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.451 2008/05/02 21:26:10 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, 64, 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 {"cursor_tuple_fraction", PGC_USERSET, QUERY_TUNING_OTHER,
1896 gettext_noop("Sets the planner's estimate of the fraction of "
1897 "a cursor's rows that will be retrieved."),
1900 &cursor_tuple_fraction,
1901 DEFAULT_CURSOR_TUPLE_FRACTION, 0.0, 1.0, NULL, NULL
1905 {"geqo_selection_bias", PGC_USERSET, QUERY_TUNING_GEQO,
1906 gettext_noop("GEQO: selective pressure within the population."),
1909 &Geqo_selection_bias,
1910 DEFAULT_GEQO_SELECTION_BIAS, MIN_GEQO_SELECTION_BIAS,
1911 MAX_GEQO_SELECTION_BIAS, NULL, NULL
1915 {"bgwriter_lru_multiplier", PGC_SIGHUP, RESOURCES,
1916 gettext_noop("Multiple of the average buffer usage to free per round."),
1919 &bgwriter_lru_multiplier,
1920 2.0, 0.0, 10.0, NULL, NULL
1924 {"seed", PGC_USERSET, UNGROUPED,
1925 gettext_noop("Sets the seed for random-number generation."),
1927 GUC_NO_SHOW_ALL | GUC_NO_RESET_ALL | GUC_NOT_IN_SAMPLE | GUC_DISALLOW_IN_FILE
1930 0.0, -1.0, 1.0, assign_random_seed, show_random_seed
1934 {"autovacuum_vacuum_scale_factor", PGC_SIGHUP, AUTOVACUUM,
1935 gettext_noop("Number of tuple updates or deletes prior to vacuum as a fraction of reltuples."),
1938 &autovacuum_vac_scale,
1939 0.2, 0.0, 100.0, NULL, NULL
1942 {"autovacuum_analyze_scale_factor", PGC_SIGHUP, AUTOVACUUM,
1943 gettext_noop("Number of tuple inserts, updates or deletes prior to analyze as a fraction of reltuples."),
1946 &autovacuum_anl_scale,
1947 0.1, 0.0, 100.0, NULL, NULL
1951 {"checkpoint_completion_target", PGC_SIGHUP, WAL_CHECKPOINTS,
1952 gettext_noop("Time spent flushing dirty buffers during checkpoint, as fraction of checkpoint interval."),
1955 &CheckPointCompletionTarget,
1956 0.5, 0.0, 1.0, NULL, NULL
1959 /* End-of-list marker */
1961 {NULL, 0, 0, NULL, NULL}, NULL, 0.0, 0.0, 0.0, NULL, NULL
1966 static struct config_string ConfigureNamesString[] =
1969 {"archive_command", PGC_SIGHUP, WAL_SETTINGS,
1970 gettext_noop("Sets the shell command that will be called to archive a WAL file."),
1973 &XLogArchiveCommand,
1974 "", NULL, show_archive_command
1978 {"client_encoding", PGC_USERSET, CLIENT_CONN_LOCALE,
1979 gettext_noop("Sets the client's character set encoding."),
1981 GUC_IS_NAME | GUC_REPORT
1983 &client_encoding_string,
1984 "SQL_ASCII", assign_client_encoding, NULL
1988 {"log_line_prefix", PGC_SIGHUP, LOGGING_WHAT,
1989 gettext_noop("Controls information prefixed to each log line."),
1990 gettext_noop("If blank, no prefix is used.")
1997 {"log_timezone", PGC_SIGHUP, LOGGING_WHAT,
1998 gettext_noop("Sets the time zone to use in log messages."),
2001 &log_timezone_string,
2002 "UNKNOWN", assign_log_timezone, show_log_timezone
2006 {"DateStyle", PGC_USERSET, CLIENT_CONN_LOCALE,
2007 gettext_noop("Sets the display format for date and time values."),
2008 gettext_noop("Also controls interpretation of ambiguous "
2010 GUC_LIST_INPUT | GUC_REPORT
2013 "ISO, MDY", assign_datestyle, NULL
2017 {"default_tablespace", PGC_USERSET, CLIENT_CONN_STATEMENT,
2018 gettext_noop("Sets the default tablespace to create tables and indexes in."),
2019 gettext_noop("An empty string selects the database's default tablespace."),
2022 &default_tablespace,
2023 "", assign_default_tablespace, NULL
2027 {"temp_tablespaces", PGC_USERSET, CLIENT_CONN_STATEMENT,
2028 gettext_noop("Sets the tablespace(s) to use for temporary tables and sort files."),
2030 GUC_LIST_INPUT | GUC_LIST_QUOTE
2033 "", assign_temp_tablespaces, NULL
2037 {"dynamic_library_path", PGC_SUSET, CLIENT_CONN_OTHER,
2038 gettext_noop("Sets the path for dynamically loadable modules."),
2039 gettext_noop("If a dynamically loadable module needs to be opened and "
2040 "the specified name does not have a directory component (i.e., the "
2041 "name does not contain a slash), the system will search this path for "
2042 "the specified file."),
2045 &Dynamic_library_path,
2046 "$libdir", NULL, NULL
2050 {"krb_realm", PGC_POSTMASTER, CONN_AUTH_SECURITY,
2051 gettext_noop("Sets realm to match Kerberos and GSSAPI users against."),
2060 {"krb_server_keyfile", PGC_POSTMASTER, CONN_AUTH_SECURITY,
2061 gettext_noop("Sets the location of the Kerberos server key file."),
2065 &pg_krb_server_keyfile,
2066 PG_KRB_SRVTAB, NULL, NULL
2070 {"krb_srvname", PGC_POSTMASTER, CONN_AUTH_SECURITY,
2071 gettext_noop("Sets the name of the Kerberos service."),
2075 PG_KRB_SRVNAM, NULL, NULL
2079 {"krb_server_hostname", PGC_POSTMASTER, CONN_AUTH_SECURITY,
2080 gettext_noop("Sets the hostname of the Kerberos server."),
2083 &pg_krb_server_hostname,
2088 {"bonjour_name", PGC_POSTMASTER, CONN_AUTH_SETTINGS,
2089 gettext_noop("Sets the Bonjour broadcast service name."),
2096 /* See main.c about why defaults for LC_foo are not all alike */
2099 {"lc_collate", PGC_INTERNAL, CLIENT_CONN_LOCALE,
2100 gettext_noop("Shows the collation order locale."),
2102 GUC_NOT_IN_SAMPLE | GUC_DISALLOW_IN_FILE
2109 {"lc_ctype", PGC_INTERNAL, CLIENT_CONN_LOCALE,
2110 gettext_noop("Shows the character classification and case conversion locale."),
2112 GUC_NOT_IN_SAMPLE | GUC_DISALLOW_IN_FILE
2119 {"lc_messages", PGC_SUSET, CLIENT_CONN_LOCALE,
2120 gettext_noop("Sets the language in which messages are displayed."),
2124 "", locale_messages_assign, NULL
2128 {"lc_monetary", PGC_USERSET, CLIENT_CONN_LOCALE,
2129 gettext_noop("Sets the locale for formatting monetary amounts."),
2133 "C", locale_monetary_assign, NULL
2137 {"lc_numeric", PGC_USERSET, CLIENT_CONN_LOCALE,
2138 gettext_noop("Sets the locale for formatting numbers."),
2142 "C", locale_numeric_assign, NULL
2146 {"lc_time", PGC_USERSET, CLIENT_CONN_LOCALE,
2147 gettext_noop("Sets the locale for formatting date and time values."),
2151 "C", locale_time_assign, NULL
2155 {"shared_preload_libraries", PGC_POSTMASTER, RESOURCES_KERNEL,
2156 gettext_noop("Lists shared libraries to preload into server."),
2158 GUC_LIST_INPUT | GUC_LIST_QUOTE | GUC_SUPERUSER_ONLY
2160 &shared_preload_libraries_string,
2165 {"local_preload_libraries", PGC_BACKEND, CLIENT_CONN_OTHER,
2166 gettext_noop("Lists shared libraries to preload into each backend."),
2168 GUC_LIST_INPUT | GUC_LIST_QUOTE
2170 &local_preload_libraries_string,
2175 {"search_path", PGC_USERSET, CLIENT_CONN_STATEMENT,
2176 gettext_noop("Sets the schema search order for names that are not schema-qualified."),
2178 GUC_LIST_INPUT | GUC_LIST_QUOTE
2180 &namespace_search_path,
2181 "\"$user\",public", assign_search_path, NULL
2185 /* Can't be set in postgresql.conf */
2186 {"server_encoding", PGC_INTERNAL, CLIENT_CONN_LOCALE,
2187 gettext_noop("Sets the server (database) character set encoding."),
2189 GUC_IS_NAME | GUC_REPORT | GUC_NOT_IN_SAMPLE | GUC_DISALLOW_IN_FILE
2191 &server_encoding_string,
2192 "SQL_ASCII", NULL, NULL
2196 /* Can't be set in postgresql.conf */
2197 {"server_version", PGC_INTERNAL, PRESET_OPTIONS,
2198 gettext_noop("Shows the server version."),
2200 GUC_REPORT | GUC_NOT_IN_SAMPLE | GUC_DISALLOW_IN_FILE
2202 &server_version_string,
2203 PG_VERSION, NULL, NULL
2207 /* Not for general use --- used by SET ROLE */
2208 {"role", PGC_USERSET, UNGROUPED,
2209 gettext_noop("Sets the current role."),
2211 GUC_IS_NAME | GUC_NO_SHOW_ALL | GUC_NO_RESET_ALL | GUC_NOT_IN_SAMPLE | GUC_DISALLOW_IN_FILE
2214 "none", assign_role, show_role
2218 /* Not for general use --- used by SET SESSION AUTHORIZATION */
2219 {"session_authorization", PGC_USERSET, UNGROUPED,
2220 gettext_noop("Sets the session user name."),
2222 GUC_IS_NAME | GUC_REPORT | GUC_NO_SHOW_ALL | GUC_NO_RESET_ALL | GUC_NOT_IN_SAMPLE | GUC_DISALLOW_IN_FILE
2224 &session_authorization_string,
2225 NULL, assign_session_authorization, show_session_authorization
2229 {"log_destination", PGC_SIGHUP, LOGGING_WHERE,
2230 gettext_noop("Sets the destination for server log output."),
2231 gettext_noop("Valid values are combinations of \"stderr\", "
2232 "\"syslog\", \"csvlog\", and \"eventlog\", "
2233 "depending on the platform."),
2236 &log_destination_string,
2237 "stderr", assign_log_destination, NULL
2240 {"log_directory", PGC_SIGHUP, LOGGING_WHERE,
2241 gettext_noop("Sets the destination directory for log files."),
2242 gettext_noop("Can be specified as relative to the data directory "
2243 "or as absolute path."),
2247 "pg_log", assign_canonical_path, NULL
2250 {"log_filename", PGC_SIGHUP, LOGGING_WHERE,
2251 gettext_noop("Sets the file name pattern for log files."),
2256 "postgresql-%Y-%m-%d_%H%M%S.log", NULL, NULL
2261 {"syslog_ident", PGC_SIGHUP, LOGGING_WHERE,
2262 gettext_noop("Sets the program name used to identify PostgreSQL "
2263 "messages in syslog."),
2267 "postgres", assign_syslog_ident, NULL
2272 {"TimeZone", PGC_USERSET, CLIENT_CONN_LOCALE,
2273 gettext_noop("Sets the time zone for displaying and interpreting time stamps."),
2278 "UNKNOWN", assign_timezone, show_timezone
2281 {"timezone_abbreviations", PGC_USERSET, CLIENT_CONN_LOCALE,
2282 gettext_noop("Selects a file of time zone abbreviations."),
2285 &timezone_abbreviations_string,
2286 "UNKNOWN", assign_timezone_abbreviations, NULL
2290 {"transaction_isolation", PGC_USERSET, CLIENT_CONN_STATEMENT,
2291 gettext_noop("Sets the current transaction's isolation level."),
2293 GUC_NO_RESET_ALL | GUC_NOT_IN_SAMPLE | GUC_DISALLOW_IN_FILE
2295 &XactIsoLevel_string,
2296 NULL, assign_XactIsoLevel, show_XactIsoLevel
2300 {"unix_socket_group", PGC_POSTMASTER, CONN_AUTH_SETTINGS,
2301 gettext_noop("Sets the owning group of the Unix-domain socket."),
2302 gettext_noop("The owning user of the socket is always the user "
2303 "that starts the server.")
2310 {"unix_socket_directory", PGC_POSTMASTER, CONN_AUTH_SETTINGS,
2311 gettext_noop("Sets the directory where the Unix-domain socket will be created."),
2316 "", assign_canonical_path, NULL
2320 {"listen_addresses", PGC_POSTMASTER, CONN_AUTH_SETTINGS,
2321 gettext_noop("Sets the host name or IP address(es) to listen to."),
2326 "localhost", NULL, NULL
2330 {"wal_sync_method", PGC_SIGHUP, WAL_SETTINGS,
2331 gettext_noop("Selects the method used for forcing WAL updates to disk."),
2335 XLOG_sync_method_default, assign_xlog_sync_method, NULL
2339 {"custom_variable_classes", PGC_SIGHUP, CUSTOM_OPTIONS,
2340 gettext_noop("Sets the list of known custom variable classes."),
2342 GUC_LIST_INPUT | GUC_LIST_QUOTE
2344 &custom_variable_classes,
2345 NULL, assign_custom_variable_classes, NULL
2349 {"data_directory", PGC_POSTMASTER, FILE_LOCATIONS,
2350 gettext_noop("Sets the server's data directory."),
2359 {"config_file", PGC_POSTMASTER, FILE_LOCATIONS,
2360 gettext_noop("Sets the server's main configuration file."),
2362 GUC_DISALLOW_IN_FILE | GUC_SUPERUSER_ONLY
2369 {"hba_file", PGC_POSTMASTER, FILE_LOCATIONS,
2370 gettext_noop("Sets the server's \"hba\" configuration file."),
2379 {"ident_file", PGC_POSTMASTER, FILE_LOCATIONS,
2380 gettext_noop("Sets the server's \"ident\" configuration file."),
2389 {"external_pid_file", PGC_POSTMASTER, FILE_LOCATIONS,
2390 gettext_noop("Writes the postmaster PID to the specified file."),
2395 NULL, assign_canonical_path, NULL
2399 {"default_text_search_config", PGC_USERSET, CLIENT_CONN_LOCALE,
2400 gettext_noop("Sets default text search configuration."),
2404 "pg_catalog.simple", assignTSCurrentConfig, NULL
2409 {"ssl_ciphers", PGC_POSTMASTER, CONN_AUTH_SECURITY,
2410 gettext_noop("Sets the list of allowed SSL ciphers."),
2415 "ALL:!ADH:!LOW:!EXP:!MD5:@STRENGTH", NULL, NULL
2417 #endif /* USE_SSL */
2419 /* End-of-list marker */
2421 {NULL, 0, 0, NULL, NULL}, NULL, NULL, NULL, NULL
2426 static struct config_enum ConfigureNamesEnum[] =
2429 {"backslash_quote", PGC_USERSET, COMPAT_OPTIONS_PREVIOUS,
2430 gettext_noop("Sets whether \"\\'\" is allowed in string literals."),
2431 gettext_noop("Valid values are ON, OFF, and SAFE_ENCODING.")
2434 BACKSLASH_QUOTE_SAFE_ENCODING, backslash_quote_options, NULL, NULL
2438 {"client_min_messages", PGC_USERSET, LOGGING_WHEN,
2439 gettext_noop("Sets the message levels that are sent to the client."),
2440 gettext_noop("Valid values are DEBUG5, DEBUG4, DEBUG3, DEBUG2, "
2441 "DEBUG1, LOG, NOTICE, WARNING, and ERROR. Each level includes all the "
2442 "levels that follow it. The later the level, the fewer messages are "
2445 &client_min_messages,
2446 NOTICE, message_level_options,NULL, NULL
2450 {"default_transaction_isolation", PGC_USERSET, CLIENT_CONN_STATEMENT,
2451 gettext_noop("Sets the transaction isolation level of each new transaction."),
2452 gettext_noop("Each SQL transaction has an isolation level, which "
2453 "can be either \"read uncommitted\", \"read committed\", \"repeatable read\", or \"serializable\".")
2455 &DefaultXactIsoLevel,
2456 XACT_READ_COMMITTED, isolation_level_options, NULL, NULL
2460 {"log_error_verbosity", PGC_SUSET, LOGGING_WHEN,
2461 gettext_noop("Sets the verbosity of logged messages."),
2462 gettext_noop("Valid values are \"terse\", \"default\", and \"verbose\".")
2464 &Log_error_verbosity,
2465 PGERROR_DEFAULT, log_error_verbosity_options, NULL, NULL
2469 {"log_min_messages", PGC_SUSET, LOGGING_WHEN,
2470 gettext_noop("Sets the message levels that are logged."),
2471 gettext_noop("Valid values are DEBUG5, DEBUG4, DEBUG3, DEBUG2, DEBUG1, "
2472 "INFO, NOTICE, WARNING, ERROR, LOG, FATAL, and PANIC. Each level "
2473 "includes all the levels that follow it.")
2476 WARNING, message_level_options, NULL, NULL
2480 {"log_min_error_statement", PGC_SUSET, LOGGING_WHEN,
2481 gettext_noop("Causes all statements generating error at or above this level to be logged."),
2482 gettext_noop("All SQL statements that cause an error of the "
2483 "specified level or a higher level are logged.")
2485 &log_min_error_statement,
2486 ERROR, message_level_options, NULL, NULL
2490 {"log_statement", PGC_SUSET, LOGGING_WHAT,
2491 gettext_noop("Sets the type of statements logged."),
2492 gettext_noop("Valid values are \"none\", \"ddl\", \"mod\", and \"all\".")
2495 LOGSTMT_NONE, log_statement_options, NULL, NULL
2500 {"syslog_facility", PGC_SIGHUP, LOGGING_WHERE,
2501 gettext_noop("Sets the syslog \"facility\" to be used when syslog enabled."),
2502 gettext_noop("Valid values are LOCAL0, LOCAL1, LOCAL2, LOCAL3, "
2503 "LOCAL4, LOCAL5, LOCAL6, LOCAL7.")
2506 LOG_LOCAL0, syslog_facility_options, assign_syslog_facility, NULL
2511 {"regex_flavor", PGC_USERSET, COMPAT_OPTIONS_PREVIOUS,
2512 gettext_noop("Sets the regular expression \"flavor\"."),
2513 gettext_noop("This can be set to advanced, extended, or basic.")
2516 REG_ADVANCED, regex_flavor_options, NULL, NULL
2520 {"session_replication_role", PGC_SUSET, CLIENT_CONN_STATEMENT,
2521 gettext_noop("Sets the session's behavior for triggers and rewrite rules."),
2522 gettext_noop("Each session can be either"
2523 " \"origin\", \"replica\", or \"local\".")
2525 &SessionReplicationRole,
2526 SESSION_REPLICATION_ROLE_ORIGIN, session_replication_role_options,
2527 assign_session_replication_role, NULL
2531 {"xmlbinary", PGC_USERSET, CLIENT_CONN_STATEMENT,
2532 gettext_noop("Sets how binary values are to be encoded in XML."),
2533 gettext_noop("Valid values are BASE64 and HEX.")
2536 XMLBINARY_BASE64, xmlbinary_options, NULL, NULL
2540 {"xmloption", PGC_USERSET, CLIENT_CONN_STATEMENT,
2541 gettext_noop("Sets whether XML data in implicit parsing and serialization "
2542 "operations is to be considered as documents or content fragments."),
2543 gettext_noop("Valid values are DOCUMENT and CONTENT.")
2546 XMLOPTION_CONTENT, xmloption_options, NULL, NULL
2550 /* End-of-list marker */
2552 {NULL, 0, 0, NULL, NULL}, NULL, 0, NULL, NULL, NULL
2556 /******** end of options list ********/
2560 * To allow continued support of obsolete names for GUC variables, we apply
2561 * the following mappings to any unrecognized name. Note that an old name
2562 * should be mapped to a new one only if the new variable has very similar
2563 * semantics to the old.
2565 static const char *const map_old_guc_names[] = {
2566 "sort_mem", "work_mem",
2567 "vacuum_mem", "maintenance_work_mem",
2573 * Actual lookup of variables is done through this single, sorted array.
2575 static struct config_generic **guc_variables;
2577 /* Current number of variables contained in the vector */
2578 static int num_guc_variables;
2580 /* Vector capacity */
2581 static int size_guc_variables;
2584 static bool guc_dirty; /* TRUE if need to do commit/abort work */
2586 static bool reporting_enabled; /* TRUE to enable GUC_REPORT */
2588 static int GUCNestLevel = 0; /* 1 when in main transaction */
2591 static int guc_var_compare(const void *a, const void *b);
2592 static int guc_name_compare(const char *namea, const char *nameb);
2593 static void push_old_value(struct config_generic * gconf, GucAction action);
2594 static void ReportGUCOption(struct config_generic * record);
2595 static void ShowGUCConfigOption(const char *name, DestReceiver *dest);
2596 static void ShowAllGUCConfig(DestReceiver *dest);
2597 static char *_ShowOption(struct config_generic * record, bool use_units);
2598 static bool is_newvalue_equal(struct config_generic * record, const char *newvalue);
2602 * Some infrastructure for checking malloc/strdup/realloc calls
2605 guc_malloc(int elevel, size_t size)
2609 data = malloc(size);
2612 (errcode(ERRCODE_OUT_OF_MEMORY),
2613 errmsg("out of memory")));
2618 guc_realloc(int elevel, void *old, size_t size)
2622 data = realloc(old, size);
2625 (errcode(ERRCODE_OUT_OF_MEMORY),
2626 errmsg("out of memory")));
2631 guc_strdup(int elevel, const char *src)
2638 (errcode(ERRCODE_OUT_OF_MEMORY),
2639 errmsg("out of memory")));
2645 * Support for assigning to a field of a string GUC item. Free the prior
2646 * value if it's not referenced anywhere else in the item (including stacked
2650 set_string_field(struct config_string * conf, char **field, char *newval)
2652 char *oldval = *field;
2655 /* Do the assignment */
2658 /* Exit if any duplicate references, or if old value was NULL anyway */
2659 if (oldval == NULL ||
2660 oldval == *(conf->variable) ||
2661 oldval == conf->reset_val ||
2662 oldval == conf->boot_val)
2664 for (stack = conf->gen.stack; stack; stack = stack->prev)
2666 if (oldval == stack->prior.stringval ||
2667 oldval == stack->masked.stringval)
2671 /* Not used anymore, so free it */
2676 * Detect whether strval is referenced anywhere in a GUC string item
2679 string_field_used(struct config_string * conf, char *strval)
2683 if (strval == *(conf->variable) ||
2684 strval == conf->reset_val ||
2685 strval == conf->boot_val)
2687 for (stack = conf->gen.stack; stack; stack = stack->prev)
2689 if (strval == stack->prior.stringval ||
2690 strval == stack->masked.stringval)
2697 * Support for copying a variable's active value into a stack entry
2700 set_stack_value(struct config_generic * gconf, union config_var_value * val)
2702 switch (gconf->vartype)
2706 *((struct config_bool *) gconf)->variable;
2710 *((struct config_int *) gconf)->variable;
2714 *((struct config_real *) gconf)->variable;
2717 /* we assume stringval is NULL if not valid */
2718 set_string_field((struct config_string *) gconf,
2720 *((struct config_string *) gconf)->variable);
2724 *((struct config_enum *) gconf)->variable;
2730 * Support for discarding a no-longer-needed value in a stack entry
2733 discard_stack_value(struct config_generic * gconf, union config_var_value * val)
2735 switch (gconf->vartype)
2741 /* no need to do anything */
2744 set_string_field((struct config_string *) gconf,
2753 * Fetch the sorted array pointer (exported for help_config.c's use ONLY)
2755 struct config_generic **
2756 get_guc_variables(void)
2758 return guc_variables;
2763 * Build the sorted array. This is split out so that it could be
2764 * re-executed after startup (eg, we could allow loadable modules to
2765 * add vars, and then we'd need to re-sort).
2768 build_guc_variables(void)
2772 struct config_generic **guc_vars;
2775 for (i = 0; ConfigureNamesBool[i].gen.name; i++)
2777 struct config_bool *conf = &ConfigureNamesBool[i];
2779 /* Rather than requiring vartype to be filled in by hand, do this: */
2780 conf->gen.vartype = PGC_BOOL;
2784 for (i = 0; ConfigureNamesInt[i].gen.name; i++)
2786 struct config_int *conf = &ConfigureNamesInt[i];
2788 conf->gen.vartype = PGC_INT;
2792 for (i = 0; ConfigureNamesReal[i].gen.name; i++)
2794 struct config_real *conf = &ConfigureNamesReal[i];
2796 conf->gen.vartype = PGC_REAL;
2800 for (i = 0; ConfigureNamesString[i].gen.name; i++)
2802 struct config_string *conf = &ConfigureNamesString[i];
2804 conf->gen.vartype = PGC_STRING;
2808 for (i = 0; ConfigureNamesEnum[i].gen.name; i++)
2810 struct config_enum *conf = &ConfigureNamesEnum[i];
2812 conf->gen.vartype = PGC_ENUM;
2817 * Create table with 20% slack
2819 size_vars = num_vars + num_vars / 4;
2821 guc_vars = (struct config_generic **)
2822 guc_malloc(FATAL, size_vars * sizeof(struct config_generic *));
2826 for (i = 0; ConfigureNamesBool[i].gen.name; i++)
2827 guc_vars[num_vars++] = &ConfigureNamesBool[i].gen;
2829 for (i = 0; ConfigureNamesInt[i].gen.name; i++)
2830 guc_vars[num_vars++] = &ConfigureNamesInt[i].gen;
2832 for (i = 0; ConfigureNamesReal[i].gen.name; i++)
2833 guc_vars[num_vars++] = &ConfigureNamesReal[i].gen;
2835 for (i = 0; ConfigureNamesString[i].gen.name; i++)
2836 guc_vars[num_vars++] = &ConfigureNamesString[i].gen;
2838 for (i = 0; ConfigureNamesEnum[i].gen.name; i++)
2839 guc_vars[num_vars++] = &ConfigureNamesEnum[i].gen;
2842 free(guc_variables);
2843 guc_variables = guc_vars;
2844 num_guc_variables = num_vars;
2845 size_guc_variables = size_vars;
2846 qsort((void *) guc_variables, num_guc_variables,
2847 sizeof(struct config_generic *), guc_var_compare);
2851 * Add a new GUC variable to the list of known variables. The
2852 * list is expanded if needed.
2855 add_guc_variable(struct config_generic * var, int elevel)
2857 if (num_guc_variables + 1 >= size_guc_variables)
2860 * Increase the vector by 25%
2862 int size_vars = size_guc_variables + size_guc_variables / 4;
2863 struct config_generic **guc_vars;
2868 guc_vars = (struct config_generic **)
2869 guc_malloc(elevel, size_vars * sizeof(struct config_generic *));
2873 guc_vars = (struct config_generic **)
2874 guc_realloc(elevel, guc_variables, size_vars * sizeof(struct config_generic *));
2877 if (guc_vars == NULL)
2878 return false; /* out of memory */
2880 guc_variables = guc_vars;
2881 size_guc_variables = size_vars;
2883 guc_variables[num_guc_variables++] = var;
2884 qsort((void *) guc_variables, num_guc_variables,
2885 sizeof(struct config_generic *), guc_var_compare);
2890 * Create and add a placeholder variable. It's presumed to belong
2891 * to a valid custom variable class at this point.
2893 static struct config_generic *
2894 add_placeholder_variable(const char *name, int elevel)
2896 size_t sz = sizeof(struct config_string) + sizeof(char *);
2897 struct config_string *var;
2898 struct config_generic *gen;
2900 var = (struct config_string *) guc_malloc(elevel, sz);
2906 gen->name = guc_strdup(elevel, name);
2907 if (gen->name == NULL)
2913 gen->context = PGC_USERSET;
2914 gen->group = CUSTOM_OPTIONS;
2915 gen->short_desc = "GUC placeholder variable";
2916 gen->flags = GUC_NO_SHOW_ALL | GUC_NOT_IN_SAMPLE | GUC_CUSTOM_PLACEHOLDER;
2917 gen->vartype = PGC_STRING;
2920 * The char* is allocated at the end of the struct since we have no
2921 * 'static' place to point to. Note that the current value, as well as
2922 * the boot and reset values, start out NULL.
2924 var->variable = (char **) (var + 1);
2926 if (!add_guc_variable((struct config_generic *) var, elevel))
2928 free((void *) gen->name);
2937 * Detect whether the portion of "name" before dotPos matches any custom
2938 * variable class name listed in custom_var_classes. The latter must be
2939 * formatted the way that assign_custom_variable_classes does it, ie,
2940 * no whitespace. NULL is valid for custom_var_classes.
2943 is_custom_class(const char *name, int dotPos, const char *custom_var_classes)
2945 bool result = false;
2946 const char *ccs = custom_var_classes;
2950 const char *start = ccs;
2956 if (c == '\0' || c == ',')
2958 if (dotPos == ccs - start && strncmp(start, name, dotPos) == 0)
2973 * Look up option NAME. If it exists, return a pointer to its record,
2974 * else return NULL. If create_placeholders is TRUE, we'll create a
2975 * placeholder record for a valid-looking custom variable name.
2977 static struct config_generic *
2978 find_option(const char *name, bool create_placeholders, int elevel)
2980 const char **key = &name;
2981 struct config_generic **res;
2987 * By equating const char ** with struct config_generic *, we are assuming
2988 * the name field is first in config_generic.
2990 res = (struct config_generic **) bsearch((void *) &key,
2991 (void *) guc_variables,
2993 sizeof(struct config_generic *),
2999 * See if the name is an obsolete name for a variable. We assume that the
3000 * set of supported old names is short enough that a brute-force search is
3003 for (i = 0; map_old_guc_names[i] != NULL; i += 2)
3005 if (guc_name_compare(name, map_old_guc_names[i]) == 0)
3006 return find_option(map_old_guc_names[i + 1], false, elevel);
3009 if (create_placeholders)
3012 * Check if the name is qualified, and if so, check if the qualifier
3013 * matches any custom variable class. If so, add a placeholder.
3015 const char *dot = strchr(name, GUC_QUALIFIER_SEPARATOR);
3018 is_custom_class(name, dot - name, custom_variable_classes))
3019 return add_placeholder_variable(name, elevel);
3028 * comparator for qsorting and bsearching guc_variables array
3031 guc_var_compare(const void *a, const void *b)
3033 struct config_generic *confa = *(struct config_generic **) a;
3034 struct config_generic *confb = *(struct config_generic **) b;
3036 return guc_name_compare(confa->name, confb->name);
3040 * the bare comparison function for GUC names
3043 guc_name_compare(const char *namea, const char *nameb)
3046 * The temptation to use strcasecmp() here must be resisted, because the
3047 * array ordering has to remain stable across setlocale() calls. So, build
3048 * our own with a simple ASCII-only downcasing.
3050 while (*namea && *nameb)
3052 char cha = *namea++;
3053 char chb = *nameb++;
3055 if (cha >= 'A' && cha <= 'Z')
3057 if (chb >= 'A' && chb <= 'Z')
3063 return 1; /* a is longer */
3065 return -1; /* b is longer */
3071 * Initialize GUC options during program startup.
3073 * Note that we cannot read the config file yet, since we have not yet
3074 * processed command-line switches.
3077 InitializeGUCOptions(void)
3084 * Before log_line_prefix could possibly receive a nonempty setting, make
3085 * sure that timezone processing is minimally alive (see elog.c).
3087 pg_timezone_pre_initialize();
3090 * Build sorted array of all GUC variables.
3092 build_guc_variables();
3095 * Load all variables with their compiled-in defaults, and initialize
3096 * status fields as needed.
3098 for (i = 0; i < num_guc_variables; i++)
3100 struct config_generic *gconf = guc_variables[i];
3103 gconf->reset_source = PGC_S_DEFAULT;
3104 gconf->source = PGC_S_DEFAULT;
3105 gconf->stack = NULL;
3107 switch (gconf->vartype)
3111 struct config_bool *conf = (struct config_bool *) gconf;
3113 if (conf->assign_hook)
3114 if (!(*conf->assign_hook) (conf->boot_val, true,
3116 elog(FATAL, "failed to initialize %s to %d",
3117 conf->gen.name, (int) conf->boot_val);
3118 *conf->variable = conf->reset_val = conf->boot_val;
3123 struct config_int *conf = (struct config_int *) gconf;
3125 Assert(conf->boot_val >= conf->min);
3126 Assert(conf->boot_val <= conf->max);
3127 if (conf->assign_hook)
3128 if (!(*conf->assign_hook) (conf->boot_val, true,
3130 elog(FATAL, "failed to initialize %s to %d",
3131 conf->gen.name, conf->boot_val);
3132 *conf->variable = conf->reset_val = conf->boot_val;
3137 struct config_real *conf = (struct config_real *) gconf;
3139 Assert(conf->boot_val >= conf->min);
3140 Assert(conf->boot_val <= conf->max);
3141 if (conf->assign_hook)
3142 if (!(*conf->assign_hook) (conf->boot_val, true,
3144 elog(FATAL, "failed to initialize %s to %g",
3145 conf->gen.name, conf->boot_val);
3146 *conf->variable = conf->reset_val = conf->boot_val;
3151 struct config_string *conf = (struct config_string *) gconf;
3154 *conf->variable = NULL;
3155 conf->reset_val = NULL;
3157 if (conf->boot_val == NULL)
3159 /* leave the value NULL, do not call assign hook */
3163 str = guc_strdup(FATAL, conf->boot_val);
3164 conf->reset_val = str;
3166 if (conf->assign_hook)
3170 newstr = (*conf->assign_hook) (str, true,
3174 elog(FATAL, "failed to initialize %s to \"%s\"",
3175 conf->gen.name, str);
3177 else if (newstr != str)
3182 * See notes in set_config_option about casting
3184 str = (char *) newstr;
3185 conf->reset_val = str;
3188 *conf->variable = str;
3193 struct config_enum *conf = (struct config_enum *) gconf;
3195 if (conf->assign_hook)
3196 if (!(*conf->assign_hook) (conf->boot_val, true,
3198 elog(FATAL, "failed to initialize %s to %s",
3200 config_enum_lookup_by_value(conf, conf->boot_val));
3201 *conf->variable = conf->reset_val = conf->boot_val;
3209 reporting_enabled = false;
3212 * Prevent any attempt to override the transaction modes from
3213 * non-interactive sources.
3215 SetConfigOption("transaction_isolation", "default",
3216 PGC_POSTMASTER, PGC_S_OVERRIDE);
3217 SetConfigOption("transaction_read_only", "no",
3218 PGC_POSTMASTER, PGC_S_OVERRIDE);
3221 * For historical reasons, some GUC parameters can receive defaults from
3222 * environment variables. Process those settings. NB: if you add or
3223 * remove anything here, see also ProcessConfigFile().
3226 env = getenv("PGPORT");
3228 SetConfigOption("port", env, PGC_POSTMASTER, PGC_S_ENV_VAR);
3230 env = getenv("PGDATESTYLE");
3232 SetConfigOption("datestyle", env, PGC_POSTMASTER, PGC_S_ENV_VAR);
3234 env = getenv("PGCLIENTENCODING");
3236 SetConfigOption("client_encoding", env, PGC_POSTMASTER, PGC_S_ENV_VAR);
3239 * rlimit isn't exactly an "environment variable", but it behaves about
3240 * the same. If we can identify the platform stack depth rlimit, increase
3241 * default stack depth setting up to whatever is safe (but at most 2MB).
3243 stack_rlimit = get_stack_depth_rlimit();
3244 if (stack_rlimit > 0)
3246 int new_limit = (stack_rlimit - STACK_DEPTH_SLOP) / 1024L;
3248 if (new_limit > 100)
3252 new_limit = Min(new_limit, 2048);
3253 sprintf(limbuf, "%d", new_limit);
3254 SetConfigOption("max_stack_depth", limbuf,
3255 PGC_POSTMASTER, PGC_S_ENV_VAR);
3262 * Select the configuration files and data directory to be used, and
3263 * do the initial read of postgresql.conf.
3265 * This is called after processing command-line switches.
3266 * userDoption is the -D switch value if any (NULL if unspecified).
3267 * progname is just for use in error messages.
3269 * Returns true on success; on failure, prints a suitable error message
3270 * to stderr and returns false.
3273 SelectConfigFiles(const char *userDoption, const char *progname)
3277 struct stat stat_buf;
3279 /* configdir is -D option, or $PGDATA if no -D */
3281 configdir = make_absolute_path(userDoption);
3283 configdir = make_absolute_path(getenv("PGDATA"));
3286 * Find the configuration file: if config_file was specified on the
3287 * command line, use it, else use configdir/postgresql.conf. In any case
3288 * ensure the result is an absolute path, so that it will be interpreted
3289 * the same way by future backends.
3292 fname = make_absolute_path(ConfigFileName);
3295 fname = guc_malloc(FATAL,
3296 strlen(configdir) + strlen(CONFIG_FILENAME) + 2);
3297 sprintf(fname, "%s/%s", configdir, CONFIG_FILENAME);
3301 write_stderr("%s does not know where to find the server configuration file.\n"
3302 "You must specify the --config-file or -D invocation "
3303 "option or set the PGDATA environment variable.\n",
3309 * Set the ConfigFileName GUC variable to its final value, ensuring that
3310 * it can't be overridden later.
3312 SetConfigOption("config_file", fname, PGC_POSTMASTER, PGC_S_OVERRIDE);
3316 * Now read the config file for the first time.
3318 if (stat(ConfigFileName, &stat_buf) != 0)
3320 write_stderr("%s cannot access the server configuration file \"%s\": %s\n",
3321 progname, ConfigFileName, strerror(errno));
3325 ProcessConfigFile(PGC_POSTMASTER);
3328 * If the data_directory GUC variable has been set, use that as DataDir;
3329 * otherwise use configdir if set; else punt.
3331 * Note: SetDataDir will copy and absolute-ize its argument, so we don't
3335 SetDataDir(data_directory);
3337 SetDataDir(configdir);
3340 write_stderr("%s does not know where to find the database system data.\n"
3341 "This can be specified as \"data_directory\" in \"%s\", "
3342 "or by the -D invocation option, or by the "
3343 "PGDATA environment variable.\n",
3344 progname, ConfigFileName);
3349 * Reflect the final DataDir value back into the data_directory GUC var.
3350 * (If you are wondering why we don't just make them a single variable,
3351 * it's because the EXEC_BACKEND case needs DataDir to be transmitted to
3352 * child backends specially. XXX is that still true? Given that we now
3353 * chdir to DataDir, EXEC_BACKEND can read the config file without knowing
3354 * DataDir in advance.)
3356 SetConfigOption("data_directory", DataDir, PGC_POSTMASTER, PGC_S_OVERRIDE);
3359 * Figure out where pg_hba.conf is, and make sure the path is absolute.
3362 fname = make_absolute_path(HbaFileName);
3365 fname = guc_malloc(FATAL,
3366 strlen(configdir) + strlen(HBA_FILENAME) + 2);
3367 sprintf(fname, "%s/%s", configdir, HBA_FILENAME);
3371 write_stderr("%s does not know where to find the \"hba\" configuration file.\n"
3372 "This can be specified as \"hba_file\" in \"%s\", "
3373 "or by the -D invocation option, or by the "
3374 "PGDATA environment variable.\n",
3375 progname, ConfigFileName);
3378 SetConfigOption("hba_file", fname, PGC_POSTMASTER, PGC_S_OVERRIDE);
3382 * Likewise for pg_ident.conf.
3385 fname = make_absolute_path(IdentFileName);
3388 fname = guc_malloc(FATAL,
3389 strlen(configdir) + strlen(IDENT_FILENAME) + 2);
3390 sprintf(fname, "%s/%s", configdir, IDENT_FILENAME);
3394 write_stderr("%s does not know where to find the \"ident\" configuration file.\n"
3395 "This can be specified as \"ident_file\" in \"%s\", "
3396 "or by the -D invocation option, or by the "
3397 "PGDATA environment variable.\n",
3398 progname, ConfigFileName);
3401 SetConfigOption("ident_file", fname, PGC_POSTMASTER, PGC_S_OVERRIDE);
3411 * Reset all options to their saved default values (implements RESET ALL)
3414 ResetAllOptions(void)
3418 for (i = 0; i < num_guc_variables; i++)
3420 struct config_generic *gconf = guc_variables[i];
3422 /* Don't reset non-SET-able values */
3423 if (gconf->context != PGC_SUSET &&
3424 gconf->context != PGC_USERSET)
3426 /* Don't reset if special exclusion from RESET ALL */
3427 if (gconf->flags & GUC_NO_RESET_ALL)
3429 /* No need to reset if wasn't SET */
3430 if (gconf->source <= PGC_S_OVERRIDE)
3433 /* Save old value to support transaction abort */
3434 push_old_value(gconf, GUC_ACTION_SET);
3436 switch (gconf->vartype)
3440 struct config_bool *conf = (struct config_bool *) gconf;
3442 if (conf->assign_hook)
3443 if (!(*conf->assign_hook) (conf->reset_val, true,
3445 elog(ERROR, "failed to reset %s", conf->gen.name);
3446 *conf->variable = conf->reset_val;
3447 conf->gen.source = conf->gen.reset_source;
3452 struct config_int *conf = (struct config_int *) gconf;
3454 if (conf->assign_hook)
3455 if (!(*conf->assign_hook) (conf->reset_val, true,
3457 elog(ERROR, "failed to reset %s", conf->gen.name);
3458 *conf->variable = conf->reset_val;
3459 conf->gen.source = conf->gen.reset_source;
3464 struct config_real *conf = (struct config_real *) gconf;
3466 if (conf->assign_hook)
3467 if (!(*conf->assign_hook) (conf->reset_val, true,
3469 elog(ERROR, "failed to reset %s", conf->gen.name);
3470 *conf->variable = conf->reset_val;
3471 conf->gen.source = conf->gen.reset_source;
3476 struct config_string *conf = (struct config_string *) gconf;
3479 /* We need not strdup here */
3480 str = conf->reset_val;
3482 if (conf->assign_hook && str)
3486 newstr = (*conf->assign_hook) (str, true,
3489 elog(ERROR, "failed to reset %s", conf->gen.name);
3490 else if (newstr != str)
3493 * See notes in set_config_option about casting
3495 str = (char *) newstr;
3499 set_string_field(conf, conf->variable, str);
3500 conf->gen.source = conf->gen.reset_source;
3505 struct config_enum *conf = (struct config_enum *) gconf;
3507 if (conf->assign_hook)
3508 if (!(*conf->assign_hook) (conf->reset_val, true,
3510 elog(ERROR, "failed to reset %s", conf->gen.name);
3511 *conf->variable = conf->reset_val;
3512 conf->gen.source = conf->gen.reset_source;
3517 if (gconf->flags & GUC_REPORT)
3518 ReportGUCOption(gconf);
3525 * Push previous state during transactional assignment to a GUC variable.
3528 push_old_value(struct config_generic * gconf, GucAction action)
3532 /* If we're not inside a nest level, do nothing */
3533 if (GUCNestLevel == 0)
3536 /* Do we already have a stack entry of the current nest level? */
3537 stack = gconf->stack;
3538 if (stack && stack->nest_level >= GUCNestLevel)
3540 /* Yes, so adjust its state if necessary */
3541 Assert(stack->nest_level == GUCNestLevel);
3544 case GUC_ACTION_SET:
3545 /* SET overrides any prior action at same nest level */
3546 if (stack->state == GUC_SET_LOCAL)
3548 /* must discard old masked value */
3549 discard_stack_value(gconf, &stack->masked);
3551 stack->state = GUC_SET;
3553 case GUC_ACTION_LOCAL:
3554 if (stack->state == GUC_SET)
3556 /* SET followed by SET LOCAL, remember SET's value */
3557 set_stack_value(gconf, &stack->masked);
3558 stack->state = GUC_SET_LOCAL;
3560 /* in all other cases, no change to stack entry */
3562 case GUC_ACTION_SAVE:
3563 /* Could only have a prior SAVE of same variable */
3564 Assert(stack->state == GUC_SAVE);
3567 Assert(guc_dirty); /* must be set already */
3572 * Push a new stack entry
3574 * We keep all the stack entries in TopTransactionContext for simplicity.
3576 stack = (GucStack *) MemoryContextAllocZero(TopTransactionContext,
3579 stack->prev = gconf->stack;
3580 stack->nest_level = GUCNestLevel;
3583 case GUC_ACTION_SET:
3584 stack->state = GUC_SET;
3586 case GUC_ACTION_LOCAL:
3587 stack->state = GUC_LOCAL;
3589 case GUC_ACTION_SAVE:
3590 stack->state = GUC_SAVE;
3593 stack->source = gconf->source;
3594 set_stack_value(gconf, &stack->prior);
3596 gconf->stack = stack;
3598 /* Ensure we remember to pop at end of xact */
3604 * Do GUC processing at main transaction start.
3610 * The nest level should be 0 between transactions; if it isn't, somebody
3611 * didn't call AtEOXact_GUC, or called it with the wrong nestLevel. We
3612 * throw a warning but make no other effort to clean up.
3614 if (GUCNestLevel != 0)
3615 elog(WARNING, "GUC nest level = %d at transaction start",
3621 * Enter a new nesting level for GUC values. This is called at subtransaction
3622 * start and when entering a function that has proconfig settings. NOTE that
3623 * we must not risk error here, else subtransaction start will be unhappy.
3626 NewGUCNestLevel(void)
3628 return ++GUCNestLevel;
3632 * Do GUC processing at transaction or subtransaction commit or abort, or
3633 * when exiting a function that has proconfig settings. (The name is thus
3634 * a bit of a misnomer; perhaps it should be ExitGUCNestLevel or some such.)
3635 * During abort, we discard all GUC settings that were applied at nesting
3636 * levels >= nestLevel. nestLevel == 1 corresponds to the main transaction.
3639 AtEOXact_GUC(bool isCommit, int nestLevel)
3644 Assert(nestLevel > 0 && nestLevel <= GUCNestLevel);
3646 /* Quick exit if nothing's changed in this transaction */
3649 GUCNestLevel = nestLevel - 1;
3653 still_dirty = false;
3654 for (i = 0; i < num_guc_variables; i++)
3656 struct config_generic *gconf = guc_variables[i];
3660 * Process and pop each stack entry within the nest level. To
3661 * simplify fmgr_security_definer(), we allow failure exit from a
3662 * function-with-SET-options to be recovered at the surrounding
3663 * transaction or subtransaction abort; so there could be more than
3664 * one stack entry to pop.
3666 while ((stack = gconf->stack) != NULL &&
3667 stack->nest_level >= nestLevel)
3669 GucStack *prev = stack->prev;
3670 bool restorePrior = false;
3671 bool restoreMasked = false;
3675 * In this next bit, if we don't set either restorePrior or
3676 * restoreMasked, we must "discard" any unwanted fields of the
3677 * stack entries to avoid leaking memory. If we do set one of
3678 * those flags, unused fields will be cleaned up after restoring.
3680 if (!isCommit) /* if abort, always restore prior value */
3681 restorePrior = true;
3682 else if (stack->state == GUC_SAVE)
3683 restorePrior = true;
3684 else if (stack->nest_level == 1)
3686 /* transaction commit */
3687 if (stack->state == GUC_SET_LOCAL)
3688 restoreMasked = true;
3689 else if (stack->state == GUC_SET)
3691 /* we keep the current active value */
3692 discard_stack_value(gconf, &stack->prior);
3694 else /* must be GUC_LOCAL */
3695 restorePrior = true;
3697 else if (prev == NULL ||
3698 prev->nest_level < stack->nest_level - 1)
3700 /* decrement entry's level and do not pop it */
3701 stack->nest_level--;
3707 * We have to merge this stack entry into prev. See README for
3708 * discussion of this bit.
3710 switch (stack->state)
3713 Assert(false); /* can't get here */
3716 /* next level always becomes SET */
3717 discard_stack_value(gconf, &stack->prior);
3718 if (prev->state == GUC_SET_LOCAL)
3719 discard_stack_value(gconf, &prev->masked);
3720 prev->state = GUC_SET;
3724 if (prev->state == GUC_SET)
3726 /* LOCAL migrates down */
3727 prev->masked = stack->prior;
3728 prev->state = GUC_SET_LOCAL;
3732 /* else just forget this stack level */
3733 discard_stack_value(gconf, &stack->prior);
3738 /* prior state at this level no longer wanted */
3739 discard_stack_value(gconf, &stack->prior);
3740 /* copy down the masked state */
3741 if (prev->state == GUC_SET_LOCAL)
3742 discard_stack_value(gconf, &prev->masked);
3743 prev->masked = stack->masked;
3744 prev->state = GUC_SET_LOCAL;
3751 if (restorePrior || restoreMasked)
3753 /* Perform appropriate restoration of the stacked value */
3754 union config_var_value newvalue;
3755 GucSource newsource;
3759 newvalue = stack->masked;
3760 newsource = PGC_S_SESSION;
3764 newvalue = stack->prior;
3765 newsource = stack->source;
3768 switch (gconf->vartype)
3772 struct config_bool *conf = (struct config_bool *) gconf;
3773 bool newval = newvalue.boolval;
3775 if (*conf->variable != newval)
3777 if (conf->assign_hook)
3778 if (!(*conf->assign_hook) (newval,
3779 true, PGC_S_OVERRIDE))
3780 elog(LOG, "failed to commit %s",
3782 *conf->variable = newval;
3789 struct config_int *conf = (struct config_int *) gconf;
3790 int newval = newvalue.intval;
3792 if (*conf->variable != newval)
3794 if (conf->assign_hook)
3795 if (!(*conf->assign_hook) (newval,
3796 true, PGC_S_OVERRIDE))
3797 elog(LOG, "failed to commit %s",
3799 *conf->variable = newval;
3806 struct config_real *conf = (struct config_real *) gconf;
3807 double newval = newvalue.realval;
3809 if (*conf->variable != newval)
3811 if (conf->assign_hook)
3812 if (!(*conf->assign_hook) (newval,
3813 true, PGC_S_OVERRIDE))
3814 elog(LOG, "failed to commit %s",
3816 *conf->variable = newval;
3823 struct config_string *conf = (struct config_string *) gconf;
3824 char *newval = newvalue.stringval;
3826 if (*conf->variable != newval)
3828 if (conf->assign_hook && newval)
3832 newstr = (*conf->assign_hook) (newval, true,
3835 elog(LOG, "failed to commit %s",
3837 else if (newstr != newval)
3840 * If newval should now be freed,
3841 * it'll be taken care of below.
3843 * See notes in set_config_option
3846 newval = (char *) newstr;
3850 set_string_field(conf, conf->variable, newval);
3855 * Release stacked values if not used anymore. We
3856 * could use discard_stack_value() here, but since
3857 * we have type-specific code anyway, might as
3860 set_string_field(conf, &stack->prior.stringval, NULL);
3861 set_string_field(conf, &stack->masked.stringval, NULL);
3866 struct config_enum *conf = (struct config_enum *) gconf;
3867 int newval = newvalue.enumval;
3869 if (*conf->variable != newval)
3871 if (conf->assign_hook)
3872 if (!(*conf->assign_hook) (newval,
3873 true, PGC_S_OVERRIDE))
3874 elog(LOG, "failed to commit %s",
3876 *conf->variable = newval;
3883 gconf->source = newsource;
3886 /* Finish popping the state stack */
3887 gconf->stack = prev;
3890 /* Report new value if we changed it */
3891 if (changed && (gconf->flags & GUC_REPORT))
3892 ReportGUCOption(gconf);
3893 } /* end of stack-popping loop */
3899 /* If there are no remaining stack entries, we can reset guc_dirty */
3900 guc_dirty = still_dirty;
3902 /* Update nesting level */
3903 GUCNestLevel = nestLevel - 1;
3908 * Start up automatic reporting of changes to variables marked GUC_REPORT.
3909 * This is executed at completion of backend startup.
3912 BeginReportingGUCOptions(void)
3917 * Don't do anything unless talking to an interactive frontend of protocol
3920 if (whereToSendOutput != DestRemote ||
3921 PG_PROTOCOL_MAJOR(FrontendProtocol) < 3)
3924 reporting_enabled = true;
3926 /* Transmit initial values of interesting variables */
3927 for (i = 0; i < num_guc_variables; i++)
3929 struct config_generic *conf = guc_variables[i];
3931 if (conf->flags & GUC_REPORT)
3932 ReportGUCOption(conf);
3937 * ReportGUCOption: if appropriate, transmit option value to frontend
3940 ReportGUCOption(struct config_generic * record)
3942 if (reporting_enabled && (record->flags & GUC_REPORT))
3944 char *val = _ShowOption(record, false);
3945 StringInfoData msgbuf;
3947 pq_beginmessage(&msgbuf, 'S');
3948 pq_sendstring(&msgbuf, record->name);
3949 pq_sendstring(&msgbuf, val);
3950 pq_endmessage(&msgbuf);
3958 * Try to interpret value as boolean value. Valid values are: true,
3959 * false, yes, no, on, off, 1, 0; as well as unique prefixes thereof.
3960 * If the string parses okay, return true, else false.
3961 * If okay and result is not NULL, return the value in *result.
3964 parse_bool(const char *value, bool *result)
3966 size_t len = strlen(value);
3968 if (pg_strncasecmp(value, "true", len) == 0)
3973 else if (pg_strncasecmp(value, "false", len) == 0)
3979 else if (pg_strncasecmp(value, "yes", len) == 0)
3984 else if (pg_strncasecmp(value, "no", len) == 0)
3990 /* 'o' is not unique enough */
3991 else if (pg_strncasecmp(value, "on", (len > 2 ? len : 2)) == 0)
3996 else if (pg_strncasecmp(value, "off", (len > 2 ? len : 2)) == 0)
4002 else if (pg_strcasecmp(value, "1") == 0)
4007 else if (pg_strcasecmp(value, "0") == 0)
4016 *result = false; /* suppress compiler warning */
4025 * Try to parse value as an integer. The accepted formats are the
4026 * usual decimal, octal, or hexadecimal formats, optionally followed by
4027 * a unit name if "flags" indicates a unit is allowed.
4029 * If the string parses okay, return true, else false.
4030 * If okay and result is not NULL, return the value in *result.
4031 * If not okay and hintmsg is not NULL, *hintmsg is set to a suitable
4032 * HINT message, or NULL if no hint provided.
4035 parse_int(const char *value, int *result, int flags, const char **hintmsg)
4040 /* To suppress compiler warnings, always set output params */
4046 /* We assume here that int64 is at least as wide as long */
4048 val = strtol(value, &endptr, 0);
4050 if (endptr == value)
4051 return false; /* no HINT for integer syntax error */
4053 if (errno == ERANGE || val != (int64) ((int32) val))
4056 *hintmsg = gettext_noop("Value exceeds integer range.");
4060 /* allow whitespace between integer and unit */
4061 while (isspace((unsigned char) *endptr))
4064 /* Handle possible unit */
4065 if (*endptr != '\0')
4068 * Note: the multiple-switch coding technique here is a bit tedious,
4069 * but seems necessary to avoid intermediate-value overflows.
4071 * If INT64_IS_BUSTED (ie, it's really int32) we will fail to detect
4072 * overflow due to units conversion, but there are few enough such
4073 * machines that it does not seem worth trying to be smarter.
4075 if (flags & GUC_UNIT_MEMORY)
4077 /* Set hint for use if no match or trailing garbage */
4079 *hintmsg = gettext_noop("Valid units for this parameter are \"kB\", \"MB\", and \"GB\".");
4081 #if BLCKSZ < 1024 || BLCKSZ > (1024*1024)
4082 #error BLCKSZ must be between 1KB and 1MB
4084 #if XLOG_BLCKSZ < 1024 || XLOG_BLCKSZ > (1024*1024)
4085 #error XLOG_BLCKSZ must be between 1KB and 1MB
4088 if (strncmp(endptr, "kB", 2) == 0)
4091 switch (flags & GUC_UNIT_MEMORY)
4093 case GUC_UNIT_BLOCKS:
4094 val /= (BLCKSZ / 1024);
4096 case GUC_UNIT_XBLOCKS:
4097 val /= (XLOG_BLCKSZ / 1024);
4101 else if (strncmp(endptr, "MB", 2) == 0)
4104 switch (flags & GUC_UNIT_MEMORY)
4109 case GUC_UNIT_BLOCKS:
4110 val *= KB_PER_MB / (BLCKSZ / 1024);
4112 case GUC_UNIT_XBLOCKS:
4113 val *= KB_PER_MB / (XLOG_BLCKSZ / 1024);
4117 else if (strncmp(endptr, "GB", 2) == 0)
4120 switch (flags & GUC_UNIT_MEMORY)
4125 case GUC_UNIT_BLOCKS:
4126 val *= KB_PER_GB / (BLCKSZ / 1024);
4128 case GUC_UNIT_XBLOCKS:
4129 val *= KB_PER_GB / (XLOG_BLCKSZ / 1024);
4134 else if (flags & GUC_UNIT_TIME)
4136 /* Set hint for use if no match or trailing garbage */
4138 *hintmsg = gettext_noop("Valid units for this parameter are \"ms\", \"s\", \"min\", \"h\", and \"d\".");
4140 if (strncmp(endptr, "ms", 2) == 0)
4143 switch (flags & GUC_UNIT_TIME)
4153 else if (strncmp(endptr, "s", 1) == 0)
4156 switch (flags & GUC_UNIT_TIME)
4166 else if (strncmp(endptr, "min", 3) == 0)
4169 switch (flags & GUC_UNIT_TIME)
4179 else if (strncmp(endptr, "h", 1) == 0)
4182 switch (flags & GUC_UNIT_TIME)
4195 else if (strncmp(endptr, "d", 1) == 0)
4198 switch (flags & GUC_UNIT_TIME)
4213 /* allow whitespace after unit */
4214 while (isspace((unsigned char) *endptr))
4217 if (*endptr != '\0')
4218 return false; /* appropriate hint, if any, already set */
4220 /* Check for overflow due to units conversion */
4221 if (val != (int64) ((int32) val))
4224 *hintmsg = gettext_noop("Value exceeds integer range.");
4230 *result = (int) val;
4237 * Try to parse value as a floating point number in the usual format.
4238 * If the string parses okay, return true, else false.
4239 * If okay and result is not NULL, return the value in *result.
4242 parse_real(const char *value, double *result)
4248 *result = 0; /* suppress compiler warning */
4251 val = strtod(value, &endptr);
4252 if (endptr == value || errno == ERANGE)
4255 /* allow whitespace after number */
4256 while (isspace((unsigned char) *endptr))
4258 if (*endptr != '\0')
4268 * Lookup the name for an enum option with the selected value.
4269 * Should only ever be called with known-valid values, so throws
4270 * an elog(ERROR) if the enum option is not found.
4272 * The returned string is a pointer to static data and not
4273 * allocated for modification.
4276 config_enum_lookup_by_value(struct config_enum *record, int val)
4278 const struct config_enum_entry *entry = record->options;
4279 while (entry && entry->name)
4281 if (entry->val == val)
4285 elog(ERROR, "could not find enum option %d for %s",
4286 val, record->gen.name);
4287 return NULL; /* silence compiler */
4292 * Lookup the value for an enum option with the selected name
4293 * (case-insensitive).
4294 * If the enum option is found, sets the retval value and returns
4295 * true. If it's not found, return FALSE and retval is set to 0.
4299 config_enum_lookup_by_name(struct config_enum *record, const char *value, int *retval)
4301 const struct config_enum_entry *entry = record->options;
4304 *retval = 0; /* suppress compiler warning */
4306 while (entry && entry->name)
4308 if (pg_strcasecmp(value, entry->name) == 0)
4310 *retval = entry->val;
4320 * Return a list of all available options for an enum, separated
4321 * by ", " (comma-space).
4322 * If prefix is non-NULL, it is added before the first enum value.
4323 * If suffix is non-NULL, it is added to the end of the string.
4326 config_enum_get_options(struct config_enum *record, const char *prefix, const char *suffix)
4328 const struct config_enum_entry *entry = record->options;
4332 if (!entry || !entry->name)
4333 return NULL; /* Should not happen */
4335 while (entry && entry->name)
4337 len += strlen(entry->name) + 2; /* string and ", " */
4341 hintmsg = palloc(len + strlen(prefix) + strlen(suffix) + 2);
4343 strcpy(hintmsg, prefix);
4345 entry = record->options;
4346 while (entry && entry->name)
4348 strcat(hintmsg, entry->name);
4349 strcat(hintmsg, ", ");
4353 /* Replace final comma/space */
4354 hintmsg[strlen(hintmsg)-2] = '\0';
4355 strcat(hintmsg, suffix);
4362 * Call a GucStringAssignHook function, being careful to free the
4363 * "newval" string if the hook ereports.
4365 * This is split out of set_config_option just to avoid the "volatile"
4366 * qualifiers that would otherwise have to be plastered all over.
4369 call_string_assign_hook(GucStringAssignHook assign_hook,
4370 char *newval, bool doit, GucSource source)
4376 result = (*assign_hook) (newval, doit, source);
4390 * Sets option `name' to given value. The value should be a string
4391 * which is going to be parsed and converted to the appropriate data
4392 * type. The context and source parameters indicate in which context this
4393 * function is being called so it can apply the access restrictions
4396 * If value is NULL, set the option to its default value (normally the
4397 * reset_val, but if source == PGC_S_DEFAULT we instead use the boot_val).
4399 * action indicates whether to set the value globally in the session, locally
4400 * to the current top transaction, or just for the duration of a function call.
4402 * If changeVal is false then don't really set the option but do all
4403 * the checks to see if it would work.
4405 * If there is an error (non-existing option, invalid value) then an
4406 * ereport(ERROR) is thrown *unless* this is called in a context where we
4407 * don't want to ereport (currently, startup or SIGHUP config file reread).
4408 * In that case we write a suitable error message via ereport(LOG) and
4409 * return false. This is working around the deficiencies in the ereport
4410 * mechanism, so don't blame me. In all other cases, the function
4411 * returns true, including cases where the input is valid but we chose
4412 * not to apply it because of context or source-priority considerations.
4414 * See also SetConfigOption for an external interface.
4417 set_config_option(const char *name, const char *value,
4418 GucContext context, GucSource source,
4419 GucAction action, bool changeVal)
4421 struct config_generic *record;
4425 if (context == PGC_SIGHUP || source == PGC_S_DEFAULT)
4428 * To avoid cluttering the log, only the postmaster bleats loudly
4429 * about problems with the config file.
4431 elevel = IsUnderPostmaster ? DEBUG3 : LOG;
4433 else if (source == PGC_S_DATABASE || source == PGC_S_USER)
4438 record = find_option(name, true, elevel);
4442 (errcode(ERRCODE_UNDEFINED_OBJECT),
4443 errmsg("unrecognized configuration parameter \"%s\"", name)));
4448 * If source is postgresql.conf, mark the found record with
4449 * GUC_IS_IN_FILE. This is for the convenience of ProcessConfigFile. Note
4450 * that we do it even if changeVal is false, since ProcessConfigFile wants
4451 * the marking to occur during its testing pass.
4453 if (source == PGC_S_FILE)
4454 record->status |= GUC_IS_IN_FILE;
4457 * Check if the option can be set at this time. See guc.h for the precise
4458 * rules. Note that we don't want to throw errors if we're in the SIGHUP
4459 * context. In that case we just ignore the attempt and return true.
4461 switch (record->context)
4464 if (context == PGC_SIGHUP)
4466 if (context != PGC_INTERNAL)
4469 (errcode(ERRCODE_CANT_CHANGE_RUNTIME_PARAM),
4470 errmsg("parameter \"%s\" cannot be changed",
4475 case PGC_POSTMASTER:
4476 if (context == PGC_SIGHUP)
4479 * We are reading a PGC_POSTMASTER var from postgresql.conf.
4480 * We can't change the setting, so give a warning if the DBA
4481 * tries to change it. (Throwing an error would be more
4482 * consistent, but seems overly rigid.)
4484 if (changeVal && !is_newvalue_equal(record, value))
4486 (errcode(ERRCODE_CANT_CHANGE_RUNTIME_PARAM),
4487 errmsg("parameter \"%s\" cannot be changed after server start; configuration file change ignored",
4491 if (context != PGC_POSTMASTER)
4494 (errcode(ERRCODE_CANT_CHANGE_RUNTIME_PARAM),
4495 errmsg("parameter \"%s\" cannot be changed after server start",
4501 if (context != PGC_SIGHUP && context != PGC_POSTMASTER)
4504 (errcode(ERRCODE_CANT_CHANGE_RUNTIME_PARAM),
4505 errmsg("parameter \"%s\" cannot be changed now",
4511 * Hmm, the idea of the SIGHUP context is "ought to be global, but
4512 * can be changed after postmaster start". But there's nothing
4513 * that prevents a crafty administrator from sending SIGHUP
4514 * signals to individual backends only.
4518 if (context == PGC_SIGHUP)
4521 * If a PGC_BACKEND parameter is changed in the config file,
4522 * we want to accept the new value in the postmaster (whence
4523 * it will propagate to subsequently-started backends), but
4524 * ignore it in existing backends. This is a tad klugy, but
4525 * necessary because we don't re-read the config file during
4528 if (IsUnderPostmaster)
4531 else if (context != PGC_BACKEND && context != PGC_POSTMASTER)
4534 (errcode(ERRCODE_CANT_CHANGE_RUNTIME_PARAM),
4535 errmsg("parameter \"%s\" cannot be set after connection start",
4541 if (context == PGC_USERSET || context == PGC_BACKEND)
4544 (errcode(ERRCODE_INSUFFICIENT_PRIVILEGE),
4545 errmsg("permission denied to set parameter \"%s\"",
4556 * Should we set reset/stacked values? (If so, the behavior is not
4557 * transactional.) This is done either when we get a default value from
4558 * the database's/user's/client's default settings or when we reset a
4559 * value to its default.
4561 makeDefault = changeVal && (source <= PGC_S_OVERRIDE) &&
4562 ((value != NULL) || source == PGC_S_DEFAULT);
4565 * Ignore attempted set if overridden by previously processed setting.
4566 * However, if changeVal is false then plow ahead anyway since we are
4567 * trying to find out if the value is potentially good, not actually use
4568 * it. Also keep going if makeDefault is true, since we may want to set
4569 * the reset/stacked values even if we can't set the variable itself.
4571 if (record->source > source)
4573 if (changeVal && !makeDefault)
4575 elog(DEBUG3, "\"%s\": setting ignored because previous source is higher priority",
4583 * Evaluate value and set variable.
4585 switch (record->vartype)
4589 struct config_bool *conf = (struct config_bool *) record;
4594 if (!parse_bool(value, &newval))
4597 (errcode(ERRCODE_INVALID_PARAMETER_VALUE),
4598 errmsg("parameter \"%s\" requires a Boolean value",
4603 else if (source == PGC_S_DEFAULT)
4604 newval = conf->boot_val;
4607 newval = conf->reset_val;
4608 source = conf->gen.reset_source;
4611 if (conf->assign_hook)
4612 if (!(*conf->assign_hook) (newval, changeVal, source))
4615 (errcode(ERRCODE_INVALID_PARAMETER_VALUE),
4616 errmsg("invalid value for parameter \"%s\": %d",
4617 name, (int) newval)));
4621 if (changeVal || makeDefault)
4623 /* Save old value to support transaction abort */
4625 push_old_value(&conf->gen, action);
4628 *conf->variable = newval;
4629 conf->gen.source = source;
4635 if (conf->gen.reset_source <= source)
4637 conf->reset_val = newval;
4638 conf->gen.reset_source = source;
4640 for (stack = conf->gen.stack; stack; stack = stack->prev)
4642 if (stack->source <= source)
4644 stack->prior.boolval = newval;
4645 stack->source = source;
4655 struct config_int *conf = (struct config_int *) record;
4660 const char *hintmsg;
4662 if (!parse_int(value, &newval, conf->gen.flags, &hintmsg))
4665 (errcode(ERRCODE_INVALID_PARAMETER_VALUE),
4666 errmsg("invalid value for parameter \"%s\": \"%s\"",
4668 hintmsg ? errhint(hintmsg) : 0));
4671 if (newval < conf->min || newval > conf->max)
4674 (errcode(ERRCODE_INVALID_PARAMETER_VALUE),
4675 errmsg("%d is outside the valid range for parameter \"%s\" (%d .. %d)",
4676 newval, name, conf->min, conf->max)));
4680 else if (source == PGC_S_DEFAULT)
4681 newval = conf->boot_val;
4684 newval = conf->reset_val;
4685 source = conf->gen.reset_source;
4688 if (conf->assign_hook)
4689 if (!(*conf->assign_hook) (newval, changeVal, source))
4692 (errcode(ERRCODE_INVALID_PARAMETER_VALUE),
4693 errmsg("invalid value for parameter \"%s\": %d",
4698 if (changeVal || makeDefault)
4700 /* Save old value to support transaction abort */
4702 push_old_value(&conf->gen, action);
4705 *conf->variable = newval;
4706 conf->gen.source = source;
4712 if (conf->gen.reset_source <= source)
4714 conf->reset_val = newval;
4715 conf->gen.reset_source = source;
4717 for (stack = conf->gen.stack; stack; stack = stack->prev)
4719 if (stack->source <= source)
4721 stack->prior.intval = newval;
4722 stack->source = source;
4732 struct config_real *conf = (struct config_real *) record;
4737 if (!parse_real(value, &newval))
4740 (errcode(ERRCODE_INVALID_PARAMETER_VALUE),
4741 errmsg("parameter \"%s\" requires a numeric value",
4745 if (newval < conf->min || newval > conf->max)
4748 (errcode(ERRCODE_INVALID_PARAMETER_VALUE),
4749 errmsg("%g is outside the valid range for parameter \"%s\" (%g .. %g)",
4750 newval, name, conf->min, conf->max)));
4754 else if (source == PGC_S_DEFAULT)
4755 newval = conf->boot_val;
4758 newval = conf->reset_val;
4759 source = conf->gen.reset_source;
4762 if (conf->assign_hook)
4763 if (!(*conf->assign_hook) (newval, changeVal, source))
4766 (errcode(ERRCODE_INVALID_PARAMETER_VALUE),
4767 errmsg("invalid value for parameter \"%s\": %g",
4772 if (changeVal || makeDefault)
4774 /* Save old value to support transaction abort */
4776 push_old_value(&conf->gen, action);
4779 *conf->variable = newval;
4780 conf->gen.source = source;
4786 if (conf->gen.reset_source <= source)
4788 conf->reset_val = newval;
4789 conf->gen.reset_source = source;
4791 for (stack = conf->gen.stack; stack; stack = stack->prev)
4793 if (stack->source <= source)
4795 stack->prior.realval = newval;
4796 stack->source = source;
4806 struct config_string *conf = (struct config_string *) record;
4811 newval = guc_strdup(elevel, value);
4816 * The only sort of "parsing" check we need to do is apply
4817 * truncation if GUC_IS_NAME.
4819 if (conf->gen.flags & GUC_IS_NAME)
4820 truncate_identifier(newval, strlen(newval), true);
4822 else if (source == PGC_S_DEFAULT)
4824 if (conf->boot_val == NULL)
4828 newval = guc_strdup(elevel, conf->boot_val);
4836 * We could possibly avoid strdup here, but easier to make
4837 * this case work the same as the normal assignment case;
4838 * note the possible free of newval below.
4840 if (conf->reset_val == NULL)
4844 newval = guc_strdup(elevel, conf->reset_val);
4848 source = conf->gen.reset_source;
4851 if (conf->assign_hook && newval)
4853 const char *hookresult;
4856 * If the hook ereports, we have to make sure we free
4857 * newval, else it will be a permanent memory leak.
4859 hookresult = call_string_assign_hook(conf->assign_hook,
4863 if (hookresult == NULL)
4867 (errcode(ERRCODE_INVALID_PARAMETER_VALUE),
4868 errmsg("invalid value for parameter \"%s\": \"%s\"",
4869 name, value ? value : "")));
4872 else if (hookresult != newval)
4877 * Having to cast away const here is annoying, but the
4878 * alternative is to declare assign_hooks as returning
4879 * char*, which would mean they'd have to cast away
4880 * const, or as both taking and returning char*, which
4881 * doesn't seem attractive either --- we don't want
4882 * them to scribble on the passed str.
4884 newval = (char *) hookresult;
4888 if (changeVal || makeDefault)
4890 /* Save old value to support transaction abort */
4892 push_old_value(&conf->gen, action);
4895 set_string_field(conf, conf->variable, newval);
4896 conf->gen.source = source;
4902 if (conf->gen.reset_source <= source)
4904 set_string_field(conf, &conf->reset_val, newval);
4905 conf->gen.reset_source = source;
4907 for (stack = conf->gen.stack; stack; stack = stack->prev)
4909 if (stack->source <= source)
4911 set_string_field(conf, &stack->prior.stringval,
4913 stack->source = source;
4916 /* Perhaps we didn't install newval anywhere */
4917 if (newval && !string_field_used(conf, newval))
4927 struct config_enum *conf = (struct config_enum *) record;
4932 if (!config_enum_lookup_by_name(conf, value, &newval))
4934 char *hintmsg = config_enum_get_options(conf, "Available values: ", ".");
4937 (errcode(ERRCODE_INVALID_PARAMETER_VALUE),
4938 errmsg("invalid value for parameter \"%s\": \"%s\"",
4940 hintmsg ? errhint(hintmsg) : 0));
4947 else if (source == PGC_S_DEFAULT)
4948 newval = conf->boot_val;
4951 newval = conf->reset_val;
4952 source = conf->gen.reset_source;
4955 if (conf->assign_hook)
4956 if (!(*conf->assign_hook) (newval, changeVal, source))
4959 (errcode(ERRCODE_INVALID_PARAMETER_VALUE),
4960 errmsg("invalid value for parameter \"%s\": \"%s\"",
4962 config_enum_lookup_by_value(conf, newval))));
4966 if (changeVal || makeDefault)
4968 /* Save old value to support transaction abort */
4970 push_old_value(&conf->gen, action);
4973 *conf->variable = newval;
4974 conf->gen.source = source;
4980 if (conf->gen.reset_source <= source)
4982 conf->reset_val = newval;
4983 conf->gen.reset_source = source;
4985 for (stack = conf->gen.stack; stack; stack = stack->prev)
4987 if (stack->source <= source)
4989 stack->prior.enumval = newval;
4990 stack->source = source;
4999 if (changeVal && (record->flags & GUC_REPORT))
5000 ReportGUCOption(record);
5007 * Set a config option to the given value. See also set_config_option,
5008 * this is just the wrapper to be called from outside GUC. NB: this
5009 * is used only for non-transactional operations.
5012 SetConfigOption(const char *name, const char *value,
5013 GucContext context, GucSource source)
5015 (void) set_config_option(name, value, context, source,
5016 GUC_ACTION_SET, true);
5022 * Fetch the current value of the option `name'. If the option doesn't exist,
5023 * throw an ereport and don't return.
5025 * The string is *not* allocated for modification and is really only
5026 * valid until the next call to configuration related functions.
5029 GetConfigOption(const char *name)
5031 struct config_generic *record;
5032 static char buffer[256];
5034 record = find_option(name, false, ERROR);
5037 (errcode(ERRCODE_UNDEFINED_OBJECT),
5038 errmsg("unrecognized configuration parameter \"%s\"", name)));
5039 if ((record->flags & GUC_SUPERUSER_ONLY) && !superuser())
5041 (errcode(ERRCODE_INSUFFICIENT_PRIVILEGE),
5042 errmsg("must be superuser to examine \"%s\"", name)));
5044 switch (record->vartype)
5047 return *((struct config_bool *) record)->variable ? "on" : "off";
5050 snprintf(buffer, sizeof(buffer), "%d",
5051 *((struct config_int *) record)->variable);
5055 snprintf(buffer, sizeof(buffer), "%g",
5056 *((struct config_real *) record)->variable);
5060 return *((struct config_string *) record)->variable;
5063 return config_enum_lookup_by_value((struct config_enum *) record,
5064 *((struct config_enum *) record)->variable);
5070 * Get the RESET value associated with the given option.
5072 * Note: this is not re-entrant, due to use of static result buffer;
5073 * not to mention that a string variable could have its reset_val changed.
5074 * Beware of assuming the result value is good for very long.
5077 GetConfigOptionResetString(const char *name)
5079 struct config_generic *record;
5080 static char buffer[256];
5082 record = find_option(name, false, ERROR);
5085 (errcode(ERRCODE_UNDEFINED_OBJECT),
5086 errmsg("unrecognized configuration parameter \"%s\"", name)));
5087 if ((record->flags & GUC_SUPERUSER_ONLY) && !superuser())
5089 (errcode(ERRCODE_INSUFFICIENT_PRIVILEGE),
5090 errmsg("must be superuser to examine \"%s\"", name)));
5092 switch (record->vartype)
5095 return ((struct config_bool *) record)->reset_val ? "on" : "off";
5098 snprintf(buffer, sizeof(buffer), "%d",
5099 ((struct config_int *) record)->reset_val);
5103 snprintf(buffer, sizeof(buffer), "%g",
5104 ((struct config_real *) record)->reset_val);
5108 return ((struct config_string *) record)->reset_val;
5111 return config_enum_lookup_by_value((struct config_enum *) record,
5112 ((struct config_enum *) record)->reset_val);
5118 * Detect whether the given configuration option can only be set by
5122 IsSuperuserConfigOption(const char *name)
5124 struct config_generic *record;
5126 record = find_option(name, false, ERROR);
5127 /* On an unrecognized name, don't error, just return false. */
5130 return (record->context == PGC_SUSET);
5135 * GUC_complaint_elevel
5136 * Get the ereport error level to use in an assign_hook's error report.
5138 * This should be used by assign hooks that want to emit a custom error
5139 * report (in addition to the generic "invalid value for option FOO" that
5140 * guc.c will provide). Note that the result might be ERROR or a lower
5141 * level, so the caller must be prepared for control to return from ereport,
5142 * or not. If control does return, return false/NULL from the hook function.
5144 * At some point it'd be nice to replace this with a mechanism that allows
5145 * the custom message to become the DETAIL line of guc.c's generic message.
5148 GUC_complaint_elevel(GucSource source)
5152 if (source == PGC_S_FILE)
5155 * To avoid cluttering the log, only the postmaster bleats loudly
5156 * about problems with the config file.
5158 elevel = IsUnderPostmaster ? DEBUG3 : LOG;
5160 else if (source == PGC_S_OVERRIDE)
5163 * If we're a postmaster child, this is probably "undo" during
5164 * transaction abort, so we don't want to clutter the log. There's
5165 * a small chance of a real problem with an OVERRIDE setting,
5166 * though, so suppressing the message entirely wouldn't be desirable.
5168 elevel = IsUnderPostmaster ? DEBUG5 : LOG;
5170 else if (source < PGC_S_INTERACTIVE)
5180 * flatten_set_variable_args
5181 * Given a parsenode List as emitted by the grammar for SET,
5182 * convert to the flat string representation used by GUC.
5184 * We need to be told the name of the variable the args are for, because
5185 * the flattening rules vary (ugh).
5187 * The result is NULL if args is NIL (ie, SET ... TO DEFAULT), otherwise
5188 * a palloc'd string.
5191 flatten_set_variable_args(const char *name, List *args)
5193 struct config_generic *record;
5198 /* Fast path if just DEFAULT */
5202 /* Else get flags for the variable */
5203 record = find_option(name, true, ERROR);
5206 (errcode(ERRCODE_UNDEFINED_OBJECT),
5207 errmsg("unrecognized configuration parameter \"%s\"", name)));
5209 flags = record->flags;
5211 /* Complain if list input and non-list variable */
5212 if ((flags & GUC_LIST_INPUT) == 0 &&
5213 list_length(args) != 1)
5215 (errcode(ERRCODE_INVALID_PARAMETER_VALUE),
5216 errmsg("SET %s takes only one argument", name)));
5218 initStringInfo(&buf);
5221 * Each list member may be a plain A_Const node, or an A_Const within a
5222 * TypeCast; the latter case is supported only for ConstInterval
5223 * arguments (for SET TIME ZONE).
5227 Node *arg = (Node *) lfirst(l);
5229 TypeName *typename = NULL;
5232 if (l != list_head(args))
5233 appendStringInfo(&buf, ", ");
5235 if (IsA(arg, TypeCast))
5237 TypeCast *tc = (TypeCast *) arg;
5240 typename = tc->typename;
5243 if (!IsA(arg, A_Const))
5244 elog(ERROR, "unrecognized node type: %d", (int) nodeTag(arg));
5245 con = (A_Const *) arg;
5247 switch (nodeTag(&con->val))
5250 appendStringInfo(&buf, "%ld", intVal(&con->val));
5253 /* represented as a string, so just copy it */
5254 appendStringInfoString(&buf, strVal(&con->val));
5257 val = strVal(&con->val);
5258 if (typename != NULL)
5261 * Must be a ConstInterval argument for TIME ZONE. Coerce
5262 * to interval and back to normalize the value and account
5270 typoid = typenameTypeId(NULL, typename, &typmod);
5271 Assert(typoid == INTERVALOID);
5274 DirectFunctionCall3(interval_in,
5275 CStringGetDatum(val),
5276 ObjectIdGetDatum(InvalidOid),
5277 Int32GetDatum(typmod));
5280 DatumGetCString(DirectFunctionCall1(interval_out,
5282 appendStringInfo(&buf, "INTERVAL '%s'", intervalout);
5287 * Plain string literal or identifier. For quote mode,
5288 * quote it if it's not a vanilla identifier.
5290 if (flags & GUC_LIST_QUOTE)
5291 appendStringInfoString(&buf, quote_identifier(val));
5293 appendStringInfoString(&buf, val);
5297 elog(ERROR, "unrecognized node type: %d",
5298 (int) nodeTag(&con->val));
5311 ExecSetVariableStmt(VariableSetStmt *stmt)
5313 GucAction action = stmt->is_local ? GUC_ACTION_LOCAL : GUC_ACTION_SET;
5318 case VAR_SET_CURRENT:
5319 set_config_option(stmt->name,
5320 ExtractSetVariableArgs(stmt),
5321 (superuser() ? PGC_SUSET : PGC_USERSET),
5329 * Special case for special SQL syntax that effectively sets more
5330 * than one variable per statement.
5332 if (strcmp(stmt->name, "TRANSACTION") == 0)
5336 foreach(head, stmt->args)
5338 DefElem *item = (DefElem *) lfirst(head);
5340 if (strcmp(item->defname, "transaction_isolation") == 0)
5341 SetPGVariable("transaction_isolation",
5342 list_make1(item->arg), stmt->is_local);
5343 else if (strcmp(item->defname, "transaction_read_only") == 0)
5344 SetPGVariable("transaction_read_only",
5345 list_make1(item->arg), stmt->is_local);
5347 elog(ERROR, "unexpected SET TRANSACTION element: %s",
5351 else if (strcmp(stmt->name, "SESSION CHARACTERISTICS") == 0)
5355 foreach(head, stmt->args)
5357 DefElem *item = (DefElem *) lfirst(head);
5359 if (strcmp(item->defname, "transaction_isolation") == 0)
5360 SetPGVariable("default_transaction_isolation",
5361 list_make1(item->arg), stmt->is_local);
5362 else if (strcmp(item->defname, "transaction_read_only") == 0)
5363 SetPGVariable("default_transaction_read_only",
5364 list_make1(item->arg), stmt->is_local);
5366 elog(ERROR, "unexpected SET SESSION element: %s",
5371 elog(ERROR, "unexpected SET MULTI element: %s",
5374 case VAR_SET_DEFAULT:
5376 set_config_option(stmt->name,
5378 (superuser() ? PGC_SUSET : PGC_USERSET),
5390 * Get the value to assign for a VariableSetStmt, or NULL if it's RESET.
5391 * The result is palloc'd.
5393 * This is exported for use by actions such as ALTER ROLE SET.
5396 ExtractSetVariableArgs(VariableSetStmt *stmt)
5401 return flatten_set_variable_args(stmt->name, stmt->args);
5402 case VAR_SET_CURRENT:
5403 return GetConfigOptionByName(stmt->name, NULL);
5410 * SetPGVariable - SET command exported as an easily-C-callable function.
5412 * This provides access to SET TO value, as well as SET TO DEFAULT (expressed
5413 * by passing args == NIL), but not SET FROM CURRENT functionality.
5416 SetPGVariable(const char *name, List *args, bool is_local)
5418 char *argstring = flatten_set_variable_args(name, args);
5420 /* Note SET DEFAULT (argstring == NULL) is equivalent to RESET */
5421 set_config_option(name,
5423 (superuser() ? PGC_SUSET : PGC_USERSET),
5425 is_local ? GUC_ACTION_LOCAL : GUC_ACTION_SET,
5430 * SET command wrapped as a SQL callable function.
5433 set_config_by_name(PG_FUNCTION_ARGS)
5440 if (PG_ARGISNULL(0))
5442 (errcode(ERRCODE_NULL_VALUE_NOT_ALLOWED),
5443 errmsg("SET requires parameter name")));
5445 /* Get the GUC variable name */
5446 name = TextDatumGetCString(PG_GETARG_DATUM(0));
5448 /* Get the desired value or set to NULL for a reset request */
5449 if (PG_ARGISNULL(1))
5452 value = TextDatumGetCString(PG_GETARG_DATUM(1));
5455 * Get the desired state of is_local. Default to false if provided value
5458 if (PG_ARGISNULL(2))
5461 is_local = PG_GETARG_BOOL(2);
5463 /* Note SET DEFAULT (argstring == NULL) is equivalent to RESET */
5464 set_config_option(name,
5466 (superuser() ? PGC_SUSET : PGC_USERSET),
5468 is_local ? GUC_ACTION_LOCAL : GUC_ACTION_SET,
5471 /* get the new current value */
5472 new_value = GetConfigOptionByName(name, NULL);
5474 /* Convert return string to text */
5475 PG_RETURN_TEXT_P(cstring_to_text(new_value));
5480 * Common code for DefineCustomXXXVariable subroutines: allocate the
5481 * new variable's config struct and fill in generic fields.
5483 static struct config_generic *
5484 init_custom_variable(const char *name,
5485 const char *short_desc,
5486 const char *long_desc,
5488 enum config_type type,
5491 struct config_generic *gen;
5493 gen = (struct config_generic *) guc_malloc(ERROR, sz);
5496 gen->name = guc_strdup(ERROR, name);
5497 gen->context = context;
5498 gen->group = CUSTOM_OPTIONS;
5499 gen->short_desc = short_desc;
5500 gen->long_desc = long_desc;
5501 gen->vartype = type;
5507 * Common code for DefineCustomXXXVariable subroutines: insert the new
5508 * variable into the GUC variable array, replacing any placeholder.
5511 define_custom_variable(struct config_generic * variable)
5513 const char *name = variable->name;
5514 const char **nameAddr = &name;
5516 struct config_string *pHolder;
5517 struct config_generic **res;
5519 res = (struct config_generic **) bsearch((void *) &nameAddr,
5520 (void *) guc_variables,
5522 sizeof(struct config_generic *),
5526 /* No placeholder to replace, so just add it */
5527 add_guc_variable(variable, ERROR);
5532 * This better be a placeholder
5534 if (((*res)->flags & GUC_CUSTOM_PLACEHOLDER) == 0)
5536 (errcode(ERRCODE_INTERNAL_ERROR),
5537 errmsg("attempt to redefine parameter \"%s\"", name)));
5539 Assert((*res)->vartype == PGC_STRING);
5540 pHolder = (struct config_string *) (*res);
5543 * Replace the placeholder. We aren't changing the name, so no re-sorting
5549 * Assign the string value stored in the placeholder to the real variable.
5551 * XXX this is not really good enough --- it should be a nontransactional
5552 * assignment, since we don't want it to roll back if the current xact
5555 value = *pHolder->variable;
5558 set_config_option(name, value,
5559 pHolder->gen.context, pHolder->gen.source,
5560 GUC_ACTION_SET, true);
5563 * Free up as much as we conveniently can of the placeholder structure
5564 * (this neglects any stack items...)
5566 set_string_field(pHolder, pHolder->variable, NULL);
5567 set_string_field(pHolder, &pHolder->reset_val, NULL);
5573 DefineCustomBoolVariable(const char *name,
5574 const char *short_desc,
5575 const char *long_desc,
5578 GucBoolAssignHook assign_hook,
5579 GucShowHook show_hook)
5581 struct config_bool *var;
5583 var = (struct config_bool *)
5584 init_custom_variable(name, short_desc, long_desc, context,
5585 PGC_BOOL, sizeof(struct config_bool));
5586 var->variable = valueAddr;
5587 var->boot_val = *valueAddr;
5588 var->reset_val = *valueAddr;
5589 var->assign_hook = assign_hook;
5590 var->show_hook = show_hook;
5591 define_custom_variable(&var->gen);
5595 DefineCustomIntVariable(const char *name,
5596 const char *short_desc,
5597 const char *long_desc,
5602 GucIntAssignHook assign_hook,
5603 GucShowHook show_hook)
5605 struct config_int *var;
5607 var = (struct config_int *)
5608 init_custom_variable(name, short_desc, long_desc, context,
5609 PGC_INT, sizeof(struct config_int));
5610 var->variable = valueAddr;
5611 var->boot_val = *valueAddr;
5612 var->reset_val = *valueAddr;
5613 var->min = minValue;
5614 var->max = maxValue;
5615 var->assign_hook = assign_hook;
5616 var->show_hook = show_hook;
5617 define_custom_variable(&var->gen);
5621 DefineCustomRealVariable(const char *name,
5622 const char *short_desc,
5623 const char *long_desc,
5628 GucRealAssignHook assign_hook,
5629 GucShowHook show_hook)
5631 struct config_real *var;
5633 var = (struct config_real *)
5634 init_custom_variable(name, short_desc, long_desc, context,
5635 PGC_REAL, sizeof(struct config_real));
5636 var->variable = valueAddr;
5637 var->boot_val = *valueAddr;
5638 var->reset_val = *valueAddr;
5639 var->min = minValue;
5640 var->max = maxValue;
5641 var->assign_hook = assign_hook;
5642 var->show_hook = show_hook;
5643 define_custom_variable(&var->gen);
5647 DefineCustomStringVariable(const char *name,
5648 const char *short_desc,
5649 const char *long_desc,
5652 GucStringAssignHook assign_hook,
5653 GucShowHook show_hook)
5655 struct config_string *var;
5657 var = (struct config_string *)
5658 init_custom_variable(name, short_desc, long_desc, context,
5659 PGC_STRING, sizeof(struct config_string));
5660 var->variable = valueAddr;
5661 var->boot_val = *valueAddr;
5662 /* we could probably do without strdup, but keep it like normal case */
5664 var->reset_val = guc_strdup(ERROR, var->boot_val);
5665 var->assign_hook = assign_hook;
5666 var->show_hook = show_hook;
5667 define_custom_variable(&var->gen);
5671 DefineCustomEnumVariable(const char *name,
5672 const char *short_desc,
5673 const char *long_desc,
5675 const struct config_enum_entry *options,
5677 GucEnumAssignHook assign_hook,
5678 GucShowHook show_hook)
5680 struct config_enum *var;
5682 var = (struct config_enum *)
5683 init_custom_variable(name, short_desc, long_desc, context,
5684 PGC_ENUM, sizeof(struct config_enum));
5685 var->variable = valueAddr;
5686 var->boot_val = *valueAddr;
5687 var->reset_val = *valueAddr;
5688 var->options = options;
5689 var->assign_hook = assign_hook;
5690 var->show_hook = show_hook;
5691 define_custom_variable(&var->gen);
5695 EmitWarningsOnPlaceholders(const char *className)
5697 struct config_generic **vars = guc_variables;
5698 struct config_generic **last = vars + num_guc_variables;
5700 int nameLen = strlen(className);
5704 struct config_generic *var = *vars++;
5706 if ((var->flags & GUC_CUSTOM_PLACEHOLDER) != 0 &&
5707 strncmp(className, var->name, nameLen) == 0 &&
5708 var->name[nameLen] == GUC_QUALIFIER_SEPARATOR)
5711 (errcode(ERRCODE_UNDEFINED_OBJECT),
5712 errmsg("unrecognized configuration parameter \"%s\"", var->name)));
5722 GetPGVariable(const char *name, DestReceiver *dest)
5724 if (guc_name_compare(name, "all") == 0)
5725 ShowAllGUCConfig(dest);
5727 ShowGUCConfigOption(name, dest);
5731 GetPGVariableResultDesc(const char *name)
5735 if (guc_name_compare(name, "all") == 0)
5737 /* need a tuple descriptor representing three TEXT columns */
5738 tupdesc = CreateTemplateTupleDesc(3, false);
5739 TupleDescInitEntry(tupdesc, (AttrNumber) 1, "name",
5741 TupleDescInitEntry(tupdesc, (AttrNumber) 2, "setting",
5743 TupleDescInitEntry(tupdesc, (AttrNumber) 3, "description",
5749 const char *varname;
5751 /* Get the canonical spelling of name */
5752 (void) GetConfigOptionByName(name, &varname);
5754 /* need a tuple descriptor representing a single TEXT column */
5755 tupdesc = CreateTemplateTupleDesc(1, false);
5756 TupleDescInitEntry(tupdesc, (AttrNumber) 1, varname,
5767 ShowGUCConfigOption(const char *name, DestReceiver *dest)
5769 TupOutputState *tstate;
5771 const char *varname;
5774 /* Get the value and canonical spelling of name */
5775 value = GetConfigOptionByName(name, &varname);
5777 /* need a tuple descriptor representing a single TEXT column */
5778 tupdesc = CreateTemplateTupleDesc(1, false);
5779 TupleDescInitEntry(tupdesc, (AttrNumber) 1, varname,
5782 /* prepare for projection of tuples */
5783 tstate = begin_tup_output_tupdesc(dest, tupdesc);
5786 do_text_output_oneline(tstate, value);
5788 end_tup_output(tstate);
5795 ShowAllGUCConfig(DestReceiver *dest)
5797 bool am_superuser = superuser();
5799 TupOutputState *tstate;
5803 /* need a tuple descriptor representing three TEXT columns */
5804 tupdesc = CreateTemplateTupleDesc(3, false);
5805 TupleDescInitEntry(tupdesc, (AttrNumber) 1, "name",
5807 TupleDescInitEntry(tupdesc, (AttrNumber) 2, "setting",
5809 TupleDescInitEntry(tupdesc, (AttrNumber) 3, "description",
5813 /* prepare for projection of tuples */
5814 tstate = begin_tup_output_tupdesc(dest, tupdesc);
5816 for (i = 0; i < num_guc_variables; i++)
5818 struct config_generic *conf = guc_variables[i];
5820 if ((conf->flags & GUC_NO_SHOW_ALL) ||
5821 ((conf->flags & GUC_SUPERUSER_ONLY) && !am_superuser))
5824 /* assign to the values array */
5825 values[0] = (char *) conf->name;
5826 values[1] = _ShowOption(conf, true);
5827 values[2] = (char *) conf->short_desc;
5829 /* send it to dest */
5830 do_tup_output(tstate, values);
5833 if (values[1] != NULL)
5837 end_tup_output(tstate);
5841 * Return GUC variable value by name; optionally return canonical
5842 * form of name. Return value is palloc'd.
5845 GetConfigOptionByName(const char *name, const char **varname)
5847 struct config_generic *record;
5849 record = find_option(name, false, ERROR);
5852 (errcode(ERRCODE_UNDEFINED_OBJECT),
5853 errmsg("unrecognized configuration parameter \"%s\"", name)));
5854 if ((record->flags & GUC_SUPERUSER_ONLY) && !superuser())
5856 (errcode(ERRCODE_INSUFFICIENT_PRIVILEGE),
5857 errmsg("must be superuser to examine \"%s\"", name)));
5860 *varname = record->name;
5862 return _ShowOption(record, true);
5866 * Return GUC variable value by variable number; optionally return canonical
5867 * form of name. Return value is palloc'd.
5870 GetConfigOptionByNum(int varnum, const char **values, bool *noshow)
5873 struct config_generic *conf;
5875 /* check requested variable number valid */
5876 Assert((varnum >= 0) && (varnum < num_guc_variables));
5878 conf = guc_variables[varnum];
5882 if ((conf->flags & GUC_NO_SHOW_ALL) ||
5883 ((conf->flags & GUC_SUPERUSER_ONLY) && !superuser()))
5889 /* first get the generic attributes */
5892 values[0] = conf->name;
5894 /* setting : use _ShowOption in order to avoid duplicating the logic */
5895 values[1] = _ShowOption(conf, false);
5898 if (conf->vartype == PGC_INT)
5902 switch (conf->flags & (GUC_UNIT_MEMORY | GUC_UNIT_TIME))
5907 case GUC_UNIT_BLOCKS:
5908 snprintf(buf, sizeof(buf), "%dkB", BLCKSZ / 1024);
5911 case GUC_UNIT_XBLOCKS:
5912 snprintf(buf, sizeof(buf), "%dkB", XLOG_BLCKSZ / 1024);
5933 values[3] = config_group_names[conf->group];
5936 values[4] = conf->short_desc;
5939 values[5] = conf->long_desc;
5942 values[6] = GucContext_Names[conf->context];
5945 values[7] = config_type_names[conf->vartype];
5948 values[8] = GucSource_Names[conf->source];
5950 /* now get the type specifc attributes */
5951 switch (conf->vartype)
5968 struct config_int *lconf = (struct config_int *) conf;
5971 snprintf(buffer, sizeof(buffer), "%d", lconf->min);
5972 values[9] = pstrdup(buffer);
5975 snprintf(buffer, sizeof(buffer), "%d", lconf->max);
5976 values[10] = pstrdup(buffer);
5985 struct config_real *lconf = (struct config_real *) conf;
5988 snprintf(buffer, sizeof(buffer), "%g", lconf->min);
5989 values[9] = pstrdup(buffer);
5992 snprintf(buffer, sizeof(buffer), "%g", lconf->max);
5993 values[10] = pstrdup(buffer);
6022 values[11] = config_enum_get_options((struct config_enum *) conf, "", "");
6029 * should never get here, but in case we do, set 'em to NULL
6046 * Return the total number of GUC variables
6049 GetNumConfigOptions(void)
6051 return num_guc_variables;
6055 * show_config_by_name - equiv to SHOW X command but implemented as
6059 show_config_by_name(PG_FUNCTION_ARGS)
6064 /* Get the GUC variable name */
6065 varname = TextDatumGetCString(PG_GETARG_DATUM(0));
6068 varval = GetConfigOptionByName(varname, NULL);
6070 /* Convert to text */
6071 PG_RETURN_TEXT_P(cstring_to_text(varval));
6075 * show_all_settings - equiv to SHOW ALL command but implemented as
6078 #define NUM_PG_SETTINGS_ATTS 12
6081 show_all_settings(PG_FUNCTION_ARGS)
6083 FuncCallContext *funcctx;
6087 AttInMetadata *attinmeta;
6088 MemoryContext oldcontext;
6090 /* stuff done only on the first call of the function */
6091 if (SRF_IS_FIRSTCALL())
6093 /* create a function context for cross-call persistence */
6094 funcctx = SRF_FIRSTCALL_INIT();
6097 * switch to memory context appropriate for multiple function calls
6099 oldcontext = MemoryContextSwitchTo(funcctx->multi_call_memory_ctx);
6102 * need a tuple descriptor representing NUM_PG_SETTINGS_ATTS columns
6103 * of the appropriate types
6105 tupdesc = CreateTemplateTupleDesc(NUM_PG_SETTINGS_ATTS, false);
6106 TupleDescInitEntry(tupdesc, (AttrNumber) 1, "name",
6108 TupleDescInitEntry(tupdesc, (AttrNumber) 2, "setting",
6110 TupleDescInitEntry(tupdesc, (AttrNumber) 3, "unit",
6112 TupleDescInitEntry(tupdesc, (AttrNumber) 4, "category",
6114 TupleDescInitEntry(tupdesc, (AttrNumber) 5, "short_desc",
6116 TupleDescInitEntry(tupdesc, (AttrNumber) 6, "extra_desc",
6118 TupleDescInitEntry(tupdesc, (AttrNumber) 7, "context",
6120 TupleDescInitEntry(tupdesc, (AttrNumber) 8, "vartype",
6122 TupleDescInitEntry(tupdesc, (AttrNumber) 9, "source",
6124 TupleDescInitEntry(tupdesc, (AttrNumber) 10, "min_val",
6126 TupleDescInitEntry(tupdesc, (AttrNumber) 11, "max_val",
6128 TupleDescInitEntry(tupdesc, (AttrNumber) 12, "enumvals",
6132 * Generate attribute metadata needed later to produce tuples from raw
6135 attinmeta = TupleDescGetAttInMetadata(tupdesc);
6136 funcctx->attinmeta = attinmeta;
6138 /* total number of tuples to be returned */
6139 funcctx->max_calls = GetNumConfigOptions();
6141 MemoryContextSwitchTo(oldcontext);
6144 /* stuff done on every call of the function */
6145 funcctx = SRF_PERCALL_SETUP();
6147 call_cntr = funcctx->call_cntr;
6148 max_calls = funcctx->max_calls;
6149 attinmeta = funcctx->attinmeta;
6151 if (call_cntr < max_calls) /* do when there is more left to send */
6153 char *values[NUM_PG_SETTINGS_ATTS];
6159 * Get the next visible GUC variable name and value
6163 GetConfigOptionByNum(call_cntr, (const char **) values, &noshow);
6166 /* bump the counter and get the next config setting */
6167 call_cntr = ++funcctx->call_cntr;
6169 /* make sure we haven't gone too far now */
6170 if (call_cntr >= max_calls)
6171 SRF_RETURN_DONE(funcctx);
6176 tuple = BuildTupleFromCStrings(attinmeta, values);
6178 /* make the tuple into a datum */
6179 result = HeapTupleGetDatum(tuple);
6181 SRF_RETURN_NEXT(funcctx, result);
6185 /* do when there is no more left */
6186 SRF_RETURN_DONE(funcctx);
6191 _ShowOption(struct config_generic * record, bool use_units)
6196 switch (record->vartype)
6200 struct config_bool *conf = (struct config_bool *) record;
6202 if (conf->show_hook)
6203 val = (*conf->show_hook) ();
6205 val = *conf->variable ? "on" : "off";
6211 struct config_int *conf = (struct config_int *) record;
6213 if (conf->show_hook)
6214 val = (*conf->show_hook) ();
6218 int result = *conf->variable;
6220 if (use_units && result > 0 && (record->flags & GUC_UNIT_MEMORY))
6222 switch (record->flags & GUC_UNIT_MEMORY)
6224 case GUC_UNIT_BLOCKS:
6225 result *= BLCKSZ / 1024;
6227 case GUC_UNIT_XBLOCKS:
6228 result *= XLOG_BLCKSZ / 1024;
6232 if (result % KB_PER_GB == 0)
6234 result /= KB_PER_GB;
6237 else if (result % KB_PER_MB == 0)
6239 result /= KB_PER_MB;
6247 else if (use_units && result > 0 && (record->flags & GUC_UNIT_TIME))
6249 switch (record->flags & GUC_UNIT_TIME)
6255 result *= MS_PER_MIN;
6259 if (result % MS_PER_D == 0)
6264 else if (result % MS_PER_H == 0)
6269 else if (result % MS_PER_MIN == 0)
6271 result /= MS_PER_MIN;
6272 strcpy(unit, "min");
6274 else if (result % MS_PER_S == 0)
6287 snprintf(buffer, sizeof(buffer), "%d%s",
6288 (int) result, unit);
6296 struct config_real *conf = (struct config_real *) record;
6298 if (conf->show_hook)
6299 val = (*conf->show_hook) ();
6302 snprintf(buffer, sizeof(buffer), "%g",
6311 struct config_string *conf = (struct config_string *) record;
6313 if (conf->show_hook)
6314 val = (*conf->show_hook) ();
6315 else if (*conf->variable && **conf->variable)
6316 val = *conf->variable;
6324 struct config_enum *conf = (struct config_enum *) record;
6327 val = (*conf->show_hook) ();
6329 val = config_enum_lookup_by_value(conf, *conf->variable);
6334 /* just to keep compiler quiet */
6339 return pstrdup(val);
6344 * Attempt (badly) to detect if a proposed new GUC setting is the same
6345 * as the current value.
6347 * XXX this does not really work because it doesn't account for the
6348 * effects of canonicalization of string values by assign_hooks.
6351 is_newvalue_equal(struct config_generic * record, const char *newvalue)
6353 /* newvalue == NULL isn't supported */
6354 Assert(newvalue != NULL);
6356 switch (record->vartype)
6360 struct config_bool *conf = (struct config_bool *) record;
6363 return parse_bool(newvalue, &newval)
6364 && *conf->variable == newval;
6368 struct config_int *conf = (struct config_int *) record;
6371 return parse_int(newvalue, &newval, record->flags, NULL)
6372 && *conf->variable == newval;
6376 struct config_real *conf = (struct config_real *) record;
6379 return parse_real(newvalue, &newval)
6380 && *conf->variable == newval;
6384 struct config_string *conf = (struct config_string *) record;
6386 return *conf->variable != NULL &&
6387 strcmp(*conf->variable, newvalue) == 0;
6392 struct config_enum *conf = (struct config_enum *) record;
6395 return config_enum_lookup_by_name(conf, newvalue, &newval)
6396 && *conf->variable == newval;
6407 * This routine dumps out all non-default GUC options into a binary
6408 * file that is read by all exec'ed backends. The format is:
6410 * variable name, string, null terminated
6411 * variable value, string, null terminated
6412 * variable source, integer
6415 write_nondefault_variables(GucContext context)
6421 Assert(context == PGC_POSTMASTER || context == PGC_SIGHUP);
6423 elevel = (context == PGC_SIGHUP) ? LOG : ERROR;
6428 fp = AllocateFile(CONFIG_EXEC_PARAMS_NEW, "w");
6432 (errcode_for_file_access(),
6433 errmsg("could not write to file \"%s\": %m",
6434 CONFIG_EXEC_PARAMS_NEW)));
6438 for (i = 0; i < num_guc_variables; i++)
6440 struct config_generic *gconf = guc_variables[i];
6442 if (gconf->source != PGC_S_DEFAULT)
6444 fprintf(fp, "%s", gconf->name);
6447 switch (gconf->vartype)
6451 struct config_bool *conf = (struct config_bool *) gconf;
6453 if (*conf->variable == 0)
6454 fprintf(fp, "false");
6456 fprintf(fp, "true");
6462 struct config_int *conf = (struct config_int *) gconf;
6464 fprintf(fp, "%d", *conf->variable);
6470 struct config_real *conf = (struct config_real *) gconf;
6472 /* Could lose precision here? */
6473 fprintf(fp, "%f", *conf->variable);
6479 struct config_string *conf = (struct config_string *) gconf;
6481 fprintf(fp, "%s", *conf->variable);
6487 struct config_enum *conf = (struct config_enum *) gconf;
6489 fprintf(fp, "%s", config_enum_lookup_by_value(conf, *conf->variable));
6496 fwrite(&gconf->source, sizeof(gconf->source), 1, fp);
6503 (errcode_for_file_access(),
6504 errmsg("could not write to file \"%s\": %m",
6505 CONFIG_EXEC_PARAMS_NEW)));
6510 * Put new file in place. This could delay on Win32, but we don't hold
6511 * any exclusive locks.
6513 rename(CONFIG_EXEC_PARAMS_NEW, CONFIG_EXEC_PARAMS);
6518 * Read string, including null byte from file
6520 * Return NULL on EOF and nothing read
6523 read_string_with_null(FILE *fp)
6532 if ((ch = fgetc(fp)) == EOF)
6537 elog(FATAL, "invalid format of exec config params file");
6540 str = guc_malloc(FATAL, maxlen);
6541 else if (i == maxlen)
6542 str = guc_realloc(FATAL, str, maxlen *= 2);
6551 * This routine loads a previous postmaster dump of its non-default
6555 read_nondefault_variables(void)
6565 fp = AllocateFile(CONFIG_EXEC_PARAMS, "r");
6568 /* File not found is fine */
6569 if (errno != ENOENT)
6571 (errcode_for_file_access(),
6572 errmsg("could not read from file \"%s\": %m",
6573 CONFIG_EXEC_PARAMS)));
6579 struct config_generic *record;
6581 if ((varname = read_string_with_null(fp)) == NULL)
6584 if ((record = find_option(varname, true, FATAL)) == NULL)
6585 elog(FATAL, "failed to locate variable %s in exec config params file", varname);
6586 if ((varvalue = read_string_with_null(fp)) == NULL)
6587 elog(FATAL, "invalid format of exec config params file");
6588 if (fread(&varsource, sizeof(varsource), 1, fp) == 0)
6589 elog(FATAL, "invalid format of exec config params file");
6591 (void) set_config_option(varname, varvalue, record->context,
6592 varsource, GUC_ACTION_SET, true);
6599 #endif /* EXEC_BACKEND */
6603 * A little "long argument" simulation, although not quite GNU
6604 * compliant. Takes a string of the form "some-option=some value" and
6605 * returns name = "some_option" and value = "some value" in malloc'ed
6606 * storage. Note that '-' is converted to '_' in the option name. If
6607 * there is no '=' in the input string then value will be NULL.
6610 ParseLongOption(const char *string, char **name, char **value)
6619 equal_pos = strcspn(string, "=");
6621 if (string[equal_pos] == '=')
6623 *name = guc_malloc(FATAL, equal_pos + 1);
6624 strlcpy(*name, string, equal_pos + 1);
6626 *value = guc_strdup(FATAL, &string[equal_pos + 1]);
6630 /* no equal sign in string */
6631 *name = guc_strdup(FATAL, string);
6635 for (cp = *name; *cp; cp++)
6642 * Handle options fetched from pg_database.datconfig, pg_authid.rolconfig,
6643 * pg_proc.proconfig, etc. Caller must specify proper context/source/action.
6645 * The array parameter must be an array of TEXT (it must not be NULL).
6648 ProcessGUCArray(ArrayType *array,
6649 GucContext context, GucSource source, GucAction action)
6653 Assert(array != NULL);
6654 Assert(ARR_ELEMTYPE(array) == TEXTOID);
6655 Assert(ARR_NDIM(array) == 1);
6656 Assert(ARR_LBOUND(array)[0] == 1);
6658 for (i = 1; i <= ARR_DIMS(array)[0]; i++)
6666 d = array_ref(array, 1, &i,
6667 -1 /* varlenarray */ ,
6668 -1 /* TEXT's typlen */ ,
6669 false /* TEXT's typbyval */ ,
6670 'i' /* TEXT's typalign */ ,
6676 s = TextDatumGetCString(d);
6678 ParseLongOption(s, &name, &value);
6682 (errcode(ERRCODE_SYNTAX_ERROR),
6683 errmsg("could not parse setting for parameter \"%s\"",
6689 (void) set_config_option(name, value, context, source, action, true);
6699 * Add an entry to an option array. The array parameter may be NULL
6700 * to indicate the current table entry is NULL.
6703 GUCArrayAdd(ArrayType *array, const char *name, const char *value)
6705 const char *varname;
6713 /* test if the option is valid */
6714 set_config_option(name, value,
6715 superuser() ? PGC_SUSET : PGC_USERSET,
6716 PGC_S_TEST, GUC_ACTION_SET, false);
6718 /* convert name to canonical spelling, so we can use plain strcmp */
6719 (void) GetConfigOptionByName(name, &varname);
6722 newval = palloc(strlen(name) + 1 + strlen(value) + 1);
6723 sprintf(newval, "%s=%s", name, value);
6724 datum = CStringGetTextDatum(newval);
6732 Assert(ARR_ELEMTYPE(array) == TEXTOID);
6733 Assert(ARR_NDIM(array) == 1);
6734 Assert(ARR_LBOUND(array)[0] == 1);
6736 index = ARR_DIMS(array)[0] + 1; /* add after end */
6738 for (i = 1; i <= ARR_DIMS(array)[0]; i++)
6743 d = array_ref(array, 1, &i,
6744 -1 /* varlenarray */ ,
6745 -1 /* TEXT's typlen */ ,
6746 false /* TEXT's typbyval */ ,
6747 'i' /* TEXT's typalign */ ,
6751 current = TextDatumGetCString(d);
6752 if (strncmp(current, newval, strlen(name) + 1) == 0)
6759 a = array_set(array, 1, &index,
6762 -1 /* varlena array */ ,
6763 -1 /* TEXT's typlen */ ,
6764 false /* TEXT's typbyval */ ,
6765 'i' /* TEXT's typalign */ );
6768 a = construct_array(&datum, 1,
6777 * Delete an entry from an option array. The array parameter may be NULL
6778 * to indicate the current table entry is NULL. Also, if the return value
6779 * is NULL then a null should be stored.
6782 GUCArrayDelete(ArrayType *array, const char *name)
6784 const char *varname;
6785 ArrayType *newarray;
6791 /* test if the option is valid */
6792 set_config_option(name, NULL,
6793 superuser() ? PGC_SUSET : PGC_USERSET,
6794 PGC_S_TEST, GUC_ACTION_SET, false);
6796 /* convert name to canonical spelling, so we can use plain strcmp */
6797 (void) GetConfigOptionByName(name, &varname);
6800 /* if array is currently null, then surely nothing to delete */
6807 for (i = 1; i <= ARR_DIMS(array)[0]; i++)
6813 d = array_ref(array, 1, &i,
6814 -1 /* varlenarray */ ,
6815 -1 /* TEXT's typlen */ ,
6816 false /* TEXT's typbyval */ ,
6817 'i' /* TEXT's typalign */ ,
6821 val = TextDatumGetCString(d);
6823 /* ignore entry if it's what we want to delete */
6824 if (strncmp(val, name, strlen(name)) == 0
6825 && val[strlen(name)] == '=')
6828 /* else add it to the output array */
6831 newarray = array_set(newarray, 1, &index,
6834 -1 /* varlenarray */ ,
6835 -1 /* TEXT's typlen */ ,
6836 false /* TEXT's typbyval */ ,
6837 'i' /* TEXT's typalign */ );
6840 newarray = construct_array(&d, 1,
6852 * assign_hook and show_hook subroutines
6856 assign_log_destination(const char *value, bool doit, GucSource source)
6863 /* Need a modifiable copy of string */
6864 rawstring = pstrdup(value);
6866 /* Parse string into list of identifiers */
6867 if (!SplitIdentifierString(rawstring, ',', &elemlist))
6869 /* syntax error in list */
6871 list_free(elemlist);
6872 ereport(GUC_complaint_elevel(source),
6873 (errcode(ERRCODE_INVALID_PARAMETER_VALUE),
6874 errmsg("invalid list syntax for parameter \"log_destination\"")));
6878 foreach(l, elemlist)
6880 char *tok = (char *) lfirst(l);
6882 if (pg_strcasecmp(tok, "stderr") == 0)
6883 newlogdest |= LOG_DESTINATION_STDERR;
6884 else if (pg_strcasecmp(tok, "csvlog") == 0)
6885 newlogdest |= LOG_DESTINATION_CSVLOG;
6887 else if (pg_strcasecmp(tok, "syslog") == 0)
6888 newlogdest |= LOG_DESTINATION_SYSLOG;
6891 else if (pg_strcasecmp(tok, "eventlog") == 0)
6892 newlogdest |= LOG_DESTINATION_EVENTLOG;
6896 ereport(GUC_complaint_elevel(source),
6897 (errcode(ERRCODE_INVALID_PARAMETER_VALUE),
6898 errmsg("unrecognized \"log_destination\" key word: \"%s\"",
6901 list_free(elemlist);
6907 Log_destination = newlogdest;
6910 list_free(elemlist);
6918 assign_syslog_facility(int newval, bool doit, GucSource source)
6921 set_syslog_parameters(syslog_ident_str ? syslog_ident_str : "postgres",
6928 assign_syslog_ident(const char *ident, bool doit, GucSource source)
6931 set_syslog_parameters(ident, syslog_facility);
6935 #endif /* HAVE_SYSLOG */
6939 assign_session_replication_role(int newval, bool doit, GucSource source)
6942 * Must flush the plan cache when changing replication role; but don't
6943 * flush unnecessarily.
6945 if (doit && SessionReplicationRole != newval)
6954 show_num_temp_buffers(void)
6957 * We show the GUC var until local buffers have been initialized, and
6958 * NLocBuffer afterwards.
6960 static char nbuf[32];
6962 sprintf(nbuf, "%d", NLocBuffer ? NLocBuffer : num_temp_buffers);
6967 assign_phony_autocommit(bool newval, bool doit, GucSource source)
6971 ereport(GUC_complaint_elevel(source),
6972 (errcode(ERRCODE_FEATURE_NOT_SUPPORTED),
6973 errmsg("SET AUTOCOMMIT TO OFF is no longer supported")));
6980 assign_custom_variable_classes(const char *newval, bool doit, GucSource source)
6983 * Check syntax. newval must be a comma separated list of identifiers.
6984 * Whitespace is allowed but removed from the result.
6986 bool hasSpaceAfterToken = false;
6987 const char *cp = newval;
6992 initStringInfo(&buf);
6993 while ((c = *cp++) != '\0')
6995 if (isspace((unsigned char) c))
6998 hasSpaceAfterToken = true;
7004 if (symLen > 0) /* terminate identifier */
7006 appendStringInfoChar(&buf, ',');
7009 hasSpaceAfterToken = false;
7013 if (hasSpaceAfterToken || !isalnum((unsigned char) c))
7016 * Syntax error due to token following space after token or non
7017 * alpha numeric character
7022 appendStringInfoChar(&buf, c);
7026 /* Remove stray ',' at end */
7027 if (symLen == 0 && buf.len > 0)
7028 buf.data[--buf.len] = '\0';
7030 /* GUC wants the result malloc'd */
7031 newval = guc_strdup(LOG, buf.data);
7038 assign_debug_assertions(bool newval, bool doit, GucSource source)
7040 #ifndef USE_ASSERT_CHECKING
7043 ereport(GUC_complaint_elevel(source),
7044 (errcode(ERRCODE_INVALID_PARAMETER_VALUE),
7045 errmsg("assertion checking is not supported by this build")));
7053 assign_ssl(bool newval, bool doit, GucSource source)
7058 ereport(GUC_complaint_elevel(source),
7059 (errcode(ERRCODE_INVALID_PARAMETER_VALUE),
7060 errmsg("SSL is not supported by this build")));
7068 assign_stage_log_stats(bool newval, bool doit, GucSource source)
7070 if (newval && log_statement_stats)
7072 ereport(GUC_complaint_elevel(source),
7073 (errcode(ERRCODE_INVALID_PARAMETER_VALUE),
7074 errmsg("cannot enable parameter when \"log_statement_stats\" is true")));
7075 /* source == PGC_S_OVERRIDE means do it anyway, eg at xact abort */
7076 if (source != PGC_S_OVERRIDE)
7083 assign_log_stats(bool newval, bool doit, GucSource source)
7086 (log_parser_stats || log_planner_stats || log_executor_stats))
7088 ereport(GUC_complaint_elevel(source),
7089 (errcode(ERRCODE_INVALID_PARAMETER_VALUE),
7090 errmsg("cannot enable \"log_statement_stats\" when "
7091 "\"log_parser_stats\", \"log_planner_stats\", "
7092 "or \"log_executor_stats\" is true")));
7093 /* source == PGC_S_OVERRIDE means do it anyway, eg at xact abort */
7094 if (source != PGC_S_OVERRIDE)
7101 assign_transaction_read_only(bool newval, bool doit, GucSource source)
7103 /* Can't go to r/w mode inside a r/o transaction */
7104 if (newval == false && XactReadOnly && IsSubTransaction())
7106 ereport(GUC_complaint_elevel(source),
7107 (errcode(ERRCODE_INVALID_PARAMETER_VALUE),
7108 errmsg("cannot set transaction read-write mode inside a read-only transaction")));
7109 /* source == PGC_S_OVERRIDE means do it anyway, eg at xact abort */
7110 if (source != PGC_S_OVERRIDE)
7117 assign_canonical_path(const char *newval, bool doit, GucSource source)
7121 char *canon_val = guc_strdup(ERROR, newval);
7123 canonicalize_path(canon_val);
7131 assign_timezone_abbreviations(const char *newval, bool doit, GucSource source)
7134 * The powerup value shown above for timezone_abbreviations is "UNKNOWN".
7135 * When we see this we just do nothing. If this value isn't overridden
7136 * from the config file then pg_timezone_abbrev_initialize() will
7137 * eventually replace it with "Default". This hack has two purposes: to
7138 * avoid wasting cycles loading values that might soon be overridden from
7139 * the config file, and to avoid trying to read the timezone abbrev files
7140 * during InitializeGUCOptions(). The latter doesn't work in an
7141 * EXEC_BACKEND subprocess because my_exec_path hasn't been set yet and so
7142 * we can't locate PGSHAREDIR. (Essentially the same hack is used to
7143 * delay initializing TimeZone ... if we have any more, we should try to
7144 * clean up and centralize this mechanism ...)
7146 if (strcmp(newval, "UNKNOWN") == 0)
7151 /* Loading abbrev file is expensive, so only do it when value changes */
7152 if (timezone_abbreviations_string == NULL ||
7153 strcmp(timezone_abbreviations_string, newval) != 0)
7158 * If reading config file, only the postmaster should bleat loudly
7159 * about problems. Otherwise, it's just this one process doing it,
7160 * and we use WARNING message level.
7162 if (source == PGC_S_FILE)
7163 elevel = IsUnderPostmaster ? DEBUG3 : LOG;
7166 if (!load_tzoffsets(newval, doit, elevel))
7173 * pg_timezone_abbrev_initialize --- set default value if not done already
7175 * This is called after initial loading of postgresql.conf. If no
7176 * timezone_abbreviations setting was found therein, select default.
7179 pg_timezone_abbrev_initialize(void)
7181 if (strcmp(timezone_abbreviations_string, "UNKNOWN") == 0)
7183 SetConfigOption("timezone_abbreviations", "Default",
7184 PGC_POSTMASTER, PGC_S_ARGV);
7189 show_archive_command(void)
7191 if (XLogArchiveMode)
7192 return XLogArchiveCommand;
7194 return "(disabled)";
7198 assign_tcp_keepalives_idle(int newval, bool doit, GucSource source)
7201 return (pq_setkeepalivesidle(newval, MyProcPort) == STATUS_OK);
7207 show_tcp_keepalives_idle(void)
7209 static char nbuf[16];
7211 snprintf(nbuf, sizeof(nbuf), "%d", pq_getkeepalivesidle(MyProcPort));
7216 assign_tcp_keepalives_interval(int newval, bool doit, GucSource source)
7219 return (pq_setkeepalivesinterval(newval, MyProcPort) == STATUS_OK);
7225 show_tcp_keepalives_interval(void)
7227 static char nbuf[16];
7229 snprintf(nbuf, sizeof(nbuf), "%d", pq_getkeepalivesinterval(MyProcPort));
7234 assign_tcp_keepalives_count(int newval, bool doit, GucSource source)
7237 return (pq_setkeepalivescount(newval, MyProcPort) == STATUS_OK);
7243 show_tcp_keepalives_count(void)
7245 static char nbuf[16];
7247 snprintf(nbuf, sizeof(nbuf), "%d", pq_getkeepalivescount(MyProcPort));
7252 assign_maxconnections(int newval, bool doit, GucSource source)
7254 if (newval + autovacuum_max_workers > INT_MAX / 4)
7258 MaxBackends = newval + autovacuum_max_workers;
7264 assign_autovacuum_max_workers(int newval, bool doit, GucSource source)
7266 if (newval + MaxConnections > INT_MAX / 4)
7270 MaxBackends = newval + MaxConnections;
7275 #include "guc-file.c"