PostgreSQL Source Code  git master
guc_tables.h File Reference
#include "lib/ilist.h"
#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_TCP ,
  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_RECOVERY ,
  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_CUMULATIVE ,
  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_genericfind_option (const char *name, bool create_placeholders, bool skip_errors, int elevel)
 
struct config_generic ** get_explain_guc_options (int *num)
 
char * ShowGUCOption (struct config_generic *record, bool use_units)
 
bool ConfigOptionIsVisible (struct config_generic *conf)
 
struct config_generic ** get_guc_variables (int *num_vars)
 
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)
 
char * config_enum_get_options (struct config_enum *record, const char *prefix, const char *suffix, const char *separator)
 

Variables

PGDLLIMPORT const char *const config_group_names []
 
PGDLLIMPORT const char *const config_type_names []
 
PGDLLIMPORT const char *const GucContext_Names []
 
PGDLLIMPORT const char *const GucSource_Names []
 
PGDLLIMPORT struct config_bool ConfigureNamesBool []
 
PGDLLIMPORT struct config_int ConfigureNamesInt []
 
PGDLLIMPORT struct config_real ConfigureNamesReal []
 
PGDLLIMPORT struct config_string ConfigureNamesString []
 
PGDLLIMPORT struct config_enum ConfigureNamesEnum []
 

Macro Definition Documentation

◆ GUC_IS_IN_FILE

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

Definition at line 186 of file guc_tables.h.

◆ GUC_NEEDS_REPORT

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

Definition at line 192 of file guc_tables.h.

◆ GUC_PENDING_RESTART

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

Definition at line 191 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_TCP 
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_RECOVERY 
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_CUMULATIVE 
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 55 of file guc_tables.h.

56 {
57  UNGROUPED, /* use for options not shown in pg_settings */
89  AUTOVACUUM,
101 };
@ RESOURCES_KERNEL
Definition: guc_tables.h:65
@ CLIENT_CONN_LOCALE
Definition: guc_tables.h:91
@ WAL_ARCHIVE_RECOVERY
Definition: guc_tables.h:73
@ STATS_CUMULATIVE
Definition: guc_tables.h:88
@ AUTOVACUUM
Definition: guc_tables.h:89
@ CLIENT_CONN_PRELOAD
Definition: guc_tables.h:92
@ QUERY_TUNING_OTHER
Definition: guc_tables.h:82
@ LOGGING_WHERE
Definition: guc_tables.h:83
@ CONN_AUTH_AUTH
Definition: guc_tables.h:61
@ ERROR_HANDLING_OPTIONS
Definition: guc_tables.h:97
@ PROCESS_TITLE
Definition: guc_tables.h:86
@ RESOURCES_DISK
Definition: guc_tables.h:64
@ REPLICATION_SENDING
Definition: guc_tables.h:75
@ LOCK_MANAGEMENT
Definition: guc_tables.h:94
@ CUSTOM_OPTIONS
Definition: guc_tables.h:99
@ REPLICATION_PRIMARY
Definition: guc_tables.h:76
@ STATS_MONITORING
Definition: guc_tables.h:87
@ WAL_RECOVERY_TARGET
Definition: guc_tables.h:74
@ WAL_RECOVERY
Definition: guc_tables.h:72
@ CONN_AUTH_SSL
Definition: guc_tables.h:62
@ RESOURCES_MEM
Definition: guc_tables.h:63
@ RESOURCES_BGWRITER
Definition: guc_tables.h:67
@ PRESET_OPTIONS
Definition: guc_tables.h:98
@ DEVELOPER_OPTIONS
Definition: guc_tables.h:100
@ RESOURCES_VACUUM_DELAY
Definition: guc_tables.h:66
@ QUERY_TUNING_METHOD
Definition: guc_tables.h:79
@ LOGGING_WHAT
Definition: guc_tables.h:85
@ RESOURCES_ASYNCHRONOUS
Definition: guc_tables.h:68
@ QUERY_TUNING_GEQO
Definition: guc_tables.h:81
@ WAL_SETTINGS
Definition: guc_tables.h:69
@ CLIENT_CONN_STATEMENT
Definition: guc_tables.h:90
@ FILE_LOCATIONS
Definition: guc_tables.h:58
@ COMPAT_OPTIONS_CLIENT
Definition: guc_tables.h:96
@ REPLICATION_STANDBY
Definition: guc_tables.h:77
@ QUERY_TUNING_COST
Definition: guc_tables.h:80
@ WAL_ARCHIVING
Definition: guc_tables.h:71
@ COMPAT_OPTIONS_PREVIOUS
Definition: guc_tables.h:95
@ WAL_CHECKPOINTS
Definition: guc_tables.h:70
@ CLIENT_CONN_OTHER
Definition: guc_tables.h:93
@ LOGGING_WHEN
Definition: guc_tables.h:84
@ CONN_AUTH_TCP
Definition: guc_tables.h:60
@ REPLICATION_SUBSCRIBERS
Definition: guc_tables.h:78
@ CONN_AUTH_SETTINGS
Definition: guc_tables.h:59
@ UNGROUPED
Definition: guc_tables.h:57

