src/src/exim.h

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