PostgreSQL Source Code  git master
guc_tables.h File Reference
#include "utils/guc.h"
Include dependency graph for guc_tables.h:
This graph shows which files directly or indirectly include this file:

Go to the source code of 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 /* changed value cannot be applied yet */
 
#define GUC_NEEDS_REPORT   0x0004 /* new value must be reported to client */
 

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_SETTINGS, CONN_AUTH_AUTH,
  CONN_AUTH_SSL, RESOURCES_MEM, RESOURCES_DISK, RESOURCES_KERNEL,
  RESOURCES_VACUUM_DELAY, RESOURCES_BGWRITER, RESOURCES_ASYNCHRONOUS, WAL_SETTINGS,
  WAL_CHECKPOINTS, WAL_ARCHIVING, WAL_ARCHIVE_RECOVERY, WAL_RECOVERY_TARGET,
  REPLICATION_SENDING, REPLICATION_PRIMARY, REPLICATION_STANDBY, REPLICATION_SUBSCRIBERS,
  QUERY_TUNING_METHOD, QUERY_TUNING_COST, QUERY_TUNING_GEQO, QUERY_TUNING_OTHER,
  LOGGING_WHERE, LOGGING_WHEN, LOGGING_WHAT, PROCESS_TITLE,
  STATS_MONITORING, STATS_COLLECTOR, AUTOVACUUM, CLIENT_CONN_STATEMENT,
  CLIENT_CONN_LOCALE, CLIENT_CONN_PRELOAD, CLIENT_CONN_OTHER, LOCK_MANAGEMENT,
  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 164 of file guc_tables.h.

◆ GUC_NEEDS_REPORT

#define GUC_NEEDS_REPORT   0x0004 /* new value must be reported to client */

◆ GUC_PENDING_RESTART

#define GUC_PENDING_RESTART   0x0002 /* changed value cannot be applied yet */

Definition at line 169 of file guc_tables.h.

Referenced by GetConfigOptionByNum(), and set_config_option().

Typedef Documentation

◆ config_var_value

◆ GucStack

typedef struct guc_stack GucStack

Enumeration Type Documentation

◆ config_group

Enumerator
UNGROUPED 
FILE_LOCATIONS 
CONN_AUTH_SETTINGS 
CONN_AUTH_AUTH 
CONN_AUTH_SSL 
RESOURCES_MEM 
RESOURCES_DISK 
RESOURCES_KERNEL 
RESOURCES_VACUUM_DELAY 
RESOURCES_BGWRITER 
RESOURCES_ASYNCHRONOUS 
WAL_SETTINGS 
WAL_CHECKPOINTS 
WAL_ARCHIVING 
WAL_ARCHIVE_RECOVERY 
WAL_RECOVERY_TARGET 
REPLICATION_SENDING 
REPLICATION_PRIMARY 
REPLICATION_STANDBY 
REPLICATION_SUBSCRIBERS 
QUERY_TUNING_METHOD 
QUERY_TUNING_COST 
QUERY_TUNING_GEQO 
QUERY_TUNING_OTHER 
LOGGING_WHERE 
LOGGING_WHEN 
LOGGING_WHAT 
PROCESS_TITLE 
STATS_MONITORING 
STATS_COLLECTOR 
AUTOVACUUM 
CLIENT_CONN_STATEMENT 
CLIENT_CONN_LOCALE 
CLIENT_CONN_PRELOAD 
CLIENT_CONN_OTHER 
LOCK_MANAGEMENT 
COMPAT_OPTIONS_PREVIOUS 
COMPAT_OPTIONS_CLIENT 
ERROR_HANDLING_OPTIONS 
PRESET_OPTIONS 
CUSTOM_OPTIONS 
DEVELOPER_OPTIONS 

Definition at line 54 of file guc_tables.h.

55 {
56  UNGROUPED, /* use for options not shown in pg_settings */
86  AUTOVACUUM,
98 };

◆ config_type

