#include <setjmp.h>
#include "lib/stringinfo.h"
#include "utils/errcodes.h"

Include dependency graph for elog.h:

This graph shows which files directly or indirectly include this file:

Data Structures
struct	ErrorContextCallback

struct	ErrorData

Macros
#define	DEBUG5

#define	DEBUG4 11

#define	DEBUG3 12

#define	DEBUG2 13

#define	DEBUG1 14 /* used by GUC debug_* variables */

#define	LOG

#define	LOG_SERVER_ONLY

#define	COMMERROR

#define	INFO

#define	NOTICE

#define	WARNING

#define	PGWARNING 19 /* Must equal WARNING; see NOTE below. */

#define	WARNING_CLIENT_ONLY

#define	ERROR

#define	PGERROR 21 /* Must equal ERROR; see NOTE below. */

#define	FATAL 22 /* fatal error - abort process */

#define	PANIC 23 /* take down the other backends with me */

#define	PGSIXBIT(ch) (((ch) - '0') & 0x3F)

#define	PGUNSIXBIT(val) (((val) & 0x3F) + '0')

#define	MAKE_SQLSTATE(ch1, ch2, ch3, ch4, ch5)

#define	ERRCODE_TO_CATEGORY(ec) ((ec) & ((1 << 12) - 1))

#define	ERRCODE_IS_CATEGORY(ec) (((ec) & ~((1 << 12) - 1)) == 0)

#define	pg_prevent_errno_in_scope()

#define	ereport_domain(elevel, domain, ...)

#define	ereport(elevel, ...) ereport_domain(elevel, TEXTDOMAIN, __VA_ARGS__)

#define	TEXTDOMAIN NULL

#define	errcontext set_errcontext_domain(TEXTDOMAIN), errcontext_msg

#define	elog(elevel, ...) ereport(elevel, errmsg_internal(__VA_ARGS__))

#define	errsave_domain(context, domain, ...)

#define	errsave(context, ...) errsave_domain(context, TEXTDOMAIN, __VA_ARGS__)

#define	ereturn_domain(context, dummy_value, domain, ...)

#define	ereturn(context, dummy_value, ...) ereturn_domain(context, dummy_value, TEXTDOMAIN, __VA_ARGS__)

#define	PG_TRY(...)

#define	PG_CATCH(...)

#define	PG_FINALLY(...)

#define	PG_END_TRY(...)

#define	PG_RE_THROW() pg_re_throw()

#define	LOG_DESTINATION_STDERR 1

#define	LOG_DESTINATION_SYSLOG 2

#define	LOG_DESTINATION_EVENTLOG 4

#define	LOG_DESTINATION_CSVLOG 8

#define	LOG_DESTINATION_JSONLOG 16

Typedefs
typedef char struct ErrorContextCallback	ErrorContextCallback

typedef struct ErrorData	ErrorData

typedef void(*	emit_log_hook_type) (ErrorData *edata)

Enumerations
enum	PGErrorVerbosity { PGERROR_TERSE , PGERROR_DEFAULT , PGERROR_VERBOSE }

Functions
bool	message_level_is_interesting (int elevel)

bool	errstart (int elevel, const char *domain)

pg_attribute_cold bool	errstart_cold (int elevel, const char *domain)

void	errfinish (const char filename, int lineno, const char funcname)

int	errcode (int sqlerrcode)

int	errcode_for_file_access (void)

int	errcode_for_socket_access (void)

