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-2011, PostgreSQL Global Development Group
10 * Written by Peter Eisentraut <peter_e@gmx.net>.
13 * src/backend/utils/misc/guc.c
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 "replication/syncrep.h"
59 #include "replication/walreceiver.h"
60 #include "replication/walsender.h"
61 #include "storage/bufmgr.h"
62 #include "storage/standby.h"
63 #include "storage/fd.h"
64 #include "storage/predicate.h"
65 #include "tcop/tcopprot.h"
66 #include "tsearch/ts_cache.h"
67 #include "utils/builtins.h"
68 #include "utils/bytea.h"
69 #include "utils/guc_tables.h"
70 #include "utils/memutils.h"
71 #include "utils/pg_locale.h"
72 #include "utils/plancache.h"
73 #include "utils/portal.h"
74 #include "utils/ps_status.h"
75 #include "utils/tzparser.h"
76 #include "utils/xml.h"
79 #define PG_KRB_SRVTAB ""
82 #define PG_KRB_SRVNAM ""
85 #define CONFIG_FILENAME "postgresql.conf"
86 #define HBA_FILENAME "pg_hba.conf"
87 #define IDENT_FILENAME "pg_ident.conf"
90 #define CONFIG_EXEC_PARAMS "global/config_exec_params"
91 #define CONFIG_EXEC_PARAMS_NEW "global/config_exec_params.new"
94 /* upper limit for GUC variables measured in kilobytes of memory */
95 /* note that various places assume the byte size fits in a "long" variable */
96 #if SIZEOF_SIZE_T > 4 && SIZEOF_LONG > 4
97 #define MAX_KILOBYTES INT_MAX
99 #define MAX_KILOBYTES (INT_MAX / 1024)
103 * Note: MAX_BACKENDS is limited to 2^23-1 because inval.c stores the
104 * backend ID as a 3-byte signed integer. Even if that limitation were
105 * removed, we still could not exceed INT_MAX/4 because some places compute
106 * 4*MaxBackends without any overflow check. This is rechecked in
107 * check_maxconnections, since MaxBackends is computed as MaxConnections
108 * plus autovacuum_max_workers plus one (for the autovacuum launcher).
110 #define MAX_BACKENDS 0x7fffff
112 #define KB_PER_MB (1024)
113 #define KB_PER_GB (1024*1024)
115 #define MS_PER_S 1000
117 #define MS_PER_MIN (1000 * 60)
119 #define S_PER_H (60 * 60)
120 #define MS_PER_H (1000 * 60 * 60)
121 #define MIN_PER_D (60 * 24)
122 #define S_PER_D (60 * 60 * 24)
123 #define MS_PER_D (1000 * 60 * 60 * 24)
125 /* XXX these should appear in other modules' header files */
126 extern bool Log_disconnections;
127 extern int CommitDelay;
128 extern int CommitSiblings;
129 extern char *default_tablespace;
130 extern char *temp_tablespaces;
131 extern bool synchronize_seqscans;
132 extern bool fullPageWrites;
133 extern int ssl_renegotiation_limit;
134 extern char *SSLCipherSuites;
137 extern bool trace_sort;
139 #ifdef TRACE_SYNCSCAN
140 extern bool trace_syncscan;
142 #ifdef DEBUG_BOUNDED_SORT
143 extern bool optimize_bounded_sort;
146 static int GUC_check_errcode_value;
148 /* global variables for check hook support */
149 char *GUC_check_errmsg_string;
150 char *GUC_check_errdetail_string;
151 char *GUC_check_errhint_string;
154 static void set_config_sourcefile(const char *name, char *sourcefile,
156 static bool call_bool_check_hook(struct config_bool * conf, bool *newval,
157 void **extra, GucSource source, int elevel);
158 static bool call_int_check_hook(struct config_int * conf, int *newval,
159 void **extra, GucSource source, int elevel);
160 static bool call_real_check_hook(struct config_real * conf, double *newval,
161 void **extra, GucSource source, int elevel);
162 static bool call_string_check_hook(struct config_string * conf, char **newval,
163 void **extra, GucSource source, int elevel);
164 static bool call_enum_check_hook(struct config_enum * conf, int *newval,
165 void **extra, GucSource source, int elevel);
167 static bool check_log_destination(char **newval, void **extra, GucSource source);
168 static void assign_log_destination(const char *newval, void *extra);
171 static int syslog_facility = LOG_LOCAL0;
173 static int syslog_facility = 0;
176 static void assign_syslog_facility(int newval, void *extra);
177 static void assign_syslog_ident(const char *newval, void *extra);
178 static void assign_session_replication_role(int newval, void *extra);
179 static bool check_temp_buffers(int *newval, void **extra, GucSource source);
180 static bool check_phony_autocommit(bool *newval, void **extra, GucSource source);
181 static bool check_custom_variable_classes(char **newval, void **extra, GucSource source);
182 static bool check_debug_assertions(bool *newval, void **extra, GucSource source);
183 static bool check_bonjour(bool *newval, void **extra, GucSource source);
184 static bool check_ssl(bool *newval, void **extra, GucSource source);
185 static bool check_stage_log_stats(bool *newval, void **extra, GucSource source);
186 static bool check_log_stats(bool *newval, void **extra, GucSource source);
187 static bool check_canonical_path(char **newval, void **extra, GucSource source);
188 static bool check_timezone_abbreviations(char **newval, void **extra, GucSource source);
189 static void assign_timezone_abbreviations(const char *newval, void *extra);
190 static const char *show_archive_command(void);
191 static void assign_tcp_keepalives_idle(int newval, void *extra);
192 static void assign_tcp_keepalives_interval(int newval, void *extra);
193 static void assign_tcp_keepalives_count(int newval, void *extra);
194 static const char *show_tcp_keepalives_idle(void);
195 static const char *show_tcp_keepalives_interval(void);
196 static const char *show_tcp_keepalives_count(void);
197 static bool check_maxconnections(int *newval, void **extra, GucSource source);
198 static void assign_maxconnections(int newval, void *extra);
199 static bool check_autovacuum_max_workers(int *newval, void **extra, GucSource source);
200 static void assign_autovacuum_max_workers(int newval, void *extra);
201 static bool check_effective_io_concurrency(int *newval, void **extra, GucSource source);
202 static void assign_effective_io_concurrency(int newval, void *extra);
203 static void assign_pgstat_temp_directory(const char *newval, void *extra);
204 static bool check_application_name(char **newval, void **extra, GucSource source);
205 static void assign_application_name(const char *newval, void *extra);
206 static const char *show_unix_socket_permissions(void);
207 static const char *show_log_file_mode(void);
209 static char *config_enum_get_options(struct config_enum * record,
210 const char *prefix, const char *suffix,
211 const char *separator);
215 * Options for enum values defined in this module.
217 * NOTE! Option values may not contain double quotes!
220 static const struct config_enum_entry bytea_output_options[] = {
221 {"escape", BYTEA_OUTPUT_ESCAPE, false},
222 {"hex", BYTEA_OUTPUT_HEX, false},
227 * We have different sets for client and server message level options because
228 * they sort slightly different (see "log" level)
230 static const struct config_enum_entry client_message_level_options[] = {
231 {"debug", DEBUG2, true},
232 {"debug5", DEBUG5, false},
233 {"debug4", DEBUG4, false},
234 {"debug3", DEBUG3, false},
235 {"debug2", DEBUG2, false},
236 {"debug1", DEBUG1, false},
238 {"info", INFO, true},
239 {"notice", NOTICE, false},
240 {"warning", WARNING, false},
241 {"error", ERROR, false},
242 {"fatal", FATAL, true},
243 {"panic", PANIC, true},
247 static const struct config_enum_entry server_message_level_options[] = {
248 {"debug", DEBUG2, true},
249 {"debug5", DEBUG5, false},
250 {"debug4", DEBUG4, false},
251 {"debug3", DEBUG3, false},
252 {"debug2", DEBUG2, false},
253 {"debug1", DEBUG1, false},
254 {"info", INFO, false},
255 {"notice", NOTICE, false},
256 {"warning", WARNING, false},
257 {"error", ERROR, false},
259 {"fatal", FATAL, false},
260 {"panic", PANIC, false},
264 static const struct config_enum_entry intervalstyle_options[] = {
265 {"postgres", INTSTYLE_POSTGRES, false},
266 {"postgres_verbose", INTSTYLE_POSTGRES_VERBOSE, false},
267 {"sql_standard", INTSTYLE_SQL_STANDARD, false},
268 {"iso_8601", INTSTYLE_ISO_8601, false},
272 static const struct config_enum_entry log_error_verbosity_options[] = {
273 {"terse", PGERROR_TERSE, false},
274 {"default", PGERROR_DEFAULT, false},
275 {"verbose", PGERROR_VERBOSE, false},
279 static const struct config_enum_entry log_statement_options[] = {
280 {"none", LOGSTMT_NONE, false},
281 {"ddl", LOGSTMT_DDL, false},
282 {"mod", LOGSTMT_MOD, false},
283 {"all", LOGSTMT_ALL, false},
287 static const struct config_enum_entry isolation_level_options[] = {
288 {"serializable", XACT_SERIALIZABLE, false},
289 {"repeatable read", XACT_REPEATABLE_READ, false},
290 {"read committed", XACT_READ_COMMITTED, false},
291 {"read uncommitted", XACT_READ_UNCOMMITTED, false},
295 static const struct config_enum_entry session_replication_role_options[] = {
296 {"origin", SESSION_REPLICATION_ROLE_ORIGIN, false},
297 {"replica", SESSION_REPLICATION_ROLE_REPLICA, false},
298 {"local", SESSION_REPLICATION_ROLE_LOCAL, false},
302 static const struct config_enum_entry syslog_facility_options[] = {
304 {"local0", LOG_LOCAL0, false},
305 {"local1", LOG_LOCAL1, false},
306 {"local2", LOG_LOCAL2, false},
307 {"local3", LOG_LOCAL3, false},
308 {"local4", LOG_LOCAL4, false},
309 {"local5", LOG_LOCAL5, false},
310 {"local6", LOG_LOCAL6, false},
311 {"local7", LOG_LOCAL7, false},
318 static const struct config_enum_entry track_function_options[] = {
319 {"none", TRACK_FUNC_OFF, false},
320 {"pl", TRACK_FUNC_PL, false},
321 {"all", TRACK_FUNC_ALL, false},
325 static const struct config_enum_entry xmlbinary_options[] = {
326 {"base64", XMLBINARY_BASE64, false},
327 {"hex", XMLBINARY_HEX, false},
331 static const struct config_enum_entry xmloption_options[] = {
332 {"content", XMLOPTION_CONTENT, false},
333 {"document", XMLOPTION_DOCUMENT, false},
338 * Although only "on", "off", and "safe_encoding" are documented, we
339 * accept all the likely variants of "on" and "off".
341 static const struct config_enum_entry backslash_quote_options[] = {
342 {"safe_encoding", BACKSLASH_QUOTE_SAFE_ENCODING, false},
343 {"on", BACKSLASH_QUOTE_ON, false},
344 {"off", BACKSLASH_QUOTE_OFF, false},
345 {"true", BACKSLASH_QUOTE_ON, true},
346 {"false", BACKSLASH_QUOTE_OFF, true},
347 {"yes", BACKSLASH_QUOTE_ON, true},
348 {"no", BACKSLASH_QUOTE_OFF, true},
349 {"1", BACKSLASH_QUOTE_ON, true},
350 {"0", BACKSLASH_QUOTE_OFF, true},
355 * Although only "on", "off", and "partition" are documented, we
356 * accept all the likely variants of "on" and "off".
358 static const struct config_enum_entry constraint_exclusion_options[] = {
359 {"partition", CONSTRAINT_EXCLUSION_PARTITION, false},
360 {"on", CONSTRAINT_EXCLUSION_ON, false},
361 {"off", CONSTRAINT_EXCLUSION_OFF, false},
362 {"true", CONSTRAINT_EXCLUSION_ON, true},
363 {"false", CONSTRAINT_EXCLUSION_OFF, true},
364 {"yes", CONSTRAINT_EXCLUSION_ON, true},
365 {"no", CONSTRAINT_EXCLUSION_OFF, true},
366 {"1", CONSTRAINT_EXCLUSION_ON, true},
367 {"0", CONSTRAINT_EXCLUSION_OFF, true},
372 * Although only "on", "off", and "local" are documented, we
373 * accept all the likely variants of "on" and "off".
375 static const struct config_enum_entry synchronous_commit_options[] = {
376 {"local", SYNCHRONOUS_COMMIT_LOCAL_FLUSH, false},
377 {"on", SYNCHRONOUS_COMMIT_ON, false},
378 {"off", SYNCHRONOUS_COMMIT_OFF, false},
379 {"true", SYNCHRONOUS_COMMIT_ON, true},
380 {"false", SYNCHRONOUS_COMMIT_OFF, true},
381 {"yes", SYNCHRONOUS_COMMIT_ON, true},
382 {"no", SYNCHRONOUS_COMMIT_OFF, true},
383 {"1", SYNCHRONOUS_COMMIT_ON, true},
384 {"0", SYNCHRONOUS_COMMIT_OFF, true},
389 * Options for enum values stored in other modules
391 extern const struct config_enum_entry wal_level_options[];
392 extern const struct config_enum_entry sync_method_options[];
395 * GUC option variables that are exported from this module
397 #ifdef USE_ASSERT_CHECKING
398 bool assert_enabled = true;
400 bool assert_enabled = false;
402 bool log_duration = false;
403 bool Debug_print_plan = false;
404 bool Debug_print_parse = false;
405 bool Debug_print_rewritten = false;
406 bool Debug_pretty_print = true;
408 bool log_parser_stats = false;
409 bool log_planner_stats = false;
410 bool log_executor_stats = false;
411 bool log_statement_stats = false; /* this is sort of all three
413 bool log_btree_build_stats = false;
415 bool check_function_bodies = true;
416 bool default_with_oids = false;
417 bool SQL_inheritance = true;
419 bool Password_encryption = true;
421 int log_min_error_statement = ERROR;
422 int log_min_messages = WARNING;
423 int client_min_messages = NOTICE;
424 int log_min_duration_statement = -1;
425 int log_temp_files = -1;
426 int trace_recovery_messages = LOG;
428 int temp_file_limit = -1;
430 int num_temp_buffers = 1024;
432 char *data_directory;
433 char *ConfigFileName;
436 char *external_pid_file;
438 char *pgstat_temp_directory;
440 char *application_name;
442 int tcp_keepalives_idle;
443 int tcp_keepalives_interval;
444 int tcp_keepalives_count;
447 * These variables are all dummies that don't do anything, except in some
448 * cases provide the value for SHOW to display. The real state is elsewhere
449 * and is kept in sync by assign_hooks.
451 static char *log_destination_string;
453 static char *syslog_ident_str;
454 static bool phony_autocommit;
455 static bool session_auth_is_superuser;
456 static double phony_random_seed;
457 static char *client_encoding_string;
458 static char *datestyle_string;
459 static char *locale_collate;
460 static char *locale_ctype;
461 static char *server_encoding_string;
462 static char *server_version_string;
463 static int server_version_num;
464 static char *timezone_string;
465 static char *log_timezone_string;
466 static char *timezone_abbreviations_string;
467 static char *XactIsoLevel_string;
468 static char *session_authorization_string;
469 static char *custom_variable_classes;
470 static int max_function_args;
471 static int max_index_keys;
472 static int max_identifier_length;
473 static int block_size;
474 static int segment_size;
475 static int wal_block_size;
476 static int wal_segment_size;
477 static bool integer_datetimes;
478 static int effective_io_concurrency;
480 /* should be static, but commands/variable.c needs to get at this */
485 * Displayable names for context types (enum GucContext)
487 * Note: these strings are deliberately not localized.
489 const char *const GucContext_Names[] =
491 /* PGC_INTERNAL */ "internal",
492 /* PGC_POSTMASTER */ "postmaster",
493 /* PGC_SIGHUP */ "sighup",
494 /* PGC_BACKEND */ "backend",
495 /* PGC_SUSET */ "superuser",
496 /* PGC_USERSET */ "user"
500 * Displayable names for source types (enum GucSource)
502 * Note: these strings are deliberately not localized.
504 const char *const GucSource_Names[] =
506 /* PGC_S_DEFAULT */ "default",
507 /* PGC_S_DYNAMIC_DEFAULT */ "default",
508 /* PGC_S_ENV_VAR */ "environment variable",
509 /* PGC_S_FILE */ "configuration file",
510 /* PGC_S_ARGV */ "command line",
511 /* PGC_S_DATABASE */ "database",
512 /* PGC_S_USER */ "user",
513 /* PGC_S_DATABASE_USER */ "database user",
514 /* PGC_S_CLIENT */ "client",
515 /* PGC_S_OVERRIDE */ "override",
516 /* PGC_S_INTERACTIVE */ "interactive",
517 /* PGC_S_TEST */ "test",
518 /* PGC_S_SESSION */ "session"
522 * Displayable names for the groupings defined in enum config_group
524 const char *const config_group_names[] =
527 gettext_noop("Ungrouped"),
529 gettext_noop("File Locations"),
531 gettext_noop("Connections and Authentication"),
532 /* CONN_AUTH_SETTINGS */
533 gettext_noop("Connections and Authentication / Connection Settings"),
534 /* CONN_AUTH_SECURITY */
535 gettext_noop("Connections and Authentication / Security and Authentication"),
537 gettext_noop("Resource Usage"),
539 gettext_noop("Resource Usage / Memory"),
541 gettext_noop("Resource Usage / Disk"),
542 /* RESOURCES_KERNEL */
543 gettext_noop("Resource Usage / Kernel Resources"),
544 /* RESOURCES_VACUUM_DELAY */
545 gettext_noop("Resource Usage / Cost-Based Vacuum Delay"),
546 /* RESOURCES_BGWRITER */
547 gettext_noop("Resource Usage / Background Writer"),
548 /* RESOURCES_ASYNCHRONOUS */
549 gettext_noop("Resource Usage / Asynchronous Behavior"),
551 gettext_noop("Write-Ahead Log"),
553 gettext_noop("Write-Ahead Log / Settings"),
554 /* WAL_CHECKPOINTS */
555 gettext_noop("Write-Ahead Log / Checkpoints"),
557 gettext_noop("Write-Ahead Log / Archiving"),
559 gettext_noop("Replication"),
560 /* REPLICATION_SENDING */
561 gettext_noop("Replication / Sending Servers"),
562 /* REPLICATION_MASTER */
563 gettext_noop("Replication / Master Server"),
564 /* REPLICATION_STANDBY */
565 gettext_noop("Replication / Standby Servers"),
567 gettext_noop("Query Tuning"),
568 /* QUERY_TUNING_METHOD */
569 gettext_noop("Query Tuning / Planner Method Configuration"),
570 /* QUERY_TUNING_COST */
571 gettext_noop("Query Tuning / Planner Cost Constants"),
572 /* QUERY_TUNING_GEQO */
573 gettext_noop("Query Tuning / Genetic Query Optimizer"),
574 /* QUERY_TUNING_OTHER */
575 gettext_noop("Query Tuning / Other Planner Options"),
577 gettext_noop("Reporting and Logging"),
579 gettext_noop("Reporting and Logging / Where to Log"),
581 gettext_noop("Reporting and Logging / When to Log"),
583 gettext_noop("Reporting and Logging / What to Log"),
585 gettext_noop("Statistics"),
586 /* STATS_MONITORING */
587 gettext_noop("Statistics / Monitoring"),
588 /* STATS_COLLECTOR */
589 gettext_noop("Statistics / Query and Index Statistics Collector"),
591 gettext_noop("Autovacuum"),
593 gettext_noop("Client Connection Defaults"),
594 /* CLIENT_CONN_STATEMENT */
595 gettext_noop("Client Connection Defaults / Statement Behavior"),
596 /* CLIENT_CONN_LOCALE */
597 gettext_noop("Client Connection Defaults / Locale and Formatting"),
598 /* CLIENT_CONN_OTHER */
599 gettext_noop("Client Connection Defaults / Other Defaults"),
600 /* LOCK_MANAGEMENT */
601 gettext_noop("Lock Management"),
603 gettext_noop("Version and Platform Compatibility"),
604 /* COMPAT_OPTIONS_PREVIOUS */
605 gettext_noop("Version and Platform Compatibility / Previous PostgreSQL Versions"),
606 /* COMPAT_OPTIONS_CLIENT */
607 gettext_noop("Version and Platform Compatibility / Other Platforms and Clients"),
609 gettext_noop("Error Handling"),
611 gettext_noop("Preset Options"),
613 gettext_noop("Customized Options"),
614 /* DEVELOPER_OPTIONS */
615 gettext_noop("Developer Options"),
616 /* help_config wants this array to be null-terminated */
621 * Displayable names for GUC variable types (enum config_type)
623 * Note: these strings are deliberately not localized.
625 const char *const config_type_names[] =
627 /* PGC_BOOL */ "bool",
628 /* PGC_INT */ "integer",
629 /* PGC_REAL */ "real",
630 /* PGC_STRING */ "string",
631 /* PGC_ENUM */ "enum"
636 * Contents of GUC tables
638 * See src/backend/utils/misc/README for design notes.
642 * 1. Declare a global variable of type bool, int, double, or char*
643 * and make use of it.
645 * 2. Decide at what times it's safe to set the option. See guc.h for
648 * 3. Decide on a name, a default value, upper and lower bounds (if
651 * 4. Add a record below.
653 * 5. Add it to src/backend/utils/misc/postgresql.conf.sample, if
656 * 6. Don't forget to document the option (at least in config.sgml).
658 * 7. If it's a new GUC_LIST option you must edit pg_dumpall.c to ensure
659 * it is not single quoted at dump time.
663 /******** option records follow ********/
665 static struct config_bool ConfigureNamesBool[] =
668 {"enable_seqscan", PGC_USERSET, QUERY_TUNING_METHOD,
669 gettext_noop("Enables the planner's use of sequential-scan plans."),
677 {"enable_indexscan", PGC_USERSET, QUERY_TUNING_METHOD,
678 gettext_noop("Enables the planner's use of index-scan plans."),
686 {"enable_bitmapscan", PGC_USERSET, QUERY_TUNING_METHOD,
687 gettext_noop("Enables the planner's use of bitmap-scan plans."),
695 {"enable_tidscan", PGC_USERSET, QUERY_TUNING_METHOD,
696 gettext_noop("Enables the planner's use of TID scan plans."),
704 {"enable_sort", PGC_USERSET, QUERY_TUNING_METHOD,
705 gettext_noop("Enables the planner's use of explicit sort steps."),
713 {"enable_hashagg", PGC_USERSET, QUERY_TUNING_METHOD,
714 gettext_noop("Enables the planner's use of hashed aggregation plans."),
722 {"enable_material", PGC_USERSET, QUERY_TUNING_METHOD,
723 gettext_noop("Enables the planner's use of materialization."),
731 {"enable_nestloop", PGC_USERSET, QUERY_TUNING_METHOD,
732 gettext_noop("Enables the planner's use of nested-loop join plans."),
740 {"enable_mergejoin", PGC_USERSET, QUERY_TUNING_METHOD,
741 gettext_noop("Enables the planner's use of merge join plans."),
749 {"enable_hashjoin", PGC_USERSET, QUERY_TUNING_METHOD,
750 gettext_noop("Enables the planner's use of hash join plans."),
758 {"geqo", PGC_USERSET, QUERY_TUNING_GEQO,
759 gettext_noop("Enables genetic query optimization."),
760 gettext_noop("This algorithm attempts to do planning without "
761 "exhaustive searching.")
768 /* Not for general use --- used by SET SESSION AUTHORIZATION */
769 {"is_superuser", PGC_INTERNAL, UNGROUPED,
770 gettext_noop("Shows whether the current user is a superuser."),
772 GUC_REPORT | GUC_NO_SHOW_ALL | GUC_NO_RESET_ALL | GUC_NOT_IN_SAMPLE | GUC_DISALLOW_IN_FILE
774 &session_auth_is_superuser,
779 {"bonjour", PGC_POSTMASTER, CONN_AUTH_SETTINGS,
780 gettext_noop("Enables advertising the server via Bonjour."),
785 check_bonjour, NULL, NULL
788 {"ssl", PGC_POSTMASTER, CONN_AUTH_SECURITY,
789 gettext_noop("Enables SSL connections."),
794 check_ssl, NULL, NULL
797 {"fsync", PGC_SIGHUP, WAL_SETTINGS,
798 gettext_noop("Forces synchronization of updates to disk."),
799 gettext_noop("The server will use the fsync() system call in several places to make "
800 "sure that updates are physically written to disk. This insures "
801 "that a database cluster will recover to a consistent state after "
802 "an operating system or hardware crash.")
809 {"zero_damaged_pages", PGC_SUSET, DEVELOPER_OPTIONS,
810 gettext_noop("Continues processing past damaged page headers."),
811 gettext_noop("Detection of a damaged page header normally causes PostgreSQL to "
812 "report an error, aborting the current transaction. Setting "
813 "zero_damaged_pages to true causes the system to instead report a "
814 "warning, zero out the damaged page, and continue processing. This "
815 "behavior will destroy data, namely all the rows on the damaged page."),
823 {"full_page_writes", PGC_SIGHUP, WAL_SETTINGS,
824 gettext_noop("Writes full pages to WAL when first modified after a checkpoint."),
825 gettext_noop("A page write in process during an operating system crash might be "
826 "only partially written to disk. During recovery, the row changes "
827 "stored in WAL are not enough to recover. This option writes "
828 "pages when first modified after a checkpoint to WAL so full recovery "
836 {"log_checkpoints", PGC_SIGHUP, LOGGING_WHAT,
837 gettext_noop("Logs each checkpoint."),
845 {"log_connections", PGC_BACKEND, LOGGING_WHAT,
846 gettext_noop("Logs each successful connection."),
854 {"log_disconnections", PGC_BACKEND, LOGGING_WHAT,
855 gettext_noop("Logs end of a session, including duration."),
863 {"debug_assertions", PGC_USERSET, DEVELOPER_OPTIONS,
864 gettext_noop("Turns on various assertion checks."),
865 gettext_noop("This is a debugging aid."),
869 #ifdef USE_ASSERT_CHECKING
874 check_debug_assertions, NULL, NULL
878 {"exit_on_error", PGC_USERSET, ERROR_HANDLING_OPTIONS,
879 gettext_noop("Terminate session on any error."),
887 {"restart_after_crash", PGC_SIGHUP, ERROR_HANDLING_OPTIONS,
888 gettext_noop("Reinitialize server after backend crash."),
891 &restart_after_crash,
897 {"log_duration", PGC_SUSET, LOGGING_WHAT,
898 gettext_noop("Logs the duration of each completed SQL statement."),
906 {"debug_print_parse", PGC_USERSET, LOGGING_WHAT,
907 gettext_noop("Logs each query's parse tree."),
915 {"debug_print_rewritten", PGC_USERSET, LOGGING_WHAT,
916 gettext_noop("Logs each query's rewritten parse tree."),
919 &Debug_print_rewritten,
924 {"debug_print_plan", PGC_USERSET, LOGGING_WHAT,
925 gettext_noop("Logs each query's execution plan."),
933 {"debug_pretty_print", PGC_USERSET, LOGGING_WHAT,
934 gettext_noop("Indents parse and plan tree displays."),
942 {"log_parser_stats", PGC_SUSET, STATS_MONITORING,
943 gettext_noop("Writes parser performance statistics to the server log."),
948 check_stage_log_stats, NULL, NULL
951 {"log_planner_stats", PGC_SUSET, STATS_MONITORING,
952 gettext_noop("Writes planner performance statistics to the server log."),
957 check_stage_log_stats, NULL, NULL
960 {"log_executor_stats", PGC_SUSET, STATS_MONITORING,
961 gettext_noop("Writes executor performance statistics to the server log."),
966 check_stage_log_stats, NULL, NULL
969 {"log_statement_stats", PGC_SUSET, STATS_MONITORING,
970 gettext_noop("Writes cumulative performance statistics to the server log."),
973 &log_statement_stats,
975 check_log_stats, NULL, NULL
977 #ifdef BTREE_BUILD_STATS
979 {"log_btree_build_stats", PGC_SUSET, DEVELOPER_OPTIONS,
980 gettext_noop("No description available."),
984 &log_btree_build_stats,
991 {"track_activities", PGC_SUSET, STATS_COLLECTOR,
992 gettext_noop("Collects information about executing commands."),
993 gettext_noop("Enables the collection of information on the currently "
994 "executing command of each session, along with "
995 "the time at which that command began execution.")
997 &pgstat_track_activities,
1002 {"track_counts", PGC_SUSET, STATS_COLLECTOR,
1003 gettext_noop("Collects statistics on database activity."),
1006 &pgstat_track_counts,
1012 {"update_process_title", PGC_SUSET, STATS_COLLECTOR,
1013 gettext_noop("Updates the process title to show the active SQL command."),
1014 gettext_noop("Enables updating of the process title every time a new SQL command is received by the server.")
1016 &update_process_title,
1022 {"autovacuum", PGC_SIGHUP, AUTOVACUUM,
1023 gettext_noop("Starts the autovacuum subprocess."),
1026 &autovacuum_start_daemon,
1032 {"trace_notify", PGC_USERSET, DEVELOPER_OPTIONS,
1033 gettext_noop("Generates debugging output for LISTEN and NOTIFY."),
1044 {"trace_locks", PGC_SUSET, DEVELOPER_OPTIONS,
1045 gettext_noop("No description available."),
1054 {"trace_userlocks", PGC_SUSET, DEVELOPER_OPTIONS,
1055 gettext_noop("No description available."),
1064 {"trace_lwlocks", PGC_SUSET, DEVELOPER_OPTIONS,
1065 gettext_noop("No description available."),
1074 {"debug_deadlocks", PGC_SUSET, DEVELOPER_OPTIONS,
1075 gettext_noop("No description available."),
1086 {"log_lock_waits", PGC_SUSET, LOGGING_WHAT,
1087 gettext_noop("Logs long lock waits."),
1096 {"log_hostname", PGC_SIGHUP, LOGGING_WHAT,
1097 gettext_noop("Logs the host name in the connection logs."),
1098 gettext_noop("By default, connection logs only show the IP address "
1099 "of the connecting host. If you want them to show the host name you "
1100 "can turn this on, but depending on your host name resolution "
1101 "setup it might impose a non-negligible performance penalty.")
1108 {"sql_inheritance", PGC_USERSET, COMPAT_OPTIONS_PREVIOUS,
1109 gettext_noop("Causes subtables to be included by default in various commands."),
1117 {"password_encryption", PGC_USERSET, CONN_AUTH_SECURITY,
1118 gettext_noop("Encrypt passwords."),
1119 gettext_noop("When a password is specified in CREATE USER or "
1120 "ALTER USER without writing either ENCRYPTED or UNENCRYPTED, "
1121 "this parameter determines whether the password is to be encrypted.")
1123 &Password_encryption,
1128 {"transform_null_equals", PGC_USERSET, COMPAT_OPTIONS_CLIENT,
1129 gettext_noop("Treats \"expr=NULL\" as \"expr IS NULL\"."),
1130 gettext_noop("When turned on, expressions of the form expr = NULL "
1131 "(or NULL = expr) are treated as expr IS NULL, that is, they "
1132 "return true if expr evaluates to the null value, and false "
1133 "otherwise. The correct behavior of expr = NULL is to always "
1134 "return null (unknown).")
1136 &Transform_null_equals,
1141 {"db_user_namespace", PGC_SIGHUP, CONN_AUTH_SECURITY,
1142 gettext_noop("Enables per-database user names."),
1150 /* only here for backwards compatibility */
1151 {"autocommit", PGC_USERSET, CLIENT_CONN_STATEMENT,
1152 gettext_noop("This parameter doesn't do anything."),
1153 gettext_noop("It's just here so that we won't choke on SET AUTOCOMMIT TO ON from 7.3-vintage clients."),
1154 GUC_NO_SHOW_ALL | GUC_NOT_IN_SAMPLE
1158 check_phony_autocommit, NULL, NULL
1161 {"default_transaction_read_only", PGC_USERSET, CLIENT_CONN_STATEMENT,
1162 gettext_noop("Sets the default read-only status of new transactions."),
1165 &DefaultXactReadOnly,
1170 {"transaction_read_only", PGC_USERSET, CLIENT_CONN_STATEMENT,
1171 gettext_noop("Sets the current transaction's read-only status."),
1173 GUC_NO_RESET_ALL | GUC_NOT_IN_SAMPLE | GUC_DISALLOW_IN_FILE
1177 check_transaction_read_only, NULL, NULL
1180 {"default_transaction_deferrable", PGC_USERSET, CLIENT_CONN_STATEMENT,
1181 gettext_noop("Sets the default deferrable status of new transactions."),
1184 &DefaultXactDeferrable,
1189 {"transaction_deferrable", PGC_USERSET, CLIENT_CONN_STATEMENT,
1190 gettext_noop("Whether to defer a read-only serializable transaction until it can be executed with no possible serialization failures."),
1192 GUC_NO_RESET_ALL | GUC_NOT_IN_SAMPLE | GUC_DISALLOW_IN_FILE
1196 check_transaction_deferrable, NULL, NULL
1199 {"check_function_bodies", PGC_USERSET, CLIENT_CONN_STATEMENT,
1200 gettext_noop("Check function bodies during CREATE FUNCTION."),
1203 &check_function_bodies,
1208 {"array_nulls", PGC_USERSET, COMPAT_OPTIONS_PREVIOUS,
1209 gettext_noop("Enable input of NULL elements in arrays."),
1210 gettext_noop("When turned on, unquoted NULL in an array input "
1211 "value means a null value; "
1212 "otherwise it is taken literally.")
1219 {"default_with_oids", PGC_USERSET, COMPAT_OPTIONS_PREVIOUS,
1220 gettext_noop("Create new tables with OIDs by default."),
1228 {"logging_collector", PGC_POSTMASTER, LOGGING_WHERE,
1229 gettext_noop("Start a subprocess to capture stderr output and/or csvlogs into log files."),
1237 {"log_truncate_on_rotation", PGC_SIGHUP, LOGGING_WHERE,
1238 gettext_noop("Truncate existing log files of same name during log rotation."),
1241 &Log_truncate_on_rotation,
1248 {"trace_sort", PGC_USERSET, DEVELOPER_OPTIONS,
1249 gettext_noop("Emit information about resource usage in sorting."),
1259 #ifdef TRACE_SYNCSCAN
1260 /* this is undocumented because not exposed in a standard build */
1262 {"trace_syncscan", PGC_USERSET, DEVELOPER_OPTIONS,
1263 gettext_noop("Generate debugging output for synchronized scanning."),
1273 #ifdef DEBUG_BOUNDED_SORT
1274 /* this is undocumented because not exposed in a standard build */
1277 "optimize_bounded_sort", PGC_USERSET, QUERY_TUNING_METHOD,
1278 gettext_noop("Enable bounded sorting using heap sort."),
1282 &optimize_bounded_sort,
1290 {"wal_debug", PGC_SUSET, DEVELOPER_OPTIONS,
1291 gettext_noop("Emit WAL-related debugging output."),
1302 {"integer_datetimes", PGC_INTERNAL, PRESET_OPTIONS,
1303 gettext_noop("Datetimes are integer based."),
1305 GUC_REPORT | GUC_NOT_IN_SAMPLE | GUC_DISALLOW_IN_FILE
1308 #ifdef HAVE_INT64_TIMESTAMP
1317 {"krb_caseins_users", PGC_SIGHUP, CONN_AUTH_SECURITY,
1318 gettext_noop("Sets whether Kerberos and GSSAPI user names should be treated as case-insensitive."),
1321 &pg_krb_caseins_users,
1327 {"escape_string_warning", PGC_USERSET, COMPAT_OPTIONS_PREVIOUS,
1328 gettext_noop("Warn about backslash escapes in ordinary string literals."),
1331 &escape_string_warning,
1337 {"standard_conforming_strings", PGC_USERSET, COMPAT_OPTIONS_PREVIOUS,
1338 gettext_noop("Causes '...' strings to treat backslashes literally."),
1342 &standard_conforming_strings,
1348 {"synchronize_seqscans", PGC_USERSET, COMPAT_OPTIONS_PREVIOUS,
1349 gettext_noop("Enable synchronized sequential scans."),
1352 &synchronize_seqscans,
1358 {"archive_mode", PGC_POSTMASTER, WAL_ARCHIVING,
1359 gettext_noop("Allows archiving of WAL files using archive_command."),
1368 {"hot_standby", PGC_POSTMASTER, REPLICATION_STANDBY,
1369 gettext_noop("Allows connections and queries during recovery."),
1378 {"hot_standby_feedback", PGC_SIGHUP, REPLICATION_STANDBY,
1379 gettext_noop("Allows feedback from a hot standby to the primary that will avoid query conflicts."),
1382 &hot_standby_feedback,
1388 {"allow_system_table_mods", PGC_POSTMASTER, DEVELOPER_OPTIONS,
1389 gettext_noop("Allows modifications of the structure of system tables."),
1393 &allowSystemTableMods,
1399 {"ignore_system_indexes", PGC_BACKEND, DEVELOPER_OPTIONS,
1400 gettext_noop("Disables reading from system indexes."),
1401 gettext_noop("It does not prevent updating the indexes, so it is safe "
1402 "to use. The worst consequence is slowness."),
1405 &IgnoreSystemIndexes,
1411 {"lo_compat_privileges", PGC_SUSET, COMPAT_OPTIONS_PREVIOUS,
1412 gettext_noop("Enables backward compatibility mode for privilege checks on large objects."),
1413 gettext_noop("Skips privilege checks when reading or modifying large objects, "
1414 "for compatibility with PostgreSQL releases prior to 9.0.")
1416 &lo_compat_privileges,
1422 {"quote_all_identifiers", PGC_USERSET, COMPAT_OPTIONS_PREVIOUS,
1423 gettext_noop("When generating SQL fragments, quote all identifiers."),
1426 "e_all_identifiers,
1431 /* End-of-list marker */
1433 {NULL, 0, 0, NULL, NULL}, NULL, false, NULL, NULL, NULL
1438 static struct config_int ConfigureNamesInt[] =
1441 {"archive_timeout", PGC_SIGHUP, WAL_ARCHIVING,
1442 gettext_noop("Forces a switch to the next xlog file if a "
1443 "new file has not been started within N seconds."),
1447 &XLogArchiveTimeout,
1452 {"post_auth_delay", PGC_BACKEND, DEVELOPER_OPTIONS,
1453 gettext_noop("Waits N seconds on connection startup after authentication."),
1454 gettext_noop("This allows attaching a debugger to the process."),
1455 GUC_NOT_IN_SAMPLE | GUC_UNIT_S
1462 {"default_statistics_target", PGC_USERSET, QUERY_TUNING_OTHER,
1463 gettext_noop("Sets the default statistics target."),
1464 gettext_noop("This applies to table columns that have not had a "
1465 "column-specific target set via ALTER TABLE SET STATISTICS.")
1467 &default_statistics_target,
1472 {"from_collapse_limit", PGC_USERSET, QUERY_TUNING_OTHER,
1473 gettext_noop("Sets the FROM-list size beyond which subqueries "
1474 "are not collapsed."),
1475 gettext_noop("The planner will merge subqueries into upper "
1476 "queries if the resulting FROM list would have no more than "
1479 &from_collapse_limit,
1484 {"join_collapse_limit", PGC_USERSET, QUERY_TUNING_OTHER,
1485 gettext_noop("Sets the FROM-list size beyond which JOIN "
1486 "constructs are not flattened."),
1487 gettext_noop("The planner will flatten explicit JOIN "
1488 "constructs into lists of FROM items whenever a "
1489 "list of no more than this many items would result.")
1491 &join_collapse_limit,
1496 {"geqo_threshold", PGC_USERSET, QUERY_TUNING_GEQO,
1497 gettext_noop("Sets the threshold of FROM items beyond which GEQO is used."),
1505 {"geqo_effort", PGC_USERSET, QUERY_TUNING_GEQO,
1506 gettext_noop("GEQO: effort is used to set the default for other GEQO parameters."),
1510 DEFAULT_GEQO_EFFORT, MIN_GEQO_EFFORT, MAX_GEQO_EFFORT,
1514 {"geqo_pool_size", PGC_USERSET, QUERY_TUNING_GEQO,
1515 gettext_noop("GEQO: number of individuals in the population."),
1516 gettext_noop("Zero selects a suitable default value.")
1523 {"geqo_generations", PGC_USERSET, QUERY_TUNING_GEQO,
1524 gettext_noop("GEQO: number of iterations of the algorithm."),
1525 gettext_noop("Zero selects a suitable default value.")
1533 /* This is PGC_SUSET to prevent hiding from log_lock_waits. */
1534 {"deadlock_timeout", PGC_SUSET, LOCK_MANAGEMENT,
1535 gettext_noop("Sets the time to wait on a lock before checking for deadlock."),
1545 {"max_standby_archive_delay", PGC_SIGHUP, REPLICATION_STANDBY,
1546 gettext_noop("Sets the maximum delay before canceling queries when a hot standby server is processing archived WAL data."),
1550 &max_standby_archive_delay,
1551 30 * 1000, -1, INT_MAX,
1556 {"max_standby_streaming_delay", PGC_SIGHUP, REPLICATION_STANDBY,
1557 gettext_noop("Sets the maximum delay before canceling queries when a hot standby server is processing streamed WAL data."),
1561 &max_standby_streaming_delay,
1562 30 * 1000, -1, INT_MAX,
1567 {"wal_receiver_status_interval", PGC_SIGHUP, REPLICATION_STANDBY,
1568 gettext_noop("Sets the maximum interval between WAL receiver status reports to the primary."),
1572 &wal_receiver_status_interval,
1573 10, 0, INT_MAX / 1000,
1578 {"max_connections", PGC_POSTMASTER, CONN_AUTH_SETTINGS,
1579 gettext_noop("Sets the maximum number of concurrent connections."),
1583 100, 1, MAX_BACKENDS,
1584 check_maxconnections, assign_maxconnections, NULL
1588 {"superuser_reserved_connections", PGC_POSTMASTER, CONN_AUTH_SETTINGS,
1589 gettext_noop("Sets the number of connection slots reserved for superusers."),
1598 * We sometimes multiply the number of shared buffers by two without
1599 * checking for overflow, so we mustn't allow more than INT_MAX / 2.
1602 {"shared_buffers", PGC_POSTMASTER, RESOURCES_MEM,
1603 gettext_noop("Sets the number of shared memory buffers used by the server."),
1608 1024, 16, INT_MAX / 2,
1613 {"temp_buffers", PGC_USERSET, RESOURCES_MEM,
1614 gettext_noop("Sets the maximum number of temporary buffers used by each session."),
1619 1024, 100, INT_MAX / 2,
1620 check_temp_buffers, NULL, NULL
1624 {"port", PGC_POSTMASTER, CONN_AUTH_SETTINGS,
1625 gettext_noop("Sets the TCP port the server listens on."),
1629 DEF_PGPORT, 1, 65535,
1634 {"unix_socket_permissions", PGC_POSTMASTER, CONN_AUTH_SETTINGS,
1635 gettext_noop("Sets the access permissions of the Unix-domain socket."),
1636 gettext_noop("Unix-domain sockets use the usual Unix file system "
1637 "permission set. The parameter value is expected "
1638 "to be a numeric mode specification in the form "
1639 "accepted by the chmod and umask system calls. "
1640 "(To use the customary octal format the number must "
1641 "start with a 0 (zero).)")
1643 &Unix_socket_permissions,
1645 NULL, NULL, show_unix_socket_permissions
1649 {"log_file_mode", PGC_SIGHUP, LOGGING_WHERE,
1650 gettext_noop("Sets the file permissions for log files."),
1651 gettext_noop("The parameter value is expected "
1652 "to be a numeric mode specification in the form "
1653 "accepted by the chmod and umask system calls. "
1654 "(To use the customary octal format the number must "
1655 "start with a 0 (zero).)")
1659 NULL, NULL, show_log_file_mode
1663 {"work_mem", PGC_USERSET, RESOURCES_MEM,
1664 gettext_noop("Sets the maximum memory to be used for query workspaces."),
1665 gettext_noop("This much memory can be used by each internal "
1666 "sort operation and hash table before switching to "
1667 "temporary disk files."),
1671 1024, 64, MAX_KILOBYTES,
1676 {"maintenance_work_mem", PGC_USERSET, RESOURCES_MEM,
1677 gettext_noop("Sets the maximum memory to be used for maintenance operations."),
1678 gettext_noop("This includes operations such as VACUUM and CREATE INDEX."),
1681 &maintenance_work_mem,
1682 16384, 1024, MAX_KILOBYTES,
1687 * We use the hopefully-safely-small value of 100kB as the compiled-in
1688 * default for max_stack_depth. InitializeGUCOptions will increase it if
1689 * possible, depending on the actual platform-specific stack limit.
1692 {"max_stack_depth", PGC_SUSET, RESOURCES_MEM,
1693 gettext_noop("Sets the maximum stack depth, in kilobytes."),
1698 100, 100, MAX_KILOBYTES,
1699 check_max_stack_depth, assign_max_stack_depth, NULL
1703 {"temp_file_limit", PGC_SUSET, RESOURCES_DISK,
1704 gettext_noop("Limits the total size of all temp files used by each session."),
1705 gettext_noop("-1 means no limit."),
1714 {"vacuum_cost_page_hit", PGC_USERSET, RESOURCES_VACUUM_DELAY,
1715 gettext_noop("Vacuum cost for a page found in the buffer cache."),
1724 {"vacuum_cost_page_miss", PGC_USERSET, RESOURCES_VACUUM_DELAY,
1725 gettext_noop("Vacuum cost for a page not found in the buffer cache."),
1728 &VacuumCostPageMiss,
1734 {"vacuum_cost_page_dirty", PGC_USERSET, RESOURCES_VACUUM_DELAY,
1735 gettext_noop("Vacuum cost for a page dirtied by vacuum."),
1738 &VacuumCostPageDirty,
1744 {"vacuum_cost_limit", PGC_USERSET, RESOURCES_VACUUM_DELAY,
1745 gettext_noop("Vacuum cost amount available before napping."),
1754 {"vacuum_cost_delay", PGC_USERSET, RESOURCES_VACUUM_DELAY,
1755 gettext_noop("Vacuum cost delay in milliseconds."),
1765 {"autovacuum_vacuum_cost_delay", PGC_SIGHUP, AUTOVACUUM,
1766 gettext_noop("Vacuum cost delay in milliseconds, for autovacuum."),
1770 &autovacuum_vac_cost_delay,
1776 {"autovacuum_vacuum_cost_limit", PGC_SIGHUP, AUTOVACUUM,
1777 gettext_noop("Vacuum cost amount available before napping, for autovacuum."),
1780 &autovacuum_vac_cost_limit,
1786 {"max_files_per_process", PGC_POSTMASTER, RESOURCES_KERNEL,
1787 gettext_noop("Sets the maximum number of simultaneously open files for each server process."),
1790 &max_files_per_process,
1796 * See also CheckRequiredParameterValues() if this parameter changes
1799 {"max_prepared_transactions", PGC_POSTMASTER, RESOURCES_MEM,
1800 gettext_noop("Sets the maximum number of simultaneously prepared transactions."),
1803 &max_prepared_xacts,
1810 {"trace_lock_oidmin", PGC_SUSET, DEVELOPER_OPTIONS,
1811 gettext_noop("No description available."),
1816 FirstNormalObjectId, 0, INT_MAX,
1820 {"trace_lock_table", PGC_SUSET, DEVELOPER_OPTIONS,
1821 gettext_noop("No description available."),
1832 {"statement_timeout", PGC_USERSET, CLIENT_CONN_STATEMENT,
1833 gettext_noop("Sets the maximum allowed duration of any statement."),
1834 gettext_noop("A value of 0 turns off the timeout."),
1843 {"vacuum_freeze_min_age", PGC_USERSET, CLIENT_CONN_STATEMENT,
1844 gettext_noop("Minimum age at which VACUUM should freeze a table row."),
1847 &vacuum_freeze_min_age,
1848 50000000, 0, 1000000000,
1853 {"vacuum_freeze_table_age", PGC_USERSET, CLIENT_CONN_STATEMENT,
1854 gettext_noop("Age at which VACUUM should scan whole table to freeze tuples."),
1857 &vacuum_freeze_table_age,
1858 150000000, 0, 2000000000,
1863 {"vacuum_defer_cleanup_age", PGC_SIGHUP, REPLICATION_MASTER,
1864 gettext_noop("Number of transactions by which VACUUM and HOT cleanup should be deferred, if any."),
1867 &vacuum_defer_cleanup_age,
1873 * See also CheckRequiredParameterValues() if this parameter changes
1876 {"max_locks_per_transaction", PGC_POSTMASTER, LOCK_MANAGEMENT,
1877 gettext_noop("Sets the maximum number of locks per transaction."),
1878 gettext_noop("The shared lock table is sized on the assumption that "
1879 "at most max_locks_per_transaction * max_connections distinct "
1880 "objects will need to be locked at any one time.")
1882 &max_locks_per_xact,
1888 {"max_pred_locks_per_transaction", PGC_POSTMASTER, LOCK_MANAGEMENT,
1889 gettext_noop("Sets the maximum number of predicate locks per transaction."),
1890 gettext_noop("The shared predicate lock table is sized on the assumption that "
1891 "at most max_pred_locks_per_transaction * max_connections distinct "
1892 "objects will need to be locked at any one time.")
1894 &max_predicate_locks_per_xact,
1900 {"authentication_timeout", PGC_SIGHUP, CONN_AUTH_SECURITY,
1901 gettext_noop("Sets the maximum allowed time to complete client authentication."),
1905 &AuthenticationTimeout,
1911 /* Not for general use */
1912 {"pre_auth_delay", PGC_SIGHUP, DEVELOPER_OPTIONS,
1913 gettext_noop("Waits N seconds on connection startup before authentication."),
1914 gettext_noop("This allows attaching a debugger to the process."),
1915 GUC_NOT_IN_SAMPLE | GUC_UNIT_S
1923 {"wal_keep_segments", PGC_SIGHUP, REPLICATION_SENDING,
1924 gettext_noop("Sets the number of WAL files held for standby servers."),
1933 {"checkpoint_segments", PGC_SIGHUP, WAL_CHECKPOINTS,
1934 gettext_noop("Sets the maximum distance in log segments between automatic WAL checkpoints."),
1937 &CheckPointSegments,
1943 {"checkpoint_timeout", PGC_SIGHUP, WAL_CHECKPOINTS,
1944 gettext_noop("Sets the maximum time between automatic WAL checkpoints."),
1954 {"checkpoint_warning", PGC_SIGHUP, WAL_CHECKPOINTS,
1955 gettext_noop("Enables warnings if checkpoint segments are filled more "
1956 "frequently than this."),
1957 gettext_noop("Write a message to the server log if checkpoints "
1958 "caused by the filling of checkpoint segment files happens more "
1959 "frequently than this number of seconds. Zero turns off the warning."),
1968 {"wal_buffers", PGC_POSTMASTER, WAL_SETTINGS,
1969 gettext_noop("Sets the number of disk-page buffers in shared memory for WAL."),
1975 check_wal_buffers, NULL, NULL
1979 {"wal_writer_delay", PGC_SIGHUP, WAL_SETTINGS,
1980 gettext_noop("WAL writer sleep time between WAL flushes."),
1990 /* see max_connections */
1991 {"max_wal_senders", PGC_POSTMASTER, REPLICATION_SENDING,
1992 gettext_noop("Sets the maximum number of simultaneously running WAL sender processes."),
2001 {"replication_timeout", PGC_SIGHUP, REPLICATION_SENDING,
2002 gettext_noop("Sets the maximum time to wait for WAL replication."),
2006 &replication_timeout,
2007 60 * 1000, 0, INT_MAX,
2012 {"commit_delay", PGC_USERSET, WAL_SETTINGS,
2013 gettext_noop("Sets the delay in microseconds between transaction commit and "
2014 "flushing WAL to disk."),
2023 {"commit_siblings", PGC_USERSET, WAL_SETTINGS,
2024 gettext_noop("Sets the minimum concurrent open transactions before performing "
2034 {"extra_float_digits", PGC_USERSET, CLIENT_CONN_LOCALE,
2035 gettext_noop("Sets the number of digits displayed for floating-point values."),
2036 gettext_noop("This affects real, double precision, and geometric data types. "
2037 "The parameter value is added to the standard number of digits "
2038 "(FLT_DIG or DBL_DIG as appropriate).")
2040 &extra_float_digits,
2046 {"log_min_duration_statement", PGC_SUSET, LOGGING_WHEN,
2047 gettext_noop("Sets the minimum execution time above which "
2048 "statements will be logged."),
2049 gettext_noop("Zero prints all queries. -1 turns this feature off."),
2052 &log_min_duration_statement,
2058 {"log_autovacuum_min_duration", PGC_SIGHUP, LOGGING_WHAT,
2059 gettext_noop("Sets the minimum execution time above which "
2060 "autovacuum actions will be logged."),
2061 gettext_noop("Zero prints all actions. -1 turns autovacuum logging off."),
2064 &Log_autovacuum_min_duration,
2070 {"bgwriter_delay", PGC_SIGHUP, RESOURCES_BGWRITER,
2071 gettext_noop("Background writer sleep time between rounds."),
2081 {"bgwriter_lru_maxpages", PGC_SIGHUP, RESOURCES_BGWRITER,
2082 gettext_noop("Background writer maximum number of LRU pages to flush per round."),
2085 &bgwriter_lru_maxpages,
2091 {"effective_io_concurrency",
2097 RESOURCES_ASYNCHRONOUS,
2098 gettext_noop("Number of simultaneous requests that can be handled efficiently by the disk subsystem."),
2099 gettext_noop("For RAID arrays, this should be approximately the number of drive spindles in the array.")
2101 &effective_io_concurrency,
2107 check_effective_io_concurrency, assign_effective_io_concurrency, NULL
2111 {"log_rotation_age", PGC_SIGHUP, LOGGING_WHERE,
2112 gettext_noop("Automatic log file rotation will occur after N minutes."),
2117 HOURS_PER_DAY * MINS_PER_HOUR, 0, INT_MAX / MINS_PER_HOUR,
2122 {"log_rotation_size", PGC_SIGHUP, LOGGING_WHERE,
2123 gettext_noop("Automatic log file rotation will occur after N kilobytes."),
2128 10 * 1024, 0, INT_MAX / 1024,
2133 {"max_function_args", PGC_INTERNAL, PRESET_OPTIONS,
2134 gettext_noop("Shows the maximum number of function arguments."),
2136 GUC_NOT_IN_SAMPLE | GUC_DISALLOW_IN_FILE
2139 FUNC_MAX_ARGS, FUNC_MAX_ARGS, FUNC_MAX_ARGS,
2144 {"max_index_keys", PGC_INTERNAL, PRESET_OPTIONS,
2145 gettext_noop("Shows the maximum number of index keys."),
2147 GUC_NOT_IN_SAMPLE | GUC_DISALLOW_IN_FILE
2150 INDEX_MAX_KEYS, INDEX_MAX_KEYS, INDEX_MAX_KEYS,
2155 {"max_identifier_length", PGC_INTERNAL, PRESET_OPTIONS,
2156 gettext_noop("Shows the maximum identifier length."),
2158 GUC_NOT_IN_SAMPLE | GUC_DISALLOW_IN_FILE
2160 &max_identifier_length,
2161 NAMEDATALEN - 1, NAMEDATALEN - 1, NAMEDATALEN - 1,
2166 {"block_size", PGC_INTERNAL, PRESET_OPTIONS,
2167 gettext_noop("Shows the size of a disk block."),
2169 GUC_NOT_IN_SAMPLE | GUC_DISALLOW_IN_FILE
2172 BLCKSZ, BLCKSZ, BLCKSZ,
2177 {"segment_size", PGC_INTERNAL, PRESET_OPTIONS,
2178 gettext_noop("Shows the number of pages per disk file."),
2180 GUC_UNIT_BLOCKS | GUC_NOT_IN_SAMPLE | GUC_DISALLOW_IN_FILE
2183 RELSEG_SIZE, RELSEG_SIZE, RELSEG_SIZE,
2188 {"wal_block_size", PGC_INTERNAL, PRESET_OPTIONS,
2189 gettext_noop("Shows the block size in the write ahead log."),
2191 GUC_NOT_IN_SAMPLE | GUC_DISALLOW_IN_FILE
2194 XLOG_BLCKSZ, XLOG_BLCKSZ, XLOG_BLCKSZ,
2199 {"wal_segment_size", PGC_INTERNAL, PRESET_OPTIONS,
2200 gettext_noop("Shows the number of pages per write ahead log segment."),
2202 GUC_UNIT_XBLOCKS | GUC_NOT_IN_SAMPLE | GUC_DISALLOW_IN_FILE
2205 (XLOG_SEG_SIZE / XLOG_BLCKSZ),
2206 (XLOG_SEG_SIZE / XLOG_BLCKSZ),
2207 (XLOG_SEG_SIZE / XLOG_BLCKSZ),
2212 {"autovacuum_naptime", PGC_SIGHUP, AUTOVACUUM,
2213 gettext_noop("Time to sleep between autovacuum runs."),
2217 &autovacuum_naptime,
2218 60, 1, INT_MAX / 1000,
2222 {"autovacuum_vacuum_threshold", PGC_SIGHUP, AUTOVACUUM,
2223 gettext_noop("Minimum number of tuple updates or deletes prior to vacuum."),
2226 &autovacuum_vac_thresh,
2231 {"autovacuum_analyze_threshold", PGC_SIGHUP, AUTOVACUUM,
2232 gettext_noop("Minimum number of tuple inserts, updates or deletes prior to analyze."),
2235 &autovacuum_anl_thresh,
2240 /* see varsup.c for why this is PGC_POSTMASTER not PGC_SIGHUP */
2241 {"autovacuum_freeze_max_age", PGC_POSTMASTER, AUTOVACUUM,
2242 gettext_noop("Age at which to autovacuum a table to prevent transaction ID wraparound."),
2245 &autovacuum_freeze_max_age,
2246 /* see pg_resetxlog if you change the upper-limit value */
2247 200000000, 100000000, 2000000000,
2251 /* see max_connections */
2252 {"autovacuum_max_workers", PGC_POSTMASTER, AUTOVACUUM,
2253 gettext_noop("Sets the maximum number of simultaneously running autovacuum worker processes."),
2256 &autovacuum_max_workers,
2258 check_autovacuum_max_workers, assign_autovacuum_max_workers, NULL
2262 {"tcp_keepalives_idle", PGC_USERSET, CLIENT_CONN_OTHER,
2263 gettext_noop("Time between issuing TCP keepalives."),
2264 gettext_noop("A value of 0 uses the system default."),
2267 &tcp_keepalives_idle,
2269 NULL, assign_tcp_keepalives_idle, show_tcp_keepalives_idle
2273 {"tcp_keepalives_interval", PGC_USERSET, CLIENT_CONN_OTHER,
2274 gettext_noop("Time between TCP keepalive retransmits."),
2275 gettext_noop("A value of 0 uses the system default."),
2278 &tcp_keepalives_interval,
2280 NULL, assign_tcp_keepalives_interval, show_tcp_keepalives_interval
2284 {"ssl_renegotiation_limit", PGC_USERSET, CONN_AUTH_SECURITY,
2285 gettext_noop("Set the amount of traffic to send and receive before renegotiating the encryption keys."),
2289 &ssl_renegotiation_limit,
2290 512 * 1024, 0, MAX_KILOBYTES,
2295 {"tcp_keepalives_count", PGC_USERSET, CLIENT_CONN_OTHER,
2296 gettext_noop("Maximum number of TCP keepalive retransmits."),
2297 gettext_noop("This controls the number of consecutive keepalive retransmits that can be "
2298 "lost before a connection is considered dead. A value of 0 uses the "
2301 &tcp_keepalives_count,
2303 NULL, assign_tcp_keepalives_count, show_tcp_keepalives_count
2307 {"gin_fuzzy_search_limit", PGC_USERSET, CLIENT_CONN_OTHER,
2308 gettext_noop("Sets the maximum allowed result for exact search by GIN."),
2312 &GinFuzzySearchLimit,
2318 {"effective_cache_size", PGC_USERSET, QUERY_TUNING_COST,
2319 gettext_noop("Sets the planner's assumption about the size of the disk cache."),
2320 gettext_noop("That is, the portion of the kernel's disk cache that "
2321 "will be used for PostgreSQL data files. This is measured in disk "
2322 "pages, which are normally 8 kB each."),
2325 &effective_cache_size,
2326 DEFAULT_EFFECTIVE_CACHE_SIZE, 1, INT_MAX,
2331 /* Can't be set in postgresql.conf */
2332 {"server_version_num", PGC_INTERNAL, PRESET_OPTIONS,
2333 gettext_noop("Shows the server version as an integer."),
2335 GUC_NOT_IN_SAMPLE | GUC_DISALLOW_IN_FILE
2337 &server_version_num,
2338 PG_VERSION_NUM, PG_VERSION_NUM, PG_VERSION_NUM,
2343 {"log_temp_files", PGC_SUSET, LOGGING_WHAT,
2344 gettext_noop("Log the use of temporary files larger than this number of kilobytes."),
2345 gettext_noop("Zero logs all files. The default is -1 (turning this feature off)."),
2354 {"track_activity_query_size", PGC_POSTMASTER, RESOURCES_MEM,
2355 gettext_noop("Sets the size reserved for pg_stat_activity.current_query, in bytes."),
2358 &pgstat_track_activity_query_size,
2363 /* End-of-list marker */
2365 {NULL, 0, 0, NULL, NULL}, NULL, 0, 0, 0, NULL, NULL, NULL
2370 static struct config_real ConfigureNamesReal[] =
2373 {"seq_page_cost", PGC_USERSET, QUERY_TUNING_COST,
2374 gettext_noop("Sets the planner's estimate of the cost of a "
2375 "sequentially fetched disk page."),
2379 DEFAULT_SEQ_PAGE_COST, 0, DBL_MAX,
2383 {"random_page_cost", PGC_USERSET, QUERY_TUNING_COST,
2384 gettext_noop("Sets the planner's estimate of the cost of a "
2385 "nonsequentially fetched disk page."),
2389 DEFAULT_RANDOM_PAGE_COST, 0, DBL_MAX,
2393 {"cpu_tuple_cost", PGC_USERSET, QUERY_TUNING_COST,
2394 gettext_noop("Sets the planner's estimate of the cost of "
2395 "processing each tuple (row)."),
2399 DEFAULT_CPU_TUPLE_COST, 0, DBL_MAX,
2403 {"cpu_index_tuple_cost", PGC_USERSET, QUERY_TUNING_COST,
2404 gettext_noop("Sets the planner's estimate of the cost of "
2405 "processing each index entry during an index scan."),
2408 &cpu_index_tuple_cost,
2409 DEFAULT_CPU_INDEX_TUPLE_COST, 0, DBL_MAX,
2413 {"cpu_operator_cost", PGC_USERSET, QUERY_TUNING_COST,
2414 gettext_noop("Sets the planner's estimate of the cost of "
2415 "processing each operator or function call."),
2419 DEFAULT_CPU_OPERATOR_COST, 0, DBL_MAX,
2424 {"cursor_tuple_fraction", PGC_USERSET, QUERY_TUNING_OTHER,
2425 gettext_noop("Sets the planner's estimate of the fraction of "
2426 "a cursor's rows that will be retrieved."),
2429 &cursor_tuple_fraction,
2430 DEFAULT_CURSOR_TUPLE_FRACTION, 0.0, 1.0,
2435 {"geqo_selection_bias", PGC_USERSET, QUERY_TUNING_GEQO,
2436 gettext_noop("GEQO: selective pressure within the population."),
2439 &Geqo_selection_bias,
2440 DEFAULT_GEQO_SELECTION_BIAS,
2441 MIN_GEQO_SELECTION_BIAS, MAX_GEQO_SELECTION_BIAS,
2445 {"geqo_seed", PGC_USERSET, QUERY_TUNING_GEQO,
2446 gettext_noop("GEQO: seed for random path selection."),
2455 {"bgwriter_lru_multiplier", PGC_SIGHUP, RESOURCES_BGWRITER,
2456 gettext_noop("Multiple of the average buffer usage to free per round."),
2459 &bgwriter_lru_multiplier,
2465 {"seed", PGC_USERSET, UNGROUPED,
2466 gettext_noop("Sets the seed for random-number generation."),
2468 GUC_NO_SHOW_ALL | GUC_NO_RESET_ALL | GUC_NOT_IN_SAMPLE | GUC_DISALLOW_IN_FILE
2472 check_random_seed, assign_random_seed, show_random_seed
2476 {"autovacuum_vacuum_scale_factor", PGC_SIGHUP, AUTOVACUUM,
2477 gettext_noop("Number of tuple updates or deletes prior to vacuum as a fraction of reltuples."),
2480 &autovacuum_vac_scale,
2485 {"autovacuum_analyze_scale_factor", PGC_SIGHUP, AUTOVACUUM,
2486 gettext_noop("Number of tuple inserts, updates or deletes prior to analyze as a fraction of reltuples."),
2489 &autovacuum_anl_scale,
2495 {"checkpoint_completion_target", PGC_SIGHUP, WAL_CHECKPOINTS,
2496 gettext_noop("Time spent flushing dirty buffers during checkpoint, as fraction of checkpoint interval."),
2499 &CheckPointCompletionTarget,
2504 /* End-of-list marker */
2506 {NULL, 0, 0, NULL, NULL}, NULL, 0.0, 0.0, 0.0, NULL, NULL, NULL
2511 static struct config_string ConfigureNamesString[] =
2514 {"archive_command", PGC_SIGHUP, WAL_ARCHIVING,
2515 gettext_noop("Sets the shell command that will be called to archive a WAL file."),
2518 &XLogArchiveCommand,
2520 NULL, NULL, show_archive_command
2524 {"client_encoding", PGC_USERSET, CLIENT_CONN_LOCALE,
2525 gettext_noop("Sets the client's character set encoding."),
2527 GUC_IS_NAME | GUC_REPORT
2529 &client_encoding_string,
2531 check_client_encoding, assign_client_encoding, NULL
2535 {"log_line_prefix", PGC_SIGHUP, LOGGING_WHAT,
2536 gettext_noop("Controls information prefixed to each log line."),
2537 gettext_noop("If blank, no prefix is used.")
2545 {"log_timezone", PGC_SIGHUP, LOGGING_WHAT,
2546 gettext_noop("Sets the time zone to use in log messages."),
2549 &log_timezone_string,
2551 check_log_timezone, assign_log_timezone, show_log_timezone
2555 {"DateStyle", PGC_USERSET, CLIENT_CONN_LOCALE,
2556 gettext_noop("Sets the display format for date and time values."),
2557 gettext_noop("Also controls interpretation of ambiguous "
2559 GUC_LIST_INPUT | GUC_REPORT
2563 check_datestyle, assign_datestyle, NULL
2567 {"default_tablespace", PGC_USERSET, CLIENT_CONN_STATEMENT,
2568 gettext_noop("Sets the default tablespace to create tables and indexes in."),
2569 gettext_noop("An empty string selects the database's default tablespace."),
2572 &default_tablespace,
2574 check_default_tablespace, NULL, NULL
2578 {"temp_tablespaces", PGC_USERSET, CLIENT_CONN_STATEMENT,
2579 gettext_noop("Sets the tablespace(s) to use for temporary tables and sort files."),
2581 GUC_LIST_INPUT | GUC_LIST_QUOTE
2585 check_temp_tablespaces, assign_temp_tablespaces, NULL
2589 {"dynamic_library_path", PGC_SUSET, CLIENT_CONN_OTHER,
2590 gettext_noop("Sets the path for dynamically loadable modules."),
2591 gettext_noop("If a dynamically loadable module needs to be opened and "
2592 "the specified name does not have a directory component (i.e., the "
2593 "name does not contain a slash), the system will search this path for "
2594 "the specified file."),
2597 &Dynamic_library_path,
2603 {"krb_server_keyfile", PGC_SIGHUP, CONN_AUTH_SECURITY,
2604 gettext_noop("Sets the location of the Kerberos server key file."),
2608 &pg_krb_server_keyfile,
2614 {"krb_srvname", PGC_SIGHUP, CONN_AUTH_SECURITY,
2615 gettext_noop("Sets the name of the Kerberos service."),
2624 {"bonjour_name", PGC_POSTMASTER, CONN_AUTH_SETTINGS,
2625 gettext_noop("Sets the Bonjour service name."),
2633 /* See main.c about why defaults for LC_foo are not all alike */
2636 {"lc_collate", PGC_INTERNAL, CLIENT_CONN_LOCALE,
2637 gettext_noop("Shows the collation order locale."),
2639 GUC_NOT_IN_SAMPLE | GUC_DISALLOW_IN_FILE
2647 {"lc_ctype", PGC_INTERNAL, CLIENT_CONN_LOCALE,
2648 gettext_noop("Shows the character classification and case conversion locale."),
2650 GUC_NOT_IN_SAMPLE | GUC_DISALLOW_IN_FILE
2658 {"lc_messages", PGC_SUSET, CLIENT_CONN_LOCALE,
2659 gettext_noop("Sets the language in which messages are displayed."),
2664 check_locale_messages, assign_locale_messages, NULL
2668 {"lc_monetary", PGC_USERSET, CLIENT_CONN_LOCALE,
2669 gettext_noop("Sets the locale for formatting monetary amounts."),
2674 check_locale_monetary, assign_locale_monetary, NULL
2678 {"lc_numeric", PGC_USERSET, CLIENT_CONN_LOCALE,
2679 gettext_noop("Sets the locale for formatting numbers."),
2684 check_locale_numeric, assign_locale_numeric, NULL
2688 {"lc_time", PGC_USERSET, CLIENT_CONN_LOCALE,
2689 gettext_noop("Sets the locale for formatting date and time values."),
2694 check_locale_time, assign_locale_time, NULL
2698 {"shared_preload_libraries", PGC_POSTMASTER, RESOURCES_KERNEL,
2699 gettext_noop("Lists shared libraries to preload into server."),
2701 GUC_LIST_INPUT | GUC_LIST_QUOTE | GUC_SUPERUSER_ONLY
2703 &shared_preload_libraries_string,
2709 {"local_preload_libraries", PGC_BACKEND, CLIENT_CONN_OTHER,
2710 gettext_noop("Lists shared libraries to preload into each backend."),
2712 GUC_LIST_INPUT | GUC_LIST_QUOTE
2714 &local_preload_libraries_string,
2720 {"search_path", PGC_USERSET, CLIENT_CONN_STATEMENT,
2721 gettext_noop("Sets the schema search order for names that are not schema-qualified."),
2723 GUC_LIST_INPUT | GUC_LIST_QUOTE
2725 &namespace_search_path,
2727 check_search_path, assign_search_path, NULL
2731 /* Can't be set in postgresql.conf */
2732 {"server_encoding", PGC_INTERNAL, CLIENT_CONN_LOCALE,
2733 gettext_noop("Sets the server (database) character set encoding."),
2735 GUC_IS_NAME | GUC_REPORT | GUC_NOT_IN_SAMPLE | GUC_DISALLOW_IN_FILE
2737 &server_encoding_string,
2743 /* Can't be set in postgresql.conf */
2744 {"server_version", PGC_INTERNAL, PRESET_OPTIONS,
2745 gettext_noop("Shows the server version."),
2747 GUC_REPORT | GUC_NOT_IN_SAMPLE | GUC_DISALLOW_IN_FILE
2749 &server_version_string,
2755 /* Not for general use --- used by SET ROLE */
2756 {"role", PGC_USERSET, UNGROUPED,
2757 gettext_noop("Sets the current role."),
2759 GUC_IS_NAME | GUC_NO_SHOW_ALL | GUC_NO_RESET_ALL | GUC_NOT_IN_SAMPLE | GUC_DISALLOW_IN_FILE | GUC_NOT_WHILE_SEC_REST
2763 check_role, assign_role, show_role
2767 /* Not for general use --- used by SET SESSION AUTHORIZATION */
2768 {"session_authorization", PGC_USERSET, UNGROUPED,
2769 gettext_noop("Sets the session user name."),
2771 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
2773 &session_authorization_string,
2775 check_session_authorization, assign_session_authorization, NULL
2779 {"log_destination", PGC_SIGHUP, LOGGING_WHERE,
2780 gettext_noop("Sets the destination for server log output."),
2781 gettext_noop("Valid values are combinations of \"stderr\", "
2782 "\"syslog\", \"csvlog\", and \"eventlog\", "
2783 "depending on the platform."),
2786 &log_destination_string,
2788 check_log_destination, assign_log_destination, NULL
2791 {"log_directory", PGC_SIGHUP, LOGGING_WHERE,
2792 gettext_noop("Sets the destination directory for log files."),
2793 gettext_noop("Can be specified as relative to the data directory "
2794 "or as absolute path."),
2799 check_canonical_path, NULL, NULL
2802 {"log_filename", PGC_SIGHUP, LOGGING_WHERE,
2803 gettext_noop("Sets the file name pattern for log files."),
2808 "postgresql-%Y-%m-%d_%H%M%S.log",
2813 {"syslog_ident", PGC_SIGHUP, LOGGING_WHERE,
2814 gettext_noop("Sets the program name used to identify PostgreSQL "
2815 "messages in syslog."),
2820 NULL, assign_syslog_ident, NULL
2824 {"TimeZone", PGC_USERSET, CLIENT_CONN_LOCALE,
2825 gettext_noop("Sets the time zone for displaying and interpreting time stamps."),
2831 check_timezone, assign_timezone, show_timezone
2834 {"timezone_abbreviations", PGC_USERSET, CLIENT_CONN_LOCALE,
2835 gettext_noop("Selects a file of time zone abbreviations."),
2838 &timezone_abbreviations_string,
2840 check_timezone_abbreviations, assign_timezone_abbreviations, NULL
2844 {"transaction_isolation", PGC_USERSET, CLIENT_CONN_STATEMENT,
2845 gettext_noop("Sets the current transaction's isolation level."),
2847 GUC_NO_RESET_ALL | GUC_NOT_IN_SAMPLE | GUC_DISALLOW_IN_FILE
2849 &XactIsoLevel_string,
2851 check_XactIsoLevel, assign_XactIsoLevel, show_XactIsoLevel
2855 {"unix_socket_group", PGC_POSTMASTER, CONN_AUTH_SETTINGS,
2856 gettext_noop("Sets the owning group of the Unix-domain socket."),
2857 gettext_noop("The owning user of the socket is always the user "
2858 "that starts the server.")
2866 {"unix_socket_directory", PGC_POSTMASTER, CONN_AUTH_SETTINGS,
2867 gettext_noop("Sets the directory where the Unix-domain socket will be created."),
2873 check_canonical_path, NULL, NULL
2877 {"listen_addresses", PGC_POSTMASTER, CONN_AUTH_SETTINGS,
2878 gettext_noop("Sets the host name or IP address(es) to listen to."),
2888 {"custom_variable_classes", PGC_SIGHUP, CUSTOM_OPTIONS,
2889 gettext_noop("Sets the list of known custom variable classes."),
2891 GUC_LIST_INPUT | GUC_LIST_QUOTE
2893 &custom_variable_classes,
2895 check_custom_variable_classes, NULL, NULL
2899 {"data_directory", PGC_POSTMASTER, FILE_LOCATIONS,
2900 gettext_noop("Sets the server's data directory."),
2910 {"config_file", PGC_POSTMASTER, FILE_LOCATIONS,
2911 gettext_noop("Sets the server's main configuration file."),
2913 GUC_DISALLOW_IN_FILE | GUC_SUPERUSER_ONLY
2921 {"hba_file", PGC_POSTMASTER, FILE_LOCATIONS,
2922 gettext_noop("Sets the server's \"hba\" configuration file."),
2932 {"ident_file", PGC_POSTMASTER, FILE_LOCATIONS,
2933 gettext_noop("Sets the server's \"ident\" configuration file."),
2943 {"external_pid_file", PGC_POSTMASTER, FILE_LOCATIONS,
2944 gettext_noop("Writes the postmaster PID to the specified file."),
2950 check_canonical_path, NULL, NULL
2954 {"stats_temp_directory", PGC_SIGHUP, STATS_COLLECTOR,
2955 gettext_noop("Writes temporary statistics files to the specified directory."),
2959 &pgstat_temp_directory,
2961 check_canonical_path, assign_pgstat_temp_directory, NULL
2965 {"synchronous_standby_names", PGC_SIGHUP, REPLICATION_MASTER,
2966 gettext_noop("List of names of potential synchronous standbys."),
2970 &SyncRepStandbyNames,
2972 check_synchronous_standby_names, NULL, NULL
2976 {"default_text_search_config", PGC_USERSET, CLIENT_CONN_LOCALE,
2977 gettext_noop("Sets default text search configuration."),
2981 "pg_catalog.simple",
2982 check_TSCurrentConfig, assign_TSCurrentConfig, NULL
2986 {"ssl_ciphers", PGC_POSTMASTER, CONN_AUTH_SECURITY,
2987 gettext_noop("Sets the list of allowed SSL ciphers."),
2993 "ALL:!ADH:!LOW:!EXP:!MD5:@STRENGTH",
3001 {"application_name", PGC_USERSET, LOGGING_WHAT,
3002 gettext_noop("Sets the application name to be reported in statistics and logs."),
3004 GUC_IS_NAME | GUC_REPORT | GUC_NOT_IN_SAMPLE
3008 check_application_name, assign_application_name, NULL
3011 /* End-of-list marker */
3013 {NULL, 0, 0, NULL, NULL}, NULL, NULL, NULL, NULL, NULL
3018 static struct config_enum ConfigureNamesEnum[] =
3021 {"backslash_quote", PGC_USERSET, COMPAT_OPTIONS_PREVIOUS,
3022 gettext_noop("Sets whether \"\\'\" is allowed in string literals."),
3026 BACKSLASH_QUOTE_SAFE_ENCODING, backslash_quote_options,
3031 {"bytea_output", PGC_USERSET, CLIENT_CONN_STATEMENT,
3032 gettext_noop("Sets the output format for bytea."),
3036 BYTEA_OUTPUT_HEX, bytea_output_options,
3041 {"client_min_messages", PGC_USERSET, LOGGING_WHEN,
3042 gettext_noop("Sets the message levels that are sent to the client."),
3043 gettext_noop("Each level includes all the levels that follow it. The later"
3044 " the level, the fewer messages are sent.")
3046 &client_min_messages,
3047 NOTICE, client_message_level_options,
3052 {"constraint_exclusion", PGC_USERSET, QUERY_TUNING_OTHER,
3053 gettext_noop("Enables the planner to use constraints to optimize queries."),
3054 gettext_noop("Table scans will be skipped if their constraints"
3055 " guarantee that no rows match the query.")
3057 &constraint_exclusion,
3058 CONSTRAINT_EXCLUSION_PARTITION, constraint_exclusion_options,
3063 {"default_transaction_isolation", PGC_USERSET, CLIENT_CONN_STATEMENT,
3064 gettext_noop("Sets the transaction isolation level of each new transaction."),
3067 &DefaultXactIsoLevel,
3068 XACT_READ_COMMITTED, isolation_level_options,
3073 {"IntervalStyle", PGC_USERSET, CLIENT_CONN_LOCALE,
3074 gettext_noop("Sets the display format for interval values."),
3079 INTSTYLE_POSTGRES, intervalstyle_options,
3084 {"log_error_verbosity", PGC_SUSET, LOGGING_WHAT,
3085 gettext_noop("Sets the verbosity of logged messages."),
3088 &Log_error_verbosity,
3089 PGERROR_DEFAULT, log_error_verbosity_options,
3094 {"log_min_messages", PGC_SUSET, LOGGING_WHEN,
3095 gettext_noop("Sets the message levels that are logged."),
3096 gettext_noop("Each level includes all the levels that follow it. The later"
3097 " the level, the fewer messages are sent.")
3100 WARNING, server_message_level_options,
3105 {"log_min_error_statement", PGC_SUSET, LOGGING_WHEN,
3106 gettext_noop("Causes all statements generating error at or above this level to be logged."),
3107 gettext_noop("Each level includes all the levels that follow it. The later"
3108 " the level, the fewer messages are sent.")
3110 &log_min_error_statement,
3111 ERROR, server_message_level_options,
3116 {"log_statement", PGC_SUSET, LOGGING_WHAT,
3117 gettext_noop("Sets the type of statements logged."),
3121 LOGSTMT_NONE, log_statement_options,
3126 {"syslog_facility", PGC_SIGHUP, LOGGING_WHERE,
3127 gettext_noop("Sets the syslog \"facility\" to be used when syslog enabled."),
3136 syslog_facility_options,
3137 NULL, assign_syslog_facility, NULL
3141 {"session_replication_role", PGC_SUSET, CLIENT_CONN_STATEMENT,
3142 gettext_noop("Sets the session's behavior for triggers and rewrite rules."),
3145 &SessionReplicationRole,
3146 SESSION_REPLICATION_ROLE_ORIGIN, session_replication_role_options,
3147 NULL, assign_session_replication_role, NULL
3151 {"synchronous_commit", PGC_USERSET, WAL_SETTINGS,
3152 gettext_noop("Sets the current transaction's synchronization level."),
3155 &synchronous_commit,
3156 SYNCHRONOUS_COMMIT_ON, synchronous_commit_options,
3161 {"trace_recovery_messages", PGC_SIGHUP, DEVELOPER_OPTIONS,
3162 gettext_noop("Enables logging of recovery-related debugging information."),
3163 gettext_noop("Each level includes all the levels that follow it. The later"
3164 " the level, the fewer messages are sent.")
3166 &trace_recovery_messages,
3169 * client_message_level_options allows too many values, really, but
3170 * it's not worth having a separate options array for this.
3172 LOG, client_message_level_options,
3177 {"track_functions", PGC_SUSET, STATS_COLLECTOR,
3178 gettext_noop("Collects function-level statistics on database activity."),
3181 &pgstat_track_functions,
3182 TRACK_FUNC_OFF, track_function_options,
3187 {"wal_level", PGC_POSTMASTER, WAL_SETTINGS,
3188 gettext_noop("Set the level of information written to the WAL."),
3192 WAL_LEVEL_MINIMAL, wal_level_options,
3197 {"wal_sync_method", PGC_SIGHUP, WAL_SETTINGS,
3198 gettext_noop("Selects the method used for forcing WAL updates to disk."),
3202 DEFAULT_SYNC_METHOD, sync_method_options,
3203 NULL, assign_xlog_sync_method, NULL
3207 {"xmlbinary", PGC_USERSET, CLIENT_CONN_STATEMENT,
3208 gettext_noop("Sets how binary values are to be encoded in XML."),
3212 XMLBINARY_BASE64, xmlbinary_options,
3217 {"xmloption", PGC_USERSET, CLIENT_CONN_STATEMENT,
3218 gettext_noop("Sets whether XML data in implicit parsing and serialization "
3219 "operations is to be considered as documents or content fragments."),
3223 XMLOPTION_CONTENT, xmloption_options,
3228 /* End-of-list marker */
3230 {NULL, 0, 0, NULL, NULL}, NULL, 0, NULL, NULL, NULL, NULL
3234 /******** end of options list ********/
3238 * To allow continued support of obsolete names for GUC variables, we apply
3239 * the following mappings to any unrecognized name. Note that an old name
3240 * should be mapped to a new one only if the new variable has very similar
3241 * semantics to the old.
3243 static const char *const map_old_guc_names[] = {
3244 "sort_mem", "work_mem",
3245 "vacuum_mem", "maintenance_work_mem",
3251 * Actual lookup of variables is done through this single, sorted array.
3253 static struct config_generic **guc_variables;
3255 /* Current number of variables contained in the vector */
3256 static int num_guc_variables;
3258 /* Vector capacity */
3259 static int size_guc_variables;
3262 static bool guc_dirty; /* TRUE if need to do commit/abort work */
3264 static bool reporting_enabled; /* TRUE to enable GUC_REPORT */
3266 static int GUCNestLevel = 0; /* 1 when in main transaction */
3269 static int guc_var_compare(const void *a, const void *b);
3270 static int guc_name_compare(const char *namea, const char *nameb);
3271 static void InitializeGUCOptionsFromEnvironment(void);
3272 static void InitializeOneGUCOption(struct config_generic * gconf);
3273 static void push_old_value(struct config_generic * gconf, GucAction action);
3274 static void ReportGUCOption(struct config_generic * record);
3275 static void ShowGUCConfigOption(const char *name, DestReceiver *dest);
3276 static void ShowAllGUCConfig(DestReceiver *dest);
3277 static char *_ShowOption(struct config_generic * record, bool use_units);
3278 static bool validate_option_array_item(const char *name, const char *value,
3279 bool skipIfNoPermissions);
3283 * Some infrastructure for checking malloc/strdup/realloc calls
3286 guc_malloc(int elevel, size_t size)
3290 data = malloc(size);
3293 (errcode(ERRCODE_OUT_OF_MEMORY),
3294 errmsg("out of memory")));
3299 guc_realloc(int elevel, void *old, size_t size)
3303 data = realloc(old, size);
3306 (errcode(ERRCODE_OUT_OF_MEMORY),
3307 errmsg("out of memory")));
3312 guc_strdup(int elevel, const char *src)
3319 (errcode(ERRCODE_OUT_OF_MEMORY),
3320 errmsg("out of memory")));
3326 * Detect whether strval is referenced anywhere in a GUC string item
3329 string_field_used(struct config_string * conf, char *strval)
3333 if (strval == *(conf->variable) ||
3334 strval == conf->reset_val ||
3335 strval == conf->boot_val)
3337 for (stack = conf->gen.stack; stack; stack = stack->prev)
3339 if (strval == stack->prior.val.stringval ||
3340 strval == stack->masked.val.stringval)
3347 * Support for assigning to a field of a string GUC item. Free the prior
3348 * value if it's not referenced anywhere else in the item (including stacked
3352 set_string_field(struct config_string * conf, char **field, char *newval)
3354 char *oldval = *field;
3356 /* Do the assignment */
3359 /* Free old value if it's not NULL and isn't referenced anymore */
3360 if (oldval && !string_field_used(conf, oldval))
3365 * Detect whether an "extra" struct is referenced anywhere in a GUC item
3368 extra_field_used(struct config_generic * gconf, void *extra)
3372 if (extra == gconf->extra)
3374 switch (gconf->vartype)
3377 if (extra == ((struct config_bool *) gconf)->reset_extra)
3381 if (extra == ((struct config_int *) gconf)->reset_extra)
3385 if (extra == ((struct config_real *) gconf)->reset_extra)
3389 if (extra == ((struct config_string *) gconf)->reset_extra)
3393 if (extra == ((struct config_enum *) gconf)->reset_extra)
3397 for (stack = gconf->stack; stack; stack = stack->prev)
3399 if (extra == stack->prior.extra ||
3400 extra == stack->masked.extra)
3408 * Support for assigning to an "extra" field of a GUC item. Free the prior
3409 * value if it's not referenced anywhere else in the item (including stacked
3413 set_extra_field(struct config_generic * gconf, void **field, void *newval)
3415 void *oldval = *field;
3417 /* Do the assignment */
3420 /* Free old value if it's not NULL and isn't referenced anymore */
3421 if (oldval && !extra_field_used(gconf, oldval))
3426 * Support for copying a variable's active value into a stack entry.
3427 * The "extra" field associated with the active value is copied, too.
3429 * NB: be sure stringval and extra fields of a new stack entry are
3430 * initialized to NULL before this is used, else we'll try to free() them.
3433 set_stack_value(struct config_generic * gconf, config_var_value *val)
3435 switch (gconf->vartype)
3439 *((struct config_bool *) gconf)->variable;
3443 *((struct config_int *) gconf)->variable;
3447 *((struct config_real *) gconf)->variable;
3450 set_string_field((struct config_string *) gconf,
3451 &(val->val.stringval),
3452 *((struct config_string *) gconf)->variable);
3456 *((struct config_enum *) gconf)->variable;
3459 set_extra_field(gconf, &(val->extra), gconf->extra);
3463 * Support for discarding a no-longer-needed value in a stack entry.
3464 * The "extra" field associated with the stack entry is cleared, too.
3467 discard_stack_value(struct config_generic * gconf, config_var_value *val)
3469 switch (gconf->vartype)
3475 /* no need to do anything */
3478 set_string_field((struct config_string *) gconf,
3479 &(val->val.stringval),
3483 set_extra_field(gconf, &(val->extra), NULL);
3488 * Fetch the sorted array pointer (exported for help_config.c's use ONLY)
3490 struct config_generic **
3491 get_guc_variables(void)
3493 return guc_variables;
3498 * Build the sorted array. This is split out so that it could be
3499 * re-executed after startup (eg, we could allow loadable modules to
3500 * add vars, and then we'd need to re-sort).
3503 build_guc_variables(void)
3507 struct config_generic **guc_vars;
3510 for (i = 0; ConfigureNamesBool[i].gen.name; i++)
3512 struct config_bool *conf = &ConfigureNamesBool[i];
3514 /* Rather than requiring vartype to be filled in by hand, do this: */
3515 conf->gen.vartype = PGC_BOOL;
3519 for (i = 0; ConfigureNamesInt[i].gen.name; i++)
3521 struct config_int *conf = &ConfigureNamesInt[i];
3523 conf->gen.vartype = PGC_INT;
3527 for (i = 0; ConfigureNamesReal[i].gen.name; i++)
3529 struct config_real *conf = &ConfigureNamesReal[i];
3531 conf->gen.vartype = PGC_REAL;
3535 for (i = 0; ConfigureNamesString[i].gen.name; i++)
3537 struct config_string *conf = &ConfigureNamesString[i];
3539 conf->gen.vartype = PGC_STRING;
3543 for (i = 0; ConfigureNamesEnum[i].gen.name; i++)
3545 struct config_enum *conf = &ConfigureNamesEnum[i];
3547 conf->gen.vartype = PGC_ENUM;
3552 * Create table with 20% slack
3554 size_vars = num_vars + num_vars / 4;
3556 guc_vars = (struct config_generic **)
3557 guc_malloc(FATAL, size_vars * sizeof(struct config_generic *));
3561 for (i = 0; ConfigureNamesBool[i].gen.name; i++)
3562 guc_vars[num_vars++] = &ConfigureNamesBool[i].gen;
3564 for (i = 0; ConfigureNamesInt[i].gen.name; i++)
3565 guc_vars[num_vars++] = &ConfigureNamesInt[i].gen;
3567 for (i = 0; ConfigureNamesReal[i].gen.name; i++)
3568 guc_vars[num_vars++] = &ConfigureNamesReal[i].gen;
3570 for (i = 0; ConfigureNamesString[i].gen.name; i++)
3571 guc_vars[num_vars++] = &ConfigureNamesString[i].gen;
3573 for (i = 0; ConfigureNamesEnum[i].gen.name; i++)
3574 guc_vars[num_vars++] = &ConfigureNamesEnum[i].gen;
3577 free(guc_variables);
3578 guc_variables = guc_vars;
3579 num_guc_variables = num_vars;
3580 size_guc_variables = size_vars;
3581 qsort((void *) guc_variables, num_guc_variables,
3582 sizeof(struct config_generic *), guc_var_compare);
3586 * Add a new GUC variable to the list of known variables. The
3587 * list is expanded if needed.
3590 add_guc_variable(struct config_generic * var, int elevel)
3592 if (num_guc_variables + 1 >= size_guc_variables)
3595 * Increase the vector by 25%
3597 int size_vars = size_guc_variables + size_guc_variables / 4;
3598 struct config_generic **guc_vars;
3603 guc_vars = (struct config_generic **)
3604 guc_malloc(elevel, size_vars * sizeof(struct config_generic *));
3608 guc_vars = (struct config_generic **)
3609 guc_realloc(elevel, guc_variables, size_vars * sizeof(struct config_generic *));
3612 if (guc_vars == NULL)
3613 return false; /* out of memory */
3615 guc_variables = guc_vars;
3616 size_guc_variables = size_vars;
3618 guc_variables[num_guc_variables++] = var;
3619 qsort((void *) guc_variables, num_guc_variables,
3620 sizeof(struct config_generic *), guc_var_compare);
3625 * Create and add a placeholder variable. It's presumed to belong
3626 * to a valid custom variable class at this point.
3628 static struct config_generic *
3629 add_placeholder_variable(const char *name, int elevel)
3631 size_t sz = sizeof(struct config_string) + sizeof(char *);
3632 struct config_string *var;
3633 struct config_generic *gen;
3635 var = (struct config_string *) guc_malloc(elevel, sz);
3641 gen->name = guc_strdup(elevel, name);
3642 if (gen->name == NULL)
3648 gen->context = PGC_USERSET;
3649 gen->group = CUSTOM_OPTIONS;
3650 gen->short_desc = "GUC placeholder variable";
3651 gen->flags = GUC_NO_SHOW_ALL | GUC_NOT_IN_SAMPLE | GUC_CUSTOM_PLACEHOLDER;
3652 gen->vartype = PGC_STRING;
3655 * The char* is allocated at the end of the struct since we have no
3656 * 'static' place to point to. Note that the current value, as well as
3657 * the boot and reset values, start out NULL.
3659 var->variable = (char **) (var + 1);
3661 if (!add_guc_variable((struct config_generic *) var, elevel))
3663 free((void *) gen->name);
3672 * Detect whether the portion of "name" before dotPos matches any custom
3673 * variable class name listed in custom_var_classes. The latter must be
3674 * formatted the way that assign_custom_variable_classes does it, ie,
3675 * no whitespace. NULL is valid for custom_var_classes.
3678 is_custom_class(const char *name, int dotPos, const char *custom_var_classes)
3680 bool result = false;
3681 const char *ccs = custom_var_classes;
3685 const char *start = ccs;
3691 if (c == '\0' || c == ',')
3693 if (dotPos == ccs - start && strncmp(start, name, dotPos) == 0)
3708 * Look up option NAME. If it exists, return a pointer to its record,
3709 * else return NULL. If create_placeholders is TRUE, we'll create a
3710 * placeholder record for a valid-looking custom variable name.
3712 static struct config_generic *
3713 find_option(const char *name, bool create_placeholders, int elevel)
3715 const char **key = &name;
3716 struct config_generic **res;
3722 * By equating const char ** with struct config_generic *, we are assuming
3723 * the name field is first in config_generic.
3725 res = (struct config_generic **) bsearch((void *) &key,
3726 (void *) guc_variables,
3728 sizeof(struct config_generic *),
3734 * See if the name is an obsolete name for a variable. We assume that the
3735 * set of supported old names is short enough that a brute-force search is
3738 for (i = 0; map_old_guc_names[i] != NULL; i += 2)
3740 if (guc_name_compare(name, map_old_guc_names[i]) == 0)
3741 return find_option(map_old_guc_names[i + 1], false, elevel);
3744 if (create_placeholders)
3747 * Check if the name is qualified, and if so, check if the qualifier
3748 * matches any custom variable class. If so, add a placeholder.
3750 const char *dot = strchr(name, GUC_QUALIFIER_SEPARATOR);
3753 is_custom_class(name, dot - name, custom_variable_classes))
3754 return add_placeholder_variable(name, elevel);
3763 * comparator for qsorting and bsearching guc_variables array
3766 guc_var_compare(const void *a, const void *b)
3768 struct config_generic *confa = *(struct config_generic **) a;
3769 struct config_generic *confb = *(struct config_generic **) b;
3771 return guc_name_compare(confa->name, confb->name);
3775 * the bare comparison function for GUC names
3778 guc_name_compare(const char *namea, const char *nameb)
3781 * The temptation to use strcasecmp() here must be resisted, because the
3782 * array ordering has to remain stable across setlocale() calls. So, build
3783 * our own with a simple ASCII-only downcasing.
3785 while (*namea && *nameb)
3787 char cha = *namea++;
3788 char chb = *nameb++;
3790 if (cha >= 'A' && cha <= 'Z')
3792 if (chb >= 'A' && chb <= 'Z')
3798 return 1; /* a is longer */
3800 return -1; /* b is longer */
3806 * Initialize GUC options during program startup.
3808 * Note that we cannot read the config file yet, since we have not yet
3809 * processed command-line switches.
3812 InitializeGUCOptions(void)
3817 * Before log_line_prefix could possibly receive a nonempty setting, make
3818 * sure that timezone processing is minimally alive (see elog.c).
3820 pg_timezone_pre_initialize();
3823 * Build sorted array of all GUC variables.
3825 build_guc_variables();
3828 * Load all variables with their compiled-in defaults, and initialize
3829 * status fields as needed.
3831 for (i = 0; i < num_guc_variables; i++)
3833 InitializeOneGUCOption(guc_variables[i]);
3838 reporting_enabled = false;
3841 * Prevent any attempt to override the transaction modes from
3842 * non-interactive sources.
3844 SetConfigOption("transaction_isolation", "default",
3845 PGC_POSTMASTER, PGC_S_OVERRIDE);
3846 SetConfigOption("transaction_read_only", "no",
3847 PGC_POSTMASTER, PGC_S_OVERRIDE);
3848 SetConfigOption("transaction_deferrable", "no",
3849 PGC_POSTMASTER, PGC_S_OVERRIDE);
3852 * For historical reasons, some GUC parameters can receive defaults from
3853 * environment variables. Process those settings.
3855 InitializeGUCOptionsFromEnvironment();
3859 * Assign any GUC values that can come from the server's environment.
3861 * This is called from InitializeGUCOptions, and also from ProcessConfigFile
3862 * to deal with the possibility that a setting has been removed from
3863 * postgresql.conf and should now get a value from the environment.
3864 * (The latter is a kludge that should probably go away someday; if so,
3865 * fold this back into InitializeGUCOptions.)
3868 InitializeGUCOptionsFromEnvironment(void)
3873 env = getenv("PGPORT");
3875 SetConfigOption("port", env, PGC_POSTMASTER, PGC_S_ENV_VAR);
3877 env = getenv("PGDATESTYLE");
3879 SetConfigOption("datestyle", env, PGC_POSTMASTER, PGC_S_ENV_VAR);
3881 env = getenv("PGCLIENTENCODING");
3883 SetConfigOption("client_encoding", env, PGC_POSTMASTER, PGC_S_ENV_VAR);
3886 * rlimit isn't exactly an "environment variable", but it behaves about
3887 * the same. If we can identify the platform stack depth rlimit, increase
3888 * default stack depth setting up to whatever is safe (but at most 2MB).
3890 stack_rlimit = get_stack_depth_rlimit();
3891 if (stack_rlimit > 0)
3893 long new_limit = (stack_rlimit - STACK_DEPTH_SLOP) / 1024L;
3895 if (new_limit > 100)
3899 new_limit = Min(new_limit, 2048);
3900 sprintf(limbuf, "%ld", new_limit);
3901 SetConfigOption("max_stack_depth", limbuf,
3902 PGC_POSTMASTER, PGC_S_ENV_VAR);
3908 * Initialize one GUC option variable to its compiled-in default.
3910 * Note: the reason for calling check_hooks is not that we think the boot_val
3911 * might fail, but that the hooks might wish to compute an "extra" struct.
3914 InitializeOneGUCOption(struct config_generic * gconf)
3917 gconf->reset_source = PGC_S_DEFAULT;
3918 gconf->source = PGC_S_DEFAULT;
3919 gconf->stack = NULL;
3920 gconf->extra = NULL;
3921 gconf->sourcefile = NULL;
3922 gconf->sourceline = 0;
3924 switch (gconf->vartype)
3928 struct config_bool *conf = (struct config_bool *) gconf;
3929 bool newval = conf->boot_val;
3932 if (!call_bool_check_hook(conf, &newval, &extra,
3933 PGC_S_DEFAULT, LOG))
3934 elog(FATAL, "failed to initialize %s to %d",
3935 conf->gen.name, (int) newval);
3936 if (conf->assign_hook)
3937 (*conf->assign_hook) (newval, extra);
3938 *conf->variable = conf->reset_val = newval;
3939 conf->gen.extra = conf->reset_extra = extra;
3944 struct config_int *conf = (struct config_int *) gconf;
3945 int newval = conf->boot_val;
3948 Assert(newval >= conf->min);
3949 Assert(newval <= conf->max);
3950 if (!call_int_check_hook(conf, &newval, &extra,
3951 PGC_S_DEFAULT, LOG))
3952 elog(FATAL, "failed to initialize %s to %d",
3953 conf->gen.name, newval);
3954 if (conf->assign_hook)
3955 (*conf->assign_hook) (newval, extra);
3956 *conf->variable = conf->reset_val = newval;
3957 conf->gen.extra = conf->reset_extra = extra;
3962 struct config_real *conf = (struct config_real *) gconf;
3963 double newval = conf->boot_val;
3966 Assert(newval >= conf->min);
3967 Assert(newval <= conf->max);
3968 if (!call_real_check_hook(conf, &newval, &extra,
3969 PGC_S_DEFAULT, LOG))
3970 elog(FATAL, "failed to initialize %s to %g",
3971 conf->gen.name, newval);
3972 if (conf->assign_hook)
3973 (*conf->assign_hook) (newval, extra);
3974 *conf->variable = conf->reset_val = newval;
3975 conf->gen.extra = conf->reset_extra = extra;
3980 struct config_string *conf = (struct config_string *) gconf;
3984 /* non-NULL boot_val must always get strdup'd */
3985 if (conf->boot_val != NULL)
3986 newval = guc_strdup(FATAL, conf->boot_val);
3990 if (!call_string_check_hook(conf, &newval, &extra,
3991 PGC_S_DEFAULT, LOG))
3992 elog(FATAL, "failed to initialize %s to \"%s\"",
3993 conf->gen.name, newval ? newval : "");
3994 if (conf->assign_hook)
3995 (*conf->assign_hook) (newval, extra);
3996 *conf->variable = conf->reset_val = newval;
3997 conf->gen.extra = conf->reset_extra = extra;
4002 struct config_enum *conf = (struct config_enum *) gconf;
4003 int newval = conf->boot_val;
4006 if (!call_enum_check_hook(conf, &newval, &extra,
4007 PGC_S_DEFAULT, LOG))
4008 elog(FATAL, "failed to initialize %s to %d",
4009 conf->gen.name, newval);
4010 if (conf->assign_hook)
4011 (*conf->assign_hook) (newval, extra);
4012 *conf->variable = conf->reset_val = newval;
4013 conf->gen.extra = conf->reset_extra = extra;
4021 * Select the configuration files and data directory to be used, and
4022 * do the initial read of postgresql.conf.
4024 * This is called after processing command-line switches.
4025 * userDoption is the -D switch value if any (NULL if unspecified).
4026 * progname is just for use in error messages.
4028 * Returns true on success; on failure, prints a suitable error message
4029 * to stderr and returns false.
4032 SelectConfigFiles(const char *userDoption, const char *progname)
4036 struct stat stat_buf;
4038 /* configdir is -D option, or $PGDATA if no -D */
4040 configdir = make_absolute_path(userDoption);
4042 configdir = make_absolute_path(getenv("PGDATA"));
4045 * Find the configuration file: if config_file was specified on the
4046 * command line, use it, else use configdir/postgresql.conf. In any case
4047 * ensure the result is an absolute path, so that it will be interpreted
4048 * the same way by future backends.
4051 fname = make_absolute_path(ConfigFileName);
4054 fname = guc_malloc(FATAL,
4055 strlen(configdir) + strlen(CONFIG_FILENAME) + 2);
4056 sprintf(fname, "%s/%s", configdir, CONFIG_FILENAME);
4060 write_stderr("%s does not know where to find the server configuration file.\n"
4061 "You must specify the --config-file or -D invocation "
4062 "option or set the PGDATA environment variable.\n",
4068 * Set the ConfigFileName GUC variable to its final value, ensuring that
4069 * it can't be overridden later.
4071 SetConfigOption("config_file", fname, PGC_POSTMASTER, PGC_S_OVERRIDE);
4075 * Now read the config file for the first time.
4077 if (stat(ConfigFileName, &stat_buf) != 0)
4079 write_stderr("%s cannot access the server configuration file \"%s\": %s\n",
4080 progname, ConfigFileName, strerror(errno));
4084 ProcessConfigFile(PGC_POSTMASTER);
4087 * If the data_directory GUC variable has been set, use that as DataDir;
4088 * otherwise use configdir if set; else punt.
4090 * Note: SetDataDir will copy and absolute-ize its argument, so we don't
4094 SetDataDir(data_directory);
4096 SetDataDir(configdir);
4099 write_stderr("%s does not know where to find the database system data.\n"
4100 "This can be specified as \"data_directory\" in \"%s\", "
4101 "or by the -D invocation option, or by the "
4102 "PGDATA environment variable.\n",
4103 progname, ConfigFileName);
4108 * Reflect the final DataDir value back into the data_directory GUC var.
4109 * (If you are wondering why we don't just make them a single variable,
4110 * it's because the EXEC_BACKEND case needs DataDir to be transmitted to
4111 * child backends specially. XXX is that still true? Given that we now
4112 * chdir to DataDir, EXEC_BACKEND can read the config file without knowing
4113 * DataDir in advance.)
4115 SetConfigOption("data_directory", DataDir, PGC_POSTMASTER, PGC_S_OVERRIDE);
4118 * Figure out where pg_hba.conf is, and make sure the path is absolute.
4121 fname = make_absolute_path(HbaFileName);
4124 fname = guc_malloc(FATAL,
4125 strlen(configdir) + strlen(HBA_FILENAME) + 2);
4126 sprintf(fname, "%s/%s", configdir, HBA_FILENAME);
4130 write_stderr("%s does not know where to find the \"hba\" configuration file.\n"
4131 "This can be specified as \"hba_file\" in \"%s\", "
4132 "or by the -D invocation option, or by the "
4133 "PGDATA environment variable.\n",
4134 progname, ConfigFileName);
4137 SetConfigOption("hba_file", fname, PGC_POSTMASTER, PGC_S_OVERRIDE);
4141 * Likewise for pg_ident.conf.
4144 fname = make_absolute_path(IdentFileName);
4147 fname = guc_malloc(FATAL,
4148 strlen(configdir) + strlen(IDENT_FILENAME) + 2);
4149 sprintf(fname, "%s/%s", configdir, IDENT_FILENAME);
4153 write_stderr("%s does not know where to find the \"ident\" configuration file.\n"
4154 "This can be specified as \"ident_file\" in \"%s\", "
4155 "or by the -D invocation option, or by the "
4156 "PGDATA environment variable.\n",
4157 progname, ConfigFileName);
4160 SetConfigOption("ident_file", fname, PGC_POSTMASTER, PGC_S_OVERRIDE);
4170 * Reset all options to their saved default values (implements RESET ALL)
4173 ResetAllOptions(void)
4177 for (i = 0; i < num_guc_variables; i++)
4179 struct config_generic *gconf = guc_variables[i];
4181 /* Don't reset non-SET-able values */
4182 if (gconf->context != PGC_SUSET &&
4183 gconf->context != PGC_USERSET)
4185 /* Don't reset if special exclusion from RESET ALL */
4186 if (gconf->flags & GUC_NO_RESET_ALL)
4188 /* No need to reset if wasn't SET */
4189 if (gconf->source <= PGC_S_OVERRIDE)
4192 /* Save old value to support transaction abort */
4193 push_old_value(gconf, GUC_ACTION_SET);
4195 switch (gconf->vartype)
4199 struct config_bool *conf = (struct config_bool *) gconf;
4201 if (conf->assign_hook)
4202 (*conf->assign_hook) (conf->reset_val,
4204 *conf->variable = conf->reset_val;
4205 set_extra_field(&conf->gen, &conf->gen.extra,
4211 struct config_int *conf = (struct config_int *) gconf;
4213 if (conf->assign_hook)
4214 (*conf->assign_hook) (conf->reset_val,
4216 *conf->variable = conf->reset_val;
4217 set_extra_field(&conf->gen, &conf->gen.extra,
4223 struct config_real *conf = (struct config_real *) gconf;
4225 if (conf->assign_hook)
4226 (*conf->assign_hook) (conf->reset_val,
4228 *conf->variable = conf->reset_val;
4229 set_extra_field(&conf->gen, &conf->gen.extra,
4235 struct config_string *conf = (struct config_string *) gconf;
4237 if (conf->assign_hook)
4238 (*conf->assign_hook) (conf->reset_val,
4240 set_string_field(conf, conf->variable, conf->reset_val);
4241 set_extra_field(&conf->gen, &conf->gen.extra,
4247 struct config_enum *conf = (struct config_enum *) gconf;
4249 if (conf->assign_hook)
4250 (*conf->assign_hook) (conf->reset_val,
4252 *conf->variable = conf->reset_val;
4253 set_extra_field(&conf->gen, &conf->gen.extra,
4259 gconf->source = gconf->reset_source;
4261 if (gconf->flags & GUC_REPORT)
4262 ReportGUCOption(gconf);
4269 * Push previous state during transactional assignment to a GUC variable.
4272 push_old_value(struct config_generic * gconf, GucAction action)
4276 /* If we're not inside a nest level, do nothing */
4277 if (GUCNestLevel == 0)
4280 /* Do we already have a stack entry of the current nest level? */
4281 stack = gconf->stack;
4282 if (stack && stack->nest_level >= GUCNestLevel)
4284 /* Yes, so adjust its state if necessary */
4285 Assert(stack->nest_level == GUCNestLevel);
4288 case GUC_ACTION_SET:
4289 /* SET overrides any prior action at same nest level */
4290 if (stack->state == GUC_SET_LOCAL)
4292 /* must discard old masked value */
4293 discard_stack_value(gconf, &stack->masked);
4295 stack->state = GUC_SET;
4297 case GUC_ACTION_LOCAL:
4298 if (stack->state == GUC_SET)
4300 /* SET followed by SET LOCAL, remember SET's value */
4301 set_stack_value(gconf, &stack->masked);
4302 stack->state = GUC_SET_LOCAL;
4304 /* in all other cases, no change to stack entry */
4306 case GUC_ACTION_SAVE:
4307 /* Could only have a prior SAVE of same variable */
4308 Assert(stack->state == GUC_SAVE);
4311 Assert(guc_dirty); /* must be set already */
4316 * Push a new stack entry
4318 * We keep all the stack entries in TopTransactionContext for simplicity.
4320 stack = (GucStack *) MemoryContextAllocZero(TopTransactionContext,
4323 stack->prev = gconf->stack;
4324 stack->nest_level = GUCNestLevel;
4327 case GUC_ACTION_SET:
4328 stack->state = GUC_SET;
4330 case GUC_ACTION_LOCAL:
4331 stack->state = GUC_LOCAL;
4333 case GUC_ACTION_SAVE:
4334 stack->state = GUC_SAVE;
4337 stack->source = gconf->source;
4338 set_stack_value(gconf, &stack->prior);
4340 gconf->stack = stack;
4342 /* Ensure we remember to pop at end of xact */
4348 * Do GUC processing at main transaction start.
4354 * The nest level should be 0 between transactions; if it isn't, somebody
4355 * didn't call AtEOXact_GUC, or called it with the wrong nestLevel. We
4356 * throw a warning but make no other effort to clean up.
4358 if (GUCNestLevel != 0)
4359 elog(WARNING, "GUC nest level = %d at transaction start",
4365 * Enter a new nesting level for GUC values. This is called at subtransaction
4366 * start and when entering a function that has proconfig settings. NOTE that
4367 * we must not risk error here, else subtransaction start will be unhappy.
4370 NewGUCNestLevel(void)
4372 return ++GUCNestLevel;
4376 * Do GUC processing at transaction or subtransaction commit or abort, or
4377 * when exiting a function that has proconfig settings. (The name is thus
4378 * a bit of a misnomer; perhaps it should be ExitGUCNestLevel or some such.)
4379 * During abort, we discard all GUC settings that were applied at nesting
4380 * levels >= nestLevel. nestLevel == 1 corresponds to the main transaction.
4383 AtEOXact_GUC(bool isCommit, int nestLevel)
4389 * Note: it's possible to get here with GUCNestLevel == nestLevel-1 during
4390 * abort, if there is a failure during transaction start before
4391 * AtStart_GUC is called.
4393 Assert(nestLevel > 0 &&
4394 (nestLevel <= GUCNestLevel ||
4395 (nestLevel == GUCNestLevel + 1 && !isCommit)));
4397 /* Quick exit if nothing's changed in this transaction */
4400 GUCNestLevel = nestLevel - 1;
4404 still_dirty = false;
4405 for (i = 0; i < num_guc_variables; i++)
4407 struct config_generic *gconf = guc_variables[i];
4411 * Process and pop each stack entry within the nest level. To
4412 * simplify fmgr_security_definer(), we allow failure exit from a
4413 * function-with-SET-options to be recovered at the surrounding
4414 * transaction or subtransaction abort; so there could be more than
4415 * one stack entry to pop.
4417 while ((stack = gconf->stack) != NULL &&
4418 stack->nest_level >= nestLevel)
4420 GucStack *prev = stack->prev;
4421 bool restorePrior = false;
4422 bool restoreMasked = false;
4426 * In this next bit, if we don't set either restorePrior or
4427 * restoreMasked, we must "discard" any unwanted fields of the
4428 * stack entries to avoid leaking memory. If we do set one of
4429 * those flags, unused fields will be cleaned up after restoring.
4431 if (!isCommit) /* if abort, always restore prior value */
4432 restorePrior = true;
4433 else if (stack->state == GUC_SAVE)
4434 restorePrior = true;
4435 else if (stack->nest_level == 1)
4437 /* transaction commit */
4438 if (stack->state == GUC_SET_LOCAL)
4439 restoreMasked = true;
4440 else if (stack->state == GUC_SET)
4442 /* we keep the current active value */
4443 discard_stack_value(gconf, &stack->prior);
4445 else /* must be GUC_LOCAL */
4446 restorePrior = true;
4448 else if (prev == NULL ||
4449 prev->nest_level < stack->nest_level - 1)
4451 /* decrement entry's level and do not pop it */
4452 stack->nest_level--;
4458 * We have to merge this stack entry into prev. See README for
4459 * discussion of this bit.
4461 switch (stack->state)
4464 Assert(false); /* can't get here */
4467 /* next level always becomes SET */
4468 discard_stack_value(gconf, &stack->prior);
4469 if (prev->state == GUC_SET_LOCAL)
4470 discard_stack_value(gconf, &prev->masked);
4471 prev->state = GUC_SET;
4475 if (prev->state == GUC_SET)
4477 /* LOCAL migrates down */
4478 prev->masked = stack->prior;
4479 prev->state = GUC_SET_LOCAL;
4483 /* else just forget this stack level */
4484 discard_stack_value(gconf, &stack->prior);
4489 /* prior state at this level no longer wanted */
4490 discard_stack_value(gconf, &stack->prior);
4491 /* copy down the masked state */
4492 if (prev->state == GUC_SET_LOCAL)
4493 discard_stack_value(gconf, &prev->masked);
4494 prev->masked = stack->masked;
4495 prev->state = GUC_SET_LOCAL;
4502 if (restorePrior || restoreMasked)
4504 /* Perform appropriate restoration of the stacked value */
4505 config_var_value newvalue;
4506 GucSource newsource;
4510 newvalue = stack->masked;
4511 newsource = PGC_S_SESSION;
4515 newvalue = stack->prior;
4516 newsource = stack->source;
4519 switch (gconf->vartype)
4523 struct config_bool *conf = (struct config_bool *) gconf;
4524 bool newval = newvalue.val.boolval;
4525 void *newextra = newvalue.extra;
4527 if (*conf->variable != newval ||
4528 conf->gen.extra != newextra)
4530 if (conf->assign_hook)
4531 (*conf->assign_hook) (newval, newextra);
4532 *conf->variable = newval;
4533 set_extra_field(&conf->gen, &conf->gen.extra,
4541 struct config_int *conf = (struct config_int *) gconf;
4542 int newval = newvalue.val.intval;
4543 void *newextra = newvalue.extra;
4545 if (*conf->variable != newval ||
4546 conf->gen.extra != newextra)
4548 if (conf->assign_hook)
4549 (*conf->assign_hook) (newval, newextra);
4550 *conf->variable = newval;
4551 set_extra_field(&conf->gen, &conf->gen.extra,
4559 struct config_real *conf = (struct config_real *) gconf;
4560 double newval = newvalue.val.realval;
4561 void *newextra = newvalue.extra;
4563 if (*conf->variable != newval ||
4564 conf->gen.extra != newextra)
4566 if (conf->assign_hook)
4567 (*conf->assign_hook) (newval, newextra);
4568 *conf->variable = newval;
4569 set_extra_field(&conf->gen, &conf->gen.extra,
4577 struct config_string *conf = (struct config_string *) gconf;
4578 char *newval = newvalue.val.stringval;
4579 void *newextra = newvalue.extra;
4581 if (*conf->variable != newval ||
4582 conf->gen.extra != newextra)
4584 if (conf->assign_hook)
4585 (*conf->assign_hook) (newval, newextra);
4586 set_string_field(conf, conf->variable, newval);
4587 set_extra_field(&conf->gen, &conf->gen.extra,
4593 * Release stacked values if not used anymore. We
4594 * could use discard_stack_value() here, but since
4595 * we have type-specific code anyway, might as
4598 set_string_field(conf, &stack->prior.val.stringval, NULL);
4599 set_string_field(conf, &stack->masked.val.stringval, NULL);
4604 struct config_enum *conf = (struct config_enum *) gconf;
4605 int newval = newvalue.val.enumval;
4606 void *newextra = newvalue.extra;
4608 if (*conf->variable != newval ||
4609 conf->gen.extra != newextra)
4611 if (conf->assign_hook)
4612 (*conf->assign_hook) (newval, newextra);
4613 *conf->variable = newval;
4614 set_extra_field(&conf->gen, &conf->gen.extra,
4623 * Release stacked extra values if not used anymore.
4625 set_extra_field(gconf, &(stack->prior.extra), NULL);
4626 set_extra_field(gconf, &(stack->masked.extra), NULL);
4628 gconf->source = newsource;
4631 /* Finish popping the state stack */
4632 gconf->stack = prev;
4635 /* Report new value if we changed it */
4636 if (changed && (gconf->flags & GUC_REPORT))
4637 ReportGUCOption(gconf);
4638 } /* end of stack-popping loop */
4644 /* If there are no remaining stack entries, we can reset guc_dirty */
4645 guc_dirty = still_dirty;
4647 /* Update nesting level */
4648 GUCNestLevel = nestLevel - 1;
4653 * Start up automatic reporting of changes to variables marked GUC_REPORT.
4654 * This is executed at completion of backend startup.
4657 BeginReportingGUCOptions(void)
4662 * Don't do anything unless talking to an interactive frontend of protocol
4665 if (whereToSendOutput != DestRemote ||
4666 PG_PROTOCOL_MAJOR(FrontendProtocol) < 3)
4669 reporting_enabled = true;
4671 /* Transmit initial values of interesting variables */
4672 for (i = 0; i < num_guc_variables; i++)
4674 struct config_generic *conf = guc_variables[i];
4676 if (conf->flags & GUC_REPORT)
4677 ReportGUCOption(conf);
4682 * ReportGUCOption: if appropriate, transmit option value to frontend
4685 ReportGUCOption(struct config_generic * record)
4687 if (reporting_enabled && (record->flags & GUC_REPORT))
4689 char *val = _ShowOption(record, false);
4690 StringInfoData msgbuf;
4692 pq_beginmessage(&msgbuf, 'S');
4693 pq_sendstring(&msgbuf, record->name);
4694 pq_sendstring(&msgbuf, val);
4695 pq_endmessage(&msgbuf);
4702 * Try to parse value as an integer. The accepted formats are the
4703 * usual decimal, octal, or hexadecimal formats, optionally followed by
4704 * a unit name if "flags" indicates a unit is allowed.
4706 * If the string parses okay, return true, else false.
4707 * If okay and result is not NULL, return the value in *result.
4708 * If not okay and hintmsg is not NULL, *hintmsg is set to a suitable
4709 * HINT message, or NULL if no hint provided.
4712 parse_int(const char *value, int *result, int flags, const char **hintmsg)
4717 /* To suppress compiler warnings, always set output params */
4723 /* We assume here that int64 is at least as wide as long */
4725 val = strtol(value, &endptr, 0);
4727 if (endptr == value)
4728 return false; /* no HINT for integer syntax error */
4730 if (errno == ERANGE || val != (int64) ((int32) val))
4733 *hintmsg = gettext_noop("Value exceeds integer range.");
4737 /* allow whitespace between integer and unit */
4738 while (isspace((unsigned char) *endptr))
4741 /* Handle possible unit */
4742 if (*endptr != '\0')
4745 * Note: the multiple-switch coding technique here is a bit tedious,
4746 * but seems necessary to avoid intermediate-value overflows.
4748 if (flags & GUC_UNIT_MEMORY)
4750 /* Set hint for use if no match or trailing garbage */
4752 *hintmsg = gettext_noop("Valid units for this parameter are \"kB\", \"MB\", and \"GB\".");
4754 #if BLCKSZ < 1024 || BLCKSZ > (1024*1024)
4755 #error BLCKSZ must be between 1KB and 1MB
4757 #if XLOG_BLCKSZ < 1024 || XLOG_BLCKSZ > (1024*1024)
4758 #error XLOG_BLCKSZ must be between 1KB and 1MB
4761 if (strncmp(endptr, "kB", 2) == 0)
4764 switch (flags & GUC_UNIT_MEMORY)
4766 case GUC_UNIT_BLOCKS:
4767 val /= (BLCKSZ / 1024);
4769 case GUC_UNIT_XBLOCKS:
4770 val /= (XLOG_BLCKSZ / 1024);
4774 else if (strncmp(endptr, "MB", 2) == 0)
4777 switch (flags & GUC_UNIT_MEMORY)
4782 case GUC_UNIT_BLOCKS:
4783 val *= KB_PER_MB / (BLCKSZ / 1024);
4785 case GUC_UNIT_XBLOCKS:
4786 val *= KB_PER_MB / (XLOG_BLCKSZ / 1024);
4790 else if (strncmp(endptr, "GB", 2) == 0)
4793 switch (flags & GUC_UNIT_MEMORY)
4798 case GUC_UNIT_BLOCKS:
4799 val *= KB_PER_GB / (BLCKSZ / 1024);
4801 case GUC_UNIT_XBLOCKS:
4802 val *= KB_PER_GB / (XLOG_BLCKSZ / 1024);
4807 else if (flags & GUC_UNIT_TIME)
4809 /* Set hint for use if no match or trailing garbage */
4811 *hintmsg = gettext_noop("Valid units for this parameter are \"ms\", \"s\", \"min\", \"h\", and \"d\".");
4813 if (strncmp(endptr, "ms", 2) == 0)
4816 switch (flags & GUC_UNIT_TIME)
4826 else if (strncmp(endptr, "s", 1) == 0)
4829 switch (flags & GUC_UNIT_TIME)
4839 else if (strncmp(endptr, "min", 3) == 0)
4842 switch (flags & GUC_UNIT_TIME)
4852 else if (strncmp(endptr, "h", 1) == 0)
4855 switch (flags & GUC_UNIT_TIME)
4868 else if (strncmp(endptr, "d", 1) == 0)
4871 switch (flags & GUC_UNIT_TIME)
4886 /* allow whitespace after unit */
4887 while (isspace((unsigned char) *endptr))
4890 if (*endptr != '\0')
4891 return false; /* appropriate hint, if any, already set */
4893 /* Check for overflow due to units conversion */
4894 if (val != (int64) ((int32) val))
4897 *hintmsg = gettext_noop("Value exceeds integer range.");
4903 *result = (int) val;
4910 * Try to parse value as a floating point number in the usual format.
4911 * If the string parses okay, return true, else false.
4912 * If okay and result is not NULL, return the value in *result.
4915 parse_real(const char *value, double *result)
4921 *result = 0; /* suppress compiler warning */
4924 val = strtod(value, &endptr);
4925 if (endptr == value || errno == ERANGE)
4928 /* allow whitespace after number */
4929 while (isspace((unsigned char) *endptr))
4931 if (*endptr != '\0')
4941 * Lookup the name for an enum option with the selected value.
4942 * Should only ever be called with known-valid values, so throws
4943 * an elog(ERROR) if the enum option is not found.
4945 * The returned string is a pointer to static data and not
4946 * allocated for modification.
4949 config_enum_lookup_by_value(struct config_enum * record, int val)
4951 const struct config_enum_entry *entry;
4953 for (entry = record->options; entry && entry->name; entry++)
4955 if (entry->val == val)
4959 elog(ERROR, "could not find enum option %d for %s",
4960 val, record->gen.name);
4961 return NULL; /* silence compiler */
4966 * Lookup the value for an enum option with the selected name
4967 * (case-insensitive).
4968 * If the enum option is found, sets the retval value and returns
4969 * true. If it's not found, return FALSE and retval is set to 0.
4972 config_enum_lookup_by_name(struct config_enum * record, const char *value,
4975 const struct config_enum_entry *entry;
4977 for (entry = record->options; entry && entry->name; entry++)
4979 if (pg_strcasecmp(value, entry->name) == 0)
4981 *retval = entry->val;
4992 * Return a list of all available options for an enum, excluding
4993 * hidden ones, separated by the given separator.
4994 * If prefix is non-NULL, it is added before the first enum value.
4995 * If suffix is non-NULL, it is added to the end of the string.
4998 config_enum_get_options(struct config_enum * record, const char *prefix,
4999 const char *suffix, const char *separator)
5001 const struct config_enum_entry *entry;
5002 StringInfoData retstr;
5005 initStringInfo(&retstr);
5006 appendStringInfoString(&retstr, prefix);
5008 seplen = strlen(separator);
5009 for (entry = record->options; entry && entry->name; entry++)
5013 appendStringInfoString(&retstr, entry->name);
5014 appendBinaryStringInfo(&retstr, separator, seplen);
5019 * All the entries may have been hidden, leaving the string empty if no
5020 * prefix was given. This indicates a broken GUC setup, since there is no
5021 * use for an enum without any values, so we just check to make sure we
5022 * don't write to invalid memory instead of actually trying to do
5023 * something smart with it.
5025 if (retstr.len >= seplen)
5027 /* Replace final separator */
5028 retstr.data[retstr.len - seplen] = '\0';
5029 retstr.len -= seplen;
5032 appendStringInfoString(&retstr, suffix);
5039 * Sets option `name' to given value. The value should be a string
5040 * which is going to be parsed and converted to the appropriate data
5041 * type. The context and source parameters indicate in which context this
5042 * function is being called so it can apply the access restrictions
5045 * If value is NULL, set the option to its default value (normally the
5046 * reset_val, but if source == PGC_S_DEFAULT we instead use the boot_val).
5048 * action indicates whether to set the value globally in the session, locally
5049 * to the current top transaction, or just for the duration of a function call.
5051 * If changeVal is false then don't really set the option but do all
5052 * the checks to see if it would work.
5054 * If there is an error (non-existing option, invalid value) then an
5055 * ereport(ERROR) is thrown *unless* this is called in a context where we
5056 * don't want to ereport (currently, startup or SIGHUP config file reread).
5057 * In that case we write a suitable error message via ereport(LOG) and
5058 * return false. This is working around the deficiencies in the ereport
5059 * mechanism, so don't blame me. In all other cases, the function
5060 * returns true, including cases where the input is valid but we chose
5061 * not to apply it because of context or source-priority considerations.
5063 * See also SetConfigOption for an external interface.
5066 set_config_option(const char *name, const char *value,
5067 GucContext context, GucSource source,
5068 GucAction action, bool changeVal)
5070 struct config_generic *record;
5072 bool prohibitValueChange = false;
5075 if (context == PGC_SIGHUP || source == PGC_S_DEFAULT)
5078 * To avoid cluttering the log, only the postmaster bleats loudly
5079 * about problems with the config file.
5081 elevel = IsUnderPostmaster ? DEBUG3 : LOG;
5083 else if (source == PGC_S_DATABASE || source == PGC_S_USER ||
5084 source == PGC_S_DATABASE_USER)
5089 record = find_option(name, true, elevel);
5093 (errcode(ERRCODE_UNDEFINED_OBJECT),
5094 errmsg("unrecognized configuration parameter \"%s\"", name)));
5099 * If source is postgresql.conf, mark the found record with
5100 * GUC_IS_IN_FILE. This is for the convenience of ProcessConfigFile. Note
5101 * that we do it even if changeVal is false, since ProcessConfigFile wants
5102 * the marking to occur during its testing pass.
5104 if (source == PGC_S_FILE)
5105 record->status |= GUC_IS_IN_FILE;
5108 * Check if the option can be set at this time. See guc.h for the precise
5111 switch (record->context)
5114 if (context == PGC_SIGHUP)
5117 * Historically we've just silently ignored attempts to set
5118 * PGC_INTERNAL variables from the config file. Maybe it'd be
5119 * better to use the prohibitValueChange logic for this?
5123 else if (context != PGC_INTERNAL)
5126 (errcode(ERRCODE_CANT_CHANGE_RUNTIME_PARAM),
5127 errmsg("parameter \"%s\" cannot be changed",
5132 case PGC_POSTMASTER:
5133 if (context == PGC_SIGHUP)
5136 * We are re-reading a PGC_POSTMASTER variable from
5137 * postgresql.conf. We can't change the setting, so we should
5138 * give a warning if the DBA tries to change it. However,
5139 * because of variant formats, canonicalization by check
5140 * hooks, etc, we can't just compare the given string directly
5141 * to what's stored. Set a flag to check below after we have
5142 * the final storable value.
5144 * During the "checking" pass we just do nothing, to avoid
5145 * printing the warning twice.
5150 prohibitValueChange = true;
5152 else if (context != PGC_POSTMASTER)
5155 (errcode(ERRCODE_CANT_CHANGE_RUNTIME_PARAM),
5156 errmsg("parameter \"%s\" cannot be changed without restarting the server",
5162 if (context != PGC_SIGHUP && context != PGC_POSTMASTER)
5165 (errcode(ERRCODE_CANT_CHANGE_RUNTIME_PARAM),
5166 errmsg("parameter \"%s\" cannot be changed now",
5172 * Hmm, the idea of the SIGHUP context is "ought to be global, but
5173 * can be changed after postmaster start". But there's nothing
5174 * that prevents a crafty administrator from sending SIGHUP
5175 * signals to individual backends only.
5179 if (context == PGC_SIGHUP)
5182 * If a PGC_BACKEND parameter is changed in the config file,
5183 * we want to accept the new value in the postmaster (whence
5184 * it will propagate to subsequently-started backends), but
5185 * ignore it in existing backends. This is a tad klugy, but
5186 * necessary because we don't re-read the config file during
5189 if (IsUnderPostmaster)
5192 else if (context != PGC_POSTMASTER && context != PGC_BACKEND &&
5193 source != PGC_S_CLIENT)
5196 (errcode(ERRCODE_CANT_CHANGE_RUNTIME_PARAM),
5197 errmsg("parameter \"%s\" cannot be set after connection start",
5203 if (context == PGC_USERSET || context == PGC_BACKEND)
5206 (errcode(ERRCODE_INSUFFICIENT_PRIVILEGE),
5207 errmsg("permission denied to set parameter \"%s\"",
5218 * Disallow changing GUC_NOT_WHILE_SEC_REST values if we are inside a
5219 * security restriction context. We can reject this regardless of the GUC
5220 * context or source, mainly because sources that it might be reasonable
5221 * to override for won't be seen while inside a function.
5223 * Note: variables marked GUC_NOT_WHILE_SEC_REST should usually be marked
5224 * GUC_NO_RESET_ALL as well, because ResetAllOptions() doesn't check this.
5225 * An exception might be made if the reset value is assumed to be "safe".
5227 * Note: this flag is currently used for "session_authorization" and
5228 * "role". We need to prohibit changing these inside a local userid
5229 * context because when we exit it, GUC won't be notified, leaving things
5230 * out of sync. (This could be fixed by forcing a new GUC nesting level,
5231 * but that would change behavior in possibly-undesirable ways.) Also, we
5232 * prohibit changing these in a security-restricted operation because
5233 * otherwise RESET could be used to regain the session user's privileges.
5235 if (record->flags & GUC_NOT_WHILE_SEC_REST)
5237 if (InLocalUserIdChange())
5240 * Phrasing of this error message is historical, but it's the most
5244 (errcode(ERRCODE_INSUFFICIENT_PRIVILEGE),
5245 errmsg("cannot set parameter \"%s\" within security-definer function",
5249 if (InSecurityRestrictedOperation())
5252 (errcode(ERRCODE_INSUFFICIENT_PRIVILEGE),
5253 errmsg("cannot set parameter \"%s\" within security-restricted operation",
5260 * Should we set reset/stacked values? (If so, the behavior is not
5261 * transactional.) This is done either when we get a default value from
5262 * the database's/user's/client's default settings or when we reset a
5263 * value to its default.
5265 makeDefault = changeVal && (source <= PGC_S_OVERRIDE) &&
5266 ((value != NULL) || source == PGC_S_DEFAULT);
5269 * Ignore attempted set if overridden by previously processed setting.
5270 * However, if changeVal is false then plow ahead anyway since we are
5271 * trying to find out if the value is potentially good, not actually use
5272 * it. Also keep going if makeDefault is true, since we may want to set
5273 * the reset/stacked values even if we can't set the variable itself.
5275 if (record->source > source)
5277 if (changeVal && !makeDefault)
5279 elog(DEBUG3, "\"%s\": setting ignored because previous source is higher priority",
5287 * Evaluate value and set variable.
5289 switch (record->vartype)
5293 struct config_bool *conf = (struct config_bool *) record;
5295 void *newextra = NULL;
5299 if (!parse_bool(value, &newval))
5302 (errcode(ERRCODE_INVALID_PARAMETER_VALUE),
5303 errmsg("parameter \"%s\" requires a Boolean value",
5307 if (!call_bool_check_hook(conf, &newval, &newextra,
5311 else if (source == PGC_S_DEFAULT)
5313 newval = conf->boot_val;
5314 if (!call_bool_check_hook(conf, &newval, &newextra,
5320 newval = conf->reset_val;
5321 newextra = conf->reset_extra;
5322 source = conf->gen.reset_source;
5325 if (prohibitValueChange)
5327 if (*conf->variable != newval)
5329 (errcode(ERRCODE_CANT_CHANGE_RUNTIME_PARAM),
5330 errmsg("parameter \"%s\" cannot be changed without restarting the server",
5337 /* Save old value to support transaction abort */
5339 push_old_value(&conf->gen, action);
5341 if (conf->assign_hook)
5342 (*conf->assign_hook) (newval, newextra);
5343 *conf->variable = newval;
5344 set_extra_field(&conf->gen, &conf->gen.extra,
5346 conf->gen.source = source;
5352 if (conf->gen.reset_source <= source)
5354 conf->reset_val = newval;
5355 set_extra_field(&conf->gen, &conf->reset_extra,
5357 conf->gen.reset_source = source;
5359 for (stack = conf->gen.stack; stack; stack = stack->prev)
5361 if (stack->source <= source)
5363 stack->prior.val.boolval = newval;
5364 set_extra_field(&conf->gen, &stack->prior.extra,
5366 stack->source = source;
5371 /* Perhaps we didn't install newextra anywhere */
5372 if (newextra && !extra_field_used(&conf->gen, newextra))
5379 struct config_int *conf = (struct config_int *) record;
5381 void *newextra = NULL;
5385 const char *hintmsg;
5387 if (!parse_int(value, &newval, conf->gen.flags, &hintmsg))
5390 (errcode(ERRCODE_INVALID_PARAMETER_VALUE),
5391 errmsg("invalid value for parameter \"%s\": \"%s\"",
5393 hintmsg ? errhint("%s", _(hintmsg)) : 0));
5396 if (newval < conf->min || newval > conf->max)
5399 (errcode(ERRCODE_INVALID_PARAMETER_VALUE),
5400 errmsg("%d is outside the valid range for parameter \"%s\" (%d .. %d)",
5401 newval, name, conf->min, conf->max)));
5404 if (!call_int_check_hook(conf, &newval, &newextra,
5408 else if (source == PGC_S_DEFAULT)
5410 newval = conf->boot_val;
5411 if (!call_int_check_hook(conf, &newval, &newextra,
5417 newval = conf->reset_val;
5418 newextra = conf->reset_extra;
5419 source = conf->gen.reset_source;
5422 if (prohibitValueChange)
5424 if (*conf->variable != newval)
5426 (errcode(ERRCODE_CANT_CHANGE_RUNTIME_PARAM),
5427 errmsg("parameter \"%s\" cannot be changed without restarting the server",
5434 /* Save old value to support transaction abort */
5436 push_old_value(&conf->gen, action);
5438 if (conf->assign_hook)
5439 (*conf->assign_hook) (newval, newextra);
5440 *conf->variable = newval;
5441 set_extra_field(&conf->gen, &conf->gen.extra,
5443 conf->gen.source = source;
5449 if (conf->gen.reset_source <= source)
5451 conf->reset_val = newval;
5452 set_extra_field(&conf->gen, &conf->reset_extra,
5454 conf->gen.reset_source = source;
5456 for (stack = conf->gen.stack; stack; stack = stack->prev)
5458 if (stack->source <= source)
5460 stack->prior.val.intval = newval;
5461 set_extra_field(&conf->gen, &stack->prior.extra,
5463 stack->source = source;
5468 /* Perhaps we didn't install newextra anywhere */
5469 if (newextra && !extra_field_used(&conf->gen, newextra))
5476 struct config_real *conf = (struct config_real *) record;
5478 void *newextra = NULL;
5482 if (!parse_real(value, &newval))
5485 (errcode(ERRCODE_INVALID_PARAMETER_VALUE),
5486 errmsg("parameter \"%s\" requires a numeric value",
5490 if (newval < conf->min || newval > conf->max)
5493 (errcode(ERRCODE_INVALID_PARAMETER_VALUE),
5494 errmsg("%g is outside the valid range for parameter \"%s\" (%g .. %g)",
5495 newval, name, conf->min, conf->max)));
5498 if (!call_real_check_hook(conf, &newval, &newextra,
5502 else if (source == PGC_S_DEFAULT)
5504 newval = conf->boot_val;
5505 if (!call_real_check_hook(conf, &newval, &newextra,
5511 newval = conf->reset_val;
5512 newextra = conf->reset_extra;
5513 source = conf->gen.reset_source;
5516 if (prohibitValueChange)
5518 if (*conf->variable != newval)
5520 (errcode(ERRCODE_CANT_CHANGE_RUNTIME_PARAM),
5521 errmsg("parameter \"%s\" cannot be changed without restarting the server",
5528 /* Save old value to support transaction abort */
5530 push_old_value(&conf->gen, action);
5532 if (conf->assign_hook)
5533 (*conf->assign_hook) (newval, newextra);
5534 *conf->variable = newval;
5535 set_extra_field(&conf->gen, &conf->gen.extra,
5537 conf->gen.source = source;
5543 if (conf->gen.reset_source <= source)
5545 conf->reset_val = newval;
5546 set_extra_field(&conf->gen, &conf->reset_extra,
5548 conf->gen.reset_source = source;
5550 for (stack = conf->gen.stack; stack; stack = stack->prev)
5552 if (stack->source <= source)
5554 stack->prior.val.realval = newval;
5555 set_extra_field(&conf->gen, &stack->prior.extra,
5557 stack->source = source;
5562 /* Perhaps we didn't install newextra anywhere */
5563 if (newextra && !extra_field_used(&conf->gen, newextra))
5570 struct config_string *conf = (struct config_string *) record;
5572 void *newextra = NULL;
5577 * The value passed by the caller could be transient, so
5578 * we always strdup it.
5580 newval = guc_strdup(elevel, value);
5585 * The only built-in "parsing" check we have is to apply
5586 * truncation if GUC_IS_NAME.
5588 if (conf->gen.flags & GUC_IS_NAME)
5589 truncate_identifier(newval, strlen(newval), true);
5591 if (!call_string_check_hook(conf, &newval, &newextra,
5598 else if (source == PGC_S_DEFAULT)
5600 /* non-NULL boot_val must always get strdup'd */
5601 if (conf->boot_val != NULL)
5603 newval = guc_strdup(elevel, conf->boot_val);
5610 if (!call_string_check_hook(conf, &newval, &newextra,
5620 * strdup not needed, since reset_val is already under
5623 newval = conf->reset_val;
5624 newextra = conf->reset_extra;
5625 source = conf->gen.reset_source;
5628 if (prohibitValueChange)
5630 /* newval shouldn't be NULL, so we're a bit sloppy here */
5631 if (*conf->variable == NULL || newval == NULL ||
5632 strcmp(*conf->variable, newval) != 0)
5634 (errcode(ERRCODE_CANT_CHANGE_RUNTIME_PARAM),
5635 errmsg("parameter \"%s\" cannot be changed without restarting the server",
5642 /* Save old value to support transaction abort */
5644 push_old_value(&conf->gen, action);
5646 if (conf->assign_hook)
5647 (*conf->assign_hook) (newval, newextra);
5648 set_string_field(conf, conf->variable, newval);
5649 set_extra_field(&conf->gen, &conf->gen.extra,
5651 conf->gen.source = source;
5658 if (conf->gen.reset_source <= source)
5660 set_string_field(conf, &conf->reset_val, newval);
5661 set_extra_field(&conf->gen, &conf->reset_extra,
5663 conf->gen.reset_source = source;
5665 for (stack = conf->gen.stack; stack; stack = stack->prev)
5667 if (stack->source <= source)
5669 set_string_field(conf, &stack->prior.val.stringval,
5671 set_extra_field(&conf->gen, &stack->prior.extra,
5673 stack->source = source;
5678 /* Perhaps we didn't install newval anywhere */
5679 if (newval && !string_field_used(conf, newval))
5681 /* Perhaps we didn't install newextra anywhere */
5682 if (newextra && !extra_field_used(&conf->gen, newextra))
5689 struct config_enum *conf = (struct config_enum *) record;
5691 void *newextra = NULL;
5695 if (!config_enum_lookup_by_name(conf, value, &newval))
5699 hintmsg = config_enum_get_options(conf,
5700 "Available values: ",
5704 (errcode(ERRCODE_INVALID_PARAMETER_VALUE),
5705 errmsg("invalid value for parameter \"%s\": \"%s\"",
5707 hintmsg ? errhint("%s", _(hintmsg)) : 0));
5713 if (!call_enum_check_hook(conf, &newval, &newextra,
5717 else if (source == PGC_S_DEFAULT)
5719 newval = conf->boot_val;
5720 if (!call_enum_check_hook(conf, &newval, &newextra,
5726 newval = conf->reset_val;
5727 newextra = conf->reset_extra;
5728 source = conf->gen.reset_source;
5731 if (prohibitValueChange)
5733 if (*conf->variable != newval)
5735 (errcode(ERRCODE_CANT_CHANGE_RUNTIME_PARAM),
5736 errmsg("parameter \"%s\" cannot be changed without restarting the server",
5743 /* Save old value to support transaction abort */
5745 push_old_value(&conf->gen, action);
5747 if (conf->assign_hook)
5748 (*conf->assign_hook) (newval, newextra);
5749 *conf->variable = newval;
5750 set_extra_field(&conf->gen, &conf->gen.extra,
5752 conf->gen.source = source;
5758 if (conf->gen.reset_source <= source)
5760 conf->reset_val = newval;
5761 set_extra_field(&conf->gen, &conf->reset_extra,
5763 conf->gen.reset_source = source;
5765 for (stack = conf->gen.stack; stack; stack = stack->prev)
5767 if (stack->source <= source)
5769 stack->prior.val.enumval = newval;
5770 set_extra_field(&conf->gen, &stack->prior.extra,
5772 stack->source = source;
5777 /* Perhaps we didn't install newextra anywhere */
5778 if (newextra && !extra_field_used(&conf->gen, newextra))
5784 if (changeVal && (record->flags & GUC_REPORT))
5785 ReportGUCOption(record);
5792 * Set the fields for source file and line number the setting came from.
5795 set_config_sourcefile(const char *name, char *sourcefile, int sourceline)
5797 struct config_generic *record;
5801 * To avoid cluttering the log, only the postmaster bleats loudly about
5802 * problems with the config file.
5804 elevel = IsUnderPostmaster ? DEBUG3 : LOG;
5806 record = find_option(name, true, elevel);
5807 /* should not happen */
5809 elog(ERROR, "unrecognized configuration parameter \"%s\"", name);
5811 sourcefile = guc_strdup(elevel, sourcefile);
5812 if (record->sourcefile)
5813 free(record->sourcefile);
5814 record->sourcefile = sourcefile;
5815 record->sourceline = sourceline;
5819 * Set a config option to the given value. See also set_config_option,
5820 * this is just the wrapper to be called from outside GUC. NB: this
5821 * is used only for non-transactional operations.
5823 * Note: there is no support here for setting source file/line, as it
5824 * is currently not needed.
5827 SetConfigOption(const char *name, const char *value,
5828 GucContext context, GucSource source)
5830 (void) set_config_option(name, value, context, source,
5831 GUC_ACTION_SET, true);
5837 * Fetch the current value of the option `name', as a string.
5839 * If the option doesn't exist, return NULL if missing_ok is true (NOTE that
5840 * this cannot be distinguished from a string variable with a NULL value!),
5841 * otherwise throw an ereport and don't return.
5843 * If restrict_superuser is true, we also enforce that only superusers can
5844 * see GUC_SUPERUSER_ONLY variables. This should only be passed as true
5845 * in user-driven calls.
5847 * The string is *not* allocated for modification and is really only
5848 * valid until the next call to configuration related functions.
5851 GetConfigOption(const char *name, bool missing_ok, bool restrict_superuser)
5853 struct config_generic *record;
5854 static char buffer[256];
5856 record = find_option(name, false, ERROR);
5862 (errcode(ERRCODE_UNDEFINED_OBJECT),
5863 errmsg("unrecognized configuration parameter \"%s\"",
5866 if (restrict_superuser &&
5867 (record->flags & GUC_SUPERUSER_ONLY) &&
5870 (errcode(ERRCODE_INSUFFICIENT_PRIVILEGE),
5871 errmsg("must be superuser to examine \"%s\"", name)));
5873 switch (record->vartype)
5876 return *((struct config_bool *) record)->variable ? "on" : "off";
5879 snprintf(buffer, sizeof(buffer), "%d",
5880 *((struct config_int *) record)->variable);
5884 snprintf(buffer, sizeof(buffer), "%g",
5885 *((struct config_real *) record)->variable);
5889 return *((struct config_string *) record)->variable;
5892 return config_enum_lookup_by_value((struct config_enum *) record,
5893 *((struct config_enum *) record)->variable);
5899 * Get the RESET value associated with the given option.
5901 * Note: this is not re-entrant, due to use of static result buffer;
5902 * not to mention that a string variable could have its reset_val changed.
5903 * Beware of assuming the result value is good for very long.
5906 GetConfigOptionResetString(const char *name)
5908 struct config_generic *record;
5909 static char buffer[256];
5911 record = find_option(name, false, ERROR);
5914 (errcode(ERRCODE_UNDEFINED_OBJECT),
5915 errmsg("unrecognized configuration parameter \"%s\"", name)));
5916 if ((record->flags & GUC_SUPERUSER_ONLY) && !superuser())
5918 (errcode(ERRCODE_INSUFFICIENT_PRIVILEGE),
5919 errmsg("must be superuser to examine \"%s\"", name)));
5921 switch (record->vartype)
5924 return ((struct config_bool *) record)->reset_val ? "on" : "off";
5927 snprintf(buffer, sizeof(buffer), "%d",
5928 ((struct config_int *) record)->reset_val);
5932 snprintf(buffer, sizeof(buffer), "%g",
5933 ((struct config_real *) record)->reset_val);
5937 return ((struct config_string *) record)->reset_val;
5940 return config_enum_lookup_by_value((struct config_enum *) record,
5941 ((struct config_enum *) record)->reset_val);
5948 * flatten_set_variable_args
5949 * Given a parsenode List as emitted by the grammar for SET,
5950 * convert to the flat string representation used by GUC.
5952 * We need to be told the name of the variable the args are for, because
5953 * the flattening rules vary (ugh).
5955 * The result is NULL if args is NIL (ie, SET ... TO DEFAULT), otherwise
5956 * a palloc'd string.
5959 flatten_set_variable_args(const char *name, List *args)
5961 struct config_generic *record;
5966 /* Fast path if just DEFAULT */
5971 * Get flags for the variable; if it's not known, use default flags.
5972 * (Caller might throw error later, but not our business to do so here.)
5974 record = find_option(name, false, WARNING);
5976 flags = record->flags;
5980 /* Complain if list input and non-list variable */
5981 if ((flags & GUC_LIST_INPUT) == 0 &&
5982 list_length(args) != 1)
5984 (errcode(ERRCODE_INVALID_PARAMETER_VALUE),
5985 errmsg("SET %s takes only one argument", name)));
5987 initStringInfo(&buf);
5990 * Each list member may be a plain A_Const node, or an A_Const within a
5991 * TypeCast; the latter case is supported only for ConstInterval arguments
5992 * (for SET TIME ZONE).
5996 Node *arg = (Node *) lfirst(l);
5998 TypeName *typeName = NULL;
6001 if (l != list_head(args))
6002 appendStringInfo(&buf, ", ");
6004 if (IsA(arg, TypeCast))
6006 TypeCast *tc = (TypeCast *) arg;
6009 typeName = tc->typeName;
6012 if (!IsA(arg, A_Const))
6013 elog(ERROR, "unrecognized node type: %d", (int) nodeTag(arg));
6014 con = (A_Const *) arg;
6016 switch (nodeTag(&con->val))
6019 appendStringInfo(&buf, "%ld", intVal(&con->val));
6022 /* represented as a string, so just copy it */
6023 appendStringInfoString(&buf, strVal(&con->val));
6026 val = strVal(&con->val);
6027 if (typeName != NULL)
6030 * Must be a ConstInterval argument for TIME ZONE. Coerce
6031 * to interval and back to normalize the value and account
6039 typenameTypeIdAndMod(NULL, typeName, &typoid, &typmod);
6040 Assert(typoid == INTERVALOID);
6043 DirectFunctionCall3(interval_in,
6044 CStringGetDatum(val),
6045 ObjectIdGetDatum(InvalidOid),
6046 Int32GetDatum(typmod));
6049 DatumGetCString(DirectFunctionCall1(interval_out,
6051 appendStringInfo(&buf, "INTERVAL '%s'", intervalout);
6056 * Plain string literal or identifier. For quote mode,
6057 * quote it if it's not a vanilla identifier.
6059 if (flags & GUC_LIST_QUOTE)
6060 appendStringInfoString(&buf, quote_identifier(val));
6062 appendStringInfoString(&buf, val);
6066 elog(ERROR, "unrecognized node type: %d",
6067 (int) nodeTag(&con->val));
6080 ExecSetVariableStmt(VariableSetStmt *stmt)
6082 GucAction action = stmt->is_local ? GUC_ACTION_LOCAL : GUC_ACTION_SET;
6087 case VAR_SET_CURRENT:
6088 set_config_option(stmt->name,
6089 ExtractSetVariableArgs(stmt),
6090 (superuser() ? PGC_SUSET : PGC_USERSET),
6098 * Special case for special SQL syntax that effectively sets more
6099 * than one variable per statement.
6101 if (strcmp(stmt->name, "TRANSACTION") == 0)
6105 foreach(head, stmt->args)
6107 DefElem *item = (DefElem *) lfirst(head);
6109 if (strcmp(item->defname, "transaction_isolation") == 0)
6110 SetPGVariable("transaction_isolation",
6111 list_make1(item->arg), stmt->is_local);
6112 else if (strcmp(item->defname, "transaction_read_only") == 0)
6113 SetPGVariable("transaction_read_only",
6114 list_make1(item->arg), stmt->is_local);
6115 else if (strcmp(item->defname, "transaction_deferrable") == 0)
6116 SetPGVariable("transaction_deferrable",
6117 list_make1(item->arg), stmt->is_local);
6119 elog(ERROR, "unexpected SET TRANSACTION element: %s",
6123 else if (strcmp(stmt->name, "SESSION CHARACTERISTICS") == 0)
6127 foreach(head, stmt->args)
6129 DefElem *item = (DefElem *) lfirst(head);
6131 if (strcmp(item->defname, "transaction_isolation") == 0)
6132 SetPGVariable("default_transaction_isolation",
6133 list_make1(item->arg), stmt->is_local);
6134 else if (strcmp(item->defname, "transaction_read_only") == 0)
6135 SetPGVariable("default_transaction_read_only",
6136 list_make1(item->arg), stmt->is_local);
6137 else if (strcmp(item->defname, "transaction_deferrable") == 0)
6138 SetPGVariable("default_transaction_deferrable",
6139 list_make1(item->arg), stmt->is_local);
6141 elog(ERROR, "unexpected SET SESSION element: %s",
6146 elog(ERROR, "unexpected SET MULTI element: %s",
6149 case VAR_SET_DEFAULT:
6151 set_config_option(stmt->name,
6153 (superuser() ? PGC_SUSET : PGC_USERSET),
6165 * Get the value to assign for a VariableSetStmt, or NULL if it's RESET.
6166 * The result is palloc'd.
6168 * This is exported for use by actions such as ALTER ROLE SET.
6171 ExtractSetVariableArgs(VariableSetStmt *stmt)
6176 return flatten_set_variable_args(stmt->name, stmt->args);
6177 case VAR_SET_CURRENT:
6178 return GetConfigOptionByName(stmt->name, NULL);
6185 * SetPGVariable - SET command exported as an easily-C-callable function.
6187 * This provides access to SET TO value, as well as SET TO DEFAULT (expressed
6188 * by passing args == NIL), but not SET FROM CURRENT functionality.
6191 SetPGVariable(const char *name, List *args, bool is_local)
6193 char *argstring = flatten_set_variable_args(name, args);
6195 /* Note SET DEFAULT (argstring == NULL) is equivalent to RESET */
6196 set_config_option(name,
6198 (superuser() ? PGC_SUSET : PGC_USERSET),
6200 is_local ? GUC_ACTION_LOCAL : GUC_ACTION_SET,
6205 * SET command wrapped as a SQL callable function.
6208 set_config_by_name(PG_FUNCTION_ARGS)
6215 if (PG_ARGISNULL(0))
6217 (errcode(ERRCODE_NULL_VALUE_NOT_ALLOWED),
6218 errmsg("SET requires parameter name")));
6220 /* Get the GUC variable name */
6221 name = TextDatumGetCString(PG_GETARG_DATUM(0));
6223 /* Get the desired value or set to NULL for a reset request */
6224 if (PG_ARGISNULL(1))
6227 value = TextDatumGetCString(PG_GETARG_DATUM(1));
6230 * Get the desired state of is_local. Default to false if provided value
6233 if (PG_ARGISNULL(2))
6236 is_local = PG_GETARG_BOOL(2);
6238 /* Note SET DEFAULT (argstring == NULL) is equivalent to RESET */
6239 set_config_option(name,
6241 (superuser() ? PGC_SUSET : PGC_USERSET),
6243 is_local ? GUC_ACTION_LOCAL : GUC_ACTION_SET,
6246 /* get the new current value */
6247 new_value = GetConfigOptionByName(name, NULL);
6249 /* Convert return string to text */
6250 PG_RETURN_TEXT_P(cstring_to_text(new_value));
6255 * Common code for DefineCustomXXXVariable subroutines: allocate the
6256 * new variable's config struct and fill in generic fields.
6258 static struct config_generic *
6259 init_custom_variable(const char *name,
6260 const char *short_desc,
6261 const char *long_desc,
6264 enum config_type type,
6267 struct config_generic *gen;
6270 * Only allow custom PGC_POSTMASTER variables to be created during shared
6271 * library preload; any later than that, we can't ensure that the value
6272 * doesn't change after startup. This is a fatal elog if it happens; just
6273 * erroring out isn't safe because we don't know what the calling loadable
6274 * module might already have hooked into.
6276 if (context == PGC_POSTMASTER &&
6277 !process_shared_preload_libraries_in_progress)
6278 elog(FATAL, "cannot create PGC_POSTMASTER variables after startup");
6280 gen = (struct config_generic *) guc_malloc(ERROR, sz);
6283 gen->name = guc_strdup(ERROR, name);
6284 gen->context = context;
6285 gen->group = CUSTOM_OPTIONS;
6286 gen->short_desc = short_desc;
6287 gen->long_desc = long_desc;
6289 gen->vartype = type;
6295 * Common code for DefineCustomXXXVariable subroutines: insert the new
6296 * variable into the GUC variable array, replacing any placeholder.
6299 define_custom_variable(struct config_generic * variable)
6301 const char *name = variable->name;
6302 const char **nameAddr = &name;
6304 struct config_string *pHolder;
6305 GucContext phcontext;
6306 struct config_generic **res;
6309 * See if there's a placeholder by the same name.
6311 res = (struct config_generic **) bsearch((void *) &nameAddr,
6312 (void *) guc_variables,
6314 sizeof(struct config_generic *),
6319 * No placeholder to replace, so we can just add it ... but first,
6320 * make sure it's initialized to its default value.
6322 InitializeOneGUCOption(variable);
6323 add_guc_variable(variable, ERROR);
6328 * This better be a placeholder
6330 if (((*res)->flags & GUC_CUSTOM_PLACEHOLDER) == 0)
6332 (errcode(ERRCODE_INTERNAL_ERROR),
6333 errmsg("attempt to redefine parameter \"%s\"", name)));
6335 Assert((*res)->vartype == PGC_STRING);
6336 pHolder = (struct config_string *) (*res);
6339 * First, set the variable to its default value. We must do this even
6340 * though we intend to immediately apply a new value, since it's possible
6341 * that the new value is invalid.
6343 InitializeOneGUCOption(variable);
6346 * Replace the placeholder. We aren't changing the name, so no re-sorting
6352 * Infer context for assignment based on source of existing value. We
6353 * can't tell this with exact accuracy, but we can at least do something
6354 * reasonable in typical cases.
6356 switch (pHolder->gen.source)
6359 case PGC_S_DYNAMIC_DEFAULT:
6365 * If we got past the check in init_custom_variable, we can safely
6366 * assume that any existing value for a PGC_POSTMASTER variable
6367 * was set in postmaster context.
6369 if (variable->context == PGC_POSTMASTER)
6370 phcontext = PGC_POSTMASTER;
6372 phcontext = PGC_SIGHUP;
6375 case PGC_S_DATABASE:
6377 case PGC_S_DATABASE_USER:
6380 * The existing value came from an ALTER ROLE/DATABASE SET
6381 * command. We can assume that at the time the command was issued,
6382 * we checked that the issuing user was superuser if the variable
6383 * requires superuser privileges to set. So it's safe to use
6384 * SUSET context here.
6386 phcontext = PGC_SUSET;
6394 * We must assume that the value came from an untrusted user, even
6395 * if the current_user is a superuser.
6397 phcontext = PGC_USERSET;
6402 * Assign the string value stored in the placeholder to the real variable.
6404 * XXX this is not really good enough --- it should be a nontransactional
6405 * assignment, since we don't want it to roll back if the current xact
6406 * fails later. (Or do we?)
6408 value = *pHolder->variable;
6412 if (set_config_option(name, value,
6413 phcontext, pHolder->gen.source,
6414 GUC_ACTION_SET, true))
6416 /* Also copy over any saved source-location information */
6417 if (pHolder->gen.sourcefile)
6418 set_config_sourcefile(name, pHolder->gen.sourcefile,
6419 pHolder->gen.sourceline);
6424 * Free up as much as we conveniently can of the placeholder structure
6425 * (this neglects any stack items...)
6427 set_string_field(pHolder, pHolder->variable, NULL);
6428 set_string_field(pHolder, &pHolder->reset_val, NULL);
6434 DefineCustomBoolVariable(const char *name,
6435 const char *short_desc,
6436 const char *long_desc,
6441 GucBoolCheckHook check_hook,
6442 GucBoolAssignHook assign_hook,
6443 GucShowHook show_hook)
6445 struct config_bool *var;
6447 var = (struct config_bool *)
6448 init_custom_variable(name, short_desc, long_desc, context, flags,
6449 PGC_BOOL, sizeof(struct config_bool));
6450 var->variable = valueAddr;
6451 var->boot_val = bootValue;
6452 var->reset_val = bootValue;
6453 var->check_hook = check_hook;
6454 var->assign_hook = assign_hook;
6455 var->show_hook = show_hook;
6456 define_custom_variable(&var->gen);
6460 DefineCustomIntVariable(const char *name,
6461 const char *short_desc,
6462 const char *long_desc,
6469 GucIntCheckHook check_hook,
6470 GucIntAssignHook assign_hook,
6471 GucShowHook show_hook)
6473 struct config_int *var;
6475 var = (struct config_int *)
6476 init_custom_variable(name, short_desc, long_desc, context, flags,
6477 PGC_INT, sizeof(struct config_int));
6478 var->variable = valueAddr;
6479 var->boot_val = bootValue;
6480 var->reset_val = bootValue;
6481 var->min = minValue;
6482 var->max = maxValue;
6483 var->check_hook = check_hook;
6484 var->assign_hook = assign_hook;
6485 var->show_hook = show_hook;
6486 define_custom_variable(&var->gen);
6490 DefineCustomRealVariable(const char *name,
6491 const char *short_desc,
6492 const char *long_desc,
6499 GucRealCheckHook check_hook,
6500 GucRealAssignHook assign_hook,
6501 GucShowHook show_hook)
6503 struct config_real *var;
6505 var = (struct config_real *)
6506 init_custom_variable(name, short_desc, long_desc, context, flags,
6507 PGC_REAL, sizeof(struct config_real));
6508 var->variable = valueAddr;
6509 var->boot_val = bootValue;
6510 var->reset_val = bootValue;
6511 var->min = minValue;
6512 var->max = maxValue;
6513 var->check_hook = check_hook;
6514 var->assign_hook = assign_hook;
6515 var->show_hook = show_hook;
6516 define_custom_variable(&var->gen);
6520 DefineCustomStringVariable(const char *name,
6521 const char *short_desc,
6522 const char *long_desc,
6524 const char *bootValue,
6527 GucStringCheckHook check_hook,
6528 GucStringAssignHook assign_hook,
6529 GucShowHook show_hook)
6531 struct config_string *var;
6533 var = (struct config_string *)
6534 init_custom_variable(name, short_desc, long_desc, context, flags,
6535 PGC_STRING, sizeof(struct config_string));
6536 var->variable = valueAddr;
6537 var->boot_val = bootValue;
6538 var->check_hook = check_hook;
6539 var->assign_hook = assign_hook;
6540 var->show_hook = show_hook;
6541 define_custom_variable(&var->gen);
6545 DefineCustomEnumVariable(const char *name,
6546 const char *short_desc,
6547 const char *long_desc,
6550 const struct config_enum_entry * options,
6553 GucEnumCheckHook check_hook,
6554 GucEnumAssignHook assign_hook,
6555 GucShowHook show_hook)
6557 struct config_enum *var;
6559 var = (struct config_enum *)
6560 init_custom_variable(name, short_desc, long_desc, context, flags,
6561 PGC_ENUM, sizeof(struct config_enum));
6562 var->variable = valueAddr;
6563 var->boot_val = bootValue;
6564 var->reset_val = bootValue;
6565 var->options = options;
6566 var->check_hook = check_hook;
6567 var->assign_hook = assign_hook;
6568 var->show_hook = show_hook;
6569 define_custom_variable(&var->gen);
6573 EmitWarningsOnPlaceholders(const char *className)
6575 int classLen = strlen(className);
6578 for (i = 0; i < num_guc_variables; i++)
6580 struct config_generic *var = guc_variables[i];
6582 if ((var->flags & GUC_CUSTOM_PLACEHOLDER) != 0 &&
6583 strncmp(className, var->name, classLen) == 0 &&
6584 var->name[classLen] == GUC_QUALIFIER_SEPARATOR)
6587 (errcode(ERRCODE_UNDEFINED_OBJECT),
6588 errmsg("unrecognized configuration parameter \"%s\"",
6599 GetPGVariable(const char *name, DestReceiver *dest)
6601 if (guc_name_compare(name, "all") == 0)
6602 ShowAllGUCConfig(dest);
6604 ShowGUCConfigOption(name, dest);
6608 GetPGVariableResultDesc(const char *name)
6612 if (guc_name_compare(name, "all") == 0)
6614 /* need a tuple descriptor representing three TEXT columns */
6615 tupdesc = CreateTemplateTupleDesc(3, false);
6616 TupleDescInitEntry(tupdesc, (AttrNumber) 1, "name",
6618 TupleDescInitEntry(tupdesc, (AttrNumber) 2, "setting",
6620 TupleDescInitEntry(tupdesc, (AttrNumber) 3, "description",
6625 const char *varname;
6627 /* Get the canonical spelling of name */
6628 (void) GetConfigOptionByName(name, &varname);
6630 /* need a tuple descriptor representing a single TEXT column */
6631 tupdesc = CreateTemplateTupleDesc(1, false);
6632 TupleDescInitEntry(tupdesc, (AttrNumber) 1, varname,
6643 ShowGUCConfigOption(const char *name, DestReceiver *dest)
6645 TupOutputState *tstate;
6647 const char *varname;
6650 /* Get the value and canonical spelling of name */
6651 value = GetConfigOptionByName(name, &varname);
6653 /* need a tuple descriptor representing a single TEXT column */
6654 tupdesc = CreateTemplateTupleDesc(1, false);
6655 TupleDescInitEntry(tupdesc, (AttrNumber) 1, varname,
6658 /* prepare for projection of tuples */
6659 tstate = begin_tup_output_tupdesc(dest, tupdesc);
6662 do_text_output_oneline(tstate, value);
6664 end_tup_output(tstate);
6671 ShowAllGUCConfig(DestReceiver *dest)
6673 bool am_superuser = superuser();
6675 TupOutputState *tstate;
6678 bool isnull[3] = {false, false, false};
6680 /* need a tuple descriptor representing three TEXT columns */
6681 tupdesc = CreateTemplateTupleDesc(3, false);
6682 TupleDescInitEntry(tupdesc, (AttrNumber) 1, "name",
6684 TupleDescInitEntry(tupdesc, (AttrNumber) 2, "setting",
6686 TupleDescInitEntry(tupdesc, (AttrNumber) 3, "description",
6689 /* prepare for projection of tuples */
6690 tstate = begin_tup_output_tupdesc(dest, tupdesc);
6692 for (i = 0; i < num_guc_variables; i++)
6694 struct config_generic *conf = guc_variables[i];
6697 if ((conf->flags & GUC_NO_SHOW_ALL) ||
6698 ((conf->flags & GUC_SUPERUSER_ONLY) && !am_superuser))
6701 /* assign to the values array */
6702 values[0] = PointerGetDatum(cstring_to_text(conf->name));
6704 setting = _ShowOption(conf, true);
6707 values[1] = PointerGetDatum(cstring_to_text(setting));
6712 values[1] = PointerGetDatum(NULL);
6716 values[2] = PointerGetDatum(cstring_to_text(conf->short_desc));
6718 /* send it to dest */
6719 do_tup_output(tstate, values, isnull);
6722 pfree(DatumGetPointer(values[0]));
6726 pfree(DatumGetPointer(values[1]));
6728 pfree(DatumGetPointer(values[2]));
6731 end_tup_output(tstate);
6735 * Return GUC variable value by name; optionally return canonical
6736 * form of name. Return value is palloc'd.
6739 GetConfigOptionByName(const char *name, const char **varname)
6741 struct config_generic *record;
6743 record = find_option(name, false, ERROR);
6746 (errcode(ERRCODE_UNDEFINED_OBJECT),
6747 errmsg("unrecognized configuration parameter \"%s\"", name)));
6748 if ((record->flags & GUC_SUPERUSER_ONLY) && !superuser())
6750 (errcode(ERRCODE_INSUFFICIENT_PRIVILEGE),
6751 errmsg("must be superuser to examine \"%s\"", name)));
6754 *varname = record->name;
6756 return _ShowOption(record, true);
6760 * Return GUC variable value by variable number; optionally return canonical
6761 * form of name. Return value is palloc'd.
6764 GetConfigOptionByNum(int varnum, const char **values, bool *noshow)
6767 struct config_generic *conf;
6769 /* check requested variable number valid */
6770 Assert((varnum >= 0) && (varnum < num_guc_variables));
6772 conf = guc_variables[varnum];
6776 if ((conf->flags & GUC_NO_SHOW_ALL) ||
6777 ((conf->flags & GUC_SUPERUSER_ONLY) && !superuser()))
6783 /* first get the generic attributes */
6786 values[0] = conf->name;
6788 /* setting : use _ShowOption in order to avoid duplicating the logic */
6789 values[1] = _ShowOption(conf, false);
6792 if (conf->vartype == PGC_INT)
6796 switch (conf->flags & (GUC_UNIT_MEMORY | GUC_UNIT_TIME))
6801 case GUC_UNIT_BLOCKS:
6802 snprintf(buf, sizeof(buf), "%dkB", BLCKSZ / 1024);
6805 case GUC_UNIT_XBLOCKS:
6806 snprintf(buf, sizeof(buf), "%dkB", XLOG_BLCKSZ / 1024);
6827 values[3] = config_group_names[conf->group];
6830 values[4] = conf->short_desc;
6833 values[5] = conf->long_desc;
6836 values[6] = GucContext_Names[conf->context];
6839 values[7] = config_type_names[conf->vartype];
6842 values[8] = GucSource_Names[conf->source];
6844 /* now get the type specifc attributes */
6845 switch (conf->vartype)
6849 struct config_bool *lconf = (struct config_bool *) conf;
6861 values[12] = pstrdup(lconf->boot_val ? "on" : "off");
6864 values[13] = pstrdup(lconf->reset_val ? "on" : "off");
6870 struct config_int *lconf = (struct config_int *) conf;
6873 snprintf(buffer, sizeof(buffer), "%d", lconf->min);
6874 values[9] = pstrdup(buffer);
6877 snprintf(buffer, sizeof(buffer), "%d", lconf->max);
6878 values[10] = pstrdup(buffer);
6884 snprintf(buffer, sizeof(buffer), "%d", lconf->boot_val);
6885 values[12] = pstrdup(buffer);
6888 snprintf(buffer, sizeof(buffer), "%d", lconf->reset_val);
6889 values[13] = pstrdup(buffer);
6895 struct config_real *lconf = (struct config_real *) conf;
6898 snprintf(buffer, sizeof(buffer), "%g", lconf->min);
6899 values[9] = pstrdup(buffer);
6902 snprintf(buffer, sizeof(buffer), "%g", lconf->max);
6903 values[10] = pstrdup(buffer);
6909 snprintf(buffer, sizeof(buffer), "%g", lconf->boot_val);
6910 values[12] = pstrdup(buffer);
6913 snprintf(buffer, sizeof(buffer), "%g", lconf->reset_val);
6914 values[13] = pstrdup(buffer);
6920 struct config_string *lconf = (struct config_string *) conf;
6932 if (lconf->boot_val == NULL)
6935 values[12] = pstrdup(lconf->boot_val);
6938 if (lconf->reset_val == NULL)
6941 values[13] = pstrdup(lconf->reset_val);
6947 struct config_enum *lconf = (struct config_enum *) conf;
6958 * NOTE! enumvals with double quotes in them are not
6961 values[11] = config_enum_get_options((struct config_enum *) conf,
6962 "{\"", "\"}", "\",\"");
6965 values[12] = pstrdup(config_enum_lookup_by_value(lconf,
6969 values[13] = pstrdup(config_enum_lookup_by_value(lconf,
6977 * should never get here, but in case we do, set 'em to NULL
6999 * If the setting came from a config file, set the source location. For
7000 * security reasons, we don't show source file/line number for
7003 if (conf->source == PGC_S_FILE && superuser())
7005 values[14] = conf->sourcefile;
7006 snprintf(buffer, sizeof(buffer), "%d", conf->sourceline);
7007 values[15] = pstrdup(buffer);
7017 * Return the total number of GUC variables
7020 GetNumConfigOptions(void)
7022 return num_guc_variables;
7026 * show_config_by_name - equiv to SHOW X command but implemented as
7030 show_config_by_name(PG_FUNCTION_ARGS)
7035 /* Get the GUC variable name */
7036 varname = TextDatumGetCString(PG_GETARG_DATUM(0));
7039 varval = GetConfigOptionByName(varname, NULL);
7041 /* Convert to text */
7042 PG_RETURN_TEXT_P(cstring_to_text(varval));
7046 * show_all_settings - equiv to SHOW ALL command but implemented as
7049 #define NUM_PG_SETTINGS_ATTS 16
7052 show_all_settings(PG_FUNCTION_ARGS)
7054 FuncCallContext *funcctx;
7058 AttInMetadata *attinmeta;
7059 MemoryContext oldcontext;
7061 /* stuff done only on the first call of the function */
7062 if (SRF_IS_FIRSTCALL())
7064 /* create a function context for cross-call persistence */
7065 funcctx = SRF_FIRSTCALL_INIT();
7068 * switch to memory context appropriate for multiple function calls
7070 oldcontext = MemoryContextSwitchTo(funcctx->multi_call_memory_ctx);
7073 * need a tuple descriptor representing NUM_PG_SETTINGS_ATTS columns
7074 * of the appropriate types
7076 tupdesc = CreateTemplateTupleDesc(NUM_PG_SETTINGS_ATTS, false);
7077 TupleDescInitEntry(tupdesc, (AttrNumber) 1, "name",
7079 TupleDescInitEntry(tupdesc, (AttrNumber) 2, "setting",
7081 TupleDescInitEntry(tupdesc, (AttrNumber) 3, "unit",
7083 TupleDescInitEntry(tupdesc, (AttrNumber) 4, "category",
7085 TupleDescInitEntry(tupdesc, (AttrNumber) 5, "short_desc",
7087 TupleDescInitEntry(tupdesc, (AttrNumber) 6, "extra_desc",
7089 TupleDescInitEntry(tupdesc, (AttrNumber) 7, "context",
7091 TupleDescInitEntry(tupdesc, (AttrNumber) 8, "vartype",
7093 TupleDescInitEntry(tupdesc, (AttrNumber) 9, "source",
7095 TupleDescInitEntry(tupdesc, (AttrNumber) 10, "min_val",
7097 TupleDescInitEntry(tupdesc, (AttrNumber) 11, "max_val",
7099 TupleDescInitEntry(tupdesc, (AttrNumber) 12, "enumvals",
7100 TEXTARRAYOID, -1, 0);
7101 TupleDescInitEntry(tupdesc, (AttrNumber) 13, "boot_val",
7103 TupleDescInitEntry(tupdesc, (AttrNumber) 14, "reset_val",
7105 TupleDescInitEntry(tupdesc, (AttrNumber) 15, "sourcefile",
7107 TupleDescInitEntry(tupdesc, (AttrNumber) 16, "sourceline",
7111 * Generate attribute metadata needed later to produce tuples from raw
7114 attinmeta = TupleDescGetAttInMetadata(tupdesc);
7115 funcctx->attinmeta = attinmeta;
7117 /* total number of tuples to be returned */
7118 funcctx->max_calls = GetNumConfigOptions();
7120 MemoryContextSwitchTo(oldcontext);
7123 /* stuff done on every call of the function */
7124 funcctx = SRF_PERCALL_SETUP();
7126 call_cntr = funcctx->call_cntr;
7127 max_calls = funcctx->max_calls;
7128 attinmeta = funcctx->attinmeta;
7130 if (call_cntr < max_calls) /* do when there is more left to send */
7132 char *values[NUM_PG_SETTINGS_ATTS];
7138 * Get the next visible GUC variable name and value
7142 GetConfigOptionByNum(call_cntr, (const char **) values, &noshow);
7145 /* bump the counter and get the next config setting */
7146 call_cntr = ++funcctx->call_cntr;
7148 /* make sure we haven't gone too far now */
7149 if (call_cntr >= max_calls)
7150 SRF_RETURN_DONE(funcctx);
7155 tuple = BuildTupleFromCStrings(attinmeta, values);
7157 /* make the tuple into a datum */
7158 result = HeapTupleGetDatum(tuple);
7160 SRF_RETURN_NEXT(funcctx, result);
7164 /* do when there is no more left */
7165 SRF_RETURN_DONE(funcctx);
7170 _ShowOption(struct config_generic * record, bool use_units)
7175 switch (record->vartype)
7179 struct config_bool *conf = (struct config_bool *) record;
7181 if (conf->show_hook)
7182 val = (*conf->show_hook) ();
7184 val = *conf->variable ? "on" : "off";
7190 struct config_int *conf = (struct config_int *) record;
7192 if (conf->show_hook)
7193 val = (*conf->show_hook) ();
7197 * Use int64 arithmetic to avoid overflows in units
7200 int64 result = *conf->variable;
7203 if (use_units && result > 0 &&
7204 (record->flags & GUC_UNIT_MEMORY))
7206 switch (record->flags & GUC_UNIT_MEMORY)
7208 case GUC_UNIT_BLOCKS:
7209 result *= BLCKSZ / 1024;
7211 case GUC_UNIT_XBLOCKS:
7212 result *= XLOG_BLCKSZ / 1024;
7216 if (result % KB_PER_GB == 0)
7218 result /= KB_PER_GB;
7221 else if (result % KB_PER_MB == 0)
7223 result /= KB_PER_MB;
7231 else if (use_units && result > 0 &&
7232 (record->flags & GUC_UNIT_TIME))
7234 switch (record->flags & GUC_UNIT_TIME)
7240 result *= MS_PER_MIN;
7244 if (result % MS_PER_D == 0)
7249 else if (result % MS_PER_H == 0)
7254 else if (result % MS_PER_MIN == 0)
7256 result /= MS_PER_MIN;
7259 else if (result % MS_PER_S == 0)
7272 snprintf(buffer, sizeof(buffer), INT64_FORMAT "%s",
7281 struct config_real *conf = (struct config_real *) record;
7283 if (conf->show_hook)
7284 val = (*conf->show_hook) ();
7287 snprintf(buffer, sizeof(buffer), "%g",
7296 struct config_string *conf = (struct config_string *) record;
7298 if (conf->show_hook)
7299 val = (*conf->show_hook) ();
7300 else if (*conf->variable && **conf->variable)
7301 val = *conf->variable;
7309 struct config_enum *conf = (struct config_enum *) record;
7311 if (conf->show_hook)
7312 val = (*conf->show_hook) ();
7314 val = config_enum_lookup_by_value(conf, *conf->variable);
7319 /* just to keep compiler quiet */
7324 return pstrdup(val);
7331 * These routines dump out all non-default GUC options into a binary
7332 * file that is read by all exec'ed backends. The format is:
7334 * variable name, string, null terminated
7335 * variable value, string, null terminated
7336 * variable source, integer
7339 write_one_nondefault_variable(FILE *fp, struct config_generic * gconf)
7341 if (gconf->source == PGC_S_DEFAULT)
7344 fprintf(fp, "%s", gconf->name);
7347 switch (gconf->vartype)
7351 struct config_bool *conf = (struct config_bool *) gconf;
7353 if (*conf->variable)
7354 fprintf(fp, "true");
7356 fprintf(fp, "false");
7362 struct config_int *conf = (struct config_int *) gconf;
7364 fprintf(fp, "%d", *conf->variable);
7370 struct config_real *conf = (struct config_real *) gconf;
7372 /* Could lose precision here? */
7373 fprintf(fp, "%f", *conf->variable);
7379 struct config_string *conf = (struct config_string *) gconf;
7381 fprintf(fp, "%s", *conf->variable);
7387 struct config_enum *conf = (struct config_enum *) gconf;
7390 config_enum_lookup_by_value(conf, *conf->variable));
7397 fwrite(&gconf->source, sizeof(gconf->source), 1, fp);
7401 write_nondefault_variables(GucContext context)
7405 struct config_generic *cvc_conf;
7408 Assert(context == PGC_POSTMASTER || context == PGC_SIGHUP);
7410 elevel = (context == PGC_SIGHUP) ? LOG : ERROR;
7415 fp = AllocateFile(CONFIG_EXEC_PARAMS_NEW, "w");
7419 (errcode_for_file_access(),
7420 errmsg("could not write to file \"%s\": %m",
7421 CONFIG_EXEC_PARAMS_NEW)));
7426 * custom_variable_classes must be written out first; otherwise we might
7427 * reject custom variable values while reading the file.
7429 cvc_conf = find_option("custom_variable_classes", false, ERROR);
7431 write_one_nondefault_variable(fp, cvc_conf);
7433 for (i = 0; i < num_guc_variables; i++)
7435 struct config_generic *gconf = guc_variables[i];
7437 if (gconf != cvc_conf)
7438 write_one_nondefault_variable(fp, gconf);
7444 (errcode_for_file_access(),
7445 errmsg("could not write to file \"%s\": %m",
7446 CONFIG_EXEC_PARAMS_NEW)));
7451 * Put new file in place. This could delay on Win32, but we don't hold
7452 * any exclusive locks.
7454 rename(CONFIG_EXEC_PARAMS_NEW, CONFIG_EXEC_PARAMS);
7459 * Read string, including null byte from file
7461 * Return NULL on EOF and nothing read
7464 read_string_with_null(FILE *fp)
7473 if ((ch = fgetc(fp)) == EOF)
7478 elog(FATAL, "invalid format of exec config params file");
7481 str = guc_malloc(FATAL, maxlen);
7482 else if (i == maxlen)
7483 str = guc_realloc(FATAL, str, maxlen *= 2);
7492 * This routine loads a previous postmaster dump of its non-default
7496 read_nondefault_variables(void)
7506 fp = AllocateFile(CONFIG_EXEC_PARAMS, "r");
7509 /* File not found is fine */
7510 if (errno != ENOENT)
7512 (errcode_for_file_access(),
7513 errmsg("could not read from file \"%s\": %m",
7514 CONFIG_EXEC_PARAMS)));
7520 struct config_generic *record;
7522 if ((varname = read_string_with_null(fp)) == NULL)
7525 if ((record = find_option(varname, true, FATAL)) == NULL)
7526 elog(FATAL, "failed to locate variable %s in exec config params file", varname);
7527 if ((varvalue = read_string_with_null(fp)) == NULL)
7528 elog(FATAL, "invalid format of exec config params file");
7529 if (fread(&varsource, sizeof(varsource), 1, fp) == 0)
7530 elog(FATAL, "invalid format of exec config params file");
7532 (void) set_config_option(varname, varvalue, record->context,
7533 varsource, GUC_ACTION_SET, true);
7540 #endif /* EXEC_BACKEND */
7544 * A little "long argument" simulation, although not quite GNU
7545 * compliant. Takes a string of the form "some-option=some value" and
7546 * returns name = "some_option" and value = "some value" in malloc'ed
7547 * storage. Note that '-' is converted to '_' in the option name. If
7548 * there is no '=' in the input string then value will be NULL.
7551 ParseLongOption(const char *string, char **name, char **value)
7560 equal_pos = strcspn(string, "=");
7562 if (string[equal_pos] == '=')
7564 *name = guc_malloc(FATAL, equal_pos + 1);
7565 strlcpy(*name, string, equal_pos + 1);
7567 *value = guc_strdup(FATAL, &string[equal_pos + 1]);
7571 /* no equal sign in string */
7572 *name = guc_strdup(FATAL, string);
7576 for (cp = *name; *cp; cp++)
7583 * Handle options fetched from pg_db_role_setting.setconfig,
7584 * pg_proc.proconfig, etc. Caller must specify proper context/source/action.
7586 * The array parameter must be an array of TEXT (it must not be NULL).
7589 ProcessGUCArray(ArrayType *array,
7590 GucContext context, GucSource source, GucAction action)
7594 Assert(array != NULL);
7595 Assert(ARR_ELEMTYPE(array) == TEXTOID);
7596 Assert(ARR_NDIM(array) == 1);
7597 Assert(ARR_LBOUND(array)[0] == 1);
7599 for (i = 1; i <= ARR_DIMS(array)[0]; i++)
7607 d = array_ref(array, 1, &i,
7608 -1 /* varlenarray */ ,
7609 -1 /* TEXT's typlen */ ,
7610 false /* TEXT's typbyval */ ,
7611 'i' /* TEXT's typalign */ ,
7617 s = TextDatumGetCString(d);
7619 ParseLongOption(s, &name, &value);
7623 (errcode(ERRCODE_SYNTAX_ERROR),
7624 errmsg("could not parse setting for parameter \"%s\"",
7630 (void) set_config_option(name, value, context, source, action, true);
7641 * Add an entry to an option array. The array parameter may be NULL
7642 * to indicate the current table entry is NULL.
7645 GUCArrayAdd(ArrayType *array, const char *name, const char *value)
7647 struct config_generic *record;
7655 /* test if the option is valid and we're allowed to set it */
7656 (void) validate_option_array_item(name, value, false);
7658 /* normalize name (converts obsolete GUC names to modern spellings) */
7659 record = find_option(name, false, WARNING);
7661 name = record->name;
7663 /* build new item for array */
7664 newval = palloc(strlen(name) + 1 + strlen(value) + 1);
7665 sprintf(newval, "%s=%s", name, value);
7666 datum = CStringGetTextDatum(newval);
7674 Assert(ARR_ELEMTYPE(array) == TEXTOID);
7675 Assert(ARR_NDIM(array) == 1);
7676 Assert(ARR_LBOUND(array)[0] == 1);
7678 index = ARR_DIMS(array)[0] + 1; /* add after end */
7680 for (i = 1; i <= ARR_DIMS(array)[0]; i++)
7685 d = array_ref(array, 1, &i,
7686 -1 /* varlenarray */ ,
7687 -1 /* TEXT's typlen */ ,
7688 false /* TEXT's typbyval */ ,
7689 'i' /* TEXT's typalign */ ,
7693 current = TextDatumGetCString(d);
7695 /* check for match up through and including '=' */
7696 if (strncmp(current, newval, strlen(name) + 1) == 0)
7703 a = array_set(array, 1, &index,
7706 -1 /* varlena array */ ,
7707 -1 /* TEXT's typlen */ ,
7708 false /* TEXT's typbyval */ ,
7709 'i' /* TEXT's typalign */ );
7712 a = construct_array(&datum, 1,
7721 * Delete an entry from an option array. The array parameter may be NULL
7722 * to indicate the current table entry is NULL. Also, if the return value
7723 * is NULL then a null should be stored.
7726 GUCArrayDelete(ArrayType *array, const char *name)
7728 struct config_generic *record;
7729 ArrayType *newarray;
7735 /* test if the option is valid and we're allowed to set it */
7736 (void) validate_option_array_item(name, NULL, false);
7738 /* normalize name (converts obsolete GUC names to modern spellings) */
7739 record = find_option(name, false, WARNING);
7741 name = record->name;
7743 /* if array is currently null, then surely nothing to delete */
7750 for (i = 1; i <= ARR_DIMS(array)[0]; i++)
7756 d = array_ref(array, 1, &i,
7757 -1 /* varlenarray */ ,
7758 -1 /* TEXT's typlen */ ,
7759 false /* TEXT's typbyval */ ,
7760 'i' /* TEXT's typalign */ ,
7764 val = TextDatumGetCString(d);
7766 /* ignore entry if it's what we want to delete */
7767 if (strncmp(val, name, strlen(name)) == 0
7768 && val[strlen(name)] == '=')
7771 /* else add it to the output array */
7773 newarray = array_set(newarray, 1, &index,
7776 -1 /* varlenarray */ ,
7777 -1 /* TEXT's typlen */ ,
7778 false /* TEXT's typbyval */ ,
7779 'i' /* TEXT's typalign */ );
7781 newarray = construct_array(&d, 1,
7793 * Given a GUC array, delete all settings from it that our permission
7794 * level allows: if superuser, delete them all; if regular user, only
7795 * those that are PGC_USERSET
7798 GUCArrayReset(ArrayType *array)
7800 ArrayType *newarray;
7804 /* if array is currently null, nothing to do */
7808 /* if we're superuser, we can delete everything, so just do it */
7815 for (i = 1; i <= ARR_DIMS(array)[0]; i++)
7822 d = array_ref(array, 1, &i,
7823 -1 /* varlenarray */ ,
7824 -1 /* TEXT's typlen */ ,
7825 false /* TEXT's typbyval */ ,
7826 'i' /* TEXT's typalign */ ,
7830 val = TextDatumGetCString(d);
7832 eqsgn = strchr(val, '=');
7835 /* skip if we have permission to delete it */
7836 if (validate_option_array_item(val, NULL, true))
7839 /* else add it to the output array */
7841 newarray = array_set(newarray, 1, &index,
7844 -1 /* varlenarray */ ,
7845 -1 /* TEXT's typlen */ ,
7846 false /* TEXT's typbyval */ ,
7847 'i' /* TEXT's typalign */ );
7849 newarray = construct_array(&d, 1,
7861 * Validate a proposed option setting for GUCArrayAdd/Delete/Reset.
7863 * name is the option name. value is the proposed value for the Add case,
7864 * or NULL for the Delete/Reset cases. If skipIfNoPermissions is true, it's
7865 * not an error to have no permissions to set the option.
7867 * Returns TRUE if OK, FALSE if skipIfNoPermissions is true and user does not
7868 * have permission to change this option (all other error cases result in an
7869 * error being thrown).
7872 validate_option_array_item(const char *name, const char *value,
7873 bool skipIfNoPermissions)
7876 struct config_generic *gconf;
7879 * There are three cases to consider:
7881 * name is a known GUC variable. Check the value normally, check
7882 * permissions normally (ie, allow if variable is USERSET, or if it's
7883 * SUSET and user is superuser).
7885 * name is not known, but exists or can be created as a placeholder
7886 * (implying it has a prefix listed in custom_variable_classes). We allow
7887 * this case if you're a superuser, otherwise not. Superusers are assumed
7888 * to know what they're doing. We can't allow it for other users, because
7889 * when the placeholder is resolved it might turn out to be a SUSET
7890 * variable; define_custom_variable assumes we checked that.
7892 * name is not known and can't be created as a placeholder. Throw error,
7893 * unless skipIfNoPermissions is true, in which case return FALSE. (It's
7894 * tempting to allow this case to superusers, if the name is qualified but
7895 * not listed in custom_variable_classes. That would ease restoring of
7896 * dumps containing ALTER ROLE/DATABASE SET. However, it's not clear that
7897 * this usage justifies such a loss of error checking. You can always fix
7898 * custom_variable_classes before you restore.)
7900 gconf = find_option(name, true, WARNING);
7903 /* not known, failed to make a placeholder */
7904 if (skipIfNoPermissions)
7907 (errcode(ERRCODE_UNDEFINED_OBJECT),
7908 errmsg("unrecognized configuration parameter \"%s\"", name)));
7911 if (gconf->flags & GUC_CUSTOM_PLACEHOLDER)
7914 * We cannot do any meaningful check on the value, so only permissions
7915 * are useful to check.
7919 if (skipIfNoPermissions)
7922 (errcode(ERRCODE_INSUFFICIENT_PRIVILEGE),
7923 errmsg("permission denied to set parameter \"%s\"", name)));
7926 /* manual permissions check so we can avoid an error being thrown */
7927 if (gconf->context == PGC_USERSET)
7929 else if (gconf->context == PGC_SUSET && superuser())
7931 else if (skipIfNoPermissions)
7933 /* if a permissions error should be thrown, let set_config_option do it */
7935 /* test for permissions and valid option value */
7936 set_config_option(name, value,
7937 superuser() ? PGC_SUSET : PGC_USERSET,
7938 PGC_S_TEST, GUC_ACTION_SET, false);
7945 * Called by check_hooks that want to override the normal
7946 * ERRCODE_INVALID_PARAMETER_VALUE SQLSTATE for check hook failures.
7948 * Note that GUC_check_errmsg() etc are just macros that result in a direct
7949 * assignment to the associated variables. That is ugly, but forced by the
7950 * limitations of C's macro mechanisms.
7953 GUC_check_errcode(int sqlerrcode)
7955 GUC_check_errcode_value = sqlerrcode;
7960 * Convenience functions to manage calling a variable's check_hook.
7961 * These mostly take care of the protocol for letting check hooks supply
7962 * portions of the error report on failure.
7966 call_bool_check_hook(struct config_bool * conf, bool *newval, void **extra,
7967 GucSource source, int elevel)
7969 /* Quick success if no hook */
7970 if (!conf->check_hook)
7973 /* Reset variables that might be set by hook */
7974 GUC_check_errcode_value = ERRCODE_INVALID_PARAMETER_VALUE;
7975 GUC_check_errmsg_string = NULL;
7976 GUC_check_errdetail_string = NULL;
7977 GUC_check_errhint_string = NULL;
7979 if (!(*conf->check_hook) (newval, extra, source))
7982 (errcode(GUC_check_errcode_value),
7983 GUC_check_errmsg_string ?
7984 errmsg_internal("%s", GUC_check_errmsg_string) :
7985 errmsg("invalid value for parameter \"%s\": %d",
7986 conf->gen.name, (int) *newval),
7987 GUC_check_errdetail_string ?
7988 errdetail_internal("%s", GUC_check_errdetail_string) : 0,
7989 GUC_check_errhint_string ?
7990 errhint("%s", GUC_check_errhint_string) : 0));
7991 /* Flush any strings created in ErrorContext */
8000 call_int_check_hook(struct config_int * conf, int *newval, void **extra,
8001 GucSource source, int elevel)
8003 /* Quick success if no hook */
8004 if (!conf->check_hook)
8007 /* Reset variables that might be set by hook */
8008 GUC_check_errcode_value = ERRCODE_INVALID_PARAMETER_VALUE;
8009 GUC_check_errmsg_string = NULL;
8010 GUC_check_errdetail_string = NULL;
8011 GUC_check_errhint_string = NULL;
8013 if (!(*conf->check_hook) (newval, extra, source))
8016 (errcode(GUC_check_errcode_value),
8017 GUC_check_errmsg_string ?
8018 errmsg_internal("%s", GUC_check_errmsg_string) :
8019 errmsg("invalid value for parameter \"%s\": %d",
8020 conf->gen.name, *newval),
8021 GUC_check_errdetail_string ?
8022 errdetail_internal("%s", GUC_check_errdetail_string) : 0,
8023 GUC_check_errhint_string ?
8024 errhint("%s", GUC_check_errhint_string) : 0));
8025 /* Flush any strings created in ErrorContext */
8034 call_real_check_hook(struct config_real * conf, double *newval, void **extra,
8035 GucSource source, int elevel)
8037 /* Quick success if no hook */
8038 if (!conf->check_hook)
8041 /* Reset variables that might be set by hook */
8042 GUC_check_errcode_value = ERRCODE_INVALID_PARAMETER_VALUE;
8043 GUC_check_errmsg_string = NULL;
8044 GUC_check_errdetail_string = NULL;
8045 GUC_check_errhint_string = NULL;
8047 if (!(*conf->check_hook) (newval, extra, source))
8050 (errcode(GUC_check_errcode_value),
8051 GUC_check_errmsg_string ?
8052 errmsg_internal("%s", GUC_check_errmsg_string) :
8053 errmsg("invalid value for parameter \"%s\": %g",
8054 conf->gen.name, *newval),
8055 GUC_check_errdetail_string ?
8056 errdetail_internal("%s", GUC_check_errdetail_string) : 0,
8057 GUC_check_errhint_string ?
8058 errhint("%s", GUC_check_errhint_string) : 0));
8059 /* Flush any strings created in ErrorContext */
8068 call_string_check_hook(struct config_string * conf, char **newval, void **extra,
8069 GucSource source, int elevel)
8071 /* Quick success if no hook */
8072 if (!conf->check_hook)
8075 /* Reset variables that might be set by hook */
8076 GUC_check_errcode_value = ERRCODE_INVALID_PARAMETER_VALUE;
8077 GUC_check_errmsg_string = NULL;
8078 GUC_check_errdetail_string = NULL;
8079 GUC_check_errhint_string = NULL;
8081 if (!(*conf->check_hook) (newval, extra, source))
8084 (errcode(GUC_check_errcode_value),
8085 GUC_check_errmsg_string ?
8086 errmsg_internal("%s", GUC_check_errmsg_string) :
8087 errmsg("invalid value for parameter \"%s\": \"%s\"",
8088 conf->gen.name, *newval ? *newval : ""),
8089 GUC_check_errdetail_string ?
8090 errdetail_internal("%s", GUC_check_errdetail_string) : 0,
8091 GUC_check_errhint_string ?
8092 errhint("%s", GUC_check_errhint_string) : 0));
8093 /* Flush any strings created in ErrorContext */
8102 call_enum_check_hook(struct config_enum * conf, int *newval, void **extra,
8103 GucSource source, int elevel)
8105 /* Quick success if no hook */
8106 if (!conf->check_hook)
8109 /* Reset variables that might be set by hook */
8110 GUC_check_errcode_value = ERRCODE_INVALID_PARAMETER_VALUE;
8111 GUC_check_errmsg_string = NULL;
8112 GUC_check_errdetail_string = NULL;
8113 GUC_check_errhint_string = NULL;
8115 if (!(*conf->check_hook) (newval, extra, source))
8118 (errcode(GUC_check_errcode_value),
8119 GUC_check_errmsg_string ?
8120 errmsg_internal("%s", GUC_check_errmsg_string) :
8121 errmsg("invalid value for parameter \"%s\": \"%s\"",
8123 config_enum_lookup_by_value(conf, *newval)),
8124 GUC_check_errdetail_string ?
8125 errdetail_internal("%s", GUC_check_errdetail_string) : 0,
8126 GUC_check_errhint_string ?
8127 errhint("%s", GUC_check_errhint_string) : 0));
8128 /* Flush any strings created in ErrorContext */
8138 * check_hook, assign_hook and show_hook subroutines
8142 check_log_destination(char **newval, void **extra, GucSource source)
8150 /* Need a modifiable copy of string */
8151 rawstring = pstrdup(*newval);
8153 /* Parse string into list of identifiers */
8154 if (!SplitIdentifierString(rawstring, ',', &elemlist))
8156 /* syntax error in list */
8157 GUC_check_errdetail("List syntax is invalid.");
8159 list_free(elemlist);
8163 foreach(l, elemlist)
8165 char *tok = (char *) lfirst(l);
8167 if (pg_strcasecmp(tok, "stderr") == 0)
8168 newlogdest |= LOG_DESTINATION_STDERR;
8169 else if (pg_strcasecmp(tok, "csvlog") == 0)
8170 newlogdest |= LOG_DESTINATION_CSVLOG;
8172 else if (pg_strcasecmp(tok, "syslog") == 0)
8173 newlogdest |= LOG_DESTINATION_SYSLOG;
8176 else if (pg_strcasecmp(tok, "eventlog") == 0)
8177 newlogdest |= LOG_DESTINATION_EVENTLOG;
8181 GUC_check_errdetail("Unrecognized key word: \"%s\".", tok);
8183 list_free(elemlist);
8189 list_free(elemlist);
8191 myextra = (int *) guc_malloc(ERROR, sizeof(int));
8192 *myextra = newlogdest;
8193 *extra = (void *) myextra;
8199 assign_log_destination(const char *newval, void *extra)
8201 Log_destination = *((int *) extra);
8205 assign_syslog_facility(int newval, void *extra)
8208 set_syslog_parameters(syslog_ident_str ? syslog_ident_str : "postgres",
8211 /* Without syslog support, just ignore it */
8215 assign_syslog_ident(const char *newval, void *extra)
8218 set_syslog_parameters(newval, syslog_facility);
8220 /* Without syslog support, it will always be set to "none", so ignore */
8225 assign_session_replication_role(int newval, void *extra)
8228 * Must flush the plan cache when changing replication role; but don't
8229 * flush unnecessarily.
8231 if (SessionReplicationRole != newval)
8236 check_temp_buffers(int *newval, void **extra, GucSource source)
8239 * Once local buffers have been initialized, it's too late to change this.
8241 if (NLocBuffer && NLocBuffer != *newval)
8243 GUC_check_errdetail("\"temp_buffers\" cannot be changed after any temporary tables have been accessed in the session.");
8250 check_phony_autocommit(bool *newval, void **extra, GucSource source)
8254 GUC_check_errcode(ERRCODE_FEATURE_NOT_SUPPORTED);
8255 GUC_check_errmsg("SET AUTOCOMMIT TO OFF is no longer supported");
8262 check_custom_variable_classes(char **newval, void **extra, GucSource source)
8265 * Check syntax. newval must be a comma separated list of identifiers.
8266 * Whitespace is allowed but removed from the result.
8268 bool hasSpaceAfterToken = false;
8269 const char *cp = *newval;
8274 /* Default NULL is OK */
8278 initStringInfo(&buf);
8279 while ((c = *cp++) != '\0')
8281 if (isspace((unsigned char) c))
8284 hasSpaceAfterToken = true;
8290 if (symLen > 0) /* terminate identifier */
8292 appendStringInfoChar(&buf, ',');
8295 hasSpaceAfterToken = false;
8299 if (hasSpaceAfterToken || !(isalnum((unsigned char) c) || c == '_'))
8302 * Syntax error due to token following space after token or
8303 * non-identifier character
8308 appendStringInfoChar(&buf, c);
8312 /* Remove stray ',' at end */
8313 if (symLen == 0 && buf.len > 0)
8314 buf.data[--buf.len] = '\0';
8316 /* GUC wants the result malloc'd */
8318 *newval = guc_strdup(LOG, buf.data);
8325 check_debug_assertions(bool *newval, void **extra, GucSource source)
8327 #ifndef USE_ASSERT_CHECKING
8330 GUC_check_errmsg("assertion checking is not supported by this build");
8338 check_bonjour(bool *newval, void **extra, GucSource source)
8343 GUC_check_errmsg("Bonjour is not supported by this build");
8351 check_ssl(bool *newval, void **extra, GucSource source)
8356 GUC_check_errmsg("SSL is not supported by this build");
8364 check_stage_log_stats(bool *newval, void **extra, GucSource source)
8366 if (*newval && log_statement_stats)
8368 GUC_check_errdetail("Cannot enable parameter when \"log_statement_stats\" is true.");
8375 check_log_stats(bool *newval, void **extra, GucSource source)
8378 (log_parser_stats || log_planner_stats || log_executor_stats))
8380 GUC_check_errdetail("Cannot enable \"log_statement_stats\" when "
8381 "\"log_parser_stats\", \"log_planner_stats\", "
8382 "or \"log_executor_stats\" is true.");
8389 check_canonical_path(char **newval, void **extra, GucSource source)
8392 * Since canonicalize_path never enlarges the string, we can just modify
8393 * newval in-place. But watch out for NULL, which is the default value
8394 * for external_pid_file.
8397 canonicalize_path(*newval);
8402 check_timezone_abbreviations(char **newval, void **extra, GucSource source)
8405 * The boot_val given above for timezone_abbreviations is NULL. When we
8406 * see this we just do nothing. If this value isn't overridden from the
8407 * config file then pg_timezone_abbrev_initialize() will eventually
8408 * replace it with "Default". This hack has two purposes: to avoid
8409 * wasting cycles loading values that might soon be overridden from the
8410 * config file, and to avoid trying to read the timezone abbrev files
8411 * during InitializeGUCOptions(). The latter doesn't work in an
8412 * EXEC_BACKEND subprocess because my_exec_path hasn't been set yet and so
8413 * we can't locate PGSHAREDIR.
8415 if (*newval == NULL)
8417 Assert(source == PGC_S_DEFAULT);
8421 /* OK, load the file and produce a malloc'd TimeZoneAbbrevTable */
8422 *extra = load_tzoffsets(*newval);
8424 /* tzparser.c returns NULL on failure, reporting via GUC_check_errmsg */
8432 assign_timezone_abbreviations(const char *newval, void *extra)
8434 /* Do nothing for the boot_val default of NULL */
8438 InstallTimeZoneAbbrevs((TimeZoneAbbrevTable *) extra);
8442 * pg_timezone_abbrev_initialize --- set default value if not done already
8444 * This is called after initial loading of postgresql.conf. If no
8445 * timezone_abbreviations setting was found therein, select default.
8446 * If a non-default value is already installed, nothing will happen.
8449 pg_timezone_abbrev_initialize(void)
8451 SetConfigOption("timezone_abbreviations", "Default",
8452 PGC_POSTMASTER, PGC_S_DYNAMIC_DEFAULT);
8456 show_archive_command(void)
8458 if (XLogArchivingActive())
8459 return XLogArchiveCommand;
8461 return "(disabled)";
8465 assign_tcp_keepalives_idle(int newval, void *extra)
8468 * The kernel API provides no way to test a value without setting it; and
8469 * once we set it we might fail to unset it. So there seems little point
8470 * in fully implementing the check-then-assign GUC API for these
8471 * variables. Instead we just do the assignment on demand. pqcomm.c
8472 * reports any problems via elog(LOG).
8474 * This approach means that the GUC value might have little to do with the
8475 * actual kernel value, so we use a show_hook that retrieves the kernel
8476 * value rather than trusting GUC's copy.
8478 (void) pq_setkeepalivesidle(newval, MyProcPort);
8482 show_tcp_keepalives_idle(void)
8484 /* See comments in assign_tcp_keepalives_idle */
8485 static char nbuf[16];
8487 snprintf(nbuf, sizeof(nbuf), "%d", pq_getkeepalivesidle(MyProcPort));
8492 assign_tcp_keepalives_interval(int newval, void *extra)
8494 /* See comments in assign_tcp_keepalives_idle */
8495 (void) pq_setkeepalivesinterval(newval, MyProcPort);
8499 show_tcp_keepalives_interval(void)
8501 /* See comments in assign_tcp_keepalives_idle */
8502 static char nbuf[16];
8504 snprintf(nbuf, sizeof(nbuf), "%d", pq_getkeepalivesinterval(MyProcPort));
8509 assign_tcp_keepalives_count(int newval, void *extra)
8511 /* See comments in assign_tcp_keepalives_idle */
8512 (void) pq_setkeepalivescount(newval, MyProcPort);
8516 show_tcp_keepalives_count(void)
8518 /* See comments in assign_tcp_keepalives_idle */
8519 static char nbuf[16];
8521 snprintf(nbuf, sizeof(nbuf), "%d", pq_getkeepalivescount(MyProcPort));
8526 check_maxconnections(int *newval, void **extra, GucSource source)
8528 if (*newval + autovacuum_max_workers + 1 > MAX_BACKENDS)
8534 assign_maxconnections(int newval, void *extra)
8536 MaxBackends = newval + autovacuum_max_workers + 1;
8540 check_autovacuum_max_workers(int *newval, void **extra, GucSource source)
8542 if (MaxConnections + *newval + 1 > MAX_BACKENDS)
8548 assign_autovacuum_max_workers(int newval, void *extra)
8550 MaxBackends = MaxConnections + newval + 1;
8554 check_effective_io_concurrency(int *newval, void **extra, GucSource source)
8557 double new_prefetch_pages = 0.0;
8561 * The user-visible GUC parameter is the number of drives (spindles),
8562 * which we need to translate to a number-of-pages-to-prefetch target.
8563 * The target value is stashed in *extra and then assigned to the actual
8564 * variable by assign_effective_io_concurrency.
8566 * The expected number of prefetch pages needed to keep N drives busy is:
8568 * drives | I/O requests
8569 * -------+----------------
8572 * 3 | 3/1 + 3/2 + 3/3 = 5 1/2
8573 * 4 | 4/1 + 4/2 + 4/3 + 4/4 = 8 1/3
8576 * This is called the "coupon collector problem" and H(n) is called the
8577 * harmonic series. This could be approximated by n * ln(n), but for
8578 * reasonable numbers of drives we might as well just compute the series.
8580 * Alternatively we could set the target to the number of pages necessary
8581 * so that the expected number of active spindles is some arbitrary
8582 * percentage of the total. This sounds the same but is actually slightly
8583 * different. The result ends up being ln(1-P)/ln((n-1)/n) where P is
8584 * that desired fraction.
8586 * Experimental results show that both of these formulas aren't aggressive
8587 * enough, but we don't really have any better proposals.
8589 * Note that if *newval = 0 (disabled), we must set target = 0.
8593 for (i = 1; i <= *newval; i++)
8594 new_prefetch_pages += (double) *newval / (double) i;
8596 /* This range check shouldn't fail, but let's be paranoid */
8597 if (new_prefetch_pages >= 0.0 && new_prefetch_pages < (double) INT_MAX)
8599 int *myextra = (int *) guc_malloc(ERROR, sizeof(int));
8601 *myextra = (int) rint(new_prefetch_pages);
8602 *extra = (void *) myextra;
8610 #endif /* USE_PREFETCH */
8614 assign_effective_io_concurrency(int newval, void *extra)
8617 target_prefetch_pages = *((int *) extra);
8618 #endif /* USE_PREFETCH */
8622 assign_pgstat_temp_directory(const char *newval, void *extra)
8624 /* check_canonical_path already canonicalized newval for us */
8628 tname = guc_malloc(ERROR, strlen(newval) + 12); /* /pgstat.tmp */
8629 sprintf(tname, "%s/pgstat.tmp", newval);
8630 fname = guc_malloc(ERROR, strlen(newval) + 13); /* /pgstat.stat */
8631 sprintf(fname, "%s/pgstat.stat", newval);
8633 if (pgstat_stat_tmpname)
8634 free(pgstat_stat_tmpname);
8635 pgstat_stat_tmpname = tname;
8636 if (pgstat_stat_filename)
8637 free(pgstat_stat_filename);
8638 pgstat_stat_filename = fname;
8642 check_application_name(char **newval, void **extra, GucSource source)
8644 /* Only allow clean ASCII chars in the application name */
8647 for (p = *newval; *p; p++)
8649 if (*p < 32 || *p > 126)
8657 assign_application_name(const char *newval, void *extra)
8659 /* Update the pg_stat_activity view */
8660 pgstat_report_appname(newval);
8664 show_unix_socket_permissions(void)
8668 snprintf(buf, sizeof(buf), "%04o", Unix_socket_permissions);
8673 show_log_file_mode(void)
8677 snprintf(buf, sizeof(buf), "%04o", Log_file_mode);
8681 #include "guc-file.c"