1 /*************************************************
2 * Exim - an Internet mail transport agent *
3 *************************************************/
5 /* Copyright (c) University of Cambridge 1995 - 2009 */
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. */
14 /* Assume most systems have statfs() unless os.h undefines this macro */
18 /* Similarly, assume most systems have srandom() unless os.h undefines it.
19 This call dates back at least as far as SUSv2. */
23 /* First of all include the os-specific header, which might set things that
24 are needed by any of the other headers, including system headers. */
28 /* If it didn't define os_find_running_interfaces, use the common function. */
30 #ifndef os_find_running_interfaces
31 #define os_find_running_interfaces os_common_find_running_interfaces
34 /* If it didn't define the base for "base 62" numbers, we really do use 62.
35 This is the case for all real Unix and Unix-like OS. It's only Cygwin and
36 Darwin, with their case-insensitive file systems, that can't use base 62 for
37 making unique names. */
43 /* The maximum value of localhost_number depends on the base being used */
46 #define LOCALHOST_MAX 16
48 #define LOCALHOST_MAX 10
51 /* ANSI C standard includes */
67 #if defined(__svr4__) && defined(__sparc) && ! defined(__EXTENSIONS__)
68 #define __EXTENSIONS__ /* so that SunOS 5 gets NGROUPS_MAX */
75 /* Just in case some aged system doesn't define them... */
78 #define INT_MAX 2147483647
82 #define INT_MIN (-INT_MAX - 1)
86 #define SHRT_MAX 32767
93 /* Some systems have PATH_MAX and some have MAX_PATH_LEN. */
97 #define PATH_MAX MAX_PATH_LEN
103 #include <sys/types.h>
104 #include <sys/file.h>
114 /* Not all systems have flock() available. Those that do must define LOCK_SH
121 #ifndef NO_SYSEXITS /* some OS don't have this */
122 #include <sysexits.h>
125 /* A few OS don't have socklen_t; their os.h files define EXIM_SOCKLEN_T to
126 be size_t or whatever. We used to use SOCKLEN_T, but then it was discovered
127 that this is used by the AIX include files. */
129 #ifndef EXIM_SOCKLEN_T
130 #define EXIM_SOCKLEN_T socklen_t
133 /* Ensure that the sysexits we reference are defined */
135 #ifndef EX_UNAVAILABLE
136 #define EX_UNAVAILABLE 69 /* service unavailable; used for execv fail */
139 #define EX_CANTCREAT 73 /* can't create file: treat as temporary */
142 #define EX_TEMPFAIL 75 /* temp failure; user is invited to retry */
145 #define EX_CONFIG 78 /* configuration error */
148 /* This one is not in any sysexits file that I've come across */
150 #define EX_EXECFAILED 127 /* execve() failed */
153 #include <sys/time.h>
154 #include <sys/param.h>
156 #ifndef NO_SYS_RESOURCE_H /* QNX doesn't have this */
157 #include <sys/resource.h>
160 #include <sys/socket.h>
162 /* If we are on an IPv6 system, the macro AF_INET6 will have been defined in
163 the sys/socket.h header. It is helpful to have this defined on an IPv4 system
164 so that it can appear in the code, even if it is never actually used when
165 the code is run. It saves some #ifdef occurrences. */
171 #include <sys/ioctl.h>
173 /* The new standard is statvfs; some OS have statfs. For statvfs the block
174 counts must be multiplied by the "fragment size" f_frsize to get the actual
175 size. In other cases the value seems to be f_bsize (which is sometimes the only
176 block size), so we use a macro to get that instead.
178 Also arrange to be able to cut it out altogether for way-out OS that don't have
179 anything. I've indented a bit here to try to make the mess a bit more
180 intelligible. Note that simply defining one name to be another when
181 HAVE_SYS_STATVFS_H is not set will not work if the system has a statvfs macro
182 or a macro with entries f_frsize and f_bsize. */
185 #ifdef HAVE_SYS_STATVFS_H
186 #include <sys/statvfs.h>
187 #define STATVFS statvfs
188 #define F_FRSIZE f_frsize
190 #define STATVFS statfs
191 #define F_FRSIZE f_bsize
192 #ifdef HAVE_SYS_VFS_H
194 #ifdef HAVE_SYS_STATFS_H
195 #include <sys/statfs.h>
198 #ifdef HAVE_SYS_MOUNT_H
199 #include <sys/mount.h>
203 /* Macros for the fields for the available space for non-superusers; define
204 these only if the OS header has not. Not all OS have f_favail; those that
205 are known to have it define F_FAVAIL as f_favail. The default is to use
209 #define F_BAVAIL f_bavail
213 #define F_FAVAIL f_ffree
216 /* All the systems I've been able to look at seem to have F_FILES */
219 #define F_FILES f_files
225 #ifndef SIOCGIFCONF /* HACK for SunOS 5 */
226 #include <sys/sockio.h>
229 #include <sys/stat.h>
230 #include <sys/wait.h>
231 #include <sys/utsname.h>
234 /* There's a shambles in IRIX6 - it defines EX_OK in unistd.h which conflicts
235 with the definition in sysexits.h. Exim does not actually use this macro, so we
236 just undefine it. It would be nice to be able to re-instate the definition from
237 sysexits.h if there is no definition in unistd.h, but I do not think there is a
238 way to do this in C because macro definitions are not scanned for other macros
239 at definition time. [The code here used to assume they were, until I was
240 disabused of the notion. Luckily, since EX_OK is not used, it didn't matter.] */
253 #include <netinet/in.h>
254 #include <netinet/tcp.h>
255 #include <arpa/inet.h>
256 #include <arpa/nameser.h>
259 /* If arpa/nameser.h defines a maximum name server packet size, use it,
260 provided it is greater than 2048. Otherwise go for a default. PACKETSZ was used
261 for this, but it seems that NS_PACKETSZ is coming into use. */
263 #if defined(NS_PACKETSZ) && NS_PACKETSZ >= 2048
264 #define MAXPACKET NS_PACKETSZ
265 #elif defined(PACKETSZ) && PACKETSZ >= 2048
266 #define MAXPACKET PACKETSZ
268 #define MAXPACKET 2048
271 /* While IPv6 is still young the definitions of T_AAAA and T_A6 may not be
272 included in arpa/nameser.h. Fudge them here. */
282 /* Ancient systems (e.g. SunOS4) don't appear to have T_TXT defined in their
283 header files. I don't suppose they have T_SRV either. */
293 /* It seems that some versions of arpa/nameser.h don't define *any* of the
294 T_xxx macros, which seem to be non-standard nowadays. Just to be on the safe
295 side, put in definitions for all the ones that Exim uses. */
322 /* We define a few private types for special DNS lookups:
324 . T_ZNS gets the nameservers of the enclosing zone of a domain
326 . T_MXH gets the MX hostnames only (without their priorities)
328 . T_CSA gets the domain's Client SMTP Authorization SRV record
336 /* The resolv.h header defines __P(x) on some Solaris 2.5.1 systems (without
337 checking that it is already defined, in fact). This conflicts with other
338 headers that behave likewise (see below), leading to compiler warnings. Arrange
339 to undefine it if resolv.h defines it. */
342 #define __P_WAS_DEFINED_BEFORE_RESOLV
347 #if defined(__P) && ! defined (__P_WAS_DEFINED_BEFORE_RESOLV)
351 /* These three are to support the IP option logging code. Linux is
352 different to everyone else and there are also other systems which don't
353 have netinet/ip_var.h, so there's a general macro to control its inclusion. */
355 #include <netinet/in_systm.h>
356 #include <netinet/ip.h>
359 #include <netinet/ip_var.h>
362 /* Linux (and some others) uses a different type for the 2nd argument of
363 iconv(). It's os.h file defines ICONV_ARG2_TYPE. For the rest, define a default
366 #ifndef ICONV_ARG2_TYPE
367 #define ICONV_ARG2_TYPE const char **
370 /* One OS uses a different type for the 5th argument of getsockopt */
372 #ifndef GETSOCKOPT_ARG5_TYPE
373 #define GETSOCKOPT_ARG5_TYPE socklen_t *
376 /* One operating system uses a different type for the 2nd argument of select().
377 Its os.h file defines SELECT_ARG2_TYPE. For the rest, define a default here. */
379 #ifndef SELECT_ARG2_TYPE
380 #define SELECT_ARG2_TYPE fd_set
383 /* One operating system uses a different type for the 4th argument of
384 dn_expand(). Its os.h file defines DN_EXPAND_ARG4_TYPE. For the rest, define a
387 #ifndef DN_EXPAND_ARG4_TYPE
388 #define DN_EXPAND_ARG4_TYPE char *
391 /* One operating system defines a different type for the yield of inet_addr().
392 In Exim code, its value is always assigned to the s_addr members of address
393 structures. Casting the yield to the type of s_addr should fix the problem,
394 since the size of the data is correct. Just in case this ever has to be
395 changed, use a macro for the type, and define it here so that it is possible to
396 use different values for specific OS if ever necessary. */
399 #define S_ADDR_TYPE u_long
402 /* (At least) one operating system (Solaris) defines a different type for the
403 second argument of pam_converse() - the difference is the absence of "const".
404 Its os.h file defines PAM_CONVERSE_ARG2_TYPE. For the rest, define a default
407 #ifndef PAM_CONVERSE_ARG2_TYPE
408 #define PAM_CONVERSE_ARG2_TYPE const struct pam_message
411 /* One operating system (SunOS4) defines getc, ungetc, feof, and ferror as
412 macros and not as functions. Exim needs them to be assignable functions. This
413 flag gets set to cause this to be sorted out here. */
415 #ifdef FUDGE_GETC_AND_FRIENDS
417 extern int getc(FILE *);
419 extern int ungetc(int, FILE *);
421 extern int feof(FILE *);
423 extern int ferror(FILE *);
426 /* The header from the PCRE regex package */
430 /* Exim includes are in several files. Note that local_scan.h #includes
431 config.h, mytypes.h, and store.h, so we don't need to mention them explicitly.
434 #include "local_scan.h"
439 #include "functions.h"
440 #include "dbfunctions.h"
441 #include "osfunctions.h"
443 #ifdef EXPERIMENTAL_BRIGHTMAIL
444 #include "bmi_spam.h"
446 #ifdef EXPERIMENTAL_SPF
449 #ifdef EXPERIMENTAL_SRS
456 /* The following stuff must follow the inclusion of config.h because it
457 requires various things that are set therein. */
459 #if HAVE_ICONV /* Not all OS have this */
463 #if defined(USE_READLINE) || defined(EXPAND_DLFUNC) || defined (LOOKUP_MODULE_DIR)
467 #ifdef ENABLE_DISABLE_FSYNC
468 #define EXIMfsync(f) (disable_fsync? 0 : fsync(f))
470 #define EXIMfsync(f) fsync(f)
473 /* Backward compatibility; LOOKUP_LSEARCH now includes all three */
475 #if (!defined LOOKUP_LSEARCH) && (defined LOOKUP_WILDLSEARCH || defined LOOKUP_NWILDLSEARCH)
476 #define LOOKUP_LSEARCH yes
479 /* Define a union to hold either an IPv4 or an IPv6 sockaddr structure; this
480 simplifies some of the coding. We include the sockaddr to reduce type-punning
484 struct sockaddr_in v4;
486 struct sockaddr_in6 v6;
491 /* If SUPPORT_TLS is not defined, ensure that USE_GNUTLS is also not defined
492 so that if USE_GNUTLS *is* set, we can assume SUPPORT_TLS is also set. */
498 /* If SPOOL_DIRECTORY, LOG_FILE_PATH or PID_FILE_PATH have not been defined,
499 set them to the null string. */
501 #ifndef SPOOL_DIRECTORY
502 #define SPOOL_DIRECTORY ""
504 #ifndef LOG_FILE_PATH
505 #define LOG_FILE_PATH ""
507 #ifndef PID_FILE_PATH
508 #define PID_FILE_PATH ""
511 /* The EDQUOT error code isn't universally available, though it is widespread.
512 There is a particular shambles in SunOS5, where it did not exist originally,
513 but got installed with a particular patch for Solaris 2.4. There is a
514 configuration variable for specifying what the system's "over quota" error is,
515 which will end up in config.h if supplied in OS/Makefile-xxx. If it is not set,
516 default to EDQUOT if it exists, otherwise ENOSPC. */
520 #define ERRNO_QUOTA EDQUOT
522 #define ERRNO_QUOTA ENOSPC
526 /* Ensure PATH_MAX is defined */
530 #define PATH_MAX MAXPATHLEN
532 #define PATH_MAX 1024
536 /* These are for reporting version information from various componenents, to
537 figure out what's actually happening. They need to be available to the main
538 function, so we declare them here. Unfortunate. */
540 #ifdef AUTH_CYRUS_SASL
541 extern void auth_cyrus_sasl_version_report(FILE *);