src/src/exim.h

   1 /* $Cambridge: exim/src/src/exim.h,v 1.4 2004/12/16 15:11:47 tom Exp $ */
   2
   3 /*************************************************
   4 *     Exim - an Internet mail transport agent    *
   5 *************************************************/
   6
   7 /* Copyright (c) University of Cambridge 1995 - 2004 */
   8 /* See the file NOTICE for conditions of use and distribution. */
   9
  10
  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. */
  15
  16 /* Assume most systems have statfs() unless os.h undefines this macro */
  17
  18 #define HAVE_STATFS
  19
  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. */
  22
  23 #include "os.h"
  24
  25 /* If it didn't define os_find_running_interfaces, use the common function. */
  26
  27 #ifndef os_find_running_interfaces
  28 #define os_find_running_interfaces os_common_find_running_interfaces
  29 #endif
  30
  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. */
  35
  36 #ifndef BASE_62
  37 #define BASE_62 62
  38 #endif
  39
  40 /* The maximum value of localhost_number depends on the base being used */
  41
  42 #if BASE_62 == 62
  43 #define LOCALHOST_MAX  16
  44 #else
  45 #define LOCALHOST_MAX  10
  46 #endif
  47
  48 /* ANSI C standard includes */
  49
  50 #include <ctype.h>
  51 #include <locale.h>
  52 #include <signal.h>
  53 #include <stdarg.h>
  54 #include <stddef.h>
  55 #include <stdio.h>
  56 #include <stdlib.h>
  57 #include <string.h>
  58 #include <time.h>
  59
  60 /* Unix includes */
  61
  62 #include <errno.h>
  63 #if     defined(__svr4__) && defined(__sparc) && ! defined(__EXTENSIONS__)
  64 #define __EXTENSIONS__  /* so that SunOS 5 gets NGROUPS_MAX */
  65 #include <limits.h>
  66 #undef  __EXTENSIONS__
  67 #else
  68 #include <limits.h>
  69 #endif
  70
  71 /* Just in case some aged system doesn't define them... */
  72
  73 #ifndef INT_MAX
  74 #define INT_MAX 2147483647
  75 #endif
  76
  77 #ifndef UCHAR_MAX
  78 #define UCHAR_MAX 255
  79 #endif
  80
  81 /* Some systems have PATH_MAX and some have MAX_PATH_LEN. */
  82
  83 #ifndef PATH_MAX
  84 #ifdef MAX_PATH_LEN
  85 #define PATH_MAX MAX_PATH_LEN
  86 #else
  87 #define PATH_MAX 1024
  88 #endif
  89 #endif
  90
  91 #include <sys/types.h>
  92 #include <sys/file.h>
  93 #include <dirent.h>
  94 #include <netdb.h>
  95 #include <pwd.h>
  96 #include <grp.h>
  97 #include <syslog.h>
  98
  99 /* Not all systems have flock() available. Those that do must define LOCK_SH
 100 in sys/file.h. */
 101
 102 #ifndef LOCK_SH
 103 #define NO_FLOCK
 104 #endif
 105
 106 #ifndef NO_SYSEXITS        /* some OS don't have this */
 107 #include <sysexits.h>
 108 #endif
 109
 110 /* A few OS don't have socklen_t; their os.h files define SOCKLEN_T to
 111 be size_t or whatever. */
 112
 113 #ifndef SOCKLEN_T
 114 #define SOCKLEN_T socklen_t
 115 #endif
 116
 117 /* Ensure that the sysexits we reference are defined */
 118
 119 #ifndef EX_UNAVAILABLE
 120 #define EX_UNAVAILABLE 69        /* service unavailable; used for execv fail */
 121 #endif
 122 #ifndef EX_CANTCREAT
 123 #define EX_CANTCREAT   73        /* can't create file: treat as temporary */
 124 #endif
 125 #ifndef EX_TEMPFAIL
 126 #define EX_TEMPFAIL    75        /* temp failure; user is invited to retry */
 127 #endif
 128 #ifndef EX_CONFIG
 129 #define EX_CONFIG      78        /* configuration error */
 130 #endif
 131
 132 /* This one is not in any sysexits file that I've come across */
 133
 134 #define EX_EXECFAILED 127        /* execve() failed */
 135
 136
 137 #include <sys/time.h>
 138 #include <sys/param.h>
 139
 140 #ifndef NO_SYS_RESOURCE_H  /* QNX doesn't have this */
 141 #include <sys/resource.h>
 142 #endif
 143
 144 #include <sys/socket.h>
 145
 146 /* If we are on an IPv6 system, the macro AF_INET6 will have been defined in
 147 the sys/socket.h header. It is helpful to have this defined on an IPv4 system
 148 so that it can appear in the code, even if it is never actually used when
 149 the code is run. It saves some #ifdef occurrences. */
 150
 151 #ifndef AF_INET6
 152 #define AF_INET6 24
 153 #endif
 154
 155 #include <sys/ioctl.h>
 156
 157 /* The new standard is statvfs; some OS have statfs. For statvfs the block
 158 counts must be multiplied by the "fragment size" f_frsize to get the actual
 159 size. In other cases the value seems to be f_bsize (which is sometimes the only
 160 block size), so we use a macro to get that instead.
 161
 162 Also arrange to be able to cut it out altogether for way-out OS that don't have
 163 anything. I've indented a bit here to try to make the mess a bit more
 164 intelligible. Note that simply defining one name to be another when
 165 HAVE_SYS_STATVFS_H is not set will not work if the system has a statvfs macro
 166 or a macro with entries f_frsize and f_bsize. */
 167
 168 #ifdef HAVE_STATFS
 169   #ifdef HAVE_SYS_STATVFS_H
 170     #include <sys/statvfs.h>
 171     #define STATVFS statvfs
 172     #define F_FRSIZE f_frsize
 173   #else
 174     #define STATVFS statfs
 175     #define F_FRSIZE f_bsize
 176     #ifdef HAVE_SYS_VFS_H
 177       #include <sys/vfs.h>
 178       #ifdef HAVE_SYS_STATFS_H
 179       #include <sys/statfs.h>
 180       #endif
 181     #endif
 182     #ifdef HAVE_SYS_MOUNT_H
 183     #include <sys/mount.h>
 184     #endif
 185   #endif
 186
 187   /* Macros for the fields for the available space for non-superusers; define
 188   these only if the OS header has not. Not all OS have f_favail; those that
 189   are known to have it define F_FAVAIL as f_favail. The default is to use
 190   f_free. */
 191
 192   #ifndef F_BAVAIL
 193   #define F_BAVAIL f_bavail
 194   #endif
 195
 196   #ifndef F_FAVAIL
 197   #define F_FAVAIL f_ffree
 198   #endif
 199
 200   /* All the systems I've been able to look at seem to have F_FILES */
 201
 202   #ifndef F_FILES
 203   #define F_FILES  f_files
 204   #endif
 205
 206 #endif
 207
 208
 209 #ifndef  SIOCGIFCONF     /* HACK for SunOS 5 */
 210 #include <sys/sockio.h>
 211 #endif
 212
 213 #include <sys/stat.h>
 214 #include <sys/wait.h>
 215 #include <sys/utsname.h>
 216 #include <fcntl.h>
 217
 218 /* There's a shambles in IRIX6 - it defines EX_OK in unistd.h which conflicts
 219 with the definition in sysexits.h. Arrange to preserve it, even though at
 220 present Exim doesn't actually use it. */
 221
 222 #ifdef EX_OK
 223 #define SAVE_EX_OK EX_OK
 224 #undef EX_OK
 225 #endif
 226
 227 #include <unistd.h>
 228
 229 #ifdef SAVE_EX_OK
 230 #ifdef EX_OK
 231 #undef EX_OK
 232 #endif
 233 #define EX_OK SAVE_EX_OK
 234 #endif
 235
 236 #include <utime.h>
 237 #ifndef NO_NET_IF_H
 238 #include <net/if.h>
 239 #endif
 240 #include <sys/un.h>
 241 #include <netinet/in.h>
 242 #include <netinet/tcp.h>
 243 #include <arpa/inet.h>
 244 #include <arpa/nameser.h>
 245
 246
 247 /* If arpa/nameser.h defines a maximum name server packet size, use it,
 248 provided it is greater than 2048. Otherwise go for a default. PACKETSZ was used
 249 for this, but it seems that NS_PACKETSZ is coming into use. */
 250
 251 #if defined(NS_PACKETSZ) && NS_PACKETSZ >= 2048
 252   #define MAXPACKET NS_PACKETSZ
 253 #elif defined(PACKETSZ) && PACKETSZ >= 2048
 254   #define MAXPACKET PACKETSZ
 255 #else
 256   #define MAXPACKET 2048
 257 #endif
 258
 259 /* While IPv6 is still young the definitions of T_AAAA and T_A6 may not be
 260 included in arpa/nameser.h. Fudge them here. */
 261
 262 #ifndef T_AAAA
 263 #define T_AAAA 28
 264 #endif
 265
 266 #ifndef T_A6
 267 #define T_A6 38
 268 #endif
 269
 270 /* Ancient systems (e.g. SunOS4) don't appear to have T_TXT defined in their
 271 header files. I don't suppose they have T_SRV either. */
 272
 273 #ifndef T_TXT
 274 #define T_TXT 16
 275 #endif
 276
 277 #ifndef T_SRV
 278 #define T_SRV 33
 279 #endif
 280
 281 /* We use the private type T_ZNS for retrieving the nameservers for the
 282 enclosing zone of a domain, and the private type T_MXH for retrieving
 283 the MX hostnames only (without their priorities). */
 284
 285 #define T_ZNS (-1)
 286 #define T_MXH (-2)
 287
 288 /* The resolv.h header defines __P(x) on some Solaris 2.5.1 systems (without
 289 checking that it is already defined, in fact). This conflicts with other
 290 headers that behave likewise (see below), leading to compiler warnings. Arrange
 291 to undefine it if resolv.h defines it. */
 292
 293 #if defined(__P)
 294 #define __P_WAS_DEFINED_BEFORE_RESOLV
 295 #endif
 296
 297 #include <resolv.h>
 298
 299 #if defined(__P) && ! defined (__P_WAS_DEFINED_BEFORE_RESOLV)
 300 #undef __P
 301 #endif
 302
 303 /* These three are to support the IP option logging code. Linux is
 304 different to everyone else and there are also other systems which don't
 305 have netinet/ip_var.h, so there's a general macro to control its inclusion. */
 306
 307 #include <netinet/in_systm.h>
 308 #include <netinet/ip.h>
 309
 310 #ifndef NO_IP_VAR_H
 311 #include <netinet/ip_var.h>
 312 #endif
 313
 314 /* Linux (and some others) uses a different type for the 2nd argument of
 315 iconv(). It's os.h file defines ICONV_ARG2_TYPE. For the rest, define a default
 316 here. */
 317
 318 #ifndef ICONV_ARG2_TYPE
 319 #define ICONV_ARG2_TYPE const char **
 320 #endif
 321
 322 /* One OS uses a different type for the 5th argument of getsockopt */
 323
 324 #ifndef GETSOCKOPT_ARG5_TYPE
 325 #define GETSOCKOPT_ARG5_TYPE socklen_t *
 326 #endif
 327
 328 /* One operating system uses a different type for the 2nd argument of select().
 329 Its os.h file defines SELECT_ARG2_TYPE. For the rest, define a default here. */
 330
 331 #ifndef SELECT_ARG2_TYPE
 332 #define SELECT_ARG2_TYPE fd_set
 333 #endif
 334
 335 /* One operating system uses a different type for the 4th argument of
 336 dn_expand(). Its os.h file defines DN_EXPAND_ARG4_TYPE. For the rest, define a
 337 default here. */
 338
 339 #ifndef DN_EXPAND_ARG4_TYPE
 340 #define DN_EXPAND_ARG4_TYPE char *
 341 #endif
 342
 343 /* One operating system defines a different type for the yield of inet_addr().
 344 In Exim code, its value is always assigned to the s_addr members of address
 345 structures. Casting the yield to the type of s_addr should fix the problem,
 346 since the size of the data is correct. Just in case this ever has to be
 347 changed, use a macro for the type, and define it here so that it is possible to
 348 use different values for specific OS if ever necessary. */
 349
 350 #ifndef S_ADDR_TYPE
 351 #define S_ADDR_TYPE u_long
 352 #endif
 353
 354 /* (At least) one operating system (Solaris) defines a different type for the
 355 second argument of pam_converse() - the difference is the absence of "const".
 356 Its os.h file defines PAM_CONVERSE_ARG2_TYPE. For the rest, define a default
 357 here. */
 358
 359 #ifndef PAM_CONVERSE_ARG2_TYPE
 360 #define PAM_CONVERSE_ARG2_TYPE const struct pam_message
 361 #endif
 362
 363 /* One operating system (SunOS4) defines getc, ungetc, feof, and ferror as
 364 macros and not as functions. Exim needs them to be assignable functions. This
 365 flag gets set to cause this to be sorted out here. */
 366
 367 #ifdef FUDGE_GETC_AND_FRIENDS
 368 #undef getc
 369 extern int getc(FILE *);
 370 #undef ungetc
 371 extern int ungetc(int, FILE *);
 372 #undef feof
 373 extern int feof(FILE *);
 374 #undef ferror
 375 extern int ferror(FILE *);
 376 #endif
 377
 378 /* The header from the PCRE regex package */
 379
 380 #include "pcre/pcre.h"
 381
 382 /* Exim includes are in several files. Note that local_scan.h #includes
 383 mytypes.h and store.h, so we don't need to mention them explicitly. */
 384 #include "config.h"
 385
 386 /* Before including the rest of the Exim headers, lets clear up some content
 387 scanning dependencies. */
 388 #ifdef WITH_OLD_DEMIME
 389 #define WITH_CONTENT_SCAN
 390 #endif
 391
 392 #include "local_scan.h"
 393 #include "macros.h"
 394 #include "dbstuff.h"
 395 #include "structs.h"
 396 #include "globals.h"
 397 #include "functions.h"
 398 #include "dbfunctions.h"
 399 #include "osfunctions.h"
 400
 401 #ifdef EXPERIMENTAL_BRIGHTMAIL
 402 #include "bmi_spam.h"
 403 #endif
 404 #ifdef EXPERIMENTAL_SPF
 405 #include "spf.h"
 406 #endif
 407 #ifdef EXPERIMENTAL_SRS
 408 #include "srs.h"
 409 #endif
 410
 411 /* The following stuff must follow the inclusion of config.h because it
 412 requires various things that are set therein. */
 413
 414 #if HAVE_ICONV             /* Not all OS have this */
 415 #include <iconv.h>
 416 #endif
 417
 418 #ifdef USE_READLINE
 419 #include <dlfcn.h>
 420 #endif
 421
 422 /* Backward compatibility; LOOKUP_LSEARCH now includes all three */
 423
 424 #if (!defined LOOKUP_LSEARCH) && (defined LOOKUP_WILDLSEARCH || defined LOOKUP_NWILDLSEARCH)
 425 #define LOOKUP_LSEARCH yes
 426 #endif
 427
 428 /* Define a union to hold either an IPv4 or an IPv6 sockaddr structure; this
 429 simplifies some of the coding. */
 430
 431 union sockaddr_46 {
 432   struct sockaddr_in v4;
 433   #if HAVE_IPV6
 434   struct sockaddr_in6 v6;
 435   #endif
 436 };
 437
 438 /* If SUPPORT_TLS is not defined, ensure that USE_GNUTLS is also not defined
 439 so that if USE_GNUTLS *is* set, we can assume SUPPORT_TLS is also set. */
 440
 441 #ifndef SUPPORT_TLS
 442 #undef USE_GNUTLS
 443 #endif
 444
 445 /* If SPOOL_DIRECTORY, LOG_FILE_PATH or PID_FILE_PATH have not been defined,
 446 set them to the null string. */
 447
 448 #ifndef SPOOL_DIRECTORY
 449   #define SPOOL_DIRECTORY ""
 450 #endif
 451 #ifndef LOG_FILE_PATH
 452   #define LOG_FILE_PATH ""
 453 #endif
 454 #ifndef PID_FILE_PATH
 455   #define PID_FILE_PATH ""
 456 #endif
 457
 458 /* The EDQUOT error code isn't universally available, though it is widespread.
 459 There is a particular shambles in SunOS5, where it did not exist originally,
 460 but got installed with a particular patch for Solaris 2.4. There is a
 461 configuration variable for specifying what the system's "over quota" error is,
 462 which will end up in config.h if supplied in OS/Makefile-xxx. If it is not set,
 463 default to EDQUOT if it exists, otherwise ENOSPC. */
 464
 465 #ifndef ERRNO_QUOTA
 466 #ifdef  EDQUOT
 467 #define ERRNO_QUOTA EDQUOT
 468 #else
 469 #define ERRNO_QUOTA ENOSPC
 470 #endif
 471 #endif
 472
 473 /* Ensure PATH_MAX is defined */
 474
 475 #ifndef PATH_MAX
 476   #ifdef MAXPATHLEN
 477   #define PATH_MAX MAXPATHLEN
 478   #else
 479   #define PATH_MAX 1024
 480   #endif
 481 #endif
 482
 483
 484 /* End of exim.h */