1 /* $Cambridge: exim/src/src/exim.h,v 1.16 2005/06/27 10:52:20 ph10 Exp $ */
3 /*************************************************
4 * Exim - an Internet mail transport agent *
5 *************************************************/
7 /* Copyright (c) University of Cambridge 1995 - 2005 */
8 /* See the file NOTICE for conditions of use and distribution. */
11 /* Source files for exim all #include this header, which drags in everything
12 that is needed. They don't all need everything, of course, but it's far too
13 messy to have each one importing its own list, and anyway, most of them need
14 most of these includes. */
16 /* Assume most systems have statfs() unless os.h undefines this macro */
20 /* First of all include the os-specific header, which might set things that
21 are needed by any of the other headers, including system headers. */
25 /* If it didn't define os_find_running_interfaces, use the common function. */
27 #ifndef os_find_running_interfaces
28 #define os_find_running_interfaces os_common_find_running_interfaces
31 /* If it didn't define the base for "base 62" numbers, we really do use 62.
32 This is the case for all real Unix and Unix-like OS. It's only Cygwin and
33 Darwin, with their case-insensitive file systems, that can't use base 62 for
34 making unique names. */
40 /* The maximum value of localhost_number depends on the base being used */
43 #define LOCALHOST_MAX 16
45 #define LOCALHOST_MAX 10
48 /* ANSI C standard includes */
64 #if defined(__svr4__) && defined(__sparc) && ! defined(__EXTENSIONS__)
65 #define __EXTENSIONS__ /* so that SunOS 5 gets NGROUPS_MAX */
72 /* Just in case some aged system doesn't define them... */
75 #define INT_MAX 2147483647
82 /* Some systems have PATH_MAX and some have MAX_PATH_LEN. */
86 #define PATH_MAX MAX_PATH_LEN
92 #include <sys/types.h>
103 /* Not all systems have flock() available. Those that do must define LOCK_SH
110 #ifndef NO_SYSEXITS /* some OS don't have this */
111 #include <sysexits.h>
114 /* A few OS don't have socklen_t; their os.h files define EXIM_SOCKLEN_T to
115 be size_t or whatever. We used to use SOCKLEN_T, but then it was discovered
116 that this is used by the AIX include files. */
118 #ifndef EXIM_SOCKLEN_T
119 #define EXIM_SOCKLEN_T socklen_t
122 /* Ensure that the sysexits we reference are defined */
124 #ifndef EX_UNAVAILABLE
125 #define EX_UNAVAILABLE 69 /* service unavailable; used for execv fail */
128 #define EX_CANTCREAT 73 /* can't create file: treat as temporary */
131 #define EX_TEMPFAIL 75 /* temp failure; user is invited to retry */
134 #define EX_CONFIG 78 /* configuration error */
137 /* This one is not in any sysexits file that I've come across */
139 #define EX_EXECFAILED 127 /* execve() failed */
142 #include <sys/time.h>
143 #include <sys/param.h>
145 #ifndef NO_SYS_RESOURCE_H /* QNX doesn't have this */
146 #include <sys/resource.h>
149 #include <sys/socket.h>
151 /* If we are on an IPv6 system, the macro AF_INET6 will have been defined in
152 the sys/socket.h header. It is helpful to have this defined on an IPv4 system
153 so that it can appear in the code, even if it is never actually used when
154 the code is run. It saves some #ifdef occurrences. */
160 #include <sys/ioctl.h>
162 /* The new standard is statvfs; some OS have statfs. For statvfs the block
163 counts must be multiplied by the "fragment size" f_frsize to get the actual
164 size. In other cases the value seems to be f_bsize (which is sometimes the only
165 block size), so we use a macro to get that instead.
167 Also arrange to be able to cut it out altogether for way-out OS that don't have
168 anything. I've indented a bit here to try to make the mess a bit more
169 intelligible. Note that simply defining one name to be another when
170 HAVE_SYS_STATVFS_H is not set will not work if the system has a statvfs macro
171 or a macro with entries f_frsize and f_bsize. */
174 #ifdef HAVE_SYS_STATVFS_H
175 #include <sys/statvfs.h>
176 #define STATVFS statvfs
177 #define F_FRSIZE f_frsize
179 #define STATVFS statfs
180 #define F_FRSIZE f_bsize
181 #ifdef HAVE_SYS_VFS_H
183 #ifdef HAVE_SYS_STATFS_H
184 #include <sys/statfs.h>
187 #ifdef HAVE_SYS_MOUNT_H
188 #include <sys/mount.h>
192 /* Macros for the fields for the available space for non-superusers; define
193 these only if the OS header has not. Not all OS have f_favail; those that
194 are known to have it define F_FAVAIL as f_favail. The default is to use
198 #define F_BAVAIL f_bavail
202 #define F_FAVAIL f_ffree
205 /* All the systems I've been able to look at seem to have F_FILES */
208 #define F_FILES f_files
214 #ifndef SIOCGIFCONF /* HACK for SunOS 5 */
215 #include <sys/sockio.h>
218 #include <sys/stat.h>
219 #include <sys/wait.h>
220 #include <sys/utsname.h>
223 /* There's a shambles in IRIX6 - it defines EX_OK in unistd.h which conflicts
224 with the definition in sysexits.h. Exim does not actually use this macro, so we
225 just undefine it. It would be nice to be able to re-instate the definition from
226 sysexits.h if there is no definition in unistd.h, but I do not think there is a
227 way to do this in C because macro definitions are not scanned for other macros
228 at definition time. [The code here used to assume they were, until I was
229 disabused of the notion. Luckily, since EX_OK is not used, it didn't matter.] */
242 #include <netinet/in.h>
243 #include <netinet/tcp.h>
244 #include <arpa/inet.h>
245 #include <arpa/nameser.h>
248 /* If arpa/nameser.h defines a maximum name server packet size, use it,
249 provided it is greater than 2048. Otherwise go for a default. PACKETSZ was used
250 for this, but it seems that NS_PACKETSZ is coming into use. */
252 #if defined(NS_PACKETSZ) && NS_PACKETSZ >= 2048
253 #define MAXPACKET NS_PACKETSZ
254 #elif defined(PACKETSZ) && PACKETSZ >= 2048
255 #define MAXPACKET PACKETSZ
257 #define MAXPACKET 2048
260 /* While IPv6 is still young the definitions of T_AAAA and T_A6 may not be
261 included in arpa/nameser.h. Fudge them here. */
271 /* Ancient systems (e.g. SunOS4) don't appear to have T_TXT defined in their
272 header files. I don't suppose they have T_SRV either. */
282 /* It seems that some versions of arpa/nameser.h don't define *any* of the
283 T_xxx macros, which seem to be non-standard nowadays. Just to be on the safe
284 side, put in definitions for all the ones that Exim uses. */
307 /* We define a few private types for special DNS lookups:
309 . T_ZNS gets the nameservers of the enclosing zone of a domain
311 . T_MXH gets the MX hostnames only (without their priorities)
313 . T_CSA gets the domain's Client SMTP Authorization SRV record
321 /* The resolv.h header defines __P(x) on some Solaris 2.5.1 systems (without
322 checking that it is already defined, in fact). This conflicts with other
323 headers that behave likewise (see below), leading to compiler warnings. Arrange
324 to undefine it if resolv.h defines it. */
327 #define __P_WAS_DEFINED_BEFORE_RESOLV
332 #if defined(__P) && ! defined (__P_WAS_DEFINED_BEFORE_RESOLV)
336 /* These three are to support the IP option logging code. Linux is
337 different to everyone else and there are also other systems which don't
338 have netinet/ip_var.h, so there's a general macro to control its inclusion. */
340 #include <netinet/in_systm.h>
341 #include <netinet/ip.h>
344 #include <netinet/ip_var.h>
347 /* Linux (and some others) uses a different type for the 2nd argument of
348 iconv(). It's os.h file defines ICONV_ARG2_TYPE. For the rest, define a default
351 #ifndef ICONV_ARG2_TYPE
352 #define ICONV_ARG2_TYPE const char **
355 /* One OS uses a different type for the 5th argument of getsockopt */
357 #ifndef GETSOCKOPT_ARG5_TYPE
358 #define GETSOCKOPT_ARG5_TYPE socklen_t *
361 /* One operating system uses a different type for the 2nd argument of select().
362 Its os.h file defines SELECT_ARG2_TYPE. For the rest, define a default here. */
364 #ifndef SELECT_ARG2_TYPE
365 #define SELECT_ARG2_TYPE fd_set
368 /* One operating system uses a different type for the 4th argument of
369 dn_expand(). Its os.h file defines DN_EXPAND_ARG4_TYPE. For the rest, define a
372 #ifndef DN_EXPAND_ARG4_TYPE
373 #define DN_EXPAND_ARG4_TYPE char *
376 /* One operating system defines a different type for the yield of inet_addr().
377 In Exim code, its value is always assigned to the s_addr members of address
378 structures. Casting the yield to the type of s_addr should fix the problem,
379 since the size of the data is correct. Just in case this ever has to be
380 changed, use a macro for the type, and define it here so that it is possible to
381 use different values for specific OS if ever necessary. */
384 #define S_ADDR_TYPE u_long
387 /* (At least) one operating system (Solaris) defines a different type for the
388 second argument of pam_converse() - the difference is the absence of "const".
389 Its os.h file defines PAM_CONVERSE_ARG2_TYPE. For the rest, define a default
392 #ifndef PAM_CONVERSE_ARG2_TYPE
393 #define PAM_CONVERSE_ARG2_TYPE const struct pam_message
396 /* One operating system (SunOS4) defines getc, ungetc, feof, and ferror as
397 macros and not as functions. Exim needs them to be assignable functions. This
398 flag gets set to cause this to be sorted out here. */
400 #ifdef FUDGE_GETC_AND_FRIENDS
402 extern int getc(FILE *);
404 extern int ungetc(int, FILE *);
406 extern int feof(FILE *);
408 extern int ferror(FILE *);
411 /* The header from the PCRE regex package */
413 #include "pcre/pcre.h"
415 /* Exim includes are in several files. Note that local_scan.h #includes
416 mytypes.h and store.h, so we don't need to mention them explicitly. */
420 #include "local_scan.h"
425 #include "functions.h"
426 #include "dbfunctions.h"
427 #include "osfunctions.h"
429 #ifdef EXPERIMENTAL_BRIGHTMAIL
430 #include "bmi_spam.h"
432 #ifdef EXPERIMENTAL_SPF
435 #ifdef EXPERIMENTAL_SRS
438 #ifdef EXPERIMENTAL_DOMAINKEYS
442 /* The following stuff must follow the inclusion of config.h because it
443 requires various things that are set therein. */
445 #if HAVE_ICONV /* Not all OS have this */
449 #if defined(USE_READLINE) || defined(EXPAND_DLFUNC)
453 /* Backward compatibility; LOOKUP_LSEARCH now includes all three */
455 #if (!defined LOOKUP_LSEARCH) && (defined LOOKUP_WILDLSEARCH || defined LOOKUP_NWILDLSEARCH)
456 #define LOOKUP_LSEARCH yes
459 /* Define a union to hold either an IPv4 or an IPv6 sockaddr structure; this
460 simplifies some of the coding. */
463 struct sockaddr_in v4;
465 struct sockaddr_in6 v6;
469 /* If SUPPORT_TLS is not defined, ensure that USE_GNUTLS is also not defined
470 so that if USE_GNUTLS *is* set, we can assume SUPPORT_TLS is also set. */
476 /* If SPOOL_DIRECTORY, LOG_FILE_PATH or PID_FILE_PATH have not been defined,
477 set them to the null string. */
479 #ifndef SPOOL_DIRECTORY
480 #define SPOOL_DIRECTORY ""
482 #ifndef LOG_FILE_PATH
483 #define LOG_FILE_PATH ""
485 #ifndef PID_FILE_PATH
486 #define PID_FILE_PATH ""
489 /* The EDQUOT error code isn't universally available, though it is widespread.
490 There is a particular shambles in SunOS5, where it did not exist originally,
491 but got installed with a particular patch for Solaris 2.4. There is a
492 configuration variable for specifying what the system's "over quota" error is,
493 which will end up in config.h if supplied in OS/Makefile-xxx. If it is not set,
494 default to EDQUOT if it exists, otherwise ENOSPC. */
498 #define ERRNO_QUOTA EDQUOT
500 #define ERRNO_QUOTA ENOSPC
504 /* Ensure PATH_MAX is defined */
508 #define PATH_MAX MAXPATHLEN
510 #define PATH_MAX 1024