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