◆ config_type

Enumerator
PGC_BOOL 
PGC_INT 
PGC_REAL 
PGC_STRING 
PGC_ENUM 

Definition at line 23 of file guc_tables.h.

24 {
25  PGC_BOOL,
26  PGC_INT,
27  PGC_REAL,
28  PGC_STRING,
29  PGC_ENUM,
30 };
@ PGC_BOOL
Definition: guc_tables.h:25
@ PGC_STRING
Definition: guc_tables.h:28
@ PGC_ENUM
Definition: guc_tables.h:29
@ PGC_REAL
Definition: guc_tables.h:27
@ PGC_INT
Definition: guc_tables.h:26

◆ GucStackState

Enumerator
GUC_SAVE 
GUC_SET 
GUC_LOCAL 
GUC_SET_LOCAL 

Definition at line 107 of file guc_tables.h.

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

Function Documentation

◆ build_guc_variables()

void build_guc_variables ( void  )

Definition at line 898 of file guc.c.

899 {
900  int size_vars;
901  int num_vars = 0;
902  HASHCTL hash_ctl;
903  GUCHashEntry *hentry;
904  bool found;
905  int i;
906 
907  /*
908  * Create the memory context that will hold all GUC-related data.
909  */
910  Assert(GUCMemoryContext == NULL);
912  "GUCMemoryContext",
914 
915  /*
916  * Count all the built-in variables, and set their vartypes correctly.
917  */
918  for (i = 0; ConfigureNamesBool[i].gen.name; i++)
919  {
920  struct config_bool *conf = &ConfigureNamesBool[i];
921 
922  /* Rather than requiring vartype to be filled in by hand, do this: */
923  conf->gen.vartype = PGC_BOOL;
924  num_vars++;
925  }
926 
927  for (i = 0; ConfigureNamesInt[i].gen.name; i++)
928  {
929  struct config_int *conf = &ConfigureNamesInt[i];
930 
931  conf->gen.vartype = PGC_INT;
932  num_vars++;
933  }
934 
935  for (i = 0; ConfigureNamesReal[i].gen.name; i++)
936  {
937  struct config_real *conf = &ConfigureNamesReal[i];
938 
939  conf->gen.vartype = PGC_REAL;
940  num_vars++;
941  }
942 
943  for (i = 0; ConfigureNamesString[i].gen.name; i++)
944  {
945  struct config_string *conf = &ConfigureNamesString[i];
946 
947  conf->gen.vartype = PGC_STRING;
948  num_vars++;
949  }
950 
951  for (i = 0; ConfigureNamesEnum[i].gen.name; i++)
952  {
953  struct config_enum *conf = &ConfigureNamesEnum[i];
954 
955  conf->gen.vartype = PGC_ENUM;
956  num_vars++;
957  }
958 
959  /*
960  * Create hash table with 20% slack
961  */
962  size_vars = num_vars + num_vars / 4;
963 
964  hash_ctl.keysize = sizeof(char *);
965  hash_ctl.entrysize = sizeof(GUCHashEntry);
966  hash_ctl.hash = guc_name_hash;
967  hash_ctl.match = guc_name_match;
968  hash_ctl.hcxt = GUCMemoryContext;
969  guc_hashtab = hash_create("GUC hash table",
970  size_vars,
971  &hash_ctl,
973 
974  for (i = 0; ConfigureNamesBool[i].gen.name; i++)
975  {
976  struct config_generic *gucvar = &ConfigureNamesBool[i].gen;
977 
978  hentry = (GUCHashEntry *) hash_search(guc_hashtab,
979  &gucvar->name,
980  HASH_ENTER,
981  &found);
982  Assert(!found);
983  hentry->gucvar = gucvar;
984  }
985 
986  for (i = 0; ConfigureNamesInt[i].gen.name; i++)
987  {
988  struct config_generic *gucvar = &ConfigureNamesInt[i].gen;
989 
990  hentry = (GUCHashEntry *) hash_search(guc_hashtab,
991  &gucvar->name,
992  HASH_ENTER,
993  &found);
994  Assert(!found);
995  hentry->gucvar = gucvar;
996  }
997 
998  for (i = 0; ConfigureNamesReal[i].gen.name; i++)
999  {
1000  struct config_generic *gucvar = &ConfigureNamesReal[i].gen;
1001 
1002  hentry = (GUCHashEntry *) hash_search(guc_hashtab,
1003  &gucvar->name,
1004  HASH_ENTER,
1005  &found);
1006  Assert(!found);
1007  hentry->gucvar = gucvar;
1008  }
1009 
1010  for (i = 0; ConfigureNamesString[i].gen.name; i++)
1011  {
1012  struct config_generic *gucvar = &ConfigureNamesString[i].gen;
1013 
1014  hentry = (GUCHashEntry *) hash_search(guc_hashtab,
1015  &gucvar->name,
1016  HASH_ENTER,
1017  &found);
1018  Assert(!found);
1019  hentry->gucvar = gucvar;
1020  }
1021 
1022  for (i = 0; ConfigureNamesEnum[i].gen.name; i++)
1023  {
1024  struct config_generic *gucvar = &ConfigureNamesEnum[i].gen;
1025 
1026  hentry = (GUCHashEntry *) hash_search(guc_hashtab,
1027  &gucvar->name,
1028  HASH_ENTER,
1029  &found);
1030  Assert(!found);
1031  hentry->gucvar = gucvar;
1032  }
1033 
1034  Assert(num_vars == hash_get_num_entries(guc_hashtab));
1035 }
void * hash_search(HTAB *hashp, const void *keyPtr, HASHACTION action, bool *foundPtr)
Definition: dynahash.c:953
HTAB * hash_create(const char *tabname, long nelem, const HASHCTL *info, int flags)
Definition: dynahash.c:350
long hash_get_num_entries(HTAB *hashp)
Definition: dynahash.c:1377
static int guc_name_match(const void *key1, const void *key2, Size keysize)
Definition: guc.c:1349
static uint32 guc_name_hash(const void *key, Size keysize)
Definition: guc.c:1325
static HTAB * guc_hashtab
Definition: guc.c:207
static MemoryContext GUCMemoryContext
Definition: guc.c:194
struct config_string ConfigureNamesString[]
Definition: guc_tables.c:3819
struct config_int ConfigureNamesInt[]
Definition: guc_tables.c:2031
struct config_bool ConfigureNamesBool[]
Definition: guc_tables.c:811
struct config_real ConfigureNamesReal[]
Definition: guc_tables.c:3538
struct config_enum ConfigureNamesEnum[]
Definition: guc_tables.c:4582
@ HASH_ENTER
Definition: hsearch.h:114
#define HASH_CONTEXT
Definition: hsearch.h:102
#define HASH_ELEM
Definition: hsearch.h:95
#define HASH_COMPARE
Definition: hsearch.h:99
#define HASH_FUNCTION
Definition: hsearch.h:98
int i
Definition: isn.c:73
Assert(fmt[strlen(fmt) - 1] !='\n')
MemoryContext TopMemoryContext
Definition: mcxt.c:141
#define AllocSetContextCreate
Definition: memutils.h:126
#define ALLOCSET_DEFAULT_SIZES
Definition: memutils.h:150
struct config_generic * gucvar
Definition: guc.c:204
Size keysize
Definition: hsearch.h:75
HashValueFunc hash
Definition: hsearch.h:78
Size entrysize
Definition: hsearch.h:76
HashCompareFunc match
Definition: hsearch.h:80
MemoryContext hcxt
Definition: hsearch.h:86
struct config_generic gen
Definition: guc_tables.h:199
struct config_generic gen
Definition: guc_tables.h:269
const char * name
Definition: guc_tables.h:155
enum config_type vartype
Definition: guc_tables.h:162
struct config_generic gen
Definition: guc_tables.h:213
struct config_generic gen
Definition: guc_tables.h:229
struct config_generic gen
Definition: guc_tables.h:255

References ALLOCSET_DEFAULT_SIZES, AllocSetContextCreate, Assert(), ConfigureNamesBool, ConfigureNamesEnum, ConfigureNamesInt, ConfigureNamesReal, ConfigureNamesString, HASHCTL::entrysize, config_bool::gen, config_int::gen, config_real::gen, config_string::gen, config_enum::gen, guc_hashtab, guc_name_hash(), guc_name_match(), GUCMemoryContext, GUCHashEntry::gucvar, HASHCTL::hash, HASH_COMPARE, HASH_CONTEXT, hash_create(), HASH_ELEM, HASH_ENTER, HASH_FUNCTION, hash_get_num_entries(), hash_search(), HASHCTL::hcxt, i, HASHCTL::keysize, HASHCTL::match, config_generic::name, PGC_BOOL, PGC_ENUM, PGC_INT, PGC_REAL, PGC_STRING, TopMemoryContext, and config_generic::vartype.

Referenced by GucInfoMain(), and InitializeGUCOptions().

◆ config_enum_get_options()

char* config_enum_get_options ( struct config_enum record,
const char *  prefix,
const char *  suffix,
const char *  separator 
)

Definition at line 3055 of file guc.c.

3057 {
3058  const struct config_enum_entry *entry;
3059  StringInfoData retstr;
3060  int seplen;
3061 
3062  initStringInfo(&retstr);
3063  appendStringInfoString(&retstr, prefix);
3064 
3065  seplen = strlen(separator);
3066  for (entry = record->options; entry && entry->name; entry++)
3067  {
3068  if (!entry->hidden)
3069  {
3070  appendStringInfoString(&retstr, entry->name);
3071  appendBinaryStringInfo(&retstr, separator, seplen);
3072  }
3073  }
3074 
3075  /*
3076  * All the entries may have been hidden, leaving the string empty if no
3077  * prefix was given. This indicates a broken GUC setup, since there is no
3078  * use for an enum without any values, so we just check to make sure we
3079  * don't write to invalid memory instead of actually trying to do
3080  * something smart with it.
3081  */
3082  if (retstr.len >= seplen)
3083  {
3084  /* Replace final separator */
3085  retstr.data[retstr.len - seplen] = '\0';
3086  retstr.len -= seplen;
3087  }
3088 
3089  appendStringInfoString(&retstr, suffix);
3090 
3091  return retstr.data;
3092 }
void appendBinaryStringInfo(StringInfo str, const void *data, int datalen)
Definition: stringinfo.c:233
void appendStringInfoString(StringInfo str, const char *s)
Definition: stringinfo.c:182
void initStringInfo(StringInfo str)
Definition: stringinfo.c:59
Definition: guc.h:168
const char * name
Definition: guc.h:169
bool hidden
Definition: guc.h:171
const struct config_enum_entry * options
Definition: guc_tables.h:273

References appendBinaryStringInfo(), appendStringInfoString(), StringInfoData::data, config_enum_entry::hidden, initStringInfo(), StringInfoData::len, config_enum_entry::name, and config_enum::options.

Referenced by GetConfigOptionValues(), and parse_and_validate_value().

◆ config_enum_lookup_by_name()

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

Definition at line 3029 of file guc.c.

3031 {
3032  const struct config_enum_entry *entry;
3033 
3034  for (entry = record->options; entry && entry->name; entry++)
3035  {
3036  if (pg_strcasecmp(value, entry->name) == 0)
3037  {
3038  *retval = entry->val;
3039  return true;
3040  }
3041  }
3042 
3043  *retval = 0;
3044  return false;
3045 }
static struct @148 value
int pg_strcasecmp(const char *s1, const char *s2)
Definition: pgstrcasecmp.c:36
int val
Definition: guc.h:170

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 3006 of file guc.c.

3007 {
3008  const struct config_enum_entry *entry;
3009 
3010  for (entry = record->options; entry && entry->name; entry++)
3011  {
3012  if (entry->val == val)
3013  return entry->name;
3014  }
3015 
3016  elog(ERROR, "could not find enum option %d for %s",
3017  val, record->gen.name);
3018  return NULL; /* silence compiler */
3019 }
#define ERROR
Definition: elog.h:39
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 call_enum_check_hook(), estimate_variable_size(), GetConfigOption(), GetConfigOptionResetString(), GetConfigOptionValues(), serialize_variable(), and ShowGUCOption().

◆ ConfigOptionIsVisible()

bool ConfigOptionIsVisible ( struct config_generic conf)

Definition at line 581 of file guc_funcs.c.

582 {
583  if ((conf->flags & GUC_SUPERUSER_ONLY) &&
584  !has_privs_of_role(GetUserId(), ROLE_PG_READ_ALL_SETTINGS))
585  return false;
586  else
587  return true;
588 }
bool has_privs_of_role(Oid member, Oid role)
Definition: acl.c:5060
#define GUC_SUPERUSER_ONLY
Definition: guc.h:218
Oid GetUserId(void)
Definition: miscinit.c:508

References config_generic::flags, GetUserId(), GUC_SUPERUSER_ONLY, and has_privs_of_role().

Referenced by get_explain_guc_options(), GetConfigOption(), GetConfigOptionByName(), GetConfigOptionResetString(), show_all_settings(), and ShowAllGUCConfig().

◆ find_option()

struct config_generic* find_option ( const char *  name,
bool  create_placeholders,
bool  skip_errors,
int  elevel 
)

Definition at line 1230 of file guc.c.

1232 {
1233  GUCHashEntry *hentry;
1234  int i;
1235 
1236  Assert(name);
1237 
1238  /* Look it up using the hash table. */
1239  hentry = (GUCHashEntry *) hash_search(guc_hashtab,
1240  &name,
1241  HASH_FIND,
1242  NULL);
1243  if (hentry)
1244  return hentry->gucvar;
1245 
1246  /*
1247  * See if the name is an obsolete name for a variable. We assume that the
1248  * set of supported old names is short enough that a brute-force search is
1249  * the best way.
1250  */
1251  for (i = 0; map_old_guc_names[i] != NULL; i += 2)
1252  {
1254  return find_option(map_old_guc_names[i + 1], false,
1255  skip_errors, elevel);
1256  }
1257 
1258  if (create_placeholders)
1259  {
1260  /*
1261  * Check if the name is valid, and if so, add a placeholder.
1262  */
1263  if (assignable_custom_variable_name(name, skip_errors, elevel))
1264  return add_placeholder_variable(name, elevel);
1265  else
1266  return NULL; /* error message, if any, already emitted */
1267  }
1268 
1269  /* Unknown name and we're not supposed to make a placeholder */
1270  if (!skip_errors)
1271  ereport(elevel,
1272  (errcode(ERRCODE_UNDEFINED_OBJECT),
1273  errmsg("unrecognized configuration parameter \"%s\"",
1274  name)));
1275  return NULL;
1276 }
int errcode(int sqlerrcode)
Definition: elog.c:858
int errmsg(const char *fmt,...)
Definition: elog.c:1069
#define ereport(elevel,...)
Definition: elog.h:149
static const char *const map_old_guc_names[]
Definition: guc.c:186
static bool assignable_custom_variable_name(const char *name, bool skip_errors, int elevel)
Definition: guc.c:1116
struct config_generic * find_option(const char *name, bool create_placeholders, bool skip_errors, int elevel)
Definition: guc.c:1230
static struct config_generic * add_placeholder_variable(const char *name, int elevel)
Definition: guc.c:1172
int guc_name_compare(const char *namea, const char *nameb)
Definition: guc.c:1295
@ HASH_FIND
Definition: hsearch.h:113
const char * name

References add_placeholder_variable(), Assert(), assignable_custom_variable_name(), ereport, errcode(), errmsg(), guc_hashtab, guc_name_compare(), GUCHashEntry::gucvar, HASH_FIND, hash_search(), i, map_old_guc_names, and name.

Referenced by AlterSystemSetConfigFile(), check_GUC_name_for_parameter_acl(), flatten_set_variable_args(), GetConfigOption(), GetConfigOptionByName(), GetConfigOptionFlags(), GetConfigOptionResetString(), GUCArrayAdd(), GUCArrayDelete(), InitializeWalConsistencyChecking(), pg_settings_get_flags(), ProcessConfigFileInternal(), SelectConfigFiles(), set_config_option_ext(), set_config_sourcefile(), and validate_option_array_item().

◆ get_explain_guc_options()

struct config_generic** get_explain_guc_options ( int *  num)

Definition at line 5200 of file guc.c.

5201 {
5202  struct config_generic **result;
5203  dlist_iter iter;
5204 
5205  *num = 0;
5206 
5207  /*
5208  * While only a fraction of all the GUC variables are marked GUC_EXPLAIN,
5209  * it doesn't seem worth dynamically resizing this array.
5210  */
5211  result = palloc(sizeof(struct config_generic *) * hash_get_num_entries(guc_hashtab));
5212 
5213  /* We need only consider GUCs with source not PGC_S_DEFAULT */
5215  {
5216  struct config_generic *conf = dlist_container(struct config_generic,
5217  nondef_link, iter.cur);
5218  bool modified;
5219 
5220  /* return only parameters marked for inclusion in explain */
5221  if (!(conf->flags & GUC_EXPLAIN))
5222  continue;
5223 
5224  /* return only options visible to the current user */
5225  if (!ConfigOptionIsVisible(conf))
5226  continue;
5227 
5228  /* return only options that are different from their boot values */
5229  modified = false;
5230 
5231  switch (conf->vartype)
5232  {
5233  case PGC_BOOL:
5234  {
5235  struct config_bool *lconf = (struct config_bool *) conf;
5236 
5237  modified = (lconf->boot_val != *(lconf->variable));
5238  }
5239  break;
5240 
5241  case PGC_INT:
5242  {
5243  struct config_int *lconf = (struct config_int *) conf;
5244 
5245  modified = (lconf->boot_val != *(lconf->variable));
5246  }
5247  break;
5248 
5249  case PGC_REAL:
5250  {
5251  struct config_real *lconf = (struct config_real *) conf;
5252 
5253  modified = (lconf->boot_val != *(lconf->variable));
5254  }
5255  break;
5256 
5257  case PGC_STRING:
5258  {
5259  struct config_string *lconf = (struct config_string *) conf;
5260 
5261  if (lconf->boot_val == NULL &&
5262  *lconf->variable == NULL)
5263  modified = false;
5264  else if (lconf->boot_val == NULL ||
5265  *lconf->variable == NULL)
5266  modified = true;
5267  else
5268  modified = (strcmp(lconf->boot_val, *(lconf->variable)) != 0);
5269  }
5270  break;
5271 
5272  case PGC_ENUM:
5273  {
5274  struct config_enum *lconf = (struct config_enum *) conf;
5275 
5276  modified = (lconf->boot_val != *(lconf->variable));
5277  }
5278  break;
5279 
5280  default:
5281  elog(ERROR, "unexpected GUC type: %d", conf->vartype);
5282  }
5283 
5284  if (!modified)
5285  continue;
5286 
5287  /* OK, report it */
5288  result[*num] = conf;
5289  *num = *num + 1;
5290  }
5291 
5292  return result;
5293 }
static dlist_head guc_nondef_list
Definition: guc.c:217
#define GUC_EXPLAIN
Definition: guc.h:213
bool ConfigOptionIsVisible(struct config_generic *conf)
Definition: guc_funcs.c:581
#define dlist_foreach(iter, lhead)
Definition: ilist.h:623
#define dlist_container(type, membername, ptr)
Definition: ilist.h:593
void * palloc(Size size)
Definition: mcxt.c:1226
bool * variable
Definition: guc_tables.h:201
bool boot_val
Definition: guc_tables.h:202
int * variable
Definition: guc_tables.h:271
dlist_node nondef_link
Definition: guc_tables.h:172
int boot_val
Definition: guc_tables.h:216
int * variable
Definition: guc_tables.h:215
double boot_val
Definition: guc_tables.h:232
double * variable
Definition: guc_tables.h:231
char ** variable
Definition: guc_tables.h:257
const char * boot_val
Definition: guc_tables.h:258
dlist_node * cur
Definition: ilist.h:179

References config_bool::boot_val, config_int::boot_val, config_real::boot_val, config_string::boot_val, config_enum::boot_val, ConfigOptionIsVisible(), dlist_iter::cur, dlist_container, dlist_foreach, elog(), ERROR, config_generic::flags, GUC_EXPLAIN, guc_hashtab, guc_nondef_list, hash_get_num_entries(), config_generic::nondef_link, 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 ( int *  num_vars)

Definition at line 867 of file guc.c.

868 {
869  struct config_generic **result;
871  GUCHashEntry *hentry;
872  int i;
873 
874  *num_vars = hash_get_num_entries(guc_hashtab);
875  result = palloc(sizeof(struct config_generic *) * *num_vars);
876 
877  /* Extract pointers from the hash table */
878  i = 0;
880  while ((hentry = (GUCHashEntry *) hash_seq_search(&status)) != NULL)
881  result[i++] = hentry->gucvar;
882  Assert(i == *num_vars);
883 
884  /* Sort by name */
885  qsort(result, *num_vars,
886  sizeof(struct config_generic *), guc_var_compare);
887 
888  return result;
889 }
void * hash_seq_search(HASH_SEQ_STATUS *status)
Definition: dynahash.c:1431
void hash_seq_init(HASH_SEQ_STATUS *status, HTAB *hashp)
Definition: dynahash.c:1421
static int guc_var_compare(const void *a, const void *b)
Definition: guc.c:1283
#define qsort(a, b, c, d)
Definition: port.h:445

References Assert(), guc_hashtab, guc_var_compare(), GUCHashEntry::gucvar, hash_get_num_entries(), hash_seq_init(), hash_seq_search(), i, palloc(), qsort, and config_generic::status.

Referenced by GucInfoMain(), show_all_settings(), and ShowAllGUCConfig().

◆ ShowGUCOption()

char* ShowGUCOption ( struct config_generic record,
bool  use_units 
)

Definition at line 5334 of file guc.c.

5335 {
5336  char buffer[256];
5337  const char *val;
5338 
5339  switch (record->vartype)
5340  {
5341  case PGC_BOOL:
5342  {
5343  struct config_bool *conf = (struct config_bool *) record;
5344 
5345  if (conf->show_hook)
5346  val = conf->show_hook();
5347  else
5348  val = *conf->variable ? "on" : "off";
5349  }
5350  break;
5351 
5352  case PGC_INT:
5353  {
5354  struct config_int *conf = (struct config_int *) record;
5355 
5356  if (conf->show_hook)
5357  val = conf->show_hook();
5358  else
5359  {
5360  /*
5361  * Use int64 arithmetic to avoid overflows in units
5362  * conversion.
5363  */
5364  int64 result = *conf->variable;
5365  const char *unit;
5366 
5367  if (use_units && result > 0 && (record->flags & GUC_UNIT))
5369  record->flags & GUC_UNIT,
5370  &result, &unit);
5371  else
5372  unit = "";
5373 
5374  snprintf(buffer, sizeof(buffer), INT64_FORMAT "%s",
5375  result, unit);
5376  val = buffer;
5377  }
5378  }
5379  break;
5380 
5381  case PGC_REAL:
5382  {
5383  struct config_real *conf = (struct config_real *) record;
5384 
5385  if (conf->show_hook)
5386  val = conf->show_hook();
5387  else
5388  {
5389  double result = *conf->variable;
5390  const char *unit;
5391 
5392  if (use_units && result > 0 && (record->flags & GUC_UNIT))
5394  record->flags & GUC_UNIT,
5395  &result, &unit);
5396  else
5397  unit = "";
5398 
5399  snprintf(buffer, sizeof(buffer), "%g%s",
5400  result, unit);
5401  val = buffer;
5402  }
5403  }
5404  break;
5405 
5406  case PGC_STRING:
5407  {
5408  struct config_string *conf = (struct config_string *) record;
5409 
5410  if (conf->show_hook)
5411  val = conf->show_hook();
5412  else if (*conf->variable && **conf->variable)
5413  val = *conf->variable;
5414  else
5415  val = "";
5416  }
5417  break;
5418 
5419  case PGC_ENUM:
5420  {
5421  struct config_enum *conf = (struct config_enum *) record;
5422 
5423  if (conf->show_hook)
5424  val = conf->show_hook();
5425  else
5426  val = config_enum_lookup_by_value(conf, *conf->variable);
5427  }
5428  break;
5429 
5430  default:
5431  /* just to keep compiler quiet */
5432  val = "???";
5433  break;
5434  }
5435 
5436  return pstrdup(val);
5437 }
#define INT64_FORMAT
Definition: c.h:537
const char * config_enum_lookup_by_value(struct config_enum *record, int val)
Definition: guc.c:3006
static void convert_int_from_base_unit(int64 base_value, int base_unit, int64 *value, const char **unit)
Definition: guc.c:2712
static void convert_real_from_base_unit(double base_value, int base_unit, double *value, const char **unit)
Definition: guc.c:2754
#define GUC_UNIT
Definition: guc.h:237
char * pstrdup(const char *in)
Definition: mcxt.c:1644
#define snprintf
Definition: port.h:238
GucShowHook show_hook
Definition: guc_tables.h:205
GucShowHook show_hook
Definition: guc_tables.h:276
GucShowHook show_hook
Definition: guc_tables.h:221
GucShowHook show_hook
Definition: guc_tables.h:237
GucShowHook show_hook
Definition: guc_tables.h:261

