PostgreSQL Source Code  git master
elog.c
Go to the documentation of this file.
1 /*-------------------------------------------------------------------------
2  *
3  * elog.c
4  * error logging and reporting
5  *
6  * Because of the extremely high rate at which log messages can be generated,
7  * we need to be mindful of the performance cost of obtaining any information
8  * that may be logged. Also, it's important to keep in mind that this code may
9  * get called from within an aborted transaction, in which case operations
10  * such as syscache lookups are unsafe.
11  *
12  * Some notes about recursion and errors during error processing:
13  *
14  * We need to be robust about recursive-error scenarios --- for example,
15  * if we run out of memory, it's important to be able to report that fact.
16  * There are a number of considerations that go into this.
17  *
18  * First, distinguish between re-entrant use and actual recursion. It
19  * is possible for an error or warning message to be emitted while the
20  * parameters for an error message are being computed. In this case
21  * errstart has been called for the outer message, and some field values
22  * may have already been saved, but we are not actually recursing. We handle
23  * this by providing a (small) stack of ErrorData records. The inner message
24  * can be computed and sent without disturbing the state of the outer message.
25  * (If the inner message is actually an error, this isn't very interesting
26  * because control won't come back to the outer message generator ... but
27  * if the inner message is only debug or log data, this is critical.)
28  *
29  * Second, actual recursion will occur if an error is reported by one of
30  * the elog.c routines or something they call. By far the most probable
31  * scenario of this sort is "out of memory"; and it's also the nastiest
32  * to handle because we'd likely also run out of memory while trying to
33  * report this error! Our escape hatch for this case is to reset the
34  * ErrorContext to empty before trying to process the inner error. Since
35  * ErrorContext is guaranteed to have at least 8K of space in it (see mcxt.c),
36  * we should be able to process an "out of memory" message successfully.
37  * Since we lose the prior error state due to the reset, we won't be able
38  * to return to processing the original error, but we wouldn't have anyway.
39  * (NOTE: the escape hatch is not used for recursive situations where the
40  * inner message is of less than ERROR severity; in that case we just
41  * try to process it and return normally. Usually this will work, but if
42  * it ends up in infinite recursion, we will PANIC due to error stack
43  * overflow.)
44  *
45  *
46  * Portions Copyright (c) 1996-2024, PostgreSQL Global Development Group
47  * Portions Copyright (c) 1994, Regents of the University of California
48  *
49  *
50  * IDENTIFICATION
51  * src/backend/utils/error/elog.c
52  *
53  *-------------------------------------------------------------------------
54  */
55 #include "postgres.h"
56 
57 #include <fcntl.h>
58 #include <time.h>
59 #include <unistd.h>
60 #include <signal.h>
61 #include <ctype.h>
62 #ifdef HAVE_SYSLOG
63 #include <syslog.h>
64 #endif
65 #ifdef HAVE_EXECINFO_H
66 #include <execinfo.h>
67 #endif
68 
69 #include "access/xact.h"
70 #include "libpq/libpq.h"
71 #include "libpq/pqformat.h"
72 #include "mb/pg_wchar.h"
73 #include "miscadmin.h"
74 #include "nodes/miscnodes.h"
75 #include "pgstat.h"
76 #include "postmaster/bgworker.h"
77 #include "postmaster/postmaster.h"
78 #include "postmaster/syslogger.h"
79 #include "storage/ipc.h"
80 #include "storage/proc.h"
81 #include "tcop/tcopprot.h"
82 #include "utils/guc_hooks.h"
83 #include "utils/memutils.h"
84 #include "utils/ps_status.h"
85 #include "utils/varlena.h"
86 
87 
88 /* In this module, access gettext() via err_gettext() */
89 #undef _
90 #define _(x) err_gettext(x)
91 
92 
93 /* Global variables */
95 
96 sigjmp_buf *PG_exception_stack = NULL;
97 
98 /*
99  * Hook for intercepting messages before they are sent to the server log.
100  * Note that the hook will not get called for messages that are suppressed
101  * by log_min_messages. Also note that logging hooks implemented in preload
102  * libraries will miss any log messages that are generated before the
103  * library is loaded.
104  */
106 
107 /* GUC parameters */
109 char *Log_line_prefix = NULL; /* format for extra log line info */
114 
115 /* Processed form of backtrace_functions GUC */
117 
118 #ifdef HAVE_SYSLOG
119 
120 /*
121  * Max string length to send to syslog(). Note that this doesn't count the
122  * sequence-number prefix we add, and of course it doesn't count the prefix
123  * added by syslog itself. Solaris and sysklogd truncate the final message
124  * at 1024 bytes, so this value leaves 124 bytes for those prefixes. (Most
125  * other syslog implementations seem to have limits of 2KB or so.)
126  */
127 #ifndef PG_SYSLOG_LIMIT
128 #define PG_SYSLOG_LIMIT 900
129 #endif
130 
131 static bool openlog_done = false;
132 static char *syslog_ident = NULL;
133 static int syslog_facility = LOG_LOCAL0;
134 
135 static void write_syslog(int level, const char *line);
136 #endif
137 
138 #ifdef WIN32
139 static void write_eventlog(int level, const char *line, int len);
140 #endif
141 
142 /* We provide a small stack of ErrorData records for re-entrant cases */
143 #define ERRORDATA_STACK_SIZE 5
144 
146 
147 static int errordata_stack_depth = -1; /* index of topmost active frame */
148 
149 static int recursion_depth = 0; /* to detect actual recursion */
150 
151 /*
152  * Saved timeval and buffers for formatted timestamps that might be used by
153  * log_line_prefix, csv logs and JSON logs.
154  */
155 static struct timeval saved_timeval;
156 static bool saved_timeval_set = false;
157 
158 #define FORMATTED_TS_LEN 128
161 
162 
163 /* Macro for checking errordata_stack_depth is reasonable */
164 #define CHECK_STACK_DEPTH() \
165  do { \
166  if (errordata_stack_depth < 0) \
167  { \
168  errordata_stack_depth = -1; \
169  ereport(ERROR, (errmsg_internal("errstart was not called"))); \
170  } \
171  } while (0)
172 
173 
174 static const char *err_gettext(const char *str) pg_attribute_format_arg(1);
175 static ErrorData *get_error_stack_entry(void);
176 static void set_stack_entry_domain(ErrorData *edata, const char *domain);
177 static void set_stack_entry_location(ErrorData *edata,
178  const char *filename, int lineno,
179  const char *funcname);
180 static bool matches_backtrace_functions(const char *funcname);
181 static pg_noinline void set_backtrace(ErrorData *edata, int num_skip);
182 static void set_errdata_field(MemoryContextData *cxt, char **ptr, const char *str);
183 static void FreeErrorDataContents(ErrorData *edata);
184 static void write_console(const char *line, int len);
185 static const char *process_log_prefix_padding(const char *p, int *ppadding);
186 static void log_line_prefix(StringInfo buf, ErrorData *edata);
187 static void send_message_to_server_log(ErrorData *edata);
188 static void send_message_to_frontend(ErrorData *edata);
189 static void append_with_tabs(StringInfo buf, const char *str);
190 
191 
192 /*
193  * is_log_level_output -- is elevel logically >= log_min_level?
194  *
195  * We use this for tests that should consider LOG to sort out-of-order,
196  * between ERROR and FATAL. Generally this is the right thing for testing
197  * whether a message should go to the postmaster log, whereas a simple >=
198  * test is correct for testing whether the message should go to the client.
199  */
200 static inline bool
201 is_log_level_output(int elevel, int log_min_level)
202 {
203  if (elevel == LOG || elevel == LOG_SERVER_ONLY)
204  {
205  if (log_min_level == LOG || log_min_level <= ERROR)
206  return true;
207  }
208  else if (elevel == WARNING_CLIENT_ONLY)
209  {
210  /* never sent to log, regardless of log_min_level */
211  return false;
212  }
213  else if (log_min_level == LOG)
214  {
215  /* elevel != LOG */
216  if (elevel >= FATAL)
217  return true;
218  }
219  /* Neither is LOG */
220  else if (elevel >= log_min_level)
221  return true;
222 
223  return false;
224 }
225 
226 /*
227  * Policy-setting subroutines. These are fairly simple, but it seems wise
228  * to have the code in just one place.
229  */
230 
231 /*
232  * should_output_to_server --- should message of given elevel go to the log?
233  */
234 static inline bool
236 {
237  return is_log_level_output(elevel, log_min_messages);
238 }
239 
240 /*
241  * should_output_to_client --- should message of given elevel go to the client?
242  */
243 static inline bool
245 {
246  if (whereToSendOutput == DestRemote && elevel != LOG_SERVER_ONLY)
247  {
248  /*
249  * client_min_messages is honored only after we complete the
250  * authentication handshake. This is required both for security
251  * reasons and because many clients can't handle NOTICE messages
252  * during authentication.
253  */
255  return (elevel >= ERROR);
256  else
257  return (elevel >= client_min_messages || elevel == INFO);
258  }
259  return false;
260 }
261 
262 
263 /*
264  * message_level_is_interesting --- would ereport/elog do anything?
265  *
266  * Returns true if ereport/elog with this elevel will not be a no-op.
267  * This is useful to short-circuit any expensive preparatory work that
268  * might be needed for a logging message. There is no point in
269  * prepending this to a bare ereport/elog call, however.
270  */
271 bool
273 {
274  /*
275  * Keep this in sync with the decision-making in errstart().
276  */
277  if (elevel >= ERROR ||
278  should_output_to_server(elevel) ||
279  should_output_to_client(elevel))
280  return true;
281  return false;
282 }
283 
284 
285 /*
286  * in_error_recursion_trouble --- are we at risk of infinite error recursion?
287  *
288  * This function exists to provide common control of various fallback steps
289  * that we take if we think we are facing infinite error recursion. See the
290  * callers for details.
291  */
292 bool
294 {
295  /* Pull the plug if recurse more than once */
296  return (recursion_depth > 2);
297 }
298 
299 /*
300  * One of those fallback steps is to stop trying to localize the error
301  * message, since there's a significant probability that that's exactly
302  * what's causing the recursion.
303  */
304 static inline const char *
305 err_gettext(const char *str)
306 {
307 #ifdef ENABLE_NLS
309  return str;
310  else
311  return gettext(str);
312 #else
313  return str;
314 #endif
315 }
316 
317 /*
318  * errstart_cold
319  * A simple wrapper around errstart, but hinted to be "cold". Supporting
320  * compilers are more likely to move code for branches containing this
321  * function into an area away from the calling function's code. This can
322  * result in more commonly executed code being more compact and fitting
323  * on fewer cache lines.
324  */
326 errstart_cold(int elevel, const char *domain)
327 {
328  return errstart(elevel, domain);
329 }
330 
331 /*
332  * errstart --- begin an error-reporting cycle
333  *
334  * Create and initialize error stack entry. Subsequently, errmsg() and
335  * perhaps other routines will be called to further populate the stack entry.
336  * Finally, errfinish() will be called to actually process the error report.
337  *
338  * Returns true in normal case. Returns false to short-circuit the error
339  * report (if it's a warning or lower and not to be reported anywhere).
340  */
341 bool
342 errstart(int elevel, const char *domain)
343 {
344  ErrorData *edata;
345  bool output_to_server;
346  bool output_to_client = false;
347  int i;
348 
349  /*
350  * Check some cases in which we want to promote an error into a more
351  * severe error. None of this logic applies for non-error messages.
352  */
353  if (elevel >= ERROR)
354  {
355  /*
356  * If we are inside a critical section, all errors become PANIC
357  * errors. See miscadmin.h.
358  */
359  if (CritSectionCount > 0)
360  elevel = PANIC;
361 
362  /*
363  * Check reasons for treating ERROR as FATAL:
364  *
365  * 1. we have no handler to pass the error to (implies we are in the
366  * postmaster or in backend startup).
367  *
368  * 2. ExitOnAnyError mode switch is set (initdb uses this).
369  *
370  * 3. the error occurred after proc_exit has begun to run. (It's
371  * proc_exit's responsibility to see that this doesn't turn into
372  * infinite recursion!)
373  */
374  if (elevel == ERROR)
375  {
376  if (PG_exception_stack == NULL ||
377  ExitOnAnyError ||
379  elevel = FATAL;
380  }
381 
382  /*
383  * If the error level is ERROR or more, errfinish is not going to
384  * return to caller; therefore, if there is any stacked error already
385  * in progress it will be lost. This is more or less okay, except we
386  * do not want to have a FATAL or PANIC error downgraded because the
387  * reporting process was interrupted by a lower-grade error. So check
388  * the stack and make sure we panic if panic is warranted.
389  */
390  for (i = 0; i <= errordata_stack_depth; i++)
391  elevel = Max(elevel, errordata[i].elevel);
392  }
393 
394  /*
395  * Now decide whether we need to process this report at all; if it's
396  * warning or less and not enabled for logging, just return false without
397  * starting up any error logging machinery.
398  */
399  output_to_server = should_output_to_server(elevel);
400  output_to_client = should_output_to_client(elevel);
401  if (elevel < ERROR && !output_to_server && !output_to_client)
402  return false;
403 
404  /*
405  * We need to do some actual work. Make sure that memory context
406  * initialization has finished, else we can't do anything useful.
407  */
408  if (ErrorContext == NULL)
409  {
410  /* Oops, hard crash time; very little we can do safely here */
411  write_stderr("error occurred before error message processing is available\n");
412  exit(2);
413  }
414 
415  /*
416  * Okay, crank up a stack entry to store the info in.
417  */
418 
419  if (recursion_depth++ > 0 && elevel >= ERROR)
420  {
421  /*
422  * Oops, error during error processing. Clear ErrorContext as
423  * discussed at top of file. We will not return to the original
424  * error's reporter or handler, so we don't need it.
425  */
427 
428  /*
429  * Infinite error recursion might be due to something broken in a
430  * context traceback routine. Abandon them too. We also abandon
431  * attempting to print the error statement (which, if long, could
432  * itself be the source of the recursive failure).
433  */
435  {
436  error_context_stack = NULL;
437  debug_query_string = NULL;
438  }
439  }
440 
441  /* Initialize data for this error frame */
442  edata = get_error_stack_entry();
443  edata->elevel = elevel;
444  edata->output_to_server = output_to_server;
445  edata->output_to_client = output_to_client;
446  set_stack_entry_domain(edata, domain);
447  /* Select default errcode based on elevel */
448  if (elevel >= ERROR)
449  edata->sqlerrcode = ERRCODE_INTERNAL_ERROR;
450  else if (elevel >= WARNING)
451  edata->sqlerrcode = ERRCODE_WARNING;
452  else
453  edata->sqlerrcode = ERRCODE_SUCCESSFUL_COMPLETION;
454 
455  /*
456  * Any allocations for this error state level should go into ErrorContext
457  */
458  edata->assoc_context = ErrorContext;
459 
460  recursion_depth--;
461  return true;
462 }
463 
464 /*
465  * errfinish --- end an error-reporting cycle
466  *
467  * Produce the appropriate error report(s) and pop the error stack.
468  *
469  * If elevel, as passed to errstart(), is ERROR or worse, control does not
470  * return to the caller. See elog.h for the error level definitions.
471  */
472 void
473 errfinish(const char *filename, int lineno, const char *funcname)
474 {
476  int elevel;
477  MemoryContext oldcontext;
478  ErrorContextCallback *econtext;
479 
480  recursion_depth++;
482 
483  /* Save the last few bits of error state into the stack entry */
484  set_stack_entry_location(edata, filename, lineno, funcname);
485 
486  elevel = edata->elevel;
487 
488  /*
489  * Do processing in ErrorContext, which we hope has enough reserved space
490  * to report an error.
491  */
492  oldcontext = MemoryContextSwitchTo(ErrorContext);
493 
494  /* Collect backtrace, if enabled and we didn't already */
495  if (!edata->backtrace &&
496  edata->funcname &&
499  set_backtrace(edata, 2);
500 
501  /*
502  * Call any context callback functions. Errors occurring in callback
503  * functions will be treated as recursive errors --- this ensures we will
504  * avoid infinite recursion (see errstart).
505  */
506  for (econtext = error_context_stack;
507  econtext != NULL;
508  econtext = econtext->previous)
509  econtext->callback(econtext->arg);
510 
511  /*
512  * If ERROR (not more nor less) we pass it off to the current handler.
513  * Printing it and popping the stack is the responsibility of the handler.
514  */
515  if (elevel == ERROR)
516  {
517  /*
518  * We do some minimal cleanup before longjmp'ing so that handlers can
519  * execute in a reasonably sane state.
520  *
521  * Reset InterruptHoldoffCount in case we ereport'd from inside an
522  * interrupt holdoff section. (We assume here that no handler will
523  * itself be inside a holdoff section. If necessary, such a handler
524  * could save and restore InterruptHoldoffCount for itself, but this
525  * should make life easier for most.)
526  */
529 
530  CritSectionCount = 0; /* should be unnecessary, but... */
531 
532  /*
533  * Note that we leave CurrentMemoryContext set to ErrorContext. The
534  * handler should reset it to something else soon.
535  */
536 
537  recursion_depth--;
538  PG_RE_THROW();
539  }
540 
541  /* Emit the message to the right places */
542  EmitErrorReport();
543 
544  /* Now free up subsidiary data attached to stack entry, and release it */
545  FreeErrorDataContents(edata);
547 
548  /* Exit error-handling context */
549  MemoryContextSwitchTo(oldcontext);
550  recursion_depth--;
551 
552  /*
553  * Perform error recovery action as specified by elevel.
554  */
555  if (elevel == FATAL)
556  {
557  /*
558  * For a FATAL error, we let proc_exit clean up and exit.
559  *
560  * If we just reported a startup failure, the client will disconnect
561  * on receiving it, so don't send any more to the client.
562  */
565 
566  /*
567  * fflush here is just to improve the odds that we get to see the
568  * error message, in case things are so hosed that proc_exit crashes.
569  * Any other code you might be tempted to add here should probably be
570  * in an on_proc_exit or on_shmem_exit callback instead.
571  */
572  fflush(NULL);
573 
574  /*
575  * Let the cumulative stats system know. Only mark the session as
576  * terminated by fatal error if there is no other known cause.
577  */
580 
581  /*
582  * Do normal process-exit cleanup, then return exit code 1 to indicate
583  * FATAL termination. The postmaster may or may not consider this
584  * worthy of panic, depending on which subprocess returns it.
585  */
586  proc_exit(1);
587  }
588 
589  if (elevel >= PANIC)
590  {
591  /*
592  * Serious crash time. Postmaster will observe SIGABRT process exit
593  * status and kill the other backends too.
594  *
595  * XXX: what if we are *in* the postmaster? abort() won't kill our
596  * children...
597  */
598  fflush(NULL);
599  abort();
600  }
601 
602  /*
603  * Check for cancel/die interrupt first --- this is so that the user can
604  * stop a query emitting tons of notice or warning messages, even if it's
605  * in a loop that otherwise fails to check for interrupts.
606  */
608 }
609 
610 
611 /*
612  * errsave_start --- begin a "soft" error-reporting cycle
613  *
614  * If "context" isn't an ErrorSaveContext node, this behaves as
615  * errstart(ERROR, domain), and the errsave() macro ends up acting
616  * exactly like ereport(ERROR, ...).
617  *
618  * If "context" is an ErrorSaveContext node, but the node creator only wants
619  * notification of the fact of a soft error without any details, we just set
620  * the error_occurred flag in the ErrorSaveContext node and return false,
621  * which will cause us to skip the remaining error processing steps.
622  *
623  * Otherwise, create and initialize error stack entry and return true.
624  * Subsequently, errmsg() and perhaps other routines will be called to further
625  * populate the stack entry. Finally, errsave_finish() will be called to
626  * tidy up.
627  */
628 bool
629 errsave_start(struct Node *context, const char *domain)
630 {
631  ErrorSaveContext *escontext;
632  ErrorData *edata;
633 
634  /*
635  * Do we have a context for soft error reporting? If not, just punt to
636  * errstart().
637  */
638  if (context == NULL || !IsA(context, ErrorSaveContext))
639  return errstart(ERROR, domain);
640 
641  /* Report that a soft error was detected */
642  escontext = (ErrorSaveContext *) context;
643  escontext->error_occurred = true;
644 
645  /* Nothing else to do if caller wants no further details */
646  if (!escontext->details_wanted)
647  return false;
648 
649  /*
650  * Okay, crank up a stack entry to store the info in.
651  */
652 
653  recursion_depth++;
654 
655  /* Initialize data for this error frame */
656  edata = get_error_stack_entry();
657  edata->elevel = LOG; /* signal all is well to errsave_finish */
658  set_stack_entry_domain(edata, domain);
659  /* Select default errcode based on the assumed elevel of ERROR */
660  edata->sqlerrcode = ERRCODE_INTERNAL_ERROR;
661 
662  /*
663  * Any allocations for this error state level should go into the caller's
664  * context. We don't need to pollute ErrorContext, or even require it to
665  * exist, in this code path.
666  */
668 
669  recursion_depth--;
670  return true;
671 }
672 
673 /*
674  * errsave_finish --- end a "soft" error-reporting cycle
675  *
676  * If errsave_start() decided this was a regular error, behave as
677  * errfinish(). Otherwise, package up the error details and save
678  * them in the ErrorSaveContext node.
679  */
680 void
681 errsave_finish(struct Node *context, const char *filename, int lineno,
682  const char *funcname)
683 {
684  ErrorSaveContext *escontext = (ErrorSaveContext *) context;
686 
687  /* verify stack depth before accessing *edata */
689 
690  /*
691  * If errsave_start punted to errstart, then elevel will be ERROR or
692  * perhaps even PANIC. Punt likewise to errfinish.
693  */
694  if (edata->elevel >= ERROR)
695  {
696  errfinish(filename, lineno, funcname);
697  pg_unreachable();
698  }
699 
700  /*
701  * Else, we should package up the stack entry contents and deliver them to
702  * the caller.
703  */
704  recursion_depth++;
705 
706  /* Save the last few bits of error state into the stack entry */
707  set_stack_entry_location(edata, filename, lineno, funcname);
708 
709  /* Replace the LOG value that errsave_start inserted */
710  edata->elevel = ERROR;
711 
712  /*
713  * We skip calling backtrace and context functions, which are more likely
714  * to cause trouble than provide useful context; they might act on the
715  * assumption that a transaction abort is about to occur.
716  */
717 
718  /*
719  * Make a copy of the error info for the caller. All the subsidiary
720  * strings are already in the caller's context, so it's sufficient to
721  * flat-copy the stack entry.
722  */
723  escontext->error_data = palloc_object(ErrorData);
724  memcpy(escontext->error_data, edata, sizeof(ErrorData));
725 
726  /* Exit error-handling context */
728  recursion_depth--;
729 }
730 
731 
732 /*
733  * get_error_stack_entry --- allocate and initialize a new stack entry
734  *
735  * The entry should be freed, when we're done with it, by calling
736  * FreeErrorDataContents() and then decrementing errordata_stack_depth.
737  *
738  * Returning the entry's address is just a notational convenience,
739  * since it had better be errordata[errordata_stack_depth].
740  *
741  * Although the error stack is not large, we don't expect to run out of space.
742  * Using more than one entry implies a new error report during error recovery,
743  * which is possible but already suggests we're in trouble. If we exhaust the
744  * stack, almost certainly we are in an infinite loop of errors during error
745  * recovery, so we give up and PANIC.
746  *
747  * (Note that this is distinct from the recursion_depth checks, which
748  * guard against recursion while handling a single stack entry.)
749  */
750 static ErrorData *
752 {
753  ErrorData *edata;
754 
755  /* Allocate error frame */
758  {
759  /* Wups, stack not big enough */
760  errordata_stack_depth = -1; /* make room on stack */
761  ereport(PANIC, (errmsg_internal("ERRORDATA_STACK_SIZE exceeded")));
762  }
763 
764  /* Initialize error frame to all zeroes/NULLs */
766  memset(edata, 0, sizeof(ErrorData));
767 
768  /* Save errno immediately to ensure error parameter eval can't change it */
769  edata->saved_errno = errno;
770 
771  return edata;
772 }
773 
774 /*
775  * set_stack_entry_domain --- fill in the internationalization domain
776  */
777 static void
778 set_stack_entry_domain(ErrorData *edata, const char *domain)
779 {
780  /* the default text domain is the backend's */
781  edata->domain = domain ? domain : PG_TEXTDOMAIN("postgres");
782  /* initialize context_domain the same way (see set_errcontext_domain()) */
783  edata->context_domain = edata->domain;
784 }
785 
786 /*
787  * set_stack_entry_location --- fill in code-location details
788  *
789  * Store the values of __FILE__, __LINE__, and __func__ from the call site.
790  * We make an effort to normalize __FILE__, since compilers are inconsistent
791  * about how much of the path they'll include, and we'd prefer that the
792  * behavior not depend on that (especially, that it not vary with build path).
793  */
794 static void
796  const char *filename, int lineno,
797  const char *funcname)
798 {
799  if (filename)
800  {
801  const char *slash;
802 
803  /* keep only base name, useful especially for vpath builds */
804  slash = strrchr(filename, '/');
805  if (slash)
806  filename = slash + 1;
807  /* Some Windows compilers use backslashes in __FILE__ strings */
808  slash = strrchr(filename, '\\');
809  if (slash)
810  filename = slash + 1;
811  }
812 
813  edata->filename = filename;
814  edata->lineno = lineno;
815  edata->funcname = funcname;
816 }
817 
818 /*
819  * matches_backtrace_functions --- checks whether the given funcname matches
820  * backtrace_functions
821  *
822  * See check_backtrace_functions.
823  */
824 static bool
826 {
827  const char *p;
828 
829  if (!backtrace_function_list || funcname == NULL || funcname[0] == '\0')
830  return false;
831 
833  for (;;)
834  {
835  if (*p == '\0') /* end of backtrace_function_list */
836  break;
837 
838  if (strcmp(funcname, p) == 0)
839  return true;
840  p += strlen(p) + 1;
841  }
842 
843  return false;
844 }
845 
846 
847 /*
848  * errcode --- add SQLSTATE error code to the current error
849  *
850  * The code is expected to be represented as per MAKE_SQLSTATE().
851  */
852 int
853 errcode(int sqlerrcode)
854 {
856 
857  /* we don't bother incrementing recursion_depth */
859 
860  edata->sqlerrcode = sqlerrcode;
861 
862  return 0; /* return value does not matter */
863 }
864 
865 
866 /*
867  * errcode_for_file_access --- add SQLSTATE error code to the current error
868  *
869  * The SQLSTATE code is chosen based on the saved errno value. We assume
870  * that the failing operation was some type of disk file access.
871  *
872  * NOTE: the primary error message string should generally include %m
873  * when this is used.
874  */
875 int
877 {
879 
880  /* we don't bother incrementing recursion_depth */
882 
883  switch (edata->saved_errno)
884  {
885  /* Permission-denied failures */
886  case EPERM: /* Not super-user */
887  case EACCES: /* Permission denied */
888 #ifdef EROFS
889  case EROFS: /* Read only file system */
890 #endif
891  edata->sqlerrcode = ERRCODE_INSUFFICIENT_PRIVILEGE;
892  break;
893 
894  /* File not found */
895  case ENOENT: /* No such file or directory */
896  edata->sqlerrcode = ERRCODE_UNDEFINED_FILE;
897  break;
898 
899  /* Duplicate file */
900  case EEXIST: /* File exists */
901  edata->sqlerrcode = ERRCODE_DUPLICATE_FILE;
902  break;
903 
904  /* Wrong object type or state */
905  case ENOTDIR: /* Not a directory */
906  case EISDIR: /* Is a directory */
907  case ENOTEMPTY: /* Directory not empty */
908  edata->sqlerrcode = ERRCODE_WRONG_OBJECT_TYPE;
909  break;
910 
911  /* Insufficient resources */
912  case ENOSPC: /* No space left on device */
913  edata->sqlerrcode = ERRCODE_DISK_FULL;
914  break;
915 
916  case ENOMEM: /* Out of memory */
917  edata->sqlerrcode = ERRCODE_OUT_OF_MEMORY;
918  break;
919 
920  case ENFILE: /* File table overflow */
921  case EMFILE: /* Too many open files */
922  edata->sqlerrcode = ERRCODE_INSUFFICIENT_RESOURCES;
923  break;
924 
925  /* Hardware failure */
926  case EIO: /* I/O error */
927  edata->sqlerrcode = ERRCODE_IO_ERROR;
928  break;
929 
930  case ENAMETOOLONG: /* File name too long */
931  edata->sqlerrcode = ERRCODE_FILE_NAME_TOO_LONG;
932  break;
933 
934  /* All else is classified as internal errors */
935  default:
936  edata->sqlerrcode = ERRCODE_INTERNAL_ERROR;
937  break;
938  }
939 
940  return 0; /* return value does not matter */
941 }
942 
943 /*
944  * errcode_for_socket_access --- add SQLSTATE error code to the current error
945  *
946  * The SQLSTATE code is chosen based on the saved errno value. We assume
947  * that the failing operation was some type of socket access.
948  *
949  * NOTE: the primary error message string should generally include %m
950  * when this is used.
951  */
952 int
954 {
956 
957  /* we don't bother incrementing recursion_depth */
959 
960  switch (edata->saved_errno)
961  {
962  /* Loss of connection */
964  edata->sqlerrcode = ERRCODE_CONNECTION_FAILURE;
965  break;
966 
967  /* All else is classified as internal errors */
968  default:
969  edata->sqlerrcode = ERRCODE_INTERNAL_ERROR;
970  break;
971  }
972 
973  return 0; /* return value does not matter */
974 }
975 
976 
977 /*
978  * This macro handles expansion of a format string and associated parameters;
979  * it's common code for errmsg(), errdetail(), etc. Must be called inside
980  * a routine that is declared like "const char *fmt, ..." and has an edata
981  * pointer set up. The message is assigned to edata->targetfield, or
982  * appended to it if appendval is true. The message is subject to translation
983  * if translateit is true.
984  *
985  * Note: we pstrdup the buffer rather than just transferring its storage
986  * to the edata field because the buffer might be considerably larger than
987  * really necessary.
988  */
989 #define EVALUATE_MESSAGE(domain, targetfield, appendval, translateit) \
990  { \
991  StringInfoData buf; \
992  /* Internationalize the error format string */ \
993  if ((translateit) && !in_error_recursion_trouble()) \
994  fmt = dgettext((domain), fmt); \
995  initStringInfo(&buf); \
996  if ((appendval) && edata->targetfield) { \
997  appendStringInfoString(&buf, edata->targetfield); \
998  appendStringInfoChar(&buf, '\n'); \
999  } \
1000  /* Generate actual output --- have to use appendStringInfoVA */ \
1001  for (;;) \
1002  { \
1003  va_list args; \
1004  int needed; \
1005  errno = edata->saved_errno; \
1006  va_start(args, fmt); \
1007  needed = appendStringInfoVA(&buf, fmt, args); \
1008  va_end(args); \
1009  if (needed == 0) \
1010  break; \
1011  enlargeStringInfo(&buf, needed); \
1012  } \
1013  /* Save the completed message into the stack item */ \
1014  if (edata->targetfield) \
1015  pfree(edata->targetfield); \
1016  edata->targetfield = pstrdup(buf.data); \
1017  pfree(buf.data); \
1018  }
1019 
1020 /*
1021  * Same as above, except for pluralized error messages. The calling routine
1022  * must be declared like "const char *fmt_singular, const char *fmt_plural,
1023  * unsigned long n, ...". Translation is assumed always wanted.
1024  */
1025 #define EVALUATE_MESSAGE_PLURAL(domain, targetfield, appendval) \
1026  { \
1027  const char *fmt; \
1028  StringInfoData buf; \
1029  /* Internationalize the error format string */ \
1030  if (!in_error_recursion_trouble()) \
1031  fmt = dngettext((domain), fmt_singular, fmt_plural, n); \
1032  else \
1033  fmt = (n == 1 ? fmt_singular : fmt_plural); \
1034  initStringInfo(&buf); \
1035  if ((appendval) && edata->targetfield) { \
1036  appendStringInfoString(&buf, edata->targetfield); \
1037  appendStringInfoChar(&buf, '\n'); \
1038  } \
1039  /* Generate actual output --- have to use appendStringInfoVA */ \
1040  for (;;) \
1041  { \
1042  va_list args; \
1043  int needed; \
1044  errno = edata->saved_errno; \
1045  va_start(args, n); \
1046  needed = appendStringInfoVA(&buf, fmt, args); \
1047  va_end(args); \
1048  if (needed == 0) \
1049  break; \
1050  enlargeStringInfo(&buf, needed); \
1051  } \
1052  /* Save the completed message into the stack item */ \
1053  if (edata->targetfield) \
1054  pfree(edata->targetfield); \
1055  edata->targetfield = pstrdup(buf.data); \
1056  pfree(buf.data); \
1057  }
1058 
1059 
1060 /*
1061  * errmsg --- add a primary error message text to the current error
1062  *
1063  * In addition to the usual %-escapes recognized by printf, "%m" in
1064  * fmt is replaced by the error message for the caller's value of errno.
1065  *
1066  * Note: no newline is needed at the end of the fmt string, since
1067  * ereport will provide one for the output methods that need it.
1068  */
1069 int
1070 errmsg(const char *fmt,...)
1071 {
1073  MemoryContext oldcontext;
1074 
1075  recursion_depth++;
1077  oldcontext = MemoryContextSwitchTo(edata->assoc_context);
1078 
1079  edata->message_id = fmt;
1080  EVALUATE_MESSAGE(edata->domain, message, false, true);
1081 
1082  MemoryContextSwitchTo(oldcontext);
1083  recursion_depth--;
1084  return 0; /* return value does not matter */
1085 }
1086 
1087 /*
1088  * Add a backtrace to the containing ereport() call. This is intended to be
1089  * added temporarily during debugging.
1090  */
1091 int
1093 {
1095  MemoryContext oldcontext;
1096 
1097  recursion_depth++;
1099  oldcontext = MemoryContextSwitchTo(edata->assoc_context);
1100 
1101  set_backtrace(edata, 1);
1102 
1103  MemoryContextSwitchTo(oldcontext);
1104  recursion_depth--;
1105 
1106  return 0;
1107 }
1108 
1109 /*
1110  * Compute backtrace data and add it to the supplied ErrorData. num_skip
1111  * specifies how many inner frames to skip. Use this to avoid showing the
1112  * internal backtrace support functions in the backtrace. This requires that
1113  * this and related functions are not inlined.
1114  */
1115 static void
1116 set_backtrace(ErrorData *edata, int num_skip)
1117 {
1118  StringInfoData errtrace;
1119 
1120  initStringInfo(&errtrace);
1121 
1122 #ifdef HAVE_BACKTRACE_SYMBOLS
1123  {
1124  void *buf[100];
1125  int nframes;
1126  char **strfrms;
1127 
1128  nframes = backtrace(buf, lengthof(buf));
1129  strfrms = backtrace_symbols(buf, nframes);
1130  if (strfrms == NULL)
1131  return;
1132 
1133  for (int i = num_skip; i < nframes; i++)
1134  appendStringInfo(&errtrace, "\n%s", strfrms[i]);
1135  free(strfrms);
1136  }
1137 #else
1138  appendStringInfoString(&errtrace,
1139  "backtrace generation is not supported by this installation");
1140 #endif
1141 
1142  edata->backtrace = errtrace.data;
1143 }
1144 
1145 /*
1146  * errmsg_internal --- add a primary error message text to the current error
1147  *
1148  * This is exactly like errmsg() except that strings passed to errmsg_internal
1149  * are not translated, and are customarily left out of the
1150  * internationalization message dictionary. This should be used for "can't
1151  * happen" cases that are probably not worth spending translation effort on.
1152  * We also use this for certain cases where we *must* not try to translate
1153  * the message because the translation would fail and result in infinite
1154  * error recursion.
1155  */
1156 int
1157 errmsg_internal(const char *fmt,...)
1158 {
1160  MemoryContext oldcontext;
1161 
1162  recursion_depth++;
1164  oldcontext = MemoryContextSwitchTo(edata->assoc_context);
1165 
1166  edata->message_id = fmt;
1167  EVALUATE_MESSAGE(edata->domain, message, false, false);
1168 
1169  MemoryContextSwitchTo(oldcontext);
1170  recursion_depth--;
1171  return 0; /* return value does not matter */
1172 }
1173 
1174 
1175 /*
1176  * errmsg_plural --- add a primary error message text to the current error,
1177  * with support for pluralization of the message text
1178  */
1179 int
1180 errmsg_plural(const char *fmt_singular, const char *fmt_plural,
1181  unsigned long n,...)
1182 {
1184  MemoryContext oldcontext;
1185 
1186  recursion_depth++;
1188  oldcontext = MemoryContextSwitchTo(edata->assoc_context);
1189 
1190  edata->message_id = fmt_singular;
1191  EVALUATE_MESSAGE_PLURAL(edata->domain, message, false);
1192 
1193  MemoryContextSwitchTo(oldcontext);
1194  recursion_depth--;
1195  return 0; /* return value does not matter */
1196 }
1197 
1198 
1199 /*
1200  * errdetail --- add a detail error message text to the current error
1201  */
1202 int
1203 errdetail(const char *fmt,...)
1204 {
1206  MemoryContext oldcontext;
1207 
1208  recursion_depth++;
1210  oldcontext = MemoryContextSwitchTo(edata->assoc_context);
1211 
1212  EVALUATE_MESSAGE(edata->domain, detail, false, true);
1213 
1214  MemoryContextSwitchTo(oldcontext);
1215  recursion_depth--;
1216  return 0; /* return value does not matter */
1217 }
1218 
1219 
1220 /*
1221  * errdetail_internal --- add a detail error message text to the current error
1222  *
1223  * This is exactly like errdetail() except that strings passed to
1224  * errdetail_internal are not translated, and are customarily left out of the
1225  * internationalization message dictionary. This should be used for detail
1226  * messages that seem not worth translating for one reason or another
1227  * (typically, that they don't seem to be useful to average users).
1228  */
1229 int
1230 errdetail_internal(const char *fmt,...)
1231 {
1233  MemoryContext oldcontext;
1234 
1235  recursion_depth++;
1237  oldcontext = MemoryContextSwitchTo(edata->assoc_context);
1238 
1239  EVALUATE_MESSAGE(edata->domain, detail, false, false);
1240 
1241  MemoryContextSwitchTo(oldcontext);
1242  recursion_depth--;
1243  return 0; /* return value does not matter */
1244 }
1245 
1246 
1247 /*
1248  * errdetail_log --- add a detail_log error message text to the current error
1249  */
1250 int
1251 errdetail_log(const char *fmt,...)
1252 {
1254  MemoryContext oldcontext;
1255 
1256  recursion_depth++;
1258  oldcontext = MemoryContextSwitchTo(edata->assoc_context);
1259 
1260  EVALUATE_MESSAGE(edata->domain, detail_log, false, true);
1261 
1262  MemoryContextSwitchTo(oldcontext);
1263  recursion_depth--;
1264  return 0; /* return value does not matter */
1265 }
1266 
1267 /*
1268  * errdetail_log_plural --- add a detail_log error message text to the current error
1269  * with support for pluralization of the message text
1270  */
1271 int
1272 errdetail_log_plural(const char *fmt_singular, const char *fmt_plural,
1273  unsigned long n,...)
1274 {
1276  MemoryContext oldcontext;
1277 
1278  recursion_depth++;
1280  oldcontext = MemoryContextSwitchTo(edata->assoc_context);
1281 
1282  EVALUATE_MESSAGE_PLURAL(edata->domain, detail_log, false);
1283 
1284  MemoryContextSwitchTo(oldcontext);
1285  recursion_depth--;
1286  return 0; /* return value does not matter */
1287 }
1288 
1289 
1290 /*
1291  * errdetail_plural --- add a detail error message text to the current error,
1292  * with support for pluralization of the message text
1293  */
1294 int
1295 errdetail_plural(const char *fmt_singular, const char *fmt_plural,
1296  unsigned long n,...)
1297 {
1299  MemoryContext oldcontext;
1300 
1301  recursion_depth++;
1303  oldcontext = MemoryContextSwitchTo(edata->assoc_context);
1304 
1305  EVALUATE_MESSAGE_PLURAL(edata->domain, detail, false);
1306 
1307  MemoryContextSwitchTo(oldcontext);
1308  recursion_depth--;
1309  return 0; /* return value does not matter */
1310 }
1311 
1312 
1313 /*
1314  * errhint --- add a hint error message text to the current error
1315  */
1316 int
1317 errhint(const char *fmt,...)
1318 {
1320  MemoryContext oldcontext;
1321 
1322  recursion_depth++;
1324  oldcontext = MemoryContextSwitchTo(edata->assoc_context);
1325 
1326  EVALUATE_MESSAGE(edata->domain, hint, false, true);
1327 
1328  MemoryContextSwitchTo(oldcontext);
1329  recursion_depth--;
1330  return 0; /* return value does not matter */
1331 }
1332 
1333 
1334 /*
1335  * errhint_plural --- add a hint error message text to the current error,
1336  * with support for pluralization of the message text
1337  */
1338 int
1339 errhint_plural(const char *fmt_singular, const char *fmt_plural,
1340  unsigned long n,...)
1341 {
1343  MemoryContext oldcontext;
1344 
1345  recursion_depth++;
1347  oldcontext = MemoryContextSwitchTo(edata->assoc_context);
1348 
1349  EVALUATE_MESSAGE_PLURAL(edata->domain, hint, false);
1350 
1351  MemoryContextSwitchTo(oldcontext);
1352  recursion_depth--;
1353  return 0; /* return value does not matter */
1354 }
1355 
1356 
1357 /*
1358  * errcontext_msg --- add a context error message text to the current error
1359  *
1360  * Unlike other cases, multiple calls are allowed to build up a stack of
1361  * context information. We assume earlier calls represent more-closely-nested
1362  * states.
1363  */
1364 int
1365 errcontext_msg(const char *fmt,...)
1366 {
1368  MemoryContext oldcontext;
1369 
1370  recursion_depth++;
1372  oldcontext = MemoryContextSwitchTo(edata->assoc_context);
1373 
1374  EVALUATE_MESSAGE(edata->context_domain, context, true, true);
1375 
1376  MemoryContextSwitchTo(oldcontext);
1377  recursion_depth--;
1378  return 0; /* return value does not matter */
1379 }
1380 
1381 /*
1382  * set_errcontext_domain --- set message domain to be used by errcontext()
1383  *
1384  * errcontext_msg() can be called from a different module than the original
1385  * ereport(), so we cannot use the message domain passed in errstart() to
1386  * translate it. Instead, each errcontext_msg() call should be preceded by
1387  * a set_errcontext_domain() call to specify the domain. This is usually
1388  * done transparently by the errcontext() macro.
1389  */
1390 int
1391 set_errcontext_domain(const char *domain)
1392 {
1394 
1395  /* we don't bother incrementing recursion_depth */
1397 
1398  /* the default text domain is the backend's */
1399  edata->context_domain = domain ? domain : PG_TEXTDOMAIN("postgres");
1400 
1401  return 0; /* return value does not matter */
1402 }
1403 
1404 
1405 /*
1406  * errhidestmt --- optionally suppress STATEMENT: field of log entry
1407  *
1408  * This should be called if the message text already includes the statement.
1409  */
1410 int
1411 errhidestmt(bool hide_stmt)
1412 {
1414 
1415  /* we don't bother incrementing recursion_depth */
1417 
1418  edata->hide_stmt = hide_stmt;
1419 
1420  return 0; /* return value does not matter */
1421 }
1422 
1423 /*
1424  * errhidecontext --- optionally suppress CONTEXT: field of log entry
1425  *
1426  * This should only be used for verbose debugging messages where the repeated
1427  * inclusion of context would bloat the log volume too much.
1428  */
1429 int
1430 errhidecontext(bool hide_ctx)
1431 {
1433 
1434  /* we don't bother incrementing recursion_depth */
1436 
1437  edata->hide_ctx = hide_ctx;
1438 
1439  return 0; /* return value does not matter */
1440 }
1441 
1442 /*
1443  * errposition --- add cursor position to the current error
1444  */
1445 int
1446 errposition(int cursorpos)
1447 {
1449 
1450  /* we don't bother incrementing recursion_depth */
1452 
1453  edata->cursorpos = cursorpos;
1454 
1455  return 0; /* return value does not matter */
1456 }
1457 
1458 /*
1459  * internalerrposition --- add internal cursor position to the current error
1460  */
1461 int
1462 internalerrposition(int cursorpos)
1463 {
1465 
1466  /* we don't bother incrementing recursion_depth */
1468 
1469  edata->internalpos = cursorpos;
1470 
1471  return 0; /* return value does not matter */
1472 }
1473 
1474 /*
1475  * internalerrquery --- add internal query text to the current error
1476  *
1477  * Can also pass NULL to drop the internal query text entry. This case
1478  * is intended for use in error callback subroutines that are editorializing
1479  * on the layout of the error report.
1480  */
1481 int
1482 internalerrquery(const char *query)
1483 {
1485 
1486  /* we don't bother incrementing recursion_depth */
1488 
1489  if (edata->internalquery)
1490  {
1491  pfree(edata->internalquery);
1492  edata->internalquery = NULL;
1493  }
1494 
1495  if (query)
1496  edata->internalquery = MemoryContextStrdup(edata->assoc_context, query);
1497 
1498  return 0; /* return value does not matter */
1499 }
1500 
1501 /*
1502  * err_generic_string -- used to set individual ErrorData string fields
1503  * identified by PG_DIAG_xxx codes.
1504  *
1505  * This intentionally only supports fields that don't use localized strings,
1506  * so that there are no translation considerations.
1507  *
1508  * Most potential callers should not use this directly, but instead prefer
1509  * higher-level abstractions, such as errtablecol() (see relcache.c).
1510  */
1511 int
1512 err_generic_string(int field, const char *str)
1513 {
1515 
1516  /* we don't bother incrementing recursion_depth */
1518 
1519  switch (field)
1520  {
1521  case PG_DIAG_SCHEMA_NAME:
1522  set_errdata_field(edata->assoc_context, &edata->schema_name, str);
1523  break;
1524  case PG_DIAG_TABLE_NAME:
1525  set_errdata_field(edata->assoc_context, &edata->table_name, str);
1526  break;
1527  case PG_DIAG_COLUMN_NAME:
1528  set_errdata_field(edata->assoc_context, &edata->column_name, str);
1529  break;
1530  case PG_DIAG_DATATYPE_NAME:
1532  break;
1535  break;
1536  default:
1537  elog(ERROR, "unsupported ErrorData field id: %d", field);
1538  break;
1539  }
1540 
1541  return 0; /* return value does not matter */
1542 }
1543 
1544 /*
1545  * set_errdata_field --- set an ErrorData string field
1546  */
1547 static void
1548 set_errdata_field(MemoryContextData *cxt, char **ptr, const char *str)
1549 {
1550  Assert(*ptr == NULL);
1551  *ptr = MemoryContextStrdup(cxt, str);
1552 }
1553 
1554 /*
1555  * geterrcode --- return the currently set SQLSTATE error code
1556  *
1557  * This is only intended for use in error callback subroutines, since there
1558  * is no other place outside elog.c where the concept is meaningful.
1559  */
1560 int
1562 {
1564 
1565  /* we don't bother incrementing recursion_depth */
1567 
1568  return edata->sqlerrcode;
1569 }
1570 
1571 /*
1572  * geterrlevel --- return the currently set error level
1573  *
1574  * This is only intended for use in error callback subroutines, since there
1575  * is no other place outside elog.c where the concept is meaningful.
1576  */
1577 int
1579 {
1581 
1582  /* we don't bother incrementing recursion_depth */
1584 
1585  return edata->elevel;
1586 }
1587 
1588 /*
1589  * geterrposition --- return the currently set error position (0 if none)
1590  *
1591  * This is only intended for use in error callback subroutines, since there
1592  * is no other place outside elog.c where the concept is meaningful.
1593  */
1594 int
1596 {
1598 
1599  /* we don't bother incrementing recursion_depth */
1601 
1602  return edata->cursorpos;
1603 }
1604 
1605 /*
1606  * getinternalerrposition --- same for internal error position
1607  *
1608  * This is only intended for use in error callback subroutines, since there
1609  * is no other place outside elog.c where the concept is meaningful.
1610  */
1611 int
1613 {
1615 
1616  /* we don't bother incrementing recursion_depth */
1618 
1619  return edata->internalpos;
1620 }
1621 
1622 
1623 /*
1624  * Functions to allow construction of error message strings separately from
1625  * the ereport() call itself.
1626  *
1627  * The expected calling convention is
1628  *
1629  * pre_format_elog_string(errno, domain), var = format_elog_string(format,...)
1630  *
1631  * which can be hidden behind a macro such as GUC_check_errdetail(). We
1632  * assume that any functions called in the arguments of format_elog_string()
1633  * cannot result in re-entrant use of these functions --- otherwise the wrong
1634  * text domain might be used, or the wrong errno substituted for %m. This is
1635  * okay for the current usage with GUC check hooks, but might need further
1636  * effort someday.
1637  *
1638  * The result of format_elog_string() is stored in ErrorContext, and will
1639  * therefore survive until FlushErrorState() is called.
1640  */
1642 static const char *save_format_domain;
1643 
1644 void
1645 pre_format_elog_string(int errnumber, const char *domain)
1646 {
1647  /* Save errno before evaluation of argument functions can change it */
1648  save_format_errnumber = errnumber;
1649  /* Save caller's text domain */
1650  save_format_domain = domain;
1651 }
1652 
1653 char *
1654 format_elog_string(const char *fmt,...)
1655 {
1656  ErrorData errdata;
1657  ErrorData *edata;
1658  MemoryContext oldcontext;
1659 
1660  /* Initialize a mostly-dummy error frame */
1661  edata = &errdata;
1662  MemSet(edata, 0, sizeof(ErrorData));
1663  /* the default text domain is the backend's */
1664  edata->domain = save_format_domain ? save_format_domain : PG_TEXTDOMAIN("postgres");
1665  /* set the errno to be used to interpret %m */
1667 
1668  oldcontext = MemoryContextSwitchTo(ErrorContext);
1669 
1670  edata->message_id = fmt;
1671  EVALUATE_MESSAGE(edata->domain, message, false, true);
1672 
1673  MemoryContextSwitchTo(oldcontext);
1674 
1675  return edata->message;
1676 }
1677 
1678 
1679 /*
1680  * Actual output of the top-of-stack error message
1681  *
1682  * In the ereport(ERROR) case this is called from PostgresMain (or not at all,
1683  * if the error is caught by somebody). For all other severity levels this
1684  * is called by errfinish.
1685  */
1686 void
1688 {
1690  MemoryContext oldcontext;
1691 
1692  recursion_depth++;
1694  oldcontext = MemoryContextSwitchTo(edata->assoc_context);
1695 
1696  /*
1697  * Reset the formatted timestamp fields before emitting any logs. This
1698  * includes all the log destinations and emit_log_hook, as the latter
1699  * could use log_line_prefix or the formatted timestamps.
1700  */
1701  saved_timeval_set = false;
1702  formatted_log_time[0] = '\0';
1703 
1704  /*
1705  * Call hook before sending message to log. The hook function is allowed
1706  * to turn off edata->output_to_server, so we must recheck that afterward.
1707  * Making any other change in the content of edata is not considered
1708  * supported.
1709  *
1710  * Note: the reason why the hook can only turn off output_to_server, and
1711  * not turn it on, is that it'd be unreliable: we will never get here at
1712  * all if errstart() deems the message uninteresting. A hook that could
1713  * make decisions in that direction would have to hook into errstart(),
1714  * where it would have much less information available. emit_log_hook is
1715  * intended for custom log filtering and custom log message transmission
1716  * mechanisms.
1717  *
1718  * The log hook has access to both the translated and original English
1719  * error message text, which is passed through to allow it to be used as a
1720  * message identifier. Note that the original text is not available for
1721  * detail, detail_log, hint and context text elements.
1722  */
1723  if (edata->output_to_server && emit_log_hook)
1724  (*emit_log_hook) (edata);
1725 
1726  /* Send to server log, if enabled */
1727  if (edata->output_to_server)
1729 
1730  /* Send to client, if enabled */
1731  if (edata->output_to_client)
1732  send_message_to_frontend(edata);
1733 
1734  MemoryContextSwitchTo(oldcontext);
1735  recursion_depth--;
1736 }
1737 
1738 /*
1739  * CopyErrorData --- obtain a copy of the topmost error stack entry
1740  *
1741  * This is only for use in error handler code. The data is copied into the
1742  * current memory context, so callers should always switch away from
1743  * ErrorContext first; otherwise it will be lost when FlushErrorState is done.
1744  */
1745 ErrorData *
1747 {
1749  ErrorData *newedata;
1750 
1751  /*
1752  * we don't increment recursion_depth because out-of-memory here does not
1753  * indicate a problem within the error subsystem.
1754  */
1756 
1758 
1759  /* Copy the struct itself */
1760  newedata = (ErrorData *) palloc(sizeof(ErrorData));
1761  memcpy(newedata, edata, sizeof(ErrorData));
1762 
1763  /*
1764  * Make copies of separately-allocated strings. Note that we copy even
1765  * theoretically-constant strings such as filename. This is because those
1766  * could point into JIT-created code segments that might get unloaded at
1767  * transaction cleanup. In some cases we need the copied ErrorData to
1768  * survive transaction boundaries, so we'd better copy those strings too.
1769  */
1770  if (newedata->filename)
1771  newedata->filename = pstrdup(newedata->filename);
1772  if (newedata->funcname)
1773  newedata->funcname = pstrdup(newedata->funcname);
1774  if (newedata->domain)
1775  newedata->domain = pstrdup(newedata->domain);
1776  if (newedata->context_domain)
1777  newedata->context_domain = pstrdup(newedata->context_domain);
1778  if (newedata->message)
1779  newedata->message = pstrdup(newedata->message);
1780  if (newedata->detail)
1781  newedata->detail = pstrdup(newedata->detail);
1782  if (newedata->detail_log)
1783  newedata->detail_log = pstrdup(newedata->detail_log);
1784  if (newedata->hint)
1785  newedata->hint = pstrdup(newedata->hint);
1786  if (newedata->context)
1787  newedata->context = pstrdup(newedata->context);
1788  if (newedata->backtrace)
1789  newedata->backtrace = pstrdup(newedata->backtrace);
1790  if (newedata->message_id)
1791  newedata->message_id = pstrdup(newedata->message_id);
1792  if (newedata->schema_name)
1793  newedata->schema_name = pstrdup(newedata->schema_name);
1794  if (newedata->table_name)
1795  newedata->table_name = pstrdup(newedata->table_name);
1796  if (newedata->column_name)
1797  newedata->column_name = pstrdup(newedata->column_name);
1798  if (newedata->datatype_name)
1799  newedata->datatype_name = pstrdup(newedata->datatype_name);
1800  if (newedata->constraint_name)
1801  newedata->constraint_name = pstrdup(newedata->constraint_name);
1802  if (newedata->internalquery)
1803  newedata->internalquery = pstrdup(newedata->internalquery);
1804 
1805  /* Use the calling context for string allocation */
1806  newedata->assoc_context = CurrentMemoryContext;
1807 
1808  return newedata;
1809 }
1810 
1811 /*
1812  * FreeErrorData --- free the structure returned by CopyErrorData.
1813  *
1814  * Error handlers should use this in preference to assuming they know all
1815  * the separately-allocated fields.
1816  */
1817 void
1819 {
1820  FreeErrorDataContents(edata);
1821  pfree(edata);
1822 }
1823 
1824 /*
1825  * FreeErrorDataContents --- free the subsidiary data of an ErrorData.
1826  *
1827  * This can be used on either an error stack entry or a copied ErrorData.
1828  */
1829 static void
1831 {
1832  if (edata->message)
1833  pfree(edata->message);
1834  if (edata->detail)
1835  pfree(edata->detail);
1836  if (edata->detail_log)
1837  pfree(edata->detail_log);
1838  if (edata->hint)
1839  pfree(edata->hint);
1840  if (edata->context)
1841  pfree(edata->context);
1842  if (edata->backtrace)
1843  pfree(edata->backtrace);
1844  if (edata->schema_name)
1845  pfree(edata->schema_name);
1846  if (edata->table_name)
1847  pfree(edata->table_name);
1848  if (edata->column_name)
1849  pfree(edata->column_name);
1850  if (edata->datatype_name)
1851  pfree(edata->datatype_name);
1852  if (edata->constraint_name)
1853  pfree(edata->constraint_name);
1854  if (edata->internalquery)
1855  pfree(edata->internalquery);
1856 }
1857 
1858 /*
1859  * FlushErrorState --- flush the error state after error recovery
1860  *
1861  * This should be called by an error handler after it's done processing
1862  * the error; or as soon as it's done CopyErrorData, if it intends to
1863  * do stuff that is likely to provoke another error. You are not "out" of
1864  * the error subsystem until you have done this.
1865  */
1866 void
1868 {
1869  /*
1870  * Reset stack to empty. The only case where it would be more than one
1871  * deep is if we serviced an error that interrupted construction of
1872  * another message. We assume control escaped out of that message
1873  * construction and won't ever go back.
1874  */
1875  errordata_stack_depth = -1;
1876  recursion_depth = 0;
1877  /* Delete all data in ErrorContext */
1879 }
1880 
1881 /*
1882  * ThrowErrorData --- report an error described by an ErrorData structure
1883  *
1884  * This is somewhat like ReThrowError, but it allows elevels besides ERROR,
1885  * and the boolean flags such as output_to_server are computed via the
1886  * default rules rather than being copied from the given ErrorData.
1887  * This is primarily used to re-report errors originally reported by
1888  * background worker processes and then propagated (with or without
1889  * modification) to the backend responsible for them.
1890  */
1891 void
1893 {
1894  ErrorData *newedata;
1895  MemoryContext oldcontext;
1896 
1897  if (!errstart(edata->elevel, edata->domain))
1898  return; /* error is not to be reported at all */
1899 
1900  newedata = &errordata[errordata_stack_depth];
1901  recursion_depth++;
1902  oldcontext = MemoryContextSwitchTo(newedata->assoc_context);
1903 
1904  /* Copy the supplied fields to the error stack entry. */
1905  if (edata->sqlerrcode != 0)
1906  newedata->sqlerrcode = edata->sqlerrcode;
1907  if (edata->message)
1908  newedata->message = pstrdup(edata->message);
1909  if (edata->detail)
1910  newedata->detail = pstrdup(edata->detail);
1911  if (edata->detail_log)
1912  newedata->detail_log = pstrdup(edata->detail_log);
1913  if (edata->hint)
1914  newedata->hint = pstrdup(edata->hint);
1915  if (edata->context)
1916  newedata->context = pstrdup(edata->context);
1917  if (edata->backtrace)
1918  newedata->backtrace = pstrdup(edata->backtrace);
1919  /* assume message_id is not available */
1920  if (edata->schema_name)
1921  newedata->schema_name = pstrdup(edata->schema_name);
1922  if (edata->table_name)
1923  newedata->table_name = pstrdup(edata->table_name);
1924  if (edata->column_name)
1925  newedata->column_name = pstrdup(edata->column_name);
1926  if (edata->datatype_name)
1927  newedata->datatype_name = pstrdup(edata->datatype_name);
1928  if (edata->constraint_name)
1929  newedata->constraint_name = pstrdup(edata->constraint_name);
1930  newedata->cursorpos = edata->cursorpos;
1931  newedata->internalpos = edata->internalpos;
1932  if (edata->internalquery)
1933  newedata->internalquery = pstrdup(edata->internalquery);
1934 
1935  MemoryContextSwitchTo(oldcontext);
1936  recursion_depth--;
1937 
1938  /* Process the error. */
1939  errfinish(edata->filename, edata->lineno, edata->funcname);
1940 }
1941 
1942 /*
1943  * ReThrowError --- re-throw a previously copied error
1944  *
1945  * A handler can do CopyErrorData/FlushErrorState to get out of the error
1946  * subsystem, then do some processing, and finally ReThrowError to re-throw
1947  * the original error. This is slower than just PG_RE_THROW() but should
1948  * be used if the "some processing" is likely to incur another error.
1949  */
1950 void
1952 {
1953  ErrorData *newedata;
1954 
1955  Assert(edata->elevel == ERROR);
1956 
1957  /* Push the data back into the error context */
1958  recursion_depth++;
1960 
1961  newedata = get_error_stack_entry();
1962  memcpy(newedata, edata, sizeof(ErrorData));
1963 
1964  /* Make copies of separately-allocated fields */
1965  if (newedata->message)
1966  newedata->message = pstrdup(newedata->message);
1967  if (newedata->detail)
1968  newedata->detail = pstrdup(newedata->detail);
1969  if (newedata->detail_log)
1970  newedata->detail_log = pstrdup(newedata->detail_log);
1971  if (newedata->hint)
1972  newedata->hint = pstrdup(newedata->hint);
1973  if (newedata->context)
1974  newedata->context = pstrdup(newedata->context);
1975  if (newedata->backtrace)
1976  newedata->backtrace = pstrdup(newedata->backtrace);
1977  if (newedata->schema_name)
1978  newedata->schema_name = pstrdup(newedata->schema_name);
1979  if (newedata->table_name)
1980  newedata->table_name = pstrdup(newedata->table_name);
1981  if (newedata->column_name)
1982  newedata->column_name = pstrdup(newedata->column_name);
1983  if (newedata->datatype_name)
1984  newedata->datatype_name = pstrdup(newedata->datatype_name);
1985  if (newedata->constraint_name)
1986  newedata->constraint_name = pstrdup(newedata->constraint_name);
1987  if (newedata->internalquery)
1988  newedata->internalquery = pstrdup(newedata->internalquery);
1989 
1990  /* Reset the assoc_context to be ErrorContext */
1991  newedata->assoc_context = ErrorContext;
1992 
1993  recursion_depth--;
1994  PG_RE_THROW();
1995 }
1996 
1997 /*
1998  * pg_re_throw --- out-of-line implementation of PG_RE_THROW() macro
1999  */
2000 void
2002 {
2003  /* If possible, throw the error to the next outer setjmp handler */
2004  if (PG_exception_stack != NULL)
2005  siglongjmp(*PG_exception_stack, 1);
2006  else
2007  {
2008  /*
2009  * If we get here, elog(ERROR) was thrown inside a PG_TRY block, which
2010  * we have now exited only to discover that there is no outer setjmp
2011  * handler to pass the error to. Had the error been thrown outside
2012  * the block to begin with, we'd have promoted the error to FATAL, so
2013  * the correct behavior is to make it FATAL now; that is, emit it and
2014  * then call proc_exit.
2015  */
2017 
2019  Assert(edata->elevel == ERROR);
2020  edata->elevel = FATAL;
2021 
2022  /*
2023  * At least in principle, the increase in severity could have changed
2024  * where-to-output decisions, so recalculate.
2025  */
2028 
2029  /*
2030  * We can use errfinish() for the rest, but we don't want it to call
2031  * any error context routines a second time. Since we know we are
2032  * about to exit, it should be OK to just clear the context stack.
2033  */
2034  error_context_stack = NULL;
2035 
2036  errfinish(edata->filename, edata->lineno, edata->funcname);
2037  }
2038 
2039  /* Doesn't return ... */
2040  ExceptionalCondition("pg_re_throw tried to return", __FILE__, __LINE__);
2041 }
2042 
2043 
2044 /*
2045  * GetErrorContextStack - Return the context stack, for display/diags
2046  *
2047  * Returns a pstrdup'd string in the caller's context which includes the PG
2048  * error call stack. It is the caller's responsibility to ensure this string
2049  * is pfree'd (or its context cleaned up) when done.
2050  *
2051  * This information is collected by traversing the error contexts and calling
2052  * each context's callback function, each of which is expected to call
2053  * errcontext() to return a string which can be presented to the user.
2054  */
2055 char *
2057 {
2058  ErrorData *edata;
2059  ErrorContextCallback *econtext;
2060 
2061  /*
2062  * Crank up a stack entry to store the info in.
2063  */
2064  recursion_depth++;
2065 
2066  edata = get_error_stack_entry();
2067 
2068  /*
2069  * Set up assoc_context to be the caller's context, so any allocations
2070  * done (which will include edata->context) will use their context.
2071  */
2073 
2074  /*
2075  * Call any context callback functions to collect the context information
2076  * into edata->context.
2077  *
2078  * Errors occurring in callback functions should go through the regular
2079  * error handling code which should handle any recursive errors, though we
2080  * double-check above, just in case.
2081  */
2082  for (econtext = error_context_stack;
2083  econtext != NULL;
2084  econtext = econtext->previous)
2085  econtext->callback(econtext->arg);
2086 
2087  /*
2088  * Clean ourselves off the stack, any allocations done should have been
2089  * using edata->assoc_context, which we set up earlier to be the caller's
2090  * context, so we're free to just remove our entry off the stack and
2091  * decrement recursion depth and exit.
2092  */
2094  recursion_depth--;
2095 
2096  /*
2097  * Return a pointer to the string the caller asked for, which should have
2098  * been allocated in their context.
2099  */
2100  return edata->context;
2101 }
2102 
2103 
2104 /*
2105  * Initialization of error output file
2106  */
2107 void
2109 {
2110  int fd,
2111  istty;
2112 
2113  if (OutputFileName[0])
2114  {
2115  /*
2116  * A debug-output file name was given.
2117  *
2118  * Make sure we can write the file, and find out if it's a tty.
2119  */
2120  if ((fd = open(OutputFileName, O_CREAT | O_APPEND | O_WRONLY,
2121  0666)) < 0)
2122  ereport(FATAL,
2124  errmsg("could not open file \"%s\": %m", OutputFileName)));
2125  istty = isatty(fd);
2126  close(fd);
2127 
2128  /*
2129  * Redirect our stderr to the debug output file.
2130  */
2131  if (!freopen(OutputFileName, "a", stderr))
2132  ereport(FATAL,
2134  errmsg("could not reopen file \"%s\" as stderr: %m",
2135  OutputFileName)));
2136 
2137  /*
2138  * If the file is a tty and we're running under the postmaster, try to
2139  * send stdout there as well (if it isn't a tty then stderr will block
2140  * out stdout, so we may as well let stdout go wherever it was going
2141  * before).
2142  */
2143  if (istty && IsUnderPostmaster)
2144  if (!freopen(OutputFileName, "a", stdout))
2145  ereport(FATAL,
2147  errmsg("could not reopen file \"%s\" as stdout: %m",
2148  OutputFileName)));
2149  }
2150 }
2151 
2152 
2153 /*
2154  * GUC check_hook for backtrace_functions
2155  *
2156  * We split the input string, where commas separate function names
2157  * and certain whitespace chars are ignored, into a \0-separated (and
2158  * \0\0-terminated) list of function names. This formulation allows
2159  * easy scanning when an error is thrown while avoiding the use of
2160  * non-reentrant strtok(), as well as keeping the output data in a
2161  * single palloc() chunk.
2162  */
2163 bool
2165 {
2166  int newvallen = strlen(*newval);
2167  char *someval;
2168  int validlen;
2169  int i;
2170  int j;
2171 
2172  /*
2173  * Allow characters that can be C identifiers and commas as separators, as
2174  * well as some whitespace for readability.
2175  */
2176  validlen = strspn(*newval,
2177  "0123456789_"
2178  "abcdefghijklmnopqrstuvwxyz"
2179  "ABCDEFGHIJKLMNOPQRSTUVWXYZ"
2180  ", \n\t");
2181  if (validlen != newvallen)
2182  {
2183  GUC_check_errdetail("Invalid character");
2184  return false;
2185  }
2186 
2187  if (*newval[0] == '\0')
2188  {
2189  *extra = NULL;
2190  return true;
2191  }
2192 
2193  /*
2194  * Allocate space for the output and create the copy. We could discount
2195  * whitespace chars to save some memory, but it doesn't seem worth the
2196  * trouble.
2197  */
2198  someval = guc_malloc(ERROR, newvallen + 1 + 1);
2199  for (i = 0, j = 0; i < newvallen; i++)
2200  {
2201  if ((*newval)[i] == ',')
2202  someval[j++] = '\0'; /* next item */
2203  else if ((*newval)[i] == ' ' ||
2204  (*newval)[i] == '\n' ||
2205  (*newval)[i] == '\t')
2206  ; /* ignore these */
2207  else
2208  someval[j++] = (*newval)[i]; /* copy anything else */
2209  }
2210 
2211  /* two \0s end the setting */
2212  someval[j] = '\0';
2213  someval[j + 1] = '\0';
2214 
2215  *extra = someval;
2216  return true;
2217 }
2218 
2219 /*
2220  * GUC assign_hook for backtrace_functions
2221  */
2222 void
2223 assign_backtrace_functions(const char *newval, void *extra)
2224 {
2225  backtrace_function_list = (char *) extra;
2226 }
2227 
2228 /*
2229  * GUC check_hook for log_destination
2230  */
2231 bool
2233 {
2234  char *rawstring;
2235  List *elemlist;
2236  ListCell *l;
2237  int newlogdest = 0;
2238  int *myextra;
2239 
2240  /* Need a modifiable copy of string */
2241  rawstring = pstrdup(*newval);
2242 
2243  /* Parse string into list of identifiers */
2244  if (!SplitIdentifierString(rawstring, ',', &elemlist))
2245  {
2246  /* syntax error in list */
2247  GUC_check_errdetail("List syntax is invalid.");
2248  pfree(rawstring);
2249  list_free(elemlist);
2250  return false;
2251  }
2252 
2253  foreach(l, elemlist)
2254  {
2255  char *tok = (char *) lfirst(l);
2256 
2257  if (pg_strcasecmp(tok, "stderr") == 0)
2258  newlogdest |= LOG_DESTINATION_STDERR;
2259  else if (pg_strcasecmp(tok, "csvlog") == 0)
2260  newlogdest |= LOG_DESTINATION_CSVLOG;
2261  else if (pg_strcasecmp(tok, "jsonlog") == 0)
2262  newlogdest |= LOG_DESTINATION_JSONLOG;
2263 #ifdef HAVE_SYSLOG
2264  else if (pg_strcasecmp(tok, "syslog") == 0)
2265  newlogdest |= LOG_DESTINATION_SYSLOG;
2266 #endif
2267 #ifdef WIN32
2268  else if (pg_strcasecmp(tok, "eventlog") == 0)
2269  newlogdest |= LOG_DESTINATION_EVENTLOG;
2270 #endif
2271  else
2272  {
2273  GUC_check_errdetail("Unrecognized key word: \"%s\".", tok);
2274  pfree(rawstring);
2275  list_free(elemlist);
2276  return false;
2277  }
2278  }
2279 
2280  pfree(rawstring);
2281  list_free(elemlist);
2282 
2283  myextra = (int *) guc_malloc(ERROR, sizeof(int));
2284  *myextra = newlogdest;
2285  *extra = (void *) myextra;
2286 
2287  return true;
2288 }
2289 
2290 /*
2291  * GUC assign_hook for log_destination
2292  */
2293 void
2294 assign_log_destination(const char *newval, void *extra)
2295 {
2296  Log_destination = *((int *) extra);
2297 }
2298 
2299 /*
2300  * GUC assign_hook for syslog_ident
2301  */
2302 void
2303 assign_syslog_ident(const char *newval, void *extra)
2304 {
2305 #ifdef HAVE_SYSLOG
2306  /*
2307  * guc.c is likely to call us repeatedly with same parameters, so don't
2308  * thrash the syslog connection unnecessarily. Also, we do not re-open
2309  * the connection until needed, since this routine will get called whether
2310  * or not Log_destination actually mentions syslog.
2311  *
2312  * Note that we make our own copy of the ident string rather than relying
2313  * on guc.c's. This may be overly paranoid, but it ensures that we cannot
2314  * accidentally free a string that syslog is still using.
2315  */
2316  if (syslog_ident == NULL || strcmp(syslog_ident, newval) != 0)
2317  {
2318  if (openlog_done)
2319  {
2320  closelog();
2321  openlog_done = false;
2322  }
2323  free(syslog_ident);
2324  syslog_ident = strdup(newval);
2325  /* if the strdup fails, we will cope in write_syslog() */
2326  }
2327 #endif
2328  /* Without syslog support, just ignore it */
2329 }
2330 
2331 /*
2332  * GUC assign_hook for syslog_facility
2333  */
2334 void
2336 {
2337 #ifdef HAVE_SYSLOG
2338  /*
2339  * As above, don't thrash the syslog connection unnecessarily.
2340  */
2341  if (syslog_facility != newval)
2342  {
2343  if (openlog_done)
2344  {
2345  closelog();
2346  openlog_done = false;
2347  }
2349  }
2350 #endif
2351  /* Without syslog support, just ignore it */
2352 }
2353 
2354 #ifdef HAVE_SYSLOG
2355 
2356 /*
2357  * Write a message line to syslog
2358  */
2359 static void
2360 write_syslog(int level, const char *line)
2361 {
2362  static unsigned long seq = 0;
2363 
2364  int len;
2365  const char *nlpos;
2366 
2367  /* Open syslog connection if not done yet */
2368  if (!openlog_done)
2369  {
2370  openlog(syslog_ident ? syslog_ident : "postgres",
2371  LOG_PID | LOG_NDELAY | LOG_NOWAIT,
2372  syslog_facility);
2373  openlog_done = true;
2374  }
2375 
2376  /*
2377  * We add a sequence number to each log message to suppress "same"
2378  * messages.
2379  */
2380  seq++;
2381 
2382  /*
2383  * Our problem here is that many syslog implementations don't handle long
2384  * messages in an acceptable manner. While this function doesn't help that
2385  * fact, it does work around by splitting up messages into smaller pieces.
2386  *
2387  * We divide into multiple syslog() calls if message is too long or if the
2388  * message contains embedded newline(s).
2389  */
2390  len = strlen(line);
2391  nlpos = strchr(line, '\n');
2392  if (syslog_split_messages && (len > PG_SYSLOG_LIMIT || nlpos != NULL))
2393  {
2394  int chunk_nr = 0;
2395 
2396  while (len > 0)
2397  {
2398  char buf[PG_SYSLOG_LIMIT + 1];
2399  int buflen;
2400  int i;
2401 
2402  /* if we start at a newline, move ahead one char */
2403  if (line[0] == '\n')
2404  {
2405  line++;
2406  len--;
2407  /* we need to recompute the next newline's position, too */
2408  nlpos = strchr(line, '\n');
2409  continue;
2410  }
2411 
2412  /* copy one line, or as much as will fit, to buf */
2413  if (nlpos != NULL)
2414  buflen = nlpos - line;
2415  else
2416  buflen = len;
2417  buflen = Min(buflen, PG_SYSLOG_LIMIT);
2418  memcpy(buf, line, buflen);
2419  buf[buflen] = '\0';
2420 
2421  /* trim to multibyte letter boundary */
2422  buflen = pg_mbcliplen(buf, buflen, buflen);
2423  if (buflen <= 0)
2424  return;
2425  buf[buflen] = '\0';
2426 
2427  /* already word boundary? */
2428  if (line[buflen] != '\0' &&
2429  !isspace((unsigned char) line[buflen]))
2430  {
2431  /* try to divide at word boundary */
2432  i = buflen - 1;
2433  while (i > 0 && !isspace((unsigned char) buf[i]))
2434  i--;
2435 
2436  if (i > 0) /* else couldn't divide word boundary */
2437  {
2438  buflen = i;
2439  buf[i] = '\0';
2440  }
2441  }
2442 
2443  chunk_nr++;
2444 
2446  syslog(level, "[%lu-%d] %s", seq, chunk_nr, buf);
2447  else
2448  syslog(level, "[%d] %s", chunk_nr, buf);
2449 
2450  line += buflen;
2451  len -= buflen;
2452  }
2453  }
2454  else
2455  {
2456  /* message short enough */
2458  syslog(level, "[%lu] %s", seq, line);
2459  else
2460  syslog(level, "%s", line);
2461  }
2462 }
2463 #endif /* HAVE_SYSLOG */
2464 
2465 #ifdef WIN32
2466 /*
2467  * Get the PostgreSQL equivalent of the Windows ANSI code page. "ANSI" system
2468  * interfaces (e.g. CreateFileA()) expect string arguments in this encoding.
2469  * Every process in a given system will find the same value at all times.
2470  */
2471 static int
2472 GetACPEncoding(void)
2473 {
2474  static int encoding = -2;
2475 
2476  if (encoding == -2)
2477  encoding = pg_codepage_to_encoding(GetACP());
2478 
2479  return encoding;
2480 }
2481 
2482 /*
2483  * Write a message line to the windows event log
2484  */
2485 static void
2486 write_eventlog(int level, const char *line, int len)
2487 {
2488  WCHAR *utf16;
2489  int eventlevel = EVENTLOG_ERROR_TYPE;
2490  static HANDLE evtHandle = INVALID_HANDLE_VALUE;
2491 
2492  if (evtHandle == INVALID_HANDLE_VALUE)
2493  {
2494  evtHandle = RegisterEventSource(NULL,
2496  if (evtHandle == NULL)
2497  {
2498  evtHandle = INVALID_HANDLE_VALUE;
2499  return;
2500  }
2501  }
2502 
2503  switch (level)
2504  {
2505  case DEBUG5:
2506  case DEBUG4:
2507  case DEBUG3:
2508  case DEBUG2:
2509  case DEBUG1:
2510  case LOG:
2511  case LOG_SERVER_ONLY:
2512  case INFO:
2513  case NOTICE:
2514  eventlevel = EVENTLOG_INFORMATION_TYPE;
2515  break;
2516  case WARNING:
2517  case WARNING_CLIENT_ONLY:
2518  eventlevel = EVENTLOG_WARNING_TYPE;
2519  break;
2520  case ERROR:
2521  case FATAL:
2522  case PANIC:
2523  default:
2524  eventlevel = EVENTLOG_ERROR_TYPE;
2525  break;
2526  }
2527 
2528  /*
2529  * If message character encoding matches the encoding expected by
2530  * ReportEventA(), call it to avoid the hazards of conversion. Otherwise,
2531  * try to convert the message to UTF16 and write it with ReportEventW().
2532  * Fall back on ReportEventA() if conversion failed.
2533  *
2534  * Since we palloc the structure required for conversion, also fall
2535  * through to writing unconverted if we have not yet set up
2536  * CurrentMemoryContext.
2537  *
2538  * Also verify that we are not on our way into error recursion trouble due
2539  * to error messages thrown deep inside pgwin32_message_to_UTF16().
2540  */
2541  if (!in_error_recursion_trouble() &&
2542  CurrentMemoryContext != NULL &&
2543  GetMessageEncoding() != GetACPEncoding())
2544  {
2545  utf16 = pgwin32_message_to_UTF16(line, len, NULL);
2546  if (utf16)
2547  {
2548  ReportEventW(evtHandle,
2549  eventlevel,
2550  0,
2551  0, /* All events are Id 0 */
2552  NULL,
2553  1,
2554  0,
2555  (LPCWSTR *) &utf16,
2556  NULL);
2557  /* XXX Try ReportEventA() when ReportEventW() fails? */
2558 
2559  pfree(utf16);
2560  return;
2561  }
2562  }
2563  ReportEventA(evtHandle,
2564  eventlevel,
2565  0,
2566  0, /* All events are Id 0 */
2567  NULL,
2568  1,
2569  0,
2570  &line,
2571  NULL);
2572 }
2573 #endif /* WIN32 */
2574 
2575 static void
2576 write_console(const char *line, int len)
2577 {
2578  int rc;
2579 
2580 #ifdef WIN32
2581 
2582  /*
2583  * Try to convert the message to UTF16 and write it with WriteConsoleW().
2584  * Fall back on write() if anything fails.
2585  *
2586  * In contrast to write_eventlog(), don't skip straight to write() based
2587  * on the applicable encodings. Unlike WriteConsoleW(), write() depends
2588  * on the suitability of the console output code page. Since we put
2589  * stderr into binary mode in SubPostmasterMain(), write() skips the
2590  * necessary translation anyway.
2591  *
2592  * WriteConsoleW() will fail if stderr is redirected, so just fall through
2593  * to writing unconverted to the logfile in this case.
2594  *
2595  * Since we palloc the structure required for conversion, also fall
2596  * through to writing unconverted if we have not yet set up
2597  * CurrentMemoryContext.
2598  */
2599  if (!in_error_recursion_trouble() &&
2600  !redirection_done &&
2601  CurrentMemoryContext != NULL)
2602  {
2603  WCHAR *utf16;
2604  int utf16len;
2605 
2606  utf16 = pgwin32_message_to_UTF16(line, len, &utf16len);
2607  if (utf16 != NULL)
2608  {
2609  HANDLE stdHandle;
2610  DWORD written;
2611 
2612  stdHandle = GetStdHandle(STD_ERROR_HANDLE);
2613  if (WriteConsoleW(stdHandle, utf16, utf16len, &written, NULL))
2614  {
2615  pfree(utf16);
2616  return;
2617  }
2618 
2619  /*
2620  * In case WriteConsoleW() failed, fall back to writing the
2621  * message unconverted.
2622  */
2623  pfree(utf16);
2624  }
2625  }
2626 #else
2627 
2628  /*
2629  * Conversion on non-win32 platforms is not implemented yet. It requires
2630  * non-throw version of pg_do_encoding_conversion(), that converts
2631  * unconvertible characters to '?' without errors.
2632  *
2633  * XXX: We have a no-throw version now. It doesn't convert to '?' though.
2634  */
2635 #endif
2636 
2637  /*
2638  * We ignore any error from write() here. We have no useful way to report
2639  * it ... certainly whining on stderr isn't likely to be productive.
2640  */
2641  rc = write(fileno(stderr), line, len);
2642  (void) rc;
2643 }
2644 
2645 /*
2646  * get_formatted_log_time -- compute and get the log timestamp.
2647  *
2648  * The timestamp is computed if not set yet, so as it is kept consistent
2649  * among all the log destinations that require it to be consistent. Note
2650  * that the computed timestamp is returned in a static buffer, not
2651  * palloc()'d.
2652  */
2653 char *
2655 {
2656  pg_time_t stamp_time;
2657  char msbuf[13];
2658 
2659  /* leave if already computed */
2660  if (formatted_log_time[0] != '\0')
2661  return formatted_log_time;
2662 
2663  if (!saved_timeval_set)
2664  {
2665  gettimeofday(&saved_timeval, NULL);
2666  saved_timeval_set = true;
2667  }
2668 
2669  stamp_time = (pg_time_t) saved_timeval.tv_sec;
2670 
2671  /*
2672  * Note: we expect that guc.c will ensure that log_timezone is set up (at
2673  * least with a minimal GMT value) before Log_line_prefix can become
2674  * nonempty or CSV/JSON mode can be selected.
2675  */
2677  /* leave room for milliseconds... */
2678  "%Y-%m-%d %H:%M:%S %Z",
2679  pg_localtime(&stamp_time, log_timezone));
2680 
2681  /* 'paste' milliseconds into place... */
2682  sprintf(msbuf, ".%03d", (int) (saved_timeval.tv_usec / 1000));
2683  memcpy(formatted_log_time + 19, msbuf, 4);
2684 
2685  return formatted_log_time;
2686 }
2687 
2688 /*
2689  * reset_formatted_start_time -- reset the start timestamp
2690  */
2691 void
2693 {
2694  formatted_start_time[0] = '\0';
2695 }
2696 
2697 /*
2698  * get_formatted_start_time -- compute and get the start timestamp.
2699  *
2700  * The timestamp is computed if not set yet. Note that the computed
2701  * timestamp is returned in a static buffer, not palloc()'d.
2702  */
2703 char *
2705 {
2706  pg_time_t stamp_time = (pg_time_t) MyStartTime;
2707 
2708  /* leave if already computed */
2709  if (formatted_start_time[0] != '\0')
2710  return formatted_start_time;
2711 
2712  /*
2713  * Note: we expect that guc.c will ensure that log_timezone is set up (at
2714  * least with a minimal GMT value) before Log_line_prefix can become
2715  * nonempty or CSV/JSON mode can be selected.
2716  */
2718  "%Y-%m-%d %H:%M:%S %Z",
2719  pg_localtime(&stamp_time, log_timezone));
2720 
2721  return formatted_start_time;
2722 }
2723 
2724 /*
2725  * check_log_of_query -- check if a query can be logged
2726  */
2727 bool
2729 {
2730  /* log required? */
2732  return false;
2733 
2734  /* query log wanted? */
2735  if (edata->hide_stmt)
2736  return false;
2737 
2738  /* query string available? */
2739  if (debug_query_string == NULL)
2740  return false;
2741 
2742  return true;
2743 }
2744 
2745 /*
2746  * get_backend_type_for_log -- backend type for log entries
2747  *
2748  * Returns a pointer to a static buffer, not palloc()'d.
2749  */
2750 const char *
2752 {
2753  const char *backend_type_str;
2754 
2755  if (MyProcPid == PostmasterPid)
2756  backend_type_str = "postmaster";
2757  else if (MyBackendType == B_BG_WORKER)
2758  backend_type_str = MyBgworkerEntry->bgw_type;
2759  else
2760  backend_type_str = GetBackendTypeDesc(MyBackendType);
2761 
2762  return backend_type_str;
2763 }
2764 
2765 /*
2766  * process_log_prefix_padding --- helper function for processing the format
2767  * string in log_line_prefix
2768  *
2769  * Note: This function returns NULL if it finds something which
2770  * it deems invalid in the format string.
2771  */
2772 static const char *
2773 process_log_prefix_padding(const char *p, int *ppadding)
2774 {
2775  int paddingsign = 1;
2776  int padding = 0;
2777 
2778  if (*p == '-')
2779  {
2780  p++;
2781 
2782  if (*p == '\0') /* Did the buf end in %- ? */
2783  return NULL;
2784  paddingsign = -1;
2785  }
2786 
2787  /* generate an int version of the numerical string */
2788  while (*p >= '0' && *p <= '9')
2789  padding = padding * 10 + (*p++ - '0');
2790 
2791  /* format is invalid if it ends with the padding number */
2792  if (*p == '\0')
2793  return NULL;
2794 
2795  padding *= paddingsign;
2796  *ppadding = padding;
2797  return p;
2798 }
2799 
2800 /*
2801  * Format log status information using Log_line_prefix.
2802  */
2803 static void
2805 {
2807 }
2808 
2809 /*
2810  * Format log status info; append to the provided buffer.
2811  */
2812 void
2814 {
2815  /* static counter for line numbers */
2816  static long log_line_number = 0;
2817 
2818  /* has counter been reset in current process? */
2819  static int log_my_pid = 0;
2820  int padding;
2821  const char *p;
2822 
2823  /*
2824  * This is one of the few places where we'd rather not inherit a static
2825  * variable's value from the postmaster. But since we will, reset it when
2826  * MyProcPid changes. MyStartTime also changes when MyProcPid does, so
2827  * reset the formatted start timestamp too.
2828  */
2829  if (log_my_pid != MyProcPid)
2830  {
2831  log_line_number = 0;
2832  log_my_pid = MyProcPid;
2834  }
2835  log_line_number++;
2836 
2837  if (format == NULL)
2838  return; /* in case guc hasn't run yet */
2839 
2840  for (p = format; *p != '\0'; p++)
2841  {
2842  if (*p != '%')
2843  {
2844  /* literal char, just copy */
2846  continue;
2847  }
2848 
2849  /* must be a '%', so skip to the next char */
2850  p++;
2851  if (*p == '\0')
2852  break; /* format error - ignore it */
2853  else if (*p == '%')
2854  {
2855  /* string contains %% */
2856  appendStringInfoChar(buf, '%');
2857  continue;
2858  }
2859 
2860 
2861  /*
2862  * Process any formatting which may exist after the '%'. Note that
2863  * process_log_prefix_padding moves p past the padding number if it
2864  * exists.
2865  *
2866  * Note: Since only '-', '0' to '9' are valid formatting characters we
2867  * can do a quick check here to pre-check for formatting. If the char
2868  * is not formatting then we can skip a useless function call.
2869  *
2870  * Further note: At least on some platforms, passing %*s rather than
2871  * %s to appendStringInfo() is substantially slower, so many of the
2872  * cases below avoid doing that unless non-zero padding is in fact
2873  * specified.
2874  */
2875  if (*p > '9')
2876  padding = 0;
2877  else if ((p = process_log_prefix_padding(p, &padding)) == NULL)
2878  break;
2879 
2880  /* process the option */
2881  switch (*p)
2882  {
2883  case 'a':
2884  if (MyProcPort)
2885  {
2886  const char *appname = application_name;
2887 
2888  if (appname == NULL || *appname == '\0')
2889  appname = _("[unknown]");
2890  if (padding != 0)
2891  appendStringInfo(buf, "%*s", padding, appname);
2892  else
2893  appendStringInfoString(buf, appname);
2894  }
2895  else if (padding != 0)
2897  padding > 0 ? padding : -padding);
2898 
2899  break;
2900  case 'b':
2901  {
2902  const char *backend_type_str = get_backend_type_for_log();
2903 
2904  if (padding != 0)
2905  appendStringInfo(buf, "%*s", padding, backend_type_str);
2906  else
2907  appendStringInfoString(buf, backend_type_str);
2908  break;
2909  }
2910  case 'u':
2911  if (MyProcPort)
2912  {
2913  const char *username = MyProcPort->user_name;
2914 
2915  if (username == NULL || *username == '\0')
2916  username = _("[unknown]");
2917  if (padding != 0)
2918  appendStringInfo(buf, "%*s", padding, username);
2919  else
2921  }
2922  else if (padding != 0)
2924  padding > 0 ? padding : -padding);
2925  break;
2926  case 'd':
2927  if (MyProcPort)
2928  {
2929  const char *dbname = MyProcPort->database_name;
2930 
2931  if (dbname == NULL || *dbname == '\0')
2932  dbname = _("[unknown]");
2933  if (padding != 0)
2934  appendStringInfo(buf, "%*s", padding, dbname);
2935  else
2937  }
2938  else if (padding != 0)
2940  padding > 0 ? padding : -padding);
2941  break;
2942  case 'c':
2943  if (padding != 0)
2944  {
2945  char strfbuf[128];
2946 
2947  snprintf(strfbuf, sizeof(strfbuf) - 1, "%lx.%x",
2948  (long) (MyStartTime), MyProcPid);
2949  appendStringInfo(buf, "%*s", padding, strfbuf);
2950  }
2951  else
2952  appendStringInfo(buf, "%lx.%x", (long) (MyStartTime), MyProcPid);
2953  break;
2954  case 'p':
2955  if (padding != 0)
2956  appendStringInfo(buf, "%*d", padding, MyProcPid);
2957  else
2958  appendStringInfo(buf, "%d", MyProcPid);
2959  break;
2960 
2961  case 'P':
2962  if (MyProc)
2963  {
2964  PGPROC *leader = MyProc->lockGroupLeader;
2965 
2966  /*
2967  * Show the leader only for active parallel workers. This
2968  * leaves out the leader of a parallel group.
2969  */
2970  if (leader == NULL || leader->pid == MyProcPid)
2972  padding > 0 ? padding : -padding);
2973  else if (padding != 0)
2974  appendStringInfo(buf, "%*d", padding, leader->pid);
2975  else
2976  appendStringInfo(buf, "%d", leader->pid);
2977  }
2978  else if (padding != 0)
2980  padding > 0 ? padding : -padding);
2981  break;
2982 
2983  case 'l':
2984  if (padding != 0)
2985  appendStringInfo(buf, "%*ld", padding, log_line_number);
2986  else
2987  appendStringInfo(buf, "%ld", log_line_number);
2988  break;
2989  case 'm':
2990  /* force a log timestamp reset */
2991  formatted_log_time[0] = '\0';
2992  (void) get_formatted_log_time();
2993 
2994  if (padding != 0)
2995  appendStringInfo(buf, "%*s", padding, formatted_log_time);
2996  else
2998  break;
2999  case 't':
3000  {
3001  pg_time_t stamp_time = (pg_time_t) time(NULL);
3002  char strfbuf[128];
3003 
3004  pg_strftime(strfbuf, sizeof(strfbuf),
3005  "%Y-%m-%d %H:%M:%S %Z",
3006  pg_localtime(&stamp_time, log_timezone));
3007  if (padding != 0)
3008  appendStringInfo(buf, "%*s", padding, strfbuf);
3009  else
3010  appendStringInfoString(buf, strfbuf);
3011  }
3012  break;
3013  case 'n':
3014  {
3015  char strfbuf[128];
3016 
3017  if (!saved_timeval_set)
3018  {
3019  gettimeofday(&saved_timeval, NULL);
3020  saved_timeval_set = true;
3021  }
3022 
3023  snprintf(strfbuf, sizeof(strfbuf), "%ld.%03d",
3024  (long) saved_timeval.tv_sec,
3025  (int) (saved_timeval.tv_usec / 1000));
3026 
3027  if (padding != 0)
3028  appendStringInfo(buf, "%*s", padding, strfbuf);
3029  else
3030  appendStringInfoString(buf, strfbuf);
3031  }
3032  break;
3033  case 's':
3034  {
3036 
3037  if (padding != 0)
3038  appendStringInfo(buf, "%*s", padding, start_time);
3039  else
3041  }
3042  break;
3043  case 'i':
3044  if (MyProcPort)
3045  {
3046  const char *psdisp;
3047  int displen;
3048 
3049  psdisp = get_ps_display(&displen);
3050  if (padding != 0)
3051  appendStringInfo(buf, "%*s", padding, psdisp);
3052  else
3053  appendBinaryStringInfo(buf, psdisp, displen);
3054  }
3055  else if (padding != 0)
3057  padding > 0 ? padding : -padding);
3058  break;
3059  case 'r':
3061  {
3062  if (padding != 0)
3063  {
3064  if (MyProcPort->remote_port && MyProcPort->remote_port[0] != '\0')
3065  {
3066  /*
3067  * This option is slightly special as the port
3068  * number may be appended onto the end. Here we
3069  * need to build 1 string which contains the
3070  * remote_host and optionally the remote_port (if
3071  * set) so we can properly align the string.
3072  */
3073 
3074  char *hostport;
3075 
3076  hostport = psprintf("%s(%s)", MyProcPort->remote_host, MyProcPort->remote_port);
3077  appendStringInfo(buf, "%*s", padding, hostport);
3078  pfree(hostport);
3079  }
3080  else
3081  appendStringInfo(buf, "%*s", padding, MyProcPort->remote_host);
3082  }
3083  else
3084  {
3085  /* padding is 0, so we don't need a temp buffer */
3087  if (MyProcPort->remote_port &&
3088  MyProcPort->remote_port[0] != '\0')
3089  appendStringInfo(buf, "(%s)",
3091  }
3092  }
3093  else if (padding != 0)
3095  padding > 0 ? padding : -padding);
3096  break;
3097  case 'h':
3099  {
3100  if (padding != 0)
3101  appendStringInfo(buf, "%*s", padding, MyProcPort->remote_host);
3102  else
3104  }
3105  else if (padding != 0)
3107  padding > 0 ? padding : -padding);
3108  break;
3109  case 'q':
3110  /* in postmaster and friends, stop if %q is seen */
3111  /* in a backend, just ignore */
3112  if (MyProcPort == NULL)
3113  return;
3114  break;
3115  case 'v':
3116  /* keep VXID format in sync with lockfuncs.c */
3117  if (MyProc != NULL && MyProc->vxid.procNumber != INVALID_PROC_NUMBER)
3118  {
3119  if (padding != 0)
3120  {
3121  char strfbuf[128];
3122 
3123  snprintf(strfbuf, sizeof(strfbuf) - 1, "%d/%u",
3125  appendStringInfo(buf, "%*s", padding, strfbuf);
3126  }
3127  else
3129  }
3130  else if (padding != 0)
3132  padding > 0 ? padding : -padding);
3133  break;
3134  case 'x':
3135  if (padding != 0)
3136  appendStringInfo(buf, "%*u", padding, GetTopTransactionIdIfAny());
3137  else
3139  break;
3140  case 'e':
3141  if (padding != 0)
3142  appendStringInfo(buf, "%*s", padding, unpack_sql_state(edata->sqlerrcode));
3143  else
3145  break;
3146  case 'Q':
3147  if (padding != 0)
3148  appendStringInfo(buf, "%*lld", padding,
3149  (long long) pgstat_get_my_query_id());
3150  else
3151  appendStringInfo(buf, "%lld",
3152  (long long) pgstat_get_my_query_id());
3153  break;
3154  default:
3155  /* format error - ignore it */
3156  break;
3157  }
3158  }
3159 }
3160 
3161 /*
3162  * Unpack MAKE_SQLSTATE code. Note that this returns a pointer to a
3163  * static buffer.
3164  */
3165 char *
3166 unpack_sql_state(int sql_state)
3167 {
3168  static char buf[12];
3169  int i;
3170 
3171  for (i = 0; i < 5; i++)
3172  {
3173  buf[i] = PGUNSIXBIT(sql_state);
3174  sql_state >>= 6;
3175  }
3176 
3177  buf[i] = '\0';
3178  return buf;
3179 }
3180 
3181 
3182 /*
3183  * Write error report to server's log
3184  */
3185 static void
3187 {
3189  bool fallback_to_stderr = false;
3190 
3191  initStringInfo(&buf);
3192 
3193  log_line_prefix(&buf, edata);
3194  appendStringInfo(&buf, "%s: ", _(error_severity(edata->elevel)));
3195 
3197  appendStringInfo(&buf, "%s: ", unpack_sql_state(edata->sqlerrcode));
3198 
3199  if (edata->message)
3200  append_with_tabs(&buf, edata->message);
3201  else
3202  append_with_tabs(&buf, _("missing error text"));
3203 
3204  if (edata->cursorpos > 0)
3205  appendStringInfo(&buf, _(" at character %d"),
3206  edata->cursorpos);
3207  else if (edata->internalpos > 0)
3208  appendStringInfo(&buf, _(" at character %d"),
3209  edata->internalpos);
3210 
3211  appendStringInfoChar(&buf, '\n');
3212 
3214  {
3215  if (edata->detail_log)
3216  {
3217  log_line_prefix(&buf, edata);
3218  appendStringInfoString(&buf, _("DETAIL: "));
3219  append_with_tabs(&buf, edata->detail_log);
3220  appendStringInfoChar(&buf, '\n');
3221  }
3222  else if (edata->detail)
3223  {
3224  log_line_prefix(&buf, edata);
3225  appendStringInfoString(&buf, _("DETAIL: "));
3226  append_with_tabs(&buf, edata->detail);
3227  appendStringInfoChar(&buf, '\n');
3228  }
3229  if (edata->hint)
3230  {
3231  log_line_prefix(&buf, edata);
3232  appendStringInfoString(&buf, _("HINT: "));
3233  append_with_tabs(&buf, edata->hint);
3234  appendStringInfoChar(&buf, '\n');
3235  }
3236  if (edata->internalquery)
3237  {
3238  log_line_prefix(&buf, edata);
3239  appendStringInfoString(&buf, _("QUERY: "));
3241  appendStringInfoChar(&buf, '\n');
3242  }
3243  if (edata->context && !edata->hide_ctx)
3244  {
3245  log_line_prefix(&buf, edata);
3246  appendStringInfoString(&buf, _("CONTEXT: "));
3247  append_with_tabs(&buf, edata->context);
3248  appendStringInfoChar(&buf, '\n');
3249  }
3251  {
3252  /* assume no newlines in funcname or filename... */
3253  if (edata->funcname && edata->filename)
3254  {
3255  log_line_prefix(&buf, edata);
3256  appendStringInfo(&buf, _("LOCATION: %s, %s:%d\n"),
3257  edata->funcname, edata->filename,
3258  edata->lineno);
3259  }
3260  else if (edata->filename)
3261  {
3262  log_line_prefix(&buf, edata);
3263  appendStringInfo(&buf, _("LOCATION: %s:%d\n"),
3264  edata->filename, edata->lineno);
3265  }
3266  }
3267  if (edata->backtrace)
3268  {
3269  log_line_prefix(&buf, edata);
3270  appendStringInfoString(&buf, _("BACKTRACE: "));
3271  append_with_tabs(&buf, edata->backtrace);
3272  appendStringInfoChar(&buf, '\n');
3273  }
3274  }
3275 
3276  /*
3277  * If the user wants the query that generated this error logged, do it.
3278  */
3279  if (check_log_of_query(edata))
3280  {
3281  log_line_prefix(&buf, edata);
3282  appendStringInfoString(&buf, _("STATEMENT: "));
3284  appendStringInfoChar(&buf, '\n');
3285  }
3286 
3287 #ifdef HAVE_SYSLOG
3288  /* Write to syslog, if enabled */
3290  {
3291  int syslog_level;
3292 
3293  switch (edata->elevel)
3294  {
3295  case DEBUG5:
3296  case DEBUG4:
3297  case DEBUG3:
3298  case DEBUG2:
3299  case DEBUG1:
3300  syslog_level = LOG_DEBUG;
3301  break;
3302  case LOG:
3303  case LOG_SERVER_ONLY:
3304  case INFO:
3305  syslog_level = LOG_INFO;
3306  break;
3307  case NOTICE:
3308  case WARNING:
3309  case WARNING_CLIENT_ONLY:
3310  syslog_level = LOG_NOTICE;
3311  break;
3312  case ERROR:
3313  syslog_level = LOG_WARNING;
3314  break;
3315  case FATAL:
3316  syslog_level = LOG_ERR;
3317  break;
3318  case PANIC:
3319  default:
3320  syslog_level = LOG_CRIT;
3321  break;
3322  }
3323 
3324  write_syslog(syslog_level, buf.data);
3325  }
3326 #endif /* HAVE_SYSLOG */
3327 
3328 #ifdef WIN32
3329  /* Write to eventlog, if enabled */
3331  {
3332  write_eventlog(edata->elevel, buf.data, buf.len);
3333  }
3334 #endif /* WIN32 */
3335 
3336  /* Write to csvlog, if enabled */
3338  {
3339  /*
3340  * Send CSV data if it's safe to do so (syslogger doesn't need the
3341  * pipe). If this is not possible, fallback to an entry written to
3342  * stderr.
3343  */
3345  write_csvlog(edata);
3346  else
3347  fallback_to_stderr = true;
3348  }
3349 
3350  /* Write to JSON log, if enabled */
3352  {
3353  /*
3354  * Send JSON data if it's safe to do so (syslogger doesn't need the
3355  * pipe). If this is not possible, fallback to an entry written to
3356  * stderr.
3357  */
3359  {
3360  write_jsonlog(edata);
3361  }
3362  else
3363  fallback_to_stderr = true;
3364  }
3365 
3366  /*
3367  * Write to stderr, if enabled or if required because of a previous
3368  * limitation.
3369  */
3372  fallback_to_stderr)
3373  {
3374  /*
3375  * Use the chunking protocol if we know the syslogger should be
3376  * catching stderr output, and we are not ourselves the syslogger.
3377  * Otherwise, just do a vanilla write to stderr.
3378  */
3381 #ifdef WIN32
3382 
3383  /*
3384  * In a win32 service environment, there is no usable stderr. Capture
3385  * anything going there and write it to the eventlog instead.
3386  *
3387  * If stderr redirection is active, it was OK to write to stderr above
3388  * because that's really a pipe to the syslogger process.
3389  */
3390  else if (pgwin32_is_service())
3391  write_eventlog(edata->elevel, buf.data, buf.len);
3392 #endif
3393  else
3394  write_console(buf.data, buf.len);
3395  }
3396 
3397  /* If in the syslogger process, try to write messages direct to file */
3398  if (MyBackendType == B_LOGGER)
3400 
3401  /* No more need of the message formatted for stderr */
3402  pfree(buf.data);
3403 }
3404 
3405 /*
3406  * Send data to the syslogger using the chunked protocol
3407  *
3408  * Note: when there are multiple backends writing into the syslogger pipe,
3409  * it's critical that each write go into the pipe indivisibly, and not
3410  * get interleaved with data from other processes. Fortunately, the POSIX
3411  * spec requires that writes to pipes be atomic so long as they are not
3412  * more than PIPE_BUF bytes long. So we divide long messages into chunks
3413  * that are no more than that length, and send one chunk per write() call.
3414  * The collector process knows how to reassemble the chunks.
3415  *
3416  * Because of the atomic write requirement, there are only two possible
3417  * results from write() here: -1 for failure, or the requested number of
3418  * bytes. There is not really anything we can do about a failure; retry would
3419  * probably be an infinite loop, and we can't even report the error usefully.
3420  * (There is noplace else we could send it!) So we might as well just ignore
3421  * the result from write(). However, on some platforms you get a compiler
3422  * warning from ignoring write()'s result, so do a little dance with casting
3423  * rc to void to shut up the compiler.
3424  */
3425 void
3426 write_pipe_chunks(char *data, int len, int dest)
3427 {
3428  PipeProtoChunk p;
3429  int fd = fileno(stderr);
3430  int rc;
3431 
3432  Assert(len > 0);
3433 
3434  p.proto.nuls[0] = p.proto.nuls[1] = '\0';
3435  p.proto.pid = MyProcPid;
3436  p.proto.flags = 0;
3439  else if (dest == LOG_DESTINATION_CSVLOG)
3441  else if (dest == LOG_DESTINATION_JSONLOG)
3443 
3444  /* write all but the last chunk */
3445  while (len > PIPE_MAX_PAYLOAD)
3446  {
3447  /* no need to set PIPE_PROTO_IS_LAST yet */
3449  memcpy(p.proto.data, data, PIPE_MAX_PAYLOAD);
3451  (void) rc;
3453  len -= PIPE_MAX_PAYLOAD;
3454  }
3455 
3456  /* write the last chunk */
3458  p.proto.len = len;
3459  memcpy(p.proto.data, data, len);
3460  rc = write(fd, &p, PIPE_HEADER_SIZE + len);
3461  (void) rc;
3462 }
3463 
3464 
3465 /*
3466  * Append a text string to the error report being built for the client.
3467  *
3468  * This is ordinarily identical to pq_sendstring(), but if we are in
3469  * error recursion trouble we skip encoding conversion, because of the
3470  * possibility that the problem is a failure in the encoding conversion
3471  * subsystem itself. Code elsewhere should ensure that the passed-in
3472  * strings will be plain 7-bit ASCII, and thus not in need of conversion,
3473  * in such cases. (In particular, we disable localization of error messages
3474  * to help ensure that's true.)
3475  */
3476 static void
3478 {
3481  else
3482  pq_sendstring(buf, str);
3483 }
3484 
3485 /*
3486  * Write error report to client
3487  */
3488 static void
3490 {
3491  StringInfoData msgbuf;
3492 
3493  /*
3494  * We no longer support pre-3.0 FE/BE protocol, except here. If a client
3495  * tries to connect using an older protocol version, it's nice to send the
3496  * "protocol version not supported" error in a format the client
3497  * understands. If protocol hasn't been set yet, early in backend
3498  * startup, assume modern protocol.
3499  */
3501  {
3502  /* New style with separate fields */
3503  const char *sev;
3504  char tbuf[12];
3505 
3506  /* 'N' (Notice) is for nonfatal conditions, 'E' is for errors */
3507  if (edata->elevel < ERROR)
3509  else
3511 
3512  sev = error_severity(edata->elevel);
3513  pq_sendbyte(&msgbuf, PG_DIAG_SEVERITY);
3514  err_sendstring(&msgbuf, _(sev));
3516  err_sendstring(&msgbuf, sev);
3517 
3518  pq_sendbyte(&msgbuf, PG_DIAG_SQLSTATE);
3519  err_sendstring(&msgbuf, unpack_sql_state(edata->sqlerrcode));
3520 
3521  /* M field is required per protocol, so always send something */
3523  if (edata->message)
3524  err_sendstring(&msgbuf, edata->message);
3525  else
3526  err_sendstring(&msgbuf, _("missing error text"));
3527 
3528  if (edata->detail)
3529  {
3531  err_sendstring(&msgbuf, edata->detail);
3532  }
3533 
3534  /* detail_log is intentionally not used here */
3535 
3536  if (edata->hint)
3537  {
3539  err_sendstring(&msgbuf, edata->hint);
3540  }
3541 
3542  if (edata->context)
3543  {
3544  pq_sendbyte(&msgbuf, PG_DIAG_CONTEXT);
3545  err_sendstring(&msgbuf, edata->context);
3546  }
3547 
3548  if (edata->schema_name)
3549  {
3550  pq_sendbyte(&msgbuf, PG_DIAG_SCHEMA_NAME);
3551  err_sendstring(&msgbuf, edata->schema_name);
3552  }
3553 
3554  if (edata->table_name)
3555  {
3556  pq_sendbyte(&msgbuf, PG_DIAG_TABLE_NAME);
3557  err_sendstring(&msgbuf, edata->table_name);
3558  }
3559 
3560  if (edata->column_name)
3561  {
3562  pq_sendbyte(&msgbuf, PG_DIAG_COLUMN_NAME);
3563  err_sendstring(&msgbuf, edata->column_name);
3564  }
3565 
3566  if (edata->datatype_name)
3567  {
3569  err_sendstring(&msgbuf, edata->datatype_name);
3570  }
3571 
3572  if (edata->constraint_name)
3573  {
3575  err_sendstring(&msgbuf, edata->constraint_name);
3576  }
3577 
3578  if (edata->cursorpos > 0)
3579  {
3580  snprintf(tbuf, sizeof(tbuf), "%d", edata->cursorpos);
3582  err_sendstring(&msgbuf, tbuf);
3583  }
3584 
3585  if (edata->internalpos > 0)
3586  {
3587  snprintf(tbuf, sizeof(tbuf), "%d", edata->internalpos);
3589  err_sendstring(&msgbuf, tbuf);
3590  }
3591 
3592  if (edata->internalquery)
3593  {
3595  err_sendstring(&msgbuf, edata->internalquery);
3596  }
3597 
3598  if (edata->filename)
3599  {
3600  pq_sendbyte(&msgbuf, PG_DIAG_SOURCE_FILE);
3601  err_sendstring(&msgbuf, edata->filename);
3602  }
3603 
3604  if (edata->lineno > 0)
3605  {
3606  snprintf(tbuf, sizeof(tbuf), "%d", edata->lineno);
3607  pq_sendbyte(&msgbuf, PG_DIAG_SOURCE_LINE);
3608  err_sendstring(&msgbuf, tbuf);
3609  }
3610 
3611  if (edata->funcname)
3612  {
3614  err_sendstring(&msgbuf, edata->funcname);
3615  }
3616 
3617  pq_sendbyte(&msgbuf, '\0'); /* terminator */
3618 
3619  pq_endmessage(&msgbuf);
3620  }
3621  else
3622  {
3623  /* Old style --- gin up a backwards-compatible message */
3625 
3626  initStringInfo(&buf);
3627 
3628  appendStringInfo(&buf, "%s: ", _(error_severity(edata->elevel)));
3629 
3630  if (edata->message)
3632  else
3633  appendStringInfoString(&buf, _("missing error text"));
3634 
3635  appendStringInfoChar(&buf, '\n');
3636 
3637  /* 'N' (Notice) is for nonfatal conditions, 'E' is for errors */
3638  pq_putmessage_v2((edata->elevel < ERROR) ? 'N' : 'E', buf.data, buf.len + 1);
3639 
3640  pfree(buf.data);
3641  }
3642 
3643  /*
3644  * This flush is normally not necessary, since postgres.c will flush out
3645  * waiting data when control returns to the main loop. But it seems best
3646  * to leave it here, so that the client has some clue what happened if the
3647  * backend dies before getting back to the main loop ... error/notice
3648  * messages should not be a performance-critical path anyway, so an extra
3649  * flush won't hurt much ...
3650  */
3651  pq_flush();
3652 }
3653 
3654 
3655 /*
3656  * Support routines for formatting error messages.
3657  */
3658 
3659 
3660 /*
3661  * error_severity --- get string representing elevel
3662  *
3663  * The string is not localized here, but we mark the strings for translation
3664  * so that callers can invoke _() on the result.
3665  */
3666 const char *
3667 error_severity(int elevel)
3668 {
3669  const char *prefix;
3670 
3671  switch (elevel)
3672  {
3673  case DEBUG1:
3674  case DEBUG2:
3675  case DEBUG3:
3676  case DEBUG4:
3677  case DEBUG5:
3678  prefix = gettext_noop("DEBUG");
3679  break;
3680  case LOG:
3681  case LOG_SERVER_ONLY:
3682  prefix = gettext_noop("LOG");
3683  break;
3684  case INFO:
3685  prefix = gettext_noop("INFO");
3686  break;
3687  case NOTICE:
3688  prefix = gettext_noop("NOTICE");
3689  break;
3690  case WARNING:
3691  case WARNING_CLIENT_ONLY:
3692  prefix = gettext_noop("WARNING");
3693  break;
3694  case ERROR:
3695  prefix = gettext_noop("ERROR");
3696  break;
3697  case FATAL:
3698  prefix = gettext_noop("FATAL");
3699  break;
3700  case PANIC:
3701  prefix = gettext_noop("PANIC");
3702  break;
3703  default:
3704  prefix = "???";
3705  break;
3706  }
3707 
3708  return prefix;
3709 }
3710 
3711 
3712 /*
3713  * append_with_tabs
3714  *
3715  * Append the string to the StringInfo buffer, inserting a tab after any
3716  * newline.
3717  */
3718 static void
3720 {
3721  char ch;
3722 
3723  while ((ch = *str++) != '\0')
3724  {
3726  if (ch == '\n')
3728  }
3729 }
3730 
3731 
3732 /*
3733  * Write errors to stderr (or by equal means when stderr is
3734  * not available). Used before ereport/elog can be used
3735  * safely (memory context, GUC load etc)
3736  */
3737 void
3738 write_stderr(const char *fmt,...)
3739 {
3740  va_list ap;
3741 
3742 #ifdef WIN32
3743  char errbuf[2048]; /* Arbitrary size? */
3744 #endif
3745 
3746  fmt = _(fmt);
3747 
3748  va_start(ap, fmt);
3749 #ifndef WIN32
3750  /* On Unix, we just fprintf to stderr */
3751  vfprintf(stderr, fmt, ap);
3752  fflush(stderr);
3753 #else
3754  vsnprintf(errbuf, sizeof(errbuf), fmt, ap);
3755 
3756  /*
3757  * On Win32, we print to stderr if running on a console, or write to
3758  * eventlog if running as a service
3759  */
3760  if (pgwin32_is_service()) /* Running as a service */
3761  {
3762  write_eventlog(ERROR, errbuf, strlen(errbuf));
3763  }
3764  else
3765  {
3766  /* Not running as service, write to stderr */
3767  write_console(errbuf, strlen(errbuf));
3768  fflush(stderr);
3769  }
3770 #endif
3771  va_end(ap);
3772 }
void ExceptionalCondition(const char *conditionName, const char *fileName, int lineNumber)
Definition: assert.c:30
uint64 pgstat_get_my_query_id(void)
#define pg_attribute_format_arg(a)
Definition: c.h:190
#define pg_noinline
Definition: c.h:250
#define Min(x, y)
Definition: c.h:1004
#define pg_attribute_cold
Definition: c.h:275
#define gettext_noop(x)
Definition: c.h:1196
#define Max(x, y)
Definition: c.h:998
#define Assert(condition)
Definition: c.h:858
#define PG_TEXTDOMAIN(domain)
Definition: c.h:1214
#define gettext(x)
Definition: c.h:1179
#define pg_unreachable()
Definition: c.h:296
#define unlikely(x)
Definition: c.h:311
#define lengthof(array)
Definition: c.h:788
#define MemSet(start, val, len)
Definition: c.h:1020
void write_csvlog(ErrorData *edata)
Definition: csvlog.c:63
@ DestRemote
Definition: dest.h:89
@ DestDebug
Definition: dest.h:88
@ DestNone
Definition: dest.h:87
void assign_syslog_facility(int newval, void *extra)
Definition: elog.c:2335
int getinternalerrposition(void)
Definition: elog.c:1612
static bool should_output_to_client(int elevel)
Definition: elog.c:244
void assign_syslog_ident(const char *newval, void *extra)
Definition: elog.c:2303
int errcode_for_socket_access(void)
Definition: elog.c:953
bool errsave_start(struct Node *context, const char *domain)
Definition: elog.c:629
static void log_line_prefix(StringInfo buf, ErrorData *edata)
Definition: elog.c:2804
static const char * process_log_prefix_padding(const char *p, int *ppadding)
Definition: elog.c:2773
int err_generic_string(int field, const char *str)
Definition: elog.c:1512
int errmsg_plural(const char *fmt_singular, const char *fmt_plural, unsigned long n,...)
Definition: elog.c:1180
void errsave_finish(struct Node *context, const char *filename, int lineno, const char *funcname)
Definition: elog.c:681
int geterrlevel(void)
Definition: elog.c:1578
static char formatted_log_time[FORMATTED_TS_LEN]
Definition: elog.c:160
int internalerrquery(const char *query)
Definition: elog.c:1482
static char formatted_start_time[FORMATTED_TS_LEN]
Definition: elog.c:159
int internalerrposition(int cursorpos)
Definition: elog.c:1462
static void send_message_to_frontend(ErrorData *edata)
Definition: elog.c:3489
bool check_log_of_query(ErrorData *edata)
Definition: elog.c:2728
int errmsg_internal(const char *fmt,...)
Definition: elog.c:1157
static void append_with_tabs(StringInfo buf, const char *str)
Definition: elog.c:3719
int geterrcode(void)
Definition: elog.c:1561
int errhidestmt(bool hide_stmt)
Definition: elog.c:1411
char * get_formatted_log_time(void)
Definition: elog.c:2654
bool errstart(int elevel, const char *domain)
Definition: elog.c:342
void EmitErrorReport(void)
Definition: elog.c:1687
bool syslog_split_messages
Definition: elog.c:113
static void FreeErrorDataContents(ErrorData *edata)
Definition: elog.c:1830
static int errordata_stack_depth
Definition: elog.c:147
void DebugFileOpen(void)
Definition: elog.c:2108
static void err_sendstring(StringInfo buf, const char *str)
Definition: elog.c:3477
void FreeErrorData(ErrorData *edata)
Definition: elog.c:1818
void assign_backtrace_functions(const char *newval, void *extra)
Definition: elog.c:2223
static ErrorData * get_error_stack_entry(void)
Definition: elog.c:751
#define FORMATTED_TS_LEN
Definition: elog.c:158
int errdetail_internal(const char *fmt,...)
Definition: elog.c:1230
static bool saved_timeval_set
Definition: elog.c:156
int errcode_for_file_access(void)
Definition: elog.c:876
static char * backtrace_function_list
Definition: elog.c:116
int errdetail(const char *fmt,...)
Definition: elog.c:1203
int Log_error_verbosity
Definition: elog.c:108
const char * error_severity(int elevel)
Definition: elog.c:3667
void pg_re_throw(void)
Definition: elog.c:2001
int errcontext_msg(const char *fmt,...)
Definition: elog.c:1365
static int save_format_errnumber
Definition: elog.c:1641
bool check_backtrace_functions(char **newval, void **extra, GucSource source)
Definition: elog.c:2164
void pre_format_elog_string(int errnumber, const char *domain)
Definition: elog.c:1645
static int recursion_depth
Definition: elog.c:149
ErrorContextCallback * error_context_stack
Definition: elog.c:94
int errbacktrace(void)
Definition: elog.c:1092
static struct timeval saved_timeval
Definition: elog.c:155
int Log_destination
Definition: elog.c:110
void ReThrowError(ErrorData *edata)
Definition: elog.c:1951
static void set_errdata_field(MemoryContextData *cxt, char **ptr, const char *str)
Definition: elog.c:1548
const char * get_backend_type_for_log(void)
Definition: elog.c:2751
static bool matches_backtrace_functions(const char *funcname)
Definition: elog.c:825
bool check_log_destination(char **newval, void **extra, GucSource source)
Definition: elog.c:2232
void FlushErrorState(void)
Definition: elog.c:1867
int errdetail_plural(const char *fmt_singular, const char *fmt_plural, unsigned long n,...)
Definition: elog.c:1295
char * format_elog_string(const char *fmt,...)
Definition: elog.c:1654
int errhint(const char *fmt,...)
Definition: elog.c:1317
static bool is_log_level_output(int elevel, int log_min_level)
Definition: elog.c:201
void ThrowErrorData(ErrorData *edata)
Definition: elog.c:1892
bool message_level_is_interesting(int elevel)
Definition: elog.c:272
void write_pipe_chunks(char *data, int len, int dest)
Definition: elog.c:3426
int errhidecontext(bool hide_ctx)
Definition: elog.c:1430
emit_log_hook_type emit_log_hook
Definition: elog.c:105
bool syslog_sequence_numbers
Definition: elog.c:112
int geterrposition(void)
Definition: elog.c:1595
static void send_message_to_server_log(ErrorData *edata)
Definition: elog.c:3186
char * Log_destination_string
Definition: elog.c:111
static void write_console(const char *line, int len)
Definition: elog.c:2576
#define EVALUATE_MESSAGE(domain, targetfield, appendval, translateit)
Definition: elog.c:989
char * unpack_sql_state(int sql_state)
Definition: elog.c:3166
static void set_stack_entry_location(ErrorData *edata, const char *filename, int lineno, const char *funcname)
Definition: elog.c:795
pg_attribute_cold bool errstart_cold(int elevel, const char *domain)
Definition: elog.c:326
#define CHECK_STACK_DEPTH()
Definition: elog.c:164
static void set_stack_entry_domain(ErrorData *edata, const char *domain)
Definition: elog.c:778
#define EVALUATE_MESSAGE_PLURAL(domain, targetfield, appendval)
Definition: elog.c:1025
static bool should_output_to_server(int elevel)
Definition: elog.c:235
int errcode(int sqlerrcode)
Definition: elog.c:853
int errdetail_log_plural(const char *fmt_singular, const char *fmt_plural, unsigned long n,...)
Definition: elog.c:1272
void write_stderr(const char *fmt,...)
Definition: elog.c:3738
int errmsg(const char *fmt,...)
Definition: elog.c:1070
void log_status_format(StringInfo buf, const char *format, ErrorData *edata)
Definition: elog.c:2813
char * GetErrorContextStack(void)
Definition: elog.c:2056
bool in_error_recursion_trouble(void)
Definition: elog.c:293
void errfinish(const char *filename, int lineno, const char *funcname)
Definition: elog.c:473
static const char * err_gettext(const char *str) pg_attribute_format_arg(1)
Definition: elog.c:305
int errposition(int cursorpos)
Definition: elog.c:1446
#define ERRORDATA_STACK_SIZE
Definition: elog.c:143
int errhint_plural(const char *fmt_singular, const char *fmt_plural, unsigned long n,...)
Definition: elog.c:1339
int errdetail_log(const char *fmt,...)
Definition: elog.c:1251
static pg_noinline void set_backtrace(ErrorData *edata, int num_skip)
Definition: elog.c:1116
char * Log_line_prefix
Definition: elog.c:109
char * get_formatted_start_time(void)
Definition: elog.c:2704
#define _(x)
Definition: elog.c:90
int set_errcontext_domain(const char *domain)
Definition: elog.c:1391
void reset_formatted_start_time(void)
Definition: elog.c:2692
static ErrorData errordata[ERRORDATA_STACK_SIZE]
Definition: elog.c:145
sigjmp_buf * PG_exception_stack
Definition: elog.c:96
static const char * save_format_domain
Definition: elog.c:1642
ErrorData * CopyErrorData(void)
Definition: elog.c:1746
void assign_log_destination(const char *newval, void *extra)
Definition: elog.c:2294
@ PGERROR_VERBOSE
Definition: elog.h:482
@ PGERROR_DEFAULT
Definition: elog.h:481
#define LOG
Definition: elog.h:31
void(* emit_log_hook_type)(ErrorData *edata)
Definition: elog.h:472
#define PG_RE_THROW()
Definition: elog.h:412
#define DEBUG3
Definition: elog.h:28
#define LOG_SERVER_ONLY
Definition: elog.h:32
#define WARNING_CLIENT_ONLY
Definition: elog.h:38
#define FATAL
Definition: elog.h:41
#define WARNING
Definition: elog.h:36
#define LOG_DESTINATION_JSONLOG
Definition: elog.h:497
#define DEBUG2
Definition: elog.h:29
#define PGUNSIXBIT(val)
Definition: elog.h:54
#define PANIC
Definition: elog.h:42
#define DEBUG1
Definition: elog.h:30
#define ERROR
Definition: elog.h:39
#define elog(elevel,...)
Definition: elog.h:225
#define NOTICE
Definition: elog.h:35
#define LOG_DESTINATION_SYSLOG
Definition: elog.h:494
#define LOG_DESTINATION_STDERR
Definition: elog.h:493
#define INFO
Definition: elog.h:34
#define ereport(elevel,...)
Definition: elog.h:149
#define LOG_DESTINATION_EVENTLOG
Definition: elog.h:495
#define DEBUG5
Definition: elog.h:26
#define LOG_DESTINATION_CSVLOG
Definition: elog.h:496
#define DEBUG4
Definition: elog.h:27
#define palloc_object(type)
Definition: fe_memutils.h:62
volatile uint32 QueryCancelHoldoffCount
Definition: globals.c:43
ProtocolVersion FrontendProtocol
Definition: globals.c:29
pid_t PostmasterPid
Definition: globals.c:105
volatile uint32 InterruptHoldoffCount
Definition: globals.c:42
int MyProcPid
Definition: globals.c:46
bool IsUnderPostmaster
Definition: globals.c:119
volatile uint32 CritSectionCount
Definition: globals.c:44
bool ExitOnAnyError
Definition: globals.c:122
struct Port * MyProcPort
Definition: globals.c:50
pg_time_t MyStartTime
Definition: globals.c:47
char OutputFileName[MAXPGPATH]
Definition: globals.c:78
void * guc_malloc(int elevel, size_t size)
Definition: guc.c:637
#define newval
#define GUC_check_errdetail
Definition: guc.h:476
GucSource
Definition: guc.h:108
char * event_source
Definition: guc_tables.c:508
int client_min_messages
Definition: guc_tables.c:523
int log_min_error_statement
Definition: guc_tables.c:521
static int syslog_facility
Definition: guc_tables.c:586
char * application_name
Definition: guc_tables.c:543
int log_min_messages
Definition: guc_tables.c:522
char * backtrace_functions
Definition: guc_tables.c:531
const char * str
#define free(a)
Definition: header.h:65
#define funcname
Definition: indent_codes.h:69
static char * username
Definition: initdb.c:153
#define close(a)
Definition: win32.h:12
#define write(a, b, c)
Definition: win32.h:14
bool proc_exit_inprogress
Definition: ipc.c:40
void proc_exit(int code)
Definition: ipc.c:104
int j
Definition: isn.c:74
int i
Definition: isn.c:73
void write_jsonlog(ErrorData *edata)
Definition: jsonlog.c:109
#define pq_flush()
Definition: libpq.h:46
static void const char * fmt
static void const char fflush(stdout)
va_end(args)
vfprintf(stderr, fmt, args)
exit(1)
va_start(args, fmt)
void list_free(List *list)
Definition: list.c:1546
int pg_mbcliplen(const char *mbstr, int len, int limit)
Definition: mbutils.c:1083
int GetMessageEncoding(void)
Definition: mbutils.c:1308
void MemoryContextReset(MemoryContext context)
Definition: mcxt.c:383
char * pstrdup(const char *in)
Definition: mcxt.c:1696
void pfree(void *pointer)
Definition: mcxt.c:1521
MemoryContext CurrentMemoryContext
Definition: mcxt.c:143
char * MemoryContextStrdup(MemoryContext context, const char *string)
Definition: mcxt.c:1683
MemoryContext ErrorContext
Definition: mcxt.c:150
void * palloc(Size size)
Definition: mcxt.c:1317
#define CHECK_FOR_INTERRUPTS()
Definition: miscadmin.h:122
@ B_LOGGER
Definition: miscadmin.h:364
@ B_BG_WORKER
Definition: miscadmin.h:338
const char * GetBackendTypeDesc(BackendType backendType)
Definition: miscinit.c:263
BackendType MyBackendType
Definition: miscinit.c:63
#define IsA(nodeptr, _type_)
Definition: nodes.h:158
static char format
#define DEFAULT_EVENT_SOURCE
const void size_t len
const void * data
static time_t start_time
Definition: pg_ctl.c:95
int32 encoding
Definition: pg_database.h:41
static char * filename
Definition: pg_dumpall.c:119
#define lfirst(lc)
Definition: pg_list.h:172
static rewind_source * source
Definition: pg_rewind.c:89
static char * buf
Definition: pg_test_fsync.c:73
@ DISCONNECT_FATAL
Definition: pgstat.h:112
@ DISCONNECT_NORMAL
Definition: pgstat.h:110
SessionEndType pgStatSessionEndCause
int64 pg_time_t
Definition: pgtime.h:23
struct pg_tm * pg_localtime(const pg_time_t *timep, const pg_tz *tz)
Definition: localtime.c:1344
size_t pg_strftime(char *s, size_t maxsize, const char *format, const struct pg_tm *t)
Definition: strftime.c:128
PGDLLIMPORT pg_tz * log_timezone
Definition: pgtz.c:31
#define vsnprintf
Definition: port.h:237
#define ALL_CONNECTION_FAILURE_ERRNOS
Definition: port.h:121
int pg_strcasecmp(const char *s1, const char *s2)
Definition: pgstrcasecmp.c:36
#define sprintf
Definition: port.h:240
#define snprintf
Definition: port.h:238
CommandDest whereToSendOutput
Definition: postgres.c:91
const char * debug_query_string
Definition: postgres.c:88
#define PG_DIAG_INTERNAL_QUERY
Definition: postgres_ext.h:62
#define PG_DIAG_SCHEMA_NAME
Definition: postgres_ext.h:64
#define PG_DIAG_CONSTRAINT_NAME
Definition: postgres_ext.h:68
#define PG_DIAG_DATATYPE_NAME
Definition: postgres_ext.h:67
#define PG_DIAG_SOURCE_LINE
Definition: postgres_ext.h:70
#define PG_DIAG_STATEMENT_POSITION
Definition: postgres_ext.h:60
#define PG_DIAG_SOURCE_FILE
Definition: postgres_ext.h:69
#define PG_DIAG_MESSAGE_HINT
Definition: postgres_ext.h:59
#define PG_DIAG_SQLSTATE
Definition: postgres_ext.h:56
#define PG_DIAG_SEVERITY_NONLOCALIZED
Definition: postgres_ext.h:55
#define PG_DIAG_TABLE_NAME
Definition: postgres_ext.h:65
#define PG_DIAG_MESSAGE_PRIMARY
Definition: postgres_ext.h:57
#define PG_DIAG_COLUMN_NAME
Definition: postgres_ext.h:66
#define PG_DIAG_MESSAGE_DETAIL
Definition: postgres_ext.h:58
#define PG_DIAG_CONTEXT
Definition: postgres_ext.h:63
#define PG_DIAG_SEVERITY
Definition: postgres_ext.h:54
#define PG_DIAG_SOURCE_FUNCTION
Definition: postgres_ext.h:71
#define PG_DIAG_INTERNAL_POSITION
Definition: postgres_ext.h:61
bool redirection_done
Definition: postmaster.c:349
bool ClientAuthInProgress
Definition: postmaster.c:346
BackgroundWorker * MyBgworkerEntry
Definition: postmaster.c:181
int pq_putmessage_v2(char msgtype, const char *s, size_t len)
Definition: pqcomm.c:1559
#define PG_PROTOCOL_MAJOR(v)
Definition: pqcomm.h:87
void pq_sendstring(StringInfo buf, const char *str)
Definition: pqformat.c:195
void pq_endmessage(StringInfo buf)
Definition: pqformat.c:296
void pq_beginmessage(StringInfo buf, char msgtype)
Definition: pqformat.c:88
void pq_send_ascii_string(StringInfo buf, const char *str)
Definition: pqformat.c:227
static void pq_sendbyte(StringInfo buf, uint8 byt)
Definition: pqformat.h:160
static int fd(const char *x, int i)
Definition: preproc-init.c:105
#define INVALID_PROC_NUMBER
Definition: procnumber.h:26
#define PqMsg_ErrorResponse
Definition: protocol.h:44
#define PqMsg_NoticeResponse
Definition: protocol.h:49
const char * get_ps_display(int *displen)
Definition: ps_status.c:530
char * psprintf(const char *fmt,...)
Definition: psprintf.c:46
tree context
Definition: radixtree.h:1835
MemoryContextSwitchTo(old_ctx)
PGPROC * MyProc
Definition: proc.c:67
char * dbname
Definition: streamutil.c:52
void appendStringInfo(StringInfo str, const char *fmt,...)
Definition: stringinfo.c:97
void appendBinaryStringInfo(StringInfo str, const void *data, int datalen)
Definition: stringinfo.c:233
void appendStringInfoSpaces(StringInfo str, int count)
Definition: stringinfo.c:212
void appendStringInfoString(StringInfo str, const char *s)
Definition: stringinfo.c:182
void appendStringInfoChar(StringInfo str, char ch)
Definition: stringinfo.c:194
void initStringInfo(StringInfo str)
Definition: stringinfo.c:59
#define appendStringInfoCharMacro(str, ch)
Definition: stringinfo.h:204
char bgw_type[BGW_MAXLEN]
Definition: bgworker.h:92
struct ErrorContextCallback * previous
Definition: elog.h:296
void(* callback)(void *arg)
Definition: elog.h:297
int internalpos
Definition: elog.h:453
char * schema_name
Definition: elog.h:447
char * context
Definition: elog.h:444
const char * domain
Definition: elog.h:437
char * internalquery
Definition: elog.h:454
int saved_errno
Definition: elog.h:455
int sqlerrcode
Definition: elog.h:439
struct MemoryContextData * assoc_context
Definition: elog.h:458
const char * filename
Definition: elog.h:434
bool output_to_server
Definition: elog.h:430
int elevel
Definition: elog.h:429
char * datatype_name
Definition: elog.h:450
char * detail
Definition: elog.h:441
const char * context_domain
Definition: elog.h:438
const char * funcname
Definition: elog.h:436
char * table_name
Definition: elog.h:448
char * backtrace
Definition: elog.h:445
char * message
Definition: elog.h:440
bool hide_stmt
Definition: elog.h:432
char * detail_log
Definition: elog.h:442
int lineno
Definition: elog.h:435
const char * message_id
Definition: elog.h:446
char * hint
Definition: elog.h:443
bool hide_ctx
Definition: elog.h:433
char * constraint_name
Definition: elog.h:451
int cursorpos
Definition: elog.h:452
bool output_to_client
Definition: elog.h:431
char * column_name
Definition: elog.h:449
bool details_wanted
Definition: miscnodes.h:47
ErrorData * error_data
Definition: miscnodes.h:48
bool error_occurred
Definition: miscnodes.h:46
Definition: pg_list.h:54
Definition: nodes.h:129
Definition: proc.h:157
LocalTransactionId lxid
Definition: proc.h:195
ProcNumber procNumber
Definition: proc.h:190
int pid
Definition: proc.h:177
struct PGPROC::@119 vxid
PGPROC * lockGroupLeader
Definition: proc.h:299
char data[FLEXIBLE_ARRAY_MEMBER]
Definition: syslogger.h:50
char nuls[2]
Definition: syslogger.h:46
char * user_name
Definition: libpq-be.h:152
char * remote_port
Definition: libpq-be.h:144
char * database_name
Definition: libpq-be.h:151
char * remote_host
Definition: libpq-be.h:139
void write_syslogger_file(const char *buffer, int count, int destination)
Definition: syslogger.c:1092
#define PIPE_PROTO_DEST_JSONLOG
Definition: syslogger.h:67
#define PIPE_PROTO_IS_LAST
Definition: syslogger.h:63
#define PIPE_PROTO_DEST_CSVLOG
Definition: syslogger.h:66
#define PIPE_PROTO_DEST_STDERR
Definition: syslogger.h:65
#define PIPE_MAX_PAYLOAD
Definition: syslogger.h:60
#define PIPE_HEADER_SIZE
Definition: syslogger.h:59
PipeProtoHeader proto
Definition: syslogger.h:55
bool SplitIdentifierString(char *rawstring, char separator, List **namelist)
Definition: varlena.c:3437
int pgwin32_is_service(void)
int gettimeofday(struct timeval *tp, void *tzp)
TransactionId GetTopTransactionIdIfAny(void)
Definition: xact.c:440