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-2008, PostgreSQL Global Development Group
10 * Written by Peter Eisentraut <peter_e@gmx.net>.
13 * $PostgreSQL: pgsql/src/backend/utils/misc/guc.c,v 1.449 2008/04/29 20:44:49 tgl Exp $
15 *--------------------------------------------------------------------
28 #include "access/gin.h"
29 #include "access/transam.h"
30 #include "access/twophase.h"
31 #include "access/xact.h"
32 #include "catalog/namespace.h"
33 #include "commands/async.h"
34 #include "commands/prepare.h"
35 #include "commands/vacuum.h"
36 #include "commands/variable.h"
37 #include "commands/trigger.h"
39 #include "libpq/auth.h"
40 #include "libpq/pqformat.h"
41 #include "miscadmin.h"
42 #include "optimizer/cost.h"
43 #include "optimizer/geqo.h"
44 #include "optimizer/paths.h"
45 #include "optimizer/planmain.h"
46 #include "parser/gramparse.h"
47 #include "parser/parse_expr.h"
48 #include "parser/parse_relation.h"
49 #include "parser/parse_type.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 "regex/regex.h"
58 #include "storage/fd.h"
59 #include "storage/freespace.h"
60 #include "tcop/tcopprot.h"
61 #include "tsearch/ts_cache.h"
62 #include "utils/builtins.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;
132 static const char *assign_log_destination(const char *value,
133 bool doit, GucSource source);
136 static int syslog_facility = LOG_LOCAL0;
138 static bool assign_syslog_facility(int newval,
139 bool doit, GucSource source);
140 static const char *assign_syslog_ident(const char *ident,
141 bool doit, GucSource source);
144 static bool assign_session_replication_role(int newval, bool doit,
146 static const char *show_num_temp_buffers(void);
147 static bool assign_phony_autocommit(bool newval, bool doit, GucSource source);
148 static const char *assign_custom_variable_classes(const char *newval, bool doit,
150 static bool assign_debug_assertions(bool newval, bool doit, GucSource source);
151 static bool assign_ssl(bool newval, bool doit, GucSource source);
152 static bool assign_stage_log_stats(bool newval, bool doit, GucSource source);
153 static bool assign_log_stats(bool newval, bool doit, GucSource source);
154 static bool assign_transaction_read_only(bool newval, bool doit, GucSource source);
155 static const char *assign_canonical_path(const char *newval, bool doit, GucSource source);
156 static const char *assign_timezone_abbreviations(const char *newval, bool doit, GucSource source);
157 static const char *show_archive_command(void);
158 static bool assign_tcp_keepalives_idle(int newval, bool doit, GucSource source);
159 static bool assign_tcp_keepalives_interval(int newval, bool doit, GucSource source);
160 static bool assign_tcp_keepalives_count(int newval, bool doit, GucSource source);
161 static const char *show_tcp_keepalives_idle(void);
162 static const char *show_tcp_keepalives_interval(void);
163 static const char *show_tcp_keepalives_count(void);
164 static bool assign_autovacuum_max_workers(int newval, bool doit, GucSource source);
165 static bool assign_maxconnections(int newval, bool doit, GucSource source);
167 static char *config_enum_get_options(struct config_enum *record,
168 const char *prefix, const char *suffix);
173 * Options for enum values defined in this module.
175 static const struct config_enum_entry message_level_options[] = {
185 {"warning", WARNING},
192 static const struct config_enum_entry log_error_verbosity_options[] = {
193 {"default", PGERROR_DEFAULT},
194 {"terse", PGERROR_TERSE},
195 {"verbose", PGERROR_VERBOSE},
199 static const struct config_enum_entry log_statement_options[] = {
200 {"none", LOGSTMT_NONE},
201 {"ddl", LOGSTMT_DDL},
202 {"mod", LOGSTMT_MOD},
203 {"all", LOGSTMT_ALL},
207 static const struct config_enum_entry regex_flavor_options[] = {
208 {"advanced", REG_ADVANCED},
209 {"extended", REG_EXTENDED},
210 {"basic", REG_BASIC},
214 static const struct config_enum_entry isolation_level_options[] = {
215 {"serializable", XACT_SERIALIZABLE},
216 {"repeatable read", XACT_REPEATABLE_READ},
217 {"read committed", XACT_READ_COMMITTED},
218 {"read uncommitted", XACT_READ_UNCOMMITTED},
222 static const struct config_enum_entry session_replication_role_options[] = {
223 {"origin", SESSION_REPLICATION_ROLE_ORIGIN},
224 {"replica", SESSION_REPLICATION_ROLE_REPLICA},
225 {"local", SESSION_REPLICATION_ROLE_LOCAL},
230 static const struct config_enum_entry syslog_facility_options[] = {
231 {"local0", LOG_LOCAL0},
232 {"local1", LOG_LOCAL1},
233 {"local2", LOG_LOCAL2},
234 {"local3", LOG_LOCAL3},
235 {"local4", LOG_LOCAL4},
236 {"local5", LOG_LOCAL5},
237 {"local6", LOG_LOCAL6},
238 {"local7", LOG_LOCAL7},
243 static const struct config_enum_entry xmlbinary_options[] = {
244 {"base64", XMLBINARY_BASE64},
245 {"hex", XMLBINARY_HEX},
249 static const struct config_enum_entry xmloption_options[] = {
250 {"content", XMLOPTION_CONTENT},
251 {"document", XMLOPTION_DOCUMENT},
256 * Although only "on", "off", and "safe_encoding" are documented, we
257 * accept all the likely variants of "on" and "off".
259 static const struct config_enum_entry backslash_quote_options[] = {
260 {"safe_encoding", BACKSLASH_QUOTE_SAFE_ENCODING},
261 {"on", BACKSLASH_QUOTE_ON},
262 {"off", BACKSLASH_QUOTE_OFF},
263 {"true", BACKSLASH_QUOTE_ON},
264 {"false", BACKSLASH_QUOTE_OFF},
265 {"yes", BACKSLASH_QUOTE_ON},
266 {"no", BACKSLASH_QUOTE_OFF},
267 {"1", BACKSLASH_QUOTE_ON},
268 {"0", BACKSLASH_QUOTE_OFF},
273 * GUC option variables that are exported from this module
275 #ifdef USE_ASSERT_CHECKING
276 bool assert_enabled = true;
278 bool assert_enabled = false;
280 bool log_duration = false;
281 bool Debug_print_plan = false;
282 bool Debug_print_parse = false;
283 bool Debug_print_rewritten = false;
284 bool Debug_pretty_print = false;
286 bool log_parser_stats = false;
287 bool log_planner_stats = false;
288 bool log_executor_stats = false;
289 bool log_statement_stats = false; /* this is sort of all three
291 bool log_btree_build_stats = false;
293 bool check_function_bodies = true;
294 bool default_with_oids = false;
295 bool SQL_inheritance = true;
297 bool Password_encryption = true;
299 int log_min_error_statement = ERROR;
300 int log_min_messages = WARNING;
301 int client_min_messages = NOTICE;
302 int log_min_duration_statement = -1;
303 int log_temp_files = -1;
305 int num_temp_buffers = 1000;
307 char *ConfigFileName;
310 char *external_pid_file;
312 int tcp_keepalives_idle;
313 int tcp_keepalives_interval;
314 int tcp_keepalives_count;
317 * These variables are all dummies that don't do anything, except in some
318 * cases provide the value for SHOW to display. The real state is elsewhere
319 * and is kept in sync by assign_hooks.
321 static char *log_destination_string;
324 static char *syslog_ident_str;
326 static bool phony_autocommit;
327 static bool session_auth_is_superuser;
328 static double phony_random_seed;
329 static char *client_encoding_string;
330 static char *datestyle_string;
331 static char *locale_collate;
332 static char *locale_ctype;
333 static char *server_encoding_string;
334 static char *server_version_string;
335 static int server_version_num;
336 static char *timezone_string;
337 static char *log_timezone_string;
338 static char *timezone_abbreviations_string;
339 static char *XactIsoLevel_string;
340 static char *data_directory;
341 static char *custom_variable_classes;
342 static int max_function_args;
343 static int max_index_keys;
344 static int max_identifier_length;
345 static int block_size;
346 static bool integer_datetimes;
348 /* should be static, but commands/variable.c needs to get at these */
350 char *session_authorization_string;
354 * Displayable names for context types (enum GucContext)
356 * Note: these strings are deliberately not localized.
358 const char *const GucContext_Names[] =
360 /* PGC_INTERNAL */ "internal",
361 /* PGC_POSTMASTER */ "postmaster",
362 /* PGC_SIGHUP */ "sighup",
363 /* PGC_BACKEND */ "backend",
364 /* PGC_SUSET */ "superuser",
365 /* PGC_USERSET */ "user"
369 * Displayable names for source types (enum GucSource)
371 * Note: these strings are deliberately not localized.
373 const char *const GucSource_Names[] =
375 /* PGC_S_DEFAULT */ "default",
376 /* PGC_S_ENV_VAR */ "environment variable",
377 /* PGC_S_FILE */ "configuration file",
378 /* PGC_S_ARGV */ "command line",
379 /* PGC_S_DATABASE */ "database",
380 /* PGC_S_USER */ "user",
381 /* PGC_S_CLIENT */ "client",
382 /* PGC_S_OVERRIDE */ "override",
383 /* PGC_S_INTERACTIVE */ "interactive",
384 /* PGC_S_TEST */ "test",
385 /* PGC_S_SESSION */ "session"
389 * Displayable names for the groupings defined in enum config_group
391 const char *const config_group_names[] =
394 gettext_noop("Ungrouped"),
396 gettext_noop("File Locations"),
398 gettext_noop("Connections and Authentication"),
399 /* CONN_AUTH_SETTINGS */
400 gettext_noop("Connections and Authentication / Connection Settings"),
401 /* CONN_AUTH_SECURITY */
402 gettext_noop("Connections and Authentication / Security and Authentication"),
404 gettext_noop("Resource Usage"),
406 gettext_noop("Resource Usage / Memory"),
408 gettext_noop("Resource Usage / Free Space Map"),
409 /* RESOURCES_KERNEL */
410 gettext_noop("Resource Usage / Kernel Resources"),
412 gettext_noop("Write-Ahead Log"),
414 gettext_noop("Write-Ahead Log / Settings"),
415 /* WAL_CHECKPOINTS */
416 gettext_noop("Write-Ahead Log / Checkpoints"),
418 gettext_noop("Query Tuning"),
419 /* QUERY_TUNING_METHOD */
420 gettext_noop("Query Tuning / Planner Method Configuration"),
421 /* QUERY_TUNING_COST */
422 gettext_noop("Query Tuning / Planner Cost Constants"),
423 /* QUERY_TUNING_GEQO */
424 gettext_noop("Query Tuning / Genetic Query Optimizer"),
425 /* QUERY_TUNING_OTHER */
426 gettext_noop("Query Tuning / Other Planner Options"),
428 gettext_noop("Reporting and Logging"),
430 gettext_noop("Reporting and Logging / Where to Log"),
432 gettext_noop("Reporting and Logging / When to Log"),
434 gettext_noop("Reporting and Logging / What to Log"),
436 gettext_noop("Statistics"),
437 /* STATS_MONITORING */
438 gettext_noop("Statistics / Monitoring"),
439 /* STATS_COLLECTOR */
440 gettext_noop("Statistics / Query and Index Statistics Collector"),
442 gettext_noop("Autovacuum"),
444 gettext_noop("Client Connection Defaults"),
445 /* CLIENT_CONN_STATEMENT */
446 gettext_noop("Client Connection Defaults / Statement Behavior"),
447 /* CLIENT_CONN_LOCALE */
448 gettext_noop("Client Connection Defaults / Locale and Formatting"),
449 /* CLIENT_CONN_OTHER */
450 gettext_noop("Client Connection Defaults / Other Defaults"),
451 /* LOCK_MANAGEMENT */
452 gettext_noop("Lock Management"),
454 gettext_noop("Version and Platform Compatibility"),
455 /* COMPAT_OPTIONS_PREVIOUS */
456 gettext_noop("Version and Platform Compatibility / Previous PostgreSQL Versions"),
457 /* COMPAT_OPTIONS_CLIENT */
458 gettext_noop("Version and Platform Compatibility / Other Platforms and Clients"),
460 gettext_noop("Preset Options"),
462 gettext_noop("Customized Options"),
463 /* DEVELOPER_OPTIONS */
464 gettext_noop("Developer Options"),
465 /* help_config wants this array to be null-terminated */
470 * Displayable names for GUC variable types (enum config_type)
472 * Note: these strings are deliberately not localized.
474 const char *const config_type_names[] =
476 /* PGC_BOOL */ "bool",
477 /* PGC_INT */ "integer",
478 /* PGC_REAL */ "real",
479 /* PGC_STRING */ "string",
480 /* PGC_ENUM */ "enum"
485 * Contents of GUC tables
487 * See src/backend/utils/misc/README for design notes.
491 * 1. Declare a global variable of type bool, int, double, or char*
492 * and make use of it.
494 * 2. Decide at what times it's safe to set the option. See guc.h for
497 * 3. Decide on a name, a default value, upper and lower bounds (if
500 * 4. Add a record below.
502 * 5. Add it to src/backend/utils/misc/postgresql.conf.sample, if
505 * 6. Don't forget to document the option (at least in config.sgml).
507 * 7. If it's a new GUC_LIST option you must edit pg_dumpall.c to ensure
508 * it is not single quoted at dump time.
512 /******** option records follow ********/
514 static struct config_bool ConfigureNamesBool[] =
517 {"enable_seqscan", PGC_USERSET, QUERY_TUNING_METHOD,
518 gettext_noop("Enables the planner's use of sequential-scan plans."),
525 {"enable_indexscan", PGC_USERSET, QUERY_TUNING_METHOD,
526 gettext_noop("Enables the planner's use of index-scan plans."),
533 {"enable_bitmapscan", PGC_USERSET, QUERY_TUNING_METHOD,
534 gettext_noop("Enables the planner's use of bitmap-scan plans."),
541 {"enable_tidscan", PGC_USERSET, QUERY_TUNING_METHOD,
542 gettext_noop("Enables the planner's use of TID scan plans."),
549 {"enable_sort", PGC_USERSET, QUERY_TUNING_METHOD,
550 gettext_noop("Enables the planner's use of explicit sort steps."),
557 {"enable_hashagg", PGC_USERSET, QUERY_TUNING_METHOD,
558 gettext_noop("Enables the planner's use of hashed aggregation plans."),
565 {"enable_nestloop", PGC_USERSET, QUERY_TUNING_METHOD,
566 gettext_noop("Enables the planner's use of nested-loop join plans."),
573 {"enable_mergejoin", PGC_USERSET, QUERY_TUNING_METHOD,
574 gettext_noop("Enables the planner's use of merge join plans."),
581 {"enable_hashjoin", PGC_USERSET, QUERY_TUNING_METHOD,
582 gettext_noop("Enables the planner's use of hash join plans."),
589 {"constraint_exclusion", PGC_USERSET, QUERY_TUNING_OTHER,
590 gettext_noop("Enables the planner to use constraints to optimize queries."),
591 gettext_noop("Child table scans will be skipped if their "
592 "constraints guarantee that no rows match the query.")
594 &constraint_exclusion,
598 {"geqo", PGC_USERSET, QUERY_TUNING_GEQO,
599 gettext_noop("Enables genetic query optimization."),
600 gettext_noop("This algorithm attempts to do planning without "
601 "exhaustive searching.")
607 /* Not for general use --- used by SET SESSION AUTHORIZATION */
608 {"is_superuser", PGC_INTERNAL, UNGROUPED,
609 gettext_noop("Shows whether the current user is a superuser."),
611 GUC_REPORT | GUC_NO_SHOW_ALL | GUC_NO_RESET_ALL | GUC_NOT_IN_SAMPLE | GUC_DISALLOW_IN_FILE
613 &session_auth_is_superuser,
617 {"ssl", PGC_POSTMASTER, CONN_AUTH_SECURITY,
618 gettext_noop("Enables SSL connections."),
622 false, assign_ssl, NULL
625 {"fsync", PGC_SIGHUP, WAL_SETTINGS,
626 gettext_noop("Forces synchronization of updates to disk."),
627 gettext_noop("The server will use the fsync() system call in several places to make "
628 "sure that updates are physically written to disk. This insures "
629 "that a database cluster will recover to a consistent state after "
630 "an operating system or hardware crash.")
636 {"synchronous_commit", PGC_USERSET, WAL_SETTINGS,
637 gettext_noop("Sets immediate fsync at commit."),
644 {"zero_damaged_pages", PGC_SUSET, DEVELOPER_OPTIONS,
645 gettext_noop("Continues processing past damaged page headers."),
646 gettext_noop("Detection of a damaged page header normally causes PostgreSQL to "
647 "report an error, aborting the current transaction. Setting "
648 "zero_damaged_pages to true causes the system to instead report a "
649 "warning, zero out the damaged page, and continue processing. This "
650 "behavior will destroy data, namely all the rows on the damaged page."),
657 {"full_page_writes", PGC_SIGHUP, WAL_SETTINGS,
658 gettext_noop("Writes full pages to WAL when first modified after a checkpoint."),
659 gettext_noop("A page write in process during an operating system crash might be "
660 "only partially written to disk. During recovery, the row changes "
661 "stored in WAL are not enough to recover. This option writes "
662 "pages when first modified after a checkpoint to WAL so full recovery "
669 {"silent_mode", PGC_POSTMASTER, LOGGING_WHEN,
670 gettext_noop("Runs the server silently."),
671 gettext_noop("If this parameter is set, the server will automatically run in the "
672 "background and any controlling terminals are dissociated.")
678 {"log_checkpoints", PGC_SIGHUP, LOGGING_WHAT,
679 gettext_noop("Logs each checkpoint."),
686 {"log_connections", PGC_BACKEND, LOGGING_WHAT,
687 gettext_noop("Logs each successful connection."),
694 {"log_disconnections", PGC_BACKEND, LOGGING_WHAT,
695 gettext_noop("Logs end of a session, including duration."),
702 {"debug_assertions", PGC_USERSET, DEVELOPER_OPTIONS,
703 gettext_noop("Turns on various assertion checks."),
704 gettext_noop("This is a debugging aid."),
708 #ifdef USE_ASSERT_CHECKING
713 assign_debug_assertions, NULL
716 /* currently undocumented, so don't show in SHOW ALL */
717 {"exit_on_error", PGC_USERSET, UNGROUPED,
718 gettext_noop("No description available."),
720 GUC_NO_SHOW_ALL | GUC_NOT_IN_SAMPLE
726 {"log_duration", PGC_SUSET, LOGGING_WHAT,
727 gettext_noop("Logs the duration of each completed SQL statement."),
734 {"debug_print_parse", PGC_USERSET, LOGGING_WHAT,
735 gettext_noop("Prints the parse tree to the server log."),
742 {"debug_print_rewritten", PGC_USERSET, LOGGING_WHAT,
743 gettext_noop("Prints the parse tree after rewriting to server log."),
746 &Debug_print_rewritten,
750 {"debug_print_plan", PGC_USERSET, LOGGING_WHAT,
751 gettext_noop("Prints the execution plan to server log."),
758 {"debug_pretty_print", PGC_USERSET, LOGGING_WHAT,
759 gettext_noop("Indents parse and plan tree displays."),
766 {"log_parser_stats", PGC_SUSET, STATS_MONITORING,
767 gettext_noop("Writes parser performance statistics to the server log."),
771 false, assign_stage_log_stats, NULL
774 {"log_planner_stats", PGC_SUSET, STATS_MONITORING,
775 gettext_noop("Writes planner performance statistics to the server log."),
779 false, assign_stage_log_stats, NULL
782 {"log_executor_stats", PGC_SUSET, STATS_MONITORING,
783 gettext_noop("Writes executor performance statistics to the server log."),
787 false, assign_stage_log_stats, NULL
790 {"log_statement_stats", PGC_SUSET, STATS_MONITORING,
791 gettext_noop("Writes cumulative performance statistics to the server log."),
794 &log_statement_stats,
795 false, assign_log_stats, NULL
797 #ifdef BTREE_BUILD_STATS
799 {"log_btree_build_stats", PGC_SUSET, DEVELOPER_OPTIONS,
800 gettext_noop("No description available."),
804 &log_btree_build_stats,
810 {"track_activities", PGC_SUSET, STATS_COLLECTOR,
811 gettext_noop("Collects information about executing commands."),
812 gettext_noop("Enables the collection of information on the currently "
813 "executing command of each session, along with "
814 "the time at which that command began execution.")
816 &pgstat_track_activities,
820 {"track_counts", PGC_SUSET, STATS_COLLECTOR,
821 gettext_noop("Collects statistics on database activity."),
824 &pgstat_track_counts,
829 {"update_process_title", PGC_SUSET, STATS_COLLECTOR,
830 gettext_noop("Updates the process title to show the active SQL command."),
831 gettext_noop("Enables updating of the process title every time a new SQL command is received by the server.")
833 &update_process_title,
838 {"autovacuum", PGC_SIGHUP, AUTOVACUUM,
839 gettext_noop("Starts the autovacuum subprocess."),
842 &autovacuum_start_daemon,
847 {"trace_notify", PGC_USERSET, DEVELOPER_OPTIONS,
848 gettext_noop("Generates debugging output for LISTEN and NOTIFY."),
858 {"trace_locks", PGC_SUSET, DEVELOPER_OPTIONS,
859 gettext_noop("No description available."),
867 {"trace_userlocks", PGC_SUSET, DEVELOPER_OPTIONS,
868 gettext_noop("No description available."),
876 {"trace_lwlocks", PGC_SUSET, DEVELOPER_OPTIONS,
877 gettext_noop("No description available."),
885 {"debug_deadlocks", PGC_SUSET, DEVELOPER_OPTIONS,
886 gettext_noop("No description available."),
896 {"log_lock_waits", PGC_SUSET, LOGGING_WHAT,
897 gettext_noop("Logs long lock waits."),
905 {"log_hostname", PGC_SIGHUP, LOGGING_WHAT,
906 gettext_noop("Logs the host name in the connection logs."),
907 gettext_noop("By default, connection logs only show the IP address "
908 "of the connecting host. If you want them to show the host name you "
909 "can turn this on, but depending on your host name resolution "
910 "setup it might impose a non-negligible performance penalty.")
916 {"sql_inheritance", PGC_USERSET, COMPAT_OPTIONS_PREVIOUS,
917 gettext_noop("Causes subtables to be included by default in various commands."),
924 {"password_encryption", PGC_USERSET, CONN_AUTH_SECURITY,
925 gettext_noop("Encrypt passwords."),
926 gettext_noop("When a password is specified in CREATE USER or "
927 "ALTER USER without writing either ENCRYPTED or UNENCRYPTED, "
928 "this parameter determines whether the password is to be encrypted.")
930 &Password_encryption,
934 {"transform_null_equals", PGC_USERSET, COMPAT_OPTIONS_CLIENT,
935 gettext_noop("Treats \"expr=NULL\" as \"expr IS NULL\"."),
936 gettext_noop("When turned on, expressions of the form expr = NULL "
937 "(or NULL = expr) are treated as expr IS NULL, that is, they "
938 "return true if expr evaluates to the null value, and false "
939 "otherwise. The correct behavior of expr = NULL is to always "
940 "return null (unknown).")
942 &Transform_null_equals,
946 {"db_user_namespace", PGC_SIGHUP, CONN_AUTH_SECURITY,
947 gettext_noop("Enables per-database user names."),
954 /* only here for backwards compatibility */
955 {"autocommit", PGC_USERSET, CLIENT_CONN_STATEMENT,
956 gettext_noop("This parameter doesn't do anything."),
957 gettext_noop("It's just here so that we won't choke on SET AUTOCOMMIT TO ON from 7.3-vintage clients."),
958 GUC_NO_SHOW_ALL | GUC_NOT_IN_SAMPLE
961 true, assign_phony_autocommit, NULL
964 {"default_transaction_read_only", PGC_USERSET, CLIENT_CONN_STATEMENT,
965 gettext_noop("Sets the default read-only status of new transactions."),
968 &DefaultXactReadOnly,
972 {"transaction_read_only", PGC_USERSET, CLIENT_CONN_STATEMENT,
973 gettext_noop("Sets the current transaction's read-only status."),
975 GUC_NO_RESET_ALL | GUC_NOT_IN_SAMPLE | GUC_DISALLOW_IN_FILE
978 false, assign_transaction_read_only, NULL
981 {"add_missing_from", PGC_USERSET, COMPAT_OPTIONS_PREVIOUS,
982 gettext_noop("Automatically adds missing table references to FROM clauses."),
989 {"check_function_bodies", PGC_USERSET, CLIENT_CONN_STATEMENT,
990 gettext_noop("Check function bodies during CREATE FUNCTION."),
993 &check_function_bodies,
997 {"array_nulls", PGC_USERSET, COMPAT_OPTIONS_PREVIOUS,
998 gettext_noop("Enable input of NULL elements in arrays."),
999 gettext_noop("When turned on, unquoted NULL in an array input "
1000 "value means a null value; "
1001 "otherwise it is taken literally.")
1007 {"default_with_oids", PGC_USERSET, COMPAT_OPTIONS_PREVIOUS,
1008 gettext_noop("Create new tables with OIDs by default."),
1015 {"logging_collector", PGC_POSTMASTER, LOGGING_WHERE,
1016 gettext_noop("Start a subprocess to capture stderr output and/or csvlogs into log files."),
1023 {"log_truncate_on_rotation", PGC_SIGHUP, LOGGING_WHERE,
1024 gettext_noop("Truncate existing log files of same name during log rotation."),
1027 &Log_truncate_on_rotation,
1033 {"trace_sort", PGC_USERSET, DEVELOPER_OPTIONS,
1034 gettext_noop("Emit information about resource usage in sorting."),
1043 #ifdef TRACE_SYNCSCAN
1044 /* this is undocumented because not exposed in a standard build */
1046 {"trace_syncscan", PGC_USERSET, DEVELOPER_OPTIONS,
1047 gettext_noop("Generate debugging output for synchronized scanning."),
1056 #ifdef DEBUG_BOUNDED_SORT
1057 /* this is undocumented because not exposed in a standard build */
1060 "optimize_bounded_sort", PGC_USERSET, QUERY_TUNING_METHOD,
1061 gettext_noop("Enable bounded sorting using heap sort."),
1065 &optimize_bounded_sort,
1072 {"wal_debug", PGC_SUSET, DEVELOPER_OPTIONS,
1073 gettext_noop("Emit WAL-related debugging output."),
1083 {"integer_datetimes", PGC_INTERNAL, PRESET_OPTIONS,
1084 gettext_noop("Datetimes are integer based."),
1086 GUC_REPORT | GUC_NOT_IN_SAMPLE | GUC_DISALLOW_IN_FILE
1089 #ifdef HAVE_INT64_TIMESTAMP
1097 {"krb_caseins_users", PGC_POSTMASTER, CONN_AUTH_SECURITY,
1098 gettext_noop("Sets whether Kerberos and GSSAPI user names should be treated as case-insensitive."),
1101 &pg_krb_caseins_users,
1106 {"escape_string_warning", PGC_USERSET, COMPAT_OPTIONS_PREVIOUS,
1107 gettext_noop("Warn about backslash escapes in ordinary string literals."),
1110 &escape_string_warning,
1115 {"standard_conforming_strings", PGC_USERSET, COMPAT_OPTIONS_PREVIOUS,
1116 gettext_noop("Causes '...' strings to treat backslashes literally."),
1120 &standard_conforming_strings,
1125 {"synchronize_seqscans", PGC_USERSET, COMPAT_OPTIONS_PREVIOUS,
1126 gettext_noop("Enable synchronized sequential scans."),
1129 &synchronize_seqscans,
1134 {"archive_mode", PGC_POSTMASTER, WAL_SETTINGS,
1135 gettext_noop("Allows archiving of WAL files using archive_command."),
1143 {"allow_system_table_mods", PGC_POSTMASTER, DEVELOPER_OPTIONS,
1144 gettext_noop("Allows modifications of the structure of system tables."),
1148 &allowSystemTableMods,
1153 {"ignore_system_indexes", PGC_BACKEND, DEVELOPER_OPTIONS,
1154 gettext_noop("Disables reading from system indexes."),
1155 gettext_noop("It does not prevent updating the indexes, so it is safe "
1156 "to use. The worst consequence is slowness."),
1159 &IgnoreSystemIndexes,
1163 /* End-of-list marker */
1165 {NULL, 0, 0, NULL, NULL}, NULL, false, NULL, NULL
1170 static struct config_int ConfigureNamesInt[] =
1173 {"archive_timeout", PGC_SIGHUP, WAL_SETTINGS,
1174 gettext_noop("Forces a switch to the next xlog file if a "
1175 "new file has not been started within N seconds."),
1179 &XLogArchiveTimeout,
1180 0, 0, INT_MAX, NULL, NULL
1183 {"post_auth_delay", PGC_BACKEND, DEVELOPER_OPTIONS,
1184 gettext_noop("Waits N seconds on connection startup after authentication."),
1185 gettext_noop("This allows attaching a debugger to the process."),
1186 GUC_NOT_IN_SAMPLE | GUC_UNIT_S
1189 0, 0, INT_MAX, NULL, NULL
1192 {"default_statistics_target", PGC_USERSET, QUERY_TUNING_OTHER,
1193 gettext_noop("Sets the default statistics target."),
1194 gettext_noop("This applies to table columns that have not had a "
1195 "column-specific target set via ALTER TABLE SET STATISTICS.")
1197 &default_statistics_target,
1198 10, 1, 1000, NULL, NULL
1201 {"from_collapse_limit", PGC_USERSET, QUERY_TUNING_OTHER,
1202 gettext_noop("Sets the FROM-list size beyond which subqueries "
1203 "are not collapsed."),
1204 gettext_noop("The planner will merge subqueries into upper "
1205 "queries if the resulting FROM list would have no more than "
1208 &from_collapse_limit,
1209 8, 1, INT_MAX, NULL, NULL
1212 {"join_collapse_limit", PGC_USERSET, QUERY_TUNING_OTHER,
1213 gettext_noop("Sets the FROM-list size beyond which JOIN "
1214 "constructs are not flattened."),
1215 gettext_noop("The planner will flatten explicit JOIN "
1216 "constructs into lists of FROM items whenever a "
1217 "list of no more than this many items would result.")
1219 &join_collapse_limit,
1220 8, 1, INT_MAX, NULL, NULL
1223 {"geqo_threshold", PGC_USERSET, QUERY_TUNING_GEQO,
1224 gettext_noop("Sets the threshold of FROM items beyond which GEQO is used."),
1228 12, 2, INT_MAX, NULL, NULL
1231 {"geqo_effort", PGC_USERSET, QUERY_TUNING_GEQO,
1232 gettext_noop("GEQO: effort is used to set the default for other GEQO parameters."),
1236 DEFAULT_GEQO_EFFORT, MIN_GEQO_EFFORT, MAX_GEQO_EFFORT, NULL, NULL
1239 {"geqo_pool_size", PGC_USERSET, QUERY_TUNING_GEQO,
1240 gettext_noop("GEQO: number of individuals in the population."),
1241 gettext_noop("Zero selects a suitable default value.")
1244 0, 0, INT_MAX, NULL, NULL
1247 {"geqo_generations", PGC_USERSET, QUERY_TUNING_GEQO,
1248 gettext_noop("GEQO: number of iterations of the algorithm."),
1249 gettext_noop("Zero selects a suitable default value.")
1252 0, 0, INT_MAX, NULL, NULL
1256 {"deadlock_timeout", PGC_SIGHUP, LOCK_MANAGEMENT,
1257 gettext_noop("Sets the time to wait on a lock before checking for deadlock."),
1262 1000, 1, INT_MAX / 1000, NULL, NULL
1266 * Note: MaxBackends is limited to INT_MAX/4 because some places compute
1267 * 4*MaxBackends without any overflow check. This check is made in
1268 * assign_maxconnections, since MaxBackends is computed as MaxConnections
1269 * plus autovacuum_max_workers.
1271 * Likewise we have to limit NBuffers to INT_MAX/2.
1274 {"max_connections", PGC_POSTMASTER, CONN_AUTH_SETTINGS,
1275 gettext_noop("Sets the maximum number of concurrent connections."),
1279 100, 1, INT_MAX / 4, assign_maxconnections, NULL
1283 {"superuser_reserved_connections", PGC_POSTMASTER, CONN_AUTH_SETTINGS,
1284 gettext_noop("Sets the number of connection slots reserved for superusers."),
1288 3, 0, INT_MAX / 4, NULL, NULL
1292 {"shared_buffers", PGC_POSTMASTER, RESOURCES_MEM,
1293 gettext_noop("Sets the number of shared memory buffers used by the server."),
1298 1024, 16, INT_MAX / 2, NULL, NULL
1302 {"temp_buffers", PGC_USERSET, RESOURCES_MEM,
1303 gettext_noop("Sets the maximum number of temporary buffers used by each session."),
1308 1024, 100, INT_MAX / 2, NULL, show_num_temp_buffers
1312 {"port", PGC_POSTMASTER, CONN_AUTH_SETTINGS,
1313 gettext_noop("Sets the TCP port the server listens on."),
1317 DEF_PGPORT, 1, 65535, NULL, NULL
1321 {"unix_socket_permissions", PGC_POSTMASTER, CONN_AUTH_SETTINGS,
1322 gettext_noop("Sets the access permissions of the Unix-domain socket."),
1323 gettext_noop("Unix-domain sockets use the usual Unix file system "
1324 "permission set. The parameter value is expected to be an numeric mode "
1325 "specification in the form accepted by the chmod and umask system "
1326 "calls. (To use the customary octal format the number must start with "
1329 &Unix_socket_permissions,
1330 0777, 0000, 0777, NULL, NULL
1334 {"work_mem", PGC_USERSET, RESOURCES_MEM,
1335 gettext_noop("Sets the maximum memory to be used for query workspaces."),
1336 gettext_noop("This much memory can be used by each internal "
1337 "sort operation and hash table before switching to "
1338 "temporary disk files."),
1342 1024, 8 * BLCKSZ / 1024, MAX_KILOBYTES, NULL, NULL
1346 {"maintenance_work_mem", PGC_USERSET, RESOURCES_MEM,
1347 gettext_noop("Sets the maximum memory to be used for maintenance operations."),
1348 gettext_noop("This includes operations such as VACUUM and CREATE INDEX."),
1351 &maintenance_work_mem,
1352 16384, 1024, MAX_KILOBYTES, NULL, NULL
1356 {"max_stack_depth", PGC_SUSET, RESOURCES_MEM,
1357 gettext_noop("Sets the maximum stack depth, in kilobytes."),
1362 100, 100, MAX_KILOBYTES, assign_max_stack_depth, NULL
1366 {"vacuum_cost_page_hit", PGC_USERSET, RESOURCES,
1367 gettext_noop("Vacuum cost for a page found in the buffer cache."),
1371 1, 0, 10000, NULL, NULL
1375 {"vacuum_cost_page_miss", PGC_USERSET, RESOURCES,
1376 gettext_noop("Vacuum cost for a page not found in the buffer cache."),
1379 &VacuumCostPageMiss,
1380 10, 0, 10000, NULL, NULL
1384 {"vacuum_cost_page_dirty", PGC_USERSET, RESOURCES,
1385 gettext_noop("Vacuum cost for a page dirtied by vacuum."),
1388 &VacuumCostPageDirty,
1389 20, 0, 10000, NULL, NULL
1393 {"vacuum_cost_limit", PGC_USERSET, RESOURCES,
1394 gettext_noop("Vacuum cost amount available before napping."),
1398 200, 1, 10000, NULL, NULL
1402 {"vacuum_cost_delay", PGC_USERSET, RESOURCES,
1403 gettext_noop("Vacuum cost delay in milliseconds."),
1408 0, 0, 1000, NULL, NULL
1412 {"autovacuum_vacuum_cost_delay", PGC_SIGHUP, AUTOVACUUM,
1413 gettext_noop("Vacuum cost delay in milliseconds, for autovacuum."),
1417 &autovacuum_vac_cost_delay,
1418 20, -1, 1000, NULL, NULL
1422 {"autovacuum_vacuum_cost_limit", PGC_SIGHUP, AUTOVACUUM,
1423 gettext_noop("Vacuum cost amount available before napping, for autovacuum."),
1426 &autovacuum_vac_cost_limit,
1427 -1, -1, 10000, NULL, NULL
1431 {"max_files_per_process", PGC_POSTMASTER, RESOURCES_KERNEL,
1432 gettext_noop("Sets the maximum number of simultaneously open files for each server process."),
1435 &max_files_per_process,
1436 1000, 25, INT_MAX, NULL, NULL
1440 {"max_prepared_transactions", PGC_POSTMASTER, RESOURCES,
1441 gettext_noop("Sets the maximum number of simultaneously prepared transactions."),
1444 &max_prepared_xacts,
1445 5, 0, INT_MAX, NULL, NULL
1450 {"trace_lock_oidmin", PGC_SUSET, DEVELOPER_OPTIONS,
1451 gettext_noop("No description available."),
1456 FirstNormalObjectId, 0, INT_MAX, NULL, NULL
1459 {"trace_lock_table", PGC_SUSET, DEVELOPER_OPTIONS,
1460 gettext_noop("No description available."),
1465 0, 0, INT_MAX, NULL, NULL
1470 {"statement_timeout", PGC_USERSET, CLIENT_CONN_STATEMENT,
1471 gettext_noop("Sets the maximum allowed duration of any statement."),
1472 gettext_noop("A value of 0 turns off the timeout."),
1476 0, 0, INT_MAX, NULL, NULL
1480 {"vacuum_freeze_min_age", PGC_USERSET, CLIENT_CONN_STATEMENT,
1481 gettext_noop("Minimum age at which VACUUM should freeze a table row."),
1484 &vacuum_freeze_min_age,
1485 100000000, 0, 1000000000, NULL, NULL
1489 {"max_fsm_relations", PGC_POSTMASTER, RESOURCES_FSM,
1490 gettext_noop("Sets the maximum number of tables and indexes for which free space is tracked."),
1494 1000, 100, INT_MAX, NULL, NULL
1497 {"max_fsm_pages", PGC_POSTMASTER, RESOURCES_FSM,
1498 gettext_noop("Sets the maximum number of disk pages for which free space is tracked."),
1502 20000, 1000, INT_MAX, NULL, NULL
1506 {"max_locks_per_transaction", PGC_POSTMASTER, LOCK_MANAGEMENT,
1507 gettext_noop("Sets the maximum number of locks per transaction."),
1508 gettext_noop("The shared lock table is sized on the assumption that "
1509 "at most max_locks_per_transaction * max_connections distinct "
1510 "objects will need to be locked at any one time.")
1512 &max_locks_per_xact,
1513 64, 10, INT_MAX, NULL, NULL
1517 {"authentication_timeout", PGC_SIGHUP, CONN_AUTH_SECURITY,
1518 gettext_noop("Sets the maximum allowed time to complete client authentication."),
1522 &AuthenticationTimeout,
1523 60, 1, 600, NULL, NULL
1527 /* Not for general use */
1528 {"pre_auth_delay", PGC_SIGHUP, DEVELOPER_OPTIONS,
1529 gettext_noop("Waits N seconds on connection startup before authentication."),
1530 gettext_noop("This allows attaching a debugger to the process."),
1531 GUC_NOT_IN_SAMPLE | GUC_UNIT_S
1534 0, 0, 60, NULL, NULL
1538 {"checkpoint_segments", PGC_SIGHUP, WAL_CHECKPOINTS,
1539 gettext_noop("Sets the maximum distance in log segments between automatic WAL checkpoints."),
1542 &CheckPointSegments,
1543 3, 1, INT_MAX, NULL, NULL
1547 {"checkpoint_timeout", PGC_SIGHUP, WAL_CHECKPOINTS,
1548 gettext_noop("Sets the maximum time between automatic WAL checkpoints."),
1553 300, 30, 3600, NULL, NULL
1557 {"checkpoint_warning", PGC_SIGHUP, WAL_CHECKPOINTS,
1558 gettext_noop("Enables warnings if checkpoint segments are filled more "
1559 "frequently than this."),
1560 gettext_noop("Write a message to the server log if checkpoints "
1561 "caused by the filling of checkpoint segment files happens more "
1562 "frequently than this number of seconds. Zero turns off the warning."),
1566 30, 0, INT_MAX, NULL, NULL
1570 {"wal_buffers", PGC_POSTMASTER, WAL_SETTINGS,
1571 gettext_noop("Sets the number of disk-page buffers in shared memory for WAL."),
1576 8, 4, INT_MAX, NULL, NULL
1580 {"wal_writer_delay", PGC_SIGHUP, WAL_SETTINGS,
1581 gettext_noop("WAL writer sleep time between WAL flushes."),
1586 200, 1, 10000, NULL, NULL
1590 {"commit_delay", PGC_USERSET, WAL_SETTINGS,
1591 gettext_noop("Sets the delay in microseconds between transaction commit and "
1592 "flushing WAL to disk."),
1596 0, 0, 100000, NULL, NULL
1600 {"commit_siblings", PGC_USERSET, WAL_SETTINGS,
1601 gettext_noop("Sets the minimum concurrent open transactions before performing "
1606 5, 1, 1000, NULL, NULL
1610 {"extra_float_digits", PGC_USERSET, CLIENT_CONN_LOCALE,
1611 gettext_noop("Sets the number of digits displayed for floating-point values."),
1612 gettext_noop("This affects real, double precision, and geometric data types. "
1613 "The parameter value is added to the standard number of digits "
1614 "(FLT_DIG or DBL_DIG as appropriate).")
1616 &extra_float_digits,
1617 0, -15, 2, NULL, NULL
1621 {"log_min_duration_statement", PGC_SUSET, LOGGING_WHEN,
1622 gettext_noop("Sets the minimum execution time above which "
1623 "statements will be logged."),
1624 gettext_noop("Zero prints all queries. -1 turns this feature off."),
1627 &log_min_duration_statement,
1628 -1, -1, INT_MAX / 1000, NULL, NULL
1632 {"log_autovacuum_min_duration", PGC_SIGHUP, LOGGING_WHAT,
1633 gettext_noop("Sets the minimum execution time above which "
1634 "autovacuum actions will be logged."),
1635 gettext_noop("Zero prints all actions. -1 turns autovacuum logging off."),
1638 &Log_autovacuum_min_duration,
1639 -1, -1, INT_MAX / 1000, NULL, NULL
1643 {"bgwriter_delay", PGC_SIGHUP, RESOURCES,
1644 gettext_noop("Background writer sleep time between rounds."),
1649 200, 10, 10000, NULL, NULL
1653 {"bgwriter_lru_maxpages", PGC_SIGHUP, RESOURCES,
1654 gettext_noop("Background writer maximum number of LRU pages to flush per round."),
1657 &bgwriter_lru_maxpages,
1658 100, 0, 1000, NULL, NULL
1662 {"log_rotation_age", PGC_SIGHUP, LOGGING_WHERE,
1663 gettext_noop("Automatic log file rotation will occur after N minutes."),
1668 HOURS_PER_DAY * MINS_PER_HOUR, 0, INT_MAX / MINS_PER_HOUR, NULL, NULL
1672 {"log_rotation_size", PGC_SIGHUP, LOGGING_WHERE,
1673 gettext_noop("Automatic log file rotation will occur after N kilobytes."),
1678 10 * 1024, 0, INT_MAX / 1024, NULL, NULL
1682 {"max_function_args", PGC_INTERNAL, PRESET_OPTIONS,
1683 gettext_noop("Shows the maximum number of function arguments."),
1685 GUC_NOT_IN_SAMPLE | GUC_DISALLOW_IN_FILE
1688 FUNC_MAX_ARGS, FUNC_MAX_ARGS, FUNC_MAX_ARGS, NULL, NULL
1692 {"max_index_keys", PGC_INTERNAL, PRESET_OPTIONS,
1693 gettext_noop("Shows the maximum number of index keys."),
1695 GUC_NOT_IN_SAMPLE | GUC_DISALLOW_IN_FILE
1698 INDEX_MAX_KEYS, INDEX_MAX_KEYS, INDEX_MAX_KEYS, NULL, NULL
1702 {"max_identifier_length", PGC_INTERNAL, PRESET_OPTIONS,
1703 gettext_noop("Shows the maximum identifier length."),
1705 GUC_NOT_IN_SAMPLE | GUC_DISALLOW_IN_FILE
1707 &max_identifier_length,
1708 NAMEDATALEN - 1, NAMEDATALEN - 1, NAMEDATALEN - 1, NULL, NULL
1712 {"block_size", PGC_INTERNAL, PRESET_OPTIONS,
1713 gettext_noop("Shows the size of a disk block."),
1715 GUC_NOT_IN_SAMPLE | GUC_DISALLOW_IN_FILE
1718 BLCKSZ, BLCKSZ, BLCKSZ, NULL, NULL
1722 {"autovacuum_naptime", PGC_SIGHUP, AUTOVACUUM,
1723 gettext_noop("Time to sleep between autovacuum runs."),
1727 &autovacuum_naptime,
1728 60, 1, INT_MAX / 1000, NULL, NULL
1731 {"autovacuum_vacuum_threshold", PGC_SIGHUP, AUTOVACUUM,
1732 gettext_noop("Minimum number of tuple updates or deletes prior to vacuum."),
1735 &autovacuum_vac_thresh,
1736 50, 0, INT_MAX, NULL, NULL
1739 {"autovacuum_analyze_threshold", PGC_SIGHUP, AUTOVACUUM,
1740 gettext_noop("Minimum number of tuple inserts, updates or deletes prior to analyze."),
1743 &autovacuum_anl_thresh,
1744 50, 0, INT_MAX, NULL, NULL
1747 /* see varsup.c for why this is PGC_POSTMASTER not PGC_SIGHUP */
1748 {"autovacuum_freeze_max_age", PGC_POSTMASTER, AUTOVACUUM,
1749 gettext_noop("Age at which to autovacuum a table to prevent transaction ID wraparound."),
1752 &autovacuum_freeze_max_age,
1753 200000000, 100000000, 2000000000, NULL, NULL
1756 /* see max_connections */
1757 {"autovacuum_max_workers", PGC_POSTMASTER, AUTOVACUUM,
1758 gettext_noop("Sets the maximum number of simultaneously running autovacuum worker processes."),
1761 &autovacuum_max_workers,
1762 3, 1, INT_MAX / 4, assign_autovacuum_max_workers, NULL
1766 {"tcp_keepalives_idle", PGC_USERSET, CLIENT_CONN_OTHER,
1767 gettext_noop("Time between issuing TCP keepalives."),
1768 gettext_noop("A value of 0 uses the system default."),
1771 &tcp_keepalives_idle,
1772 0, 0, INT_MAX, assign_tcp_keepalives_idle, show_tcp_keepalives_idle
1776 {"tcp_keepalives_interval", PGC_USERSET, CLIENT_CONN_OTHER,
1777 gettext_noop("Time between TCP keepalive retransmits."),
1778 gettext_noop("A value of 0 uses the system default."),
1781 &tcp_keepalives_interval,
1782 0, 0, INT_MAX, assign_tcp_keepalives_interval, show_tcp_keepalives_interval
1786 {"tcp_keepalives_count", PGC_USERSET, CLIENT_CONN_OTHER,
1787 gettext_noop("Maximum number of TCP keepalive retransmits."),
1788 gettext_noop("This controls the number of consecutive keepalive retransmits that can be "
1789 "lost before a connection is considered dead. A value of 0 uses the "
1792 &tcp_keepalives_count,
1793 0, 0, INT_MAX, assign_tcp_keepalives_count, show_tcp_keepalives_count
1797 {"gin_fuzzy_search_limit", PGC_USERSET, CLIENT_CONN_OTHER,
1798 gettext_noop("Sets the maximum allowed result for exact search by GIN."),
1802 &GinFuzzySearchLimit,
1803 0, 0, INT_MAX, NULL, NULL
1807 {"effective_cache_size", PGC_USERSET, QUERY_TUNING_COST,
1808 gettext_noop("Sets the planner's assumption about the size of the disk cache."),
1809 gettext_noop("That is, the portion of the kernel's disk cache that "
1810 "will be used for PostgreSQL data files. This is measured in disk "
1811 "pages, which are normally 8 kB each."),
1814 &effective_cache_size,
1815 DEFAULT_EFFECTIVE_CACHE_SIZE, 1, INT_MAX, NULL, NULL
1819 /* Can't be set in postgresql.conf */
1820 {"server_version_num", PGC_INTERNAL, PRESET_OPTIONS,
1821 gettext_noop("Shows the server version as an integer."),
1823 GUC_NOT_IN_SAMPLE | GUC_DISALLOW_IN_FILE
1825 &server_version_num,
1826 PG_VERSION_NUM, PG_VERSION_NUM, PG_VERSION_NUM, NULL, NULL
1830 {"log_temp_files", PGC_USERSET, LOGGING_WHAT,
1831 gettext_noop("Log the use of temporary files larger than this number of kilobytes."),
1832 gettext_noop("Zero logs all files. The default is -1 (turning this feature off)."),
1836 -1, -1, INT_MAX, NULL, NULL
1839 /* End-of-list marker */
1841 {NULL, 0, 0, NULL, NULL}, NULL, 0, 0, 0, NULL, NULL
1846 static struct config_real ConfigureNamesReal[] =
1849 {"seq_page_cost", PGC_USERSET, QUERY_TUNING_COST,
1850 gettext_noop("Sets the planner's estimate of the cost of a "
1851 "sequentially fetched disk page."),
1855 DEFAULT_SEQ_PAGE_COST, 0, DBL_MAX, NULL, NULL
1858 {"random_page_cost", PGC_USERSET, QUERY_TUNING_COST,
1859 gettext_noop("Sets the planner's estimate of the cost of a "
1860 "nonsequentially fetched disk page."),
1864 DEFAULT_RANDOM_PAGE_COST, 0, DBL_MAX, NULL, NULL
1867 {"cpu_tuple_cost", PGC_USERSET, QUERY_TUNING_COST,
1868 gettext_noop("Sets the planner's estimate of the cost of "
1869 "processing each tuple (row)."),
1873 DEFAULT_CPU_TUPLE_COST, 0, DBL_MAX, NULL, NULL
1876 {"cpu_index_tuple_cost", PGC_USERSET, QUERY_TUNING_COST,
1877 gettext_noop("Sets the planner's estimate of the cost of "
1878 "processing each index entry during an index scan."),
1881 &cpu_index_tuple_cost,
1882 DEFAULT_CPU_INDEX_TUPLE_COST, 0, DBL_MAX, NULL, NULL
1885 {"cpu_operator_cost", PGC_USERSET, QUERY_TUNING_COST,
1886 gettext_noop("Sets the planner's estimate of the cost of "
1887 "processing each operator or function call."),
1891 DEFAULT_CPU_OPERATOR_COST, 0, DBL_MAX, NULL, NULL
1895 {"geqo_selection_bias", PGC_USERSET, QUERY_TUNING_GEQO,
1896 gettext_noop("GEQO: selective pressure within the population."),
1899 &Geqo_selection_bias,
1900 DEFAULT_GEQO_SELECTION_BIAS, MIN_GEQO_SELECTION_BIAS,
1901 MAX_GEQO_SELECTION_BIAS, NULL, NULL
1905 {"bgwriter_lru_multiplier", PGC_SIGHUP, RESOURCES,
1906 gettext_noop("Multiple of the average buffer usage to free per round."),
1909 &bgwriter_lru_multiplier,
1910 2.0, 0.0, 10.0, NULL, NULL
1914 {"seed", PGC_USERSET, UNGROUPED,
1915 gettext_noop("Sets the seed for random-number generation."),
1917 GUC_NO_SHOW_ALL | GUC_NO_RESET_ALL | GUC_NOT_IN_SAMPLE | GUC_DISALLOW_IN_FILE
1920 0.0, -1.0, 1.0, assign_random_seed, show_random_seed
1924 {"autovacuum_vacuum_scale_factor", PGC_SIGHUP, AUTOVACUUM,
1925 gettext_noop("Number of tuple updates or deletes prior to vacuum as a fraction of reltuples."),
1928 &autovacuum_vac_scale,
1929 0.2, 0.0, 100.0, NULL, NULL
1932 {"autovacuum_analyze_scale_factor", PGC_SIGHUP, AUTOVACUUM,
1933 gettext_noop("Number of tuple inserts, updates or deletes prior to analyze as a fraction of reltuples."),
1936 &autovacuum_anl_scale,
1937 0.1, 0.0, 100.0, NULL, NULL
1941 {"checkpoint_completion_target", PGC_SIGHUP, WAL_CHECKPOINTS,
1942 gettext_noop("Time spent flushing dirty buffers during checkpoint, as fraction of checkpoint interval."),
1945 &CheckPointCompletionTarget,
1946 0.5, 0.0, 1.0, NULL, NULL
1949 /* End-of-list marker */
1951 {NULL, 0, 0, NULL, NULL}, NULL, 0.0, 0.0, 0.0, NULL, NULL
1956 static struct config_string ConfigureNamesString[] =
1959 {"archive_command", PGC_SIGHUP, WAL_SETTINGS,
1960 gettext_noop("Sets the shell command that will be called to archive a WAL file."),
1963 &XLogArchiveCommand,
1964 "", NULL, show_archive_command
1968 {"client_encoding", PGC_USERSET, CLIENT_CONN_LOCALE,
1969 gettext_noop("Sets the client's character set encoding."),
1971 GUC_IS_NAME | GUC_REPORT
1973 &client_encoding_string,
1974 "SQL_ASCII", assign_client_encoding, NULL
1978 {"log_line_prefix", PGC_SIGHUP, LOGGING_WHAT,
1979 gettext_noop("Controls information prefixed to each log line."),
1980 gettext_noop("If blank, no prefix is used.")
1987 {"log_timezone", PGC_SIGHUP, LOGGING_WHAT,
1988 gettext_noop("Sets the time zone to use in log messages."),
1991 &log_timezone_string,
1992 "UNKNOWN", assign_log_timezone, show_log_timezone
1996 {"DateStyle", PGC_USERSET, CLIENT_CONN_LOCALE,
1997 gettext_noop("Sets the display format for date and time values."),
1998 gettext_noop("Also controls interpretation of ambiguous "
2000 GUC_LIST_INPUT | GUC_REPORT
2003 "ISO, MDY", assign_datestyle, NULL
2007 {"default_tablespace", PGC_USERSET, CLIENT_CONN_STATEMENT,
2008 gettext_noop("Sets the default tablespace to create tables and indexes in."),
2009 gettext_noop("An empty string selects the database's default tablespace."),
2012 &default_tablespace,
2013 "", assign_default_tablespace, NULL
2017 {"temp_tablespaces", PGC_USERSET, CLIENT_CONN_STATEMENT,
2018 gettext_noop("Sets the tablespace(s) to use for temporary tables and sort files."),
2020 GUC_LIST_INPUT | GUC_LIST_QUOTE
2023 "", assign_temp_tablespaces, NULL
2027 {"dynamic_library_path", PGC_SUSET, CLIENT_CONN_OTHER,
2028 gettext_noop("Sets the path for dynamically loadable modules."),
2029 gettext_noop("If a dynamically loadable module needs to be opened and "
2030 "the specified name does not have a directory component (i.e., the "
2031 "name does not contain a slash), the system will search this path for "
2032 "the specified file."),
2035 &Dynamic_library_path,
2036 "$libdir", NULL, NULL
2040 {"krb_realm", PGC_POSTMASTER, CONN_AUTH_SECURITY,
2041 gettext_noop("Sets realm to match Kerberos and GSSAPI users against."),
2050 {"krb_server_keyfile", PGC_POSTMASTER, CONN_AUTH_SECURITY,
2051 gettext_noop("Sets the location of the Kerberos server key file."),
2055 &pg_krb_server_keyfile,
2056 PG_KRB_SRVTAB, NULL, NULL
2060 {"krb_srvname", PGC_POSTMASTER, CONN_AUTH_SECURITY,
2061 gettext_noop("Sets the name of the Kerberos service."),
2065 PG_KRB_SRVNAM, NULL, NULL
2069 {"krb_server_hostname", PGC_POSTMASTER, CONN_AUTH_SECURITY,
2070 gettext_noop("Sets the hostname of the Kerberos server."),
2073 &pg_krb_server_hostname,
2078 {"bonjour_name", PGC_POSTMASTER, CONN_AUTH_SETTINGS,
2079 gettext_noop("Sets the Bonjour broadcast service name."),
2086 /* See main.c about why defaults for LC_foo are not all alike */
2089 {"lc_collate", PGC_INTERNAL, CLIENT_CONN_LOCALE,
2090 gettext_noop("Shows the collation order locale."),
2092 GUC_NOT_IN_SAMPLE | GUC_DISALLOW_IN_FILE
2099 {"lc_ctype", PGC_INTERNAL, CLIENT_CONN_LOCALE,
2100 gettext_noop("Shows the character classification and case conversion locale."),
2102 GUC_NOT_IN_SAMPLE | GUC_DISALLOW_IN_FILE
2109 {"lc_messages", PGC_SUSET, CLIENT_CONN_LOCALE,
2110 gettext_noop("Sets the language in which messages are displayed."),
2114 "", locale_messages_assign, NULL
2118 {"lc_monetary", PGC_USERSET, CLIENT_CONN_LOCALE,
2119 gettext_noop("Sets the locale for formatting monetary amounts."),
2123 "C", locale_monetary_assign, NULL
2127 {"lc_numeric", PGC_USERSET, CLIENT_CONN_LOCALE,
2128 gettext_noop("Sets the locale for formatting numbers."),
2132 "C", locale_numeric_assign, NULL
2136 {"lc_time", PGC_USERSET, CLIENT_CONN_LOCALE,
2137 gettext_noop("Sets the locale for formatting date and time values."),
2141 "C", locale_time_assign, NULL
2145 {"shared_preload_libraries", PGC_POSTMASTER, RESOURCES_KERNEL,
2146 gettext_noop("Lists shared libraries to preload into server."),
2148 GUC_LIST_INPUT | GUC_LIST_QUOTE | GUC_SUPERUSER_ONLY
2150 &shared_preload_libraries_string,
2155 {"local_preload_libraries", PGC_BACKEND, CLIENT_CONN_OTHER,
2156 gettext_noop("Lists shared libraries to preload into each backend."),
2158 GUC_LIST_INPUT | GUC_LIST_QUOTE
2160 &local_preload_libraries_string,
2165 {"search_path", PGC_USERSET, CLIENT_CONN_STATEMENT,
2166 gettext_noop("Sets the schema search order for names that are not schema-qualified."),
2168 GUC_LIST_INPUT | GUC_LIST_QUOTE
2170 &namespace_search_path,
2171 "\"$user\",public", assign_search_path, NULL
2175 /* Can't be set in postgresql.conf */
2176 {"server_encoding", PGC_INTERNAL, CLIENT_CONN_LOCALE,
2177 gettext_noop("Sets the server (database) character set encoding."),
2179 GUC_IS_NAME | GUC_REPORT | GUC_NOT_IN_SAMPLE | GUC_DISALLOW_IN_FILE
2181 &server_encoding_string,
2182 "SQL_ASCII", NULL, NULL
2186 /* Can't be set in postgresql.conf */
2187 {"server_version", PGC_INTERNAL, PRESET_OPTIONS,
2188 gettext_noop("Shows the server version."),
2190 GUC_REPORT | GUC_NOT_IN_SAMPLE | GUC_DISALLOW_IN_FILE
2192 &server_version_string,
2193 PG_VERSION, NULL, NULL
2197 /* Not for general use --- used by SET ROLE */
2198 {"role", PGC_USERSET, UNGROUPED,
2199 gettext_noop("Sets the current role."),
2201 GUC_IS_NAME | GUC_NO_SHOW_ALL | GUC_NO_RESET_ALL | GUC_NOT_IN_SAMPLE | GUC_DISALLOW_IN_FILE
2204 "none", assign_role, show_role
2208 /* Not for general use --- used by SET SESSION AUTHORIZATION */
2209 {"session_authorization", PGC_USERSET, UNGROUPED,
2210 gettext_noop("Sets the session user name."),
2212 GUC_IS_NAME | GUC_REPORT | GUC_NO_SHOW_ALL | GUC_NO_RESET_ALL | GUC_NOT_IN_SAMPLE | GUC_DISALLOW_IN_FILE
2214 &session_authorization_string,
2215 NULL, assign_session_authorization, show_session_authorization
2219 {"log_destination", PGC_SIGHUP, LOGGING_WHERE,
2220 gettext_noop("Sets the destination for server log output."),
2221 gettext_noop("Valid values are combinations of \"stderr\", "
2222 "\"syslog\", \"csvlog\", and \"eventlog\", "
2223 "depending on the platform."),
2226 &log_destination_string,
2227 "stderr", assign_log_destination, NULL
2230 {"log_directory", PGC_SIGHUP, LOGGING_WHERE,
2231 gettext_noop("Sets the destination directory for log files."),
2232 gettext_noop("Can be specified as relative to the data directory "
2233 "or as absolute path."),
2237 "pg_log", assign_canonical_path, NULL
2240 {"log_filename", PGC_SIGHUP, LOGGING_WHERE,
2241 gettext_noop("Sets the file name pattern for log files."),
2246 "postgresql-%Y-%m-%d_%H%M%S.log", NULL, NULL
2251 {"syslog_ident", PGC_SIGHUP, LOGGING_WHERE,
2252 gettext_noop("Sets the program name used to identify PostgreSQL "
2253 "messages in syslog."),
2257 "postgres", assign_syslog_ident, NULL
2262 {"TimeZone", PGC_USERSET, CLIENT_CONN_LOCALE,
2263 gettext_noop("Sets the time zone for displaying and interpreting time stamps."),
2268 "UNKNOWN", assign_timezone, show_timezone
2271 {"timezone_abbreviations", PGC_USERSET, CLIENT_CONN_LOCALE,
2272 gettext_noop("Selects a file of time zone abbreviations."),
2275 &timezone_abbreviations_string,
2276 "UNKNOWN", assign_timezone_abbreviations, NULL
2280 {"transaction_isolation", PGC_USERSET, CLIENT_CONN_STATEMENT,
2281 gettext_noop("Sets the current transaction's isolation level."),
2283 GUC_NO_RESET_ALL | GUC_NOT_IN_SAMPLE | GUC_DISALLOW_IN_FILE
2285 &XactIsoLevel_string,
2286 NULL, assign_XactIsoLevel, show_XactIsoLevel
2290 {"unix_socket_group", PGC_POSTMASTER, CONN_AUTH_SETTINGS,
2291 gettext_noop("Sets the owning group of the Unix-domain socket."),
2292 gettext_noop("The owning user of the socket is always the user "
2293 "that starts the server.")
2300 {"unix_socket_directory", PGC_POSTMASTER, CONN_AUTH_SETTINGS,
2301 gettext_noop("Sets the directory where the Unix-domain socket will be created."),
2306 "", assign_canonical_path, NULL
2310 {"listen_addresses", PGC_POSTMASTER, CONN_AUTH_SETTINGS,
2311 gettext_noop("Sets the host name or IP address(es) to listen to."),
2316 "localhost", NULL, NULL
2320 {"wal_sync_method", PGC_SIGHUP, WAL_SETTINGS,
2321 gettext_noop("Selects the method used for forcing WAL updates to disk."),
2325 XLOG_sync_method_default, assign_xlog_sync_method, NULL
2329 {"custom_variable_classes", PGC_SIGHUP, CUSTOM_OPTIONS,
2330 gettext_noop("Sets the list of known custom variable classes."),
2332 GUC_LIST_INPUT | GUC_LIST_QUOTE
2334 &custom_variable_classes,
2335 NULL, assign_custom_variable_classes, NULL
2339 {"data_directory", PGC_POSTMASTER, FILE_LOCATIONS,
2340 gettext_noop("Sets the server's data directory."),
2349 {"config_file", PGC_POSTMASTER, FILE_LOCATIONS,
2350 gettext_noop("Sets the server's main configuration file."),
2352 GUC_DISALLOW_IN_FILE | GUC_SUPERUSER_ONLY
2359 {"hba_file", PGC_POSTMASTER, FILE_LOCATIONS,
2360 gettext_noop("Sets the server's \"hba\" configuration file."),
2369 {"ident_file", PGC_POSTMASTER, FILE_LOCATIONS,
2370 gettext_noop("Sets the server's \"ident\" configuration file."),
2379 {"external_pid_file", PGC_POSTMASTER, FILE_LOCATIONS,
2380 gettext_noop("Writes the postmaster PID to the specified file."),
2385 NULL, assign_canonical_path, NULL
2389 {"default_text_search_config", PGC_USERSET, CLIENT_CONN_LOCALE,
2390 gettext_noop("Sets default text search configuration."),
2394 "pg_catalog.simple", assignTSCurrentConfig, NULL
2399 {"ssl_ciphers", PGC_POSTMASTER, CONN_AUTH_SECURITY,
2400 gettext_noop("Sets the list of allowed SSL ciphers."),
2405 "ALL:!ADH:!LOW:!EXP:!MD5:@STRENGTH", NULL, NULL
2407 #endif /* USE_SSL */
2409 /* End-of-list marker */
2411 {NULL, 0, 0, NULL, NULL}, NULL, NULL, NULL, NULL
2416 static struct config_enum ConfigureNamesEnum[] =
2419 {"backslash_quote", PGC_USERSET, COMPAT_OPTIONS_PREVIOUS,
2420 gettext_noop("Sets whether \"\\'\" is allowed in string literals."),
2421 gettext_noop("Valid values are ON, OFF, and SAFE_ENCODING.")
2424 BACKSLASH_QUOTE_SAFE_ENCODING, backslash_quote_options, NULL, NULL
2428 {"client_min_messages", PGC_USERSET, LOGGING_WHEN,
2429 gettext_noop("Sets the message levels that are sent to the client."),
2430 gettext_noop("Valid values are DEBUG5, DEBUG4, DEBUG3, DEBUG2, "
2431 "DEBUG1, LOG, NOTICE, WARNING, and ERROR. Each level includes all the "
2432 "levels that follow it. The later the level, the fewer messages are "
2435 &client_min_messages,
2436 NOTICE, message_level_options,NULL, NULL
2440 {"default_transaction_isolation", PGC_USERSET, CLIENT_CONN_STATEMENT,
2441 gettext_noop("Sets the transaction isolation level of each new transaction."),
2442 gettext_noop("Each SQL transaction has an isolation level, which "
2443 "can be either \"read uncommitted\", \"read committed\", \"repeatable read\", or \"serializable\".")
2445 &DefaultXactIsoLevel,
2446 XACT_READ_COMMITTED, isolation_level_options, NULL, NULL
2450 {"log_error_verbosity", PGC_SUSET, LOGGING_WHEN,
2451 gettext_noop("Sets the verbosity of logged messages."),
2452 gettext_noop("Valid values are \"terse\", \"default\", and \"verbose\".")
2454 &Log_error_verbosity,
2455 PGERROR_DEFAULT, log_error_verbosity_options, NULL, NULL
2459 {"log_min_messages", PGC_SUSET, LOGGING_WHEN,
2460 gettext_noop("Sets the message levels that are logged."),
2461 gettext_noop("Valid values are DEBUG5, DEBUG4, DEBUG3, DEBUG2, DEBUG1, "
2462 "INFO, NOTICE, WARNING, ERROR, LOG, FATAL, and PANIC. Each level "
2463 "includes all the levels that follow it.")
2466 WARNING, message_level_options, NULL, NULL
2470 {"log_min_error_statement", PGC_SUSET, LOGGING_WHEN,
2471 gettext_noop("Causes all statements generating error at or above this level to be logged."),
2472 gettext_noop("All SQL statements that cause an error of the "
2473 "specified level or a higher level are logged.")
2475 &log_min_error_statement,
2476 ERROR, message_level_options, NULL, NULL
2480 {"log_statement", PGC_SUSET, LOGGING_WHAT,
2481 gettext_noop("Sets the type of statements logged."),
2482 gettext_noop("Valid values are \"none\", \"ddl\", \"mod\", and \"all\".")
2485 LOGSTMT_NONE, log_statement_options, NULL, NULL
2490 {"syslog_facility", PGC_SIGHUP, LOGGING_WHERE,
2491 gettext_noop("Sets the syslog \"facility\" to be used when syslog enabled."),
2492 gettext_noop("Valid values are LOCAL0, LOCAL1, LOCAL2, LOCAL3, "
2493 "LOCAL4, LOCAL5, LOCAL6, LOCAL7.")
2496 LOG_LOCAL0, syslog_facility_options, assign_syslog_facility, NULL
2501 {"regex_flavor", PGC_USERSET, COMPAT_OPTIONS_PREVIOUS,
2502 gettext_noop("Sets the regular expression \"flavor\"."),
2503 gettext_noop("This can be set to advanced, extended, or basic.")
2506 REG_ADVANCED, regex_flavor_options, NULL, NULL
2510 {"session_replication_role", PGC_SUSET, CLIENT_CONN_STATEMENT,
2511 gettext_noop("Sets the session's behavior for triggers and rewrite rules."),
2512 gettext_noop("Each session can be either"
2513 " \"origin\", \"replica\", or \"local\".")
2515 &SessionReplicationRole,
2516 SESSION_REPLICATION_ROLE_ORIGIN, session_replication_role_options,
2517 assign_session_replication_role, NULL
2521 {"xmlbinary", PGC_USERSET, CLIENT_CONN_STATEMENT,
2522 gettext_noop("Sets how binary values are to be encoded in XML."),
2523 gettext_noop("Valid values are BASE64 and HEX.")
2526 XMLBINARY_BASE64, xmlbinary_options, NULL, NULL
2530 {"xmloption", PGC_USERSET, CLIENT_CONN_STATEMENT,
2531 gettext_noop("Sets whether XML data in implicit parsing and serialization "
2532 "operations is to be considered as documents or content fragments."),
2533 gettext_noop("Valid values are DOCUMENT and CONTENT.")
2536 XMLOPTION_CONTENT, xmloption_options, NULL, NULL
2540 /* End-of-list marker */
2542 {NULL, 0, 0, NULL, NULL}, NULL, 0, NULL, NULL, NULL
2546 /******** end of options list ********/
2550 * To allow continued support of obsolete names for GUC variables, we apply
2551 * the following mappings to any unrecognized name. Note that an old name
2552 * should be mapped to a new one only if the new variable has very similar
2553 * semantics to the old.
2555 static const char *const map_old_guc_names[] = {
2556 "sort_mem", "work_mem",
2557 "vacuum_mem", "maintenance_work_mem",
2563 * Actual lookup of variables is done through this single, sorted array.
2565 static struct config_generic **guc_variables;
2567 /* Current number of variables contained in the vector */
2568 static int num_guc_variables;
2570 /* Vector capacity */
2571 static int size_guc_variables;
2574 static bool guc_dirty; /* TRUE if need to do commit/abort work */
2576 static bool reporting_enabled; /* TRUE to enable GUC_REPORT */
2578 static int GUCNestLevel = 0; /* 1 when in main transaction */
2581 static int guc_var_compare(const void *a, const void *b);
2582 static int guc_name_compare(const char *namea, const char *nameb);
2583 static void push_old_value(struct config_generic * gconf, GucAction action);
2584 static void ReportGUCOption(struct config_generic * record);
2585 static void ShowGUCConfigOption(const char *name, DestReceiver *dest);
2586 static void ShowAllGUCConfig(DestReceiver *dest);
2587 static char *_ShowOption(struct config_generic * record, bool use_units);
2588 static bool is_newvalue_equal(struct config_generic * record, const char *newvalue);
2592 * Some infrastructure for checking malloc/strdup/realloc calls
2595 guc_malloc(int elevel, size_t size)
2599 data = malloc(size);
2602 (errcode(ERRCODE_OUT_OF_MEMORY),
2603 errmsg("out of memory")));
2608 guc_realloc(int elevel, void *old, size_t size)
2612 data = realloc(old, size);
2615 (errcode(ERRCODE_OUT_OF_MEMORY),
2616 errmsg("out of memory")));
2621 guc_strdup(int elevel, const char *src)
2628 (errcode(ERRCODE_OUT_OF_MEMORY),
2629 errmsg("out of memory")));
2635 * Support for assigning to a field of a string GUC item. Free the prior
2636 * value if it's not referenced anywhere else in the item (including stacked
2640 set_string_field(struct config_string * conf, char **field, char *newval)
2642 char *oldval = *field;
2645 /* Do the assignment */
2648 /* Exit if any duplicate references, or if old value was NULL anyway */
2649 if (oldval == NULL ||
2650 oldval == *(conf->variable) ||
2651 oldval == conf->reset_val ||
2652 oldval == conf->boot_val)
2654 for (stack = conf->gen.stack; stack; stack = stack->prev)
2656 if (oldval == stack->prior.stringval ||
2657 oldval == stack->masked.stringval)
2661 /* Not used anymore, so free it */
2666 * Detect whether strval is referenced anywhere in a GUC string item
2669 string_field_used(struct config_string * conf, char *strval)
2673 if (strval == *(conf->variable) ||
2674 strval == conf->reset_val ||
2675 strval == conf->boot_val)
2677 for (stack = conf->gen.stack; stack; stack = stack->prev)
2679 if (strval == stack->prior.stringval ||
2680 strval == stack->masked.stringval)
2687 * Support for copying a variable's active value into a stack entry
2690 set_stack_value(struct config_generic * gconf, union config_var_value * val)
2692 switch (gconf->vartype)
2696 *((struct config_bool *) gconf)->variable;
2700 *((struct config_int *) gconf)->variable;
2704 *((struct config_real *) gconf)->variable;
2707 /* we assume stringval is NULL if not valid */
2708 set_string_field((struct config_string *) gconf,
2710 *((struct config_string *) gconf)->variable);
2714 *((struct config_enum *) gconf)->variable;
2720 * Support for discarding a no-longer-needed value in a stack entry
2723 discard_stack_value(struct config_generic * gconf, union config_var_value * val)
2725 switch (gconf->vartype)
2731 /* no need to do anything */
2734 set_string_field((struct config_string *) gconf,
2743 * Fetch the sorted array pointer (exported for help_config.c's use ONLY)
2745 struct config_generic **
2746 get_guc_variables(void)
2748 return guc_variables;
2753 * Build the sorted array. This is split out so that it could be
2754 * re-executed after startup (eg, we could allow loadable modules to
2755 * add vars, and then we'd need to re-sort).
2758 build_guc_variables(void)
2762 struct config_generic **guc_vars;
2765 for (i = 0; ConfigureNamesBool[i].gen.name; i++)
2767 struct config_bool *conf = &ConfigureNamesBool[i];
2769 /* Rather than requiring vartype to be filled in by hand, do this: */
2770 conf->gen.vartype = PGC_BOOL;
2774 for (i = 0; ConfigureNamesInt[i].gen.name; i++)
2776 struct config_int *conf = &ConfigureNamesInt[i];
2778 conf->gen.vartype = PGC_INT;
2782 for (i = 0; ConfigureNamesReal[i].gen.name; i++)
2784 struct config_real *conf = &ConfigureNamesReal[i];
2786 conf->gen.vartype = PGC_REAL;
2790 for (i = 0; ConfigureNamesString[i].gen.name; i++)
2792 struct config_string *conf = &ConfigureNamesString[i];
2794 conf->gen.vartype = PGC_STRING;
2798 for (i = 0; ConfigureNamesEnum[i].gen.name; i++)
2800 struct config_enum *conf = &ConfigureNamesEnum[i];
2802 conf->gen.vartype = PGC_ENUM;
2807 * Create table with 20% slack
2809 size_vars = num_vars + num_vars / 4;
2811 guc_vars = (struct config_generic **)
2812 guc_malloc(FATAL, size_vars * sizeof(struct config_generic *));
2816 for (i = 0; ConfigureNamesBool[i].gen.name; i++)
2817 guc_vars[num_vars++] = &ConfigureNamesBool[i].gen;
2819 for (i = 0; ConfigureNamesInt[i].gen.name; i++)
2820 guc_vars[num_vars++] = &ConfigureNamesInt[i].gen;
2822 for (i = 0; ConfigureNamesReal[i].gen.name; i++)
2823 guc_vars[num_vars++] = &ConfigureNamesReal[i].gen;
2825 for (i = 0; ConfigureNamesString[i].gen.name; i++)
2826 guc_vars[num_vars++] = &ConfigureNamesString[i].gen;
2828 for (i = 0; ConfigureNamesEnum[i].gen.name; i++)
2829 guc_vars[num_vars++] = &ConfigureNamesEnum[i].gen;
2832 free(guc_variables);
2833 guc_variables = guc_vars;
2834 num_guc_variables = num_vars;
2835 size_guc_variables = size_vars;
2836 qsort((void *) guc_variables, num_guc_variables,
2837 sizeof(struct config_generic *), guc_var_compare);
2841 * Add a new GUC variable to the list of known variables. The
2842 * list is expanded if needed.
2845 add_guc_variable(struct config_generic * var, int elevel)
2847 if (num_guc_variables + 1 >= size_guc_variables)
2850 * Increase the vector by 25%
2852 int size_vars = size_guc_variables + size_guc_variables / 4;
2853 struct config_generic **guc_vars;
2858 guc_vars = (struct config_generic **)
2859 guc_malloc(elevel, size_vars * sizeof(struct config_generic *));
2863 guc_vars = (struct config_generic **)
2864 guc_realloc(elevel, guc_variables, size_vars * sizeof(struct config_generic *));
2867 if (guc_vars == NULL)
2868 return false; /* out of memory */
2870 guc_variables = guc_vars;
2871 size_guc_variables = size_vars;
2873 guc_variables[num_guc_variables++] = var;
2874 qsort((void *) guc_variables, num_guc_variables,
2875 sizeof(struct config_generic *), guc_var_compare);
2880 * Create and add a placeholder variable. It's presumed to belong
2881 * to a valid custom variable class at this point.
2883 static struct config_generic *
2884 add_placeholder_variable(const char *name, int elevel)
2886 size_t sz = sizeof(struct config_string) + sizeof(char *);
2887 struct config_string *var;
2888 struct config_generic *gen;
2890 var = (struct config_string *) guc_malloc(elevel, sz);
2896 gen->name = guc_strdup(elevel, name);
2897 if (gen->name == NULL)
2903 gen->context = PGC_USERSET;
2904 gen->group = CUSTOM_OPTIONS;
2905 gen->short_desc = "GUC placeholder variable";
2906 gen->flags = GUC_NO_SHOW_ALL | GUC_NOT_IN_SAMPLE | GUC_CUSTOM_PLACEHOLDER;
2907 gen->vartype = PGC_STRING;
2910 * The char* is allocated at the end of the struct since we have no
2911 * 'static' place to point to. Note that the current value, as well as
2912 * the boot and reset values, start out NULL.
2914 var->variable = (char **) (var + 1);
2916 if (!add_guc_variable((struct config_generic *) var, elevel))
2918 free((void *) gen->name);
2927 * Detect whether the portion of "name" before dotPos matches any custom
2928 * variable class name listed in custom_var_classes. The latter must be
2929 * formatted the way that assign_custom_variable_classes does it, ie,
2930 * no whitespace. NULL is valid for custom_var_classes.
2933 is_custom_class(const char *name, int dotPos, const char *custom_var_classes)
2935 bool result = false;
2936 const char *ccs = custom_var_classes;
2940 const char *start = ccs;
2946 if (c == '\0' || c == ',')
2948 if (dotPos == ccs - start && strncmp(start, name, dotPos) == 0)
2963 * Look up option NAME. If it exists, return a pointer to its record,
2964 * else return NULL. If create_placeholders is TRUE, we'll create a
2965 * placeholder record for a valid-looking custom variable name.
2967 static struct config_generic *
2968 find_option(const char *name, bool create_placeholders, int elevel)
2970 const char **key = &name;
2971 struct config_generic **res;
2977 * By equating const char ** with struct config_generic *, we are assuming
2978 * the name field is first in config_generic.
2980 res = (struct config_generic **) bsearch((void *) &key,
2981 (void *) guc_variables,
2983 sizeof(struct config_generic *),
2989 * See if the name is an obsolete name for a variable. We assume that the
2990 * set of supported old names is short enough that a brute-force search is
2993 for (i = 0; map_old_guc_names[i] != NULL; i += 2)
2995 if (guc_name_compare(name, map_old_guc_names[i]) == 0)
2996 return find_option(map_old_guc_names[i + 1], false, elevel);
2999 if (create_placeholders)
3002 * Check if the name is qualified, and if so, check if the qualifier
3003 * matches any custom variable class. If so, add a placeholder.
3005 const char *dot = strchr(name, GUC_QUALIFIER_SEPARATOR);
3008 is_custom_class(name, dot - name, custom_variable_classes))
3009 return add_placeholder_variable(name, elevel);
3018 * comparator for qsorting and bsearching guc_variables array
3021 guc_var_compare(const void *a, const void *b)
3023 struct config_generic *confa = *(struct config_generic **) a;
3024 struct config_generic *confb = *(struct config_generic **) b;
3026 return guc_name_compare(confa->name, confb->name);
3030 * the bare comparison function for GUC names
3033 guc_name_compare(const char *namea, const char *nameb)
3036 * The temptation to use strcasecmp() here must be resisted, because the
3037 * array ordering has to remain stable across setlocale() calls. So, build
3038 * our own with a simple ASCII-only downcasing.
3040 while (*namea && *nameb)
3042 char cha = *namea++;
3043 char chb = *nameb++;
3045 if (cha >= 'A' && cha <= 'Z')
3047 if (chb >= 'A' && chb <= 'Z')
3053 return 1; /* a is longer */
3055 return -1; /* b is longer */
3061 * Initialize GUC options during program startup.
3063 * Note that we cannot read the config file yet, since we have not yet
3064 * processed command-line switches.
3067 InitializeGUCOptions(void)
3074 * Before log_line_prefix could possibly receive a nonempty setting, make
3075 * sure that timezone processing is minimally alive (see elog.c).
3077 pg_timezone_pre_initialize();
3080 * Build sorted array of all GUC variables.
3082 build_guc_variables();
3085 * Load all variables with their compiled-in defaults, and initialize
3086 * status fields as needed.
3088 for (i = 0; i < num_guc_variables; i++)
3090 struct config_generic *gconf = guc_variables[i];
3093 gconf->reset_source = PGC_S_DEFAULT;
3094 gconf->source = PGC_S_DEFAULT;
3095 gconf->stack = NULL;
3097 switch (gconf->vartype)
3101 struct config_bool *conf = (struct config_bool *) gconf;
3103 if (conf->assign_hook)
3104 if (!(*conf->assign_hook) (conf->boot_val, true,
3106 elog(FATAL, "failed to initialize %s to %d",
3107 conf->gen.name, (int) conf->boot_val);
3108 *conf->variable = conf->reset_val = conf->boot_val;
3113 struct config_int *conf = (struct config_int *) gconf;
3115 Assert(conf->boot_val >= conf->min);
3116 Assert(conf->boot_val <= conf->max);
3117 if (conf->assign_hook)
3118 if (!(*conf->assign_hook) (conf->boot_val, true,
3120 elog(FATAL, "failed to initialize %s to %d",
3121 conf->gen.name, conf->boot_val);
3122 *conf->variable = conf->reset_val = conf->boot_val;
3127 struct config_real *conf = (struct config_real *) gconf;
3129 Assert(conf->boot_val >= conf->min);
3130 Assert(conf->boot_val <= conf->max);
3131 if (conf->assign_hook)
3132 if (!(*conf->assign_hook) (conf->boot_val, true,
3134 elog(FATAL, "failed to initialize %s to %g",
3135 conf->gen.name, conf->boot_val);
3136 *conf->variable = conf->reset_val = conf->boot_val;
3141 struct config_string *conf = (struct config_string *) gconf;
3144 *conf->variable = NULL;
3145 conf->reset_val = NULL;
3147 if (conf->boot_val == NULL)
3149 /* leave the value NULL, do not call assign hook */
3153 str = guc_strdup(FATAL, conf->boot_val);
3154 conf->reset_val = str;
3156 if (conf->assign_hook)
3160 newstr = (*conf->assign_hook) (str, true,
3164 elog(FATAL, "failed to initialize %s to \"%s\"",
3165 conf->gen.name, str);
3167 else if (newstr != str)
3172 * See notes in set_config_option about casting
3174 str = (char *) newstr;
3175 conf->reset_val = str;
3178 *conf->variable = str;
3183 struct config_enum *conf = (struct config_enum *) gconf;
3185 if (conf->assign_hook)
3186 if (!(*conf->assign_hook) (conf->boot_val, true,
3188 elog(FATAL, "failed to initialize %s to %s",
3190 config_enum_lookup_by_value(conf, conf->boot_val));
3191 *conf->variable = conf->reset_val = conf->boot_val;
3199 reporting_enabled = false;
3202 * Prevent any attempt to override the transaction modes from
3203 * non-interactive sources.
3205 SetConfigOption("transaction_isolation", "default",
3206 PGC_POSTMASTER, PGC_S_OVERRIDE);
3207 SetConfigOption("transaction_read_only", "no",
3208 PGC_POSTMASTER, PGC_S_OVERRIDE);
3211 * For historical reasons, some GUC parameters can receive defaults from
3212 * environment variables. Process those settings. NB: if you add or
3213 * remove anything here, see also ProcessConfigFile().
3216 env = getenv("PGPORT");
3218 SetConfigOption("port", env, PGC_POSTMASTER, PGC_S_ENV_VAR);
3220 env = getenv("PGDATESTYLE");
3222 SetConfigOption("datestyle", env, PGC_POSTMASTER, PGC_S_ENV_VAR);
3224 env = getenv("PGCLIENTENCODING");
3226 SetConfigOption("client_encoding", env, PGC_POSTMASTER, PGC_S_ENV_VAR);
3229 * rlimit isn't exactly an "environment variable", but it behaves about
3230 * the same. If we can identify the platform stack depth rlimit, increase
3231 * default stack depth setting up to whatever is safe (but at most 2MB).
3233 stack_rlimit = get_stack_depth_rlimit();
3234 if (stack_rlimit > 0)
3236 int new_limit = (stack_rlimit - STACK_DEPTH_SLOP) / 1024L;
3238 if (new_limit > 100)
3242 new_limit = Min(new_limit, 2048);
3243 sprintf(limbuf, "%d", new_limit);
3244 SetConfigOption("max_stack_depth", limbuf,
3245 PGC_POSTMASTER, PGC_S_ENV_VAR);
3252 * Select the configuration files and data directory to be used, and
3253 * do the initial read of postgresql.conf.
3255 * This is called after processing command-line switches.
3256 * userDoption is the -D switch value if any (NULL if unspecified).
3257 * progname is just for use in error messages.
3259 * Returns true on success; on failure, prints a suitable error message
3260 * to stderr and returns false.
3263 SelectConfigFiles(const char *userDoption, const char *progname)
3267 struct stat stat_buf;
3269 /* configdir is -D option, or $PGDATA if no -D */
3271 configdir = make_absolute_path(userDoption);
3273 configdir = make_absolute_path(getenv("PGDATA"));
3276 * Find the configuration file: if config_file was specified on the
3277 * command line, use it, else use configdir/postgresql.conf. In any case
3278 * ensure the result is an absolute path, so that it will be interpreted
3279 * the same way by future backends.
3282 fname = make_absolute_path(ConfigFileName);
3285 fname = guc_malloc(FATAL,
3286 strlen(configdir) + strlen(CONFIG_FILENAME) + 2);
3287 sprintf(fname, "%s/%s", configdir, CONFIG_FILENAME);
3291 write_stderr("%s does not know where to find the server configuration file.\n"
3292 "You must specify the --config-file or -D invocation "
3293 "option or set the PGDATA environment variable.\n",
3299 * Set the ConfigFileName GUC variable to its final value, ensuring that
3300 * it can't be overridden later.
3302 SetConfigOption("config_file", fname, PGC_POSTMASTER, PGC_S_OVERRIDE);
3306 * Now read the config file for the first time.
3308 if (stat(ConfigFileName, &stat_buf) != 0)
3310 write_stderr("%s cannot access the server configuration file \"%s\": %s\n",
3311 progname, ConfigFileName, strerror(errno));
3315 ProcessConfigFile(PGC_POSTMASTER);
3318 * If the data_directory GUC variable has been set, use that as DataDir;
3319 * otherwise use configdir if set; else punt.
3321 * Note: SetDataDir will copy and absolute-ize its argument, so we don't
3325 SetDataDir(data_directory);
3327 SetDataDir(configdir);
3330 write_stderr("%s does not know where to find the database system data.\n"
3331 "This can be specified as \"data_directory\" in \"%s\", "
3332 "or by the -D invocation option, or by the "
3333 "PGDATA environment variable.\n",
3334 progname, ConfigFileName);
3339 * Reflect the final DataDir value back into the data_directory GUC var.
3340 * (If you are wondering why we don't just make them a single variable,
3341 * it's because the EXEC_BACKEND case needs DataDir to be transmitted to
3342 * child backends specially. XXX is that still true? Given that we now
3343 * chdir to DataDir, EXEC_BACKEND can read the config file without knowing
3344 * DataDir in advance.)
3346 SetConfigOption("data_directory", DataDir, PGC_POSTMASTER, PGC_S_OVERRIDE);
3349 * Figure out where pg_hba.conf is, and make sure the path is absolute.
3352 fname = make_absolute_path(HbaFileName);
3355 fname = guc_malloc(FATAL,
3356 strlen(configdir) + strlen(HBA_FILENAME) + 2);
3357 sprintf(fname, "%s/%s", configdir, HBA_FILENAME);
3361 write_stderr("%s does not know where to find the \"hba\" configuration file.\n"
3362 "This can be specified as \"hba_file\" in \"%s\", "
3363 "or by the -D invocation option, or by the "
3364 "PGDATA environment variable.\n",
3365 progname, ConfigFileName);
3368 SetConfigOption("hba_file", fname, PGC_POSTMASTER, PGC_S_OVERRIDE);
3372 * Likewise for pg_ident.conf.
3375 fname = make_absolute_path(IdentFileName);
3378 fname = guc_malloc(FATAL,
3379 strlen(configdir) + strlen(IDENT_FILENAME) + 2);
3380 sprintf(fname, "%s/%s", configdir, IDENT_FILENAME);
3384 write_stderr("%s does not know where to find the \"ident\" configuration file.\n"
3385 "This can be specified as \"ident_file\" in \"%s\", "
3386 "or by the -D invocation option, or by the "
3387 "PGDATA environment variable.\n",
3388 progname, ConfigFileName);
3391 SetConfigOption("ident_file", fname, PGC_POSTMASTER, PGC_S_OVERRIDE);
3401 * Reset all options to their saved default values (implements RESET ALL)
3404 ResetAllOptions(void)
3408 for (i = 0; i < num_guc_variables; i++)
3410 struct config_generic *gconf = guc_variables[i];
3412 /* Don't reset non-SET-able values */
3413 if (gconf->context != PGC_SUSET &&
3414 gconf->context != PGC_USERSET)
3416 /* Don't reset if special exclusion from RESET ALL */
3417 if (gconf->flags & GUC_NO_RESET_ALL)
3419 /* No need to reset if wasn't SET */
3420 if (gconf->source <= PGC_S_OVERRIDE)
3423 /* Save old value to support transaction abort */
3424 push_old_value(gconf, GUC_ACTION_SET);
3426 switch (gconf->vartype)
3430 struct config_bool *conf = (struct config_bool *) gconf;
3432 if (conf->assign_hook)
3433 if (!(*conf->assign_hook) (conf->reset_val, true,
3435 elog(ERROR, "failed to reset %s", conf->gen.name);
3436 *conf->variable = conf->reset_val;
3437 conf->gen.source = conf->gen.reset_source;
3442 struct config_int *conf = (struct config_int *) gconf;
3444 if (conf->assign_hook)
3445 if (!(*conf->assign_hook) (conf->reset_val, true,
3447 elog(ERROR, "failed to reset %s", conf->gen.name);
3448 *conf->variable = conf->reset_val;
3449 conf->gen.source = conf->gen.reset_source;
3454 struct config_real *conf = (struct config_real *) gconf;
3456 if (conf->assign_hook)
3457 if (!(*conf->assign_hook) (conf->reset_val, true,
3459 elog(ERROR, "failed to reset %s", conf->gen.name);
3460 *conf->variable = conf->reset_val;
3461 conf->gen.source = conf->gen.reset_source;
3466 struct config_string *conf = (struct config_string *) gconf;
3469 /* We need not strdup here */
3470 str = conf->reset_val;
3472 if (conf->assign_hook && str)
3476 newstr = (*conf->assign_hook) (str, true,
3479 elog(ERROR, "failed to reset %s", conf->gen.name);
3480 else if (newstr != str)
3483 * See notes in set_config_option about casting
3485 str = (char *) newstr;
3489 set_string_field(conf, conf->variable, str);
3490 conf->gen.source = conf->gen.reset_source;
3495 struct config_enum *conf = (struct config_enum *) gconf;
3497 if (conf->assign_hook)
3498 if (!(*conf->assign_hook) (conf->reset_val, true,
3500 elog(ERROR, "failed to reset %s", conf->gen.name);
3501 *conf->variable = conf->reset_val;
3502 conf->gen.source = conf->gen.reset_source;
3507 if (gconf->flags & GUC_REPORT)
3508 ReportGUCOption(gconf);
3515 * Push previous state during transactional assignment to a GUC variable.
3518 push_old_value(struct config_generic * gconf, GucAction action)
3522 /* If we're not inside a nest level, do nothing */
3523 if (GUCNestLevel == 0)
3526 /* Do we already have a stack entry of the current nest level? */
3527 stack = gconf->stack;
3528 if (stack && stack->nest_level >= GUCNestLevel)
3530 /* Yes, so adjust its state if necessary */
3531 Assert(stack->nest_level == GUCNestLevel);
3534 case GUC_ACTION_SET:
3535 /* SET overrides any prior action at same nest level */
3536 if (stack->state == GUC_SET_LOCAL)
3538 /* must discard old masked value */
3539 discard_stack_value(gconf, &stack->masked);
3541 stack->state = GUC_SET;
3543 case GUC_ACTION_LOCAL:
3544 if (stack->state == GUC_SET)
3546 /* SET followed by SET LOCAL, remember SET's value */
3547 set_stack_value(gconf, &stack->masked);
3548 stack->state = GUC_SET_LOCAL;
3550 /* in all other cases, no change to stack entry */
3552 case GUC_ACTION_SAVE:
3553 /* Could only have a prior SAVE of same variable */
3554 Assert(stack->state == GUC_SAVE);
3557 Assert(guc_dirty); /* must be set already */
3562 * Push a new stack entry
3564 * We keep all the stack entries in TopTransactionContext for simplicity.
3566 stack = (GucStack *) MemoryContextAllocZero(TopTransactionContext,
3569 stack->prev = gconf->stack;
3570 stack->nest_level = GUCNestLevel;
3573 case GUC_ACTION_SET:
3574 stack->state = GUC_SET;
3576 case GUC_ACTION_LOCAL:
3577 stack->state = GUC_LOCAL;
3579 case GUC_ACTION_SAVE:
3580 stack->state = GUC_SAVE;
3583 stack->source = gconf->source;
3584 set_stack_value(gconf, &stack->prior);
3586 gconf->stack = stack;
3588 /* Ensure we remember to pop at end of xact */
3594 * Do GUC processing at main transaction start.
3600 * The nest level should be 0 between transactions; if it isn't, somebody
3601 * didn't call AtEOXact_GUC, or called it with the wrong nestLevel. We
3602 * throw a warning but make no other effort to clean up.
3604 if (GUCNestLevel != 0)
3605 elog(WARNING, "GUC nest level = %d at transaction start",
3611 * Enter a new nesting level for GUC values. This is called at subtransaction
3612 * start and when entering a function that has proconfig settings. NOTE that
3613 * we must not risk error here, else subtransaction start will be unhappy.
3616 NewGUCNestLevel(void)
3618 return ++GUCNestLevel;
3622 * Do GUC processing at transaction or subtransaction commit or abort, or
3623 * when exiting a function that has proconfig settings. (The name is thus
3624 * a bit of a misnomer; perhaps it should be ExitGUCNestLevel or some such.)
3625 * During abort, we discard all GUC settings that were applied at nesting
3626 * levels >= nestLevel. nestLevel == 1 corresponds to the main transaction.
3629 AtEOXact_GUC(bool isCommit, int nestLevel)
3634 Assert(nestLevel > 0 && nestLevel <= GUCNestLevel);
3636 /* Quick exit if nothing's changed in this transaction */
3639 GUCNestLevel = nestLevel - 1;
3643 still_dirty = false;
3644 for (i = 0; i < num_guc_variables; i++)
3646 struct config_generic *gconf = guc_variables[i];
3650 * Process and pop each stack entry within the nest level. To
3651 * simplify fmgr_security_definer(), we allow failure exit from a
3652 * function-with-SET-options to be recovered at the surrounding
3653 * transaction or subtransaction abort; so there could be more than
3654 * one stack entry to pop.
3656 while ((stack = gconf->stack) != NULL &&
3657 stack->nest_level >= nestLevel)
3659 GucStack *prev = stack->prev;
3660 bool restorePrior = false;
3661 bool restoreMasked = false;
3665 * In this next bit, if we don't set either restorePrior or
3666 * restoreMasked, we must "discard" any unwanted fields of the
3667 * stack entries to avoid leaking memory. If we do set one of
3668 * those flags, unused fields will be cleaned up after restoring.
3670 if (!isCommit) /* if abort, always restore prior value */
3671 restorePrior = true;
3672 else if (stack->state == GUC_SAVE)
3673 restorePrior = true;
3674 else if (stack->nest_level == 1)
3676 /* transaction commit */
3677 if (stack->state == GUC_SET_LOCAL)
3678 restoreMasked = true;
3679 else if (stack->state == GUC_SET)
3681 /* we keep the current active value */
3682 discard_stack_value(gconf, &stack->prior);
3684 else /* must be GUC_LOCAL */
3685 restorePrior = true;
3687 else if (prev == NULL ||
3688 prev->nest_level < stack->nest_level - 1)
3690 /* decrement entry's level and do not pop it */
3691 stack->nest_level--;
3697 * We have to merge this stack entry into prev. See README for
3698 * discussion of this bit.
3700 switch (stack->state)
3703 Assert(false); /* can't get here */
3706 /* next level always becomes SET */
3707 discard_stack_value(gconf, &stack->prior);
3708 if (prev->state == GUC_SET_LOCAL)
3709 discard_stack_value(gconf, &prev->masked);
3710 prev->state = GUC_SET;
3714 if (prev->state == GUC_SET)
3716 /* LOCAL migrates down */
3717 prev->masked = stack->prior;
3718 prev->state = GUC_SET_LOCAL;
3722 /* else just forget this stack level */
3723 discard_stack_value(gconf, &stack->prior);
3728 /* prior state at this level no longer wanted */
3729 discard_stack_value(gconf, &stack->prior);
3730 /* copy down the masked state */
3731 if (prev->state == GUC_SET_LOCAL)
3732 discard_stack_value(gconf, &prev->masked);
3733 prev->masked = stack->masked;
3734 prev->state = GUC_SET_LOCAL;
3741 if (restorePrior || restoreMasked)
3743 /* Perform appropriate restoration of the stacked value */
3744 union config_var_value newvalue;
3745 GucSource newsource;
3749 newvalue = stack->masked;
3750 newsource = PGC_S_SESSION;
3754 newvalue = stack->prior;
3755 newsource = stack->source;
3758 switch (gconf->vartype)
3762 struct config_bool *conf = (struct config_bool *) gconf;
3763 bool newval = newvalue.boolval;
3765 if (*conf->variable != newval)
3767 if (conf->assign_hook)
3768 if (!(*conf->assign_hook) (newval,
3769 true, PGC_S_OVERRIDE))
3770 elog(LOG, "failed to commit %s",
3772 *conf->variable = newval;
3779 struct config_int *conf = (struct config_int *) gconf;
3780 int newval = newvalue.intval;
3782 if (*conf->variable != newval)
3784 if (conf->assign_hook)
3785 if (!(*conf->assign_hook) (newval,
3786 true, PGC_S_OVERRIDE))
3787 elog(LOG, "failed to commit %s",
3789 *conf->variable = newval;
3796 struct config_real *conf = (struct config_real *) gconf;
3797 double newval = newvalue.realval;
3799 if (*conf->variable != newval)
3801 if (conf->assign_hook)
3802 if (!(*conf->assign_hook) (newval,
3803 true, PGC_S_OVERRIDE))
3804 elog(LOG, "failed to commit %s",
3806 *conf->variable = newval;
3813 struct config_string *conf = (struct config_string *) gconf;
3814 char *newval = newvalue.stringval;
3816 if (*conf->variable != newval)
3818 if (conf->assign_hook && newval)
3822 newstr = (*conf->assign_hook) (newval, true,
3825 elog(LOG, "failed to commit %s",
3827 else if (newstr != newval)
3830 * If newval should now be freed,
3831 * it'll be taken care of below.
3833 * See notes in set_config_option
3836 newval = (char *) newstr;
3840 set_string_field(conf, conf->variable, newval);
3845 * Release stacked values if not used anymore. We
3846 * could use discard_stack_value() here, but since
3847 * we have type-specific code anyway, might as
3850 set_string_field(conf, &stack->prior.stringval, NULL);
3851 set_string_field(conf, &stack->masked.stringval, NULL);
3856 struct config_enum *conf = (struct config_enum *) gconf;
3857 int newval = newvalue.enumval;
3859 if (*conf->variable != newval)
3861 if (conf->assign_hook)
3862 if (!(*conf->assign_hook) (newval,
3863 true, PGC_S_OVERRIDE))
3864 elog(LOG, "failed to commit %s",
3866 *conf->variable = newval;
3873 gconf->source = newsource;
3876 /* Finish popping the state stack */
3877 gconf->stack = prev;
3880 /* Report new value if we changed it */
3881 if (changed && (gconf->flags & GUC_REPORT))
3882 ReportGUCOption(gconf);
3883 } /* end of stack-popping loop */
3889 /* If there are no remaining stack entries, we can reset guc_dirty */
3890 guc_dirty = still_dirty;
3892 /* Update nesting level */
3893 GUCNestLevel = nestLevel - 1;
3898 * Start up automatic reporting of changes to variables marked GUC_REPORT.
3899 * This is executed at completion of backend startup.
3902 BeginReportingGUCOptions(void)
3907 * Don't do anything unless talking to an interactive frontend of protocol
3910 if (whereToSendOutput != DestRemote ||
3911 PG_PROTOCOL_MAJOR(FrontendProtocol) < 3)
3914 reporting_enabled = true;
3916 /* Transmit initial values of interesting variables */
3917 for (i = 0; i < num_guc_variables; i++)
3919 struct config_generic *conf = guc_variables[i];
3921 if (conf->flags & GUC_REPORT)
3922 ReportGUCOption(conf);
3927 * ReportGUCOption: if appropriate, transmit option value to frontend
3930 ReportGUCOption(struct config_generic * record)
3932 if (reporting_enabled && (record->flags & GUC_REPORT))
3934 char *val = _ShowOption(record, false);
3935 StringInfoData msgbuf;
3937 pq_beginmessage(&msgbuf, 'S');
3938 pq_sendstring(&msgbuf, record->name);
3939 pq_sendstring(&msgbuf, val);
3940 pq_endmessage(&msgbuf);
3948 * Try to interpret value as boolean value. Valid values are: true,
3949 * false, yes, no, on, off, 1, 0; as well as unique prefixes thereof.
3950 * If the string parses okay, return true, else false.
3951 * If okay and result is not NULL, return the value in *result.
3954 parse_bool(const char *value, bool *result)
3956 size_t len = strlen(value);
3958 if (pg_strncasecmp(value, "true", len) == 0)
3963 else if (pg_strncasecmp(value, "false", len) == 0)
3969 else if (pg_strncasecmp(value, "yes", len) == 0)
3974 else if (pg_strncasecmp(value, "no", len) == 0)
3980 /* 'o' is not unique enough */
3981 else if (pg_strncasecmp(value, "on", (len > 2 ? len : 2)) == 0)
3986 else if (pg_strncasecmp(value, "off", (len > 2 ? len : 2)) == 0)
3992 else if (pg_strcasecmp(value, "1") == 0)
3997 else if (pg_strcasecmp(value, "0") == 0)
4006 *result = false; /* suppress compiler warning */
4015 * Try to parse value as an integer. The accepted formats are the
4016 * usual decimal, octal, or hexadecimal formats, optionally followed by
4017 * a unit name if "flags" indicates a unit is allowed.
4019 * If the string parses okay, return true, else false.
4020 * If okay and result is not NULL, return the value in *result.
4021 * If not okay and hintmsg is not NULL, *hintmsg is set to a suitable
4022 * HINT message, or NULL if no hint provided.
4025 parse_int(const char *value, int *result, int flags, const char **hintmsg)
4030 /* To suppress compiler warnings, always set output params */
4036 /* We assume here that int64 is at least as wide as long */
4038 val = strtol(value, &endptr, 0);
4040 if (endptr == value)
4041 return false; /* no HINT for integer syntax error */
4043 if (errno == ERANGE || val != (int64) ((int32) val))
4046 *hintmsg = gettext_noop("Value exceeds integer range.");
4050 /* allow whitespace between integer and unit */
4051 while (isspace((unsigned char) *endptr))
4054 /* Handle possible unit */
4055 if (*endptr != '\0')
4058 * Note: the multiple-switch coding technique here is a bit tedious,
4059 * but seems necessary to avoid intermediate-value overflows.
4061 * If INT64_IS_BUSTED (ie, it's really int32) we will fail to detect
4062 * overflow due to units conversion, but there are few enough such
4063 * machines that it does not seem worth trying to be smarter.
4065 if (flags & GUC_UNIT_MEMORY)
4067 /* Set hint for use if no match or trailing garbage */
4069 *hintmsg = gettext_noop("Valid units for this parameter are \"kB\", \"MB\", and \"GB\".");
4071 #if BLCKSZ < 1024 || BLCKSZ > (1024*1024)
4072 #error BLCKSZ must be between 1KB and 1MB
4074 #if XLOG_BLCKSZ < 1024 || XLOG_BLCKSZ > (1024*1024)
4075 #error XLOG_BLCKSZ must be between 1KB and 1MB
4078 if (strncmp(endptr, "kB", 2) == 0)
4081 switch (flags & GUC_UNIT_MEMORY)
4083 case GUC_UNIT_BLOCKS:
4084 val /= (BLCKSZ / 1024);
4086 case GUC_UNIT_XBLOCKS:
4087 val /= (XLOG_BLCKSZ / 1024);
4091 else if (strncmp(endptr, "MB", 2) == 0)
4094 switch (flags & GUC_UNIT_MEMORY)
4099 case GUC_UNIT_BLOCKS:
4100 val *= KB_PER_MB / (BLCKSZ / 1024);
4102 case GUC_UNIT_XBLOCKS:
4103 val *= KB_PER_MB / (XLOG_BLCKSZ / 1024);
4107 else if (strncmp(endptr, "GB", 2) == 0)
4110 switch (flags & GUC_UNIT_MEMORY)
4115 case GUC_UNIT_BLOCKS:
4116 val *= KB_PER_GB / (BLCKSZ / 1024);
4118 case GUC_UNIT_XBLOCKS:
4119 val *= KB_PER_GB / (XLOG_BLCKSZ / 1024);
4124 else if (flags & GUC_UNIT_TIME)
4126 /* Set hint for use if no match or trailing garbage */
4128 *hintmsg = gettext_noop("Valid units for this parameter are \"ms\", \"s\", \"min\", \"h\", and \"d\".");
4130 if (strncmp(endptr, "ms", 2) == 0)
4133 switch (flags & GUC_UNIT_TIME)
4143 else if (strncmp(endptr, "s", 1) == 0)
4146 switch (flags & GUC_UNIT_TIME)
4156 else if (strncmp(endptr, "min", 3) == 0)
4159 switch (flags & GUC_UNIT_TIME)
4169 else if (strncmp(endptr, "h", 1) == 0)
4172 switch (flags & GUC_UNIT_TIME)
4185 else if (strncmp(endptr, "d", 1) == 0)
4188 switch (flags & GUC_UNIT_TIME)
4203 /* allow whitespace after unit */
4204 while (isspace((unsigned char) *endptr))
4207 if (*endptr != '\0')
4208 return false; /* appropriate hint, if any, already set */
4210 /* Check for overflow due to units conversion */
4211 if (val != (int64) ((int32) val))
4214 *hintmsg = gettext_noop("Value exceeds integer range.");
4220 *result = (int) val;
4227 * Try to parse value as a floating point number in the usual format.
4228 * If the string parses okay, return true, else false.
4229 * If okay and result is not NULL, return the value in *result.
4232 parse_real(const char *value, double *result)
4238 *result = 0; /* suppress compiler warning */
4241 val = strtod(value, &endptr);
4242 if (endptr == value || errno == ERANGE)
4245 /* allow whitespace after number */
4246 while (isspace((unsigned char) *endptr))
4248 if (*endptr != '\0')
4258 * Lookup the name for an enum option with the selected value.
4259 * Should only ever be called with known-valid values, so throws
4260 * an elog(ERROR) if the enum option is not found.
4262 * The returned string is a pointer to static data and not
4263 * allocated for modification.
4266 config_enum_lookup_by_value(struct config_enum *record, int val)
4268 const struct config_enum_entry *entry = record->options;
4269 while (entry && entry->name)
4271 if (entry->val == val)
4275 elog(ERROR, "could not find enum option %d for %s",
4276 val, record->gen.name);
4277 return NULL; /* silence compiler */
4282 * Lookup the value for an enum option with the selected name
4283 * (case-insensitive).
4284 * If the enum option is found, sets the retval value and returns
4285 * true. If it's not found, return FALSE and retval is set to 0.
4289 config_enum_lookup_by_name(struct config_enum *record, const char *value, int *retval)
4291 const struct config_enum_entry *entry = record->options;
4294 *retval = 0; /* suppress compiler warning */
4296 while (entry && entry->name)
4298 if (pg_strcasecmp(value, entry->name) == 0)
4300 *retval = entry->val;
4310 * Return a list of all available options for an enum, separated
4311 * by ", " (comma-space).
4312 * If prefix is non-NULL, it is added before the first enum value.
4313 * If suffix is non-NULL, it is added to the end of the string.
4316 config_enum_get_options(struct config_enum *record, const char *prefix, const char *suffix)
4318 const struct config_enum_entry *entry = record->options;
4322 if (!entry || !entry->name)
4323 return NULL; /* Should not happen */
4325 while (entry && entry->name)
4327 len += strlen(entry->name) + 2; /* string and ", " */
4331 hintmsg = palloc(len + strlen(prefix) + strlen(suffix) + 2);
4333 strcpy(hintmsg, prefix);
4335 entry = record->options;
4336 while (entry && entry->name)
4338 strcat(hintmsg, entry->name);
4339 strcat(hintmsg, ", ");
4343 /* Replace final comma/space */
4344 hintmsg[strlen(hintmsg)-2] = '\0';
4345 strcat(hintmsg, suffix);
4352 * Call a GucStringAssignHook function, being careful to free the
4353 * "newval" string if the hook ereports.
4355 * This is split out of set_config_option just to avoid the "volatile"
4356 * qualifiers that would otherwise have to be plastered all over.
4359 call_string_assign_hook(GucStringAssignHook assign_hook,
4360 char *newval, bool doit, GucSource source)
4366 result = (*assign_hook) (newval, doit, source);
4380 * Sets option `name' to given value. The value should be a string
4381 * which is going to be parsed and converted to the appropriate data
4382 * type. The context and source parameters indicate in which context this
4383 * function is being called so it can apply the access restrictions
4386 * If value is NULL, set the option to its default value (normally the
4387 * reset_val, but if source == PGC_S_DEFAULT we instead use the boot_val).
4389 * action indicates whether to set the value globally in the session, locally
4390 * to the current top transaction, or just for the duration of a function call.
4392 * If changeVal is false then don't really set the option but do all
4393 * the checks to see if it would work.
4395 * If there is an error (non-existing option, invalid value) then an
4396 * ereport(ERROR) is thrown *unless* this is called in a context where we
4397 * don't want to ereport (currently, startup or SIGHUP config file reread).
4398 * In that case we write a suitable error message via ereport(LOG) and
4399 * return false. This is working around the deficiencies in the ereport
4400 * mechanism, so don't blame me. In all other cases, the function
4401 * returns true, including cases where the input is valid but we chose
4402 * not to apply it because of context or source-priority considerations.
4404 * See also SetConfigOption for an external interface.
4407 set_config_option(const char *name, const char *value,
4408 GucContext context, GucSource source,
4409 GucAction action, bool changeVal)
4411 struct config_generic *record;
4415 if (context == PGC_SIGHUP || source == PGC_S_DEFAULT)
4418 * To avoid cluttering the log, only the postmaster bleats loudly
4419 * about problems with the config file.
4421 elevel = IsUnderPostmaster ? DEBUG3 : LOG;
4423 else if (source == PGC_S_DATABASE || source == PGC_S_USER)
4428 record = find_option(name, true, elevel);
4432 (errcode(ERRCODE_UNDEFINED_OBJECT),
4433 errmsg("unrecognized configuration parameter \"%s\"", name)));
4438 * If source is postgresql.conf, mark the found record with
4439 * GUC_IS_IN_FILE. This is for the convenience of ProcessConfigFile. Note
4440 * that we do it even if changeVal is false, since ProcessConfigFile wants
4441 * the marking to occur during its testing pass.
4443 if (source == PGC_S_FILE)
4444 record->status |= GUC_IS_IN_FILE;
4447 * Check if the option can be set at this time. See guc.h for the precise
4448 * rules. Note that we don't want to throw errors if we're in the SIGHUP
4449 * context. In that case we just ignore the attempt and return true.
4451 switch (record->context)
4454 if (context == PGC_SIGHUP)
4456 if (context != PGC_INTERNAL)
4459 (errcode(ERRCODE_CANT_CHANGE_RUNTIME_PARAM),
4460 errmsg("parameter \"%s\" cannot be changed",
4465 case PGC_POSTMASTER:
4466 if (context == PGC_SIGHUP)
4469 * We are reading a PGC_POSTMASTER var from postgresql.conf.
4470 * We can't change the setting, so give a warning if the DBA
4471 * tries to change it. (Throwing an error would be more
4472 * consistent, but seems overly rigid.)
4474 if (changeVal && !is_newvalue_equal(record, value))
4476 (errcode(ERRCODE_CANT_CHANGE_RUNTIME_PARAM),
4477 errmsg("parameter \"%s\" cannot be changed after server start; configuration file change ignored",
4481 if (context != PGC_POSTMASTER)
4484 (errcode(ERRCODE_CANT_CHANGE_RUNTIME_PARAM),
4485 errmsg("parameter \"%s\" cannot be changed after server start",
4491 if (context != PGC_SIGHUP && context != PGC_POSTMASTER)
4494 (errcode(ERRCODE_CANT_CHANGE_RUNTIME_PARAM),
4495 errmsg("parameter \"%s\" cannot be changed now",
4501 * Hmm, the idea of the SIGHUP context is "ought to be global, but
4502 * can be changed after postmaster start". But there's nothing
4503 * that prevents a crafty administrator from sending SIGHUP
4504 * signals to individual backends only.
4508 if (context == PGC_SIGHUP)
4511 * If a PGC_BACKEND parameter is changed in the config file,
4512 * we want to accept the new value in the postmaster (whence
4513 * it will propagate to subsequently-started backends), but
4514 * ignore it in existing backends. This is a tad klugy, but
4515 * necessary because we don't re-read the config file during
4518 if (IsUnderPostmaster)
4521 else if (context != PGC_BACKEND && context != PGC_POSTMASTER)
4524 (errcode(ERRCODE_CANT_CHANGE_RUNTIME_PARAM),
4525 errmsg("parameter \"%s\" cannot be set after connection start",
4531 if (context == PGC_USERSET || context == PGC_BACKEND)
4534 (errcode(ERRCODE_INSUFFICIENT_PRIVILEGE),
4535 errmsg("permission denied to set parameter \"%s\"",
4546 * Should we set reset/stacked values? (If so, the behavior is not
4547 * transactional.) This is done either when we get a default value from
4548 * the database's/user's/client's default settings or when we reset a
4549 * value to its default.
4551 makeDefault = changeVal && (source <= PGC_S_OVERRIDE) &&
4552 ((value != NULL) || source == PGC_S_DEFAULT);
4555 * Ignore attempted set if overridden by previously processed setting.
4556 * However, if changeVal is false then plow ahead anyway since we are
4557 * trying to find out if the value is potentially good, not actually use
4558 * it. Also keep going if makeDefault is true, since we may want to set
4559 * the reset/stacked values even if we can't set the variable itself.
4561 if (record->source > source)
4563 if (changeVal && !makeDefault)
4565 elog(DEBUG3, "\"%s\": setting ignored because previous source is higher priority",
4573 * Evaluate value and set variable.
4575 switch (record->vartype)
4579 struct config_bool *conf = (struct config_bool *) record;
4584 if (!parse_bool(value, &newval))
4587 (errcode(ERRCODE_INVALID_PARAMETER_VALUE),
4588 errmsg("parameter \"%s\" requires a Boolean value",
4593 else if (source == PGC_S_DEFAULT)
4594 newval = conf->boot_val;
4597 newval = conf->reset_val;
4598 source = conf->gen.reset_source;
4601 if (conf->assign_hook)
4602 if (!(*conf->assign_hook) (newval, changeVal, source))
4605 (errcode(ERRCODE_INVALID_PARAMETER_VALUE),
4606 errmsg("invalid value for parameter \"%s\": %d",
4607 name, (int) newval)));
4611 if (changeVal || makeDefault)
4613 /* Save old value to support transaction abort */
4615 push_old_value(&conf->gen, action);
4618 *conf->variable = newval;
4619 conf->gen.source = source;
4625 if (conf->gen.reset_source <= source)
4627 conf->reset_val = newval;
4628 conf->gen.reset_source = source;
4630 for (stack = conf->gen.stack; stack; stack = stack->prev)
4632 if (stack->source <= source)
4634 stack->prior.boolval = newval;
4635 stack->source = source;
4645 struct config_int *conf = (struct config_int *) record;
4650 const char *hintmsg;
4652 if (!parse_int(value, &newval, conf->gen.flags, &hintmsg))
4655 (errcode(ERRCODE_INVALID_PARAMETER_VALUE),
4656 errmsg("invalid value for parameter \"%s\": \"%s\"",
4658 hintmsg ? errhint(hintmsg) : 0));
4661 if (newval < conf->min || newval > conf->max)
4664 (errcode(ERRCODE_INVALID_PARAMETER_VALUE),
4665 errmsg("%d is outside the valid range for parameter \"%s\" (%d .. %d)",
4666 newval, name, conf->min, conf->max)));
4670 else if (source == PGC_S_DEFAULT)
4671 newval = conf->boot_val;
4674 newval = conf->reset_val;
4675 source = conf->gen.reset_source;
4678 if (conf->assign_hook)
4679 if (!(*conf->assign_hook) (newval, changeVal, source))
4682 (errcode(ERRCODE_INVALID_PARAMETER_VALUE),
4683 errmsg("invalid value for parameter \"%s\": %d",
4688 if (changeVal || makeDefault)
4690 /* Save old value to support transaction abort */
4692 push_old_value(&conf->gen, action);
4695 *conf->variable = newval;
4696 conf->gen.source = source;
4702 if (conf->gen.reset_source <= source)
4704 conf->reset_val = newval;
4705 conf->gen.reset_source = source;
4707 for (stack = conf->gen.stack; stack; stack = stack->prev)
4709 if (stack->source <= source)
4711 stack->prior.intval = newval;
4712 stack->source = source;
4722 struct config_real *conf = (struct config_real *) record;
4727 if (!parse_real(value, &newval))
4730 (errcode(ERRCODE_INVALID_PARAMETER_VALUE),
4731 errmsg("parameter \"%s\" requires a numeric value",
4735 if (newval < conf->min || newval > conf->max)
4738 (errcode(ERRCODE_INVALID_PARAMETER_VALUE),
4739 errmsg("%g is outside the valid range for parameter \"%s\" (%g .. %g)",
4740 newval, name, conf->min, conf->max)));
4744 else if (source == PGC_S_DEFAULT)
4745 newval = conf->boot_val;
4748 newval = conf->reset_val;
4749 source = conf->gen.reset_source;
4752 if (conf->assign_hook)
4753 if (!(*conf->assign_hook) (newval, changeVal, source))
4756 (errcode(ERRCODE_INVALID_PARAMETER_VALUE),
4757 errmsg("invalid value for parameter \"%s\": %g",
4762 if (changeVal || makeDefault)
4764 /* Save old value to support transaction abort */
4766 push_old_value(&conf->gen, action);
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.realval = newval;
4786 stack->source = source;
4796 struct config_string *conf = (struct config_string *) record;
4801 newval = guc_strdup(elevel, value);
4806 * The only sort of "parsing" check we need to do is apply
4807 * truncation if GUC_IS_NAME.
4809 if (conf->gen.flags & GUC_IS_NAME)
4810 truncate_identifier(newval, strlen(newval), true);
4812 else if (source == PGC_S_DEFAULT)
4814 if (conf->boot_val == NULL)
4818 newval = guc_strdup(elevel, conf->boot_val);
4826 * We could possibly avoid strdup here, but easier to make
4827 * this case work the same as the normal assignment case;
4828 * note the possible free of newval below.
4830 if (conf->reset_val == NULL)
4834 newval = guc_strdup(elevel, conf->reset_val);
4838 source = conf->gen.reset_source;
4841 if (conf->assign_hook && newval)
4843 const char *hookresult;
4846 * If the hook ereports, we have to make sure we free
4847 * newval, else it will be a permanent memory leak.
4849 hookresult = call_string_assign_hook(conf->assign_hook,
4853 if (hookresult == NULL)
4857 (errcode(ERRCODE_INVALID_PARAMETER_VALUE),
4858 errmsg("invalid value for parameter \"%s\": \"%s\"",
4859 name, value ? value : "")));
4862 else if (hookresult != newval)
4867 * Having to cast away const here is annoying, but the
4868 * alternative is to declare assign_hooks as returning
4869 * char*, which would mean they'd have to cast away
4870 * const, or as both taking and returning char*, which
4871 * doesn't seem attractive either --- we don't want
4872 * them to scribble on the passed str.
4874 newval = (char *) hookresult;
4878 if (changeVal || makeDefault)
4880 /* Save old value to support transaction abort */
4882 push_old_value(&conf->gen, action);
4885 set_string_field(conf, conf->variable, newval);
4886 conf->gen.source = source;
4892 if (conf->gen.reset_source <= source)
4894 set_string_field(conf, &conf->reset_val, newval);
4895 conf->gen.reset_source = source;
4897 for (stack = conf->gen.stack; stack; stack = stack->prev)
4899 if (stack->source <= source)
4901 set_string_field(conf, &stack->prior.stringval,
4903 stack->source = source;
4906 /* Perhaps we didn't install newval anywhere */
4907 if (newval && !string_field_used(conf, newval))
4917 struct config_enum *conf = (struct config_enum *) record;
4922 if (!config_enum_lookup_by_name(conf, value, &newval))
4924 char *hintmsg = config_enum_get_options(conf, "Available values: ", ".");
4927 (errcode(ERRCODE_INVALID_PARAMETER_VALUE),
4928 errmsg("invalid value for parameter \"%s\": \"%s\"",
4930 hintmsg ? errhint(hintmsg) : 0));
4937 else if (source == PGC_S_DEFAULT)
4938 newval = conf->boot_val;
4941 newval = conf->reset_val;
4942 source = conf->gen.reset_source;
4945 if (conf->assign_hook)
4946 if (!(*conf->assign_hook) (newval, changeVal, source))
4949 (errcode(ERRCODE_INVALID_PARAMETER_VALUE),
4950 errmsg("invalid value for parameter \"%s\": \"%s\"",
4952 config_enum_lookup_by_value(conf, newval))));
4956 if (changeVal || makeDefault)
4958 /* Save old value to support transaction abort */
4960 push_old_value(&conf->gen, action);
4963 *conf->variable = newval;
4964 conf->gen.source = source;
4970 if (conf->gen.reset_source <= source)
4972 conf->reset_val = newval;
4973 conf->gen.reset_source = source;
4975 for (stack = conf->gen.stack; stack; stack = stack->prev)
4977 if (stack->source <= source)
4979 stack->prior.enumval = newval;
4980 stack->source = source;
4989 if (changeVal && (record->flags & GUC_REPORT))
4990 ReportGUCOption(record);
4997 * Set a config option to the given value. See also set_config_option,
4998 * this is just the wrapper to be called from outside GUC. NB: this
4999 * is used only for non-transactional operations.
5002 SetConfigOption(const char *name, const char *value,
5003 GucContext context, GucSource source)
5005 (void) set_config_option(name, value, context, source,
5006 GUC_ACTION_SET, true);
5012 * Fetch the current value of the option `name'. If the option doesn't exist,
5013 * throw an ereport and don't return.
5015 * The string is *not* allocated for modification and is really only
5016 * valid until the next call to configuration related functions.
5019 GetConfigOption(const char *name)
5021 struct config_generic *record;
5022 static char buffer[256];
5024 record = find_option(name, false, ERROR);
5027 (errcode(ERRCODE_UNDEFINED_OBJECT),
5028 errmsg("unrecognized configuration parameter \"%s\"", name)));
5029 if ((record->flags & GUC_SUPERUSER_ONLY) && !superuser())
5031 (errcode(ERRCODE_INSUFFICIENT_PRIVILEGE),
5032 errmsg("must be superuser to examine \"%s\"", name)));
5034 switch (record->vartype)
5037 return *((struct config_bool *) record)->variable ? "on" : "off";
5040 snprintf(buffer, sizeof(buffer), "%d",
5041 *((struct config_int *) record)->variable);
5045 snprintf(buffer, sizeof(buffer), "%g",
5046 *((struct config_real *) record)->variable);
5050 return *((struct config_string *) record)->variable;
5053 return config_enum_lookup_by_value((struct config_enum *) record,
5054 *((struct config_enum *) record)->variable);
5060 * Get the RESET value associated with the given option.
5062 * Note: this is not re-entrant, due to use of static result buffer;
5063 * not to mention that a string variable could have its reset_val changed.
5064 * Beware of assuming the result value is good for very long.
5067 GetConfigOptionResetString(const char *name)
5069 struct config_generic *record;
5070 static char buffer[256];
5072 record = find_option(name, false, ERROR);
5075 (errcode(ERRCODE_UNDEFINED_OBJECT),
5076 errmsg("unrecognized configuration parameter \"%s\"", name)));
5077 if ((record->flags & GUC_SUPERUSER_ONLY) && !superuser())
5079 (errcode(ERRCODE_INSUFFICIENT_PRIVILEGE),
5080 errmsg("must be superuser to examine \"%s\"", name)));
5082 switch (record->vartype)
5085 return ((struct config_bool *) record)->reset_val ? "on" : "off";
5088 snprintf(buffer, sizeof(buffer), "%d",
5089 ((struct config_int *) record)->reset_val);
5093 snprintf(buffer, sizeof(buffer), "%g",
5094 ((struct config_real *) record)->reset_val);
5098 return ((struct config_string *) record)->reset_val;
5101 return config_enum_lookup_by_value((struct config_enum *) record,
5102 ((struct config_enum *) record)->reset_val);
5108 * Detect whether the given configuration option can only be set by
5112 IsSuperuserConfigOption(const char *name)
5114 struct config_generic *record;
5116 record = find_option(name, false, ERROR);
5117 /* On an unrecognized name, don't error, just return false. */
5120 return (record->context == PGC_SUSET);
5125 * GUC_complaint_elevel
5126 * Get the ereport error level to use in an assign_hook's error report.
5128 * This should be used by assign hooks that want to emit a custom error
5129 * report (in addition to the generic "invalid value for option FOO" that
5130 * guc.c will provide). Note that the result might be ERROR or a lower
5131 * level, so the caller must be prepared for control to return from ereport,
5132 * or not. If control does return, return false/NULL from the hook function.
5134 * At some point it'd be nice to replace this with a mechanism that allows
5135 * the custom message to become the DETAIL line of guc.c's generic message.
5138 GUC_complaint_elevel(GucSource source)
5142 if (source == PGC_S_FILE)
5145 * To avoid cluttering the log, only the postmaster bleats loudly
5146 * about problems with the config file.
5148 elevel = IsUnderPostmaster ? DEBUG3 : LOG;
5150 else if (source == PGC_S_OVERRIDE)
5153 * If we're a postmaster child, this is probably "undo" during
5154 * transaction abort, so we don't want to clutter the log. There's
5155 * a small chance of a real problem with an OVERRIDE setting,
5156 * though, so suppressing the message entirely wouldn't be desirable.
5158 elevel = IsUnderPostmaster ? DEBUG5 : LOG;
5160 else if (source < PGC_S_INTERACTIVE)
5170 * flatten_set_variable_args
5171 * Given a parsenode List as emitted by the grammar for SET,
5172 * convert to the flat string representation used by GUC.
5174 * We need to be told the name of the variable the args are for, because
5175 * the flattening rules vary (ugh).
5177 * The result is NULL if args is NIL (ie, SET ... TO DEFAULT), otherwise
5178 * a palloc'd string.
5181 flatten_set_variable_args(const char *name, List *args)
5183 struct config_generic *record;
5188 /* Fast path if just DEFAULT */
5192 /* Else get flags for the variable */
5193 record = find_option(name, true, ERROR);
5196 (errcode(ERRCODE_UNDEFINED_OBJECT),
5197 errmsg("unrecognized configuration parameter \"%s\"", name)));
5199 flags = record->flags;
5201 /* Complain if list input and non-list variable */
5202 if ((flags & GUC_LIST_INPUT) == 0 &&
5203 list_length(args) != 1)
5205 (errcode(ERRCODE_INVALID_PARAMETER_VALUE),
5206 errmsg("SET %s takes only one argument", name)));
5208 initStringInfo(&buf);
5211 * Each list member may be a plain A_Const node, or an A_Const within a
5212 * TypeCast; the latter case is supported only for ConstInterval
5213 * arguments (for SET TIME ZONE).
5217 Node *arg = (Node *) lfirst(l);
5219 TypeName *typename = NULL;
5222 if (l != list_head(args))
5223 appendStringInfo(&buf, ", ");
5225 if (IsA(arg, TypeCast))
5227 TypeCast *tc = (TypeCast *) arg;
5230 typename = tc->typename;
5233 if (!IsA(arg, A_Const))
5234 elog(ERROR, "unrecognized node type: %d", (int) nodeTag(arg));
5235 con = (A_Const *) arg;
5237 switch (nodeTag(&con->val))
5240 appendStringInfo(&buf, "%ld", intVal(&con->val));
5243 /* represented as a string, so just copy it */
5244 appendStringInfoString(&buf, strVal(&con->val));
5247 val = strVal(&con->val);
5248 if (typename != NULL)
5251 * Must be a ConstInterval argument for TIME ZONE. Coerce
5252 * to interval and back to normalize the value and account
5260 typoid = typenameTypeId(NULL, typename, &typmod);
5261 Assert(typoid == INTERVALOID);
5264 DirectFunctionCall3(interval_in,
5265 CStringGetDatum(val),
5266 ObjectIdGetDatum(InvalidOid),
5267 Int32GetDatum(typmod));
5270 DatumGetCString(DirectFunctionCall1(interval_out,
5272 appendStringInfo(&buf, "INTERVAL '%s'", intervalout);
5277 * Plain string literal or identifier. For quote mode,
5278 * quote it if it's not a vanilla identifier.
5280 if (flags & GUC_LIST_QUOTE)
5281 appendStringInfoString(&buf, quote_identifier(val));
5283 appendStringInfoString(&buf, val);
5287 elog(ERROR, "unrecognized node type: %d",
5288 (int) nodeTag(&con->val));
5301 ExecSetVariableStmt(VariableSetStmt *stmt)
5303 GucAction action = stmt->is_local ? GUC_ACTION_LOCAL : GUC_ACTION_SET;
5308 case VAR_SET_CURRENT:
5309 set_config_option(stmt->name,
5310 ExtractSetVariableArgs(stmt),
5311 (superuser() ? PGC_SUSET : PGC_USERSET),
5319 * Special case for special SQL syntax that effectively sets more
5320 * than one variable per statement.
5322 if (strcmp(stmt->name, "TRANSACTION") == 0)
5326 foreach(head, stmt->args)
5328 DefElem *item = (DefElem *) lfirst(head);
5330 if (strcmp(item->defname, "transaction_isolation") == 0)
5331 SetPGVariable("transaction_isolation",
5332 list_make1(item->arg), stmt->is_local);
5333 else if (strcmp(item->defname, "transaction_read_only") == 0)
5334 SetPGVariable("transaction_read_only",
5335 list_make1(item->arg), stmt->is_local);
5337 elog(ERROR, "unexpected SET TRANSACTION element: %s",
5341 else if (strcmp(stmt->name, "SESSION CHARACTERISTICS") == 0)
5345 foreach(head, stmt->args)
5347 DefElem *item = (DefElem *) lfirst(head);
5349 if (strcmp(item->defname, "transaction_isolation") == 0)
5350 SetPGVariable("default_transaction_isolation",
5351 list_make1(item->arg), stmt->is_local);
5352 else if (strcmp(item->defname, "transaction_read_only") == 0)
5353 SetPGVariable("default_transaction_read_only",
5354 list_make1(item->arg), stmt->is_local);
5356 elog(ERROR, "unexpected SET SESSION element: %s",
5361 elog(ERROR, "unexpected SET MULTI element: %s",
5364 case VAR_SET_DEFAULT:
5366 set_config_option(stmt->name,
5368 (superuser() ? PGC_SUSET : PGC_USERSET),
5380 * Get the value to assign for a VariableSetStmt, or NULL if it's RESET.
5381 * The result is palloc'd.
5383 * This is exported for use by actions such as ALTER ROLE SET.
5386 ExtractSetVariableArgs(VariableSetStmt *stmt)
5391 return flatten_set_variable_args(stmt->name, stmt->args);
5392 case VAR_SET_CURRENT:
5393 return GetConfigOptionByName(stmt->name, NULL);
5400 * SetPGVariable - SET command exported as an easily-C-callable function.
5402 * This provides access to SET TO value, as well as SET TO DEFAULT (expressed
5403 * by passing args == NIL), but not SET FROM CURRENT functionality.
5406 SetPGVariable(const char *name, List *args, bool is_local)
5408 char *argstring = flatten_set_variable_args(name, args);
5410 /* Note SET DEFAULT (argstring == NULL) is equivalent to RESET */
5411 set_config_option(name,
5413 (superuser() ? PGC_SUSET : PGC_USERSET),
5415 is_local ? GUC_ACTION_LOCAL : GUC_ACTION_SET,
5420 * SET command wrapped as a SQL callable function.
5423 set_config_by_name(PG_FUNCTION_ARGS)
5430 if (PG_ARGISNULL(0))
5432 (errcode(ERRCODE_NULL_VALUE_NOT_ALLOWED),
5433 errmsg("SET requires parameter name")));
5435 /* Get the GUC variable name */
5436 name = TextDatumGetCString(PG_GETARG_DATUM(0));
5438 /* Get the desired value or set to NULL for a reset request */
5439 if (PG_ARGISNULL(1))
5442 value = TextDatumGetCString(PG_GETARG_DATUM(1));
5445 * Get the desired state of is_local. Default to false if provided value
5448 if (PG_ARGISNULL(2))
5451 is_local = PG_GETARG_BOOL(2);
5453 /* Note SET DEFAULT (argstring == NULL) is equivalent to RESET */
5454 set_config_option(name,
5456 (superuser() ? PGC_SUSET : PGC_USERSET),
5458 is_local ? GUC_ACTION_LOCAL : GUC_ACTION_SET,
5461 /* get the new current value */
5462 new_value = GetConfigOptionByName(name, NULL);
5464 /* Convert return string to text */
5465 PG_RETURN_TEXT_P(cstring_to_text(new_value));
5470 * Common code for DefineCustomXXXVariable subroutines: allocate the
5471 * new variable's config struct and fill in generic fields.
5473 static struct config_generic *
5474 init_custom_variable(const char *name,
5475 const char *short_desc,
5476 const char *long_desc,
5478 enum config_type type,
5481 struct config_generic *gen;
5483 gen = (struct config_generic *) guc_malloc(ERROR, sz);
5486 gen->name = guc_strdup(ERROR, name);
5487 gen->context = context;
5488 gen->group = CUSTOM_OPTIONS;
5489 gen->short_desc = short_desc;
5490 gen->long_desc = long_desc;
5491 gen->vartype = type;
5497 * Common code for DefineCustomXXXVariable subroutines: insert the new
5498 * variable into the GUC variable array, replacing any placeholder.
5501 define_custom_variable(struct config_generic * variable)
5503 const char *name = variable->name;
5504 const char **nameAddr = &name;
5506 struct config_string *pHolder;
5507 struct config_generic **res;
5509 res = (struct config_generic **) bsearch((void *) &nameAddr,
5510 (void *) guc_variables,
5512 sizeof(struct config_generic *),
5516 /* No placeholder to replace, so just add it */
5517 add_guc_variable(variable, ERROR);
5522 * This better be a placeholder
5524 if (((*res)->flags & GUC_CUSTOM_PLACEHOLDER) == 0)
5526 (errcode(ERRCODE_INTERNAL_ERROR),
5527 errmsg("attempt to redefine parameter \"%s\"", name)));
5529 Assert((*res)->vartype == PGC_STRING);
5530 pHolder = (struct config_string *) (*res);
5533 * Replace the placeholder. We aren't changing the name, so no re-sorting
5539 * Assign the string value stored in the placeholder to the real variable.
5541 * XXX this is not really good enough --- it should be a nontransactional
5542 * assignment, since we don't want it to roll back if the current xact
5545 value = *pHolder->variable;
5548 set_config_option(name, value,
5549 pHolder->gen.context, pHolder->gen.source,
5550 GUC_ACTION_SET, true);
5553 * Free up as much as we conveniently can of the placeholder structure
5554 * (this neglects any stack items...)
5556 set_string_field(pHolder, pHolder->variable, NULL);
5557 set_string_field(pHolder, &pHolder->reset_val, NULL);
5563 DefineCustomBoolVariable(const char *name,
5564 const char *short_desc,
5565 const char *long_desc,
5568 GucBoolAssignHook assign_hook,
5569 GucShowHook show_hook)
5571 struct config_bool *var;
5573 var = (struct config_bool *)
5574 init_custom_variable(name, short_desc, long_desc, context,
5575 PGC_BOOL, sizeof(struct config_bool));
5576 var->variable = valueAddr;
5577 var->boot_val = *valueAddr;
5578 var->reset_val = *valueAddr;
5579 var->assign_hook = assign_hook;
5580 var->show_hook = show_hook;
5581 define_custom_variable(&var->gen);
5585 DefineCustomIntVariable(const char *name,
5586 const char *short_desc,
5587 const char *long_desc,
5592 GucIntAssignHook assign_hook,
5593 GucShowHook show_hook)
5595 struct config_int *var;
5597 var = (struct config_int *)
5598 init_custom_variable(name, short_desc, long_desc, context,
5599 PGC_INT, sizeof(struct config_int));
5600 var->variable = valueAddr;
5601 var->boot_val = *valueAddr;
5602 var->reset_val = *valueAddr;
5603 var->min = minValue;
5604 var->max = maxValue;
5605 var->assign_hook = assign_hook;
5606 var->show_hook = show_hook;
5607 define_custom_variable(&var->gen);
5611 DefineCustomRealVariable(const char *name,
5612 const char *short_desc,
5613 const char *long_desc,
5618 GucRealAssignHook assign_hook,
5619 GucShowHook show_hook)
5621 struct config_real *var;
5623 var = (struct config_real *)
5624 init_custom_variable(name, short_desc, long_desc, context,
5625 PGC_REAL, sizeof(struct config_real));
5626 var->variable = valueAddr;
5627 var->boot_val = *valueAddr;
5628 var->reset_val = *valueAddr;
5629 var->min = minValue;
5630 var->max = maxValue;
5631 var->assign_hook = assign_hook;
5632 var->show_hook = show_hook;
5633 define_custom_variable(&var->gen);
5637 DefineCustomStringVariable(const char *name,
5638 const char *short_desc,
5639 const char *long_desc,
5642 GucStringAssignHook assign_hook,
5643 GucShowHook show_hook)
5645 struct config_string *var;
5647 var = (struct config_string *)
5648 init_custom_variable(name, short_desc, long_desc, context,
5649 PGC_STRING, sizeof(struct config_string));
5650 var->variable = valueAddr;
5651 var->boot_val = *valueAddr;
5652 /* we could probably do without strdup, but keep it like normal case */
5654 var->reset_val = guc_strdup(ERROR, var->boot_val);
5655 var->assign_hook = assign_hook;
5656 var->show_hook = show_hook;
5657 define_custom_variable(&var->gen);
5661 DefineCustomEnumVariable(const char *name,
5662 const char *short_desc,
5663 const char *long_desc,
5665 const struct config_enum_entry *options,
5667 GucEnumAssignHook assign_hook,
5668 GucShowHook show_hook)
5670 struct config_enum *var;
5672 var = (struct config_enum *)
5673 init_custom_variable(name, short_desc, long_desc, context,
5674 PGC_ENUM, sizeof(struct config_enum));
5675 var->variable = valueAddr;
5676 var->boot_val = *valueAddr;
5677 var->reset_val = *valueAddr;
5678 var->options = options;
5679 var->assign_hook = assign_hook;
5680 var->show_hook = show_hook;
5681 define_custom_variable(&var->gen);
5685 EmitWarningsOnPlaceholders(const char *className)
5687 struct config_generic **vars = guc_variables;
5688 struct config_generic **last = vars + num_guc_variables;
5690 int nameLen = strlen(className);
5694 struct config_generic *var = *vars++;
5696 if ((var->flags & GUC_CUSTOM_PLACEHOLDER) != 0 &&
5697 strncmp(className, var->name, nameLen) == 0 &&
5698 var->name[nameLen] == GUC_QUALIFIER_SEPARATOR)
5701 (errcode(ERRCODE_UNDEFINED_OBJECT),
5702 errmsg("unrecognized configuration parameter \"%s\"", var->name)));
5712 GetPGVariable(const char *name, DestReceiver *dest)
5714 if (guc_name_compare(name, "all") == 0)
5715 ShowAllGUCConfig(dest);
5717 ShowGUCConfigOption(name, dest);
5721 GetPGVariableResultDesc(const char *name)
5725 if (guc_name_compare(name, "all") == 0)
5727 /* need a tuple descriptor representing three TEXT columns */
5728 tupdesc = CreateTemplateTupleDesc(3, false);
5729 TupleDescInitEntry(tupdesc, (AttrNumber) 1, "name",
5731 TupleDescInitEntry(tupdesc, (AttrNumber) 2, "setting",
5733 TupleDescInitEntry(tupdesc, (AttrNumber) 3, "description",
5739 const char *varname;
5741 /* Get the canonical spelling of name */
5742 (void) GetConfigOptionByName(name, &varname);
5744 /* need a tuple descriptor representing a single TEXT column */
5745 tupdesc = CreateTemplateTupleDesc(1, false);
5746 TupleDescInitEntry(tupdesc, (AttrNumber) 1, varname,
5757 ShowGUCConfigOption(const char *name, DestReceiver *dest)
5759 TupOutputState *tstate;
5761 const char *varname;
5764 /* Get the value and canonical spelling of name */
5765 value = GetConfigOptionByName(name, &varname);
5767 /* need a tuple descriptor representing a single TEXT column */
5768 tupdesc = CreateTemplateTupleDesc(1, false);
5769 TupleDescInitEntry(tupdesc, (AttrNumber) 1, varname,
5772 /* prepare for projection of tuples */
5773 tstate = begin_tup_output_tupdesc(dest, tupdesc);
5776 do_text_output_oneline(tstate, value);
5778 end_tup_output(tstate);
5785 ShowAllGUCConfig(DestReceiver *dest)
5787 bool am_superuser = superuser();
5789 TupOutputState *tstate;
5793 /* need a tuple descriptor representing three TEXT columns */
5794 tupdesc = CreateTemplateTupleDesc(3, false);
5795 TupleDescInitEntry(tupdesc, (AttrNumber) 1, "name",
5797 TupleDescInitEntry(tupdesc, (AttrNumber) 2, "setting",
5799 TupleDescInitEntry(tupdesc, (AttrNumber) 3, "description",
5803 /* prepare for projection of tuples */
5804 tstate = begin_tup_output_tupdesc(dest, tupdesc);
5806 for (i = 0; i < num_guc_variables; i++)
5808 struct config_generic *conf = guc_variables[i];
5810 if ((conf->flags & GUC_NO_SHOW_ALL) ||
5811 ((conf->flags & GUC_SUPERUSER_ONLY) && !am_superuser))
5814 /* assign to the values array */
5815 values[0] = (char *) conf->name;
5816 values[1] = _ShowOption(conf, true);
5817 values[2] = (char *) conf->short_desc;
5819 /* send it to dest */
5820 do_tup_output(tstate, values);
5823 if (values[1] != NULL)
5827 end_tup_output(tstate);
5831 * Return GUC variable value by name; optionally return canonical
5832 * form of name. Return value is palloc'd.
5835 GetConfigOptionByName(const char *name, const char **varname)
5837 struct config_generic *record;
5839 record = find_option(name, false, ERROR);
5842 (errcode(ERRCODE_UNDEFINED_OBJECT),
5843 errmsg("unrecognized configuration parameter \"%s\"", name)));
5844 if ((record->flags & GUC_SUPERUSER_ONLY) && !superuser())
5846 (errcode(ERRCODE_INSUFFICIENT_PRIVILEGE),
5847 errmsg("must be superuser to examine \"%s\"", name)));
5850 *varname = record->name;
5852 return _ShowOption(record, true);
5856 * Return GUC variable value by variable number; optionally return canonical
5857 * form of name. Return value is palloc'd.
5860 GetConfigOptionByNum(int varnum, const char **values, bool *noshow)
5863 struct config_generic *conf;
5865 /* check requested variable number valid */
5866 Assert((varnum >= 0) && (varnum < num_guc_variables));
5868 conf = guc_variables[varnum];
5872 if ((conf->flags & GUC_NO_SHOW_ALL) ||
5873 ((conf->flags & GUC_SUPERUSER_ONLY) && !superuser()))
5879 /* first get the generic attributes */
5882 values[0] = conf->name;
5884 /* setting : use _ShowOption in order to avoid duplicating the logic */
5885 values[1] = _ShowOption(conf, false);
5888 if (conf->vartype == PGC_INT)
5892 switch (conf->flags & (GUC_UNIT_MEMORY | GUC_UNIT_TIME))
5897 case GUC_UNIT_BLOCKS:
5898 snprintf(buf, sizeof(buf), "%dkB", BLCKSZ / 1024);
5901 case GUC_UNIT_XBLOCKS:
5902 snprintf(buf, sizeof(buf), "%dkB", XLOG_BLCKSZ / 1024);
5923 values[3] = config_group_names[conf->group];
5926 values[4] = conf->short_desc;
5929 values[5] = conf->long_desc;
5932 values[6] = GucContext_Names[conf->context];
5935 values[7] = config_type_names[conf->vartype];
5938 values[8] = GucSource_Names[conf->source];
5940 /* now get the type specifc attributes */
5941 switch (conf->vartype)
5958 struct config_int *lconf = (struct config_int *) conf;
5961 snprintf(buffer, sizeof(buffer), "%d", lconf->min);
5962 values[9] = pstrdup(buffer);
5965 snprintf(buffer, sizeof(buffer), "%d", lconf->max);
5966 values[10] = pstrdup(buffer);
5975 struct config_real *lconf = (struct config_real *) conf;
5978 snprintf(buffer, sizeof(buffer), "%g", lconf->min);
5979 values[9] = pstrdup(buffer);
5982 snprintf(buffer, sizeof(buffer), "%g", lconf->max);
5983 values[10] = pstrdup(buffer);
6012 values[11] = config_enum_get_options((struct config_enum *) conf, "", "");
6019 * should never get here, but in case we do, set 'em to NULL
6036 * Return the total number of GUC variables
6039 GetNumConfigOptions(void)
6041 return num_guc_variables;
6045 * show_config_by_name - equiv to SHOW X command but implemented as
6049 show_config_by_name(PG_FUNCTION_ARGS)
6054 /* Get the GUC variable name */
6055 varname = TextDatumGetCString(PG_GETARG_DATUM(0));
6058 varval = GetConfigOptionByName(varname, NULL);
6060 /* Convert to text */
6061 PG_RETURN_TEXT_P(cstring_to_text(varval));
6065 * show_all_settings - equiv to SHOW ALL command but implemented as
6068 #define NUM_PG_SETTINGS_ATTS 12
6071 show_all_settings(PG_FUNCTION_ARGS)
6073 FuncCallContext *funcctx;
6077 AttInMetadata *attinmeta;
6078 MemoryContext oldcontext;
6080 /* stuff done only on the first call of the function */
6081 if (SRF_IS_FIRSTCALL())
6083 /* create a function context for cross-call persistence */
6084 funcctx = SRF_FIRSTCALL_INIT();
6087 * switch to memory context appropriate for multiple function calls
6089 oldcontext = MemoryContextSwitchTo(funcctx->multi_call_memory_ctx);
6092 * need a tuple descriptor representing NUM_PG_SETTINGS_ATTS columns
6093 * of the appropriate types
6095 tupdesc = CreateTemplateTupleDesc(NUM_PG_SETTINGS_ATTS, false);
6096 TupleDescInitEntry(tupdesc, (AttrNumber) 1, "name",
6098 TupleDescInitEntry(tupdesc, (AttrNumber) 2, "setting",
6100 TupleDescInitEntry(tupdesc, (AttrNumber) 3, "unit",
6102 TupleDescInitEntry(tupdesc, (AttrNumber) 4, "category",
6104 TupleDescInitEntry(tupdesc, (AttrNumber) 5, "short_desc",
6106 TupleDescInitEntry(tupdesc, (AttrNumber) 6, "extra_desc",
6108 TupleDescInitEntry(tupdesc, (AttrNumber) 7, "context",
6110 TupleDescInitEntry(tupdesc, (AttrNumber) 8, "vartype",
6112 TupleDescInitEntry(tupdesc, (AttrNumber) 9, "source",
6114 TupleDescInitEntry(tupdesc, (AttrNumber) 10, "min_val",
6116 TupleDescInitEntry(tupdesc, (AttrNumber) 11, "max_val",
6118 TupleDescInitEntry(tupdesc, (AttrNumber) 12, "enumvals",
6122 * Generate attribute metadata needed later to produce tuples from raw
6125 attinmeta = TupleDescGetAttInMetadata(tupdesc);
6126 funcctx->attinmeta = attinmeta;
6128 /* total number of tuples to be returned */
6129 funcctx->max_calls = GetNumConfigOptions();
6131 MemoryContextSwitchTo(oldcontext);
6134 /* stuff done on every call of the function */
6135 funcctx = SRF_PERCALL_SETUP();
6137 call_cntr = funcctx->call_cntr;
6138 max_calls = funcctx->max_calls;
6139 attinmeta = funcctx->attinmeta;
6141 if (call_cntr < max_calls) /* do when there is more left to send */
6143 char *values[NUM_PG_SETTINGS_ATTS];
6149 * Get the next visible GUC variable name and value
6153 GetConfigOptionByNum(call_cntr, (const char **) values, &noshow);
6156 /* bump the counter and get the next config setting */
6157 call_cntr = ++funcctx->call_cntr;
6159 /* make sure we haven't gone too far now */
6160 if (call_cntr >= max_calls)
6161 SRF_RETURN_DONE(funcctx);
6166 tuple = BuildTupleFromCStrings(attinmeta, values);
6168 /* make the tuple into a datum */
6169 result = HeapTupleGetDatum(tuple);
6171 SRF_RETURN_NEXT(funcctx, result);
6175 /* do when there is no more left */
6176 SRF_RETURN_DONE(funcctx);
6181 _ShowOption(struct config_generic * record, bool use_units)
6186 switch (record->vartype)
6190 struct config_bool *conf = (struct config_bool *) record;
6192 if (conf->show_hook)
6193 val = (*conf->show_hook) ();
6195 val = *conf->variable ? "on" : "off";
6201 struct config_int *conf = (struct config_int *) record;
6203 if (conf->show_hook)
6204 val = (*conf->show_hook) ();
6208 int result = *conf->variable;
6210 if (use_units && result > 0 && (record->flags & GUC_UNIT_MEMORY))
6212 switch (record->flags & GUC_UNIT_MEMORY)
6214 case GUC_UNIT_BLOCKS:
6215 result *= BLCKSZ / 1024;
6217 case GUC_UNIT_XBLOCKS:
6218 result *= XLOG_BLCKSZ / 1024;
6222 if (result % KB_PER_GB == 0)
6224 result /= KB_PER_GB;
6227 else if (result % KB_PER_MB == 0)
6229 result /= KB_PER_MB;
6237 else if (use_units && result > 0 && (record->flags & GUC_UNIT_TIME))
6239 switch (record->flags & GUC_UNIT_TIME)
6245 result *= MS_PER_MIN;
6249 if (result % MS_PER_D == 0)
6254 else if (result % MS_PER_H == 0)
6259 else if (result % MS_PER_MIN == 0)
6261 result /= MS_PER_MIN;
6262 strcpy(unit, "min");
6264 else if (result % MS_PER_S == 0)
6277 snprintf(buffer, sizeof(buffer), "%d%s",
6278 (int) result, unit);
6286 struct config_real *conf = (struct config_real *) record;
6288 if (conf->show_hook)
6289 val = (*conf->show_hook) ();
6292 snprintf(buffer, sizeof(buffer), "%g",
6301 struct config_string *conf = (struct config_string *) record;
6303 if (conf->show_hook)
6304 val = (*conf->show_hook) ();
6305 else if (*conf->variable && **conf->variable)
6306 val = *conf->variable;
6314 struct config_enum *conf = (struct config_enum *) record;
6317 val = (*conf->show_hook) ();
6319 val = config_enum_lookup_by_value(conf, *conf->variable);
6324 /* just to keep compiler quiet */
6329 return pstrdup(val);
6334 * Attempt (badly) to detect if a proposed new GUC setting is the same
6335 * as the current value.
6337 * XXX this does not really work because it doesn't account for the
6338 * effects of canonicalization of string values by assign_hooks.
6341 is_newvalue_equal(struct config_generic * record, const char *newvalue)
6343 /* newvalue == NULL isn't supported */
6344 Assert(newvalue != NULL);
6346 switch (record->vartype)
6350 struct config_bool *conf = (struct config_bool *) record;
6353 return parse_bool(newvalue, &newval)
6354 && *conf->variable == newval;
6358 struct config_int *conf = (struct config_int *) record;
6361 return parse_int(newvalue, &newval, record->flags, NULL)
6362 && *conf->variable == newval;
6366 struct config_real *conf = (struct config_real *) record;
6369 return parse_real(newvalue, &newval)
6370 && *conf->variable == newval;
6374 struct config_string *conf = (struct config_string *) record;
6376 return *conf->variable != NULL &&
6377 strcmp(*conf->variable, newvalue) == 0;
6382 struct config_enum *conf = (struct config_enum *) record;
6385 return config_enum_lookup_by_name(conf, newvalue, &newval)
6386 && *conf->variable == newval;
6397 * This routine dumps out all non-default GUC options into a binary
6398 * file that is read by all exec'ed backends. The format is:
6400 * variable name, string, null terminated
6401 * variable value, string, null terminated
6402 * variable source, integer
6405 write_nondefault_variables(GucContext context)
6411 Assert(context == PGC_POSTMASTER || context == PGC_SIGHUP);
6413 elevel = (context == PGC_SIGHUP) ? LOG : ERROR;
6418 fp = AllocateFile(CONFIG_EXEC_PARAMS_NEW, "w");
6422 (errcode_for_file_access(),
6423 errmsg("could not write to file \"%s\": %m",
6424 CONFIG_EXEC_PARAMS_NEW)));
6428 for (i = 0; i < num_guc_variables; i++)
6430 struct config_generic *gconf = guc_variables[i];
6432 if (gconf->source != PGC_S_DEFAULT)
6434 fprintf(fp, "%s", gconf->name);
6437 switch (gconf->vartype)
6441 struct config_bool *conf = (struct config_bool *) gconf;
6443 if (*conf->variable == 0)
6444 fprintf(fp, "false");
6446 fprintf(fp, "true");
6452 struct config_int *conf = (struct config_int *) gconf;
6454 fprintf(fp, "%d", *conf->variable);
6460 struct config_real *conf = (struct config_real *) gconf;
6462 /* Could lose precision here? */
6463 fprintf(fp, "%f", *conf->variable);
6469 struct config_string *conf = (struct config_string *) gconf;
6471 fprintf(fp, "%s", *conf->variable);
6477 struct config_enum *conf = (struct config_enum *) gconf;
6479 fprintf(fp, "%s", config_enum_lookup_by_value(conf, *conf->variable));
6486 fwrite(&gconf->source, sizeof(gconf->source), 1, fp);
6493 (errcode_for_file_access(),
6494 errmsg("could not write to file \"%s\": %m",
6495 CONFIG_EXEC_PARAMS_NEW)));
6500 * Put new file in place. This could delay on Win32, but we don't hold
6501 * any exclusive locks.
6503 rename(CONFIG_EXEC_PARAMS_NEW, CONFIG_EXEC_PARAMS);
6508 * Read string, including null byte from file
6510 * Return NULL on EOF and nothing read
6513 read_string_with_null(FILE *fp)
6522 if ((ch = fgetc(fp)) == EOF)
6527 elog(FATAL, "invalid format of exec config params file");
6530 str = guc_malloc(FATAL, maxlen);
6531 else if (i == maxlen)
6532 str = guc_realloc(FATAL, str, maxlen *= 2);
6541 * This routine loads a previous postmaster dump of its non-default
6545 read_nondefault_variables(void)
6555 fp = AllocateFile(CONFIG_EXEC_PARAMS, "r");
6558 /* File not found is fine */
6559 if (errno != ENOENT)
6561 (errcode_for_file_access(),
6562 errmsg("could not read from file \"%s\": %m",
6563 CONFIG_EXEC_PARAMS)));
6569 struct config_generic *record;
6571 if ((varname = read_string_with_null(fp)) == NULL)
6574 if ((record = find_option(varname, true, FATAL)) == NULL)
6575 elog(FATAL, "failed to locate variable %s in exec config params file", varname);
6576 if ((varvalue = read_string_with_null(fp)) == NULL)
6577 elog(FATAL, "invalid format of exec config params file");
6578 if (fread(&varsource, sizeof(varsource), 1, fp) == 0)
6579 elog(FATAL, "invalid format of exec config params file");
6581 (void) set_config_option(varname, varvalue, record->context,
6582 varsource, GUC_ACTION_SET, true);
6589 #endif /* EXEC_BACKEND */
6593 * A little "long argument" simulation, although not quite GNU
6594 * compliant. Takes a string of the form "some-option=some value" and
6595 * returns name = "some_option" and value = "some value" in malloc'ed
6596 * storage. Note that '-' is converted to '_' in the option name. If
6597 * there is no '=' in the input string then value will be NULL.
6600 ParseLongOption(const char *string, char **name, char **value)
6609 equal_pos = strcspn(string, "=");
6611 if (string[equal_pos] == '=')
6613 *name = guc_malloc(FATAL, equal_pos + 1);
6614 strlcpy(*name, string, equal_pos + 1);
6616 *value = guc_strdup(FATAL, &string[equal_pos + 1]);
6620 /* no equal sign in string */
6621 *name = guc_strdup(FATAL, string);
6625 for (cp = *name; *cp; cp++)
6632 * Handle options fetched from pg_database.datconfig, pg_authid.rolconfig,
6633 * pg_proc.proconfig, etc. Caller must specify proper context/source/action.
6635 * The array parameter must be an array of TEXT (it must not be NULL).
6638 ProcessGUCArray(ArrayType *array,
6639 GucContext context, GucSource source, GucAction action)
6643 Assert(array != NULL);
6644 Assert(ARR_ELEMTYPE(array) == TEXTOID);
6645 Assert(ARR_NDIM(array) == 1);
6646 Assert(ARR_LBOUND(array)[0] == 1);
6648 for (i = 1; i <= ARR_DIMS(array)[0]; i++)
6656 d = array_ref(array, 1, &i,
6657 -1 /* varlenarray */ ,
6658 -1 /* TEXT's typlen */ ,
6659 false /* TEXT's typbyval */ ,
6660 'i' /* TEXT's typalign */ ,
6666 s = TextDatumGetCString(d);
6668 ParseLongOption(s, &name, &value);
6672 (errcode(ERRCODE_SYNTAX_ERROR),
6673 errmsg("could not parse setting for parameter \"%s\"",
6679 (void) set_config_option(name, value, context, source, action, true);
6689 * Add an entry to an option array. The array parameter may be NULL
6690 * to indicate the current table entry is NULL.
6693 GUCArrayAdd(ArrayType *array, const char *name, const char *value)
6695 const char *varname;
6703 /* test if the option is valid */
6704 set_config_option(name, value,
6705 superuser() ? PGC_SUSET : PGC_USERSET,
6706 PGC_S_TEST, GUC_ACTION_SET, false);
6708 /* convert name to canonical spelling, so we can use plain strcmp */
6709 (void) GetConfigOptionByName(name, &varname);
6712 newval = palloc(strlen(name) + 1 + strlen(value) + 1);
6713 sprintf(newval, "%s=%s", name, value);
6714 datum = CStringGetTextDatum(newval);
6722 Assert(ARR_ELEMTYPE(array) == TEXTOID);
6723 Assert(ARR_NDIM(array) == 1);
6724 Assert(ARR_LBOUND(array)[0] == 1);
6726 index = ARR_DIMS(array)[0] + 1; /* add after end */
6728 for (i = 1; i <= ARR_DIMS(array)[0]; i++)
6733 d = array_ref(array, 1, &i,
6734 -1 /* varlenarray */ ,
6735 -1 /* TEXT's typlen */ ,
6736 false /* TEXT's typbyval */ ,
6737 'i' /* TEXT's typalign */ ,
6741 current = TextDatumGetCString(d);
6742 if (strncmp(current, newval, strlen(name) + 1) == 0)
6749 a = array_set(array, 1, &index,
6752 -1 /* varlena array */ ,
6753 -1 /* TEXT's typlen */ ,
6754 false /* TEXT's typbyval */ ,
6755 'i' /* TEXT's typalign */ );
6758 a = construct_array(&datum, 1,
6767 * Delete an entry from an option array. The array parameter may be NULL
6768 * to indicate the current table entry is NULL. Also, if the return value
6769 * is NULL then a null should be stored.
6772 GUCArrayDelete(ArrayType *array, const char *name)
6774 const char *varname;
6775 ArrayType *newarray;
6781 /* test if the option is valid */
6782 set_config_option(name, NULL,
6783 superuser() ? PGC_SUSET : PGC_USERSET,
6784 PGC_S_TEST, GUC_ACTION_SET, false);
6786 /* convert name to canonical spelling, so we can use plain strcmp */
6787 (void) GetConfigOptionByName(name, &varname);
6790 /* if array is currently null, then surely nothing to delete */
6797 for (i = 1; i <= ARR_DIMS(array)[0]; i++)
6803 d = array_ref(array, 1, &i,
6804 -1 /* varlenarray */ ,
6805 -1 /* TEXT's typlen */ ,
6806 false /* TEXT's typbyval */ ,
6807 'i' /* TEXT's typalign */ ,
6811 val = TextDatumGetCString(d);
6813 /* ignore entry if it's what we want to delete */
6814 if (strncmp(val, name, strlen(name)) == 0
6815 && val[strlen(name)] == '=')
6818 /* else add it to the output array */
6821 newarray = array_set(newarray, 1, &index,
6824 -1 /* varlenarray */ ,
6825 -1 /* TEXT's typlen */ ,
6826 false /* TEXT's typbyval */ ,
6827 'i' /* TEXT's typalign */ );
6830 newarray = construct_array(&d, 1,
6842 * assign_hook and show_hook subroutines
6846 assign_log_destination(const char *value, bool doit, GucSource source)
6853 /* Need a modifiable copy of string */
6854 rawstring = pstrdup(value);
6856 /* Parse string into list of identifiers */
6857 if (!SplitIdentifierString(rawstring, ',', &elemlist))
6859 /* syntax error in list */
6861 list_free(elemlist);
6862 ereport(GUC_complaint_elevel(source),
6863 (errcode(ERRCODE_INVALID_PARAMETER_VALUE),
6864 errmsg("invalid list syntax for parameter \"log_destination\"")));
6868 foreach(l, elemlist)
6870 char *tok = (char *) lfirst(l);
6872 if (pg_strcasecmp(tok, "stderr") == 0)
6873 newlogdest |= LOG_DESTINATION_STDERR;
6874 else if (pg_strcasecmp(tok, "csvlog") == 0)
6875 newlogdest |= LOG_DESTINATION_CSVLOG;
6877 else if (pg_strcasecmp(tok, "syslog") == 0)
6878 newlogdest |= LOG_DESTINATION_SYSLOG;
6881 else if (pg_strcasecmp(tok, "eventlog") == 0)
6882 newlogdest |= LOG_DESTINATION_EVENTLOG;
6886 ereport(GUC_complaint_elevel(source),
6887 (errcode(ERRCODE_INVALID_PARAMETER_VALUE),
6888 errmsg("unrecognized \"log_destination\" key word: \"%s\"",
6891 list_free(elemlist);
6897 Log_destination = newlogdest;
6900 list_free(elemlist);
6908 assign_syslog_facility(int newval, bool doit, GucSource source)
6911 set_syslog_parameters(syslog_ident_str ? syslog_ident_str : "postgres",
6918 assign_syslog_ident(const char *ident, bool doit, GucSource source)
6921 set_syslog_parameters(ident, syslog_facility);
6925 #endif /* HAVE_SYSLOG */
6929 assign_session_replication_role(int newval, bool doit, GucSource source)
6932 * Must flush the plan cache when changing replication role; but don't
6933 * flush unnecessarily.
6935 if (doit && SessionReplicationRole != newval)
6944 show_num_temp_buffers(void)
6947 * We show the GUC var until local buffers have been initialized, and
6948 * NLocBuffer afterwards.
6950 static char nbuf[32];
6952 sprintf(nbuf, "%d", NLocBuffer ? NLocBuffer : num_temp_buffers);
6957 assign_phony_autocommit(bool newval, bool doit, GucSource source)
6961 ereport(GUC_complaint_elevel(source),
6962 (errcode(ERRCODE_FEATURE_NOT_SUPPORTED),
6963 errmsg("SET AUTOCOMMIT TO OFF is no longer supported")));
6970 assign_custom_variable_classes(const char *newval, bool doit, GucSource source)
6973 * Check syntax. newval must be a comma separated list of identifiers.
6974 * Whitespace is allowed but removed from the result.
6976 bool hasSpaceAfterToken = false;
6977 const char *cp = newval;
6982 initStringInfo(&buf);
6983 while ((c = *cp++) != '\0')
6985 if (isspace((unsigned char) c))
6988 hasSpaceAfterToken = true;
6994 if (symLen > 0) /* terminate identifier */
6996 appendStringInfoChar(&buf, ',');
6999 hasSpaceAfterToken = false;
7003 if (hasSpaceAfterToken || !isalnum((unsigned char) c))
7006 * Syntax error due to token following space after token or non
7007 * alpha numeric character
7012 appendStringInfoChar(&buf, c);
7016 /* Remove stray ',' at end */
7017 if (symLen == 0 && buf.len > 0)
7018 buf.data[--buf.len] = '\0';
7020 /* GUC wants the result malloc'd */
7021 newval = guc_strdup(LOG, buf.data);
7028 assign_debug_assertions(bool newval, bool doit, GucSource source)
7030 #ifndef USE_ASSERT_CHECKING
7033 ereport(GUC_complaint_elevel(source),
7034 (errcode(ERRCODE_INVALID_PARAMETER_VALUE),
7035 errmsg("assertion checking is not supported by this build")));
7043 assign_ssl(bool newval, bool doit, GucSource source)
7048 ereport(GUC_complaint_elevel(source),
7049 (errcode(ERRCODE_INVALID_PARAMETER_VALUE),
7050 errmsg("SSL is not supported by this build")));
7058 assign_stage_log_stats(bool newval, bool doit, GucSource source)
7060 if (newval && log_statement_stats)
7062 ereport(GUC_complaint_elevel(source),
7063 (errcode(ERRCODE_INVALID_PARAMETER_VALUE),
7064 errmsg("cannot enable parameter when \"log_statement_stats\" is true")));
7065 /* source == PGC_S_OVERRIDE means do it anyway, eg at xact abort */
7066 if (source != PGC_S_OVERRIDE)
7073 assign_log_stats(bool newval, bool doit, GucSource source)
7076 (log_parser_stats || log_planner_stats || log_executor_stats))
7078 ereport(GUC_complaint_elevel(source),
7079 (errcode(ERRCODE_INVALID_PARAMETER_VALUE),
7080 errmsg("cannot enable \"log_statement_stats\" when "
7081 "\"log_parser_stats\", \"log_planner_stats\", "
7082 "or \"log_executor_stats\" is true")));
7083 /* source == PGC_S_OVERRIDE means do it anyway, eg at xact abort */
7084 if (source != PGC_S_OVERRIDE)
7091 assign_transaction_read_only(bool newval, bool doit, GucSource source)
7093 /* Can't go to r/w mode inside a r/o transaction */
7094 if (newval == false && XactReadOnly && IsSubTransaction())
7096 ereport(GUC_complaint_elevel(source),
7097 (errcode(ERRCODE_INVALID_PARAMETER_VALUE),
7098 errmsg("cannot set transaction read-write mode inside a read-only transaction")));
7099 /* source == PGC_S_OVERRIDE means do it anyway, eg at xact abort */
7100 if (source != PGC_S_OVERRIDE)
7107 assign_canonical_path(const char *newval, bool doit, GucSource source)
7111 char *canon_val = guc_strdup(ERROR, newval);
7113 canonicalize_path(canon_val);
7121 assign_timezone_abbreviations(const char *newval, bool doit, GucSource source)
7124 * The powerup value shown above for timezone_abbreviations is "UNKNOWN".
7125 * When we see this we just do nothing. If this value isn't overridden
7126 * from the config file then pg_timezone_abbrev_initialize() will
7127 * eventually replace it with "Default". This hack has two purposes: to
7128 * avoid wasting cycles loading values that might soon be overridden from
7129 * the config file, and to avoid trying to read the timezone abbrev files
7130 * during InitializeGUCOptions(). The latter doesn't work in an
7131 * EXEC_BACKEND subprocess because my_exec_path hasn't been set yet and so
7132 * we can't locate PGSHAREDIR. (Essentially the same hack is used to
7133 * delay initializing TimeZone ... if we have any more, we should try to
7134 * clean up and centralize this mechanism ...)
7136 if (strcmp(newval, "UNKNOWN") == 0)
7141 /* Loading abbrev file is expensive, so only do it when value changes */
7142 if (timezone_abbreviations_string == NULL ||
7143 strcmp(timezone_abbreviations_string, newval) != 0)
7148 * If reading config file, only the postmaster should bleat loudly
7149 * about problems. Otherwise, it's just this one process doing it,
7150 * and we use WARNING message level.
7152 if (source == PGC_S_FILE)
7153 elevel = IsUnderPostmaster ? DEBUG3 : LOG;
7156 if (!load_tzoffsets(newval, doit, elevel))
7163 * pg_timezone_abbrev_initialize --- set default value if not done already
7165 * This is called after initial loading of postgresql.conf. If no
7166 * timezone_abbreviations setting was found therein, select default.
7169 pg_timezone_abbrev_initialize(void)
7171 if (strcmp(timezone_abbreviations_string, "UNKNOWN") == 0)
7173 SetConfigOption("timezone_abbreviations", "Default",
7174 PGC_POSTMASTER, PGC_S_ARGV);
7179 show_archive_command(void)
7181 if (XLogArchiveMode)
7182 return XLogArchiveCommand;
7184 return "(disabled)";
7188 assign_tcp_keepalives_idle(int newval, bool doit, GucSource source)
7191 return (pq_setkeepalivesidle(newval, MyProcPort) == STATUS_OK);
7197 show_tcp_keepalives_idle(void)
7199 static char nbuf[16];
7201 snprintf(nbuf, sizeof(nbuf), "%d", pq_getkeepalivesidle(MyProcPort));
7206 assign_tcp_keepalives_interval(int newval, bool doit, GucSource source)
7209 return (pq_setkeepalivesinterval(newval, MyProcPort) == STATUS_OK);
7215 show_tcp_keepalives_interval(void)
7217 static char nbuf[16];
7219 snprintf(nbuf, sizeof(nbuf), "%d", pq_getkeepalivesinterval(MyProcPort));
7224 assign_tcp_keepalives_count(int newval, bool doit, GucSource source)
7227 return (pq_setkeepalivescount(newval, MyProcPort) == STATUS_OK);
7233 show_tcp_keepalives_count(void)
7235 static char nbuf[16];
7237 snprintf(nbuf, sizeof(nbuf), "%d", pq_getkeepalivescount(MyProcPort));
7242 assign_maxconnections(int newval, bool doit, GucSource source)
7244 if (newval + autovacuum_max_workers > INT_MAX / 4)
7248 MaxBackends = newval + autovacuum_max_workers;
7254 assign_autovacuum_max_workers(int newval, bool doit, GucSource source)
7256 if (newval + MaxConnections > INT_MAX / 4)
7260 MaxBackends = newval + MaxConnections;
7265 #include "guc-file.c"