References config_enum_lookup_by_value(), convert_int_from_base_unit(), convert_real_from_base_unit(), config_generic::flags, GUC_UNIT, INT64_FORMAT, PGC_BOOL, PGC_ENUM, PGC_INT, PGC_REAL, PGC_STRING, pstrdup(), config_bool::show_hook, config_int::show_hook, config_real::show_hook, config_string::show_hook, config_enum::show_hook, snprintf, val, config_bool::variable, config_int::variable, config_real::variable, config_string::variable, config_enum::variable, and config_generic::vartype.

Referenced by GetConfigOptionByName(), GetConfigOptionValues(), ReportGUCOption(), and ShowAllGUCConfig().

Variable Documentation

◆ config_group_names

PGDLLIMPORT const char* const config_group_names[]
extern

Definition at line 669 of file guc_tables.c.

Referenced by GetConfigOptionValues().

◆ config_type_names

PGDLLIMPORT const char* const config_type_names[]
extern

Definition at line 771 of file guc_tables.c.

Referenced by GetConfigOptionValues().

◆ ConfigureNamesBool

PGDLLIMPORT struct config_bool ConfigureNamesBool[]
extern

Definition at line 780 of file guc_tables.c.

Referenced by build_guc_variables().

◆ ConfigureNamesEnum

PGDLLIMPORT struct config_enum ConfigureNamesEnum[]
extern

Definition at line 780 of file guc_tables.c.

Referenced by build_guc_variables().

◆ ConfigureNamesInt

PGDLLIMPORT struct config_int ConfigureNamesInt[]
extern

Definition at line 780 of file guc_tables.c.

Referenced by build_guc_variables().

◆ ConfigureNamesReal

PGDLLIMPORT struct config_real ConfigureNamesReal[]
extern

Definition at line 780 of file guc_tables.c.

Referenced by build_guc_variables().

◆ ConfigureNamesString

PGDLLIMPORT struct config_string ConfigureNamesString[]
extern

Definition at line 780 of file guc_tables.c.

Referenced by build_guc_variables().

◆ GucContext_Names

PGDLLIMPORT const char* const GucContext_Names[]
extern

Definition at line 626 of file guc_tables.c.

Referenced by GetConfigOptionValues().

◆ GucSource_Names

PGDLLIMPORT const char* const GucSource_Names[]
extern

Definition at line 645 of file guc_tables.c.

Referenced by GetConfigOptionValues().