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 */

Definition at line 170 of file guc_tables.h.

◆ GUC_PENDING_RESTART

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

Definition at line 169 of file guc_tables.h.

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 };
@ RESOURCES_KERNEL
Definition: guc_tables.h:63
@ CLIENT_CONN_LOCALE
Definition: guc_tables.h:88
@ WAL_ARCHIVE_RECOVERY
Definition: guc_tables.h:70
@ AUTOVACUUM
Definition: guc_tables.h:86
@ CLIENT_CONN_PRELOAD
Definition: guc_tables.h:89
@ QUERY_TUNING_OTHER
Definition: guc_tables.h:79
@ LOGGING_WHERE
Definition: guc_tables.h:80
@ CONN_AUTH_AUTH
Definition: guc_tables.h:59
@ ERROR_HANDLING_OPTIONS
Definition: guc_tables.h:94
@ PROCESS_TITLE
Definition: guc_tables.h:83
@ RESOURCES_DISK
Definition: guc_tables.h:62
@ REPLICATION_SENDING
Definition: guc_tables.h:72
@ LOCK_MANAGEMENT
Definition: guc_tables.h:91
@ CUSTOM_OPTIONS
Definition: guc_tables.h:96
@ REPLICATION_PRIMARY
Definition: guc_tables.h:73
@ STATS_MONITORING
Definition: guc_tables.h:84
@ WAL_RECOVERY_TARGET
Definition: guc_tables.h:71
@ CONN_AUTH_SSL
Definition: guc_tables.h:60
@ RESOURCES_MEM
Definition: guc_tables.h:61
@ RESOURCES_BGWRITER
Definition: guc_tables.h:65
@ PRESET_OPTIONS
Definition: guc_tables.h:95
@ DEVELOPER_OPTIONS
Definition: guc_tables.h:97
@ RESOURCES_VACUUM_DELAY
Definition: guc_tables.h:64
@ QUERY_TUNING_METHOD
Definition: guc_tables.h:76
@ LOGGING_WHAT
Definition: guc_tables.h:82
@ RESOURCES_ASYNCHRONOUS
Definition: guc_tables.h:66
@ QUERY_TUNING_GEQO
Definition: guc_tables.h:78
@ WAL_SETTINGS
Definition: guc_tables.h:67
@ CLIENT_CONN_STATEMENT
Definition: guc_tables.h:87
@ FILE_LOCATIONS
Definition: guc_tables.h:57
@ STATS_COLLECTOR
Definition: guc_tables.h:85
@ COMPAT_OPTIONS_CLIENT
Definition: guc_tables.h:93
@ REPLICATION_STANDBY
Definition: guc_tables.h:74
@ QUERY_TUNING_COST
Definition: guc_tables.h:77
@ WAL_ARCHIVING
Definition: guc_tables.h:69
@ COMPAT_OPTIONS_PREVIOUS
Definition: guc_tables.h:92
@ WAL_CHECKPOINTS
Definition: guc_tables.h:68
@ CLIENT_CONN_OTHER
Definition: guc_tables.h:90
@ LOGGING_WHEN
Definition: guc_tables.h:81
@ REPLICATION_SUBSCRIBERS
Definition: guc_tables.h:75
@ CONN_AUTH_SETTINGS
Definition: guc_tables.h:58
@ UNGROUPED
Definition: guc_tables.h:56

◆ 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 };
@ PGC_BOOL
Definition: guc_tables.h:24
@ PGC_STRING
Definition: guc_tables.h:27
@ PGC_ENUM
Definition: guc_tables.h:28
@ PGC_REAL
Definition: guc_tables.h:26
@ PGC_INT
Definition: guc_tables.h:25

◆ 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:105
@ GUC_SET_LOCAL
Definition: guc_tables.h:110
@ GUC_SET
Definition: guc_tables.h:108
@ GUC_SAVE
Definition: guc_tables.h:107
@ GUC_LOCAL
Definition: guc_tables.h:109

Function Documentation

◆ build_guc_variables()

void build_guc_variables ( void  )

Definition at line 5319 of file guc.c.

