#include "utils/guc.h"

Include dependency graph for guc_tables.h:

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

Data Structures
union	config_var_val

struct	config_var_value

struct	guc_stack

struct	config_generic

struct	config_bool

struct	config_int

struct	config_real

struct	config_string

struct	config_enum

Macros
#define	GUC_IS_IN_FILE 0x0001 /* found it in config file */

#define	GUC_PENDING_RESTART 0x0002

Typedefs
typedef struct config_var_value	config_var_value

typedef struct guc_stack	GucStack

Enumerations
enum	config_type { PGC_BOOL, PGC_INT, PGC_REAL, PGC_STRING, PGC_ENUM }

enum	config_group { UNGROUPED, FILE_LOCATIONS, CONN_AUTH, CONN_AUTH_SETTINGS, CONN_AUTH_AUTH, CONN_AUTH_SSL, RESOURCES, RESOURCES_MEM, RESOURCES_DISK, RESOURCES_KERNEL, RESOURCES_VACUUM_DELAY, RESOURCES_BGWRITER, RESOURCES_ASYNCHRONOUS, WAL, WAL_SETTINGS, WAL_CHECKPOINTS, WAL_ARCHIVING, WAL_ARCHIVE_RECOVERY, WAL_RECOVERY_TARGET, REPLICATION, REPLICATION_SENDING, REPLICATION_MASTER, REPLICATION_STANDBY, REPLICATION_SUBSCRIBERS, QUERY_TUNING, QUERY_TUNING_METHOD, QUERY_TUNING_COST, QUERY_TUNING_GEQO, QUERY_TUNING_OTHER, LOGGING, LOGGING_WHERE, LOGGING_WHEN, LOGGING_WHAT, PROCESS_TITLE, STATS, STATS_MONITORING, STATS_COLLECTOR, AUTOVACUUM, CLIENT_CONN, CLIENT_CONN_STATEMENT, CLIENT_CONN_LOCALE, CLIENT_CONN_PRELOAD, CLIENT_CONN_OTHER, LOCK_MANAGEMENT, COMPAT_OPTIONS, COMPAT_OPTIONS_PREVIOUS, COMPAT_OPTIONS_CLIENT, ERROR_HANDLING_OPTIONS, PRESET_OPTIONS, CUSTOM_OPTIONS, DEVELOPER_OPTIONS }

enum	GucStackState { GUC_SAVE, GUC_SET, GUC_LOCAL, GUC_SET_LOCAL }

Functions
struct config_generic **	get_guc_variables (void)

void	build_guc_variables (void)

const char *	config_enum_lookup_by_value (struct config_enum *record, int val)

bool	config_enum_lookup_by_name (struct config_enum record, const char value, int *retval)

struct config_generic **	get_explain_guc_options (int *num)

Variables
const char *const	config_group_names []

const char *const	config_type_names []

const char *const	GucContext_Names []

const char *const	GucSource_Names []

Macro Definition Documentation

◆ GUC_IS_IN_FILE

#define GUC_IS_IN_FILE 0x0001 /* found it in config file */

Definition at line 170 of file guc_tables.h.

◆ GUC_PENDING_RESTART

#define GUC_PENDING_RESTART 0x0002

Definition at line 175 of file guc_tables.h.

Referenced by GetConfigOptionByNum(), and set_config_option().

Typedef Documentation

◆ config_var_value

typedef struct config_var_value config_var_value

◆ GucStack

typedef struct guc_stack GucStack

Enumeration Type Documentation

◆ config_group

enum config_group

