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