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.462 2008/07/06 19:48:45 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/bufmgr.h"
59 #include "storage/fd.h"
60 #include "storage/freespace.h"
61 #include "tcop/tcopprot.h"
62 #include "tsearch/ts_cache.h"
63 #include "utils/builtins.h"
64 #include "utils/guc_tables.h"
65 #include "utils/memutils.h"
66 #include "utils/pg_locale.h"
67 #include "utils/plancache.h"
68 #include "utils/portal.h"
69 #include "utils/ps_status.h"
70 #include "utils/tzparser.h"
71 #include "utils/xml.h"
74 #define PG_KRB_SRVTAB ""
77 #define PG_KRB_SRVNAM ""
80 #define CONFIG_FILENAME "postgresql.conf"
81 #define HBA_FILENAME "pg_hba.conf"
82 #define IDENT_FILENAME "pg_ident.conf"
85 #define CONFIG_EXEC_PARAMS "global/config_exec_params"
86 #define CONFIG_EXEC_PARAMS_NEW "global/config_exec_params.new"
89 /* upper limit for GUC variables measured in kilobytes of memory */
91 #define MAX_KILOBYTES INT_MAX
93 #define MAX_KILOBYTES (INT_MAX / 1024)
96 #define KB_PER_MB (1024)
97 #define KB_PER_GB (1024*1024)
101 #define MS_PER_MIN (1000 * 60)
103 #define S_PER_H (60 * 60)
104 #define MS_PER_H (1000 * 60 * 60)
105 #define MIN_PER_D (60 * 24)
106 #define S_PER_D (60 * 60 * 24)
107 #define MS_PER_D (1000 * 60 * 60 * 24)
109 /* XXX these should appear in other modules' header files */
110 extern bool Log_disconnections;
111 extern int CommitDelay;
112 extern int CommitSiblings;
113 extern char *default_tablespace;
114 extern char *temp_tablespaces;
115 extern bool synchronize_seqscans;
116 extern bool fullPageWrites;
119 extern bool trace_sort;
121 #ifdef TRACE_SYNCSCAN
122 extern bool trace_syncscan;
124 #ifdef DEBUG_BOUNDED_SORT
125 extern bool optimize_bounded_sort;
129 extern char *SSLCipherSuites;
133 static const char *assign_log_destination(const char *value,
134 bool doit, GucSource source);
137 static int syslog_facility = LOG_LOCAL0;
139 static bool assign_syslog_facility(int newval,
140 bool doit, GucSource source);
141 static const char *assign_syslog_ident(const char *ident,
142 bool doit, GucSource source);
145 static bool assign_session_replication_role(int newval, bool doit,
147 static const char *show_num_temp_buffers(void);
148 static bool assign_phony_autocommit(bool newval, bool doit, GucSource source);
149 static const char *assign_custom_variable_classes(const char *newval, bool doit,
151 static bool assign_debug_assertions(bool newval, bool doit, GucSource source);
152 static bool assign_ssl(bool newval, bool doit, GucSource source);
153 static bool assign_stage_log_stats(bool newval, bool doit, GucSource source);
154 static bool assign_log_stats(bool newval, bool doit, GucSource source);
155 static bool assign_transaction_read_only(bool newval, bool doit, GucSource source);
156 static const char *assign_canonical_path(const char *newval, bool doit, GucSource source);
157 static const char *assign_timezone_abbreviations(const char *newval, bool doit, GucSource source);
158 static const char *show_archive_command(void);
159 static bool assign_tcp_keepalives_idle(int newval, bool doit, GucSource source);
160 static bool assign_tcp_keepalives_interval(int newval, bool doit, GucSource source);
161 static bool assign_tcp_keepalives_count(int newval, bool doit, GucSource source);
162 static const char *show_tcp_keepalives_idle(void);
163 static const char *show_tcp_keepalives_interval(void);
164 static const char *show_tcp_keepalives_count(void);
165 static bool assign_autovacuum_max_workers(int newval, bool doit, GucSource source);
166 static bool assign_maxconnections(int newval, bool doit, GucSource source);
168 static char *config_enum_get_options(struct config_enum *record,
169 const char *prefix, const char *suffix);
173 * Options for enum values defined in this module.
177 * We have different sets for client and server message level options because
178 * they sort slightly different (see "log" level)
180 static const struct config_enum_entry client_message_level_options[] = {
181 {"debug", DEBUG2, true},
182 {"debug5", DEBUG5, false},
183 {"debug4", DEBUG4, false},
184 {"debug3", DEBUG3, false},
185 {"debug2", DEBUG2, false},
186 {"debug1", DEBUG1, false},
188 {"info", INFO, true},
189 {"notice", NOTICE, false},
190 {"warning", WARNING, false},
191 {"error", ERROR, false},
192 {"fatal", FATAL, true},
193 {"panic", PANIC, true},
197 static const struct config_enum_entry server_message_level_options[] = {
198 {"debug", DEBUG2, true},
199 {"debug5", DEBUG5, false},
200 {"debug4", DEBUG4, false},
201 {"debug3", DEBUG3, false},
202 {"debug2", DEBUG2, false},
203 {"debug1", DEBUG1, false},
204 {"info", INFO, false},
205 {"notice", NOTICE, false},
206 {"warning", WARNING, false},
207 {"error", ERROR, false},
209 {"fatal", FATAL, false},
210 {"panic", PANIC, false},
214 static const struct config_enum_entry log_error_verbosity_options[] = {
215 {"terse", PGERROR_TERSE, false},
216 {"default", PGERROR_DEFAULT, false},
217 {"verbose", PGERROR_VERBOSE, false},
221 static const struct config_enum_entry log_statement_options[] = {
222 {"none", LOGSTMT_NONE, false},
223 {"ddl", LOGSTMT_DDL, false},
224 {"mod", LOGSTMT_MOD, false},
225 {"all", LOGSTMT_ALL, false},
229 static const struct config_enum_entry regex_flavor_options[] = {
230 {"advanced", REG_ADVANCED, false},
231 {"extended", REG_EXTENDED, false},
232 {"basic", REG_BASIC, false},
236 static const struct config_enum_entry isolation_level_options[] = {
237 {"serializable", XACT_SERIALIZABLE, false},
238 {"repeatable read", XACT_REPEATABLE_READ, false},
239 {"read committed", XACT_READ_COMMITTED, false},
240 {"read uncommitted", XACT_READ_UNCOMMITTED, false},
244 static const struct config_enum_entry session_replication_role_options[] = {
245 {"origin", SESSION_REPLICATION_ROLE_ORIGIN, false},
246 {"replica", SESSION_REPLICATION_ROLE_REPLICA, false},
247 {"local", SESSION_REPLICATION_ROLE_LOCAL, false},
252 static const struct config_enum_entry syslog_facility_options[] = {
253 {"local0", LOG_LOCAL0, false},
254 {"local1", LOG_LOCAL1, false},
255 {"local2", LOG_LOCAL2, false},
256 {"local3", LOG_LOCAL3, false},
257 {"local4", LOG_LOCAL4, false},
258 {"local5", LOG_LOCAL5, false},
259 {"local6", LOG_LOCAL6, false},
260 {"local7", LOG_LOCAL7, false},
265 static const struct config_enum_entry track_function_options[] = {
266 {"none", TRACK_FUNC_OFF, false},
267 {"pl", TRACK_FUNC_PL, false},
268 {"all", TRACK_FUNC_ALL, false},
272 static const struct config_enum_entry xmlbinary_options[] = {
273 {"base64", XMLBINARY_BASE64, false},
274 {"hex", XMLBINARY_HEX, false},
278 static const struct config_enum_entry xmloption_options[] = {
279 {"content", XMLOPTION_CONTENT, false},
280 {"document", XMLOPTION_DOCUMENT, false},
285 * Although only "on", "off", and "safe_encoding" are documented, we
286 * accept all the likely variants of "on" and "off".
288 static const struct config_enum_entry backslash_quote_options[] = {
289 {"safe_encoding", BACKSLASH_QUOTE_SAFE_ENCODING, false},
290 {"on", BACKSLASH_QUOTE_ON, false},
291 {"off", BACKSLASH_QUOTE_OFF, false},
292 {"true", BACKSLASH_QUOTE_ON, true},
293 {"false", BACKSLASH_QUOTE_OFF, true},
294 {"yes", BACKSLASH_QUOTE_ON, true},
295 {"no", BACKSLASH_QUOTE_OFF, true},
296 {"1", BACKSLASH_QUOTE_ON, true},
297 {"0", BACKSLASH_QUOTE_OFF, true},
302 * Options for enum values stored in other modules
304 extern const struct config_enum_entry sync_method_options[];
307 * GUC option variables that are exported from this module
309 #ifdef USE_ASSERT_CHECKING
310 bool assert_enabled = true;
312 bool assert_enabled = false;
314 bool log_duration = false;
315 bool Debug_print_plan = false;
316 bool Debug_print_parse = false;
317 bool Debug_print_rewritten = false;
318 bool Debug_pretty_print = false;
320 bool log_parser_stats = false;
321 bool log_planner_stats = false;
322 bool log_executor_stats = false;
323 bool log_statement_stats = false; /* this is sort of all three
325 bool log_btree_build_stats = false;
327 bool check_function_bodies = true;
328 bool default_with_oids = false;
329 bool SQL_inheritance = true;
331 bool Password_encryption = true;
333 int log_min_error_statement = ERROR;
334 int log_min_messages = WARNING;
335 int client_min_messages = NOTICE;
336 int log_min_duration_statement = -1;
337 int log_temp_files = -1;
339 int num_temp_buffers = 1000;
341 char *ConfigFileName;
344 char *external_pid_file;
346 int tcp_keepalives_idle;
347 int tcp_keepalives_interval;
348 int tcp_keepalives_count;
351 * These variables are all dummies that don't do anything, except in some
352 * cases provide the value for SHOW to display. The real state is elsewhere
353 * and is kept in sync by assign_hooks.
355 static char *log_destination_string;
358 static char *syslog_ident_str;
360 static bool phony_autocommit;
361 static bool session_auth_is_superuser;
362 static double phony_random_seed;
363 static char *client_encoding_string;
364 static char *datestyle_string;
365 static char *locale_collate;
366 static char *locale_ctype;
367 static char *server_encoding_string;
368 static char *server_version_string;
369 static int server_version_num;
370 static char *timezone_string;
371 static char *log_timezone_string;
372 static char *timezone_abbreviations_string;
373 static char *XactIsoLevel_string;
374 static char *data_directory;
375 static char *custom_variable_classes;
376 static int max_function_args;
377 static int max_index_keys;
378 static int max_identifier_length;
379 static int block_size;
380 static bool integer_datetimes;
382 /* should be static, but commands/variable.c needs to get at these */
384 char *session_authorization_string;
388 * Displayable names for context types (enum GucContext)
390 * Note: these strings are deliberately not localized.
392 const char *const GucContext_Names[] =
394 /* PGC_INTERNAL */ "internal",
395 /* PGC_POSTMASTER */ "postmaster",
396 /* PGC_SIGHUP */ "sighup",
397 /* PGC_BACKEND */ "backend",
398 /* PGC_SUSET */ "superuser",
399 /* PGC_USERSET */ "user"
403 * Displayable names for source types (enum GucSource)
405 * Note: these strings are deliberately not localized.
407 const char *const GucSource_Names[] =
409 /* PGC_S_DEFAULT */ "default",
410 /* PGC_S_ENV_VAR */ "environment variable",
411 /* PGC_S_FILE */ "configuration file",
412 /* PGC_S_ARGV */ "command line",
413 /* PGC_S_DATABASE */ "database",
414 /* PGC_S_USER */ "user",
415 /* PGC_S_CLIENT */ "client",
416 /* PGC_S_OVERRIDE */ "override",
417 /* PGC_S_INTERACTIVE */ "interactive",
418 /* PGC_S_TEST */ "test",
419 /* PGC_S_SESSION */ "session"
423 * Displayable names for the groupings defined in enum config_group
425 const char *const config_group_names[] =
428 gettext_noop("Ungrouped"),
430 gettext_noop("File Locations"),
432 gettext_noop("Connections and Authentication"),
433 /* CONN_AUTH_SETTINGS */
434 gettext_noop("Connections and Authentication / Connection Settings"),
435 /* CONN_AUTH_SECURITY */
436 gettext_noop("Connections and Authentication / Security and Authentication"),
438 gettext_noop("Resource Usage"),
440 gettext_noop("Resource Usage / Memory"),
442 gettext_noop("Resource Usage / Free Space Map"),
443 /* RESOURCES_KERNEL */
444 gettext_noop("Resource Usage / Kernel Resources"),
446 gettext_noop("Write-Ahead Log"),
448 gettext_noop("Write-Ahead Log / Settings"),
449 /* WAL_CHECKPOINTS */
450 gettext_noop("Write-Ahead Log / Checkpoints"),
452 gettext_noop("Query Tuning"),
453 /* QUERY_TUNING_METHOD */
454 gettext_noop("Query Tuning / Planner Method Configuration"),
455 /* QUERY_TUNING_COST */
456 gettext_noop("Query Tuning / Planner Cost Constants"),
457 /* QUERY_TUNING_GEQO */
458 gettext_noop("Query Tuning / Genetic Query Optimizer"),
459 /* QUERY_TUNING_OTHER */
460 gettext_noop("Query Tuning / Other Planner Options"),
462 gettext_noop("Reporting and Logging"),
464 gettext_noop("Reporting and Logging / Where to Log"),
466 gettext_noop("Reporting and Logging / When to Log"),
468 gettext_noop("Reporting and Logging / What to Log"),
470 gettext_noop("Statistics"),
471 /* STATS_MONITORING */
472 gettext_noop("Statistics / Monitoring"),
473 /* STATS_COLLECTOR */
474 gettext_noop("Statistics / Query and Index Statistics Collector"),
476 gettext_noop("Autovacuum"),
478 gettext_noop("Client Connection Defaults"),
479 /* CLIENT_CONN_STATEMENT */
480 gettext_noop("Client Connection Defaults / Statement Behavior"),
481 /* CLIENT_CONN_LOCALE */
482 gettext_noop("Client Connection Defaults / Locale and Formatting"),
483 /* CLIENT_CONN_OTHER */
484 gettext_noop("Client Connection Defaults / Other Defaults"),
485 /* LOCK_MANAGEMENT */
486 gettext_noop("Lock Management"),
488 gettext_noop("Version and Platform Compatibility"),
489 /* COMPAT_OPTIONS_PREVIOUS */
490 gettext_noop("Version and Platform Compatibility / Previous PostgreSQL Versions"),
491 /* COMPAT_OPTIONS_CLIENT */
492 gettext_noop("Version and Platform Compatibility / Other Platforms and Clients"),
494 gettext_noop("Preset Options"),
496 gettext_noop("Customized Options"),
497 /* DEVELOPER_OPTIONS */
498 gettext_noop("Developer Options"),
499 /* help_config wants this array to be null-terminated */
504 * Displayable names for GUC variable types (enum config_type)
506 * Note: these strings are deliberately not localized.
508 const char *const config_type_names[] =
510 /* PGC_BOOL */ "bool",
511 /* PGC_INT */ "integer",
512 /* PGC_REAL */ "real",
513 /* PGC_STRING */ "string",
514 /* PGC_ENUM */ "enum"
519 * Contents of GUC tables
521 * See src/backend/utils/misc/README for design notes.
525 * 1. Declare a global variable of type bool, int, double, or char*
526 * and make use of it.
528 * 2. Decide at what times it's safe to set the option. See guc.h for
531 * 3. Decide on a name, a default value, upper and lower bounds (if
534 * 4. Add a record below.
536 * 5. Add it to src/backend/utils/misc/postgresql.conf.sample, if
539 * 6. Don't forget to document the option (at least in config.sgml).
541 * 7. If it's a new GUC_LIST option you must edit pg_dumpall.c to ensure
542 * it is not single quoted at dump time.
546 /******** option records follow ********/
548 static struct config_bool ConfigureNamesBool[] =
551 {"enable_seqscan", PGC_USERSET, QUERY_TUNING_METHOD,
552 gettext_noop("Enables the planner's use of sequential-scan plans."),
559 {"enable_indexscan", PGC_USERSET, QUERY_TUNING_METHOD,
560 gettext_noop("Enables the planner's use of index-scan plans."),
567 {"enable_bitmapscan", PGC_USERSET, QUERY_TUNING_METHOD,
568 gettext_noop("Enables the planner's use of bitmap-scan plans."),
575 {"enable_tidscan", PGC_USERSET, QUERY_TUNING_METHOD,
576 gettext_noop("Enables the planner's use of TID scan plans."),
583 {"enable_sort", PGC_USERSET, QUERY_TUNING_METHOD,
584 gettext_noop("Enables the planner's use of explicit sort steps."),
591 {"enable_hashagg", PGC_USERSET, QUERY_TUNING_METHOD,
592 gettext_noop("Enables the planner's use of hashed aggregation plans."),
599 {"enable_nestloop", PGC_USERSET, QUERY_TUNING_METHOD,
600 gettext_noop("Enables the planner's use of nested-loop join plans."),
607 {"enable_mergejoin", PGC_USERSET, QUERY_TUNING_METHOD,
608 gettext_noop("Enables the planner's use of merge join plans."),
615 {"enable_hashjoin", PGC_USERSET, QUERY_TUNING_METHOD,
616 gettext_noop("Enables the planner's use of hash join plans."),
623 {"constraint_exclusion", PGC_USERSET, QUERY_TUNING_OTHER,
624 gettext_noop("Enables the planner to use constraints to optimize queries."),
625 gettext_noop("Child table scans will be skipped if their "
626 "constraints guarantee that no rows match the query.")
628 &constraint_exclusion,
632 {"geqo", PGC_USERSET, QUERY_TUNING_GEQO,
633 gettext_noop("Enables genetic query optimization."),
634 gettext_noop("This algorithm attempts to do planning without "
635 "exhaustive searching.")
641 /* Not for general use --- used by SET SESSION AUTHORIZATION */
642 {"is_superuser", PGC_INTERNAL, UNGROUPED,
643 gettext_noop("Shows whether the current user is a superuser."),
645 GUC_REPORT | GUC_NO_SHOW_ALL | GUC_NO_RESET_ALL | GUC_NOT_IN_SAMPLE | GUC_DISALLOW_IN_FILE
647 &session_auth_is_superuser,
651 {"ssl", PGC_POSTMASTER, CONN_AUTH_SECURITY,
652 gettext_noop("Enables SSL connections."),
656 false, assign_ssl, NULL
659 {"fsync", PGC_SIGHUP, WAL_SETTINGS,
660 gettext_noop("Forces synchronization of updates to disk."),
661 gettext_noop("The server will use the fsync() system call in several places to make "
662 "sure that updates are physically written to disk. This insures "
663 "that a database cluster will recover to a consistent state after "
664 "an operating system or hardware crash.")
670 {"synchronous_commit", PGC_USERSET, WAL_SETTINGS,
671 gettext_noop("Sets immediate fsync at commit."),
678 {"zero_damaged_pages", PGC_SUSET, DEVELOPER_OPTIONS,
679 gettext_noop("Continues processing past damaged page headers."),
680 gettext_noop("Detection of a damaged page header normally causes PostgreSQL to "
681 "report an error, aborting the current transaction. Setting "
682 "zero_damaged_pages to true causes the system to instead report a "
683 "warning, zero out the damaged page, and continue processing. This "
684 "behavior will destroy data, namely all the rows on the damaged page."),
691 {"full_page_writes", PGC_SIGHUP, WAL_SETTINGS,
692 gettext_noop("Writes full pages to WAL when first modified after a checkpoint."),
693 gettext_noop("A page write in process during an operating system crash might be "
694 "only partially written to disk. During recovery, the row changes "
695 "stored in WAL are not enough to recover. This option writes "
696 "pages when first modified after a checkpoint to WAL so full recovery "
703 {"silent_mode", PGC_POSTMASTER, LOGGING_WHEN,
704 gettext_noop("Runs the server silently."),
705 gettext_noop("If this parameter is set, the server will automatically run in the "
706 "background and any controlling terminals are dissociated.")
712 {"log_checkpoints", PGC_SIGHUP, LOGGING_WHAT,
713 gettext_noop("Logs each checkpoint."),
720 {"log_connections", PGC_BACKEND, LOGGING_WHAT,
721 gettext_noop("Logs each successful connection."),
728 {"log_disconnections", PGC_BACKEND, LOGGING_WHAT,
729 gettext_noop("Logs end of a session, including duration."),
736 {"debug_assertions", PGC_USERSET, DEVELOPER_OPTIONS,
737 gettext_noop("Turns on various assertion checks."),
738 gettext_noop("This is a debugging aid."),
742 #ifdef USE_ASSERT_CHECKING
747 assign_debug_assertions, NULL
750 /* currently undocumented, so don't show in SHOW ALL */
751 {"exit_on_error", PGC_USERSET, UNGROUPED,
752 gettext_noop("No description available."),
754 GUC_NO_SHOW_ALL | GUC_NOT_IN_SAMPLE
760 {"log_duration", PGC_SUSET, LOGGING_WHAT,
761 gettext_noop("Logs the duration of each completed SQL statement."),
768 {"debug_print_parse", PGC_USERSET, LOGGING_WHAT,
769 gettext_noop("Prints the parse tree to the server log."),
776 {"debug_print_rewritten", PGC_USERSET, LOGGING_WHAT,
777 gettext_noop("Prints the parse tree after rewriting to server log."),
780 &Debug_print_rewritten,
784 {"debug_print_plan", PGC_USERSET, LOGGING_WHAT,
785 gettext_noop("Prints the execution plan to server log."),
792 {"debug_pretty_print", PGC_USERSET, LOGGING_WHAT,
793 gettext_noop("Indents parse and plan tree displays."),
800 {"log_parser_stats", PGC_SUSET, STATS_MONITORING,
801 gettext_noop("Writes parser performance statistics to the server log."),
805 false, assign_stage_log_stats, NULL
808 {"log_planner_stats", PGC_SUSET, STATS_MONITORING,
809 gettext_noop("Writes planner performance statistics to the server log."),
813 false, assign_stage_log_stats, NULL
816 {"log_executor_stats", PGC_SUSET, STATS_MONITORING,
817 gettext_noop("Writes executor performance statistics to the server log."),
821 false, assign_stage_log_stats, NULL
824 {"log_statement_stats", PGC_SUSET, STATS_MONITORING,
825 gettext_noop("Writes cumulative performance statistics to the server log."),
828 &log_statement_stats,
829 false, assign_log_stats, NULL
831 #ifdef BTREE_BUILD_STATS
833 {"log_btree_build_stats", PGC_SUSET, DEVELOPER_OPTIONS,
834 gettext_noop("No description available."),
838 &log_btree_build_stats,
844 {"track_activities", PGC_SUSET, STATS_COLLECTOR,
845 gettext_noop("Collects information about executing commands."),
846 gettext_noop("Enables the collection of information on the currently "
847 "executing command of each session, along with "
848 "the time at which that command began execution.")
850 &pgstat_track_activities,
854 {"track_counts", PGC_SUSET, STATS_COLLECTOR,
855 gettext_noop("Collects statistics on database activity."),
858 &pgstat_track_counts,
863 {"update_process_title", PGC_SUSET, STATS_COLLECTOR,
864 gettext_noop("Updates the process title to show the active SQL command."),
865 gettext_noop("Enables updating of the process title every time a new SQL command is received by the server.")
867 &update_process_title,
872 {"autovacuum", PGC_SIGHUP, AUTOVACUUM,
873 gettext_noop("Starts the autovacuum subprocess."),
876 &autovacuum_start_daemon,
881 {"trace_notify", PGC_USERSET, DEVELOPER_OPTIONS,
882 gettext_noop("Generates debugging output for LISTEN and NOTIFY."),
892 {"trace_locks", PGC_SUSET, DEVELOPER_OPTIONS,
893 gettext_noop("No description available."),
901 {"trace_userlocks", PGC_SUSET, DEVELOPER_OPTIONS,
902 gettext_noop("No description available."),
910 {"trace_lwlocks", PGC_SUSET, DEVELOPER_OPTIONS,
911 gettext_noop("No description available."),
919 {"debug_deadlocks", PGC_SUSET, DEVELOPER_OPTIONS,
920 gettext_noop("No description available."),
930 {"log_lock_waits", PGC_SUSET, LOGGING_WHAT,
931 gettext_noop("Logs long lock waits."),
939 {"log_hostname", PGC_SIGHUP, LOGGING_WHAT,
940 gettext_noop("Logs the host name in the connection logs."),
941 gettext_noop("By default, connection logs only show the IP address "
942 "of the connecting host. If you want them to show the host name you "
943 "can turn this on, but depending on your host name resolution "
944 "setup it might impose a non-negligible performance penalty.")
950 {"sql_inheritance", PGC_USERSET, COMPAT_OPTIONS_PREVIOUS,
951 gettext_noop("Causes subtables to be included by default in various commands."),
958 {"password_encryption", PGC_USERSET, CONN_AUTH_SECURITY,
959 gettext_noop("Encrypt passwords."),
960 gettext_noop("When a password is specified in CREATE USER or "
961 "ALTER USER without writing either ENCRYPTED or UNENCRYPTED, "
962 "this parameter determines whether the password is to be encrypted.")
964 &Password_encryption,
968 {"transform_null_equals", PGC_USERSET, COMPAT_OPTIONS_CLIENT,
969 gettext_noop("Treats \"expr=NULL\" as \"expr IS NULL\"."),
970 gettext_noop("When turned on, expressions of the form expr = NULL "
971 "(or NULL = expr) are treated as expr IS NULL, that is, they "
972 "return true if expr evaluates to the null value, and false "
973 "otherwise. The correct behavior of expr = NULL is to always "
974 "return null (unknown).")
976 &Transform_null_equals,
980 {"db_user_namespace", PGC_SIGHUP, CONN_AUTH_SECURITY,
981 gettext_noop("Enables per-database user names."),
988 /* only here for backwards compatibility */
989 {"autocommit", PGC_USERSET, CLIENT_CONN_STATEMENT,
990 gettext_noop("This parameter doesn't do anything."),
991 gettext_noop("It's just here so that we won't choke on SET AUTOCOMMIT TO ON from 7.3-vintage clients."),
992 GUC_NO_SHOW_ALL | GUC_NOT_IN_SAMPLE
995 true, assign_phony_autocommit, NULL
998 {"default_transaction_read_only", PGC_USERSET, CLIENT_CONN_STATEMENT,
999 gettext_noop("Sets the default read-only status of new transactions."),
1002 &DefaultXactReadOnly,
1006 {"transaction_read_only", PGC_USERSET, CLIENT_CONN_STATEMENT,
1007 gettext_noop("Sets the current transaction's read-only status."),
1009 GUC_NO_RESET_ALL | GUC_NOT_IN_SAMPLE | GUC_DISALLOW_IN_FILE
1012 false, assign_transaction_read_only, NULL
1015 {"add_missing_from", PGC_USERSET, COMPAT_OPTIONS_PREVIOUS,
1016 gettext_noop("Automatically adds missing table references to FROM clauses."),
1023 {"check_function_bodies", PGC_USERSET, CLIENT_CONN_STATEMENT,
1024 gettext_noop("Check function bodies during CREATE FUNCTION."),
1027 &check_function_bodies,
1031 {"array_nulls", PGC_USERSET, COMPAT_OPTIONS_PREVIOUS,
1032 gettext_noop("Enable input of NULL elements in arrays."),
1033 gettext_noop("When turned on, unquoted NULL in an array input "
1034 "value means a null value; "
1035 "otherwise it is taken literally.")
1041 {"default_with_oids", PGC_USERSET, COMPAT_OPTIONS_PREVIOUS,
1042 gettext_noop("Create new tables with OIDs by default."),
1049 {"logging_collector", PGC_POSTMASTER, LOGGING_WHERE,
1050 gettext_noop("Start a subprocess to capture stderr output and/or csvlogs into log files."),
1057 {"log_truncate_on_rotation", PGC_SIGHUP, LOGGING_WHERE,
1058 gettext_noop("Truncate existing log files of same name during log rotation."),
1061 &Log_truncate_on_rotation,
1067 {"trace_sort", PGC_USERSET, DEVELOPER_OPTIONS,
1068 gettext_noop("Emit information about resource usage in sorting."),
1077 #ifdef TRACE_SYNCSCAN
1078 /* this is undocumented because not exposed in a standard build */
1080 {"trace_syncscan", PGC_USERSET, DEVELOPER_OPTIONS,
1081 gettext_noop("Generate debugging output for synchronized scanning."),
1090 #ifdef DEBUG_BOUNDED_SORT
1091 /* this is undocumented because not exposed in a standard build */
1094 "optimize_bounded_sort", PGC_USERSET, QUERY_TUNING_METHOD,
1095 gettext_noop("Enable bounded sorting using heap sort."),
1099 &optimize_bounded_sort,
1106 {"wal_debug", PGC_SUSET, DEVELOPER_OPTIONS,
1107 gettext_noop("Emit WAL-related debugging output."),
1117 {"integer_datetimes", PGC_INTERNAL, PRESET_OPTIONS,
1118 gettext_noop("Datetimes are integer based."),
1120 GUC_REPORT | GUC_NOT_IN_SAMPLE | GUC_DISALLOW_IN_FILE
1123 #ifdef HAVE_INT64_TIMESTAMP
1131 {"krb_caseins_users", PGC_POSTMASTER, CONN_AUTH_SECURITY,
1132 gettext_noop("Sets whether Kerberos and GSSAPI user names should be treated as case-insensitive."),
1135 &pg_krb_caseins_users,
1140 {"escape_string_warning", PGC_USERSET, COMPAT_OPTIONS_PREVIOUS,
1141 gettext_noop("Warn about backslash escapes in ordinary string literals."),
1144 &escape_string_warning,
1149 {"standard_conforming_strings", PGC_USERSET, COMPAT_OPTIONS_PREVIOUS,
1150 gettext_noop("Causes '...' strings to treat backslashes literally."),
1154 &standard_conforming_strings,
1159 {"synchronize_seqscans", PGC_USERSET, COMPAT_OPTIONS_PREVIOUS,
1160 gettext_noop("Enable synchronized sequential scans."),
1163 &synchronize_seqscans,
1168 {"archive_mode", PGC_POSTMASTER, WAL_SETTINGS,
1169 gettext_noop("Allows archiving of WAL files using archive_command."),
1177 {"allow_system_table_mods", PGC_POSTMASTER, DEVELOPER_OPTIONS,
1178 gettext_noop("Allows modifications of the structure of system tables."),
1182 &allowSystemTableMods,
1187 {"ignore_system_indexes", PGC_BACKEND, DEVELOPER_OPTIONS,
1188 gettext_noop("Disables reading from system indexes."),
1189 gettext_noop("It does not prevent updating the indexes, so it is safe "
1190 "to use. The worst consequence is slowness."),
1193 &IgnoreSystemIndexes,
1197 /* End-of-list marker */
1199 {NULL, 0, 0, NULL, NULL}, NULL, false, NULL, NULL
1204 static struct config_int ConfigureNamesInt[] =
1207 {"archive_timeout", PGC_SIGHUP, WAL_SETTINGS,
1208 gettext_noop("Forces a switch to the next xlog file if a "
1209 "new file has not been started within N seconds."),
1213 &XLogArchiveTimeout,
1214 0, 0, INT_MAX, NULL, NULL
1217 {"post_auth_delay", PGC_BACKEND, DEVELOPER_OPTIONS,
1218 gettext_noop("Waits N seconds on connection startup after authentication."),
1219 gettext_noop("This allows attaching a debugger to the process."),
1220 GUC_NOT_IN_SAMPLE | GUC_UNIT_S
1223 0, 0, INT_MAX, NULL, NULL
1226 {"default_statistics_target", PGC_USERSET, QUERY_TUNING_OTHER,
1227 gettext_noop("Sets the default statistics target."),
1228 gettext_noop("This applies to table columns that have not had a "
1229 "column-specific target set via ALTER TABLE SET STATISTICS.")
1231 &default_statistics_target,
1232 10, 1, 1000, NULL, NULL
1235 {"from_collapse_limit", PGC_USERSET, QUERY_TUNING_OTHER,
1236 gettext_noop("Sets the FROM-list size beyond which subqueries "
1237 "are not collapsed."),
1238 gettext_noop("The planner will merge subqueries into upper "
1239 "queries if the resulting FROM list would have no more than "
1242 &from_collapse_limit,
1243 8, 1, INT_MAX, NULL, NULL
1246 {"join_collapse_limit", PGC_USERSET, QUERY_TUNING_OTHER,
1247 gettext_noop("Sets the FROM-list size beyond which JOIN "
1248 "constructs are not flattened."),
1249 gettext_noop("The planner will flatten explicit JOIN "
1250 "constructs into lists of FROM items whenever a "
1251 "list of no more than this many items would result.")
1253 &join_collapse_limit,
1254 8, 1, INT_MAX, NULL, NULL
1257 {"geqo_threshold", PGC_USERSET, QUERY_TUNING_GEQO,
1258 gettext_noop("Sets the threshold of FROM items beyond which GEQO is used."),
1262 12, 2, INT_MAX, NULL, NULL
1265 {"geqo_effort", PGC_USERSET, QUERY_TUNING_GEQO,
1266 gettext_noop("GEQO: effort is used to set the default for other GEQO parameters."),
1270 DEFAULT_GEQO_EFFORT, MIN_GEQO_EFFORT, MAX_GEQO_EFFORT, NULL, NULL
1273 {"geqo_pool_size", PGC_USERSET, QUERY_TUNING_GEQO,
1274 gettext_noop("GEQO: number of individuals in the population."),
1275 gettext_noop("Zero selects a suitable default value.")
1278 0, 0, INT_MAX, NULL, NULL
1281 {"geqo_generations", PGC_USERSET, QUERY_TUNING_GEQO,
1282 gettext_noop("GEQO: number of iterations of the algorithm."),
1283 gettext_noop("Zero selects a suitable default value.")
1286 0, 0, INT_MAX, NULL, NULL
1290 {"deadlock_timeout", PGC_SIGHUP, LOCK_MANAGEMENT,
1291 gettext_noop("Sets the time to wait on a lock before checking for deadlock."),
1296 1000, 1, INT_MAX / 1000, NULL, NULL
1300 * Note: MaxBackends is limited to INT_MAX/4 because some places compute
1301 * 4*MaxBackends without any overflow check. This check is made in
1302 * assign_maxconnections, since MaxBackends is computed as MaxConnections
1303 * plus autovacuum_max_workers.
1305 * Likewise we have to limit NBuffers to INT_MAX/2.
1308 {"max_connections", PGC_POSTMASTER, CONN_AUTH_SETTINGS,
1309 gettext_noop("Sets the maximum number of concurrent connections."),
1313 100, 1, INT_MAX / 4, assign_maxconnections, NULL
1317 {"superuser_reserved_connections", PGC_POSTMASTER, CONN_AUTH_SETTINGS,
1318 gettext_noop("Sets the number of connection slots reserved for superusers."),
1322 3, 0, INT_MAX / 4, NULL, NULL
1326 {"shared_buffers", PGC_POSTMASTER, RESOURCES_MEM,
1327 gettext_noop("Sets the number of shared memory buffers used by the server."),
1332 1024, 16, INT_MAX / 2, NULL, NULL
1336 {"temp_buffers", PGC_USERSET, RESOURCES_MEM,
1337 gettext_noop("Sets the maximum number of temporary buffers used by each session."),
1342 1024, 100, INT_MAX / 2, NULL, show_num_temp_buffers
1346 {"port", PGC_POSTMASTER, CONN_AUTH_SETTINGS,
1347 gettext_noop("Sets the TCP port the server listens on."),
1351 DEF_PGPORT, 1, 65535, NULL, NULL
1355 {"unix_socket_permissions", PGC_POSTMASTER, CONN_AUTH_SETTINGS,
1356 gettext_noop("Sets the access permissions of the Unix-domain socket."),
1357 gettext_noop("Unix-domain sockets use the usual Unix file system "
1358 "permission set. The parameter value is expected to be a numeric mode "
1359 "specification in the form accepted by the chmod and umask system "
1360 "calls. (To use the customary octal format the number must start with "
1363 &Unix_socket_permissions,
1364 0777, 0000, 0777, NULL, NULL
1368 {"work_mem", PGC_USERSET, RESOURCES_MEM,
1369 gettext_noop("Sets the maximum memory to be used for query workspaces."),
1370 gettext_noop("This much memory can be used by each internal "
1371 "sort operation and hash table before switching to "
1372 "temporary disk files."),
1376 1024, 64, MAX_KILOBYTES, NULL, NULL
1380 {"maintenance_work_mem", PGC_USERSET, RESOURCES_MEM,
1381 gettext_noop("Sets the maximum memory to be used for maintenance operations."),
1382 gettext_noop("This includes operations such as VACUUM and CREATE INDEX."),
1385 &maintenance_work_mem,
1386 16384, 1024, MAX_KILOBYTES, NULL, NULL
1390 {"max_stack_depth", PGC_SUSET, RESOURCES_MEM,
1391 gettext_noop("Sets the maximum stack depth, in kilobytes."),
1396 100, 100, MAX_KILOBYTES, assign_max_stack_depth, NULL
1400 {"vacuum_cost_page_hit", PGC_USERSET, RESOURCES,
1401 gettext_noop("Vacuum cost for a page found in the buffer cache."),
1405 1, 0, 10000, NULL, NULL
1409 {"vacuum_cost_page_miss", PGC_USERSET, RESOURCES,
1410 gettext_noop("Vacuum cost for a page not found in the buffer cache."),
1413 &VacuumCostPageMiss,
1414 10, 0, 10000, NULL, NULL
1418 {"vacuum_cost_page_dirty", PGC_USERSET, RESOURCES,
1419 gettext_noop("Vacuum cost for a page dirtied by vacuum."),
1422 &VacuumCostPageDirty,
1423 20, 0, 10000, NULL, NULL
1427 {"vacuum_cost_limit", PGC_USERSET, RESOURCES,
1428 gettext_noop("Vacuum cost amount available before napping."),
1432 200, 1, 10000, NULL, NULL
1436 {"vacuum_cost_delay", PGC_USERSET, RESOURCES,
1437 gettext_noop("Vacuum cost delay in milliseconds."),
1442 0, 0, 1000, NULL, NULL
1446 {"autovacuum_vacuum_cost_delay", PGC_SIGHUP, AUTOVACUUM,
1447 gettext_noop("Vacuum cost delay in milliseconds, for autovacuum."),
1451 &autovacuum_vac_cost_delay,
1452 20, -1, 1000, NULL, NULL
1456 {"autovacuum_vacuum_cost_limit", PGC_SIGHUP, AUTOVACUUM,
1457 gettext_noop("Vacuum cost amount available before napping, for autovacuum."),
1460 &autovacuum_vac_cost_limit,
1461 -1, -1, 10000, NULL, NULL
1465 {"max_files_per_process", PGC_POSTMASTER, RESOURCES_KERNEL,
1466 gettext_noop("Sets the maximum number of simultaneously open files for each server process."),
1469 &max_files_per_process,
1470 1000, 25, INT_MAX, NULL, NULL
1474 {"max_prepared_transactions", PGC_POSTMASTER, RESOURCES,
1475 gettext_noop("Sets the maximum number of simultaneously prepared transactions."),
1478 &max_prepared_xacts,
1479 5, 0, INT_MAX, NULL, NULL
1484 {"trace_lock_oidmin", PGC_SUSET, DEVELOPER_OPTIONS,
1485 gettext_noop("No description available."),
1490 FirstNormalObjectId, 0, INT_MAX, NULL, NULL
1493 {"trace_lock_table", PGC_SUSET, DEVELOPER_OPTIONS,
1494 gettext_noop("No description available."),
1499 0, 0, INT_MAX, NULL, NULL
1504 {"statement_timeout", PGC_USERSET, CLIENT_CONN_STATEMENT,
1505 gettext_noop("Sets the maximum allowed duration of any statement."),
1506 gettext_noop("A value of 0 turns off the timeout."),
1510 0, 0, INT_MAX, NULL, NULL
1514 {"vacuum_freeze_min_age", PGC_USERSET, CLIENT_CONN_STATEMENT,
1515 gettext_noop("Minimum age at which VACUUM should freeze a table row."),
1518 &vacuum_freeze_min_age,
1519 100000000, 0, 1000000000, NULL, NULL
1523 {"max_fsm_relations", PGC_POSTMASTER, RESOURCES_FSM,
1524 gettext_noop("Sets the maximum number of tables and indexes for which free space is tracked."),
1528 1000, 100, INT_MAX, NULL, NULL
1531 {"max_fsm_pages", PGC_POSTMASTER, RESOURCES_FSM,
1532 gettext_noop("Sets the maximum number of disk pages for which free space is tracked."),
1536 20000, 1000, INT_MAX, NULL, NULL
1540 {"max_locks_per_transaction", PGC_POSTMASTER, LOCK_MANAGEMENT,
1541 gettext_noop("Sets the maximum number of locks per transaction."),
1542 gettext_noop("The shared lock table is sized on the assumption that "
1543 "at most max_locks_per_transaction * max_connections distinct "
1544 "objects will need to be locked at any one time.")
1546 &max_locks_per_xact,
1547 64, 10, INT_MAX, NULL, NULL
1551 {"authentication_timeout", PGC_SIGHUP, CONN_AUTH_SECURITY,
1552 gettext_noop("Sets the maximum allowed time to complete client authentication."),
1556 &AuthenticationTimeout,
1557 60, 1, 600, NULL, NULL
1561 /* Not for general use */
1562 {"pre_auth_delay", PGC_SIGHUP, DEVELOPER_OPTIONS,
1563 gettext_noop("Waits N seconds on connection startup before authentication."),
1564 gettext_noop("This allows attaching a debugger to the process."),
1565 GUC_NOT_IN_SAMPLE | GUC_UNIT_S
1568 0, 0, 60, NULL, NULL
1572 {"checkpoint_segments", PGC_SIGHUP, WAL_CHECKPOINTS,
1573 gettext_noop("Sets the maximum distance in log segments between automatic WAL checkpoints."),
1576 &CheckPointSegments,
1577 3, 1, INT_MAX, NULL, NULL
1581 {"checkpoint_timeout", PGC_SIGHUP, WAL_CHECKPOINTS,
1582 gettext_noop("Sets the maximum time between automatic WAL checkpoints."),
1587 300, 30, 3600, NULL, NULL
1591 {"checkpoint_warning", PGC_SIGHUP, WAL_CHECKPOINTS,
1592 gettext_noop("Enables warnings if checkpoint segments are filled more "
1593 "frequently than this."),
1594 gettext_noop("Write a message to the server log if checkpoints "
1595 "caused by the filling of checkpoint segment files happens more "
1596 "frequently than this number of seconds. Zero turns off the warning."),
1600 30, 0, INT_MAX, NULL, NULL
1604 {"wal_buffers", PGC_POSTMASTER, WAL_SETTINGS,
1605 gettext_noop("Sets the number of disk-page buffers in shared memory for WAL."),
1610 8, 4, INT_MAX, NULL, NULL
1614 {"wal_writer_delay", PGC_SIGHUP, WAL_SETTINGS,
1615 gettext_noop("WAL writer sleep time between WAL flushes."),
1620 200, 1, 10000, NULL, NULL
1624 {"commit_delay", PGC_USERSET, WAL_SETTINGS,
1625 gettext_noop("Sets the delay in microseconds between transaction commit and "
1626 "flushing WAL to disk."),
1630 0, 0, 100000, NULL, NULL
1634 {"commit_siblings", PGC_USERSET, WAL_SETTINGS,
1635 gettext_noop("Sets the minimum concurrent open transactions before performing "
1640 5, 1, 1000, NULL, NULL
1644 {"extra_float_digits", PGC_USERSET, CLIENT_CONN_LOCALE,
1645 gettext_noop("Sets the number of digits displayed for floating-point values."),
1646 gettext_noop("This affects real, double precision, and geometric data types. "
1647 "The parameter value is added to the standard number of digits "
1648 "(FLT_DIG or DBL_DIG as appropriate).")
1650 &extra_float_digits,
1651 0, -15, 2, NULL, NULL
1655 {"log_min_duration_statement", PGC_SUSET, LOGGING_WHEN,
1656 gettext_noop("Sets the minimum execution time above which "
1657 "statements will be logged."),
1658 gettext_noop("Zero prints all queries. -1 turns this feature off."),
1661 &log_min_duration_statement,
1662 -1, -1, INT_MAX / 1000, NULL, NULL
1666 {"log_autovacuum_min_duration", PGC_SIGHUP, LOGGING_WHAT,
1667 gettext_noop("Sets the minimum execution time above which "
1668 "autovacuum actions will be logged."),
1669 gettext_noop("Zero prints all actions. -1 turns autovacuum logging off."),
1672 &Log_autovacuum_min_duration,
1673 -1, -1, INT_MAX / 1000, NULL, NULL
1677 {"bgwriter_delay", PGC_SIGHUP, RESOURCES,
1678 gettext_noop("Background writer sleep time between rounds."),
1683 200, 10, 10000, NULL, NULL
1687 {"bgwriter_lru_maxpages", PGC_SIGHUP, RESOURCES,
1688 gettext_noop("Background writer maximum number of LRU pages to flush per round."),
1691 &bgwriter_lru_maxpages,
1692 100, 0, 1000, NULL, NULL
1696 {"log_rotation_age", PGC_SIGHUP, LOGGING_WHERE,
1697 gettext_noop("Automatic log file rotation will occur after N minutes."),
1702 HOURS_PER_DAY * MINS_PER_HOUR, 0, INT_MAX / MINS_PER_HOUR, NULL, NULL
1706 {"log_rotation_size", PGC_SIGHUP, LOGGING_WHERE,
1707 gettext_noop("Automatic log file rotation will occur after N kilobytes."),
1712 10 * 1024, 0, INT_MAX / 1024, NULL, NULL
1716 {"max_function_args", PGC_INTERNAL, PRESET_OPTIONS,
1717 gettext_noop("Shows the maximum number of function arguments."),
1719 GUC_NOT_IN_SAMPLE | GUC_DISALLOW_IN_FILE
1722 FUNC_MAX_ARGS, FUNC_MAX_ARGS, FUNC_MAX_ARGS, NULL, NULL
1726 {"max_index_keys", PGC_INTERNAL, PRESET_OPTIONS,
1727 gettext_noop("Shows the maximum number of index keys."),
1729 GUC_NOT_IN_SAMPLE | GUC_DISALLOW_IN_FILE
1732 INDEX_MAX_KEYS, INDEX_MAX_KEYS, INDEX_MAX_KEYS, NULL, NULL
1736 {"max_identifier_length", PGC_INTERNAL, PRESET_OPTIONS,
1737 gettext_noop("Shows the maximum identifier length."),
1739 GUC_NOT_IN_SAMPLE | GUC_DISALLOW_IN_FILE
1741 &max_identifier_length,
1742 NAMEDATALEN - 1, NAMEDATALEN - 1, NAMEDATALEN - 1, NULL, NULL
1746 {"block_size", PGC_INTERNAL, PRESET_OPTIONS,
1747 gettext_noop("Shows the size of a disk block."),
1749 GUC_NOT_IN_SAMPLE | GUC_DISALLOW_IN_FILE
1752 BLCKSZ, BLCKSZ, BLCKSZ, NULL, NULL
1756 {"autovacuum_naptime", PGC_SIGHUP, AUTOVACUUM,
1757 gettext_noop("Time to sleep between autovacuum runs."),
1761 &autovacuum_naptime,
1762 60, 1, INT_MAX / 1000, NULL, NULL
1765 {"autovacuum_vacuum_threshold", PGC_SIGHUP, AUTOVACUUM,
1766 gettext_noop("Minimum number of tuple updates or deletes prior to vacuum."),
1769 &autovacuum_vac_thresh,
1770 50, 0, INT_MAX, NULL, NULL
1773 {"autovacuum_analyze_threshold", PGC_SIGHUP, AUTOVACUUM,
1774 gettext_noop("Minimum number of tuple inserts, updates or deletes prior to analyze."),
1777 &autovacuum_anl_thresh,
1778 50, 0, INT_MAX, NULL, NULL
1781 /* see varsup.c for why this is PGC_POSTMASTER not PGC_SIGHUP */
1782 {"autovacuum_freeze_max_age", PGC_POSTMASTER, AUTOVACUUM,
1783 gettext_noop("Age at which to autovacuum a table to prevent transaction ID wraparound."),
1786 &autovacuum_freeze_max_age,
1787 200000000, 100000000, 2000000000, NULL, NULL
1790 /* see max_connections */
1791 {"autovacuum_max_workers", PGC_POSTMASTER, AUTOVACUUM,
1792 gettext_noop("Sets the maximum number of simultaneously running autovacuum worker processes."),
1795 &autovacuum_max_workers,
1796 3, 1, INT_MAX / 4, assign_autovacuum_max_workers, NULL
1800 {"tcp_keepalives_idle", PGC_USERSET, CLIENT_CONN_OTHER,
1801 gettext_noop("Time between issuing TCP keepalives."),
1802 gettext_noop("A value of 0 uses the system default."),
1805 &tcp_keepalives_idle,
1806 0, 0, INT_MAX, assign_tcp_keepalives_idle, show_tcp_keepalives_idle
1810 {"tcp_keepalives_interval", PGC_USERSET, CLIENT_CONN_OTHER,
1811 gettext_noop("Time between TCP keepalive retransmits."),
1812 gettext_noop("A value of 0 uses the system default."),
1815 &tcp_keepalives_interval,
1816 0, 0, INT_MAX, assign_tcp_keepalives_interval, show_tcp_keepalives_interval
1820 {"tcp_keepalives_count", PGC_USERSET, CLIENT_CONN_OTHER,
1821 gettext_noop("Maximum number of TCP keepalive retransmits."),
1822 gettext_noop("This controls the number of consecutive keepalive retransmits that can be "
1823 "lost before a connection is considered dead. A value of 0 uses the "
1826 &tcp_keepalives_count,
1827 0, 0, INT_MAX, assign_tcp_keepalives_count, show_tcp_keepalives_count
1831 {"gin_fuzzy_search_limit", PGC_USERSET, CLIENT_CONN_OTHER,
1832 gettext_noop("Sets the maximum allowed result for exact search by GIN."),
1836 &GinFuzzySearchLimit,
1837 0, 0, INT_MAX, NULL, NULL
1841 {"effective_cache_size", PGC_USERSET, QUERY_TUNING_COST,
1842 gettext_noop("Sets the planner's assumption about the size of the disk cache."),
1843 gettext_noop("That is, the portion of the kernel's disk cache that "
1844 "will be used for PostgreSQL data files. This is measured in disk "
1845 "pages, which are normally 8 kB each."),
1848 &effective_cache_size,
1849 DEFAULT_EFFECTIVE_CACHE_SIZE, 1, INT_MAX, NULL, NULL
1853 /* Can't be set in postgresql.conf */
1854 {"server_version_num", PGC_INTERNAL, PRESET_OPTIONS,
1855 gettext_noop("Shows the server version as an integer."),
1857 GUC_NOT_IN_SAMPLE | GUC_DISALLOW_IN_FILE
1859 &server_version_num,
1860 PG_VERSION_NUM, PG_VERSION_NUM, PG_VERSION_NUM, NULL, NULL
1864 {"log_temp_files", PGC_USERSET, LOGGING_WHAT,
1865 gettext_noop("Log the use of temporary files larger than this number of kilobytes."),
1866 gettext_noop("Zero logs all files. The default is -1 (turning this feature off)."),
1870 -1, -1, INT_MAX, NULL, NULL
1874 {"track_activity_query_size", PGC_POSTMASTER, RESOURCES_MEM,
1875 gettext_noop("Sets the size reserved for pg_stat_activity.current_query, in bytes."),
1878 &pgstat_track_activity_query_size,
1879 1024, 100, 102400, NULL, NULL
1882 /* End-of-list marker */
1884 {NULL, 0, 0, NULL, NULL}, NULL, 0, 0, 0, NULL, NULL
1889 static struct config_real ConfigureNamesReal[] =
1892 {"seq_page_cost", PGC_USERSET, QUERY_TUNING_COST,
1893 gettext_noop("Sets the planner's estimate of the cost of a "
1894 "sequentially fetched disk page."),
1898 DEFAULT_SEQ_PAGE_COST, 0, DBL_MAX, NULL, NULL
1901 {"random_page_cost", PGC_USERSET, QUERY_TUNING_COST,
1902 gettext_noop("Sets the planner's estimate of the cost of a "
1903 "nonsequentially fetched disk page."),
1907 DEFAULT_RANDOM_PAGE_COST, 0, DBL_MAX, NULL, NULL
1910 {"cpu_tuple_cost", PGC_USERSET, QUERY_TUNING_COST,
1911 gettext_noop("Sets the planner's estimate of the cost of "
1912 "processing each tuple (row)."),
1916 DEFAULT_CPU_TUPLE_COST, 0, DBL_MAX, NULL, NULL
1919 {"cpu_index_tuple_cost", PGC_USERSET, QUERY_TUNING_COST,
1920 gettext_noop("Sets the planner's estimate of the cost of "
1921 "processing each index entry during an index scan."),
1924 &cpu_index_tuple_cost,
1925 DEFAULT_CPU_INDEX_TUPLE_COST, 0, DBL_MAX, NULL, NULL
1928 {"cpu_operator_cost", PGC_USERSET, QUERY_TUNING_COST,
1929 gettext_noop("Sets the planner's estimate of the cost of "
1930 "processing each operator or function call."),
1934 DEFAULT_CPU_OPERATOR_COST, 0, DBL_MAX, NULL, NULL
1938 {"cursor_tuple_fraction", PGC_USERSET, QUERY_TUNING_OTHER,
1939 gettext_noop("Sets the planner's estimate of the fraction of "
1940 "a cursor's rows that will be retrieved."),
1943 &cursor_tuple_fraction,
1944 DEFAULT_CURSOR_TUPLE_FRACTION, 0.0, 1.0, NULL, NULL
1948 {"geqo_selection_bias", PGC_USERSET, QUERY_TUNING_GEQO,
1949 gettext_noop("GEQO: selective pressure within the population."),
1952 &Geqo_selection_bias,
1953 DEFAULT_GEQO_SELECTION_BIAS, MIN_GEQO_SELECTION_BIAS,
1954 MAX_GEQO_SELECTION_BIAS, NULL, NULL
1958 {"bgwriter_lru_multiplier", PGC_SIGHUP, RESOURCES,
1959 gettext_noop("Multiple of the average buffer usage to free per round."),
1962 &bgwriter_lru_multiplier,
1963 2.0, 0.0, 10.0, NULL, NULL
1967 {"seed", PGC_USERSET, UNGROUPED,
1968 gettext_noop("Sets the seed for random-number generation."),
1970 GUC_NO_SHOW_ALL | GUC_NO_RESET_ALL | GUC_NOT_IN_SAMPLE | GUC_DISALLOW_IN_FILE
1973 0.0, -1.0, 1.0, assign_random_seed, show_random_seed
1977 {"autovacuum_vacuum_scale_factor", PGC_SIGHUP, AUTOVACUUM,
1978 gettext_noop("Number of tuple updates or deletes prior to vacuum as a fraction of reltuples."),
1981 &autovacuum_vac_scale,
1982 0.2, 0.0, 100.0, NULL, NULL
1985 {"autovacuum_analyze_scale_factor", PGC_SIGHUP, AUTOVACUUM,
1986 gettext_noop("Number of tuple inserts, updates or deletes prior to analyze as a fraction of reltuples."),
1989 &autovacuum_anl_scale,
1990 0.1, 0.0, 100.0, NULL, NULL
1994 {"checkpoint_completion_target", PGC_SIGHUP, WAL_CHECKPOINTS,
1995 gettext_noop("Time spent flushing dirty buffers during checkpoint, as fraction of checkpoint interval."),
1998 &CheckPointCompletionTarget,
1999 0.5, 0.0, 1.0, NULL, NULL
2002 /* End-of-list marker */
2004 {NULL, 0, 0, NULL, NULL}, NULL, 0.0, 0.0, 0.0, NULL, NULL
2009 static struct config_string ConfigureNamesString[] =
2012 {"archive_command", PGC_SIGHUP, WAL_SETTINGS,
2013 gettext_noop("Sets the shell command that will be called to archive a WAL file."),
2016 &XLogArchiveCommand,
2017 "", NULL, show_archive_command
2021 {"client_encoding", PGC_USERSET, CLIENT_CONN_LOCALE,
2022 gettext_noop("Sets the client's character set encoding."),
2024 GUC_IS_NAME | GUC_REPORT
2026 &client_encoding_string,
2027 "SQL_ASCII", assign_client_encoding, NULL
2031 {"log_line_prefix", PGC_SIGHUP, LOGGING_WHAT,
2032 gettext_noop("Controls information prefixed to each log line."),
2033 gettext_noop("If blank, no prefix is used.")
2040 {"log_timezone", PGC_SIGHUP, LOGGING_WHAT,
2041 gettext_noop("Sets the time zone to use in log messages."),
2044 &log_timezone_string,
2045 "UNKNOWN", assign_log_timezone, show_log_timezone
2049 {"DateStyle", PGC_USERSET, CLIENT_CONN_LOCALE,
2050 gettext_noop("Sets the display format for date and time values."),
2051 gettext_noop("Also controls interpretation of ambiguous "
2053 GUC_LIST_INPUT | GUC_REPORT
2056 "ISO, MDY", assign_datestyle, NULL
2060 {"default_tablespace", PGC_USERSET, CLIENT_CONN_STATEMENT,
2061 gettext_noop("Sets the default tablespace to create tables and indexes in."),
2062 gettext_noop("An empty string selects the database's default tablespace."),
2065 &default_tablespace,
2066 "", assign_default_tablespace, NULL
2070 {"temp_tablespaces", PGC_USERSET, CLIENT_CONN_STATEMENT,
2071 gettext_noop("Sets the tablespace(s) to use for temporary tables and sort files."),
2073 GUC_LIST_INPUT | GUC_LIST_QUOTE
2076 "", assign_temp_tablespaces, NULL
2080 {"dynamic_library_path", PGC_SUSET, CLIENT_CONN_OTHER,
2081 gettext_noop("Sets the path for dynamically loadable modules."),
2082 gettext_noop("If a dynamically loadable module needs to be opened and "
2083 "the specified name does not have a directory component (i.e., the "
2084 "name does not contain a slash), the system will search this path for "
2085 "the specified file."),
2088 &Dynamic_library_path,
2089 "$libdir", NULL, NULL
2093 {"krb_realm", PGC_POSTMASTER, CONN_AUTH_SECURITY,
2094 gettext_noop("Sets realm to match Kerberos and GSSAPI users against."),
2103 {"krb_server_keyfile", PGC_POSTMASTER, CONN_AUTH_SECURITY,
2104 gettext_noop("Sets the location of the Kerberos server key file."),
2108 &pg_krb_server_keyfile,
2109 PG_KRB_SRVTAB, NULL, NULL
2113 {"krb_srvname", PGC_POSTMASTER, CONN_AUTH_SECURITY,
2114 gettext_noop("Sets the name of the Kerberos service."),
2118 PG_KRB_SRVNAM, NULL, NULL
2122 {"krb_server_hostname", PGC_POSTMASTER, CONN_AUTH_SECURITY,
2123 gettext_noop("Sets the hostname of the Kerberos server."),
2126 &pg_krb_server_hostname,
2131 {"bonjour_name", PGC_POSTMASTER, CONN_AUTH_SETTINGS,
2132 gettext_noop("Sets the Bonjour broadcast service name."),
2139 /* See main.c about why defaults for LC_foo are not all alike */
2142 {"lc_collate", PGC_INTERNAL, CLIENT_CONN_LOCALE,
2143 gettext_noop("Shows the collation order locale."),
2145 GUC_NOT_IN_SAMPLE | GUC_DISALLOW_IN_FILE
2152 {"lc_ctype", PGC_INTERNAL, CLIENT_CONN_LOCALE,
2153 gettext_noop("Shows the character classification and case conversion locale."),
2155 GUC_NOT_IN_SAMPLE | GUC_DISALLOW_IN_FILE
2162 {"lc_messages", PGC_SUSET, CLIENT_CONN_LOCALE,
2163 gettext_noop("Sets the language in which messages are displayed."),
2167 "", locale_messages_assign, NULL
2171 {"lc_monetary", PGC_USERSET, CLIENT_CONN_LOCALE,
2172 gettext_noop("Sets the locale for formatting monetary amounts."),
2176 "C", locale_monetary_assign, NULL
2180 {"lc_numeric", PGC_USERSET, CLIENT_CONN_LOCALE,
2181 gettext_noop("Sets the locale for formatting numbers."),
2185 "C", locale_numeric_assign, NULL
2189 {"lc_time", PGC_USERSET, CLIENT_CONN_LOCALE,
2190 gettext_noop("Sets the locale for formatting date and time values."),
2194 "C", locale_time_assign, NULL
2198 {"shared_preload_libraries", PGC_POSTMASTER, RESOURCES_KERNEL,
2199 gettext_noop("Lists shared libraries to preload into server."),
2201 GUC_LIST_INPUT | GUC_LIST_QUOTE | GUC_SUPERUSER_ONLY
2203 &shared_preload_libraries_string,
2208 {"local_preload_libraries", PGC_BACKEND, CLIENT_CONN_OTHER,
2209 gettext_noop("Lists shared libraries to preload into each backend."),
2211 GUC_LIST_INPUT | GUC_LIST_QUOTE
2213 &local_preload_libraries_string,
2218 {"search_path", PGC_USERSET, CLIENT_CONN_STATEMENT,
2219 gettext_noop("Sets the schema search order for names that are not schema-qualified."),
2221 GUC_LIST_INPUT | GUC_LIST_QUOTE
2223 &namespace_search_path,
2224 "\"$user\",public", assign_search_path, NULL
2228 /* Can't be set in postgresql.conf */
2229 {"server_encoding", PGC_INTERNAL, CLIENT_CONN_LOCALE,
2230 gettext_noop("Sets the server (database) character set encoding."),
2232 GUC_IS_NAME | GUC_REPORT | GUC_NOT_IN_SAMPLE | GUC_DISALLOW_IN_FILE
2234 &server_encoding_string,
2235 "SQL_ASCII", NULL, NULL
2239 /* Can't be set in postgresql.conf */
2240 {"server_version", PGC_INTERNAL, PRESET_OPTIONS,
2241 gettext_noop("Shows the server version."),
2243 GUC_REPORT | GUC_NOT_IN_SAMPLE | GUC_DISALLOW_IN_FILE
2245 &server_version_string,
2246 PG_VERSION, NULL, NULL
2250 /* Not for general use --- used by SET ROLE */
2251 {"role", PGC_USERSET, UNGROUPED,
2252 gettext_noop("Sets the current role."),
2254 GUC_IS_NAME | GUC_NO_SHOW_ALL | GUC_NO_RESET_ALL | GUC_NOT_IN_SAMPLE | GUC_DISALLOW_IN_FILE
2257 "none", assign_role, show_role
2261 /* Not for general use --- used by SET SESSION AUTHORIZATION */
2262 {"session_authorization", PGC_USERSET, UNGROUPED,
2263 gettext_noop("Sets the session user name."),
2265 GUC_IS_NAME | GUC_REPORT | GUC_NO_SHOW_ALL | GUC_NO_RESET_ALL | GUC_NOT_IN_SAMPLE | GUC_DISALLOW_IN_FILE
2267 &session_authorization_string,
2268 NULL, assign_session_authorization, show_session_authorization
2272 {"log_destination", PGC_SIGHUP, LOGGING_WHERE,
2273 gettext_noop("Sets the destination for server log output."),
2274 gettext_noop("Valid values are combinations of \"stderr\", "
2275 "\"syslog\", \"csvlog\", and \"eventlog\", "
2276 "depending on the platform."),
2279 &log_destination_string,
2280 "stderr", assign_log_destination, NULL
2283 {"log_directory", PGC_SIGHUP, LOGGING_WHERE,
2284 gettext_noop("Sets the destination directory for log files."),
2285 gettext_noop("Can be specified as relative to the data directory "
2286 "or as absolute path."),
2290 "pg_log", assign_canonical_path, NULL
2293 {"log_filename", PGC_SIGHUP, LOGGING_WHERE,
2294 gettext_noop("Sets the file name pattern for log files."),
2299 "postgresql-%Y-%m-%d_%H%M%S.log", NULL, NULL
2304 {"syslog_ident", PGC_SIGHUP, LOGGING_WHERE,
2305 gettext_noop("Sets the program name used to identify PostgreSQL "
2306 "messages in syslog."),
2310 "postgres", assign_syslog_ident, NULL
2315 {"TimeZone", PGC_USERSET, CLIENT_CONN_LOCALE,
2316 gettext_noop("Sets the time zone for displaying and interpreting time stamps."),
2321 "UNKNOWN", assign_timezone, show_timezone
2324 {"timezone_abbreviations", PGC_USERSET, CLIENT_CONN_LOCALE,
2325 gettext_noop("Selects a file of time zone abbreviations."),
2328 &timezone_abbreviations_string,
2329 "UNKNOWN", assign_timezone_abbreviations, NULL
2333 {"transaction_isolation", PGC_USERSET, CLIENT_CONN_STATEMENT,
2334 gettext_noop("Sets the current transaction's isolation level."),
2336 GUC_NO_RESET_ALL | GUC_NOT_IN_SAMPLE | GUC_DISALLOW_IN_FILE
2338 &XactIsoLevel_string,
2339 NULL, assign_XactIsoLevel, show_XactIsoLevel
2343 {"unix_socket_group", PGC_POSTMASTER, CONN_AUTH_SETTINGS,
2344 gettext_noop("Sets the owning group of the Unix-domain socket."),
2345 gettext_noop("The owning user of the socket is always the user "
2346 "that starts the server.")
2353 {"unix_socket_directory", PGC_POSTMASTER, CONN_AUTH_SETTINGS,
2354 gettext_noop("Sets the directory where the Unix-domain socket will be created."),
2359 "", assign_canonical_path, NULL
2363 {"listen_addresses", PGC_POSTMASTER, CONN_AUTH_SETTINGS,
2364 gettext_noop("Sets the host name or IP address(es) to listen to."),
2369 "localhost", NULL, NULL
2373 {"custom_variable_classes", PGC_SIGHUP, CUSTOM_OPTIONS,
2374 gettext_noop("Sets the list of known custom variable classes."),
2376 GUC_LIST_INPUT | GUC_LIST_QUOTE
2378 &custom_variable_classes,
2379 NULL, assign_custom_variable_classes, NULL
2383 {"data_directory", PGC_POSTMASTER, FILE_LOCATIONS,
2384 gettext_noop("Sets the server's data directory."),
2393 {"config_file", PGC_POSTMASTER, FILE_LOCATIONS,
2394 gettext_noop("Sets the server's main configuration file."),
2396 GUC_DISALLOW_IN_FILE | GUC_SUPERUSER_ONLY
2403 {"hba_file", PGC_POSTMASTER, FILE_LOCATIONS,
2404 gettext_noop("Sets the server's \"hba\" configuration file."),
2413 {"ident_file", PGC_POSTMASTER, FILE_LOCATIONS,
2414 gettext_noop("Sets the server's \"ident\" configuration file."),
2423 {"external_pid_file", PGC_POSTMASTER, FILE_LOCATIONS,
2424 gettext_noop("Writes the postmaster PID to the specified file."),
2429 NULL, assign_canonical_path, NULL
2433 {"default_text_search_config", PGC_USERSET, CLIENT_CONN_LOCALE,
2434 gettext_noop("Sets default text search configuration."),
2438 "pg_catalog.simple", assignTSCurrentConfig, NULL
2443 {"ssl_ciphers", PGC_POSTMASTER, CONN_AUTH_SECURITY,
2444 gettext_noop("Sets the list of allowed SSL ciphers."),
2449 "ALL:!ADH:!LOW:!EXP:!MD5:@STRENGTH", NULL, NULL
2451 #endif /* USE_SSL */
2453 /* End-of-list marker */
2455 {NULL, 0, 0, NULL, NULL}, NULL, NULL, NULL, NULL
2460 static struct config_enum ConfigureNamesEnum[] =
2463 {"backslash_quote", PGC_USERSET, COMPAT_OPTIONS_PREVIOUS,
2464 gettext_noop("Sets whether \"\\'\" is allowed in string literals."),
2468 BACKSLASH_QUOTE_SAFE_ENCODING, backslash_quote_options, NULL, NULL
2472 {"client_min_messages", PGC_USERSET, LOGGING_WHEN,
2473 gettext_noop("Sets the message levels that are sent to the client."),
2474 gettext_noop("Each level includes all the levels that follow it. The later"
2475 " the level, the fewer messages are sent.")
2477 &client_min_messages,
2478 NOTICE, client_message_level_options, NULL, NULL
2482 {"default_transaction_isolation", PGC_USERSET, CLIENT_CONN_STATEMENT,
2483 gettext_noop("Sets the transaction isolation level of each new transaction."),
2486 &DefaultXactIsoLevel,
2487 XACT_READ_COMMITTED, isolation_level_options, NULL, NULL
2491 {"log_error_verbosity", PGC_SUSET, LOGGING_WHEN,
2492 gettext_noop("Sets the verbosity of logged messages."),
2495 &Log_error_verbosity,
2496 PGERROR_DEFAULT, log_error_verbosity_options, NULL, NULL
2500 {"log_min_messages", PGC_SUSET, LOGGING_WHEN,
2501 gettext_noop("Sets the message levels that are logged."),
2502 gettext_noop("Each level includes all the levels that follow it. The later"
2503 " the level, the fewer messages are sent.")
2506 WARNING, server_message_level_options, NULL, NULL
2510 {"log_min_error_statement", PGC_SUSET, LOGGING_WHEN,
2511 gettext_noop("Causes all statements generating error at or above this level to be logged."),
2512 gettext_noop("Each level includes all the levels that follow it. The later"
2513 " the level, the fewer messages are sent.")
2515 &log_min_error_statement,
2516 ERROR, server_message_level_options, NULL, NULL
2520 {"log_statement", PGC_SUSET, LOGGING_WHAT,
2521 gettext_noop("Sets the type of statements logged."),
2525 LOGSTMT_NONE, log_statement_options, NULL, NULL
2530 {"syslog_facility", PGC_SIGHUP, LOGGING_WHERE,
2531 gettext_noop("Sets the syslog \"facility\" to be used when syslog enabled."),
2535 LOG_LOCAL0, syslog_facility_options, assign_syslog_facility, NULL
2540 {"regex_flavor", PGC_USERSET, COMPAT_OPTIONS_PREVIOUS,
2541 gettext_noop("Sets the regular expression \"flavor\"."),
2545 REG_ADVANCED, regex_flavor_options, NULL, NULL
2549 {"session_replication_role", PGC_SUSET, CLIENT_CONN_STATEMENT,
2550 gettext_noop("Sets the session's behavior for triggers and rewrite rules."),
2553 &SessionReplicationRole,
2554 SESSION_REPLICATION_ROLE_ORIGIN, session_replication_role_options,
2555 assign_session_replication_role, NULL
2559 {"track_functions", PGC_SUSET, STATS_COLLECTOR,
2560 gettext_noop("Collects function-level statistics on database activity."),
2563 &pgstat_track_functions,
2564 TRACK_FUNC_OFF, track_function_options, NULL, NULL
2568 {"wal_sync_method", PGC_SIGHUP, WAL_SETTINGS,
2569 gettext_noop("Selects the method used for forcing WAL updates to disk."),
2573 DEFAULT_SYNC_METHOD, sync_method_options,
2574 assign_xlog_sync_method, NULL
2578 {"xmlbinary", PGC_USERSET, CLIENT_CONN_STATEMENT,
2579 gettext_noop("Sets how binary values are to be encoded in XML."),
2583 XMLBINARY_BASE64, xmlbinary_options, NULL, NULL
2587 {"xmloption", PGC_USERSET, CLIENT_CONN_STATEMENT,
2588 gettext_noop("Sets whether XML data in implicit parsing and serialization "
2589 "operations is to be considered as documents or content fragments."),
2593 XMLOPTION_CONTENT, xmloption_options, NULL, NULL
2597 /* End-of-list marker */
2599 {NULL, 0, 0, NULL, NULL}, NULL, 0, NULL, NULL, NULL
2603 /******** end of options list ********/
2607 * To allow continued support of obsolete names for GUC variables, we apply
2608 * the following mappings to any unrecognized name. Note that an old name
2609 * should be mapped to a new one only if the new variable has very similar
2610 * semantics to the old.
2612 static const char *const map_old_guc_names[] = {
2613 "sort_mem", "work_mem",
2614 "vacuum_mem", "maintenance_work_mem",
2620 * Actual lookup of variables is done through this single, sorted array.
2622 static struct config_generic **guc_variables;
2624 /* Current number of variables contained in the vector */
2625 static int num_guc_variables;
2627 /* Vector capacity */
2628 static int size_guc_variables;
2631 static bool guc_dirty; /* TRUE if need to do commit/abort work */
2633 static bool reporting_enabled; /* TRUE to enable GUC_REPORT */
2635 static int GUCNestLevel = 0; /* 1 when in main transaction */
2638 static int guc_var_compare(const void *a, const void *b);
2639 static int guc_name_compare(const char *namea, const char *nameb);
2640 static void push_old_value(struct config_generic * gconf, GucAction action);
2641 static void ReportGUCOption(struct config_generic * record);
2642 static void ShowGUCConfigOption(const char *name, DestReceiver *dest);
2643 static void ShowAllGUCConfig(DestReceiver *dest);
2644 static char *_ShowOption(struct config_generic * record, bool use_units);
2645 static bool is_newvalue_equal(struct config_generic * record, const char *newvalue);
2649 * Some infrastructure for checking malloc/strdup/realloc calls
2652 guc_malloc(int elevel, size_t size)
2656 data = malloc(size);
2659 (errcode(ERRCODE_OUT_OF_MEMORY),
2660 errmsg("out of memory")));
2665 guc_realloc(int elevel, void *old, size_t size)
2669 data = realloc(old, size);
2672 (errcode(ERRCODE_OUT_OF_MEMORY),
2673 errmsg("out of memory")));
2678 guc_strdup(int elevel, const char *src)
2685 (errcode(ERRCODE_OUT_OF_MEMORY),
2686 errmsg("out of memory")));
2692 * Support for assigning to a field of a string GUC item. Free the prior
2693 * value if it's not referenced anywhere else in the item (including stacked
2697 set_string_field(struct config_string * conf, char **field, char *newval)
2699 char *oldval = *field;
2702 /* Do the assignment */
2705 /* Exit if any duplicate references, or if old value was NULL anyway */
2706 if (oldval == NULL ||
2707 oldval == *(conf->variable) ||
2708 oldval == conf->reset_val ||
2709 oldval == conf->boot_val)
2711 for (stack = conf->gen.stack; stack; stack = stack->prev)
2713 if (oldval == stack->prior.stringval ||
2714 oldval == stack->masked.stringval)
2718 /* Not used anymore, so free it */
2723 * Detect whether strval is referenced anywhere in a GUC string item
2726 string_field_used(struct config_string * conf, char *strval)
2730 if (strval == *(conf->variable) ||
2731 strval == conf->reset_val ||
2732 strval == conf->boot_val)
2734 for (stack = conf->gen.stack; stack; stack = stack->prev)
2736 if (strval == stack->prior.stringval ||
2737 strval == stack->masked.stringval)
2744 * Support for copying a variable's active value into a stack entry
2747 set_stack_value(struct config_generic * gconf, union config_var_value * val)
2749 switch (gconf->vartype)
2753 *((struct config_bool *) gconf)->variable;
2757 *((struct config_int *) gconf)->variable;
2761 *((struct config_real *) gconf)->variable;
2764 /* we assume stringval is NULL if not valid */
2765 set_string_field((struct config_string *) gconf,
2767 *((struct config_string *) gconf)->variable);
2771 *((struct config_enum *) gconf)->variable;
2777 * Support for discarding a no-longer-needed value in a stack entry
2780 discard_stack_value(struct config_generic * gconf, union config_var_value * val)
2782 switch (gconf->vartype)
2788 /* no need to do anything */
2791 set_string_field((struct config_string *) gconf,
2800 * Fetch the sorted array pointer (exported for help_config.c's use ONLY)
2802 struct config_generic **
2803 get_guc_variables(void)
2805 return guc_variables;
2810 * Build the sorted array. This is split out so that it could be
2811 * re-executed after startup (eg, we could allow loadable modules to
2812 * add vars, and then we'd need to re-sort).
2815 build_guc_variables(void)
2819 struct config_generic **guc_vars;
2822 for (i = 0; ConfigureNamesBool[i].gen.name; i++)
2824 struct config_bool *conf = &ConfigureNamesBool[i];
2826 /* Rather than requiring vartype to be filled in by hand, do this: */
2827 conf->gen.vartype = PGC_BOOL;
2831 for (i = 0; ConfigureNamesInt[i].gen.name; i++)
2833 struct config_int *conf = &ConfigureNamesInt[i];
2835 conf->gen.vartype = PGC_INT;
2839 for (i = 0; ConfigureNamesReal[i].gen.name; i++)
2841 struct config_real *conf = &ConfigureNamesReal[i];
2843 conf->gen.vartype = PGC_REAL;
2847 for (i = 0; ConfigureNamesString[i].gen.name; i++)
2849 struct config_string *conf = &ConfigureNamesString[i];
2851 conf->gen.vartype = PGC_STRING;
2855 for (i = 0; ConfigureNamesEnum[i].gen.name; i++)
2857 struct config_enum *conf = &ConfigureNamesEnum[i];
2859 conf->gen.vartype = PGC_ENUM;
2864 * Create table with 20% slack
2866 size_vars = num_vars + num_vars / 4;
2868 guc_vars = (struct config_generic **)
2869 guc_malloc(FATAL, size_vars * sizeof(struct config_generic *));
2873 for (i = 0; ConfigureNamesBool[i].gen.name; i++)
2874 guc_vars[num_vars++] = &ConfigureNamesBool[i].gen;
2876 for (i = 0; ConfigureNamesInt[i].gen.name; i++)
2877 guc_vars[num_vars++] = &ConfigureNamesInt[i].gen;
2879 for (i = 0; ConfigureNamesReal[i].gen.name; i++)
2880 guc_vars[num_vars++] = &ConfigureNamesReal[i].gen;
2882 for (i = 0; ConfigureNamesString[i].gen.name; i++)
2883 guc_vars[num_vars++] = &ConfigureNamesString[i].gen;
2885 for (i = 0; ConfigureNamesEnum[i].gen.name; i++)
2886 guc_vars[num_vars++] = &ConfigureNamesEnum[i].gen;
2889 free(guc_variables);
2890 guc_variables = guc_vars;
2891 num_guc_variables = num_vars;
2892 size_guc_variables = size_vars;
2893 qsort((void *) guc_variables, num_guc_variables,
2894 sizeof(struct config_generic *), guc_var_compare);
2898 * Add a new GUC variable to the list of known variables. The
2899 * list is expanded if needed.
2902 add_guc_variable(struct config_generic * var, int elevel)
2904 if (num_guc_variables + 1 >= size_guc_variables)
2907 * Increase the vector by 25%
2909 int size_vars = size_guc_variables + size_guc_variables / 4;
2910 struct config_generic **guc_vars;
2915 guc_vars = (struct config_generic **)
2916 guc_malloc(elevel, size_vars * sizeof(struct config_generic *));
2920 guc_vars = (struct config_generic **)
2921 guc_realloc(elevel, guc_variables, size_vars * sizeof(struct config_generic *));
2924 if (guc_vars == NULL)
2925 return false; /* out of memory */
2927 guc_variables = guc_vars;
2928 size_guc_variables = size_vars;
2930 guc_variables[num_guc_variables++] = var;
2931 qsort((void *) guc_variables, num_guc_variables,
2932 sizeof(struct config_generic *), guc_var_compare);
2937 * Create and add a placeholder variable. It's presumed to belong
2938 * to a valid custom variable class at this point.
2940 static struct config_generic *
2941 add_placeholder_variable(const char *name, int elevel)
2943 size_t sz = sizeof(struct config_string) + sizeof(char *);
2944 struct config_string *var;
2945 struct config_generic *gen;
2947 var = (struct config_string *) guc_malloc(elevel, sz);
2953 gen->name = guc_strdup(elevel, name);
2954 if (gen->name == NULL)
2960 gen->context = PGC_USERSET;
2961 gen->group = CUSTOM_OPTIONS;
2962 gen->short_desc = "GUC placeholder variable";
2963 gen->flags = GUC_NO_SHOW_ALL | GUC_NOT_IN_SAMPLE | GUC_CUSTOM_PLACEHOLDER;
2964 gen->vartype = PGC_STRING;
2967 * The char* is allocated at the end of the struct since we have no
2968 * 'static' place to point to. Note that the current value, as well as
2969 * the boot and reset values, start out NULL.
2971 var->variable = (char **) (var + 1);
2973 if (!add_guc_variable((struct config_generic *) var, elevel))
2975 free((void *) gen->name);
2984 * Detect whether the portion of "name" before dotPos matches any custom
2985 * variable class name listed in custom_var_classes. The latter must be
2986 * formatted the way that assign_custom_variable_classes does it, ie,
2987 * no whitespace. NULL is valid for custom_var_classes.
2990 is_custom_class(const char *name, int dotPos, const char *custom_var_classes)
2992 bool result = false;
2993 const char *ccs = custom_var_classes;
2997 const char *start = ccs;
3003 if (c == '\0' || c == ',')
3005 if (dotPos == ccs - start && strncmp(start, name, dotPos) == 0)
3020 * Look up option NAME. If it exists, return a pointer to its record,
3021 * else return NULL. If create_placeholders is TRUE, we'll create a
3022 * placeholder record for a valid-looking custom variable name.
3024 static struct config_generic *
3025 find_option(const char *name, bool create_placeholders, int elevel)
3027 const char **key = &name;
3028 struct config_generic **res;
3034 * By equating const char ** with struct config_generic *, we are assuming
3035 * the name field is first in config_generic.
3037 res = (struct config_generic **) bsearch((void *) &key,
3038 (void *) guc_variables,
3040 sizeof(struct config_generic *),
3046 * See if the name is an obsolete name for a variable. We assume that the
3047 * set of supported old names is short enough that a brute-force search is
3050 for (i = 0; map_old_guc_names[i] != NULL; i += 2)
3052 if (guc_name_compare(name, map_old_guc_names[i]) == 0)
3053 return find_option(map_old_guc_names[i + 1], false, elevel);
3056 if (create_placeholders)
3059 * Check if the name is qualified, and if so, check if the qualifier
3060 * matches any custom variable class. If so, add a placeholder.
3062 const char *dot = strchr(name, GUC_QUALIFIER_SEPARATOR);
3065 is_custom_class(name, dot - name, custom_variable_classes))
3066 return add_placeholder_variable(name, elevel);
3075 * comparator for qsorting and bsearching guc_variables array
3078 guc_var_compare(const void *a, const void *b)
3080 struct config_generic *confa = *(struct config_generic **) a;
3081 struct config_generic *confb = *(struct config_generic **) b;
3083 return guc_name_compare(confa->name, confb->name);
3087 * the bare comparison function for GUC names
3090 guc_name_compare(const char *namea, const char *nameb)
3093 * The temptation to use strcasecmp() here must be resisted, because the
3094 * array ordering has to remain stable across setlocale() calls. So, build
3095 * our own with a simple ASCII-only downcasing.
3097 while (*namea && *nameb)
3099 char cha = *namea++;
3100 char chb = *nameb++;
3102 if (cha >= 'A' && cha <= 'Z')
3104 if (chb >= 'A' && chb <= 'Z')
3110 return 1; /* a is longer */
3112 return -1; /* b is longer */
3118 * Initialize GUC options during program startup.
3120 * Note that we cannot read the config file yet, since we have not yet
3121 * processed command-line switches.
3124 InitializeGUCOptions(void)
3131 * Before log_line_prefix could possibly receive a nonempty setting, make
3132 * sure that timezone processing is minimally alive (see elog.c).
3134 pg_timezone_pre_initialize();
3137 * Build sorted array of all GUC variables.
3139 build_guc_variables();
3142 * Load all variables with their compiled-in defaults, and initialize
3143 * status fields as needed.
3145 for (i = 0; i < num_guc_variables; i++)
3147 struct config_generic *gconf = guc_variables[i];
3150 gconf->reset_source = PGC_S_DEFAULT;
3151 gconf->source = PGC_S_DEFAULT;
3152 gconf->stack = NULL;
3154 switch (gconf->vartype)
3158 struct config_bool *conf = (struct config_bool *) gconf;
3160 if (conf->assign_hook)
3161 if (!(*conf->assign_hook) (conf->boot_val, true,
3163 elog(FATAL, "failed to initialize %s to %d",
3164 conf->gen.name, (int) conf->boot_val);
3165 *conf->variable = conf->reset_val = conf->boot_val;
3170 struct config_int *conf = (struct config_int *) gconf;
3172 Assert(conf->boot_val >= conf->min);
3173 Assert(conf->boot_val <= conf->max);
3174 if (conf->assign_hook)
3175 if (!(*conf->assign_hook) (conf->boot_val, true,
3177 elog(FATAL, "failed to initialize %s to %d",
3178 conf->gen.name, conf->boot_val);
3179 *conf->variable = conf->reset_val = conf->boot_val;
3184 struct config_real *conf = (struct config_real *) gconf;
3186 Assert(conf->boot_val >= conf->min);
3187 Assert(conf->boot_val <= conf->max);
3188 if (conf->assign_hook)
3189 if (!(*conf->assign_hook) (conf->boot_val, true,
3191 elog(FATAL, "failed to initialize %s to %g",
3192 conf->gen.name, conf->boot_val);
3193 *conf->variable = conf->reset_val = conf->boot_val;
3198 struct config_string *conf = (struct config_string *) gconf;
3201 *conf->variable = NULL;
3202 conf->reset_val = NULL;
3204 if (conf->boot_val == NULL)
3206 /* leave the value NULL, do not call assign hook */
3210 str = guc_strdup(FATAL, conf->boot_val);
3211 conf->reset_val = str;
3213 if (conf->assign_hook)
3217 newstr = (*conf->assign_hook) (str, true,
3221 elog(FATAL, "failed to initialize %s to \"%s\"",
3222 conf->gen.name, str);
3224 else if (newstr != str)
3229 * See notes in set_config_option about casting
3231 str = (char *) newstr;
3232 conf->reset_val = str;
3235 *conf->variable = str;
3240 struct config_enum *conf = (struct config_enum *) gconf;
3242 if (conf->assign_hook)
3243 if (!(*conf->assign_hook) (conf->boot_val, true,
3245 elog(FATAL, "failed to initialize %s to %s",
3247 config_enum_lookup_by_value(conf, conf->boot_val));
3248 *conf->variable = conf->reset_val = conf->boot_val;
3256 reporting_enabled = false;
3259 * Prevent any attempt to override the transaction modes from
3260 * non-interactive sources.
3262 SetConfigOption("transaction_isolation", "default",
3263 PGC_POSTMASTER, PGC_S_OVERRIDE);
3264 SetConfigOption("transaction_read_only", "no",
3265 PGC_POSTMASTER, PGC_S_OVERRIDE);
3268 * For historical reasons, some GUC parameters can receive defaults from
3269 * environment variables. Process those settings. NB: if you add or
3270 * remove anything here, see also ProcessConfigFile().
3273 env = getenv("PGPORT");
3275 SetConfigOption("port", env, PGC_POSTMASTER, PGC_S_ENV_VAR);
3277 env = getenv("PGDATESTYLE");
3279 SetConfigOption("datestyle", env, PGC_POSTMASTER, PGC_S_ENV_VAR);
3281 env = getenv("PGCLIENTENCODING");
3283 SetConfigOption("client_encoding", env, PGC_POSTMASTER, PGC_S_ENV_VAR);
3286 * rlimit isn't exactly an "environment variable", but it behaves about
3287 * the same. If we can identify the platform stack depth rlimit, increase
3288 * default stack depth setting up to whatever is safe (but at most 2MB).
3290 stack_rlimit = get_stack_depth_rlimit();
3291 if (stack_rlimit > 0)
3293 int new_limit = (stack_rlimit - STACK_DEPTH_SLOP) / 1024L;
3295 if (new_limit > 100)
3299 new_limit = Min(new_limit, 2048);
3300 sprintf(limbuf, "%d", new_limit);
3301 SetConfigOption("max_stack_depth", limbuf,
3302 PGC_POSTMASTER, PGC_S_ENV_VAR);
3309 * Select the configuration files and data directory to be used, and
3310 * do the initial read of postgresql.conf.
3312 * This is called after processing command-line switches.
3313 * userDoption is the -D switch value if any (NULL if unspecified).
3314 * progname is just for use in error messages.
3316 * Returns true on success; on failure, prints a suitable error message
3317 * to stderr and returns false.
3320 SelectConfigFiles(const char *userDoption, const char *progname)
3324 struct stat stat_buf;
3326 /* configdir is -D option, or $PGDATA if no -D */
3328 configdir = make_absolute_path(userDoption);
3330 configdir = make_absolute_path(getenv("PGDATA"));
3333 * Find the configuration file: if config_file was specified on the
3334 * command line, use it, else use configdir/postgresql.conf. In any case
3335 * ensure the result is an absolute path, so that it will be interpreted
3336 * the same way by future backends.
3339 fname = make_absolute_path(ConfigFileName);
3342 fname = guc_malloc(FATAL,
3343 strlen(configdir) + strlen(CONFIG_FILENAME) + 2);
3344 sprintf(fname, "%s/%s", configdir, CONFIG_FILENAME);
3348 write_stderr("%s does not know where to find the server configuration file.\n"
3349 "You must specify the --config-file or -D invocation "
3350 "option or set the PGDATA environment variable.\n",
3356 * Set the ConfigFileName GUC variable to its final value, ensuring that
3357 * it can't be overridden later.
3359 SetConfigOption("config_file", fname, PGC_POSTMASTER, PGC_S_OVERRIDE);
3363 * Now read the config file for the first time.
3365 if (stat(ConfigFileName, &stat_buf) != 0)
3367 write_stderr("%s cannot access the server configuration file \"%s\": %s\n",
3368 progname, ConfigFileName, strerror(errno));
3372 ProcessConfigFile(PGC_POSTMASTER);
3375 * If the data_directory GUC variable has been set, use that as DataDir;
3376 * otherwise use configdir if set; else punt.
3378 * Note: SetDataDir will copy and absolute-ize its argument, so we don't
3382 SetDataDir(data_directory);
3384 SetDataDir(configdir);
3387 write_stderr("%s does not know where to find the database system data.\n"
3388 "This can be specified as \"data_directory\" in \"%s\", "
3389 "or by the -D invocation option, or by the "
3390 "PGDATA environment variable.\n",
3391 progname, ConfigFileName);
3396 * Reflect the final DataDir value back into the data_directory GUC var.
3397 * (If you are wondering why we don't just make them a single variable,
3398 * it's because the EXEC_BACKEND case needs DataDir to be transmitted to
3399 * child backends specially. XXX is that still true? Given that we now
3400 * chdir to DataDir, EXEC_BACKEND can read the config file without knowing
3401 * DataDir in advance.)
3403 SetConfigOption("data_directory", DataDir, PGC_POSTMASTER, PGC_S_OVERRIDE);
3406 * Figure out where pg_hba.conf is, and make sure the path is absolute.
3409 fname = make_absolute_path(HbaFileName);
3412 fname = guc_malloc(FATAL,
3413 strlen(configdir) + strlen(HBA_FILENAME) + 2);
3414 sprintf(fname, "%s/%s", configdir, HBA_FILENAME);
3418 write_stderr("%s does not know where to find the \"hba\" configuration file.\n"
3419 "This can be specified as \"hba_file\" in \"%s\", "
3420 "or by the -D invocation option, or by the "
3421 "PGDATA environment variable.\n",
3422 progname, ConfigFileName);
3425 SetConfigOption("hba_file", fname, PGC_POSTMASTER, PGC_S_OVERRIDE);
3429 * Likewise for pg_ident.conf.
3432 fname = make_absolute_path(IdentFileName);
3435 fname = guc_malloc(FATAL,
3436 strlen(configdir) + strlen(IDENT_FILENAME) + 2);
3437 sprintf(fname, "%s/%s", configdir, IDENT_FILENAME);
3441 write_stderr("%s does not know where to find the \"ident\" configuration file.\n"
3442 "This can be specified as \"ident_file\" in \"%s\", "
3443 "or by the -D invocation option, or by the "
3444 "PGDATA environment variable.\n",
3445 progname, ConfigFileName);
3448 SetConfigOption("ident_file", fname, PGC_POSTMASTER, PGC_S_OVERRIDE);
3458 * Reset all options to their saved default values (implements RESET ALL)
3461 ResetAllOptions(void)
3465 for (i = 0; i < num_guc_variables; i++)
3467 struct config_generic *gconf = guc_variables[i];
3469 /* Don't reset non-SET-able values */
3470 if (gconf->context != PGC_SUSET &&
3471 gconf->context != PGC_USERSET)
3473 /* Don't reset if special exclusion from RESET ALL */
3474 if (gconf->flags & GUC_NO_RESET_ALL)
3476 /* No need to reset if wasn't SET */
3477 if (gconf->source <= PGC_S_OVERRIDE)
3480 /* Save old value to support transaction abort */
3481 push_old_value(gconf, GUC_ACTION_SET);
3483 switch (gconf->vartype)
3487 struct config_bool *conf = (struct config_bool *) gconf;
3489 if (conf->assign_hook)
3490 if (!(*conf->assign_hook) (conf->reset_val, true,
3492 elog(ERROR, "failed to reset %s", conf->gen.name);
3493 *conf->variable = conf->reset_val;
3494 conf->gen.source = conf->gen.reset_source;
3499 struct config_int *conf = (struct config_int *) gconf;
3501 if (conf->assign_hook)
3502 if (!(*conf->assign_hook) (conf->reset_val, true,
3504 elog(ERROR, "failed to reset %s", conf->gen.name);
3505 *conf->variable = conf->reset_val;
3506 conf->gen.source = conf->gen.reset_source;
3511 struct config_real *conf = (struct config_real *) gconf;
3513 if (conf->assign_hook)
3514 if (!(*conf->assign_hook) (conf->reset_val, true,
3516 elog(ERROR, "failed to reset %s", conf->gen.name);
3517 *conf->variable = conf->reset_val;
3518 conf->gen.source = conf->gen.reset_source;
3523 struct config_string *conf = (struct config_string *) gconf;
3526 /* We need not strdup here */
3527 str = conf->reset_val;
3529 if (conf->assign_hook && str)
3533 newstr = (*conf->assign_hook) (str, true,
3536 elog(ERROR, "failed to reset %s", conf->gen.name);
3537 else if (newstr != str)
3540 * See notes in set_config_option about casting
3542 str = (char *) newstr;
3546 set_string_field(conf, conf->variable, str);
3547 conf->gen.source = conf->gen.reset_source;
3552 struct config_enum *conf = (struct config_enum *) gconf;
3554 if (conf->assign_hook)
3555 if (!(*conf->assign_hook) (conf->reset_val, true,
3557 elog(ERROR, "failed to reset %s", conf->gen.name);
3558 *conf->variable = conf->reset_val;
3559 conf->gen.source = conf->gen.reset_source;
3564 if (gconf->flags & GUC_REPORT)
3565 ReportGUCOption(gconf);
3572 * Push previous state during transactional assignment to a GUC variable.
3575 push_old_value(struct config_generic * gconf, GucAction action)
3579 /* If we're not inside a nest level, do nothing */
3580 if (GUCNestLevel == 0)
3583 /* Do we already have a stack entry of the current nest level? */
3584 stack = gconf->stack;
3585 if (stack && stack->nest_level >= GUCNestLevel)
3587 /* Yes, so adjust its state if necessary */
3588 Assert(stack->nest_level == GUCNestLevel);
3591 case GUC_ACTION_SET:
3592 /* SET overrides any prior action at same nest level */
3593 if (stack->state == GUC_SET_LOCAL)
3595 /* must discard old masked value */
3596 discard_stack_value(gconf, &stack->masked);
3598 stack->state = GUC_SET;
3600 case GUC_ACTION_LOCAL:
3601 if (stack->state == GUC_SET)
3603 /* SET followed by SET LOCAL, remember SET's value */
3604 set_stack_value(gconf, &stack->masked);
3605 stack->state = GUC_SET_LOCAL;
3607 /* in all other cases, no change to stack entry */
3609 case GUC_ACTION_SAVE:
3610 /* Could only have a prior SAVE of same variable */
3611 Assert(stack->state == GUC_SAVE);
3614 Assert(guc_dirty); /* must be set already */
3619 * Push a new stack entry
3621 * We keep all the stack entries in TopTransactionContext for simplicity.
3623 stack = (GucStack *) MemoryContextAllocZero(TopTransactionContext,
3626 stack->prev = gconf->stack;
3627 stack->nest_level = GUCNestLevel;
3630 case GUC_ACTION_SET:
3631 stack->state = GUC_SET;
3633 case GUC_ACTION_LOCAL:
3634 stack->state = GUC_LOCAL;
3636 case GUC_ACTION_SAVE:
3637 stack->state = GUC_SAVE;
3640 stack->source = gconf->source;
3641 set_stack_value(gconf, &stack->prior);
3643 gconf->stack = stack;
3645 /* Ensure we remember to pop at end of xact */
3651 * Do GUC processing at main transaction start.
3657 * The nest level should be 0 between transactions; if it isn't, somebody
3658 * didn't call AtEOXact_GUC, or called it with the wrong nestLevel. We
3659 * throw a warning but make no other effort to clean up.
3661 if (GUCNestLevel != 0)
3662 elog(WARNING, "GUC nest level = %d at transaction start",
3668 * Enter a new nesting level for GUC values. This is called at subtransaction
3669 * start and when entering a function that has proconfig settings. NOTE that
3670 * we must not risk error here, else subtransaction start will be unhappy.
3673 NewGUCNestLevel(void)
3675 return ++GUCNestLevel;
3679 * Do GUC processing at transaction or subtransaction commit or abort, or
3680 * when exiting a function that has proconfig settings. (The name is thus
3681 * a bit of a misnomer; perhaps it should be ExitGUCNestLevel or some such.)
3682 * During abort, we discard all GUC settings that were applied at nesting
3683 * levels >= nestLevel. nestLevel == 1 corresponds to the main transaction.
3686 AtEOXact_GUC(bool isCommit, int nestLevel)
3691 Assert(nestLevel > 0 && nestLevel <= GUCNestLevel);
3693 /* Quick exit if nothing's changed in this transaction */
3696 GUCNestLevel = nestLevel - 1;
3700 still_dirty = false;
3701 for (i = 0; i < num_guc_variables; i++)
3703 struct config_generic *gconf = guc_variables[i];
3707 * Process and pop each stack entry within the nest level. To
3708 * simplify fmgr_security_definer(), we allow failure exit from a
3709 * function-with-SET-options to be recovered at the surrounding
3710 * transaction or subtransaction abort; so there could be more than
3711 * one stack entry to pop.
3713 while ((stack = gconf->stack) != NULL &&
3714 stack->nest_level >= nestLevel)
3716 GucStack *prev = stack->prev;
3717 bool restorePrior = false;
3718 bool restoreMasked = false;
3722 * In this next bit, if we don't set either restorePrior or
3723 * restoreMasked, we must "discard" any unwanted fields of the
3724 * stack entries to avoid leaking memory. If we do set one of
3725 * those flags, unused fields will be cleaned up after restoring.
3727 if (!isCommit) /* if abort, always restore prior value */
3728 restorePrior = true;
3729 else if (stack->state == GUC_SAVE)
3730 restorePrior = true;
3731 else if (stack->nest_level == 1)
3733 /* transaction commit */
3734 if (stack->state == GUC_SET_LOCAL)
3735 restoreMasked = true;
3736 else if (stack->state == GUC_SET)
3738 /* we keep the current active value */
3739 discard_stack_value(gconf, &stack->prior);
3741 else /* must be GUC_LOCAL */
3742 restorePrior = true;
3744 else if (prev == NULL ||
3745 prev->nest_level < stack->nest_level - 1)
3747 /* decrement entry's level and do not pop it */
3748 stack->nest_level--;
3754 * We have to merge this stack entry into prev. See README for
3755 * discussion of this bit.
3757 switch (stack->state)
3760 Assert(false); /* can't get here */
3763 /* next level always becomes SET */
3764 discard_stack_value(gconf, &stack->prior);
3765 if (prev->state == GUC_SET_LOCAL)
3766 discard_stack_value(gconf, &prev->masked);
3767 prev->state = GUC_SET;
3771 if (prev->state == GUC_SET)
3773 /* LOCAL migrates down */
3774 prev->masked = stack->prior;
3775 prev->state = GUC_SET_LOCAL;
3779 /* else just forget this stack level */
3780 discard_stack_value(gconf, &stack->prior);
3785 /* prior state at this level no longer wanted */
3786 discard_stack_value(gconf, &stack->prior);
3787 /* copy down the masked state */
3788 if (prev->state == GUC_SET_LOCAL)
3789 discard_stack_value(gconf, &prev->masked);
3790 prev->masked = stack->masked;
3791 prev->state = GUC_SET_LOCAL;
3798 if (restorePrior || restoreMasked)
3800 /* Perform appropriate restoration of the stacked value */
3801 union config_var_value newvalue;
3802 GucSource newsource;
3806 newvalue = stack->masked;
3807 newsource = PGC_S_SESSION;
3811 newvalue = stack->prior;
3812 newsource = stack->source;
3815 switch (gconf->vartype)
3819 struct config_bool *conf = (struct config_bool *) gconf;
3820 bool newval = newvalue.boolval;
3822 if (*conf->variable != newval)
3824 if (conf->assign_hook)
3825 if (!(*conf->assign_hook) (newval,
3826 true, PGC_S_OVERRIDE))
3827 elog(LOG, "failed to commit %s",
3829 *conf->variable = newval;
3836 struct config_int *conf = (struct config_int *) gconf;
3837 int newval = newvalue.intval;
3839 if (*conf->variable != newval)
3841 if (conf->assign_hook)
3842 if (!(*conf->assign_hook) (newval,
3843 true, PGC_S_OVERRIDE))
3844 elog(LOG, "failed to commit %s",
3846 *conf->variable = newval;
3853 struct config_real *conf = (struct config_real *) gconf;
3854 double newval = newvalue.realval;
3856 if (*conf->variable != newval)
3858 if (conf->assign_hook)
3859 if (!(*conf->assign_hook) (newval,
3860 true, PGC_S_OVERRIDE))
3861 elog(LOG, "failed to commit %s",
3863 *conf->variable = newval;
3870 struct config_string *conf = (struct config_string *) gconf;
3871 char *newval = newvalue.stringval;
3873 if (*conf->variable != newval)
3875 if (conf->assign_hook && newval)
3879 newstr = (*conf->assign_hook) (newval, true,
3882 elog(LOG, "failed to commit %s",
3884 else if (newstr != newval)
3887 * If newval should now be freed,
3888 * it'll be taken care of below.
3890 * See notes in set_config_option
3893 newval = (char *) newstr;
3897 set_string_field(conf, conf->variable, newval);
3902 * Release stacked values if not used anymore. We
3903 * could use discard_stack_value() here, but since
3904 * we have type-specific code anyway, might as
3907 set_string_field(conf, &stack->prior.stringval, NULL);
3908 set_string_field(conf, &stack->masked.stringval, NULL);
3913 struct config_enum *conf = (struct config_enum *) gconf;
3914 int newval = newvalue.enumval;
3916 if (*conf->variable != newval)
3918 if (conf->assign_hook)
3919 if (!(*conf->assign_hook) (newval,
3920 true, PGC_S_OVERRIDE))
3921 elog(LOG, "failed to commit %s",
3923 *conf->variable = newval;
3930 gconf->source = newsource;
3933 /* Finish popping the state stack */
3934 gconf->stack = prev;
3937 /* Report new value if we changed it */
3938 if (changed && (gconf->flags & GUC_REPORT))
3939 ReportGUCOption(gconf);
3940 } /* end of stack-popping loop */
3946 /* If there are no remaining stack entries, we can reset guc_dirty */
3947 guc_dirty = still_dirty;
3949 /* Update nesting level */
3950 GUCNestLevel = nestLevel - 1;
3955 * Start up automatic reporting of changes to variables marked GUC_REPORT.
3956 * This is executed at completion of backend startup.
3959 BeginReportingGUCOptions(void)
3964 * Don't do anything unless talking to an interactive frontend of protocol
3967 if (whereToSendOutput != DestRemote ||
3968 PG_PROTOCOL_MAJOR(FrontendProtocol) < 3)
3971 reporting_enabled = true;
3973 /* Transmit initial values of interesting variables */
3974 for (i = 0; i < num_guc_variables; i++)
3976 struct config_generic *conf = guc_variables[i];
3978 if (conf->flags & GUC_REPORT)
3979 ReportGUCOption(conf);
3984 * ReportGUCOption: if appropriate, transmit option value to frontend
3987 ReportGUCOption(struct config_generic * record)
3989 if (reporting_enabled && (record->flags & GUC_REPORT))
3991 char *val = _ShowOption(record, false);
3992 StringInfoData msgbuf;
3994 pq_beginmessage(&msgbuf, 'S');
3995 pq_sendstring(&msgbuf, record->name);
3996 pq_sendstring(&msgbuf, val);
3997 pq_endmessage(&msgbuf);
4005 * Try to interpret value as boolean value. Valid values are: true,
4006 * false, yes, no, on, off, 1, 0; as well as unique prefixes thereof.
4007 * If the string parses okay, return true, else false.
4008 * If okay and result is not NULL, return the value in *result.
4011 parse_bool(const char *value, bool *result)
4013 size_t len = strlen(value);
4015 if (pg_strncasecmp(value, "true", len) == 0)
4020 else if (pg_strncasecmp(value, "false", len) == 0)
4026 else if (pg_strncasecmp(value, "yes", len) == 0)
4031 else if (pg_strncasecmp(value, "no", len) == 0)
4037 /* 'o' is not unique enough */
4038 else if (pg_strncasecmp(value, "on", (len > 2 ? len : 2)) == 0)
4043 else if (pg_strncasecmp(value, "off", (len > 2 ? len : 2)) == 0)
4049 else if (pg_strcasecmp(value, "1") == 0)
4054 else if (pg_strcasecmp(value, "0") == 0)
4063 *result = false; /* suppress compiler warning */
4072 * Try to parse value as an integer. The accepted formats are the
4073 * usual decimal, octal, or hexadecimal formats, optionally followed by
4074 * a unit name if "flags" indicates a unit is allowed.
4076 * If the string parses okay, return true, else false.
4077 * If okay and result is not NULL, return the value in *result.
4078 * If not okay and hintmsg is not NULL, *hintmsg is set to a suitable
4079 * HINT message, or NULL if no hint provided.
4082 parse_int(const char *value, int *result, int flags, const char **hintmsg)
4087 /* To suppress compiler warnings, always set output params */
4093 /* We assume here that int64 is at least as wide as long */
4095 val = strtol(value, &endptr, 0);
4097 if (endptr == value)
4098 return false; /* no HINT for integer syntax error */
4100 if (errno == ERANGE || val != (int64) ((int32) val))
4103 *hintmsg = gettext_noop("Value exceeds integer range.");
4107 /* allow whitespace between integer and unit */
4108 while (isspace((unsigned char) *endptr))
4111 /* Handle possible unit */
4112 if (*endptr != '\0')
4115 * Note: the multiple-switch coding technique here is a bit tedious,
4116 * but seems necessary to avoid intermediate-value overflows.
4118 * If INT64_IS_BUSTED (ie, it's really int32) we will fail to detect
4119 * overflow due to units conversion, but there are few enough such
4120 * machines that it does not seem worth trying to be smarter.
4122 if (flags & GUC_UNIT_MEMORY)
4124 /* Set hint for use if no match or trailing garbage */
4126 *hintmsg = gettext_noop("Valid units for this parameter are \"kB\", \"MB\", and \"GB\".");
4128 #if BLCKSZ < 1024 || BLCKSZ > (1024*1024)
4129 #error BLCKSZ must be between 1KB and 1MB
4131 #if XLOG_BLCKSZ < 1024 || XLOG_BLCKSZ > (1024*1024)
4132 #error XLOG_BLCKSZ must be between 1KB and 1MB
4135 if (strncmp(endptr, "kB", 2) == 0)
4138 switch (flags & GUC_UNIT_MEMORY)
4140 case GUC_UNIT_BLOCKS:
4141 val /= (BLCKSZ / 1024);
4143 case GUC_UNIT_XBLOCKS:
4144 val /= (XLOG_BLCKSZ / 1024);
4148 else if (strncmp(endptr, "MB", 2) == 0)
4151 switch (flags & GUC_UNIT_MEMORY)
4156 case GUC_UNIT_BLOCKS:
4157 val *= KB_PER_MB / (BLCKSZ / 1024);
4159 case GUC_UNIT_XBLOCKS:
4160 val *= KB_PER_MB / (XLOG_BLCKSZ / 1024);
4164 else if (strncmp(endptr, "GB", 2) == 0)
4167 switch (flags & GUC_UNIT_MEMORY)
4172 case GUC_UNIT_BLOCKS:
4173 val *= KB_PER_GB / (BLCKSZ / 1024);
4175 case GUC_UNIT_XBLOCKS:
4176 val *= KB_PER_GB / (XLOG_BLCKSZ / 1024);
4181 else if (flags & GUC_UNIT_TIME)
4183 /* Set hint for use if no match or trailing garbage */
4185 *hintmsg = gettext_noop("Valid units for this parameter are \"ms\", \"s\", \"min\", \"h\", and \"d\".");
4187 if (strncmp(endptr, "ms", 2) == 0)
4190 switch (flags & GUC_UNIT_TIME)
4200 else if (strncmp(endptr, "s", 1) == 0)
4203 switch (flags & GUC_UNIT_TIME)
4213 else if (strncmp(endptr, "min", 3) == 0)
4216 switch (flags & GUC_UNIT_TIME)
4226 else if (strncmp(endptr, "h", 1) == 0)
4229 switch (flags & GUC_UNIT_TIME)
4242 else if (strncmp(endptr, "d", 1) == 0)
4245 switch (flags & GUC_UNIT_TIME)
4260 /* allow whitespace after unit */
4261 while (isspace((unsigned char) *endptr))
4264 if (*endptr != '\0')
4265 return false; /* appropriate hint, if any, already set */
4267 /* Check for overflow due to units conversion */
4268 if (val != (int64) ((int32) val))
4271 *hintmsg = gettext_noop("Value exceeds integer range.");
4277 *result = (int) val;
4284 * Try to parse value as a floating point number in the usual format.
4285 * If the string parses okay, return true, else false.
4286 * If okay and result is not NULL, return the value in *result.
4289 parse_real(const char *value, double *result)
4295 *result = 0; /* suppress compiler warning */
4298 val = strtod(value, &endptr);
4299 if (endptr == value || errno == ERANGE)
4302 /* allow whitespace after number */
4303 while (isspace((unsigned char) *endptr))
4305 if (*endptr != '\0')
4315 * Lookup the name for an enum option with the selected value.
4316 * Should only ever be called with known-valid values, so throws
4317 * an elog(ERROR) if the enum option is not found.
4319 * The returned string is a pointer to static data and not
4320 * allocated for modification.
4323 config_enum_lookup_by_value(struct config_enum *record, int val)
4325 const struct config_enum_entry *entry = record->options;
4326 while (entry && entry->name)
4328 if (entry->val == val)
4332 elog(ERROR, "could not find enum option %d for %s",
4333 val, record->gen.name);
4334 return NULL; /* silence compiler */
4339 * Lookup the value for an enum option with the selected name
4340 * (case-insensitive).
4341 * If the enum option is found, sets the retval value and returns
4342 * true. If it's not found, return FALSE and retval is set to 0.
4346 config_enum_lookup_by_name(struct config_enum *record, const char *value, int *retval)
4348 const struct config_enum_entry *entry = record->options;
4351 *retval = 0; /* suppress compiler warning */
4353 while (entry && entry->name)
4355 if (pg_strcasecmp(value, entry->name) == 0)
4357 *retval = entry->val;
4367 * Return a list of all available options for an enum, excluding
4368 * hidden ones, separated by ", " (comma-space).
4369 * If prefix is non-NULL, it is added before the first enum value.
4370 * If suffix is non-NULL, it is added to the end of the string.
4373 config_enum_get_options(struct config_enum *record, const char *prefix, const char *suffix)
4375 const struct config_enum_entry *entry = record->options;
4379 if (!entry || !entry->name)
4380 return NULL; /* Should not happen */
4382 while (entry && entry->name)
4385 len += strlen(entry->name) + 2; /* string and ", " */
4390 hintmsg = palloc(len + strlen(prefix) + strlen(suffix) + 2);
4392 strcpy(hintmsg, prefix);
4394 entry = record->options;
4395 while (entry && entry->name)
4399 strcat(hintmsg, entry->name);
4400 strcat(hintmsg, ", ");
4406 len = strlen(hintmsg);
4409 * All the entries may have been hidden, leaving the string empty
4410 * if no prefix was given. This indicates a broken GUC setup, since
4411 * there is no use for an enum without any values, so we just check
4412 * to make sure we don't write to invalid memory instead of actually
4413 * trying to do something smart with it.
4416 /* Replace final comma/space */
4417 hintmsg[len-2] = '\0';
4419 strcat(hintmsg, suffix);
4426 * Call a GucStringAssignHook function, being careful to free the
4427 * "newval" string if the hook ereports.
4429 * This is split out of set_config_option just to avoid the "volatile"
4430 * qualifiers that would otherwise have to be plastered all over.
4433 call_string_assign_hook(GucStringAssignHook assign_hook,
4434 char *newval, bool doit, GucSource source)
4440 result = (*assign_hook) (newval, doit, source);
4454 * Sets option `name' to given value. The value should be a string
4455 * which is going to be parsed and converted to the appropriate data
4456 * type. The context and source parameters indicate in which context this
4457 * function is being called so it can apply the access restrictions
4460 * If value is NULL, set the option to its default value (normally the
4461 * reset_val, but if source == PGC_S_DEFAULT we instead use the boot_val).
4463 * action indicates whether to set the value globally in the session, locally
4464 * to the current top transaction, or just for the duration of a function call.
4466 * If changeVal is false then don't really set the option but do all
4467 * the checks to see if it would work.
4469 * If there is an error (non-existing option, invalid value) then an
4470 * ereport(ERROR) is thrown *unless* this is called in a context where we
4471 * don't want to ereport (currently, startup or SIGHUP config file reread).
4472 * In that case we write a suitable error message via ereport(LOG) and
4473 * return false. This is working around the deficiencies in the ereport
4474 * mechanism, so don't blame me. In all other cases, the function
4475 * returns true, including cases where the input is valid but we chose
4476 * not to apply it because of context or source-priority considerations.
4478 * See also SetConfigOption for an external interface.
4481 set_config_option(const char *name, const char *value,
4482 GucContext context, GucSource source,
4483 GucAction action, bool changeVal)
4485 struct config_generic *record;
4489 if (context == PGC_SIGHUP || source == PGC_S_DEFAULT)
4492 * To avoid cluttering the log, only the postmaster bleats loudly
4493 * about problems with the config file.
4495 elevel = IsUnderPostmaster ? DEBUG3 : LOG;
4497 else if (source == PGC_S_DATABASE || source == PGC_S_USER)
4502 record = find_option(name, true, elevel);
4506 (errcode(ERRCODE_UNDEFINED_OBJECT),
4507 errmsg("unrecognized configuration parameter \"%s\"", name)));
4512 * If source is postgresql.conf, mark the found record with
4513 * GUC_IS_IN_FILE. This is for the convenience of ProcessConfigFile. Note
4514 * that we do it even if changeVal is false, since ProcessConfigFile wants
4515 * the marking to occur during its testing pass.
4517 if (source == PGC_S_FILE)
4518 record->status |= GUC_IS_IN_FILE;
4521 * Check if the option can be set at this time. See guc.h for the precise
4522 * rules. Note that we don't want to throw errors if we're in the SIGHUP
4523 * context. In that case we just ignore the attempt and return true.
4525 switch (record->context)
4528 if (context == PGC_SIGHUP)
4530 if (context != PGC_INTERNAL)
4533 (errcode(ERRCODE_CANT_CHANGE_RUNTIME_PARAM),
4534 errmsg("parameter \"%s\" cannot be changed",
4539 case PGC_POSTMASTER:
4540 if (context == PGC_SIGHUP)
4543 * We are reading a PGC_POSTMASTER var from postgresql.conf.
4544 * We can't change the setting, so give a warning if the DBA
4545 * tries to change it. (Throwing an error would be more
4546 * consistent, but seems overly rigid.)
4548 if (changeVal && !is_newvalue_equal(record, value))
4550 (errcode(ERRCODE_CANT_CHANGE_RUNTIME_PARAM),
4551 errmsg("parameter \"%s\" cannot be changed after server start; configuration file change ignored",
4555 if (context != PGC_POSTMASTER)
4558 (errcode(ERRCODE_CANT_CHANGE_RUNTIME_PARAM),
4559 errmsg("parameter \"%s\" cannot be changed after server start",
4565 if (context != PGC_SIGHUP && context != PGC_POSTMASTER)
4568 (errcode(ERRCODE_CANT_CHANGE_RUNTIME_PARAM),
4569 errmsg("parameter \"%s\" cannot be changed now",
4575 * Hmm, the idea of the SIGHUP context is "ought to be global, but
4576 * can be changed after postmaster start". But there's nothing
4577 * that prevents a crafty administrator from sending SIGHUP
4578 * signals to individual backends only.
4582 if (context == PGC_SIGHUP)
4585 * If a PGC_BACKEND parameter is changed in the config file,
4586 * we want to accept the new value in the postmaster (whence
4587 * it will propagate to subsequently-started backends), but
4588 * ignore it in existing backends. This is a tad klugy, but
4589 * necessary because we don't re-read the config file during
4592 if (IsUnderPostmaster)
4595 else if (context != PGC_BACKEND && context != PGC_POSTMASTER)
4598 (errcode(ERRCODE_CANT_CHANGE_RUNTIME_PARAM),
4599 errmsg("parameter \"%s\" cannot be set after connection start",
4605 if (context == PGC_USERSET || context == PGC_BACKEND)
4608 (errcode(ERRCODE_INSUFFICIENT_PRIVILEGE),
4609 errmsg("permission denied to set parameter \"%s\"",
4620 * Should we set reset/stacked values? (If so, the behavior is not
4621 * transactional.) This is done either when we get a default value from
4622 * the database's/user's/client's default settings or when we reset a
4623 * value to its default.
4625 makeDefault = changeVal && (source <= PGC_S_OVERRIDE) &&
4626 ((value != NULL) || source == PGC_S_DEFAULT);
4629 * Ignore attempted set if overridden by previously processed setting.
4630 * However, if changeVal is false then plow ahead anyway since we are
4631 * trying to find out if the value is potentially good, not actually use
4632 * it. Also keep going if makeDefault is true, since we may want to set
4633 * the reset/stacked values even if we can't set the variable itself.
4635 if (record->source > source)
4637 if (changeVal && !makeDefault)
4639 elog(DEBUG3, "\"%s\": setting ignored because previous source is higher priority",
4647 * Evaluate value and set variable.
4649 switch (record->vartype)
4653 struct config_bool *conf = (struct config_bool *) record;
4658 if (!parse_bool(value, &newval))
4661 (errcode(ERRCODE_INVALID_PARAMETER_VALUE),
4662 errmsg("parameter \"%s\" requires a Boolean value",
4667 else if (source == PGC_S_DEFAULT)
4668 newval = conf->boot_val;
4671 newval = conf->reset_val;
4672 source = conf->gen.reset_source;
4675 /* Save old value to support transaction abort */
4676 if (changeVal && !makeDefault)
4677 push_old_value(&conf->gen, action);
4679 if (conf->assign_hook)
4680 if (!(*conf->assign_hook) (newval, changeVal, source))
4683 (errcode(ERRCODE_INVALID_PARAMETER_VALUE),
4684 errmsg("invalid value for parameter \"%s\": %d",
4685 name, (int) newval)));
4691 *conf->variable = newval;
4692 conf->gen.source = source;
4698 if (conf->gen.reset_source <= source)
4700 conf->reset_val = newval;
4701 conf->gen.reset_source = source;
4703 for (stack = conf->gen.stack; stack; stack = stack->prev)
4705 if (stack->source <= source)
4707 stack->prior.boolval = newval;
4708 stack->source = source;
4717 struct config_int *conf = (struct config_int *) record;
4722 const char *hintmsg;
4724 if (!parse_int(value, &newval, conf->gen.flags, &hintmsg))
4727 (errcode(ERRCODE_INVALID_PARAMETER_VALUE),
4728 errmsg("invalid value for parameter \"%s\": \"%s\"",
4730 hintmsg ? errhint(hintmsg) : 0));
4733 if (newval < conf->min || newval > conf->max)
4736 (errcode(ERRCODE_INVALID_PARAMETER_VALUE),
4737 errmsg("%d is outside the valid range for parameter \"%s\" (%d .. %d)",
4738 newval, name, conf->min, conf->max)));
4742 else if (source == PGC_S_DEFAULT)
4743 newval = conf->boot_val;
4746 newval = conf->reset_val;
4747 source = conf->gen.reset_source;
4750 /* Save old value to support transaction abort */
4751 if (changeVal && !makeDefault)
4752 push_old_value(&conf->gen, action);
4754 if (conf->assign_hook)
4755 if (!(*conf->assign_hook) (newval, changeVal, source))
4758 (errcode(ERRCODE_INVALID_PARAMETER_VALUE),
4759 errmsg("invalid value for parameter \"%s\": %d",
4766 *conf->variable = newval;
4767 conf->gen.source = source;
4773 if (conf->gen.reset_source <= source)
4775 conf->reset_val = newval;
4776 conf->gen.reset_source = source;
4778 for (stack = conf->gen.stack; stack; stack = stack->prev)
4780 if (stack->source <= source)
4782 stack->prior.intval = newval;
4783 stack->source = source;
4792 struct config_real *conf = (struct config_real *) record;
4797 if (!parse_real(value, &newval))
4800 (errcode(ERRCODE_INVALID_PARAMETER_VALUE),
4801 errmsg("parameter \"%s\" requires a numeric value",
4805 if (newval < conf->min || newval > conf->max)
4808 (errcode(ERRCODE_INVALID_PARAMETER_VALUE),
4809 errmsg("%g is outside the valid range for parameter \"%s\" (%g .. %g)",
4810 newval, name, conf->min, conf->max)));
4814 else if (source == PGC_S_DEFAULT)
4815 newval = conf->boot_val;
4818 newval = conf->reset_val;
4819 source = conf->gen.reset_source;
4822 /* Save old value to support transaction abort */
4823 if (changeVal && !makeDefault)
4824 push_old_value(&conf->gen, action);
4826 if (conf->assign_hook)
4827 if (!(*conf->assign_hook) (newval, changeVal, source))
4830 (errcode(ERRCODE_INVALID_PARAMETER_VALUE),
4831 errmsg("invalid value for parameter \"%s\": %g",
4838 *conf->variable = newval;
4839 conf->gen.source = source;
4845 if (conf->gen.reset_source <= source)
4847 conf->reset_val = newval;
4848 conf->gen.reset_source = source;
4850 for (stack = conf->gen.stack; stack; stack = stack->prev)
4852 if (stack->source <= source)
4854 stack->prior.realval = newval;
4855 stack->source = source;
4864 struct config_string *conf = (struct config_string *) record;
4869 newval = guc_strdup(elevel, value);
4874 * The only sort of "parsing" check we need to do is apply
4875 * truncation if GUC_IS_NAME.
4877 if (conf->gen.flags & GUC_IS_NAME)
4878 truncate_identifier(newval, strlen(newval), true);
4880 else if (source == PGC_S_DEFAULT)
4882 if (conf->boot_val == NULL)
4886 newval = guc_strdup(elevel, conf->boot_val);
4894 * We could possibly avoid strdup here, but easier to make
4895 * this case work the same as the normal assignment case;
4896 * note the possible free of newval below.
4898 if (conf->reset_val == NULL)
4902 newval = guc_strdup(elevel, conf->reset_val);
4906 source = conf->gen.reset_source;
4909 /* Save old value to support transaction abort */
4910 if (changeVal && !makeDefault)
4911 push_old_value(&conf->gen, action);
4913 if (conf->assign_hook && newval)
4915 const char *hookresult;
4918 * If the hook ereports, we have to make sure we free
4919 * newval, else it will be a permanent memory leak.
4921 hookresult = call_string_assign_hook(conf->assign_hook,
4925 if (hookresult == NULL)
4929 (errcode(ERRCODE_INVALID_PARAMETER_VALUE),
4930 errmsg("invalid value for parameter \"%s\": \"%s\"",
4931 name, value ? value : "")));
4934 else if (hookresult != newval)
4939 * Having to cast away const here is annoying, but the
4940 * alternative is to declare assign_hooks as returning
4941 * char*, which would mean they'd have to cast away
4942 * const, or as both taking and returning char*, which
4943 * doesn't seem attractive either --- we don't want
4944 * them to scribble on the passed str.
4946 newval = (char *) hookresult;
4952 set_string_field(conf, conf->variable, newval);
4953 conf->gen.source = source;
4959 if (conf->gen.reset_source <= source)
4961 set_string_field(conf, &conf->reset_val, newval);
4962 conf->gen.reset_source = source;
4964 for (stack = conf->gen.stack; stack; stack = stack->prev)
4966 if (stack->source <= source)
4968 set_string_field(conf, &stack->prior.stringval,
4970 stack->source = source;
4974 /* Perhaps we didn't install newval anywhere */
4975 if (newval && !string_field_used(conf, newval))
4981 struct config_enum *conf = (struct config_enum *) record;
4986 if (!config_enum_lookup_by_name(conf, value, &newval))
4988 char *hintmsg = config_enum_get_options(conf, "Available values: ", ".");
4991 (errcode(ERRCODE_INVALID_PARAMETER_VALUE),
4992 errmsg("invalid value for parameter \"%s\": \"%s\"",
4994 hintmsg ? errhint(hintmsg) : 0));
5001 else if (source == PGC_S_DEFAULT)
5002 newval = conf->boot_val;
5005 newval = conf->reset_val;
5006 source = conf->gen.reset_source;
5009 /* Save old value to support transaction abort */
5010 if (changeVal && !makeDefault)
5011 push_old_value(&conf->gen, action);
5013 if (conf->assign_hook)
5014 if (!(*conf->assign_hook) (newval, changeVal, source))
5017 (errcode(ERRCODE_INVALID_PARAMETER_VALUE),
5018 errmsg("invalid value for parameter \"%s\": \"%s\"",
5020 config_enum_lookup_by_value(conf, newval))));
5026 *conf->variable = newval;
5027 conf->gen.source = source;
5033 if (conf->gen.reset_source <= source)
5035 conf->reset_val = newval;
5036 conf->gen.reset_source = source;
5038 for (stack = conf->gen.stack; stack; stack = stack->prev)
5040 if (stack->source <= source)
5042 stack->prior.enumval = newval;
5043 stack->source = source;
5051 if (changeVal && (record->flags & GUC_REPORT))
5052 ReportGUCOption(record);
5059 * Set a config option to the given value. See also set_config_option,
5060 * this is just the wrapper to be called from outside GUC. NB: this
5061 * is used only for non-transactional operations.
5064 SetConfigOption(const char *name, const char *value,
5065 GucContext context, GucSource source)
5067 (void) set_config_option(name, value, context, source,
5068 GUC_ACTION_SET, true);
5074 * Fetch the current value of the option `name'. If the option doesn't exist,
5075 * throw an ereport and don't return.
5077 * The string is *not* allocated for modification and is really only
5078 * valid until the next call to configuration related functions.
5081 GetConfigOption(const char *name)
5083 struct config_generic *record;
5084 static char buffer[256];
5086 record = find_option(name, false, ERROR);
5089 (errcode(ERRCODE_UNDEFINED_OBJECT),
5090 errmsg("unrecognized configuration parameter \"%s\"", name)));
5091 if ((record->flags & GUC_SUPERUSER_ONLY) && !superuser())
5093 (errcode(ERRCODE_INSUFFICIENT_PRIVILEGE),
5094 errmsg("must be superuser to examine \"%s\"", name)));
5096 switch (record->vartype)
5099 return *((struct config_bool *) record)->variable ? "on" : "off";
5102 snprintf(buffer, sizeof(buffer), "%d",
5103 *((struct config_int *) record)->variable);
5107 snprintf(buffer, sizeof(buffer), "%g",
5108 *((struct config_real *) record)->variable);
5112 return *((struct config_string *) record)->variable;
5115 return config_enum_lookup_by_value((struct config_enum *) record,
5116 *((struct config_enum *) record)->variable);
5122 * Get the RESET value associated with the given option.
5124 * Note: this is not re-entrant, due to use of static result buffer;
5125 * not to mention that a string variable could have its reset_val changed.
5126 * Beware of assuming the result value is good for very long.
5129 GetConfigOptionResetString(const char *name)
5131 struct config_generic *record;
5132 static char buffer[256];
5134 record = find_option(name, false, ERROR);
5137 (errcode(ERRCODE_UNDEFINED_OBJECT),
5138 errmsg("unrecognized configuration parameter \"%s\"", name)));
5139 if ((record->flags & GUC_SUPERUSER_ONLY) && !superuser())
5141 (errcode(ERRCODE_INSUFFICIENT_PRIVILEGE),
5142 errmsg("must be superuser to examine \"%s\"", name)));
5144 switch (record->vartype)
5147 return ((struct config_bool *) record)->reset_val ? "on" : "off";
5150 snprintf(buffer, sizeof(buffer), "%d",
5151 ((struct config_int *) record)->reset_val);
5155 snprintf(buffer, sizeof(buffer), "%g",
5156 ((struct config_real *) record)->reset_val);
5160 return ((struct config_string *) record)->reset_val;
5163 return config_enum_lookup_by_value((struct config_enum *) record,
5164 ((struct config_enum *) record)->reset_val);
5170 * Detect whether the given configuration option can only be set by
5174 IsSuperuserConfigOption(const char *name)
5176 struct config_generic *record;
5178 record = find_option(name, false, ERROR);
5179 /* On an unrecognized name, don't error, just return false. */
5182 return (record->context == PGC_SUSET);
5187 * GUC_complaint_elevel
5188 * Get the ereport error level to use in an assign_hook's error report.
5190 * This should be used by assign hooks that want to emit a custom error
5191 * report (in addition to the generic "invalid value for option FOO" that
5192 * guc.c will provide). Note that the result might be ERROR or a lower
5193 * level, so the caller must be prepared for control to return from ereport,
5194 * or not. If control does return, return false/NULL from the hook function.
5196 * At some point it'd be nice to replace this with a mechanism that allows
5197 * the custom message to become the DETAIL line of guc.c's generic message.
5200 GUC_complaint_elevel(GucSource source)
5204 if (source == PGC_S_FILE)
5207 * To avoid cluttering the log, only the postmaster bleats loudly
5208 * about problems with the config file.
5210 elevel = IsUnderPostmaster ? DEBUG3 : LOG;
5212 else if (source == PGC_S_OVERRIDE)
5215 * If we're a postmaster child, this is probably "undo" during
5216 * transaction abort, so we don't want to clutter the log. There's
5217 * a small chance of a real problem with an OVERRIDE setting,
5218 * though, so suppressing the message entirely wouldn't be desirable.
5220 elevel = IsUnderPostmaster ? DEBUG5 : LOG;
5222 else if (source < PGC_S_INTERACTIVE)
5232 * flatten_set_variable_args
5233 * Given a parsenode List as emitted by the grammar for SET,
5234 * convert to the flat string representation used by GUC.
5236 * We need to be told the name of the variable the args are for, because
5237 * the flattening rules vary (ugh).
5239 * The result is NULL if args is NIL (ie, SET ... TO DEFAULT), otherwise
5240 * a palloc'd string.
5243 flatten_set_variable_args(const char *name, List *args)
5245 struct config_generic *record;
5250 /* Fast path if just DEFAULT */
5254 /* Else get flags for the variable */
5255 record = find_option(name, true, ERROR);
5258 (errcode(ERRCODE_UNDEFINED_OBJECT),
5259 errmsg("unrecognized configuration parameter \"%s\"", name)));
5261 flags = record->flags;
5263 /* Complain if list input and non-list variable */
5264 if ((flags & GUC_LIST_INPUT) == 0 &&
5265 list_length(args) != 1)
5267 (errcode(ERRCODE_INVALID_PARAMETER_VALUE),
5268 errmsg("SET %s takes only one argument", name)));
5270 initStringInfo(&buf);
5273 * Each list member may be a plain A_Const node, or an A_Const within a
5274 * TypeCast; the latter case is supported only for ConstInterval
5275 * arguments (for SET TIME ZONE).
5279 Node *arg = (Node *) lfirst(l);
5281 TypeName *typename = NULL;
5284 if (l != list_head(args))
5285 appendStringInfo(&buf, ", ");
5287 if (IsA(arg, TypeCast))
5289 TypeCast *tc = (TypeCast *) arg;
5292 typename = tc->typename;
5295 if (!IsA(arg, A_Const))
5296 elog(ERROR, "unrecognized node type: %d", (int) nodeTag(arg));
5297 con = (A_Const *) arg;
5299 switch (nodeTag(&con->val))
5302 appendStringInfo(&buf, "%ld", intVal(&con->val));
5305 /* represented as a string, so just copy it */
5306 appendStringInfoString(&buf, strVal(&con->val));
5309 val = strVal(&con->val);
5310 if (typename != NULL)
5313 * Must be a ConstInterval argument for TIME ZONE. Coerce
5314 * to interval and back to normalize the value and account
5322 typoid = typenameTypeId(NULL, typename, &typmod);
5323 Assert(typoid == INTERVALOID);
5326 DirectFunctionCall3(interval_in,
5327 CStringGetDatum(val),
5328 ObjectIdGetDatum(InvalidOid),
5329 Int32GetDatum(typmod));
5332 DatumGetCString(DirectFunctionCall1(interval_out,
5334 appendStringInfo(&buf, "INTERVAL '%s'", intervalout);
5339 * Plain string literal or identifier. For quote mode,
5340 * quote it if it's not a vanilla identifier.
5342 if (flags & GUC_LIST_QUOTE)
5343 appendStringInfoString(&buf, quote_identifier(val));
5345 appendStringInfoString(&buf, val);
5349 elog(ERROR, "unrecognized node type: %d",
5350 (int) nodeTag(&con->val));
5363 ExecSetVariableStmt(VariableSetStmt *stmt)
5365 GucAction action = stmt->is_local ? GUC_ACTION_LOCAL : GUC_ACTION_SET;
5370 case VAR_SET_CURRENT:
5371 set_config_option(stmt->name,
5372 ExtractSetVariableArgs(stmt),
5373 (superuser() ? PGC_SUSET : PGC_USERSET),
5381 * Special case for special SQL syntax that effectively sets more
5382 * than one variable per statement.
5384 if (strcmp(stmt->name, "TRANSACTION") == 0)
5388 foreach(head, stmt->args)
5390 DefElem *item = (DefElem *) lfirst(head);
5392 if (strcmp(item->defname, "transaction_isolation") == 0)
5393 SetPGVariable("transaction_isolation",
5394 list_make1(item->arg), stmt->is_local);
5395 else if (strcmp(item->defname, "transaction_read_only") == 0)
5396 SetPGVariable("transaction_read_only",
5397 list_make1(item->arg), stmt->is_local);
5399 elog(ERROR, "unexpected SET TRANSACTION element: %s",
5403 else if (strcmp(stmt->name, "SESSION CHARACTERISTICS") == 0)
5407 foreach(head, stmt->args)
5409 DefElem *item = (DefElem *) lfirst(head);
5411 if (strcmp(item->defname, "transaction_isolation") == 0)
5412 SetPGVariable("default_transaction_isolation",
5413 list_make1(item->arg), stmt->is_local);
5414 else if (strcmp(item->defname, "transaction_read_only") == 0)
5415 SetPGVariable("default_transaction_read_only",
5416 list_make1(item->arg), stmt->is_local);
5418 elog(ERROR, "unexpected SET SESSION element: %s",
5423 elog(ERROR, "unexpected SET MULTI element: %s",
5426 case VAR_SET_DEFAULT:
5428 set_config_option(stmt->name,
5430 (superuser() ? PGC_SUSET : PGC_USERSET),
5442 * Get the value to assign for a VariableSetStmt, or NULL if it's RESET.
5443 * The result is palloc'd.
5445 * This is exported for use by actions such as ALTER ROLE SET.
5448 ExtractSetVariableArgs(VariableSetStmt *stmt)
5453 return flatten_set_variable_args(stmt->name, stmt->args);
5454 case VAR_SET_CURRENT:
5455 return GetConfigOptionByName(stmt->name, NULL);
5462 * SetPGVariable - SET command exported as an easily-C-callable function.
5464 * This provides access to SET TO value, as well as SET TO DEFAULT (expressed
5465 * by passing args == NIL), but not SET FROM CURRENT functionality.
5468 SetPGVariable(const char *name, List *args, bool is_local)
5470 char *argstring = flatten_set_variable_args(name, args);
5472 /* Note SET DEFAULT (argstring == NULL) is equivalent to RESET */
5473 set_config_option(name,
5475 (superuser() ? PGC_SUSET : PGC_USERSET),
5477 is_local ? GUC_ACTION_LOCAL : GUC_ACTION_SET,
5482 * SET command wrapped as a SQL callable function.
5485 set_config_by_name(PG_FUNCTION_ARGS)
5492 if (PG_ARGISNULL(0))
5494 (errcode(ERRCODE_NULL_VALUE_NOT_ALLOWED),
5495 errmsg("SET requires parameter name")));
5497 /* Get the GUC variable name */
5498 name = TextDatumGetCString(PG_GETARG_DATUM(0));
5500 /* Get the desired value or set to NULL for a reset request */
5501 if (PG_ARGISNULL(1))
5504 value = TextDatumGetCString(PG_GETARG_DATUM(1));
5507 * Get the desired state of is_local. Default to false if provided value
5510 if (PG_ARGISNULL(2))
5513 is_local = PG_GETARG_BOOL(2);
5515 /* Note SET DEFAULT (argstring == NULL) is equivalent to RESET */
5516 set_config_option(name,
5518 (superuser() ? PGC_SUSET : PGC_USERSET),
5520 is_local ? GUC_ACTION_LOCAL : GUC_ACTION_SET,
5523 /* get the new current value */
5524 new_value = GetConfigOptionByName(name, NULL);
5526 /* Convert return string to text */
5527 PG_RETURN_TEXT_P(cstring_to_text(new_value));
5532 * Common code for DefineCustomXXXVariable subroutines: allocate the
5533 * new variable's config struct and fill in generic fields.
5535 static struct config_generic *
5536 init_custom_variable(const char *name,
5537 const char *short_desc,
5538 const char *long_desc,
5540 enum config_type type,
5543 struct config_generic *gen;
5545 gen = (struct config_generic *) guc_malloc(ERROR, sz);
5548 gen->name = guc_strdup(ERROR, name);
5549 gen->context = context;
5550 gen->group = CUSTOM_OPTIONS;
5551 gen->short_desc = short_desc;
5552 gen->long_desc = long_desc;
5553 gen->vartype = type;
5559 * Common code for DefineCustomXXXVariable subroutines: insert the new
5560 * variable into the GUC variable array, replacing any placeholder.
5563 define_custom_variable(struct config_generic * variable)
5565 const char *name = variable->name;
5566 const char **nameAddr = &name;
5568 struct config_string *pHolder;
5569 struct config_generic **res;
5571 res = (struct config_generic **) bsearch((void *) &nameAddr,
5572 (void *) guc_variables,
5574 sizeof(struct config_generic *),
5578 /* No placeholder to replace, so just add it */
5579 add_guc_variable(variable, ERROR);
5584 * This better be a placeholder
5586 if (((*res)->flags & GUC_CUSTOM_PLACEHOLDER) == 0)
5588 (errcode(ERRCODE_INTERNAL_ERROR),
5589 errmsg("attempt to redefine parameter \"%s\"", name)));
5591 Assert((*res)->vartype == PGC_STRING);
5592 pHolder = (struct config_string *) (*res);
5595 * Replace the placeholder. We aren't changing the name, so no re-sorting
5601 * Assign the string value stored in the placeholder to the real variable.
5603 * XXX this is not really good enough --- it should be a nontransactional
5604 * assignment, since we don't want it to roll back if the current xact
5607 value = *pHolder->variable;
5610 set_config_option(name, value,
5611 pHolder->gen.context, pHolder->gen.source,
5612 GUC_ACTION_SET, true);
5615 * Free up as much as we conveniently can of the placeholder structure
5616 * (this neglects any stack items...)
5618 set_string_field(pHolder, pHolder->variable, NULL);
5619 set_string_field(pHolder, &pHolder->reset_val, NULL);
5625 DefineCustomBoolVariable(const char *name,
5626 const char *short_desc,
5627 const char *long_desc,
5630 GucBoolAssignHook assign_hook,
5631 GucShowHook show_hook)
5633 struct config_bool *var;
5635 var = (struct config_bool *)
5636 init_custom_variable(name, short_desc, long_desc, context,
5637 PGC_BOOL, sizeof(struct config_bool));
5638 var->variable = valueAddr;
5639 var->boot_val = *valueAddr;
5640 var->reset_val = *valueAddr;
5641 var->assign_hook = assign_hook;
5642 var->show_hook = show_hook;
5643 define_custom_variable(&var->gen);
5647 DefineCustomIntVariable(const char *name,
5648 const char *short_desc,
5649 const char *long_desc,
5654 GucIntAssignHook assign_hook,
5655 GucShowHook show_hook)
5657 struct config_int *var;
5659 var = (struct config_int *)
5660 init_custom_variable(name, short_desc, long_desc, context,
5661 PGC_INT, sizeof(struct config_int));
5662 var->variable = valueAddr;
5663 var->boot_val = *valueAddr;
5664 var->reset_val = *valueAddr;
5665 var->min = minValue;
5666 var->max = maxValue;
5667 var->assign_hook = assign_hook;
5668 var->show_hook = show_hook;
5669 define_custom_variable(&var->gen);
5673 DefineCustomRealVariable(const char *name,
5674 const char *short_desc,
5675 const char *long_desc,
5680 GucRealAssignHook assign_hook,
5681 GucShowHook show_hook)
5683 struct config_real *var;
5685 var = (struct config_real *)
5686 init_custom_variable(name, short_desc, long_desc, context,
5687 PGC_REAL, sizeof(struct config_real));
5688 var->variable = valueAddr;
5689 var->boot_val = *valueAddr;
5690 var->reset_val = *valueAddr;
5691 var->min = minValue;
5692 var->max = maxValue;
5693 var->assign_hook = assign_hook;
5694 var->show_hook = show_hook;
5695 define_custom_variable(&var->gen);
5699 DefineCustomStringVariable(const char *name,
5700 const char *short_desc,
5701 const char *long_desc,
5704 GucStringAssignHook assign_hook,
5705 GucShowHook show_hook)
5707 struct config_string *var;
5709 var = (struct config_string *)
5710 init_custom_variable(name, short_desc, long_desc, context,
5711 PGC_STRING, sizeof(struct config_string));
5712 var->variable = valueAddr;
5713 var->boot_val = *valueAddr;
5714 /* we could probably do without strdup, but keep it like normal case */
5716 var->reset_val = guc_strdup(ERROR, var->boot_val);
5717 var->assign_hook = assign_hook;
5718 var->show_hook = show_hook;
5719 define_custom_variable(&var->gen);
5723 DefineCustomEnumVariable(const char *name,
5724 const char *short_desc,
5725 const char *long_desc,
5727 const struct config_enum_entry *options,
5729 GucEnumAssignHook assign_hook,
5730 GucShowHook show_hook)
5732 struct config_enum *var;
5734 var = (struct config_enum *)
5735 init_custom_variable(name, short_desc, long_desc, context,
5736 PGC_ENUM, sizeof(struct config_enum));
5737 var->variable = valueAddr;
5738 var->boot_val = *valueAddr;
5739 var->reset_val = *valueAddr;
5740 var->options = options;
5741 var->assign_hook = assign_hook;
5742 var->show_hook = show_hook;
5743 define_custom_variable(&var->gen);
5747 EmitWarningsOnPlaceholders(const char *className)
5749 struct config_generic **vars = guc_variables;
5750 struct config_generic **last = vars + num_guc_variables;
5752 int nameLen = strlen(className);
5756 struct config_generic *var = *vars++;
5758 if ((var->flags & GUC_CUSTOM_PLACEHOLDER) != 0 &&
5759 strncmp(className, var->name, nameLen) == 0 &&
5760 var->name[nameLen] == GUC_QUALIFIER_SEPARATOR)
5763 (errcode(ERRCODE_UNDEFINED_OBJECT),
5764 errmsg("unrecognized configuration parameter \"%s\"", var->name)));
5774 GetPGVariable(const char *name, DestReceiver *dest)
5776 if (guc_name_compare(name, "all") == 0)
5777 ShowAllGUCConfig(dest);
5779 ShowGUCConfigOption(name, dest);
5783 GetPGVariableResultDesc(const char *name)
5787 if (guc_name_compare(name, "all") == 0)
5789 /* need a tuple descriptor representing three TEXT columns */
5790 tupdesc = CreateTemplateTupleDesc(3, false);
5791 TupleDescInitEntry(tupdesc, (AttrNumber) 1, "name",
5793 TupleDescInitEntry(tupdesc, (AttrNumber) 2, "setting",
5795 TupleDescInitEntry(tupdesc, (AttrNumber) 3, "description",
5801 const char *varname;
5803 /* Get the canonical spelling of name */
5804 (void) GetConfigOptionByName(name, &varname);
5806 /* need a tuple descriptor representing a single TEXT column */
5807 tupdesc = CreateTemplateTupleDesc(1, false);
5808 TupleDescInitEntry(tupdesc, (AttrNumber) 1, varname,
5819 ShowGUCConfigOption(const char *name, DestReceiver *dest)
5821 TupOutputState *tstate;
5823 const char *varname;
5826 /* Get the value and canonical spelling of name */
5827 value = GetConfigOptionByName(name, &varname);
5829 /* need a tuple descriptor representing a single TEXT column */
5830 tupdesc = CreateTemplateTupleDesc(1, false);
5831 TupleDescInitEntry(tupdesc, (AttrNumber) 1, varname,
5834 /* prepare for projection of tuples */
5835 tstate = begin_tup_output_tupdesc(dest, tupdesc);
5838 do_text_output_oneline(tstate, value);
5840 end_tup_output(tstate);
5847 ShowAllGUCConfig(DestReceiver *dest)
5849 bool am_superuser = superuser();
5851 TupOutputState *tstate;
5855 /* need a tuple descriptor representing three TEXT columns */
5856 tupdesc = CreateTemplateTupleDesc(3, false);
5857 TupleDescInitEntry(tupdesc, (AttrNumber) 1, "name",
5859 TupleDescInitEntry(tupdesc, (AttrNumber) 2, "setting",
5861 TupleDescInitEntry(tupdesc, (AttrNumber) 3, "description",
5865 /* prepare for projection of tuples */
5866 tstate = begin_tup_output_tupdesc(dest, tupdesc);
5868 for (i = 0; i < num_guc_variables; i++)
5870 struct config_generic *conf = guc_variables[i];
5872 if ((conf->flags & GUC_NO_SHOW_ALL) ||
5873 ((conf->flags & GUC_SUPERUSER_ONLY) && !am_superuser))
5876 /* assign to the values array */
5877 values[0] = (char *) conf->name;
5878 values[1] = _ShowOption(conf, true);
5879 values[2] = (char *) conf->short_desc;
5881 /* send it to dest */
5882 do_tup_output(tstate, values);
5885 if (values[1] != NULL)
5889 end_tup_output(tstate);
5893 * Return GUC variable value by name; optionally return canonical
5894 * form of name. Return value is palloc'd.
5897 GetConfigOptionByName(const char *name, const char **varname)
5899 struct config_generic *record;
5901 record = find_option(name, false, ERROR);
5904 (errcode(ERRCODE_UNDEFINED_OBJECT),
5905 errmsg("unrecognized configuration parameter \"%s\"", name)));
5906 if ((record->flags & GUC_SUPERUSER_ONLY) && !superuser())
5908 (errcode(ERRCODE_INSUFFICIENT_PRIVILEGE),
5909 errmsg("must be superuser to examine \"%s\"", name)));
5912 *varname = record->name;
5914 return _ShowOption(record, true);
5918 * Return GUC variable value by variable number; optionally return canonical
5919 * form of name. Return value is palloc'd.
5922 GetConfigOptionByNum(int varnum, const char **values, bool *noshow)
5925 struct config_generic *conf;
5927 /* check requested variable number valid */
5928 Assert((varnum >= 0) && (varnum < num_guc_variables));
5930 conf = guc_variables[varnum];
5934 if ((conf->flags & GUC_NO_SHOW_ALL) ||
5935 ((conf->flags & GUC_SUPERUSER_ONLY) && !superuser()))
5941 /* first get the generic attributes */
5944 values[0] = conf->name;
5946 /* setting : use _ShowOption in order to avoid duplicating the logic */
5947 values[1] = _ShowOption(conf, false);
5950 if (conf->vartype == PGC_INT)
5954 switch (conf->flags & (GUC_UNIT_MEMORY | GUC_UNIT_TIME))
5959 case GUC_UNIT_BLOCKS:
5960 snprintf(buf, sizeof(buf), "%dkB", BLCKSZ / 1024);
5963 case GUC_UNIT_XBLOCKS:
5964 snprintf(buf, sizeof(buf), "%dkB", XLOG_BLCKSZ / 1024);
5985 values[3] = config_group_names[conf->group];
5988 values[4] = conf->short_desc;
5991 values[5] = conf->long_desc;
5994 values[6] = GucContext_Names[conf->context];
5997 values[7] = config_type_names[conf->vartype];
6000 values[8] = GucSource_Names[conf->source];
6002 /* now get the type specifc attributes */
6003 switch (conf->vartype)
6020 struct config_int *lconf = (struct config_int *) conf;
6023 snprintf(buffer, sizeof(buffer), "%d", lconf->min);
6024 values[9] = pstrdup(buffer);
6027 snprintf(buffer, sizeof(buffer), "%d", lconf->max);
6028 values[10] = pstrdup(buffer);
6037 struct config_real *lconf = (struct config_real *) conf;
6040 snprintf(buffer, sizeof(buffer), "%g", lconf->min);
6041 values[9] = pstrdup(buffer);
6044 snprintf(buffer, sizeof(buffer), "%g", lconf->max);
6045 values[10] = pstrdup(buffer);
6074 values[11] = config_enum_get_options((struct config_enum *) conf, "", "");
6081 * should never get here, but in case we do, set 'em to NULL
6098 * Return the total number of GUC variables
6101 GetNumConfigOptions(void)
6103 return num_guc_variables;
6107 * show_config_by_name - equiv to SHOW X command but implemented as
6111 show_config_by_name(PG_FUNCTION_ARGS)
6116 /* Get the GUC variable name */
6117 varname = TextDatumGetCString(PG_GETARG_DATUM(0));
6120 varval = GetConfigOptionByName(varname, NULL);
6122 /* Convert to text */
6123 PG_RETURN_TEXT_P(cstring_to_text(varval));
6127 * show_all_settings - equiv to SHOW ALL command but implemented as
6130 #define NUM_PG_SETTINGS_ATTS 12
6133 show_all_settings(PG_FUNCTION_ARGS)
6135 FuncCallContext *funcctx;
6139 AttInMetadata *attinmeta;
6140 MemoryContext oldcontext;
6142 /* stuff done only on the first call of the function */
6143 if (SRF_IS_FIRSTCALL())
6145 /* create a function context for cross-call persistence */
6146 funcctx = SRF_FIRSTCALL_INIT();
6149 * switch to memory context appropriate for multiple function calls
6151 oldcontext = MemoryContextSwitchTo(funcctx->multi_call_memory_ctx);
6154 * need a tuple descriptor representing NUM_PG_SETTINGS_ATTS columns
6155 * of the appropriate types
6157 tupdesc = CreateTemplateTupleDesc(NUM_PG_SETTINGS_ATTS, false);
6158 TupleDescInitEntry(tupdesc, (AttrNumber) 1, "name",
6160 TupleDescInitEntry(tupdesc, (AttrNumber) 2, "setting",
6162 TupleDescInitEntry(tupdesc, (AttrNumber) 3, "unit",
6164 TupleDescInitEntry(tupdesc, (AttrNumber) 4, "category",
6166 TupleDescInitEntry(tupdesc, (AttrNumber) 5, "short_desc",
6168 TupleDescInitEntry(tupdesc, (AttrNumber) 6, "extra_desc",
6170 TupleDescInitEntry(tupdesc, (AttrNumber) 7, "context",
6172 TupleDescInitEntry(tupdesc, (AttrNumber) 8, "vartype",
6174 TupleDescInitEntry(tupdesc, (AttrNumber) 9, "source",
6176 TupleDescInitEntry(tupdesc, (AttrNumber) 10, "min_val",
6178 TupleDescInitEntry(tupdesc, (AttrNumber) 11, "max_val",
6180 TupleDescInitEntry(tupdesc, (AttrNumber) 12, "enumvals",
6184 * Generate attribute metadata needed later to produce tuples from raw
6187 attinmeta = TupleDescGetAttInMetadata(tupdesc);
6188 funcctx->attinmeta = attinmeta;
6190 /* total number of tuples to be returned */
6191 funcctx->max_calls = GetNumConfigOptions();
6193 MemoryContextSwitchTo(oldcontext);
6196 /* stuff done on every call of the function */
6197 funcctx = SRF_PERCALL_SETUP();
6199 call_cntr = funcctx->call_cntr;
6200 max_calls = funcctx->max_calls;
6201 attinmeta = funcctx->attinmeta;
6203 if (call_cntr < max_calls) /* do when there is more left to send */
6205 char *values[NUM_PG_SETTINGS_ATTS];
6211 * Get the next visible GUC variable name and value
6215 GetConfigOptionByNum(call_cntr, (const char **) values, &noshow);
6218 /* bump the counter and get the next config setting */
6219 call_cntr = ++funcctx->call_cntr;
6221 /* make sure we haven't gone too far now */
6222 if (call_cntr >= max_calls)
6223 SRF_RETURN_DONE(funcctx);
6228 tuple = BuildTupleFromCStrings(attinmeta, values);
6230 /* make the tuple into a datum */
6231 result = HeapTupleGetDatum(tuple);
6233 SRF_RETURN_NEXT(funcctx, result);
6237 /* do when there is no more left */
6238 SRF_RETURN_DONE(funcctx);
6243 _ShowOption(struct config_generic * record, bool use_units)
6248 switch (record->vartype)
6252 struct config_bool *conf = (struct config_bool *) record;
6254 if (conf->show_hook)
6255 val = (*conf->show_hook) ();
6257 val = *conf->variable ? "on" : "off";
6263 struct config_int *conf = (struct config_int *) record;
6265 if (conf->show_hook)
6266 val = (*conf->show_hook) ();
6270 * Use int64 arithmetic to avoid overflows in units
6271 * conversion. If INT64_IS_BUSTED we might overflow
6272 * anyway and print bogus answers, but there are few
6273 * enough such machines that it doesn't seem worth
6276 int64 result = *conf->variable;
6279 if (use_units && result > 0 &&
6280 (record->flags & GUC_UNIT_MEMORY))
6282 switch (record->flags & GUC_UNIT_MEMORY)
6284 case GUC_UNIT_BLOCKS:
6285 result *= BLCKSZ / 1024;
6287 case GUC_UNIT_XBLOCKS:
6288 result *= XLOG_BLCKSZ / 1024;
6292 if (result % KB_PER_GB == 0)
6294 result /= KB_PER_GB;
6297 else if (result % KB_PER_MB == 0)
6299 result /= KB_PER_MB;
6307 else if (use_units && result > 0 &&
6308 (record->flags & GUC_UNIT_TIME))
6310 switch (record->flags & GUC_UNIT_TIME)
6316 result *= MS_PER_MIN;
6320 if (result % MS_PER_D == 0)
6325 else if (result % MS_PER_H == 0)
6330 else if (result % MS_PER_MIN == 0)
6332 result /= MS_PER_MIN;
6335 else if (result % MS_PER_S == 0)
6348 snprintf(buffer, sizeof(buffer), INT64_FORMAT "%s",
6357 struct config_real *conf = (struct config_real *) record;
6359 if (conf->show_hook)
6360 val = (*conf->show_hook) ();
6363 snprintf(buffer, sizeof(buffer), "%g",
6372 struct config_string *conf = (struct config_string *) record;
6374 if (conf->show_hook)
6375 val = (*conf->show_hook) ();
6376 else if (*conf->variable && **conf->variable)
6377 val = *conf->variable;
6385 struct config_enum *conf = (struct config_enum *) record;
6388 val = (*conf->show_hook) ();
6390 val = config_enum_lookup_by_value(conf, *conf->variable);
6395 /* just to keep compiler quiet */
6400 return pstrdup(val);
6405 * Attempt (badly) to detect if a proposed new GUC setting is the same
6406 * as the current value.
6408 * XXX this does not really work because it doesn't account for the
6409 * effects of canonicalization of string values by assign_hooks.
6412 is_newvalue_equal(struct config_generic * record, const char *newvalue)
6414 /* newvalue == NULL isn't supported */
6415 Assert(newvalue != NULL);
6417 switch (record->vartype)
6421 struct config_bool *conf = (struct config_bool *) record;
6424 return parse_bool(newvalue, &newval)
6425 && *conf->variable == newval;
6429 struct config_int *conf = (struct config_int *) record;
6432 return parse_int(newvalue, &newval, record->flags, NULL)
6433 && *conf->variable == newval;
6437 struct config_real *conf = (struct config_real *) record;
6440 return parse_real(newvalue, &newval)
6441 && *conf->variable == newval;
6445 struct config_string *conf = (struct config_string *) record;
6447 return *conf->variable != NULL &&
6448 strcmp(*conf->variable, newvalue) == 0;
6453 struct config_enum *conf = (struct config_enum *) record;
6456 return config_enum_lookup_by_name(conf, newvalue, &newval)
6457 && *conf->variable == newval;
6468 * This routine dumps out all non-default GUC options into a binary
6469 * file that is read by all exec'ed backends. The format is:
6471 * variable name, string, null terminated
6472 * variable value, string, null terminated
6473 * variable source, integer
6476 write_nondefault_variables(GucContext context)
6482 Assert(context == PGC_POSTMASTER || context == PGC_SIGHUP);
6484 elevel = (context == PGC_SIGHUP) ? LOG : ERROR;
6489 fp = AllocateFile(CONFIG_EXEC_PARAMS_NEW, "w");
6493 (errcode_for_file_access(),
6494 errmsg("could not write to file \"%s\": %m",
6495 CONFIG_EXEC_PARAMS_NEW)));
6499 for (i = 0; i < num_guc_variables; i++)
6501 struct config_generic *gconf = guc_variables[i];
6503 if (gconf->source != PGC_S_DEFAULT)
6505 fprintf(fp, "%s", gconf->name);
6508 switch (gconf->vartype)
6512 struct config_bool *conf = (struct config_bool *) gconf;
6514 if (*conf->variable == 0)
6515 fprintf(fp, "false");
6517 fprintf(fp, "true");
6523 struct config_int *conf = (struct config_int *) gconf;
6525 fprintf(fp, "%d", *conf->variable);
6531 struct config_real *conf = (struct config_real *) gconf;
6533 /* Could lose precision here? */
6534 fprintf(fp, "%f", *conf->variable);
6540 struct config_string *conf = (struct config_string *) gconf;
6542 fprintf(fp, "%s", *conf->variable);
6548 struct config_enum *conf = (struct config_enum *) gconf;
6550 fprintf(fp, "%s", config_enum_lookup_by_value(conf, *conf->variable));
6557 fwrite(&gconf->source, sizeof(gconf->source), 1, fp);
6564 (errcode_for_file_access(),
6565 errmsg("could not write to file \"%s\": %m",
6566 CONFIG_EXEC_PARAMS_NEW)));
6571 * Put new file in place. This could delay on Win32, but we don't hold
6572 * any exclusive locks.
6574 rename(CONFIG_EXEC_PARAMS_NEW, CONFIG_EXEC_PARAMS);
6579 * Read string, including null byte from file
6581 * Return NULL on EOF and nothing read
6584 read_string_with_null(FILE *fp)
6593 if ((ch = fgetc(fp)) == EOF)
6598 elog(FATAL, "invalid format of exec config params file");
6601 str = guc_malloc(FATAL, maxlen);
6602 else if (i == maxlen)
6603 str = guc_realloc(FATAL, str, maxlen *= 2);
6612 * This routine loads a previous postmaster dump of its non-default
6616 read_nondefault_variables(void)
6626 fp = AllocateFile(CONFIG_EXEC_PARAMS, "r");
6629 /* File not found is fine */
6630 if (errno != ENOENT)
6632 (errcode_for_file_access(),
6633 errmsg("could not read from file \"%s\": %m",
6634 CONFIG_EXEC_PARAMS)));
6640 struct config_generic *record;
6642 if ((varname = read_string_with_null(fp)) == NULL)
6645 if ((record = find_option(varname, true, FATAL)) == NULL)
6646 elog(FATAL, "failed to locate variable %s in exec config params file", varname);
6647 if ((varvalue = read_string_with_null(fp)) == NULL)
6648 elog(FATAL, "invalid format of exec config params file");
6649 if (fread(&varsource, sizeof(varsource), 1, fp) == 0)
6650 elog(FATAL, "invalid format of exec config params file");
6652 (void) set_config_option(varname, varvalue, record->context,
6653 varsource, GUC_ACTION_SET, true);
6660 #endif /* EXEC_BACKEND */
6664 * A little "long argument" simulation, although not quite GNU
6665 * compliant. Takes a string of the form "some-option=some value" and
6666 * returns name = "some_option" and value = "some value" in malloc'ed
6667 * storage. Note that '-' is converted to '_' in the option name. If
6668 * there is no '=' in the input string then value will be NULL.
6671 ParseLongOption(const char *string, char **name, char **value)
6680 equal_pos = strcspn(string, "=");
6682 if (string[equal_pos] == '=')
6684 *name = guc_malloc(FATAL, equal_pos + 1);
6685 strlcpy(*name, string, equal_pos + 1);
6687 *value = guc_strdup(FATAL, &string[equal_pos + 1]);
6691 /* no equal sign in string */
6692 *name = guc_strdup(FATAL, string);
6696 for (cp = *name; *cp; cp++)
6703 * Handle options fetched from pg_database.datconfig, pg_authid.rolconfig,
6704 * pg_proc.proconfig, etc. Caller must specify proper context/source/action.
6706 * The array parameter must be an array of TEXT (it must not be NULL).
6709 ProcessGUCArray(ArrayType *array,
6710 GucContext context, GucSource source, GucAction action)
6714 Assert(array != NULL);
6715 Assert(ARR_ELEMTYPE(array) == TEXTOID);
6716 Assert(ARR_NDIM(array) == 1);
6717 Assert(ARR_LBOUND(array)[0] == 1);
6719 for (i = 1; i <= ARR_DIMS(array)[0]; i++)
6727 d = array_ref(array, 1, &i,
6728 -1 /* varlenarray */ ,
6729 -1 /* TEXT's typlen */ ,
6730 false /* TEXT's typbyval */ ,
6731 'i' /* TEXT's typalign */ ,
6737 s = TextDatumGetCString(d);
6739 ParseLongOption(s, &name, &value);
6743 (errcode(ERRCODE_SYNTAX_ERROR),
6744 errmsg("could not parse setting for parameter \"%s\"",
6750 (void) set_config_option(name, value, context, source, action, true);
6760 * Add an entry to an option array. The array parameter may be NULL
6761 * to indicate the current table entry is NULL.
6764 GUCArrayAdd(ArrayType *array, const char *name, const char *value)
6766 const char *varname;
6774 /* test if the option is valid */
6775 set_config_option(name, value,
6776 superuser() ? PGC_SUSET : PGC_USERSET,
6777 PGC_S_TEST, GUC_ACTION_SET, false);
6779 /* convert name to canonical spelling, so we can use plain strcmp */
6780 (void) GetConfigOptionByName(name, &varname);
6783 newval = palloc(strlen(name) + 1 + strlen(value) + 1);
6784 sprintf(newval, "%s=%s", name, value);
6785 datum = CStringGetTextDatum(newval);
6793 Assert(ARR_ELEMTYPE(array) == TEXTOID);
6794 Assert(ARR_NDIM(array) == 1);
6795 Assert(ARR_LBOUND(array)[0] == 1);
6797 index = ARR_DIMS(array)[0] + 1; /* add after end */
6799 for (i = 1; i <= ARR_DIMS(array)[0]; i++)
6804 d = array_ref(array, 1, &i,
6805 -1 /* varlenarray */ ,
6806 -1 /* TEXT's typlen */ ,
6807 false /* TEXT's typbyval */ ,
6808 'i' /* TEXT's typalign */ ,
6812 current = TextDatumGetCString(d);
6813 if (strncmp(current, newval, strlen(name) + 1) == 0)
6820 a = array_set(array, 1, &index,
6823 -1 /* varlena array */ ,
6824 -1 /* TEXT's typlen */ ,
6825 false /* TEXT's typbyval */ ,
6826 'i' /* TEXT's typalign */ );
6829 a = construct_array(&datum, 1,
6838 * Delete an entry from an option array. The array parameter may be NULL
6839 * to indicate the current table entry is NULL. Also, if the return value
6840 * is NULL then a null should be stored.
6843 GUCArrayDelete(ArrayType *array, const char *name)
6845 const char *varname;
6846 ArrayType *newarray;
6852 /* test if the option is valid */
6853 set_config_option(name, NULL,
6854 superuser() ? PGC_SUSET : PGC_USERSET,
6855 PGC_S_TEST, GUC_ACTION_SET, false);
6857 /* convert name to canonical spelling, so we can use plain strcmp */
6858 (void) GetConfigOptionByName(name, &varname);
6861 /* if array is currently null, then surely nothing to delete */
6868 for (i = 1; i <= ARR_DIMS(array)[0]; i++)
6874 d = array_ref(array, 1, &i,
6875 -1 /* varlenarray */ ,
6876 -1 /* TEXT's typlen */ ,
6877 false /* TEXT's typbyval */ ,
6878 'i' /* TEXT's typalign */ ,
6882 val = TextDatumGetCString(d);
6884 /* ignore entry if it's what we want to delete */
6885 if (strncmp(val, name, strlen(name)) == 0
6886 && val[strlen(name)] == '=')
6889 /* else add it to the output array */
6892 newarray = array_set(newarray, 1, &index,
6895 -1 /* varlenarray */ ,
6896 -1 /* TEXT's typlen */ ,
6897 false /* TEXT's typbyval */ ,
6898 'i' /* TEXT's typalign */ );
6901 newarray = construct_array(&d, 1,
6913 * assign_hook and show_hook subroutines
6917 assign_log_destination(const char *value, bool doit, GucSource source)
6924 /* Need a modifiable copy of string */
6925 rawstring = pstrdup(value);
6927 /* Parse string into list of identifiers */
6928 if (!SplitIdentifierString(rawstring, ',', &elemlist))
6930 /* syntax error in list */
6932 list_free(elemlist);
6933 ereport(GUC_complaint_elevel(source),
6934 (errcode(ERRCODE_INVALID_PARAMETER_VALUE),
6935 errmsg("invalid list syntax for parameter \"log_destination\"")));
6939 foreach(l, elemlist)
6941 char *tok = (char *) lfirst(l);
6943 if (pg_strcasecmp(tok, "stderr") == 0)
6944 newlogdest |= LOG_DESTINATION_STDERR;
6945 else if (pg_strcasecmp(tok, "csvlog") == 0)
6946 newlogdest |= LOG_DESTINATION_CSVLOG;
6948 else if (pg_strcasecmp(tok, "syslog") == 0)
6949 newlogdest |= LOG_DESTINATION_SYSLOG;
6952 else if (pg_strcasecmp(tok, "eventlog") == 0)
6953 newlogdest |= LOG_DESTINATION_EVENTLOG;
6957 ereport(GUC_complaint_elevel(source),
6958 (errcode(ERRCODE_INVALID_PARAMETER_VALUE),
6959 errmsg("unrecognized \"log_destination\" key word: \"%s\"",
6962 list_free(elemlist);
6968 Log_destination = newlogdest;
6971 list_free(elemlist);
6979 assign_syslog_facility(int newval, bool doit, GucSource source)
6982 set_syslog_parameters(syslog_ident_str ? syslog_ident_str : "postgres",
6989 assign_syslog_ident(const char *ident, bool doit, GucSource source)
6992 set_syslog_parameters(ident, syslog_facility);
6996 #endif /* HAVE_SYSLOG */
7000 assign_session_replication_role(int newval, bool doit, GucSource source)
7003 * Must flush the plan cache when changing replication role; but don't
7004 * flush unnecessarily.
7006 if (doit && SessionReplicationRole != newval)
7015 show_num_temp_buffers(void)
7018 * We show the GUC var until local buffers have been initialized, and
7019 * NLocBuffer afterwards.
7021 static char nbuf[32];
7023 sprintf(nbuf, "%d", NLocBuffer ? NLocBuffer : num_temp_buffers);
7028 assign_phony_autocommit(bool newval, bool doit, GucSource source)
7032 ereport(GUC_complaint_elevel(source),
7033 (errcode(ERRCODE_FEATURE_NOT_SUPPORTED),
7034 errmsg("SET AUTOCOMMIT TO OFF is no longer supported")));
7041 assign_custom_variable_classes(const char *newval, bool doit, GucSource source)
7044 * Check syntax. newval must be a comma separated list of identifiers.
7045 * Whitespace is allowed but removed from the result.
7047 bool hasSpaceAfterToken = false;
7048 const char *cp = newval;
7053 initStringInfo(&buf);
7054 while ((c = *cp++) != '\0')
7056 if (isspace((unsigned char) c))
7059 hasSpaceAfterToken = true;
7065 if (symLen > 0) /* terminate identifier */
7067 appendStringInfoChar(&buf, ',');
7070 hasSpaceAfterToken = false;
7074 if (hasSpaceAfterToken || !isalnum((unsigned char) c))
7077 * Syntax error due to token following space after token or non
7078 * alpha numeric character
7083 appendStringInfoChar(&buf, c);
7087 /* Remove stray ',' at end */
7088 if (symLen == 0 && buf.len > 0)
7089 buf.data[--buf.len] = '\0';
7091 /* GUC wants the result malloc'd */
7092 newval = guc_strdup(LOG, buf.data);
7099 assign_debug_assertions(bool newval, bool doit, GucSource source)
7101 #ifndef USE_ASSERT_CHECKING
7104 ereport(GUC_complaint_elevel(source),
7105 (errcode(ERRCODE_INVALID_PARAMETER_VALUE),
7106 errmsg("assertion checking is not supported by this build")));
7114 assign_ssl(bool newval, bool doit, GucSource source)
7119 ereport(GUC_complaint_elevel(source),
7120 (errcode(ERRCODE_INVALID_PARAMETER_VALUE),
7121 errmsg("SSL is not supported by this build")));
7129 assign_stage_log_stats(bool newval, bool doit, GucSource source)
7131 if (newval && log_statement_stats)
7133 ereport(GUC_complaint_elevel(source),
7134 (errcode(ERRCODE_INVALID_PARAMETER_VALUE),
7135 errmsg("cannot enable parameter when \"log_statement_stats\" is true")));
7136 /* source == PGC_S_OVERRIDE means do it anyway, eg at xact abort */
7137 if (source != PGC_S_OVERRIDE)
7144 assign_log_stats(bool newval, bool doit, GucSource source)
7147 (log_parser_stats || log_planner_stats || log_executor_stats))
7149 ereport(GUC_complaint_elevel(source),
7150 (errcode(ERRCODE_INVALID_PARAMETER_VALUE),
7151 errmsg("cannot enable \"log_statement_stats\" when "
7152 "\"log_parser_stats\", \"log_planner_stats\", "
7153 "or \"log_executor_stats\" is true")));
7154 /* source == PGC_S_OVERRIDE means do it anyway, eg at xact abort */
7155 if (source != PGC_S_OVERRIDE)
7162 assign_transaction_read_only(bool newval, bool doit, GucSource source)
7164 /* Can't go to r/w mode inside a r/o transaction */
7165 if (newval == false && XactReadOnly && IsSubTransaction())
7167 ereport(GUC_complaint_elevel(source),
7168 (errcode(ERRCODE_INVALID_PARAMETER_VALUE),
7169 errmsg("cannot set transaction read-write mode inside a read-only transaction")));
7170 /* source == PGC_S_OVERRIDE means do it anyway, eg at xact abort */
7171 if (source != PGC_S_OVERRIDE)
7178 assign_canonical_path(const char *newval, bool doit, GucSource source)
7182 char *canon_val = guc_strdup(ERROR, newval);
7184 canonicalize_path(canon_val);
7192 assign_timezone_abbreviations(const char *newval, bool doit, GucSource source)
7195 * The powerup value shown above for timezone_abbreviations is "UNKNOWN".
7196 * When we see this we just do nothing. If this value isn't overridden
7197 * from the config file then pg_timezone_abbrev_initialize() will
7198 * eventually replace it with "Default". This hack has two purposes: to
7199 * avoid wasting cycles loading values that might soon be overridden from
7200 * the config file, and to avoid trying to read the timezone abbrev files
7201 * during InitializeGUCOptions(). The latter doesn't work in an
7202 * EXEC_BACKEND subprocess because my_exec_path hasn't been set yet and so
7203 * we can't locate PGSHAREDIR. (Essentially the same hack is used to
7204 * delay initializing TimeZone ... if we have any more, we should try to
7205 * clean up and centralize this mechanism ...)
7207 if (strcmp(newval, "UNKNOWN") == 0)
7212 /* Loading abbrev file is expensive, so only do it when value changes */
7213 if (timezone_abbreviations_string == NULL ||
7214 strcmp(timezone_abbreviations_string, newval) != 0)
7219 * If reading config file, only the postmaster should bleat loudly
7220 * about problems. Otherwise, it's just this one process doing it,
7221 * and we use WARNING message level.
7223 if (source == PGC_S_FILE)
7224 elevel = IsUnderPostmaster ? DEBUG3 : LOG;
7227 if (!load_tzoffsets(newval, doit, elevel))
7234 * pg_timezone_abbrev_initialize --- set default value if not done already
7236 * This is called after initial loading of postgresql.conf. If no
7237 * timezone_abbreviations setting was found therein, select default.
7240 pg_timezone_abbrev_initialize(void)
7242 if (strcmp(timezone_abbreviations_string, "UNKNOWN") == 0)
7244 SetConfigOption("timezone_abbreviations", "Default",
7245 PGC_POSTMASTER, PGC_S_ARGV);
7250 show_archive_command(void)
7252 if (XLogArchiveMode)
7253 return XLogArchiveCommand;
7255 return "(disabled)";
7259 assign_tcp_keepalives_idle(int newval, bool doit, GucSource source)
7262 return (pq_setkeepalivesidle(newval, MyProcPort) == STATUS_OK);
7268 show_tcp_keepalives_idle(void)
7270 static char nbuf[16];
7272 snprintf(nbuf, sizeof(nbuf), "%d", pq_getkeepalivesidle(MyProcPort));
7277 assign_tcp_keepalives_interval(int newval, bool doit, GucSource source)
7280 return (pq_setkeepalivesinterval(newval, MyProcPort) == STATUS_OK);
7286 show_tcp_keepalives_interval(void)
7288 static char nbuf[16];
7290 snprintf(nbuf, sizeof(nbuf), "%d", pq_getkeepalivesinterval(MyProcPort));
7295 assign_tcp_keepalives_count(int newval, bool doit, GucSource source)
7298 return (pq_setkeepalivescount(newval, MyProcPort) == STATUS_OK);
7304 show_tcp_keepalives_count(void)
7306 static char nbuf[16];
7308 snprintf(nbuf, sizeof(nbuf), "%d", pq_getkeepalivescount(MyProcPort));
7313 assign_maxconnections(int newval, bool doit, GucSource source)
7315 if (newval + autovacuum_max_workers > INT_MAX / 4)
7319 MaxBackends = newval + autovacuum_max_workers;
7325 assign_autovacuum_max_workers(int newval, bool doit, GucSource source)
7327 if (newval + MaxConnections > INT_MAX / 4)
7331 MaxBackends = newval + MaxConnections;
7336 #include "guc-file.c"