Enumerator
UNGROUPED
FILE_LOCATIONS
CONN_AUTH
CONN_AUTH_SETTINGS
CONN_AUTH_AUTH
CONN_AUTH_SSL
RESOURCES
RESOURCES_MEM
RESOURCES_DISK
RESOURCES_KERNEL
RESOURCES_VACUUM_DELAY
RESOURCES_BGWRITER
RESOURCES_ASYNCHRONOUS
WAL
WAL_SETTINGS
WAL_CHECKPOINTS
WAL_ARCHIVING
WAL_ARCHIVE_RECOVERY
WAL_RECOVERY_TARGET
REPLICATION
REPLICATION_SENDING
REPLICATION_MASTER
REPLICATION_STANDBY
REPLICATION_SUBSCRIBERS
QUERY_TUNING
QUERY_TUNING_METHOD
QUERY_TUNING_COST
QUERY_TUNING_GEQO
QUERY_TUNING_OTHER
LOGGING
LOGGING_WHERE
LOGGING_WHEN
LOGGING_WHAT
PROCESS_TITLE
STATS
STATS_MONITORING
STATS_COLLECTOR
AUTOVACUUM
CLIENT_CONN
CLIENT_CONN_STATEMENT
CLIENT_CONN_LOCALE
CLIENT_CONN_PRELOAD
CLIENT_CONN_OTHER
LOCK_MANAGEMENT
COMPAT_OPTIONS
COMPAT_OPTIONS_PREVIOUS
COMPAT_OPTIONS_CLIENT
ERROR_HANDLING_OPTIONS
PRESET_OPTIONS
CUSTOM_OPTIONS
DEVELOPER_OPTIONS

Definition at line 53 of file guc_tables.h.

 {
     UNGROUPED,
     FILE_LOCATIONS,
     CONN_AUTH,
     CONN_AUTH_SETTINGS,
     CONN_AUTH_AUTH,
     CONN_AUTH_SSL,
     RESOURCES,
     RESOURCES_MEM,
     RESOURCES_DISK,
     RESOURCES_KERNEL,
     RESOURCES_VACUUM_DELAY,
     RESOURCES_BGWRITER,
     RESOURCES_ASYNCHRONOUS,
     WAL,
     WAL_SETTINGS,
     WAL_CHECKPOINTS,
     WAL_ARCHIVING,
     WAL_ARCHIVE_RECOVERY,
     WAL_RECOVERY_TARGET,
     REPLICATION,
     REPLICATION_SENDING,
     REPLICATION_MASTER,
     REPLICATION_STANDBY,
     REPLICATION_SUBSCRIBERS,
     QUERY_TUNING,
     QUERY_TUNING_METHOD,
     QUERY_TUNING_COST,
     QUERY_TUNING_GEQO,
     QUERY_TUNING_OTHER,
     LOGGING,
     LOGGING_WHERE,
     LOGGING_WHEN,
     LOGGING_WHAT,
     PROCESS_TITLE,
     STATS,
     STATS_MONITORING,
     STATS_COLLECTOR,
     AUTOVACUUM,
     CLIENT_CONN,
     CLIENT_CONN_STATEMENT,
     CLIENT_CONN_LOCALE,
     CLIENT_CONN_PRELOAD,
     CLIENT_CONN_OTHER,
     LOCK_MANAGEMENT,
     COMPAT_OPTIONS,
     COMPAT_OPTIONS_PREVIOUS,
     COMPAT_OPTIONS_CLIENT,
     ERROR_HANDLING_OPTIONS,
     PRESET_OPTIONS,
     CUSTOM_OPTIONS,
     DEVELOPER_OPTIONS
 };

◆ config_type

enum config_type

Enumerator
PGC_BOOL
PGC_INT
PGC_REAL
PGC_STRING
PGC_ENUM

Definition at line 22 of file guc_tables.h.

 {
     PGC_BOOL,
     PGC_INT,
     PGC_REAL,
     PGC_STRING,
     PGC_ENUM
 };

◆ GucStackState

enum GucStackState

Enumerator
GUC_SAVE
GUC_SET
GUC_LOCAL
GUC_SET_LOCAL

Definition at line 112 of file guc_tables.h.

 {
     /* This is almost GucAction, but we need a fourth state for SET+LOCAL */
     GUC_SAVE,                   /* entry caused by function SET option */
     GUC_SET,                    /* entry caused by plain SET command */
     GUC_LOCAL,                  /* entry caused by SET LOCAL command */
     GUC_SET_LOCAL               /* entry caused by SET then SET LOCAL */
 } GucStackState;

Function Documentation

◆ build_guc_variables()

void build_guc_variables ( void )

Definition at line 4885 of file guc.c.

References FATAL, config_generic::flags, free, config_bool::gen, config_int::gen, config_real::gen, config_string::gen, config_enum::gen, GUC_EXPLAIN, guc_malloc(), guc_var_compare(), i, config_generic::name, PGC_BOOL, PGC_ENUM, PGC_INT, PGC_REAL, PGC_STRING, qsort, and config_generic::vartype.

