src/src/exim.h

   1 /*************************************************
   2 *     Exim - an Internet mail transport agent    *
   3 *************************************************/
   4
   5 /* Copyright (c) University of Cambridge 1995 - 2009 */
   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 /* It seems that some versions of arpa/nameser.h don't define *any* of the
 303 T_xxx macros, which seem to be non-standard nowadays. Just to be on the safe
 304 side, put in definitions for all the ones that Exim uses. */
 305
 306 #ifndef T_A
 307 #define T_A 1
 308 #endif
 309
 310 #ifndef T_CNAME
 311 #define T_CNAME 5
 312 #endif
 313
 314 #ifndef T_SOA
 315 #define T_SOA 6
 316 #endif
 317
 318 #ifndef T_MX
 319 #define T_MX 15
 320 #endif
 321
 322 #ifndef T_NS
 323 #define T_NS 2
 324 #endif
 325
 326 #ifndef T_PTR
 327 #define T_PTR 12
 328 #endif
 329
 330
 331 /* We define a few private types for special DNS lookups:
 332
 333  . T_ZNS gets the nameservers of the enclosing zone of a domain
 334
 335  . T_MXH gets the MX hostnames only (without their priorities)
 336
 337  . T_CSA gets the domain's Client SMTP Authorization SRV record
 338
 339 */
 340
 341 #define T_ZNS (-1)
 342 #define T_MXH (-2)
 343 #define T_CSA (-3)
 344
 345 /* The resolv.h header defines __P(x) on some Solaris 2.5.1 systems (without
 346 checking that it is already defined, in fact). This conflicts with other
 347 headers that behave likewise (see below), leading to compiler warnings. Arrange
 348 to undefine it if resolv.h defines it. */
 349
 350 #if defined(__P)
 351 #define __P_WAS_DEFINED_BEFORE_RESOLV
 352 #endif
 353
 354 #include <resolv.h>
 355
 356 #if defined(__P) && ! defined (__P_WAS_DEFINED_BEFORE_RESOLV)
 357 #undef __P
 358 #endif
 359
 360 /* If not defined by os.h, we do nothing special to push DNS resolver state
 361 back to be available by the classic resolver routines.  Also, provide
 362 prototype for our get routine, unless defined away. */
 363
 364 #ifndef os_put_dns_resolver_res
 365 # define os_put_dns_resolver_res(R) do {/**/} while(0)
 366 #endif
 367 #ifndef os_get_dns_resolver_res
 368 res_state os_get_dns_resolver_res(void);
 369 #endif
 370
 371 /* These three are to support the IP option logging code. Linux is
 372 different to everyone else and there are also other systems which don't
 373 have netinet/ip_var.h, so there's a general macro to control its inclusion. */
 374
 375 #include <netinet/in_systm.h>
 376 #include <netinet/ip.h>
 377
 378 #ifndef NO_IP_VAR_H
 379 #include <netinet/ip_var.h>
 380 #endif
 381
 382 /* Linux (and some others) uses a different type for the 2nd argument of
 383 iconv(). It's os.h file defines ICONV_ARG2_TYPE. For the rest, define a default
 384 here. */
 385
 386 #ifndef ICONV_ARG2_TYPE
 387 #define ICONV_ARG2_TYPE const char **
 388 #endif
 389
 390 /* One OS uses a different type for the 5th argument of getsockopt */
 391
 392 #ifndef GETSOCKOPT_ARG5_TYPE
 393 #define GETSOCKOPT_ARG5_TYPE socklen_t *
 394 #endif
 395
 396 /* One operating system uses a different type for the 2nd argument of select().
 397 Its os.h file defines SELECT_ARG2_TYPE. For the rest, define a default here. */
 398
 399 #ifndef SELECT_ARG2_TYPE
 400 #define SELECT_ARG2_TYPE fd_set
 401 #endif
 402
 403 /* One operating system uses a different type for the 4th argument of
 404 dn_expand(). Its os.h file defines DN_EXPAND_ARG4_TYPE. For the rest, define a
 405 default here. */
 406
 407 #ifndef DN_EXPAND_ARG4_TYPE
 408 #define DN_EXPAND_ARG4_TYPE char *
 409 #endif
 410
 411 /* One operating system defines a different type for the yield of inet_addr().
 412 In Exim code, its value is always assigned to the s_addr members of address
 413 structures. Casting the yield to the type of s_addr should fix the problem,
 414 since the size of the data is correct. Just in case this ever has to be
 415 changed, use a macro for the type, and define it here so that it is possible to
 416 use different values for specific OS if ever necessary. */
 417
 418 #ifndef S_ADDR_TYPE
 419 #define S_ADDR_TYPE u_long
 420 #endif
 421
 422 /* (At least) one operating system (Solaris) defines a different type for the
 423 second argument of pam_converse() - the difference is the absence of "const".
 424 Its os.h file defines PAM_CONVERSE_ARG2_TYPE. For the rest, define a default
 425 here. */
 426
 427 #ifndef PAM_CONVERSE_ARG2_TYPE
 428 #define PAM_CONVERSE_ARG2_TYPE const struct pam_message
 429 #endif
 430
 431 /* One operating system (SunOS4) defines getc, ungetc, feof, and ferror as
 432 macros and not as functions. Exim needs them to be assignable functions. This
 433 flag gets set to cause this to be sorted out here. */
 434
 435 #ifdef FUDGE_GETC_AND_FRIENDS
 436 #undef getc
 437 extern int getc(FILE *);
 438 #undef ungetc
 439 extern int ungetc(int, FILE *);
 440 #undef feof
 441 extern int feof(FILE *);
 442 #undef ferror
 443 extern int ferror(FILE *);
 444 #endif
 445
 446 /* The header from the PCRE regex package */
 447
 448 #include <pcre.h>
 449
 450 /* Exim includes are in several files. Note that local_scan.h #includes
 451 config.h, mytypes.h, and store.h, so we don't need to mention them explicitly.
 452 */
 453
 454 #include "local_scan.h"
 455 #include "macros.h"
 456 #include "dbstuff.h"
 457 #include "structs.h"
 458 #include "globals.h"
 459 #include "functions.h"
 460 #include "dbfunctions.h"
 461 #include "osfunctions.h"
 462
 463 #ifdef EXPERIMENTAL_BRIGHTMAIL
 464 #include "bmi_spam.h"
 465 #endif
 466 #ifdef EXPERIMENTAL_SPF
 467 #include "spf.h"
 468 #endif
 469 #ifdef EXPERIMENTAL_SRS
 470 #include "srs.h"
 471 #endif
 472 #ifndef DISABLE_DKIM
 473 #include "dkim.h"
 474 #endif
 475
 476 /* The following stuff must follow the inclusion of config.h because it
 477 requires various things that are set therein. */
 478
 479 #if HAVE_ICONV             /* Not all OS have this */
 480 #include <iconv.h>
 481 #endif
 482
 483 #if defined(USE_READLINE) || defined(EXPAND_DLFUNC) || defined (LOOKUP_MODULE_DIR)
 484 #include <dlfcn.h>
 485 #endif
 486
 487 #ifdef ENABLE_DISABLE_FSYNC
 488 #define EXIMfsync(f) (disable_fsync? 0 : fsync(f))
 489 #else
 490 #define EXIMfsync(f) fsync(f)
 491 #endif
 492
 493 /* Backward compatibility; LOOKUP_LSEARCH now includes all three */
 494
 495 #if (!defined LOOKUP_LSEARCH) && (defined LOOKUP_WILDLSEARCH || defined LOOKUP_NWILDLSEARCH)
 496 #define LOOKUP_LSEARCH yes
 497 #endif
 498
 499 /* Define a union to hold either an IPv4 or an IPv6 sockaddr structure; this
 500 simplifies some of the coding.  We include the sockaddr to reduce type-punning
 501 issues in C99. */
 502
 503 union sockaddr_46 {
 504   struct sockaddr_in v4;
 505   #if HAVE_IPV6
 506   struct sockaddr_in6 v6;
 507   #endif
 508   struct sockaddr v0;
 509 };
 510
 511 /* If SUPPORT_TLS is not defined, ensure that USE_GNUTLS is also not defined
 512 so that if USE_GNUTLS *is* set, we can assume SUPPORT_TLS is also set. */
 513
 514 #ifndef SUPPORT_TLS
 515 #undef USE_GNUTLS
 516 #endif
 517
 518 /* If SPOOL_DIRECTORY, LOG_FILE_PATH or PID_FILE_PATH have not been defined,
 519 set them to the null string. */
 520
 521 #ifndef SPOOL_DIRECTORY
 522   #define SPOOL_DIRECTORY ""
 523 #endif
 524 #ifndef LOG_FILE_PATH
 525   #define LOG_FILE_PATH ""
 526 #endif
 527 #ifndef PID_FILE_PATH
 528   #define PID_FILE_PATH ""
 529 #endif
 530
 531 /* The EDQUOT error code isn't universally available, though it is widespread.
 532 There is a particular shambles in SunOS5, where it did not exist originally,
 533 but got installed with a particular patch for Solaris 2.4. There is a
 534 configuration variable for specifying what the system's "over quota" error is,
 535 which will end up in config.h if supplied in OS/Makefile-xxx. If it is not set,
 536 default to EDQUOT if it exists, otherwise ENOSPC. */
 537
 538 #ifndef ERRNO_QUOTA
 539 #ifdef  EDQUOT
 540 #define ERRNO_QUOTA EDQUOT
 541 #else
 542 #define ERRNO_QUOTA ENOSPC
 543 #endif
 544 #endif
 545
 546 /* Ensure PATH_MAX is defined */
 547
 548 #ifndef PATH_MAX
 549   #ifdef MAXPATHLEN
 550   #define PATH_MAX MAXPATHLEN
 551   #else
 552   #define PATH_MAX 1024
 553   #endif
 554 #endif
 555
 556 /* End of exim.h */