logging.h File Reference

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

Go to the source code of this file.

Macros
#define	PG_LOG_FLAG_TERSE   1
#define	pg_log_fatal(...)
#define	pg_log_error(...)
#define	pg_log_warning(...)
#define	pg_log_info(...)
#define	pg_log_debug(...)

Enumerations
enum	pg_log_level {   PG_LOG_NOTSET = 0 , PG_LOG_DEBUG , PG_LOG_INFO , PG_LOG_WARNING ,   PG_LOG_ERROR , PG_LOG_FATAL , PG_LOG_OFF }

Functions
void	pg_logging_init (const char *argv0)
void	pg_logging_config (int new_flags)
void	pg_logging_set_level (enum pg_log_level new_level)
void	pg_logging_increase_verbosity (void)
void	pg_logging_set_pre_callback (void(*cb)(void))
void	pg_logging_set_locus_callback (void(*cb)(const char **filename, uint64 *lineno))
void	pg_log_generic (enum pg_log_level level, const char *pg_restrict fmt,...) pg_attribute_printf(2
void void	pg_log_generic_v (enum pg_log_level level, const char *pg_restrict fmt, va_list ap) pg_attribute_printf(2

Variables
enum pg_log_level	__pg_log_level

Macro Definition Documentation

pg_log_debug

#define pg_log_debug

(

...

)

Value:

        do { \
        if (unlikely(__pg_log_level <= PG_LOG_DEBUG)) pg_log_generic(PG_LOG_DEBUG, __VA_ARGS__); \
    } while(0)

Definition at line 92 of file logging.h.

pg_log_error

#define pg_log_error

(

...

)

Value:

        do { \
        if (likely(__pg_log_level <= PG_LOG_ERROR)) pg_log_generic(PG_LOG_ERROR, __VA_ARGS__); \
    } while(0)

Definition at line 80 of file logging.h.

pg_log_fatal

#define pg_log_fatal

(

...

)

Value:

        do { \
        if (likely(__pg_log_level <= PG_LOG_FATAL)) pg_log_generic(PG_LOG_FATAL, __VA_ARGS__); \
    } while(0)

Definition at line 76 of file logging.h.

PG_LOG_FLAG_TERSE

#define PG_LOG_FLAG_TERSE   1

Definition at line 64 of file logging.h.

pg_log_info

#define pg_log_info

(

...

)

Value:

        do { \
        if (likely(__pg_log_level <= PG_LOG_INFO)) pg_log_generic(PG_LOG_INFO, __VA_ARGS__); \
    } while(0)

Definition at line 88 of file logging.h.

pg_log_warning

#define pg_log_warning

(

...

)

Value:

        do { \
        if (likely(__pg_log_level <= PG_LOG_WARNING)) pg_log_generic(PG_LOG_WARNING, __VA_ARGS__); \
    } while(0)

Definition at line 84 of file logging.h.

Enumeration Type Documentation

pg_log_level

enum pg_log_level

Enumerator
PG_LOG_NOTSET
PG_LOG_DEBUG
PG_LOG_INFO
PG_LOG_WARNING
PG_LOG_ERROR
PG_LOG_FATAL
PG_LOG_OFF

Definition at line 16 of file logging.h.

{
    /*
     * Not initialized yet
     */
    PG_LOG_NOTSET = 0,
 
    /*
     * Low level messages that are normally off by default.
     */
    PG_LOG_DEBUG,
 
    /*
     * Any program messages that go to stderr, shown by default.  (The
     * program's normal output should go to stdout and not use the logging
     * system.)
     */
    PG_LOG_INFO,
 
    /*
     * Warnings and "almost" errors, depends on the program
     */
    PG_LOG_WARNING,
 
    /*
     * Errors
     */
    PG_LOG_ERROR,
 
    /*
     * Severe errors that cause program termination.  (One-shot programs may
     * chose to label even fatal errors as merely "errors".  The distinction
     * is up to the program.)
     */
    PG_LOG_FATAL,
 
    /*
     * Turn all logging off.
     */
    PG_LOG_OFF,
};

Function Documentation

pg_log_generic()

void pg_log_generic	(	enum pg_log_level	level,
		const char *pg_restrict	fmt,
			...
	)

pg_log_generic_v()

void void pg_log_generic_v	(	enum pg_log_level	level,
		const char *pg_restrict	fmt,
		va_list	ap
	)

pg_logging_config()

void pg_logging_config

(

int

new_flags

)

Definition at line 155 of file logging.c.

{
    log_flags = new_flags;
}

References log_flags.

Referenced by main(), and process_file().

pg_logging_increase_verbosity()

void pg_logging_increase_verbosity

(

void

)

Definition at line 174 of file logging.c.

{
    /*
     * The enum values are chosen such that we have to decrease __pg_log_level
     * in order to become more verbose.
     */
    if (__pg_log_level > PG_LOG_NOTSET + 1)
        __pg_log_level--;
}

References __pg_log_level, and PG_LOG_NOTSET.

Referenced by main().

pg_logging_init()

void pg_logging_init

(

const char *

argv0

)

Definition at line 81 of file logging.c.

{
    const char *pg_color_env = getenv("PG_COLOR");
    bool        log_color = false;
    bool        color_terminal = isatty(fileno(stderr));
 
#ifdef WIN32
 
    /*
     * On Windows, check if environment is VT100-compatible if using a
     * terminal.
     */
    if (color_terminal)
        color_terminal = enable_vt_processing();
#endif
 
    /* usually the default, but not on Windows */
    setvbuf(stderr, NULL, _IONBF, 0);
 
    progname = get_progname(argv0);
    __pg_log_level = PG_LOG_INFO;
 
    if (pg_color_env)
    {
        if (strcmp(pg_color_env, "always") == 0 ||
            (strcmp(pg_color_env, "auto") == 0 && color_terminal))
            log_color = true;
    }
 
    if (log_color)
    {
        const char *pg_colors_env = getenv("PG_COLORS");
 
        if (pg_colors_env)
        {
            char       *colors = strdup(pg_colors_env);
 
            if (colors)
            {
                for (char *token = strtok(colors, ":"); token; token = strtok(NULL, ":"))
                {
                    char       *e = strchr(token, '=');
 
                    if (e)
                    {
                        char       *name;
                        char       *value;
 
                        *e = '\0';
                        name = token;
                        value = e + 1;
 
                        if (strcmp(name, "error") == 0)
                            sgr_error = strdup(value);
                        if (strcmp(name, "warning") == 0)
                            sgr_warning = strdup(value);
                        if (strcmp(name, "locus") == 0)
                            sgr_locus = strdup(value);
                    }
                }
 
                free(colors);
            }
        }
        else
        {
            sgr_error = SGR_ERROR_DEFAULT;
            sgr_warning = SGR_WARNING_DEFAULT;
            sgr_locus = SGR_LOCUS_DEFAULT;
        }
    }
}

References __pg_log_level, argv0, free, get_progname(), name, PG_LOG_INFO, progname, sgr_error, SGR_ERROR_DEFAULT, sgr_locus, SGR_LOCUS_DEFAULT, sgr_warning, SGR_WARNING_DEFAULT, and value.

Referenced by get_opts(), main(), and regression_main().

pg_logging_set_level()

void pg_logging_set_level

(

enum pg_log_level

new_level

)

Definition at line 165 of file logging.c.

{
    __pg_log_level = new_level;
}

References __pg_log_level.

Referenced by main().

pg_logging_set_locus_callback()

void pg_logging_set_locus_callback

(

void(*)(const char **filename, uint64 *lineno)

cb

)

Definition at line 191 of file logging.c.

{
    log_locus_callback = cb;
}

References log_locus_callback.

Referenced by main().

pg_logging_set_pre_callback()

void pg_logging_set_pre_callback

(

void(*)(void)

cb

)

Definition at line 185 of file logging.c.

{
    log_pre_callback = cb;
}

References log_pre_callback.

Referenced by main().

Variable Documentation

__pg_log_level

enum pg_log_level __pg_log_level

extern

Definition at line 1 of file logging.c.

Referenced by executeMetaCommand(), pg_logging_increase_verbosity(), pg_logging_init(), and pg_logging_set_level().