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 , WAL_SUMMARIZATION , 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_OTHER , 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 187 of file guc_tables.h.

◆ GUC_NEEDS_REPORT

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

Definition at line 193 of file guc_tables.h.

◆ GUC_PENDING_RESTART

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

Definition at line 192 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 
WAL_SUMMARIZATION 
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_OTHER 
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 */
90  AUTOVACUUM,
102 };
@ RESOURCES_KERNEL
Definition: guc_tables.h:65
@ CLIENT_CONN_LOCALE
Definition: guc_tables.h:92
@ WAL_ARCHIVE_RECOVERY
Definition: guc_tables.h:73
@ STATS_CUMULATIVE
Definition: guc_tables.h:89
@ AUTOVACUUM
Definition: guc_tables.h:90
@ CLIENT_CONN_PRELOAD
Definition: guc_tables.h:93
@ QUERY_TUNING_OTHER
Definition: guc_tables.h:83
@ LOGGING_WHERE
Definition: guc_tables.h:84
@ CONN_AUTH_AUTH
Definition: guc_tables.h:61
@ ERROR_HANDLING_OPTIONS
Definition: guc_tables.h:98
@ PROCESS_TITLE
Definition: guc_tables.h:87
@ RESOURCES_DISK
Definition: guc_tables.h:64
@ REPLICATION_SENDING
Definition: guc_tables.h:76
@ LOCK_MANAGEMENT
Definition: guc_tables.h:95
@ CUSTOM_OPTIONS
Definition: guc_tables.h:100
@ REPLICATION_PRIMARY
Definition: guc_tables.h:77
@ STATS_MONITORING
Definition: guc_tables.h:88
@ 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:99
@ DEVELOPER_OPTIONS
Definition: guc_tables.h:101
@ RESOURCES_VACUUM_DELAY
Definition: guc_tables.h:66
@ QUERY_TUNING_METHOD
Definition: guc_tables.h:80
@ LOGGING_WHAT
Definition: guc_tables.h:86
@ RESOURCES_ASYNCHRONOUS
Definition: guc_tables.h:68
@ QUERY_TUNING_GEQO
Definition: guc_tables.h:82
@ WAL_SETTINGS
Definition: guc_tables.h:69
@ COMPAT_OPTIONS_OTHER
Definition: guc_tables.h:97
@ CLIENT_CONN_STATEMENT
Definition: guc_tables.h:91
@ FILE_LOCATIONS
Definition: guc_tables.h:58
@ REPLICATION_STANDBY
Definition: guc_tables.h:78
@ QUERY_TUNING_COST
Definition: guc_tables.h:81
@ WAL_ARCHIVING
Definition: guc_tables.h:71
@ COMPAT_OPTIONS_PREVIOUS
Definition: guc_tables.h:96
@ WAL_CHECKPOINTS
Definition: guc_tables.h:70
@ CLIENT_CONN_OTHER
Definition: guc_tables.h:94
@ LOGGING_WHEN
Definition: guc_tables.h:85
@ CONN_AUTH_TCP
Definition: guc_tables.h:60
@ REPLICATION_SUBSCRIBERS
Definition: guc_tables.h:79
@ WAL_SUMMARIZATION
Definition: guc_tables.h:75
@ 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 108 of file guc_tables.h.

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

Function Documentation

◆ build_guc_variables()

void build_guc_variables ( void  )

Definition at line 903 of file guc.c.

