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

897 {
898  int size_vars;
899  int num_vars = 0;
900  HASHCTL hash_ctl;
901  GUCHashEntry *hentry;
902  bool found;
903  int i;
904 
905  /*
906  * Create the memory context that will hold all GUC-related data.
907  */
908  Assert(GUCMemoryContext == NULL);
910  "GUCMemoryContext",
912 
913  /*
914  * Count all the built-in variables, and set their vartypes correctly.
915  */
916  for (i = 0; ConfigureNamesBool[i].gen.name; i++)
917  {
918  struct config_bool *conf = &ConfigureNamesBool[i];
919 
920  /* Rather than requiring vartype to be filled in by hand, do this: */
921  conf->gen.vartype = PGC_BOOL;
922  num_vars++;
923  }
924 
925  for (i = 0; ConfigureNamesInt[i].gen.name; i++)
926  {
927  struct config_int *conf = &ConfigureNamesInt[i];
928 
929  conf->gen.vartype = PGC_INT;
930  num_vars++;
931  }
932 
933  for (i = 0; ConfigureNamesReal[i].gen.name; i++)
934  {
935  struct config_real *conf = &ConfigureNamesReal[i];
936 
937  conf->gen.vartype = PGC_REAL;
938  num_vars++;
939  }
940 
941  for (i = 0; ConfigureNamesString[i].gen.name; i++)
942  {
943  struct config_string *conf = &ConfigureNamesString[i];
944 
945  conf->gen.vartype = PGC_STRING;
946  num_vars++;
947  }
948 
949  for (i = 0; ConfigureNamesEnum[i].gen.name; i++)
950  {
951  struct config_enum *conf = &ConfigureNamesEnum[i];
952 
953  conf->gen.vartype = PGC_ENUM;
954  num_vars++;
955  }
956 
957  /*
958  * Create hash table with 20% slack
959  */
960  size_vars = num_vars + num_vars / 4;
961 
962  hash_ctl.keysize = sizeof(char *);
963  hash_ctl.entrysize = sizeof(GUCHashEntry);
964  hash_ctl.hash = guc_name_hash;
965  hash_ctl.match = guc_name_match;
966  hash_ctl.hcxt = GUCMemoryContext;
967  guc_hashtab = hash_create("GUC hash table",
968  size_vars,
969  &hash_ctl,
971 
972  for (i = 0; ConfigureNamesBool[i].gen.name; i++)
973  {
974  struct config_generic *gucvar = &ConfigureNamesBool[i].gen;
975 
976  hentry = (GUCHashEntry *) hash_search(guc_hashtab,
977  &gucvar->name,
978  HASH_ENTER,
979  &found);
980  Assert(!found);
981  hentry->gucvar = gucvar;
982  }
983 
984  for (i = 0; ConfigureNamesInt[i].gen.name; i++)
985  {
986  struct config_generic *gucvar = &ConfigureNamesInt[i].gen;
987 
988  hentry = (GUCHashEntry *) hash_search(guc_hashtab,
989  &gucvar->name,
990  HASH_ENTER,
991  &found);
992  Assert(!found);
993  hentry->gucvar = gucvar;
994  }
995 
996  for (i = 0; ConfigureNamesReal[i].gen.name; i++)
997  {
998  struct config_generic *gucvar = &ConfigureNamesReal[i].gen;
999 
1000  hentry = (GUCHashEntry *) hash_search(guc_hashtab,
1001  &gucvar->name,
1002  HASH_ENTER,
1003  &found);
1004  Assert(!found);
1005  hentry->gucvar = gucvar;
1006  }
1007 
1008  for (i = 0; ConfigureNamesString[i].gen.name; i++)
1009  {
1010  struct config_generic *gucvar = &ConfigureNamesString[i].gen;
1011 
1012  hentry = (GUCHashEntry *) hash_search(guc_hashtab,
1013  &gucvar->name,
1014  HASH_ENTER,
1015  &found);
1016  Assert(!found);
1017  hentry->gucvar = gucvar;
1018  }
1019 
1020  for (i = 0; ConfigureNamesEnum[i].gen.name; i++)
1021  {
1022  struct config_generic *gucvar = &ConfigureNamesEnum[i].gen;
1023 
1024  hentry = (GUCHashEntry *) hash_search(guc_hashtab,
1025  &gucvar->name,
1026  HASH_ENTER,
1027  &found);
1028  Assert(!found);
1029  hentry->gucvar = gucvar;
1030  }
1031 
1032  Assert(num_vars == hash_get_num_entries(guc_hashtab));
1033 }
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:1319
static uint32 guc_name_hash(const void *key, Size keysize)
Definition: guc.c:1295
static HTAB * guc_hashtab
Definition: guc.c:207
static MemoryContext GUCMemoryContext
Definition: guc.c:194
struct config_string ConfigureNamesString[]
Definition: guc_tables.c:3801
struct config_int ConfigureNamesInt[]
Definition: guc_tables.c:2012
struct config_bool ConfigureNamesBool[]
Definition: guc_tables.c:806
struct config_real ConfigureNamesReal[]
Definition: guc_tables.c:3520
struct config_enum ConfigureNamesEnum[]
Definition: guc_tables.c:4588
@ 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:129
#define ALLOCSET_DEFAULT_SIZES
Definition: memutils.h:153
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:259
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:245

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

3027 {
3028  const struct config_enum_entry *entry;
3029  StringInfoData retstr;
3030  int seplen;
3031 
3032  initStringInfo(&retstr);
3033  appendStringInfoString(&retstr, prefix);
3034 
3035  seplen = strlen(separator);
3036  for (entry = record->options; entry && entry->name; entry++)
3037  {
3038  if (!entry->hidden)
3039  {
3040  appendStringInfoString(&retstr, entry->name);
3041  appendBinaryStringInfo(&retstr, separator, seplen);
3042  }
3043  }
3044 
3045  /*
3046  * All the entries may have been hidden, leaving the string empty if no
3047  * prefix was given. This indicates a broken GUC setup, since there is no
3048  * use for an enum without any values, so we just check to make sure we
3049  * don't write to invalid memory instead of actually trying to do
3050  * something smart with it.
3051  */
3052  if (retstr.len >= seplen)
3053  {
3054  /* Replace final separator */
3055  retstr.data[retstr.len - seplen] = '\0';
3056  retstr.len -= seplen;
3057  }
3058 
3059  appendStringInfoString(&retstr, suffix);
3060 
3061  return retstr.data;
3062 }
void appendBinaryStringInfo(StringInfo str, const void *data, int datalen)
Definition: stringinfo.c:227
void appendStringInfoString(StringInfo str, const char *s)
Definition: stringinfo.c:176
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:263

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

3001 {
3002  const struct config_enum_entry *entry;
3003 
3004  for (entry = record->options; entry && entry->name; entry++)
3005  {
3006  if (pg_strcasecmp(value, entry->name) == 0)
3007  {
3008  *retval = entry->val;
3009  return true;
3010  }
3011  }
3012 
3013  *retval = 0;
3014  return false;
3015 }
static struct @147 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 2976 of file guc.c.

2977 {
2978  const struct config_enum_entry *entry;
2979 
2980  for (entry = record->options; entry && entry->name; entry++)
2981  {
2982  if (entry->val == val)
2983  return entry->name;
2984  }
2985 
2986  elog(ERROR, "could not find enum option %d for %s",
2987  val, record->gen.name);
2988  return NULL; /* silence compiler */
2989 }
#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:4969
#define GUC_SUPERUSER_ONLY
Definition: guc.h:218
Oid GetUserId(void)
Definition: miscinit.c:510

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

1165 {
1166  GUCHashEntry *hentry;
1167  int i;
1168 
1169  Assert(name);
1170 
1171  /* Look it up using the hash table. */
1172  hentry = (GUCHashEntry *) hash_search(guc_hashtab,
1173  &name,
1174  HASH_FIND,
1175  NULL);
1176  if (hentry)
1177  return hentry->gucvar;
1178 
1179  /*
1180  * See if the name is an obsolete name for a variable. We assume that the
1181  * set of supported old names is short enough that a brute-force search is
1182  * the best way.
1183  */
1184  for (i = 0; map_old_guc_names[i] != NULL; i += 2)
1185  {
1187  return find_option(map_old_guc_names[i + 1], false,
1188  skip_errors, elevel);
1189  }
1190 
1191  if (create_placeholders)
1192  {
1193  /*
1194  * Check if the name is valid, and if so, add a placeholder. If it
1195  * doesn't contain a separator, don't assume that it was meant to be a
1196  * placeholder.
1197  */
1198  const char *sep = strchr(name, GUC_QUALIFIER_SEPARATOR);
1199 
1200  if (sep != NULL)
1201  {
1202  size_t classLen = sep - name;
1203  ListCell *lc;
1204 
1205  /* The name must be syntactically acceptable ... */
1207  {
1208  if (!skip_errors)
1209  ereport(elevel,
1210  (errcode(ERRCODE_INVALID_NAME),
1211  errmsg("invalid configuration parameter name \"%s\"",
1212  name),
1213  errdetail("Custom parameter names must be two or more simple identifiers separated by dots.")));
1214  return NULL;
1215  }
1216  /* ... and it must not match any previously-reserved prefix */
1217  foreach(lc, reserved_class_prefix)
1218  {
1219  const char *rcprefix = lfirst(lc);
1220 
1221  if (strlen(rcprefix) == classLen &&
1222  strncmp(name, rcprefix, classLen) == 0)
1223  {
1224  if (!skip_errors)
1225  ereport(elevel,
1226  (errcode(ERRCODE_INVALID_NAME),
1227  errmsg("invalid configuration parameter name \"%s\"",
1228  name),
1229  errdetail("\"%s\" is a reserved prefix.",
1230  rcprefix)));
1231  return NULL;
1232  }
1233  }
1234  /* OK, create it */
1235  return add_placeholder_variable(name, elevel);
1236  }
1237  }
1238 
1239  /* Unknown name */
1240  if (!skip_errors)
1241  ereport(elevel,
1242  (errcode(ERRCODE_UNDEFINED_OBJECT),
1243  errmsg("unrecognized configuration parameter \"%s\"",
1244  name)));
1245  return NULL;
1246 }
int errdetail(const char *fmt,...)
Definition: elog.c:1202
int errcode(int sqlerrcode)
Definition: elog.c:858
int errmsg(const char *fmt,...)
Definition: elog.c:1069
#define ereport(elevel,...)
Definition: elog.h:149
const char * name
Definition: encode.c:571
static const char *const map_old_guc_names[]
Definition: guc.c:186
struct config_generic * find_option(const char *name, bool create_placeholders, bool skip_errors, int elevel)
Definition: guc.c:1163
static bool valid_custom_variable_name(const char *name)
Definition: guc.c:1069
static List * reserved_class_prefix
Definition: guc.c:71
static struct config_generic * add_placeholder_variable(const char *name, int elevel)
Definition: guc.c:1105
int guc_name_compare(const char *namea, const char *nameb)
Definition: guc.c:1265
#define GUC_QUALIFIER_SEPARATOR
Definition: guc.h:202
@ HASH_FIND
Definition: hsearch.h:113
#define lfirst(lc)
Definition: pg_list.h:172

References add_placeholder_variable(), Assert(), ereport, errcode(), errdetail(), errmsg(), guc_hashtab, guc_name_compare(), GUC_QUALIFIER_SEPARATOR, GUCHashEntry::gucvar, HASH_FIND, hash_search(), i, lfirst, map_old_guc_names, name, reserved_class_prefix, and valid_custom_variable_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 5157 of file guc.c.

5158 {
5159  struct config_generic **result;
5160  dlist_iter iter;
5161 
5162  *num = 0;
5163 
5164  /*
5165  * While only a fraction of all the GUC variables are marked GUC_EXPLAIN,
5166  * it doesn't seem worth dynamically resizing this array.
5167  */
5168  result = palloc(sizeof(struct config_generic *) * hash_get_num_entries(guc_hashtab));
5169 
5170  /* We need only consider GUCs with source not PGC_S_DEFAULT */
5172  {
5173  struct config_generic *conf = dlist_container(struct config_generic,
5174  nondef_link, iter.cur);
5175  bool modified;
5176 
5177  /* return only parameters marked for inclusion in explain */
5178  if (!(conf->flags & GUC_EXPLAIN))
5179  continue;
5180 
5181  /* return only options visible to the current user */
5182  if (!ConfigOptionIsVisible(conf))
5183  continue;
5184 
5185  /* return only options that are different from their boot values */
5186  modified = false;
5187 
5188  switch (conf->vartype)
5189  {
5190  case PGC_BOOL:
5191  {
5192  struct config_bool *lconf = (struct config_bool *) conf;
5193 
5194  modified = (lconf->boot_val != *(lconf->variable));
5195  }
5196  break;
5197 
5198  case PGC_INT:
5199  {
5200  struct config_int *lconf = (struct config_int *) conf;
5201 
5202  modified = (lconf->boot_val != *(lconf->variable));
5203  }
5204  break;
5205 
5206  case PGC_REAL:
5207  {
5208  struct config_real *lconf = (struct config_real *) conf;
5209 
5210  modified = (lconf->boot_val != *(lconf->variable));
5211  }
5212  break;
5213 
5214  case PGC_STRING:
5215  {
5216  struct config_string *lconf = (struct config_string *) conf;
5217 
5218  modified = (strcmp(lconf->boot_val, *(lconf->variable)) != 0);
5219  }
5220  break;
5221 
5222  case PGC_ENUM:
5223  {
5224  struct config_enum *lconf = (struct config_enum *) conf;
5225 
5226  modified = (lconf->boot_val != *(lconf->variable));
5227  }
5228  break;
5229 
5230  default:
5231  elog(ERROR, "unexpected GUC type: %d", conf->vartype);
5232  }
5233 
5234  if (!modified)
5235  continue;
5236 
5237  /* OK, report it */
5238  result[*num] = conf;
5239  *num = *num + 1;
5240  }
5241 
5242  return result;
5243 }
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:261
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:247
const char * boot_val
Definition: guc_tables.h:248
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 865 of file guc.c.

866 {
867  struct config_generic **result;
869  GUCHashEntry *hentry;
870  int i;
871 
872  *num_vars = hash_get_num_entries(guc_hashtab);
873  result = palloc(sizeof(struct config_generic *) * *num_vars);
874 
875  /* Extract pointers from the hash table */
876  i = 0;
878  while ((hentry = (GUCHashEntry *) hash_seq_search(&status)) != NULL)
879  result[i++] = hentry->gucvar;
880  Assert(i == *num_vars);
881 
882  /* Sort by name */
883  qsort(result, *num_vars,
884  sizeof(struct config_generic *), guc_var_compare);
885 
886  return result;
887 }
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:1253
#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 5284 of file guc.c.

5285 {
5286  char buffer[256];
5287  const char *val;
5288 
5289  switch (record->vartype)
5290  {
5291  case PGC_BOOL:
5292  {
5293  struct config_bool *conf = (struct config_bool *) record;
5294 
5295  if (conf->show_hook)
5296  val = conf->show_hook();
5297  else
5298  val = *conf->variable ? "on" : "off";
5299  }
5300  break;
5301 
5302  case PGC_INT:
5303  {
5304  struct config_int *conf = (struct config_int *) record;
5305 
5306  if (conf->show_hook)
5307  val = conf->show_hook();
5308  else
5309  {
5310  /*
5311  * Use int64 arithmetic to avoid overflows in units
5312  * conversion.
5313  */
5314  int64 result = *conf->variable;
5315  const char *unit;
5316 
5317  if (use_units && result > 0 && (record->flags & GUC_UNIT))
5319  record->flags & GUC_UNIT,
5320  &result, &unit);
5321  else
5322  unit = "";
5323 
5324  snprintf(buffer, sizeof(buffer), INT64_FORMAT "%s",
5325  result, unit);
5326  val = buffer;
5327  }
5328  }
5329  break;
5330 
5331  case PGC_REAL:
5332  {
5333  struct config_real *conf = (struct config_real *) record;
5334 
5335  if (conf->show_hook)
5336  val = conf->show_hook();
5337  else
5338  {
5339  double result = *conf->variable;
5340  const char *unit;
5341 
5342  if (use_units && result > 0 && (record->flags & GUC_UNIT))
5344  record->flags & GUC_UNIT,
5345  &result, &unit);
5346  else
5347  unit = "";
5348 
5349  snprintf(buffer, sizeof(buffer), "%g%s",
5350  result, unit);
5351  val = buffer;
5352  }
5353  }
5354  break;
5355 
5356  case PGC_STRING:
5357  {
5358  struct config_string *conf = (struct config_string *) record;
5359 
5360  if (conf->show_hook)
5361  val = conf->show_hook();
5362  else if (*conf->variable && **conf->variable)
5363  val = *conf->variable;
5364  else
5365  val = "";
5366  }
5367  break;
5368 
5369  case PGC_ENUM:
5370  {
5371  struct config_enum *conf = (struct config_enum *) record;
5372 
5373  if (conf->show_hook)
5374  val = conf->show_hook();
5375  else
5376  val = config_enum_lookup_by_value(conf, *conf->variable);
5377  }
5378  break;
5379 
5380  default:
5381  /* just to keep compiler quiet */
5382  val = "???";
5383  break;
5384  }
5385 
5386  return pstrdup(val);
5387 }
#define INT64_FORMAT
Definition: c.h:532
const char * config_enum_lookup_by_value(struct config_enum *record, int val)
Definition: guc.c:2976
static void convert_int_from_base_unit(int64 base_value, int base_unit, int64 *value, const char **unit)
Definition: guc.c:2682
static void convert_real_from_base_unit(double base_value, int base_unit, double *value, const char **unit)
Definition: guc.c:2724
#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:266
GucShowHook show_hook
Definition: guc_tables.h:221
GucShowHook show_hook
Definition: guc_tables.h:237
GucShowHook show_hook
Definition: guc_tables.h:251

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

