Handle SIGINT as we do with SIGTERM
[exim.git] / src / src / daemon.c
1 /*************************************************
2 *     Exim - an Internet mail transport agent    *
3 *************************************************/
4
5 /* Copyright (c) University of Cambridge 1995 - 2018 */
6 /* Copyright (c) The Exim Maintainers 2020 */
7 /* See the file NOTICE for conditions of use and distribution. */
8
9 /* Functions concerned with running Exim as a daemon */
10
11
12 #include "exim.h"
13
14
15 /* Structure for holding data for each SMTP connection */
16
17 typedef struct smtp_slot {
18   pid_t pid;                       /* pid of the spawned reception process */
19   uschar *host_address;            /* address of the client host */
20 } smtp_slot;
21
22 /* An empty slot for initializing (Standard C does not allow constructor
23 expressions in assignments except as initializers in declarations). */
24
25 static smtp_slot empty_smtp_slot = { .pid = 0, .host_address = NULL };
26
27
28
29 /*************************************************
30 *               Local static variables           *
31 *************************************************/
32
33 static SIGNAL_BOOL sigchld_seen;
34 static SIGNAL_BOOL sighup_seen;
35 static SIGNAL_BOOL sigterm_seen;
36
37 static int   accept_retry_count = 0;
38 static int   accept_retry_errno;
39 static BOOL  accept_retry_select_failed;
40
41 static int   queue_run_count = 0;
42 static pid_t *queue_pid_slots = NULL;
43 static smtp_slot *smtp_slots = NULL;
44
45 static BOOL  write_pid = TRUE;
46
47
48
49 /*************************************************
50 *             SIGHUP Handler                     *
51 *************************************************/
52
53 /* All this handler does is to set a flag and re-enable the signal.
54
55 Argument: the signal number
56 Returns:  nothing
57 */
58
59 static void
60 sighup_handler(int sig)
61 {
62 sighup_seen = TRUE;
63 signal(SIGHUP, sighup_handler);
64 }
65
66
67
68 /*************************************************
69 *     SIGCHLD handler for main daemon process    *
70 *************************************************/
71
72 /* Don't re-enable the handler here, since we aren't doing the
73 waiting here. If the signal is re-enabled, there will just be an
74 infinite sequence of calls to this handler. The SIGCHLD signal is
75 used just as a means of waking up the daemon so that it notices
76 terminated subprocesses as soon as possible.
77
78 Argument: the signal number
79 Returns:  nothing
80 */
81
82 static void
83 main_sigchld_handler(int sig)
84 {
85 os_non_restarting_signal(SIGCHLD, SIG_DFL);
86 sigchld_seen = TRUE;
87 }
88
89
90 /* SIGTERM handler.  Try to get the damon pif file removed
91 before exiting. */
92
93 static void
94 main_sigterm_handler(int sig)
95 {
96 sigterm_seen = TRUE;
97 }
98
99
100
101
102 /*************************************************
103 *          Unexpected errors in SMTP calls       *
104 *************************************************/
105
106 /* This function just saves a bit of repetitious coding.
107
108 Arguments:
109   log_msg        Text of message to be logged
110   smtp_msg       Text of SMTP error message
111   was_errno      The failing errno
112
113 Returns:         nothing
114 */
115
116 static void
117 never_error(uschar *log_msg, uschar *smtp_msg, int was_errno)
118 {
119 uschar *emsg = was_errno <= 0
120   ? US"" : string_sprintf(": %s", strerror(was_errno));
121 log_write(0, LOG_MAIN|LOG_PANIC, "%s%s", log_msg, emsg);
122 if (smtp_out) smtp_printf("421 %s\r\n", FALSE, smtp_msg);
123 }
124
125
126
127
128 /*************************************************
129 *************************************************/
130
131 #ifndef EXIM_HAVE_ABSTRACT_UNIX_SOCKETS
132 static void
133 unlink_notifier_socket(void)
134 {
135 uschar * s = expand_string(notifier_socket);
136 DEBUG(D_any) debug_printf("unlinking notifier socket %s\n", s);
137 Uunlink(s);
138 }
139 #endif
140
141
142 static void
143 close_daemon_sockets(int daemon_notifier_fd,
144   int * listen_sockets, int listen_socket_count)
145 {
146 if (daemon_notifier_fd >= 0)
147   {
148   (void) close(daemon_notifier_fd);
149   daemon_notifier_fd = -1;
150 #ifndef EXIM_HAVE_ABSTRACT_UNIX_SOCKETS
151   unlink_notifier_socket();
152 #endif
153   }
154
155 for (int i = 0; i < listen_socket_count; i++) (void) close(listen_sockets[i]);
156 }
157
158
159 /*************************************************
160 *            Handle a connected SMTP call        *
161 *************************************************/
162
163 /* This function is called when an SMTP connection has been accepted.
164 If there are too many, give an error message and close down. Otherwise
165 spin off a sub-process to handle the call. The list of listening sockets
166 is required so that they can be closed in the sub-process. Take care not to
167 leak store in this process - reset the stacking pool at the end.
168
169 Arguments:
170   listen_sockets        sockets which are listening for incoming calls
171   listen_socket_count   count of listening sockets
172   accept_socket         socket of the current accepted call
173   accepted              socket information about the current call
174
175 Returns:            nothing
176 */
177
178 static void
179 handle_smtp_call(int *listen_sockets, int listen_socket_count,
180   int accept_socket, struct sockaddr *accepted)
181 {
182 pid_t pid;
183 union sockaddr_46 interface_sockaddr;
184 EXIM_SOCKLEN_T ifsize = sizeof(interface_sockaddr);
185 int dup_accept_socket = -1;
186 int max_for_this_host = 0;
187 int save_log_selector = *log_selector;
188 gstring * whofrom;
189
190 rmark reset_point = store_mark();
191
192 /* Make the address available in ASCII representation, and also fish out
193 the remote port. */
194
195 sender_host_address = host_ntoa(-1, accepted, NULL, &sender_host_port);
196 DEBUG(D_any) debug_printf("Connection request from %s port %d\n",
197   sender_host_address, sender_host_port);
198
199 /* Set up the output stream, check the socket has duplicated, and set up the
200 input stream. These operations fail only the exceptional circumstances. Note
201 that never_error() won't use smtp_out if it is NULL. */
202
203 if (!(smtp_out = fdopen(accept_socket, "wb")))
204   {
205   never_error(US"daemon: fdopen() for smtp_out failed", US"", errno);
206   goto ERROR_RETURN;
207   }
208
209 if ((dup_accept_socket = dup(accept_socket)) < 0)
210   {
211   never_error(US"daemon: couldn't dup socket descriptor",
212     US"Connection setup failed", errno);
213   goto ERROR_RETURN;
214   }
215
216 if (!(smtp_in = fdopen(dup_accept_socket, "rb")))
217   {
218   never_error(US"daemon: fdopen() for smtp_in failed",
219     US"Connection setup failed", errno);
220   goto ERROR_RETURN;
221   }
222
223 /* Get the data for the local interface address. Panic for most errors, but
224 "connection reset by peer" just means the connection went away. */
225
226 if (getsockname(accept_socket, (struct sockaddr *)(&interface_sockaddr),
227      &ifsize) < 0)
228   {
229   log_write(0, LOG_MAIN | ((errno == ECONNRESET)? 0 : LOG_PANIC),
230     "getsockname() failed: %s", strerror(errno));
231   smtp_printf("421 Local problem: getsockname() failed; please try again later\r\n", FALSE);
232   goto ERROR_RETURN;
233   }
234
235 interface_address = host_ntoa(-1, &interface_sockaddr, NULL, &interface_port);
236 DEBUG(D_interface) debug_printf("interface address=%s port=%d\n",
237   interface_address, interface_port);
238
239 /* Build a string identifying the remote host and, if requested, the port and
240 the local interface data. This is for logging; at the end of this function the
241 memory is reclaimed. */
242
243 whofrom = string_append(NULL, 3, "[", sender_host_address, "]");
244
245 if (LOGGING(incoming_port))
246   whofrom = string_fmt_append(whofrom, ":%d", sender_host_port);
247
248 if (LOGGING(incoming_interface))
249   whofrom = string_fmt_append(whofrom, " I=[%s]:%d",
250     interface_address, interface_port);
251
252 (void) string_from_gstring(whofrom);    /* Terminate the newly-built string */
253
254 /* Check maximum number of connections. We do not check for reserved
255 connections or unacceptable hosts here. That is done in the subprocess because
256 it might take some time. */
257
258 if (smtp_accept_max > 0 && smtp_accept_count >= smtp_accept_max)
259   {
260   DEBUG(D_any) debug_printf("rejecting SMTP connection: count=%d max=%d\n",
261     smtp_accept_count, smtp_accept_max);
262   smtp_printf("421 Too many concurrent SMTP connections; "
263     "please try again later.\r\n", FALSE);
264   log_write(L_connection_reject,
265             LOG_MAIN, "Connection from %s refused: too many connections",
266     whofrom->s);
267   goto ERROR_RETURN;
268   }
269
270 /* If a load limit above which only reserved hosts are acceptable is defined,
271 get the load average here, and if there are in fact no reserved hosts, do
272 the test right away (saves a fork). If there are hosts, do the check in the
273 subprocess because it might take time. */
274
275 if (smtp_load_reserve >= 0)
276   {
277   load_average = OS_GETLOADAVG();
278   if (smtp_reserve_hosts == NULL && load_average > smtp_load_reserve)
279     {
280     DEBUG(D_any) debug_printf("rejecting SMTP connection: load average = %.2f\n",
281       (double)load_average/1000.0);
282     smtp_printf("421 Too much load; please try again later.\r\n", FALSE);
283     log_write(L_connection_reject,
284               LOG_MAIN, "Connection from %s refused: load average = %.2f",
285       whofrom->s, (double)load_average/1000.0);
286     goto ERROR_RETURN;
287     }
288   }
289
290 /* Check that one specific host (strictly, IP address) is not hogging
291 resources. This is done here to prevent a denial of service attack by someone
292 forcing you to fork lots of times before denying service. The value of
293 smtp_accept_max_per_host is a string which is expanded. This makes it possible
294 to provide host-specific limits according to $sender_host address, but because
295 this is in the daemon mainline, only fast expansions (such as inline address
296 checks) should be used. The documentation is full of warnings. */
297
298 if (smtp_accept_max_per_host)
299   {
300   uschar *expanded = expand_string(smtp_accept_max_per_host);
301   if (!expanded)
302     {
303     if (!f.expand_string_forcedfail)
304       log_write(0, LOG_MAIN|LOG_PANIC, "expansion of smtp_accept_max_per_host "
305         "failed for %s: %s", whofrom->s, expand_string_message);
306     }
307   /* For speed, interpret a decimal number inline here */
308   else
309     {
310     uschar *s = expanded;
311     while (isdigit(*s))
312       max_for_this_host = max_for_this_host * 10 + *s++ - '0';
313     if (*s)
314       log_write(0, LOG_MAIN|LOG_PANIC, "expansion of smtp_accept_max_per_host "
315         "for %s contains non-digit: %s", whofrom->s, expanded);
316     }
317   }
318
319 /* If we have fewer connections than max_for_this_host, we can skip the tedious
320 per host_address checks. Note that at this stage smtp_accept_count contains the
321 count of *other* connections, not including this one. */
322
323 if (max_for_this_host > 0 && smtp_accept_count >= max_for_this_host)
324   {
325   int host_accept_count = 0;
326   int other_host_count = 0;    /* keep a count of non matches to optimise */
327
328   for (int i = 0; i < smtp_accept_max; ++i)
329     if (smtp_slots[i].host_address)
330       {
331       if (Ustrcmp(sender_host_address, smtp_slots[i].host_address) == 0)
332        host_accept_count++;
333       else
334        other_host_count++;
335
336       /* Testing all these strings is expensive - see if we can drop out
337       early, either by hitting the target, or finding there are not enough
338       connections left to make the target. */
339
340       if (  host_accept_count >= max_for_this_host
341          || smtp_accept_count - other_host_count < max_for_this_host)
342        break;
343       }
344
345   if (host_accept_count >= max_for_this_host)
346     {
347     DEBUG(D_any) debug_printf("rejecting SMTP connection: too many from this "
348       "IP address: count=%d max=%d\n",
349       host_accept_count, max_for_this_host);
350     smtp_printf("421 Too many concurrent SMTP connections "
351       "from this IP address; please try again later.\r\n", FALSE);
352     log_write(L_connection_reject,
353               LOG_MAIN, "Connection from %s refused: too many connections "
354       "from that IP address", whofrom->s);
355     search_tidyup();
356     goto ERROR_RETURN;
357     }
358   }
359
360 /* OK, the connection count checks have been passed. Before we can fork the
361 accepting process, we must first log the connection if requested. This logging
362 used to happen in the subprocess, but doing that means that the value of
363 smtp_accept_count can be out of step by the time it is logged. So we have to do
364 the logging here and accept the performance cost. Note that smtp_accept_count
365 hasn't yet been incremented to take account of this connection.
366
367 In order to minimize the cost (because this is going to happen for every
368 connection), do a preliminary selector test here. This saves ploughing through
369 the generalized logging code each time when the selector is false. If the
370 selector is set, check whether the host is on the list for logging. If not,
371 arrange to unset the selector in the subprocess. */
372
373 if (LOGGING(smtp_connection))
374   {
375   uschar *list = hosts_connection_nolog;
376   memset(sender_host_cache, 0, sizeof(sender_host_cache));
377   if (list != NULL && verify_check_host(&list) == OK)
378     save_log_selector &= ~L_smtp_connection;
379   else
380     log_write(L_smtp_connection, LOG_MAIN, "SMTP connection from %s "
381       "(TCP/IP connection count = %d)", whofrom->s, smtp_accept_count + 1);
382   }
383
384 /* Now we can fork the accepting process; do a lookup tidy, just in case any
385 expansion above did a lookup. */
386
387 search_tidyup();
388 pid = exim_fork(US"daemon-accept");
389
390 /* Handle the child process */
391
392 if (pid == 0)
393   {
394   int queue_only_reason = 0;
395   int old_pool = store_pool;
396   int save_debug_selector = debug_selector;
397   BOOL local_queue_only;
398   BOOL session_local_queue_only;
399   #ifdef SA_NOCLDWAIT
400   struct sigaction act;
401   #endif
402
403   smtp_accept_count++;    /* So that it includes this process */
404
405   /* May have been modified for the subprocess */
406
407   *log_selector = save_log_selector;
408
409   /* Get the local interface address into permanent store */
410
411   store_pool = POOL_PERM;
412   interface_address = string_copy(interface_address);
413   store_pool = old_pool;
414
415   /* Check for a tls-on-connect port */
416
417   if (host_is_tls_on_connect_port(interface_port)) tls_in.on_connect = TRUE;
418
419   /* Expand smtp_active_hostname if required. We do not do this any earlier,
420   because it may depend on the local interface address (indeed, that is most
421   likely what it depends on.) */
422
423   smtp_active_hostname = primary_hostname;
424   if (raw_active_hostname)
425     {
426     uschar * nah = expand_string(raw_active_hostname);
427     if (!nah)
428       {
429       if (!f.expand_string_forcedfail)
430         {
431         log_write(0, LOG_MAIN|LOG_PANIC, "failed to expand \"%s\" "
432           "(smtp_active_hostname): %s", raw_active_hostname,
433           expand_string_message);
434         smtp_printf("421 Local configuration error; "
435           "please try again later.\r\n", FALSE);
436         mac_smtp_fflush();
437         search_tidyup();
438         exim_underbar_exit(EXIT_FAILURE);
439         }
440       }
441     else if (*nah) smtp_active_hostname = nah;
442     }
443
444   /* Initialize the queueing flags */
445
446   queue_check_only();
447   session_local_queue_only = queue_only;
448
449   /* Close the listening sockets, and set the SIGCHLD handler to SIG_IGN.
450   We also attempt to set things up so that children are automatically reaped,
451   but just in case this isn't available, there's a paranoid waitpid() in the
452   loop too (except for systems where we are sure it isn't needed). See the more
453   extensive comment before the reception loop in exim.c for a fuller
454   explanation of this logic. */
455
456   close_daemon_sockets(daemon_notifier_fd, listen_sockets, listen_socket_count);
457
458   /* Set FD_CLOEXEC on the SMTP socket. We don't want any rogue child processes
459   to be able to communicate with them, under any circumstances. */
460   (void)fcntl(accept_socket, F_SETFD,
461               fcntl(accept_socket, F_GETFD) | FD_CLOEXEC);
462   (void)fcntl(dup_accept_socket, F_SETFD,
463               fcntl(dup_accept_socket, F_GETFD) | FD_CLOEXEC);
464
465   #ifdef SA_NOCLDWAIT
466   act.sa_handler = SIG_IGN;
467   sigemptyset(&(act.sa_mask));
468   act.sa_flags = SA_NOCLDWAIT;
469   sigaction(SIGCHLD, &act, NULL);
470   #else
471   signal(SIGCHLD, SIG_IGN);
472   #endif
473   signal(SIGTERM, SIG_DFL);
474   signal(SIGINT, SIG_DFL);
475
476   /* Attempt to get an id from the sending machine via the RFC 1413
477   protocol. We do this in the sub-process in order not to hold up the
478   main process if there is any delay. Then set up the fullhost information
479   in case there is no HELO/EHLO.
480
481   If debugging is enabled only for the daemon, we must turn if off while
482   finding the id, but turn it on again afterwards so that information about the
483   incoming connection is output. */
484
485   if (f.debug_daemon) debug_selector = 0;
486   verify_get_ident(IDENT_PORT);
487   host_build_sender_fullhost();
488   debug_selector = save_debug_selector;
489
490   DEBUG(D_any)
491     debug_printf("Process %d is handling incoming connection from %s\n",
492       (int)getpid(), sender_fullhost);
493
494   /* Now disable debugging permanently if it's required only for the daemon
495   process. */
496
497   if (f.debug_daemon) debug_selector = 0;
498
499   /* If there are too many child processes for immediate delivery,
500   set the session_local_queue_only flag, which is initialized from the
501   configured value and may therefore already be TRUE. Leave logging
502   till later so it will have a message id attached. Note that there is no
503   possibility of re-calculating this per-message, because the value of
504   smtp_accept_count does not change in this subprocess. */
505
506   if (smtp_accept_queue > 0 && smtp_accept_count > smtp_accept_queue)
507     {
508     session_local_queue_only = TRUE;
509     queue_only_reason = 1;
510     }
511
512   /* Handle the start of the SMTP session, then loop, accepting incoming
513   messages from the SMTP connection. The end will come at the QUIT command,
514   when smtp_setup_msg() returns 0. A break in the connection causes the
515   process to die (see accept.c).
516
517   NOTE: We do *not* call smtp_log_no_mail() if smtp_start_session() fails,
518   because a log line has already been written for all its failure exists
519   (usually "connection refused: <reason>") and writing another one is
520   unnecessary clutter. */
521
522   if (!smtp_start_session())
523     {
524     mac_smtp_fflush();
525     search_tidyup();
526     exim_underbar_exit(EXIT_SUCCESS);
527     }
528
529   for (;;)
530     {
531     int rc;
532     message_id[0] = 0;            /* Clear out any previous message_id */
533     reset_point = store_mark();   /* Save current store high water point */
534
535     DEBUG(D_any)
536       debug_printf("Process %d is ready for new message\n", (int)getpid());
537
538     /* Smtp_setup_msg() returns 0 on QUIT or if the call is from an
539     unacceptable host or if an ACL "drop" command was triggered, -1 on
540     connection lost, and +1 on validly reaching DATA. Receive_msg() almost
541     always returns TRUE when smtp_input is true; just retry if no message was
542     accepted (can happen for invalid message parameters). However, it can yield
543     FALSE if the connection was forcibly dropped by the DATA ACL. */
544
545     if ((rc = smtp_setup_msg()) > 0)
546       {
547       BOOL ok = receive_msg(FALSE);
548       search_tidyup();                    /* Close cached databases */
549       if (!ok)                            /* Connection was dropped */
550         {
551         cancel_cutthrough_connection(TRUE, US"receive dropped");
552         mac_smtp_fflush();
553         smtp_log_no_mail();               /* Log no mail if configured */
554         exim_underbar_exit(EXIT_SUCCESS);
555         }
556       if (message_id[0] == 0) continue;   /* No message was accepted */
557       }
558     else                                /* bad smtp_setup_msg() */
559       {
560       if (smtp_out)
561         {
562         int fd = fileno(smtp_in);
563         uschar buf[128];
564
565         mac_smtp_fflush();
566         /* drain socket, for clean TCP FINs */
567         if (fcntl(fd, F_SETFL, O_NONBLOCK) == 0)
568           for(int i = 16; read(fd, buf, sizeof(buf)) > 0 && i > 0; ) i--;
569         }
570       cancel_cutthrough_connection(TRUE, US"message setup dropped");
571       search_tidyup();
572       smtp_log_no_mail();                 /* Log no mail if configured */
573
574       /*XXX should we pause briefly, hoping that the client will be the
575       active TCP closer hence get the TCP_WAIT endpoint? */
576       DEBUG(D_receive) debug_printf("SMTP>>(close on process exit)\n");
577       exim_underbar_exit(rc ? EXIT_FAILURE : EXIT_SUCCESS);
578       }
579
580     /* Show the recipients when debugging */
581
582     DEBUG(D_receive)
583       {
584       if (sender_address)
585         debug_printf("Sender: %s\n", sender_address);
586       if (recipients_list)
587         {
588         debug_printf("Recipients:\n");
589         for (int i = 0; i < recipients_count; i++)
590           debug_printf("  %s\n", recipients_list[i].address);
591         }
592       }
593
594     /* A message has been accepted. Clean up any previous delivery processes
595     that have completed and are defunct, on systems where they don't go away
596     by themselves (see comments when setting SIG_IGN above). On such systems
597     (if any) these delivery processes hang around after termination until
598     the next message is received. */
599
600     #ifndef SIG_IGN_WORKS
601     while (waitpid(-1, NULL, WNOHANG) > 0);
602     #endif
603
604     /* Reclaim up the store used in accepting this message */
605
606       {
607       int r = receive_messagecount;
608       BOOL q = f.queue_only_policy;
609       smtp_reset(reset_point);
610       reset_point = NULL;
611       f.queue_only_policy = q;
612       receive_messagecount = r;
613       }
614
615     /* If queue_only is set or if there are too many incoming connections in
616     existence, session_local_queue_only will be TRUE. If it is not, check
617     whether we have received too many messages in this session for immediate
618     delivery. */
619
620     if (!session_local_queue_only &&
621         smtp_accept_queue_per_connection > 0 &&
622         receive_messagecount > smtp_accept_queue_per_connection)
623       {
624       session_local_queue_only = TRUE;
625       queue_only_reason = 2;
626       }
627
628     /* Initialize local_queue_only from session_local_queue_only. If it is not
629     true, and queue_only_load is set, check that the load average is below it.
630     If local_queue_only is set by this means, we also set if for the session if
631     queue_only_load_latch is true (the default). This means that, once set,
632     local_queue_only remains set for any subsequent messages on the same SMTP
633     connection. This is a deliberate choice; even though the load average may
634     fall, it doesn't seem right to deliver later messages on the same call when
635     not delivering earlier ones. However, the are special circumstances such as
636     very long-lived connections from scanning appliances where this is not the
637     best strategy. In such cases, queue_only_load_latch should be set false. */
638
639     if (  !(local_queue_only = session_local_queue_only)
640        && queue_only_load >= 0
641        && (local_queue_only = (load_average = OS_GETLOADAVG()) > queue_only_load)
642        )
643       {
644       queue_only_reason = 3;
645       if (queue_only_load_latch) session_local_queue_only = TRUE;
646       }
647
648     /* Log the queueing here, when it will get a message id attached, but
649     not if queue_only is set (case 0). */
650
651     if (local_queue_only) switch(queue_only_reason)
652       {
653       case 1: log_write(L_delay_delivery,
654                 LOG_MAIN, "no immediate delivery: too many connections "
655                 "(%d, max %d)", smtp_accept_count, smtp_accept_queue);
656               break;
657
658       case 2: log_write(L_delay_delivery,
659                 LOG_MAIN, "no immediate delivery: more than %d messages "
660                 "received in one connection", smtp_accept_queue_per_connection);
661               break;
662
663       case 3: log_write(L_delay_delivery,
664                 LOG_MAIN, "no immediate delivery: load average %.2f",
665                 (double)load_average/1000.0);
666               break;
667       }
668
669     /* If a delivery attempt is required, spin off a new process to handle it.
670     If we are not root, we have to re-exec exim unless deliveries are being
671     done unprivileged. */
672
673     else if (  (!f.queue_only_policy || f.queue_smtp)
674             && !f.deliver_freeze)
675       {
676       pid_t dpid;
677
678       /* We used to flush smtp_out before forking so that buffered data was not
679       duplicated, but now we want to pipeline the responses for data and quit.
680       Instead, hard-close the fd underlying smtp_out right after fork to discard
681       the data buffer. */
682
683       if ((dpid = exim_fork(US"daemon-accept-delivery")) == 0)
684         {
685         (void)fclose(smtp_in);
686         (void)close(fileno(smtp_out));
687         (void)fclose(smtp_out);
688
689         /* Don't ever molest the parent's SSL connection, but do clean up
690         the data structures if necessary. */
691
692 #ifndef DISABLE_TLS
693         tls_close(NULL, TLS_NO_SHUTDOWN);
694 #endif
695
696         /* Reset SIGHUP and SIGCHLD in the child in both cases. */
697
698         signal(SIGHUP,  SIG_DFL);
699         signal(SIGCHLD, SIG_DFL);
700         signal(SIGTERM, SIG_DFL);
701         signal(SIGINT, SIG_DFL);
702
703         if (geteuid() != root_uid && !deliver_drop_privilege)
704           {
705           signal(SIGALRM, SIG_DFL);
706           delivery_re_exec(CEE_EXEC_PANIC);
707           /* Control does not return here. */
708           }
709
710         /* No need to re-exec; SIGALRM remains set to the default handler */
711
712         (void) deliver_message(message_id, FALSE, FALSE);
713         search_tidyup();
714         exim_underbar_exit(EXIT_SUCCESS);
715         }
716
717       if (dpid > 0)
718         {
719         release_cutthrough_connection(US"passed for delivery");
720         DEBUG(D_any) debug_printf("forked delivery process %d\n", (int)dpid);
721         }
722       else
723         {
724         cancel_cutthrough_connection(TRUE, US"delivery fork failed");
725         log_write(0, LOG_MAIN|LOG_PANIC, "daemon: delivery process fork "
726           "failed: %s", strerror(errno));
727         }
728       }
729     }
730   }
731
732
733 /* Carrying on in the parent daemon process... Can't do much if the fork
734 failed. Otherwise, keep count of the number of accepting processes and
735 remember the pid for ticking off when the child completes. */
736
737 if (pid < 0)
738   never_error(US"daemon: accept process fork failed", US"Fork failed", errno);
739 else
740   {
741   for (int i = 0; i < smtp_accept_max; ++i)
742     if (smtp_slots[i].pid <= 0)
743       {
744       smtp_slots[i].pid = pid;
745       /* Connection closes come asyncronously, so we cannot stack this store */
746       if (smtp_accept_max_per_host)
747         smtp_slots[i].host_address = string_copy_malloc(sender_host_address);
748       smtp_accept_count++;
749       break;
750       }
751   DEBUG(D_any) debug_printf("%d SMTP accept process%s running\n",
752     smtp_accept_count, smtp_accept_count == 1 ? "" : "es");
753   }
754
755 /* Get here via goto in error cases */
756
757 ERROR_RETURN:
758
759 /* Close the streams associated with the socket which will also close the
760 socket fds in this process. We can't do anything if fclose() fails, but
761 logging brings it to someone's attention. However, "connection reset by peer"
762 isn't really a problem, so skip that one. On Solaris, a dropped connection can
763 manifest itself as a broken pipe, so drop that one too. If the streams don't
764 exist, something went wrong while setting things up. Make sure the socket
765 descriptors are closed, in order to drop the connection. */
766
767 if (smtp_out)
768   {
769   if (fclose(smtp_out) != 0 && errno != ECONNRESET && errno != EPIPE)
770     log_write(0, LOG_MAIN|LOG_PANIC, "daemon: fclose(smtp_out) failed: %s",
771       strerror(errno));
772   smtp_out = NULL;
773   }
774 else (void)close(accept_socket);
775
776 if (smtp_in)
777   {
778   if (fclose(smtp_in) != 0 && errno != ECONNRESET && errno != EPIPE)
779     log_write(0, LOG_MAIN|LOG_PANIC, "daemon: fclose(smtp_in) failed: %s",
780       strerror(errno));
781   smtp_in = NULL;
782   }
783 else (void)close(dup_accept_socket);
784
785 /* Release any store used in this process, including the store used for holding
786 the incoming host address and an expanded active_hostname. */
787
788 log_close_all();
789 interface_address =
790 sender_host_address = NULL;
791 store_reset(reset_point);
792 sender_host_address = NULL;
793 }
794
795
796
797
798 /*************************************************
799 *       Check wildcard listen special cases      *
800 *************************************************/
801
802 /* This function is used when binding and listening on lists of addresses and
803 ports. It tests for special cases of wildcard listening, when IPv4 and IPv6
804 sockets may interact in different ways in different operating systems. It is
805 passed an error number, the list of listening addresses, and the current
806 address. Two checks are available: for a previous wildcard IPv6 address, or for
807 a following wildcard IPv4 address, in both cases on the same port.
808
809 In practice, pairs of wildcard addresses should be adjacent in the address list
810 because they are sorted that way below.
811
812 Arguments:
813   eno            the error number
814   addresses      the list of addresses
815   ipa            the current IP address
816   back           if TRUE, check for previous wildcard IPv6 address
817                  if FALSE, check for a following wildcard IPv4 address
818
819 Returns:         TRUE or FALSE
820 */
821
822 static BOOL
823 check_special_case(int eno, ip_address_item *addresses, ip_address_item *ipa,
824   BOOL back)
825 {
826 ip_address_item *ipa2;
827
828 /* For the "back" case, if the failure was "address in use" for a wildcard IPv4
829 address, seek a previous IPv6 wildcard address on the same port. As it is
830 previous, it must have been successfully bound and be listening. Flag it as a
831 "6 including 4" listener. */
832
833 if (back)
834   {
835   if (eno != EADDRINUSE || ipa->address[0] != 0) return FALSE;
836   for (ipa2 = addresses; ipa2 != ipa; ipa2 = ipa2->next)
837     {
838     if (ipa2->address[1] == 0 && ipa2->port == ipa->port)
839       {
840       ipa2->v6_include_v4 = TRUE;
841       return TRUE;
842       }
843     }
844   }
845
846 /* For the "forward" case, if the current address is a wildcard IPv6 address,
847 we seek a following wildcard IPv4 address on the same port. */
848
849 else
850   {
851   if (ipa->address[0] != ':' || ipa->address[1] != 0) return FALSE;
852   for (ipa2 = ipa->next; ipa2 != NULL; ipa2 = ipa2->next)
853     if (ipa2->address[0] == 0 && ipa->port == ipa2->port) return TRUE;
854   }
855
856 return FALSE;
857 }
858
859
860
861
862 /*************************************************
863 *         Handle terminating subprocesses        *
864 *************************************************/
865
866 /* Handle the termination of child processes. Theoretically, this need be done
867 only when sigchld_seen is TRUE, but rumour has it that some systems lose
868 SIGCHLD signals at busy times, so to be on the safe side, this function is
869 called each time round. It shouldn't be too expensive.
870
871 Arguments:  none
872 Returns:    nothing
873 */
874
875 static void
876 handle_ending_processes(void)
877 {
878 int status;
879 pid_t pid;
880
881 while ((pid = waitpid(-1, &status, WNOHANG)) > 0)
882   {
883   DEBUG(D_any)
884     {
885     debug_printf("child %d ended: status=0x%x\n", (int)pid, status);
886 #ifdef WCOREDUMP
887     if (WIFEXITED(status))
888       debug_printf("  normal exit, %d\n", WEXITSTATUS(status));
889     else if (WIFSIGNALED(status))
890       debug_printf("  signal exit, signal %d%s\n", WTERMSIG(status),
891           WCOREDUMP(status) ? " (core dumped)" : "");
892 #endif
893     }
894
895   /* If it's a listening daemon for which we are keeping track of individual
896   subprocesses, deal with an accepting process that has terminated. */
897
898   if (smtp_slots)
899     {
900     int i;
901     for (i = 0; i < smtp_accept_max; i++)
902       if (smtp_slots[i].pid == pid)
903         {
904         if (smtp_slots[i].host_address)
905           store_free(smtp_slots[i].host_address);
906         smtp_slots[i] = empty_smtp_slot;
907         if (--smtp_accept_count < 0) smtp_accept_count = 0;
908         DEBUG(D_any) debug_printf("%d SMTP accept process%s now running\n",
909           smtp_accept_count, (smtp_accept_count == 1)? "" : "es");
910         break;
911         }
912     if (i < smtp_accept_max) continue;  /* Found an accepting process */
913     }
914
915   /* If it wasn't an accepting process, see if it was a queue-runner
916   process that we are tracking. */
917
918   if (queue_pid_slots)
919     {
920     int max = atoi(CS expand_string(queue_run_max));
921     for (int i = 0; i < max; i++)
922       if (queue_pid_slots[i] == pid)
923         {
924         queue_pid_slots[i] = 0;
925         if (--queue_run_count < 0) queue_run_count = 0;
926         DEBUG(D_any) debug_printf("%d queue-runner process%s now running\n",
927           queue_run_count, (queue_run_count == 1)? "" : "es");
928         break;
929         }
930     }
931   }
932 }
933
934
935
936 static void
937 set_pid_file_path(void)
938 {
939 if (override_pid_file_path)
940   pid_file_path = override_pid_file_path;
941
942 if (!*pid_file_path)
943   pid_file_path = string_sprintf("%s/exim-daemon.pid", spool_directory);
944
945 if (pid_file_path[0] != '/')
946   log_write(0, LOG_PANIC_DIE, "pid file path %s must be absolute\n", pid_file_path);
947 }
948
949
950 /* Remove the daemon's pidfile.  Note: runs with root privilege,
951 as a direct child of the daemon.  Does not return. */
952
953 void
954 delete_pid_file(void)
955 {
956 uschar * daemon_pid = string_sprintf("%d\n", (int)getppid());
957 FILE * f;
958
959 set_pid_file_path();
960 if ((f = Ufopen(pid_file_path, "rb")))
961   {
962   if (  fgets(CS big_buffer, big_buffer_size, f)
963         && Ustrcmp(daemon_pid, big_buffer) == 0
964      )
965     if (Uunlink(pid_file_path) == 0)
966       {
967       DEBUG(D_any)
968         debug_printf("%s unlink: %s\n", pid_file_path, strerror(errno));
969       }
970     else
971       DEBUG(D_any)
972         debug_printf("unlinked %s\n", pid_file_path);
973   fclose(f);
974   }
975 else
976   DEBUG(D_any)
977     debug_printf("%s\n", string_open_failed("pid file %s", pid_file_path));
978 exim_exit(EXIT_SUCCESS);
979 }
980
981
982 /* Called by the daemon; exec a child to get the pid file deleted
983 since we may require privs for the containing directory */
984
985 static void
986 daemon_die(void)
987 {
988 int pid;
989
990 DEBUG(D_any) debug_printf("SIGTERM/SIGINT seen\n");
991 #if !defined(DISABLE_TLS) && (defined(EXIM_HAVE_INOTIFY) || defined(EXIM_HAVE_KEVENT))
992 tls_watch_invalidate();
993 #endif
994
995 if (daemon_notifier_fd >= 0)
996   {
997   close(daemon_notifier_fd);
998   daemon_notifier_fd = -1;
999 #ifndef EXIM_HAVE_ABSTRACT_UNIX_SOCKETS
1000   unlink_notifier_socket();
1001 #endif
1002   }
1003
1004 if (f.running_in_test_harness || write_pid)
1005   {
1006   if ((pid = exim_fork(US"daemon-del-pidfile")) == 0)
1007     {
1008     if (override_pid_file_path)
1009       (void)child_exec_exim(CEE_EXEC_PANIC, FALSE, NULL, FALSE, 3,
1010         "-oP", override_pid_file_path, "-oPX");
1011     else
1012       (void)child_exec_exim(CEE_EXEC_PANIC, FALSE, NULL, FALSE, 1, "-oPX");
1013
1014     /* Control never returns here. */
1015     }
1016   if (pid > 0)
1017     child_close(pid, 1);
1018   }
1019 exim_exit(EXIT_SUCCESS);
1020 }
1021
1022
1023 /*************************************************
1024 *       Listener socket for local work prompts   *
1025 *************************************************/
1026
1027 static void
1028 daemon_notifier_socket(void)
1029 {
1030 int fd;
1031 const uschar * where;
1032 struct sockaddr_un sa_un = {.sun_family = AF_UNIX};
1033 int len;
1034
1035 if (!notifier_socket || !*notifier_socket)
1036   {
1037   DEBUG(D_any) debug_printf("-oY used so not creating notifier socket\n");
1038   return;
1039   }
1040 if (override_local_interfaces && !override_pid_file_path)
1041   {
1042   DEBUG(D_any)
1043     debug_printf("-oX used without -oP so not creating notifier socket\n");
1044   return;
1045   }
1046
1047 DEBUG(D_any) debug_printf("creating notifier socket\n");
1048
1049 #ifdef SOCK_CLOEXEC
1050 if ((fd = socket(PF_UNIX, SOCK_DGRAM|SOCK_CLOEXEC, 0)) < 0)
1051   { where = US"socket"; goto bad; }
1052 #else
1053 if ((fd = socket(PF_UNIX, SOCK_DGRAM, 0)) < 0)
1054   { where = US"socket"; goto bad; }
1055 (void)fcntl(fd, F_SETFD, fcntl(fd, F_GETFD) | FD_CLOEXEC);
1056 #endif
1057
1058 #ifdef EXIM_HAVE_ABSTRACT_UNIX_SOCKETS
1059 sa_un.sun_path[0] = 0;  /* Abstract local socket addr - Linux-specific? */
1060 len = offsetof(struct sockaddr_un, sun_path) + 1
1061   + snprintf(sa_un.sun_path+1, sizeof(sa_un.sun_path)-1, "%s",
1062               expand_string(notifier_socket));
1063 DEBUG(D_any) debug_printf(" @%s\n", sa_un.sun_path+1);
1064 #else                   /* filesystem-visible and persistent; will neeed removal */
1065 len = offsetof(struct sockaddr_un, sun_path)
1066   + snprintf(sa_un.sun_path, sizeof(sa_un.sun_path), "%s",
1067               expand_string(notifier_socket));
1068 DEBUG(D_any) debug_printf(" %s\n", sa_un.sun_path);
1069 #endif
1070
1071 if (bind(fd, (const struct sockaddr *)&sa_un, len) < 0)
1072   { where = US"bind"; goto bad; }
1073
1074 #ifdef SO_PASSCRED              /* Linux */
1075 if (setsockopt(fd, SOL_SOCKET, SO_PASSCRED, &on, sizeof(on)) < 0)
1076   { where = US"SO_PASSCRED"; goto bad2; }
1077 #elif defined(LOCAL_CREDS)      /* FreeBSD-ish */
1078 if (setsockopt(fd, 0, LOCAL_CREDS, &on, sizeof(on)) < 0)
1079   { where = US"LOCAL_CREDS"; goto bad2; }
1080 #endif
1081
1082 /* debug_printf("%s: fd %d\n", __FUNCTION__, fd); */
1083 daemon_notifier_fd = fd;
1084 return;
1085
1086 bad2:
1087 #ifndef EXIM_HAVE_ABSTRACT_UNIX_SOCKETS
1088   Uunlink(sa_un.sun_path);
1089 #endif
1090 bad:
1091   log_write(0, LOG_MAIN|LOG_PANIC, "%s %s: %s",
1092     __FUNCTION__, where, strerror(errno));
1093   close(fd);
1094   return;
1095 }
1096
1097
1098 static uschar queuerun_msgid[MESSAGE_ID_LENGTH+1];
1099
1100 /* Return TRUE if a sigalrm should be emulated */
1101 static BOOL
1102 daemon_notification(void)
1103 {
1104 uschar buf[256], cbuf[256];
1105 struct sockaddr_un sa_un;
1106 struct iovec iov = {.iov_base = buf, .iov_len = sizeof(buf)-1};
1107 struct msghdr msg = { .msg_name = &sa_un,
1108                       .msg_namelen = sizeof(sa_un),
1109                       .msg_iov = &iov,
1110                       .msg_iovlen = 1,
1111                       .msg_control = cbuf,
1112                       .msg_controllen = sizeof(cbuf)
1113                     };
1114 ssize_t sz;
1115
1116 buf[sizeof(buf)-1] = 0;
1117 if ((sz = recvmsg(daemon_notifier_fd, &msg, 0)) <= 0) return FALSE;
1118 if (sz >= sizeof(buf)) return FALSE;
1119
1120 #ifdef notdef
1121 debug_printf("addrlen %d\n", msg.msg_namelen);
1122 #endif
1123 DEBUG(D_queue_run) debug_printf("%s from addr '%s%.*s'\n", __FUNCTION__,
1124   *sa_un.sun_path ? "" : "@",
1125   (int)msg.msg_namelen - (*sa_un.sun_path ? 0 : 1),
1126   sa_un.sun_path + (*sa_un.sun_path ? 0 : 1));
1127
1128 /* Refuse to handle the item unless the peer has good credentials */
1129 #ifdef SCM_CREDENTIALS
1130 # define EXIM_SCM_CR_TYPE SCM_CREDENTIALS
1131 #elif defined(LOCAL_CREDS) && defined(SCM_CREDS)
1132 # define EXIM_SCM_CR_TYPE SCM_CREDS
1133 #else
1134         /* The OS has no way to get the creds of the caller (for a unix/datagram socket.
1135         Punt; don't try to check. */
1136 #endif
1137
1138 #ifdef EXIM_SCM_CR_TYPE
1139 for (struct cmsghdr * cp = CMSG_FIRSTHDR(&msg);
1140      cp;
1141      cp = CMSG_NXTHDR(&msg, cp))
1142   if (cp->cmsg_level == SOL_SOCKET && cp->cmsg_type == EXIM_SCM_CR_TYPE)
1143   {
1144 # ifdef SCM_CREDENTIALS                                 /* Linux */
1145   struct ucred * cr = (struct ucred *) CMSG_DATA(cp);
1146   if (cr->uid && cr->uid != exim_uid)
1147     {
1148     DEBUG(D_queue_run) debug_printf("%s: sender creds pid %d uid %d gid %d\n",
1149       __FUNCTION__, (int)cr->pid, (int)cr->uid, (int)cr->gid);
1150     return FALSE;
1151     }
1152 # elif defined(LOCAL_CREDS)                             /* BSD-ish */
1153   struct sockcred * cr = (struct sockcred *) CMSG_DATA(cp);
1154   if (cr->sc_uid && cr->sc_uid != exim_uid)
1155     {
1156     DEBUG(D_queue_run) debug_printf("%s: sender creds pid ??? uid %d gid %d\n",
1157       __FUNCTION__, (int)cr->sc_uid, (int)cr->sc_gid);
1158     return FALSE;
1159     }
1160 # endif
1161   break;
1162   }
1163 #endif
1164
1165 buf[sz] = 0;
1166 switch (buf[0])
1167   {
1168 #ifndef DISABLE_QUEUE_RAMP
1169   case NOTIFY_MSG_QRUN:
1170     /* this should be a message_id */
1171     DEBUG(D_queue_run)
1172       debug_printf("%s: qrunner trigger: %s\n", __FUNCTION__, buf+1);
1173     memcpy(queuerun_msgid, buf+1, MESSAGE_ID_LENGTH+1);
1174     return TRUE;
1175 #endif
1176
1177   case NOTIFY_QUEUE_SIZE_REQ:
1178     {
1179     uschar buf[16];
1180     int len = snprintf(CS buf, sizeof(buf), "%u", queue_count_cached());
1181
1182     DEBUG(D_queue_run)
1183       debug_printf("%s: queue size request: %s\n", __FUNCTION__, buf);
1184
1185     if (sendto(daemon_notifier_fd, buf, len, 0,
1186                 (const struct sockaddr *)&sa_un, msg.msg_namelen) < 0)
1187       log_write(0, LOG_MAIN|LOG_PANIC,
1188         "%s: sendto: %s\n", __FUNCTION__, strerror(errno));
1189     return FALSE;
1190     }
1191   }
1192 return FALSE;
1193 }
1194
1195
1196 /*************************************************
1197 *              Exim Daemon Mainline              *
1198 *************************************************/
1199
1200 /* The daemon can do two jobs, either of which is optional:
1201
1202 (1) Listens for incoming SMTP calls and spawns off a sub-process to handle
1203 each one. This is requested by the -bd option, with -oX specifying the SMTP
1204 port on which to listen (for testing).
1205
1206 (2) Spawns a queue-running process every so often. This is controlled by the
1207 -q option with a an interval time. (If no time is given, a single queue run
1208 is done from the main function, and control doesn't get here.)
1209
1210 Root privilege is required in order to attach to port 25. Some systems require
1211 it when calling socket() rather than bind(). To cope with all cases, we run as
1212 root for both socket() and bind(). Some systems also require root in order to
1213 write to the pid file directory. This function must therefore be called as root
1214 if it is to work properly in all circumstances. Once the socket is bound and
1215 the pid file written, root privilege is given up if there is an exim uid.
1216
1217 There are no arguments to this function, and it never returns. */
1218
1219 void
1220 daemon_go(void)
1221 {
1222 struct passwd *pw;
1223 int *listen_sockets = NULL;
1224 int listen_socket_count = 0;
1225 ip_address_item *addresses = NULL;
1226 time_t last_connection_time = (time_t)0;
1227 int local_queue_run_max = atoi(CS expand_string(queue_run_max));
1228
1229 process_purpose = US"daemon";
1230
1231 /* If any debugging options are set, turn on the D_pid bit so that all
1232 debugging lines get the pid added. */
1233
1234 DEBUG(D_any|D_v) debug_selector |= D_pid;
1235
1236 if (f.inetd_wait_mode)
1237   {
1238   listen_socket_count = 1;
1239   listen_sockets = store_get(sizeof(int), FALSE);
1240   (void) close(3);
1241   if (dup2(0, 3) == -1)
1242     log_write(0, LOG_MAIN|LOG_PANIC_DIE,
1243         "failed to dup inetd socket safely away: %s", strerror(errno));
1244
1245   listen_sockets[0] = 3;
1246   (void) close(0);
1247   (void) close(1);
1248   (void) close(2);
1249   exim_nullstd();
1250
1251   if (debug_file == stderr)
1252     {
1253     /* need a call to log_write before call to open debug_file, so that
1254     log.c:file_path has been initialised.  This is unfortunate. */
1255     log_write(0, LOG_MAIN, "debugging Exim in inetd wait mode starting");
1256
1257     fclose(debug_file);
1258     debug_file = NULL;
1259     exim_nullstd(); /* re-open fd2 after we just closed it again */
1260     debug_logging_activate(US"-wait", NULL);
1261     }
1262
1263   DEBUG(D_any) debug_printf("running in inetd wait mode\n");
1264
1265   /* As per below, when creating sockets ourselves, we handle tcp_nodelay for
1266   our own buffering; we assume though that inetd set the socket REUSEADDR. */
1267
1268   if (tcp_nodelay)
1269     if (setsockopt(3, IPPROTO_TCP, TCP_NODELAY, US &on, sizeof(on)))
1270       log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to set socket NODELAY: %s",
1271         strerror(errno));
1272   }
1273
1274
1275 if (f.inetd_wait_mode || f.daemon_listen)
1276   {
1277   /* If any option requiring a load average to be available during the
1278   reception of a message is set, call os_getloadavg() while we are root
1279   for those OS for which this is necessary the first time it is called (in
1280   order to perform an "open" on the kernel memory file). */
1281
1282   #ifdef LOAD_AVG_NEEDS_ROOT
1283   if (queue_only_load >= 0 || smtp_load_reserve >= 0 ||
1284        (deliver_queue_load_max >= 0 && deliver_drop_privilege))
1285     (void)os_getloadavg();
1286   #endif
1287   }
1288
1289
1290 /* Do the preparation for setting up a listener on one or more interfaces, and
1291 possible on various ports. This is controlled by the combination of
1292 local_interfaces (which can set IP addresses and ports) and daemon_smtp_port
1293 (which is a list of default ports to use for those items in local_interfaces
1294 that do not specify a port). The -oX command line option can be used to
1295 override one or both of these options.
1296
1297 If local_interfaces is not set, the default is to listen on all interfaces.
1298 When it is set, it can include "all IPvx interfaces" as an item. This is useful
1299 when different ports are in use.
1300
1301 It turns out that listening on all interfaces is messy in an IPv6 world,
1302 because several different implementation approaches have been taken. This code
1303 is now supposed to work with all of them. The point of difference is whether an
1304 IPv6 socket that is listening on all interfaces will receive incoming IPv4
1305 calls or not. We also have to cope with the case when IPv6 libraries exist, but
1306 there is no IPv6 support in the kernel.
1307
1308 . On Solaris, an IPv6 socket will accept IPv4 calls, and give them as mapped
1309   addresses. However, if an IPv4 socket is also listening on all interfaces,
1310   calls are directed to the appropriate socket.
1311
1312 . On (some versions of) Linux, an IPv6 socket will accept IPv4 calls, and
1313   give them as mapped addresses, but an attempt also to listen on an IPv4
1314   socket on all interfaces causes an error.
1315
1316 . On OpenBSD, an IPv6 socket will not accept IPv4 calls. You have to set up
1317   two sockets if you want to accept both kinds of call.
1318
1319 . FreeBSD is like OpenBSD, but it has the IPV6_V6ONLY socket option, which
1320   can be turned off, to make it behave like the versions of Linux described
1321   above.
1322
1323 . I heard a report that the USAGI IPv6 stack for Linux has implemented
1324   IPV6_V6ONLY.
1325
1326 So, what we do when IPv6 is supported is as follows:
1327
1328  (1) After it is set up, the list of interfaces is scanned for wildcard
1329      addresses. If an IPv6 and an IPv4 wildcard are both found for the same
1330      port, the list is re-arranged so that they are together, with the IPv6
1331      wildcard first.
1332
1333  (2) If the creation of a wildcard IPv6 socket fails, we just log the error and
1334      carry on if an IPv4 wildcard socket for the same port follows later in the
1335      list. This allows Exim to carry on in the case when the kernel has no IPv6
1336      support.
1337
1338  (3) Having created an IPv6 wildcard socket, we try to set IPV6_V6ONLY if that
1339      option is defined. However, if setting fails, carry on regardless (but log
1340      the incident).
1341
1342  (4) If binding or listening on an IPv6 wildcard socket fails, it is a serious
1343      error.
1344
1345  (5) If binding or listening on an IPv4 wildcard socket fails with the error
1346      EADDRINUSE, and a previous interface was an IPv6 wildcard for the same
1347      port (which must have succeeded or we wouldn't have got this far), we
1348      assume we are in the situation where just a single socket is permitted,
1349      and ignore the error.
1350
1351 Phew!
1352
1353 The preparation code decodes options and sets up the relevant data. We do this
1354 first, so that we can return non-zero if there are any syntax errors, and also
1355 write to stderr. */
1356
1357 if (f.daemon_listen && !f.inetd_wait_mode)
1358   {
1359   int *default_smtp_port;
1360   int sep;
1361   int pct = 0;
1362   uschar *s;
1363   const uschar * list;
1364   uschar *local_iface_source = US"local_interfaces";
1365   ip_address_item *ipa;
1366   ip_address_item **pipa;
1367
1368   /* If -oX was used, disable the writing of a pid file unless -oP was
1369   explicitly used to force it. Then scan the string given to -oX. Any items
1370   that contain neither a dot nor a colon are used to override daemon_smtp_port.
1371   Any other items are used to override local_interfaces. */
1372
1373   if (override_local_interfaces)
1374     {
1375     gstring * new_smtp_port = NULL;
1376     gstring * new_local_interfaces = NULL;
1377
1378     if (!override_pid_file_path) write_pid = FALSE;
1379
1380     list = override_local_interfaces;
1381     sep = 0;
1382     while ((s = string_nextinlist(&list, &sep, NULL, 0)))
1383       {
1384       uschar joinstr[4];
1385       gstring ** gp = Ustrpbrk(s, ".:") ? &new_local_interfaces : &new_smtp_port;
1386
1387       if (!*gp)
1388         {
1389         joinstr[0] = sep;
1390         joinstr[1] = ' ';
1391         *gp = string_catn(*gp, US"<", 1);
1392         }
1393
1394       *gp = string_catn(*gp, joinstr, 2);
1395       *gp = string_cat (*gp, s);
1396       }
1397
1398     if (new_smtp_port)
1399       {
1400       daemon_smtp_port = string_from_gstring(new_smtp_port);
1401       DEBUG(D_any) debug_printf("daemon_smtp_port overridden by -oX:\n  %s\n",
1402         daemon_smtp_port);
1403       }
1404
1405     if (new_local_interfaces)
1406       {
1407       local_interfaces = string_from_gstring(new_local_interfaces);
1408       local_iface_source = US"-oX data";
1409       DEBUG(D_any) debug_printf("local_interfaces overridden by -oX:\n  %s\n",
1410         local_interfaces);
1411       }
1412     }
1413
1414   /* Create a list of default SMTP ports, to be used if local_interfaces
1415   contains entries without explicit ports. First count the number of ports, then
1416   build a translated list in a vector. */
1417
1418   list = daemon_smtp_port;
1419   sep = 0;
1420   while ((s = string_nextinlist(&list, &sep, NULL, 0)))
1421     pct++;
1422   default_smtp_port = store_get((pct+1) * sizeof(int), FALSE);
1423   list = daemon_smtp_port;
1424   sep = 0;
1425   for (pct = 0;
1426        (s = string_nextinlist(&list, &sep, NULL, 0));
1427        pct++)
1428     {
1429     if (isdigit(*s))
1430       {
1431       uschar *end;
1432       default_smtp_port[pct] = Ustrtol(s, &end, 0);
1433       if (end != s + Ustrlen(s))
1434         log_write(0, LOG_PANIC_DIE|LOG_CONFIG, "invalid SMTP port: %s", s);
1435       }
1436     else
1437       {
1438       struct servent *smtp_service = getservbyname(CS s, "tcp");
1439       if (!smtp_service)
1440         log_write(0, LOG_PANIC_DIE|LOG_CONFIG, "TCP port \"%s\" not found", s);
1441       default_smtp_port[pct] = ntohs(smtp_service->s_port);
1442       }
1443     }
1444   default_smtp_port[pct] = 0;
1445
1446   /* Check the list of TLS-on-connect ports and do name lookups if needed */
1447
1448   list = tls_in.on_connect_ports;
1449   sep = 0;
1450   /* the list isn't expanded so cannot be tainted.  If it ever is we will trap here */
1451   while ((s = string_nextinlist(&list, &sep, big_buffer, big_buffer_size)))
1452     if (!isdigit(*s))
1453       {
1454       gstring * g = NULL;
1455
1456       list = tls_in.on_connect_ports;
1457       tls_in.on_connect_ports = NULL;
1458       sep = 0;
1459       while ((s = string_nextinlist(&list, &sep, big_buffer, big_buffer_size)))
1460         {
1461         if (!isdigit(*s))
1462           {
1463           struct servent * smtp_service = getservbyname(CS s, "tcp");
1464           if (!smtp_service)
1465             log_write(0, LOG_PANIC_DIE|LOG_CONFIG, "TCP port \"%s\" not found", s);
1466           s = string_sprintf("%d", (int)ntohs(smtp_service->s_port));
1467           }
1468         g = string_append_listele(g, ':', s);
1469         }
1470       if (g)
1471         tls_in.on_connect_ports = g->s;
1472       break;
1473       }
1474
1475   /* Create the list of local interfaces, possibly with ports included. This
1476   list may contain references to 0.0.0.0 and ::0 as wildcards. These special
1477   values are converted below. */
1478
1479   addresses = host_build_ifacelist(local_interfaces, local_iface_source);
1480
1481   /* In the list of IP addresses, convert 0.0.0.0 into an empty string, and ::0
1482   into the string ":". We use these to recognize wildcards in IPv4 and IPv6. In
1483   fact, many IP stacks recognize 0.0.0.0 and ::0 and handle them as wildcards
1484   anyway, but we need to know which are the wildcard addresses, and the shorter
1485   strings are neater.
1486
1487   In the same scan, fill in missing port numbers from the default list. When
1488   there is more than one item in the list, extra items are created. */
1489
1490   for (ipa = addresses; ipa; ipa = ipa->next)
1491     {
1492     if (Ustrcmp(ipa->address, "0.0.0.0") == 0)
1493       ipa->address[0] = 0;
1494     else if (Ustrcmp(ipa->address, "::0") == 0)
1495       {
1496       ipa->address[0] = ':';
1497       ipa->address[1] = 0;
1498       }
1499
1500     if (ipa->port > 0) continue;
1501
1502     if (daemon_smtp_port[0] <= 0)
1503       log_write(0, LOG_MAIN|LOG_PANIC_DIE, "no port specified for interface "
1504         "%s and daemon_smtp_port is unset; cannot start daemon",
1505         ipa->address[0] == 0 ? US"\"all IPv4\"" :
1506         ipa->address[1] == 0 ? US"\"all IPv6\"" : ipa->address);
1507
1508     ipa->port = default_smtp_port[0];
1509     for (int i = 1; default_smtp_port[i] > 0; i++)
1510       {
1511       ip_address_item *new = store_get(sizeof(ip_address_item), FALSE);
1512
1513       memcpy(new->address, ipa->address, Ustrlen(ipa->address) + 1);
1514       new->port = default_smtp_port[i];
1515       new->next = ipa->next;
1516       ipa->next = new;
1517       ipa = new;
1518       }
1519     }
1520
1521   /* Scan the list of addresses for wildcards. If we find an IPv4 and an IPv6
1522   wildcard for the same port, ensure that (a) they are together and (b) the
1523   IPv6 address comes first. This makes handling the messy features easier, and
1524   also simplifies the construction of the "daemon started" log line. */
1525
1526   pipa = &addresses;
1527   for (ipa = addresses; ipa; pipa = &ipa->next, ipa = ipa->next)
1528     {
1529     ip_address_item *ipa2;
1530
1531     /* Handle an IPv4 wildcard */
1532
1533     if (ipa->address[0] == 0)
1534       for (ipa2 = ipa; ipa2->next; ipa2 = ipa2->next)
1535         {
1536         ip_address_item *ipa3 = ipa2->next;
1537         if (ipa3->address[0] == ':' &&
1538             ipa3->address[1] == 0 &&
1539             ipa3->port == ipa->port)
1540           {
1541           ipa2->next = ipa3->next;
1542           ipa3->next = ipa;
1543           *pipa = ipa3;
1544           break;
1545           }
1546         }
1547
1548     /* Handle an IPv6 wildcard. */
1549
1550     else if (ipa->address[0] == ':' && ipa->address[1] == 0)
1551       for (ipa2 = ipa; ipa2->next; ipa2 = ipa2->next)
1552         {
1553         ip_address_item *ipa3 = ipa2->next;
1554         if (ipa3->address[0] == 0 && ipa3->port == ipa->port)
1555           {
1556           ipa2->next = ipa3->next;
1557           ipa3->next = ipa->next;
1558           ipa->next = ipa3;
1559           ipa = ipa3;
1560           break;
1561           }
1562         }
1563     }
1564
1565   /* Get a vector to remember all the sockets in */
1566
1567   for (ipa = addresses; ipa; ipa = ipa->next)
1568     listen_socket_count++;
1569   listen_sockets = store_get(sizeof(int) * listen_socket_count, FALSE);
1570
1571   } /* daemon_listen but not inetd_wait_mode */
1572
1573 if (f.daemon_listen)
1574   {
1575
1576   /* Do a sanity check on the max connects value just to save us from getting
1577   a huge amount of store. */
1578
1579   if (smtp_accept_max > 4095) smtp_accept_max = 4096;
1580
1581   /* There's no point setting smtp_accept_queue unless it is less than the max
1582   connects limit. The configuration reader ensures that the max is set if the
1583   queue-only option is set. */
1584
1585   if (smtp_accept_queue > smtp_accept_max) smtp_accept_queue = 0;
1586
1587   /* Get somewhere to keep the list of SMTP accepting pids if we are keeping
1588   track of them for total number and queue/host limits. */
1589
1590   if (smtp_accept_max > 0)
1591     {
1592     smtp_slots = store_get(smtp_accept_max * sizeof(smtp_slot), FALSE);
1593     for (int i = 0; i < smtp_accept_max; i++) smtp_slots[i] = empty_smtp_slot;
1594     }
1595   }
1596
1597 /* The variable background_daemon is always false when debugging, but
1598 can also be forced false in order to keep a non-debugging daemon in the
1599 foreground. If background_daemon is true, close all open file descriptors that
1600 we know about, but then re-open stdin, stdout, and stderr to /dev/null.  Also
1601 do this for inetd_wait mode.
1602
1603 This is protection against any called functions (in libraries, or in
1604 Perl, or whatever) that think they can write to stderr (or stdout). Before this
1605 was added, it was quite likely that an SMTP connection would use one of these
1606 file descriptors, in which case writing random stuff to it caused chaos.
1607
1608 Then disconnect from the controlling terminal, Most modern Unixes seem to have
1609 setsid() for getting rid of the controlling terminal. For any OS that doesn't,
1610 setsid() can be #defined as a no-op, or as something else. */
1611
1612 if (f.background_daemon || f.inetd_wait_mode)
1613   {
1614   log_close_all();    /* Just in case anything was logged earlier */
1615   search_tidyup();    /* Just in case any were used in reading the config. */
1616   (void)close(0);           /* Get rid of stdin/stdout/stderr */
1617   (void)close(1);
1618   (void)close(2);
1619   exim_nullstd();     /* Connect stdin/stdout/stderr to /dev/null */
1620   log_stderr = NULL;  /* So no attempt to copy paniclog output */
1621   }
1622
1623 if (f.background_daemon)
1624   {
1625   /* If the parent process of this one has pid == 1, we are re-initializing the
1626   daemon as the result of a SIGHUP. In this case, there is no need to do
1627   anything, because the controlling terminal has long gone. Otherwise, fork, in
1628   case current process is a process group leader (see 'man setsid' for an
1629   explanation) before calling setsid(). */
1630
1631   if (getppid() != 1)
1632     {
1633     pid_t pid = exim_fork(US"daemon");
1634     if (pid < 0) log_write(0, LOG_MAIN|LOG_PANIC_DIE,
1635       "fork() failed when starting daemon: %s", strerror(errno));
1636     if (pid > 0) exit(EXIT_SUCCESS);      /* in parent process, just exit */
1637     (void)setsid();                       /* release controlling terminal */
1638     }
1639   }
1640
1641 /* We are now in the disconnected, daemon process (unless debugging). Set up
1642 the listening sockets if required. */
1643
1644 daemon_notifier_socket();
1645
1646 if (f.daemon_listen && !f.inetd_wait_mode)
1647   {
1648   int sk;
1649   ip_address_item *ipa;
1650
1651   /* For each IP address, create a socket, bind it to the appropriate port, and
1652   start listening. See comments above about IPv6 sockets that may or may not
1653   accept IPv4 calls when listening on all interfaces. We also have to cope with
1654   the case of a system with IPv6 libraries, but no IPv6 support in the kernel.
1655   listening, provided a wildcard IPv4 socket for the same port follows. */
1656
1657   for (ipa = addresses, sk = 0; sk < listen_socket_count; ipa = ipa->next, sk++)
1658     {
1659     BOOL wildcard;
1660     ip_address_item *ipa2;
1661     int af;
1662
1663     if (Ustrchr(ipa->address, ':') != NULL)
1664       {
1665       af = AF_INET6;
1666       wildcard = ipa->address[1] == 0;
1667       }
1668     else
1669       {
1670       af = AF_INET;
1671       wildcard = ipa->address[0] == 0;
1672       }
1673
1674     if ((listen_sockets[sk] = ip_socket(SOCK_STREAM, af)) < 0)
1675       {
1676       if (check_special_case(0, addresses, ipa, FALSE))
1677         {
1678         log_write(0, LOG_MAIN, "Failed to create IPv6 socket for wildcard "
1679           "listening (%s): will use IPv4", strerror(errno));
1680         goto SKIP_SOCKET;
1681         }
1682       log_write(0, LOG_PANIC_DIE, "IPv%c socket creation failed: %s",
1683         (af == AF_INET6)? '6' : '4', strerror(errno));
1684       }
1685
1686     /* If this is an IPv6 wildcard socket, set IPV6_V6ONLY if that option is
1687     available. Just log failure (can get protocol not available, just like
1688     socket creation can). */
1689
1690 #ifdef IPV6_V6ONLY
1691     if (af == AF_INET6 && wildcard &&
1692         setsockopt(listen_sockets[sk], IPPROTO_IPV6, IPV6_V6ONLY, CS (&on),
1693           sizeof(on)) < 0)
1694       log_write(0, LOG_MAIN, "Setting IPV6_V6ONLY on daemon's IPv6 wildcard "
1695         "socket failed (%s): carrying on without it", strerror(errno));
1696 #endif  /* IPV6_V6ONLY */
1697
1698     /* Set SO_REUSEADDR so that the daemon can be restarted while a connection
1699     is being handled.  Without this, a connection will prevent reuse of the
1700     smtp port for listening. */
1701
1702     if (setsockopt(listen_sockets[sk], SOL_SOCKET, SO_REUSEADDR,
1703                    US (&on), sizeof(on)) < 0)
1704       log_write(0, LOG_MAIN|LOG_PANIC_DIE, "setting SO_REUSEADDR on socket "
1705         "failed when starting daemon: %s", strerror(errno));
1706
1707     /* Set TCP_NODELAY; Exim does its own buffering. There is a switch to
1708     disable this because it breaks some broken clients. */
1709
1710     if (tcp_nodelay) setsockopt(listen_sockets[sk], IPPROTO_TCP, TCP_NODELAY,
1711       US (&on), sizeof(on));
1712
1713     /* Now bind the socket to the required port; if Exim is being restarted
1714     it may not always be possible to bind immediately, even with SO_REUSEADDR
1715     set, so try 10 times, waiting between each try. After 10 failures, we give
1716     up. In an IPv6 environment, if bind () fails with the error EADDRINUSE and
1717     we are doing wildcard IPv4 listening and there was a previous IPv6 wildcard
1718     address for the same port, ignore the error on the grounds that we must be
1719     in a system where the IPv6 socket accepts both kinds of call. This is
1720     necessary for (some release of) USAGI Linux; other IP stacks fail at the
1721     listen() stage instead. */
1722
1723 #ifdef TCP_FASTOPEN
1724     f.tcp_fastopen_ok = TRUE;
1725 #endif
1726     for(;;)
1727       {
1728       uschar *msg, *addr;
1729       if (ip_bind(listen_sockets[sk], af, ipa->address, ipa->port) >= 0) break;
1730       if (check_special_case(errno, addresses, ipa, TRUE))
1731         {
1732         DEBUG(D_any) debug_printf("wildcard IPv4 bind() failed after IPv6 "
1733           "listen() success; EADDRINUSE ignored\n");
1734         (void)close(listen_sockets[sk]);
1735         goto SKIP_SOCKET;
1736         }
1737       msg = US strerror(errno);
1738       addr = wildcard
1739         ? af == AF_INET6
1740         ? US"(any IPv6)"
1741         : US"(any IPv4)"
1742         : ipa->address;
1743       if (daemon_startup_retries <= 0)
1744         log_write(0, LOG_MAIN|LOG_PANIC_DIE,
1745           "socket bind() to port %d for address %s failed: %s: "
1746           "daemon abandoned", ipa->port, addr, msg);
1747       log_write(0, LOG_MAIN, "socket bind() to port %d for address %s "
1748         "failed: %s: waiting %s before trying again (%d more %s)",
1749         ipa->port, addr, msg, readconf_printtime(daemon_startup_sleep),
1750         daemon_startup_retries, (daemon_startup_retries > 1)? "tries" : "try");
1751       daemon_startup_retries--;
1752       sleep(daemon_startup_sleep);
1753       }
1754
1755     DEBUG(D_any)
1756       if (wildcard)
1757         debug_printf("listening on all interfaces (IPv%c) port %d\n",
1758           af == AF_INET6 ? '6' : '4', ipa->port);
1759       else
1760         debug_printf("listening on %s port %d\n", ipa->address, ipa->port);
1761
1762 #if defined(TCP_FASTOPEN) && !defined(__APPLE__)
1763     if (  f.tcp_fastopen_ok
1764        && setsockopt(listen_sockets[sk], IPPROTO_TCP, TCP_FASTOPEN,
1765                     &smtp_connect_backlog, sizeof(smtp_connect_backlog)))
1766       {
1767       DEBUG(D_any) debug_printf("setsockopt FASTOPEN: %s\n", strerror(errno));
1768       f.tcp_fastopen_ok = FALSE;
1769       }
1770 #endif
1771
1772     /* Start listening on the bound socket, establishing the maximum backlog of
1773     connections that is allowed. On success, continue to the next address. */
1774
1775     if (listen(listen_sockets[sk], smtp_connect_backlog) >= 0)
1776       {
1777 #if defined(TCP_FASTOPEN) && defined(__APPLE__)
1778       if (  f.tcp_fastopen_ok
1779          && setsockopt(listen_sockets[sk], IPPROTO_TCP, TCP_FASTOPEN,
1780                       &on, sizeof(on)))
1781         {
1782         DEBUG(D_any) debug_printf("setsockopt FASTOPEN: %s\n", strerror(errno));
1783         f.tcp_fastopen_ok = FALSE;
1784         }
1785 #endif
1786       continue;
1787       }
1788
1789     /* Listening has failed. In an IPv6 environment, as for bind(), if listen()
1790     fails with the error EADDRINUSE and we are doing IPv4 wildcard listening
1791     and there was a previous successful IPv6 wildcard listen on the same port,
1792     we want to ignore the error on the grounds that we must be in a system
1793     where the IPv6 socket accepts both kinds of call. */
1794
1795     if (!check_special_case(errno, addresses, ipa, TRUE))
1796       log_write(0, LOG_PANIC_DIE, "listen() failed on interface %s: %s",
1797         wildcard
1798         ? af == AF_INET6 ? US"(any IPv6)" : US"(any IPv4)" : ipa->address,
1799         strerror(errno));
1800
1801     DEBUG(D_any) debug_printf("wildcard IPv4 listen() failed after IPv6 "
1802       "listen() success; EADDRINUSE ignored\n");
1803     (void)close(listen_sockets[sk]);
1804
1805     /* Come here if there has been a problem with the socket which we
1806     are going to ignore. We remove the address from the chain, and back up the
1807     counts. */
1808
1809   SKIP_SOCKET:
1810     sk--;                          /* Back up the count */
1811     listen_socket_count--;         /* Reduce the total */
1812     if (ipa == addresses) addresses = ipa->next; else
1813       {
1814       for (ipa2 = addresses; ipa2->next != ipa; ipa2 = ipa2->next);
1815       ipa2->next = ipa->next;
1816       ipa = ipa2;
1817       }
1818     }          /* End of bind/listen loop for each address */
1819   }            /* End of setup for listening */
1820
1821
1822 /* If we are not listening, we want to write a pid file only if -oP was
1823 explicitly given. */
1824
1825 else if (!override_pid_file_path)
1826   write_pid = FALSE;
1827
1828 /* Write the pid to a known file for assistance in identification, if required.
1829 We do this before giving up root privilege, because on some systems it is
1830 necessary to be root in order to write into the pid file directory. There's
1831 nothing to stop multiple daemons running, as long as no more than one listens
1832 on a given TCP/IP port on the same interface(s). However, in these
1833 circumstances it gets far too complicated to mess with pid file names
1834 automatically. Consequently, Exim 4 writes a pid file only
1835
1836   (a) When running in the test harness, or
1837   (b) When -bd is used and -oX is not used, or
1838   (c) When -oP is used to supply a path.
1839
1840 The variable daemon_write_pid is used to control this. */
1841
1842 if (f.running_in_test_harness || write_pid)
1843   {
1844   FILE *f;
1845
1846   set_pid_file_path();
1847   if ((f = modefopen(pid_file_path, "wb", 0644)))
1848     {
1849     (void)fprintf(f, "%d\n", (int)getpid());
1850     (void)fclose(f);
1851     DEBUG(D_any) debug_printf("pid written to %s\n", pid_file_path);
1852     }
1853   else
1854     DEBUG(D_any)
1855       debug_printf("%s\n", string_open_failed("pid file %s", pid_file_path));
1856   }
1857
1858 /* Set up the handler for SIGHUP, which causes a restart of the daemon. */
1859
1860 sighup_seen = FALSE;
1861 signal(SIGHUP, sighup_handler);
1862
1863 /* Give up root privilege at this point (assuming that exim_uid and exim_gid
1864 are not root). The third argument controls the running of initgroups().
1865 Normally we do this, in order to set up the groups for the Exim user. However,
1866 if we are not root at this time - some odd installations run that way - we
1867 cannot do this. */
1868
1869 exim_setugid(exim_uid, exim_gid, geteuid()==root_uid, US"running as a daemon");
1870
1871 /* Update the originator_xxx fields so that received messages as listed as
1872 coming from Exim, not whoever started the daemon. */
1873
1874 originator_uid = exim_uid;
1875 originator_gid = exim_gid;
1876 originator_login = (pw = getpwuid(exim_uid))
1877   ? string_copy_perm(US pw->pw_name, FALSE) : US"exim";
1878
1879 /* Get somewhere to keep the list of queue-runner pids if we are keeping track
1880 of them (and also if we are doing queue runs). */
1881
1882 if (queue_interval > 0 && local_queue_run_max > 0)
1883   {
1884   queue_pid_slots = store_get(local_queue_run_max * sizeof(pid_t), FALSE);
1885   for (int i = 0; i < local_queue_run_max; i++) queue_pid_slots[i] = 0;
1886   }
1887
1888 /* Set up the handler for termination of child processes, and the one
1889 telling us to die. */
1890
1891 sigchld_seen = FALSE;
1892 os_non_restarting_signal(SIGCHLD, main_sigchld_handler);
1893
1894 sigterm_seen = FALSE;
1895 os_non_restarting_signal(SIGTERM, main_sigterm_handler);
1896 os_non_restarting_signal(SIGINT, main_sigterm_handler);
1897
1898 /* If we are to run the queue periodically, pretend the alarm has just gone
1899 off. This will cause the first queue-runner to get kicked off straight away. */
1900
1901 sigalrm_seen = (queue_interval > 0);
1902
1903 /* Log the start up of a daemon - at least one of listening or queue running
1904 must be set up. */
1905
1906 if (f.inetd_wait_mode)
1907   {
1908   uschar *p = big_buffer;
1909
1910   if (inetd_wait_timeout >= 0)
1911     sprintf(CS p, "terminating after %d seconds", inetd_wait_timeout);
1912   else
1913     sprintf(CS p, "with no wait timeout");
1914
1915   log_write(0, LOG_MAIN,
1916     "exim %s daemon started: pid=%d, launched with listening socket, %s",
1917     version_string, getpid(), big_buffer);
1918   set_process_info("daemon(%s): pre-listening socket", version_string);
1919
1920   /* set up the timeout logic */
1921   sigalrm_seen = TRUE;
1922   }
1923
1924 else if (f.daemon_listen)
1925   {
1926   int smtp_ports = 0;
1927   int smtps_ports = 0;
1928   ip_address_item * ipa;
1929   uschar * p;
1930   uschar * qinfo = queue_interval > 0
1931     ? string_sprintf("-q%s%s",
1932         f.queue_2stage ? "q" : "", readconf_printtime(queue_interval))
1933     : US"no queue runs";
1934
1935   /* Build a list of listening addresses in big_buffer, but limit it to 10
1936   items. The style is for backwards compatibility.
1937
1938   It is now possible to have some ports listening for SMTPS (the old,
1939   deprecated protocol that starts TLS without using STARTTLS), and others
1940   listening for standard SMTP. Keep their listings separate. */
1941
1942   for (int j = 0, i; j < 2; j++)
1943     {
1944     for (i = 0, ipa = addresses; i < 10 && ipa; i++, ipa = ipa->next)
1945       {
1946       /* First time round, look for SMTP ports; second time round, look for
1947       SMTPS ports. Build IP+port strings. */
1948
1949       if (host_is_tls_on_connect_port(ipa->port) == (j > 0))
1950         {
1951         if (j == 0)
1952           smtp_ports++;
1953         else
1954           smtps_ports++;
1955
1956         /* Now the information about the port (and sometimes interface) */
1957
1958         if (ipa->address[0] == ':' && ipa->address[1] == 0)
1959           {                                             /* v6 wildcard */
1960           if (ipa->next && ipa->next->address[0] == 0 &&
1961               ipa->next->port == ipa->port)
1962             {
1963             ipa->log = string_sprintf(" port %d (IPv6 and IPv4)", ipa->port);
1964             (ipa = ipa->next)->log = NULL;
1965             }
1966           else if (ipa->v6_include_v4)
1967             ipa->log = string_sprintf(" port %d (IPv6 with IPv4)", ipa->port);
1968           else
1969             ipa->log = string_sprintf(" port %d (IPv6)", ipa->port);
1970           }
1971         else if (ipa->address[0] == 0)                  /* v4 wildcard */
1972           ipa->log = string_sprintf(" port %d (IPv4)", ipa->port);
1973         else                            /* check for previously-seen IP */
1974           {
1975           ip_address_item * i2;
1976           for (i2 = addresses; i2 != ipa; i2 = i2->next)
1977             if (  host_is_tls_on_connect_port(i2->port) == (j > 0)
1978                && Ustrcmp(ipa->address, i2->address) == 0
1979                )
1980               {                         /* found; append port to list */
1981               for (p = i2->log; *p; ) p++;      /* end of existing string */
1982               if (*--p == '}') *p = '\0';       /* drop EOL */
1983               while (isdigit(*--p)) ;           /* char before port */
1984
1985               i2->log = *p == ':'               /* no list yet? */
1986                 ? string_sprintf("%.*s{%s,%d}",
1987                   (int)(p - i2->log + 1), i2->log, p+1, ipa->port)
1988                 : string_sprintf("%s,%d}", i2->log, ipa->port);
1989               ipa->log = NULL;
1990               break;
1991               }
1992           if (i2 == ipa)                /* first-time IP */
1993             ipa->log = string_sprintf(" [%s]:%d", ipa->address, ipa->port);
1994           }
1995         }
1996       }
1997     }
1998
1999   p = big_buffer;
2000   for (int j = 0, i; j < 2; j++)
2001     {
2002     /* First time round, look for SMTP ports; second time round, look for
2003     SMTPS ports. For the first one of each, insert leading text. */
2004
2005     if (j == 0)
2006       {
2007       if (smtp_ports > 0)
2008         p += sprintf(CS p, "SMTP on");
2009       }
2010     else
2011       if (smtps_ports > 0)
2012         p += sprintf(CS p, "%sSMTPS on",
2013           smtp_ports == 0 ? "" : " and for ");
2014
2015     /* Now the information about the port (and sometimes interface) */
2016
2017     for (i = 0, ipa = addresses; i < 10 && ipa; i++, ipa = ipa->next)
2018       if (host_is_tls_on_connect_port(ipa->port) == (j > 0))
2019         if (ipa->log)
2020           p += sprintf(CS p, "%s",  ipa->log);
2021
2022     if (ipa)
2023       p += sprintf(CS p, " ...");
2024     }
2025
2026   log_write(0, LOG_MAIN,
2027     "exim %s daemon started: pid=%d, %s, listening for %s",
2028     version_string, getpid(), qinfo, big_buffer);
2029   set_process_info("daemon(%s): %s, listening for %s",
2030     version_string, qinfo, big_buffer);
2031   }
2032
2033 else
2034   {
2035   uschar * s = *queue_name
2036     ? string_sprintf("-qG%s/%s", queue_name, readconf_printtime(queue_interval))
2037     : string_sprintf("-q%s", readconf_printtime(queue_interval));
2038   log_write(0, LOG_MAIN,
2039     "exim %s daemon started: pid=%d, %s, not listening for SMTP",
2040     version_string, getpid(), s);
2041   set_process_info("daemon(%s): %s, not listening", version_string, s);
2042   }
2043
2044 /* Do any work it might be useful to amortize over our children
2045 (eg: compile regex) */
2046
2047 dns_pattern_init();
2048 smtp_deliver_init();    /* Used for callouts */
2049
2050 #ifndef DISABLE_DKIM
2051   {
2052 # ifdef MEASURE_TIMING
2053   struct timeval t0;
2054   gettimeofday(&t0, NULL);
2055 # endif
2056   dkim_exim_init();
2057 # ifdef MEASURE_TIMING
2058   report_time_since(&t0, US"dkim_exim_init (delta)");
2059 # endif
2060   }
2061 #endif
2062
2063 #ifdef WITH_CONTENT_SCAN
2064 malware_init();
2065 #endif
2066 #ifdef SUPPORT_SPF
2067 spf_init();
2068 #endif
2069 #ifndef DISABLE_TLS
2070 tls_daemon_init();
2071 #endif
2072
2073 /* Close the log so it can be renamed and moved. In the few cases below where
2074 this long-running process writes to the log (always exceptional conditions), it
2075 closes the log afterwards, for the same reason. */
2076
2077 log_close_all();
2078
2079 DEBUG(D_any) debug_print_ids(US"daemon running with");
2080
2081 /* Any messages accepted via this route are going to be SMTP. */
2082
2083 smtp_input = TRUE;
2084
2085 #ifdef MEASURE_TIMING
2086 report_time_since(&timestamp_startup, US"daemon loop start");   /* testcase 0022 */
2087 #endif
2088
2089 /* Enter the never-ending loop... */
2090
2091 for (;;)
2092   {
2093   #if HAVE_IPV6
2094   struct sockaddr_in6 accepted;
2095   #else
2096   struct sockaddr_in accepted;
2097   #endif
2098
2099   EXIM_SOCKLEN_T len;
2100   pid_t pid;
2101
2102   if (sigterm_seen)
2103     daemon_die();       /* Does not return */
2104
2105   /* This code is placed first in the loop, so that it gets obeyed at the
2106   start, before the first wait, for the queue-runner case, so that the first
2107   one can be started immediately.
2108
2109   The other option is that we have an inetd wait timeout specified to -bw. */
2110
2111   if (sigalrm_seen)
2112     {
2113     if (inetd_wait_timeout > 0)
2114       {
2115       time_t resignal_interval = inetd_wait_timeout;
2116
2117       if (last_connection_time == (time_t)0)
2118         {
2119         DEBUG(D_any)
2120           debug_printf("inetd wait timeout expired, but still not seen first message, ignoring\n");
2121         }
2122       else
2123         {
2124         time_t now = time(NULL);
2125         if (now == (time_t)-1)
2126           {
2127           DEBUG(D_any) debug_printf("failed to get time: %s\n", strerror(errno));
2128           }
2129         else
2130           {
2131           if ((now - last_connection_time) >= inetd_wait_timeout)
2132             {
2133             DEBUG(D_any)
2134               debug_printf("inetd wait timeout %d expired, ending daemon\n",
2135                   inetd_wait_timeout);
2136             log_write(0, LOG_MAIN, "exim %s daemon terminating, inetd wait timeout reached.\n",
2137                 version_string);
2138             exit(EXIT_SUCCESS);
2139             }
2140           else
2141             {
2142             resignal_interval -= (now - last_connection_time);
2143             }
2144           }
2145         }
2146
2147       sigalrm_seen = FALSE;
2148       ALARM(resignal_interval);
2149       }
2150
2151     else
2152       {
2153       DEBUG(D_any) debug_printf("%s received\n",
2154 #ifndef DISABLE_QUEUE_RAMP
2155         *queuerun_msgid ? "qrun notification" :
2156 #endif
2157         "SIGALRM");
2158
2159       /* Do a full queue run in a child process, if required, unless we already
2160       have enough queue runners on the go. If we are not running as root, a
2161       re-exec is required. */
2162
2163       if (  queue_interval > 0
2164          && (local_queue_run_max <= 0 || queue_run_count < local_queue_run_max))
2165         {
2166         if ((pid = exim_fork(US"queue-runner")) == 0)
2167           {
2168           /* Disable debugging if it's required only for the daemon process. We
2169           leave the above message, because it ties up with the "child ended"
2170           debugging messages. */
2171
2172           if (f.debug_daemon) debug_selector = 0;
2173
2174           /* Close any open listening sockets in the child */
2175
2176           close_daemon_sockets(daemon_notifier_fd,
2177             listen_sockets, listen_socket_count);
2178
2179           /* Reset SIGHUP and SIGCHLD in the child in both cases. */
2180
2181           signal(SIGHUP,  SIG_DFL);
2182           signal(SIGCHLD, SIG_DFL);
2183           signal(SIGTERM, SIG_DFL);
2184           signal(SIGINT, SIG_DFL);
2185
2186           /* Re-exec if privilege has been given up, unless deliver_drop_
2187           privilege is set. Reset SIGALRM before exec(). */
2188
2189           if (geteuid() != root_uid && !deliver_drop_privilege)
2190             {
2191             uschar opt[8];
2192             uschar *p = opt;
2193             uschar *extra[7];
2194             int extracount = 1;
2195
2196             signal(SIGALRM, SIG_DFL);
2197             *p++ = '-';
2198             *p++ = 'q';
2199             if (  f.queue_2stage
2200 #ifndef DISABLE_QUEUE_RAMP
2201                && !*queuerun_msgid
2202 #endif
2203                ) *p++ = 'q';
2204             if (f.queue_run_first_delivery) *p++ = 'i';
2205             if (f.queue_run_force) *p++ = 'f';
2206             if (f.deliver_force_thaw) *p++ = 'f';
2207             if (f.queue_run_local) *p++ = 'l';
2208             *p = 0;
2209             extra[0] = *queue_name
2210               ? string_sprintf("%sG%s", opt, queue_name) : opt;
2211
2212 #ifndef DISABLE_QUEUE_RAMP
2213             if (*queuerun_msgid)
2214               {
2215               log_write(0, LOG_MAIN, "notify triggered queue run");
2216               extra[extracount++] = queuerun_msgid;     /* Trigger only the */
2217               extra[extracount++] = queuerun_msgid;     /* one message      */
2218               }
2219 #endif
2220
2221             /* If -R or -S were on the original command line, ensure they get
2222             passed on. */
2223
2224             if (deliver_selectstring)
2225               {
2226               extra[extracount++] = f.deliver_selectstring_regex ? US"-Rr" : US"-R";
2227               extra[extracount++] = deliver_selectstring;
2228               }
2229
2230             if (deliver_selectstring_sender)
2231               {
2232               extra[extracount++] = f.deliver_selectstring_sender_regex
2233                 ? US"-Sr" : US"-S";
2234               extra[extracount++] = deliver_selectstring_sender;
2235               }
2236
2237             /* Overlay this process with a new execution. */
2238
2239             (void)child_exec_exim(CEE_EXEC_PANIC, FALSE, NULL, FALSE, extracount,
2240               extra[0], extra[1], extra[2], extra[3], extra[4], extra[5], extra[6]);
2241
2242             /* Control never returns here. */
2243             }
2244
2245           /* No need to re-exec; SIGALRM remains set to the default handler */
2246
2247 #ifndef DISABLE_QUEUE_RAMP
2248           if (*queuerun_msgid)
2249             {
2250             log_write(0, LOG_MAIN, "notify triggered queue run");
2251             f.queue_2stage = FALSE;
2252             queue_run(queuerun_msgid, queuerun_msgid, FALSE);
2253             }
2254           else
2255 #endif
2256             queue_run(NULL, NULL, FALSE);
2257           exim_underbar_exit(EXIT_SUCCESS);
2258           }
2259
2260         if (pid < 0)
2261           {
2262           log_write(0, LOG_MAIN|LOG_PANIC, "daemon: fork of queue-runner "
2263             "process failed: %s", strerror(errno));
2264           log_close_all();
2265           }
2266         else
2267           {
2268           for (int i = 0; i < local_queue_run_max; ++i)
2269             if (queue_pid_slots[i] <= 0)
2270               {
2271               queue_pid_slots[i] = pid;
2272               queue_run_count++;
2273               break;
2274               }
2275           DEBUG(D_any) debug_printf("%d queue-runner process%s running\n",
2276             queue_run_count, queue_run_count == 1 ? "" : "es");
2277           }
2278         }
2279
2280       /* Reset the alarm clock */
2281
2282       sigalrm_seen = FALSE;
2283 #ifndef DISABLE_QUEUE_RAMP
2284       if (*queuerun_msgid)
2285         *queuerun_msgid = 0;
2286       else
2287 #endif
2288         ALARM(queue_interval);
2289       }
2290
2291     } /* sigalrm_seen */
2292
2293
2294   /* Sleep till a connection happens if listening, and handle the connection if
2295   that is why we woke up. The FreeBSD operating system requires the use of
2296   select() before accept() because the latter function is not interrupted by
2297   a signal, and we want to wake up for SIGCHLD and SIGALRM signals. Some other
2298   OS do notice signals in accept() but it does no harm to have the select()
2299   in for all of them - and it won't then be a lurking problem for ports to
2300   new OS. In fact, the later addition of listening on specific interfaces only
2301   requires this way of working anyway. */
2302
2303   if (f.daemon_listen)
2304     {
2305     int lcount;
2306     int max_socket = 0;
2307     BOOL select_failed = FALSE;
2308     fd_set select_listen;
2309
2310     FD_ZERO(&select_listen);
2311 #ifndef DISABLE_TLS
2312     if (tls_watch_fd >= 0)
2313       {
2314       FD_SET(tls_watch_fd, &select_listen);
2315       if (tls_watch_fd > max_socket) max_socket = tls_watch_fd;
2316       }
2317 #endif
2318     if (daemon_notifier_fd >= 0)
2319       {
2320       FD_SET(daemon_notifier_fd, &select_listen);
2321       if (daemon_notifier_fd > max_socket) max_socket = daemon_notifier_fd;
2322       }
2323     for (int sk = 0; sk < listen_socket_count; sk++)
2324       {
2325       FD_SET(listen_sockets[sk], &select_listen);
2326       if (listen_sockets[sk] > max_socket) max_socket = listen_sockets[sk];
2327       }
2328
2329     DEBUG(D_any) debug_printf("Listening...\n");
2330
2331     /* In rare cases we may have had a SIGCHLD signal in the time between
2332     setting the handler (below) and getting back here. If so, pretend that the
2333     select() was interrupted so that we reap the child. This might still leave
2334     a small window when a SIGCHLD could get lost. However, since we use SIGCHLD
2335     only to do the reaping more quickly, it shouldn't result in anything other
2336     than a delay until something else causes a wake-up. */
2337
2338     if (sigchld_seen)
2339       {
2340       lcount = -1;
2341       errno = EINTR;
2342       }
2343     else
2344       lcount = select(max_socket + 1, (SELECT_ARG2_TYPE *)&select_listen,
2345         NULL, NULL, NULL);
2346
2347     if (lcount < 0)
2348       {
2349       select_failed = TRUE;
2350       lcount = 1;
2351       }
2352
2353     /* Clean up any subprocesses that may have terminated. We need to do this
2354     here so that smtp_accept_max_per_host works when a connection to that host
2355     has completed, and we are about to accept a new one. When this code was
2356     later in the sequence, a new connection could be rejected, even though an
2357     old one had just finished. Preserve the errno from any select() failure for
2358     the use of the common select/accept error processing below. */
2359
2360       {
2361       int select_errno = errno;
2362       handle_ending_processes();
2363
2364 #ifndef DISABLE_TLS
2365       /* Create or rotate any required keys; handle (delayed) filewatch event */
2366       tls_daemon_tick();
2367 #endif
2368       errno = select_errno;
2369       }
2370
2371     /* Loop for all the sockets that are currently ready to go. If select
2372     actually failed, we have set the count to 1 and select_failed=TRUE, so as
2373     to use the common error code for select/accept below. */
2374
2375     while (lcount-- > 0)
2376       {
2377       int accept_socket = -1;
2378
2379       if (!select_failed)
2380         {
2381 #if !defined(DISABLE_TLS) && (defined(EXIM_HAVE_INOTIFY) || defined(EXIM_HAVE_KEVENT))
2382         if (tls_watch_fd >= 0 && FD_ISSET(tls_watch_fd, &select_listen))
2383           {
2384           FD_CLR(tls_watch_fd, &select_listen);
2385           tls_watch_trigger_time = time(NULL);  /* Set up delayed event */
2386           tls_watch_discard_event(tls_watch_fd);
2387           break;        /* to top of daemon loop */
2388           }
2389 #endif
2390         if (  daemon_notifier_fd >= 0
2391            && FD_ISSET(daemon_notifier_fd, &select_listen))
2392           {
2393           FD_CLR(daemon_notifier_fd, &select_listen);
2394           sigalrm_seen = daemon_notification();
2395           break;        /* to top of daemon loop */
2396           }
2397         for (int sk = 0; sk < listen_socket_count; sk++)
2398           if (FD_ISSET(listen_sockets[sk], &select_listen))
2399             {
2400             len = sizeof(accepted);
2401             accept_socket = accept(listen_sockets[sk],
2402               (struct sockaddr *)&accepted, &len);
2403             FD_CLR(listen_sockets[sk], &select_listen);
2404             break;
2405             }
2406         }
2407
2408       /* If select or accept has failed and this was not caused by an
2409       interruption, log the incident and try again. With asymmetric TCP/IP
2410       routing errors such as "No route to network" have been seen here. Also
2411       "connection reset by peer" has been seen. These cannot be classed as
2412       disastrous errors, but they could fill up a lot of log. The code in smail
2413       crashes the daemon after 10 successive failures of accept, on the grounds
2414       that some OS fail continuously. Exim originally followed suit, but this
2415       appears to have caused problems. Now it just keeps going, but instead of
2416       logging each error, it batches them up when they are continuous. */
2417
2418       if (accept_socket < 0 && errno != EINTR)
2419         {
2420         if (accept_retry_count == 0)
2421           {
2422           accept_retry_errno = errno;
2423           accept_retry_select_failed = select_failed;
2424           }
2425         else if (  errno != accept_retry_errno
2426                 || select_failed != accept_retry_select_failed
2427                 || accept_retry_count >= 50)
2428             {
2429             log_write(0, LOG_MAIN | (accept_retry_count >= 50 ? LOG_PANIC : 0),
2430               "%d %s() failure%s: %s",
2431               accept_retry_count,
2432               accept_retry_select_failed ? "select" : "accept",
2433               accept_retry_count == 1 ? "" : "s",
2434               strerror(accept_retry_errno));
2435             log_close_all();
2436             accept_retry_count = 0;
2437             accept_retry_errno = errno;
2438             accept_retry_select_failed = select_failed;
2439             }
2440         accept_retry_count++;
2441         }
2442       else if (accept_retry_count > 0)
2443         {
2444         log_write(0, LOG_MAIN, "%d %s() failure%s: %s",
2445           accept_retry_count,
2446           accept_retry_select_failed ? "select" : "accept",
2447           accept_retry_count == 1 ? "" : "s",
2448           strerror(accept_retry_errno));
2449         log_close_all();
2450         accept_retry_count = 0;
2451         }
2452
2453       /* If select/accept succeeded, deal with the connection. */
2454
2455       if (accept_socket >= 0)
2456         {
2457 #ifdef TCP_QUICKACK /* Avoid pure-ACKs while in tls protocol pingpong phase */
2458         /* Unfortunately we cannot be certain to do this before a TLS-on-connect
2459         Client Hello arrives and is acked. We do it as early as possible. */
2460         (void) setsockopt(accept_socket, IPPROTO_TCP, TCP_QUICKACK, US &off, sizeof(off));
2461 #endif
2462         if (inetd_wait_timeout)
2463           last_connection_time = time(NULL);
2464         handle_smtp_call(listen_sockets, listen_socket_count, accept_socket,
2465           (struct sockaddr *)&accepted);
2466         }
2467       }
2468     }
2469
2470   /* If not listening, then just sleep for the queue interval. If we woke
2471   up early the last time for some other signal, it won't matter because
2472   the alarm signal will wake at the right time. This code originally used
2473   sleep() but it turns out that on the FreeBSD system, sleep() is not inter-
2474   rupted by signals, so it wasn't waking up for SIGALRM or SIGCHLD. Luckily
2475   select() can be used as an interruptible sleep() on all versions of Unix. */
2476
2477   else
2478     {
2479     struct timeval tv;
2480     tv.tv_sec = queue_interval;
2481     tv.tv_usec = 0;
2482     select(0, NULL, NULL, NULL, &tv);
2483     handle_ending_processes();
2484     }
2485
2486   /* Re-enable the SIGCHLD handler if it has been run. It can't do it
2487   for itself, because it isn't doing the waiting itself. */
2488
2489   if (sigchld_seen)
2490     {
2491     sigchld_seen = FALSE;
2492     os_non_restarting_signal(SIGCHLD, main_sigchld_handler);
2493     }
2494
2495   /* Handle being woken by SIGHUP. We know at this point that the result
2496   of accept() has been dealt with, so we can re-exec exim safely, first
2497   closing the listening sockets so that they can be reused. Cancel any pending
2498   alarm in case it is just about to go off, and set SIGHUP to be ignored so
2499   that another HUP in quick succession doesn't clobber the new daemon before it
2500   gets going. All log files get closed by the close-on-exec flag; however, if
2501   the exec fails, we need to close the logs. */
2502
2503   if (sighup_seen)
2504     {
2505     log_write(0, LOG_MAIN, "pid %d: SIGHUP received: re-exec daemon",
2506       getpid());
2507     close_daemon_sockets(daemon_notifier_fd,
2508       listen_sockets, listen_socket_count);
2509     ALARM_CLR(0);
2510     signal(SIGHUP, SIG_IGN);
2511     sighup_argv[0] = exim_path;
2512     exim_nullstd();
2513     execv(CS exim_path, (char *const *)sighup_argv);
2514     log_write(0, LOG_MAIN|LOG_PANIC_DIE, "pid %d: exec of %s failed: %s",
2515       getpid(), exim_path, strerror(errno));
2516     log_close_all();
2517     }
2518
2519   }   /* End of main loop */
2520
2521 /* Control never reaches here */
2522 }
2523
2524 /* vi: aw ai sw=2
2525 */
2526 /* End of exim_daemon.c */