Enumerator
PGC_BOOL 
PGC_INT 
PGC_REAL 
PGC_STRING 
PGC_ENUM 

Definition at line 22 of file guc_tables.h.

23 {
24  PGC_BOOL,
25  PGC_INT,
26  PGC_REAL,
27  PGC_STRING,
28  PGC_ENUM
29 };

◆ GucStackState

Enumerator
GUC_SAVE 
GUC_SET 
GUC_LOCAL 
GUC_SET_LOCAL 

Definition at line 104 of file guc_tables.h.

105 {
106  /* This is almost GucAction, but we need a fourth state for SET+LOCAL */
107  GUC_SAVE, /* entry caused by function SET option */
108  GUC_SET, /* entry caused by plain SET command */
109  GUC_LOCAL, /* entry caused by SET LOCAL command */
110  GUC_SET_LOCAL /* entry caused by SET then SET LOCAL */
111 } GucStackState;
GucStackState
Definition: guc_tables.h:104

Function Documentation

◆ build_guc_variables()

void build_guc_variables ( void  )

Definition at line 5288 of file guc.c.

References FATAL, free, config_bool::gen, config_int::gen, config_real::gen, config_string::gen, config_enum::gen, 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().

5289 {
5290  int size_vars;
5291  int num_vars = 0;
5292  struct config_generic **guc_vars;
5293  int i;
5294 
5295  for (i = 0; ConfigureNamesBool[i].gen.name; i++)
5296  {
5297  struct config_bool *conf = &ConfigureNamesBool[i];
5298 
5299  /* Rather than requiring vartype to be filled in by hand, do this: */
5300  conf->gen.vartype = PGC_BOOL;
5301  num_vars++;
5302  }
5303 
5304  for (i = 0; ConfigureNamesInt[i].gen.name; i++)
5305  {
5306  struct config_int *conf = &ConfigureNamesInt[i];
5307 
5308  conf->gen.vartype = PGC_INT;
5309  num_vars++;
5310  }
5311 
5312  for (i = 0; ConfigureNamesReal[i].gen.name; i++)
5313  {
5314  struct config_real *conf = &ConfigureNamesReal[i];
5315 
5316  conf->gen.vartype = PGC_REAL;
5317  num_vars++;
5318  }
5319 
5320  for (i = 0; ConfigureNamesString[i].gen.name; i++)
5321  {
5322  struct config_string *conf = &ConfigureNamesString[i];
5323 
5324  conf->gen.vartype = PGC_STRING;
5325  num_vars++;
5326  }
5327 
5328  for (i = 0; ConfigureNamesEnum[i].gen.name; i++)
5329  {
5330  struct config_enum *conf = &ConfigureNamesEnum[i];
5331 
5332  conf->gen.vartype = PGC_ENUM;
5333  num_vars++;
5334  }
5335 
5336  /*
5337  * Create table with 20% slack
5338  */
5339  size_vars = num_vars + num_vars / 4;
5340 
5341  guc_vars = (struct config_generic **)
5342  guc_malloc(FATAL, size_vars * sizeof(struct config_generic *));
5343 
5344  num_vars = 0;
5345 
5346  for (i = 0; ConfigureNamesBool[i].gen.name; i++)
5347  guc_vars[num_vars++] = &ConfigureNamesBool[i].gen;
5348 
5349  for (i = 0; ConfigureNamesInt[i].gen.name; i++)
5350  guc_vars[num_vars++] = &ConfigureNamesInt[i].gen;
5351 
5352  for (i = 0; ConfigureNamesReal[i].gen.name; i++)
5353  guc_vars[num_vars++] = &ConfigureNamesReal[i].gen;
5354 
5355  for (i = 0; ConfigureNamesString[i].gen.name; i++)
5356  guc_vars[num_vars++] = &ConfigureNamesString[i].gen;
5357 
5358  for (i = 0; ConfigureNamesEnum[i].gen.name; i++)
5359  guc_vars[num_vars++] = &ConfigureNamesEnum[i].gen;
5360 
5361  if (guc_variables)
5363  guc_variables = guc_vars;
5364  num_guc_variables = num_vars;
5365  size_guc_variables = size_vars;
5367  sizeof(struct config_generic *), guc_var_compare);
5368 }
static struct config_int ConfigureNamesInt[]
Definition: guc.c:2128
const char * name
Definition: guc_tables.h:141
static struct config_enum ConfigureNamesEnum[]
Definition: guc.c:4628
static struct config_bool ConfigureNamesBool[]
Definition: guc.c:971
static int guc_var_compare(const void *a, const void *b)
Definition: guc.c:5580
static int num_guc_variables
Definition: guc.c:5025
#define FATAL
Definition: elog.h:49
struct config_generic gen
Definition: guc_tables.h:177
struct config_generic gen
Definition: guc_tables.h:191
static struct config_generic ** guc_variables
Definition: guc.c:5022
enum config_type vartype
Definition: guc_tables.h:148
static int size_guc_variables
Definition: guc.c:5028
static struct config_real ConfigureNamesReal[]
Definition: guc.c:3580
struct config_generic gen
Definition: guc_tables.h:237
struct config_generic gen
Definition: guc_tables.h:223
#define free(a)
Definition: header.h:65
static struct config_string ConfigureNamesString[]
Definition: guc.c:3849
int i
#define qsort(a, b, c, d)
Definition: port.h:504
static void * guc_malloc(int elevel, size_t size)
Definition: guc.c:5065
struct config_generic gen
Definition: guc_tables.h:207

