1 /*************************************************
2 * Exim - an Internet mail transport agent *
3 *************************************************/
5 /* Copyright (c) University of Cambridge 1995 - 2018 */
6 /* See the file NOTICE for conditions of use and distribution. */
9 /* Source files for exim all #include this header, which drags in everything
10 that is needed. They don't all need everything, of course, but it's far too
11 messy to have each one importing its own list, and anyway, most of them need
12 most of these includes. */
17 /* Assume most systems have statfs() unless os.h undefines this macro */
21 /* Similarly, assume most systems have srandom() unless os.h undefines it.
22 This call dates back at least as far as SUSv2. */
26 /* This is primarily for the Gnu C library; we define it before os.h so that
27 os.h has a chance to hurriedly undef it, Just In Case. We need C99 for some
28 64-bit math support, and defining _ISOC99_SOURCE breaks <resolv.h> and friends.
33 /* First of all include the os-specific header, which might set things that
34 are needed by any of the other headers, including system headers. */
38 /* If it didn't define os_find_running_interfaces, use the common function. */
40 #ifndef os_find_running_interfaces
41 # define os_find_running_interfaces os_common_find_running_interfaces
44 /* If it didn't define the base for "base 62" numbers, we really do use 62.
45 This is the case for all real Unix and Unix-like OS. It's only Cygwin and
46 Darwin, with their case-insensitive file systems, that can't use base 62 for
47 making unique names. */
53 /* The maximum value of localhost_number depends on the base being used */
56 # define LOCALHOST_MAX 16
58 # define LOCALHOST_MAX 10
61 /* If not overridden by os.h, dynamic libraries have filenames ending .so */
63 # define DYNLIB_FN_EXT "so"
66 /* ANSI C standard includes */
82 #if defined(__svr4__) && defined(__sparc) && ! defined(__EXTENSIONS__)
83 # define __EXTENSIONS__ /* so that SunOS 5 gets NGROUPS_MAX */
85 # undef __EXTENSIONS__
90 #ifdef EXIM_HAVE_INOTIFY
91 # include <sys/inotify.h>
93 #ifdef EXIM_HAVE_KEVENT
94 # include <sys/event.h>
97 /* C99 integer types, figure out how to undo this if needed for older systems */
101 /* Just in case some aged system doesn't define them... */
104 # define INT_MAX 2147483647
108 # define INT_MIN (-INT_MAX - 1)
112 # define SHRT_MAX 32767
116 # define UCHAR_MAX 255
120 /* To match int_eximarith_t. Define in OS/os.h-<your-system> to override. */
121 #ifndef EXIM_ARITH_MAX
122 # define EXIM_ARITH_MAX ((int_eximarith_t)9223372036854775807LL)
124 #ifndef EXIM_ARITH_MIN
125 # define EXIM_ARITH_MIN (-EXIM_ARITH_MAX - 1)
128 /* Some systems have PATH_MAX and some have MAX_PATH_LEN. */
132 # define PATH_MAX MAX_PATH_LEN
134 # define PATH_MAX 1024
138 #include <sys/types.h>
139 #include <sys/file.h>
149 /* Not all systems have flock() available. Those that do must define LOCK_SH
156 #ifndef NO_SYSEXITS /* some OS don't have this */
157 # include <sysexits.h>
160 /* A few OS don't have socklen_t; their os.h files define EXIM_SOCKLEN_T to
161 be size_t or whatever. We used to use SOCKLEN_T, but then it was discovered
162 that this is used by the AIX include files. */
164 #ifndef EXIM_SOCKLEN_T
165 # define EXIM_SOCKLEN_T socklen_t
168 /* Ensure that the sysexits we reference are defined */
170 #ifndef EX_UNAVAILABLE
171 # define EX_UNAVAILABLE 69 /* service unavailable; used for execv fail */
174 # define EX_CANTCREAT 73 /* can't create file: treat as temporary */
177 # define EX_TEMPFAIL 75 /* temp failure; user is invited to retry */
180 # define EX_CONFIG 78 /* configuration error */
183 /* This one is not in any sysexits file that I've come across */
185 #define EX_EXECFAILED 127 /* execve() failed */
188 #include <sys/time.h>
189 #include <sys/param.h>
191 #ifndef NO_SYS_RESOURCE_H /* QNX doesn't have this */
192 # include <sys/resource.h>
195 #include <sys/socket.h>
197 /* If we are on an IPv6 system, the macro AF_INET6 will have been defined in
198 the sys/socket.h header. It is helpful to have this defined on an IPv4 system
199 so that it can appear in the code, even if it is never actually used when
200 the code is run. It saves some #ifdef occurrences. */
206 #include <sys/ioctl.h>
208 /* The new standard is statvfs; some OS have statfs. For statvfs the block
209 counts must be multiplied by the "fragment size" f_frsize to get the actual
210 size. In other cases the value seems to be f_bsize (which is sometimes the only
211 block size), so we use a macro to get that instead.
213 Also arrange to be able to cut it out altogether for way-out OS that don't have
214 anything. I've indented a bit here to try to make the mess a bit more
215 intelligible. Note that simply defining one name to be another when
216 HAVE_SYS_STATVFS_H is not set will not work if the system has a statvfs macro
217 or a macro with entries f_frsize and f_bsize. */
220 #ifdef HAVE_SYS_STATVFS_H
221 #include <sys/statvfs.h>
222 #define STATVFS statvfs
223 #define F_FRSIZE f_frsize
225 #define STATVFS statfs
226 #define F_FRSIZE f_bsize
227 #ifdef HAVE_SYS_VFS_H
229 #ifdef HAVE_SYS_STATFS_H
230 #include <sys/statfs.h>
233 #ifdef HAVE_SYS_MOUNT_H
234 #include <sys/mount.h>
238 /* Macros for the fields for the available space for non-superusers; define
239 these only if the OS header has not. Not all OS have f_favail; those that
240 are known to have it define F_FAVAIL as f_favail. The default is to use
244 # define F_BAVAIL f_bavail
248 # define F_FAVAIL f_ffree
251 /* All the systems I've been able to look at seem to have F_FILES */
254 # define F_FILES f_files
260 #ifndef SIOCGIFCONF /* HACK for SunOS 5 */
261 # include <sys/sockio.h>
264 #include <sys/stat.h>
265 #include <sys/wait.h>
266 #include <sys/utsname.h>
269 /* There's a shambles in IRIX6 - it defines EX_OK in unistd.h which conflicts
270 with the definition in sysexits.h. Exim does not actually use this macro, so we
271 just undefine it. It would be nice to be able to re-instate the definition from
272 sysexits.h if there is no definition in unistd.h, but I do not think there is a
273 way to do this in C because macro definitions are not scanned for other macros
274 at definition time. [The code here used to assume they were, until I was
275 disabused of the notion. Luckily, since EX_OK is not used, it didn't matter.] */
288 #include <netinet/in.h>
289 #include <netinet/tcp.h>
290 #include <arpa/inet.h>
291 #include <arpa/nameser.h>
294 /* While IPv6 is still young the definitions of T_AAAA and T_A6 may not be
295 included in arpa/nameser.h. Fudge them here. */
305 /* Ancient systems (e.g. SunOS4) don't appear to have T_TXT defined in their
306 header files. I don't suppose they have T_SRV either. */
316 /* Many systems do not have T_SPF. */
322 /* New TLSA record for DANE */
326 #define MAX_TLSA_EXPANDED_SIZE 8192
328 /* It seems that some versions of arpa/nameser.h don't define *any* of the
329 T_xxx macros, which seem to be non-standard nowadays. Just to be on the safe
330 side, put in definitions for all the ones that Exim uses. */
357 /* We define a few private types for special DNS lookups:
359 . T_ZNS gets the nameservers of the enclosing zone of a domain
361 . T_MXH gets the MX hostnames only (without their priorities)
363 . T_CSA gets the domain's Client SMTP Authorization SRV record
365 . T_ADDRESSES looks up both AAAA (or A6) and A records
367 If any of these names appear in the RRtype list at:
368 <http://www.iana.org/assignments/dns-parameters/dns-parameters.xhtml>
369 then we should rename Exim's private type away from the conflict.
375 #define T_ADDRESSES (-4)
377 /* The resolv.h header defines __P(x) on some Solaris 2.5.1 systems (without
378 checking that it is already defined, in fact). This conflicts with other
379 headers that behave likewise (see below), leading to compiler warnings. Arrange
380 to undefine it if resolv.h defines it. */
383 # define __P_WAS_DEFINED_BEFORE_RESOLV
388 #if defined(__P) && ! defined (__P_WAS_DEFINED_BEFORE_RESOLV)
392 /* If not defined by os.h, we do nothing special to push DNS resolver state
393 back to be available by the classic resolver routines. Also, provide
394 prototype for our get routine, unless defined away. */
396 #ifndef os_put_dns_resolver_res
397 # define os_put_dns_resolver_res(R) do {/**/} while(0)
399 #ifndef os_get_dns_resolver_res
400 res_state os_get_dns_resolver_res(void);
403 /* These three are to support the IP option logging code. Linux is
404 different to everyone else and there are also other systems which don't
405 have netinet/ip_var.h, so there's a general macro to control its inclusion. */
407 #include <netinet/in_systm.h>
408 #include <netinet/ip.h>
411 # include <netinet/ip_var.h>
414 /* Linux (and some others) uses a different type for the 2nd argument of
415 iconv(). It's os.h file defines ICONV_ARG2_TYPE. For the rest, define a default
418 #ifndef ICONV_ARG2_TYPE
419 # define ICONV_ARG2_TYPE char **
422 /* One OS uses a different type for the 5th argument of getsockopt */
424 #ifndef GETSOCKOPT_ARG5_TYPE
425 # define GETSOCKOPT_ARG5_TYPE socklen_t *
428 /* One operating system uses a different type for the 2nd argument of select().
429 Its os.h file defines SELECT_ARG2_TYPE. For the rest, define a default here. */
431 #ifndef SELECT_ARG2_TYPE
432 # define SELECT_ARG2_TYPE fd_set
435 /* One operating system uses a different type for the 4th argument of
436 dn_expand(). Its os.h file defines DN_EXPAND_ARG4_TYPE. For the rest, define a
439 #ifndef DN_EXPAND_ARG4_TYPE
440 # define DN_EXPAND_ARG4_TYPE char *
443 /* One operating system defines a different type for the yield of inet_addr().
444 In Exim code, its value is always assigned to the s_addr members of address
445 structures. Casting the yield to the type of s_addr should fix the problem,
446 since the size of the data is correct. Just in case this ever has to be
447 changed, use a macro for the type, and define it here so that it is possible to
448 use different values for specific OS if ever necessary. */
451 # define S_ADDR_TYPE u_long
454 /* (At least) one operating system (Solaris) defines a different type for the
455 second argument of pam_converse() - the difference is the absence of "const".
456 Its os.h file defines PAM_CONVERSE_ARG2_TYPE. For the rest, define a default
459 #ifndef PAM_CONVERSE_ARG2_TYPE
460 # define PAM_CONVERSE_ARG2_TYPE const struct pam_message
463 /* One operating system (SunOS4) defines getc, ungetc, feof, and ferror as
464 macros and not as functions. Exim needs them to be assignable functions. This
465 flag gets set to cause this to be sorted out here. */
467 #ifdef FUDGE_GETC_AND_FRIENDS
469 extern int getc(FILE *);
471 extern int ungetc(int, FILE *);
473 extern int feof(FILE *);
475 extern int ferror(FILE *);
478 /* The header from the PCRE regex package */
482 /* Exim includes are in several files. Note that local_scan.h #includes
483 config.h, mytypes.h, and store.h, so we don't need to mention them explicitly.
486 #include "local_scan.h"
493 #include "functions.h"
494 #include "dbfunctions.h"
495 #include "osfunctions.h"
497 #ifdef EXPERIMENTAL_BRIGHTMAIL
498 # include "bmi_spam.h"
503 #ifdef EXPERIMENTAL_SRS_ALT
511 # include <opendmarc/dmarc.h>
514 /* The following stuff must follow the inclusion of config.h because it
515 requires various things that are set therein. */
517 #if HAVE_ICONV /* Not all OS have this */
521 #if defined(USE_READLINE) || defined(EXPAND_DLFUNC) || defined (LOOKUP_MODULE_DIR)
525 #ifdef ENABLE_DISABLE_FSYNC
526 # define EXIMfsync(f) (disable_fsync? 0 : fsync(f))
528 # define EXIMfsync(f) fsync(f)
531 /* Backward compatibility; LOOKUP_LSEARCH now includes all three */
533 #if (!defined LOOKUP_LSEARCH) && (defined LOOKUP_WILDLSEARCH || defined LOOKUP_NWILDLSEARCH)
534 # define LOOKUP_LSEARCH yes
537 /* Define a union to hold either an IPv4 or an IPv6 sockaddr structure; this
538 simplifies some of the coding. We include the sockaddr to reduce type-punning
542 struct sockaddr_in v4;
544 struct sockaddr_in6 v6;
549 /* If DISABLE_TLS is defined, ensure that USE_GNUTLS is not defined
550 so that if USE_GNUTLS *is* set, we can assume DISABLE_TLS is not set.
552 Likewise, OSCP, AUTH_TLS and CERTNAMES cannot be supported. */
557 # ifndef DISABLE_OCSP
558 # define DISABLE_OCSP
560 # undef EXPERIMENTAL_CERTNAMES
564 /* If SPOOL_DIRECTORY, LOG_FILE_PATH or PID_FILE_PATH have not been defined,
565 set them to the null string. */
567 #ifndef SPOOL_DIRECTORY
568 #define SPOOL_DIRECTORY ""
570 #ifndef LOG_FILE_PATH
571 #define LOG_FILE_PATH ""
573 #ifndef PID_FILE_PATH
574 #define PID_FILE_PATH ""
577 /* The EDQUOT error code isn't universally available, though it is widespread.
578 There is a particular shambles in SunOS5, where it did not exist originally,
579 but got installed with a particular patch for Solaris 2.4. There is a
580 configuration variable for specifying what the system's "over quota" error is,
581 which will end up in config.h if supplied in OS/Makefile-xxx. If it is not set,
582 default to EDQUOT if it exists, otherwise ENOSPC. */
586 # define ERRNO_QUOTA EDQUOT
588 # define ERRNO_QUOTA ENOSPC
592 /* DANE w/o DNSSEC is useless */
593 #if defined(SUPPORT_DANE) && defined(DISABLE_DNSSEC)
594 # error DANE support requires DNSSEC support
597 /* Some platforms (FreeBSD, OpenBSD, Solaris) do not seem to define this */
600 # define POLLRDHUP (POLLIN | POLLHUP)
603 /* Some platforms (Darwin) have to define a larger limit on groups membership */
605 #ifndef EXIM_GROUPLIST_SIZE
606 # define EXIM_GROUPLIST_SIZE NGROUPS_MAX