Referenced by GetConfigOptionValues().

◆ config_type_names

PGDLLIMPORT const char* const config_type_names[]
extern

Definition at line 766 of file guc_tables.c.

Referenced by GetConfigOptionValues().

◆ ConfigureNamesBool

PGDLLIMPORT struct config_bool ConfigureNamesBool[]
extern

Definition at line 775 of file guc_tables.c.

Referenced by build_guc_variables().

◆ ConfigureNamesEnum

PGDLLIMPORT struct config_enum ConfigureNamesEnum[]
extern

Definition at line 775 of file guc_tables.c.

Referenced by build_guc_variables().

◆ ConfigureNamesInt

PGDLLIMPORT struct config_int ConfigureNamesInt[]
extern

Definition at line 775 of file guc_tables.c.

Referenced by build_guc_variables().

◆ ConfigureNamesReal

PGDLLIMPORT struct config_real ConfigureNamesReal[]
extern

Definition at line 775 of file guc_tables.c.

Referenced by build_guc_variables().

◆ ConfigureNamesString

PGDLLIMPORT struct config_string ConfigureNamesString[]
extern

Definition at line 775 of file guc_tables.c.

Referenced by build_guc_variables().

◆ GucContext_Names

PGDLLIMPORT const char* const GucContext_Names[]
extern

Definition at line 621 of file guc_tables.c.

Referenced by GetConfigOptionValues().

◆ GucSource_Names

PGDLLIMPORT const char* const GucSource_Names[]
extern

Definition at line 640 of file guc_tables.c.

Referenced by GetConfigOptionValues().