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-2009, PostgreSQL Global Development Group
10 * Written by Peter Eisentraut <peter_e@gmx.net>.
13 * $PostgreSQL: pgsql/src/backend/utils/misc/guc.c,v 1.525 2009/12/02 04:54:10 tgl Exp $
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/pqformat.h"
42 #include "miscadmin.h"
43 #include "optimizer/cost.h"
44 #include "optimizer/geqo.h"
45 #include "optimizer/paths.h"
46 #include "optimizer/planmain.h"
47 #include "parser/parse_expr.h"
48 #include "parser/parse_type.h"
49 #include "parser/parser.h"
50 #include "parser/scansup.h"
52 #include "postmaster/autovacuum.h"
53 #include "postmaster/bgwriter.h"
54 #include "postmaster/postmaster.h"
55 #include "postmaster/syslogger.h"
56 #include "postmaster/walwriter.h"
57 #include "storage/bufmgr.h"
58 #include "storage/fd.h"
59 #include "tcop/tcopprot.h"
60 #include "tsearch/ts_cache.h"
61 #include "utils/builtins.h"
62 #include "utils/bytea.h"
63 #include "utils/guc_tables.h"
64 #include "utils/memutils.h"
65 #include "utils/pg_locale.h"
66 #include "utils/plancache.h"
67 #include "utils/portal.h"
68 #include "utils/ps_status.h"
69 #include "utils/tzparser.h"
70 #include "utils/xml.h"
73 #define PG_KRB_SRVTAB ""
76 #define PG_KRB_SRVNAM ""
79 #define CONFIG_FILENAME "postgresql.conf"
80 #define HBA_FILENAME "pg_hba.conf"
81 #define IDENT_FILENAME "pg_ident.conf"
84 #define CONFIG_EXEC_PARAMS "global/config_exec_params"
85 #define CONFIG_EXEC_PARAMS_NEW "global/config_exec_params.new"
88 /* upper limit for GUC variables measured in kilobytes of memory */
90 #define MAX_KILOBYTES INT_MAX
92 #define MAX_KILOBYTES (INT_MAX / 1024)
95 #define KB_PER_MB (1024)
96 #define KB_PER_GB (1024*1024)
100 #define MS_PER_MIN (1000 * 60)
102 #define S_PER_H (60 * 60)
103 #define MS_PER_H (1000 * 60 * 60)
104 #define MIN_PER_D (60 * 24)
105 #define S_PER_D (60 * 60 * 24)
106 #define MS_PER_D (1000 * 60 * 60 * 24)
108 /* XXX these should appear in other modules' header files */
109 extern bool Log_disconnections;
110 extern int CommitDelay;
111 extern int CommitSiblings;
112 extern char *default_tablespace;
113 extern char *temp_tablespaces;
114 extern bool synchronize_seqscans;
115 extern bool fullPageWrites;
118 extern bool trace_sort;
120 #ifdef TRACE_SYNCSCAN
121 extern bool trace_syncscan;
123 #ifdef DEBUG_BOUNDED_SORT
124 extern bool optimize_bounded_sort;
128 extern char *SSLCipherSuites;
131 static void set_config_sourcefile(const char *name, char *sourcefile,
134 static const char *assign_log_destination(const char *value,
135 bool doit, GucSource source);
138 static int syslog_facility = LOG_LOCAL0;
140 static bool assign_syslog_facility(int newval,
141 bool doit, GucSource source);
142 static const char *assign_syslog_ident(const char *ident,
143 bool doit, GucSource source);
146 static bool assign_session_replication_role(int newval, bool doit,
148 static const char *show_num_temp_buffers(void);
149 static bool assign_phony_autocommit(bool newval, bool doit, GucSource source);
150 static const char *assign_custom_variable_classes(const char *newval, bool doit,
152 static bool assign_debug_assertions(bool newval, bool doit, GucSource source);
153 static bool assign_bonjour(bool newval, bool doit, GucSource source);
154 static bool assign_ssl(bool newval, bool doit, GucSource source);
155 static bool assign_stage_log_stats(bool newval, bool doit, GucSource source);
156 static bool assign_log_stats(bool newval, bool doit, GucSource source);
157 static bool assign_transaction_read_only(bool newval, bool doit, GucSource source);
158 static const char *assign_canonical_path(const char *newval, bool doit, GucSource source);
159 static const char *assign_timezone_abbreviations(const char *newval, bool doit, GucSource source);
160 static const char *show_archive_command(void);
161 static bool assign_tcp_keepalives_idle(int newval, bool doit, GucSource source);
162 static bool assign_tcp_keepalives_interval(int newval, bool doit, GucSource source);
163 static bool assign_tcp_keepalives_count(int newval, bool doit, GucSource source);
164 static const char *show_tcp_keepalives_idle(void);
165 static const char *show_tcp_keepalives_interval(void);
166 static const char *show_tcp_keepalives_count(void);
167 static bool assign_maxconnections(int newval, bool doit, GucSource source);
168 static bool assign_autovacuum_max_workers(int newval, bool doit, GucSource source);
169 static bool assign_effective_io_concurrency(int newval, bool doit, GucSource source);
170 static const char *assign_pgstat_temp_directory(const char *newval, bool doit, GucSource source);
171 static const char *assign_application_name(const char *newval, bool doit, GucSource source);
173 static char *config_enum_get_options(struct config_enum * record,
174 const char *prefix, const char *suffix,
175 const char *separator);
179 * Options for enum values defined in this module.
181 * NOTE! Option values may not contain double quotes!
184 static const struct config_enum_entry bytea_output_options[] = {
185 {"escape", BYTEA_OUTPUT_ESCAPE, false},
186 {"hex", BYTEA_OUTPUT_HEX, false},
191 * We have different sets for client and server message level options because
192 * they sort slightly different (see "log" level)
194 static const struct config_enum_entry client_message_level_options[] = {
195 {"debug", DEBUG2, true},
196 {"debug5", DEBUG5, false},
197 {"debug4", DEBUG4, false},
198 {"debug3", DEBUG3, false},
199 {"debug2", DEBUG2, false},
200 {"debug1", DEBUG1, false},
202 {"info", INFO, true},
203 {"notice", NOTICE, false},
204 {"warning", WARNING, false},
205 {"error", ERROR, false},
206 {"fatal", FATAL, true},
207 {"panic", PANIC, true},
211 static const struct config_enum_entry server_message_level_options[] = {
212 {"debug", DEBUG2, true},
213 {"debug5", DEBUG5, false},
214 {"debug4", DEBUG4, false},
215 {"debug3", DEBUG3, false},
216 {"debug2", DEBUG2, false},
217 {"debug1", DEBUG1, false},
218 {"info", INFO, false},
219 {"notice", NOTICE, false},
220 {"warning", WARNING, false},
221 {"error", ERROR, false},
223 {"fatal", FATAL, false},
224 {"panic", PANIC, false},
228 static const struct config_enum_entry intervalstyle_options[] = {
229 {"postgres", INTSTYLE_POSTGRES, false},
230 {"postgres_verbose", INTSTYLE_POSTGRES_VERBOSE, false},
231 {"sql_standard", INTSTYLE_SQL_STANDARD, false},
232 {"iso_8601", INTSTYLE_ISO_8601, false},
236 static const struct config_enum_entry log_error_verbosity_options[] = {
237 {"terse", PGERROR_TERSE, false},
238 {"default", PGERROR_DEFAULT, false},
239 {"verbose", PGERROR_VERBOSE, false},
243 static const struct config_enum_entry log_statement_options[] = {
244 {"none", LOGSTMT_NONE, false},
245 {"ddl", LOGSTMT_DDL, false},
246 {"mod", LOGSTMT_MOD, false},
247 {"all", LOGSTMT_ALL, false},
251 static const struct config_enum_entry isolation_level_options[] = {
252 {"serializable", XACT_SERIALIZABLE, false},
253 {"repeatable read", XACT_REPEATABLE_READ, false},
254 {"read committed", XACT_READ_COMMITTED, false},
255 {"read uncommitted", XACT_READ_UNCOMMITTED, false},
259 static const struct config_enum_entry session_replication_role_options[] = {
260 {"origin", SESSION_REPLICATION_ROLE_ORIGIN, false},
261 {"replica", SESSION_REPLICATION_ROLE_REPLICA, false},
262 {"local", SESSION_REPLICATION_ROLE_LOCAL, false},
267 static const struct config_enum_entry syslog_facility_options[] = {
268 {"local0", LOG_LOCAL0, false},
269 {"local1", LOG_LOCAL1, false},
270 {"local2", LOG_LOCAL2, false},
271 {"local3", LOG_LOCAL3, false},
272 {"local4", LOG_LOCAL4, false},
273 {"local5", LOG_LOCAL5, false},
274 {"local6", LOG_LOCAL6, false},
275 {"local7", LOG_LOCAL7, false},
280 static const struct config_enum_entry track_function_options[] = {
281 {"none", TRACK_FUNC_OFF, false},
282 {"pl", TRACK_FUNC_PL, false},
283 {"all", TRACK_FUNC_ALL, false},
287 static const struct config_enum_entry xmlbinary_options[] = {
288 {"base64", XMLBINARY_BASE64, false},
289 {"hex", XMLBINARY_HEX, false},
293 static const struct config_enum_entry xmloption_options[] = {
294 {"content", XMLOPTION_CONTENT, false},
295 {"document", XMLOPTION_DOCUMENT, false},
300 * Although only "on", "off", and "safe_encoding" are documented, we
301 * accept all the likely variants of "on" and "off".
303 static const struct config_enum_entry backslash_quote_options[] = {
304 {"safe_encoding", BACKSLASH_QUOTE_SAFE_ENCODING, false},
305 {"on", BACKSLASH_QUOTE_ON, false},
306 {"off", BACKSLASH_QUOTE_OFF, false},
307 {"true", BACKSLASH_QUOTE_ON, true},
308 {"false", BACKSLASH_QUOTE_OFF, true},
309 {"yes", BACKSLASH_QUOTE_ON, true},
310 {"no", BACKSLASH_QUOTE_OFF, true},
311 {"1", BACKSLASH_QUOTE_ON, true},
312 {"0", BACKSLASH_QUOTE_OFF, true},
317 * Although only "on", "off", and "partition" are documented, we
318 * accept all the likely variants of "on" and "off".
320 static const struct config_enum_entry constraint_exclusion_options[] = {
321 {"partition", CONSTRAINT_EXCLUSION_PARTITION, false},
322 {"on", CONSTRAINT_EXCLUSION_ON, false},
323 {"off", CONSTRAINT_EXCLUSION_OFF, false},
324 {"true", CONSTRAINT_EXCLUSION_ON, true},
325 {"false", CONSTRAINT_EXCLUSION_OFF, true},
326 {"yes", CONSTRAINT_EXCLUSION_ON, true},
327 {"no", CONSTRAINT_EXCLUSION_OFF, true},
328 {"1", CONSTRAINT_EXCLUSION_ON, true},
329 {"0", CONSTRAINT_EXCLUSION_OFF, true},
334 * Options for enum values stored in other modules
336 extern const struct config_enum_entry sync_method_options[];
339 * GUC option variables that are exported from this module
341 #ifdef USE_ASSERT_CHECKING
342 bool assert_enabled = true;
344 bool assert_enabled = false;
346 bool log_duration = false;
347 bool Debug_print_plan = false;
348 bool Debug_print_parse = false;
349 bool Debug_print_rewritten = false;
350 bool Debug_pretty_print = true;
352 bool log_parser_stats = false;
353 bool log_planner_stats = false;
354 bool log_executor_stats = false;
355 bool log_statement_stats = false; /* this is sort of all three
357 bool log_btree_build_stats = false;
359 bool check_function_bodies = true;
360 bool default_with_oids = false;
361 bool SQL_inheritance = true;
363 bool Password_encryption = true;
365 int log_min_error_statement = ERROR;
366 int log_min_messages = WARNING;
367 int client_min_messages = NOTICE;
368 int log_min_duration_statement = -1;
369 int log_temp_files = -1;
371 int num_temp_buffers = 1000;
373 char *ConfigFileName;
376 char *external_pid_file;
378 char *pgstat_temp_directory;
380 char *default_do_language;
382 char *application_name;
384 int tcp_keepalives_idle;
385 int tcp_keepalives_interval;
386 int tcp_keepalives_count;
389 * These variables are all dummies that don't do anything, except in some
390 * cases provide the value for SHOW to display. The real state is elsewhere
391 * and is kept in sync by assign_hooks.
393 static char *log_destination_string;
396 static char *syslog_ident_str;
398 static bool phony_autocommit;
399 static bool session_auth_is_superuser;
400 static double phony_random_seed;
401 static char *client_encoding_string;
402 static char *datestyle_string;
403 static char *locale_collate;
404 static char *locale_ctype;
405 static char *server_encoding_string;
406 static char *server_version_string;
407 static int server_version_num;
408 static char *timezone_string;
409 static char *log_timezone_string;
410 static char *timezone_abbreviations_string;
411 static char *XactIsoLevel_string;
412 static char *data_directory;
413 static char *custom_variable_classes;
414 static int max_function_args;
415 static int max_index_keys;
416 static int max_identifier_length;
417 static int block_size;
418 static int segment_size;
419 static int wal_block_size;
420 static int wal_segment_size;
421 static bool integer_datetimes;
422 static int effective_io_concurrency;
424 /* should be static, but commands/variable.c needs to get at these */
426 char *session_authorization_string;
430 * Displayable names for context types (enum GucContext)
432 * Note: these strings are deliberately not localized.
434 const char *const GucContext_Names[] =
436 /* PGC_INTERNAL */ "internal",
437 /* PGC_POSTMASTER */ "postmaster",
438 /* PGC_SIGHUP */ "sighup",
439 /* PGC_BACKEND */ "backend",
440 /* PGC_SUSET */ "superuser",
441 /* PGC_USERSET */ "user"
445 * Displayable names for source types (enum GucSource)
447 * Note: these strings are deliberately not localized.
449 const char *const GucSource_Names[] =
451 /* PGC_S_DEFAULT */ "default",
452 /* PGC_S_ENV_VAR */ "environment variable",
453 /* PGC_S_FILE */ "configuration file",
454 /* PGC_S_ARGV */ "command line",
455 /* PGC_S_DATABASE */ "database",
456 /* PGC_S_USER */ "user",
457 /* PGC_S_DATABASE_USER */ "database user",
458 /* PGC_S_CLIENT */ "client",
459 /* PGC_S_OVERRIDE */ "override",
460 /* PGC_S_INTERACTIVE */ "interactive",
461 /* PGC_S_TEST */ "test",
462 /* PGC_S_SESSION */ "session"
466 * Displayable names for the groupings defined in enum config_group
468 const char *const config_group_names[] =
471 gettext_noop("Ungrouped"),
473 gettext_noop("File Locations"),
475 gettext_noop("Connections and Authentication"),
476 /* CONN_AUTH_SETTINGS */
477 gettext_noop("Connections and Authentication / Connection Settings"),
478 /* CONN_AUTH_SECURITY */
479 gettext_noop("Connections and Authentication / Security and Authentication"),
481 gettext_noop("Resource Usage"),
483 gettext_noop("Resource Usage / Memory"),
484 /* RESOURCES_KERNEL */
485 gettext_noop("Resource Usage / Kernel Resources"),
487 gettext_noop("Write-Ahead Log"),
489 gettext_noop("Write-Ahead Log / Settings"),
490 /* WAL_CHECKPOINTS */
491 gettext_noop("Write-Ahead Log / Checkpoints"),
493 gettext_noop("Query Tuning"),
494 /* QUERY_TUNING_METHOD */
495 gettext_noop("Query Tuning / Planner Method Configuration"),
496 /* QUERY_TUNING_COST */
497 gettext_noop("Query Tuning / Planner Cost Constants"),
498 /* QUERY_TUNING_GEQO */
499 gettext_noop("Query Tuning / Genetic Query Optimizer"),
500 /* QUERY_TUNING_OTHER */
501 gettext_noop("Query Tuning / Other Planner Options"),
503 gettext_noop("Reporting and Logging"),
505 gettext_noop("Reporting and Logging / Where to Log"),
507 gettext_noop("Reporting and Logging / When to Log"),
509 gettext_noop("Reporting and Logging / What to Log"),
511 gettext_noop("Statistics"),
512 /* STATS_MONITORING */
513 gettext_noop("Statistics / Monitoring"),
514 /* STATS_COLLECTOR */
515 gettext_noop("Statistics / Query and Index Statistics Collector"),
517 gettext_noop("Autovacuum"),
519 gettext_noop("Client Connection Defaults"),
520 /* CLIENT_CONN_STATEMENT */
521 gettext_noop("Client Connection Defaults / Statement Behavior"),
522 /* CLIENT_CONN_LOCALE */
523 gettext_noop("Client Connection Defaults / Locale and Formatting"),
524 /* CLIENT_CONN_OTHER */
525 gettext_noop("Client Connection Defaults / Other Defaults"),
526 /* LOCK_MANAGEMENT */
527 gettext_noop("Lock Management"),
529 gettext_noop("Version and Platform Compatibility"),
530 /* COMPAT_OPTIONS_PREVIOUS */
531 gettext_noop("Version and Platform Compatibility / Previous PostgreSQL Versions"),
532 /* COMPAT_OPTIONS_CLIENT */
533 gettext_noop("Version and Platform Compatibility / Other Platforms and Clients"),
535 gettext_noop("Preset Options"),
537 gettext_noop("Customized Options"),
538 /* DEVELOPER_OPTIONS */
539 gettext_noop("Developer Options"),
540 /* help_config wants this array to be null-terminated */
545 * Displayable names for GUC variable types (enum config_type)
547 * Note: these strings are deliberately not localized.
549 const char *const config_type_names[] =
551 /* PGC_BOOL */ "bool",
552 /* PGC_INT */ "integer",
553 /* PGC_REAL */ "real",
554 /* PGC_STRING */ "string",
555 /* PGC_ENUM */ "enum"
560 * Contents of GUC tables
562 * See src/backend/utils/misc/README for design notes.
566 * 1. Declare a global variable of type bool, int, double, or char*
567 * and make use of it.
569 * 2. Decide at what times it's safe to set the option. See guc.h for
572 * 3. Decide on a name, a default value, upper and lower bounds (if
575 * 4. Add a record below.
577 * 5. Add it to src/backend/utils/misc/postgresql.conf.sample, if
580 * 6. Don't forget to document the option (at least in config.sgml).
582 * 7. If it's a new GUC_LIST option you must edit pg_dumpall.c to ensure
583 * it is not single quoted at dump time.
587 /******** option records follow ********/
589 static struct config_bool ConfigureNamesBool[] =
592 {"enable_seqscan", PGC_USERSET, QUERY_TUNING_METHOD,
593 gettext_noop("Enables the planner's use of sequential-scan plans."),
600 {"enable_indexscan", PGC_USERSET, QUERY_TUNING_METHOD,
601 gettext_noop("Enables the planner's use of index-scan plans."),
608 {"enable_bitmapscan", PGC_USERSET, QUERY_TUNING_METHOD,
609 gettext_noop("Enables the planner's use of bitmap-scan plans."),
616 {"enable_tidscan", PGC_USERSET, QUERY_TUNING_METHOD,
617 gettext_noop("Enables the planner's use of TID scan plans."),
624 {"enable_sort", PGC_USERSET, QUERY_TUNING_METHOD,
625 gettext_noop("Enables the planner's use of explicit sort steps."),
632 {"enable_hashagg", PGC_USERSET, QUERY_TUNING_METHOD,
633 gettext_noop("Enables the planner's use of hashed aggregation plans."),
640 {"enable_nestloop", PGC_USERSET, QUERY_TUNING_METHOD,
641 gettext_noop("Enables the planner's use of nested-loop join plans."),
648 {"enable_mergejoin", PGC_USERSET, QUERY_TUNING_METHOD,
649 gettext_noop("Enables the planner's use of merge join plans."),
656 {"enable_hashjoin", PGC_USERSET, QUERY_TUNING_METHOD,
657 gettext_noop("Enables the planner's use of hash join plans."),
664 {"geqo", PGC_USERSET, QUERY_TUNING_GEQO,
665 gettext_noop("Enables genetic query optimization."),
666 gettext_noop("This algorithm attempts to do planning without "
667 "exhaustive searching.")
673 /* Not for general use --- used by SET SESSION AUTHORIZATION */
674 {"is_superuser", PGC_INTERNAL, UNGROUPED,
675 gettext_noop("Shows whether the current user is a superuser."),
677 GUC_REPORT | GUC_NO_SHOW_ALL | GUC_NO_RESET_ALL | GUC_NOT_IN_SAMPLE | GUC_DISALLOW_IN_FILE
679 &session_auth_is_superuser,
683 {"bonjour", PGC_POSTMASTER, CONN_AUTH_SETTINGS,
684 gettext_noop("Enables advertising the server via Bonjour."),
688 false, assign_bonjour, NULL
691 {"ssl", PGC_POSTMASTER, CONN_AUTH_SECURITY,
692 gettext_noop("Enables SSL connections."),
696 false, assign_ssl, NULL
699 {"fsync", PGC_SIGHUP, WAL_SETTINGS,
700 gettext_noop("Forces synchronization of updates to disk."),
701 gettext_noop("The server will use the fsync() system call in several places to make "
702 "sure that updates are physically written to disk. This insures "
703 "that a database cluster will recover to a consistent state after "
704 "an operating system or hardware crash.")
710 {"synchronous_commit", PGC_USERSET, WAL_SETTINGS,
711 gettext_noop("Sets immediate fsync at commit."),
718 {"zero_damaged_pages", PGC_SUSET, DEVELOPER_OPTIONS,
719 gettext_noop("Continues processing past damaged page headers."),
720 gettext_noop("Detection of a damaged page header normally causes PostgreSQL to "
721 "report an error, aborting the current transaction. Setting "
722 "zero_damaged_pages to true causes the system to instead report a "
723 "warning, zero out the damaged page, and continue processing. This "
724 "behavior will destroy data, namely all the rows on the damaged page."),
731 {"full_page_writes", PGC_SIGHUP, WAL_SETTINGS,
732 gettext_noop("Writes full pages to WAL when first modified after a checkpoint."),
733 gettext_noop("A page write in process during an operating system crash might be "
734 "only partially written to disk. During recovery, the row changes "
735 "stored in WAL are not enough to recover. This option writes "
736 "pages when first modified after a checkpoint to WAL so full recovery "
743 {"silent_mode", PGC_POSTMASTER, LOGGING_WHERE,
744 gettext_noop("Runs the server silently."),
745 gettext_noop("If this parameter is set, the server will automatically run in the "
746 "background and any controlling terminals are dissociated.")
752 {"log_checkpoints", PGC_SIGHUP, LOGGING_WHAT,
753 gettext_noop("Logs each checkpoint."),
760 {"log_connections", PGC_BACKEND, LOGGING_WHAT,
761 gettext_noop("Logs each successful connection."),
768 {"log_disconnections", PGC_BACKEND, LOGGING_WHAT,
769 gettext_noop("Logs end of a session, including duration."),
776 {"debug_assertions", PGC_USERSET, DEVELOPER_OPTIONS,
777 gettext_noop("Turns on various assertion checks."),
778 gettext_noop("This is a debugging aid."),
782 #ifdef USE_ASSERT_CHECKING
787 assign_debug_assertions, NULL
790 /* currently undocumented, so don't show in SHOW ALL */
791 {"exit_on_error", PGC_USERSET, UNGROUPED,
792 gettext_noop("No description available."),
794 GUC_NO_SHOW_ALL | GUC_NOT_IN_SAMPLE
800 {"log_duration", PGC_SUSET, LOGGING_WHAT,
801 gettext_noop("Logs the duration of each completed SQL statement."),
808 {"debug_print_parse", PGC_USERSET, LOGGING_WHAT,
809 gettext_noop("Logs each query's parse tree."),
816 {"debug_print_rewritten", PGC_USERSET, LOGGING_WHAT,
817 gettext_noop("Logs each query's rewritten parse tree."),
820 &Debug_print_rewritten,
824 {"debug_print_plan", PGC_USERSET, LOGGING_WHAT,
825 gettext_noop("Logs each query's execution plan."),
832 {"debug_pretty_print", PGC_USERSET, LOGGING_WHAT,
833 gettext_noop("Indents parse and plan tree displays."),
840 {"log_parser_stats", PGC_SUSET, STATS_MONITORING,
841 gettext_noop("Writes parser performance statistics to the server log."),
845 false, assign_stage_log_stats, NULL
848 {"log_planner_stats", PGC_SUSET, STATS_MONITORING,
849 gettext_noop("Writes planner performance statistics to the server log."),
853 false, assign_stage_log_stats, NULL
856 {"log_executor_stats", PGC_SUSET, STATS_MONITORING,
857 gettext_noop("Writes executor performance statistics to the server log."),
861 false, assign_stage_log_stats, NULL
864 {"log_statement_stats", PGC_SUSET, STATS_MONITORING,
865 gettext_noop("Writes cumulative performance statistics to the server log."),
868 &log_statement_stats,
869 false, assign_log_stats, NULL
871 #ifdef BTREE_BUILD_STATS
873 {"log_btree_build_stats", PGC_SUSET, DEVELOPER_OPTIONS,
874 gettext_noop("No description available."),
878 &log_btree_build_stats,
884 {"track_activities", PGC_SUSET, STATS_COLLECTOR,
885 gettext_noop("Collects information about executing commands."),
886 gettext_noop("Enables the collection of information on the currently "
887 "executing command of each session, along with "
888 "the time at which that command began execution.")
890 &pgstat_track_activities,
894 {"track_counts", PGC_SUSET, STATS_COLLECTOR,
895 gettext_noop("Collects statistics on database activity."),
898 &pgstat_track_counts,
903 {"update_process_title", PGC_SUSET, STATS_COLLECTOR,
904 gettext_noop("Updates the process title to show the active SQL command."),
905 gettext_noop("Enables updating of the process title every time a new SQL command is received by the server.")
907 &update_process_title,
912 {"autovacuum", PGC_SIGHUP, AUTOVACUUM,
913 gettext_noop("Starts the autovacuum subprocess."),
916 &autovacuum_start_daemon,
921 {"trace_notify", PGC_USERSET, DEVELOPER_OPTIONS,
922 gettext_noop("Generates debugging output for LISTEN and NOTIFY."),
932 {"trace_locks", PGC_SUSET, DEVELOPER_OPTIONS,
933 gettext_noop("No description available."),
941 {"trace_userlocks", PGC_SUSET, DEVELOPER_OPTIONS,
942 gettext_noop("No description available."),
950 {"trace_lwlocks", PGC_SUSET, DEVELOPER_OPTIONS,
951 gettext_noop("No description available."),
959 {"debug_deadlocks", PGC_SUSET, DEVELOPER_OPTIONS,
960 gettext_noop("No description available."),
970 {"log_lock_waits", PGC_SUSET, LOGGING_WHAT,
971 gettext_noop("Logs long lock waits."),
979 {"log_hostname", PGC_SIGHUP, LOGGING_WHAT,
980 gettext_noop("Logs the host name in the connection logs."),
981 gettext_noop("By default, connection logs only show the IP address "
982 "of the connecting host. If you want them to show the host name you "
983 "can turn this on, but depending on your host name resolution "
984 "setup it might impose a non-negligible performance penalty.")
990 {"sql_inheritance", PGC_USERSET, COMPAT_OPTIONS_PREVIOUS,
991 gettext_noop("Causes subtables to be included by default in various commands."),
998 {"password_encryption", PGC_USERSET, CONN_AUTH_SECURITY,
999 gettext_noop("Encrypt passwords."),
1000 gettext_noop("When a password is specified in CREATE USER or "
1001 "ALTER USER without writing either ENCRYPTED or UNENCRYPTED, "
1002 "this parameter determines whether the password is to be encrypted.")
1004 &Password_encryption,
1008 {"transform_null_equals", PGC_USERSET, COMPAT_OPTIONS_CLIENT,
1009 gettext_noop("Treats \"expr=NULL\" as \"expr IS NULL\"."),
1010 gettext_noop("When turned on, expressions of the form expr = NULL "
1011 "(or NULL = expr) are treated as expr IS NULL, that is, they "
1012 "return true if expr evaluates to the null value, and false "
1013 "otherwise. The correct behavior of expr = NULL is to always "
1014 "return null (unknown).")
1016 &Transform_null_equals,
1020 {"db_user_namespace", PGC_SIGHUP, CONN_AUTH_SECURITY,
1021 gettext_noop("Enables per-database user names."),
1028 /* only here for backwards compatibility */
1029 {"autocommit", PGC_USERSET, CLIENT_CONN_STATEMENT,
1030 gettext_noop("This parameter doesn't do anything."),
1031 gettext_noop("It's just here so that we won't choke on SET AUTOCOMMIT TO ON from 7.3-vintage clients."),
1032 GUC_NO_SHOW_ALL | GUC_NOT_IN_SAMPLE
1035 true, assign_phony_autocommit, NULL
1038 {"default_transaction_read_only", PGC_USERSET, CLIENT_CONN_STATEMENT,
1039 gettext_noop("Sets the default read-only status of new transactions."),
1042 &DefaultXactReadOnly,
1046 {"transaction_read_only", PGC_USERSET, CLIENT_CONN_STATEMENT,
1047 gettext_noop("Sets the current transaction's read-only status."),
1049 GUC_NO_RESET_ALL | GUC_NOT_IN_SAMPLE | GUC_DISALLOW_IN_FILE
1052 false, assign_transaction_read_only, NULL
1055 {"check_function_bodies", PGC_USERSET, CLIENT_CONN_STATEMENT,
1056 gettext_noop("Check function bodies during CREATE FUNCTION."),
1059 &check_function_bodies,
1063 {"array_nulls", PGC_USERSET, COMPAT_OPTIONS_PREVIOUS,
1064 gettext_noop("Enable input of NULL elements in arrays."),
1065 gettext_noop("When turned on, unquoted NULL in an array input "
1066 "value means a null value; "
1067 "otherwise it is taken literally.")
1073 {"default_with_oids", PGC_USERSET, COMPAT_OPTIONS_PREVIOUS,
1074 gettext_noop("Create new tables with OIDs by default."),
1081 {"logging_collector", PGC_POSTMASTER, LOGGING_WHERE,
1082 gettext_noop("Start a subprocess to capture stderr output and/or csvlogs into log files."),
1089 {"log_truncate_on_rotation", PGC_SIGHUP, LOGGING_WHERE,
1090 gettext_noop("Truncate existing log files of same name during log rotation."),
1093 &Log_truncate_on_rotation,
1099 {"trace_sort", PGC_USERSET, DEVELOPER_OPTIONS,
1100 gettext_noop("Emit information about resource usage in sorting."),
1109 #ifdef TRACE_SYNCSCAN
1110 /* this is undocumented because not exposed in a standard build */
1112 {"trace_syncscan", PGC_USERSET, DEVELOPER_OPTIONS,
1113 gettext_noop("Generate debugging output for synchronized scanning."),
1122 #ifdef DEBUG_BOUNDED_SORT
1123 /* this is undocumented because not exposed in a standard build */
1126 "optimize_bounded_sort", PGC_USERSET, QUERY_TUNING_METHOD,
1127 gettext_noop("Enable bounded sorting using heap sort."),
1131 &optimize_bounded_sort,
1138 {"wal_debug", PGC_SUSET, DEVELOPER_OPTIONS,
1139 gettext_noop("Emit WAL-related debugging output."),
1149 {"integer_datetimes", PGC_INTERNAL, PRESET_OPTIONS,
1150 gettext_noop("Datetimes are integer based."),
1152 GUC_REPORT | GUC_NOT_IN_SAMPLE | GUC_DISALLOW_IN_FILE
1155 #ifdef HAVE_INT64_TIMESTAMP
1163 {"krb_caseins_users", PGC_SIGHUP, CONN_AUTH_SECURITY,
1164 gettext_noop("Sets whether Kerberos and GSSAPI user names should be treated as case-insensitive."),
1167 &pg_krb_caseins_users,
1172 {"escape_string_warning", PGC_USERSET, COMPAT_OPTIONS_PREVIOUS,
1173 gettext_noop("Warn about backslash escapes in ordinary string literals."),
1176 &escape_string_warning,
1181 {"standard_conforming_strings", PGC_USERSET, COMPAT_OPTIONS_PREVIOUS,
1182 gettext_noop("Causes '...' strings to treat backslashes literally."),
1186 &standard_conforming_strings,
1191 {"synchronize_seqscans", PGC_USERSET, COMPAT_OPTIONS_PREVIOUS,
1192 gettext_noop("Enable synchronized sequential scans."),
1195 &synchronize_seqscans,
1200 {"archive_mode", PGC_POSTMASTER, WAL_SETTINGS,
1201 gettext_noop("Allows archiving of WAL files using archive_command."),
1209 {"allow_system_table_mods", PGC_POSTMASTER, DEVELOPER_OPTIONS,
1210 gettext_noop("Allows modifications of the structure of system tables."),
1214 &allowSystemTableMods,
1219 {"ignore_system_indexes", PGC_BACKEND, DEVELOPER_OPTIONS,
1220 gettext_noop("Disables reading from system indexes."),
1221 gettext_noop("It does not prevent updating the indexes, so it is safe "
1222 "to use. The worst consequence is slowness."),
1225 &IgnoreSystemIndexes,
1229 /* End-of-list marker */
1231 {NULL, 0, 0, NULL, NULL}, NULL, false, NULL, NULL
1236 static struct config_int ConfigureNamesInt[] =
1239 {"archive_timeout", PGC_SIGHUP, WAL_SETTINGS,
1240 gettext_noop("Forces a switch to the next xlog file if a "
1241 "new file has not been started within N seconds."),
1245 &XLogArchiveTimeout,
1246 0, 0, INT_MAX, NULL, NULL
1249 {"post_auth_delay", PGC_BACKEND, DEVELOPER_OPTIONS,
1250 gettext_noop("Waits N seconds on connection startup after authentication."),
1251 gettext_noop("This allows attaching a debugger to the process."),
1252 GUC_NOT_IN_SAMPLE | GUC_UNIT_S
1255 0, 0, INT_MAX, NULL, NULL
1258 {"default_statistics_target", PGC_USERSET, QUERY_TUNING_OTHER,
1259 gettext_noop("Sets the default statistics target."),
1260 gettext_noop("This applies to table columns that have not had a "
1261 "column-specific target set via ALTER TABLE SET STATISTICS.")
1263 &default_statistics_target,
1264 100, 1, 10000, NULL, NULL
1267 {"from_collapse_limit", PGC_USERSET, QUERY_TUNING_OTHER,
1268 gettext_noop("Sets the FROM-list size beyond which subqueries "
1269 "are not collapsed."),
1270 gettext_noop("The planner will merge subqueries into upper "
1271 "queries if the resulting FROM list would have no more than "
1274 &from_collapse_limit,
1275 8, 1, INT_MAX, NULL, NULL
1278 {"join_collapse_limit", PGC_USERSET, QUERY_TUNING_OTHER,
1279 gettext_noop("Sets the FROM-list size beyond which JOIN "
1280 "constructs are not flattened."),
1281 gettext_noop("The planner will flatten explicit JOIN "
1282 "constructs into lists of FROM items whenever a "
1283 "list of no more than this many items would result.")
1285 &join_collapse_limit,
1286 8, 1, INT_MAX, NULL, NULL
1289 {"geqo_threshold", PGC_USERSET, QUERY_TUNING_GEQO,
1290 gettext_noop("Sets the threshold of FROM items beyond which GEQO is used."),
1294 12, 2, INT_MAX, NULL, NULL
1297 {"geqo_effort", PGC_USERSET, QUERY_TUNING_GEQO,
1298 gettext_noop("GEQO: effort is used to set the default for other GEQO parameters."),
1302 DEFAULT_GEQO_EFFORT, MIN_GEQO_EFFORT, MAX_GEQO_EFFORT, NULL, NULL
1305 {"geqo_pool_size", PGC_USERSET, QUERY_TUNING_GEQO,
1306 gettext_noop("GEQO: number of individuals in the population."),
1307 gettext_noop("Zero selects a suitable default value.")
1310 0, 0, INT_MAX, NULL, NULL
1313 {"geqo_generations", PGC_USERSET, QUERY_TUNING_GEQO,
1314 gettext_noop("GEQO: number of iterations of the algorithm."),
1315 gettext_noop("Zero selects a suitable default value.")
1318 0, 0, INT_MAX, NULL, NULL
1322 /* This is PGC_SIGHUP so all backends have the same value. */
1323 {"deadlock_timeout", PGC_SIGHUP, LOCK_MANAGEMENT,
1324 gettext_noop("Sets the time to wait on a lock before checking for deadlock."),
1329 1000, 1, INT_MAX / 1000, NULL, NULL
1333 * Note: MaxBackends is limited to INT_MAX/4 because some places compute
1334 * 4*MaxBackends without any overflow check. This check is made in
1335 * assign_maxconnections, since MaxBackends is computed as MaxConnections
1336 * plus autovacuum_max_workers plus one (for the autovacuum launcher).
1338 * Likewise we have to limit NBuffers to INT_MAX/2.
1341 {"max_connections", PGC_POSTMASTER, CONN_AUTH_SETTINGS,
1342 gettext_noop("Sets the maximum number of concurrent connections."),
1346 100, 1, INT_MAX / 4, assign_maxconnections, NULL
1350 {"superuser_reserved_connections", PGC_POSTMASTER, CONN_AUTH_SETTINGS,
1351 gettext_noop("Sets the number of connection slots reserved for superusers."),
1355 3, 0, INT_MAX / 4, NULL, NULL
1359 {"shared_buffers", PGC_POSTMASTER, RESOURCES_MEM,
1360 gettext_noop("Sets the number of shared memory buffers used by the server."),
1365 1024, 16, INT_MAX / 2, NULL, NULL
1369 {"temp_buffers", PGC_USERSET, RESOURCES_MEM,
1370 gettext_noop("Sets the maximum number of temporary buffers used by each session."),
1375 1024, 100, INT_MAX / 2, NULL, show_num_temp_buffers
1379 {"port", PGC_POSTMASTER, CONN_AUTH_SETTINGS,
1380 gettext_noop("Sets the TCP port the server listens on."),
1384 DEF_PGPORT, 1, 65535, NULL, NULL
1388 {"unix_socket_permissions", PGC_POSTMASTER, CONN_AUTH_SETTINGS,
1389 gettext_noop("Sets the access permissions of the Unix-domain socket."),
1390 gettext_noop("Unix-domain sockets use the usual Unix file system "
1391 "permission set. The parameter value is expected to be a numeric mode "
1392 "specification in the form accepted by the chmod and umask system "
1393 "calls. (To use the customary octal format the number must start with "
1396 &Unix_socket_permissions,
1397 0777, 0000, 0777, NULL, NULL
1401 {"work_mem", PGC_USERSET, RESOURCES_MEM,
1402 gettext_noop("Sets the maximum memory to be used for query workspaces."),
1403 gettext_noop("This much memory can be used by each internal "
1404 "sort operation and hash table before switching to "
1405 "temporary disk files."),
1409 1024, 64, MAX_KILOBYTES, NULL, NULL
1413 {"maintenance_work_mem", PGC_USERSET, RESOURCES_MEM,
1414 gettext_noop("Sets the maximum memory to be used for maintenance operations."),
1415 gettext_noop("This includes operations such as VACUUM and CREATE INDEX."),
1418 &maintenance_work_mem,
1419 16384, 1024, MAX_KILOBYTES, NULL, NULL
1423 {"max_stack_depth", PGC_SUSET, RESOURCES_MEM,
1424 gettext_noop("Sets the maximum stack depth, in kilobytes."),
1429 100, 100, MAX_KILOBYTES, assign_max_stack_depth, NULL
1433 {"vacuum_cost_page_hit", PGC_USERSET, RESOURCES,
1434 gettext_noop("Vacuum cost for a page found in the buffer cache."),
1438 1, 0, 10000, NULL, NULL
1442 {"vacuum_cost_page_miss", PGC_USERSET, RESOURCES,
1443 gettext_noop("Vacuum cost for a page not found in the buffer cache."),
1446 &VacuumCostPageMiss,
1447 10, 0, 10000, NULL, NULL
1451 {"vacuum_cost_page_dirty", PGC_USERSET, RESOURCES,
1452 gettext_noop("Vacuum cost for a page dirtied by vacuum."),
1455 &VacuumCostPageDirty,
1456 20, 0, 10000, NULL, NULL
1460 {"vacuum_cost_limit", PGC_USERSET, RESOURCES,
1461 gettext_noop("Vacuum cost amount available before napping."),
1465 200, 1, 10000, NULL, NULL
1469 {"vacuum_cost_delay", PGC_USERSET, RESOURCES,
1470 gettext_noop("Vacuum cost delay in milliseconds."),
1475 0, 0, 100, NULL, NULL
1479 {"autovacuum_vacuum_cost_delay", PGC_SIGHUP, AUTOVACUUM,
1480 gettext_noop("Vacuum cost delay in milliseconds, for autovacuum."),
1484 &autovacuum_vac_cost_delay,
1485 20, -1, 100, NULL, NULL
1489 {"autovacuum_vacuum_cost_limit", PGC_SIGHUP, AUTOVACUUM,
1490 gettext_noop("Vacuum cost amount available before napping, for autovacuum."),
1493 &autovacuum_vac_cost_limit,
1494 -1, -1, 10000, NULL, NULL
1498 {"max_files_per_process", PGC_POSTMASTER, RESOURCES_KERNEL,
1499 gettext_noop("Sets the maximum number of simultaneously open files for each server process."),
1502 &max_files_per_process,
1503 1000, 25, INT_MAX, NULL, NULL
1507 {"max_prepared_transactions", PGC_POSTMASTER, RESOURCES,
1508 gettext_noop("Sets the maximum number of simultaneously prepared transactions."),
1511 &max_prepared_xacts,
1512 0, 0, INT_MAX / 4, NULL, NULL
1517 {"trace_lock_oidmin", PGC_SUSET, DEVELOPER_OPTIONS,
1518 gettext_noop("No description available."),
1523 FirstNormalObjectId, 0, INT_MAX, NULL, NULL
1526 {"trace_lock_table", PGC_SUSET, DEVELOPER_OPTIONS,
1527 gettext_noop("No description available."),
1532 0, 0, INT_MAX, NULL, NULL
1537 {"statement_timeout", PGC_USERSET, CLIENT_CONN_STATEMENT,
1538 gettext_noop("Sets the maximum allowed duration of any statement."),
1539 gettext_noop("A value of 0 turns off the timeout."),
1543 0, 0, INT_MAX, NULL, NULL
1547 {"vacuum_freeze_min_age", PGC_USERSET, CLIENT_CONN_STATEMENT,
1548 gettext_noop("Minimum age at which VACUUM should freeze a table row."),
1551 &vacuum_freeze_min_age,
1552 50000000, 0, 1000000000, NULL, NULL
1556 {"vacuum_freeze_table_age", PGC_USERSET, CLIENT_CONN_STATEMENT,
1557 gettext_noop("Age at which VACUUM should scan whole table to freeze tuples."),
1560 &vacuum_freeze_table_age,
1561 150000000, 0, 2000000000, NULL, NULL
1565 {"max_locks_per_transaction", PGC_POSTMASTER, LOCK_MANAGEMENT,
1566 gettext_noop("Sets the maximum number of locks per transaction."),
1567 gettext_noop("The shared lock table is sized on the assumption that "
1568 "at most max_locks_per_transaction * max_connections distinct "
1569 "objects will need to be locked at any one time.")
1571 &max_locks_per_xact,
1572 64, 10, INT_MAX, NULL, NULL
1576 {"authentication_timeout", PGC_SIGHUP, CONN_AUTH_SECURITY,
1577 gettext_noop("Sets the maximum allowed time to complete client authentication."),
1581 &AuthenticationTimeout,
1582 60, 1, 600, NULL, NULL
1586 /* Not for general use */
1587 {"pre_auth_delay", PGC_SIGHUP, DEVELOPER_OPTIONS,
1588 gettext_noop("Waits N seconds on connection startup before authentication."),
1589 gettext_noop("This allows attaching a debugger to the process."),
1590 GUC_NOT_IN_SAMPLE | GUC_UNIT_S
1593 0, 0, 60, NULL, NULL
1597 {"checkpoint_segments", PGC_SIGHUP, WAL_CHECKPOINTS,
1598 gettext_noop("Sets the maximum distance in log segments between automatic WAL checkpoints."),
1601 &CheckPointSegments,
1602 3, 1, INT_MAX, NULL, NULL
1606 {"checkpoint_timeout", PGC_SIGHUP, WAL_CHECKPOINTS,
1607 gettext_noop("Sets the maximum time between automatic WAL checkpoints."),
1612 300, 30, 3600, NULL, NULL
1616 {"checkpoint_warning", PGC_SIGHUP, WAL_CHECKPOINTS,
1617 gettext_noop("Enables warnings if checkpoint segments are filled more "
1618 "frequently than this."),
1619 gettext_noop("Write a message to the server log if checkpoints "
1620 "caused by the filling of checkpoint segment files happens more "
1621 "frequently than this number of seconds. Zero turns off the warning."),
1625 30, 0, INT_MAX, NULL, NULL
1629 {"wal_buffers", PGC_POSTMASTER, WAL_SETTINGS,
1630 gettext_noop("Sets the number of disk-page buffers in shared memory for WAL."),
1635 8, 4, INT_MAX, NULL, NULL
1639 {"wal_writer_delay", PGC_SIGHUP, WAL_SETTINGS,
1640 gettext_noop("WAL writer sleep time between WAL flushes."),
1645 200, 1, 10000, NULL, NULL
1649 {"commit_delay", PGC_USERSET, WAL_SETTINGS,
1650 gettext_noop("Sets the delay in microseconds between transaction commit and "
1651 "flushing WAL to disk."),
1655 0, 0, 100000, NULL, NULL
1659 {"commit_siblings", PGC_USERSET, WAL_SETTINGS,
1660 gettext_noop("Sets the minimum concurrent open transactions before performing "
1665 5, 1, 1000, NULL, NULL
1669 {"extra_float_digits", PGC_USERSET, CLIENT_CONN_LOCALE,
1670 gettext_noop("Sets the number of digits displayed for floating-point values."),
1671 gettext_noop("This affects real, double precision, and geometric data types. "
1672 "The parameter value is added to the standard number of digits "
1673 "(FLT_DIG or DBL_DIG as appropriate).")
1675 &extra_float_digits,
1676 0, -15, 3, NULL, NULL
1680 {"log_min_duration_statement", PGC_SUSET, LOGGING_WHEN,
1681 gettext_noop("Sets the minimum execution time above which "
1682 "statements will be logged."),
1683 gettext_noop("Zero prints all queries. -1 turns this feature off."),
1686 &log_min_duration_statement,
1687 -1, -1, INT_MAX / 1000, NULL, NULL
1691 {"log_autovacuum_min_duration", PGC_SIGHUP, LOGGING_WHAT,
1692 gettext_noop("Sets the minimum execution time above which "
1693 "autovacuum actions will be logged."),
1694 gettext_noop("Zero prints all actions. -1 turns autovacuum logging off."),
1697 &Log_autovacuum_min_duration,
1698 -1, -1, INT_MAX / 1000, NULL, NULL
1702 {"bgwriter_delay", PGC_SIGHUP, RESOURCES,
1703 gettext_noop("Background writer sleep time between rounds."),
1708 200, 10, 10000, NULL, NULL
1712 {"bgwriter_lru_maxpages", PGC_SIGHUP, RESOURCES,
1713 gettext_noop("Background writer maximum number of LRU pages to flush per round."),
1716 &bgwriter_lru_maxpages,
1717 100, 0, 1000, NULL, NULL
1721 {"effective_io_concurrency",
1728 gettext_noop("Number of simultaneous requests that can be handled efficiently by the disk subsystem."),
1729 gettext_noop("For RAID arrays, this should be approximately the number of drive spindles in the array.")
1731 &effective_io_concurrency,
1737 assign_effective_io_concurrency, NULL
1741 {"log_rotation_age", PGC_SIGHUP, LOGGING_WHERE,
1742 gettext_noop("Automatic log file rotation will occur after N minutes."),
1747 HOURS_PER_DAY * MINS_PER_HOUR, 0, INT_MAX / MINS_PER_HOUR, NULL, NULL
1751 {"log_rotation_size", PGC_SIGHUP, LOGGING_WHERE,
1752 gettext_noop("Automatic log file rotation will occur after N kilobytes."),
1757 10 * 1024, 0, INT_MAX / 1024, NULL, NULL
1761 {"max_function_args", PGC_INTERNAL, PRESET_OPTIONS,
1762 gettext_noop("Shows the maximum number of function arguments."),
1764 GUC_NOT_IN_SAMPLE | GUC_DISALLOW_IN_FILE
1767 FUNC_MAX_ARGS, FUNC_MAX_ARGS, FUNC_MAX_ARGS, NULL, NULL
1771 {"max_index_keys", PGC_INTERNAL, PRESET_OPTIONS,
1772 gettext_noop("Shows the maximum number of index keys."),
1774 GUC_NOT_IN_SAMPLE | GUC_DISALLOW_IN_FILE
1777 INDEX_MAX_KEYS, INDEX_MAX_KEYS, INDEX_MAX_KEYS, NULL, NULL
1781 {"max_identifier_length", PGC_INTERNAL, PRESET_OPTIONS,
1782 gettext_noop("Shows the maximum identifier length."),
1784 GUC_NOT_IN_SAMPLE | GUC_DISALLOW_IN_FILE
1786 &max_identifier_length,
1787 NAMEDATALEN - 1, NAMEDATALEN - 1, NAMEDATALEN - 1, NULL, NULL
1791 {"block_size", PGC_INTERNAL, PRESET_OPTIONS,
1792 gettext_noop("Shows the size of a disk block."),
1794 GUC_NOT_IN_SAMPLE | GUC_DISALLOW_IN_FILE
1797 BLCKSZ, BLCKSZ, BLCKSZ, NULL, NULL
1801 {"segment_size", PGC_INTERNAL, PRESET_OPTIONS,
1802 gettext_noop("Shows the number of pages per disk file."),
1804 GUC_UNIT_BLOCKS | GUC_NOT_IN_SAMPLE | GUC_DISALLOW_IN_FILE
1807 RELSEG_SIZE, RELSEG_SIZE, RELSEG_SIZE, NULL, NULL
1811 {"wal_block_size", PGC_INTERNAL, PRESET_OPTIONS,
1812 gettext_noop("Shows the block size in the write ahead log."),
1814 GUC_NOT_IN_SAMPLE | GUC_DISALLOW_IN_FILE
1817 XLOG_BLCKSZ, XLOG_BLCKSZ, XLOG_BLCKSZ, NULL, NULL
1821 {"wal_segment_size", PGC_INTERNAL, PRESET_OPTIONS,
1822 gettext_noop("Shows the number of pages per write ahead log segment."),
1824 GUC_UNIT_XBLOCKS | GUC_NOT_IN_SAMPLE | GUC_DISALLOW_IN_FILE
1827 (XLOG_SEG_SIZE / XLOG_BLCKSZ),
1828 (XLOG_SEG_SIZE / XLOG_BLCKSZ),
1829 (XLOG_SEG_SIZE / XLOG_BLCKSZ),
1834 {"autovacuum_naptime", PGC_SIGHUP, AUTOVACUUM,
1835 gettext_noop("Time to sleep between autovacuum runs."),
1839 &autovacuum_naptime,
1840 60, 1, INT_MAX / 1000, NULL, NULL
1843 {"autovacuum_vacuum_threshold", PGC_SIGHUP, AUTOVACUUM,
1844 gettext_noop("Minimum number of tuple updates or deletes prior to vacuum."),
1847 &autovacuum_vac_thresh,
1848 50, 0, INT_MAX, NULL, NULL
1851 {"autovacuum_analyze_threshold", PGC_SIGHUP, AUTOVACUUM,
1852 gettext_noop("Minimum number of tuple inserts, updates or deletes prior to analyze."),
1855 &autovacuum_anl_thresh,
1856 50, 0, INT_MAX, NULL, NULL
1859 /* see varsup.c for why this is PGC_POSTMASTER not PGC_SIGHUP */
1860 {"autovacuum_freeze_max_age", PGC_POSTMASTER, AUTOVACUUM,
1861 gettext_noop("Age at which to autovacuum a table to prevent transaction ID wraparound."),
1864 &autovacuum_freeze_max_age,
1865 /* see pg_resetxlog if you change the upper-limit value */
1866 200000000, 100000000, 2000000000, NULL, NULL
1869 /* see max_connections */
1870 {"autovacuum_max_workers", PGC_POSTMASTER, AUTOVACUUM,
1871 gettext_noop("Sets the maximum number of simultaneously running autovacuum worker processes."),
1874 &autovacuum_max_workers,
1875 3, 1, INT_MAX / 4, assign_autovacuum_max_workers, NULL
1879 {"tcp_keepalives_idle", PGC_USERSET, CLIENT_CONN_OTHER,
1880 gettext_noop("Time between issuing TCP keepalives."),
1881 gettext_noop("A value of 0 uses the system default."),
1884 &tcp_keepalives_idle,
1885 0, 0, INT_MAX, assign_tcp_keepalives_idle, show_tcp_keepalives_idle
1889 {"tcp_keepalives_interval", PGC_USERSET, CLIENT_CONN_OTHER,
1890 gettext_noop("Time between TCP keepalive retransmits."),
1891 gettext_noop("A value of 0 uses the system default."),
1894 &tcp_keepalives_interval,
1895 0, 0, INT_MAX, assign_tcp_keepalives_interval, show_tcp_keepalives_interval
1899 {"tcp_keepalives_count", PGC_USERSET, CLIENT_CONN_OTHER,
1900 gettext_noop("Maximum number of TCP keepalive retransmits."),
1901 gettext_noop("This controls the number of consecutive keepalive retransmits that can be "
1902 "lost before a connection is considered dead. A value of 0 uses the "
1905 &tcp_keepalives_count,
1906 0, 0, INT_MAX, assign_tcp_keepalives_count, show_tcp_keepalives_count
1910 {"gin_fuzzy_search_limit", PGC_USERSET, CLIENT_CONN_OTHER,
1911 gettext_noop("Sets the maximum allowed result for exact search by GIN."),
1915 &GinFuzzySearchLimit,
1916 0, 0, INT_MAX, NULL, NULL
1920 {"effective_cache_size", PGC_USERSET, QUERY_TUNING_COST,
1921 gettext_noop("Sets the planner's assumption about the size of the disk cache."),
1922 gettext_noop("That is, the portion of the kernel's disk cache that "
1923 "will be used for PostgreSQL data files. This is measured in disk "
1924 "pages, which are normally 8 kB each."),
1927 &effective_cache_size,
1928 DEFAULT_EFFECTIVE_CACHE_SIZE, 1, INT_MAX, NULL, NULL
1932 /* Can't be set in postgresql.conf */
1933 {"server_version_num", PGC_INTERNAL, PRESET_OPTIONS,
1934 gettext_noop("Shows the server version as an integer."),
1936 GUC_NOT_IN_SAMPLE | GUC_DISALLOW_IN_FILE
1938 &server_version_num,
1939 PG_VERSION_NUM, PG_VERSION_NUM, PG_VERSION_NUM, NULL, NULL
1943 {"log_temp_files", PGC_SUSET, LOGGING_WHAT,
1944 gettext_noop("Log the use of temporary files larger than this number of kilobytes."),
1945 gettext_noop("Zero logs all files. The default is -1 (turning this feature off)."),
1949 -1, -1, INT_MAX, NULL, NULL
1953 {"track_activity_query_size", PGC_POSTMASTER, RESOURCES_MEM,
1954 gettext_noop("Sets the size reserved for pg_stat_activity.current_query, in bytes."),
1957 &pgstat_track_activity_query_size,
1958 1024, 100, 102400, NULL, NULL
1961 /* End-of-list marker */
1963 {NULL, 0, 0, NULL, NULL}, NULL, 0, 0, 0, NULL, NULL
1968 static struct config_real ConfigureNamesReal[] =
1971 {"seq_page_cost", PGC_USERSET, QUERY_TUNING_COST,
1972 gettext_noop("Sets the planner's estimate of the cost of a "
1973 "sequentially fetched disk page."),
1977 DEFAULT_SEQ_PAGE_COST, 0, DBL_MAX, NULL, NULL
1980 {"random_page_cost", PGC_USERSET, QUERY_TUNING_COST,
1981 gettext_noop("Sets the planner's estimate of the cost of a "
1982 "nonsequentially fetched disk page."),
1986 DEFAULT_RANDOM_PAGE_COST, 0, DBL_MAX, NULL, NULL
1989 {"cpu_tuple_cost", PGC_USERSET, QUERY_TUNING_COST,
1990 gettext_noop("Sets the planner's estimate of the cost of "
1991 "processing each tuple (row)."),
1995 DEFAULT_CPU_TUPLE_COST, 0, DBL_MAX, NULL, NULL
1998 {"cpu_index_tuple_cost", PGC_USERSET, QUERY_TUNING_COST,
1999 gettext_noop("Sets the planner's estimate of the cost of "
2000 "processing each index entry during an index scan."),
2003 &cpu_index_tuple_cost,
2004 DEFAULT_CPU_INDEX_TUPLE_COST, 0, DBL_MAX, NULL, NULL
2007 {"cpu_operator_cost", PGC_USERSET, QUERY_TUNING_COST,
2008 gettext_noop("Sets the planner's estimate of the cost of "
2009 "processing each operator or function call."),
2013 DEFAULT_CPU_OPERATOR_COST, 0, DBL_MAX, NULL, NULL
2017 {"cursor_tuple_fraction", PGC_USERSET, QUERY_TUNING_OTHER,
2018 gettext_noop("Sets the planner's estimate of the fraction of "
2019 "a cursor's rows that will be retrieved."),
2022 &cursor_tuple_fraction,
2023 DEFAULT_CURSOR_TUPLE_FRACTION, 0.0, 1.0, NULL, NULL
2027 {"geqo_selection_bias", PGC_USERSET, QUERY_TUNING_GEQO,
2028 gettext_noop("GEQO: selective pressure within the population."),
2031 &Geqo_selection_bias,
2032 DEFAULT_GEQO_SELECTION_BIAS, MIN_GEQO_SELECTION_BIAS,
2033 MAX_GEQO_SELECTION_BIAS, NULL, NULL
2036 {"geqo_seed", PGC_USERSET, QUERY_TUNING_GEQO,
2037 gettext_noop("GEQO: seed for random path selection."),
2041 0.0, 0.0, 1.0, NULL, NULL
2045 {"bgwriter_lru_multiplier", PGC_SIGHUP, RESOURCES,
2046 gettext_noop("Multiple of the average buffer usage to free per round."),
2049 &bgwriter_lru_multiplier,
2050 2.0, 0.0, 10.0, NULL, NULL
2054 {"seed", PGC_USERSET, UNGROUPED,
2055 gettext_noop("Sets the seed for random-number generation."),
2057 GUC_NO_SHOW_ALL | GUC_NO_RESET_ALL | GUC_NOT_IN_SAMPLE | GUC_DISALLOW_IN_FILE
2060 0.0, -1.0, 1.0, assign_random_seed, show_random_seed
2064 {"autovacuum_vacuum_scale_factor", PGC_SIGHUP, AUTOVACUUM,
2065 gettext_noop("Number of tuple updates or deletes prior to vacuum as a fraction of reltuples."),
2068 &autovacuum_vac_scale,
2069 0.2, 0.0, 100.0, NULL, NULL
2072 {"autovacuum_analyze_scale_factor", PGC_SIGHUP, AUTOVACUUM,
2073 gettext_noop("Number of tuple inserts, updates or deletes prior to analyze as a fraction of reltuples."),
2076 &autovacuum_anl_scale,
2077 0.1, 0.0, 100.0, NULL, NULL
2081 {"checkpoint_completion_target", PGC_SIGHUP, WAL_CHECKPOINTS,
2082 gettext_noop("Time spent flushing dirty buffers during checkpoint, as fraction of checkpoint interval."),
2085 &CheckPointCompletionTarget,
2086 0.5, 0.0, 1.0, NULL, NULL
2089 /* End-of-list marker */
2091 {NULL, 0, 0, NULL, NULL}, NULL, 0.0, 0.0, 0.0, NULL, NULL
2096 static struct config_string ConfigureNamesString[] =
2099 {"archive_command", PGC_SIGHUP, WAL_SETTINGS,
2100 gettext_noop("Sets the shell command that will be called to archive a WAL file."),
2103 &XLogArchiveCommand,
2104 "", NULL, show_archive_command
2108 {"client_encoding", PGC_USERSET, CLIENT_CONN_LOCALE,
2109 gettext_noop("Sets the client's character set encoding."),
2111 GUC_IS_NAME | GUC_REPORT
2113 &client_encoding_string,
2114 "SQL_ASCII", assign_client_encoding, NULL
2118 {"log_line_prefix", PGC_SIGHUP, LOGGING_WHAT,
2119 gettext_noop("Controls information prefixed to each log line."),
2120 gettext_noop("If blank, no prefix is used.")
2127 {"log_timezone", PGC_SIGHUP, LOGGING_WHAT,
2128 gettext_noop("Sets the time zone to use in log messages."),
2131 &log_timezone_string,
2132 "UNKNOWN", assign_log_timezone, show_log_timezone
2136 {"DateStyle", PGC_USERSET, CLIENT_CONN_LOCALE,
2137 gettext_noop("Sets the display format for date and time values."),
2138 gettext_noop("Also controls interpretation of ambiguous "
2140 GUC_LIST_INPUT | GUC_REPORT
2143 "ISO, MDY", assign_datestyle, NULL
2147 {"default_tablespace", PGC_USERSET, CLIENT_CONN_STATEMENT,
2148 gettext_noop("Sets the default tablespace to create tables and indexes in."),
2149 gettext_noop("An empty string selects the database's default tablespace."),
2152 &default_tablespace,
2153 "", assign_default_tablespace, NULL
2157 {"temp_tablespaces", PGC_USERSET, CLIENT_CONN_STATEMENT,
2158 gettext_noop("Sets the tablespace(s) to use for temporary tables and sort files."),
2160 GUC_LIST_INPUT | GUC_LIST_QUOTE
2163 "", assign_temp_tablespaces, NULL
2167 {"dynamic_library_path", PGC_SUSET, CLIENT_CONN_OTHER,
2168 gettext_noop("Sets the path for dynamically loadable modules."),
2169 gettext_noop("If a dynamically loadable module needs to be opened and "
2170 "the specified name does not have a directory component (i.e., the "
2171 "name does not contain a slash), the system will search this path for "
2172 "the specified file."),
2175 &Dynamic_library_path,
2176 "$libdir", NULL, NULL
2180 {"krb_server_keyfile", PGC_SIGHUP, CONN_AUTH_SECURITY,
2181 gettext_noop("Sets the location of the Kerberos server key file."),
2185 &pg_krb_server_keyfile,
2186 PG_KRB_SRVTAB, NULL, NULL
2190 {"krb_srvname", PGC_SIGHUP, CONN_AUTH_SECURITY,
2191 gettext_noop("Sets the name of the Kerberos service."),
2195 PG_KRB_SRVNAM, NULL, NULL
2199 {"bonjour_name", PGC_POSTMASTER, CONN_AUTH_SETTINGS,
2200 gettext_noop("Sets the Bonjour service name."),
2207 /* See main.c about why defaults for LC_foo are not all alike */
2210 {"lc_collate", PGC_INTERNAL, CLIENT_CONN_LOCALE,
2211 gettext_noop("Shows the collation order locale."),
2213 GUC_NOT_IN_SAMPLE | GUC_DISALLOW_IN_FILE
2220 {"lc_ctype", PGC_INTERNAL, CLIENT_CONN_LOCALE,
2221 gettext_noop("Shows the character classification and case conversion locale."),
2223 GUC_NOT_IN_SAMPLE | GUC_DISALLOW_IN_FILE
2230 {"lc_messages", PGC_SUSET, CLIENT_CONN_LOCALE,
2231 gettext_noop("Sets the language in which messages are displayed."),
2235 "", locale_messages_assign, NULL
2239 {"lc_monetary", PGC_USERSET, CLIENT_CONN_LOCALE,
2240 gettext_noop("Sets the locale for formatting monetary amounts."),
2244 "C", locale_monetary_assign, NULL
2248 {"lc_numeric", PGC_USERSET, CLIENT_CONN_LOCALE,
2249 gettext_noop("Sets the locale for formatting numbers."),
2253 "C", locale_numeric_assign, NULL
2257 {"lc_time", PGC_USERSET, CLIENT_CONN_LOCALE,
2258 gettext_noop("Sets the locale for formatting date and time values."),
2262 "C", locale_time_assign, NULL
2266 {"shared_preload_libraries", PGC_POSTMASTER, RESOURCES_KERNEL,
2267 gettext_noop("Lists shared libraries to preload into server."),
2269 GUC_LIST_INPUT | GUC_LIST_QUOTE | GUC_SUPERUSER_ONLY
2271 &shared_preload_libraries_string,
2276 {"local_preload_libraries", PGC_BACKEND, CLIENT_CONN_OTHER,
2277 gettext_noop("Lists shared libraries to preload into each backend."),
2279 GUC_LIST_INPUT | GUC_LIST_QUOTE
2281 &local_preload_libraries_string,
2286 {"search_path", PGC_USERSET, CLIENT_CONN_STATEMENT,
2287 gettext_noop("Sets the schema search order for names that are not schema-qualified."),
2289 GUC_LIST_INPUT | GUC_LIST_QUOTE
2291 &namespace_search_path,
2292 "\"$user\",public", assign_search_path, NULL
2296 /* Can't be set in postgresql.conf */
2297 {"server_encoding", PGC_INTERNAL, CLIENT_CONN_LOCALE,
2298 gettext_noop("Sets the server (database) character set encoding."),
2300 GUC_IS_NAME | GUC_REPORT | GUC_NOT_IN_SAMPLE | GUC_DISALLOW_IN_FILE
2302 &server_encoding_string,
2303 "SQL_ASCII", NULL, NULL
2307 /* Can't be set in postgresql.conf */
2308 {"server_version", PGC_INTERNAL, PRESET_OPTIONS,
2309 gettext_noop("Shows the server version."),
2311 GUC_REPORT | GUC_NOT_IN_SAMPLE | GUC_DISALLOW_IN_FILE
2313 &server_version_string,
2314 PG_VERSION, NULL, NULL
2318 /* Not for general use --- used by SET ROLE */
2319 {"role", PGC_USERSET, UNGROUPED,
2320 gettext_noop("Sets the current role."),
2322 GUC_IS_NAME | GUC_NO_SHOW_ALL | GUC_NO_RESET_ALL | GUC_NOT_IN_SAMPLE | GUC_DISALLOW_IN_FILE | GUC_NOT_WHILE_SEC_DEF
2325 "none", assign_role, show_role
2329 /* Not for general use --- used by SET SESSION AUTHORIZATION */
2330 {"session_authorization", PGC_USERSET, UNGROUPED,
2331 gettext_noop("Sets the session user name."),
2333 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_DEF
2335 &session_authorization_string,
2336 NULL, assign_session_authorization, show_session_authorization
2340 {"log_destination", PGC_SIGHUP, LOGGING_WHERE,
2341 gettext_noop("Sets the destination for server log output."),
2342 gettext_noop("Valid values are combinations of \"stderr\", "
2343 "\"syslog\", \"csvlog\", and \"eventlog\", "
2344 "depending on the platform."),
2347 &log_destination_string,
2348 "stderr", assign_log_destination, NULL
2351 {"log_directory", PGC_SIGHUP, LOGGING_WHERE,
2352 gettext_noop("Sets the destination directory for log files."),
2353 gettext_noop("Can be specified as relative to the data directory "
2354 "or as absolute path."),
2358 "pg_log", assign_canonical_path, NULL
2361 {"log_filename", PGC_SIGHUP, LOGGING_WHERE,
2362 gettext_noop("Sets the file name pattern for log files."),
2367 "postgresql-%Y-%m-%d_%H%M%S.log", NULL, NULL
2372 {"syslog_ident", PGC_SIGHUP, LOGGING_WHERE,
2373 gettext_noop("Sets the program name used to identify PostgreSQL "
2374 "messages in syslog."),
2378 "postgres", assign_syslog_ident, NULL
2383 {"TimeZone", PGC_USERSET, CLIENT_CONN_LOCALE,
2384 gettext_noop("Sets the time zone for displaying and interpreting time stamps."),
2389 "UNKNOWN", assign_timezone, show_timezone
2392 {"timezone_abbreviations", PGC_USERSET, CLIENT_CONN_LOCALE,
2393 gettext_noop("Selects a file of time zone abbreviations."),
2396 &timezone_abbreviations_string,
2397 "UNKNOWN", assign_timezone_abbreviations, NULL
2401 {"transaction_isolation", PGC_USERSET, CLIENT_CONN_STATEMENT,
2402 gettext_noop("Sets the current transaction's isolation level."),
2404 GUC_NO_RESET_ALL | GUC_NOT_IN_SAMPLE | GUC_DISALLOW_IN_FILE
2406 &XactIsoLevel_string,
2407 NULL, assign_XactIsoLevel, show_XactIsoLevel
2411 {"unix_socket_group", PGC_POSTMASTER, CONN_AUTH_SETTINGS,
2412 gettext_noop("Sets the owning group of the Unix-domain socket."),
2413 gettext_noop("The owning user of the socket is always the user "
2414 "that starts the server.")
2421 {"unix_socket_directory", PGC_POSTMASTER, CONN_AUTH_SETTINGS,
2422 gettext_noop("Sets the directory where the Unix-domain socket will be created."),
2427 "", assign_canonical_path, NULL
2431 {"listen_addresses", PGC_POSTMASTER, CONN_AUTH_SETTINGS,
2432 gettext_noop("Sets the host name or IP address(es) to listen to."),
2437 "localhost", NULL, NULL
2441 {"custom_variable_classes", PGC_SIGHUP, CUSTOM_OPTIONS,
2442 gettext_noop("Sets the list of known custom variable classes."),
2444 GUC_LIST_INPUT | GUC_LIST_QUOTE
2446 &custom_variable_classes,
2447 NULL, assign_custom_variable_classes, NULL
2451 {"data_directory", PGC_POSTMASTER, FILE_LOCATIONS,
2452 gettext_noop("Sets the server's data directory."),
2461 {"config_file", PGC_POSTMASTER, FILE_LOCATIONS,
2462 gettext_noop("Sets the server's main configuration file."),
2464 GUC_DISALLOW_IN_FILE | GUC_SUPERUSER_ONLY
2471 {"hba_file", PGC_POSTMASTER, FILE_LOCATIONS,
2472 gettext_noop("Sets the server's \"hba\" configuration file."),
2481 {"ident_file", PGC_POSTMASTER, FILE_LOCATIONS,
2482 gettext_noop("Sets the server's \"ident\" configuration file."),
2491 {"external_pid_file", PGC_POSTMASTER, FILE_LOCATIONS,
2492 gettext_noop("Writes the postmaster PID to the specified file."),
2497 NULL, assign_canonical_path, NULL
2501 {"stats_temp_directory", PGC_SIGHUP, STATS_COLLECTOR,
2502 gettext_noop("Writes temporary statistics files to the specified directory."),
2506 &pgstat_temp_directory,
2507 "pg_stat_tmp", assign_pgstat_temp_directory, NULL
2511 {"default_text_search_config", PGC_USERSET, CLIENT_CONN_LOCALE,
2512 gettext_noop("Sets default text search configuration."),
2516 "pg_catalog.simple", assignTSCurrentConfig, NULL
2521 {"ssl_ciphers", PGC_POSTMASTER, CONN_AUTH_SECURITY,
2522 gettext_noop("Sets the list of allowed SSL ciphers."),
2527 "ALL:!ADH:!LOW:!EXP:!MD5:@STRENGTH", NULL, NULL
2529 #endif /* USE_SSL */
2532 {"default_do_language", PGC_USERSET, CLIENT_CONN_STATEMENT,
2533 gettext_noop("Sets the language used in DO statement if LANGUAGE is not specified."),
2536 &default_do_language,
2537 "plpgsql", NULL, NULL
2541 {"application_name", PGC_USERSET, LOGGING,
2542 gettext_noop("Sets the application name to be reported in statistics and logs."),
2544 GUC_IS_NAME | GUC_REPORT | GUC_NOT_IN_SAMPLE
2547 "", assign_application_name, NULL
2550 /* End-of-list marker */
2552 {NULL, 0, 0, NULL, NULL}, NULL, NULL, NULL, NULL
2557 static struct config_enum ConfigureNamesEnum[] =
2560 {"backslash_quote", PGC_USERSET, COMPAT_OPTIONS_PREVIOUS,
2561 gettext_noop("Sets whether \"\\'\" is allowed in string literals."),
2565 BACKSLASH_QUOTE_SAFE_ENCODING, backslash_quote_options, NULL, NULL
2569 {"bytea_output", PGC_USERSET, CLIENT_CONN_STATEMENT,
2570 gettext_noop("Sets the output format for bytea."),
2574 BYTEA_OUTPUT_HEX, bytea_output_options, NULL, NULL
2578 {"client_min_messages", PGC_USERSET, LOGGING_WHEN,
2579 gettext_noop("Sets the message levels that are sent to the client."),
2580 gettext_noop("Each level includes all the levels that follow it. The later"
2581 " the level, the fewer messages are sent.")
2583 &client_min_messages,
2584 NOTICE, client_message_level_options, NULL, NULL
2588 {"constraint_exclusion", PGC_USERSET, QUERY_TUNING_OTHER,
2589 gettext_noop("Enables the planner to use constraints to optimize queries."),
2590 gettext_noop("Table scans will be skipped if their constraints"
2591 " guarantee that no rows match the query.")
2593 &constraint_exclusion,
2594 CONSTRAINT_EXCLUSION_PARTITION, constraint_exclusion_options,
2599 {"default_transaction_isolation", PGC_USERSET, CLIENT_CONN_STATEMENT,
2600 gettext_noop("Sets the transaction isolation level of each new transaction."),
2603 &DefaultXactIsoLevel,
2604 XACT_READ_COMMITTED, isolation_level_options, NULL, NULL
2608 {"IntervalStyle", PGC_USERSET, CLIENT_CONN_LOCALE,
2609 gettext_noop("Sets the display format for interval values."),
2614 INTSTYLE_POSTGRES, intervalstyle_options, NULL, NULL
2618 {"log_error_verbosity", PGC_SUSET, LOGGING_WHEN,
2619 gettext_noop("Sets the verbosity of logged messages."),
2622 &Log_error_verbosity,
2623 PGERROR_DEFAULT, log_error_verbosity_options, NULL, NULL
2627 {"log_min_messages", PGC_SUSET, LOGGING_WHEN,
2628 gettext_noop("Sets the message levels that are logged."),
2629 gettext_noop("Each level includes all the levels that follow it. The later"
2630 " the level, the fewer messages are sent.")
2633 WARNING, server_message_level_options, NULL, NULL
2637 {"log_min_error_statement", PGC_SUSET, LOGGING_WHEN,
2638 gettext_noop("Causes all statements generating error at or above this level to be logged."),
2639 gettext_noop("Each level includes all the levels that follow it. The later"
2640 " the level, the fewer messages are sent.")
2642 &log_min_error_statement,
2643 ERROR, server_message_level_options, NULL, NULL
2647 {"log_statement", PGC_SUSET, LOGGING_WHAT,
2648 gettext_noop("Sets the type of statements logged."),
2652 LOGSTMT_NONE, log_statement_options, NULL, NULL
2657 {"syslog_facility", PGC_SIGHUP, LOGGING_WHERE,
2658 gettext_noop("Sets the syslog \"facility\" to be used when syslog enabled."),
2662 LOG_LOCAL0, syslog_facility_options, assign_syslog_facility, NULL
2667 {"session_replication_role", PGC_SUSET, CLIENT_CONN_STATEMENT,
2668 gettext_noop("Sets the session's behavior for triggers and rewrite rules."),
2671 &SessionReplicationRole,
2672 SESSION_REPLICATION_ROLE_ORIGIN, session_replication_role_options,
2673 assign_session_replication_role, NULL
2677 {"track_functions", PGC_SUSET, STATS_COLLECTOR,
2678 gettext_noop("Collects function-level statistics on database activity."),
2681 &pgstat_track_functions,
2682 TRACK_FUNC_OFF, track_function_options, NULL, NULL
2686 {"wal_sync_method", PGC_SIGHUP, WAL_SETTINGS,
2687 gettext_noop("Selects the method used for forcing WAL updates to disk."),
2691 DEFAULT_SYNC_METHOD, sync_method_options,
2692 assign_xlog_sync_method, NULL
2696 {"xmlbinary", PGC_USERSET, CLIENT_CONN_STATEMENT,
2697 gettext_noop("Sets how binary values are to be encoded in XML."),
2701 XMLBINARY_BASE64, xmlbinary_options, NULL, NULL
2705 {"xmloption", PGC_USERSET, CLIENT_CONN_STATEMENT,
2706 gettext_noop("Sets whether XML data in implicit parsing and serialization "
2707 "operations is to be considered as documents or content fragments."),
2711 XMLOPTION_CONTENT, xmloption_options, NULL, NULL
2715 /* End-of-list marker */
2717 {NULL, 0, 0, NULL, NULL}, NULL, 0, NULL, NULL, NULL
2721 /******** end of options list ********/
2725 * To allow continued support of obsolete names for GUC variables, we apply
2726 * the following mappings to any unrecognized name. Note that an old name
2727 * should be mapped to a new one only if the new variable has very similar
2728 * semantics to the old.
2730 static const char *const map_old_guc_names[] = {
2731 "sort_mem", "work_mem",
2732 "vacuum_mem", "maintenance_work_mem",
2738 * Actual lookup of variables is done through this single, sorted array.
2740 static struct config_generic **guc_variables;
2742 /* Current number of variables contained in the vector */
2743 static int num_guc_variables;
2745 /* Vector capacity */
2746 static int size_guc_variables;
2749 static bool guc_dirty; /* TRUE if need to do commit/abort work */
2751 static bool reporting_enabled; /* TRUE to enable GUC_REPORT */
2753 static int GUCNestLevel = 0; /* 1 when in main transaction */
2756 static int guc_var_compare(const void *a, const void *b);
2757 static int guc_name_compare(const char *namea, const char *nameb);
2758 static void InitializeOneGUCOption(struct config_generic * gconf);
2759 static void push_old_value(struct config_generic * gconf, GucAction action);
2760 static void ReportGUCOption(struct config_generic * record);
2761 static void ShowGUCConfigOption(const char *name, DestReceiver *dest);
2762 static void ShowAllGUCConfig(DestReceiver *dest);
2763 static char *_ShowOption(struct config_generic * record, bool use_units);
2764 static bool is_newvalue_equal(struct config_generic * record, const char *newvalue);
2768 * Some infrastructure for checking malloc/strdup/realloc calls
2771 guc_malloc(int elevel, size_t size)
2775 data = malloc(size);
2778 (errcode(ERRCODE_OUT_OF_MEMORY),
2779 errmsg("out of memory")));
2784 guc_realloc(int elevel, void *old, size_t size)
2788 data = realloc(old, size);
2791 (errcode(ERRCODE_OUT_OF_MEMORY),
2792 errmsg("out of memory")));
2797 guc_strdup(int elevel, const char *src)
2804 (errcode(ERRCODE_OUT_OF_MEMORY),
2805 errmsg("out of memory")));
2811 * Support for assigning to a field of a string GUC item. Free the prior
2812 * value if it's not referenced anywhere else in the item (including stacked
2816 set_string_field(struct config_string * conf, char **field, char *newval)
2818 char *oldval = *field;
2821 /* Do the assignment */
2824 /* Exit if any duplicate references, or if old value was NULL anyway */
2825 if (oldval == NULL ||
2826 oldval == *(conf->variable) ||
2827 oldval == conf->reset_val ||
2828 oldval == conf->boot_val)
2830 for (stack = conf->gen.stack; stack; stack = stack->prev)
2832 if (oldval == stack->prior.stringval ||
2833 oldval == stack->masked.stringval)
2837 /* Not used anymore, so free it */
2842 * Detect whether strval is referenced anywhere in a GUC string item
2845 string_field_used(struct config_string * conf, char *strval)
2849 if (strval == *(conf->variable) ||
2850 strval == conf->reset_val ||
2851 strval == conf->boot_val)
2853 for (stack = conf->gen.stack; stack; stack = stack->prev)
2855 if (strval == stack->prior.stringval ||
2856 strval == stack->masked.stringval)
2863 * Support for copying a variable's active value into a stack entry
2866 set_stack_value(struct config_generic * gconf, union config_var_value * val)
2868 switch (gconf->vartype)
2872 *((struct config_bool *) gconf)->variable;
2876 *((struct config_int *) gconf)->variable;
2880 *((struct config_real *) gconf)->variable;
2883 /* we assume stringval is NULL if not valid */
2884 set_string_field((struct config_string *) gconf,
2886 *((struct config_string *) gconf)->variable);
2890 *((struct config_enum *) gconf)->variable;
2896 * Support for discarding a no-longer-needed value in a stack entry
2899 discard_stack_value(struct config_generic * gconf, union config_var_value * val)
2901 switch (gconf->vartype)
2907 /* no need to do anything */
2910 set_string_field((struct config_string *) gconf,
2919 * Fetch the sorted array pointer (exported for help_config.c's use ONLY)
2921 struct config_generic **
2922 get_guc_variables(void)
2924 return guc_variables;
2929 * Build the sorted array. This is split out so that it could be
2930 * re-executed after startup (eg, we could allow loadable modules to
2931 * add vars, and then we'd need to re-sort).
2934 build_guc_variables(void)
2938 struct config_generic **guc_vars;
2941 for (i = 0; ConfigureNamesBool[i].gen.name; i++)
2943 struct config_bool *conf = &ConfigureNamesBool[i];
2945 /* Rather than requiring vartype to be filled in by hand, do this: */
2946 conf->gen.vartype = PGC_BOOL;
2950 for (i = 0; ConfigureNamesInt[i].gen.name; i++)
2952 struct config_int *conf = &ConfigureNamesInt[i];
2954 conf->gen.vartype = PGC_INT;
2958 for (i = 0; ConfigureNamesReal[i].gen.name; i++)
2960 struct config_real *conf = &ConfigureNamesReal[i];
2962 conf->gen.vartype = PGC_REAL;
2966 for (i = 0; ConfigureNamesString[i].gen.name; i++)
2968 struct config_string *conf = &ConfigureNamesString[i];
2970 conf->gen.vartype = PGC_STRING;
2974 for (i = 0; ConfigureNamesEnum[i].gen.name; i++)
2976 struct config_enum *conf = &ConfigureNamesEnum[i];
2978 conf->gen.vartype = PGC_ENUM;
2983 * Create table with 20% slack
2985 size_vars = num_vars + num_vars / 4;
2987 guc_vars = (struct config_generic **)
2988 guc_malloc(FATAL, size_vars * sizeof(struct config_generic *));
2992 for (i = 0; ConfigureNamesBool[i].gen.name; i++)
2993 guc_vars[num_vars++] = &ConfigureNamesBool[i].gen;
2995 for (i = 0; ConfigureNamesInt[i].gen.name; i++)
2996 guc_vars[num_vars++] = &ConfigureNamesInt[i].gen;
2998 for (i = 0; ConfigureNamesReal[i].gen.name; i++)
2999 guc_vars[num_vars++] = &ConfigureNamesReal[i].gen;
3001 for (i = 0; ConfigureNamesString[i].gen.name; i++)
3002 guc_vars[num_vars++] = &ConfigureNamesString[i].gen;
3004 for (i = 0; ConfigureNamesEnum[i].gen.name; i++)
3005 guc_vars[num_vars++] = &ConfigureNamesEnum[i].gen;
3008 free(guc_variables);
3009 guc_variables = guc_vars;
3010 num_guc_variables = num_vars;
3011 size_guc_variables = size_vars;
3012 qsort((void *) guc_variables, num_guc_variables,
3013 sizeof(struct config_generic *), guc_var_compare);
3017 * Add a new GUC variable to the list of known variables. The
3018 * list is expanded if needed.
3021 add_guc_variable(struct config_generic * var, int elevel)
3023 if (num_guc_variables + 1 >= size_guc_variables)
3026 * Increase the vector by 25%
3028 int size_vars = size_guc_variables + size_guc_variables / 4;
3029 struct config_generic **guc_vars;
3034 guc_vars = (struct config_generic **)
3035 guc_malloc(elevel, size_vars * sizeof(struct config_generic *));
3039 guc_vars = (struct config_generic **)
3040 guc_realloc(elevel, guc_variables, size_vars * sizeof(struct config_generic *));
3043 if (guc_vars == NULL)
3044 return false; /* out of memory */
3046 guc_variables = guc_vars;
3047 size_guc_variables = size_vars;
3049 guc_variables[num_guc_variables++] = var;
3050 qsort((void *) guc_variables, num_guc_variables,
3051 sizeof(struct config_generic *), guc_var_compare);
3056 * Create and add a placeholder variable. It's presumed to belong
3057 * to a valid custom variable class at this point.
3059 static struct config_generic *
3060 add_placeholder_variable(const char *name, int elevel)
3062 size_t sz = sizeof(struct config_string) + sizeof(char *);
3063 struct config_string *var;
3064 struct config_generic *gen;
3066 var = (struct config_string *) guc_malloc(elevel, sz);
3072 gen->name = guc_strdup(elevel, name);
3073 if (gen->name == NULL)
3079 gen->context = PGC_USERSET;
3080 gen->group = CUSTOM_OPTIONS;
3081 gen->short_desc = "GUC placeholder variable";
3082 gen->flags = GUC_NO_SHOW_ALL | GUC_NOT_IN_SAMPLE | GUC_CUSTOM_PLACEHOLDER;
3083 gen->vartype = PGC_STRING;
3086 * The char* is allocated at the end of the struct since we have no
3087 * 'static' place to point to. Note that the current value, as well as
3088 * the boot and reset values, start out NULL.
3090 var->variable = (char **) (var + 1);
3092 if (!add_guc_variable((struct config_generic *) var, elevel))
3094 free((void *) gen->name);
3103 * Detect whether the portion of "name" before dotPos matches any custom
3104 * variable class name listed in custom_var_classes. The latter must be
3105 * formatted the way that assign_custom_variable_classes does it, ie,
3106 * no whitespace. NULL is valid for custom_var_classes.
3109 is_custom_class(const char *name, int dotPos, const char *custom_var_classes)
3111 bool result = false;
3112 const char *ccs = custom_var_classes;
3116 const char *start = ccs;
3122 if (c == '\0' || c == ',')
3124 if (dotPos == ccs - start && strncmp(start, name, dotPos) == 0)
3139 * Look up option NAME. If it exists, return a pointer to its record,
3140 * else return NULL. If create_placeholders is TRUE, we'll create a
3141 * placeholder record for a valid-looking custom variable name.
3143 static struct config_generic *
3144 find_option(const char *name, bool create_placeholders, int elevel)
3146 const char **key = &name;
3147 struct config_generic **res;
3153 * By equating const char ** with struct config_generic *, we are assuming
3154 * the name field is first in config_generic.
3156 res = (struct config_generic **) bsearch((void *) &key,
3157 (void *) guc_variables,
3159 sizeof(struct config_generic *),
3165 * See if the name is an obsolete name for a variable. We assume that the
3166 * set of supported old names is short enough that a brute-force search is
3169 for (i = 0; map_old_guc_names[i] != NULL; i += 2)
3171 if (guc_name_compare(name, map_old_guc_names[i]) == 0)
3172 return find_option(map_old_guc_names[i + 1], false, elevel);
3175 if (create_placeholders)
3178 * Check if the name is qualified, and if so, check if the qualifier
3179 * matches any custom variable class. If so, add a placeholder.
3181 const char *dot = strchr(name, GUC_QUALIFIER_SEPARATOR);
3184 is_custom_class(name, dot - name, custom_variable_classes))
3185 return add_placeholder_variable(name, elevel);
3194 * comparator for qsorting and bsearching guc_variables array
3197 guc_var_compare(const void *a, const void *b)
3199 struct config_generic *confa = *(struct config_generic **) a;
3200 struct config_generic *confb = *(struct config_generic **) b;
3202 return guc_name_compare(confa->name, confb->name);
3206 * the bare comparison function for GUC names
3209 guc_name_compare(const char *namea, const char *nameb)
3212 * The temptation to use strcasecmp() here must be resisted, because the
3213 * array ordering has to remain stable across setlocale() calls. So, build
3214 * our own with a simple ASCII-only downcasing.
3216 while (*namea && *nameb)
3218 char cha = *namea++;
3219 char chb = *nameb++;
3221 if (cha >= 'A' && cha <= 'Z')
3223 if (chb >= 'A' && chb <= 'Z')
3229 return 1; /* a is longer */
3231 return -1; /* b is longer */
3237 * Initialize GUC options during program startup.
3239 * Note that we cannot read the config file yet, since we have not yet
3240 * processed command-line switches.
3243 InitializeGUCOptions(void)
3250 * Before log_line_prefix could possibly receive a nonempty setting, make
3251 * sure that timezone processing is minimally alive (see elog.c).
3253 pg_timezone_pre_initialize();
3256 * Build sorted array of all GUC variables.
3258 build_guc_variables();
3261 * Load all variables with their compiled-in defaults, and initialize
3262 * status fields as needed.
3264 for (i = 0; i < num_guc_variables; i++)
3266 InitializeOneGUCOption(guc_variables[i]);
3271 reporting_enabled = false;
3274 * Prevent any attempt to override the transaction modes from
3275 * non-interactive sources.
3277 SetConfigOption("transaction_isolation", "default",
3278 PGC_POSTMASTER, PGC_S_OVERRIDE);
3279 SetConfigOption("transaction_read_only", "no",
3280 PGC_POSTMASTER, PGC_S_OVERRIDE);
3283 * For historical reasons, some GUC parameters can receive defaults from
3284 * environment variables. Process those settings. NB: if you add or
3285 * remove anything here, see also ProcessConfigFile().
3288 env = getenv("PGPORT");
3290 SetConfigOption("port", env, PGC_POSTMASTER, PGC_S_ENV_VAR);
3292 env = getenv("PGDATESTYLE");
3294 SetConfigOption("datestyle", env, PGC_POSTMASTER, PGC_S_ENV_VAR);
3296 env = getenv("PGCLIENTENCODING");
3298 SetConfigOption("client_encoding", env, PGC_POSTMASTER, PGC_S_ENV_VAR);
3301 * rlimit isn't exactly an "environment variable", but it behaves about
3302 * the same. If we can identify the platform stack depth rlimit, increase
3303 * default stack depth setting up to whatever is safe (but at most 2MB).
3305 stack_rlimit = get_stack_depth_rlimit();
3306 if (stack_rlimit > 0)
3308 int new_limit = (stack_rlimit - STACK_DEPTH_SLOP) / 1024L;
3310 if (new_limit > 100)
3314 new_limit = Min(new_limit, 2048);
3315 sprintf(limbuf, "%d", new_limit);
3316 SetConfigOption("max_stack_depth", limbuf,
3317 PGC_POSTMASTER, PGC_S_ENV_VAR);
3323 * Initialize one GUC option variable to its compiled-in default.
3326 InitializeOneGUCOption(struct config_generic * gconf)
3329 gconf->reset_source = PGC_S_DEFAULT;
3330 gconf->source = PGC_S_DEFAULT;
3331 gconf->stack = NULL;
3332 gconf->sourcefile = NULL;
3333 gconf->sourceline = 0;
3335 switch (gconf->vartype)
3339 struct config_bool *conf = (struct config_bool *) gconf;
3341 if (conf->assign_hook)
3342 if (!(*conf->assign_hook) (conf->boot_val, true,
3344 elog(FATAL, "failed to initialize %s to %d",
3345 conf->gen.name, (int) conf->boot_val);
3346 *conf->variable = conf->reset_val = conf->boot_val;
3351 struct config_int *conf = (struct config_int *) gconf;
3353 Assert(conf->boot_val >= conf->min);
3354 Assert(conf->boot_val <= conf->max);
3355 if (conf->assign_hook)
3356 if (!(*conf->assign_hook) (conf->boot_val, true,
3358 elog(FATAL, "failed to initialize %s to %d",
3359 conf->gen.name, conf->boot_val);
3360 *conf->variable = conf->reset_val = conf->boot_val;
3365 struct config_real *conf = (struct config_real *) gconf;
3367 Assert(conf->boot_val >= conf->min);
3368 Assert(conf->boot_val <= conf->max);
3369 if (conf->assign_hook)
3370 if (!(*conf->assign_hook) (conf->boot_val, true,
3372 elog(FATAL, "failed to initialize %s to %g",
3373 conf->gen.name, conf->boot_val);
3374 *conf->variable = conf->reset_val = conf->boot_val;
3379 struct config_string *conf = (struct config_string *) gconf;
3382 *conf->variable = NULL;
3383 conf->reset_val = NULL;
3385 if (conf->boot_val == NULL)
3387 /* leave the value NULL, do not call assign hook */
3391 str = guc_strdup(FATAL, conf->boot_val);
3392 conf->reset_val = str;
3394 if (conf->assign_hook)
3398 newstr = (*conf->assign_hook) (str, true,
3402 elog(FATAL, "failed to initialize %s to \"%s\"",
3403 conf->gen.name, str);
3405 else if (newstr != str)
3410 * See notes in set_config_option about casting
3412 str = (char *) newstr;
3413 conf->reset_val = str;
3416 *conf->variable = str;
3421 struct config_enum *conf = (struct config_enum *) gconf;
3423 if (conf->assign_hook)
3424 if (!(*conf->assign_hook) (conf->boot_val, true,
3426 elog(FATAL, "failed to initialize %s to %s",
3428 config_enum_lookup_by_value(conf, conf->boot_val));
3429 *conf->variable = conf->reset_val = conf->boot_val;
3437 * Select the configuration files and data directory to be used, and
3438 * do the initial read of postgresql.conf.
3440 * This is called after processing command-line switches.
3441 * userDoption is the -D switch value if any (NULL if unspecified).
3442 * progname is just for use in error messages.
3444 * Returns true on success; on failure, prints a suitable error message
3445 * to stderr and returns false.
3448 SelectConfigFiles(const char *userDoption, const char *progname)
3452 struct stat stat_buf;
3454 /* configdir is -D option, or $PGDATA if no -D */
3456 configdir = make_absolute_path(userDoption);
3458 configdir = make_absolute_path(getenv("PGDATA"));
3461 * Find the configuration file: if config_file was specified on the
3462 * command line, use it, else use configdir/postgresql.conf. In any case
3463 * ensure the result is an absolute path, so that it will be interpreted
3464 * the same way by future backends.
3467 fname = make_absolute_path(ConfigFileName);
3470 fname = guc_malloc(FATAL,
3471 strlen(configdir) + strlen(CONFIG_FILENAME) + 2);
3472 sprintf(fname, "%s/%s", configdir, CONFIG_FILENAME);
3476 write_stderr("%s does not know where to find the server configuration file.\n"
3477 "You must specify the --config-file or -D invocation "
3478 "option or set the PGDATA environment variable.\n",
3484 * Set the ConfigFileName GUC variable to its final value, ensuring that
3485 * it can't be overridden later.
3487 SetConfigOption("config_file", fname, PGC_POSTMASTER, PGC_S_OVERRIDE);
3491 * Now read the config file for the first time.
3493 if (stat(ConfigFileName, &stat_buf) != 0)
3495 write_stderr("%s cannot access the server configuration file \"%s\": %s\n",
3496 progname, ConfigFileName, strerror(errno));
3500 ProcessConfigFile(PGC_POSTMASTER);
3503 * If the data_directory GUC variable has been set, use that as DataDir;
3504 * otherwise use configdir if set; else punt.
3506 * Note: SetDataDir will copy and absolute-ize its argument, so we don't
3510 SetDataDir(data_directory);
3512 SetDataDir(configdir);
3515 write_stderr("%s does not know where to find the database system data.\n"
3516 "This can be specified as \"data_directory\" in \"%s\", "
3517 "or by the -D invocation option, or by the "
3518 "PGDATA environment variable.\n",
3519 progname, ConfigFileName);
3524 * Reflect the final DataDir value back into the data_directory GUC var.
3525 * (If you are wondering why we don't just make them a single variable,
3526 * it's because the EXEC_BACKEND case needs DataDir to be transmitted to
3527 * child backends specially. XXX is that still true? Given that we now
3528 * chdir to DataDir, EXEC_BACKEND can read the config file without knowing
3529 * DataDir in advance.)
3531 SetConfigOption("data_directory", DataDir, PGC_POSTMASTER, PGC_S_OVERRIDE);
3534 * Figure out where pg_hba.conf is, and make sure the path is absolute.
3537 fname = make_absolute_path(HbaFileName);
3540 fname = guc_malloc(FATAL,
3541 strlen(configdir) + strlen(HBA_FILENAME) + 2);
3542 sprintf(fname, "%s/%s", configdir, HBA_FILENAME);
3546 write_stderr("%s does not know where to find the \"hba\" configuration file.\n"
3547 "This can be specified as \"hba_file\" in \"%s\", "
3548 "or by the -D invocation option, or by the "
3549 "PGDATA environment variable.\n",
3550 progname, ConfigFileName);
3553 SetConfigOption("hba_file", fname, PGC_POSTMASTER, PGC_S_OVERRIDE);
3557 * Likewise for pg_ident.conf.
3560 fname = make_absolute_path(IdentFileName);
3563 fname = guc_malloc(FATAL,
3564 strlen(configdir) + strlen(IDENT_FILENAME) + 2);
3565 sprintf(fname, "%s/%s", configdir, IDENT_FILENAME);
3569 write_stderr("%s does not know where to find the \"ident\" configuration file.\n"
3570 "This can be specified as \"ident_file\" in \"%s\", "
3571 "or by the -D invocation option, or by the "
3572 "PGDATA environment variable.\n",
3573 progname, ConfigFileName);
3576 SetConfigOption("ident_file", fname, PGC_POSTMASTER, PGC_S_OVERRIDE);
3586 * Reset all options to their saved default values (implements RESET ALL)
3589 ResetAllOptions(void)
3593 for (i = 0; i < num_guc_variables; i++)
3595 struct config_generic *gconf = guc_variables[i];
3597 /* Don't reset non-SET-able values */
3598 if (gconf->context != PGC_SUSET &&
3599 gconf->context != PGC_USERSET)
3601 /* Don't reset if special exclusion from RESET ALL */
3602 if (gconf->flags & GUC_NO_RESET_ALL)
3604 /* No need to reset if wasn't SET */
3605 if (gconf->source <= PGC_S_OVERRIDE)
3608 /* Save old value to support transaction abort */
3609 push_old_value(gconf, GUC_ACTION_SET);
3611 switch (gconf->vartype)
3615 struct config_bool *conf = (struct config_bool *) gconf;
3617 if (conf->assign_hook)
3618 if (!(*conf->assign_hook) (conf->reset_val, true,
3620 elog(ERROR, "failed to reset %s to %d",
3621 conf->gen.name, (int) conf->reset_val);
3622 *conf->variable = conf->reset_val;
3627 struct config_int *conf = (struct config_int *) gconf;
3629 if (conf->assign_hook)
3630 if (!(*conf->assign_hook) (conf->reset_val, true,
3632 elog(ERROR, "failed to reset %s to %d",
3633 conf->gen.name, conf->reset_val);
3634 *conf->variable = conf->reset_val;
3639 struct config_real *conf = (struct config_real *) gconf;
3641 if (conf->assign_hook)
3642 if (!(*conf->assign_hook) (conf->reset_val, true,
3644 elog(ERROR, "failed to reset %s to %g",
3645 conf->gen.name, conf->reset_val);
3646 *conf->variable = conf->reset_val;
3651 struct config_string *conf = (struct config_string *) gconf;
3654 /* We need not strdup here */
3655 str = conf->reset_val;
3657 if (conf->assign_hook && str)
3661 newstr = (*conf->assign_hook) (str, true,
3664 elog(ERROR, "failed to reset %s to \"%s\"",
3665 conf->gen.name, str);
3666 else if (newstr != str)
3669 * See notes in set_config_option about casting
3671 str = (char *) newstr;
3675 set_string_field(conf, conf->variable, str);
3680 struct config_enum *conf = (struct config_enum *) gconf;
3682 if (conf->assign_hook)
3683 if (!(*conf->assign_hook) (conf->reset_val, true,
3685 elog(ERROR, "failed to reset %s to %s",
3687 config_enum_lookup_by_value(conf, conf->reset_val));
3688 *conf->variable = conf->reset_val;
3693 gconf->source = gconf->reset_source;
3695 if (gconf->flags & GUC_REPORT)
3696 ReportGUCOption(gconf);
3703 * Push previous state during transactional assignment to a GUC variable.
3706 push_old_value(struct config_generic * gconf, GucAction action)
3710 /* If we're not inside a nest level, do nothing */
3711 if (GUCNestLevel == 0)
3714 /* Do we already have a stack entry of the current nest level? */
3715 stack = gconf->stack;
3716 if (stack && stack->nest_level >= GUCNestLevel)
3718 /* Yes, so adjust its state if necessary */
3719 Assert(stack->nest_level == GUCNestLevel);
3722 case GUC_ACTION_SET:
3723 /* SET overrides any prior action at same nest level */
3724 if (stack->state == GUC_SET_LOCAL)
3726 /* must discard old masked value */
3727 discard_stack_value(gconf, &stack->masked);
3729 stack->state = GUC_SET;
3731 case GUC_ACTION_LOCAL:
3732 if (stack->state == GUC_SET)
3734 /* SET followed by SET LOCAL, remember SET's value */
3735 set_stack_value(gconf, &stack->masked);
3736 stack->state = GUC_SET_LOCAL;
3738 /* in all other cases, no change to stack entry */
3740 case GUC_ACTION_SAVE:
3741 /* Could only have a prior SAVE of same variable */
3742 Assert(stack->state == GUC_SAVE);
3745 Assert(guc_dirty); /* must be set already */
3750 * Push a new stack entry
3752 * We keep all the stack entries in TopTransactionContext for simplicity.
3754 stack = (GucStack *) MemoryContextAllocZero(TopTransactionContext,
3757 stack->prev = gconf->stack;
3758 stack->nest_level = GUCNestLevel;
3761 case GUC_ACTION_SET:
3762 stack->state = GUC_SET;
3764 case GUC_ACTION_LOCAL:
3765 stack->state = GUC_LOCAL;
3767 case GUC_ACTION_SAVE:
3768 stack->state = GUC_SAVE;
3771 stack->source = gconf->source;
3772 set_stack_value(gconf, &stack->prior);
3774 gconf->stack = stack;
3776 /* Ensure we remember to pop at end of xact */
3782 * Do GUC processing at main transaction start.
3788 * The nest level should be 0 between transactions; if it isn't, somebody
3789 * didn't call AtEOXact_GUC, or called it with the wrong nestLevel. We
3790 * throw a warning but make no other effort to clean up.
3792 if (GUCNestLevel != 0)
3793 elog(WARNING, "GUC nest level = %d at transaction start",
3799 * Enter a new nesting level for GUC values. This is called at subtransaction
3800 * start and when entering a function that has proconfig settings. NOTE that
3801 * we must not risk error here, else subtransaction start will be unhappy.
3804 NewGUCNestLevel(void)
3806 return ++GUCNestLevel;
3810 * Do GUC processing at transaction or subtransaction commit or abort, or
3811 * when exiting a function that has proconfig settings. (The name is thus
3812 * a bit of a misnomer; perhaps it should be ExitGUCNestLevel or some such.)
3813 * During abort, we discard all GUC settings that were applied at nesting
3814 * levels >= nestLevel. nestLevel == 1 corresponds to the main transaction.
3817 AtEOXact_GUC(bool isCommit, int nestLevel)
3822 Assert(nestLevel > 0 && nestLevel <= GUCNestLevel);
3824 /* Quick exit if nothing's changed in this transaction */
3827 GUCNestLevel = nestLevel - 1;
3831 still_dirty = false;
3832 for (i = 0; i < num_guc_variables; i++)
3834 struct config_generic *gconf = guc_variables[i];
3838 * Process and pop each stack entry within the nest level. To
3839 * simplify fmgr_security_definer(), we allow failure exit from a
3840 * function-with-SET-options to be recovered at the surrounding
3841 * transaction or subtransaction abort; so there could be more than
3842 * one stack entry to pop.
3844 while ((stack = gconf->stack) != NULL &&
3845 stack->nest_level >= nestLevel)
3847 GucStack *prev = stack->prev;
3848 bool restorePrior = false;
3849 bool restoreMasked = false;
3853 * In this next bit, if we don't set either restorePrior or
3854 * restoreMasked, we must "discard" any unwanted fields of the
3855 * stack entries to avoid leaking memory. If we do set one of
3856 * those flags, unused fields will be cleaned up after restoring.
3858 if (!isCommit) /* if abort, always restore prior value */
3859 restorePrior = true;
3860 else if (stack->state == GUC_SAVE)
3861 restorePrior = true;
3862 else if (stack->nest_level == 1)
3864 /* transaction commit */
3865 if (stack->state == GUC_SET_LOCAL)
3866 restoreMasked = true;
3867 else if (stack->state == GUC_SET)
3869 /* we keep the current active value */
3870 discard_stack_value(gconf, &stack->prior);
3872 else /* must be GUC_LOCAL */
3873 restorePrior = true;
3875 else if (prev == NULL ||
3876 prev->nest_level < stack->nest_level - 1)
3878 /* decrement entry's level and do not pop it */
3879 stack->nest_level--;
3885 * We have to merge this stack entry into prev. See README for
3886 * discussion of this bit.
3888 switch (stack->state)
3891 Assert(false); /* can't get here */
3894 /* next level always becomes SET */
3895 discard_stack_value(gconf, &stack->prior);
3896 if (prev->state == GUC_SET_LOCAL)
3897 discard_stack_value(gconf, &prev->masked);
3898 prev->state = GUC_SET;
3902 if (prev->state == GUC_SET)
3904 /* LOCAL migrates down */
3905 prev->masked = stack->prior;
3906 prev->state = GUC_SET_LOCAL;
3910 /* else just forget this stack level */
3911 discard_stack_value(gconf, &stack->prior);
3916 /* prior state at this level no longer wanted */
3917 discard_stack_value(gconf, &stack->prior);
3918 /* copy down the masked state */
3919 if (prev->state == GUC_SET_LOCAL)
3920 discard_stack_value(gconf, &prev->masked);
3921 prev->masked = stack->masked;
3922 prev->state = GUC_SET_LOCAL;
3929 if (restorePrior || restoreMasked)
3931 /* Perform appropriate restoration of the stacked value */
3932 union config_var_value newvalue;
3933 GucSource newsource;
3937 newvalue = stack->masked;
3938 newsource = PGC_S_SESSION;
3942 newvalue = stack->prior;
3943 newsource = stack->source;
3946 switch (gconf->vartype)
3950 struct config_bool *conf = (struct config_bool *) gconf;
3951 bool newval = newvalue.boolval;
3953 if (*conf->variable != newval)
3955 if (conf->assign_hook)
3956 if (!(*conf->assign_hook) (newval,
3957 true, PGC_S_OVERRIDE))
3958 elog(LOG, "failed to commit %s as %d",
3959 conf->gen.name, (int) newval);
3960 *conf->variable = newval;
3967 struct config_int *conf = (struct config_int *) gconf;
3968 int newval = newvalue.intval;
3970 if (*conf->variable != newval)
3972 if (conf->assign_hook)
3973 if (!(*conf->assign_hook) (newval,
3974 true, PGC_S_OVERRIDE))
3975 elog(LOG, "failed to commit %s as %d",
3976 conf->gen.name, newval);
3977 *conf->variable = newval;
3984 struct config_real *conf = (struct config_real *) gconf;
3985 double newval = newvalue.realval;
3987 if (*conf->variable != newval)
3989 if (conf->assign_hook)
3990 if (!(*conf->assign_hook) (newval,
3991 true, PGC_S_OVERRIDE))
3992 elog(LOG, "failed to commit %s as %g",
3993 conf->gen.name, newval);
3994 *conf->variable = newval;
4001 struct config_string *conf = (struct config_string *) gconf;
4002 char *newval = newvalue.stringval;
4004 if (*conf->variable != newval)
4006 if (conf->assign_hook && newval)
4010 newstr = (*conf->assign_hook) (newval, true,
4013 elog(LOG, "failed to commit %s as \"%s\"",
4014 conf->gen.name, newval);
4015 else if (newstr != newval)
4018 * If newval should now be freed,
4019 * it'll be taken care of below.
4021 * See notes in set_config_option
4024 newval = (char *) newstr;
4028 set_string_field(conf, conf->variable, newval);
4033 * Release stacked values if not used anymore. We
4034 * could use discard_stack_value() here, but since
4035 * we have type-specific code anyway, might as
4038 set_string_field(conf, &stack->prior.stringval, NULL);
4039 set_string_field(conf, &stack->masked.stringval, NULL);
4044 struct config_enum *conf = (struct config_enum *) gconf;
4045 int newval = newvalue.enumval;
4047 if (*conf->variable != newval)
4049 if (conf->assign_hook)
4050 if (!(*conf->assign_hook) (newval,
4051 true, PGC_S_OVERRIDE))
4052 elog(LOG, "failed to commit %s as %s",
4054 config_enum_lookup_by_value(conf, newval));
4055 *conf->variable = newval;
4062 gconf->source = newsource;
4065 /* Finish popping the state stack */
4066 gconf->stack = prev;
4069 /* Report new value if we changed it */
4070 if (changed && (gconf->flags & GUC_REPORT))
4071 ReportGUCOption(gconf);
4072 } /* end of stack-popping loop */
4078 /* If there are no remaining stack entries, we can reset guc_dirty */
4079 guc_dirty = still_dirty;
4081 /* Update nesting level */
4082 GUCNestLevel = nestLevel - 1;
4087 * Start up automatic reporting of changes to variables marked GUC_REPORT.
4088 * This is executed at completion of backend startup.
4091 BeginReportingGUCOptions(void)
4096 * Don't do anything unless talking to an interactive frontend of protocol
4099 if (whereToSendOutput != DestRemote ||
4100 PG_PROTOCOL_MAJOR(FrontendProtocol) < 3)
4103 reporting_enabled = true;
4105 /* Transmit initial values of interesting variables */
4106 for (i = 0; i < num_guc_variables; i++)
4108 struct config_generic *conf = guc_variables[i];
4110 if (conf->flags & GUC_REPORT)
4111 ReportGUCOption(conf);
4116 * ReportGUCOption: if appropriate, transmit option value to frontend
4119 ReportGUCOption(struct config_generic * record)
4121 if (reporting_enabled && (record->flags & GUC_REPORT))
4123 char *val = _ShowOption(record, false);
4124 StringInfoData msgbuf;
4126 pq_beginmessage(&msgbuf, 'S');
4127 pq_sendstring(&msgbuf, record->name);
4128 pq_sendstring(&msgbuf, val);
4129 pq_endmessage(&msgbuf);
4136 * Try to parse value as an integer. The accepted formats are the
4137 * usual decimal, octal, or hexadecimal formats, optionally followed by
4138 * a unit name if "flags" indicates a unit is allowed.
4140 * If the string parses okay, return true, else false.
4141 * If okay and result is not NULL, return the value in *result.
4142 * If not okay and hintmsg is not NULL, *hintmsg is set to a suitable
4143 * HINT message, or NULL if no hint provided.
4146 parse_int(const char *value, int *result, int flags, const char **hintmsg)
4151 /* To suppress compiler warnings, always set output params */
4157 /* We assume here that int64 is at least as wide as long */
4159 val = strtol(value, &endptr, 0);
4161 if (endptr == value)
4162 return false; /* no HINT for integer syntax error */
4164 if (errno == ERANGE || val != (int64) ((int32) val))
4167 *hintmsg = gettext_noop("Value exceeds integer range.");
4171 /* allow whitespace between integer and unit */
4172 while (isspace((unsigned char) *endptr))
4175 /* Handle possible unit */
4176 if (*endptr != '\0')
4179 * Note: the multiple-switch coding technique here is a bit tedious,
4180 * but seems necessary to avoid intermediate-value overflows.
4182 * If INT64_IS_BUSTED (ie, it's really int32) we will fail to detect
4183 * overflow due to units conversion, but there are few enough such
4184 * machines that it does not seem worth trying to be smarter.
4186 if (flags & GUC_UNIT_MEMORY)
4188 /* Set hint for use if no match or trailing garbage */
4190 *hintmsg = gettext_noop("Valid units for this parameter are \"kB\", \"MB\", and \"GB\".");
4192 #if BLCKSZ < 1024 || BLCKSZ > (1024*1024)
4193 #error BLCKSZ must be between 1KB and 1MB
4195 #if XLOG_BLCKSZ < 1024 || XLOG_BLCKSZ > (1024*1024)
4196 #error XLOG_BLCKSZ must be between 1KB and 1MB
4199 if (strncmp(endptr, "kB", 2) == 0)
4202 switch (flags & GUC_UNIT_MEMORY)
4204 case GUC_UNIT_BLOCKS:
4205 val /= (BLCKSZ / 1024);
4207 case GUC_UNIT_XBLOCKS:
4208 val /= (XLOG_BLCKSZ / 1024);
4212 else if (strncmp(endptr, "MB", 2) == 0)
4215 switch (flags & GUC_UNIT_MEMORY)
4220 case GUC_UNIT_BLOCKS:
4221 val *= KB_PER_MB / (BLCKSZ / 1024);
4223 case GUC_UNIT_XBLOCKS:
4224 val *= KB_PER_MB / (XLOG_BLCKSZ / 1024);
4228 else if (strncmp(endptr, "GB", 2) == 0)
4231 switch (flags & GUC_UNIT_MEMORY)
4236 case GUC_UNIT_BLOCKS:
4237 val *= KB_PER_GB / (BLCKSZ / 1024);
4239 case GUC_UNIT_XBLOCKS:
4240 val *= KB_PER_GB / (XLOG_BLCKSZ / 1024);
4245 else if (flags & GUC_UNIT_TIME)
4247 /* Set hint for use if no match or trailing garbage */
4249 *hintmsg = gettext_noop("Valid units for this parameter are \"ms\", \"s\", \"min\", \"h\", and \"d\".");
4251 if (strncmp(endptr, "ms", 2) == 0)
4254 switch (flags & GUC_UNIT_TIME)
4264 else if (strncmp(endptr, "s", 1) == 0)
4267 switch (flags & GUC_UNIT_TIME)
4277 else if (strncmp(endptr, "min", 3) == 0)
4280 switch (flags & GUC_UNIT_TIME)
4290 else if (strncmp(endptr, "h", 1) == 0)
4293 switch (flags & GUC_UNIT_TIME)
4306 else if (strncmp(endptr, "d", 1) == 0)
4309 switch (flags & GUC_UNIT_TIME)
4324 /* allow whitespace after unit */
4325 while (isspace((unsigned char) *endptr))
4328 if (*endptr != '\0')
4329 return false; /* appropriate hint, if any, already set */
4331 /* Check for overflow due to units conversion */
4332 if (val != (int64) ((int32) val))
4335 *hintmsg = gettext_noop("Value exceeds integer range.");
4341 *result = (int) val;
4348 * Try to parse value as a floating point number in the usual format.
4349 * If the string parses okay, return true, else false.
4350 * If okay and result is not NULL, return the value in *result.
4353 parse_real(const char *value, double *result)
4359 *result = 0; /* suppress compiler warning */
4362 val = strtod(value, &endptr);
4363 if (endptr == value || errno == ERANGE)
4366 /* allow whitespace after number */
4367 while (isspace((unsigned char) *endptr))
4369 if (*endptr != '\0')
4379 * Lookup the name for an enum option with the selected value.
4380 * Should only ever be called with known-valid values, so throws
4381 * an elog(ERROR) if the enum option is not found.
4383 * The returned string is a pointer to static data and not
4384 * allocated for modification.
4387 config_enum_lookup_by_value(struct config_enum * record, int val)
4389 const struct config_enum_entry *entry;
4391 for (entry = record->options; entry && entry->name; entry++)
4393 if (entry->val == val)
4397 elog(ERROR, "could not find enum option %d for %s",
4398 val, record->gen.name);
4399 return NULL; /* silence compiler */
4404 * Lookup the value for an enum option with the selected name
4405 * (case-insensitive).
4406 * If the enum option is found, sets the retval value and returns
4407 * true. If it's not found, return FALSE and retval is set to 0.
4410 config_enum_lookup_by_name(struct config_enum * record, const char *value,
4413 const struct config_enum_entry *entry;
4415 for (entry = record->options; entry && entry->name; entry++)
4417 if (pg_strcasecmp(value, entry->name) == 0)
4419 *retval = entry->val;
4430 * Return a list of all available options for an enum, excluding
4431 * hidden ones, separated by the given separator.
4432 * If prefix is non-NULL, it is added before the first enum value.
4433 * If suffix is non-NULL, it is added to the end of the string.
4436 config_enum_get_options(struct config_enum * record, const char *prefix,
4437 const char *suffix, const char *separator)
4439 const struct config_enum_entry *entry;
4440 StringInfoData retstr;
4443 initStringInfo(&retstr);
4444 appendStringInfoString(&retstr, prefix);
4446 seplen = strlen(separator);
4447 for (entry = record->options; entry && entry->name; entry++)
4451 appendStringInfoString(&retstr, entry->name);
4452 appendBinaryStringInfo(&retstr, separator, seplen);
4457 * All the entries may have been hidden, leaving the string empty if no
4458 * prefix was given. This indicates a broken GUC setup, since there is no
4459 * use for an enum without any values, so we just check to make sure we
4460 * don't write to invalid memory instead of actually trying to do
4461 * something smart with it.
4463 if (retstr.len >= seplen)
4465 /* Replace final separator */
4466 retstr.data[retstr.len - seplen] = '\0';
4467 retstr.len -= seplen;
4470 appendStringInfoString(&retstr, suffix);
4476 * Call a GucStringAssignHook function, being careful to free the
4477 * "newval" string if the hook ereports.
4479 * This is split out of set_config_option just to avoid the "volatile"
4480 * qualifiers that would otherwise have to be plastered all over.
4483 call_string_assign_hook(GucStringAssignHook assign_hook,
4484 char *newval, bool doit, GucSource source)
4490 result = (*assign_hook) (newval, doit, source);
4504 * Sets option `name' to given value. The value should be a string
4505 * which is going to be parsed and converted to the appropriate data
4506 * type. The context and source parameters indicate in which context this
4507 * function is being called so it can apply the access restrictions
4510 * If value is NULL, set the option to its default value (normally the
4511 * reset_val, but if source == PGC_S_DEFAULT we instead use the boot_val).
4513 * action indicates whether to set the value globally in the session, locally
4514 * to the current top transaction, or just for the duration of a function call.
4516 * If changeVal is false then don't really set the option but do all
4517 * the checks to see if it would work.
4519 * If there is an error (non-existing option, invalid value) then an
4520 * ereport(ERROR) is thrown *unless* this is called in a context where we
4521 * don't want to ereport (currently, startup or SIGHUP config file reread).
4522 * In that case we write a suitable error message via ereport(LOG) and
4523 * return false. This is working around the deficiencies in the ereport
4524 * mechanism, so don't blame me. In all other cases, the function
4525 * returns true, including cases where the input is valid but we chose
4526 * not to apply it because of context or source-priority considerations.
4528 * See also SetConfigOption for an external interface.
4531 set_config_option(const char *name, const char *value,
4532 GucContext context, GucSource source,
4533 GucAction action, bool changeVal)
4535 struct config_generic *record;
4539 if (context == PGC_SIGHUP || source == PGC_S_DEFAULT)
4542 * To avoid cluttering the log, only the postmaster bleats loudly
4543 * about problems with the config file.
4545 elevel = IsUnderPostmaster ? DEBUG3 : LOG;
4547 else if (source == PGC_S_DATABASE || source == PGC_S_USER ||
4548 source == PGC_S_DATABASE_USER)
4553 record = find_option(name, true, elevel);
4557 (errcode(ERRCODE_UNDEFINED_OBJECT),
4558 errmsg("unrecognized configuration parameter \"%s\"", name)));
4563 * If source is postgresql.conf, mark the found record with
4564 * GUC_IS_IN_FILE. This is for the convenience of ProcessConfigFile. Note
4565 * that we do it even if changeVal is false, since ProcessConfigFile wants
4566 * the marking to occur during its testing pass.
4568 if (source == PGC_S_FILE)
4569 record->status |= GUC_IS_IN_FILE;
4572 * Check if the option can be set at this time. See guc.h for the precise
4573 * rules. Note that we don't want to throw errors if we're in the SIGHUP
4574 * context. In that case we just ignore the attempt and return true.
4576 switch (record->context)
4579 if (context == PGC_SIGHUP)
4581 if (context != PGC_INTERNAL)
4584 (errcode(ERRCODE_CANT_CHANGE_RUNTIME_PARAM),
4585 errmsg("parameter \"%s\" cannot be changed",
4590 case PGC_POSTMASTER:
4591 if (context == PGC_SIGHUP)
4594 * We are reading a PGC_POSTMASTER var from postgresql.conf.
4595 * We can't change the setting, so give a warning if the DBA
4596 * tries to change it. (Throwing an error would be more
4597 * consistent, but seems overly rigid.)
4599 if (changeVal && !is_newvalue_equal(record, value))
4601 (errcode(ERRCODE_CANT_CHANGE_RUNTIME_PARAM),
4602 errmsg("parameter \"%s\" cannot be changed without restarting the server",
4606 if (context != PGC_POSTMASTER)
4609 (errcode(ERRCODE_CANT_CHANGE_RUNTIME_PARAM),
4610 errmsg("parameter \"%s\" cannot be changed without restarting the server",
4616 if (context != PGC_SIGHUP && context != PGC_POSTMASTER)
4619 (errcode(ERRCODE_CANT_CHANGE_RUNTIME_PARAM),
4620 errmsg("parameter \"%s\" cannot be changed now",
4626 * Hmm, the idea of the SIGHUP context is "ought to be global, but
4627 * can be changed after postmaster start". But there's nothing
4628 * that prevents a crafty administrator from sending SIGHUP
4629 * signals to individual backends only.
4633 if (context == PGC_SIGHUP)
4636 * If a PGC_BACKEND parameter is changed in the config file,
4637 * we want to accept the new value in the postmaster (whence
4638 * it will propagate to subsequently-started backends), but
4639 * ignore it in existing backends. This is a tad klugy, but
4640 * necessary because we don't re-read the config file during
4643 if (IsUnderPostmaster)
4646 else if (context != PGC_POSTMASTER && context != PGC_BACKEND &&
4647 source != PGC_S_CLIENT)
4650 (errcode(ERRCODE_CANT_CHANGE_RUNTIME_PARAM),
4651 errmsg("parameter \"%s\" cannot be set after connection start",
4657 if (context == PGC_USERSET || context == PGC_BACKEND)
4660 (errcode(ERRCODE_INSUFFICIENT_PRIVILEGE),
4661 errmsg("permission denied to set parameter \"%s\"",
4672 * Disallow changing GUC_NOT_WHILE_SEC_DEF values if we are inside a
4673 * security-definer function. We can reject this regardless of
4674 * the context or source, mainly because sources that it might be
4675 * reasonable to override for won't be seen while inside a function.
4677 * Note: variables marked GUC_NOT_WHILE_SEC_DEF should probably be marked
4678 * GUC_NO_RESET_ALL as well, because ResetAllOptions() doesn't check this.
4680 * Note: this flag is currently used for "session_authorization" and
4681 * "role". We need to prohibit this because when we exit the sec-def
4682 * context, GUC won't be notified, leaving things out of sync.
4684 * XXX it would be nice to allow these cases in future, with the behavior
4685 * being that the SET's effects end when the security definer context is
4688 if ((record->flags & GUC_NOT_WHILE_SEC_DEF) && InSecurityDefinerContext())
4691 (errcode(ERRCODE_INSUFFICIENT_PRIVILEGE),
4692 errmsg("cannot set parameter \"%s\" within security-definer function",
4698 * Should we set reset/stacked values? (If so, the behavior is not
4699 * transactional.) This is done either when we get a default value from
4700 * the database's/user's/client's default settings or when we reset a
4701 * value to its default.
4703 makeDefault = changeVal && (source <= PGC_S_OVERRIDE) &&
4704 ((value != NULL) || source == PGC_S_DEFAULT);
4707 * Ignore attempted set if overridden by previously processed setting.
4708 * However, if changeVal is false then plow ahead anyway since we are
4709 * trying to find out if the value is potentially good, not actually use
4710 * it. Also keep going if makeDefault is true, since we may want to set
4711 * the reset/stacked values even if we can't set the variable itself.
4713 if (record->source > source)
4715 if (changeVal && !makeDefault)
4717 elog(DEBUG3, "\"%s\": setting ignored because previous source is higher priority",
4725 * Evaluate value and set variable.
4727 switch (record->vartype)
4731 struct config_bool *conf = (struct config_bool *) record;
4736 if (!parse_bool(value, &newval))
4739 (errcode(ERRCODE_INVALID_PARAMETER_VALUE),
4740 errmsg("parameter \"%s\" requires a Boolean value",
4745 else if (source == PGC_S_DEFAULT)
4746 newval = conf->boot_val;
4749 newval = conf->reset_val;
4750 source = conf->gen.reset_source;
4753 /* Save old value to support transaction abort */
4754 if (changeVal && !makeDefault)
4755 push_old_value(&conf->gen, action);
4757 if (conf->assign_hook)
4758 if (!(*conf->assign_hook) (newval, changeVal, source))
4761 (errcode(ERRCODE_INVALID_PARAMETER_VALUE),
4762 errmsg("invalid value for parameter \"%s\": %d",
4763 name, (int) newval)));
4769 *conf->variable = newval;
4770 conf->gen.source = source;
4776 if (conf->gen.reset_source <= source)
4778 conf->reset_val = newval;
4779 conf->gen.reset_source = source;
4781 for (stack = conf->gen.stack; stack; stack = stack->prev)
4783 if (stack->source <= source)
4785 stack->prior.boolval = newval;
4786 stack->source = source;
4795 struct config_int *conf = (struct config_int *) record;
4800 const char *hintmsg;
4802 if (!parse_int(value, &newval, conf->gen.flags, &hintmsg))
4805 (errcode(ERRCODE_INVALID_PARAMETER_VALUE),
4806 errmsg("invalid value for parameter \"%s\": \"%s\"",
4808 hintmsg ? errhint("%s", _(hintmsg)) : 0));
4811 if (newval < conf->min || newval > conf->max)
4814 (errcode(ERRCODE_INVALID_PARAMETER_VALUE),
4815 errmsg("%d is outside the valid range for parameter \"%s\" (%d .. %d)",
4816 newval, name, conf->min, conf->max)));
4820 else if (source == PGC_S_DEFAULT)
4821 newval = conf->boot_val;
4824 newval = conf->reset_val;
4825 source = conf->gen.reset_source;
4828 /* Save old value to support transaction abort */
4829 if (changeVal && !makeDefault)
4830 push_old_value(&conf->gen, action);
4832 if (conf->assign_hook)
4833 if (!(*conf->assign_hook) (newval, changeVal, source))
4836 (errcode(ERRCODE_INVALID_PARAMETER_VALUE),
4837 errmsg("invalid value for parameter \"%s\": %d",
4844 *conf->variable = newval;
4845 conf->gen.source = source;
4851 if (conf->gen.reset_source <= source)
4853 conf->reset_val = newval;
4854 conf->gen.reset_source = source;
4856 for (stack = conf->gen.stack; stack; stack = stack->prev)
4858 if (stack->source <= source)
4860 stack->prior.intval = newval;
4861 stack->source = source;
4870 struct config_real *conf = (struct config_real *) record;
4875 if (!parse_real(value, &newval))
4878 (errcode(ERRCODE_INVALID_PARAMETER_VALUE),
4879 errmsg("parameter \"%s\" requires a numeric value",
4883 if (newval < conf->min || newval > conf->max)
4886 (errcode(ERRCODE_INVALID_PARAMETER_VALUE),
4887 errmsg("%g is outside the valid range for parameter \"%s\" (%g .. %g)",
4888 newval, name, conf->min, conf->max)));
4892 else if (source == PGC_S_DEFAULT)
4893 newval = conf->boot_val;
4896 newval = conf->reset_val;
4897 source = conf->gen.reset_source;
4900 /* Save old value to support transaction abort */
4901 if (changeVal && !makeDefault)
4902 push_old_value(&conf->gen, action);
4904 if (conf->assign_hook)
4905 if (!(*conf->assign_hook) (newval, changeVal, source))
4908 (errcode(ERRCODE_INVALID_PARAMETER_VALUE),
4909 errmsg("invalid value for parameter \"%s\": %g",
4916 *conf->variable = newval;
4917 conf->gen.source = source;
4923 if (conf->gen.reset_source <= source)
4925 conf->reset_val = newval;
4926 conf->gen.reset_source = source;
4928 for (stack = conf->gen.stack; stack; stack = stack->prev)
4930 if (stack->source <= source)
4932 stack->prior.realval = newval;
4933 stack->source = source;
4942 struct config_string *conf = (struct config_string *) record;
4947 newval = guc_strdup(elevel, value);
4952 * The only sort of "parsing" check we need to do is apply
4953 * truncation if GUC_IS_NAME.
4955 if (conf->gen.flags & GUC_IS_NAME)
4956 truncate_identifier(newval, strlen(newval), true);
4958 else if (source == PGC_S_DEFAULT)
4960 if (conf->boot_val == NULL)
4964 newval = guc_strdup(elevel, conf->boot_val);
4972 * We could possibly avoid strdup here, but easier to make
4973 * this case work the same as the normal assignment case;
4974 * note the possible free of newval below.
4976 if (conf->reset_val == NULL)
4980 newval = guc_strdup(elevel, conf->reset_val);
4984 source = conf->gen.reset_source;
4987 /* Save old value to support transaction abort */
4988 if (changeVal && !makeDefault)
4989 push_old_value(&conf->gen, action);
4991 if (conf->assign_hook && newval)
4993 const char *hookresult;
4996 * If the hook ereports, we have to make sure we free
4997 * newval, else it will be a permanent memory leak.
4999 hookresult = call_string_assign_hook(conf->assign_hook,
5003 if (hookresult == NULL)
5007 (errcode(ERRCODE_INVALID_PARAMETER_VALUE),
5008 errmsg("invalid value for parameter \"%s\": \"%s\"",
5009 name, value ? value : "")));
5012 else if (hookresult != newval)
5017 * Having to cast away const here is annoying, but the
5018 * alternative is to declare assign_hooks as returning
5019 * char*, which would mean they'd have to cast away
5020 * const, or as both taking and returning char*, which
5021 * doesn't seem attractive either --- we don't want
5022 * them to scribble on the passed str.
5024 newval = (char *) hookresult;
5030 set_string_field(conf, conf->variable, newval);
5031 conf->gen.source = source;
5037 if (conf->gen.reset_source <= source)
5039 set_string_field(conf, &conf->reset_val, newval);
5040 conf->gen.reset_source = source;
5042 for (stack = conf->gen.stack; stack; stack = stack->prev)
5044 if (stack->source <= source)
5046 set_string_field(conf, &stack->prior.stringval,
5048 stack->source = source;
5052 /* Perhaps we didn't install newval anywhere */
5053 if (newval && !string_field_used(conf, newval))
5059 struct config_enum *conf = (struct config_enum *) record;
5064 if (!config_enum_lookup_by_name(conf, value, &newval))
5068 hintmsg = config_enum_get_options(conf,
5069 "Available values: ",
5073 (errcode(ERRCODE_INVALID_PARAMETER_VALUE),
5074 errmsg("invalid value for parameter \"%s\": \"%s\"",
5076 hintmsg ? errhint("%s", _(hintmsg)) : 0));
5083 else if (source == PGC_S_DEFAULT)
5084 newval = conf->boot_val;
5087 newval = conf->reset_val;
5088 source = conf->gen.reset_source;
5091 /* Save old value to support transaction abort */
5092 if (changeVal && !makeDefault)
5093 push_old_value(&conf->gen, action);
5095 if (conf->assign_hook)
5096 if (!(*conf->assign_hook) (newval, changeVal, source))
5099 (errcode(ERRCODE_INVALID_PARAMETER_VALUE),
5100 errmsg("invalid value for parameter \"%s\": \"%s\"",
5102 config_enum_lookup_by_value(conf, newval))));
5108 *conf->variable = newval;
5109 conf->gen.source = source;
5115 if (conf->gen.reset_source <= source)
5117 conf->reset_val = newval;
5118 conf->gen.reset_source = source;
5120 for (stack = conf->gen.stack; stack; stack = stack->prev)
5122 if (stack->source <= source)
5124 stack->prior.enumval = newval;
5125 stack->source = source;
5133 if (changeVal && (record->flags & GUC_REPORT))
5134 ReportGUCOption(record);
5141 * Set the fields for source file and line number the setting came from.
5144 set_config_sourcefile(const char *name, char *sourcefile, int sourceline)
5146 struct config_generic *record;
5150 * To avoid cluttering the log, only the postmaster bleats loudly about
5151 * problems with the config file.
5153 elevel = IsUnderPostmaster ? DEBUG3 : LOG;
5155 record = find_option(name, true, elevel);
5156 /* should not happen */
5158 elog(ERROR, "unrecognized configuration parameter \"%s\"", name);
5160 sourcefile = guc_strdup(elevel, sourcefile);
5161 if (record->sourcefile)
5162 free(record->sourcefile);
5163 record->sourcefile = sourcefile;
5164 record->sourceline = sourceline;
5168 * Set a config option to the given value. See also set_config_option,
5169 * this is just the wrapper to be called from outside GUC. NB: this
5170 * is used only for non-transactional operations.
5172 * Note: there is no support here for setting source file/line, as it
5173 * is currently not needed.
5176 SetConfigOption(const char *name, const char *value,
5177 GucContext context, GucSource source)
5179 (void) set_config_option(name, value, context, source,
5180 GUC_ACTION_SET, true);
5186 * Fetch the current value of the option `name'. If the option doesn't exist,
5187 * throw an ereport and don't return.
5189 * If restrict_superuser is true, we also enforce that only superusers can
5190 * see GUC_SUPERUSER_ONLY variables. This should only be passed as true
5191 * in user-driven calls.
5193 * The string is *not* allocated for modification and is really only
5194 * valid until the next call to configuration related functions.
5197 GetConfigOption(const char *name, bool restrict_superuser)
5199 struct config_generic *record;
5200 static char buffer[256];
5202 record = find_option(name, false, ERROR);
5205 (errcode(ERRCODE_UNDEFINED_OBJECT),
5206 errmsg("unrecognized configuration parameter \"%s\"", name)));
5207 if (restrict_superuser &&
5208 (record->flags & GUC_SUPERUSER_ONLY) &&
5211 (errcode(ERRCODE_INSUFFICIENT_PRIVILEGE),
5212 errmsg("must be superuser to examine \"%s\"", name)));
5214 switch (record->vartype)
5217 return *((struct config_bool *) record)->variable ? "on" : "off";
5220 snprintf(buffer, sizeof(buffer), "%d",
5221 *((struct config_int *) record)->variable);
5225 snprintf(buffer, sizeof(buffer), "%g",
5226 *((struct config_real *) record)->variable);
5230 return *((struct config_string *) record)->variable;
5233 return config_enum_lookup_by_value((struct config_enum *) record,
5234 *((struct config_enum *) record)->variable);
5240 * Get the RESET value associated with the given option.
5242 * Note: this is not re-entrant, due to use of static result buffer;
5243 * not to mention that a string variable could have its reset_val changed.
5244 * Beware of assuming the result value is good for very long.
5247 GetConfigOptionResetString(const char *name)
5249 struct config_generic *record;
5250 static char buffer[256];
5252 record = find_option(name, false, ERROR);
5255 (errcode(ERRCODE_UNDEFINED_OBJECT),
5256 errmsg("unrecognized configuration parameter \"%s\"", name)));
5257 if ((record->flags & GUC_SUPERUSER_ONLY) && !superuser())
5259 (errcode(ERRCODE_INSUFFICIENT_PRIVILEGE),
5260 errmsg("must be superuser to examine \"%s\"", name)));
5262 switch (record->vartype)
5265 return ((struct config_bool *) record)->reset_val ? "on" : "off";
5268 snprintf(buffer, sizeof(buffer), "%d",
5269 ((struct config_int *) record)->reset_val);
5273 snprintf(buffer, sizeof(buffer), "%g",
5274 ((struct config_real *) record)->reset_val);
5278 return ((struct config_string *) record)->reset_val;
5281 return config_enum_lookup_by_value((struct config_enum *) record,
5282 ((struct config_enum *) record)->reset_val);
5289 * GUC_complaint_elevel
5290 * Get the ereport error level to use in an assign_hook's error report.
5292 * This should be used by assign hooks that want to emit a custom error
5293 * report (in addition to the generic "invalid value for option FOO" that
5294 * guc.c will provide). Note that the result might be ERROR or a lower
5295 * level, so the caller must be prepared for control to return from ereport,
5296 * or not. If control does return, return false/NULL from the hook function.
5298 * At some point it'd be nice to replace this with a mechanism that allows
5299 * the custom message to become the DETAIL line of guc.c's generic message.
5302 GUC_complaint_elevel(GucSource source)
5306 if (source == PGC_S_FILE)
5309 * To avoid cluttering the log, only the postmaster bleats loudly
5310 * about problems with the config file.
5312 elevel = IsUnderPostmaster ? DEBUG3 : LOG;
5314 else if (source == PGC_S_OVERRIDE)
5317 * If we're a postmaster child, this is probably "undo" during
5318 * transaction abort, so we don't want to clutter the log. There's a
5319 * small chance of a real problem with an OVERRIDE setting, though, so
5320 * suppressing the message entirely wouldn't be desirable.
5322 elevel = IsUnderPostmaster ? DEBUG5 : LOG;
5324 else if (source < PGC_S_INTERACTIVE)
5334 * flatten_set_variable_args
5335 * Given a parsenode List as emitted by the grammar for SET,
5336 * convert to the flat string representation used by GUC.
5338 * We need to be told the name of the variable the args are for, because
5339 * the flattening rules vary (ugh).
5341 * The result is NULL if args is NIL (ie, SET ... TO DEFAULT), otherwise
5342 * a palloc'd string.
5345 flatten_set_variable_args(const char *name, List *args)
5347 struct config_generic *record;
5352 /* Fast path if just DEFAULT */
5356 /* Else get flags for the variable */
5357 record = find_option(name, true, ERROR);
5360 (errcode(ERRCODE_UNDEFINED_OBJECT),
5361 errmsg("unrecognized configuration parameter \"%s\"", name)));
5363 flags = record->flags;
5365 /* Complain if list input and non-list variable */
5366 if ((flags & GUC_LIST_INPUT) == 0 &&
5367 list_length(args) != 1)
5369 (errcode(ERRCODE_INVALID_PARAMETER_VALUE),
5370 errmsg("SET %s takes only one argument", name)));
5372 initStringInfo(&buf);
5375 * Each list member may be a plain A_Const node, or an A_Const within a
5376 * TypeCast; the latter case is supported only for ConstInterval arguments
5377 * (for SET TIME ZONE).
5381 Node *arg = (Node *) lfirst(l);
5383 TypeName *typeName = NULL;
5386 if (l != list_head(args))
5387 appendStringInfo(&buf, ", ");
5389 if (IsA(arg, TypeCast))
5391 TypeCast *tc = (TypeCast *) arg;
5394 typeName = tc->typeName;
5397 if (!IsA(arg, A_Const))
5398 elog(ERROR, "unrecognized node type: %d", (int) nodeTag(arg));
5399 con = (A_Const *) arg;
5401 switch (nodeTag(&con->val))
5404 appendStringInfo(&buf, "%ld", intVal(&con->val));
5407 /* represented as a string, so just copy it */
5408 appendStringInfoString(&buf, strVal(&con->val));
5411 val = strVal(&con->val);
5412 if (typeName != NULL)
5415 * Must be a ConstInterval argument for TIME ZONE. Coerce
5416 * to interval and back to normalize the value and account
5424 typoid = typenameTypeId(NULL, typeName, &typmod);
5425 Assert(typoid == INTERVALOID);
5428 DirectFunctionCall3(interval_in,
5429 CStringGetDatum(val),
5430 ObjectIdGetDatum(InvalidOid),
5431 Int32GetDatum(typmod));
5434 DatumGetCString(DirectFunctionCall1(interval_out,
5436 appendStringInfo(&buf, "INTERVAL '%s'", intervalout);
5441 * Plain string literal or identifier. For quote mode,
5442 * quote it if it's not a vanilla identifier.
5444 if (flags & GUC_LIST_QUOTE)
5445 appendStringInfoString(&buf, quote_identifier(val));
5447 appendStringInfoString(&buf, val);
5451 elog(ERROR, "unrecognized node type: %d",
5452 (int) nodeTag(&con->val));
5465 ExecSetVariableStmt(VariableSetStmt *stmt)
5467 GucAction action = stmt->is_local ? GUC_ACTION_LOCAL : GUC_ACTION_SET;
5472 case VAR_SET_CURRENT:
5473 set_config_option(stmt->name,
5474 ExtractSetVariableArgs(stmt),
5475 (superuser() ? PGC_SUSET : PGC_USERSET),
5483 * Special case for special SQL syntax that effectively sets more
5484 * than one variable per statement.
5486 if (strcmp(stmt->name, "TRANSACTION") == 0)
5490 foreach(head, stmt->args)
5492 DefElem *item = (DefElem *) lfirst(head);
5494 if (strcmp(item->defname, "transaction_isolation") == 0)
5495 SetPGVariable("transaction_isolation",
5496 list_make1(item->arg), stmt->is_local);
5497 else if (strcmp(item->defname, "transaction_read_only") == 0)
5498 SetPGVariable("transaction_read_only",
5499 list_make1(item->arg), stmt->is_local);
5501 elog(ERROR, "unexpected SET TRANSACTION element: %s",
5505 else if (strcmp(stmt->name, "SESSION CHARACTERISTICS") == 0)
5509 foreach(head, stmt->args)
5511 DefElem *item = (DefElem *) lfirst(head);
5513 if (strcmp(item->defname, "transaction_isolation") == 0)
5514 SetPGVariable("default_transaction_isolation",
5515 list_make1(item->arg), stmt->is_local);
5516 else if (strcmp(item->defname, "transaction_read_only") == 0)
5517 SetPGVariable("default_transaction_read_only",
5518 list_make1(item->arg), stmt->is_local);
5520 elog(ERROR, "unexpected SET SESSION element: %s",
5525 elog(ERROR, "unexpected SET MULTI element: %s",
5528 case VAR_SET_DEFAULT:
5530 set_config_option(stmt->name,
5532 (superuser() ? PGC_SUSET : PGC_USERSET),
5544 * Get the value to assign for a VariableSetStmt, or NULL if it's RESET.
5545 * The result is palloc'd.
5547 * This is exported for use by actions such as ALTER ROLE SET.
5550 ExtractSetVariableArgs(VariableSetStmt *stmt)
5555 return flatten_set_variable_args(stmt->name, stmt->args);
5556 case VAR_SET_CURRENT:
5557 return GetConfigOptionByName(stmt->name, NULL);
5564 * SetPGVariable - SET command exported as an easily-C-callable function.
5566 * This provides access to SET TO value, as well as SET TO DEFAULT (expressed
5567 * by passing args == NIL), but not SET FROM CURRENT functionality.
5570 SetPGVariable(const char *name, List *args, bool is_local)
5572 char *argstring = flatten_set_variable_args(name, args);
5574 /* Note SET DEFAULT (argstring == NULL) is equivalent to RESET */
5575 set_config_option(name,
5577 (superuser() ? PGC_SUSET : PGC_USERSET),
5579 is_local ? GUC_ACTION_LOCAL : GUC_ACTION_SET,
5584 * SET command wrapped as a SQL callable function.
5587 set_config_by_name(PG_FUNCTION_ARGS)
5594 if (PG_ARGISNULL(0))
5596 (errcode(ERRCODE_NULL_VALUE_NOT_ALLOWED),
5597 errmsg("SET requires parameter name")));
5599 /* Get the GUC variable name */
5600 name = TextDatumGetCString(PG_GETARG_DATUM(0));
5602 /* Get the desired value or set to NULL for a reset request */
5603 if (PG_ARGISNULL(1))
5606 value = TextDatumGetCString(PG_GETARG_DATUM(1));
5609 * Get the desired state of is_local. Default to false if provided value
5612 if (PG_ARGISNULL(2))
5615 is_local = PG_GETARG_BOOL(2);
5617 /* Note SET DEFAULT (argstring == NULL) is equivalent to RESET */
5618 set_config_option(name,
5620 (superuser() ? PGC_SUSET : PGC_USERSET),
5622 is_local ? GUC_ACTION_LOCAL : GUC_ACTION_SET,
5625 /* get the new current value */
5626 new_value = GetConfigOptionByName(name, NULL);
5628 /* Convert return string to text */
5629 PG_RETURN_TEXT_P(cstring_to_text(new_value));
5634 * Common code for DefineCustomXXXVariable subroutines: allocate the
5635 * new variable's config struct and fill in generic fields.
5637 static struct config_generic *
5638 init_custom_variable(const char *name,
5639 const char *short_desc,
5640 const char *long_desc,
5643 enum config_type type,
5646 struct config_generic *gen;
5649 * Only allow custom PGC_POSTMASTER variables to be created during shared
5650 * library preload; any later than that, we can't ensure that the value
5651 * doesn't change after startup. This is a fatal elog if it happens; just
5652 * erroring out isn't safe because we don't know what the calling loadable
5653 * module might already have hooked into.
5655 if (context == PGC_POSTMASTER &&
5656 !process_shared_preload_libraries_in_progress)
5657 elog(FATAL, "cannot create PGC_POSTMASTER variables after startup");
5659 gen = (struct config_generic *) guc_malloc(ERROR, sz);
5662 gen->name = guc_strdup(ERROR, name);
5663 gen->context = context;
5664 gen->group = CUSTOM_OPTIONS;
5665 gen->short_desc = short_desc;
5666 gen->long_desc = long_desc;
5668 gen->vartype = type;
5674 * Common code for DefineCustomXXXVariable subroutines: insert the new
5675 * variable into the GUC variable array, replacing any placeholder.
5678 define_custom_variable(struct config_generic * variable)
5680 const char *name = variable->name;
5681 const char **nameAddr = &name;
5683 struct config_string *pHolder;
5684 GucContext phcontext;
5685 struct config_generic **res;
5688 * See if there's a placeholder by the same name.
5690 res = (struct config_generic **) bsearch((void *) &nameAddr,
5691 (void *) guc_variables,
5693 sizeof(struct config_generic *),
5698 * No placeholder to replace, so we can just add it ... but first,
5699 * make sure it's initialized to its default value.
5701 InitializeOneGUCOption(variable);
5702 add_guc_variable(variable, ERROR);
5707 * This better be a placeholder
5709 if (((*res)->flags & GUC_CUSTOM_PLACEHOLDER) == 0)
5711 (errcode(ERRCODE_INTERNAL_ERROR),
5712 errmsg("attempt to redefine parameter \"%s\"", name)));
5714 Assert((*res)->vartype == PGC_STRING);
5715 pHolder = (struct config_string *) (*res);
5718 * First, set the variable to its default value. We must do this even
5719 * though we intend to immediately apply a new value, since it's possible
5720 * that the new value is invalid.
5722 InitializeOneGUCOption(variable);
5725 * Replace the placeholder. We aren't changing the name, so no re-sorting
5731 * Infer context for assignment based on source of existing value. We
5732 * can't tell this with exact accuracy, but we can at least do something
5733 * reasonable in typical cases.
5735 switch (pHolder->gen.source)
5743 * If we got past the check in init_custom_variable, we can safely
5744 * assume that any existing value for a PGC_POSTMASTER variable
5745 * was set in postmaster context.
5747 if (variable->context == PGC_POSTMASTER)
5748 phcontext = PGC_POSTMASTER;
5750 phcontext = PGC_SIGHUP;
5752 case PGC_S_DATABASE:
5754 case PGC_S_DATABASE_USER:
5758 phcontext = PGC_USERSET;
5763 * Assign the string value stored in the placeholder to the real variable.
5765 * XXX this is not really good enough --- it should be a nontransactional
5766 * assignment, since we don't want it to roll back if the current xact
5767 * fails later. (Or do we?)
5769 value = *pHolder->variable;
5773 if (set_config_option(name, value,
5774 phcontext, pHolder->gen.source,
5775 GUC_ACTION_SET, true))
5777 /* Also copy over any saved source-location information */
5778 if (pHolder->gen.sourcefile)
5779 set_config_sourcefile(name, pHolder->gen.sourcefile,
5780 pHolder->gen.sourceline);
5785 * Free up as much as we conveniently can of the placeholder structure
5786 * (this neglects any stack items...)
5788 set_string_field(pHolder, pHolder->variable, NULL);
5789 set_string_field(pHolder, &pHolder->reset_val, NULL);
5795 DefineCustomBoolVariable(const char *name,
5796 const char *short_desc,
5797 const char *long_desc,
5802 GucBoolAssignHook assign_hook,
5803 GucShowHook show_hook)
5805 struct config_bool *var;
5807 var = (struct config_bool *)
5808 init_custom_variable(name, short_desc, long_desc, context, flags,
5809 PGC_BOOL, sizeof(struct config_bool));
5810 var->variable = valueAddr;
5811 var->boot_val = bootValue;
5812 var->reset_val = bootValue;
5813 var->assign_hook = assign_hook;
5814 var->show_hook = show_hook;
5815 define_custom_variable(&var->gen);
5819 DefineCustomIntVariable(const char *name,
5820 const char *short_desc,
5821 const char *long_desc,
5828 GucIntAssignHook assign_hook,
5829 GucShowHook show_hook)
5831 struct config_int *var;
5833 var = (struct config_int *)
5834 init_custom_variable(name, short_desc, long_desc, context, flags,
5835 PGC_INT, sizeof(struct config_int));
5836 var->variable = valueAddr;
5837 var->boot_val = bootValue;
5838 var->reset_val = bootValue;
5839 var->min = minValue;
5840 var->max = maxValue;
5841 var->assign_hook = assign_hook;
5842 var->show_hook = show_hook;
5843 define_custom_variable(&var->gen);
5847 DefineCustomRealVariable(const char *name,
5848 const char *short_desc,
5849 const char *long_desc,
5856 GucRealAssignHook assign_hook,
5857 GucShowHook show_hook)
5859 struct config_real *var;
5861 var = (struct config_real *)
5862 init_custom_variable(name, short_desc, long_desc, context, flags,
5863 PGC_REAL, sizeof(struct config_real));
5864 var->variable = valueAddr;
5865 var->boot_val = bootValue;
5866 var->reset_val = bootValue;
5867 var->min = minValue;
5868 var->max = maxValue;
5869 var->assign_hook = assign_hook;
5870 var->show_hook = show_hook;
5871 define_custom_variable(&var->gen);
5875 DefineCustomStringVariable(const char *name,
5876 const char *short_desc,
5877 const char *long_desc,
5879 const char *bootValue,
5882 GucStringAssignHook assign_hook,
5883 GucShowHook show_hook)
5885 struct config_string *var;
5887 var = (struct config_string *)
5888 init_custom_variable(name, short_desc, long_desc, context, flags,
5889 PGC_STRING, sizeof(struct config_string));
5890 var->variable = valueAddr;
5891 var->boot_val = bootValue;
5892 /* we could probably do without strdup, but keep it like normal case */
5894 var->reset_val = guc_strdup(ERROR, var->boot_val);
5895 var->assign_hook = assign_hook;
5896 var->show_hook = show_hook;
5897 define_custom_variable(&var->gen);
5901 DefineCustomEnumVariable(const char *name,
5902 const char *short_desc,
5903 const char *long_desc,
5906 const struct config_enum_entry * options,
5909 GucEnumAssignHook assign_hook,
5910 GucShowHook show_hook)
5912 struct config_enum *var;
5914 var = (struct config_enum *)
5915 init_custom_variable(name, short_desc, long_desc, context, flags,
5916 PGC_ENUM, sizeof(struct config_enum));
5917 var->variable = valueAddr;
5918 var->boot_val = bootValue;
5919 var->reset_val = bootValue;
5920 var->options = options;
5921 var->assign_hook = assign_hook;
5922 var->show_hook = show_hook;
5923 define_custom_variable(&var->gen);
5927 EmitWarningsOnPlaceholders(const char *className)
5929 int classLen = strlen(className);
5932 for (i = 0; i < num_guc_variables; i++)
5934 struct config_generic *var = guc_variables[i];
5936 if ((var->flags & GUC_CUSTOM_PLACEHOLDER) != 0 &&
5937 strncmp(className, var->name, classLen) == 0 &&
5938 var->name[classLen] == GUC_QUALIFIER_SEPARATOR)
5941 (errcode(ERRCODE_UNDEFINED_OBJECT),
5942 errmsg("unrecognized configuration parameter \"%s\"",
5953 GetPGVariable(const char *name, DestReceiver *dest)
5955 if (guc_name_compare(name, "all") == 0)
5956 ShowAllGUCConfig(dest);
5958 ShowGUCConfigOption(name, dest);
5962 GetPGVariableResultDesc(const char *name)
5966 if (guc_name_compare(name, "all") == 0)
5968 /* need a tuple descriptor representing three TEXT columns */
5969 tupdesc = CreateTemplateTupleDesc(3, false);
5970 TupleDescInitEntry(tupdesc, (AttrNumber) 1, "name",
5972 TupleDescInitEntry(tupdesc, (AttrNumber) 2, "setting",
5974 TupleDescInitEntry(tupdesc, (AttrNumber) 3, "description",
5979 const char *varname;
5981 /* Get the canonical spelling of name */
5982 (void) GetConfigOptionByName(name, &varname);
5984 /* need a tuple descriptor representing a single TEXT column */
5985 tupdesc = CreateTemplateTupleDesc(1, false);
5986 TupleDescInitEntry(tupdesc, (AttrNumber) 1, varname,
5997 ShowGUCConfigOption(const char *name, DestReceiver *dest)
5999 TupOutputState *tstate;
6001 const char *varname;
6004 /* Get the value and canonical spelling of name */
6005 value = GetConfigOptionByName(name, &varname);
6007 /* need a tuple descriptor representing a single TEXT column */
6008 tupdesc = CreateTemplateTupleDesc(1, false);
6009 TupleDescInitEntry(tupdesc, (AttrNumber) 1, varname,
6012 /* prepare for projection of tuples */
6013 tstate = begin_tup_output_tupdesc(dest, tupdesc);
6016 do_text_output_oneline(tstate, value);
6018 end_tup_output(tstate);
6025 ShowAllGUCConfig(DestReceiver *dest)
6027 bool am_superuser = superuser();
6029 TupOutputState *tstate;
6032 bool isnull[3] = { false, false, false };
6034 /* need a tuple descriptor representing three TEXT columns */
6035 tupdesc = CreateTemplateTupleDesc(3, false);
6036 TupleDescInitEntry(tupdesc, (AttrNumber) 1, "name",
6038 TupleDescInitEntry(tupdesc, (AttrNumber) 2, "setting",
6040 TupleDescInitEntry(tupdesc, (AttrNumber) 3, "description",
6043 /* prepare for projection of tuples */
6044 tstate = begin_tup_output_tupdesc(dest, tupdesc);
6046 for (i = 0; i < num_guc_variables; i++)
6048 struct config_generic *conf = guc_variables[i];
6051 if ((conf->flags & GUC_NO_SHOW_ALL) ||
6052 ((conf->flags & GUC_SUPERUSER_ONLY) && !am_superuser))
6055 /* assign to the values array */
6056 values[0] = PointerGetDatum(cstring_to_text(conf->name));
6058 setting = _ShowOption(conf, true);
6061 values[1] = PointerGetDatum(cstring_to_text(setting));
6066 values[1] = PointerGetDatum(NULL);
6070 values[2] = PointerGetDatum(cstring_to_text(conf->short_desc));
6072 /* send it to dest */
6073 do_tup_output(tstate, values, isnull);
6076 pfree(DatumGetPointer(values[0]));
6080 pfree(DatumGetPointer(values[1]));
6082 pfree(DatumGetPointer(values[2]));
6085 end_tup_output(tstate);
6089 * Return GUC variable value by name; optionally return canonical
6090 * form of name. Return value is palloc'd.
6093 GetConfigOptionByName(const char *name, const char **varname)
6095 struct config_generic *record;
6097 record = find_option(name, false, ERROR);
6100 (errcode(ERRCODE_UNDEFINED_OBJECT),
6101 errmsg("unrecognized configuration parameter \"%s\"", name)));
6102 if ((record->flags & GUC_SUPERUSER_ONLY) && !superuser())
6104 (errcode(ERRCODE_INSUFFICIENT_PRIVILEGE),
6105 errmsg("must be superuser to examine \"%s\"", name)));
6108 *varname = record->name;
6110 return _ShowOption(record, true);
6114 * Return GUC variable value by variable number; optionally return canonical
6115 * form of name. Return value is palloc'd.
6118 GetConfigOptionByNum(int varnum, const char **values, bool *noshow)
6121 struct config_generic *conf;
6123 /* check requested variable number valid */
6124 Assert((varnum >= 0) && (varnum < num_guc_variables));
6126 conf = guc_variables[varnum];
6130 if ((conf->flags & GUC_NO_SHOW_ALL) ||
6131 ((conf->flags & GUC_SUPERUSER_ONLY) && !superuser()))
6137 /* first get the generic attributes */
6140 values[0] = conf->name;
6142 /* setting : use _ShowOption in order to avoid duplicating the logic */
6143 values[1] = _ShowOption(conf, false);
6146 if (conf->vartype == PGC_INT)
6150 switch (conf->flags & (GUC_UNIT_MEMORY | GUC_UNIT_TIME))
6155 case GUC_UNIT_BLOCKS:
6156 snprintf(buf, sizeof(buf), "%dkB", BLCKSZ / 1024);
6159 case GUC_UNIT_XBLOCKS:
6160 snprintf(buf, sizeof(buf), "%dkB", XLOG_BLCKSZ / 1024);
6181 values[3] = config_group_names[conf->group];
6184 values[4] = conf->short_desc;
6187 values[5] = conf->long_desc;
6190 values[6] = GucContext_Names[conf->context];
6193 values[7] = config_type_names[conf->vartype];
6196 values[8] = GucSource_Names[conf->source];
6198 /* now get the type specifc attributes */
6199 switch (conf->vartype)
6203 struct config_bool *lconf = (struct config_bool *) conf;
6215 values[12] = pstrdup(lconf->boot_val ? "on" : "off");
6218 values[13] = pstrdup(lconf->reset_val ? "on" : "off");
6224 struct config_int *lconf = (struct config_int *) conf;
6227 snprintf(buffer, sizeof(buffer), "%d", lconf->min);
6228 values[9] = pstrdup(buffer);
6231 snprintf(buffer, sizeof(buffer), "%d", lconf->max);
6232 values[10] = pstrdup(buffer);
6238 snprintf(buffer, sizeof(buffer), "%d", lconf->boot_val);
6239 values[12] = pstrdup(buffer);
6242 snprintf(buffer, sizeof(buffer), "%d", lconf->reset_val);
6243 values[13] = pstrdup(buffer);
6249 struct config_real *lconf = (struct config_real *) conf;
6252 snprintf(buffer, sizeof(buffer), "%g", lconf->min);
6253 values[9] = pstrdup(buffer);
6256 snprintf(buffer, sizeof(buffer), "%g", lconf->max);
6257 values[10] = pstrdup(buffer);
6263 snprintf(buffer, sizeof(buffer), "%g", lconf->boot_val);
6264 values[12] = pstrdup(buffer);
6267 snprintf(buffer, sizeof(buffer), "%g", lconf->reset_val);
6268 values[13] = pstrdup(buffer);
6274 struct config_string *lconf = (struct config_string *) conf;
6286 if (lconf->boot_val == NULL)
6289 values[12] = pstrdup(lconf->boot_val);
6292 if (lconf->reset_val == NULL)
6295 values[13] = pstrdup(lconf->reset_val);
6301 struct config_enum *lconf = (struct config_enum *) conf;
6312 * NOTE! enumvals with double quotes in them are not
6315 values[11] = config_enum_get_options((struct config_enum *) conf,
6316 "{\"", "\"}", "\",\"");
6319 values[12] = pstrdup(config_enum_lookup_by_value(lconf,
6323 values[13] = pstrdup(config_enum_lookup_by_value(lconf,
6331 * should never get here, but in case we do, set 'em to NULL
6353 * If the setting came from a config file, set the source location. For
6354 * security reasons, we don't show source file/line number for
6357 if (conf->source == PGC_S_FILE && superuser())
6359 values[14] = conf->sourcefile;
6360 snprintf(buffer, sizeof(buffer), "%d", conf->sourceline);
6361 values[15] = pstrdup(buffer);
6371 * Return the total number of GUC variables
6374 GetNumConfigOptions(void)
6376 return num_guc_variables;
6380 * show_config_by_name - equiv to SHOW X command but implemented as
6384 show_config_by_name(PG_FUNCTION_ARGS)
6389 /* Get the GUC variable name */
6390 varname = TextDatumGetCString(PG_GETARG_DATUM(0));
6393 varval = GetConfigOptionByName(varname, NULL);
6395 /* Convert to text */
6396 PG_RETURN_TEXT_P(cstring_to_text(varval));
6400 * show_all_settings - equiv to SHOW ALL command but implemented as
6403 #define NUM_PG_SETTINGS_ATTS 16
6406 show_all_settings(PG_FUNCTION_ARGS)
6408 FuncCallContext *funcctx;
6412 AttInMetadata *attinmeta;
6413 MemoryContext oldcontext;
6415 /* stuff done only on the first call of the function */
6416 if (SRF_IS_FIRSTCALL())
6418 /* create a function context for cross-call persistence */
6419 funcctx = SRF_FIRSTCALL_INIT();
6422 * switch to memory context appropriate for multiple function calls
6424 oldcontext = MemoryContextSwitchTo(funcctx->multi_call_memory_ctx);
6427 * need a tuple descriptor representing NUM_PG_SETTINGS_ATTS columns
6428 * of the appropriate types
6430 tupdesc = CreateTemplateTupleDesc(NUM_PG_SETTINGS_ATTS, false);
6431 TupleDescInitEntry(tupdesc, (AttrNumber) 1, "name",
6433 TupleDescInitEntry(tupdesc, (AttrNumber) 2, "setting",
6435 TupleDescInitEntry(tupdesc, (AttrNumber) 3, "unit",
6437 TupleDescInitEntry(tupdesc, (AttrNumber) 4, "category",
6439 TupleDescInitEntry(tupdesc, (AttrNumber) 5, "short_desc",
6441 TupleDescInitEntry(tupdesc, (AttrNumber) 6, "extra_desc",
6443 TupleDescInitEntry(tupdesc, (AttrNumber) 7, "context",
6445 TupleDescInitEntry(tupdesc, (AttrNumber) 8, "vartype",
6447 TupleDescInitEntry(tupdesc, (AttrNumber) 9, "source",
6449 TupleDescInitEntry(tupdesc, (AttrNumber) 10, "min_val",
6451 TupleDescInitEntry(tupdesc, (AttrNumber) 11, "max_val",
6453 TupleDescInitEntry(tupdesc, (AttrNumber) 12, "enumvals",
6454 TEXTARRAYOID, -1, 0);
6455 TupleDescInitEntry(tupdesc, (AttrNumber) 13, "boot_val",
6457 TupleDescInitEntry(tupdesc, (AttrNumber) 14, "reset_val",
6459 TupleDescInitEntry(tupdesc, (AttrNumber) 15, "sourcefile",
6461 TupleDescInitEntry(tupdesc, (AttrNumber) 16, "sourceline",
6465 * Generate attribute metadata needed later to produce tuples from raw
6468 attinmeta = TupleDescGetAttInMetadata(tupdesc);
6469 funcctx->attinmeta = attinmeta;
6471 /* total number of tuples to be returned */
6472 funcctx->max_calls = GetNumConfigOptions();
6474 MemoryContextSwitchTo(oldcontext);
6477 /* stuff done on every call of the function */
6478 funcctx = SRF_PERCALL_SETUP();
6480 call_cntr = funcctx->call_cntr;
6481 max_calls = funcctx->max_calls;
6482 attinmeta = funcctx->attinmeta;
6484 if (call_cntr < max_calls) /* do when there is more left to send */
6486 char *values[NUM_PG_SETTINGS_ATTS];
6492 * Get the next visible GUC variable name and value
6496 GetConfigOptionByNum(call_cntr, (const char **) values, &noshow);
6499 /* bump the counter and get the next config setting */
6500 call_cntr = ++funcctx->call_cntr;
6502 /* make sure we haven't gone too far now */
6503 if (call_cntr >= max_calls)
6504 SRF_RETURN_DONE(funcctx);
6509 tuple = BuildTupleFromCStrings(attinmeta, values);
6511 /* make the tuple into a datum */
6512 result = HeapTupleGetDatum(tuple);
6514 SRF_RETURN_NEXT(funcctx, result);
6518 /* do when there is no more left */
6519 SRF_RETURN_DONE(funcctx);
6524 _ShowOption(struct config_generic * record, bool use_units)
6529 switch (record->vartype)
6533 struct config_bool *conf = (struct config_bool *) record;
6535 if (conf->show_hook)
6536 val = (*conf->show_hook) ();
6538 val = *conf->variable ? "on" : "off";
6544 struct config_int *conf = (struct config_int *) record;
6546 if (conf->show_hook)
6547 val = (*conf->show_hook) ();
6551 * Use int64 arithmetic to avoid overflows in units
6552 * conversion. If INT64_IS_BUSTED we might overflow
6553 * anyway and print bogus answers, but there are few
6554 * enough such machines that it doesn't seem worth trying
6557 int64 result = *conf->variable;
6560 if (use_units && result > 0 &&
6561 (record->flags & GUC_UNIT_MEMORY))
6563 switch (record->flags & GUC_UNIT_MEMORY)
6565 case GUC_UNIT_BLOCKS:
6566 result *= BLCKSZ / 1024;
6568 case GUC_UNIT_XBLOCKS:
6569 result *= XLOG_BLCKSZ / 1024;
6573 if (result % KB_PER_GB == 0)
6575 result /= KB_PER_GB;
6578 else if (result % KB_PER_MB == 0)
6580 result /= KB_PER_MB;
6588 else if (use_units && result > 0 &&
6589 (record->flags & GUC_UNIT_TIME))
6591 switch (record->flags & GUC_UNIT_TIME)
6597 result *= MS_PER_MIN;
6601 if (result % MS_PER_D == 0)
6606 else if (result % MS_PER_H == 0)
6611 else if (result % MS_PER_MIN == 0)
6613 result /= MS_PER_MIN;
6616 else if (result % MS_PER_S == 0)
6629 snprintf(buffer, sizeof(buffer), INT64_FORMAT "%s",
6638 struct config_real *conf = (struct config_real *) record;
6640 if (conf->show_hook)
6641 val = (*conf->show_hook) ();
6644 snprintf(buffer, sizeof(buffer), "%g",
6653 struct config_string *conf = (struct config_string *) record;
6655 if (conf->show_hook)
6656 val = (*conf->show_hook) ();
6657 else if (*conf->variable && **conf->variable)
6658 val = *conf->variable;
6666 struct config_enum *conf = (struct config_enum *) record;
6668 if (conf->show_hook)
6669 val = (*conf->show_hook) ();
6671 val = config_enum_lookup_by_value(conf, *conf->variable);
6676 /* just to keep compiler quiet */
6681 return pstrdup(val);
6686 * Attempt (badly) to detect if a proposed new GUC setting is the same
6687 * as the current value.
6689 * XXX this does not really work because it doesn't account for the
6690 * effects of canonicalization of string values by assign_hooks.
6693 is_newvalue_equal(struct config_generic * record, const char *newvalue)
6695 /* newvalue == NULL isn't supported */
6696 Assert(newvalue != NULL);
6698 switch (record->vartype)
6702 struct config_bool *conf = (struct config_bool *) record;
6705 return parse_bool(newvalue, &newval)
6706 && *conf->variable == newval;
6710 struct config_int *conf = (struct config_int *) record;
6713 return parse_int(newvalue, &newval, record->flags, NULL)
6714 && *conf->variable == newval;
6718 struct config_real *conf = (struct config_real *) record;
6721 return parse_real(newvalue, &newval)
6722 && *conf->variable == newval;
6726 struct config_string *conf = (struct config_string *) record;
6728 return *conf->variable != NULL &&
6729 strcmp(*conf->variable, newvalue) == 0;
6734 struct config_enum *conf = (struct config_enum *) record;
6737 return config_enum_lookup_by_name(conf, newvalue, &newval) &&
6738 *conf->variable == newval;
6749 * These routines dump out all non-default GUC options into a binary
6750 * file that is read by all exec'ed backends. The format is:
6752 * variable name, string, null terminated
6753 * variable value, string, null terminated
6754 * variable source, integer
6757 write_one_nondefault_variable(FILE *fp, struct config_generic * gconf)
6759 if (gconf->source == PGC_S_DEFAULT)
6762 fprintf(fp, "%s", gconf->name);
6765 switch (gconf->vartype)
6769 struct config_bool *conf = (struct config_bool *) gconf;
6771 if (*conf->variable)
6772 fprintf(fp, "true");
6774 fprintf(fp, "false");
6780 struct config_int *conf = (struct config_int *) gconf;
6782 fprintf(fp, "%d", *conf->variable);
6788 struct config_real *conf = (struct config_real *) gconf;
6790 /* Could lose precision here? */
6791 fprintf(fp, "%f", *conf->variable);
6797 struct config_string *conf = (struct config_string *) gconf;
6799 fprintf(fp, "%s", *conf->variable);
6805 struct config_enum *conf = (struct config_enum *) gconf;
6808 config_enum_lookup_by_value(conf, *conf->variable));
6815 fwrite(&gconf->source, sizeof(gconf->source), 1, fp);
6819 write_nondefault_variables(GucContext context)
6823 struct config_generic *cvc_conf;
6826 Assert(context == PGC_POSTMASTER || context == PGC_SIGHUP);
6828 elevel = (context == PGC_SIGHUP) ? LOG : ERROR;
6833 fp = AllocateFile(CONFIG_EXEC_PARAMS_NEW, "w");
6837 (errcode_for_file_access(),
6838 errmsg("could not write to file \"%s\": %m",
6839 CONFIG_EXEC_PARAMS_NEW)));
6844 * custom_variable_classes must be written out first; otherwise we might
6845 * reject custom variable values while reading the file.
6847 cvc_conf = find_option("custom_variable_classes", false, ERROR);
6849 write_one_nondefault_variable(fp, cvc_conf);
6851 for (i = 0; i < num_guc_variables; i++)
6853 struct config_generic *gconf = guc_variables[i];
6855 if (gconf != cvc_conf)
6856 write_one_nondefault_variable(fp, gconf);
6862 (errcode_for_file_access(),
6863 errmsg("could not write to file \"%s\": %m",
6864 CONFIG_EXEC_PARAMS_NEW)));
6869 * Put new file in place. This could delay on Win32, but we don't hold
6870 * any exclusive locks.
6872 rename(CONFIG_EXEC_PARAMS_NEW, CONFIG_EXEC_PARAMS);
6877 * Read string, including null byte from file
6879 * Return NULL on EOF and nothing read
6882 read_string_with_null(FILE *fp)
6891 if ((ch = fgetc(fp)) == EOF)
6896 elog(FATAL, "invalid format of exec config params file");
6899 str = guc_malloc(FATAL, maxlen);
6900 else if (i == maxlen)
6901 str = guc_realloc(FATAL, str, maxlen *= 2);
6910 * This routine loads a previous postmaster dump of its non-default
6914 read_nondefault_variables(void)
6924 fp = AllocateFile(CONFIG_EXEC_PARAMS, "r");
6927 /* File not found is fine */
6928 if (errno != ENOENT)
6930 (errcode_for_file_access(),
6931 errmsg("could not read from file \"%s\": %m",
6932 CONFIG_EXEC_PARAMS)));
6938 struct config_generic *record;
6940 if ((varname = read_string_with_null(fp)) == NULL)
6943 if ((record = find_option(varname, true, FATAL)) == NULL)
6944 elog(FATAL, "failed to locate variable %s in exec config params file", varname);
6945 if ((varvalue = read_string_with_null(fp)) == NULL)
6946 elog(FATAL, "invalid format of exec config params file");
6947 if (fread(&varsource, sizeof(varsource), 1, fp) == 0)
6948 elog(FATAL, "invalid format of exec config params file");
6950 (void) set_config_option(varname, varvalue, record->context,
6951 varsource, GUC_ACTION_SET, true);
6958 #endif /* EXEC_BACKEND */
6962 * A little "long argument" simulation, although not quite GNU
6963 * compliant. Takes a string of the form "some-option=some value" and
6964 * returns name = "some_option" and value = "some value" in malloc'ed
6965 * storage. Note that '-' is converted to '_' in the option name. If
6966 * there is no '=' in the input string then value will be NULL.
6969 ParseLongOption(const char *string, char **name, char **value)
6978 equal_pos = strcspn(string, "=");
6980 if (string[equal_pos] == '=')
6982 *name = guc_malloc(FATAL, equal_pos + 1);
6983 strlcpy(*name, string, equal_pos + 1);
6985 *value = guc_strdup(FATAL, &string[equal_pos + 1]);
6989 /* no equal sign in string */
6990 *name = guc_strdup(FATAL, string);
6994 for (cp = *name; *cp; cp++)
7001 * Handle options fetched from pg_database.datconfig, pg_authid.rolconfig,
7002 * pg_proc.proconfig, etc. Caller must specify proper context/source/action.
7004 * The array parameter must be an array of TEXT (it must not be NULL).
7007 ProcessGUCArray(ArrayType *array,
7008 GucContext context, GucSource source, GucAction action)
7012 Assert(array != NULL);
7013 Assert(ARR_ELEMTYPE(array) == TEXTOID);
7014 Assert(ARR_NDIM(array) == 1);
7015 Assert(ARR_LBOUND(array)[0] == 1);
7017 for (i = 1; i <= ARR_DIMS(array)[0]; i++)
7025 d = array_ref(array, 1, &i,
7026 -1 /* varlenarray */ ,
7027 -1 /* TEXT's typlen */ ,
7028 false /* TEXT's typbyval */ ,
7029 'i' /* TEXT's typalign */ ,
7035 s = TextDatumGetCString(d);
7037 ParseLongOption(s, &name, &value);
7041 (errcode(ERRCODE_SYNTAX_ERROR),
7042 errmsg("could not parse setting for parameter \"%s\"",
7048 (void) set_config_option(name, value, context, source, action, true);
7058 * Add an entry to an option array. The array parameter may be NULL
7059 * to indicate the current table entry is NULL.
7062 GUCArrayAdd(ArrayType *array, const char *name, const char *value)
7064 const char *varname;
7072 /* test if the option is valid */
7073 set_config_option(name, value,
7074 superuser() ? PGC_SUSET : PGC_USERSET,
7075 PGC_S_TEST, GUC_ACTION_SET, false);
7077 /* convert name to canonical spelling, so we can use plain strcmp */
7078 (void) GetConfigOptionByName(name, &varname);
7081 newval = palloc(strlen(name) + 1 + strlen(value) + 1);
7082 sprintf(newval, "%s=%s", name, value);
7083 datum = CStringGetTextDatum(newval);
7091 Assert(ARR_ELEMTYPE(array) == TEXTOID);
7092 Assert(ARR_NDIM(array) == 1);
7093 Assert(ARR_LBOUND(array)[0] == 1);
7095 index = ARR_DIMS(array)[0] + 1; /* add after end */
7097 for (i = 1; i <= ARR_DIMS(array)[0]; i++)
7102 d = array_ref(array, 1, &i,
7103 -1 /* varlenarray */ ,
7104 -1 /* TEXT's typlen */ ,
7105 false /* TEXT's typbyval */ ,
7106 'i' /* TEXT's typalign */ ,
7110 current = TextDatumGetCString(d);
7111 if (strncmp(current, newval, strlen(name) + 1) == 0)
7118 a = array_set(array, 1, &index,
7121 -1 /* varlena array */ ,
7122 -1 /* TEXT's typlen */ ,
7123 false /* TEXT's typbyval */ ,
7124 'i' /* TEXT's typalign */ );
7127 a = construct_array(&datum, 1,
7136 * Delete an entry from an option array. The array parameter may be NULL
7137 * to indicate the current table entry is NULL. Also, if the return value
7138 * is NULL then a null should be stored.
7141 GUCArrayDelete(ArrayType *array, const char *name)
7143 const char *varname;
7144 ArrayType *newarray;
7150 /* test if the option is valid */
7151 set_config_option(name, NULL,
7152 superuser() ? PGC_SUSET : PGC_USERSET,
7153 PGC_S_TEST, GUC_ACTION_SET, false);
7155 /* convert name to canonical spelling, so we can use plain strcmp */
7156 (void) GetConfigOptionByName(name, &varname);
7159 /* if array is currently null, then surely nothing to delete */
7166 for (i = 1; i <= ARR_DIMS(array)[0]; i++)
7172 d = array_ref(array, 1, &i,
7173 -1 /* varlenarray */ ,
7174 -1 /* TEXT's typlen */ ,
7175 false /* TEXT's typbyval */ ,
7176 'i' /* TEXT's typalign */ ,
7180 val = TextDatumGetCString(d);
7182 /* ignore entry if it's what we want to delete */
7183 if (strncmp(val, name, strlen(name)) == 0
7184 && val[strlen(name)] == '=')
7187 /* else add it to the output array */
7190 newarray = array_set(newarray, 1, &index,
7193 -1 /* varlenarray */ ,
7194 -1 /* TEXT's typlen */ ,
7195 false /* TEXT's typbyval */ ,
7196 'i' /* TEXT's typalign */ );
7199 newarray = construct_array(&d, 1,
7211 * assign_hook and show_hook subroutines
7215 assign_log_destination(const char *value, bool doit, GucSource source)
7222 /* Need a modifiable copy of string */
7223 rawstring = pstrdup(value);
7225 /* Parse string into list of identifiers */
7226 if (!SplitIdentifierString(rawstring, ',', &elemlist))
7228 /* syntax error in list */
7230 list_free(elemlist);
7231 ereport(GUC_complaint_elevel(source),
7232 (errcode(ERRCODE_INVALID_PARAMETER_VALUE),
7233 errmsg("invalid list syntax for parameter \"log_destination\"")));
7237 foreach(l, elemlist)
7239 char *tok = (char *) lfirst(l);
7241 if (pg_strcasecmp(tok, "stderr") == 0)
7242 newlogdest |= LOG_DESTINATION_STDERR;
7243 else if (pg_strcasecmp(tok, "csvlog") == 0)
7244 newlogdest |= LOG_DESTINATION_CSVLOG;
7246 else if (pg_strcasecmp(tok, "syslog") == 0)
7247 newlogdest |= LOG_DESTINATION_SYSLOG;
7250 else if (pg_strcasecmp(tok, "eventlog") == 0)
7251 newlogdest |= LOG_DESTINATION_EVENTLOG;
7255 ereport(GUC_complaint_elevel(source),
7256 (errcode(ERRCODE_INVALID_PARAMETER_VALUE),
7257 errmsg("unrecognized \"log_destination\" key word: \"%s\"",
7260 list_free(elemlist);
7266 Log_destination = newlogdest;
7269 list_free(elemlist);
7277 assign_syslog_facility(int newval, bool doit, GucSource source)
7280 set_syslog_parameters(syslog_ident_str ? syslog_ident_str : "postgres",
7287 assign_syslog_ident(const char *ident, bool doit, GucSource source)
7290 set_syslog_parameters(ident, syslog_facility);
7294 #endif /* HAVE_SYSLOG */
7298 assign_session_replication_role(int newval, bool doit, GucSource source)
7301 * Must flush the plan cache when changing replication role; but don't
7302 * flush unnecessarily.
7304 if (doit && SessionReplicationRole != newval)
7313 show_num_temp_buffers(void)
7316 * We show the GUC var until local buffers have been initialized, and
7317 * NLocBuffer afterwards.
7319 static char nbuf[32];
7321 sprintf(nbuf, "%d", NLocBuffer ? NLocBuffer : num_temp_buffers);
7326 assign_phony_autocommit(bool newval, bool doit, GucSource source)
7330 ereport(GUC_complaint_elevel(source),
7331 (errcode(ERRCODE_FEATURE_NOT_SUPPORTED),
7332 errmsg("SET AUTOCOMMIT TO OFF is no longer supported")));
7339 assign_custom_variable_classes(const char *newval, bool doit, GucSource source)
7342 * Check syntax. newval must be a comma separated list of identifiers.
7343 * Whitespace is allowed but removed from the result.
7345 bool hasSpaceAfterToken = false;
7346 const char *cp = newval;
7351 initStringInfo(&buf);
7352 while ((c = *cp++) != '\0')
7354 if (isspace((unsigned char) c))
7357 hasSpaceAfterToken = true;
7363 if (symLen > 0) /* terminate identifier */
7365 appendStringInfoChar(&buf, ',');
7368 hasSpaceAfterToken = false;
7372 if (hasSpaceAfterToken || !(isalnum((unsigned char) c) || c == '_'))
7375 * Syntax error due to token following space after token or
7376 * non-identifier character
7381 appendStringInfoChar(&buf, c);
7385 /* Remove stray ',' at end */
7386 if (symLen == 0 && buf.len > 0)
7387 buf.data[--buf.len] = '\0';
7389 /* GUC wants the result malloc'd */
7390 newval = guc_strdup(LOG, buf.data);
7397 assign_debug_assertions(bool newval, bool doit, GucSource source)
7399 #ifndef USE_ASSERT_CHECKING
7402 ereport(GUC_complaint_elevel(source),
7403 (errcode(ERRCODE_INVALID_PARAMETER_VALUE),
7404 errmsg("assertion checking is not supported by this build")));
7412 assign_bonjour(bool newval, bool doit, GucSource source)
7417 ereport(GUC_complaint_elevel(source),
7418 (errcode(ERRCODE_INVALID_PARAMETER_VALUE),
7419 errmsg("Bonjour is not supported by this build")));
7427 assign_ssl(bool newval, bool doit, GucSource source)
7432 ereport(GUC_complaint_elevel(source),
7433 (errcode(ERRCODE_INVALID_PARAMETER_VALUE),
7434 errmsg("SSL is not supported by this build")));
7442 assign_stage_log_stats(bool newval, bool doit, GucSource source)
7444 if (newval && log_statement_stats)
7446 ereport(GUC_complaint_elevel(source),
7447 (errcode(ERRCODE_INVALID_PARAMETER_VALUE),
7448 errmsg("cannot enable parameter when \"log_statement_stats\" is true")));
7449 /* source == PGC_S_OVERRIDE means do it anyway, eg at xact abort */
7450 if (source != PGC_S_OVERRIDE)
7457 assign_log_stats(bool newval, bool doit, GucSource source)
7460 (log_parser_stats || log_planner_stats || log_executor_stats))
7462 ereport(GUC_complaint_elevel(source),
7463 (errcode(ERRCODE_INVALID_PARAMETER_VALUE),
7464 errmsg("cannot enable \"log_statement_stats\" when "
7465 "\"log_parser_stats\", \"log_planner_stats\", "
7466 "or \"log_executor_stats\" is true")));
7467 /* source == PGC_S_OVERRIDE means do it anyway, eg at xact abort */
7468 if (source != PGC_S_OVERRIDE)
7475 assign_transaction_read_only(bool newval, bool doit, GucSource source)
7477 /* Can't go to r/w mode inside a r/o transaction */
7478 if (newval == false && XactReadOnly && IsSubTransaction())
7480 ereport(GUC_complaint_elevel(source),
7481 (errcode(ERRCODE_INVALID_PARAMETER_VALUE),
7482 errmsg("cannot set transaction read-write mode inside a read-only transaction")));
7483 /* source == PGC_S_OVERRIDE means do it anyway, eg at xact abort */
7484 if (source != PGC_S_OVERRIDE)
7491 assign_canonical_path(const char *newval, bool doit, GucSource source)
7495 char *canon_val = guc_strdup(ERROR, newval);
7497 canonicalize_path(canon_val);
7505 assign_timezone_abbreviations(const char *newval, bool doit, GucSource source)
7508 * The powerup value shown above for timezone_abbreviations is "UNKNOWN".
7509 * When we see this we just do nothing. If this value isn't overridden
7510 * from the config file then pg_timezone_abbrev_initialize() will
7511 * eventually replace it with "Default". This hack has two purposes: to
7512 * avoid wasting cycles loading values that might soon be overridden from
7513 * the config file, and to avoid trying to read the timezone abbrev files
7514 * during InitializeGUCOptions(). The latter doesn't work in an
7515 * EXEC_BACKEND subprocess because my_exec_path hasn't been set yet and so
7516 * we can't locate PGSHAREDIR. (Essentially the same hack is used to
7517 * delay initializing TimeZone ... if we have any more, we should try to
7518 * clean up and centralize this mechanism ...)
7520 if (strcmp(newval, "UNKNOWN") == 0)
7525 /* Loading abbrev file is expensive, so only do it when value changes */
7526 if (timezone_abbreviations_string == NULL ||
7527 strcmp(timezone_abbreviations_string, newval) != 0)
7532 * If reading config file, only the postmaster should bleat loudly
7533 * about problems. Otherwise, it's just this one process doing it,
7534 * and we use WARNING message level.
7536 if (source == PGC_S_FILE)
7537 elevel = IsUnderPostmaster ? DEBUG3 : LOG;
7540 if (!load_tzoffsets(newval, doit, elevel))
7547 * pg_timezone_abbrev_initialize --- set default value if not done already
7549 * This is called after initial loading of postgresql.conf. If no
7550 * timezone_abbreviations setting was found therein, select default.
7553 pg_timezone_abbrev_initialize(void)
7555 if (strcmp(timezone_abbreviations_string, "UNKNOWN") == 0)
7557 SetConfigOption("timezone_abbreviations", "Default",
7558 PGC_POSTMASTER, PGC_S_ARGV);
7563 show_archive_command(void)
7565 if (XLogArchiveMode)
7566 return XLogArchiveCommand;
7568 return "(disabled)";
7572 assign_tcp_keepalives_idle(int newval, bool doit, GucSource source)
7575 return (pq_setkeepalivesidle(newval, MyProcPort) == STATUS_OK);
7581 show_tcp_keepalives_idle(void)
7583 static char nbuf[16];
7585 snprintf(nbuf, sizeof(nbuf), "%d", pq_getkeepalivesidle(MyProcPort));
7590 assign_tcp_keepalives_interval(int newval, bool doit, GucSource source)
7593 return (pq_setkeepalivesinterval(newval, MyProcPort) == STATUS_OK);
7599 show_tcp_keepalives_interval(void)
7601 static char nbuf[16];
7603 snprintf(nbuf, sizeof(nbuf), "%d", pq_getkeepalivesinterval(MyProcPort));
7608 assign_tcp_keepalives_count(int newval, bool doit, GucSource source)
7611 return (pq_setkeepalivescount(newval, MyProcPort) == STATUS_OK);
7617 show_tcp_keepalives_count(void)
7619 static char nbuf[16];
7621 snprintf(nbuf, sizeof(nbuf), "%d", pq_getkeepalivescount(MyProcPort));
7626 assign_maxconnections(int newval, bool doit, GucSource source)
7628 if (newval + autovacuum_max_workers + 1 > INT_MAX / 4)
7632 MaxBackends = newval + autovacuum_max_workers + 1;
7638 assign_autovacuum_max_workers(int newval, bool doit, GucSource source)
7640 if (MaxConnections + newval + 1 > INT_MAX / 4)
7644 MaxBackends = MaxConnections + newval + 1;
7650 assign_effective_io_concurrency(int newval, bool doit, GucSource source)
7653 double new_prefetch_pages = 0.0;
7657 * The user-visible GUC parameter is the number of drives (spindles),
7658 * which we need to translate to a number-of-pages-to-prefetch target.
7660 * The expected number of prefetch pages needed to keep N drives busy is:
7662 * drives | I/O requests
7663 * -------+----------------
7666 * 3 | 3/1 + 3/2 + 3/3 = 5 1/2
7667 * 4 | 4/1 + 4/2 + 4/3 + 4/4 = 8 1/3
7670 * This is called the "coupon collector problem" and H(n) is called the
7671 * harmonic series. This could be approximated by n * ln(n), but for
7672 * reasonable numbers of drives we might as well just compute the series.
7674 * Alternatively we could set the target to the number of pages necessary
7675 * so that the expected number of active spindles is some arbitrary
7676 * percentage of the total. This sounds the same but is actually slightly
7677 * different. The result ends up being ln(1-P)/ln((n-1)/n) where P is
7678 * that desired fraction.
7680 * Experimental results show that both of these formulas aren't aggressive
7681 * enough, but we don't really have any better proposals.
7683 * Note that if newval = 0 (disabled), we must set target = 0.
7687 for (i = 1; i <= newval; i++)
7688 new_prefetch_pages += (double) newval / (double) i;
7690 /* This range check shouldn't fail, but let's be paranoid */
7691 if (new_prefetch_pages >= 0.0 && new_prefetch_pages < (double) INT_MAX)
7694 target_prefetch_pages = (int) rint(new_prefetch_pages);
7701 #endif /* USE_PREFETCH */
7705 assign_pgstat_temp_directory(const char *newval, bool doit, GucSource source)
7709 char *canon_val = guc_strdup(ERROR, newval);
7713 canonicalize_path(canon_val);
7715 tname = guc_malloc(ERROR, strlen(canon_val) + 12); /* /pgstat.tmp */
7716 sprintf(tname, "%s/pgstat.tmp", canon_val);
7717 fname = guc_malloc(ERROR, strlen(canon_val) + 13); /* /pgstat.stat */
7718 sprintf(fname, "%s/pgstat.stat", canon_val);
7720 if (pgstat_stat_tmpname)
7721 free(pgstat_stat_tmpname);
7722 pgstat_stat_tmpname = tname;
7723 if (pgstat_stat_filename)
7724 free(pgstat_stat_filename);
7725 pgstat_stat_filename = fname;
7734 assign_application_name(const char *newval, bool doit, GucSource source)
7738 /* Only allow clean ASCII chars in the application name */
7739 char *repval = guc_strdup(ERROR, newval);
7742 for (p = repval; *p; p++)
7744 if (*p < 32 || *p > 126)
7748 /* Update the pg_stat_activity view */
7749 pgstat_report_appname(repval);
7757 #include "guc-file.c"