Referenced by GucInfoMain(), and InitializeGUCOptions().

 {
     int         size_vars;
     int         num_vars = 0;
     int         num_explain_vars = 0;
     struct config_generic **guc_vars;
     int         i;
 
     for (i = 0; ConfigureNamesBool[i].gen.name; i++)
     {
         struct config_bool *conf = &ConfigureNamesBool[i];
 
         /* Rather than requiring vartype to be filled in by hand, do this: */
         conf->gen.vartype = PGC_BOOL;
         num_vars++;
 
         if (conf->gen.flags & GUC_EXPLAIN)
             num_explain_vars++;
     }
 
     for (i = 0; ConfigureNamesInt[i].gen.name; i++)
     {
         struct config_int *conf = &ConfigureNamesInt[i];
 
         conf->gen.vartype = PGC_INT;
         num_vars++;
 
         if (conf->gen.flags & GUC_EXPLAIN)
             num_explain_vars++;
     }
 
     for (i = 0; ConfigureNamesReal[i].gen.name; i++)
     {
         struct config_real *conf = &ConfigureNamesReal[i];
 
         conf->gen.vartype = PGC_REAL;
         num_vars++;
 
         if (conf->gen.flags & GUC_EXPLAIN)
             num_explain_vars++;
     }
 
     for (i = 0; ConfigureNamesString[i].gen.name; i++)
     {
         struct config_string *conf = &ConfigureNamesString[i];
 
         conf->gen.vartype = PGC_STRING;
         num_vars++;
 
         if (conf->gen.flags & GUC_EXPLAIN)
             num_explain_vars++;
     }
 
     for (i = 0; ConfigureNamesEnum[i].gen.name; i++)
     {
         struct config_enum *conf = &ConfigureNamesEnum[i];
 
         conf->gen.vartype = PGC_ENUM;
         num_vars++;
 
         if (conf->gen.flags & GUC_EXPLAIN)
             num_explain_vars++;
     }
 
     /*
      * Create table with 20% slack
      */
     size_vars = num_vars + num_vars / 4;
 
     guc_vars = (struct config_generic **)
         guc_malloc(FATAL, size_vars * sizeof(struct config_generic *));
 
     num_vars = 0;
 
     for (i = 0; ConfigureNamesBool[i].gen.name; i++)
         guc_vars[num_vars++] = &ConfigureNamesBool[i].gen;
 
     for (i = 0; ConfigureNamesInt[i].gen.name; i++)
         guc_vars[num_vars++] = &ConfigureNamesInt[i].gen;
 
     for (i = 0; ConfigureNamesReal[i].gen.name; i++)
         guc_vars[num_vars++] = &ConfigureNamesReal[i].gen;
 
     for (i = 0; ConfigureNamesString[i].gen.name; i++)
         guc_vars[num_vars++] = &ConfigureNamesString[i].gen;
 
     for (i = 0; ConfigureNamesEnum[i].gen.name; i++)
         guc_vars[num_vars++] = &ConfigureNamesEnum[i].gen;
 
     if (guc_variables)
         free(guc_variables);
     guc_variables = guc_vars;
     num_guc_variables = num_vars;
     num_guc_explain_variables = num_explain_vars;
     size_guc_variables = size_vars;
     qsort((void *) guc_variables, num_guc_variables,
           sizeof(struct config_generic *), guc_var_compare);
 }

◆ config_enum_lookup_by_name()

bool config_enum_lookup_by_name	(	struct config_enum *	record,
		const char *	value,
		int *	retval
	)

Definition at line 6494 of file guc.c.

References config_enum_entry::name, config_enum::options, pg_strcasecmp(), and config_enum_entry::val.

Referenced by parse_and_validate_value().

 {
     const struct config_enum_entry *entry;
 
     for (entry = record->options; entry && entry->name; entry++)
     {
         if (pg_strcasecmp(value, entry->name) == 0)
         {
             *retval = entry->val;
             return true;
         }
     }
 
     *retval = 0;
     return false;
 }

◆ config_enum_lookup_by_value()

const char* config_enum_lookup_by_value	(	struct config_enum *	record,
		int	val
	)

Definition at line 6471 of file guc.c.

References elog, ERROR, config_enum::gen, config_generic::name, config_enum_entry::name, config_enum::options, and config_enum_entry::val.

