PostgreSQL Source Code  git master
 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros
guc_tables.h
Go to the documentation of this file.
1 /*-------------------------------------------------------------------------
2  *
3  * guc_tables.h
4  * Declarations of tables used by GUC.
5  *
6  * See src/backend/utils/misc/README for design notes.
7  *
8  * Portions Copyright (c) 1996-2017, PostgreSQL Global Development Group
9  *
10  * src/include/utils/guc_tables.h
11  *
12  *-------------------------------------------------------------------------
13  */
14 #ifndef GUC_TABLES_H
15 #define GUC_TABLES_H 1
16 
17 #include "utils/guc.h"
18 
19 /*
20  * GUC supports these types of variables:
21  */
23 {
29 };
30 
32 {
33  bool boolval;
34  int intval;
35  double realval;
36  char *stringval;
37  int enumval;
38 };
39 
40 /*
41  * The actual value of a GUC variable can include a malloc'd opaque struct
42  * "extra", which is created by its check_hook and used by its assign_hook.
43  */
44 typedef struct config_var_value
45 {
47  void *extra;
49 
50 /*
51  * Groupings to help organize all the run-time options for display
52  */
54 {
67  WAL,
102 };
103 
104 /*
105  * Stack entry for saving the state a variable had prior to an uncommitted
106  * transactional change
107  */
108 typedef enum
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;
116 
117 typedef struct guc_stack
118 {
119  struct guc_stack *prev; /* previous stack item, if any */
120  int nest_level; /* nesting depth at which we made entry */
121  GucStackState state; /* see enum above */
122  GucSource source; /* source of the prior value */
123  /* masked value's source must be PGC_S_SESSION, so no need to store it */
124  GucContext scontext; /* context that set the prior value */
125  GucContext masked_scontext; /* context that set the masked value */
126  config_var_value prior; /* previous value of variable */
127  config_var_value masked; /* SET value in a GUC_SET_LOCAL entry */
128 } GucStack;
129 
130 /*
131  * Generic fields applicable to all types of variables
132  *
133  * The short description should be less than 80 chars in length. Some
134  * applications may use the long description as well, and will append
135  * it to the short description. (separated by a newline or '. ')
136  *
137  * Note that sourcefile/sourceline are kept here, and not pushed into stacked
138  * values, although in principle they belong with some stacked value if the
139  * active value is session- or transaction-local. This is to avoid bloating
140  * stack entries. We know they are only relevant when source == PGC_S_FILE.
141  */
143 {
144  /* constant fields, must be set correctly in initial value: */
145  const char *name; /* name of variable - MUST BE FIRST */
146  GucContext context; /* context required to set the variable */
147  enum config_group group; /* to help organize variables by function */
148  const char *short_desc; /* short desc. of this variable's purpose */
149  const char *long_desc; /* long desc. of this variable's purpose */
150  int flags; /* flag bits, see guc.h */
151  /* variable fields, initialized at runtime: */
152  enum config_type vartype; /* type of variable (set only at startup) */
153  int status; /* status bits, see below */
154  GucSource source; /* source of the current actual value */
155  GucSource reset_source; /* source of the reset_value */
156  GucContext scontext; /* context that set the current value */
157  GucContext reset_scontext; /* context that set the reset value */
158  GucStack *stack; /* stacked prior values */
159  void *extra; /* "extra" pointer for current actual value */
160  char *sourcefile; /* file current setting is from (NULL if not
161  * set in config file) */
162  int sourceline; /* line in source file */
163 };
164 
165 /* bit values in status field */
166 #define GUC_IS_IN_FILE 0x0001 /* found it in config file */
167 /*
168  * Caution: the GUC_IS_IN_FILE bit is transient state for ProcessConfigFile.
169  * Do not assume that its value represents useful information elsewhere.
170  */
171 #define GUC_PENDING_RESTART 0x0002
172 
173 
174 /* GUC records for specific variable types */
175 
177 {
179  /* constant fields, must be set correctly in initial value: */
180  bool *variable;
181  bool boot_val;
185  /* variable fields, initialized at runtime: */
186  bool reset_val;
187  void *reset_extra;
188 };
189 
191 {
193  /* constant fields, must be set correctly in initial value: */
194  int *variable;
195  int boot_val;
196  int min;
197  int max;
201  /* variable fields, initialized at runtime: */
203  void *reset_extra;
204 };
205 
207 {
209  /* constant fields, must be set correctly in initial value: */
210  double *variable;
211  double boot_val;
212  double min;
213  double max;
217  /* variable fields, initialized at runtime: */
218  double reset_val;
219  void *reset_extra;
220 };
221 
223 {
225  /* constant fields, must be set correctly in initial value: */
226  char **variable;
227  const char *boot_val;
231  /* variable fields, initialized at runtime: */
232  char *reset_val;
233  void *reset_extra;
234 };
235 
237 {
239  /* constant fields, must be set correctly in initial value: */
240  int *variable;
241  int boot_val;
242  const struct config_enum_entry *options;
246  /* variable fields, initialized at runtime: */
248  void *reset_extra;
249 };
250 
251 /* constant tables corresponding to enums above and in guc.h */
252 extern const char *const config_group_names[];
253 extern const char *const config_type_names[];
254 extern const char *const GucContext_Names[];
255 extern const char *const GucSource_Names[];
256 
257 /* get the current set of variables */
258 extern struct config_generic **get_guc_variables(void);
259 
260 extern void build_guc_variables(void);
261 
262 /* search in enum options */
263 extern const char *config_enum_lookup_by_value(struct config_enum * record, int val);
264 extern bool config_enum_lookup_by_name(struct config_enum * record,
265  const char *value, int *retval);
266 
267 #endif /* GUC_TABLES_H */
struct guc_stack * prev
Definition: guc_tables.h:119
GucSource source
Definition: guc_tables.h:154
GucEnumCheckHook check_hook
Definition: guc_tables.h:243
void(* GucRealAssignHook)(double newval, void *extra)
Definition: guc.h:182
void * reset_extra
Definition: guc_tables.h:203
GucContext
Definition: guc.h:68
static struct @76 value
union config_var_val val
Definition: guc_tables.h:46
config_group
Definition: guc_tables.h:53
const char * config_enum_lookup_by_value(struct config_enum *record, int val)
Definition: guc.c:5578
int nest_level
Definition: guc_tables.h:120
const char * long_desc
Definition: guc_tables.h:149
const char *const config_type_names[]
Definition: guc.c:674
GucRealAssignHook assign_hook
Definition: guc_tables.h:215
double reset_val
Definition: guc_tables.h:218
void(* GucStringAssignHook)(const char *newval, void *extra)
Definition: guc.h:183
Definition: guc.h:164
void(* GucBoolAssignHook)(bool newval, void *extra)
Definition: guc.h:180
char ** variable
Definition: guc_tables.h:226
const char * name
Definition: guc_tables.h:145
bool * variable
Definition: guc_tables.h:180
const char * short_desc
Definition: guc_tables.h:148
int boot_val
Definition: guc_tables.h:195
GucStringCheckHook check_hook
Definition: guc_tables.h:228
const char * boot_val
Definition: guc_tables.h:227
GucEnumAssignHook assign_hook
Definition: guc_tables.h:244
GucBoolAssignHook assign_hook
Definition: guc_tables.h:183
config_var_value masked
Definition: guc_tables.h:127
bool(* GucStringCheckHook)(char **newval, void **extra, GucSource source)
Definition: guc.h:177
void build_guc_variables(void)
Definition: guc.c:4160
GucRealCheckHook check_hook
Definition: guc_tables.h:214
bool(* GucEnumCheckHook)(int *newval, void **extra, GucSource source)
Definition: guc.h:178
GucContext scontext
Definition: guc_tables.h:156
struct config_var_value config_var_value
GucIntAssignHook assign_hook
Definition: guc_tables.h:199
GucIntCheckHook check_hook
Definition: guc_tables.h:198
GucStackState
Definition: guc_tables.h:108
GucSource
Definition: guc.h:105
Definition: guc_tables.h:67
GucShowHook show_hook
Definition: guc_tables.h:200
int * variable
Definition: guc_tables.h:194
int * variable
Definition: guc_tables.h:240
void * reset_extra
Definition: guc_tables.h:248
char * sourcefile
Definition: guc_tables.h:160
bool boot_val
Definition: guc_tables.h:181
const struct config_enum_entry * options
Definition: guc_tables.h:242
bool config_enum_lookup_by_name(struct config_enum *record, const char *value, int *retval)
Definition: guc.c:5601
GucSource source
Definition: guc_tables.h:122
GucShowHook show_hook
Definition: guc_tables.h:230
GucSource reset_source
Definition: guc_tables.h:155
struct config_generic gen
Definition: guc_tables.h:178
struct config_generic gen
Definition: guc_tables.h:192
GucContext masked_scontext
Definition: guc_tables.h:125
GucShowHook show_hook
Definition: guc_tables.h:216
double * variable
Definition: guc_tables.h:210
const char *const config_group_names[]
Definition: guc.c:569
const char *const GucContext_Names[]
Definition: guc.c:532
bool(* GucIntCheckHook)(int *newval, void **extra, GucSource source)
Definition: guc.h:175
enum config_type vartype
Definition: guc_tables.h:152
void * reset_extra
Definition: guc_tables.h:219
GucShowHook show_hook
Definition: guc_tables.h:245
GucContext scontext
Definition: guc_tables.h:124
config_type
Definition: guc_tables.h:22
struct config_generic gen
Definition: guc_tables.h:238
double max
Definition: guc_tables.h:213
GucBoolCheckHook check_hook
Definition: guc_tables.h:182
struct guc_stack GucStack
GucShowHook show_hook
Definition: guc_tables.h:184
const char *const GucSource_Names[]
Definition: guc.c:548
struct config_generic gen
Definition: guc_tables.h:224
void(* GucIntAssignHook)(int newval, void *extra)
Definition: guc.h:181
struct config_generic ** get_guc_variables(void)
Definition: guc.c:4148
char * reset_val
Definition: guc_tables.h:232
GucStackState state
Definition: guc_tables.h:121
GucStringAssignHook assign_hook
Definition: guc_tables.h:229
double boot_val
Definition: guc_tables.h:211
bool(* GucRealCheckHook)(double *newval, void **extra, GucSource source)
Definition: guc.h:176
double min
Definition: guc_tables.h:212
void * reset_extra
Definition: guc_tables.h:233
const char *(* GucShowHook)(void)
Definition: guc.h:186
void * reset_extra
Definition: guc_tables.h:187
char * stringval
Definition: guc_tables.h:36
GucStack * stack
Definition: guc_tables.h:158
enum config_group group
Definition: guc_tables.h:147
void(* GucEnumAssignHook)(int newval, void *extra)
Definition: guc.h:184
double realval
Definition: guc_tables.h:35
bool reset_val
Definition: guc_tables.h:186
long val
Definition: informix.c:689
config_var_value prior
Definition: guc_tables.h:126
GucContext context
Definition: guc_tables.h:146
bool(* GucBoolCheckHook)(bool *newval, void **extra, GucSource source)
Definition: guc.h:174
struct config_generic gen
Definition: guc_tables.h:208
GucContext reset_scontext
Definition: guc_tables.h:157
int reset_val
Definition: guc_tables.h:202