1 /*--------------------------------------------------------------------
4 * External declarations pertaining to backend/utils/misc/guc.c and
5 * backend/utils/misc/guc-file.l
7 * Copyright (c) 2000-2017, PostgreSQL Global Development Group
8 * Written by Peter Eisentraut <peter_e@gmx.net>.
10 * src/include/utils/guc.h
11 *--------------------------------------------------------------------
16 #include "nodes/parsenodes.h"
17 #include "tcop/dest.h"
18 #include "utils/array.h"
21 /* upper limit for GUC variables measured in kilobytes of memory */
22 /* note that various places assume the byte size fits in a "long" variable */
23 #if SIZEOF_SIZE_T > 4 && SIZEOF_LONG > 4
24 #define MAX_KILOBYTES INT_MAX
26 #define MAX_KILOBYTES (INT_MAX / 1024)
30 * Automatic configuration file name for ALTER SYSTEM.
31 * This file will be used to store values of configuration parameters
32 * set by ALTER SYSTEM command.
34 #define PG_AUTOCONF_FILENAME "postgresql.auto.conf"
37 * Certain options can only be set at certain times. The rules are
40 * INTERNAL options cannot be set by the user at all, but only through
41 * internal processes ("server_version" is an example). These are GUC
42 * variables only so they can be shown by SHOW, etc.
44 * POSTMASTER options can only be set when the postmaster starts,
45 * either from the configuration file or the command line.
47 * SIGHUP options can only be set at postmaster startup or by changing
48 * the configuration file and sending the HUP signal to the postmaster
49 * or a backend process. (Notice that the signal receipt will not be
50 * evaluated immediately. The postmaster and the backend check it at a
51 * certain point in their main loop. It's safer to wait than to read a
52 * file asynchronously.)
54 * BACKEND and SU_BACKEND options can only be set at postmaster startup,
55 * from the configuration file, or by client request in the connection
56 * startup packet (e.g., from libpq's PGOPTIONS variable). SU_BACKEND
57 * options can be set from the startup packet only when the user is a
58 * superuser. Furthermore, an already-started backend will ignore changes
59 * to such an option in the configuration file. The idea is that these
60 * options are fixed for a given backend once it's started, but they can
61 * vary across backends.
63 * SUSET options can be set at postmaster startup, with the SIGHUP
64 * mechanism, or from the startup packet or SQL if you're a superuser.
66 * USERSET options can be set by anyone any time.
80 * The following type records the source of the current setting. A
81 * new setting can only take effect if the previous setting had the
82 * same or lower level. (E.g, changing the config file doesn't
83 * override the postmaster command line.) Tracking the source allows us
84 * to process sources in any convenient order without affecting results.
85 * Sources <= PGC_S_OVERRIDE will set the default used by RESET, as well
86 * as the current value. Note that source == PGC_S_OVERRIDE should be
87 * used when setting a PGC_INTERNAL option.
89 * PGC_S_INTERACTIVE isn't actually a source value, but is the
90 * dividing line between "interactive" and "non-interactive" sources for
91 * error reporting purposes.
93 * PGC_S_TEST is used when testing values to be used later ("doit" will always
94 * be false, so this never gets stored as the actual source of any value).
95 * For example, ALTER DATABASE/ROLE tests proposed per-database or per-user
96 * defaults this way, and CREATE FUNCTION tests proposed function SET clauses
97 * this way. This is an interactive case, but it needs its own source value
98 * because some assign hooks need to make different validity checks in this
99 * case. In particular, references to nonexistent database objects generally
100 * shouldn't throw hard errors in this case, at most NOTICEs, since the
101 * objects might exist by the time the setting is used for real.
103 * NB: see GucSource_Names in guc.c if you change this.
107 PGC_S_DEFAULT, /* hard-wired default ("boot_val") */
108 PGC_S_DYNAMIC_DEFAULT, /* default computed during initialization */
109 PGC_S_ENV_VAR, /* postmaster environment variable */
110 PGC_S_FILE, /* postgresql.conf */
111 PGC_S_ARGV, /* postmaster command line */
112 PGC_S_GLOBAL, /* global in-database setting */
113 PGC_S_DATABASE, /* per-database setting */
114 PGC_S_USER, /* per-user setting */
115 PGC_S_DATABASE_USER, /* per-user-and-database setting */
116 PGC_S_CLIENT, /* from client connection request */
117 PGC_S_OVERRIDE, /* special case to forcibly set default */
118 PGC_S_INTERACTIVE, /* dividing line for error reporting */
119 PGC_S_TEST, /* test per-database or per-user setting */
120 PGC_S_SESSION /* SET command */
124 * Parsing the configuration file(s) will return a list of name-value pairs
125 * with source location info. We also abuse this data structure to carry
126 * error reports about the config files. An entry reporting an error will
127 * have errmsg != NULL, and might have NULLs for name, value, and/or filename.
129 * If "ignore" is true, don't attempt to apply the item (it might be an error
130 * report, or an item we determined to be duplicate). "applied" is set true
131 * if we successfully applied, or could have applied, the setting.
133 typedef struct ConfigVariable
142 struct ConfigVariable *next;
145 extern bool ParseConfigFile(const char *config_file, bool strict,
146 const char *calling_file, int calling_lineno,
147 int depth, int elevel,
148 ConfigVariable **head_p, ConfigVariable **tail_p);
149 extern bool ParseConfigFp(FILE *fp, const char *config_file,
150 int depth, int elevel,
151 ConfigVariable **head_p, ConfigVariable **tail_p);
152 extern bool ParseConfigDirectory(const char *includedir,
153 const char *calling_file, int calling_lineno,
154 int depth, int elevel,
155 ConfigVariable **head_p,
156 ConfigVariable **tail_p);
157 extern void FreeConfigVariables(ConfigVariable *list);
160 * The possible values of an enum variable are specified by an array of
161 * name-value pairs. The "hidden" flag means the value is accepted but
162 * won't be displayed when guc.c is asked for a list of acceptable values.
164 struct config_enum_entry
172 * Signatures for per-variable check/assign/show hook functions
174 typedef bool (*GucBoolCheckHook) (bool *newval, void **extra, GucSource source);
175 typedef bool (*GucIntCheckHook) (int *newval, void **extra, GucSource source);
176 typedef bool (*GucRealCheckHook) (double *newval, void **extra, GucSource source);
177 typedef bool (*GucStringCheckHook) (char **newval, void **extra, GucSource source);
178 typedef bool (*GucEnumCheckHook) (int *newval, void **extra, GucSource source);
180 typedef void (*GucBoolAssignHook) (bool newval, void *extra);
181 typedef void (*GucIntAssignHook) (int newval, void *extra);
182 typedef void (*GucRealAssignHook) (double newval, void *extra);
183 typedef void (*GucStringAssignHook) (const char *newval, void *extra);
184 typedef void (*GucEnumAssignHook) (int newval, void *extra);
186 typedef const char *(*GucShowHook) (void);
193 /* Types of set_config_option actions */
194 GUC_ACTION_SET, /* regular SET command */
195 GUC_ACTION_LOCAL, /* SET LOCAL command */
196 GUC_ACTION_SAVE /* function SET option, or temp assignment */
199 #define GUC_QUALIFIER_SEPARATOR '.'
202 * bit values in "flags" of a GUC variable
204 #define GUC_LIST_INPUT 0x0001 /* input can be list format */
205 #define GUC_LIST_QUOTE 0x0002 /* double-quote list elements */
206 #define GUC_NO_SHOW_ALL 0x0004 /* exclude from SHOW ALL */
207 #define GUC_NO_RESET_ALL 0x0008 /* exclude from RESET ALL */
208 #define GUC_REPORT 0x0010 /* auto-report changes to client */
209 #define GUC_NOT_IN_SAMPLE 0x0020 /* not in postgresql.conf.sample */
210 #define GUC_DISALLOW_IN_FILE 0x0040 /* can't set in postgresql.conf */
211 #define GUC_CUSTOM_PLACEHOLDER 0x0080 /* placeholder for custom variable */
212 #define GUC_SUPERUSER_ONLY 0x0100 /* show only to superusers */
213 #define GUC_IS_NAME 0x0200 /* limit string to NAMEDATALEN-1 */
214 #define GUC_NOT_WHILE_SEC_REST 0x0400 /* can't set if security restricted */
215 #define GUC_DISALLOW_IN_AUTO_FILE 0x0800 /* can't set in
216 * PG_AUTOCONF_FILENAME */
218 #define GUC_UNIT_KB 0x1000 /* value is in kilobytes */
219 #define GUC_UNIT_BLOCKS 0x2000 /* value is in blocks */
220 #define GUC_UNIT_XBLOCKS 0x3000 /* value is in xlog blocks */
221 #define GUC_UNIT_XSEGS 0x4000 /* value is in xlog segments */
222 #define GUC_UNIT_MEMORY 0xF000 /* mask for size-related units */
224 #define GUC_UNIT_MS 0x10000 /* value is in milliseconds */
225 #define GUC_UNIT_S 0x20000 /* value is in seconds */
226 #define GUC_UNIT_MIN 0x30000 /* value is in minutes */
227 #define GUC_UNIT_TIME 0xF0000 /* mask for time-related units */
229 #define GUC_UNIT (GUC_UNIT_MEMORY | GUC_UNIT_TIME)
232 /* GUC vars that are actually declared in guc.c, rather than elsewhere */
233 extern bool log_duration;
234 extern bool Debug_print_plan;
235 extern bool Debug_print_parse;
236 extern bool Debug_print_rewritten;
237 extern bool Debug_pretty_print;
239 extern bool log_parser_stats;
240 extern bool log_planner_stats;
241 extern bool log_executor_stats;
242 extern bool log_statement_stats;
243 extern bool log_btree_build_stats;
245 extern PGDLLIMPORT bool check_function_bodies;
246 extern bool default_with_oids;
248 extern int log_min_error_statement;
249 extern int log_min_messages;
250 extern int client_min_messages;
251 extern int log_min_duration_statement;
252 extern int log_temp_files;
254 extern int temp_file_limit;
256 extern int num_temp_buffers;
258 extern char *cluster_name;
259 extern char *ConfigFileName;
260 extern char *HbaFileName;
261 extern char *IdentFileName;
262 extern char *external_pid_file;
264 extern char *application_name;
266 extern int tcp_keepalives_idle;
267 extern int tcp_keepalives_interval;
268 extern int tcp_keepalives_count;
271 extern bool trace_sort;
275 * Functions exported by guc.c
277 extern void SetConfigOption(const char *name, const char *value,
278 GucContext context, GucSource source);
280 extern void DefineCustomBoolVariable(
282 const char *short_desc,
283 const char *long_desc,
288 GucBoolCheckHook check_hook,
289 GucBoolAssignHook assign_hook,
290 GucShowHook show_hook);
292 extern void DefineCustomIntVariable(
294 const char *short_desc,
295 const char *long_desc,
302 GucIntCheckHook check_hook,
303 GucIntAssignHook assign_hook,
304 GucShowHook show_hook);
306 extern void DefineCustomRealVariable(
308 const char *short_desc,
309 const char *long_desc,
316 GucRealCheckHook check_hook,
317 GucRealAssignHook assign_hook,
318 GucShowHook show_hook);
320 extern void DefineCustomStringVariable(
322 const char *short_desc,
323 const char *long_desc,
325 const char *bootValue,
328 GucStringCheckHook check_hook,
329 GucStringAssignHook assign_hook,
330 GucShowHook show_hook);
332 extern void DefineCustomEnumVariable(
334 const char *short_desc,
335 const char *long_desc,
338 const struct config_enum_entry * options,
341 GucEnumCheckHook check_hook,
342 GucEnumAssignHook assign_hook,
343 GucShowHook show_hook);
345 extern void EmitWarningsOnPlaceholders(const char *className);
347 extern const char *GetConfigOption(const char *name, bool missing_ok,
348 bool restrict_superuser);
349 extern const char *GetConfigOptionResetString(const char *name);
350 extern void ProcessConfigFile(GucContext context);
351 extern void InitializeGUCOptions(void);
352 extern bool SelectConfigFiles(const char *userDoption, const char *progname);
353 extern void ResetAllOptions(void);
354 extern void AtStart_GUC(void);
355 extern int NewGUCNestLevel(void);
356 extern void AtEOXact_GUC(bool isCommit, int nestLevel);
357 extern void BeginReportingGUCOptions(void);
358 extern void ParseLongOption(const char *string, char **name, char **value);
359 extern bool parse_int(const char *value, int *result, int flags,
360 const char **hintmsg);
361 extern bool parse_real(const char *value, double *result);
362 extern int set_config_option(const char *name, const char *value,
363 GucContext context, GucSource source,
364 GucAction action, bool changeVal, int elevel,
366 extern void AlterSystemSetConfigFile(AlterSystemStmt *setstmt);
367 extern char *GetConfigOptionByName(const char *name, const char **varname,
369 extern void GetConfigOptionByNum(int varnum, const char **values, bool *noshow);
370 extern int GetNumConfigOptions(void);
372 extern void SetPGVariable(const char *name, List *args, bool is_local);
373 extern void GetPGVariable(const char *name, DestReceiver *dest);
374 extern TupleDesc GetPGVariableResultDesc(const char *name);
376 extern void ExecSetVariableStmt(VariableSetStmt *stmt, bool isTopLevel);
377 extern char *ExtractSetVariableArgs(VariableSetStmt *stmt);
379 extern void ProcessGUCArray(ArrayType *array,
380 GucContext context, GucSource source, GucAction action);
381 extern ArrayType *GUCArrayAdd(ArrayType *array, const char *name, const char *value);
382 extern ArrayType *GUCArrayDelete(ArrayType *array, const char *name);
383 extern ArrayType *GUCArrayReset(ArrayType *array);
386 extern void write_nondefault_variables(GucContext context);
387 extern void read_nondefault_variables(void);
390 /* GUC serialization */
391 extern Size EstimateGUCStateSpace(void);
392 extern void SerializeGUCState(Size maxsize, char *start_address);
393 extern void RestoreGUCState(void *gucstate);
395 /* Support for messages reported from GUC check hooks */
397 extern PGDLLIMPORT char *GUC_check_errmsg_string;
398 extern PGDLLIMPORT char *GUC_check_errdetail_string;
399 extern PGDLLIMPORT char *GUC_check_errhint_string;
401 extern void GUC_check_errcode(int sqlerrcode);
403 #define GUC_check_errmsg \
404 pre_format_elog_string(errno, TEXTDOMAIN), \
405 GUC_check_errmsg_string = format_elog_string
407 #define GUC_check_errdetail \
408 pre_format_elog_string(errno, TEXTDOMAIN), \
409 GUC_check_errdetail_string = format_elog_string
411 #define GUC_check_errhint \
412 pre_format_elog_string(errno, TEXTDOMAIN), \
413 GUC_check_errhint_string = format_elog_string
417 * The following functions are not in guc.c, but are declared here to avoid
418 * having to include guc.h in some widely used headers that it really doesn't
422 /* in commands/tablespace.c */
423 extern bool check_default_tablespace(char **newval, void **extra, GucSource source);
424 extern bool check_temp_tablespaces(char **newval, void **extra, GucSource source);
425 extern void assign_temp_tablespaces(const char *newval, void *extra);
427 /* in catalog/namespace.c */
428 extern bool check_search_path(char **newval, void **extra, GucSource source);
429 extern void assign_search_path(const char *newval, void *extra);
431 /* in access/transam/xlog.c */
432 extern bool check_wal_buffers(int *newval, void **extra, GucSource source);
433 extern void assign_xlog_sync_method(int new_sync_method, void *extra);