Referenced by _ShowOption(), call_enum_check_hook(), estimate_variable_size(), GetConfigOption(), GetConfigOptionByNum(), GetConfigOptionResetString(), printMixedStruct(), and serialize_variable().

 {
     const struct config_enum_entry *entry;
 
     for (entry = record->options; entry && entry->name; entry++)
     {
         if (entry->val == val)
             return entry->name;
     }
 
     elog(ERROR, "could not find enum option %d for %s",
          val, record->gen.name);
     return NULL;                /* silence compiler */
 }

◆ get_explain_guc_options()

struct config_generic** get_explain_guc_options ( int * num )

Definition at line 8932 of file guc.c.

References Assert, config_bool::boot_val, config_int::boot_val, config_real::boot_val, config_string::boot_val, config_enum::boot_val, elog, ERROR, config_generic::flags, GetUserId(), GUC_EXPLAIN, GUC_NO_SHOW_ALL, GUC_SUPERUSER_ONLY, i, is_member_of_role(), num_guc_variables, palloc(), PGC_BOOL, PGC_ENUM, PGC_INT, PGC_REAL, PGC_STRING, config_bool::variable, config_int::variable, config_real::variable, config_string::variable, config_enum::variable, and config_generic::vartype.

Referenced by ExplainPrintSettings().

 {
     int         i;
     struct config_generic **result;
 
     *num = 0;
 
     /*
      * Allocate enough space to fit all GUC_EXPLAIN options. We may not need
      * all the space, but there are fairly few such options so we don't waste
      * a lot of memory.
      */
     result = palloc(sizeof(struct config_generic *) * num_guc_explain_variables);
 
     for (i = 0; i < num_guc_variables; i++)
     {
         bool        modified;
         struct config_generic *conf = guc_variables[i];
 
         /* return only options visible to the user */
         if ((conf->flags & GUC_NO_SHOW_ALL) ||
             ((conf->flags & GUC_SUPERUSER_ONLY) &&
              !is_member_of_role(GetUserId(), DEFAULT_ROLE_READ_ALL_SETTINGS)))
             continue;
 
         /* only parameters explicitly marked for inclusion in explain */
         if (!(conf->flags & GUC_EXPLAIN))
             continue;
 
         /* return only options that were modified (w.r.t. config file) */
         modified = false;
 
         switch (conf->vartype)
         {
             case PGC_BOOL:
                 {
                     struct config_bool *lconf = (struct config_bool *) conf;
 
                     modified = (lconf->boot_val != *(lconf->variable));
                 }
                 break;
 
             case PGC_INT:
                 {
                     struct config_int *lconf = (struct config_int *) conf;
 
                     modified = (lconf->boot_val != *(lconf->variable));
                 }
                 break;
 
             case PGC_REAL:
                 {
                     struct config_real *lconf = (struct config_real *) conf;
 
                     modified = (lconf->boot_val != *(lconf->variable));
                 }
                 break;
 
             case PGC_STRING:
                 {
                     struct config_string *lconf = (struct config_string *) conf;
 
                     modified = (strcmp(lconf->boot_val, *(lconf->variable)) != 0);
                 }
                 break;
 
             case PGC_ENUM:
                 {
                     struct config_enum *lconf = (struct config_enum *) conf;
 
                     modified = (lconf->boot_val != *(lconf->variable));
                 }
                 break;
 
             default:
                 elog(ERROR, "unexpected GUC type: %d", conf->vartype);
         }
 
         /* skip GUC variables that match the built-in default */
         if (!modified)
             continue;
 
         /* assign to the values array */
         result[*num] = conf;
         *num = *num + 1;
 
         Assert(*num <= num_guc_explain_variables);
     }
 
     return result;
 }

◆ get_guc_variables()

struct config_generic** get_guc_variables ( void )

Definition at line 4873 of file guc.c.

References guc_variables.

Referenced by GucInfoMain().

 {
     return guc_variables;
 }

Variable Documentation

◆ config_group_names

const char* const config_group_names[]

Definition at line 638 of file guc.c.

Referenced by printMixedStruct().

◆ config_type_names

const char* const config_type_names[]

Definition at line 751 of file guc.c.

◆ GucContext_Names

const char* const GucContext_Names[]

Definition at line 601 of file guc.c.