1 /*-------------------------------------------------------------------------
6 * Portions Copyright (c) 1996-2002, PostgreSQL Global Development Group
7 * Portions Copyright (c) 1994, Regents of the University of California
11 * $Header: /cvsroot/pgsql/src/backend/utils/error/elog.c,v 1.101 2002/09/02 02:47:05 momjian Exp $
13 *-------------------------------------------------------------------------
28 #include "commands/copy.h"
29 #include "libpq/libpq.h"
30 #include "libpq/pqformat.h"
31 #include "miscadmin.h"
32 #include "storage/ipc.h"
33 #include "storage/proc.h"
34 #include "tcop/tcopprot.h"
35 #include "utils/memutils.h"
37 #include "mb/pg_wchar.h"
39 int server_min_messages;
40 char *server_min_messages_str = NULL;
41 const char server_min_messages_str_default[] = "notice";
43 int client_min_messages;
44 char *client_min_messages_str = NULL;
45 const char client_min_messages_str_default[] = "notice";
49 * 0 = only stdout/stderr
50 * 1 = stdout+stderr and syslog
52 * ... in theory anyway
55 char *Syslog_facility;
58 static void write_syslog(int level, const char *line);
67 #define TIMESTAMP_SIZE 20 /* format `YYYY-MM-DD HH:MM:SS ' */
68 #define PID_SIZE 9 /* format `[123456] ' */
70 static const char *print_timestamp(void);
71 static const char *print_pid(void);
72 static void send_message_to_frontend(int type, const char *msg);
73 static const char *useful_strerror(int errnum);
74 static const char *elog_message_prefix(int lev);
76 static int Debugfile = -1;
79 /*--------------------
81 * Primary error logging function.
83 * 'lev': error level; indicates recovery action to take, if any.
84 * 'fmt': a printf-style string.
85 * Additional arguments, if any, are formatted per %-escapes in 'fmt'.
87 * In addition to the usual %-escapes recognized by printf, "%m" in
88 * fmt is replaced by the error message for the current value of errno.
90 * Note: no newline is needed at the end of the fmt string, since
91 * elog will provide one for the output methods that need it.
93 * If 'lev' is ERROR or worse, control does not return to the caller.
94 * See elog.h for the error level definitions.
98 elog(int lev, const char *fmt,...)
102 * The expanded format and final output message are dynamically
103 * allocated if necessary, but not if they fit in the "reasonable
104 * size" buffers shown here. In extremis, we'd rather depend on
105 * having a few hundred bytes of stack space than on malloc() still
106 * working (since memory-clobber errors often take out malloc first).
107 * Don't make these buffers unreasonably large though, on pain of
108 * having to chase a bug with no error message.
110 * Note that we use malloc() not palloc() because we want to retain
111 * control if we run out of memory. palloc() would recursively call
112 * elog(ERROR), which would be all right except if we are working on a
113 * FATAL or PANIC error. We'd lose track of the fatal condition
114 * and report a mere ERROR to outer loop, which would be a Bad Thing.
115 * So, we substitute an appropriate message in-place, without
116 * downgrading the level if it's above ERROR.
118 char fmt_fixedbuf[128];
119 char msg_fixedbuf[256];
120 char *fmt_buf = fmt_fixedbuf;
121 char *msg_buf = msg_fixedbuf;
122 char copylineno_buf[32]; /* for COPY line numbers */
123 const char *errorstr;
128 size_t timestamp_size; /* prefix len for timestamp+pid */
129 bool output_to_server = false;
130 bool output_to_client = false;
132 /* Check for old elog calls. Codes were renumbered in 7.3. 2002-02-24 */
134 elog(FATAL, "Pre-7.3 object file made an elog() call. Recompile.");
137 * Convert initialization errors into fatal errors. This is probably
138 * redundant, because Warn_restart_ready won't be set anyway.
140 if (lev == ERROR && IsInitProcessingMode())
144 * If we are inside a critical section, all errors become PANIC
145 * errors. See miscadmin.h.
149 if (CritSectionCount > 0)
153 /* Determine whether message is enabled for server log output */
154 /* Complicated because LOG is sorted out-of-order for this purpose */
155 if (lev == LOG || lev == COMMERROR)
157 if (server_min_messages == LOG)
158 output_to_server = true;
159 else if (server_min_messages < FATAL)
160 output_to_server = true;
165 if (server_min_messages == LOG)
168 output_to_server = true;
171 else if (lev >= server_min_messages)
172 output_to_server = true;
175 /* Determine whether message is enabled for client output */
176 if (whereToSendOutput == Remote && lev != COMMERROR)
179 * client_min_messages is honored only after we complete the
180 * authentication handshake. This is required both for security
181 * reasons and because many clients can't handle NOTICE messages
182 * during authentication.
184 if (ClientAuthInProgress)
185 output_to_client = (lev >= ERROR);
187 output_to_client = (lev >= client_min_messages || lev == INFO);
190 /* Skip formatting effort if non-error message will not be output */
191 if (lev < ERROR && !output_to_server && !output_to_client)
194 /* Save error str before calling any function that might change errno */
195 errorstr = useful_strerror(errno);
197 /* Internationalize the error format string */
200 /* Begin formatting by determining prefix information */
201 prefix = elog_message_prefix(lev);
205 timestamp_size += TIMESTAMP_SIZE;
207 timestamp_size += PID_SIZE;
210 * Set up the expanded format, consisting of the prefix string plus
211 * input format, with any %m replaced by strerror() string (since
212 * vsnprintf won't know what to do with %m). To keep space
213 * calculation simple, we only allow one %m.
215 space_needed = timestamp_size + strlen(prefix) +
216 strlen(fmt) + strlen(errorstr) + 1;
221 * Prints the failure line of the COPY. Wow, what a hack! bjm
222 * Translator: Error message will be truncated at 31 characters.
224 snprintf(copylineno_buf, 32, gettext("copy: line %d, "), copy_lineno);
225 space_needed += strlen(copylineno_buf);
228 if (space_needed > sizeof(fmt_fixedbuf))
230 fmt_buf = malloc(space_needed);
233 /* We're up against it, convert to out-of-memory error */
234 fmt_buf = fmt_fixedbuf;
238 prefix = elog_message_prefix(lev);
242 * gettext doesn't allocate memory, except in the very first
243 * call (which this isn't), so it's safe to translate here.
244 * Worst case we get the untranslated string back.
246 /* translator: This must fit in fmt_fixedbuf. */
247 fmt = gettext("elog: out of memory");
254 strcat(fmt_buf, print_timestamp());
256 strcat(fmt_buf, print_pid());
258 strcat(fmt_buf, prefix);
260 /* If error was in CopyFrom() print the offending line number -- dz */
263 strcat(fmt_buf, copylineno_buf);
268 bp = fmt_buf + strlen(fmt_buf);
270 for (cp = fmt; *cp; cp++)
272 if (cp[0] == '%' && cp[1] != '\0')
277 * XXX If there are any %'s in errorstr then vsnprintf
278 * will do the Wrong Thing; do we need to cope? Seems
279 * unlikely that % would appear in system errors.
281 strcpy(bp, errorstr);
284 * copy the rest of fmt literally, since we can't afford
285 * to insert another %m.
293 /* copy % and next char --- this avoids trouble with %%m */
304 * Now generate the actual output text using vsnprintf(). Be sure to
305 * leave space for \n added later as well as trailing null.
307 space_needed = sizeof(msg_fixedbuf);
313 nprinted = vsnprintf(msg_buf, space_needed - 2, fmt_buf, ap);
317 * Note: some versions of vsnprintf return the number of chars
318 * actually stored, but at least one returns -1 on failure. Be
319 * conservative about believing whether the print worked.
321 if (nprinted >= 0 && nprinted < space_needed - 3)
323 /* It didn't work, try to get a bigger buffer */
324 if (msg_buf != msg_fixedbuf)
327 msg_buf = malloc(space_needed);
330 /* We're up against it, convert to out-of-memory error */
331 msg_buf = msg_fixedbuf;
335 prefix = elog_message_prefix(lev);
339 strcat(msg_buf, print_timestamp());
341 strcat(msg_buf, print_pid());
342 strcat(msg_buf, prefix);
343 strcat(msg_buf, gettext("elog: out of memory"));
349 * Message prepared; send it where it should go
353 /* Write to syslog, if enabled */
354 if (output_to_server && Use_syslog >= 1)
365 syslog_level = LOG_DEBUG;
370 syslog_level = LOG_INFO;
374 syslog_level = LOG_NOTICE;
377 syslog_level = LOG_WARNING;
380 syslog_level = LOG_ERR;
384 syslog_level = LOG_CRIT;
388 write_syslog(syslog_level, msg_buf + timestamp_size);
390 #endif /* HAVE_SYSLOG */
392 /* syslog doesn't want a trailing newline, but other destinations do */
393 strcat(msg_buf, "\n");
395 /* Write to stderr, if enabled */
396 if (output_to_server && (Use_syslog <= 1 || whereToSendOutput == Debug))
397 write(2, msg_buf, strlen(msg_buf));
399 /* Send to client, if enabled */
400 if (output_to_client)
402 /* Send IPC message to the front-end program */
403 MemoryContext oldcxt;
406 * Since backend libpq may call palloc(), switch to a context
407 * where there's fairly likely to be some free space. After all
408 * the pushups above, we don't want to drop the ball by running
409 * out of space now...
411 oldcxt = MemoryContextSwitchTo(ErrorContext);
414 /* exclude the timestamp from msg sent to frontend */
415 send_message_to_frontend(lev, msg_buf + timestamp_size);
419 * Abort any COPY OUT in progress when an error is detected.
420 * This hack is necessary because of poor design of copy
424 send_message_to_frontend(ERROR, msg_buf + timestamp_size);
427 MemoryContextSwitchTo(oldcxt);
430 /* done with the message, release space */
431 if (fmt_buf != fmt_fixedbuf)
433 if (msg_buf != msg_fixedbuf)
437 * Perform error recovery action as specified by lev.
439 if (lev == ERROR || lev == FATAL)
441 /* Prevent immediate interrupt while entering error recovery */
442 ImmediateInterruptOK = false;
445 * If we just reported a startup failure, the client will
446 * disconnect on receiving it, so don't send any more to the client.
448 if (!Warn_restart_ready && whereToSendOutput == Remote)
449 whereToSendOutput = None;
452 * For a FATAL error, we let proc_exit clean up and exit.
454 * If we have not yet entered the main backend loop (ie, we are in
455 * the postmaster or in backend startup), we also go directly to
456 * proc_exit. The same is true if anyone tries to report an error
457 * after proc_exit has begun to run. (It's proc_exit's
458 * responsibility to see that this doesn't turn into infinite
459 * recursion!) But in the latter case, we exit with nonzero exit
460 * code to indicate that something's pretty wrong. We also want
461 * to exit with nonzero exit code if not running under the
462 * postmaster (for example, if we are being run from the initdb
463 * script, we'd better return an error status).
465 if (lev == FATAL || !Warn_restart_ready || proc_exit_inprogress)
468 * fflush here is just to improve the odds that we get to see
469 * the error message, in case things are so hosed that
470 * proc_exit crashes. Any other code you might be tempted to
471 * add here should probably be in an on_proc_exit callback
476 proc_exit(proc_exit_inprogress || !IsUnderPostmaster);
480 * Guard against infinite loop from elog() during error recovery.
483 elog(PANIC, "elog: error during error recovery, giving up!");
487 * Otherwise we can return to the main loop in postgres.c.
489 siglongjmp(Warn_restart, 1);
495 * Serious crash time. Postmaster will observe nonzero process
496 * exit status and kill the other backends too.
498 * XXX: what if we are *in* the postmaster? proc_exit() won't kill
501 ImmediateInterruptOK = false;
507 /* We reach here if lev <= WARNING. OK to return to caller. */
519 if (OutputFileName[0])
522 * A debug-output file name was given.
524 * Make sure we can write the file, and find out if it's a tty.
526 if ((fd = open(OutputFileName, O_CREAT | O_APPEND | O_WRONLY,
528 elog(FATAL, "DebugFileOpen: open of %s: %m",
534 * Redirect our stderr to the debug output file.
536 if (!freopen(OutputFileName, "a", stderr))
537 elog(FATAL, "DebugFileOpen: %s reopen as stderr: %m",
539 Debugfile = fileno(stderr);
542 * If the file is a tty and we're running under the postmaster,
543 * try to send stdout there as well (if it isn't a tty then stderr
544 * will block out stdout, so we may as well let stdout go wherever
545 * it was going before).
547 if (istty && IsUnderPostmaster)
548 if (!freopen(OutputFileName, "a", stdout))
549 elog(FATAL, "DebugFileOpen: %s reopen as stdout: %m",
555 * If no filename was specified, send debugging output to stderr. If
556 * stderr has been hosed, try to open a file.
559 if (fcntl(fd, F_GETFD, 0) < 0)
561 snprintf(OutputFileName, MAXPGPATH, "%s/pg.errors.%d",
562 DataDir, (int) MyProcPid);
563 fd = open(OutputFileName, O_CREAT | O_APPEND | O_WRONLY, 0666);
566 elog(FATAL, "DebugFileOpen: could not open debugging file");
574 * Return a timestamp string like
576 * "2000-06-04 13:12:03 "
579 print_timestamp(void)
582 static char buf[TIMESTAMP_SIZE + 1];
584 curtime = time(NULL);
586 strftime(buf, sizeof(buf),
587 "%Y-%m-%d %H:%M:%S ",
588 localtime(&curtime));
596 * Return a string like
600 * with the current pid.
605 static char buf[PID_SIZE + 1];
607 snprintf(buf, PID_SIZE + 1, "[%d] ", (int) MyProcPid);
615 #ifndef PG_SYSLOG_LIMIT
616 #define PG_SYSLOG_LIMIT 128
620 * Write a message line to syslog if the syslog option is set.
622 * Our problem here is that many syslog implementations don't handle
623 * long messages in an acceptable manner. While this function doesn't
624 * help that fact, it does work around by splitting up messages into
628 write_syslog(int level, const char *line)
630 static bool openlog_done = false;
631 static unsigned long seq = 0;
632 static int syslog_fac = LOG_LOCAL0;
634 int len = strlen(line);
641 if (strcasecmp(Syslog_facility, "LOCAL0") == 0)
642 syslog_fac = LOG_LOCAL0;
643 if (strcasecmp(Syslog_facility, "LOCAL1") == 0)
644 syslog_fac = LOG_LOCAL1;
645 if (strcasecmp(Syslog_facility, "LOCAL2") == 0)
646 syslog_fac = LOG_LOCAL2;
647 if (strcasecmp(Syslog_facility, "LOCAL3") == 0)
648 syslog_fac = LOG_LOCAL3;
649 if (strcasecmp(Syslog_facility, "LOCAL4") == 0)
650 syslog_fac = LOG_LOCAL4;
651 if (strcasecmp(Syslog_facility, "LOCAL5") == 0)
652 syslog_fac = LOG_LOCAL5;
653 if (strcasecmp(Syslog_facility, "LOCAL6") == 0)
654 syslog_fac = LOG_LOCAL6;
655 if (strcasecmp(Syslog_facility, "LOCAL7") == 0)
656 syslog_fac = LOG_LOCAL7;
657 openlog(Syslog_ident, LOG_PID | LOG_NDELAY, syslog_fac);
662 * We add a sequence number to each log message to suppress "same"
667 /* divide into multiple syslog() calls if message is too long */
668 /* or if the message contains embedded NewLine(s) '\n' */
669 if (len > PG_SYSLOG_LIMIT || strchr(line, '\n') != NULL)
675 char buf[PG_SYSLOG_LIMIT + 1];
680 /* if we start at a newline, move ahead one char */
688 strncpy(buf, line, PG_SYSLOG_LIMIT);
689 buf[PG_SYSLOG_LIMIT] = '\0';
690 if (strchr(buf, '\n') != NULL)
691 *strchr(buf, '\n') = '\0';
695 /* trim to multibyte letter boundary */
696 buflen = pg_mbcliplen(buf, l, l);
702 /* already word boundary? */
703 if (isspace((unsigned char) line[l]) || line[l] == '\0')
707 /* try to divide at word boundary */
709 while (i > 0 && !isspace((unsigned char) buf[i]))
712 if (i <= 0) /* couldn't divide word boundary */
723 syslog(level, "[%lu-%d] %s", seq, chunk_nr, buf);
730 /* message short enough */
731 syslog(level, "[%lu] %s", seq, line);
734 #endif /* HAVE_SYSLOG */
738 send_message_to_frontend(int type, const char *msg)
742 AssertArg(type <= ERROR);
744 pq_beginmessage(&buf);
745 pq_sendbyte(&buf, type != ERROR ? 'N' : 'E'); /* N is INFO, NOTICE,
747 pq_sendstring(&buf, msg);
751 * This flush is normally not necessary, since postgres.c will flush
752 * out waiting data when control returns to the main loop. But it
753 * seems best to leave it here, so that the client has some clue what
754 * happened if the backend dies before getting back to the main loop
755 * ... error/notice messages should not be a performance-critical path
756 * anyway, so an extra flush won't hurt much ...
763 useful_strerror(int errnum)
765 /* this buffer is only used if errno has a bogus value */
766 static char errorstr_buf[48];
769 if (errnum == ERANGE)
770 /* small trick to save creating many regression test result files */
771 str = gettext("Numerical result out of range");
773 str = strerror(errnum);
776 * Some strerror()s return an empty string for out-of-range errno.
777 * This is ANSI C spec compliant, but not exactly useful.
779 if (str == NULL || *str == '\0')
782 * translator: This string will be truncated at 47 characters
785 snprintf(errorstr_buf, 48, gettext("operating system error %d"),
796 elog_message_prefix(int lev)
798 const char *prefix = NULL;
807 prefix = gettext("DEBUG: ");
811 prefix = gettext("LOG: ");
814 prefix = gettext("INFO: ");
817 prefix = gettext("NOTICE: ");
820 prefix = gettext("WARNING: ");
823 prefix = gettext("ERROR: ");
826 prefix = gettext("FATAL: ");
829 prefix = gettext("PANIC: ");
833 Assert(prefix != NULL);
839 * GUC support routines
842 assign_server_min_messages(const char *newval,
843 bool doit, bool interactive)
845 if (strcasecmp(newval, "debug") == 0)
846 { if (doit) server_min_messages = DEBUG1; }
847 else if (strcasecmp(newval, "debug5") == 0)
848 { if (doit) server_min_messages = DEBUG5; }
849 else if (strcasecmp(newval, "debug4") == 0)
850 { if (doit) server_min_messages = DEBUG4; }
851 else if (strcasecmp(newval, "debug3") == 0)
852 { if (doit) server_min_messages = DEBUG3; }
853 else if (strcasecmp(newval, "debug2") == 0)
854 { if (doit) server_min_messages = DEBUG2; }
855 else if (strcasecmp(newval, "debug1") == 0)
856 { if (doit) server_min_messages = DEBUG1; }
857 else if (strcasecmp(newval, "info") == 0)
858 { if (doit) server_min_messages = INFO; }
859 else if (strcasecmp(newval, "notice") == 0)
860 { if (doit) server_min_messages = NOTICE; }
861 else if (strcasecmp(newval, "warning") == 0)
862 { if (doit) server_min_messages = WARNING; }
863 else if (strcasecmp(newval, "error") == 0)
864 { if (doit) server_min_messages = ERROR; }
865 else if (strcasecmp(newval, "log") == 0)
866 { if (doit) server_min_messages = LOG; }
867 else if (strcasecmp(newval, "fatal") == 0)
868 { if (doit) server_min_messages = FATAL; }
869 else if (strcasecmp(newval, "panic") == 0)
870 { if (doit) server_min_messages = PANIC; }
872 return NULL; /* fail */
873 return newval; /* OK */
877 assign_client_min_messages(const char *newval,
878 bool doit, bool interactive)
880 if (strcasecmp(newval, "debug") == 0)
881 { if (doit) client_min_messages = DEBUG1; }
882 else if (strcasecmp(newval, "debug5") == 0)
883 { if (doit) client_min_messages = DEBUG5; }
884 else if (strcasecmp(newval, "debug4") == 0)
885 { if (doit) client_min_messages = DEBUG4; }
886 else if (strcasecmp(newval, "debug3") == 0)
887 { if (doit) client_min_messages = DEBUG3; }
888 else if (strcasecmp(newval, "debug2") == 0)
889 { if (doit) client_min_messages = DEBUG2; }
890 else if (strcasecmp(newval, "debug1") == 0)
891 { if (doit) client_min_messages = DEBUG1; }
892 else if (strcasecmp(newval, "log") == 0)
893 { if (doit) client_min_messages = LOG; }
894 else if (strcasecmp(newval, "info") == 0)
895 { if (doit) client_min_messages = INFO; }
896 else if (strcasecmp(newval, "notice") == 0)
897 { if (doit) client_min_messages = NOTICE; }
898 else if (strcasecmp(newval, "warning") == 0)
899 { if (doit) client_min_messages = WARNING; }
900 else if (strcasecmp(newval, "error") == 0)
901 { if (doit) client_min_messages = ERROR; }
903 return NULL; /* fail */
904 return newval; /* OK */