granicus.if.org Git - postgresql/blob - src/include/utils/guc_tables.h

   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-2012, 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  */
  22 enum config_type
  23 {
  24         PGC_BOOL,
  25         PGC_INT,
  26         PGC_REAL,
  27         PGC_STRING,
  28         PGC_ENUM
  29 };
  30
  31 union config_var_val
  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 {
  46         union config_var_val val;
  47         void       *extra;
  48 } config_var_value;
  49
  50 /*
  51  * Groupings to help organize all the run-time options for display
  52  */
  53 enum config_group
  54 {
  55         UNGROUPED,
  56         FILE_LOCATIONS,
  57         CONN_AUTH,
  58         CONN_AUTH_SETTINGS,
  59         CONN_AUTH_SECURITY,
  60         RESOURCES,
  61         RESOURCES_MEM,
  62         RESOURCES_DISK,
  63         RESOURCES_KERNEL,
  64         RESOURCES_VACUUM_DELAY,
  65         RESOURCES_BGWRITER,
  66         RESOURCES_ASYNCHRONOUS,
  67         WAL,
  68         WAL_SETTINGS,
  69         WAL_CHECKPOINTS,
  70         WAL_ARCHIVING,
  71         REPLICATION,
  72         REPLICATION_SENDING,
  73         REPLICATION_MASTER,
  74         REPLICATION_STANDBY,
  75         QUERY_TUNING,
  76         QUERY_TUNING_METHOD,
  77         QUERY_TUNING_COST,
  78         QUERY_TUNING_GEQO,
  79         QUERY_TUNING_OTHER,
  80         LOGGING,
  81         LOGGING_WHERE,
  82         LOGGING_WHEN,
  83         LOGGING_WHAT,
  84         STATS,
  85         STATS_MONITORING,
  86         STATS_COLLECTOR,
  87         AUTOVACUUM,
  88         CLIENT_CONN,
  89         CLIENT_CONN_STATEMENT,
  90         CLIENT_CONN_LOCALE,
  91         CLIENT_CONN_OTHER,
  92         LOCK_MANAGEMENT,
  93         COMPAT_OPTIONS,
  94         COMPAT_OPTIONS_PREVIOUS,
  95         COMPAT_OPTIONS_CLIENT,
  96         ERROR_HANDLING_OPTIONS,
  97         PRESET_OPTIONS,
  98         CUSTOM_OPTIONS,
  99         DEVELOPER_OPTIONS
 100 };
 101
 102 /*
 103  * Stack entry for saving the state a variable had prior to an uncommitted
 104  * transactional change
 105  */
 106 typedef enum
 107 {
 108         /* This is almost GucAction, but we need a fourth state for SET+LOCAL */
 109         GUC_SAVE,                                       /* entry caused by function SET option */
 110         GUC_SET,                                        /* entry caused by plain SET command */
 111         GUC_LOCAL,                                      /* entry caused by SET LOCAL command */
 112         GUC_SET_LOCAL                           /* entry caused by SET then SET LOCAL */
 113 } GucStackState;
 114
 115 typedef struct guc_stack
 116 {
 117         struct guc_stack *prev;         /* previous stack item, if any */
 118         int                     nest_level;             /* nesting depth at which we made entry */
 119         GucStackState state;            /* see enum above */
 120         GucSource       source;                 /* source of the prior value */
 121         /* masked value's source must be PGC_S_SESSION, so no need to store it */
 122         GucContext      scontext;               /* context that set the prior value */
 123         GucContext      masked_scontext; /* context that set the masked value */
 124         config_var_value prior;         /* previous value of variable */
 125         config_var_value masked;        /* SET value in a GUC_SET_LOCAL entry */
 126 } GucStack;
 127
 128 /*
 129  * Generic fields applicable to all types of variables
 130  *
 131  * The short description should be less than 80 chars in length. Some
 132  * applications may use the long description as well, and will append
 133  * it to the short description. (separated by a newline or '. ')
 134  *
 135  * Note that sourcefile/sourceline are kept here, and not pushed into stacked
 136  * values, although in principle they belong with some stacked value if the
 137  * active value is session- or transaction-local.  This is to avoid bloating
 138  * stack entries.  We know they are only relevant when source == PGC_S_FILE.
 139  */
 140 struct config_generic
 141 {
 142         /* constant fields, must be set correctly in initial value: */
 143         const char *name;                       /* name of variable - MUST BE FIRST */
 144         GucContext      context;                /* context required to set the variable */
 145         enum config_group group;        /* to help organize variables by function */
 146         const char *short_desc;         /* short desc. of this variable's purpose */
 147         const char *long_desc;          /* long desc. of this variable's purpose */
 148         int                     flags;                  /* flag bits, see guc.h */
 149         /* variable fields, initialized at runtime: */
 150         enum config_type vartype;       /* type of variable (set only at startup) */
 151         int                     status;                 /* status bits, see below */
 152         GucSource       source;                 /* source of the current actual value */
 153         GucSource       reset_source;   /* source of the reset_value */
 154         GucContext      scontext;               /* context that set the current value */
 155         GucContext      reset_scontext; /* context that set the reset value */
 156         GucStack   *stack;                      /* stacked prior values */
 157         void       *extra;                      /* "extra" pointer for current actual value */
 158         char       *sourcefile;         /* file current setting is from (NULL if not
 159                                                                  * set in config file) */
 160         int                     sourceline;             /* line in source file */
 161 };
 162
 163 /* bit values in status field */
 164 #define GUC_IS_IN_FILE          0x0001          /* found it in config file */
 165 /*
 166  * Caution: the GUC_IS_IN_FILE bit is transient state for ProcessConfigFile.
 167  * Do not assume that its value represents useful information elsewhere.
 168  */
 169
 170
 171 /* GUC records for specific variable types */
 172
 173 struct config_bool
 174 {
 175         struct config_generic gen;
 176         /* constant fields, must be set correctly in initial value: */
 177         bool       *variable;
 178         bool            boot_val;
 179         GucBoolCheckHook check_hook;
 180         GucBoolAssignHook assign_hook;
 181         GucShowHook show_hook;
 182         /* variable fields, initialized at runtime: */
 183         bool            reset_val;
 184         void       *reset_extra;
 185 };
 186
 187 struct config_int
 188 {
 189         struct config_generic gen;
 190         /* constant fields, must be set correctly in initial value: */
 191         int                *variable;
 192         int                     boot_val;
 193         int                     min;
 194         int                     max;
 195         GucIntCheckHook check_hook;
 196         GucIntAssignHook assign_hook;
 197         GucShowHook show_hook;
 198         /* variable fields, initialized at runtime: */
 199         int                     reset_val;
 200         void       *reset_extra;
 201 };
 202
 203 struct config_real
 204 {
 205         struct config_generic gen;
 206         /* constant fields, must be set correctly in initial value: */
 207         double     *variable;
 208         double          boot_val;
 209         double          min;
 210         double          max;
 211         GucRealCheckHook check_hook;
 212         GucRealAssignHook assign_hook;
 213         GucShowHook show_hook;
 214         /* variable fields, initialized at runtime: */
 215         double          reset_val;
 216         void       *reset_extra;
 217 };
 218
 219 struct config_string
 220 {
 221         struct config_generic gen;
 222         /* constant fields, must be set correctly in initial value: */
 223         char      **variable;
 224         const char *boot_val;
 225         GucStringCheckHook check_hook;
 226         GucStringAssignHook assign_hook;
 227         GucShowHook show_hook;
 228         /* variable fields, initialized at runtime: */
 229         char       *reset_val;
 230         void       *reset_extra;
 231 };
 232
 233 struct config_enum
 234 {
 235         struct config_generic gen;
 236         /* constant fields, must be set correctly in initial value: */
 237         int                *variable;
 238         int                     boot_val;
 239         const struct config_enum_entry *options;
 240         GucEnumCheckHook check_hook;
 241         GucEnumAssignHook assign_hook;
 242         GucShowHook show_hook;
 243         /* variable fields, initialized at runtime: */
 244         int                     reset_val;
 245         void       *reset_extra;
 246 };
 247
 248 /* constant tables corresponding to enums above and in guc.h */
 249 extern const char *const config_group_names[];
 250 extern const char *const config_type_names[];
 251 extern const char *const GucContext_Names[];
 252 extern const char *const GucSource_Names[];
 253
 254 /* get the current set of variables */
 255 extern struct config_generic **get_guc_variables(void);
 256
 257 extern void build_guc_variables(void);
 258
 259 /* search in enum options */
 260 extern const char *config_enum_lookup_by_value(struct config_enum * record, int val);
 261 extern bool config_enum_lookup_by_name(struct config_enum * record,
 262                                                    const char *value, int *retval);
 263
 264
 265 #endif   /* GUC_TABLES_H */