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/proc.h"
66 #include "storage/predicate.h"
67 #include "tcop/tcopprot.h"
68 #include "tsearch/ts_cache.h"
69 #include "utils/builtins.h"
70 #include "utils/bytea.h"
71 #include "utils/guc_tables.h"
72 #include "utils/memutils.h"
73 #include "utils/pg_locale.h"
74 #include "utils/plancache.h"
75 #include "utils/portal.h"
76 #include "utils/ps_status.h"
77 #include "utils/snapmgr.h"
78 #include "utils/tzparser.h"
79 #include "utils/xml.h"
82 #define PG_KRB_SRVTAB ""
85 #define PG_KRB_SRVNAM ""
88 #define CONFIG_FILENAME "postgresql.conf"
89 #define HBA_FILENAME "pg_hba.conf"
90 #define IDENT_FILENAME "pg_ident.conf"
93 #define CONFIG_EXEC_PARAMS "global/config_exec_params"
94 #define CONFIG_EXEC_PARAMS_NEW "global/config_exec_params.new"
97 /* upper limit for GUC variables measured in kilobytes of memory */
98 /* note that various places assume the byte size fits in a "long" variable */
99 #if SIZEOF_SIZE_T > 4 && SIZEOF_LONG > 4
100 #define MAX_KILOBYTES INT_MAX
102 #define MAX_KILOBYTES (INT_MAX / 1024)
106 * Note: MAX_BACKENDS is limited to 2^23-1 because inval.c stores the
107 * backend ID as a 3-byte signed integer. Even if that limitation were
108 * removed, we still could not exceed INT_MAX/4 because some places compute
109 * 4*MaxBackends without any overflow check. This is rechecked in
110 * check_maxconnections, since MaxBackends is computed as MaxConnections
111 * plus autovacuum_max_workers plus one (for the autovacuum launcher).
113 #define MAX_BACKENDS 0x7fffff
115 #define KB_PER_MB (1024)
116 #define KB_PER_GB (1024*1024)
118 #define MS_PER_S 1000
120 #define MS_PER_MIN (1000 * 60)
122 #define S_PER_H (60 * 60)
123 #define MS_PER_H (1000 * 60 * 60)
124 #define MIN_PER_D (60 * 24)
125 #define S_PER_D (60 * 60 * 24)
126 #define MS_PER_D (1000 * 60 * 60 * 24)
128 /* XXX these should appear in other modules' header files */
129 extern bool Log_disconnections;
130 extern int CommitDelay;
131 extern int CommitSiblings;
132 extern char *default_tablespace;
133 extern char *temp_tablespaces;
134 extern bool synchronize_seqscans;
135 extern int ssl_renegotiation_limit;
136 extern char *SSLCipherSuites;
139 extern bool trace_sort;
141 #ifdef TRACE_SYNCSCAN
142 extern bool trace_syncscan;
144 #ifdef DEBUG_BOUNDED_SORT
145 extern bool optimize_bounded_sort;
148 static int GUC_check_errcode_value;
150 /* global variables for check hook support */
151 char *GUC_check_errmsg_string;
152 char *GUC_check_errdetail_string;
153 char *GUC_check_errhint_string;
156 static void set_config_sourcefile(const char *name, char *sourcefile,
158 static bool call_bool_check_hook(struct config_bool * conf, bool *newval,
159 void **extra, GucSource source, int elevel);
160 static bool call_int_check_hook(struct config_int * conf, int *newval,
161 void **extra, GucSource source, int elevel);
162 static bool call_real_check_hook(struct config_real * conf, double *newval,
163 void **extra, GucSource source, int elevel);
164 static bool call_string_check_hook(struct config_string * conf, char **newval,
165 void **extra, GucSource source, int elevel);
166 static bool call_enum_check_hook(struct config_enum * conf, int *newval,
167 void **extra, GucSource source, int elevel);
169 static bool check_log_destination(char **newval, void **extra, GucSource source);
170 static void assign_log_destination(const char *newval, void *extra);
173 static int syslog_facility = LOG_LOCAL0;
175 static int syslog_facility = 0;
178 static void assign_syslog_facility(int newval, void *extra);
179 static void assign_syslog_ident(const char *newval, void *extra);
180 static void assign_session_replication_role(int newval, void *extra);
181 static bool check_temp_buffers(int *newval, void **extra, GucSource source);
182 static bool check_phony_autocommit(bool *newval, void **extra, GucSource source);
183 static bool check_debug_assertions(bool *newval, void **extra, GucSource source);
184 static bool check_bonjour(bool *newval, void **extra, GucSource source);
185 static bool check_ssl(bool *newval, void **extra, GucSource source);
186 static bool check_stage_log_stats(bool *newval, void **extra, GucSource source);
187 static bool check_log_stats(bool *newval, void **extra, GucSource source);
188 static bool check_canonical_path(char **newval, void **extra, GucSource source);
189 static bool check_timezone_abbreviations(char **newval, void **extra, GucSource source);
190 static void assign_timezone_abbreviations(const char *newval, void *extra);
191 static void pg_timezone_abbrev_initialize(void);
192 static const char *show_archive_command(void);
193 static void assign_tcp_keepalives_idle(int newval, void *extra);
194 static void assign_tcp_keepalives_interval(int newval, void *extra);
195 static void assign_tcp_keepalives_count(int newval, void *extra);
196 static const char *show_tcp_keepalives_idle(void);
197 static const char *show_tcp_keepalives_interval(void);
198 static const char *show_tcp_keepalives_count(void);
199 static bool check_maxconnections(int *newval, void **extra, GucSource source);
200 static void assign_maxconnections(int newval, void *extra);
201 static bool check_autovacuum_max_workers(int *newval, void **extra, GucSource source);
202 static void assign_autovacuum_max_workers(int newval, void *extra);
203 static bool check_effective_io_concurrency(int *newval, void **extra, GucSource source);
204 static void assign_effective_io_concurrency(int newval, void *extra);
205 static void assign_pgstat_temp_directory(const char *newval, void *extra);
206 static bool check_application_name(char **newval, void **extra, GucSource source);
207 static void assign_application_name(const char *newval, void *extra);
208 static const char *show_unix_socket_permissions(void);
209 static const char *show_log_file_mode(void);
211 static char *config_enum_get_options(struct config_enum * record,
212 const char *prefix, const char *suffix,
213 const char *separator);
217 * Options for enum values defined in this module.
219 * NOTE! Option values may not contain double quotes!
222 static const struct config_enum_entry bytea_output_options[] = {
223 {"escape", BYTEA_OUTPUT_ESCAPE, false},
224 {"hex", BYTEA_OUTPUT_HEX, false},
229 * We have different sets for client and server message level options because
230 * they sort slightly different (see "log" level)
232 static const struct config_enum_entry client_message_level_options[] = {
233 {"debug", DEBUG2, true},
234 {"debug5", DEBUG5, false},
235 {"debug4", DEBUG4, false},
236 {"debug3", DEBUG3, false},
237 {"debug2", DEBUG2, false},
238 {"debug1", DEBUG1, false},
240 {"info", INFO, true},
241 {"notice", NOTICE, false},
242 {"warning", WARNING, false},
243 {"error", ERROR, false},
244 {"fatal", FATAL, true},
245 {"panic", PANIC, true},
249 static const struct config_enum_entry server_message_level_options[] = {
250 {"debug", DEBUG2, true},
251 {"debug5", DEBUG5, false},
252 {"debug4", DEBUG4, false},
253 {"debug3", DEBUG3, false},
254 {"debug2", DEBUG2, false},
255 {"debug1", DEBUG1, false},
256 {"info", INFO, false},
257 {"notice", NOTICE, false},
258 {"warning", WARNING, false},
259 {"error", ERROR, false},
261 {"fatal", FATAL, false},
262 {"panic", PANIC, false},
266 static const struct config_enum_entry intervalstyle_options[] = {
267 {"postgres", INTSTYLE_POSTGRES, false},
268 {"postgres_verbose", INTSTYLE_POSTGRES_VERBOSE, false},
269 {"sql_standard", INTSTYLE_SQL_STANDARD, false},
270 {"iso_8601", INTSTYLE_ISO_8601, false},
274 static const struct config_enum_entry log_error_verbosity_options[] = {
275 {"terse", PGERROR_TERSE, false},
276 {"default", PGERROR_DEFAULT, false},
277 {"verbose", PGERROR_VERBOSE, false},
281 static const struct config_enum_entry log_statement_options[] = {
282 {"none", LOGSTMT_NONE, false},
283 {"ddl", LOGSTMT_DDL, false},
284 {"mod", LOGSTMT_MOD, false},
285 {"all", LOGSTMT_ALL, false},
289 static const struct config_enum_entry isolation_level_options[] = {
290 {"serializable", XACT_SERIALIZABLE, false},
291 {"repeatable read", XACT_REPEATABLE_READ, false},
292 {"read committed", XACT_READ_COMMITTED, false},
293 {"read uncommitted", XACT_READ_UNCOMMITTED, false},
297 static const struct config_enum_entry session_replication_role_options[] = {
298 {"origin", SESSION_REPLICATION_ROLE_ORIGIN, false},
299 {"replica", SESSION_REPLICATION_ROLE_REPLICA, false},
300 {"local", SESSION_REPLICATION_ROLE_LOCAL, false},
304 static const struct config_enum_entry syslog_facility_options[] = {
306 {"local0", LOG_LOCAL0, false},
307 {"local1", LOG_LOCAL1, false},
308 {"local2", LOG_LOCAL2, false},
309 {"local3", LOG_LOCAL3, false},
310 {"local4", LOG_LOCAL4, false},
311 {"local5", LOG_LOCAL5, false},
312 {"local6", LOG_LOCAL6, false},
313 {"local7", LOG_LOCAL7, false},
320 static const struct config_enum_entry track_function_options[] = {
321 {"none", TRACK_FUNC_OFF, false},
322 {"pl", TRACK_FUNC_PL, false},
323 {"all", TRACK_FUNC_ALL, false},
327 static const struct config_enum_entry xmlbinary_options[] = {
328 {"base64", XMLBINARY_BASE64, false},
329 {"hex", XMLBINARY_HEX, false},
333 static const struct config_enum_entry xmloption_options[] = {
334 {"content", XMLOPTION_CONTENT, false},
335 {"document", XMLOPTION_DOCUMENT, false},
340 * Although only "on", "off", and "safe_encoding" are documented, we
341 * accept all the likely variants of "on" and "off".
343 static const struct config_enum_entry backslash_quote_options[] = {
344 {"safe_encoding", BACKSLASH_QUOTE_SAFE_ENCODING, false},
345 {"on", BACKSLASH_QUOTE_ON, false},
346 {"off", BACKSLASH_QUOTE_OFF, false},
347 {"true", BACKSLASH_QUOTE_ON, true},
348 {"false", BACKSLASH_QUOTE_OFF, true},
349 {"yes", BACKSLASH_QUOTE_ON, true},
350 {"no", BACKSLASH_QUOTE_OFF, true},
351 {"1", BACKSLASH_QUOTE_ON, true},
352 {"0", BACKSLASH_QUOTE_OFF, true},
357 * Although only "on", "off", and "partition" are documented, we
358 * accept all the likely variants of "on" and "off".
360 static const struct config_enum_entry constraint_exclusion_options[] = {
361 {"partition", CONSTRAINT_EXCLUSION_PARTITION, false},
362 {"on", CONSTRAINT_EXCLUSION_ON, false},
363 {"off", CONSTRAINT_EXCLUSION_OFF, false},
364 {"true", CONSTRAINT_EXCLUSION_ON, true},
365 {"false", CONSTRAINT_EXCLUSION_OFF, true},
366 {"yes", CONSTRAINT_EXCLUSION_ON, true},
367 {"no", CONSTRAINT_EXCLUSION_OFF, true},
368 {"1", CONSTRAINT_EXCLUSION_ON, true},
369 {"0", CONSTRAINT_EXCLUSION_OFF, true},
374 * Although only "on", "off", "remote_write", and "local" are documented, we
375 * accept all the likely variants of "on" and "off".
377 static const struct config_enum_entry synchronous_commit_options[] = {
378 {"local", SYNCHRONOUS_COMMIT_LOCAL_FLUSH, false},
379 {"remote_write", SYNCHRONOUS_COMMIT_REMOTE_WRITE, false},
380 {"on", SYNCHRONOUS_COMMIT_ON, false},
381 {"off", SYNCHRONOUS_COMMIT_OFF, false},
382 {"true", SYNCHRONOUS_COMMIT_ON, true},
383 {"false", SYNCHRONOUS_COMMIT_OFF, true},
384 {"yes", SYNCHRONOUS_COMMIT_ON, true},
385 {"no", SYNCHRONOUS_COMMIT_OFF, true},
386 {"1", SYNCHRONOUS_COMMIT_ON, true},
387 {"0", SYNCHRONOUS_COMMIT_OFF, true},
392 * Options for enum values stored in other modules
394 extern const struct config_enum_entry wal_level_options[];
395 extern const struct config_enum_entry sync_method_options[];
398 * GUC option variables that are exported from this module
400 #ifdef USE_ASSERT_CHECKING
401 bool assert_enabled = true;
403 bool assert_enabled = false;
405 bool log_duration = false;
406 bool Debug_print_plan = false;
407 bool Debug_print_parse = false;
408 bool Debug_print_rewritten = false;
409 bool Debug_pretty_print = true;
411 bool log_parser_stats = false;
412 bool log_planner_stats = false;
413 bool log_executor_stats = false;
414 bool log_statement_stats = false; /* this is sort of all three
416 bool log_btree_build_stats = false;
419 bool check_function_bodies = true;
420 bool default_with_oids = false;
421 bool SQL_inheritance = true;
423 bool Password_encryption = true;
425 int log_min_error_statement = ERROR;
426 int log_min_messages = WARNING;
427 int client_min_messages = NOTICE;
428 int log_min_duration_statement = -1;
429 int log_temp_files = -1;
430 int trace_recovery_messages = LOG;
432 int temp_file_limit = -1;
434 int num_temp_buffers = 1024;
436 char *data_directory;
437 char *ConfigFileName;
440 char *external_pid_file;
442 char *pgstat_temp_directory;
444 char *application_name;
446 int tcp_keepalives_idle;
447 int tcp_keepalives_interval;
448 int tcp_keepalives_count;
451 * These variables are all dummies that don't do anything, except in some
452 * cases provide the value for SHOW to display. The real state is elsewhere
453 * and is kept in sync by assign_hooks.
455 static char *log_destination_string;
457 static char *syslog_ident_str;
458 static bool phony_autocommit;
459 static bool session_auth_is_superuser;
460 static double phony_random_seed;
461 static char *client_encoding_string;
462 static char *datestyle_string;
463 static char *locale_collate;
464 static char *locale_ctype;
465 static char *server_encoding_string;
466 static char *server_version_string;
467 static int server_version_num;
468 static char *timezone_string;
469 static char *log_timezone_string;
470 static char *timezone_abbreviations_string;
471 static char *XactIsoLevel_string;
472 static char *session_authorization_string;
473 static int max_function_args;
474 static int max_index_keys;
475 static int max_identifier_length;
476 static int block_size;
477 static int segment_size;
478 static int wal_block_size;
479 static int wal_segment_size;
480 static bool integer_datetimes;
481 static int effective_io_concurrency;
483 /* should be static, but commands/variable.c needs to get at this */
488 * Displayable names for context types (enum GucContext)
490 * Note: these strings are deliberately not localized.
492 const char *const GucContext_Names[] =
494 /* PGC_INTERNAL */ "internal",
495 /* PGC_POSTMASTER */ "postmaster",
496 /* PGC_SIGHUP */ "sighup",
497 /* PGC_BACKEND */ "backend",
498 /* PGC_SUSET */ "superuser",
499 /* PGC_USERSET */ "user"
503 * Displayable names for source types (enum GucSource)
505 * Note: these strings are deliberately not localized.
507 const char *const GucSource_Names[] =
509 /* PGC_S_DEFAULT */ "default",
510 /* PGC_S_DYNAMIC_DEFAULT */ "default",
511 /* PGC_S_ENV_VAR */ "environment variable",
512 /* PGC_S_FILE */ "configuration file",
513 /* PGC_S_ARGV */ "command line",
514 /* PGC_S_DATABASE */ "database",
515 /* PGC_S_USER */ "user",
516 /* PGC_S_DATABASE_USER */ "database user",
517 /* PGC_S_CLIENT */ "client",
518 /* PGC_S_OVERRIDE */ "override",
519 /* PGC_S_INTERACTIVE */ "interactive",
520 /* PGC_S_TEST */ "test",
521 /* PGC_S_SESSION */ "session"
525 * Displayable names for the groupings defined in enum config_group
527 const char *const config_group_names[] =
530 gettext_noop("Ungrouped"),
532 gettext_noop("File Locations"),
534 gettext_noop("Connections and Authentication"),
535 /* CONN_AUTH_SETTINGS */
536 gettext_noop("Connections and Authentication / Connection Settings"),
537 /* CONN_AUTH_SECURITY */
538 gettext_noop("Connections and Authentication / Security and Authentication"),
540 gettext_noop("Resource Usage"),
542 gettext_noop("Resource Usage / Memory"),
544 gettext_noop("Resource Usage / Disk"),
545 /* RESOURCES_KERNEL */
546 gettext_noop("Resource Usage / Kernel Resources"),
547 /* RESOURCES_VACUUM_DELAY */
548 gettext_noop("Resource Usage / Cost-Based Vacuum Delay"),
549 /* RESOURCES_BGWRITER */
550 gettext_noop("Resource Usage / Background Writer"),
551 /* RESOURCES_ASYNCHRONOUS */
552 gettext_noop("Resource Usage / Asynchronous Behavior"),
554 gettext_noop("Write-Ahead Log"),
556 gettext_noop("Write-Ahead Log / Settings"),
557 /* WAL_CHECKPOINTS */
558 gettext_noop("Write-Ahead Log / Checkpoints"),
560 gettext_noop("Write-Ahead Log / Archiving"),
562 gettext_noop("Replication"),
563 /* REPLICATION_SENDING */
564 gettext_noop("Replication / Sending Servers"),
565 /* REPLICATION_MASTER */
566 gettext_noop("Replication / Master Server"),
567 /* REPLICATION_STANDBY */
568 gettext_noop("Replication / Standby Servers"),
570 gettext_noop("Query Tuning"),
571 /* QUERY_TUNING_METHOD */
572 gettext_noop("Query Tuning / Planner Method Configuration"),
573 /* QUERY_TUNING_COST */
574 gettext_noop("Query Tuning / Planner Cost Constants"),
575 /* QUERY_TUNING_GEQO */
576 gettext_noop("Query Tuning / Genetic Query Optimizer"),
577 /* QUERY_TUNING_OTHER */
578 gettext_noop("Query Tuning / Other Planner Options"),
580 gettext_noop("Reporting and Logging"),
582 gettext_noop("Reporting and Logging / Where to Log"),
584 gettext_noop("Reporting and Logging / When to Log"),
586 gettext_noop("Reporting and Logging / What to Log"),
588 gettext_noop("Statistics"),
589 /* STATS_MONITORING */
590 gettext_noop("Statistics / Monitoring"),
591 /* STATS_COLLECTOR */
592 gettext_noop("Statistics / Query and Index Statistics Collector"),
594 gettext_noop("Autovacuum"),
596 gettext_noop("Client Connection Defaults"),
597 /* CLIENT_CONN_STATEMENT */
598 gettext_noop("Client Connection Defaults / Statement Behavior"),
599 /* CLIENT_CONN_LOCALE */
600 gettext_noop("Client Connection Defaults / Locale and Formatting"),
601 /* CLIENT_CONN_OTHER */
602 gettext_noop("Client Connection Defaults / Other Defaults"),
603 /* LOCK_MANAGEMENT */
604 gettext_noop("Lock Management"),
606 gettext_noop("Version and Platform Compatibility"),
607 /* COMPAT_OPTIONS_PREVIOUS */
608 gettext_noop("Version and Platform Compatibility / Previous PostgreSQL Versions"),
609 /* COMPAT_OPTIONS_CLIENT */
610 gettext_noop("Version and Platform Compatibility / Other Platforms and Clients"),
612 gettext_noop("Error Handling"),
614 gettext_noop("Preset Options"),
616 gettext_noop("Customized Options"),
617 /* DEVELOPER_OPTIONS */
618 gettext_noop("Developer Options"),
619 /* help_config wants this array to be null-terminated */
624 * Displayable names for GUC variable types (enum config_type)
626 * Note: these strings are deliberately not localized.
628 const char *const config_type_names[] =
630 /* PGC_BOOL */ "bool",
631 /* PGC_INT */ "integer",
632 /* PGC_REAL */ "real",
633 /* PGC_STRING */ "string",
634 /* PGC_ENUM */ "enum"
639 * Contents of GUC tables
641 * See src/backend/utils/misc/README for design notes.
645 * 1. Declare a global variable of type bool, int, double, or char*
646 * and make use of it.
648 * 2. Decide at what times it's safe to set the option. See guc.h for
651 * 3. Decide on a name, a default value, upper and lower bounds (if
654 * 4. Add a record below.
656 * 5. Add it to src/backend/utils/misc/postgresql.conf.sample, if
659 * 6. Don't forget to document the option (at least in config.sgml).
661 * 7. If it's a new GUC_LIST option you must edit pg_dumpall.c to ensure
662 * it is not single quoted at dump time.
666 /******** option records follow ********/
668 static struct config_bool ConfigureNamesBool[] =
671 {"enable_seqscan", PGC_USERSET, QUERY_TUNING_METHOD,
672 gettext_noop("Enables the planner's use of sequential-scan plans."),
680 {"enable_indexscan", PGC_USERSET, QUERY_TUNING_METHOD,
681 gettext_noop("Enables the planner's use of index-scan plans."),
689 {"enable_indexonlyscan", PGC_USERSET, QUERY_TUNING_METHOD,
690 gettext_noop("Enables the planner's use of index-only-scan plans."),
693 &enable_indexonlyscan,
698 {"enable_bitmapscan", PGC_USERSET, QUERY_TUNING_METHOD,
699 gettext_noop("Enables the planner's use of bitmap-scan plans."),
707 {"enable_tidscan", PGC_USERSET, QUERY_TUNING_METHOD,
708 gettext_noop("Enables the planner's use of TID scan plans."),
716 {"enable_sort", PGC_USERSET, QUERY_TUNING_METHOD,
717 gettext_noop("Enables the planner's use of explicit sort steps."),
725 {"enable_hashagg", PGC_USERSET, QUERY_TUNING_METHOD,
726 gettext_noop("Enables the planner's use of hashed aggregation plans."),
734 {"enable_material", PGC_USERSET, QUERY_TUNING_METHOD,
735 gettext_noop("Enables the planner's use of materialization."),
743 {"enable_nestloop", PGC_USERSET, QUERY_TUNING_METHOD,
744 gettext_noop("Enables the planner's use of nested-loop join plans."),
752 {"enable_mergejoin", PGC_USERSET, QUERY_TUNING_METHOD,
753 gettext_noop("Enables the planner's use of merge join plans."),
761 {"enable_hashjoin", PGC_USERSET, QUERY_TUNING_METHOD,
762 gettext_noop("Enables the planner's use of hash join plans."),
770 {"geqo", PGC_USERSET, QUERY_TUNING_GEQO,
771 gettext_noop("Enables genetic query optimization."),
772 gettext_noop("This algorithm attempts to do planning without "
773 "exhaustive searching.")
780 /* Not for general use --- used by SET SESSION AUTHORIZATION */
781 {"is_superuser", PGC_INTERNAL, UNGROUPED,
782 gettext_noop("Shows whether the current user is a superuser."),
784 GUC_REPORT | GUC_NO_SHOW_ALL | GUC_NO_RESET_ALL | GUC_NOT_IN_SAMPLE | GUC_DISALLOW_IN_FILE
786 &session_auth_is_superuser,
791 {"bonjour", PGC_POSTMASTER, CONN_AUTH_SETTINGS,
792 gettext_noop("Enables advertising the server via Bonjour."),
797 check_bonjour, NULL, NULL
800 {"ssl", PGC_POSTMASTER, CONN_AUTH_SECURITY,
801 gettext_noop("Enables SSL connections."),
806 check_ssl, NULL, NULL
809 {"fsync", PGC_SIGHUP, WAL_SETTINGS,
810 gettext_noop("Forces synchronization of updates to disk."),
811 gettext_noop("The server will use the fsync() system call in several places to make "
812 "sure that updates are physically written to disk. This insures "
813 "that a database cluster will recover to a consistent state after "
814 "an operating system or hardware crash.")
821 {"zero_damaged_pages", PGC_SUSET, DEVELOPER_OPTIONS,
822 gettext_noop("Continues processing past damaged page headers."),
823 gettext_noop("Detection of a damaged page header normally causes PostgreSQL to "
824 "report an error, aborting the current transaction. Setting "
825 "zero_damaged_pages to true causes the system to instead report a "
826 "warning, zero out the damaged page, and continue processing. This "
827 "behavior will destroy data, namely all the rows on the damaged page."),
835 {"full_page_writes", PGC_SIGHUP, WAL_SETTINGS,
836 gettext_noop("Writes full pages to WAL when first modified after a checkpoint."),
837 gettext_noop("A page write in process during an operating system crash might be "
838 "only partially written to disk. During recovery, the row changes "
839 "stored in WAL are not enough to recover. This option writes "
840 "pages when first modified after a checkpoint to WAL so full recovery "
848 {"log_checkpoints", PGC_SIGHUP, LOGGING_WHAT,
849 gettext_noop("Logs each checkpoint."),
857 {"log_connections", PGC_BACKEND, LOGGING_WHAT,
858 gettext_noop("Logs each successful connection."),
866 {"log_disconnections", PGC_BACKEND, LOGGING_WHAT,
867 gettext_noop("Logs end of a session, including duration."),
875 {"debug_assertions", PGC_USERSET, DEVELOPER_OPTIONS,
876 gettext_noop("Turns on various assertion checks."),
877 gettext_noop("This is a debugging aid."),
881 #ifdef USE_ASSERT_CHECKING
886 check_debug_assertions, NULL, NULL
890 {"exit_on_error", PGC_USERSET, ERROR_HANDLING_OPTIONS,
891 gettext_noop("Terminate session on any error."),
899 {"restart_after_crash", PGC_SIGHUP, ERROR_HANDLING_OPTIONS,
900 gettext_noop("Reinitialize server after backend crash."),
903 &restart_after_crash,
909 {"log_duration", PGC_SUSET, LOGGING_WHAT,
910 gettext_noop("Logs the duration of each completed SQL statement."),
918 {"debug_print_parse", PGC_USERSET, LOGGING_WHAT,
919 gettext_noop("Logs each query's parse tree."),
927 {"debug_print_rewritten", PGC_USERSET, LOGGING_WHAT,
928 gettext_noop("Logs each query's rewritten parse tree."),
931 &Debug_print_rewritten,
936 {"debug_print_plan", PGC_USERSET, LOGGING_WHAT,
937 gettext_noop("Logs each query's execution plan."),
945 {"debug_pretty_print", PGC_USERSET, LOGGING_WHAT,
946 gettext_noop("Indents parse and plan tree displays."),
954 {"log_parser_stats", PGC_SUSET, STATS_MONITORING,
955 gettext_noop("Writes parser performance statistics to the server log."),
960 check_stage_log_stats, NULL, NULL
963 {"log_planner_stats", PGC_SUSET, STATS_MONITORING,
964 gettext_noop("Writes planner performance statistics to the server log."),
969 check_stage_log_stats, NULL, NULL
972 {"log_executor_stats", PGC_SUSET, STATS_MONITORING,
973 gettext_noop("Writes executor performance statistics to the server log."),
978 check_stage_log_stats, NULL, NULL
981 {"log_statement_stats", PGC_SUSET, STATS_MONITORING,
982 gettext_noop("Writes cumulative performance statistics to the server log."),
985 &log_statement_stats,
987 check_log_stats, NULL, NULL
989 #ifdef BTREE_BUILD_STATS
991 {"log_btree_build_stats", PGC_SUSET, DEVELOPER_OPTIONS,
992 gettext_noop("No description available."),
996 &log_btree_build_stats,
1003 {"track_activities", PGC_SUSET, STATS_COLLECTOR,
1004 gettext_noop("Collects information about executing commands."),
1005 gettext_noop("Enables the collection of information on the currently "
1006 "executing command of each session, along with "
1007 "the time at which that command began execution.")
1009 &pgstat_track_activities,
1014 {"track_counts", PGC_SUSET, STATS_COLLECTOR,
1015 gettext_noop("Collects statistics on database activity."),
1018 &pgstat_track_counts,
1023 {"track_io_timing", PGC_SUSET, STATS_COLLECTOR,
1024 gettext_noop("Collects timing statistics for database I/O activity."),
1033 {"update_process_title", PGC_SUSET, STATS_COLLECTOR,
1034 gettext_noop("Updates the process title to show the active SQL command."),
1035 gettext_noop("Enables updating of the process title every time a new SQL command is received by the server.")
1037 &update_process_title,
1043 {"autovacuum", PGC_SIGHUP, AUTOVACUUM,
1044 gettext_noop("Starts the autovacuum subprocess."),
1047 &autovacuum_start_daemon,
1053 {"trace_notify", PGC_USERSET, DEVELOPER_OPTIONS,
1054 gettext_noop("Generates debugging output for LISTEN and NOTIFY."),
1065 {"trace_locks", PGC_SUSET, DEVELOPER_OPTIONS,
1066 gettext_noop("No description available."),
1075 {"trace_userlocks", PGC_SUSET, DEVELOPER_OPTIONS,
1076 gettext_noop("No description available."),
1085 {"trace_lwlocks", PGC_SUSET, DEVELOPER_OPTIONS,
1086 gettext_noop("No description available."),
1095 {"debug_deadlocks", PGC_SUSET, DEVELOPER_OPTIONS,
1096 gettext_noop("No description available."),
1107 {"log_lock_waits", PGC_SUSET, LOGGING_WHAT,
1108 gettext_noop("Logs long lock waits."),
1117 {"log_hostname", PGC_SIGHUP, LOGGING_WHAT,
1118 gettext_noop("Logs the host name in the connection logs."),
1119 gettext_noop("By default, connection logs only show the IP address "
1120 "of the connecting host. If you want them to show the host name you "
1121 "can turn this on, but depending on your host name resolution "
1122 "setup it might impose a non-negligible performance penalty.")
1129 {"sql_inheritance", PGC_USERSET, COMPAT_OPTIONS_PREVIOUS,
1130 gettext_noop("Causes subtables to be included by default in various commands."),
1138 {"password_encryption", PGC_USERSET, CONN_AUTH_SECURITY,
1139 gettext_noop("Encrypt passwords."),
1140 gettext_noop("When a password is specified in CREATE USER or "
1141 "ALTER USER without writing either ENCRYPTED or UNENCRYPTED, "
1142 "this parameter determines whether the password is to be encrypted.")
1144 &Password_encryption,
1149 {"transform_null_equals", PGC_USERSET, COMPAT_OPTIONS_CLIENT,
1150 gettext_noop("Treats \"expr=NULL\" as \"expr IS NULL\"."),
1151 gettext_noop("When turned on, expressions of the form expr = NULL "
1152 "(or NULL = expr) are treated as expr IS NULL, that is, they "
1153 "return true if expr evaluates to the null value, and false "
1154 "otherwise. The correct behavior of expr = NULL is to always "
1155 "return null (unknown).")
1157 &Transform_null_equals,
1162 {"db_user_namespace", PGC_SIGHUP, CONN_AUTH_SECURITY,
1163 gettext_noop("Enables per-database user names."),
1171 /* only here for backwards compatibility */
1172 {"autocommit", PGC_USERSET, CLIENT_CONN_STATEMENT,
1173 gettext_noop("This parameter doesn't do anything."),
1174 gettext_noop("It's just here so that we won't choke on SET AUTOCOMMIT TO ON from 7.3-vintage clients."),
1175 GUC_NO_SHOW_ALL | GUC_NOT_IN_SAMPLE
1179 check_phony_autocommit, NULL, NULL
1182 {"default_transaction_read_only", PGC_USERSET, CLIENT_CONN_STATEMENT,
1183 gettext_noop("Sets the default read-only status of new transactions."),
1186 &DefaultXactReadOnly,
1191 {"transaction_read_only", PGC_USERSET, CLIENT_CONN_STATEMENT,
1192 gettext_noop("Sets the current transaction's read-only status."),
1194 GUC_NO_RESET_ALL | GUC_NOT_IN_SAMPLE | GUC_DISALLOW_IN_FILE
1198 check_transaction_read_only, NULL, NULL
1201 {"default_transaction_deferrable", PGC_USERSET, CLIENT_CONN_STATEMENT,
1202 gettext_noop("Sets the default deferrable status of new transactions."),
1205 &DefaultXactDeferrable,
1210 {"transaction_deferrable", PGC_USERSET, CLIENT_CONN_STATEMENT,
1211 gettext_noop("Whether to defer a read-only serializable transaction until it can be executed with no possible serialization failures."),
1213 GUC_NO_RESET_ALL | GUC_NOT_IN_SAMPLE | GUC_DISALLOW_IN_FILE
1217 check_transaction_deferrable, NULL, NULL
1220 {"check_function_bodies", PGC_USERSET, CLIENT_CONN_STATEMENT,
1221 gettext_noop("Check function bodies during CREATE FUNCTION."),
1224 &check_function_bodies,
1229 {"array_nulls", PGC_USERSET, COMPAT_OPTIONS_PREVIOUS,
1230 gettext_noop("Enable input of NULL elements in arrays."),
1231 gettext_noop("When turned on, unquoted NULL in an array input "
1232 "value means a null value; "
1233 "otherwise it is taken literally.")
1240 {"default_with_oids", PGC_USERSET, COMPAT_OPTIONS_PREVIOUS,
1241 gettext_noop("Create new tables with OIDs by default."),
1249 {"logging_collector", PGC_POSTMASTER, LOGGING_WHERE,
1250 gettext_noop("Start a subprocess to capture stderr output and/or csvlogs into log files."),
1258 {"log_truncate_on_rotation", PGC_SIGHUP, LOGGING_WHERE,
1259 gettext_noop("Truncate existing log files of same name during log rotation."),
1262 &Log_truncate_on_rotation,
1269 {"trace_sort", PGC_USERSET, DEVELOPER_OPTIONS,
1270 gettext_noop("Emit information about resource usage in sorting."),
1280 #ifdef TRACE_SYNCSCAN
1281 /* this is undocumented because not exposed in a standard build */
1283 {"trace_syncscan", PGC_USERSET, DEVELOPER_OPTIONS,
1284 gettext_noop("Generate debugging output for synchronized scanning."),
1294 #ifdef DEBUG_BOUNDED_SORT
1295 /* this is undocumented because not exposed in a standard build */
1298 "optimize_bounded_sort", PGC_USERSET, QUERY_TUNING_METHOD,
1299 gettext_noop("Enable bounded sorting using heap sort."),
1303 &optimize_bounded_sort,
1311 {"wal_debug", PGC_SUSET, DEVELOPER_OPTIONS,
1312 gettext_noop("Emit WAL-related debugging output."),
1323 {"integer_datetimes", PGC_INTERNAL, PRESET_OPTIONS,
1324 gettext_noop("Datetimes are integer based."),
1326 GUC_REPORT | GUC_NOT_IN_SAMPLE | GUC_DISALLOW_IN_FILE
1329 #ifdef HAVE_INT64_TIMESTAMP
1338 {"krb_caseins_users", PGC_SIGHUP, CONN_AUTH_SECURITY,
1339 gettext_noop("Sets whether Kerberos and GSSAPI user names should be treated as case-insensitive."),
1342 &pg_krb_caseins_users,
1348 {"escape_string_warning", PGC_USERSET, COMPAT_OPTIONS_PREVIOUS,
1349 gettext_noop("Warn about backslash escapes in ordinary string literals."),
1352 &escape_string_warning,
1358 {"standard_conforming_strings", PGC_USERSET, COMPAT_OPTIONS_PREVIOUS,
1359 gettext_noop("Causes '...' strings to treat backslashes literally."),
1363 &standard_conforming_strings,
1369 {"synchronize_seqscans", PGC_USERSET, COMPAT_OPTIONS_PREVIOUS,
1370 gettext_noop("Enable synchronized sequential scans."),
1373 &synchronize_seqscans,
1379 {"archive_mode", PGC_POSTMASTER, WAL_ARCHIVING,
1380 gettext_noop("Allows archiving of WAL files using archive_command."),
1389 {"hot_standby", PGC_POSTMASTER, REPLICATION_STANDBY,
1390 gettext_noop("Allows connections and queries during recovery."),
1399 {"hot_standby_feedback", PGC_SIGHUP, REPLICATION_STANDBY,
1400 gettext_noop("Allows feedback from a hot standby to the primary that will avoid query conflicts."),
1403 &hot_standby_feedback,
1409 {"allow_system_table_mods", PGC_POSTMASTER, DEVELOPER_OPTIONS,
1410 gettext_noop("Allows modifications of the structure of system tables."),
1414 &allowSystemTableMods,
1420 {"ignore_system_indexes", PGC_BACKEND, DEVELOPER_OPTIONS,
1421 gettext_noop("Disables reading from system indexes."),
1422 gettext_noop("It does not prevent updating the indexes, so it is safe "
1423 "to use. The worst consequence is slowness."),
1426 &IgnoreSystemIndexes,
1432 {"lo_compat_privileges", PGC_SUSET, COMPAT_OPTIONS_PREVIOUS,
1433 gettext_noop("Enables backward compatibility mode for privilege checks on large objects."),
1434 gettext_noop("Skips privilege checks when reading or modifying large objects, "
1435 "for compatibility with PostgreSQL releases prior to 9.0.")
1437 &lo_compat_privileges,
1443 {"quote_all_identifiers", PGC_USERSET, COMPAT_OPTIONS_PREVIOUS,
1444 gettext_noop("When generating SQL fragments, quote all identifiers."),
1447 "e_all_identifiers,
1452 /* End-of-list marker */
1454 {NULL, 0, 0, NULL, NULL}, NULL, false, NULL, NULL, NULL
1459 static struct config_int ConfigureNamesInt[] =
1462 {"archive_timeout", PGC_SIGHUP, WAL_ARCHIVING,
1463 gettext_noop("Forces a switch to the next xlog file if a "
1464 "new file has not been started within N seconds."),
1468 &XLogArchiveTimeout,
1473 {"post_auth_delay", PGC_BACKEND, DEVELOPER_OPTIONS,
1474 gettext_noop("Waits N seconds on connection startup after authentication."),
1475 gettext_noop("This allows attaching a debugger to the process."),
1476 GUC_NOT_IN_SAMPLE | GUC_UNIT_S
1483 {"default_statistics_target", PGC_USERSET, QUERY_TUNING_OTHER,
1484 gettext_noop("Sets the default statistics target."),
1485 gettext_noop("This applies to table columns that have not had a "
1486 "column-specific target set via ALTER TABLE SET STATISTICS.")
1488 &default_statistics_target,
1493 {"from_collapse_limit", PGC_USERSET, QUERY_TUNING_OTHER,
1494 gettext_noop("Sets the FROM-list size beyond which subqueries "
1495 "are not collapsed."),
1496 gettext_noop("The planner will merge subqueries into upper "
1497 "queries if the resulting FROM list would have no more than "
1500 &from_collapse_limit,
1505 {"join_collapse_limit", PGC_USERSET, QUERY_TUNING_OTHER,
1506 gettext_noop("Sets the FROM-list size beyond which JOIN "
1507 "constructs are not flattened."),
1508 gettext_noop("The planner will flatten explicit JOIN "
1509 "constructs into lists of FROM items whenever a "
1510 "list of no more than this many items would result.")
1512 &join_collapse_limit,
1517 {"geqo_threshold", PGC_USERSET, QUERY_TUNING_GEQO,
1518 gettext_noop("Sets the threshold of FROM items beyond which GEQO is used."),
1526 {"geqo_effort", PGC_USERSET, QUERY_TUNING_GEQO,
1527 gettext_noop("GEQO: effort is used to set the default for other GEQO parameters."),
1531 DEFAULT_GEQO_EFFORT, MIN_GEQO_EFFORT, MAX_GEQO_EFFORT,
1535 {"geqo_pool_size", PGC_USERSET, QUERY_TUNING_GEQO,
1536 gettext_noop("GEQO: number of individuals in the population."),
1537 gettext_noop("Zero selects a suitable default value.")
1544 {"geqo_generations", PGC_USERSET, QUERY_TUNING_GEQO,
1545 gettext_noop("GEQO: number of iterations of the algorithm."),
1546 gettext_noop("Zero selects a suitable default value.")
1554 /* This is PGC_SUSET to prevent hiding from log_lock_waits. */
1555 {"deadlock_timeout", PGC_SUSET, LOCK_MANAGEMENT,
1556 gettext_noop("Sets the time to wait on a lock before checking for deadlock."),
1566 {"max_standby_archive_delay", PGC_SIGHUP, REPLICATION_STANDBY,
1567 gettext_noop("Sets the maximum delay before canceling queries when a hot standby server is processing archived WAL data."),
1571 &max_standby_archive_delay,
1572 30 * 1000, -1, INT_MAX,
1577 {"max_standby_streaming_delay", PGC_SIGHUP, REPLICATION_STANDBY,
1578 gettext_noop("Sets the maximum delay before canceling queries when a hot standby server is processing streamed WAL data."),
1582 &max_standby_streaming_delay,
1583 30 * 1000, -1, INT_MAX,
1588 {"wal_receiver_status_interval", PGC_SIGHUP, REPLICATION_STANDBY,
1589 gettext_noop("Sets the maximum interval between WAL receiver status reports to the primary."),
1593 &wal_receiver_status_interval,
1594 10, 0, INT_MAX / 1000,
1599 {"max_connections", PGC_POSTMASTER, CONN_AUTH_SETTINGS,
1600 gettext_noop("Sets the maximum number of concurrent connections."),
1604 100, 1, MAX_BACKENDS,
1605 check_maxconnections, assign_maxconnections, NULL
1609 {"superuser_reserved_connections", PGC_POSTMASTER, CONN_AUTH_SETTINGS,
1610 gettext_noop("Sets the number of connection slots reserved for superusers."),
1619 * We sometimes multiply the number of shared buffers by two without
1620 * checking for overflow, so we mustn't allow more than INT_MAX / 2.
1623 {"shared_buffers", PGC_POSTMASTER, RESOURCES_MEM,
1624 gettext_noop("Sets the number of shared memory buffers used by the server."),
1629 1024, 16, INT_MAX / 2,
1634 {"temp_buffers", PGC_USERSET, RESOURCES_MEM,
1635 gettext_noop("Sets the maximum number of temporary buffers used by each session."),
1640 1024, 100, INT_MAX / 2,
1641 check_temp_buffers, NULL, NULL
1645 {"port", PGC_POSTMASTER, CONN_AUTH_SETTINGS,
1646 gettext_noop("Sets the TCP port the server listens on."),
1650 DEF_PGPORT, 1, 65535,
1655 {"unix_socket_permissions", PGC_POSTMASTER, CONN_AUTH_SETTINGS,
1656 gettext_noop("Sets the access permissions of the Unix-domain socket."),
1657 gettext_noop("Unix-domain sockets use the usual Unix file system "
1658 "permission set. The parameter value is expected "
1659 "to be a numeric mode specification in the form "
1660 "accepted by the chmod and umask system calls. "
1661 "(To use the customary octal format the number must "
1662 "start with a 0 (zero).)")
1664 &Unix_socket_permissions,
1666 NULL, NULL, show_unix_socket_permissions
1670 {"log_file_mode", PGC_SIGHUP, LOGGING_WHERE,
1671 gettext_noop("Sets the file permissions for log files."),
1672 gettext_noop("The parameter value is expected "
1673 "to be a numeric mode specification in the form "
1674 "accepted by the chmod and umask system calls. "
1675 "(To use the customary octal format the number must "
1676 "start with a 0 (zero).)")
1680 NULL, NULL, show_log_file_mode
1684 {"work_mem", PGC_USERSET, RESOURCES_MEM,
1685 gettext_noop("Sets the maximum memory to be used for query workspaces."),
1686 gettext_noop("This much memory can be used by each internal "
1687 "sort operation and hash table before switching to "
1688 "temporary disk files."),
1692 1024, 64, MAX_KILOBYTES,
1697 {"maintenance_work_mem", PGC_USERSET, RESOURCES_MEM,
1698 gettext_noop("Sets the maximum memory to be used for maintenance operations."),
1699 gettext_noop("This includes operations such as VACUUM and CREATE INDEX."),
1702 &maintenance_work_mem,
1703 16384, 1024, MAX_KILOBYTES,
1708 * We use the hopefully-safely-small value of 100kB as the compiled-in
1709 * default for max_stack_depth. InitializeGUCOptions will increase it if
1710 * possible, depending on the actual platform-specific stack limit.
1713 {"max_stack_depth", PGC_SUSET, RESOURCES_MEM,
1714 gettext_noop("Sets the maximum stack depth, in kilobytes."),
1719 100, 100, MAX_KILOBYTES,
1720 check_max_stack_depth, assign_max_stack_depth, NULL
1724 {"temp_file_limit", PGC_SUSET, RESOURCES_DISK,
1725 gettext_noop("Limits the total size of all temporary files used by each session."),
1726 gettext_noop("-1 means no limit."),
1735 {"vacuum_cost_page_hit", PGC_USERSET, RESOURCES_VACUUM_DELAY,
1736 gettext_noop("Vacuum cost for a page found in the buffer cache."),
1745 {"vacuum_cost_page_miss", PGC_USERSET, RESOURCES_VACUUM_DELAY,
1746 gettext_noop("Vacuum cost for a page not found in the buffer cache."),
1749 &VacuumCostPageMiss,
1755 {"vacuum_cost_page_dirty", PGC_USERSET, RESOURCES_VACUUM_DELAY,
1756 gettext_noop("Vacuum cost for a page dirtied by vacuum."),
1759 &VacuumCostPageDirty,
1765 {"vacuum_cost_limit", PGC_USERSET, RESOURCES_VACUUM_DELAY,
1766 gettext_noop("Vacuum cost amount available before napping."),
1775 {"vacuum_cost_delay", PGC_USERSET, RESOURCES_VACUUM_DELAY,
1776 gettext_noop("Vacuum cost delay in milliseconds."),
1786 {"autovacuum_vacuum_cost_delay", PGC_SIGHUP, AUTOVACUUM,
1787 gettext_noop("Vacuum cost delay in milliseconds, for autovacuum."),
1791 &autovacuum_vac_cost_delay,
1797 {"autovacuum_vacuum_cost_limit", PGC_SIGHUP, AUTOVACUUM,
1798 gettext_noop("Vacuum cost amount available before napping, for autovacuum."),
1801 &autovacuum_vac_cost_limit,
1807 {"max_files_per_process", PGC_POSTMASTER, RESOURCES_KERNEL,
1808 gettext_noop("Sets the maximum number of simultaneously open files for each server process."),
1811 &max_files_per_process,
1817 * See also CheckRequiredParameterValues() if this parameter changes
1820 {"max_prepared_transactions", PGC_POSTMASTER, RESOURCES_MEM,
1821 gettext_noop("Sets the maximum number of simultaneously prepared transactions."),
1824 &max_prepared_xacts,
1831 {"trace_lock_oidmin", PGC_SUSET, DEVELOPER_OPTIONS,
1832 gettext_noop("No description available."),
1837 FirstNormalObjectId, 0, INT_MAX,
1841 {"trace_lock_table", PGC_SUSET, DEVELOPER_OPTIONS,
1842 gettext_noop("No description available."),
1853 {"statement_timeout", PGC_USERSET, CLIENT_CONN_STATEMENT,
1854 gettext_noop("Sets the maximum allowed duration of any statement."),
1855 gettext_noop("A value of 0 turns off the timeout."),
1864 {"vacuum_freeze_min_age", PGC_USERSET, CLIENT_CONN_STATEMENT,
1865 gettext_noop("Minimum age at which VACUUM should freeze a table row."),
1868 &vacuum_freeze_min_age,
1869 50000000, 0, 1000000000,
1874 {"vacuum_freeze_table_age", PGC_USERSET, CLIENT_CONN_STATEMENT,
1875 gettext_noop("Age at which VACUUM should scan whole table to freeze tuples."),
1878 &vacuum_freeze_table_age,
1879 150000000, 0, 2000000000,
1884 {"vacuum_defer_cleanup_age", PGC_SIGHUP, REPLICATION_MASTER,
1885 gettext_noop("Number of transactions by which VACUUM and HOT cleanup should be deferred, if any."),
1888 &vacuum_defer_cleanup_age,
1894 * See also CheckRequiredParameterValues() if this parameter changes
1897 {"max_locks_per_transaction", PGC_POSTMASTER, LOCK_MANAGEMENT,
1898 gettext_noop("Sets the maximum number of locks per transaction."),
1899 gettext_noop("The shared lock table is sized on the assumption that "
1900 "at most max_locks_per_transaction * max_connections distinct "
1901 "objects will need to be locked at any one time.")
1903 &max_locks_per_xact,
1909 {"max_pred_locks_per_transaction", PGC_POSTMASTER, LOCK_MANAGEMENT,
1910 gettext_noop("Sets the maximum number of predicate locks per transaction."),
1911 gettext_noop("The shared predicate lock table is sized on the assumption that "
1912 "at most max_pred_locks_per_transaction * max_connections distinct "
1913 "objects will need to be locked at any one time.")
1915 &max_predicate_locks_per_xact,
1921 {"authentication_timeout", PGC_SIGHUP, CONN_AUTH_SECURITY,
1922 gettext_noop("Sets the maximum allowed time to complete client authentication."),
1926 &AuthenticationTimeout,
1932 /* Not for general use */
1933 {"pre_auth_delay", PGC_SIGHUP, DEVELOPER_OPTIONS,
1934 gettext_noop("Waits N seconds on connection startup before authentication."),
1935 gettext_noop("This allows attaching a debugger to the process."),
1936 GUC_NOT_IN_SAMPLE | GUC_UNIT_S
1944 {"wal_keep_segments", PGC_SIGHUP, REPLICATION_SENDING,
1945 gettext_noop("Sets the number of WAL files held for standby servers."),
1954 {"checkpoint_segments", PGC_SIGHUP, WAL_CHECKPOINTS,
1955 gettext_noop("Sets the maximum distance in log segments between automatic WAL checkpoints."),
1958 &CheckPointSegments,
1964 {"checkpoint_timeout", PGC_SIGHUP, WAL_CHECKPOINTS,
1965 gettext_noop("Sets the maximum time between automatic WAL checkpoints."),
1975 {"checkpoint_warning", PGC_SIGHUP, WAL_CHECKPOINTS,
1976 gettext_noop("Enables warnings if checkpoint segments are filled more "
1977 "frequently than this."),
1978 gettext_noop("Write a message to the server log if checkpoints "
1979 "caused by the filling of checkpoint segment files happens more "
1980 "frequently than this number of seconds. Zero turns off the warning."),
1989 {"wal_buffers", PGC_POSTMASTER, WAL_SETTINGS,
1990 gettext_noop("Sets the number of disk-page buffers in shared memory for WAL."),
1996 check_wal_buffers, NULL, NULL
2000 {"wal_writer_delay", PGC_SIGHUP, WAL_SETTINGS,
2001 gettext_noop("WAL writer sleep time between WAL flushes."),
2011 /* see max_connections */
2012 {"max_wal_senders", PGC_POSTMASTER, REPLICATION_SENDING,
2013 gettext_noop("Sets the maximum number of simultaneously running WAL sender processes."),
2022 {"replication_timeout", PGC_SIGHUP, REPLICATION_SENDING,
2023 gettext_noop("Sets the maximum time to wait for WAL replication."),
2027 &replication_timeout,
2028 60 * 1000, 0, INT_MAX,
2033 {"commit_delay", PGC_USERSET, WAL_SETTINGS,
2034 gettext_noop("Sets the delay in microseconds between transaction commit and "
2035 "flushing WAL to disk."),
2037 /* we have no microseconds designation, so can't supply units here */
2045 {"commit_siblings", PGC_USERSET, WAL_SETTINGS,
2046 gettext_noop("Sets the minimum concurrent open transactions before performing "
2056 {"extra_float_digits", PGC_USERSET, CLIENT_CONN_LOCALE,
2057 gettext_noop("Sets the number of digits displayed for floating-point values."),
2058 gettext_noop("This affects real, double precision, and geometric data types. "
2059 "The parameter value is added to the standard number of digits "
2060 "(FLT_DIG or DBL_DIG as appropriate).")
2062 &extra_float_digits,
2068 {"log_min_duration_statement", PGC_SUSET, LOGGING_WHEN,
2069 gettext_noop("Sets the minimum execution time above which "
2070 "statements will be logged."),
2071 gettext_noop("Zero prints all queries. -1 turns this feature off."),
2074 &log_min_duration_statement,
2080 {"log_autovacuum_min_duration", PGC_SIGHUP, LOGGING_WHAT,
2081 gettext_noop("Sets the minimum execution time above which "
2082 "autovacuum actions will be logged."),
2083 gettext_noop("Zero prints all actions. -1 turns autovacuum logging off."),
2086 &Log_autovacuum_min_duration,
2092 {"bgwriter_delay", PGC_SIGHUP, RESOURCES_BGWRITER,
2093 gettext_noop("Background writer sleep time between rounds."),
2103 {"bgwriter_lru_maxpages", PGC_SIGHUP, RESOURCES_BGWRITER,
2104 gettext_noop("Background writer maximum number of LRU pages to flush per round."),
2107 &bgwriter_lru_maxpages,
2113 {"effective_io_concurrency",
2119 RESOURCES_ASYNCHRONOUS,
2120 gettext_noop("Number of simultaneous requests that can be handled efficiently by the disk subsystem."),
2121 gettext_noop("For RAID arrays, this should be approximately the number of drive spindles in the array.")
2123 &effective_io_concurrency,
2129 check_effective_io_concurrency, assign_effective_io_concurrency, NULL
2133 {"log_rotation_age", PGC_SIGHUP, LOGGING_WHERE,
2134 gettext_noop("Automatic log file rotation will occur after N minutes."),
2139 HOURS_PER_DAY * MINS_PER_HOUR, 0, INT_MAX / MINS_PER_HOUR,
2144 {"log_rotation_size", PGC_SIGHUP, LOGGING_WHERE,
2145 gettext_noop("Automatic log file rotation will occur after N kilobytes."),
2150 10 * 1024, 0, INT_MAX / 1024,
2155 {"max_function_args", PGC_INTERNAL, PRESET_OPTIONS,
2156 gettext_noop("Shows the maximum number of function arguments."),
2158 GUC_NOT_IN_SAMPLE | GUC_DISALLOW_IN_FILE
2161 FUNC_MAX_ARGS, FUNC_MAX_ARGS, FUNC_MAX_ARGS,
2166 {"max_index_keys", PGC_INTERNAL, PRESET_OPTIONS,
2167 gettext_noop("Shows the maximum number of index keys."),
2169 GUC_NOT_IN_SAMPLE | GUC_DISALLOW_IN_FILE
2172 INDEX_MAX_KEYS, INDEX_MAX_KEYS, INDEX_MAX_KEYS,
2177 {"max_identifier_length", PGC_INTERNAL, PRESET_OPTIONS,
2178 gettext_noop("Shows the maximum identifier length."),
2180 GUC_NOT_IN_SAMPLE | GUC_DISALLOW_IN_FILE
2182 &max_identifier_length,
2183 NAMEDATALEN - 1, NAMEDATALEN - 1, NAMEDATALEN - 1,
2188 {"block_size", PGC_INTERNAL, PRESET_OPTIONS,
2189 gettext_noop("Shows the size of a disk block."),
2191 GUC_NOT_IN_SAMPLE | GUC_DISALLOW_IN_FILE
2194 BLCKSZ, BLCKSZ, BLCKSZ,
2199 {"segment_size", PGC_INTERNAL, PRESET_OPTIONS,
2200 gettext_noop("Shows the number of pages per disk file."),
2202 GUC_UNIT_BLOCKS | GUC_NOT_IN_SAMPLE | GUC_DISALLOW_IN_FILE
2205 RELSEG_SIZE, RELSEG_SIZE, RELSEG_SIZE,
2210 {"wal_block_size", PGC_INTERNAL, PRESET_OPTIONS,
2211 gettext_noop("Shows the block size in the write ahead log."),
2213 GUC_NOT_IN_SAMPLE | GUC_DISALLOW_IN_FILE
2216 XLOG_BLCKSZ, XLOG_BLCKSZ, XLOG_BLCKSZ,
2221 {"wal_segment_size", PGC_INTERNAL, PRESET_OPTIONS,
2222 gettext_noop("Shows the number of pages per write ahead log segment."),
2224 GUC_UNIT_XBLOCKS | GUC_NOT_IN_SAMPLE | GUC_DISALLOW_IN_FILE
2227 (XLOG_SEG_SIZE / XLOG_BLCKSZ),
2228 (XLOG_SEG_SIZE / XLOG_BLCKSZ),
2229 (XLOG_SEG_SIZE / XLOG_BLCKSZ),
2234 {"autovacuum_naptime", PGC_SIGHUP, AUTOVACUUM,
2235 gettext_noop("Time to sleep between autovacuum runs."),
2239 &autovacuum_naptime,
2240 60, 1, INT_MAX / 1000,
2244 {"autovacuum_vacuum_threshold", PGC_SIGHUP, AUTOVACUUM,
2245 gettext_noop("Minimum number of tuple updates or deletes prior to vacuum."),
2248 &autovacuum_vac_thresh,
2253 {"autovacuum_analyze_threshold", PGC_SIGHUP, AUTOVACUUM,
2254 gettext_noop("Minimum number of tuple inserts, updates, or deletes prior to analyze."),
2257 &autovacuum_anl_thresh,
2262 /* see varsup.c for why this is PGC_POSTMASTER not PGC_SIGHUP */
2263 {"autovacuum_freeze_max_age", PGC_POSTMASTER, AUTOVACUUM,
2264 gettext_noop("Age at which to autovacuum a table to prevent transaction ID wraparound."),
2267 &autovacuum_freeze_max_age,
2268 /* see pg_resetxlog if you change the upper-limit value */
2269 200000000, 100000000, 2000000000,
2273 /* see max_connections */
2274 {"autovacuum_max_workers", PGC_POSTMASTER, AUTOVACUUM,
2275 gettext_noop("Sets the maximum number of simultaneously running autovacuum worker processes."),
2278 &autovacuum_max_workers,
2280 check_autovacuum_max_workers, assign_autovacuum_max_workers, NULL
2284 {"tcp_keepalives_idle", PGC_USERSET, CLIENT_CONN_OTHER,
2285 gettext_noop("Time between issuing TCP keepalives."),
2286 gettext_noop("A value of 0 uses the system default."),
2289 &tcp_keepalives_idle,
2291 NULL, assign_tcp_keepalives_idle, show_tcp_keepalives_idle
2295 {"tcp_keepalives_interval", PGC_USERSET, CLIENT_CONN_OTHER,
2296 gettext_noop("Time between TCP keepalive retransmits."),
2297 gettext_noop("A value of 0 uses the system default."),
2300 &tcp_keepalives_interval,
2302 NULL, assign_tcp_keepalives_interval, show_tcp_keepalives_interval
2306 {"ssl_renegotiation_limit", PGC_USERSET, CONN_AUTH_SECURITY,
2307 gettext_noop("Set the amount of traffic to send and receive before renegotiating the encryption keys."),
2311 &ssl_renegotiation_limit,
2312 512 * 1024, 0, MAX_KILOBYTES,
2317 {"tcp_keepalives_count", PGC_USERSET, CLIENT_CONN_OTHER,
2318 gettext_noop("Maximum number of TCP keepalive retransmits."),
2319 gettext_noop("This controls the number of consecutive keepalive retransmits that can be "
2320 "lost before a connection is considered dead. A value of 0 uses the "
2323 &tcp_keepalives_count,
2325 NULL, assign_tcp_keepalives_count, show_tcp_keepalives_count
2329 {"gin_fuzzy_search_limit", PGC_USERSET, CLIENT_CONN_OTHER,
2330 gettext_noop("Sets the maximum allowed result for exact search by GIN."),
2334 &GinFuzzySearchLimit,
2340 {"effective_cache_size", PGC_USERSET, QUERY_TUNING_COST,
2341 gettext_noop("Sets the planner's assumption about the size of the disk cache."),
2342 gettext_noop("That is, the portion of the kernel's disk cache that "
2343 "will be used for PostgreSQL data files. This is measured in disk "
2344 "pages, which are normally 8 kB each."),
2347 &effective_cache_size,
2348 DEFAULT_EFFECTIVE_CACHE_SIZE, 1, INT_MAX,
2353 /* Can't be set in postgresql.conf */
2354 {"server_version_num", PGC_INTERNAL, PRESET_OPTIONS,
2355 gettext_noop("Shows the server version as an integer."),
2357 GUC_NOT_IN_SAMPLE | GUC_DISALLOW_IN_FILE
2359 &server_version_num,
2360 PG_VERSION_NUM, PG_VERSION_NUM, PG_VERSION_NUM,
2365 {"log_temp_files", PGC_SUSET, LOGGING_WHAT,
2366 gettext_noop("Log the use of temporary files larger than this number of kilobytes."),
2367 gettext_noop("Zero logs all files. The default is -1 (turning this feature off)."),
2376 {"track_activity_query_size", PGC_POSTMASTER, RESOURCES_MEM,
2377 gettext_noop("Sets the size reserved for pg_stat_activity.query, in bytes."),
2380 &pgstat_track_activity_query_size,
2385 /* End-of-list marker */
2387 {NULL, 0, 0, NULL, NULL}, NULL, 0, 0, 0, NULL, NULL, NULL
2392 static struct config_real ConfigureNamesReal[] =
2395 {"seq_page_cost", PGC_USERSET, QUERY_TUNING_COST,
2396 gettext_noop("Sets the planner's estimate of the cost of a "
2397 "sequentially fetched disk page."),
2401 DEFAULT_SEQ_PAGE_COST, 0, DBL_MAX,
2405 {"random_page_cost", PGC_USERSET, QUERY_TUNING_COST,
2406 gettext_noop("Sets the planner's estimate of the cost of a "
2407 "nonsequentially fetched disk page."),
2411 DEFAULT_RANDOM_PAGE_COST, 0, DBL_MAX,
2415 {"cpu_tuple_cost", PGC_USERSET, QUERY_TUNING_COST,
2416 gettext_noop("Sets the planner's estimate of the cost of "
2417 "processing each tuple (row)."),
2421 DEFAULT_CPU_TUPLE_COST, 0, DBL_MAX,
2425 {"cpu_index_tuple_cost", PGC_USERSET, QUERY_TUNING_COST,
2426 gettext_noop("Sets the planner's estimate of the cost of "
2427 "processing each index entry during an index scan."),
2430 &cpu_index_tuple_cost,
2431 DEFAULT_CPU_INDEX_TUPLE_COST, 0, DBL_MAX,
2435 {"cpu_operator_cost", PGC_USERSET, QUERY_TUNING_COST,
2436 gettext_noop("Sets the planner's estimate of the cost of "
2437 "processing each operator or function call."),
2441 DEFAULT_CPU_OPERATOR_COST, 0, DBL_MAX,
2446 {"cursor_tuple_fraction", PGC_USERSET, QUERY_TUNING_OTHER,
2447 gettext_noop("Sets the planner's estimate of the fraction of "
2448 "a cursor's rows that will be retrieved."),
2451 &cursor_tuple_fraction,
2452 DEFAULT_CURSOR_TUPLE_FRACTION, 0.0, 1.0,
2457 {"geqo_selection_bias", PGC_USERSET, QUERY_TUNING_GEQO,
2458 gettext_noop("GEQO: selective pressure within the population."),
2461 &Geqo_selection_bias,
2462 DEFAULT_GEQO_SELECTION_BIAS,
2463 MIN_GEQO_SELECTION_BIAS, MAX_GEQO_SELECTION_BIAS,
2467 {"geqo_seed", PGC_USERSET, QUERY_TUNING_GEQO,
2468 gettext_noop("GEQO: seed for random path selection."),
2477 {"bgwriter_lru_multiplier", PGC_SIGHUP, RESOURCES_BGWRITER,
2478 gettext_noop("Multiple of the average buffer usage to free per round."),
2481 &bgwriter_lru_multiplier,
2487 {"seed", PGC_USERSET, UNGROUPED,
2488 gettext_noop("Sets the seed for random-number generation."),
2490 GUC_NO_SHOW_ALL | GUC_NO_RESET_ALL | GUC_NOT_IN_SAMPLE | GUC_DISALLOW_IN_FILE
2494 check_random_seed, assign_random_seed, show_random_seed
2498 {"autovacuum_vacuum_scale_factor", PGC_SIGHUP, AUTOVACUUM,
2499 gettext_noop("Number of tuple updates or deletes prior to vacuum as a fraction of reltuples."),
2502 &autovacuum_vac_scale,
2507 {"autovacuum_analyze_scale_factor", PGC_SIGHUP, AUTOVACUUM,
2508 gettext_noop("Number of tuple inserts, updates, or deletes prior to analyze as a fraction of reltuples."),
2511 &autovacuum_anl_scale,
2517 {"checkpoint_completion_target", PGC_SIGHUP, WAL_CHECKPOINTS,
2518 gettext_noop("Time spent flushing dirty buffers during checkpoint, as fraction of checkpoint interval."),
2521 &CheckPointCompletionTarget,
2526 /* End-of-list marker */
2528 {NULL, 0, 0, NULL, NULL}, NULL, 0.0, 0.0, 0.0, NULL, NULL, NULL
2533 static struct config_string ConfigureNamesString[] =
2536 {"archive_command", PGC_SIGHUP, WAL_ARCHIVING,
2537 gettext_noop("Sets the shell command that will be called to archive a WAL file."),
2540 &XLogArchiveCommand,
2542 NULL, NULL, show_archive_command
2546 {"client_encoding", PGC_USERSET, CLIENT_CONN_LOCALE,
2547 gettext_noop("Sets the client's character set encoding."),
2549 GUC_IS_NAME | GUC_REPORT
2551 &client_encoding_string,
2553 check_client_encoding, assign_client_encoding, NULL
2557 {"log_line_prefix", PGC_SIGHUP, LOGGING_WHAT,
2558 gettext_noop("Controls information prefixed to each log line."),
2559 gettext_noop("If blank, no prefix is used.")
2567 {"log_timezone", PGC_SIGHUP, LOGGING_WHAT,
2568 gettext_noop("Sets the time zone to use in log messages."),
2571 &log_timezone_string,
2573 check_log_timezone, assign_log_timezone, show_log_timezone
2577 {"DateStyle", PGC_USERSET, CLIENT_CONN_LOCALE,
2578 gettext_noop("Sets the display format for date and time values."),
2579 gettext_noop("Also controls interpretation of ambiguous "
2581 GUC_LIST_INPUT | GUC_REPORT
2585 check_datestyle, assign_datestyle, NULL
2589 {"default_tablespace", PGC_USERSET, CLIENT_CONN_STATEMENT,
2590 gettext_noop("Sets the default tablespace to create tables and indexes in."),
2591 gettext_noop("An empty string selects the database's default tablespace."),
2594 &default_tablespace,
2596 check_default_tablespace, NULL, NULL
2600 {"temp_tablespaces", PGC_USERSET, CLIENT_CONN_STATEMENT,
2601 gettext_noop("Sets the tablespace(s) to use for temporary tables and sort files."),
2603 GUC_LIST_INPUT | GUC_LIST_QUOTE
2607 check_temp_tablespaces, assign_temp_tablespaces, NULL
2611 {"dynamic_library_path", PGC_SUSET, CLIENT_CONN_OTHER,
2612 gettext_noop("Sets the path for dynamically loadable modules."),
2613 gettext_noop("If a dynamically loadable module needs to be opened and "
2614 "the specified name does not have a directory component (i.e., the "
2615 "name does not contain a slash), the system will search this path for "
2616 "the specified file."),
2619 &Dynamic_library_path,
2625 {"krb_server_keyfile", PGC_SIGHUP, CONN_AUTH_SECURITY,
2626 gettext_noop("Sets the location of the Kerberos server key file."),
2630 &pg_krb_server_keyfile,
2636 {"krb_srvname", PGC_SIGHUP, CONN_AUTH_SECURITY,
2637 gettext_noop("Sets the name of the Kerberos service."),
2646 {"bonjour_name", PGC_POSTMASTER, CONN_AUTH_SETTINGS,
2647 gettext_noop("Sets the Bonjour service name."),
2655 /* See main.c about why defaults for LC_foo are not all alike */
2658 {"lc_collate", PGC_INTERNAL, CLIENT_CONN_LOCALE,
2659 gettext_noop("Shows the collation order locale."),
2661 GUC_NOT_IN_SAMPLE | GUC_DISALLOW_IN_FILE
2669 {"lc_ctype", PGC_INTERNAL, CLIENT_CONN_LOCALE,
2670 gettext_noop("Shows the character classification and case conversion locale."),
2672 GUC_NOT_IN_SAMPLE | GUC_DISALLOW_IN_FILE
2680 {"lc_messages", PGC_SUSET, CLIENT_CONN_LOCALE,
2681 gettext_noop("Sets the language in which messages are displayed."),
2686 check_locale_messages, assign_locale_messages, NULL
2690 {"lc_monetary", PGC_USERSET, CLIENT_CONN_LOCALE,
2691 gettext_noop("Sets the locale for formatting monetary amounts."),
2696 check_locale_monetary, assign_locale_monetary, NULL
2700 {"lc_numeric", PGC_USERSET, CLIENT_CONN_LOCALE,
2701 gettext_noop("Sets the locale for formatting numbers."),
2706 check_locale_numeric, assign_locale_numeric, NULL
2710 {"lc_time", PGC_USERSET, CLIENT_CONN_LOCALE,
2711 gettext_noop("Sets the locale for formatting date and time values."),
2716 check_locale_time, assign_locale_time, NULL
2720 {"shared_preload_libraries", PGC_POSTMASTER, RESOURCES_KERNEL,
2721 gettext_noop("Lists shared libraries to preload into server."),
2723 GUC_LIST_INPUT | GUC_LIST_QUOTE | GUC_SUPERUSER_ONLY
2725 &shared_preload_libraries_string,
2731 {"local_preload_libraries", PGC_BACKEND, CLIENT_CONN_OTHER,
2732 gettext_noop("Lists shared libraries to preload into each backend."),
2734 GUC_LIST_INPUT | GUC_LIST_QUOTE
2736 &local_preload_libraries_string,
2742 {"search_path", PGC_USERSET, CLIENT_CONN_STATEMENT,
2743 gettext_noop("Sets the schema search order for names that are not schema-qualified."),
2745 GUC_LIST_INPUT | GUC_LIST_QUOTE
2747 &namespace_search_path,
2749 check_search_path, assign_search_path, NULL
2753 /* Can't be set in postgresql.conf */
2754 {"server_encoding", PGC_INTERNAL, CLIENT_CONN_LOCALE,
2755 gettext_noop("Sets the server (database) character set encoding."),
2757 GUC_IS_NAME | GUC_REPORT | GUC_NOT_IN_SAMPLE | GUC_DISALLOW_IN_FILE
2759 &server_encoding_string,
2765 /* Can't be set in postgresql.conf */
2766 {"server_version", PGC_INTERNAL, PRESET_OPTIONS,
2767 gettext_noop("Shows the server version."),
2769 GUC_REPORT | GUC_NOT_IN_SAMPLE | GUC_DISALLOW_IN_FILE
2771 &server_version_string,
2777 /* Not for general use --- used by SET ROLE */
2778 {"role", PGC_USERSET, UNGROUPED,
2779 gettext_noop("Sets the current role."),
2781 GUC_IS_NAME | GUC_NO_SHOW_ALL | GUC_NO_RESET_ALL | GUC_NOT_IN_SAMPLE | GUC_DISALLOW_IN_FILE | GUC_NOT_WHILE_SEC_REST
2785 check_role, assign_role, show_role
2789 /* Not for general use --- used by SET SESSION AUTHORIZATION */
2790 {"session_authorization", PGC_USERSET, UNGROUPED,
2791 gettext_noop("Sets the session user name."),
2793 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
2795 &session_authorization_string,
2797 check_session_authorization, assign_session_authorization, NULL
2801 {"log_destination", PGC_SIGHUP, LOGGING_WHERE,
2802 gettext_noop("Sets the destination for server log output."),
2803 gettext_noop("Valid values are combinations of \"stderr\", "
2804 "\"syslog\", \"csvlog\", and \"eventlog\", "
2805 "depending on the platform."),
2808 &log_destination_string,
2810 check_log_destination, assign_log_destination, NULL
2813 {"log_directory", PGC_SIGHUP, LOGGING_WHERE,
2814 gettext_noop("Sets the destination directory for log files."),
2815 gettext_noop("Can be specified as relative to the data directory "
2816 "or as absolute path."),
2821 check_canonical_path, NULL, NULL
2824 {"log_filename", PGC_SIGHUP, LOGGING_WHERE,
2825 gettext_noop("Sets the file name pattern for log files."),
2830 "postgresql-%Y-%m-%d_%H%M%S.log",
2835 {"syslog_ident", PGC_SIGHUP, LOGGING_WHERE,
2836 gettext_noop("Sets the program name used to identify PostgreSQL "
2837 "messages in syslog."),
2842 NULL, assign_syslog_ident, NULL
2846 {"event_source", PGC_POSTMASTER, LOGGING_WHERE,
2847 gettext_noop("Sets the application name used to identify "
2848 "PostgreSQL messages in the event log."),
2857 {"TimeZone", PGC_USERSET, CLIENT_CONN_LOCALE,
2858 gettext_noop("Sets the time zone for displaying and interpreting time stamps."),
2864 check_timezone, assign_timezone, show_timezone
2867 {"timezone_abbreviations", PGC_USERSET, CLIENT_CONN_LOCALE,
2868 gettext_noop("Selects a file of time zone abbreviations."),
2871 &timezone_abbreviations_string,
2873 check_timezone_abbreviations, assign_timezone_abbreviations, NULL
2877 {"transaction_isolation", PGC_USERSET, CLIENT_CONN_STATEMENT,
2878 gettext_noop("Sets the current transaction's isolation level."),
2880 GUC_NO_RESET_ALL | GUC_NOT_IN_SAMPLE | GUC_DISALLOW_IN_FILE
2882 &XactIsoLevel_string,
2884 check_XactIsoLevel, assign_XactIsoLevel, show_XactIsoLevel
2888 {"unix_socket_group", PGC_POSTMASTER, CONN_AUTH_SETTINGS,
2889 gettext_noop("Sets the owning group of the Unix-domain socket."),
2890 gettext_noop("The owning user of the socket is always the user "
2891 "that starts the server.")
2899 {"unix_socket_directories", PGC_POSTMASTER, CONN_AUTH_SETTINGS,
2900 gettext_noop("Sets the directories where Unix-domain sockets will be created."),
2904 &Unix_socket_directories,
2905 #ifdef HAVE_UNIX_SOCKETS
2906 DEFAULT_PGSOCKET_DIR,
2914 {"listen_addresses", PGC_POSTMASTER, CONN_AUTH_SETTINGS,
2915 gettext_noop("Sets the host name or IP address(es) to listen to."),
2925 {"data_directory", PGC_POSTMASTER, FILE_LOCATIONS,
2926 gettext_noop("Sets the server's data directory."),
2936 {"config_file", PGC_POSTMASTER, FILE_LOCATIONS,
2937 gettext_noop("Sets the server's main configuration file."),
2939 GUC_DISALLOW_IN_FILE | GUC_SUPERUSER_ONLY
2947 {"hba_file", PGC_POSTMASTER, FILE_LOCATIONS,
2948 gettext_noop("Sets the server's \"hba\" configuration file."),
2958 {"ident_file", PGC_POSTMASTER, FILE_LOCATIONS,
2959 gettext_noop("Sets the server's \"ident\" configuration file."),
2969 {"external_pid_file", PGC_POSTMASTER, FILE_LOCATIONS,
2970 gettext_noop("Writes the postmaster PID to the specified file."),
2976 check_canonical_path, NULL, NULL
2980 {"ssl_cert_file", PGC_POSTMASTER, CONN_AUTH_SECURITY,
2981 gettext_noop("Location of the SSL server certificate file."),
2990 {"ssl_key_file", PGC_POSTMASTER, CONN_AUTH_SECURITY,
2991 gettext_noop("Location of the SSL server private key file."),
3000 {"ssl_ca_file", PGC_POSTMASTER, CONN_AUTH_SECURITY,
3001 gettext_noop("Location of the SSL certificate authority file."),
3010 {"ssl_crl_file", PGC_POSTMASTER, CONN_AUTH_SECURITY,
3011 gettext_noop("Location of the SSL certificate revocation list file."),
3020 {"stats_temp_directory", PGC_SIGHUP, STATS_COLLECTOR,
3021 gettext_noop("Writes temporary statistics files to the specified directory."),
3025 &pgstat_temp_directory,
3027 check_canonical_path, assign_pgstat_temp_directory, NULL
3031 {"synchronous_standby_names", PGC_SIGHUP, REPLICATION_MASTER,
3032 gettext_noop("List of names of potential synchronous standbys."),
3036 &SyncRepStandbyNames,
3038 check_synchronous_standby_names, NULL, NULL
3042 {"default_text_search_config", PGC_USERSET, CLIENT_CONN_LOCALE,
3043 gettext_noop("Sets default text search configuration."),
3047 "pg_catalog.simple",
3048 check_TSCurrentConfig, assign_TSCurrentConfig, NULL
3052 {"ssl_ciphers", PGC_POSTMASTER, CONN_AUTH_SECURITY,
3053 gettext_noop("Sets the list of allowed SSL ciphers."),
3059 "ALL:!ADH:!LOW:!EXP:!MD5:@STRENGTH",
3067 {"application_name", PGC_USERSET, LOGGING_WHAT,
3068 gettext_noop("Sets the application name to be reported in statistics and logs."),
3070 GUC_IS_NAME | GUC_REPORT | GUC_NOT_IN_SAMPLE
3074 check_application_name, assign_application_name, NULL
3077 /* End-of-list marker */
3079 {NULL, 0, 0, NULL, NULL}, NULL, NULL, NULL, NULL, NULL
3084 static struct config_enum ConfigureNamesEnum[] =
3087 {"backslash_quote", PGC_USERSET, COMPAT_OPTIONS_PREVIOUS,
3088 gettext_noop("Sets whether \"\\'\" is allowed in string literals."),
3092 BACKSLASH_QUOTE_SAFE_ENCODING, backslash_quote_options,
3097 {"bytea_output", PGC_USERSET, CLIENT_CONN_STATEMENT,
3098 gettext_noop("Sets the output format for bytea."),
3102 BYTEA_OUTPUT_HEX, bytea_output_options,
3107 {"client_min_messages", PGC_USERSET, LOGGING_WHEN,
3108 gettext_noop("Sets the message levels that are sent to the client."),
3109 gettext_noop("Each level includes all the levels that follow it. The later"
3110 " the level, the fewer messages are sent.")
3112 &client_min_messages,
3113 NOTICE, client_message_level_options,
3118 {"constraint_exclusion", PGC_USERSET, QUERY_TUNING_OTHER,
3119 gettext_noop("Enables the planner to use constraints to optimize queries."),
3120 gettext_noop("Table scans will be skipped if their constraints"
3121 " guarantee that no rows match the query.")
3123 &constraint_exclusion,
3124 CONSTRAINT_EXCLUSION_PARTITION, constraint_exclusion_options,
3129 {"default_transaction_isolation", PGC_USERSET, CLIENT_CONN_STATEMENT,
3130 gettext_noop("Sets the transaction isolation level of each new transaction."),
3133 &DefaultXactIsoLevel,
3134 XACT_READ_COMMITTED, isolation_level_options,
3139 {"IntervalStyle", PGC_USERSET, CLIENT_CONN_LOCALE,
3140 gettext_noop("Sets the display format for interval values."),
3145 INTSTYLE_POSTGRES, intervalstyle_options,
3150 {"log_error_verbosity", PGC_SUSET, LOGGING_WHAT,
3151 gettext_noop("Sets the verbosity of logged messages."),
3154 &Log_error_verbosity,
3155 PGERROR_DEFAULT, log_error_verbosity_options,
3160 {"log_min_messages", PGC_SUSET, LOGGING_WHEN,
3161 gettext_noop("Sets the message levels that are logged."),
3162 gettext_noop("Each level includes all the levels that follow it. The later"
3163 " the level, the fewer messages are sent.")
3166 WARNING, server_message_level_options,
3171 {"log_min_error_statement", PGC_SUSET, LOGGING_WHEN,
3172 gettext_noop("Causes all statements generating error at or above this level to be logged."),
3173 gettext_noop("Each level includes all the levels that follow it. The later"
3174 " the level, the fewer messages are sent.")
3176 &log_min_error_statement,
3177 ERROR, server_message_level_options,
3182 {"log_statement", PGC_SUSET, LOGGING_WHAT,
3183 gettext_noop("Sets the type of statements logged."),
3187 LOGSTMT_NONE, log_statement_options,
3192 {"syslog_facility", PGC_SIGHUP, LOGGING_WHERE,
3193 gettext_noop("Sets the syslog \"facility\" to be used when syslog enabled."),
3202 syslog_facility_options,
3203 NULL, assign_syslog_facility, NULL
3207 {"session_replication_role", PGC_SUSET, CLIENT_CONN_STATEMENT,
3208 gettext_noop("Sets the session's behavior for triggers and rewrite rules."),
3211 &SessionReplicationRole,
3212 SESSION_REPLICATION_ROLE_ORIGIN, session_replication_role_options,
3213 NULL, assign_session_replication_role, NULL
3217 {"synchronous_commit", PGC_USERSET, WAL_SETTINGS,
3218 gettext_noop("Sets the current transaction's synchronization level."),
3221 &synchronous_commit,
3222 SYNCHRONOUS_COMMIT_ON, synchronous_commit_options,
3223 NULL, assign_synchronous_commit, NULL
3227 {"trace_recovery_messages", PGC_SIGHUP, DEVELOPER_OPTIONS,
3228 gettext_noop("Enables logging of recovery-related debugging information."),
3229 gettext_noop("Each level includes all the levels that follow it. The later"
3230 " the level, the fewer messages are sent.")
3232 &trace_recovery_messages,
3235 * client_message_level_options allows too many values, really, but
3236 * it's not worth having a separate options array for this.
3238 LOG, client_message_level_options,
3243 {"track_functions", PGC_SUSET, STATS_COLLECTOR,
3244 gettext_noop("Collects function-level statistics on database activity."),
3247 &pgstat_track_functions,
3248 TRACK_FUNC_OFF, track_function_options,
3253 {"wal_level", PGC_POSTMASTER, WAL_SETTINGS,
3254 gettext_noop("Set the level of information written to the WAL."),
3258 WAL_LEVEL_MINIMAL, wal_level_options,
3263 {"wal_sync_method", PGC_SIGHUP, WAL_SETTINGS,
3264 gettext_noop("Selects the method used for forcing WAL updates to disk."),
3268 DEFAULT_SYNC_METHOD, sync_method_options,
3269 NULL, assign_xlog_sync_method, NULL
3273 {"xmlbinary", PGC_USERSET, CLIENT_CONN_STATEMENT,
3274 gettext_noop("Sets how binary values are to be encoded in XML."),
3278 XMLBINARY_BASE64, xmlbinary_options,
3283 {"xmloption", PGC_USERSET, CLIENT_CONN_STATEMENT,
3284 gettext_noop("Sets whether XML data in implicit parsing and serialization "
3285 "operations is to be considered as documents or content fragments."),
3289 XMLOPTION_CONTENT, xmloption_options,
3294 /* End-of-list marker */
3296 {NULL, 0, 0, NULL, NULL}, NULL, 0, NULL, NULL, NULL, NULL
3300 /******** end of options list ********/
3304 * To allow continued support of obsolete names for GUC variables, we apply
3305 * the following mappings to any unrecognized name. Note that an old name
3306 * should be mapped to a new one only if the new variable has very similar
3307 * semantics to the old.
3309 static const char *const map_old_guc_names[] = {
3310 "sort_mem", "work_mem",
3311 "vacuum_mem", "maintenance_work_mem",
3317 * Actual lookup of variables is done through this single, sorted array.
3319 static struct config_generic **guc_variables;
3321 /* Current number of variables contained in the vector */
3322 static int num_guc_variables;
3324 /* Vector capacity */
3325 static int size_guc_variables;
3328 static bool guc_dirty; /* TRUE if need to do commit/abort work */
3330 static bool reporting_enabled; /* TRUE to enable GUC_REPORT */
3332 static int GUCNestLevel = 0; /* 1 when in main transaction */
3335 static int guc_var_compare(const void *a, const void *b);
3336 static int guc_name_compare(const char *namea, const char *nameb);
3337 static void InitializeGUCOptionsFromEnvironment(void);
3338 static void InitializeOneGUCOption(struct config_generic * gconf);
3339 static void push_old_value(struct config_generic * gconf, GucAction action);
3340 static void ReportGUCOption(struct config_generic * record);
3341 static void reapply_stacked_values(struct config_generic * variable,
3342 struct config_string * pHolder,
3344 const char *curvalue,
3345 GucContext curscontext, GucSource cursource);
3346 static void ShowGUCConfigOption(const char *name, DestReceiver *dest);
3347 static void ShowAllGUCConfig(DestReceiver *dest);
3348 static char *_ShowOption(struct config_generic * record, bool use_units);
3349 static bool validate_option_array_item(const char *name, const char *value,
3350 bool skipIfNoPermissions);
3354 * Some infrastructure for checking malloc/strdup/realloc calls
3357 guc_malloc(int elevel, size_t size)
3361 /* Avoid unportable behavior of malloc(0) */
3364 data = malloc(size);
3367 (errcode(ERRCODE_OUT_OF_MEMORY),
3368 errmsg("out of memory")));
3373 guc_realloc(int elevel, void *old, size_t size)
3377 /* Avoid unportable behavior of realloc(NULL, 0) */
3378 if (old == NULL && size == 0)
3380 data = realloc(old, size);
3383 (errcode(ERRCODE_OUT_OF_MEMORY),
3384 errmsg("out of memory")));
3389 guc_strdup(int elevel, const char *src)
3396 (errcode(ERRCODE_OUT_OF_MEMORY),
3397 errmsg("out of memory")));
3403 * Detect whether strval is referenced anywhere in a GUC string item
3406 string_field_used(struct config_string * conf, char *strval)
3410 if (strval == *(conf->variable) ||
3411 strval == conf->reset_val ||
3412 strval == conf->boot_val)
3414 for (stack = conf->gen.stack; stack; stack = stack->prev)
3416 if (strval == stack->prior.val.stringval ||
3417 strval == stack->masked.val.stringval)
3424 * Support for assigning to a field of a string GUC item. Free the prior
3425 * value if it's not referenced anywhere else in the item (including stacked
3429 set_string_field(struct config_string * conf, char **field, char *newval)
3431 char *oldval = *field;
3433 /* Do the assignment */
3436 /* Free old value if it's not NULL and isn't referenced anymore */
3437 if (oldval && !string_field_used(conf, oldval))
3442 * Detect whether an "extra" struct is referenced anywhere in a GUC item
3445 extra_field_used(struct config_generic * gconf, void *extra)
3449 if (extra == gconf->extra)
3451 switch (gconf->vartype)
3454 if (extra == ((struct config_bool *) gconf)->reset_extra)
3458 if (extra == ((struct config_int *) gconf)->reset_extra)
3462 if (extra == ((struct config_real *) gconf)->reset_extra)
3466 if (extra == ((struct config_string *) gconf)->reset_extra)
3470 if (extra == ((struct config_enum *) gconf)->reset_extra)
3474 for (stack = gconf->stack; stack; stack = stack->prev)
3476 if (extra == stack->prior.extra ||
3477 extra == stack->masked.extra)
3485 * Support for assigning to an "extra" field of a GUC item. Free the prior
3486 * value if it's not referenced anywhere else in the item (including stacked
3490 set_extra_field(struct config_generic * gconf, void **field, void *newval)
3492 void *oldval = *field;
3494 /* Do the assignment */
3497 /* Free old value if it's not NULL and isn't referenced anymore */
3498 if (oldval && !extra_field_used(gconf, oldval))
3503 * Support for copying a variable's active value into a stack entry.
3504 * The "extra" field associated with the active value is copied, too.
3506 * NB: be sure stringval and extra fields of a new stack entry are
3507 * initialized to NULL before this is used, else we'll try to free() them.
3510 set_stack_value(struct config_generic * gconf, config_var_value *val)
3512 switch (gconf->vartype)
3516 *((struct config_bool *) gconf)->variable;
3520 *((struct config_int *) gconf)->variable;
3524 *((struct config_real *) gconf)->variable;
3527 set_string_field((struct config_string *) gconf,
3528 &(val->val.stringval),
3529 *((struct config_string *) gconf)->variable);
3533 *((struct config_enum *) gconf)->variable;
3536 set_extra_field(gconf, &(val->extra), gconf->extra);
3540 * Support for discarding a no-longer-needed value in a stack entry.
3541 * The "extra" field associated with the stack entry is cleared, too.
3544 discard_stack_value(struct config_generic * gconf, config_var_value *val)
3546 switch (gconf->vartype)
3552 /* no need to do anything */
3555 set_string_field((struct config_string *) gconf,
3556 &(val->val.stringval),
3560 set_extra_field(gconf, &(val->extra), NULL);
3565 * Fetch the sorted array pointer (exported for help_config.c's use ONLY)
3567 struct config_generic **
3568 get_guc_variables(void)
3570 return guc_variables;
3575 * Build the sorted array. This is split out so that it could be
3576 * re-executed after startup (eg, we could allow loadable modules to
3577 * add vars, and then we'd need to re-sort).
3580 build_guc_variables(void)
3584 struct config_generic **guc_vars;
3587 for (i = 0; ConfigureNamesBool[i].gen.name; i++)
3589 struct config_bool *conf = &ConfigureNamesBool[i];
3591 /* Rather than requiring vartype to be filled in by hand, do this: */
3592 conf->gen.vartype = PGC_BOOL;
3596 for (i = 0; ConfigureNamesInt[i].gen.name; i++)
3598 struct config_int *conf = &ConfigureNamesInt[i];
3600 conf->gen.vartype = PGC_INT;
3604 for (i = 0; ConfigureNamesReal[i].gen.name; i++)
3606 struct config_real *conf = &ConfigureNamesReal[i];
3608 conf->gen.vartype = PGC_REAL;
3612 for (i = 0; ConfigureNamesString[i].gen.name; i++)
3614 struct config_string *conf = &ConfigureNamesString[i];
3616 conf->gen.vartype = PGC_STRING;
3620 for (i = 0; ConfigureNamesEnum[i].gen.name; i++)
3622 struct config_enum *conf = &ConfigureNamesEnum[i];
3624 conf->gen.vartype = PGC_ENUM;
3629 * Create table with 20% slack
3631 size_vars = num_vars + num_vars / 4;
3633 guc_vars = (struct config_generic **)
3634 guc_malloc(FATAL, size_vars * sizeof(struct config_generic *));
3638 for (i = 0; ConfigureNamesBool[i].gen.name; i++)
3639 guc_vars[num_vars++] = &ConfigureNamesBool[i].gen;
3641 for (i = 0; ConfigureNamesInt[i].gen.name; i++)
3642 guc_vars[num_vars++] = &ConfigureNamesInt[i].gen;
3644 for (i = 0; ConfigureNamesReal[i].gen.name; i++)
3645 guc_vars[num_vars++] = &ConfigureNamesReal[i].gen;
3647 for (i = 0; ConfigureNamesString[i].gen.name; i++)
3648 guc_vars[num_vars++] = &ConfigureNamesString[i].gen;
3650 for (i = 0; ConfigureNamesEnum[i].gen.name; i++)
3651 guc_vars[num_vars++] = &ConfigureNamesEnum[i].gen;
3654 free(guc_variables);
3655 guc_variables = guc_vars;
3656 num_guc_variables = num_vars;
3657 size_guc_variables = size_vars;
3658 qsort((void *) guc_variables, num_guc_variables,
3659 sizeof(struct config_generic *), guc_var_compare);
3663 * Add a new GUC variable to the list of known variables. The
3664 * list is expanded if needed.
3667 add_guc_variable(struct config_generic * var, int elevel)
3669 if (num_guc_variables + 1 >= size_guc_variables)
3672 * Increase the vector by 25%
3674 int size_vars = size_guc_variables + size_guc_variables / 4;
3675 struct config_generic **guc_vars;
3680 guc_vars = (struct config_generic **)
3681 guc_malloc(elevel, size_vars * sizeof(struct config_generic *));
3685 guc_vars = (struct config_generic **)
3686 guc_realloc(elevel, guc_variables, size_vars * sizeof(struct config_generic *));
3689 if (guc_vars == NULL)
3690 return false; /* out of memory */
3692 guc_variables = guc_vars;
3693 size_guc_variables = size_vars;
3695 guc_variables[num_guc_variables++] = var;
3696 qsort((void *) guc_variables, num_guc_variables,
3697 sizeof(struct config_generic *), guc_var_compare);
3702 * Create and add a placeholder variable for a custom variable name.
3704 static struct config_generic *
3705 add_placeholder_variable(const char *name, int elevel)
3707 size_t sz = sizeof(struct config_string) + sizeof(char *);
3708 struct config_string *var;
3709 struct config_generic *gen;
3711 var = (struct config_string *) guc_malloc(elevel, sz);
3717 gen->name = guc_strdup(elevel, name);
3718 if (gen->name == NULL)
3724 gen->context = PGC_USERSET;
3725 gen->group = CUSTOM_OPTIONS;
3726 gen->short_desc = "GUC placeholder variable";
3727 gen->flags = GUC_NO_SHOW_ALL | GUC_NOT_IN_SAMPLE | GUC_CUSTOM_PLACEHOLDER;
3728 gen->vartype = PGC_STRING;
3731 * The char* is allocated at the end of the struct since we have no
3732 * 'static' place to point to. Note that the current value, as well as
3733 * the boot and reset values, start out NULL.
3735 var->variable = (char **) (var + 1);
3737 if (!add_guc_variable((struct config_generic *) var, elevel))
3739 free((void *) gen->name);
3748 * Look up option NAME. If it exists, return a pointer to its record,
3749 * else return NULL. If create_placeholders is TRUE, we'll create a
3750 * placeholder record for a valid-looking custom variable name.
3752 static struct config_generic *
3753 find_option(const char *name, bool create_placeholders, int elevel)
3755 const char **key = &name;
3756 struct config_generic **res;
3762 * By equating const char ** with struct config_generic *, we are assuming
3763 * the name field is first in config_generic.
3765 res = (struct config_generic **) bsearch((void *) &key,
3766 (void *) guc_variables,
3768 sizeof(struct config_generic *),
3774 * See if the name is an obsolete name for a variable. We assume that the
3775 * set of supported old names is short enough that a brute-force search is
3778 for (i = 0; map_old_guc_names[i] != NULL; i += 2)
3780 if (guc_name_compare(name, map_old_guc_names[i]) == 0)
3781 return find_option(map_old_guc_names[i + 1], false, elevel);
3784 if (create_placeholders)
3787 * Check if the name is qualified, and if so, add a placeholder.
3789 if (strchr(name, GUC_QUALIFIER_SEPARATOR) != NULL)
3790 return add_placeholder_variable(name, elevel);
3799 * comparator for qsorting and bsearching guc_variables array
3802 guc_var_compare(const void *a, const void *b)
3804 const struct config_generic *confa = *(struct config_generic * const *) a;
3805 const struct config_generic *confb = *(struct config_generic * const *) b;
3807 return guc_name_compare(confa->name, confb->name);
3811 * the bare comparison function for GUC names
3814 guc_name_compare(const char *namea, const char *nameb)
3817 * The temptation to use strcasecmp() here must be resisted, because the
3818 * array ordering has to remain stable across setlocale() calls. So, build
3819 * our own with a simple ASCII-only downcasing.
3821 while (*namea && *nameb)
3823 char cha = *namea++;
3824 char chb = *nameb++;
3826 if (cha >= 'A' && cha <= 'Z')
3828 if (chb >= 'A' && chb <= 'Z')
3834 return 1; /* a is longer */
3836 return -1; /* b is longer */
3842 * Initialize GUC options during program startup.
3844 * Note that we cannot read the config file yet, since we have not yet
3845 * processed command-line switches.
3848 InitializeGUCOptions(void)
3853 * Before log_line_prefix could possibly receive a nonempty setting, make
3854 * sure that timezone processing is minimally alive (see elog.c).
3856 pg_timezone_initialize();
3859 * Build sorted array of all GUC variables.
3861 build_guc_variables();
3864 * Load all variables with their compiled-in defaults, and initialize
3865 * status fields as needed.
3867 for (i = 0; i < num_guc_variables; i++)
3869 InitializeOneGUCOption(guc_variables[i]);
3874 reporting_enabled = false;
3877 * Prevent any attempt to override the transaction modes from
3878 * non-interactive sources.
3880 SetConfigOption("transaction_isolation", "default",
3881 PGC_POSTMASTER, PGC_S_OVERRIDE);
3882 SetConfigOption("transaction_read_only", "no",
3883 PGC_POSTMASTER, PGC_S_OVERRIDE);
3884 SetConfigOption("transaction_deferrable", "no",
3885 PGC_POSTMASTER, PGC_S_OVERRIDE);
3888 * For historical reasons, some GUC parameters can receive defaults from
3889 * environment variables. Process those settings.
3891 InitializeGUCOptionsFromEnvironment();
3895 * Assign any GUC values that can come from the server's environment.
3897 * This is called from InitializeGUCOptions, and also from ProcessConfigFile
3898 * to deal with the possibility that a setting has been removed from
3899 * postgresql.conf and should now get a value from the environment.
3900 * (The latter is a kludge that should probably go away someday; if so,
3901 * fold this back into InitializeGUCOptions.)
3904 InitializeGUCOptionsFromEnvironment(void)
3909 env = getenv("PGPORT");
3911 SetConfigOption("port", env, PGC_POSTMASTER, PGC_S_ENV_VAR);
3913 env = getenv("PGDATESTYLE");
3915 SetConfigOption("datestyle", env, PGC_POSTMASTER, PGC_S_ENV_VAR);
3917 env = getenv("PGCLIENTENCODING");
3919 SetConfigOption("client_encoding", env, PGC_POSTMASTER, PGC_S_ENV_VAR);
3922 * rlimit isn't exactly an "environment variable", but it behaves about
3923 * the same. If we can identify the platform stack depth rlimit, increase
3924 * default stack depth setting up to whatever is safe (but at most 2MB).
3926 stack_rlimit = get_stack_depth_rlimit();
3927 if (stack_rlimit > 0)
3929 long new_limit = (stack_rlimit - STACK_DEPTH_SLOP) / 1024L;
3931 if (new_limit > 100)
3935 new_limit = Min(new_limit, 2048);
3936 sprintf(limbuf, "%ld", new_limit);
3937 SetConfigOption("max_stack_depth", limbuf,
3938 PGC_POSTMASTER, PGC_S_ENV_VAR);
3944 * Initialize one GUC option variable to its compiled-in default.
3946 * Note: the reason for calling check_hooks is not that we think the boot_val
3947 * might fail, but that the hooks might wish to compute an "extra" struct.
3950 InitializeOneGUCOption(struct config_generic * gconf)
3953 gconf->source = PGC_S_DEFAULT;
3954 gconf->reset_source = PGC_S_DEFAULT;
3955 gconf->scontext = PGC_INTERNAL;
3956 gconf->reset_scontext = PGC_INTERNAL;
3957 gconf->stack = NULL;
3958 gconf->extra = NULL;
3959 gconf->sourcefile = NULL;
3960 gconf->sourceline = 0;
3962 switch (gconf->vartype)
3966 struct config_bool *conf = (struct config_bool *) gconf;
3967 bool newval = conf->boot_val;
3970 if (!call_bool_check_hook(conf, &newval, &extra,
3971 PGC_S_DEFAULT, LOG))
3972 elog(FATAL, "failed to initialize %s to %d",
3973 conf->gen.name, (int) newval);
3974 if (conf->assign_hook)
3975 (*conf->assign_hook) (newval, extra);
3976 *conf->variable = conf->reset_val = newval;
3977 conf->gen.extra = conf->reset_extra = extra;
3982 struct config_int *conf = (struct config_int *) gconf;
3983 int newval = conf->boot_val;
3986 Assert(newval >= conf->min);
3987 Assert(newval <= conf->max);
3988 if (!call_int_check_hook(conf, &newval, &extra,
3989 PGC_S_DEFAULT, LOG))
3990 elog(FATAL, "failed to initialize %s to %d",
3991 conf->gen.name, newval);
3992 if (conf->assign_hook)
3993 (*conf->assign_hook) (newval, extra);
3994 *conf->variable = conf->reset_val = newval;
3995 conf->gen.extra = conf->reset_extra = extra;
4000 struct config_real *conf = (struct config_real *) gconf;
4001 double newval = conf->boot_val;
4004 Assert(newval >= conf->min);
4005 Assert(newval <= conf->max);
4006 if (!call_real_check_hook(conf, &newval, &extra,
4007 PGC_S_DEFAULT, LOG))
4008 elog(FATAL, "failed to initialize %s to %g",
4009 conf->gen.name, newval);
4010 if (conf->assign_hook)
4011 (*conf->assign_hook) (newval, extra);
4012 *conf->variable = conf->reset_val = newval;
4013 conf->gen.extra = conf->reset_extra = extra;
4018 struct config_string *conf = (struct config_string *) gconf;
4022 /* non-NULL boot_val must always get strdup'd */
4023 if (conf->boot_val != NULL)
4024 newval = guc_strdup(FATAL, conf->boot_val);
4028 if (!call_string_check_hook(conf, &newval, &extra,
4029 PGC_S_DEFAULT, LOG))
4030 elog(FATAL, "failed to initialize %s to \"%s\"",
4031 conf->gen.name, newval ? newval : "");
4032 if (conf->assign_hook)
4033 (*conf->assign_hook) (newval, extra);
4034 *conf->variable = conf->reset_val = newval;
4035 conf->gen.extra = conf->reset_extra = extra;
4040 struct config_enum *conf = (struct config_enum *) gconf;
4041 int newval = conf->boot_val;
4044 if (!call_enum_check_hook(conf, &newval, &extra,
4045 PGC_S_DEFAULT, LOG))
4046 elog(FATAL, "failed to initialize %s to %d",
4047 conf->gen.name, newval);
4048 if (conf->assign_hook)
4049 (*conf->assign_hook) (newval, extra);
4050 *conf->variable = conf->reset_val = newval;
4051 conf->gen.extra = conf->reset_extra = extra;
4059 * Select the configuration files and data directory to be used, and
4060 * do the initial read of postgresql.conf.
4062 * This is called after processing command-line switches.
4063 * userDoption is the -D switch value if any (NULL if unspecified).
4064 * progname is just for use in error messages.
4066 * Returns true on success; on failure, prints a suitable error message
4067 * to stderr and returns false.
4070 SelectConfigFiles(const char *userDoption, const char *progname)
4074 struct stat stat_buf;
4076 /* configdir is -D option, or $PGDATA if no -D */
4078 configdir = make_absolute_path(userDoption);
4080 configdir = make_absolute_path(getenv("PGDATA"));
4083 * Find the configuration file: if config_file was specified on the
4084 * command line, use it, else use configdir/postgresql.conf. In any case
4085 * ensure the result is an absolute path, so that it will be interpreted
4086 * the same way by future backends.
4089 fname = make_absolute_path(ConfigFileName);
4092 fname = guc_malloc(FATAL,
4093 strlen(configdir) + strlen(CONFIG_FILENAME) + 2);
4094 sprintf(fname, "%s/%s", configdir, CONFIG_FILENAME);
4098 write_stderr("%s does not know where to find the server configuration file.\n"
4099 "You must specify the --config-file or -D invocation "
4100 "option or set the PGDATA environment variable.\n",
4106 * Set the ConfigFileName GUC variable to its final value, ensuring that
4107 * it can't be overridden later.
4109 SetConfigOption("config_file", fname, PGC_POSTMASTER, PGC_S_OVERRIDE);
4113 * Now read the config file for the first time.
4115 if (stat(ConfigFileName, &stat_buf) != 0)
4117 write_stderr("%s cannot access the server configuration file \"%s\": %s\n",
4118 progname, ConfigFileName, strerror(errno));
4123 ProcessConfigFile(PGC_POSTMASTER);
4126 * If the data_directory GUC variable has been set, use that as DataDir;
4127 * otherwise use configdir if set; else punt.
4129 * Note: SetDataDir will copy and absolute-ize its argument, so we don't
4133 SetDataDir(data_directory);
4135 SetDataDir(configdir);
4138 write_stderr("%s does not know where to find the database system data.\n"
4139 "This can be specified as \"data_directory\" in \"%s\", "
4140 "or by the -D invocation option, or by the "
4141 "PGDATA environment variable.\n",
4142 progname, ConfigFileName);
4147 * Reflect the final DataDir value back into the data_directory GUC var.
4148 * (If you are wondering why we don't just make them a single variable,
4149 * it's because the EXEC_BACKEND case needs DataDir to be transmitted to
4150 * child backends specially. XXX is that still true? Given that we now
4151 * chdir to DataDir, EXEC_BACKEND can read the config file without knowing
4152 * DataDir in advance.)
4154 SetConfigOption("data_directory", DataDir, PGC_POSTMASTER, PGC_S_OVERRIDE);
4157 * If timezone_abbreviations wasn't set in the configuration file, install
4158 * the default value. We do it this way because we can't safely install a
4159 * "real" value until my_exec_path is set, which may not have happened
4160 * when InitializeGUCOptions runs, so the bootstrap default value cannot
4161 * be the real desired default.
4163 pg_timezone_abbrev_initialize();
4166 * Figure out where pg_hba.conf is, and make sure the path is absolute.
4169 fname = make_absolute_path(HbaFileName);
4172 fname = guc_malloc(FATAL,
4173 strlen(configdir) + strlen(HBA_FILENAME) + 2);
4174 sprintf(fname, "%s/%s", configdir, HBA_FILENAME);
4178 write_stderr("%s does not know where to find the \"hba\" configuration file.\n"
4179 "This can be specified as \"hba_file\" in \"%s\", "
4180 "or by the -D invocation option, or by the "
4181 "PGDATA environment variable.\n",
4182 progname, ConfigFileName);
4185 SetConfigOption("hba_file", fname, PGC_POSTMASTER, PGC_S_OVERRIDE);
4189 * Likewise for pg_ident.conf.
4192 fname = make_absolute_path(IdentFileName);
4195 fname = guc_malloc(FATAL,
4196 strlen(configdir) + strlen(IDENT_FILENAME) + 2);
4197 sprintf(fname, "%s/%s", configdir, IDENT_FILENAME);
4201 write_stderr("%s does not know where to find the \"ident\" configuration file.\n"
4202 "This can be specified as \"ident_file\" in \"%s\", "
4203 "or by the -D invocation option, or by the "
4204 "PGDATA environment variable.\n",
4205 progname, ConfigFileName);
4208 SetConfigOption("ident_file", fname, PGC_POSTMASTER, PGC_S_OVERRIDE);
4218 * Reset all options to their saved default values (implements RESET ALL)
4221 ResetAllOptions(void)
4225 for (i = 0; i < num_guc_variables; i++)
4227 struct config_generic *gconf = guc_variables[i];
4229 /* Don't reset non-SET-able values */
4230 if (gconf->context != PGC_SUSET &&
4231 gconf->context != PGC_USERSET)
4233 /* Don't reset if special exclusion from RESET ALL */
4234 if (gconf->flags & GUC_NO_RESET_ALL)
4236 /* No need to reset if wasn't SET */
4237 if (gconf->source <= PGC_S_OVERRIDE)
4240 /* Save old value to support transaction abort */
4241 push_old_value(gconf, GUC_ACTION_SET);
4243 switch (gconf->vartype)
4247 struct config_bool *conf = (struct config_bool *) 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_int *conf = (struct config_int *) 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_real *conf = (struct config_real *) gconf;
4273 if (conf->assign_hook)
4274 (*conf->assign_hook) (conf->reset_val,
4276 *conf->variable = conf->reset_val;
4277 set_extra_field(&conf->gen, &conf->gen.extra,
4283 struct config_string *conf = (struct config_string *) gconf;
4285 if (conf->assign_hook)
4286 (*conf->assign_hook) (conf->reset_val,
4288 set_string_field(conf, conf->variable, conf->reset_val);
4289 set_extra_field(&conf->gen, &conf->gen.extra,
4295 struct config_enum *conf = (struct config_enum *) gconf;
4297 if (conf->assign_hook)
4298 (*conf->assign_hook) (conf->reset_val,
4300 *conf->variable = conf->reset_val;
4301 set_extra_field(&conf->gen, &conf->gen.extra,
4307 gconf->source = gconf->reset_source;
4308 gconf->scontext = gconf->reset_scontext;
4310 if (gconf->flags & GUC_REPORT)
4311 ReportGUCOption(gconf);
4318 * Push previous state during transactional assignment to a GUC variable.
4321 push_old_value(struct config_generic * gconf, GucAction action)
4325 /* If we're not inside a nest level, do nothing */
4326 if (GUCNestLevel == 0)
4329 /* Do we already have a stack entry of the current nest level? */
4330 stack = gconf->stack;
4331 if (stack && stack->nest_level >= GUCNestLevel)
4333 /* Yes, so adjust its state if necessary */
4334 Assert(stack->nest_level == GUCNestLevel);
4337 case GUC_ACTION_SET:
4338 /* SET overrides any prior action at same nest level */
4339 if (stack->state == GUC_SET_LOCAL)
4341 /* must discard old masked value */
4342 discard_stack_value(gconf, &stack->masked);
4344 stack->state = GUC_SET;
4346 case GUC_ACTION_LOCAL:
4347 if (stack->state == GUC_SET)
4349 /* SET followed by SET LOCAL, remember SET's value */
4350 stack->masked_scontext = gconf->scontext;
4351 set_stack_value(gconf, &stack->masked);
4352 stack->state = GUC_SET_LOCAL;
4354 /* in all other cases, no change to stack entry */
4356 case GUC_ACTION_SAVE:
4357 /* Could only have a prior SAVE of same variable */
4358 Assert(stack->state == GUC_SAVE);
4361 Assert(guc_dirty); /* must be set already */
4366 * Push a new stack entry
4368 * We keep all the stack entries in TopTransactionContext for simplicity.
4370 stack = (GucStack *) MemoryContextAllocZero(TopTransactionContext,
4373 stack->prev = gconf->stack;
4374 stack->nest_level = GUCNestLevel;
4377 case GUC_ACTION_SET:
4378 stack->state = GUC_SET;
4380 case GUC_ACTION_LOCAL:
4381 stack->state = GUC_LOCAL;
4383 case GUC_ACTION_SAVE:
4384 stack->state = GUC_SAVE;
4387 stack->source = gconf->source;
4388 stack->scontext = gconf->scontext;
4389 set_stack_value(gconf, &stack->prior);
4391 gconf->stack = stack;
4393 /* Ensure we remember to pop at end of xact */
4399 * Do GUC processing at main transaction start.
4405 * The nest level should be 0 between transactions; if it isn't, somebody
4406 * didn't call AtEOXact_GUC, or called it with the wrong nestLevel. We
4407 * throw a warning but make no other effort to clean up.
4409 if (GUCNestLevel != 0)
4410 elog(WARNING, "GUC nest level = %d at transaction start",
4416 * Enter a new nesting level for GUC values. This is called at subtransaction
4417 * start, and when entering a function that has proconfig settings, and in
4418 * some other places where we want to set GUC variables transiently.
4419 * NOTE we must not risk error here, else subtransaction start will be unhappy.
4422 NewGUCNestLevel(void)
4424 return ++GUCNestLevel;
4428 * Do GUC processing at transaction or subtransaction commit or abort, or
4429 * when exiting a function that has proconfig settings, or when undoing a
4430 * transient assignment to some GUC variables. (The name is thus a bit of
4431 * a misnomer; perhaps it should be ExitGUCNestLevel or some such.)
4432 * During abort, we discard all GUC settings that were applied at nesting
4433 * levels >= nestLevel. nestLevel == 1 corresponds to the main transaction.
4436 AtEOXact_GUC(bool isCommit, int nestLevel)
4442 * Note: it's possible to get here with GUCNestLevel == nestLevel-1 during
4443 * abort, if there is a failure during transaction start before
4444 * AtStart_GUC is called.
4446 Assert(nestLevel > 0 &&
4447 (nestLevel <= GUCNestLevel ||
4448 (nestLevel == GUCNestLevel + 1 && !isCommit)));
4450 /* Quick exit if nothing's changed in this transaction */
4453 GUCNestLevel = nestLevel - 1;
4457 still_dirty = false;
4458 for (i = 0; i < num_guc_variables; i++)
4460 struct config_generic *gconf = guc_variables[i];
4464 * Process and pop each stack entry within the nest level. To simplify
4465 * fmgr_security_definer() and other places that use GUC_ACTION_SAVE,
4466 * we allow failure exit from code that uses a local nest level to be
4467 * recovered at the surrounding transaction or subtransaction abort;
4468 * so there could be more than one stack entry to pop.
4470 while ((stack = gconf->stack) != NULL &&
4471 stack->nest_level >= nestLevel)
4473 GucStack *prev = stack->prev;
4474 bool restorePrior = false;
4475 bool restoreMasked = false;
4479 * In this next bit, if we don't set either restorePrior or
4480 * restoreMasked, we must "discard" any unwanted fields of the
4481 * stack entries to avoid leaking memory. If we do set one of
4482 * those flags, unused fields will be cleaned up after restoring.
4484 if (!isCommit) /* if abort, always restore prior value */
4485 restorePrior = true;
4486 else if (stack->state == GUC_SAVE)
4487 restorePrior = true;
4488 else if (stack->nest_level == 1)
4490 /* transaction commit */
4491 if (stack->state == GUC_SET_LOCAL)
4492 restoreMasked = true;
4493 else if (stack->state == GUC_SET)
4495 /* we keep the current active value */
4496 discard_stack_value(gconf, &stack->prior);
4498 else /* must be GUC_LOCAL */
4499 restorePrior = true;
4501 else if (prev == NULL ||
4502 prev->nest_level < stack->nest_level - 1)
4504 /* decrement entry's level and do not pop it */
4505 stack->nest_level--;
4511 * We have to merge this stack entry into prev. See README for
4512 * discussion of this bit.
4514 switch (stack->state)
4517 Assert(false); /* can't get here */
4520 /* next level always becomes SET */
4521 discard_stack_value(gconf, &stack->prior);
4522 if (prev->state == GUC_SET_LOCAL)
4523 discard_stack_value(gconf, &prev->masked);
4524 prev->state = GUC_SET;
4528 if (prev->state == GUC_SET)
4530 /* LOCAL migrates down */
4531 prev->masked_scontext = stack->scontext;
4532 prev->masked = stack->prior;
4533 prev->state = GUC_SET_LOCAL;
4537 /* else just forget this stack level */
4538 discard_stack_value(gconf, &stack->prior);
4543 /* prior state at this level no longer wanted */
4544 discard_stack_value(gconf, &stack->prior);
4545 /* copy down the masked state */
4546 prev->masked_scontext = stack->masked_scontext;
4547 if (prev->state == GUC_SET_LOCAL)
4548 discard_stack_value(gconf, &prev->masked);
4549 prev->masked = stack->masked;
4550 prev->state = GUC_SET_LOCAL;
4557 if (restorePrior || restoreMasked)
4559 /* Perform appropriate restoration of the stacked value */
4560 config_var_value newvalue;
4561 GucSource newsource;
4562 GucContext newscontext;
4566 newvalue = stack->masked;
4567 newsource = PGC_S_SESSION;
4568 newscontext = stack->masked_scontext;
4572 newvalue = stack->prior;
4573 newsource = stack->source;
4574 newscontext = stack->scontext;
4577 switch (gconf->vartype)
4581 struct config_bool *conf = (struct config_bool *) gconf;
4582 bool newval = newvalue.val.boolval;
4583 void *newextra = newvalue.extra;
4585 if (*conf->variable != newval ||
4586 conf->gen.extra != newextra)
4588 if (conf->assign_hook)
4589 (*conf->assign_hook) (newval, newextra);
4590 *conf->variable = newval;
4591 set_extra_field(&conf->gen, &conf->gen.extra,
4599 struct config_int *conf = (struct config_int *) gconf;
4600 int newval = newvalue.val.intval;
4601 void *newextra = newvalue.extra;
4603 if (*conf->variable != newval ||
4604 conf->gen.extra != newextra)
4606 if (conf->assign_hook)
4607 (*conf->assign_hook) (newval, newextra);
4608 *conf->variable = newval;
4609 set_extra_field(&conf->gen, &conf->gen.extra,
4617 struct config_real *conf = (struct config_real *) gconf;
4618 double newval = newvalue.val.realval;
4619 void *newextra = newvalue.extra;
4621 if (*conf->variable != newval ||
4622 conf->gen.extra != newextra)
4624 if (conf->assign_hook)
4625 (*conf->assign_hook) (newval, newextra);
4626 *conf->variable = newval;
4627 set_extra_field(&conf->gen, &conf->gen.extra,
4635 struct config_string *conf = (struct config_string *) gconf;
4636 char *newval = newvalue.val.stringval;
4637 void *newextra = newvalue.extra;
4639 if (*conf->variable != newval ||
4640 conf->gen.extra != newextra)
4642 if (conf->assign_hook)
4643 (*conf->assign_hook) (newval, newextra);
4644 set_string_field(conf, conf->variable, newval);
4645 set_extra_field(&conf->gen, &conf->gen.extra,
4651 * Release stacked values if not used anymore. We
4652 * could use discard_stack_value() here, but since
4653 * we have type-specific code anyway, might as
4656 set_string_field(conf, &stack->prior.val.stringval, NULL);
4657 set_string_field(conf, &stack->masked.val.stringval, NULL);
4662 struct config_enum *conf = (struct config_enum *) gconf;
4663 int newval = newvalue.val.enumval;
4664 void *newextra = newvalue.extra;
4666 if (*conf->variable != newval ||
4667 conf->gen.extra != newextra)
4669 if (conf->assign_hook)
4670 (*conf->assign_hook) (newval, newextra);
4671 *conf->variable = newval;
4672 set_extra_field(&conf->gen, &conf->gen.extra,
4681 * Release stacked extra values if not used anymore.
4683 set_extra_field(gconf, &(stack->prior.extra), NULL);
4684 set_extra_field(gconf, &(stack->masked.extra), NULL);
4686 /* And restore source information */
4687 gconf->source = newsource;
4688 gconf->scontext = newscontext;
4691 /* Finish popping the state stack */
4692 gconf->stack = prev;
4695 /* Report new value if we changed it */
4696 if (changed && (gconf->flags & GUC_REPORT))
4697 ReportGUCOption(gconf);
4698 } /* end of stack-popping loop */
4704 /* If there are no remaining stack entries, we can reset guc_dirty */
4705 guc_dirty = still_dirty;
4707 /* Update nesting level */
4708 GUCNestLevel = nestLevel - 1;
4713 * Start up automatic reporting of changes to variables marked GUC_REPORT.
4714 * This is executed at completion of backend startup.
4717 BeginReportingGUCOptions(void)
4722 * Don't do anything unless talking to an interactive frontend of protocol
4725 if (whereToSendOutput != DestRemote ||
4726 PG_PROTOCOL_MAJOR(FrontendProtocol) < 3)
4729 reporting_enabled = true;
4731 /* Transmit initial values of interesting variables */
4732 for (i = 0; i < num_guc_variables; i++)
4734 struct config_generic *conf = guc_variables[i];
4736 if (conf->flags & GUC_REPORT)
4737 ReportGUCOption(conf);
4742 * ReportGUCOption: if appropriate, transmit option value to frontend
4745 ReportGUCOption(struct config_generic * record)
4747 if (reporting_enabled && (record->flags & GUC_REPORT))
4749 char *val = _ShowOption(record, false);
4750 StringInfoData msgbuf;
4752 pq_beginmessage(&msgbuf, 'S');
4753 pq_sendstring(&msgbuf, record->name);
4754 pq_sendstring(&msgbuf, val);
4755 pq_endmessage(&msgbuf);
4762 * Try to parse value as an integer. The accepted formats are the
4763 * usual decimal, octal, or hexadecimal formats, optionally followed by
4764 * a unit name if "flags" indicates a unit is allowed.
4766 * If the string parses okay, return true, else false.
4767 * If okay and result is not NULL, return the value in *result.
4768 * If not okay and hintmsg is not NULL, *hintmsg is set to a suitable
4769 * HINT message, or NULL if no hint provided.
4772 parse_int(const char *value, int *result, int flags, const char **hintmsg)
4777 /* To suppress compiler warnings, always set output params */
4783 /* We assume here that int64 is at least as wide as long */
4785 val = strtol(value, &endptr, 0);
4787 if (endptr == value)
4788 return false; /* no HINT for integer syntax error */
4790 if (errno == ERANGE || val != (int64) ((int32) val))
4793 *hintmsg = gettext_noop("Value exceeds integer range.");
4797 /* allow whitespace between integer and unit */
4798 while (isspace((unsigned char) *endptr))
4801 /* Handle possible unit */
4802 if (*endptr != '\0')
4805 * Note: the multiple-switch coding technique here is a bit tedious,
4806 * but seems necessary to avoid intermediate-value overflows.
4808 if (flags & GUC_UNIT_MEMORY)
4810 /* Set hint for use if no match or trailing garbage */
4812 *hintmsg = gettext_noop("Valid units for this parameter are \"kB\", \"MB\", and \"GB\".");
4814 #if BLCKSZ < 1024 || BLCKSZ > (1024*1024)
4815 #error BLCKSZ must be between 1KB and 1MB
4817 #if XLOG_BLCKSZ < 1024 || XLOG_BLCKSZ > (1024*1024)
4818 #error XLOG_BLCKSZ must be between 1KB and 1MB
4821 if (strncmp(endptr, "kB", 2) == 0)
4824 switch (flags & GUC_UNIT_MEMORY)
4826 case GUC_UNIT_BLOCKS:
4827 val /= (BLCKSZ / 1024);
4829 case GUC_UNIT_XBLOCKS:
4830 val /= (XLOG_BLCKSZ / 1024);
4834 else if (strncmp(endptr, "MB", 2) == 0)
4837 switch (flags & GUC_UNIT_MEMORY)
4842 case GUC_UNIT_BLOCKS:
4843 val *= KB_PER_MB / (BLCKSZ / 1024);
4845 case GUC_UNIT_XBLOCKS:
4846 val *= KB_PER_MB / (XLOG_BLCKSZ / 1024);
4850 else if (strncmp(endptr, "GB", 2) == 0)
4853 switch (flags & GUC_UNIT_MEMORY)
4858 case GUC_UNIT_BLOCKS:
4859 val *= KB_PER_GB / (BLCKSZ / 1024);
4861 case GUC_UNIT_XBLOCKS:
4862 val *= KB_PER_GB / (XLOG_BLCKSZ / 1024);
4867 else if (flags & GUC_UNIT_TIME)
4869 /* Set hint for use if no match or trailing garbage */
4871 *hintmsg = gettext_noop("Valid units for this parameter are \"ms\", \"s\", \"min\", \"h\", and \"d\".");
4873 if (strncmp(endptr, "ms", 2) == 0)
4876 switch (flags & GUC_UNIT_TIME)
4886 else if (strncmp(endptr, "s", 1) == 0)
4889 switch (flags & GUC_UNIT_TIME)
4899 else if (strncmp(endptr, "min", 3) == 0)
4902 switch (flags & GUC_UNIT_TIME)
4912 else if (strncmp(endptr, "h", 1) == 0)
4915 switch (flags & GUC_UNIT_TIME)
4928 else if (strncmp(endptr, "d", 1) == 0)
4931 switch (flags & GUC_UNIT_TIME)
4946 /* allow whitespace after unit */
4947 while (isspace((unsigned char) *endptr))
4950 if (*endptr != '\0')
4951 return false; /* appropriate hint, if any, already set */
4953 /* Check for overflow due to units conversion */
4954 if (val != (int64) ((int32) val))
4957 *hintmsg = gettext_noop("Value exceeds integer range.");
4963 *result = (int) val;
4970 * Try to parse value as a floating point number in the usual format.
4971 * If the string parses okay, return true, else false.
4972 * If okay and result is not NULL, return the value in *result.
4975 parse_real(const char *value, double *result)
4981 *result = 0; /* suppress compiler warning */
4984 val = strtod(value, &endptr);
4985 if (endptr == value || errno == ERANGE)
4988 /* allow whitespace after number */
4989 while (isspace((unsigned char) *endptr))
4991 if (*endptr != '\0')
5001 * Lookup the name for an enum option with the selected value.
5002 * Should only ever be called with known-valid values, so throws
5003 * an elog(ERROR) if the enum option is not found.
5005 * The returned string is a pointer to static data and not
5006 * allocated for modification.
5009 config_enum_lookup_by_value(struct config_enum * record, int val)
5011 const struct config_enum_entry *entry;
5013 for (entry = record->options; entry && entry->name; entry++)
5015 if (entry->val == val)
5019 elog(ERROR, "could not find enum option %d for %s",
5020 val, record->gen.name);
5021 return NULL; /* silence compiler */
5026 * Lookup the value for an enum option with the selected name
5027 * (case-insensitive).
5028 * If the enum option is found, sets the retval value and returns
5029 * true. If it's not found, return FALSE and retval is set to 0.
5032 config_enum_lookup_by_name(struct config_enum * record, const char *value,
5035 const struct config_enum_entry *entry;
5037 for (entry = record->options; entry && entry->name; entry++)
5039 if (pg_strcasecmp(value, entry->name) == 0)
5041 *retval = entry->val;
5052 * Return a list of all available options for an enum, excluding
5053 * hidden ones, separated by the given separator.
5054 * If prefix is non-NULL, it is added before the first enum value.
5055 * If suffix is non-NULL, it is added to the end of the string.
5058 config_enum_get_options(struct config_enum * record, const char *prefix,
5059 const char *suffix, const char *separator)
5061 const struct config_enum_entry *entry;
5062 StringInfoData retstr;
5065 initStringInfo(&retstr);
5066 appendStringInfoString(&retstr, prefix);
5068 seplen = strlen(separator);
5069 for (entry = record->options; entry && entry->name; entry++)
5073 appendStringInfoString(&retstr, entry->name);
5074 appendBinaryStringInfo(&retstr, separator, seplen);
5079 * All the entries may have been hidden, leaving the string empty if no
5080 * prefix was given. This indicates a broken GUC setup, since there is no
5081 * use for an enum without any values, so we just check to make sure we
5082 * don't write to invalid memory instead of actually trying to do
5083 * something smart with it.
5085 if (retstr.len >= seplen)
5087 /* Replace final separator */
5088 retstr.data[retstr.len - seplen] = '\0';
5089 retstr.len -= seplen;
5092 appendStringInfoString(&retstr, suffix);
5099 * Sets option `name' to given value.
5101 * The value should be a string, which will be parsed and converted to
5102 * the appropriate data type. The context and source parameters indicate
5103 * in which context this function is being called, so that it can apply the
5104 * access restrictions properly.
5106 * If value is NULL, set the option to its default value (normally the
5107 * reset_val, but if source == PGC_S_DEFAULT we instead use the boot_val).
5109 * action indicates whether to set the value globally in the session, locally
5110 * to the current top transaction, or just for the duration of a function call.
5112 * If changeVal is false then don't really set the option but do all
5113 * the checks to see if it would work.
5115 * elevel should normally be passed as zero, allowing this function to make
5116 * its standard choice of ereport level. However some callers need to be
5117 * able to override that choice; they should pass the ereport level to use.
5120 * +1: the value is valid and was successfully applied.
5121 * 0: the name or value is invalid (but see below).
5122 * -1: the value was not applied because of context, priority, or changeVal.
5124 * If there is an error (non-existing option, invalid value) then an
5125 * ereport(ERROR) is thrown *unless* this is called for a source for which
5126 * we don't want an ERROR (currently, those are defaults, the config file,
5127 * and per-database or per-user settings, as well as callers who specify
5128 * a less-than-ERROR elevel). In those cases we write a suitable error
5129 * message via ereport() and return 0.
5131 * See also SetConfigOption for an external interface.
5134 set_config_option(const char *name, const char *value,
5135 GucContext context, GucSource source,
5136 GucAction action, bool changeVal, int elevel)
5138 struct config_generic *record;
5139 bool prohibitValueChange = false;
5144 if (source == PGC_S_DEFAULT || source == PGC_S_FILE)
5147 * To avoid cluttering the log, only the postmaster bleats loudly
5148 * about problems with the config file.
5150 elevel = IsUnderPostmaster ? DEBUG3 : LOG;
5152 else if (source == PGC_S_DATABASE || source == PGC_S_USER ||
5153 source == PGC_S_DATABASE_USER)
5159 record = find_option(name, true, elevel);
5163 (errcode(ERRCODE_UNDEFINED_OBJECT),
5164 errmsg("unrecognized configuration parameter \"%s\"", name)));
5169 * Check if the option can be set at this time. See guc.h for the precise
5172 switch (record->context)
5175 if (context != PGC_INTERNAL)
5178 (errcode(ERRCODE_CANT_CHANGE_RUNTIME_PARAM),
5179 errmsg("parameter \"%s\" cannot be changed",
5184 case PGC_POSTMASTER:
5185 if (context == PGC_SIGHUP)
5188 * We are re-reading a PGC_POSTMASTER variable from
5189 * postgresql.conf. We can't change the setting, so we should
5190 * give a warning if the DBA tries to change it. However,
5191 * because of variant formats, canonicalization by check
5192 * hooks, etc, we can't just compare the given string directly
5193 * to what's stored. Set a flag to check below after we have
5194 * the final storable value.
5196 prohibitValueChange = true;
5198 else if (context != PGC_POSTMASTER)
5201 (errcode(ERRCODE_CANT_CHANGE_RUNTIME_PARAM),
5202 errmsg("parameter \"%s\" cannot be changed without restarting the server",
5208 if (context != PGC_SIGHUP && context != PGC_POSTMASTER)
5211 (errcode(ERRCODE_CANT_CHANGE_RUNTIME_PARAM),
5212 errmsg("parameter \"%s\" cannot be changed now",
5218 * Hmm, the idea of the SIGHUP context is "ought to be global, but
5219 * can be changed after postmaster start". But there's nothing
5220 * that prevents a crafty administrator from sending SIGHUP
5221 * signals to individual backends only.
5225 if (context == PGC_SIGHUP)
5228 * If a PGC_BACKEND parameter is changed in the config file,
5229 * we want to accept the new value in the postmaster (whence
5230 * it will propagate to subsequently-started backends), but
5231 * ignore it in existing backends. This is a tad klugy, but
5232 * necessary because we don't re-read the config file during
5235 if (IsUnderPostmaster)
5238 else if (context != PGC_POSTMASTER && context != PGC_BACKEND &&
5239 source != PGC_S_CLIENT)
5242 (errcode(ERRCODE_CANT_CHANGE_RUNTIME_PARAM),
5243 errmsg("parameter \"%s\" cannot be set after connection start",
5249 if (context == PGC_USERSET || context == PGC_BACKEND)
5252 (errcode(ERRCODE_INSUFFICIENT_PRIVILEGE),
5253 errmsg("permission denied to set parameter \"%s\"",
5264 * Disallow changing GUC_NOT_WHILE_SEC_REST values if we are inside a
5265 * security restriction context. We can reject this regardless of the GUC
5266 * context or source, mainly because sources that it might be reasonable
5267 * to override for won't be seen while inside a function.
5269 * Note: variables marked GUC_NOT_WHILE_SEC_REST should usually be marked
5270 * GUC_NO_RESET_ALL as well, because ResetAllOptions() doesn't check this.
5271 * An exception might be made if the reset value is assumed to be "safe".
5273 * Note: this flag is currently used for "session_authorization" and
5274 * "role". We need to prohibit changing these inside a local userid
5275 * context because when we exit it, GUC won't be notified, leaving things
5276 * out of sync. (This could be fixed by forcing a new GUC nesting level,
5277 * but that would change behavior in possibly-undesirable ways.) Also, we
5278 * prohibit changing these in a security-restricted operation because
5279 * otherwise RESET could be used to regain the session user's privileges.
5281 if (record->flags & GUC_NOT_WHILE_SEC_REST)
5283 if (InLocalUserIdChange())
5286 * Phrasing of this error message is historical, but it's the most
5290 (errcode(ERRCODE_INSUFFICIENT_PRIVILEGE),
5291 errmsg("cannot set parameter \"%s\" within security-definer function",
5295 if (InSecurityRestrictedOperation())
5298 (errcode(ERRCODE_INSUFFICIENT_PRIVILEGE),
5299 errmsg("cannot set parameter \"%s\" within security-restricted operation",
5306 * Should we set reset/stacked values? (If so, the behavior is not
5307 * transactional.) This is done either when we get a default value from
5308 * the database's/user's/client's default settings or when we reset a
5309 * value to its default.
5311 makeDefault = changeVal && (source <= PGC_S_OVERRIDE) &&
5312 ((value != NULL) || source == PGC_S_DEFAULT);
5315 * Ignore attempted set if overridden by previously processed setting.
5316 * However, if changeVal is false then plow ahead anyway since we are
5317 * trying to find out if the value is potentially good, not actually use
5318 * it. Also keep going if makeDefault is true, since we may want to set
5319 * the reset/stacked values even if we can't set the variable itself.
5321 if (record->source > source)
5323 if (changeVal && !makeDefault)
5325 elog(DEBUG3, "\"%s\": setting ignored because previous source is higher priority",
5333 * Evaluate value and set variable.
5335 switch (record->vartype)
5339 struct config_bool *conf = (struct config_bool *) record;
5341 void *newextra = NULL;
5345 if (!parse_bool(value, &newval))
5348 (errcode(ERRCODE_INVALID_PARAMETER_VALUE),
5349 errmsg("parameter \"%s\" requires a Boolean value",
5353 if (!call_bool_check_hook(conf, &newval, &newextra,
5357 else if (source == PGC_S_DEFAULT)
5359 newval = conf->boot_val;
5360 if (!call_bool_check_hook(conf, &newval, &newextra,
5366 newval = conf->reset_val;
5367 newextra = conf->reset_extra;
5368 source = conf->gen.reset_source;
5369 context = conf->gen.reset_scontext;
5372 if (prohibitValueChange)
5374 if (*conf->variable != newval)
5377 (errcode(ERRCODE_CANT_CHANGE_RUNTIME_PARAM),
5378 errmsg("parameter \"%s\" cannot be changed without restarting the server",
5387 /* Save old value to support transaction abort */
5389 push_old_value(&conf->gen, action);
5391 if (conf->assign_hook)
5392 (*conf->assign_hook) (newval, newextra);
5393 *conf->variable = newval;
5394 set_extra_field(&conf->gen, &conf->gen.extra,
5396 conf->gen.source = source;
5397 conf->gen.scontext = context;
5403 if (conf->gen.reset_source <= source)
5405 conf->reset_val = newval;
5406 set_extra_field(&conf->gen, &conf->reset_extra,
5408 conf->gen.reset_source = source;
5409 conf->gen.reset_scontext = context;
5411 for (stack = conf->gen.stack; stack; stack = stack->prev)
5413 if (stack->source <= source)
5415 stack->prior.val.boolval = newval;
5416 set_extra_field(&conf->gen, &stack->prior.extra,
5418 stack->source = source;
5419 stack->scontext = context;
5424 /* Perhaps we didn't install newextra anywhere */
5425 if (newextra && !extra_field_used(&conf->gen, newextra))
5432 struct config_int *conf = (struct config_int *) record;
5434 void *newextra = NULL;
5438 const char *hintmsg;
5440 if (!parse_int(value, &newval, conf->gen.flags, &hintmsg))
5443 (errcode(ERRCODE_INVALID_PARAMETER_VALUE),
5444 errmsg("invalid value for parameter \"%s\": \"%s\"",
5446 hintmsg ? errhint("%s", _(hintmsg)) : 0));
5449 if (newval < conf->min || newval > conf->max)
5452 (errcode(ERRCODE_INVALID_PARAMETER_VALUE),
5453 errmsg("%d is outside the valid range for parameter \"%s\" (%d .. %d)",
5454 newval, name, conf->min, conf->max)));
5457 if (!call_int_check_hook(conf, &newval, &newextra,
5461 else if (source == PGC_S_DEFAULT)
5463 newval = conf->boot_val;
5464 if (!call_int_check_hook(conf, &newval, &newextra,
5470 newval = conf->reset_val;
5471 newextra = conf->reset_extra;
5472 source = conf->gen.reset_source;
5473 context = conf->gen.reset_scontext;
5476 if (prohibitValueChange)
5478 if (*conf->variable != newval)
5481 (errcode(ERRCODE_CANT_CHANGE_RUNTIME_PARAM),
5482 errmsg("parameter \"%s\" cannot be changed without restarting the server",
5491 /* Save old value to support transaction abort */
5493 push_old_value(&conf->gen, action);
5495 if (conf->assign_hook)
5496 (*conf->assign_hook) (newval, newextra);
5497 *conf->variable = newval;
5498 set_extra_field(&conf->gen, &conf->gen.extra,
5500 conf->gen.source = source;
5501 conf->gen.scontext = context;
5507 if (conf->gen.reset_source <= source)
5509 conf->reset_val = newval;
5510 set_extra_field(&conf->gen, &conf->reset_extra,
5512 conf->gen.reset_source = source;
5513 conf->gen.reset_scontext = context;
5515 for (stack = conf->gen.stack; stack; stack = stack->prev)
5517 if (stack->source <= source)
5519 stack->prior.val.intval = newval;
5520 set_extra_field(&conf->gen, &stack->prior.extra,
5522 stack->source = source;
5523 stack->scontext = context;
5528 /* Perhaps we didn't install newextra anywhere */
5529 if (newextra && !extra_field_used(&conf->gen, newextra))
5536 struct config_real *conf = (struct config_real *) record;
5538 void *newextra = NULL;
5542 if (!parse_real(value, &newval))
5545 (errcode(ERRCODE_INVALID_PARAMETER_VALUE),
5546 errmsg("parameter \"%s\" requires a numeric value",
5550 if (newval < conf->min || newval > conf->max)
5553 (errcode(ERRCODE_INVALID_PARAMETER_VALUE),
5554 errmsg("%g is outside the valid range for parameter \"%s\" (%g .. %g)",
5555 newval, name, conf->min, conf->max)));
5558 if (!call_real_check_hook(conf, &newval, &newextra,
5562 else if (source == PGC_S_DEFAULT)
5564 newval = conf->boot_val;
5565 if (!call_real_check_hook(conf, &newval, &newextra,
5571 newval = conf->reset_val;
5572 newextra = conf->reset_extra;
5573 source = conf->gen.reset_source;
5574 context = conf->gen.reset_scontext;
5577 if (prohibitValueChange)
5579 if (*conf->variable != newval)
5582 (errcode(ERRCODE_CANT_CHANGE_RUNTIME_PARAM),
5583 errmsg("parameter \"%s\" cannot be changed without restarting the server",
5592 /* Save old value to support transaction abort */
5594 push_old_value(&conf->gen, action);
5596 if (conf->assign_hook)
5597 (*conf->assign_hook) (newval, newextra);
5598 *conf->variable = newval;
5599 set_extra_field(&conf->gen, &conf->gen.extra,
5601 conf->gen.source = source;
5602 conf->gen.scontext = context;
5608 if (conf->gen.reset_source <= source)
5610 conf->reset_val = newval;
5611 set_extra_field(&conf->gen, &conf->reset_extra,
5613 conf->gen.reset_source = source;
5614 conf->gen.reset_scontext = context;
5616 for (stack = conf->gen.stack; stack; stack = stack->prev)
5618 if (stack->source <= source)
5620 stack->prior.val.realval = newval;
5621 set_extra_field(&conf->gen, &stack->prior.extra,
5623 stack->source = source;
5624 stack->scontext = context;
5629 /* Perhaps we didn't install newextra anywhere */
5630 if (newextra && !extra_field_used(&conf->gen, newextra))
5637 struct config_string *conf = (struct config_string *) record;
5639 void *newextra = NULL;
5644 * The value passed by the caller could be transient, so
5645 * we always strdup it.
5647 newval = guc_strdup(elevel, value);
5652 * The only built-in "parsing" check we have is to apply
5653 * truncation if GUC_IS_NAME.
5655 if (conf->gen.flags & GUC_IS_NAME)
5656 truncate_identifier(newval, strlen(newval), true);
5658 if (!call_string_check_hook(conf, &newval, &newextra,
5665 else if (source == PGC_S_DEFAULT)
5667 /* non-NULL boot_val must always get strdup'd */
5668 if (conf->boot_val != NULL)
5670 newval = guc_strdup(elevel, conf->boot_val);
5677 if (!call_string_check_hook(conf, &newval, &newextra,
5687 * strdup not needed, since reset_val is already under
5690 newval = conf->reset_val;
5691 newextra = conf->reset_extra;
5692 source = conf->gen.reset_source;
5693 context = conf->gen.reset_scontext;
5696 if (prohibitValueChange)
5698 /* newval shouldn't be NULL, so we're a bit sloppy here */
5699 if (*conf->variable == NULL || newval == NULL ||
5700 strcmp(*conf->variable, newval) != 0)
5703 (errcode(ERRCODE_CANT_CHANGE_RUNTIME_PARAM),
5704 errmsg("parameter \"%s\" cannot be changed without restarting the server",
5713 /* Save old value to support transaction abort */
5715 push_old_value(&conf->gen, action);
5717 if (conf->assign_hook)
5718 (*conf->assign_hook) (newval, newextra);
5719 set_string_field(conf, conf->variable, newval);
5720 set_extra_field(&conf->gen, &conf->gen.extra,
5722 conf->gen.source = source;
5723 conf->gen.scontext = context;
5730 if (conf->gen.reset_source <= source)
5732 set_string_field(conf, &conf->reset_val, newval);
5733 set_extra_field(&conf->gen, &conf->reset_extra,
5735 conf->gen.reset_source = source;
5736 conf->gen.reset_scontext = context;
5738 for (stack = conf->gen.stack; stack; stack = stack->prev)
5740 if (stack->source <= source)
5742 set_string_field(conf, &stack->prior.val.stringval,
5744 set_extra_field(&conf->gen, &stack->prior.extra,
5746 stack->source = source;
5747 stack->scontext = context;
5752 /* Perhaps we didn't install newval anywhere */
5753 if (newval && !string_field_used(conf, newval))
5755 /* Perhaps we didn't install newextra anywhere */
5756 if (newextra && !extra_field_used(&conf->gen, newextra))
5763 struct config_enum *conf = (struct config_enum *) record;
5765 void *newextra = NULL;
5769 if (!config_enum_lookup_by_name(conf, value, &newval))
5773 hintmsg = config_enum_get_options(conf,
5774 "Available values: ",
5778 (errcode(ERRCODE_INVALID_PARAMETER_VALUE),
5779 errmsg("invalid value for parameter \"%s\": \"%s\"",
5781 hintmsg ? errhint("%s", _(hintmsg)) : 0));
5787 if (!call_enum_check_hook(conf, &newval, &newextra,
5791 else if (source == PGC_S_DEFAULT)
5793 newval = conf->boot_val;
5794 if (!call_enum_check_hook(conf, &newval, &newextra,
5800 newval = conf->reset_val;
5801 newextra = conf->reset_extra;
5802 source = conf->gen.reset_source;
5803 context = conf->gen.reset_scontext;
5806 if (prohibitValueChange)
5808 if (*conf->variable != newval)
5811 (errcode(ERRCODE_CANT_CHANGE_RUNTIME_PARAM),
5812 errmsg("parameter \"%s\" cannot be changed without restarting the server",
5821 /* Save old value to support transaction abort */
5823 push_old_value(&conf->gen, action);
5825 if (conf->assign_hook)
5826 (*conf->assign_hook) (newval, newextra);
5827 *conf->variable = newval;
5828 set_extra_field(&conf->gen, &conf->gen.extra,
5830 conf->gen.source = source;
5831 conf->gen.scontext = context;
5837 if (conf->gen.reset_source <= source)
5839 conf->reset_val = newval;
5840 set_extra_field(&conf->gen, &conf->reset_extra,
5842 conf->gen.reset_source = source;
5843 conf->gen.reset_scontext = context;
5845 for (stack = conf->gen.stack; stack; stack = stack->prev)
5847 if (stack->source <= source)
5849 stack->prior.val.enumval = newval;
5850 set_extra_field(&conf->gen, &stack->prior.extra,
5852 stack->source = source;
5853 stack->scontext = context;
5858 /* Perhaps we didn't install newextra anywhere */
5859 if (newextra && !extra_field_used(&conf->gen, newextra))
5865 if (changeVal && (record->flags & GUC_REPORT))
5866 ReportGUCOption(record);
5868 return changeVal ? 1 : -1;
5873 * Set the fields for source file and line number the setting came from.
5876 set_config_sourcefile(const char *name, char *sourcefile, int sourceline)
5878 struct config_generic *record;
5882 * To avoid cluttering the log, only the postmaster bleats loudly about
5883 * problems with the config file.
5885 elevel = IsUnderPostmaster ? DEBUG3 : LOG;
5887 record = find_option(name, true, elevel);
5888 /* should not happen */
5890 elog(ERROR, "unrecognized configuration parameter \"%s\"", name);
5892 sourcefile = guc_strdup(elevel, sourcefile);
5893 if (record->sourcefile)
5894 free(record->sourcefile);
5895 record->sourcefile = sourcefile;
5896 record->sourceline = sourceline;
5900 * Set a config option to the given value.
5902 * See also set_config_option; this is just the wrapper to be called from
5903 * outside GUC. (This function should be used when possible, because its API
5904 * is more stable than set_config_option's.)
5906 * Note: there is no support here for setting source file/line, as it
5907 * is currently not needed.
5910 SetConfigOption(const char *name, const char *value,
5911 GucContext context, GucSource source)
5913 (void) set_config_option(name, value, context, source,
5914 GUC_ACTION_SET, true, 0);
5920 * Fetch the current value of the option `name', as a string.
5922 * If the option doesn't exist, return NULL if missing_ok is true (NOTE that
5923 * this cannot be distinguished from a string variable with a NULL value!),
5924 * otherwise throw an ereport and don't return.
5926 * If restrict_superuser is true, we also enforce that only superusers can
5927 * see GUC_SUPERUSER_ONLY variables. This should only be passed as true
5928 * in user-driven calls.
5930 * The string is *not* allocated for modification and is really only
5931 * valid until the next call to configuration related functions.
5934 GetConfigOption(const char *name, bool missing_ok, bool restrict_superuser)
5936 struct config_generic *record;
5937 static char buffer[256];
5939 record = find_option(name, false, ERROR);
5945 (errcode(ERRCODE_UNDEFINED_OBJECT),
5946 errmsg("unrecognized configuration parameter \"%s\"",
5949 if (restrict_superuser &&
5950 (record->flags & GUC_SUPERUSER_ONLY) &&
5953 (errcode(ERRCODE_INSUFFICIENT_PRIVILEGE),
5954 errmsg("must be superuser to examine \"%s\"", name)));
5956 switch (record->vartype)
5959 return *((struct config_bool *) record)->variable ? "on" : "off";
5962 snprintf(buffer, sizeof(buffer), "%d",
5963 *((struct config_int *) record)->variable);
5967 snprintf(buffer, sizeof(buffer), "%g",
5968 *((struct config_real *) record)->variable);
5972 return *((struct config_string *) record)->variable;
5975 return config_enum_lookup_by_value((struct config_enum *) record,
5976 *((struct config_enum *) record)->variable);
5982 * Get the RESET value associated with the given option.
5984 * Note: this is not re-entrant, due to use of static result buffer;
5985 * not to mention that a string variable could have its reset_val changed.
5986 * Beware of assuming the result value is good for very long.
5989 GetConfigOptionResetString(const char *name)
5991 struct config_generic *record;
5992 static char buffer[256];
5994 record = find_option(name, false, ERROR);
5997 (errcode(ERRCODE_UNDEFINED_OBJECT),
5998 errmsg("unrecognized configuration parameter \"%s\"", name)));
5999 if ((record->flags & GUC_SUPERUSER_ONLY) && !superuser())
6001 (errcode(ERRCODE_INSUFFICIENT_PRIVILEGE),
6002 errmsg("must be superuser to examine \"%s\"", name)));
6004 switch (record->vartype)
6007 return ((struct config_bool *) record)->reset_val ? "on" : "off";
6010 snprintf(buffer, sizeof(buffer), "%d",
6011 ((struct config_int *) record)->reset_val);
6015 snprintf(buffer, sizeof(buffer), "%g",
6016 ((struct config_real *) record)->reset_val);
6020 return ((struct config_string *) record)->reset_val;
6023 return config_enum_lookup_by_value((struct config_enum *) record,
6024 ((struct config_enum *) record)->reset_val);
6031 * flatten_set_variable_args
6032 * Given a parsenode List as emitted by the grammar for SET,
6033 * convert to the flat string representation used by GUC.
6035 * We need to be told the name of the variable the args are for, because
6036 * the flattening rules vary (ugh).
6038 * The result is NULL if args is NIL (ie, SET ... TO DEFAULT), otherwise
6039 * a palloc'd string.
6042 flatten_set_variable_args(const char *name, List *args)
6044 struct config_generic *record;
6049 /* Fast path if just DEFAULT */
6054 * Get flags for the variable; if it's not known, use default flags.
6055 * (Caller might throw error later, but not our business to do so here.)
6057 record = find_option(name, false, WARNING);
6059 flags = record->flags;
6063 /* Complain if list input and non-list variable */
6064 if ((flags & GUC_LIST_INPUT) == 0 &&
6065 list_length(args) != 1)
6067 (errcode(ERRCODE_INVALID_PARAMETER_VALUE),
6068 errmsg("SET %s takes only one argument", name)));
6070 initStringInfo(&buf);
6073 * Each list member may be a plain A_Const node, or an A_Const within a
6074 * TypeCast; the latter case is supported only for ConstInterval arguments
6075 * (for SET TIME ZONE).
6079 Node *arg = (Node *) lfirst(l);
6081 TypeName *typeName = NULL;
6084 if (l != list_head(args))
6085 appendStringInfo(&buf, ", ");
6087 if (IsA(arg, TypeCast))
6089 TypeCast *tc = (TypeCast *) arg;
6092 typeName = tc->typeName;
6095 if (!IsA(arg, A_Const))
6096 elog(ERROR, "unrecognized node type: %d", (int) nodeTag(arg));
6097 con = (A_Const *) arg;
6099 switch (nodeTag(&con->val))
6102 appendStringInfo(&buf, "%ld", intVal(&con->val));
6105 /* represented as a string, so just copy it */
6106 appendStringInfoString(&buf, strVal(&con->val));
6109 val = strVal(&con->val);
6110 if (typeName != NULL)
6113 * Must be a ConstInterval argument for TIME ZONE. Coerce
6114 * to interval and back to normalize the value and account
6122 typenameTypeIdAndMod(NULL, typeName, &typoid, &typmod);
6123 Assert(typoid == INTERVALOID);
6126 DirectFunctionCall3(interval_in,
6127 CStringGetDatum(val),
6128 ObjectIdGetDatum(InvalidOid),
6129 Int32GetDatum(typmod));
6132 DatumGetCString(DirectFunctionCall1(interval_out,
6134 appendStringInfo(&buf, "INTERVAL '%s'", intervalout);
6139 * Plain string literal or identifier. For quote mode,
6140 * quote it if it's not a vanilla identifier.
6142 if (flags & GUC_LIST_QUOTE)
6143 appendStringInfoString(&buf, quote_identifier(val));
6145 appendStringInfoString(&buf, val);
6149 elog(ERROR, "unrecognized node type: %d",
6150 (int) nodeTag(&con->val));
6163 ExecSetVariableStmt(VariableSetStmt *stmt)
6165 GucAction action = stmt->is_local ? GUC_ACTION_LOCAL : GUC_ACTION_SET;
6170 case VAR_SET_CURRENT:
6171 (void) set_config_option(stmt->name,
6172 ExtractSetVariableArgs(stmt),
6173 (superuser() ? PGC_SUSET : PGC_USERSET),
6182 * Special-case SQL syntaxes. The TRANSACTION and SESSION
6183 * CHARACTERISTICS cases effectively set more than one variable
6184 * per statement. TRANSACTION SNAPSHOT only takes one argument,
6185 * but we put it here anyway since it's a special case and not
6186 * related to any GUC variable.
6188 if (strcmp(stmt->name, "TRANSACTION") == 0)
6192 foreach(head, stmt->args)
6194 DefElem *item = (DefElem *) lfirst(head);
6196 if (strcmp(item->defname, "transaction_isolation") == 0)
6197 SetPGVariable("transaction_isolation",
6198 list_make1(item->arg), stmt->is_local);
6199 else if (strcmp(item->defname, "transaction_read_only") == 0)
6200 SetPGVariable("transaction_read_only",
6201 list_make1(item->arg), stmt->is_local);
6202 else if (strcmp(item->defname, "transaction_deferrable") == 0)
6203 SetPGVariable("transaction_deferrable",
6204 list_make1(item->arg), stmt->is_local);
6206 elog(ERROR, "unexpected SET TRANSACTION element: %s",
6210 else if (strcmp(stmt->name, "SESSION CHARACTERISTICS") == 0)
6214 foreach(head, stmt->args)
6216 DefElem *item = (DefElem *) lfirst(head);
6218 if (strcmp(item->defname, "transaction_isolation") == 0)
6219 SetPGVariable("default_transaction_isolation",
6220 list_make1(item->arg), stmt->is_local);
6221 else if (strcmp(item->defname, "transaction_read_only") == 0)
6222 SetPGVariable("default_transaction_read_only",
6223 list_make1(item->arg), stmt->is_local);
6224 else if (strcmp(item->defname, "transaction_deferrable") == 0)
6225 SetPGVariable("default_transaction_deferrable",
6226 list_make1(item->arg), stmt->is_local);
6228 elog(ERROR, "unexpected SET SESSION element: %s",
6232 else if (strcmp(stmt->name, "TRANSACTION SNAPSHOT") == 0)
6234 A_Const *con = (A_Const *) linitial(stmt->args);
6238 (errcode(ERRCODE_FEATURE_NOT_SUPPORTED),
6239 errmsg("SET LOCAL TRANSACTION SNAPSHOT is not implemented")));
6240 Assert(IsA(con, A_Const));
6241 Assert(nodeTag(&con->val) == T_String);
6242 ImportSnapshot(strVal(&con->val));
6245 elog(ERROR, "unexpected SET MULTI element: %s",
6248 case VAR_SET_DEFAULT:
6250 (void) set_config_option(stmt->name,
6252 (superuser() ? PGC_SUSET : PGC_USERSET),
6265 * Get the value to assign for a VariableSetStmt, or NULL if it's RESET.
6266 * The result is palloc'd.
6268 * This is exported for use by actions such as ALTER ROLE SET.
6271 ExtractSetVariableArgs(VariableSetStmt *stmt)
6276 return flatten_set_variable_args(stmt->name, stmt->args);
6277 case VAR_SET_CURRENT:
6278 return GetConfigOptionByName(stmt->name, NULL);
6285 * SetPGVariable - SET command exported as an easily-C-callable function.
6287 * This provides access to SET TO value, as well as SET TO DEFAULT (expressed
6288 * by passing args == NIL), but not SET FROM CURRENT functionality.
6291 SetPGVariable(const char *name, List *args, bool is_local)
6293 char *argstring = flatten_set_variable_args(name, args);
6295 /* Note SET DEFAULT (argstring == NULL) is equivalent to RESET */
6296 (void) set_config_option(name,
6298 (superuser() ? PGC_SUSET : PGC_USERSET),
6300 is_local ? GUC_ACTION_LOCAL : GUC_ACTION_SET,
6306 * SET command wrapped as a SQL callable function.
6309 set_config_by_name(PG_FUNCTION_ARGS)
6316 if (PG_ARGISNULL(0))
6318 (errcode(ERRCODE_NULL_VALUE_NOT_ALLOWED),
6319 errmsg("SET requires parameter name")));
6321 /* Get the GUC variable name */
6322 name = TextDatumGetCString(PG_GETARG_DATUM(0));
6324 /* Get the desired value or set to NULL for a reset request */
6325 if (PG_ARGISNULL(1))
6328 value = TextDatumGetCString(PG_GETARG_DATUM(1));
6331 * Get the desired state of is_local. Default to false if provided value
6334 if (PG_ARGISNULL(2))
6337 is_local = PG_GETARG_BOOL(2);
6339 /* Note SET DEFAULT (argstring == NULL) is equivalent to RESET */
6340 (void) set_config_option(name,
6342 (superuser() ? PGC_SUSET : PGC_USERSET),
6344 is_local ? GUC_ACTION_LOCAL : GUC_ACTION_SET,
6348 /* get the new current value */
6349 new_value = GetConfigOptionByName(name, NULL);
6351 /* Convert return string to text */
6352 PG_RETURN_TEXT_P(cstring_to_text(new_value));
6357 * Common code for DefineCustomXXXVariable subroutines: allocate the
6358 * new variable's config struct and fill in generic fields.
6360 static struct config_generic *
6361 init_custom_variable(const char *name,
6362 const char *short_desc,
6363 const char *long_desc,
6366 enum config_type type,
6369 struct config_generic *gen;
6372 * Only allow custom PGC_POSTMASTER variables to be created during shared
6373 * library preload; any later than that, we can't ensure that the value
6374 * doesn't change after startup. This is a fatal elog if it happens; just
6375 * erroring out isn't safe because we don't know what the calling loadable
6376 * module might already have hooked into.
6378 if (context == PGC_POSTMASTER &&
6379 !process_shared_preload_libraries_in_progress)
6380 elog(FATAL, "cannot create PGC_POSTMASTER variables after startup");
6382 gen = (struct config_generic *) guc_malloc(ERROR, sz);
6385 gen->name = guc_strdup(ERROR, name);
6386 gen->context = context;
6387 gen->group = CUSTOM_OPTIONS;
6388 gen->short_desc = short_desc;
6389 gen->long_desc = long_desc;
6391 gen->vartype = type;
6397 * Common code for DefineCustomXXXVariable subroutines: insert the new
6398 * variable into the GUC variable array, replacing any placeholder.
6401 define_custom_variable(struct config_generic * variable)
6403 const char *name = variable->name;
6404 const char **nameAddr = &name;
6405 struct config_string *pHolder;
6406 struct config_generic **res;
6409 * See if there's a placeholder by the same name.
6411 res = (struct config_generic **) bsearch((void *) &nameAddr,
6412 (void *) guc_variables,
6414 sizeof(struct config_generic *),
6419 * No placeholder to replace, so we can just add it ... but first,
6420 * make sure it's initialized to its default value.
6422 InitializeOneGUCOption(variable);
6423 add_guc_variable(variable, ERROR);
6428 * This better be a placeholder
6430 if (((*res)->flags & GUC_CUSTOM_PLACEHOLDER) == 0)
6432 (errcode(ERRCODE_INTERNAL_ERROR),
6433 errmsg("attempt to redefine parameter \"%s\"", name)));
6435 Assert((*res)->vartype == PGC_STRING);
6436 pHolder = (struct config_string *) (*res);
6439 * First, set the variable to its default value. We must do this even
6440 * though we intend to immediately apply a new value, since it's possible
6441 * that the new value is invalid.
6443 InitializeOneGUCOption(variable);
6446 * Replace the placeholder. We aren't changing the name, so no re-sorting
6452 * Assign the string value(s) stored in the placeholder to the real
6453 * variable. Essentially, we need to duplicate all the active and stacked
6454 * values, but with appropriate validation and datatype adjustment.
6456 * If an assignment fails, we report a WARNING and keep going. We don't
6457 * want to throw ERROR for bad values, because it'd bollix the add-on
6458 * module that's presumably halfway through getting loaded. In such cases
6459 * the default or previous state will become active instead.
6462 /* First, apply the reset value if any */
6463 if (pHolder->reset_val)
6464 (void) set_config_option(name, pHolder->reset_val,
6465 pHolder->gen.reset_scontext,
6466 pHolder->gen.reset_source,
6467 GUC_ACTION_SET, true, WARNING);
6468 /* That should not have resulted in stacking anything */
6469 Assert(variable->stack == NULL);
6471 /* Now, apply current and stacked values, in the order they were stacked */
6472 reapply_stacked_values(variable, pHolder, pHolder->gen.stack,
6473 *(pHolder->variable),
6474 pHolder->gen.scontext, pHolder->gen.source);
6476 /* Also copy over any saved source-location information */
6477 if (pHolder->gen.sourcefile)
6478 set_config_sourcefile(name, pHolder->gen.sourcefile,
6479 pHolder->gen.sourceline);
6482 * Free up as much as we conveniently can of the placeholder structure.
6483 * (This neglects any stack items, so it's possible for some memory to be
6484 * leaked. Since this can only happen once per session per variable, it
6485 * doesn't seem worth spending much code on.)
6487 set_string_field(pHolder, pHolder->variable, NULL);
6488 set_string_field(pHolder, &pHolder->reset_val, NULL);
6494 * Recursive subroutine for define_custom_variable: reapply non-reset values
6496 * We recurse so that the values are applied in the same order as originally.
6497 * At each recursion level, apply the upper-level value (passed in) in the
6498 * fashion implied by the stack entry.
6501 reapply_stacked_values(struct config_generic * variable,
6502 struct config_string * pHolder,
6504 const char *curvalue,
6505 GucContext curscontext, GucSource cursource)
6507 const char *name = variable->name;
6508 GucStack *oldvarstack = variable->stack;
6512 /* First, recurse, so that stack items are processed bottom to top */
6513 reapply_stacked_values(variable, pHolder, stack->prev,
6514 stack->prior.val.stringval,
6515 stack->scontext, stack->source);
6517 /* See how to apply the passed-in value */
6518 switch (stack->state)
6521 (void) set_config_option(name, curvalue,
6522 curscontext, cursource,
6523 GUC_ACTION_SAVE, true, WARNING);
6527 (void) set_config_option(name, curvalue,
6528 curscontext, cursource,
6529 GUC_ACTION_SET, true, WARNING);
6533 (void) set_config_option(name, curvalue,
6534 curscontext, cursource,
6535 GUC_ACTION_LOCAL, true, WARNING);
6539 /* first, apply the masked value as SET */
6540 (void) set_config_option(name, stack->masked.val.stringval,
6541 stack->masked_scontext, PGC_S_SESSION,
6542 GUC_ACTION_SET, true, WARNING);
6543 /* then apply the current value as LOCAL */
6544 (void) set_config_option(name, curvalue,
6545 curscontext, cursource,
6546 GUC_ACTION_LOCAL, true, WARNING);
6550 /* If we successfully made a stack entry, adjust its nest level */
6551 if (variable->stack != oldvarstack)
6552 variable->stack->nest_level = stack->nest_level;
6557 * We are at the end of the stack. If the active/previous value is
6558 * different from the reset value, it must represent a previously
6559 * committed session value. Apply it, and then drop the stack entry
6560 * that set_config_option will have created under the impression that
6561 * this is to be just a transactional assignment. (We leak the stack
6564 if (curvalue != pHolder->reset_val ||
6565 curscontext != pHolder->gen.reset_scontext ||
6566 cursource != pHolder->gen.reset_source)
6568 (void) set_config_option(name, curvalue,
6569 curscontext, cursource,
6570 GUC_ACTION_SET, true, WARNING);
6571 variable->stack = NULL;
6577 DefineCustomBoolVariable(const char *name,
6578 const char *short_desc,
6579 const char *long_desc,
6584 GucBoolCheckHook check_hook,
6585 GucBoolAssignHook assign_hook,
6586 GucShowHook show_hook)
6588 struct config_bool *var;
6590 var = (struct config_bool *)
6591 init_custom_variable(name, short_desc, long_desc, context, flags,
6592 PGC_BOOL, sizeof(struct config_bool));
6593 var->variable = valueAddr;
6594 var->boot_val = bootValue;
6595 var->reset_val = bootValue;
6596 var->check_hook = check_hook;
6597 var->assign_hook = assign_hook;
6598 var->show_hook = show_hook;
6599 define_custom_variable(&var->gen);
6603 DefineCustomIntVariable(const char *name,
6604 const char *short_desc,
6605 const char *long_desc,
6612 GucIntCheckHook check_hook,
6613 GucIntAssignHook assign_hook,
6614 GucShowHook show_hook)
6616 struct config_int *var;
6618 var = (struct config_int *)
6619 init_custom_variable(name, short_desc, long_desc, context, flags,
6620 PGC_INT, sizeof(struct config_int));
6621 var->variable = valueAddr;
6622 var->boot_val = bootValue;
6623 var->reset_val = bootValue;
6624 var->min = minValue;
6625 var->max = maxValue;
6626 var->check_hook = check_hook;
6627 var->assign_hook = assign_hook;
6628 var->show_hook = show_hook;
6629 define_custom_variable(&var->gen);
6633 DefineCustomRealVariable(const char *name,
6634 const char *short_desc,
6635 const char *long_desc,
6642 GucRealCheckHook check_hook,
6643 GucRealAssignHook assign_hook,
6644 GucShowHook show_hook)
6646 struct config_real *var;
6648 var = (struct config_real *)
6649 init_custom_variable(name, short_desc, long_desc, context, flags,
6650 PGC_REAL, sizeof(struct config_real));
6651 var->variable = valueAddr;
6652 var->boot_val = bootValue;
6653 var->reset_val = bootValue;
6654 var->min = minValue;
6655 var->max = maxValue;
6656 var->check_hook = check_hook;
6657 var->assign_hook = assign_hook;
6658 var->show_hook = show_hook;
6659 define_custom_variable(&var->gen);
6663 DefineCustomStringVariable(const char *name,
6664 const char *short_desc,
6665 const char *long_desc,
6667 const char *bootValue,
6670 GucStringCheckHook check_hook,
6671 GucStringAssignHook assign_hook,
6672 GucShowHook show_hook)
6674 struct config_string *var;
6676 var = (struct config_string *)
6677 init_custom_variable(name, short_desc, long_desc, context, flags,
6678 PGC_STRING, sizeof(struct config_string));
6679 var->variable = valueAddr;
6680 var->boot_val = bootValue;
6681 var->check_hook = check_hook;
6682 var->assign_hook = assign_hook;
6683 var->show_hook = show_hook;
6684 define_custom_variable(&var->gen);
6688 DefineCustomEnumVariable(const char *name,
6689 const char *short_desc,
6690 const char *long_desc,
6693 const struct config_enum_entry * options,
6696 GucEnumCheckHook check_hook,
6697 GucEnumAssignHook assign_hook,
6698 GucShowHook show_hook)
6700 struct config_enum *var;
6702 var = (struct config_enum *)
6703 init_custom_variable(name, short_desc, long_desc, context, flags,
6704 PGC_ENUM, sizeof(struct config_enum));
6705 var->variable = valueAddr;
6706 var->boot_val = bootValue;
6707 var->reset_val = bootValue;
6708 var->options = options;
6709 var->check_hook = check_hook;
6710 var->assign_hook = assign_hook;
6711 var->show_hook = show_hook;
6712 define_custom_variable(&var->gen);
6716 EmitWarningsOnPlaceholders(const char *className)
6718 int classLen = strlen(className);
6721 for (i = 0; i < num_guc_variables; i++)
6723 struct config_generic *var = guc_variables[i];
6725 if ((var->flags & GUC_CUSTOM_PLACEHOLDER) != 0 &&
6726 strncmp(className, var->name, classLen) == 0 &&
6727 var->name[classLen] == GUC_QUALIFIER_SEPARATOR)
6730 (errcode(ERRCODE_UNDEFINED_OBJECT),
6731 errmsg("unrecognized configuration parameter \"%s\"",
6742 GetPGVariable(const char *name, DestReceiver *dest)
6744 if (guc_name_compare(name, "all") == 0)
6745 ShowAllGUCConfig(dest);
6747 ShowGUCConfigOption(name, dest);
6751 GetPGVariableResultDesc(const char *name)
6755 if (guc_name_compare(name, "all") == 0)
6757 /* need a tuple descriptor representing three TEXT columns */
6758 tupdesc = CreateTemplateTupleDesc(3, false);
6759 TupleDescInitEntry(tupdesc, (AttrNumber) 1, "name",
6761 TupleDescInitEntry(tupdesc, (AttrNumber) 2, "setting",
6763 TupleDescInitEntry(tupdesc, (AttrNumber) 3, "description",
6768 const char *varname;
6770 /* Get the canonical spelling of name */
6771 (void) GetConfigOptionByName(name, &varname);
6773 /* need a tuple descriptor representing a single TEXT column */
6774 tupdesc = CreateTemplateTupleDesc(1, false);
6775 TupleDescInitEntry(tupdesc, (AttrNumber) 1, varname,
6786 ShowGUCConfigOption(const char *name, DestReceiver *dest)
6788 TupOutputState *tstate;
6790 const char *varname;
6793 /* Get the value and canonical spelling of name */
6794 value = GetConfigOptionByName(name, &varname);
6796 /* need a tuple descriptor representing a single TEXT column */
6797 tupdesc = CreateTemplateTupleDesc(1, false);
6798 TupleDescInitEntry(tupdesc, (AttrNumber) 1, varname,
6801 /* prepare for projection of tuples */
6802 tstate = begin_tup_output_tupdesc(dest, tupdesc);
6805 do_text_output_oneline(tstate, value);
6807 end_tup_output(tstate);
6814 ShowAllGUCConfig(DestReceiver *dest)
6816 bool am_superuser = superuser();
6818 TupOutputState *tstate;
6821 bool isnull[3] = {false, false, false};
6823 /* need a tuple descriptor representing three TEXT columns */
6824 tupdesc = CreateTemplateTupleDesc(3, false);
6825 TupleDescInitEntry(tupdesc, (AttrNumber) 1, "name",
6827 TupleDescInitEntry(tupdesc, (AttrNumber) 2, "setting",
6829 TupleDescInitEntry(tupdesc, (AttrNumber) 3, "description",
6832 /* prepare for projection of tuples */
6833 tstate = begin_tup_output_tupdesc(dest, tupdesc);
6835 for (i = 0; i < num_guc_variables; i++)
6837 struct config_generic *conf = guc_variables[i];
6840 if ((conf->flags & GUC_NO_SHOW_ALL) ||
6841 ((conf->flags & GUC_SUPERUSER_ONLY) && !am_superuser))
6844 /* assign to the values array */
6845 values[0] = PointerGetDatum(cstring_to_text(conf->name));
6847 setting = _ShowOption(conf, true);
6850 values[1] = PointerGetDatum(cstring_to_text(setting));
6855 values[1] = PointerGetDatum(NULL);
6859 values[2] = PointerGetDatum(cstring_to_text(conf->short_desc));
6861 /* send it to dest */
6862 do_tup_output(tstate, values, isnull);
6865 pfree(DatumGetPointer(values[0]));
6869 pfree(DatumGetPointer(values[1]));
6871 pfree(DatumGetPointer(values[2]));
6874 end_tup_output(tstate);
6878 * Return GUC variable value by name; optionally return canonical
6879 * form of name. Return value is palloc'd.
6882 GetConfigOptionByName(const char *name, const char **varname)
6884 struct config_generic *record;
6886 record = find_option(name, false, ERROR);
6889 (errcode(ERRCODE_UNDEFINED_OBJECT),
6890 errmsg("unrecognized configuration parameter \"%s\"", name)));
6891 if ((record->flags & GUC_SUPERUSER_ONLY) && !superuser())
6893 (errcode(ERRCODE_INSUFFICIENT_PRIVILEGE),
6894 errmsg("must be superuser to examine \"%s\"", name)));
6897 *varname = record->name;
6899 return _ShowOption(record, true);
6903 * Return GUC variable value by variable number; optionally return canonical
6904 * form of name. Return value is palloc'd.
6907 GetConfigOptionByNum(int varnum, const char **values, bool *noshow)
6910 struct config_generic *conf;
6912 /* check requested variable number valid */
6913 Assert((varnum >= 0) && (varnum < num_guc_variables));
6915 conf = guc_variables[varnum];
6919 if ((conf->flags & GUC_NO_SHOW_ALL) ||
6920 ((conf->flags & GUC_SUPERUSER_ONLY) && !superuser()))
6926 /* first get the generic attributes */
6929 values[0] = conf->name;
6931 /* setting : use _ShowOption in order to avoid duplicating the logic */
6932 values[1] = _ShowOption(conf, false);
6935 if (conf->vartype == PGC_INT)
6939 switch (conf->flags & (GUC_UNIT_MEMORY | GUC_UNIT_TIME))
6944 case GUC_UNIT_BLOCKS:
6945 snprintf(buf, sizeof(buf), "%dkB", BLCKSZ / 1024);
6948 case GUC_UNIT_XBLOCKS:
6949 snprintf(buf, sizeof(buf), "%dkB", XLOG_BLCKSZ / 1024);
6970 values[3] = config_group_names[conf->group];
6973 values[4] = conf->short_desc;
6976 values[5] = conf->long_desc;
6979 values[6] = GucContext_Names[conf->context];
6982 values[7] = config_type_names[conf->vartype];
6985 values[8] = GucSource_Names[conf->source];
6987 /* now get the type specifc attributes */
6988 switch (conf->vartype)
6992 struct config_bool *lconf = (struct config_bool *) conf;
7004 values[12] = pstrdup(lconf->boot_val ? "on" : "off");
7007 values[13] = pstrdup(lconf->reset_val ? "on" : "off");
7013 struct config_int *lconf = (struct config_int *) conf;
7016 snprintf(buffer, sizeof(buffer), "%d", lconf->min);
7017 values[9] = pstrdup(buffer);
7020 snprintf(buffer, sizeof(buffer), "%d", lconf->max);
7021 values[10] = pstrdup(buffer);
7027 snprintf(buffer, sizeof(buffer), "%d", lconf->boot_val);
7028 values[12] = pstrdup(buffer);
7031 snprintf(buffer, sizeof(buffer), "%d", lconf->reset_val);
7032 values[13] = pstrdup(buffer);
7038 struct config_real *lconf = (struct config_real *) conf;
7041 snprintf(buffer, sizeof(buffer), "%g", lconf->min);
7042 values[9] = pstrdup(buffer);
7045 snprintf(buffer, sizeof(buffer), "%g", lconf->max);
7046 values[10] = pstrdup(buffer);
7052 snprintf(buffer, sizeof(buffer), "%g", lconf->boot_val);
7053 values[12] = pstrdup(buffer);
7056 snprintf(buffer, sizeof(buffer), "%g", lconf->reset_val);
7057 values[13] = pstrdup(buffer);
7063 struct config_string *lconf = (struct config_string *) conf;
7075 if (lconf->boot_val == NULL)
7078 values[12] = pstrdup(lconf->boot_val);
7081 if (lconf->reset_val == NULL)
7084 values[13] = pstrdup(lconf->reset_val);
7090 struct config_enum *lconf = (struct config_enum *) conf;
7101 * NOTE! enumvals with double quotes in them are not
7104 values[11] = config_enum_get_options((struct config_enum *) conf,
7105 "{\"", "\"}", "\",\"");
7108 values[12] = pstrdup(config_enum_lookup_by_value(lconf,
7112 values[13] = pstrdup(config_enum_lookup_by_value(lconf,
7120 * should never get here, but in case we do, set 'em to NULL
7142 * If the setting came from a config file, set the source location. For
7143 * security reasons, we don't show source file/line number for
7146 if (conf->source == PGC_S_FILE && superuser())
7148 values[14] = conf->sourcefile;
7149 snprintf(buffer, sizeof(buffer), "%d", conf->sourceline);
7150 values[15] = pstrdup(buffer);
7160 * Return the total number of GUC variables
7163 GetNumConfigOptions(void)
7165 return num_guc_variables;
7169 * show_config_by_name - equiv to SHOW X command but implemented as
7173 show_config_by_name(PG_FUNCTION_ARGS)
7178 /* Get the GUC variable name */
7179 varname = TextDatumGetCString(PG_GETARG_DATUM(0));
7182 varval = GetConfigOptionByName(varname, NULL);
7184 /* Convert to text */
7185 PG_RETURN_TEXT_P(cstring_to_text(varval));
7189 * show_all_settings - equiv to SHOW ALL command but implemented as
7192 #define NUM_PG_SETTINGS_ATTS 16
7195 show_all_settings(PG_FUNCTION_ARGS)
7197 FuncCallContext *funcctx;
7201 AttInMetadata *attinmeta;
7202 MemoryContext oldcontext;
7204 /* stuff done only on the first call of the function */
7205 if (SRF_IS_FIRSTCALL())
7207 /* create a function context for cross-call persistence */
7208 funcctx = SRF_FIRSTCALL_INIT();
7211 * switch to memory context appropriate for multiple function calls
7213 oldcontext = MemoryContextSwitchTo(funcctx->multi_call_memory_ctx);
7216 * need a tuple descriptor representing NUM_PG_SETTINGS_ATTS columns
7217 * of the appropriate types
7219 tupdesc = CreateTemplateTupleDesc(NUM_PG_SETTINGS_ATTS, false);
7220 TupleDescInitEntry(tupdesc, (AttrNumber) 1, "name",
7222 TupleDescInitEntry(tupdesc, (AttrNumber) 2, "setting",
7224 TupleDescInitEntry(tupdesc, (AttrNumber) 3, "unit",
7226 TupleDescInitEntry(tupdesc, (AttrNumber) 4, "category",
7228 TupleDescInitEntry(tupdesc, (AttrNumber) 5, "short_desc",
7230 TupleDescInitEntry(tupdesc, (AttrNumber) 6, "extra_desc",
7232 TupleDescInitEntry(tupdesc, (AttrNumber) 7, "context",
7234 TupleDescInitEntry(tupdesc, (AttrNumber) 8, "vartype",
7236 TupleDescInitEntry(tupdesc, (AttrNumber) 9, "source",
7238 TupleDescInitEntry(tupdesc, (AttrNumber) 10, "min_val",
7240 TupleDescInitEntry(tupdesc, (AttrNumber) 11, "max_val",
7242 TupleDescInitEntry(tupdesc, (AttrNumber) 12, "enumvals",
7243 TEXTARRAYOID, -1, 0);
7244 TupleDescInitEntry(tupdesc, (AttrNumber) 13, "boot_val",
7246 TupleDescInitEntry(tupdesc, (AttrNumber) 14, "reset_val",
7248 TupleDescInitEntry(tupdesc, (AttrNumber) 15, "sourcefile",
7250 TupleDescInitEntry(tupdesc, (AttrNumber) 16, "sourceline",
7254 * Generate attribute metadata needed later to produce tuples from raw
7257 attinmeta = TupleDescGetAttInMetadata(tupdesc);
7258 funcctx->attinmeta = attinmeta;
7260 /* total number of tuples to be returned */
7261 funcctx->max_calls = GetNumConfigOptions();
7263 MemoryContextSwitchTo(oldcontext);
7266 /* stuff done on every call of the function */
7267 funcctx = SRF_PERCALL_SETUP();
7269 call_cntr = funcctx->call_cntr;
7270 max_calls = funcctx->max_calls;
7271 attinmeta = funcctx->attinmeta;
7273 if (call_cntr < max_calls) /* do when there is more left to send */
7275 char *values[NUM_PG_SETTINGS_ATTS];
7281 * Get the next visible GUC variable name and value
7285 GetConfigOptionByNum(call_cntr, (const char **) values, &noshow);
7288 /* bump the counter and get the next config setting */
7289 call_cntr = ++funcctx->call_cntr;
7291 /* make sure we haven't gone too far now */
7292 if (call_cntr >= max_calls)
7293 SRF_RETURN_DONE(funcctx);
7298 tuple = BuildTupleFromCStrings(attinmeta, values);
7300 /* make the tuple into a datum */
7301 result = HeapTupleGetDatum(tuple);
7303 SRF_RETURN_NEXT(funcctx, result);
7307 /* do when there is no more left */
7308 SRF_RETURN_DONE(funcctx);
7313 _ShowOption(struct config_generic * record, bool use_units)
7318 switch (record->vartype)
7322 struct config_bool *conf = (struct config_bool *) record;
7324 if (conf->show_hook)
7325 val = (*conf->show_hook) ();
7327 val = *conf->variable ? "on" : "off";
7333 struct config_int *conf = (struct config_int *) record;
7335 if (conf->show_hook)
7336 val = (*conf->show_hook) ();
7340 * Use int64 arithmetic to avoid overflows in units
7343 int64 result = *conf->variable;
7346 if (use_units && result > 0 &&
7347 (record->flags & GUC_UNIT_MEMORY))
7349 switch (record->flags & GUC_UNIT_MEMORY)
7351 case GUC_UNIT_BLOCKS:
7352 result *= BLCKSZ / 1024;
7354 case GUC_UNIT_XBLOCKS:
7355 result *= XLOG_BLCKSZ / 1024;
7359 if (result % KB_PER_GB == 0)
7361 result /= KB_PER_GB;
7364 else if (result % KB_PER_MB == 0)
7366 result /= KB_PER_MB;
7374 else if (use_units && result > 0 &&
7375 (record->flags & GUC_UNIT_TIME))
7377 switch (record->flags & GUC_UNIT_TIME)
7383 result *= MS_PER_MIN;
7387 if (result % MS_PER_D == 0)
7392 else if (result % MS_PER_H == 0)
7397 else if (result % MS_PER_MIN == 0)
7399 result /= MS_PER_MIN;
7402 else if (result % MS_PER_S == 0)
7415 snprintf(buffer, sizeof(buffer), INT64_FORMAT "%s",
7424 struct config_real *conf = (struct config_real *) record;
7426 if (conf->show_hook)
7427 val = (*conf->show_hook) ();
7430 snprintf(buffer, sizeof(buffer), "%g",
7439 struct config_string *conf = (struct config_string *) record;
7441 if (conf->show_hook)
7442 val = (*conf->show_hook) ();
7443 else if (*conf->variable && **conf->variable)
7444 val = *conf->variable;
7452 struct config_enum *conf = (struct config_enum *) record;
7454 if (conf->show_hook)
7455 val = (*conf->show_hook) ();
7457 val = config_enum_lookup_by_value(conf, *conf->variable);
7462 /* just to keep compiler quiet */
7467 return pstrdup(val);
7474 * These routines dump out all non-default GUC options into a binary
7475 * file that is read by all exec'ed backends. The format is:
7477 * variable name, string, null terminated
7478 * variable value, string, null terminated
7479 * variable sourcefile, string, null terminated (empty if none)
7480 * variable sourceline, integer
7481 * variable source, integer
7482 * variable scontext, integer
7485 write_one_nondefault_variable(FILE *fp, struct config_generic * gconf)
7487 if (gconf->source == PGC_S_DEFAULT)
7490 fprintf(fp, "%s", gconf->name);
7493 switch (gconf->vartype)
7497 struct config_bool *conf = (struct config_bool *) gconf;
7499 if (*conf->variable)
7500 fprintf(fp, "true");
7502 fprintf(fp, "false");
7508 struct config_int *conf = (struct config_int *) gconf;
7510 fprintf(fp, "%d", *conf->variable);
7516 struct config_real *conf = (struct config_real *) gconf;
7518 fprintf(fp, "%.17g", *conf->variable);
7524 struct config_string *conf = (struct config_string *) gconf;
7526 fprintf(fp, "%s", *conf->variable);
7532 struct config_enum *conf = (struct config_enum *) gconf;
7535 config_enum_lookup_by_value(conf, *conf->variable));
7542 if (gconf->sourcefile)
7543 fprintf(fp, "%s", gconf->sourcefile);
7546 fwrite(&gconf->sourceline, 1, sizeof(gconf->sourceline), fp);
7547 fwrite(&gconf->source, 1, sizeof(gconf->source), fp);
7548 fwrite(&gconf->scontext, 1, sizeof(gconf->scontext), fp);
7552 write_nondefault_variables(GucContext context)
7558 Assert(context == PGC_POSTMASTER || context == PGC_SIGHUP);
7560 elevel = (context == PGC_SIGHUP) ? LOG : ERROR;
7565 fp = AllocateFile(CONFIG_EXEC_PARAMS_NEW, "w");
7569 (errcode_for_file_access(),
7570 errmsg("could not write to file \"%s\": %m",
7571 CONFIG_EXEC_PARAMS_NEW)));
7575 for (i = 0; i < num_guc_variables; i++)
7577 write_one_nondefault_variable(fp, guc_variables[i]);
7583 (errcode_for_file_access(),
7584 errmsg("could not write to file \"%s\": %m",
7585 CONFIG_EXEC_PARAMS_NEW)));
7590 * Put new file in place. This could delay on Win32, but we don't hold
7591 * any exclusive locks.
7593 rename(CONFIG_EXEC_PARAMS_NEW, CONFIG_EXEC_PARAMS);
7598 * Read string, including null byte from file
7600 * Return NULL on EOF and nothing read
7603 read_string_with_null(FILE *fp)
7612 if ((ch = fgetc(fp)) == EOF)
7617 elog(FATAL, "invalid format of exec config params file");
7620 str = guc_malloc(FATAL, maxlen);
7621 else if (i == maxlen)
7622 str = guc_realloc(FATAL, str, maxlen *= 2);
7631 * This routine loads a previous postmaster dump of its non-default
7635 read_nondefault_variables(void)
7642 GucSource varsource;
7643 GucContext varscontext;
7648 fp = AllocateFile(CONFIG_EXEC_PARAMS, "r");
7651 /* File not found is fine */
7652 if (errno != ENOENT)
7654 (errcode_for_file_access(),
7655 errmsg("could not read from file \"%s\": %m",
7656 CONFIG_EXEC_PARAMS)));
7662 struct config_generic *record;
7664 if ((varname = read_string_with_null(fp)) == NULL)
7667 if ((record = find_option(varname, true, FATAL)) == NULL)
7668 elog(FATAL, "failed to locate variable \"%s\" in exec config params file", varname);
7670 if ((varvalue = read_string_with_null(fp)) == NULL)
7671 elog(FATAL, "invalid format of exec config params file");
7672 if ((varsourcefile = read_string_with_null(fp)) == NULL)
7673 elog(FATAL, "invalid format of exec config params file");
7674 if (fread(&varsourceline, 1, sizeof(varsourceline), fp) != sizeof(varsourceline))
7675 elog(FATAL, "invalid format of exec config params file");
7676 if (fread(&varsource, 1, sizeof(varsource), fp) != sizeof(varsource))
7677 elog(FATAL, "invalid format of exec config params file");
7678 if (fread(&varscontext, 1, sizeof(varscontext), fp) != sizeof(varscontext))
7679 elog(FATAL, "invalid format of exec config params file");
7681 (void) set_config_option(varname, varvalue,
7682 varscontext, varsource,
7683 GUC_ACTION_SET, true, 0);
7684 if (varsourcefile[0])
7685 set_config_sourcefile(varname, varsourcefile, varsourceline);
7689 free(varsourcefile);
7694 #endif /* EXEC_BACKEND */
7698 * A little "long argument" simulation, although not quite GNU
7699 * compliant. Takes a string of the form "some-option=some value" and
7700 * returns name = "some_option" and value = "some value" in malloc'ed
7701 * storage. Note that '-' is converted to '_' in the option name. If
7702 * there is no '=' in the input string then value will be NULL.
7705 ParseLongOption(const char *string, char **name, char **value)
7714 equal_pos = strcspn(string, "=");
7716 if (string[equal_pos] == '=')
7718 *name = guc_malloc(FATAL, equal_pos + 1);
7719 strlcpy(*name, string, equal_pos + 1);
7721 *value = guc_strdup(FATAL, &string[equal_pos + 1]);
7725 /* no equal sign in string */
7726 *name = guc_strdup(FATAL, string);
7730 for (cp = *name; *cp; cp++)
7737 * Handle options fetched from pg_db_role_setting.setconfig,
7738 * pg_proc.proconfig, etc. Caller must specify proper context/source/action.
7740 * The array parameter must be an array of TEXT (it must not be NULL).
7743 ProcessGUCArray(ArrayType *array,
7744 GucContext context, GucSource source, GucAction action)
7748 Assert(array != NULL);
7749 Assert(ARR_ELEMTYPE(array) == TEXTOID);
7750 Assert(ARR_NDIM(array) == 1);
7751 Assert(ARR_LBOUND(array)[0] == 1);
7753 for (i = 1; i <= ARR_DIMS(array)[0]; i++)
7761 d = array_ref(array, 1, &i,
7762 -1 /* varlenarray */ ,
7763 -1 /* TEXT's typlen */ ,
7764 false /* TEXT's typbyval */ ,
7765 'i' /* TEXT's typalign */ ,
7771 s = TextDatumGetCString(d);
7773 ParseLongOption(s, &name, &value);
7777 (errcode(ERRCODE_SYNTAX_ERROR),
7778 errmsg("could not parse setting for parameter \"%s\"",
7784 (void) set_config_option(name, value,
7797 * Add an entry to an option array. The array parameter may be NULL
7798 * to indicate the current table entry is NULL.
7801 GUCArrayAdd(ArrayType *array, const char *name, const char *value)
7803 struct config_generic *record;
7811 /* test if the option is valid and we're allowed to set it */
7812 (void) validate_option_array_item(name, value, false);
7814 /* normalize name (converts obsolete GUC names to modern spellings) */
7815 record = find_option(name, false, WARNING);
7817 name = record->name;
7819 /* build new item for array */
7820 newval = palloc(strlen(name) + 1 + strlen(value) + 1);
7821 sprintf(newval, "%s=%s", name, value);
7822 datum = CStringGetTextDatum(newval);
7830 Assert(ARR_ELEMTYPE(array) == TEXTOID);
7831 Assert(ARR_NDIM(array) == 1);
7832 Assert(ARR_LBOUND(array)[0] == 1);
7834 index = ARR_DIMS(array)[0] + 1; /* add after end */
7836 for (i = 1; i <= ARR_DIMS(array)[0]; i++)
7841 d = array_ref(array, 1, &i,
7842 -1 /* varlenarray */ ,
7843 -1 /* TEXT's typlen */ ,
7844 false /* TEXT's typbyval */ ,
7845 'i' /* TEXT's typalign */ ,
7849 current = TextDatumGetCString(d);
7851 /* check for match up through and including '=' */
7852 if (strncmp(current, newval, strlen(name) + 1) == 0)
7859 a = array_set(array, 1, &index,
7862 -1 /* varlena array */ ,
7863 -1 /* TEXT's typlen */ ,
7864 false /* TEXT's typbyval */ ,
7865 'i' /* TEXT's typalign */ );
7868 a = construct_array(&datum, 1,
7877 * Delete an entry from an option array. The array parameter may be NULL
7878 * to indicate the current table entry is NULL. Also, if the return value
7879 * is NULL then a null should be stored.
7882 GUCArrayDelete(ArrayType *array, const char *name)
7884 struct config_generic *record;
7885 ArrayType *newarray;
7891 /* test if the option is valid and we're allowed to set it */
7892 (void) validate_option_array_item(name, NULL, false);
7894 /* normalize name (converts obsolete GUC names to modern spellings) */
7895 record = find_option(name, false, WARNING);
7897 name = record->name;
7899 /* if array is currently null, then surely nothing to delete */
7906 for (i = 1; i <= ARR_DIMS(array)[0]; i++)
7912 d = array_ref(array, 1, &i,
7913 -1 /* varlenarray */ ,
7914 -1 /* TEXT's typlen */ ,
7915 false /* TEXT's typbyval */ ,
7916 'i' /* TEXT's typalign */ ,
7920 val = TextDatumGetCString(d);
7922 /* ignore entry if it's what we want to delete */
7923 if (strncmp(val, name, strlen(name)) == 0
7924 && val[strlen(name)] == '=')
7927 /* else add it to the output array */
7929 newarray = array_set(newarray, 1, &index,
7932 -1 /* varlenarray */ ,
7933 -1 /* TEXT's typlen */ ,
7934 false /* TEXT's typbyval */ ,
7935 'i' /* TEXT's typalign */ );
7937 newarray = construct_array(&d, 1,
7949 * Given a GUC array, delete all settings from it that our permission
7950 * level allows: if superuser, delete them all; if regular user, only
7951 * those that are PGC_USERSET
7954 GUCArrayReset(ArrayType *array)
7956 ArrayType *newarray;
7960 /* if array is currently null, nothing to do */
7964 /* if we're superuser, we can delete everything, so just do it */
7971 for (i = 1; i <= ARR_DIMS(array)[0]; i++)
7978 d = array_ref(array, 1, &i,
7979 -1 /* varlenarray */ ,
7980 -1 /* TEXT's typlen */ ,
7981 false /* TEXT's typbyval */ ,
7982 'i' /* TEXT's typalign */ ,
7986 val = TextDatumGetCString(d);
7988 eqsgn = strchr(val, '=');
7991 /* skip if we have permission to delete it */
7992 if (validate_option_array_item(val, NULL, true))
7995 /* else add it to the output array */
7997 newarray = array_set(newarray, 1, &index,
8000 -1 /* varlenarray */ ,
8001 -1 /* TEXT's typlen */ ,
8002 false /* TEXT's typbyval */ ,
8003 'i' /* TEXT's typalign */ );
8005 newarray = construct_array(&d, 1,
8017 * Validate a proposed option setting for GUCArrayAdd/Delete/Reset.
8019 * name is the option name. value is the proposed value for the Add case,
8020 * or NULL for the Delete/Reset cases. If skipIfNoPermissions is true, it's
8021 * not an error to have no permissions to set the option.
8023 * Returns TRUE if OK, FALSE if skipIfNoPermissions is true and user does not
8024 * have permission to change this option (all other error cases result in an
8025 * error being thrown).
8028 validate_option_array_item(const char *name, const char *value,
8029 bool skipIfNoPermissions)
8032 struct config_generic *gconf;
8035 * There are three cases to consider:
8037 * name is a known GUC variable. Check the value normally, check
8038 * permissions normally (ie, allow if variable is USERSET, or if it's
8039 * SUSET and user is superuser).
8041 * name is not known, but exists or can be created as a placeholder (i.e.,
8042 * it has a prefixed name). We allow this case if you're a superuser,
8043 * otherwise not. Superusers are assumed to know what they're doing. We
8044 * can't allow it for other users, because when the placeholder is
8045 * resolved it might turn out to be a SUSET variable;
8046 * define_custom_variable assumes we checked that.
8048 * name is not known and can't be created as a placeholder. Throw error,
8049 * unless skipIfNoPermissions is true, in which case return FALSE.
8051 gconf = find_option(name, true, WARNING);
8054 /* not known, failed to make a placeholder */
8055 if (skipIfNoPermissions)
8058 (errcode(ERRCODE_UNDEFINED_OBJECT),
8059 errmsg("unrecognized configuration parameter \"%s\"",
8063 if (gconf->flags & GUC_CUSTOM_PLACEHOLDER)
8066 * We cannot do any meaningful check on the value, so only permissions
8067 * are useful to check.
8071 if (skipIfNoPermissions)
8074 (errcode(ERRCODE_INSUFFICIENT_PRIVILEGE),
8075 errmsg("permission denied to set parameter \"%s\"", name)));
8078 /* manual permissions check so we can avoid an error being thrown */
8079 if (gconf->context == PGC_USERSET)
8081 else if (gconf->context == PGC_SUSET && superuser())
8083 else if (skipIfNoPermissions)
8085 /* if a permissions error should be thrown, let set_config_option do it */
8087 /* test for permissions and valid option value */
8088 (void) set_config_option(name, value,
8089 superuser() ? PGC_SUSET : PGC_USERSET,
8090 PGC_S_TEST, GUC_ACTION_SET, false, 0);
8097 * Called by check_hooks that want to override the normal
8098 * ERRCODE_INVALID_PARAMETER_VALUE SQLSTATE for check hook failures.
8100 * Note that GUC_check_errmsg() etc are just macros that result in a direct
8101 * assignment to the associated variables. That is ugly, but forced by the
8102 * limitations of C's macro mechanisms.
8105 GUC_check_errcode(int sqlerrcode)
8107 GUC_check_errcode_value = sqlerrcode;
8112 * Convenience functions to manage calling a variable's check_hook.
8113 * These mostly take care of the protocol for letting check hooks supply
8114 * portions of the error report on failure.
8118 call_bool_check_hook(struct config_bool * conf, bool *newval, void **extra,
8119 GucSource source, int elevel)
8121 /* Quick success if no hook */
8122 if (!conf->check_hook)
8125 /* Reset variables that might be set by hook */
8126 GUC_check_errcode_value = ERRCODE_INVALID_PARAMETER_VALUE;
8127 GUC_check_errmsg_string = NULL;
8128 GUC_check_errdetail_string = NULL;
8129 GUC_check_errhint_string = NULL;
8131 if (!(*conf->check_hook) (newval, extra, source))
8134 (errcode(GUC_check_errcode_value),
8135 GUC_check_errmsg_string ?
8136 errmsg_internal("%s", GUC_check_errmsg_string) :
8137 errmsg("invalid value for parameter \"%s\": %d",
8138 conf->gen.name, (int) *newval),
8139 GUC_check_errdetail_string ?
8140 errdetail_internal("%s", GUC_check_errdetail_string) : 0,
8141 GUC_check_errhint_string ?
8142 errhint("%s", GUC_check_errhint_string) : 0));
8143 /* Flush any strings created in ErrorContext */
8152 call_int_check_hook(struct config_int * conf, int *newval, void **extra,
8153 GucSource source, int elevel)
8155 /* Quick success if no hook */
8156 if (!conf->check_hook)
8159 /* Reset variables that might be set by hook */
8160 GUC_check_errcode_value = ERRCODE_INVALID_PARAMETER_VALUE;
8161 GUC_check_errmsg_string = NULL;
8162 GUC_check_errdetail_string = NULL;
8163 GUC_check_errhint_string = NULL;
8165 if (!(*conf->check_hook) (newval, extra, source))
8168 (errcode(GUC_check_errcode_value),
8169 GUC_check_errmsg_string ?
8170 errmsg_internal("%s", GUC_check_errmsg_string) :
8171 errmsg("invalid value for parameter \"%s\": %d",
8172 conf->gen.name, *newval),
8173 GUC_check_errdetail_string ?
8174 errdetail_internal("%s", GUC_check_errdetail_string) : 0,
8175 GUC_check_errhint_string ?
8176 errhint("%s", GUC_check_errhint_string) : 0));
8177 /* Flush any strings created in ErrorContext */
8186 call_real_check_hook(struct config_real * conf, double *newval, void **extra,
8187 GucSource source, int elevel)
8189 /* Quick success if no hook */
8190 if (!conf->check_hook)
8193 /* Reset variables that might be set by hook */
8194 GUC_check_errcode_value = ERRCODE_INVALID_PARAMETER_VALUE;
8195 GUC_check_errmsg_string = NULL;
8196 GUC_check_errdetail_string = NULL;
8197 GUC_check_errhint_string = NULL;
8199 if (!(*conf->check_hook) (newval, extra, source))
8202 (errcode(GUC_check_errcode_value),
8203 GUC_check_errmsg_string ?
8204 errmsg_internal("%s", GUC_check_errmsg_string) :
8205 errmsg("invalid value for parameter \"%s\": %g",
8206 conf->gen.name, *newval),
8207 GUC_check_errdetail_string ?
8208 errdetail_internal("%s", GUC_check_errdetail_string) : 0,
8209 GUC_check_errhint_string ?
8210 errhint("%s", GUC_check_errhint_string) : 0));
8211 /* Flush any strings created in ErrorContext */
8220 call_string_check_hook(struct config_string * conf, char **newval, void **extra,
8221 GucSource source, int elevel)
8223 /* Quick success if no hook */
8224 if (!conf->check_hook)
8227 /* Reset variables that might be set by hook */
8228 GUC_check_errcode_value = ERRCODE_INVALID_PARAMETER_VALUE;
8229 GUC_check_errmsg_string = NULL;
8230 GUC_check_errdetail_string = NULL;
8231 GUC_check_errhint_string = NULL;
8233 if (!(*conf->check_hook) (newval, extra, source))
8236 (errcode(GUC_check_errcode_value),
8237 GUC_check_errmsg_string ?
8238 errmsg_internal("%s", GUC_check_errmsg_string) :
8239 errmsg("invalid value for parameter \"%s\": \"%s\"",
8240 conf->gen.name, *newval ? *newval : ""),
8241 GUC_check_errdetail_string ?
8242 errdetail_internal("%s", GUC_check_errdetail_string) : 0,
8243 GUC_check_errhint_string ?
8244 errhint("%s", GUC_check_errhint_string) : 0));
8245 /* Flush any strings created in ErrorContext */
8254 call_enum_check_hook(struct config_enum * conf, int *newval, void **extra,
8255 GucSource source, int elevel)
8257 /* Quick success if no hook */
8258 if (!conf->check_hook)
8261 /* Reset variables that might be set by hook */
8262 GUC_check_errcode_value = ERRCODE_INVALID_PARAMETER_VALUE;
8263 GUC_check_errmsg_string = NULL;
8264 GUC_check_errdetail_string = NULL;
8265 GUC_check_errhint_string = NULL;
8267 if (!(*conf->check_hook) (newval, extra, source))
8270 (errcode(GUC_check_errcode_value),
8271 GUC_check_errmsg_string ?
8272 errmsg_internal("%s", GUC_check_errmsg_string) :
8273 errmsg("invalid value for parameter \"%s\": \"%s\"",
8275 config_enum_lookup_by_value(conf, *newval)),
8276 GUC_check_errdetail_string ?
8277 errdetail_internal("%s", GUC_check_errdetail_string) : 0,
8278 GUC_check_errhint_string ?
8279 errhint("%s", GUC_check_errhint_string) : 0));
8280 /* Flush any strings created in ErrorContext */
8290 * check_hook, assign_hook and show_hook subroutines
8294 check_log_destination(char **newval, void **extra, GucSource source)
8302 /* Need a modifiable copy of string */
8303 rawstring = pstrdup(*newval);
8305 /* Parse string into list of identifiers */
8306 if (!SplitIdentifierString(rawstring, ',', &elemlist))
8308 /* syntax error in list */
8309 GUC_check_errdetail("List syntax is invalid.");
8311 list_free(elemlist);
8315 foreach(l, elemlist)
8317 char *tok = (char *) lfirst(l);
8319 if (pg_strcasecmp(tok, "stderr") == 0)
8320 newlogdest |= LOG_DESTINATION_STDERR;
8321 else if (pg_strcasecmp(tok, "csvlog") == 0)
8322 newlogdest |= LOG_DESTINATION_CSVLOG;
8324 else if (pg_strcasecmp(tok, "syslog") == 0)
8325 newlogdest |= LOG_DESTINATION_SYSLOG;
8328 else if (pg_strcasecmp(tok, "eventlog") == 0)
8329 newlogdest |= LOG_DESTINATION_EVENTLOG;
8333 GUC_check_errdetail("Unrecognized key word: \"%s\".", tok);
8335 list_free(elemlist);
8341 list_free(elemlist);
8343 myextra = (int *) guc_malloc(ERROR, sizeof(int));
8344 *myextra = newlogdest;
8345 *extra = (void *) myextra;
8351 assign_log_destination(const char *newval, void *extra)
8353 Log_destination = *((int *) extra);
8357 assign_syslog_facility(int newval, void *extra)
8360 set_syslog_parameters(syslog_ident_str ? syslog_ident_str : "postgres",
8363 /* Without syslog support, just ignore it */
8367 assign_syslog_ident(const char *newval, void *extra)
8370 set_syslog_parameters(newval, syslog_facility);
8372 /* Without syslog support, it will always be set to "none", so ignore */
8377 assign_session_replication_role(int newval, void *extra)
8380 * Must flush the plan cache when changing replication role; but don't
8381 * flush unnecessarily.
8383 if (SessionReplicationRole != newval)
8388 check_temp_buffers(int *newval, void **extra, GucSource source)
8391 * Once local buffers have been initialized, it's too late to change this.
8393 if (NLocBuffer && NLocBuffer != *newval)
8395 GUC_check_errdetail("\"temp_buffers\" cannot be changed after any temporary tables have been accessed in the session.");
8402 check_phony_autocommit(bool *newval, void **extra, GucSource source)
8406 GUC_check_errcode(ERRCODE_FEATURE_NOT_SUPPORTED);
8407 GUC_check_errmsg("SET AUTOCOMMIT TO OFF is no longer supported");
8414 check_debug_assertions(bool *newval, void **extra, GucSource source)
8416 #ifndef USE_ASSERT_CHECKING
8419 GUC_check_errmsg("assertion checking is not supported by this build");
8427 check_bonjour(bool *newval, void **extra, GucSource source)
8432 GUC_check_errmsg("Bonjour is not supported by this build");
8440 check_ssl(bool *newval, void **extra, GucSource source)
8445 GUC_check_errmsg("SSL is not supported by this build");
8453 check_stage_log_stats(bool *newval, void **extra, GucSource source)
8455 if (*newval && log_statement_stats)
8457 GUC_check_errdetail("Cannot enable parameter when \"log_statement_stats\" is true.");
8464 check_log_stats(bool *newval, void **extra, GucSource source)
8467 (log_parser_stats || log_planner_stats || log_executor_stats))
8469 GUC_check_errdetail("Cannot enable \"log_statement_stats\" when "
8470 "\"log_parser_stats\", \"log_planner_stats\", "
8471 "or \"log_executor_stats\" is true.");
8478 check_canonical_path(char **newval, void **extra, GucSource source)
8481 * Since canonicalize_path never enlarges the string, we can just modify
8482 * newval in-place. But watch out for NULL, which is the default value
8483 * for external_pid_file.
8486 canonicalize_path(*newval);
8491 check_timezone_abbreviations(char **newval, void **extra, GucSource source)
8494 * The boot_val given above for timezone_abbreviations is NULL. When we
8495 * see this we just do nothing. If this value isn't overridden from the
8496 * config file then pg_timezone_abbrev_initialize() will eventually
8497 * replace it with "Default". This hack has two purposes: to avoid
8498 * wasting cycles loading values that might soon be overridden from the
8499 * config file, and to avoid trying to read the timezone abbrev files
8500 * during InitializeGUCOptions(). The latter doesn't work in an
8501 * EXEC_BACKEND subprocess because my_exec_path hasn't been set yet and so
8502 * we can't locate PGSHAREDIR.
8504 if (*newval == NULL)
8506 Assert(source == PGC_S_DEFAULT);
8510 /* OK, load the file and produce a malloc'd TimeZoneAbbrevTable */
8511 *extra = load_tzoffsets(*newval);
8513 /* tzparser.c returns NULL on failure, reporting via GUC_check_errmsg */
8521 assign_timezone_abbreviations(const char *newval, void *extra)
8523 /* Do nothing for the boot_val default of NULL */
8527 InstallTimeZoneAbbrevs((TimeZoneAbbrevTable *) extra);
8531 * pg_timezone_abbrev_initialize --- set default value if not done already
8533 * This is called after initial loading of postgresql.conf. If no
8534 * timezone_abbreviations setting was found therein, select default.
8535 * If a non-default value is already installed, nothing will happen.
8537 * This can also be called from ProcessConfigFile to establish the default
8538 * value after a postgresql.conf entry for it is removed.
8541 pg_timezone_abbrev_initialize(void)
8543 SetConfigOption("timezone_abbreviations", "Default",
8544 PGC_POSTMASTER, PGC_S_DYNAMIC_DEFAULT);
8548 show_archive_command(void)
8550 if (XLogArchivingActive())
8551 return XLogArchiveCommand;
8553 return "(disabled)";
8557 assign_tcp_keepalives_idle(int newval, void *extra)
8560 * The kernel API provides no way to test a value without setting it; and
8561 * once we set it we might fail to unset it. So there seems little point
8562 * in fully implementing the check-then-assign GUC API for these
8563 * variables. Instead we just do the assignment on demand. pqcomm.c
8564 * reports any problems via elog(LOG).
8566 * This approach means that the GUC value might have little to do with the
8567 * actual kernel value, so we use a show_hook that retrieves the kernel
8568 * value rather than trusting GUC's copy.
8570 (void) pq_setkeepalivesidle(newval, MyProcPort);
8574 show_tcp_keepalives_idle(void)
8576 /* See comments in assign_tcp_keepalives_idle */
8577 static char nbuf[16];
8579 snprintf(nbuf, sizeof(nbuf), "%d", pq_getkeepalivesidle(MyProcPort));
8584 assign_tcp_keepalives_interval(int newval, void *extra)
8586 /* See comments in assign_tcp_keepalives_idle */
8587 (void) pq_setkeepalivesinterval(newval, MyProcPort);
8591 show_tcp_keepalives_interval(void)
8593 /* See comments in assign_tcp_keepalives_idle */
8594 static char nbuf[16];
8596 snprintf(nbuf, sizeof(nbuf), "%d", pq_getkeepalivesinterval(MyProcPort));
8601 assign_tcp_keepalives_count(int newval, void *extra)
8603 /* See comments in assign_tcp_keepalives_idle */
8604 (void) pq_setkeepalivescount(newval, MyProcPort);
8608 show_tcp_keepalives_count(void)
8610 /* See comments in assign_tcp_keepalives_idle */
8611 static char nbuf[16];
8613 snprintf(nbuf, sizeof(nbuf), "%d", pq_getkeepalivescount(MyProcPort));
8618 check_maxconnections(int *newval, void **extra, GucSource source)
8620 if (*newval + autovacuum_max_workers + 1 > MAX_BACKENDS)
8626 assign_maxconnections(int newval, void *extra)
8628 MaxBackends = newval + autovacuum_max_workers + 1;
8632 check_autovacuum_max_workers(int *newval, void **extra, GucSource source)
8634 if (MaxConnections + *newval + 1 > MAX_BACKENDS)
8640 assign_autovacuum_max_workers(int newval, void *extra)
8642 MaxBackends = MaxConnections + newval + 1;
8646 check_effective_io_concurrency(int *newval, void **extra, GucSource source)
8649 double new_prefetch_pages = 0.0;
8653 * The user-visible GUC parameter is the number of drives (spindles),
8654 * which we need to translate to a number-of-pages-to-prefetch target.
8655 * The target value is stashed in *extra and then assigned to the actual
8656 * variable by assign_effective_io_concurrency.
8658 * The expected number of prefetch pages needed to keep N drives busy is:
8660 * drives | I/O requests
8661 * -------+----------------
8664 * 3 | 3/1 + 3/2 + 3/3 = 5 1/2
8665 * 4 | 4/1 + 4/2 + 4/3 + 4/4 = 8 1/3
8668 * This is called the "coupon collector problem" and H(n) is called the
8669 * harmonic series. This could be approximated by n * ln(n), but for
8670 * reasonable numbers of drives we might as well just compute the series.
8672 * Alternatively we could set the target to the number of pages necessary
8673 * so that the expected number of active spindles is some arbitrary
8674 * percentage of the total. This sounds the same but is actually slightly
8675 * different. The result ends up being ln(1-P)/ln((n-1)/n) where P is
8676 * that desired fraction.
8678 * Experimental results show that both of these formulas aren't aggressive
8679 * enough, but we don't really have any better proposals.
8681 * Note that if *newval = 0 (disabled), we must set target = 0.
8685 for (i = 1; i <= *newval; i++)
8686 new_prefetch_pages += (double) *newval / (double) i;
8688 /* This range check shouldn't fail, but let's be paranoid */
8689 if (new_prefetch_pages >= 0.0 && new_prefetch_pages < (double) INT_MAX)
8691 int *myextra = (int *) guc_malloc(ERROR, sizeof(int));
8693 *myextra = (int) rint(new_prefetch_pages);
8694 *extra = (void *) myextra;
8702 #endif /* USE_PREFETCH */
8706 assign_effective_io_concurrency(int newval, void *extra)
8709 target_prefetch_pages = *((int *) extra);
8710 #endif /* USE_PREFETCH */
8714 assign_pgstat_temp_directory(const char *newval, void *extra)
8716 /* check_canonical_path already canonicalized newval for us */
8720 tname = guc_malloc(ERROR, strlen(newval) + 12); /* /pgstat.tmp */
8721 sprintf(tname, "%s/pgstat.tmp", newval);
8722 fname = guc_malloc(ERROR, strlen(newval) + 13); /* /pgstat.stat */
8723 sprintf(fname, "%s/pgstat.stat", newval);
8725 if (pgstat_stat_tmpname)
8726 free(pgstat_stat_tmpname);
8727 pgstat_stat_tmpname = tname;
8728 if (pgstat_stat_filename)
8729 free(pgstat_stat_filename);
8730 pgstat_stat_filename = fname;
8734 check_application_name(char **newval, void **extra, GucSource source)
8736 /* Only allow clean ASCII chars in the application name */
8739 for (p = *newval; *p; p++)
8741 if (*p < 32 || *p > 126)
8749 assign_application_name(const char *newval, void *extra)
8751 /* Update the pg_stat_activity view */
8752 pgstat_report_appname(newval);
8756 show_unix_socket_permissions(void)
8760 snprintf(buf, sizeof(buf), "%04o", Unix_socket_permissions);
8765 show_log_file_mode(void)
8769 snprintf(buf, sizeof(buf), "%04o", Log_file_mode);
8773 #include "guc-file.c"