904 {
905  int size_vars;
906  int num_vars = 0;
907  HASHCTL hash_ctl;
908  GUCHashEntry *hentry;
909  bool found;
910  int i;
911 
912  /*
913  * Create the memory context that will hold all GUC-related data.
914  */
915  Assert(GUCMemoryContext == NULL);
917  "GUCMemoryContext",
919 
920  /*
921  * Count all the built-in variables, and set their vartypes correctly.
922  */
923  for (i = 0; ConfigureNamesBool[i].gen.name; i++)
924  {
925  struct config_bool *conf = &ConfigureNamesBool[i];
926 
927  /* Rather than requiring vartype to be filled in by hand, do this: */
928  conf->gen.vartype = PGC_BOOL;
929  num_vars++;
930  }
931 
932  for (i = 0; ConfigureNamesInt[i].gen.name; i++)
933  {
934  struct config_int *conf = &ConfigureNamesInt[i];
935 
936  conf->gen.vartype = PGC_INT;
937  num_vars++;
938  }
939 
940  for (i = 0; ConfigureNamesReal[i].gen.name; i++)
941  {
942  struct config_real *conf = &ConfigureNamesReal[i];
943 
944  conf->gen.vartype = PGC_REAL;
945  num_vars++;
946  }
947 
948  for (i = 0; ConfigureNamesString[i].gen.name; i++)
949  {
950  struct config_string *conf = &ConfigureNamesString[i];
951 
952  conf->gen.vartype = PGC_STRING;
953  num_vars++;
954  }
955 
956  for (i = 0; ConfigureNamesEnum[i].gen.name; i++)
957  {
958  struct config_enum *conf = &ConfigureNamesEnum[i];
959 
960  conf->gen.vartype = PGC_ENUM;
961  num_vars++;
962  }
963 
964  /*
965  * Create hash table with 20% slack
966  */
967  size_vars = num_vars + num_vars / 4;
968 
969  hash_ctl.keysize = sizeof(char *);
970  hash_ctl.entrysize = sizeof(GUCHashEntry);
971  hash_ctl.hash = guc_name_hash;
972  hash_ctl.match = guc_name_match;
973  hash_ctl.hcxt = GUCMemoryContext;
974  guc_hashtab = hash_create("GUC hash table",
975  size_vars,
976  &hash_ctl,
978 
979  for (i = 0; ConfigureNamesBool[i].gen.name; i++)
980  {
981  struct config_generic *gucvar = &ConfigureNamesBool[i].gen;
982 
983  hentry = (GUCHashEntry *) hash_search(guc_hashtab,
984  &gucvar->name,
985  HASH_ENTER,
986  &found);
987  Assert(!found);
988  hentry->gucvar = gucvar;
989  }
990 
991  for (i = 0; ConfigureNamesInt[i].gen.name; i++)
992  {
993  struct config_generic *gucvar = &ConfigureNamesInt[i].gen;
994 
995  hentry = (GUCHashEntry *) hash_search(guc_hashtab,
996  &gucvar->name,
997  HASH_ENTER,
998  &found);
999  Assert(!found);
1000  hentry->gucvar = gucvar;
1001  }
1002 
1003  for (i = 0; ConfigureNamesReal[i].gen.name; i++)
1004  {
1005  struct config_generic *gucvar = &ConfigureNamesReal[i].gen;
1006 
1007  hentry = (GUCHashEntry *) hash_search(guc_hashtab,
1008  &gucvar->name,
1009  HASH_ENTER,
1010  &found);
1011  Assert(!found);
1012  hentry->gucvar = gucvar;
1013  }
1014 
1015  for (i = 0; ConfigureNamesString[i].gen.name; i++)
1016  {
1017  struct config_generic *gucvar = &ConfigureNamesString[i].gen;
1018 
1019  hentry = (GUCHashEntry *) hash_search(guc_hashtab,
1020  &gucvar->name,
1021  HASH_ENTER,
1022  &found);
1023  Assert(!found);
1024  hentry->gucvar = gucvar;
1025  }
1026 
1027  for (i = 0; ConfigureNamesEnum[i].gen.name; i++)
1028  {
1029  struct config_generic *gucvar = &ConfigureNamesEnum[i].gen;
1030 
1031  hentry = (GUCHashEntry *) hash_search(guc_hashtab,
1032  &gucvar->name,
1033  HASH_ENTER,
1034  &found);
1035  Assert(!found);
1036  hentry->gucvar = gucvar;
1037  }
1038 
1039  Assert(num_vars == hash_get_num_entries(guc_hashtab));
1040 }
#define Assert(condition)
Definition: c.h:812
void * hash_search(HTAB *hashp, const void *keyPtr, HASHACTION action, bool *foundPtr)
Definition: dynahash.c:955
HTAB * hash_create(const char *tabname, long nelem, const HASHCTL *info, int flags)
Definition: dynahash.c:352
long hash_get_num_entries(HTAB *hashp)
Definition: dynahash.c:1341
static int guc_name_match(const void *key1, const void *key2, Size keysize)
Definition: guc.c:1354
static uint32 guc_name_hash(const void *key, Size keysize)
Definition: guc.c:1330
static HTAB * guc_hashtab
Definition: guc.c:212
static MemoryContext GUCMemoryContext
Definition: guc.c:199
struct config_string ConfigureNamesString[]
Definition: guc_tables.c:4024
struct config_int ConfigureNamesInt[]
Definition: guc_tables.c:2105
struct config_bool ConfigureNamesBool[]
Definition: guc_tables.c:770
struct config_real ConfigureNamesReal[]
Definition: guc_tables.c:3743
struct config_enum ConfigureNamesEnum[]
Definition: guc_tables.c:4823
@ 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:72
MemoryContext TopMemoryContext
Definition: mcxt.c:149
#define AllocSetContextCreate
Definition: memutils.h:129
#define ALLOCSET_DEFAULT_SIZES
Definition: memutils.h:160
struct config_generic * gucvar
Definition: guc.c:209
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:200
struct config_generic gen
Definition: guc_tables.h:270
const char * name
Definition: guc_tables.h:156
enum config_type vartype
Definition: guc_tables.h:163
struct config_generic gen
Definition: guc_tables.h:214
struct config_generic gen
Definition: guc_tables.h:230
struct config_generic gen
Definition: guc_tables.h:256

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

3074 {
3075  const struct config_enum_entry *entry;
3076  StringInfoData retstr;
3077  int seplen;
3078 
3079  initStringInfo(&retstr);
3080  appendStringInfoString(&retstr, prefix);
3081 
3082  seplen = strlen(separator);
3083  for (entry = record->options; entry && entry->name; entry++)
3084  {
3085  if (!entry->hidden)
3086  {
3087  appendStringInfoString(&retstr, entry->name);
3088  appendBinaryStringInfo(&retstr, separator, seplen);
3089  }
3090  }
3091 
3092  /*
3093  * All the entries may have been hidden, leaving the string empty if no
3094  * prefix was given. This indicates a broken GUC setup, since there is no
3095  * use for an enum without any values, so we just check to make sure we
3096  * don't write to invalid memory instead of actually trying to do
3097  * something smart with it.
3098  */
3099  if (retstr.len >= seplen)
3100  {
3101  /* Replace final separator */
3102  retstr.data[retstr.len - seplen] = '\0';
3103  retstr.len -= seplen;
3104  }
3105 
3106  appendStringInfoString(&retstr, suffix);
3107 
3108  return retstr.data;
3109 }
void appendBinaryStringInfo(StringInfo str, const void *data, int datalen)
Definition: stringinfo.c:230
void appendStringInfoString(StringInfo str, const char *s)
Definition: stringinfo.c:179
void initStringInfo(StringInfo str)
Definition: stringinfo.c:56
Definition: guc.h:170
const char * name
Definition: guc.h:171
bool hidden
Definition: guc.h:173
const struct config_enum_entry * options
Definition: guc_tables.h:274

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

3048 {
3049  const struct config_enum_entry *entry;
3050 
3051  for (entry = record->options; entry && entry->name; entry++)
3052  {
3053  if (pg_strcasecmp(value, entry->name) == 0)
3054  {
3055  *retval = entry->val;
3056  return true;
3057  }
3058  }
3059 
3060  *retval = 0;
3061  return false;
3062 }
static struct @160 value
int pg_strcasecmp(const char *s1, const char *s2)
Definition: pgstrcasecmp.c:36
int val
Definition: guc.h:172

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

3024 {
3025  const struct config_enum_entry *entry;
3026 
3027  for (entry = record->options; entry && entry->name; entry++)
3028  {
3029  if (entry->val == val)
3030  return entry->name;
3031  }
3032 
3033  elog(ERROR, "could not find enum option %d for %s",
3034  val, record->gen.name);
3035  return NULL; /* silence compiler */
3036 }
#define ERROR
Definition: elog.h:39
#define elog(elevel,...)
Definition: elog.h:225
long val
Definition: informix.c:689

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:5268
#define GUC_SUPERUSER_ONLY
Definition: guc.h:220
Oid GetUserId(void)
Definition: miscinit.c:524

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

1237 {
1238  GUCHashEntry *hentry;
1239  int i;
1240 
1241  Assert(name);
1242 
1243  /* Look it up using the hash table. */
1244  hentry = (GUCHashEntry *) hash_search(guc_hashtab,
1245  &name,
1246  HASH_FIND,
1247  NULL);
1248  if (hentry)
1249  return hentry->gucvar;
1250 
1251  /*
1252  * See if the name is an obsolete name for a variable. We assume that the
1253  * set of supported old names is short enough that a brute-force search is
1254  * the best way.
1255  */
1256  for (i = 0; map_old_guc_names[i] != NULL; i += 2)
1257  {
1259  return find_option(map_old_guc_names[i + 1], false,
1260  skip_errors, elevel);
1261  }
1262 
1263  if (create_placeholders)
1264  {
1265  /*
1266  * Check if the name is valid, and if so, add a placeholder.
1267  */
1268  if (assignable_custom_variable_name(name, skip_errors, elevel))
1269  return add_placeholder_variable(name, elevel);
1270  else
1271  return NULL; /* error message, if any, already emitted */
1272  }
1273 
1274  /* Unknown name and we're not supposed to make a placeholder */
1275  if (!skip_errors)
1276  ereport(elevel,
1277  (errcode(ERRCODE_UNDEFINED_OBJECT),
1278  errmsg("unrecognized configuration parameter \"%s\"",
1279  name)));
1280  return NULL;
1281 }
int errcode(int sqlerrcode)
Definition: elog.c:853
int errmsg(const char *fmt,...)
Definition: elog.c:1070
#define ereport(elevel,...)
Definition: elog.h:149
static const char *const map_old_guc_names[]
Definition: guc.c:190
static bool assignable_custom_variable_name(const char *name, bool skip_errors, int elevel)
Definition: guc.c:1121
struct config_generic * find_option(const char *name, bool create_placeholders, bool skip_errors, int elevel)
Definition: guc.c:1235
static struct config_generic * add_placeholder_variable(const char *name, int elevel)
Definition: guc.c:1177
int guc_name_compare(const char *namea, const char *nameb)
Definition: guc.c:1300
@ 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(), get_config_handle(), GetConfigOption(), GetConfigOptionByName(), GetConfigOptionFlags(), GetConfigOptionResetString(), GUCArrayAdd(), GUCArrayDelete(), InitializeWalConsistencyChecking(), pg_settings_get_flags(), ProcessConfigFileInternal(), SelectConfigFiles(), set_config_sourcefile(), set_config_with_handle(), and validate_option_array_item().

◆ get_explain_guc_options()

struct config_generic** get_explain_guc_options ( int *  num)

Definition at line 5331 of file guc.c.

5332 {
5333  struct config_generic **result;
5334  dlist_iter iter;
5335 
5336  *num = 0;
5337 
5338  /*
5339  * While only a fraction of all the GUC variables are marked GUC_EXPLAIN,
5340  * it doesn't seem worth dynamically resizing this array.
5341  */
5342  result = palloc(sizeof(struct config_generic *) * hash_get_num_entries(guc_hashtab));
5343 
5344  /* We need only consider GUCs with source not PGC_S_DEFAULT */
5346  {
5347  struct config_generic *conf = dlist_container(struct config_generic,
5348  nondef_link, iter.cur);
5349  bool modified;
5350 
5351  /* return only parameters marked for inclusion in explain */
5352  if (!(conf->flags & GUC_EXPLAIN))
5353  continue;
5354 
5355  /* return only options visible to the current user */
5356  if (!ConfigOptionIsVisible(conf))
5357  continue;
5358 
5359  /* return only options that are different from their boot values */
5360  modified = false;
5361 
5362  switch (conf->vartype)
5363  {
5364  case PGC_BOOL:
5365  {
5366  struct config_bool *lconf = (struct config_bool *) conf;
5367 
5368  modified = (lconf->boot_val != *(lconf->variable));
5369  }
5370  break;
5371 
5372  case PGC_INT:
5373  {
5374  struct config_int *lconf = (struct config_int *) conf;
5375 
5376  modified = (lconf->boot_val != *(lconf->variable));
5377  }
5378  break;
5379 
5380  case PGC_REAL:
5381  {
5382  struct config_real *lconf = (struct config_real *) conf;
5383 
5384  modified = (lconf->boot_val != *(lconf->variable));
5385  }
5386  break;
5387 
5388  case PGC_STRING:
5389  {
5390  struct config_string *lconf = (struct config_string *) conf;
5391 
5392  if (lconf->boot_val == NULL &&
5393  *lconf->variable == NULL)
5394  modified = false;
5395  else if (lconf->boot_val == NULL ||
5396  *lconf->variable == NULL)
5397  modified = true;
5398  else
5399  modified = (strcmp(lconf->boot_val, *(lconf->variable)) != 0);
5400  }
5401  break;
5402 
5403  case PGC_ENUM:
5404  {
5405  struct config_enum *lconf = (struct config_enum *) conf;
5406 
5407  modified = (lconf->boot_val != *(lconf->variable));
5408  }
5409  break;
5410 
5411  default:
5412  elog(ERROR, "unexpected GUC type: %d", conf->vartype);
5413  }
5414 
5415  if (!modified)
5416  continue;
5417 
5418  /* OK, report it */
5419  result[*num] = conf;
5420  *num = *num + 1;
5421  }
5422 
5423  return result;
5424 }
static dlist_head guc_nondef_list
Definition: guc.c:222
#define GUC_EXPLAIN
Definition: guc.h:215
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:1317
bool * variable
Definition: guc_tables.h:202
bool boot_val
Definition: guc_tables.h:203
int * variable
Definition: guc_tables.h:272
dlist_node nondef_link
Definition: guc_tables.h:173
int boot_val
Definition: guc_tables.h:217
int * variable
Definition: guc_tables.h:216
double boot_val
Definition: guc_tables.h:233
double * variable
Definition: guc_tables.h:232
char ** variable
Definition: guc_tables.h:258
const char * boot_val
Definition: guc_tables.h:259
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 872 of file guc.c.

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

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

5466 {
5467  char buffer[256];
5468  const char *val;
5469 
5470  switch (record->vartype)
5471  {
5472  case PGC_BOOL:
5473  {
5474  struct config_bool *conf = (struct config_bool *) record;
5475 
5476  if (conf->show_hook)
5477  val = conf->show_hook();
5478  else
5479  val = *conf->variable ? "on" : "off";
5480  }
5481  break;
5482 
5483  case PGC_INT:
5484  {
5485  struct config_int *conf = (struct config_int *) record;
5486 
5487  if (conf->show_hook)
5488  val = conf->show_hook();
5489  else
5490  {
5491  /*
5492  * Use int64 arithmetic to avoid overflows in units
5493  * conversion.
5494  */
5495  int64 result = *conf->variable;
5496  const char *unit;
5497 
5498  if (use_units && result > 0 && (record->flags & GUC_UNIT))
5500  record->flags & GUC_UNIT,
5501  &result, &unit);
5502  else
5503  unit = "";
5504 
5505  snprintf(buffer, sizeof(buffer), INT64_FORMAT "%s",
5506  result, unit);
5507  val = buffer;
5508  }
5509  }
5510  break;
5511 
5512  case PGC_REAL:
5513  {
5514  struct config_real *conf = (struct config_real *) record;
5515 
5516  if (conf->show_hook)
5517  val = conf->show_hook();
5518  else
5519  {
5520  double result = *conf->variable;
5521  const char *unit;
5522 
5523  if (use_units && result > 0 && (record->flags & GUC_UNIT))
5525  record->flags & GUC_UNIT,
5526  &result, &unit);
5527  else
5528  unit = "";
5529 
5530  snprintf(buffer, sizeof(buffer), "%g%s",
5531  result, unit);
5532  val = buffer;
5533  }
5534  }
5535  break;
5536 
5537  case PGC_STRING:
5538  {
5539  struct config_string *conf = (struct config_string *) record;
5540 
5541  if (conf->show_hook)
5542  val = conf->show_hook();
5543  else if (*conf->variable && **conf->variable)
5544  val = *conf->variable;
5545  else
5546  val = "";
5547  }
5548  break;
5549 
5550  case PGC_ENUM:
5551  {
5552  struct config_enum *conf = (struct config_enum *) record;
5553 
5554  if (conf->show_hook)
5555  val = conf->show_hook();
5556  else
5557  val = config_enum_lookup_by_value(conf, *conf->variable);
5558  }
5559  break;
5560 
5561  default:
5562  /* just to keep compiler quiet */
5563  val = "???";
5564  break;
5565  }
5566 
5567  return pstrdup(val);
5568 }
#define INT64_FORMAT
Definition: c.h:503
int64_t int64
Definition: c.h:482
const char * config_enum_lookup_by_value(struct config_enum *record, int val)
Definition: guc.c:3023
static void convert_int_from_base_unit(int64 base_value, int base_unit, int64 *value, const char **unit)
Definition: guc.c:2729
static void convert_real_from_base_unit(double base_value, int base_unit, double *value, const char **unit)
Definition: guc.c:2771
#define GUC_UNIT
Definition: guc.h:240
char * pstrdup(const char *in)
Definition: mcxt.c:1696
#define snprintf
Definition: port.h:238
GucShowHook show_hook
Definition: guc_tables.h:206
GucShowHook show_hook
Definition: guc_tables.h:277
GucShowHook show_hook
Definition: guc_tables.h:222
GucShowHook show_hook
Definition: guc_tables.h:238
GucShowHook show_hook
Definition: guc_tables.h:262

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 673 of file guc_tables.c.