5320 {
5321  int size_vars;
5322  int num_vars = 0;
5323  struct config_generic **guc_vars;
5324  int i;
5325 
5326  for (i = 0; ConfigureNamesBool[i].gen.name; i++)
5327  {
5328  struct config_bool *conf = &ConfigureNamesBool[i];
5329 
5330  /* Rather than requiring vartype to be filled in by hand, do this: */
5331  conf->gen.vartype = PGC_BOOL;
5332  num_vars++;
5333  }
5334 
5335  for (i = 0; ConfigureNamesInt[i].gen.name; i++)
5336  {
5337  struct config_int *conf = &ConfigureNamesInt[i];
5338 
5339  conf->gen.vartype = PGC_INT;
5340  num_vars++;
5341  }
5342 
5343  for (i = 0; ConfigureNamesReal[i].gen.name; i++)
5344  {
5345  struct config_real *conf = &ConfigureNamesReal[i];
5346 
5347  conf->gen.vartype = PGC_REAL;
5348  num_vars++;
5349  }
5350 
5351  for (i = 0; ConfigureNamesString[i].gen.name; i++)
5352  {
5353  struct config_string *conf = &ConfigureNamesString[i];
5354 
5355  conf->gen.vartype = PGC_STRING;
5356  num_vars++;
5357  }
5358 
5359  for (i = 0; ConfigureNamesEnum[i].gen.name; i++)
5360  {
5361  struct config_enum *conf = &ConfigureNamesEnum[i];
5362 
5363  conf->gen.vartype = PGC_ENUM;
5364  num_vars++;
5365  }
5366 
5367  /*
5368  * Create table with 20% slack
5369  */
5370  size_vars = num_vars + num_vars / 4;
5371 
5372  guc_vars = (struct config_generic **)
5373  guc_malloc(FATAL, size_vars * sizeof(struct config_generic *));
5374 
5375  num_vars = 0;
5376 
5377  for (i = 0; ConfigureNamesBool[i].gen.name; i++)
5378  guc_vars[num_vars++] = &ConfigureNamesBool[i].gen;
5379 
5380  for (i = 0; ConfigureNamesInt[i].gen.name; i++)
5381  guc_vars[num_vars++] = &ConfigureNamesInt[i].gen;
5382 
5383  for (i = 0; ConfigureNamesReal[i].gen.name; i++)
5384  guc_vars[num_vars++] = &ConfigureNamesReal[i].gen;
5385 
5386  for (i = 0; ConfigureNamesString[i].gen.name; i++)
5387  guc_vars[num_vars++] = &ConfigureNamesString[i].gen;
5388 
5389  for (i = 0; ConfigureNamesEnum[i].gen.name; i++)
5390  guc_vars[num_vars++] = &ConfigureNamesEnum[i].gen;
5391 
5392  if (guc_variables)
5394  guc_variables = guc_vars;
5395  num_guc_variables = num_vars;
5396  size_guc_variables = size_vars;
5398  sizeof(struct config_generic *), guc_var_compare);
5399 }
#define FATAL
Definition: elog.h:35
static struct config_generic ** guc_variables
Definition: guc.c:5053
static void * guc_malloc(int elevel, size_t size)
Definition: guc.c:5096
static struct config_string ConfigureNamesString[]
Definition: guc.c:3879
static int guc_var_compare(const void *a, const void *b)
Definition: guc.c:5611
static int num_guc_variables
Definition: guc.c:5056
static int size_guc_variables
Definition: guc.c:5059
static struct config_int ConfigureNamesInt[]
Definition: guc.c:2142
static struct config_bool ConfigureNamesBool[]
Definition: guc.c:973
static struct config_real ConfigureNamesReal[]
Definition: guc.c:3610
static struct config_enum ConfigureNamesEnum[]
Definition: guc.c:4658
#define free(a)
Definition: header.h:65
int i
Definition: isn.c:73
#define qsort(a, b, c, d)
Definition: port.h:495
struct config_generic gen
Definition: guc_tables.h:177
struct config_generic gen
Definition: guc_tables.h:237
const char * name
Definition: guc_tables.h:141
enum config_type vartype
Definition: guc_tables.h:148
struct config_generic gen
Definition: guc_tables.h:191
struct config_generic gen
Definition: guc_tables.h:207
struct config_generic gen
Definition: guc_tables.h:223

References ConfigureNamesBool, ConfigureNamesEnum, ConfigureNamesInt, ConfigureNamesReal, ConfigureNamesString, FATAL, free, config_bool::gen, config_int::gen, config_real::gen, config_string::gen, config_enum::gen, guc_malloc(), guc_var_compare(), guc_variables, i, config_generic::name, num_guc_variables, PGC_BOOL, PGC_ENUM, PGC_INT, PGC_REAL, PGC_STRING, qsort, size_guc_variables, and config_generic::vartype.

Referenced by GucInfoMain(), and InitializeGUCOptions().

◆ config_enum_lookup_by_name()

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

Definition at line 7065 of file guc.c.

7067 {
7068  const struct config_enum_entry *entry;
7069 
7070  for (entry = record->options; entry && entry->name; entry++)
7071  {
7072  if (pg_strcasecmp(value, entry->name) == 0)
7073  {
7074  *retval = entry->val;
7075  return true;
7076  }
7077  }
7078 
7079  *retval = 0;
7080  return false;
7081 }
static struct @142 value
int pg_strcasecmp(const char *s1, const char *s2)
Definition: pgstrcasecmp.c:36
Definition: guc.h:165
const char * name
Definition: guc.h:166
int val
Definition: guc.h:167
const struct config_enum_entry * options
Definition: guc_tables.h:241

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

Referenced by parse_and_validate_value().

◆ config_enum_lookup_by_value()

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

Definition at line 7042 of file guc.c.

