1 /*************************************************
2 * Exim - an Internet mail transport agent *
3 *************************************************/
5 /* Copyright (c) University of Cambridge 1995 - 2016 */
6 /* See the file NOTICE for conditions of use and distribution. */
8 /* Functions for writing log files. The code for maintaining datestamped
9 log files was originally contributed by Tony Sheen. */
14 #define LOG_NAME_SIZE 256
15 #define MAX_SYSLOG_LEN 870
17 #define LOG_MODE_FILE 1
18 #define LOG_MODE_SYSLOG 2
20 enum { lt_main, lt_reject, lt_panic, lt_debug };
22 static uschar *log_names[] = { US"main", US"reject", US"panic", US"debug" };
26 /*************************************************
27 * Local static variables *
28 *************************************************/
30 static uschar mainlog_name[LOG_NAME_SIZE];
31 static uschar rejectlog_name[LOG_NAME_SIZE];
32 static uschar debuglog_name[LOG_NAME_SIZE];
34 static uschar *mainlog_datestamp = NULL;
35 static uschar *rejectlog_datestamp = NULL;
37 static int mainlogfd = -1;
38 static int rejectlogfd = -1;
39 static ino_t mainlog_inode = 0;
40 static ino_t rejectlog_inode = 0;
42 static uschar *panic_save_buffer = NULL;
43 static BOOL panic_recurseflag = FALSE;
45 static BOOL syslog_open = FALSE;
46 static BOOL path_inspected = FALSE;
47 static int logging_mode = LOG_MODE_FILE;
48 static uschar *file_path = US"";
51 /* These should be kept in-step with the private delivery error
52 number definitions in macros.h */
54 static const uschar * exim_errstrings[] = {
77 US"Exim-imposed quota",
79 US"Delivery filter process failure",
80 US"Delivery add/remove header failure",
81 US"Delivery write incomplete error",
82 US"Some expansion failed",
83 US"Failed to get gid",
84 US"Failed to get uid",
85 US"Unset or non-existent transport",
86 US"MBX length mismatch",
87 US"Lookup failed routing or in smtp tpt",
88 US"Can't match format in appendfile",
89 US"Creation outside home in appendfile",
90 US"Can't check a list; lookup defer",
92 US"Failed to start TLS session",
93 US"Mandatory TLS session not started",
94 US"Failed to chown a file",
95 US"Failed to create a pipe",
97 US"When required by client",
98 US"Used internally in smtp transport",
99 US"RCPT gave 4xx error",
100 US"MAIL gave 4xx error",
101 US"DATA gave 4xx error",
102 US"Negotiation failed for proxy configured host",
103 US"Authenticator 'other' failure",
104 US"target not supporting SMTPUTF8",
107 US"Not time for routing",
108 US"Not time for local delivery",
109 US"Not time for any remote host",
110 US"Local-only delivery",
111 US"Domain in queue_domains",
112 US"Transport concurrency limit",
116 /************************************************/
120 return err < 0 ? exim_errstrings[-err] : CUS strerror(err);
123 /*************************************************
125 *************************************************/
127 /* The given string is split into sections according to length, or at embedded
128 newlines, and syslogged as a numbered sequence if it is overlong or if there is
129 more than one line. However, if we are running in the test harness, do not do
130 anything. (The test harness doesn't use syslog - for obvious reasons - but we
131 can get here if there is a failure to open the panic log.)
134 priority syslog priority
135 s the string to be written
141 write_syslog(int priority, uschar *s)
146 if (running_in_test_harness) return;
148 if (!syslog_timestamp) s += log_timezone? 26 : 20;
155 #ifdef SYSLOG_LOG_PID
156 openlog(CS syslog_processname, LOG_PID|LOG_CONS, syslog_facility);
158 openlog(CS syslog_processname, LOG_CONS, syslog_facility);
164 /* First do a scan through the message in order to determine how many lines
165 it is going to end up as. Then rescan to output it. */
167 for (pass = 0; pass < 2; pass++)
172 for (i = 1, tlen = len; tlen > 0; i++)
175 uschar *nlptr = Ustrchr(ss, '\n');
176 if (nlptr != NULL) plen = nlptr - ss;
177 #ifndef SYSLOG_LONG_LINES
178 if (plen > MAX_SYSLOG_LEN) plen = MAX_SYSLOG_LEN;
181 if (ss[plen] == '\n') tlen--; /* chars left */
183 if (pass == 0) linecount++; else
186 syslog(priority, "%.*s", plen, ss);
188 syslog(priority, "[%d%c%d] %.*s", i,
189 (ss[plen] == '\n' && tlen != 0)? '\\' : '/',
190 linecount, plen, ss);
193 if (*ss == '\n') ss++;
200 /*************************************************
202 *************************************************/
204 /* This is called when Exim is dying as a result of something going wrong in
205 the logging, or after a log call with LOG_PANIC_DIE set. Optionally write a
206 message to debug_file or a stderr file, if they exist. Then, if in the middle
207 of accepting a message, throw it away tidily by calling receive_bomb_out();
208 this will attempt to send an SMTP response if appropriate. Passing NULL as the
209 first argument stops it trying to run the NOTQUIT ACL (which might try further
210 logging and thus cause problems). Otherwise, try to close down an outstanding
214 s1 Error message to write to debug_file and/or stderr and syslog
215 s2 Error message for any SMTP call that is in progress
216 Returns: The function does not return
220 die(uschar *s1, uschar *s2)
224 write_syslog(LOG_CRIT, s1);
225 if (debug_file != NULL) debug_printf("%s\n", s1);
226 if (log_stderr != NULL && log_stderr != debug_file)
227 fprintf(log_stderr, "%s\n", s1);
229 if (receive_call_bombout) receive_bomb_out(NULL, s2); /* does not return */
230 if (smtp_input) smtp_closedown(s2);
231 exim_exit(EXIT_FAILURE);
236 /*************************************************
237 * Create a log file *
238 *************************************************/
240 /* This function is called to create and open a log file. It may be called in a
241 subprocess when the original process is root.
246 The file name has been build in a working buffer, so it is permissible to
247 overwrite it temporarily if it is necessary to create the directory.
249 Returns: a file descriptor, or < 0 on failure (errno set)
253 log_create(uschar *name)
259 O_CREAT|O_APPEND|O_WRONLY, LOG_MODE);
261 /* If creation failed, attempt to build a log directory in case that is the
264 if (fd < 0 && errno == ENOENT)
267 uschar *lastslash = Ustrrchr(name, '/');
269 created = directory_make(NULL, name, LOG_DIRECTORY_MODE, FALSE);
270 DEBUG(D_any) debug_printf("%s log directory %s\n",
271 created? "created" : "failed to create", name);
273 if (created) fd = Uopen(name,
277 O_CREAT|O_APPEND|O_WRONLY, LOG_MODE);
285 /*************************************************
286 * Create a log file as the exim user *
287 *************************************************/
289 /* This function is called when we are root to spawn an exim:exim subprocess
290 in which we can create a log file. It must be signal-safe since it is called
291 by the usr1_handler().
296 Returns: a file descriptor, or < 0 on failure (errno set)
300 log_create_as_exim(uschar *name)
306 /* In the subprocess, change uid/gid and do the creation. Return 0 from the
307 subprocess on success. If we don't check for setuid failures, then the file
308 can be created as root, so vulnerabilities which cause setuid to fail mean
309 that the Exim user can use symlinks to cause a file to be opened/created as
310 root. We always open for append, so can't nuke existing content but it would
311 still be Rather Bad. */
315 if (setgid(exim_gid) < 0)
316 die(US"exim: setgid for log-file creation failed, aborting",
317 US"Unexpected log failure, please try later");
318 if (setuid(exim_uid) < 0)
319 die(US"exim: setuid for log-file creation failed, aborting",
320 US"Unexpected log failure, please try later");
321 _exit((log_create(name) < 0)? 1 : 0);
324 /* If we created a subprocess, wait for it. If it succeeded, try the open. */
326 while (pid > 0 && waitpid(pid, &status, 0) != pid);
327 if (status == 0) fd = Uopen(name,
331 O_APPEND|O_WRONLY, LOG_MODE);
333 /* If we failed to create a subprocess, we are in a bad way. We return
334 with fd still < 0, and errno set, letting the caller handle the error. */
342 /*************************************************
344 *************************************************/
346 /* This function opens one of a number of logs, creating the log directory if
347 it does not exist. This may be called recursively on failure, in order to open
350 The directory is in the static variable file_path. This is static so that it
351 the work of sorting out the path is done just once per Exim process.
353 Exim is normally configured to avoid running as root wherever possible, the log
354 files must be owned by the non-privileged exim user. To ensure this, first try
355 an open without O_CREAT - most of the time this will succeed. If it fails, try
356 to create the file; if running as root, this must be done in a subprocess to
360 fd where to return the resulting file descriptor
361 type lt_main, lt_reject, lt_panic, or lt_debug
362 tag optional tag to include in the name (only hooked up for debug)
368 open_log(int *fd, int type, uschar *tag)
372 uschar buffer[LOG_NAME_SIZE];
374 /* The names of the log files are controlled by file_path. The panic log is
375 written to the same directory as the main and reject logs, but its name does
376 not have a datestamp. The use of datestamps is indicated by %D/%M in file_path.
377 When opening the panic log, if %D or %M is present, we remove the datestamp
378 from the generated name; if it is at the start, remove a following
379 non-alphanumeric character as well; otherwise, remove a preceding
380 non-alphanumeric character. This is definitely kludgy, but it sort of does what
381 people want, I hope. */
383 ok = string_format(buffer, sizeof(buffer), CS file_path, log_names[type]);
385 /* Save the name of the mainlog for rollover processing. Without a datestamp,
386 it gets statted to see if it has been cycled. With a datestamp, the datestamp
387 will be compared. The static slot for saving it is the same size as buffer,
388 and the text has been checked above to fit, so this use of strcpy() is OK. */
392 Ustrcpy(mainlog_name, buffer);
393 mainlog_datestamp = mainlog_name + string_datestamp_offset;
396 /* Ditto for the reject log */
398 else if (type == lt_reject)
400 Ustrcpy(rejectlog_name, buffer);
401 rejectlog_datestamp = rejectlog_name + string_datestamp_offset;
404 /* and deal with the debug log (which keeps the datestamp, but does not
407 else if (type == lt_debug)
409 Ustrcpy(debuglog_name, buffer);
412 /* this won't change the offset of the datestamp */
413 ok2 = string_format(buffer, sizeof(buffer), "%s%s",
416 Ustrcpy(debuglog_name, buffer);
420 /* Remove any datestamp if this is the panic log. This is rare, so there's no
421 need to optimize getting the datestamp length. We remove one non-alphanumeric
422 char afterwards if at the start, otherwise one before. */
424 else if (string_datestamp_offset >= 0)
426 uschar *from = buffer + string_datestamp_offset;
427 uschar *to = from + string_datestamp_length;
428 if (from == buffer || from[-1] == '/')
430 if (!isalnum(*to)) to++;
434 if (!isalnum(from[-1])) from--;
437 /* This strcpy is ok, because we know that to is a substring of from. */
442 /* If the file name is too long, it is an unrecoverable disaster */
446 die(US"exim: log file path too long: aborting",
447 US"Logging failure; please try later");
450 /* We now have the file name. Try to open an existing file. After a successful
451 open, arrange for automatic closure on exec(), and then return. */
457 O_APPEND|O_WRONLY, LOG_MODE);
462 (void)fcntl(*fd, F_SETFD, fcntl(*fd, F_GETFD) | FD_CLOEXEC);
467 /* Open was not successful: try creating the file. If this is a root process,
468 we must do the creating in a subprocess set to exim:exim in order to ensure
469 that the file is created with the right ownership. Otherwise, there can be a
470 race if another Exim process is trying to write to the log at the same time.
471 The use of SIGUSR1 by the exiwhat utility can provoke a lot of simultaneous
476 /* If we are already running as the Exim user (even if that user is root),
477 we can go ahead and create in the current process. */
479 if (euid == exim_uid) *fd = log_create(buffer);
481 /* Otherwise, if we are root, do the creation in an exim:exim subprocess. If we
482 are neither exim nor root, creation is not attempted. */
484 else if (euid == root_uid) *fd = log_create_as_exim(buffer);
486 /* If we now have an open file, set the close-on-exec flag and return. */
491 (void)fcntl(*fd, F_SETFD, fcntl(*fd, F_GETFD) | FD_CLOEXEC);
496 /* Creation failed. There are some circumstances in which we get here when
497 the effective uid is not root or exim, which is the problem. (For example, a
498 non-setuid binary with log_arguments set, called in certain ways.) Rather than
499 just bombing out, force the log to stderr and carry on if stderr is available.
502 if (euid != root_uid && euid != exim_uid && log_stderr != NULL)
504 *fd = fileno(log_stderr);
508 /* Otherwise this is a disaster. This call is deliberately ONLY to the panic
509 log. If possible, save a copy of the original line that was being logged. If we
510 are recursing (can't open the panic log either), the pointer will already be
513 if (!panic_save_buffer)
514 if ((panic_save_buffer = US malloc(LOG_BUFFER_SIZE)))
515 memcpy(panic_save_buffer, log_buffer, LOG_BUFFER_SIZE);
517 log_write(0, LOG_PANIC_DIE, "Cannot open %s log file \"%s\": %s: "
518 "euid=%d egid=%d", log_names[type], buffer, strerror(errno), euid, getegid());
526 if (type == lt_debug) unlink(CS debuglog_name);
531 /*************************************************
532 * Add configuration file info to log line *
533 *************************************************/
535 /* This is put in a function because it's needed twice (once for debugging,
539 ptr pointer to the end of the line we are building
542 Returns: updated pointer
546 log_config_info(uschar *ptr, int flags)
548 Ustrcpy(ptr, "Exim configuration error");
551 if ((flags & (LOG_CONFIG_FOR & ~LOG_CONFIG)) != 0)
553 Ustrcpy(ptr, " for ");
557 if ((flags & (LOG_CONFIG_IN & ~LOG_CONFIG)) != 0)
559 sprintf(CS ptr, " in line %d of %s", config_lineno, config_filename);
563 Ustrcpy(ptr, ":\n ");
568 /*************************************************
569 * A write() operation failed *
570 *************************************************/
572 /* This function is called when write() fails on anything other than the panic
573 log, which can happen if a disk gets full or a file gets too large or whatever.
574 We try to save the relevant message in the panic_save buffer before crashing
577 The potential invoker should probably not call us for EINTR -1 writes. But
578 otherwise, short writes are bad as we don't do non-blocking writes to fds
579 subject to flow control. (If we do, that's new and the logic of this should
583 name the name of the log being written
584 length the string length being written
585 rc the return value from write()
587 Returns: does not return
591 log_write_failed(uschar *name, int length, int rc)
593 int save_errno = errno;
595 if (!panic_save_buffer)
596 if ((panic_save_buffer = US malloc(LOG_BUFFER_SIZE)))
597 memcpy(panic_save_buffer, log_buffer, LOG_BUFFER_SIZE);
599 log_write(0, LOG_PANIC_DIE, "failed to write to %s: length=%d result=%d "
600 "errno=%d (%s)", name, length, rc, save_errno,
601 (save_errno == 0)? "write incomplete" : strerror(save_errno));
607 /*************************************************
608 * Write to an fd, retrying after signals *
609 *************************************************/
611 /* Basic write to fd for logs, handling EINTR.
614 fd the fd to write to
615 buf the string to write
616 length the string length being written
619 length actually written, persisting an errno from write()
622 write_to_fd_buf(int fd, const uschar *buf, size_t length)
625 size_t total_written = 0;
626 const uschar *p = buf;
627 size_t left = length;
631 wrote = write(fd, p, left);
632 if (wrote == (ssize_t)-1)
634 if (errno == EINTR) continue;
637 total_written += wrote;
646 return total_written;
654 int sep = ':'; /* Fixed separator - outside use */
656 const uschar *tt = US LOG_FILE_PATH;
657 while ((t = string_nextinlist(&tt, &sep, log_buffer, LOG_BUFFER_SIZE)))
659 if (Ustrcmp(t, "syslog") == 0 || t[0] == 0) continue;
660 file_path = string_copy(t);
669 if (mainlogfd < 0) return;
670 (void)close(mainlogfd);
675 /*************************************************
676 * Write message to log file *
677 *************************************************/
679 /* Exim can be configured to log to local files, or use syslog, or both. This
680 is controlled by the setting of log_file_path. The following cases are
683 log_file_path = "" write files in the spool/log directory
684 log_file_path = "xxx" write files in the xxx directory
685 log_file_path = "syslog" write to syslog
686 log_file_path = "syslog : xxx" write to syslog and to files (any order)
688 The message always gets '\n' added on the end of it, since more than one
689 process may be writing to the log at once and we don't want intermingling to
690 happen in the middle of lines. To be absolutely sure of this we write the data
691 into a private buffer and then put it out in a single write() call.
693 The flags determine which log(s) the message is written to, or for syslogging,
694 which priority to use, and in the case of the panic log, whether the process
695 should die afterwards.
697 The variable really_exim is TRUE only when exim is running in privileged state
698 (i.e. not with a changed configuration or with testing options such as -brw).
699 If it is not, don't try to write to the log because permission will probably be
702 Avoid actually writing to the logs when exim is called with -bv or -bt to
703 test an address, but take other actions, such as panicing.
705 In Exim proper, the buffer for building the message is got at start-up, so that
706 nothing gets done if it can't be got. However, some functions that are also
707 used in utilities occasionally obey log_write calls in error situations, and it
708 is simplest to put a single malloc() here rather than put one in each utility.
709 Malloc is used directly because the store functions may call log_write().
711 If a message_id exists, we include it after the timestamp.
714 selector write to main log or LOG_INFO only if this value is zero, or if
715 its bit is set in log_selector[0]
716 flags each bit indicates some independent action:
717 LOG_SENDER add raw sender to the message
718 LOG_RECIPIENTS add raw recipients list to message
719 LOG_CONFIG add "Exim configuration error"
720 LOG_CONFIG_FOR add " for " instead of ":\n "
721 LOG_CONFIG_IN add " in line x[ of file y]"
722 LOG_MAIN write to main log or syslog LOG_INFO
723 LOG_REJECT write to reject log or syslog LOG_NOTICE
724 LOG_PANIC write to panic log or syslog LOG_ALERT
725 LOG_PANIC_DIE write to panic log or LOG_ALERT and then crash
726 format a printf() format
727 ... arguments for format
733 log_write(unsigned int selector, int flags, const char *format, ...)
741 /* If panic_recurseflag is set, we have failed to open the panic log. This is
742 the ultimate disaster. First try to write the message to a debug file and/or
743 stderr and also to syslog. If panic_save_buffer is not NULL, it contains the
744 original log line that caused the problem. Afterwards, expire. */
746 if (panic_recurseflag)
748 uschar *extra = (panic_save_buffer == NULL)? US"" : panic_save_buffer;
749 if (debug_file != NULL) debug_printf("%s%s", extra, log_buffer);
750 if (log_stderr != NULL && log_stderr != debug_file)
751 fprintf(log_stderr, "%s%s", extra, log_buffer);
752 if (*extra != 0) write_syslog(LOG_CRIT, extra);
753 write_syslog(LOG_CRIT, log_buffer);
754 die(US"exim: could not open panic log - aborting: see message(s) above",
755 US"Unexpected log failure, please try later");
758 /* Ensure we have a buffer (see comment above); this should never be obeyed
759 when running Exim proper, only when running utilities. */
762 if (!(log_buffer = US malloc(LOG_BUFFER_SIZE)))
764 fprintf(stderr, "exim: failed to get store for log buffer\n");
765 exim_exit(EXIT_FAILURE);
768 /* If we haven't already done so, inspect the setting of log_file_path to
769 determine whether to log to files and/or to syslog. Bits in logging_mode
770 control this, and for file logging, the path must end up in file_path. This
771 variable must be in permanent store because it may be required again later in
776 BOOL multiple = FALSE;
777 int old_pool = store_pool;
779 store_pool = POOL_PERM;
781 /* If nothing has been set, don't waste effort... the default values for the
782 statics are file_path="" and logging_mode = LOG_MODE_FILE. */
786 int sep = ':'; /* Fixed separator - outside use */
788 const uschar *ss = log_file_path;
790 while ((s = string_nextinlist(&ss, &sep, log_buffer, LOG_BUFFER_SIZE)))
792 if (Ustrcmp(s, "syslog") == 0)
793 logging_mode |= LOG_MODE_SYSLOG;
794 else if ((logging_mode & LOG_MODE_FILE) != 0) multiple = TRUE;
797 logging_mode |= LOG_MODE_FILE;
799 /* If a non-empty path is given, use it */
802 file_path = string_copy(s);
804 /* If the path is empty, we want to use the first non-empty, non-
805 syslog item in LOG_FILE_PATH, if there is one, since the value of
806 log_file_path may have been set at runtime. If there is no such item,
807 use the ultimate default in the spool directory. */
810 set_file_path(); /* Empty item in log_file_path */
811 } /* First non-syslog item in log_file_path */
812 } /* Scan of log_file_path */
815 /* If no modes have been selected, it is a major disaster */
817 if (logging_mode == 0)
818 die(US"Neither syslog nor file logging set in log_file_path",
819 US"Unexpected logging failure");
821 /* Set up the ultimate default if necessary. Then revert to the old store
822 pool, and record that we've sorted out the path. */
824 if ((logging_mode & LOG_MODE_FILE) != 0 && file_path[0] == 0)
825 file_path = string_sprintf("%s/log/%%slog", spool_directory);
826 store_pool = old_pool;
827 path_inspected = TRUE;
829 /* If more than one file path was given, log a complaint. This recursive call
830 should work since we have now set up the routing. */
833 log_write(0, LOG_MAIN|LOG_PANIC,
834 "More than one path given in log_file_path: using %s", file_path);
837 /* If debugging, show all log entries, but don't show headers. Do it all
838 in one go so that it doesn't get split when multi-processing. */
845 Ustrcpy(ptr, "LOG:");
848 /* Show the selector that was passed into the call. */
850 for (i = 0; i < log_options_count; i++)
852 unsigned int bitnum = log_options[i].bit;
853 if (bitnum < BITWORDSIZE && selector == BIT(bitnum))
856 Ustrcpy(ptr, log_options[i].name);
861 sprintf(CS ptr, "%s%s%s%s\n ",
862 ((flags & LOG_MAIN) != 0)? " MAIN" : "",
863 ((flags & LOG_PANIC) != 0)? " PANIC" : "",
864 ((flags & LOG_PANIC_DIE) == LOG_PANIC_DIE)? " DIE" : "",
865 ((flags & LOG_REJECT) != 0)? " REJECT" : "");
868 if ((flags & LOG_CONFIG) != 0) ptr = log_config_info(ptr, flags);
870 va_start(ap, format);
871 if (!string_vformat(ptr, LOG_BUFFER_SIZE - (ptr-log_buffer)-1, format, ap))
872 Ustrcpy(ptr, "**** log string overflowed log buffer ****");
877 debug_printf("%s", log_buffer);
880 /* If no log file is specified, we are in a mess. */
882 if ((flags & (LOG_MAIN|LOG_PANIC|LOG_REJECT)) == 0)
883 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "log_write called with no log "
886 /* There are some weird circumstances in which logging is disabled. */
890 DEBUG(D_any) debug_printf("log writing disabled\n");
894 /* Handle disabled reject log */
896 if (!write_rejectlog) flags &= ~LOG_REJECT;
898 /* Create the main message in the log buffer. Do not include the message id
899 when called by a utility. */
902 sprintf(CS ptr, "%s ", tod_stamp(tod_log));
907 sprintf(CS ptr, "[%d] ", (int)getpid());
911 if (really_exim && message_id[0] != 0)
913 sprintf(CS ptr, "%s ", message_id);
917 if ((flags & LOG_CONFIG) != 0) ptr = log_config_info(ptr, flags);
919 va_start(ap, format);
920 if (!string_vformat(ptr, LOG_BUFFER_SIZE - (ptr-log_buffer)-1, format, ap))
921 Ustrcpy(ptr, "**** log string overflowed log buffer ****\n");
925 /* Add the raw, unrewritten, sender to the message if required. This is done
926 this way because it kind of fits with LOG_RECIPIENTS. */
928 if ((flags & LOG_SENDER) != 0 &&
929 ptr < log_buffer + LOG_BUFFER_SIZE - 10 - Ustrlen(raw_sender))
931 sprintf(CS ptr, " from <%s>", raw_sender);
935 /* Add list of recipients to the message if required; the raw list,
936 before rewriting, was saved in raw_recipients. There may be none, if an ACL
937 discarded them all. */
939 if ((flags & LOG_RECIPIENTS) != 0 && ptr < log_buffer + LOG_BUFFER_SIZE - 6 &&
940 raw_recipients_count > 0)
943 sprintf(CS ptr, " for");
945 for (i = 0; i < raw_recipients_count; i++)
947 uschar *s = raw_recipients[i];
948 if (log_buffer + LOG_BUFFER_SIZE - ptr < Ustrlen(s) + 3) break;
949 sprintf(CS ptr, " %s", s);
954 sprintf(CS ptr, "\n");
956 length = ptr - log_buffer;
958 /* Handle loggable errors when running a utility, or when address testing.
959 Write to log_stderr unless debugging (when it will already have been written),
960 or unless there is no log_stderr (expn called from daemon, for example). */
962 if (!really_exim || log_testing_mode)
964 if (debug_selector == 0 && log_stderr != NULL &&
965 (selector == 0 || (selector & log_selector[0]) != 0))
968 fprintf(log_stderr, "LOG: %s", CS(log_buffer + 20)); /* no timestamp */
970 fprintf(log_stderr, "%s", CS log_buffer);
972 if ((flags & LOG_PANIC_DIE) == LOG_PANIC_DIE) exim_exit(EXIT_FAILURE);
976 /* Handle the main log. We know that either syslog or file logging (or both) is
977 set up. A real file gets left open during reception or delivery once it has
978 been opened, but we don't want to keep on writing to it for too long after it
979 has been renamed. Therefore, do a stat() and see if the inode has changed, and
982 if ( flags & LOG_MAIN
983 && (!selector || selector & log_selector[0]))
985 if ( logging_mode & LOG_MODE_SYSLOG
986 && (syslog_duplication || !(flags & (LOG_REJECT|LOG_PANIC))))
987 write_syslog(LOG_INFO, log_buffer);
989 if (logging_mode & LOG_MODE_FILE)
993 /* Check for a change to the mainlog file name when datestamping is in
994 operation. This happens at midnight, at which point we want to roll over
995 the file. Closing it has the desired effect. */
997 if (mainlog_datestamp != NULL)
999 uschar *nowstamp = tod_stamp(string_datestamp_type);
1000 if (Ustrncmp (mainlog_datestamp, nowstamp, Ustrlen(nowstamp)) != 0)
1002 (void)close(mainlogfd); /* Close the file */
1003 mainlogfd = -1; /* Clear the file descriptor */
1004 mainlog_inode = 0; /* Unset the inode */
1005 mainlog_datestamp = NULL; /* Clear the datestamp */
1009 /* Otherwise, we want to check whether the file has been renamed by a
1010 cycling script. This could be "if else", but for safety's sake, leave it as
1011 "if" so that renaming the log starts a new file even when datestamping is
1015 if (Ustat(mainlog_name, &statbuf) < 0 || statbuf.st_ino != mainlog_inode)
1018 /* If the log is closed, open it. Then write the line. */
1022 open_log(&mainlogfd, lt_main, NULL); /* No return on error */
1023 if (fstat(mainlogfd, &statbuf) >= 0) mainlog_inode = statbuf.st_ino;
1026 /* Failing to write to the log is disastrous */
1028 written_len = write_to_fd_buf(mainlogfd, log_buffer, length);
1029 if (written_len != length)
1031 log_write_failed(US"main log", length, written_len);
1032 /* That function does not return */
1037 /* Handle the log for rejected messages. This can be globally disabled, in
1038 which case the flags are altered above. If there are any header lines (i.e. if
1039 the rejection is happening after the DATA phase), log the recipients and the
1042 if ((flags & LOG_REJECT) != 0)
1046 if (header_list != NULL && LOGGING(rejected_header))
1048 if (recipients_count > 0)
1052 /* List the sender */
1054 string_format(ptr, LOG_BUFFER_SIZE - (ptr-log_buffer),
1055 "Envelope-from: <%s>\n", sender_address);
1058 /* List up to 5 recipients */
1060 string_format(ptr, LOG_BUFFER_SIZE - (ptr-log_buffer),
1061 "Envelope-to: <%s>\n", recipients_list[0].address);
1064 for (i = 1; i < recipients_count && i < 5; i++)
1066 string_format(ptr, LOG_BUFFER_SIZE - (ptr-log_buffer), " <%s>\n",
1067 recipients_list[i].address);
1071 if (i < recipients_count)
1073 (void)string_format(ptr, LOG_BUFFER_SIZE - (ptr-log_buffer),
1079 /* A header with a NULL text is an unfilled in Received: header */
1081 for (h = header_list; h != NULL; h = h->next)
1084 if (h->text == NULL) continue;
1085 fitted = string_format(ptr, LOG_BUFFER_SIZE - (ptr-log_buffer),
1086 "%c %s", h->type, h->text);
1088 if (!fitted) /* Buffer is full; truncate */
1090 ptr -= 100; /* For message and separator */
1091 if (ptr[-1] == '\n') ptr--;
1092 Ustrcpy(ptr, "\n*** truncated ***\n");
1098 length = ptr - log_buffer;
1101 /* Write to syslog or to a log file */
1103 if ((logging_mode & LOG_MODE_SYSLOG) != 0 &&
1104 (syslog_duplication || (flags & LOG_PANIC) == 0))
1105 write_syslog(LOG_NOTICE, log_buffer);
1107 /* Check for a change to the rejectlog file name when datestamping is in
1108 operation. This happens at midnight, at which point we want to roll over
1109 the file. Closing it has the desired effect. */
1111 if ((logging_mode & LOG_MODE_FILE) != 0)
1113 struct stat statbuf;
1115 if (rejectlog_datestamp != NULL)
1117 uschar *nowstamp = tod_stamp(string_datestamp_type);
1118 if (Ustrncmp (rejectlog_datestamp, nowstamp, Ustrlen(nowstamp)) != 0)
1120 (void)close(rejectlogfd); /* Close the file */
1121 rejectlogfd = -1; /* Clear the file descriptor */
1122 rejectlog_inode = 0; /* Unset the inode */
1123 rejectlog_datestamp = NULL; /* Clear the datestamp */
1127 /* Otherwise, we want to check whether the file has been renamed by a
1128 cycling script. This could be "if else", but for safety's sake, leave it as
1129 "if" so that renaming the log starts a new file even when datestamping is
1132 if (rejectlogfd >= 0)
1134 if (Ustat(rejectlog_name, &statbuf) < 0 ||
1135 statbuf.st_ino != rejectlog_inode)
1137 (void)close(rejectlogfd);
1139 rejectlog_inode = 0;
1143 /* Open the file if necessary, and write the data */
1145 if (rejectlogfd < 0)
1147 open_log(&rejectlogfd, lt_reject, NULL); /* No return on error */
1148 if (fstat(rejectlogfd, &statbuf) >= 0) rejectlog_inode = statbuf.st_ino;
1151 written_len = write_to_fd_buf(rejectlogfd, log_buffer, length);
1152 if (written_len != length)
1154 log_write_failed(US"reject log", length, written_len);
1155 /* That function does not return */
1161 /* Handle the panic log, which is not kept open like the others. If it fails to
1162 open, there will be a recursive call to log_write(). We detect this above and
1163 attempt to write to the system log as a last-ditch try at telling somebody. In
1164 all cases except mua_wrapper, try to write to log_stderr. */
1166 if ((flags & LOG_PANIC) != 0)
1168 if (log_stderr != NULL && log_stderr != debug_file && !mua_wrapper)
1169 fprintf(log_stderr, "%s", CS log_buffer);
1171 if ((logging_mode & LOG_MODE_SYSLOG) != 0)
1173 write_syslog(LOG_ALERT, log_buffer);
1176 /* If this panic logging was caused by a failure to open the main log,
1177 the original log line is in panic_save_buffer. Make an attempt to write it. */
1179 if ((logging_mode & LOG_MODE_FILE) != 0)
1181 panic_recurseflag = TRUE;
1182 open_log(&paniclogfd, lt_panic, NULL); /* Won't return on failure */
1183 panic_recurseflag = FALSE;
1185 if (panic_save_buffer != NULL)
1187 int i = write(paniclogfd, panic_save_buffer, Ustrlen(panic_save_buffer));
1188 i = i; /* compiler quietening */
1191 written_len = write_to_fd_buf(paniclogfd, log_buffer, length);
1192 if (written_len != length)
1194 int save_errno = errno;
1195 write_syslog(LOG_CRIT, log_buffer);
1196 sprintf(CS log_buffer, "write failed on panic log: length=%d result=%d "
1197 "errno=%d (%s)", length, (int)written_len, save_errno, strerror(save_errno));
1198 write_syslog(LOG_CRIT, log_buffer);
1199 flags |= LOG_PANIC_DIE;
1202 (void)close(paniclogfd);
1205 /* Give up if the DIE flag is set */
1207 if ((flags & LOG_PANIC_DIE) != LOG_PANIC)
1208 die(NULL, US"Unexpected failure, please try later");
1214 /*************************************************
1215 * Close any open log files *
1216 *************************************************/
1222 { (void)close(mainlogfd); mainlogfd = -1; }
1223 if (rejectlogfd >= 0)
1224 { (void)close(rejectlogfd); rejectlogfd = -1; }
1226 syslog_open = FALSE;
1231 /*************************************************
1232 * Multi-bit set or clear *
1233 *************************************************/
1235 /* These functions take a list of bit indexes (terminated by -1) and
1236 clear or set the corresponding bits in the selector.
1239 selector address of the bit string
1240 selsize number of words in the bit string
1241 bits list of bits to set
1245 bits_clear(unsigned int *selector, size_t selsize, int *bits)
1247 for(; *bits != -1; ++bits)
1248 BIT_CLEAR(selector, selsize, *bits);
1252 bits_set(unsigned int *selector, size_t selsize, int *bits)
1254 for(; *bits != -1; ++bits)
1255 BIT_SET(selector, selsize, *bits);
1260 /*************************************************
1261 * Decode bit settings for log/debug *
1262 *************************************************/
1264 /* This function decodes a string containing bit settings in the form of +name
1265 and/or -name sequences, and sets/unsets bits in a bit string accordingly. It
1266 also recognizes a numeric setting of the form =<number>, but this is not
1267 intended for user use. It's an easy way for Exim to pass the debug settings
1268 when it is re-exec'ed.
1270 The option table is a list of names and bit indexes. The index -1
1271 means "set all bits, except for those listed in notall". The notall
1272 list is terminated by -1.
1274 The action taken for bad values varies depending upon why we're here.
1275 For log messages, or if the debugging is triggered from config, then we write
1276 to the log on the way out. For debug setting triggered from the command-line,
1277 we treat it as an unknown option: error message to stderr and die.
1280 selector address of the bit string
1281 selsize number of words in the bit string
1282 notall list of bits to exclude from "all"
1283 string the configured string
1284 options the table of option names
1286 which "log" or "debug"
1287 flags DEBUG_FROM_CONFIG
1289 Returns: nothing on success - bomb out on failure
1293 decode_bits(unsigned int *selector, size_t selsize, int *notall,
1294 uschar *string, bit_table *options, int count, uschar *which, int flags)
1297 if (string == NULL) return;
1301 char *end; /* Not uschar */
1302 memset(selector, 0, sizeof(*selector)*selsize);
1303 *selector = strtoul(CS string+1, &end, 0);
1304 if (*end == 0) return;
1305 errmsg = string_sprintf("malformed numeric %s_selector setting: %s", which,
1310 /* Handle symbolic setting */
1317 bit_table *start, *end;
1319 while (isspace(*string)) string++;
1320 if (*string == 0) return;
1322 if (*string != '+' && *string != '-')
1324 errmsg = string_sprintf("malformed %s_selector setting: "
1325 "+ or - expected but found \"%s\"", which, string);
1329 adding = *string++ == '+';
1331 while (isalnum(*string) || *string == '_') string++;
1335 end = options + count;
1339 bit_table *middle = start + (end - start)/2;
1340 int c = Ustrncmp(s, middle->name, len);
1343 if (middle->name[len] != 0) c = -1; else
1345 unsigned int bit = middle->bit;
1351 memset(selector, -1, sizeof(*selector)*selsize);
1352 bits_clear(selector, selsize, notall);
1355 memset(selector, 0, sizeof(*selector)*selsize);
1358 BIT_SET(selector, selsize, bit);
1360 BIT_CLEAR(selector, selsize, bit);
1362 break; /* Out of loop to match selector name */
1365 if (c < 0) end = middle; else start = middle + 1;
1366 } /* Loop to match selector name */
1370 errmsg = string_sprintf("unknown %s_selector setting: %c%.*s", which,
1371 adding? '+' : '-', len, s);
1374 } /* Loop for selector names */
1376 /* Handle disasters */
1379 if (Ustrcmp(which, "debug") == 0)
1381 if (flags & DEBUG_FROM_CONFIG)
1383 log_write(0, LOG_CONFIG|LOG_PANIC, "%s", errmsg);
1386 fprintf(stderr, "exim: %s\n", errmsg);
1389 else log_write(0, LOG_CONFIG|LOG_PANIC_DIE, "%s", errmsg);
1394 /*************************************************
1395 * Activate a debug logfile (late) *
1396 *************************************************/
1398 /* Normally, debugging is activated from the command-line; it may be useful
1399 within the configuration to activate debugging later, based on certain
1400 conditions. If debugging is already in progress, we return early, no action
1401 taken (besides debug-logging that we wanted debug-logging).
1403 Failures in options are not fatal but will result in paniclog entries for the
1406 The first use of this is in ACL logic, "control = debug/tag=foo/opts=+expand"
1407 which can be combined with conditions, etc, to activate extra logging only
1408 for certain sources. The second use is inetd wait mode debug preservation. */
1411 debug_logging_activate(uschar *tag_name, uschar *opts)
1417 debug_printf("DEBUGGING ACTIVATED FROM WITHIN CONFIG.\n"
1418 "DEBUG: Tag=\"%s\" opts=\"%s\"\n", tag_name, opts ? opts : US"");
1422 if (tag_name != NULL && (Ustrchr(tag_name, '/') != NULL))
1424 log_write(0, LOG_MAIN|LOG_PANIC, "debug tag may not contain a '/' in: %s",
1429 debug_selector = D_default;
1431 decode_bits(&debug_selector, 1, debug_notall, opts,
1432 debug_options, debug_options_count, US"debug", DEBUG_FROM_CONFIG);
1434 /* When activating from a transport process we may never have logged at all
1435 resulting in certain setup not having been done. Hack this for now so we
1436 do not segfault; note that nondefault log locations will not work */
1438 if (!*file_path) set_file_path();
1440 open_log(&fd, lt_debug, tag_name);
1443 debug_file = fdopen(fd, "w");
1445 log_write(0, LOG_MAIN|LOG_PANIC, "unable to open debug log");
1450 debug_logging_stop(void)
1452 if (!debug_file || !debuglog_name[0]) return;
1457 unlink_log(lt_debug);