granicus.if.org Git - postgresql/blob - src/include/utils/elog.h

   1 /*-------------------------------------------------------------------------
   2  *
   3  * elog.h
   4  *        POSTGRES error reporting/logging definitions.
   5  *
   6  *
   7  * Portions Copyright (c) 1996-2003, PostgreSQL Global Development Group
   8  * Portions Copyright (c) 1994, Regents of the University of California
   9  *
  10  * $PostgreSQL: pgsql/src/include/utils/elog.h,v 1.72 2004/07/31 23:04:55 tgl Exp $
  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
  27                                                                  * to server log by default. */
  28 #define COMMERROR       16                      /* Client communication problems; same as
  29                                                                  * LOG for server reporting, but never
  30                                                                  * sent to client. */
  31 #define INFO            17                      /* Informative messages that are always
  32                                                                  * sent to client;      is not affected by
  33                                                                  * client_min_messages */
  34 #define NOTICE          18                      /* Helpful messages to users about query
  35                                                                  * operation;  sent to client and server
  36                                                                  * log by default. */
  37 #define WARNING         19                      /* Warnings.  NOTICE is for expected messages
  38                                                                  * like implicit sequence creation by SERIAL.
  39                                                                  * WARNING is for unexpected messages.
  40                                                                  */
  41 #define ERROR           20                      /* user error - abort transaction; return
  42                                                                  * to known state */
  43 /* Save ERROR value in PGERROR so it can be restored when Win32 includes
  44  * modify it.  We have to use a constant rather than ERROR because macros
  45  * are expanded only when referenced outside macros.
  46  */
  47 #ifdef WIN32
  48 #define PGERROR         20
  49 #endif
  50 #define FATAL           21                      /* fatal error - abort process */
  51 #define PANIC           22                      /* take down the other backends with me */
  52
  53  /* #define DEBUG DEBUG1 */     /* Backward compatibility with pre-7.3 */
  54
  55
  56 /* macros for representing SQLSTATE strings compactly */
  57 #define PGSIXBIT(ch)    (((ch) - '0') & 0x3F)
  58 #define PGUNSIXBIT(val) (((val) & 0x3F) + '0')
  59
  60 #define MAKE_SQLSTATE(ch1,ch2,ch3,ch4,ch5)      \
  61         (PGSIXBIT(ch1) + (PGSIXBIT(ch2) << 6) + (PGSIXBIT(ch3) << 12) + \
  62          (PGSIXBIT(ch4) << 18) + (PGSIXBIT(ch5) << 24))
  63
  64 /* These macros depend on the fact that '0' becomes a zero in SIXBIT */
  65 #define ERRCODE_TO_CATEGORY(ec)  ((ec) & ((1 << 12) - 1))
  66 #define ERRCODE_IS_CATEGORY(ec)  (((ec) & ~((1 << 12) - 1)) == 0)
  67
  68 /* SQLSTATE codes for errors are defined in a separate file */
  69 #include "utils/errcodes.h"
  70
  71
  72 /* Which __func__ symbol do we have, if any? */
  73 #ifdef HAVE_FUNCNAME__FUNC
  74 #define PG_FUNCNAME_MACRO       __func__
  75 #else
  76 #ifdef HAVE_FUNCNAME__FUNCTION
  77 #define PG_FUNCNAME_MACRO       __FUNCTION__
  78 #else
  79 #define PG_FUNCNAME_MACRO       NULL
  80 #endif
  81 #endif
  82
  83
  84 /*----------
  85  * New-style error reporting API: to be used in this way:
  86  *              ereport(ERROR,
  87  *                              (errcode(ERRCODE_UNDEFINED_CURSOR),
  88  *                               errmsg("portal \"%s\" not found", stmt->portalname),
  89  *                               ... other errxxx() fields as needed ...));
  90  *
  91  * The error level is required, and so is a primary error message (errmsg
  92  * or errmsg_internal).  All else is optional.  errcode() defaults to
  93  * ERRCODE_INTERNAL_ERROR if elevel is ERROR or more, ERRCODE_WARNING
  94  * if elevel is WARNING, or ERRCODE_SUCCESSFUL_COMPLETION if elevel is
  95  * NOTICE or below.
  96  *----------
  97  */
  98 #define ereport(elevel, rest)  \
  99         (errstart(elevel, __FILE__, __LINE__, PG_FUNCNAME_MACRO) ? \
 100          (errfinish rest) : (void) 0)
 101
 102 extern bool errstart(int elevel, const char *filename, int lineno,
 103                  const char *funcname);
 104 extern void errfinish(int dummy,...);
 105
 106 extern int      errcode(int sqlerrcode);
 107
 108 extern int      errcode_for_file_access(void);
 109 extern int      errcode_for_socket_access(void);
 110
 111 extern int
 112 errmsg(const char *fmt,...)
 113 /* This extension allows gcc to check the format string for consistency with
 114    the supplied arguments. */
 115 __attribute__((format(printf, 1, 2)));
 116
 117 extern int
 118 errmsg_internal(const char *fmt,...)
 119 /* This extension allows gcc to check the format string for consistency with
 120    the supplied arguments. */
 121 __attribute__((format(printf, 1, 2)));
 122
 123 extern int
 124 errdetail(const char *fmt,...)
 125 /* This extension allows gcc to check the format string for consistency with
 126    the supplied arguments. */
 127 __attribute__((format(printf, 1, 2)));
 128
 129 extern int
 130 errhint(const char *fmt,...)
 131 /* This extension allows gcc to check the format string for consistency with
 132    the supplied arguments. */
 133 __attribute__((format(printf, 1, 2)));
 134
 135 extern int
 136 errcontext(const char *fmt,...)
 137 /* This extension allows gcc to check the format string for consistency with
 138    the supplied arguments. */
 139 __attribute__((format(printf, 1, 2)));
 140
 141 extern int      errfunction(const char *funcname);
 142 extern int      errposition(int cursorpos);
 143
 144 extern int      internalerrposition(int cursorpos);
 145 extern int      internalerrquery(const char *query);
 146
 147 extern int      geterrposition(void);
 148 extern int      getinternalerrposition(void);
 149
 150
 151 /*----------
 152  * Old-style error reporting API: to be used in this way:
 153  *              elog(ERROR, "portal \"%s\" not found", stmt->portalname);
 154  *----------
 155  */
 156 #define elog    errstart(ERROR, __FILE__, __LINE__, PG_FUNCNAME_MACRO), elog_finish
 157
 158 extern void
 159 elog_finish(int elevel, const char *fmt,...)
 160 /* This extension allows gcc to check the format string for consistency with
 161    the supplied arguments. */
 162 __attribute__((format(printf, 2, 3)));
 163
 164
 165 /* Support for attaching context information to error reports */
 166
 167 typedef struct ErrorContextCallback
 168 {
 169         struct ErrorContextCallback *previous;
 170         void            (*callback) (void *arg);
 171         void       *arg;
 172 } ErrorContextCallback;
 173
 174 extern DLLIMPORT ErrorContextCallback *error_context_stack;
 175
 176
 177 /*----------
 178  * API for catching ereport(ERROR) exits.  Use these macros like so:
 179  *
 180  *              PG_TRY();
 181  *              {
 182  *                      ... code that might throw ereport(ERROR) ...
 183  *              }
 184  *              PG_CATCH();
 185  *              {
 186  *                      ... error recovery code ...
 187  *              }
 188  *              PG_END_TRY();
 189  *
 190  * (The braces are not actually necessary, but are recommended so that
 191  * pg_indent will indent the construct nicely.)  The error recovery code
 192  * can optionally do PG_RE_THROW() to propagate the same error outwards.
 193  *
 194  * Note: while the system will correctly propagate any new ereport(ERROR)
 195  * occurring in the recovery section, there is a small limit on the number
 196  * of levels this will work for.  It's best to keep the error recovery
 197  * section simple enough that it can't generate any new errors, at least
 198  * not before popping the error stack.
 199  *----------
 200  */
 201 #define PG_TRY()  \
 202         do { \
 203                 sigjmp_buf *save_exception_stack = PG_exception_stack; \
 204                 ErrorContextCallback *save_context_stack = error_context_stack; \
 205                 sigjmp_buf local_sigjmp_buf; \
 206                 if (sigsetjmp(local_sigjmp_buf, 1) == 0) \
 207                 { \
 208                         PG_exception_stack = &local_sigjmp_buf
 209
 210 #define PG_CATCH()  \
 211                 } \
 212                 else \
 213                 { \
 214                         PG_exception_stack = save_exception_stack; \
 215                         error_context_stack = save_context_stack
 216
 217 #define PG_END_TRY()  \
 218                 } \
 219                 PG_exception_stack = save_exception_stack; \
 220                 error_context_stack = save_context_stack; \
 221         } while (0)
 222
 223 #define PG_RE_THROW()  \
 224         siglongjmp(*PG_exception_stack, 1)
 225
 226 extern DLLIMPORT sigjmp_buf *PG_exception_stack;
 227
 228
 229 /* Stuff that error handlers might want to use */
 230
 231 /*
 232  * ErrorData holds the data accumulated during any one ereport() cycle.
 233  * Any non-NULL pointers must point to palloc'd data.
 234  * (The const pointers are an exception; we assume they point at non-freeable
 235  * constant strings.)
 236  */
 237 typedef struct ErrorData
 238 {
 239         int                     elevel;                 /* error level */
 240         bool            output_to_server;               /* will report to server log? */
 241         bool            output_to_client;               /* will report to client? */
 242         bool            show_funcname;  /* true to force funcname inclusion */
 243         const char *filename;           /* __FILE__ of ereport() call */
 244         int                     lineno;                 /* __LINE__ of ereport() call */
 245         const char *funcname;           /* __func__ of ereport() call */
 246         int                     sqlerrcode;             /* encoded ERRSTATE */
 247         char       *message;            /* primary error message */
 248         char       *detail;                     /* detail error message */
 249         char       *hint;                       /* hint message */
 250         char       *context;            /* context message */
 251         int                     cursorpos;              /* cursor index into query string */
 252         int                     internalpos;    /* cursor index into internalquery */
 253         char       *internalquery;      /* text of internally-generated query */
 254         int                     saved_errno;    /* errno at entry */
 255 } ErrorData;
 256
 257 extern void EmitErrorReport(void);
 258 extern ErrorData *CopyErrorData(void);
 259 extern void FreeErrorData(ErrorData *edata);
 260 extern void FlushErrorState(void);
 261 extern void ReThrowError(ErrorData *edata);
 262
 263
 264 /* GUC-configurable parameters */
 265
 266 typedef enum
 267 {
 268         PGERROR_TERSE,                          /* single-line error messages */
 269         PGERROR_DEFAULT,                        /* recommended style */
 270         PGERROR_VERBOSE                         /* all the facts, ma'am */
 271 } PGErrorVerbosity;
 272
 273 extern PGErrorVerbosity Log_error_verbosity;
 274 extern char *Log_line_prefix;
 275 extern unsigned int Log_destination;
 276
 277 /* Log destination bitmap */
 278 #define LOG_DESTINATION_STDERR   1
 279 #define LOG_DESTINATION_SYSLOG   2
 280 #define LOG_DESTINATION_EVENTLOG 4
 281
 282 /* Other exported functions */
 283 extern void DebugFileOpen(void);
 284
 285 /*
 286  * Write errors to stderr (or by equal means when stderr is
 287  * not available). Used before ereport/elog can be used
 288  * safely (memory context, GUC load etc)
 289  */
 290 extern void write_stderr(const char *fmt,...)
 291 /* This extension allows gcc to check the format string for consistency with
 292    the supplied arguments. */
 293 __attribute__((format(printf, 1, 2)));
 294
 295 #endif   /* ELOG_H */