src/src/exim.h

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