Merge branch 'CHUNKING'
[exim.git] / src / src / macros.h
CommitLineData
059ec3d9
PH
1/*************************************************
2* Exim - an Internet mail transport agent *
3*************************************************/
4
80fea873 5/* Copyright (c) University of Cambridge 1995 - 2016 */
059ec3d9
PH
6/* See the file NOTICE for conditions of use and distribution. */
7
8
9/* These two macros make it possible to obtain the result of macro-expanding
10a string as a text string. This is sometimes useful for debugging output. */
11
12#define mac_string(s) # s
13#define mac_expanded_string(s) mac_string(s)
14
f846c8f5
JH
15/* Number of elements of an array */
16#define nelem(arr) (sizeof(arr) / sizeof(*arr))
17
059ec3d9 18
8669f003
PH
19/* When running in the test harness, the load average is fudged. */
20
21#define OS_GETLOADAVG() \
22 (running_in_test_harness? (test_harness_load_avg += 10) : os_getloadavg())
23
24
059ec3d9
PH
25/* The address_item structure has a word full of 1-bit flags. These macros
26manipulate them. */
27
28#define setflag(addr,flag) addr->flags |= (flag)
29#define clearflag(addr,flag) addr->flags &= ~(flag)
30
31#define testflag(addr,flag) ((addr->flags & (flag)) != 0)
32#define testflagsall(addr,flag) ((addr->flags & (flag)) == (flag))
33
34#define copyflag(addrnew,addrold,flag) \
35 addrnew->flags = (addrnew->flags & ~(flag)) | (addrold->flags & (flag))
36
37#define orflag(addrnew,addrold,flag) \
38 addrnew->flags |= addrold->flags & (flag)
39
40
41/* For almost all calls to convert things to printing characters, we want to
42allow tabs. A macro just makes life a bit easier. */
43
44#define string_printing(s) string_printing2((s), TRUE)
45
46
47/* We need a special return code for "no recipients and failed to send an error
48message". ANSI C defines only EXIT_FAILURE and EXIT_SUCCESS. On the assumption
49that these are always 1 and 0 on Unix systems ... */
50
51#define EXIT_NORECIPIENTS 2
52
53
54/* Character-handling macros. It seems that the set of standard functions in
55ctype.h aren't actually all that useful. One reason for this is that email is
56international, so the concept of using a locale to vary what they do is not
57helpful. Another problem is that in different operating systems, the libraries
58yield different results, even in the default locale. For example, Linux yields
59TRUE for iscntrl() for all characters > 127, whereas many other systems yield
60FALSE. For these reasons we define our own set of macros for a number of
61character testing functions. Ensure that all these tests treat their arguments
62as unsigned. */
63
64#define mac_iscntrl(c) \
65 ((uschar)(c) < 32 || (uschar)(c) == 127)
66
67#define mac_iscntrl_or_special(c) \
68 ((uschar)(c) < 32 || strchr(" ()<>@,;:\\\".[]\177", (uschar)(c)) != NULL)
69
70#define mac_isgraph(c) \
71 ((uschar)(c) > 32 && (uschar)(c) != 127)
72
73#define mac_isprint(c) \
74 (((uschar)(c) >= 32 && (uschar)(c) <= 126) || c == '\t' || \
75 ((uschar)(c) > 127 && print_topbitchars))
76
77
ce52b325
PP
78/* Convenience for testing strings */
79
80#define streqic(Foo, Bar) (strcmpic(Foo, Bar) == 0)
81
82
059ec3d9
PH
83/* When built with TLS support, the act of flushing SMTP output becomes
84a no-op once an SSL session is in progress. */
85
86#ifdef SUPPORT_TLS
817d9f57 87#define mac_smtp_fflush() if (tls_in.active < 0) fflush(smtp_out);
059ec3d9
PH
88#else
89#define mac_smtp_fflush() fflush(smtp_out);
90#endif
91
92
93/* Define which ends of pipes are for reading and writing, as some systems
94don't make the file descriptors two-way. */
95
96#define pipe_read 0
97#define pipe_write 1
98
99/* The RFC 1413 ident port */
100
101#define IDENT_PORT 113
102
103/* A macro to simplify testing bits in lookup types */
104
e6d225ae 105#define mac_islookup(a,b) ((lookup_list[a]->type & (b)) != 0)
059ec3d9
PH
106
107/* Debugging control */
108
109#define DEBUG(x) if ((debug_selector & (x)) != 0)
110#define HDEBUG(x) if (host_checking || (debug_selector & (x)) != 0)
111
55414b25
JH
112#define PTR_CHK(ptr) \
113do { \
114if ((void *)ptr > (void *)store_get(0)) \
115 debug_printf("BUG: ptr '%s' beyond arena at %s:%d\n", \
116 mac_expanded_string(ptr), __FUNCTION__, __LINE__); \
117} while(0)
118
0e22dfd1
PH
119/* The default From: text for DSNs */
120
121#define DEFAULT_DSN_FROM "Mail Delivery System <Mailer-Daemon@$qualify_domain>"
122
059ec3d9
PH
123/* The size of the vector for saving/restoring address expansion pointers while
124verifying. This has to be explicit because it is referenced in more than one
125source module. */
126
127#define ADDRESS_EXPANSIONS_COUNT 18
128
129/* The maximum permitted number of command-line (-D) macro definitions. We
130need a limit only to make it easier to generate argument vectors for re-exec
131of Exim. */
132
133#define MAX_CLMACROS 10
134
135/* The number of integer variables available in filter files. If this is
136changed, then the tables in expand.c for accessing them must be changed too. */
137
138#define FILTER_VARIABLE_COUNT 10
139
140/* The size of the vector holding delay warning times */
141
142#define DELAY_WARNING_SIZE 12
143
144/* The size of the buffer holding the processing information string. */
145
146#define PROCESS_INFO_SIZE 256
147
148/* The size of buffer to get for constructing log entries. Make it big
149enough to hold all the headers from a normal kind of message. */
150
151#define LOG_BUFFER_SIZE 8192
152
b4ed4da0
PH
153/* The size of the circular buffer that remembers recent SMTP commands */
154
155#define SMTP_HBUFF_SIZE 20
156
059ec3d9
PH
157/* The initial size of a big buffer for use in various places. It gets put
158into big_buffer_size and in some circumstances increased. It should be at least
159as long as the maximum path length. */
160
8523533c 161#if defined PATH_MAX && PATH_MAX > 16384
f846c8f5 162# define BIG_BUFFER_SIZE PATH_MAX
8523533c 163#elif defined MAXPATHLEN && MAXPATHLEN > 16384
f846c8f5 164# define BIG_BUFFER_SIZE MAXPATHLEN
059ec3d9 165#else
f846c8f5 166# define BIG_BUFFER_SIZE 16384
059ec3d9
PH
167#endif
168
94431adb 169/* header size of pipe content
bd21a787
WB
170 currently: char id, char subid, char[5] length */
171#define PIPE_HEADER_SIZE 7
172
059ec3d9
PH
173/* This limits the length of data returned by local_scan(). Because it is
174written on the spool, it gets read into big_buffer. */
175
176#define LOCAL_SCAN_MAX_RETURN (BIG_BUFFER_SIZE - 24)
177
178/* A limit to the length of an address. RFC 2821 limits the local part to 64
179and the domain to 255, so this should be adequate, taking into account quotings
180etc. */
181
182#define ADDRESS_MAXLENGTH 512
183
184/* The length of the base names of spool files, which consist of an internal
185message id with a trailing "-H" or "-D" added. */
186
187#define SPOOL_NAME_LENGTH (MESSAGE_ID_LENGTH+2)
188
189/* The maximum number of message ids to store in a waiting database
190record. */
191
192#define WAIT_NAME_MAX 50
193
a3c86431
TL
194/* Wait this long before determining that a Proxy Protocol configured
195host isn't speaking the protocol, and so is disallowed. Can be moved to
196runtime configuration if per site settings become needed. */
cee5f132 197#ifdef SUPPORT_PROXY
a3c86431
TL
198#define PROXY_NEGOTIATION_TIMEOUT_SEC 3
199#define PROXY_NEGOTIATION_TIMEOUT_USEC 0
200#endif
201
059ec3d9
PH
202/* Fixed option values for all PCRE functions */
203
204#define PCRE_COPT 0 /* compile */
205#define PCRE_EOPT 0 /* exec */
206
207/* Macros for trivial functions */
208
209#define mac_ismsgid(s) \
210 (pcre_exec(regex_ismsgid,NULL,CS s,Ustrlen(s),0,PCRE_EOPT,NULL,0) >= 0)
211
212
213/* Options for dns_next_rr */
214
e5a9dba6 215enum { RESET_NEXT, RESET_ANSWERS, RESET_AUTHORITY, RESET_ADDITIONAL };
059ec3d9
PH
216
217/* Argument values for the time-of-day function */
218
f1e5fef5
PP
219enum { tod_log, tod_log_bare, tod_log_zone, tod_log_datestamp_daily,
220 tod_log_datestamp_monthly, tod_zone, tod_full, tod_bsdin,
f5787926 221 tod_mbx, tod_epoch, tod_epoch_l, tod_zulu };
059ec3d9
PH
222
223/* For identifying types of driver */
224
225enum {
226 DTYPE_NONE,
227 DTYPE_ROUTER,
228 DTYPE_TRANSPORT
229};
230
231/* Error numbers for generating error messages when reading a message on the
232standard input. */
233
234enum {
235 ERRMESS_BADARGADDRESS, /* Bad address via argument list */
236 ERRMESS_BADADDRESS, /* Bad address read via -t */
237 ERRMESS_NOADDRESS, /* Message has no addresses */
238 ERRMESS_IGADDRESS, /* All -t addresses ignored */
239 ERRMESS_BADNOADDRESS, /* Bad address via -t, leaving none */
240 ERRMESS_IOERR, /* I/O error while reading a message */
241 ERRMESS_VLONGHEADER, /* Excessively long message header */
242 ERRMESS_VLONGHDRLINE, /* Excessively long single line in header */
243 ERRMESS_TOOBIG, /* Message too big */
244 ERRMESS_TOOMANYRECIP, /* Too many recipients */
245 ERRMESS_LOCAL_SCAN, /* Rejected by local scan */
246 ERRMESS_LOCAL_ACL /* Rejected by non-SMTP ACL */
4840604e
TL
247#ifdef EXPERIMENTAL_DMARC
248 ,ERRMESS_DMARC_FORENSIC /* DMARC Forensic Report */
249#endif
059ec3d9
PH
250};
251
252/* Error handling styles - set by option, and apply only when receiving
253a local message not via SMTP. */
254
255enum {
256 ERRORS_SENDER, /* Return to sender (default) */
257 ERRORS_STDERR /* Write on stderr */
258};
259
260/* Exec control values when Exim execs itself via child_exec_exim. */
261
262enum {
263 CEE_RETURN_ARGV, /* Don't exec, just build and return argv */
264 CEE_EXEC_EXIT, /* Just exit if exec fails */
265 CEE_EXEC_PANIC /* Panic-die if exec fails */
266};
267
f05da2e8
PH
268/* Bit values for filter_test */
269
270#define FTEST_NONE 0 /* Not filter testing */
271#define FTEST_USER 1 /* Testing user filter */
8e669ac1 272#define FTEST_SYSTEM 2 /* Testing system filter */
f05da2e8 273
059ec3d9
PH
274/* Returns from the routing, transport and authentication functions (not all
275apply to all of them). Some other functions also use these convenient values,
276and some additional values are used only by non-driver functions.
277
1a46a8c5
PH
278OK, FAIL, DEFER, ERROR, and FAIL_FORCED are also declared in local_scan.h for
279use in the local_scan() function and in ${dlfunc loaded functions. Do not
280change them unilaterally. */
059ec3d9 281
f05da2e8
PH
282#define OK 0 /* Successful match */
283#define DEFER 1 /* Defer - some problem */
284#define FAIL 2 /* Matching failed */
285#define ERROR 3 /* Internal or config error */
1a46a8c5 286#define FAIL_FORCED 4 /* "Forced" failure */
059ec3d9 287/***********/
1a46a8c5 288#define DECLINE 5 /* Declined to handle the address, pass to next
059ec3d9 289 router unless no_more is set */
1a46a8c5 290#define PASS 6 /* Pass to next driver, or to pass_router,
059ec3d9 291 even if no_more is set */
1a46a8c5
PH
292#define DISCARD 7 /* Address routed to :blackhole: or "seen finish" */
293#define SKIP 8 /* Skip this router (used in route_address only) */
294#define REROUTED 9 /* Address was changed and child created*/
295#define PANIC 10 /* Hard failed with internal error */
296#define BAD64 11 /* Bad base64 data (auth) */
297#define UNEXPECTED 12 /* Unexpected initial auth data */
298#define CANCELLED 13 /* Authentication cancelled */
299#define FAIL_SEND 14 /* send() failed in authenticator */
300#define FAIL_DROP 15 /* Fail and drop connection (used in ACL) */
059ec3d9
PH
301
302/* Returns from the deliver_message() function */
303
304#define DELIVER_ATTEMPTED_NORMAL 0 /* Tried a normal delivery */
305#define DELIVER_MUA_SUCCEEDED 1 /* Success when mua_wrapper is set */
306#define DELIVER_MUA_FAILED 2 /* Failure when mua_wrapper is set */
307#define DELIVER_NOT_ATTEMPTED 3 /* Not tried (no msg or is locked */
308
309/* Returns from DNS lookup functions. */
310
311enum { DNS_SUCCEED, DNS_NOMATCH, DNS_NODATA, DNS_AGAIN, DNS_FAIL };
312
313/* Ending states when reading a message. The order is important. The test
314for having to swallow the rest of an SMTP message is whether the value is
315>= END_NOTENDED. */
316
317#define END_NOTSTARTED 0 /* Message not started */
318#define END_DOT 1 /* Message ended with '.' */
319#define END_EOF 2 /* Message ended with EOF (error for SMTP) */
320#define END_NOTENDED 3 /* Message reading not yet ended */
321#define END_SIZE 4 /* Reading ended because message too big */
322#define END_WERROR 5 /* Write error while reading the message */
7e3ce68e
JH
323#define END_PROTOCOL 6 /* Protocol error in CHUNKING sequence */
324
325/* result codes for bdat_getc() (which can also return EOF) */
326
327#define EOD (-2)
328#define ERR (-3)
329
059ec3d9 330
6c6d6e48
TF
331/* Bit masks for debug and log selectors */
332
333/* Assume words are 32 bits wide. Tiny waste of space on 64 bit
334platforms, but this ensures bit vectors always work the same way. */
335#define BITWORDSIZE 32
336
337/* This macro is for single-word bit vectors: the debug selector,
338and the first word of the log selector. */
339#define BIT(n) (1 << (n))
340
341/* And these are for multi-word vectors. */
342#define BITWORD(n) ( (n) / BITWORDSIZE)
343#define BITMASK(n) (1 << (n) % BITWORDSIZE)
344
345#define BIT_CLEAR(s,z,n) ((s)[BITWORD(n)] &= ~BITMASK(n))
346#define BIT_SET(s,z,n) ((s)[BITWORD(n)] |= BITMASK(n))
347#define BIT_TEST(s,z,n) (((s)[BITWORD(n)] & BITMASK(n)) != 0)
348
349/* Used in globals.c for initializing bit_table structures. T will be either
350D or L correspondong to the debug and log selector bits declared below. */
351
352#define BIT_TABLE(T,name) { US #name, T##i_##name }
353
354/* IOTA allows us to keep an implicit sequential count, like a simple enum,
355but we can have sequentially numbered identifiers which are not declared
356sequentially. We use this for more compact declarations of bit indexes and
357masks, alternating between sequential bit index and corresponding mask. */
358
359#define IOTA(iota) (__LINE__ - iota)
360#define IOTA_INIT(zero) (__LINE__ - zero + 1)
361
362/* Options bits for debugging. DEBUG_BIT() declares both a bit index and the
363corresponding mask. Di_all is a special value recognized by decode_bits().
364
365Exim's code assumes in a number of places that the debug_selector is one
366word, and this is exposed in the local_scan ABI. The D_v and D_local_scan bit
367masks are part of the local_scan API so are #defined in local_scan.h */
368
369#define DEBUG_BIT(name) Di_##name = IOTA(Di_iota), D_##name = BIT(Di_##name)
370
371enum {
372 Di_all = -1,
373 Di_v = 0,
374 Di_local_scan = 1,
375
376 Di_iota = IOTA_INIT(2),
377 DEBUG_BIT(acl),
378 DEBUG_BIT(auth),
379 DEBUG_BIT(deliver),
380 DEBUG_BIT(dns),
381 DEBUG_BIT(dnsbl),
382 DEBUG_BIT(exec),
383 DEBUG_BIT(expand),
384 DEBUG_BIT(filter),
385 DEBUG_BIT(hints_lookup),
386 DEBUG_BIT(host_lookup),
387 DEBUG_BIT(ident),
388 DEBUG_BIT(interface),
389 DEBUG_BIT(lists),
390 DEBUG_BIT(load),
391 DEBUG_BIT(lookup),
392 DEBUG_BIT(memory),
393 DEBUG_BIT(pid),
394 DEBUG_BIT(process_info),
395 DEBUG_BIT(queue_run),
396 DEBUG_BIT(receive),
397 DEBUG_BIT(resolver),
398 DEBUG_BIT(retry),
399 DEBUG_BIT(rewrite),
400 DEBUG_BIT(route),
401 DEBUG_BIT(timestamp),
402 DEBUG_BIT(tls),
403 DEBUG_BIT(transport),
404 DEBUG_BIT(uid),
405 DEBUG_BIT(verify),
406};
407
408/* Multi-bit debug masks */
1fe64dcc
PH
409
410#define D_all 0xffffffff
059ec3d9
PH
411
412#define D_any (D_all & \
413 ~(D_v | \
414 D_pid | \
415 D_timestamp) )
416
59cf8544 417#define D_default (0xffffffff & \
059ec3d9
PH
418 ~(D_expand | \
419 D_filter | \
420 D_interface | \
421 D_load | \
422 D_local_scan | \
423 D_memory | \
424 D_pid | \
425 D_timestamp | \
426 D_resolver))
427
6c6d6e48
TF
428/* Options bits for logging. Those that have values < BITWORDSIZE can be used
429in calls to log_write(). The others are put into later words in log_selector
430and are only ever tested independently, so they do not need bit mask
431declarations. The Li_all value is recognized specially by decode_bits(). */
432
433#define LOG_BIT(name) Li_##name = IOTA(Li_iota), L_##name = BIT(Li_##name)
434
435enum {
436 Li_all = -1,
437
438 Li_iota = IOTA_INIT(0),
439 LOG_BIT(address_rewrite),
440 LOG_BIT(all_parents),
441 LOG_BIT(connection_reject),
442 LOG_BIT(delay_delivery),
443 LOG_BIT(dnslist_defer),
444 LOG_BIT(etrn),
445 LOG_BIT(host_lookup_failed),
446 LOG_BIT(lost_incoming_connection),
447 LOG_BIT(queue_run),
448 LOG_BIT(retry_defer),
449 LOG_BIT(size_reject),
450 LOG_BIT(skip_delivery),
451 LOG_BIT(smtp_connection),
452 LOG_BIT(smtp_incomplete_transaction),
453 LOG_BIT(smtp_protocol_error),
454 LOG_BIT(smtp_syntax_error),
455
fc16abb4
JH
456 Li_8bitmime = BITWORDSIZE,
457 Li_acl_warn_skipped,
6c6d6e48
TF
458 Li_arguments,
459 Li_deliver_time,
460 Li_delivery_size,
fc16abb4 461 Li_dnssec,
6c6d6e48
TF
462 Li_ident_timeout,
463 Li_incoming_interface,
464 Li_incoming_port,
fc16abb4 465 Li_outgoing_interface,
6c6d6e48
TF
466 Li_outgoing_port,
467 Li_pid,
fc16abb4 468 Li_proxy,
6c6d6e48
TF
469 Li_queue_time,
470 Li_queue_time_overall,
471 Li_received_sender,
472 Li_received_recipients,
473 Li_rejected_header,
474 Li_return_path_on_delivery,
475 Li_sender_on_delivery,
476 Li_sender_verify_fail,
477 Li_smtp_confirmation,
fc16abb4 478 Li_smtp_mailauth,
6c6d6e48
TF
479 Li_smtp_no_mail,
480 Li_subject,
481 Li_tls_certificate_verified,
482 Li_tls_cipher,
483 Li_tls_peerdn,
484 Li_tls_sni,
485 Li_unknown_in_list,
6c6d6e48 486
fc16abb4 487 log_selector_size = BITWORD(Li_unknown_in_list) + 1
6c6d6e48
TF
488};
489
490#define LOGGING(opt) BIT_TEST(log_selector, log_selector_size, Li_##opt)
059ec3d9
PH
491
492/* Private error numbers for delivery failures, set negative so as not
37f3dc43
JH
493to conflict with system errno values. Take care to maintain the string
494table exim_errstrings[] in log.c */
059ec3d9
PH
495
496#define ERRNO_UNKNOWNERROR (-1)
497#define ERRNO_USERSLASH (-2)
498#define ERRNO_EXISTRACE (-3)
499#define ERRNO_NOTREGULAR (-4)
500#define ERRNO_NOTDIRECTORY (-5)
501#define ERRNO_BADUGID (-6)
502#define ERRNO_BADMODE (-7)
503#define ERRNO_INODECHANGED (-8)
504#define ERRNO_LOCKFAILED (-9)
505#define ERRNO_BADADDRESS2 (-10)
506#define ERRNO_FORBIDPIPE (-11)
507#define ERRNO_FORBIDFILE (-12)
508#define ERRNO_FORBIDREPLY (-13)
509#define ERRNO_MISSINGPIPE (-14)
510#define ERRNO_MISSINGFILE (-15)
511#define ERRNO_MISSINGREPLY (-16)
512#define ERRNO_BADREDIRECT (-17)
513#define ERRNO_SMTPCLOSED (-18)
514#define ERRNO_SMTPFORMAT (-19)
515#define ERRNO_SPOOLFORMAT (-20)
516#define ERRNO_NOTABSOLUTE (-21)
517#define ERRNO_EXIMQUOTA (-22) /* Exim-imposed quota */
518#define ERRNO_HELD (-23)
519#define ERRNO_FILTER_FAIL (-24) /* Delivery filter process failure */
520#define ERRNO_CHHEADER_FAIL (-25) /* Delivery add/remove header failure */
521#define ERRNO_WRITEINCOMPLETE (-26) /* Delivery write incomplete error */
522#define ERRNO_EXPANDFAIL (-27) /* Some expansion failed */
523#define ERRNO_GIDFAIL (-28) /* Failed to get gid */
524#define ERRNO_UIDFAIL (-29) /* Failed to get uid */
525#define ERRNO_BADTRANSPORT (-30) /* Unset or non-existent transport */
526#define ERRNO_MBXLENGTH (-31) /* MBX length mismatch */
bd4ece7d 527#define ERRNO_UNKNOWNHOST (-32) /* Lookup failed routing or in smtp tpt */
059ec3d9
PH
528#define ERRNO_FORMATUNKNOWN (-33) /* Can't match format in appendfile */
529#define ERRNO_BADCREATE (-34) /* Creation outside home in appendfile */
530#define ERRNO_LISTDEFER (-35) /* Can't check a list; lookup defer */
531#define ERRNO_DNSDEFER (-36) /* DNS lookup defer */
532#define ERRNO_TLSFAILURE (-37) /* Failed to start TLS session */
533#define ERRNO_TLSREQUIRED (-38) /* Mandatory TLS session not started */
534#define ERRNO_CHOWNFAIL (-39) /* Failed to chown a file */
535#define ERRNO_PIPEFAIL (-40) /* Failed to create a pipe */
536#define ERRNO_CALLOUTDEFER (-41) /* When verifying */
537#define ERRNO_AUTHFAIL (-42) /* When required by client */
538#define ERRNO_CONNECTTIMEOUT (-43) /* Used internally in smtp transport */
539#define ERRNO_RCPT4XX (-44) /* RCPT gave 4xx error */
e97957bc
PH
540#define ERRNO_MAIL4XX (-45) /* MAIL gave 4xx error */
541#define ERRNO_DATA4XX (-46) /* DATA gave 4xx error */
a3c86431 542#define ERRNO_PROXYFAIL (-47) /* Negotiation failed for proxy configured host */
7ade712c
JH
543#define ERRNO_AUTHPROB (-48) /* Authenticator "other" failure */
544
8c5d388a 545#ifdef SUPPORT_I18N
7ade712c
JH
546# define ERRNO_UTF8_FWD (-49) /* target not supporting SMTPUTF8 */
547#endif
059ec3d9
PH
548
549/* These must be last, so all retry deferments can easily be identified */
550
551#define ERRNO_RETRY_BASE (-51) /* Base to test against */
552#define ERRNO_RRETRY (-51) /* Not time for routing */
553#define ERRNO_LRETRY (-52) /* Not time for local delivery */
554#define ERRNO_HRETRY (-53) /* Not time for any remote host */
555#define ERRNO_LOCAL_ONLY (-54) /* Local-only delivery */
556#define ERRNO_QUEUE_DOMAIN (-55) /* Domain in queue_domains */
3070ceee 557#define ERRNO_TRETRY (-56) /* Transport concurrency limit */
059ec3d9 558
37f3dc43
JH
559
560
059ec3d9
PH
561/* Special actions to take after failure or deferment. */
562
563enum {
564 SPECIAL_NONE, /* No special action */
565 SPECIAL_FREEZE, /* Freeze message */
566 SPECIAL_FAIL, /* Fail the delivery */
567 SPECIAL_WARN /* Send a warning message */
568};
569
570/* Flags that get ORed into the more_errno field of an address to give more
571information about errors for retry purposes. They are greater than 256, because
572the bottom byte contains 'A' or 'M' for remote addresses, to indicate whether
573the name was looked up only via an address record or whether MX records were
574used, respectively. */
575
576#define RTEF_CTOUT 0x0100 /* Connection timed out */
577
578/* Permission and other options for parse_extract_addresses(),
579filter_interpret(), and rda_interpret(), i.e. what special things are allowed
580in redirection operations. Not all apply to all cases. Some of the bits allow
581and some forbid, reflecting the "allow" and "forbid" options in the redirect
582router, which were chosen to represent the standard situation for users'
583.forward files. */
584
23c7ff99
PH
585#define RDO_BLACKHOLE 0x00000001 /* Forbid :blackhole: */
586#define RDO_DEFER 0x00000002 /* Allow :defer: or "defer" */
587#define RDO_EACCES 0x00000004 /* Ignore EACCES */
588#define RDO_ENOTDIR 0x00000008 /* Ignore ENOTDIR */
589#define RDO_EXISTS 0x00000010 /* Forbid "exists" in expansion in filter */
590#define RDO_FAIL 0x00000020 /* Allow :fail: or "fail" */
591#define RDO_FILTER 0x00000040 /* Allow a filter script */
592#define RDO_FREEZE 0x00000080 /* Allow "freeze" */
593#define RDO_INCLUDE 0x00000100 /* Forbid :include: */
594#define RDO_LOG 0x00000200 /* Forbid "log" */
595#define RDO_LOOKUP 0x00000400 /* Forbid "lookup" in expansion in filter */
596#define RDO_PERL 0x00000800 /* Forbid "perl" in expansion in filter */
597#define RDO_READFILE 0x00001000 /* Forbid "readfile" in exp in filter */
598#define RDO_READSOCK 0x00002000 /* Forbid "readsocket" in exp in filter */
599#define RDO_RUN 0x00004000 /* Forbid "run" in expansion in filter */
1a46a8c5
PH
600#define RDO_DLFUNC 0x00008000 /* Forbid "dlfunc" in expansion in filter */
601#define RDO_REALLOG 0x00010000 /* Really do log (not testing/verifying) */
602#define RDO_REWRITE 0x00020000 /* Rewrite generated addresses */
603#define RDO_EXIM_FILTER 0x00040000 /* Forbid Exim filters */
604#define RDO_SIEVE_FILTER 0x00080000 /* Forbid Sieve filters */
4608d683 605#define RDO_PREPEND_HOME 0x00100000 /* Prepend $home to relative paths in Exim filter save commands */
059ec3d9
PH
606
607/* This is the set that apply to expansions in filters */
608
609#define RDO_FILTER_EXPANSIONS \
1a46a8c5 610 (RDO_EXISTS|RDO_LOOKUP|RDO_PERL|RDO_READFILE|RDO_READSOCK|RDO_RUN|RDO_DLFUNC)
059ec3d9
PH
611
612/* As well as the RDO bits themselves, we need the bit numbers in order to
613access (most of) the individual bits as separate options. This could be
614automated, but I haven't bothered. Keep this list in step with the above! */
615
616enum { RDON_BLACKHOLE, RDON_DEFER, RDON_EACCES, RDON_ENOTDIR, RDON_EXISTS,
617 RDON_FAIL, RDON_FILTER, RDON_FREEZE, RDON_INCLUDE, RDON_LOG, RDON_LOOKUP,
1a46a8c5 618 RDON_PERL, RDON_READFILE, RDON_READSOCK, RDON_RUN, RDON_DLFUNC, RDON_REALLOG,
4608d683 619 RDON_REWRITE, RDON_EXIM_FILTER, RDON_SIEVE_FILTER, RDON_PREPEND_HOME };
059ec3d9
PH
620
621/* Results of filter or forward file processing. Some are only from a filter;
622some are only from a forward file. */
623
624enum {
625 FF_DELIVERED, /* Success, took significant action */
626 FF_NOTDELIVERED, /* Success, didn't take significant action */
627 FF_BLACKHOLE, /* Blackholing requested */
628 FF_DEFER, /* Defer requested */
629 FF_FAIL, /* Fail requested */
630 FF_INCLUDEFAIL, /* :include: failed */
631 FF_NONEXIST, /* Forward file does not exist */
632 FF_FREEZE, /* Freeze requested */
633 FF_ERROR /* We have a problem */
634};
635
636/* Values for identifying particular headers; printing characters are used, so
637they can be read in the spool file for those headers that are permanently
638marked. The lower case values don't get onto the spool; they are used only as
639return values from header_checkname(). */
640
641#define htype_other ' ' /* Unspecified header */
642#define htype_from 'F'
643#define htype_to 'T'
644#define htype_cc 'C'
645#define htype_bcc 'B'
646#define htype_id 'I' /* for message-id */
647#define htype_reply_to 'R'
648#define htype_received 'P' /* P for Postmark */
649#define htype_sender 'S'
650#define htype_old '*' /* Replaced header */
651
652#define htype_date 'd'
653#define htype_return_path 'p'
654#define htype_delivery_date 'x'
655#define htype_envelope_to 'e'
656#define htype_subject 's'
657
658/* These values are used only when adding new headers from an ACL; they too
659never get onto the spool. The type of the added header is set by reference
660to the header name, by calling header_checkname(). */
661
662#define htype_add_top 'a'
663#define htype_add_rec 'r'
664#define htype_add_bot 'z'
8523533c 665#define htype_add_rfc 'f'
059ec3d9
PH
666
667/* Types of item in options lists. These are the bottom 8 bits of the "type"
668field, which is an int. The opt_void value is used for entries in tables that
669point to special types of value that are accessed only indirectly (e.g. the
670rewrite data that is built out of a string option.) We need to have some values
671visible in local_scan, so the following are declared there:
672
673 opt_stringptr, opt_int, opt_octint, opt_mkint, opt_Kint, opt_fixed, opt_time,
674 opt_bool
675
676To make sure we don't conflict, the local_scan.h values start from zero, and
677those defined here start from 32. The boolean ones must all be together so they
678can be easily tested as a group. That is the only use of opt_bool_last. */
679
680enum { opt_bit = 32, opt_bool_verify, opt_bool_set, opt_expand_bool,
681 opt_bool_last,
682 opt_rewrite, opt_timelist, opt_uid, opt_gid, opt_uidlist, opt_gidlist,
1ad6489e 683 opt_expand_uid, opt_expand_gid, opt_func, opt_void };
059ec3d9
PH
684
685/* There's a high-ish bit which is used to flag duplicate options, kept
686for compatibility, which shouldn't be output. Also used for hidden options
687that are automatically maintained from others. Another high bit is used to
688flag driver options that although private (so as to be settable only on some
689drivers), are stored in the instance block so as to be accessible from outside.
690A third high bit is set when an option is read, so as to be able to give an
691error if any option is set twice. Finally, there's a bit which is set when an
692option is set with the "hide" prefix, to prevent -bP from showing it to
693non-admin callers. The next byte up in the int is used to keep the bit number
694for booleans that are kept in one bit. */
695
696#define opt_hidden 0x100 /* Private to Exim */
697#define opt_public 0x200 /* Stored in the main instance block */
698#define opt_set 0x400 /* Option is set */
699#define opt_secure 0x800 /* "hide" prefix used */
846726c5
JH
700#define opt_rep_con 0x1000 /* Can be appended to by a repeated line (condition) */
701#define opt_rep_str 0x2000 /* Can be appended to by a repeated line (string) */
702#define opt_mask 0x00ff
059ec3d9
PH
703
704/* Verify types when directing and routing */
705
706enum { v_none, v_sender, v_recipient, v_expn };
707
708/* Option flags for verify_address() */
709
710#define vopt_fake_sender 0x0001 /* for verify=sender=<address> */
711#define vopt_is_recipient 0x0002
712#define vopt_qualify 0x0004
713#define vopt_expn 0x0008
2a4be8f9 714#define vopt_callout_fullpm 0x0010 /* full postmaster during callout */
059ec3d9
PH
715#define vopt_callout_random 0x0020 /* during callout */
716#define vopt_callout_no_cache 0x0040 /* disable callout cache */
717#define vopt_callout_recipsender 0x0080 /* use real sender to verify recip */
718#define vopt_callout_recippmaster 0x0100 /* use postmaster to verify recip */
eafd343b 719#define vopt_success_on_redirect 0x0200
059ec3d9
PH
720
721/* Values for fields in callout cache records */
722
723#define ccache_unknown 0 /* test hasn't been done */
724#define ccache_accept 1
2b1c6e3a
PH
725#define ccache_reject 2 /* All rejections except */
726#define ccache_reject_mfnull 3 /* MAIL FROM:<> was rejected */
059ec3d9
PH
727
728/* Options for lookup functions */
729
730#define lookup_querystyle 1 /* query-style lookup */
731#define lookup_absfile 2 /* requires absolute file name */
13b685f9 732#define lookup_absfilequery 4 /* query-style starts with file name */
059ec3d9
PH
733
734/* Status values for host_item blocks. Require hstatus_unusable and
735hstatus_unusable_expired to be last. */
736
737enum { hstatus_unknown, hstatus_usable, hstatus_unusable,
738 hstatus_unusable_expired };
739
740/* Reasons why a host is unusable (for clearer log messages) */
741
742enum { hwhy_unknown, hwhy_retry, hwhy_failed, hwhy_deferred, hwhy_ignored };
743
744/* Domain lookup types for routers */
745
746enum { lk_default, lk_byname, lk_bydns };
747
748/* Values for the self_code fields */
749
750enum { self_freeze, self_defer, self_send, self_reroute, self_pass, self_fail };
751
752/* Flags for rewrite rules */
753
754#define rewrite_sender 0x0001
755#define rewrite_from 0x0002
756#define rewrite_to 0x0004
757#define rewrite_cc 0x0008
758#define rewrite_bcc 0x0010
759#define rewrite_replyto 0x0020
760#define rewrite_all_headers 0x003F /* all header flags */
761
762#define rewrite_envfrom 0x0040
763#define rewrite_envto 0x0080
764#define rewrite_all_envelope 0x00C0 /* all envelope flags */
765
766#define rewrite_all (rewrite_all_headers | rewrite_all_envelope)
767
768#define rewrite_smtp 0x0100 /* rewrite at SMTP time */
769#define rewrite_smtp_sender 0x0200 /* SMTP sender rewrite (allows <>) */
770#define rewrite_qualify 0x0400 /* qualify if necessary */
771#define rewrite_repeat 0x0800 /* repeat rewrite rule */
772
773#define rewrite_whole 0x1000 /* option bit for headers */
774#define rewrite_quit 0x2000 /* "no more" option */
775
776/* Flags for log_write(); LOG_MAIN, LOG_PANIC, and LOG_REJECT are also in
777local_scan.h */
778
779#define LOG_MAIN 1 /* Write to the main log */
780#define LOG_PANIC 2 /* Write to the panic log */
781#define LOG_PANIC_DIE 6 /* Write to the panic log and then die */
059ec3d9
PH
782#define LOG_REJECT 16 /* Write to the reject log, with headers */
783#define LOG_SENDER 32 /* Add raw sender to the message */
784#define LOG_RECIPIENTS 64 /* Add raw recipients to the message */
785#define LOG_CONFIG 128 /* Add "Exim configuration error" */
786#define LOG_CONFIG_FOR (256+128) /* Add " for" instead of ":\n" */
787#define LOG_CONFIG_IN (512+128) /* Add " in line x[ of file y]" */
788
ed7f7860
PP
789/* and for debug_bits() logging action control: */
790#define DEBUG_FROM_CONFIG 0x0001
791
b4ed4da0
PH
792/* SMTP command identifiers for the smtp_connection_had field that records the
793most recent SMTP commands. Must be kept in step with the list of names in
794smtp_in.c that is used for creating the smtp_no_mail logging action. SCH_NONE
795is "empty". */
796
18481de3
JH
797enum { SCH_NONE, SCH_AUTH, SCH_DATA, SCH_BDAT,
798 SCH_EHLO, SCH_ETRN, SCH_EXPN, SCH_HELO,
b4ed4da0
PH
799 SCH_HELP, SCH_MAIL, SCH_NOOP, SCH_QUIT, SCH_RCPT, SCH_RSET, SCH_STARTTLS,
800 SCH_VRFY };
801
059ec3d9
PH
802/* Returns from host_find_by{name,dns}() */
803
804enum {
805 HOST_FIND_FAILED, /* failed to find the host */
806 HOST_FIND_AGAIN, /* could not resolve at this time */
807 HOST_FOUND, /* found host */
808 HOST_FOUND_LOCAL, /* found, but MX points to local host */
809 HOST_IGNORED /* found but ignored - used internally only */
810};
811
812/* Flags for host_find_bydns() */
813
814#define HOST_FIND_BY_SRV 0x0001
815#define HOST_FIND_BY_MX 0x0002
816#define HOST_FIND_BY_A 0x0004
817#define HOST_FIND_QUALIFY_SINGLE 0x0008
818#define HOST_FIND_SEARCH_PARENTS 0x0010
819
820/* Actions applied to specific messages. */
821
822enum { MSG_DELIVER, MSG_FREEZE, MSG_REMOVE, MSG_THAW, MSG_ADD_RECIPIENT,
823 MSG_MARK_ALL_DELIVERED, MSG_MARK_DELIVERED, MSG_EDIT_SENDER,
a96603a0
PH
824 MSG_SHOW_COPY, MSG_LOAD,
825 /* These ones must be last: a test for >= MSG_SHOW_BODY is used
826 to test for actions that list individual spool files. */
827 MSG_SHOW_BODY, MSG_SHOW_HEADER, MSG_SHOW_LOG };
059ec3d9
PH
828
829/* Returns from the spool_read_header() function */
830
831enum {
832 spool_read_OK, /* success */
833 spool_read_notopen, /* open failed */
834 spool_read_enverror, /* error in the envelope */
835 spool_read_hdrerror /* error in the headers */
836};
837
838/* Options for transport_write_message */
839
840#define topt_add_return_path 0x001
841#define topt_add_delivery_date 0x002
842#define topt_add_envelope_to 0x004
843#define topt_use_crlf 0x008 /* Terminate lines with CRLF */
844#define topt_end_dot 0x010 /* Send terminting dot line */
845#define topt_no_headers 0x020 /* Omit headers */
846#define topt_no_body 0x040 /* Omit body */
847#define topt_escape_headers 0x080 /* Apply escape check to headers */
59932f7d 848#define topt_use_bdat 0x100 /* prepend chunks with RFC3030 BDAT header */
059ec3d9 849
6c1c3d1d
WB
850/* Flags for recipient_block, used in DSN support */
851
852#define rf_dsnlasthop 0x01 /* Do not propagate DSN any further */
853#define rf_notify_never 0x02 /* NOTIFY= settings */
854#define rf_notify_success 0x04
855#define rf_notify_failure 0x08
856#define rf_notify_delay 0x10
857
858#define rf_dsnflags (rf_notify_never | rf_notify_success | \
859 rf_notify_failure | rf_notify_delay)
860
861/* DSN RET types */
862
863#define dsn_ret_full 1
864#define dsn_ret_hdrs 2
865
866#define dsn_support_unknown 0
867#define dsn_support_yes 1
868#define dsn_support_no 2
869
6c1c3d1d 870
c456d9bb 871/* Codes for the host_find_failed and host_all_ignored options. */
059ec3d9
PH
872
873#define hff_freeze 0
874#define hff_defer 1
875#define hff_pass 2
876#define hff_decline 3
877#define hff_fail 4
c456d9bb 878#define hff_ignore 5
059ec3d9
PH
879
880/* Router information flags */
881
882#define ri_yestransport 0x0001 /* Must have a transport */
883#define ri_notransport 0x0002 /* Must not have a transport */
884
885/* Codes for match types in match_check_list; to any of them, MCL_NOEXPAND may
886be added */
887
888#define MCL_NOEXPAND 16
889
890enum { MCL_STRING, MCL_DOMAIN, MCL_HOST, MCL_ADDRESS, MCL_LOCALPART };
891
892/* Codes for the places from which ACLs can be called. These are cunningly
893ordered to make it easy to implement tests for certain ACLs when processing
894"control" modifiers, by means of a maximum "where" value. Do not modify this
9c4e8f60
PH
895order without checking carefully!
896
897**** IMPORTANT***
898**** Furthermore, remember to keep these in step with the tables
899**** of names and response codes in globals.c.
900**** IMPORTANT ****
901*/
059ec3d9
PH
902
903enum { ACL_WHERE_RCPT, /* Some controls are for RCPT only */
904 ACL_WHERE_MAIL, /* ) */
905 ACL_WHERE_PREDATA, /* ) There are several tests for "in message", */
9c4e8f60 906 ACL_WHERE_MIME, /* ) implemented by <= WHERE_NOTSMTP */
80a47a2c 907 ACL_WHERE_DKIM, /* ) */
3e11c26b 908 ACL_WHERE_DATA, /* ) */
8ccd00b1 909#ifndef DISABLE_PRDR
fd98a5c6
JH
910 ACL_WHERE_PRDR, /* ) */
911#endif
3e11c26b 912 ACL_WHERE_NOTSMTP, /* ) */
059ec3d9
PH
913
914 ACL_WHERE_AUTH, /* These remaining ones are not currently */
915 ACL_WHERE_CONNECT, /* required to be in a special order so they */
916 ACL_WHERE_ETRN, /* are just alphabetical. */
917 ACL_WHERE_EXPN,
918 ACL_WHERE_HELO,
919 ACL_WHERE_MAILAUTH,
45b91596 920 ACL_WHERE_NOTSMTP_START,
8f128379 921 ACL_WHERE_NOTQUIT,
059ec3d9
PH
922 ACL_WHERE_QUIT,
923 ACL_WHERE_STARTTLS,
723c72e6
JH
924 ACL_WHERE_VRFY,
925
faa05a93
JH
926 ACL_WHERE_DELIVERY,
927 ACL_WHERE_UNKNOWN /* Currently used by a ${acl:name} expansion */
059ec3d9
PH
928 };
929
930/* Situations for spool_write_header() */
931
932enum { SW_RECEIVING, SW_DELIVERING, SW_MODIFYING };
933
934/* MX fields for hosts not obtained from MX records are always negative.
935MX_NONE is the default case; lesser values are used when the hosts are
936randomized in batches. */
937
938#define MX_NONE (-1)
939
940/* host_item.port defaults to PORT_NONE; the only current case where this
941is changed before running the transport is when an dnslookup router sets an
942explicit port number. */
943
944#define PORT_NONE (-1)
945
946/* Flags for single-key search defaults */
947
948#define SEARCH_STAR 0x01
949#define SEARCH_STARAT 0x02
950
951/* Filter types */
952
953enum { FILTER_UNSET, FILTER_FORWARD, FILTER_EXIM, FILTER_SIEVE };
954
9094b84b
JH
955/* Codes for ESMTP facilities offered by peer */
956
957#define PEER_OFFERED_TLS BIT(0)
958#define PEER_OFFERED_IGNQ BIT(1)
959#define PEER_OFFERED_PRDR BIT(2)
960#define PEER_OFFERED_UTF8 BIT(3)
961#define PEER_OFFERED_DSN BIT(4)
962#define PEER_OFFERED_PIPE BIT(5)
963#define PEER_OFFERED_SIZE BIT(6)
f98442df 964#define PEER_OFFERED_CHUNKING BIT(7)
9094b84b
JH
965
966
059ec3d9 967/* End of macros.h */