7043 {
7044  const struct config_enum_entry *entry;
7045 
7046  for (entry = record->options; entry && entry->name; entry++)
7047  {
7048  if (entry->val == val)
7049  return entry->name;
7050  }
7051 
7052  elog(ERROR, "could not find enum option %d for %s",
7053  val, record->gen.name);
7054  return NULL; /* silence compiler */
7055 }
#define ERROR
Definition: elog.h:33
#define elog(elevel,...)
Definition: elog.h:218
long val
Definition: informix.c:664

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

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

◆ get_explain_guc_options()

struct config_generic** get_explain_guc_options ( int *  num)

Definition at line 9519 of file guc.c.

9520 {
9521  struct config_generic **result;
9522 
9523  *num = 0;
9524 
9525  /*
9526  * While only a fraction of all the GUC variables are marked GUC_EXPLAIN,
9527  * it doesn't seem worth dynamically resizing this array.
9528  */
9529  result = palloc(sizeof(struct config_generic *) * num_guc_variables);
9530 
9531  for (int i = 0; i < num_guc_variables; i++)
9532  {
9533  bool modified;
9534  struct config_generic *conf = guc_variables[i];
9535 
9536  /* return only parameters marked for inclusion in explain */
9537  if (!(conf->flags & GUC_EXPLAIN))
9538  continue;
9539 
9540  /* return only options visible to the current user */
9541  if ((conf->flags & GUC_NO_SHOW_ALL) ||
9542  ((conf->flags & GUC_SUPERUSER_ONLY) &&
9543  !is_member_of_role(GetUserId(), ROLE_PG_READ_ALL_SETTINGS)))
9544  continue;
9545 
9546  /* return only options that are different from their boot values */
9547  modified = false;
9548 
9549  switch (conf->vartype)
9550  {
9551  case PGC_BOOL:
9552  {
9553  struct config_bool *lconf = (struct config_bool *) conf;
9554 
9555  modified = (lconf->boot_val != *(lconf->variable));
9556  }
9557  break;
9558 
9559  case PGC_INT:
9560  {
9561  struct config_int *lconf = (struct config_int *) conf;
9562 
9563  modified = (lconf->boot_val != *(lconf->variable));
9564  }
9565  break;
9566 
9567  case PGC_REAL:
9568  {
9569  struct config_real *lconf = (struct config_real *) conf;
9570 
9571  modified = (lconf->boot_val != *(lconf->variable));
9572  }
9573  break;
9574 
9575  case PGC_STRING:
9576  {
9577  struct config_string *lconf = (struct config_string *) conf;
9578 
9579  modified = (strcmp(lconf->boot_val, *(lconf->variable)) != 0);
9580  }
9581  break;
9582 
9583  case PGC_ENUM:
9584  {
9585  struct config_enum *lconf = (struct config_enum *) conf;
9586 
9587  modified = (lconf->boot_val != *(lconf->variable));
9588  }
9589  break;
9590 
9591  default:
9592  elog(ERROR, "unexpected GUC type: %d", conf->vartype);
9593  }
9594 
9595  if (!modified)
9596  continue;
9597 
9598  /* OK, report it */
9599  result[*num] = conf;
9600  *num = *num + 1;
9601  }
9602 
9603  return result;
9604 }
bool is_member_of_role(Oid member, Oid role)
Definition: acl.c:4869
#define GUC_EXPLAIN
Definition: guc.h:229
#define GUC_SUPERUSER_ONLY
Definition: guc.h:212
#define GUC_NO_SHOW_ALL
Definition: guc.h:206
void * palloc(Size size)
Definition: mcxt.c:1062
Oid GetUserId(void)
Definition: miscinit.c:495
bool * variable
Definition: guc_tables.h:179
bool boot_val
Definition: guc_tables.h:180
int * variable
Definition: guc_tables.h:239
int boot_val
Definition: guc_tables.h:194
int * variable
Definition: guc_tables.h:193
double boot_val
Definition: guc_tables.h:210
double * variable
Definition: guc_tables.h:209
char ** variable
Definition: guc_tables.h:225
const char * boot_val
Definition: guc_tables.h:226

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, guc_variables, 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().

◆ get_guc_variables()

struct config_generic** get_guc_variables ( void  )

Definition at line 5307 of file guc.c.

5308 {
5309  return guc_variables;
5310 }

References guc_variables.

Referenced by GucInfoMain().

Variable Documentation

◆ config_group_names

const char* const config_group_names[]
extern

Definition at line 735 of file guc.c.

Referenced by GetConfigOptionByNum().

◆ config_type_names

const char* const config_type_names[]
extern

Definition at line 833 of file guc.c.

Referenced by GetConfigOptionByNum().

◆ GucContext_Names

const char* const GucContext_Names[]
extern

Definition at line 692 of file guc.c.

Referenced by GetConfigOptionByNum().

◆ GucSource_Names

const char* const GucSource_Names[]
extern

Definition at line 711 of file guc.c.

Referenced by GetConfigOptionByNum().