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