1 /*--------------------------------------------------------------------
4 * Support for grand unified configuration scheme, including SET
5 * command, configuration file, and command line options.
6 * See src/backend/utils/misc/README for more information.
9 * Copyright (c) 2000-2012, PostgreSQL Global Development Group
10 * Written by Peter Eisentraut <peter_e@gmx.net>.
13 * src/backend/utils/misc/guc.c
15 *--------------------------------------------------------------------
29 #include "access/gin.h"
30 #include "access/transam.h"
31 #include "access/twophase.h"
32 #include "access/xact.h"
33 #include "catalog/namespace.h"
34 #include "commands/async.h"
35 #include "commands/prepare.h"
36 #include "commands/vacuum.h"
37 #include "commands/variable.h"
38 #include "commands/trigger.h"
40 #include "libpq/auth.h"
41 #include "libpq/be-fsstubs.h"
42 #include "libpq/libpq.h"
43 #include "libpq/pqformat.h"
44 #include "miscadmin.h"
45 #include "optimizer/cost.h"
46 #include "optimizer/geqo.h"
47 #include "optimizer/paths.h"
48 #include "optimizer/planmain.h"
49 #include "parser/parse_expr.h"
50 #include "parser/parse_type.h"
51 #include "parser/parser.h"
52 #include "parser/scansup.h"
54 #include "postmaster/autovacuum.h"
55 #include "postmaster/bgwriter.h"
56 #include "postmaster/postmaster.h"
57 #include "postmaster/syslogger.h"
58 #include "postmaster/walwriter.h"
59 #include "replication/syncrep.h"
60 #include "replication/walreceiver.h"
61 #include "replication/walsender.h"
62 #include "storage/bufmgr.h"
63 #include "storage/standby.h"
64 #include "storage/fd.h"
65 #include "storage/predicate.h"
66 #include "tcop/tcopprot.h"
67 #include "tsearch/ts_cache.h"
68 #include "utils/builtins.h"
69 #include "utils/bytea.h"
70 #include "utils/guc_tables.h"
71 #include "utils/memutils.h"
72 #include "utils/pg_locale.h"
73 #include "utils/plancache.h"
74 #include "utils/portal.h"
75 #include "utils/ps_status.h"
76 #include "utils/snapmgr.h"
77 #include "utils/tzparser.h"
78 #include "utils/xml.h"
81 #define PG_KRB_SRVTAB ""
84 #define PG_KRB_SRVNAM ""
87 #define CONFIG_FILENAME "postgresql.conf"
88 #define HBA_FILENAME "pg_hba.conf"
89 #define IDENT_FILENAME "pg_ident.conf"
92 #define CONFIG_EXEC_PARAMS "global/config_exec_params"
93 #define CONFIG_EXEC_PARAMS_NEW "global/config_exec_params.new"
96 /* upper limit for GUC variables measured in kilobytes of memory */
97 /* note that various places assume the byte size fits in a "long" variable */
98 #if SIZEOF_SIZE_T > 4 && SIZEOF_LONG > 4
99 #define MAX_KILOBYTES INT_MAX
101 #define MAX_KILOBYTES (INT_MAX / 1024)
105 * Note: MAX_BACKENDS is limited to 2^23-1 because inval.c stores the
106 * backend ID as a 3-byte signed integer. Even if that limitation were
107 * removed, we still could not exceed INT_MAX/4 because some places compute
108 * 4*MaxBackends without any overflow check. This is rechecked in
109 * check_maxconnections, since MaxBackends is computed as MaxConnections
110 * plus autovacuum_max_workers plus one (for the autovacuum launcher).
112 #define MAX_BACKENDS 0x7fffff
114 #define KB_PER_MB (1024)
115 #define KB_PER_GB (1024*1024)
117 #define MS_PER_S 1000
119 #define MS_PER_MIN (1000 * 60)
121 #define S_PER_H (60 * 60)
122 #define MS_PER_H (1000 * 60 * 60)
123 #define MIN_PER_D (60 * 24)
124 #define S_PER_D (60 * 60 * 24)
125 #define MS_PER_D (1000 * 60 * 60 * 24)
127 /* XXX these should appear in other modules' header files */
128 extern bool Log_disconnections;
129 extern int CommitDelay;
130 extern int CommitSiblings;
131 extern char *default_tablespace;
132 extern char *temp_tablespaces;
133 extern bool synchronize_seqscans;
134 extern int ssl_renegotiation_limit;
135 extern char *SSLCipherSuites;
138 extern bool trace_sort;
140 #ifdef TRACE_SYNCSCAN
141 extern bool trace_syncscan;
143 #ifdef DEBUG_BOUNDED_SORT
144 extern bool optimize_bounded_sort;
147 static int GUC_check_errcode_value;
149 /* global variables for check hook support */
150 char *GUC_check_errmsg_string;
151 char *GUC_check_errdetail_string;
152 char *GUC_check_errhint_string;
155 static void set_config_sourcefile(const char *name, char *sourcefile,
157 static bool call_bool_check_hook(struct config_bool * conf, bool *newval,
158 void **extra, GucSource source, int elevel);
159 static bool call_int_check_hook(struct config_int * conf, int *newval,
160 void **extra, GucSource source, int elevel);
161 static bool call_real_check_hook(struct config_real * conf, double *newval,
162 void **extra, GucSource source, int elevel);
163 static bool call_string_check_hook(struct config_string * conf, char **newval,
164 void **extra, GucSource source, int elevel);
165 static bool call_enum_check_hook(struct config_enum * conf, int *newval,
166 void **extra, GucSource source, int elevel);
168 static bool check_log_destination(char **newval, void **extra, GucSource source);
169 static void assign_log_destination(const char *newval, void *extra);
172 static int syslog_facility = LOG_LOCAL0;
174 static int syslog_facility = 0;
177 static void assign_syslog_facility(int newval, void *extra);
178 static void assign_syslog_ident(const char *newval, void *extra);
179 static void assign_session_replication_role(int newval, void *extra);
180 static bool check_temp_buffers(int *newval, void **extra, GucSource source);
181 static bool check_phony_autocommit(bool *newval, void **extra, GucSource source);
182 static bool check_debug_assertions(bool *newval, void **extra, GucSource source);
183 static bool check_bonjour(bool *newval, void **extra, GucSource source);
184 static bool check_ssl(bool *newval, void **extra, GucSource source);
185 static bool check_stage_log_stats(bool *newval, void **extra, GucSource source);
186 static bool check_log_stats(bool *newval, void **extra, GucSource source);
187 static bool check_canonical_path(char **newval, void **extra, GucSource source);
188 static bool check_timezone_abbreviations(char **newval, void **extra, GucSource source);
189 static void assign_timezone_abbreviations(const char *newval, void *extra);
190 static void pg_timezone_abbrev_initialize(void);
191 static const char *show_archive_command(void);
192 static void assign_tcp_keepalives_idle(int newval, void *extra);
193 static void assign_tcp_keepalives_interval(int newval, void *extra);
194 static void assign_tcp_keepalives_count(int newval, void *extra);
195 static const char *show_tcp_keepalives_idle(void);
196 static const char *show_tcp_keepalives_interval(void);
197 static const char *show_tcp_keepalives_count(void);
198 static bool check_maxconnections(int *newval, void **extra, GucSource source);
199 static void assign_maxconnections(int newval, void *extra);
200 static bool check_autovacuum_max_workers(int *newval, void **extra, GucSource source);
201 static void assign_autovacuum_max_workers(int newval, void *extra);
202 static bool check_effective_io_concurrency(int *newval, void **extra, GucSource source);
203 static void assign_effective_io_concurrency(int newval, void *extra);
204 static void assign_pgstat_temp_directory(const char *newval, void *extra);
205 static bool check_application_name(char **newval, void **extra, GucSource source);
206 static void assign_application_name(const char *newval, void *extra);
207 static const char *show_unix_socket_permissions(void);
208 static const char *show_log_file_mode(void);
210 static char *config_enum_get_options(struct config_enum * record,
211 const char *prefix, const char *suffix,
212 const char *separator);
216 * Options for enum values defined in this module.
218 * NOTE! Option values may not contain double quotes!
221 static const struct config_enum_entry bytea_output_options[] = {
222 {"escape", BYTEA_OUTPUT_ESCAPE, false},
223 {"hex", BYTEA_OUTPUT_HEX, false},
228 * We have different sets for client and server message level options because
229 * they sort slightly different (see "log" level)
231 static const struct config_enum_entry client_message_level_options[] = {
232 {"debug", DEBUG2, true},
233 {"debug5", DEBUG5, false},
234 {"debug4", DEBUG4, false},
235 {"debug3", DEBUG3, false},
236 {"debug2", DEBUG2, false},
237 {"debug1", DEBUG1, false},
239 {"info", INFO, true},
240 {"notice", NOTICE, false},
241 {"warning", WARNING, false},
242 {"error", ERROR, false},
243 {"fatal", FATAL, true},
244 {"panic", PANIC, true},
248 static const struct config_enum_entry server_message_level_options[] = {
249 {"debug", DEBUG2, true},
250 {"debug5", DEBUG5, false},
251 {"debug4", DEBUG4, false},
252 {"debug3", DEBUG3, false},
253 {"debug2", DEBUG2, false},
254 {"debug1", DEBUG1, false},
255 {"info", INFO, false},
256 {"notice", NOTICE, false},
257 {"warning", WARNING, false},
258 {"error", ERROR, false},
260 {"fatal", FATAL, false},
261 {"panic", PANIC, false},
265 static const struct config_enum_entry intervalstyle_options[] = {
266 {"postgres", INTSTYLE_POSTGRES, false},
267 {"postgres_verbose", INTSTYLE_POSTGRES_VERBOSE, false},
268 {"sql_standard", INTSTYLE_SQL_STANDARD, false},
269 {"iso_8601", INTSTYLE_ISO_8601, false},
273 static const struct config_enum_entry log_error_verbosity_options[] = {
274 {"terse", PGERROR_TERSE, false},
275 {"default", PGERROR_DEFAULT, false},
276 {"verbose", PGERROR_VERBOSE, false},
280 static const struct config_enum_entry log_statement_options[] = {
281 {"none", LOGSTMT_NONE, false},
282 {"ddl", LOGSTMT_DDL, false},
283 {"mod", LOGSTMT_MOD, false},
284 {"all", LOGSTMT_ALL, false},
288 static const struct config_enum_entry isolation_level_options[] = {
289 {"serializable", XACT_SERIALIZABLE, false},
290 {"repeatable read", XACT_REPEATABLE_READ, false},
291 {"read committed", XACT_READ_COMMITTED, false},
292 {"read uncommitted", XACT_READ_UNCOMMITTED, false},
296 static const struct config_enum_entry session_replication_role_options[] = {
297 {"origin", SESSION_REPLICATION_ROLE_ORIGIN, false},
298 {"replica", SESSION_REPLICATION_ROLE_REPLICA, false},
299 {"local", SESSION_REPLICATION_ROLE_LOCAL, false},
303 static const struct config_enum_entry syslog_facility_options[] = {
305 {"local0", LOG_LOCAL0, false},
306 {"local1", LOG_LOCAL1, false},
307 {"local2", LOG_LOCAL2, false},
308 {"local3", LOG_LOCAL3, false},
309 {"local4", LOG_LOCAL4, false},
310 {"local5", LOG_LOCAL5, false},
311 {"local6", LOG_LOCAL6, false},
312 {"local7", LOG_LOCAL7, false},
319 static const struct config_enum_entry track_function_options[] = {
320 {"none", TRACK_FUNC_OFF, false},
321 {"pl", TRACK_FUNC_PL, false},
322 {"all", TRACK_FUNC_ALL, false},
326 static const struct config_enum_entry xmlbinary_options[] = {
327 {"base64", XMLBINARY_BASE64, false},
328 {"hex", XMLBINARY_HEX, false},
332 static const struct config_enum_entry xmloption_options[] = {
333 {"content", XMLOPTION_CONTENT, false},
334 {"document", XMLOPTION_DOCUMENT, false},
339 * Although only "on", "off", and "safe_encoding" are documented, we
340 * accept all the likely variants of "on" and "off".
342 static const struct config_enum_entry backslash_quote_options[] = {
343 {"safe_encoding", BACKSLASH_QUOTE_SAFE_ENCODING, false},
344 {"on", BACKSLASH_QUOTE_ON, false},
345 {"off", BACKSLASH_QUOTE_OFF, false},
346 {"true", BACKSLASH_QUOTE_ON, true},
347 {"false", BACKSLASH_QUOTE_OFF, true},
348 {"yes", BACKSLASH_QUOTE_ON, true},
349 {"no", BACKSLASH_QUOTE_OFF, true},
350 {"1", BACKSLASH_QUOTE_ON, true},
351 {"0", BACKSLASH_QUOTE_OFF, true},
356 * Although only "on", "off", and "partition" are documented, we
357 * accept all the likely variants of "on" and "off".
359 static const struct config_enum_entry constraint_exclusion_options[] = {
360 {"partition", CONSTRAINT_EXCLUSION_PARTITION, false},
361 {"on", CONSTRAINT_EXCLUSION_ON, false},
362 {"off", CONSTRAINT_EXCLUSION_OFF, false},
363 {"true", CONSTRAINT_EXCLUSION_ON, true},
364 {"false", CONSTRAINT_EXCLUSION_OFF, true},
365 {"yes", CONSTRAINT_EXCLUSION_ON, true},
366 {"no", CONSTRAINT_EXCLUSION_OFF, true},
367 {"1", CONSTRAINT_EXCLUSION_ON, true},
368 {"0", CONSTRAINT_EXCLUSION_OFF, true},
373 * Although only "on", "off", "remote_write", and "local" are documented, we
374 * accept all the likely variants of "on" and "off".
376 static const struct config_enum_entry synchronous_commit_options[] = {
377 {"local", SYNCHRONOUS_COMMIT_LOCAL_FLUSH, false},
378 {"remote_write", SYNCHRONOUS_COMMIT_REMOTE_WRITE, false},
379 {"on", SYNCHRONOUS_COMMIT_ON, false},
380 {"off", SYNCHRONOUS_COMMIT_OFF, false},
381 {"true", SYNCHRONOUS_COMMIT_ON, true},
382 {"false", SYNCHRONOUS_COMMIT_OFF, true},
383 {"yes", SYNCHRONOUS_COMMIT_ON, true},
384 {"no", SYNCHRONOUS_COMMIT_OFF, true},
385 {"1", SYNCHRONOUS_COMMIT_ON, true},
386 {"0", SYNCHRONOUS_COMMIT_OFF, true},
391 * Options for enum values stored in other modules
393 extern const struct config_enum_entry wal_level_options[];
394 extern const struct config_enum_entry sync_method_options[];
397 * GUC option variables that are exported from this module
399 #ifdef USE_ASSERT_CHECKING
400 bool assert_enabled = true;
402 bool assert_enabled = false;
404 bool log_duration = false;
405 bool Debug_print_plan = false;
406 bool Debug_print_parse = false;
407 bool Debug_print_rewritten = false;
408 bool Debug_pretty_print = true;
410 bool log_parser_stats = false;
411 bool log_planner_stats = false;
412 bool log_executor_stats = false;
413 bool log_statement_stats = false; /* this is sort of all three
415 bool log_btree_build_stats = false;
418 bool check_function_bodies = true;
419 bool default_with_oids = false;
420 bool SQL_inheritance = true;
422 bool Password_encryption = true;
424 int log_min_error_statement = ERROR;
425 int log_min_messages = WARNING;
426 int client_min_messages = NOTICE;
427 int log_min_duration_statement = -1;
428 int log_temp_files = -1;
429 int trace_recovery_messages = LOG;
431 int temp_file_limit = -1;
433 int num_temp_buffers = 1024;
435 char *data_directory;
436 char *ConfigFileName;
439 char *external_pid_file;
441 char *pgstat_temp_directory;
443 char *application_name;
445 int tcp_keepalives_idle;
446 int tcp_keepalives_interval;
447 int tcp_keepalives_count;
450 * These variables are all dummies that don't do anything, except in some
451 * cases provide the value for SHOW to display. The real state is elsewhere
452 * and is kept in sync by assign_hooks.
454 static char *log_destination_string;
456 static char *syslog_ident_str;
457 static bool phony_autocommit;
458 static bool session_auth_is_superuser;
459 static double phony_random_seed;
460 static char *client_encoding_string;
461 static char *datestyle_string;
462 static char *locale_collate;
463 static char *locale_ctype;
464 static char *server_encoding_string;
465 static char *server_version_string;
466 static int server_version_num;
467 static char *timezone_string;
468 static char *log_timezone_string;
469 static char *timezone_abbreviations_string;
470 static char *XactIsoLevel_string;
471 static char *session_authorization_string;
472 static int max_function_args;
473 static int max_index_keys;
474 static int max_identifier_length;
475 static int block_size;
476 static int segment_size;
477 static int wal_block_size;
478 static int wal_segment_size;
479 static bool integer_datetimes;
480 static int effective_io_concurrency;
482 /* should be static, but commands/variable.c needs to get at this */
487 * Displayable names for context types (enum GucContext)
489 * Note: these strings are deliberately not localized.
491 const char *const GucContext_Names[] =
493 /* PGC_INTERNAL */ "internal",
494 /* PGC_POSTMASTER */ "postmaster",
495 /* PGC_SIGHUP */ "sighup",
496 /* PGC_BACKEND */ "backend",
497 /* PGC_SUSET */ "superuser",
498 /* PGC_USERSET */ "user"
502 * Displayable names for source types (enum GucSource)
504 * Note: these strings are deliberately not localized.
506 const char *const GucSource_Names[] =
508 /* PGC_S_DEFAULT */ "default",
509 /* PGC_S_DYNAMIC_DEFAULT */ "default",
510 /* PGC_S_ENV_VAR */ "environment variable",
511 /* PGC_S_FILE */ "configuration file",
512 /* PGC_S_ARGV */ "command line",
513 /* PGC_S_DATABASE */ "database",
514 /* PGC_S_USER */ "user",
515 /* PGC_S_DATABASE_USER */ "database user",
516 /* PGC_S_CLIENT */ "client",
517 /* PGC_S_OVERRIDE */ "override",
518 /* PGC_S_INTERACTIVE */ "interactive",
519 /* PGC_S_TEST */ "test",
520 /* PGC_S_SESSION */ "session"
524 * Displayable names for the groupings defined in enum config_group
526 const char *const config_group_names[] =
529 gettext_noop("Ungrouped"),
531 gettext_noop("File Locations"),
533 gettext_noop("Connections and Authentication"),
534 /* CONN_AUTH_SETTINGS */
535 gettext_noop("Connections and Authentication / Connection Settings"),
536 /* CONN_AUTH_SECURITY */
537 gettext_noop("Connections and Authentication / Security and Authentication"),
539 gettext_noop("Resource Usage"),
541 gettext_noop("Resource Usage / Memory"),
543 gettext_noop("Resource Usage / Disk"),
544 /* RESOURCES_KERNEL */
545 gettext_noop("Resource Usage / Kernel Resources"),
546 /* RESOURCES_VACUUM_DELAY */
547 gettext_noop("Resource Usage / Cost-Based Vacuum Delay"),
548 /* RESOURCES_BGWRITER */
549 gettext_noop("Resource Usage / Background Writer"),
550 /* RESOURCES_ASYNCHRONOUS */
551 gettext_noop("Resource Usage / Asynchronous Behavior"),
553 gettext_noop("Write-Ahead Log"),
555 gettext_noop("Write-Ahead Log / Settings"),
556 /* WAL_CHECKPOINTS */
557 gettext_noop("Write-Ahead Log / Checkpoints"),
559 gettext_noop("Write-Ahead Log / Archiving"),
561 gettext_noop("Replication"),
562 /* REPLICATION_SENDING */
563 gettext_noop("Replication / Sending Servers"),
564 /* REPLICATION_MASTER */
565 gettext_noop("Replication / Master Server"),
566 /* REPLICATION_STANDBY */
567 gettext_noop("Replication / Standby Servers"),
569 gettext_noop("Query Tuning"),
570 /* QUERY_TUNING_METHOD */
571 gettext_noop("Query Tuning / Planner Method Configuration"),
572 /* QUERY_TUNING_COST */
573 gettext_noop("Query Tuning / Planner Cost Constants"),
574 /* QUERY_TUNING_GEQO */
575 gettext_noop("Query Tuning / Genetic Query Optimizer"),
576 /* QUERY_TUNING_OTHER */
577 gettext_noop("Query Tuning / Other Planner Options"),
579 gettext_noop("Reporting and Logging"),
581 gettext_noop("Reporting and Logging / Where to Log"),
583 gettext_noop("Reporting and Logging / When to Log"),
585 gettext_noop("Reporting and Logging / What to Log"),
587 gettext_noop("Statistics"),
588 /* STATS_MONITORING */
589 gettext_noop("Statistics / Monitoring"),
590 /* STATS_COLLECTOR */
591 gettext_noop("Statistics / Query and Index Statistics Collector"),
593 gettext_noop("Autovacuum"),
595 gettext_noop("Client Connection Defaults"),
596 /* CLIENT_CONN_STATEMENT */
597 gettext_noop("Client Connection Defaults / Statement Behavior"),
598 /* CLIENT_CONN_LOCALE */
599 gettext_noop("Client Connection Defaults / Locale and Formatting"),
600 /* CLIENT_CONN_OTHER */
601 gettext_noop("Client Connection Defaults / Other Defaults"),
602 /* LOCK_MANAGEMENT */
603 gettext_noop("Lock Management"),
605 gettext_noop("Version and Platform Compatibility"),
606 /* COMPAT_OPTIONS_PREVIOUS */
607 gettext_noop("Version and Platform Compatibility / Previous PostgreSQL Versions"),
608 /* COMPAT_OPTIONS_CLIENT */
609 gettext_noop("Version and Platform Compatibility / Other Platforms and Clients"),
611 gettext_noop("Error Handling"),
613 gettext_noop("Preset Options"),
615 gettext_noop("Customized Options"),
616 /* DEVELOPER_OPTIONS */
617 gettext_noop("Developer Options"),
618 /* help_config wants this array to be null-terminated */
623 * Displayable names for GUC variable types (enum config_type)
625 * Note: these strings are deliberately not localized.
627 const char *const config_type_names[] =
629 /* PGC_BOOL */ "bool",
630 /* PGC_INT */ "integer",
631 /* PGC_REAL */ "real",
632 /* PGC_STRING */ "string",
633 /* PGC_ENUM */ "enum"
638 * Contents of GUC tables
640 * See src/backend/utils/misc/README for design notes.
644 * 1. Declare a global variable of type bool, int, double, or char*
645 * and make use of it.
647 * 2. Decide at what times it's safe to set the option. See guc.h for
650 * 3. Decide on a name, a default value, upper and lower bounds (if
653 * 4. Add a record below.
655 * 5. Add it to src/backend/utils/misc/postgresql.conf.sample, if
658 * 6. Don't forget to document the option (at least in config.sgml).
660 * 7. If it's a new GUC_LIST option you must edit pg_dumpall.c to ensure
661 * it is not single quoted at dump time.
665 /******** option records follow ********/
667 static struct config_bool ConfigureNamesBool[] =
670 {"enable_seqscan", PGC_USERSET, QUERY_TUNING_METHOD,
671 gettext_noop("Enables the planner's use of sequential-scan plans."),
679 {"enable_indexscan", PGC_USERSET, QUERY_TUNING_METHOD,
680 gettext_noop("Enables the planner's use of index-scan plans."),
688 {"enable_indexonlyscan", PGC_USERSET, QUERY_TUNING_METHOD,
689 gettext_noop("Enables the planner's use of index-only-scan plans."),
692 &enable_indexonlyscan,
697 {"enable_bitmapscan", PGC_USERSET, QUERY_TUNING_METHOD,
698 gettext_noop("Enables the planner's use of bitmap-scan plans."),
706 {"enable_tidscan", PGC_USERSET, QUERY_TUNING_METHOD,
707 gettext_noop("Enables the planner's use of TID scan plans."),
715 {"enable_sort", PGC_USERSET, QUERY_TUNING_METHOD,
716 gettext_noop("Enables the planner's use of explicit sort steps."),
724 {"enable_hashagg", PGC_USERSET, QUERY_TUNING_METHOD,
725 gettext_noop("Enables the planner's use of hashed aggregation plans."),
733 {"enable_material", PGC_USERSET, QUERY_TUNING_METHOD,
734 gettext_noop("Enables the planner's use of materialization."),
742 {"enable_nestloop", PGC_USERSET, QUERY_TUNING_METHOD,
743 gettext_noop("Enables the planner's use of nested-loop join plans."),
751 {"enable_mergejoin", PGC_USERSET, QUERY_TUNING_METHOD,
752 gettext_noop("Enables the planner's use of merge join plans."),
760 {"enable_hashjoin", PGC_USERSET, QUERY_TUNING_METHOD,
761 gettext_noop("Enables the planner's use of hash join plans."),
769 {"geqo", PGC_USERSET, QUERY_TUNING_GEQO,
770 gettext_noop("Enables genetic query optimization."),
771 gettext_noop("This algorithm attempts to do planning without "
772 "exhaustive searching.")
779 /* Not for general use --- used by SET SESSION AUTHORIZATION */
780 {"is_superuser", PGC_INTERNAL, UNGROUPED,
781 gettext_noop("Shows whether the current user is a superuser."),
783 GUC_REPORT | GUC_NO_SHOW_ALL | GUC_NO_RESET_ALL | GUC_NOT_IN_SAMPLE | GUC_DISALLOW_IN_FILE
785 &session_auth_is_superuser,
790 {"bonjour", PGC_POSTMASTER, CONN_AUTH_SETTINGS,
791 gettext_noop("Enables advertising the server via Bonjour."),
796 check_bonjour, NULL, NULL
799 {"ssl", PGC_POSTMASTER, CONN_AUTH_SECURITY,
800 gettext_noop("Enables SSL connections."),
805 check_ssl, NULL, NULL
808 {"fsync", PGC_SIGHUP, WAL_SETTINGS,
809 gettext_noop("Forces synchronization of updates to disk."),
810 gettext_noop("The server will use the fsync() system call in several places to make "
811 "sure that updates are physically written to disk. This insures "
812 "that a database cluster will recover to a consistent state after "
813 "an operating system or hardware crash.")
820 {"zero_damaged_pages", PGC_SUSET, DEVELOPER_OPTIONS,
821 gettext_noop("Continues processing past damaged page headers."),
822 gettext_noop("Detection of a damaged page header normally causes PostgreSQL to "
823 "report an error, aborting the current transaction. Setting "
824 "zero_damaged_pages to true causes the system to instead report a "
825 "warning, zero out the damaged page, and continue processing. This "
826 "behavior will destroy data, namely all the rows on the damaged page."),
834 {"full_page_writes", PGC_SIGHUP, WAL_SETTINGS,
835 gettext_noop("Writes full pages to WAL when first modified after a checkpoint."),
836 gettext_noop("A page write in process during an operating system crash might be "
837 "only partially written to disk. During recovery, the row changes "
838 "stored in WAL are not enough to recover. This option writes "
839 "pages when first modified after a checkpoint to WAL so full recovery "
847 {"log_checkpoints", PGC_SIGHUP, LOGGING_WHAT,
848 gettext_noop("Logs each checkpoint."),
856 {"log_connections", PGC_BACKEND, LOGGING_WHAT,
857 gettext_noop("Logs each successful connection."),
865 {"log_disconnections", PGC_BACKEND, LOGGING_WHAT,
866 gettext_noop("Logs end of a session, including duration."),
874 {"debug_assertions", PGC_USERSET, DEVELOPER_OPTIONS,
875 gettext_noop("Turns on various assertion checks."),
876 gettext_noop("This is a debugging aid."),
880 #ifdef USE_ASSERT_CHECKING
885 check_debug_assertions, NULL, NULL
889 {"exit_on_error", PGC_USERSET, ERROR_HANDLING_OPTIONS,
890 gettext_noop("Terminate session on any error."),
898 {"restart_after_crash", PGC_SIGHUP, ERROR_HANDLING_OPTIONS,
899 gettext_noop("Reinitialize server after backend crash."),
902 &restart_after_crash,
908 {"log_duration", PGC_SUSET, LOGGING_WHAT,
909 gettext_noop("Logs the duration of each completed SQL statement."),
917 {"debug_print_parse", PGC_USERSET, LOGGING_WHAT,
918 gettext_noop("Logs each query's parse tree."),
926 {"debug_print_rewritten", PGC_USERSET, LOGGING_WHAT,
927 gettext_noop("Logs each query's rewritten parse tree."),
930 &Debug_print_rewritten,
935 {"debug_print_plan", PGC_USERSET, LOGGING_WHAT,
936 gettext_noop("Logs each query's execution plan."),
944 {"debug_pretty_print", PGC_USERSET, LOGGING_WHAT,
945 gettext_noop("Indents parse and plan tree displays."),
953 {"log_parser_stats", PGC_SUSET, STATS_MONITORING,
954 gettext_noop("Writes parser performance statistics to the server log."),
959 check_stage_log_stats, NULL, NULL
962 {"log_planner_stats", PGC_SUSET, STATS_MONITORING,
963 gettext_noop("Writes planner performance statistics to the server log."),
968 check_stage_log_stats, NULL, NULL
971 {"log_executor_stats", PGC_SUSET, STATS_MONITORING,
972 gettext_noop("Writes executor performance statistics to the server log."),
977 check_stage_log_stats, NULL, NULL
980 {"log_statement_stats", PGC_SUSET, STATS_MONITORING,
981 gettext_noop("Writes cumulative performance statistics to the server log."),
984 &log_statement_stats,
986 check_log_stats, NULL, NULL
988 #ifdef BTREE_BUILD_STATS
990 {"log_btree_build_stats", PGC_SUSET, DEVELOPER_OPTIONS,
991 gettext_noop("No description available."),
995 &log_btree_build_stats,
1002 {"track_activities", PGC_SUSET, STATS_COLLECTOR,
1003 gettext_noop("Collects information about executing commands."),
1004 gettext_noop("Enables the collection of information on the currently "
1005 "executing command of each session, along with "
1006 "the time at which that command began execution.")
1008 &pgstat_track_activities,
1013 {"track_counts", PGC_SUSET, STATS_COLLECTOR,
1014 gettext_noop("Collects statistics on database activity."),
1017 &pgstat_track_counts,
1022 {"track_io_timing", PGC_SUSET, STATS_COLLECTOR,
1023 gettext_noop("Collects timing statistics for database I/O activity."),
1032 {"update_process_title", PGC_SUSET, STATS_COLLECTOR,
1033 gettext_noop("Updates the process title to show the active SQL command."),
1034 gettext_noop("Enables updating of the process title every time a new SQL command is received by the server.")
1036 &update_process_title,
1042 {"autovacuum", PGC_SIGHUP, AUTOVACUUM,
1043 gettext_noop("Starts the autovacuum subprocess."),
1046 &autovacuum_start_daemon,
1052 {"trace_notify", PGC_USERSET, DEVELOPER_OPTIONS,
1053 gettext_noop("Generates debugging output for LISTEN and NOTIFY."),
1064 {"trace_locks", PGC_SUSET, DEVELOPER_OPTIONS,
1065 gettext_noop("No description available."),
1074 {"trace_userlocks", PGC_SUSET, DEVELOPER_OPTIONS,
1075 gettext_noop("No description available."),
1084 {"trace_lwlocks", PGC_SUSET, DEVELOPER_OPTIONS,
1085 gettext_noop("No description available."),
1094 {"debug_deadlocks", PGC_SUSET, DEVELOPER_OPTIONS,
1095 gettext_noop("No description available."),
1106 {"log_lock_waits", PGC_SUSET, LOGGING_WHAT,
1107 gettext_noop("Logs long lock waits."),
1116 {"log_hostname", PGC_SIGHUP, LOGGING_WHAT,
1117 gettext_noop("Logs the host name in the connection logs."),
1118 gettext_noop("By default, connection logs only show the IP address "
1119 "of the connecting host. If you want them to show the host name you "
1120 "can turn this on, but depending on your host name resolution "
1121 "setup it might impose a non-negligible performance penalty.")
1128 {"sql_inheritance", PGC_USERSET, COMPAT_OPTIONS_PREVIOUS,
1129 gettext_noop("Causes subtables to be included by default in various commands."),
1137 {"password_encryption", PGC_USERSET, CONN_AUTH_SECURITY,
1138 gettext_noop("Encrypt passwords."),
1139 gettext_noop("When a password is specified in CREATE USER or "
1140 "ALTER USER without writing either ENCRYPTED or UNENCRYPTED, "
1141 "this parameter determines whether the password is to be encrypted.")
1143 &Password_encryption,
1148 {"transform_null_equals", PGC_USERSET, COMPAT_OPTIONS_CLIENT,
1149 gettext_noop("Treats \"expr=NULL\" as \"expr IS NULL\"."),
1150 gettext_noop("When turned on, expressions of the form expr = NULL "
1151 "(or NULL = expr) are treated as expr IS NULL, that is, they "
1152 "return true if expr evaluates to the null value, and false "
1153 "otherwise. The correct behavior of expr = NULL is to always "
1154 "return null (unknown).")
1156 &Transform_null_equals,
1161 {"db_user_namespace", PGC_SIGHUP, CONN_AUTH_SECURITY,
1162 gettext_noop("Enables per-database user names."),
1170 /* only here for backwards compatibility */
1171 {"autocommit", PGC_USERSET, CLIENT_CONN_STATEMENT,
1172 gettext_noop("This parameter doesn't do anything."),
1173 gettext_noop("It's just here so that we won't choke on SET AUTOCOMMIT TO ON from 7.3-vintage clients."),
1174 GUC_NO_SHOW_ALL | GUC_NOT_IN_SAMPLE
1178 check_phony_autocommit, NULL, NULL
1181 {"default_transaction_read_only", PGC_USERSET, CLIENT_CONN_STATEMENT,
1182 gettext_noop("Sets the default read-only status of new transactions."),
1185 &DefaultXactReadOnly,
1190 {"transaction_read_only", PGC_USERSET, CLIENT_CONN_STATEMENT,
1191 gettext_noop("Sets the current transaction's read-only status."),
1193 GUC_NO_RESET_ALL | GUC_NOT_IN_SAMPLE | GUC_DISALLOW_IN_FILE
1197 check_transaction_read_only, NULL, NULL
1200 {"default_transaction_deferrable", PGC_USERSET, CLIENT_CONN_STATEMENT,
1201 gettext_noop("Sets the default deferrable status of new transactions."),
1204 &DefaultXactDeferrable,
1209 {"transaction_deferrable", PGC_USERSET, CLIENT_CONN_STATEMENT,
1210 gettext_noop("Whether to defer a read-only serializable transaction until it can be executed with no possible serialization failures."),
1212 GUC_NO_RESET_ALL | GUC_NOT_IN_SAMPLE | GUC_DISALLOW_IN_FILE
1216 check_transaction_deferrable, NULL, NULL
1219 {"check_function_bodies", PGC_USERSET, CLIENT_CONN_STATEMENT,
1220 gettext_noop("Check function bodies during CREATE FUNCTION."),
1223 &check_function_bodies,
1228 {"array_nulls", PGC_USERSET, COMPAT_OPTIONS_PREVIOUS,
1229 gettext_noop("Enable input of NULL elements in arrays."),
1230 gettext_noop("When turned on, unquoted NULL in an array input "
1231 "value means a null value; "
1232 "otherwise it is taken literally.")
1239 {"default_with_oids", PGC_USERSET, COMPAT_OPTIONS_PREVIOUS,
1240 gettext_noop("Create new tables with OIDs by default."),
1248 {"logging_collector", PGC_POSTMASTER, LOGGING_WHERE,
1249 gettext_noop("Start a subprocess to capture stderr output and/or csvlogs into log files."),
1257 {"log_truncate_on_rotation", PGC_SIGHUP, LOGGING_WHERE,
1258 gettext_noop("Truncate existing log files of same name during log rotation."),
1261 &Log_truncate_on_rotation,
1268 {"trace_sort", PGC_USERSET, DEVELOPER_OPTIONS,
1269 gettext_noop("Emit information about resource usage in sorting."),
1279 #ifdef TRACE_SYNCSCAN
1280 /* this is undocumented because not exposed in a standard build */
1282 {"trace_syncscan", PGC_USERSET, DEVELOPER_OPTIONS,
1283 gettext_noop("Generate debugging output for synchronized scanning."),
1293 #ifdef DEBUG_BOUNDED_SORT
1294 /* this is undocumented because not exposed in a standard build */
1297 "optimize_bounded_sort", PGC_USERSET, QUERY_TUNING_METHOD,
1298 gettext_noop("Enable bounded sorting using heap sort."),
1302 &optimize_bounded_sort,
1310 {"wal_debug", PGC_SUSET, DEVELOPER_OPTIONS,
1311 gettext_noop("Emit WAL-related debugging output."),
1322 {"integer_datetimes", PGC_INTERNAL, PRESET_OPTIONS,
1323 gettext_noop("Datetimes are integer based."),
1325 GUC_REPORT | GUC_NOT_IN_SAMPLE | GUC_DISALLOW_IN_FILE
1328 #ifdef HAVE_INT64_TIMESTAMP
1337 {"krb_caseins_users", PGC_SIGHUP, CONN_AUTH_SECURITY,
1338 gettext_noop("Sets whether Kerberos and GSSAPI user names should be treated as case-insensitive."),
1341 &pg_krb_caseins_users,
1347 {"escape_string_warning", PGC_USERSET, COMPAT_OPTIONS_PREVIOUS,
1348 gettext_noop("Warn about backslash escapes in ordinary string literals."),
1351 &escape_string_warning,
1357 {"standard_conforming_strings", PGC_USERSET, COMPAT_OPTIONS_PREVIOUS,
1358 gettext_noop("Causes '...' strings to treat backslashes literally."),
1362 &standard_conforming_strings,
1368 {"synchronize_seqscans", PGC_USERSET, COMPAT_OPTIONS_PREVIOUS,
1369 gettext_noop("Enable synchronized sequential scans."),
1372 &synchronize_seqscans,
1378 {"archive_mode", PGC_POSTMASTER, WAL_ARCHIVING,
1379 gettext_noop("Allows archiving of WAL files using archive_command."),
1388 {"hot_standby", PGC_POSTMASTER, REPLICATION_STANDBY,
1389 gettext_noop("Allows connections and queries during recovery."),
1398 {"hot_standby_feedback", PGC_SIGHUP, REPLICATION_STANDBY,
1399 gettext_noop("Allows feedback from a hot standby to the primary that will avoid query conflicts."),
1402 &hot_standby_feedback,
1408 {"allow_system_table_mods", PGC_POSTMASTER, DEVELOPER_OPTIONS,
1409 gettext_noop("Allows modifications of the structure of system tables."),
1413 &allowSystemTableMods,
1419 {"ignore_system_indexes", PGC_BACKEND, DEVELOPER_OPTIONS,
1420 gettext_noop("Disables reading from system indexes."),
1421 gettext_noop("It does not prevent updating the indexes, so it is safe "
1422 "to use. The worst consequence is slowness."),
1425 &IgnoreSystemIndexes,
1431 {"lo_compat_privileges", PGC_SUSET, COMPAT_OPTIONS_PREVIOUS,
1432 gettext_noop("Enables backward compatibility mode for privilege checks on large objects."),
1433 gettext_noop("Skips privilege checks when reading or modifying large objects, "
1434 "for compatibility with PostgreSQL releases prior to 9.0.")
1436 &lo_compat_privileges,
1442 {"quote_all_identifiers", PGC_USERSET, COMPAT_OPTIONS_PREVIOUS,
1443 gettext_noop("When generating SQL fragments, quote all identifiers."),
1446 "e_all_identifiers,
1451 /* End-of-list marker */
1453 {NULL, 0, 0, NULL, NULL}, NULL, false, NULL, NULL, NULL
1458 static struct config_int ConfigureNamesInt[] =
1461 {"archive_timeout", PGC_SIGHUP, WAL_ARCHIVING,
1462 gettext_noop("Forces a switch to the next xlog file if a "
1463 "new file has not been started within N seconds."),
1467 &XLogArchiveTimeout,
1472 {"post_auth_delay", PGC_BACKEND, DEVELOPER_OPTIONS,
1473 gettext_noop("Waits N seconds on connection startup after authentication."),
1474 gettext_noop("This allows attaching a debugger to the process."),
1475 GUC_NOT_IN_SAMPLE | GUC_UNIT_S
1482 {"default_statistics_target", PGC_USERSET, QUERY_TUNING_OTHER,
1483 gettext_noop("Sets the default statistics target."),
1484 gettext_noop("This applies to table columns that have not had a "
1485 "column-specific target set via ALTER TABLE SET STATISTICS.")
1487 &default_statistics_target,
1492 {"from_collapse_limit", PGC_USERSET, QUERY_TUNING_OTHER,
1493 gettext_noop("Sets the FROM-list size beyond which subqueries "
1494 "are not collapsed."),
1495 gettext_noop("The planner will merge subqueries into upper "
1496 "queries if the resulting FROM list would have no more than "
1499 &from_collapse_limit,
1504 {"join_collapse_limit", PGC_USERSET, QUERY_TUNING_OTHER,
1505 gettext_noop("Sets the FROM-list size beyond which JOIN "
1506 "constructs are not flattened."),
1507 gettext_noop("The planner will flatten explicit JOIN "
1508 "constructs into lists of FROM items whenever a "
1509 "list of no more than this many items would result.")
1511 &join_collapse_limit,
1516 {"geqo_threshold", PGC_USERSET, QUERY_TUNING_GEQO,
1517 gettext_noop("Sets the threshold of FROM items beyond which GEQO is used."),
1525 {"geqo_effort", PGC_USERSET, QUERY_TUNING_GEQO,
1526 gettext_noop("GEQO: effort is used to set the default for other GEQO parameters."),
1530 DEFAULT_GEQO_EFFORT, MIN_GEQO_EFFORT, MAX_GEQO_EFFORT,
1534 {"geqo_pool_size", PGC_USERSET, QUERY_TUNING_GEQO,
1535 gettext_noop("GEQO: number of individuals in the population."),
1536 gettext_noop("Zero selects a suitable default value.")
1543 {"geqo_generations", PGC_USERSET, QUERY_TUNING_GEQO,
1544 gettext_noop("GEQO: number of iterations of the algorithm."),
1545 gettext_noop("Zero selects a suitable default value.")
1553 /* This is PGC_SUSET to prevent hiding from log_lock_waits. */
1554 {"deadlock_timeout", PGC_SUSET, LOCK_MANAGEMENT,
1555 gettext_noop("Sets the time to wait on a lock before checking for deadlock."),
1565 {"max_standby_archive_delay", PGC_SIGHUP, REPLICATION_STANDBY,
1566 gettext_noop("Sets the maximum delay before canceling queries when a hot standby server is processing archived WAL data."),
1570 &max_standby_archive_delay,
1571 30 * 1000, -1, INT_MAX,
1576 {"max_standby_streaming_delay", PGC_SIGHUP, REPLICATION_STANDBY,
1577 gettext_noop("Sets the maximum delay before canceling queries when a hot standby server is processing streamed WAL data."),
1581 &max_standby_streaming_delay,
1582 30 * 1000, -1, INT_MAX,
1587 {"wal_receiver_status_interval", PGC_SIGHUP, REPLICATION_STANDBY,
1588 gettext_noop("Sets the maximum interval between WAL receiver status reports to the primary."),
1592 &wal_receiver_status_interval,
1593 10, 0, INT_MAX / 1000,
1598 {"max_connections", PGC_POSTMASTER, CONN_AUTH_SETTINGS,
1599 gettext_noop("Sets the maximum number of concurrent connections."),
1603 100, 1, MAX_BACKENDS,
1604 check_maxconnections, assign_maxconnections, NULL
1608 {"superuser_reserved_connections", PGC_POSTMASTER, CONN_AUTH_SETTINGS,
1609 gettext_noop("Sets the number of connection slots reserved for superusers."),
1618 * We sometimes multiply the number of shared buffers by two without
1619 * checking for overflow, so we mustn't allow more than INT_MAX / 2.
1622 {"shared_buffers", PGC_POSTMASTER, RESOURCES_MEM,
1623 gettext_noop("Sets the number of shared memory buffers used by the server."),
1628 1024, 16, INT_MAX / 2,
1633 {"temp_buffers", PGC_USERSET, RESOURCES_MEM,
1634 gettext_noop("Sets the maximum number of temporary buffers used by each session."),
1639 1024, 100, INT_MAX / 2,
1640 check_temp_buffers, NULL, NULL
1644 {"port", PGC_POSTMASTER, CONN_AUTH_SETTINGS,
1645 gettext_noop("Sets the TCP port the server listens on."),
1649 DEF_PGPORT, 1, 65535,
1654 {"unix_socket_permissions", PGC_POSTMASTER, CONN_AUTH_SETTINGS,
1655 gettext_noop("Sets the access permissions of the Unix-domain socket."),
1656 gettext_noop("Unix-domain sockets use the usual Unix file system "
1657 "permission set. The parameter value is expected "
1658 "to be a numeric mode specification in the form "
1659 "accepted by the chmod and umask system calls. "
1660 "(To use the customary octal format the number must "
1661 "start with a 0 (zero).)")
1663 &Unix_socket_permissions,
1665 NULL, NULL, show_unix_socket_permissions
1669 {"log_file_mode", PGC_SIGHUP, LOGGING_WHERE,
1670 gettext_noop("Sets the file permissions for log files."),
1671 gettext_noop("The parameter value is expected "
1672 "to be a numeric mode specification in the form "
1673 "accepted by the chmod and umask system calls. "
1674 "(To use the customary octal format the number must "
1675 "start with a 0 (zero).)")
1679 NULL, NULL, show_log_file_mode
1683 {"work_mem", PGC_USERSET, RESOURCES_MEM,
1684 gettext_noop("Sets the maximum memory to be used for query workspaces."),
1685 gettext_noop("This much memory can be used by each internal "
1686 "sort operation and hash table before switching to "
1687 "temporary disk files."),
1691 1024, 64, MAX_KILOBYTES,
1696 {"maintenance_work_mem", PGC_USERSET, RESOURCES_MEM,
1697 gettext_noop("Sets the maximum memory to be used for maintenance operations."),
1698 gettext_noop("This includes operations such as VACUUM and CREATE INDEX."),
1701 &maintenance_work_mem,
1702 16384, 1024, MAX_KILOBYTES,
1707 * We use the hopefully-safely-small value of 100kB as the compiled-in
1708 * default for max_stack_depth. InitializeGUCOptions will increase it if
1709 * possible, depending on the actual platform-specific stack limit.
1712 {"max_stack_depth", PGC_SUSET, RESOURCES_MEM,
1713 gettext_noop("Sets the maximum stack depth, in kilobytes."),
1718 100, 100, MAX_KILOBYTES,
1719 check_max_stack_depth, assign_max_stack_depth, NULL
1723 {"temp_file_limit", PGC_SUSET, RESOURCES_DISK,
1724 gettext_noop("Limits the total size of all temp files used by each session."),
1725 gettext_noop("-1 means no limit."),
1734 {"vacuum_cost_page_hit", PGC_USERSET, RESOURCES_VACUUM_DELAY,
1735 gettext_noop("Vacuum cost for a page found in the buffer cache."),
1744 {"vacuum_cost_page_miss", PGC_USERSET, RESOURCES_VACUUM_DELAY,
1745 gettext_noop("Vacuum cost for a page not found in the buffer cache."),
1748 &VacuumCostPageMiss,
1754 {"vacuum_cost_page_dirty", PGC_USERSET, RESOURCES_VACUUM_DELAY,
1755 gettext_noop("Vacuum cost for a page dirtied by vacuum."),
1758 &VacuumCostPageDirty,
1764 {"vacuum_cost_limit", PGC_USERSET, RESOURCES_VACUUM_DELAY,
1765 gettext_noop("Vacuum cost amount available before napping."),
1774 {"vacuum_cost_delay", PGC_USERSET, RESOURCES_VACUUM_DELAY,
1775 gettext_noop("Vacuum cost delay in milliseconds."),
1785 {"autovacuum_vacuum_cost_delay", PGC_SIGHUP, AUTOVACUUM,
1786 gettext_noop("Vacuum cost delay in milliseconds, for autovacuum."),
1790 &autovacuum_vac_cost_delay,
1796 {"autovacuum_vacuum_cost_limit", PGC_SIGHUP, AUTOVACUUM,
1797 gettext_noop("Vacuum cost amount available before napping, for autovacuum."),
1800 &autovacuum_vac_cost_limit,
1806 {"max_files_per_process", PGC_POSTMASTER, RESOURCES_KERNEL,
1807 gettext_noop("Sets the maximum number of simultaneously open files for each server process."),
1810 &max_files_per_process,
1816 * See also CheckRequiredParameterValues() if this parameter changes
1819 {"max_prepared_transactions", PGC_POSTMASTER, RESOURCES_MEM,
1820 gettext_noop("Sets the maximum number of simultaneously prepared transactions."),
1823 &max_prepared_xacts,
1830 {"trace_lock_oidmin", PGC_SUSET, DEVELOPER_OPTIONS,
1831 gettext_noop("No description available."),
1836 FirstNormalObjectId, 0, INT_MAX,
1840 {"trace_lock_table", PGC_SUSET, DEVELOPER_OPTIONS,
1841 gettext_noop("No description available."),
1852 {"statement_timeout", PGC_USERSET, CLIENT_CONN_STATEMENT,
1853 gettext_noop("Sets the maximum allowed duration of any statement."),
1854 gettext_noop("A value of 0 turns off the timeout."),
1863 {"vacuum_freeze_min_age", PGC_USERSET, CLIENT_CONN_STATEMENT,
1864 gettext_noop("Minimum age at which VACUUM should freeze a table row."),
1867 &vacuum_freeze_min_age,
1868 50000000, 0, 1000000000,
1873 {"vacuum_freeze_table_age", PGC_USERSET, CLIENT_CONN_STATEMENT,
1874 gettext_noop("Age at which VACUUM should scan whole table to freeze tuples."),
1877 &vacuum_freeze_table_age,
1878 150000000, 0, 2000000000,
1883 {"vacuum_defer_cleanup_age", PGC_SIGHUP, REPLICATION_MASTER,
1884 gettext_noop("Number of transactions by which VACUUM and HOT cleanup should be deferred, if any."),
1887 &vacuum_defer_cleanup_age,
1893 * See also CheckRequiredParameterValues() if this parameter changes
1896 {"max_locks_per_transaction", PGC_POSTMASTER, LOCK_MANAGEMENT,
1897 gettext_noop("Sets the maximum number of locks per transaction."),
1898 gettext_noop("The shared lock table is sized on the assumption that "
1899 "at most max_locks_per_transaction * max_connections distinct "
1900 "objects will need to be locked at any one time.")
1902 &max_locks_per_xact,
1908 {"max_pred_locks_per_transaction", PGC_POSTMASTER, LOCK_MANAGEMENT,
1909 gettext_noop("Sets the maximum number of predicate locks per transaction."),
1910 gettext_noop("The shared predicate lock table is sized on the assumption that "
1911 "at most max_pred_locks_per_transaction * max_connections distinct "
1912 "objects will need to be locked at any one time.")
1914 &max_predicate_locks_per_xact,
1920 {"authentication_timeout", PGC_SIGHUP, CONN_AUTH_SECURITY,
1921 gettext_noop("Sets the maximum allowed time to complete client authentication."),
1925 &AuthenticationTimeout,
1931 /* Not for general use */
1932 {"pre_auth_delay", PGC_SIGHUP, DEVELOPER_OPTIONS,
1933 gettext_noop("Waits N seconds on connection startup before authentication."),
1934 gettext_noop("This allows attaching a debugger to the process."),
1935 GUC_NOT_IN_SAMPLE | GUC_UNIT_S
1943 {"wal_keep_segments", PGC_SIGHUP, REPLICATION_SENDING,
1944 gettext_noop("Sets the number of WAL files held for standby servers."),
1953 {"checkpoint_segments", PGC_SIGHUP, WAL_CHECKPOINTS,
1954 gettext_noop("Sets the maximum distance in log segments between automatic WAL checkpoints."),
1957 &CheckPointSegments,
1963 {"checkpoint_timeout", PGC_SIGHUP, WAL_CHECKPOINTS,
1964 gettext_noop("Sets the maximum time between automatic WAL checkpoints."),
1974 {"checkpoint_warning", PGC_SIGHUP, WAL_CHECKPOINTS,
1975 gettext_noop("Enables warnings if checkpoint segments are filled more "
1976 "frequently than this."),
1977 gettext_noop("Write a message to the server log if checkpoints "
1978 "caused by the filling of checkpoint segment files happens more "
1979 "frequently than this number of seconds. Zero turns off the warning."),
1988 {"wal_buffers", PGC_POSTMASTER, WAL_SETTINGS,
1989 gettext_noop("Sets the number of disk-page buffers in shared memory for WAL."),
1995 check_wal_buffers, NULL, NULL
1999 {"wal_writer_delay", PGC_SIGHUP, WAL_SETTINGS,
2000 gettext_noop("WAL writer sleep time between WAL flushes."),
2010 /* see max_connections */
2011 {"max_wal_senders", PGC_POSTMASTER, REPLICATION_SENDING,
2012 gettext_noop("Sets the maximum number of simultaneously running WAL sender processes."),
2021 {"replication_timeout", PGC_SIGHUP, REPLICATION_SENDING,
2022 gettext_noop("Sets the maximum time to wait for WAL replication."),
2026 &replication_timeout,
2027 60 * 1000, 0, INT_MAX,
2032 {"commit_delay", PGC_USERSET, WAL_SETTINGS,
2033 gettext_noop("Sets the delay in microseconds between transaction commit and "
2034 "flushing WAL to disk."),
2043 {"commit_siblings", PGC_USERSET, WAL_SETTINGS,
2044 gettext_noop("Sets the minimum concurrent open transactions before performing "
2054 {"extra_float_digits", PGC_USERSET, CLIENT_CONN_LOCALE,
2055 gettext_noop("Sets the number of digits displayed for floating-point values."),
2056 gettext_noop("This affects real, double precision, and geometric data types. "
2057 "The parameter value is added to the standard number of digits "
2058 "(FLT_DIG or DBL_DIG as appropriate).")
2060 &extra_float_digits,
2066 {"log_min_duration_statement", PGC_SUSET, LOGGING_WHEN,
2067 gettext_noop("Sets the minimum execution time above which "
2068 "statements will be logged."),
2069 gettext_noop("Zero prints all queries. -1 turns this feature off."),
2072 &log_min_duration_statement,
2078 {"log_autovacuum_min_duration", PGC_SIGHUP, LOGGING_WHAT,
2079 gettext_noop("Sets the minimum execution time above which "
2080 "autovacuum actions will be logged."),
2081 gettext_noop("Zero prints all actions. -1 turns autovacuum logging off."),
2084 &Log_autovacuum_min_duration,
2090 {"bgwriter_delay", PGC_SIGHUP, RESOURCES_BGWRITER,
2091 gettext_noop("Background writer sleep time between rounds."),
2101 {"bgwriter_lru_maxpages", PGC_SIGHUP, RESOURCES_BGWRITER,
2102 gettext_noop("Background writer maximum number of LRU pages to flush per round."),
2105 &bgwriter_lru_maxpages,
2111 {"effective_io_concurrency",
2117 RESOURCES_ASYNCHRONOUS,
2118 gettext_noop("Number of simultaneous requests that can be handled efficiently by the disk subsystem."),
2119 gettext_noop("For RAID arrays, this should be approximately the number of drive spindles in the array.")
2121 &effective_io_concurrency,
2127 check_effective_io_concurrency, assign_effective_io_concurrency, NULL
2131 {"log_rotation_age", PGC_SIGHUP, LOGGING_WHERE,
2132 gettext_noop("Automatic log file rotation will occur after N minutes."),
2137 HOURS_PER_DAY * MINS_PER_HOUR, 0, INT_MAX / MINS_PER_HOUR,
2142 {"log_rotation_size", PGC_SIGHUP, LOGGING_WHERE,
2143 gettext_noop("Automatic log file rotation will occur after N kilobytes."),
2148 10 * 1024, 0, INT_MAX / 1024,
2153 {"max_function_args", PGC_INTERNAL, PRESET_OPTIONS,
2154 gettext_noop("Shows the maximum number of function arguments."),
2156 GUC_NOT_IN_SAMPLE | GUC_DISALLOW_IN_FILE
2159 FUNC_MAX_ARGS, FUNC_MAX_ARGS, FUNC_MAX_ARGS,
2164 {"max_index_keys", PGC_INTERNAL, PRESET_OPTIONS,
2165 gettext_noop("Shows the maximum number of index keys."),
2167 GUC_NOT_IN_SAMPLE | GUC_DISALLOW_IN_FILE
2170 INDEX_MAX_KEYS, INDEX_MAX_KEYS, INDEX_MAX_KEYS,
2175 {"max_identifier_length", PGC_INTERNAL, PRESET_OPTIONS,
2176 gettext_noop("Shows the maximum identifier length."),
2178 GUC_NOT_IN_SAMPLE | GUC_DISALLOW_IN_FILE
2180 &max_identifier_length,
2181 NAMEDATALEN - 1, NAMEDATALEN - 1, NAMEDATALEN - 1,
2186 {"block_size", PGC_INTERNAL, PRESET_OPTIONS,
2187 gettext_noop("Shows the size of a disk block."),
2189 GUC_NOT_IN_SAMPLE | GUC_DISALLOW_IN_FILE
2192 BLCKSZ, BLCKSZ, BLCKSZ,
2197 {"segment_size", PGC_INTERNAL, PRESET_OPTIONS,
2198 gettext_noop("Shows the number of pages per disk file."),
2200 GUC_UNIT_BLOCKS | GUC_NOT_IN_SAMPLE | GUC_DISALLOW_IN_FILE
2203 RELSEG_SIZE, RELSEG_SIZE, RELSEG_SIZE,
2208 {"wal_block_size", PGC_INTERNAL, PRESET_OPTIONS,
2209 gettext_noop("Shows the block size in the write ahead log."),
2211 GUC_NOT_IN_SAMPLE | GUC_DISALLOW_IN_FILE
2214 XLOG_BLCKSZ, XLOG_BLCKSZ, XLOG_BLCKSZ,
2219 {"wal_segment_size", PGC_INTERNAL, PRESET_OPTIONS,
2220 gettext_noop("Shows the number of pages per write ahead log segment."),
2222 GUC_UNIT_XBLOCKS | GUC_NOT_IN_SAMPLE | GUC_DISALLOW_IN_FILE
2225 (XLOG_SEG_SIZE / XLOG_BLCKSZ),
2226 (XLOG_SEG_SIZE / XLOG_BLCKSZ),
2227 (XLOG_SEG_SIZE / XLOG_BLCKSZ),
2232 {"autovacuum_naptime", PGC_SIGHUP, AUTOVACUUM,
2233 gettext_noop("Time to sleep between autovacuum runs."),
2237 &autovacuum_naptime,
2238 60, 1, INT_MAX / 1000,
2242 {"autovacuum_vacuum_threshold", PGC_SIGHUP, AUTOVACUUM,
2243 gettext_noop("Minimum number of tuple updates or deletes prior to vacuum."),
2246 &autovacuum_vac_thresh,
2251 {"autovacuum_analyze_threshold", PGC_SIGHUP, AUTOVACUUM,
2252 gettext_noop("Minimum number of tuple inserts, updates, or deletes prior to analyze."),
2255 &autovacuum_anl_thresh,
2260 /* see varsup.c for why this is PGC_POSTMASTER not PGC_SIGHUP */
2261 {"autovacuum_freeze_max_age", PGC_POSTMASTER, AUTOVACUUM,
2262 gettext_noop("Age at which to autovacuum a table to prevent transaction ID wraparound."),
2265 &autovacuum_freeze_max_age,
2266 /* see pg_resetxlog if you change the upper-limit value */
2267 200000000, 100000000, 2000000000,
2271 /* see max_connections */
2272 {"autovacuum_max_workers", PGC_POSTMASTER, AUTOVACUUM,
2273 gettext_noop("Sets the maximum number of simultaneously running autovacuum worker processes."),
2276 &autovacuum_max_workers,
2278 check_autovacuum_max_workers, assign_autovacuum_max_workers, NULL
2282 {"tcp_keepalives_idle", PGC_USERSET, CLIENT_CONN_OTHER,
2283 gettext_noop("Time between issuing TCP keepalives."),
2284 gettext_noop("A value of 0 uses the system default."),
2287 &tcp_keepalives_idle,
2289 NULL, assign_tcp_keepalives_idle, show_tcp_keepalives_idle
2293 {"tcp_keepalives_interval", PGC_USERSET, CLIENT_CONN_OTHER,
2294 gettext_noop("Time between TCP keepalive retransmits."),
2295 gettext_noop("A value of 0 uses the system default."),
2298 &tcp_keepalives_interval,
2300 NULL, assign_tcp_keepalives_interval, show_tcp_keepalives_interval
2304 {"ssl_renegotiation_limit", PGC_USERSET, CONN_AUTH_SECURITY,
2305 gettext_noop("Set the amount of traffic to send and receive before renegotiating the encryption keys."),
2309 &ssl_renegotiation_limit,
2310 512 * 1024, 0, MAX_KILOBYTES,
2315 {"tcp_keepalives_count", PGC_USERSET, CLIENT_CONN_OTHER,
2316 gettext_noop("Maximum number of TCP keepalive retransmits."),
2317 gettext_noop("This controls the number of consecutive keepalive retransmits that can be "
2318 "lost before a connection is considered dead. A value of 0 uses the "
2321 &tcp_keepalives_count,
2323 NULL, assign_tcp_keepalives_count, show_tcp_keepalives_count
2327 {"gin_fuzzy_search_limit", PGC_USERSET, CLIENT_CONN_OTHER,
2328 gettext_noop("Sets the maximum allowed result for exact search by GIN."),
2332 &GinFuzzySearchLimit,
2338 {"effective_cache_size", PGC_USERSET, QUERY_TUNING_COST,
2339 gettext_noop("Sets the planner's assumption about the size of the disk cache."),
2340 gettext_noop("That is, the portion of the kernel's disk cache that "
2341 "will be used for PostgreSQL data files. This is measured in disk "
2342 "pages, which are normally 8 kB each."),
2345 &effective_cache_size,
2346 DEFAULT_EFFECTIVE_CACHE_SIZE, 1, INT_MAX,
2351 /* Can't be set in postgresql.conf */
2352 {"server_version_num", PGC_INTERNAL, PRESET_OPTIONS,
2353 gettext_noop("Shows the server version as an integer."),
2355 GUC_NOT_IN_SAMPLE | GUC_DISALLOW_IN_FILE
2357 &server_version_num,
2358 PG_VERSION_NUM, PG_VERSION_NUM, PG_VERSION_NUM,
2363 {"log_temp_files", PGC_SUSET, LOGGING_WHAT,
2364 gettext_noop("Log the use of temporary files larger than this number of kilobytes."),
2365 gettext_noop("Zero logs all files. The default is -1 (turning this feature off)."),
2374 {"track_activity_query_size", PGC_POSTMASTER, RESOURCES_MEM,
2375 gettext_noop("Sets the size reserved for pg_stat_activity.query, in bytes."),
2378 &pgstat_track_activity_query_size,
2383 /* End-of-list marker */
2385 {NULL, 0, 0, NULL, NULL}, NULL, 0, 0, 0, NULL, NULL, NULL
2390 static struct config_real ConfigureNamesReal[] =
2393 {"seq_page_cost", PGC_USERSET, QUERY_TUNING_COST,
2394 gettext_noop("Sets the planner's estimate of the cost of a "
2395 "sequentially fetched disk page."),
2399 DEFAULT_SEQ_PAGE_COST, 0, DBL_MAX,
2403 {"random_page_cost", PGC_USERSET, QUERY_TUNING_COST,
2404 gettext_noop("Sets the planner's estimate of the cost of a "
2405 "nonsequentially fetched disk page."),
2409 DEFAULT_RANDOM_PAGE_COST, 0, DBL_MAX,
2413 {"cpu_tuple_cost", PGC_USERSET, QUERY_TUNING_COST,
2414 gettext_noop("Sets the planner's estimate of the cost of "
2415 "processing each tuple (row)."),
2419 DEFAULT_CPU_TUPLE_COST, 0, DBL_MAX,
2423 {"cpu_index_tuple_cost", PGC_USERSET, QUERY_TUNING_COST,
2424 gettext_noop("Sets the planner's estimate of the cost of "
2425 "processing each index entry during an index scan."),
2428 &cpu_index_tuple_cost,
2429 DEFAULT_CPU_INDEX_TUPLE_COST, 0, DBL_MAX,
2433 {"cpu_operator_cost", PGC_USERSET, QUERY_TUNING_COST,
2434 gettext_noop("Sets the planner's estimate of the cost of "
2435 "processing each operator or function call."),
2439 DEFAULT_CPU_OPERATOR_COST, 0, DBL_MAX,
2444 {"cursor_tuple_fraction", PGC_USERSET, QUERY_TUNING_OTHER,
2445 gettext_noop("Sets the planner's estimate of the fraction of "
2446 "a cursor's rows that will be retrieved."),
2449 &cursor_tuple_fraction,
2450 DEFAULT_CURSOR_TUPLE_FRACTION, 0.0, 1.0,
2455 {"geqo_selection_bias", PGC_USERSET, QUERY_TUNING_GEQO,
2456 gettext_noop("GEQO: selective pressure within the population."),
2459 &Geqo_selection_bias,
2460 DEFAULT_GEQO_SELECTION_BIAS,
2461 MIN_GEQO_SELECTION_BIAS, MAX_GEQO_SELECTION_BIAS,
2465 {"geqo_seed", PGC_USERSET, QUERY_TUNING_GEQO,
2466 gettext_noop("GEQO: seed for random path selection."),
2475 {"bgwriter_lru_multiplier", PGC_SIGHUP, RESOURCES_BGWRITER,
2476 gettext_noop("Multiple of the average buffer usage to free per round."),
2479 &bgwriter_lru_multiplier,
2485 {"seed", PGC_USERSET, UNGROUPED,
2486 gettext_noop("Sets the seed for random-number generation."),
2488 GUC_NO_SHOW_ALL | GUC_NO_RESET_ALL | GUC_NOT_IN_SAMPLE | GUC_DISALLOW_IN_FILE
2492 check_random_seed, assign_random_seed, show_random_seed
2496 {"autovacuum_vacuum_scale_factor", PGC_SIGHUP, AUTOVACUUM,
2497 gettext_noop("Number of tuple updates or deletes prior to vacuum as a fraction of reltuples."),
2500 &autovacuum_vac_scale,
2505 {"autovacuum_analyze_scale_factor", PGC_SIGHUP, AUTOVACUUM,
2506 gettext_noop("Number of tuple inserts, updates, or deletes prior to analyze as a fraction of reltuples."),
2509 &autovacuum_anl_scale,
2515 {"checkpoint_completion_target", PGC_SIGHUP, WAL_CHECKPOINTS,
2516 gettext_noop("Time spent flushing dirty buffers during checkpoint, as fraction of checkpoint interval."),
2519 &CheckPointCompletionTarget,
2524 /* End-of-list marker */
2526 {NULL, 0, 0, NULL, NULL}, NULL, 0.0, 0.0, 0.0, NULL, NULL, NULL
2531 static struct config_string ConfigureNamesString[] =
2534 {"archive_command", PGC_SIGHUP, WAL_ARCHIVING,
2535 gettext_noop("Sets the shell command that will be called to archive a WAL file."),
2538 &XLogArchiveCommand,
2540 NULL, NULL, show_archive_command
2544 {"client_encoding", PGC_USERSET, CLIENT_CONN_LOCALE,
2545 gettext_noop("Sets the client's character set encoding."),
2547 GUC_IS_NAME | GUC_REPORT
2549 &client_encoding_string,
2551 check_client_encoding, assign_client_encoding, NULL
2555 {"log_line_prefix", PGC_SIGHUP, LOGGING_WHAT,
2556 gettext_noop("Controls information prefixed to each log line."),
2557 gettext_noop("If blank, no prefix is used.")
2565 {"log_timezone", PGC_SIGHUP, LOGGING_WHAT,
2566 gettext_noop("Sets the time zone to use in log messages."),
2569 &log_timezone_string,
2571 check_log_timezone, assign_log_timezone, show_log_timezone
2575 {"DateStyle", PGC_USERSET, CLIENT_CONN_LOCALE,
2576 gettext_noop("Sets the display format for date and time values."),
2577 gettext_noop("Also controls interpretation of ambiguous "
2579 GUC_LIST_INPUT | GUC_REPORT
2583 check_datestyle, assign_datestyle, NULL
2587 {"default_tablespace", PGC_USERSET, CLIENT_CONN_STATEMENT,
2588 gettext_noop("Sets the default tablespace to create tables and indexes in."),
2589 gettext_noop("An empty string selects the database's default tablespace."),
2592 &default_tablespace,
2594 check_default_tablespace, NULL, NULL
2598 {"temp_tablespaces", PGC_USERSET, CLIENT_CONN_STATEMENT,
2599 gettext_noop("Sets the tablespace(s) to use for temporary tables and sort files."),
2601 GUC_LIST_INPUT | GUC_LIST_QUOTE
2605 check_temp_tablespaces, assign_temp_tablespaces, NULL
2609 {"dynamic_library_path", PGC_SUSET, CLIENT_CONN_OTHER,
2610 gettext_noop("Sets the path for dynamically loadable modules."),
2611 gettext_noop("If a dynamically loadable module needs to be opened and "
2612 "the specified name does not have a directory component (i.e., the "
2613 "name does not contain a slash), the system will search this path for "
2614 "the specified file."),
2617 &Dynamic_library_path,
2623 {"krb_server_keyfile", PGC_SIGHUP, CONN_AUTH_SECURITY,
2624 gettext_noop("Sets the location of the Kerberos server key file."),
2628 &pg_krb_server_keyfile,
2634 {"krb_srvname", PGC_SIGHUP, CONN_AUTH_SECURITY,
2635 gettext_noop("Sets the name of the Kerberos service."),
2644 {"bonjour_name", PGC_POSTMASTER, CONN_AUTH_SETTINGS,
2645 gettext_noop("Sets the Bonjour service name."),
2653 /* See main.c about why defaults for LC_foo are not all alike */
2656 {"lc_collate", PGC_INTERNAL, CLIENT_CONN_LOCALE,
2657 gettext_noop("Shows the collation order locale."),
2659 GUC_NOT_IN_SAMPLE | GUC_DISALLOW_IN_FILE
2667 {"lc_ctype", PGC_INTERNAL, CLIENT_CONN_LOCALE,
2668 gettext_noop("Shows the character classification and case conversion locale."),
2670 GUC_NOT_IN_SAMPLE | GUC_DISALLOW_IN_FILE
2678 {"lc_messages", PGC_SUSET, CLIENT_CONN_LOCALE,
2679 gettext_noop("Sets the language in which messages are displayed."),
2684 check_locale_messages, assign_locale_messages, NULL
2688 {"lc_monetary", PGC_USERSET, CLIENT_CONN_LOCALE,
2689 gettext_noop("Sets the locale for formatting monetary amounts."),
2694 check_locale_monetary, assign_locale_monetary, NULL
2698 {"lc_numeric", PGC_USERSET, CLIENT_CONN_LOCALE,
2699 gettext_noop("Sets the locale for formatting numbers."),
2704 check_locale_numeric, assign_locale_numeric, NULL
2708 {"lc_time", PGC_USERSET, CLIENT_CONN_LOCALE,
2709 gettext_noop("Sets the locale for formatting date and time values."),
2714 check_locale_time, assign_locale_time, NULL
2718 {"shared_preload_libraries", PGC_POSTMASTER, RESOURCES_KERNEL,
2719 gettext_noop("Lists shared libraries to preload into server."),
2721 GUC_LIST_INPUT | GUC_LIST_QUOTE | GUC_SUPERUSER_ONLY
2723 &shared_preload_libraries_string,
2729 {"local_preload_libraries", PGC_BACKEND, CLIENT_CONN_OTHER,
2730 gettext_noop("Lists shared libraries to preload into each backend."),
2732 GUC_LIST_INPUT | GUC_LIST_QUOTE
2734 &local_preload_libraries_string,
2740 {"search_path", PGC_USERSET, CLIENT_CONN_STATEMENT,
2741 gettext_noop("Sets the schema search order for names that are not schema-qualified."),
2743 GUC_LIST_INPUT | GUC_LIST_QUOTE
2745 &namespace_search_path,
2747 check_search_path, assign_search_path, NULL
2751 /* Can't be set in postgresql.conf */
2752 {"server_encoding", PGC_INTERNAL, CLIENT_CONN_LOCALE,
2753 gettext_noop("Sets the server (database) character set encoding."),
2755 GUC_IS_NAME | GUC_REPORT | GUC_NOT_IN_SAMPLE | GUC_DISALLOW_IN_FILE
2757 &server_encoding_string,
2763 /* Can't be set in postgresql.conf */
2764 {"server_version", PGC_INTERNAL, PRESET_OPTIONS,
2765 gettext_noop("Shows the server version."),
2767 GUC_REPORT | GUC_NOT_IN_SAMPLE | GUC_DISALLOW_IN_FILE
2769 &server_version_string,
2775 /* Not for general use --- used by SET ROLE */
2776 {"role", PGC_USERSET, UNGROUPED,
2777 gettext_noop("Sets the current role."),
2779 GUC_IS_NAME | GUC_NO_SHOW_ALL | GUC_NO_RESET_ALL | GUC_NOT_IN_SAMPLE | GUC_DISALLOW_IN_FILE | GUC_NOT_WHILE_SEC_REST
2783 check_role, assign_role, show_role
2787 /* Not for general use --- used by SET SESSION AUTHORIZATION */
2788 {"session_authorization", PGC_USERSET, UNGROUPED,
2789 gettext_noop("Sets the session user name."),
2791 GUC_IS_NAME | GUC_REPORT | GUC_NO_SHOW_ALL | GUC_NO_RESET_ALL | GUC_NOT_IN_SAMPLE | GUC_DISALLOW_IN_FILE | GUC_NOT_WHILE_SEC_REST
2793 &session_authorization_string,
2795 check_session_authorization, assign_session_authorization, NULL
2799 {"log_destination", PGC_SIGHUP, LOGGING_WHERE,
2800 gettext_noop("Sets the destination for server log output."),
2801 gettext_noop("Valid values are combinations of \"stderr\", "
2802 "\"syslog\", \"csvlog\", and \"eventlog\", "
2803 "depending on the platform."),
2806 &log_destination_string,
2808 check_log_destination, assign_log_destination, NULL
2811 {"log_directory", PGC_SIGHUP, LOGGING_WHERE,
2812 gettext_noop("Sets the destination directory for log files."),
2813 gettext_noop("Can be specified as relative to the data directory "
2814 "or as absolute path."),
2819 check_canonical_path, NULL, NULL
2822 {"log_filename", PGC_SIGHUP, LOGGING_WHERE,
2823 gettext_noop("Sets the file name pattern for log files."),
2828 "postgresql-%Y-%m-%d_%H%M%S.log",
2833 {"syslog_ident", PGC_SIGHUP, LOGGING_WHERE,
2834 gettext_noop("Sets the program name used to identify PostgreSQL "
2835 "messages in syslog."),
2840 NULL, assign_syslog_ident, NULL
2844 {"event_source", PGC_POSTMASTER, LOGGING_WHERE,
2845 gettext_noop("Sets the application name used to identify"
2846 "PostgreSQL messages in the event log."),
2855 {"TimeZone", PGC_USERSET, CLIENT_CONN_LOCALE,
2856 gettext_noop("Sets the time zone for displaying and interpreting time stamps."),
2862 check_timezone, assign_timezone, show_timezone
2865 {"timezone_abbreviations", PGC_USERSET, CLIENT_CONN_LOCALE,
2866 gettext_noop("Selects a file of time zone abbreviations."),
2869 &timezone_abbreviations_string,
2871 check_timezone_abbreviations, assign_timezone_abbreviations, NULL
2875 {"transaction_isolation", PGC_USERSET, CLIENT_CONN_STATEMENT,
2876 gettext_noop("Sets the current transaction's isolation level."),
2878 GUC_NO_RESET_ALL | GUC_NOT_IN_SAMPLE | GUC_DISALLOW_IN_FILE
2880 &XactIsoLevel_string,
2882 check_XactIsoLevel, assign_XactIsoLevel, show_XactIsoLevel
2886 {"unix_socket_group", PGC_POSTMASTER, CONN_AUTH_SETTINGS,
2887 gettext_noop("Sets the owning group of the Unix-domain socket."),
2888 gettext_noop("The owning user of the socket is always the user "
2889 "that starts the server.")
2897 {"unix_socket_directory", PGC_POSTMASTER, CONN_AUTH_SETTINGS,
2898 gettext_noop("Sets the directory where the Unix-domain socket will be created."),
2904 check_canonical_path, NULL, NULL
2908 {"listen_addresses", PGC_POSTMASTER, CONN_AUTH_SETTINGS,
2909 gettext_noop("Sets the host name or IP address(es) to listen to."),
2919 {"data_directory", PGC_POSTMASTER, FILE_LOCATIONS,
2920 gettext_noop("Sets the server's data directory."),
2930 {"config_file", PGC_POSTMASTER, FILE_LOCATIONS,
2931 gettext_noop("Sets the server's main configuration file."),
2933 GUC_DISALLOW_IN_FILE | GUC_SUPERUSER_ONLY
2941 {"hba_file", PGC_POSTMASTER, FILE_LOCATIONS,
2942 gettext_noop("Sets the server's \"hba\" configuration file."),
2952 {"ident_file", PGC_POSTMASTER, FILE_LOCATIONS,
2953 gettext_noop("Sets the server's \"ident\" configuration file."),
2963 {"external_pid_file", PGC_POSTMASTER, FILE_LOCATIONS,
2964 gettext_noop("Writes the postmaster PID to the specified file."),
2970 check_canonical_path, NULL, NULL
2974 {"ssl_cert_file", PGC_POSTMASTER, CONN_AUTH_SECURITY,
2975 gettext_noop("Location of the SSL server certificate file."),
2984 {"ssl_key_file", PGC_POSTMASTER, CONN_AUTH_SECURITY,
2985 gettext_noop("Location of the SSL server private key file."),
2994 {"ssl_ca_file", PGC_POSTMASTER, CONN_AUTH_SECURITY,
2995 gettext_noop("Location of the SSL certificate authority file."),
3004 {"ssl_crl_file", PGC_POSTMASTER, CONN_AUTH_SECURITY,
3005 gettext_noop("Location of the SSL certificate revocation list file."),
3014 {"stats_temp_directory", PGC_SIGHUP, STATS_COLLECTOR,
3015 gettext_noop("Writes temporary statistics files to the specified directory."),
3019 &pgstat_temp_directory,
3021 check_canonical_path, assign_pgstat_temp_directory, NULL
3025 {"synchronous_standby_names", PGC_SIGHUP, REPLICATION_MASTER,
3026 gettext_noop("List of names of potential synchronous standbys."),
3030 &SyncRepStandbyNames,
3032 check_synchronous_standby_names, NULL, NULL
3036 {"default_text_search_config", PGC_USERSET, CLIENT_CONN_LOCALE,
3037 gettext_noop("Sets default text search configuration."),
3041 "pg_catalog.simple",
3042 check_TSCurrentConfig, assign_TSCurrentConfig, NULL
3046 {"ssl_ciphers", PGC_POSTMASTER, CONN_AUTH_SECURITY,
3047 gettext_noop("Sets the list of allowed SSL ciphers."),
3053 "ALL:!ADH:!LOW:!EXP:!MD5:@STRENGTH",
3061 {"application_name", PGC_USERSET, LOGGING_WHAT,
3062 gettext_noop("Sets the application name to be reported in statistics and logs."),
3064 GUC_IS_NAME | GUC_REPORT | GUC_NOT_IN_SAMPLE
3068 check_application_name, assign_application_name, NULL
3071 /* End-of-list marker */
3073 {NULL, 0, 0, NULL, NULL}, NULL, NULL, NULL, NULL, NULL
3078 static struct config_enum ConfigureNamesEnum[] =
3081 {"backslash_quote", PGC_USERSET, COMPAT_OPTIONS_PREVIOUS,
3082 gettext_noop("Sets whether \"\\'\" is allowed in string literals."),
3086 BACKSLASH_QUOTE_SAFE_ENCODING, backslash_quote_options,
3091 {"bytea_output", PGC_USERSET, CLIENT_CONN_STATEMENT,
3092 gettext_noop("Sets the output format for bytea."),
3096 BYTEA_OUTPUT_HEX, bytea_output_options,
3101 {"client_min_messages", PGC_USERSET, LOGGING_WHEN,
3102 gettext_noop("Sets the message levels that are sent to the client."),
3103 gettext_noop("Each level includes all the levels that follow it. The later"
3104 " the level, the fewer messages are sent.")
3106 &client_min_messages,
3107 NOTICE, client_message_level_options,
3112 {"constraint_exclusion", PGC_USERSET, QUERY_TUNING_OTHER,
3113 gettext_noop("Enables the planner to use constraints to optimize queries."),
3114 gettext_noop("Table scans will be skipped if their constraints"
3115 " guarantee that no rows match the query.")
3117 &constraint_exclusion,
3118 CONSTRAINT_EXCLUSION_PARTITION, constraint_exclusion_options,
3123 {"default_transaction_isolation", PGC_USERSET, CLIENT_CONN_STATEMENT,
3124 gettext_noop("Sets the transaction isolation level of each new transaction."),
3127 &DefaultXactIsoLevel,
3128 XACT_READ_COMMITTED, isolation_level_options,
3133 {"IntervalStyle", PGC_USERSET, CLIENT_CONN_LOCALE,
3134 gettext_noop("Sets the display format for interval values."),
3139 INTSTYLE_POSTGRES, intervalstyle_options,
3144 {"log_error_verbosity", PGC_SUSET, LOGGING_WHAT,
3145 gettext_noop("Sets the verbosity of logged messages."),
3148 &Log_error_verbosity,
3149 PGERROR_DEFAULT, log_error_verbosity_options,
3154 {"log_min_messages", PGC_SUSET, LOGGING_WHEN,
3155 gettext_noop("Sets the message levels that are logged."),
3156 gettext_noop("Each level includes all the levels that follow it. The later"
3157 " the level, the fewer messages are sent.")
3160 WARNING, server_message_level_options,
3165 {"log_min_error_statement", PGC_SUSET, LOGGING_WHEN,
3166 gettext_noop("Causes all statements generating error at or above this level to be logged."),
3167 gettext_noop("Each level includes all the levels that follow it. The later"
3168 " the level, the fewer messages are sent.")
3170 &log_min_error_statement,
3171 ERROR, server_message_level_options,
3176 {"log_statement", PGC_SUSET, LOGGING_WHAT,
3177 gettext_noop("Sets the type of statements logged."),
3181 LOGSTMT_NONE, log_statement_options,
3186 {"syslog_facility", PGC_SIGHUP, LOGGING_WHERE,
3187 gettext_noop("Sets the syslog \"facility\" to be used when syslog enabled."),
3196 syslog_facility_options,
3197 NULL, assign_syslog_facility, NULL
3201 {"session_replication_role", PGC_SUSET, CLIENT_CONN_STATEMENT,
3202 gettext_noop("Sets the session's behavior for triggers and rewrite rules."),
3205 &SessionReplicationRole,
3206 SESSION_REPLICATION_ROLE_ORIGIN, session_replication_role_options,
3207 NULL, assign_session_replication_role, NULL
3211 {"synchronous_commit", PGC_USERSET, WAL_SETTINGS,
3212 gettext_noop("Sets the current transaction's synchronization level."),
3215 &synchronous_commit,
3216 SYNCHRONOUS_COMMIT_ON, synchronous_commit_options,
3217 NULL, assign_synchronous_commit, NULL
3221 {"trace_recovery_messages", PGC_SIGHUP, DEVELOPER_OPTIONS,
3222 gettext_noop("Enables logging of recovery-related debugging information."),
3223 gettext_noop("Each level includes all the levels that follow it. The later"
3224 " the level, the fewer messages are sent.")
3226 &trace_recovery_messages,
3229 * client_message_level_options allows too many values, really, but
3230 * it's not worth having a separate options array for this.
3232 LOG, client_message_level_options,
3237 {"track_functions", PGC_SUSET, STATS_COLLECTOR,
3238 gettext_noop("Collects function-level statistics on database activity."),
3241 &pgstat_track_functions,
3242 TRACK_FUNC_OFF, track_function_options,
3247 {"wal_level", PGC_POSTMASTER, WAL_SETTINGS,
3248 gettext_noop("Set the level of information written to the WAL."),
3252 WAL_LEVEL_MINIMAL, wal_level_options,
3257 {"wal_sync_method", PGC_SIGHUP, WAL_SETTINGS,
3258 gettext_noop("Selects the method used for forcing WAL updates to disk."),
3262 DEFAULT_SYNC_METHOD, sync_method_options,
3263 NULL, assign_xlog_sync_method, NULL
3267 {"xmlbinary", PGC_USERSET, CLIENT_CONN_STATEMENT,
3268 gettext_noop("Sets how binary values are to be encoded in XML."),
3272 XMLBINARY_BASE64, xmlbinary_options,
3277 {"xmloption", PGC_USERSET, CLIENT_CONN_STATEMENT,
3278 gettext_noop("Sets whether XML data in implicit parsing and serialization "
3279 "operations is to be considered as documents or content fragments."),
3283 XMLOPTION_CONTENT, xmloption_options,
3288 /* End-of-list marker */
3290 {NULL, 0, 0, NULL, NULL}, NULL, 0, NULL, NULL, NULL, NULL
3294 /******** end of options list ********/
3298 * To allow continued support of obsolete names for GUC variables, we apply
3299 * the following mappings to any unrecognized name. Note that an old name
3300 * should be mapped to a new one only if the new variable has very similar
3301 * semantics to the old.
3303 static const char *const map_old_guc_names[] = {
3304 "sort_mem", "work_mem",
3305 "vacuum_mem", "maintenance_work_mem",
3311 * Actual lookup of variables is done through this single, sorted array.
3313 static struct config_generic **guc_variables;
3315 /* Current number of variables contained in the vector */
3316 static int num_guc_variables;
3318 /* Vector capacity */
3319 static int size_guc_variables;
3322 static bool guc_dirty; /* TRUE if need to do commit/abort work */
3324 static bool reporting_enabled; /* TRUE to enable GUC_REPORT */
3326 static int GUCNestLevel = 0; /* 1 when in main transaction */
3329 static int guc_var_compare(const void *a, const void *b);
3330 static int guc_name_compare(const char *namea, const char *nameb);
3331 static void InitializeGUCOptionsFromEnvironment(void);
3332 static void InitializeOneGUCOption(struct config_generic * gconf);
3333 static void push_old_value(struct config_generic * gconf, GucAction action);
3334 static void ReportGUCOption(struct config_generic * record);
3335 static void reapply_stacked_values(struct config_generic * variable,
3336 struct config_string *pHolder,
3338 const char *curvalue,
3339 GucContext curscontext, GucSource cursource);
3340 static void ShowGUCConfigOption(const char *name, DestReceiver *dest);
3341 static void ShowAllGUCConfig(DestReceiver *dest);
3342 static char *_ShowOption(struct config_generic * record, bool use_units);
3343 static bool validate_option_array_item(const char *name, const char *value,
3344 bool skipIfNoPermissions);
3348 * Some infrastructure for checking malloc/strdup/realloc calls
3351 guc_malloc(int elevel, size_t size)
3355 data = malloc(size);
3358 (errcode(ERRCODE_OUT_OF_MEMORY),
3359 errmsg("out of memory")));
3364 guc_realloc(int elevel, void *old, size_t size)
3368 data = realloc(old, size);
3371 (errcode(ERRCODE_OUT_OF_MEMORY),
3372 errmsg("out of memory")));
3377 guc_strdup(int elevel, const char *src)
3384 (errcode(ERRCODE_OUT_OF_MEMORY),
3385 errmsg("out of memory")));
3391 * Detect whether strval is referenced anywhere in a GUC string item
3394 string_field_used(struct config_string * conf, char *strval)
3398 if (strval == *(conf->variable) ||
3399 strval == conf->reset_val ||
3400 strval == conf->boot_val)
3402 for (stack = conf->gen.stack; stack; stack = stack->prev)
3404 if (strval == stack->prior.val.stringval ||
3405 strval == stack->masked.val.stringval)
3412 * Support for assigning to a field of a string GUC item. Free the prior
3413 * value if it's not referenced anywhere else in the item (including stacked
3417 set_string_field(struct config_string * conf, char **field, char *newval)
3419 char *oldval = *field;
3421 /* Do the assignment */
3424 /* Free old value if it's not NULL and isn't referenced anymore */
3425 if (oldval && !string_field_used(conf, oldval))
3430 * Detect whether an "extra" struct is referenced anywhere in a GUC item
3433 extra_field_used(struct config_generic * gconf, void *extra)
3437 if (extra == gconf->extra)
3439 switch (gconf->vartype)
3442 if (extra == ((struct config_bool *) gconf)->reset_extra)
3446 if (extra == ((struct config_int *) gconf)->reset_extra)
3450 if (extra == ((struct config_real *) gconf)->reset_extra)
3454 if (extra == ((struct config_string *) gconf)->reset_extra)
3458 if (extra == ((struct config_enum *) gconf)->reset_extra)
3462 for (stack = gconf->stack; stack; stack = stack->prev)
3464 if (extra == stack->prior.extra ||
3465 extra == stack->masked.extra)
3473 * Support for assigning to an "extra" field of a GUC item. Free the prior
3474 * value if it's not referenced anywhere else in the item (including stacked
3478 set_extra_field(struct config_generic * gconf, void **field, void *newval)
3480 void *oldval = *field;
3482 /* Do the assignment */
3485 /* Free old value if it's not NULL and isn't referenced anymore */
3486 if (oldval && !extra_field_used(gconf, oldval))
3491 * Support for copying a variable's active value into a stack entry.
3492 * The "extra" field associated with the active value is copied, too.
3494 * NB: be sure stringval and extra fields of a new stack entry are
3495 * initialized to NULL before this is used, else we'll try to free() them.
3498 set_stack_value(struct config_generic * gconf, config_var_value *val)
3500 switch (gconf->vartype)
3504 *((struct config_bool *) gconf)->variable;
3508 *((struct config_int *) gconf)->variable;
3512 *((struct config_real *) gconf)->variable;
3515 set_string_field((struct config_string *) gconf,
3516 &(val->val.stringval),
3517 *((struct config_string *) gconf)->variable);
3521 *((struct config_enum *) gconf)->variable;
3524 set_extra_field(gconf, &(val->extra), gconf->extra);
3528 * Support for discarding a no-longer-needed value in a stack entry.
3529 * The "extra" field associated with the stack entry is cleared, too.
3532 discard_stack_value(struct config_generic * gconf, config_var_value *val)
3534 switch (gconf->vartype)
3540 /* no need to do anything */
3543 set_string_field((struct config_string *) gconf,
3544 &(val->val.stringval),
3548 set_extra_field(gconf, &(val->extra), NULL);
3553 * Fetch the sorted array pointer (exported for help_config.c's use ONLY)
3555 struct config_generic **
3556 get_guc_variables(void)
3558 return guc_variables;
3563 * Build the sorted array. This is split out so that it could be
3564 * re-executed after startup (eg, we could allow loadable modules to
3565 * add vars, and then we'd need to re-sort).
3568 build_guc_variables(void)
3572 struct config_generic **guc_vars;
3575 for (i = 0; ConfigureNamesBool[i].gen.name; i++)
3577 struct config_bool *conf = &ConfigureNamesBool[i];
3579 /* Rather than requiring vartype to be filled in by hand, do this: */
3580 conf->gen.vartype = PGC_BOOL;
3584 for (i = 0; ConfigureNamesInt[i].gen.name; i++)
3586 struct config_int *conf = &ConfigureNamesInt[i];
3588 conf->gen.vartype = PGC_INT;
3592 for (i = 0; ConfigureNamesReal[i].gen.name; i++)
3594 struct config_real *conf = &ConfigureNamesReal[i];
3596 conf->gen.vartype = PGC_REAL;
3600 for (i = 0; ConfigureNamesString[i].gen.name; i++)
3602 struct config_string *conf = &ConfigureNamesString[i];
3604 conf->gen.vartype = PGC_STRING;
3608 for (i = 0; ConfigureNamesEnum[i].gen.name; i++)
3610 struct config_enum *conf = &ConfigureNamesEnum[i];
3612 conf->gen.vartype = PGC_ENUM;
3617 * Create table with 20% slack
3619 size_vars = num_vars + num_vars / 4;
3621 guc_vars = (struct config_generic **)
3622 guc_malloc(FATAL, size_vars * sizeof(struct config_generic *));
3626 for (i = 0; ConfigureNamesBool[i].gen.name; i++)
3627 guc_vars[num_vars++] = &ConfigureNamesBool[i].gen;
3629 for (i = 0; ConfigureNamesInt[i].gen.name; i++)
3630 guc_vars[num_vars++] = &ConfigureNamesInt[i].gen;
3632 for (i = 0; ConfigureNamesReal[i].gen.name; i++)
3633 guc_vars[num_vars++] = &ConfigureNamesReal[i].gen;
3635 for (i = 0; ConfigureNamesString[i].gen.name; i++)
3636 guc_vars[num_vars++] = &ConfigureNamesString[i].gen;
3638 for (i = 0; ConfigureNamesEnum[i].gen.name; i++)
3639 guc_vars[num_vars++] = &ConfigureNamesEnum[i].gen;
3642 free(guc_variables);
3643 guc_variables = guc_vars;
3644 num_guc_variables = num_vars;
3645 size_guc_variables = size_vars;
3646 qsort((void *) guc_variables, num_guc_variables,
3647 sizeof(struct config_generic *), guc_var_compare);
3651 * Add a new GUC variable to the list of known variables. The
3652 * list is expanded if needed.
3655 add_guc_variable(struct config_generic * var, int elevel)
3657 if (num_guc_variables + 1 >= size_guc_variables)
3660 * Increase the vector by 25%
3662 int size_vars = size_guc_variables + size_guc_variables / 4;
3663 struct config_generic **guc_vars;
3668 guc_vars = (struct config_generic **)
3669 guc_malloc(elevel, size_vars * sizeof(struct config_generic *));
3673 guc_vars = (struct config_generic **)
3674 guc_realloc(elevel, guc_variables, size_vars * sizeof(struct config_generic *));
3677 if (guc_vars == NULL)
3678 return false; /* out of memory */
3680 guc_variables = guc_vars;
3681 size_guc_variables = size_vars;
3683 guc_variables[num_guc_variables++] = var;
3684 qsort((void *) guc_variables, num_guc_variables,
3685 sizeof(struct config_generic *), guc_var_compare);
3690 * Create and add a placeholder variable for a custom variable name.
3692 static struct config_generic *
3693 add_placeholder_variable(const char *name, int elevel)
3695 size_t sz = sizeof(struct config_string) + sizeof(char *);
3696 struct config_string *var;
3697 struct config_generic *gen;
3699 var = (struct config_string *) guc_malloc(elevel, sz);
3705 gen->name = guc_strdup(elevel, name);
3706 if (gen->name == NULL)
3712 gen->context = PGC_USERSET;
3713 gen->group = CUSTOM_OPTIONS;
3714 gen->short_desc = "GUC placeholder variable";
3715 gen->flags = GUC_NO_SHOW_ALL | GUC_NOT_IN_SAMPLE | GUC_CUSTOM_PLACEHOLDER;
3716 gen->vartype = PGC_STRING;
3719 * The char* is allocated at the end of the struct since we have no
3720 * 'static' place to point to. Note that the current value, as well as
3721 * the boot and reset values, start out NULL.
3723 var->variable = (char **) (var + 1);
3725 if (!add_guc_variable((struct config_generic *) var, elevel))
3727 free((void *) gen->name);
3736 * Look up option NAME. If it exists, return a pointer to its record,
3737 * else return NULL. If create_placeholders is TRUE, we'll create a
3738 * placeholder record for a valid-looking custom variable name.
3740 static struct config_generic *
3741 find_option(const char *name, bool create_placeholders, int elevel)
3743 const char **key = &name;
3744 struct config_generic **res;
3750 * By equating const char ** with struct config_generic *, we are assuming
3751 * the name field is first in config_generic.
3753 res = (struct config_generic **) bsearch((void *) &key,
3754 (void *) guc_variables,
3756 sizeof(struct config_generic *),
3762 * See if the name is an obsolete name for a variable. We assume that the
3763 * set of supported old names is short enough that a brute-force search is
3766 for (i = 0; map_old_guc_names[i] != NULL; i += 2)
3768 if (guc_name_compare(name, map_old_guc_names[i]) == 0)
3769 return find_option(map_old_guc_names[i + 1], false, elevel);
3772 if (create_placeholders)
3775 * Check if the name is qualified, and if so, add a placeholder.
3777 if (strchr(name, GUC_QUALIFIER_SEPARATOR) != NULL)
3778 return add_placeholder_variable(name, elevel);
3787 * comparator for qsorting and bsearching guc_variables array
3790 guc_var_compare(const void *a, const void *b)
3792 const struct config_generic *confa = *(struct config_generic * const *) a;
3793 const struct config_generic *confb = *(struct config_generic * const *) b;
3795 return guc_name_compare(confa->name, confb->name);
3799 * the bare comparison function for GUC names
3802 guc_name_compare(const char *namea, const char *nameb)
3805 * The temptation to use strcasecmp() here must be resisted, because the
3806 * array ordering has to remain stable across setlocale() calls. So, build
3807 * our own with a simple ASCII-only downcasing.
3809 while (*namea && *nameb)
3811 char cha = *namea++;
3812 char chb = *nameb++;
3814 if (cha >= 'A' && cha <= 'Z')
3816 if (chb >= 'A' && chb <= 'Z')
3822 return 1; /* a is longer */
3824 return -1; /* b is longer */
3830 * Initialize GUC options during program startup.
3832 * Note that we cannot read the config file yet, since we have not yet
3833 * processed command-line switches.
3836 InitializeGUCOptions(void)
3841 * Before log_line_prefix could possibly receive a nonempty setting, make
3842 * sure that timezone processing is minimally alive (see elog.c).
3844 pg_timezone_initialize();
3847 * Build sorted array of all GUC variables.
3849 build_guc_variables();
3852 * Load all variables with their compiled-in defaults, and initialize
3853 * status fields as needed.
3855 for (i = 0; i < num_guc_variables; i++)
3857 InitializeOneGUCOption(guc_variables[i]);
3862 reporting_enabled = false;
3865 * Prevent any attempt to override the transaction modes from
3866 * non-interactive sources.
3868 SetConfigOption("transaction_isolation", "default",
3869 PGC_POSTMASTER, PGC_S_OVERRIDE);
3870 SetConfigOption("transaction_read_only", "no",
3871 PGC_POSTMASTER, PGC_S_OVERRIDE);
3872 SetConfigOption("transaction_deferrable", "no",
3873 PGC_POSTMASTER, PGC_S_OVERRIDE);
3876 * For historical reasons, some GUC parameters can receive defaults from
3877 * environment variables. Process those settings.
3879 InitializeGUCOptionsFromEnvironment();
3883 * Assign any GUC values that can come from the server's environment.
3885 * This is called from InitializeGUCOptions, and also from ProcessConfigFile
3886 * to deal with the possibility that a setting has been removed from
3887 * postgresql.conf and should now get a value from the environment.
3888 * (The latter is a kludge that should probably go away someday; if so,
3889 * fold this back into InitializeGUCOptions.)
3892 InitializeGUCOptionsFromEnvironment(void)
3897 env = getenv("PGPORT");
3899 SetConfigOption("port", env, PGC_POSTMASTER, PGC_S_ENV_VAR);
3901 env = getenv("PGDATESTYLE");
3903 SetConfigOption("datestyle", env, PGC_POSTMASTER, PGC_S_ENV_VAR);
3905 env = getenv("PGCLIENTENCODING");
3907 SetConfigOption("client_encoding", env, PGC_POSTMASTER, PGC_S_ENV_VAR);
3910 * rlimit isn't exactly an "environment variable", but it behaves about
3911 * the same. If we can identify the platform stack depth rlimit, increase
3912 * default stack depth setting up to whatever is safe (but at most 2MB).
3914 stack_rlimit = get_stack_depth_rlimit();
3915 if (stack_rlimit > 0)
3917 long new_limit = (stack_rlimit - STACK_DEPTH_SLOP) / 1024L;
3919 if (new_limit > 100)
3923 new_limit = Min(new_limit, 2048);
3924 sprintf(limbuf, "%ld", new_limit);
3925 SetConfigOption("max_stack_depth", limbuf,
3926 PGC_POSTMASTER, PGC_S_ENV_VAR);
3932 * Initialize one GUC option variable to its compiled-in default.
3934 * Note: the reason for calling check_hooks is not that we think the boot_val
3935 * might fail, but that the hooks might wish to compute an "extra" struct.
3938 InitializeOneGUCOption(struct config_generic * gconf)
3941 gconf->source = PGC_S_DEFAULT;
3942 gconf->reset_source = PGC_S_DEFAULT;
3943 gconf->scontext = PGC_INTERNAL;
3944 gconf->reset_scontext = PGC_INTERNAL;
3945 gconf->stack = NULL;
3946 gconf->extra = NULL;
3947 gconf->sourcefile = NULL;
3948 gconf->sourceline = 0;
3950 switch (gconf->vartype)
3954 struct config_bool *conf = (struct config_bool *) gconf;
3955 bool newval = conf->boot_val;
3958 if (!call_bool_check_hook(conf, &newval, &extra,
3959 PGC_S_DEFAULT, LOG))
3960 elog(FATAL, "failed to initialize %s to %d",
3961 conf->gen.name, (int) newval);
3962 if (conf->assign_hook)
3963 (*conf->assign_hook) (newval, extra);
3964 *conf->variable = conf->reset_val = newval;
3965 conf->gen.extra = conf->reset_extra = extra;
3970 struct config_int *conf = (struct config_int *) gconf;
3971 int newval = conf->boot_val;
3974 Assert(newval >= conf->min);
3975 Assert(newval <= conf->max);
3976 if (!call_int_check_hook(conf, &newval, &extra,
3977 PGC_S_DEFAULT, LOG))
3978 elog(FATAL, "failed to initialize %s to %d",
3979 conf->gen.name, newval);
3980 if (conf->assign_hook)
3981 (*conf->assign_hook) (newval, extra);
3982 *conf->variable = conf->reset_val = newval;
3983 conf->gen.extra = conf->reset_extra = extra;
3988 struct config_real *conf = (struct config_real *) gconf;
3989 double newval = conf->boot_val;
3992 Assert(newval >= conf->min);
3993 Assert(newval <= conf->max);
3994 if (!call_real_check_hook(conf, &newval, &extra,
3995 PGC_S_DEFAULT, LOG))
3996 elog(FATAL, "failed to initialize %s to %g",
3997 conf->gen.name, newval);
3998 if (conf->assign_hook)
3999 (*conf->assign_hook) (newval, extra);
4000 *conf->variable = conf->reset_val = newval;
4001 conf->gen.extra = conf->reset_extra = extra;
4006 struct config_string *conf = (struct config_string *) gconf;
4010 /* non-NULL boot_val must always get strdup'd */
4011 if (conf->boot_val != NULL)
4012 newval = guc_strdup(FATAL, conf->boot_val);
4016 if (!call_string_check_hook(conf, &newval, &extra,
4017 PGC_S_DEFAULT, LOG))
4018 elog(FATAL, "failed to initialize %s to \"%s\"",
4019 conf->gen.name, newval ? newval : "");
4020 if (conf->assign_hook)
4021 (*conf->assign_hook) (newval, extra);
4022 *conf->variable = conf->reset_val = newval;
4023 conf->gen.extra = conf->reset_extra = extra;
4028 struct config_enum *conf = (struct config_enum *) gconf;
4029 int newval = conf->boot_val;
4032 if (!call_enum_check_hook(conf, &newval, &extra,
4033 PGC_S_DEFAULT, LOG))
4034 elog(FATAL, "failed to initialize %s to %d",
4035 conf->gen.name, newval);
4036 if (conf->assign_hook)
4037 (*conf->assign_hook) (newval, extra);
4038 *conf->variable = conf->reset_val = newval;
4039 conf->gen.extra = conf->reset_extra = extra;
4047 * Select the configuration files and data directory to be used, and
4048 * do the initial read of postgresql.conf.
4050 * This is called after processing command-line switches.
4051 * userDoption is the -D switch value if any (NULL if unspecified).
4052 * progname is just for use in error messages.
4054 * Returns true on success; on failure, prints a suitable error message
4055 * to stderr and returns false.
4058 SelectConfigFiles(const char *userDoption, const char *progname)
4062 struct stat stat_buf;
4064 /* configdir is -D option, or $PGDATA if no -D */
4066 configdir = make_absolute_path(userDoption);
4068 configdir = make_absolute_path(getenv("PGDATA"));
4071 * Find the configuration file: if config_file was specified on the
4072 * command line, use it, else use configdir/postgresql.conf. In any case
4073 * ensure the result is an absolute path, so that it will be interpreted
4074 * the same way by future backends.
4077 fname = make_absolute_path(ConfigFileName);
4080 fname = guc_malloc(FATAL,
4081 strlen(configdir) + strlen(CONFIG_FILENAME) + 2);
4082 sprintf(fname, "%s/%s", configdir, CONFIG_FILENAME);
4086 write_stderr("%s does not know where to find the server configuration file.\n"
4087 "You must specify the --config-file or -D invocation "
4088 "option or set the PGDATA environment variable.\n",
4094 * Set the ConfigFileName GUC variable to its final value, ensuring that
4095 * it can't be overridden later.
4097 SetConfigOption("config_file", fname, PGC_POSTMASTER, PGC_S_OVERRIDE);
4101 * Now read the config file for the first time.
4103 if (stat(ConfigFileName, &stat_buf) != 0)
4105 write_stderr("%s cannot access the server configuration file \"%s\": %s\n",
4106 progname, ConfigFileName, strerror(errno));
4111 ProcessConfigFile(PGC_POSTMASTER);
4114 * If the data_directory GUC variable has been set, use that as DataDir;
4115 * otherwise use configdir if set; else punt.
4117 * Note: SetDataDir will copy and absolute-ize its argument, so we don't
4121 SetDataDir(data_directory);
4123 SetDataDir(configdir);
4126 write_stderr("%s does not know where to find the database system data.\n"
4127 "This can be specified as \"data_directory\" in \"%s\", "
4128 "or by the -D invocation option, or by the "
4129 "PGDATA environment variable.\n",
4130 progname, ConfigFileName);
4135 * Reflect the final DataDir value back into the data_directory GUC var.
4136 * (If you are wondering why we don't just make them a single variable,
4137 * it's because the EXEC_BACKEND case needs DataDir to be transmitted to
4138 * child backends specially. XXX is that still true? Given that we now
4139 * chdir to DataDir, EXEC_BACKEND can read the config file without knowing
4140 * DataDir in advance.)
4142 SetConfigOption("data_directory", DataDir, PGC_POSTMASTER, PGC_S_OVERRIDE);
4145 * If timezone_abbreviations wasn't set in the configuration file, install
4146 * the default value. We do it this way because we can't safely install
4147 * a "real" value until my_exec_path is set, which may not have happened
4148 * when InitializeGUCOptions runs, so the bootstrap default value cannot
4149 * be the real desired default.
4151 pg_timezone_abbrev_initialize();
4154 * Figure out where pg_hba.conf is, and make sure the path is absolute.
4157 fname = make_absolute_path(HbaFileName);
4160 fname = guc_malloc(FATAL,
4161 strlen(configdir) + strlen(HBA_FILENAME) + 2);
4162 sprintf(fname, "%s/%s", configdir, HBA_FILENAME);
4166 write_stderr("%s does not know where to find the \"hba\" configuration file.\n"
4167 "This can be specified as \"hba_file\" in \"%s\", "
4168 "or by the -D invocation option, or by the "
4169 "PGDATA environment variable.\n",
4170 progname, ConfigFileName);
4173 SetConfigOption("hba_file", fname, PGC_POSTMASTER, PGC_S_OVERRIDE);
4177 * Likewise for pg_ident.conf.
4180 fname = make_absolute_path(IdentFileName);
4183 fname = guc_malloc(FATAL,
4184 strlen(configdir) + strlen(IDENT_FILENAME) + 2);
4185 sprintf(fname, "%s/%s", configdir, IDENT_FILENAME);
4189 write_stderr("%s does not know where to find the \"ident\" configuration file.\n"
4190 "This can be specified as \"ident_file\" in \"%s\", "
4191 "or by the -D invocation option, or by the "
4192 "PGDATA environment variable.\n",
4193 progname, ConfigFileName);
4196 SetConfigOption("ident_file", fname, PGC_POSTMASTER, PGC_S_OVERRIDE);
4206 * Reset all options to their saved default values (implements RESET ALL)
4209 ResetAllOptions(void)
4213 for (i = 0; i < num_guc_variables; i++)
4215 struct config_generic *gconf = guc_variables[i];
4217 /* Don't reset non-SET-able values */
4218 if (gconf->context != PGC_SUSET &&
4219 gconf->context != PGC_USERSET)
4221 /* Don't reset if special exclusion from RESET ALL */
4222 if (gconf->flags & GUC_NO_RESET_ALL)
4224 /* No need to reset if wasn't SET */
4225 if (gconf->source <= PGC_S_OVERRIDE)
4228 /* Save old value to support transaction abort */
4229 push_old_value(gconf, GUC_ACTION_SET);
4231 switch (gconf->vartype)
4235 struct config_bool *conf = (struct config_bool *) gconf;
4237 if (conf->assign_hook)
4238 (*conf->assign_hook) (conf->reset_val,
4240 *conf->variable = conf->reset_val;
4241 set_extra_field(&conf->gen, &conf->gen.extra,
4247 struct config_int *conf = (struct config_int *) gconf;
4249 if (conf->assign_hook)
4250 (*conf->assign_hook) (conf->reset_val,
4252 *conf->variable = conf->reset_val;
4253 set_extra_field(&conf->gen, &conf->gen.extra,
4259 struct config_real *conf = (struct config_real *) gconf;
4261 if (conf->assign_hook)
4262 (*conf->assign_hook) (conf->reset_val,
4264 *conf->variable = conf->reset_val;
4265 set_extra_field(&conf->gen, &conf->gen.extra,
4271 struct config_string *conf = (struct config_string *) gconf;
4273 if (conf->assign_hook)
4274 (*conf->assign_hook) (conf->reset_val,
4276 set_string_field(conf, conf->variable, conf->reset_val);
4277 set_extra_field(&conf->gen, &conf->gen.extra,
4283 struct config_enum *conf = (struct config_enum *) gconf;
4285 if (conf->assign_hook)
4286 (*conf->assign_hook) (conf->reset_val,
4288 *conf->variable = conf->reset_val;
4289 set_extra_field(&conf->gen, &conf->gen.extra,
4295 gconf->source = gconf->reset_source;
4296 gconf->scontext = gconf->reset_scontext;
4298 if (gconf->flags & GUC_REPORT)
4299 ReportGUCOption(gconf);
4306 * Push previous state during transactional assignment to a GUC variable.
4309 push_old_value(struct config_generic * gconf, GucAction action)
4313 /* If we're not inside a nest level, do nothing */
4314 if (GUCNestLevel == 0)
4317 /* Do we already have a stack entry of the current nest level? */
4318 stack = gconf->stack;
4319 if (stack && stack->nest_level >= GUCNestLevel)
4321 /* Yes, so adjust its state if necessary */
4322 Assert(stack->nest_level == GUCNestLevel);
4325 case GUC_ACTION_SET:
4326 /* SET overrides any prior action at same nest level */
4327 if (stack->state == GUC_SET_LOCAL)
4329 /* must discard old masked value */
4330 discard_stack_value(gconf, &stack->masked);
4332 stack->state = GUC_SET;
4334 case GUC_ACTION_LOCAL:
4335 if (stack->state == GUC_SET)
4337 /* SET followed by SET LOCAL, remember SET's value */
4338 stack->masked_scontext = gconf->scontext;
4339 set_stack_value(gconf, &stack->masked);
4340 stack->state = GUC_SET_LOCAL;
4342 /* in all other cases, no change to stack entry */
4344 case GUC_ACTION_SAVE:
4345 /* Could only have a prior SAVE of same variable */
4346 Assert(stack->state == GUC_SAVE);
4349 Assert(guc_dirty); /* must be set already */
4354 * Push a new stack entry
4356 * We keep all the stack entries in TopTransactionContext for simplicity.
4358 stack = (GucStack *) MemoryContextAllocZero(TopTransactionContext,
4361 stack->prev = gconf->stack;
4362 stack->nest_level = GUCNestLevel;
4365 case GUC_ACTION_SET:
4366 stack->state = GUC_SET;
4368 case GUC_ACTION_LOCAL:
4369 stack->state = GUC_LOCAL;
4371 case GUC_ACTION_SAVE:
4372 stack->state = GUC_SAVE;
4375 stack->source = gconf->source;
4376 stack->scontext = gconf->scontext;
4377 set_stack_value(gconf, &stack->prior);
4379 gconf->stack = stack;
4381 /* Ensure we remember to pop at end of xact */
4387 * Do GUC processing at main transaction start.
4393 * The nest level should be 0 between transactions; if it isn't, somebody
4394 * didn't call AtEOXact_GUC, or called it with the wrong nestLevel. We
4395 * throw a warning but make no other effort to clean up.
4397 if (GUCNestLevel != 0)
4398 elog(WARNING, "GUC nest level = %d at transaction start",
4404 * Enter a new nesting level for GUC values. This is called at subtransaction
4405 * start, and when entering a function that has proconfig settings, and in
4406 * some other places where we want to set GUC variables transiently.
4407 * NOTE we must not risk error here, else subtransaction start will be unhappy.
4410 NewGUCNestLevel(void)
4412 return ++GUCNestLevel;
4416 * Do GUC processing at transaction or subtransaction commit or abort, or
4417 * when exiting a function that has proconfig settings, or when undoing a
4418 * transient assignment to some GUC variables. (The name is thus a bit of
4419 * a misnomer; perhaps it should be ExitGUCNestLevel or some such.)
4420 * During abort, we discard all GUC settings that were applied at nesting
4421 * levels >= nestLevel. nestLevel == 1 corresponds to the main transaction.
4424 AtEOXact_GUC(bool isCommit, int nestLevel)
4430 * Note: it's possible to get here with GUCNestLevel == nestLevel-1 during
4431 * abort, if there is a failure during transaction start before
4432 * AtStart_GUC is called.
4434 Assert(nestLevel > 0 &&
4435 (nestLevel <= GUCNestLevel ||
4436 (nestLevel == GUCNestLevel + 1 && !isCommit)));
4438 /* Quick exit if nothing's changed in this transaction */
4441 GUCNestLevel = nestLevel - 1;
4445 still_dirty = false;
4446 for (i = 0; i < num_guc_variables; i++)
4448 struct config_generic *gconf = guc_variables[i];
4452 * Process and pop each stack entry within the nest level. To simplify
4453 * fmgr_security_definer() and other places that use GUC_ACTION_SAVE,
4454 * we allow failure exit from code that uses a local nest level to be
4455 * recovered at the surrounding transaction or subtransaction abort;
4456 * so there could be more than one stack entry to pop.
4458 while ((stack = gconf->stack) != NULL &&
4459 stack->nest_level >= nestLevel)
4461 GucStack *prev = stack->prev;
4462 bool restorePrior = false;
4463 bool restoreMasked = false;
4467 * In this next bit, if we don't set either restorePrior or
4468 * restoreMasked, we must "discard" any unwanted fields of the
4469 * stack entries to avoid leaking memory. If we do set one of
4470 * those flags, unused fields will be cleaned up after restoring.
4472 if (!isCommit) /* if abort, always restore prior value */
4473 restorePrior = true;
4474 else if (stack->state == GUC_SAVE)
4475 restorePrior = true;
4476 else if (stack->nest_level == 1)
4478 /* transaction commit */
4479 if (stack->state == GUC_SET_LOCAL)
4480 restoreMasked = true;
4481 else if (stack->state == GUC_SET)
4483 /* we keep the current active value */
4484 discard_stack_value(gconf, &stack->prior);
4486 else /* must be GUC_LOCAL */
4487 restorePrior = true;
4489 else if (prev == NULL ||
4490 prev->nest_level < stack->nest_level - 1)
4492 /* decrement entry's level and do not pop it */
4493 stack->nest_level--;
4499 * We have to merge this stack entry into prev. See README for
4500 * discussion of this bit.
4502 switch (stack->state)
4505 Assert(false); /* can't get here */
4508 /* next level always becomes SET */
4509 discard_stack_value(gconf, &stack->prior);
4510 if (prev->state == GUC_SET_LOCAL)
4511 discard_stack_value(gconf, &prev->masked);
4512 prev->state = GUC_SET;
4516 if (prev->state == GUC_SET)
4518 /* LOCAL migrates down */
4519 prev->masked_scontext = stack->scontext;
4520 prev->masked = stack->prior;
4521 prev->state = GUC_SET_LOCAL;
4525 /* else just forget this stack level */
4526 discard_stack_value(gconf, &stack->prior);
4531 /* prior state at this level no longer wanted */
4532 discard_stack_value(gconf, &stack->prior);
4533 /* copy down the masked state */
4534 prev->masked_scontext = stack->masked_scontext;
4535 if (prev->state == GUC_SET_LOCAL)
4536 discard_stack_value(gconf, &prev->masked);
4537 prev->masked = stack->masked;
4538 prev->state = GUC_SET_LOCAL;
4545 if (restorePrior || restoreMasked)
4547 /* Perform appropriate restoration of the stacked value */
4548 config_var_value newvalue;
4549 GucSource newsource;
4550 GucContext newscontext;
4554 newvalue = stack->masked;
4555 newsource = PGC_S_SESSION;
4556 newscontext = stack->masked_scontext;
4560 newvalue = stack->prior;
4561 newsource = stack->source;
4562 newscontext = stack->scontext;
4565 switch (gconf->vartype)
4569 struct config_bool *conf = (struct config_bool *) gconf;
4570 bool newval = newvalue.val.boolval;
4571 void *newextra = newvalue.extra;
4573 if (*conf->variable != newval ||
4574 conf->gen.extra != newextra)
4576 if (conf->assign_hook)
4577 (*conf->assign_hook) (newval, newextra);
4578 *conf->variable = newval;
4579 set_extra_field(&conf->gen, &conf->gen.extra,
4587 struct config_int *conf = (struct config_int *) gconf;
4588 int newval = newvalue.val.intval;
4589 void *newextra = newvalue.extra;
4591 if (*conf->variable != newval ||
4592 conf->gen.extra != newextra)
4594 if (conf->assign_hook)
4595 (*conf->assign_hook) (newval, newextra);
4596 *conf->variable = newval;
4597 set_extra_field(&conf->gen, &conf->gen.extra,
4605 struct config_real *conf = (struct config_real *) gconf;
4606 double newval = newvalue.val.realval;
4607 void *newextra = newvalue.extra;
4609 if (*conf->variable != newval ||
4610 conf->gen.extra != newextra)
4612 if (conf->assign_hook)
4613 (*conf->assign_hook) (newval, newextra);
4614 *conf->variable = newval;
4615 set_extra_field(&conf->gen, &conf->gen.extra,
4623 struct config_string *conf = (struct config_string *) gconf;
4624 char *newval = newvalue.val.stringval;
4625 void *newextra = newvalue.extra;
4627 if (*conf->variable != newval ||
4628 conf->gen.extra != newextra)
4630 if (conf->assign_hook)
4631 (*conf->assign_hook) (newval, newextra);
4632 set_string_field(conf, conf->variable, newval);
4633 set_extra_field(&conf->gen, &conf->gen.extra,
4639 * Release stacked values if not used anymore. We
4640 * could use discard_stack_value() here, but since
4641 * we have type-specific code anyway, might as
4644 set_string_field(conf, &stack->prior.val.stringval, NULL);
4645 set_string_field(conf, &stack->masked.val.stringval, NULL);
4650 struct config_enum *conf = (struct config_enum *) gconf;
4651 int newval = newvalue.val.enumval;
4652 void *newextra = newvalue.extra;
4654 if (*conf->variable != newval ||
4655 conf->gen.extra != newextra)
4657 if (conf->assign_hook)
4658 (*conf->assign_hook) (newval, newextra);
4659 *conf->variable = newval;
4660 set_extra_field(&conf->gen, &conf->gen.extra,
4669 * Release stacked extra values if not used anymore.
4671 set_extra_field(gconf, &(stack->prior.extra), NULL);
4672 set_extra_field(gconf, &(stack->masked.extra), NULL);
4674 /* And restore source information */
4675 gconf->source = newsource;
4676 gconf->scontext = newscontext;
4679 /* Finish popping the state stack */
4680 gconf->stack = prev;
4683 /* Report new value if we changed it */
4684 if (changed && (gconf->flags & GUC_REPORT))
4685 ReportGUCOption(gconf);
4686 } /* end of stack-popping loop */
4692 /* If there are no remaining stack entries, we can reset guc_dirty */
4693 guc_dirty = still_dirty;
4695 /* Update nesting level */
4696 GUCNestLevel = nestLevel - 1;
4701 * Start up automatic reporting of changes to variables marked GUC_REPORT.
4702 * This is executed at completion of backend startup.
4705 BeginReportingGUCOptions(void)
4710 * Don't do anything unless talking to an interactive frontend of protocol
4713 if (whereToSendOutput != DestRemote ||
4714 PG_PROTOCOL_MAJOR(FrontendProtocol) < 3)
4717 reporting_enabled = true;
4719 /* Transmit initial values of interesting variables */
4720 for (i = 0; i < num_guc_variables; i++)
4722 struct config_generic *conf = guc_variables[i];
4724 if (conf->flags & GUC_REPORT)
4725 ReportGUCOption(conf);
4730 * ReportGUCOption: if appropriate, transmit option value to frontend
4733 ReportGUCOption(struct config_generic * record)
4735 if (reporting_enabled && (record->flags & GUC_REPORT))
4737 char *val = _ShowOption(record, false);
4738 StringInfoData msgbuf;
4740 pq_beginmessage(&msgbuf, 'S');
4741 pq_sendstring(&msgbuf, record->name);
4742 pq_sendstring(&msgbuf, val);
4743 pq_endmessage(&msgbuf);
4750 * Try to parse value as an integer. The accepted formats are the
4751 * usual decimal, octal, or hexadecimal formats, optionally followed by
4752 * a unit name if "flags" indicates a unit is allowed.
4754 * If the string parses okay, return true, else false.
4755 * If okay and result is not NULL, return the value in *result.
4756 * If not okay and hintmsg is not NULL, *hintmsg is set to a suitable
4757 * HINT message, or NULL if no hint provided.
4760 parse_int(const char *value, int *result, int flags, const char **hintmsg)
4765 /* To suppress compiler warnings, always set output params */
4771 /* We assume here that int64 is at least as wide as long */
4773 val = strtol(value, &endptr, 0);
4775 if (endptr == value)
4776 return false; /* no HINT for integer syntax error */
4778 if (errno == ERANGE || val != (int64) ((int32) val))
4781 *hintmsg = gettext_noop("Value exceeds integer range.");
4785 /* allow whitespace between integer and unit */
4786 while (isspace((unsigned char) *endptr))
4789 /* Handle possible unit */
4790 if (*endptr != '\0')
4793 * Note: the multiple-switch coding technique here is a bit tedious,
4794 * but seems necessary to avoid intermediate-value overflows.
4796 if (flags & GUC_UNIT_MEMORY)
4798 /* Set hint for use if no match or trailing garbage */
4800 *hintmsg = gettext_noop("Valid units for this parameter are \"kB\", \"MB\", and \"GB\".");
4802 #if BLCKSZ < 1024 || BLCKSZ > (1024*1024)
4803 #error BLCKSZ must be between 1KB and 1MB
4805 #if XLOG_BLCKSZ < 1024 || XLOG_BLCKSZ > (1024*1024)
4806 #error XLOG_BLCKSZ must be between 1KB and 1MB
4809 if (strncmp(endptr, "kB", 2) == 0)
4812 switch (flags & GUC_UNIT_MEMORY)
4814 case GUC_UNIT_BLOCKS:
4815 val /= (BLCKSZ / 1024);
4817 case GUC_UNIT_XBLOCKS:
4818 val /= (XLOG_BLCKSZ / 1024);
4822 else if (strncmp(endptr, "MB", 2) == 0)
4825 switch (flags & GUC_UNIT_MEMORY)
4830 case GUC_UNIT_BLOCKS:
4831 val *= KB_PER_MB / (BLCKSZ / 1024);
4833 case GUC_UNIT_XBLOCKS:
4834 val *= KB_PER_MB / (XLOG_BLCKSZ / 1024);
4838 else if (strncmp(endptr, "GB", 2) == 0)
4841 switch (flags & GUC_UNIT_MEMORY)
4846 case GUC_UNIT_BLOCKS:
4847 val *= KB_PER_GB / (BLCKSZ / 1024);
4849 case GUC_UNIT_XBLOCKS:
4850 val *= KB_PER_GB / (XLOG_BLCKSZ / 1024);
4855 else if (flags & GUC_UNIT_TIME)
4857 /* Set hint for use if no match or trailing garbage */
4859 *hintmsg = gettext_noop("Valid units for this parameter are \"ms\", \"s\", \"min\", \"h\", and \"d\".");
4861 if (strncmp(endptr, "ms", 2) == 0)
4864 switch (flags & GUC_UNIT_TIME)
4874 else if (strncmp(endptr, "s", 1) == 0)
4877 switch (flags & GUC_UNIT_TIME)
4887 else if (strncmp(endptr, "min", 3) == 0)
4890 switch (flags & GUC_UNIT_TIME)
4900 else if (strncmp(endptr, "h", 1) == 0)
4903 switch (flags & GUC_UNIT_TIME)
4916 else if (strncmp(endptr, "d", 1) == 0)
4919 switch (flags & GUC_UNIT_TIME)
4934 /* allow whitespace after unit */
4935 while (isspace((unsigned char) *endptr))
4938 if (*endptr != '\0')
4939 return false; /* appropriate hint, if any, already set */
4941 /* Check for overflow due to units conversion */
4942 if (val != (int64) ((int32) val))
4945 *hintmsg = gettext_noop("Value exceeds integer range.");
4951 *result = (int) val;
4958 * Try to parse value as a floating point number in the usual format.
4959 * If the string parses okay, return true, else false.
4960 * If okay and result is not NULL, return the value in *result.
4963 parse_real(const char *value, double *result)
4969 *result = 0; /* suppress compiler warning */
4972 val = strtod(value, &endptr);
4973 if (endptr == value || errno == ERANGE)
4976 /* allow whitespace after number */
4977 while (isspace((unsigned char) *endptr))
4979 if (*endptr != '\0')
4989 * Lookup the name for an enum option with the selected value.
4990 * Should only ever be called with known-valid values, so throws
4991 * an elog(ERROR) if the enum option is not found.
4993 * The returned string is a pointer to static data and not
4994 * allocated for modification.
4997 config_enum_lookup_by_value(struct config_enum * record, int val)
4999 const struct config_enum_entry *entry;
5001 for (entry = record->options; entry && entry->name; entry++)
5003 if (entry->val == val)
5007 elog(ERROR, "could not find enum option %d for %s",
5008 val, record->gen.name);
5009 return NULL; /* silence compiler */
5014 * Lookup the value for an enum option with the selected name
5015 * (case-insensitive).
5016 * If the enum option is found, sets the retval value and returns
5017 * true. If it's not found, return FALSE and retval is set to 0.
5020 config_enum_lookup_by_name(struct config_enum * record, const char *value,
5023 const struct config_enum_entry *entry;
5025 for (entry = record->options; entry && entry->name; entry++)
5027 if (pg_strcasecmp(value, entry->name) == 0)
5029 *retval = entry->val;
5040 * Return a list of all available options for an enum, excluding
5041 * hidden ones, separated by the given separator.
5042 * If prefix is non-NULL, it is added before the first enum value.
5043 * If suffix is non-NULL, it is added to the end of the string.
5046 config_enum_get_options(struct config_enum * record, const char *prefix,
5047 const char *suffix, const char *separator)
5049 const struct config_enum_entry *entry;
5050 StringInfoData retstr;
5053 initStringInfo(&retstr);
5054 appendStringInfoString(&retstr, prefix);
5056 seplen = strlen(separator);
5057 for (entry = record->options; entry && entry->name; entry++)
5061 appendStringInfoString(&retstr, entry->name);
5062 appendBinaryStringInfo(&retstr, separator, seplen);
5067 * All the entries may have been hidden, leaving the string empty if no
5068 * prefix was given. This indicates a broken GUC setup, since there is no
5069 * use for an enum without any values, so we just check to make sure we
5070 * don't write to invalid memory instead of actually trying to do
5071 * something smart with it.
5073 if (retstr.len >= seplen)
5075 /* Replace final separator */
5076 retstr.data[retstr.len - seplen] = '\0';
5077 retstr.len -= seplen;
5080 appendStringInfoString(&retstr, suffix);
5087 * Sets option `name' to given value.
5089 * The value should be a string, which will be parsed and converted to
5090 * the appropriate data type. The context and source parameters indicate
5091 * in which context this function is being called, so that it can apply the
5092 * access restrictions properly.
5094 * If value is NULL, set the option to its default value (normally the
5095 * reset_val, but if source == PGC_S_DEFAULT we instead use the boot_val).
5097 * action indicates whether to set the value globally in the session, locally
5098 * to the current top transaction, or just for the duration of a function call.
5100 * If changeVal is false then don't really set the option but do all
5101 * the checks to see if it would work.
5103 * elevel should normally be passed as zero, allowing this function to make
5104 * its standard choice of ereport level. However some callers need to be
5105 * able to override that choice; they should pass the ereport level to use.
5108 * +1: the value is valid and was successfully applied.
5109 * 0: the name or value is invalid (but see below).
5110 * -1: the value was not applied because of context, priority, or changeVal.
5112 * If there is an error (non-existing option, invalid value) then an
5113 * ereport(ERROR) is thrown *unless* this is called for a source for which
5114 * we don't want an ERROR (currently, those are defaults, the config file,
5115 * and per-database or per-user settings, as well as callers who specify
5116 * a less-than-ERROR elevel). In those cases we write a suitable error
5117 * message via ereport() and return 0.
5119 * See also SetConfigOption for an external interface.
5122 set_config_option(const char *name, const char *value,
5123 GucContext context, GucSource source,
5124 GucAction action, bool changeVal, int elevel)
5126 struct config_generic *record;
5127 bool prohibitValueChange = false;
5132 if (source == PGC_S_DEFAULT || source == PGC_S_FILE)
5135 * To avoid cluttering the log, only the postmaster bleats loudly
5136 * about problems with the config file.
5138 elevel = IsUnderPostmaster ? DEBUG3 : LOG;
5140 else if (source == PGC_S_DATABASE || source == PGC_S_USER ||
5141 source == PGC_S_DATABASE_USER)
5147 record = find_option(name, true, elevel);
5151 (errcode(ERRCODE_UNDEFINED_OBJECT),
5152 errmsg("unrecognized configuration parameter \"%s\"", name)));
5157 * Check if the option can be set at this time. See guc.h for the precise
5160 switch (record->context)
5163 if (context != PGC_INTERNAL)
5166 (errcode(ERRCODE_CANT_CHANGE_RUNTIME_PARAM),
5167 errmsg("parameter \"%s\" cannot be changed",
5172 case PGC_POSTMASTER:
5173 if (context == PGC_SIGHUP)
5176 * We are re-reading a PGC_POSTMASTER variable from
5177 * postgresql.conf. We can't change the setting, so we should
5178 * give a warning if the DBA tries to change it. However,
5179 * because of variant formats, canonicalization by check
5180 * hooks, etc, we can't just compare the given string directly
5181 * to what's stored. Set a flag to check below after we have
5182 * the final storable value.
5184 prohibitValueChange = true;
5186 else if (context != PGC_POSTMASTER)
5189 (errcode(ERRCODE_CANT_CHANGE_RUNTIME_PARAM),
5190 errmsg("parameter \"%s\" cannot be changed without restarting the server",
5196 if (context != PGC_SIGHUP && context != PGC_POSTMASTER)
5199 (errcode(ERRCODE_CANT_CHANGE_RUNTIME_PARAM),
5200 errmsg("parameter \"%s\" cannot be changed now",
5206 * Hmm, the idea of the SIGHUP context is "ought to be global, but
5207 * can be changed after postmaster start". But there's nothing
5208 * that prevents a crafty administrator from sending SIGHUP
5209 * signals to individual backends only.
5213 if (context == PGC_SIGHUP)
5216 * If a PGC_BACKEND parameter is changed in the config file,
5217 * we want to accept the new value in the postmaster (whence
5218 * it will propagate to subsequently-started backends), but
5219 * ignore it in existing backends. This is a tad klugy, but
5220 * necessary because we don't re-read the config file during
5223 if (IsUnderPostmaster)
5226 else if (context != PGC_POSTMASTER && context != PGC_BACKEND &&
5227 source != PGC_S_CLIENT)
5230 (errcode(ERRCODE_CANT_CHANGE_RUNTIME_PARAM),
5231 errmsg("parameter \"%s\" cannot be set after connection start",
5237 if (context == PGC_USERSET || context == PGC_BACKEND)
5240 (errcode(ERRCODE_INSUFFICIENT_PRIVILEGE),
5241 errmsg("permission denied to set parameter \"%s\"",
5252 * Disallow changing GUC_NOT_WHILE_SEC_REST values if we are inside a
5253 * security restriction context. We can reject this regardless of the GUC
5254 * context or source, mainly because sources that it might be reasonable
5255 * to override for won't be seen while inside a function.
5257 * Note: variables marked GUC_NOT_WHILE_SEC_REST should usually be marked
5258 * GUC_NO_RESET_ALL as well, because ResetAllOptions() doesn't check this.
5259 * An exception might be made if the reset value is assumed to be "safe".
5261 * Note: this flag is currently used for "session_authorization" and
5262 * "role". We need to prohibit changing these inside a local userid
5263 * context because when we exit it, GUC won't be notified, leaving things
5264 * out of sync. (This could be fixed by forcing a new GUC nesting level,
5265 * but that would change behavior in possibly-undesirable ways.) Also, we
5266 * prohibit changing these in a security-restricted operation because
5267 * otherwise RESET could be used to regain the session user's privileges.
5269 if (record->flags & GUC_NOT_WHILE_SEC_REST)
5271 if (InLocalUserIdChange())
5274 * Phrasing of this error message is historical, but it's the most
5278 (errcode(ERRCODE_INSUFFICIENT_PRIVILEGE),
5279 errmsg("cannot set parameter \"%s\" within security-definer function",
5283 if (InSecurityRestrictedOperation())
5286 (errcode(ERRCODE_INSUFFICIENT_PRIVILEGE),
5287 errmsg("cannot set parameter \"%s\" within security-restricted operation",
5294 * Should we set reset/stacked values? (If so, the behavior is not
5295 * transactional.) This is done either when we get a default value from
5296 * the database's/user's/client's default settings or when we reset a
5297 * value to its default.
5299 makeDefault = changeVal && (source <= PGC_S_OVERRIDE) &&
5300 ((value != NULL) || source == PGC_S_DEFAULT);
5303 * Ignore attempted set if overridden by previously processed setting.
5304 * However, if changeVal is false then plow ahead anyway since we are
5305 * trying to find out if the value is potentially good, not actually use
5306 * it. Also keep going if makeDefault is true, since we may want to set
5307 * the reset/stacked values even if we can't set the variable itself.
5309 if (record->source > source)
5311 if (changeVal && !makeDefault)
5313 elog(DEBUG3, "\"%s\": setting ignored because previous source is higher priority",
5321 * Evaluate value and set variable.
5323 switch (record->vartype)
5327 struct config_bool *conf = (struct config_bool *) record;
5329 void *newextra = NULL;
5333 if (!parse_bool(value, &newval))
5336 (errcode(ERRCODE_INVALID_PARAMETER_VALUE),
5337 errmsg("parameter \"%s\" requires a Boolean value",
5341 if (!call_bool_check_hook(conf, &newval, &newextra,
5345 else if (source == PGC_S_DEFAULT)
5347 newval = conf->boot_val;
5348 if (!call_bool_check_hook(conf, &newval, &newextra,
5354 newval = conf->reset_val;
5355 newextra = conf->reset_extra;
5356 source = conf->gen.reset_source;
5357 context = conf->gen.reset_scontext;
5360 if (prohibitValueChange)
5362 if (*conf->variable != newval)
5365 (errcode(ERRCODE_CANT_CHANGE_RUNTIME_PARAM),
5366 errmsg("parameter \"%s\" cannot be changed without restarting the server",
5375 /* Save old value to support transaction abort */
5377 push_old_value(&conf->gen, action);
5379 if (conf->assign_hook)
5380 (*conf->assign_hook) (newval, newextra);
5381 *conf->variable = newval;
5382 set_extra_field(&conf->gen, &conf->gen.extra,
5384 conf->gen.source = source;
5385 conf->gen.scontext = context;
5391 if (conf->gen.reset_source <= source)
5393 conf->reset_val = newval;
5394 set_extra_field(&conf->gen, &conf->reset_extra,
5396 conf->gen.reset_source = source;
5397 conf->gen.reset_scontext = context;
5399 for (stack = conf->gen.stack; stack; stack = stack->prev)
5401 if (stack->source <= source)
5403 stack->prior.val.boolval = newval;
5404 set_extra_field(&conf->gen, &stack->prior.extra,
5406 stack->source = source;
5407 stack->scontext = context;
5412 /* Perhaps we didn't install newextra anywhere */
5413 if (newextra && !extra_field_used(&conf->gen, newextra))
5420 struct config_int *conf = (struct config_int *) record;
5422 void *newextra = NULL;
5426 const char *hintmsg;
5428 if (!parse_int(value, &newval, conf->gen.flags, &hintmsg))
5431 (errcode(ERRCODE_INVALID_PARAMETER_VALUE),
5432 errmsg("invalid value for parameter \"%s\": \"%s\"",
5434 hintmsg ? errhint("%s", _(hintmsg)) : 0));
5437 if (newval < conf->min || newval > conf->max)
5440 (errcode(ERRCODE_INVALID_PARAMETER_VALUE),
5441 errmsg("%d is outside the valid range for parameter \"%s\" (%d .. %d)",
5442 newval, name, conf->min, conf->max)));
5445 if (!call_int_check_hook(conf, &newval, &newextra,
5449 else if (source == PGC_S_DEFAULT)
5451 newval = conf->boot_val;
5452 if (!call_int_check_hook(conf, &newval, &newextra,
5458 newval = conf->reset_val;
5459 newextra = conf->reset_extra;
5460 source = conf->gen.reset_source;
5461 context = conf->gen.reset_scontext;
5464 if (prohibitValueChange)
5466 if (*conf->variable != newval)
5469 (errcode(ERRCODE_CANT_CHANGE_RUNTIME_PARAM),
5470 errmsg("parameter \"%s\" cannot be changed without restarting the server",
5479 /* Save old value to support transaction abort */
5481 push_old_value(&conf->gen, action);
5483 if (conf->assign_hook)
5484 (*conf->assign_hook) (newval, newextra);
5485 *conf->variable = newval;
5486 set_extra_field(&conf->gen, &conf->gen.extra,
5488 conf->gen.source = source;
5489 conf->gen.scontext = context;
5495 if (conf->gen.reset_source <= source)
5497 conf->reset_val = newval;
5498 set_extra_field(&conf->gen, &conf->reset_extra,
5500 conf->gen.reset_source = source;
5501 conf->gen.reset_scontext = context;
5503 for (stack = conf->gen.stack; stack; stack = stack->prev)
5505 if (stack->source <= source)
5507 stack->prior.val.intval = newval;
5508 set_extra_field(&conf->gen, &stack->prior.extra,
5510 stack->source = source;
5511 stack->scontext = context;
5516 /* Perhaps we didn't install newextra anywhere */
5517 if (newextra && !extra_field_used(&conf->gen, newextra))
5524 struct config_real *conf = (struct config_real *) record;
5526 void *newextra = NULL;
5530 if (!parse_real(value, &newval))
5533 (errcode(ERRCODE_INVALID_PARAMETER_VALUE),
5534 errmsg("parameter \"%s\" requires a numeric value",
5538 if (newval < conf->min || newval > conf->max)
5541 (errcode(ERRCODE_INVALID_PARAMETER_VALUE),
5542 errmsg("%g is outside the valid range for parameter \"%s\" (%g .. %g)",
5543 newval, name, conf->min, conf->max)));
5546 if (!call_real_check_hook(conf, &newval, &newextra,
5550 else if (source == PGC_S_DEFAULT)
5552 newval = conf->boot_val;
5553 if (!call_real_check_hook(conf, &newval, &newextra,
5559 newval = conf->reset_val;
5560 newextra = conf->reset_extra;
5561 source = conf->gen.reset_source;
5562 context = conf->gen.reset_scontext;
5565 if (prohibitValueChange)
5567 if (*conf->variable != newval)
5570 (errcode(ERRCODE_CANT_CHANGE_RUNTIME_PARAM),
5571 errmsg("parameter \"%s\" cannot be changed without restarting the server",
5580 /* Save old value to support transaction abort */
5582 push_old_value(&conf->gen, action);
5584 if (conf->assign_hook)
5585 (*conf->assign_hook) (newval, newextra);
5586 *conf->variable = newval;
5587 set_extra_field(&conf->gen, &conf->gen.extra,
5589 conf->gen.source = source;
5590 conf->gen.scontext = context;
5596 if (conf->gen.reset_source <= source)
5598 conf->reset_val = newval;
5599 set_extra_field(&conf->gen, &conf->reset_extra,
5601 conf->gen.reset_source = source;
5602 conf->gen.reset_scontext = context;
5604 for (stack = conf->gen.stack; stack; stack = stack->prev)
5606 if (stack->source <= source)
5608 stack->prior.val.realval = newval;
5609 set_extra_field(&conf->gen, &stack->prior.extra,
5611 stack->source = source;
5612 stack->scontext = context;
5617 /* Perhaps we didn't install newextra anywhere */
5618 if (newextra && !extra_field_used(&conf->gen, newextra))
5625 struct config_string *conf = (struct config_string *) record;
5627 void *newextra = NULL;
5632 * The value passed by the caller could be transient, so
5633 * we always strdup it.
5635 newval = guc_strdup(elevel, value);
5640 * The only built-in "parsing" check we have is to apply
5641 * truncation if GUC_IS_NAME.
5643 if (conf->gen.flags & GUC_IS_NAME)
5644 truncate_identifier(newval, strlen(newval), true);
5646 if (!call_string_check_hook(conf, &newval, &newextra,
5653 else if (source == PGC_S_DEFAULT)
5655 /* non-NULL boot_val must always get strdup'd */
5656 if (conf->boot_val != NULL)
5658 newval = guc_strdup(elevel, conf->boot_val);
5665 if (!call_string_check_hook(conf, &newval, &newextra,
5675 * strdup not needed, since reset_val is already under
5678 newval = conf->reset_val;
5679 newextra = conf->reset_extra;
5680 source = conf->gen.reset_source;
5681 context = conf->gen.reset_scontext;
5684 if (prohibitValueChange)
5686 /* newval shouldn't be NULL, so we're a bit sloppy here */
5687 if (*conf->variable == NULL || newval == NULL ||
5688 strcmp(*conf->variable, newval) != 0)
5691 (errcode(ERRCODE_CANT_CHANGE_RUNTIME_PARAM),
5692 errmsg("parameter \"%s\" cannot be changed without restarting the server",
5701 /* Save old value to support transaction abort */
5703 push_old_value(&conf->gen, action);
5705 if (conf->assign_hook)
5706 (*conf->assign_hook) (newval, newextra);
5707 set_string_field(conf, conf->variable, newval);
5708 set_extra_field(&conf->gen, &conf->gen.extra,
5710 conf->gen.source = source;
5711 conf->gen.scontext = context;
5718 if (conf->gen.reset_source <= source)
5720 set_string_field(conf, &conf->reset_val, newval);
5721 set_extra_field(&conf->gen, &conf->reset_extra,
5723 conf->gen.reset_source = source;
5724 conf->gen.reset_scontext = context;
5726 for (stack = conf->gen.stack; stack; stack = stack->prev)
5728 if (stack->source <= source)
5730 set_string_field(conf, &stack->prior.val.stringval,
5732 set_extra_field(&conf->gen, &stack->prior.extra,
5734 stack->source = source;
5735 stack->scontext = context;
5740 /* Perhaps we didn't install newval anywhere */
5741 if (newval && !string_field_used(conf, newval))
5743 /* Perhaps we didn't install newextra anywhere */
5744 if (newextra && !extra_field_used(&conf->gen, newextra))
5751 struct config_enum *conf = (struct config_enum *) record;
5753 void *newextra = NULL;
5757 if (!config_enum_lookup_by_name(conf, value, &newval))
5761 hintmsg = config_enum_get_options(conf,
5762 "Available values: ",
5766 (errcode(ERRCODE_INVALID_PARAMETER_VALUE),
5767 errmsg("invalid value for parameter \"%s\": \"%s\"",
5769 hintmsg ? errhint("%s", _(hintmsg)) : 0));
5775 if (!call_enum_check_hook(conf, &newval, &newextra,
5779 else if (source == PGC_S_DEFAULT)
5781 newval = conf->boot_val;
5782 if (!call_enum_check_hook(conf, &newval, &newextra,
5788 newval = conf->reset_val;
5789 newextra = conf->reset_extra;
5790 source = conf->gen.reset_source;
5791 context = conf->gen.reset_scontext;
5794 if (prohibitValueChange)
5796 if (*conf->variable != newval)
5799 (errcode(ERRCODE_CANT_CHANGE_RUNTIME_PARAM),
5800 errmsg("parameter \"%s\" cannot be changed without restarting the server",
5809 /* Save old value to support transaction abort */
5811 push_old_value(&conf->gen, action);
5813 if (conf->assign_hook)
5814 (*conf->assign_hook) (newval, newextra);
5815 *conf->variable = newval;
5816 set_extra_field(&conf->gen, &conf->gen.extra,
5818 conf->gen.source = source;
5819 conf->gen.scontext = context;
5825 if (conf->gen.reset_source <= source)
5827 conf->reset_val = newval;
5828 set_extra_field(&conf->gen, &conf->reset_extra,
5830 conf->gen.reset_source = source;
5831 conf->gen.reset_scontext = context;
5833 for (stack = conf->gen.stack; stack; stack = stack->prev)
5835 if (stack->source <= source)
5837 stack->prior.val.enumval = newval;
5838 set_extra_field(&conf->gen, &stack->prior.extra,
5840 stack->source = source;
5841 stack->scontext = context;
5846 /* Perhaps we didn't install newextra anywhere */
5847 if (newextra && !extra_field_used(&conf->gen, newextra))
5853 if (changeVal && (record->flags & GUC_REPORT))
5854 ReportGUCOption(record);
5856 return changeVal ? 1 : -1;
5861 * Set the fields for source file and line number the setting came from.
5864 set_config_sourcefile(const char *name, char *sourcefile, int sourceline)
5866 struct config_generic *record;
5870 * To avoid cluttering the log, only the postmaster bleats loudly about
5871 * problems with the config file.
5873 elevel = IsUnderPostmaster ? DEBUG3 : LOG;
5875 record = find_option(name, true, elevel);
5876 /* should not happen */
5878 elog(ERROR, "unrecognized configuration parameter \"%s\"", name);
5880 sourcefile = guc_strdup(elevel, sourcefile);
5881 if (record->sourcefile)
5882 free(record->sourcefile);
5883 record->sourcefile = sourcefile;
5884 record->sourceline = sourceline;
5888 * Set a config option to the given value.
5890 * See also set_config_option; this is just the wrapper to be called from
5891 * outside GUC. (This function should be used when possible, because its API
5892 * is more stable than set_config_option's.)
5894 * Note: there is no support here for setting source file/line, as it
5895 * is currently not needed.
5898 SetConfigOption(const char *name, const char *value,
5899 GucContext context, GucSource source)
5901 (void) set_config_option(name, value, context, source,
5902 GUC_ACTION_SET, true, 0);
5908 * Fetch the current value of the option `name', as a string.
5910 * If the option doesn't exist, return NULL if missing_ok is true (NOTE that
5911 * this cannot be distinguished from a string variable with a NULL value!),
5912 * otherwise throw an ereport and don't return.
5914 * If restrict_superuser is true, we also enforce that only superusers can
5915 * see GUC_SUPERUSER_ONLY variables. This should only be passed as true
5916 * in user-driven calls.
5918 * The string is *not* allocated for modification and is really only
5919 * valid until the next call to configuration related functions.
5922 GetConfigOption(const char *name, bool missing_ok, bool restrict_superuser)
5924 struct config_generic *record;
5925 static char buffer[256];
5927 record = find_option(name, false, ERROR);
5933 (errcode(ERRCODE_UNDEFINED_OBJECT),
5934 errmsg("unrecognized configuration parameter \"%s\"",
5937 if (restrict_superuser &&
5938 (record->flags & GUC_SUPERUSER_ONLY) &&
5941 (errcode(ERRCODE_INSUFFICIENT_PRIVILEGE),
5942 errmsg("must be superuser to examine \"%s\"", name)));
5944 switch (record->vartype)
5947 return *((struct config_bool *) record)->variable ? "on" : "off";
5950 snprintf(buffer, sizeof(buffer), "%d",
5951 *((struct config_int *) record)->variable);
5955 snprintf(buffer, sizeof(buffer), "%g",
5956 *((struct config_real *) record)->variable);
5960 return *((struct config_string *) record)->variable;
5963 return config_enum_lookup_by_value((struct config_enum *) record,
5964 *((struct config_enum *) record)->variable);
5970 * Get the RESET value associated with the given option.
5972 * Note: this is not re-entrant, due to use of static result buffer;
5973 * not to mention that a string variable could have its reset_val changed.
5974 * Beware of assuming the result value is good for very long.
5977 GetConfigOptionResetString(const char *name)
5979 struct config_generic *record;
5980 static char buffer[256];
5982 record = find_option(name, false, ERROR);
5985 (errcode(ERRCODE_UNDEFINED_OBJECT),
5986 errmsg("unrecognized configuration parameter \"%s\"", name)));
5987 if ((record->flags & GUC_SUPERUSER_ONLY) && !superuser())
5989 (errcode(ERRCODE_INSUFFICIENT_PRIVILEGE),
5990 errmsg("must be superuser to examine \"%s\"", name)));
5992 switch (record->vartype)
5995 return ((struct config_bool *) record)->reset_val ? "on" : "off";
5998 snprintf(buffer, sizeof(buffer), "%d",
5999 ((struct config_int *) record)->reset_val);
6003 snprintf(buffer, sizeof(buffer), "%g",
6004 ((struct config_real *) record)->reset_val);
6008 return ((struct config_string *) record)->reset_val;
6011 return config_enum_lookup_by_value((struct config_enum *) record,
6012 ((struct config_enum *) record)->reset_val);
6019 * flatten_set_variable_args
6020 * Given a parsenode List as emitted by the grammar for SET,
6021 * convert to the flat string representation used by GUC.
6023 * We need to be told the name of the variable the args are for, because
6024 * the flattening rules vary (ugh).
6026 * The result is NULL if args is NIL (ie, SET ... TO DEFAULT), otherwise
6027 * a palloc'd string.
6030 flatten_set_variable_args(const char *name, List *args)
6032 struct config_generic *record;
6037 /* Fast path if just DEFAULT */
6042 * Get flags for the variable; if it's not known, use default flags.
6043 * (Caller might throw error later, but not our business to do so here.)
6045 record = find_option(name, false, WARNING);
6047 flags = record->flags;
6051 /* Complain if list input and non-list variable */
6052 if ((flags & GUC_LIST_INPUT) == 0 &&
6053 list_length(args) != 1)
6055 (errcode(ERRCODE_INVALID_PARAMETER_VALUE),
6056 errmsg("SET %s takes only one argument", name)));
6058 initStringInfo(&buf);
6061 * Each list member may be a plain A_Const node, or an A_Const within a
6062 * TypeCast; the latter case is supported only for ConstInterval arguments
6063 * (for SET TIME ZONE).
6067 Node *arg = (Node *) lfirst(l);
6069 TypeName *typeName = NULL;
6072 if (l != list_head(args))
6073 appendStringInfo(&buf, ", ");
6075 if (IsA(arg, TypeCast))
6077 TypeCast *tc = (TypeCast *) arg;
6080 typeName = tc->typeName;
6083 if (!IsA(arg, A_Const))
6084 elog(ERROR, "unrecognized node type: %d", (int) nodeTag(arg));
6085 con = (A_Const *) arg;
6087 switch (nodeTag(&con->val))
6090 appendStringInfo(&buf, "%ld", intVal(&con->val));
6093 /* represented as a string, so just copy it */
6094 appendStringInfoString(&buf, strVal(&con->val));
6097 val = strVal(&con->val);
6098 if (typeName != NULL)
6101 * Must be a ConstInterval argument for TIME ZONE. Coerce
6102 * to interval and back to normalize the value and account
6110 typenameTypeIdAndMod(NULL, typeName, &typoid, &typmod);
6111 Assert(typoid == INTERVALOID);
6114 DirectFunctionCall3(interval_in,
6115 CStringGetDatum(val),
6116 ObjectIdGetDatum(InvalidOid),
6117 Int32GetDatum(typmod));
6120 DatumGetCString(DirectFunctionCall1(interval_out,
6122 appendStringInfo(&buf, "INTERVAL '%s'", intervalout);
6127 * Plain string literal or identifier. For quote mode,
6128 * quote it if it's not a vanilla identifier.
6130 if (flags & GUC_LIST_QUOTE)
6131 appendStringInfoString(&buf, quote_identifier(val));
6133 appendStringInfoString(&buf, val);
6137 elog(ERROR, "unrecognized node type: %d",
6138 (int) nodeTag(&con->val));
6151 ExecSetVariableStmt(VariableSetStmt *stmt)
6153 GucAction action = stmt->is_local ? GUC_ACTION_LOCAL : GUC_ACTION_SET;
6158 case VAR_SET_CURRENT:
6159 (void) set_config_option(stmt->name,
6160 ExtractSetVariableArgs(stmt),
6161 (superuser() ? PGC_SUSET : PGC_USERSET),
6170 * Special-case SQL syntaxes. The TRANSACTION and SESSION
6171 * CHARACTERISTICS cases effectively set more than one variable
6172 * per statement. TRANSACTION SNAPSHOT only takes one argument,
6173 * but we put it here anyway since it's a special case and not
6174 * related to any GUC variable.
6176 if (strcmp(stmt->name, "TRANSACTION") == 0)
6180 foreach(head, stmt->args)
6182 DefElem *item = (DefElem *) lfirst(head);
6184 if (strcmp(item->defname, "transaction_isolation") == 0)
6185 SetPGVariable("transaction_isolation",
6186 list_make1(item->arg), stmt->is_local);
6187 else if (strcmp(item->defname, "transaction_read_only") == 0)
6188 SetPGVariable("transaction_read_only",
6189 list_make1(item->arg), stmt->is_local);
6190 else if (strcmp(item->defname, "transaction_deferrable") == 0)
6191 SetPGVariable("transaction_deferrable",
6192 list_make1(item->arg), stmt->is_local);
6194 elog(ERROR, "unexpected SET TRANSACTION element: %s",
6198 else if (strcmp(stmt->name, "SESSION CHARACTERISTICS") == 0)
6202 foreach(head, stmt->args)
6204 DefElem *item = (DefElem *) lfirst(head);
6206 if (strcmp(item->defname, "transaction_isolation") == 0)
6207 SetPGVariable("default_transaction_isolation",
6208 list_make1(item->arg), stmt->is_local);
6209 else if (strcmp(item->defname, "transaction_read_only") == 0)
6210 SetPGVariable("default_transaction_read_only",
6211 list_make1(item->arg), stmt->is_local);
6212 else if (strcmp(item->defname, "transaction_deferrable") == 0)
6213 SetPGVariable("default_transaction_deferrable",
6214 list_make1(item->arg), stmt->is_local);
6216 elog(ERROR, "unexpected SET SESSION element: %s",
6220 else if (strcmp(stmt->name, "TRANSACTION SNAPSHOT") == 0)
6222 A_Const *con = (A_Const *) linitial(stmt->args);
6226 (errcode(ERRCODE_FEATURE_NOT_SUPPORTED),
6227 errmsg("SET LOCAL TRANSACTION SNAPSHOT is not implemented")));
6228 Assert(IsA(con, A_Const));
6229 Assert(nodeTag(&con->val) == T_String);
6230 ImportSnapshot(strVal(&con->val));
6233 elog(ERROR, "unexpected SET MULTI element: %s",
6236 case VAR_SET_DEFAULT:
6238 (void) set_config_option(stmt->name,
6240 (superuser() ? PGC_SUSET : PGC_USERSET),
6253 * Get the value to assign for a VariableSetStmt, or NULL if it's RESET.
6254 * The result is palloc'd.
6256 * This is exported for use by actions such as ALTER ROLE SET.
6259 ExtractSetVariableArgs(VariableSetStmt *stmt)
6264 return flatten_set_variable_args(stmt->name, stmt->args);
6265 case VAR_SET_CURRENT:
6266 return GetConfigOptionByName(stmt->name, NULL);
6273 * SetPGVariable - SET command exported as an easily-C-callable function.
6275 * This provides access to SET TO value, as well as SET TO DEFAULT (expressed
6276 * by passing args == NIL), but not SET FROM CURRENT functionality.
6279 SetPGVariable(const char *name, List *args, bool is_local)
6281 char *argstring = flatten_set_variable_args(name, args);
6283 /* Note SET DEFAULT (argstring == NULL) is equivalent to RESET */
6284 (void) set_config_option(name,
6286 (superuser() ? PGC_SUSET : PGC_USERSET),
6288 is_local ? GUC_ACTION_LOCAL : GUC_ACTION_SET,
6294 * SET command wrapped as a SQL callable function.
6297 set_config_by_name(PG_FUNCTION_ARGS)
6304 if (PG_ARGISNULL(0))
6306 (errcode(ERRCODE_NULL_VALUE_NOT_ALLOWED),
6307 errmsg("SET requires parameter name")));
6309 /* Get the GUC variable name */
6310 name = TextDatumGetCString(PG_GETARG_DATUM(0));
6312 /* Get the desired value or set to NULL for a reset request */
6313 if (PG_ARGISNULL(1))
6316 value = TextDatumGetCString(PG_GETARG_DATUM(1));
6319 * Get the desired state of is_local. Default to false if provided value
6322 if (PG_ARGISNULL(2))
6325 is_local = PG_GETARG_BOOL(2);
6327 /* Note SET DEFAULT (argstring == NULL) is equivalent to RESET */
6328 (void) set_config_option(name,
6330 (superuser() ? PGC_SUSET : PGC_USERSET),
6332 is_local ? GUC_ACTION_LOCAL : GUC_ACTION_SET,
6336 /* get the new current value */
6337 new_value = GetConfigOptionByName(name, NULL);
6339 /* Convert return string to text */
6340 PG_RETURN_TEXT_P(cstring_to_text(new_value));
6345 * Common code for DefineCustomXXXVariable subroutines: allocate the
6346 * new variable's config struct and fill in generic fields.
6348 static struct config_generic *
6349 init_custom_variable(const char *name,
6350 const char *short_desc,
6351 const char *long_desc,
6354 enum config_type type,
6357 struct config_generic *gen;
6360 * Only allow custom PGC_POSTMASTER variables to be created during shared
6361 * library preload; any later than that, we can't ensure that the value
6362 * doesn't change after startup. This is a fatal elog if it happens; just
6363 * erroring out isn't safe because we don't know what the calling loadable
6364 * module might already have hooked into.
6366 if (context == PGC_POSTMASTER &&
6367 !process_shared_preload_libraries_in_progress)
6368 elog(FATAL, "cannot create PGC_POSTMASTER variables after startup");
6370 gen = (struct config_generic *) guc_malloc(ERROR, sz);
6373 gen->name = guc_strdup(ERROR, name);
6374 gen->context = context;
6375 gen->group = CUSTOM_OPTIONS;
6376 gen->short_desc = short_desc;
6377 gen->long_desc = long_desc;
6379 gen->vartype = type;
6385 * Common code for DefineCustomXXXVariable subroutines: insert the new
6386 * variable into the GUC variable array, replacing any placeholder.
6389 define_custom_variable(struct config_generic * variable)
6391 const char *name = variable->name;
6392 const char **nameAddr = &name;
6393 struct config_string *pHolder;
6394 struct config_generic **res;
6397 * See if there's a placeholder by the same name.
6399 res = (struct config_generic **) bsearch((void *) &nameAddr,
6400 (void *) guc_variables,
6402 sizeof(struct config_generic *),
6407 * No placeholder to replace, so we can just add it ... but first,
6408 * make sure it's initialized to its default value.
6410 InitializeOneGUCOption(variable);
6411 add_guc_variable(variable, ERROR);
6416 * This better be a placeholder
6418 if (((*res)->flags & GUC_CUSTOM_PLACEHOLDER) == 0)
6420 (errcode(ERRCODE_INTERNAL_ERROR),
6421 errmsg("attempt to redefine parameter \"%s\"", name)));
6423 Assert((*res)->vartype == PGC_STRING);
6424 pHolder = (struct config_string *) (*res);
6427 * First, set the variable to its default value. We must do this even
6428 * though we intend to immediately apply a new value, since it's possible
6429 * that the new value is invalid.
6431 InitializeOneGUCOption(variable);
6434 * Replace the placeholder. We aren't changing the name, so no re-sorting
6440 * Assign the string value(s) stored in the placeholder to the real
6441 * variable. Essentially, we need to duplicate all the active and stacked
6442 * values, but with appropriate validation and datatype adjustment.
6444 * If an assignment fails, we report a WARNING and keep going. We don't
6445 * want to throw ERROR for bad values, because it'd bollix the add-on
6446 * module that's presumably halfway through getting loaded. In such cases
6447 * the default or previous state will become active instead.
6450 /* First, apply the reset value if any */
6451 if (pHolder->reset_val)
6452 (void) set_config_option(name, pHolder->reset_val,
6453 pHolder->gen.reset_scontext,
6454 pHolder->gen.reset_source,
6455 GUC_ACTION_SET, true, WARNING);
6456 /* That should not have resulted in stacking anything */
6457 Assert(variable->stack == NULL);
6459 /* Now, apply current and stacked values, in the order they were stacked */
6460 reapply_stacked_values(variable, pHolder, pHolder->gen.stack,
6461 *(pHolder->variable),
6462 pHolder->gen.scontext, pHolder->gen.source);
6464 /* Also copy over any saved source-location information */
6465 if (pHolder->gen.sourcefile)
6466 set_config_sourcefile(name, pHolder->gen.sourcefile,
6467 pHolder->gen.sourceline);
6470 * Free up as much as we conveniently can of the placeholder structure.
6471 * (This neglects any stack items, so it's possible for some memory to be
6472 * leaked. Since this can only happen once per session per variable, it
6473 * doesn't seem worth spending much code on.)
6475 set_string_field(pHolder, pHolder->variable, NULL);
6476 set_string_field(pHolder, &pHolder->reset_val, NULL);
6482 * Recursive subroutine for define_custom_variable: reapply non-reset values
6484 * We recurse so that the values are applied in the same order as originally.
6485 * At each recursion level, apply the upper-level value (passed in) in the
6486 * fashion implied by the stack entry.
6489 reapply_stacked_values(struct config_generic * variable,
6490 struct config_string *pHolder,
6492 const char *curvalue,
6493 GucContext curscontext, GucSource cursource)
6495 const char *name = variable->name;
6496 GucStack *oldvarstack = variable->stack;
6500 /* First, recurse, so that stack items are processed bottom to top */
6501 reapply_stacked_values(variable, pHolder, stack->prev,
6502 stack->prior.val.stringval,
6503 stack->scontext, stack->source);
6505 /* See how to apply the passed-in value */
6506 switch (stack->state)
6509 (void) set_config_option(name, curvalue,
6510 curscontext, cursource,
6511 GUC_ACTION_SAVE, true, WARNING);
6515 (void) set_config_option(name, curvalue,
6516 curscontext, cursource,
6517 GUC_ACTION_SET, true, WARNING);
6521 (void) set_config_option(name, curvalue,
6522 curscontext, cursource,
6523 GUC_ACTION_LOCAL, true, WARNING);
6527 /* first, apply the masked value as SET */
6528 (void) set_config_option(name, stack->masked.val.stringval,
6529 stack->masked_scontext, PGC_S_SESSION,
6530 GUC_ACTION_SET, true, WARNING);
6531 /* then apply the current value as LOCAL */
6532 (void) set_config_option(name, curvalue,
6533 curscontext, cursource,
6534 GUC_ACTION_LOCAL, true, WARNING);
6538 /* If we successfully made a stack entry, adjust its nest level */
6539 if (variable->stack != oldvarstack)
6540 variable->stack->nest_level = stack->nest_level;
6545 * We are at the end of the stack. If the active/previous value is
6546 * different from the reset value, it must represent a previously
6547 * committed session value. Apply it, and then drop the stack entry
6548 * that set_config_option will have created under the impression that
6549 * this is to be just a transactional assignment. (We leak the stack
6552 if (curvalue != pHolder->reset_val ||
6553 curscontext != pHolder->gen.reset_scontext ||
6554 cursource != pHolder->gen.reset_source)
6556 (void) set_config_option(name, curvalue,
6557 curscontext, cursource,
6558 GUC_ACTION_SET, true, WARNING);
6559 variable->stack = NULL;
6565 DefineCustomBoolVariable(const char *name,
6566 const char *short_desc,
6567 const char *long_desc,
6572 GucBoolCheckHook check_hook,
6573 GucBoolAssignHook assign_hook,
6574 GucShowHook show_hook)
6576 struct config_bool *var;
6578 var = (struct config_bool *)
6579 init_custom_variable(name, short_desc, long_desc, context, flags,
6580 PGC_BOOL, sizeof(struct config_bool));
6581 var->variable = valueAddr;
6582 var->boot_val = bootValue;
6583 var->reset_val = bootValue;
6584 var->check_hook = check_hook;
6585 var->assign_hook = assign_hook;
6586 var->show_hook = show_hook;
6587 define_custom_variable(&var->gen);
6591 DefineCustomIntVariable(const char *name,
6592 const char *short_desc,
6593 const char *long_desc,
6600 GucIntCheckHook check_hook,
6601 GucIntAssignHook assign_hook,
6602 GucShowHook show_hook)
6604 struct config_int *var;
6606 var = (struct config_int *)
6607 init_custom_variable(name, short_desc, long_desc, context, flags,
6608 PGC_INT, sizeof(struct config_int));
6609 var->variable = valueAddr;
6610 var->boot_val = bootValue;
6611 var->reset_val = bootValue;
6612 var->min = minValue;
6613 var->max = maxValue;
6614 var->check_hook = check_hook;
6615 var->assign_hook = assign_hook;
6616 var->show_hook = show_hook;
6617 define_custom_variable(&var->gen);
6621 DefineCustomRealVariable(const char *name,
6622 const char *short_desc,
6623 const char *long_desc,
6630 GucRealCheckHook check_hook,
6631 GucRealAssignHook assign_hook,
6632 GucShowHook show_hook)
6634 struct config_real *var;
6636 var = (struct config_real *)
6637 init_custom_variable(name, short_desc, long_desc, context, flags,
6638 PGC_REAL, sizeof(struct config_real));
6639 var->variable = valueAddr;
6640 var->boot_val = bootValue;
6641 var->reset_val = bootValue;
6642 var->min = minValue;
6643 var->max = maxValue;
6644 var->check_hook = check_hook;
6645 var->assign_hook = assign_hook;
6646 var->show_hook = show_hook;
6647 define_custom_variable(&var->gen);
6651 DefineCustomStringVariable(const char *name,
6652 const char *short_desc,
6653 const char *long_desc,
6655 const char *bootValue,
6658 GucStringCheckHook check_hook,
6659 GucStringAssignHook assign_hook,
6660 GucShowHook show_hook)
6662 struct config_string *var;
6664 var = (struct config_string *)
6665 init_custom_variable(name, short_desc, long_desc, context, flags,
6666 PGC_STRING, sizeof(struct config_string));
6667 var->variable = valueAddr;
6668 var->boot_val = bootValue;
6669 var->check_hook = check_hook;
6670 var->assign_hook = assign_hook;
6671 var->show_hook = show_hook;
6672 define_custom_variable(&var->gen);
6676 DefineCustomEnumVariable(const char *name,
6677 const char *short_desc,
6678 const char *long_desc,
6681 const struct config_enum_entry * options,
6684 GucEnumCheckHook check_hook,
6685 GucEnumAssignHook assign_hook,
6686 GucShowHook show_hook)
6688 struct config_enum *var;
6690 var = (struct config_enum *)
6691 init_custom_variable(name, short_desc, long_desc, context, flags,
6692 PGC_ENUM, sizeof(struct config_enum));
6693 var->variable = valueAddr;
6694 var->boot_val = bootValue;
6695 var->reset_val = bootValue;
6696 var->options = options;
6697 var->check_hook = check_hook;
6698 var->assign_hook = assign_hook;
6699 var->show_hook = show_hook;
6700 define_custom_variable(&var->gen);
6704 EmitWarningsOnPlaceholders(const char *className)
6706 int classLen = strlen(className);
6709 for (i = 0; i < num_guc_variables; i++)
6711 struct config_generic *var = guc_variables[i];
6713 if ((var->flags & GUC_CUSTOM_PLACEHOLDER) != 0 &&
6714 strncmp(className, var->name, classLen) == 0 &&
6715 var->name[classLen] == GUC_QUALIFIER_SEPARATOR)
6718 (errcode(ERRCODE_UNDEFINED_OBJECT),
6719 errmsg("unrecognized configuration parameter \"%s\"",
6730 GetPGVariable(const char *name, DestReceiver *dest)
6732 if (guc_name_compare(name, "all") == 0)
6733 ShowAllGUCConfig(dest);
6735 ShowGUCConfigOption(name, dest);
6739 GetPGVariableResultDesc(const char *name)
6743 if (guc_name_compare(name, "all") == 0)
6745 /* need a tuple descriptor representing three TEXT columns */
6746 tupdesc = CreateTemplateTupleDesc(3, false);
6747 TupleDescInitEntry(tupdesc, (AttrNumber) 1, "name",
6749 TupleDescInitEntry(tupdesc, (AttrNumber) 2, "setting",
6751 TupleDescInitEntry(tupdesc, (AttrNumber) 3, "description",
6756 const char *varname;
6758 /* Get the canonical spelling of name */
6759 (void) GetConfigOptionByName(name, &varname);
6761 /* need a tuple descriptor representing a single TEXT column */
6762 tupdesc = CreateTemplateTupleDesc(1, false);
6763 TupleDescInitEntry(tupdesc, (AttrNumber) 1, varname,
6774 ShowGUCConfigOption(const char *name, DestReceiver *dest)
6776 TupOutputState *tstate;
6778 const char *varname;
6781 /* Get the value and canonical spelling of name */
6782 value = GetConfigOptionByName(name, &varname);
6784 /* need a tuple descriptor representing a single TEXT column */
6785 tupdesc = CreateTemplateTupleDesc(1, false);
6786 TupleDescInitEntry(tupdesc, (AttrNumber) 1, varname,
6789 /* prepare for projection of tuples */
6790 tstate = begin_tup_output_tupdesc(dest, tupdesc);
6793 do_text_output_oneline(tstate, value);
6795 end_tup_output(tstate);
6802 ShowAllGUCConfig(DestReceiver *dest)
6804 bool am_superuser = superuser();
6806 TupOutputState *tstate;
6809 bool isnull[3] = {false, false, false};
6811 /* need a tuple descriptor representing three TEXT columns */
6812 tupdesc = CreateTemplateTupleDesc(3, false);
6813 TupleDescInitEntry(tupdesc, (AttrNumber) 1, "name",
6815 TupleDescInitEntry(tupdesc, (AttrNumber) 2, "setting",
6817 TupleDescInitEntry(tupdesc, (AttrNumber) 3, "description",
6820 /* prepare for projection of tuples */
6821 tstate = begin_tup_output_tupdesc(dest, tupdesc);
6823 for (i = 0; i < num_guc_variables; i++)
6825 struct config_generic *conf = guc_variables[i];
6828 if ((conf->flags & GUC_NO_SHOW_ALL) ||
6829 ((conf->flags & GUC_SUPERUSER_ONLY) && !am_superuser))
6832 /* assign to the values array */
6833 values[0] = PointerGetDatum(cstring_to_text(conf->name));
6835 setting = _ShowOption(conf, true);
6838 values[1] = PointerGetDatum(cstring_to_text(setting));
6843 values[1] = PointerGetDatum(NULL);
6847 values[2] = PointerGetDatum(cstring_to_text(conf->short_desc));
6849 /* send it to dest */
6850 do_tup_output(tstate, values, isnull);
6853 pfree(DatumGetPointer(values[0]));
6857 pfree(DatumGetPointer(values[1]));
6859 pfree(DatumGetPointer(values[2]));
6862 end_tup_output(tstate);
6866 * Return GUC variable value by name; optionally return canonical
6867 * form of name. Return value is palloc'd.
6870 GetConfigOptionByName(const char *name, const char **varname)
6872 struct config_generic *record;
6874 record = find_option(name, false, ERROR);
6877 (errcode(ERRCODE_UNDEFINED_OBJECT),
6878 errmsg("unrecognized configuration parameter \"%s\"", name)));
6879 if ((record->flags & GUC_SUPERUSER_ONLY) && !superuser())
6881 (errcode(ERRCODE_INSUFFICIENT_PRIVILEGE),
6882 errmsg("must be superuser to examine \"%s\"", name)));
6885 *varname = record->name;
6887 return _ShowOption(record, true);
6891 * Return GUC variable value by variable number; optionally return canonical
6892 * form of name. Return value is palloc'd.
6895 GetConfigOptionByNum(int varnum, const char **values, bool *noshow)
6898 struct config_generic *conf;
6900 /* check requested variable number valid */
6901 Assert((varnum >= 0) && (varnum < num_guc_variables));
6903 conf = guc_variables[varnum];
6907 if ((conf->flags & GUC_NO_SHOW_ALL) ||
6908 ((conf->flags & GUC_SUPERUSER_ONLY) && !superuser()))
6914 /* first get the generic attributes */
6917 values[0] = conf->name;
6919 /* setting : use _ShowOption in order to avoid duplicating the logic */
6920 values[1] = _ShowOption(conf, false);
6923 if (conf->vartype == PGC_INT)
6927 switch (conf->flags & (GUC_UNIT_MEMORY | GUC_UNIT_TIME))
6932 case GUC_UNIT_BLOCKS:
6933 snprintf(buf, sizeof(buf), "%dkB", BLCKSZ / 1024);
6936 case GUC_UNIT_XBLOCKS:
6937 snprintf(buf, sizeof(buf), "%dkB", XLOG_BLCKSZ / 1024);
6958 values[3] = config_group_names[conf->group];
6961 values[4] = conf->short_desc;
6964 values[5] = conf->long_desc;
6967 values[6] = GucContext_Names[conf->context];
6970 values[7] = config_type_names[conf->vartype];
6973 values[8] = GucSource_Names[conf->source];
6975 /* now get the type specifc attributes */
6976 switch (conf->vartype)
6980 struct config_bool *lconf = (struct config_bool *) conf;
6992 values[12] = pstrdup(lconf->boot_val ? "on" : "off");
6995 values[13] = pstrdup(lconf->reset_val ? "on" : "off");
7001 struct config_int *lconf = (struct config_int *) conf;
7004 snprintf(buffer, sizeof(buffer), "%d", lconf->min);
7005 values[9] = pstrdup(buffer);
7008 snprintf(buffer, sizeof(buffer), "%d", lconf->max);
7009 values[10] = pstrdup(buffer);
7015 snprintf(buffer, sizeof(buffer), "%d", lconf->boot_val);
7016 values[12] = pstrdup(buffer);
7019 snprintf(buffer, sizeof(buffer), "%d", lconf->reset_val);
7020 values[13] = pstrdup(buffer);
7026 struct config_real *lconf = (struct config_real *) conf;
7029 snprintf(buffer, sizeof(buffer), "%g", lconf->min);
7030 values[9] = pstrdup(buffer);
7033 snprintf(buffer, sizeof(buffer), "%g", lconf->max);
7034 values[10] = pstrdup(buffer);
7040 snprintf(buffer, sizeof(buffer), "%g", lconf->boot_val);
7041 values[12] = pstrdup(buffer);
7044 snprintf(buffer, sizeof(buffer), "%g", lconf->reset_val);
7045 values[13] = pstrdup(buffer);
7051 struct config_string *lconf = (struct config_string *) conf;
7063 if (lconf->boot_val == NULL)
7066 values[12] = pstrdup(lconf->boot_val);
7069 if (lconf->reset_val == NULL)
7072 values[13] = pstrdup(lconf->reset_val);
7078 struct config_enum *lconf = (struct config_enum *) conf;
7089 * NOTE! enumvals with double quotes in them are not
7092 values[11] = config_enum_get_options((struct config_enum *) conf,
7093 "{\"", "\"}", "\",\"");
7096 values[12] = pstrdup(config_enum_lookup_by_value(lconf,
7100 values[13] = pstrdup(config_enum_lookup_by_value(lconf,
7108 * should never get here, but in case we do, set 'em to NULL
7130 * If the setting came from a config file, set the source location. For
7131 * security reasons, we don't show source file/line number for
7134 if (conf->source == PGC_S_FILE && superuser())
7136 values[14] = conf->sourcefile;
7137 snprintf(buffer, sizeof(buffer), "%d", conf->sourceline);
7138 values[15] = pstrdup(buffer);
7148 * Return the total number of GUC variables
7151 GetNumConfigOptions(void)
7153 return num_guc_variables;
7157 * show_config_by_name - equiv to SHOW X command but implemented as
7161 show_config_by_name(PG_FUNCTION_ARGS)
7166 /* Get the GUC variable name */
7167 varname = TextDatumGetCString(PG_GETARG_DATUM(0));
7170 varval = GetConfigOptionByName(varname, NULL);
7172 /* Convert to text */
7173 PG_RETURN_TEXT_P(cstring_to_text(varval));
7177 * show_all_settings - equiv to SHOW ALL command but implemented as
7180 #define NUM_PG_SETTINGS_ATTS 16
7183 show_all_settings(PG_FUNCTION_ARGS)
7185 FuncCallContext *funcctx;
7189 AttInMetadata *attinmeta;
7190 MemoryContext oldcontext;
7192 /* stuff done only on the first call of the function */
7193 if (SRF_IS_FIRSTCALL())
7195 /* create a function context for cross-call persistence */
7196 funcctx = SRF_FIRSTCALL_INIT();
7199 * switch to memory context appropriate for multiple function calls
7201 oldcontext = MemoryContextSwitchTo(funcctx->multi_call_memory_ctx);
7204 * need a tuple descriptor representing NUM_PG_SETTINGS_ATTS columns
7205 * of the appropriate types
7207 tupdesc = CreateTemplateTupleDesc(NUM_PG_SETTINGS_ATTS, false);
7208 TupleDescInitEntry(tupdesc, (AttrNumber) 1, "name",
7210 TupleDescInitEntry(tupdesc, (AttrNumber) 2, "setting",
7212 TupleDescInitEntry(tupdesc, (AttrNumber) 3, "unit",
7214 TupleDescInitEntry(tupdesc, (AttrNumber) 4, "category",
7216 TupleDescInitEntry(tupdesc, (AttrNumber) 5, "short_desc",
7218 TupleDescInitEntry(tupdesc, (AttrNumber) 6, "extra_desc",
7220 TupleDescInitEntry(tupdesc, (AttrNumber) 7, "context",
7222 TupleDescInitEntry(tupdesc, (AttrNumber) 8, "vartype",
7224 TupleDescInitEntry(tupdesc, (AttrNumber) 9, "source",
7226 TupleDescInitEntry(tupdesc, (AttrNumber) 10, "min_val",
7228 TupleDescInitEntry(tupdesc, (AttrNumber) 11, "max_val",
7230 TupleDescInitEntry(tupdesc, (AttrNumber) 12, "enumvals",
7231 TEXTARRAYOID, -1, 0);
7232 TupleDescInitEntry(tupdesc, (AttrNumber) 13, "boot_val",
7234 TupleDescInitEntry(tupdesc, (AttrNumber) 14, "reset_val",
7236 TupleDescInitEntry(tupdesc, (AttrNumber) 15, "sourcefile",
7238 TupleDescInitEntry(tupdesc, (AttrNumber) 16, "sourceline",
7242 * Generate attribute metadata needed later to produce tuples from raw
7245 attinmeta = TupleDescGetAttInMetadata(tupdesc);
7246 funcctx->attinmeta = attinmeta;
7248 /* total number of tuples to be returned */
7249 funcctx->max_calls = GetNumConfigOptions();
7251 MemoryContextSwitchTo(oldcontext);
7254 /* stuff done on every call of the function */
7255 funcctx = SRF_PERCALL_SETUP();
7257 call_cntr = funcctx->call_cntr;
7258 max_calls = funcctx->max_calls;
7259 attinmeta = funcctx->attinmeta;
7261 if (call_cntr < max_calls) /* do when there is more left to send */
7263 char *values[NUM_PG_SETTINGS_ATTS];
7269 * Get the next visible GUC variable name and value
7273 GetConfigOptionByNum(call_cntr, (const char **) values, &noshow);
7276 /* bump the counter and get the next config setting */
7277 call_cntr = ++funcctx->call_cntr;
7279 /* make sure we haven't gone too far now */
7280 if (call_cntr >= max_calls)
7281 SRF_RETURN_DONE(funcctx);
7286 tuple = BuildTupleFromCStrings(attinmeta, values);
7288 /* make the tuple into a datum */
7289 result = HeapTupleGetDatum(tuple);
7291 SRF_RETURN_NEXT(funcctx, result);
7295 /* do when there is no more left */
7296 SRF_RETURN_DONE(funcctx);
7301 _ShowOption(struct config_generic * record, bool use_units)
7306 switch (record->vartype)
7310 struct config_bool *conf = (struct config_bool *) record;
7312 if (conf->show_hook)
7313 val = (*conf->show_hook) ();
7315 val = *conf->variable ? "on" : "off";
7321 struct config_int *conf = (struct config_int *) record;
7323 if (conf->show_hook)
7324 val = (*conf->show_hook) ();
7328 * Use int64 arithmetic to avoid overflows in units
7331 int64 result = *conf->variable;
7334 if (use_units && result > 0 &&
7335 (record->flags & GUC_UNIT_MEMORY))
7337 switch (record->flags & GUC_UNIT_MEMORY)
7339 case GUC_UNIT_BLOCKS:
7340 result *= BLCKSZ / 1024;
7342 case GUC_UNIT_XBLOCKS:
7343 result *= XLOG_BLCKSZ / 1024;
7347 if (result % KB_PER_GB == 0)
7349 result /= KB_PER_GB;
7352 else if (result % KB_PER_MB == 0)
7354 result /= KB_PER_MB;
7362 else if (use_units && result > 0 &&
7363 (record->flags & GUC_UNIT_TIME))
7365 switch (record->flags & GUC_UNIT_TIME)
7371 result *= MS_PER_MIN;
7375 if (result % MS_PER_D == 0)
7380 else if (result % MS_PER_H == 0)
7385 else if (result % MS_PER_MIN == 0)
7387 result /= MS_PER_MIN;
7390 else if (result % MS_PER_S == 0)
7403 snprintf(buffer, sizeof(buffer), INT64_FORMAT "%s",
7412 struct config_real *conf = (struct config_real *) record;
7414 if (conf->show_hook)
7415 val = (*conf->show_hook) ();
7418 snprintf(buffer, sizeof(buffer), "%g",
7427 struct config_string *conf = (struct config_string *) record;
7429 if (conf->show_hook)
7430 val = (*conf->show_hook) ();
7431 else if (*conf->variable && **conf->variable)
7432 val = *conf->variable;
7440 struct config_enum *conf = (struct config_enum *) record;
7442 if (conf->show_hook)
7443 val = (*conf->show_hook) ();
7445 val = config_enum_lookup_by_value(conf, *conf->variable);
7450 /* just to keep compiler quiet */
7455 return pstrdup(val);
7462 * These routines dump out all non-default GUC options into a binary
7463 * file that is read by all exec'ed backends. The format is:
7465 * variable name, string, null terminated
7466 * variable value, string, null terminated
7467 * variable sourcefile, string, null terminated (empty if none)
7468 * variable sourceline, integer
7469 * variable source, integer
7470 * variable scontext, integer
7473 write_one_nondefault_variable(FILE *fp, struct config_generic * gconf)
7475 if (gconf->source == PGC_S_DEFAULT)
7478 fprintf(fp, "%s", gconf->name);
7481 switch (gconf->vartype)
7485 struct config_bool *conf = (struct config_bool *) gconf;
7487 if (*conf->variable)
7488 fprintf(fp, "true");
7490 fprintf(fp, "false");
7496 struct config_int *conf = (struct config_int *) gconf;
7498 fprintf(fp, "%d", *conf->variable);
7504 struct config_real *conf = (struct config_real *) gconf;
7506 fprintf(fp, "%.17g", *conf->variable);
7512 struct config_string *conf = (struct config_string *) gconf;
7514 fprintf(fp, "%s", *conf->variable);
7520 struct config_enum *conf = (struct config_enum *) gconf;
7523 config_enum_lookup_by_value(conf, *conf->variable));
7530 if (gconf->sourcefile)
7531 fprintf(fp, "%s", gconf->sourcefile);
7534 fwrite(&gconf->sourceline, 1, sizeof(gconf->sourceline), fp);
7535 fwrite(&gconf->source, 1, sizeof(gconf->source), fp);
7536 fwrite(&gconf->scontext, 1, sizeof(gconf->scontext), fp);
7540 write_nondefault_variables(GucContext context)
7546 Assert(context == PGC_POSTMASTER || context == PGC_SIGHUP);
7548 elevel = (context == PGC_SIGHUP) ? LOG : ERROR;
7553 fp = AllocateFile(CONFIG_EXEC_PARAMS_NEW, "w");
7557 (errcode_for_file_access(),
7558 errmsg("could not write to file \"%s\": %m",
7559 CONFIG_EXEC_PARAMS_NEW)));
7563 for (i = 0; i < num_guc_variables; i++)
7565 write_one_nondefault_variable(fp, guc_variables[i]);
7571 (errcode_for_file_access(),
7572 errmsg("could not write to file \"%s\": %m",
7573 CONFIG_EXEC_PARAMS_NEW)));
7578 * Put new file in place. This could delay on Win32, but we don't hold
7579 * any exclusive locks.
7581 rename(CONFIG_EXEC_PARAMS_NEW, CONFIG_EXEC_PARAMS);
7586 * Read string, including null byte from file
7588 * Return NULL on EOF and nothing read
7591 read_string_with_null(FILE *fp)
7600 if ((ch = fgetc(fp)) == EOF)
7605 elog(FATAL, "invalid format of exec config params file");
7608 str = guc_malloc(FATAL, maxlen);
7609 else if (i == maxlen)
7610 str = guc_realloc(FATAL, str, maxlen *= 2);
7619 * This routine loads a previous postmaster dump of its non-default
7623 read_nondefault_variables(void)
7630 GucSource varsource;
7631 GucContext varscontext;
7636 fp = AllocateFile(CONFIG_EXEC_PARAMS, "r");
7639 /* File not found is fine */
7640 if (errno != ENOENT)
7642 (errcode_for_file_access(),
7643 errmsg("could not read from file \"%s\": %m",
7644 CONFIG_EXEC_PARAMS)));
7650 struct config_generic *record;
7652 if ((varname = read_string_with_null(fp)) == NULL)
7655 if ((record = find_option(varname, true, FATAL)) == NULL)
7656 elog(FATAL, "failed to locate variable \"%s\" in exec config params file", varname);
7658 if ((varvalue = read_string_with_null(fp)) == NULL)
7659 elog(FATAL, "invalid format of exec config params file");
7660 if ((varsourcefile = read_string_with_null(fp)) == NULL)
7661 elog(FATAL, "invalid format of exec config params file");
7662 if (fread(&varsourceline, 1, sizeof(varsourceline), fp) != sizeof(varsourceline))
7663 elog(FATAL, "invalid format of exec config params file");
7664 if (fread(&varsource, 1, sizeof(varsource), fp) != sizeof(varsource))
7665 elog(FATAL, "invalid format of exec config params file");
7666 if (fread(&varscontext, 1, sizeof(varscontext), fp) != sizeof(varscontext))
7667 elog(FATAL, "invalid format of exec config params file");
7669 (void) set_config_option(varname, varvalue,
7670 varscontext, varsource,
7671 GUC_ACTION_SET, true, 0);
7672 if (varsourcefile[0])
7673 set_config_sourcefile(varname, varsourcefile, varsourceline);
7677 free(varsourcefile);
7682 #endif /* EXEC_BACKEND */
7686 * A little "long argument" simulation, although not quite GNU
7687 * compliant. Takes a string of the form "some-option=some value" and
7688 * returns name = "some_option" and value = "some value" in malloc'ed
7689 * storage. Note that '-' is converted to '_' in the option name. If
7690 * there is no '=' in the input string then value will be NULL.
7693 ParseLongOption(const char *string, char **name, char **value)
7702 equal_pos = strcspn(string, "=");
7704 if (string[equal_pos] == '=')
7706 *name = guc_malloc(FATAL, equal_pos + 1);
7707 strlcpy(*name, string, equal_pos + 1);
7709 *value = guc_strdup(FATAL, &string[equal_pos + 1]);
7713 /* no equal sign in string */
7714 *name = guc_strdup(FATAL, string);
7718 for (cp = *name; *cp; cp++)
7725 * Handle options fetched from pg_db_role_setting.setconfig,
7726 * pg_proc.proconfig, etc. Caller must specify proper context/source/action.
7728 * The array parameter must be an array of TEXT (it must not be NULL).
7731 ProcessGUCArray(ArrayType *array,
7732 GucContext context, GucSource source, GucAction action)
7736 Assert(array != NULL);
7737 Assert(ARR_ELEMTYPE(array) == TEXTOID);
7738 Assert(ARR_NDIM(array) == 1);
7739 Assert(ARR_LBOUND(array)[0] == 1);
7741 for (i = 1; i <= ARR_DIMS(array)[0]; i++)
7749 d = array_ref(array, 1, &i,
7750 -1 /* varlenarray */ ,
7751 -1 /* TEXT's typlen */ ,
7752 false /* TEXT's typbyval */ ,
7753 'i' /* TEXT's typalign */ ,
7759 s = TextDatumGetCString(d);
7761 ParseLongOption(s, &name, &value);
7765 (errcode(ERRCODE_SYNTAX_ERROR),
7766 errmsg("could not parse setting for parameter \"%s\"",
7772 (void) set_config_option(name, value,
7785 * Add an entry to an option array. The array parameter may be NULL
7786 * to indicate the current table entry is NULL.
7789 GUCArrayAdd(ArrayType *array, const char *name, const char *value)
7791 struct config_generic *record;
7799 /* test if the option is valid and we're allowed to set it */
7800 (void) validate_option_array_item(name, value, false);
7802 /* normalize name (converts obsolete GUC names to modern spellings) */
7803 record = find_option(name, false, WARNING);
7805 name = record->name;
7807 /* build new item for array */
7808 newval = palloc(strlen(name) + 1 + strlen(value) + 1);
7809 sprintf(newval, "%s=%s", name, value);
7810 datum = CStringGetTextDatum(newval);
7818 Assert(ARR_ELEMTYPE(array) == TEXTOID);
7819 Assert(ARR_NDIM(array) == 1);
7820 Assert(ARR_LBOUND(array)[0] == 1);
7822 index = ARR_DIMS(array)[0] + 1; /* add after end */
7824 for (i = 1; i <= ARR_DIMS(array)[0]; i++)
7829 d = array_ref(array, 1, &i,
7830 -1 /* varlenarray */ ,
7831 -1 /* TEXT's typlen */ ,
7832 false /* TEXT's typbyval */ ,
7833 'i' /* TEXT's typalign */ ,
7837 current = TextDatumGetCString(d);
7839 /* check for match up through and including '=' */
7840 if (strncmp(current, newval, strlen(name) + 1) == 0)
7847 a = array_set(array, 1, &index,
7850 -1 /* varlena array */ ,
7851 -1 /* TEXT's typlen */ ,
7852 false /* TEXT's typbyval */ ,
7853 'i' /* TEXT's typalign */ );
7856 a = construct_array(&datum, 1,
7865 * Delete an entry from an option array. The array parameter may be NULL
7866 * to indicate the current table entry is NULL. Also, if the return value
7867 * is NULL then a null should be stored.
7870 GUCArrayDelete(ArrayType *array, const char *name)
7872 struct config_generic *record;
7873 ArrayType *newarray;
7879 /* test if the option is valid and we're allowed to set it */
7880 (void) validate_option_array_item(name, NULL, false);
7882 /* normalize name (converts obsolete GUC names to modern spellings) */
7883 record = find_option(name, false, WARNING);
7885 name = record->name;
7887 /* if array is currently null, then surely nothing to delete */
7894 for (i = 1; i <= ARR_DIMS(array)[0]; i++)
7900 d = array_ref(array, 1, &i,
7901 -1 /* varlenarray */ ,
7902 -1 /* TEXT's typlen */ ,
7903 false /* TEXT's typbyval */ ,
7904 'i' /* TEXT's typalign */ ,
7908 val = TextDatumGetCString(d);
7910 /* ignore entry if it's what we want to delete */
7911 if (strncmp(val, name, strlen(name)) == 0
7912 && val[strlen(name)] == '=')
7915 /* else add it to the output array */
7917 newarray = array_set(newarray, 1, &index,
7920 -1 /* varlenarray */ ,
7921 -1 /* TEXT's typlen */ ,
7922 false /* TEXT's typbyval */ ,
7923 'i' /* TEXT's typalign */ );
7925 newarray = construct_array(&d, 1,
7937 * Given a GUC array, delete all settings from it that our permission
7938 * level allows: if superuser, delete them all; if regular user, only
7939 * those that are PGC_USERSET
7942 GUCArrayReset(ArrayType *array)
7944 ArrayType *newarray;
7948 /* if array is currently null, nothing to do */
7952 /* if we're superuser, we can delete everything, so just do it */
7959 for (i = 1; i <= ARR_DIMS(array)[0]; i++)
7966 d = array_ref(array, 1, &i,
7967 -1 /* varlenarray */ ,
7968 -1 /* TEXT's typlen */ ,
7969 false /* TEXT's typbyval */ ,
7970 'i' /* TEXT's typalign */ ,
7974 val = TextDatumGetCString(d);
7976 eqsgn = strchr(val, '=');
7979 /* skip if we have permission to delete it */
7980 if (validate_option_array_item(val, NULL, true))
7983 /* else add it to the output array */
7985 newarray = array_set(newarray, 1, &index,
7988 -1 /* varlenarray */ ,
7989 -1 /* TEXT's typlen */ ,
7990 false /* TEXT's typbyval */ ,
7991 'i' /* TEXT's typalign */ );
7993 newarray = construct_array(&d, 1,
8005 * Validate a proposed option setting for GUCArrayAdd/Delete/Reset.
8007 * name is the option name. value is the proposed value for the Add case,
8008 * or NULL for the Delete/Reset cases. If skipIfNoPermissions is true, it's
8009 * not an error to have no permissions to set the option.
8011 * Returns TRUE if OK, FALSE if skipIfNoPermissions is true and user does not
8012 * have permission to change this option (all other error cases result in an
8013 * error being thrown).
8016 validate_option_array_item(const char *name, const char *value,
8017 bool skipIfNoPermissions)
8020 struct config_generic *gconf;
8023 * There are three cases to consider:
8025 * name is a known GUC variable. Check the value normally, check
8026 * permissions normally (ie, allow if variable is USERSET, or if it's
8027 * SUSET and user is superuser).
8029 * name is not known, but exists or can be created as a placeholder (i.e.,
8030 * it has a prefixed name). We allow this case if you're a superuser,
8031 * otherwise not. Superusers are assumed to know what they're doing.
8032 * We can't allow it for other users, because when the placeholder is
8033 * resolved it might turn out to be a SUSET variable;
8034 * define_custom_variable assumes we checked that.
8036 * name is not known and can't be created as a placeholder. Throw error,
8037 * unless skipIfNoPermissions is true, in which case return FALSE.
8039 gconf = find_option(name, true, WARNING);
8042 /* not known, failed to make a placeholder */
8043 if (skipIfNoPermissions)
8046 (errcode(ERRCODE_UNDEFINED_OBJECT),
8047 errmsg("unrecognized configuration parameter \"%s\"",
8051 if (gconf->flags & GUC_CUSTOM_PLACEHOLDER)
8054 * We cannot do any meaningful check on the value, so only permissions
8055 * are useful to check.
8059 if (skipIfNoPermissions)
8062 (errcode(ERRCODE_INSUFFICIENT_PRIVILEGE),
8063 errmsg("permission denied to set parameter \"%s\"", name)));
8066 /* manual permissions check so we can avoid an error being thrown */
8067 if (gconf->context == PGC_USERSET)
8069 else if (gconf->context == PGC_SUSET && superuser())
8071 else if (skipIfNoPermissions)
8073 /* if a permissions error should be thrown, let set_config_option do it */
8075 /* test for permissions and valid option value */
8076 (void) set_config_option(name, value,
8077 superuser() ? PGC_SUSET : PGC_USERSET,
8078 PGC_S_TEST, GUC_ACTION_SET, false, 0);
8085 * Called by check_hooks that want to override the normal
8086 * ERRCODE_INVALID_PARAMETER_VALUE SQLSTATE for check hook failures.
8088 * Note that GUC_check_errmsg() etc are just macros that result in a direct
8089 * assignment to the associated variables. That is ugly, but forced by the
8090 * limitations of C's macro mechanisms.
8093 GUC_check_errcode(int sqlerrcode)
8095 GUC_check_errcode_value = sqlerrcode;
8100 * Convenience functions to manage calling a variable's check_hook.
8101 * These mostly take care of the protocol for letting check hooks supply
8102 * portions of the error report on failure.
8106 call_bool_check_hook(struct config_bool * conf, bool *newval, void **extra,
8107 GucSource source, int elevel)
8109 /* Quick success if no hook */
8110 if (!conf->check_hook)
8113 /* Reset variables that might be set by hook */
8114 GUC_check_errcode_value = ERRCODE_INVALID_PARAMETER_VALUE;
8115 GUC_check_errmsg_string = NULL;
8116 GUC_check_errdetail_string = NULL;
8117 GUC_check_errhint_string = NULL;
8119 if (!(*conf->check_hook) (newval, extra, source))
8122 (errcode(GUC_check_errcode_value),
8123 GUC_check_errmsg_string ?
8124 errmsg_internal("%s", GUC_check_errmsg_string) :
8125 errmsg("invalid value for parameter \"%s\": %d",
8126 conf->gen.name, (int) *newval),
8127 GUC_check_errdetail_string ?
8128 errdetail_internal("%s", GUC_check_errdetail_string) : 0,
8129 GUC_check_errhint_string ?
8130 errhint("%s", GUC_check_errhint_string) : 0));
8131 /* Flush any strings created in ErrorContext */
8140 call_int_check_hook(struct config_int * conf, int *newval, void **extra,
8141 GucSource source, int elevel)
8143 /* Quick success if no hook */
8144 if (!conf->check_hook)
8147 /* Reset variables that might be set by hook */
8148 GUC_check_errcode_value = ERRCODE_INVALID_PARAMETER_VALUE;
8149 GUC_check_errmsg_string = NULL;
8150 GUC_check_errdetail_string = NULL;
8151 GUC_check_errhint_string = NULL;
8153 if (!(*conf->check_hook) (newval, extra, source))
8156 (errcode(GUC_check_errcode_value),
8157 GUC_check_errmsg_string ?
8158 errmsg_internal("%s", GUC_check_errmsg_string) :
8159 errmsg("invalid value for parameter \"%s\": %d",
8160 conf->gen.name, *newval),
8161 GUC_check_errdetail_string ?
8162 errdetail_internal("%s", GUC_check_errdetail_string) : 0,
8163 GUC_check_errhint_string ?
8164 errhint("%s", GUC_check_errhint_string) : 0));
8165 /* Flush any strings created in ErrorContext */
8174 call_real_check_hook(struct config_real * conf, double *newval, void **extra,
8175 GucSource source, int elevel)
8177 /* Quick success if no hook */
8178 if (!conf->check_hook)
8181 /* Reset variables that might be set by hook */
8182 GUC_check_errcode_value = ERRCODE_INVALID_PARAMETER_VALUE;
8183 GUC_check_errmsg_string = NULL;
8184 GUC_check_errdetail_string = NULL;
8185 GUC_check_errhint_string = NULL;
8187 if (!(*conf->check_hook) (newval, extra, source))
8190 (errcode(GUC_check_errcode_value),
8191 GUC_check_errmsg_string ?
8192 errmsg_internal("%s", GUC_check_errmsg_string) :
8193 errmsg("invalid value for parameter \"%s\": %g",
8194 conf->gen.name, *newval),
8195 GUC_check_errdetail_string ?
8196 errdetail_internal("%s", GUC_check_errdetail_string) : 0,
8197 GUC_check_errhint_string ?
8198 errhint("%s", GUC_check_errhint_string) : 0));
8199 /* Flush any strings created in ErrorContext */
8208 call_string_check_hook(struct config_string * conf, char **newval, void **extra,
8209 GucSource source, int elevel)
8211 /* Quick success if no hook */
8212 if (!conf->check_hook)
8215 /* Reset variables that might be set by hook */
8216 GUC_check_errcode_value = ERRCODE_INVALID_PARAMETER_VALUE;
8217 GUC_check_errmsg_string = NULL;
8218 GUC_check_errdetail_string = NULL;
8219 GUC_check_errhint_string = NULL;
8221 if (!(*conf->check_hook) (newval, extra, source))
8224 (errcode(GUC_check_errcode_value),
8225 GUC_check_errmsg_string ?
8226 errmsg_internal("%s", GUC_check_errmsg_string) :
8227 errmsg("invalid value for parameter \"%s\": \"%s\"",
8228 conf->gen.name, *newval ? *newval : ""),
8229 GUC_check_errdetail_string ?
8230 errdetail_internal("%s", GUC_check_errdetail_string) : 0,
8231 GUC_check_errhint_string ?
8232 errhint("%s", GUC_check_errhint_string) : 0));
8233 /* Flush any strings created in ErrorContext */
8242 call_enum_check_hook(struct config_enum * conf, int *newval, void **extra,
8243 GucSource source, int elevel)
8245 /* Quick success if no hook */
8246 if (!conf->check_hook)
8249 /* Reset variables that might be set by hook */
8250 GUC_check_errcode_value = ERRCODE_INVALID_PARAMETER_VALUE;
8251 GUC_check_errmsg_string = NULL;
8252 GUC_check_errdetail_string = NULL;
8253 GUC_check_errhint_string = NULL;
8255 if (!(*conf->check_hook) (newval, extra, source))
8258 (errcode(GUC_check_errcode_value),
8259 GUC_check_errmsg_string ?
8260 errmsg_internal("%s", GUC_check_errmsg_string) :
8261 errmsg("invalid value for parameter \"%s\": \"%s\"",
8263 config_enum_lookup_by_value(conf, *newval)),
8264 GUC_check_errdetail_string ?
8265 errdetail_internal("%s", GUC_check_errdetail_string) : 0,
8266 GUC_check_errhint_string ?
8267 errhint("%s", GUC_check_errhint_string) : 0));
8268 /* Flush any strings created in ErrorContext */
8278 * check_hook, assign_hook and show_hook subroutines
8282 check_log_destination(char **newval, void **extra, GucSource source)
8290 /* Need a modifiable copy of string */
8291 rawstring = pstrdup(*newval);
8293 /* Parse string into list of identifiers */
8294 if (!SplitIdentifierString(rawstring, ',', &elemlist))
8296 /* syntax error in list */
8297 GUC_check_errdetail("List syntax is invalid.");
8299 list_free(elemlist);
8303 foreach(l, elemlist)
8305 char *tok = (char *) lfirst(l);
8307 if (pg_strcasecmp(tok, "stderr") == 0)
8308 newlogdest |= LOG_DESTINATION_STDERR;
8309 else if (pg_strcasecmp(tok, "csvlog") == 0)
8310 newlogdest |= LOG_DESTINATION_CSVLOG;
8312 else if (pg_strcasecmp(tok, "syslog") == 0)
8313 newlogdest |= LOG_DESTINATION_SYSLOG;
8316 else if (pg_strcasecmp(tok, "eventlog") == 0)
8317 newlogdest |= LOG_DESTINATION_EVENTLOG;
8321 GUC_check_errdetail("Unrecognized key word: \"%s\".", tok);
8323 list_free(elemlist);
8329 list_free(elemlist);
8331 myextra = (int *) guc_malloc(ERROR, sizeof(int));
8332 *myextra = newlogdest;
8333 *extra = (void *) myextra;
8339 assign_log_destination(const char *newval, void *extra)
8341 Log_destination = *((int *) extra);
8345 assign_syslog_facility(int newval, void *extra)
8348 set_syslog_parameters(syslog_ident_str ? syslog_ident_str : "postgres",
8351 /* Without syslog support, just ignore it */
8355 assign_syslog_ident(const char *newval, void *extra)
8358 set_syslog_parameters(newval, syslog_facility);
8360 /* Without syslog support, it will always be set to "none", so ignore */
8365 assign_session_replication_role(int newval, void *extra)
8368 * Must flush the plan cache when changing replication role; but don't
8369 * flush unnecessarily.
8371 if (SessionReplicationRole != newval)
8376 check_temp_buffers(int *newval, void **extra, GucSource source)
8379 * Once local buffers have been initialized, it's too late to change this.
8381 if (NLocBuffer && NLocBuffer != *newval)
8383 GUC_check_errdetail("\"temp_buffers\" cannot be changed after any temporary tables have been accessed in the session.");
8390 check_phony_autocommit(bool *newval, void **extra, GucSource source)
8394 GUC_check_errcode(ERRCODE_FEATURE_NOT_SUPPORTED);
8395 GUC_check_errmsg("SET AUTOCOMMIT TO OFF is no longer supported");
8402 check_debug_assertions(bool *newval, void **extra, GucSource source)
8404 #ifndef USE_ASSERT_CHECKING
8407 GUC_check_errmsg("assertion checking is not supported by this build");
8415 check_bonjour(bool *newval, void **extra, GucSource source)
8420 GUC_check_errmsg("Bonjour is not supported by this build");
8428 check_ssl(bool *newval, void **extra, GucSource source)
8433 GUC_check_errmsg("SSL is not supported by this build");
8441 check_stage_log_stats(bool *newval, void **extra, GucSource source)
8443 if (*newval && log_statement_stats)
8445 GUC_check_errdetail("Cannot enable parameter when \"log_statement_stats\" is true.");
8452 check_log_stats(bool *newval, void **extra, GucSource source)
8455 (log_parser_stats || log_planner_stats || log_executor_stats))
8457 GUC_check_errdetail("Cannot enable \"log_statement_stats\" when "
8458 "\"log_parser_stats\", \"log_planner_stats\", "
8459 "or \"log_executor_stats\" is true.");
8466 check_canonical_path(char **newval, void **extra, GucSource source)
8469 * Since canonicalize_path never enlarges the string, we can just modify
8470 * newval in-place. But watch out for NULL, which is the default value
8471 * for external_pid_file.
8474 canonicalize_path(*newval);
8479 check_timezone_abbreviations(char **newval, void **extra, GucSource source)
8482 * The boot_val given above for timezone_abbreviations is NULL. When we
8483 * see this we just do nothing. If this value isn't overridden from the
8484 * config file then pg_timezone_abbrev_initialize() will eventually
8485 * replace it with "Default". This hack has two purposes: to avoid
8486 * wasting cycles loading values that might soon be overridden from the
8487 * config file, and to avoid trying to read the timezone abbrev files
8488 * during InitializeGUCOptions(). The latter doesn't work in an
8489 * EXEC_BACKEND subprocess because my_exec_path hasn't been set yet and so
8490 * we can't locate PGSHAREDIR.
8492 if (*newval == NULL)
8494 Assert(source == PGC_S_DEFAULT);
8498 /* OK, load the file and produce a malloc'd TimeZoneAbbrevTable */
8499 *extra = load_tzoffsets(*newval);
8501 /* tzparser.c returns NULL on failure, reporting via GUC_check_errmsg */
8509 assign_timezone_abbreviations(const char *newval, void *extra)
8511 /* Do nothing for the boot_val default of NULL */
8515 InstallTimeZoneAbbrevs((TimeZoneAbbrevTable *) extra);
8519 * pg_timezone_abbrev_initialize --- set default value if not done already
8521 * This is called after initial loading of postgresql.conf. If no
8522 * timezone_abbreviations setting was found therein, select default.
8523 * If a non-default value is already installed, nothing will happen.
8525 * This can also be called from ProcessConfigFile to establish the default
8526 * value after a postgresql.conf entry for it is removed.
8529 pg_timezone_abbrev_initialize(void)
8531 SetConfigOption("timezone_abbreviations", "Default",
8532 PGC_POSTMASTER, PGC_S_DYNAMIC_DEFAULT);
8536 show_archive_command(void)
8538 if (XLogArchivingActive())
8539 return XLogArchiveCommand;
8541 return "(disabled)";
8545 assign_tcp_keepalives_idle(int newval, void *extra)
8548 * The kernel API provides no way to test a value without setting it; and
8549 * once we set it we might fail to unset it. So there seems little point
8550 * in fully implementing the check-then-assign GUC API for these
8551 * variables. Instead we just do the assignment on demand. pqcomm.c
8552 * reports any problems via elog(LOG).
8554 * This approach means that the GUC value might have little to do with the
8555 * actual kernel value, so we use a show_hook that retrieves the kernel
8556 * value rather than trusting GUC's copy.
8558 (void) pq_setkeepalivesidle(newval, MyProcPort);
8562 show_tcp_keepalives_idle(void)
8564 /* See comments in assign_tcp_keepalives_idle */
8565 static char nbuf[16];
8567 snprintf(nbuf, sizeof(nbuf), "%d", pq_getkeepalivesidle(MyProcPort));
8572 assign_tcp_keepalives_interval(int newval, void *extra)
8574 /* See comments in assign_tcp_keepalives_idle */
8575 (void) pq_setkeepalivesinterval(newval, MyProcPort);
8579 show_tcp_keepalives_interval(void)
8581 /* See comments in assign_tcp_keepalives_idle */
8582 static char nbuf[16];
8584 snprintf(nbuf, sizeof(nbuf), "%d", pq_getkeepalivesinterval(MyProcPort));
8589 assign_tcp_keepalives_count(int newval, void *extra)
8591 /* See comments in assign_tcp_keepalives_idle */
8592 (void) pq_setkeepalivescount(newval, MyProcPort);
8596 show_tcp_keepalives_count(void)
8598 /* See comments in assign_tcp_keepalives_idle */
8599 static char nbuf[16];
8601 snprintf(nbuf, sizeof(nbuf), "%d", pq_getkeepalivescount(MyProcPort));
8606 check_maxconnections(int *newval, void **extra, GucSource source)
8608 if (*newval + autovacuum_max_workers + 1 > MAX_BACKENDS)
8614 assign_maxconnections(int newval, void *extra)
8616 MaxBackends = newval + autovacuum_max_workers + 1;
8620 check_autovacuum_max_workers(int *newval, void **extra, GucSource source)
8622 if (MaxConnections + *newval + 1 > MAX_BACKENDS)
8628 assign_autovacuum_max_workers(int newval, void *extra)
8630 MaxBackends = MaxConnections + newval + 1;
8634 check_effective_io_concurrency(int *newval, void **extra, GucSource source)
8637 double new_prefetch_pages = 0.0;
8641 * The user-visible GUC parameter is the number of drives (spindles),
8642 * which we need to translate to a number-of-pages-to-prefetch target.
8643 * The target value is stashed in *extra and then assigned to the actual
8644 * variable by assign_effective_io_concurrency.
8646 * The expected number of prefetch pages needed to keep N drives busy is:
8648 * drives | I/O requests
8649 * -------+----------------
8652 * 3 | 3/1 + 3/2 + 3/3 = 5 1/2
8653 * 4 | 4/1 + 4/2 + 4/3 + 4/4 = 8 1/3
8656 * This is called the "coupon collector problem" and H(n) is called the
8657 * harmonic series. This could be approximated by n * ln(n), but for
8658 * reasonable numbers of drives we might as well just compute the series.
8660 * Alternatively we could set the target to the number of pages necessary
8661 * so that the expected number of active spindles is some arbitrary
8662 * percentage of the total. This sounds the same but is actually slightly
8663 * different. The result ends up being ln(1-P)/ln((n-1)/n) where P is
8664 * that desired fraction.
8666 * Experimental results show that both of these formulas aren't aggressive
8667 * enough, but we don't really have any better proposals.
8669 * Note that if *newval = 0 (disabled), we must set target = 0.
8673 for (i = 1; i <= *newval; i++)
8674 new_prefetch_pages += (double) *newval / (double) i;
8676 /* This range check shouldn't fail, but let's be paranoid */
8677 if (new_prefetch_pages >= 0.0 && new_prefetch_pages < (double) INT_MAX)
8679 int *myextra = (int *) guc_malloc(ERROR, sizeof(int));
8681 *myextra = (int) rint(new_prefetch_pages);
8682 *extra = (void *) myextra;
8690 #endif /* USE_PREFETCH */
8694 assign_effective_io_concurrency(int newval, void *extra)
8697 target_prefetch_pages = *((int *) extra);
8698 #endif /* USE_PREFETCH */
8702 assign_pgstat_temp_directory(const char *newval, void *extra)
8704 /* check_canonical_path already canonicalized newval for us */
8708 tname = guc_malloc(ERROR, strlen(newval) + 12); /* /pgstat.tmp */
8709 sprintf(tname, "%s/pgstat.tmp", newval);
8710 fname = guc_malloc(ERROR, strlen(newval) + 13); /* /pgstat.stat */
8711 sprintf(fname, "%s/pgstat.stat", newval);
8713 if (pgstat_stat_tmpname)
8714 free(pgstat_stat_tmpname);
8715 pgstat_stat_tmpname = tname;
8716 if (pgstat_stat_filename)
8717 free(pgstat_stat_filename);
8718 pgstat_stat_filename = fname;
8722 check_application_name(char **newval, void **extra, GucSource source)
8724 /* Only allow clean ASCII chars in the application name */
8727 for (p = *newval; *p; p++)
8729 if (*p < 32 || *p > 126)
8737 assign_application_name(const char *newval, void *extra)
8739 /* Update the pg_stat_activity view */
8740 pgstat_report_appname(newval);
8744 show_unix_socket_permissions(void)
8748 snprintf(buf, sizeof(buf), "%04o", Unix_socket_permissions);
8753 show_log_file_mode(void)
8757 snprintf(buf, sizeof(buf), "%04o", Log_file_mode);
8761 #include "guc-file.c"