int	errmsg (const char *fmt,...) pg_attribute_printf(1

int int	errmsg_internal (const char *fmt,...) pg_attribute_printf(1

int int int	errmsg_plural (const char fmt_singular, const char fmt_plural, unsigned long n,...) pg_attribute_printf(1

int int int	pg_attribute_printf (2, 4)

int	errdetail (const char *fmt,...) pg_attribute_printf(1

int int	errdetail_internal (const char *fmt,...) pg_attribute_printf(1

int int int	errdetail_log (const char *fmt,...) pg_attribute_printf(1

int int int int	errdetail_log_plural (const char fmt_singular, const char fmt_plural, unsigned long n,...) pg_attribute_printf(1

int	errdetail_plural (const char fmt_singular, const char fmt_plural, unsigned long n,...) pg_attribute_printf(1

int	errhint (const char *fmt,...) pg_attribute_printf(1

int int	errhint_internal (const char *fmt,...) pg_attribute_printf(1

int int int	errhint_plural (const char fmt_singular, const char fmt_plural, unsigned long n,...) pg_attribute_printf(1

int	set_errcontext_domain (const char *domain)

int	errcontext_msg (const char *fmt,...) pg_attribute_printf(1

int int	errhidestmt (bool hide_stmt)

int	errhidecontext (bool hide_ctx)

int	errbacktrace (void)

int	errposition (int cursorpos)

int	internalerrposition (int cursorpos)

int	internalerrquery (const char *query)

int	err_generic_string (int field, const char *str)

int	geterrcode (void)

int	geterrposition (void)

int	getinternalerrposition (void)

bool	errsave_start (struct Node context, const char domain)

void	errsave_finish (struct Node context, const char filename, int lineno, const char *funcname)

void	pre_format_elog_string (int errnumber, const char *domain)

char *	format_elog_string (const char *fmt,...) pg_attribute_printf(1

void	EmitErrorReport (void)

ErrorData *	CopyErrorData (void)

void	FreeErrorData (ErrorData *edata)

void	FlushErrorState (void)

pg_noreturn void	ReThrowError (ErrorData *edata)

void	ThrowErrorData (ErrorData *edata)

pg_noreturn void	pg_re_throw (void)

char *	GetErrorContextStack (void)

void	log_status_format (StringInfo buf, const char format, ErrorData edata)

void	DebugFileOpen (void)

char *	unpack_sql_state (int sql_state)

bool	in_error_recursion_trouble (void)

void	reset_formatted_start_time (void)

char *	get_formatted_start_time (void)

char *	get_formatted_log_time (void)

const char *	get_backend_type_for_log (void)

bool	check_log_of_query (ErrorData *edata)

const char *	error_severity (int elevel)

void	write_pipe_chunks (char *data, int len, int dest)

void	write_csvlog (ErrorData *edata)

void	write_jsonlog (ErrorData *edata)

void	write_stderr (const char *fmt,...) pg_attribute_printf(1

void void	vwrite_stderr (const char *fmt, va_list ap) pg_attribute_printf(1

Variables
PGDLLIMPORT ErrorContextCallback *	error_context_stack

PGDLLIMPORT sigjmp_buf *	PG_exception_stack

PGDLLIMPORT emit_log_hook_type	emit_log_hook

PGDLLIMPORT int	Log_error_verbosity

PGDLLIMPORT char *	Log_line_prefix

PGDLLIMPORT int	Log_destination

PGDLLIMPORT char *	Log_destination_string

PGDLLIMPORT bool	syslog_sequence_numbers

PGDLLIMPORT bool	syslog_split_messages

Macro Definition Documentation

◆ COMMERROR

#define COMMERROR

Value:

                                     LOG_SERVER_ONLY /* Client communication problems; same as
                                     * LOG for server reporting, but never
                                     * sent to client. */

Definition at line 33 of file elog.h.

◆ DEBUG1

#define DEBUG1 14 /* used by GUC debug_* variables */

Definition at line 30 of file elog.h.

◆ DEBUG2

#define DEBUG2 13

Definition at line 29 of file elog.h.

◆ DEBUG3

#define DEBUG3 12

Definition at line 28 of file elog.h.

◆ DEBUG4

#define DEBUG4 11

Definition at line 27 of file elog.h.

◆ DEBUG5

#define DEBUG5

Value:

10 /* Debugging messages, in categories of

* decreasing detail. */

Definition at line 26 of file elog.h.

◆ elog

#define elog	(	elevel,
		...
	)	ereport(elevel, errmsg_internal(__VA_ARGS__))

Definition at line 226 of file elog.h.

◆ ereport

#define ereport	(	elevel,
		...
	)	ereport_domain(elevel, TEXTDOMAIN, __VA_ARGS__)

Definition at line 150 of file elog.h.

◆ ereport_domain

#define ereport_domain	(	elevel,
		domain,
		...
	)

Value:

    do { \
        const int elevel_ = (elevel); \
        pg_prevent_errno_in_scope(); \
        if (errstart(elevel_, domain)) \
            __VA_ARGS__, errfinish(__FILE__, __LINE__, __func__); \
        if (elevel_ >= ERROR) \
            pg_unreachable(); \
    } while(0)

Definition at line 139 of file elog.h.

◆ ereturn

#define ereturn	(	context,
		dummy_value,
		...
	)	ereturn_domain(context, dummy_value, TEXTDOMAIN, __VA_ARGS__)

Definition at line 278 of file elog.h.

◆ ereturn_domain

#define ereturn_domain	(	context,
		dummy_value,
		domain,
		...
	)

Value:

    do { \
        errsave_domain(context, domain, __VA_ARGS__); \
        return dummy_value; \
    } while(0)

Definition at line 272 of file elog.h.

◆ ERRCODE_IS_CATEGORY

#define ERRCODE_IS_CATEGORY ( ec ) (((ec) & ~((1 << 12) - 1)) == 0)

Definition at line 62 of file elog.h.

◆ ERRCODE_TO_CATEGORY

#define ERRCODE_TO_CATEGORY ( ec ) ((ec) & ((1 << 12) - 1))

Definition at line 61 of file elog.h.

◆ errcontext

#define errcontext set_errcontext_domain(TEXTDOMAIN), errcontext_msg

Definition at line 198 of file elog.h.

◆ ERROR

#define ERROR

Value:

21 /* user error - abort transaction; return to

* known state */

Definition at line 39 of file elog.h.

◆ errsave

#define errsave	(	context,
		...
	)	errsave_domain(context, TEXTDOMAIN, __VA_ARGS__)

Definition at line 262 of file elog.h.

◆ errsave_domain

#define errsave_domain	(	context,
		domain,
		...
	)

Value:

    do { \
        struct Node *context_ = (context); \
        pg_prevent_errno_in_scope(); \
        if (errsave_start(context_, domain)) \
            __VA_ARGS__, errsave_finish(context_, __FILE__, __LINE__, __func__); \
    } while(0)

Definition at line 254 of file elog.h.

◆ FATAL

#define FATAL 22 /* fatal error - abort process */

Definition at line 41 of file elog.h.

◆ INFO

#define INFO

Value:

                                 17         /* Messages specifically requested by user (eg
                                 * VACUUM VERBOSE output); always sent to
                                 * client regardless of client_min_messages,
                                 * but by default not sent to server log. */

Definition at line 34 of file elog.h.

◆ LOG

#define LOG

Value:

15 /* Server operational messages; sent only to

* server log by default. */

Definition at line 31 of file elog.h.

◆ LOG_DESTINATION_CSVLOG

#define LOG_DESTINATION_CSVLOG 8

Definition at line 488 of file elog.h.

◆ LOG_DESTINATION_EVENTLOG

#define LOG_DESTINATION_EVENTLOG 4

Definition at line 487 of file elog.h.

◆ LOG_DESTINATION_JSONLOG

#define LOG_DESTINATION_JSONLOG 16

Definition at line 489 of file elog.h.

◆ LOG_DESTINATION_STDERR

#define LOG_DESTINATION_STDERR 1

Definition at line 485 of file elog.h.

◆ LOG_DESTINATION_SYSLOG

#define LOG_DESTINATION_SYSLOG 2

Definition at line 486 of file elog.h.

◆ LOG_SERVER_ONLY

#define LOG_SERVER_ONLY

Value:

16 /* Same as LOG for server reporting, but never

* sent to client. */

Definition at line 32 of file elog.h.

◆ MAKE_SQLSTATE

#define MAKE_SQLSTATE	(	ch1,
		ch2,
		ch3,
		ch4,
		ch5
	)

Value:

(PGSIXBIT(ch1) + (PGSIXBIT(ch2) << 6) + (PGSIXBIT(ch3) << 12) + \

(PGSIXBIT(ch4) << 18) + (PGSIXBIT(ch5) << 24))

PGSIXBIT

#define PGSIXBIT(ch)

Definition: elog.h:53

Definition at line 56 of file elog.h.

◆ NOTICE

#define NOTICE

Value:

                                 18         /* Helpful messages to users about query
                                 * operation; sent to client and not to server
                                 * log by default. */

Definition at line 35 of file elog.h.

◆ PANIC

#define PANIC 23 /* take down the other backends with me */

Definition at line 42 of file elog.h.

◆ PG_CATCH

#define PG_CATCH ( ... )

Value:

        } \
        else \
        { \
            PG_exception_stack = _save_exception_stack##__VA_ARGS__; \
            error_context_stack = _save_context_stack##__VA_ARGS__

Definition at line 382 of file elog.h.

◆ PG_END_TRY

#define PG_END_TRY ( ... )

Value:

        } \
        if (_do_rethrow##__VA_ARGS__) \
                PG_RE_THROW(); \
        PG_exception_stack = _save_exception_stack##__VA_ARGS__; \
        error_context_stack = _save_context_stack##__VA_ARGS__; \
    } while (0)

Definition at line 397 of file elog.h.

◆ PG_FINALLY

#define PG_FINALLY ( ... )

Value:

        } \
        else \
            _do_rethrow##__VA_ARGS__ = true; \
        { \
            PG_exception_stack = _save_exception_stack##__VA_ARGS__; \
            error_context_stack = _save_context_stack##__VA_ARGS__

Definition at line 389 of file elog.h.

◆ pg_prevent_errno_in_scope

#define pg_prevent_errno_in_scope ( )

Definition at line 81 of file elog.h.

◆ PG_RE_THROW

#define PG_RE_THROW ( ) pg_re_throw()

Definition at line 405 of file elog.h.

◆ PG_TRY

#define PG_TRY ( ... )

Value:

    do { \
        sigjmp_buf *_save_exception_stack##__VA_ARGS__ = PG_exception_stack; \
        ErrorContextCallback *_save_context_stack##__VA_ARGS__ = error_context_stack; \
        sigjmp_buf _local_sigjmp_buf##__VA_ARGS__; \
        bool _do_rethrow##__VA_ARGS__ = false; \
        if (sigsetjmp(_local_sigjmp_buf##__VA_ARGS__, 0) == 0) \
        { \
            PG_exception_stack = &_local_sigjmp_buf##__VA_ARGS__

Definition at line 372 of file elog.h.

◆ PGERROR

#define PGERROR 21 /* Must equal ERROR; see NOTE below. */

Definition at line 40 of file elog.h.

◆ PGSIXBIT

#define PGSIXBIT ( ch ) (((ch) - '0') & 0x3F)

Definition at line 53 of file elog.h.

◆ PGUNSIXBIT

#define PGUNSIXBIT ( val ) (((val) & 0x3F) + '0')

Definition at line 54 of file elog.h.

◆ PGWARNING

#define PGWARNING 19 /* Must equal WARNING; see NOTE below. */

Definition at line 37 of file elog.h.

◆ TEXTDOMAIN

#define TEXTDOMAIN NULL

Definition at line 153 of file elog.h.

◆ WARNING

#define WARNING

Value:

                                 19         /* Warnings.  NOTICE is for expected messages
                                 * like implicit sequence creation by SERIAL.
                                 * WARNING is for unexpected messages. */

Definition at line 36 of file elog.h.

◆ WARNING_CLIENT_ONLY

#define WARNING_CLIENT_ONLY

Value:

20 /* Warnings to be sent to client as usual, but

* never to the server log. */

Definition at line 38 of file elog.h.

Typedef Documentation

◆ emit_log_hook_type

typedef void(* emit_log_hook_type) (ErrorData *edata)

Definition at line 464 of file elog.h.

◆ ErrorContextCallback

typedef char struct ErrorContextCallback ErrorContextCallback

◆ ErrorData

typedef struct ErrorData ErrorData

Enumeration Type Documentation

◆ PGErrorVerbosity

enum PGErrorVerbosity

Enumerator
PGERROR_TERSE
PGERROR_DEFAULT
PGERROR_VERBOSE

Definition at line 470 of file elog.h.

485{

Function Documentation

◆ check_log_of_query()

bool check_log_of_query ( ErrorData * edata )

Definition at line 2752 of file elog.c.

{
    /* log required? */
    if (!is_log_level_output(edata->elevel, log_min_error_statement))
        return false;
 
    /* query log wanted? */
    if (edata->hide_stmt)
        return false;
 
    /* query string available? */
    if (debug_query_string == NULL)
        return false;
 
    return true;
}

References debug_query_string, ErrorData::elevel, ErrorData::hide_stmt, is_log_level_output(), and log_min_error_statement.

Referenced by send_message_to_server_log(), write_csvlog(), and write_jsonlog().

◆ CopyErrorData()

ErrorData * CopyErrorData ( void )

Definition at line 1763 of file elog.c.

{
    ErrorData  *edata = &errordata[errordata_stack_depth];
    ErrorData  *newedata;
 
    /*
     * we don't increment recursion_depth because out-of-memory here does not
     * indicate a problem within the error subsystem.
     */
    CHECK_STACK_DEPTH();
 
    Assert(CurrentMemoryContext != ErrorContext);
 
    /* Copy the struct itself */
    newedata = (ErrorData *) palloc(sizeof(ErrorData));
    memcpy(newedata, edata, sizeof(ErrorData));
 
    /*
     * Make copies of separately-allocated strings.  Note that we copy even
     * theoretically-constant strings such as filename.  This is because those
     * could point into JIT-created code segments that might get unloaded at
     * transaction cleanup.  In some cases we need the copied ErrorData to
     * survive transaction boundaries, so we'd better copy those strings too.
     */
    if (newedata->filename)
        newedata->filename = pstrdup(newedata->filename);
    if (newedata->funcname)
        newedata->funcname = pstrdup(newedata->funcname);
    if (newedata->domain)
        newedata->domain = pstrdup(newedata->domain);
    if (newedata->context_domain)
        newedata->context_domain = pstrdup(newedata->context_domain);
    if (newedata->message)
        newedata->message = pstrdup(newedata->message);
    if (newedata->detail)
        newedata->detail = pstrdup(newedata->detail);
    if (newedata->detail_log)
        newedata->detail_log = pstrdup(newedata->detail_log);
    if (newedata->hint)
        newedata->hint = pstrdup(newedata->hint);
    if (newedata->context)
        newedata->context = pstrdup(newedata->context);
    if (newedata->backtrace)
        newedata->backtrace = pstrdup(newedata->backtrace);
    if (newedata->message_id)
        newedata->message_id = pstrdup(newedata->message_id);
    if (newedata->schema_name)
        newedata->schema_name = pstrdup(newedata->schema_name);
    if (newedata->table_name)
        newedata->table_name = pstrdup(newedata->table_name);
    if (newedata->column_name)
        newedata->column_name = pstrdup(newedata->column_name);
    if (newedata->datatype_name)
        newedata->datatype_name = pstrdup(newedata->datatype_name);
    if (newedata->constraint_name)
        newedata->constraint_name = pstrdup(newedata->constraint_name);
    if (newedata->internalquery)
        newedata->internalquery = pstrdup(newedata->internalquery);
 
    /* Use the calling context for string allocation */
    newedata->assoc_context = CurrentMemoryContext;
 
    return newedata;
}

References Assert(), ErrorData::assoc_context, ErrorData::backtrace, CHECK_STACK_DEPTH, ErrorData::column_name, ErrorData::constraint_name, ErrorData::context, ErrorData::context_domain, CurrentMemoryContext, ErrorData::datatype_name, ErrorData::detail, ErrorData::detail_log, ErrorData::domain, ErrorContext, errordata, errordata_stack_depth, ErrorData::filename, ErrorData::funcname, ErrorData::hint, ErrorData::internalquery, ErrorData::message, ErrorData::message_id, palloc(), pstrdup(), ErrorData::schema_name, and ErrorData::table_name.

Referenced by _SPI_commit(), _SPI_rollback(), exec_stmt_block(), GetConnection(), initTrie(), plperl_return_next(), plperl_spi_commit(), plperl_spi_exec(), plperl_spi_exec_prepared(), plperl_spi_fetchrow(), plperl_spi_prepare(), plperl_spi_query(), plperl_spi_query_prepared(), plperl_spi_rollback(), plperl_util_elog(), pltcl_commit(), pltcl_elog(), pltcl_rollback(), pltcl_subtrans_abort(), PLy_commit(), PLy_output(), PLy_rollback(), PLy_spi_subtransaction_abort(), and ReorderBufferProcessTXN().

◆ DebugFileOpen()

void DebugFileOpen ( void )

Definition at line 2128 of file elog.c.

{
    int         fd,
                istty;
 
    if (OutputFileName[0])
    {
        /*
         * A debug-output file name was given.
         *
         * Make sure we can write the file, and find out if it's a tty.
         */
        if ((fd = open(OutputFileName, O_CREAT | O_APPEND | O_WRONLY,
                       0666)) < 0)
            ereport(FATAL,
                    (errcode_for_file_access(),
                     errmsg("could not open file \"%s\": %m", OutputFileName)));
        istty = isatty(fd);
        close(fd);
 
        /*
         * Redirect our stderr to the debug output file.
         */
        if (!freopen(OutputFileName, "a", stderr))
            ereport(FATAL,
                    (errcode_for_file_access(),
                     errmsg("could not reopen file \"%s\" as stderr: %m",
                            OutputFileName)));
 
        /*
         * If the file is a tty and we're running under the postmaster, try to
         * send stdout there as well (if it isn't a tty then stderr will block
         * out stdout, so we may as well let stdout go wherever it was going
         * before).
         */
        if (istty && IsUnderPostmaster)
            if (!freopen(OutputFileName, "a", stdout))
                ereport(FATAL,
                        (errcode_for_file_access(),
                         errmsg("could not reopen file \"%s\" as stdout: %m",
                                OutputFileName)));
    }
}

References close, ereport, errcode_for_file_access(), errmsg(), FATAL, fd(), IsUnderPostmaster, OutputFileName, and generate_unaccent_rules::stdout.

Referenced by BaseInit().

◆ EmitErrorReport()

void EmitErrorReport ( void )

Definition at line 1704 of file elog.c.

{
    ErrorData  *edata = &errordata[errordata_stack_depth];
    MemoryContext oldcontext;
 
    recursion_depth++;
    CHECK_STACK_DEPTH();
    oldcontext = MemoryContextSwitchTo(edata->assoc_context);
 
    /*
     * Reset the formatted timestamp fields before emitting any logs.  This
     * includes all the log destinations and emit_log_hook, as the latter
     * could use log_line_prefix or the formatted timestamps.
     */
    saved_timeval_set = false;
    formatted_log_time[0] = '\0';
 
    /*
     * Call hook before sending message to log.  The hook function is allowed
     * to turn off edata->output_to_server, so we must recheck that afterward.
     * Making any other change in the content of edata is not considered
     * supported.
     *
     * Note: the reason why the hook can only turn off output_to_server, and
     * not turn it on, is that it'd be unreliable: we will never get here at
     * all if errstart() deems the message uninteresting.  A hook that could
     * make decisions in that direction would have to hook into errstart(),
     * where it would have much less information available.  emit_log_hook is
     * intended for custom log filtering and custom log message transmission
     * mechanisms.
     *
     * The log hook has access to both the translated and original English
     * error message text, which is passed through to allow it to be used as a
     * message identifier. Note that the original text is not available for
     * detail, detail_log, hint and context text elements.
     */
    if (edata->output_to_server && emit_log_hook)
        (*emit_log_hook) (edata);
 
    /* Send to server log, if enabled */
    if (edata->output_to_server)
        send_message_to_server_log(edata);
 
    /* Send to client, if enabled */
    if (edata->output_to_client)
        send_message_to_frontend(edata);
 
    MemoryContextSwitchTo(oldcontext);
    recursion_depth--;
}

References ErrorData::assoc_context, CHECK_STACK_DEPTH, emit_log_hook, errordata, errordata_stack_depth, formatted_log_time, MemoryContextSwitchTo(), ErrorData::output_to_client, ErrorData::output_to_server, recursion_depth, saved_timeval_set, send_message_to_frontend(), and send_message_to_server_log().

Referenced by AutoVacLauncherMain(), AutoVacWorkerMain(), BackgroundWorkerMain(), BackgroundWriterMain(), CheckpointerMain(), DisableSubscriptionAndExit(), do_autovacuum(), errfinish(), IoWorkerMain(), perform_work_item(), pgarch_archiveXlog(), PostgresMain(), ReplSlotSyncWorkerMain(), WalSummarizerMain(), and WalWriterMain().

◆ err_generic_string()

int err_generic_string	(	int	field,
		const char *	str
	)

Definition at line 1546 of file elog.c.

{
    ErrorData  *edata = &errordata[errordata_stack_depth];
 
    /* we don't bother incrementing recursion_depth */
    CHECK_STACK_DEPTH();
 
    switch (field)
    {
        case PG_DIAG_SCHEMA_NAME:
            set_errdata_field(edata->assoc_context, &edata->schema_name, str);
            break;
        case PG_DIAG_TABLE_NAME:
            set_errdata_field(edata->assoc_context, &edata->table_name, str);
            break;
        case PG_DIAG_COLUMN_NAME:
            set_errdata_field(edata->assoc_context, &edata->column_name, str);
            break;
        case PG_DIAG_DATATYPE_NAME:
            set_errdata_field(edata->assoc_context, &edata->datatype_name, str);
            break;
        case PG_DIAG_CONSTRAINT_NAME:
            set_errdata_field(edata->assoc_context, &edata->constraint_name, str);
            break;
        default:
            elog(ERROR, "unsupported ErrorData field id: %d", field);
            break;
    }
 
    return 0;                   /* return value does not matter */
}

References ErrorData::assoc_context, CHECK_STACK_DEPTH, ErrorData::column_name, ErrorData::constraint_name, ErrorData::datatype_name, elog, ERROR, errordata, errordata_stack_depth, PG_DIAG_COLUMN_NAME, PG_DIAG_CONSTRAINT_NAME, PG_DIAG_DATATYPE_NAME, PG_DIAG_SCHEMA_NAME, PG_DIAG_TABLE_NAME, ErrorData::schema_name, set_errdata_field(), str, and ErrorData::table_name.

Referenced by errdatatype(), errdomainconstraint(), errtable(), errtablecolname(), errtableconstraint(), exec_stmt_raise(), PLy_elog_impl(), and PLy_output().

◆ errbacktrace()

int errbacktrace ( void )

Definition at line 1102 of file elog.c.

{
    ErrorData  *edata = &errordata[errordata_stack_depth];
    MemoryContext oldcontext;
 
    recursion_depth++;
    CHECK_STACK_DEPTH();
    oldcontext = MemoryContextSwitchTo(edata->assoc_context);
 
    set_backtrace(edata, 1);
 
    MemoryContextSwitchTo(oldcontext);
    recursion_depth--;
 
    return 0;
}

References ErrorData::assoc_context, CHECK_STACK_DEPTH, errordata, errordata_stack_depth, MemoryContextSwitchTo(), recursion_depth, and set_backtrace().

◆ errcode()

int errcode ( int sqlerrcode )

Definition at line 863 of file elog.c.

{
    ErrorData  *edata = &errordata[errordata_stack_depth];
 
    /* we don't bother incrementing recursion_depth */
    CHECK_STACK_DEPTH();
 
    edata->sqlerrcode = sqlerrcode;
 
    return 0;                   /* return value does not matter */
}

References CHECK_STACK_DEPTH, errordata, errordata_stack_depth, and ErrorData::sqlerrcode.

◆ errcode_for_file_access()

int errcode_for_file_access ( void )

Definition at line 886 of file elog.c.

{
    ErrorData  *edata = &errordata[errordata_stack_depth];
 
    /* we don't bother incrementing recursion_depth */
    CHECK_STACK_DEPTH();
 
    switch (edata->saved_errno)
    {
            /* Permission-denied failures */
        case EPERM:             /* Not super-user */
        case EACCES:            /* Permission denied */
#ifdef EROFS
        case EROFS:             /* Read only file system */
#endif
            edata->sqlerrcode = ERRCODE_INSUFFICIENT_PRIVILEGE;
            break;
 
            /* File not found */
        case ENOENT:            /* No such file or directory */
            edata->sqlerrcode = ERRCODE_UNDEFINED_FILE;
            break;
 
            /* Duplicate file */
        case EEXIST:            /* File exists */
            edata->sqlerrcode = ERRCODE_DUPLICATE_FILE;
            break;
 
            /* Wrong object type or state */
        case ENOTDIR:           /* Not a directory */
        case EISDIR:            /* Is a directory */
        case ENOTEMPTY:         /* Directory not empty */
            edata->sqlerrcode = ERRCODE_WRONG_OBJECT_TYPE;
            break;
 
            /* Insufficient resources */
        case ENOSPC:            /* No space left on device */
            edata->sqlerrcode = ERRCODE_DISK_FULL;
            break;
 
        case ENOMEM:            /* Out of memory */
            edata->sqlerrcode = ERRCODE_OUT_OF_MEMORY;
            break;
 
        case ENFILE:            /* File table overflow */
        case EMFILE:            /* Too many open files */
            edata->sqlerrcode = ERRCODE_INSUFFICIENT_RESOURCES;
            break;
 
            /* Hardware failure */
        case EIO:               /* I/O error */
            edata->sqlerrcode = ERRCODE_IO_ERROR;
            break;
 
        case ENAMETOOLONG:      /* File name too long */
            edata->sqlerrcode = ERRCODE_FILE_NAME_TOO_LONG;
            break;
 
            /* All else is classified as internal errors */
        default:
            edata->sqlerrcode = ERRCODE_INTERNAL_ERROR;
            break;
    }
 
    return 0;                   /* return value does not matter */
}

References CHECK_STACK_DEPTH, errordata, errordata_stack_depth, ErrorData::saved_errno, and ErrorData::sqlerrcode.

Referenced by _mdfd_getseg(), _mdnblocks(), AddToDataDirLockFile(), AlterSystemSetConfigFile(), ApplyLogicalMappingFile(), apw_dump_now(), apw_load_buffers(), assign_wal_sync_method(), basebackup_read_file(), basic_archive_file(), bbsink_server_archive_contents(), bbsink_server_begin_archive(), bbsink_server_begin_manifest(), bbsink_server_end_archive(), bbsink_server_manifest_contents(), bbsink_server_new(), be_lo_export(), BeginCopyFrom(), BeginCopyTo(), BootStrapXLOG(), BufFileDumpBuffer(), BufFileLoadBuffer(), BufFileOpenFileSet(), BufFileReadCommon(), BufFileSeek(), BufFileSize(), BufFileTruncateFileSet(), calculate_relation_size(), calculate_tablespace_size(), ChangeToDataDir(), check_ssl_key_file_permissions(), checkDataDir(), CheckPointLogicalRewriteHeap(), CheckPointReplicationOrigin(), CheckPointSnapBuild(), CheckXLogRemoved(), clone_file(), ClosePipeFromProgram(), ClosePipeToProgram(), ClosePostmasterPorts(), compare_files(), copy_file(), copydir(), CopyGetData(), CopySendEndOfRow(), create_tablespace_directories(), CreateDirAndVersionFile(), CreateLockFile(), CreateOptsFile(), CreateSlotOnDisk(), db_dir_size(), DebugFileOpen(), DeleteAllExportedSnapshotFiles(), destroy_tablespace_directories(), do_pg_backup_stop(), do_truncate(), dsm_cleanup_for_mmap(), dsm_impl_mmap(), durable_rename(), durable_unlink(), EndCopy(), EndCopyFrom(), entry_reset(), errcode_for_dynamic_shared_memory(), ExecHashJoinNewBatch(), existsTimeLineHistory(), ExportSnapshot(), fileAnalyzeForeignTable(), FileClose(), fsync_fname_ext(), gc_qtexts(), get_controlfile_by_exact_path(), get_dirent_type(), get_tablespace_location(), GetConfFilesInDir(), getInstallationPaths(), hashagg_batch_read(), heap_xlog_logical_rewrite(), ImportSnapshot(), InitPostgres(), InitPostmasterDeathWatchHandle(), InitWalRecovery(), internal_load_library(), issue_xlog_fsync(), KeepFileRestoredFromArchive(), lo_import_internal(), load_dh_file(), logfile_open(), logical_end_heap_rewrite(), logical_heap_rewrite_flush_mappings(), logical_rewrite_log_mapping(), ltsReadBlock(), ltsWriteBlock(), md_readv_report(), mdcreate(), mdextend(), mdimmedsync(), mdopenfork(), mdreadv(), mdstartreadv(), mdtruncate(), mdunlinkfork(), mdwritev(), mdzeroextend(), normalize_exec_path(), open_auth_file(), OpenWalSummaryFile(), parse_extension_control_file(), ParseConfigFile(), PathNameCreateTemporaryDir(), PathNameCreateTemporaryFile(), PathNameDeleteTemporaryFile(), PathNameOpenTemporaryFile(), perform_base_backup(), pg_current_logfile(), pg_file_exists(), pg_flush_data(), pg_import_system_collations(), pg_ls_dir_files(), pg_promote(), pg_stat_file(), pg_tablespace_databases(), pg_tzenumerate_next(), pg_tzenumerate_start(), pgarch_archiveDone(), pgarch_readyXlog(), PGReserveSemaphores(), PGSharedMemoryCreate(), pgss_shmem_shutdown(), pgss_shmem_startup(), pgstat_discard_stats(), pgstat_read_statsfile(), pgstat_write_statsfile(), pipe_read_line(), PostmasterMain(), PrepareRedoAdd(), ProcessSyncRequests(), qtext_load_file(), qtext_store(), read_backup_label(), read_binary_file(), read_relmap_file(), read_tablespace_map(), read_whole_file(), ReadControlFile(), ReadDirExtended(), ReadNextXLogRecord(), readRecoverySignalFile(), readTimeLineHistory(), ReadTwoPhaseFile(), ReadWalSummary(), RecheckDataDirLockFile(), RecreateTwoPhaseFile(), register_dirty_segment(), remove_tablespace_symlink(), RemovePgTempFilesInDir(), RemovePgTempRelationFilesInDbspace(), RemoveTwoPhaseFile(), RemoveWalSummaryIfOlderThan(), RemoveXlogFile(), ReorderBufferCleanupSerializedTXNs(), ReorderBufferRestoreChanges(), ReorderBufferRestoreCleanup(), ReorderBufferSerializeChange(), ReorderBufferSerializeTXN(), ReplicationSlotDropPtr(), ResetUnloggedRelationsInDbspaceDir(), ResetUnloggedRelationsInTablespaceDir(), RestoreArchivedFile(), RestoreSlotFromDisk(), run_ssl_passphrase_command(), SaveSlotToPath(), SendBackupManifest(), sendDir(), sendFile(), sendTablespace(), SendTimeLineHistory(), Setup_AF_UNIX(), shell_finish_command(), shell_run_command(), shell_send_data(), SlruReportIOError(), SnapBuildRestoreContents(), SnapBuildRestoreSnapshot(), SnapBuildSerialize(), SnapBuildSnapshotExists(), StartupReplicationOrigin(), sts_parallel_scan_next(), sts_read_tuple(), SummarizeWAL(), SyncDataDirectory(), SyncPostCheckpoint(), SysLogger_Start(), TablespaceCreateDbspace(), tokenize_auth_file(), tuplestore_copy_read_pointer(), tuplestore_gettuple(), tuplestore_puttuple_common(), tuplestore_rescan(), tuplestore_select_read_pointer(), unlink_if_exists_fname(), unlink_initfile(), update_controlfile(), update_metainfo_datafile(), ValidatePgVersion(), ValidateXLOGDirectoryStructure(), wal_segment_open(), WALReadRaiseError(), WalReceiverMain(), WalSndSegmentOpen(), write_auto_conf_file(), write_item(), write_relcache_init_file(), write_relmap_file(), WriteControlFile(), writeTimeLineHistory(), writeTimeLineHistoryFile(), WriteWalSummary(), XLogArchiveForceDone(), XLogArchiveNotify(), XLogFileClose(), XLogFileCopy(), XLogFileInit(), XLogFileInitInternal(), XLogFileOpen(), XLogFileRead(), XLogFileReadAnyTLI(), XLogInitNewTimeline(), XLogPageRead(), XlogReadTwoPhaseData(), XLogWalRcvClose(), XLogWalRcvWrite(), and XLogWrite().

◆ errcode_for_socket_access()

int errcode_for_socket_access ( void )

Definition at line 963 of file elog.c.

{
    ErrorData  *edata = &errordata[errordata_stack_depth];
 
    /* we don't bother incrementing recursion_depth */
    CHECK_STACK_DEPTH();
 
    switch (edata->saved_errno)
    {
            /* Loss of connection */
        case ALL_CONNECTION_FAILURE_ERRNOS:
            edata->sqlerrcode = ERRCODE_CONNECTION_FAILURE;
            break;
 
            /* All else is classified as internal errors */
        default:
            edata->sqlerrcode = ERRCODE_INTERNAL_ERROR;
            break;
    }
 
    return 0;                   /* return value does not matter */
}

References ALL_CONNECTION_FAILURE_ERRNOS, CHECK_STACK_DEPTH, errordata, errordata_stack_depth, ErrorData::saved_errno, and ErrorData::sqlerrcode.

Referenced by AcceptConnection(), auth_peer(), be_tls_open_server(), ident_inet(), InitPostmasterChild(), InitPostmasterDeathWatchHandle(), internal_flush_buffer(), ListenServerPort(), pq_getbyte_if_available(), pq_recvbuf(), ProcessStartupPacket(), SysLogger_Start(), SysLoggerMain(), and WaitEventSetWaitBlock().

◆ errcontext_msg()

int errcontext_msg	(	const char *	fmt,
			...
	)

◆ errdetail()

int errdetail	(	const char *	fmt,
			...
	)

◆ errdetail_internal()

int int errdetail_internal	(	const char *	fmt,
			...
	)

◆ errdetail_log()

int int int errdetail_log	(	const char *	fmt,
			...
	)

◆ errdetail_log_plural()

int int int int errdetail_log_plural	(	const char *	fmt_singular,
		const char *	fmt_plural,
		unsigned long	n,
			...
	)

◆ errdetail_plural()

int errdetail_plural	(	const char *	fmt_singular,
		const char *	fmt_plural,
		unsigned long	n,
			...
	)

◆ errfinish()

void errfinish	(	const char *	filename,
		int	lineno,
		const char *	funcname
	)

Definition at line 474 of file elog.c.

{
    ErrorData  *edata = &errordata[errordata_stack_depth];
    int         elevel;
    MemoryContext oldcontext;
    ErrorContextCallback *econtext;
 
    recursion_depth++;
    CHECK_STACK_DEPTH();
 
    /* Save the last few bits of error state into the stack entry */
    set_stack_entry_location(edata, filename, lineno, funcname);
 
    elevel = edata->elevel;
 
    /*
     * Do processing in ErrorContext, which we hope has enough reserved space
     * to report an error.
     */
    oldcontext = MemoryContextSwitchTo(ErrorContext);
 
    /* Collect backtrace, if enabled and we didn't already */
    if (!edata->backtrace &&
        edata->funcname &&
        backtrace_functions &&
        matches_backtrace_functions(edata->funcname))
        set_backtrace(edata, 2);
 
    /*
     * Call any context callback functions.  Errors occurring in callback
     * functions will be treated as recursive errors --- this ensures we will
     * avoid infinite recursion (see errstart).
     */
    for (econtext = error_context_stack;
         econtext != NULL;
         econtext = econtext->previous)
        econtext->callback(econtext->arg);
 
    /*
     * If ERROR (not more nor less) we pass it off to the current handler.
     * Printing it and popping the stack is the responsibility of the handler.
     */
    if (elevel == ERROR)
    {
        /*
         * We do some minimal cleanup before longjmp'ing so that handlers can
         * execute in a reasonably sane state.
         *
         * Reset InterruptHoldoffCount in case we ereport'd from inside an
         * interrupt holdoff section.  (We assume here that no handler will
         * itself be inside a holdoff section.  If necessary, such a handler
         * could save and restore InterruptHoldoffCount for itself, but this
         * should make life easier for most.)
         */
        InterruptHoldoffCount = 0;
        QueryCancelHoldoffCount = 0;
 
        CritSectionCount = 0;   /* should be unnecessary, but... */
 
        /*
         * Note that we leave CurrentMemoryContext set to ErrorContext. The
         * handler should reset it to something else soon.
         */
 
        recursion_depth--;
        PG_RE_THROW();
    }
 
    /* Emit the message to the right places */
    EmitErrorReport();
 
    /*
     * If this is the outermost recursion level, we can clean up by resetting
     * ErrorContext altogether (compare FlushErrorState), which is good
     * because it cleans up any random leakages that might have occurred in
     * places such as context callback functions.  If we're nested, we can
     * only safely remove the subsidiary data of the current stack entry.
     */
    if (errordata_stack_depth == 0 && recursion_depth == 1)
        MemoryContextReset(ErrorContext);
    else
        FreeErrorDataContents(edata);
 
    /* Release stack entry and exit error-handling context */
    errordata_stack_depth--;
    MemoryContextSwitchTo(oldcontext);
    recursion_depth--;
 
    /*
     * Perform error recovery action as specified by elevel.
     */
    if (elevel == FATAL)
    {
        /*
         * For a FATAL error, we let proc_exit clean up and exit.
         *
         * If we just reported a startup failure, the client will disconnect
         * on receiving it, so don't send any more to the client.
         */
        if (PG_exception_stack == NULL && whereToSendOutput == DestRemote)
            whereToSendOutput = DestNone;
 
        /*
         * fflush here is just to improve the odds that we get to see the
         * error message, in case things are so hosed that proc_exit crashes.
         * Any other code you might be tempted to add here should probably be
         * in an on_proc_exit or on_shmem_exit callback instead.
         */
        fflush(NULL);
 
        /*
         * Let the cumulative stats system know. Only mark the session as
         * terminated by fatal error if there is no other known cause.
         */
        if (pgStatSessionEndCause == DISCONNECT_NORMAL)
            pgStatSessionEndCause = DISCONNECT_FATAL;
 
        /*
         * Do normal process-exit cleanup, then return exit code 1 to indicate
         * FATAL termination.  The postmaster may or may not consider this
         * worthy of panic, depending on which subprocess returns it.
         */
        proc_exit(1);
    }
 
    if (elevel >= PANIC)
    {
        /*
         * Serious crash time. Postmaster will observe SIGABRT process exit
         * status and kill the other backends too.
         *
         * XXX: what if we are *in* the postmaster?  abort() won't kill our
         * children...
         */
        fflush(NULL);
        abort();
    }
 
    /*
     * Check for cancel/die interrupt first --- this is so that the user can
     * stop a query emitting tons of notice or warning messages, even if it's
     * in a loop that otherwise fails to check for interrupts.
     */
    CHECK_FOR_INTERRUPTS();
}

References ErrorContextCallback::arg, ErrorData::backtrace, backtrace_functions, ErrorContextCallback::callback, CHECK_FOR_INTERRUPTS, CHECK_STACK_DEPTH, CritSectionCount, DestNone, DestRemote, DISCONNECT_FATAL, DISCONNECT_NORMAL, ErrorData::elevel, EmitErrorReport(), ERROR, error_context_stack, ErrorContext, errordata, errordata_stack_depth, FATAL, filename, FreeErrorDataContents(), ErrorData::funcname, funcname, InterruptHoldoffCount, matches_backtrace_functions(), MemoryContextReset(), MemoryContextSwitchTo(), PANIC, PG_exception_stack, PG_RE_THROW, pgStatSessionEndCause, ErrorContextCallback::previous, proc_exit(), QueryCancelHoldoffCount, recursion_depth, set_backtrace(), set_stack_entry_location(), and whereToSendOutput.

Referenced by errsave_finish(), pg_re_throw(), and ThrowErrorData().

◆ errhidecontext()

int errhidecontext ( bool hide_ctx )

Definition at line 1464 of file elog.c.

{
    ErrorData  *edata = &errordata[errordata_stack_depth];
 
    /* we don't bother incrementing recursion_depth */
    CHECK_STACK_DEPTH();
 
    edata->hide_ctx = hide_ctx;
 
    return 0;                   /* return value does not matter */
}

References CHECK_STACK_DEPTH, errordata, errordata_stack_depth, and ErrorData::hide_ctx.

Referenced by buffer_call_start_io(), buffer_call_terminate_io(), llvm_compile_module(), MemoryContextStatsDetail(), MemoryContextStatsInternal(), MemoryContextStatsPrint(), and ProcessLogMemoryContextInterrupt().

◆ errhidestmt()

int int errhidestmt ( bool hide_stmt )

Definition at line 1445 of file elog.c.

{
    ErrorData  *edata = &errordata[errordata_stack_depth];
 
    /* we don't bother incrementing recursion_depth */
    CHECK_STACK_DEPTH();
 
    edata->hide_stmt = hide_stmt;
 
    return 0;                   /* return value does not matter */
}

References CHECK_STACK_DEPTH, errordata, errordata_stack_depth, and ErrorData::hide_stmt.

Referenced by buffer_call_start_io(), buffer_call_terminate_io(), exec_bind_message(), exec_execute_message(), exec_parse_message(), exec_simple_query(), explain_ExecutorEnd(), llvm_compile_module(), MemoryContextStatsDetail(), MemoryContextStatsInternal(), MemoryContextStatsPrint(), and ProcessLogMemoryContextInterrupt().

◆ errhint()

int errhint	(	const char *	fmt,
			...
	)

◆ errhint_internal()

int int errhint_internal	(	const char *	fmt,
			...
	)

◆ errhint_plural()

int int int errhint_plural	(	const char *	fmt_singular,
		const char *	fmt_plural,
		unsigned long	n,
			...
	)

◆ errmsg()

int errmsg	(	const char *	fmt,
			...
	)

◆ errmsg_internal()

int int errmsg_internal	(	const char *	fmt,
			...
	)

◆ errmsg_plural()

int int int errmsg_plural	(	const char *	fmt_singular,
		const char *	fmt_plural,
		unsigned long	n,
			...
	)

◆ error_severity()

const char * error_severity ( int elevel )

Definition at line 3723 of file elog.c.

{
    const char *prefix;
 
    switch (elevel)
    {
        case DEBUG1:
        case DEBUG2:
        case DEBUG3:
        case DEBUG4:
        case DEBUG5:
            prefix = gettext_noop("DEBUG");
            break;
        case LOG:
        case LOG_SERVER_ONLY:
            prefix = gettext_noop("LOG");
            break;
        case INFO:
            prefix = gettext_noop("INFO");
            break;
        case NOTICE:
            prefix = gettext_noop("NOTICE");
            break;
        case WARNING:
        case WARNING_CLIENT_ONLY:
            prefix = gettext_noop("WARNING");
            break;
        case ERROR:
            prefix = gettext_noop("ERROR");
            break;
        case FATAL:
            prefix = gettext_noop("FATAL");
            break;
        case PANIC:
            prefix = gettext_noop("PANIC");
            break;
        default:
            prefix = "???";
            break;
    }
 
    return prefix;
}

References DEBUG1, DEBUG2, DEBUG3, DEBUG4, DEBUG5, ERROR, FATAL, gettext_noop, INFO, LOG, LOG_SERVER_ONLY, NOTICE, PANIC, WARNING, and WARNING_CLIENT_ONLY.

Referenced by send_message_to_frontend(), send_message_to_server_log(), write_csvlog(), and write_jsonlog().

◆ errposition()

int errposition ( int cursorpos )

Definition at line 1480 of file elog.c.

{
    ErrorData  *edata = &errordata[errordata_stack_depth];
 
    /* we don't bother incrementing recursion_depth */
    CHECK_STACK_DEPTH();
 
    edata->cursorpos = cursorpos;
 
    return 0;                   /* return value does not matter */
}

References CHECK_STACK_DEPTH, ErrorData::cursorpos, errordata, and errordata_stack_depth.

Referenced by _SPI_error_callback(), executor_errposition(), function_parse_error_transpose(), import_error_callback(), parser_errposition(), scanner_errposition(), script_error_callback(), sql_compile_error_callback(), sql_exec_error_callback(), and sql_inline_error_callback().

◆ errsave_finish()

void errsave_finish	(	struct Node *	context,
		const char *	filename,
		int	lineno,
		const char *	funcname
	)

Definition at line 691 of file elog.c.

{
    ErrorSaveContext *escontext = (ErrorSaveContext *) context;
    ErrorData  *edata = &errordata[errordata_stack_depth];
 
    /* verify stack depth before accessing *edata */
    CHECK_STACK_DEPTH();
 
    /*
     * If errsave_start punted to errstart, then elevel will be ERROR or
     * perhaps even PANIC.  Punt likewise to errfinish.
     */
    if (edata->elevel >= ERROR)
    {
        errfinish(filename, lineno, funcname);
        pg_unreachable();
    }
 
    /*
     * Else, we should package up the stack entry contents and deliver them to
     * the caller.
     */
    recursion_depth++;
 
    /* Save the last few bits of error state into the stack entry */
    set_stack_entry_location(edata, filename, lineno, funcname);
 
    /* Replace the LOG value that errsave_start inserted */
    edata->elevel = ERROR;
 
    /*
     * We skip calling backtrace and context functions, which are more likely
     * to cause trouble than provide useful context; they might act on the
     * assumption that a transaction abort is about to occur.
     */
 
    /*
     * Make a copy of the error info for the caller.  All the subsidiary
     * strings are already in the caller's context, so it's sufficient to
     * flat-copy the stack entry.
     */
    escontext->error_data = palloc_object(ErrorData);
    memcpy(escontext->error_data, edata, sizeof(ErrorData));
 
    /* Exit error-handling context */
    errordata_stack_depth--;
    recursion_depth--;
}

References CHECK_STACK_DEPTH, ErrorData::elevel, errfinish(), ERROR, ErrorSaveContext::error_data, errordata, errordata_stack_depth, filename, funcname, palloc_object, pg_unreachable, recursion_depth, and set_stack_entry_location().

◆ errsave_start()

bool errsave_start	(	struct Node *	context,
		const char *	domain
	)

Definition at line 639 of file elog.c.

{
    ErrorSaveContext *escontext;
    ErrorData  *edata;
 
    /*
     * Do we have a context for soft error reporting?  If not, just punt to
     * errstart().
     */
    if (context == NULL || !IsA(context, ErrorSaveContext))
        return errstart(ERROR, domain);
 
    /* Report that a soft error was detected */
    escontext = (ErrorSaveContext *) context;
    escontext->error_occurred = true;
 
    /* Nothing else to do if caller wants no further details */
    if (!escontext->details_wanted)
        return false;
 
    /*
     * Okay, crank up a stack entry to store the info in.
     */
 
    recursion_depth++;
 
    /* Initialize data for this error frame */
    edata = get_error_stack_entry();
    edata->elevel = LOG;        /* signal all is well to errsave_finish */
    set_stack_entry_domain(edata, domain);
    /* Select default errcode based on the assumed elevel of ERROR */
    edata->sqlerrcode = ERRCODE_INTERNAL_ERROR;
 
    /*
     * Any allocations for this error state level should go into the caller's
     * context.  We don't need to pollute ErrorContext, or even require it to
     * exist, in this code path.
     */
    edata->assoc_context = CurrentMemoryContext;
 
    recursion_depth--;
    return true;
}

References ErrorData::assoc_context, CurrentMemoryContext, ErrorSaveContext::details_wanted, ErrorData::elevel, ERROR, ErrorSaveContext::error_occurred, errstart(), get_error_stack_entry(), IsA, LOG, recursion_depth, set_stack_entry_domain(), and ErrorData::sqlerrcode.

◆ errstart()

bool errstart	(	int	elevel,
		const char *	domain
	)

Definition at line 343 of file elog.c.

{
    ErrorData  *edata;
    bool        output_to_server;
    bool        output_to_client = false;
    int         i;
 
    /*
     * Check some cases in which we want to promote an error into a more
     * severe error.  None of this logic applies for non-error messages.
     */
    if (elevel >= ERROR)
    {
        /*
         * If we are inside a critical section, all errors become PANIC
         * errors.  See miscadmin.h.
         */
        if (CritSectionCount > 0)
            elevel = PANIC;
 
        /*
         * Check reasons for treating ERROR as FATAL:
         *
         * 1. we have no handler to pass the error to (implies we are in the
         * postmaster or in backend startup).
         *
         * 2. ExitOnAnyError mode switch is set (initdb uses this).
         *
         * 3. the error occurred after proc_exit has begun to run.  (It's
         * proc_exit's responsibility to see that this doesn't turn into
         * infinite recursion!)
         */
        if (elevel == ERROR)
        {
            if (PG_exception_stack == NULL ||
                ExitOnAnyError ||
                proc_exit_inprogress)
                elevel = FATAL;
        }
 
        /*
         * If the error level is ERROR or more, errfinish is not going to
         * return to caller; therefore, if there is any stacked error already
         * in progress it will be lost.  This is more or less okay, except we
         * do not want to have a FATAL or PANIC error downgraded because the
         * reporting process was interrupted by a lower-grade error.  So check
         * the stack and make sure we panic if panic is warranted.
         */
        for (i = 0; i <= errordata_stack_depth; i++)
            elevel = Max(elevel, errordata[i].elevel);
    }
 
    /*
     * Now decide whether we need to process this report at all; if it's
     * warning or less and not enabled for logging, just return false without
     * starting up any error logging machinery.
     */
    output_to_server = should_output_to_server(elevel);
    output_to_client = should_output_to_client(elevel);
    if (elevel < ERROR && !output_to_server && !output_to_client)
        return false;
 
    /*
     * We need to do some actual work.  Make sure that memory context
     * initialization has finished, else we can't do anything useful.
     */
    if (ErrorContext == NULL)
    {
        /* Oops, hard crash time; very little we can do safely here */
        write_stderr("error occurred before error message processing is available\n");
        exit(2);
    }
 
    /*
     * Okay, crank up a stack entry to store the info in.
     */
 
    if (recursion_depth++ > 0 && elevel >= ERROR)
    {
        /*
         * Oops, error during error processing.  Clear ErrorContext as
         * discussed at top of file.  We will not return to the original
         * error's reporter or handler, so we don't need it.
         */
        MemoryContextReset(ErrorContext);
 
        /*
         * Infinite error recursion might be due to something broken in a
         * context traceback routine.  Abandon them too.  We also abandon
         * attempting to print the error statement (which, if long, could
         * itself be the source of the recursive failure).
         */
        if (in_error_recursion_trouble())
        {
            error_context_stack = NULL;
            debug_query_string = NULL;
        }
    }
 
    /* Initialize data for this error frame */
    edata = get_error_stack_entry();
    edata->elevel = elevel;
    edata->output_to_server = output_to_server;
    edata->output_to_client = output_to_client;
    set_stack_entry_domain(edata, domain);
    /* Select default errcode based on elevel */
    if (elevel >= ERROR)
        edata->sqlerrcode = ERRCODE_INTERNAL_ERROR;
    else if (elevel >= WARNING)
        edata->sqlerrcode = ERRCODE_WARNING;
    else
        edata->sqlerrcode = ERRCODE_SUCCESSFUL_COMPLETION;
 
    /*
     * Any allocations for this error state level should go into ErrorContext
     */
    edata->assoc_context = ErrorContext;
 
    recursion_depth--;
    return true;
}

References ErrorData::assoc_context, CritSectionCount, debug_query_string, ErrorData::elevel, ERROR, error_context_stack, ErrorContext, errordata, errordata_stack_depth, ExitOnAnyError, FATAL, get_error_stack_entry(), i, in_error_recursion_trouble(), Max, MemoryContextReset(), ErrorData::output_to_client, ErrorData::output_to_server, PANIC, PG_exception_stack, proc_exit_inprogress, recursion_depth, set_stack_entry_domain(), should_output_to_client(), should_output_to_server(), ErrorData::sqlerrcode, WARNING, and write_stderr().

Referenced by errsave_start(), errstart_cold(), and ThrowErrorData().

◆ errstart_cold()

pg_attribute_cold bool errstart_cold	(	int	elevel,
		const char *	domain
	)

Definition at line 327 of file elog.c.

{
    return errstart(elevel, domain);
}

References errstart().

◆ FlushErrorState()

void FlushErrorState ( void )

Definition at line 1884 of file elog.c.

{
    /*
     * Reset stack to empty.  The only case where it would be more than one
     * deep is if we serviced an error that interrupted construction of
     * another message.  We assume control escaped out of that message
     * construction and won't ever go back.
     */
    errordata_stack_depth = -1;
    recursion_depth = 0;
    /* Delete all data in ErrorContext */
    MemoryContextReset(ErrorContext);
}

References ErrorContext, errordata_stack_depth, MemoryContextReset(), and recursion_depth.

Referenced by _SPI_commit(), _SPI_rollback(), AutoVacLauncherMain(), BackgroundWriterMain(), call_bool_check_hook(), call_enum_check_hook(), call_int_check_hook(), call_real_check_hook(), call_string_check_hook(), CheckpointerMain(), DisableSubscriptionAndExit(), do_autovacuum(), exec_stmt_block(), GetConnection(), initTrie(), perform_work_item(), pgarch_archiveXlog(), plperl_return_next(), plperl_spi_commit(), plperl_spi_exec(), plperl_spi_exec_prepared(), plperl_spi_fetchrow(), plperl_spi_prepare(), plperl_spi_query(), plperl_spi_query_prepared(), plperl_spi_rollback(), plperl_util_elog(), pltcl_commit(), pltcl_elog(), pltcl_rollback(), pltcl_subtrans_abort(), PLy_commit(), PLy_output(), PLy_rollback(), PLy_spi_subtransaction_abort(), PostgresMain(), ReorderBufferProcessTXN(), WalSummarizerMain(), and WalWriterMain().

◆ format_elog_string()

char * format_elog_string	(	const char *	fmt,
			...
	)

◆ FreeErrorData()

void FreeErrorData ( ErrorData * edata )

Definition at line 1835 of file elog.c.

{
    FreeErrorDataContents(edata);
    pfree(edata);
}

References FreeErrorDataContents(), and pfree().

Referenced by GetConnection(), pltcl_commit(), pltcl_elog(), pltcl_rollback(), pltcl_subtrans_abort(), PLy_commit(), PLy_output(), PLy_rollback(), PLy_spi_subtransaction_abort(), and ReorderBufferProcessTXN().

◆ get_backend_type_for_log()

const char * get_backend_type_for_log ( void )

Definition at line 2775 of file elog.c.

{
    const char *backend_type_str;
 
    if (MyProcPid == PostmasterPid)
        backend_type_str = "postmaster";
    else if (MyBackendType == B_BG_WORKER)
        backend_type_str = MyBgworkerEntry->bgw_type;
    else
        backend_type_str = GetBackendTypeDesc(MyBackendType);
 
    return backend_type_str;
}

References B_BG_WORKER, BackgroundWorker::bgw_type, GetBackendTypeDesc(), MyBackendType, MyBgworkerEntry, MyProcPid, and PostmasterPid.

Referenced by log_status_format(), write_csvlog(), and write_jsonlog().

◆ get_formatted_log_time()

char * get_formatted_log_time ( void )

Definition at line 2678 of file elog.c.

{
    pg_time_t   stamp_time;
    char        msbuf[13];
 
    /* leave if already computed */
    if (formatted_log_time[0] != '\0')
        return formatted_log_time;
 
    if (!saved_timeval_set)
    {
        gettimeofday(&saved_timeval, NULL);
        saved_timeval_set = true;
    }
 
    stamp_time = (pg_time_t) saved_timeval.tv_sec;
 
    /*
     * Note: we expect that guc.c will ensure that log_timezone is set up (at
     * least with a minimal GMT value) before Log_line_prefix can become
     * nonempty or CSV/JSON mode can be selected.
     */
    pg_strftime(formatted_log_time, FORMATTED_TS_LEN,
    /* leave room for milliseconds... */
                "%Y-%m-%d %H:%M:%S     %Z",
                pg_localtime(&stamp_time, log_timezone));
 
    /* 'paste' milliseconds into place... */
    sprintf(msbuf, ".%03d", (int) (saved_timeval.tv_usec / 1000));
    memcpy(formatted_log_time + 19, msbuf, 4);
 
    return formatted_log_time;
}

References formatted_log_time, FORMATTED_TS_LEN, gettimeofday(), log_timezone, pg_localtime(), pg_strftime(), saved_timeval, saved_timeval_set, and sprintf.

Referenced by log_status_format(), write_csvlog(), and write_jsonlog().

◆ get_formatted_start_time()

char * get_formatted_start_time ( void )

Definition at line 2728 of file elog.c.

{
    pg_time_t   stamp_time = (pg_time_t) MyStartTime;
 
    /* leave if already computed */
    if (formatted_start_time[0] != '\0')
        return formatted_start_time;
 
    /*
     * Note: we expect that guc.c will ensure that log_timezone is set up (at
     * least with a minimal GMT value) before Log_line_prefix can become
     * nonempty or CSV/JSON mode can be selected.
     */
    pg_strftime(formatted_start_time, FORMATTED_TS_LEN,
                "%Y-%m-%d %H:%M:%S %Z",
                pg_localtime(&stamp_time, log_timezone));
 
    return formatted_start_time;
}

References formatted_start_time, FORMATTED_TS_LEN, log_timezone, MyStartTime, pg_localtime(), and pg_strftime().

Referenced by log_status_format(), write_csvlog(), and write_jsonlog().

◆ geterrcode()

int geterrcode ( void )

Definition at line 1595 of file elog.c.

{
    ErrorData  *edata = &errordata[errordata_stack_depth];
 
    /* we don't bother incrementing recursion_depth */
    CHECK_STACK_DEPTH();
 
    return edata->sqlerrcode;
}

References CHECK_STACK_DEPTH, errordata, errordata_stack_depth, and ErrorData::sqlerrcode.

Referenced by pcb_error_callback(), and scb_error_callback().

◆ GetErrorContextStack()

char * GetErrorContextStack ( void )

Definition at line 2076 of file elog.c.

{
    ErrorData  *edata;
    ErrorContextCallback *econtext;
 
    /*
     * Crank up a stack entry to store the info in.
     */
    recursion_depth++;
 
    edata = get_error_stack_entry();
 
    /*
     * Set up assoc_context to be the caller's context, so any allocations
     * done (which will include edata->context) will use their context.
     */
    edata->assoc_context = CurrentMemoryContext;
 
    /*
     * Call any context callback functions to collect the context information
     * into edata->context.
     *
     * Errors occurring in callback functions should go through the regular
     * error handling code which should handle any recursive errors, though we
     * double-check above, just in case.
     */
    for (econtext = error_context_stack;
         econtext != NULL;
         econtext = econtext->previous)
        econtext->callback(econtext->arg);
 
    /*
     * Clean ourselves off the stack, any allocations done should have been
     * using edata->assoc_context, which we set up earlier to be the caller's
     * context, so we're free to just remove our entry off the stack and
     * decrement recursion depth and exit.
     */
    errordata_stack_depth--;
    recursion_depth--;
 
    /*
     * Return a pointer to the string the caller asked for, which should have
     * been allocated in their context.
     */
    return edata->context;
}

References ErrorContextCallback::arg, ErrorData::assoc_context, ErrorContextCallback::callback, ErrorData::context, CurrentMemoryContext, error_context_stack, errordata_stack_depth, get_error_stack_entry(), ErrorContextCallback::previous, and recursion_depth.

Referenced by exec_stmt_getdiag().

◆ geterrposition()

int geterrposition ( void )

Definition at line 1612 of file elog.c.

{
    ErrorData  *edata = &errordata[errordata_stack_depth];
 
    /* we don't bother incrementing recursion_depth */
    CHECK_STACK_DEPTH();
 
    return edata->cursorpos;
}

References CHECK_STACK_DEPTH, ErrorData::cursorpos, errordata, and errordata_stack_depth.

Referenced by _SPI_error_callback(), function_parse_error_transpose(), import_error_callback(), script_error_callback(), sql_compile_error_callback(), sql_exec_error_callback(), and sql_inline_error_callback().

◆ getinternalerrposition()

int getinternalerrposition ( void )

Definition at line 1629 of file elog.c.

{
    ErrorData  *edata = &errordata[errordata_stack_depth];
 
    /* we don't bother incrementing recursion_depth */
    CHECK_STACK_DEPTH();
 
    return edata->internalpos;
}

References CHECK_STACK_DEPTH, errordata, errordata_stack_depth, and ErrorData::internalpos.

Referenced by function_parse_error_transpose().

◆ in_error_recursion_trouble()

bool in_error_recursion_trouble ( void )

Definition at line 294 of file elog.c.

{
    /* Pull the plug if recurse more than once */
    return (recursion_depth > 2);
}

References recursion_depth.

Referenced by err_gettext(), err_sendstring(), errstart(), pgfdw_abort_cleanup(), pgfdw_abort_cleanup_begin(), and write_console().

◆ internalerrposition()

int internalerrposition ( int cursorpos )

Definition at line 1496 of file elog.c.

{
    ErrorData  *edata = &errordata[errordata_stack_depth];
 
    /* we don't bother incrementing recursion_depth */
    CHECK_STACK_DEPTH();
 
    edata->internalpos = cursorpos;
 
    return 0;                   /* return value does not matter */
}

References CHECK_STACK_DEPTH, errordata, errordata_stack_depth, and ErrorData::internalpos.

Referenced by _SPI_error_callback(), function_parse_error_transpose(), import_error_callback(), plpgsql_scanner_errposition(), PLy_elog_impl(), script_error_callback(), sql_compile_error_callback(), sql_exec_error_callback(), and sql_inline_error_callback().

◆ internalerrquery()

int internalerrquery ( const char * query )

Definition at line 1516 of file elog.c.

{
    ErrorData  *edata = &errordata[errordata_stack_depth];
 
    /* we don't bother incrementing recursion_depth */
    CHECK_STACK_DEPTH();
 
    if (edata->internalquery)
    {
        pfree(edata->internalquery);
        edata->internalquery = NULL;
    }
 
    if (query)
        edata->internalquery = MemoryContextStrdup(edata->assoc_context, query);
 
    return 0;                   /* return value does not matter */
}

References ErrorData::assoc_context, CHECK_STACK_DEPTH, errordata, errordata_stack_depth, ErrorData::internalquery, MemoryContextStrdup(), and pfree().

Referenced by _SPI_error_callback(), function_parse_error_transpose(), import_error_callback(), plpgsql_scanner_errposition(), PLy_elog_impl(), script_error_callback(), sql_compile_error_callback(), sql_exec_error_callback(), and sql_inline_error_callback().

◆ log_status_format()

void log_status_format	(	StringInfo	buf,
		const char *	format,
		ErrorData *	edata
	)

Definition at line 2837 of file elog.c.

{
    /* static counter for line numbers */
    static long log_line_number = 0;
 
    /* has counter been reset in current process? */
    static int  log_my_pid = 0;
    int         padding;
    const char *p;
 
    /*
     * This is one of the few places where we'd rather not inherit a static
     * variable's value from the postmaster.  But since we will, reset it when
     * MyProcPid changes. MyStartTime also changes when MyProcPid does, so
     * reset the formatted start timestamp too.
     */
    if (log_my_pid != MyProcPid)
    {
        log_line_number = 0;
        log_my_pid = MyProcPid;
        reset_formatted_start_time();
    }
    log_line_number++;
 
    if (format == NULL)
        return;                 /* in case guc hasn't run yet */
 
    for (p = format; *p != '\0'; p++)
    {
        if (*p != '%')
        {
            /* literal char, just copy */
            appendStringInfoChar(buf, *p);
            continue;
        }
 
        /* must be a '%', so skip to the next char */
        p++;
        if (*p == '\0')
            break;              /* format error - ignore it */
        else if (*p == '%')
        {
            /* string contains %% */
            appendStringInfoChar(buf, '%');
            continue;
        }
 
 
        /*
         * Process any formatting which may exist after the '%'.  Note that
         * process_log_prefix_padding moves p past the padding number if it
         * exists.
         *
         * Note: Since only '-', '0' to '9' are valid formatting characters we
         * can do a quick check here to pre-check for formatting. If the char
         * is not formatting then we can skip a useless function call.
         *
         * Further note: At least on some platforms, passing %*s rather than
         * %s to appendStringInfo() is substantially slower, so many of the
         * cases below avoid doing that unless non-zero padding is in fact
         * specified.
         */
        if (*p > '9')
            padding = 0;
        else if ((p = process_log_prefix_padding(p, &padding)) == NULL)
            break;
 
        /* process the option */
        switch (*p)
        {
            case 'a':
                if (MyProcPort)
                {
                    const char *appname = application_name;
 
                    if (appname == NULL || *appname == '\0')
                        appname = _("[unknown]");
                    if (padding != 0)
                        appendStringInfo(buf, "%*s", padding, appname);
                    else
                        appendStringInfoString(buf, appname);
                }
                else if (padding != 0)
                    appendStringInfoSpaces(buf,
                                           padding > 0 ? padding : -padding);
 
                break;
            case 'b':
                {
                    const char *backend_type_str = get_backend_type_for_log();
 
                    if (padding != 0)
                        appendStringInfo(buf, "%*s", padding, backend_type_str);
                    else
                        appendStringInfoString(buf, backend_type_str);
                    break;
                }
            case 'u':
                if (MyProcPort)
                {
                    const char *username = MyProcPort->user_name;
 
                    if (username == NULL || *username == '\0')
                        username = _("[unknown]");
                    if (padding != 0)
                        appendStringInfo(buf, "%*s", padding, username);
                    else
                        appendStringInfoString(buf, username);
                }
                else if (padding != 0)
                    appendStringInfoSpaces(buf,
                                           padding > 0 ? padding : -padding);
                break;
            case 'd':
                if (MyProcPort)
                {
                    const char *dbname = MyProcPort->database_name;
 
                    if (dbname == NULL || *dbname == '\0')
                        dbname = _("[unknown]");
                    if (padding != 0)
                        appendStringInfo(buf, "%*s", padding, dbname);
                    else
                        appendStringInfoString(buf, dbname);
                }
                else if (padding != 0)
                    appendStringInfoSpaces(buf,
                                           padding > 0 ? padding : -padding);
                break;
            case 'c':
                if (padding != 0)
                {
                    char        strfbuf[128];
 
                    snprintf(strfbuf, sizeof(strfbuf) - 1, "%" PRIx64 ".%x",
                             MyStartTime, MyProcPid);
                    appendStringInfo(buf, "%*s", padding, strfbuf);
                }
                else
                    appendStringInfo(buf, "%" PRIx64 ".%x", MyStartTime, MyProcPid);
                break;
            case 'p':
                if (padding != 0)
                    appendStringInfo(buf, "%*d", padding, MyProcPid);
                else
                    appendStringInfo(buf, "%d", MyProcPid);
                break;
 
            case 'P':
                if (MyProc)
                {
                    PGPROC     *leader = MyProc->lockGroupLeader;
 
                    /*
                     * Show the leader only for active parallel workers. This
                     * leaves out the leader of a parallel group.
                     */
                    if (leader == NULL || leader->pid == MyProcPid)
                        appendStringInfoSpaces(buf,
                                               padding > 0 ? padding : -padding);
                    else if (padding != 0)
                        appendStringInfo(buf, "%*d", padding, leader->pid);
                    else
                        appendStringInfo(buf, "%d", leader->pid);
                }
                else if (padding != 0)
                    appendStringInfoSpaces(buf,
                                           padding > 0 ? padding : -padding);
                break;
 
            case 'l':
                if (padding != 0)
                    appendStringInfo(buf, "%*ld", padding, log_line_number);
                else
                    appendStringInfo(buf, "%ld", log_line_number);
                break;
            case 'm':
                /* force a log timestamp reset */
                formatted_log_time[0] = '\0';
                (void) get_formatted_log_time();
 
                if (padding != 0)
                    appendStringInfo(buf, "%*s", padding, formatted_log_time);
                else
                    appendStringInfoString(buf, formatted_log_time);
                break;
            case 't':
                {
                    pg_time_t   stamp_time = (pg_time_t) time(NULL);
                    char        strfbuf[128];
 
                    pg_strftime(strfbuf, sizeof(strfbuf),
                                "%Y-%m-%d %H:%M:%S %Z",
                                pg_localtime(&stamp_time, log_timezone));
                    if (padding != 0)
                        appendStringInfo(buf, "%*s", padding, strfbuf);
                    else
                        appendStringInfoString(buf, strfbuf);
                }
                break;
            case 'n':
                {
                    char        strfbuf[128];
 
                    if (!saved_timeval_set)
                    {
                        gettimeofday(&saved_timeval, NULL);
                        saved_timeval_set = true;
                    }
 
                    snprintf(strfbuf, sizeof(strfbuf), "%ld.%03d",
                             (long) saved_timeval.tv_sec,
                             (int) (saved_timeval.tv_usec / 1000));
 
                    if (padding != 0)
                        appendStringInfo(buf, "%*s", padding, strfbuf);
                    else
                        appendStringInfoString(buf, strfbuf);
                }
                break;
            case 's':
                {
                    char       *start_time = get_formatted_start_time();
 
                    if (padding != 0)
                        appendStringInfo(buf, "%*s", padding, start_time);
                    else
                        appendStringInfoString(buf, start_time);
                }
                break;
            case 'i':
                if (MyProcPort)
                {
                    const char *psdisp;
                    int         displen;
 
                    psdisp = get_ps_display(&displen);
                    if (padding != 0)
                        appendStringInfo(buf, "%*s", padding, psdisp);
                    else
                        appendBinaryStringInfo(buf, psdisp, displen);
                }
                else if (padding != 0)
                    appendStringInfoSpaces(buf,
                                           padding > 0 ? padding : -padding);
                break;
            case 'L':
                {
                    const char *local_host;
 
                    if (MyProcPort)
                    {
                        if (MyProcPort->local_host[0] == '\0')
                        {
                            /*
                             * First time through: cache the lookup, since it
                             * might not have trivial cost.
                             */
                            (void) pg_getnameinfo_all(&MyProcPort->laddr.addr,
                                                      MyProcPort->laddr.salen,
                                                      MyProcPort->local_host,
                                                      sizeof(MyProcPort->local_host),
                                                      NULL, 0,
                                                      NI_NUMERICHOST | NI_NUMERICSERV);
                        }
                        local_host = MyProcPort->local_host;
                    }
                    else
                    {
                        /* Background process, or connection not yet made */
                        local_host = "[none]";
                    }
                    if (padding != 0)
                        appendStringInfo(buf, "%*s", padding, local_host);
                    else
                        appendStringInfoString(buf, local_host);
                }
                break;
            case 'r':
                if (MyProcPort && MyProcPort->remote_host)
                {
                    if (padding != 0)
                    {
                        if (MyProcPort->remote_port && MyProcPort->remote_port[0] != '\0')
                        {
                            /*
                             * This option is slightly special as the port
                             * number may be appended onto the end. Here we
                             * need to build 1 string which contains the
                             * remote_host and optionally the remote_port (if
                             * set) so we can properly align the string.
                             */
 
                            char       *hostport;
 
                            hostport = psprintf("%s(%s)", MyProcPort->remote_host, MyProcPort->remote_port);
                            appendStringInfo(buf, "%*s", padding, hostport);
                            pfree(hostport);
                        }
                        else
                            appendStringInfo(buf, "%*s", padding, MyProcPort->remote_host);
                    }
                    else
                    {
                        /* padding is 0, so we don't need a temp buffer */
                        appendStringInfoString(buf, MyProcPort->remote_host);
                        if (MyProcPort->remote_port &&
                            MyProcPort->remote_port[0] != '\0')
                            appendStringInfo(buf, "(%s)",
                                             MyProcPort->remote_port);
                    }
                }
                else if (padding != 0)
                    appendStringInfoSpaces(buf,
                                           padding > 0 ? padding : -padding);
                break;
            case 'h':
                if (MyProcPort && MyProcPort->remote_host)
                {
                    if (padding != 0)
                        appendStringInfo(buf, "%*s", padding, MyProcPort->remote_host);
                    else
                        appendStringInfoString(buf, MyProcPort->remote_host);
                }
                else if (padding != 0)
                    appendStringInfoSpaces(buf,
                                           padding > 0 ? padding : -padding);
                break;
            case 'q':
                /* in postmaster and friends, stop if %q is seen */
                /* in a backend, just ignore */
                if (MyProcPort == NULL)
                    return;
                break;
            case 'v':
                /* keep VXID format in sync with lockfuncs.c */
                if (MyProc != NULL && MyProc->vxid.procNumber != INVALID_PROC_NUMBER)
                {
                    if (padding != 0)
                    {
                        char        strfbuf[128];
 
                        snprintf(strfbuf, sizeof(strfbuf) - 1, "%d/%u",
                                 MyProc->vxid.procNumber, MyProc->vxid.lxid);
                        appendStringInfo(buf, "%*s", padding, strfbuf);
                    }
                    else
                        appendStringInfo(buf, "%d/%u", MyProc->vxid.procNumber, MyProc->vxid.lxid);
                }
                else if (padding != 0)
                    appendStringInfoSpaces(buf,
                                           padding > 0 ? padding : -padding);
                break;
            case 'x':
                if (padding != 0)
                    appendStringInfo(buf, "%*u", padding, GetTopTransactionIdIfAny());
                else
                    appendStringInfo(buf, "%u", GetTopTransactionIdIfAny());
                break;
            case 'e':
                if (padding != 0)
                    appendStringInfo(buf, "%*s", padding, unpack_sql_state(edata->sqlerrcode));
                else
                    appendStringInfoString(buf, unpack_sql_state(edata->sqlerrcode));
                break;
            case 'Q':
                if (padding != 0)
                    appendStringInfo(buf, "%*" PRId64, padding,
                                     pgstat_get_my_query_id());
                else
                    appendStringInfo(buf, "%" PRId64,
                                     pgstat_get_my_query_id());
                break;
            default:
                /* format error - ignore it */
                break;
        }
    }
}

References _, SockAddr::addr, appendBinaryStringInfo(), appendStringInfo(), appendStringInfoChar(), appendStringInfoSpaces(), appendStringInfoString(), application_name, buf, Port::database_name, dbname, format, formatted_log_time, get_backend_type_for_log(), get_formatted_log_time(), get_formatted_start_time(), get_ps_display(), gettimeofday(), GetTopTransactionIdIfAny(), INVALID_PROC_NUMBER, Port::laddr, Port::local_host, PGPROC::lockGroupLeader, log_timezone, PGPROC::lxid, MyProc, MyProcPid, MyProcPort, MyStartTime, pfree(), pg_getnameinfo_all(), pg_localtime(), pg_strftime(), pgstat_get_my_query_id(), PGPROC::pid, process_log_prefix_padding(), PGPROC::procNumber, psprintf(), Port::remote_host, Port::remote_port, reset_formatted_start_time(), SockAddr::salen, saved_timeval, saved_timeval_set, snprintf, ErrorData::sqlerrcode, start_time, unpack_sql_state(), Port::user_name, username, and PGPROC::vxid.

Referenced by log_line_prefix().

◆ message_level_is_interesting()

bool message_level_is_interesting ( int elevel )

Definition at line 273 of file elog.c.

{
    /*
     * Keep this in sync with the decision-making in errstart().
     */
    if (elevel >= ERROR ||
        should_output_to_server(elevel) ||
        should_output_to_client(elevel))
        return true;
    return false;
}

References ERROR, should_output_to_client(), and should_output_to_server().

Referenced by log_invalid_page(), PostmasterMain(), ProcessStandbyHSFeedbackMessage(), ProcessStandbyReplyMessage(), ProcessWalSndrMessage(), ProcSleep(), reportDependentObjects(), ShowTransactionState(), and VacuumUpdateCosts().

◆ pg_attribute_printf()

int int int pg_attribute_printf	(	2	,
		4
	)

◆ pg_re_throw()

pg_noreturn void pg_re_throw ( void )

Definition at line 2021 of file elog.c.

{
    /* If possible, throw the error to the next outer setjmp handler */
    if (PG_exception_stack != NULL)
        siglongjmp(*PG_exception_stack, 1);
    else
    {
        /*
         * If we get here, elog(ERROR) was thrown inside a PG_TRY block, which
         * we have now exited only to discover that there is no outer setjmp
         * handler to pass the error to.  Had the error been thrown outside
         * the block to begin with, we'd have promoted the error to FATAL, so
         * the correct behavior is to make it FATAL now; that is, emit it and
         * then call proc_exit.
         */
        ErrorData  *edata = &errordata[errordata_stack_depth];
 
        Assert(errordata_stack_depth >= 0);
        Assert(edata->elevel == ERROR);
        edata->elevel = FATAL;
 
        /*
         * At least in principle, the increase in severity could have changed
         * where-to-output decisions, so recalculate.
         */
        edata->output_to_server = should_output_to_server(FATAL);
        edata->output_to_client = should_output_to_client(FATAL);
 
        /*
         * We can use errfinish() for the rest, but we don't want it to call
         * any error context routines a second time.  Since we know we are
         * about to exit, it should be OK to just clear the context stack.
         */
        error_context_stack = NULL;
 
        errfinish(edata->filename, edata->lineno, edata->funcname);
    }
 
    /* Doesn't return ... */
    ExceptionalCondition("pg_re_throw tried to return", __FILE__, __LINE__);
}

References Assert(), ErrorData::elevel, errfinish(), ERROR, error_context_stack, errordata, errordata_stack_depth, ExceptionalCondition(), FATAL, ErrorData::filename, ErrorData::funcname, ErrorData::lineno, ErrorData::output_to_client, ErrorData::output_to_server, PG_exception_stack, should_output_to_client(), and should_output_to_server().

◆ pre_format_elog_string()

void pre_format_elog_string	(	int	errnumber,
		const char *	domain
	)

Definition at line 1662 of file elog.c.

{
    /* Save errno before evaluation of argument functions can change it */
    save_format_errnumber = errnumber;
    /* Save caller's text domain */
    save_format_domain = domain;
}

References save_format_domain, and save_format_errnumber.

◆ reset_formatted_start_time()

void reset_formatted_start_time ( void )

Definition at line 2716 of file elog.c.

{
    formatted_start_time[0] = '\0';
}

References formatted_start_time.

Referenced by log_status_format(), write_csvlog(), and write_jsonlog().

◆ ReThrowError()

pg_noreturn void ReThrowError ( ErrorData * edata )

Definition at line 1971 of file elog.c.

{
    ErrorData  *newedata;
 
    Assert(edata->elevel == ERROR);
 
    /* Push the data back into the error context */
    recursion_depth++;
    MemoryContextSwitchTo(ErrorContext);
 
    newedata = get_error_stack_entry();
    memcpy(newedata, edata, sizeof(ErrorData));
 
    /* Make copies of separately-allocated fields */
    if (newedata->message)
        newedata->message = pstrdup(newedata->message);
    if (newedata->detail)
        newedata->detail = pstrdup(newedata->detail);
    if (newedata->detail_log)
        newedata->detail_log = pstrdup(newedata->detail_log);
    if (newedata->hint)
        newedata->hint = pstrdup(newedata->hint);
    if (newedata->context)
        newedata->context = pstrdup(newedata->context);
    if (newedata->backtrace)
        newedata->backtrace = pstrdup(newedata->backtrace);
    if (newedata->schema_name)
        newedata->schema_name = pstrdup(newedata->schema_name);
    if (newedata->table_name)
        newedata->table_name = pstrdup(newedata->table_name);
    if (newedata->column_name)
        newedata->column_name = pstrdup(newedata->column_name);
    if (newedata->datatype_name)
        newedata->datatype_name = pstrdup(newedata->datatype_name);
    if (newedata->constraint_name)
        newedata->constraint_name = pstrdup(newedata->constraint_name);
    if (newedata->internalquery)
        newedata->internalquery = pstrdup(newedata->internalquery);
 
    /* Reset the assoc_context to be ErrorContext */
    newedata->assoc_context = ErrorContext;
 
    recursion_depth--;
    PG_RE_THROW();
}

References Assert(), ErrorData::assoc_context, ErrorData::backtrace, ErrorData::column_name, ErrorData::constraint_name, ErrorData::context, ErrorData::datatype_name, ErrorData::detail, ErrorData::detail_log, ErrorData::elevel, ERROR, ErrorContext, get_error_stack_entry(), ErrorData::hint, ErrorData::internalquery, MemoryContextSwitchTo(), ErrorData::message, PG_RE_THROW, pstrdup(), recursion_depth, ErrorData::schema_name, and ErrorData::table_name.

Referenced by _SPI_commit(), _SPI_rollback(), exec_stmt_block(), and exec_stmt_raise().

◆ set_errcontext_domain()

int set_errcontext_domain ( const char * domain )

Definition at line 1425 of file elog.c.

{
    ErrorData  *edata = &errordata[errordata_stack_depth];
 
    /* we don't bother incrementing recursion_depth */
    CHECK_STACK_DEPTH();
 
    /* the default text domain is the backend's */
    edata->context_domain = domain ? domain : PG_TEXTDOMAIN("postgres");
 
    return 0;                   /* return value does not matter */
}

References CHECK_STACK_DEPTH, ErrorData::context_domain, errordata, errordata_stack_depth, and PG_TEXTDOMAIN.

◆ ThrowErrorData()

void ThrowErrorData ( ErrorData * edata )

Definition at line 1912 of file elog.c.

{
    ErrorData  *newedata;
    MemoryContext oldcontext;
 
    if (!errstart(edata->elevel, edata->domain))
        return;                 /* error is not to be reported at all */
 
    newedata = &errordata[errordata_stack_depth];
    recursion_depth++;
    oldcontext = MemoryContextSwitchTo(newedata->assoc_context);
 
    /* Copy the supplied fields to the error stack entry. */
    if (edata->sqlerrcode != 0)
        newedata->sqlerrcode = edata->sqlerrcode;
    if (edata->message)
        newedata->message = pstrdup(edata->message);
    if (edata->detail)
        newedata->detail = pstrdup(edata->detail);
    if (edata->detail_log)
        newedata->detail_log = pstrdup(edata->detail_log);
    if (edata->hint)
        newedata->hint = pstrdup(edata->hint);
    if (edata->context)
        newedata->context = pstrdup(edata->context);
    if (edata->backtrace)
        newedata->backtrace = pstrdup(edata->backtrace);
    /* assume message_id is not available */
    if (edata->schema_name)
        newedata->schema_name = pstrdup(edata->schema_name);
    if (edata->table_name)
        newedata->table_name = pstrdup(edata->table_name);
    if (edata->column_name)
        newedata->column_name = pstrdup(edata->column_name);
    if (edata->datatype_name)
        newedata->datatype_name = pstrdup(edata->datatype_name);
    if (edata->constraint_name)
        newedata->constraint_name = pstrdup(edata->constraint_name);
    newedata->cursorpos = edata->cursorpos;
    newedata->internalpos = edata->internalpos;
    if (edata->internalquery)
        newedata->internalquery = pstrdup(edata->internalquery);
 
    MemoryContextSwitchTo(oldcontext);
    recursion_depth--;
 
    /* Process the error. */
    errfinish(edata->filename, edata->lineno, edata->funcname);
}

References ErrorData::assoc_context, ErrorData::backtrace, ErrorData::column_name, ErrorData::constraint_name, ErrorData::context, ErrorData::cursorpos, ErrorData::datatype_name, ErrorData::detail, ErrorData::detail_log, ErrorData::domain, ErrorData::elevel, errfinish(), errordata, errordata_stack_depth, errstart(), ErrorData::filename, ErrorData::funcname, ErrorData::hint, ErrorData::internalpos, ErrorData::internalquery, ErrorData::lineno, MemoryContextSwitchTo(), ErrorData::message, pstrdup(), recursion_depth, ErrorData::schema_name, ErrorData::sqlerrcode, and ErrorData::table_name.

Referenced by ProcessParallelMessage(), and text_to_stavalues().

◆ unpack_sql_state()

char * unpack_sql_state ( int sql_state )

Definition at line 3222 of file elog.c.

{
    static char buf[12];
    int         i;
 
    for (i = 0; i < 5; i++)
    {
        buf[i] = PGUNSIXBIT(sql_state);
        sql_state >>= 6;
    }
 
    buf[i] = '\0';
    return buf;
}

References buf, i, and PGUNSIXBIT.

Referenced by exec_stmt_block(), exec_stmt_getdiag(), exec_stmt_raise(), log_status_format(), pg_input_error_info(), pltcl_construct_errorCode(), PLy_exception_set_with_details(), PLy_generate_spi_exceptions(), send_message_to_frontend(), send_message_to_server_log(), write_csvlog(), and write_jsonlog().

◆ vwrite_stderr()

void void vwrite_stderr	(	const char *	fmt,
		va_list	ap
	)

◆ write_csvlog()

void write_csvlog ( ErrorData * edata )

Definition at line 63 of file csvlog.c.

{
    StringInfoData buf;
    bool        print_stmt = false;
 
    /* static counter for line numbers */
    static long log_line_number = 0;
 
    /* has counter been reset in current process? */
    static int  log_my_pid = 0;
 
    /*
     * This is one of the few places where we'd rather not inherit a static
     * variable's value from the postmaster.  But since we will, reset it when
     * MyProcPid changes.
     */
    if (log_my_pid != MyProcPid)
    {
        log_line_number = 0;
        log_my_pid = MyProcPid;
        reset_formatted_start_time();
    }
    log_line_number++;
 
    initStringInfo(&buf);
 
    /* timestamp with milliseconds */
    appendStringInfoString(&buf, get_formatted_log_time());
    appendStringInfoChar(&buf, ',');
 
    /* username */
    if (MyProcPort)
        appendCSVLiteral(&buf, MyProcPort->user_name);
    appendStringInfoChar(&buf, ',');
 
    /* database name */
    if (MyProcPort)
        appendCSVLiteral(&buf, MyProcPort->database_name);
    appendStringInfoChar(&buf, ',');
 
    /* Process id  */
    if (MyProcPid != 0)
        appendStringInfo(&buf, "%d", MyProcPid);
    appendStringInfoChar(&buf, ',');
 
    /* Remote host and port */
    if (MyProcPort && MyProcPort->remote_host)
    {
        appendStringInfoChar(&buf, '"');
        appendStringInfoString(&buf, MyProcPort->remote_host);
        if (MyProcPort->remote_port && MyProcPort->remote_port[0] != '\0')
        {
            appendStringInfoChar(&buf, ':');
            appendStringInfoString(&buf, MyProcPort->remote_port);
        }
        appendStringInfoChar(&buf, '"');
    }
    appendStringInfoChar(&buf, ',');
 
    /* session id */
    appendStringInfo(&buf, "%" PRIx64 ".%x", MyStartTime, MyProcPid);
    appendStringInfoChar(&buf, ',');
 
    /* Line number */
    appendStringInfo(&buf, "%ld", log_line_number);
    appendStringInfoChar(&buf, ',');
 
    /* PS display */
    if (MyProcPort)
    {
        StringInfoData msgbuf;
        const char *psdisp;
        int         displen;
 
        initStringInfo(&msgbuf);
 
        psdisp = get_ps_display(&displen);
        appendBinaryStringInfo(&msgbuf, psdisp, displen);
        appendCSVLiteral(&buf, msgbuf.data);
 
        pfree(msgbuf.data);
    }
    appendStringInfoChar(&buf, ',');
 
    /* session start timestamp */
    appendStringInfoString(&buf, get_formatted_start_time());
    appendStringInfoChar(&buf, ',');
 
    /* Virtual transaction id */
    /* keep VXID format in sync with lockfuncs.c */
    if (MyProc != NULL && MyProc->vxid.procNumber != INVALID_PROC_NUMBER)
        appendStringInfo(&buf, "%d/%u", MyProc->vxid.procNumber, MyProc->vxid.lxid);
    appendStringInfoChar(&buf, ',');
 
    /* Transaction id */
    appendStringInfo(&buf, "%u", GetTopTransactionIdIfAny());
    appendStringInfoChar(&buf, ',');
 
    /* Error severity */
    appendStringInfoString(&buf, _(error_severity(edata->elevel)));
    appendStringInfoChar(&buf, ',');
 
    /* SQL state code */
    appendStringInfoString(&buf, unpack_sql_state(edata->sqlerrcode));
    appendStringInfoChar(&buf, ',');
 
    /* errmessage */
    appendCSVLiteral(&buf, edata->message);
    appendStringInfoChar(&buf, ',');
 
    /* errdetail or errdetail_log */
    if (edata->detail_log)
        appendCSVLiteral(&buf, edata->detail_log);
    else
        appendCSVLiteral(&buf, edata->detail);
    appendStringInfoChar(&buf, ',');
 
    /* errhint */
    appendCSVLiteral(&buf, edata->hint);
    appendStringInfoChar(&buf, ',');
 
    /* internal query */
    appendCSVLiteral(&buf, edata->internalquery);
    appendStringInfoChar(&buf, ',');
 
    /* if printed internal query, print internal pos too */
    if (edata->internalpos > 0 && edata->internalquery != NULL)
        appendStringInfo(&buf, "%d", edata->internalpos);
    appendStringInfoChar(&buf, ',');
 
    /* errcontext */
    if (!edata->hide_ctx)
        appendCSVLiteral(&buf, edata->context);
    appendStringInfoChar(&buf, ',');
 
    /* user query --- only reported if not disabled by the caller */
    print_stmt = check_log_of_query(edata);
    if (print_stmt)
        appendCSVLiteral(&buf, debug_query_string);
    appendStringInfoChar(&buf, ',');
    if (print_stmt && edata->cursorpos > 0)
        appendStringInfo(&buf, "%d", edata->cursorpos);
    appendStringInfoChar(&buf, ',');
 
    /* file error location */
    if (Log_error_verbosity >= PGERROR_VERBOSE)
    {
        StringInfoData msgbuf;
 
        initStringInfo(&msgbuf);
 
        if (edata->funcname && edata->filename)
            appendStringInfo(&msgbuf, "%s, %s:%d",
                             edata->funcname, edata->filename,
                             edata->lineno);
        else if (edata->filename)
            appendStringInfo(&msgbuf, "%s:%d",
                             edata->filename, edata->lineno);
        appendCSVLiteral(&buf, msgbuf.data);
        pfree(msgbuf.data);
    }
    appendStringInfoChar(&buf, ',');
 
    /* application name */
    if (application_name)
        appendCSVLiteral(&buf, application_name);
 
    appendStringInfoChar(&buf, ',');
 
    /* backend type */
    appendCSVLiteral(&buf, get_backend_type_for_log());
    appendStringInfoChar(&buf, ',');
 
    /* leader PID */
    if (MyProc)
    {
        PGPROC     *leader = MyProc->lockGroupLeader;
 
        /*
         * Show the leader only for active parallel workers.  This leaves out
         * the leader of a parallel group.
         */
        if (leader && leader->pid != MyProcPid)
            appendStringInfo(&buf, "%d", leader->pid);
    }
    appendStringInfoChar(&buf, ',');
 
    /* query id */
    appendStringInfo(&buf, "%" PRId64, pgstat_get_my_query_id());
 
    appendStringInfoChar(&buf, '\n');
 
    /* If in the syslogger process, try to write messages direct to file */
    if (MyBackendType == B_LOGGER)
        write_syslogger_file(buf.data, buf.len, LOG_DESTINATION_CSVLOG);
    else
        write_pipe_chunks(buf.data, buf.len, LOG_DESTINATION_CSVLOG);
 
    pfree(buf.data);
}

References _, appendBinaryStringInfo(), appendCSVLiteral(), appendStringInfo(), appendStringInfoChar(), appendStringInfoString(), application_name, B_LOGGER, buf, check_log_of_query(), ErrorData::context, ErrorData::cursorpos, StringInfoData::data, Port::database_name, debug_query_string, ErrorData::detail, ErrorData::detail_log, ErrorData::elevel, error_severity(), ErrorData::filename, ErrorData::funcname, get_backend_type_for_log(), get_formatted_log_time(), get_formatted_start_time(), get_ps_display(), GetTopTransactionIdIfAny(), ErrorData::hide_ctx, ErrorData::hint, initStringInfo(), ErrorData::internalpos, ErrorData::internalquery, INVALID_PROC_NUMBER, ErrorData::lineno, PGPROC::lockGroupLeader, LOG_DESTINATION_CSVLOG, Log_error_verbosity, PGPROC::lxid, ErrorData::message, MyBackendType, MyProc, MyProcPid, MyProcPort, MyStartTime, pfree(), PGERROR_VERBOSE, pgstat_get_my_query_id(), PGPROC::pid, PGPROC::procNumber, Port::remote_host, Port::remote_port, reset_formatted_start_time(), ErrorData::sqlerrcode, unpack_sql_state(), Port::user_name, PGPROC::vxid, write_pipe_chunks(), and write_syslogger_file().

Referenced by send_message_to_server_log().

◆ write_jsonlog()

void write_jsonlog ( ErrorData * edata )

Definition at line 109 of file jsonlog.c.

{
    StringInfoData buf;
    char       *start_time;
    char       *log_time;
 
    /* static counter for line numbers */
    static long log_line_number = 0;
 
    /* Has the counter been reset in the current process? */
    static int  log_my_pid = 0;
 
    /*
     * This is one of the few places where we'd rather not inherit a static
     * variable's value from the postmaster.  But since we will, reset it when
     * MyProcPid changes.
     */
    if (log_my_pid != MyProcPid)
    {
        log_line_number = 0;
        log_my_pid = MyProcPid;
        reset_formatted_start_time();
    }
    log_line_number++;
 
    initStringInfo(&buf);
 
    /* Initialize string */
    appendStringInfoChar(&buf, '{');
 
    /* timestamp with milliseconds */
    log_time = get_formatted_log_time();
 
    /*
     * First property does not use appendJSONKeyValue as it does not have
     * comma prefix.
     */
    escape_json(&buf, "timestamp");
    appendStringInfoChar(&buf, ':');
    escape_json(&buf, log_time);
 
    /* username */
    if (MyProcPort)
        appendJSONKeyValue(&buf, "user", MyProcPort->user_name, true);
 
    /* database name */
    if (MyProcPort)
        appendJSONKeyValue(&buf, "dbname", MyProcPort->database_name, true);
 
    /* Process ID */
    if (MyProcPid != 0)
        appendJSONKeyValueFmt(&buf, "pid", false, "%d", MyProcPid);
 
    /* Remote host and port */
    if (MyProcPort && MyProcPort->remote_host)
    {
        appendJSONKeyValue(&buf, "remote_host", MyProcPort->remote_host, true);
        if (MyProcPort->remote_port && MyProcPort->remote_port[0] != '\0')
            appendJSONKeyValue(&buf, "remote_port", MyProcPort->remote_port, false);
    }
 
    /* Session id */
    appendJSONKeyValueFmt(&buf, "session_id", true, "%" PRIx64 ".%x",
                          MyStartTime, MyProcPid);
 
    /* Line number */
    appendJSONKeyValueFmt(&buf, "line_num", false, "%ld", log_line_number);
 
    /* PS display */
    if (MyProcPort)
    {
        StringInfoData msgbuf;
        const char *psdisp;
        int         displen;
 
        initStringInfo(&msgbuf);
        psdisp = get_ps_display(&displen);
        appendBinaryStringInfo(&msgbuf, psdisp, displen);
        appendJSONKeyValue(&buf, "ps", msgbuf.data, true);
 
        pfree(msgbuf.data);
    }
 
    /* session start timestamp */
    start_time = get_formatted_start_time();
    appendJSONKeyValue(&buf, "session_start", start_time, true);
 
    /* Virtual transaction id */
    /* keep VXID format in sync with lockfuncs.c */
    if (MyProc != NULL && MyProc->vxid.procNumber != INVALID_PROC_NUMBER)
        appendJSONKeyValueFmt(&buf, "vxid", true, "%d/%u",
                              MyProc->vxid.procNumber, MyProc->vxid.lxid);
 
    /* Transaction id */
    appendJSONKeyValueFmt(&buf, "txid", false, "%u",
                          GetTopTransactionIdIfAny());
 
    /* Error severity */
    if (edata->elevel)
        appendJSONKeyValue(&buf, "error_severity",
                           error_severity(edata->elevel), true);
 
    /* SQL state code */
    if (edata->sqlerrcode)
        appendJSONKeyValue(&buf, "state_code",
                           unpack_sql_state(edata->sqlerrcode), true);
 
    /* errmessage */
    appendJSONKeyValue(&buf, "message", edata->message, true);
 
    /* errdetail or error_detail log */
    if (edata->detail_log)
        appendJSONKeyValue(&buf, "detail", edata->detail_log, true);
    else
        appendJSONKeyValue(&buf, "detail", edata->detail, true);
 
    /* errhint */
    if (edata->hint)
        appendJSONKeyValue(&buf, "hint", edata->hint, true);
 
    /* internal query */
    if (edata->internalquery)
        appendJSONKeyValue(&buf, "internal_query", edata->internalquery,
                           true);
 
    /* if printed internal query, print internal pos too */
    if (edata->internalpos > 0 && edata->internalquery != NULL)
        appendJSONKeyValueFmt(&buf, "internal_position", false, "%d",
                              edata->internalpos);
 
    /* errcontext */
    if (edata->context && !edata->hide_ctx)
        appendJSONKeyValue(&buf, "context", edata->context, true);
 
    /* user query --- only reported if not disabled by the caller */
    if (check_log_of_query(edata))
    {
        appendJSONKeyValue(&buf, "statement", debug_query_string, true);
        if (edata->cursorpos > 0)
            appendJSONKeyValueFmt(&buf, "cursor_position", false, "%d",
                                  edata->cursorpos);
    }
 
    /* file error location */
    if (Log_error_verbosity >= PGERROR_VERBOSE)
    {
        if (edata->funcname)
            appendJSONKeyValue(&buf, "func_name", edata->funcname, true);
        if (edata->filename)
        {
            appendJSONKeyValue(&buf, "file_name", edata->filename, true);
            appendJSONKeyValueFmt(&buf, "file_line_num", false, "%d",
                                  edata->lineno);
        }
    }
 
    /* Application name */
    if (application_name && application_name[0] != '\0')
        appendJSONKeyValue(&buf, "application_name", application_name, true);
 
    /* backend type */
    appendJSONKeyValue(&buf, "backend_type", get_backend_type_for_log(), true);
 
    /* leader PID */
    if (MyProc)
    {
        PGPROC     *leader = MyProc->lockGroupLeader;
 
        /*
         * Show the leader only for active parallel workers.  This leaves out
         * the leader of a parallel group.
         */
        if (leader && leader->pid != MyProcPid)
            appendJSONKeyValueFmt(&buf, "leader_pid", false, "%d",
                                  leader->pid);
    }
 
    /* query id */
    appendJSONKeyValueFmt(&buf, "query_id", false, "%" PRId64,
                          pgstat_get_my_query_id());
 
    /* Finish string */
    appendStringInfoChar(&buf, '}');
    appendStringInfoChar(&buf, '\n');
 
    /* If in the syslogger process, try to write messages direct to file */
    if (MyBackendType == B_LOGGER)
        write_syslogger_file(buf.data, buf.len, LOG_DESTINATION_JSONLOG);
    else
        write_pipe_chunks(buf.data, buf.len, LOG_DESTINATION_JSONLOG);
 
    pfree(buf.data);
}

References appendBinaryStringInfo(), appendJSONKeyValue(), appendJSONKeyValueFmt(), appendStringInfoChar(), application_name, B_LOGGER, buf, check_log_of_query(), ErrorData::context, ErrorData::cursorpos, StringInfoData::data, Port::database_name, debug_query_string, ErrorData::detail, ErrorData::detail_log, ErrorData::elevel, error_severity(), escape_json(), ErrorData::filename, ErrorData::funcname, get_backend_type_for_log(), get_formatted_log_time(), get_formatted_start_time(), get_ps_display(), GetTopTransactionIdIfAny(), ErrorData::hide_ctx, ErrorData::hint, initStringInfo(), ErrorData::internalpos, ErrorData::internalquery, INVALID_PROC_NUMBER, ErrorData::lineno, PGPROC::lockGroupLeader, LOG_DESTINATION_JSONLOG, Log_error_verbosity, PGPROC::lxid, ErrorData::message, MyBackendType, MyProc, MyProcPid, MyProcPort, MyStartTime, pfree(), PGERROR_VERBOSE, pgstat_get_my_query_id(), PGPROC::pid, PGPROC::procNumber, Port::remote_host, Port::remote_port, reset_formatted_start_time(), ErrorData::sqlerrcode, start_time, unpack_sql_state(), Port::user_name, PGPROC::vxid, write_pipe_chunks(), and write_syslogger_file().

Referenced by send_message_to_server_log().

◆ write_pipe_chunks()

void write_pipe_chunks	(	char *	data,
		int	len,
		int	dest
	)

Definition at line 3482 of file elog.c.

{
    PipeProtoChunk p;
    int         fd = fileno(stderr);
    int         rc;
 
    Assert(len > 0);
 
    p.proto.nuls[0] = p.proto.nuls[1] = '\0';
    p.proto.pid = MyProcPid;
    p.proto.flags = 0;
    if (dest == LOG_DESTINATION_STDERR)
        p.proto.flags |= PIPE_PROTO_DEST_STDERR;
    else if (dest == LOG_DESTINATION_CSVLOG)
        p.proto.flags |= PIPE_PROTO_DEST_CSVLOG;
    else if (dest == LOG_DESTINATION_JSONLOG)
        p.proto.flags |= PIPE_PROTO_DEST_JSONLOG;
 
    /* write all but the last chunk */
    while (len > PIPE_MAX_PAYLOAD)
    {
        /* no need to set PIPE_PROTO_IS_LAST yet */
        p.proto.len = PIPE_MAX_PAYLOAD;
        memcpy(p.proto.data, data, PIPE_MAX_PAYLOAD);
        rc = write(fd, &p, PIPE_HEADER_SIZE + PIPE_MAX_PAYLOAD);
        (void) rc;
        data += PIPE_MAX_PAYLOAD;
        len -= PIPE_MAX_PAYLOAD;
    }
 
    /* write the last chunk */
    p.proto.flags |= PIPE_PROTO_IS_LAST;
    p.proto.len = len;
    memcpy(p.proto.data, data, len);
    rc = write(fd, &p, PIPE_HEADER_SIZE + len);
    (void) rc;
}

References Assert(), PipeProtoHeader::data, data, generate_unaccent_rules::dest, fd(), PipeProtoHeader::flags, PipeProtoHeader::len, len, LOG_DESTINATION_CSVLOG, LOG_DESTINATION_JSONLOG, LOG_DESTINATION_STDERR, MyProcPid, PipeProtoHeader::nuls, PipeProtoHeader::pid, PIPE_HEADER_SIZE, PIPE_MAX_PAYLOAD, PIPE_PROTO_DEST_CSVLOG, PIPE_PROTO_DEST_JSONLOG, PIPE_PROTO_DEST_STDERR, PIPE_PROTO_IS_LAST, PipeProtoChunk::proto, and write.

Referenced by send_message_to_server_log(), write_csvlog(), and write_jsonlog().

◆ write_stderr()

void write_stderr	(	const char *	fmt,
			...
	)

Variable Documentation

◆ emit_log_hook

PGDLLIMPORT emit_log_hook_type emit_log_hook

extern

Definition at line 106 of file elog.c.

Referenced by EmitErrorReport().

◆ error_context_stack

PGDLLIMPORT ErrorContextCallback* error_context_stack

extern

Definition at line 95 of file elog.c.

◆ Log_destination

PGDLLIMPORT int Log_destination

extern

Definition at line 111 of file elog.c.

Referenced by assign_log_destination(), logfile_rotate_dest(), PostmasterMain(), send_message_to_server_log(), SysLogger_Start(), SysLoggerMain(), and update_metainfo_datafile().

◆ Log_destination_string

PGDLLIMPORT char* Log_destination_string

extern

Definition at line 112 of file elog.c.

Referenced by PostmasterMain().

◆ Log_error_verbosity

PGDLLIMPORT int Log_error_verbosity

extern

Definition at line 109 of file elog.c.

Referenced by send_message_to_server_log(), write_csvlog(), and write_jsonlog().

◆ Log_line_prefix

PGDLLIMPORT char* Log_line_prefix

extern

Definition at line 110 of file elog.c.

Referenced by log_line_prefix().

◆ PG_exception_stack

PGDLLIMPORT sigjmp_buf* PG_exception_stack

extern

Definition at line 97 of file elog.c.

Referenced by AutoVacLauncherMain(), AutoVacWorkerMain(), BackgroundWorkerMain(), BackgroundWriterMain(), CheckpointerMain(), errfinish(), errstart(), IoWorkerMain(), pg_re_throw(), pgarch_archiveXlog(), PostgresMain(), ReplSlotSyncWorkerMain(), WalSummarizerMain(), and WalWriterMain().

◆ syslog_sequence_numbers

PGDLLIMPORT bool syslog_sequence_numbers

extern

Definition at line 113 of file elog.c.

◆ syslog_split_messages

PGDLLIMPORT bool syslog_split_messages

extern

Definition at line 114 of file elog.c.

Data Structures

Macros

Typedefs

Enumerations

Functions

Variables

Macro Definition Documentation

◆ COMMERROR

◆ DEBUG1

◆ DEBUG2

◆ DEBUG3

◆ DEBUG4

◆ DEBUG5

◆ elog

◆ ereport

◆ ereport_domain

◆ ereturn

◆ ereturn_domain

◆ ERRCODE_IS_CATEGORY

◆ ERRCODE_TO_CATEGORY

◆ errcontext

◆ ERROR

◆ errsave

◆ errsave_domain

◆ FATAL

◆ INFO

◆ LOG

◆ LOG_DESTINATION_CSVLOG

◆ LOG_DESTINATION_EVENTLOG

◆ LOG_DESTINATION_JSONLOG

◆ LOG_DESTINATION_STDERR

◆ LOG_DESTINATION_SYSLOG

◆ LOG_SERVER_ONLY

◆ MAKE_SQLSTATE

◆ NOTICE

◆ PANIC

◆ PG_CATCH

◆ PG_END_TRY

◆ PG_FINALLY

◆ pg_prevent_errno_in_scope

◆ PG_RE_THROW

◆ PG_TRY

◆ PGERROR

◆ PGSIXBIT

◆ PGUNSIXBIT

◆ PGWARNING

◆ TEXTDOMAIN

◆ WARNING

◆ WARNING_CLIENT_ONLY

Typedef Documentation

◆ emit_log_hook_type

◆ ErrorContextCallback

◆ ErrorData

Enumeration Type Documentation

◆ PGErrorVerbosity

Function Documentation

◆ check_log_of_query()

◆ CopyErrorData()

◆ DebugFileOpen()

◆ EmitErrorReport()

◆ err_generic_string()

◆ errbacktrace()

◆ errcode()

◆ errcode_for_file_access()

◆ errcode_for_socket_access()

◆ errcontext_msg()

◆ errdetail()

◆ errdetail_internal()

◆ errdetail_log()

◆ errdetail_log_plural()

◆ errdetail_plural()

◆ errfinish()

◆ errhidecontext()

◆ errhidestmt()

◆ errhint()

◆ errhint_internal()

◆ errhint_plural()

◆ errmsg()

◆ errmsg_internal()

◆ errmsg_plural()