1 /*--------------------------------------------------------------------
4 * Support for grand unified configuration scheme, including SET
5 * command, configuration file, and command line options.
6 * See src/backend/utils/misc/README for more information.
9 * Copyright (c) 2000-2009, PostgreSQL Global Development Group
10 * Written by Peter Eisentraut <peter_e@gmx.net>.
13 * $PostgreSQL: pgsql/src/backend/utils/misc/guc.c,v 1.514 2009/08/31 19:41:00 tgl Exp $
15 *--------------------------------------------------------------------
29 #include "access/gin.h"
30 #include "access/transam.h"
31 #include "access/twophase.h"
32 #include "access/xact.h"
33 #include "catalog/namespace.h"
34 #include "commands/async.h"
35 #include "commands/prepare.h"
36 #include "commands/vacuum.h"
37 #include "commands/variable.h"
38 #include "commands/trigger.h"
40 #include "libpq/auth.h"
41 #include "libpq/pqformat.h"
42 #include "miscadmin.h"
43 #include "optimizer/cost.h"
44 #include "optimizer/geqo.h"
45 #include "optimizer/paths.h"
46 #include "optimizer/planmain.h"
47 #include "parser/parse_expr.h"
48 #include "parser/parse_relation.h"
49 #include "parser/parse_type.h"
50 #include "parser/parser.h"
51 #include "parser/scansup.h"
53 #include "postmaster/autovacuum.h"
54 #include "postmaster/bgwriter.h"
55 #include "postmaster/postmaster.h"
56 #include "postmaster/syslogger.h"
57 #include "postmaster/walwriter.h"
58 #include "regex/regex.h"
59 #include "storage/bufmgr.h"
60 #include "storage/fd.h"
61 #include "tcop/tcopprot.h"
62 #include "tsearch/ts_cache.h"
63 #include "utils/builtins.h"
64 #include "utils/bytea.h"
65 #include "utils/guc_tables.h"
66 #include "utils/memutils.h"
67 #include "utils/pg_locale.h"
68 #include "utils/plancache.h"
69 #include "utils/portal.h"
70 #include "utils/ps_status.h"
71 #include "utils/tzparser.h"
72 #include "utils/xml.h"
75 #define PG_KRB_SRVTAB ""
78 #define PG_KRB_SRVNAM ""
81 #define CONFIG_FILENAME "postgresql.conf"
82 #define HBA_FILENAME "pg_hba.conf"
83 #define IDENT_FILENAME "pg_ident.conf"
86 #define CONFIG_EXEC_PARAMS "global/config_exec_params"
87 #define CONFIG_EXEC_PARAMS_NEW "global/config_exec_params.new"
90 /* upper limit for GUC variables measured in kilobytes of memory */
92 #define MAX_KILOBYTES INT_MAX
94 #define MAX_KILOBYTES (INT_MAX / 1024)
97 #define KB_PER_MB (1024)
98 #define KB_PER_GB (1024*1024)
100 #define MS_PER_S 1000
102 #define MS_PER_MIN (1000 * 60)
104 #define S_PER_H (60 * 60)
105 #define MS_PER_H (1000 * 60 * 60)
106 #define MIN_PER_D (60 * 24)
107 #define S_PER_D (60 * 60 * 24)
108 #define MS_PER_D (1000 * 60 * 60 * 24)
110 /* XXX these should appear in other modules' header files */
111 extern bool Log_disconnections;
112 extern int CommitDelay;
113 extern int CommitSiblings;
114 extern char *default_tablespace;
115 extern char *temp_tablespaces;
116 extern bool synchronize_seqscans;
117 extern bool fullPageWrites;
120 extern bool trace_sort;
122 #ifdef TRACE_SYNCSCAN
123 extern bool trace_syncscan;
125 #ifdef DEBUG_BOUNDED_SORT
126 extern bool optimize_bounded_sort;
130 extern char *SSLCipherSuites;
133 static void set_config_sourcefile(const char *name, char *sourcefile,
136 static const char *assign_log_destination(const char *value,
137 bool doit, GucSource source);
140 static int syslog_facility = LOG_LOCAL0;
142 static bool assign_syslog_facility(int newval,
143 bool doit, GucSource source);
144 static const char *assign_syslog_ident(const char *ident,
145 bool doit, GucSource source);
148 static bool assign_session_replication_role(int newval, bool doit,
150 static const char *show_num_temp_buffers(void);
151 static bool assign_phony_autocommit(bool newval, bool doit, GucSource source);
152 static const char *assign_custom_variable_classes(const char *newval, bool doit,
154 static bool assign_debug_assertions(bool newval, bool doit, GucSource source);
155 static bool assign_ssl(bool newval, bool doit, GucSource source);
156 static bool assign_stage_log_stats(bool newval, bool doit, GucSource source);
157 static bool assign_log_stats(bool newval, bool doit, GucSource source);
158 static bool assign_transaction_read_only(bool newval, bool doit, GucSource source);
159 static const char *assign_canonical_path(const char *newval, bool doit, GucSource source);
160 static const char *assign_timezone_abbreviations(const char *newval, bool doit, GucSource source);
161 static const char *show_archive_command(void);
162 static bool assign_tcp_keepalives_idle(int newval, bool doit, GucSource source);
163 static bool assign_tcp_keepalives_interval(int newval, bool doit, GucSource source);
164 static bool assign_tcp_keepalives_count(int newval, bool doit, GucSource source);
165 static const char *show_tcp_keepalives_idle(void);
166 static const char *show_tcp_keepalives_interval(void);
167 static const char *show_tcp_keepalives_count(void);
168 static bool assign_maxconnections(int newval, bool doit, GucSource source);
169 static bool assign_autovacuum_max_workers(int newval, bool doit, GucSource source);
170 static bool assign_effective_io_concurrency(int newval, bool doit, GucSource source);
171 static const char *assign_pgstat_temp_directory(const char *newval, bool doit, GucSource source);
173 static char *config_enum_get_options(struct config_enum * record,
174 const char *prefix, const char *suffix,
175 const char *separator);
179 * Options for enum values defined in this module.
181 * NOTE! Option values may not contain double quotes!
184 static const struct config_enum_entry bytea_output_options[] = {
185 {"escape", BYTEA_OUTPUT_ESCAPE, false},
186 {"hex", BYTEA_OUTPUT_HEX, false},
191 * We have different sets for client and server message level options because
192 * they sort slightly different (see "log" level)
194 static const struct config_enum_entry client_message_level_options[] = {
195 {"debug", DEBUG2, true},
196 {"debug5", DEBUG5, false},
197 {"debug4", DEBUG4, false},
198 {"debug3", DEBUG3, false},
199 {"debug2", DEBUG2, false},
200 {"debug1", DEBUG1, false},
202 {"info", INFO, true},
203 {"notice", NOTICE, false},
204 {"warning", WARNING, false},
205 {"error", ERROR, false},
206 {"fatal", FATAL, true},
207 {"panic", PANIC, true},
211 static const struct config_enum_entry server_message_level_options[] = {
212 {"debug", DEBUG2, true},
213 {"debug5", DEBUG5, false},
214 {"debug4", DEBUG4, false},
215 {"debug3", DEBUG3, false},
216 {"debug2", DEBUG2, false},
217 {"debug1", DEBUG1, false},
218 {"info", INFO, false},
219 {"notice", NOTICE, false},
220 {"warning", WARNING, false},
221 {"error", ERROR, false},
223 {"fatal", FATAL, false},
224 {"panic", PANIC, false},
228 static const struct config_enum_entry intervalstyle_options[] = {
229 {"postgres", INTSTYLE_POSTGRES, false},
230 {"postgres_verbose", INTSTYLE_POSTGRES_VERBOSE, false},
231 {"sql_standard", INTSTYLE_SQL_STANDARD, false},
232 {"iso_8601", INTSTYLE_ISO_8601, false},
236 static const struct config_enum_entry log_error_verbosity_options[] = {
237 {"terse", PGERROR_TERSE, false},
238 {"default", PGERROR_DEFAULT, false},
239 {"verbose", PGERROR_VERBOSE, false},
243 static const struct config_enum_entry log_statement_options[] = {
244 {"none", LOGSTMT_NONE, false},
245 {"ddl", LOGSTMT_DDL, false},
246 {"mod", LOGSTMT_MOD, false},
247 {"all", LOGSTMT_ALL, false},
251 static const struct config_enum_entry regex_flavor_options[] = {
252 {"advanced", REG_ADVANCED, false},
253 {"extended", REG_EXTENDED, false},
254 {"basic", REG_BASIC, false},
258 static const struct config_enum_entry isolation_level_options[] = {
259 {"serializable", XACT_SERIALIZABLE, false},
260 {"repeatable read", XACT_REPEATABLE_READ, false},
261 {"read committed", XACT_READ_COMMITTED, false},
262 {"read uncommitted", XACT_READ_UNCOMMITTED, false},
266 static const struct config_enum_entry session_replication_role_options[] = {
267 {"origin", SESSION_REPLICATION_ROLE_ORIGIN, false},
268 {"replica", SESSION_REPLICATION_ROLE_REPLICA, false},
269 {"local", SESSION_REPLICATION_ROLE_LOCAL, false},
274 static const struct config_enum_entry syslog_facility_options[] = {
275 {"local0", LOG_LOCAL0, false},
276 {"local1", LOG_LOCAL1, false},
277 {"local2", LOG_LOCAL2, false},
278 {"local3", LOG_LOCAL3, false},
279 {"local4", LOG_LOCAL4, false},
280 {"local5", LOG_LOCAL5, false},
281 {"local6", LOG_LOCAL6, false},
282 {"local7", LOG_LOCAL7, false},
287 static const struct config_enum_entry track_function_options[] = {
288 {"none", TRACK_FUNC_OFF, false},
289 {"pl", TRACK_FUNC_PL, false},
290 {"all", TRACK_FUNC_ALL, false},
294 static const struct config_enum_entry xmlbinary_options[] = {
295 {"base64", XMLBINARY_BASE64, false},
296 {"hex", XMLBINARY_HEX, false},
300 static const struct config_enum_entry xmloption_options[] = {
301 {"content", XMLOPTION_CONTENT, false},
302 {"document", XMLOPTION_DOCUMENT, false},
307 * Although only "on", "off", and "safe_encoding" are documented, we
308 * accept all the likely variants of "on" and "off".
310 static const struct config_enum_entry backslash_quote_options[] = {
311 {"safe_encoding", BACKSLASH_QUOTE_SAFE_ENCODING, false},
312 {"on", BACKSLASH_QUOTE_ON, false},
313 {"off", BACKSLASH_QUOTE_OFF, false},
314 {"true", BACKSLASH_QUOTE_ON, true},
315 {"false", BACKSLASH_QUOTE_OFF, true},
316 {"yes", BACKSLASH_QUOTE_ON, true},
317 {"no", BACKSLASH_QUOTE_OFF, true},
318 {"1", BACKSLASH_QUOTE_ON, true},
319 {"0", BACKSLASH_QUOTE_OFF, true},
324 * Although only "on", "off", and "partition" are documented, we
325 * accept all the likely variants of "on" and "off".
327 static const struct config_enum_entry constraint_exclusion_options[] = {
328 {"partition", CONSTRAINT_EXCLUSION_PARTITION, false},
329 {"on", CONSTRAINT_EXCLUSION_ON, false},
330 {"off", CONSTRAINT_EXCLUSION_OFF, false},
331 {"true", CONSTRAINT_EXCLUSION_ON, true},
332 {"false", CONSTRAINT_EXCLUSION_OFF, true},
333 {"yes", CONSTRAINT_EXCLUSION_ON, true},
334 {"no", CONSTRAINT_EXCLUSION_OFF, true},
335 {"1", CONSTRAINT_EXCLUSION_ON, true},
336 {"0", CONSTRAINT_EXCLUSION_OFF, true},
341 * Options for enum values stored in other modules
343 extern const struct config_enum_entry sync_method_options[];
346 * GUC option variables that are exported from this module
348 #ifdef USE_ASSERT_CHECKING
349 bool assert_enabled = true;
351 bool assert_enabled = false;
353 bool log_duration = false;
354 bool Debug_print_plan = false;
355 bool Debug_print_parse = false;
356 bool Debug_print_rewritten = false;
357 bool Debug_pretty_print = true;
359 bool log_parser_stats = false;
360 bool log_planner_stats = false;
361 bool log_executor_stats = false;
362 bool log_statement_stats = false; /* this is sort of all three
364 bool log_btree_build_stats = false;
366 bool check_function_bodies = true;
367 bool default_with_oids = false;
368 bool SQL_inheritance = true;
370 bool Password_encryption = true;
372 int log_min_error_statement = ERROR;
373 int log_min_messages = WARNING;
374 int client_min_messages = NOTICE;
375 int log_min_duration_statement = -1;
376 int log_temp_files = -1;
378 int num_temp_buffers = 1000;
380 char *ConfigFileName;
383 char *external_pid_file;
385 char *pgstat_temp_directory;
387 int tcp_keepalives_idle;
388 int tcp_keepalives_interval;
389 int tcp_keepalives_count;
392 * These variables are all dummies that don't do anything, except in some
393 * cases provide the value for SHOW to display. The real state is elsewhere
394 * and is kept in sync by assign_hooks.
396 static char *log_destination_string;
399 static char *syslog_ident_str;
401 static bool phony_autocommit;
402 static bool session_auth_is_superuser;
403 static double phony_random_seed;
404 static char *client_encoding_string;
405 static char *datestyle_string;
406 static char *locale_collate;
407 static char *locale_ctype;
408 static char *server_encoding_string;
409 static char *server_version_string;
410 static int server_version_num;
411 static char *timezone_string;
412 static char *log_timezone_string;
413 static char *timezone_abbreviations_string;
414 static char *XactIsoLevel_string;
415 static char *data_directory;
416 static char *custom_variable_classes;
417 static int max_function_args;
418 static int max_index_keys;
419 static int max_identifier_length;
420 static int block_size;
421 static int segment_size;
422 static int wal_block_size;
423 static int wal_segment_size;
424 static bool integer_datetimes;
425 static int effective_io_concurrency;
427 /* should be static, but commands/variable.c needs to get at these */
429 char *session_authorization_string;
433 * Displayable names for context types (enum GucContext)
435 * Note: these strings are deliberately not localized.
437 const char *const GucContext_Names[] =
439 /* PGC_INTERNAL */ "internal",
440 /* PGC_POSTMASTER */ "postmaster",
441 /* PGC_SIGHUP */ "sighup",
442 /* PGC_BACKEND */ "backend",
443 /* PGC_SUSET */ "superuser",
444 /* PGC_USERSET */ "user"
448 * Displayable names for source types (enum GucSource)
450 * Note: these strings are deliberately not localized.
452 const char *const GucSource_Names[] =
454 /* PGC_S_DEFAULT */ "default",
455 /* PGC_S_ENV_VAR */ "environment variable",
456 /* PGC_S_FILE */ "configuration file",
457 /* PGC_S_ARGV */ "command line",
458 /* PGC_S_DATABASE */ "database",
459 /* PGC_S_USER */ "user",
460 /* PGC_S_CLIENT */ "client",
461 /* PGC_S_OVERRIDE */ "override",
462 /* PGC_S_INTERACTIVE */ "interactive",
463 /* PGC_S_TEST */ "test",
464 /* PGC_S_SESSION */ "session"
468 * Displayable names for the groupings defined in enum config_group
470 const char *const config_group_names[] =
473 gettext_noop("Ungrouped"),
475 gettext_noop("File Locations"),
477 gettext_noop("Connections and Authentication"),
478 /* CONN_AUTH_SETTINGS */
479 gettext_noop("Connections and Authentication / Connection Settings"),
480 /* CONN_AUTH_SECURITY */
481 gettext_noop("Connections and Authentication / Security and Authentication"),
483 gettext_noop("Resource Usage"),
485 gettext_noop("Resource Usage / Memory"),
486 /* RESOURCES_KERNEL */
487 gettext_noop("Resource Usage / Kernel Resources"),
489 gettext_noop("Write-Ahead Log"),
491 gettext_noop("Write-Ahead Log / Settings"),
492 /* WAL_CHECKPOINTS */
493 gettext_noop("Write-Ahead Log / Checkpoints"),
495 gettext_noop("Query Tuning"),
496 /* QUERY_TUNING_METHOD */
497 gettext_noop("Query Tuning / Planner Method Configuration"),
498 /* QUERY_TUNING_COST */
499 gettext_noop("Query Tuning / Planner Cost Constants"),
500 /* QUERY_TUNING_GEQO */
501 gettext_noop("Query Tuning / Genetic Query Optimizer"),
502 /* QUERY_TUNING_OTHER */
503 gettext_noop("Query Tuning / Other Planner Options"),
505 gettext_noop("Reporting and Logging"),
507 gettext_noop("Reporting and Logging / Where to Log"),
509 gettext_noop("Reporting and Logging / When to Log"),
511 gettext_noop("Reporting and Logging / What to Log"),
513 gettext_noop("Statistics"),
514 /* STATS_MONITORING */
515 gettext_noop("Statistics / Monitoring"),
516 /* STATS_COLLECTOR */
517 gettext_noop("Statistics / Query and Index Statistics Collector"),
519 gettext_noop("Autovacuum"),
521 gettext_noop("Client Connection Defaults"),
522 /* CLIENT_CONN_STATEMENT */
523 gettext_noop("Client Connection Defaults / Statement Behavior"),
524 /* CLIENT_CONN_LOCALE */
525 gettext_noop("Client Connection Defaults / Locale and Formatting"),
526 /* CLIENT_CONN_OTHER */
527 gettext_noop("Client Connection Defaults / Other Defaults"),
528 /* LOCK_MANAGEMENT */
529 gettext_noop("Lock Management"),
531 gettext_noop("Version and Platform Compatibility"),
532 /* COMPAT_OPTIONS_PREVIOUS */
533 gettext_noop("Version and Platform Compatibility / Previous PostgreSQL Versions"),
534 /* COMPAT_OPTIONS_CLIENT */
535 gettext_noop("Version and Platform Compatibility / Other Platforms and Clients"),
537 gettext_noop("Preset Options"),
539 gettext_noop("Customized Options"),
540 /* DEVELOPER_OPTIONS */
541 gettext_noop("Developer Options"),
542 /* help_config wants this array to be null-terminated */
547 * Displayable names for GUC variable types (enum config_type)
549 * Note: these strings are deliberately not localized.
551 const char *const config_type_names[] =
553 /* PGC_BOOL */ "bool",
554 /* PGC_INT */ "integer",
555 /* PGC_REAL */ "real",
556 /* PGC_STRING */ "string",
557 /* PGC_ENUM */ "enum"
562 * Contents of GUC tables
564 * See src/backend/utils/misc/README for design notes.
568 * 1. Declare a global variable of type bool, int, double, or char*
569 * and make use of it.
571 * 2. Decide at what times it's safe to set the option. See guc.h for
574 * 3. Decide on a name, a default value, upper and lower bounds (if
577 * 4. Add a record below.
579 * 5. Add it to src/backend/utils/misc/postgresql.conf.sample, if
582 * 6. Don't forget to document the option (at least in config.sgml).
584 * 7. If it's a new GUC_LIST option you must edit pg_dumpall.c to ensure
585 * it is not single quoted at dump time.
589 /******** option records follow ********/
591 static struct config_bool ConfigureNamesBool[] =
594 {"enable_seqscan", PGC_USERSET, QUERY_TUNING_METHOD,
595 gettext_noop("Enables the planner's use of sequential-scan plans."),
602 {"enable_indexscan", PGC_USERSET, QUERY_TUNING_METHOD,
603 gettext_noop("Enables the planner's use of index-scan plans."),
610 {"enable_bitmapscan", PGC_USERSET, QUERY_TUNING_METHOD,
611 gettext_noop("Enables the planner's use of bitmap-scan plans."),
618 {"enable_tidscan", PGC_USERSET, QUERY_TUNING_METHOD,
619 gettext_noop("Enables the planner's use of TID scan plans."),
626 {"enable_sort", PGC_USERSET, QUERY_TUNING_METHOD,
627 gettext_noop("Enables the planner's use of explicit sort steps."),
634 {"enable_hashagg", PGC_USERSET, QUERY_TUNING_METHOD,
635 gettext_noop("Enables the planner's use of hashed aggregation plans."),
642 {"enable_nestloop", PGC_USERSET, QUERY_TUNING_METHOD,
643 gettext_noop("Enables the planner's use of nested-loop join plans."),
650 {"enable_mergejoin", PGC_USERSET, QUERY_TUNING_METHOD,
651 gettext_noop("Enables the planner's use of merge join plans."),
658 {"enable_hashjoin", PGC_USERSET, QUERY_TUNING_METHOD,
659 gettext_noop("Enables the planner's use of hash join plans."),
666 {"geqo", PGC_USERSET, QUERY_TUNING_GEQO,
667 gettext_noop("Enables genetic query optimization."),
668 gettext_noop("This algorithm attempts to do planning without "
669 "exhaustive searching.")
675 /* Not for general use --- used by SET SESSION AUTHORIZATION */
676 {"is_superuser", PGC_INTERNAL, UNGROUPED,
677 gettext_noop("Shows whether the current user is a superuser."),
679 GUC_REPORT | GUC_NO_SHOW_ALL | GUC_NO_RESET_ALL | GUC_NOT_IN_SAMPLE | GUC_DISALLOW_IN_FILE
681 &session_auth_is_superuser,
685 {"ssl", PGC_POSTMASTER, CONN_AUTH_SECURITY,
686 gettext_noop("Enables SSL connections."),
690 false, assign_ssl, NULL
693 {"fsync", PGC_SIGHUP, WAL_SETTINGS,
694 gettext_noop("Forces synchronization of updates to disk."),
695 gettext_noop("The server will use the fsync() system call in several places to make "
696 "sure that updates are physically written to disk. This insures "
697 "that a database cluster will recover to a consistent state after "
698 "an operating system or hardware crash.")
704 {"synchronous_commit", PGC_USERSET, WAL_SETTINGS,
705 gettext_noop("Sets immediate fsync at commit."),
712 {"zero_damaged_pages", PGC_SUSET, DEVELOPER_OPTIONS,
713 gettext_noop("Continues processing past damaged page headers."),
714 gettext_noop("Detection of a damaged page header normally causes PostgreSQL to "
715 "report an error, aborting the current transaction. Setting "
716 "zero_damaged_pages to true causes the system to instead report a "
717 "warning, zero out the damaged page, and continue processing. This "
718 "behavior will destroy data, namely all the rows on the damaged page."),
725 {"full_page_writes", PGC_SIGHUP, WAL_SETTINGS,
726 gettext_noop("Writes full pages to WAL when first modified after a checkpoint."),
727 gettext_noop("A page write in process during an operating system crash might be "
728 "only partially written to disk. During recovery, the row changes "
729 "stored in WAL are not enough to recover. This option writes "
730 "pages when first modified after a checkpoint to WAL so full recovery "
737 {"silent_mode", PGC_POSTMASTER, LOGGING_WHERE,
738 gettext_noop("Runs the server silently."),
739 gettext_noop("If this parameter is set, the server will automatically run in the "
740 "background and any controlling terminals are dissociated.")
746 {"log_checkpoints", PGC_SIGHUP, LOGGING_WHAT,
747 gettext_noop("Logs each checkpoint."),
754 {"log_connections", PGC_BACKEND, LOGGING_WHAT,
755 gettext_noop("Logs each successful connection."),
762 {"log_disconnections", PGC_BACKEND, LOGGING_WHAT,
763 gettext_noop("Logs end of a session, including duration."),
770 {"debug_assertions", PGC_USERSET, DEVELOPER_OPTIONS,
771 gettext_noop("Turns on various assertion checks."),
772 gettext_noop("This is a debugging aid."),
776 #ifdef USE_ASSERT_CHECKING
781 assign_debug_assertions, NULL
784 /* currently undocumented, so don't show in SHOW ALL */
785 {"exit_on_error", PGC_USERSET, UNGROUPED,
786 gettext_noop("No description available."),
788 GUC_NO_SHOW_ALL | GUC_NOT_IN_SAMPLE
794 {"log_duration", PGC_SUSET, LOGGING_WHAT,
795 gettext_noop("Logs the duration of each completed SQL statement."),
802 {"debug_print_parse", PGC_USERSET, LOGGING_WHAT,
803 gettext_noop("Logs each query's parse tree."),
810 {"debug_print_rewritten", PGC_USERSET, LOGGING_WHAT,
811 gettext_noop("Logs each query's rewritten parse tree."),
814 &Debug_print_rewritten,
818 {"debug_print_plan", PGC_USERSET, LOGGING_WHAT,
819 gettext_noop("Logs each query's execution plan."),
826 {"debug_pretty_print", PGC_USERSET, LOGGING_WHAT,
827 gettext_noop("Indents parse and plan tree displays."),
834 {"log_parser_stats", PGC_SUSET, STATS_MONITORING,
835 gettext_noop("Writes parser performance statistics to the server log."),
839 false, assign_stage_log_stats, NULL
842 {"log_planner_stats", PGC_SUSET, STATS_MONITORING,
843 gettext_noop("Writes planner performance statistics to the server log."),
847 false, assign_stage_log_stats, NULL
850 {"log_executor_stats", PGC_SUSET, STATS_MONITORING,
851 gettext_noop("Writes executor performance statistics to the server log."),
855 false, assign_stage_log_stats, NULL
858 {"log_statement_stats", PGC_SUSET, STATS_MONITORING,
859 gettext_noop("Writes cumulative performance statistics to the server log."),
862 &log_statement_stats,
863 false, assign_log_stats, NULL
865 #ifdef BTREE_BUILD_STATS
867 {"log_btree_build_stats", PGC_SUSET, DEVELOPER_OPTIONS,
868 gettext_noop("No description available."),
872 &log_btree_build_stats,
878 {"track_activities", PGC_SUSET, STATS_COLLECTOR,
879 gettext_noop("Collects information about executing commands."),
880 gettext_noop("Enables the collection of information on the currently "
881 "executing command of each session, along with "
882 "the time at which that command began execution.")
884 &pgstat_track_activities,
888 {"track_counts", PGC_SUSET, STATS_COLLECTOR,
889 gettext_noop("Collects statistics on database activity."),
892 &pgstat_track_counts,
897 {"update_process_title", PGC_SUSET, STATS_COLLECTOR,
898 gettext_noop("Updates the process title to show the active SQL command."),
899 gettext_noop("Enables updating of the process title every time a new SQL command is received by the server.")
901 &update_process_title,
906 {"autovacuum", PGC_SIGHUP, AUTOVACUUM,
907 gettext_noop("Starts the autovacuum subprocess."),
910 &autovacuum_start_daemon,
915 {"trace_notify", PGC_USERSET, DEVELOPER_OPTIONS,
916 gettext_noop("Generates debugging output for LISTEN and NOTIFY."),
926 {"trace_locks", PGC_SUSET, DEVELOPER_OPTIONS,
927 gettext_noop("No description available."),
935 {"trace_userlocks", PGC_SUSET, DEVELOPER_OPTIONS,
936 gettext_noop("No description available."),
944 {"trace_lwlocks", PGC_SUSET, DEVELOPER_OPTIONS,
945 gettext_noop("No description available."),
953 {"debug_deadlocks", PGC_SUSET, DEVELOPER_OPTIONS,
954 gettext_noop("No description available."),
964 {"log_lock_waits", PGC_SUSET, LOGGING_WHAT,
965 gettext_noop("Logs long lock waits."),
973 {"log_hostname", PGC_SIGHUP, LOGGING_WHAT,
974 gettext_noop("Logs the host name in the connection logs."),
975 gettext_noop("By default, connection logs only show the IP address "
976 "of the connecting host. If you want them to show the host name you "
977 "can turn this on, but depending on your host name resolution "
978 "setup it might impose a non-negligible performance penalty.")
984 {"sql_inheritance", PGC_USERSET, COMPAT_OPTIONS_PREVIOUS,
985 gettext_noop("Causes subtables to be included by default in various commands."),
992 {"password_encryption", PGC_USERSET, CONN_AUTH_SECURITY,
993 gettext_noop("Encrypt passwords."),
994 gettext_noop("When a password is specified in CREATE USER or "
995 "ALTER USER without writing either ENCRYPTED or UNENCRYPTED, "
996 "this parameter determines whether the password is to be encrypted.")
998 &Password_encryption,
1002 {"transform_null_equals", PGC_USERSET, COMPAT_OPTIONS_CLIENT,
1003 gettext_noop("Treats \"expr=NULL\" as \"expr IS NULL\"."),
1004 gettext_noop("When turned on, expressions of the form expr = NULL "
1005 "(or NULL = expr) are treated as expr IS NULL, that is, they "
1006 "return true if expr evaluates to the null value, and false "
1007 "otherwise. The correct behavior of expr = NULL is to always "
1008 "return null (unknown).")
1010 &Transform_null_equals,
1014 {"db_user_namespace", PGC_SIGHUP, CONN_AUTH_SECURITY,
1015 gettext_noop("Enables per-database user names."),
1022 /* only here for backwards compatibility */
1023 {"autocommit", PGC_USERSET, CLIENT_CONN_STATEMENT,
1024 gettext_noop("This parameter doesn't do anything."),
1025 gettext_noop("It's just here so that we won't choke on SET AUTOCOMMIT TO ON from 7.3-vintage clients."),
1026 GUC_NO_SHOW_ALL | GUC_NOT_IN_SAMPLE
1029 true, assign_phony_autocommit, NULL
1032 {"default_transaction_read_only", PGC_USERSET, CLIENT_CONN_STATEMENT,
1033 gettext_noop("Sets the default read-only status of new transactions."),
1036 &DefaultXactReadOnly,
1040 {"transaction_read_only", PGC_USERSET, CLIENT_CONN_STATEMENT,
1041 gettext_noop("Sets the current transaction's read-only status."),
1043 GUC_NO_RESET_ALL | GUC_NOT_IN_SAMPLE | GUC_DISALLOW_IN_FILE
1046 false, assign_transaction_read_only, NULL
1049 {"add_missing_from", PGC_USERSET, COMPAT_OPTIONS_PREVIOUS,
1050 gettext_noop("Automatically adds missing table references to FROM clauses."),
1057 {"check_function_bodies", PGC_USERSET, CLIENT_CONN_STATEMENT,
1058 gettext_noop("Check function bodies during CREATE FUNCTION."),
1061 &check_function_bodies,
1065 {"array_nulls", PGC_USERSET, COMPAT_OPTIONS_PREVIOUS,
1066 gettext_noop("Enable input of NULL elements in arrays."),
1067 gettext_noop("When turned on, unquoted NULL in an array input "
1068 "value means a null value; "
1069 "otherwise it is taken literally.")
1075 {"default_with_oids", PGC_USERSET, COMPAT_OPTIONS_PREVIOUS,
1076 gettext_noop("Create new tables with OIDs by default."),
1083 {"logging_collector", PGC_POSTMASTER, LOGGING_WHERE,
1084 gettext_noop("Start a subprocess to capture stderr output and/or csvlogs into log files."),
1091 {"log_truncate_on_rotation", PGC_SIGHUP, LOGGING_WHERE,
1092 gettext_noop("Truncate existing log files of same name during log rotation."),
1095 &Log_truncate_on_rotation,
1101 {"trace_sort", PGC_USERSET, DEVELOPER_OPTIONS,
1102 gettext_noop("Emit information about resource usage in sorting."),
1111 #ifdef TRACE_SYNCSCAN
1112 /* this is undocumented because not exposed in a standard build */
1114 {"trace_syncscan", PGC_USERSET, DEVELOPER_OPTIONS,
1115 gettext_noop("Generate debugging output for synchronized scanning."),
1124 #ifdef DEBUG_BOUNDED_SORT
1125 /* this is undocumented because not exposed in a standard build */
1128 "optimize_bounded_sort", PGC_USERSET, QUERY_TUNING_METHOD,
1129 gettext_noop("Enable bounded sorting using heap sort."),
1133 &optimize_bounded_sort,
1140 {"wal_debug", PGC_SUSET, DEVELOPER_OPTIONS,
1141 gettext_noop("Emit WAL-related debugging output."),
1151 {"integer_datetimes", PGC_INTERNAL, PRESET_OPTIONS,
1152 gettext_noop("Datetimes are integer based."),
1154 GUC_REPORT | GUC_NOT_IN_SAMPLE | GUC_DISALLOW_IN_FILE
1157 #ifdef HAVE_INT64_TIMESTAMP
1165 {"krb_caseins_users", PGC_SIGHUP, CONN_AUTH_SECURITY,
1166 gettext_noop("Sets whether Kerberos and GSSAPI user names should be treated as case-insensitive."),
1169 &pg_krb_caseins_users,
1174 {"escape_string_warning", PGC_USERSET, COMPAT_OPTIONS_PREVIOUS,
1175 gettext_noop("Warn about backslash escapes in ordinary string literals."),
1178 &escape_string_warning,
1183 {"standard_conforming_strings", PGC_USERSET, COMPAT_OPTIONS_PREVIOUS,
1184 gettext_noop("Causes '...' strings to treat backslashes literally."),
1188 &standard_conforming_strings,
1193 {"synchronize_seqscans", PGC_USERSET, COMPAT_OPTIONS_PREVIOUS,
1194 gettext_noop("Enable synchronized sequential scans."),
1197 &synchronize_seqscans,
1202 {"archive_mode", PGC_POSTMASTER, WAL_SETTINGS,
1203 gettext_noop("Allows archiving of WAL files using archive_command."),
1211 {"allow_system_table_mods", PGC_POSTMASTER, DEVELOPER_OPTIONS,
1212 gettext_noop("Allows modifications of the structure of system tables."),
1216 &allowSystemTableMods,
1221 {"ignore_system_indexes", PGC_BACKEND, DEVELOPER_OPTIONS,
1222 gettext_noop("Disables reading from system indexes."),
1223 gettext_noop("It does not prevent updating the indexes, so it is safe "
1224 "to use. The worst consequence is slowness."),
1227 &IgnoreSystemIndexes,
1231 /* End-of-list marker */
1233 {NULL, 0, 0, NULL, NULL}, NULL, false, NULL, NULL
1238 static struct config_int ConfigureNamesInt[] =
1241 {"archive_timeout", PGC_SIGHUP, WAL_SETTINGS,
1242 gettext_noop("Forces a switch to the next xlog file if a "
1243 "new file has not been started within N seconds."),
1247 &XLogArchiveTimeout,
1248 0, 0, INT_MAX, NULL, NULL
1251 {"post_auth_delay", PGC_BACKEND, DEVELOPER_OPTIONS,
1252 gettext_noop("Waits N seconds on connection startup after authentication."),
1253 gettext_noop("This allows attaching a debugger to the process."),
1254 GUC_NOT_IN_SAMPLE | GUC_UNIT_S
1257 0, 0, INT_MAX, NULL, NULL
1260 {"default_statistics_target", PGC_USERSET, QUERY_TUNING_OTHER,
1261 gettext_noop("Sets the default statistics target."),
1262 gettext_noop("This applies to table columns that have not had a "
1263 "column-specific target set via ALTER TABLE SET STATISTICS.")
1265 &default_statistics_target,
1266 100, 1, 10000, NULL, NULL
1269 {"from_collapse_limit", PGC_USERSET, QUERY_TUNING_OTHER,
1270 gettext_noop("Sets the FROM-list size beyond which subqueries "
1271 "are not collapsed."),
1272 gettext_noop("The planner will merge subqueries into upper "
1273 "queries if the resulting FROM list would have no more than "
1276 &from_collapse_limit,
1277 8, 1, INT_MAX, NULL, NULL
1280 {"join_collapse_limit", PGC_USERSET, QUERY_TUNING_OTHER,
1281 gettext_noop("Sets the FROM-list size beyond which JOIN "
1282 "constructs are not flattened."),
1283 gettext_noop("The planner will flatten explicit JOIN "
1284 "constructs into lists of FROM items whenever a "
1285 "list of no more than this many items would result.")
1287 &join_collapse_limit,
1288 8, 1, INT_MAX, NULL, NULL
1291 {"geqo_threshold", PGC_USERSET, QUERY_TUNING_GEQO,
1292 gettext_noop("Sets the threshold of FROM items beyond which GEQO is used."),
1296 12, 2, INT_MAX, NULL, NULL
1299 {"geqo_effort", PGC_USERSET, QUERY_TUNING_GEQO,
1300 gettext_noop("GEQO: effort is used to set the default for other GEQO parameters."),
1304 DEFAULT_GEQO_EFFORT, MIN_GEQO_EFFORT, MAX_GEQO_EFFORT, NULL, NULL
1307 {"geqo_pool_size", PGC_USERSET, QUERY_TUNING_GEQO,
1308 gettext_noop("GEQO: number of individuals in the population."),
1309 gettext_noop("Zero selects a suitable default value.")
1312 0, 0, INT_MAX, NULL, NULL
1315 {"geqo_generations", PGC_USERSET, QUERY_TUNING_GEQO,
1316 gettext_noop("GEQO: number of iterations of the algorithm."),
1317 gettext_noop("Zero selects a suitable default value.")
1320 0, 0, INT_MAX, NULL, NULL
1324 /* This is PGC_SIGHUP so all backends have the same value. */
1325 {"deadlock_timeout", PGC_SIGHUP, LOCK_MANAGEMENT,
1326 gettext_noop("Sets the time to wait on a lock before checking for deadlock."),
1331 1000, 1, INT_MAX / 1000, NULL, NULL
1335 * Note: MaxBackends is limited to INT_MAX/4 because some places compute
1336 * 4*MaxBackends without any overflow check. This check is made in
1337 * assign_maxconnections, since MaxBackends is computed as MaxConnections
1338 * plus autovacuum_max_workers plus one (for the autovacuum launcher).
1340 * Likewise we have to limit NBuffers to INT_MAX/2.
1343 {"max_connections", PGC_POSTMASTER, CONN_AUTH_SETTINGS,
1344 gettext_noop("Sets the maximum number of concurrent connections."),
1348 100, 1, INT_MAX / 4, assign_maxconnections, NULL
1352 {"superuser_reserved_connections", PGC_POSTMASTER, CONN_AUTH_SETTINGS,
1353 gettext_noop("Sets the number of connection slots reserved for superusers."),
1357 3, 0, INT_MAX / 4, NULL, NULL
1361 {"shared_buffers", PGC_POSTMASTER, RESOURCES_MEM,
1362 gettext_noop("Sets the number of shared memory buffers used by the server."),
1367 1024, 16, INT_MAX / 2, NULL, NULL
1371 {"temp_buffers", PGC_USERSET, RESOURCES_MEM,
1372 gettext_noop("Sets the maximum number of temporary buffers used by each session."),
1377 1024, 100, INT_MAX / 2, NULL, show_num_temp_buffers
1381 {"port", PGC_POSTMASTER, CONN_AUTH_SETTINGS,
1382 gettext_noop("Sets the TCP port the server listens on."),
1386 DEF_PGPORT, 1, 65535, NULL, NULL
1390 {"unix_socket_permissions", PGC_POSTMASTER, CONN_AUTH_SETTINGS,
1391 gettext_noop("Sets the access permissions of the Unix-domain socket."),
1392 gettext_noop("Unix-domain sockets use the usual Unix file system "
1393 "permission set. The parameter value is expected to be a numeric mode "
1394 "specification in the form accepted by the chmod and umask system "
1395 "calls. (To use the customary octal format the number must start with "
1398 &Unix_socket_permissions,
1399 0777, 0000, 0777, NULL, NULL
1403 {"work_mem", PGC_USERSET, RESOURCES_MEM,
1404 gettext_noop("Sets the maximum memory to be used for query workspaces."),
1405 gettext_noop("This much memory can be used by each internal "
1406 "sort operation and hash table before switching to "
1407 "temporary disk files."),
1411 1024, 64, MAX_KILOBYTES, NULL, NULL
1415 {"maintenance_work_mem", PGC_USERSET, RESOURCES_MEM,
1416 gettext_noop("Sets the maximum memory to be used for maintenance operations."),
1417 gettext_noop("This includes operations such as VACUUM and CREATE INDEX."),
1420 &maintenance_work_mem,
1421 16384, 1024, MAX_KILOBYTES, NULL, NULL
1425 {"max_stack_depth", PGC_SUSET, RESOURCES_MEM,
1426 gettext_noop("Sets the maximum stack depth, in kilobytes."),
1431 100, 100, MAX_KILOBYTES, assign_max_stack_depth, NULL
1435 {"vacuum_cost_page_hit", PGC_USERSET, RESOURCES,
1436 gettext_noop("Vacuum cost for a page found in the buffer cache."),
1440 1, 0, 10000, NULL, NULL
1444 {"vacuum_cost_page_miss", PGC_USERSET, RESOURCES,
1445 gettext_noop("Vacuum cost for a page not found in the buffer cache."),
1448 &VacuumCostPageMiss,
1449 10, 0, 10000, NULL, NULL
1453 {"vacuum_cost_page_dirty", PGC_USERSET, RESOURCES,
1454 gettext_noop("Vacuum cost for a page dirtied by vacuum."),
1457 &VacuumCostPageDirty,
1458 20, 0, 10000, NULL, NULL
1462 {"vacuum_cost_limit", PGC_USERSET, RESOURCES,
1463 gettext_noop("Vacuum cost amount available before napping."),
1467 200, 1, 10000, NULL, NULL
1471 {"vacuum_cost_delay", PGC_USERSET, RESOURCES,
1472 gettext_noop("Vacuum cost delay in milliseconds."),
1477 0, 0, 100, NULL, NULL
1481 {"autovacuum_vacuum_cost_delay", PGC_SIGHUP, AUTOVACUUM,
1482 gettext_noop("Vacuum cost delay in milliseconds, for autovacuum."),
1486 &autovacuum_vac_cost_delay,
1487 20, -1, 100, NULL, NULL
1491 {"autovacuum_vacuum_cost_limit", PGC_SIGHUP, AUTOVACUUM,
1492 gettext_noop("Vacuum cost amount available before napping, for autovacuum."),
1495 &autovacuum_vac_cost_limit,
1496 -1, -1, 10000, NULL, NULL
1500 {"max_files_per_process", PGC_POSTMASTER, RESOURCES_KERNEL,
1501 gettext_noop("Sets the maximum number of simultaneously open files for each server process."),
1504 &max_files_per_process,
1505 1000, 25, INT_MAX, NULL, NULL
1509 {"max_prepared_transactions", PGC_POSTMASTER, RESOURCES,
1510 gettext_noop("Sets the maximum number of simultaneously prepared transactions."),
1513 &max_prepared_xacts,
1514 0, 0, INT_MAX / 4, NULL, NULL
1519 {"trace_lock_oidmin", PGC_SUSET, DEVELOPER_OPTIONS,
1520 gettext_noop("No description available."),
1525 FirstNormalObjectId, 0, INT_MAX, NULL, NULL
1528 {"trace_lock_table", PGC_SUSET, DEVELOPER_OPTIONS,
1529 gettext_noop("No description available."),
1534 0, 0, INT_MAX, NULL, NULL
1539 {"statement_timeout", PGC_USERSET, CLIENT_CONN_STATEMENT,
1540 gettext_noop("Sets the maximum allowed duration of any statement."),
1541 gettext_noop("A value of 0 turns off the timeout."),
1545 0, 0, INT_MAX, NULL, NULL
1549 {"vacuum_freeze_min_age", PGC_USERSET, CLIENT_CONN_STATEMENT,
1550 gettext_noop("Minimum age at which VACUUM should freeze a table row."),
1553 &vacuum_freeze_min_age,
1554 50000000, 0, 1000000000, NULL, NULL
1558 {"vacuum_freeze_table_age", PGC_USERSET, CLIENT_CONN_STATEMENT,
1559 gettext_noop("Age at which VACUUM should scan whole table to freeze tuples."),
1562 &vacuum_freeze_table_age,
1563 150000000, 0, 2000000000, NULL, NULL
1567 {"max_locks_per_transaction", PGC_POSTMASTER, LOCK_MANAGEMENT,
1568 gettext_noop("Sets the maximum number of locks per transaction."),
1569 gettext_noop("The shared lock table is sized on the assumption that "
1570 "at most max_locks_per_transaction * max_connections distinct "
1571 "objects will need to be locked at any one time.")
1573 &max_locks_per_xact,
1574 64, 10, INT_MAX, NULL, NULL
1578 {"authentication_timeout", PGC_SIGHUP, CONN_AUTH_SECURITY,
1579 gettext_noop("Sets the maximum allowed time to complete client authentication."),
1583 &AuthenticationTimeout,
1584 60, 1, 600, NULL, NULL
1588 /* Not for general use */
1589 {"pre_auth_delay", PGC_SIGHUP, DEVELOPER_OPTIONS,
1590 gettext_noop("Waits N seconds on connection startup before authentication."),
1591 gettext_noop("This allows attaching a debugger to the process."),
1592 GUC_NOT_IN_SAMPLE | GUC_UNIT_S
1595 0, 0, 60, NULL, NULL
1599 {"checkpoint_segments", PGC_SIGHUP, WAL_CHECKPOINTS,
1600 gettext_noop("Sets the maximum distance in log segments between automatic WAL checkpoints."),
1603 &CheckPointSegments,
1604 3, 1, INT_MAX, NULL, NULL
1608 {"checkpoint_timeout", PGC_SIGHUP, WAL_CHECKPOINTS,
1609 gettext_noop("Sets the maximum time between automatic WAL checkpoints."),
1614 300, 30, 3600, NULL, NULL
1618 {"checkpoint_warning", PGC_SIGHUP, WAL_CHECKPOINTS,
1619 gettext_noop("Enables warnings if checkpoint segments are filled more "
1620 "frequently than this."),
1621 gettext_noop("Write a message to the server log if checkpoints "
1622 "caused by the filling of checkpoint segment files happens more "
1623 "frequently than this number of seconds. Zero turns off the warning."),
1627 30, 0, INT_MAX, NULL, NULL
1631 {"wal_buffers", PGC_POSTMASTER, WAL_SETTINGS,
1632 gettext_noop("Sets the number of disk-page buffers in shared memory for WAL."),
1637 8, 4, INT_MAX, NULL, NULL
1641 {"wal_writer_delay", PGC_SIGHUP, WAL_SETTINGS,
1642 gettext_noop("WAL writer sleep time between WAL flushes."),
1647 200, 1, 10000, NULL, NULL
1651 {"commit_delay", PGC_USERSET, WAL_SETTINGS,
1652 gettext_noop("Sets the delay in microseconds between transaction commit and "
1653 "flushing WAL to disk."),
1657 0, 0, 100000, NULL, NULL
1661 {"commit_siblings", PGC_USERSET, WAL_SETTINGS,
1662 gettext_noop("Sets the minimum concurrent open transactions before performing "
1667 5, 1, 1000, NULL, NULL
1671 {"extra_float_digits", PGC_USERSET, CLIENT_CONN_LOCALE,
1672 gettext_noop("Sets the number of digits displayed for floating-point values."),
1673 gettext_noop("This affects real, double precision, and geometric data types. "
1674 "The parameter value is added to the standard number of digits "
1675 "(FLT_DIG or DBL_DIG as appropriate).")
1677 &extra_float_digits,
1678 0, -15, 2, NULL, NULL
1682 {"log_min_duration_statement", PGC_SUSET, LOGGING_WHEN,
1683 gettext_noop("Sets the minimum execution time above which "
1684 "statements will be logged."),
1685 gettext_noop("Zero prints all queries. -1 turns this feature off."),
1688 &log_min_duration_statement,
1689 -1, -1, INT_MAX / 1000, NULL, NULL
1693 {"log_autovacuum_min_duration", PGC_SIGHUP, LOGGING_WHAT,
1694 gettext_noop("Sets the minimum execution time above which "
1695 "autovacuum actions will be logged."),
1696 gettext_noop("Zero prints all actions. -1 turns autovacuum logging off."),
1699 &Log_autovacuum_min_duration,
1700 -1, -1, INT_MAX / 1000, NULL, NULL
1704 {"bgwriter_delay", PGC_SIGHUP, RESOURCES,
1705 gettext_noop("Background writer sleep time between rounds."),
1710 200, 10, 10000, NULL, NULL
1714 {"bgwriter_lru_maxpages", PGC_SIGHUP, RESOURCES,
1715 gettext_noop("Background writer maximum number of LRU pages to flush per round."),
1718 &bgwriter_lru_maxpages,
1719 100, 0, 1000, NULL, NULL
1723 {"effective_io_concurrency",
1730 gettext_noop("Number of simultaneous requests that can be handled efficiently by the disk subsystem."),
1731 gettext_noop("For RAID arrays, this should be approximately the number of drive spindles in the array.")
1733 &effective_io_concurrency,
1739 assign_effective_io_concurrency, NULL
1743 {"log_rotation_age", PGC_SIGHUP, LOGGING_WHERE,
1744 gettext_noop("Automatic log file rotation will occur after N minutes."),
1749 HOURS_PER_DAY * MINS_PER_HOUR, 0, INT_MAX / MINS_PER_HOUR, NULL, NULL
1753 {"log_rotation_size", PGC_SIGHUP, LOGGING_WHERE,
1754 gettext_noop("Automatic log file rotation will occur after N kilobytes."),
1759 10 * 1024, 0, INT_MAX / 1024, NULL, NULL
1763 {"max_function_args", PGC_INTERNAL, PRESET_OPTIONS,
1764 gettext_noop("Shows the maximum number of function arguments."),
1766 GUC_NOT_IN_SAMPLE | GUC_DISALLOW_IN_FILE
1769 FUNC_MAX_ARGS, FUNC_MAX_ARGS, FUNC_MAX_ARGS, NULL, NULL
1773 {"max_index_keys", PGC_INTERNAL, PRESET_OPTIONS,
1774 gettext_noop("Shows the maximum number of index keys."),
1776 GUC_NOT_IN_SAMPLE | GUC_DISALLOW_IN_FILE
1779 INDEX_MAX_KEYS, INDEX_MAX_KEYS, INDEX_MAX_KEYS, NULL, NULL
1783 {"max_identifier_length", PGC_INTERNAL, PRESET_OPTIONS,
1784 gettext_noop("Shows the maximum identifier length."),
1786 GUC_NOT_IN_SAMPLE | GUC_DISALLOW_IN_FILE
1788 &max_identifier_length,
1789 NAMEDATALEN - 1, NAMEDATALEN - 1, NAMEDATALEN - 1, NULL, NULL
1793 {"block_size", PGC_INTERNAL, PRESET_OPTIONS,
1794 gettext_noop("Shows the size of a disk block."),
1796 GUC_NOT_IN_SAMPLE | GUC_DISALLOW_IN_FILE
1799 BLCKSZ, BLCKSZ, BLCKSZ, NULL, NULL
1803 {"segment_size", PGC_INTERNAL, PRESET_OPTIONS,
1804 gettext_noop("Shows the number of pages per disk file."),
1806 GUC_UNIT_BLOCKS | GUC_NOT_IN_SAMPLE | GUC_DISALLOW_IN_FILE
1809 RELSEG_SIZE, RELSEG_SIZE, RELSEG_SIZE, NULL, NULL
1813 {"wal_block_size", PGC_INTERNAL, PRESET_OPTIONS,
1814 gettext_noop("Shows the block size in the write ahead log."),
1816 GUC_NOT_IN_SAMPLE | GUC_DISALLOW_IN_FILE
1819 XLOG_BLCKSZ, XLOG_BLCKSZ, XLOG_BLCKSZ, NULL, NULL
1823 {"wal_segment_size", PGC_INTERNAL, PRESET_OPTIONS,
1824 gettext_noop("Shows the number of pages per write ahead log segment."),
1826 GUC_UNIT_XBLOCKS | GUC_NOT_IN_SAMPLE | GUC_DISALLOW_IN_FILE
1829 (XLOG_SEG_SIZE / XLOG_BLCKSZ),
1830 (XLOG_SEG_SIZE / XLOG_BLCKSZ),
1831 (XLOG_SEG_SIZE / XLOG_BLCKSZ),
1836 {"autovacuum_naptime", PGC_SIGHUP, AUTOVACUUM,
1837 gettext_noop("Time to sleep between autovacuum runs."),
1841 &autovacuum_naptime,
1842 60, 1, INT_MAX / 1000, NULL, NULL
1845 {"autovacuum_vacuum_threshold", PGC_SIGHUP, AUTOVACUUM,
1846 gettext_noop("Minimum number of tuple updates or deletes prior to vacuum."),
1849 &autovacuum_vac_thresh,
1850 50, 0, INT_MAX, NULL, NULL
1853 {"autovacuum_analyze_threshold", PGC_SIGHUP, AUTOVACUUM,
1854 gettext_noop("Minimum number of tuple inserts, updates or deletes prior to analyze."),
1857 &autovacuum_anl_thresh,
1858 50, 0, INT_MAX, NULL, NULL
1861 /* see varsup.c for why this is PGC_POSTMASTER not PGC_SIGHUP */
1862 {"autovacuum_freeze_max_age", PGC_POSTMASTER, AUTOVACUUM,
1863 gettext_noop("Age at which to autovacuum a table to prevent transaction ID wraparound."),
1866 &autovacuum_freeze_max_age,
1867 /* see pg_resetxlog if you change the upper-limit value */
1868 200000000, 100000000, 2000000000, NULL, NULL
1871 /* see max_connections */
1872 {"autovacuum_max_workers", PGC_POSTMASTER, AUTOVACUUM,
1873 gettext_noop("Sets the maximum number of simultaneously running autovacuum worker processes."),
1876 &autovacuum_max_workers,
1877 3, 1, INT_MAX / 4, assign_autovacuum_max_workers, NULL
1881 {"tcp_keepalives_idle", PGC_USERSET, CLIENT_CONN_OTHER,
1882 gettext_noop("Time between issuing TCP keepalives."),
1883 gettext_noop("A value of 0 uses the system default."),
1886 &tcp_keepalives_idle,
1887 0, 0, INT_MAX, assign_tcp_keepalives_idle, show_tcp_keepalives_idle
1891 {"tcp_keepalives_interval", PGC_USERSET, CLIENT_CONN_OTHER,
1892 gettext_noop("Time between TCP keepalive retransmits."),
1893 gettext_noop("A value of 0 uses the system default."),
1896 &tcp_keepalives_interval,
1897 0, 0, INT_MAX, assign_tcp_keepalives_interval, show_tcp_keepalives_interval
1901 {"tcp_keepalives_count", PGC_USERSET, CLIENT_CONN_OTHER,
1902 gettext_noop("Maximum number of TCP keepalive retransmits."),
1903 gettext_noop("This controls the number of consecutive keepalive retransmits that can be "
1904 "lost before a connection is considered dead. A value of 0 uses the "
1907 &tcp_keepalives_count,
1908 0, 0, INT_MAX, assign_tcp_keepalives_count, show_tcp_keepalives_count
1912 {"gin_fuzzy_search_limit", PGC_USERSET, CLIENT_CONN_OTHER,
1913 gettext_noop("Sets the maximum allowed result for exact search by GIN."),
1917 &GinFuzzySearchLimit,
1918 0, 0, INT_MAX, NULL, NULL
1922 {"effective_cache_size", PGC_USERSET, QUERY_TUNING_COST,
1923 gettext_noop("Sets the planner's assumption about the size of the disk cache."),
1924 gettext_noop("That is, the portion of the kernel's disk cache that "
1925 "will be used for PostgreSQL data files. This is measured in disk "
1926 "pages, which are normally 8 kB each."),
1929 &effective_cache_size,
1930 DEFAULT_EFFECTIVE_CACHE_SIZE, 1, INT_MAX, NULL, NULL
1934 /* Can't be set in postgresql.conf */
1935 {"server_version_num", PGC_INTERNAL, PRESET_OPTIONS,
1936 gettext_noop("Shows the server version as an integer."),
1938 GUC_NOT_IN_SAMPLE | GUC_DISALLOW_IN_FILE
1940 &server_version_num,
1941 PG_VERSION_NUM, PG_VERSION_NUM, PG_VERSION_NUM, NULL, NULL
1945 {"log_temp_files", PGC_SUSET, LOGGING_WHAT,
1946 gettext_noop("Log the use of temporary files larger than this number of kilobytes."),
1947 gettext_noop("Zero logs all files. The default is -1 (turning this feature off)."),
1951 -1, -1, INT_MAX, NULL, NULL
1955 {"track_activity_query_size", PGC_POSTMASTER, RESOURCES_MEM,
1956 gettext_noop("Sets the size reserved for pg_stat_activity.current_query, in bytes."),
1959 &pgstat_track_activity_query_size,
1960 1024, 100, 102400, NULL, NULL
1963 /* End-of-list marker */
1965 {NULL, 0, 0, NULL, NULL}, NULL, 0, 0, 0, NULL, NULL
1970 static struct config_real ConfigureNamesReal[] =
1973 {"seq_page_cost", PGC_USERSET, QUERY_TUNING_COST,
1974 gettext_noop("Sets the planner's estimate of the cost of a "
1975 "sequentially fetched disk page."),
1979 DEFAULT_SEQ_PAGE_COST, 0, DBL_MAX, NULL, NULL
1982 {"random_page_cost", PGC_USERSET, QUERY_TUNING_COST,
1983 gettext_noop("Sets the planner's estimate of the cost of a "
1984 "nonsequentially fetched disk page."),
1988 DEFAULT_RANDOM_PAGE_COST, 0, DBL_MAX, NULL, NULL
1991 {"cpu_tuple_cost", PGC_USERSET, QUERY_TUNING_COST,
1992 gettext_noop("Sets the planner's estimate of the cost of "
1993 "processing each tuple (row)."),
1997 DEFAULT_CPU_TUPLE_COST, 0, DBL_MAX, NULL, NULL
2000 {"cpu_index_tuple_cost", PGC_USERSET, QUERY_TUNING_COST,
2001 gettext_noop("Sets the planner's estimate of the cost of "
2002 "processing each index entry during an index scan."),
2005 &cpu_index_tuple_cost,
2006 DEFAULT_CPU_INDEX_TUPLE_COST, 0, DBL_MAX, NULL, NULL
2009 {"cpu_operator_cost", PGC_USERSET, QUERY_TUNING_COST,
2010 gettext_noop("Sets the planner's estimate of the cost of "
2011 "processing each operator or function call."),
2015 DEFAULT_CPU_OPERATOR_COST, 0, DBL_MAX, NULL, NULL
2019 {"cursor_tuple_fraction", PGC_USERSET, QUERY_TUNING_OTHER,
2020 gettext_noop("Sets the planner's estimate of the fraction of "
2021 "a cursor's rows that will be retrieved."),
2024 &cursor_tuple_fraction,
2025 DEFAULT_CURSOR_TUPLE_FRACTION, 0.0, 1.0, NULL, NULL
2029 {"geqo_selection_bias", PGC_USERSET, QUERY_TUNING_GEQO,
2030 gettext_noop("GEQO: selective pressure within the population."),
2033 &Geqo_selection_bias,
2034 DEFAULT_GEQO_SELECTION_BIAS, MIN_GEQO_SELECTION_BIAS,
2035 MAX_GEQO_SELECTION_BIAS, NULL, NULL
2038 {"geqo_seed", PGC_USERSET, QUERY_TUNING_GEQO,
2039 gettext_noop("GEQO: seed for random path selection."),
2043 0.0, 0.0, 1.0, NULL, NULL
2047 {"bgwriter_lru_multiplier", PGC_SIGHUP, RESOURCES,
2048 gettext_noop("Multiple of the average buffer usage to free per round."),
2051 &bgwriter_lru_multiplier,
2052 2.0, 0.0, 10.0, NULL, NULL
2056 {"seed", PGC_USERSET, UNGROUPED,
2057 gettext_noop("Sets the seed for random-number generation."),
2059 GUC_NO_SHOW_ALL | GUC_NO_RESET_ALL | GUC_NOT_IN_SAMPLE | GUC_DISALLOW_IN_FILE
2062 0.0, -1.0, 1.0, assign_random_seed, show_random_seed
2066 {"autovacuum_vacuum_scale_factor", PGC_SIGHUP, AUTOVACUUM,
2067 gettext_noop("Number of tuple updates or deletes prior to vacuum as a fraction of reltuples."),
2070 &autovacuum_vac_scale,
2071 0.2, 0.0, 100.0, NULL, NULL
2074 {"autovacuum_analyze_scale_factor", PGC_SIGHUP, AUTOVACUUM,
2075 gettext_noop("Number of tuple inserts, updates or deletes prior to analyze as a fraction of reltuples."),
2078 &autovacuum_anl_scale,
2079 0.1, 0.0, 100.0, NULL, NULL
2083 {"checkpoint_completion_target", PGC_SIGHUP, WAL_CHECKPOINTS,
2084 gettext_noop("Time spent flushing dirty buffers during checkpoint, as fraction of checkpoint interval."),
2087 &CheckPointCompletionTarget,
2088 0.5, 0.0, 1.0, NULL, NULL
2091 /* End-of-list marker */
2093 {NULL, 0, 0, NULL, NULL}, NULL, 0.0, 0.0, 0.0, NULL, NULL
2098 static struct config_string ConfigureNamesString[] =
2101 {"archive_command", PGC_SIGHUP, WAL_SETTINGS,
2102 gettext_noop("Sets the shell command that will be called to archive a WAL file."),
2105 &XLogArchiveCommand,
2106 "", NULL, show_archive_command
2110 {"client_encoding", PGC_USERSET, CLIENT_CONN_LOCALE,
2111 gettext_noop("Sets the client's character set encoding."),
2113 GUC_IS_NAME | GUC_REPORT
2115 &client_encoding_string,
2116 "SQL_ASCII", assign_client_encoding, NULL
2120 {"log_line_prefix", PGC_SIGHUP, LOGGING_WHAT,
2121 gettext_noop("Controls information prefixed to each log line."),
2122 gettext_noop("If blank, no prefix is used.")
2129 {"log_timezone", PGC_SIGHUP, LOGGING_WHAT,
2130 gettext_noop("Sets the time zone to use in log messages."),
2133 &log_timezone_string,
2134 "UNKNOWN", assign_log_timezone, show_log_timezone
2138 {"DateStyle", PGC_USERSET, CLIENT_CONN_LOCALE,
2139 gettext_noop("Sets the display format for date and time values."),
2140 gettext_noop("Also controls interpretation of ambiguous "
2142 GUC_LIST_INPUT | GUC_REPORT
2145 "ISO, MDY", assign_datestyle, NULL
2149 {"default_tablespace", PGC_USERSET, CLIENT_CONN_STATEMENT,
2150 gettext_noop("Sets the default tablespace to create tables and indexes in."),
2151 gettext_noop("An empty string selects the database's default tablespace."),
2154 &default_tablespace,
2155 "", assign_default_tablespace, NULL
2159 {"temp_tablespaces", PGC_USERSET, CLIENT_CONN_STATEMENT,
2160 gettext_noop("Sets the tablespace(s) to use for temporary tables and sort files."),
2162 GUC_LIST_INPUT | GUC_LIST_QUOTE
2165 "", assign_temp_tablespaces, NULL
2169 {"dynamic_library_path", PGC_SUSET, CLIENT_CONN_OTHER,
2170 gettext_noop("Sets the path for dynamically loadable modules."),
2171 gettext_noop("If a dynamically loadable module needs to be opened and "
2172 "the specified name does not have a directory component (i.e., the "
2173 "name does not contain a slash), the system will search this path for "
2174 "the specified file."),
2177 &Dynamic_library_path,
2178 "$libdir", NULL, NULL
2182 {"krb_server_keyfile", PGC_SIGHUP, CONN_AUTH_SECURITY,
2183 gettext_noop("Sets the location of the Kerberos server key file."),
2187 &pg_krb_server_keyfile,
2188 PG_KRB_SRVTAB, NULL, NULL
2192 {"krb_srvname", PGC_SIGHUP, CONN_AUTH_SECURITY,
2193 gettext_noop("Sets the name of the Kerberos service."),
2197 PG_KRB_SRVNAM, NULL, NULL
2201 {"bonjour_name", PGC_POSTMASTER, CONN_AUTH_SETTINGS,
2202 gettext_noop("Sets the Bonjour broadcast service name."),
2209 /* See main.c about why defaults for LC_foo are not all alike */
2212 {"lc_collate", PGC_INTERNAL, CLIENT_CONN_LOCALE,
2213 gettext_noop("Shows the collation order locale."),
2215 GUC_NOT_IN_SAMPLE | GUC_DISALLOW_IN_FILE
2222 {"lc_ctype", PGC_INTERNAL, CLIENT_CONN_LOCALE,
2223 gettext_noop("Shows the character classification and case conversion locale."),
2225 GUC_NOT_IN_SAMPLE | GUC_DISALLOW_IN_FILE
2232 {"lc_messages", PGC_SUSET, CLIENT_CONN_LOCALE,
2233 gettext_noop("Sets the language in which messages are displayed."),
2237 "", locale_messages_assign, NULL
2241 {"lc_monetary", PGC_USERSET, CLIENT_CONN_LOCALE,
2242 gettext_noop("Sets the locale for formatting monetary amounts."),
2246 "C", locale_monetary_assign, NULL
2250 {"lc_numeric", PGC_USERSET, CLIENT_CONN_LOCALE,
2251 gettext_noop("Sets the locale for formatting numbers."),
2255 "C", locale_numeric_assign, NULL
2259 {"lc_time", PGC_USERSET, CLIENT_CONN_LOCALE,
2260 gettext_noop("Sets the locale for formatting date and time values."),
2264 "C", locale_time_assign, NULL
2268 {"shared_preload_libraries", PGC_POSTMASTER, RESOURCES_KERNEL,
2269 gettext_noop("Lists shared libraries to preload into server."),
2271 GUC_LIST_INPUT | GUC_LIST_QUOTE | GUC_SUPERUSER_ONLY
2273 &shared_preload_libraries_string,
2278 {"local_preload_libraries", PGC_BACKEND, CLIENT_CONN_OTHER,
2279 gettext_noop("Lists shared libraries to preload into each backend."),
2281 GUC_LIST_INPUT | GUC_LIST_QUOTE
2283 &local_preload_libraries_string,
2288 {"search_path", PGC_USERSET, CLIENT_CONN_STATEMENT,
2289 gettext_noop("Sets the schema search order for names that are not schema-qualified."),
2291 GUC_LIST_INPUT | GUC_LIST_QUOTE
2293 &namespace_search_path,
2294 "\"$user\",public", assign_search_path, NULL
2298 /* Can't be set in postgresql.conf */
2299 {"server_encoding", PGC_INTERNAL, CLIENT_CONN_LOCALE,
2300 gettext_noop("Sets the server (database) character set encoding."),
2302 GUC_IS_NAME | GUC_REPORT | GUC_NOT_IN_SAMPLE | GUC_DISALLOW_IN_FILE
2304 &server_encoding_string,
2305 "SQL_ASCII", NULL, NULL
2309 /* Can't be set in postgresql.conf */
2310 {"server_version", PGC_INTERNAL, PRESET_OPTIONS,
2311 gettext_noop("Shows the server version."),
2313 GUC_REPORT | GUC_NOT_IN_SAMPLE | GUC_DISALLOW_IN_FILE
2315 &server_version_string,
2316 PG_VERSION, NULL, NULL
2320 /* Not for general use --- used by SET ROLE */
2321 {"role", PGC_USERSET, UNGROUPED,
2322 gettext_noop("Sets the current role."),
2324 GUC_IS_NAME | GUC_NO_SHOW_ALL | GUC_NO_RESET_ALL | GUC_NOT_IN_SAMPLE | GUC_DISALLOW_IN_FILE
2327 "none", assign_role, show_role
2331 /* Not for general use --- used by SET SESSION AUTHORIZATION */
2332 {"session_authorization", PGC_USERSET, UNGROUPED,
2333 gettext_noop("Sets the session user name."),
2335 GUC_IS_NAME | GUC_REPORT | GUC_NO_SHOW_ALL | GUC_NO_RESET_ALL | GUC_NOT_IN_SAMPLE | GUC_DISALLOW_IN_FILE
2337 &session_authorization_string,
2338 NULL, assign_session_authorization, show_session_authorization
2342 {"log_destination", PGC_SIGHUP, LOGGING_WHERE,
2343 gettext_noop("Sets the destination for server log output."),
2344 gettext_noop("Valid values are combinations of \"stderr\", "
2345 "\"syslog\", \"csvlog\", and \"eventlog\", "
2346 "depending on the platform."),
2349 &log_destination_string,
2350 "stderr", assign_log_destination, NULL
2353 {"log_directory", PGC_SIGHUP, LOGGING_WHERE,
2354 gettext_noop("Sets the destination directory for log files."),
2355 gettext_noop("Can be specified as relative to the data directory "
2356 "or as absolute path."),
2360 "pg_log", assign_canonical_path, NULL
2363 {"log_filename", PGC_SIGHUP, LOGGING_WHERE,
2364 gettext_noop("Sets the file name pattern for log files."),
2369 "postgresql-%Y-%m-%d_%H%M%S.log", NULL, NULL
2374 {"syslog_ident", PGC_SIGHUP, LOGGING_WHERE,
2375 gettext_noop("Sets the program name used to identify PostgreSQL "
2376 "messages in syslog."),
2380 "postgres", assign_syslog_ident, NULL
2385 {"TimeZone", PGC_USERSET, CLIENT_CONN_LOCALE,
2386 gettext_noop("Sets the time zone for displaying and interpreting time stamps."),
2391 "UNKNOWN", assign_timezone, show_timezone
2394 {"timezone_abbreviations", PGC_USERSET, CLIENT_CONN_LOCALE,
2395 gettext_noop("Selects a file of time zone abbreviations."),
2398 &timezone_abbreviations_string,
2399 "UNKNOWN", assign_timezone_abbreviations, NULL
2403 {"transaction_isolation", PGC_USERSET, CLIENT_CONN_STATEMENT,
2404 gettext_noop("Sets the current transaction's isolation level."),
2406 GUC_NO_RESET_ALL | GUC_NOT_IN_SAMPLE | GUC_DISALLOW_IN_FILE
2408 &XactIsoLevel_string,
2409 NULL, assign_XactIsoLevel, show_XactIsoLevel
2413 {"unix_socket_group", PGC_POSTMASTER, CONN_AUTH_SETTINGS,
2414 gettext_noop("Sets the owning group of the Unix-domain socket."),
2415 gettext_noop("The owning user of the socket is always the user "
2416 "that starts the server.")
2423 {"unix_socket_directory", PGC_POSTMASTER, CONN_AUTH_SETTINGS,
2424 gettext_noop("Sets the directory where the Unix-domain socket will be created."),
2429 "", assign_canonical_path, NULL
2433 {"listen_addresses", PGC_POSTMASTER, CONN_AUTH_SETTINGS,
2434 gettext_noop("Sets the host name or IP address(es) to listen to."),
2439 "localhost", NULL, NULL
2443 {"custom_variable_classes", PGC_SIGHUP, CUSTOM_OPTIONS,
2444 gettext_noop("Sets the list of known custom variable classes."),
2446 GUC_LIST_INPUT | GUC_LIST_QUOTE
2448 &custom_variable_classes,
2449 NULL, assign_custom_variable_classes, NULL
2453 {"data_directory", PGC_POSTMASTER, FILE_LOCATIONS,
2454 gettext_noop("Sets the server's data directory."),
2463 {"config_file", PGC_POSTMASTER, FILE_LOCATIONS,
2464 gettext_noop("Sets the server's main configuration file."),
2466 GUC_DISALLOW_IN_FILE | GUC_SUPERUSER_ONLY
2473 {"hba_file", PGC_POSTMASTER, FILE_LOCATIONS,
2474 gettext_noop("Sets the server's \"hba\" configuration file."),
2483 {"ident_file", PGC_POSTMASTER, FILE_LOCATIONS,
2484 gettext_noop("Sets the server's \"ident\" configuration file."),
2493 {"external_pid_file", PGC_POSTMASTER, FILE_LOCATIONS,
2494 gettext_noop("Writes the postmaster PID to the specified file."),
2499 NULL, assign_canonical_path, NULL
2503 {"stats_temp_directory", PGC_SIGHUP, STATS_COLLECTOR,
2504 gettext_noop("Writes temporary statistics files to the specified directory."),
2508 &pgstat_temp_directory,
2509 "pg_stat_tmp", assign_pgstat_temp_directory, NULL
2513 {"default_text_search_config", PGC_USERSET, CLIENT_CONN_LOCALE,
2514 gettext_noop("Sets default text search configuration."),
2518 "pg_catalog.simple", assignTSCurrentConfig, NULL
2523 {"ssl_ciphers", PGC_POSTMASTER, CONN_AUTH_SECURITY,
2524 gettext_noop("Sets the list of allowed SSL ciphers."),
2529 "ALL:!ADH:!LOW:!EXP:!MD5:@STRENGTH", NULL, NULL
2531 #endif /* USE_SSL */
2533 /* End-of-list marker */
2535 {NULL, 0, 0, NULL, NULL}, NULL, NULL, NULL, NULL
2540 static struct config_enum ConfigureNamesEnum[] =
2543 {"backslash_quote", PGC_USERSET, COMPAT_OPTIONS_PREVIOUS,
2544 gettext_noop("Sets whether \"\\'\" is allowed in string literals."),
2548 BACKSLASH_QUOTE_SAFE_ENCODING, backslash_quote_options, NULL, NULL
2552 {"bytea_output", PGC_USERSET, CLIENT_CONN_STATEMENT,
2553 gettext_noop("Sets the output format for bytea."),
2557 BYTEA_OUTPUT_HEX, bytea_output_options, NULL, NULL
2561 {"client_min_messages", PGC_USERSET, LOGGING_WHEN,
2562 gettext_noop("Sets the message levels that are sent to the client."),
2563 gettext_noop("Each level includes all the levels that follow it. The later"
2564 " the level, the fewer messages are sent.")
2566 &client_min_messages,
2567 NOTICE, client_message_level_options, NULL, NULL
2571 {"constraint_exclusion", PGC_USERSET, QUERY_TUNING_OTHER,
2572 gettext_noop("Enables the planner to use constraints to optimize queries."),
2573 gettext_noop("Table scans will be skipped if their constraints"
2574 " guarantee that no rows match the query.")
2576 &constraint_exclusion,
2577 CONSTRAINT_EXCLUSION_PARTITION, constraint_exclusion_options,
2582 {"default_transaction_isolation", PGC_USERSET, CLIENT_CONN_STATEMENT,
2583 gettext_noop("Sets the transaction isolation level of each new transaction."),
2586 &DefaultXactIsoLevel,
2587 XACT_READ_COMMITTED, isolation_level_options, NULL, NULL
2591 {"IntervalStyle", PGC_USERSET, CLIENT_CONN_LOCALE,
2592 gettext_noop("Sets the display format for interval values."),
2597 INTSTYLE_POSTGRES, intervalstyle_options, NULL, NULL
2601 {"log_error_verbosity", PGC_SUSET, LOGGING_WHEN,
2602 gettext_noop("Sets the verbosity of logged messages."),
2605 &Log_error_verbosity,
2606 PGERROR_DEFAULT, log_error_verbosity_options, NULL, NULL
2610 {"log_min_messages", PGC_SUSET, LOGGING_WHEN,
2611 gettext_noop("Sets the message levels that are logged."),
2612 gettext_noop("Each level includes all the levels that follow it. The later"
2613 " the level, the fewer messages are sent.")
2616 WARNING, server_message_level_options, NULL, NULL
2620 {"log_min_error_statement", PGC_SUSET, LOGGING_WHEN,
2621 gettext_noop("Causes all statements generating error at or above this level to be logged."),
2622 gettext_noop("Each level includes all the levels that follow it. The later"
2623 " the level, the fewer messages are sent.")
2625 &log_min_error_statement,
2626 ERROR, server_message_level_options, NULL, NULL
2630 {"log_statement", PGC_SUSET, LOGGING_WHAT,
2631 gettext_noop("Sets the type of statements logged."),
2635 LOGSTMT_NONE, log_statement_options, NULL, NULL
2640 {"syslog_facility", PGC_SIGHUP, LOGGING_WHERE,
2641 gettext_noop("Sets the syslog \"facility\" to be used when syslog enabled."),
2645 LOG_LOCAL0, syslog_facility_options, assign_syslog_facility, NULL
2650 {"regex_flavor", PGC_USERSET, COMPAT_OPTIONS_PREVIOUS,
2651 gettext_noop("Sets the regular expression \"flavor\"."),
2655 REG_ADVANCED, regex_flavor_options, NULL, NULL
2659 {"session_replication_role", PGC_SUSET, CLIENT_CONN_STATEMENT,
2660 gettext_noop("Sets the session's behavior for triggers and rewrite rules."),
2663 &SessionReplicationRole,
2664 SESSION_REPLICATION_ROLE_ORIGIN, session_replication_role_options,
2665 assign_session_replication_role, NULL
2669 {"track_functions", PGC_SUSET, STATS_COLLECTOR,
2670 gettext_noop("Collects function-level statistics on database activity."),
2673 &pgstat_track_functions,
2674 TRACK_FUNC_OFF, track_function_options, NULL, NULL
2678 {"wal_sync_method", PGC_SIGHUP, WAL_SETTINGS,
2679 gettext_noop("Selects the method used for forcing WAL updates to disk."),
2683 DEFAULT_SYNC_METHOD, sync_method_options,
2684 assign_xlog_sync_method, NULL
2688 {"xmlbinary", PGC_USERSET, CLIENT_CONN_STATEMENT,
2689 gettext_noop("Sets how binary values are to be encoded in XML."),
2693 XMLBINARY_BASE64, xmlbinary_options, NULL, NULL
2697 {"xmloption", PGC_USERSET, CLIENT_CONN_STATEMENT,
2698 gettext_noop("Sets whether XML data in implicit parsing and serialization "
2699 "operations is to be considered as documents or content fragments."),
2703 XMLOPTION_CONTENT, xmloption_options, NULL, NULL
2707 /* End-of-list marker */
2709 {NULL, 0, 0, NULL, NULL}, NULL, 0, NULL, NULL, NULL
2713 /******** end of options list ********/
2717 * To allow continued support of obsolete names for GUC variables, we apply
2718 * the following mappings to any unrecognized name. Note that an old name
2719 * should be mapped to a new one only if the new variable has very similar
2720 * semantics to the old.
2722 static const char *const map_old_guc_names[] = {
2723 "sort_mem", "work_mem",
2724 "vacuum_mem", "maintenance_work_mem",
2730 * Actual lookup of variables is done through this single, sorted array.
2732 static struct config_generic **guc_variables;
2734 /* Current number of variables contained in the vector */
2735 static int num_guc_variables;
2737 /* Vector capacity */
2738 static int size_guc_variables;
2741 static bool guc_dirty; /* TRUE if need to do commit/abort work */
2743 static bool reporting_enabled; /* TRUE to enable GUC_REPORT */
2745 static int GUCNestLevel = 0; /* 1 when in main transaction */
2748 static int guc_var_compare(const void *a, const void *b);
2749 static int guc_name_compare(const char *namea, const char *nameb);
2750 static void InitializeOneGUCOption(struct config_generic * gconf);
2751 static void push_old_value(struct config_generic * gconf, GucAction action);
2752 static void ReportGUCOption(struct config_generic * record);
2753 static void ShowGUCConfigOption(const char *name, DestReceiver *dest);
2754 static void ShowAllGUCConfig(DestReceiver *dest);
2755 static char *_ShowOption(struct config_generic * record, bool use_units);
2756 static bool is_newvalue_equal(struct config_generic * record, const char *newvalue);
2760 * Some infrastructure for checking malloc/strdup/realloc calls
2763 guc_malloc(int elevel, size_t size)
2767 data = malloc(size);
2770 (errcode(ERRCODE_OUT_OF_MEMORY),
2771 errmsg("out of memory")));
2776 guc_realloc(int elevel, void *old, size_t size)
2780 data = realloc(old, size);
2783 (errcode(ERRCODE_OUT_OF_MEMORY),
2784 errmsg("out of memory")));
2789 guc_strdup(int elevel, const char *src)
2796 (errcode(ERRCODE_OUT_OF_MEMORY),
2797 errmsg("out of memory")));
2803 * Support for assigning to a field of a string GUC item. Free the prior
2804 * value if it's not referenced anywhere else in the item (including stacked
2808 set_string_field(struct config_string * conf, char **field, char *newval)
2810 char *oldval = *field;
2813 /* Do the assignment */
2816 /* Exit if any duplicate references, or if old value was NULL anyway */
2817 if (oldval == NULL ||
2818 oldval == *(conf->variable) ||
2819 oldval == conf->reset_val ||
2820 oldval == conf->boot_val)
2822 for (stack = conf->gen.stack; stack; stack = stack->prev)
2824 if (oldval == stack->prior.stringval ||
2825 oldval == stack->masked.stringval)
2829 /* Not used anymore, so free it */
2834 * Detect whether strval is referenced anywhere in a GUC string item
2837 string_field_used(struct config_string * conf, char *strval)
2841 if (strval == *(conf->variable) ||
2842 strval == conf->reset_val ||
2843 strval == conf->boot_val)
2845 for (stack = conf->gen.stack; stack; stack = stack->prev)
2847 if (strval == stack->prior.stringval ||
2848 strval == stack->masked.stringval)
2855 * Support for copying a variable's active value into a stack entry
2858 set_stack_value(struct config_generic * gconf, union config_var_value * val)
2860 switch (gconf->vartype)
2864 *((struct config_bool *) gconf)->variable;
2868 *((struct config_int *) gconf)->variable;
2872 *((struct config_real *) gconf)->variable;
2875 /* we assume stringval is NULL if not valid */
2876 set_string_field((struct config_string *) gconf,
2878 *((struct config_string *) gconf)->variable);
2882 *((struct config_enum *) gconf)->variable;
2888 * Support for discarding a no-longer-needed value in a stack entry
2891 discard_stack_value(struct config_generic * gconf, union config_var_value * val)
2893 switch (gconf->vartype)
2899 /* no need to do anything */
2902 set_string_field((struct config_string *) gconf,
2911 * Fetch the sorted array pointer (exported for help_config.c's use ONLY)
2913 struct config_generic **
2914 get_guc_variables(void)
2916 return guc_variables;
2921 * Build the sorted array. This is split out so that it could be
2922 * re-executed after startup (eg, we could allow loadable modules to
2923 * add vars, and then we'd need to re-sort).
2926 build_guc_variables(void)
2930 struct config_generic **guc_vars;
2933 for (i = 0; ConfigureNamesBool[i].gen.name; i++)
2935 struct config_bool *conf = &ConfigureNamesBool[i];
2937 /* Rather than requiring vartype to be filled in by hand, do this: */
2938 conf->gen.vartype = PGC_BOOL;
2942 for (i = 0; ConfigureNamesInt[i].gen.name; i++)
2944 struct config_int *conf = &ConfigureNamesInt[i];
2946 conf->gen.vartype = PGC_INT;
2950 for (i = 0; ConfigureNamesReal[i].gen.name; i++)
2952 struct config_real *conf = &ConfigureNamesReal[i];
2954 conf->gen.vartype = PGC_REAL;
2958 for (i = 0; ConfigureNamesString[i].gen.name; i++)
2960 struct config_string *conf = &ConfigureNamesString[i];
2962 conf->gen.vartype = PGC_STRING;
2966 for (i = 0; ConfigureNamesEnum[i].gen.name; i++)
2968 struct config_enum *conf = &ConfigureNamesEnum[i];
2970 conf->gen.vartype = PGC_ENUM;
2975 * Create table with 20% slack
2977 size_vars = num_vars + num_vars / 4;
2979 guc_vars = (struct config_generic **)
2980 guc_malloc(FATAL, size_vars * sizeof(struct config_generic *));
2984 for (i = 0; ConfigureNamesBool[i].gen.name; i++)
2985 guc_vars[num_vars++] = &ConfigureNamesBool[i].gen;
2987 for (i = 0; ConfigureNamesInt[i].gen.name; i++)
2988 guc_vars[num_vars++] = &ConfigureNamesInt[i].gen;
2990 for (i = 0; ConfigureNamesReal[i].gen.name; i++)
2991 guc_vars[num_vars++] = &ConfigureNamesReal[i].gen;
2993 for (i = 0; ConfigureNamesString[i].gen.name; i++)
2994 guc_vars[num_vars++] = &ConfigureNamesString[i].gen;
2996 for (i = 0; ConfigureNamesEnum[i].gen.name; i++)
2997 guc_vars[num_vars++] = &ConfigureNamesEnum[i].gen;
3000 free(guc_variables);
3001 guc_variables = guc_vars;
3002 num_guc_variables = num_vars;
3003 size_guc_variables = size_vars;
3004 qsort((void *) guc_variables, num_guc_variables,
3005 sizeof(struct config_generic *), guc_var_compare);
3009 * Add a new GUC variable to the list of known variables. The
3010 * list is expanded if needed.
3013 add_guc_variable(struct config_generic * var, int elevel)
3015 if (num_guc_variables + 1 >= size_guc_variables)
3018 * Increase the vector by 25%
3020 int size_vars = size_guc_variables + size_guc_variables / 4;
3021 struct config_generic **guc_vars;
3026 guc_vars = (struct config_generic **)
3027 guc_malloc(elevel, size_vars * sizeof(struct config_generic *));
3031 guc_vars = (struct config_generic **)
3032 guc_realloc(elevel, guc_variables, size_vars * sizeof(struct config_generic *));
3035 if (guc_vars == NULL)
3036 return false; /* out of memory */
3038 guc_variables = guc_vars;
3039 size_guc_variables = size_vars;
3041 guc_variables[num_guc_variables++] = var;
3042 qsort((void *) guc_variables, num_guc_variables,
3043 sizeof(struct config_generic *), guc_var_compare);
3048 * Create and add a placeholder variable. It's presumed to belong
3049 * to a valid custom variable class at this point.
3051 static struct config_generic *
3052 add_placeholder_variable(const char *name, int elevel)
3054 size_t sz = sizeof(struct config_string) + sizeof(char *);
3055 struct config_string *var;
3056 struct config_generic *gen;
3058 var = (struct config_string *) guc_malloc(elevel, sz);
3064 gen->name = guc_strdup(elevel, name);
3065 if (gen->name == NULL)
3071 gen->context = PGC_USERSET;
3072 gen->group = CUSTOM_OPTIONS;
3073 gen->short_desc = "GUC placeholder variable";
3074 gen->flags = GUC_NO_SHOW_ALL | GUC_NOT_IN_SAMPLE | GUC_CUSTOM_PLACEHOLDER;
3075 gen->vartype = PGC_STRING;
3078 * The char* is allocated at the end of the struct since we have no
3079 * 'static' place to point to. Note that the current value, as well as
3080 * the boot and reset values, start out NULL.
3082 var->variable = (char **) (var + 1);
3084 if (!add_guc_variable((struct config_generic *) var, elevel))
3086 free((void *) gen->name);
3095 * Detect whether the portion of "name" before dotPos matches any custom
3096 * variable class name listed in custom_var_classes. The latter must be
3097 * formatted the way that assign_custom_variable_classes does it, ie,
3098 * no whitespace. NULL is valid for custom_var_classes.
3101 is_custom_class(const char *name, int dotPos, const char *custom_var_classes)
3103 bool result = false;
3104 const char *ccs = custom_var_classes;
3108 const char *start = ccs;
3114 if (c == '\0' || c == ',')
3116 if (dotPos == ccs - start && strncmp(start, name, dotPos) == 0)
3131 * Look up option NAME. If it exists, return a pointer to its record,
3132 * else return NULL. If create_placeholders is TRUE, we'll create a
3133 * placeholder record for a valid-looking custom variable name.
3135 static struct config_generic *
3136 find_option(const char *name, bool create_placeholders, int elevel)
3138 const char **key = &name;
3139 struct config_generic **res;
3145 * By equating const char ** with struct config_generic *, we are assuming
3146 * the name field is first in config_generic.
3148 res = (struct config_generic **) bsearch((void *) &key,
3149 (void *) guc_variables,
3151 sizeof(struct config_generic *),
3157 * See if the name is an obsolete name for a variable. We assume that the
3158 * set of supported old names is short enough that a brute-force search is
3161 for (i = 0; map_old_guc_names[i] != NULL; i += 2)
3163 if (guc_name_compare(name, map_old_guc_names[i]) == 0)
3164 return find_option(map_old_guc_names[i + 1], false, elevel);
3167 if (create_placeholders)
3170 * Check if the name is qualified, and if so, check if the qualifier
3171 * matches any custom variable class. If so, add a placeholder.
3173 const char *dot = strchr(name, GUC_QUALIFIER_SEPARATOR);
3176 is_custom_class(name, dot - name, custom_variable_classes))
3177 return add_placeholder_variable(name, elevel);
3186 * comparator for qsorting and bsearching guc_variables array
3189 guc_var_compare(const void *a, const void *b)
3191 struct config_generic *confa = *(struct config_generic **) a;
3192 struct config_generic *confb = *(struct config_generic **) b;
3194 return guc_name_compare(confa->name, confb->name);
3198 * the bare comparison function for GUC names
3201 guc_name_compare(const char *namea, const char *nameb)
3204 * The temptation to use strcasecmp() here must be resisted, because the
3205 * array ordering has to remain stable across setlocale() calls. So, build
3206 * our own with a simple ASCII-only downcasing.
3208 while (*namea && *nameb)
3210 char cha = *namea++;
3211 char chb = *nameb++;
3213 if (cha >= 'A' && cha <= 'Z')
3215 if (chb >= 'A' && chb <= 'Z')
3221 return 1; /* a is longer */
3223 return -1; /* b is longer */
3229 * Initialize GUC options during program startup.
3231 * Note that we cannot read the config file yet, since we have not yet
3232 * processed command-line switches.
3235 InitializeGUCOptions(void)
3242 * Before log_line_prefix could possibly receive a nonempty setting, make
3243 * sure that timezone processing is minimally alive (see elog.c).
3245 pg_timezone_pre_initialize();
3248 * Build sorted array of all GUC variables.
3250 build_guc_variables();
3253 * Load all variables with their compiled-in defaults, and initialize
3254 * status fields as needed.
3256 for (i = 0; i < num_guc_variables; i++)
3258 InitializeOneGUCOption(guc_variables[i]);
3263 reporting_enabled = false;
3266 * Prevent any attempt to override the transaction modes from
3267 * non-interactive sources.
3269 SetConfigOption("transaction_isolation", "default",
3270 PGC_POSTMASTER, PGC_S_OVERRIDE);
3271 SetConfigOption("transaction_read_only", "no",
3272 PGC_POSTMASTER, PGC_S_OVERRIDE);
3275 * For historical reasons, some GUC parameters can receive defaults from
3276 * environment variables. Process those settings. NB: if you add or
3277 * remove anything here, see also ProcessConfigFile().
3280 env = getenv("PGPORT");
3282 SetConfigOption("port", env, PGC_POSTMASTER, PGC_S_ENV_VAR);
3284 env = getenv("PGDATESTYLE");
3286 SetConfigOption("datestyle", env, PGC_POSTMASTER, PGC_S_ENV_VAR);
3288 env = getenv("PGCLIENTENCODING");
3290 SetConfigOption("client_encoding", env, PGC_POSTMASTER, PGC_S_ENV_VAR);
3293 * rlimit isn't exactly an "environment variable", but it behaves about
3294 * the same. If we can identify the platform stack depth rlimit, increase
3295 * default stack depth setting up to whatever is safe (but at most 2MB).
3297 stack_rlimit = get_stack_depth_rlimit();
3298 if (stack_rlimit > 0)
3300 int new_limit = (stack_rlimit - STACK_DEPTH_SLOP) / 1024L;
3302 if (new_limit > 100)
3306 new_limit = Min(new_limit, 2048);
3307 sprintf(limbuf, "%d", new_limit);
3308 SetConfigOption("max_stack_depth", limbuf,
3309 PGC_POSTMASTER, PGC_S_ENV_VAR);
3315 * Initialize one GUC option variable to its compiled-in default.
3318 InitializeOneGUCOption(struct config_generic * gconf)
3321 gconf->reset_source = PGC_S_DEFAULT;
3322 gconf->source = PGC_S_DEFAULT;
3323 gconf->stack = NULL;
3324 gconf->sourcefile = NULL;
3325 gconf->sourceline = 0;
3327 switch (gconf->vartype)
3331 struct config_bool *conf = (struct config_bool *) gconf;
3333 if (conf->assign_hook)
3334 if (!(*conf->assign_hook) (conf->boot_val, true,
3336 elog(FATAL, "failed to initialize %s to %d",
3337 conf->gen.name, (int) conf->boot_val);
3338 *conf->variable = conf->reset_val = conf->boot_val;
3343 struct config_int *conf = (struct config_int *) gconf;
3345 Assert(conf->boot_val >= conf->min);
3346 Assert(conf->boot_val <= conf->max);
3347 if (conf->assign_hook)
3348 if (!(*conf->assign_hook) (conf->boot_val, true,
3350 elog(FATAL, "failed to initialize %s to %d",
3351 conf->gen.name, conf->boot_val);
3352 *conf->variable = conf->reset_val = conf->boot_val;
3357 struct config_real *conf = (struct config_real *) gconf;
3359 Assert(conf->boot_val >= conf->min);
3360 Assert(conf->boot_val <= conf->max);
3361 if (conf->assign_hook)
3362 if (!(*conf->assign_hook) (conf->boot_val, true,
3364 elog(FATAL, "failed to initialize %s to %g",
3365 conf->gen.name, conf->boot_val);
3366 *conf->variable = conf->reset_val = conf->boot_val;
3371 struct config_string *conf = (struct config_string *) gconf;
3374 *conf->variable = NULL;
3375 conf->reset_val = NULL;
3377 if (conf->boot_val == NULL)
3379 /* leave the value NULL, do not call assign hook */
3383 str = guc_strdup(FATAL, conf->boot_val);
3384 conf->reset_val = str;
3386 if (conf->assign_hook)
3390 newstr = (*conf->assign_hook) (str, true,
3394 elog(FATAL, "failed to initialize %s to \"%s\"",
3395 conf->gen.name, str);
3397 else if (newstr != str)
3402 * See notes in set_config_option about casting
3404 str = (char *) newstr;
3405 conf->reset_val = str;
3408 *conf->variable = str;
3413 struct config_enum *conf = (struct config_enum *) gconf;
3415 if (conf->assign_hook)
3416 if (!(*conf->assign_hook) (conf->boot_val, true,
3418 elog(FATAL, "failed to initialize %s to %s",
3420 config_enum_lookup_by_value(conf, conf->boot_val));
3421 *conf->variable = conf->reset_val = conf->boot_val;
3429 * Select the configuration files and data directory to be used, and
3430 * do the initial read of postgresql.conf.
3432 * This is called after processing command-line switches.
3433 * userDoption is the -D switch value if any (NULL if unspecified).
3434 * progname is just for use in error messages.
3436 * Returns true on success; on failure, prints a suitable error message
3437 * to stderr and returns false.
3440 SelectConfigFiles(const char *userDoption, const char *progname)
3444 struct stat stat_buf;
3446 /* configdir is -D option, or $PGDATA if no -D */
3448 configdir = make_absolute_path(userDoption);
3450 configdir = make_absolute_path(getenv("PGDATA"));
3453 * Find the configuration file: if config_file was specified on the
3454 * command line, use it, else use configdir/postgresql.conf. In any case
3455 * ensure the result is an absolute path, so that it will be interpreted
3456 * the same way by future backends.
3459 fname = make_absolute_path(ConfigFileName);
3462 fname = guc_malloc(FATAL,
3463 strlen(configdir) + strlen(CONFIG_FILENAME) + 2);
3464 sprintf(fname, "%s/%s", configdir, CONFIG_FILENAME);
3468 write_stderr("%s does not know where to find the server configuration file.\n"
3469 "You must specify the --config-file or -D invocation "
3470 "option or set the PGDATA environment variable.\n",
3476 * Set the ConfigFileName GUC variable to its final value, ensuring that
3477 * it can't be overridden later.
3479 SetConfigOption("config_file", fname, PGC_POSTMASTER, PGC_S_OVERRIDE);
3483 * Now read the config file for the first time.
3485 if (stat(ConfigFileName, &stat_buf) != 0)
3487 write_stderr("%s cannot access the server configuration file \"%s\": %s\n",
3488 progname, ConfigFileName, strerror(errno));
3492 ProcessConfigFile(PGC_POSTMASTER);
3495 * If the data_directory GUC variable has been set, use that as DataDir;
3496 * otherwise use configdir if set; else punt.
3498 * Note: SetDataDir will copy and absolute-ize its argument, so we don't
3502 SetDataDir(data_directory);
3504 SetDataDir(configdir);
3507 write_stderr("%s does not know where to find the database system data.\n"
3508 "This can be specified as \"data_directory\" in \"%s\", "
3509 "or by the -D invocation option, or by the "
3510 "PGDATA environment variable.\n",
3511 progname, ConfigFileName);
3516 * Reflect the final DataDir value back into the data_directory GUC var.
3517 * (If you are wondering why we don't just make them a single variable,
3518 * it's because the EXEC_BACKEND case needs DataDir to be transmitted to
3519 * child backends specially. XXX is that still true? Given that we now
3520 * chdir to DataDir, EXEC_BACKEND can read the config file without knowing
3521 * DataDir in advance.)
3523 SetConfigOption("data_directory", DataDir, PGC_POSTMASTER, PGC_S_OVERRIDE);
3526 * Figure out where pg_hba.conf is, and make sure the path is absolute.
3529 fname = make_absolute_path(HbaFileName);
3532 fname = guc_malloc(FATAL,
3533 strlen(configdir) + strlen(HBA_FILENAME) + 2);
3534 sprintf(fname, "%s/%s", configdir, HBA_FILENAME);
3538 write_stderr("%s does not know where to find the \"hba\" configuration file.\n"
3539 "This can be specified as \"hba_file\" in \"%s\", "
3540 "or by the -D invocation option, or by the "
3541 "PGDATA environment variable.\n",
3542 progname, ConfigFileName);
3545 SetConfigOption("hba_file", fname, PGC_POSTMASTER, PGC_S_OVERRIDE);
3549 * Likewise for pg_ident.conf.
3552 fname = make_absolute_path(IdentFileName);
3555 fname = guc_malloc(FATAL,
3556 strlen(configdir) + strlen(IDENT_FILENAME) + 2);
3557 sprintf(fname, "%s/%s", configdir, IDENT_FILENAME);
3561 write_stderr("%s does not know where to find the \"ident\" configuration file.\n"
3562 "This can be specified as \"ident_file\" in \"%s\", "
3563 "or by the -D invocation option, or by the "
3564 "PGDATA environment variable.\n",
3565 progname, ConfigFileName);
3568 SetConfigOption("ident_file", fname, PGC_POSTMASTER, PGC_S_OVERRIDE);
3578 * Reset all options to their saved default values (implements RESET ALL)
3581 ResetAllOptions(void)
3585 for (i = 0; i < num_guc_variables; i++)
3587 struct config_generic *gconf = guc_variables[i];
3589 /* Don't reset non-SET-able values */
3590 if (gconf->context != PGC_SUSET &&
3591 gconf->context != PGC_USERSET)
3593 /* Don't reset if special exclusion from RESET ALL */
3594 if (gconf->flags & GUC_NO_RESET_ALL)
3596 /* No need to reset if wasn't SET */
3597 if (gconf->source <= PGC_S_OVERRIDE)
3600 /* Save old value to support transaction abort */
3601 push_old_value(gconf, GUC_ACTION_SET);
3603 switch (gconf->vartype)
3607 struct config_bool *conf = (struct config_bool *) gconf;
3609 if (conf->assign_hook)
3610 if (!(*conf->assign_hook) (conf->reset_val, true,
3612 elog(ERROR, "failed to reset %s to %d",
3613 conf->gen.name, (int) conf->reset_val);
3614 *conf->variable = conf->reset_val;
3619 struct config_int *conf = (struct config_int *) gconf;
3621 if (conf->assign_hook)
3622 if (!(*conf->assign_hook) (conf->reset_val, true,
3624 elog(ERROR, "failed to reset %s to %d",
3625 conf->gen.name, conf->reset_val);
3626 *conf->variable = conf->reset_val;
3631 struct config_real *conf = (struct config_real *) gconf;
3633 if (conf->assign_hook)
3634 if (!(*conf->assign_hook) (conf->reset_val, true,
3636 elog(ERROR, "failed to reset %s to %g",
3637 conf->gen.name, conf->reset_val);
3638 *conf->variable = conf->reset_val;
3643 struct config_string *conf = (struct config_string *) gconf;
3646 /* We need not strdup here */
3647 str = conf->reset_val;
3649 if (conf->assign_hook && str)
3653 newstr = (*conf->assign_hook) (str, true,
3656 elog(ERROR, "failed to reset %s to \"%s\"",
3657 conf->gen.name, str);
3658 else if (newstr != str)
3661 * See notes in set_config_option about casting
3663 str = (char *) newstr;
3667 set_string_field(conf, conf->variable, str);
3672 struct config_enum *conf = (struct config_enum *) gconf;
3674 if (conf->assign_hook)
3675 if (!(*conf->assign_hook) (conf->reset_val, true,
3677 elog(ERROR, "failed to reset %s to %s",
3679 config_enum_lookup_by_value(conf, conf->reset_val));
3680 *conf->variable = conf->reset_val;
3685 gconf->source = gconf->reset_source;
3687 if (gconf->flags & GUC_REPORT)
3688 ReportGUCOption(gconf);
3695 * Push previous state during transactional assignment to a GUC variable.
3698 push_old_value(struct config_generic * gconf, GucAction action)
3702 /* If we're not inside a nest level, do nothing */
3703 if (GUCNestLevel == 0)
3706 /* Do we already have a stack entry of the current nest level? */
3707 stack = gconf->stack;
3708 if (stack && stack->nest_level >= GUCNestLevel)
3710 /* Yes, so adjust its state if necessary */
3711 Assert(stack->nest_level == GUCNestLevel);
3714 case GUC_ACTION_SET:
3715 /* SET overrides any prior action at same nest level */
3716 if (stack->state == GUC_SET_LOCAL)
3718 /* must discard old masked value */
3719 discard_stack_value(gconf, &stack->masked);
3721 stack->state = GUC_SET;
3723 case GUC_ACTION_LOCAL:
3724 if (stack->state == GUC_SET)
3726 /* SET followed by SET LOCAL, remember SET's value */
3727 set_stack_value(gconf, &stack->masked);
3728 stack->state = GUC_SET_LOCAL;
3730 /* in all other cases, no change to stack entry */
3732 case GUC_ACTION_SAVE:
3733 /* Could only have a prior SAVE of same variable */
3734 Assert(stack->state == GUC_SAVE);
3737 Assert(guc_dirty); /* must be set already */
3742 * Push a new stack entry
3744 * We keep all the stack entries in TopTransactionContext for simplicity.
3746 stack = (GucStack *) MemoryContextAllocZero(TopTransactionContext,
3749 stack->prev = gconf->stack;
3750 stack->nest_level = GUCNestLevel;
3753 case GUC_ACTION_SET:
3754 stack->state = GUC_SET;
3756 case GUC_ACTION_LOCAL:
3757 stack->state = GUC_LOCAL;
3759 case GUC_ACTION_SAVE:
3760 stack->state = GUC_SAVE;
3763 stack->source = gconf->source;
3764 set_stack_value(gconf, &stack->prior);
3766 gconf->stack = stack;
3768 /* Ensure we remember to pop at end of xact */
3774 * Do GUC processing at main transaction start.
3780 * The nest level should be 0 between transactions; if it isn't, somebody
3781 * didn't call AtEOXact_GUC, or called it with the wrong nestLevel. We
3782 * throw a warning but make no other effort to clean up.
3784 if (GUCNestLevel != 0)
3785 elog(WARNING, "GUC nest level = %d at transaction start",
3791 * Enter a new nesting level for GUC values. This is called at subtransaction
3792 * start and when entering a function that has proconfig settings. NOTE that
3793 * we must not risk error here, else subtransaction start will be unhappy.
3796 NewGUCNestLevel(void)
3798 return ++GUCNestLevel;
3802 * Do GUC processing at transaction or subtransaction commit or abort, or
3803 * when exiting a function that has proconfig settings. (The name is thus
3804 * a bit of a misnomer; perhaps it should be ExitGUCNestLevel or some such.)
3805 * During abort, we discard all GUC settings that were applied at nesting
3806 * levels >= nestLevel. nestLevel == 1 corresponds to the main transaction.
3809 AtEOXact_GUC(bool isCommit, int nestLevel)
3814 Assert(nestLevel > 0 && nestLevel <= GUCNestLevel);
3816 /* Quick exit if nothing's changed in this transaction */
3819 GUCNestLevel = nestLevel - 1;
3823 still_dirty = false;
3824 for (i = 0; i < num_guc_variables; i++)
3826 struct config_generic *gconf = guc_variables[i];
3830 * Process and pop each stack entry within the nest level. To
3831 * simplify fmgr_security_definer(), we allow failure exit from a
3832 * function-with-SET-options to be recovered at the surrounding
3833 * transaction or subtransaction abort; so there could be more than
3834 * one stack entry to pop.
3836 while ((stack = gconf->stack) != NULL &&
3837 stack->nest_level >= nestLevel)
3839 GucStack *prev = stack->prev;
3840 bool restorePrior = false;
3841 bool restoreMasked = false;
3845 * In this next bit, if we don't set either restorePrior or
3846 * restoreMasked, we must "discard" any unwanted fields of the
3847 * stack entries to avoid leaking memory. If we do set one of
3848 * those flags, unused fields will be cleaned up after restoring.
3850 if (!isCommit) /* if abort, always restore prior value */
3851 restorePrior = true;
3852 else if (stack->state == GUC_SAVE)
3853 restorePrior = true;
3854 else if (stack->nest_level == 1)
3856 /* transaction commit */
3857 if (stack->state == GUC_SET_LOCAL)
3858 restoreMasked = true;
3859 else if (stack->state == GUC_SET)
3861 /* we keep the current active value */
3862 discard_stack_value(gconf, &stack->prior);
3864 else /* must be GUC_LOCAL */
3865 restorePrior = true;
3867 else if (prev == NULL ||
3868 prev->nest_level < stack->nest_level - 1)
3870 /* decrement entry's level and do not pop it */
3871 stack->nest_level--;
3877 * We have to merge this stack entry into prev. See README for
3878 * discussion of this bit.
3880 switch (stack->state)
3883 Assert(false); /* can't get here */
3886 /* next level always becomes SET */
3887 discard_stack_value(gconf, &stack->prior);
3888 if (prev->state == GUC_SET_LOCAL)
3889 discard_stack_value(gconf, &prev->masked);
3890 prev->state = GUC_SET;
3894 if (prev->state == GUC_SET)
3896 /* LOCAL migrates down */
3897 prev->masked = stack->prior;
3898 prev->state = GUC_SET_LOCAL;
3902 /* else just forget this stack level */
3903 discard_stack_value(gconf, &stack->prior);
3908 /* prior state at this level no longer wanted */
3909 discard_stack_value(gconf, &stack->prior);
3910 /* copy down the masked state */
3911 if (prev->state == GUC_SET_LOCAL)
3912 discard_stack_value(gconf, &prev->masked);
3913 prev->masked = stack->masked;
3914 prev->state = GUC_SET_LOCAL;
3921 if (restorePrior || restoreMasked)
3923 /* Perform appropriate restoration of the stacked value */
3924 union config_var_value newvalue;
3925 GucSource newsource;
3929 newvalue = stack->masked;
3930 newsource = PGC_S_SESSION;
3934 newvalue = stack->prior;
3935 newsource = stack->source;
3938 switch (gconf->vartype)
3942 struct config_bool *conf = (struct config_bool *) gconf;
3943 bool newval = newvalue.boolval;
3945 if (*conf->variable != newval)
3947 if (conf->assign_hook)
3948 if (!(*conf->assign_hook) (newval,
3949 true, PGC_S_OVERRIDE))
3950 elog(LOG, "failed to commit %s as %d",
3951 conf->gen.name, (int) newval);
3952 *conf->variable = newval;
3959 struct config_int *conf = (struct config_int *) gconf;
3960 int newval = newvalue.intval;
3962 if (*conf->variable != newval)
3964 if (conf->assign_hook)
3965 if (!(*conf->assign_hook) (newval,
3966 true, PGC_S_OVERRIDE))
3967 elog(LOG, "failed to commit %s as %d",
3968 conf->gen.name, newval);
3969 *conf->variable = newval;
3976 struct config_real *conf = (struct config_real *) gconf;
3977 double newval = newvalue.realval;
3979 if (*conf->variable != newval)
3981 if (conf->assign_hook)
3982 if (!(*conf->assign_hook) (newval,
3983 true, PGC_S_OVERRIDE))
3984 elog(LOG, "failed to commit %s as %g",
3985 conf->gen.name, newval);
3986 *conf->variable = newval;
3993 struct config_string *conf = (struct config_string *) gconf;
3994 char *newval = newvalue.stringval;
3996 if (*conf->variable != newval)
3998 if (conf->assign_hook && newval)
4002 newstr = (*conf->assign_hook) (newval, true,
4005 elog(LOG, "failed to commit %s as \"%s\"",
4006 conf->gen.name, newval);
4007 else if (newstr != newval)
4010 * If newval should now be freed,
4011 * it'll be taken care of below.
4013 * See notes in set_config_option
4016 newval = (char *) newstr;
4020 set_string_field(conf, conf->variable, newval);
4025 * Release stacked values if not used anymore. We
4026 * could use discard_stack_value() here, but since
4027 * we have type-specific code anyway, might as
4030 set_string_field(conf, &stack->prior.stringval, NULL);
4031 set_string_field(conf, &stack->masked.stringval, NULL);
4036 struct config_enum *conf = (struct config_enum *) gconf;
4037 int newval = newvalue.enumval;
4039 if (*conf->variable != newval)
4041 if (conf->assign_hook)
4042 if (!(*conf->assign_hook) (newval,
4043 true, PGC_S_OVERRIDE))
4044 elog(LOG, "failed to commit %s as %s",
4046 config_enum_lookup_by_value(conf, newval));
4047 *conf->variable = newval;
4054 gconf->source = newsource;
4057 /* Finish popping the state stack */
4058 gconf->stack = prev;
4061 /* Report new value if we changed it */
4062 if (changed && (gconf->flags & GUC_REPORT))
4063 ReportGUCOption(gconf);
4064 } /* end of stack-popping loop */
4070 /* If there are no remaining stack entries, we can reset guc_dirty */
4071 guc_dirty = still_dirty;
4073 /* Update nesting level */
4074 GUCNestLevel = nestLevel - 1;
4079 * Start up automatic reporting of changes to variables marked GUC_REPORT.
4080 * This is executed at completion of backend startup.
4083 BeginReportingGUCOptions(void)
4088 * Don't do anything unless talking to an interactive frontend of protocol
4091 if (whereToSendOutput != DestRemote ||
4092 PG_PROTOCOL_MAJOR(FrontendProtocol) < 3)
4095 reporting_enabled = true;
4097 /* Transmit initial values of interesting variables */
4098 for (i = 0; i < num_guc_variables; i++)
4100 struct config_generic *conf = guc_variables[i];
4102 if (conf->flags & GUC_REPORT)
4103 ReportGUCOption(conf);
4108 * ReportGUCOption: if appropriate, transmit option value to frontend
4111 ReportGUCOption(struct config_generic * record)
4113 if (reporting_enabled && (record->flags & GUC_REPORT))
4115 char *val = _ShowOption(record, false);
4116 StringInfoData msgbuf;
4118 pq_beginmessage(&msgbuf, 'S');
4119 pq_sendstring(&msgbuf, record->name);
4120 pq_sendstring(&msgbuf, val);
4121 pq_endmessage(&msgbuf);
4128 * Try to parse value as an integer. The accepted formats are the
4129 * usual decimal, octal, or hexadecimal formats, optionally followed by
4130 * a unit name if "flags" indicates a unit is allowed.
4132 * If the string parses okay, return true, else false.
4133 * If okay and result is not NULL, return the value in *result.
4134 * If not okay and hintmsg is not NULL, *hintmsg is set to a suitable
4135 * HINT message, or NULL if no hint provided.
4138 parse_int(const char *value, int *result, int flags, const char **hintmsg)
4143 /* To suppress compiler warnings, always set output params */
4149 /* We assume here that int64 is at least as wide as long */
4151 val = strtol(value, &endptr, 0);
4153 if (endptr == value)
4154 return false; /* no HINT for integer syntax error */
4156 if (errno == ERANGE || val != (int64) ((int32) val))
4159 *hintmsg = gettext_noop("Value exceeds integer range.");
4163 /* allow whitespace between integer and unit */
4164 while (isspace((unsigned char) *endptr))
4167 /* Handle possible unit */
4168 if (*endptr != '\0')
4171 * Note: the multiple-switch coding technique here is a bit tedious,
4172 * but seems necessary to avoid intermediate-value overflows.
4174 * If INT64_IS_BUSTED (ie, it's really int32) we will fail to detect
4175 * overflow due to units conversion, but there are few enough such
4176 * machines that it does not seem worth trying to be smarter.
4178 if (flags & GUC_UNIT_MEMORY)
4180 /* Set hint for use if no match or trailing garbage */
4182 *hintmsg = gettext_noop("Valid units for this parameter are \"kB\", \"MB\", and \"GB\".");
4184 #if BLCKSZ < 1024 || BLCKSZ > (1024*1024)
4185 #error BLCKSZ must be between 1KB and 1MB
4187 #if XLOG_BLCKSZ < 1024 || XLOG_BLCKSZ > (1024*1024)
4188 #error XLOG_BLCKSZ must be between 1KB and 1MB
4191 if (strncmp(endptr, "kB", 2) == 0)
4194 switch (flags & GUC_UNIT_MEMORY)
4196 case GUC_UNIT_BLOCKS:
4197 val /= (BLCKSZ / 1024);
4199 case GUC_UNIT_XBLOCKS:
4200 val /= (XLOG_BLCKSZ / 1024);
4204 else if (strncmp(endptr, "MB", 2) == 0)
4207 switch (flags & GUC_UNIT_MEMORY)
4212 case GUC_UNIT_BLOCKS:
4213 val *= KB_PER_MB / (BLCKSZ / 1024);
4215 case GUC_UNIT_XBLOCKS:
4216 val *= KB_PER_MB / (XLOG_BLCKSZ / 1024);
4220 else if (strncmp(endptr, "GB", 2) == 0)
4223 switch (flags & GUC_UNIT_MEMORY)
4228 case GUC_UNIT_BLOCKS:
4229 val *= KB_PER_GB / (BLCKSZ / 1024);
4231 case GUC_UNIT_XBLOCKS:
4232 val *= KB_PER_GB / (XLOG_BLCKSZ / 1024);
4237 else if (flags & GUC_UNIT_TIME)
4239 /* Set hint for use if no match or trailing garbage */
4241 *hintmsg = gettext_noop("Valid units for this parameter are \"ms\", \"s\", \"min\", \"h\", and \"d\".");
4243 if (strncmp(endptr, "ms", 2) == 0)
4246 switch (flags & GUC_UNIT_TIME)
4256 else if (strncmp(endptr, "s", 1) == 0)
4259 switch (flags & GUC_UNIT_TIME)
4269 else if (strncmp(endptr, "min", 3) == 0)
4272 switch (flags & GUC_UNIT_TIME)
4282 else if (strncmp(endptr, "h", 1) == 0)
4285 switch (flags & GUC_UNIT_TIME)
4298 else if (strncmp(endptr, "d", 1) == 0)
4301 switch (flags & GUC_UNIT_TIME)
4316 /* allow whitespace after unit */
4317 while (isspace((unsigned char) *endptr))
4320 if (*endptr != '\0')
4321 return false; /* appropriate hint, if any, already set */
4323 /* Check for overflow due to units conversion */
4324 if (val != (int64) ((int32) val))
4327 *hintmsg = gettext_noop("Value exceeds integer range.");
4333 *result = (int) val;
4340 * Try to parse value as a floating point number in the usual format.
4341 * If the string parses okay, return true, else false.
4342 * If okay and result is not NULL, return the value in *result.
4345 parse_real(const char *value, double *result)
4351 *result = 0; /* suppress compiler warning */
4354 val = strtod(value, &endptr);
4355 if (endptr == value || errno == ERANGE)
4358 /* allow whitespace after number */
4359 while (isspace((unsigned char) *endptr))
4361 if (*endptr != '\0')
4371 * Lookup the name for an enum option with the selected value.
4372 * Should only ever be called with known-valid values, so throws
4373 * an elog(ERROR) if the enum option is not found.
4375 * The returned string is a pointer to static data and not
4376 * allocated for modification.
4379 config_enum_lookup_by_value(struct config_enum * record, int val)
4381 const struct config_enum_entry *entry;
4383 for (entry = record->options; entry && entry->name; entry++)
4385 if (entry->val == val)
4389 elog(ERROR, "could not find enum option %d for %s",
4390 val, record->gen.name);
4391 return NULL; /* silence compiler */
4396 * Lookup the value for an enum option with the selected name
4397 * (case-insensitive).
4398 * If the enum option is found, sets the retval value and returns
4399 * true. If it's not found, return FALSE and retval is set to 0.
4402 config_enum_lookup_by_name(struct config_enum * record, const char *value,
4405 const struct config_enum_entry *entry;
4407 for (entry = record->options; entry && entry->name; entry++)
4409 if (pg_strcasecmp(value, entry->name) == 0)
4411 *retval = entry->val;
4422 * Return a list of all available options for an enum, excluding
4423 * hidden ones, separated by the given separator.
4424 * If prefix is non-NULL, it is added before the first enum value.
4425 * If suffix is non-NULL, it is added to the end of the string.
4428 config_enum_get_options(struct config_enum * record, const char *prefix,
4429 const char *suffix, const char *separator)
4431 const struct config_enum_entry *entry;
4432 StringInfoData retstr;
4435 initStringInfo(&retstr);
4436 appendStringInfoString(&retstr, prefix);
4438 seplen = strlen(separator);
4439 for (entry = record->options; entry && entry->name; entry++)
4443 appendStringInfoString(&retstr, entry->name);
4444 appendBinaryStringInfo(&retstr, separator, seplen);
4449 * All the entries may have been hidden, leaving the string empty if no
4450 * prefix was given. This indicates a broken GUC setup, since there is no
4451 * use for an enum without any values, so we just check to make sure we
4452 * don't write to invalid memory instead of actually trying to do
4453 * something smart with it.
4455 if (retstr.len >= seplen)
4457 /* Replace final separator */
4458 retstr.data[retstr.len - seplen] = '\0';
4459 retstr.len -= seplen;
4462 appendStringInfoString(&retstr, suffix);
4468 * Call a GucStringAssignHook function, being careful to free the
4469 * "newval" string if the hook ereports.
4471 * This is split out of set_config_option just to avoid the "volatile"
4472 * qualifiers that would otherwise have to be plastered all over.
4475 call_string_assign_hook(GucStringAssignHook assign_hook,
4476 char *newval, bool doit, GucSource source)
4482 result = (*assign_hook) (newval, doit, source);
4496 * Sets option `name' to given value. The value should be a string
4497 * which is going to be parsed and converted to the appropriate data
4498 * type. The context and source parameters indicate in which context this
4499 * function is being called so it can apply the access restrictions
4502 * If value is NULL, set the option to its default value (normally the
4503 * reset_val, but if source == PGC_S_DEFAULT we instead use the boot_val).
4505 * action indicates whether to set the value globally in the session, locally
4506 * to the current top transaction, or just for the duration of a function call.
4508 * If changeVal is false then don't really set the option but do all
4509 * the checks to see if it would work.
4511 * If there is an error (non-existing option, invalid value) then an
4512 * ereport(ERROR) is thrown *unless* this is called in a context where we
4513 * don't want to ereport (currently, startup or SIGHUP config file reread).
4514 * In that case we write a suitable error message via ereport(LOG) and
4515 * return false. This is working around the deficiencies in the ereport
4516 * mechanism, so don't blame me. In all other cases, the function
4517 * returns true, including cases where the input is valid but we chose
4518 * not to apply it because of context or source-priority considerations.
4520 * See also SetConfigOption for an external interface.
4523 set_config_option(const char *name, const char *value,
4524 GucContext context, GucSource source,
4525 GucAction action, bool changeVal)
4527 struct config_generic *record;
4531 if (context == PGC_SIGHUP || source == PGC_S_DEFAULT)
4534 * To avoid cluttering the log, only the postmaster bleats loudly
4535 * about problems with the config file.
4537 elevel = IsUnderPostmaster ? DEBUG3 : LOG;
4539 else if (source == PGC_S_DATABASE || source == PGC_S_USER)
4544 record = find_option(name, true, elevel);
4548 (errcode(ERRCODE_UNDEFINED_OBJECT),
4549 errmsg("unrecognized configuration parameter \"%s\"", name)));
4554 * If source is postgresql.conf, mark the found record with
4555 * GUC_IS_IN_FILE. This is for the convenience of ProcessConfigFile. Note
4556 * that we do it even if changeVal is false, since ProcessConfigFile wants
4557 * the marking to occur during its testing pass.
4559 if (source == PGC_S_FILE)
4560 record->status |= GUC_IS_IN_FILE;
4563 * Check if the option can be set at this time. See guc.h for the precise
4564 * rules. Note that we don't want to throw errors if we're in the SIGHUP
4565 * context. In that case we just ignore the attempt and return true.
4567 switch (record->context)
4570 if (context == PGC_SIGHUP)
4572 if (context != PGC_INTERNAL)
4575 (errcode(ERRCODE_CANT_CHANGE_RUNTIME_PARAM),
4576 errmsg("parameter \"%s\" cannot be changed",
4581 case PGC_POSTMASTER:
4582 if (context == PGC_SIGHUP)
4585 * We are reading a PGC_POSTMASTER var from postgresql.conf.
4586 * We can't change the setting, so give a warning if the DBA
4587 * tries to change it. (Throwing an error would be more
4588 * consistent, but seems overly rigid.)
4590 if (changeVal && !is_newvalue_equal(record, value))
4592 (errcode(ERRCODE_CANT_CHANGE_RUNTIME_PARAM),
4593 errmsg("attempted change of parameter \"%s\" ignored",
4595 errdetail("This parameter cannot be changed after server start.")));
4598 if (context != PGC_POSTMASTER)
4601 (errcode(ERRCODE_CANT_CHANGE_RUNTIME_PARAM),
4602 errmsg("attempted change of parameter \"%s\" ignored",
4604 errdetail("This parameter cannot be changed after server start.")));
4609 if (context != PGC_SIGHUP && context != PGC_POSTMASTER)
4612 (errcode(ERRCODE_CANT_CHANGE_RUNTIME_PARAM),
4613 errmsg("parameter \"%s\" cannot be changed now",
4619 * Hmm, the idea of the SIGHUP context is "ought to be global, but
4620 * can be changed after postmaster start". But there's nothing
4621 * that prevents a crafty administrator from sending SIGHUP
4622 * signals to individual backends only.
4626 if (context == PGC_SIGHUP)
4629 * If a PGC_BACKEND parameter is changed in the config file,
4630 * we want to accept the new value in the postmaster (whence
4631 * it will propagate to subsequently-started backends), but
4632 * ignore it in existing backends. This is a tad klugy, but
4633 * necessary because we don't re-read the config file during
4636 if (IsUnderPostmaster)
4639 else if (context != PGC_POSTMASTER && context != PGC_BACKEND &&
4640 source != PGC_S_CLIENT)
4643 (errcode(ERRCODE_CANT_CHANGE_RUNTIME_PARAM),
4644 errmsg("parameter \"%s\" cannot be set after connection start",
4650 if (context == PGC_USERSET || context == PGC_BACKEND)
4653 (errcode(ERRCODE_INSUFFICIENT_PRIVILEGE),
4654 errmsg("permission denied to set parameter \"%s\"",
4665 * Should we set reset/stacked values? (If so, the behavior is not
4666 * transactional.) This is done either when we get a default value from
4667 * the database's/user's/client's default settings or when we reset a
4668 * value to its default.
4670 makeDefault = changeVal && (source <= PGC_S_OVERRIDE) &&
4671 ((value != NULL) || source == PGC_S_DEFAULT);
4674 * Ignore attempted set if overridden by previously processed setting.
4675 * However, if changeVal is false then plow ahead anyway since we are
4676 * trying to find out if the value is potentially good, not actually use
4677 * it. Also keep going if makeDefault is true, since we may want to set
4678 * the reset/stacked values even if we can't set the variable itself.
4680 if (record->source > source)
4682 if (changeVal && !makeDefault)
4684 elog(DEBUG3, "\"%s\": setting ignored because previous source is higher priority",
4692 * Evaluate value and set variable.
4694 switch (record->vartype)
4698 struct config_bool *conf = (struct config_bool *) record;
4703 if (!parse_bool(value, &newval))
4706 (errcode(ERRCODE_INVALID_PARAMETER_VALUE),
4707 errmsg("parameter \"%s\" requires a Boolean value",
4712 else if (source == PGC_S_DEFAULT)
4713 newval = conf->boot_val;
4716 newval = conf->reset_val;
4717 source = conf->gen.reset_source;
4720 /* Save old value to support transaction abort */
4721 if (changeVal && !makeDefault)
4722 push_old_value(&conf->gen, action);
4724 if (conf->assign_hook)
4725 if (!(*conf->assign_hook) (newval, changeVal, source))
4728 (errcode(ERRCODE_INVALID_PARAMETER_VALUE),
4729 errmsg("invalid value for parameter \"%s\": %d",
4730 name, (int) newval)));
4736 *conf->variable = newval;
4737 conf->gen.source = source;
4743 if (conf->gen.reset_source <= source)
4745 conf->reset_val = newval;
4746 conf->gen.reset_source = source;
4748 for (stack = conf->gen.stack; stack; stack = stack->prev)
4750 if (stack->source <= source)
4752 stack->prior.boolval = newval;
4753 stack->source = source;
4762 struct config_int *conf = (struct config_int *) record;
4767 const char *hintmsg;
4769 if (!parse_int(value, &newval, conf->gen.flags, &hintmsg))
4772 (errcode(ERRCODE_INVALID_PARAMETER_VALUE),
4773 errmsg("invalid value for parameter \"%s\": \"%s\"",
4775 hintmsg ? errhint("%s", _(hintmsg)) : 0));
4778 if (newval < conf->min || newval > conf->max)
4781 (errcode(ERRCODE_INVALID_PARAMETER_VALUE),
4782 errmsg("%d is outside the valid range for parameter \"%s\" (%d .. %d)",
4783 newval, name, conf->min, conf->max)));
4787 else if (source == PGC_S_DEFAULT)
4788 newval = conf->boot_val;
4791 newval = conf->reset_val;
4792 source = conf->gen.reset_source;
4795 /* Save old value to support transaction abort */
4796 if (changeVal && !makeDefault)
4797 push_old_value(&conf->gen, action);
4799 if (conf->assign_hook)
4800 if (!(*conf->assign_hook) (newval, changeVal, source))
4803 (errcode(ERRCODE_INVALID_PARAMETER_VALUE),
4804 errmsg("invalid value for parameter \"%s\": %d",
4811 *conf->variable = newval;
4812 conf->gen.source = source;
4818 if (conf->gen.reset_source <= source)
4820 conf->reset_val = newval;
4821 conf->gen.reset_source = source;
4823 for (stack = conf->gen.stack; stack; stack = stack->prev)
4825 if (stack->source <= source)
4827 stack->prior.intval = newval;
4828 stack->source = source;
4837 struct config_real *conf = (struct config_real *) record;
4842 if (!parse_real(value, &newval))
4845 (errcode(ERRCODE_INVALID_PARAMETER_VALUE),
4846 errmsg("parameter \"%s\" requires a numeric value",
4850 if (newval < conf->min || newval > conf->max)
4853 (errcode(ERRCODE_INVALID_PARAMETER_VALUE),
4854 errmsg("%g is outside the valid range for parameter \"%s\" (%g .. %g)",
4855 newval, name, conf->min, conf->max)));
4859 else if (source == PGC_S_DEFAULT)
4860 newval = conf->boot_val;
4863 newval = conf->reset_val;
4864 source = conf->gen.reset_source;
4867 /* Save old value to support transaction abort */
4868 if (changeVal && !makeDefault)
4869 push_old_value(&conf->gen, action);
4871 if (conf->assign_hook)
4872 if (!(*conf->assign_hook) (newval, changeVal, source))
4875 (errcode(ERRCODE_INVALID_PARAMETER_VALUE),
4876 errmsg("invalid value for parameter \"%s\": %g",
4883 *conf->variable = newval;
4884 conf->gen.source = source;
4890 if (conf->gen.reset_source <= source)
4892 conf->reset_val = newval;
4893 conf->gen.reset_source = source;
4895 for (stack = conf->gen.stack; stack; stack = stack->prev)
4897 if (stack->source <= source)
4899 stack->prior.realval = newval;
4900 stack->source = source;
4909 struct config_string *conf = (struct config_string *) record;
4914 newval = guc_strdup(elevel, value);
4919 * The only sort of "parsing" check we need to do is apply
4920 * truncation if GUC_IS_NAME.
4922 if (conf->gen.flags & GUC_IS_NAME)
4923 truncate_identifier(newval, strlen(newval), true);
4925 else if (source == PGC_S_DEFAULT)
4927 if (conf->boot_val == NULL)
4931 newval = guc_strdup(elevel, conf->boot_val);
4939 * We could possibly avoid strdup here, but easier to make
4940 * this case work the same as the normal assignment case;
4941 * note the possible free of newval below.
4943 if (conf->reset_val == NULL)
4947 newval = guc_strdup(elevel, conf->reset_val);
4951 source = conf->gen.reset_source;
4954 /* Save old value to support transaction abort */
4955 if (changeVal && !makeDefault)
4956 push_old_value(&conf->gen, action);
4958 if (conf->assign_hook && newval)
4960 const char *hookresult;
4963 * If the hook ereports, we have to make sure we free
4964 * newval, else it will be a permanent memory leak.
4966 hookresult = call_string_assign_hook(conf->assign_hook,
4970 if (hookresult == NULL)
4974 (errcode(ERRCODE_INVALID_PARAMETER_VALUE),
4975 errmsg("invalid value for parameter \"%s\": \"%s\"",
4976 name, value ? value : "")));
4979 else if (hookresult != newval)
4984 * Having to cast away const here is annoying, but the
4985 * alternative is to declare assign_hooks as returning
4986 * char*, which would mean they'd have to cast away
4987 * const, or as both taking and returning char*, which
4988 * doesn't seem attractive either --- we don't want
4989 * them to scribble on the passed str.
4991 newval = (char *) hookresult;
4997 set_string_field(conf, conf->variable, newval);
4998 conf->gen.source = source;
5004 if (conf->gen.reset_source <= source)
5006 set_string_field(conf, &conf->reset_val, newval);
5007 conf->gen.reset_source = source;
5009 for (stack = conf->gen.stack; stack; stack = stack->prev)
5011 if (stack->source <= source)
5013 set_string_field(conf, &stack->prior.stringval,
5015 stack->source = source;
5019 /* Perhaps we didn't install newval anywhere */
5020 if (newval && !string_field_used(conf, newval))
5026 struct config_enum *conf = (struct config_enum *) record;
5031 if (!config_enum_lookup_by_name(conf, value, &newval))
5035 hintmsg = config_enum_get_options(conf,
5036 "Available values: ",
5040 (errcode(ERRCODE_INVALID_PARAMETER_VALUE),
5041 errmsg("invalid value for parameter \"%s\": \"%s\"",
5043 hintmsg ? errhint("%s", _(hintmsg)) : 0));
5050 else if (source == PGC_S_DEFAULT)
5051 newval = conf->boot_val;
5054 newval = conf->reset_val;
5055 source = conf->gen.reset_source;
5058 /* Save old value to support transaction abort */
5059 if (changeVal && !makeDefault)
5060 push_old_value(&conf->gen, action);
5062 if (conf->assign_hook)
5063 if (!(*conf->assign_hook) (newval, changeVal, source))
5066 (errcode(ERRCODE_INVALID_PARAMETER_VALUE),
5067 errmsg("invalid value for parameter \"%s\": \"%s\"",
5069 config_enum_lookup_by_value(conf, newval))));
5075 *conf->variable = newval;
5076 conf->gen.source = source;
5082 if (conf->gen.reset_source <= source)
5084 conf->reset_val = newval;
5085 conf->gen.reset_source = source;
5087 for (stack = conf->gen.stack; stack; stack = stack->prev)
5089 if (stack->source <= source)
5091 stack->prior.enumval = newval;
5092 stack->source = source;
5100 if (changeVal && (record->flags & GUC_REPORT))
5101 ReportGUCOption(record);
5108 * Set the fields for source file and line number the setting came from.
5111 set_config_sourcefile(const char *name, char *sourcefile, int sourceline)
5113 struct config_generic *record;
5117 * To avoid cluttering the log, only the postmaster bleats loudly about
5118 * problems with the config file.
5120 elevel = IsUnderPostmaster ? DEBUG3 : LOG;
5122 record = find_option(name, true, elevel);
5123 /* should not happen */
5125 elog(ERROR, "unrecognized configuration parameter \"%s\"", name);
5127 sourcefile = guc_strdup(elevel, sourcefile);
5128 if (record->sourcefile)
5129 free(record->sourcefile);
5130 record->sourcefile = sourcefile;
5131 record->sourceline = sourceline;
5135 * Set a config option to the given value. See also set_config_option,
5136 * this is just the wrapper to be called from outside GUC. NB: this
5137 * is used only for non-transactional operations.
5139 * Note: there is no support here for setting source file/line, as it
5140 * is currently not needed.
5143 SetConfigOption(const char *name, const char *value,
5144 GucContext context, GucSource source)
5146 (void) set_config_option(name, value, context, source,
5147 GUC_ACTION_SET, true);
5153 * Fetch the current value of the option `name'. If the option doesn't exist,
5154 * throw an ereport and don't return.
5156 * The string is *not* allocated for modification and is really only
5157 * valid until the next call to configuration related functions.
5160 GetConfigOption(const char *name)
5162 struct config_generic *record;
5163 static char buffer[256];
5165 record = find_option(name, false, ERROR);
5168 (errcode(ERRCODE_UNDEFINED_OBJECT),
5169 errmsg("unrecognized configuration parameter \"%s\"", name)));
5170 if ((record->flags & GUC_SUPERUSER_ONLY) && !superuser())
5172 (errcode(ERRCODE_INSUFFICIENT_PRIVILEGE),
5173 errmsg("must be superuser to examine \"%s\"", name)));
5175 switch (record->vartype)
5178 return *((struct config_bool *) record)->variable ? "on" : "off";
5181 snprintf(buffer, sizeof(buffer), "%d",
5182 *((struct config_int *) record)->variable);
5186 snprintf(buffer, sizeof(buffer), "%g",
5187 *((struct config_real *) record)->variable);
5191 return *((struct config_string *) record)->variable;
5194 return config_enum_lookup_by_value((struct config_enum *) record,
5195 *((struct config_enum *) record)->variable);
5201 * Get the RESET value associated with the given option.
5203 * Note: this is not re-entrant, due to use of static result buffer;
5204 * not to mention that a string variable could have its reset_val changed.
5205 * Beware of assuming the result value is good for very long.
5208 GetConfigOptionResetString(const char *name)
5210 struct config_generic *record;
5211 static char buffer[256];
5213 record = find_option(name, false, ERROR);
5216 (errcode(ERRCODE_UNDEFINED_OBJECT),
5217 errmsg("unrecognized configuration parameter \"%s\"", name)));
5218 if ((record->flags & GUC_SUPERUSER_ONLY) && !superuser())
5220 (errcode(ERRCODE_INSUFFICIENT_PRIVILEGE),
5221 errmsg("must be superuser to examine \"%s\"", name)));
5223 switch (record->vartype)
5226 return ((struct config_bool *) record)->reset_val ? "on" : "off";
5229 snprintf(buffer, sizeof(buffer), "%d",
5230 ((struct config_int *) record)->reset_val);
5234 snprintf(buffer, sizeof(buffer), "%g",
5235 ((struct config_real *) record)->reset_val);
5239 return ((struct config_string *) record)->reset_val;
5242 return config_enum_lookup_by_value((struct config_enum *) record,
5243 ((struct config_enum *) record)->reset_val);
5250 * GUC_complaint_elevel
5251 * Get the ereport error level to use in an assign_hook's error report.
5253 * This should be used by assign hooks that want to emit a custom error
5254 * report (in addition to the generic "invalid value for option FOO" that
5255 * guc.c will provide). Note that the result might be ERROR or a lower
5256 * level, so the caller must be prepared for control to return from ereport,
5257 * or not. If control does return, return false/NULL from the hook function.
5259 * At some point it'd be nice to replace this with a mechanism that allows
5260 * the custom message to become the DETAIL line of guc.c's generic message.
5263 GUC_complaint_elevel(GucSource source)
5267 if (source == PGC_S_FILE)
5270 * To avoid cluttering the log, only the postmaster bleats loudly
5271 * about problems with the config file.
5273 elevel = IsUnderPostmaster ? DEBUG3 : LOG;
5275 else if (source == PGC_S_OVERRIDE)
5278 * If we're a postmaster child, this is probably "undo" during
5279 * transaction abort, so we don't want to clutter the log. There's a
5280 * small chance of a real problem with an OVERRIDE setting, though, so
5281 * suppressing the message entirely wouldn't be desirable.
5283 elevel = IsUnderPostmaster ? DEBUG5 : LOG;
5285 else if (source < PGC_S_INTERACTIVE)
5295 * flatten_set_variable_args
5296 * Given a parsenode List as emitted by the grammar for SET,
5297 * convert to the flat string representation used by GUC.
5299 * We need to be told the name of the variable the args are for, because
5300 * the flattening rules vary (ugh).
5302 * The result is NULL if args is NIL (ie, SET ... TO DEFAULT), otherwise
5303 * a palloc'd string.
5306 flatten_set_variable_args(const char *name, List *args)
5308 struct config_generic *record;
5313 /* Fast path if just DEFAULT */
5317 /* Else get flags for the variable */
5318 record = find_option(name, true, ERROR);
5321 (errcode(ERRCODE_UNDEFINED_OBJECT),
5322 errmsg("unrecognized configuration parameter \"%s\"", name)));
5324 flags = record->flags;
5326 /* Complain if list input and non-list variable */
5327 if ((flags & GUC_LIST_INPUT) == 0 &&
5328 list_length(args) != 1)
5330 (errcode(ERRCODE_INVALID_PARAMETER_VALUE),
5331 errmsg("SET %s takes only one argument", name)));
5333 initStringInfo(&buf);
5336 * Each list member may be a plain A_Const node, or an A_Const within a
5337 * TypeCast; the latter case is supported only for ConstInterval arguments
5338 * (for SET TIME ZONE).
5342 Node *arg = (Node *) lfirst(l);
5344 TypeName *typeName = NULL;
5347 if (l != list_head(args))
5348 appendStringInfo(&buf, ", ");
5350 if (IsA(arg, TypeCast))
5352 TypeCast *tc = (TypeCast *) arg;
5355 typeName = tc->typeName;
5358 if (!IsA(arg, A_Const))
5359 elog(ERROR, "unrecognized node type: %d", (int) nodeTag(arg));
5360 con = (A_Const *) arg;
5362 switch (nodeTag(&con->val))
5365 appendStringInfo(&buf, "%ld", intVal(&con->val));
5368 /* represented as a string, so just copy it */
5369 appendStringInfoString(&buf, strVal(&con->val));
5372 val = strVal(&con->val);
5373 if (typeName != NULL)
5376 * Must be a ConstInterval argument for TIME ZONE. Coerce
5377 * to interval and back to normalize the value and account
5385 typoid = typenameTypeId(NULL, typeName, &typmod);
5386 Assert(typoid == INTERVALOID);
5389 DirectFunctionCall3(interval_in,
5390 CStringGetDatum(val),
5391 ObjectIdGetDatum(InvalidOid),
5392 Int32GetDatum(typmod));
5395 DatumGetCString(DirectFunctionCall1(interval_out,
5397 appendStringInfo(&buf, "INTERVAL '%s'", intervalout);
5402 * Plain string literal or identifier. For quote mode,
5403 * quote it if it's not a vanilla identifier.
5405 if (flags & GUC_LIST_QUOTE)
5406 appendStringInfoString(&buf, quote_identifier(val));
5408 appendStringInfoString(&buf, val);
5412 elog(ERROR, "unrecognized node type: %d",
5413 (int) nodeTag(&con->val));
5426 ExecSetVariableStmt(VariableSetStmt *stmt)
5428 GucAction action = stmt->is_local ? GUC_ACTION_LOCAL : GUC_ACTION_SET;
5433 case VAR_SET_CURRENT:
5434 set_config_option(stmt->name,
5435 ExtractSetVariableArgs(stmt),
5436 (superuser() ? PGC_SUSET : PGC_USERSET),
5444 * Special case for special SQL syntax that effectively sets more
5445 * than one variable per statement.
5447 if (strcmp(stmt->name, "TRANSACTION") == 0)
5451 foreach(head, stmt->args)
5453 DefElem *item = (DefElem *) lfirst(head);
5455 if (strcmp(item->defname, "transaction_isolation") == 0)
5456 SetPGVariable("transaction_isolation",
5457 list_make1(item->arg), stmt->is_local);
5458 else if (strcmp(item->defname, "transaction_read_only") == 0)
5459 SetPGVariable("transaction_read_only",
5460 list_make1(item->arg), stmt->is_local);
5462 elog(ERROR, "unexpected SET TRANSACTION element: %s",
5466 else if (strcmp(stmt->name, "SESSION CHARACTERISTICS") == 0)
5470 foreach(head, stmt->args)
5472 DefElem *item = (DefElem *) lfirst(head);
5474 if (strcmp(item->defname, "transaction_isolation") == 0)
5475 SetPGVariable("default_transaction_isolation",
5476 list_make1(item->arg), stmt->is_local);
5477 else if (strcmp(item->defname, "transaction_read_only") == 0)
5478 SetPGVariable("default_transaction_read_only",
5479 list_make1(item->arg), stmt->is_local);
5481 elog(ERROR, "unexpected SET SESSION element: %s",
5486 elog(ERROR, "unexpected SET MULTI element: %s",
5489 case VAR_SET_DEFAULT:
5491 set_config_option(stmt->name,
5493 (superuser() ? PGC_SUSET : PGC_USERSET),
5505 * Get the value to assign for a VariableSetStmt, or NULL if it's RESET.
5506 * The result is palloc'd.
5508 * This is exported for use by actions such as ALTER ROLE SET.
5511 ExtractSetVariableArgs(VariableSetStmt *stmt)
5516 return flatten_set_variable_args(stmt->name, stmt->args);
5517 case VAR_SET_CURRENT:
5518 return GetConfigOptionByName(stmt->name, NULL);
5525 * SetPGVariable - SET command exported as an easily-C-callable function.
5527 * This provides access to SET TO value, as well as SET TO DEFAULT (expressed
5528 * by passing args == NIL), but not SET FROM CURRENT functionality.
5531 SetPGVariable(const char *name, List *args, bool is_local)
5533 char *argstring = flatten_set_variable_args(name, args);
5535 /* Note SET DEFAULT (argstring == NULL) is equivalent to RESET */
5536 set_config_option(name,
5538 (superuser() ? PGC_SUSET : PGC_USERSET),
5540 is_local ? GUC_ACTION_LOCAL : GUC_ACTION_SET,
5545 * SET command wrapped as a SQL callable function.
5548 set_config_by_name(PG_FUNCTION_ARGS)
5555 if (PG_ARGISNULL(0))
5557 (errcode(ERRCODE_NULL_VALUE_NOT_ALLOWED),
5558 errmsg("SET requires parameter name")));
5560 /* Get the GUC variable name */
5561 name = TextDatumGetCString(PG_GETARG_DATUM(0));
5563 /* Get the desired value or set to NULL for a reset request */
5564 if (PG_ARGISNULL(1))
5567 value = TextDatumGetCString(PG_GETARG_DATUM(1));
5570 * Get the desired state of is_local. Default to false if provided value
5573 if (PG_ARGISNULL(2))
5576 is_local = PG_GETARG_BOOL(2);
5578 /* Note SET DEFAULT (argstring == NULL) is equivalent to RESET */
5579 set_config_option(name,
5581 (superuser() ? PGC_SUSET : PGC_USERSET),
5583 is_local ? GUC_ACTION_LOCAL : GUC_ACTION_SET,
5586 /* get the new current value */
5587 new_value = GetConfigOptionByName(name, NULL);
5589 /* Convert return string to text */
5590 PG_RETURN_TEXT_P(cstring_to_text(new_value));
5595 * Common code for DefineCustomXXXVariable subroutines: allocate the
5596 * new variable's config struct and fill in generic fields.
5598 static struct config_generic *
5599 init_custom_variable(const char *name,
5600 const char *short_desc,
5601 const char *long_desc,
5604 enum config_type type,
5607 struct config_generic *gen;
5610 * Only allow custom PGC_POSTMASTER variables to be created during shared
5611 * library preload; any later than that, we can't ensure that the value
5612 * doesn't change after startup. This is a fatal elog if it happens; just
5613 * erroring out isn't safe because we don't know what the calling loadable
5614 * module might already have hooked into.
5616 if (context == PGC_POSTMASTER &&
5617 !process_shared_preload_libraries_in_progress)
5618 elog(FATAL, "cannot create PGC_POSTMASTER variables after startup");
5620 gen = (struct config_generic *) guc_malloc(ERROR, sz);
5623 gen->name = guc_strdup(ERROR, name);
5624 gen->context = context;
5625 gen->group = CUSTOM_OPTIONS;
5626 gen->short_desc = short_desc;
5627 gen->long_desc = long_desc;
5629 gen->vartype = type;
5635 * Common code for DefineCustomXXXVariable subroutines: insert the new
5636 * variable into the GUC variable array, replacing any placeholder.
5639 define_custom_variable(struct config_generic * variable)
5641 const char *name = variable->name;
5642 const char **nameAddr = &name;
5644 struct config_string *pHolder;
5645 GucContext phcontext;
5646 struct config_generic **res;
5649 * See if there's a placeholder by the same name.
5651 res = (struct config_generic **) bsearch((void *) &nameAddr,
5652 (void *) guc_variables,
5654 sizeof(struct config_generic *),
5659 * No placeholder to replace, so we can just add it ... but first,
5660 * make sure it's initialized to its default value.
5662 InitializeOneGUCOption(variable);
5663 add_guc_variable(variable, ERROR);
5668 * This better be a placeholder
5670 if (((*res)->flags & GUC_CUSTOM_PLACEHOLDER) == 0)
5672 (errcode(ERRCODE_INTERNAL_ERROR),
5673 errmsg("attempt to redefine parameter \"%s\"", name)));
5675 Assert((*res)->vartype == PGC_STRING);
5676 pHolder = (struct config_string *) (*res);
5679 * First, set the variable to its default value. We must do this even
5680 * though we intend to immediately apply a new value, since it's possible
5681 * that the new value is invalid.
5683 InitializeOneGUCOption(variable);
5686 * Replace the placeholder. We aren't changing the name, so no re-sorting
5692 * Infer context for assignment based on source of existing value. We
5693 * can't tell this with exact accuracy, but we can at least do something
5694 * reasonable in typical cases.
5696 switch (pHolder->gen.source)
5704 * If we got past the check in init_custom_variable, we can safely
5705 * assume that any existing value for a PGC_POSTMASTER variable
5706 * was set in postmaster context.
5708 if (variable->context == PGC_POSTMASTER)
5709 phcontext = PGC_POSTMASTER;
5711 phcontext = PGC_SIGHUP;
5713 case PGC_S_DATABASE:
5718 phcontext = PGC_USERSET;
5723 * Assign the string value stored in the placeholder to the real variable.
5725 * XXX this is not really good enough --- it should be a nontransactional
5726 * assignment, since we don't want it to roll back if the current xact
5727 * fails later. (Or do we?)
5729 value = *pHolder->variable;
5733 if (set_config_option(name, value,
5734 phcontext, pHolder->gen.source,
5735 GUC_ACTION_SET, true))
5737 /* Also copy over any saved source-location information */
5738 if (pHolder->gen.sourcefile)
5739 set_config_sourcefile(name, pHolder->gen.sourcefile,
5740 pHolder->gen.sourceline);
5745 * Free up as much as we conveniently can of the placeholder structure
5746 * (this neglects any stack items...)
5748 set_string_field(pHolder, pHolder->variable, NULL);
5749 set_string_field(pHolder, &pHolder->reset_val, NULL);
5755 DefineCustomBoolVariable(const char *name,
5756 const char *short_desc,
5757 const char *long_desc,
5762 GucBoolAssignHook assign_hook,
5763 GucShowHook show_hook)
5765 struct config_bool *var;
5767 var = (struct config_bool *)
5768 init_custom_variable(name, short_desc, long_desc, context, flags,
5769 PGC_BOOL, sizeof(struct config_bool));
5770 var->variable = valueAddr;
5771 var->boot_val = bootValue;
5772 var->reset_val = bootValue;
5773 var->assign_hook = assign_hook;
5774 var->show_hook = show_hook;
5775 define_custom_variable(&var->gen);
5779 DefineCustomIntVariable(const char *name,
5780 const char *short_desc,
5781 const char *long_desc,
5788 GucIntAssignHook assign_hook,
5789 GucShowHook show_hook)
5791 struct config_int *var;
5793 var = (struct config_int *)
5794 init_custom_variable(name, short_desc, long_desc, context, flags,
5795 PGC_INT, sizeof(struct config_int));
5796 var->variable = valueAddr;
5797 var->boot_val = bootValue;
5798 var->reset_val = bootValue;
5799 var->min = minValue;
5800 var->max = maxValue;
5801 var->assign_hook = assign_hook;
5802 var->show_hook = show_hook;
5803 define_custom_variable(&var->gen);
5807 DefineCustomRealVariable(const char *name,
5808 const char *short_desc,
5809 const char *long_desc,
5816 GucRealAssignHook assign_hook,
5817 GucShowHook show_hook)
5819 struct config_real *var;
5821 var = (struct config_real *)
5822 init_custom_variable(name, short_desc, long_desc, context, flags,
5823 PGC_REAL, sizeof(struct config_real));
5824 var->variable = valueAddr;
5825 var->boot_val = bootValue;
5826 var->reset_val = bootValue;
5827 var->min = minValue;
5828 var->max = maxValue;
5829 var->assign_hook = assign_hook;
5830 var->show_hook = show_hook;
5831 define_custom_variable(&var->gen);
5835 DefineCustomStringVariable(const char *name,
5836 const char *short_desc,
5837 const char *long_desc,
5839 const char *bootValue,
5842 GucStringAssignHook assign_hook,
5843 GucShowHook show_hook)
5845 struct config_string *var;
5847 var = (struct config_string *)
5848 init_custom_variable(name, short_desc, long_desc, context, flags,
5849 PGC_STRING, sizeof(struct config_string));
5850 var->variable = valueAddr;
5851 var->boot_val = bootValue;
5852 /* we could probably do without strdup, but keep it like normal case */
5854 var->reset_val = guc_strdup(ERROR, var->boot_val);
5855 var->assign_hook = assign_hook;
5856 var->show_hook = show_hook;
5857 define_custom_variable(&var->gen);
5861 DefineCustomEnumVariable(const char *name,
5862 const char *short_desc,
5863 const char *long_desc,
5866 const struct config_enum_entry * options,
5869 GucEnumAssignHook assign_hook,
5870 GucShowHook show_hook)
5872 struct config_enum *var;
5874 var = (struct config_enum *)
5875 init_custom_variable(name, short_desc, long_desc, context, flags,
5876 PGC_ENUM, sizeof(struct config_enum));
5877 var->variable = valueAddr;
5878 var->boot_val = bootValue;
5879 var->reset_val = bootValue;
5880 var->options = options;
5881 var->assign_hook = assign_hook;
5882 var->show_hook = show_hook;
5883 define_custom_variable(&var->gen);
5887 EmitWarningsOnPlaceholders(const char *className)
5889 int classLen = strlen(className);
5892 for (i = 0; i < num_guc_variables; i++)
5894 struct config_generic *var = guc_variables[i];
5896 if ((var->flags & GUC_CUSTOM_PLACEHOLDER) != 0 &&
5897 strncmp(className, var->name, classLen) == 0 &&
5898 var->name[classLen] == GUC_QUALIFIER_SEPARATOR)
5901 (errcode(ERRCODE_UNDEFINED_OBJECT),
5902 errmsg("unrecognized configuration parameter \"%s\"",
5913 GetPGVariable(const char *name, DestReceiver *dest)
5915 if (guc_name_compare(name, "all") == 0)
5916 ShowAllGUCConfig(dest);
5918 ShowGUCConfigOption(name, dest);
5922 GetPGVariableResultDesc(const char *name)
5926 if (guc_name_compare(name, "all") == 0)
5928 /* need a tuple descriptor representing three TEXT columns */
5929 tupdesc = CreateTemplateTupleDesc(3, false);
5930 TupleDescInitEntry(tupdesc, (AttrNumber) 1, "name",
5932 TupleDescInitEntry(tupdesc, (AttrNumber) 2, "setting",
5934 TupleDescInitEntry(tupdesc, (AttrNumber) 3, "description",
5939 const char *varname;
5941 /* Get the canonical spelling of name */
5942 (void) GetConfigOptionByName(name, &varname);
5944 /* need a tuple descriptor representing a single TEXT column */
5945 tupdesc = CreateTemplateTupleDesc(1, false);
5946 TupleDescInitEntry(tupdesc, (AttrNumber) 1, varname,
5957 ShowGUCConfigOption(const char *name, DestReceiver *dest)
5959 TupOutputState *tstate;
5961 const char *varname;
5964 /* Get the value and canonical spelling of name */
5965 value = GetConfigOptionByName(name, &varname);
5967 /* need a tuple descriptor representing a single TEXT column */
5968 tupdesc = CreateTemplateTupleDesc(1, false);
5969 TupleDescInitEntry(tupdesc, (AttrNumber) 1, varname,
5972 /* prepare for projection of tuples */
5973 tstate = begin_tup_output_tupdesc(dest, tupdesc);
5976 do_text_output_oneline(tstate, value);
5978 end_tup_output(tstate);
5985 ShowAllGUCConfig(DestReceiver *dest)
5987 bool am_superuser = superuser();
5989 TupOutputState *tstate;
5992 bool isnull[3] = { false, false, false };
5994 /* need a tuple descriptor representing three TEXT columns */
5995 tupdesc = CreateTemplateTupleDesc(3, false);
5996 TupleDescInitEntry(tupdesc, (AttrNumber) 1, "name",
5998 TupleDescInitEntry(tupdesc, (AttrNumber) 2, "setting",
6000 TupleDescInitEntry(tupdesc, (AttrNumber) 3, "description",
6003 /* prepare for projection of tuples */
6004 tstate = begin_tup_output_tupdesc(dest, tupdesc);
6006 for (i = 0; i < num_guc_variables; i++)
6008 struct config_generic *conf = guc_variables[i];
6011 if ((conf->flags & GUC_NO_SHOW_ALL) ||
6012 ((conf->flags & GUC_SUPERUSER_ONLY) && !am_superuser))
6015 /* assign to the values array */
6016 values[0] = PointerGetDatum(cstring_to_text(conf->name));
6018 setting = _ShowOption(conf, true);
6021 values[1] = PointerGetDatum(cstring_to_text(setting));
6026 values[1] = PointerGetDatum(NULL);
6030 values[2] = PointerGetDatum(cstring_to_text(conf->short_desc));
6032 /* send it to dest */
6033 do_tup_output(tstate, values, isnull);
6036 pfree(DatumGetPointer(values[0]));
6040 pfree(DatumGetPointer(values[1]));
6042 pfree(DatumGetPointer(values[2]));
6045 end_tup_output(tstate);
6049 * Return GUC variable value by name; optionally return canonical
6050 * form of name. Return value is palloc'd.
6053 GetConfigOptionByName(const char *name, const char **varname)
6055 struct config_generic *record;
6057 record = find_option(name, false, ERROR);
6060 (errcode(ERRCODE_UNDEFINED_OBJECT),
6061 errmsg("unrecognized configuration parameter \"%s\"", name)));
6062 if ((record->flags & GUC_SUPERUSER_ONLY) && !superuser())
6064 (errcode(ERRCODE_INSUFFICIENT_PRIVILEGE),
6065 errmsg("must be superuser to examine \"%s\"", name)));
6068 *varname = record->name;
6070 return _ShowOption(record, true);
6074 * Return GUC variable value by variable number; optionally return canonical
6075 * form of name. Return value is palloc'd.
6078 GetConfigOptionByNum(int varnum, const char **values, bool *noshow)
6081 struct config_generic *conf;
6083 /* check requested variable number valid */
6084 Assert((varnum >= 0) && (varnum < num_guc_variables));
6086 conf = guc_variables[varnum];
6090 if ((conf->flags & GUC_NO_SHOW_ALL) ||
6091 ((conf->flags & GUC_SUPERUSER_ONLY) && !superuser()))
6097 /* first get the generic attributes */
6100 values[0] = conf->name;
6102 /* setting : use _ShowOption in order to avoid duplicating the logic */
6103 values[1] = _ShowOption(conf, false);
6106 if (conf->vartype == PGC_INT)
6110 switch (conf->flags & (GUC_UNIT_MEMORY | GUC_UNIT_TIME))
6115 case GUC_UNIT_BLOCKS:
6116 snprintf(buf, sizeof(buf), "%dkB", BLCKSZ / 1024);
6119 case GUC_UNIT_XBLOCKS:
6120 snprintf(buf, sizeof(buf), "%dkB", XLOG_BLCKSZ / 1024);
6141 values[3] = config_group_names[conf->group];
6144 values[4] = conf->short_desc;
6147 values[5] = conf->long_desc;
6150 values[6] = GucContext_Names[conf->context];
6153 values[7] = config_type_names[conf->vartype];
6156 values[8] = GucSource_Names[conf->source];
6158 /* now get the type specifc attributes */
6159 switch (conf->vartype)
6163 struct config_bool *lconf = (struct config_bool *) conf;
6175 values[12] = pstrdup(lconf->boot_val ? "on" : "off");
6178 values[13] = pstrdup(lconf->reset_val ? "on" : "off");
6184 struct config_int *lconf = (struct config_int *) conf;
6187 snprintf(buffer, sizeof(buffer), "%d", lconf->min);
6188 values[9] = pstrdup(buffer);
6191 snprintf(buffer, sizeof(buffer), "%d", lconf->max);
6192 values[10] = pstrdup(buffer);
6198 snprintf(buffer, sizeof(buffer), "%d", lconf->boot_val);
6199 values[12] = pstrdup(buffer);
6202 snprintf(buffer, sizeof(buffer), "%d", lconf->reset_val);
6203 values[13] = pstrdup(buffer);
6209 struct config_real *lconf = (struct config_real *) conf;
6212 snprintf(buffer, sizeof(buffer), "%g", lconf->min);
6213 values[9] = pstrdup(buffer);
6216 snprintf(buffer, sizeof(buffer), "%g", lconf->max);
6217 values[10] = pstrdup(buffer);
6223 snprintf(buffer, sizeof(buffer), "%g", lconf->boot_val);
6224 values[12] = pstrdup(buffer);
6227 snprintf(buffer, sizeof(buffer), "%g", lconf->reset_val);
6228 values[13] = pstrdup(buffer);
6234 struct config_string *lconf = (struct config_string *) conf;
6246 if (lconf->boot_val == NULL)
6249 values[12] = pstrdup(lconf->boot_val);
6252 if (lconf->reset_val == NULL)
6255 values[13] = pstrdup(lconf->reset_val);
6261 struct config_enum *lconf = (struct config_enum *) conf;
6272 * NOTE! enumvals with double quotes in them are not
6275 values[11] = config_enum_get_options((struct config_enum *) conf,
6276 "{\"", "\"}", "\",\"");
6279 values[12] = pstrdup(config_enum_lookup_by_value(lconf,
6283 values[13] = pstrdup(config_enum_lookup_by_value(lconf,
6291 * should never get here, but in case we do, set 'em to NULL
6313 * If the setting came from a config file, set the source location. For
6314 * security reasons, we don't show source file/line number for
6317 if (conf->source == PGC_S_FILE && superuser())
6319 values[14] = conf->sourcefile;
6320 snprintf(buffer, sizeof(buffer), "%d", conf->sourceline);
6321 values[15] = pstrdup(buffer);
6331 * Return the total number of GUC variables
6334 GetNumConfigOptions(void)
6336 return num_guc_variables;
6340 * show_config_by_name - equiv to SHOW X command but implemented as
6344 show_config_by_name(PG_FUNCTION_ARGS)
6349 /* Get the GUC variable name */
6350 varname = TextDatumGetCString(PG_GETARG_DATUM(0));
6353 varval = GetConfigOptionByName(varname, NULL);
6355 /* Convert to text */
6356 PG_RETURN_TEXT_P(cstring_to_text(varval));
6360 * show_all_settings - equiv to SHOW ALL command but implemented as
6363 #define NUM_PG_SETTINGS_ATTS 16
6366 show_all_settings(PG_FUNCTION_ARGS)
6368 FuncCallContext *funcctx;
6372 AttInMetadata *attinmeta;
6373 MemoryContext oldcontext;
6375 /* stuff done only on the first call of the function */
6376 if (SRF_IS_FIRSTCALL())
6378 /* create a function context for cross-call persistence */
6379 funcctx = SRF_FIRSTCALL_INIT();
6382 * switch to memory context appropriate for multiple function calls
6384 oldcontext = MemoryContextSwitchTo(funcctx->multi_call_memory_ctx);
6387 * need a tuple descriptor representing NUM_PG_SETTINGS_ATTS columns
6388 * of the appropriate types
6390 tupdesc = CreateTemplateTupleDesc(NUM_PG_SETTINGS_ATTS, false);
6391 TupleDescInitEntry(tupdesc, (AttrNumber) 1, "name",
6393 TupleDescInitEntry(tupdesc, (AttrNumber) 2, "setting",
6395 TupleDescInitEntry(tupdesc, (AttrNumber) 3, "unit",
6397 TupleDescInitEntry(tupdesc, (AttrNumber) 4, "category",
6399 TupleDescInitEntry(tupdesc, (AttrNumber) 5, "short_desc",
6401 TupleDescInitEntry(tupdesc, (AttrNumber) 6, "extra_desc",
6403 TupleDescInitEntry(tupdesc, (AttrNumber) 7, "context",
6405 TupleDescInitEntry(tupdesc, (AttrNumber) 8, "vartype",
6407 TupleDescInitEntry(tupdesc, (AttrNumber) 9, "source",
6409 TupleDescInitEntry(tupdesc, (AttrNumber) 10, "min_val",
6411 TupleDescInitEntry(tupdesc, (AttrNumber) 11, "max_val",
6413 TupleDescInitEntry(tupdesc, (AttrNumber) 12, "enumvals",
6414 TEXTARRAYOID, -1, 0);
6415 TupleDescInitEntry(tupdesc, (AttrNumber) 13, "boot_val",
6417 TupleDescInitEntry(tupdesc, (AttrNumber) 14, "reset_val",
6419 TupleDescInitEntry(tupdesc, (AttrNumber) 15, "sourcefile",
6421 TupleDescInitEntry(tupdesc, (AttrNumber) 16, "sourceline",
6425 * Generate attribute metadata needed later to produce tuples from raw
6428 attinmeta = TupleDescGetAttInMetadata(tupdesc);
6429 funcctx->attinmeta = attinmeta;
6431 /* total number of tuples to be returned */
6432 funcctx->max_calls = GetNumConfigOptions();
6434 MemoryContextSwitchTo(oldcontext);
6437 /* stuff done on every call of the function */
6438 funcctx = SRF_PERCALL_SETUP();
6440 call_cntr = funcctx->call_cntr;
6441 max_calls = funcctx->max_calls;
6442 attinmeta = funcctx->attinmeta;
6444 if (call_cntr < max_calls) /* do when there is more left to send */
6446 char *values[NUM_PG_SETTINGS_ATTS];
6452 * Get the next visible GUC variable name and value
6456 GetConfigOptionByNum(call_cntr, (const char **) values, &noshow);
6459 /* bump the counter and get the next config setting */
6460 call_cntr = ++funcctx->call_cntr;
6462 /* make sure we haven't gone too far now */
6463 if (call_cntr >= max_calls)
6464 SRF_RETURN_DONE(funcctx);
6469 tuple = BuildTupleFromCStrings(attinmeta, values);
6471 /* make the tuple into a datum */
6472 result = HeapTupleGetDatum(tuple);
6474 SRF_RETURN_NEXT(funcctx, result);
6478 /* do when there is no more left */
6479 SRF_RETURN_DONE(funcctx);
6484 _ShowOption(struct config_generic * record, bool use_units)
6489 switch (record->vartype)
6493 struct config_bool *conf = (struct config_bool *) record;
6495 if (conf->show_hook)
6496 val = (*conf->show_hook) ();
6498 val = *conf->variable ? "on" : "off";
6504 struct config_int *conf = (struct config_int *) record;
6506 if (conf->show_hook)
6507 val = (*conf->show_hook) ();
6511 * Use int64 arithmetic to avoid overflows in units
6512 * conversion. If INT64_IS_BUSTED we might overflow
6513 * anyway and print bogus answers, but there are few
6514 * enough such machines that it doesn't seem worth trying
6517 int64 result = *conf->variable;
6520 if (use_units && result > 0 &&
6521 (record->flags & GUC_UNIT_MEMORY))
6523 switch (record->flags & GUC_UNIT_MEMORY)
6525 case GUC_UNIT_BLOCKS:
6526 result *= BLCKSZ / 1024;
6528 case GUC_UNIT_XBLOCKS:
6529 result *= XLOG_BLCKSZ / 1024;
6533 if (result % KB_PER_GB == 0)
6535 result /= KB_PER_GB;
6538 else if (result % KB_PER_MB == 0)
6540 result /= KB_PER_MB;
6548 else if (use_units && result > 0 &&
6549 (record->flags & GUC_UNIT_TIME))
6551 switch (record->flags & GUC_UNIT_TIME)
6557 result *= MS_PER_MIN;
6561 if (result % MS_PER_D == 0)
6566 else if (result % MS_PER_H == 0)
6571 else if (result % MS_PER_MIN == 0)
6573 result /= MS_PER_MIN;
6576 else if (result % MS_PER_S == 0)
6589 snprintf(buffer, sizeof(buffer), INT64_FORMAT "%s",
6598 struct config_real *conf = (struct config_real *) record;
6600 if (conf->show_hook)
6601 val = (*conf->show_hook) ();
6604 snprintf(buffer, sizeof(buffer), "%g",
6613 struct config_string *conf = (struct config_string *) record;
6615 if (conf->show_hook)
6616 val = (*conf->show_hook) ();
6617 else if (*conf->variable && **conf->variable)
6618 val = *conf->variable;
6626 struct config_enum *conf = (struct config_enum *) record;
6628 if (conf->show_hook)
6629 val = (*conf->show_hook) ();
6631 val = config_enum_lookup_by_value(conf, *conf->variable);
6636 /* just to keep compiler quiet */
6641 return pstrdup(val);
6646 * Attempt (badly) to detect if a proposed new GUC setting is the same
6647 * as the current value.
6649 * XXX this does not really work because it doesn't account for the
6650 * effects of canonicalization of string values by assign_hooks.
6653 is_newvalue_equal(struct config_generic * record, const char *newvalue)
6655 /* newvalue == NULL isn't supported */
6656 Assert(newvalue != NULL);
6658 switch (record->vartype)
6662 struct config_bool *conf = (struct config_bool *) record;
6665 return parse_bool(newvalue, &newval)
6666 && *conf->variable == newval;
6670 struct config_int *conf = (struct config_int *) record;
6673 return parse_int(newvalue, &newval, record->flags, NULL)
6674 && *conf->variable == newval;
6678 struct config_real *conf = (struct config_real *) record;
6681 return parse_real(newvalue, &newval)
6682 && *conf->variable == newval;
6686 struct config_string *conf = (struct config_string *) record;
6688 return *conf->variable != NULL &&
6689 strcmp(*conf->variable, newvalue) == 0;
6694 struct config_enum *conf = (struct config_enum *) record;
6697 return config_enum_lookup_by_name(conf, newvalue, &newval) &&
6698 *conf->variable == newval;
6709 * These routines dump out all non-default GUC options into a binary
6710 * file that is read by all exec'ed backends. The format is:
6712 * variable name, string, null terminated
6713 * variable value, string, null terminated
6714 * variable source, integer
6717 write_one_nondefault_variable(FILE *fp, struct config_generic * gconf)
6719 if (gconf->source == PGC_S_DEFAULT)
6722 fprintf(fp, "%s", gconf->name);
6725 switch (gconf->vartype)
6729 struct config_bool *conf = (struct config_bool *) gconf;
6731 if (*conf->variable)
6732 fprintf(fp, "true");
6734 fprintf(fp, "false");
6740 struct config_int *conf = (struct config_int *) gconf;
6742 fprintf(fp, "%d", *conf->variable);
6748 struct config_real *conf = (struct config_real *) gconf;
6750 /* Could lose precision here? */
6751 fprintf(fp, "%f", *conf->variable);
6757 struct config_string *conf = (struct config_string *) gconf;
6759 fprintf(fp, "%s", *conf->variable);
6765 struct config_enum *conf = (struct config_enum *) gconf;
6768 config_enum_lookup_by_value(conf, *conf->variable));
6775 fwrite(&gconf->source, sizeof(gconf->source), 1, fp);
6779 write_nondefault_variables(GucContext context)
6783 struct config_generic *cvc_conf;
6786 Assert(context == PGC_POSTMASTER || context == PGC_SIGHUP);
6788 elevel = (context == PGC_SIGHUP) ? LOG : ERROR;
6793 fp = AllocateFile(CONFIG_EXEC_PARAMS_NEW, "w");
6797 (errcode_for_file_access(),
6798 errmsg("could not write to file \"%s\": %m",
6799 CONFIG_EXEC_PARAMS_NEW)));
6804 * custom_variable_classes must be written out first; otherwise we might
6805 * reject custom variable values while reading the file.
6807 cvc_conf = find_option("custom_variable_classes", false, ERROR);
6809 write_one_nondefault_variable(fp, cvc_conf);
6811 for (i = 0; i < num_guc_variables; i++)
6813 struct config_generic *gconf = guc_variables[i];
6815 if (gconf != cvc_conf)
6816 write_one_nondefault_variable(fp, gconf);
6822 (errcode_for_file_access(),
6823 errmsg("could not write to file \"%s\": %m",
6824 CONFIG_EXEC_PARAMS_NEW)));
6829 * Put new file in place. This could delay on Win32, but we don't hold
6830 * any exclusive locks.
6832 rename(CONFIG_EXEC_PARAMS_NEW, CONFIG_EXEC_PARAMS);
6837 * Read string, including null byte from file
6839 * Return NULL on EOF and nothing read
6842 read_string_with_null(FILE *fp)
6851 if ((ch = fgetc(fp)) == EOF)
6856 elog(FATAL, "invalid format of exec config params file");
6859 str = guc_malloc(FATAL, maxlen);
6860 else if (i == maxlen)
6861 str = guc_realloc(FATAL, str, maxlen *= 2);
6870 * This routine loads a previous postmaster dump of its non-default
6874 read_nondefault_variables(void)
6884 fp = AllocateFile(CONFIG_EXEC_PARAMS, "r");
6887 /* File not found is fine */
6888 if (errno != ENOENT)
6890 (errcode_for_file_access(),
6891 errmsg("could not read from file \"%s\": %m",
6892 CONFIG_EXEC_PARAMS)));
6898 struct config_generic *record;
6900 if ((varname = read_string_with_null(fp)) == NULL)
6903 if ((record = find_option(varname, true, FATAL)) == NULL)
6904 elog(FATAL, "failed to locate variable %s in exec config params file", varname);
6905 if ((varvalue = read_string_with_null(fp)) == NULL)
6906 elog(FATAL, "invalid format of exec config params file");
6907 if (fread(&varsource, sizeof(varsource), 1, fp) == 0)
6908 elog(FATAL, "invalid format of exec config params file");
6910 (void) set_config_option(varname, varvalue, record->context,
6911 varsource, GUC_ACTION_SET, true);
6918 #endif /* EXEC_BACKEND */
6922 * A little "long argument" simulation, although not quite GNU
6923 * compliant. Takes a string of the form "some-option=some value" and
6924 * returns name = "some_option" and value = "some value" in malloc'ed
6925 * storage. Note that '-' is converted to '_' in the option name. If
6926 * there is no '=' in the input string then value will be NULL.
6929 ParseLongOption(const char *string, char **name, char **value)
6938 equal_pos = strcspn(string, "=");
6940 if (string[equal_pos] == '=')
6942 *name = guc_malloc(FATAL, equal_pos + 1);
6943 strlcpy(*name, string, equal_pos + 1);
6945 *value = guc_strdup(FATAL, &string[equal_pos + 1]);
6949 /* no equal sign in string */
6950 *name = guc_strdup(FATAL, string);
6954 for (cp = *name; *cp; cp++)
6961 * Handle options fetched from pg_database.datconfig, pg_authid.rolconfig,
6962 * pg_proc.proconfig, etc. Caller must specify proper context/source/action.
6964 * The array parameter must be an array of TEXT (it must not be NULL).
6967 ProcessGUCArray(ArrayType *array,
6968 GucContext context, GucSource source, GucAction action)
6972 Assert(array != NULL);
6973 Assert(ARR_ELEMTYPE(array) == TEXTOID);
6974 Assert(ARR_NDIM(array) == 1);
6975 Assert(ARR_LBOUND(array)[0] == 1);
6977 for (i = 1; i <= ARR_DIMS(array)[0]; i++)
6985 d = array_ref(array, 1, &i,
6986 -1 /* varlenarray */ ,
6987 -1 /* TEXT's typlen */ ,
6988 false /* TEXT's typbyval */ ,
6989 'i' /* TEXT's typalign */ ,
6995 s = TextDatumGetCString(d);
6997 ParseLongOption(s, &name, &value);
7001 (errcode(ERRCODE_SYNTAX_ERROR),
7002 errmsg("could not parse setting for parameter \"%s\"",
7008 (void) set_config_option(name, value, context, source, action, true);
7018 * Add an entry to an option array. The array parameter may be NULL
7019 * to indicate the current table entry is NULL.
7022 GUCArrayAdd(ArrayType *array, const char *name, const char *value)
7024 const char *varname;
7032 /* test if the option is valid */
7033 set_config_option(name, value,
7034 superuser() ? PGC_SUSET : PGC_USERSET,
7035 PGC_S_TEST, GUC_ACTION_SET, false);
7037 /* convert name to canonical spelling, so we can use plain strcmp */
7038 (void) GetConfigOptionByName(name, &varname);
7041 newval = palloc(strlen(name) + 1 + strlen(value) + 1);
7042 sprintf(newval, "%s=%s", name, value);
7043 datum = CStringGetTextDatum(newval);
7051 Assert(ARR_ELEMTYPE(array) == TEXTOID);
7052 Assert(ARR_NDIM(array) == 1);
7053 Assert(ARR_LBOUND(array)[0] == 1);
7055 index = ARR_DIMS(array)[0] + 1; /* add after end */
7057 for (i = 1; i <= ARR_DIMS(array)[0]; i++)
7062 d = array_ref(array, 1, &i,
7063 -1 /* varlenarray */ ,
7064 -1 /* TEXT's typlen */ ,
7065 false /* TEXT's typbyval */ ,
7066 'i' /* TEXT's typalign */ ,
7070 current = TextDatumGetCString(d);
7071 if (strncmp(current, newval, strlen(name) + 1) == 0)
7078 a = array_set(array, 1, &index,
7081 -1 /* varlena array */ ,
7082 -1 /* TEXT's typlen */ ,
7083 false /* TEXT's typbyval */ ,
7084 'i' /* TEXT's typalign */ );
7087 a = construct_array(&datum, 1,
7096 * Delete an entry from an option array. The array parameter may be NULL
7097 * to indicate the current table entry is NULL. Also, if the return value
7098 * is NULL then a null should be stored.
7101 GUCArrayDelete(ArrayType *array, const char *name)
7103 const char *varname;
7104 ArrayType *newarray;
7110 /* test if the option is valid */
7111 set_config_option(name, NULL,
7112 superuser() ? PGC_SUSET : PGC_USERSET,
7113 PGC_S_TEST, GUC_ACTION_SET, false);
7115 /* convert name to canonical spelling, so we can use plain strcmp */
7116 (void) GetConfigOptionByName(name, &varname);
7119 /* if array is currently null, then surely nothing to delete */
7126 for (i = 1; i <= ARR_DIMS(array)[0]; i++)
7132 d = array_ref(array, 1, &i,
7133 -1 /* varlenarray */ ,
7134 -1 /* TEXT's typlen */ ,
7135 false /* TEXT's typbyval */ ,
7136 'i' /* TEXT's typalign */ ,
7140 val = TextDatumGetCString(d);
7142 /* ignore entry if it's what we want to delete */
7143 if (strncmp(val, name, strlen(name)) == 0
7144 && val[strlen(name)] == '=')
7147 /* else add it to the output array */
7150 newarray = array_set(newarray, 1, &index,
7153 -1 /* varlenarray */ ,
7154 -1 /* TEXT's typlen */ ,
7155 false /* TEXT's typbyval */ ,
7156 'i' /* TEXT's typalign */ );
7159 newarray = construct_array(&d, 1,
7171 * assign_hook and show_hook subroutines
7175 assign_log_destination(const char *value, bool doit, GucSource source)
7182 /* Need a modifiable copy of string */
7183 rawstring = pstrdup(value);
7185 /* Parse string into list of identifiers */
7186 if (!SplitIdentifierString(rawstring, ',', &elemlist))
7188 /* syntax error in list */
7190 list_free(elemlist);
7191 ereport(GUC_complaint_elevel(source),
7192 (errcode(ERRCODE_INVALID_PARAMETER_VALUE),
7193 errmsg("invalid list syntax for parameter \"log_destination\"")));
7197 foreach(l, elemlist)
7199 char *tok = (char *) lfirst(l);
7201 if (pg_strcasecmp(tok, "stderr") == 0)
7202 newlogdest |= LOG_DESTINATION_STDERR;
7203 else if (pg_strcasecmp(tok, "csvlog") == 0)
7204 newlogdest |= LOG_DESTINATION_CSVLOG;
7206 else if (pg_strcasecmp(tok, "syslog") == 0)
7207 newlogdest |= LOG_DESTINATION_SYSLOG;
7210 else if (pg_strcasecmp(tok, "eventlog") == 0)
7211 newlogdest |= LOG_DESTINATION_EVENTLOG;
7215 ereport(GUC_complaint_elevel(source),
7216 (errcode(ERRCODE_INVALID_PARAMETER_VALUE),
7217 errmsg("unrecognized \"log_destination\" key word: \"%s\"",
7220 list_free(elemlist);
7226 Log_destination = newlogdest;
7229 list_free(elemlist);
7237 assign_syslog_facility(int newval, bool doit, GucSource source)
7240 set_syslog_parameters(syslog_ident_str ? syslog_ident_str : "postgres",
7247 assign_syslog_ident(const char *ident, bool doit, GucSource source)
7250 set_syslog_parameters(ident, syslog_facility);
7254 #endif /* HAVE_SYSLOG */
7258 assign_session_replication_role(int newval, bool doit, GucSource source)
7261 * Must flush the plan cache when changing replication role; but don't
7262 * flush unnecessarily.
7264 if (doit && SessionReplicationRole != newval)
7273 show_num_temp_buffers(void)
7276 * We show the GUC var until local buffers have been initialized, and
7277 * NLocBuffer afterwards.
7279 static char nbuf[32];
7281 sprintf(nbuf, "%d", NLocBuffer ? NLocBuffer : num_temp_buffers);
7286 assign_phony_autocommit(bool newval, bool doit, GucSource source)
7290 ereport(GUC_complaint_elevel(source),
7291 (errcode(ERRCODE_FEATURE_NOT_SUPPORTED),
7292 errmsg("SET AUTOCOMMIT TO OFF is no longer supported")));
7299 assign_custom_variable_classes(const char *newval, bool doit, GucSource source)
7302 * Check syntax. newval must be a comma separated list of identifiers.
7303 * Whitespace is allowed but removed from the result.
7305 bool hasSpaceAfterToken = false;
7306 const char *cp = newval;
7311 initStringInfo(&buf);
7312 while ((c = *cp++) != '\0')
7314 if (isspace((unsigned char) c))
7317 hasSpaceAfterToken = true;
7323 if (symLen > 0) /* terminate identifier */
7325 appendStringInfoChar(&buf, ',');
7328 hasSpaceAfterToken = false;
7332 if (hasSpaceAfterToken || !(isalnum((unsigned char) c) || c == '_'))
7335 * Syntax error due to token following space after token or
7336 * non-identifier character
7341 appendStringInfoChar(&buf, c);
7345 /* Remove stray ',' at end */
7346 if (symLen == 0 && buf.len > 0)
7347 buf.data[--buf.len] = '\0';
7349 /* GUC wants the result malloc'd */
7350 newval = guc_strdup(LOG, buf.data);
7357 assign_debug_assertions(bool newval, bool doit, GucSource source)
7359 #ifndef USE_ASSERT_CHECKING
7362 ereport(GUC_complaint_elevel(source),
7363 (errcode(ERRCODE_INVALID_PARAMETER_VALUE),
7364 errmsg("assertion checking is not supported by this build")));
7372 assign_ssl(bool newval, bool doit, GucSource source)
7377 ereport(GUC_complaint_elevel(source),
7378 (errcode(ERRCODE_INVALID_PARAMETER_VALUE),
7379 errmsg("SSL is not supported by this build")));
7387 assign_stage_log_stats(bool newval, bool doit, GucSource source)
7389 if (newval && log_statement_stats)
7391 ereport(GUC_complaint_elevel(source),
7392 (errcode(ERRCODE_INVALID_PARAMETER_VALUE),
7393 errmsg("cannot enable parameter when \"log_statement_stats\" is true")));
7394 /* source == PGC_S_OVERRIDE means do it anyway, eg at xact abort */
7395 if (source != PGC_S_OVERRIDE)
7402 assign_log_stats(bool newval, bool doit, GucSource source)
7405 (log_parser_stats || log_planner_stats || log_executor_stats))
7407 ereport(GUC_complaint_elevel(source),
7408 (errcode(ERRCODE_INVALID_PARAMETER_VALUE),
7409 errmsg("cannot enable \"log_statement_stats\" when "
7410 "\"log_parser_stats\", \"log_planner_stats\", "
7411 "or \"log_executor_stats\" is true")));
7412 /* source == PGC_S_OVERRIDE means do it anyway, eg at xact abort */
7413 if (source != PGC_S_OVERRIDE)
7420 assign_transaction_read_only(bool newval, bool doit, GucSource source)
7422 /* Can't go to r/w mode inside a r/o transaction */
7423 if (newval == false && XactReadOnly && IsSubTransaction())
7425 ereport(GUC_complaint_elevel(source),
7426 (errcode(ERRCODE_INVALID_PARAMETER_VALUE),
7427 errmsg("cannot set transaction read-write mode inside a read-only transaction")));
7428 /* source == PGC_S_OVERRIDE means do it anyway, eg at xact abort */
7429 if (source != PGC_S_OVERRIDE)
7436 assign_canonical_path(const char *newval, bool doit, GucSource source)
7440 char *canon_val = guc_strdup(ERROR, newval);
7442 canonicalize_path(canon_val);
7450 assign_timezone_abbreviations(const char *newval, bool doit, GucSource source)
7453 * The powerup value shown above for timezone_abbreviations is "UNKNOWN".
7454 * When we see this we just do nothing. If this value isn't overridden
7455 * from the config file then pg_timezone_abbrev_initialize() will
7456 * eventually replace it with "Default". This hack has two purposes: to
7457 * avoid wasting cycles loading values that might soon be overridden from
7458 * the config file, and to avoid trying to read the timezone abbrev files
7459 * during InitializeGUCOptions(). The latter doesn't work in an
7460 * EXEC_BACKEND subprocess because my_exec_path hasn't been set yet and so
7461 * we can't locate PGSHAREDIR. (Essentially the same hack is used to
7462 * delay initializing TimeZone ... if we have any more, we should try to
7463 * clean up and centralize this mechanism ...)
7465 if (strcmp(newval, "UNKNOWN") == 0)
7470 /* Loading abbrev file is expensive, so only do it when value changes */
7471 if (timezone_abbreviations_string == NULL ||
7472 strcmp(timezone_abbreviations_string, newval) != 0)
7477 * If reading config file, only the postmaster should bleat loudly
7478 * about problems. Otherwise, it's just this one process doing it,
7479 * and we use WARNING message level.
7481 if (source == PGC_S_FILE)
7482 elevel = IsUnderPostmaster ? DEBUG3 : LOG;
7485 if (!load_tzoffsets(newval, doit, elevel))
7492 * pg_timezone_abbrev_initialize --- set default value if not done already
7494 * This is called after initial loading of postgresql.conf. If no
7495 * timezone_abbreviations setting was found therein, select default.
7498 pg_timezone_abbrev_initialize(void)
7500 if (strcmp(timezone_abbreviations_string, "UNKNOWN") == 0)
7502 SetConfigOption("timezone_abbreviations", "Default",
7503 PGC_POSTMASTER, PGC_S_ARGV);
7508 show_archive_command(void)
7510 if (XLogArchiveMode)
7511 return XLogArchiveCommand;
7513 return "(disabled)";
7517 assign_tcp_keepalives_idle(int newval, bool doit, GucSource source)
7520 return (pq_setkeepalivesidle(newval, MyProcPort) == STATUS_OK);
7526 show_tcp_keepalives_idle(void)
7528 static char nbuf[16];
7530 snprintf(nbuf, sizeof(nbuf), "%d", pq_getkeepalivesidle(MyProcPort));
7535 assign_tcp_keepalives_interval(int newval, bool doit, GucSource source)
7538 return (pq_setkeepalivesinterval(newval, MyProcPort) == STATUS_OK);
7544 show_tcp_keepalives_interval(void)
7546 static char nbuf[16];
7548 snprintf(nbuf, sizeof(nbuf), "%d", pq_getkeepalivesinterval(MyProcPort));
7553 assign_tcp_keepalives_count(int newval, bool doit, GucSource source)
7556 return (pq_setkeepalivescount(newval, MyProcPort) == STATUS_OK);
7562 show_tcp_keepalives_count(void)
7564 static char nbuf[16];
7566 snprintf(nbuf, sizeof(nbuf), "%d", pq_getkeepalivescount(MyProcPort));
7571 assign_maxconnections(int newval, bool doit, GucSource source)
7573 if (newval + autovacuum_max_workers + 1 > INT_MAX / 4)
7577 MaxBackends = newval + autovacuum_max_workers + 1;
7583 assign_autovacuum_max_workers(int newval, bool doit, GucSource source)
7585 if (MaxConnections + newval + 1 > INT_MAX / 4)
7589 MaxBackends = MaxConnections + newval + 1;
7595 assign_effective_io_concurrency(int newval, bool doit, GucSource source)
7598 double new_prefetch_pages = 0.0;
7602 * The user-visible GUC parameter is the number of drives (spindles),
7603 * which we need to translate to a number-of-pages-to-prefetch target.
7605 * The expected number of prefetch pages needed to keep N drives busy is:
7607 * drives | I/O requests
7608 * -------+----------------
7611 * 3 | 3/1 + 3/2 + 3/3 = 5 1/2
7612 * 4 | 4/1 + 4/2 + 4/3 + 4/4 = 8 1/3
7615 * This is called the "coupon collector problem" and H(n) is called the
7616 * harmonic series. This could be approximated by n * ln(n), but for
7617 * reasonable numbers of drives we might as well just compute the series.
7619 * Alternatively we could set the target to the number of pages necessary
7620 * so that the expected number of active spindles is some arbitrary
7621 * percentage of the total. This sounds the same but is actually slightly
7622 * different. The result ends up being ln(1-P)/ln((n-1)/n) where P is
7623 * that desired fraction.
7625 * Experimental results show that both of these formulas aren't aggressive
7626 * enough, but we don't really have any better proposals.
7628 * Note that if newval = 0 (disabled), we must set target = 0.
7632 for (i = 1; i <= newval; i++)
7633 new_prefetch_pages += (double) newval / (double) i;
7635 /* This range check shouldn't fail, but let's be paranoid */
7636 if (new_prefetch_pages >= 0.0 && new_prefetch_pages < (double) INT_MAX)
7639 target_prefetch_pages = (int) rint(new_prefetch_pages);
7646 #endif /* USE_PREFETCH */
7650 assign_pgstat_temp_directory(const char *newval, bool doit, GucSource source)
7654 char *canon_val = guc_strdup(ERROR, newval);
7658 canonicalize_path(canon_val);
7660 tname = guc_malloc(ERROR, strlen(canon_val) + 12); /* /pgstat.tmp */
7661 sprintf(tname, "%s/pgstat.tmp", canon_val);
7662 fname = guc_malloc(ERROR, strlen(canon_val) + 13); /* /pgstat.stat */
7663 sprintf(fname, "%s/pgstat.stat", canon_val);
7665 if (pgstat_stat_tmpname)
7666 free(pgstat_stat_tmpname);
7667 pgstat_stat_tmpname = tname;
7668 if (pgstat_stat_filename)
7669 free(pgstat_stat_filename);
7670 pgstat_stat_filename = fname;
7678 #include "guc-file.c"