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_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

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

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

4926 {
4927  int size_vars;
4928  int num_vars = 0;
4929  struct config_generic **guc_vars;
4930  int i;
4931 
4932  for (i = 0; ConfigureNamesBool[i].gen.name; i++)
4933  {
4934  struct config_bool *conf = &ConfigureNamesBool[i];
4935 
4936  /* Rather than requiring vartype to be filled in by hand, do this: */
4937  conf->gen.vartype = PGC_BOOL;
4938  num_vars++;
4939  }
4940 
4941  for (i = 0; ConfigureNamesInt[i].gen.name; i++)
4942  {
4943  struct config_int *conf = &ConfigureNamesInt[i];
4944 
4945  conf->gen.vartype = PGC_INT;
4946  num_vars++;
4947  }
4948 
4949  for (i = 0; ConfigureNamesReal[i].gen.name; i++)
4950  {
4951  struct config_real *conf = &ConfigureNamesReal[i];
4952 
4953  conf->gen.vartype = PGC_REAL;
4954  num_vars++;
4955  }
4956 
4957  for (i = 0; ConfigureNamesString[i].gen.name; i++)
4958  {
4959  struct config_string *conf = &ConfigureNamesString[i];
4960 
4961  conf->gen.vartype = PGC_STRING;
4962  num_vars++;
4963  }
4964 
4965  for (i = 0; ConfigureNamesEnum[i].gen.name; i++)
4966  {
4967  struct config_enum *conf = &ConfigureNamesEnum[i];
4968 
4969  conf->gen.vartype = PGC_ENUM;
4970  num_vars++;
4971  }
4972 
4973  /*
4974  * Create table with 20% slack
4975  */
4976  size_vars = num_vars + num_vars / 4;
4977 
4978  guc_vars = (struct config_generic **)
4979  guc_malloc(FATAL, size_vars * sizeof(struct config_generic *));
4980 
4981  num_vars = 0;
4982 
4983  for (i = 0; ConfigureNamesBool[i].gen.name; i++)
4984  guc_vars[num_vars++] = &ConfigureNamesBool[i].gen;
4985 
4986  for (i = 0; ConfigureNamesInt[i].gen.name; i++)
4987  guc_vars[num_vars++] = &ConfigureNamesInt[i].gen;
4988 
4989  for (i = 0; ConfigureNamesReal[i].gen.name; i++)
4990  guc_vars[num_vars++] = &ConfigureNamesReal[i].gen;
4991 
4992  for (i = 0; ConfigureNamesString[i].gen.name; i++)
4993  guc_vars[num_vars++] = &ConfigureNamesString[i].gen;
4994 
4995  for (i = 0; ConfigureNamesEnum[i].gen.name; i++)
4996  guc_vars[num_vars++] = &ConfigureNamesEnum[i].gen;
4997 
4998  if (guc_variables)
5000  guc_variables = guc_vars;
5001  num_guc_variables = num_vars;
5002  size_guc_variables = size_vars;
5004  sizeof(struct config_generic *), guc_var_compare);
5005 }
static struct config_int ConfigureNamesInt[]
Definition: guc.c:2012
const char * name
Definition: guc_tables.h:149
static struct config_enum ConfigureNamesEnum[]
Definition: guc.c:4305
static struct config_bool ConfigureNamesBool[]
Definition: guc.c:894
static int guc_var_compare(const void *a, const void *b)
Definition: guc.c:5147
static int num_guc_variables
Definition: guc.c:4664
#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:4661
enum config_type vartype
Definition: guc_tables.h:156
static int size_guc_variables
Definition: guc.c:4667
static struct config_real ConfigureNamesReal[]
Definition: guc.c:3279
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:3537
int i
#define qsort(a, b, c, d)
Definition: port.h:491
static void * guc_malloc(int elevel, size_t size)
Definition: guc.c:4702
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 6517 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().

6519 {
6520  const struct config_enum_entry *entry;
6521 
6522  for (entry = record->options; entry && entry->name; entry++)
6523  {
6524  if (pg_strcasecmp(value, entry->name) == 0)
6525  {
6526  *retval = entry->val;
6527  return true;
6528  }
6529  }
6530 
6531  *retval = 0;
6532  return false;
6533 }
Definition: guc.h:164
static struct @145 value
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:167
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 6494 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().

