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
 

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_PRIMARY, 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

◆ GucStack

typedef struct guc_stack GucStack

Enumeration Type Documentation

◆ 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_PRIMARY 
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.

54 {
55  UNGROUPED,
57  CONN_AUTH,
61  RESOURCES,
68  WAL,
84  LOGGING,
89  STATS,
92  AUTOVACUUM,
106 };
Definition: guc_tables.h:68

◆ 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 112 of file guc_tables.h.

113 {
114  /* This is almost GucAction, but we need a fourth state for SET+LOCAL */
115  GUC_SAVE, /* entry caused by function SET option */
116  GUC_SET, /* entry caused by plain SET command */
117  GUC_LOCAL, /* entry caused by SET LOCAL command */
118  GUC_SET_LOCAL /* entry caused by SET then SET LOCAL */
119 } GucStackState;
GucStackState
Definition: guc_tables.h:112

Function Documentation

◆ build_guc_variables()

void build_guc_variables ( void  )

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

5077 {
5078  int size_vars;
5079  int num_vars = 0;
5080  struct config_generic **guc_vars;
5081  int i;
5082 
5083  for (i = 0; ConfigureNamesBool[i].gen.name; i++)
5084  {
5085  struct config_bool *conf = &ConfigureNamesBool[i];
5086 
5087  /* Rather than requiring vartype to be filled in by hand, do this: */
5088  conf->gen.vartype = PGC_BOOL;
5089  num_vars++;
5090  }
5091 
5092  for (i = 0; ConfigureNamesInt[i].gen.name; i++)
5093  {
5094  struct config_int *conf = &ConfigureNamesInt[i];
5095 
5096  conf->gen.vartype = PGC_INT;
5097  num_vars++;
5098  }
5099 
5100  for (i = 0; ConfigureNamesReal[i].gen.name; i++)
5101  {
5102  struct config_real *conf = &ConfigureNamesReal[i];
5103 
5104  conf->gen.vartype = PGC_REAL;
5105  num_vars++;
5106  }
5107 
5108  for (i = 0; ConfigureNamesString[i].gen.name; i++)
5109  {
5110  struct config_string *conf = &ConfigureNamesString[i];
5111 
5112  conf->gen.vartype = PGC_STRING;
5113  num_vars++;
5114  }
5115 
5116  for (i = 0; ConfigureNamesEnum[i].gen.name; i++)
5117  {
5118  struct config_enum *conf = &ConfigureNamesEnum[i];
5119 
5120  conf->gen.vartype = PGC_ENUM;
5121  num_vars++;
5122  }
5123 
5124  /*
5125  * Create table with 20% slack
5126  */
5127  size_vars = num_vars + num_vars / 4;
5128 
5129  guc_vars = (struct config_generic **)
5130  guc_malloc(FATAL, size_vars * sizeof(struct config_generic *));
5131 
5132  num_vars = 0;
5133 
5134  for (i = 0; ConfigureNamesBool[i].gen.name; i++)
5135  guc_vars[num_vars++] = &ConfigureNamesBool[i].gen;
5136 
5137  for (i = 0; ConfigureNamesInt[i].gen.name; i++)
5138  guc_vars[num_vars++] = &ConfigureNamesInt[i].gen;
5139 
5140  for (i = 0; ConfigureNamesReal[i].gen.name; i++)
5141  guc_vars[num_vars++] = &ConfigureNamesReal[i].gen;
5142 
5143  for (i = 0; ConfigureNamesString[i].gen.name; i++)
5144  guc_vars[num_vars++] = &ConfigureNamesString[i].gen;
5145 
5146  for (i = 0; ConfigureNamesEnum[i].gen.name; i++)
5147  guc_vars[num_vars++] = &ConfigureNamesEnum[i].gen;
5148 
5149  if (guc_variables)
5151  guc_variables = guc_vars;
5152  num_guc_variables = num_vars;
5153  size_guc_variables = size_vars;
5155  sizeof(struct config_generic *), guc_var_compare);
5156 }
static struct config_int ConfigureNamesInt[]
Definition: guc.c:2046
const char * name
Definition: guc_tables.h:149
static struct config_enum ConfigureNamesEnum[]
Definition: guc.c:4458
static struct config_bool ConfigureNamesBool[]
Definition: guc.c:928
static int guc_var_compare(const void *a, const void *b)
Definition: guc.c:5298
static int num_guc_variables
Definition: guc.c:4815
#define FATAL
Definition: elog.h:52
struct config_generic gen
Definition: guc_tables.h:182
struct config_generic gen
Definition: guc_tables.h:196
static struct config_generic ** guc_variables
Definition: guc.c:4812
enum config_type vartype
Definition: guc_tables.h:156
static int size_guc_variables
Definition: guc.c:4818
static struct config_real ConfigureNamesReal[]
Definition: guc.c:3409
struct config_generic gen
Definition: guc_tables.h:242
struct config_generic gen
Definition: guc_tables.h:228
#define free(a)
Definition: header.h:65
static struct config_string ConfigureNamesString[]
Definition: guc.c:3689
int i
#define qsort(a, b, c, d)
Definition: port.h:497
static void * guc_malloc(int elevel, size_t size)
Definition: guc.c:4853
struct config_generic gen
Definition: guc_tables.h:212

◆ config_enum_lookup_by_name()

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

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

6670 {
6671  const struct config_enum_entry *entry;
6672 
6673  for (entry = record->options; entry && entry->name; entry++)
6674  {
6675  if (pg_strcasecmp(value, entry->name) == 0)
6676  {
6677  *retval = entry->val;
6678  return true;
6679  }
6680  }
6681 
6682  *retval = 0;
6683  return false;
6684 }
Definition: guc.h:165
int pg_strcasecmp(const char *s1, const char *s2)
Definition: pgstrcasecmp.c:36
const struct config_enum_entry * options
Definition: guc_tables.h:246
int val
Definition: guc.h:168
static struct @143 value
const char * name
Definition: guc.h:167

