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.527 2009/12/11 03:34:56 itagaki 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/be-fsstubs.h"
42 #include "libpq/pqformat.h"
43 #include "miscadmin.h"
44 #include "optimizer/cost.h"
45 #include "optimizer/geqo.h"
46 #include "optimizer/paths.h"
47 #include "optimizer/planmain.h"
48 #include "parser/parse_expr.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 "storage/bufmgr.h"
59 #include "storage/fd.h"
60 #include "tcop/tcopprot.h"
61 #include "tsearch/ts_cache.h"
62 #include "utils/builtins.h"
63 #include "utils/bytea.h"
64 #include "utils/guc_tables.h"
65 #include "utils/memutils.h"
66 #include "utils/pg_locale.h"
67 #include "utils/plancache.h"
68 #include "utils/portal.h"
69 #include "utils/ps_status.h"
70 #include "utils/tzparser.h"
71 #include "utils/xml.h"
74 #define PG_KRB_SRVTAB ""
77 #define PG_KRB_SRVNAM ""
80 #define CONFIG_FILENAME "postgresql.conf"
81 #define HBA_FILENAME "pg_hba.conf"
82 #define IDENT_FILENAME "pg_ident.conf"
85 #define CONFIG_EXEC_PARAMS "global/config_exec_params"
86 #define CONFIG_EXEC_PARAMS_NEW "global/config_exec_params.new"
89 /* upper limit for GUC variables measured in kilobytes of memory */
91 #define MAX_KILOBYTES INT_MAX
93 #define MAX_KILOBYTES (INT_MAX / 1024)
96 #define KB_PER_MB (1024)
97 #define KB_PER_GB (1024*1024)
101 #define MS_PER_MIN (1000 * 60)
103 #define S_PER_H (60 * 60)
104 #define MS_PER_H (1000 * 60 * 60)
105 #define MIN_PER_D (60 * 24)
106 #define S_PER_D (60 * 60 * 24)
107 #define MS_PER_D (1000 * 60 * 60 * 24)
109 /* XXX these should appear in other modules' header files */
110 extern bool Log_disconnections;
111 extern int CommitDelay;
112 extern int CommitSiblings;
113 extern char *default_tablespace;
114 extern char *temp_tablespaces;
115 extern bool synchronize_seqscans;
116 extern bool fullPageWrites;
119 extern bool trace_sort;
121 #ifdef TRACE_SYNCSCAN
122 extern bool trace_syncscan;
124 #ifdef DEBUG_BOUNDED_SORT
125 extern bool optimize_bounded_sort;
129 extern char *SSLCipherSuites;
132 static void set_config_sourcefile(const char *name, char *sourcefile,
135 static const char *assign_log_destination(const char *value,
136 bool doit, GucSource source);
139 static int syslog_facility = LOG_LOCAL0;
141 static bool assign_syslog_facility(int newval,
142 bool doit, GucSource source);
143 static const char *assign_syslog_ident(const char *ident,
144 bool doit, GucSource source);
147 static bool assign_session_replication_role(int newval, bool doit,
149 static const char *show_num_temp_buffers(void);
150 static bool assign_phony_autocommit(bool newval, bool doit, GucSource source);
151 static const char *assign_custom_variable_classes(const char *newval, bool doit,
153 static bool assign_debug_assertions(bool newval, bool doit, GucSource source);
154 static bool assign_bonjour(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);
172 static const char *assign_application_name(const char *newval, bool doit, GucSource source);
174 static char *config_enum_get_options(struct config_enum * record,
175 const char *prefix, const char *suffix,
176 const char *separator);
180 * Options for enum values defined in this module.
182 * NOTE! Option values may not contain double quotes!
185 static const struct config_enum_entry bytea_output_options[] = {
186 {"escape", BYTEA_OUTPUT_ESCAPE, false},
187 {"hex", BYTEA_OUTPUT_HEX, false},
192 * We have different sets for client and server message level options because
193 * they sort slightly different (see "log" level)
195 static const struct config_enum_entry client_message_level_options[] = {
196 {"debug", DEBUG2, true},
197 {"debug5", DEBUG5, false},
198 {"debug4", DEBUG4, false},
199 {"debug3", DEBUG3, false},
200 {"debug2", DEBUG2, false},
201 {"debug1", DEBUG1, false},
203 {"info", INFO, true},
204 {"notice", NOTICE, false},
205 {"warning", WARNING, false},
206 {"error", ERROR, false},
207 {"fatal", FATAL, true},
208 {"panic", PANIC, true},
212 static const struct config_enum_entry server_message_level_options[] = {
213 {"debug", DEBUG2, true},
214 {"debug5", DEBUG5, false},
215 {"debug4", DEBUG4, false},
216 {"debug3", DEBUG3, false},
217 {"debug2", DEBUG2, false},
218 {"debug1", DEBUG1, false},
219 {"info", INFO, false},
220 {"notice", NOTICE, false},
221 {"warning", WARNING, false},
222 {"error", ERROR, false},
224 {"fatal", FATAL, false},
225 {"panic", PANIC, false},
229 static const struct config_enum_entry intervalstyle_options[] = {
230 {"postgres", INTSTYLE_POSTGRES, false},
231 {"postgres_verbose", INTSTYLE_POSTGRES_VERBOSE, false},
232 {"sql_standard", INTSTYLE_SQL_STANDARD, false},
233 {"iso_8601", INTSTYLE_ISO_8601, false},
237 static const struct config_enum_entry log_error_verbosity_options[] = {
238 {"terse", PGERROR_TERSE, false},
239 {"default", PGERROR_DEFAULT, false},
240 {"verbose", PGERROR_VERBOSE, false},
244 static const struct config_enum_entry log_statement_options[] = {
245 {"none", LOGSTMT_NONE, false},
246 {"ddl", LOGSTMT_DDL, false},
247 {"mod", LOGSTMT_MOD, false},
248 {"all", LOGSTMT_ALL, false},
252 static const struct config_enum_entry isolation_level_options[] = {
253 {"serializable", XACT_SERIALIZABLE, false},
254 {"repeatable read", XACT_REPEATABLE_READ, false},
255 {"read committed", XACT_READ_COMMITTED, false},
256 {"read uncommitted", XACT_READ_UNCOMMITTED, false},
260 static const struct config_enum_entry session_replication_role_options[] = {
261 {"origin", SESSION_REPLICATION_ROLE_ORIGIN, false},
262 {"replica", SESSION_REPLICATION_ROLE_REPLICA, false},
263 {"local", SESSION_REPLICATION_ROLE_LOCAL, false},
268 static const struct config_enum_entry syslog_facility_options[] = {
269 {"local0", LOG_LOCAL0, false},
270 {"local1", LOG_LOCAL1, false},
271 {"local2", LOG_LOCAL2, false},
272 {"local3", LOG_LOCAL3, false},
273 {"local4", LOG_LOCAL4, false},
274 {"local5", LOG_LOCAL5, false},
275 {"local6", LOG_LOCAL6, false},
276 {"local7", LOG_LOCAL7, false},
281 static const struct config_enum_entry track_function_options[] = {
282 {"none", TRACK_FUNC_OFF, false},
283 {"pl", TRACK_FUNC_PL, false},
284 {"all", TRACK_FUNC_ALL, false},
288 static const struct config_enum_entry xmlbinary_options[] = {
289 {"base64", XMLBINARY_BASE64, false},
290 {"hex", XMLBINARY_HEX, false},
294 static const struct config_enum_entry xmloption_options[] = {
295 {"content", XMLOPTION_CONTENT, false},
296 {"document", XMLOPTION_DOCUMENT, false},
301 * Although only "on", "off", and "safe_encoding" are documented, we
302 * accept all the likely variants of "on" and "off".
304 static const struct config_enum_entry backslash_quote_options[] = {
305 {"safe_encoding", BACKSLASH_QUOTE_SAFE_ENCODING, false},
306 {"on", BACKSLASH_QUOTE_ON, false},
307 {"off", BACKSLASH_QUOTE_OFF, false},
308 {"true", BACKSLASH_QUOTE_ON, true},
309 {"false", BACKSLASH_QUOTE_OFF, true},
310 {"yes", BACKSLASH_QUOTE_ON, true},
311 {"no", BACKSLASH_QUOTE_OFF, true},
312 {"1", BACKSLASH_QUOTE_ON, true},
313 {"0", BACKSLASH_QUOTE_OFF, true},
318 * Although only "on", "off", and "partition" are documented, we
319 * accept all the likely variants of "on" and "off".
321 static const struct config_enum_entry constraint_exclusion_options[] = {
322 {"partition", CONSTRAINT_EXCLUSION_PARTITION, false},
323 {"on", CONSTRAINT_EXCLUSION_ON, false},
324 {"off", CONSTRAINT_EXCLUSION_OFF, false},
325 {"true", CONSTRAINT_EXCLUSION_ON, true},
326 {"false", CONSTRAINT_EXCLUSION_OFF, true},
327 {"yes", CONSTRAINT_EXCLUSION_ON, true},
328 {"no", CONSTRAINT_EXCLUSION_OFF, true},
329 {"1", CONSTRAINT_EXCLUSION_ON, true},
330 {"0", CONSTRAINT_EXCLUSION_OFF, true},
335 * Options for enum values stored in other modules
337 extern const struct config_enum_entry sync_method_options[];
340 * GUC option variables that are exported from this module
342 #ifdef USE_ASSERT_CHECKING
343 bool assert_enabled = true;
345 bool assert_enabled = false;
347 bool log_duration = false;
348 bool Debug_print_plan = false;
349 bool Debug_print_parse = false;
350 bool Debug_print_rewritten = false;
351 bool Debug_pretty_print = true;
353 bool log_parser_stats = false;
354 bool log_planner_stats = false;
355 bool log_executor_stats = false;
356 bool log_statement_stats = false; /* this is sort of all three
358 bool log_btree_build_stats = false;
360 bool check_function_bodies = true;
361 bool default_with_oids = false;
362 bool SQL_inheritance = true;
364 bool Password_encryption = true;
366 int log_min_error_statement = ERROR;
367 int log_min_messages = WARNING;
368 int client_min_messages = NOTICE;
369 int log_min_duration_statement = -1;
370 int log_temp_files = -1;
372 int num_temp_buffers = 1000;
374 char *ConfigFileName;
377 char *external_pid_file;
379 char *pgstat_temp_directory;
381 char *default_do_language;
383 char *application_name;
385 int tcp_keepalives_idle;
386 int tcp_keepalives_interval;
387 int tcp_keepalives_count;
390 * These variables are all dummies that don't do anything, except in some
391 * cases provide the value for SHOW to display. The real state is elsewhere
392 * and is kept in sync by assign_hooks.
394 static char *log_destination_string;
397 static char *syslog_ident_str;
399 static bool phony_autocommit;
400 static bool session_auth_is_superuser;
401 static double phony_random_seed;
402 static char *client_encoding_string;
403 static char *datestyle_string;
404 static char *locale_collate;
405 static char *locale_ctype;
406 static char *server_encoding_string;
407 static char *server_version_string;
408 static int server_version_num;
409 static char *timezone_string;
410 static char *log_timezone_string;
411 static char *timezone_abbreviations_string;
412 static char *XactIsoLevel_string;
413 static char *data_directory;
414 static char *custom_variable_classes;
415 static int max_function_args;
416 static int max_index_keys;
417 static int max_identifier_length;
418 static int block_size;
419 static int segment_size;
420 static int wal_block_size;
421 static int wal_segment_size;
422 static bool integer_datetimes;
423 static int effective_io_concurrency;
425 /* should be static, but commands/variable.c needs to get at these */
427 char *session_authorization_string;
431 * Displayable names for context types (enum GucContext)
433 * Note: these strings are deliberately not localized.
435 const char *const GucContext_Names[] =
437 /* PGC_INTERNAL */ "internal",
438 /* PGC_POSTMASTER */ "postmaster",
439 /* PGC_SIGHUP */ "sighup",
440 /* PGC_BACKEND */ "backend",
441 /* PGC_SUSET */ "superuser",
442 /* PGC_USERSET */ "user"
446 * Displayable names for source types (enum GucSource)
448 * Note: these strings are deliberately not localized.
450 const char *const GucSource_Names[] =
452 /* PGC_S_DEFAULT */ "default",
453 /* PGC_S_ENV_VAR */ "environment variable",
454 /* PGC_S_FILE */ "configuration file",
455 /* PGC_S_ARGV */ "command line",
456 /* PGC_S_DATABASE */ "database",
457 /* PGC_S_USER */ "user",
458 /* PGC_S_DATABASE_USER */ "database user",
459 /* PGC_S_CLIENT */ "client",
460 /* PGC_S_OVERRIDE */ "override",
461 /* PGC_S_INTERACTIVE */ "interactive",
462 /* PGC_S_TEST */ "test",
463 /* PGC_S_SESSION */ "session"
467 * Displayable names for the groupings defined in enum config_group
469 const char *const config_group_names[] =
472 gettext_noop("Ungrouped"),
474 gettext_noop("File Locations"),
476 gettext_noop("Connections and Authentication"),
477 /* CONN_AUTH_SETTINGS */
478 gettext_noop("Connections and Authentication / Connection Settings"),
479 /* CONN_AUTH_SECURITY */
480 gettext_noop("Connections and Authentication / Security and Authentication"),
482 gettext_noop("Resource Usage"),
484 gettext_noop("Resource Usage / Memory"),
485 /* RESOURCES_KERNEL */
486 gettext_noop("Resource Usage / Kernel Resources"),
488 gettext_noop("Write-Ahead Log"),
490 gettext_noop("Write-Ahead Log / Settings"),
491 /* WAL_CHECKPOINTS */
492 gettext_noop("Write-Ahead Log / Checkpoints"),
494 gettext_noop("Query Tuning"),
495 /* QUERY_TUNING_METHOD */
496 gettext_noop("Query Tuning / Planner Method Configuration"),
497 /* QUERY_TUNING_COST */
498 gettext_noop("Query Tuning / Planner Cost Constants"),
499 /* QUERY_TUNING_GEQO */
500 gettext_noop("Query Tuning / Genetic Query Optimizer"),
501 /* QUERY_TUNING_OTHER */
502 gettext_noop("Query Tuning / Other Planner Options"),
504 gettext_noop("Reporting and Logging"),
506 gettext_noop("Reporting and Logging / Where to Log"),
508 gettext_noop("Reporting and Logging / When to Log"),
510 gettext_noop("Reporting and Logging / What to Log"),
512 gettext_noop("Statistics"),
513 /* STATS_MONITORING */
514 gettext_noop("Statistics / Monitoring"),
515 /* STATS_COLLECTOR */
516 gettext_noop("Statistics / Query and Index Statistics Collector"),
518 gettext_noop("Autovacuum"),
520 gettext_noop("Client Connection Defaults"),
521 /* CLIENT_CONN_STATEMENT */
522 gettext_noop("Client Connection Defaults / Statement Behavior"),
523 /* CLIENT_CONN_LOCALE */
524 gettext_noop("Client Connection Defaults / Locale and Formatting"),
525 /* CLIENT_CONN_OTHER */
526 gettext_noop("Client Connection Defaults / Other Defaults"),
527 /* LOCK_MANAGEMENT */
528 gettext_noop("Lock Management"),
530 gettext_noop("Version and Platform Compatibility"),
531 /* COMPAT_OPTIONS_PREVIOUS */
532 gettext_noop("Version and Platform Compatibility / Previous PostgreSQL Versions"),
533 /* COMPAT_OPTIONS_CLIENT */
534 gettext_noop("Version and Platform Compatibility / Other Platforms and Clients"),
536 gettext_noop("Preset Options"),
538 gettext_noop("Customized Options"),
539 /* DEVELOPER_OPTIONS */
540 gettext_noop("Developer Options"),
541 /* help_config wants this array to be null-terminated */
546 * Displayable names for GUC variable types (enum config_type)
548 * Note: these strings are deliberately not localized.
550 const char *const config_type_names[] =
552 /* PGC_BOOL */ "bool",
553 /* PGC_INT */ "integer",
554 /* PGC_REAL */ "real",
555 /* PGC_STRING */ "string",
556 /* PGC_ENUM */ "enum"
561 * Contents of GUC tables
563 * See src/backend/utils/misc/README for design notes.
567 * 1. Declare a global variable of type bool, int, double, or char*
568 * and make use of it.
570 * 2. Decide at what times it's safe to set the option. See guc.h for
573 * 3. Decide on a name, a default value, upper and lower bounds (if
576 * 4. Add a record below.
578 * 5. Add it to src/backend/utils/misc/postgresql.conf.sample, if
581 * 6. Don't forget to document the option (at least in config.sgml).
583 * 7. If it's a new GUC_LIST option you must edit pg_dumpall.c to ensure
584 * it is not single quoted at dump time.
588 /******** option records follow ********/
590 static struct config_bool ConfigureNamesBool[] =
593 {"enable_seqscan", PGC_USERSET, QUERY_TUNING_METHOD,
594 gettext_noop("Enables the planner's use of sequential-scan plans."),
601 {"enable_indexscan", PGC_USERSET, QUERY_TUNING_METHOD,
602 gettext_noop("Enables the planner's use of index-scan plans."),
609 {"enable_bitmapscan", PGC_USERSET, QUERY_TUNING_METHOD,
610 gettext_noop("Enables the planner's use of bitmap-scan plans."),
617 {"enable_tidscan", PGC_USERSET, QUERY_TUNING_METHOD,
618 gettext_noop("Enables the planner's use of TID scan plans."),
625 {"enable_sort", PGC_USERSET, QUERY_TUNING_METHOD,
626 gettext_noop("Enables the planner's use of explicit sort steps."),
633 {"enable_hashagg", PGC_USERSET, QUERY_TUNING_METHOD,
634 gettext_noop("Enables the planner's use of hashed aggregation plans."),
641 {"enable_nestloop", PGC_USERSET, QUERY_TUNING_METHOD,
642 gettext_noop("Enables the planner's use of nested-loop join plans."),
649 {"enable_mergejoin", PGC_USERSET, QUERY_TUNING_METHOD,
650 gettext_noop("Enables the planner's use of merge join plans."),
657 {"enable_hashjoin", PGC_USERSET, QUERY_TUNING_METHOD,
658 gettext_noop("Enables the planner's use of hash join plans."),
665 {"geqo", PGC_USERSET, QUERY_TUNING_GEQO,
666 gettext_noop("Enables genetic query optimization."),
667 gettext_noop("This algorithm attempts to do planning without "
668 "exhaustive searching.")
674 /* Not for general use --- used by SET SESSION AUTHORIZATION */
675 {"is_superuser", PGC_INTERNAL, UNGROUPED,
676 gettext_noop("Shows whether the current user is a superuser."),
678 GUC_REPORT | GUC_NO_SHOW_ALL | GUC_NO_RESET_ALL | GUC_NOT_IN_SAMPLE | GUC_DISALLOW_IN_FILE
680 &session_auth_is_superuser,
684 {"bonjour", PGC_POSTMASTER, CONN_AUTH_SETTINGS,
685 gettext_noop("Enables advertising the server via Bonjour."),
689 false, assign_bonjour, NULL
692 {"ssl", PGC_POSTMASTER, CONN_AUTH_SECURITY,
693 gettext_noop("Enables SSL connections."),
697 false, assign_ssl, NULL
700 {"fsync", PGC_SIGHUP, WAL_SETTINGS,
701 gettext_noop("Forces synchronization of updates to disk."),
702 gettext_noop("The server will use the fsync() system call in several places to make "
703 "sure that updates are physically written to disk. This insures "
704 "that a database cluster will recover to a consistent state after "
705 "an operating system or hardware crash.")
711 {"synchronous_commit", PGC_USERSET, WAL_SETTINGS,
712 gettext_noop("Sets immediate fsync at commit."),
719 {"zero_damaged_pages", PGC_SUSET, DEVELOPER_OPTIONS,
720 gettext_noop("Continues processing past damaged page headers."),
721 gettext_noop("Detection of a damaged page header normally causes PostgreSQL to "
722 "report an error, aborting the current transaction. Setting "
723 "zero_damaged_pages to true causes the system to instead report a "
724 "warning, zero out the damaged page, and continue processing. This "
725 "behavior will destroy data, namely all the rows on the damaged page."),
732 {"full_page_writes", PGC_SIGHUP, WAL_SETTINGS,
733 gettext_noop("Writes full pages to WAL when first modified after a checkpoint."),
734 gettext_noop("A page write in process during an operating system crash might be "
735 "only partially written to disk. During recovery, the row changes "
736 "stored in WAL are not enough to recover. This option writes "
737 "pages when first modified after a checkpoint to WAL so full recovery "
744 {"silent_mode", PGC_POSTMASTER, LOGGING_WHERE,
745 gettext_noop("Runs the server silently."),
746 gettext_noop("If this parameter is set, the server will automatically run in the "
747 "background and any controlling terminals are dissociated.")
753 {"log_checkpoints", PGC_SIGHUP, LOGGING_WHAT,
754 gettext_noop("Logs each checkpoint."),
761 {"log_connections", PGC_BACKEND, LOGGING_WHAT,
762 gettext_noop("Logs each successful connection."),
769 {"log_disconnections", PGC_BACKEND, LOGGING_WHAT,
770 gettext_noop("Logs end of a session, including duration."),
777 {"debug_assertions", PGC_USERSET, DEVELOPER_OPTIONS,
778 gettext_noop("Turns on various assertion checks."),
779 gettext_noop("This is a debugging aid."),
783 #ifdef USE_ASSERT_CHECKING
788 assign_debug_assertions, NULL
791 /* currently undocumented, so don't show in SHOW ALL */
792 {"exit_on_error", PGC_USERSET, UNGROUPED,
793 gettext_noop("No description available."),
795 GUC_NO_SHOW_ALL | GUC_NOT_IN_SAMPLE
801 {"log_duration", PGC_SUSET, LOGGING_WHAT,
802 gettext_noop("Logs the duration of each completed SQL statement."),
809 {"debug_print_parse", PGC_USERSET, LOGGING_WHAT,
810 gettext_noop("Logs each query's parse tree."),
817 {"debug_print_rewritten", PGC_USERSET, LOGGING_WHAT,
818 gettext_noop("Logs each query's rewritten parse tree."),
821 &Debug_print_rewritten,
825 {"debug_print_plan", PGC_USERSET, LOGGING_WHAT,
826 gettext_noop("Logs each query's execution plan."),
833 {"debug_pretty_print", PGC_USERSET, LOGGING_WHAT,
834 gettext_noop("Indents parse and plan tree displays."),
841 {"log_parser_stats", PGC_SUSET, STATS_MONITORING,
842 gettext_noop("Writes parser performance statistics to the server log."),
846 false, assign_stage_log_stats, NULL
849 {"log_planner_stats", PGC_SUSET, STATS_MONITORING,
850 gettext_noop("Writes planner performance statistics to the server log."),
854 false, assign_stage_log_stats, NULL
857 {"log_executor_stats", PGC_SUSET, STATS_MONITORING,
858 gettext_noop("Writes executor performance statistics to the server log."),
862 false, assign_stage_log_stats, NULL
865 {"log_statement_stats", PGC_SUSET, STATS_MONITORING,
866 gettext_noop("Writes cumulative performance statistics to the server log."),
869 &log_statement_stats,
870 false, assign_log_stats, NULL
872 #ifdef BTREE_BUILD_STATS
874 {"log_btree_build_stats", PGC_SUSET, DEVELOPER_OPTIONS,
875 gettext_noop("No description available."),
879 &log_btree_build_stats,
885 {"track_activities", PGC_SUSET, STATS_COLLECTOR,
886 gettext_noop("Collects information about executing commands."),
887 gettext_noop("Enables the collection of information on the currently "
888 "executing command of each session, along with "
889 "the time at which that command began execution.")
891 &pgstat_track_activities,
895 {"track_counts", PGC_SUSET, STATS_COLLECTOR,
896 gettext_noop("Collects statistics on database activity."),
899 &pgstat_track_counts,
904 {"update_process_title", PGC_SUSET, STATS_COLLECTOR,
905 gettext_noop("Updates the process title to show the active SQL command."),
906 gettext_noop("Enables updating of the process title every time a new SQL command is received by the server.")
908 &update_process_title,
913 {"autovacuum", PGC_SIGHUP, AUTOVACUUM,
914 gettext_noop("Starts the autovacuum subprocess."),
917 &autovacuum_start_daemon,
922 {"trace_notify", PGC_USERSET, DEVELOPER_OPTIONS,
923 gettext_noop("Generates debugging output for LISTEN and NOTIFY."),
933 {"trace_locks", PGC_SUSET, DEVELOPER_OPTIONS,
934 gettext_noop("No description available."),
942 {"trace_userlocks", PGC_SUSET, DEVELOPER_OPTIONS,
943 gettext_noop("No description available."),
951 {"trace_lwlocks", PGC_SUSET, DEVELOPER_OPTIONS,
952 gettext_noop("No description available."),
960 {"debug_deadlocks", PGC_SUSET, DEVELOPER_OPTIONS,
961 gettext_noop("No description available."),
971 {"log_lock_waits", PGC_SUSET, LOGGING_WHAT,
972 gettext_noop("Logs long lock waits."),
980 {"log_hostname", PGC_SIGHUP, LOGGING_WHAT,
981 gettext_noop("Logs the host name in the connection logs."),
982 gettext_noop("By default, connection logs only show the IP address "
983 "of the connecting host. If you want them to show the host name you "
984 "can turn this on, but depending on your host name resolution "
985 "setup it might impose a non-negligible performance penalty.")
991 {"sql_inheritance", PGC_USERSET, COMPAT_OPTIONS_PREVIOUS,
992 gettext_noop("Causes subtables to be included by default in various commands."),
999 {"password_encryption", PGC_USERSET, CONN_AUTH_SECURITY,
1000 gettext_noop("Encrypt passwords."),
1001 gettext_noop("When a password is specified in CREATE USER or "
1002 "ALTER USER without writing either ENCRYPTED or UNENCRYPTED, "
1003 "this parameter determines whether the password is to be encrypted.")
1005 &Password_encryption,
1009 {"transform_null_equals", PGC_USERSET, COMPAT_OPTIONS_CLIENT,
1010 gettext_noop("Treats \"expr=NULL\" as \"expr IS NULL\"."),
1011 gettext_noop("When turned on, expressions of the form expr = NULL "
1012 "(or NULL = expr) are treated as expr IS NULL, that is, they "
1013 "return true if expr evaluates to the null value, and false "
1014 "otherwise. The correct behavior of expr = NULL is to always "
1015 "return null (unknown).")
1017 &Transform_null_equals,
1021 {"db_user_namespace", PGC_SIGHUP, CONN_AUTH_SECURITY,
1022 gettext_noop("Enables per-database user names."),
1029 /* only here for backwards compatibility */
1030 {"autocommit", PGC_USERSET, CLIENT_CONN_STATEMENT,
1031 gettext_noop("This parameter doesn't do anything."),
1032 gettext_noop("It's just here so that we won't choke on SET AUTOCOMMIT TO ON from 7.3-vintage clients."),
1033 GUC_NO_SHOW_ALL | GUC_NOT_IN_SAMPLE
1036 true, assign_phony_autocommit, NULL
1039 {"default_transaction_read_only", PGC_USERSET, CLIENT_CONN_STATEMENT,
1040 gettext_noop("Sets the default read-only status of new transactions."),
1043 &DefaultXactReadOnly,
1047 {"transaction_read_only", PGC_USERSET, CLIENT_CONN_STATEMENT,
1048 gettext_noop("Sets the current transaction's read-only status."),
1050 GUC_NO_RESET_ALL | GUC_NOT_IN_SAMPLE | GUC_DISALLOW_IN_FILE
1053 false, assign_transaction_read_only, NULL
1056 {"check_function_bodies", PGC_USERSET, CLIENT_CONN_STATEMENT,
1057 gettext_noop("Check function bodies during CREATE FUNCTION."),
1060 &check_function_bodies,
1064 {"array_nulls", PGC_USERSET, COMPAT_OPTIONS_PREVIOUS,
1065 gettext_noop("Enable input of NULL elements in arrays."),
1066 gettext_noop("When turned on, unquoted NULL in an array input "
1067 "value means a null value; "
1068 "otherwise it is taken literally.")
1074 {"default_with_oids", PGC_USERSET, COMPAT_OPTIONS_PREVIOUS,
1075 gettext_noop("Create new tables with OIDs by default."),
1082 {"logging_collector", PGC_POSTMASTER, LOGGING_WHERE,
1083 gettext_noop("Start a subprocess to capture stderr output and/or csvlogs into log files."),
1090 {"log_truncate_on_rotation", PGC_SIGHUP, LOGGING_WHERE,
1091 gettext_noop("Truncate existing log files of same name during log rotation."),
1094 &Log_truncate_on_rotation,
1100 {"trace_sort", PGC_USERSET, DEVELOPER_OPTIONS,
1101 gettext_noop("Emit information about resource usage in sorting."),
1110 #ifdef TRACE_SYNCSCAN
1111 /* this is undocumented because not exposed in a standard build */
1113 {"trace_syncscan", PGC_USERSET, DEVELOPER_OPTIONS,
1114 gettext_noop("Generate debugging output for synchronized scanning."),
1123 #ifdef DEBUG_BOUNDED_SORT
1124 /* this is undocumented because not exposed in a standard build */
1127 "optimize_bounded_sort", PGC_USERSET, QUERY_TUNING_METHOD,
1128 gettext_noop("Enable bounded sorting using heap sort."),
1132 &optimize_bounded_sort,
1139 {"wal_debug", PGC_SUSET, DEVELOPER_OPTIONS,
1140 gettext_noop("Emit WAL-related debugging output."),
1150 {"integer_datetimes", PGC_INTERNAL, PRESET_OPTIONS,
1151 gettext_noop("Datetimes are integer based."),
1153 GUC_REPORT | GUC_NOT_IN_SAMPLE | GUC_DISALLOW_IN_FILE
1156 #ifdef HAVE_INT64_TIMESTAMP
1164 {"krb_caseins_users", PGC_SIGHUP, CONN_AUTH_SECURITY,
1165 gettext_noop("Sets whether Kerberos and GSSAPI user names should be treated as case-insensitive."),
1168 &pg_krb_caseins_users,
1173 {"escape_string_warning", PGC_USERSET, COMPAT_OPTIONS_PREVIOUS,
1174 gettext_noop("Warn about backslash escapes in ordinary string literals."),
1177 &escape_string_warning,
1182 {"standard_conforming_strings", PGC_USERSET, COMPAT_OPTIONS_PREVIOUS,
1183 gettext_noop("Causes '...' strings to treat backslashes literally."),
1187 &standard_conforming_strings,
1192 {"synchronize_seqscans", PGC_USERSET, COMPAT_OPTIONS_PREVIOUS,
1193 gettext_noop("Enable synchronized sequential scans."),
1196 &synchronize_seqscans,
1201 {"archive_mode", PGC_POSTMASTER, WAL_SETTINGS,
1202 gettext_noop("Allows archiving of WAL files using archive_command."),
1210 {"allow_system_table_mods", PGC_POSTMASTER, DEVELOPER_OPTIONS,
1211 gettext_noop("Allows modifications of the structure of system tables."),
1215 &allowSystemTableMods,
1220 {"ignore_system_indexes", PGC_BACKEND, DEVELOPER_OPTIONS,
1221 gettext_noop("Disables reading from system indexes."),
1222 gettext_noop("It does not prevent updating the indexes, so it is safe "
1223 "to use. The worst consequence is slowness."),
1226 &IgnoreSystemIndexes,
1231 {"lo_compat_privileges", PGC_SUSET, COMPAT_OPTIONS_PREVIOUS,
1232 gettext_noop("Enables backward compatibility in privilege checks on large objects"),
1233 gettext_noop("When turned on, privilege checks on large objects perform "
1234 "with backward compatibility as 8.4.x or earlier releases.")
1236 &lo_compat_privileges,
1240 /* End-of-list marker */
1242 {NULL, 0, 0, NULL, NULL}, NULL, false, NULL, NULL
1247 static struct config_int ConfigureNamesInt[] =
1250 {"archive_timeout", PGC_SIGHUP, WAL_SETTINGS,
1251 gettext_noop("Forces a switch to the next xlog file if a "
1252 "new file has not been started within N seconds."),
1256 &XLogArchiveTimeout,
1257 0, 0, INT_MAX, NULL, NULL
1260 {"post_auth_delay", PGC_BACKEND, DEVELOPER_OPTIONS,
1261 gettext_noop("Waits N seconds on connection startup after authentication."),
1262 gettext_noop("This allows attaching a debugger to the process."),
1263 GUC_NOT_IN_SAMPLE | GUC_UNIT_S
1266 0, 0, INT_MAX, NULL, NULL
1269 {"default_statistics_target", PGC_USERSET, QUERY_TUNING_OTHER,
1270 gettext_noop("Sets the default statistics target."),
1271 gettext_noop("This applies to table columns that have not had a "
1272 "column-specific target set via ALTER TABLE SET STATISTICS.")
1274 &default_statistics_target,
1275 100, 1, 10000, NULL, NULL
1278 {"from_collapse_limit", PGC_USERSET, QUERY_TUNING_OTHER,
1279 gettext_noop("Sets the FROM-list size beyond which subqueries "
1280 "are not collapsed."),
1281 gettext_noop("The planner will merge subqueries into upper "
1282 "queries if the resulting FROM list would have no more than "
1285 &from_collapse_limit,
1286 8, 1, INT_MAX, NULL, NULL
1289 {"join_collapse_limit", PGC_USERSET, QUERY_TUNING_OTHER,
1290 gettext_noop("Sets the FROM-list size beyond which JOIN "
1291 "constructs are not flattened."),
1292 gettext_noop("The planner will flatten explicit JOIN "
1293 "constructs into lists of FROM items whenever a "
1294 "list of no more than this many items would result.")
1296 &join_collapse_limit,
1297 8, 1, INT_MAX, NULL, NULL
1300 {"geqo_threshold", PGC_USERSET, QUERY_TUNING_GEQO,
1301 gettext_noop("Sets the threshold of FROM items beyond which GEQO is used."),
1305 12, 2, INT_MAX, NULL, NULL
1308 {"geqo_effort", PGC_USERSET, QUERY_TUNING_GEQO,
1309 gettext_noop("GEQO: effort is used to set the default for other GEQO parameters."),
1313 DEFAULT_GEQO_EFFORT, MIN_GEQO_EFFORT, MAX_GEQO_EFFORT, NULL, NULL
1316 {"geqo_pool_size", PGC_USERSET, QUERY_TUNING_GEQO,
1317 gettext_noop("GEQO: number of individuals in the population."),
1318 gettext_noop("Zero selects a suitable default value.")
1321 0, 0, INT_MAX, NULL, NULL
1324 {"geqo_generations", PGC_USERSET, QUERY_TUNING_GEQO,
1325 gettext_noop("GEQO: number of iterations of the algorithm."),
1326 gettext_noop("Zero selects a suitable default value.")
1329 0, 0, INT_MAX, NULL, NULL
1333 /* This is PGC_SIGHUP so all backends have the same value. */
1334 {"deadlock_timeout", PGC_SIGHUP, LOCK_MANAGEMENT,
1335 gettext_noop("Sets the time to wait on a lock before checking for deadlock."),
1340 1000, 1, INT_MAX / 1000, NULL, NULL
1344 * Note: MaxBackends is limited to INT_MAX/4 because some places compute
1345 * 4*MaxBackends without any overflow check. This check is made in
1346 * assign_maxconnections, since MaxBackends is computed as MaxConnections
1347 * plus autovacuum_max_workers plus one (for the autovacuum launcher).
1349 * Likewise we have to limit NBuffers to INT_MAX/2.
1352 {"max_connections", PGC_POSTMASTER, CONN_AUTH_SETTINGS,
1353 gettext_noop("Sets the maximum number of concurrent connections."),
1357 100, 1, INT_MAX / 4, assign_maxconnections, NULL
1361 {"superuser_reserved_connections", PGC_POSTMASTER, CONN_AUTH_SETTINGS,
1362 gettext_noop("Sets the number of connection slots reserved for superusers."),
1366 3, 0, INT_MAX / 4, NULL, NULL
1370 {"shared_buffers", PGC_POSTMASTER, RESOURCES_MEM,
1371 gettext_noop("Sets the number of shared memory buffers used by the server."),
1376 1024, 16, INT_MAX / 2, NULL, NULL
1380 {"temp_buffers", PGC_USERSET, RESOURCES_MEM,
1381 gettext_noop("Sets the maximum number of temporary buffers used by each session."),
1386 1024, 100, INT_MAX / 2, NULL, show_num_temp_buffers
1390 {"port", PGC_POSTMASTER, CONN_AUTH_SETTINGS,
1391 gettext_noop("Sets the TCP port the server listens on."),
1395 DEF_PGPORT, 1, 65535, NULL, NULL
1399 {"unix_socket_permissions", PGC_POSTMASTER, CONN_AUTH_SETTINGS,
1400 gettext_noop("Sets the access permissions of the Unix-domain socket."),
1401 gettext_noop("Unix-domain sockets use the usual Unix file system "
1402 "permission set. The parameter value is expected to be a numeric mode "
1403 "specification in the form accepted by the chmod and umask system "
1404 "calls. (To use the customary octal format the number must start with "
1407 &Unix_socket_permissions,
1408 0777, 0000, 0777, NULL, NULL
1412 {"work_mem", PGC_USERSET, RESOURCES_MEM,
1413 gettext_noop("Sets the maximum memory to be used for query workspaces."),
1414 gettext_noop("This much memory can be used by each internal "
1415 "sort operation and hash table before switching to "
1416 "temporary disk files."),
1420 1024, 64, MAX_KILOBYTES, NULL, NULL
1424 {"maintenance_work_mem", PGC_USERSET, RESOURCES_MEM,
1425 gettext_noop("Sets the maximum memory to be used for maintenance operations."),
1426 gettext_noop("This includes operations such as VACUUM and CREATE INDEX."),
1429 &maintenance_work_mem,
1430 16384, 1024, MAX_KILOBYTES, NULL, NULL
1434 {"max_stack_depth", PGC_SUSET, RESOURCES_MEM,
1435 gettext_noop("Sets the maximum stack depth, in kilobytes."),
1440 100, 100, MAX_KILOBYTES, assign_max_stack_depth, NULL
1444 {"vacuum_cost_page_hit", PGC_USERSET, RESOURCES,
1445 gettext_noop("Vacuum cost for a page found in the buffer cache."),
1449 1, 0, 10000, NULL, NULL
1453 {"vacuum_cost_page_miss", PGC_USERSET, RESOURCES,
1454 gettext_noop("Vacuum cost for a page not found in the buffer cache."),
1457 &VacuumCostPageMiss,
1458 10, 0, 10000, NULL, NULL
1462 {"vacuum_cost_page_dirty", PGC_USERSET, RESOURCES,
1463 gettext_noop("Vacuum cost for a page dirtied by vacuum."),
1466 &VacuumCostPageDirty,
1467 20, 0, 10000, NULL, NULL
1471 {"vacuum_cost_limit", PGC_USERSET, RESOURCES,
1472 gettext_noop("Vacuum cost amount available before napping."),
1476 200, 1, 10000, NULL, NULL
1480 {"vacuum_cost_delay", PGC_USERSET, RESOURCES,
1481 gettext_noop("Vacuum cost delay in milliseconds."),
1486 0, 0, 100, NULL, NULL
1490 {"autovacuum_vacuum_cost_delay", PGC_SIGHUP, AUTOVACUUM,
1491 gettext_noop("Vacuum cost delay in milliseconds, for autovacuum."),
1495 &autovacuum_vac_cost_delay,
1496 20, -1, 100, NULL, NULL
1500 {"autovacuum_vacuum_cost_limit", PGC_SIGHUP, AUTOVACUUM,
1501 gettext_noop("Vacuum cost amount available before napping, for autovacuum."),
1504 &autovacuum_vac_cost_limit,
1505 -1, -1, 10000, NULL, NULL
1509 {"max_files_per_process", PGC_POSTMASTER, RESOURCES_KERNEL,
1510 gettext_noop("Sets the maximum number of simultaneously open files for each server process."),
1513 &max_files_per_process,
1514 1000, 25, INT_MAX, NULL, NULL
1518 {"max_prepared_transactions", PGC_POSTMASTER, RESOURCES,
1519 gettext_noop("Sets the maximum number of simultaneously prepared transactions."),
1522 &max_prepared_xacts,
1523 0, 0, INT_MAX / 4, NULL, NULL
1528 {"trace_lock_oidmin", PGC_SUSET, DEVELOPER_OPTIONS,
1529 gettext_noop("No description available."),
1534 FirstNormalObjectId, 0, INT_MAX, NULL, NULL
1537 {"trace_lock_table", PGC_SUSET, DEVELOPER_OPTIONS,
1538 gettext_noop("No description available."),
1543 0, 0, INT_MAX, NULL, NULL
1548 {"statement_timeout", PGC_USERSET, CLIENT_CONN_STATEMENT,
1549 gettext_noop("Sets the maximum allowed duration of any statement."),
1550 gettext_noop("A value of 0 turns off the timeout."),
1554 0, 0, INT_MAX, NULL, NULL
1558 {"vacuum_freeze_min_age", PGC_USERSET, CLIENT_CONN_STATEMENT,
1559 gettext_noop("Minimum age at which VACUUM should freeze a table row."),
1562 &vacuum_freeze_min_age,
1563 50000000, 0, 1000000000, NULL, NULL
1567 {"vacuum_freeze_table_age", PGC_USERSET, CLIENT_CONN_STATEMENT,
1568 gettext_noop("Age at which VACUUM should scan whole table to freeze tuples."),
1571 &vacuum_freeze_table_age,
1572 150000000, 0, 2000000000, NULL, NULL
1576 {"max_locks_per_transaction", PGC_POSTMASTER, LOCK_MANAGEMENT,
1577 gettext_noop("Sets the maximum number of locks per transaction."),
1578 gettext_noop("The shared lock table is sized on the assumption that "
1579 "at most max_locks_per_transaction * max_connections distinct "
1580 "objects will need to be locked at any one time.")
1582 &max_locks_per_xact,
1583 64, 10, INT_MAX, NULL, NULL
1587 {"authentication_timeout", PGC_SIGHUP, CONN_AUTH_SECURITY,
1588 gettext_noop("Sets the maximum allowed time to complete client authentication."),
1592 &AuthenticationTimeout,
1593 60, 1, 600, NULL, NULL
1597 /* Not for general use */
1598 {"pre_auth_delay", PGC_SIGHUP, DEVELOPER_OPTIONS,
1599 gettext_noop("Waits N seconds on connection startup before authentication."),
1600 gettext_noop("This allows attaching a debugger to the process."),
1601 GUC_NOT_IN_SAMPLE | GUC_UNIT_S
1604 0, 0, 60, NULL, NULL
1608 {"checkpoint_segments", PGC_SIGHUP, WAL_CHECKPOINTS,
1609 gettext_noop("Sets the maximum distance in log segments between automatic WAL checkpoints."),
1612 &CheckPointSegments,
1613 3, 1, INT_MAX, NULL, NULL
1617 {"checkpoint_timeout", PGC_SIGHUP, WAL_CHECKPOINTS,
1618 gettext_noop("Sets the maximum time between automatic WAL checkpoints."),
1623 300, 30, 3600, NULL, NULL
1627 {"checkpoint_warning", PGC_SIGHUP, WAL_CHECKPOINTS,
1628 gettext_noop("Enables warnings if checkpoint segments are filled more "
1629 "frequently than this."),
1630 gettext_noop("Write a message to the server log if checkpoints "
1631 "caused by the filling of checkpoint segment files happens more "
1632 "frequently than this number of seconds. Zero turns off the warning."),
1636 30, 0, INT_MAX, NULL, NULL
1640 {"wal_buffers", PGC_POSTMASTER, WAL_SETTINGS,
1641 gettext_noop("Sets the number of disk-page buffers in shared memory for WAL."),
1646 8, 4, INT_MAX, NULL, NULL
1650 {"wal_writer_delay", PGC_SIGHUP, WAL_SETTINGS,
1651 gettext_noop("WAL writer sleep time between WAL flushes."),
1656 200, 1, 10000, NULL, NULL
1660 {"commit_delay", PGC_USERSET, WAL_SETTINGS,
1661 gettext_noop("Sets the delay in microseconds between transaction commit and "
1662 "flushing WAL to disk."),
1666 0, 0, 100000, NULL, NULL
1670 {"commit_siblings", PGC_USERSET, WAL_SETTINGS,
1671 gettext_noop("Sets the minimum concurrent open transactions before performing "
1676 5, 1, 1000, NULL, NULL
1680 {"extra_float_digits", PGC_USERSET, CLIENT_CONN_LOCALE,
1681 gettext_noop("Sets the number of digits displayed for floating-point values."),
1682 gettext_noop("This affects real, double precision, and geometric data types. "
1683 "The parameter value is added to the standard number of digits "
1684 "(FLT_DIG or DBL_DIG as appropriate).")
1686 &extra_float_digits,
1687 0, -15, 3, NULL, NULL
1691 {"log_min_duration_statement", PGC_SUSET, LOGGING_WHEN,
1692 gettext_noop("Sets the minimum execution time above which "
1693 "statements will be logged."),
1694 gettext_noop("Zero prints all queries. -1 turns this feature off."),
1697 &log_min_duration_statement,
1698 -1, -1, INT_MAX / 1000, NULL, NULL
1702 {"log_autovacuum_min_duration", PGC_SIGHUP, LOGGING_WHAT,
1703 gettext_noop("Sets the minimum execution time above which "
1704 "autovacuum actions will be logged."),
1705 gettext_noop("Zero prints all actions. -1 turns autovacuum logging off."),
1708 &Log_autovacuum_min_duration,
1709 -1, -1, INT_MAX / 1000, NULL, NULL
1713 {"bgwriter_delay", PGC_SIGHUP, RESOURCES,
1714 gettext_noop("Background writer sleep time between rounds."),
1719 200, 10, 10000, NULL, NULL
1723 {"bgwriter_lru_maxpages", PGC_SIGHUP, RESOURCES,
1724 gettext_noop("Background writer maximum number of LRU pages to flush per round."),
1727 &bgwriter_lru_maxpages,
1728 100, 0, 1000, NULL, NULL
1732 {"effective_io_concurrency",
1739 gettext_noop("Number of simultaneous requests that can be handled efficiently by the disk subsystem."),
1740 gettext_noop("For RAID arrays, this should be approximately the number of drive spindles in the array.")
1742 &effective_io_concurrency,
1748 assign_effective_io_concurrency, NULL
1752 {"log_rotation_age", PGC_SIGHUP, LOGGING_WHERE,
1753 gettext_noop("Automatic log file rotation will occur after N minutes."),
1758 HOURS_PER_DAY * MINS_PER_HOUR, 0, INT_MAX / MINS_PER_HOUR, NULL, NULL
1762 {"log_rotation_size", PGC_SIGHUP, LOGGING_WHERE,
1763 gettext_noop("Automatic log file rotation will occur after N kilobytes."),
1768 10 * 1024, 0, INT_MAX / 1024, NULL, NULL
1772 {"max_function_args", PGC_INTERNAL, PRESET_OPTIONS,
1773 gettext_noop("Shows the maximum number of function arguments."),
1775 GUC_NOT_IN_SAMPLE | GUC_DISALLOW_IN_FILE
1778 FUNC_MAX_ARGS, FUNC_MAX_ARGS, FUNC_MAX_ARGS, NULL, NULL
1782 {"max_index_keys", PGC_INTERNAL, PRESET_OPTIONS,
1783 gettext_noop("Shows the maximum number of index keys."),
1785 GUC_NOT_IN_SAMPLE | GUC_DISALLOW_IN_FILE
1788 INDEX_MAX_KEYS, INDEX_MAX_KEYS, INDEX_MAX_KEYS, NULL, NULL
1792 {"max_identifier_length", PGC_INTERNAL, PRESET_OPTIONS,
1793 gettext_noop("Shows the maximum identifier length."),
1795 GUC_NOT_IN_SAMPLE | GUC_DISALLOW_IN_FILE
1797 &max_identifier_length,
1798 NAMEDATALEN - 1, NAMEDATALEN - 1, NAMEDATALEN - 1, NULL, NULL
1802 {"block_size", PGC_INTERNAL, PRESET_OPTIONS,
1803 gettext_noop("Shows the size of a disk block."),
1805 GUC_NOT_IN_SAMPLE | GUC_DISALLOW_IN_FILE
1808 BLCKSZ, BLCKSZ, BLCKSZ, NULL, NULL
1812 {"segment_size", PGC_INTERNAL, PRESET_OPTIONS,
1813 gettext_noop("Shows the number of pages per disk file."),
1815 GUC_UNIT_BLOCKS | GUC_NOT_IN_SAMPLE | GUC_DISALLOW_IN_FILE
1818 RELSEG_SIZE, RELSEG_SIZE, RELSEG_SIZE, NULL, NULL
1822 {"wal_block_size", PGC_INTERNAL, PRESET_OPTIONS,
1823 gettext_noop("Shows the block size in the write ahead log."),
1825 GUC_NOT_IN_SAMPLE | GUC_DISALLOW_IN_FILE
1828 XLOG_BLCKSZ, XLOG_BLCKSZ, XLOG_BLCKSZ, NULL, NULL
1832 {"wal_segment_size", PGC_INTERNAL, PRESET_OPTIONS,
1833 gettext_noop("Shows the number of pages per write ahead log segment."),
1835 GUC_UNIT_XBLOCKS | GUC_NOT_IN_SAMPLE | GUC_DISALLOW_IN_FILE
1838 (XLOG_SEG_SIZE / XLOG_BLCKSZ),
1839 (XLOG_SEG_SIZE / XLOG_BLCKSZ),
1840 (XLOG_SEG_SIZE / XLOG_BLCKSZ),
1845 {"autovacuum_naptime", PGC_SIGHUP, AUTOVACUUM,
1846 gettext_noop("Time to sleep between autovacuum runs."),
1850 &autovacuum_naptime,
1851 60, 1, INT_MAX / 1000, NULL, NULL
1854 {"autovacuum_vacuum_threshold", PGC_SIGHUP, AUTOVACUUM,
1855 gettext_noop("Minimum number of tuple updates or deletes prior to vacuum."),
1858 &autovacuum_vac_thresh,
1859 50, 0, INT_MAX, NULL, NULL
1862 {"autovacuum_analyze_threshold", PGC_SIGHUP, AUTOVACUUM,
1863 gettext_noop("Minimum number of tuple inserts, updates or deletes prior to analyze."),
1866 &autovacuum_anl_thresh,
1867 50, 0, INT_MAX, NULL, NULL
1870 /* see varsup.c for why this is PGC_POSTMASTER not PGC_SIGHUP */
1871 {"autovacuum_freeze_max_age", PGC_POSTMASTER, AUTOVACUUM,
1872 gettext_noop("Age at which to autovacuum a table to prevent transaction ID wraparound."),
1875 &autovacuum_freeze_max_age,
1876 /* see pg_resetxlog if you change the upper-limit value */
1877 200000000, 100000000, 2000000000, NULL, NULL
1880 /* see max_connections */
1881 {"autovacuum_max_workers", PGC_POSTMASTER, AUTOVACUUM,
1882 gettext_noop("Sets the maximum number of simultaneously running autovacuum worker processes."),
1885 &autovacuum_max_workers,
1886 3, 1, INT_MAX / 4, assign_autovacuum_max_workers, NULL
1890 {"tcp_keepalives_idle", PGC_USERSET, CLIENT_CONN_OTHER,
1891 gettext_noop("Time between issuing TCP keepalives."),
1892 gettext_noop("A value of 0 uses the system default."),
1895 &tcp_keepalives_idle,
1896 0, 0, INT_MAX, assign_tcp_keepalives_idle, show_tcp_keepalives_idle
1900 {"tcp_keepalives_interval", PGC_USERSET, CLIENT_CONN_OTHER,
1901 gettext_noop("Time between TCP keepalive retransmits."),
1902 gettext_noop("A value of 0 uses the system default."),
1905 &tcp_keepalives_interval,
1906 0, 0, INT_MAX, assign_tcp_keepalives_interval, show_tcp_keepalives_interval
1910 {"tcp_keepalives_count", PGC_USERSET, CLIENT_CONN_OTHER,
1911 gettext_noop("Maximum number of TCP keepalive retransmits."),
1912 gettext_noop("This controls the number of consecutive keepalive retransmits that can be "
1913 "lost before a connection is considered dead. A value of 0 uses the "
1916 &tcp_keepalives_count,
1917 0, 0, INT_MAX, assign_tcp_keepalives_count, show_tcp_keepalives_count
1921 {"gin_fuzzy_search_limit", PGC_USERSET, CLIENT_CONN_OTHER,
1922 gettext_noop("Sets the maximum allowed result for exact search by GIN."),
1926 &GinFuzzySearchLimit,
1927 0, 0, INT_MAX, NULL, NULL
1931 {"effective_cache_size", PGC_USERSET, QUERY_TUNING_COST,
1932 gettext_noop("Sets the planner's assumption about the size of the disk cache."),
1933 gettext_noop("That is, the portion of the kernel's disk cache that "
1934 "will be used for PostgreSQL data files. This is measured in disk "
1935 "pages, which are normally 8 kB each."),
1938 &effective_cache_size,
1939 DEFAULT_EFFECTIVE_CACHE_SIZE, 1, INT_MAX, NULL, NULL
1943 /* Can't be set in postgresql.conf */
1944 {"server_version_num", PGC_INTERNAL, PRESET_OPTIONS,
1945 gettext_noop("Shows the server version as an integer."),
1947 GUC_NOT_IN_SAMPLE | GUC_DISALLOW_IN_FILE
1949 &server_version_num,
1950 PG_VERSION_NUM, PG_VERSION_NUM, PG_VERSION_NUM, NULL, NULL
1954 {"log_temp_files", PGC_SUSET, LOGGING_WHAT,
1955 gettext_noop("Log the use of temporary files larger than this number of kilobytes."),
1956 gettext_noop("Zero logs all files. The default is -1 (turning this feature off)."),
1960 -1, -1, INT_MAX, NULL, NULL
1964 {"track_activity_query_size", PGC_POSTMASTER, RESOURCES_MEM,
1965 gettext_noop("Sets the size reserved for pg_stat_activity.current_query, in bytes."),
1968 &pgstat_track_activity_query_size,
1969 1024, 100, 102400, NULL, NULL
1972 /* End-of-list marker */
1974 {NULL, 0, 0, NULL, NULL}, NULL, 0, 0, 0, NULL, NULL
1979 static struct config_real ConfigureNamesReal[] =
1982 {"seq_page_cost", PGC_USERSET, QUERY_TUNING_COST,
1983 gettext_noop("Sets the planner's estimate of the cost of a "
1984 "sequentially fetched disk page."),
1988 DEFAULT_SEQ_PAGE_COST, 0, DBL_MAX, NULL, NULL
1991 {"random_page_cost", PGC_USERSET, QUERY_TUNING_COST,
1992 gettext_noop("Sets the planner's estimate of the cost of a "
1993 "nonsequentially fetched disk page."),
1997 DEFAULT_RANDOM_PAGE_COST, 0, DBL_MAX, NULL, NULL
2000 {"cpu_tuple_cost", PGC_USERSET, QUERY_TUNING_COST,
2001 gettext_noop("Sets the planner's estimate of the cost of "
2002 "processing each tuple (row)."),
2006 DEFAULT_CPU_TUPLE_COST, 0, DBL_MAX, NULL, NULL
2009 {"cpu_index_tuple_cost", PGC_USERSET, QUERY_TUNING_COST,
2010 gettext_noop("Sets the planner's estimate of the cost of "
2011 "processing each index entry during an index scan."),
2014 &cpu_index_tuple_cost,
2015 DEFAULT_CPU_INDEX_TUPLE_COST, 0, DBL_MAX, NULL, NULL
2018 {"cpu_operator_cost", PGC_USERSET, QUERY_TUNING_COST,
2019 gettext_noop("Sets the planner's estimate of the cost of "
2020 "processing each operator or function call."),
2024 DEFAULT_CPU_OPERATOR_COST, 0, DBL_MAX, NULL, NULL
2028 {"cursor_tuple_fraction", PGC_USERSET, QUERY_TUNING_OTHER,
2029 gettext_noop("Sets the planner's estimate of the fraction of "
2030 "a cursor's rows that will be retrieved."),
2033 &cursor_tuple_fraction,
2034 DEFAULT_CURSOR_TUPLE_FRACTION, 0.0, 1.0, NULL, NULL
2038 {"geqo_selection_bias", PGC_USERSET, QUERY_TUNING_GEQO,
2039 gettext_noop("GEQO: selective pressure within the population."),
2042 &Geqo_selection_bias,
2043 DEFAULT_GEQO_SELECTION_BIAS, MIN_GEQO_SELECTION_BIAS,
2044 MAX_GEQO_SELECTION_BIAS, NULL, NULL
2047 {"geqo_seed", PGC_USERSET, QUERY_TUNING_GEQO,
2048 gettext_noop("GEQO: seed for random path selection."),
2052 0.0, 0.0, 1.0, NULL, NULL
2056 {"bgwriter_lru_multiplier", PGC_SIGHUP, RESOURCES,
2057 gettext_noop("Multiple of the average buffer usage to free per round."),
2060 &bgwriter_lru_multiplier,
2061 2.0, 0.0, 10.0, NULL, NULL
2065 {"seed", PGC_USERSET, UNGROUPED,
2066 gettext_noop("Sets the seed for random-number generation."),
2068 GUC_NO_SHOW_ALL | GUC_NO_RESET_ALL | GUC_NOT_IN_SAMPLE | GUC_DISALLOW_IN_FILE
2071 0.0, -1.0, 1.0, assign_random_seed, show_random_seed
2075 {"autovacuum_vacuum_scale_factor", PGC_SIGHUP, AUTOVACUUM,
2076 gettext_noop("Number of tuple updates or deletes prior to vacuum as a fraction of reltuples."),
2079 &autovacuum_vac_scale,
2080 0.2, 0.0, 100.0, NULL, NULL
2083 {"autovacuum_analyze_scale_factor", PGC_SIGHUP, AUTOVACUUM,
2084 gettext_noop("Number of tuple inserts, updates or deletes prior to analyze as a fraction of reltuples."),
2087 &autovacuum_anl_scale,
2088 0.1, 0.0, 100.0, NULL, NULL
2092 {"checkpoint_completion_target", PGC_SIGHUP, WAL_CHECKPOINTS,
2093 gettext_noop("Time spent flushing dirty buffers during checkpoint, as fraction of checkpoint interval."),
2096 &CheckPointCompletionTarget,
2097 0.5, 0.0, 1.0, NULL, NULL
2100 /* End-of-list marker */
2102 {NULL, 0, 0, NULL, NULL}, NULL, 0.0, 0.0, 0.0, NULL, NULL
2107 static struct config_string ConfigureNamesString[] =
2110 {"archive_command", PGC_SIGHUP, WAL_SETTINGS,
2111 gettext_noop("Sets the shell command that will be called to archive a WAL file."),
2114 &XLogArchiveCommand,
2115 "", NULL, show_archive_command
2119 {"client_encoding", PGC_USERSET, CLIENT_CONN_LOCALE,
2120 gettext_noop("Sets the client's character set encoding."),
2122 GUC_IS_NAME | GUC_REPORT
2124 &client_encoding_string,
2125 "SQL_ASCII", assign_client_encoding, NULL
2129 {"log_line_prefix", PGC_SIGHUP, LOGGING_WHAT,
2130 gettext_noop("Controls information prefixed to each log line."),
2131 gettext_noop("If blank, no prefix is used.")
2138 {"log_timezone", PGC_SIGHUP, LOGGING_WHAT,
2139 gettext_noop("Sets the time zone to use in log messages."),
2142 &log_timezone_string,
2143 "UNKNOWN", assign_log_timezone, show_log_timezone
2147 {"DateStyle", PGC_USERSET, CLIENT_CONN_LOCALE,
2148 gettext_noop("Sets the display format for date and time values."),
2149 gettext_noop("Also controls interpretation of ambiguous "
2151 GUC_LIST_INPUT | GUC_REPORT
2154 "ISO, MDY", assign_datestyle, NULL
2158 {"default_tablespace", PGC_USERSET, CLIENT_CONN_STATEMENT,
2159 gettext_noop("Sets the default tablespace to create tables and indexes in."),
2160 gettext_noop("An empty string selects the database's default tablespace."),
2163 &default_tablespace,
2164 "", assign_default_tablespace, NULL
2168 {"temp_tablespaces", PGC_USERSET, CLIENT_CONN_STATEMENT,
2169 gettext_noop("Sets the tablespace(s) to use for temporary tables and sort files."),
2171 GUC_LIST_INPUT | GUC_LIST_QUOTE
2174 "", assign_temp_tablespaces, NULL
2178 {"dynamic_library_path", PGC_SUSET, CLIENT_CONN_OTHER,
2179 gettext_noop("Sets the path for dynamically loadable modules."),
2180 gettext_noop("If a dynamically loadable module needs to be opened and "
2181 "the specified name does not have a directory component (i.e., the "
2182 "name does not contain a slash), the system will search this path for "
2183 "the specified file."),
2186 &Dynamic_library_path,
2187 "$libdir", NULL, NULL
2191 {"krb_server_keyfile", PGC_SIGHUP, CONN_AUTH_SECURITY,
2192 gettext_noop("Sets the location of the Kerberos server key file."),
2196 &pg_krb_server_keyfile,
2197 PG_KRB_SRVTAB, NULL, NULL
2201 {"krb_srvname", PGC_SIGHUP, CONN_AUTH_SECURITY,
2202 gettext_noop("Sets the name of the Kerberos service."),
2206 PG_KRB_SRVNAM, NULL, NULL
2210 {"bonjour_name", PGC_POSTMASTER, CONN_AUTH_SETTINGS,
2211 gettext_noop("Sets the Bonjour service name."),
2218 /* See main.c about why defaults for LC_foo are not all alike */
2221 {"lc_collate", PGC_INTERNAL, CLIENT_CONN_LOCALE,
2222 gettext_noop("Shows the collation order locale."),
2224 GUC_NOT_IN_SAMPLE | GUC_DISALLOW_IN_FILE
2231 {"lc_ctype", PGC_INTERNAL, CLIENT_CONN_LOCALE,
2232 gettext_noop("Shows the character classification and case conversion locale."),
2234 GUC_NOT_IN_SAMPLE | GUC_DISALLOW_IN_FILE
2241 {"lc_messages", PGC_SUSET, CLIENT_CONN_LOCALE,
2242 gettext_noop("Sets the language in which messages are displayed."),
2246 "", locale_messages_assign, NULL
2250 {"lc_monetary", PGC_USERSET, CLIENT_CONN_LOCALE,
2251 gettext_noop("Sets the locale for formatting monetary amounts."),
2255 "C", locale_monetary_assign, NULL
2259 {"lc_numeric", PGC_USERSET, CLIENT_CONN_LOCALE,
2260 gettext_noop("Sets the locale for formatting numbers."),
2264 "C", locale_numeric_assign, NULL
2268 {"lc_time", PGC_USERSET, CLIENT_CONN_LOCALE,
2269 gettext_noop("Sets the locale for formatting date and time values."),
2273 "C", locale_time_assign, NULL
2277 {"shared_preload_libraries", PGC_POSTMASTER, RESOURCES_KERNEL,
2278 gettext_noop("Lists shared libraries to preload into server."),
2280 GUC_LIST_INPUT | GUC_LIST_QUOTE | GUC_SUPERUSER_ONLY
2282 &shared_preload_libraries_string,
2287 {"local_preload_libraries", PGC_BACKEND, CLIENT_CONN_OTHER,
2288 gettext_noop("Lists shared libraries to preload into each backend."),
2290 GUC_LIST_INPUT | GUC_LIST_QUOTE
2292 &local_preload_libraries_string,
2297 {"search_path", PGC_USERSET, CLIENT_CONN_STATEMENT,
2298 gettext_noop("Sets the schema search order for names that are not schema-qualified."),
2300 GUC_LIST_INPUT | GUC_LIST_QUOTE
2302 &namespace_search_path,
2303 "\"$user\",public", assign_search_path, NULL
2307 /* Can't be set in postgresql.conf */
2308 {"server_encoding", PGC_INTERNAL, CLIENT_CONN_LOCALE,
2309 gettext_noop("Sets the server (database) character set encoding."),
2311 GUC_IS_NAME | GUC_REPORT | GUC_NOT_IN_SAMPLE | GUC_DISALLOW_IN_FILE
2313 &server_encoding_string,
2314 "SQL_ASCII", NULL, NULL
2318 /* Can't be set in postgresql.conf */
2319 {"server_version", PGC_INTERNAL, PRESET_OPTIONS,
2320 gettext_noop("Shows the server version."),
2322 GUC_REPORT | GUC_NOT_IN_SAMPLE | GUC_DISALLOW_IN_FILE
2324 &server_version_string,
2325 PG_VERSION, NULL, NULL
2329 /* Not for general use --- used by SET ROLE */
2330 {"role", PGC_USERSET, UNGROUPED,
2331 gettext_noop("Sets the current role."),
2333 GUC_IS_NAME | GUC_NO_SHOW_ALL | GUC_NO_RESET_ALL | GUC_NOT_IN_SAMPLE | GUC_DISALLOW_IN_FILE | GUC_NOT_WHILE_SEC_REST
2336 "none", assign_role, show_role
2340 /* Not for general use --- used by SET SESSION AUTHORIZATION */
2341 {"session_authorization", PGC_USERSET, UNGROUPED,
2342 gettext_noop("Sets the session user name."),
2344 GUC_IS_NAME | GUC_REPORT | GUC_NO_SHOW_ALL | GUC_NO_RESET_ALL | GUC_NOT_IN_SAMPLE | GUC_DISALLOW_IN_FILE | GUC_NOT_WHILE_SEC_REST
2346 &session_authorization_string,
2347 NULL, assign_session_authorization, show_session_authorization
2351 {"log_destination", PGC_SIGHUP, LOGGING_WHERE,
2352 gettext_noop("Sets the destination for server log output."),
2353 gettext_noop("Valid values are combinations of \"stderr\", "
2354 "\"syslog\", \"csvlog\", and \"eventlog\", "
2355 "depending on the platform."),
2358 &log_destination_string,
2359 "stderr", assign_log_destination, NULL
2362 {"log_directory", PGC_SIGHUP, LOGGING_WHERE,
2363 gettext_noop("Sets the destination directory for log files."),
2364 gettext_noop("Can be specified as relative to the data directory "
2365 "or as absolute path."),
2369 "pg_log", assign_canonical_path, NULL
2372 {"log_filename", PGC_SIGHUP, LOGGING_WHERE,
2373 gettext_noop("Sets the file name pattern for log files."),
2378 "postgresql-%Y-%m-%d_%H%M%S.log", NULL, NULL
2383 {"syslog_ident", PGC_SIGHUP, LOGGING_WHERE,
2384 gettext_noop("Sets the program name used to identify PostgreSQL "
2385 "messages in syslog."),
2389 "postgres", assign_syslog_ident, NULL
2394 {"TimeZone", PGC_USERSET, CLIENT_CONN_LOCALE,
2395 gettext_noop("Sets the time zone for displaying and interpreting time stamps."),
2400 "UNKNOWN", assign_timezone, show_timezone
2403 {"timezone_abbreviations", PGC_USERSET, CLIENT_CONN_LOCALE,
2404 gettext_noop("Selects a file of time zone abbreviations."),
2407 &timezone_abbreviations_string,
2408 "UNKNOWN", assign_timezone_abbreviations, NULL
2412 {"transaction_isolation", PGC_USERSET, CLIENT_CONN_STATEMENT,
2413 gettext_noop("Sets the current transaction's isolation level."),
2415 GUC_NO_RESET_ALL | GUC_NOT_IN_SAMPLE | GUC_DISALLOW_IN_FILE
2417 &XactIsoLevel_string,
2418 NULL, assign_XactIsoLevel, show_XactIsoLevel
2422 {"unix_socket_group", PGC_POSTMASTER, CONN_AUTH_SETTINGS,
2423 gettext_noop("Sets the owning group of the Unix-domain socket."),
2424 gettext_noop("The owning user of the socket is always the user "
2425 "that starts the server.")
2432 {"unix_socket_directory", PGC_POSTMASTER, CONN_AUTH_SETTINGS,
2433 gettext_noop("Sets the directory where the Unix-domain socket will be created."),
2438 "", assign_canonical_path, NULL
2442 {"listen_addresses", PGC_POSTMASTER, CONN_AUTH_SETTINGS,
2443 gettext_noop("Sets the host name or IP address(es) to listen to."),
2448 "localhost", NULL, NULL
2452 {"custom_variable_classes", PGC_SIGHUP, CUSTOM_OPTIONS,
2453 gettext_noop("Sets the list of known custom variable classes."),
2455 GUC_LIST_INPUT | GUC_LIST_QUOTE
2457 &custom_variable_classes,
2458 NULL, assign_custom_variable_classes, NULL
2462 {"data_directory", PGC_POSTMASTER, FILE_LOCATIONS,
2463 gettext_noop("Sets the server's data directory."),
2472 {"config_file", PGC_POSTMASTER, FILE_LOCATIONS,
2473 gettext_noop("Sets the server's main configuration file."),
2475 GUC_DISALLOW_IN_FILE | GUC_SUPERUSER_ONLY
2482 {"hba_file", PGC_POSTMASTER, FILE_LOCATIONS,
2483 gettext_noop("Sets the server's \"hba\" configuration file."),
2492 {"ident_file", PGC_POSTMASTER, FILE_LOCATIONS,
2493 gettext_noop("Sets the server's \"ident\" configuration file."),
2502 {"external_pid_file", PGC_POSTMASTER, FILE_LOCATIONS,
2503 gettext_noop("Writes the postmaster PID to the specified file."),
2508 NULL, assign_canonical_path, NULL
2512 {"stats_temp_directory", PGC_SIGHUP, STATS_COLLECTOR,
2513 gettext_noop("Writes temporary statistics files to the specified directory."),
2517 &pgstat_temp_directory,
2518 "pg_stat_tmp", assign_pgstat_temp_directory, NULL
2522 {"default_text_search_config", PGC_USERSET, CLIENT_CONN_LOCALE,
2523 gettext_noop("Sets default text search configuration."),
2527 "pg_catalog.simple", assignTSCurrentConfig, NULL
2532 {"ssl_ciphers", PGC_POSTMASTER, CONN_AUTH_SECURITY,
2533 gettext_noop("Sets the list of allowed SSL ciphers."),
2538 "ALL:!ADH:!LOW:!EXP:!MD5:@STRENGTH", NULL, NULL
2540 #endif /* USE_SSL */
2543 {"default_do_language", PGC_USERSET, CLIENT_CONN_STATEMENT,
2544 gettext_noop("Sets the language used in DO statement if LANGUAGE is not specified."),
2547 &default_do_language,
2548 "plpgsql", NULL, NULL
2552 {"application_name", PGC_USERSET, LOGGING,
2553 gettext_noop("Sets the application name to be reported in statistics and logs."),
2555 GUC_IS_NAME | GUC_REPORT | GUC_NOT_IN_SAMPLE
2558 "", assign_application_name, NULL
2561 /* End-of-list marker */
2563 {NULL, 0, 0, NULL, NULL}, NULL, NULL, NULL, NULL
2568 static struct config_enum ConfigureNamesEnum[] =
2571 {"backslash_quote", PGC_USERSET, COMPAT_OPTIONS_PREVIOUS,
2572 gettext_noop("Sets whether \"\\'\" is allowed in string literals."),
2576 BACKSLASH_QUOTE_SAFE_ENCODING, backslash_quote_options, NULL, NULL
2580 {"bytea_output", PGC_USERSET, CLIENT_CONN_STATEMENT,
2581 gettext_noop("Sets the output format for bytea."),
2585 BYTEA_OUTPUT_HEX, bytea_output_options, NULL, NULL
2589 {"client_min_messages", PGC_USERSET, LOGGING_WHEN,
2590 gettext_noop("Sets the message levels that are sent to the client."),
2591 gettext_noop("Each level includes all the levels that follow it. The later"
2592 " the level, the fewer messages are sent.")
2594 &client_min_messages,
2595 NOTICE, client_message_level_options, NULL, NULL
2599 {"constraint_exclusion", PGC_USERSET, QUERY_TUNING_OTHER,
2600 gettext_noop("Enables the planner to use constraints to optimize queries."),
2601 gettext_noop("Table scans will be skipped if their constraints"
2602 " guarantee that no rows match the query.")
2604 &constraint_exclusion,
2605 CONSTRAINT_EXCLUSION_PARTITION, constraint_exclusion_options,
2610 {"default_transaction_isolation", PGC_USERSET, CLIENT_CONN_STATEMENT,
2611 gettext_noop("Sets the transaction isolation level of each new transaction."),
2614 &DefaultXactIsoLevel,
2615 XACT_READ_COMMITTED, isolation_level_options, NULL, NULL
2619 {"IntervalStyle", PGC_USERSET, CLIENT_CONN_LOCALE,
2620 gettext_noop("Sets the display format for interval values."),
2625 INTSTYLE_POSTGRES, intervalstyle_options, NULL, NULL
2629 {"log_error_verbosity", PGC_SUSET, LOGGING_WHEN,
2630 gettext_noop("Sets the verbosity of logged messages."),
2633 &Log_error_verbosity,
2634 PGERROR_DEFAULT, log_error_verbosity_options, NULL, NULL
2638 {"log_min_messages", PGC_SUSET, LOGGING_WHEN,
2639 gettext_noop("Sets the message levels that are logged."),
2640 gettext_noop("Each level includes all the levels that follow it. The later"
2641 " the level, the fewer messages are sent.")
2644 WARNING, server_message_level_options, NULL, NULL
2648 {"log_min_error_statement", PGC_SUSET, LOGGING_WHEN,
2649 gettext_noop("Causes all statements generating error at or above this level to be logged."),
2650 gettext_noop("Each level includes all the levels that follow it. The later"
2651 " the level, the fewer messages are sent.")
2653 &log_min_error_statement,
2654 ERROR, server_message_level_options, NULL, NULL
2658 {"log_statement", PGC_SUSET, LOGGING_WHAT,
2659 gettext_noop("Sets the type of statements logged."),
2663 LOGSTMT_NONE, log_statement_options, NULL, NULL
2668 {"syslog_facility", PGC_SIGHUP, LOGGING_WHERE,
2669 gettext_noop("Sets the syslog \"facility\" to be used when syslog enabled."),
2673 LOG_LOCAL0, syslog_facility_options, assign_syslog_facility, NULL
2678 {"session_replication_role", PGC_SUSET, CLIENT_CONN_STATEMENT,
2679 gettext_noop("Sets the session's behavior for triggers and rewrite rules."),
2682 &SessionReplicationRole,
2683 SESSION_REPLICATION_ROLE_ORIGIN, session_replication_role_options,
2684 assign_session_replication_role, NULL
2688 {"track_functions", PGC_SUSET, STATS_COLLECTOR,
2689 gettext_noop("Collects function-level statistics on database activity."),
2692 &pgstat_track_functions,
2693 TRACK_FUNC_OFF, track_function_options, NULL, NULL
2697 {"wal_sync_method", PGC_SIGHUP, WAL_SETTINGS,
2698 gettext_noop("Selects the method used for forcing WAL updates to disk."),
2702 DEFAULT_SYNC_METHOD, sync_method_options,
2703 assign_xlog_sync_method, NULL
2707 {"xmlbinary", PGC_USERSET, CLIENT_CONN_STATEMENT,
2708 gettext_noop("Sets how binary values are to be encoded in XML."),
2712 XMLBINARY_BASE64, xmlbinary_options, NULL, NULL
2716 {"xmloption", PGC_USERSET, CLIENT_CONN_STATEMENT,
2717 gettext_noop("Sets whether XML data in implicit parsing and serialization "
2718 "operations is to be considered as documents or content fragments."),
2722 XMLOPTION_CONTENT, xmloption_options, NULL, NULL
2726 /* End-of-list marker */
2728 {NULL, 0, 0, NULL, NULL}, NULL, 0, NULL, NULL, NULL
2732 /******** end of options list ********/
2736 * To allow continued support of obsolete names for GUC variables, we apply
2737 * the following mappings to any unrecognized name. Note that an old name
2738 * should be mapped to a new one only if the new variable has very similar
2739 * semantics to the old.
2741 static const char *const map_old_guc_names[] = {
2742 "sort_mem", "work_mem",
2743 "vacuum_mem", "maintenance_work_mem",
2749 * Actual lookup of variables is done through this single, sorted array.
2751 static struct config_generic **guc_variables;
2753 /* Current number of variables contained in the vector */
2754 static int num_guc_variables;
2756 /* Vector capacity */
2757 static int size_guc_variables;
2760 static bool guc_dirty; /* TRUE if need to do commit/abort work */
2762 static bool reporting_enabled; /* TRUE to enable GUC_REPORT */
2764 static int GUCNestLevel = 0; /* 1 when in main transaction */
2767 static int guc_var_compare(const void *a, const void *b);
2768 static int guc_name_compare(const char *namea, const char *nameb);
2769 static void InitializeOneGUCOption(struct config_generic * gconf);
2770 static void push_old_value(struct config_generic * gconf, GucAction action);
2771 static void ReportGUCOption(struct config_generic * record);
2772 static void ShowGUCConfigOption(const char *name, DestReceiver *dest);
2773 static void ShowAllGUCConfig(DestReceiver *dest);
2774 static char *_ShowOption(struct config_generic * record, bool use_units);
2775 static bool is_newvalue_equal(struct config_generic * record, const char *newvalue);
2779 * Some infrastructure for checking malloc/strdup/realloc calls
2782 guc_malloc(int elevel, size_t size)
2786 data = malloc(size);
2789 (errcode(ERRCODE_OUT_OF_MEMORY),
2790 errmsg("out of memory")));
2795 guc_realloc(int elevel, void *old, size_t size)
2799 data = realloc(old, size);
2802 (errcode(ERRCODE_OUT_OF_MEMORY),
2803 errmsg("out of memory")));
2808 guc_strdup(int elevel, const char *src)
2815 (errcode(ERRCODE_OUT_OF_MEMORY),
2816 errmsg("out of memory")));
2822 * Support for assigning to a field of a string GUC item. Free the prior
2823 * value if it's not referenced anywhere else in the item (including stacked
2827 set_string_field(struct config_string * conf, char **field, char *newval)
2829 char *oldval = *field;
2832 /* Do the assignment */
2835 /* Exit if any duplicate references, or if old value was NULL anyway */
2836 if (oldval == NULL ||
2837 oldval == *(conf->variable) ||
2838 oldval == conf->reset_val ||
2839 oldval == conf->boot_val)
2841 for (stack = conf->gen.stack; stack; stack = stack->prev)
2843 if (oldval == stack->prior.stringval ||
2844 oldval == stack->masked.stringval)
2848 /* Not used anymore, so free it */
2853 * Detect whether strval is referenced anywhere in a GUC string item
2856 string_field_used(struct config_string * conf, char *strval)
2860 if (strval == *(conf->variable) ||
2861 strval == conf->reset_val ||
2862 strval == conf->boot_val)
2864 for (stack = conf->gen.stack; stack; stack = stack->prev)
2866 if (strval == stack->prior.stringval ||
2867 strval == stack->masked.stringval)
2874 * Support for copying a variable's active value into a stack entry
2877 set_stack_value(struct config_generic * gconf, union config_var_value * val)
2879 switch (gconf->vartype)
2883 *((struct config_bool *) gconf)->variable;
2887 *((struct config_int *) gconf)->variable;
2891 *((struct config_real *) gconf)->variable;
2894 /* we assume stringval is NULL if not valid */
2895 set_string_field((struct config_string *) gconf,
2897 *((struct config_string *) gconf)->variable);
2901 *((struct config_enum *) gconf)->variable;
2907 * Support for discarding a no-longer-needed value in a stack entry
2910 discard_stack_value(struct config_generic * gconf, union config_var_value * val)
2912 switch (gconf->vartype)
2918 /* no need to do anything */
2921 set_string_field((struct config_string *) gconf,
2930 * Fetch the sorted array pointer (exported for help_config.c's use ONLY)
2932 struct config_generic **
2933 get_guc_variables(void)
2935 return guc_variables;
2940 * Build the sorted array. This is split out so that it could be
2941 * re-executed after startup (eg, we could allow loadable modules to
2942 * add vars, and then we'd need to re-sort).
2945 build_guc_variables(void)
2949 struct config_generic **guc_vars;
2952 for (i = 0; ConfigureNamesBool[i].gen.name; i++)
2954 struct config_bool *conf = &ConfigureNamesBool[i];
2956 /* Rather than requiring vartype to be filled in by hand, do this: */
2957 conf->gen.vartype = PGC_BOOL;
2961 for (i = 0; ConfigureNamesInt[i].gen.name; i++)
2963 struct config_int *conf = &ConfigureNamesInt[i];
2965 conf->gen.vartype = PGC_INT;
2969 for (i = 0; ConfigureNamesReal[i].gen.name; i++)
2971 struct config_real *conf = &ConfigureNamesReal[i];
2973 conf->gen.vartype = PGC_REAL;
2977 for (i = 0; ConfigureNamesString[i].gen.name; i++)
2979 struct config_string *conf = &ConfigureNamesString[i];
2981 conf->gen.vartype = PGC_STRING;
2985 for (i = 0; ConfigureNamesEnum[i].gen.name; i++)
2987 struct config_enum *conf = &ConfigureNamesEnum[i];
2989 conf->gen.vartype = PGC_ENUM;
2994 * Create table with 20% slack
2996 size_vars = num_vars + num_vars / 4;
2998 guc_vars = (struct config_generic **)
2999 guc_malloc(FATAL, size_vars * sizeof(struct config_generic *));
3003 for (i = 0; ConfigureNamesBool[i].gen.name; i++)
3004 guc_vars[num_vars++] = &ConfigureNamesBool[i].gen;
3006 for (i = 0; ConfigureNamesInt[i].gen.name; i++)
3007 guc_vars[num_vars++] = &ConfigureNamesInt[i].gen;
3009 for (i = 0; ConfigureNamesReal[i].gen.name; i++)
3010 guc_vars[num_vars++] = &ConfigureNamesReal[i].gen;
3012 for (i = 0; ConfigureNamesString[i].gen.name; i++)
3013 guc_vars[num_vars++] = &ConfigureNamesString[i].gen;
3015 for (i = 0; ConfigureNamesEnum[i].gen.name; i++)
3016 guc_vars[num_vars++] = &ConfigureNamesEnum[i].gen;
3019 free(guc_variables);
3020 guc_variables = guc_vars;
3021 num_guc_variables = num_vars;
3022 size_guc_variables = size_vars;
3023 qsort((void *) guc_variables, num_guc_variables,
3024 sizeof(struct config_generic *), guc_var_compare);
3028 * Add a new GUC variable to the list of known variables. The
3029 * list is expanded if needed.
3032 add_guc_variable(struct config_generic * var, int elevel)
3034 if (num_guc_variables + 1 >= size_guc_variables)
3037 * Increase the vector by 25%
3039 int size_vars = size_guc_variables + size_guc_variables / 4;
3040 struct config_generic **guc_vars;
3045 guc_vars = (struct config_generic **)
3046 guc_malloc(elevel, size_vars * sizeof(struct config_generic *));
3050 guc_vars = (struct config_generic **)
3051 guc_realloc(elevel, guc_variables, size_vars * sizeof(struct config_generic *));
3054 if (guc_vars == NULL)
3055 return false; /* out of memory */
3057 guc_variables = guc_vars;
3058 size_guc_variables = size_vars;
3060 guc_variables[num_guc_variables++] = var;
3061 qsort((void *) guc_variables, num_guc_variables,
3062 sizeof(struct config_generic *), guc_var_compare);
3067 * Create and add a placeholder variable. It's presumed to belong
3068 * to a valid custom variable class at this point.
3070 static struct config_generic *
3071 add_placeholder_variable(const char *name, int elevel)
3073 size_t sz = sizeof(struct config_string) + sizeof(char *);
3074 struct config_string *var;
3075 struct config_generic *gen;
3077 var = (struct config_string *) guc_malloc(elevel, sz);
3083 gen->name = guc_strdup(elevel, name);
3084 if (gen->name == NULL)
3090 gen->context = PGC_USERSET;
3091 gen->group = CUSTOM_OPTIONS;
3092 gen->short_desc = "GUC placeholder variable";
3093 gen->flags = GUC_NO_SHOW_ALL | GUC_NOT_IN_SAMPLE | GUC_CUSTOM_PLACEHOLDER;
3094 gen->vartype = PGC_STRING;
3097 * The char* is allocated at the end of the struct since we have no
3098 * 'static' place to point to. Note that the current value, as well as
3099 * the boot and reset values, start out NULL.
3101 var->variable = (char **) (var + 1);
3103 if (!add_guc_variable((struct config_generic *) var, elevel))
3105 free((void *) gen->name);
3114 * Detect whether the portion of "name" before dotPos matches any custom
3115 * variable class name listed in custom_var_classes. The latter must be
3116 * formatted the way that assign_custom_variable_classes does it, ie,
3117 * no whitespace. NULL is valid for custom_var_classes.
3120 is_custom_class(const char *name, int dotPos, const char *custom_var_classes)
3122 bool result = false;
3123 const char *ccs = custom_var_classes;
3127 const char *start = ccs;
3133 if (c == '\0' || c == ',')
3135 if (dotPos == ccs - start && strncmp(start, name, dotPos) == 0)
3150 * Look up option NAME. If it exists, return a pointer to its record,
3151 * else return NULL. If create_placeholders is TRUE, we'll create a
3152 * placeholder record for a valid-looking custom variable name.
3154 static struct config_generic *
3155 find_option(const char *name, bool create_placeholders, int elevel)
3157 const char **key = &name;
3158 struct config_generic **res;
3164 * By equating const char ** with struct config_generic *, we are assuming
3165 * the name field is first in config_generic.
3167 res = (struct config_generic **) bsearch((void *) &key,
3168 (void *) guc_variables,
3170 sizeof(struct config_generic *),
3176 * See if the name is an obsolete name for a variable. We assume that the
3177 * set of supported old names is short enough that a brute-force search is
3180 for (i = 0; map_old_guc_names[i] != NULL; i += 2)
3182 if (guc_name_compare(name, map_old_guc_names[i]) == 0)
3183 return find_option(map_old_guc_names[i + 1], false, elevel);
3186 if (create_placeholders)
3189 * Check if the name is qualified, and if so, check if the qualifier
3190 * matches any custom variable class. If so, add a placeholder.
3192 const char *dot = strchr(name, GUC_QUALIFIER_SEPARATOR);
3195 is_custom_class(name, dot - name, custom_variable_classes))
3196 return add_placeholder_variable(name, elevel);
3205 * comparator for qsorting and bsearching guc_variables array
3208 guc_var_compare(const void *a, const void *b)
3210 struct config_generic *confa = *(struct config_generic **) a;
3211 struct config_generic *confb = *(struct config_generic **) b;
3213 return guc_name_compare(confa->name, confb->name);
3217 * the bare comparison function for GUC names
3220 guc_name_compare(const char *namea, const char *nameb)
3223 * The temptation to use strcasecmp() here must be resisted, because the
3224 * array ordering has to remain stable across setlocale() calls. So, build
3225 * our own with a simple ASCII-only downcasing.
3227 while (*namea && *nameb)
3229 char cha = *namea++;
3230 char chb = *nameb++;
3232 if (cha >= 'A' && cha <= 'Z')
3234 if (chb >= 'A' && chb <= 'Z')
3240 return 1; /* a is longer */
3242 return -1; /* b is longer */
3248 * Initialize GUC options during program startup.
3250 * Note that we cannot read the config file yet, since we have not yet
3251 * processed command-line switches.
3254 InitializeGUCOptions(void)
3261 * Before log_line_prefix could possibly receive a nonempty setting, make
3262 * sure that timezone processing is minimally alive (see elog.c).
3264 pg_timezone_pre_initialize();
3267 * Build sorted array of all GUC variables.
3269 build_guc_variables();
3272 * Load all variables with their compiled-in defaults, and initialize
3273 * status fields as needed.
3275 for (i = 0; i < num_guc_variables; i++)
3277 InitializeOneGUCOption(guc_variables[i]);
3282 reporting_enabled = false;
3285 * Prevent any attempt to override the transaction modes from
3286 * non-interactive sources.
3288 SetConfigOption("transaction_isolation", "default",
3289 PGC_POSTMASTER, PGC_S_OVERRIDE);
3290 SetConfigOption("transaction_read_only", "no",
3291 PGC_POSTMASTER, PGC_S_OVERRIDE);
3294 * For historical reasons, some GUC parameters can receive defaults from
3295 * environment variables. Process those settings. NB: if you add or
3296 * remove anything here, see also ProcessConfigFile().
3299 env = getenv("PGPORT");
3301 SetConfigOption("port", env, PGC_POSTMASTER, PGC_S_ENV_VAR);
3303 env = getenv("PGDATESTYLE");
3305 SetConfigOption("datestyle", env, PGC_POSTMASTER, PGC_S_ENV_VAR);
3307 env = getenv("PGCLIENTENCODING");
3309 SetConfigOption("client_encoding", env, PGC_POSTMASTER, PGC_S_ENV_VAR);
3312 * rlimit isn't exactly an "environment variable", but it behaves about
3313 * the same. If we can identify the platform stack depth rlimit, increase
3314 * default stack depth setting up to whatever is safe (but at most 2MB).
3316 stack_rlimit = get_stack_depth_rlimit();
3317 if (stack_rlimit > 0)
3319 int new_limit = (stack_rlimit - STACK_DEPTH_SLOP) / 1024L;
3321 if (new_limit > 100)
3325 new_limit = Min(new_limit, 2048);
3326 sprintf(limbuf, "%d", new_limit);
3327 SetConfigOption("max_stack_depth", limbuf,
3328 PGC_POSTMASTER, PGC_S_ENV_VAR);
3334 * Initialize one GUC option variable to its compiled-in default.
3337 InitializeOneGUCOption(struct config_generic * gconf)
3340 gconf->reset_source = PGC_S_DEFAULT;
3341 gconf->source = PGC_S_DEFAULT;
3342 gconf->stack = NULL;
3343 gconf->sourcefile = NULL;
3344 gconf->sourceline = 0;
3346 switch (gconf->vartype)
3350 struct config_bool *conf = (struct config_bool *) gconf;
3352 if (conf->assign_hook)
3353 if (!(*conf->assign_hook) (conf->boot_val, true,
3355 elog(FATAL, "failed to initialize %s to %d",
3356 conf->gen.name, (int) conf->boot_val);
3357 *conf->variable = conf->reset_val = conf->boot_val;
3362 struct config_int *conf = (struct config_int *) gconf;
3364 Assert(conf->boot_val >= conf->min);
3365 Assert(conf->boot_val <= conf->max);
3366 if (conf->assign_hook)
3367 if (!(*conf->assign_hook) (conf->boot_val, true,
3369 elog(FATAL, "failed to initialize %s to %d",
3370 conf->gen.name, conf->boot_val);
3371 *conf->variable = conf->reset_val = conf->boot_val;
3376 struct config_real *conf = (struct config_real *) gconf;
3378 Assert(conf->boot_val >= conf->min);
3379 Assert(conf->boot_val <= conf->max);
3380 if (conf->assign_hook)
3381 if (!(*conf->assign_hook) (conf->boot_val, true,
3383 elog(FATAL, "failed to initialize %s to %g",
3384 conf->gen.name, conf->boot_val);
3385 *conf->variable = conf->reset_val = conf->boot_val;
3390 struct config_string *conf = (struct config_string *) gconf;
3393 *conf->variable = NULL;
3394 conf->reset_val = NULL;
3396 if (conf->boot_val == NULL)
3398 /* leave the value NULL, do not call assign hook */
3402 str = guc_strdup(FATAL, conf->boot_val);
3403 conf->reset_val = str;
3405 if (conf->assign_hook)
3409 newstr = (*conf->assign_hook) (str, true,
3413 elog(FATAL, "failed to initialize %s to \"%s\"",
3414 conf->gen.name, str);
3416 else if (newstr != str)
3421 * See notes in set_config_option about casting
3423 str = (char *) newstr;
3424 conf->reset_val = str;
3427 *conf->variable = str;
3432 struct config_enum *conf = (struct config_enum *) gconf;
3434 if (conf->assign_hook)
3435 if (!(*conf->assign_hook) (conf->boot_val, true,
3437 elog(FATAL, "failed to initialize %s to %s",
3439 config_enum_lookup_by_value(conf, conf->boot_val));
3440 *conf->variable = conf->reset_val = conf->boot_val;
3448 * Select the configuration files and data directory to be used, and
3449 * do the initial read of postgresql.conf.
3451 * This is called after processing command-line switches.
3452 * userDoption is the -D switch value if any (NULL if unspecified).
3453 * progname is just for use in error messages.
3455 * Returns true on success; on failure, prints a suitable error message
3456 * to stderr and returns false.
3459 SelectConfigFiles(const char *userDoption, const char *progname)
3463 struct stat stat_buf;
3465 /* configdir is -D option, or $PGDATA if no -D */
3467 configdir = make_absolute_path(userDoption);
3469 configdir = make_absolute_path(getenv("PGDATA"));
3472 * Find the configuration file: if config_file was specified on the
3473 * command line, use it, else use configdir/postgresql.conf. In any case
3474 * ensure the result is an absolute path, so that it will be interpreted
3475 * the same way by future backends.
3478 fname = make_absolute_path(ConfigFileName);
3481 fname = guc_malloc(FATAL,
3482 strlen(configdir) + strlen(CONFIG_FILENAME) + 2);
3483 sprintf(fname, "%s/%s", configdir, CONFIG_FILENAME);
3487 write_stderr("%s does not know where to find the server configuration file.\n"
3488 "You must specify the --config-file or -D invocation "
3489 "option or set the PGDATA environment variable.\n",
3495 * Set the ConfigFileName GUC variable to its final value, ensuring that
3496 * it can't be overridden later.
3498 SetConfigOption("config_file", fname, PGC_POSTMASTER, PGC_S_OVERRIDE);
3502 * Now read the config file for the first time.
3504 if (stat(ConfigFileName, &stat_buf) != 0)
3506 write_stderr("%s cannot access the server configuration file \"%s\": %s\n",
3507 progname, ConfigFileName, strerror(errno));
3511 ProcessConfigFile(PGC_POSTMASTER);
3514 * If the data_directory GUC variable has been set, use that as DataDir;
3515 * otherwise use configdir if set; else punt.
3517 * Note: SetDataDir will copy and absolute-ize its argument, so we don't
3521 SetDataDir(data_directory);
3523 SetDataDir(configdir);
3526 write_stderr("%s does not know where to find the database system data.\n"
3527 "This can be specified as \"data_directory\" in \"%s\", "
3528 "or by the -D invocation option, or by the "
3529 "PGDATA environment variable.\n",
3530 progname, ConfigFileName);
3535 * Reflect the final DataDir value back into the data_directory GUC var.
3536 * (If you are wondering why we don't just make them a single variable,
3537 * it's because the EXEC_BACKEND case needs DataDir to be transmitted to
3538 * child backends specially. XXX is that still true? Given that we now
3539 * chdir to DataDir, EXEC_BACKEND can read the config file without knowing
3540 * DataDir in advance.)
3542 SetConfigOption("data_directory", DataDir, PGC_POSTMASTER, PGC_S_OVERRIDE);
3545 * Figure out where pg_hba.conf is, and make sure the path is absolute.
3548 fname = make_absolute_path(HbaFileName);
3551 fname = guc_malloc(FATAL,
3552 strlen(configdir) + strlen(HBA_FILENAME) + 2);
3553 sprintf(fname, "%s/%s", configdir, HBA_FILENAME);
3557 write_stderr("%s does not know where to find the \"hba\" configuration file.\n"
3558 "This can be specified as \"hba_file\" in \"%s\", "
3559 "or by the -D invocation option, or by the "
3560 "PGDATA environment variable.\n",
3561 progname, ConfigFileName);
3564 SetConfigOption("hba_file", fname, PGC_POSTMASTER, PGC_S_OVERRIDE);
3568 * Likewise for pg_ident.conf.
3571 fname = make_absolute_path(IdentFileName);
3574 fname = guc_malloc(FATAL,
3575 strlen(configdir) + strlen(IDENT_FILENAME) + 2);
3576 sprintf(fname, "%s/%s", configdir, IDENT_FILENAME);
3580 write_stderr("%s does not know where to find the \"ident\" configuration file.\n"
3581 "This can be specified as \"ident_file\" in \"%s\", "
3582 "or by the -D invocation option, or by the "
3583 "PGDATA environment variable.\n",
3584 progname, ConfigFileName);
3587 SetConfigOption("ident_file", fname, PGC_POSTMASTER, PGC_S_OVERRIDE);
3597 * Reset all options to their saved default values (implements RESET ALL)
3600 ResetAllOptions(void)
3604 for (i = 0; i < num_guc_variables; i++)
3606 struct config_generic *gconf = guc_variables[i];
3608 /* Don't reset non-SET-able values */
3609 if (gconf->context != PGC_SUSET &&
3610 gconf->context != PGC_USERSET)
3612 /* Don't reset if special exclusion from RESET ALL */
3613 if (gconf->flags & GUC_NO_RESET_ALL)
3615 /* No need to reset if wasn't SET */
3616 if (gconf->source <= PGC_S_OVERRIDE)
3619 /* Save old value to support transaction abort */
3620 push_old_value(gconf, GUC_ACTION_SET);
3622 switch (gconf->vartype)
3626 struct config_bool *conf = (struct config_bool *) gconf;
3628 if (conf->assign_hook)
3629 if (!(*conf->assign_hook) (conf->reset_val, true,
3631 elog(ERROR, "failed to reset %s to %d",
3632 conf->gen.name, (int) conf->reset_val);
3633 *conf->variable = conf->reset_val;
3638 struct config_int *conf = (struct config_int *) gconf;
3640 if (conf->assign_hook)
3641 if (!(*conf->assign_hook) (conf->reset_val, true,
3643 elog(ERROR, "failed to reset %s to %d",
3644 conf->gen.name, conf->reset_val);
3645 *conf->variable = conf->reset_val;
3650 struct config_real *conf = (struct config_real *) gconf;
3652 if (conf->assign_hook)
3653 if (!(*conf->assign_hook) (conf->reset_val, true,
3655 elog(ERROR, "failed to reset %s to %g",
3656 conf->gen.name, conf->reset_val);
3657 *conf->variable = conf->reset_val;
3662 struct config_string *conf = (struct config_string *) gconf;
3665 /* We need not strdup here */
3666 str = conf->reset_val;
3668 if (conf->assign_hook && str)
3672 newstr = (*conf->assign_hook) (str, true,
3675 elog(ERROR, "failed to reset %s to \"%s\"",
3676 conf->gen.name, str);
3677 else if (newstr != str)
3680 * See notes in set_config_option about casting
3682 str = (char *) newstr;
3686 set_string_field(conf, conf->variable, str);
3691 struct config_enum *conf = (struct config_enum *) gconf;
3693 if (conf->assign_hook)
3694 if (!(*conf->assign_hook) (conf->reset_val, true,
3696 elog(ERROR, "failed to reset %s to %s",
3698 config_enum_lookup_by_value(conf, conf->reset_val));
3699 *conf->variable = conf->reset_val;
3704 gconf->source = gconf->reset_source;
3706 if (gconf->flags & GUC_REPORT)
3707 ReportGUCOption(gconf);
3714 * Push previous state during transactional assignment to a GUC variable.
3717 push_old_value(struct config_generic * gconf, GucAction action)
3721 /* If we're not inside a nest level, do nothing */
3722 if (GUCNestLevel == 0)
3725 /* Do we already have a stack entry of the current nest level? */
3726 stack = gconf->stack;
3727 if (stack && stack->nest_level >= GUCNestLevel)
3729 /* Yes, so adjust its state if necessary */
3730 Assert(stack->nest_level == GUCNestLevel);
3733 case GUC_ACTION_SET:
3734 /* SET overrides any prior action at same nest level */
3735 if (stack->state == GUC_SET_LOCAL)
3737 /* must discard old masked value */
3738 discard_stack_value(gconf, &stack->masked);
3740 stack->state = GUC_SET;
3742 case GUC_ACTION_LOCAL:
3743 if (stack->state == GUC_SET)
3745 /* SET followed by SET LOCAL, remember SET's value */
3746 set_stack_value(gconf, &stack->masked);
3747 stack->state = GUC_SET_LOCAL;
3749 /* in all other cases, no change to stack entry */
3751 case GUC_ACTION_SAVE:
3752 /* Could only have a prior SAVE of same variable */
3753 Assert(stack->state == GUC_SAVE);
3756 Assert(guc_dirty); /* must be set already */
3761 * Push a new stack entry
3763 * We keep all the stack entries in TopTransactionContext for simplicity.
3765 stack = (GucStack *) MemoryContextAllocZero(TopTransactionContext,
3768 stack->prev = gconf->stack;
3769 stack->nest_level = GUCNestLevel;
3772 case GUC_ACTION_SET:
3773 stack->state = GUC_SET;
3775 case GUC_ACTION_LOCAL:
3776 stack->state = GUC_LOCAL;
3778 case GUC_ACTION_SAVE:
3779 stack->state = GUC_SAVE;
3782 stack->source = gconf->source;
3783 set_stack_value(gconf, &stack->prior);
3785 gconf->stack = stack;
3787 /* Ensure we remember to pop at end of xact */
3793 * Do GUC processing at main transaction start.
3799 * The nest level should be 0 between transactions; if it isn't, somebody
3800 * didn't call AtEOXact_GUC, or called it with the wrong nestLevel. We
3801 * throw a warning but make no other effort to clean up.
3803 if (GUCNestLevel != 0)
3804 elog(WARNING, "GUC nest level = %d at transaction start",
3810 * Enter a new nesting level for GUC values. This is called at subtransaction
3811 * start and when entering a function that has proconfig settings. NOTE that
3812 * we must not risk error here, else subtransaction start will be unhappy.
3815 NewGUCNestLevel(void)
3817 return ++GUCNestLevel;
3821 * Do GUC processing at transaction or subtransaction commit or abort, or
3822 * when exiting a function that has proconfig settings. (The name is thus
3823 * a bit of a misnomer; perhaps it should be ExitGUCNestLevel or some such.)
3824 * During abort, we discard all GUC settings that were applied at nesting
3825 * levels >= nestLevel. nestLevel == 1 corresponds to the main transaction.
3828 AtEOXact_GUC(bool isCommit, int nestLevel)
3833 Assert(nestLevel > 0 && nestLevel <= GUCNestLevel);
3835 /* Quick exit if nothing's changed in this transaction */
3838 GUCNestLevel = nestLevel - 1;
3842 still_dirty = false;
3843 for (i = 0; i < num_guc_variables; i++)
3845 struct config_generic *gconf = guc_variables[i];
3849 * Process and pop each stack entry within the nest level. To
3850 * simplify fmgr_security_definer(), we allow failure exit from a
3851 * function-with-SET-options to be recovered at the surrounding
3852 * transaction or subtransaction abort; so there could be more than
3853 * one stack entry to pop.
3855 while ((stack = gconf->stack) != NULL &&
3856 stack->nest_level >= nestLevel)
3858 GucStack *prev = stack->prev;
3859 bool restorePrior = false;
3860 bool restoreMasked = false;
3864 * In this next bit, if we don't set either restorePrior or
3865 * restoreMasked, we must "discard" any unwanted fields of the
3866 * stack entries to avoid leaking memory. If we do set one of
3867 * those flags, unused fields will be cleaned up after restoring.
3869 if (!isCommit) /* if abort, always restore prior value */
3870 restorePrior = true;
3871 else if (stack->state == GUC_SAVE)
3872 restorePrior = true;
3873 else if (stack->nest_level == 1)
3875 /* transaction commit */
3876 if (stack->state == GUC_SET_LOCAL)
3877 restoreMasked = true;
3878 else if (stack->state == GUC_SET)
3880 /* we keep the current active value */
3881 discard_stack_value(gconf, &stack->prior);
3883 else /* must be GUC_LOCAL */
3884 restorePrior = true;
3886 else if (prev == NULL ||
3887 prev->nest_level < stack->nest_level - 1)
3889 /* decrement entry's level and do not pop it */
3890 stack->nest_level--;
3896 * We have to merge this stack entry into prev. See README for
3897 * discussion of this bit.
3899 switch (stack->state)
3902 Assert(false); /* can't get here */
3905 /* next level always becomes SET */
3906 discard_stack_value(gconf, &stack->prior);
3907 if (prev->state == GUC_SET_LOCAL)
3908 discard_stack_value(gconf, &prev->masked);
3909 prev->state = GUC_SET;
3913 if (prev->state == GUC_SET)
3915 /* LOCAL migrates down */
3916 prev->masked = stack->prior;
3917 prev->state = GUC_SET_LOCAL;
3921 /* else just forget this stack level */
3922 discard_stack_value(gconf, &stack->prior);
3927 /* prior state at this level no longer wanted */
3928 discard_stack_value(gconf, &stack->prior);
3929 /* copy down the masked state */
3930 if (prev->state == GUC_SET_LOCAL)
3931 discard_stack_value(gconf, &prev->masked);
3932 prev->masked = stack->masked;
3933 prev->state = GUC_SET_LOCAL;
3940 if (restorePrior || restoreMasked)
3942 /* Perform appropriate restoration of the stacked value */
3943 union config_var_value newvalue;
3944 GucSource newsource;
3948 newvalue = stack->masked;
3949 newsource = PGC_S_SESSION;
3953 newvalue = stack->prior;
3954 newsource = stack->source;
3957 switch (gconf->vartype)
3961 struct config_bool *conf = (struct config_bool *) gconf;
3962 bool newval = newvalue.boolval;
3964 if (*conf->variable != newval)
3966 if (conf->assign_hook)
3967 if (!(*conf->assign_hook) (newval,
3968 true, PGC_S_OVERRIDE))
3969 elog(LOG, "failed to commit %s as %d",
3970 conf->gen.name, (int) newval);
3971 *conf->variable = newval;
3978 struct config_int *conf = (struct config_int *) gconf;
3979 int newval = newvalue.intval;
3981 if (*conf->variable != newval)
3983 if (conf->assign_hook)
3984 if (!(*conf->assign_hook) (newval,
3985 true, PGC_S_OVERRIDE))
3986 elog(LOG, "failed to commit %s as %d",
3987 conf->gen.name, newval);
3988 *conf->variable = newval;
3995 struct config_real *conf = (struct config_real *) gconf;
3996 double newval = newvalue.realval;
3998 if (*conf->variable != newval)
4000 if (conf->assign_hook)
4001 if (!(*conf->assign_hook) (newval,
4002 true, PGC_S_OVERRIDE))
4003 elog(LOG, "failed to commit %s as %g",
4004 conf->gen.name, newval);
4005 *conf->variable = newval;
4012 struct config_string *conf = (struct config_string *) gconf;
4013 char *newval = newvalue.stringval;
4015 if (*conf->variable != newval)
4017 if (conf->assign_hook && newval)
4021 newstr = (*conf->assign_hook) (newval, true,
4024 elog(LOG, "failed to commit %s as \"%s\"",
4025 conf->gen.name, newval);
4026 else if (newstr != newval)
4029 * If newval should now be freed,
4030 * it'll be taken care of below.
4032 * See notes in set_config_option
4035 newval = (char *) newstr;
4039 set_string_field(conf, conf->variable, newval);
4044 * Release stacked values if not used anymore. We
4045 * could use discard_stack_value() here, but since
4046 * we have type-specific code anyway, might as
4049 set_string_field(conf, &stack->prior.stringval, NULL);
4050 set_string_field(conf, &stack->masked.stringval, NULL);
4055 struct config_enum *conf = (struct config_enum *) gconf;
4056 int newval = newvalue.enumval;
4058 if (*conf->variable != newval)
4060 if (conf->assign_hook)
4061 if (!(*conf->assign_hook) (newval,
4062 true, PGC_S_OVERRIDE))
4063 elog(LOG, "failed to commit %s as %s",
4065 config_enum_lookup_by_value(conf, newval));
4066 *conf->variable = newval;
4073 gconf->source = newsource;
4076 /* Finish popping the state stack */
4077 gconf->stack = prev;
4080 /* Report new value if we changed it */
4081 if (changed && (gconf->flags & GUC_REPORT))
4082 ReportGUCOption(gconf);
4083 } /* end of stack-popping loop */
4089 /* If there are no remaining stack entries, we can reset guc_dirty */
4090 guc_dirty = still_dirty;
4092 /* Update nesting level */
4093 GUCNestLevel = nestLevel - 1;
4098 * Start up automatic reporting of changes to variables marked GUC_REPORT.
4099 * This is executed at completion of backend startup.
4102 BeginReportingGUCOptions(void)
4107 * Don't do anything unless talking to an interactive frontend of protocol
4110 if (whereToSendOutput != DestRemote ||
4111 PG_PROTOCOL_MAJOR(FrontendProtocol) < 3)
4114 reporting_enabled = true;
4116 /* Transmit initial values of interesting variables */
4117 for (i = 0; i < num_guc_variables; i++)
4119 struct config_generic *conf = guc_variables[i];
4121 if (conf->flags & GUC_REPORT)
4122 ReportGUCOption(conf);
4127 * ReportGUCOption: if appropriate, transmit option value to frontend
4130 ReportGUCOption(struct config_generic * record)
4132 if (reporting_enabled && (record->flags & GUC_REPORT))
4134 char *val = _ShowOption(record, false);
4135 StringInfoData msgbuf;
4137 pq_beginmessage(&msgbuf, 'S');
4138 pq_sendstring(&msgbuf, record->name);
4139 pq_sendstring(&msgbuf, val);
4140 pq_endmessage(&msgbuf);
4147 * Try to parse value as an integer. The accepted formats are the
4148 * usual decimal, octal, or hexadecimal formats, optionally followed by
4149 * a unit name if "flags" indicates a unit is allowed.
4151 * If the string parses okay, return true, else false.
4152 * If okay and result is not NULL, return the value in *result.
4153 * If not okay and hintmsg is not NULL, *hintmsg is set to a suitable
4154 * HINT message, or NULL if no hint provided.
4157 parse_int(const char *value, int *result, int flags, const char **hintmsg)
4162 /* To suppress compiler warnings, always set output params */
4168 /* We assume here that int64 is at least as wide as long */
4170 val = strtol(value, &endptr, 0);
4172 if (endptr == value)
4173 return false; /* no HINT for integer syntax error */
4175 if (errno == ERANGE || val != (int64) ((int32) val))
4178 *hintmsg = gettext_noop("Value exceeds integer range.");
4182 /* allow whitespace between integer and unit */
4183 while (isspace((unsigned char) *endptr))
4186 /* Handle possible unit */
4187 if (*endptr != '\0')
4190 * Note: the multiple-switch coding technique here is a bit tedious,
4191 * but seems necessary to avoid intermediate-value overflows.
4193 * If INT64_IS_BUSTED (ie, it's really int32) we will fail to detect
4194 * overflow due to units conversion, but there are few enough such
4195 * machines that it does not seem worth trying to be smarter.
4197 if (flags & GUC_UNIT_MEMORY)
4199 /* Set hint for use if no match or trailing garbage */
4201 *hintmsg = gettext_noop("Valid units for this parameter are \"kB\", \"MB\", and \"GB\".");
4203 #if BLCKSZ < 1024 || BLCKSZ > (1024*1024)
4204 #error BLCKSZ must be between 1KB and 1MB
4206 #if XLOG_BLCKSZ < 1024 || XLOG_BLCKSZ > (1024*1024)
4207 #error XLOG_BLCKSZ must be between 1KB and 1MB
4210 if (strncmp(endptr, "kB", 2) == 0)
4213 switch (flags & GUC_UNIT_MEMORY)
4215 case GUC_UNIT_BLOCKS:
4216 val /= (BLCKSZ / 1024);
4218 case GUC_UNIT_XBLOCKS:
4219 val /= (XLOG_BLCKSZ / 1024);
4223 else if (strncmp(endptr, "MB", 2) == 0)
4226 switch (flags & GUC_UNIT_MEMORY)
4231 case GUC_UNIT_BLOCKS:
4232 val *= KB_PER_MB / (BLCKSZ / 1024);
4234 case GUC_UNIT_XBLOCKS:
4235 val *= KB_PER_MB / (XLOG_BLCKSZ / 1024);
4239 else if (strncmp(endptr, "GB", 2) == 0)
4242 switch (flags & GUC_UNIT_MEMORY)
4247 case GUC_UNIT_BLOCKS:
4248 val *= KB_PER_GB / (BLCKSZ / 1024);
4250 case GUC_UNIT_XBLOCKS:
4251 val *= KB_PER_GB / (XLOG_BLCKSZ / 1024);
4256 else if (flags & GUC_UNIT_TIME)
4258 /* Set hint for use if no match or trailing garbage */
4260 *hintmsg = gettext_noop("Valid units for this parameter are \"ms\", \"s\", \"min\", \"h\", and \"d\".");
4262 if (strncmp(endptr, "ms", 2) == 0)
4265 switch (flags & GUC_UNIT_TIME)
4275 else if (strncmp(endptr, "s", 1) == 0)
4278 switch (flags & GUC_UNIT_TIME)
4288 else if (strncmp(endptr, "min", 3) == 0)
4291 switch (flags & GUC_UNIT_TIME)
4301 else if (strncmp(endptr, "h", 1) == 0)
4304 switch (flags & GUC_UNIT_TIME)
4317 else if (strncmp(endptr, "d", 1) == 0)
4320 switch (flags & GUC_UNIT_TIME)
4335 /* allow whitespace after unit */
4336 while (isspace((unsigned char) *endptr))
4339 if (*endptr != '\0')
4340 return false; /* appropriate hint, if any, already set */
4342 /* Check for overflow due to units conversion */
4343 if (val != (int64) ((int32) val))
4346 *hintmsg = gettext_noop("Value exceeds integer range.");
4352 *result = (int) val;
4359 * Try to parse value as a floating point number in the usual format.
4360 * If the string parses okay, return true, else false.
4361 * If okay and result is not NULL, return the value in *result.
4364 parse_real(const char *value, double *result)
4370 *result = 0; /* suppress compiler warning */
4373 val = strtod(value, &endptr);
4374 if (endptr == value || errno == ERANGE)
4377 /* allow whitespace after number */
4378 while (isspace((unsigned char) *endptr))
4380 if (*endptr != '\0')
4390 * Lookup the name for an enum option with the selected value.
4391 * Should only ever be called with known-valid values, so throws
4392 * an elog(ERROR) if the enum option is not found.
4394 * The returned string is a pointer to static data and not
4395 * allocated for modification.
4398 config_enum_lookup_by_value(struct config_enum * record, int val)
4400 const struct config_enum_entry *entry;
4402 for (entry = record->options; entry && entry->name; entry++)
4404 if (entry->val == val)
4408 elog(ERROR, "could not find enum option %d for %s",
4409 val, record->gen.name);
4410 return NULL; /* silence compiler */
4415 * Lookup the value for an enum option with the selected name
4416 * (case-insensitive).
4417 * If the enum option is found, sets the retval value and returns
4418 * true. If it's not found, return FALSE and retval is set to 0.
4421 config_enum_lookup_by_name(struct config_enum * record, const char *value,
4424 const struct config_enum_entry *entry;
4426 for (entry = record->options; entry && entry->name; entry++)
4428 if (pg_strcasecmp(value, entry->name) == 0)
4430 *retval = entry->val;
4441 * Return a list of all available options for an enum, excluding
4442 * hidden ones, separated by the given separator.
4443 * If prefix is non-NULL, it is added before the first enum value.
4444 * If suffix is non-NULL, it is added to the end of the string.
4447 config_enum_get_options(struct config_enum * record, const char *prefix,
4448 const char *suffix, const char *separator)
4450 const struct config_enum_entry *entry;
4451 StringInfoData retstr;
4454 initStringInfo(&retstr);
4455 appendStringInfoString(&retstr, prefix);
4457 seplen = strlen(separator);
4458 for (entry = record->options; entry && entry->name; entry++)
4462 appendStringInfoString(&retstr, entry->name);
4463 appendBinaryStringInfo(&retstr, separator, seplen);
4468 * All the entries may have been hidden, leaving the string empty if no
4469 * prefix was given. This indicates a broken GUC setup, since there is no
4470 * use for an enum without any values, so we just check to make sure we
4471 * don't write to invalid memory instead of actually trying to do
4472 * something smart with it.
4474 if (retstr.len >= seplen)
4476 /* Replace final separator */
4477 retstr.data[retstr.len - seplen] = '\0';
4478 retstr.len -= seplen;
4481 appendStringInfoString(&retstr, suffix);
4487 * Call a GucStringAssignHook function, being careful to free the
4488 * "newval" string if the hook ereports.
4490 * This is split out of set_config_option just to avoid the "volatile"
4491 * qualifiers that would otherwise have to be plastered all over.
4494 call_string_assign_hook(GucStringAssignHook assign_hook,
4495 char *newval, bool doit, GucSource source)
4501 result = (*assign_hook) (newval, doit, source);
4515 * Sets option `name' to given value. The value should be a string
4516 * which is going to be parsed and converted to the appropriate data
4517 * type. The context and source parameters indicate in which context this
4518 * function is being called so it can apply the access restrictions
4521 * If value is NULL, set the option to its default value (normally the
4522 * reset_val, but if source == PGC_S_DEFAULT we instead use the boot_val).
4524 * action indicates whether to set the value globally in the session, locally
4525 * to the current top transaction, or just for the duration of a function call.
4527 * If changeVal is false then don't really set the option but do all
4528 * the checks to see if it would work.
4530 * If there is an error (non-existing option, invalid value) then an
4531 * ereport(ERROR) is thrown *unless* this is called in a context where we
4532 * don't want to ereport (currently, startup or SIGHUP config file reread).
4533 * In that case we write a suitable error message via ereport(LOG) and
4534 * return false. This is working around the deficiencies in the ereport
4535 * mechanism, so don't blame me. In all other cases, the function
4536 * returns true, including cases where the input is valid but we chose
4537 * not to apply it because of context or source-priority considerations.
4539 * See also SetConfigOption for an external interface.
4542 set_config_option(const char *name, const char *value,
4543 GucContext context, GucSource source,
4544 GucAction action, bool changeVal)
4546 struct config_generic *record;
4550 if (context == PGC_SIGHUP || source == PGC_S_DEFAULT)
4553 * To avoid cluttering the log, only the postmaster bleats loudly
4554 * about problems with the config file.
4556 elevel = IsUnderPostmaster ? DEBUG3 : LOG;
4558 else if (source == PGC_S_DATABASE || source == PGC_S_USER ||
4559 source == PGC_S_DATABASE_USER)
4564 record = find_option(name, true, elevel);
4568 (errcode(ERRCODE_UNDEFINED_OBJECT),
4569 errmsg("unrecognized configuration parameter \"%s\"", name)));
4574 * If source is postgresql.conf, mark the found record with
4575 * GUC_IS_IN_FILE. This is for the convenience of ProcessConfigFile. Note
4576 * that we do it even if changeVal is false, since ProcessConfigFile wants
4577 * the marking to occur during its testing pass.
4579 if (source == PGC_S_FILE)
4580 record->status |= GUC_IS_IN_FILE;
4583 * Check if the option can be set at this time. See guc.h for the precise
4584 * rules. Note that we don't want to throw errors if we're in the SIGHUP
4585 * context. In that case we just ignore the attempt and return true.
4587 switch (record->context)
4590 if (context == PGC_SIGHUP)
4592 if (context != PGC_INTERNAL)
4595 (errcode(ERRCODE_CANT_CHANGE_RUNTIME_PARAM),
4596 errmsg("parameter \"%s\" cannot be changed",
4601 case PGC_POSTMASTER:
4602 if (context == PGC_SIGHUP)
4605 * We are reading a PGC_POSTMASTER var from postgresql.conf.
4606 * We can't change the setting, so give a warning if the DBA
4607 * tries to change it. (Throwing an error would be more
4608 * consistent, but seems overly rigid.)
4610 if (changeVal && !is_newvalue_equal(record, value))
4612 (errcode(ERRCODE_CANT_CHANGE_RUNTIME_PARAM),
4613 errmsg("parameter \"%s\" cannot be changed without restarting the server",
4617 if (context != PGC_POSTMASTER)
4620 (errcode(ERRCODE_CANT_CHANGE_RUNTIME_PARAM),
4621 errmsg("parameter \"%s\" cannot be changed without restarting the server",
4627 if (context != PGC_SIGHUP && context != PGC_POSTMASTER)
4630 (errcode(ERRCODE_CANT_CHANGE_RUNTIME_PARAM),
4631 errmsg("parameter \"%s\" cannot be changed now",
4637 * Hmm, the idea of the SIGHUP context is "ought to be global, but
4638 * can be changed after postmaster start". But there's nothing
4639 * that prevents a crafty administrator from sending SIGHUP
4640 * signals to individual backends only.
4644 if (context == PGC_SIGHUP)
4647 * If a PGC_BACKEND parameter is changed in the config file,
4648 * we want to accept the new value in the postmaster (whence
4649 * it will propagate to subsequently-started backends), but
4650 * ignore it in existing backends. This is a tad klugy, but
4651 * necessary because we don't re-read the config file during
4654 if (IsUnderPostmaster)
4657 else if (context != PGC_POSTMASTER && context != PGC_BACKEND &&
4658 source != PGC_S_CLIENT)
4661 (errcode(ERRCODE_CANT_CHANGE_RUNTIME_PARAM),
4662 errmsg("parameter \"%s\" cannot be set after connection start",
4668 if (context == PGC_USERSET || context == PGC_BACKEND)
4671 (errcode(ERRCODE_INSUFFICIENT_PRIVILEGE),
4672 errmsg("permission denied to set parameter \"%s\"",
4683 * Disallow changing GUC_NOT_WHILE_SEC_REST values if we are inside a
4684 * security restriction context. We can reject this regardless of
4685 * the GUC context or source, mainly because sources that it might be
4686 * reasonable to override for won't be seen while inside a function.
4688 * Note: variables marked GUC_NOT_WHILE_SEC_REST should usually be marked
4689 * GUC_NO_RESET_ALL as well, because ResetAllOptions() doesn't check this.
4690 * An exception might be made if the reset value is assumed to be "safe".
4692 * Note: this flag is currently used for "session_authorization" and
4693 * "role". We need to prohibit changing these inside a local userid
4694 * context because when we exit it, GUC won't be notified, leaving things
4695 * out of sync. (This could be fixed by forcing a new GUC nesting level,
4696 * but that would change behavior in possibly-undesirable ways.) Also,
4697 * we prohibit changing these in a security-restricted operation because
4698 * otherwise RESET could be used to regain the session user's privileges.
4700 if (record->flags & GUC_NOT_WHILE_SEC_REST)
4702 if (InLocalUserIdChange())
4705 * Phrasing of this error message is historical, but it's the
4709 (errcode(ERRCODE_INSUFFICIENT_PRIVILEGE),
4710 errmsg("cannot set parameter \"%s\" within security-definer function",
4714 if (InSecurityRestrictedOperation())
4717 (errcode(ERRCODE_INSUFFICIENT_PRIVILEGE),
4718 errmsg("cannot set parameter \"%s\" within security-restricted operation",
4725 * Should we set reset/stacked values? (If so, the behavior is not
4726 * transactional.) This is done either when we get a default value from
4727 * the database's/user's/client's default settings or when we reset a
4728 * value to its default.
4730 makeDefault = changeVal && (source <= PGC_S_OVERRIDE) &&
4731 ((value != NULL) || source == PGC_S_DEFAULT);
4734 * Ignore attempted set if overridden by previously processed setting.
4735 * However, if changeVal is false then plow ahead anyway since we are
4736 * trying to find out if the value is potentially good, not actually use
4737 * it. Also keep going if makeDefault is true, since we may want to set
4738 * the reset/stacked values even if we can't set the variable itself.
4740 if (record->source > source)
4742 if (changeVal && !makeDefault)
4744 elog(DEBUG3, "\"%s\": setting ignored because previous source is higher priority",
4752 * Evaluate value and set variable.
4754 switch (record->vartype)
4758 struct config_bool *conf = (struct config_bool *) record;
4763 if (!parse_bool(value, &newval))
4766 (errcode(ERRCODE_INVALID_PARAMETER_VALUE),
4767 errmsg("parameter \"%s\" requires a Boolean value",
4772 else if (source == PGC_S_DEFAULT)
4773 newval = conf->boot_val;
4776 newval = conf->reset_val;
4777 source = conf->gen.reset_source;
4780 /* Save old value to support transaction abort */
4781 if (changeVal && !makeDefault)
4782 push_old_value(&conf->gen, action);
4784 if (conf->assign_hook)
4785 if (!(*conf->assign_hook) (newval, changeVal, source))
4788 (errcode(ERRCODE_INVALID_PARAMETER_VALUE),
4789 errmsg("invalid value for parameter \"%s\": %d",
4790 name, (int) newval)));
4796 *conf->variable = newval;
4797 conf->gen.source = source;
4803 if (conf->gen.reset_source <= source)
4805 conf->reset_val = newval;
4806 conf->gen.reset_source = source;
4808 for (stack = conf->gen.stack; stack; stack = stack->prev)
4810 if (stack->source <= source)
4812 stack->prior.boolval = newval;
4813 stack->source = source;
4822 struct config_int *conf = (struct config_int *) record;
4827 const char *hintmsg;
4829 if (!parse_int(value, &newval, conf->gen.flags, &hintmsg))
4832 (errcode(ERRCODE_INVALID_PARAMETER_VALUE),
4833 errmsg("invalid value for parameter \"%s\": \"%s\"",
4835 hintmsg ? errhint("%s", _(hintmsg)) : 0));
4838 if (newval < conf->min || newval > conf->max)
4841 (errcode(ERRCODE_INVALID_PARAMETER_VALUE),
4842 errmsg("%d is outside the valid range for parameter \"%s\" (%d .. %d)",
4843 newval, name, conf->min, conf->max)));
4847 else if (source == PGC_S_DEFAULT)
4848 newval = conf->boot_val;
4851 newval = conf->reset_val;
4852 source = conf->gen.reset_source;
4855 /* Save old value to support transaction abort */
4856 if (changeVal && !makeDefault)
4857 push_old_value(&conf->gen, action);
4859 if (conf->assign_hook)
4860 if (!(*conf->assign_hook) (newval, changeVal, source))
4863 (errcode(ERRCODE_INVALID_PARAMETER_VALUE),
4864 errmsg("invalid value for parameter \"%s\": %d",
4871 *conf->variable = newval;
4872 conf->gen.source = source;
4878 if (conf->gen.reset_source <= source)
4880 conf->reset_val = newval;
4881 conf->gen.reset_source = source;
4883 for (stack = conf->gen.stack; stack; stack = stack->prev)
4885 if (stack->source <= source)
4887 stack->prior.intval = newval;
4888 stack->source = source;
4897 struct config_real *conf = (struct config_real *) record;
4902 if (!parse_real(value, &newval))
4905 (errcode(ERRCODE_INVALID_PARAMETER_VALUE),
4906 errmsg("parameter \"%s\" requires a numeric value",
4910 if (newval < conf->min || newval > conf->max)
4913 (errcode(ERRCODE_INVALID_PARAMETER_VALUE),
4914 errmsg("%g is outside the valid range for parameter \"%s\" (%g .. %g)",
4915 newval, name, conf->min, conf->max)));
4919 else if (source == PGC_S_DEFAULT)
4920 newval = conf->boot_val;
4923 newval = conf->reset_val;
4924 source = conf->gen.reset_source;
4927 /* Save old value to support transaction abort */
4928 if (changeVal && !makeDefault)
4929 push_old_value(&conf->gen, action);
4931 if (conf->assign_hook)
4932 if (!(*conf->assign_hook) (newval, changeVal, source))
4935 (errcode(ERRCODE_INVALID_PARAMETER_VALUE),
4936 errmsg("invalid value for parameter \"%s\": %g",
4943 *conf->variable = newval;
4944 conf->gen.source = source;
4950 if (conf->gen.reset_source <= source)
4952 conf->reset_val = newval;
4953 conf->gen.reset_source = source;
4955 for (stack = conf->gen.stack; stack; stack = stack->prev)
4957 if (stack->source <= source)
4959 stack->prior.realval = newval;
4960 stack->source = source;
4969 struct config_string *conf = (struct config_string *) record;
4974 newval = guc_strdup(elevel, value);
4979 * The only sort of "parsing" check we need to do is apply
4980 * truncation if GUC_IS_NAME.
4982 if (conf->gen.flags & GUC_IS_NAME)
4983 truncate_identifier(newval, strlen(newval), true);
4985 else if (source == PGC_S_DEFAULT)
4987 if (conf->boot_val == NULL)
4991 newval = guc_strdup(elevel, conf->boot_val);
4999 * We could possibly avoid strdup here, but easier to make
5000 * this case work the same as the normal assignment case;
5001 * note the possible free of newval below.
5003 if (conf->reset_val == NULL)
5007 newval = guc_strdup(elevel, conf->reset_val);
5011 source = conf->gen.reset_source;
5014 /* Save old value to support transaction abort */
5015 if (changeVal && !makeDefault)
5016 push_old_value(&conf->gen, action);
5018 if (conf->assign_hook && newval)
5020 const char *hookresult;
5023 * If the hook ereports, we have to make sure we free
5024 * newval, else it will be a permanent memory leak.
5026 hookresult = call_string_assign_hook(conf->assign_hook,
5030 if (hookresult == NULL)
5034 (errcode(ERRCODE_INVALID_PARAMETER_VALUE),
5035 errmsg("invalid value for parameter \"%s\": \"%s\"",
5036 name, value ? value : "")));
5039 else if (hookresult != newval)
5044 * Having to cast away const here is annoying, but the
5045 * alternative is to declare assign_hooks as returning
5046 * char*, which would mean they'd have to cast away
5047 * const, or as both taking and returning char*, which
5048 * doesn't seem attractive either --- we don't want
5049 * them to scribble on the passed str.
5051 newval = (char *) hookresult;
5057 set_string_field(conf, conf->variable, newval);
5058 conf->gen.source = source;
5064 if (conf->gen.reset_source <= source)
5066 set_string_field(conf, &conf->reset_val, newval);
5067 conf->gen.reset_source = source;
5069 for (stack = conf->gen.stack; stack; stack = stack->prev)
5071 if (stack->source <= source)
5073 set_string_field(conf, &stack->prior.stringval,
5075 stack->source = source;
5079 /* Perhaps we didn't install newval anywhere */
5080 if (newval && !string_field_used(conf, newval))
5086 struct config_enum *conf = (struct config_enum *) record;
5091 if (!config_enum_lookup_by_name(conf, value, &newval))
5095 hintmsg = config_enum_get_options(conf,
5096 "Available values: ",
5100 (errcode(ERRCODE_INVALID_PARAMETER_VALUE),
5101 errmsg("invalid value for parameter \"%s\": \"%s\"",
5103 hintmsg ? errhint("%s", _(hintmsg)) : 0));
5110 else if (source == PGC_S_DEFAULT)
5111 newval = conf->boot_val;
5114 newval = conf->reset_val;
5115 source = conf->gen.reset_source;
5118 /* Save old value to support transaction abort */
5119 if (changeVal && !makeDefault)
5120 push_old_value(&conf->gen, action);
5122 if (conf->assign_hook)
5123 if (!(*conf->assign_hook) (newval, changeVal, source))
5126 (errcode(ERRCODE_INVALID_PARAMETER_VALUE),
5127 errmsg("invalid value for parameter \"%s\": \"%s\"",
5129 config_enum_lookup_by_value(conf, newval))));
5135 *conf->variable = newval;
5136 conf->gen.source = source;
5142 if (conf->gen.reset_source <= source)
5144 conf->reset_val = newval;
5145 conf->gen.reset_source = source;
5147 for (stack = conf->gen.stack; stack; stack = stack->prev)
5149 if (stack->source <= source)
5151 stack->prior.enumval = newval;
5152 stack->source = source;
5160 if (changeVal && (record->flags & GUC_REPORT))
5161 ReportGUCOption(record);
5168 * Set the fields for source file and line number the setting came from.
5171 set_config_sourcefile(const char *name, char *sourcefile, int sourceline)
5173 struct config_generic *record;
5177 * To avoid cluttering the log, only the postmaster bleats loudly about
5178 * problems with the config file.
5180 elevel = IsUnderPostmaster ? DEBUG3 : LOG;
5182 record = find_option(name, true, elevel);
5183 /* should not happen */
5185 elog(ERROR, "unrecognized configuration parameter \"%s\"", name);
5187 sourcefile = guc_strdup(elevel, sourcefile);
5188 if (record->sourcefile)
5189 free(record->sourcefile);
5190 record->sourcefile = sourcefile;
5191 record->sourceline = sourceline;
5195 * Set a config option to the given value. See also set_config_option,
5196 * this is just the wrapper to be called from outside GUC. NB: this
5197 * is used only for non-transactional operations.
5199 * Note: there is no support here for setting source file/line, as it
5200 * is currently not needed.
5203 SetConfigOption(const char *name, const char *value,
5204 GucContext context, GucSource source)
5206 (void) set_config_option(name, value, context, source,
5207 GUC_ACTION_SET, true);
5213 * Fetch the current value of the option `name'. If the option doesn't exist,
5214 * throw an ereport and don't return.
5216 * If restrict_superuser is true, we also enforce that only superusers can
5217 * see GUC_SUPERUSER_ONLY variables. This should only be passed as true
5218 * in user-driven calls.
5220 * The string is *not* allocated for modification and is really only
5221 * valid until the next call to configuration related functions.
5224 GetConfigOption(const char *name, bool restrict_superuser)
5226 struct config_generic *record;
5227 static char buffer[256];
5229 record = find_option(name, false, ERROR);
5232 (errcode(ERRCODE_UNDEFINED_OBJECT),
5233 errmsg("unrecognized configuration parameter \"%s\"", name)));
5234 if (restrict_superuser &&
5235 (record->flags & GUC_SUPERUSER_ONLY) &&
5238 (errcode(ERRCODE_INSUFFICIENT_PRIVILEGE),
5239 errmsg("must be superuser to examine \"%s\"", name)));
5241 switch (record->vartype)
5244 return *((struct config_bool *) record)->variable ? "on" : "off";
5247 snprintf(buffer, sizeof(buffer), "%d",
5248 *((struct config_int *) record)->variable);
5252 snprintf(buffer, sizeof(buffer), "%g",
5253 *((struct config_real *) record)->variable);
5257 return *((struct config_string *) record)->variable;
5260 return config_enum_lookup_by_value((struct config_enum *) record,
5261 *((struct config_enum *) record)->variable);
5267 * Get the RESET value associated with the given option.
5269 * Note: this is not re-entrant, due to use of static result buffer;
5270 * not to mention that a string variable could have its reset_val changed.
5271 * Beware of assuming the result value is good for very long.
5274 GetConfigOptionResetString(const char *name)
5276 struct config_generic *record;
5277 static char buffer[256];
5279 record = find_option(name, false, ERROR);
5282 (errcode(ERRCODE_UNDEFINED_OBJECT),
5283 errmsg("unrecognized configuration parameter \"%s\"", name)));
5284 if ((record->flags & GUC_SUPERUSER_ONLY) && !superuser())
5286 (errcode(ERRCODE_INSUFFICIENT_PRIVILEGE),
5287 errmsg("must be superuser to examine \"%s\"", name)));
5289 switch (record->vartype)
5292 return ((struct config_bool *) record)->reset_val ? "on" : "off";
5295 snprintf(buffer, sizeof(buffer), "%d",
5296 ((struct config_int *) record)->reset_val);
5300 snprintf(buffer, sizeof(buffer), "%g",
5301 ((struct config_real *) record)->reset_val);
5305 return ((struct config_string *) record)->reset_val;
5308 return config_enum_lookup_by_value((struct config_enum *) record,
5309 ((struct config_enum *) record)->reset_val);
5316 * GUC_complaint_elevel
5317 * Get the ereport error level to use in an assign_hook's error report.
5319 * This should be used by assign hooks that want to emit a custom error
5320 * report (in addition to the generic "invalid value for option FOO" that
5321 * guc.c will provide). Note that the result might be ERROR or a lower
5322 * level, so the caller must be prepared for control to return from ereport,
5323 * or not. If control does return, return false/NULL from the hook function.
5325 * At some point it'd be nice to replace this with a mechanism that allows
5326 * the custom message to become the DETAIL line of guc.c's generic message.
5329 GUC_complaint_elevel(GucSource source)
5333 if (source == PGC_S_FILE)
5336 * To avoid cluttering the log, only the postmaster bleats loudly
5337 * about problems with the config file.
5339 elevel = IsUnderPostmaster ? DEBUG3 : LOG;
5341 else if (source == PGC_S_OVERRIDE)
5344 * If we're a postmaster child, this is probably "undo" during
5345 * transaction abort, so we don't want to clutter the log. There's a
5346 * small chance of a real problem with an OVERRIDE setting, though, so
5347 * suppressing the message entirely wouldn't be desirable.
5349 elevel = IsUnderPostmaster ? DEBUG5 : LOG;
5351 else if (source < PGC_S_INTERACTIVE)
5361 * flatten_set_variable_args
5362 * Given a parsenode List as emitted by the grammar for SET,
5363 * convert to the flat string representation used by GUC.
5365 * We need to be told the name of the variable the args are for, because
5366 * the flattening rules vary (ugh).
5368 * The result is NULL if args is NIL (ie, SET ... TO DEFAULT), otherwise
5369 * a palloc'd string.
5372 flatten_set_variable_args(const char *name, List *args)
5374 struct config_generic *record;
5379 /* Fast path if just DEFAULT */
5383 /* Else get flags for the variable */
5384 record = find_option(name, true, ERROR);
5387 (errcode(ERRCODE_UNDEFINED_OBJECT),
5388 errmsg("unrecognized configuration parameter \"%s\"", name)));
5390 flags = record->flags;
5392 /* Complain if list input and non-list variable */
5393 if ((flags & GUC_LIST_INPUT) == 0 &&
5394 list_length(args) != 1)
5396 (errcode(ERRCODE_INVALID_PARAMETER_VALUE),
5397 errmsg("SET %s takes only one argument", name)));
5399 initStringInfo(&buf);
5402 * Each list member may be a plain A_Const node, or an A_Const within a
5403 * TypeCast; the latter case is supported only for ConstInterval arguments
5404 * (for SET TIME ZONE).
5408 Node *arg = (Node *) lfirst(l);
5410 TypeName *typeName = NULL;
5413 if (l != list_head(args))
5414 appendStringInfo(&buf, ", ");
5416 if (IsA(arg, TypeCast))
5418 TypeCast *tc = (TypeCast *) arg;
5421 typeName = tc->typeName;
5424 if (!IsA(arg, A_Const))
5425 elog(ERROR, "unrecognized node type: %d", (int) nodeTag(arg));
5426 con = (A_Const *) arg;
5428 switch (nodeTag(&con->val))
5431 appendStringInfo(&buf, "%ld", intVal(&con->val));
5434 /* represented as a string, so just copy it */
5435 appendStringInfoString(&buf, strVal(&con->val));
5438 val = strVal(&con->val);
5439 if (typeName != NULL)
5442 * Must be a ConstInterval argument for TIME ZONE. Coerce
5443 * to interval and back to normalize the value and account
5451 typoid = typenameTypeId(NULL, typeName, &typmod);
5452 Assert(typoid == INTERVALOID);
5455 DirectFunctionCall3(interval_in,
5456 CStringGetDatum(val),
5457 ObjectIdGetDatum(InvalidOid),
5458 Int32GetDatum(typmod));
5461 DatumGetCString(DirectFunctionCall1(interval_out,
5463 appendStringInfo(&buf, "INTERVAL '%s'", intervalout);
5468 * Plain string literal or identifier. For quote mode,
5469 * quote it if it's not a vanilla identifier.
5471 if (flags & GUC_LIST_QUOTE)
5472 appendStringInfoString(&buf, quote_identifier(val));
5474 appendStringInfoString(&buf, val);
5478 elog(ERROR, "unrecognized node type: %d",
5479 (int) nodeTag(&con->val));
5492 ExecSetVariableStmt(VariableSetStmt *stmt)
5494 GucAction action = stmt->is_local ? GUC_ACTION_LOCAL : GUC_ACTION_SET;
5499 case VAR_SET_CURRENT:
5500 set_config_option(stmt->name,
5501 ExtractSetVariableArgs(stmt),
5502 (superuser() ? PGC_SUSET : PGC_USERSET),
5510 * Special case for special SQL syntax that effectively sets more
5511 * than one variable per statement.
5513 if (strcmp(stmt->name, "TRANSACTION") == 0)
5517 foreach(head, stmt->args)
5519 DefElem *item = (DefElem *) lfirst(head);
5521 if (strcmp(item->defname, "transaction_isolation") == 0)
5522 SetPGVariable("transaction_isolation",
5523 list_make1(item->arg), stmt->is_local);
5524 else if (strcmp(item->defname, "transaction_read_only") == 0)
5525 SetPGVariable("transaction_read_only",
5526 list_make1(item->arg), stmt->is_local);
5528 elog(ERROR, "unexpected SET TRANSACTION element: %s",
5532 else if (strcmp(stmt->name, "SESSION CHARACTERISTICS") == 0)
5536 foreach(head, stmt->args)
5538 DefElem *item = (DefElem *) lfirst(head);
5540 if (strcmp(item->defname, "transaction_isolation") == 0)
5541 SetPGVariable("default_transaction_isolation",
5542 list_make1(item->arg), stmt->is_local);
5543 else if (strcmp(item->defname, "transaction_read_only") == 0)
5544 SetPGVariable("default_transaction_read_only",
5545 list_make1(item->arg), stmt->is_local);
5547 elog(ERROR, "unexpected SET SESSION element: %s",
5552 elog(ERROR, "unexpected SET MULTI element: %s",
5555 case VAR_SET_DEFAULT:
5557 set_config_option(stmt->name,
5559 (superuser() ? PGC_SUSET : PGC_USERSET),
5571 * Get the value to assign for a VariableSetStmt, or NULL if it's RESET.
5572 * The result is palloc'd.
5574 * This is exported for use by actions such as ALTER ROLE SET.
5577 ExtractSetVariableArgs(VariableSetStmt *stmt)
5582 return flatten_set_variable_args(stmt->name, stmt->args);
5583 case VAR_SET_CURRENT:
5584 return GetConfigOptionByName(stmt->name, NULL);
5591 * SetPGVariable - SET command exported as an easily-C-callable function.
5593 * This provides access to SET TO value, as well as SET TO DEFAULT (expressed
5594 * by passing args == NIL), but not SET FROM CURRENT functionality.
5597 SetPGVariable(const char *name, List *args, bool is_local)
5599 char *argstring = flatten_set_variable_args(name, args);
5601 /* Note SET DEFAULT (argstring == NULL) is equivalent to RESET */
5602 set_config_option(name,
5604 (superuser() ? PGC_SUSET : PGC_USERSET),
5606 is_local ? GUC_ACTION_LOCAL : GUC_ACTION_SET,
5611 * SET command wrapped as a SQL callable function.
5614 set_config_by_name(PG_FUNCTION_ARGS)
5621 if (PG_ARGISNULL(0))
5623 (errcode(ERRCODE_NULL_VALUE_NOT_ALLOWED),
5624 errmsg("SET requires parameter name")));
5626 /* Get the GUC variable name */
5627 name = TextDatumGetCString(PG_GETARG_DATUM(0));
5629 /* Get the desired value or set to NULL for a reset request */
5630 if (PG_ARGISNULL(1))
5633 value = TextDatumGetCString(PG_GETARG_DATUM(1));
5636 * Get the desired state of is_local. Default to false if provided value
5639 if (PG_ARGISNULL(2))
5642 is_local = PG_GETARG_BOOL(2);
5644 /* Note SET DEFAULT (argstring == NULL) is equivalent to RESET */
5645 set_config_option(name,
5647 (superuser() ? PGC_SUSET : PGC_USERSET),
5649 is_local ? GUC_ACTION_LOCAL : GUC_ACTION_SET,
5652 /* get the new current value */
5653 new_value = GetConfigOptionByName(name, NULL);
5655 /* Convert return string to text */
5656 PG_RETURN_TEXT_P(cstring_to_text(new_value));
5661 * Common code for DefineCustomXXXVariable subroutines: allocate the
5662 * new variable's config struct and fill in generic fields.
5664 static struct config_generic *
5665 init_custom_variable(const char *name,
5666 const char *short_desc,
5667 const char *long_desc,
5670 enum config_type type,
5673 struct config_generic *gen;
5676 * Only allow custom PGC_POSTMASTER variables to be created during shared
5677 * library preload; any later than that, we can't ensure that the value
5678 * doesn't change after startup. This is a fatal elog if it happens; just
5679 * erroring out isn't safe because we don't know what the calling loadable
5680 * module might already have hooked into.
5682 if (context == PGC_POSTMASTER &&
5683 !process_shared_preload_libraries_in_progress)
5684 elog(FATAL, "cannot create PGC_POSTMASTER variables after startup");
5686 gen = (struct config_generic *) guc_malloc(ERROR, sz);
5689 gen->name = guc_strdup(ERROR, name);
5690 gen->context = context;
5691 gen->group = CUSTOM_OPTIONS;
5692 gen->short_desc = short_desc;
5693 gen->long_desc = long_desc;
5695 gen->vartype = type;
5701 * Common code for DefineCustomXXXVariable subroutines: insert the new
5702 * variable into the GUC variable array, replacing any placeholder.
5705 define_custom_variable(struct config_generic * variable)
5707 const char *name = variable->name;
5708 const char **nameAddr = &name;
5710 struct config_string *pHolder;
5711 GucContext phcontext;
5712 struct config_generic **res;
5715 * See if there's a placeholder by the same name.
5717 res = (struct config_generic **) bsearch((void *) &nameAddr,
5718 (void *) guc_variables,
5720 sizeof(struct config_generic *),
5725 * No placeholder to replace, so we can just add it ... but first,
5726 * make sure it's initialized to its default value.
5728 InitializeOneGUCOption(variable);
5729 add_guc_variable(variable, ERROR);
5734 * This better be a placeholder
5736 if (((*res)->flags & GUC_CUSTOM_PLACEHOLDER) == 0)
5738 (errcode(ERRCODE_INTERNAL_ERROR),
5739 errmsg("attempt to redefine parameter \"%s\"", name)));
5741 Assert((*res)->vartype == PGC_STRING);
5742 pHolder = (struct config_string *) (*res);
5745 * First, set the variable to its default value. We must do this even
5746 * though we intend to immediately apply a new value, since it's possible
5747 * that the new value is invalid.
5749 InitializeOneGUCOption(variable);
5752 * Replace the placeholder. We aren't changing the name, so no re-sorting
5758 * Infer context for assignment based on source of existing value. We
5759 * can't tell this with exact accuracy, but we can at least do something
5760 * reasonable in typical cases.
5762 switch (pHolder->gen.source)
5770 * If we got past the check in init_custom_variable, we can safely
5771 * assume that any existing value for a PGC_POSTMASTER variable
5772 * was set in postmaster context.
5774 if (variable->context == PGC_POSTMASTER)
5775 phcontext = PGC_POSTMASTER;
5777 phcontext = PGC_SIGHUP;
5779 case PGC_S_DATABASE:
5781 case PGC_S_DATABASE_USER:
5785 phcontext = PGC_USERSET;
5790 * Assign the string value stored in the placeholder to the real variable.
5792 * XXX this is not really good enough --- it should be a nontransactional
5793 * assignment, since we don't want it to roll back if the current xact
5794 * fails later. (Or do we?)
5796 value = *pHolder->variable;
5800 if (set_config_option(name, value,
5801 phcontext, pHolder->gen.source,
5802 GUC_ACTION_SET, true))
5804 /* Also copy over any saved source-location information */
5805 if (pHolder->gen.sourcefile)
5806 set_config_sourcefile(name, pHolder->gen.sourcefile,
5807 pHolder->gen.sourceline);
5812 * Free up as much as we conveniently can of the placeholder structure
5813 * (this neglects any stack items...)
5815 set_string_field(pHolder, pHolder->variable, NULL);
5816 set_string_field(pHolder, &pHolder->reset_val, NULL);
5822 DefineCustomBoolVariable(const char *name,
5823 const char *short_desc,
5824 const char *long_desc,
5829 GucBoolAssignHook assign_hook,
5830 GucShowHook show_hook)
5832 struct config_bool *var;
5834 var = (struct config_bool *)
5835 init_custom_variable(name, short_desc, long_desc, context, flags,
5836 PGC_BOOL, sizeof(struct config_bool));
5837 var->variable = valueAddr;
5838 var->boot_val = bootValue;
5839 var->reset_val = bootValue;
5840 var->assign_hook = assign_hook;
5841 var->show_hook = show_hook;
5842 define_custom_variable(&var->gen);
5846 DefineCustomIntVariable(const char *name,
5847 const char *short_desc,
5848 const char *long_desc,
5855 GucIntAssignHook assign_hook,
5856 GucShowHook show_hook)
5858 struct config_int *var;
5860 var = (struct config_int *)
5861 init_custom_variable(name, short_desc, long_desc, context, flags,
5862 PGC_INT, sizeof(struct config_int));
5863 var->variable = valueAddr;
5864 var->boot_val = bootValue;
5865 var->reset_val = bootValue;
5866 var->min = minValue;
5867 var->max = maxValue;
5868 var->assign_hook = assign_hook;
5869 var->show_hook = show_hook;
5870 define_custom_variable(&var->gen);
5874 DefineCustomRealVariable(const char *name,
5875 const char *short_desc,
5876 const char *long_desc,
5883 GucRealAssignHook assign_hook,
5884 GucShowHook show_hook)
5886 struct config_real *var;
5888 var = (struct config_real *)
5889 init_custom_variable(name, short_desc, long_desc, context, flags,
5890 PGC_REAL, sizeof(struct config_real));
5891 var->variable = valueAddr;
5892 var->boot_val = bootValue;
5893 var->reset_val = bootValue;
5894 var->min = minValue;
5895 var->max = maxValue;
5896 var->assign_hook = assign_hook;
5897 var->show_hook = show_hook;
5898 define_custom_variable(&var->gen);
5902 DefineCustomStringVariable(const char *name,
5903 const char *short_desc,
5904 const char *long_desc,
5906 const char *bootValue,
5909 GucStringAssignHook assign_hook,
5910 GucShowHook show_hook)
5912 struct config_string *var;
5914 var = (struct config_string *)
5915 init_custom_variable(name, short_desc, long_desc, context, flags,
5916 PGC_STRING, sizeof(struct config_string));
5917 var->variable = valueAddr;
5918 var->boot_val = bootValue;
5919 /* we could probably do without strdup, but keep it like normal case */
5921 var->reset_val = guc_strdup(ERROR, var->boot_val);
5922 var->assign_hook = assign_hook;
5923 var->show_hook = show_hook;
5924 define_custom_variable(&var->gen);
5928 DefineCustomEnumVariable(const char *name,
5929 const char *short_desc,
5930 const char *long_desc,
5933 const struct config_enum_entry * options,
5936 GucEnumAssignHook assign_hook,
5937 GucShowHook show_hook)
5939 struct config_enum *var;
5941 var = (struct config_enum *)
5942 init_custom_variable(name, short_desc, long_desc, context, flags,
5943 PGC_ENUM, sizeof(struct config_enum));
5944 var->variable = valueAddr;
5945 var->boot_val = bootValue;
5946 var->reset_val = bootValue;
5947 var->options = options;
5948 var->assign_hook = assign_hook;
5949 var->show_hook = show_hook;
5950 define_custom_variable(&var->gen);
5954 EmitWarningsOnPlaceholders(const char *className)
5956 int classLen = strlen(className);
5959 for (i = 0; i < num_guc_variables; i++)
5961 struct config_generic *var = guc_variables[i];
5963 if ((var->flags & GUC_CUSTOM_PLACEHOLDER) != 0 &&
5964 strncmp(className, var->name, classLen) == 0 &&
5965 var->name[classLen] == GUC_QUALIFIER_SEPARATOR)
5968 (errcode(ERRCODE_UNDEFINED_OBJECT),
5969 errmsg("unrecognized configuration parameter \"%s\"",
5980 GetPGVariable(const char *name, DestReceiver *dest)
5982 if (guc_name_compare(name, "all") == 0)
5983 ShowAllGUCConfig(dest);
5985 ShowGUCConfigOption(name, dest);
5989 GetPGVariableResultDesc(const char *name)
5993 if (guc_name_compare(name, "all") == 0)
5995 /* need a tuple descriptor representing three TEXT columns */
5996 tupdesc = CreateTemplateTupleDesc(3, false);
5997 TupleDescInitEntry(tupdesc, (AttrNumber) 1, "name",
5999 TupleDescInitEntry(tupdesc, (AttrNumber) 2, "setting",
6001 TupleDescInitEntry(tupdesc, (AttrNumber) 3, "description",
6006 const char *varname;
6008 /* Get the canonical spelling of name */
6009 (void) GetConfigOptionByName(name, &varname);
6011 /* need a tuple descriptor representing a single TEXT column */
6012 tupdesc = CreateTemplateTupleDesc(1, false);
6013 TupleDescInitEntry(tupdesc, (AttrNumber) 1, varname,
6024 ShowGUCConfigOption(const char *name, DestReceiver *dest)
6026 TupOutputState *tstate;
6028 const char *varname;
6031 /* Get the value and canonical spelling of name */
6032 value = GetConfigOptionByName(name, &varname);
6034 /* need a tuple descriptor representing a single TEXT column */
6035 tupdesc = CreateTemplateTupleDesc(1, false);
6036 TupleDescInitEntry(tupdesc, (AttrNumber) 1, varname,
6039 /* prepare for projection of tuples */
6040 tstate = begin_tup_output_tupdesc(dest, tupdesc);
6043 do_text_output_oneline(tstate, value);
6045 end_tup_output(tstate);
6052 ShowAllGUCConfig(DestReceiver *dest)
6054 bool am_superuser = superuser();
6056 TupOutputState *tstate;
6059 bool isnull[3] = { false, false, false };
6061 /* need a tuple descriptor representing three TEXT columns */
6062 tupdesc = CreateTemplateTupleDesc(3, false);
6063 TupleDescInitEntry(tupdesc, (AttrNumber) 1, "name",
6065 TupleDescInitEntry(tupdesc, (AttrNumber) 2, "setting",
6067 TupleDescInitEntry(tupdesc, (AttrNumber) 3, "description",
6070 /* prepare for projection of tuples */
6071 tstate = begin_tup_output_tupdesc(dest, tupdesc);
6073 for (i = 0; i < num_guc_variables; i++)
6075 struct config_generic *conf = guc_variables[i];
6078 if ((conf->flags & GUC_NO_SHOW_ALL) ||
6079 ((conf->flags & GUC_SUPERUSER_ONLY) && !am_superuser))
6082 /* assign to the values array */
6083 values[0] = PointerGetDatum(cstring_to_text(conf->name));
6085 setting = _ShowOption(conf, true);
6088 values[1] = PointerGetDatum(cstring_to_text(setting));
6093 values[1] = PointerGetDatum(NULL);
6097 values[2] = PointerGetDatum(cstring_to_text(conf->short_desc));
6099 /* send it to dest */
6100 do_tup_output(tstate, values, isnull);
6103 pfree(DatumGetPointer(values[0]));
6107 pfree(DatumGetPointer(values[1]));
6109 pfree(DatumGetPointer(values[2]));
6112 end_tup_output(tstate);
6116 * Return GUC variable value by name; optionally return canonical
6117 * form of name. Return value is palloc'd.
6120 GetConfigOptionByName(const char *name, const char **varname)
6122 struct config_generic *record;
6124 record = find_option(name, false, ERROR);
6127 (errcode(ERRCODE_UNDEFINED_OBJECT),
6128 errmsg("unrecognized configuration parameter \"%s\"", name)));
6129 if ((record->flags & GUC_SUPERUSER_ONLY) && !superuser())
6131 (errcode(ERRCODE_INSUFFICIENT_PRIVILEGE),
6132 errmsg("must be superuser to examine \"%s\"", name)));
6135 *varname = record->name;
6137 return _ShowOption(record, true);
6141 * Return GUC variable value by variable number; optionally return canonical
6142 * form of name. Return value is palloc'd.
6145 GetConfigOptionByNum(int varnum, const char **values, bool *noshow)
6148 struct config_generic *conf;
6150 /* check requested variable number valid */
6151 Assert((varnum >= 0) && (varnum < num_guc_variables));
6153 conf = guc_variables[varnum];
6157 if ((conf->flags & GUC_NO_SHOW_ALL) ||
6158 ((conf->flags & GUC_SUPERUSER_ONLY) && !superuser()))
6164 /* first get the generic attributes */
6167 values[0] = conf->name;
6169 /* setting : use _ShowOption in order to avoid duplicating the logic */
6170 values[1] = _ShowOption(conf, false);
6173 if (conf->vartype == PGC_INT)
6177 switch (conf->flags & (GUC_UNIT_MEMORY | GUC_UNIT_TIME))
6182 case GUC_UNIT_BLOCKS:
6183 snprintf(buf, sizeof(buf), "%dkB", BLCKSZ / 1024);
6186 case GUC_UNIT_XBLOCKS:
6187 snprintf(buf, sizeof(buf), "%dkB", XLOG_BLCKSZ / 1024);
6208 values[3] = config_group_names[conf->group];
6211 values[4] = conf->short_desc;
6214 values[5] = conf->long_desc;
6217 values[6] = GucContext_Names[conf->context];
6220 values[7] = config_type_names[conf->vartype];
6223 values[8] = GucSource_Names[conf->source];
6225 /* now get the type specifc attributes */
6226 switch (conf->vartype)
6230 struct config_bool *lconf = (struct config_bool *) conf;
6242 values[12] = pstrdup(lconf->boot_val ? "on" : "off");
6245 values[13] = pstrdup(lconf->reset_val ? "on" : "off");
6251 struct config_int *lconf = (struct config_int *) conf;
6254 snprintf(buffer, sizeof(buffer), "%d", lconf->min);
6255 values[9] = pstrdup(buffer);
6258 snprintf(buffer, sizeof(buffer), "%d", lconf->max);
6259 values[10] = pstrdup(buffer);
6265 snprintf(buffer, sizeof(buffer), "%d", lconf->boot_val);
6266 values[12] = pstrdup(buffer);
6269 snprintf(buffer, sizeof(buffer), "%d", lconf->reset_val);
6270 values[13] = pstrdup(buffer);
6276 struct config_real *lconf = (struct config_real *) conf;
6279 snprintf(buffer, sizeof(buffer), "%g", lconf->min);
6280 values[9] = pstrdup(buffer);
6283 snprintf(buffer, sizeof(buffer), "%g", lconf->max);
6284 values[10] = pstrdup(buffer);
6290 snprintf(buffer, sizeof(buffer), "%g", lconf->boot_val);
6291 values[12] = pstrdup(buffer);
6294 snprintf(buffer, sizeof(buffer), "%g", lconf->reset_val);
6295 values[13] = pstrdup(buffer);
6301 struct config_string *lconf = (struct config_string *) conf;
6313 if (lconf->boot_val == NULL)
6316 values[12] = pstrdup(lconf->boot_val);
6319 if (lconf->reset_val == NULL)
6322 values[13] = pstrdup(lconf->reset_val);
6328 struct config_enum *lconf = (struct config_enum *) conf;
6339 * NOTE! enumvals with double quotes in them are not
6342 values[11] = config_enum_get_options((struct config_enum *) conf,
6343 "{\"", "\"}", "\",\"");
6346 values[12] = pstrdup(config_enum_lookup_by_value(lconf,
6350 values[13] = pstrdup(config_enum_lookup_by_value(lconf,
6358 * should never get here, but in case we do, set 'em to NULL
6380 * If the setting came from a config file, set the source location. For
6381 * security reasons, we don't show source file/line number for
6384 if (conf->source == PGC_S_FILE && superuser())
6386 values[14] = conf->sourcefile;
6387 snprintf(buffer, sizeof(buffer), "%d", conf->sourceline);
6388 values[15] = pstrdup(buffer);
6398 * Return the total number of GUC variables
6401 GetNumConfigOptions(void)
6403 return num_guc_variables;
6407 * show_config_by_name - equiv to SHOW X command but implemented as
6411 show_config_by_name(PG_FUNCTION_ARGS)
6416 /* Get the GUC variable name */
6417 varname = TextDatumGetCString(PG_GETARG_DATUM(0));
6420 varval = GetConfigOptionByName(varname, NULL);
6422 /* Convert to text */
6423 PG_RETURN_TEXT_P(cstring_to_text(varval));
6427 * show_all_settings - equiv to SHOW ALL command but implemented as
6430 #define NUM_PG_SETTINGS_ATTS 16
6433 show_all_settings(PG_FUNCTION_ARGS)
6435 FuncCallContext *funcctx;
6439 AttInMetadata *attinmeta;
6440 MemoryContext oldcontext;
6442 /* stuff done only on the first call of the function */
6443 if (SRF_IS_FIRSTCALL())
6445 /* create a function context for cross-call persistence */
6446 funcctx = SRF_FIRSTCALL_INIT();
6449 * switch to memory context appropriate for multiple function calls
6451 oldcontext = MemoryContextSwitchTo(funcctx->multi_call_memory_ctx);
6454 * need a tuple descriptor representing NUM_PG_SETTINGS_ATTS columns
6455 * of the appropriate types
6457 tupdesc = CreateTemplateTupleDesc(NUM_PG_SETTINGS_ATTS, false);
6458 TupleDescInitEntry(tupdesc, (AttrNumber) 1, "name",
6460 TupleDescInitEntry(tupdesc, (AttrNumber) 2, "setting",
6462 TupleDescInitEntry(tupdesc, (AttrNumber) 3, "unit",
6464 TupleDescInitEntry(tupdesc, (AttrNumber) 4, "category",
6466 TupleDescInitEntry(tupdesc, (AttrNumber) 5, "short_desc",
6468 TupleDescInitEntry(tupdesc, (AttrNumber) 6, "extra_desc",
6470 TupleDescInitEntry(tupdesc, (AttrNumber) 7, "context",
6472 TupleDescInitEntry(tupdesc, (AttrNumber) 8, "vartype",
6474 TupleDescInitEntry(tupdesc, (AttrNumber) 9, "source",
6476 TupleDescInitEntry(tupdesc, (AttrNumber) 10, "min_val",
6478 TupleDescInitEntry(tupdesc, (AttrNumber) 11, "max_val",
6480 TupleDescInitEntry(tupdesc, (AttrNumber) 12, "enumvals",
6481 TEXTARRAYOID, -1, 0);
6482 TupleDescInitEntry(tupdesc, (AttrNumber) 13, "boot_val",
6484 TupleDescInitEntry(tupdesc, (AttrNumber) 14, "reset_val",
6486 TupleDescInitEntry(tupdesc, (AttrNumber) 15, "sourcefile",
6488 TupleDescInitEntry(tupdesc, (AttrNumber) 16, "sourceline",
6492 * Generate attribute metadata needed later to produce tuples from raw
6495 attinmeta = TupleDescGetAttInMetadata(tupdesc);
6496 funcctx->attinmeta = attinmeta;
6498 /* total number of tuples to be returned */
6499 funcctx->max_calls = GetNumConfigOptions();
6501 MemoryContextSwitchTo(oldcontext);
6504 /* stuff done on every call of the function */
6505 funcctx = SRF_PERCALL_SETUP();
6507 call_cntr = funcctx->call_cntr;
6508 max_calls = funcctx->max_calls;
6509 attinmeta = funcctx->attinmeta;
6511 if (call_cntr < max_calls) /* do when there is more left to send */
6513 char *values[NUM_PG_SETTINGS_ATTS];
6519 * Get the next visible GUC variable name and value
6523 GetConfigOptionByNum(call_cntr, (const char **) values, &noshow);
6526 /* bump the counter and get the next config setting */
6527 call_cntr = ++funcctx->call_cntr;
6529 /* make sure we haven't gone too far now */
6530 if (call_cntr >= max_calls)
6531 SRF_RETURN_DONE(funcctx);
6536 tuple = BuildTupleFromCStrings(attinmeta, values);
6538 /* make the tuple into a datum */
6539 result = HeapTupleGetDatum(tuple);
6541 SRF_RETURN_NEXT(funcctx, result);
6545 /* do when there is no more left */
6546 SRF_RETURN_DONE(funcctx);
6551 _ShowOption(struct config_generic * record, bool use_units)
6556 switch (record->vartype)
6560 struct config_bool *conf = (struct config_bool *) record;
6562 if (conf->show_hook)
6563 val = (*conf->show_hook) ();
6565 val = *conf->variable ? "on" : "off";
6571 struct config_int *conf = (struct config_int *) record;
6573 if (conf->show_hook)
6574 val = (*conf->show_hook) ();
6578 * Use int64 arithmetic to avoid overflows in units
6579 * conversion. If INT64_IS_BUSTED we might overflow
6580 * anyway and print bogus answers, but there are few
6581 * enough such machines that it doesn't seem worth trying
6584 int64 result = *conf->variable;
6587 if (use_units && result > 0 &&
6588 (record->flags & GUC_UNIT_MEMORY))
6590 switch (record->flags & GUC_UNIT_MEMORY)
6592 case GUC_UNIT_BLOCKS:
6593 result *= BLCKSZ / 1024;
6595 case GUC_UNIT_XBLOCKS:
6596 result *= XLOG_BLCKSZ / 1024;
6600 if (result % KB_PER_GB == 0)
6602 result /= KB_PER_GB;
6605 else if (result % KB_PER_MB == 0)
6607 result /= KB_PER_MB;
6615 else if (use_units && result > 0 &&
6616 (record->flags & GUC_UNIT_TIME))
6618 switch (record->flags & GUC_UNIT_TIME)
6624 result *= MS_PER_MIN;
6628 if (result % MS_PER_D == 0)
6633 else if (result % MS_PER_H == 0)
6638 else if (result % MS_PER_MIN == 0)
6640 result /= MS_PER_MIN;
6643 else if (result % MS_PER_S == 0)
6656 snprintf(buffer, sizeof(buffer), INT64_FORMAT "%s",
6665 struct config_real *conf = (struct config_real *) record;
6667 if (conf->show_hook)
6668 val = (*conf->show_hook) ();
6671 snprintf(buffer, sizeof(buffer), "%g",
6680 struct config_string *conf = (struct config_string *) record;
6682 if (conf->show_hook)
6683 val = (*conf->show_hook) ();
6684 else if (*conf->variable && **conf->variable)
6685 val = *conf->variable;
6693 struct config_enum *conf = (struct config_enum *) record;
6695 if (conf->show_hook)
6696 val = (*conf->show_hook) ();
6698 val = config_enum_lookup_by_value(conf, *conf->variable);
6703 /* just to keep compiler quiet */
6708 return pstrdup(val);
6713 * Attempt (badly) to detect if a proposed new GUC setting is the same
6714 * as the current value.
6716 * XXX this does not really work because it doesn't account for the
6717 * effects of canonicalization of string values by assign_hooks.
6720 is_newvalue_equal(struct config_generic * record, const char *newvalue)
6722 /* newvalue == NULL isn't supported */
6723 Assert(newvalue != NULL);
6725 switch (record->vartype)
6729 struct config_bool *conf = (struct config_bool *) record;
6732 return parse_bool(newvalue, &newval)
6733 && *conf->variable == newval;
6737 struct config_int *conf = (struct config_int *) record;
6740 return parse_int(newvalue, &newval, record->flags, NULL)
6741 && *conf->variable == newval;
6745 struct config_real *conf = (struct config_real *) record;
6748 return parse_real(newvalue, &newval)
6749 && *conf->variable == newval;
6753 struct config_string *conf = (struct config_string *) record;
6755 return *conf->variable != NULL &&
6756 strcmp(*conf->variable, newvalue) == 0;
6761 struct config_enum *conf = (struct config_enum *) record;
6764 return config_enum_lookup_by_name(conf, newvalue, &newval) &&
6765 *conf->variable == newval;
6776 * These routines dump out all non-default GUC options into a binary
6777 * file that is read by all exec'ed backends. The format is:
6779 * variable name, string, null terminated
6780 * variable value, string, null terminated
6781 * variable source, integer
6784 write_one_nondefault_variable(FILE *fp, struct config_generic * gconf)
6786 if (gconf->source == PGC_S_DEFAULT)
6789 fprintf(fp, "%s", gconf->name);
6792 switch (gconf->vartype)
6796 struct config_bool *conf = (struct config_bool *) gconf;
6798 if (*conf->variable)
6799 fprintf(fp, "true");
6801 fprintf(fp, "false");
6807 struct config_int *conf = (struct config_int *) gconf;
6809 fprintf(fp, "%d", *conf->variable);
6815 struct config_real *conf = (struct config_real *) gconf;
6817 /* Could lose precision here? */
6818 fprintf(fp, "%f", *conf->variable);
6824 struct config_string *conf = (struct config_string *) gconf;
6826 fprintf(fp, "%s", *conf->variable);
6832 struct config_enum *conf = (struct config_enum *) gconf;
6835 config_enum_lookup_by_value(conf, *conf->variable));
6842 fwrite(&gconf->source, sizeof(gconf->source), 1, fp);
6846 write_nondefault_variables(GucContext context)
6850 struct config_generic *cvc_conf;
6853 Assert(context == PGC_POSTMASTER || context == PGC_SIGHUP);
6855 elevel = (context == PGC_SIGHUP) ? LOG : ERROR;
6860 fp = AllocateFile(CONFIG_EXEC_PARAMS_NEW, "w");
6864 (errcode_for_file_access(),
6865 errmsg("could not write to file \"%s\": %m",
6866 CONFIG_EXEC_PARAMS_NEW)));
6871 * custom_variable_classes must be written out first; otherwise we might
6872 * reject custom variable values while reading the file.
6874 cvc_conf = find_option("custom_variable_classes", false, ERROR);
6876 write_one_nondefault_variable(fp, cvc_conf);
6878 for (i = 0; i < num_guc_variables; i++)
6880 struct config_generic *gconf = guc_variables[i];
6882 if (gconf != cvc_conf)
6883 write_one_nondefault_variable(fp, gconf);
6889 (errcode_for_file_access(),
6890 errmsg("could not write to file \"%s\": %m",
6891 CONFIG_EXEC_PARAMS_NEW)));
6896 * Put new file in place. This could delay on Win32, but we don't hold
6897 * any exclusive locks.
6899 rename(CONFIG_EXEC_PARAMS_NEW, CONFIG_EXEC_PARAMS);
6904 * Read string, including null byte from file
6906 * Return NULL on EOF and nothing read
6909 read_string_with_null(FILE *fp)
6918 if ((ch = fgetc(fp)) == EOF)
6923 elog(FATAL, "invalid format of exec config params file");
6926 str = guc_malloc(FATAL, maxlen);
6927 else if (i == maxlen)
6928 str = guc_realloc(FATAL, str, maxlen *= 2);
6937 * This routine loads a previous postmaster dump of its non-default
6941 read_nondefault_variables(void)
6951 fp = AllocateFile(CONFIG_EXEC_PARAMS, "r");
6954 /* File not found is fine */
6955 if (errno != ENOENT)
6957 (errcode_for_file_access(),
6958 errmsg("could not read from file \"%s\": %m",
6959 CONFIG_EXEC_PARAMS)));
6965 struct config_generic *record;
6967 if ((varname = read_string_with_null(fp)) == NULL)
6970 if ((record = find_option(varname, true, FATAL)) == NULL)
6971 elog(FATAL, "failed to locate variable %s in exec config params file", varname);
6972 if ((varvalue = read_string_with_null(fp)) == NULL)
6973 elog(FATAL, "invalid format of exec config params file");
6974 if (fread(&varsource, sizeof(varsource), 1, fp) == 0)
6975 elog(FATAL, "invalid format of exec config params file");
6977 (void) set_config_option(varname, varvalue, record->context,
6978 varsource, GUC_ACTION_SET, true);
6985 #endif /* EXEC_BACKEND */
6989 * A little "long argument" simulation, although not quite GNU
6990 * compliant. Takes a string of the form "some-option=some value" and
6991 * returns name = "some_option" and value = "some value" in malloc'ed
6992 * storage. Note that '-' is converted to '_' in the option name. If
6993 * there is no '=' in the input string then value will be NULL.
6996 ParseLongOption(const char *string, char **name, char **value)
7005 equal_pos = strcspn(string, "=");
7007 if (string[equal_pos] == '=')
7009 *name = guc_malloc(FATAL, equal_pos + 1);
7010 strlcpy(*name, string, equal_pos + 1);
7012 *value = guc_strdup(FATAL, &string[equal_pos + 1]);
7016 /* no equal sign in string */
7017 *name = guc_strdup(FATAL, string);
7021 for (cp = *name; *cp; cp++)
7028 * Handle options fetched from pg_database.datconfig, pg_authid.rolconfig,
7029 * pg_proc.proconfig, etc. Caller must specify proper context/source/action.
7031 * The array parameter must be an array of TEXT (it must not be NULL).
7034 ProcessGUCArray(ArrayType *array,
7035 GucContext context, GucSource source, GucAction action)
7039 Assert(array != NULL);
7040 Assert(ARR_ELEMTYPE(array) == TEXTOID);
7041 Assert(ARR_NDIM(array) == 1);
7042 Assert(ARR_LBOUND(array)[0] == 1);
7044 for (i = 1; i <= ARR_DIMS(array)[0]; i++)
7052 d = array_ref(array, 1, &i,
7053 -1 /* varlenarray */ ,
7054 -1 /* TEXT's typlen */ ,
7055 false /* TEXT's typbyval */ ,
7056 'i' /* TEXT's typalign */ ,
7062 s = TextDatumGetCString(d);
7064 ParseLongOption(s, &name, &value);
7068 (errcode(ERRCODE_SYNTAX_ERROR),
7069 errmsg("could not parse setting for parameter \"%s\"",
7075 (void) set_config_option(name, value, context, source, action, true);
7085 * Add an entry to an option array. The array parameter may be NULL
7086 * to indicate the current table entry is NULL.
7089 GUCArrayAdd(ArrayType *array, const char *name, const char *value)
7091 const char *varname;
7099 /* test if the option is valid */
7100 set_config_option(name, value,
7101 superuser() ? PGC_SUSET : PGC_USERSET,
7102 PGC_S_TEST, GUC_ACTION_SET, false);
7104 /* convert name to canonical spelling, so we can use plain strcmp */
7105 (void) GetConfigOptionByName(name, &varname);
7108 newval = palloc(strlen(name) + 1 + strlen(value) + 1);
7109 sprintf(newval, "%s=%s", name, value);
7110 datum = CStringGetTextDatum(newval);
7118 Assert(ARR_ELEMTYPE(array) == TEXTOID);
7119 Assert(ARR_NDIM(array) == 1);
7120 Assert(ARR_LBOUND(array)[0] == 1);
7122 index = ARR_DIMS(array)[0] + 1; /* add after end */
7124 for (i = 1; i <= ARR_DIMS(array)[0]; i++)
7129 d = array_ref(array, 1, &i,
7130 -1 /* varlenarray */ ,
7131 -1 /* TEXT's typlen */ ,
7132 false /* TEXT's typbyval */ ,
7133 'i' /* TEXT's typalign */ ,
7137 current = TextDatumGetCString(d);
7138 if (strncmp(current, newval, strlen(name) + 1) == 0)
7145 a = array_set(array, 1, &index,
7148 -1 /* varlena array */ ,
7149 -1 /* TEXT's typlen */ ,
7150 false /* TEXT's typbyval */ ,
7151 'i' /* TEXT's typalign */ );
7154 a = construct_array(&datum, 1,
7163 * Delete an entry from an option array. The array parameter may be NULL
7164 * to indicate the current table entry is NULL. Also, if the return value
7165 * is NULL then a null should be stored.
7168 GUCArrayDelete(ArrayType *array, const char *name)
7170 const char *varname;
7171 ArrayType *newarray;
7177 /* test if the option is valid */
7178 set_config_option(name, NULL,
7179 superuser() ? PGC_SUSET : PGC_USERSET,
7180 PGC_S_TEST, GUC_ACTION_SET, false);
7182 /* convert name to canonical spelling, so we can use plain strcmp */
7183 (void) GetConfigOptionByName(name, &varname);
7186 /* if array is currently null, then surely nothing to delete */
7193 for (i = 1; i <= ARR_DIMS(array)[0]; i++)
7199 d = array_ref(array, 1, &i,
7200 -1 /* varlenarray */ ,
7201 -1 /* TEXT's typlen */ ,
7202 false /* TEXT's typbyval */ ,
7203 'i' /* TEXT's typalign */ ,
7207 val = TextDatumGetCString(d);
7209 /* ignore entry if it's what we want to delete */
7210 if (strncmp(val, name, strlen(name)) == 0
7211 && val[strlen(name)] == '=')
7214 /* else add it to the output array */
7217 newarray = array_set(newarray, 1, &index,
7220 -1 /* varlenarray */ ,
7221 -1 /* TEXT's typlen */ ,
7222 false /* TEXT's typbyval */ ,
7223 'i' /* TEXT's typalign */ );
7226 newarray = construct_array(&d, 1,
7238 * assign_hook and show_hook subroutines
7242 assign_log_destination(const char *value, bool doit, GucSource source)
7249 /* Need a modifiable copy of string */
7250 rawstring = pstrdup(value);
7252 /* Parse string into list of identifiers */
7253 if (!SplitIdentifierString(rawstring, ',', &elemlist))
7255 /* syntax error in list */
7257 list_free(elemlist);
7258 ereport(GUC_complaint_elevel(source),
7259 (errcode(ERRCODE_INVALID_PARAMETER_VALUE),
7260 errmsg("invalid list syntax for parameter \"log_destination\"")));
7264 foreach(l, elemlist)
7266 char *tok = (char *) lfirst(l);
7268 if (pg_strcasecmp(tok, "stderr") == 0)
7269 newlogdest |= LOG_DESTINATION_STDERR;
7270 else if (pg_strcasecmp(tok, "csvlog") == 0)
7271 newlogdest |= LOG_DESTINATION_CSVLOG;
7273 else if (pg_strcasecmp(tok, "syslog") == 0)
7274 newlogdest |= LOG_DESTINATION_SYSLOG;
7277 else if (pg_strcasecmp(tok, "eventlog") == 0)
7278 newlogdest |= LOG_DESTINATION_EVENTLOG;
7282 ereport(GUC_complaint_elevel(source),
7283 (errcode(ERRCODE_INVALID_PARAMETER_VALUE),
7284 errmsg("unrecognized \"log_destination\" key word: \"%s\"",
7287 list_free(elemlist);
7293 Log_destination = newlogdest;
7296 list_free(elemlist);
7304 assign_syslog_facility(int newval, bool doit, GucSource source)
7307 set_syslog_parameters(syslog_ident_str ? syslog_ident_str : "postgres",
7314 assign_syslog_ident(const char *ident, bool doit, GucSource source)
7317 set_syslog_parameters(ident, syslog_facility);
7321 #endif /* HAVE_SYSLOG */
7325 assign_session_replication_role(int newval, bool doit, GucSource source)
7328 * Must flush the plan cache when changing replication role; but don't
7329 * flush unnecessarily.
7331 if (doit && SessionReplicationRole != newval)
7340 show_num_temp_buffers(void)
7343 * We show the GUC var until local buffers have been initialized, and
7344 * NLocBuffer afterwards.
7346 static char nbuf[32];
7348 sprintf(nbuf, "%d", NLocBuffer ? NLocBuffer : num_temp_buffers);
7353 assign_phony_autocommit(bool newval, bool doit, GucSource source)
7357 ereport(GUC_complaint_elevel(source),
7358 (errcode(ERRCODE_FEATURE_NOT_SUPPORTED),
7359 errmsg("SET AUTOCOMMIT TO OFF is no longer supported")));
7366 assign_custom_variable_classes(const char *newval, bool doit, GucSource source)
7369 * Check syntax. newval must be a comma separated list of identifiers.
7370 * Whitespace is allowed but removed from the result.
7372 bool hasSpaceAfterToken = false;
7373 const char *cp = newval;
7378 initStringInfo(&buf);
7379 while ((c = *cp++) != '\0')
7381 if (isspace((unsigned char) c))
7384 hasSpaceAfterToken = true;
7390 if (symLen > 0) /* terminate identifier */
7392 appendStringInfoChar(&buf, ',');
7395 hasSpaceAfterToken = false;
7399 if (hasSpaceAfterToken || !(isalnum((unsigned char) c) || c == '_'))
7402 * Syntax error due to token following space after token or
7403 * non-identifier character
7408 appendStringInfoChar(&buf, c);
7412 /* Remove stray ',' at end */
7413 if (symLen == 0 && buf.len > 0)
7414 buf.data[--buf.len] = '\0';
7416 /* GUC wants the result malloc'd */
7417 newval = guc_strdup(LOG, buf.data);
7424 assign_debug_assertions(bool newval, bool doit, GucSource source)
7426 #ifndef USE_ASSERT_CHECKING
7429 ereport(GUC_complaint_elevel(source),
7430 (errcode(ERRCODE_INVALID_PARAMETER_VALUE),
7431 errmsg("assertion checking is not supported by this build")));
7439 assign_bonjour(bool newval, bool doit, GucSource source)
7444 ereport(GUC_complaint_elevel(source),
7445 (errcode(ERRCODE_INVALID_PARAMETER_VALUE),
7446 errmsg("Bonjour is not supported by this build")));
7454 assign_ssl(bool newval, bool doit, GucSource source)
7459 ereport(GUC_complaint_elevel(source),
7460 (errcode(ERRCODE_INVALID_PARAMETER_VALUE),
7461 errmsg("SSL is not supported by this build")));
7469 assign_stage_log_stats(bool newval, bool doit, GucSource source)
7471 if (newval && log_statement_stats)
7473 ereport(GUC_complaint_elevel(source),
7474 (errcode(ERRCODE_INVALID_PARAMETER_VALUE),
7475 errmsg("cannot enable parameter when \"log_statement_stats\" is true")));
7476 /* source == PGC_S_OVERRIDE means do it anyway, eg at xact abort */
7477 if (source != PGC_S_OVERRIDE)
7484 assign_log_stats(bool newval, bool doit, GucSource source)
7487 (log_parser_stats || log_planner_stats || log_executor_stats))
7489 ereport(GUC_complaint_elevel(source),
7490 (errcode(ERRCODE_INVALID_PARAMETER_VALUE),
7491 errmsg("cannot enable \"log_statement_stats\" when "
7492 "\"log_parser_stats\", \"log_planner_stats\", "
7493 "or \"log_executor_stats\" is true")));
7494 /* source == PGC_S_OVERRIDE means do it anyway, eg at xact abort */
7495 if (source != PGC_S_OVERRIDE)
7502 assign_transaction_read_only(bool newval, bool doit, GucSource source)
7504 /* Can't go to r/w mode inside a r/o transaction */
7505 if (newval == false && XactReadOnly && IsSubTransaction())
7507 ereport(GUC_complaint_elevel(source),
7508 (errcode(ERRCODE_INVALID_PARAMETER_VALUE),
7509 errmsg("cannot set transaction read-write mode inside a read-only transaction")));
7510 /* source == PGC_S_OVERRIDE means do it anyway, eg at xact abort */
7511 if (source != PGC_S_OVERRIDE)
7518 assign_canonical_path(const char *newval, bool doit, GucSource source)
7522 char *canon_val = guc_strdup(ERROR, newval);
7524 canonicalize_path(canon_val);
7532 assign_timezone_abbreviations(const char *newval, bool doit, GucSource source)
7535 * The powerup value shown above for timezone_abbreviations is "UNKNOWN".
7536 * When we see this we just do nothing. If this value isn't overridden
7537 * from the config file then pg_timezone_abbrev_initialize() will
7538 * eventually replace it with "Default". This hack has two purposes: to
7539 * avoid wasting cycles loading values that might soon be overridden from
7540 * the config file, and to avoid trying to read the timezone abbrev files
7541 * during InitializeGUCOptions(). The latter doesn't work in an
7542 * EXEC_BACKEND subprocess because my_exec_path hasn't been set yet and so
7543 * we can't locate PGSHAREDIR. (Essentially the same hack is used to
7544 * delay initializing TimeZone ... if we have any more, we should try to
7545 * clean up and centralize this mechanism ...)
7547 if (strcmp(newval, "UNKNOWN") == 0)
7552 /* Loading abbrev file is expensive, so only do it when value changes */
7553 if (timezone_abbreviations_string == NULL ||
7554 strcmp(timezone_abbreviations_string, newval) != 0)
7559 * If reading config file, only the postmaster should bleat loudly
7560 * about problems. Otherwise, it's just this one process doing it,
7561 * and we use WARNING message level.
7563 if (source == PGC_S_FILE)
7564 elevel = IsUnderPostmaster ? DEBUG3 : LOG;
7567 if (!load_tzoffsets(newval, doit, elevel))
7574 * pg_timezone_abbrev_initialize --- set default value if not done already
7576 * This is called after initial loading of postgresql.conf. If no
7577 * timezone_abbreviations setting was found therein, select default.
7580 pg_timezone_abbrev_initialize(void)
7582 if (strcmp(timezone_abbreviations_string, "UNKNOWN") == 0)
7584 SetConfigOption("timezone_abbreviations", "Default",
7585 PGC_POSTMASTER, PGC_S_ARGV);
7590 show_archive_command(void)
7592 if (XLogArchiveMode)
7593 return XLogArchiveCommand;
7595 return "(disabled)";
7599 assign_tcp_keepalives_idle(int newval, bool doit, GucSource source)
7602 return (pq_setkeepalivesidle(newval, MyProcPort) == STATUS_OK);
7608 show_tcp_keepalives_idle(void)
7610 static char nbuf[16];
7612 snprintf(nbuf, sizeof(nbuf), "%d", pq_getkeepalivesidle(MyProcPort));
7617 assign_tcp_keepalives_interval(int newval, bool doit, GucSource source)
7620 return (pq_setkeepalivesinterval(newval, MyProcPort) == STATUS_OK);
7626 show_tcp_keepalives_interval(void)
7628 static char nbuf[16];
7630 snprintf(nbuf, sizeof(nbuf), "%d", pq_getkeepalivesinterval(MyProcPort));
7635 assign_tcp_keepalives_count(int newval, bool doit, GucSource source)
7638 return (pq_setkeepalivescount(newval, MyProcPort) == STATUS_OK);
7644 show_tcp_keepalives_count(void)
7646 static char nbuf[16];
7648 snprintf(nbuf, sizeof(nbuf), "%d", pq_getkeepalivescount(MyProcPort));
7653 assign_maxconnections(int newval, bool doit, GucSource source)
7655 if (newval + autovacuum_max_workers + 1 > INT_MAX / 4)
7659 MaxBackends = newval + autovacuum_max_workers + 1;
7665 assign_autovacuum_max_workers(int newval, bool doit, GucSource source)
7667 if (MaxConnections + newval + 1 > INT_MAX / 4)
7671 MaxBackends = MaxConnections + newval + 1;
7677 assign_effective_io_concurrency(int newval, bool doit, GucSource source)
7680 double new_prefetch_pages = 0.0;
7684 * The user-visible GUC parameter is the number of drives (spindles),
7685 * which we need to translate to a number-of-pages-to-prefetch target.
7687 * The expected number of prefetch pages needed to keep N drives busy is:
7689 * drives | I/O requests
7690 * -------+----------------
7693 * 3 | 3/1 + 3/2 + 3/3 = 5 1/2
7694 * 4 | 4/1 + 4/2 + 4/3 + 4/4 = 8 1/3
7697 * This is called the "coupon collector problem" and H(n) is called the
7698 * harmonic series. This could be approximated by n * ln(n), but for
7699 * reasonable numbers of drives we might as well just compute the series.
7701 * Alternatively we could set the target to the number of pages necessary
7702 * so that the expected number of active spindles is some arbitrary
7703 * percentage of the total. This sounds the same but is actually slightly
7704 * different. The result ends up being ln(1-P)/ln((n-1)/n) where P is
7705 * that desired fraction.
7707 * Experimental results show that both of these formulas aren't aggressive
7708 * enough, but we don't really have any better proposals.
7710 * Note that if newval = 0 (disabled), we must set target = 0.
7714 for (i = 1; i <= newval; i++)
7715 new_prefetch_pages += (double) newval / (double) i;
7717 /* This range check shouldn't fail, but let's be paranoid */
7718 if (new_prefetch_pages >= 0.0 && new_prefetch_pages < (double) INT_MAX)
7721 target_prefetch_pages = (int) rint(new_prefetch_pages);
7728 #endif /* USE_PREFETCH */
7732 assign_pgstat_temp_directory(const char *newval, bool doit, GucSource source)
7736 char *canon_val = guc_strdup(ERROR, newval);
7740 canonicalize_path(canon_val);
7742 tname = guc_malloc(ERROR, strlen(canon_val) + 12); /* /pgstat.tmp */
7743 sprintf(tname, "%s/pgstat.tmp", canon_val);
7744 fname = guc_malloc(ERROR, strlen(canon_val) + 13); /* /pgstat.stat */
7745 sprintf(fname, "%s/pgstat.stat", canon_val);
7747 if (pgstat_stat_tmpname)
7748 free(pgstat_stat_tmpname);
7749 pgstat_stat_tmpname = tname;
7750 if (pgstat_stat_filename)
7751 free(pgstat_stat_filename);
7752 pgstat_stat_filename = fname;
7761 assign_application_name(const char *newval, bool doit, GucSource source)
7765 /* Only allow clean ASCII chars in the application name */
7766 char *repval = guc_strdup(ERROR, newval);
7769 for (p = repval; *p; p++)
7771 if (*p < 32 || *p > 126)
7775 /* Update the pg_stat_activity view */
7776 pgstat_report_appname(repval);
7784 #include "guc-file.c"