◆ config_enum_lookup_by_name()

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

Definition at line 7034 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().

7036 {
7037  const struct config_enum_entry *entry;
7038 
7039  for (entry = record->options; entry && entry->name; entry++)
7040  {
7041  if (pg_strcasecmp(value, entry->name) == 0)
7042  {
7043  *retval = entry->val;
7044  return true;
7045  }
7046  }
7047 
7048  *retval = 0;
7049  return false;
7050 }
Definition: guc.h:164
int pg_strcasecmp(const char *s1, const char *s2)
Definition: pgstrcasecmp.c:36
const struct config_enum_entry * options
Definition: guc_tables.h:241
int val
Definition: guc.h:167
static struct @143 value
const char * name
Definition: guc.h:166

◆ config_enum_lookup_by_value()

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

Definition at line 7011 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().

7012 {
7013  const struct config_enum_entry *entry;
7014 
7015  for (entry = record->options; entry && entry->name; entry++)
7016  {
7017  if (entry->val == val)
7018  return entry->name;
7019  }
7020 
7021  elog(ERROR, "could not find enum option %d for %s",
7022  val, record->gen.name);
7023  return NULL; /* silence compiler */
7024 }
Definition: guc.h:164
const char * name
Definition: guc_tables.h:141
#define ERROR
Definition: elog.h:46
const struct config_enum_entry * options
Definition: guc_tables.h:241
int val
Definition: guc.h:167
struct config_generic gen
Definition: guc_tables.h:237
const char * name
Definition: guc.h:166
#define elog(elevel,...)
Definition: elog.h:232
long val
Definition: informix.c:664

◆ get_explain_guc_options()

struct config_generic** get_explain_guc_options ( int *  num)

Definition at line 9481 of file guc.c.

References 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().

