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 /* ANSI C standard includes */
  52
  53 #include <ctype.h>
  54 #include <locale.h>
  55 #include <math.h>
  56 #include <signal.h>
  57 #include <stdarg.h>
  58 #include <stddef.h>
  59 #include <stdio.h>
  60 #include <stdlib.h>
  61 #include <string.h>
  62 #include <time.h>
  63
  64 /* Unix includes */
  65
  66 #include <errno.h>
  67 #if defined(__svr4__) && defined(__sparc) && ! defined(__EXTENSIONS__)
  68 #define __EXTENSIONS__  /* so that SunOS 5 gets NGROUPS_MAX */
  69 #include <limits.h>
  70 #undef  __EXTENSIONS__
  71 #else
  72 #include <limits.h>
  73 #endif
  74
  75 /* Just in case some aged system doesn't define them... */
  76
  77 #ifndef INT_MAX
  78 #define INT_MAX 2147483647
  79 #endif
  80
  81 #ifndef INT_MIN
  82 #define INT_MIN (-INT_MAX - 1)
  83 #endif
  84
  85 #ifndef SHRT_MAX
  86 #define SHRT_MAX 32767
  87 #endif
  88
  89 #ifndef UCHAR_MAX
  90 #define UCHAR_MAX 255
  91 #endif
  92
  93 /* Some systems have PATH_MAX and some have MAX_PATH_LEN. */
  94
  95 #ifndef PATH_MAX
  96 #ifdef MAX_PATH_LEN
  97 #define PATH_MAX MAX_PATH_LEN
  98 #else
  99 #define PATH_MAX 1024
 100 #endif
 101 #endif
 102
 103 #include <sys/types.h>
 104 #include <sys/file.h>
 105 #include <dirent.h>
 106 #include <netdb.h>
 107 #ifndef NO_POLL_H
 108 #include <poll.h>
 109 #endif
 110 #include <pwd.h>
 111 #include <grp.h>
 112 #include <syslog.h>
 113
 114 /* Not all systems have flock() available. Those that do must define LOCK_SH
 115 in sys/file.h. */
 116
 117 #ifndef LOCK_SH
 118 #define NO_FLOCK
 119 #endif
 120
 121 #ifndef NO_SYSEXITS        /* some OS don't have this */
 122 #include <sysexits.h>
 123 #endif
 124
 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. */
 128
 129 #ifndef EXIM_SOCKLEN_T
 130 #define EXIM_SOCKLEN_T socklen_t
 131 #endif
 132
 133 /* Ensure that the sysexits we reference are defined */
 134
 135 #ifndef EX_UNAVAILABLE
 136 #define EX_UNAVAILABLE 69        /* service unavailable; used for execv fail */
 137 #endif
 138 #ifndef EX_CANTCREAT
 139 #define EX_CANTCREAT   73        /* can't create file: treat as temporary */
 140 #endif
 141 #ifndef EX_TEMPFAIL
 142 #define EX_TEMPFAIL    75        /* temp failure; user is invited to retry */
 143 #endif
 144 #ifndef EX_CONFIG
 145 #define EX_CONFIG      78        /* configuration error */
 146 #endif
 147
 148 /* This one is not in any sysexits file that I've come across */
 149
 150 #define EX_EXECFAILED 127        /* execve() failed */
 151
 152
 153 #include <sys/time.h>
 154 #include <sys/param.h>
 155
 156 #ifndef NO_SYS_RESOURCE_H  /* QNX doesn't have this */
 157 #include <sys/resource.h>
 158 #endif
 159
 160 #include <sys/socket.h>
 161
 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. */
 166
 167 #ifndef AF_INET6
 168 #define AF_INET6 24
 169 #endif
 170
 171 #include <sys/ioctl.h>
 172
 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.
 177
 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. */
 183
 184 #ifdef HAVE_STATFS
 185   #ifdef HAVE_SYS_STATVFS_H
 186     #include <sys/statvfs.h>
 187     #define STATVFS statvfs
 188     #define F_FRSIZE f_frsize
 189   #else
 190     #define STATVFS statfs
 191     #define F_FRSIZE f_bsize
 192     #ifdef HAVE_SYS_VFS_H
 193       #include <sys/vfs.h>
 194       #ifdef HAVE_SYS_STATFS_H
 195       #include <sys/statfs.h>
 196       #endif
 197     #endif
 198     #ifdef HAVE_SYS_MOUNT_H
 199     #include <sys/mount.h>
 200     #endif
 201   #endif
 202
 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
 206   f_free. */
 207
 208   #ifndef F_BAVAIL
 209   #define F_BAVAIL f_bavail
 210   #endif
 211
 212   #ifndef F_FAVAIL
 213   #define F_FAVAIL f_ffree
 214   #endif
 215
 216   /* All the systems I've been able to look at seem to have F_FILES */
 217
 218   #ifndef F_FILES
 219   #define F_FILES  f_files
 220   #endif
 221
 222 #endif
 223
 224
 225 #ifndef  SIOCGIFCONF   /* HACK for SunOS 5 */
 226 #include <sys/sockio.h>
 227 #endif
 228
 229 #include <sys/stat.h>
 230 #include <sys/wait.h>
 231 #include <sys/utsname.h>
 232 #include <fcntl.h>
 233
 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.] */
 241
 242 #ifdef EX_OK
 243 #undef EX_OK
 244 #endif
 245
 246 #include <unistd.h>
 247
 248 #include <utime.h>
 249 #ifndef NO_NET_IF_H
 250 #include <net/if.h>
 251 #endif
 252 #include <sys/un.h>
 253 #include <netinet/in.h>
 254 #include <netinet/tcp.h>
 255 #include <arpa/inet.h>
 256 #include <arpa/nameser.h>
 257
 258
 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. */
 262
 263 #if defined(NS_PACKETSZ) && NS_PACKETSZ >= 2048
 264   #define MAXPACKET NS_PACKETSZ
 265 #elif defined(PACKETSZ) && PACKETSZ >= 2048
 266   #define MAXPACKET PACKETSZ
 267 #else
 268   #define MAXPACKET 2048
 269 #endif
 270
 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. */
 273
 274 #ifndef T_AAAA
 275 #define T_AAAA 28
 276 #endif
 277
 278 #ifndef T_A6
 279 #define T_A6 38
 280 #endif
 281
 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. */
 284
 285 #ifndef T_TXT
 286 #define T_TXT 16
 287 #endif
 288
 289 #ifndef T_SRV
 290 #define T_SRV 33
 291 #endif
 292
 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. */
 296
 297 #ifndef T_A
 298 #define T_A 1
 299 #endif
 300
 301 #ifndef T_CNAME
 302 #define T_CNAME 5
 303 #endif
 304
 305 #ifndef T_SOA
 306 #define T_SOA 6
 307 #endif
 308
 309 #ifndef T_MX
 310 #define T_MX 15
 311 #endif
 312
 313 #ifndef T_NS
 314 #define T_NS 2
 315 #endif
 316
 317 #ifndef T_PTR
 318 #define T_PTR 12
 319 #endif
 320
 321
 322 /* We define a few private types for special DNS lookups:
 323
 324  . T_ZNS gets the nameservers of the enclosing zone of a domain
 325
 326  . T_MXH gets the MX hostnames only (without their priorities)
 327
 328  . T_CSA gets the domain's Client SMTP Authorization SRV record
 329
 330 */
 331
 332 #define T_ZNS (-1)
 333 #define T_MXH (-2)
 334 #define T_CSA (-3)
 335
 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. */
 340
 341 #if defined(__P)
 342 #define __P_WAS_DEFINED_BEFORE_RESOLV
 343 #endif
 344
 345 #include <resolv.h>
 346
 347 #if defined(__P) && ! defined (__P_WAS_DEFINED_BEFORE_RESOLV)
 348 #undef __P
 349 #endif
 350
 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. */
 354
 355 #include <netinet/in_systm.h>
 356 #include <netinet/ip.h>
 357
 358 #ifndef NO_IP_VAR_H
 359 #include <netinet/ip_var.h>
 360 #endif
 361
 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
 364 here. */
 365
 366 #ifndef ICONV_ARG2_TYPE
 367 #define ICONV_ARG2_TYPE const char **
 368 #endif
 369
 370 /* One OS uses a different type for the 5th argument of getsockopt */
 371
 372 #ifndef GETSOCKOPT_ARG5_TYPE
 373 #define GETSOCKOPT_ARG5_TYPE socklen_t *
 374 #endif
 375
 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. */
 378
 379 #ifndef SELECT_ARG2_TYPE
 380 #define SELECT_ARG2_TYPE fd_set
 381 #endif
 382
 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
 385 default here. */
 386
 387 #ifndef DN_EXPAND_ARG4_TYPE
 388 #define DN_EXPAND_ARG4_TYPE char *
 389 #endif
 390
 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. */
 397
 398 #ifndef S_ADDR_TYPE
 399 #define S_ADDR_TYPE u_long
 400 #endif
 401
 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
 405 here. */
 406
 407 #ifndef PAM_CONVERSE_ARG2_TYPE
 408 #define PAM_CONVERSE_ARG2_TYPE const struct pam_message
 409 #endif
 410
 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. */
 414
 415 #ifdef FUDGE_GETC_AND_FRIENDS
 416 #undef getc
 417 extern int getc(FILE *);
 418 #undef ungetc
 419 extern int ungetc(int, FILE *);
 420 #undef feof
 421 extern int feof(FILE *);
 422 #undef ferror
 423 extern int ferror(FILE *);
 424 #endif
 425
 426 /* The header from the PCRE regex package */
 427
 428 #include <pcre.h>
 429
 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.
 432 */
 433
 434 #include "local_scan.h"
 435 #include "macros.h"
 436 #include "dbstuff.h"
 437 #include "structs.h"
 438 #include "globals.h"
 439 #include "functions.h"
 440 #include "dbfunctions.h"
 441 #include "osfunctions.h"
 442
 443 #ifdef EXPERIMENTAL_BRIGHTMAIL
 444 #include "bmi_spam.h"
 445 #endif
 446 #ifdef EXPERIMENTAL_SPF
 447 #include "spf.h"
 448 #endif
 449 #ifdef EXPERIMENTAL_SRS
 450 #include "srs.h"
 451 #endif
 452 #ifndef DISABLE_DKIM
 453 #include "dkim.h"
 454 #endif
 455
 456 /* The following stuff must follow the inclusion of config.h because it
 457 requires various things that are set therein. */
 458
 459 #if HAVE_ICONV             /* Not all OS have this */
 460 #include <iconv.h>
 461 #endif
 462
 463 #if defined(USE_READLINE) || defined(EXPAND_DLFUNC) || defined (LOOKUP_MODULE_DIR)
 464 #include <dlfcn.h>
 465 #endif
 466
 467 #ifdef ENABLE_DISABLE_FSYNC
 468 #define EXIMfsync(f) (disable_fsync? 0 : fsync(f))
 469 #else
 470 #define EXIMfsync(f) fsync(f)
 471 #endif
 472
 473 /* Backward compatibility; LOOKUP_LSEARCH now includes all three */
 474
 475 #if (!defined LOOKUP_LSEARCH) && (defined LOOKUP_WILDLSEARCH || defined LOOKUP_NWILDLSEARCH)
 476 #define LOOKUP_LSEARCH yes
 477 #endif
 478
 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
 481 issues in C99. */
 482
 483 union sockaddr_46 {
 484   struct sockaddr_in v4;
 485   #if HAVE_IPV6
 486   struct sockaddr_in6 v6;
 487   #endif
 488   struct sockaddr v0;
 489 };
 490
 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. */
 493
 494 #ifndef SUPPORT_TLS
 495 #undef USE_GNUTLS
 496 #endif
 497
 498 /* If SPOOL_DIRECTORY, LOG_FILE_PATH or PID_FILE_PATH have not been defined,
 499 set them to the null string. */
 500
 501 #ifndef SPOOL_DIRECTORY
 502   #define SPOOL_DIRECTORY ""
 503 #endif
 504 #ifndef LOG_FILE_PATH
 505   #define LOG_FILE_PATH ""
 506 #endif
 507 #ifndef PID_FILE_PATH
 508   #define PID_FILE_PATH ""
 509 #endif
 510
 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. */
 517
 518 #ifndef ERRNO_QUOTA
 519 #ifdef  EDQUOT
 520 #define ERRNO_QUOTA EDQUOT
 521 #else
 522 #define ERRNO_QUOTA ENOSPC
 523 #endif
 524 #endif
 525
 526 /* Ensure PATH_MAX is defined */
 527
 528 #ifndef PATH_MAX
 529   #ifdef MAXPATHLEN
 530   #define PATH_MAX MAXPATHLEN
 531   #else
 532   #define PATH_MAX 1024
 533   #endif
 534 #endif
 535
 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. */
 539
 540 #ifdef AUTH_CYRUS_SASL
 541 extern void auth_cyrus_sasl_version_report(FILE *);
 542 #endif
 543
 544 /* End of exim.h */