1996-08-28 03:59:28 +02:00
|
|
|
/*-------------------------------------------------------------------------
|
|
|
|
*
|
1999-02-14 00:22:53 +01:00
|
|
|
* elog.h
|
2003-07-27 20:37:52 +02:00
|
|
|
* POSTGRES error reporting/logging definitions.
|
1996-08-28 03:59:28 +02:00
|
|
|
*
|
|
|
|
*
|
2003-08-04 04:40:20 +02:00
|
|
|
* Portions Copyright (c) 1996-2003, PostgreSQL Global Development Group
|
2000-01-26 06:58:53 +01:00
|
|
|
* Portions Copyright (c) 1994, Regents of the University of California
|
1996-08-28 03:59:28 +02:00
|
|
|
*
|
2004-07-31 02:45:57 +02:00
|
|
|
* $PostgreSQL: pgsql/src/include/utils/elog.h,v 1.71 2004/07/31 00:45:43 tgl Exp $
|
1996-08-28 03:59:28 +02:00
|
|
|
*
|
|
|
|
*-------------------------------------------------------------------------
|
|
|
|
*/
|
1997-09-07 07:04:48 +02:00
|
|
|
#ifndef ELOG_H
|
1996-08-28 03:59:28 +02:00
|
|
|
#define ELOG_H
|
|
|
|
|
2004-07-31 02:45:57 +02:00
|
|
|
#include <setjmp.h>
|
|
|
|
|
2001-01-14 06:08:17 +01:00
|
|
|
/* Error level codes */
|
2002-09-04 22:31:48 +02:00
|
|
|
#define DEBUG5 10 /* Debugging messages, in categories of
|
|
|
|
* decreasing detail. */
|
2002-03-05 00:59:14 +01:00
|
|
|
#define DEBUG4 11
|
2002-09-04 22:31:48 +02:00
|
|
|
#define DEBUG3 12
|
|
|
|
#define DEBUG2 13
|
2003-05-27 19:49:47 +02:00
|
|
|
#define DEBUG1 14 /* used by GUC debug_* variables */
|
2002-09-04 22:31:48 +02:00
|
|
|
#define LOG 15 /* Server operational messages; sent only
|
|
|
|
* to server log by default. */
|
|
|
|
#define COMMERROR 16 /* Client communication problems; same as
|
|
|
|
* LOG for server reporting, but never
|
|
|
|
* sent to client. */
|
|
|
|
#define INFO 17 /* Informative messages that are always
|
|
|
|
* sent to client; is not affected by
|
|
|
|
* client_min_messages */
|
|
|
|
#define NOTICE 18 /* Helpful messages to users about query
|
|
|
|
* operation; sent to client and server
|
|
|
|
* log by default. */
|
2004-07-06 21:51:59 +02:00
|
|
|
#define WARNING 19 /* Warnings. NOTICE is for expected messages
|
|
|
|
* like implicit sequence creation by SERIAL.
|
|
|
|
* WARNING is for unexpected messages.
|
|
|
|
*/
|
2002-09-04 22:31:48 +02:00
|
|
|
#define ERROR 20 /* user error - abort transaction; return
|
|
|
|
* to known state */
|
2003-07-15 01:36:15 +02:00
|
|
|
/* Save ERROR value in PGERROR so it can be restored when Win32 includes
|
2003-05-15 18:35:30 +02:00
|
|
|
* modify it. We have to use a constant rather than ERROR because macros
|
|
|
|
* are expanded only when referenced outside macros.
|
|
|
|
*/
|
|
|
|
#ifdef WIN32
|
|
|
|
#define PGERROR 20
|
|
|
|
#endif
|
2002-09-04 22:31:48 +02:00
|
|
|
#define FATAL 21 /* fatal error - abort process */
|
|
|
|
#define PANIC 22 /* take down the other backends with me */
|
2001-06-08 23:16:49 +02:00
|
|
|
|
2003-08-04 02:43:34 +02:00
|
|
|
/* #define DEBUG DEBUG1 */ /* Backward compatibility with pre-7.3 */
|
1996-08-28 03:59:28 +02:00
|
|
|
|
2003-04-24 23:16:45 +02:00
|
|
|
|
|
|
|
/* macros for representing SQLSTATE strings compactly */
|
|
|
|
#define PGSIXBIT(ch) (((ch) - '0') & 0x3F)
|
2003-08-04 02:43:34 +02:00
|
|
|
#define PGUNSIXBIT(val) (((val) & 0x3F) + '0')
|
2003-04-24 23:16:45 +02:00
|
|
|
|
|
|
|
#define MAKE_SQLSTATE(ch1,ch2,ch3,ch4,ch5) \
|
|
|
|
(PGSIXBIT(ch1) + (PGSIXBIT(ch2) << 6) + (PGSIXBIT(ch3) << 12) + \
|
|
|
|
(PGSIXBIT(ch4) << 18) + (PGSIXBIT(ch5) << 24))
|
|
|
|
|
2003-07-27 20:37:52 +02:00
|
|
|
/* SQLSTATE codes for errors are defined in a separate file */
|
|
|
|
#include "utils/errcodes.h"
|
2003-07-19 22:20:53 +02:00
|
|
|
|
2003-04-24 23:16:45 +02:00
|
|
|
|
|
|
|
/* Which __func__ symbol do we have, if any? */
|
|
|
|
#ifdef HAVE_FUNCNAME__FUNC
|
|
|
|
#define PG_FUNCNAME_MACRO __func__
|
|
|
|
#else
|
|
|
|
#ifdef HAVE_FUNCNAME__FUNCTION
|
|
|
|
#define PG_FUNCNAME_MACRO __FUNCTION__
|
|
|
|
#else
|
|
|
|
#define PG_FUNCNAME_MACRO NULL
|
2000-05-31 02:28:42 +02:00
|
|
|
#endif
|
2003-04-24 23:16:45 +02:00
|
|
|
#endif
|
|
|
|
|
|
|
|
|
|
|
|
/*----------
|
|
|
|
* New-style error reporting API: to be used in this way:
|
|
|
|
* ereport(ERROR,
|
2003-07-19 01:20:33 +02:00
|
|
|
* (errcode(ERRCODE_UNDEFINED_CURSOR),
|
2003-04-24 23:16:45 +02:00
|
|
|
* errmsg("portal \"%s\" not found", stmt->portalname),
|
|
|
|
* ... other errxxx() fields as needed ...));
|
|
|
|
*
|
|
|
|
* The error level is required, and so is a primary error message (errmsg
|
2003-08-04 02:43:34 +02:00
|
|
|
* or errmsg_internal). All else is optional. errcode() defaults to
|
2003-07-19 01:20:33 +02:00
|
|
|
* ERRCODE_INTERNAL_ERROR if elevel is ERROR or more, ERRCODE_WARNING
|
|
|
|
* if elevel is WARNING, or ERRCODE_SUCCESSFUL_COMPLETION if elevel is
|
|
|
|
* NOTICE or below.
|
2003-04-24 23:16:45 +02:00
|
|
|
*----------
|
|
|
|
*/
|
|
|
|
#define ereport(elevel, rest) \
|
|
|
|
(errstart(elevel, __FILE__, __LINE__, PG_FUNCNAME_MACRO) ? \
|
|
|
|
(errfinish rest) : (void) 0)
|
|
|
|
|
|
|
|
extern bool errstart(int elevel, const char *filename, int lineno,
|
2003-08-04 02:43:34 +02:00
|
|
|
const char *funcname);
|
|
|
|
extern void errfinish(int dummy,...);
|
2003-04-24 23:16:45 +02:00
|
|
|
|
2003-08-04 02:43:34 +02:00
|
|
|
extern int errcode(int sqlerrcode);
|
2003-04-24 23:16:45 +02:00
|
|
|
|
2003-08-04 02:43:34 +02:00
|
|
|
extern int errcode_for_file_access(void);
|
|
|
|
extern int errcode_for_socket_access(void);
|
2003-07-19 01:20:33 +02:00
|
|
|
|
2003-08-04 02:43:34 +02:00
|
|
|
extern int
|
|
|
|
errmsg(const char *fmt,...)
|
2003-04-24 23:16:45 +02:00
|
|
|
/* This extension allows gcc to check the format string for consistency with
|
|
|
|
the supplied arguments. */
|
|
|
|
__attribute__((format(printf, 1, 2)));
|
|
|
|
|
2003-08-04 02:43:34 +02:00
|
|
|
extern int
|
|
|
|
errmsg_internal(const char *fmt,...)
|
2003-04-24 23:16:45 +02:00
|
|
|
/* This extension allows gcc to check the format string for consistency with
|
|
|
|
the supplied arguments. */
|
|
|
|
__attribute__((format(printf, 1, 2)));
|
|
|
|
|
2003-08-04 02:43:34 +02:00
|
|
|
extern int
|
|
|
|
errdetail(const char *fmt,...)
|
2003-04-24 23:16:45 +02:00
|
|
|
/* This extension allows gcc to check the format string for consistency with
|
|
|
|
the supplied arguments. */
|
|
|
|
__attribute__((format(printf, 1, 2)));
|
|
|
|
|
2003-08-04 02:43:34 +02:00
|
|
|
extern int
|
|
|
|
errhint(const char *fmt,...)
|
2003-04-24 23:16:45 +02:00
|
|
|
/* This extension allows gcc to check the format string for consistency with
|
|
|
|
the supplied arguments. */
|
|
|
|
__attribute__((format(printf, 1, 2)));
|
|
|
|
|
2003-08-04 02:43:34 +02:00
|
|
|
extern int
|
|
|
|
errcontext(const char *fmt,...)
|
2003-04-24 23:16:45 +02:00
|
|
|
/* This extension allows gcc to check the format string for consistency with
|
|
|
|
the supplied arguments. */
|
|
|
|
__attribute__((format(printf, 1, 2)));
|
|
|
|
|
2003-08-04 02:43:34 +02:00
|
|
|
extern int errfunction(const char *funcname);
|
|
|
|
extern int errposition(int cursorpos);
|
2003-04-24 23:16:45 +02:00
|
|
|
|
2004-03-21 23:29:11 +01:00
|
|
|
extern int internalerrposition(int cursorpos);
|
|
|
|
extern int internalerrquery(const char *query);
|
|
|
|
|
|
|
|
extern int geterrposition(void);
|
|
|
|
extern int getinternalerrposition(void);
|
|
|
|
|
2003-04-24 23:16:45 +02:00
|
|
|
|
|
|
|
/*----------
|
|
|
|
* Old-style error reporting API: to be used in this way:
|
|
|
|
* elog(ERROR, "portal \"%s\" not found", stmt->portalname);
|
|
|
|
*----------
|
|
|
|
*/
|
2003-08-04 02:43:34 +02:00
|
|
|
#define elog errstart(ERROR, __FILE__, __LINE__, PG_FUNCNAME_MACRO), elog_finish
|
2000-06-04 17:06:34 +02:00
|
|
|
|
2001-10-25 07:50:21 +02:00
|
|
|
extern void
|
2003-08-04 02:43:34 +02:00
|
|
|
elog_finish(int elevel, const char *fmt,...)
|
2000-01-13 19:26:18 +01:00
|
|
|
/* This extension allows gcc to check the format string for consistency with
|
|
|
|
the supplied arguments. */
|
2001-03-22 05:01:46 +01:00
|
|
|
__attribute__((format(printf, 2, 3)));
|
2000-04-12 19:17:23 +02:00
|
|
|
|
2003-04-24 23:16:45 +02:00
|
|
|
|
|
|
|
/* Support for attaching context information to error reports */
|
|
|
|
|
|
|
|
typedef struct ErrorContextCallback
|
|
|
|
{
|
|
|
|
struct ErrorContextCallback *previous;
|
2003-08-04 02:43:34 +02:00
|
|
|
void (*callback) (void *arg);
|
|
|
|
void *arg;
|
2003-08-08 23:42:59 +02:00
|
|
|
} ErrorContextCallback;
|
2003-04-24 23:16:45 +02:00
|
|
|
|
2003-05-22 19:20:44 +02:00
|
|
|
extern DLLIMPORT ErrorContextCallback *error_context_stack;
|
2003-04-24 23:16:45 +02:00
|
|
|
|
|
|
|
|
2004-07-31 02:45:57 +02:00
|
|
|
/*----------
|
|
|
|
* API for catching ereport(ERROR) exits. Use these macros like so:
|
|
|
|
*
|
|
|
|
* PG_TRY();
|
|
|
|
* {
|
|
|
|
* ... code that might throw ereport(ERROR) ...
|
|
|
|
* }
|
|
|
|
* PG_CATCH();
|
|
|
|
* {
|
|
|
|
* ... error recovery code ...
|
|
|
|
* }
|
|
|
|
* PG_END_TRY();
|
|
|
|
*
|
|
|
|
* (The braces are not actually necessary, but are recommended so that
|
|
|
|
* pg_indent will indent the construct nicely.) The error recovery code
|
|
|
|
* can optionally do PG_RE_THROW() to propagate the same error outwards.
|
|
|
|
*
|
|
|
|
* Note: while the system will correctly propagate any new ereport(ERROR)
|
|
|
|
* occurring in the recovery section, there is a small limit on the number
|
|
|
|
* of levels this will work for. It's best to keep the error recovery
|
|
|
|
* section simple enough that it can't generate any new errors, at least
|
|
|
|
* not before popping the error stack.
|
|
|
|
*----------
|
|
|
|
*/
|
|
|
|
#define PG_TRY() \
|
|
|
|
do { \
|
|
|
|
sigjmp_buf *save_exception_stack = PG_exception_stack; \
|
|
|
|
ErrorContextCallback *save_context_stack = error_context_stack; \
|
|
|
|
sigjmp_buf local_sigjmp_buf; \
|
|
|
|
if (sigsetjmp(local_sigjmp_buf, 1) == 0) \
|
|
|
|
{ \
|
|
|
|
PG_exception_stack = &local_sigjmp_buf
|
|
|
|
|
|
|
|
#define PG_CATCH() \
|
|
|
|
} \
|
|
|
|
else \
|
|
|
|
{ \
|
|
|
|
PG_exception_stack = save_exception_stack; \
|
|
|
|
error_context_stack = save_context_stack
|
|
|
|
|
|
|
|
#define PG_END_TRY() \
|
|
|
|
} \
|
|
|
|
PG_exception_stack = save_exception_stack; \
|
|
|
|
error_context_stack = save_context_stack; \
|
|
|
|
} while (0)
|
|
|
|
|
|
|
|
#define PG_RE_THROW() \
|
|
|
|
siglongjmp(*PG_exception_stack, 1)
|
|
|
|
|
|
|
|
extern DLLIMPORT sigjmp_buf *PG_exception_stack;
|
|
|
|
|
|
|
|
|
|
|
|
/* Stuff that error handlers might want to use */
|
|
|
|
|
|
|
|
/*
|
|
|
|
* ErrorData holds the data accumulated during any one ereport() cycle.
|
|
|
|
* Any non-NULL pointers must point to palloc'd data.
|
|
|
|
* (The const pointers are an exception; we assume they point at non-freeable
|
|
|
|
* constant strings.)
|
|
|
|
*/
|
|
|
|
typedef struct ErrorData
|
|
|
|
{
|
|
|
|
int elevel; /* error level */
|
|
|
|
bool output_to_server; /* will report to server log? */
|
|
|
|
bool output_to_client; /* will report to client? */
|
|
|
|
bool show_funcname; /* true to force funcname inclusion */
|
|
|
|
const char *filename; /* __FILE__ of ereport() call */
|
|
|
|
int lineno; /* __LINE__ of ereport() call */
|
|
|
|
const char *funcname; /* __func__ of ereport() call */
|
|
|
|
int sqlerrcode; /* encoded ERRSTATE */
|
|
|
|
char *message; /* primary error message */
|
|
|
|
char *detail; /* detail error message */
|
|
|
|
char *hint; /* hint message */
|
|
|
|
char *context; /* context message */
|
|
|
|
int cursorpos; /* cursor index into query string */
|
|
|
|
int internalpos; /* cursor index into internalquery */
|
|
|
|
char *internalquery; /* text of internally-generated query */
|
|
|
|
int saved_errno; /* errno at entry */
|
|
|
|
} ErrorData;
|
|
|
|
|
|
|
|
extern void EmitErrorReport(void);
|
|
|
|
extern ErrorData *CopyErrorData(void);
|
|
|
|
extern void FreeErrorData(ErrorData *edata);
|
|
|
|
extern void FlushErrorState(void);
|
|
|
|
extern void ReThrowError(ErrorData *edata);
|
|
|
|
|
|
|
|
|
2003-04-24 23:16:45 +02:00
|
|
|
/* GUC-configurable parameters */
|
2003-06-30 18:47:02 +02:00
|
|
|
|
|
|
|
typedef enum
|
|
|
|
{
|
|
|
|
PGERROR_TERSE, /* single-line error messages */
|
|
|
|
PGERROR_DEFAULT, /* recommended style */
|
|
|
|
PGERROR_VERBOSE /* all the facts, ma'am */
|
2003-08-08 23:42:59 +02:00
|
|
|
} PGErrorVerbosity;
|
2003-06-30 18:47:02 +02:00
|
|
|
|
|
|
|
extern PGErrorVerbosity Log_error_verbosity;
|
2004-03-09 05:43:07 +01:00
|
|
|
extern char *Log_line_prefix;
|
2004-04-05 05:02:11 +02:00
|
|
|
extern unsigned int Log_destination;
|
2003-08-04 02:43:34 +02:00
|
|
|
|
2004-04-05 05:02:11 +02:00
|
|
|
/* Log destination bitmap */
|
|
|
|
#define LOG_DESTINATION_STDERR 1
|
|
|
|
#define LOG_DESTINATION_SYSLOG 2
|
|
|
|
#define LOG_DESTINATION_EVENTLOG 4
|
2003-04-24 23:16:45 +02:00
|
|
|
|
|
|
|
/* Other exported functions */
|
|
|
|
extern void DebugFileOpen(void);
|
Commit to match discussed elog() changes. Only update is that LOG is
now just below FATAL in server_min_messages. Added more text to
highlight ordering difference between it and client_min_messages.
---------------------------------------------------------------------------
REALLYFATAL => PANIC
STOP => PANIC
New INFO level the prints to client by default
New LOG level the prints to server log by default
Cause VACUUM information to print only to the client
NOTICE => INFO where purely information messages are sent
DEBUG => LOG for purely server status messages
DEBUG removed, kept as backward compatible
DEBUG5, DEBUG4, DEBUG3, DEBUG2, DEBUG1 added
DebugLvl removed in favor of new DEBUG[1-5] symbols
New server_min_messages GUC parameter with values:
DEBUG[5-1], INFO, NOTICE, ERROR, LOG, FATAL, PANIC
New client_min_messages GUC parameter with values:
DEBUG[5-1], LOG, INFO, NOTICE, ERROR, FATAL, PANIC
Server startup now logged with LOG instead of DEBUG
Remove debug_level GUC parameter
elog() numbers now start at 10
Add test to print error message if older elog() values are passed to elog()
Bootstrap mode now has a -d that requires an argument, like postmaster
2002-03-02 22:39:36 +01:00
|
|
|
|
2004-06-24 23:03:42 +02:00
|
|
|
/*
|
|
|
|
* Write errors to stderr (or by equal means when stderr is
|
|
|
|
* not available). Used before ereport/elog can be used
|
|
|
|
* safely (memory context, GUC load etc)
|
|
|
|
*/
|
|
|
|
extern void write_stderr(const char *fmt,...)
|
|
|
|
/* This extension allows gcc to check the format string for consistency with
|
|
|
|
the supplied arguments. */
|
|
|
|
__attribute__((format(printf, 1, 2)));
|
|
|
|
|
2001-11-05 18:46:40 +01:00
|
|
|
#endif /* ELOG_H */
|