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 {"wal_receiver_timeout", PGC_SIGHUP, REPLICATION_STANDBY,
1600 gettext_noop("Sets the maximum wait time to receive data from master."),
1604 &wal_receiver_timeout,
1605 60 * 1000, 0, INT_MAX,
1610 {"max_connections", PGC_POSTMASTER, CONN_AUTH_SETTINGS,
1611 gettext_noop("Sets the maximum number of concurrent connections."),
1615 100, 1, MAX_BACKENDS,
1616 check_maxconnections, assign_maxconnections, NULL
1620 {"superuser_reserved_connections", PGC_POSTMASTER, CONN_AUTH_SETTINGS,
1621 gettext_noop("Sets the number of connection slots reserved for superusers."),
1630 * We sometimes multiply the number of shared buffers by two without
1631 * checking for overflow, so we mustn't allow more than INT_MAX / 2.
1634 {"shared_buffers", PGC_POSTMASTER, RESOURCES_MEM,
1635 gettext_noop("Sets the number of shared memory buffers used by the server."),
1640 1024, 16, INT_MAX / 2,
1645 {"temp_buffers", PGC_USERSET, RESOURCES_MEM,
1646 gettext_noop("Sets the maximum number of temporary buffers used by each session."),
1651 1024, 100, INT_MAX / 2,
1652 check_temp_buffers, NULL, NULL
1656 {"port", PGC_POSTMASTER, CONN_AUTH_SETTINGS,
1657 gettext_noop("Sets the TCP port the server listens on."),
1661 DEF_PGPORT, 1, 65535,
1666 {"unix_socket_permissions", PGC_POSTMASTER, CONN_AUTH_SETTINGS,
1667 gettext_noop("Sets the access permissions of the Unix-domain socket."),
1668 gettext_noop("Unix-domain sockets use the usual Unix file system "
1669 "permission set. The parameter value is expected "
1670 "to be a numeric mode specification in the form "
1671 "accepted by the chmod and umask system calls. "
1672 "(To use the customary octal format the number must "
1673 "start with a 0 (zero).)")
1675 &Unix_socket_permissions,
1677 NULL, NULL, show_unix_socket_permissions
1681 {"log_file_mode", PGC_SIGHUP, LOGGING_WHERE,
1682 gettext_noop("Sets the file permissions for log files."),
1683 gettext_noop("The parameter value is expected "
1684 "to be a numeric mode specification in the form "
1685 "accepted by the chmod and umask system calls. "
1686 "(To use the customary octal format the number must "
1687 "start with a 0 (zero).)")
1691 NULL, NULL, show_log_file_mode
1695 {"work_mem", PGC_USERSET, RESOURCES_MEM,
1696 gettext_noop("Sets the maximum memory to be used for query workspaces."),
1697 gettext_noop("This much memory can be used by each internal "
1698 "sort operation and hash table before switching to "
1699 "temporary disk files."),
1703 1024, 64, MAX_KILOBYTES,
1708 {"maintenance_work_mem", PGC_USERSET, RESOURCES_MEM,
1709 gettext_noop("Sets the maximum memory to be used for maintenance operations."),
1710 gettext_noop("This includes operations such as VACUUM and CREATE INDEX."),
1713 &maintenance_work_mem,
1714 16384, 1024, MAX_KILOBYTES,
1719 * We use the hopefully-safely-small value of 100kB as the compiled-in
1720 * default for max_stack_depth. InitializeGUCOptions will increase it if
1721 * possible, depending on the actual platform-specific stack limit.
1724 {"max_stack_depth", PGC_SUSET, RESOURCES_MEM,
1725 gettext_noop("Sets the maximum stack depth, in kilobytes."),
1730 100, 100, MAX_KILOBYTES,
1731 check_max_stack_depth, assign_max_stack_depth, NULL
1735 {"temp_file_limit", PGC_SUSET, RESOURCES_DISK,
1736 gettext_noop("Limits the total size of all temporary files used by each session."),
1737 gettext_noop("-1 means no limit."),
1746 {"vacuum_cost_page_hit", PGC_USERSET, RESOURCES_VACUUM_DELAY,
1747 gettext_noop("Vacuum cost for a page found in the buffer cache."),
1756 {"vacuum_cost_page_miss", PGC_USERSET, RESOURCES_VACUUM_DELAY,
1757 gettext_noop("Vacuum cost for a page not found in the buffer cache."),
1760 &VacuumCostPageMiss,
1766 {"vacuum_cost_page_dirty", PGC_USERSET, RESOURCES_VACUUM_DELAY,
1767 gettext_noop("Vacuum cost for a page dirtied by vacuum."),
1770 &VacuumCostPageDirty,
1776 {"vacuum_cost_limit", PGC_USERSET, RESOURCES_VACUUM_DELAY,
1777 gettext_noop("Vacuum cost amount available before napping."),
1786 {"vacuum_cost_delay", PGC_USERSET, RESOURCES_VACUUM_DELAY,
1787 gettext_noop("Vacuum cost delay in milliseconds."),
1797 {"autovacuum_vacuum_cost_delay", PGC_SIGHUP, AUTOVACUUM,
1798 gettext_noop("Vacuum cost delay in milliseconds, for autovacuum."),
1802 &autovacuum_vac_cost_delay,
1808 {"autovacuum_vacuum_cost_limit", PGC_SIGHUP, AUTOVACUUM,
1809 gettext_noop("Vacuum cost amount available before napping, for autovacuum."),
1812 &autovacuum_vac_cost_limit,
1818 {"max_files_per_process", PGC_POSTMASTER, RESOURCES_KERNEL,
1819 gettext_noop("Sets the maximum number of simultaneously open files for each server process."),
1822 &max_files_per_process,
1828 * See also CheckRequiredParameterValues() if this parameter changes
1831 {"max_prepared_transactions", PGC_POSTMASTER, RESOURCES_MEM,
1832 gettext_noop("Sets the maximum number of simultaneously prepared transactions."),
1835 &max_prepared_xacts,
1842 {"trace_lock_oidmin", PGC_SUSET, DEVELOPER_OPTIONS,
1843 gettext_noop("No description available."),
1848 FirstNormalObjectId, 0, INT_MAX,
1852 {"trace_lock_table", PGC_SUSET, DEVELOPER_OPTIONS,
1853 gettext_noop("No description available."),
1864 {"statement_timeout", PGC_USERSET, CLIENT_CONN_STATEMENT,
1865 gettext_noop("Sets the maximum allowed duration of any statement."),
1866 gettext_noop("A value of 0 turns off the timeout."),
1875 {"vacuum_freeze_min_age", PGC_USERSET, CLIENT_CONN_STATEMENT,
1876 gettext_noop("Minimum age at which VACUUM should freeze a table row."),
1879 &vacuum_freeze_min_age,
1880 50000000, 0, 1000000000,
1885 {"vacuum_freeze_table_age", PGC_USERSET, CLIENT_CONN_STATEMENT,
1886 gettext_noop("Age at which VACUUM should scan whole table to freeze tuples."),
1889 &vacuum_freeze_table_age,
1890 150000000, 0, 2000000000,
1895 {"vacuum_defer_cleanup_age", PGC_SIGHUP, REPLICATION_MASTER,
1896 gettext_noop("Number of transactions by which VACUUM and HOT cleanup should be deferred, if any."),
1899 &vacuum_defer_cleanup_age,
1905 * See also CheckRequiredParameterValues() if this parameter changes
1908 {"max_locks_per_transaction", PGC_POSTMASTER, LOCK_MANAGEMENT,
1909 gettext_noop("Sets the maximum number of locks per transaction."),
1910 gettext_noop("The shared lock table is sized on the assumption that "
1911 "at most max_locks_per_transaction * max_connections distinct "
1912 "objects will need to be locked at any one time.")
1914 &max_locks_per_xact,
1920 {"max_pred_locks_per_transaction", PGC_POSTMASTER, LOCK_MANAGEMENT,
1921 gettext_noop("Sets the maximum number of predicate locks per transaction."),
1922 gettext_noop("The shared predicate lock table is sized on the assumption that "
1923 "at most max_pred_locks_per_transaction * max_connections distinct "
1924 "objects will need to be locked at any one time.")
1926 &max_predicate_locks_per_xact,
1932 {"authentication_timeout", PGC_SIGHUP, CONN_AUTH_SECURITY,
1933 gettext_noop("Sets the maximum allowed time to complete client authentication."),
1937 &AuthenticationTimeout,
1943 /* Not for general use */
1944 {"pre_auth_delay", PGC_SIGHUP, DEVELOPER_OPTIONS,
1945 gettext_noop("Waits N seconds on connection startup before authentication."),
1946 gettext_noop("This allows attaching a debugger to the process."),
1947 GUC_NOT_IN_SAMPLE | GUC_UNIT_S
1955 {"wal_keep_segments", PGC_SIGHUP, REPLICATION_SENDING,
1956 gettext_noop("Sets the number of WAL files held for standby servers."),
1965 {"checkpoint_segments", PGC_SIGHUP, WAL_CHECKPOINTS,
1966 gettext_noop("Sets the maximum distance in log segments between automatic WAL checkpoints."),
1969 &CheckPointSegments,
1975 {"checkpoint_timeout", PGC_SIGHUP, WAL_CHECKPOINTS,
1976 gettext_noop("Sets the maximum time between automatic WAL checkpoints."),
1986 {"checkpoint_warning", PGC_SIGHUP, WAL_CHECKPOINTS,
1987 gettext_noop("Enables warnings if checkpoint segments are filled more "
1988 "frequently than this."),
1989 gettext_noop("Write a message to the server log if checkpoints "
1990 "caused by the filling of checkpoint segment files happens more "
1991 "frequently than this number of seconds. Zero turns off the warning."),
2000 {"wal_buffers", PGC_POSTMASTER, WAL_SETTINGS,
2001 gettext_noop("Sets the number of disk-page buffers in shared memory for WAL."),
2007 check_wal_buffers, NULL, NULL
2011 {"wal_writer_delay", PGC_SIGHUP, WAL_SETTINGS,
2012 gettext_noop("WAL writer sleep time between WAL flushes."),
2022 /* see max_connections */
2023 {"max_wal_senders", PGC_POSTMASTER, REPLICATION_SENDING,
2024 gettext_noop("Sets the maximum number of simultaneously running WAL sender processes."),
2033 {"wal_sender_timeout", PGC_SIGHUP, REPLICATION_SENDING,
2034 gettext_noop("Sets the maximum time to wait for WAL replication."),
2038 &wal_sender_timeout,
2039 60 * 1000, 0, INT_MAX,
2044 {"commit_delay", PGC_USERSET, WAL_SETTINGS,
2045 gettext_noop("Sets the delay in microseconds between transaction commit and "
2046 "flushing WAL to disk."),
2048 /* we have no microseconds designation, so can't supply units here */
2056 {"commit_siblings", PGC_USERSET, WAL_SETTINGS,
2057 gettext_noop("Sets the minimum concurrent open transactions before performing "
2067 {"extra_float_digits", PGC_USERSET, CLIENT_CONN_LOCALE,
2068 gettext_noop("Sets the number of digits displayed for floating-point values."),
2069 gettext_noop("This affects real, double precision, and geometric data types. "
2070 "The parameter value is added to the standard number of digits "
2071 "(FLT_DIG or DBL_DIG as appropriate).")
2073 &extra_float_digits,
2079 {"log_min_duration_statement", PGC_SUSET, LOGGING_WHEN,
2080 gettext_noop("Sets the minimum execution time above which "
2081 "statements will be logged."),
2082 gettext_noop("Zero prints all queries. -1 turns this feature off."),
2085 &log_min_duration_statement,
2091 {"log_autovacuum_min_duration", PGC_SIGHUP, LOGGING_WHAT,
2092 gettext_noop("Sets the minimum execution time above which "
2093 "autovacuum actions will be logged."),
2094 gettext_noop("Zero prints all actions. -1 turns autovacuum logging off."),
2097 &Log_autovacuum_min_duration,
2103 {"bgwriter_delay", PGC_SIGHUP, RESOURCES_BGWRITER,
2104 gettext_noop("Background writer sleep time between rounds."),
2114 {"bgwriter_lru_maxpages", PGC_SIGHUP, RESOURCES_BGWRITER,
2115 gettext_noop("Background writer maximum number of LRU pages to flush per round."),
2118 &bgwriter_lru_maxpages,
2124 {"effective_io_concurrency",
2130 RESOURCES_ASYNCHRONOUS,
2131 gettext_noop("Number of simultaneous requests that can be handled efficiently by the disk subsystem."),
2132 gettext_noop("For RAID arrays, this should be approximately the number of drive spindles in the array.")
2134 &effective_io_concurrency,
2140 check_effective_io_concurrency, assign_effective_io_concurrency, NULL
2144 {"log_rotation_age", PGC_SIGHUP, LOGGING_WHERE,
2145 gettext_noop("Automatic log file rotation will occur after N minutes."),
2150 HOURS_PER_DAY * MINS_PER_HOUR, 0, INT_MAX / MINS_PER_HOUR,
2155 {"log_rotation_size", PGC_SIGHUP, LOGGING_WHERE,
2156 gettext_noop("Automatic log file rotation will occur after N kilobytes."),
2161 10 * 1024, 0, INT_MAX / 1024,
2166 {"max_function_args", PGC_INTERNAL, PRESET_OPTIONS,
2167 gettext_noop("Shows the maximum number of function arguments."),
2169 GUC_NOT_IN_SAMPLE | GUC_DISALLOW_IN_FILE
2172 FUNC_MAX_ARGS, FUNC_MAX_ARGS, FUNC_MAX_ARGS,
2177 {"max_index_keys", PGC_INTERNAL, PRESET_OPTIONS,
2178 gettext_noop("Shows the maximum number of index keys."),
2180 GUC_NOT_IN_SAMPLE | GUC_DISALLOW_IN_FILE
2183 INDEX_MAX_KEYS, INDEX_MAX_KEYS, INDEX_MAX_KEYS,
2188 {"max_identifier_length", PGC_INTERNAL, PRESET_OPTIONS,
2189 gettext_noop("Shows the maximum identifier length."),
2191 GUC_NOT_IN_SAMPLE | GUC_DISALLOW_IN_FILE
2193 &max_identifier_length,
2194 NAMEDATALEN - 1, NAMEDATALEN - 1, NAMEDATALEN - 1,
2199 {"block_size", PGC_INTERNAL, PRESET_OPTIONS,
2200 gettext_noop("Shows the size of a disk block."),
2202 GUC_NOT_IN_SAMPLE | GUC_DISALLOW_IN_FILE
2205 BLCKSZ, BLCKSZ, BLCKSZ,
2210 {"segment_size", PGC_INTERNAL, PRESET_OPTIONS,
2211 gettext_noop("Shows the number of pages per disk file."),
2213 GUC_UNIT_BLOCKS | GUC_NOT_IN_SAMPLE | GUC_DISALLOW_IN_FILE
2216 RELSEG_SIZE, RELSEG_SIZE, RELSEG_SIZE,
2221 {"wal_block_size", PGC_INTERNAL, PRESET_OPTIONS,
2222 gettext_noop("Shows the block size in the write ahead log."),
2224 GUC_NOT_IN_SAMPLE | GUC_DISALLOW_IN_FILE
2227 XLOG_BLCKSZ, XLOG_BLCKSZ, XLOG_BLCKSZ,
2232 {"wal_segment_size", PGC_INTERNAL, PRESET_OPTIONS,
2233 gettext_noop("Shows the number of pages per write ahead log segment."),
2235 GUC_UNIT_XBLOCKS | GUC_NOT_IN_SAMPLE | GUC_DISALLOW_IN_FILE
2238 (XLOG_SEG_SIZE / XLOG_BLCKSZ),
2239 (XLOG_SEG_SIZE / XLOG_BLCKSZ),
2240 (XLOG_SEG_SIZE / XLOG_BLCKSZ),
2245 {"autovacuum_naptime", PGC_SIGHUP, AUTOVACUUM,
2246 gettext_noop("Time to sleep between autovacuum runs."),
2250 &autovacuum_naptime,
2251 60, 1, INT_MAX / 1000,
2255 {"autovacuum_vacuum_threshold", PGC_SIGHUP, AUTOVACUUM,
2256 gettext_noop("Minimum number of tuple updates or deletes prior to vacuum."),
2259 &autovacuum_vac_thresh,
2264 {"autovacuum_analyze_threshold", PGC_SIGHUP, AUTOVACUUM,
2265 gettext_noop("Minimum number of tuple inserts, updates, or deletes prior to analyze."),
2268 &autovacuum_anl_thresh,
2273 /* see varsup.c for why this is PGC_POSTMASTER not PGC_SIGHUP */
2274 {"autovacuum_freeze_max_age", PGC_POSTMASTER, AUTOVACUUM,
2275 gettext_noop("Age at which to autovacuum a table to prevent transaction ID wraparound."),
2278 &autovacuum_freeze_max_age,
2279 /* see pg_resetxlog if you change the upper-limit value */
2280 200000000, 100000000, 2000000000,
2284 /* see max_connections */
2285 {"autovacuum_max_workers", PGC_POSTMASTER, AUTOVACUUM,
2286 gettext_noop("Sets the maximum number of simultaneously running autovacuum worker processes."),
2289 &autovacuum_max_workers,
2291 check_autovacuum_max_workers, assign_autovacuum_max_workers, NULL
2295 {"tcp_keepalives_idle", PGC_USERSET, CLIENT_CONN_OTHER,
2296 gettext_noop("Time between issuing TCP keepalives."),
2297 gettext_noop("A value of 0 uses the system default."),
2300 &tcp_keepalives_idle,
2302 NULL, assign_tcp_keepalives_idle, show_tcp_keepalives_idle
2306 {"tcp_keepalives_interval", PGC_USERSET, CLIENT_CONN_OTHER,
2307 gettext_noop("Time between TCP keepalive retransmits."),
2308 gettext_noop("A value of 0 uses the system default."),
2311 &tcp_keepalives_interval,
2313 NULL, assign_tcp_keepalives_interval, show_tcp_keepalives_interval
2317 {"ssl_renegotiation_limit", PGC_USERSET, CONN_AUTH_SECURITY,
2318 gettext_noop("Set the amount of traffic to send and receive before renegotiating the encryption keys."),
2322 &ssl_renegotiation_limit,
2323 512 * 1024, 0, MAX_KILOBYTES,
2328 {"tcp_keepalives_count", PGC_USERSET, CLIENT_CONN_OTHER,
2329 gettext_noop("Maximum number of TCP keepalive retransmits."),
2330 gettext_noop("This controls the number of consecutive keepalive retransmits that can be "
2331 "lost before a connection is considered dead. A value of 0 uses the "
2334 &tcp_keepalives_count,
2336 NULL, assign_tcp_keepalives_count, show_tcp_keepalives_count
2340 {"gin_fuzzy_search_limit", PGC_USERSET, CLIENT_CONN_OTHER,
2341 gettext_noop("Sets the maximum allowed result for exact search by GIN."),
2345 &GinFuzzySearchLimit,
2351 {"effective_cache_size", PGC_USERSET, QUERY_TUNING_COST,
2352 gettext_noop("Sets the planner's assumption about the size of the disk cache."),
2353 gettext_noop("That is, the portion of the kernel's disk cache that "
2354 "will be used for PostgreSQL data files. This is measured in disk "
2355 "pages, which are normally 8 kB each."),
2358 &effective_cache_size,
2359 DEFAULT_EFFECTIVE_CACHE_SIZE, 1, INT_MAX,
2364 /* Can't be set in postgresql.conf */
2365 {"server_version_num", PGC_INTERNAL, PRESET_OPTIONS,
2366 gettext_noop("Shows the server version as an integer."),
2368 GUC_NOT_IN_SAMPLE | GUC_DISALLOW_IN_FILE
2370 &server_version_num,
2371 PG_VERSION_NUM, PG_VERSION_NUM, PG_VERSION_NUM,
2376 {"log_temp_files", PGC_SUSET, LOGGING_WHAT,
2377 gettext_noop("Log the use of temporary files larger than this number of kilobytes."),
2378 gettext_noop("Zero logs all files. The default is -1 (turning this feature off)."),
2387 {"track_activity_query_size", PGC_POSTMASTER, RESOURCES_MEM,
2388 gettext_noop("Sets the size reserved for pg_stat_activity.query, in bytes."),
2391 &pgstat_track_activity_query_size,
2396 /* End-of-list marker */
2398 {NULL, 0, 0, NULL, NULL}, NULL, 0, 0, 0, NULL, NULL, NULL
2403 static struct config_real ConfigureNamesReal[] =
2406 {"seq_page_cost", PGC_USERSET, QUERY_TUNING_COST,
2407 gettext_noop("Sets the planner's estimate of the cost of a "
2408 "sequentially fetched disk page."),
2412 DEFAULT_SEQ_PAGE_COST, 0, DBL_MAX,
2416 {"random_page_cost", PGC_USERSET, QUERY_TUNING_COST,
2417 gettext_noop("Sets the planner's estimate of the cost of a "
2418 "nonsequentially fetched disk page."),
2422 DEFAULT_RANDOM_PAGE_COST, 0, DBL_MAX,
2426 {"cpu_tuple_cost", PGC_USERSET, QUERY_TUNING_COST,
2427 gettext_noop("Sets the planner's estimate of the cost of "
2428 "processing each tuple (row)."),
2432 DEFAULT_CPU_TUPLE_COST, 0, DBL_MAX,
2436 {"cpu_index_tuple_cost", PGC_USERSET, QUERY_TUNING_COST,
2437 gettext_noop("Sets the planner's estimate of the cost of "
2438 "processing each index entry during an index scan."),
2441 &cpu_index_tuple_cost,
2442 DEFAULT_CPU_INDEX_TUPLE_COST, 0, DBL_MAX,
2446 {"cpu_operator_cost", PGC_USERSET, QUERY_TUNING_COST,
2447 gettext_noop("Sets the planner's estimate of the cost of "
2448 "processing each operator or function call."),
2452 DEFAULT_CPU_OPERATOR_COST, 0, DBL_MAX,
2457 {"cursor_tuple_fraction", PGC_USERSET, QUERY_TUNING_OTHER,
2458 gettext_noop("Sets the planner's estimate of the fraction of "
2459 "a cursor's rows that will be retrieved."),
2462 &cursor_tuple_fraction,
2463 DEFAULT_CURSOR_TUPLE_FRACTION, 0.0, 1.0,
2468 {"geqo_selection_bias", PGC_USERSET, QUERY_TUNING_GEQO,
2469 gettext_noop("GEQO: selective pressure within the population."),
2472 &Geqo_selection_bias,
2473 DEFAULT_GEQO_SELECTION_BIAS,
2474 MIN_GEQO_SELECTION_BIAS, MAX_GEQO_SELECTION_BIAS,
2478 {"geqo_seed", PGC_USERSET, QUERY_TUNING_GEQO,
2479 gettext_noop("GEQO: seed for random path selection."),
2488 {"bgwriter_lru_multiplier", PGC_SIGHUP, RESOURCES_BGWRITER,
2489 gettext_noop("Multiple of the average buffer usage to free per round."),
2492 &bgwriter_lru_multiplier,
2498 {"seed", PGC_USERSET, UNGROUPED,
2499 gettext_noop("Sets the seed for random-number generation."),
2501 GUC_NO_SHOW_ALL | GUC_NO_RESET_ALL | GUC_NOT_IN_SAMPLE | GUC_DISALLOW_IN_FILE
2505 check_random_seed, assign_random_seed, show_random_seed
2509 {"autovacuum_vacuum_scale_factor", PGC_SIGHUP, AUTOVACUUM,
2510 gettext_noop("Number of tuple updates or deletes prior to vacuum as a fraction of reltuples."),
2513 &autovacuum_vac_scale,
2518 {"autovacuum_analyze_scale_factor", PGC_SIGHUP, AUTOVACUUM,
2519 gettext_noop("Number of tuple inserts, updates, or deletes prior to analyze as a fraction of reltuples."),
2522 &autovacuum_anl_scale,
2528 {"checkpoint_completion_target", PGC_SIGHUP, WAL_CHECKPOINTS,
2529 gettext_noop("Time spent flushing dirty buffers during checkpoint, as fraction of checkpoint interval."),
2532 &CheckPointCompletionTarget,
2537 /* End-of-list marker */
2539 {NULL, 0, 0, NULL, NULL}, NULL, 0.0, 0.0, 0.0, NULL, NULL, NULL
2544 static struct config_string ConfigureNamesString[] =
2547 {"archive_command", PGC_SIGHUP, WAL_ARCHIVING,
2548 gettext_noop("Sets the shell command that will be called to archive a WAL file."),
2551 &XLogArchiveCommand,
2553 NULL, NULL, show_archive_command
2557 {"client_encoding", PGC_USERSET, CLIENT_CONN_LOCALE,
2558 gettext_noop("Sets the client's character set encoding."),
2560 GUC_IS_NAME | GUC_REPORT
2562 &client_encoding_string,
2564 check_client_encoding, assign_client_encoding, NULL
2568 {"log_line_prefix", PGC_SIGHUP, LOGGING_WHAT,
2569 gettext_noop("Controls information prefixed to each log line."),
2570 gettext_noop("If blank, no prefix is used.")
2578 {"log_timezone", PGC_SIGHUP, LOGGING_WHAT,
2579 gettext_noop("Sets the time zone to use in log messages."),
2582 &log_timezone_string,
2584 check_log_timezone, assign_log_timezone, show_log_timezone
2588 {"DateStyle", PGC_USERSET, CLIENT_CONN_LOCALE,
2589 gettext_noop("Sets the display format for date and time values."),
2590 gettext_noop("Also controls interpretation of ambiguous "
2592 GUC_LIST_INPUT | GUC_REPORT
2596 check_datestyle, assign_datestyle, NULL
2600 {"default_tablespace", PGC_USERSET, CLIENT_CONN_STATEMENT,
2601 gettext_noop("Sets the default tablespace to create tables and indexes in."),
2602 gettext_noop("An empty string selects the database's default tablespace."),
2605 &default_tablespace,
2607 check_default_tablespace, NULL, NULL
2611 {"temp_tablespaces", PGC_USERSET, CLIENT_CONN_STATEMENT,
2612 gettext_noop("Sets the tablespace(s) to use for temporary tables and sort files."),
2614 GUC_LIST_INPUT | GUC_LIST_QUOTE
2618 check_temp_tablespaces, assign_temp_tablespaces, NULL
2622 {"dynamic_library_path", PGC_SUSET, CLIENT_CONN_OTHER,
2623 gettext_noop("Sets the path for dynamically loadable modules."),
2624 gettext_noop("If a dynamically loadable module needs to be opened and "
2625 "the specified name does not have a directory component (i.e., the "
2626 "name does not contain a slash), the system will search this path for "
2627 "the specified file."),
2630 &Dynamic_library_path,
2636 {"krb_server_keyfile", PGC_SIGHUP, CONN_AUTH_SECURITY,
2637 gettext_noop("Sets the location of the Kerberos server key file."),
2641 &pg_krb_server_keyfile,
2647 {"krb_srvname", PGC_SIGHUP, CONN_AUTH_SECURITY,
2648 gettext_noop("Sets the name of the Kerberos service."),
2657 {"bonjour_name", PGC_POSTMASTER, CONN_AUTH_SETTINGS,
2658 gettext_noop("Sets the Bonjour service name."),
2666 /* See main.c about why defaults for LC_foo are not all alike */
2669 {"lc_collate", PGC_INTERNAL, CLIENT_CONN_LOCALE,
2670 gettext_noop("Shows the collation order locale."),
2672 GUC_NOT_IN_SAMPLE | GUC_DISALLOW_IN_FILE
2680 {"lc_ctype", PGC_INTERNAL, CLIENT_CONN_LOCALE,
2681 gettext_noop("Shows the character classification and case conversion locale."),
2683 GUC_NOT_IN_SAMPLE | GUC_DISALLOW_IN_FILE
2691 {"lc_messages", PGC_SUSET, CLIENT_CONN_LOCALE,
2692 gettext_noop("Sets the language in which messages are displayed."),
2697 check_locale_messages, assign_locale_messages, NULL
2701 {"lc_monetary", PGC_USERSET, CLIENT_CONN_LOCALE,
2702 gettext_noop("Sets the locale for formatting monetary amounts."),
2707 check_locale_monetary, assign_locale_monetary, NULL
2711 {"lc_numeric", PGC_USERSET, CLIENT_CONN_LOCALE,
2712 gettext_noop("Sets the locale for formatting numbers."),
2717 check_locale_numeric, assign_locale_numeric, NULL
2721 {"lc_time", PGC_USERSET, CLIENT_CONN_LOCALE,
2722 gettext_noop("Sets the locale for formatting date and time values."),
2727 check_locale_time, assign_locale_time, NULL
2731 {"shared_preload_libraries", PGC_POSTMASTER, RESOURCES_KERNEL,
2732 gettext_noop("Lists shared libraries to preload into server."),
2734 GUC_LIST_INPUT | GUC_LIST_QUOTE | GUC_SUPERUSER_ONLY
2736 &shared_preload_libraries_string,
2742 {"local_preload_libraries", PGC_BACKEND, CLIENT_CONN_OTHER,
2743 gettext_noop("Lists shared libraries to preload into each backend."),
2745 GUC_LIST_INPUT | GUC_LIST_QUOTE
2747 &local_preload_libraries_string,
2753 {"search_path", PGC_USERSET, CLIENT_CONN_STATEMENT,
2754 gettext_noop("Sets the schema search order for names that are not schema-qualified."),
2756 GUC_LIST_INPUT | GUC_LIST_QUOTE
2758 &namespace_search_path,
2760 check_search_path, assign_search_path, NULL
2764 /* Can't be set in postgresql.conf */
2765 {"server_encoding", PGC_INTERNAL, CLIENT_CONN_LOCALE,
2766 gettext_noop("Sets the server (database) character set encoding."),
2768 GUC_IS_NAME | GUC_REPORT | GUC_NOT_IN_SAMPLE | GUC_DISALLOW_IN_FILE
2770 &server_encoding_string,
2776 /* Can't be set in postgresql.conf */
2777 {"server_version", PGC_INTERNAL, PRESET_OPTIONS,
2778 gettext_noop("Shows the server version."),
2780 GUC_REPORT | GUC_NOT_IN_SAMPLE | GUC_DISALLOW_IN_FILE
2782 &server_version_string,
2788 /* Not for general use --- used by SET ROLE */
2789 {"role", PGC_USERSET, UNGROUPED,
2790 gettext_noop("Sets the current role."),
2792 GUC_IS_NAME | GUC_NO_SHOW_ALL | GUC_NO_RESET_ALL | GUC_NOT_IN_SAMPLE | GUC_DISALLOW_IN_FILE | GUC_NOT_WHILE_SEC_REST
2796 check_role, assign_role, show_role
2800 /* Not for general use --- used by SET SESSION AUTHORIZATION */
2801 {"session_authorization", PGC_USERSET, UNGROUPED,
2802 gettext_noop("Sets the session user name."),
2804 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
2806 &session_authorization_string,
2808 check_session_authorization, assign_session_authorization, NULL
2812 {"log_destination", PGC_SIGHUP, LOGGING_WHERE,
2813 gettext_noop("Sets the destination for server log output."),
2814 gettext_noop("Valid values are combinations of \"stderr\", "
2815 "\"syslog\", \"csvlog\", and \"eventlog\", "
2816 "depending on the platform."),
2819 &log_destination_string,
2821 check_log_destination, assign_log_destination, NULL
2824 {"log_directory", PGC_SIGHUP, LOGGING_WHERE,
2825 gettext_noop("Sets the destination directory for log files."),
2826 gettext_noop("Can be specified as relative to the data directory "
2827 "or as absolute path."),
2832 check_canonical_path, NULL, NULL
2835 {"log_filename", PGC_SIGHUP, LOGGING_WHERE,
2836 gettext_noop("Sets the file name pattern for log files."),
2841 "postgresql-%Y-%m-%d_%H%M%S.log",
2846 {"syslog_ident", PGC_SIGHUP, LOGGING_WHERE,
2847 gettext_noop("Sets the program name used to identify PostgreSQL "
2848 "messages in syslog."),
2853 NULL, assign_syslog_ident, NULL
2857 {"event_source", PGC_POSTMASTER, LOGGING_WHERE,
2858 gettext_noop("Sets the application name used to identify "
2859 "PostgreSQL messages in the event log."),
2868 {"TimeZone", PGC_USERSET, CLIENT_CONN_LOCALE,
2869 gettext_noop("Sets the time zone for displaying and interpreting time stamps."),
2875 check_timezone, assign_timezone, show_timezone
2878 {"timezone_abbreviations", PGC_USERSET, CLIENT_CONN_LOCALE,
2879 gettext_noop("Selects a file of time zone abbreviations."),
2882 &timezone_abbreviations_string,
2884 check_timezone_abbreviations, assign_timezone_abbreviations, NULL
2888 {"transaction_isolation", PGC_USERSET, CLIENT_CONN_STATEMENT,
2889 gettext_noop("Sets the current transaction's isolation level."),
2891 GUC_NO_RESET_ALL | GUC_NOT_IN_SAMPLE | GUC_DISALLOW_IN_FILE
2893 &XactIsoLevel_string,
2895 check_XactIsoLevel, assign_XactIsoLevel, show_XactIsoLevel
2899 {"unix_socket_group", PGC_POSTMASTER, CONN_AUTH_SETTINGS,
2900 gettext_noop("Sets the owning group of the Unix-domain socket."),
2901 gettext_noop("The owning user of the socket is always the user "
2902 "that starts the server.")
2910 {"unix_socket_directories", PGC_POSTMASTER, CONN_AUTH_SETTINGS,
2911 gettext_noop("Sets the directories where Unix-domain sockets will be created."),
2915 &Unix_socket_directories,
2916 #ifdef HAVE_UNIX_SOCKETS
2917 DEFAULT_PGSOCKET_DIR,
2925 {"listen_addresses", PGC_POSTMASTER, CONN_AUTH_SETTINGS,
2926 gettext_noop("Sets the host name or IP address(es) to listen to."),
2936 {"data_directory", PGC_POSTMASTER, FILE_LOCATIONS,
2937 gettext_noop("Sets the server's data directory."),
2947 {"config_file", PGC_POSTMASTER, FILE_LOCATIONS,
2948 gettext_noop("Sets the server's main configuration file."),
2950 GUC_DISALLOW_IN_FILE | GUC_SUPERUSER_ONLY
2958 {"hba_file", PGC_POSTMASTER, FILE_LOCATIONS,
2959 gettext_noop("Sets the server's \"hba\" configuration file."),
2969 {"ident_file", PGC_POSTMASTER, FILE_LOCATIONS,
2970 gettext_noop("Sets the server's \"ident\" configuration file."),
2980 {"external_pid_file", PGC_POSTMASTER, FILE_LOCATIONS,
2981 gettext_noop("Writes the postmaster PID to the specified file."),
2987 check_canonical_path, NULL, NULL
2991 {"ssl_cert_file", PGC_POSTMASTER, CONN_AUTH_SECURITY,
2992 gettext_noop("Location of the SSL server certificate file."),
3001 {"ssl_key_file", PGC_POSTMASTER, CONN_AUTH_SECURITY,
3002 gettext_noop("Location of the SSL server private key file."),
3011 {"ssl_ca_file", PGC_POSTMASTER, CONN_AUTH_SECURITY,
3012 gettext_noop("Location of the SSL certificate authority file."),
3021 {"ssl_crl_file", PGC_POSTMASTER, CONN_AUTH_SECURITY,
3022 gettext_noop("Location of the SSL certificate revocation list file."),
3031 {"stats_temp_directory", PGC_SIGHUP, STATS_COLLECTOR,
3032 gettext_noop("Writes temporary statistics files to the specified directory."),
3036 &pgstat_temp_directory,
3038 check_canonical_path, assign_pgstat_temp_directory, NULL
3042 {"synchronous_standby_names", PGC_SIGHUP, REPLICATION_MASTER,
3043 gettext_noop("List of names of potential synchronous standbys."),
3047 &SyncRepStandbyNames,
3049 check_synchronous_standby_names, NULL, NULL
3053 {"default_text_search_config", PGC_USERSET, CLIENT_CONN_LOCALE,
3054 gettext_noop("Sets default text search configuration."),
3058 "pg_catalog.simple",
3059 check_TSCurrentConfig, assign_TSCurrentConfig, NULL
3063 {"ssl_ciphers", PGC_POSTMASTER, CONN_AUTH_SECURITY,
3064 gettext_noop("Sets the list of allowed SSL ciphers."),
3070 "ALL:!ADH:!LOW:!EXP:!MD5:@STRENGTH",
3078 {"application_name", PGC_USERSET, LOGGING_WHAT,
3079 gettext_noop("Sets the application name to be reported in statistics and logs."),
3081 GUC_IS_NAME | GUC_REPORT | GUC_NOT_IN_SAMPLE
3085 check_application_name, assign_application_name, NULL
3088 /* End-of-list marker */
3090 {NULL, 0, 0, NULL, NULL}, NULL, NULL, NULL, NULL, NULL
3095 static struct config_enum ConfigureNamesEnum[] =
3098 {"backslash_quote", PGC_USERSET, COMPAT_OPTIONS_PREVIOUS,
3099 gettext_noop("Sets whether \"\\'\" is allowed in string literals."),
3103 BACKSLASH_QUOTE_SAFE_ENCODING, backslash_quote_options,
3108 {"bytea_output", PGC_USERSET, CLIENT_CONN_STATEMENT,
3109 gettext_noop("Sets the output format for bytea."),
3113 BYTEA_OUTPUT_HEX, bytea_output_options,
3118 {"client_min_messages", PGC_USERSET, LOGGING_WHEN,
3119 gettext_noop("Sets the message levels that are sent to the client."),
3120 gettext_noop("Each level includes all the levels that follow it. The later"
3121 " the level, the fewer messages are sent.")
3123 &client_min_messages,
3124 NOTICE, client_message_level_options,
3129 {"constraint_exclusion", PGC_USERSET, QUERY_TUNING_OTHER,
3130 gettext_noop("Enables the planner to use constraints to optimize queries."),
3131 gettext_noop("Table scans will be skipped if their constraints"
3132 " guarantee that no rows match the query.")
3134 &constraint_exclusion,
3135 CONSTRAINT_EXCLUSION_PARTITION, constraint_exclusion_options,
3140 {"default_transaction_isolation", PGC_USERSET, CLIENT_CONN_STATEMENT,
3141 gettext_noop("Sets the transaction isolation level of each new transaction."),
3144 &DefaultXactIsoLevel,
3145 XACT_READ_COMMITTED, isolation_level_options,
3150 {"IntervalStyle", PGC_USERSET, CLIENT_CONN_LOCALE,
3151 gettext_noop("Sets the display format for interval values."),
3156 INTSTYLE_POSTGRES, intervalstyle_options,
3161 {"log_error_verbosity", PGC_SUSET, LOGGING_WHAT,
3162 gettext_noop("Sets the verbosity of logged messages."),
3165 &Log_error_verbosity,
3166 PGERROR_DEFAULT, log_error_verbosity_options,
3171 {"log_min_messages", PGC_SUSET, LOGGING_WHEN,
3172 gettext_noop("Sets the message levels that are logged."),
3173 gettext_noop("Each level includes all the levels that follow it. The later"
3174 " the level, the fewer messages are sent.")
3177 WARNING, server_message_level_options,
3182 {"log_min_error_statement", PGC_SUSET, LOGGING_WHEN,
3183 gettext_noop("Causes all statements generating error at or above this level to be logged."),
3184 gettext_noop("Each level includes all the levels that follow it. The later"
3185 " the level, the fewer messages are sent.")
3187 &log_min_error_statement,
3188 ERROR, server_message_level_options,
3193 {"log_statement", PGC_SUSET, LOGGING_WHAT,
3194 gettext_noop("Sets the type of statements logged."),
3198 LOGSTMT_NONE, log_statement_options,
3203 {"syslog_facility", PGC_SIGHUP, LOGGING_WHERE,
3204 gettext_noop("Sets the syslog \"facility\" to be used when syslog enabled."),
3213 syslog_facility_options,
3214 NULL, assign_syslog_facility, NULL
3218 {"session_replication_role", PGC_SUSET, CLIENT_CONN_STATEMENT,
3219 gettext_noop("Sets the session's behavior for triggers and rewrite rules."),
3222 &SessionReplicationRole,
3223 SESSION_REPLICATION_ROLE_ORIGIN, session_replication_role_options,
3224 NULL, assign_session_replication_role, NULL
3228 {"synchronous_commit", PGC_USERSET, WAL_SETTINGS,
3229 gettext_noop("Sets the current transaction's synchronization level."),
3232 &synchronous_commit,
3233 SYNCHRONOUS_COMMIT_ON, synchronous_commit_options,
3234 NULL, assign_synchronous_commit, NULL
3238 {"trace_recovery_messages", PGC_SIGHUP, DEVELOPER_OPTIONS,
3239 gettext_noop("Enables logging of recovery-related debugging information."),
3240 gettext_noop("Each level includes all the levels that follow it. The later"
3241 " the level, the fewer messages are sent.")
3243 &trace_recovery_messages,
3246 * client_message_level_options allows too many values, really, but
3247 * it's not worth having a separate options array for this.
3249 LOG, client_message_level_options,
3254 {"track_functions", PGC_SUSET, STATS_COLLECTOR,
3255 gettext_noop("Collects function-level statistics on database activity."),
3258 &pgstat_track_functions,
3259 TRACK_FUNC_OFF, track_function_options,
3264 {"wal_level", PGC_POSTMASTER, WAL_SETTINGS,
3265 gettext_noop("Set the level of information written to the WAL."),
3269 WAL_LEVEL_MINIMAL, wal_level_options,
3274 {"wal_sync_method", PGC_SIGHUP, WAL_SETTINGS,
3275 gettext_noop("Selects the method used for forcing WAL updates to disk."),
3279 DEFAULT_SYNC_METHOD, sync_method_options,
3280 NULL, assign_xlog_sync_method, NULL
3284 {"xmlbinary", PGC_USERSET, CLIENT_CONN_STATEMENT,
3285 gettext_noop("Sets how binary values are to be encoded in XML."),
3289 XMLBINARY_BASE64, xmlbinary_options,
3294 {"xmloption", PGC_USERSET, CLIENT_CONN_STATEMENT,
3295 gettext_noop("Sets whether XML data in implicit parsing and serialization "
3296 "operations is to be considered as documents or content fragments."),
3300 XMLOPTION_CONTENT, xmloption_options,
3305 /* End-of-list marker */
3307 {NULL, 0, 0, NULL, NULL}, NULL, 0, NULL, NULL, NULL, NULL
3311 /******** end of options list ********/
3315 * To allow continued support of obsolete names for GUC variables, we apply
3316 * the following mappings to any unrecognized name. Note that an old name
3317 * should be mapped to a new one only if the new variable has very similar
3318 * semantics to the old.
3320 static const char *const map_old_guc_names[] = {
3321 "sort_mem", "work_mem",
3322 "vacuum_mem", "maintenance_work_mem",
3328 * Actual lookup of variables is done through this single, sorted array.
3330 static struct config_generic **guc_variables;
3332 /* Current number of variables contained in the vector */
3333 static int num_guc_variables;
3335 /* Vector capacity */
3336 static int size_guc_variables;
3339 static bool guc_dirty; /* TRUE if need to do commit/abort work */
3341 static bool reporting_enabled; /* TRUE to enable GUC_REPORT */
3343 static int GUCNestLevel = 0; /* 1 when in main transaction */
3346 static int guc_var_compare(const void *a, const void *b);
3347 static int guc_name_compare(const char *namea, const char *nameb);
3348 static void InitializeGUCOptionsFromEnvironment(void);
3349 static void InitializeOneGUCOption(struct config_generic * gconf);
3350 static void push_old_value(struct config_generic * gconf, GucAction action);
3351 static void ReportGUCOption(struct config_generic * record);
3352 static void reapply_stacked_values(struct config_generic * variable,
3353 struct config_string * pHolder,
3355 const char *curvalue,
3356 GucContext curscontext, GucSource cursource);
3357 static void ShowGUCConfigOption(const char *name, DestReceiver *dest);
3358 static void ShowAllGUCConfig(DestReceiver *dest);
3359 static char *_ShowOption(struct config_generic * record, bool use_units);
3360 static bool validate_option_array_item(const char *name, const char *value,
3361 bool skipIfNoPermissions);
3365 * Some infrastructure for checking malloc/strdup/realloc calls
3368 guc_malloc(int elevel, size_t size)
3372 /* Avoid unportable behavior of malloc(0) */
3375 data = malloc(size);
3378 (errcode(ERRCODE_OUT_OF_MEMORY),
3379 errmsg("out of memory")));
3384 guc_realloc(int elevel, void *old, size_t size)
3388 /* Avoid unportable behavior of realloc(NULL, 0) */
3389 if (old == NULL && size == 0)
3391 data = realloc(old, size);
3394 (errcode(ERRCODE_OUT_OF_MEMORY),
3395 errmsg("out of memory")));
3400 guc_strdup(int elevel, const char *src)
3407 (errcode(ERRCODE_OUT_OF_MEMORY),
3408 errmsg("out of memory")));
3414 * Detect whether strval is referenced anywhere in a GUC string item
3417 string_field_used(struct config_string * conf, char *strval)
3421 if (strval == *(conf->variable) ||
3422 strval == conf->reset_val ||
3423 strval == conf->boot_val)
3425 for (stack = conf->gen.stack; stack; stack = stack->prev)
3427 if (strval == stack->prior.val.stringval ||
3428 strval == stack->masked.val.stringval)
3435 * Support for assigning to a field of a string GUC item. Free the prior
3436 * value if it's not referenced anywhere else in the item (including stacked
3440 set_string_field(struct config_string * conf, char **field, char *newval)
3442 char *oldval = *field;
3444 /* Do the assignment */
3447 /* Free old value if it's not NULL and isn't referenced anymore */
3448 if (oldval && !string_field_used(conf, oldval))
3453 * Detect whether an "extra" struct is referenced anywhere in a GUC item
3456 extra_field_used(struct config_generic * gconf, void *extra)
3460 if (extra == gconf->extra)
3462 switch (gconf->vartype)
3465 if (extra == ((struct config_bool *) gconf)->reset_extra)
3469 if (extra == ((struct config_int *) gconf)->reset_extra)
3473 if (extra == ((struct config_real *) gconf)->reset_extra)
3477 if (extra == ((struct config_string *) gconf)->reset_extra)
3481 if (extra == ((struct config_enum *) gconf)->reset_extra)
3485 for (stack = gconf->stack; stack; stack = stack->prev)
3487 if (extra == stack->prior.extra ||
3488 extra == stack->masked.extra)
3496 * Support for assigning to an "extra" field of a GUC item. Free the prior
3497 * value if it's not referenced anywhere else in the item (including stacked
3501 set_extra_field(struct config_generic * gconf, void **field, void *newval)
3503 void *oldval = *field;
3505 /* Do the assignment */
3508 /* Free old value if it's not NULL and isn't referenced anymore */
3509 if (oldval && !extra_field_used(gconf, oldval))
3514 * Support for copying a variable's active value into a stack entry.
3515 * The "extra" field associated with the active value is copied, too.
3517 * NB: be sure stringval and extra fields of a new stack entry are
3518 * initialized to NULL before this is used, else we'll try to free() them.
3521 set_stack_value(struct config_generic * gconf, config_var_value *val)
3523 switch (gconf->vartype)
3527 *((struct config_bool *) gconf)->variable;
3531 *((struct config_int *) gconf)->variable;
3535 *((struct config_real *) gconf)->variable;
3538 set_string_field((struct config_string *) gconf,
3539 &(val->val.stringval),
3540 *((struct config_string *) gconf)->variable);
3544 *((struct config_enum *) gconf)->variable;
3547 set_extra_field(gconf, &(val->extra), gconf->extra);
3551 * Support for discarding a no-longer-needed value in a stack entry.
3552 * The "extra" field associated with the stack entry is cleared, too.
3555 discard_stack_value(struct config_generic * gconf, config_var_value *val)
3557 switch (gconf->vartype)
3563 /* no need to do anything */
3566 set_string_field((struct config_string *) gconf,
3567 &(val->val.stringval),
3571 set_extra_field(gconf, &(val->extra), NULL);
3576 * Fetch the sorted array pointer (exported for help_config.c's use ONLY)
3578 struct config_generic **
3579 get_guc_variables(void)
3581 return guc_variables;
3586 * Build the sorted array. This is split out so that it could be
3587 * re-executed after startup (eg, we could allow loadable modules to
3588 * add vars, and then we'd need to re-sort).
3591 build_guc_variables(void)
3595 struct config_generic **guc_vars;
3598 for (i = 0; ConfigureNamesBool[i].gen.name; i++)
3600 struct config_bool *conf = &ConfigureNamesBool[i];
3602 /* Rather than requiring vartype to be filled in by hand, do this: */
3603 conf->gen.vartype = PGC_BOOL;
3607 for (i = 0; ConfigureNamesInt[i].gen.name; i++)
3609 struct config_int *conf = &ConfigureNamesInt[i];
3611 conf->gen.vartype = PGC_INT;
3615 for (i = 0; ConfigureNamesReal[i].gen.name; i++)
3617 struct config_real *conf = &ConfigureNamesReal[i];
3619 conf->gen.vartype = PGC_REAL;
3623 for (i = 0; ConfigureNamesString[i].gen.name; i++)
3625 struct config_string *conf = &ConfigureNamesString[i];
3627 conf->gen.vartype = PGC_STRING;
3631 for (i = 0; ConfigureNamesEnum[i].gen.name; i++)
3633 struct config_enum *conf = &ConfigureNamesEnum[i];
3635 conf->gen.vartype = PGC_ENUM;
3640 * Create table with 20% slack
3642 size_vars = num_vars + num_vars / 4;
3644 guc_vars = (struct config_generic **)
3645 guc_malloc(FATAL, size_vars * sizeof(struct config_generic *));
3649 for (i = 0; ConfigureNamesBool[i].gen.name; i++)
3650 guc_vars[num_vars++] = &ConfigureNamesBool[i].gen;
3652 for (i = 0; ConfigureNamesInt[i].gen.name; i++)
3653 guc_vars[num_vars++] = &ConfigureNamesInt[i].gen;
3655 for (i = 0; ConfigureNamesReal[i].gen.name; i++)
3656 guc_vars[num_vars++] = &ConfigureNamesReal[i].gen;
3658 for (i = 0; ConfigureNamesString[i].gen.name; i++)
3659 guc_vars[num_vars++] = &ConfigureNamesString[i].gen;
3661 for (i = 0; ConfigureNamesEnum[i].gen.name; i++)
3662 guc_vars[num_vars++] = &ConfigureNamesEnum[i].gen;
3665 free(guc_variables);
3666 guc_variables = guc_vars;
3667 num_guc_variables = num_vars;
3668 size_guc_variables = size_vars;
3669 qsort((void *) guc_variables, num_guc_variables,
3670 sizeof(struct config_generic *), guc_var_compare);
3674 * Add a new GUC variable to the list of known variables. The
3675 * list is expanded if needed.
3678 add_guc_variable(struct config_generic * var, int elevel)
3680 if (num_guc_variables + 1 >= size_guc_variables)
3683 * Increase the vector by 25%
3685 int size_vars = size_guc_variables + size_guc_variables / 4;
3686 struct config_generic **guc_vars;
3691 guc_vars = (struct config_generic **)
3692 guc_malloc(elevel, size_vars * sizeof(struct config_generic *));
3696 guc_vars = (struct config_generic **)
3697 guc_realloc(elevel, guc_variables, size_vars * sizeof(struct config_generic *));
3700 if (guc_vars == NULL)
3701 return false; /* out of memory */
3703 guc_variables = guc_vars;
3704 size_guc_variables = size_vars;
3706 guc_variables[num_guc_variables++] = var;
3707 qsort((void *) guc_variables, num_guc_variables,
3708 sizeof(struct config_generic *), guc_var_compare);
3713 * Create and add a placeholder variable for a custom variable name.
3715 static struct config_generic *
3716 add_placeholder_variable(const char *name, int elevel)
3718 size_t sz = sizeof(struct config_string) + sizeof(char *);
3719 struct config_string *var;
3720 struct config_generic *gen;
3722 var = (struct config_string *) guc_malloc(elevel, sz);
3728 gen->name = guc_strdup(elevel, name);
3729 if (gen->name == NULL)
3735 gen->context = PGC_USERSET;
3736 gen->group = CUSTOM_OPTIONS;
3737 gen->short_desc = "GUC placeholder variable";
3738 gen->flags = GUC_NO_SHOW_ALL | GUC_NOT_IN_SAMPLE | GUC_CUSTOM_PLACEHOLDER;
3739 gen->vartype = PGC_STRING;
3742 * The char* is allocated at the end of the struct since we have no
3743 * 'static' place to point to. Note that the current value, as well as
3744 * the boot and reset values, start out NULL.
3746 var->variable = (char **) (var + 1);
3748 if (!add_guc_variable((struct config_generic *) var, elevel))
3750 free((void *) gen->name);
3759 * Look up option NAME. If it exists, return a pointer to its record,
3760 * else return NULL. If create_placeholders is TRUE, we'll create a
3761 * placeholder record for a valid-looking custom variable name.
3763 static struct config_generic *
3764 find_option(const char *name, bool create_placeholders, int elevel)
3766 const char **key = &name;
3767 struct config_generic **res;
3773 * By equating const char ** with struct config_generic *, we are assuming
3774 * the name field is first in config_generic.
3776 res = (struct config_generic **) bsearch((void *) &key,
3777 (void *) guc_variables,
3779 sizeof(struct config_generic *),
3785 * See if the name is an obsolete name for a variable. We assume that the
3786 * set of supported old names is short enough that a brute-force search is
3789 for (i = 0; map_old_guc_names[i] != NULL; i += 2)
3791 if (guc_name_compare(name, map_old_guc_names[i]) == 0)
3792 return find_option(map_old_guc_names[i + 1], false, elevel);
3795 if (create_placeholders)
3798 * Check if the name is qualified, and if so, add a placeholder.
3800 if (strchr(name, GUC_QUALIFIER_SEPARATOR) != NULL)
3801 return add_placeholder_variable(name, elevel);
3810 * comparator for qsorting and bsearching guc_variables array
3813 guc_var_compare(const void *a, const void *b)
3815 const struct config_generic *confa = *(struct config_generic * const *) a;
3816 const struct config_generic *confb = *(struct config_generic * const *) b;
3818 return guc_name_compare(confa->name, confb->name);
3822 * the bare comparison function for GUC names
3825 guc_name_compare(const char *namea, const char *nameb)
3828 * The temptation to use strcasecmp() here must be resisted, because the
3829 * array ordering has to remain stable across setlocale() calls. So, build
3830 * our own with a simple ASCII-only downcasing.
3832 while (*namea && *nameb)
3834 char cha = *namea++;
3835 char chb = *nameb++;
3837 if (cha >= 'A' && cha <= 'Z')
3839 if (chb >= 'A' && chb <= 'Z')
3845 return 1; /* a is longer */
3847 return -1; /* b is longer */
3853 * Initialize GUC options during program startup.
3855 * Note that we cannot read the config file yet, since we have not yet
3856 * processed command-line switches.
3859 InitializeGUCOptions(void)
3864 * Before log_line_prefix could possibly receive a nonempty setting, make
3865 * sure that timezone processing is minimally alive (see elog.c).
3867 pg_timezone_initialize();
3870 * Build sorted array of all GUC variables.
3872 build_guc_variables();
3875 * Load all variables with their compiled-in defaults, and initialize
3876 * status fields as needed.
3878 for (i = 0; i < num_guc_variables; i++)
3880 InitializeOneGUCOption(guc_variables[i]);
3885 reporting_enabled = false;
3888 * Prevent any attempt to override the transaction modes from
3889 * non-interactive sources.
3891 SetConfigOption("transaction_isolation", "default",
3892 PGC_POSTMASTER, PGC_S_OVERRIDE);
3893 SetConfigOption("transaction_read_only", "no",
3894 PGC_POSTMASTER, PGC_S_OVERRIDE);
3895 SetConfigOption("transaction_deferrable", "no",
3896 PGC_POSTMASTER, PGC_S_OVERRIDE);
3899 * For historical reasons, some GUC parameters can receive defaults from
3900 * environment variables. Process those settings.
3902 InitializeGUCOptionsFromEnvironment();
3906 * Assign any GUC values that can come from the server's environment.
3908 * This is called from InitializeGUCOptions, and also from ProcessConfigFile
3909 * to deal with the possibility that a setting has been removed from
3910 * postgresql.conf and should now get a value from the environment.
3911 * (The latter is a kludge that should probably go away someday; if so,
3912 * fold this back into InitializeGUCOptions.)
3915 InitializeGUCOptionsFromEnvironment(void)
3920 env = getenv("PGPORT");
3922 SetConfigOption("port", env, PGC_POSTMASTER, PGC_S_ENV_VAR);
3924 env = getenv("PGDATESTYLE");
3926 SetConfigOption("datestyle", env, PGC_POSTMASTER, PGC_S_ENV_VAR);
3928 env = getenv("PGCLIENTENCODING");
3930 SetConfigOption("client_encoding", env, PGC_POSTMASTER, PGC_S_ENV_VAR);
3933 * rlimit isn't exactly an "environment variable", but it behaves about
3934 * the same. If we can identify the platform stack depth rlimit, increase
3935 * default stack depth setting up to whatever is safe (but at most 2MB).
3937 stack_rlimit = get_stack_depth_rlimit();
3938 if (stack_rlimit > 0)
3940 long new_limit = (stack_rlimit - STACK_DEPTH_SLOP) / 1024L;
3942 if (new_limit > 100)
3946 new_limit = Min(new_limit, 2048);
3947 sprintf(limbuf, "%ld", new_limit);
3948 SetConfigOption("max_stack_depth", limbuf,
3949 PGC_POSTMASTER, PGC_S_ENV_VAR);
3955 * Initialize one GUC option variable to its compiled-in default.
3957 * Note: the reason for calling check_hooks is not that we think the boot_val
3958 * might fail, but that the hooks might wish to compute an "extra" struct.
3961 InitializeOneGUCOption(struct config_generic * gconf)
3964 gconf->source = PGC_S_DEFAULT;
3965 gconf->reset_source = PGC_S_DEFAULT;
3966 gconf->scontext = PGC_INTERNAL;
3967 gconf->reset_scontext = PGC_INTERNAL;
3968 gconf->stack = NULL;
3969 gconf->extra = NULL;
3970 gconf->sourcefile = NULL;
3971 gconf->sourceline = 0;
3973 switch (gconf->vartype)
3977 struct config_bool *conf = (struct config_bool *) gconf;
3978 bool newval = conf->boot_val;
3981 if (!call_bool_check_hook(conf, &newval, &extra,
3982 PGC_S_DEFAULT, LOG))
3983 elog(FATAL, "failed to initialize %s to %d",
3984 conf->gen.name, (int) newval);
3985 if (conf->assign_hook)
3986 (*conf->assign_hook) (newval, extra);
3987 *conf->variable = conf->reset_val = newval;
3988 conf->gen.extra = conf->reset_extra = extra;
3993 struct config_int *conf = (struct config_int *) gconf;
3994 int newval = conf->boot_val;
3997 Assert(newval >= conf->min);
3998 Assert(newval <= conf->max);
3999 if (!call_int_check_hook(conf, &newval, &extra,
4000 PGC_S_DEFAULT, LOG))
4001 elog(FATAL, "failed to initialize %s to %d",
4002 conf->gen.name, newval);
4003 if (conf->assign_hook)
4004 (*conf->assign_hook) (newval, extra);
4005 *conf->variable = conf->reset_val = newval;
4006 conf->gen.extra = conf->reset_extra = extra;
4011 struct config_real *conf = (struct config_real *) gconf;
4012 double newval = conf->boot_val;
4015 Assert(newval >= conf->min);
4016 Assert(newval <= conf->max);
4017 if (!call_real_check_hook(conf, &newval, &extra,
4018 PGC_S_DEFAULT, LOG))
4019 elog(FATAL, "failed to initialize %s to %g",
4020 conf->gen.name, newval);
4021 if (conf->assign_hook)
4022 (*conf->assign_hook) (newval, extra);
4023 *conf->variable = conf->reset_val = newval;
4024 conf->gen.extra = conf->reset_extra = extra;
4029 struct config_string *conf = (struct config_string *) gconf;
4033 /* non-NULL boot_val must always get strdup'd */
4034 if (conf->boot_val != NULL)
4035 newval = guc_strdup(FATAL, conf->boot_val);
4039 if (!call_string_check_hook(conf, &newval, &extra,
4040 PGC_S_DEFAULT, LOG))
4041 elog(FATAL, "failed to initialize %s to \"%s\"",
4042 conf->gen.name, newval ? newval : "");
4043 if (conf->assign_hook)
4044 (*conf->assign_hook) (newval, extra);
4045 *conf->variable = conf->reset_val = newval;
4046 conf->gen.extra = conf->reset_extra = extra;
4051 struct config_enum *conf = (struct config_enum *) gconf;
4052 int newval = conf->boot_val;
4055 if (!call_enum_check_hook(conf, &newval, &extra,
4056 PGC_S_DEFAULT, LOG))
4057 elog(FATAL, "failed to initialize %s to %d",
4058 conf->gen.name, newval);
4059 if (conf->assign_hook)
4060 (*conf->assign_hook) (newval, extra);
4061 *conf->variable = conf->reset_val = newval;
4062 conf->gen.extra = conf->reset_extra = extra;
4070 * Select the configuration files and data directory to be used, and
4071 * do the initial read of postgresql.conf.
4073 * This is called after processing command-line switches.
4074 * userDoption is the -D switch value if any (NULL if unspecified).
4075 * progname is just for use in error messages.
4077 * Returns true on success; on failure, prints a suitable error message
4078 * to stderr and returns false.
4081 SelectConfigFiles(const char *userDoption, const char *progname)
4085 struct stat stat_buf;
4087 /* configdir is -D option, or $PGDATA if no -D */
4089 configdir = make_absolute_path(userDoption);
4091 configdir = make_absolute_path(getenv("PGDATA"));
4094 * Find the configuration file: if config_file was specified on the
4095 * command line, use it, else use configdir/postgresql.conf. In any case
4096 * ensure the result is an absolute path, so that it will be interpreted
4097 * the same way by future backends.
4100 fname = make_absolute_path(ConfigFileName);
4103 fname = guc_malloc(FATAL,
4104 strlen(configdir) + strlen(CONFIG_FILENAME) + 2);
4105 sprintf(fname, "%s/%s", configdir, CONFIG_FILENAME);
4109 write_stderr("%s does not know where to find the server configuration file.\n"
4110 "You must specify the --config-file or -D invocation "
4111 "option or set the PGDATA environment variable.\n",
4117 * Set the ConfigFileName GUC variable to its final value, ensuring that
4118 * it can't be overridden later.
4120 SetConfigOption("config_file", fname, PGC_POSTMASTER, PGC_S_OVERRIDE);
4124 * Now read the config file for the first time.
4126 if (stat(ConfigFileName, &stat_buf) != 0)
4128 write_stderr("%s cannot access the server configuration file \"%s\": %s\n",
4129 progname, ConfigFileName, strerror(errno));
4134 ProcessConfigFile(PGC_POSTMASTER);
4137 * If the data_directory GUC variable has been set, use that as DataDir;
4138 * otherwise use configdir if set; else punt.
4140 * Note: SetDataDir will copy and absolute-ize its argument, so we don't
4144 SetDataDir(data_directory);
4146 SetDataDir(configdir);
4149 write_stderr("%s does not know where to find the database system data.\n"
4150 "This can be specified as \"data_directory\" in \"%s\", "
4151 "or by the -D invocation option, or by the "
4152 "PGDATA environment variable.\n",
4153 progname, ConfigFileName);
4158 * Reflect the final DataDir value back into the data_directory GUC var.
4159 * (If you are wondering why we don't just make them a single variable,
4160 * it's because the EXEC_BACKEND case needs DataDir to be transmitted to
4161 * child backends specially. XXX is that still true? Given that we now
4162 * chdir to DataDir, EXEC_BACKEND can read the config file without knowing
4163 * DataDir in advance.)
4165 SetConfigOption("data_directory", DataDir, PGC_POSTMASTER, PGC_S_OVERRIDE);
4168 * If timezone_abbreviations wasn't set in the configuration file, install
4169 * the default value. We do it this way because we can't safely install a
4170 * "real" value until my_exec_path is set, which may not have happened
4171 * when InitializeGUCOptions runs, so the bootstrap default value cannot
4172 * be the real desired default.
4174 pg_timezone_abbrev_initialize();
4177 * Figure out where pg_hba.conf is, and make sure the path is absolute.
4180 fname = make_absolute_path(HbaFileName);
4183 fname = guc_malloc(FATAL,
4184 strlen(configdir) + strlen(HBA_FILENAME) + 2);
4185 sprintf(fname, "%s/%s", configdir, HBA_FILENAME);
4189 write_stderr("%s does not know where to find the \"hba\" configuration file.\n"
4190 "This can be specified as \"hba_file\" in \"%s\", "
4191 "or by the -D invocation option, or by the "
4192 "PGDATA environment variable.\n",
4193 progname, ConfigFileName);
4196 SetConfigOption("hba_file", fname, PGC_POSTMASTER, PGC_S_OVERRIDE);
4200 * Likewise for pg_ident.conf.
4203 fname = make_absolute_path(IdentFileName);
4206 fname = guc_malloc(FATAL,
4207 strlen(configdir) + strlen(IDENT_FILENAME) + 2);
4208 sprintf(fname, "%s/%s", configdir, IDENT_FILENAME);
4212 write_stderr("%s does not know where to find the \"ident\" configuration file.\n"
4213 "This can be specified as \"ident_file\" in \"%s\", "
4214 "or by the -D invocation option, or by the "
4215 "PGDATA environment variable.\n",
4216 progname, ConfigFileName);
4219 SetConfigOption("ident_file", fname, PGC_POSTMASTER, PGC_S_OVERRIDE);
4229 * Reset all options to their saved default values (implements RESET ALL)
4232 ResetAllOptions(void)
4236 for (i = 0; i < num_guc_variables; i++)
4238 struct config_generic *gconf = guc_variables[i];
4240 /* Don't reset non-SET-able values */
4241 if (gconf->context != PGC_SUSET &&
4242 gconf->context != PGC_USERSET)
4244 /* Don't reset if special exclusion from RESET ALL */
4245 if (gconf->flags & GUC_NO_RESET_ALL)
4247 /* No need to reset if wasn't SET */
4248 if (gconf->source <= PGC_S_OVERRIDE)
4251 /* Save old value to support transaction abort */
4252 push_old_value(gconf, GUC_ACTION_SET);
4254 switch (gconf->vartype)
4258 struct config_bool *conf = (struct config_bool *) gconf;
4260 if (conf->assign_hook)
4261 (*conf->assign_hook) (conf->reset_val,
4263 *conf->variable = conf->reset_val;
4264 set_extra_field(&conf->gen, &conf->gen.extra,
4270 struct config_int *conf = (struct config_int *) gconf;
4272 if (conf->assign_hook)
4273 (*conf->assign_hook) (conf->reset_val,
4275 *conf->variable = conf->reset_val;
4276 set_extra_field(&conf->gen, &conf->gen.extra,
4282 struct config_real *conf = (struct config_real *) gconf;
4284 if (conf->assign_hook)
4285 (*conf->assign_hook) (conf->reset_val,
4287 *conf->variable = conf->reset_val;
4288 set_extra_field(&conf->gen, &conf->gen.extra,
4294 struct config_string *conf = (struct config_string *) gconf;
4296 if (conf->assign_hook)
4297 (*conf->assign_hook) (conf->reset_val,
4299 set_string_field(conf, conf->variable, conf->reset_val);
4300 set_extra_field(&conf->gen, &conf->gen.extra,
4306 struct config_enum *conf = (struct config_enum *) gconf;
4308 if (conf->assign_hook)
4309 (*conf->assign_hook) (conf->reset_val,
4311 *conf->variable = conf->reset_val;
4312 set_extra_field(&conf->gen, &conf->gen.extra,
4318 gconf->source = gconf->reset_source;
4319 gconf->scontext = gconf->reset_scontext;
4321 if (gconf->flags & GUC_REPORT)
4322 ReportGUCOption(gconf);
4329 * Push previous state during transactional assignment to a GUC variable.
4332 push_old_value(struct config_generic * gconf, GucAction action)
4336 /* If we're not inside a nest level, do nothing */
4337 if (GUCNestLevel == 0)
4340 /* Do we already have a stack entry of the current nest level? */
4341 stack = gconf->stack;
4342 if (stack && stack->nest_level >= GUCNestLevel)
4344 /* Yes, so adjust its state if necessary */
4345 Assert(stack->nest_level == GUCNestLevel);
4348 case GUC_ACTION_SET:
4349 /* SET overrides any prior action at same nest level */
4350 if (stack->state == GUC_SET_LOCAL)
4352 /* must discard old masked value */
4353 discard_stack_value(gconf, &stack->masked);
4355 stack->state = GUC_SET;
4357 case GUC_ACTION_LOCAL:
4358 if (stack->state == GUC_SET)
4360 /* SET followed by SET LOCAL, remember SET's value */
4361 stack->masked_scontext = gconf->scontext;
4362 set_stack_value(gconf, &stack->masked);
4363 stack->state = GUC_SET_LOCAL;
4365 /* in all other cases, no change to stack entry */
4367 case GUC_ACTION_SAVE:
4368 /* Could only have a prior SAVE of same variable */
4369 Assert(stack->state == GUC_SAVE);
4372 Assert(guc_dirty); /* must be set already */
4377 * Push a new stack entry
4379 * We keep all the stack entries in TopTransactionContext for simplicity.
4381 stack = (GucStack *) MemoryContextAllocZero(TopTransactionContext,
4384 stack->prev = gconf->stack;
4385 stack->nest_level = GUCNestLevel;
4388 case GUC_ACTION_SET:
4389 stack->state = GUC_SET;
4391 case GUC_ACTION_LOCAL:
4392 stack->state = GUC_LOCAL;
4394 case GUC_ACTION_SAVE:
4395 stack->state = GUC_SAVE;
4398 stack->source = gconf->source;
4399 stack->scontext = gconf->scontext;
4400 set_stack_value(gconf, &stack->prior);
4402 gconf->stack = stack;
4404 /* Ensure we remember to pop at end of xact */
4410 * Do GUC processing at main transaction start.
4416 * The nest level should be 0 between transactions; if it isn't, somebody
4417 * didn't call AtEOXact_GUC, or called it with the wrong nestLevel. We
4418 * throw a warning but make no other effort to clean up.
4420 if (GUCNestLevel != 0)
4421 elog(WARNING, "GUC nest level = %d at transaction start",
4427 * Enter a new nesting level for GUC values. This is called at subtransaction
4428 * start, and when entering a function that has proconfig settings, and in
4429 * some other places where we want to set GUC variables transiently.
4430 * NOTE we must not risk error here, else subtransaction start will be unhappy.
4433 NewGUCNestLevel(void)
4435 return ++GUCNestLevel;
4439 * Do GUC processing at transaction or subtransaction commit or abort, or
4440 * when exiting a function that has proconfig settings, or when undoing a
4441 * transient assignment to some GUC variables. (The name is thus a bit of
4442 * a misnomer; perhaps it should be ExitGUCNestLevel or some such.)
4443 * During abort, we discard all GUC settings that were applied at nesting
4444 * levels >= nestLevel. nestLevel == 1 corresponds to the main transaction.
4447 AtEOXact_GUC(bool isCommit, int nestLevel)
4453 * Note: it's possible to get here with GUCNestLevel == nestLevel-1 during
4454 * abort, if there is a failure during transaction start before
4455 * AtStart_GUC is called.
4457 Assert(nestLevel > 0 &&
4458 (nestLevel <= GUCNestLevel ||
4459 (nestLevel == GUCNestLevel + 1 && !isCommit)));
4461 /* Quick exit if nothing's changed in this transaction */
4464 GUCNestLevel = nestLevel - 1;
4468 still_dirty = false;
4469 for (i = 0; i < num_guc_variables; i++)
4471 struct config_generic *gconf = guc_variables[i];
4475 * Process and pop each stack entry within the nest level. To simplify
4476 * fmgr_security_definer() and other places that use GUC_ACTION_SAVE,
4477 * we allow failure exit from code that uses a local nest level to be
4478 * recovered at the surrounding transaction or subtransaction abort;
4479 * so there could be more than one stack entry to pop.
4481 while ((stack = gconf->stack) != NULL &&
4482 stack->nest_level >= nestLevel)
4484 GucStack *prev = stack->prev;
4485 bool restorePrior = false;
4486 bool restoreMasked = false;
4490 * In this next bit, if we don't set either restorePrior or
4491 * restoreMasked, we must "discard" any unwanted fields of the
4492 * stack entries to avoid leaking memory. If we do set one of
4493 * those flags, unused fields will be cleaned up after restoring.
4495 if (!isCommit) /* if abort, always restore prior value */
4496 restorePrior = true;
4497 else if (stack->state == GUC_SAVE)
4498 restorePrior = true;
4499 else if (stack->nest_level == 1)
4501 /* transaction commit */
4502 if (stack->state == GUC_SET_LOCAL)
4503 restoreMasked = true;
4504 else if (stack->state == GUC_SET)
4506 /* we keep the current active value */
4507 discard_stack_value(gconf, &stack->prior);
4509 else /* must be GUC_LOCAL */
4510 restorePrior = true;
4512 else if (prev == NULL ||
4513 prev->nest_level < stack->nest_level - 1)
4515 /* decrement entry's level and do not pop it */
4516 stack->nest_level--;
4522 * We have to merge this stack entry into prev. See README for
4523 * discussion of this bit.
4525 switch (stack->state)
4528 Assert(false); /* can't get here */
4531 /* next level always becomes SET */
4532 discard_stack_value(gconf, &stack->prior);
4533 if (prev->state == GUC_SET_LOCAL)
4534 discard_stack_value(gconf, &prev->masked);
4535 prev->state = GUC_SET;
4539 if (prev->state == GUC_SET)
4541 /* LOCAL migrates down */
4542 prev->masked_scontext = stack->scontext;
4543 prev->masked = stack->prior;
4544 prev->state = GUC_SET_LOCAL;
4548 /* else just forget this stack level */
4549 discard_stack_value(gconf, &stack->prior);
4554 /* prior state at this level no longer wanted */
4555 discard_stack_value(gconf, &stack->prior);
4556 /* copy down the masked state */
4557 prev->masked_scontext = stack->masked_scontext;
4558 if (prev->state == GUC_SET_LOCAL)
4559 discard_stack_value(gconf, &prev->masked);
4560 prev->masked = stack->masked;
4561 prev->state = GUC_SET_LOCAL;
4568 if (restorePrior || restoreMasked)
4570 /* Perform appropriate restoration of the stacked value */
4571 config_var_value newvalue;
4572 GucSource newsource;
4573 GucContext newscontext;
4577 newvalue = stack->masked;
4578 newsource = PGC_S_SESSION;
4579 newscontext = stack->masked_scontext;
4583 newvalue = stack->prior;
4584 newsource = stack->source;
4585 newscontext = stack->scontext;
4588 switch (gconf->vartype)
4592 struct config_bool *conf = (struct config_bool *) gconf;
4593 bool newval = newvalue.val.boolval;
4594 void *newextra = newvalue.extra;
4596 if (*conf->variable != newval ||
4597 conf->gen.extra != newextra)
4599 if (conf->assign_hook)
4600 (*conf->assign_hook) (newval, newextra);
4601 *conf->variable = newval;
4602 set_extra_field(&conf->gen, &conf->gen.extra,
4610 struct config_int *conf = (struct config_int *) gconf;
4611 int newval = newvalue.val.intval;
4612 void *newextra = newvalue.extra;
4614 if (*conf->variable != newval ||
4615 conf->gen.extra != newextra)
4617 if (conf->assign_hook)
4618 (*conf->assign_hook) (newval, newextra);
4619 *conf->variable = newval;
4620 set_extra_field(&conf->gen, &conf->gen.extra,
4628 struct config_real *conf = (struct config_real *) gconf;
4629 double newval = newvalue.val.realval;
4630 void *newextra = newvalue.extra;
4632 if (*conf->variable != newval ||
4633 conf->gen.extra != newextra)
4635 if (conf->assign_hook)
4636 (*conf->assign_hook) (newval, newextra);
4637 *conf->variable = newval;
4638 set_extra_field(&conf->gen, &conf->gen.extra,
4646 struct config_string *conf = (struct config_string *) gconf;
4647 char *newval = newvalue.val.stringval;
4648 void *newextra = newvalue.extra;
4650 if (*conf->variable != newval ||
4651 conf->gen.extra != newextra)
4653 if (conf->assign_hook)
4654 (*conf->assign_hook) (newval, newextra);
4655 set_string_field(conf, conf->variable, newval);
4656 set_extra_field(&conf->gen, &conf->gen.extra,
4662 * Release stacked values if not used anymore. We
4663 * could use discard_stack_value() here, but since
4664 * we have type-specific code anyway, might as
4667 set_string_field(conf, &stack->prior.val.stringval, NULL);
4668 set_string_field(conf, &stack->masked.val.stringval, NULL);
4673 struct config_enum *conf = (struct config_enum *) gconf;
4674 int newval = newvalue.val.enumval;
4675 void *newextra = newvalue.extra;
4677 if (*conf->variable != newval ||
4678 conf->gen.extra != newextra)
4680 if (conf->assign_hook)
4681 (*conf->assign_hook) (newval, newextra);
4682 *conf->variable = newval;
4683 set_extra_field(&conf->gen, &conf->gen.extra,
4692 * Release stacked extra values if not used anymore.
4694 set_extra_field(gconf, &(stack->prior.extra), NULL);
4695 set_extra_field(gconf, &(stack->masked.extra), NULL);
4697 /* And restore source information */
4698 gconf->source = newsource;
4699 gconf->scontext = newscontext;
4702 /* Finish popping the state stack */
4703 gconf->stack = prev;
4706 /* Report new value if we changed it */
4707 if (changed && (gconf->flags & GUC_REPORT))
4708 ReportGUCOption(gconf);
4709 } /* end of stack-popping loop */
4715 /* If there are no remaining stack entries, we can reset guc_dirty */
4716 guc_dirty = still_dirty;
4718 /* Update nesting level */
4719 GUCNestLevel = nestLevel - 1;
4724 * Start up automatic reporting of changes to variables marked GUC_REPORT.
4725 * This is executed at completion of backend startup.
4728 BeginReportingGUCOptions(void)
4733 * Don't do anything unless talking to an interactive frontend of protocol
4736 if (whereToSendOutput != DestRemote ||
4737 PG_PROTOCOL_MAJOR(FrontendProtocol) < 3)
4740 reporting_enabled = true;
4742 /* Transmit initial values of interesting variables */
4743 for (i = 0; i < num_guc_variables; i++)
4745 struct config_generic *conf = guc_variables[i];
4747 if (conf->flags & GUC_REPORT)
4748 ReportGUCOption(conf);
4753 * ReportGUCOption: if appropriate, transmit option value to frontend
4756 ReportGUCOption(struct config_generic * record)
4758 if (reporting_enabled && (record->flags & GUC_REPORT))
4760 char *val = _ShowOption(record, false);
4761 StringInfoData msgbuf;
4763 pq_beginmessage(&msgbuf, 'S');
4764 pq_sendstring(&msgbuf, record->name);
4765 pq_sendstring(&msgbuf, val);
4766 pq_endmessage(&msgbuf);
4773 * Try to parse value as an integer. The accepted formats are the
4774 * usual decimal, octal, or hexadecimal formats, optionally followed by
4775 * a unit name if "flags" indicates a unit is allowed.
4777 * If the string parses okay, return true, else false.
4778 * If okay and result is not NULL, return the value in *result.
4779 * If not okay and hintmsg is not NULL, *hintmsg is set to a suitable
4780 * HINT message, or NULL if no hint provided.
4783 parse_int(const char *value, int *result, int flags, const char **hintmsg)
4788 /* To suppress compiler warnings, always set output params */
4794 /* We assume here that int64 is at least as wide as long */
4796 val = strtol(value, &endptr, 0);
4798 if (endptr == value)
4799 return false; /* no HINT for integer syntax error */
4801 if (errno == ERANGE || val != (int64) ((int32) val))
4804 *hintmsg = gettext_noop("Value exceeds integer range.");
4808 /* allow whitespace between integer and unit */
4809 while (isspace((unsigned char) *endptr))
4812 /* Handle possible unit */
4813 if (*endptr != '\0')
4816 * Note: the multiple-switch coding technique here is a bit tedious,
4817 * but seems necessary to avoid intermediate-value overflows.
4819 if (flags & GUC_UNIT_MEMORY)
4821 /* Set hint for use if no match or trailing garbage */
4823 *hintmsg = gettext_noop("Valid units for this parameter are \"kB\", \"MB\", and \"GB\".");
4825 #if BLCKSZ < 1024 || BLCKSZ > (1024*1024)
4826 #error BLCKSZ must be between 1KB and 1MB
4828 #if XLOG_BLCKSZ < 1024 || XLOG_BLCKSZ > (1024*1024)
4829 #error XLOG_BLCKSZ must be between 1KB and 1MB
4832 if (strncmp(endptr, "kB", 2) == 0)
4835 switch (flags & GUC_UNIT_MEMORY)
4837 case GUC_UNIT_BLOCKS:
4838 val /= (BLCKSZ / 1024);
4840 case GUC_UNIT_XBLOCKS:
4841 val /= (XLOG_BLCKSZ / 1024);
4845 else if (strncmp(endptr, "MB", 2) == 0)
4848 switch (flags & GUC_UNIT_MEMORY)
4853 case GUC_UNIT_BLOCKS:
4854 val *= KB_PER_MB / (BLCKSZ / 1024);
4856 case GUC_UNIT_XBLOCKS:
4857 val *= KB_PER_MB / (XLOG_BLCKSZ / 1024);
4861 else if (strncmp(endptr, "GB", 2) == 0)
4864 switch (flags & GUC_UNIT_MEMORY)
4869 case GUC_UNIT_BLOCKS:
4870 val *= KB_PER_GB / (BLCKSZ / 1024);
4872 case GUC_UNIT_XBLOCKS:
4873 val *= KB_PER_GB / (XLOG_BLCKSZ / 1024);
4878 else if (flags & GUC_UNIT_TIME)
4880 /* Set hint for use if no match or trailing garbage */
4882 *hintmsg = gettext_noop("Valid units for this parameter are \"ms\", \"s\", \"min\", \"h\", and \"d\".");
4884 if (strncmp(endptr, "ms", 2) == 0)
4887 switch (flags & GUC_UNIT_TIME)
4897 else if (strncmp(endptr, "s", 1) == 0)
4900 switch (flags & GUC_UNIT_TIME)
4910 else if (strncmp(endptr, "min", 3) == 0)
4913 switch (flags & GUC_UNIT_TIME)
4923 else if (strncmp(endptr, "h", 1) == 0)
4926 switch (flags & GUC_UNIT_TIME)
4939 else if (strncmp(endptr, "d", 1) == 0)
4942 switch (flags & GUC_UNIT_TIME)
4957 /* allow whitespace after unit */
4958 while (isspace((unsigned char) *endptr))
4961 if (*endptr != '\0')
4962 return false; /* appropriate hint, if any, already set */
4964 /* Check for overflow due to units conversion */
4965 if (val != (int64) ((int32) val))
4968 *hintmsg = gettext_noop("Value exceeds integer range.");
4974 *result = (int) val;
4981 * Try to parse value as a floating point number in the usual format.
4982 * If the string parses okay, return true, else false.
4983 * If okay and result is not NULL, return the value in *result.
4986 parse_real(const char *value, double *result)
4992 *result = 0; /* suppress compiler warning */
4995 val = strtod(value, &endptr);
4996 if (endptr == value || errno == ERANGE)
4999 /* allow whitespace after number */
5000 while (isspace((unsigned char) *endptr))
5002 if (*endptr != '\0')
5012 * Lookup the name for an enum option with the selected value.
5013 * Should only ever be called with known-valid values, so throws
5014 * an elog(ERROR) if the enum option is not found.
5016 * The returned string is a pointer to static data and not
5017 * allocated for modification.
5020 config_enum_lookup_by_value(struct config_enum * record, int val)
5022 const struct config_enum_entry *entry;
5024 for (entry = record->options; entry && entry->name; entry++)
5026 if (entry->val == val)
5030 elog(ERROR, "could not find enum option %d for %s",
5031 val, record->gen.name);
5032 return NULL; /* silence compiler */
5037 * Lookup the value for an enum option with the selected name
5038 * (case-insensitive).
5039 * If the enum option is found, sets the retval value and returns
5040 * true. If it's not found, return FALSE and retval is set to 0.
5043 config_enum_lookup_by_name(struct config_enum * record, const char *value,
5046 const struct config_enum_entry *entry;
5048 for (entry = record->options; entry && entry->name; entry++)
5050 if (pg_strcasecmp(value, entry->name) == 0)
5052 *retval = entry->val;
5063 * Return a list of all available options for an enum, excluding
5064 * hidden ones, separated by the given separator.
5065 * If prefix is non-NULL, it is added before the first enum value.
5066 * If suffix is non-NULL, it is added to the end of the string.
5069 config_enum_get_options(struct config_enum * record, const char *prefix,
5070 const char *suffix, const char *separator)
5072 const struct config_enum_entry *entry;
5073 StringInfoData retstr;
5076 initStringInfo(&retstr);
5077 appendStringInfoString(&retstr, prefix);
5079 seplen = strlen(separator);
5080 for (entry = record->options; entry && entry->name; entry++)
5084 appendStringInfoString(&retstr, entry->name);
5085 appendBinaryStringInfo(&retstr, separator, seplen);
5090 * All the entries may have been hidden, leaving the string empty if no
5091 * prefix was given. This indicates a broken GUC setup, since there is no
5092 * use for an enum without any values, so we just check to make sure we
5093 * don't write to invalid memory instead of actually trying to do
5094 * something smart with it.
5096 if (retstr.len >= seplen)
5098 /* Replace final separator */
5099 retstr.data[retstr.len - seplen] = '\0';
5100 retstr.len -= seplen;
5103 appendStringInfoString(&retstr, suffix);
5110 * Sets option `name' to given value.
5112 * The value should be a string, which will be parsed and converted to
5113 * the appropriate data type. The context and source parameters indicate
5114 * in which context this function is being called, so that it can apply the
5115 * access restrictions properly.
5117 * If value is NULL, set the option to its default value (normally the
5118 * reset_val, but if source == PGC_S_DEFAULT we instead use the boot_val).
5120 * action indicates whether to set the value globally in the session, locally
5121 * to the current top transaction, or just for the duration of a function call.
5123 * If changeVal is false then don't really set the option but do all
5124 * the checks to see if it would work.
5126 * elevel should normally be passed as zero, allowing this function to make
5127 * its standard choice of ereport level. However some callers need to be
5128 * able to override that choice; they should pass the ereport level to use.
5131 * +1: the value is valid and was successfully applied.
5132 * 0: the name or value is invalid (but see below).
5133 * -1: the value was not applied because of context, priority, or changeVal.
5135 * If there is an error (non-existing option, invalid value) then an
5136 * ereport(ERROR) is thrown *unless* this is called for a source for which
5137 * we don't want an ERROR (currently, those are defaults, the config file,
5138 * and per-database or per-user settings, as well as callers who specify
5139 * a less-than-ERROR elevel). In those cases we write a suitable error
5140 * message via ereport() and return 0.
5142 * See also SetConfigOption for an external interface.
5145 set_config_option(const char *name, const char *value,
5146 GucContext context, GucSource source,
5147 GucAction action, bool changeVal, int elevel)
5149 struct config_generic *record;
5150 bool prohibitValueChange = false;
5155 if (source == PGC_S_DEFAULT || source == PGC_S_FILE)
5158 * To avoid cluttering the log, only the postmaster bleats loudly
5159 * about problems with the config file.
5161 elevel = IsUnderPostmaster ? DEBUG3 : LOG;
5163 else if (source == PGC_S_DATABASE || source == PGC_S_USER ||
5164 source == PGC_S_DATABASE_USER)
5170 record = find_option(name, true, elevel);
5174 (errcode(ERRCODE_UNDEFINED_OBJECT),
5175 errmsg("unrecognized configuration parameter \"%s\"", name)));
5180 * Check if the option can be set at this time. See guc.h for the precise
5183 switch (record->context)
5186 if (context != PGC_INTERNAL)
5189 (errcode(ERRCODE_CANT_CHANGE_RUNTIME_PARAM),
5190 errmsg("parameter \"%s\" cannot be changed",
5195 case PGC_POSTMASTER:
5196 if (context == PGC_SIGHUP)
5199 * We are re-reading a PGC_POSTMASTER variable from
5200 * postgresql.conf. We can't change the setting, so we should
5201 * give a warning if the DBA tries to change it. However,
5202 * because of variant formats, canonicalization by check
5203 * hooks, etc, we can't just compare the given string directly
5204 * to what's stored. Set a flag to check below after we have
5205 * the final storable value.
5207 prohibitValueChange = true;
5209 else if (context != PGC_POSTMASTER)
5212 (errcode(ERRCODE_CANT_CHANGE_RUNTIME_PARAM),
5213 errmsg("parameter \"%s\" cannot be changed without restarting the server",
5219 if (context != PGC_SIGHUP && context != PGC_POSTMASTER)
5222 (errcode(ERRCODE_CANT_CHANGE_RUNTIME_PARAM),
5223 errmsg("parameter \"%s\" cannot be changed now",
5229 * Hmm, the idea of the SIGHUP context is "ought to be global, but
5230 * can be changed after postmaster start". But there's nothing
5231 * that prevents a crafty administrator from sending SIGHUP
5232 * signals to individual backends only.
5236 if (context == PGC_SIGHUP)
5239 * If a PGC_BACKEND parameter is changed in the config file,
5240 * we want to accept the new value in the postmaster (whence
5241 * it will propagate to subsequently-started backends), but
5242 * ignore it in existing backends. This is a tad klugy, but
5243 * necessary because we don't re-read the config file during
5246 if (IsUnderPostmaster)
5249 else if (context != PGC_POSTMASTER && context != PGC_BACKEND &&
5250 source != PGC_S_CLIENT)
5253 (errcode(ERRCODE_CANT_CHANGE_RUNTIME_PARAM),
5254 errmsg("parameter \"%s\" cannot be set after connection start",
5260 if (context == PGC_USERSET || context == PGC_BACKEND)
5263 (errcode(ERRCODE_INSUFFICIENT_PRIVILEGE),
5264 errmsg("permission denied to set parameter \"%s\"",
5275 * Disallow changing GUC_NOT_WHILE_SEC_REST values if we are inside a
5276 * security restriction context. We can reject this regardless of the GUC
5277 * context or source, mainly because sources that it might be reasonable
5278 * to override for won't be seen while inside a function.
5280 * Note: variables marked GUC_NOT_WHILE_SEC_REST should usually be marked
5281 * GUC_NO_RESET_ALL as well, because ResetAllOptions() doesn't check this.
5282 * An exception might be made if the reset value is assumed to be "safe".
5284 * Note: this flag is currently used for "session_authorization" and
5285 * "role". We need to prohibit changing these inside a local userid
5286 * context because when we exit it, GUC won't be notified, leaving things
5287 * out of sync. (This could be fixed by forcing a new GUC nesting level,
5288 * but that would change behavior in possibly-undesirable ways.) Also, we
5289 * prohibit changing these in a security-restricted operation because
5290 * otherwise RESET could be used to regain the session user's privileges.
5292 if (record->flags & GUC_NOT_WHILE_SEC_REST)
5294 if (InLocalUserIdChange())
5297 * Phrasing of this error message is historical, but it's the most
5301 (errcode(ERRCODE_INSUFFICIENT_PRIVILEGE),
5302 errmsg("cannot set parameter \"%s\" within security-definer function",
5306 if (InSecurityRestrictedOperation())
5309 (errcode(ERRCODE_INSUFFICIENT_PRIVILEGE),
5310 errmsg("cannot set parameter \"%s\" within security-restricted operation",
5317 * Should we set reset/stacked values? (If so, the behavior is not
5318 * transactional.) This is done either when we get a default value from
5319 * the database's/user's/client's default settings or when we reset a
5320 * value to its default.
5322 makeDefault = changeVal && (source <= PGC_S_OVERRIDE) &&
5323 ((value != NULL) || source == PGC_S_DEFAULT);
5326 * Ignore attempted set if overridden by previously processed setting.
5327 * However, if changeVal is false then plow ahead anyway since we are
5328 * trying to find out if the value is potentially good, not actually use
5329 * it. Also keep going if makeDefault is true, since we may want to set
5330 * the reset/stacked values even if we can't set the variable itself.
5332 if (record->source > source)
5334 if (changeVal && !makeDefault)
5336 elog(DEBUG3, "\"%s\": setting ignored because previous source is higher priority",
5344 * Evaluate value and set variable.
5346 switch (record->vartype)
5350 struct config_bool *conf = (struct config_bool *) record;
5352 void *newextra = NULL;
5356 if (!parse_bool(value, &newval))
5359 (errcode(ERRCODE_INVALID_PARAMETER_VALUE),
5360 errmsg("parameter \"%s\" requires a Boolean value",
5364 if (!call_bool_check_hook(conf, &newval, &newextra,
5368 else if (source == PGC_S_DEFAULT)
5370 newval = conf->boot_val;
5371 if (!call_bool_check_hook(conf, &newval, &newextra,
5377 newval = conf->reset_val;
5378 newextra = conf->reset_extra;
5379 source = conf->gen.reset_source;
5380 context = conf->gen.reset_scontext;
5383 if (prohibitValueChange)
5385 if (*conf->variable != newval)
5388 (errcode(ERRCODE_CANT_CHANGE_RUNTIME_PARAM),
5389 errmsg("parameter \"%s\" cannot be changed without restarting the server",
5398 /* Save old value to support transaction abort */
5400 push_old_value(&conf->gen, action);
5402 if (conf->assign_hook)
5403 (*conf->assign_hook) (newval, newextra);
5404 *conf->variable = newval;
5405 set_extra_field(&conf->gen, &conf->gen.extra,
5407 conf->gen.source = source;
5408 conf->gen.scontext = context;
5414 if (conf->gen.reset_source <= source)
5416 conf->reset_val = newval;
5417 set_extra_field(&conf->gen, &conf->reset_extra,
5419 conf->gen.reset_source = source;
5420 conf->gen.reset_scontext = context;
5422 for (stack = conf->gen.stack; stack; stack = stack->prev)
5424 if (stack->source <= source)
5426 stack->prior.val.boolval = newval;
5427 set_extra_field(&conf->gen, &stack->prior.extra,
5429 stack->source = source;
5430 stack->scontext = context;
5435 /* Perhaps we didn't install newextra anywhere */
5436 if (newextra && !extra_field_used(&conf->gen, newextra))
5443 struct config_int *conf = (struct config_int *) record;
5445 void *newextra = NULL;
5449 const char *hintmsg;
5451 if (!parse_int(value, &newval, conf->gen.flags, &hintmsg))
5454 (errcode(ERRCODE_INVALID_PARAMETER_VALUE),
5455 errmsg("invalid value for parameter \"%s\": \"%s\"",
5457 hintmsg ? errhint("%s", _(hintmsg)) : 0));
5460 if (newval < conf->min || newval > conf->max)
5463 (errcode(ERRCODE_INVALID_PARAMETER_VALUE),
5464 errmsg("%d is outside the valid range for parameter \"%s\" (%d .. %d)",
5465 newval, name, conf->min, conf->max)));
5468 if (!call_int_check_hook(conf, &newval, &newextra,
5472 else if (source == PGC_S_DEFAULT)
5474 newval = conf->boot_val;
5475 if (!call_int_check_hook(conf, &newval, &newextra,
5481 newval = conf->reset_val;
5482 newextra = conf->reset_extra;
5483 source = conf->gen.reset_source;
5484 context = conf->gen.reset_scontext;
5487 if (prohibitValueChange)
5489 if (*conf->variable != newval)
5492 (errcode(ERRCODE_CANT_CHANGE_RUNTIME_PARAM),
5493 errmsg("parameter \"%s\" cannot be changed without restarting the server",
5502 /* Save old value to support transaction abort */
5504 push_old_value(&conf->gen, action);
5506 if (conf->assign_hook)
5507 (*conf->assign_hook) (newval, newextra);
5508 *conf->variable = newval;
5509 set_extra_field(&conf->gen, &conf->gen.extra,
5511 conf->gen.source = source;
5512 conf->gen.scontext = context;
5518 if (conf->gen.reset_source <= source)
5520 conf->reset_val = newval;
5521 set_extra_field(&conf->gen, &conf->reset_extra,
5523 conf->gen.reset_source = source;
5524 conf->gen.reset_scontext = context;
5526 for (stack = conf->gen.stack; stack; stack = stack->prev)
5528 if (stack->source <= source)
5530 stack->prior.val.intval = newval;
5531 set_extra_field(&conf->gen, &stack->prior.extra,
5533 stack->source = source;
5534 stack->scontext = context;
5539 /* Perhaps we didn't install newextra anywhere */
5540 if (newextra && !extra_field_used(&conf->gen, newextra))
5547 struct config_real *conf = (struct config_real *) record;
5549 void *newextra = NULL;
5553 if (!parse_real(value, &newval))
5556 (errcode(ERRCODE_INVALID_PARAMETER_VALUE),
5557 errmsg("parameter \"%s\" requires a numeric value",
5561 if (newval < conf->min || newval > conf->max)
5564 (errcode(ERRCODE_INVALID_PARAMETER_VALUE),
5565 errmsg("%g is outside the valid range for parameter \"%s\" (%g .. %g)",
5566 newval, name, conf->min, conf->max)));
5569 if (!call_real_check_hook(conf, &newval, &newextra,
5573 else if (source == PGC_S_DEFAULT)
5575 newval = conf->boot_val;
5576 if (!call_real_check_hook(conf, &newval, &newextra,
5582 newval = conf->reset_val;
5583 newextra = conf->reset_extra;
5584 source = conf->gen.reset_source;
5585 context = conf->gen.reset_scontext;
5588 if (prohibitValueChange)
5590 if (*conf->variable != newval)
5593 (errcode(ERRCODE_CANT_CHANGE_RUNTIME_PARAM),
5594 errmsg("parameter \"%s\" cannot be changed without restarting the server",
5603 /* Save old value to support transaction abort */
5605 push_old_value(&conf->gen, action);
5607 if (conf->assign_hook)
5608 (*conf->assign_hook) (newval, newextra);
5609 *conf->variable = newval;
5610 set_extra_field(&conf->gen, &conf->gen.extra,
5612 conf->gen.source = source;
5613 conf->gen.scontext = context;
5619 if (conf->gen.reset_source <= source)
5621 conf->reset_val = newval;
5622 set_extra_field(&conf->gen, &conf->reset_extra,
5624 conf->gen.reset_source = source;
5625 conf->gen.reset_scontext = context;
5627 for (stack = conf->gen.stack; stack; stack = stack->prev)
5629 if (stack->source <= source)
5631 stack->prior.val.realval = newval;
5632 set_extra_field(&conf->gen, &stack->prior.extra,
5634 stack->source = source;
5635 stack->scontext = context;
5640 /* Perhaps we didn't install newextra anywhere */
5641 if (newextra && !extra_field_used(&conf->gen, newextra))
5648 struct config_string *conf = (struct config_string *) record;
5650 void *newextra = NULL;
5655 * The value passed by the caller could be transient, so
5656 * we always strdup it.
5658 newval = guc_strdup(elevel, value);
5663 * The only built-in "parsing" check we have is to apply
5664 * truncation if GUC_IS_NAME.
5666 if (conf->gen.flags & GUC_IS_NAME)
5667 truncate_identifier(newval, strlen(newval), true);
5669 if (!call_string_check_hook(conf, &newval, &newextra,
5676 else if (source == PGC_S_DEFAULT)
5678 /* non-NULL boot_val must always get strdup'd */
5679 if (conf->boot_val != NULL)
5681 newval = guc_strdup(elevel, conf->boot_val);
5688 if (!call_string_check_hook(conf, &newval, &newextra,
5698 * strdup not needed, since reset_val is already under
5701 newval = conf->reset_val;
5702 newextra = conf->reset_extra;
5703 source = conf->gen.reset_source;
5704 context = conf->gen.reset_scontext;
5707 if (prohibitValueChange)
5709 /* newval shouldn't be NULL, so we're a bit sloppy here */
5710 if (*conf->variable == NULL || newval == NULL ||
5711 strcmp(*conf->variable, newval) != 0)
5714 (errcode(ERRCODE_CANT_CHANGE_RUNTIME_PARAM),
5715 errmsg("parameter \"%s\" cannot be changed without restarting the server",
5724 /* Save old value to support transaction abort */
5726 push_old_value(&conf->gen, action);
5728 if (conf->assign_hook)
5729 (*conf->assign_hook) (newval, newextra);
5730 set_string_field(conf, conf->variable, newval);
5731 set_extra_field(&conf->gen, &conf->gen.extra,
5733 conf->gen.source = source;
5734 conf->gen.scontext = context;
5741 if (conf->gen.reset_source <= source)
5743 set_string_field(conf, &conf->reset_val, newval);
5744 set_extra_field(&conf->gen, &conf->reset_extra,
5746 conf->gen.reset_source = source;
5747 conf->gen.reset_scontext = context;
5749 for (stack = conf->gen.stack; stack; stack = stack->prev)
5751 if (stack->source <= source)
5753 set_string_field(conf, &stack->prior.val.stringval,
5755 set_extra_field(&conf->gen, &stack->prior.extra,
5757 stack->source = source;
5758 stack->scontext = context;
5763 /* Perhaps we didn't install newval anywhere */
5764 if (newval && !string_field_used(conf, newval))
5766 /* Perhaps we didn't install newextra anywhere */
5767 if (newextra && !extra_field_used(&conf->gen, newextra))
5774 struct config_enum *conf = (struct config_enum *) record;
5776 void *newextra = NULL;
5780 if (!config_enum_lookup_by_name(conf, value, &newval))
5784 hintmsg = config_enum_get_options(conf,
5785 "Available values: ",
5789 (errcode(ERRCODE_INVALID_PARAMETER_VALUE),
5790 errmsg("invalid value for parameter \"%s\": \"%s\"",
5792 hintmsg ? errhint("%s", _(hintmsg)) : 0));
5798 if (!call_enum_check_hook(conf, &newval, &newextra,
5802 else if (source == PGC_S_DEFAULT)
5804 newval = conf->boot_val;
5805 if (!call_enum_check_hook(conf, &newval, &newextra,
5811 newval = conf->reset_val;
5812 newextra = conf->reset_extra;
5813 source = conf->gen.reset_source;
5814 context = conf->gen.reset_scontext;
5817 if (prohibitValueChange)
5819 if (*conf->variable != newval)
5822 (errcode(ERRCODE_CANT_CHANGE_RUNTIME_PARAM),
5823 errmsg("parameter \"%s\" cannot be changed without restarting the server",
5832 /* Save old value to support transaction abort */
5834 push_old_value(&conf->gen, action);
5836 if (conf->assign_hook)
5837 (*conf->assign_hook) (newval, newextra);
5838 *conf->variable = newval;
5839 set_extra_field(&conf->gen, &conf->gen.extra,
5841 conf->gen.source = source;
5842 conf->gen.scontext = context;
5848 if (conf->gen.reset_source <= source)
5850 conf->reset_val = newval;
5851 set_extra_field(&conf->gen, &conf->reset_extra,
5853 conf->gen.reset_source = source;
5854 conf->gen.reset_scontext = context;
5856 for (stack = conf->gen.stack; stack; stack = stack->prev)
5858 if (stack->source <= source)
5860 stack->prior.val.enumval = newval;
5861 set_extra_field(&conf->gen, &stack->prior.extra,
5863 stack->source = source;
5864 stack->scontext = context;
5869 /* Perhaps we didn't install newextra anywhere */
5870 if (newextra && !extra_field_used(&conf->gen, newextra))
5876 if (changeVal && (record->flags & GUC_REPORT))
5877 ReportGUCOption(record);
5879 return changeVal ? 1 : -1;
5884 * Set the fields for source file and line number the setting came from.
5887 set_config_sourcefile(const char *name, char *sourcefile, int sourceline)
5889 struct config_generic *record;
5893 * To avoid cluttering the log, only the postmaster bleats loudly about
5894 * problems with the config file.
5896 elevel = IsUnderPostmaster ? DEBUG3 : LOG;
5898 record = find_option(name, true, elevel);
5899 /* should not happen */
5901 elog(ERROR, "unrecognized configuration parameter \"%s\"", name);
5903 sourcefile = guc_strdup(elevel, sourcefile);
5904 if (record->sourcefile)
5905 free(record->sourcefile);
5906 record->sourcefile = sourcefile;
5907 record->sourceline = sourceline;
5911 * Set a config option to the given value.
5913 * See also set_config_option; this is just the wrapper to be called from
5914 * outside GUC. (This function should be used when possible, because its API
5915 * is more stable than set_config_option's.)
5917 * Note: there is no support here for setting source file/line, as it
5918 * is currently not needed.
5921 SetConfigOption(const char *name, const char *value,
5922 GucContext context, GucSource source)
5924 (void) set_config_option(name, value, context, source,
5925 GUC_ACTION_SET, true, 0);
5931 * Fetch the current value of the option `name', as a string.
5933 * If the option doesn't exist, return NULL if missing_ok is true (NOTE that
5934 * this cannot be distinguished from a string variable with a NULL value!),
5935 * otherwise throw an ereport and don't return.
5937 * If restrict_superuser is true, we also enforce that only superusers can
5938 * see GUC_SUPERUSER_ONLY variables. This should only be passed as true
5939 * in user-driven calls.
5941 * The string is *not* allocated for modification and is really only
5942 * valid until the next call to configuration related functions.
5945 GetConfigOption(const char *name, bool missing_ok, bool restrict_superuser)
5947 struct config_generic *record;
5948 static char buffer[256];
5950 record = find_option(name, false, ERROR);
5956 (errcode(ERRCODE_UNDEFINED_OBJECT),
5957 errmsg("unrecognized configuration parameter \"%s\"",
5960 if (restrict_superuser &&
5961 (record->flags & GUC_SUPERUSER_ONLY) &&
5964 (errcode(ERRCODE_INSUFFICIENT_PRIVILEGE),
5965 errmsg("must be superuser to examine \"%s\"", name)));
5967 switch (record->vartype)
5970 return *((struct config_bool *) record)->variable ? "on" : "off";
5973 snprintf(buffer, sizeof(buffer), "%d",
5974 *((struct config_int *) record)->variable);
5978 snprintf(buffer, sizeof(buffer), "%g",
5979 *((struct config_real *) record)->variable);
5983 return *((struct config_string *) record)->variable;
5986 return config_enum_lookup_by_value((struct config_enum *) record,
5987 *((struct config_enum *) record)->variable);
5993 * Get the RESET value associated with the given option.
5995 * Note: this is not re-entrant, due to use of static result buffer;
5996 * not to mention that a string variable could have its reset_val changed.
5997 * Beware of assuming the result value is good for very long.
6000 GetConfigOptionResetString(const char *name)
6002 struct config_generic *record;
6003 static char buffer[256];
6005 record = find_option(name, false, ERROR);
6008 (errcode(ERRCODE_UNDEFINED_OBJECT),
6009 errmsg("unrecognized configuration parameter \"%s\"", name)));
6010 if ((record->flags & GUC_SUPERUSER_ONLY) && !superuser())
6012 (errcode(ERRCODE_INSUFFICIENT_PRIVILEGE),
6013 errmsg("must be superuser to examine \"%s\"", name)));
6015 switch (record->vartype)
6018 return ((struct config_bool *) record)->reset_val ? "on" : "off";
6021 snprintf(buffer, sizeof(buffer), "%d",
6022 ((struct config_int *) record)->reset_val);
6026 snprintf(buffer, sizeof(buffer), "%g",
6027 ((struct config_real *) record)->reset_val);
6031 return ((struct config_string *) record)->reset_val;
6034 return config_enum_lookup_by_value((struct config_enum *) record,
6035 ((struct config_enum *) record)->reset_val);
6042 * flatten_set_variable_args
6043 * Given a parsenode List as emitted by the grammar for SET,
6044 * convert to the flat string representation used by GUC.
6046 * We need to be told the name of the variable the args are for, because
6047 * the flattening rules vary (ugh).
6049 * The result is NULL if args is NIL (ie, SET ... TO DEFAULT), otherwise
6050 * a palloc'd string.
6053 flatten_set_variable_args(const char *name, List *args)
6055 struct config_generic *record;
6060 /* Fast path if just DEFAULT */
6065 * Get flags for the variable; if it's not known, use default flags.
6066 * (Caller might throw error later, but not our business to do so here.)
6068 record = find_option(name, false, WARNING);
6070 flags = record->flags;
6074 /* Complain if list input and non-list variable */
6075 if ((flags & GUC_LIST_INPUT) == 0 &&
6076 list_length(args) != 1)
6078 (errcode(ERRCODE_INVALID_PARAMETER_VALUE),
6079 errmsg("SET %s takes only one argument", name)));
6081 initStringInfo(&buf);
6084 * Each list member may be a plain A_Const node, or an A_Const within a
6085 * TypeCast; the latter case is supported only for ConstInterval arguments
6086 * (for SET TIME ZONE).
6090 Node *arg = (Node *) lfirst(l);
6092 TypeName *typeName = NULL;
6095 if (l != list_head(args))
6096 appendStringInfo(&buf, ", ");
6098 if (IsA(arg, TypeCast))
6100 TypeCast *tc = (TypeCast *) arg;
6103 typeName = tc->typeName;
6106 if (!IsA(arg, A_Const))
6107 elog(ERROR, "unrecognized node type: %d", (int) nodeTag(arg));
6108 con = (A_Const *) arg;
6110 switch (nodeTag(&con->val))
6113 appendStringInfo(&buf, "%ld", intVal(&con->val));
6116 /* represented as a string, so just copy it */
6117 appendStringInfoString(&buf, strVal(&con->val));
6120 val = strVal(&con->val);
6121 if (typeName != NULL)
6124 * Must be a ConstInterval argument for TIME ZONE. Coerce
6125 * to interval and back to normalize the value and account
6133 typenameTypeIdAndMod(NULL, typeName, &typoid, &typmod);
6134 Assert(typoid == INTERVALOID);
6137 DirectFunctionCall3(interval_in,
6138 CStringGetDatum(val),
6139 ObjectIdGetDatum(InvalidOid),
6140 Int32GetDatum(typmod));
6143 DatumGetCString(DirectFunctionCall1(interval_out,
6145 appendStringInfo(&buf, "INTERVAL '%s'", intervalout);
6150 * Plain string literal or identifier. For quote mode,
6151 * quote it if it's not a vanilla identifier.
6153 if (flags & GUC_LIST_QUOTE)
6154 appendStringInfoString(&buf, quote_identifier(val));
6156 appendStringInfoString(&buf, val);
6160 elog(ERROR, "unrecognized node type: %d",
6161 (int) nodeTag(&con->val));
6174 ExecSetVariableStmt(VariableSetStmt *stmt)
6176 GucAction action = stmt->is_local ? GUC_ACTION_LOCAL : GUC_ACTION_SET;
6181 case VAR_SET_CURRENT:
6182 (void) set_config_option(stmt->name,
6183 ExtractSetVariableArgs(stmt),
6184 (superuser() ? PGC_SUSET : PGC_USERSET),
6193 * Special-case SQL syntaxes. The TRANSACTION and SESSION
6194 * CHARACTERISTICS cases effectively set more than one variable
6195 * per statement. TRANSACTION SNAPSHOT only takes one argument,
6196 * but we put it here anyway since it's a special case and not
6197 * related to any GUC variable.
6199 if (strcmp(stmt->name, "TRANSACTION") == 0)
6203 foreach(head, stmt->args)
6205 DefElem *item = (DefElem *) lfirst(head);
6207 if (strcmp(item->defname, "transaction_isolation") == 0)
6208 SetPGVariable("transaction_isolation",
6209 list_make1(item->arg), stmt->is_local);
6210 else if (strcmp(item->defname, "transaction_read_only") == 0)
6211 SetPGVariable("transaction_read_only",
6212 list_make1(item->arg), stmt->is_local);
6213 else if (strcmp(item->defname, "transaction_deferrable") == 0)
6214 SetPGVariable("transaction_deferrable",
6215 list_make1(item->arg), stmt->is_local);
6217 elog(ERROR, "unexpected SET TRANSACTION element: %s",
6221 else if (strcmp(stmt->name, "SESSION CHARACTERISTICS") == 0)
6225 foreach(head, stmt->args)
6227 DefElem *item = (DefElem *) lfirst(head);
6229 if (strcmp(item->defname, "transaction_isolation") == 0)
6230 SetPGVariable("default_transaction_isolation",
6231 list_make1(item->arg), stmt->is_local);
6232 else if (strcmp(item->defname, "transaction_read_only") == 0)
6233 SetPGVariable("default_transaction_read_only",
6234 list_make1(item->arg), stmt->is_local);
6235 else if (strcmp(item->defname, "transaction_deferrable") == 0)
6236 SetPGVariable("default_transaction_deferrable",
6237 list_make1(item->arg), stmt->is_local);
6239 elog(ERROR, "unexpected SET SESSION element: %s",
6243 else if (strcmp(stmt->name, "TRANSACTION SNAPSHOT") == 0)
6245 A_Const *con = (A_Const *) linitial(stmt->args);
6249 (errcode(ERRCODE_FEATURE_NOT_SUPPORTED),
6250 errmsg("SET LOCAL TRANSACTION SNAPSHOT is not implemented")));
6251 Assert(IsA(con, A_Const));
6252 Assert(nodeTag(&con->val) == T_String);
6253 ImportSnapshot(strVal(&con->val));
6256 elog(ERROR, "unexpected SET MULTI element: %s",
6259 case VAR_SET_DEFAULT:
6261 (void) set_config_option(stmt->name,
6263 (superuser() ? PGC_SUSET : PGC_USERSET),
6276 * Get the value to assign for a VariableSetStmt, or NULL if it's RESET.
6277 * The result is palloc'd.
6279 * This is exported for use by actions such as ALTER ROLE SET.
6282 ExtractSetVariableArgs(VariableSetStmt *stmt)
6287 return flatten_set_variable_args(stmt->name, stmt->args);
6288 case VAR_SET_CURRENT:
6289 return GetConfigOptionByName(stmt->name, NULL);
6296 * SetPGVariable - SET command exported as an easily-C-callable function.
6298 * This provides access to SET TO value, as well as SET TO DEFAULT (expressed
6299 * by passing args == NIL), but not SET FROM CURRENT functionality.
6302 SetPGVariable(const char *name, List *args, bool is_local)
6304 char *argstring = flatten_set_variable_args(name, args);
6306 /* Note SET DEFAULT (argstring == NULL) is equivalent to RESET */
6307 (void) set_config_option(name,
6309 (superuser() ? PGC_SUSET : PGC_USERSET),
6311 is_local ? GUC_ACTION_LOCAL : GUC_ACTION_SET,
6317 * SET command wrapped as a SQL callable function.
6320 set_config_by_name(PG_FUNCTION_ARGS)
6327 if (PG_ARGISNULL(0))
6329 (errcode(ERRCODE_NULL_VALUE_NOT_ALLOWED),
6330 errmsg("SET requires parameter name")));
6332 /* Get the GUC variable name */
6333 name = TextDatumGetCString(PG_GETARG_DATUM(0));
6335 /* Get the desired value or set to NULL for a reset request */
6336 if (PG_ARGISNULL(1))
6339 value = TextDatumGetCString(PG_GETARG_DATUM(1));
6342 * Get the desired state of is_local. Default to false if provided value
6345 if (PG_ARGISNULL(2))
6348 is_local = PG_GETARG_BOOL(2);
6350 /* Note SET DEFAULT (argstring == NULL) is equivalent to RESET */
6351 (void) set_config_option(name,
6353 (superuser() ? PGC_SUSET : PGC_USERSET),
6355 is_local ? GUC_ACTION_LOCAL : GUC_ACTION_SET,
6359 /* get the new current value */
6360 new_value = GetConfigOptionByName(name, NULL);
6362 /* Convert return string to text */
6363 PG_RETURN_TEXT_P(cstring_to_text(new_value));
6368 * Common code for DefineCustomXXXVariable subroutines: allocate the
6369 * new variable's config struct and fill in generic fields.
6371 static struct config_generic *
6372 init_custom_variable(const char *name,
6373 const char *short_desc,
6374 const char *long_desc,
6377 enum config_type type,
6380 struct config_generic *gen;
6383 * Only allow custom PGC_POSTMASTER variables to be created during shared
6384 * library preload; any later than that, we can't ensure that the value
6385 * doesn't change after startup. This is a fatal elog if it happens; just
6386 * erroring out isn't safe because we don't know what the calling loadable
6387 * module might already have hooked into.
6389 if (context == PGC_POSTMASTER &&
6390 !process_shared_preload_libraries_in_progress)
6391 elog(FATAL, "cannot create PGC_POSTMASTER variables after startup");
6393 gen = (struct config_generic *) guc_malloc(ERROR, sz);
6396 gen->name = guc_strdup(ERROR, name);
6397 gen->context = context;
6398 gen->group = CUSTOM_OPTIONS;
6399 gen->short_desc = short_desc;
6400 gen->long_desc = long_desc;
6402 gen->vartype = type;
6408 * Common code for DefineCustomXXXVariable subroutines: insert the new
6409 * variable into the GUC variable array, replacing any placeholder.
6412 define_custom_variable(struct config_generic * variable)
6414 const char *name = variable->name;
6415 const char **nameAddr = &name;
6416 struct config_string *pHolder;
6417 struct config_generic **res;
6420 * See if there's a placeholder by the same name.
6422 res = (struct config_generic **) bsearch((void *) &nameAddr,
6423 (void *) guc_variables,
6425 sizeof(struct config_generic *),
6430 * No placeholder to replace, so we can just add it ... but first,
6431 * make sure it's initialized to its default value.
6433 InitializeOneGUCOption(variable);
6434 add_guc_variable(variable, ERROR);
6439 * This better be a placeholder
6441 if (((*res)->flags & GUC_CUSTOM_PLACEHOLDER) == 0)
6443 (errcode(ERRCODE_INTERNAL_ERROR),
6444 errmsg("attempt to redefine parameter \"%s\"", name)));
6446 Assert((*res)->vartype == PGC_STRING);
6447 pHolder = (struct config_string *) (*res);
6450 * First, set the variable to its default value. We must do this even
6451 * though we intend to immediately apply a new value, since it's possible
6452 * that the new value is invalid.
6454 InitializeOneGUCOption(variable);
6457 * Replace the placeholder. We aren't changing the name, so no re-sorting
6463 * Assign the string value(s) stored in the placeholder to the real
6464 * variable. Essentially, we need to duplicate all the active and stacked
6465 * values, but with appropriate validation and datatype adjustment.
6467 * If an assignment fails, we report a WARNING and keep going. We don't
6468 * want to throw ERROR for bad values, because it'd bollix the add-on
6469 * module that's presumably halfway through getting loaded. In such cases
6470 * the default or previous state will become active instead.
6473 /* First, apply the reset value if any */
6474 if (pHolder->reset_val)
6475 (void) set_config_option(name, pHolder->reset_val,
6476 pHolder->gen.reset_scontext,
6477 pHolder->gen.reset_source,
6478 GUC_ACTION_SET, true, WARNING);
6479 /* That should not have resulted in stacking anything */
6480 Assert(variable->stack == NULL);
6482 /* Now, apply current and stacked values, in the order they were stacked */
6483 reapply_stacked_values(variable, pHolder, pHolder->gen.stack,
6484 *(pHolder->variable),
6485 pHolder->gen.scontext, pHolder->gen.source);
6487 /* Also copy over any saved source-location information */
6488 if (pHolder->gen.sourcefile)
6489 set_config_sourcefile(name, pHolder->gen.sourcefile,
6490 pHolder->gen.sourceline);
6493 * Free up as much as we conveniently can of the placeholder structure.
6494 * (This neglects any stack items, so it's possible for some memory to be
6495 * leaked. Since this can only happen once per session per variable, it
6496 * doesn't seem worth spending much code on.)
6498 set_string_field(pHolder, pHolder->variable, NULL);
6499 set_string_field(pHolder, &pHolder->reset_val, NULL);
6505 * Recursive subroutine for define_custom_variable: reapply non-reset values
6507 * We recurse so that the values are applied in the same order as originally.
6508 * At each recursion level, apply the upper-level value (passed in) in the
6509 * fashion implied by the stack entry.
6512 reapply_stacked_values(struct config_generic * variable,
6513 struct config_string * pHolder,
6515 const char *curvalue,
6516 GucContext curscontext, GucSource cursource)
6518 const char *name = variable->name;
6519 GucStack *oldvarstack = variable->stack;
6523 /* First, recurse, so that stack items are processed bottom to top */
6524 reapply_stacked_values(variable, pHolder, stack->prev,
6525 stack->prior.val.stringval,
6526 stack->scontext, stack->source);
6528 /* See how to apply the passed-in value */
6529 switch (stack->state)
6532 (void) set_config_option(name, curvalue,
6533 curscontext, cursource,
6534 GUC_ACTION_SAVE, true, WARNING);
6538 (void) set_config_option(name, curvalue,
6539 curscontext, cursource,
6540 GUC_ACTION_SET, true, WARNING);
6544 (void) set_config_option(name, curvalue,
6545 curscontext, cursource,
6546 GUC_ACTION_LOCAL, true, WARNING);
6550 /* first, apply the masked value as SET */
6551 (void) set_config_option(name, stack->masked.val.stringval,
6552 stack->masked_scontext, PGC_S_SESSION,
6553 GUC_ACTION_SET, true, WARNING);
6554 /* then apply the current value as LOCAL */
6555 (void) set_config_option(name, curvalue,
6556 curscontext, cursource,
6557 GUC_ACTION_LOCAL, true, WARNING);
6561 /* If we successfully made a stack entry, adjust its nest level */
6562 if (variable->stack != oldvarstack)
6563 variable->stack->nest_level = stack->nest_level;
6568 * We are at the end of the stack. If the active/previous value is
6569 * different from the reset value, it must represent a previously
6570 * committed session value. Apply it, and then drop the stack entry
6571 * that set_config_option will have created under the impression that
6572 * this is to be just a transactional assignment. (We leak the stack
6575 if (curvalue != pHolder->reset_val ||
6576 curscontext != pHolder->gen.reset_scontext ||
6577 cursource != pHolder->gen.reset_source)
6579 (void) set_config_option(name, curvalue,
6580 curscontext, cursource,
6581 GUC_ACTION_SET, true, WARNING);
6582 variable->stack = NULL;
6588 DefineCustomBoolVariable(const char *name,
6589 const char *short_desc,
6590 const char *long_desc,
6595 GucBoolCheckHook check_hook,
6596 GucBoolAssignHook assign_hook,
6597 GucShowHook show_hook)
6599 struct config_bool *var;
6601 var = (struct config_bool *)
6602 init_custom_variable(name, short_desc, long_desc, context, flags,
6603 PGC_BOOL, sizeof(struct config_bool));
6604 var->variable = valueAddr;
6605 var->boot_val = bootValue;
6606 var->reset_val = bootValue;
6607 var->check_hook = check_hook;
6608 var->assign_hook = assign_hook;
6609 var->show_hook = show_hook;
6610 define_custom_variable(&var->gen);
6614 DefineCustomIntVariable(const char *name,
6615 const char *short_desc,
6616 const char *long_desc,
6623 GucIntCheckHook check_hook,
6624 GucIntAssignHook assign_hook,
6625 GucShowHook show_hook)
6627 struct config_int *var;
6629 var = (struct config_int *)
6630 init_custom_variable(name, short_desc, long_desc, context, flags,
6631 PGC_INT, sizeof(struct config_int));
6632 var->variable = valueAddr;
6633 var->boot_val = bootValue;
6634 var->reset_val = bootValue;
6635 var->min = minValue;
6636 var->max = maxValue;
6637 var->check_hook = check_hook;
6638 var->assign_hook = assign_hook;
6639 var->show_hook = show_hook;
6640 define_custom_variable(&var->gen);
6644 DefineCustomRealVariable(const char *name,
6645 const char *short_desc,
6646 const char *long_desc,
6653 GucRealCheckHook check_hook,
6654 GucRealAssignHook assign_hook,
6655 GucShowHook show_hook)
6657 struct config_real *var;
6659 var = (struct config_real *)
6660 init_custom_variable(name, short_desc, long_desc, context, flags,
6661 PGC_REAL, sizeof(struct config_real));
6662 var->variable = valueAddr;
6663 var->boot_val = bootValue;
6664 var->reset_val = bootValue;
6665 var->min = minValue;
6666 var->max = maxValue;
6667 var->check_hook = check_hook;
6668 var->assign_hook = assign_hook;
6669 var->show_hook = show_hook;
6670 define_custom_variable(&var->gen);
6674 DefineCustomStringVariable(const char *name,
6675 const char *short_desc,
6676 const char *long_desc,
6678 const char *bootValue,
6681 GucStringCheckHook check_hook,
6682 GucStringAssignHook assign_hook,
6683 GucShowHook show_hook)
6685 struct config_string *var;
6687 var = (struct config_string *)
6688 init_custom_variable(name, short_desc, long_desc, context, flags,
6689 PGC_STRING, sizeof(struct config_string));
6690 var->variable = valueAddr;
6691 var->boot_val = bootValue;
6692 var->check_hook = check_hook;
6693 var->assign_hook = assign_hook;
6694 var->show_hook = show_hook;
6695 define_custom_variable(&var->gen);
6699 DefineCustomEnumVariable(const char *name,
6700 const char *short_desc,
6701 const char *long_desc,
6704 const struct config_enum_entry * options,
6707 GucEnumCheckHook check_hook,
6708 GucEnumAssignHook assign_hook,
6709 GucShowHook show_hook)
6711 struct config_enum *var;
6713 var = (struct config_enum *)
6714 init_custom_variable(name, short_desc, long_desc, context, flags,
6715 PGC_ENUM, sizeof(struct config_enum));
6716 var->variable = valueAddr;
6717 var->boot_val = bootValue;
6718 var->reset_val = bootValue;
6719 var->options = options;
6720 var->check_hook = check_hook;
6721 var->assign_hook = assign_hook;
6722 var->show_hook = show_hook;
6723 define_custom_variable(&var->gen);
6727 EmitWarningsOnPlaceholders(const char *className)
6729 int classLen = strlen(className);
6732 for (i = 0; i < num_guc_variables; i++)
6734 struct config_generic *var = guc_variables[i];
6736 if ((var->flags & GUC_CUSTOM_PLACEHOLDER) != 0 &&
6737 strncmp(className, var->name, classLen) == 0 &&
6738 var->name[classLen] == GUC_QUALIFIER_SEPARATOR)
6741 (errcode(ERRCODE_UNDEFINED_OBJECT),
6742 errmsg("unrecognized configuration parameter \"%s\"",
6753 GetPGVariable(const char *name, DestReceiver *dest)
6755 if (guc_name_compare(name, "all") == 0)
6756 ShowAllGUCConfig(dest);
6758 ShowGUCConfigOption(name, dest);
6762 GetPGVariableResultDesc(const char *name)
6766 if (guc_name_compare(name, "all") == 0)
6768 /* need a tuple descriptor representing three TEXT columns */
6769 tupdesc = CreateTemplateTupleDesc(3, false);
6770 TupleDescInitEntry(tupdesc, (AttrNumber) 1, "name",
6772 TupleDescInitEntry(tupdesc, (AttrNumber) 2, "setting",
6774 TupleDescInitEntry(tupdesc, (AttrNumber) 3, "description",
6779 const char *varname;
6781 /* Get the canonical spelling of name */
6782 (void) GetConfigOptionByName(name, &varname);
6784 /* need a tuple descriptor representing a single TEXT column */
6785 tupdesc = CreateTemplateTupleDesc(1, false);
6786 TupleDescInitEntry(tupdesc, (AttrNumber) 1, varname,
6797 ShowGUCConfigOption(const char *name, DestReceiver *dest)
6799 TupOutputState *tstate;
6801 const char *varname;
6804 /* Get the value and canonical spelling of name */
6805 value = GetConfigOptionByName(name, &varname);
6807 /* need a tuple descriptor representing a single TEXT column */
6808 tupdesc = CreateTemplateTupleDesc(1, false);
6809 TupleDescInitEntry(tupdesc, (AttrNumber) 1, varname,
6812 /* prepare for projection of tuples */
6813 tstate = begin_tup_output_tupdesc(dest, tupdesc);
6816 do_text_output_oneline(tstate, value);
6818 end_tup_output(tstate);
6825 ShowAllGUCConfig(DestReceiver *dest)
6827 bool am_superuser = superuser();
6829 TupOutputState *tstate;
6832 bool isnull[3] = {false, false, false};
6834 /* need a tuple descriptor representing three TEXT columns */
6835 tupdesc = CreateTemplateTupleDesc(3, false);
6836 TupleDescInitEntry(tupdesc, (AttrNumber) 1, "name",
6838 TupleDescInitEntry(tupdesc, (AttrNumber) 2, "setting",
6840 TupleDescInitEntry(tupdesc, (AttrNumber) 3, "description",
6843 /* prepare for projection of tuples */
6844 tstate = begin_tup_output_tupdesc(dest, tupdesc);
6846 for (i = 0; i < num_guc_variables; i++)
6848 struct config_generic *conf = guc_variables[i];
6851 if ((conf->flags & GUC_NO_SHOW_ALL) ||
6852 ((conf->flags & GUC_SUPERUSER_ONLY) && !am_superuser))
6855 /* assign to the values array */
6856 values[0] = PointerGetDatum(cstring_to_text(conf->name));
6858 setting = _ShowOption(conf, true);
6861 values[1] = PointerGetDatum(cstring_to_text(setting));
6866 values[1] = PointerGetDatum(NULL);
6870 values[2] = PointerGetDatum(cstring_to_text(conf->short_desc));
6872 /* send it to dest */
6873 do_tup_output(tstate, values, isnull);
6876 pfree(DatumGetPointer(values[0]));
6880 pfree(DatumGetPointer(values[1]));
6882 pfree(DatumGetPointer(values[2]));
6885 end_tup_output(tstate);
6889 * Return GUC variable value by name; optionally return canonical
6890 * form of name. Return value is palloc'd.
6893 GetConfigOptionByName(const char *name, const char **varname)
6895 struct config_generic *record;
6897 record = find_option(name, false, ERROR);
6900 (errcode(ERRCODE_UNDEFINED_OBJECT),
6901 errmsg("unrecognized configuration parameter \"%s\"", name)));
6902 if ((record->flags & GUC_SUPERUSER_ONLY) && !superuser())
6904 (errcode(ERRCODE_INSUFFICIENT_PRIVILEGE),
6905 errmsg("must be superuser to examine \"%s\"", name)));
6908 *varname = record->name;
6910 return _ShowOption(record, true);
6914 * Return GUC variable value by variable number; optionally return canonical
6915 * form of name. Return value is palloc'd.
6918 GetConfigOptionByNum(int varnum, const char **values, bool *noshow)
6921 struct config_generic *conf;
6923 /* check requested variable number valid */
6924 Assert((varnum >= 0) && (varnum < num_guc_variables));
6926 conf = guc_variables[varnum];
6930 if ((conf->flags & GUC_NO_SHOW_ALL) ||
6931 ((conf->flags & GUC_SUPERUSER_ONLY) && !superuser()))
6937 /* first get the generic attributes */
6940 values[0] = conf->name;
6942 /* setting : use _ShowOption in order to avoid duplicating the logic */
6943 values[1] = _ShowOption(conf, false);
6946 if (conf->vartype == PGC_INT)
6950 switch (conf->flags & (GUC_UNIT_MEMORY | GUC_UNIT_TIME))
6955 case GUC_UNIT_BLOCKS:
6956 snprintf(buf, sizeof(buf), "%dkB", BLCKSZ / 1024);
6959 case GUC_UNIT_XBLOCKS:
6960 snprintf(buf, sizeof(buf), "%dkB", XLOG_BLCKSZ / 1024);
6981 values[3] = config_group_names[conf->group];
6984 values[4] = conf->short_desc;
6987 values[5] = conf->long_desc;
6990 values[6] = GucContext_Names[conf->context];
6993 values[7] = config_type_names[conf->vartype];
6996 values[8] = GucSource_Names[conf->source];
6998 /* now get the type specifc attributes */
6999 switch (conf->vartype)
7003 struct config_bool *lconf = (struct config_bool *) conf;
7015 values[12] = pstrdup(lconf->boot_val ? "on" : "off");
7018 values[13] = pstrdup(lconf->reset_val ? "on" : "off");
7024 struct config_int *lconf = (struct config_int *) conf;
7027 snprintf(buffer, sizeof(buffer), "%d", lconf->min);
7028 values[9] = pstrdup(buffer);
7031 snprintf(buffer, sizeof(buffer), "%d", lconf->max);
7032 values[10] = pstrdup(buffer);
7038 snprintf(buffer, sizeof(buffer), "%d", lconf->boot_val);
7039 values[12] = pstrdup(buffer);
7042 snprintf(buffer, sizeof(buffer), "%d", lconf->reset_val);
7043 values[13] = pstrdup(buffer);
7049 struct config_real *lconf = (struct config_real *) conf;
7052 snprintf(buffer, sizeof(buffer), "%g", lconf->min);
7053 values[9] = pstrdup(buffer);
7056 snprintf(buffer, sizeof(buffer), "%g", lconf->max);
7057 values[10] = pstrdup(buffer);
7063 snprintf(buffer, sizeof(buffer), "%g", lconf->boot_val);
7064 values[12] = pstrdup(buffer);
7067 snprintf(buffer, sizeof(buffer), "%g", lconf->reset_val);
7068 values[13] = pstrdup(buffer);
7074 struct config_string *lconf = (struct config_string *) conf;
7086 if (lconf->boot_val == NULL)
7089 values[12] = pstrdup(lconf->boot_val);
7092 if (lconf->reset_val == NULL)
7095 values[13] = pstrdup(lconf->reset_val);
7101 struct config_enum *lconf = (struct config_enum *) conf;
7112 * NOTE! enumvals with double quotes in them are not
7115 values[11] = config_enum_get_options((struct config_enum *) conf,
7116 "{\"", "\"}", "\",\"");
7119 values[12] = pstrdup(config_enum_lookup_by_value(lconf,
7123 values[13] = pstrdup(config_enum_lookup_by_value(lconf,
7131 * should never get here, but in case we do, set 'em to NULL
7153 * If the setting came from a config file, set the source location. For
7154 * security reasons, we don't show source file/line number for
7157 if (conf->source == PGC_S_FILE && superuser())
7159 values[14] = conf->sourcefile;
7160 snprintf(buffer, sizeof(buffer), "%d", conf->sourceline);
7161 values[15] = pstrdup(buffer);
7171 * Return the total number of GUC variables
7174 GetNumConfigOptions(void)
7176 return num_guc_variables;
7180 * show_config_by_name - equiv to SHOW X command but implemented as
7184 show_config_by_name(PG_FUNCTION_ARGS)
7189 /* Get the GUC variable name */
7190 varname = TextDatumGetCString(PG_GETARG_DATUM(0));
7193 varval = GetConfigOptionByName(varname, NULL);
7195 /* Convert to text */
7196 PG_RETURN_TEXT_P(cstring_to_text(varval));
7200 * show_all_settings - equiv to SHOW ALL command but implemented as
7203 #define NUM_PG_SETTINGS_ATTS 16
7206 show_all_settings(PG_FUNCTION_ARGS)
7208 FuncCallContext *funcctx;
7212 AttInMetadata *attinmeta;
7213 MemoryContext oldcontext;
7215 /* stuff done only on the first call of the function */
7216 if (SRF_IS_FIRSTCALL())
7218 /* create a function context for cross-call persistence */
7219 funcctx = SRF_FIRSTCALL_INIT();
7222 * switch to memory context appropriate for multiple function calls
7224 oldcontext = MemoryContextSwitchTo(funcctx->multi_call_memory_ctx);
7227 * need a tuple descriptor representing NUM_PG_SETTINGS_ATTS columns
7228 * of the appropriate types
7230 tupdesc = CreateTemplateTupleDesc(NUM_PG_SETTINGS_ATTS, false);
7231 TupleDescInitEntry(tupdesc, (AttrNumber) 1, "name",
7233 TupleDescInitEntry(tupdesc, (AttrNumber) 2, "setting",
7235 TupleDescInitEntry(tupdesc, (AttrNumber) 3, "unit",
7237 TupleDescInitEntry(tupdesc, (AttrNumber) 4, "category",
7239 TupleDescInitEntry(tupdesc, (AttrNumber) 5, "short_desc",
7241 TupleDescInitEntry(tupdesc, (AttrNumber) 6, "extra_desc",
7243 TupleDescInitEntry(tupdesc, (AttrNumber) 7, "context",
7245 TupleDescInitEntry(tupdesc, (AttrNumber) 8, "vartype",
7247 TupleDescInitEntry(tupdesc, (AttrNumber) 9, "source",
7249 TupleDescInitEntry(tupdesc, (AttrNumber) 10, "min_val",
7251 TupleDescInitEntry(tupdesc, (AttrNumber) 11, "max_val",
7253 TupleDescInitEntry(tupdesc, (AttrNumber) 12, "enumvals",
7254 TEXTARRAYOID, -1, 0);
7255 TupleDescInitEntry(tupdesc, (AttrNumber) 13, "boot_val",
7257 TupleDescInitEntry(tupdesc, (AttrNumber) 14, "reset_val",
7259 TupleDescInitEntry(tupdesc, (AttrNumber) 15, "sourcefile",
7261 TupleDescInitEntry(tupdesc, (AttrNumber) 16, "sourceline",
7265 * Generate attribute metadata needed later to produce tuples from raw
7268 attinmeta = TupleDescGetAttInMetadata(tupdesc);
7269 funcctx->attinmeta = attinmeta;
7271 /* total number of tuples to be returned */
7272 funcctx->max_calls = GetNumConfigOptions();
7274 MemoryContextSwitchTo(oldcontext);
7277 /* stuff done on every call of the function */
7278 funcctx = SRF_PERCALL_SETUP();
7280 call_cntr = funcctx->call_cntr;
7281 max_calls = funcctx->max_calls;
7282 attinmeta = funcctx->attinmeta;
7284 if (call_cntr < max_calls) /* do when there is more left to send */
7286 char *values[NUM_PG_SETTINGS_ATTS];
7292 * Get the next visible GUC variable name and value
7296 GetConfigOptionByNum(call_cntr, (const char **) values, &noshow);
7299 /* bump the counter and get the next config setting */
7300 call_cntr = ++funcctx->call_cntr;
7302 /* make sure we haven't gone too far now */
7303 if (call_cntr >= max_calls)
7304 SRF_RETURN_DONE(funcctx);
7309 tuple = BuildTupleFromCStrings(attinmeta, values);
7311 /* make the tuple into a datum */
7312 result = HeapTupleGetDatum(tuple);
7314 SRF_RETURN_NEXT(funcctx, result);
7318 /* do when there is no more left */
7319 SRF_RETURN_DONE(funcctx);
7324 _ShowOption(struct config_generic * record, bool use_units)
7329 switch (record->vartype)
7333 struct config_bool *conf = (struct config_bool *) record;
7335 if (conf->show_hook)
7336 val = (*conf->show_hook) ();
7338 val = *conf->variable ? "on" : "off";
7344 struct config_int *conf = (struct config_int *) record;
7346 if (conf->show_hook)
7347 val = (*conf->show_hook) ();
7351 * Use int64 arithmetic to avoid overflows in units
7354 int64 result = *conf->variable;
7357 if (use_units && result > 0 &&
7358 (record->flags & GUC_UNIT_MEMORY))
7360 switch (record->flags & GUC_UNIT_MEMORY)
7362 case GUC_UNIT_BLOCKS:
7363 result *= BLCKSZ / 1024;
7365 case GUC_UNIT_XBLOCKS:
7366 result *= XLOG_BLCKSZ / 1024;
7370 if (result % KB_PER_GB == 0)
7372 result /= KB_PER_GB;
7375 else if (result % KB_PER_MB == 0)
7377 result /= KB_PER_MB;
7385 else if (use_units && result > 0 &&
7386 (record->flags & GUC_UNIT_TIME))
7388 switch (record->flags & GUC_UNIT_TIME)
7394 result *= MS_PER_MIN;
7398 if (result % MS_PER_D == 0)
7403 else if (result % MS_PER_H == 0)
7408 else if (result % MS_PER_MIN == 0)
7410 result /= MS_PER_MIN;
7413 else if (result % MS_PER_S == 0)
7426 snprintf(buffer, sizeof(buffer), INT64_FORMAT "%s",
7435 struct config_real *conf = (struct config_real *) record;
7437 if (conf->show_hook)
7438 val = (*conf->show_hook) ();
7441 snprintf(buffer, sizeof(buffer), "%g",
7450 struct config_string *conf = (struct config_string *) record;
7452 if (conf->show_hook)
7453 val = (*conf->show_hook) ();
7454 else if (*conf->variable && **conf->variable)
7455 val = *conf->variable;
7463 struct config_enum *conf = (struct config_enum *) record;
7465 if (conf->show_hook)
7466 val = (*conf->show_hook) ();
7468 val = config_enum_lookup_by_value(conf, *conf->variable);
7473 /* just to keep compiler quiet */
7478 return pstrdup(val);
7485 * These routines dump out all non-default GUC options into a binary
7486 * file that is read by all exec'ed backends. The format is:
7488 * variable name, string, null terminated
7489 * variable value, string, null terminated
7490 * variable sourcefile, string, null terminated (empty if none)
7491 * variable sourceline, integer
7492 * variable source, integer
7493 * variable scontext, integer
7496 write_one_nondefault_variable(FILE *fp, struct config_generic * gconf)
7498 if (gconf->source == PGC_S_DEFAULT)
7501 fprintf(fp, "%s", gconf->name);
7504 switch (gconf->vartype)
7508 struct config_bool *conf = (struct config_bool *) gconf;
7510 if (*conf->variable)
7511 fprintf(fp, "true");
7513 fprintf(fp, "false");
7519 struct config_int *conf = (struct config_int *) gconf;
7521 fprintf(fp, "%d", *conf->variable);
7527 struct config_real *conf = (struct config_real *) gconf;
7529 fprintf(fp, "%.17g", *conf->variable);
7535 struct config_string *conf = (struct config_string *) gconf;
7537 fprintf(fp, "%s", *conf->variable);
7543 struct config_enum *conf = (struct config_enum *) gconf;
7546 config_enum_lookup_by_value(conf, *conf->variable));
7553 if (gconf->sourcefile)
7554 fprintf(fp, "%s", gconf->sourcefile);
7557 fwrite(&gconf->sourceline, 1, sizeof(gconf->sourceline), fp);
7558 fwrite(&gconf->source, 1, sizeof(gconf->source), fp);
7559 fwrite(&gconf->scontext, 1, sizeof(gconf->scontext), fp);
7563 write_nondefault_variables(GucContext context)
7569 Assert(context == PGC_POSTMASTER || context == PGC_SIGHUP);
7571 elevel = (context == PGC_SIGHUP) ? LOG : ERROR;
7576 fp = AllocateFile(CONFIG_EXEC_PARAMS_NEW, "w");
7580 (errcode_for_file_access(),
7581 errmsg("could not write to file \"%s\": %m",
7582 CONFIG_EXEC_PARAMS_NEW)));
7586 for (i = 0; i < num_guc_variables; i++)
7588 write_one_nondefault_variable(fp, guc_variables[i]);
7594 (errcode_for_file_access(),
7595 errmsg("could not write to file \"%s\": %m",
7596 CONFIG_EXEC_PARAMS_NEW)));
7601 * Put new file in place. This could delay on Win32, but we don't hold
7602 * any exclusive locks.
7604 rename(CONFIG_EXEC_PARAMS_NEW, CONFIG_EXEC_PARAMS);
7609 * Read string, including null byte from file
7611 * Return NULL on EOF and nothing read
7614 read_string_with_null(FILE *fp)
7623 if ((ch = fgetc(fp)) == EOF)
7628 elog(FATAL, "invalid format of exec config params file");
7631 str = guc_malloc(FATAL, maxlen);
7632 else if (i == maxlen)
7633 str = guc_realloc(FATAL, str, maxlen *= 2);
7642 * This routine loads a previous postmaster dump of its non-default
7646 read_nondefault_variables(void)
7653 GucSource varsource;
7654 GucContext varscontext;
7659 fp = AllocateFile(CONFIG_EXEC_PARAMS, "r");
7662 /* File not found is fine */
7663 if (errno != ENOENT)
7665 (errcode_for_file_access(),
7666 errmsg("could not read from file \"%s\": %m",
7667 CONFIG_EXEC_PARAMS)));
7673 struct config_generic *record;
7675 if ((varname = read_string_with_null(fp)) == NULL)
7678 if ((record = find_option(varname, true, FATAL)) == NULL)
7679 elog(FATAL, "failed to locate variable \"%s\" in exec config params file", varname);
7681 if ((varvalue = read_string_with_null(fp)) == NULL)
7682 elog(FATAL, "invalid format of exec config params file");
7683 if ((varsourcefile = read_string_with_null(fp)) == NULL)
7684 elog(FATAL, "invalid format of exec config params file");
7685 if (fread(&varsourceline, 1, sizeof(varsourceline), fp) != sizeof(varsourceline))
7686 elog(FATAL, "invalid format of exec config params file");
7687 if (fread(&varsource, 1, sizeof(varsource), fp) != sizeof(varsource))
7688 elog(FATAL, "invalid format of exec config params file");
7689 if (fread(&varscontext, 1, sizeof(varscontext), fp) != sizeof(varscontext))
7690 elog(FATAL, "invalid format of exec config params file");
7692 (void) set_config_option(varname, varvalue,
7693 varscontext, varsource,
7694 GUC_ACTION_SET, true, 0);
7695 if (varsourcefile[0])
7696 set_config_sourcefile(varname, varsourcefile, varsourceline);
7700 free(varsourcefile);
7705 #endif /* EXEC_BACKEND */
7709 * A little "long argument" simulation, although not quite GNU
7710 * compliant. Takes a string of the form "some-option=some value" and
7711 * returns name = "some_option" and value = "some value" in malloc'ed
7712 * storage. Note that '-' is converted to '_' in the option name. If
7713 * there is no '=' in the input string then value will be NULL.
7716 ParseLongOption(const char *string, char **name, char **value)
7725 equal_pos = strcspn(string, "=");
7727 if (string[equal_pos] == '=')
7729 *name = guc_malloc(FATAL, equal_pos + 1);
7730 strlcpy(*name, string, equal_pos + 1);
7732 *value = guc_strdup(FATAL, &string[equal_pos + 1]);
7736 /* no equal sign in string */
7737 *name = guc_strdup(FATAL, string);
7741 for (cp = *name; *cp; cp++)
7748 * Handle options fetched from pg_db_role_setting.setconfig,
7749 * pg_proc.proconfig, etc. Caller must specify proper context/source/action.
7751 * The array parameter must be an array of TEXT (it must not be NULL).
7754 ProcessGUCArray(ArrayType *array,
7755 GucContext context, GucSource source, GucAction action)
7759 Assert(array != NULL);
7760 Assert(ARR_ELEMTYPE(array) == TEXTOID);
7761 Assert(ARR_NDIM(array) == 1);
7762 Assert(ARR_LBOUND(array)[0] == 1);
7764 for (i = 1; i <= ARR_DIMS(array)[0]; i++)
7772 d = array_ref(array, 1, &i,
7773 -1 /* varlenarray */ ,
7774 -1 /* TEXT's typlen */ ,
7775 false /* TEXT's typbyval */ ,
7776 'i' /* TEXT's typalign */ ,
7782 s = TextDatumGetCString(d);
7784 ParseLongOption(s, &name, &value);
7788 (errcode(ERRCODE_SYNTAX_ERROR),
7789 errmsg("could not parse setting for parameter \"%s\"",
7795 (void) set_config_option(name, value,
7808 * Add an entry to an option array. The array parameter may be NULL
7809 * to indicate the current table entry is NULL.
7812 GUCArrayAdd(ArrayType *array, const char *name, const char *value)
7814 struct config_generic *record;
7822 /* test if the option is valid and we're allowed to set it */
7823 (void) validate_option_array_item(name, value, false);
7825 /* normalize name (converts obsolete GUC names to modern spellings) */
7826 record = find_option(name, false, WARNING);
7828 name = record->name;
7830 /* build new item for array */
7831 newval = palloc(strlen(name) + 1 + strlen(value) + 1);
7832 sprintf(newval, "%s=%s", name, value);
7833 datum = CStringGetTextDatum(newval);
7841 Assert(ARR_ELEMTYPE(array) == TEXTOID);
7842 Assert(ARR_NDIM(array) == 1);
7843 Assert(ARR_LBOUND(array)[0] == 1);
7845 index = ARR_DIMS(array)[0] + 1; /* add after end */
7847 for (i = 1; i <= ARR_DIMS(array)[0]; i++)
7852 d = array_ref(array, 1, &i,
7853 -1 /* varlenarray */ ,
7854 -1 /* TEXT's typlen */ ,
7855 false /* TEXT's typbyval */ ,
7856 'i' /* TEXT's typalign */ ,
7860 current = TextDatumGetCString(d);
7862 /* check for match up through and including '=' */
7863 if (strncmp(current, newval, strlen(name) + 1) == 0)
7870 a = array_set(array, 1, &index,
7873 -1 /* varlena array */ ,
7874 -1 /* TEXT's typlen */ ,
7875 false /* TEXT's typbyval */ ,
7876 'i' /* TEXT's typalign */ );
7879 a = construct_array(&datum, 1,
7888 * Delete an entry from an option array. The array parameter may be NULL
7889 * to indicate the current table entry is NULL. Also, if the return value
7890 * is NULL then a null should be stored.
7893 GUCArrayDelete(ArrayType *array, const char *name)
7895 struct config_generic *record;
7896 ArrayType *newarray;
7902 /* test if the option is valid and we're allowed to set it */
7903 (void) validate_option_array_item(name, NULL, false);
7905 /* normalize name (converts obsolete GUC names to modern spellings) */
7906 record = find_option(name, false, WARNING);
7908 name = record->name;
7910 /* if array is currently null, then surely nothing to delete */
7917 for (i = 1; i <= ARR_DIMS(array)[0]; i++)
7923 d = array_ref(array, 1, &i,
7924 -1 /* varlenarray */ ,
7925 -1 /* TEXT's typlen */ ,
7926 false /* TEXT's typbyval */ ,
7927 'i' /* TEXT's typalign */ ,
7931 val = TextDatumGetCString(d);
7933 /* ignore entry if it's what we want to delete */
7934 if (strncmp(val, name, strlen(name)) == 0
7935 && val[strlen(name)] == '=')
7938 /* else add it to the output array */
7940 newarray = array_set(newarray, 1, &index,
7943 -1 /* varlenarray */ ,
7944 -1 /* TEXT's typlen */ ,
7945 false /* TEXT's typbyval */ ,
7946 'i' /* TEXT's typalign */ );
7948 newarray = construct_array(&d, 1,
7960 * Given a GUC array, delete all settings from it that our permission
7961 * level allows: if superuser, delete them all; if regular user, only
7962 * those that are PGC_USERSET
7965 GUCArrayReset(ArrayType *array)
7967 ArrayType *newarray;
7971 /* if array is currently null, nothing to do */
7975 /* if we're superuser, we can delete everything, so just do it */
7982 for (i = 1; i <= ARR_DIMS(array)[0]; i++)
7989 d = array_ref(array, 1, &i,
7990 -1 /* varlenarray */ ,
7991 -1 /* TEXT's typlen */ ,
7992 false /* TEXT's typbyval */ ,
7993 'i' /* TEXT's typalign */ ,
7997 val = TextDatumGetCString(d);
7999 eqsgn = strchr(val, '=');
8002 /* skip if we have permission to delete it */
8003 if (validate_option_array_item(val, NULL, true))
8006 /* else add it to the output array */
8008 newarray = array_set(newarray, 1, &index,
8011 -1 /* varlenarray */ ,
8012 -1 /* TEXT's typlen */ ,
8013 false /* TEXT's typbyval */ ,
8014 'i' /* TEXT's typalign */ );
8016 newarray = construct_array(&d, 1,
8028 * Validate a proposed option setting for GUCArrayAdd/Delete/Reset.
8030 * name is the option name. value is the proposed value for the Add case,
8031 * or NULL for the Delete/Reset cases. If skipIfNoPermissions is true, it's
8032 * not an error to have no permissions to set the option.
8034 * Returns TRUE if OK, FALSE if skipIfNoPermissions is true and user does not
8035 * have permission to change this option (all other error cases result in an
8036 * error being thrown).
8039 validate_option_array_item(const char *name, const char *value,
8040 bool skipIfNoPermissions)
8043 struct config_generic *gconf;
8046 * There are three cases to consider:
8048 * name is a known GUC variable. Check the value normally, check
8049 * permissions normally (ie, allow if variable is USERSET, or if it's
8050 * SUSET and user is superuser).
8052 * name is not known, but exists or can be created as a placeholder (i.e.,
8053 * it has a prefixed name). We allow this case if you're a superuser,
8054 * otherwise not. Superusers are assumed to know what they're doing. We
8055 * can't allow it for other users, because when the placeholder is
8056 * resolved it might turn out to be a SUSET variable;
8057 * define_custom_variable assumes we checked that.
8059 * name is not known and can't be created as a placeholder. Throw error,
8060 * unless skipIfNoPermissions is true, in which case return FALSE.
8062 gconf = find_option(name, true, WARNING);
8065 /* not known, failed to make a placeholder */
8066 if (skipIfNoPermissions)
8069 (errcode(ERRCODE_UNDEFINED_OBJECT),
8070 errmsg("unrecognized configuration parameter \"%s\"",
8074 if (gconf->flags & GUC_CUSTOM_PLACEHOLDER)
8077 * We cannot do any meaningful check on the value, so only permissions
8078 * are useful to check.
8082 if (skipIfNoPermissions)
8085 (errcode(ERRCODE_INSUFFICIENT_PRIVILEGE),
8086 errmsg("permission denied to set parameter \"%s\"", name)));
8089 /* manual permissions check so we can avoid an error being thrown */
8090 if (gconf->context == PGC_USERSET)
8092 else if (gconf->context == PGC_SUSET && superuser())
8094 else if (skipIfNoPermissions)
8096 /* if a permissions error should be thrown, let set_config_option do it */
8098 /* test for permissions and valid option value */
8099 (void) set_config_option(name, value,
8100 superuser() ? PGC_SUSET : PGC_USERSET,
8101 PGC_S_TEST, GUC_ACTION_SET, false, 0);
8108 * Called by check_hooks that want to override the normal
8109 * ERRCODE_INVALID_PARAMETER_VALUE SQLSTATE for check hook failures.
8111 * Note that GUC_check_errmsg() etc are just macros that result in a direct
8112 * assignment to the associated variables. That is ugly, but forced by the
8113 * limitations of C's macro mechanisms.
8116 GUC_check_errcode(int sqlerrcode)
8118 GUC_check_errcode_value = sqlerrcode;
8123 * Convenience functions to manage calling a variable's check_hook.
8124 * These mostly take care of the protocol for letting check hooks supply
8125 * portions of the error report on failure.
8129 call_bool_check_hook(struct config_bool * conf, bool *newval, void **extra,
8130 GucSource source, int elevel)
8132 /* Quick success if no hook */
8133 if (!conf->check_hook)
8136 /* Reset variables that might be set by hook */
8137 GUC_check_errcode_value = ERRCODE_INVALID_PARAMETER_VALUE;
8138 GUC_check_errmsg_string = NULL;
8139 GUC_check_errdetail_string = NULL;
8140 GUC_check_errhint_string = NULL;
8142 if (!(*conf->check_hook) (newval, extra, source))
8145 (errcode(GUC_check_errcode_value),
8146 GUC_check_errmsg_string ?
8147 errmsg_internal("%s", GUC_check_errmsg_string) :
8148 errmsg("invalid value for parameter \"%s\": %d",
8149 conf->gen.name, (int) *newval),
8150 GUC_check_errdetail_string ?
8151 errdetail_internal("%s", GUC_check_errdetail_string) : 0,
8152 GUC_check_errhint_string ?
8153 errhint("%s", GUC_check_errhint_string) : 0));
8154 /* Flush any strings created in ErrorContext */
8163 call_int_check_hook(struct config_int * conf, int *newval, void **extra,
8164 GucSource source, int elevel)
8166 /* Quick success if no hook */
8167 if (!conf->check_hook)
8170 /* Reset variables that might be set by hook */
8171 GUC_check_errcode_value = ERRCODE_INVALID_PARAMETER_VALUE;
8172 GUC_check_errmsg_string = NULL;
8173 GUC_check_errdetail_string = NULL;
8174 GUC_check_errhint_string = NULL;
8176 if (!(*conf->check_hook) (newval, extra, source))
8179 (errcode(GUC_check_errcode_value),
8180 GUC_check_errmsg_string ?
8181 errmsg_internal("%s", GUC_check_errmsg_string) :
8182 errmsg("invalid value for parameter \"%s\": %d",
8183 conf->gen.name, *newval),
8184 GUC_check_errdetail_string ?
8185 errdetail_internal("%s", GUC_check_errdetail_string) : 0,
8186 GUC_check_errhint_string ?
8187 errhint("%s", GUC_check_errhint_string) : 0));
8188 /* Flush any strings created in ErrorContext */
8197 call_real_check_hook(struct config_real * conf, double *newval, void **extra,
8198 GucSource source, int elevel)
8200 /* Quick success if no hook */
8201 if (!conf->check_hook)
8204 /* Reset variables that might be set by hook */
8205 GUC_check_errcode_value = ERRCODE_INVALID_PARAMETER_VALUE;
8206 GUC_check_errmsg_string = NULL;
8207 GUC_check_errdetail_string = NULL;
8208 GUC_check_errhint_string = NULL;
8210 if (!(*conf->check_hook) (newval, extra, source))
8213 (errcode(GUC_check_errcode_value),
8214 GUC_check_errmsg_string ?
8215 errmsg_internal("%s", GUC_check_errmsg_string) :
8216 errmsg("invalid value for parameter \"%s\": %g",
8217 conf->gen.name, *newval),
8218 GUC_check_errdetail_string ?
8219 errdetail_internal("%s", GUC_check_errdetail_string) : 0,
8220 GUC_check_errhint_string ?
8221 errhint("%s", GUC_check_errhint_string) : 0));
8222 /* Flush any strings created in ErrorContext */
8231 call_string_check_hook(struct config_string * conf, char **newval, void **extra,
8232 GucSource source, int elevel)
8234 /* Quick success if no hook */
8235 if (!conf->check_hook)
8238 /* Reset variables that might be set by hook */
8239 GUC_check_errcode_value = ERRCODE_INVALID_PARAMETER_VALUE;
8240 GUC_check_errmsg_string = NULL;
8241 GUC_check_errdetail_string = NULL;
8242 GUC_check_errhint_string = NULL;
8244 if (!(*conf->check_hook) (newval, extra, source))
8247 (errcode(GUC_check_errcode_value),
8248 GUC_check_errmsg_string ?
8249 errmsg_internal("%s", GUC_check_errmsg_string) :
8250 errmsg("invalid value for parameter \"%s\": \"%s\"",
8251 conf->gen.name, *newval ? *newval : ""),
8252 GUC_check_errdetail_string ?
8253 errdetail_internal("%s", GUC_check_errdetail_string) : 0,
8254 GUC_check_errhint_string ?
8255 errhint("%s", GUC_check_errhint_string) : 0));
8256 /* Flush any strings created in ErrorContext */
8265 call_enum_check_hook(struct config_enum * conf, int *newval, void **extra,
8266 GucSource source, int elevel)
8268 /* Quick success if no hook */
8269 if (!conf->check_hook)
8272 /* Reset variables that might be set by hook */
8273 GUC_check_errcode_value = ERRCODE_INVALID_PARAMETER_VALUE;
8274 GUC_check_errmsg_string = NULL;
8275 GUC_check_errdetail_string = NULL;
8276 GUC_check_errhint_string = NULL;
8278 if (!(*conf->check_hook) (newval, extra, source))
8281 (errcode(GUC_check_errcode_value),
8282 GUC_check_errmsg_string ?
8283 errmsg_internal("%s", GUC_check_errmsg_string) :
8284 errmsg("invalid value for parameter \"%s\": \"%s\"",
8286 config_enum_lookup_by_value(conf, *newval)),
8287 GUC_check_errdetail_string ?
8288 errdetail_internal("%s", GUC_check_errdetail_string) : 0,
8289 GUC_check_errhint_string ?
8290 errhint("%s", GUC_check_errhint_string) : 0));
8291 /* Flush any strings created in ErrorContext */
8301 * check_hook, assign_hook and show_hook subroutines
8305 check_log_destination(char **newval, void **extra, GucSource source)
8313 /* Need a modifiable copy of string */
8314 rawstring = pstrdup(*newval);
8316 /* Parse string into list of identifiers */
8317 if (!SplitIdentifierString(rawstring, ',', &elemlist))
8319 /* syntax error in list */
8320 GUC_check_errdetail("List syntax is invalid.");
8322 list_free(elemlist);
8326 foreach(l, elemlist)
8328 char *tok = (char *) lfirst(l);
8330 if (pg_strcasecmp(tok, "stderr") == 0)
8331 newlogdest |= LOG_DESTINATION_STDERR;
8332 else if (pg_strcasecmp(tok, "csvlog") == 0)
8333 newlogdest |= LOG_DESTINATION_CSVLOG;
8335 else if (pg_strcasecmp(tok, "syslog") == 0)
8336 newlogdest |= LOG_DESTINATION_SYSLOG;
8339 else if (pg_strcasecmp(tok, "eventlog") == 0)
8340 newlogdest |= LOG_DESTINATION_EVENTLOG;
8344 GUC_check_errdetail("Unrecognized key word: \"%s\".", tok);
8346 list_free(elemlist);
8352 list_free(elemlist);
8354 myextra = (int *) guc_malloc(ERROR, sizeof(int));
8355 *myextra = newlogdest;
8356 *extra = (void *) myextra;
8362 assign_log_destination(const char *newval, void *extra)
8364 Log_destination = *((int *) extra);
8368 assign_syslog_facility(int newval, void *extra)
8371 set_syslog_parameters(syslog_ident_str ? syslog_ident_str : "postgres",
8374 /* Without syslog support, just ignore it */
8378 assign_syslog_ident(const char *newval, void *extra)
8381 set_syslog_parameters(newval, syslog_facility);
8383 /* Without syslog support, it will always be set to "none", so ignore */
8388 assign_session_replication_role(int newval, void *extra)
8391 * Must flush the plan cache when changing replication role; but don't
8392 * flush unnecessarily.
8394 if (SessionReplicationRole != newval)
8399 check_temp_buffers(int *newval, void **extra, GucSource source)
8402 * Once local buffers have been initialized, it's too late to change this.
8404 if (NLocBuffer && NLocBuffer != *newval)
8406 GUC_check_errdetail("\"temp_buffers\" cannot be changed after any temporary tables have been accessed in the session.");
8413 check_phony_autocommit(bool *newval, void **extra, GucSource source)
8417 GUC_check_errcode(ERRCODE_FEATURE_NOT_SUPPORTED);
8418 GUC_check_errmsg("SET AUTOCOMMIT TO OFF is no longer supported");
8425 check_debug_assertions(bool *newval, void **extra, GucSource source)
8427 #ifndef USE_ASSERT_CHECKING
8430 GUC_check_errmsg("assertion checking is not supported by this build");
8438 check_bonjour(bool *newval, void **extra, GucSource source)
8443 GUC_check_errmsg("Bonjour is not supported by this build");
8451 check_ssl(bool *newval, void **extra, GucSource source)
8456 GUC_check_errmsg("SSL is not supported by this build");
8464 check_stage_log_stats(bool *newval, void **extra, GucSource source)
8466 if (*newval && log_statement_stats)
8468 GUC_check_errdetail("Cannot enable parameter when \"log_statement_stats\" is true.");
8475 check_log_stats(bool *newval, void **extra, GucSource source)
8478 (log_parser_stats || log_planner_stats || log_executor_stats))
8480 GUC_check_errdetail("Cannot enable \"log_statement_stats\" when "
8481 "\"log_parser_stats\", \"log_planner_stats\", "
8482 "or \"log_executor_stats\" is true.");
8489 check_canonical_path(char **newval, void **extra, GucSource source)
8492 * Since canonicalize_path never enlarges the string, we can just modify
8493 * newval in-place. But watch out for NULL, which is the default value
8494 * for external_pid_file.
8497 canonicalize_path(*newval);
8502 check_timezone_abbreviations(char **newval, void **extra, GucSource source)
8505 * The boot_val given above for timezone_abbreviations is NULL. When we
8506 * see this we just do nothing. If this value isn't overridden from the
8507 * config file then pg_timezone_abbrev_initialize() will eventually
8508 * replace it with "Default". This hack has two purposes: to avoid
8509 * wasting cycles loading values that might soon be overridden from the
8510 * config file, and to avoid trying to read the timezone abbrev files
8511 * during InitializeGUCOptions(). The latter doesn't work in an
8512 * EXEC_BACKEND subprocess because my_exec_path hasn't been set yet and so
8513 * we can't locate PGSHAREDIR.
8515 if (*newval == NULL)
8517 Assert(source == PGC_S_DEFAULT);
8521 /* OK, load the file and produce a malloc'd TimeZoneAbbrevTable */
8522 *extra = load_tzoffsets(*newval);
8524 /* tzparser.c returns NULL on failure, reporting via GUC_check_errmsg */
8532 assign_timezone_abbreviations(const char *newval, void *extra)
8534 /* Do nothing for the boot_val default of NULL */
8538 InstallTimeZoneAbbrevs((TimeZoneAbbrevTable *) extra);
8542 * pg_timezone_abbrev_initialize --- set default value if not done already
8544 * This is called after initial loading of postgresql.conf. If no
8545 * timezone_abbreviations setting was found therein, select default.
8546 * If a non-default value is already installed, nothing will happen.
8548 * This can also be called from ProcessConfigFile to establish the default
8549 * value after a postgresql.conf entry for it is removed.
8552 pg_timezone_abbrev_initialize(void)
8554 SetConfigOption("timezone_abbreviations", "Default",
8555 PGC_POSTMASTER, PGC_S_DYNAMIC_DEFAULT);
8559 show_archive_command(void)
8561 if (XLogArchivingActive())
8562 return XLogArchiveCommand;
8564 return "(disabled)";
8568 assign_tcp_keepalives_idle(int newval, void *extra)
8571 * The kernel API provides no way to test a value without setting it; and
8572 * once we set it we might fail to unset it. So there seems little point
8573 * in fully implementing the check-then-assign GUC API for these
8574 * variables. Instead we just do the assignment on demand. pqcomm.c
8575 * reports any problems via elog(LOG).
8577 * This approach means that the GUC value might have little to do with the
8578 * actual kernel value, so we use a show_hook that retrieves the kernel
8579 * value rather than trusting GUC's copy.
8581 (void) pq_setkeepalivesidle(newval, MyProcPort);
8585 show_tcp_keepalives_idle(void)
8587 /* See comments in assign_tcp_keepalives_idle */
8588 static char nbuf[16];
8590 snprintf(nbuf, sizeof(nbuf), "%d", pq_getkeepalivesidle(MyProcPort));
8595 assign_tcp_keepalives_interval(int newval, void *extra)
8597 /* See comments in assign_tcp_keepalives_idle */
8598 (void) pq_setkeepalivesinterval(newval, MyProcPort);
8602 show_tcp_keepalives_interval(void)
8604 /* See comments in assign_tcp_keepalives_idle */
8605 static char nbuf[16];
8607 snprintf(nbuf, sizeof(nbuf), "%d", pq_getkeepalivesinterval(MyProcPort));
8612 assign_tcp_keepalives_count(int newval, void *extra)
8614 /* See comments in assign_tcp_keepalives_idle */
8615 (void) pq_setkeepalivescount(newval, MyProcPort);
8619 show_tcp_keepalives_count(void)
8621 /* See comments in assign_tcp_keepalives_idle */
8622 static char nbuf[16];
8624 snprintf(nbuf, sizeof(nbuf), "%d", pq_getkeepalivescount(MyProcPort));
8629 check_maxconnections(int *newval, void **extra, GucSource source)
8631 if (*newval + autovacuum_max_workers + 1 > MAX_BACKENDS)
8637 assign_maxconnections(int newval, void *extra)
8639 MaxBackends = newval + autovacuum_max_workers + 1;
8643 check_autovacuum_max_workers(int *newval, void **extra, GucSource source)
8645 if (MaxConnections + *newval + 1 > MAX_BACKENDS)
8651 assign_autovacuum_max_workers(int newval, void *extra)
8653 MaxBackends = MaxConnections + newval + 1;
8657 check_effective_io_concurrency(int *newval, void **extra, GucSource source)
8660 double new_prefetch_pages = 0.0;
8664 * The user-visible GUC parameter is the number of drives (spindles),
8665 * which we need to translate to a number-of-pages-to-prefetch target.
8666 * The target value is stashed in *extra and then assigned to the actual
8667 * variable by assign_effective_io_concurrency.
8669 * The expected number of prefetch pages needed to keep N drives busy is:
8671 * drives | I/O requests
8672 * -------+----------------
8675 * 3 | 3/1 + 3/2 + 3/3 = 5 1/2
8676 * 4 | 4/1 + 4/2 + 4/3 + 4/4 = 8 1/3
8679 * This is called the "coupon collector problem" and H(n) is called the
8680 * harmonic series. This could be approximated by n * ln(n), but for
8681 * reasonable numbers of drives we might as well just compute the series.
8683 * Alternatively we could set the target to the number of pages necessary
8684 * so that the expected number of active spindles is some arbitrary
8685 * percentage of the total. This sounds the same but is actually slightly
8686 * different. The result ends up being ln(1-P)/ln((n-1)/n) where P is
8687 * that desired fraction.
8689 * Experimental results show that both of these formulas aren't aggressive
8690 * enough, but we don't really have any better proposals.
8692 * Note that if *newval = 0 (disabled), we must set target = 0.
8696 for (i = 1; i <= *newval; i++)
8697 new_prefetch_pages += (double) *newval / (double) i;
8699 /* This range check shouldn't fail, but let's be paranoid */
8700 if (new_prefetch_pages >= 0.0 && new_prefetch_pages < (double) INT_MAX)
8702 int *myextra = (int *) guc_malloc(ERROR, sizeof(int));
8704 *myextra = (int) rint(new_prefetch_pages);
8705 *extra = (void *) myextra;
8713 #endif /* USE_PREFETCH */
8717 assign_effective_io_concurrency(int newval, void *extra)
8720 target_prefetch_pages = *((int *) extra);
8721 #endif /* USE_PREFETCH */
8725 assign_pgstat_temp_directory(const char *newval, void *extra)
8727 /* check_canonical_path already canonicalized newval for us */
8731 tname = guc_malloc(ERROR, strlen(newval) + 12); /* /pgstat.tmp */
8732 sprintf(tname, "%s/pgstat.tmp", newval);
8733 fname = guc_malloc(ERROR, strlen(newval) + 13); /* /pgstat.stat */
8734 sprintf(fname, "%s/pgstat.stat", newval);
8736 if (pgstat_stat_tmpname)
8737 free(pgstat_stat_tmpname);
8738 pgstat_stat_tmpname = tname;
8739 if (pgstat_stat_filename)
8740 free(pgstat_stat_filename);
8741 pgstat_stat_filename = fname;
8745 check_application_name(char **newval, void **extra, GucSource source)
8747 /* Only allow clean ASCII chars in the application name */
8750 for (p = *newval; *p; p++)
8752 if (*p < 32 || *p > 126)
8760 assign_application_name(const char *newval, void *extra)
8762 /* Update the pg_stat_activity view */
8763 pgstat_report_appname(newval);
8767 show_unix_socket_permissions(void)
8771 snprintf(buf, sizeof(buf), "%04o", Unix_socket_permissions);
8776 show_log_file_mode(void)
8780 snprintf(buf, sizeof(buf), "%04o", Log_file_mode);
8784 #include "guc-file.c"