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