9482 {
9483  struct config_generic **result;
9484 
9485  *num = 0;
9486 
9487  /*
9488  * While only a fraction of all the GUC variables are marked GUC_EXPLAIN,
9489  * it doesn't seem worth dynamically resizing this array.
9490  */
9491  result = palloc(sizeof(struct config_generic *) * num_guc_variables);
9492 
9493  for (int i = 0; i < num_guc_variables; i++)
9494  {
9495  bool modified;
9496  struct config_generic *conf = guc_variables[i];
9497 
9498  /* return only parameters marked for inclusion in explain */
9499  if (!(conf->flags & GUC_EXPLAIN))
9500  continue;
9501 
9502  /* return only options visible to the current user */
9503  if ((conf->flags & GUC_NO_SHOW_ALL) ||
9504  ((conf->flags & GUC_SUPERUSER_ONLY) &&
9505  !is_member_of_role(GetUserId(), ROLE_PG_READ_ALL_SETTINGS)))
9506  continue;
9507 
9508  /* return only options that are different from their boot values */
9509  modified = false;
9510 
9511  switch (conf->vartype)
9512  {
9513  case PGC_BOOL:
9514  {
9515  struct config_bool *lconf = (struct config_bool *) conf;
9516 
9517  modified = (lconf->boot_val != *(lconf->variable));
9518  }
9519  break;
9520 
9521  case PGC_INT:
9522  {
9523  struct config_int *lconf = (struct config_int *) conf;
9524 
9525  modified = (lconf->boot_val != *(lconf->variable));
9526  }
9527  break;
9528 
9529  case PGC_REAL:
9530  {
9531  struct config_real *lconf = (struct config_real *) conf;
9532 
9533  modified = (lconf->boot_val != *(lconf->variable));
9534  }
9535  break;
9536 
9537  case PGC_STRING:
9538  {
9539  struct config_string *lconf = (struct config_string *) conf;
9540 
9541  modified = (strcmp(lconf->boot_val, *(lconf->variable)) != 0);
9542  }
9543  break;
9544 
9545  case PGC_ENUM:
9546  {
9547  struct config_enum *lconf = (struct config_enum *) conf;
9548 
9549  modified = (lconf->boot_val != *(lconf->variable));
9550  }
9551  break;
9552 
9553  default:
9554  elog(ERROR, "unexpected GUC type: %d", conf->vartype);
9555  }
9556 
9557  if (!modified)
9558  continue;
9559 
9560  /* OK, report it */
9561  result[*num] = conf;
9562  *num = *num + 1;
9563  }
9564 
9565  return result;
9566 }
Oid GetUserId(void)
Definition: miscinit.c:495
char ** variable
Definition: guc_tables.h:225
bool * variable
Definition: guc_tables.h:179
int boot_val
Definition: guc_tables.h:194
const char * boot_val
Definition: guc_tables.h:226
#define GUC_NO_SHOW_ALL
Definition: guc.h:206
int * variable
Definition: guc_tables.h:193
int * variable
Definition: guc_tables.h:239
#define ERROR
Definition: elog.h:46
static int num_guc_variables
Definition: guc.c:5025
bool boot_val
Definition: guc_tables.h:180
#define GUC_EXPLAIN
Definition: guc.h:230
double * variable
Definition: guc_tables.h:209
static struct config_generic ** guc_variables
Definition: guc.c:5022
enum config_type vartype
Definition: guc_tables.h:148
#define GUC_SUPERUSER_ONLY
Definition: guc.h:212
bool is_member_of_role(Oid member, Oid role)
Definition: acl.c:4869
double boot_val
Definition: guc_tables.h:210
void * palloc(Size size)
Definition: mcxt.c:1062
#define elog(elevel,...)
Definition: elog.h:232
int i

◆ get_guc_variables()

struct config_generic** get_guc_variables ( void  )

Definition at line 5276 of file guc.c.

References guc_variables.

Referenced by GucInfoMain().

5277 {
5278  return guc_variables;
5279 }
static struct config_generic ** guc_variables
Definition: guc.c:5022

Variable Documentation

◆ config_group_names

const char* const config_group_names[]

Definition at line 733 of file guc.c.

Referenced by printMixedStruct().

◆ config_type_names

const char* const config_type_names[]

Definition at line 831 of file guc.c.

◆ GucContext_Names

const char* const GucContext_Names[]

Definition at line 690 of file guc.c.

Referenced by printMixedStruct().

◆ GucSource_Names

const char* const GucSource_Names[]

Definition at line 709 of file guc.c.