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