Referenced by GetConfigOptionValues().

◆ config_type_names

PGDLLIMPORT const char* const config_type_names[]
extern

Definition at line 730 of file guc_tables.c.

Referenced by GetConfigOptionValues().

◆ ConfigureNamesBool

PGDLLIMPORT struct config_bool ConfigureNamesBool[]
extern

Definition at line 739 of file guc_tables.c.

Referenced by build_guc_variables().

◆ ConfigureNamesEnum

PGDLLIMPORT struct config_enum ConfigureNamesEnum[]
extern

Definition at line 739 of file guc_tables.c.

Referenced by build_guc_variables().

◆ ConfigureNamesInt

PGDLLIMPORT struct config_int ConfigureNamesInt[]
extern

Definition at line 739 of file guc_tables.c.

Referenced by build_guc_variables().

◆ ConfigureNamesReal

PGDLLIMPORT struct config_real ConfigureNamesReal[]
extern

Definition at line 739 of file guc_tables.c.

Referenced by build_guc_variables().

◆ ConfigureNamesString

PGDLLIMPORT struct config_string ConfigureNamesString[]
extern

Definition at line 739 of file guc_tables.c.

Referenced by build_guc_variables().

◆ GucContext_Names

PGDLLIMPORT const char* const GucContext_Names[]
extern

Definition at line 630 of file guc_tables.c.

Referenced by GetConfigOptionValues().

◆ GucSource_Names

PGDLLIMPORT const char* const GucSource_Names[]
extern

Definition at line 649 of file guc_tables.c.

Referenced by GetConfigOptionValues().