◆ config_enum_lookup_by_value()

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

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

6646 {
6647  const struct config_enum_entry *entry;
6648 
6649  for (entry = record->options; entry && entry->name; entry++)
6650  {
6651  if (entry->val == val)
6652  return entry->name;
6653  }
6654 
6655  elog(ERROR, "could not find enum option %d for %s",
6656  val, record->gen.name);
6657  return NULL; /* silence compiler */
6658 }
Definition: guc.h:165
const char * name
Definition: guc_tables.h:149
#define ERROR
Definition: elog.h:43
const struct config_enum_entry * options
Definition: guc_tables.h:246
int val
Definition: guc.h:168
struct config_generic gen
Definition: guc_tables.h:242
const char * name
Definition: guc.h:167
#define elog(elevel,...)
Definition: elog.h:228
long val
Definition: informix.c:664

◆ get_explain_guc_options()

struct config_generic** get_explain_guc_options ( int *  num)

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

9136 {
9137  struct config_generic **result;
9138 
9139  *num = 0;
9140 
9141  /*
9142  * While only a fraction of all the GUC variables are marked GUC_EXPLAIN,
9143  * it doesn't seem worth dynamically resizing this array.
9144  */
9145  result = palloc(sizeof(struct config_generic *) * num_guc_variables);
9146 
9147  for (int i = 0; i < num_guc_variables; i++)
9148  {
9149  bool modified;
9150  struct config_generic *conf = guc_variables[i];
9151 
9152  /* return only parameters marked for inclusion in explain */
9153  if (!(conf->flags & GUC_EXPLAIN))
9154  continue;
9155 
9156  /* return only options visible to the current user */
9157  if ((conf->flags & GUC_NO_SHOW_ALL) ||
9158  ((conf->flags & GUC_SUPERUSER_ONLY) &&
9159  !is_member_of_role(GetUserId(), DEFAULT_ROLE_READ_ALL_SETTINGS)))
9160  continue;
9161 
9162  /* return only options that are different from their boot values */
9163  modified = false;
9164 
9165  switch (conf->vartype)
9166  {
9167  case PGC_BOOL:
9168  {
9169  struct config_bool *lconf = (struct config_bool *) conf;
9170 
9171  modified = (lconf->boot_val != *(lconf->variable));
9172  }
9173  break;
9174 
9175  case PGC_INT:
9176  {
9177  struct config_int *lconf = (struct config_int *) conf;
9178 
9179  modified = (lconf->boot_val != *(lconf->variable));
9180  }
9181  break;
9182 
9183  case PGC_REAL:
9184  {
9185  struct config_real *lconf = (struct config_real *) conf;
9186 
9187  modified = (lconf->boot_val != *(lconf->variable));
9188  }
9189  break;
9190 
9191  case PGC_STRING:
9192  {
9193  struct config_string *lconf = (struct config_string *) conf;
9194 
9195  modified = (strcmp(lconf->boot_val, *(lconf->variable)) != 0);
9196  }
9197  break;
9198 
9199  case PGC_ENUM:
9200  {
9201  struct config_enum *lconf = (struct config_enum *) conf;
9202 
9203  modified = (lconf->boot_val != *(lconf->variable));
9204  }
9205  break;
9206 
9207  default:
9208  elog(ERROR, "unexpected GUC type: %d", conf->vartype);
9209  }
9210 
9211  if (!modified)
9212  continue;
9213 
9214  /* OK, report it */
9215  result[*num] = conf;
9216  *num = *num + 1;
9217  }
9218 
9219  return result;
9220 }
Oid GetUserId(void)
Definition: miscinit.c:476
char ** variable
Definition: guc_tables.h:230
bool * variable
Definition: guc_tables.h:184
int boot_val
Definition: guc_tables.h:199
const char * boot_val
Definition: guc_tables.h:231
#define GUC_NO_SHOW_ALL
Definition: guc.h:207
int * variable
Definition: guc_tables.h:198
int * variable
Definition: guc_tables.h:244
#define ERROR
Definition: elog.h:43
static int num_guc_variables
Definition: guc.c:4815
bool boot_val
Definition: guc_tables.h:185
#define GUC_EXPLAIN
Definition: guc.h:231
double * variable
Definition: guc_tables.h:214
static struct config_generic ** guc_variables
Definition: guc.c:4812
enum config_type vartype
Definition: guc_tables.h:156
#define GUC_SUPERUSER_ONLY
Definition: guc.h:213
bool is_member_of_role(Oid member, Oid role)
Definition: acl.c:4916
double boot_val
Definition: guc_tables.h:215
void * palloc(Size size)
Definition: mcxt.c:950
#define elog(elevel,...)
Definition: elog.h:228
int i

◆ get_guc_variables()

struct config_generic** get_guc_variables ( void  )

Definition at line 5064 of file guc.c.

References guc_variables.

Referenced by GucInfoMain().

5065 {
5066  return guc_variables;
5067 }
static struct config_generic ** guc_variables
Definition: guc.c:4812

Variable Documentation

◆ config_group_names

const char* const config_group_names[]

Definition at line 672 of file guc.c.

Referenced by printMixedStruct().

◆ config_type_names

const char* const config_type_names[]

Definition at line 788 of file guc.c.

◆ GucContext_Names

const char* const GucContext_Names[]

Definition at line 629 of file guc.c.

Referenced by printMixedStruct().

◆ GucSource_Names

const char* const GucSource_Names[]

Definition at line 648 of file guc.c.