99eba5f905971c5c80bfb6b8e65ae92aa08e9a85
[users/heiko/exim.git] / src / src / log.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 for writing log files. The code for maintaining datestamped
10 log files was originally contributed by Tony Sheen. */
11
12
13 #include "exim.h"
14
15 #define LOG_NAME_SIZE 256
16 #define MAX_SYSLOG_LEN 870
17
18 #define LOG_MODE_FILE   1
19 #define LOG_MODE_SYSLOG 2
20
21 enum { lt_main, lt_reject, lt_panic, lt_debug };
22
23 static uschar *log_names[] = { US"main", US"reject", US"panic", US"debug" };
24
25
26
27 /*************************************************
28 *           Local static variables               *
29 *************************************************/
30
31 static uschar mainlog_name[LOG_NAME_SIZE];
32 static uschar rejectlog_name[LOG_NAME_SIZE];
33 static uschar debuglog_name[LOG_NAME_SIZE];
34
35 static uschar *mainlog_datestamp = NULL;
36 static uschar *rejectlog_datestamp = NULL;
37
38 static int    mainlogfd = -1;
39 static int    rejectlogfd = -1;
40 static ino_t  mainlog_inode = 0;
41 static ino_t  rejectlog_inode = 0;
42
43 static uschar *panic_save_buffer = NULL;
44 static BOOL   panic_recurseflag = FALSE;
45
46 static BOOL   syslog_open = FALSE;
47 static BOOL   path_inspected = FALSE;
48 static int    logging_mode = LOG_MODE_FILE;
49 static uschar *file_path = US"";
50
51 static size_t pid_position[2];
52
53
54 /* These should be kept in-step with the private delivery error
55 number definitions in macros.h */
56
57 static const uschar * exim_errstrings[] = {
58   US"",
59   US"unknown error",
60   US"user slash",
61   US"exist race",
62   US"not regular",
63   US"not directory",
64   US"bad ugid",
65   US"bad mode",
66   US"inode changed",
67   US"lock failed",
68   US"bad address2",
69   US"forbid pipe",
70   US"forbid file",
71   US"forbid reply",
72   US"missing pipe",
73   US"missing file",
74   US"missing reply",
75   US"bad redirect",
76   US"smtp closed",
77   US"smtp format",
78   US"spool format",
79   US"not absolute",
80   US"Exim-imposed quota",
81   US"held",
82   US"Delivery filter process failure",
83   US"Delivery add/remove header failure",
84   US"Delivery write incomplete error",
85   US"Some expansion failed",
86   US"Failed to get gid",
87   US"Failed to get uid",
88   US"Unset or non-existent transport",
89   US"MBX length mismatch",
90   US"Lookup failed routing or in smtp tpt",
91   US"Can't match format in appendfile",
92   US"Creation outside home in appendfile",
93   US"Can't check a list; lookup defer",
94   US"DNS lookup defer",
95   US"Failed to start TLS session",
96   US"Mandatory TLS session not started",
97   US"Failed to chown a file",
98   US"Failed to create a pipe",
99   US"When verifying",
100   US"When required by client",
101   US"Used internally in smtp transport",
102   US"RCPT gave 4xx error",
103   US"MAIL gave 4xx error",
104   US"DATA gave 4xx error",
105   US"Negotiation failed for proxy configured host",
106   US"Authenticator 'other' failure",
107   US"target not supporting SMTPUTF8",
108   US"",
109
110   US"Not time for routing",
111   US"Not time for local delivery",
112   US"Not time for any remote host",
113   US"Local-only delivery",
114   US"Domain in queue_domains",
115   US"Transport concurrency limit",
116   US"Event requests alternate response",
117 };
118
119
120 /************************************************/
121 const uschar *
122 exim_errstr(int err)
123 {
124 return err < 0 ? exim_errstrings[-err] : CUS strerror(err);
125 }
126
127 /*************************************************
128 *              Write to syslog                   *
129 *************************************************/
130
131 /* The given string is split into sections according to length, or at embedded
132 newlines, and syslogged as a numbered sequence if it is overlong or if there is
133 more than one line. However, if we are running in the test harness, do not do
134 anything. (The test harness doesn't use syslog - for obvious reasons - but we
135 can get here if there is a failure to open the panic log.)
136
137 Arguments:
138   priority       syslog priority
139   s              the string to be written
140
141 Returns:         nothing
142 */
143
144 static void
145 write_syslog(int priority, const uschar *s)
146 {
147 int len;
148 int linecount = 0;
149
150 if (!syslog_pid && LOGGING(pid))
151   s = string_sprintf("%.*s%s", (int)pid_position[0], s, s + pid_position[1]);
152 if (!syslog_timestamp)
153   {
154   len = log_timezone ? 26 : 20;
155   if (LOGGING(millisec)) len += 4;
156   s += len;
157   }
158
159 len = Ustrlen(s);
160
161 #ifndef NO_OPENLOG
162 if (!syslog_open && !f.running_in_test_harness)
163   {
164 # ifdef SYSLOG_LOG_PID
165   openlog(CS syslog_processname, LOG_PID|LOG_CONS, syslog_facility);
166 # else
167   openlog(CS syslog_processname, LOG_CONS, syslog_facility);
168 # endif
169   syslog_open = TRUE;
170   }
171 #endif
172
173 /* First do a scan through the message in order to determine how many lines
174 it is going to end up as. Then rescan to output it. */
175
176 for (int pass = 0; pass < 2; pass++)
177   {
178   const uschar * ss = s;
179   for (int i = 1, tlen = len; tlen > 0; i++)
180     {
181     int plen = tlen;
182     uschar *nlptr = Ustrchr(ss, '\n');
183     if (nlptr != NULL) plen = nlptr - ss;
184 #ifndef SYSLOG_LONG_LINES
185     if (plen > MAX_SYSLOG_LEN) plen = MAX_SYSLOG_LEN;
186 #endif
187     tlen -= plen;
188     if (ss[plen] == '\n') tlen--;    /* chars left */
189
190     if (pass == 0)
191       linecount++;
192     else if (f.running_in_test_harness)
193       if (linecount == 1)
194         fprintf(stderr, "SYSLOG: '%.*s'\n", plen, ss);
195       else
196         fprintf(stderr, "SYSLOG: '[%d%c%d] %.*s'\n", i,
197           ss[plen] == '\n' && tlen != 0 ? '\\' : '/',
198           linecount, plen, ss);
199     else
200       if (linecount == 1)
201         syslog(priority, "%.*s", plen, ss);
202       else
203         syslog(priority, "[%d%c%d] %.*s", i,
204           ss[plen] == '\n' && tlen != 0 ? '\\' : '/',
205           linecount, plen, ss);
206
207     ss += plen;
208     if (*ss == '\n') ss++;
209     }
210   }
211 }
212
213
214
215 /*************************************************
216 *             Die tidily                         *
217 *************************************************/
218
219 /* This is called when Exim is dying as a result of something going wrong in
220 the logging, or after a log call with LOG_PANIC_DIE set. Optionally write a
221 message to debug_file or a stderr file, if they exist. Then, if in the middle
222 of accepting a message, throw it away tidily by calling receive_bomb_out();
223 this will attempt to send an SMTP response if appropriate. Passing NULL as the
224 first argument stops it trying to run the NOTQUIT ACL (which might try further
225 logging and thus cause problems). Otherwise, try to close down an outstanding
226 SMTP call tidily.
227
228 Arguments:
229   s1         Error message to write to debug_file and/or stderr and syslog
230   s2         Error message for any SMTP call that is in progress
231 Returns:     The function does not return
232 */
233
234 static void
235 die(uschar *s1, uschar *s2)
236 {
237 if (s1)
238   {
239   write_syslog(LOG_CRIT, s1);
240   if (debug_file) debug_printf("%s\n", s1);
241   if (log_stderr && log_stderr != debug_file)
242     fprintf(log_stderr, "%s\n", s1);
243   }
244 if (f.receive_call_bombout) receive_bomb_out(NULL, s2);  /* does not return */
245 if (smtp_input) smtp_closedown(s2);
246 exim_exit(EXIT_FAILURE);
247 }
248
249
250
251 /*************************************************
252 *             Create a log file                  *
253 *************************************************/
254
255 /* This function is called to create and open a log file. It may be called in a
256 subprocess when the original process is root.
257
258 Arguments:
259   name         the file name
260
261 The file name has been build in a working buffer, so it is permissible to
262 overwrite it temporarily if it is necessary to create the directory.
263
264 Returns:       a file descriptor, or < 0 on failure (errno set)
265 */
266
267 int
268 log_create(uschar *name)
269 {
270 int fd = Uopen(name,
271 #ifdef O_CLOEXEC
272         O_CLOEXEC |
273 #endif
274         O_CREAT|O_APPEND|O_WRONLY, LOG_MODE);
275
276 /* If creation failed, attempt to build a log directory in case that is the
277 problem. */
278
279 if (fd < 0 && errno == ENOENT)
280   {
281   BOOL created;
282   uschar *lastslash = Ustrrchr(name, '/');
283   *lastslash = 0;
284   created = directory_make(NULL, name, LOG_DIRECTORY_MODE, FALSE);
285   DEBUG(D_any) debug_printf("%s log directory %s\n",
286     created ? "created" : "failed to create", name);
287   *lastslash = '/';
288   if (created) fd = Uopen(name,
289 #ifdef O_CLOEXEC
290                         O_CLOEXEC |
291 #endif
292                         O_CREAT|O_APPEND|O_WRONLY, LOG_MODE);
293   }
294
295 return fd;
296 }
297
298
299
300 /*************************************************
301 *     Create a log file as the exim user         *
302 *************************************************/
303
304 /* This function is called when we are root to spawn an exim:exim subprocess
305 in which we can create a log file. It must be signal-safe since it is called
306 by the usr1_handler().
307
308 Arguments:
309   name         the file name
310
311 Returns:       a file descriptor, or < 0 on failure (errno set)
312 */
313
314 int
315 log_create_as_exim(uschar *name)
316 {
317 pid_t pid = exim_fork(US"logfile-create");
318 int status = 1;
319 int fd = -1;
320
321 /* In the subprocess, change uid/gid and do the creation. Return 0 from the
322 subprocess on success. If we don't check for setuid failures, then the file
323 can be created as root, so vulnerabilities which cause setuid to fail mean
324 that the Exim user can use symlinks to cause a file to be opened/created as
325 root. We always open for append, so can't nuke existing content but it would
326 still be Rather Bad. */
327
328 if (pid == 0)
329   {
330   if (setgid(exim_gid) < 0)
331     die(US"exim: setgid for log-file creation failed, aborting",
332       US"Unexpected log failure, please try later");
333   if (setuid(exim_uid) < 0)
334     die(US"exim: setuid for log-file creation failed, aborting",
335       US"Unexpected log failure, please try later");
336   _exit((log_create(name) < 0)? 1 : 0);
337   }
338
339 /* If we created a subprocess, wait for it. If it succeeded, try the open. */
340
341 while (pid > 0 && waitpid(pid, &status, 0) != pid);
342 if (status == 0) fd = Uopen(name,
343 #ifdef O_CLOEXEC
344                         O_CLOEXEC |
345 #endif
346                         O_APPEND|O_WRONLY, LOG_MODE);
347
348 /* If we failed to create a subprocess, we are in a bad way. We return
349 with fd still < 0, and errno set, letting the caller handle the error. */
350
351 return fd;
352 }
353
354
355
356
357 /*************************************************
358 *                Open a log file                 *
359 *************************************************/
360
361 /* This function opens one of a number of logs, creating the log directory if
362 it does not exist. This may be called recursively on failure, in order to open
363 the panic log.
364
365 The directory is in the static variable file_path. This is static so that it
366 the work of sorting out the path is done just once per Exim process.
367
368 Exim is normally configured to avoid running as root wherever possible, the log
369 files must be owned by the non-privileged exim user. To ensure this, first try
370 an open without O_CREAT - most of the time this will succeed. If it fails, try
371 to create the file; if running as root, this must be done in a subprocess to
372 avoid races.
373
374 Arguments:
375   fd         where to return the resulting file descriptor
376   type       lt_main, lt_reject, lt_panic, or lt_debug
377   tag        optional tag to include in the name (only hooked up for debug)
378
379 Returns:   nothing
380 */
381
382 static void
383 open_log(int *fd, int type, uschar *tag)
384 {
385 uid_t euid;
386 BOOL ok, ok2;
387 uschar buffer[LOG_NAME_SIZE];
388
389 /* The names of the log files are controlled by file_path. The panic log is
390 written to the same directory as the main and reject logs, but its name does
391 not have a datestamp. The use of datestamps is indicated by %D/%M in file_path.
392 When opening the panic log, if %D or %M is present, we remove the datestamp
393 from the generated name; if it is at the start, remove a following
394 non-alphanumeric character as well; otherwise, remove a preceding
395 non-alphanumeric character. This is definitely kludgy, but it sort of does what
396 people want, I hope. */
397
398 ok = string_format(buffer, sizeof(buffer), CS file_path, log_names[type]);
399
400 /* Save the name of the mainlog for rollover processing. Without a datestamp,
401 it gets statted to see if it has been cycled. With a datestamp, the datestamp
402 will be compared. The static slot for saving it is the same size as buffer,
403 and the text has been checked above to fit, so this use of strcpy() is OK. */
404
405 if (type == lt_main && string_datestamp_offset >= 0)
406   {
407   Ustrcpy(mainlog_name, buffer);
408   mainlog_datestamp = mainlog_name + string_datestamp_offset;
409   }
410
411 /* Ditto for the reject log */
412
413 else if (type == lt_reject && string_datestamp_offset >= 0)
414   {
415   Ustrcpy(rejectlog_name, buffer);
416   rejectlog_datestamp = rejectlog_name + string_datestamp_offset;
417   }
418
419 /* and deal with the debug log (which keeps the datestamp, but does not
420 update it) */
421
422 else if (type == lt_debug)
423   {
424   Ustrcpy(debuglog_name, buffer);
425   if (tag)
426     {
427     /* this won't change the offset of the datestamp */
428     ok2 = string_format(buffer, sizeof(buffer), "%s%s",
429       debuglog_name, tag);
430     if (ok2)
431       Ustrcpy(debuglog_name, buffer);
432     }
433   }
434
435 /* Remove any datestamp if this is the panic log. This is rare, so there's no
436 need to optimize getting the datestamp length. We remove one non-alphanumeric
437 char afterwards if at the start, otherwise one before. */
438
439 else if (string_datestamp_offset >= 0)
440   {
441   uschar * from = buffer + string_datestamp_offset;
442   uschar * to = from + string_datestamp_length;
443
444   if (from == buffer || from[-1] == '/')
445     {
446     if (!isalnum(*to)) to++;
447     }
448   else
449     if (!isalnum(from[-1])) from--;
450
451   /* This copy is ok, because we know that to is a substring of from. But
452   due to overlap we must use memmove() not Ustrcpy(). */
453   memmove(from, to, Ustrlen(to)+1);
454   }
455
456 /* If the file name is too long, it is an unrecoverable disaster */
457
458 if (!ok)
459   die(US"exim: log file path too long: aborting",
460       US"Logging failure; please try later");
461
462 /* We now have the file name. Try to open an existing file. After a successful
463 open, arrange for automatic closure on exec(), and then return. */
464
465 *fd = Uopen(buffer,
466 #ifdef O_CLOEXEC
467                 O_CLOEXEC |
468 #endif
469                 O_APPEND|O_WRONLY, LOG_MODE);
470
471 if (*fd >= 0)
472   {
473 #ifndef O_CLOEXEC
474   (void)fcntl(*fd, F_SETFD, fcntl(*fd, F_GETFD) | FD_CLOEXEC);
475 #endif
476   return;
477   }
478
479 /* Open was not successful: try creating the file. If this is a root process,
480 we must do the creating in a subprocess set to exim:exim in order to ensure
481 that the file is created with the right ownership. Otherwise, there can be a
482 race if another Exim process is trying to write to the log at the same time.
483 The use of SIGUSR1 by the exiwhat utility can provoke a lot of simultaneous
484 writing. */
485
486 euid = geteuid();
487
488 /* If we are already running as the Exim user (even if that user is root),
489 we can go ahead and create in the current process. */
490
491 if (euid == exim_uid) *fd = log_create(buffer);
492
493 /* Otherwise, if we are root, do the creation in an exim:exim subprocess. If we
494 are neither exim nor root, creation is not attempted. */
495
496 else if (euid == root_uid) *fd = log_create_as_exim(buffer);
497
498 /* If we now have an open file, set the close-on-exec flag and return. */
499
500 if (*fd >= 0)
501   {
502 #ifndef O_CLOEXEC
503   (void)fcntl(*fd, F_SETFD, fcntl(*fd, F_GETFD) | FD_CLOEXEC);
504 #endif
505   return;
506   }
507
508 /* Creation failed. There are some circumstances in which we get here when
509 the effective uid is not root or exim, which is the problem. (For example, a
510 non-setuid binary with log_arguments set, called in certain ways.) Rather than
511 just bombing out, force the log to stderr and carry on if stderr is available.
512 */
513
514 if (euid != root_uid && euid != exim_uid && log_stderr)
515   {
516   *fd = fileno(log_stderr);
517   return;
518   }
519
520 /* Otherwise this is a disaster. This call is deliberately ONLY to the panic
521 log. If possible, save a copy of the original line that was being logged. If we
522 are recursing (can't open the panic log either), the pointer will already be
523 set.  Also, when we had to use a subprocess for the create we didn't retrieve
524 errno from it, so get the error from the open attempt above (which is often
525 meaningful enough, so leave it). */
526
527 if (!panic_save_buffer)
528   if ((panic_save_buffer = US malloc(LOG_BUFFER_SIZE)))
529     memcpy(panic_save_buffer, log_buffer, LOG_BUFFER_SIZE);
530
531 log_write(0, LOG_PANIC_DIE, "Cannot open %s log file \"%s\": %s: "
532   "euid=%d egid=%d", log_names[type], buffer, strerror(errno), euid, getegid());
533 /* Never returns */
534 }
535
536
537 static void
538 unlink_log(int type)
539 {
540 if (type == lt_debug) unlink(CS debuglog_name);
541 }
542
543
544
545 /*************************************************
546 *     Add configuration file info to log line    *
547 *************************************************/
548
549 /* This is put in a function because it's needed twice (once for debugging,
550 once for real).
551
552 Arguments:
553   ptr         pointer to the end of the line we are building
554   flags       log flags
555
556 Returns:      updated pointer
557 */
558
559 static gstring *
560 log_config_info(gstring * g, int flags)
561 {
562 g = string_cat(g, US"Exim configuration error");
563
564 if (flags & (LOG_CONFIG_FOR & ~LOG_CONFIG))
565   return string_cat(g, US" for ");
566
567 if (flags & (LOG_CONFIG_IN & ~LOG_CONFIG))
568   g = string_fmt_append(g, " in line %d of %s", config_lineno, config_filename);
569
570 return string_catn(g, US":\n  ", 4);
571 }
572
573
574 /*************************************************
575 *           A write() operation failed           *
576 *************************************************/
577
578 /* This function is called when write() fails on anything other than the panic
579 log, which can happen if a disk gets full or a file gets too large or whatever.
580 We try to save the relevant message in the panic_save buffer before crashing
581 out.
582
583 The potential invoker should probably not call us for EINTR -1 writes.  But
584 otherwise, short writes are bad as we don't do non-blocking writes to fds
585 subject to flow control.  (If we do, that's new and the logic of this should
586 be reconsidered).
587
588 Arguments:
589   name      the name of the log being written
590   length    the string length being written
591   rc        the return value from write()
592
593 Returns:    does not return
594 */
595
596 static void
597 log_write_failed(uschar *name, int length, int rc)
598 {
599 int save_errno = errno;
600
601 if (!panic_save_buffer)
602   if ((panic_save_buffer = US malloc(LOG_BUFFER_SIZE)))
603     memcpy(panic_save_buffer, log_buffer, LOG_BUFFER_SIZE);
604
605 log_write(0, LOG_PANIC_DIE, "failed to write to %s: length=%d result=%d "
606   "errno=%d (%s)", name, length, rc, save_errno,
607   (save_errno == 0)? "write incomplete" : strerror(save_errno));
608 /* Never returns */
609 }
610
611
612
613 /*************************************************
614 *     Write to an fd, retrying after signals     *
615 *************************************************/
616
617 /* Basic write to fd for logs, handling EINTR.
618
619 Arguments:
620   fd        the fd to write to
621   buf       the string to write
622   length    the string length being written
623
624 Returns:
625   length actually written, persisting an errno from write()
626 */
627 ssize_t
628 write_to_fd_buf(int fd, const uschar *buf, size_t length)
629 {
630 ssize_t wrote;
631 size_t total_written = 0;
632 const uschar *p = buf;
633 size_t left = length;
634
635 while (1)
636   {
637   wrote = write(fd, p, left);
638   if (wrote == (ssize_t)-1)
639     {
640     if (errno == EINTR) continue;
641     return wrote;
642     }
643   total_written += wrote;
644   if (wrote == left)
645     break;
646   else
647     {
648     p += wrote;
649     left -= wrote;
650     }
651   }
652 return total_written;
653 }
654
655
656
657 static void
658 set_file_path(void)
659 {
660 int sep = ':';              /* Fixed separator - outside use */
661 uschar *t;
662 const uschar *tt = US LOG_FILE_PATH;
663 while ((t = string_nextinlist(&tt, &sep, log_buffer, LOG_BUFFER_SIZE)))
664   {
665   if (Ustrcmp(t, "syslog") == 0 || t[0] == 0) continue;
666   file_path = string_copy(t);
667   break;
668   }
669 }
670
671
672 void
673 mainlog_close(void)
674 {
675 if (mainlogfd < 0) return;
676 (void)close(mainlogfd);
677 mainlogfd = -1;
678 mainlog_inode = 0;
679 }
680
681 /*************************************************
682 *            Write message to log file           *
683 *************************************************/
684
685 /* Exim can be configured to log to local files, or use syslog, or both. This
686 is controlled by the setting of log_file_path. The following cases are
687 recognized:
688
689   log_file_path = ""               write files in the spool/log directory
690   log_file_path = "xxx"            write files in the xxx directory
691   log_file_path = "syslog"         write to syslog
692   log_file_path = "syslog : xxx"   write to syslog and to files (any order)
693
694 The message always gets '\n' added on the end of it, since more than one
695 process may be writing to the log at once and we don't want intermingling to
696 happen in the middle of lines. To be absolutely sure of this we write the data
697 into a private buffer and then put it out in a single write() call.
698
699 The flags determine which log(s) the message is written to, or for syslogging,
700 which priority to use, and in the case of the panic log, whether the process
701 should die afterwards.
702
703 The variable really_exim is TRUE only when exim is running in privileged state
704 (i.e. not with a changed configuration or with testing options such as -brw).
705 If it is not, don't try to write to the log because permission will probably be
706 denied.
707
708 Avoid actually writing to the logs when exim is called with -bv or -bt to
709 test an address, but take other actions, such as panicking.
710
711 In Exim proper, the buffer for building the message is got at start-up, so that
712 nothing gets done if it can't be got. However, some functions that are also
713 used in utilities occasionally obey log_write calls in error situations, and it
714 is simplest to put a single malloc() here rather than put one in each utility.
715 Malloc is used directly because the store functions may call log_write().
716
717 If a message_id exists, we include it after the timestamp.
718
719 Arguments:
720   selector  write to main log or LOG_INFO only if this value is zero, or if
721               its bit is set in log_selector[0]
722   flags     each bit indicates some independent action:
723               LOG_SENDER      add raw sender to the message
724               LOG_RECIPIENTS  add raw recipients list to message
725               LOG_CONFIG      add "Exim configuration error"
726               LOG_CONFIG_FOR  add " for " instead of ":\n  "
727               LOG_CONFIG_IN   add " in line x[ of file y]"
728               LOG_MAIN        write to main log or syslog LOG_INFO
729               LOG_REJECT      write to reject log or syslog LOG_NOTICE
730               LOG_PANIC       write to panic log or syslog LOG_ALERT
731               LOG_PANIC_DIE   write to panic log or LOG_ALERT and then crash
732   format    a printf() format
733   ...       arguments for format
734
735 Returns:    nothing
736 */
737
738 void
739 log_write(unsigned int selector, int flags, const char *format, ...)
740 {
741 int paniclogfd;
742 ssize_t written_len;
743 gstring gs = { .size = LOG_BUFFER_SIZE-1, .ptr = 0, .s = log_buffer };
744 gstring * g;
745 va_list ap;
746
747 /* If panic_recurseflag is set, we have failed to open the panic log. This is
748 the ultimate disaster. First try to write the message to a debug file and/or
749 stderr and also to syslog. If panic_save_buffer is not NULL, it contains the
750 original log line that caused the problem. Afterwards, expire. */
751
752 if (panic_recurseflag)
753   {
754   uschar *extra = panic_save_buffer ? panic_save_buffer : US"";
755   if (debug_file) debug_printf("%s%s", extra, log_buffer);
756   if (log_stderr && log_stderr != debug_file)
757     fprintf(log_stderr, "%s%s", extra, log_buffer);
758   if (*extra) write_syslog(LOG_CRIT, extra);
759   write_syslog(LOG_CRIT, log_buffer);
760   die(US"exim: could not open panic log - aborting: see message(s) above",
761     US"Unexpected log failure, please try later");
762   }
763
764 /* Ensure we have a buffer (see comment above); this should never be obeyed
765 when running Exim proper, only when running utilities. */
766
767 if (!log_buffer)
768   if (!(log_buffer = US malloc(LOG_BUFFER_SIZE)))
769     {
770     fprintf(stderr, "exim: failed to get store for log buffer\n");
771     exim_exit(EXIT_FAILURE);
772     }
773
774 /* If we haven't already done so, inspect the setting of log_file_path to
775 determine whether to log to files and/or to syslog. Bits in logging_mode
776 control this, and for file logging, the path must end up in file_path. This
777 variable must be in permanent store because it may be required again later in
778 the process. */
779
780 if (!path_inspected)
781   {
782   BOOL multiple = FALSE;
783   int old_pool = store_pool;
784
785   store_pool = POOL_PERM;
786
787   /* If nothing has been set, don't waste effort... the default values for the
788   statics are file_path="" and logging_mode = LOG_MODE_FILE. */
789
790   if (*log_file_path)
791     {
792     int sep = ':';              /* Fixed separator - outside use */
793     uschar *s;
794     const uschar *ss = log_file_path;
795
796     logging_mode = 0;
797     while ((s = string_nextinlist(&ss, &sep, log_buffer, LOG_BUFFER_SIZE)))
798       {
799       if (Ustrcmp(s, "syslog") == 0)
800         logging_mode |= LOG_MODE_SYSLOG;
801       else if (logging_mode & LOG_MODE_FILE)
802         multiple = TRUE;
803       else
804         {
805         logging_mode |= LOG_MODE_FILE;
806
807         /* If a non-empty path is given, use it */
808
809         if (*s)
810           file_path = string_copy(s);
811
812         /* If the path is empty, we want to use the first non-empty, non-
813         syslog item in LOG_FILE_PATH, if there is one, since the value of
814         log_file_path may have been set at runtime. If there is no such item,
815         use the ultimate default in the spool directory. */
816
817         else
818           set_file_path();  /* Empty item in log_file_path */
819         }    /* First non-syslog item in log_file_path */
820       }      /* Scan of log_file_path */
821     }
822
823   /* If no modes have been selected, it is a major disaster */
824
825   if (logging_mode == 0)
826     die(US"Neither syslog nor file logging set in log_file_path",
827         US"Unexpected logging failure");
828
829   /* Set up the ultimate default if necessary. Then revert to the old store
830   pool, and record that we've sorted out the path. */
831
832   if (logging_mode & LOG_MODE_FILE  &&  !file_path[0])
833     file_path = string_sprintf("%s/log/%%slog", spool_directory);
834   store_pool = old_pool;
835   path_inspected = TRUE;
836
837   /* If more than one file path was given, log a complaint. This recursive call
838   should work since we have now set up the routing. */
839
840   if (multiple)
841     log_write(0, LOG_MAIN|LOG_PANIC,
842       "More than one path given in log_file_path: using %s", file_path);
843   }
844
845 /* If debugging, show all log entries, but don't show headers. Do it all
846 in one go so that it doesn't get split when multi-processing. */
847
848 DEBUG(D_any|D_v)
849   {
850   int i;
851
852   g = string_catn(&gs, US"LOG:", 4);
853
854   /* Show the selector that was passed into the call. */
855
856   for (i = 0; i < log_options_count; i++)
857     {
858     unsigned int bitnum = log_options[i].bit;
859     if (bitnum < BITWORDSIZE && selector == BIT(bitnum))
860       g = string_fmt_append(g, " %s", log_options[i].name);
861     }
862
863   g = string_fmt_append(g, "%s%s%s%s\n  ",
864     flags & LOG_MAIN ?    " MAIN"   : "",
865     flags & LOG_PANIC ?   " PANIC"  : "",
866     (flags & LOG_PANIC_DIE) == LOG_PANIC_DIE ? " DIE" : "",
867     flags & LOG_REJECT ?  " REJECT" : "");
868
869   if (flags & LOG_CONFIG) g = log_config_info(g, flags);
870
871   /* We want to be able to log tainted info, but log_buffer is directly
872   malloc'd.  So use deliberately taint-nonchecking routines to build into
873   it, trusting that we will never expand the results. */
874
875   va_start(ap, format);
876   i = g->ptr;
877   if (!string_vformat(g, SVFMT_TAINT_NOCHK, format, ap))
878     {
879     g->ptr = i;
880     g = string_cat(g, US"**** log string overflowed log buffer ****");
881     }
882   va_end(ap);
883
884   g->size = LOG_BUFFER_SIZE;
885   g = string_catn(g, US"\n", 1);
886   debug_printf("%s", string_from_gstring(g));
887
888   gs.size = LOG_BUFFER_SIZE-1;  /* Having used the buffer for debug output, */
889   gs.ptr = 0;                   /* reset it for the real use. */
890   gs.s = log_buffer;
891   }
892 /* If no log file is specified, we are in a mess. */
893
894 if (!(flags & (LOG_MAIN|LOG_PANIC|LOG_REJECT)))
895   log_write(0, LOG_MAIN|LOG_PANIC_DIE, "log_write called with no log "
896     "flags set");
897
898 /* There are some weird circumstances in which logging is disabled. */
899
900 if (f.disable_logging)
901   {
902   DEBUG(D_any) debug_printf("log writing disabled\n");
903   return;
904   }
905
906 /* Handle disabled reject log */
907
908 if (!write_rejectlog) flags &= ~LOG_REJECT;
909
910 /* Create the main message in the log buffer. Do not include the message id
911 when called by a utility. */
912
913 g = string_fmt_append(&gs, "%s ", tod_stamp(tod_log));
914
915 if (LOGGING(pid))
916   {
917   if (!syslog_pid) pid_position[0] = g->ptr;            /* remember begin â€¦ */
918   g = string_fmt_append(g, "[%d] ", (int)getpid());
919   if (!syslog_pid) pid_position[1] = g->ptr;            /*  â€¦ and end+1 of the PID */
920   }
921
922 if (f.really_exim && message_id[0] != 0)
923   g = string_fmt_append(g, "%s ", message_id);
924
925 if (flags & LOG_CONFIG)
926   g = log_config_info(g, flags);
927
928 va_start(ap, format);
929   {
930   int i = g->ptr;
931
932   /* We want to be able to log tainted info, but log_buffer is directly
933   malloc'd.  So use deliberately taint-nonchecking routines to build into
934   it, trusting that we will never expand the results. */
935
936   if (!string_vformat(g, SVFMT_TAINT_NOCHK, format, ap))
937     {
938     g->ptr = i;
939     g = string_cat(g, US"**** log string overflowed log buffer ****\n");
940     }
941   }
942 va_end(ap);
943
944 /* Add the raw, unrewritten, sender to the message if required. This is done
945 this way because it kind of fits with LOG_RECIPIENTS. */
946
947 if (   flags & LOG_SENDER
948    && g->ptr < LOG_BUFFER_SIZE - 10 - Ustrlen(raw_sender))
949   g = string_fmt_append_f(g, SVFMT_TAINT_NOCHK, " from <%s>", raw_sender);
950
951 /* Add list of recipients to the message if required; the raw list,
952 before rewriting, was saved in raw_recipients. There may be none, if an ACL
953 discarded them all. */
954
955 if (  flags & LOG_RECIPIENTS
956    && g->ptr < LOG_BUFFER_SIZE - 6
957    && raw_recipients_count > 0)
958   {
959   int i;
960   g = string_fmt_append_f(g, SVFMT_TAINT_NOCHK, " for", NULL);
961   for (i = 0; i < raw_recipients_count; i++)
962     {
963     uschar * s = raw_recipients[i];
964     if (LOG_BUFFER_SIZE - g->ptr < Ustrlen(s) + 3) break;
965     g = string_fmt_append_f(g, SVFMT_TAINT_NOCHK, " %s", s);
966     }
967   }
968
969 g = string_catn(g, US"\n", 1);
970 string_from_gstring(g);
971
972 /* Handle loggable errors when running a utility, or when address testing.
973 Write to log_stderr unless debugging (when it will already have been written),
974 or unless there is no log_stderr (expn called from daemon, for example). */
975
976 if (!f.really_exim || f.log_testing_mode)
977   {
978   if (  !debug_selector
979      && log_stderr
980      && (selector == 0 || (selector & log_selector[0]) != 0)
981     )
982     if (host_checking)
983       fprintf(log_stderr, "LOG: %s", CS(log_buffer + 20));  /* no timestamp */
984     else
985       fprintf(log_stderr, "%s", CS log_buffer);
986
987   if ((flags & LOG_PANIC_DIE) == LOG_PANIC_DIE) exim_exit(EXIT_FAILURE);
988   return;
989   }
990
991 /* Handle the main log. We know that either syslog or file logging (or both) is
992 set up. A real file gets left open during reception or delivery once it has
993 been opened, but we don't want to keep on writing to it for too long after it
994 has been renamed. Therefore, do a stat() and see if the inode has changed, and
995 if so, re-open. */
996
997 if (  flags & LOG_MAIN
998    && (!selector ||  selector & log_selector[0]))
999   {
1000   if (  logging_mode & LOG_MODE_SYSLOG
1001      && (syslog_duplication || !(flags & (LOG_REJECT|LOG_PANIC))))
1002     write_syslog(LOG_INFO, log_buffer);
1003
1004   if (logging_mode & LOG_MODE_FILE)
1005     {
1006     struct stat statbuf;
1007
1008     /* Check for a change to the mainlog file name when datestamping is in
1009     operation. This happens at midnight, at which point we want to roll over
1010     the file. Closing it has the desired effect. */
1011
1012     if (mainlog_datestamp)
1013       {
1014       uschar *nowstamp = tod_stamp(string_datestamp_type);
1015       if (Ustrncmp (mainlog_datestamp, nowstamp, Ustrlen(nowstamp)) != 0)
1016         {
1017         (void)close(mainlogfd);       /* Close the file */
1018         mainlogfd = -1;               /* Clear the file descriptor */
1019         mainlog_inode = 0;            /* Unset the inode */
1020         mainlog_datestamp = NULL;     /* Clear the datestamp */
1021         }
1022       }
1023
1024     /* Otherwise, we want to check whether the file has been renamed by a
1025     cycling script. This could be "if else", but for safety's sake, leave it as
1026     "if" so that renaming the log starts a new file even when datestamping is
1027     happening. */
1028
1029     if (mainlogfd >= 0)
1030       if (Ustat(mainlog_name, &statbuf) < 0 || statbuf.st_ino != mainlog_inode)
1031         mainlog_close();
1032
1033     /* If the log is closed, open it. Then write the line. */
1034
1035     if (mainlogfd < 0)
1036       {
1037       open_log(&mainlogfd, lt_main, NULL);     /* No return on error */
1038       if (fstat(mainlogfd, &statbuf) >= 0) mainlog_inode = statbuf.st_ino;
1039       }
1040
1041     /* Failing to write to the log is disastrous */
1042
1043     written_len = write_to_fd_buf(mainlogfd, g->s, g->ptr);
1044     if (written_len != g->ptr)
1045       {
1046       log_write_failed(US"main log", g->ptr, written_len);
1047       /* That function does not return */
1048       }
1049     }
1050   }
1051
1052 /* Handle the log for rejected messages. This can be globally disabled, in
1053 which case the flags are altered above. If there are any header lines (i.e. if
1054 the rejection is happening after the DATA phase), log the recipients and the
1055 headers. */
1056
1057 if (flags & LOG_REJECT)
1058   {
1059   if (header_list && LOGGING(rejected_header))
1060     {
1061     gstring * g2;
1062     int i;
1063
1064     if (recipients_count > 0)
1065       {
1066       /* List the sender */
1067
1068       g2 = string_fmt_append_f(g, SVFMT_TAINT_NOCHK,
1069                         "Envelope-from: <%s>\n", sender_address);
1070       if (g2) g = g2;
1071
1072       /* List up to 5 recipients */
1073
1074       g2 = string_fmt_append_f(g, SVFMT_TAINT_NOCHK,
1075                         "Envelope-to: <%s>\n", recipients_list[0].address);
1076       if (g2) g = g2;
1077
1078       for (i = 1; i < recipients_count && i < 5; i++)
1079         {
1080         g2 = string_fmt_append_f(g, SVFMT_TAINT_NOCHK,
1081                         "    <%s>\n", recipients_list[i].address);
1082         if (g2) g = g2;
1083         }
1084
1085       if (i < recipients_count)
1086         {
1087         g2 = string_fmt_append_f(g, SVFMT_TAINT_NOCHK, "    ...\n", NULL);
1088         if (g2) g = g2;
1089         }
1090       }
1091
1092     /* A header with a NULL text is an unfilled in Received: header */
1093
1094     for (header_line * h = header_list; h; h = h->next) if (h->text)
1095       {
1096       g2 = string_fmt_append_f(g, SVFMT_TAINT_NOCHK,
1097                         "%c %s", h->type, h->text);
1098       if (g2)
1099         g = g2;
1100       else              /* Buffer is full; truncate */
1101         {
1102         g->ptr -= 100;        /* For message and separator */
1103         if (g->s[g->ptr-1] == '\n') g->ptr--;
1104         g = string_cat(g, US"\n*** truncated ***\n");
1105         break;
1106         }
1107       }
1108     }
1109
1110   /* Write to syslog or to a log file */
1111
1112   if (  logging_mode & LOG_MODE_SYSLOG
1113      && (syslog_duplication || !(flags & LOG_PANIC)))
1114     write_syslog(LOG_NOTICE, string_from_gstring(g));
1115
1116   /* Check for a change to the rejectlog file name when datestamping is in
1117   operation. This happens at midnight, at which point we want to roll over
1118   the file. Closing it has the desired effect. */
1119
1120   if (logging_mode & LOG_MODE_FILE)
1121     {
1122     struct stat statbuf;
1123
1124     if (rejectlog_datestamp)
1125       {
1126       uschar *nowstamp = tod_stamp(string_datestamp_type);
1127       if (Ustrncmp (rejectlog_datestamp, nowstamp, Ustrlen(nowstamp)) != 0)
1128         {
1129         (void)close(rejectlogfd);       /* Close the file */
1130         rejectlogfd = -1;               /* Clear the file descriptor */
1131         rejectlog_inode = 0;            /* Unset the inode */
1132         rejectlog_datestamp = NULL;     /* Clear the datestamp */
1133         }
1134       }
1135
1136     /* Otherwise, we want to check whether the file has been renamed by a
1137     cycling script. This could be "if else", but for safety's sake, leave it as
1138     "if" so that renaming the log starts a new file even when datestamping is
1139     happening. */
1140
1141     if (rejectlogfd >= 0)
1142       if (Ustat(rejectlog_name, &statbuf) < 0 ||
1143            statbuf.st_ino != rejectlog_inode)
1144         {
1145         (void)close(rejectlogfd);
1146         rejectlogfd = -1;
1147         rejectlog_inode = 0;
1148         }
1149
1150     /* Open the file if necessary, and write the data */
1151
1152     if (rejectlogfd < 0)
1153       {
1154       open_log(&rejectlogfd, lt_reject, NULL); /* No return on error */
1155       if (fstat(rejectlogfd, &statbuf) >= 0) rejectlog_inode = statbuf.st_ino;
1156       }
1157
1158     written_len = write_to_fd_buf(rejectlogfd, g->s, g->ptr);
1159     if (written_len != g->ptr)
1160       {
1161       log_write_failed(US"reject log", g->ptr, written_len);
1162       /* That function does not return */
1163       }
1164     }
1165   }
1166
1167
1168 /* Handle the panic log, which is not kept open like the others. If it fails to
1169 open, there will be a recursive call to log_write(). We detect this above and
1170 attempt to write to the system log as a last-ditch try at telling somebody. In
1171 all cases except mua_wrapper, try to write to log_stderr. */
1172
1173 if (flags & LOG_PANIC)
1174   {
1175   if (log_stderr && log_stderr != debug_file && !mua_wrapper)
1176     fprintf(log_stderr, "%s", CS string_from_gstring(g));
1177
1178   if (logging_mode & LOG_MODE_SYSLOG)
1179     write_syslog(LOG_ALERT, log_buffer);
1180
1181   /* If this panic logging was caused by a failure to open the main log,
1182   the original log line is in panic_save_buffer. Make an attempt to write it. */
1183
1184   if (logging_mode & LOG_MODE_FILE)
1185     {
1186     panic_recurseflag = TRUE;
1187     open_log(&paniclogfd, lt_panic, NULL);  /* Won't return on failure */
1188     panic_recurseflag = FALSE;
1189
1190     if (panic_save_buffer)
1191       {
1192       int i = write(paniclogfd, panic_save_buffer, Ustrlen(panic_save_buffer));
1193       i = i;    /* compiler quietening */
1194       }
1195
1196     written_len = write_to_fd_buf(paniclogfd, g->s, g->ptr);
1197     if (written_len != g->ptr)
1198       {
1199       int save_errno = errno;
1200       write_syslog(LOG_CRIT, log_buffer);
1201       sprintf(CS log_buffer, "write failed on panic log: length=%d result=%d "
1202         "errno=%d (%s)", g->ptr, (int)written_len, save_errno, strerror(save_errno));
1203       write_syslog(LOG_CRIT, string_from_gstring(g));
1204       flags |= LOG_PANIC_DIE;
1205       }
1206
1207     (void)close(paniclogfd);
1208     }
1209
1210   /* Give up if the DIE flag is set */
1211
1212   if ((flags & LOG_PANIC_DIE) != LOG_PANIC)
1213     die(NULL, US"Unexpected failure, please try later");
1214   }
1215 }
1216
1217
1218
1219 /*************************************************
1220 *            Close any open log files            *
1221 *************************************************/
1222
1223 void
1224 log_close_all(void)
1225 {
1226 if (mainlogfd >= 0)
1227   { (void)close(mainlogfd); mainlogfd = -1; }
1228 if (rejectlogfd >= 0)
1229   { (void)close(rejectlogfd); rejectlogfd = -1; }
1230 closelog();
1231 syslog_open = FALSE;
1232 }
1233
1234
1235
1236 /*************************************************
1237 *             Multi-bit set or clear             *
1238 *************************************************/
1239
1240 /* These functions take a list of bit indexes (terminated by -1) and
1241 clear or set the corresponding bits in the selector.
1242
1243 Arguments:
1244   selector       address of the bit string
1245   selsize        number of words in the bit string
1246   bits           list of bits to set
1247 */
1248
1249 void
1250 bits_clear(unsigned int *selector, size_t selsize, int *bits)
1251 {
1252 for(; *bits != -1; ++bits)
1253   BIT_CLEAR(selector, selsize, *bits);
1254 }
1255
1256 void
1257 bits_set(unsigned int *selector, size_t selsize, int *bits)
1258 {
1259 for(; *bits != -1; ++bits)
1260   BIT_SET(selector, selsize, *bits);
1261 }
1262
1263
1264
1265 /*************************************************
1266 *         Decode bit settings for log/debug      *
1267 *************************************************/
1268
1269 /* This function decodes a string containing bit settings in the form of +name
1270 and/or -name sequences, and sets/unsets bits in a bit string accordingly. It
1271 also recognizes a numeric setting of the form =<number>, but this is not
1272 intended for user use. It's an easy way for Exim to pass the debug settings
1273 when it is re-exec'ed.
1274
1275 The option table is a list of names and bit indexes. The index -1
1276 means "set all bits, except for those listed in notall". The notall
1277 list is terminated by -1.
1278
1279 The action taken for bad values varies depending upon why we're here.
1280 For log messages, or if the debugging is triggered from config, then we write
1281 to the log on the way out.  For debug setting triggered from the command-line,
1282 we treat it as an unknown option: error message to stderr and die.
1283
1284 Arguments:
1285   selector       address of the bit string
1286   selsize        number of words in the bit string
1287   notall         list of bits to exclude from "all"
1288   string         the configured string
1289   options        the table of option names
1290   count          size of table
1291   which          "log" or "debug"
1292   flags          DEBUG_FROM_CONFIG
1293
1294 Returns:         nothing on success - bomb out on failure
1295 */
1296
1297 void
1298 decode_bits(unsigned int *selector, size_t selsize, int *notall,
1299   uschar *string, bit_table *options, int count, uschar *which, int flags)
1300 {
1301 uschar *errmsg;
1302 if (!string) return;
1303
1304 if (*string == '=')
1305   {
1306   char *end;    /* Not uschar */
1307   memset(selector, 0, sizeof(*selector)*selsize);
1308   *selector = strtoul(CS string+1, &end, 0);
1309   if (!*end) return;
1310   errmsg = string_sprintf("malformed numeric %s_selector setting: %s", which,
1311     string);
1312   goto ERROR_RETURN;
1313   }
1314
1315 /* Handle symbolic setting */
1316
1317 else for(;;)
1318   {
1319   BOOL adding;
1320   uschar *s;
1321   int len;
1322   bit_table *start, *end;
1323
1324   Uskip_whitespace(&string);
1325   if (!*string) return;
1326
1327   if (*string != '+' && *string != '-')
1328     {
1329     errmsg = string_sprintf("malformed %s_selector setting: "
1330       "+ or - expected but found \"%s\"", which, string);
1331     goto ERROR_RETURN;
1332     }
1333
1334   adding = *string++ == '+';
1335   s = string;
1336   while (isalnum(*string) || *string == '_') string++;
1337   len = string - s;
1338
1339   start = options;
1340   end = options + count;
1341
1342   while (start < end)
1343     {
1344     bit_table *middle = start + (end - start)/2;
1345     int c = Ustrncmp(s, middle->name, len);
1346     if (c == 0)
1347       if (middle->name[len] != 0) c = -1; else
1348         {
1349         unsigned int bit = middle->bit;
1350
1351         if (bit == -1)
1352           {
1353           if (adding)
1354             {
1355             memset(selector, -1, sizeof(*selector)*selsize);
1356             bits_clear(selector, selsize, notall);
1357             }
1358           else
1359             memset(selector, 0, sizeof(*selector)*selsize);
1360           }
1361         else if (adding)
1362           BIT_SET(selector, selsize, bit);
1363         else
1364           BIT_CLEAR(selector, selsize, bit);
1365
1366         break;  /* Out of loop to match selector name */
1367         }
1368     if (c < 0) end = middle; else start = middle + 1;
1369     }  /* Loop to match selector name */
1370
1371   if (start >= end)
1372     {
1373     errmsg = string_sprintf("unknown %s_selector setting: %c%.*s", which,
1374       adding? '+' : '-', len, s);
1375     goto ERROR_RETURN;
1376     }
1377   }    /* Loop for selector names */
1378
1379 /* Handle disasters */
1380
1381 ERROR_RETURN:
1382 if (Ustrcmp(which, "debug") == 0)
1383   {
1384   if (flags & DEBUG_FROM_CONFIG)
1385     {
1386     log_write(0, LOG_CONFIG|LOG_PANIC, "%s", errmsg);
1387     return;
1388     }
1389   fprintf(stderr, "exim: %s\n", errmsg);
1390   exit(EXIT_FAILURE);
1391   }
1392 else log_write(0, LOG_CONFIG|LOG_PANIC_DIE, "%s", errmsg);
1393 }
1394
1395
1396
1397 /*************************************************
1398 *        Activate a debug logfile (late)         *
1399 *************************************************/
1400
1401 /* Normally, debugging is activated from the command-line; it may be useful
1402 within the configuration to activate debugging later, based on certain
1403 conditions.  If debugging is already in progress, we return early, no action
1404 taken (besides debug-logging that we wanted debug-logging).
1405
1406 Failures in options are not fatal but will result in paniclog entries for the
1407 misconfiguration.
1408
1409 The first use of this is in ACL logic, "control = debug/tag=foo/opts=+expand"
1410 which can be combined with conditions, etc, to activate extra logging only
1411 for certain sources. The second use is inetd wait mode debug preservation. */
1412
1413 void
1414 debug_logging_activate(uschar *tag_name, uschar *opts)
1415 {
1416 int fd = -1;
1417
1418 if (debug_file)
1419   {
1420   debug_printf("DEBUGGING ACTIVATED FROM WITHIN CONFIG.\n"
1421       "DEBUG: Tag=\"%s\" opts=\"%s\"\n", tag_name, opts ? opts : US"");
1422   return;
1423   }
1424
1425 if (tag_name != NULL && (Ustrchr(tag_name, '/') != NULL))
1426   {
1427   log_write(0, LOG_MAIN|LOG_PANIC, "debug tag may not contain a '/' in: %s",
1428       tag_name);
1429   return;
1430   }
1431
1432 debug_selector = D_default;
1433 if (opts)
1434   decode_bits(&debug_selector, 1, debug_notall, opts,
1435       debug_options, debug_options_count, US"debug", DEBUG_FROM_CONFIG);
1436
1437 /* When activating from a transport process we may never have logged at all
1438 resulting in certain setup not having been done.  Hack this for now so we
1439 do not segfault; note that nondefault log locations will not work */
1440
1441 if (!*file_path) set_file_path();
1442
1443 open_log(&fd, lt_debug, tag_name);
1444
1445 if (fd != -1)
1446   debug_file = fdopen(fd, "w");
1447 else
1448   log_write(0, LOG_MAIN|LOG_PANIC, "unable to open debug log");
1449 }
1450
1451
1452 void
1453 debug_logging_stop(void)
1454 {
1455 if (!debug_file || !debuglog_name[0]) return;
1456
1457 debug_selector = 0;
1458 fclose(debug_file);
1459 debug_file = NULL;
1460 unlink_log(lt_debug);
1461 }
1462
1463
1464 /* End of log.c */