src/src/exim.h

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