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/pqformat.h"
43 #include "miscadmin.h"
44 #include "optimizer/cost.h"
45 #include "optimizer/geqo.h"
46 #include "optimizer/paths.h"
47 #include "optimizer/planmain.h"
48 #include "parser/parse_expr.h"
49 #include "parser/parse_type.h"
50 #include "parser/parser.h"
51 #include "parser/scansup.h"
53 #include "postmaster/autovacuum.h"
54 #include "postmaster/bgwriter.h"
55 #include "postmaster/postmaster.h"
56 #include "postmaster/syslogger.h"
57 #include "postmaster/walwriter.h"
58 #include "replication/syncrep.h"
59 #include "replication/walreceiver.h"
60 #include "replication/walsender.h"
61 #include "storage/bufmgr.h"
62 #include "storage/standby.h"
63 #include "storage/fd.h"
64 #include "storage/predicate.h"
65 #include "tcop/tcopprot.h"
66 #include "tsearch/ts_cache.h"
67 #include "utils/builtins.h"
68 #include "utils/bytea.h"
69 #include "utils/guc_tables.h"
70 #include "utils/memutils.h"
71 #include "utils/pg_locale.h"
72 #include "utils/plancache.h"
73 #include "utils/portal.h"
74 #include "utils/ps_status.h"
75 #include "utils/snapmgr.h"
76 #include "utils/tzparser.h"
77 #include "utils/xml.h"
80 #define PG_KRB_SRVTAB ""
83 #define PG_KRB_SRVNAM ""
86 #define CONFIG_FILENAME "postgresql.conf"
87 #define HBA_FILENAME "pg_hba.conf"
88 #define IDENT_FILENAME "pg_ident.conf"
91 #define CONFIG_EXEC_PARAMS "global/config_exec_params"
92 #define CONFIG_EXEC_PARAMS_NEW "global/config_exec_params.new"
95 /* upper limit for GUC variables measured in kilobytes of memory */
96 /* note that various places assume the byte size fits in a "long" variable */
97 #if SIZEOF_SIZE_T > 4 && SIZEOF_LONG > 4
98 #define MAX_KILOBYTES INT_MAX
100 #define MAX_KILOBYTES (INT_MAX / 1024)
104 * Note: MAX_BACKENDS is limited to 2^23-1 because inval.c stores the
105 * backend ID as a 3-byte signed integer. Even if that limitation were
106 * removed, we still could not exceed INT_MAX/4 because some places compute
107 * 4*MaxBackends without any overflow check. This is rechecked in
108 * check_maxconnections, since MaxBackends is computed as MaxConnections
109 * plus autovacuum_max_workers plus one (for the autovacuum launcher).
111 #define MAX_BACKENDS 0x7fffff
113 #define KB_PER_MB (1024)
114 #define KB_PER_GB (1024*1024)
116 #define MS_PER_S 1000
118 #define MS_PER_MIN (1000 * 60)
120 #define S_PER_H (60 * 60)
121 #define MS_PER_H (1000 * 60 * 60)
122 #define MIN_PER_D (60 * 24)
123 #define S_PER_D (60 * 60 * 24)
124 #define MS_PER_D (1000 * 60 * 60 * 24)
126 /* XXX these should appear in other modules' header files */
127 extern bool Log_disconnections;
128 extern int CommitDelay;
129 extern int CommitSiblings;
130 extern char *default_tablespace;
131 extern char *temp_tablespaces;
132 extern bool synchronize_seqscans;
133 extern bool fullPageWrites;
134 extern int ssl_renegotiation_limit;
135 extern char *SSLCipherSuites;
138 extern bool trace_sort;
140 #ifdef TRACE_SYNCSCAN
141 extern bool trace_syncscan;
143 #ifdef DEBUG_BOUNDED_SORT
144 extern bool optimize_bounded_sort;
147 static int GUC_check_errcode_value;
149 /* global variables for check hook support */
150 char *GUC_check_errmsg_string;
151 char *GUC_check_errdetail_string;
152 char *GUC_check_errhint_string;
155 static void set_config_sourcefile(const char *name, char *sourcefile,
157 static bool call_bool_check_hook(struct config_bool * conf, bool *newval,
158 void **extra, GucSource source, int elevel);
159 static bool call_int_check_hook(struct config_int * conf, int *newval,
160 void **extra, GucSource source, int elevel);
161 static bool call_real_check_hook(struct config_real * conf, double *newval,
162 void **extra, GucSource source, int elevel);
163 static bool call_string_check_hook(struct config_string * conf, char **newval,
164 void **extra, GucSource source, int elevel);
165 static bool call_enum_check_hook(struct config_enum * conf, int *newval,
166 void **extra, GucSource source, int elevel);
168 static bool check_log_destination(char **newval, void **extra, GucSource source);
169 static void assign_log_destination(const char *newval, void *extra);
172 static int syslog_facility = LOG_LOCAL0;
174 static int syslog_facility = 0;
177 static void assign_syslog_facility(int newval, void *extra);
178 static void assign_syslog_ident(const char *newval, void *extra);
179 static void assign_session_replication_role(int newval, void *extra);
180 static bool check_temp_buffers(int *newval, void **extra, GucSource source);
181 static bool check_phony_autocommit(bool *newval, void **extra, GucSource source);
182 static bool check_debug_assertions(bool *newval, void **extra, GucSource source);
183 static bool check_bonjour(bool *newval, void **extra, GucSource source);
184 static bool check_ssl(bool *newval, void **extra, GucSource source);
185 static bool check_stage_log_stats(bool *newval, void **extra, GucSource source);
186 static bool check_log_stats(bool *newval, void **extra, GucSource source);
187 static bool check_canonical_path(char **newval, void **extra, GucSource source);
188 static bool check_timezone_abbreviations(char **newval, void **extra, GucSource source);
189 static void assign_timezone_abbreviations(const char *newval, void *extra);
190 static void pg_timezone_abbrev_initialize(void);
191 static const char *show_archive_command(void);
192 static void assign_tcp_keepalives_idle(int newval, void *extra);
193 static void assign_tcp_keepalives_interval(int newval, void *extra);
194 static void assign_tcp_keepalives_count(int newval, void *extra);
195 static const char *show_tcp_keepalives_idle(void);
196 static const char *show_tcp_keepalives_interval(void);
197 static const char *show_tcp_keepalives_count(void);
198 static bool check_maxconnections(int *newval, void **extra, GucSource source);
199 static void assign_maxconnections(int newval, void *extra);
200 static bool check_autovacuum_max_workers(int *newval, void **extra, GucSource source);
201 static void assign_autovacuum_max_workers(int newval, void *extra);
202 static bool check_effective_io_concurrency(int *newval, void **extra, GucSource source);
203 static void assign_effective_io_concurrency(int newval, void *extra);
204 static void assign_pgstat_temp_directory(const char *newval, void *extra);
205 static bool check_application_name(char **newval, void **extra, GucSource source);
206 static void assign_application_name(const char *newval, void *extra);
207 static const char *show_unix_socket_permissions(void);
208 static const char *show_log_file_mode(void);
210 static char *config_enum_get_options(struct config_enum * record,
211 const char *prefix, const char *suffix,
212 const char *separator);
216 * Options for enum values defined in this module.
218 * NOTE! Option values may not contain double quotes!
221 static const struct config_enum_entry bytea_output_options[] = {
222 {"escape", BYTEA_OUTPUT_ESCAPE, false},
223 {"hex", BYTEA_OUTPUT_HEX, false},
228 * We have different sets for client and server message level options because
229 * they sort slightly different (see "log" level)
231 static const struct config_enum_entry client_message_level_options[] = {
232 {"debug", DEBUG2, true},
233 {"debug5", DEBUG5, false},
234 {"debug4", DEBUG4, false},
235 {"debug3", DEBUG3, false},
236 {"debug2", DEBUG2, false},
237 {"debug1", DEBUG1, false},
239 {"info", INFO, true},
240 {"notice", NOTICE, false},
241 {"warning", WARNING, false},
242 {"error", ERROR, false},
243 {"fatal", FATAL, true},
244 {"panic", PANIC, true},
248 static const struct config_enum_entry server_message_level_options[] = {
249 {"debug", DEBUG2, true},
250 {"debug5", DEBUG5, false},
251 {"debug4", DEBUG4, false},
252 {"debug3", DEBUG3, false},
253 {"debug2", DEBUG2, false},
254 {"debug1", DEBUG1, false},
255 {"info", INFO, false},
256 {"notice", NOTICE, false},
257 {"warning", WARNING, false},
258 {"error", ERROR, false},
260 {"fatal", FATAL, false},
261 {"panic", PANIC, false},
265 static const struct config_enum_entry intervalstyle_options[] = {
266 {"postgres", INTSTYLE_POSTGRES, false},
267 {"postgres_verbose", INTSTYLE_POSTGRES_VERBOSE, false},
268 {"sql_standard", INTSTYLE_SQL_STANDARD, false},
269 {"iso_8601", INTSTYLE_ISO_8601, false},
273 static const struct config_enum_entry log_error_verbosity_options[] = {
274 {"terse", PGERROR_TERSE, false},
275 {"default", PGERROR_DEFAULT, false},
276 {"verbose", PGERROR_VERBOSE, false},
280 static const struct config_enum_entry log_statement_options[] = {
281 {"none", LOGSTMT_NONE, false},
282 {"ddl", LOGSTMT_DDL, false},
283 {"mod", LOGSTMT_MOD, false},
284 {"all", LOGSTMT_ALL, false},
288 static const struct config_enum_entry isolation_level_options[] = {
289 {"serializable", XACT_SERIALIZABLE, false},
290 {"repeatable read", XACT_REPEATABLE_READ, false},
291 {"read committed", XACT_READ_COMMITTED, false},
292 {"read uncommitted", XACT_READ_UNCOMMITTED, false},
296 static const struct config_enum_entry session_replication_role_options[] = {
297 {"origin", SESSION_REPLICATION_ROLE_ORIGIN, false},
298 {"replica", SESSION_REPLICATION_ROLE_REPLICA, false},
299 {"local", SESSION_REPLICATION_ROLE_LOCAL, false},
303 static const struct config_enum_entry syslog_facility_options[] = {
305 {"local0", LOG_LOCAL0, false},
306 {"local1", LOG_LOCAL1, false},
307 {"local2", LOG_LOCAL2, false},
308 {"local3", LOG_LOCAL3, false},
309 {"local4", LOG_LOCAL4, false},
310 {"local5", LOG_LOCAL5, false},
311 {"local6", LOG_LOCAL6, false},
312 {"local7", LOG_LOCAL7, false},
319 static const struct config_enum_entry track_function_options[] = {
320 {"none", TRACK_FUNC_OFF, false},
321 {"pl", TRACK_FUNC_PL, false},
322 {"all", TRACK_FUNC_ALL, false},
326 static const struct config_enum_entry xmlbinary_options[] = {
327 {"base64", XMLBINARY_BASE64, false},
328 {"hex", XMLBINARY_HEX, false},
332 static const struct config_enum_entry xmloption_options[] = {
333 {"content", XMLOPTION_CONTENT, false},
334 {"document", XMLOPTION_DOCUMENT, false},
339 * Although only "on", "off", and "safe_encoding" are documented, we
340 * accept all the likely variants of "on" and "off".
342 static const struct config_enum_entry backslash_quote_options[] = {
343 {"safe_encoding", BACKSLASH_QUOTE_SAFE_ENCODING, false},
344 {"on", BACKSLASH_QUOTE_ON, false},
345 {"off", BACKSLASH_QUOTE_OFF, false},
346 {"true", BACKSLASH_QUOTE_ON, true},
347 {"false", BACKSLASH_QUOTE_OFF, true},
348 {"yes", BACKSLASH_QUOTE_ON, true},
349 {"no", BACKSLASH_QUOTE_OFF, true},
350 {"1", BACKSLASH_QUOTE_ON, true},
351 {"0", BACKSLASH_QUOTE_OFF, true},
356 * Although only "on", "off", and "partition" are documented, we
357 * accept all the likely variants of "on" and "off".
359 static const struct config_enum_entry constraint_exclusion_options[] = {
360 {"partition", CONSTRAINT_EXCLUSION_PARTITION, false},
361 {"on", CONSTRAINT_EXCLUSION_ON, false},
362 {"off", CONSTRAINT_EXCLUSION_OFF, false},
363 {"true", CONSTRAINT_EXCLUSION_ON, true},
364 {"false", CONSTRAINT_EXCLUSION_OFF, true},
365 {"yes", CONSTRAINT_EXCLUSION_ON, true},
366 {"no", CONSTRAINT_EXCLUSION_OFF, true},
367 {"1", CONSTRAINT_EXCLUSION_ON, true},
368 {"0", CONSTRAINT_EXCLUSION_OFF, true},
373 * Although only "on", "off", and "local" are documented, we
374 * accept all the likely variants of "on" and "off".
376 static const struct config_enum_entry synchronous_commit_options[] = {
377 {"local", SYNCHRONOUS_COMMIT_LOCAL_FLUSH, false},
378 {"on", SYNCHRONOUS_COMMIT_ON, false},
379 {"off", SYNCHRONOUS_COMMIT_OFF, false},
380 {"true", SYNCHRONOUS_COMMIT_ON, true},
381 {"false", SYNCHRONOUS_COMMIT_OFF, true},
382 {"yes", SYNCHRONOUS_COMMIT_ON, true},
383 {"no", SYNCHRONOUS_COMMIT_OFF, true},
384 {"1", SYNCHRONOUS_COMMIT_ON, true},
385 {"0", SYNCHRONOUS_COMMIT_OFF, true},
390 * Options for enum values stored in other modules
392 extern const struct config_enum_entry wal_level_options[];
393 extern const struct config_enum_entry sync_method_options[];
396 * GUC option variables that are exported from this module
398 #ifdef USE_ASSERT_CHECKING
399 bool assert_enabled = true;
401 bool assert_enabled = false;
403 bool log_duration = false;
404 bool Debug_print_plan = false;
405 bool Debug_print_parse = false;
406 bool Debug_print_rewritten = false;
407 bool Debug_pretty_print = true;
409 bool log_parser_stats = false;
410 bool log_planner_stats = false;
411 bool log_executor_stats = false;
412 bool log_statement_stats = false; /* this is sort of all three
414 bool log_btree_build_stats = false;
417 bool check_function_bodies = true;
418 bool default_with_oids = false;
419 bool SQL_inheritance = true;
421 bool Password_encryption = true;
423 int log_min_error_statement = ERROR;
424 int log_min_messages = WARNING;
425 int client_min_messages = NOTICE;
426 int log_min_duration_statement = -1;
427 int log_temp_files = -1;
428 int trace_recovery_messages = LOG;
430 int temp_file_limit = -1;
432 int num_temp_buffers = 1024;
434 char *data_directory;
435 char *ConfigFileName;
438 char *external_pid_file;
440 char *pgstat_temp_directory;
442 char *application_name;
444 int tcp_keepalives_idle;
445 int tcp_keepalives_interval;
446 int tcp_keepalives_count;
449 * These variables are all dummies that don't do anything, except in some
450 * cases provide the value for SHOW to display. The real state is elsewhere
451 * and is kept in sync by assign_hooks.
453 static char *log_destination_string;
455 static char *syslog_ident_str;
456 static bool phony_autocommit;
457 static bool session_auth_is_superuser;
458 static double phony_random_seed;
459 static char *client_encoding_string;
460 static char *datestyle_string;
461 static char *locale_collate;
462 static char *locale_ctype;
463 static char *server_encoding_string;
464 static char *server_version_string;
465 static int server_version_num;
466 static char *timezone_string;
467 static char *log_timezone_string;
468 static char *timezone_abbreviations_string;
469 static char *XactIsoLevel_string;
470 static char *session_authorization_string;
471 static int max_function_args;
472 static int max_index_keys;
473 static int max_identifier_length;
474 static int block_size;
475 static int segment_size;
476 static int wal_block_size;
477 static int wal_segment_size;
478 static bool integer_datetimes;
479 static int effective_io_concurrency;
481 /* should be static, but commands/variable.c needs to get at this */
486 * Displayable names for context types (enum GucContext)
488 * Note: these strings are deliberately not localized.
490 const char *const GucContext_Names[] =
492 /* PGC_INTERNAL */ "internal",
493 /* PGC_POSTMASTER */ "postmaster",
494 /* PGC_SIGHUP */ "sighup",
495 /* PGC_BACKEND */ "backend",
496 /* PGC_SUSET */ "superuser",
497 /* PGC_USERSET */ "user"
501 * Displayable names for source types (enum GucSource)
503 * Note: these strings are deliberately not localized.
505 const char *const GucSource_Names[] =
507 /* PGC_S_DEFAULT */ "default",
508 /* PGC_S_DYNAMIC_DEFAULT */ "default",
509 /* PGC_S_ENV_VAR */ "environment variable",
510 /* PGC_S_FILE */ "configuration file",
511 /* PGC_S_ARGV */ "command line",
512 /* PGC_S_DATABASE */ "database",
513 /* PGC_S_USER */ "user",
514 /* PGC_S_DATABASE_USER */ "database user",
515 /* PGC_S_CLIENT */ "client",
516 /* PGC_S_OVERRIDE */ "override",
517 /* PGC_S_INTERACTIVE */ "interactive",
518 /* PGC_S_TEST */ "test",
519 /* PGC_S_SESSION */ "session"
523 * Displayable names for the groupings defined in enum config_group
525 const char *const config_group_names[] =
528 gettext_noop("Ungrouped"),
530 gettext_noop("File Locations"),
532 gettext_noop("Connections and Authentication"),
533 /* CONN_AUTH_SETTINGS */
534 gettext_noop("Connections and Authentication / Connection Settings"),
535 /* CONN_AUTH_SECURITY */
536 gettext_noop("Connections and Authentication / Security and Authentication"),
538 gettext_noop("Resource Usage"),
540 gettext_noop("Resource Usage / Memory"),
542 gettext_noop("Resource Usage / Disk"),
543 /* RESOURCES_KERNEL */
544 gettext_noop("Resource Usage / Kernel Resources"),
545 /* RESOURCES_VACUUM_DELAY */
546 gettext_noop("Resource Usage / Cost-Based Vacuum Delay"),
547 /* RESOURCES_BGWRITER */
548 gettext_noop("Resource Usage / Background Writer"),
549 /* RESOURCES_ASYNCHRONOUS */
550 gettext_noop("Resource Usage / Asynchronous Behavior"),
552 gettext_noop("Write-Ahead Log"),
554 gettext_noop("Write-Ahead Log / Settings"),
555 /* WAL_CHECKPOINTS */
556 gettext_noop("Write-Ahead Log / Checkpoints"),
558 gettext_noop("Write-Ahead Log / Archiving"),
560 gettext_noop("Replication"),
561 /* REPLICATION_SENDING */
562 gettext_noop("Replication / Sending Servers"),
563 /* REPLICATION_MASTER */
564 gettext_noop("Replication / Master Server"),
565 /* REPLICATION_STANDBY */
566 gettext_noop("Replication / Standby Servers"),
568 gettext_noop("Query Tuning"),
569 /* QUERY_TUNING_METHOD */
570 gettext_noop("Query Tuning / Planner Method Configuration"),
571 /* QUERY_TUNING_COST */
572 gettext_noop("Query Tuning / Planner Cost Constants"),
573 /* QUERY_TUNING_GEQO */
574 gettext_noop("Query Tuning / Genetic Query Optimizer"),
575 /* QUERY_TUNING_OTHER */
576 gettext_noop("Query Tuning / Other Planner Options"),
578 gettext_noop("Reporting and Logging"),
580 gettext_noop("Reporting and Logging / Where to Log"),
582 gettext_noop("Reporting and Logging / When to Log"),
584 gettext_noop("Reporting and Logging / What to Log"),
586 gettext_noop("Statistics"),
587 /* STATS_MONITORING */
588 gettext_noop("Statistics / Monitoring"),
589 /* STATS_COLLECTOR */
590 gettext_noop("Statistics / Query and Index Statistics Collector"),
592 gettext_noop("Autovacuum"),
594 gettext_noop("Client Connection Defaults"),
595 /* CLIENT_CONN_STATEMENT */
596 gettext_noop("Client Connection Defaults / Statement Behavior"),
597 /* CLIENT_CONN_LOCALE */
598 gettext_noop("Client Connection Defaults / Locale and Formatting"),
599 /* CLIENT_CONN_OTHER */
600 gettext_noop("Client Connection Defaults / Other Defaults"),
601 /* LOCK_MANAGEMENT */
602 gettext_noop("Lock Management"),
604 gettext_noop("Version and Platform Compatibility"),
605 /* COMPAT_OPTIONS_PREVIOUS */
606 gettext_noop("Version and Platform Compatibility / Previous PostgreSQL Versions"),
607 /* COMPAT_OPTIONS_CLIENT */
608 gettext_noop("Version and Platform Compatibility / Other Platforms and Clients"),
610 gettext_noop("Error Handling"),
612 gettext_noop("Preset Options"),
614 gettext_noop("Customized Options"),
615 /* DEVELOPER_OPTIONS */
616 gettext_noop("Developer Options"),
617 /* help_config wants this array to be null-terminated */
622 * Displayable names for GUC variable types (enum config_type)
624 * Note: these strings are deliberately not localized.
626 const char *const config_type_names[] =
628 /* PGC_BOOL */ "bool",
629 /* PGC_INT */ "integer",
630 /* PGC_REAL */ "real",
631 /* PGC_STRING */ "string",
632 /* PGC_ENUM */ "enum"
637 * Contents of GUC tables
639 * See src/backend/utils/misc/README for design notes.
643 * 1. Declare a global variable of type bool, int, double, or char*
644 * and make use of it.
646 * 2. Decide at what times it's safe to set the option. See guc.h for
649 * 3. Decide on a name, a default value, upper and lower bounds (if
652 * 4. Add a record below.
654 * 5. Add it to src/backend/utils/misc/postgresql.conf.sample, if
657 * 6. Don't forget to document the option (at least in config.sgml).
659 * 7. If it's a new GUC_LIST option you must edit pg_dumpall.c to ensure
660 * it is not single quoted at dump time.
664 /******** option records follow ********/
666 static struct config_bool ConfigureNamesBool[] =
669 {"enable_seqscan", PGC_USERSET, QUERY_TUNING_METHOD,
670 gettext_noop("Enables the planner's use of sequential-scan plans."),
678 {"enable_indexscan", PGC_USERSET, QUERY_TUNING_METHOD,
679 gettext_noop("Enables the planner's use of index-scan plans."),
687 {"enable_indexonlyscan", PGC_USERSET, QUERY_TUNING_METHOD,
688 gettext_noop("Enables the planner's use of index-only-scan plans."),
691 &enable_indexonlyscan,
696 {"enable_bitmapscan", PGC_USERSET, QUERY_TUNING_METHOD,
697 gettext_noop("Enables the planner's use of bitmap-scan plans."),
705 {"enable_tidscan", PGC_USERSET, QUERY_TUNING_METHOD,
706 gettext_noop("Enables the planner's use of TID scan plans."),
714 {"enable_sort", PGC_USERSET, QUERY_TUNING_METHOD,
715 gettext_noop("Enables the planner's use of explicit sort steps."),
723 {"enable_hashagg", PGC_USERSET, QUERY_TUNING_METHOD,
724 gettext_noop("Enables the planner's use of hashed aggregation plans."),
732 {"enable_material", PGC_USERSET, QUERY_TUNING_METHOD,
733 gettext_noop("Enables the planner's use of materialization."),
741 {"enable_nestloop", PGC_USERSET, QUERY_TUNING_METHOD,
742 gettext_noop("Enables the planner's use of nested-loop join plans."),
750 {"enable_mergejoin", PGC_USERSET, QUERY_TUNING_METHOD,
751 gettext_noop("Enables the planner's use of merge join plans."),
759 {"enable_hashjoin", PGC_USERSET, QUERY_TUNING_METHOD,
760 gettext_noop("Enables the planner's use of hash join plans."),
768 {"geqo", PGC_USERSET, QUERY_TUNING_GEQO,
769 gettext_noop("Enables genetic query optimization."),
770 gettext_noop("This algorithm attempts to do planning without "
771 "exhaustive searching.")
778 /* Not for general use --- used by SET SESSION AUTHORIZATION */
779 {"is_superuser", PGC_INTERNAL, UNGROUPED,
780 gettext_noop("Shows whether the current user is a superuser."),
782 GUC_REPORT | GUC_NO_SHOW_ALL | GUC_NO_RESET_ALL | GUC_NOT_IN_SAMPLE | GUC_DISALLOW_IN_FILE
784 &session_auth_is_superuser,
789 {"bonjour", PGC_POSTMASTER, CONN_AUTH_SETTINGS,
790 gettext_noop("Enables advertising the server via Bonjour."),
795 check_bonjour, NULL, NULL
798 {"ssl", PGC_POSTMASTER, CONN_AUTH_SECURITY,
799 gettext_noop("Enables SSL connections."),
804 check_ssl, NULL, NULL
807 {"fsync", PGC_SIGHUP, WAL_SETTINGS,
808 gettext_noop("Forces synchronization of updates to disk."),
809 gettext_noop("The server will use the fsync() system call in several places to make "
810 "sure that updates are physically written to disk. This insures "
811 "that a database cluster will recover to a consistent state after "
812 "an operating system or hardware crash.")
819 {"zero_damaged_pages", PGC_SUSET, DEVELOPER_OPTIONS,
820 gettext_noop("Continues processing past damaged page headers."),
821 gettext_noop("Detection of a damaged page header normally causes PostgreSQL to "
822 "report an error, aborting the current transaction. Setting "
823 "zero_damaged_pages to true causes the system to instead report a "
824 "warning, zero out the damaged page, and continue processing. This "
825 "behavior will destroy data, namely all the rows on the damaged page."),
833 {"full_page_writes", PGC_SIGHUP, WAL_SETTINGS,
834 gettext_noop("Writes full pages to WAL when first modified after a checkpoint."),
835 gettext_noop("A page write in process during an operating system crash might be "
836 "only partially written to disk. During recovery, the row changes "
837 "stored in WAL are not enough to recover. This option writes "
838 "pages when first modified after a checkpoint to WAL so full recovery "
846 {"log_checkpoints", PGC_SIGHUP, LOGGING_WHAT,
847 gettext_noop("Logs each checkpoint."),
855 {"log_connections", PGC_BACKEND, LOGGING_WHAT,
856 gettext_noop("Logs each successful connection."),
864 {"log_disconnections", PGC_BACKEND, LOGGING_WHAT,
865 gettext_noop("Logs end of a session, including duration."),
873 {"debug_assertions", PGC_USERSET, DEVELOPER_OPTIONS,
874 gettext_noop("Turns on various assertion checks."),
875 gettext_noop("This is a debugging aid."),
879 #ifdef USE_ASSERT_CHECKING
884 check_debug_assertions, NULL, NULL
888 {"exit_on_error", PGC_USERSET, ERROR_HANDLING_OPTIONS,
889 gettext_noop("Terminate session on any error."),
897 {"restart_after_crash", PGC_SIGHUP, ERROR_HANDLING_OPTIONS,
898 gettext_noop("Reinitialize server after backend crash."),
901 &restart_after_crash,
907 {"log_duration", PGC_SUSET, LOGGING_WHAT,
908 gettext_noop("Logs the duration of each completed SQL statement."),
916 {"debug_print_parse", PGC_USERSET, LOGGING_WHAT,
917 gettext_noop("Logs each query's parse tree."),
925 {"debug_print_rewritten", PGC_USERSET, LOGGING_WHAT,
926 gettext_noop("Logs each query's rewritten parse tree."),
929 &Debug_print_rewritten,
934 {"debug_print_plan", PGC_USERSET, LOGGING_WHAT,
935 gettext_noop("Logs each query's execution plan."),
943 {"debug_pretty_print", PGC_USERSET, LOGGING_WHAT,
944 gettext_noop("Indents parse and plan tree displays."),
952 {"log_parser_stats", PGC_SUSET, STATS_MONITORING,
953 gettext_noop("Writes parser performance statistics to the server log."),
958 check_stage_log_stats, NULL, NULL
961 {"log_planner_stats", PGC_SUSET, STATS_MONITORING,
962 gettext_noop("Writes planner performance statistics to the server log."),
967 check_stage_log_stats, NULL, NULL
970 {"log_executor_stats", PGC_SUSET, STATS_MONITORING,
971 gettext_noop("Writes executor performance statistics to the server log."),
976 check_stage_log_stats, NULL, NULL
979 {"log_statement_stats", PGC_SUSET, STATS_MONITORING,
980 gettext_noop("Writes cumulative performance statistics to the server log."),
983 &log_statement_stats,
985 check_log_stats, NULL, NULL
987 #ifdef BTREE_BUILD_STATS
989 {"log_btree_build_stats", PGC_SUSET, DEVELOPER_OPTIONS,
990 gettext_noop("No description available."),
994 &log_btree_build_stats,
1001 {"track_activities", PGC_SUSET, STATS_COLLECTOR,
1002 gettext_noop("Collects information about executing commands."),
1003 gettext_noop("Enables the collection of information on the currently "
1004 "executing command of each session, along with "
1005 "the time at which that command began execution.")
1007 &pgstat_track_activities,
1012 {"track_counts", PGC_SUSET, STATS_COLLECTOR,
1013 gettext_noop("Collects statistics on database activity."),
1016 &pgstat_track_counts,
1022 {"update_process_title", PGC_SUSET, STATS_COLLECTOR,
1023 gettext_noop("Updates the process title to show the active SQL command."),
1024 gettext_noop("Enables updating of the process title every time a new SQL command is received by the server.")
1026 &update_process_title,
1032 {"autovacuum", PGC_SIGHUP, AUTOVACUUM,
1033 gettext_noop("Starts the autovacuum subprocess."),
1036 &autovacuum_start_daemon,
1042 {"trace_notify", PGC_USERSET, DEVELOPER_OPTIONS,
1043 gettext_noop("Generates debugging output for LISTEN and NOTIFY."),
1054 {"trace_locks", PGC_SUSET, DEVELOPER_OPTIONS,
1055 gettext_noop("No description available."),
1064 {"trace_userlocks", PGC_SUSET, DEVELOPER_OPTIONS,
1065 gettext_noop("No description available."),
1074 {"trace_lwlocks", PGC_SUSET, DEVELOPER_OPTIONS,
1075 gettext_noop("No description available."),
1084 {"debug_deadlocks", PGC_SUSET, DEVELOPER_OPTIONS,
1085 gettext_noop("No description available."),
1096 {"log_lock_waits", PGC_SUSET, LOGGING_WHAT,
1097 gettext_noop("Logs long lock waits."),
1106 {"log_hostname", PGC_SIGHUP, LOGGING_WHAT,
1107 gettext_noop("Logs the host name in the connection logs."),
1108 gettext_noop("By default, connection logs only show the IP address "
1109 "of the connecting host. If you want them to show the host name you "
1110 "can turn this on, but depending on your host name resolution "
1111 "setup it might impose a non-negligible performance penalty.")
1118 {"sql_inheritance", PGC_USERSET, COMPAT_OPTIONS_PREVIOUS,
1119 gettext_noop("Causes subtables to be included by default in various commands."),
1127 {"password_encryption", PGC_USERSET, CONN_AUTH_SECURITY,
1128 gettext_noop("Encrypt passwords."),
1129 gettext_noop("When a password is specified in CREATE USER or "
1130 "ALTER USER without writing either ENCRYPTED or UNENCRYPTED, "
1131 "this parameter determines whether the password is to be encrypted.")
1133 &Password_encryption,
1138 {"transform_null_equals", PGC_USERSET, COMPAT_OPTIONS_CLIENT,
1139 gettext_noop("Treats \"expr=NULL\" as \"expr IS NULL\"."),
1140 gettext_noop("When turned on, expressions of the form expr = NULL "
1141 "(or NULL = expr) are treated as expr IS NULL, that is, they "
1142 "return true if expr evaluates to the null value, and false "
1143 "otherwise. The correct behavior of expr = NULL is to always "
1144 "return null (unknown).")
1146 &Transform_null_equals,
1151 {"db_user_namespace", PGC_SIGHUP, CONN_AUTH_SECURITY,
1152 gettext_noop("Enables per-database user names."),
1160 /* only here for backwards compatibility */
1161 {"autocommit", PGC_USERSET, CLIENT_CONN_STATEMENT,
1162 gettext_noop("This parameter doesn't do anything."),
1163 gettext_noop("It's just here so that we won't choke on SET AUTOCOMMIT TO ON from 7.3-vintage clients."),
1164 GUC_NO_SHOW_ALL | GUC_NOT_IN_SAMPLE
1168 check_phony_autocommit, NULL, NULL
1171 {"default_transaction_read_only", PGC_USERSET, CLIENT_CONN_STATEMENT,
1172 gettext_noop("Sets the default read-only status of new transactions."),
1175 &DefaultXactReadOnly,
1180 {"transaction_read_only", PGC_USERSET, CLIENT_CONN_STATEMENT,
1181 gettext_noop("Sets the current transaction's read-only status."),
1183 GUC_NO_RESET_ALL | GUC_NOT_IN_SAMPLE | GUC_DISALLOW_IN_FILE
1187 check_transaction_read_only, NULL, NULL
1190 {"default_transaction_deferrable", PGC_USERSET, CLIENT_CONN_STATEMENT,
1191 gettext_noop("Sets the default deferrable status of new transactions."),
1194 &DefaultXactDeferrable,
1199 {"transaction_deferrable", PGC_USERSET, CLIENT_CONN_STATEMENT,
1200 gettext_noop("Whether to defer a read-only serializable transaction until it can be executed with no possible serialization failures."),
1202 GUC_NO_RESET_ALL | GUC_NOT_IN_SAMPLE | GUC_DISALLOW_IN_FILE
1206 check_transaction_deferrable, NULL, NULL
1209 {"check_function_bodies", PGC_USERSET, CLIENT_CONN_STATEMENT,
1210 gettext_noop("Check function bodies during CREATE FUNCTION."),
1213 &check_function_bodies,
1218 {"array_nulls", PGC_USERSET, COMPAT_OPTIONS_PREVIOUS,
1219 gettext_noop("Enable input of NULL elements in arrays."),
1220 gettext_noop("When turned on, unquoted NULL in an array input "
1221 "value means a null value; "
1222 "otherwise it is taken literally.")
1229 {"default_with_oids", PGC_USERSET, COMPAT_OPTIONS_PREVIOUS,
1230 gettext_noop("Create new tables with OIDs by default."),
1238 {"logging_collector", PGC_POSTMASTER, LOGGING_WHERE,
1239 gettext_noop("Start a subprocess to capture stderr output and/or csvlogs into log files."),
1247 {"log_truncate_on_rotation", PGC_SIGHUP, LOGGING_WHERE,
1248 gettext_noop("Truncate existing log files of same name during log rotation."),
1251 &Log_truncate_on_rotation,
1258 {"trace_sort", PGC_USERSET, DEVELOPER_OPTIONS,
1259 gettext_noop("Emit information about resource usage in sorting."),
1269 #ifdef TRACE_SYNCSCAN
1270 /* this is undocumented because not exposed in a standard build */
1272 {"trace_syncscan", PGC_USERSET, DEVELOPER_OPTIONS,
1273 gettext_noop("Generate debugging output for synchronized scanning."),
1283 #ifdef DEBUG_BOUNDED_SORT
1284 /* this is undocumented because not exposed in a standard build */
1287 "optimize_bounded_sort", PGC_USERSET, QUERY_TUNING_METHOD,
1288 gettext_noop("Enable bounded sorting using heap sort."),
1292 &optimize_bounded_sort,
1300 {"wal_debug", PGC_SUSET, DEVELOPER_OPTIONS,
1301 gettext_noop("Emit WAL-related debugging output."),
1312 {"integer_datetimes", PGC_INTERNAL, PRESET_OPTIONS,
1313 gettext_noop("Datetimes are integer based."),
1315 GUC_REPORT | GUC_NOT_IN_SAMPLE | GUC_DISALLOW_IN_FILE
1318 #ifdef HAVE_INT64_TIMESTAMP
1327 {"krb_caseins_users", PGC_SIGHUP, CONN_AUTH_SECURITY,
1328 gettext_noop("Sets whether Kerberos and GSSAPI user names should be treated as case-insensitive."),
1331 &pg_krb_caseins_users,
1337 {"escape_string_warning", PGC_USERSET, COMPAT_OPTIONS_PREVIOUS,
1338 gettext_noop("Warn about backslash escapes in ordinary string literals."),
1341 &escape_string_warning,
1347 {"standard_conforming_strings", PGC_USERSET, COMPAT_OPTIONS_PREVIOUS,
1348 gettext_noop("Causes '...' strings to treat backslashes literally."),
1352 &standard_conforming_strings,
1358 {"synchronize_seqscans", PGC_USERSET, COMPAT_OPTIONS_PREVIOUS,
1359 gettext_noop("Enable synchronized sequential scans."),
1362 &synchronize_seqscans,
1368 {"archive_mode", PGC_POSTMASTER, WAL_ARCHIVING,
1369 gettext_noop("Allows archiving of WAL files using archive_command."),
1378 {"hot_standby", PGC_POSTMASTER, REPLICATION_STANDBY,
1379 gettext_noop("Allows connections and queries during recovery."),
1388 {"hot_standby_feedback", PGC_SIGHUP, REPLICATION_STANDBY,
1389 gettext_noop("Allows feedback from a hot standby to the primary that will avoid query conflicts."),
1392 &hot_standby_feedback,
1398 {"allow_system_table_mods", PGC_POSTMASTER, DEVELOPER_OPTIONS,
1399 gettext_noop("Allows modifications of the structure of system tables."),
1403 &allowSystemTableMods,
1409 {"ignore_system_indexes", PGC_BACKEND, DEVELOPER_OPTIONS,
1410 gettext_noop("Disables reading from system indexes."),
1411 gettext_noop("It does not prevent updating the indexes, so it is safe "
1412 "to use. The worst consequence is slowness."),
1415 &IgnoreSystemIndexes,
1421 {"lo_compat_privileges", PGC_SUSET, COMPAT_OPTIONS_PREVIOUS,
1422 gettext_noop("Enables backward compatibility mode for privilege checks on large objects."),
1423 gettext_noop("Skips privilege checks when reading or modifying large objects, "
1424 "for compatibility with PostgreSQL releases prior to 9.0.")
1426 &lo_compat_privileges,
1432 {"quote_all_identifiers", PGC_USERSET, COMPAT_OPTIONS_PREVIOUS,
1433 gettext_noop("When generating SQL fragments, quote all identifiers."),
1436 "e_all_identifiers,
1441 /* End-of-list marker */
1443 {NULL, 0, 0, NULL, NULL}, NULL, false, NULL, NULL, NULL
1448 static struct config_int ConfigureNamesInt[] =
1451 {"archive_timeout", PGC_SIGHUP, WAL_ARCHIVING,
1452 gettext_noop("Forces a switch to the next xlog file if a "
1453 "new file has not been started within N seconds."),
1457 &XLogArchiveTimeout,
1462 {"post_auth_delay", PGC_BACKEND, DEVELOPER_OPTIONS,
1463 gettext_noop("Waits N seconds on connection startup after authentication."),
1464 gettext_noop("This allows attaching a debugger to the process."),
1465 GUC_NOT_IN_SAMPLE | GUC_UNIT_S
1472 {"default_statistics_target", PGC_USERSET, QUERY_TUNING_OTHER,
1473 gettext_noop("Sets the default statistics target."),
1474 gettext_noop("This applies to table columns that have not had a "
1475 "column-specific target set via ALTER TABLE SET STATISTICS.")
1477 &default_statistics_target,
1482 {"from_collapse_limit", PGC_USERSET, QUERY_TUNING_OTHER,
1483 gettext_noop("Sets the FROM-list size beyond which subqueries "
1484 "are not collapsed."),
1485 gettext_noop("The planner will merge subqueries into upper "
1486 "queries if the resulting FROM list would have no more than "
1489 &from_collapse_limit,
1494 {"join_collapse_limit", PGC_USERSET, QUERY_TUNING_OTHER,
1495 gettext_noop("Sets the FROM-list size beyond which JOIN "
1496 "constructs are not flattened."),
1497 gettext_noop("The planner will flatten explicit JOIN "
1498 "constructs into lists of FROM items whenever a "
1499 "list of no more than this many items would result.")
1501 &join_collapse_limit,
1506 {"geqo_threshold", PGC_USERSET, QUERY_TUNING_GEQO,
1507 gettext_noop("Sets the threshold of FROM items beyond which GEQO is used."),
1515 {"geqo_effort", PGC_USERSET, QUERY_TUNING_GEQO,
1516 gettext_noop("GEQO: effort is used to set the default for other GEQO parameters."),
1520 DEFAULT_GEQO_EFFORT, MIN_GEQO_EFFORT, MAX_GEQO_EFFORT,
1524 {"geqo_pool_size", PGC_USERSET, QUERY_TUNING_GEQO,
1525 gettext_noop("GEQO: number of individuals in the population."),
1526 gettext_noop("Zero selects a suitable default value.")
1533 {"geqo_generations", PGC_USERSET, QUERY_TUNING_GEQO,
1534 gettext_noop("GEQO: number of iterations of the algorithm."),
1535 gettext_noop("Zero selects a suitable default value.")
1543 /* This is PGC_SUSET to prevent hiding from log_lock_waits. */
1544 {"deadlock_timeout", PGC_SUSET, LOCK_MANAGEMENT,
1545 gettext_noop("Sets the time to wait on a lock before checking for deadlock."),
1555 {"max_standby_archive_delay", PGC_SIGHUP, REPLICATION_STANDBY,
1556 gettext_noop("Sets the maximum delay before canceling queries when a hot standby server is processing archived WAL data."),
1560 &max_standby_archive_delay,
1561 30 * 1000, -1, INT_MAX,
1566 {"max_standby_streaming_delay", PGC_SIGHUP, REPLICATION_STANDBY,
1567 gettext_noop("Sets the maximum delay before canceling queries when a hot standby server is processing streamed WAL data."),
1571 &max_standby_streaming_delay,
1572 30 * 1000, -1, INT_MAX,
1577 {"wal_receiver_status_interval", PGC_SIGHUP, REPLICATION_STANDBY,
1578 gettext_noop("Sets the maximum interval between WAL receiver status reports to the primary."),
1582 &wal_receiver_status_interval,
1583 10, 0, INT_MAX / 1000,
1588 {"max_connections", PGC_POSTMASTER, CONN_AUTH_SETTINGS,
1589 gettext_noop("Sets the maximum number of concurrent connections."),
1593 100, 1, MAX_BACKENDS,
1594 check_maxconnections, assign_maxconnections, NULL
1598 {"superuser_reserved_connections", PGC_POSTMASTER, CONN_AUTH_SETTINGS,
1599 gettext_noop("Sets the number of connection slots reserved for superusers."),
1608 * We sometimes multiply the number of shared buffers by two without
1609 * checking for overflow, so we mustn't allow more than INT_MAX / 2.
1612 {"shared_buffers", PGC_POSTMASTER, RESOURCES_MEM,
1613 gettext_noop("Sets the number of shared memory buffers used by the server."),
1618 1024, 16, INT_MAX / 2,
1623 {"temp_buffers", PGC_USERSET, RESOURCES_MEM,
1624 gettext_noop("Sets the maximum number of temporary buffers used by each session."),
1629 1024, 100, INT_MAX / 2,
1630 check_temp_buffers, NULL, NULL
1634 {"port", PGC_POSTMASTER, CONN_AUTH_SETTINGS,
1635 gettext_noop("Sets the TCP port the server listens on."),
1639 DEF_PGPORT, 1, 65535,
1644 {"unix_socket_permissions", PGC_POSTMASTER, CONN_AUTH_SETTINGS,
1645 gettext_noop("Sets the access permissions of the Unix-domain socket."),
1646 gettext_noop("Unix-domain sockets use the usual Unix file system "
1647 "permission set. The parameter value is expected "
1648 "to be a numeric mode specification in the form "
1649 "accepted by the chmod and umask system calls. "
1650 "(To use the customary octal format the number must "
1651 "start with a 0 (zero).)")
1653 &Unix_socket_permissions,
1655 NULL, NULL, show_unix_socket_permissions
1659 {"log_file_mode", PGC_SIGHUP, LOGGING_WHERE,
1660 gettext_noop("Sets the file permissions for log files."),
1661 gettext_noop("The parameter value is expected "
1662 "to be a numeric mode specification in the form "
1663 "accepted by the chmod and umask system calls. "
1664 "(To use the customary octal format the number must "
1665 "start with a 0 (zero).)")
1669 NULL, NULL, show_log_file_mode
1673 {"work_mem", PGC_USERSET, RESOURCES_MEM,
1674 gettext_noop("Sets the maximum memory to be used for query workspaces."),
1675 gettext_noop("This much memory can be used by each internal "
1676 "sort operation and hash table before switching to "
1677 "temporary disk files."),
1681 1024, 64, MAX_KILOBYTES,
1686 {"maintenance_work_mem", PGC_USERSET, RESOURCES_MEM,
1687 gettext_noop("Sets the maximum memory to be used for maintenance operations."),
1688 gettext_noop("This includes operations such as VACUUM and CREATE INDEX."),
1691 &maintenance_work_mem,
1692 16384, 1024, MAX_KILOBYTES,
1697 * We use the hopefully-safely-small value of 100kB as the compiled-in
1698 * default for max_stack_depth. InitializeGUCOptions will increase it if
1699 * possible, depending on the actual platform-specific stack limit.
1702 {"max_stack_depth", PGC_SUSET, RESOURCES_MEM,
1703 gettext_noop("Sets the maximum stack depth, in kilobytes."),
1708 100, 100, MAX_KILOBYTES,
1709 check_max_stack_depth, assign_max_stack_depth, NULL
1713 {"temp_file_limit", PGC_SUSET, RESOURCES_DISK,
1714 gettext_noop("Limits the total size of all temp files used by each session."),
1715 gettext_noop("-1 means no limit."),
1724 {"vacuum_cost_page_hit", PGC_USERSET, RESOURCES_VACUUM_DELAY,
1725 gettext_noop("Vacuum cost for a page found in the buffer cache."),
1734 {"vacuum_cost_page_miss", PGC_USERSET, RESOURCES_VACUUM_DELAY,
1735 gettext_noop("Vacuum cost for a page not found in the buffer cache."),
1738 &VacuumCostPageMiss,
1744 {"vacuum_cost_page_dirty", PGC_USERSET, RESOURCES_VACUUM_DELAY,
1745 gettext_noop("Vacuum cost for a page dirtied by vacuum."),
1748 &VacuumCostPageDirty,
1754 {"vacuum_cost_limit", PGC_USERSET, RESOURCES_VACUUM_DELAY,
1755 gettext_noop("Vacuum cost amount available before napping."),
1764 {"vacuum_cost_delay", PGC_USERSET, RESOURCES_VACUUM_DELAY,
1765 gettext_noop("Vacuum cost delay in milliseconds."),
1775 {"autovacuum_vacuum_cost_delay", PGC_SIGHUP, AUTOVACUUM,
1776 gettext_noop("Vacuum cost delay in milliseconds, for autovacuum."),
1780 &autovacuum_vac_cost_delay,
1786 {"autovacuum_vacuum_cost_limit", PGC_SIGHUP, AUTOVACUUM,
1787 gettext_noop("Vacuum cost amount available before napping, for autovacuum."),
1790 &autovacuum_vac_cost_limit,
1796 {"max_files_per_process", PGC_POSTMASTER, RESOURCES_KERNEL,
1797 gettext_noop("Sets the maximum number of simultaneously open files for each server process."),
1800 &max_files_per_process,
1806 * See also CheckRequiredParameterValues() if this parameter changes
1809 {"max_prepared_transactions", PGC_POSTMASTER, RESOURCES_MEM,
1810 gettext_noop("Sets the maximum number of simultaneously prepared transactions."),
1813 &max_prepared_xacts,
1820 {"trace_lock_oidmin", PGC_SUSET, DEVELOPER_OPTIONS,
1821 gettext_noop("No description available."),
1826 FirstNormalObjectId, 0, INT_MAX,
1830 {"trace_lock_table", PGC_SUSET, DEVELOPER_OPTIONS,
1831 gettext_noop("No description available."),
1842 {"statement_timeout", PGC_USERSET, CLIENT_CONN_STATEMENT,
1843 gettext_noop("Sets the maximum allowed duration of any statement."),
1844 gettext_noop("A value of 0 turns off the timeout."),
1853 {"vacuum_freeze_min_age", PGC_USERSET, CLIENT_CONN_STATEMENT,
1854 gettext_noop("Minimum age at which VACUUM should freeze a table row."),
1857 &vacuum_freeze_min_age,
1858 50000000, 0, 1000000000,
1863 {"vacuum_freeze_table_age", PGC_USERSET, CLIENT_CONN_STATEMENT,
1864 gettext_noop("Age at which VACUUM should scan whole table to freeze tuples."),
1867 &vacuum_freeze_table_age,
1868 150000000, 0, 2000000000,
1873 {"vacuum_defer_cleanup_age", PGC_SIGHUP, REPLICATION_MASTER,
1874 gettext_noop("Number of transactions by which VACUUM and HOT cleanup should be deferred, if any."),
1877 &vacuum_defer_cleanup_age,
1883 * See also CheckRequiredParameterValues() if this parameter changes
1886 {"max_locks_per_transaction", PGC_POSTMASTER, LOCK_MANAGEMENT,
1887 gettext_noop("Sets the maximum number of locks per transaction."),
1888 gettext_noop("The shared lock table is sized on the assumption that "
1889 "at most max_locks_per_transaction * max_connections distinct "
1890 "objects will need to be locked at any one time.")
1892 &max_locks_per_xact,
1898 {"max_pred_locks_per_transaction", PGC_POSTMASTER, LOCK_MANAGEMENT,
1899 gettext_noop("Sets the maximum number of predicate locks per transaction."),
1900 gettext_noop("The shared predicate lock table is sized on the assumption that "
1901 "at most max_pred_locks_per_transaction * max_connections distinct "
1902 "objects will need to be locked at any one time.")
1904 &max_predicate_locks_per_xact,
1910 {"authentication_timeout", PGC_SIGHUP, CONN_AUTH_SECURITY,
1911 gettext_noop("Sets the maximum allowed time to complete client authentication."),
1915 &AuthenticationTimeout,
1921 /* Not for general use */
1922 {"pre_auth_delay", PGC_SIGHUP, DEVELOPER_OPTIONS,
1923 gettext_noop("Waits N seconds on connection startup before authentication."),
1924 gettext_noop("This allows attaching a debugger to the process."),
1925 GUC_NOT_IN_SAMPLE | GUC_UNIT_S
1933 {"wal_keep_segments", PGC_SIGHUP, REPLICATION_SENDING,
1934 gettext_noop("Sets the number of WAL files held for standby servers."),
1943 {"checkpoint_segments", PGC_SIGHUP, WAL_CHECKPOINTS,
1944 gettext_noop("Sets the maximum distance in log segments between automatic WAL checkpoints."),
1947 &CheckPointSegments,
1953 {"checkpoint_timeout", PGC_SIGHUP, WAL_CHECKPOINTS,
1954 gettext_noop("Sets the maximum time between automatic WAL checkpoints."),
1964 {"checkpoint_warning", PGC_SIGHUP, WAL_CHECKPOINTS,
1965 gettext_noop("Enables warnings if checkpoint segments are filled more "
1966 "frequently than this."),
1967 gettext_noop("Write a message to the server log if checkpoints "
1968 "caused by the filling of checkpoint segment files happens more "
1969 "frequently than this number of seconds. Zero turns off the warning."),
1978 {"wal_buffers", PGC_POSTMASTER, WAL_SETTINGS,
1979 gettext_noop("Sets the number of disk-page buffers in shared memory for WAL."),
1985 check_wal_buffers, NULL, NULL
1989 {"wal_writer_delay", PGC_SIGHUP, WAL_SETTINGS,
1990 gettext_noop("WAL writer sleep time between WAL flushes."),
2000 /* see max_connections */
2001 {"max_wal_senders", PGC_POSTMASTER, REPLICATION_SENDING,
2002 gettext_noop("Sets the maximum number of simultaneously running WAL sender processes."),
2011 {"replication_timeout", PGC_SIGHUP, REPLICATION_SENDING,
2012 gettext_noop("Sets the maximum time to wait for WAL replication."),
2016 &replication_timeout,
2017 60 * 1000, 0, INT_MAX,
2022 {"commit_delay", PGC_USERSET, WAL_SETTINGS,
2023 gettext_noop("Sets the delay in microseconds between transaction commit and "
2024 "flushing WAL to disk."),
2033 {"commit_siblings", PGC_USERSET, WAL_SETTINGS,
2034 gettext_noop("Sets the minimum concurrent open transactions before performing "
2044 {"extra_float_digits", PGC_USERSET, CLIENT_CONN_LOCALE,
2045 gettext_noop("Sets the number of digits displayed for floating-point values."),
2046 gettext_noop("This affects real, double precision, and geometric data types. "
2047 "The parameter value is added to the standard number of digits "
2048 "(FLT_DIG or DBL_DIG as appropriate).")
2050 &extra_float_digits,
2056 {"log_min_duration_statement", PGC_SUSET, LOGGING_WHEN,
2057 gettext_noop("Sets the minimum execution time above which "
2058 "statements will be logged."),
2059 gettext_noop("Zero prints all queries. -1 turns this feature off."),
2062 &log_min_duration_statement,
2068 {"log_autovacuum_min_duration", PGC_SIGHUP, LOGGING_WHAT,
2069 gettext_noop("Sets the minimum execution time above which "
2070 "autovacuum actions will be logged."),
2071 gettext_noop("Zero prints all actions. -1 turns autovacuum logging off."),
2074 &Log_autovacuum_min_duration,
2080 {"bgwriter_delay", PGC_SIGHUP, RESOURCES_BGWRITER,
2081 gettext_noop("Background writer sleep time between rounds."),
2091 {"bgwriter_lru_maxpages", PGC_SIGHUP, RESOURCES_BGWRITER,
2092 gettext_noop("Background writer maximum number of LRU pages to flush per round."),
2095 &bgwriter_lru_maxpages,
2101 {"effective_io_concurrency",
2107 RESOURCES_ASYNCHRONOUS,
2108 gettext_noop("Number of simultaneous requests that can be handled efficiently by the disk subsystem."),
2109 gettext_noop("For RAID arrays, this should be approximately the number of drive spindles in the array.")
2111 &effective_io_concurrency,
2117 check_effective_io_concurrency, assign_effective_io_concurrency, NULL
2121 {"log_rotation_age", PGC_SIGHUP, LOGGING_WHERE,
2122 gettext_noop("Automatic log file rotation will occur after N minutes."),
2127 HOURS_PER_DAY * MINS_PER_HOUR, 0, INT_MAX / MINS_PER_HOUR,
2132 {"log_rotation_size", PGC_SIGHUP, LOGGING_WHERE,
2133 gettext_noop("Automatic log file rotation will occur after N kilobytes."),
2138 10 * 1024, 0, INT_MAX / 1024,
2143 {"max_function_args", PGC_INTERNAL, PRESET_OPTIONS,
2144 gettext_noop("Shows the maximum number of function arguments."),
2146 GUC_NOT_IN_SAMPLE | GUC_DISALLOW_IN_FILE
2149 FUNC_MAX_ARGS, FUNC_MAX_ARGS, FUNC_MAX_ARGS,
2154 {"max_index_keys", PGC_INTERNAL, PRESET_OPTIONS,
2155 gettext_noop("Shows the maximum number of index keys."),
2157 GUC_NOT_IN_SAMPLE | GUC_DISALLOW_IN_FILE
2160 INDEX_MAX_KEYS, INDEX_MAX_KEYS, INDEX_MAX_KEYS,
2165 {"max_identifier_length", PGC_INTERNAL, PRESET_OPTIONS,
2166 gettext_noop("Shows the maximum identifier length."),
2168 GUC_NOT_IN_SAMPLE | GUC_DISALLOW_IN_FILE
2170 &max_identifier_length,
2171 NAMEDATALEN - 1, NAMEDATALEN - 1, NAMEDATALEN - 1,
2176 {"block_size", PGC_INTERNAL, PRESET_OPTIONS,
2177 gettext_noop("Shows the size of a disk block."),
2179 GUC_NOT_IN_SAMPLE | GUC_DISALLOW_IN_FILE
2182 BLCKSZ, BLCKSZ, BLCKSZ,
2187 {"segment_size", PGC_INTERNAL, PRESET_OPTIONS,
2188 gettext_noop("Shows the number of pages per disk file."),
2190 GUC_UNIT_BLOCKS | GUC_NOT_IN_SAMPLE | GUC_DISALLOW_IN_FILE
2193 RELSEG_SIZE, RELSEG_SIZE, RELSEG_SIZE,
2198 {"wal_block_size", PGC_INTERNAL, PRESET_OPTIONS,
2199 gettext_noop("Shows the block size in the write ahead log."),
2201 GUC_NOT_IN_SAMPLE | GUC_DISALLOW_IN_FILE
2204 XLOG_BLCKSZ, XLOG_BLCKSZ, XLOG_BLCKSZ,
2209 {"wal_segment_size", PGC_INTERNAL, PRESET_OPTIONS,
2210 gettext_noop("Shows the number of pages per write ahead log segment."),
2212 GUC_UNIT_XBLOCKS | GUC_NOT_IN_SAMPLE | GUC_DISALLOW_IN_FILE
2215 (XLOG_SEG_SIZE / XLOG_BLCKSZ),
2216 (XLOG_SEG_SIZE / XLOG_BLCKSZ),
2217 (XLOG_SEG_SIZE / XLOG_BLCKSZ),
2222 {"autovacuum_naptime", PGC_SIGHUP, AUTOVACUUM,
2223 gettext_noop("Time to sleep between autovacuum runs."),
2227 &autovacuum_naptime,
2228 60, 1, INT_MAX / 1000,
2232 {"autovacuum_vacuum_threshold", PGC_SIGHUP, AUTOVACUUM,
2233 gettext_noop("Minimum number of tuple updates or deletes prior to vacuum."),
2236 &autovacuum_vac_thresh,
2241 {"autovacuum_analyze_threshold", PGC_SIGHUP, AUTOVACUUM,
2242 gettext_noop("Minimum number of tuple inserts, updates or deletes prior to analyze."),
2245 &autovacuum_anl_thresh,
2250 /* see varsup.c for why this is PGC_POSTMASTER not PGC_SIGHUP */
2251 {"autovacuum_freeze_max_age", PGC_POSTMASTER, AUTOVACUUM,
2252 gettext_noop("Age at which to autovacuum a table to prevent transaction ID wraparound."),
2255 &autovacuum_freeze_max_age,
2256 /* see pg_resetxlog if you change the upper-limit value */
2257 200000000, 100000000, 2000000000,
2261 /* see max_connections */
2262 {"autovacuum_max_workers", PGC_POSTMASTER, AUTOVACUUM,
2263 gettext_noop("Sets the maximum number of simultaneously running autovacuum worker processes."),
2266 &autovacuum_max_workers,
2268 check_autovacuum_max_workers, assign_autovacuum_max_workers, NULL
2272 {"tcp_keepalives_idle", PGC_USERSET, CLIENT_CONN_OTHER,
2273 gettext_noop("Time between issuing TCP keepalives."),
2274 gettext_noop("A value of 0 uses the system default."),
2277 &tcp_keepalives_idle,
2279 NULL, assign_tcp_keepalives_idle, show_tcp_keepalives_idle
2283 {"tcp_keepalives_interval", PGC_USERSET, CLIENT_CONN_OTHER,
2284 gettext_noop("Time between TCP keepalive retransmits."),
2285 gettext_noop("A value of 0 uses the system default."),
2288 &tcp_keepalives_interval,
2290 NULL, assign_tcp_keepalives_interval, show_tcp_keepalives_interval
2294 {"ssl_renegotiation_limit", PGC_USERSET, CONN_AUTH_SECURITY,
2295 gettext_noop("Set the amount of traffic to send and receive before renegotiating the encryption keys."),
2299 &ssl_renegotiation_limit,
2300 512 * 1024, 0, MAX_KILOBYTES,
2305 {"tcp_keepalives_count", PGC_USERSET, CLIENT_CONN_OTHER,
2306 gettext_noop("Maximum number of TCP keepalive retransmits."),
2307 gettext_noop("This controls the number of consecutive keepalive retransmits that can be "
2308 "lost before a connection is considered dead. A value of 0 uses the "
2311 &tcp_keepalives_count,
2313 NULL, assign_tcp_keepalives_count, show_tcp_keepalives_count
2317 {"gin_fuzzy_search_limit", PGC_USERSET, CLIENT_CONN_OTHER,
2318 gettext_noop("Sets the maximum allowed result for exact search by GIN."),
2322 &GinFuzzySearchLimit,
2328 {"effective_cache_size", PGC_USERSET, QUERY_TUNING_COST,
2329 gettext_noop("Sets the planner's assumption about the size of the disk cache."),
2330 gettext_noop("That is, the portion of the kernel's disk cache that "
2331 "will be used for PostgreSQL data files. This is measured in disk "
2332 "pages, which are normally 8 kB each."),
2335 &effective_cache_size,
2336 DEFAULT_EFFECTIVE_CACHE_SIZE, 1, INT_MAX,
2341 /* Can't be set in postgresql.conf */
2342 {"server_version_num", PGC_INTERNAL, PRESET_OPTIONS,
2343 gettext_noop("Shows the server version as an integer."),
2345 GUC_NOT_IN_SAMPLE | GUC_DISALLOW_IN_FILE
2347 &server_version_num,
2348 PG_VERSION_NUM, PG_VERSION_NUM, PG_VERSION_NUM,
2353 {"log_temp_files", PGC_SUSET, LOGGING_WHAT,
2354 gettext_noop("Log the use of temporary files larger than this number of kilobytes."),
2355 gettext_noop("Zero logs all files. The default is -1 (turning this feature off)."),
2364 {"track_activity_query_size", PGC_POSTMASTER, RESOURCES_MEM,
2365 gettext_noop("Sets the size reserved for pg_stat_activity.query, in bytes."),
2368 &pgstat_track_activity_query_size,
2373 /* End-of-list marker */
2375 {NULL, 0, 0, NULL, NULL}, NULL, 0, 0, 0, NULL, NULL, NULL
2380 static struct config_real ConfigureNamesReal[] =
2383 {"seq_page_cost", PGC_USERSET, QUERY_TUNING_COST,
2384 gettext_noop("Sets the planner's estimate of the cost of a "
2385 "sequentially fetched disk page."),
2389 DEFAULT_SEQ_PAGE_COST, 0, DBL_MAX,
2393 {"random_page_cost", PGC_USERSET, QUERY_TUNING_COST,
2394 gettext_noop("Sets the planner's estimate of the cost of a "
2395 "nonsequentially fetched disk page."),
2399 DEFAULT_RANDOM_PAGE_COST, 0, DBL_MAX,
2403 {"cpu_tuple_cost", PGC_USERSET, QUERY_TUNING_COST,
2404 gettext_noop("Sets the planner's estimate of the cost of "
2405 "processing each tuple (row)."),
2409 DEFAULT_CPU_TUPLE_COST, 0, DBL_MAX,
2413 {"cpu_index_tuple_cost", PGC_USERSET, QUERY_TUNING_COST,
2414 gettext_noop("Sets the planner's estimate of the cost of "
2415 "processing each index entry during an index scan."),
2418 &cpu_index_tuple_cost,
2419 DEFAULT_CPU_INDEX_TUPLE_COST, 0, DBL_MAX,
2423 {"cpu_operator_cost", PGC_USERSET, QUERY_TUNING_COST,
2424 gettext_noop("Sets the planner's estimate of the cost of "
2425 "processing each operator or function call."),
2429 DEFAULT_CPU_OPERATOR_COST, 0, DBL_MAX,
2434 {"cursor_tuple_fraction", PGC_USERSET, QUERY_TUNING_OTHER,
2435 gettext_noop("Sets the planner's estimate of the fraction of "
2436 "a cursor's rows that will be retrieved."),
2439 &cursor_tuple_fraction,
2440 DEFAULT_CURSOR_TUPLE_FRACTION, 0.0, 1.0,
2445 {"geqo_selection_bias", PGC_USERSET, QUERY_TUNING_GEQO,
2446 gettext_noop("GEQO: selective pressure within the population."),
2449 &Geqo_selection_bias,
2450 DEFAULT_GEQO_SELECTION_BIAS,
2451 MIN_GEQO_SELECTION_BIAS, MAX_GEQO_SELECTION_BIAS,
2455 {"geqo_seed", PGC_USERSET, QUERY_TUNING_GEQO,
2456 gettext_noop("GEQO: seed for random path selection."),
2465 {"bgwriter_lru_multiplier", PGC_SIGHUP, RESOURCES_BGWRITER,
2466 gettext_noop("Multiple of the average buffer usage to free per round."),
2469 &bgwriter_lru_multiplier,
2475 {"seed", PGC_USERSET, UNGROUPED,
2476 gettext_noop("Sets the seed for random-number generation."),
2478 GUC_NO_SHOW_ALL | GUC_NO_RESET_ALL | GUC_NOT_IN_SAMPLE | GUC_DISALLOW_IN_FILE
2482 check_random_seed, assign_random_seed, show_random_seed
2486 {"autovacuum_vacuum_scale_factor", PGC_SIGHUP, AUTOVACUUM,
2487 gettext_noop("Number of tuple updates or deletes prior to vacuum as a fraction of reltuples."),
2490 &autovacuum_vac_scale,
2495 {"autovacuum_analyze_scale_factor", PGC_SIGHUP, AUTOVACUUM,
2496 gettext_noop("Number of tuple inserts, updates or deletes prior to analyze as a fraction of reltuples."),
2499 &autovacuum_anl_scale,
2505 {"checkpoint_completion_target", PGC_SIGHUP, WAL_CHECKPOINTS,
2506 gettext_noop("Time spent flushing dirty buffers during checkpoint, as fraction of checkpoint interval."),
2509 &CheckPointCompletionTarget,
2514 /* End-of-list marker */
2516 {NULL, 0, 0, NULL, NULL}, NULL, 0.0, 0.0, 0.0, NULL, NULL, NULL
2521 static struct config_string ConfigureNamesString[] =
2524 {"archive_command", PGC_SIGHUP, WAL_ARCHIVING,
2525 gettext_noop("Sets the shell command that will be called to archive a WAL file."),
2528 &XLogArchiveCommand,
2530 NULL, NULL, show_archive_command
2534 {"client_encoding", PGC_USERSET, CLIENT_CONN_LOCALE,
2535 gettext_noop("Sets the client's character set encoding."),
2537 GUC_IS_NAME | GUC_REPORT
2539 &client_encoding_string,
2541 check_client_encoding, assign_client_encoding, NULL
2545 {"log_line_prefix", PGC_SIGHUP, LOGGING_WHAT,
2546 gettext_noop("Controls information prefixed to each log line."),
2547 gettext_noop("If blank, no prefix is used.")
2555 {"log_timezone", PGC_SIGHUP, LOGGING_WHAT,
2556 gettext_noop("Sets the time zone to use in log messages."),
2559 &log_timezone_string,
2561 check_log_timezone, assign_log_timezone, show_log_timezone
2565 {"DateStyle", PGC_USERSET, CLIENT_CONN_LOCALE,
2566 gettext_noop("Sets the display format for date and time values."),
2567 gettext_noop("Also controls interpretation of ambiguous "
2569 GUC_LIST_INPUT | GUC_REPORT
2573 check_datestyle, assign_datestyle, NULL
2577 {"default_tablespace", PGC_USERSET, CLIENT_CONN_STATEMENT,
2578 gettext_noop("Sets the default tablespace to create tables and indexes in."),
2579 gettext_noop("An empty string selects the database's default tablespace."),
2582 &default_tablespace,
2584 check_default_tablespace, NULL, NULL
2588 {"temp_tablespaces", PGC_USERSET, CLIENT_CONN_STATEMENT,
2589 gettext_noop("Sets the tablespace(s) to use for temporary tables and sort files."),
2591 GUC_LIST_INPUT | GUC_LIST_QUOTE
2595 check_temp_tablespaces, assign_temp_tablespaces, NULL
2599 {"dynamic_library_path", PGC_SUSET, CLIENT_CONN_OTHER,
2600 gettext_noop("Sets the path for dynamically loadable modules."),
2601 gettext_noop("If a dynamically loadable module needs to be opened and "
2602 "the specified name does not have a directory component (i.e., the "
2603 "name does not contain a slash), the system will search this path for "
2604 "the specified file."),
2607 &Dynamic_library_path,
2613 {"krb_server_keyfile", PGC_SIGHUP, CONN_AUTH_SECURITY,
2614 gettext_noop("Sets the location of the Kerberos server key file."),
2618 &pg_krb_server_keyfile,
2624 {"krb_srvname", PGC_SIGHUP, CONN_AUTH_SECURITY,
2625 gettext_noop("Sets the name of the Kerberos service."),
2634 {"bonjour_name", PGC_POSTMASTER, CONN_AUTH_SETTINGS,
2635 gettext_noop("Sets the Bonjour service name."),
2643 /* See main.c about why defaults for LC_foo are not all alike */
2646 {"lc_collate", PGC_INTERNAL, CLIENT_CONN_LOCALE,
2647 gettext_noop("Shows the collation order locale."),
2649 GUC_NOT_IN_SAMPLE | GUC_DISALLOW_IN_FILE
2657 {"lc_ctype", PGC_INTERNAL, CLIENT_CONN_LOCALE,
2658 gettext_noop("Shows the character classification and case conversion locale."),
2660 GUC_NOT_IN_SAMPLE | GUC_DISALLOW_IN_FILE
2668 {"lc_messages", PGC_SUSET, CLIENT_CONN_LOCALE,
2669 gettext_noop("Sets the language in which messages are displayed."),
2674 check_locale_messages, assign_locale_messages, NULL
2678 {"lc_monetary", PGC_USERSET, CLIENT_CONN_LOCALE,
2679 gettext_noop("Sets the locale for formatting monetary amounts."),
2684 check_locale_monetary, assign_locale_monetary, NULL
2688 {"lc_numeric", PGC_USERSET, CLIENT_CONN_LOCALE,
2689 gettext_noop("Sets the locale for formatting numbers."),
2694 check_locale_numeric, assign_locale_numeric, NULL
2698 {"lc_time", PGC_USERSET, CLIENT_CONN_LOCALE,
2699 gettext_noop("Sets the locale for formatting date and time values."),
2704 check_locale_time, assign_locale_time, NULL
2708 {"shared_preload_libraries", PGC_POSTMASTER, RESOURCES_KERNEL,
2709 gettext_noop("Lists shared libraries to preload into server."),
2711 GUC_LIST_INPUT | GUC_LIST_QUOTE | GUC_SUPERUSER_ONLY
2713 &shared_preload_libraries_string,
2719 {"local_preload_libraries", PGC_BACKEND, CLIENT_CONN_OTHER,
2720 gettext_noop("Lists shared libraries to preload into each backend."),
2722 GUC_LIST_INPUT | GUC_LIST_QUOTE
2724 &local_preload_libraries_string,
2730 {"search_path", PGC_USERSET, CLIENT_CONN_STATEMENT,
2731 gettext_noop("Sets the schema search order for names that are not schema-qualified."),
2733 GUC_LIST_INPUT | GUC_LIST_QUOTE
2735 &namespace_search_path,
2737 check_search_path, assign_search_path, NULL
2741 /* Can't be set in postgresql.conf */
2742 {"server_encoding", PGC_INTERNAL, CLIENT_CONN_LOCALE,
2743 gettext_noop("Sets the server (database) character set encoding."),
2745 GUC_IS_NAME | GUC_REPORT | GUC_NOT_IN_SAMPLE | GUC_DISALLOW_IN_FILE
2747 &server_encoding_string,
2753 /* Can't be set in postgresql.conf */
2754 {"server_version", PGC_INTERNAL, PRESET_OPTIONS,
2755 gettext_noop("Shows the server version."),
2757 GUC_REPORT | GUC_NOT_IN_SAMPLE | GUC_DISALLOW_IN_FILE
2759 &server_version_string,
2765 /* Not for general use --- used by SET ROLE */
2766 {"role", PGC_USERSET, UNGROUPED,
2767 gettext_noop("Sets the current role."),
2769 GUC_IS_NAME | GUC_NO_SHOW_ALL | GUC_NO_RESET_ALL | GUC_NOT_IN_SAMPLE | GUC_DISALLOW_IN_FILE | GUC_NOT_WHILE_SEC_REST
2773 check_role, assign_role, show_role
2777 /* Not for general use --- used by SET SESSION AUTHORIZATION */
2778 {"session_authorization", PGC_USERSET, UNGROUPED,
2779 gettext_noop("Sets the session user name."),
2781 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
2783 &session_authorization_string,
2785 check_session_authorization, assign_session_authorization, NULL
2789 {"log_destination", PGC_SIGHUP, LOGGING_WHERE,
2790 gettext_noop("Sets the destination for server log output."),
2791 gettext_noop("Valid values are combinations of \"stderr\", "
2792 "\"syslog\", \"csvlog\", and \"eventlog\", "
2793 "depending on the platform."),
2796 &log_destination_string,
2798 check_log_destination, assign_log_destination, NULL
2801 {"log_directory", PGC_SIGHUP, LOGGING_WHERE,
2802 gettext_noop("Sets the destination directory for log files."),
2803 gettext_noop("Can be specified as relative to the data directory "
2804 "or as absolute path."),
2809 check_canonical_path, NULL, NULL
2812 {"log_filename", PGC_SIGHUP, LOGGING_WHERE,
2813 gettext_noop("Sets the file name pattern for log files."),
2818 "postgresql-%Y-%m-%d_%H%M%S.log",
2823 {"syslog_ident", PGC_SIGHUP, LOGGING_WHERE,
2824 gettext_noop("Sets the program name used to identify PostgreSQL "
2825 "messages in syslog."),
2830 NULL, assign_syslog_ident, NULL
2834 {"event_source", PGC_POSTMASTER, LOGGING_WHERE,
2835 gettext_noop("Sets the application name used to identify"
2836 "PostgreSQL messages in the event log."),
2845 {"TimeZone", PGC_USERSET, CLIENT_CONN_LOCALE,
2846 gettext_noop("Sets the time zone for displaying and interpreting time stamps."),
2852 check_timezone, assign_timezone, show_timezone
2855 {"timezone_abbreviations", PGC_USERSET, CLIENT_CONN_LOCALE,
2856 gettext_noop("Selects a file of time zone abbreviations."),
2859 &timezone_abbreviations_string,
2861 check_timezone_abbreviations, assign_timezone_abbreviations, NULL
2865 {"transaction_isolation", PGC_USERSET, CLIENT_CONN_STATEMENT,
2866 gettext_noop("Sets the current transaction's isolation level."),
2868 GUC_NO_RESET_ALL | GUC_NOT_IN_SAMPLE | GUC_DISALLOW_IN_FILE
2870 &XactIsoLevel_string,
2872 check_XactIsoLevel, assign_XactIsoLevel, show_XactIsoLevel
2876 {"unix_socket_group", PGC_POSTMASTER, CONN_AUTH_SETTINGS,
2877 gettext_noop("Sets the owning group of the Unix-domain socket."),
2878 gettext_noop("The owning user of the socket is always the user "
2879 "that starts the server.")
2887 {"unix_socket_directory", PGC_POSTMASTER, CONN_AUTH_SETTINGS,
2888 gettext_noop("Sets the directory where the Unix-domain socket will be created."),
2894 check_canonical_path, NULL, NULL
2898 {"listen_addresses", PGC_POSTMASTER, CONN_AUTH_SETTINGS,
2899 gettext_noop("Sets the host name or IP address(es) to listen to."),
2909 {"data_directory", PGC_POSTMASTER, FILE_LOCATIONS,
2910 gettext_noop("Sets the server's data directory."),
2920 {"config_file", PGC_POSTMASTER, FILE_LOCATIONS,
2921 gettext_noop("Sets the server's main configuration file."),
2923 GUC_DISALLOW_IN_FILE | GUC_SUPERUSER_ONLY
2931 {"hba_file", PGC_POSTMASTER, FILE_LOCATIONS,
2932 gettext_noop("Sets the server's \"hba\" configuration file."),
2942 {"ident_file", PGC_POSTMASTER, FILE_LOCATIONS,
2943 gettext_noop("Sets the server's \"ident\" configuration file."),
2953 {"external_pid_file", PGC_POSTMASTER, FILE_LOCATIONS,
2954 gettext_noop("Writes the postmaster PID to the specified file."),
2960 check_canonical_path, NULL, NULL
2964 {"stats_temp_directory", PGC_SIGHUP, STATS_COLLECTOR,
2965 gettext_noop("Writes temporary statistics files to the specified directory."),
2969 &pgstat_temp_directory,
2971 check_canonical_path, assign_pgstat_temp_directory, NULL
2975 {"synchronous_standby_names", PGC_SIGHUP, REPLICATION_MASTER,
2976 gettext_noop("List of names of potential synchronous standbys."),
2980 &SyncRepStandbyNames,
2982 check_synchronous_standby_names, NULL, NULL
2986 {"default_text_search_config", PGC_USERSET, CLIENT_CONN_LOCALE,
2987 gettext_noop("Sets default text search configuration."),
2991 "pg_catalog.simple",
2992 check_TSCurrentConfig, assign_TSCurrentConfig, NULL
2996 {"ssl_ciphers", PGC_POSTMASTER, CONN_AUTH_SECURITY,
2997 gettext_noop("Sets the list of allowed SSL ciphers."),
3003 "ALL:!ADH:!LOW:!EXP:!MD5:@STRENGTH",
3011 {"application_name", PGC_USERSET, LOGGING_WHAT,
3012 gettext_noop("Sets the application name to be reported in statistics and logs."),
3014 GUC_IS_NAME | GUC_REPORT | GUC_NOT_IN_SAMPLE
3018 check_application_name, assign_application_name, NULL
3021 /* End-of-list marker */
3023 {NULL, 0, 0, NULL, NULL}, NULL, NULL, NULL, NULL, NULL
3028 static struct config_enum ConfigureNamesEnum[] =
3031 {"backslash_quote", PGC_USERSET, COMPAT_OPTIONS_PREVIOUS,
3032 gettext_noop("Sets whether \"\\'\" is allowed in string literals."),
3036 BACKSLASH_QUOTE_SAFE_ENCODING, backslash_quote_options,
3041 {"bytea_output", PGC_USERSET, CLIENT_CONN_STATEMENT,
3042 gettext_noop("Sets the output format for bytea."),
3046 BYTEA_OUTPUT_HEX, bytea_output_options,
3051 {"client_min_messages", PGC_USERSET, LOGGING_WHEN,
3052 gettext_noop("Sets the message levels that are sent to the client."),
3053 gettext_noop("Each level includes all the levels that follow it. The later"
3054 " the level, the fewer messages are sent.")
3056 &client_min_messages,
3057 NOTICE, client_message_level_options,
3062 {"constraint_exclusion", PGC_USERSET, QUERY_TUNING_OTHER,
3063 gettext_noop("Enables the planner to use constraints to optimize queries."),
3064 gettext_noop("Table scans will be skipped if their constraints"
3065 " guarantee that no rows match the query.")
3067 &constraint_exclusion,
3068 CONSTRAINT_EXCLUSION_PARTITION, constraint_exclusion_options,
3073 {"default_transaction_isolation", PGC_USERSET, CLIENT_CONN_STATEMENT,
3074 gettext_noop("Sets the transaction isolation level of each new transaction."),
3077 &DefaultXactIsoLevel,
3078 XACT_READ_COMMITTED, isolation_level_options,
3083 {"IntervalStyle", PGC_USERSET, CLIENT_CONN_LOCALE,
3084 gettext_noop("Sets the display format for interval values."),
3089 INTSTYLE_POSTGRES, intervalstyle_options,
3094 {"log_error_verbosity", PGC_SUSET, LOGGING_WHAT,
3095 gettext_noop("Sets the verbosity of logged messages."),
3098 &Log_error_verbosity,
3099 PGERROR_DEFAULT, log_error_verbosity_options,
3104 {"log_min_messages", PGC_SUSET, LOGGING_WHEN,
3105 gettext_noop("Sets the message levels that are logged."),
3106 gettext_noop("Each level includes all the levels that follow it. The later"
3107 " the level, the fewer messages are sent.")
3110 WARNING, server_message_level_options,
3115 {"log_min_error_statement", PGC_SUSET, LOGGING_WHEN,
3116 gettext_noop("Causes all statements generating error at or above this level to be logged."),
3117 gettext_noop("Each level includes all the levels that follow it. The later"
3118 " the level, the fewer messages are sent.")
3120 &log_min_error_statement,
3121 ERROR, server_message_level_options,
3126 {"log_statement", PGC_SUSET, LOGGING_WHAT,
3127 gettext_noop("Sets the type of statements logged."),
3131 LOGSTMT_NONE, log_statement_options,
3136 {"syslog_facility", PGC_SIGHUP, LOGGING_WHERE,
3137 gettext_noop("Sets the syslog \"facility\" to be used when syslog enabled."),
3146 syslog_facility_options,
3147 NULL, assign_syslog_facility, NULL
3151 {"session_replication_role", PGC_SUSET, CLIENT_CONN_STATEMENT,
3152 gettext_noop("Sets the session's behavior for triggers and rewrite rules."),
3155 &SessionReplicationRole,
3156 SESSION_REPLICATION_ROLE_ORIGIN, session_replication_role_options,
3157 NULL, assign_session_replication_role, NULL
3161 {"synchronous_commit", PGC_USERSET, WAL_SETTINGS,
3162 gettext_noop("Sets the current transaction's synchronization level."),
3165 &synchronous_commit,
3166 SYNCHRONOUS_COMMIT_ON, synchronous_commit_options,
3171 {"trace_recovery_messages", PGC_SIGHUP, DEVELOPER_OPTIONS,
3172 gettext_noop("Enables logging of recovery-related debugging information."),
3173 gettext_noop("Each level includes all the levels that follow it. The later"
3174 " the level, the fewer messages are sent.")
3176 &trace_recovery_messages,
3179 * client_message_level_options allows too many values, really, but
3180 * it's not worth having a separate options array for this.
3182 LOG, client_message_level_options,
3187 {"track_functions", PGC_SUSET, STATS_COLLECTOR,
3188 gettext_noop("Collects function-level statistics on database activity."),
3191 &pgstat_track_functions,
3192 TRACK_FUNC_OFF, track_function_options,
3197 {"wal_level", PGC_POSTMASTER, WAL_SETTINGS,
3198 gettext_noop("Set the level of information written to the WAL."),
3202 WAL_LEVEL_MINIMAL, wal_level_options,
3207 {"wal_sync_method", PGC_SIGHUP, WAL_SETTINGS,
3208 gettext_noop("Selects the method used for forcing WAL updates to disk."),
3212 DEFAULT_SYNC_METHOD, sync_method_options,
3213 NULL, assign_xlog_sync_method, NULL
3217 {"xmlbinary", PGC_USERSET, CLIENT_CONN_STATEMENT,
3218 gettext_noop("Sets how binary values are to be encoded in XML."),
3222 XMLBINARY_BASE64, xmlbinary_options,
3227 {"xmloption", PGC_USERSET, CLIENT_CONN_STATEMENT,
3228 gettext_noop("Sets whether XML data in implicit parsing and serialization "
3229 "operations is to be considered as documents or content fragments."),
3233 XMLOPTION_CONTENT, xmloption_options,
3238 /* End-of-list marker */
3240 {NULL, 0, 0, NULL, NULL}, NULL, 0, NULL, NULL, NULL, NULL
3244 /******** end of options list ********/
3248 * To allow continued support of obsolete names for GUC variables, we apply
3249 * the following mappings to any unrecognized name. Note that an old name
3250 * should be mapped to a new one only if the new variable has very similar
3251 * semantics to the old.
3253 static const char *const map_old_guc_names[] = {
3254 "sort_mem", "work_mem",
3255 "vacuum_mem", "maintenance_work_mem",
3261 * Actual lookup of variables is done through this single, sorted array.
3263 static struct config_generic **guc_variables;
3265 /* Current number of variables contained in the vector */
3266 static int num_guc_variables;
3268 /* Vector capacity */
3269 static int size_guc_variables;
3272 static bool guc_dirty; /* TRUE if need to do commit/abort work */
3274 static bool reporting_enabled; /* TRUE to enable GUC_REPORT */
3276 static int GUCNestLevel = 0; /* 1 when in main transaction */
3279 static int guc_var_compare(const void *a, const void *b);
3280 static int guc_name_compare(const char *namea, const char *nameb);
3281 static void InitializeGUCOptionsFromEnvironment(void);
3282 static void InitializeOneGUCOption(struct config_generic * gconf);
3283 static void push_old_value(struct config_generic * gconf, GucAction action);
3284 static void ReportGUCOption(struct config_generic * record);
3285 static void reapply_stacked_values(struct config_generic * variable,
3286 struct config_string *pHolder,
3288 const char *curvalue,
3289 GucContext curscontext, GucSource cursource);
3290 static void ShowGUCConfigOption(const char *name, DestReceiver *dest);
3291 static void ShowAllGUCConfig(DestReceiver *dest);
3292 static char *_ShowOption(struct config_generic * record, bool use_units);
3293 static bool validate_option_array_item(const char *name, const char *value,
3294 bool skipIfNoPermissions);
3298 * Some infrastructure for checking malloc/strdup/realloc calls
3301 guc_malloc(int elevel, size_t size)
3305 data = malloc(size);
3308 (errcode(ERRCODE_OUT_OF_MEMORY),
3309 errmsg("out of memory")));
3314 guc_realloc(int elevel, void *old, size_t size)
3318 data = realloc(old, size);
3321 (errcode(ERRCODE_OUT_OF_MEMORY),
3322 errmsg("out of memory")));
3327 guc_strdup(int elevel, const char *src)
3334 (errcode(ERRCODE_OUT_OF_MEMORY),
3335 errmsg("out of memory")));
3341 * Detect whether strval is referenced anywhere in a GUC string item
3344 string_field_used(struct config_string * conf, char *strval)
3348 if (strval == *(conf->variable) ||
3349 strval == conf->reset_val ||
3350 strval == conf->boot_val)
3352 for (stack = conf->gen.stack; stack; stack = stack->prev)
3354 if (strval == stack->prior.val.stringval ||
3355 strval == stack->masked.val.stringval)
3362 * Support for assigning to a field of a string GUC item. Free the prior
3363 * value if it's not referenced anywhere else in the item (including stacked
3367 set_string_field(struct config_string * conf, char **field, char *newval)
3369 char *oldval = *field;
3371 /* Do the assignment */
3374 /* Free old value if it's not NULL and isn't referenced anymore */
3375 if (oldval && !string_field_used(conf, oldval))
3380 * Detect whether an "extra" struct is referenced anywhere in a GUC item
3383 extra_field_used(struct config_generic * gconf, void *extra)
3387 if (extra == gconf->extra)
3389 switch (gconf->vartype)
3392 if (extra == ((struct config_bool *) gconf)->reset_extra)
3396 if (extra == ((struct config_int *) gconf)->reset_extra)
3400 if (extra == ((struct config_real *) gconf)->reset_extra)
3404 if (extra == ((struct config_string *) gconf)->reset_extra)
3408 if (extra == ((struct config_enum *) gconf)->reset_extra)
3412 for (stack = gconf->stack; stack; stack = stack->prev)
3414 if (extra == stack->prior.extra ||
3415 extra == stack->masked.extra)
3423 * Support for assigning to an "extra" field of a GUC item. Free the prior
3424 * value if it's not referenced anywhere else in the item (including stacked
3428 set_extra_field(struct config_generic * gconf, void **field, void *newval)
3430 void *oldval = *field;
3432 /* Do the assignment */
3435 /* Free old value if it's not NULL and isn't referenced anymore */
3436 if (oldval && !extra_field_used(gconf, oldval))
3441 * Support for copying a variable's active value into a stack entry.
3442 * The "extra" field associated with the active value is copied, too.
3444 * NB: be sure stringval and extra fields of a new stack entry are
3445 * initialized to NULL before this is used, else we'll try to free() them.
3448 set_stack_value(struct config_generic * gconf, config_var_value *val)
3450 switch (gconf->vartype)
3454 *((struct config_bool *) gconf)->variable;
3458 *((struct config_int *) gconf)->variable;
3462 *((struct config_real *) gconf)->variable;
3465 set_string_field((struct config_string *) gconf,
3466 &(val->val.stringval),
3467 *((struct config_string *) gconf)->variable);
3471 *((struct config_enum *) gconf)->variable;
3474 set_extra_field(gconf, &(val->extra), gconf->extra);
3478 * Support for discarding a no-longer-needed value in a stack entry.
3479 * The "extra" field associated with the stack entry is cleared, too.
3482 discard_stack_value(struct config_generic * gconf, config_var_value *val)
3484 switch (gconf->vartype)
3490 /* no need to do anything */
3493 set_string_field((struct config_string *) gconf,
3494 &(val->val.stringval),
3498 set_extra_field(gconf, &(val->extra), NULL);
3503 * Fetch the sorted array pointer (exported for help_config.c's use ONLY)
3505 struct config_generic **
3506 get_guc_variables(void)
3508 return guc_variables;
3513 * Build the sorted array. This is split out so that it could be
3514 * re-executed after startup (eg, we could allow loadable modules to
3515 * add vars, and then we'd need to re-sort).
3518 build_guc_variables(void)
3522 struct config_generic **guc_vars;
3525 for (i = 0; ConfigureNamesBool[i].gen.name; i++)
3527 struct config_bool *conf = &ConfigureNamesBool[i];
3529 /* Rather than requiring vartype to be filled in by hand, do this: */
3530 conf->gen.vartype = PGC_BOOL;
3534 for (i = 0; ConfigureNamesInt[i].gen.name; i++)
3536 struct config_int *conf = &ConfigureNamesInt[i];
3538 conf->gen.vartype = PGC_INT;
3542 for (i = 0; ConfigureNamesReal[i].gen.name; i++)
3544 struct config_real *conf = &ConfigureNamesReal[i];
3546 conf->gen.vartype = PGC_REAL;
3550 for (i = 0; ConfigureNamesString[i].gen.name; i++)
3552 struct config_string *conf = &ConfigureNamesString[i];
3554 conf->gen.vartype = PGC_STRING;
3558 for (i = 0; ConfigureNamesEnum[i].gen.name; i++)
3560 struct config_enum *conf = &ConfigureNamesEnum[i];
3562 conf->gen.vartype = PGC_ENUM;
3567 * Create table with 20% slack
3569 size_vars = num_vars + num_vars / 4;
3571 guc_vars = (struct config_generic **)
3572 guc_malloc(FATAL, size_vars * sizeof(struct config_generic *));
3576 for (i = 0; ConfigureNamesBool[i].gen.name; i++)
3577 guc_vars[num_vars++] = &ConfigureNamesBool[i].gen;
3579 for (i = 0; ConfigureNamesInt[i].gen.name; i++)
3580 guc_vars[num_vars++] = &ConfigureNamesInt[i].gen;
3582 for (i = 0; ConfigureNamesReal[i].gen.name; i++)
3583 guc_vars[num_vars++] = &ConfigureNamesReal[i].gen;
3585 for (i = 0; ConfigureNamesString[i].gen.name; i++)
3586 guc_vars[num_vars++] = &ConfigureNamesString[i].gen;
3588 for (i = 0; ConfigureNamesEnum[i].gen.name; i++)
3589 guc_vars[num_vars++] = &ConfigureNamesEnum[i].gen;
3592 free(guc_variables);
3593 guc_variables = guc_vars;
3594 num_guc_variables = num_vars;
3595 size_guc_variables = size_vars;
3596 qsort((void *) guc_variables, num_guc_variables,
3597 sizeof(struct config_generic *), guc_var_compare);
3601 * Add a new GUC variable to the list of known variables. The
3602 * list is expanded if needed.
3605 add_guc_variable(struct config_generic * var, int elevel)
3607 if (num_guc_variables + 1 >= size_guc_variables)
3610 * Increase the vector by 25%
3612 int size_vars = size_guc_variables + size_guc_variables / 4;
3613 struct config_generic **guc_vars;
3618 guc_vars = (struct config_generic **)
3619 guc_malloc(elevel, size_vars * sizeof(struct config_generic *));
3623 guc_vars = (struct config_generic **)
3624 guc_realloc(elevel, guc_variables, size_vars * sizeof(struct config_generic *));
3627 if (guc_vars == NULL)
3628 return false; /* out of memory */
3630 guc_variables = guc_vars;
3631 size_guc_variables = size_vars;
3633 guc_variables[num_guc_variables++] = var;
3634 qsort((void *) guc_variables, num_guc_variables,
3635 sizeof(struct config_generic *), guc_var_compare);
3640 * Create and add a placeholder variable for a custom variable name.
3642 static struct config_generic *
3643 add_placeholder_variable(const char *name, int elevel)
3645 size_t sz = sizeof(struct config_string) + sizeof(char *);
3646 struct config_string *var;
3647 struct config_generic *gen;
3649 var = (struct config_string *) guc_malloc(elevel, sz);
3655 gen->name = guc_strdup(elevel, name);
3656 if (gen->name == NULL)
3662 gen->context = PGC_USERSET;
3663 gen->group = CUSTOM_OPTIONS;
3664 gen->short_desc = "GUC placeholder variable";
3665 gen->flags = GUC_NO_SHOW_ALL | GUC_NOT_IN_SAMPLE | GUC_CUSTOM_PLACEHOLDER;
3666 gen->vartype = PGC_STRING;
3669 * The char* is allocated at the end of the struct since we have no
3670 * 'static' place to point to. Note that the current value, as well as
3671 * the boot and reset values, start out NULL.
3673 var->variable = (char **) (var + 1);
3675 if (!add_guc_variable((struct config_generic *) var, elevel))
3677 free((void *) gen->name);
3686 * Look up option NAME. If it exists, return a pointer to its record,
3687 * else return NULL. If create_placeholders is TRUE, we'll create a
3688 * placeholder record for a valid-looking custom variable name.
3690 static struct config_generic *
3691 find_option(const char *name, bool create_placeholders, int elevel)
3693 const char **key = &name;
3694 struct config_generic **res;
3700 * By equating const char ** with struct config_generic *, we are assuming
3701 * the name field is first in config_generic.
3703 res = (struct config_generic **) bsearch((void *) &key,
3704 (void *) guc_variables,
3706 sizeof(struct config_generic *),
3712 * See if the name is an obsolete name for a variable. We assume that the
3713 * set of supported old names is short enough that a brute-force search is
3716 for (i = 0; map_old_guc_names[i] != NULL; i += 2)
3718 if (guc_name_compare(name, map_old_guc_names[i]) == 0)
3719 return find_option(map_old_guc_names[i + 1], false, elevel);
3722 if (create_placeholders)
3725 * Check if the name is qualified, and if so, add a placeholder.
3727 if (strchr(name, GUC_QUALIFIER_SEPARATOR) != NULL)
3728 return add_placeholder_variable(name, elevel);
3737 * comparator for qsorting and bsearching guc_variables array
3740 guc_var_compare(const void *a, const void *b)
3742 struct config_generic *confa = *(struct config_generic **) a;
3743 struct config_generic *confb = *(struct config_generic **) b;
3745 return guc_name_compare(confa->name, confb->name);
3749 * the bare comparison function for GUC names
3752 guc_name_compare(const char *namea, const char *nameb)
3755 * The temptation to use strcasecmp() here must be resisted, because the
3756 * array ordering has to remain stable across setlocale() calls. So, build
3757 * our own with a simple ASCII-only downcasing.
3759 while (*namea && *nameb)
3761 char cha = *namea++;
3762 char chb = *nameb++;
3764 if (cha >= 'A' && cha <= 'Z')
3766 if (chb >= 'A' && chb <= 'Z')
3772 return 1; /* a is longer */
3774 return -1; /* b is longer */
3780 * Initialize GUC options during program startup.
3782 * Note that we cannot read the config file yet, since we have not yet
3783 * processed command-line switches.
3786 InitializeGUCOptions(void)
3791 * Before log_line_prefix could possibly receive a nonempty setting, make
3792 * sure that timezone processing is minimally alive (see elog.c).
3794 pg_timezone_initialize();
3797 * Build sorted array of all GUC variables.
3799 build_guc_variables();
3802 * Load all variables with their compiled-in defaults, and initialize
3803 * status fields as needed.
3805 for (i = 0; i < num_guc_variables; i++)
3807 InitializeOneGUCOption(guc_variables[i]);
3812 reporting_enabled = false;
3815 * Prevent any attempt to override the transaction modes from
3816 * non-interactive sources.
3818 SetConfigOption("transaction_isolation", "default",
3819 PGC_POSTMASTER, PGC_S_OVERRIDE);
3820 SetConfigOption("transaction_read_only", "no",
3821 PGC_POSTMASTER, PGC_S_OVERRIDE);
3822 SetConfigOption("transaction_deferrable", "no",
3823 PGC_POSTMASTER, PGC_S_OVERRIDE);
3826 * For historical reasons, some GUC parameters can receive defaults from
3827 * environment variables. Process those settings.
3829 InitializeGUCOptionsFromEnvironment();
3833 * Assign any GUC values that can come from the server's environment.
3835 * This is called from InitializeGUCOptions, and also from ProcessConfigFile
3836 * to deal with the possibility that a setting has been removed from
3837 * postgresql.conf and should now get a value from the environment.
3838 * (The latter is a kludge that should probably go away someday; if so,
3839 * fold this back into InitializeGUCOptions.)
3842 InitializeGUCOptionsFromEnvironment(void)
3847 env = getenv("PGPORT");
3849 SetConfigOption("port", env, PGC_POSTMASTER, PGC_S_ENV_VAR);
3851 env = getenv("PGDATESTYLE");
3853 SetConfigOption("datestyle", env, PGC_POSTMASTER, PGC_S_ENV_VAR);
3855 env = getenv("PGCLIENTENCODING");
3857 SetConfigOption("client_encoding", env, PGC_POSTMASTER, PGC_S_ENV_VAR);
3860 * rlimit isn't exactly an "environment variable", but it behaves about
3861 * the same. If we can identify the platform stack depth rlimit, increase
3862 * default stack depth setting up to whatever is safe (but at most 2MB).
3864 stack_rlimit = get_stack_depth_rlimit();
3865 if (stack_rlimit > 0)
3867 long new_limit = (stack_rlimit - STACK_DEPTH_SLOP) / 1024L;
3869 if (new_limit > 100)
3873 new_limit = Min(new_limit, 2048);
3874 sprintf(limbuf, "%ld", new_limit);
3875 SetConfigOption("max_stack_depth", limbuf,
3876 PGC_POSTMASTER, PGC_S_ENV_VAR);
3882 * Initialize one GUC option variable to its compiled-in default.
3884 * Note: the reason for calling check_hooks is not that we think the boot_val
3885 * might fail, but that the hooks might wish to compute an "extra" struct.
3888 InitializeOneGUCOption(struct config_generic * gconf)
3891 gconf->source = PGC_S_DEFAULT;
3892 gconf->reset_source = PGC_S_DEFAULT;
3893 gconf->scontext = PGC_INTERNAL;
3894 gconf->reset_scontext = PGC_INTERNAL;
3895 gconf->stack = NULL;
3896 gconf->extra = NULL;
3897 gconf->sourcefile = NULL;
3898 gconf->sourceline = 0;
3900 switch (gconf->vartype)
3904 struct config_bool *conf = (struct config_bool *) gconf;
3905 bool newval = conf->boot_val;
3908 if (!call_bool_check_hook(conf, &newval, &extra,
3909 PGC_S_DEFAULT, LOG))
3910 elog(FATAL, "failed to initialize %s to %d",
3911 conf->gen.name, (int) newval);
3912 if (conf->assign_hook)
3913 (*conf->assign_hook) (newval, extra);
3914 *conf->variable = conf->reset_val = newval;
3915 conf->gen.extra = conf->reset_extra = extra;
3920 struct config_int *conf = (struct config_int *) gconf;
3921 int newval = conf->boot_val;
3924 Assert(newval >= conf->min);
3925 Assert(newval <= conf->max);
3926 if (!call_int_check_hook(conf, &newval, &extra,
3927 PGC_S_DEFAULT, LOG))
3928 elog(FATAL, "failed to initialize %s to %d",
3929 conf->gen.name, newval);
3930 if (conf->assign_hook)
3931 (*conf->assign_hook) (newval, extra);
3932 *conf->variable = conf->reset_val = newval;
3933 conf->gen.extra = conf->reset_extra = extra;
3938 struct config_real *conf = (struct config_real *) gconf;
3939 double newval = conf->boot_val;
3942 Assert(newval >= conf->min);
3943 Assert(newval <= conf->max);
3944 if (!call_real_check_hook(conf, &newval, &extra,
3945 PGC_S_DEFAULT, LOG))
3946 elog(FATAL, "failed to initialize %s to %g",
3947 conf->gen.name, newval);
3948 if (conf->assign_hook)
3949 (*conf->assign_hook) (newval, extra);
3950 *conf->variable = conf->reset_val = newval;
3951 conf->gen.extra = conf->reset_extra = extra;
3956 struct config_string *conf = (struct config_string *) gconf;
3960 /* non-NULL boot_val must always get strdup'd */
3961 if (conf->boot_val != NULL)
3962 newval = guc_strdup(FATAL, conf->boot_val);
3966 if (!call_string_check_hook(conf, &newval, &extra,
3967 PGC_S_DEFAULT, LOG))
3968 elog(FATAL, "failed to initialize %s to \"%s\"",
3969 conf->gen.name, newval ? newval : "");
3970 if (conf->assign_hook)
3971 (*conf->assign_hook) (newval, extra);
3972 *conf->variable = conf->reset_val = newval;
3973 conf->gen.extra = conf->reset_extra = extra;
3978 struct config_enum *conf = (struct config_enum *) gconf;
3979 int newval = conf->boot_val;
3982 if (!call_enum_check_hook(conf, &newval, &extra,
3983 PGC_S_DEFAULT, LOG))
3984 elog(FATAL, "failed to initialize %s to %d",
3985 conf->gen.name, newval);
3986 if (conf->assign_hook)
3987 (*conf->assign_hook) (newval, extra);
3988 *conf->variable = conf->reset_val = newval;
3989 conf->gen.extra = conf->reset_extra = extra;
3997 * Select the configuration files and data directory to be used, and
3998 * do the initial read of postgresql.conf.
4000 * This is called after processing command-line switches.
4001 * userDoption is the -D switch value if any (NULL if unspecified).
4002 * progname is just for use in error messages.
4004 * Returns true on success; on failure, prints a suitable error message
4005 * to stderr and returns false.
4008 SelectConfigFiles(const char *userDoption, const char *progname)
4012 struct stat stat_buf;
4014 /* configdir is -D option, or $PGDATA if no -D */
4016 configdir = make_absolute_path(userDoption);
4018 configdir = make_absolute_path(getenv("PGDATA"));
4021 * Find the configuration file: if config_file was specified on the
4022 * command line, use it, else use configdir/postgresql.conf. In any case
4023 * ensure the result is an absolute path, so that it will be interpreted
4024 * the same way by future backends.
4027 fname = make_absolute_path(ConfigFileName);
4030 fname = guc_malloc(FATAL,
4031 strlen(configdir) + strlen(CONFIG_FILENAME) + 2);
4032 sprintf(fname, "%s/%s", configdir, CONFIG_FILENAME);
4036 write_stderr("%s does not know where to find the server configuration file.\n"
4037 "You must specify the --config-file or -D invocation "
4038 "option or set the PGDATA environment variable.\n",
4044 * Set the ConfigFileName GUC variable to its final value, ensuring that
4045 * it can't be overridden later.
4047 SetConfigOption("config_file", fname, PGC_POSTMASTER, PGC_S_OVERRIDE);
4051 * Now read the config file for the first time.
4053 if (stat(ConfigFileName, &stat_buf) != 0)
4055 write_stderr("%s cannot access the server configuration file \"%s\": %s\n",
4056 progname, ConfigFileName, strerror(errno));
4060 ProcessConfigFile(PGC_POSTMASTER);
4063 * If the data_directory GUC variable has been set, use that as DataDir;
4064 * otherwise use configdir if set; else punt.
4066 * Note: SetDataDir will copy and absolute-ize its argument, so we don't
4070 SetDataDir(data_directory);
4072 SetDataDir(configdir);
4075 write_stderr("%s does not know where to find the database system data.\n"
4076 "This can be specified as \"data_directory\" in \"%s\", "
4077 "or by the -D invocation option, or by the "
4078 "PGDATA environment variable.\n",
4079 progname, ConfigFileName);
4084 * Reflect the final DataDir value back into the data_directory GUC var.
4085 * (If you are wondering why we don't just make them a single variable,
4086 * it's because the EXEC_BACKEND case needs DataDir to be transmitted to
4087 * child backends specially. XXX is that still true? Given that we now
4088 * chdir to DataDir, EXEC_BACKEND can read the config file without knowing
4089 * DataDir in advance.)
4091 SetConfigOption("data_directory", DataDir, PGC_POSTMASTER, PGC_S_OVERRIDE);
4094 * If timezone_abbreviations wasn't set in the configuration file, install
4095 * the default value. We do it this way because we can't safely install
4096 * a "real" value until my_exec_path is set, which may not have happened
4097 * when InitializeGUCOptions runs, so the bootstrap default value cannot
4098 * be the real desired default.
4100 pg_timezone_abbrev_initialize();
4103 * Figure out where pg_hba.conf is, and make sure the path is absolute.
4106 fname = make_absolute_path(HbaFileName);
4109 fname = guc_malloc(FATAL,
4110 strlen(configdir) + strlen(HBA_FILENAME) + 2);
4111 sprintf(fname, "%s/%s", configdir, HBA_FILENAME);
4115 write_stderr("%s does not know where to find the \"hba\" configuration file.\n"
4116 "This can be specified as \"hba_file\" in \"%s\", "
4117 "or by the -D invocation option, or by the "
4118 "PGDATA environment variable.\n",
4119 progname, ConfigFileName);
4122 SetConfigOption("hba_file", fname, PGC_POSTMASTER, PGC_S_OVERRIDE);
4126 * Likewise for pg_ident.conf.
4129 fname = make_absolute_path(IdentFileName);
4132 fname = guc_malloc(FATAL,
4133 strlen(configdir) + strlen(IDENT_FILENAME) + 2);
4134 sprintf(fname, "%s/%s", configdir, IDENT_FILENAME);
4138 write_stderr("%s does not know where to find the \"ident\" configuration file.\n"
4139 "This can be specified as \"ident_file\" in \"%s\", "
4140 "or by the -D invocation option, or by the "
4141 "PGDATA environment variable.\n",
4142 progname, ConfigFileName);
4145 SetConfigOption("ident_file", fname, PGC_POSTMASTER, PGC_S_OVERRIDE);
4155 * Reset all options to their saved default values (implements RESET ALL)
4158 ResetAllOptions(void)
4162 for (i = 0; i < num_guc_variables; i++)
4164 struct config_generic *gconf = guc_variables[i];
4166 /* Don't reset non-SET-able values */
4167 if (gconf->context != PGC_SUSET &&
4168 gconf->context != PGC_USERSET)
4170 /* Don't reset if special exclusion from RESET ALL */
4171 if (gconf->flags & GUC_NO_RESET_ALL)
4173 /* No need to reset if wasn't SET */
4174 if (gconf->source <= PGC_S_OVERRIDE)
4177 /* Save old value to support transaction abort */
4178 push_old_value(gconf, GUC_ACTION_SET);
4180 switch (gconf->vartype)
4184 struct config_bool *conf = (struct config_bool *) gconf;
4186 if (conf->assign_hook)
4187 (*conf->assign_hook) (conf->reset_val,
4189 *conf->variable = conf->reset_val;
4190 set_extra_field(&conf->gen, &conf->gen.extra,
4196 struct config_int *conf = (struct config_int *) gconf;
4198 if (conf->assign_hook)
4199 (*conf->assign_hook) (conf->reset_val,
4201 *conf->variable = conf->reset_val;
4202 set_extra_field(&conf->gen, &conf->gen.extra,
4208 struct config_real *conf = (struct config_real *) gconf;
4210 if (conf->assign_hook)
4211 (*conf->assign_hook) (conf->reset_val,
4213 *conf->variable = conf->reset_val;
4214 set_extra_field(&conf->gen, &conf->gen.extra,
4220 struct config_string *conf = (struct config_string *) gconf;
4222 if (conf->assign_hook)
4223 (*conf->assign_hook) (conf->reset_val,
4225 set_string_field(conf, conf->variable, conf->reset_val);
4226 set_extra_field(&conf->gen, &conf->gen.extra,
4232 struct config_enum *conf = (struct config_enum *) gconf;
4234 if (conf->assign_hook)
4235 (*conf->assign_hook) (conf->reset_val,
4237 *conf->variable = conf->reset_val;
4238 set_extra_field(&conf->gen, &conf->gen.extra,
4244 gconf->source = gconf->reset_source;
4245 gconf->scontext = gconf->reset_scontext;
4247 if (gconf->flags & GUC_REPORT)
4248 ReportGUCOption(gconf);
4255 * Push previous state during transactional assignment to a GUC variable.
4258 push_old_value(struct config_generic * gconf, GucAction action)
4262 /* If we're not inside a nest level, do nothing */
4263 if (GUCNestLevel == 0)
4266 /* Do we already have a stack entry of the current nest level? */
4267 stack = gconf->stack;
4268 if (stack && stack->nest_level >= GUCNestLevel)
4270 /* Yes, so adjust its state if necessary */
4271 Assert(stack->nest_level == GUCNestLevel);
4274 case GUC_ACTION_SET:
4275 /* SET overrides any prior action at same nest level */
4276 if (stack->state == GUC_SET_LOCAL)
4278 /* must discard old masked value */
4279 discard_stack_value(gconf, &stack->masked);
4281 stack->state = GUC_SET;
4283 case GUC_ACTION_LOCAL:
4284 if (stack->state == GUC_SET)
4286 /* SET followed by SET LOCAL, remember SET's value */
4287 stack->masked_scontext = gconf->scontext;
4288 set_stack_value(gconf, &stack->masked);
4289 stack->state = GUC_SET_LOCAL;
4291 /* in all other cases, no change to stack entry */
4293 case GUC_ACTION_SAVE:
4294 /* Could only have a prior SAVE of same variable */
4295 Assert(stack->state == GUC_SAVE);
4298 Assert(guc_dirty); /* must be set already */
4303 * Push a new stack entry
4305 * We keep all the stack entries in TopTransactionContext for simplicity.
4307 stack = (GucStack *) MemoryContextAllocZero(TopTransactionContext,
4310 stack->prev = gconf->stack;
4311 stack->nest_level = GUCNestLevel;
4314 case GUC_ACTION_SET:
4315 stack->state = GUC_SET;
4317 case GUC_ACTION_LOCAL:
4318 stack->state = GUC_LOCAL;
4320 case GUC_ACTION_SAVE:
4321 stack->state = GUC_SAVE;
4324 stack->source = gconf->source;
4325 stack->scontext = gconf->scontext;
4326 set_stack_value(gconf, &stack->prior);
4328 gconf->stack = stack;
4330 /* Ensure we remember to pop at end of xact */
4336 * Do GUC processing at main transaction start.
4342 * The nest level should be 0 between transactions; if it isn't, somebody
4343 * didn't call AtEOXact_GUC, or called it with the wrong nestLevel. We
4344 * throw a warning but make no other effort to clean up.
4346 if (GUCNestLevel != 0)
4347 elog(WARNING, "GUC nest level = %d at transaction start",
4353 * Enter a new nesting level for GUC values. This is called at subtransaction
4354 * start, and when entering a function that has proconfig settings, and in
4355 * some other places where we want to set GUC variables transiently.
4356 * NOTE we must not risk error here, else subtransaction start will be unhappy.
4359 NewGUCNestLevel(void)
4361 return ++GUCNestLevel;
4365 * Do GUC processing at transaction or subtransaction commit or abort, or
4366 * when exiting a function that has proconfig settings, or when undoing a
4367 * transient assignment to some GUC variables. (The name is thus a bit of
4368 * a misnomer; perhaps it should be ExitGUCNestLevel or some such.)
4369 * During abort, we discard all GUC settings that were applied at nesting
4370 * levels >= nestLevel. nestLevel == 1 corresponds to the main transaction.
4373 AtEOXact_GUC(bool isCommit, int nestLevel)
4379 * Note: it's possible to get here with GUCNestLevel == nestLevel-1 during
4380 * abort, if there is a failure during transaction start before
4381 * AtStart_GUC is called.
4383 Assert(nestLevel > 0 &&
4384 (nestLevel <= GUCNestLevel ||
4385 (nestLevel == GUCNestLevel + 1 && !isCommit)));
4387 /* Quick exit if nothing's changed in this transaction */
4390 GUCNestLevel = nestLevel - 1;
4394 still_dirty = false;
4395 for (i = 0; i < num_guc_variables; i++)
4397 struct config_generic *gconf = guc_variables[i];
4401 * Process and pop each stack entry within the nest level. To simplify
4402 * fmgr_security_definer() and other places that use GUC_ACTION_SAVE,
4403 * we allow failure exit from code that uses a local nest level to be
4404 * recovered at the surrounding transaction or subtransaction abort;
4405 * so there could be more than one stack entry to pop.
4407 while ((stack = gconf->stack) != NULL &&
4408 stack->nest_level >= nestLevel)
4410 GucStack *prev = stack->prev;
4411 bool restorePrior = false;
4412 bool restoreMasked = false;
4416 * In this next bit, if we don't set either restorePrior or
4417 * restoreMasked, we must "discard" any unwanted fields of the
4418 * stack entries to avoid leaking memory. If we do set one of
4419 * those flags, unused fields will be cleaned up after restoring.
4421 if (!isCommit) /* if abort, always restore prior value */
4422 restorePrior = true;
4423 else if (stack->state == GUC_SAVE)
4424 restorePrior = true;
4425 else if (stack->nest_level == 1)
4427 /* transaction commit */
4428 if (stack->state == GUC_SET_LOCAL)
4429 restoreMasked = true;
4430 else if (stack->state == GUC_SET)
4432 /* we keep the current active value */
4433 discard_stack_value(gconf, &stack->prior);
4435 else /* must be GUC_LOCAL */
4436 restorePrior = true;
4438 else if (prev == NULL ||
4439 prev->nest_level < stack->nest_level - 1)
4441 /* decrement entry's level and do not pop it */
4442 stack->nest_level--;
4448 * We have to merge this stack entry into prev. See README for
4449 * discussion of this bit.
4451 switch (stack->state)
4454 Assert(false); /* can't get here */
4457 /* next level always becomes SET */
4458 discard_stack_value(gconf, &stack->prior);
4459 if (prev->state == GUC_SET_LOCAL)
4460 discard_stack_value(gconf, &prev->masked);
4461 prev->state = GUC_SET;
4465 if (prev->state == GUC_SET)
4467 /* LOCAL migrates down */
4468 prev->masked_scontext = stack->scontext;
4469 prev->masked = stack->prior;
4470 prev->state = GUC_SET_LOCAL;
4474 /* else just forget this stack level */
4475 discard_stack_value(gconf, &stack->prior);
4480 /* prior state at this level no longer wanted */
4481 discard_stack_value(gconf, &stack->prior);
4482 /* copy down the masked state */
4483 prev->masked_scontext = stack->masked_scontext;
4484 if (prev->state == GUC_SET_LOCAL)
4485 discard_stack_value(gconf, &prev->masked);
4486 prev->masked = stack->masked;
4487 prev->state = GUC_SET_LOCAL;
4494 if (restorePrior || restoreMasked)
4496 /* Perform appropriate restoration of the stacked value */
4497 config_var_value newvalue;
4498 GucSource newsource;
4499 GucContext newscontext;
4503 newvalue = stack->masked;
4504 newsource = PGC_S_SESSION;
4505 newscontext = stack->masked_scontext;
4509 newvalue = stack->prior;
4510 newsource = stack->source;
4511 newscontext = stack->scontext;
4514 switch (gconf->vartype)
4518 struct config_bool *conf = (struct config_bool *) gconf;
4519 bool newval = newvalue.val.boolval;
4520 void *newextra = newvalue.extra;
4522 if (*conf->variable != newval ||
4523 conf->gen.extra != newextra)
4525 if (conf->assign_hook)
4526 (*conf->assign_hook) (newval, newextra);
4527 *conf->variable = newval;
4528 set_extra_field(&conf->gen, &conf->gen.extra,
4536 struct config_int *conf = (struct config_int *) gconf;
4537 int newval = newvalue.val.intval;
4538 void *newextra = newvalue.extra;
4540 if (*conf->variable != newval ||
4541 conf->gen.extra != newextra)
4543 if (conf->assign_hook)
4544 (*conf->assign_hook) (newval, newextra);
4545 *conf->variable = newval;
4546 set_extra_field(&conf->gen, &conf->gen.extra,
4554 struct config_real *conf = (struct config_real *) gconf;
4555 double newval = newvalue.val.realval;
4556 void *newextra = newvalue.extra;
4558 if (*conf->variable != newval ||
4559 conf->gen.extra != newextra)
4561 if (conf->assign_hook)
4562 (*conf->assign_hook) (newval, newextra);
4563 *conf->variable = newval;
4564 set_extra_field(&conf->gen, &conf->gen.extra,
4572 struct config_string *conf = (struct config_string *) gconf;
4573 char *newval = newvalue.val.stringval;
4574 void *newextra = newvalue.extra;
4576 if (*conf->variable != newval ||
4577 conf->gen.extra != newextra)
4579 if (conf->assign_hook)
4580 (*conf->assign_hook) (newval, newextra);
4581 set_string_field(conf, conf->variable, newval);
4582 set_extra_field(&conf->gen, &conf->gen.extra,
4588 * Release stacked values if not used anymore. We
4589 * could use discard_stack_value() here, but since
4590 * we have type-specific code anyway, might as
4593 set_string_field(conf, &stack->prior.val.stringval, NULL);
4594 set_string_field(conf, &stack->masked.val.stringval, NULL);
4599 struct config_enum *conf = (struct config_enum *) gconf;
4600 int newval = newvalue.val.enumval;
4601 void *newextra = newvalue.extra;
4603 if (*conf->variable != newval ||
4604 conf->gen.extra != newextra)
4606 if (conf->assign_hook)
4607 (*conf->assign_hook) (newval, newextra);
4608 *conf->variable = newval;
4609 set_extra_field(&conf->gen, &conf->gen.extra,
4618 * Release stacked extra values if not used anymore.
4620 set_extra_field(gconf, &(stack->prior.extra), NULL);
4621 set_extra_field(gconf, &(stack->masked.extra), NULL);
4623 /* And restore source information */
4624 gconf->source = newsource;
4625 gconf->scontext = newscontext;
4628 /* Finish popping the state stack */
4629 gconf->stack = prev;
4632 /* Report new value if we changed it */
4633 if (changed && (gconf->flags & GUC_REPORT))
4634 ReportGUCOption(gconf);
4635 } /* end of stack-popping loop */
4641 /* If there are no remaining stack entries, we can reset guc_dirty */
4642 guc_dirty = still_dirty;
4644 /* Update nesting level */
4645 GUCNestLevel = nestLevel - 1;
4650 * Start up automatic reporting of changes to variables marked GUC_REPORT.
4651 * This is executed at completion of backend startup.
4654 BeginReportingGUCOptions(void)
4659 * Don't do anything unless talking to an interactive frontend of protocol
4662 if (whereToSendOutput != DestRemote ||
4663 PG_PROTOCOL_MAJOR(FrontendProtocol) < 3)
4666 reporting_enabled = true;
4668 /* Transmit initial values of interesting variables */
4669 for (i = 0; i < num_guc_variables; i++)
4671 struct config_generic *conf = guc_variables[i];
4673 if (conf->flags & GUC_REPORT)
4674 ReportGUCOption(conf);
4679 * ReportGUCOption: if appropriate, transmit option value to frontend
4682 ReportGUCOption(struct config_generic * record)
4684 if (reporting_enabled && (record->flags & GUC_REPORT))
4686 char *val = _ShowOption(record, false);
4687 StringInfoData msgbuf;
4689 pq_beginmessage(&msgbuf, 'S');
4690 pq_sendstring(&msgbuf, record->name);
4691 pq_sendstring(&msgbuf, val);
4692 pq_endmessage(&msgbuf);
4699 * Try to parse value as an integer. The accepted formats are the
4700 * usual decimal, octal, or hexadecimal formats, optionally followed by
4701 * a unit name if "flags" indicates a unit is allowed.
4703 * If the string parses okay, return true, else false.
4704 * If okay and result is not NULL, return the value in *result.
4705 * If not okay and hintmsg is not NULL, *hintmsg is set to a suitable
4706 * HINT message, or NULL if no hint provided.
4709 parse_int(const char *value, int *result, int flags, const char **hintmsg)
4714 /* To suppress compiler warnings, always set output params */
4720 /* We assume here that int64 is at least as wide as long */
4722 val = strtol(value, &endptr, 0);
4724 if (endptr == value)
4725 return false; /* no HINT for integer syntax error */
4727 if (errno == ERANGE || val != (int64) ((int32) val))
4730 *hintmsg = gettext_noop("Value exceeds integer range.");
4734 /* allow whitespace between integer and unit */
4735 while (isspace((unsigned char) *endptr))
4738 /* Handle possible unit */
4739 if (*endptr != '\0')
4742 * Note: the multiple-switch coding technique here is a bit tedious,
4743 * but seems necessary to avoid intermediate-value overflows.
4745 if (flags & GUC_UNIT_MEMORY)
4747 /* Set hint for use if no match or trailing garbage */
4749 *hintmsg = gettext_noop("Valid units for this parameter are \"kB\", \"MB\", and \"GB\".");
4751 #if BLCKSZ < 1024 || BLCKSZ > (1024*1024)
4752 #error BLCKSZ must be between 1KB and 1MB
4754 #if XLOG_BLCKSZ < 1024 || XLOG_BLCKSZ > (1024*1024)
4755 #error XLOG_BLCKSZ must be between 1KB and 1MB
4758 if (strncmp(endptr, "kB", 2) == 0)
4761 switch (flags & GUC_UNIT_MEMORY)
4763 case GUC_UNIT_BLOCKS:
4764 val /= (BLCKSZ / 1024);
4766 case GUC_UNIT_XBLOCKS:
4767 val /= (XLOG_BLCKSZ / 1024);
4771 else if (strncmp(endptr, "MB", 2) == 0)
4774 switch (flags & GUC_UNIT_MEMORY)
4779 case GUC_UNIT_BLOCKS:
4780 val *= KB_PER_MB / (BLCKSZ / 1024);
4782 case GUC_UNIT_XBLOCKS:
4783 val *= KB_PER_MB / (XLOG_BLCKSZ / 1024);
4787 else if (strncmp(endptr, "GB", 2) == 0)
4790 switch (flags & GUC_UNIT_MEMORY)
4795 case GUC_UNIT_BLOCKS:
4796 val *= KB_PER_GB / (BLCKSZ / 1024);
4798 case GUC_UNIT_XBLOCKS:
4799 val *= KB_PER_GB / (XLOG_BLCKSZ / 1024);
4804 else if (flags & GUC_UNIT_TIME)
4806 /* Set hint for use if no match or trailing garbage */
4808 *hintmsg = gettext_noop("Valid units for this parameter are \"ms\", \"s\", \"min\", \"h\", and \"d\".");
4810 if (strncmp(endptr, "ms", 2) == 0)
4813 switch (flags & GUC_UNIT_TIME)
4823 else if (strncmp(endptr, "s", 1) == 0)
4826 switch (flags & GUC_UNIT_TIME)
4836 else if (strncmp(endptr, "min", 3) == 0)
4839 switch (flags & GUC_UNIT_TIME)
4849 else if (strncmp(endptr, "h", 1) == 0)
4852 switch (flags & GUC_UNIT_TIME)
4865 else if (strncmp(endptr, "d", 1) == 0)
4868 switch (flags & GUC_UNIT_TIME)
4883 /* allow whitespace after unit */
4884 while (isspace((unsigned char) *endptr))
4887 if (*endptr != '\0')
4888 return false; /* appropriate hint, if any, already set */
4890 /* Check for overflow due to units conversion */
4891 if (val != (int64) ((int32) val))
4894 *hintmsg = gettext_noop("Value exceeds integer range.");
4900 *result = (int) val;
4907 * Try to parse value as a floating point number in the usual format.
4908 * If the string parses okay, return true, else false.
4909 * If okay and result is not NULL, return the value in *result.
4912 parse_real(const char *value, double *result)
4918 *result = 0; /* suppress compiler warning */
4921 val = strtod(value, &endptr);
4922 if (endptr == value || errno == ERANGE)
4925 /* allow whitespace after number */
4926 while (isspace((unsigned char) *endptr))
4928 if (*endptr != '\0')
4938 * Lookup the name for an enum option with the selected value.
4939 * Should only ever be called with known-valid values, so throws
4940 * an elog(ERROR) if the enum option is not found.
4942 * The returned string is a pointer to static data and not
4943 * allocated for modification.
4946 config_enum_lookup_by_value(struct config_enum * record, int val)
4948 const struct config_enum_entry *entry;
4950 for (entry = record->options; entry && entry->name; entry++)
4952 if (entry->val == val)
4956 elog(ERROR, "could not find enum option %d for %s",
4957 val, record->gen.name);
4958 return NULL; /* silence compiler */
4963 * Lookup the value for an enum option with the selected name
4964 * (case-insensitive).
4965 * If the enum option is found, sets the retval value and returns
4966 * true. If it's not found, return FALSE and retval is set to 0.
4969 config_enum_lookup_by_name(struct config_enum * record, const char *value,
4972 const struct config_enum_entry *entry;
4974 for (entry = record->options; entry && entry->name; entry++)
4976 if (pg_strcasecmp(value, entry->name) == 0)
4978 *retval = entry->val;
4989 * Return a list of all available options for an enum, excluding
4990 * hidden ones, separated by the given separator.
4991 * If prefix is non-NULL, it is added before the first enum value.
4992 * If suffix is non-NULL, it is added to the end of the string.
4995 config_enum_get_options(struct config_enum * record, const char *prefix,
4996 const char *suffix, const char *separator)
4998 const struct config_enum_entry *entry;
4999 StringInfoData retstr;
5002 initStringInfo(&retstr);
5003 appendStringInfoString(&retstr, prefix);
5005 seplen = strlen(separator);
5006 for (entry = record->options; entry && entry->name; entry++)
5010 appendStringInfoString(&retstr, entry->name);
5011 appendBinaryStringInfo(&retstr, separator, seplen);
5016 * All the entries may have been hidden, leaving the string empty if no
5017 * prefix was given. This indicates a broken GUC setup, since there is no
5018 * use for an enum without any values, so we just check to make sure we
5019 * don't write to invalid memory instead of actually trying to do
5020 * something smart with it.
5022 if (retstr.len >= seplen)
5024 /* Replace final separator */
5025 retstr.data[retstr.len - seplen] = '\0';
5026 retstr.len -= seplen;
5029 appendStringInfoString(&retstr, suffix);
5036 * Sets option `name' to given value.
5038 * The value should be a string, which will be parsed and converted to
5039 * the appropriate data type. The context and source parameters indicate
5040 * in which context this function is being called, so that it can apply the
5041 * access restrictions properly.
5043 * If value is NULL, set the option to its default value (normally the
5044 * reset_val, but if source == PGC_S_DEFAULT we instead use the boot_val).
5046 * action indicates whether to set the value globally in the session, locally
5047 * to the current top transaction, or just for the duration of a function call.
5049 * If changeVal is false then don't really set the option but do all
5050 * the checks to see if it would work.
5052 * elevel should normally be passed as zero, allowing this function to make
5053 * its standard choice of ereport level. However some callers need to be
5054 * able to override that choice; they should pass the ereport level to use.
5057 * +1: the value is valid and was successfully applied.
5058 * 0: the name or value is invalid (but see below).
5059 * -1: the value was not applied because of context, priority, or changeVal.
5061 * If there is an error (non-existing option, invalid value) then an
5062 * ereport(ERROR) is thrown *unless* this is called for a source for which
5063 * we don't want an ERROR (currently, those are defaults, the config file,
5064 * and per-database or per-user settings, as well as callers who specify
5065 * a less-than-ERROR elevel). In those cases we write a suitable error
5066 * message via ereport() and return 0.
5068 * See also SetConfigOption for an external interface.
5071 set_config_option(const char *name, const char *value,
5072 GucContext context, GucSource source,
5073 GucAction action, bool changeVal, int elevel)
5075 struct config_generic *record;
5076 bool prohibitValueChange = false;
5081 if (source == PGC_S_DEFAULT || source == PGC_S_FILE)
5084 * To avoid cluttering the log, only the postmaster bleats loudly
5085 * about problems with the config file.
5087 elevel = IsUnderPostmaster ? DEBUG3 : LOG;
5089 else if (source == PGC_S_DATABASE || source == PGC_S_USER ||
5090 source == PGC_S_DATABASE_USER)
5096 record = find_option(name, true, elevel);
5100 (errcode(ERRCODE_UNDEFINED_OBJECT),
5101 errmsg("unrecognized configuration parameter \"%s\"", name)));
5106 * Check if the option can be set at this time. See guc.h for the precise
5109 switch (record->context)
5112 if (context != PGC_INTERNAL)
5115 (errcode(ERRCODE_CANT_CHANGE_RUNTIME_PARAM),
5116 errmsg("parameter \"%s\" cannot be changed",
5121 case PGC_POSTMASTER:
5122 if (context == PGC_SIGHUP)
5125 * We are re-reading a PGC_POSTMASTER variable from
5126 * postgresql.conf. We can't change the setting, so we should
5127 * give a warning if the DBA tries to change it. However,
5128 * because of variant formats, canonicalization by check
5129 * hooks, etc, we can't just compare the given string directly
5130 * to what's stored. Set a flag to check below after we have
5131 * the final storable value.
5133 prohibitValueChange = true;
5135 else if (context != PGC_POSTMASTER)
5138 (errcode(ERRCODE_CANT_CHANGE_RUNTIME_PARAM),
5139 errmsg("parameter \"%s\" cannot be changed without restarting the server",
5145 if (context != PGC_SIGHUP && context != PGC_POSTMASTER)
5148 (errcode(ERRCODE_CANT_CHANGE_RUNTIME_PARAM),
5149 errmsg("parameter \"%s\" cannot be changed now",
5155 * Hmm, the idea of the SIGHUP context is "ought to be global, but
5156 * can be changed after postmaster start". But there's nothing
5157 * that prevents a crafty administrator from sending SIGHUP
5158 * signals to individual backends only.
5162 if (context == PGC_SIGHUP)
5165 * If a PGC_BACKEND parameter is changed in the config file,
5166 * we want to accept the new value in the postmaster (whence
5167 * it will propagate to subsequently-started backends), but
5168 * ignore it in existing backends. This is a tad klugy, but
5169 * necessary because we don't re-read the config file during
5172 if (IsUnderPostmaster)
5175 else if (context != PGC_POSTMASTER && context != PGC_BACKEND &&
5176 source != PGC_S_CLIENT)
5179 (errcode(ERRCODE_CANT_CHANGE_RUNTIME_PARAM),
5180 errmsg("parameter \"%s\" cannot be set after connection start",
5186 if (context == PGC_USERSET || context == PGC_BACKEND)
5189 (errcode(ERRCODE_INSUFFICIENT_PRIVILEGE),
5190 errmsg("permission denied to set parameter \"%s\"",
5201 * Disallow changing GUC_NOT_WHILE_SEC_REST values if we are inside a
5202 * security restriction context. We can reject this regardless of the GUC
5203 * context or source, mainly because sources that it might be reasonable
5204 * to override for won't be seen while inside a function.
5206 * Note: variables marked GUC_NOT_WHILE_SEC_REST should usually be marked
5207 * GUC_NO_RESET_ALL as well, because ResetAllOptions() doesn't check this.
5208 * An exception might be made if the reset value is assumed to be "safe".
5210 * Note: this flag is currently used for "session_authorization" and
5211 * "role". We need to prohibit changing these inside a local userid
5212 * context because when we exit it, GUC won't be notified, leaving things
5213 * out of sync. (This could be fixed by forcing a new GUC nesting level,
5214 * but that would change behavior in possibly-undesirable ways.) Also, we
5215 * prohibit changing these in a security-restricted operation because
5216 * otherwise RESET could be used to regain the session user's privileges.
5218 if (record->flags & GUC_NOT_WHILE_SEC_REST)
5220 if (InLocalUserIdChange())
5223 * Phrasing of this error message is historical, but it's the most
5227 (errcode(ERRCODE_INSUFFICIENT_PRIVILEGE),
5228 errmsg("cannot set parameter \"%s\" within security-definer function",
5232 if (InSecurityRestrictedOperation())
5235 (errcode(ERRCODE_INSUFFICIENT_PRIVILEGE),
5236 errmsg("cannot set parameter \"%s\" within security-restricted operation",
5243 * Should we set reset/stacked values? (If so, the behavior is not
5244 * transactional.) This is done either when we get a default value from
5245 * the database's/user's/client's default settings or when we reset a
5246 * value to its default.
5248 makeDefault = changeVal && (source <= PGC_S_OVERRIDE) &&
5249 ((value != NULL) || source == PGC_S_DEFAULT);
5252 * Ignore attempted set if overridden by previously processed setting.
5253 * However, if changeVal is false then plow ahead anyway since we are
5254 * trying to find out if the value is potentially good, not actually use
5255 * it. Also keep going if makeDefault is true, since we may want to set
5256 * the reset/stacked values even if we can't set the variable itself.
5258 if (record->source > source)
5260 if (changeVal && !makeDefault)
5262 elog(DEBUG3, "\"%s\": setting ignored because previous source is higher priority",
5270 * Evaluate value and set variable.
5272 switch (record->vartype)
5276 struct config_bool *conf = (struct config_bool *) record;
5278 void *newextra = NULL;
5282 if (!parse_bool(value, &newval))
5285 (errcode(ERRCODE_INVALID_PARAMETER_VALUE),
5286 errmsg("parameter \"%s\" requires a Boolean value",
5290 if (!call_bool_check_hook(conf, &newval, &newextra,
5294 else if (source == PGC_S_DEFAULT)
5296 newval = conf->boot_val;
5297 if (!call_bool_check_hook(conf, &newval, &newextra,
5303 newval = conf->reset_val;
5304 newextra = conf->reset_extra;
5305 source = conf->gen.reset_source;
5306 context = conf->gen.reset_scontext;
5309 if (prohibitValueChange)
5311 if (*conf->variable != newval)
5314 (errcode(ERRCODE_CANT_CHANGE_RUNTIME_PARAM),
5315 errmsg("parameter \"%s\" cannot be changed without restarting the server",
5324 /* Save old value to support transaction abort */
5326 push_old_value(&conf->gen, action);
5328 if (conf->assign_hook)
5329 (*conf->assign_hook) (newval, newextra);
5330 *conf->variable = newval;
5331 set_extra_field(&conf->gen, &conf->gen.extra,
5333 conf->gen.source = source;
5334 conf->gen.scontext = context;
5340 if (conf->gen.reset_source <= source)
5342 conf->reset_val = newval;
5343 set_extra_field(&conf->gen, &conf->reset_extra,
5345 conf->gen.reset_source = source;
5346 conf->gen.reset_scontext = context;
5348 for (stack = conf->gen.stack; stack; stack = stack->prev)
5350 if (stack->source <= source)
5352 stack->prior.val.boolval = newval;
5353 set_extra_field(&conf->gen, &stack->prior.extra,
5355 stack->source = source;
5356 stack->scontext = context;
5361 /* Perhaps we didn't install newextra anywhere */
5362 if (newextra && !extra_field_used(&conf->gen, newextra))
5369 struct config_int *conf = (struct config_int *) record;
5371 void *newextra = NULL;
5375 const char *hintmsg;
5377 if (!parse_int(value, &newval, conf->gen.flags, &hintmsg))
5380 (errcode(ERRCODE_INVALID_PARAMETER_VALUE),
5381 errmsg("invalid value for parameter \"%s\": \"%s\"",
5383 hintmsg ? errhint("%s", _(hintmsg)) : 0));
5386 if (newval < conf->min || newval > conf->max)
5389 (errcode(ERRCODE_INVALID_PARAMETER_VALUE),
5390 errmsg("%d is outside the valid range for parameter \"%s\" (%d .. %d)",
5391 newval, name, conf->min, conf->max)));
5394 if (!call_int_check_hook(conf, &newval, &newextra,
5398 else if (source == PGC_S_DEFAULT)
5400 newval = conf->boot_val;
5401 if (!call_int_check_hook(conf, &newval, &newextra,
5407 newval = conf->reset_val;
5408 newextra = conf->reset_extra;
5409 source = conf->gen.reset_source;
5410 context = conf->gen.reset_scontext;
5413 if (prohibitValueChange)
5415 if (*conf->variable != newval)
5418 (errcode(ERRCODE_CANT_CHANGE_RUNTIME_PARAM),
5419 errmsg("parameter \"%s\" cannot be changed without restarting the server",
5428 /* Save old value to support transaction abort */
5430 push_old_value(&conf->gen, action);
5432 if (conf->assign_hook)
5433 (*conf->assign_hook) (newval, newextra);
5434 *conf->variable = newval;
5435 set_extra_field(&conf->gen, &conf->gen.extra,
5437 conf->gen.source = source;
5438 conf->gen.scontext = context;
5444 if (conf->gen.reset_source <= source)
5446 conf->reset_val = newval;
5447 set_extra_field(&conf->gen, &conf->reset_extra,
5449 conf->gen.reset_source = source;
5450 conf->gen.reset_scontext = context;
5452 for (stack = conf->gen.stack; stack; stack = stack->prev)
5454 if (stack->source <= source)
5456 stack->prior.val.intval = newval;
5457 set_extra_field(&conf->gen, &stack->prior.extra,
5459 stack->source = source;
5460 stack->scontext = context;
5465 /* Perhaps we didn't install newextra anywhere */
5466 if (newextra && !extra_field_used(&conf->gen, newextra))
5473 struct config_real *conf = (struct config_real *) record;
5475 void *newextra = NULL;
5479 if (!parse_real(value, &newval))
5482 (errcode(ERRCODE_INVALID_PARAMETER_VALUE),
5483 errmsg("parameter \"%s\" requires a numeric value",
5487 if (newval < conf->min || newval > conf->max)
5490 (errcode(ERRCODE_INVALID_PARAMETER_VALUE),
5491 errmsg("%g is outside the valid range for parameter \"%s\" (%g .. %g)",
5492 newval, name, conf->min, conf->max)));
5495 if (!call_real_check_hook(conf, &newval, &newextra,
5499 else if (source == PGC_S_DEFAULT)
5501 newval = conf->boot_val;
5502 if (!call_real_check_hook(conf, &newval, &newextra,
5508 newval = conf->reset_val;
5509 newextra = conf->reset_extra;
5510 source = conf->gen.reset_source;
5511 context = conf->gen.reset_scontext;
5514 if (prohibitValueChange)
5516 if (*conf->variable != newval)
5519 (errcode(ERRCODE_CANT_CHANGE_RUNTIME_PARAM),
5520 errmsg("parameter \"%s\" cannot be changed without restarting the server",
5529 /* Save old value to support transaction abort */
5531 push_old_value(&conf->gen, action);
5533 if (conf->assign_hook)
5534 (*conf->assign_hook) (newval, newextra);
5535 *conf->variable = newval;
5536 set_extra_field(&conf->gen, &conf->gen.extra,
5538 conf->gen.source = source;
5539 conf->gen.scontext = context;
5545 if (conf->gen.reset_source <= source)
5547 conf->reset_val = newval;
5548 set_extra_field(&conf->gen, &conf->reset_extra,
5550 conf->gen.reset_source = source;
5551 conf->gen.reset_scontext = context;
5553 for (stack = conf->gen.stack; stack; stack = stack->prev)
5555 if (stack->source <= source)
5557 stack->prior.val.realval = newval;
5558 set_extra_field(&conf->gen, &stack->prior.extra,
5560 stack->source = source;
5561 stack->scontext = context;
5566 /* Perhaps we didn't install newextra anywhere */
5567 if (newextra && !extra_field_used(&conf->gen, newextra))
5574 struct config_string *conf = (struct config_string *) record;
5576 void *newextra = NULL;
5581 * The value passed by the caller could be transient, so
5582 * we always strdup it.
5584 newval = guc_strdup(elevel, value);
5589 * The only built-in "parsing" check we have is to apply
5590 * truncation if GUC_IS_NAME.
5592 if (conf->gen.flags & GUC_IS_NAME)
5593 truncate_identifier(newval, strlen(newval), true);
5595 if (!call_string_check_hook(conf, &newval, &newextra,
5602 else if (source == PGC_S_DEFAULT)
5604 /* non-NULL boot_val must always get strdup'd */
5605 if (conf->boot_val != NULL)
5607 newval = guc_strdup(elevel, conf->boot_val);
5614 if (!call_string_check_hook(conf, &newval, &newextra,
5624 * strdup not needed, since reset_val is already under
5627 newval = conf->reset_val;
5628 newextra = conf->reset_extra;
5629 source = conf->gen.reset_source;
5630 context = conf->gen.reset_scontext;
5633 if (prohibitValueChange)
5635 /* newval shouldn't be NULL, so we're a bit sloppy here */
5636 if (*conf->variable == NULL || newval == NULL ||
5637 strcmp(*conf->variable, newval) != 0)
5640 (errcode(ERRCODE_CANT_CHANGE_RUNTIME_PARAM),
5641 errmsg("parameter \"%s\" cannot be changed without restarting the server",
5650 /* Save old value to support transaction abort */
5652 push_old_value(&conf->gen, action);
5654 if (conf->assign_hook)
5655 (*conf->assign_hook) (newval, newextra);
5656 set_string_field(conf, conf->variable, newval);
5657 set_extra_field(&conf->gen, &conf->gen.extra,
5659 conf->gen.source = source;
5660 conf->gen.scontext = context;
5667 if (conf->gen.reset_source <= source)
5669 set_string_field(conf, &conf->reset_val, newval);
5670 set_extra_field(&conf->gen, &conf->reset_extra,
5672 conf->gen.reset_source = source;
5673 conf->gen.reset_scontext = context;
5675 for (stack = conf->gen.stack; stack; stack = stack->prev)
5677 if (stack->source <= source)
5679 set_string_field(conf, &stack->prior.val.stringval,
5681 set_extra_field(&conf->gen, &stack->prior.extra,
5683 stack->source = source;
5684 stack->scontext = context;
5689 /* Perhaps we didn't install newval anywhere */
5690 if (newval && !string_field_used(conf, newval))
5692 /* Perhaps we didn't install newextra anywhere */
5693 if (newextra && !extra_field_used(&conf->gen, newextra))
5700 struct config_enum *conf = (struct config_enum *) record;
5702 void *newextra = NULL;
5706 if (!config_enum_lookup_by_name(conf, value, &newval))
5710 hintmsg = config_enum_get_options(conf,
5711 "Available values: ",
5715 (errcode(ERRCODE_INVALID_PARAMETER_VALUE),
5716 errmsg("invalid value for parameter \"%s\": \"%s\"",
5718 hintmsg ? errhint("%s", _(hintmsg)) : 0));
5724 if (!call_enum_check_hook(conf, &newval, &newextra,
5728 else if (source == PGC_S_DEFAULT)
5730 newval = conf->boot_val;
5731 if (!call_enum_check_hook(conf, &newval, &newextra,
5737 newval = conf->reset_val;
5738 newextra = conf->reset_extra;
5739 source = conf->gen.reset_source;
5740 context = conf->gen.reset_scontext;
5743 if (prohibitValueChange)
5745 if (*conf->variable != newval)
5748 (errcode(ERRCODE_CANT_CHANGE_RUNTIME_PARAM),
5749 errmsg("parameter \"%s\" cannot be changed without restarting the server",
5758 /* Save old value to support transaction abort */
5760 push_old_value(&conf->gen, action);
5762 if (conf->assign_hook)
5763 (*conf->assign_hook) (newval, newextra);
5764 *conf->variable = newval;
5765 set_extra_field(&conf->gen, &conf->gen.extra,
5767 conf->gen.source = source;
5768 conf->gen.scontext = context;
5774 if (conf->gen.reset_source <= source)
5776 conf->reset_val = newval;
5777 set_extra_field(&conf->gen, &conf->reset_extra,
5779 conf->gen.reset_source = source;
5780 conf->gen.reset_scontext = context;
5782 for (stack = conf->gen.stack; stack; stack = stack->prev)
5784 if (stack->source <= source)
5786 stack->prior.val.enumval = newval;
5787 set_extra_field(&conf->gen, &stack->prior.extra,
5789 stack->source = source;
5790 stack->scontext = context;
5795 /* Perhaps we didn't install newextra anywhere */
5796 if (newextra && !extra_field_used(&conf->gen, newextra))
5802 if (changeVal && (record->flags & GUC_REPORT))
5803 ReportGUCOption(record);
5805 return changeVal ? 1 : -1;
5810 * Set the fields for source file and line number the setting came from.
5813 set_config_sourcefile(const char *name, char *sourcefile, int sourceline)
5815 struct config_generic *record;
5819 * To avoid cluttering the log, only the postmaster bleats loudly about
5820 * problems with the config file.
5822 elevel = IsUnderPostmaster ? DEBUG3 : LOG;
5824 record = find_option(name, true, elevel);
5825 /* should not happen */
5827 elog(ERROR, "unrecognized configuration parameter \"%s\"", name);
5829 sourcefile = guc_strdup(elevel, sourcefile);
5830 if (record->sourcefile)
5831 free(record->sourcefile);
5832 record->sourcefile = sourcefile;
5833 record->sourceline = sourceline;
5837 * Set a config option to the given value.
5839 * See also set_config_option; this is just the wrapper to be called from
5840 * outside GUC. (This function should be used when possible, because its API
5841 * is more stable than set_config_option's.)
5843 * Note: there is no support here for setting source file/line, as it
5844 * is currently not needed.
5847 SetConfigOption(const char *name, const char *value,
5848 GucContext context, GucSource source)
5850 (void) set_config_option(name, value, context, source,
5851 GUC_ACTION_SET, true, 0);
5857 * Fetch the current value of the option `name', as a string.
5859 * If the option doesn't exist, return NULL if missing_ok is true (NOTE that
5860 * this cannot be distinguished from a string variable with a NULL value!),
5861 * otherwise throw an ereport and don't return.
5863 * If restrict_superuser is true, we also enforce that only superusers can
5864 * see GUC_SUPERUSER_ONLY variables. This should only be passed as true
5865 * in user-driven calls.
5867 * The string is *not* allocated for modification and is really only
5868 * valid until the next call to configuration related functions.
5871 GetConfigOption(const char *name, bool missing_ok, bool restrict_superuser)
5873 struct config_generic *record;
5874 static char buffer[256];
5876 record = find_option(name, false, ERROR);
5882 (errcode(ERRCODE_UNDEFINED_OBJECT),
5883 errmsg("unrecognized configuration parameter \"%s\"",
5886 if (restrict_superuser &&
5887 (record->flags & GUC_SUPERUSER_ONLY) &&
5890 (errcode(ERRCODE_INSUFFICIENT_PRIVILEGE),
5891 errmsg("must be superuser to examine \"%s\"", name)));
5893 switch (record->vartype)
5896 return *((struct config_bool *) record)->variable ? "on" : "off";
5899 snprintf(buffer, sizeof(buffer), "%d",
5900 *((struct config_int *) record)->variable);
5904 snprintf(buffer, sizeof(buffer), "%g",
5905 *((struct config_real *) record)->variable);
5909 return *((struct config_string *) record)->variable;
5912 return config_enum_lookup_by_value((struct config_enum *) record,
5913 *((struct config_enum *) record)->variable);
5919 * Get the RESET value associated with the given option.
5921 * Note: this is not re-entrant, due to use of static result buffer;
5922 * not to mention that a string variable could have its reset_val changed.
5923 * Beware of assuming the result value is good for very long.
5926 GetConfigOptionResetString(const char *name)
5928 struct config_generic *record;
5929 static char buffer[256];
5931 record = find_option(name, false, ERROR);
5934 (errcode(ERRCODE_UNDEFINED_OBJECT),
5935 errmsg("unrecognized configuration parameter \"%s\"", name)));
5936 if ((record->flags & GUC_SUPERUSER_ONLY) && !superuser())
5938 (errcode(ERRCODE_INSUFFICIENT_PRIVILEGE),
5939 errmsg("must be superuser to examine \"%s\"", name)));
5941 switch (record->vartype)
5944 return ((struct config_bool *) record)->reset_val ? "on" : "off";
5947 snprintf(buffer, sizeof(buffer), "%d",
5948 ((struct config_int *) record)->reset_val);
5952 snprintf(buffer, sizeof(buffer), "%g",
5953 ((struct config_real *) record)->reset_val);
5957 return ((struct config_string *) record)->reset_val;
5960 return config_enum_lookup_by_value((struct config_enum *) record,
5961 ((struct config_enum *) record)->reset_val);
5968 * flatten_set_variable_args
5969 * Given a parsenode List as emitted by the grammar for SET,
5970 * convert to the flat string representation used by GUC.
5972 * We need to be told the name of the variable the args are for, because
5973 * the flattening rules vary (ugh).
5975 * The result is NULL if args is NIL (ie, SET ... TO DEFAULT), otherwise
5976 * a palloc'd string.
5979 flatten_set_variable_args(const char *name, List *args)
5981 struct config_generic *record;
5986 /* Fast path if just DEFAULT */
5991 * Get flags for the variable; if it's not known, use default flags.
5992 * (Caller might throw error later, but not our business to do so here.)
5994 record = find_option(name, false, WARNING);
5996 flags = record->flags;
6000 /* Complain if list input and non-list variable */
6001 if ((flags & GUC_LIST_INPUT) == 0 &&
6002 list_length(args) != 1)
6004 (errcode(ERRCODE_INVALID_PARAMETER_VALUE),
6005 errmsg("SET %s takes only one argument", name)));
6007 initStringInfo(&buf);
6010 * Each list member may be a plain A_Const node, or an A_Const within a
6011 * TypeCast; the latter case is supported only for ConstInterval arguments
6012 * (for SET TIME ZONE).
6016 Node *arg = (Node *) lfirst(l);
6018 TypeName *typeName = NULL;
6021 if (l != list_head(args))
6022 appendStringInfo(&buf, ", ");
6024 if (IsA(arg, TypeCast))
6026 TypeCast *tc = (TypeCast *) arg;
6029 typeName = tc->typeName;
6032 if (!IsA(arg, A_Const))
6033 elog(ERROR, "unrecognized node type: %d", (int) nodeTag(arg));
6034 con = (A_Const *) arg;
6036 switch (nodeTag(&con->val))
6039 appendStringInfo(&buf, "%ld", intVal(&con->val));
6042 /* represented as a string, so just copy it */
6043 appendStringInfoString(&buf, strVal(&con->val));
6046 val = strVal(&con->val);
6047 if (typeName != NULL)
6050 * Must be a ConstInterval argument for TIME ZONE. Coerce
6051 * to interval and back to normalize the value and account
6059 typenameTypeIdAndMod(NULL, typeName, &typoid, &typmod);
6060 Assert(typoid == INTERVALOID);
6063 DirectFunctionCall3(interval_in,
6064 CStringGetDatum(val),
6065 ObjectIdGetDatum(InvalidOid),
6066 Int32GetDatum(typmod));
6069 DatumGetCString(DirectFunctionCall1(interval_out,
6071 appendStringInfo(&buf, "INTERVAL '%s'", intervalout);
6076 * Plain string literal or identifier. For quote mode,
6077 * quote it if it's not a vanilla identifier.
6079 if (flags & GUC_LIST_QUOTE)
6080 appendStringInfoString(&buf, quote_identifier(val));
6082 appendStringInfoString(&buf, val);
6086 elog(ERROR, "unrecognized node type: %d",
6087 (int) nodeTag(&con->val));
6100 ExecSetVariableStmt(VariableSetStmt *stmt)
6102 GucAction action = stmt->is_local ? GUC_ACTION_LOCAL : GUC_ACTION_SET;
6107 case VAR_SET_CURRENT:
6108 (void) set_config_option(stmt->name,
6109 ExtractSetVariableArgs(stmt),
6110 (superuser() ? PGC_SUSET : PGC_USERSET),
6119 * Special-case SQL syntaxes. The TRANSACTION and SESSION
6120 * CHARACTERISTICS cases effectively set more than one variable
6121 * per statement. TRANSACTION SNAPSHOT only takes one argument,
6122 * but we put it here anyway since it's a special case and not
6123 * related to any GUC variable.
6125 if (strcmp(stmt->name, "TRANSACTION") == 0)
6129 foreach(head, stmt->args)
6131 DefElem *item = (DefElem *) lfirst(head);
6133 if (strcmp(item->defname, "transaction_isolation") == 0)
6134 SetPGVariable("transaction_isolation",
6135 list_make1(item->arg), stmt->is_local);
6136 else if (strcmp(item->defname, "transaction_read_only") == 0)
6137 SetPGVariable("transaction_read_only",
6138 list_make1(item->arg), stmt->is_local);
6139 else if (strcmp(item->defname, "transaction_deferrable") == 0)
6140 SetPGVariable("transaction_deferrable",
6141 list_make1(item->arg), stmt->is_local);
6143 elog(ERROR, "unexpected SET TRANSACTION element: %s",
6147 else if (strcmp(stmt->name, "SESSION CHARACTERISTICS") == 0)
6151 foreach(head, stmt->args)
6153 DefElem *item = (DefElem *) lfirst(head);
6155 if (strcmp(item->defname, "transaction_isolation") == 0)
6156 SetPGVariable("default_transaction_isolation",
6157 list_make1(item->arg), stmt->is_local);
6158 else if (strcmp(item->defname, "transaction_read_only") == 0)
6159 SetPGVariable("default_transaction_read_only",
6160 list_make1(item->arg), stmt->is_local);
6161 else if (strcmp(item->defname, "transaction_deferrable") == 0)
6162 SetPGVariable("default_transaction_deferrable",
6163 list_make1(item->arg), stmt->is_local);
6165 elog(ERROR, "unexpected SET SESSION element: %s",
6169 else if (strcmp(stmt->name, "TRANSACTION SNAPSHOT") == 0)
6171 A_Const *con = (A_Const *) linitial(stmt->args);
6175 (errcode(ERRCODE_FEATURE_NOT_SUPPORTED),
6176 errmsg("SET LOCAL TRANSACTION SNAPSHOT is not implemented")));
6177 Assert(IsA(con, A_Const));
6178 Assert(nodeTag(&con->val) == T_String);
6179 ImportSnapshot(strVal(&con->val));
6182 elog(ERROR, "unexpected SET MULTI element: %s",
6185 case VAR_SET_DEFAULT:
6187 (void) set_config_option(stmt->name,
6189 (superuser() ? PGC_SUSET : PGC_USERSET),
6202 * Get the value to assign for a VariableSetStmt, or NULL if it's RESET.
6203 * The result is palloc'd.
6205 * This is exported for use by actions such as ALTER ROLE SET.
6208 ExtractSetVariableArgs(VariableSetStmt *stmt)
6213 return flatten_set_variable_args(stmt->name, stmt->args);
6214 case VAR_SET_CURRENT:
6215 return GetConfigOptionByName(stmt->name, NULL);
6222 * SetPGVariable - SET command exported as an easily-C-callable function.
6224 * This provides access to SET TO value, as well as SET TO DEFAULT (expressed
6225 * by passing args == NIL), but not SET FROM CURRENT functionality.
6228 SetPGVariable(const char *name, List *args, bool is_local)
6230 char *argstring = flatten_set_variable_args(name, args);
6232 /* Note SET DEFAULT (argstring == NULL) is equivalent to RESET */
6233 (void) set_config_option(name,
6235 (superuser() ? PGC_SUSET : PGC_USERSET),
6237 is_local ? GUC_ACTION_LOCAL : GUC_ACTION_SET,
6243 * SET command wrapped as a SQL callable function.
6246 set_config_by_name(PG_FUNCTION_ARGS)
6253 if (PG_ARGISNULL(0))
6255 (errcode(ERRCODE_NULL_VALUE_NOT_ALLOWED),
6256 errmsg("SET requires parameter name")));
6258 /* Get the GUC variable name */
6259 name = TextDatumGetCString(PG_GETARG_DATUM(0));
6261 /* Get the desired value or set to NULL for a reset request */
6262 if (PG_ARGISNULL(1))
6265 value = TextDatumGetCString(PG_GETARG_DATUM(1));
6268 * Get the desired state of is_local. Default to false if provided value
6271 if (PG_ARGISNULL(2))
6274 is_local = PG_GETARG_BOOL(2);
6276 /* Note SET DEFAULT (argstring == NULL) is equivalent to RESET */
6277 (void) set_config_option(name,
6279 (superuser() ? PGC_SUSET : PGC_USERSET),
6281 is_local ? GUC_ACTION_LOCAL : GUC_ACTION_SET,
6285 /* get the new current value */
6286 new_value = GetConfigOptionByName(name, NULL);
6288 /* Convert return string to text */
6289 PG_RETURN_TEXT_P(cstring_to_text(new_value));
6294 * Common code for DefineCustomXXXVariable subroutines: allocate the
6295 * new variable's config struct and fill in generic fields.
6297 static struct config_generic *
6298 init_custom_variable(const char *name,
6299 const char *short_desc,
6300 const char *long_desc,
6303 enum config_type type,
6306 struct config_generic *gen;
6309 * Only allow custom PGC_POSTMASTER variables to be created during shared
6310 * library preload; any later than that, we can't ensure that the value
6311 * doesn't change after startup. This is a fatal elog if it happens; just
6312 * erroring out isn't safe because we don't know what the calling loadable
6313 * module might already have hooked into.
6315 if (context == PGC_POSTMASTER &&
6316 !process_shared_preload_libraries_in_progress)
6317 elog(FATAL, "cannot create PGC_POSTMASTER variables after startup");
6319 gen = (struct config_generic *) guc_malloc(ERROR, sz);
6322 gen->name = guc_strdup(ERROR, name);
6323 gen->context = context;
6324 gen->group = CUSTOM_OPTIONS;
6325 gen->short_desc = short_desc;
6326 gen->long_desc = long_desc;
6328 gen->vartype = type;
6334 * Common code for DefineCustomXXXVariable subroutines: insert the new
6335 * variable into the GUC variable array, replacing any placeholder.
6338 define_custom_variable(struct config_generic * variable)
6340 const char *name = variable->name;
6341 const char **nameAddr = &name;
6342 struct config_string *pHolder;
6343 struct config_generic **res;
6346 * See if there's a placeholder by the same name.
6348 res = (struct config_generic **) bsearch((void *) &nameAddr,
6349 (void *) guc_variables,
6351 sizeof(struct config_generic *),
6356 * No placeholder to replace, so we can just add it ... but first,
6357 * make sure it's initialized to its default value.
6359 InitializeOneGUCOption(variable);
6360 add_guc_variable(variable, ERROR);
6365 * This better be a placeholder
6367 if (((*res)->flags & GUC_CUSTOM_PLACEHOLDER) == 0)
6369 (errcode(ERRCODE_INTERNAL_ERROR),
6370 errmsg("attempt to redefine parameter \"%s\"", name)));
6372 Assert((*res)->vartype == PGC_STRING);
6373 pHolder = (struct config_string *) (*res);
6376 * First, set the variable to its default value. We must do this even
6377 * though we intend to immediately apply a new value, since it's possible
6378 * that the new value is invalid.
6380 InitializeOneGUCOption(variable);
6383 * Replace the placeholder. We aren't changing the name, so no re-sorting
6389 * Assign the string value(s) stored in the placeholder to the real
6390 * variable. Essentially, we need to duplicate all the active and stacked
6391 * values, but with appropriate validation and datatype adjustment.
6393 * If an assignment fails, we report a WARNING and keep going. We don't
6394 * want to throw ERROR for bad values, because it'd bollix the add-on
6395 * module that's presumably halfway through getting loaded. In such cases
6396 * the default or previous state will become active instead.
6399 /* First, apply the reset value if any */
6400 if (pHolder->reset_val)
6401 (void) set_config_option(name, pHolder->reset_val,
6402 pHolder->gen.reset_scontext,
6403 pHolder->gen.reset_source,
6404 GUC_ACTION_SET, true, WARNING);
6405 /* That should not have resulted in stacking anything */
6406 Assert(variable->stack == NULL);
6408 /* Now, apply current and stacked values, in the order they were stacked */
6409 reapply_stacked_values(variable, pHolder, pHolder->gen.stack,
6410 *(pHolder->variable),
6411 pHolder->gen.scontext, pHolder->gen.source);
6413 /* Also copy over any saved source-location information */
6414 if (pHolder->gen.sourcefile)
6415 set_config_sourcefile(name, pHolder->gen.sourcefile,
6416 pHolder->gen.sourceline);
6419 * Free up as much as we conveniently can of the placeholder structure.
6420 * (This neglects any stack items, so it's possible for some memory to be
6421 * leaked. Since this can only happen once per session per variable, it
6422 * doesn't seem worth spending much code on.)
6424 set_string_field(pHolder, pHolder->variable, NULL);
6425 set_string_field(pHolder, &pHolder->reset_val, NULL);
6431 * Recursive subroutine for define_custom_variable: reapply non-reset values
6433 * We recurse so that the values are applied in the same order as originally.
6434 * At each recursion level, apply the upper-level value (passed in) in the
6435 * fashion implied by the stack entry.
6438 reapply_stacked_values(struct config_generic * variable,
6439 struct config_string *pHolder,
6441 const char *curvalue,
6442 GucContext curscontext, GucSource cursource)
6444 const char *name = variable->name;
6445 GucStack *oldvarstack = variable->stack;
6449 /* First, recurse, so that stack items are processed bottom to top */
6450 reapply_stacked_values(variable, pHolder, stack->prev,
6451 stack->prior.val.stringval,
6452 stack->scontext, stack->source);
6454 /* See how to apply the passed-in value */
6455 switch (stack->state)
6458 (void) set_config_option(name, curvalue,
6459 curscontext, cursource,
6460 GUC_ACTION_SAVE, true, WARNING);
6464 (void) set_config_option(name, curvalue,
6465 curscontext, cursource,
6466 GUC_ACTION_SET, true, WARNING);
6470 (void) set_config_option(name, curvalue,
6471 curscontext, cursource,
6472 GUC_ACTION_LOCAL, true, WARNING);
6476 /* first, apply the masked value as SET */
6477 (void) set_config_option(name, stack->masked.val.stringval,
6478 stack->masked_scontext, PGC_S_SESSION,
6479 GUC_ACTION_SET, true, WARNING);
6480 /* then apply the current value as LOCAL */
6481 (void) set_config_option(name, curvalue,
6482 curscontext, cursource,
6483 GUC_ACTION_LOCAL, true, WARNING);
6487 /* If we successfully made a stack entry, adjust its nest level */
6488 if (variable->stack != oldvarstack)
6489 variable->stack->nest_level = stack->nest_level;
6494 * We are at the end of the stack. If the active/previous value is
6495 * different from the reset value, it must represent a previously
6496 * committed session value. Apply it, and then drop the stack entry
6497 * that set_config_option will have created under the impression that
6498 * this is to be just a transactional assignment. (We leak the stack
6501 if (curvalue != pHolder->reset_val ||
6502 curscontext != pHolder->gen.reset_scontext ||
6503 cursource != pHolder->gen.reset_source)
6505 (void) set_config_option(name, curvalue,
6506 curscontext, cursource,
6507 GUC_ACTION_SET, true, WARNING);
6508 variable->stack = NULL;
6514 DefineCustomBoolVariable(const char *name,
6515 const char *short_desc,
6516 const char *long_desc,
6521 GucBoolCheckHook check_hook,
6522 GucBoolAssignHook assign_hook,
6523 GucShowHook show_hook)
6525 struct config_bool *var;
6527 var = (struct config_bool *)
6528 init_custom_variable(name, short_desc, long_desc, context, flags,
6529 PGC_BOOL, sizeof(struct config_bool));
6530 var->variable = valueAddr;
6531 var->boot_val = bootValue;
6532 var->reset_val = bootValue;
6533 var->check_hook = check_hook;
6534 var->assign_hook = assign_hook;
6535 var->show_hook = show_hook;
6536 define_custom_variable(&var->gen);
6540 DefineCustomIntVariable(const char *name,
6541 const char *short_desc,
6542 const char *long_desc,
6549 GucIntCheckHook check_hook,
6550 GucIntAssignHook assign_hook,
6551 GucShowHook show_hook)
6553 struct config_int *var;
6555 var = (struct config_int *)
6556 init_custom_variable(name, short_desc, long_desc, context, flags,
6557 PGC_INT, sizeof(struct config_int));
6558 var->variable = valueAddr;
6559 var->boot_val = bootValue;
6560 var->reset_val = bootValue;
6561 var->min = minValue;
6562 var->max = maxValue;
6563 var->check_hook = check_hook;
6564 var->assign_hook = assign_hook;
6565 var->show_hook = show_hook;
6566 define_custom_variable(&var->gen);
6570 DefineCustomRealVariable(const char *name,
6571 const char *short_desc,
6572 const char *long_desc,
6579 GucRealCheckHook check_hook,
6580 GucRealAssignHook assign_hook,
6581 GucShowHook show_hook)
6583 struct config_real *var;
6585 var = (struct config_real *)
6586 init_custom_variable(name, short_desc, long_desc, context, flags,
6587 PGC_REAL, sizeof(struct config_real));
6588 var->variable = valueAddr;
6589 var->boot_val = bootValue;
6590 var->reset_val = bootValue;
6591 var->min = minValue;
6592 var->max = maxValue;
6593 var->check_hook = check_hook;
6594 var->assign_hook = assign_hook;
6595 var->show_hook = show_hook;
6596 define_custom_variable(&var->gen);
6600 DefineCustomStringVariable(const char *name,
6601 const char *short_desc,
6602 const char *long_desc,
6604 const char *bootValue,
6607 GucStringCheckHook check_hook,
6608 GucStringAssignHook assign_hook,
6609 GucShowHook show_hook)
6611 struct config_string *var;
6613 var = (struct config_string *)
6614 init_custom_variable(name, short_desc, long_desc, context, flags,
6615 PGC_STRING, sizeof(struct config_string));
6616 var->variable = valueAddr;
6617 var->boot_val = bootValue;
6618 var->check_hook = check_hook;
6619 var->assign_hook = assign_hook;
6620 var->show_hook = show_hook;
6621 define_custom_variable(&var->gen);
6625 DefineCustomEnumVariable(const char *name,
6626 const char *short_desc,
6627 const char *long_desc,
6630 const struct config_enum_entry * options,
6633 GucEnumCheckHook check_hook,
6634 GucEnumAssignHook assign_hook,
6635 GucShowHook show_hook)
6637 struct config_enum *var;
6639 var = (struct config_enum *)
6640 init_custom_variable(name, short_desc, long_desc, context, flags,
6641 PGC_ENUM, sizeof(struct config_enum));
6642 var->variable = valueAddr;
6643 var->boot_val = bootValue;
6644 var->reset_val = bootValue;
6645 var->options = options;
6646 var->check_hook = check_hook;
6647 var->assign_hook = assign_hook;
6648 var->show_hook = show_hook;
6649 define_custom_variable(&var->gen);
6653 EmitWarningsOnPlaceholders(const char *className)
6655 int classLen = strlen(className);
6658 for (i = 0; i < num_guc_variables; i++)
6660 struct config_generic *var = guc_variables[i];
6662 if ((var->flags & GUC_CUSTOM_PLACEHOLDER) != 0 &&
6663 strncmp(className, var->name, classLen) == 0 &&
6664 var->name[classLen] == GUC_QUALIFIER_SEPARATOR)
6667 (errcode(ERRCODE_UNDEFINED_OBJECT),
6668 errmsg("unrecognized configuration parameter \"%s\"",
6679 GetPGVariable(const char *name, DestReceiver *dest)
6681 if (guc_name_compare(name, "all") == 0)
6682 ShowAllGUCConfig(dest);
6684 ShowGUCConfigOption(name, dest);
6688 GetPGVariableResultDesc(const char *name)
6692 if (guc_name_compare(name, "all") == 0)
6694 /* need a tuple descriptor representing three TEXT columns */
6695 tupdesc = CreateTemplateTupleDesc(3, false);
6696 TupleDescInitEntry(tupdesc, (AttrNumber) 1, "name",
6698 TupleDescInitEntry(tupdesc, (AttrNumber) 2, "setting",
6700 TupleDescInitEntry(tupdesc, (AttrNumber) 3, "description",
6705 const char *varname;
6707 /* Get the canonical spelling of name */
6708 (void) GetConfigOptionByName(name, &varname);
6710 /* need a tuple descriptor representing a single TEXT column */
6711 tupdesc = CreateTemplateTupleDesc(1, false);
6712 TupleDescInitEntry(tupdesc, (AttrNumber) 1, varname,
6723 ShowGUCConfigOption(const char *name, DestReceiver *dest)
6725 TupOutputState *tstate;
6727 const char *varname;
6730 /* Get the value and canonical spelling of name */
6731 value = GetConfigOptionByName(name, &varname);
6733 /* need a tuple descriptor representing a single TEXT column */
6734 tupdesc = CreateTemplateTupleDesc(1, false);
6735 TupleDescInitEntry(tupdesc, (AttrNumber) 1, varname,
6738 /* prepare for projection of tuples */
6739 tstate = begin_tup_output_tupdesc(dest, tupdesc);
6742 do_text_output_oneline(tstate, value);
6744 end_tup_output(tstate);
6751 ShowAllGUCConfig(DestReceiver *dest)
6753 bool am_superuser = superuser();
6755 TupOutputState *tstate;
6758 bool isnull[3] = {false, false, false};
6760 /* need a tuple descriptor representing three TEXT columns */
6761 tupdesc = CreateTemplateTupleDesc(3, false);
6762 TupleDescInitEntry(tupdesc, (AttrNumber) 1, "name",
6764 TupleDescInitEntry(tupdesc, (AttrNumber) 2, "setting",
6766 TupleDescInitEntry(tupdesc, (AttrNumber) 3, "description",
6769 /* prepare for projection of tuples */
6770 tstate = begin_tup_output_tupdesc(dest, tupdesc);
6772 for (i = 0; i < num_guc_variables; i++)
6774 struct config_generic *conf = guc_variables[i];
6777 if ((conf->flags & GUC_NO_SHOW_ALL) ||
6778 ((conf->flags & GUC_SUPERUSER_ONLY) && !am_superuser))
6781 /* assign to the values array */
6782 values[0] = PointerGetDatum(cstring_to_text(conf->name));
6784 setting = _ShowOption(conf, true);
6787 values[1] = PointerGetDatum(cstring_to_text(setting));
6792 values[1] = PointerGetDatum(NULL);
6796 values[2] = PointerGetDatum(cstring_to_text(conf->short_desc));
6798 /* send it to dest */
6799 do_tup_output(tstate, values, isnull);
6802 pfree(DatumGetPointer(values[0]));
6806 pfree(DatumGetPointer(values[1]));
6808 pfree(DatumGetPointer(values[2]));
6811 end_tup_output(tstate);
6815 * Return GUC variable value by name; optionally return canonical
6816 * form of name. Return value is palloc'd.
6819 GetConfigOptionByName(const char *name, const char **varname)
6821 struct config_generic *record;
6823 record = find_option(name, false, ERROR);
6826 (errcode(ERRCODE_UNDEFINED_OBJECT),
6827 errmsg("unrecognized configuration parameter \"%s\"", name)));
6828 if ((record->flags & GUC_SUPERUSER_ONLY) && !superuser())
6830 (errcode(ERRCODE_INSUFFICIENT_PRIVILEGE),
6831 errmsg("must be superuser to examine \"%s\"", name)));
6834 *varname = record->name;
6836 return _ShowOption(record, true);
6840 * Return GUC variable value by variable number; optionally return canonical
6841 * form of name. Return value is palloc'd.
6844 GetConfigOptionByNum(int varnum, const char **values, bool *noshow)
6847 struct config_generic *conf;
6849 /* check requested variable number valid */
6850 Assert((varnum >= 0) && (varnum < num_guc_variables));
6852 conf = guc_variables[varnum];
6856 if ((conf->flags & GUC_NO_SHOW_ALL) ||
6857 ((conf->flags & GUC_SUPERUSER_ONLY) && !superuser()))
6863 /* first get the generic attributes */
6866 values[0] = conf->name;
6868 /* setting : use _ShowOption in order to avoid duplicating the logic */
6869 values[1] = _ShowOption(conf, false);
6872 if (conf->vartype == PGC_INT)
6876 switch (conf->flags & (GUC_UNIT_MEMORY | GUC_UNIT_TIME))
6881 case GUC_UNIT_BLOCKS:
6882 snprintf(buf, sizeof(buf), "%dkB", BLCKSZ / 1024);
6885 case GUC_UNIT_XBLOCKS:
6886 snprintf(buf, sizeof(buf), "%dkB", XLOG_BLCKSZ / 1024);
6907 values[3] = config_group_names[conf->group];
6910 values[4] = conf->short_desc;
6913 values[5] = conf->long_desc;
6916 values[6] = GucContext_Names[conf->context];
6919 values[7] = config_type_names[conf->vartype];
6922 values[8] = GucSource_Names[conf->source];
6924 /* now get the type specifc attributes */
6925 switch (conf->vartype)
6929 struct config_bool *lconf = (struct config_bool *) conf;
6941 values[12] = pstrdup(lconf->boot_val ? "on" : "off");
6944 values[13] = pstrdup(lconf->reset_val ? "on" : "off");
6950 struct config_int *lconf = (struct config_int *) conf;
6953 snprintf(buffer, sizeof(buffer), "%d", lconf->min);
6954 values[9] = pstrdup(buffer);
6957 snprintf(buffer, sizeof(buffer), "%d", lconf->max);
6958 values[10] = pstrdup(buffer);
6964 snprintf(buffer, sizeof(buffer), "%d", lconf->boot_val);
6965 values[12] = pstrdup(buffer);
6968 snprintf(buffer, sizeof(buffer), "%d", lconf->reset_val);
6969 values[13] = pstrdup(buffer);
6975 struct config_real *lconf = (struct config_real *) conf;
6978 snprintf(buffer, sizeof(buffer), "%g", lconf->min);
6979 values[9] = pstrdup(buffer);
6982 snprintf(buffer, sizeof(buffer), "%g", lconf->max);
6983 values[10] = pstrdup(buffer);
6989 snprintf(buffer, sizeof(buffer), "%g", lconf->boot_val);
6990 values[12] = pstrdup(buffer);
6993 snprintf(buffer, sizeof(buffer), "%g", lconf->reset_val);
6994 values[13] = pstrdup(buffer);
7000 struct config_string *lconf = (struct config_string *) conf;
7012 if (lconf->boot_val == NULL)
7015 values[12] = pstrdup(lconf->boot_val);
7018 if (lconf->reset_val == NULL)
7021 values[13] = pstrdup(lconf->reset_val);
7027 struct config_enum *lconf = (struct config_enum *) conf;
7038 * NOTE! enumvals with double quotes in them are not
7041 values[11] = config_enum_get_options((struct config_enum *) conf,
7042 "{\"", "\"}", "\",\"");
7045 values[12] = pstrdup(config_enum_lookup_by_value(lconf,
7049 values[13] = pstrdup(config_enum_lookup_by_value(lconf,
7057 * should never get here, but in case we do, set 'em to NULL
7079 * If the setting came from a config file, set the source location. For
7080 * security reasons, we don't show source file/line number for
7083 if (conf->source == PGC_S_FILE && superuser())
7085 values[14] = conf->sourcefile;
7086 snprintf(buffer, sizeof(buffer), "%d", conf->sourceline);
7087 values[15] = pstrdup(buffer);
7097 * Return the total number of GUC variables
7100 GetNumConfigOptions(void)
7102 return num_guc_variables;
7106 * show_config_by_name - equiv to SHOW X command but implemented as
7110 show_config_by_name(PG_FUNCTION_ARGS)
7115 /* Get the GUC variable name */
7116 varname = TextDatumGetCString(PG_GETARG_DATUM(0));
7119 varval = GetConfigOptionByName(varname, NULL);
7121 /* Convert to text */
7122 PG_RETURN_TEXT_P(cstring_to_text(varval));
7126 * show_all_settings - equiv to SHOW ALL command but implemented as
7129 #define NUM_PG_SETTINGS_ATTS 16
7132 show_all_settings(PG_FUNCTION_ARGS)
7134 FuncCallContext *funcctx;
7138 AttInMetadata *attinmeta;
7139 MemoryContext oldcontext;
7141 /* stuff done only on the first call of the function */
7142 if (SRF_IS_FIRSTCALL())
7144 /* create a function context for cross-call persistence */
7145 funcctx = SRF_FIRSTCALL_INIT();
7148 * switch to memory context appropriate for multiple function calls
7150 oldcontext = MemoryContextSwitchTo(funcctx->multi_call_memory_ctx);
7153 * need a tuple descriptor representing NUM_PG_SETTINGS_ATTS columns
7154 * of the appropriate types
7156 tupdesc = CreateTemplateTupleDesc(NUM_PG_SETTINGS_ATTS, false);
7157 TupleDescInitEntry(tupdesc, (AttrNumber) 1, "name",
7159 TupleDescInitEntry(tupdesc, (AttrNumber) 2, "setting",
7161 TupleDescInitEntry(tupdesc, (AttrNumber) 3, "unit",
7163 TupleDescInitEntry(tupdesc, (AttrNumber) 4, "category",
7165 TupleDescInitEntry(tupdesc, (AttrNumber) 5, "short_desc",
7167 TupleDescInitEntry(tupdesc, (AttrNumber) 6, "extra_desc",
7169 TupleDescInitEntry(tupdesc, (AttrNumber) 7, "context",
7171 TupleDescInitEntry(tupdesc, (AttrNumber) 8, "vartype",
7173 TupleDescInitEntry(tupdesc, (AttrNumber) 9, "source",
7175 TupleDescInitEntry(tupdesc, (AttrNumber) 10, "min_val",
7177 TupleDescInitEntry(tupdesc, (AttrNumber) 11, "max_val",
7179 TupleDescInitEntry(tupdesc, (AttrNumber) 12, "enumvals",
7180 TEXTARRAYOID, -1, 0);
7181 TupleDescInitEntry(tupdesc, (AttrNumber) 13, "boot_val",
7183 TupleDescInitEntry(tupdesc, (AttrNumber) 14, "reset_val",
7185 TupleDescInitEntry(tupdesc, (AttrNumber) 15, "sourcefile",
7187 TupleDescInitEntry(tupdesc, (AttrNumber) 16, "sourceline",
7191 * Generate attribute metadata needed later to produce tuples from raw
7194 attinmeta = TupleDescGetAttInMetadata(tupdesc);
7195 funcctx->attinmeta = attinmeta;
7197 /* total number of tuples to be returned */
7198 funcctx->max_calls = GetNumConfigOptions();
7200 MemoryContextSwitchTo(oldcontext);
7203 /* stuff done on every call of the function */
7204 funcctx = SRF_PERCALL_SETUP();
7206 call_cntr = funcctx->call_cntr;
7207 max_calls = funcctx->max_calls;
7208 attinmeta = funcctx->attinmeta;
7210 if (call_cntr < max_calls) /* do when there is more left to send */
7212 char *values[NUM_PG_SETTINGS_ATTS];
7218 * Get the next visible GUC variable name and value
7222 GetConfigOptionByNum(call_cntr, (const char **) values, &noshow);
7225 /* bump the counter and get the next config setting */
7226 call_cntr = ++funcctx->call_cntr;
7228 /* make sure we haven't gone too far now */
7229 if (call_cntr >= max_calls)
7230 SRF_RETURN_DONE(funcctx);
7235 tuple = BuildTupleFromCStrings(attinmeta, values);
7237 /* make the tuple into a datum */
7238 result = HeapTupleGetDatum(tuple);
7240 SRF_RETURN_NEXT(funcctx, result);
7244 /* do when there is no more left */
7245 SRF_RETURN_DONE(funcctx);
7250 _ShowOption(struct config_generic * record, bool use_units)
7255 switch (record->vartype)
7259 struct config_bool *conf = (struct config_bool *) record;
7261 if (conf->show_hook)
7262 val = (*conf->show_hook) ();
7264 val = *conf->variable ? "on" : "off";
7270 struct config_int *conf = (struct config_int *) record;
7272 if (conf->show_hook)
7273 val = (*conf->show_hook) ();
7277 * Use int64 arithmetic to avoid overflows in units
7280 int64 result = *conf->variable;
7283 if (use_units && result > 0 &&
7284 (record->flags & GUC_UNIT_MEMORY))
7286 switch (record->flags & GUC_UNIT_MEMORY)
7288 case GUC_UNIT_BLOCKS:
7289 result *= BLCKSZ / 1024;
7291 case GUC_UNIT_XBLOCKS:
7292 result *= XLOG_BLCKSZ / 1024;
7296 if (result % KB_PER_GB == 0)
7298 result /= KB_PER_GB;
7301 else if (result % KB_PER_MB == 0)
7303 result /= KB_PER_MB;
7311 else if (use_units && result > 0 &&
7312 (record->flags & GUC_UNIT_TIME))
7314 switch (record->flags & GUC_UNIT_TIME)
7320 result *= MS_PER_MIN;
7324 if (result % MS_PER_D == 0)
7329 else if (result % MS_PER_H == 0)
7334 else if (result % MS_PER_MIN == 0)
7336 result /= MS_PER_MIN;
7339 else if (result % MS_PER_S == 0)
7352 snprintf(buffer, sizeof(buffer), INT64_FORMAT "%s",
7361 struct config_real *conf = (struct config_real *) record;
7363 if (conf->show_hook)
7364 val = (*conf->show_hook) ();
7367 snprintf(buffer, sizeof(buffer), "%g",
7376 struct config_string *conf = (struct config_string *) record;
7378 if (conf->show_hook)
7379 val = (*conf->show_hook) ();
7380 else if (*conf->variable && **conf->variable)
7381 val = *conf->variable;
7389 struct config_enum *conf = (struct config_enum *) record;
7391 if (conf->show_hook)
7392 val = (*conf->show_hook) ();
7394 val = config_enum_lookup_by_value(conf, *conf->variable);
7399 /* just to keep compiler quiet */
7404 return pstrdup(val);
7411 * These routines dump out all non-default GUC options into a binary
7412 * file that is read by all exec'ed backends. The format is:
7414 * variable name, string, null terminated
7415 * variable value, string, null terminated
7416 * variable sourcefile, string, null terminated (empty if none)
7417 * variable sourceline, integer
7418 * variable source, integer
7419 * variable scontext, integer
7422 write_one_nondefault_variable(FILE *fp, struct config_generic * gconf)
7424 if (gconf->source == PGC_S_DEFAULT)
7427 fprintf(fp, "%s", gconf->name);
7430 switch (gconf->vartype)
7434 struct config_bool *conf = (struct config_bool *) gconf;
7436 if (*conf->variable)
7437 fprintf(fp, "true");
7439 fprintf(fp, "false");
7445 struct config_int *conf = (struct config_int *) gconf;
7447 fprintf(fp, "%d", *conf->variable);
7453 struct config_real *conf = (struct config_real *) gconf;
7455 fprintf(fp, "%.17g", *conf->variable);
7461 struct config_string *conf = (struct config_string *) gconf;
7463 fprintf(fp, "%s", *conf->variable);
7469 struct config_enum *conf = (struct config_enum *) gconf;
7472 config_enum_lookup_by_value(conf, *conf->variable));
7479 if (gconf->sourcefile)
7480 fprintf(fp, "%s", gconf->sourcefile);
7483 fwrite(&gconf->sourceline, 1, sizeof(gconf->sourceline), fp);
7484 fwrite(&gconf->source, 1, sizeof(gconf->source), fp);
7485 fwrite(&gconf->scontext, 1, sizeof(gconf->scontext), fp);
7489 write_nondefault_variables(GucContext context)
7495 Assert(context == PGC_POSTMASTER || context == PGC_SIGHUP);
7497 elevel = (context == PGC_SIGHUP) ? LOG : ERROR;
7502 fp = AllocateFile(CONFIG_EXEC_PARAMS_NEW, "w");
7506 (errcode_for_file_access(),
7507 errmsg("could not write to file \"%s\": %m",
7508 CONFIG_EXEC_PARAMS_NEW)));
7512 for (i = 0; i < num_guc_variables; i++)
7514 write_one_nondefault_variable(fp, guc_variables[i]);
7520 (errcode_for_file_access(),
7521 errmsg("could not write to file \"%s\": %m",
7522 CONFIG_EXEC_PARAMS_NEW)));
7527 * Put new file in place. This could delay on Win32, but we don't hold
7528 * any exclusive locks.
7530 rename(CONFIG_EXEC_PARAMS_NEW, CONFIG_EXEC_PARAMS);
7535 * Read string, including null byte from file
7537 * Return NULL on EOF and nothing read
7540 read_string_with_null(FILE *fp)
7549 if ((ch = fgetc(fp)) == EOF)
7554 elog(FATAL, "invalid format of exec config params file");
7557 str = guc_malloc(FATAL, maxlen);
7558 else if (i == maxlen)
7559 str = guc_realloc(FATAL, str, maxlen *= 2);
7568 * This routine loads a previous postmaster dump of its non-default
7572 read_nondefault_variables(void)
7579 GucSource varsource;
7580 GucContext varscontext;
7585 fp = AllocateFile(CONFIG_EXEC_PARAMS, "r");
7588 /* File not found is fine */
7589 if (errno != ENOENT)
7591 (errcode_for_file_access(),
7592 errmsg("could not read from file \"%s\": %m",
7593 CONFIG_EXEC_PARAMS)));
7599 struct config_generic *record;
7601 if ((varname = read_string_with_null(fp)) == NULL)
7604 if ((record = find_option(varname, true, FATAL)) == NULL)
7605 elog(FATAL, "failed to locate variable \"%s\" in exec config params file", varname);
7607 if ((varvalue = read_string_with_null(fp)) == NULL)
7608 elog(FATAL, "invalid format of exec config params file");
7609 if ((varsourcefile = read_string_with_null(fp)) == NULL)
7610 elog(FATAL, "invalid format of exec config params file");
7611 if (fread(&varsourceline, 1, sizeof(varsourceline), fp) != sizeof(varsourceline))
7612 elog(FATAL, "invalid format of exec config params file");
7613 if (fread(&varsource, 1, sizeof(varsource), fp) != sizeof(varsource))
7614 elog(FATAL, "invalid format of exec config params file");
7615 if (fread(&varscontext, 1, sizeof(varscontext), fp) != sizeof(varscontext))
7616 elog(FATAL, "invalid format of exec config params file");
7618 (void) set_config_option(varname, varvalue,
7619 varscontext, varsource,
7620 GUC_ACTION_SET, true, 0);
7621 if (varsourcefile[0])
7622 set_config_sourcefile(varname, varsourcefile, varsourceline);
7626 free(varsourcefile);
7631 #endif /* EXEC_BACKEND */
7635 * A little "long argument" simulation, although not quite GNU
7636 * compliant. Takes a string of the form "some-option=some value" and
7637 * returns name = "some_option" and value = "some value" in malloc'ed
7638 * storage. Note that '-' is converted to '_' in the option name. If
7639 * there is no '=' in the input string then value will be NULL.
7642 ParseLongOption(const char *string, char **name, char **value)
7651 equal_pos = strcspn(string, "=");
7653 if (string[equal_pos] == '=')
7655 *name = guc_malloc(FATAL, equal_pos + 1);
7656 strlcpy(*name, string, equal_pos + 1);
7658 *value = guc_strdup(FATAL, &string[equal_pos + 1]);
7662 /* no equal sign in string */
7663 *name = guc_strdup(FATAL, string);
7667 for (cp = *name; *cp; cp++)
7674 * Handle options fetched from pg_db_role_setting.setconfig,
7675 * pg_proc.proconfig, etc. Caller must specify proper context/source/action.
7677 * The array parameter must be an array of TEXT (it must not be NULL).
7680 ProcessGUCArray(ArrayType *array,
7681 GucContext context, GucSource source, GucAction action)
7685 Assert(array != NULL);
7686 Assert(ARR_ELEMTYPE(array) == TEXTOID);
7687 Assert(ARR_NDIM(array) == 1);
7688 Assert(ARR_LBOUND(array)[0] == 1);
7690 for (i = 1; i <= ARR_DIMS(array)[0]; i++)
7698 d = array_ref(array, 1, &i,
7699 -1 /* varlenarray */ ,
7700 -1 /* TEXT's typlen */ ,
7701 false /* TEXT's typbyval */ ,
7702 'i' /* TEXT's typalign */ ,
7708 s = TextDatumGetCString(d);
7710 ParseLongOption(s, &name, &value);
7714 (errcode(ERRCODE_SYNTAX_ERROR),
7715 errmsg("could not parse setting for parameter \"%s\"",
7721 (void) set_config_option(name, value,
7734 * Add an entry to an option array. The array parameter may be NULL
7735 * to indicate the current table entry is NULL.
7738 GUCArrayAdd(ArrayType *array, const char *name, const char *value)
7740 struct config_generic *record;
7748 /* test if the option is valid and we're allowed to set it */
7749 (void) validate_option_array_item(name, value, false);
7751 /* normalize name (converts obsolete GUC names to modern spellings) */
7752 record = find_option(name, false, WARNING);
7754 name = record->name;
7756 /* build new item for array */
7757 newval = palloc(strlen(name) + 1 + strlen(value) + 1);
7758 sprintf(newval, "%s=%s", name, value);
7759 datum = CStringGetTextDatum(newval);
7767 Assert(ARR_ELEMTYPE(array) == TEXTOID);
7768 Assert(ARR_NDIM(array) == 1);
7769 Assert(ARR_LBOUND(array)[0] == 1);
7771 index = ARR_DIMS(array)[0] + 1; /* add after end */
7773 for (i = 1; i <= ARR_DIMS(array)[0]; i++)
7778 d = array_ref(array, 1, &i,
7779 -1 /* varlenarray */ ,
7780 -1 /* TEXT's typlen */ ,
7781 false /* TEXT's typbyval */ ,
7782 'i' /* TEXT's typalign */ ,
7786 current = TextDatumGetCString(d);
7788 /* check for match up through and including '=' */
7789 if (strncmp(current, newval, strlen(name) + 1) == 0)
7796 a = array_set(array, 1, &index,
7799 -1 /* varlena array */ ,
7800 -1 /* TEXT's typlen */ ,
7801 false /* TEXT's typbyval */ ,
7802 'i' /* TEXT's typalign */ );
7805 a = construct_array(&datum, 1,
7814 * Delete an entry from an option array. The array parameter may be NULL
7815 * to indicate the current table entry is NULL. Also, if the return value
7816 * is NULL then a null should be stored.
7819 GUCArrayDelete(ArrayType *array, const char *name)
7821 struct config_generic *record;
7822 ArrayType *newarray;
7828 /* test if the option is valid and we're allowed to set it */
7829 (void) validate_option_array_item(name, NULL, false);
7831 /* normalize name (converts obsolete GUC names to modern spellings) */
7832 record = find_option(name, false, WARNING);
7834 name = record->name;
7836 /* if array is currently null, then surely nothing to delete */
7843 for (i = 1; i <= ARR_DIMS(array)[0]; i++)
7849 d = array_ref(array, 1, &i,
7850 -1 /* varlenarray */ ,
7851 -1 /* TEXT's typlen */ ,
7852 false /* TEXT's typbyval */ ,
7853 'i' /* TEXT's typalign */ ,
7857 val = TextDatumGetCString(d);
7859 /* ignore entry if it's what we want to delete */
7860 if (strncmp(val, name, strlen(name)) == 0
7861 && val[strlen(name)] == '=')
7864 /* else add it to the output array */
7866 newarray = array_set(newarray, 1, &index,
7869 -1 /* varlenarray */ ,
7870 -1 /* TEXT's typlen */ ,
7871 false /* TEXT's typbyval */ ,
7872 'i' /* TEXT's typalign */ );
7874 newarray = construct_array(&d, 1,
7886 * Given a GUC array, delete all settings from it that our permission
7887 * level allows: if superuser, delete them all; if regular user, only
7888 * those that are PGC_USERSET
7891 GUCArrayReset(ArrayType *array)
7893 ArrayType *newarray;
7897 /* if array is currently null, nothing to do */
7901 /* if we're superuser, we can delete everything, so just do it */
7908 for (i = 1; i <= ARR_DIMS(array)[0]; i++)
7915 d = array_ref(array, 1, &i,
7916 -1 /* varlenarray */ ,
7917 -1 /* TEXT's typlen */ ,
7918 false /* TEXT's typbyval */ ,
7919 'i' /* TEXT's typalign */ ,
7923 val = TextDatumGetCString(d);
7925 eqsgn = strchr(val, '=');
7928 /* skip if we have permission to delete it */
7929 if (validate_option_array_item(val, NULL, true))
7932 /* else add it to the output array */
7934 newarray = array_set(newarray, 1, &index,
7937 -1 /* varlenarray */ ,
7938 -1 /* TEXT's typlen */ ,
7939 false /* TEXT's typbyval */ ,
7940 'i' /* TEXT's typalign */ );
7942 newarray = construct_array(&d, 1,
7954 * Validate a proposed option setting for GUCArrayAdd/Delete/Reset.
7956 * name is the option name. value is the proposed value for the Add case,
7957 * or NULL for the Delete/Reset cases. If skipIfNoPermissions is true, it's
7958 * not an error to have no permissions to set the option.
7960 * Returns TRUE if OK, FALSE if skipIfNoPermissions is true and user does not
7961 * have permission to change this option (all other error cases result in an
7962 * error being thrown).
7965 validate_option_array_item(const char *name, const char *value,
7966 bool skipIfNoPermissions)
7969 struct config_generic *gconf;
7972 * There are three cases to consider:
7974 * name is a known GUC variable. Check the value normally, check
7975 * permissions normally (ie, allow if variable is USERSET, or if it's
7976 * SUSET and user is superuser).
7978 * name is not known, but exists or can be created as a placeholder (i.e.,
7979 * it has a prefixed name). We allow this case if you're a superuser,
7980 * otherwise not. Superusers are assumed to know what they're doing.
7981 * We can't allow it for other users, because when the placeholder is
7982 * resolved it might turn out to be a SUSET variable;
7983 * define_custom_variable assumes we checked that.
7985 * name is not known and can't be created as a placeholder. Throw error,
7986 * unless skipIfNoPermissions is true, in which case return FALSE.
7988 gconf = find_option(name, true, WARNING);
7991 /* not known, failed to make a placeholder */
7992 if (skipIfNoPermissions)
7995 (errcode(ERRCODE_UNDEFINED_OBJECT),
7996 errmsg("unrecognized configuration parameter \"%s\"",
8000 if (gconf->flags & GUC_CUSTOM_PLACEHOLDER)
8003 * We cannot do any meaningful check on the value, so only permissions
8004 * are useful to check.
8008 if (skipIfNoPermissions)
8011 (errcode(ERRCODE_INSUFFICIENT_PRIVILEGE),
8012 errmsg("permission denied to set parameter \"%s\"", name)));
8015 /* manual permissions check so we can avoid an error being thrown */
8016 if (gconf->context == PGC_USERSET)
8018 else if (gconf->context == PGC_SUSET && superuser())
8020 else if (skipIfNoPermissions)
8022 /* if a permissions error should be thrown, let set_config_option do it */
8024 /* test for permissions and valid option value */
8025 (void) set_config_option(name, value,
8026 superuser() ? PGC_SUSET : PGC_USERSET,
8027 PGC_S_TEST, GUC_ACTION_SET, false, 0);
8034 * Called by check_hooks that want to override the normal
8035 * ERRCODE_INVALID_PARAMETER_VALUE SQLSTATE for check hook failures.
8037 * Note that GUC_check_errmsg() etc are just macros that result in a direct
8038 * assignment to the associated variables. That is ugly, but forced by the
8039 * limitations of C's macro mechanisms.
8042 GUC_check_errcode(int sqlerrcode)
8044 GUC_check_errcode_value = sqlerrcode;
8049 * Convenience functions to manage calling a variable's check_hook.
8050 * These mostly take care of the protocol for letting check hooks supply
8051 * portions of the error report on failure.
8055 call_bool_check_hook(struct config_bool * conf, bool *newval, void **extra,
8056 GucSource source, int elevel)
8058 /* Quick success if no hook */
8059 if (!conf->check_hook)
8062 /* Reset variables that might be set by hook */
8063 GUC_check_errcode_value = ERRCODE_INVALID_PARAMETER_VALUE;
8064 GUC_check_errmsg_string = NULL;
8065 GUC_check_errdetail_string = NULL;
8066 GUC_check_errhint_string = NULL;
8068 if (!(*conf->check_hook) (newval, extra, source))
8071 (errcode(GUC_check_errcode_value),
8072 GUC_check_errmsg_string ?
8073 errmsg_internal("%s", GUC_check_errmsg_string) :
8074 errmsg("invalid value for parameter \"%s\": %d",
8075 conf->gen.name, (int) *newval),
8076 GUC_check_errdetail_string ?
8077 errdetail_internal("%s", GUC_check_errdetail_string) : 0,
8078 GUC_check_errhint_string ?
8079 errhint("%s", GUC_check_errhint_string) : 0));
8080 /* Flush any strings created in ErrorContext */
8089 call_int_check_hook(struct config_int * conf, int *newval, void **extra,
8090 GucSource source, int elevel)
8092 /* Quick success if no hook */
8093 if (!conf->check_hook)
8096 /* Reset variables that might be set by hook */
8097 GUC_check_errcode_value = ERRCODE_INVALID_PARAMETER_VALUE;
8098 GUC_check_errmsg_string = NULL;
8099 GUC_check_errdetail_string = NULL;
8100 GUC_check_errhint_string = NULL;
8102 if (!(*conf->check_hook) (newval, extra, source))
8105 (errcode(GUC_check_errcode_value),
8106 GUC_check_errmsg_string ?
8107 errmsg_internal("%s", GUC_check_errmsg_string) :
8108 errmsg("invalid value for parameter \"%s\": %d",
8109 conf->gen.name, *newval),
8110 GUC_check_errdetail_string ?
8111 errdetail_internal("%s", GUC_check_errdetail_string) : 0,
8112 GUC_check_errhint_string ?
8113 errhint("%s", GUC_check_errhint_string) : 0));
8114 /* Flush any strings created in ErrorContext */
8123 call_real_check_hook(struct config_real * conf, double *newval, void **extra,
8124 GucSource source, int elevel)
8126 /* Quick success if no hook */
8127 if (!conf->check_hook)
8130 /* Reset variables that might be set by hook */
8131 GUC_check_errcode_value = ERRCODE_INVALID_PARAMETER_VALUE;
8132 GUC_check_errmsg_string = NULL;
8133 GUC_check_errdetail_string = NULL;
8134 GUC_check_errhint_string = NULL;
8136 if (!(*conf->check_hook) (newval, extra, source))
8139 (errcode(GUC_check_errcode_value),
8140 GUC_check_errmsg_string ?
8141 errmsg_internal("%s", GUC_check_errmsg_string) :
8142 errmsg("invalid value for parameter \"%s\": %g",
8143 conf->gen.name, *newval),
8144 GUC_check_errdetail_string ?
8145 errdetail_internal("%s", GUC_check_errdetail_string) : 0,
8146 GUC_check_errhint_string ?
8147 errhint("%s", GUC_check_errhint_string) : 0));
8148 /* Flush any strings created in ErrorContext */
8157 call_string_check_hook(struct config_string * conf, char **newval, void **extra,
8158 GucSource source, int elevel)
8160 /* Quick success if no hook */
8161 if (!conf->check_hook)
8164 /* Reset variables that might be set by hook */
8165 GUC_check_errcode_value = ERRCODE_INVALID_PARAMETER_VALUE;
8166 GUC_check_errmsg_string = NULL;
8167 GUC_check_errdetail_string = NULL;
8168 GUC_check_errhint_string = NULL;
8170 if (!(*conf->check_hook) (newval, extra, source))
8173 (errcode(GUC_check_errcode_value),
8174 GUC_check_errmsg_string ?
8175 errmsg_internal("%s", GUC_check_errmsg_string) :
8176 errmsg("invalid value for parameter \"%s\": \"%s\"",
8177 conf->gen.name, *newval ? *newval : ""),
8178 GUC_check_errdetail_string ?
8179 errdetail_internal("%s", GUC_check_errdetail_string) : 0,
8180 GUC_check_errhint_string ?
8181 errhint("%s", GUC_check_errhint_string) : 0));
8182 /* Flush any strings created in ErrorContext */
8191 call_enum_check_hook(struct config_enum * conf, int *newval, void **extra,
8192 GucSource source, int elevel)
8194 /* Quick success if no hook */
8195 if (!conf->check_hook)
8198 /* Reset variables that might be set by hook */
8199 GUC_check_errcode_value = ERRCODE_INVALID_PARAMETER_VALUE;
8200 GUC_check_errmsg_string = NULL;
8201 GUC_check_errdetail_string = NULL;
8202 GUC_check_errhint_string = NULL;
8204 if (!(*conf->check_hook) (newval, extra, source))
8207 (errcode(GUC_check_errcode_value),
8208 GUC_check_errmsg_string ?
8209 errmsg_internal("%s", GUC_check_errmsg_string) :
8210 errmsg("invalid value for parameter \"%s\": \"%s\"",
8212 config_enum_lookup_by_value(conf, *newval)),
8213 GUC_check_errdetail_string ?
8214 errdetail_internal("%s", GUC_check_errdetail_string) : 0,
8215 GUC_check_errhint_string ?
8216 errhint("%s", GUC_check_errhint_string) : 0));
8217 /* Flush any strings created in ErrorContext */
8227 * check_hook, assign_hook and show_hook subroutines
8231 check_log_destination(char **newval, void **extra, GucSource source)
8239 /* Need a modifiable copy of string */
8240 rawstring = pstrdup(*newval);
8242 /* Parse string into list of identifiers */
8243 if (!SplitIdentifierString(rawstring, ',', &elemlist))
8245 /* syntax error in list */
8246 GUC_check_errdetail("List syntax is invalid.");
8248 list_free(elemlist);
8252 foreach(l, elemlist)
8254 char *tok = (char *) lfirst(l);
8256 if (pg_strcasecmp(tok, "stderr") == 0)
8257 newlogdest |= LOG_DESTINATION_STDERR;
8258 else if (pg_strcasecmp(tok, "csvlog") == 0)
8259 newlogdest |= LOG_DESTINATION_CSVLOG;
8261 else if (pg_strcasecmp(tok, "syslog") == 0)
8262 newlogdest |= LOG_DESTINATION_SYSLOG;
8265 else if (pg_strcasecmp(tok, "eventlog") == 0)
8266 newlogdest |= LOG_DESTINATION_EVENTLOG;
8270 GUC_check_errdetail("Unrecognized key word: \"%s\".", tok);
8272 list_free(elemlist);
8278 list_free(elemlist);
8280 myextra = (int *) guc_malloc(ERROR, sizeof(int));
8281 *myextra = newlogdest;
8282 *extra = (void *) myextra;
8288 assign_log_destination(const char *newval, void *extra)
8290 Log_destination = *((int *) extra);
8294 assign_syslog_facility(int newval, void *extra)
8297 set_syslog_parameters(syslog_ident_str ? syslog_ident_str : "postgres",
8300 /* Without syslog support, just ignore it */
8304 assign_syslog_ident(const char *newval, void *extra)
8307 set_syslog_parameters(newval, syslog_facility);
8309 /* Without syslog support, it will always be set to "none", so ignore */
8314 assign_session_replication_role(int newval, void *extra)
8317 * Must flush the plan cache when changing replication role; but don't
8318 * flush unnecessarily.
8320 if (SessionReplicationRole != newval)
8325 check_temp_buffers(int *newval, void **extra, GucSource source)
8328 * Once local buffers have been initialized, it's too late to change this.
8330 if (NLocBuffer && NLocBuffer != *newval)
8332 GUC_check_errdetail("\"temp_buffers\" cannot be changed after any temporary tables have been accessed in the session.");
8339 check_phony_autocommit(bool *newval, void **extra, GucSource source)
8343 GUC_check_errcode(ERRCODE_FEATURE_NOT_SUPPORTED);
8344 GUC_check_errmsg("SET AUTOCOMMIT TO OFF is no longer supported");
8351 check_debug_assertions(bool *newval, void **extra, GucSource source)
8353 #ifndef USE_ASSERT_CHECKING
8356 GUC_check_errmsg("assertion checking is not supported by this build");
8364 check_bonjour(bool *newval, void **extra, GucSource source)
8369 GUC_check_errmsg("Bonjour is not supported by this build");
8377 check_ssl(bool *newval, void **extra, GucSource source)
8382 GUC_check_errmsg("SSL is not supported by this build");
8390 check_stage_log_stats(bool *newval, void **extra, GucSource source)
8392 if (*newval && log_statement_stats)
8394 GUC_check_errdetail("Cannot enable parameter when \"log_statement_stats\" is true.");
8401 check_log_stats(bool *newval, void **extra, GucSource source)
8404 (log_parser_stats || log_planner_stats || log_executor_stats))
8406 GUC_check_errdetail("Cannot enable \"log_statement_stats\" when "
8407 "\"log_parser_stats\", \"log_planner_stats\", "
8408 "or \"log_executor_stats\" is true.");
8415 check_canonical_path(char **newval, void **extra, GucSource source)
8418 * Since canonicalize_path never enlarges the string, we can just modify
8419 * newval in-place. But watch out for NULL, which is the default value
8420 * for external_pid_file.
8423 canonicalize_path(*newval);
8428 check_timezone_abbreviations(char **newval, void **extra, GucSource source)
8431 * The boot_val given above for timezone_abbreviations is NULL. When we
8432 * see this we just do nothing. If this value isn't overridden from the
8433 * config file then pg_timezone_abbrev_initialize() will eventually
8434 * replace it with "Default". This hack has two purposes: to avoid
8435 * wasting cycles loading values that might soon be overridden from the
8436 * config file, and to avoid trying to read the timezone abbrev files
8437 * during InitializeGUCOptions(). The latter doesn't work in an
8438 * EXEC_BACKEND subprocess because my_exec_path hasn't been set yet and so
8439 * we can't locate PGSHAREDIR.
8441 if (*newval == NULL)
8443 Assert(source == PGC_S_DEFAULT);
8447 /* OK, load the file and produce a malloc'd TimeZoneAbbrevTable */
8448 *extra = load_tzoffsets(*newval);
8450 /* tzparser.c returns NULL on failure, reporting via GUC_check_errmsg */
8458 assign_timezone_abbreviations(const char *newval, void *extra)
8460 /* Do nothing for the boot_val default of NULL */
8464 InstallTimeZoneAbbrevs((TimeZoneAbbrevTable *) extra);
8468 * pg_timezone_abbrev_initialize --- set default value if not done already
8470 * This is called after initial loading of postgresql.conf. If no
8471 * timezone_abbreviations setting was found therein, select default.
8472 * If a non-default value is already installed, nothing will happen.
8474 * This can also be called from ProcessConfigFile to establish the default
8475 * value after a postgresql.conf entry for it is removed.
8478 pg_timezone_abbrev_initialize(void)
8480 SetConfigOption("timezone_abbreviations", "Default",
8481 PGC_POSTMASTER, PGC_S_DYNAMIC_DEFAULT);
8485 show_archive_command(void)
8487 if (XLogArchivingActive())
8488 return XLogArchiveCommand;
8490 return "(disabled)";
8494 assign_tcp_keepalives_idle(int newval, void *extra)
8497 * The kernel API provides no way to test a value without setting it; and
8498 * once we set it we might fail to unset it. So there seems little point
8499 * in fully implementing the check-then-assign GUC API for these
8500 * variables. Instead we just do the assignment on demand. pqcomm.c
8501 * reports any problems via elog(LOG).
8503 * This approach means that the GUC value might have little to do with the
8504 * actual kernel value, so we use a show_hook that retrieves the kernel
8505 * value rather than trusting GUC's copy.
8507 (void) pq_setkeepalivesidle(newval, MyProcPort);
8511 show_tcp_keepalives_idle(void)
8513 /* See comments in assign_tcp_keepalives_idle */
8514 static char nbuf[16];
8516 snprintf(nbuf, sizeof(nbuf), "%d", pq_getkeepalivesidle(MyProcPort));
8521 assign_tcp_keepalives_interval(int newval, void *extra)
8523 /* See comments in assign_tcp_keepalives_idle */
8524 (void) pq_setkeepalivesinterval(newval, MyProcPort);
8528 show_tcp_keepalives_interval(void)
8530 /* See comments in assign_tcp_keepalives_idle */
8531 static char nbuf[16];
8533 snprintf(nbuf, sizeof(nbuf), "%d", pq_getkeepalivesinterval(MyProcPort));
8538 assign_tcp_keepalives_count(int newval, void *extra)
8540 /* See comments in assign_tcp_keepalives_idle */
8541 (void) pq_setkeepalivescount(newval, MyProcPort);
8545 show_tcp_keepalives_count(void)
8547 /* See comments in assign_tcp_keepalives_idle */
8548 static char nbuf[16];
8550 snprintf(nbuf, sizeof(nbuf), "%d", pq_getkeepalivescount(MyProcPort));
8555 check_maxconnections(int *newval, void **extra, GucSource source)
8557 if (*newval + autovacuum_max_workers + 1 > MAX_BACKENDS)
8563 assign_maxconnections(int newval, void *extra)
8565 MaxBackends = newval + autovacuum_max_workers + 1;
8569 check_autovacuum_max_workers(int *newval, void **extra, GucSource source)
8571 if (MaxConnections + *newval + 1 > MAX_BACKENDS)
8577 assign_autovacuum_max_workers(int newval, void *extra)
8579 MaxBackends = MaxConnections + newval + 1;
8583 check_effective_io_concurrency(int *newval, void **extra, GucSource source)
8586 double new_prefetch_pages = 0.0;
8590 * The user-visible GUC parameter is the number of drives (spindles),
8591 * which we need to translate to a number-of-pages-to-prefetch target.
8592 * The target value is stashed in *extra and then assigned to the actual
8593 * variable by assign_effective_io_concurrency.
8595 * The expected number of prefetch pages needed to keep N drives busy is:
8597 * drives | I/O requests
8598 * -------+----------------
8601 * 3 | 3/1 + 3/2 + 3/3 = 5 1/2
8602 * 4 | 4/1 + 4/2 + 4/3 + 4/4 = 8 1/3
8605 * This is called the "coupon collector problem" and H(n) is called the
8606 * harmonic series. This could be approximated by n * ln(n), but for
8607 * reasonable numbers of drives we might as well just compute the series.
8609 * Alternatively we could set the target to the number of pages necessary
8610 * so that the expected number of active spindles is some arbitrary
8611 * percentage of the total. This sounds the same but is actually slightly
8612 * different. The result ends up being ln(1-P)/ln((n-1)/n) where P is
8613 * that desired fraction.
8615 * Experimental results show that both of these formulas aren't aggressive
8616 * enough, but we don't really have any better proposals.
8618 * Note that if *newval = 0 (disabled), we must set target = 0.
8622 for (i = 1; i <= *newval; i++)
8623 new_prefetch_pages += (double) *newval / (double) i;
8625 /* This range check shouldn't fail, but let's be paranoid */
8626 if (new_prefetch_pages >= 0.0 && new_prefetch_pages < (double) INT_MAX)
8628 int *myextra = (int *) guc_malloc(ERROR, sizeof(int));
8630 *myextra = (int) rint(new_prefetch_pages);
8631 *extra = (void *) myextra;
8639 #endif /* USE_PREFETCH */
8643 assign_effective_io_concurrency(int newval, void *extra)
8646 target_prefetch_pages = *((int *) extra);
8647 #endif /* USE_PREFETCH */
8651 assign_pgstat_temp_directory(const char *newval, void *extra)
8653 /* check_canonical_path already canonicalized newval for us */
8657 tname = guc_malloc(ERROR, strlen(newval) + 12); /* /pgstat.tmp */
8658 sprintf(tname, "%s/pgstat.tmp", newval);
8659 fname = guc_malloc(ERROR, strlen(newval) + 13); /* /pgstat.stat */
8660 sprintf(fname, "%s/pgstat.stat", newval);
8662 if (pgstat_stat_tmpname)
8663 free(pgstat_stat_tmpname);
8664 pgstat_stat_tmpname = tname;
8665 if (pgstat_stat_filename)
8666 free(pgstat_stat_filename);
8667 pgstat_stat_filename = fname;
8671 check_application_name(char **newval, void **extra, GucSource source)
8673 /* Only allow clean ASCII chars in the application name */
8676 for (p = *newval; *p; p++)
8678 if (*p < 32 || *p > 126)
8686 assign_application_name(const char *newval, void *extra)
8688 /* Update the pg_stat_activity view */
8689 pgstat_report_appname(newval);
8693 show_unix_socket_permissions(void)
8697 snprintf(buf, sizeof(buf), "%04o", Unix_socket_permissions);
8702 show_log_file_mode(void)
8706 snprintf(buf, sizeof(buf), "%04o", Log_file_mode);
8710 #include "guc-file.c"