6495 {
6496  const struct config_enum_entry *entry;
6497 
6498  for (entry = record->options; entry && entry->name; entry++)
6499  {
6500  if (entry->val == val)
6501  return entry->name;
6502  }
6503 
6504  elog(ERROR, "could not find enum option %d for %s",
6505  val, record->gen.name);
6506  return NULL; /* silence compiler */
6507 }
Definition: guc.h:164
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:167
struct config_generic gen
Definition: guc_tables.h:242
const char * name
Definition: guc.h:166
#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 8956 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().

8957 {
8958  struct config_generic **result;
8959 
8960  *num = 0;
8961 
8962  /*
8963  * While only a fraction of all the GUC variables are marked GUC_EXPLAIN,
8964  * it doesn't seem worth dynamically resizing this array.
8965  */
8966  result = palloc(sizeof(struct config_generic *) * num_guc_variables);
8967 
8968  for (int i = 0; i < num_guc_variables; i++)
8969  {
8970  bool modified;
8971  struct config_generic *conf = guc_variables[i];
8972 
8973  /* return only parameters marked for inclusion in explain */
8974  if (!(conf->flags & GUC_EXPLAIN))
8975  continue;
8976 
8977  /* return only options visible to the current user */
8978  if ((conf->flags & GUC_NO_SHOW_ALL) ||
8979  ((conf->flags & GUC_SUPERUSER_ONLY) &&
8980  !is_member_of_role(GetUserId(), DEFAULT_ROLE_READ_ALL_SETTINGS)))
8981  continue;
8982 
8983  /* return only options that are different from their boot values */
8984  modified = false;
8985 
8986  switch (conf->vartype)
8987  {
8988  case PGC_BOOL:
8989  {
8990  struct config_bool *lconf = (struct config_bool *) conf;
8991 
8992  modified = (lconf->boot_val != *(lconf->variable));
8993  }
8994  break;
8995 
8996  case PGC_INT:
8997  {
8998  struct config_int *lconf = (struct config_int *) conf;
8999 
9000  modified = (lconf->boot_val != *(lconf->variable));
9001  }
9002  break;
9003 
9004  case PGC_REAL:
9005  {
9006  struct config_real *lconf = (struct config_real *) conf;
9007 
9008  modified = (lconf->boot_val != *(lconf->variable));
9009  }
9010  break;
9011 
9012  case PGC_STRING:
9013  {
9014  struct config_string *lconf = (struct config_string *) conf;
9015 
9016  modified = (strcmp(lconf->boot_val, *(lconf->variable)) != 0);
9017  }
9018  break;
9019 
9020  case PGC_ENUM:
9021  {
9022  struct config_enum *lconf = (struct config_enum *) conf;
9023 
9024  modified = (lconf->boot_val != *(lconf->variable));
9025  }
9026  break;
9027 
9028  default:
9029  elog(ERROR, "unexpected GUC type: %d", conf->vartype);
9030  }
9031 
9032  if (!modified)
9033  continue;
9034 
9035  /* OK, report it */
9036  result[*num] = conf;
9037  *num = *num + 1;
9038  }
9039 
9040  return result;
9041 }
Oid GetUserId(void)
Definition: miscinit.c:380
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:206
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:4664
bool boot_val
Definition: guc_tables.h:185
#define GUC_EXPLAIN
Definition: guc.h:230
double * variable
Definition: guc_tables.h:214
static struct config_generic ** guc_variables
Definition: guc.c:4661
enum config_type vartype
Definition: guc_tables.h:156
#define GUC_SUPERUSER_ONLY
Definition: guc.h:212
bool is_member_of_role(Oid member, Oid role)
Definition: acl.c:4924
double boot_val
Definition: guc_tables.h:215
void * palloc(Size size)
Definition: mcxt.c:949
#define elog(elevel,...)
Definition: elog.h:228
int i

◆ get_guc_variables()

struct config_generic** get_guc_variables ( void  )

Definition at line 4913 of file guc.c.

References guc_variables.

Referenced by GucInfoMain().

4914 {
4915  return guc_variables;
4916 }
static struct config_generic ** guc_variables
Definition: guc.c:4661

Variable Documentation

◆ config_group_names

const char* const config_group_names[]

Definition at line 644 of file guc.c.

Referenced by printMixedStruct().

◆ config_type_names

const char* const config_type_names[]

Definition at line 757 of file guc.c.

◆ GucContext_Names

const char* const GucContext_Names[]

Definition at line 607 of file guc.c.

Referenced by printMixedStruct().

◆ GucSource_Names

const char* const GucSource_Names[]

Definition at line 623 of file guc.c.