PostgreSQL Source Code  git master
elog.h
Go to the documentation of this file.
1 /*-------------------------------------------------------------------------
2  *
3  * elog.h
4  * POSTGRES error reporting/logging definitions.
5  *
6  *
7  * Portions Copyright (c) 1996-2020, PostgreSQL Global Development Group
8  * Portions Copyright (c) 1994, Regents of the University of California
9  *
10  * src/include/utils/elog.h
11  *
12  *-------------------------------------------------------------------------
13  */
14 #ifndef ELOG_H
15 #define ELOG_H
16 
17 #include <setjmp.h>
18 
19 /* Error level codes */
20 #define DEBUG5 10 /* Debugging messages, in categories of
21  * decreasing detail. */
22 #define DEBUG4 11
23 #define DEBUG3 12
24 #define DEBUG2 13
25 #define DEBUG1 14 /* used by GUC debug_* variables */
26 #define LOG 15 /* Server operational messages; sent only to
27  * server log by default. */
28 #define LOG_SERVER_ONLY 16 /* Same as LOG for server reporting, but never
29  * sent to client. */
30 #define COMMERROR LOG_SERVER_ONLY /* Client communication problems; same as
31  * LOG for server reporting, but never
32  * sent to client. */
33 #define INFO 17 /* Messages specifically requested by user (eg
34  * VACUUM VERBOSE output); always sent to
35  * client regardless of client_min_messages,
36  * but by default not sent to server log. */
37 #define NOTICE 18 /* Helpful messages to users about query
38  * operation; sent to client and not to server
39  * log by default. */
40 #define WARNING 19 /* Warnings. NOTICE is for expected messages
41  * like implicit sequence creation by SERIAL.
42  * WARNING is for unexpected messages. */
43 #define ERROR 20 /* user error - abort transaction; return to
44  * known state */
45 /* Save ERROR value in PGERROR so it can be restored when Win32 includes
46  * modify it. We have to use a constant rather than ERROR because macros
47  * are expanded only when referenced outside macros.
48  */
49 #ifdef WIN32
50 #define PGERROR 20
51 #endif
52 #define FATAL 21 /* fatal error - abort process */
53 #define PANIC 22 /* take down the other backends with me */
54 
55  /* #define DEBUG DEBUG1 */ /* Backward compatibility with pre-7.3 */
56 
57 
58 /* macros for representing SQLSTATE strings compactly */
59 #define PGSIXBIT(ch) (((ch) - '0') & 0x3F)
60 #define PGUNSIXBIT(val) (((val) & 0x3F) + '0')
61 
62 #define MAKE_SQLSTATE(ch1,ch2,ch3,ch4,ch5) \
63  (PGSIXBIT(ch1) + (PGSIXBIT(ch2) << 6) + (PGSIXBIT(ch3) << 12) + \
64  (PGSIXBIT(ch4) << 18) + (PGSIXBIT(ch5) << 24))
65 
66 /* These macros depend on the fact that '0' becomes a zero in PGSIXBIT */
67 #define ERRCODE_TO_CATEGORY(ec) ((ec) & ((1 << 12) - 1))
68 #define ERRCODE_IS_CATEGORY(ec) (((ec) & ~((1 << 12) - 1)) == 0)
69 
70 /* SQLSTATE codes for errors are defined in a separate file */
71 #include "utils/errcodes.h"
72 
73 /*
74  * Provide a way to prevent "errno" from being accidentally used inside an
75  * elog() or ereport() invocation. Since we know that some operating systems
76  * define errno as something involving a function call, we'll put a local
77  * variable of the same name as that function in the local scope to force a
78  * compile error. On platforms that don't define errno in that way, nothing
79  * happens, so we get no warning ... but we can live with that as long as it
80  * happens on some popular platforms.
81  */
82 #if defined(errno) && defined(__linux__)
83 #define pg_prevent_errno_in_scope() int __errno_location pg_attribute_unused()
84 #elif defined(errno) && (defined(__darwin__) || defined(__freebsd__))
85 #define pg_prevent_errno_in_scope() int __error pg_attribute_unused()
86 #else
87 #define pg_prevent_errno_in_scope()
88 #endif
89 
90 
91 /*----------
92  * New-style error reporting API: to be used in this way:
93  * ereport(ERROR,
94  * errcode(ERRCODE_UNDEFINED_CURSOR),
95  * errmsg("portal \"%s\" not found", stmt->portalname),
96  * ... other errxxx() fields as needed ...);
97  *
98  * The error level is required, and so is a primary error message (errmsg
99  * or errmsg_internal). All else is optional. errcode() defaults to
100  * ERRCODE_INTERNAL_ERROR if elevel is ERROR or more, ERRCODE_WARNING
101  * if elevel is WARNING, or ERRCODE_SUCCESSFUL_COMPLETION if elevel is
102  * NOTICE or below.
103  *
104  * Before Postgres v12, extra parentheses were required around the
105  * list of auxiliary function calls; that's now optional.
106  *
107  * ereport_domain() allows a message domain to be specified, for modules that
108  * wish to use a different message catalog from the backend's. To avoid having
109  * one copy of the default text domain per .o file, we define it as NULL here
110  * and have errstart insert the default text domain. Modules can either use
111  * ereport_domain() directly, or preferably they can override the TEXTDOMAIN
112  * macro.
113  *
114  * If elevel >= ERROR, the call will not return; we try to inform the compiler
115  * of that via pg_unreachable(). However, no useful optimization effect is
116  * obtained unless the compiler sees elevel as a compile-time constant, else
117  * we're just adding code bloat. So, if __builtin_constant_p is available,
118  * use that to cause the second if() to vanish completely for non-constant
119  * cases. We avoid using a local variable because it's not necessary and
120  * prevents gcc from making the unreachability deduction at optlevel -O0.
121  *----------
122  */
123 #ifdef HAVE__BUILTIN_CONSTANT_P
124 #define ereport_domain(elevel, domain, ...) \
125  do { \
126  pg_prevent_errno_in_scope(); \
127  if (errstart(elevel, domain)) \
128  __VA_ARGS__, errfinish(__FILE__, __LINE__, PG_FUNCNAME_MACRO); \
129  if (__builtin_constant_p(elevel) && (elevel) >= ERROR) \
130  pg_unreachable(); \
131  } while(0)
132 #else /* !HAVE__BUILTIN_CONSTANT_P */
133 #define ereport_domain(elevel, domain, ...) \
134  do { \
135  const int elevel_ = (elevel); \
136  pg_prevent_errno_in_scope(); \
137  if (errstart(elevel_, domain)) \
138  __VA_ARGS__, errfinish(__FILE__, __LINE__, PG_FUNCNAME_MACRO); \
139  if (elevel_ >= ERROR) \
140  pg_unreachable(); \
141  } while(0)
142 #endif /* HAVE__BUILTIN_CONSTANT_P */
143 
144 #define ereport(elevel, ...) \
145  ereport_domain(elevel, TEXTDOMAIN, __VA_ARGS__)
146 
147 #define TEXTDOMAIN NULL
148 
149 extern bool errstart(int elevel, const char *domain);
150 extern void errfinish(const char *filename, int lineno, const char *funcname);
151 
152 extern int errcode(int sqlerrcode);
153 
154 extern int errcode_for_file_access(void);
155 extern int errcode_for_socket_access(void);
156 
157 extern int errmsg(const char *fmt,...) pg_attribute_printf(1, 2);
158 extern int errmsg_internal(const char *fmt,...) pg_attribute_printf(1, 2);
159 
160 extern int errmsg_plural(const char *fmt_singular, const char *fmt_plural,
161  unsigned long n,...) pg_attribute_printf(1, 4) pg_attribute_printf(2, 4);
162 
163 extern int errdetail(const char *fmt,...) pg_attribute_printf(1, 2);
164 extern int errdetail_internal(const char *fmt,...) pg_attribute_printf(1, 2);
165 
166 extern int errdetail_log(const char *fmt,...) pg_attribute_printf(1, 2);
167 
168 extern int errdetail_log_plural(const char *fmt_singular,
169  const char *fmt_plural,
170  unsigned long n,...) pg_attribute_printf(1, 4) pg_attribute_printf(2, 4);
171 
172 extern int errdetail_plural(const char *fmt_singular, const char *fmt_plural,
173  unsigned long n,...) pg_attribute_printf(1, 4) pg_attribute_printf(2, 4);
174 
175 extern int errhint(const char *fmt,...) pg_attribute_printf(1, 2);
176 
177 /*
178  * errcontext() is typically called in error context callback functions, not
179  * within an ereport() invocation. The callback function can be in a different
180  * module than the ereport() call, so the message domain passed in errstart()
181  * is not usually the correct domain for translating the context message.
182  * set_errcontext_domain() first sets the domain to be used, and
183  * errcontext_msg() passes the actual message.
184  */
185 #define errcontext set_errcontext_domain(TEXTDOMAIN), errcontext_msg
186 
187 extern int set_errcontext_domain(const char *domain);
188 
189 extern int errcontext_msg(const char *fmt,...) pg_attribute_printf(1, 2);
190 
191 extern int errhidestmt(bool hide_stmt);
192 extern int errhidecontext(bool hide_ctx);
193 
194 extern int errbacktrace(void);
195 
196 extern int errfunction(const char *funcname);
197 extern int errposition(int cursorpos);
198 
199 extern int internalerrposition(int cursorpos);
200 extern int internalerrquery(const char *query);
201 
202 extern int err_generic_string(int field, const char *str);
203 
204 extern int geterrcode(void);
205 extern int geterrposition(void);
206 extern int getinternalerrposition(void);
207 
208 
209 /*----------
210  * Old-style error reporting API: to be used in this way:
211  * elog(ERROR, "portal \"%s\" not found", stmt->portalname);
212  *----------
213  */
214 #define elog(elevel, ...) \
215  ereport(elevel, errmsg_internal(__VA_ARGS__))
216 
217 
218 /* Support for constructing error strings separately from ereport() calls */
219 
220 extern void pre_format_elog_string(int errnumber, const char *domain);
221 extern char *format_elog_string(const char *fmt,...) pg_attribute_printf(1, 2);
222 
223 
224 /* Support for attaching context information to error reports */
225 
226 typedef struct ErrorContextCallback
227 {
228  struct ErrorContextCallback *previous;
229  void (*callback) (void *arg);
230  void *arg;
232 
234 
235 
236 /*----------
237  * API for catching ereport(ERROR) exits. Use these macros like so:
238  *
239  * PG_TRY();
240  * {
241  * ... code that might throw ereport(ERROR) ...
242  * }
243  * PG_CATCH();
244  * {
245  * ... error recovery code ...
246  * }
247  * PG_END_TRY();
248  *
249  * (The braces are not actually necessary, but are recommended so that
250  * pgindent will indent the construct nicely.) The error recovery code
251  * can either do PG_RE_THROW to propagate the error outwards, or do a
252  * (sub)transaction abort. Failure to do so may leave the system in an
253  * inconsistent state for further processing.
254  *
255  * For the common case that the error recovery code and the cleanup in the
256  * normal code path are identical, the following can be used instead:
257  *
258  * PG_TRY();
259  * {
260  * ... code that might throw ereport(ERROR) ...
261  * }
262  * PG_FINALLY();
263  * {
264  * ... cleanup code ...
265  * }
266  * PG_END_TRY();
267  *
268  * The cleanup code will be run in either case, and any error will be rethrown
269  * afterwards.
270  *
271  * You cannot use both PG_CATCH() and PG_FINALLY() in the same
272  * PG_TRY()/PG_END_TRY() block.
273  *
274  * Note: while the system will correctly propagate any new ereport(ERROR)
275  * occurring in the recovery section, there is a small limit on the number
276  * of levels this will work for. It's best to keep the error recovery
277  * section simple enough that it can't generate any new errors, at least
278  * not before popping the error stack.
279  *
280  * Note: an ereport(FATAL) will not be caught by this construct; control will
281  * exit straight through proc_exit(). Therefore, do NOT put any cleanup
282  * of non-process-local resources into the error recovery section, at least
283  * not without taking thought for what will happen during ereport(FATAL).
284  * The PG_ENSURE_ERROR_CLEANUP macros provided by storage/ipc.h may be
285  * helpful in such cases.
286  *
287  * Note: if a local variable of the function containing PG_TRY is modified
288  * in the PG_TRY section and used in the PG_CATCH section, that variable
289  * must be declared "volatile" for POSIX compliance. This is not mere
290  * pedantry; we have seen bugs from compilers improperly optimizing code
291  * away when such a variable was not marked. Beware that gcc's -Wclobbered
292  * warnings are just about entirely useless for catching such oversights.
293  *----------
294  */
295 #define PG_TRY() \
296  do { \
297  sigjmp_buf *_save_exception_stack = PG_exception_stack; \
298  ErrorContextCallback *_save_context_stack = error_context_stack; \
299  sigjmp_buf _local_sigjmp_buf; \
300  bool _do_rethrow = false; \
301  if (sigsetjmp(_local_sigjmp_buf, 0) == 0) \
302  { \
303  PG_exception_stack = &_local_sigjmp_buf
304 
305 #define PG_CATCH() \
306  } \
307  else \
308  { \
309  PG_exception_stack = _save_exception_stack; \
310  error_context_stack = _save_context_stack
311 
312 #define PG_FINALLY() \
313  } \
314  else \
315  _do_rethrow = true; \
316  { \
317  PG_exception_stack = _save_exception_stack; \
318  error_context_stack = _save_context_stack
319 
320 #define PG_END_TRY() \
321  } \
322  if (_do_rethrow) \
323  PG_RE_THROW(); \
324  PG_exception_stack = _save_exception_stack; \
325  error_context_stack = _save_context_stack; \
326  } while (0)
327 
328 /*
329  * Some compilers understand pg_attribute_noreturn(); for other compilers,
330  * insert pg_unreachable() so that the compiler gets the point.
331  */
332 #ifdef HAVE_PG_ATTRIBUTE_NORETURN
333 #define PG_RE_THROW() \
334  pg_re_throw()
335 #else
336 #define PG_RE_THROW() \
337  (pg_re_throw(), pg_unreachable())
338 #endif
339 
340 extern PGDLLIMPORT sigjmp_buf *PG_exception_stack;
341 
342 
343 /* Stuff that error handlers might want to use */
344 
345 /*
346  * ErrorData holds the data accumulated during any one ereport() cycle.
347  * Any non-NULL pointers must point to palloc'd data.
348  * (The const pointers are an exception; we assume they point at non-freeable
349  * constant strings.)
350  */
351 typedef struct ErrorData
352 {
353  int elevel; /* error level */
354  bool output_to_server; /* will report to server log? */
355  bool output_to_client; /* will report to client? */
356  bool show_funcname; /* true to force funcname inclusion */
357  bool hide_stmt; /* true to prevent STATEMENT: inclusion */
358  bool hide_ctx; /* true to prevent CONTEXT: inclusion */
359  const char *filename; /* __FILE__ of ereport() call */
360  int lineno; /* __LINE__ of ereport() call */
361  const char *funcname; /* __func__ of ereport() call */
362  const char *domain; /* message domain */
363  const char *context_domain; /* message domain for context message */
364  int sqlerrcode; /* encoded ERRSTATE */
365  char *message; /* primary error message (translated) */
366  char *detail; /* detail error message */
367  char *detail_log; /* detail error message for server log only */
368  char *hint; /* hint message */
369  char *context; /* context message */
370  char *backtrace; /* backtrace */
371  const char *message_id; /* primary message's id (original string) */
372  char *schema_name; /* name of schema */
373  char *table_name; /* name of table */
374  char *column_name; /* name of column */
375  char *datatype_name; /* name of datatype */
376  char *constraint_name; /* name of constraint */
377  int cursorpos; /* cursor index into query string */
378  int internalpos; /* cursor index into internalquery */
379  char *internalquery; /* text of internally-generated query */
380  int saved_errno; /* errno at entry */
381 
382  /* context containing associated non-constant strings */
384 } ErrorData;
385 
386 extern void EmitErrorReport(void);
387 extern ErrorData *CopyErrorData(void);
388 extern void FreeErrorData(ErrorData *edata);
389 extern void FlushErrorState(void);
390 extern void ReThrowError(ErrorData *edata) pg_attribute_noreturn();
391 extern void ThrowErrorData(ErrorData *edata);
392 extern void pg_re_throw(void) pg_attribute_noreturn();
393 
394 extern char *GetErrorContextStack(void);
395 
396 /* Hook for intercepting messages before they are sent to the server log */
397 typedef void (*emit_log_hook_type) (ErrorData *edata);
399 
400 
401 /* GUC-configurable parameters */
402 
403 typedef enum
404 {
405  PGERROR_TERSE, /* single-line error messages */
406  PGERROR_DEFAULT, /* recommended style */
407  PGERROR_VERBOSE /* all the facts, ma'am */
409 
410 extern int Log_error_verbosity;
411 extern char *Log_line_prefix;
412 extern int Log_destination;
413 extern char *Log_destination_string;
414 extern bool syslog_sequence_numbers;
415 extern bool syslog_split_messages;
416 
417 /* Log destination bitmap */
418 #define LOG_DESTINATION_STDERR 1
419 #define LOG_DESTINATION_SYSLOG 2
420 #define LOG_DESTINATION_EVENTLOG 4
421 #define LOG_DESTINATION_CSVLOG 8
422 
423 /* Other exported functions */
424 extern void DebugFileOpen(void);
425 extern char *unpack_sql_state(int sql_state);
426 extern bool in_error_recursion_trouble(void);
427 
428 #ifdef HAVE_SYSLOG
429 extern void set_syslog_parameters(const char *ident, int facility);
430 #endif
431 
432 /*
433  * Write errors to stderr (or by equal means when stderr is
434  * not available). Used before ereport/elog can be used
435  * safely (memory context, GUC load etc)
436  */
437 extern void write_stderr(const char *fmt,...) pg_attribute_printf(1, 2);
438 
439 #endif /* ELOG_H */
char * schema_name
Definition: elog.h:372
#define pg_attribute_noreturn()
Definition: c.h:145
bool hide_stmt
Definition: elog.h:357
int errbacktrace(void)
Definition: elog.c:846
void pre_format_elog_string(int errnumber, const char *domain)
Definition: elog.c:1381
int errcode_for_file_access(void)
Definition: elog.c:633
int errposition(int cursorpos)
Definition: elog.c:1199
char * format_elog_string(const char *fmt,...) pg_attribute_printf(1
int sqlerrcode
Definition: elog.h:364
const char * funcname
Definition: elog.h:361
void ReThrowError(ErrorData *edata) pg_attribute_noreturn()
Definition: elog.c:1652
ErrorData * CopyErrorData(void)
Definition: elog.c:1474
int int int pg_attribute_printf(2, 4)
char * Log_line_prefix
Definition: elog.c:109
int lineno
Definition: elog.h:360
PGDLLIMPORT sigjmp_buf * PG_exception_stack
Definition: elog.c:94
char * internalquery
Definition: elog.h:379
int int errmsg_internal(const char *fmt,...) pg_attribute_printf(1
int int errhidestmt(bool hide_stmt)
Definition: elog.c:1142
void FreeErrorData(ErrorData *edata)
Definition: elog.c:1530
char struct ErrorContextCallback ErrorContextCallback
void errfinish(const char *filename, int lineno, const char *funcname)
Definition: elog.c:426
struct ErrorContextCallback * previous
Definition: elog.h:228
int int int errmsg_plural(const char *fmt_singular, const char *fmt_plural, unsigned long n,...) pg_attribute_printf(1
#define PGDLLIMPORT
Definition: c.h:1257
int cursorpos
Definition: elog.h:377
const char * context_domain
Definition: elog.h:363
int errhidecontext(bool hide_ctx)
Definition: elog.c:1161
bool syslog_sequence_numbers
Definition: elog.c:112
char * GetErrorContextStack(void)
Definition: elog.c:1775
const char * filename
Definition: elog.h:359
char * detail_log
Definition: elog.h:367
int errdetail_plural(const char *fmt_singular, const char *fmt_plural, unsigned long n,...) pg_attribute_printf(1
int errcode_for_socket_access(void)
Definition: elog.c:704
int set_errcontext_domain(const char *domain)
Definition: elog.c:1122
static void callback(struct sockaddr *addr, struct sockaddr *mask, void *unused)
Definition: test_ifaddrs.c:48
int geterrcode(void)
Definition: elog.c:1314
int geterrposition(void)
Definition: elog.c:1331
int internalerrquery(const char *query)
Definition: elog.c:1235
char * table_name
Definition: elog.h:373
bool output_to_server
Definition: elog.h:354
int internalpos
Definition: elog.h:378
int saved_errno
Definition: elog.h:380
bool hide_ctx
Definition: elog.h:358
void ThrowErrorData(ErrorData *edata)
Definition: elog.c:1593
const char * ident
Definition: memnodes.h:89
int internalerrposition(int cursorpos)
Definition: elog.c:1215
char * backtrace
Definition: elog.h:370
char * datatype_name
Definition: elog.h:375
int elevel
Definition: elog.h:353
static int elevel
Definition: vacuumlazy.c:333
char * detail
Definition: elog.h:366
void EmitErrorReport(void)
Definition: elog.c:1423
int int errdetail_internal(const char *fmt,...) pg_attribute_printf(1
PGDLLIMPORT emit_log_hook_type emit_log_hook
Definition: elog.c:105
const char * message_id
Definition: elog.h:371
int Log_destination
Definition: elog.c:110
bool show_funcname
Definition: elog.h:356
int errmsg(const char *fmt,...) pg_attribute_printf(1
void(* emit_log_hook_type)(ErrorData *edata)
Definition: elog.h:397
char * column_name
Definition: elog.h:374
int err_generic_string(int field, const char *str)
Definition: elog.c:1265
int getinternalerrposition(void)
Definition: elog.c:1348
PGErrorVerbosity
Definition: elog.h:403
bool errstart(int elevel, const char *domain)
Definition: elog.c:234
char * hint
Definition: elog.h:368
int errcontext_msg(const char *fmt,...) pg_attribute_printf(1
char * context
Definition: elog.h:369
struct MemoryContextData * assoc_context
Definition: elog.h:383
int errhint(const char *fmt,...) pg_attribute_printf(1
int int int errdetail_log(const char *fmt,...) pg_attribute_printf(1
static char * filename
Definition: pg_dumpall.c:91
bool in_error_recursion_trouble(void)
Definition: elog.c:198
void pg_re_throw(void) pg_attribute_noreturn()
Definition: elog.c:1713
void write_stderr(const char *fmt,...) pg_attribute_printf(1
void * arg
bool syslog_split_messages
Definition: elog.c:113
int errfunction(const char *funcname)
Definition: elog.c:1182
void FlushErrorState(void)
Definition: elog.c:1568
int errdetail(const char *fmt,...) pg_attribute_printf(1
int Log_error_verbosity
Definition: elog.c:108
const char * domain
Definition: elog.h:362
char * constraint_name
Definition: elog.h:376
char * Log_destination_string
Definition: elog.c:111
char * unpack_sql_state(int sql_state)
Definition: elog.c:2893
int int int int errdetail_log_plural(const char *fmt_singular, const char *fmt_plural, unsigned long n,...) pg_attribute_printf(1
bool output_to_client
Definition: elog.h:355
char * message
Definition: elog.h:365
void DebugFileOpen(void)
Definition: elog.c:1842
PGDLLIMPORT ErrorContextCallback * error_context_stack
Definition: elog.c:92
struct ErrorData ErrorData
int errcode(int sqlerrcode)
Definition: elog.c:610