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 void pg_timezone_abbrev_initialize(void);
191 static const char *show_archive_command(void);
192 static void assign_tcp_keepalives_idle(int newval, void *extra);
193 static void assign_tcp_keepalives_interval(int newval, void *extra);
194 static void assign_tcp_keepalives_count(int newval, void *extra);
195 static const char *show_tcp_keepalives_idle(void);
196 static const char *show_tcp_keepalives_interval(void);
197 static const char *show_tcp_keepalives_count(void);
198 static bool check_maxconnections(int *newval, void **extra, GucSource source);
199 static void assign_maxconnections(int newval, void *extra);
200 static bool check_autovacuum_max_workers(int *newval, void **extra, GucSource source);
201 static void assign_autovacuum_max_workers(int newval, void *extra);
202 static bool check_effective_io_concurrency(int *newval, void **extra, GucSource source);
203 static void assign_effective_io_concurrency(int newval, void *extra);
204 static void assign_pgstat_temp_directory(const char *newval, void *extra);
205 static bool check_application_name(char **newval, void **extra, GucSource source);
206 static void assign_application_name(const char *newval, void *extra);
207 static const char *show_unix_socket_permissions(void);
208 static const char *show_log_file_mode(void);
210 static char *config_enum_get_options(struct config_enum * record,
211 const char *prefix, const char *suffix,
212 const char *separator);
216 * Options for enum values defined in this module.
218 * NOTE! Option values may not contain double quotes!
221 static const struct config_enum_entry bytea_output_options[] = {
222 {"escape", BYTEA_OUTPUT_ESCAPE, false},
223 {"hex", BYTEA_OUTPUT_HEX, false},
228 * We have different sets for client and server message level options because
229 * they sort slightly different (see "log" level)
231 static const struct config_enum_entry client_message_level_options[] = {
232 {"debug", DEBUG2, true},
233 {"debug5", DEBUG5, false},
234 {"debug4", DEBUG4, false},
235 {"debug3", DEBUG3, false},
236 {"debug2", DEBUG2, false},
237 {"debug1", DEBUG1, false},
239 {"info", INFO, true},
240 {"notice", NOTICE, false},
241 {"warning", WARNING, false},
242 {"error", ERROR, false},
243 {"fatal", FATAL, true},
244 {"panic", PANIC, true},
248 static const struct config_enum_entry server_message_level_options[] = {
249 {"debug", DEBUG2, true},
250 {"debug5", DEBUG5, false},
251 {"debug4", DEBUG4, false},
252 {"debug3", DEBUG3, false},
253 {"debug2", DEBUG2, false},
254 {"debug1", DEBUG1, false},
255 {"info", INFO, false},
256 {"notice", NOTICE, false},
257 {"warning", WARNING, false},
258 {"error", ERROR, false},
260 {"fatal", FATAL, false},
261 {"panic", PANIC, false},
265 static const struct config_enum_entry intervalstyle_options[] = {
266 {"postgres", INTSTYLE_POSTGRES, false},
267 {"postgres_verbose", INTSTYLE_POSTGRES_VERBOSE, false},
268 {"sql_standard", INTSTYLE_SQL_STANDARD, false},
269 {"iso_8601", INTSTYLE_ISO_8601, false},
273 static const struct config_enum_entry log_error_verbosity_options[] = {
274 {"terse", PGERROR_TERSE, false},
275 {"default", PGERROR_DEFAULT, false},
276 {"verbose", PGERROR_VERBOSE, false},
280 static const struct config_enum_entry log_statement_options[] = {
281 {"none", LOGSTMT_NONE, false},
282 {"ddl", LOGSTMT_DDL, false},
283 {"mod", LOGSTMT_MOD, false},
284 {"all", LOGSTMT_ALL, false},
288 static const struct config_enum_entry isolation_level_options[] = {
289 {"serializable", XACT_SERIALIZABLE, false},
290 {"repeatable read", XACT_REPEATABLE_READ, false},
291 {"read committed", XACT_READ_COMMITTED, false},
292 {"read uncommitted", XACT_READ_UNCOMMITTED, false},
296 static const struct config_enum_entry session_replication_role_options[] = {
297 {"origin", SESSION_REPLICATION_ROLE_ORIGIN, false},
298 {"replica", SESSION_REPLICATION_ROLE_REPLICA, false},
299 {"local", SESSION_REPLICATION_ROLE_LOCAL, false},
303 static const struct config_enum_entry syslog_facility_options[] = {
305 {"local0", LOG_LOCAL0, false},
306 {"local1", LOG_LOCAL1, false},
307 {"local2", LOG_LOCAL2, false},
308 {"local3", LOG_LOCAL3, false},
309 {"local4", LOG_LOCAL4, false},
310 {"local5", LOG_LOCAL5, false},
311 {"local6", LOG_LOCAL6, false},
312 {"local7", LOG_LOCAL7, false},
319 static const struct config_enum_entry track_function_options[] = {
320 {"none", TRACK_FUNC_OFF, false},
321 {"pl", TRACK_FUNC_PL, false},
322 {"all", TRACK_FUNC_ALL, false},
326 static const struct config_enum_entry xmlbinary_options[] = {
327 {"base64", XMLBINARY_BASE64, false},
328 {"hex", XMLBINARY_HEX, false},
332 static const struct config_enum_entry xmloption_options[] = {
333 {"content", XMLOPTION_CONTENT, false},
334 {"document", XMLOPTION_DOCUMENT, false},
339 * Although only "on", "off", and "safe_encoding" are documented, we
340 * accept all the likely variants of "on" and "off".
342 static const struct config_enum_entry backslash_quote_options[] = {
343 {"safe_encoding", BACKSLASH_QUOTE_SAFE_ENCODING, false},
344 {"on", BACKSLASH_QUOTE_ON, false},
345 {"off", BACKSLASH_QUOTE_OFF, false},
346 {"true", BACKSLASH_QUOTE_ON, true},
347 {"false", BACKSLASH_QUOTE_OFF, true},
348 {"yes", BACKSLASH_QUOTE_ON, true},
349 {"no", BACKSLASH_QUOTE_OFF, true},
350 {"1", BACKSLASH_QUOTE_ON, true},
351 {"0", BACKSLASH_QUOTE_OFF, true},
356 * Although only "on", "off", and "partition" are documented, we
357 * accept all the likely variants of "on" and "off".
359 static const struct config_enum_entry constraint_exclusion_options[] = {
360 {"partition", CONSTRAINT_EXCLUSION_PARTITION, false},
361 {"on", CONSTRAINT_EXCLUSION_ON, false},
362 {"off", CONSTRAINT_EXCLUSION_OFF, false},
363 {"true", CONSTRAINT_EXCLUSION_ON, true},
364 {"false", CONSTRAINT_EXCLUSION_OFF, true},
365 {"yes", CONSTRAINT_EXCLUSION_ON, true},
366 {"no", CONSTRAINT_EXCLUSION_OFF, true},
367 {"1", CONSTRAINT_EXCLUSION_ON, true},
368 {"0", CONSTRAINT_EXCLUSION_OFF, true},
373 * Although only "on", "off", and "local" are documented, we
374 * accept all the likely variants of "on" and "off".
376 static const struct config_enum_entry synchronous_commit_options[] = {
377 {"local", SYNCHRONOUS_COMMIT_LOCAL_FLUSH, false},
378 {"on", SYNCHRONOUS_COMMIT_ON, false},
379 {"off", SYNCHRONOUS_COMMIT_OFF, false},
380 {"true", SYNCHRONOUS_COMMIT_ON, true},
381 {"false", SYNCHRONOUS_COMMIT_OFF, true},
382 {"yes", SYNCHRONOUS_COMMIT_ON, true},
383 {"no", SYNCHRONOUS_COMMIT_OFF, true},
384 {"1", SYNCHRONOUS_COMMIT_ON, true},
385 {"0", SYNCHRONOUS_COMMIT_OFF, true},
390 * Options for enum values stored in other modules
392 extern const struct config_enum_entry wal_level_options[];
393 extern const struct config_enum_entry sync_method_options[];
396 * GUC option variables that are exported from this module
398 #ifdef USE_ASSERT_CHECKING
399 bool assert_enabled = true;
401 bool assert_enabled = false;
403 bool log_duration = false;
404 bool Debug_print_plan = false;
405 bool Debug_print_parse = false;
406 bool Debug_print_rewritten = false;
407 bool Debug_pretty_print = true;
409 bool log_parser_stats = false;
410 bool log_planner_stats = false;
411 bool log_executor_stats = false;
412 bool log_statement_stats = false; /* this is sort of all three
414 bool log_btree_build_stats = false;
416 bool check_function_bodies = true;
417 bool default_with_oids = false;
418 bool SQL_inheritance = true;
420 bool Password_encryption = true;
422 int log_min_error_statement = ERROR;
423 int log_min_messages = WARNING;
424 int client_min_messages = NOTICE;
425 int log_min_duration_statement = -1;
426 int log_temp_files = -1;
427 int trace_recovery_messages = LOG;
429 int temp_file_limit = -1;
431 int num_temp_buffers = 1024;
433 char *data_directory;
434 char *ConfigFileName;
437 char *external_pid_file;
439 char *pgstat_temp_directory;
441 char *application_name;
443 int tcp_keepalives_idle;
444 int tcp_keepalives_interval;
445 int tcp_keepalives_count;
448 * These variables are all dummies that don't do anything, except in some
449 * cases provide the value for SHOW to display. The real state is elsewhere
450 * and is kept in sync by assign_hooks.
452 static char *log_destination_string;
454 static char *syslog_ident_str;
455 static bool phony_autocommit;
456 static bool session_auth_is_superuser;
457 static double phony_random_seed;
458 static char *client_encoding_string;
459 static char *datestyle_string;
460 static char *locale_collate;
461 static char *locale_ctype;
462 static char *server_encoding_string;
463 static char *server_version_string;
464 static int server_version_num;
465 static char *timezone_string;
466 static char *log_timezone_string;
467 static char *timezone_abbreviations_string;
468 static char *XactIsoLevel_string;
469 static char *session_authorization_string;
470 static char *custom_variable_classes;
471 static int max_function_args;
472 static int max_index_keys;
473 static int max_identifier_length;
474 static int block_size;
475 static int segment_size;
476 static int wal_block_size;
477 static int wal_segment_size;
478 static bool integer_datetimes;
479 static int effective_io_concurrency;
481 /* should be static, but commands/variable.c needs to get at this */
486 * Displayable names for context types (enum GucContext)
488 * Note: these strings are deliberately not localized.
490 const char *const GucContext_Names[] =
492 /* PGC_INTERNAL */ "internal",
493 /* PGC_POSTMASTER */ "postmaster",
494 /* PGC_SIGHUP */ "sighup",
495 /* PGC_BACKEND */ "backend",
496 /* PGC_SUSET */ "superuser",
497 /* PGC_USERSET */ "user"
501 * Displayable names for source types (enum GucSource)
503 * Note: these strings are deliberately not localized.
505 const char *const GucSource_Names[] =
507 /* PGC_S_DEFAULT */ "default",
508 /* PGC_S_DYNAMIC_DEFAULT */ "default",
509 /* PGC_S_ENV_VAR */ "environment variable",
510 /* PGC_S_FILE */ "configuration file",
511 /* PGC_S_ARGV */ "command line",
512 /* PGC_S_DATABASE */ "database",
513 /* PGC_S_USER */ "user",
514 /* PGC_S_DATABASE_USER */ "database user",
515 /* PGC_S_CLIENT */ "client",
516 /* PGC_S_OVERRIDE */ "override",
517 /* PGC_S_INTERACTIVE */ "interactive",
518 /* PGC_S_TEST */ "test",
519 /* PGC_S_SESSION */ "session"
523 * Displayable names for the groupings defined in enum config_group
525 const char *const config_group_names[] =
528 gettext_noop("Ungrouped"),
530 gettext_noop("File Locations"),
532 gettext_noop("Connections and Authentication"),
533 /* CONN_AUTH_SETTINGS */
534 gettext_noop("Connections and Authentication / Connection Settings"),
535 /* CONN_AUTH_SECURITY */
536 gettext_noop("Connections and Authentication / Security and Authentication"),
538 gettext_noop("Resource Usage"),
540 gettext_noop("Resource Usage / Memory"),
542 gettext_noop("Resource Usage / Disk"),
543 /* RESOURCES_KERNEL */
544 gettext_noop("Resource Usage / Kernel Resources"),
545 /* RESOURCES_VACUUM_DELAY */
546 gettext_noop("Resource Usage / Cost-Based Vacuum Delay"),
547 /* RESOURCES_BGWRITER */
548 gettext_noop("Resource Usage / Background Writer"),
549 /* RESOURCES_ASYNCHRONOUS */
550 gettext_noop("Resource Usage / Asynchronous Behavior"),
552 gettext_noop("Write-Ahead Log"),
554 gettext_noop("Write-Ahead Log / Settings"),
555 /* WAL_CHECKPOINTS */
556 gettext_noop("Write-Ahead Log / Checkpoints"),
558 gettext_noop("Write-Ahead Log / Archiving"),
560 gettext_noop("Replication"),
561 /* REPLICATION_SENDING */
562 gettext_noop("Replication / Sending Servers"),
563 /* REPLICATION_MASTER */
564 gettext_noop("Replication / Master Server"),
565 /* REPLICATION_STANDBY */
566 gettext_noop("Replication / Standby Servers"),
568 gettext_noop("Query Tuning"),
569 /* QUERY_TUNING_METHOD */
570 gettext_noop("Query Tuning / Planner Method Configuration"),
571 /* QUERY_TUNING_COST */
572 gettext_noop("Query Tuning / Planner Cost Constants"),
573 /* QUERY_TUNING_GEQO */
574 gettext_noop("Query Tuning / Genetic Query Optimizer"),
575 /* QUERY_TUNING_OTHER */
576 gettext_noop("Query Tuning / Other Planner Options"),
578 gettext_noop("Reporting and Logging"),
580 gettext_noop("Reporting and Logging / Where to Log"),
582 gettext_noop("Reporting and Logging / When to Log"),
584 gettext_noop("Reporting and Logging / What to Log"),
586 gettext_noop("Statistics"),
587 /* STATS_MONITORING */
588 gettext_noop("Statistics / Monitoring"),
589 /* STATS_COLLECTOR */
590 gettext_noop("Statistics / Query and Index Statistics Collector"),
592 gettext_noop("Autovacuum"),
594 gettext_noop("Client Connection Defaults"),
595 /* CLIENT_CONN_STATEMENT */
596 gettext_noop("Client Connection Defaults / Statement Behavior"),
597 /* CLIENT_CONN_LOCALE */
598 gettext_noop("Client Connection Defaults / Locale and Formatting"),
599 /* CLIENT_CONN_OTHER */
600 gettext_noop("Client Connection Defaults / Other Defaults"),
601 /* LOCK_MANAGEMENT */
602 gettext_noop("Lock Management"),
604 gettext_noop("Version and Platform Compatibility"),
605 /* COMPAT_OPTIONS_PREVIOUS */
606 gettext_noop("Version and Platform Compatibility / Previous PostgreSQL Versions"),
607 /* COMPAT_OPTIONS_CLIENT */
608 gettext_noop("Version and Platform Compatibility / Other Platforms and Clients"),
610 gettext_noop("Error Handling"),
612 gettext_noop("Preset Options"),
614 gettext_noop("Customized Options"),
615 /* DEVELOPER_OPTIONS */
616 gettext_noop("Developer Options"),
617 /* help_config wants this array to be null-terminated */
622 * Displayable names for GUC variable types (enum config_type)
624 * Note: these strings are deliberately not localized.
626 const char *const config_type_names[] =
628 /* PGC_BOOL */ "bool",
629 /* PGC_INT */ "integer",
630 /* PGC_REAL */ "real",
631 /* PGC_STRING */ "string",
632 /* PGC_ENUM */ "enum"
637 * Contents of GUC tables
639 * See src/backend/utils/misc/README for design notes.
643 * 1. Declare a global variable of type bool, int, double, or char*
644 * and make use of it.
646 * 2. Decide at what times it's safe to set the option. See guc.h for
649 * 3. Decide on a name, a default value, upper and lower bounds (if
652 * 4. Add a record below.
654 * 5. Add it to src/backend/utils/misc/postgresql.conf.sample, if
657 * 6. Don't forget to document the option (at least in config.sgml).
659 * 7. If it's a new GUC_LIST option you must edit pg_dumpall.c to ensure
660 * it is not single quoted at dump time.
664 /******** option records follow ********/
666 static struct config_bool ConfigureNamesBool[] =
669 {"enable_seqscan", PGC_USERSET, QUERY_TUNING_METHOD,
670 gettext_noop("Enables the planner's use of sequential-scan plans."),
678 {"enable_indexscan", PGC_USERSET, QUERY_TUNING_METHOD,
679 gettext_noop("Enables the planner's use of index-scan plans."),
687 {"enable_bitmapscan", PGC_USERSET, QUERY_TUNING_METHOD,
688 gettext_noop("Enables the planner's use of bitmap-scan plans."),
696 {"enable_tidscan", PGC_USERSET, QUERY_TUNING_METHOD,
697 gettext_noop("Enables the planner's use of TID scan plans."),
705 {"enable_sort", PGC_USERSET, QUERY_TUNING_METHOD,
706 gettext_noop("Enables the planner's use of explicit sort steps."),
714 {"enable_hashagg", PGC_USERSET, QUERY_TUNING_METHOD,
715 gettext_noop("Enables the planner's use of hashed aggregation plans."),
723 {"enable_material", PGC_USERSET, QUERY_TUNING_METHOD,
724 gettext_noop("Enables the planner's use of materialization."),
732 {"enable_nestloop", PGC_USERSET, QUERY_TUNING_METHOD,
733 gettext_noop("Enables the planner's use of nested-loop join plans."),
741 {"enable_mergejoin", PGC_USERSET, QUERY_TUNING_METHOD,
742 gettext_noop("Enables the planner's use of merge join plans."),
750 {"enable_hashjoin", PGC_USERSET, QUERY_TUNING_METHOD,
751 gettext_noop("Enables the planner's use of hash join plans."),
759 {"geqo", PGC_USERSET, QUERY_TUNING_GEQO,
760 gettext_noop("Enables genetic query optimization."),
761 gettext_noop("This algorithm attempts to do planning without "
762 "exhaustive searching.")
769 /* Not for general use --- used by SET SESSION AUTHORIZATION */
770 {"is_superuser", PGC_INTERNAL, UNGROUPED,
771 gettext_noop("Shows whether the current user is a superuser."),
773 GUC_REPORT | GUC_NO_SHOW_ALL | GUC_NO_RESET_ALL | GUC_NOT_IN_SAMPLE | GUC_DISALLOW_IN_FILE
775 &session_auth_is_superuser,
780 {"bonjour", PGC_POSTMASTER, CONN_AUTH_SETTINGS,
781 gettext_noop("Enables advertising the server via Bonjour."),
786 check_bonjour, NULL, NULL
789 {"ssl", PGC_POSTMASTER, CONN_AUTH_SECURITY,
790 gettext_noop("Enables SSL connections."),
795 check_ssl, NULL, NULL
798 {"fsync", PGC_SIGHUP, WAL_SETTINGS,
799 gettext_noop("Forces synchronization of updates to disk."),
800 gettext_noop("The server will use the fsync() system call in several places to make "
801 "sure that updates are physically written to disk. This insures "
802 "that a database cluster will recover to a consistent state after "
803 "an operating system or hardware crash.")
810 {"zero_damaged_pages", PGC_SUSET, DEVELOPER_OPTIONS,
811 gettext_noop("Continues processing past damaged page headers."),
812 gettext_noop("Detection of a damaged page header normally causes PostgreSQL to "
813 "report an error, aborting the current transaction. Setting "
814 "zero_damaged_pages to true causes the system to instead report a "
815 "warning, zero out the damaged page, and continue processing. This "
816 "behavior will destroy data, namely all the rows on the damaged page."),
824 {"full_page_writes", PGC_SIGHUP, WAL_SETTINGS,
825 gettext_noop("Writes full pages to WAL when first modified after a checkpoint."),
826 gettext_noop("A page write in process during an operating system crash might be "
827 "only partially written to disk. During recovery, the row changes "
828 "stored in WAL are not enough to recover. This option writes "
829 "pages when first modified after a checkpoint to WAL so full recovery "
837 {"log_checkpoints", PGC_SIGHUP, LOGGING_WHAT,
838 gettext_noop("Logs each checkpoint."),
846 {"log_connections", PGC_BACKEND, LOGGING_WHAT,
847 gettext_noop("Logs each successful connection."),
855 {"log_disconnections", PGC_BACKEND, LOGGING_WHAT,
856 gettext_noop("Logs end of a session, including duration."),
864 {"debug_assertions", PGC_USERSET, DEVELOPER_OPTIONS,
865 gettext_noop("Turns on various assertion checks."),
866 gettext_noop("This is a debugging aid."),
870 #ifdef USE_ASSERT_CHECKING
875 check_debug_assertions, NULL, NULL
879 {"exit_on_error", PGC_USERSET, ERROR_HANDLING_OPTIONS,
880 gettext_noop("Terminate session on any error."),
888 {"restart_after_crash", PGC_SIGHUP, ERROR_HANDLING_OPTIONS,
889 gettext_noop("Reinitialize server after backend crash."),
892 &restart_after_crash,
898 {"log_duration", PGC_SUSET, LOGGING_WHAT,
899 gettext_noop("Logs the duration of each completed SQL statement."),
907 {"debug_print_parse", PGC_USERSET, LOGGING_WHAT,
908 gettext_noop("Logs each query's parse tree."),
916 {"debug_print_rewritten", PGC_USERSET, LOGGING_WHAT,
917 gettext_noop("Logs each query's rewritten parse tree."),
920 &Debug_print_rewritten,
925 {"debug_print_plan", PGC_USERSET, LOGGING_WHAT,
926 gettext_noop("Logs each query's execution plan."),
934 {"debug_pretty_print", PGC_USERSET, LOGGING_WHAT,
935 gettext_noop("Indents parse and plan tree displays."),
943 {"log_parser_stats", PGC_SUSET, STATS_MONITORING,
944 gettext_noop("Writes parser performance statistics to the server log."),
949 check_stage_log_stats, NULL, NULL
952 {"log_planner_stats", PGC_SUSET, STATS_MONITORING,
953 gettext_noop("Writes planner performance statistics to the server log."),
958 check_stage_log_stats, NULL, NULL
961 {"log_executor_stats", PGC_SUSET, STATS_MONITORING,
962 gettext_noop("Writes executor performance statistics to the server log."),
967 check_stage_log_stats, NULL, NULL
970 {"log_statement_stats", PGC_SUSET, STATS_MONITORING,
971 gettext_noop("Writes cumulative performance statistics to the server log."),
974 &log_statement_stats,
976 check_log_stats, NULL, NULL
978 #ifdef BTREE_BUILD_STATS
980 {"log_btree_build_stats", PGC_SUSET, DEVELOPER_OPTIONS,
981 gettext_noop("No description available."),
985 &log_btree_build_stats,
992 {"track_activities", PGC_SUSET, STATS_COLLECTOR,
993 gettext_noop("Collects information about executing commands."),
994 gettext_noop("Enables the collection of information on the currently "
995 "executing command of each session, along with "
996 "the time at which that command began execution.")
998 &pgstat_track_activities,
1003 {"track_counts", PGC_SUSET, STATS_COLLECTOR,
1004 gettext_noop("Collects statistics on database activity."),
1007 &pgstat_track_counts,
1013 {"update_process_title", PGC_SUSET, STATS_COLLECTOR,
1014 gettext_noop("Updates the process title to show the active SQL command."),
1015 gettext_noop("Enables updating of the process title every time a new SQL command is received by the server.")
1017 &update_process_title,
1023 {"autovacuum", PGC_SIGHUP, AUTOVACUUM,
1024 gettext_noop("Starts the autovacuum subprocess."),
1027 &autovacuum_start_daemon,
1033 {"trace_notify", PGC_USERSET, DEVELOPER_OPTIONS,
1034 gettext_noop("Generates debugging output for LISTEN and NOTIFY."),
1045 {"trace_locks", PGC_SUSET, DEVELOPER_OPTIONS,
1046 gettext_noop("No description available."),
1055 {"trace_userlocks", PGC_SUSET, DEVELOPER_OPTIONS,
1056 gettext_noop("No description available."),
1065 {"trace_lwlocks", PGC_SUSET, DEVELOPER_OPTIONS,
1066 gettext_noop("No description available."),
1075 {"debug_deadlocks", PGC_SUSET, DEVELOPER_OPTIONS,
1076 gettext_noop("No description available."),
1087 {"log_lock_waits", PGC_SUSET, LOGGING_WHAT,
1088 gettext_noop("Logs long lock waits."),
1097 {"log_hostname", PGC_SIGHUP, LOGGING_WHAT,
1098 gettext_noop("Logs the host name in the connection logs."),
1099 gettext_noop("By default, connection logs only show the IP address "
1100 "of the connecting host. If you want them to show the host name you "
1101 "can turn this on, but depending on your host name resolution "
1102 "setup it might impose a non-negligible performance penalty.")
1109 {"sql_inheritance", PGC_USERSET, COMPAT_OPTIONS_PREVIOUS,
1110 gettext_noop("Causes subtables to be included by default in various commands."),
1118 {"password_encryption", PGC_USERSET, CONN_AUTH_SECURITY,
1119 gettext_noop("Encrypt passwords."),
1120 gettext_noop("When a password is specified in CREATE USER or "
1121 "ALTER USER without writing either ENCRYPTED or UNENCRYPTED, "
1122 "this parameter determines whether the password is to be encrypted.")
1124 &Password_encryption,
1129 {"transform_null_equals", PGC_USERSET, COMPAT_OPTIONS_CLIENT,
1130 gettext_noop("Treats \"expr=NULL\" as \"expr IS NULL\"."),
1131 gettext_noop("When turned on, expressions of the form expr = NULL "
1132 "(or NULL = expr) are treated as expr IS NULL, that is, they "
1133 "return true if expr evaluates to the null value, and false "
1134 "otherwise. The correct behavior of expr = NULL is to always "
1135 "return null (unknown).")
1137 &Transform_null_equals,
1142 {"db_user_namespace", PGC_SIGHUP, CONN_AUTH_SECURITY,
1143 gettext_noop("Enables per-database user names."),
1151 /* only here for backwards compatibility */
1152 {"autocommit", PGC_USERSET, CLIENT_CONN_STATEMENT,
1153 gettext_noop("This parameter doesn't do anything."),
1154 gettext_noop("It's just here so that we won't choke on SET AUTOCOMMIT TO ON from 7.3-vintage clients."),
1155 GUC_NO_SHOW_ALL | GUC_NOT_IN_SAMPLE
1159 check_phony_autocommit, NULL, NULL
1162 {"default_transaction_read_only", PGC_USERSET, CLIENT_CONN_STATEMENT,
1163 gettext_noop("Sets the default read-only status of new transactions."),
1166 &DefaultXactReadOnly,
1171 {"transaction_read_only", PGC_USERSET, CLIENT_CONN_STATEMENT,
1172 gettext_noop("Sets the current transaction's read-only status."),
1174 GUC_NO_RESET_ALL | GUC_NOT_IN_SAMPLE | GUC_DISALLOW_IN_FILE
1178 check_transaction_read_only, NULL, NULL
1181 {"default_transaction_deferrable", PGC_USERSET, CLIENT_CONN_STATEMENT,
1182 gettext_noop("Sets the default deferrable status of new transactions."),
1185 &DefaultXactDeferrable,
1190 {"transaction_deferrable", PGC_USERSET, CLIENT_CONN_STATEMENT,
1191 gettext_noop("Whether to defer a read-only serializable transaction until it can be executed with no possible serialization failures."),
1193 GUC_NO_RESET_ALL | GUC_NOT_IN_SAMPLE | GUC_DISALLOW_IN_FILE
1197 check_transaction_deferrable, NULL, NULL
1200 {"check_function_bodies", PGC_USERSET, CLIENT_CONN_STATEMENT,
1201 gettext_noop("Check function bodies during CREATE FUNCTION."),
1204 &check_function_bodies,
1209 {"array_nulls", PGC_USERSET, COMPAT_OPTIONS_PREVIOUS,
1210 gettext_noop("Enable input of NULL elements in arrays."),
1211 gettext_noop("When turned on, unquoted NULL in an array input "
1212 "value means a null value; "
1213 "otherwise it is taken literally.")
1220 {"default_with_oids", PGC_USERSET, COMPAT_OPTIONS_PREVIOUS,
1221 gettext_noop("Create new tables with OIDs by default."),
1229 {"logging_collector", PGC_POSTMASTER, LOGGING_WHERE,
1230 gettext_noop("Start a subprocess to capture stderr output and/or csvlogs into log files."),
1238 {"log_truncate_on_rotation", PGC_SIGHUP, LOGGING_WHERE,
1239 gettext_noop("Truncate existing log files of same name during log rotation."),
1242 &Log_truncate_on_rotation,
1249 {"trace_sort", PGC_USERSET, DEVELOPER_OPTIONS,
1250 gettext_noop("Emit information about resource usage in sorting."),
1260 #ifdef TRACE_SYNCSCAN
1261 /* this is undocumented because not exposed in a standard build */
1263 {"trace_syncscan", PGC_USERSET, DEVELOPER_OPTIONS,
1264 gettext_noop("Generate debugging output for synchronized scanning."),
1274 #ifdef DEBUG_BOUNDED_SORT
1275 /* this is undocumented because not exposed in a standard build */
1278 "optimize_bounded_sort", PGC_USERSET, QUERY_TUNING_METHOD,
1279 gettext_noop("Enable bounded sorting using heap sort."),
1283 &optimize_bounded_sort,
1291 {"wal_debug", PGC_SUSET, DEVELOPER_OPTIONS,
1292 gettext_noop("Emit WAL-related debugging output."),
1303 {"integer_datetimes", PGC_INTERNAL, PRESET_OPTIONS,
1304 gettext_noop("Datetimes are integer based."),
1306 GUC_REPORT | GUC_NOT_IN_SAMPLE | GUC_DISALLOW_IN_FILE
1309 #ifdef HAVE_INT64_TIMESTAMP
1318 {"krb_caseins_users", PGC_SIGHUP, CONN_AUTH_SECURITY,
1319 gettext_noop("Sets whether Kerberos and GSSAPI user names should be treated as case-insensitive."),
1322 &pg_krb_caseins_users,
1328 {"escape_string_warning", PGC_USERSET, COMPAT_OPTIONS_PREVIOUS,
1329 gettext_noop("Warn about backslash escapes in ordinary string literals."),
1332 &escape_string_warning,
1338 {"standard_conforming_strings", PGC_USERSET, COMPAT_OPTIONS_PREVIOUS,
1339 gettext_noop("Causes '...' strings to treat backslashes literally."),
1343 &standard_conforming_strings,
1349 {"synchronize_seqscans", PGC_USERSET, COMPAT_OPTIONS_PREVIOUS,
1350 gettext_noop("Enable synchronized sequential scans."),
1353 &synchronize_seqscans,
1359 {"archive_mode", PGC_POSTMASTER, WAL_ARCHIVING,
1360 gettext_noop("Allows archiving of WAL files using archive_command."),
1369 {"hot_standby", PGC_POSTMASTER, REPLICATION_STANDBY,
1370 gettext_noop("Allows connections and queries during recovery."),
1379 {"hot_standby_feedback", PGC_SIGHUP, REPLICATION_STANDBY,
1380 gettext_noop("Allows feedback from a hot standby to the primary that will avoid query conflicts."),
1383 &hot_standby_feedback,
1389 {"allow_system_table_mods", PGC_POSTMASTER, DEVELOPER_OPTIONS,
1390 gettext_noop("Allows modifications of the structure of system tables."),
1394 &allowSystemTableMods,
1400 {"ignore_system_indexes", PGC_BACKEND, DEVELOPER_OPTIONS,
1401 gettext_noop("Disables reading from system indexes."),
1402 gettext_noop("It does not prevent updating the indexes, so it is safe "
1403 "to use. The worst consequence is slowness."),
1406 &IgnoreSystemIndexes,
1412 {"lo_compat_privileges", PGC_SUSET, COMPAT_OPTIONS_PREVIOUS,
1413 gettext_noop("Enables backward compatibility mode for privilege checks on large objects."),
1414 gettext_noop("Skips privilege checks when reading or modifying large objects, "
1415 "for compatibility with PostgreSQL releases prior to 9.0.")
1417 &lo_compat_privileges,
1423 {"quote_all_identifiers", PGC_USERSET, COMPAT_OPTIONS_PREVIOUS,
1424 gettext_noop("When generating SQL fragments, quote all identifiers."),
1427 "e_all_identifiers,
1432 /* End-of-list marker */
1434 {NULL, 0, 0, NULL, NULL}, NULL, false, NULL, NULL, NULL
1439 static struct config_int ConfigureNamesInt[] =
1442 {"archive_timeout", PGC_SIGHUP, WAL_ARCHIVING,
1443 gettext_noop("Forces a switch to the next xlog file if a "
1444 "new file has not been started within N seconds."),
1448 &XLogArchiveTimeout,
1453 {"post_auth_delay", PGC_BACKEND, DEVELOPER_OPTIONS,
1454 gettext_noop("Waits N seconds on connection startup after authentication."),
1455 gettext_noop("This allows attaching a debugger to the process."),
1456 GUC_NOT_IN_SAMPLE | GUC_UNIT_S
1463 {"default_statistics_target", PGC_USERSET, QUERY_TUNING_OTHER,
1464 gettext_noop("Sets the default statistics target."),
1465 gettext_noop("This applies to table columns that have not had a "
1466 "column-specific target set via ALTER TABLE SET STATISTICS.")
1468 &default_statistics_target,
1473 {"from_collapse_limit", PGC_USERSET, QUERY_TUNING_OTHER,
1474 gettext_noop("Sets the FROM-list size beyond which subqueries "
1475 "are not collapsed."),
1476 gettext_noop("The planner will merge subqueries into upper "
1477 "queries if the resulting FROM list would have no more than "
1480 &from_collapse_limit,
1485 {"join_collapse_limit", PGC_USERSET, QUERY_TUNING_OTHER,
1486 gettext_noop("Sets the FROM-list size beyond which JOIN "
1487 "constructs are not flattened."),
1488 gettext_noop("The planner will flatten explicit JOIN "
1489 "constructs into lists of FROM items whenever a "
1490 "list of no more than this many items would result.")
1492 &join_collapse_limit,
1497 {"geqo_threshold", PGC_USERSET, QUERY_TUNING_GEQO,
1498 gettext_noop("Sets the threshold of FROM items beyond which GEQO is used."),
1506 {"geqo_effort", PGC_USERSET, QUERY_TUNING_GEQO,
1507 gettext_noop("GEQO: effort is used to set the default for other GEQO parameters."),
1511 DEFAULT_GEQO_EFFORT, MIN_GEQO_EFFORT, MAX_GEQO_EFFORT,
1515 {"geqo_pool_size", PGC_USERSET, QUERY_TUNING_GEQO,
1516 gettext_noop("GEQO: number of individuals in the population."),
1517 gettext_noop("Zero selects a suitable default value.")
1524 {"geqo_generations", PGC_USERSET, QUERY_TUNING_GEQO,
1525 gettext_noop("GEQO: number of iterations of the algorithm."),
1526 gettext_noop("Zero selects a suitable default value.")
1534 /* This is PGC_SUSET to prevent hiding from log_lock_waits. */
1535 {"deadlock_timeout", PGC_SUSET, LOCK_MANAGEMENT,
1536 gettext_noop("Sets the time to wait on a lock before checking for deadlock."),
1546 {"max_standby_archive_delay", PGC_SIGHUP, REPLICATION_STANDBY,
1547 gettext_noop("Sets the maximum delay before canceling queries when a hot standby server is processing archived WAL data."),
1551 &max_standby_archive_delay,
1552 30 * 1000, -1, INT_MAX,
1557 {"max_standby_streaming_delay", PGC_SIGHUP, REPLICATION_STANDBY,
1558 gettext_noop("Sets the maximum delay before canceling queries when a hot standby server is processing streamed WAL data."),
1562 &max_standby_streaming_delay,
1563 30 * 1000, -1, INT_MAX,
1568 {"wal_receiver_status_interval", PGC_SIGHUP, REPLICATION_STANDBY,
1569 gettext_noop("Sets the maximum interval between WAL receiver status reports to the primary."),
1573 &wal_receiver_status_interval,
1574 10, 0, INT_MAX / 1000,
1579 {"max_connections", PGC_POSTMASTER, CONN_AUTH_SETTINGS,
1580 gettext_noop("Sets the maximum number of concurrent connections."),
1584 100, 1, MAX_BACKENDS,
1585 check_maxconnections, assign_maxconnections, NULL
1589 {"superuser_reserved_connections", PGC_POSTMASTER, CONN_AUTH_SETTINGS,
1590 gettext_noop("Sets the number of connection slots reserved for superusers."),
1599 * We sometimes multiply the number of shared buffers by two without
1600 * checking for overflow, so we mustn't allow more than INT_MAX / 2.
1603 {"shared_buffers", PGC_POSTMASTER, RESOURCES_MEM,
1604 gettext_noop("Sets the number of shared memory buffers used by the server."),
1609 1024, 16, INT_MAX / 2,
1614 {"temp_buffers", PGC_USERSET, RESOURCES_MEM,
1615 gettext_noop("Sets the maximum number of temporary buffers used by each session."),
1620 1024, 100, INT_MAX / 2,
1621 check_temp_buffers, NULL, NULL
1625 {"port", PGC_POSTMASTER, CONN_AUTH_SETTINGS,
1626 gettext_noop("Sets the TCP port the server listens on."),
1630 DEF_PGPORT, 1, 65535,
1635 {"unix_socket_permissions", PGC_POSTMASTER, CONN_AUTH_SETTINGS,
1636 gettext_noop("Sets the access permissions of the Unix-domain socket."),
1637 gettext_noop("Unix-domain sockets use the usual Unix file system "
1638 "permission set. The parameter value is expected "
1639 "to be a numeric mode specification in the form "
1640 "accepted by the chmod and umask system calls. "
1641 "(To use the customary octal format the number must "
1642 "start with a 0 (zero).)")
1644 &Unix_socket_permissions,
1646 NULL, NULL, show_unix_socket_permissions
1650 {"log_file_mode", PGC_SIGHUP, LOGGING_WHERE,
1651 gettext_noop("Sets the file permissions for log files."),
1652 gettext_noop("The parameter value is expected "
1653 "to be a numeric mode specification in the form "
1654 "accepted by the chmod and umask system calls. "
1655 "(To use the customary octal format the number must "
1656 "start with a 0 (zero).)")
1660 NULL, NULL, show_log_file_mode
1664 {"work_mem", PGC_USERSET, RESOURCES_MEM,
1665 gettext_noop("Sets the maximum memory to be used for query workspaces."),
1666 gettext_noop("This much memory can be used by each internal "
1667 "sort operation and hash table before switching to "
1668 "temporary disk files."),
1672 1024, 64, MAX_KILOBYTES,
1677 {"maintenance_work_mem", PGC_USERSET, RESOURCES_MEM,
1678 gettext_noop("Sets the maximum memory to be used for maintenance operations."),
1679 gettext_noop("This includes operations such as VACUUM and CREATE INDEX."),
1682 &maintenance_work_mem,
1683 16384, 1024, MAX_KILOBYTES,
1688 * We use the hopefully-safely-small value of 100kB as the compiled-in
1689 * default for max_stack_depth. InitializeGUCOptions will increase it if
1690 * possible, depending on the actual platform-specific stack limit.
1693 {"max_stack_depth", PGC_SUSET, RESOURCES_MEM,
1694 gettext_noop("Sets the maximum stack depth, in kilobytes."),
1699 100, 100, MAX_KILOBYTES,
1700 check_max_stack_depth, assign_max_stack_depth, NULL
1704 {"temp_file_limit", PGC_SUSET, RESOURCES_DISK,
1705 gettext_noop("Limits the total size of all temp files used by each session."),
1706 gettext_noop("-1 means no limit."),
1715 {"vacuum_cost_page_hit", PGC_USERSET, RESOURCES_VACUUM_DELAY,
1716 gettext_noop("Vacuum cost for a page found in the buffer cache."),
1725 {"vacuum_cost_page_miss", PGC_USERSET, RESOURCES_VACUUM_DELAY,
1726 gettext_noop("Vacuum cost for a page not found in the buffer cache."),
1729 &VacuumCostPageMiss,
1735 {"vacuum_cost_page_dirty", PGC_USERSET, RESOURCES_VACUUM_DELAY,
1736 gettext_noop("Vacuum cost for a page dirtied by vacuum."),
1739 &VacuumCostPageDirty,
1745 {"vacuum_cost_limit", PGC_USERSET, RESOURCES_VACUUM_DELAY,
1746 gettext_noop("Vacuum cost amount available before napping."),
1755 {"vacuum_cost_delay", PGC_USERSET, RESOURCES_VACUUM_DELAY,
1756 gettext_noop("Vacuum cost delay in milliseconds."),
1766 {"autovacuum_vacuum_cost_delay", PGC_SIGHUP, AUTOVACUUM,
1767 gettext_noop("Vacuum cost delay in milliseconds, for autovacuum."),
1771 &autovacuum_vac_cost_delay,
1777 {"autovacuum_vacuum_cost_limit", PGC_SIGHUP, AUTOVACUUM,
1778 gettext_noop("Vacuum cost amount available before napping, for autovacuum."),
1781 &autovacuum_vac_cost_limit,
1787 {"max_files_per_process", PGC_POSTMASTER, RESOURCES_KERNEL,
1788 gettext_noop("Sets the maximum number of simultaneously open files for each server process."),
1791 &max_files_per_process,
1797 * See also CheckRequiredParameterValues() if this parameter changes
1800 {"max_prepared_transactions", PGC_POSTMASTER, RESOURCES_MEM,
1801 gettext_noop("Sets the maximum number of simultaneously prepared transactions."),
1804 &max_prepared_xacts,
1811 {"trace_lock_oidmin", PGC_SUSET, DEVELOPER_OPTIONS,
1812 gettext_noop("No description available."),
1817 FirstNormalObjectId, 0, INT_MAX,
1821 {"trace_lock_table", PGC_SUSET, DEVELOPER_OPTIONS,
1822 gettext_noop("No description available."),
1833 {"statement_timeout", PGC_USERSET, CLIENT_CONN_STATEMENT,
1834 gettext_noop("Sets the maximum allowed duration of any statement."),
1835 gettext_noop("A value of 0 turns off the timeout."),
1844 {"vacuum_freeze_min_age", PGC_USERSET, CLIENT_CONN_STATEMENT,
1845 gettext_noop("Minimum age at which VACUUM should freeze a table row."),
1848 &vacuum_freeze_min_age,
1849 50000000, 0, 1000000000,
1854 {"vacuum_freeze_table_age", PGC_USERSET, CLIENT_CONN_STATEMENT,
1855 gettext_noop("Age at which VACUUM should scan whole table to freeze tuples."),
1858 &vacuum_freeze_table_age,
1859 150000000, 0, 2000000000,
1864 {"vacuum_defer_cleanup_age", PGC_SIGHUP, REPLICATION_MASTER,
1865 gettext_noop("Number of transactions by which VACUUM and HOT cleanup should be deferred, if any."),
1868 &vacuum_defer_cleanup_age,
1874 * See also CheckRequiredParameterValues() if this parameter changes
1877 {"max_locks_per_transaction", PGC_POSTMASTER, LOCK_MANAGEMENT,
1878 gettext_noop("Sets the maximum number of locks per transaction."),
1879 gettext_noop("The shared lock table is sized on the assumption that "
1880 "at most max_locks_per_transaction * max_connections distinct "
1881 "objects will need to be locked at any one time.")
1883 &max_locks_per_xact,
1889 {"max_pred_locks_per_transaction", PGC_POSTMASTER, LOCK_MANAGEMENT,
1890 gettext_noop("Sets the maximum number of predicate locks per transaction."),
1891 gettext_noop("The shared predicate lock table is sized on the assumption that "
1892 "at most max_pred_locks_per_transaction * max_connections distinct "
1893 "objects will need to be locked at any one time.")
1895 &max_predicate_locks_per_xact,
1901 {"authentication_timeout", PGC_SIGHUP, CONN_AUTH_SECURITY,
1902 gettext_noop("Sets the maximum allowed time to complete client authentication."),
1906 &AuthenticationTimeout,
1912 /* Not for general use */
1913 {"pre_auth_delay", PGC_SIGHUP, DEVELOPER_OPTIONS,
1914 gettext_noop("Waits N seconds on connection startup before authentication."),
1915 gettext_noop("This allows attaching a debugger to the process."),
1916 GUC_NOT_IN_SAMPLE | GUC_UNIT_S
1924 {"wal_keep_segments", PGC_SIGHUP, REPLICATION_SENDING,
1925 gettext_noop("Sets the number of WAL files held for standby servers."),
1934 {"checkpoint_segments", PGC_SIGHUP, WAL_CHECKPOINTS,
1935 gettext_noop("Sets the maximum distance in log segments between automatic WAL checkpoints."),
1938 &CheckPointSegments,
1944 {"checkpoint_timeout", PGC_SIGHUP, WAL_CHECKPOINTS,
1945 gettext_noop("Sets the maximum time between automatic WAL checkpoints."),
1955 {"checkpoint_warning", PGC_SIGHUP, WAL_CHECKPOINTS,
1956 gettext_noop("Enables warnings if checkpoint segments are filled more "
1957 "frequently than this."),
1958 gettext_noop("Write a message to the server log if checkpoints "
1959 "caused by the filling of checkpoint segment files happens more "
1960 "frequently than this number of seconds. Zero turns off the warning."),
1969 {"wal_buffers", PGC_POSTMASTER, WAL_SETTINGS,
1970 gettext_noop("Sets the number of disk-page buffers in shared memory for WAL."),
1976 check_wal_buffers, NULL, NULL
1980 {"wal_writer_delay", PGC_SIGHUP, WAL_SETTINGS,
1981 gettext_noop("WAL writer sleep time between WAL flushes."),
1991 /* see max_connections */
1992 {"max_wal_senders", PGC_POSTMASTER, REPLICATION_SENDING,
1993 gettext_noop("Sets the maximum number of simultaneously running WAL sender processes."),
2002 {"replication_timeout", PGC_SIGHUP, REPLICATION_SENDING,
2003 gettext_noop("Sets the maximum time to wait for WAL replication."),
2007 &replication_timeout,
2008 60 * 1000, 0, INT_MAX,
2013 {"commit_delay", PGC_USERSET, WAL_SETTINGS,
2014 gettext_noop("Sets the delay in microseconds between transaction commit and "
2015 "flushing WAL to disk."),
2024 {"commit_siblings", PGC_USERSET, WAL_SETTINGS,
2025 gettext_noop("Sets the minimum concurrent open transactions before performing "
2035 {"extra_float_digits", PGC_USERSET, CLIENT_CONN_LOCALE,
2036 gettext_noop("Sets the number of digits displayed for floating-point values."),
2037 gettext_noop("This affects real, double precision, and geometric data types. "
2038 "The parameter value is added to the standard number of digits "
2039 "(FLT_DIG or DBL_DIG as appropriate).")
2041 &extra_float_digits,
2047 {"log_min_duration_statement", PGC_SUSET, LOGGING_WHEN,
2048 gettext_noop("Sets the minimum execution time above which "
2049 "statements will be logged."),
2050 gettext_noop("Zero prints all queries. -1 turns this feature off."),
2053 &log_min_duration_statement,
2059 {"log_autovacuum_min_duration", PGC_SIGHUP, LOGGING_WHAT,
2060 gettext_noop("Sets the minimum execution time above which "
2061 "autovacuum actions will be logged."),
2062 gettext_noop("Zero prints all actions. -1 turns autovacuum logging off."),
2065 &Log_autovacuum_min_duration,
2071 {"bgwriter_delay", PGC_SIGHUP, RESOURCES_BGWRITER,
2072 gettext_noop("Background writer sleep time between rounds."),
2082 {"bgwriter_lru_maxpages", PGC_SIGHUP, RESOURCES_BGWRITER,
2083 gettext_noop("Background writer maximum number of LRU pages to flush per round."),
2086 &bgwriter_lru_maxpages,
2092 {"effective_io_concurrency",
2098 RESOURCES_ASYNCHRONOUS,
2099 gettext_noop("Number of simultaneous requests that can be handled efficiently by the disk subsystem."),
2100 gettext_noop("For RAID arrays, this should be approximately the number of drive spindles in the array.")
2102 &effective_io_concurrency,
2108 check_effective_io_concurrency, assign_effective_io_concurrency, NULL
2112 {"log_rotation_age", PGC_SIGHUP, LOGGING_WHERE,
2113 gettext_noop("Automatic log file rotation will occur after N minutes."),
2118 HOURS_PER_DAY * MINS_PER_HOUR, 0, INT_MAX / MINS_PER_HOUR,
2123 {"log_rotation_size", PGC_SIGHUP, LOGGING_WHERE,
2124 gettext_noop("Automatic log file rotation will occur after N kilobytes."),
2129 10 * 1024, 0, INT_MAX / 1024,
2134 {"max_function_args", PGC_INTERNAL, PRESET_OPTIONS,
2135 gettext_noop("Shows the maximum number of function arguments."),
2137 GUC_NOT_IN_SAMPLE | GUC_DISALLOW_IN_FILE
2140 FUNC_MAX_ARGS, FUNC_MAX_ARGS, FUNC_MAX_ARGS,
2145 {"max_index_keys", PGC_INTERNAL, PRESET_OPTIONS,
2146 gettext_noop("Shows the maximum number of index keys."),
2148 GUC_NOT_IN_SAMPLE | GUC_DISALLOW_IN_FILE
2151 INDEX_MAX_KEYS, INDEX_MAX_KEYS, INDEX_MAX_KEYS,
2156 {"max_identifier_length", PGC_INTERNAL, PRESET_OPTIONS,
2157 gettext_noop("Shows the maximum identifier length."),
2159 GUC_NOT_IN_SAMPLE | GUC_DISALLOW_IN_FILE
2161 &max_identifier_length,
2162 NAMEDATALEN - 1, NAMEDATALEN - 1, NAMEDATALEN - 1,
2167 {"block_size", PGC_INTERNAL, PRESET_OPTIONS,
2168 gettext_noop("Shows the size of a disk block."),
2170 GUC_NOT_IN_SAMPLE | GUC_DISALLOW_IN_FILE
2173 BLCKSZ, BLCKSZ, BLCKSZ,
2178 {"segment_size", PGC_INTERNAL, PRESET_OPTIONS,
2179 gettext_noop("Shows the number of pages per disk file."),
2181 GUC_UNIT_BLOCKS | GUC_NOT_IN_SAMPLE | GUC_DISALLOW_IN_FILE
2184 RELSEG_SIZE, RELSEG_SIZE, RELSEG_SIZE,
2189 {"wal_block_size", PGC_INTERNAL, PRESET_OPTIONS,
2190 gettext_noop("Shows the block size in the write ahead log."),
2192 GUC_NOT_IN_SAMPLE | GUC_DISALLOW_IN_FILE
2195 XLOG_BLCKSZ, XLOG_BLCKSZ, XLOG_BLCKSZ,
2200 {"wal_segment_size", PGC_INTERNAL, PRESET_OPTIONS,
2201 gettext_noop("Shows the number of pages per write ahead log segment."),
2203 GUC_UNIT_XBLOCKS | GUC_NOT_IN_SAMPLE | GUC_DISALLOW_IN_FILE
2206 (XLOG_SEG_SIZE / XLOG_BLCKSZ),
2207 (XLOG_SEG_SIZE / XLOG_BLCKSZ),
2208 (XLOG_SEG_SIZE / XLOG_BLCKSZ),
2213 {"autovacuum_naptime", PGC_SIGHUP, AUTOVACUUM,
2214 gettext_noop("Time to sleep between autovacuum runs."),
2218 &autovacuum_naptime,
2219 60, 1, INT_MAX / 1000,
2223 {"autovacuum_vacuum_threshold", PGC_SIGHUP, AUTOVACUUM,
2224 gettext_noop("Minimum number of tuple updates or deletes prior to vacuum."),
2227 &autovacuum_vac_thresh,
2232 {"autovacuum_analyze_threshold", PGC_SIGHUP, AUTOVACUUM,
2233 gettext_noop("Minimum number of tuple inserts, updates or deletes prior to analyze."),
2236 &autovacuum_anl_thresh,
2241 /* see varsup.c for why this is PGC_POSTMASTER not PGC_SIGHUP */
2242 {"autovacuum_freeze_max_age", PGC_POSTMASTER, AUTOVACUUM,
2243 gettext_noop("Age at which to autovacuum a table to prevent transaction ID wraparound."),
2246 &autovacuum_freeze_max_age,
2247 /* see pg_resetxlog if you change the upper-limit value */
2248 200000000, 100000000, 2000000000,
2252 /* see max_connections */
2253 {"autovacuum_max_workers", PGC_POSTMASTER, AUTOVACUUM,
2254 gettext_noop("Sets the maximum number of simultaneously running autovacuum worker processes."),
2257 &autovacuum_max_workers,
2259 check_autovacuum_max_workers, assign_autovacuum_max_workers, NULL
2263 {"tcp_keepalives_idle", PGC_USERSET, CLIENT_CONN_OTHER,
2264 gettext_noop("Time between issuing TCP keepalives."),
2265 gettext_noop("A value of 0 uses the system default."),
2268 &tcp_keepalives_idle,
2270 NULL, assign_tcp_keepalives_idle, show_tcp_keepalives_idle
2274 {"tcp_keepalives_interval", PGC_USERSET, CLIENT_CONN_OTHER,
2275 gettext_noop("Time between TCP keepalive retransmits."),
2276 gettext_noop("A value of 0 uses the system default."),
2279 &tcp_keepalives_interval,
2281 NULL, assign_tcp_keepalives_interval, show_tcp_keepalives_interval
2285 {"ssl_renegotiation_limit", PGC_USERSET, CONN_AUTH_SECURITY,
2286 gettext_noop("Set the amount of traffic to send and receive before renegotiating the encryption keys."),
2290 &ssl_renegotiation_limit,
2291 512 * 1024, 0, MAX_KILOBYTES,
2296 {"tcp_keepalives_count", PGC_USERSET, CLIENT_CONN_OTHER,
2297 gettext_noop("Maximum number of TCP keepalive retransmits."),
2298 gettext_noop("This controls the number of consecutive keepalive retransmits that can be "
2299 "lost before a connection is considered dead. A value of 0 uses the "
2302 &tcp_keepalives_count,
2304 NULL, assign_tcp_keepalives_count, show_tcp_keepalives_count
2308 {"gin_fuzzy_search_limit", PGC_USERSET, CLIENT_CONN_OTHER,
2309 gettext_noop("Sets the maximum allowed result for exact search by GIN."),
2313 &GinFuzzySearchLimit,
2319 {"effective_cache_size", PGC_USERSET, QUERY_TUNING_COST,
2320 gettext_noop("Sets the planner's assumption about the size of the disk cache."),
2321 gettext_noop("That is, the portion of the kernel's disk cache that "
2322 "will be used for PostgreSQL data files. This is measured in disk "
2323 "pages, which are normally 8 kB each."),
2326 &effective_cache_size,
2327 DEFAULT_EFFECTIVE_CACHE_SIZE, 1, INT_MAX,
2332 /* Can't be set in postgresql.conf */
2333 {"server_version_num", PGC_INTERNAL, PRESET_OPTIONS,
2334 gettext_noop("Shows the server version as an integer."),
2336 GUC_NOT_IN_SAMPLE | GUC_DISALLOW_IN_FILE
2338 &server_version_num,
2339 PG_VERSION_NUM, PG_VERSION_NUM, PG_VERSION_NUM,
2344 {"log_temp_files", PGC_SUSET, LOGGING_WHAT,
2345 gettext_noop("Log the use of temporary files larger than this number of kilobytes."),
2346 gettext_noop("Zero logs all files. The default is -1 (turning this feature off)."),
2355 {"track_activity_query_size", PGC_POSTMASTER, RESOURCES_MEM,
2356 gettext_noop("Sets the size reserved for pg_stat_activity.current_query, in bytes."),
2359 &pgstat_track_activity_query_size,
2364 /* End-of-list marker */
2366 {NULL, 0, 0, NULL, NULL}, NULL, 0, 0, 0, NULL, NULL, NULL
2371 static struct config_real ConfigureNamesReal[] =
2374 {"seq_page_cost", PGC_USERSET, QUERY_TUNING_COST,
2375 gettext_noop("Sets the planner's estimate of the cost of a "
2376 "sequentially fetched disk page."),
2380 DEFAULT_SEQ_PAGE_COST, 0, DBL_MAX,
2384 {"random_page_cost", PGC_USERSET, QUERY_TUNING_COST,
2385 gettext_noop("Sets the planner's estimate of the cost of a "
2386 "nonsequentially fetched disk page."),
2390 DEFAULT_RANDOM_PAGE_COST, 0, DBL_MAX,
2394 {"cpu_tuple_cost", PGC_USERSET, QUERY_TUNING_COST,
2395 gettext_noop("Sets the planner's estimate of the cost of "
2396 "processing each tuple (row)."),
2400 DEFAULT_CPU_TUPLE_COST, 0, DBL_MAX,
2404 {"cpu_index_tuple_cost", PGC_USERSET, QUERY_TUNING_COST,
2405 gettext_noop("Sets the planner's estimate of the cost of "
2406 "processing each index entry during an index scan."),
2409 &cpu_index_tuple_cost,
2410 DEFAULT_CPU_INDEX_TUPLE_COST, 0, DBL_MAX,
2414 {"cpu_operator_cost", PGC_USERSET, QUERY_TUNING_COST,
2415 gettext_noop("Sets the planner's estimate of the cost of "
2416 "processing each operator or function call."),
2420 DEFAULT_CPU_OPERATOR_COST, 0, DBL_MAX,
2425 {"cursor_tuple_fraction", PGC_USERSET, QUERY_TUNING_OTHER,
2426 gettext_noop("Sets the planner's estimate of the fraction of "
2427 "a cursor's rows that will be retrieved."),
2430 &cursor_tuple_fraction,
2431 DEFAULT_CURSOR_TUPLE_FRACTION, 0.0, 1.0,
2436 {"geqo_selection_bias", PGC_USERSET, QUERY_TUNING_GEQO,
2437 gettext_noop("GEQO: selective pressure within the population."),
2440 &Geqo_selection_bias,
2441 DEFAULT_GEQO_SELECTION_BIAS,
2442 MIN_GEQO_SELECTION_BIAS, MAX_GEQO_SELECTION_BIAS,
2446 {"geqo_seed", PGC_USERSET, QUERY_TUNING_GEQO,
2447 gettext_noop("GEQO: seed for random path selection."),
2456 {"bgwriter_lru_multiplier", PGC_SIGHUP, RESOURCES_BGWRITER,
2457 gettext_noop("Multiple of the average buffer usage to free per round."),
2460 &bgwriter_lru_multiplier,
2466 {"seed", PGC_USERSET, UNGROUPED,
2467 gettext_noop("Sets the seed for random-number generation."),
2469 GUC_NO_SHOW_ALL | GUC_NO_RESET_ALL | GUC_NOT_IN_SAMPLE | GUC_DISALLOW_IN_FILE
2473 check_random_seed, assign_random_seed, show_random_seed
2477 {"autovacuum_vacuum_scale_factor", PGC_SIGHUP, AUTOVACUUM,
2478 gettext_noop("Number of tuple updates or deletes prior to vacuum as a fraction of reltuples."),
2481 &autovacuum_vac_scale,
2486 {"autovacuum_analyze_scale_factor", PGC_SIGHUP, AUTOVACUUM,
2487 gettext_noop("Number of tuple inserts, updates or deletes prior to analyze as a fraction of reltuples."),
2490 &autovacuum_anl_scale,
2496 {"checkpoint_completion_target", PGC_SIGHUP, WAL_CHECKPOINTS,
2497 gettext_noop("Time spent flushing dirty buffers during checkpoint, as fraction of checkpoint interval."),
2500 &CheckPointCompletionTarget,
2505 /* End-of-list marker */
2507 {NULL, 0, 0, NULL, NULL}, NULL, 0.0, 0.0, 0.0, NULL, NULL, NULL
2512 static struct config_string ConfigureNamesString[] =
2515 {"archive_command", PGC_SIGHUP, WAL_ARCHIVING,
2516 gettext_noop("Sets the shell command that will be called to archive a WAL file."),
2519 &XLogArchiveCommand,
2521 NULL, NULL, show_archive_command
2525 {"client_encoding", PGC_USERSET, CLIENT_CONN_LOCALE,
2526 gettext_noop("Sets the client's character set encoding."),
2528 GUC_IS_NAME | GUC_REPORT
2530 &client_encoding_string,
2532 check_client_encoding, assign_client_encoding, NULL
2536 {"log_line_prefix", PGC_SIGHUP, LOGGING_WHAT,
2537 gettext_noop("Controls information prefixed to each log line."),
2538 gettext_noop("If blank, no prefix is used.")
2546 {"log_timezone", PGC_SIGHUP, LOGGING_WHAT,
2547 gettext_noop("Sets the time zone to use in log messages."),
2550 &log_timezone_string,
2552 check_log_timezone, assign_log_timezone, show_log_timezone
2556 {"DateStyle", PGC_USERSET, CLIENT_CONN_LOCALE,
2557 gettext_noop("Sets the display format for date and time values."),
2558 gettext_noop("Also controls interpretation of ambiguous "
2560 GUC_LIST_INPUT | GUC_REPORT
2564 check_datestyle, assign_datestyle, NULL
2568 {"default_tablespace", PGC_USERSET, CLIENT_CONN_STATEMENT,
2569 gettext_noop("Sets the default tablespace to create tables and indexes in."),
2570 gettext_noop("An empty string selects the database's default tablespace."),
2573 &default_tablespace,
2575 check_default_tablespace, NULL, NULL
2579 {"temp_tablespaces", PGC_USERSET, CLIENT_CONN_STATEMENT,
2580 gettext_noop("Sets the tablespace(s) to use for temporary tables and sort files."),
2582 GUC_LIST_INPUT | GUC_LIST_QUOTE
2586 check_temp_tablespaces, assign_temp_tablespaces, NULL
2590 {"dynamic_library_path", PGC_SUSET, CLIENT_CONN_OTHER,
2591 gettext_noop("Sets the path for dynamically loadable modules."),
2592 gettext_noop("If a dynamically loadable module needs to be opened and "
2593 "the specified name does not have a directory component (i.e., the "
2594 "name does not contain a slash), the system will search this path for "
2595 "the specified file."),
2598 &Dynamic_library_path,
2604 {"krb_server_keyfile", PGC_SIGHUP, CONN_AUTH_SECURITY,
2605 gettext_noop("Sets the location of the Kerberos server key file."),
2609 &pg_krb_server_keyfile,
2615 {"krb_srvname", PGC_SIGHUP, CONN_AUTH_SECURITY,
2616 gettext_noop("Sets the name of the Kerberos service."),
2625 {"bonjour_name", PGC_POSTMASTER, CONN_AUTH_SETTINGS,
2626 gettext_noop("Sets the Bonjour service name."),
2634 /* See main.c about why defaults for LC_foo are not all alike */
2637 {"lc_collate", PGC_INTERNAL, CLIENT_CONN_LOCALE,
2638 gettext_noop("Shows the collation order locale."),
2640 GUC_NOT_IN_SAMPLE | GUC_DISALLOW_IN_FILE
2648 {"lc_ctype", PGC_INTERNAL, CLIENT_CONN_LOCALE,
2649 gettext_noop("Shows the character classification and case conversion locale."),
2651 GUC_NOT_IN_SAMPLE | GUC_DISALLOW_IN_FILE
2659 {"lc_messages", PGC_SUSET, CLIENT_CONN_LOCALE,
2660 gettext_noop("Sets the language in which messages are displayed."),
2665 check_locale_messages, assign_locale_messages, NULL
2669 {"lc_monetary", PGC_USERSET, CLIENT_CONN_LOCALE,
2670 gettext_noop("Sets the locale for formatting monetary amounts."),
2675 check_locale_monetary, assign_locale_monetary, NULL
2679 {"lc_numeric", PGC_USERSET, CLIENT_CONN_LOCALE,
2680 gettext_noop("Sets the locale for formatting numbers."),
2685 check_locale_numeric, assign_locale_numeric, NULL
2689 {"lc_time", PGC_USERSET, CLIENT_CONN_LOCALE,
2690 gettext_noop("Sets the locale for formatting date and time values."),
2695 check_locale_time, assign_locale_time, NULL
2699 {"shared_preload_libraries", PGC_POSTMASTER, RESOURCES_KERNEL,
2700 gettext_noop("Lists shared libraries to preload into server."),
2702 GUC_LIST_INPUT | GUC_LIST_QUOTE | GUC_SUPERUSER_ONLY
2704 &shared_preload_libraries_string,
2710 {"local_preload_libraries", PGC_BACKEND, CLIENT_CONN_OTHER,
2711 gettext_noop("Lists shared libraries to preload into each backend."),
2713 GUC_LIST_INPUT | GUC_LIST_QUOTE
2715 &local_preload_libraries_string,
2721 {"search_path", PGC_USERSET, CLIENT_CONN_STATEMENT,
2722 gettext_noop("Sets the schema search order for names that are not schema-qualified."),
2724 GUC_LIST_INPUT | GUC_LIST_QUOTE
2726 &namespace_search_path,
2728 check_search_path, assign_search_path, NULL
2732 /* Can't be set in postgresql.conf */
2733 {"server_encoding", PGC_INTERNAL, CLIENT_CONN_LOCALE,
2734 gettext_noop("Sets the server (database) character set encoding."),
2736 GUC_IS_NAME | GUC_REPORT | GUC_NOT_IN_SAMPLE | GUC_DISALLOW_IN_FILE
2738 &server_encoding_string,
2744 /* Can't be set in postgresql.conf */
2745 {"server_version", PGC_INTERNAL, PRESET_OPTIONS,
2746 gettext_noop("Shows the server version."),
2748 GUC_REPORT | GUC_NOT_IN_SAMPLE | GUC_DISALLOW_IN_FILE
2750 &server_version_string,
2756 /* Not for general use --- used by SET ROLE */
2757 {"role", PGC_USERSET, UNGROUPED,
2758 gettext_noop("Sets the current role."),
2760 GUC_IS_NAME | GUC_NO_SHOW_ALL | GUC_NO_RESET_ALL | GUC_NOT_IN_SAMPLE | GUC_DISALLOW_IN_FILE | GUC_NOT_WHILE_SEC_REST
2764 check_role, assign_role, show_role
2768 /* Not for general use --- used by SET SESSION AUTHORIZATION */
2769 {"session_authorization", PGC_USERSET, UNGROUPED,
2770 gettext_noop("Sets the session user name."),
2772 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
2774 &session_authorization_string,
2776 check_session_authorization, assign_session_authorization, NULL
2780 {"log_destination", PGC_SIGHUP, LOGGING_WHERE,
2781 gettext_noop("Sets the destination for server log output."),
2782 gettext_noop("Valid values are combinations of \"stderr\", "
2783 "\"syslog\", \"csvlog\", and \"eventlog\", "
2784 "depending on the platform."),
2787 &log_destination_string,
2789 check_log_destination, assign_log_destination, NULL
2792 {"log_directory", PGC_SIGHUP, LOGGING_WHERE,
2793 gettext_noop("Sets the destination directory for log files."),
2794 gettext_noop("Can be specified as relative to the data directory "
2795 "or as absolute path."),
2800 check_canonical_path, NULL, NULL
2803 {"log_filename", PGC_SIGHUP, LOGGING_WHERE,
2804 gettext_noop("Sets the file name pattern for log files."),
2809 "postgresql-%Y-%m-%d_%H%M%S.log",
2814 {"syslog_ident", PGC_SIGHUP, LOGGING_WHERE,
2815 gettext_noop("Sets the program name used to identify PostgreSQL "
2816 "messages in syslog."),
2821 NULL, assign_syslog_ident, NULL
2825 {"TimeZone", PGC_USERSET, CLIENT_CONN_LOCALE,
2826 gettext_noop("Sets the time zone for displaying and interpreting time stamps."),
2832 check_timezone, assign_timezone, show_timezone
2835 {"timezone_abbreviations", PGC_USERSET, CLIENT_CONN_LOCALE,
2836 gettext_noop("Selects a file of time zone abbreviations."),
2839 &timezone_abbreviations_string,
2841 check_timezone_abbreviations, assign_timezone_abbreviations, NULL
2845 {"transaction_isolation", PGC_USERSET, CLIENT_CONN_STATEMENT,
2846 gettext_noop("Sets the current transaction's isolation level."),
2848 GUC_NO_RESET_ALL | GUC_NOT_IN_SAMPLE | GUC_DISALLOW_IN_FILE
2850 &XactIsoLevel_string,
2852 check_XactIsoLevel, assign_XactIsoLevel, show_XactIsoLevel
2856 {"unix_socket_group", PGC_POSTMASTER, CONN_AUTH_SETTINGS,
2857 gettext_noop("Sets the owning group of the Unix-domain socket."),
2858 gettext_noop("The owning user of the socket is always the user "
2859 "that starts the server.")
2867 {"unix_socket_directory", PGC_POSTMASTER, CONN_AUTH_SETTINGS,
2868 gettext_noop("Sets the directory where the Unix-domain socket will be created."),
2874 check_canonical_path, NULL, NULL
2878 {"listen_addresses", PGC_POSTMASTER, CONN_AUTH_SETTINGS,
2879 gettext_noop("Sets the host name or IP address(es) to listen to."),
2889 {"custom_variable_classes", PGC_SIGHUP, CUSTOM_OPTIONS,
2890 gettext_noop("Sets the list of known custom variable classes."),
2892 GUC_LIST_INPUT | GUC_LIST_QUOTE
2894 &custom_variable_classes,
2896 check_custom_variable_classes, NULL, NULL
2900 {"data_directory", PGC_POSTMASTER, FILE_LOCATIONS,
2901 gettext_noop("Sets the server's data directory."),
2911 {"config_file", PGC_POSTMASTER, FILE_LOCATIONS,
2912 gettext_noop("Sets the server's main configuration file."),
2914 GUC_DISALLOW_IN_FILE | GUC_SUPERUSER_ONLY
2922 {"hba_file", PGC_POSTMASTER, FILE_LOCATIONS,
2923 gettext_noop("Sets the server's \"hba\" configuration file."),
2933 {"ident_file", PGC_POSTMASTER, FILE_LOCATIONS,
2934 gettext_noop("Sets the server's \"ident\" configuration file."),
2944 {"external_pid_file", PGC_POSTMASTER, FILE_LOCATIONS,
2945 gettext_noop("Writes the postmaster PID to the specified file."),
2951 check_canonical_path, NULL, NULL
2955 {"stats_temp_directory", PGC_SIGHUP, STATS_COLLECTOR,
2956 gettext_noop("Writes temporary statistics files to the specified directory."),
2960 &pgstat_temp_directory,
2962 check_canonical_path, assign_pgstat_temp_directory, NULL
2966 {"synchronous_standby_names", PGC_SIGHUP, REPLICATION_MASTER,
2967 gettext_noop("List of names of potential synchronous standbys."),
2971 &SyncRepStandbyNames,
2973 check_synchronous_standby_names, NULL, NULL
2977 {"default_text_search_config", PGC_USERSET, CLIENT_CONN_LOCALE,
2978 gettext_noop("Sets default text search configuration."),
2982 "pg_catalog.simple",
2983 check_TSCurrentConfig, assign_TSCurrentConfig, NULL
2987 {"ssl_ciphers", PGC_POSTMASTER, CONN_AUTH_SECURITY,
2988 gettext_noop("Sets the list of allowed SSL ciphers."),
2994 "ALL:!ADH:!LOW:!EXP:!MD5:@STRENGTH",
3002 {"application_name", PGC_USERSET, LOGGING_WHAT,
3003 gettext_noop("Sets the application name to be reported in statistics and logs."),
3005 GUC_IS_NAME | GUC_REPORT | GUC_NOT_IN_SAMPLE
3009 check_application_name, assign_application_name, NULL
3012 /* End-of-list marker */
3014 {NULL, 0, 0, NULL, NULL}, NULL, NULL, NULL, NULL, NULL
3019 static struct config_enum ConfigureNamesEnum[] =
3022 {"backslash_quote", PGC_USERSET, COMPAT_OPTIONS_PREVIOUS,
3023 gettext_noop("Sets whether \"\\'\" is allowed in string literals."),
3027 BACKSLASH_QUOTE_SAFE_ENCODING, backslash_quote_options,
3032 {"bytea_output", PGC_USERSET, CLIENT_CONN_STATEMENT,
3033 gettext_noop("Sets the output format for bytea."),
3037 BYTEA_OUTPUT_HEX, bytea_output_options,
3042 {"client_min_messages", PGC_USERSET, LOGGING_WHEN,
3043 gettext_noop("Sets the message levels that are sent to the client."),
3044 gettext_noop("Each level includes all the levels that follow it. The later"
3045 " the level, the fewer messages are sent.")
3047 &client_min_messages,
3048 NOTICE, client_message_level_options,
3053 {"constraint_exclusion", PGC_USERSET, QUERY_TUNING_OTHER,
3054 gettext_noop("Enables the planner to use constraints to optimize queries."),
3055 gettext_noop("Table scans will be skipped if their constraints"
3056 " guarantee that no rows match the query.")
3058 &constraint_exclusion,
3059 CONSTRAINT_EXCLUSION_PARTITION, constraint_exclusion_options,
3064 {"default_transaction_isolation", PGC_USERSET, CLIENT_CONN_STATEMENT,
3065 gettext_noop("Sets the transaction isolation level of each new transaction."),
3068 &DefaultXactIsoLevel,
3069 XACT_READ_COMMITTED, isolation_level_options,
3074 {"IntervalStyle", PGC_USERSET, CLIENT_CONN_LOCALE,
3075 gettext_noop("Sets the display format for interval values."),
3080 INTSTYLE_POSTGRES, intervalstyle_options,
3085 {"log_error_verbosity", PGC_SUSET, LOGGING_WHAT,
3086 gettext_noop("Sets the verbosity of logged messages."),
3089 &Log_error_verbosity,
3090 PGERROR_DEFAULT, log_error_verbosity_options,
3095 {"log_min_messages", PGC_SUSET, LOGGING_WHEN,
3096 gettext_noop("Sets the message levels that are logged."),
3097 gettext_noop("Each level includes all the levels that follow it. The later"
3098 " the level, the fewer messages are sent.")
3101 WARNING, server_message_level_options,
3106 {"log_min_error_statement", PGC_SUSET, LOGGING_WHEN,
3107 gettext_noop("Causes all statements generating error at or above this level to be logged."),
3108 gettext_noop("Each level includes all the levels that follow it. The later"
3109 " the level, the fewer messages are sent.")
3111 &log_min_error_statement,
3112 ERROR, server_message_level_options,
3117 {"log_statement", PGC_SUSET, LOGGING_WHAT,
3118 gettext_noop("Sets the type of statements logged."),
3122 LOGSTMT_NONE, log_statement_options,
3127 {"syslog_facility", PGC_SIGHUP, LOGGING_WHERE,
3128 gettext_noop("Sets the syslog \"facility\" to be used when syslog enabled."),
3137 syslog_facility_options,
3138 NULL, assign_syslog_facility, NULL
3142 {"session_replication_role", PGC_SUSET, CLIENT_CONN_STATEMENT,
3143 gettext_noop("Sets the session's behavior for triggers and rewrite rules."),
3146 &SessionReplicationRole,
3147 SESSION_REPLICATION_ROLE_ORIGIN, session_replication_role_options,
3148 NULL, assign_session_replication_role, NULL
3152 {"synchronous_commit", PGC_USERSET, WAL_SETTINGS,
3153 gettext_noop("Sets the current transaction's synchronization level."),
3156 &synchronous_commit,
3157 SYNCHRONOUS_COMMIT_ON, synchronous_commit_options,
3162 {"trace_recovery_messages", PGC_SIGHUP, DEVELOPER_OPTIONS,
3163 gettext_noop("Enables logging of recovery-related debugging information."),
3164 gettext_noop("Each level includes all the levels that follow it. The later"
3165 " the level, the fewer messages are sent.")
3167 &trace_recovery_messages,
3170 * client_message_level_options allows too many values, really, but
3171 * it's not worth having a separate options array for this.
3173 LOG, client_message_level_options,
3178 {"track_functions", PGC_SUSET, STATS_COLLECTOR,
3179 gettext_noop("Collects function-level statistics on database activity."),
3182 &pgstat_track_functions,
3183 TRACK_FUNC_OFF, track_function_options,
3188 {"wal_level", PGC_POSTMASTER, WAL_SETTINGS,
3189 gettext_noop("Set the level of information written to the WAL."),
3193 WAL_LEVEL_MINIMAL, wal_level_options,
3198 {"wal_sync_method", PGC_SIGHUP, WAL_SETTINGS,
3199 gettext_noop("Selects the method used for forcing WAL updates to disk."),
3203 DEFAULT_SYNC_METHOD, sync_method_options,
3204 NULL, assign_xlog_sync_method, NULL
3208 {"xmlbinary", PGC_USERSET, CLIENT_CONN_STATEMENT,
3209 gettext_noop("Sets how binary values are to be encoded in XML."),
3213 XMLBINARY_BASE64, xmlbinary_options,
3218 {"xmloption", PGC_USERSET, CLIENT_CONN_STATEMENT,
3219 gettext_noop("Sets whether XML data in implicit parsing and serialization "
3220 "operations is to be considered as documents or content fragments."),
3224 XMLOPTION_CONTENT, xmloption_options,
3229 /* End-of-list marker */
3231 {NULL, 0, 0, NULL, NULL}, NULL, 0, NULL, NULL, NULL, NULL
3235 /******** end of options list ********/
3239 * To allow continued support of obsolete names for GUC variables, we apply
3240 * the following mappings to any unrecognized name. Note that an old name
3241 * should be mapped to a new one only if the new variable has very similar
3242 * semantics to the old.
3244 static const char *const map_old_guc_names[] = {
3245 "sort_mem", "work_mem",
3246 "vacuum_mem", "maintenance_work_mem",
3252 * Actual lookup of variables is done through this single, sorted array.
3254 static struct config_generic **guc_variables;
3256 /* Current number of variables contained in the vector */
3257 static int num_guc_variables;
3259 /* Vector capacity */
3260 static int size_guc_variables;
3263 static bool guc_dirty; /* TRUE if need to do commit/abort work */
3265 static bool reporting_enabled; /* TRUE to enable GUC_REPORT */
3267 static int GUCNestLevel = 0; /* 1 when in main transaction */
3270 static int guc_var_compare(const void *a, const void *b);
3271 static int guc_name_compare(const char *namea, const char *nameb);
3272 static void InitializeGUCOptionsFromEnvironment(void);
3273 static void InitializeOneGUCOption(struct config_generic * gconf);
3274 static void push_old_value(struct config_generic * gconf, GucAction action);
3275 static void ReportGUCOption(struct config_generic * record);
3276 static void ShowGUCConfigOption(const char *name, DestReceiver *dest);
3277 static void ShowAllGUCConfig(DestReceiver *dest);
3278 static char *_ShowOption(struct config_generic * record, bool use_units);
3279 static bool validate_option_array_item(const char *name, const char *value,
3280 bool skipIfNoPermissions);
3284 * Some infrastructure for checking malloc/strdup/realloc calls
3287 guc_malloc(int elevel, size_t size)
3291 data = malloc(size);
3294 (errcode(ERRCODE_OUT_OF_MEMORY),
3295 errmsg("out of memory")));
3300 guc_realloc(int elevel, void *old, size_t size)
3304 data = realloc(old, size);
3307 (errcode(ERRCODE_OUT_OF_MEMORY),
3308 errmsg("out of memory")));
3313 guc_strdup(int elevel, const char *src)
3320 (errcode(ERRCODE_OUT_OF_MEMORY),
3321 errmsg("out of memory")));
3327 * Detect whether strval is referenced anywhere in a GUC string item
3330 string_field_used(struct config_string * conf, char *strval)
3334 if (strval == *(conf->variable) ||
3335 strval == conf->reset_val ||
3336 strval == conf->boot_val)
3338 for (stack = conf->gen.stack; stack; stack = stack->prev)
3340 if (strval == stack->prior.val.stringval ||
3341 strval == stack->masked.val.stringval)
3348 * Support for assigning to a field of a string GUC item. Free the prior
3349 * value if it's not referenced anywhere else in the item (including stacked
3353 set_string_field(struct config_string * conf, char **field, char *newval)
3355 char *oldval = *field;
3357 /* Do the assignment */
3360 /* Free old value if it's not NULL and isn't referenced anymore */
3361 if (oldval && !string_field_used(conf, oldval))
3366 * Detect whether an "extra" struct is referenced anywhere in a GUC item
3369 extra_field_used(struct config_generic * gconf, void *extra)
3373 if (extra == gconf->extra)
3375 switch (gconf->vartype)
3378 if (extra == ((struct config_bool *) gconf)->reset_extra)
3382 if (extra == ((struct config_int *) gconf)->reset_extra)
3386 if (extra == ((struct config_real *) gconf)->reset_extra)
3390 if (extra == ((struct config_string *) gconf)->reset_extra)
3394 if (extra == ((struct config_enum *) gconf)->reset_extra)
3398 for (stack = gconf->stack; stack; stack = stack->prev)
3400 if (extra == stack->prior.extra ||
3401 extra == stack->masked.extra)
3409 * Support for assigning to an "extra" field of a GUC item. Free the prior
3410 * value if it's not referenced anywhere else in the item (including stacked
3414 set_extra_field(struct config_generic * gconf, void **field, void *newval)
3416 void *oldval = *field;
3418 /* Do the assignment */
3421 /* Free old value if it's not NULL and isn't referenced anymore */
3422 if (oldval && !extra_field_used(gconf, oldval))
3427 * Support for copying a variable's active value into a stack entry.
3428 * The "extra" field associated with the active value is copied, too.
3430 * NB: be sure stringval and extra fields of a new stack entry are
3431 * initialized to NULL before this is used, else we'll try to free() them.
3434 set_stack_value(struct config_generic * gconf, config_var_value *val)
3436 switch (gconf->vartype)
3440 *((struct config_bool *) gconf)->variable;
3444 *((struct config_int *) gconf)->variable;
3448 *((struct config_real *) gconf)->variable;
3451 set_string_field((struct config_string *) gconf,
3452 &(val->val.stringval),
3453 *((struct config_string *) gconf)->variable);
3457 *((struct config_enum *) gconf)->variable;
3460 set_extra_field(gconf, &(val->extra), gconf->extra);
3464 * Support for discarding a no-longer-needed value in a stack entry.
3465 * The "extra" field associated with the stack entry is cleared, too.
3468 discard_stack_value(struct config_generic * gconf, config_var_value *val)
3470 switch (gconf->vartype)
3476 /* no need to do anything */
3479 set_string_field((struct config_string *) gconf,
3480 &(val->val.stringval),
3484 set_extra_field(gconf, &(val->extra), NULL);
3489 * Fetch the sorted array pointer (exported for help_config.c's use ONLY)
3491 struct config_generic **
3492 get_guc_variables(void)
3494 return guc_variables;
3499 * Build the sorted array. This is split out so that it could be
3500 * re-executed after startup (eg, we could allow loadable modules to
3501 * add vars, and then we'd need to re-sort).
3504 build_guc_variables(void)
3508 struct config_generic **guc_vars;
3511 for (i = 0; ConfigureNamesBool[i].gen.name; i++)
3513 struct config_bool *conf = &ConfigureNamesBool[i];
3515 /* Rather than requiring vartype to be filled in by hand, do this: */
3516 conf->gen.vartype = PGC_BOOL;
3520 for (i = 0; ConfigureNamesInt[i].gen.name; i++)
3522 struct config_int *conf = &ConfigureNamesInt[i];
3524 conf->gen.vartype = PGC_INT;
3528 for (i = 0; ConfigureNamesReal[i].gen.name; i++)
3530 struct config_real *conf = &ConfigureNamesReal[i];
3532 conf->gen.vartype = PGC_REAL;
3536 for (i = 0; ConfigureNamesString[i].gen.name; i++)
3538 struct config_string *conf = &ConfigureNamesString[i];
3540 conf->gen.vartype = PGC_STRING;
3544 for (i = 0; ConfigureNamesEnum[i].gen.name; i++)
3546 struct config_enum *conf = &ConfigureNamesEnum[i];
3548 conf->gen.vartype = PGC_ENUM;
3553 * Create table with 20% slack
3555 size_vars = num_vars + num_vars / 4;
3557 guc_vars = (struct config_generic **)
3558 guc_malloc(FATAL, size_vars * sizeof(struct config_generic *));
3562 for (i = 0; ConfigureNamesBool[i].gen.name; i++)
3563 guc_vars[num_vars++] = &ConfigureNamesBool[i].gen;
3565 for (i = 0; ConfigureNamesInt[i].gen.name; i++)
3566 guc_vars[num_vars++] = &ConfigureNamesInt[i].gen;
3568 for (i = 0; ConfigureNamesReal[i].gen.name; i++)
3569 guc_vars[num_vars++] = &ConfigureNamesReal[i].gen;
3571 for (i = 0; ConfigureNamesString[i].gen.name; i++)
3572 guc_vars[num_vars++] = &ConfigureNamesString[i].gen;
3574 for (i = 0; ConfigureNamesEnum[i].gen.name; i++)
3575 guc_vars[num_vars++] = &ConfigureNamesEnum[i].gen;
3578 free(guc_variables);
3579 guc_variables = guc_vars;
3580 num_guc_variables = num_vars;
3581 size_guc_variables = size_vars;
3582 qsort((void *) guc_variables, num_guc_variables,
3583 sizeof(struct config_generic *), guc_var_compare);
3587 * Add a new GUC variable to the list of known variables. The
3588 * list is expanded if needed.
3591 add_guc_variable(struct config_generic * var, int elevel)
3593 if (num_guc_variables + 1 >= size_guc_variables)
3596 * Increase the vector by 25%
3598 int size_vars = size_guc_variables + size_guc_variables / 4;
3599 struct config_generic **guc_vars;
3604 guc_vars = (struct config_generic **)
3605 guc_malloc(elevel, size_vars * sizeof(struct config_generic *));
3609 guc_vars = (struct config_generic **)
3610 guc_realloc(elevel, guc_variables, size_vars * sizeof(struct config_generic *));
3613 if (guc_vars == NULL)
3614 return false; /* out of memory */
3616 guc_variables = guc_vars;
3617 size_guc_variables = size_vars;
3619 guc_variables[num_guc_variables++] = var;
3620 qsort((void *) guc_variables, num_guc_variables,
3621 sizeof(struct config_generic *), guc_var_compare);
3626 * Create and add a placeholder variable. It's presumed to belong
3627 * to a valid custom variable class at this point.
3629 static struct config_generic *
3630 add_placeholder_variable(const char *name, int elevel)
3632 size_t sz = sizeof(struct config_string) + sizeof(char *);
3633 struct config_string *var;
3634 struct config_generic *gen;
3636 var = (struct config_string *) guc_malloc(elevel, sz);
3642 gen->name = guc_strdup(elevel, name);
3643 if (gen->name == NULL)
3649 gen->context = PGC_USERSET;
3650 gen->group = CUSTOM_OPTIONS;
3651 gen->short_desc = "GUC placeholder variable";
3652 gen->flags = GUC_NO_SHOW_ALL | GUC_NOT_IN_SAMPLE | GUC_CUSTOM_PLACEHOLDER;
3653 gen->vartype = PGC_STRING;
3656 * The char* is allocated at the end of the struct since we have no
3657 * 'static' place to point to. Note that the current value, as well as
3658 * the boot and reset values, start out NULL.
3660 var->variable = (char **) (var + 1);
3662 if (!add_guc_variable((struct config_generic *) var, elevel))
3664 free((void *) gen->name);
3673 * Detect whether the portion of "name" before dotPos matches any custom
3674 * variable class name listed in custom_var_classes. The latter must be
3675 * formatted the way that assign_custom_variable_classes does it, ie,
3676 * no whitespace. NULL is valid for custom_var_classes.
3679 is_custom_class(const char *name, int dotPos, const char *custom_var_classes)
3681 bool result = false;
3682 const char *ccs = custom_var_classes;
3686 const char *start = ccs;
3692 if (c == '\0' || c == ',')
3694 if (dotPos == ccs - start && strncmp(start, name, dotPos) == 0)
3709 * Look up option NAME. If it exists, return a pointer to its record,
3710 * else return NULL. If create_placeholders is TRUE, we'll create a
3711 * placeholder record for a valid-looking custom variable name.
3713 static struct config_generic *
3714 find_option(const char *name, bool create_placeholders, int elevel)
3716 const char **key = &name;
3717 struct config_generic **res;
3723 * By equating const char ** with struct config_generic *, we are assuming
3724 * the name field is first in config_generic.
3726 res = (struct config_generic **) bsearch((void *) &key,
3727 (void *) guc_variables,
3729 sizeof(struct config_generic *),
3735 * See if the name is an obsolete name for a variable. We assume that the
3736 * set of supported old names is short enough that a brute-force search is
3739 for (i = 0; map_old_guc_names[i] != NULL; i += 2)
3741 if (guc_name_compare(name, map_old_guc_names[i]) == 0)
3742 return find_option(map_old_guc_names[i + 1], false, elevel);
3745 if (create_placeholders)
3748 * Check if the name is qualified, and if so, check if the qualifier
3749 * matches any custom variable class. If so, add a placeholder.
3751 const char *dot = strchr(name, GUC_QUALIFIER_SEPARATOR);
3754 is_custom_class(name, dot - name, custom_variable_classes))
3755 return add_placeholder_variable(name, elevel);
3764 * comparator for qsorting and bsearching guc_variables array
3767 guc_var_compare(const void *a, const void *b)
3769 struct config_generic *confa = *(struct config_generic **) a;
3770 struct config_generic *confb = *(struct config_generic **) b;
3772 return guc_name_compare(confa->name, confb->name);
3776 * the bare comparison function for GUC names
3779 guc_name_compare(const char *namea, const char *nameb)
3782 * The temptation to use strcasecmp() here must be resisted, because the
3783 * array ordering has to remain stable across setlocale() calls. So, build
3784 * our own with a simple ASCII-only downcasing.
3786 while (*namea && *nameb)
3788 char cha = *namea++;
3789 char chb = *nameb++;
3791 if (cha >= 'A' && cha <= 'Z')
3793 if (chb >= 'A' && chb <= 'Z')
3799 return 1; /* a is longer */
3801 return -1; /* b is longer */
3807 * Initialize GUC options during program startup.
3809 * Note that we cannot read the config file yet, since we have not yet
3810 * processed command-line switches.
3813 InitializeGUCOptions(void)
3818 * Before log_line_prefix could possibly receive a nonempty setting, make
3819 * sure that timezone processing is minimally alive (see elog.c).
3821 pg_timezone_initialize();
3824 * Build sorted array of all GUC variables.
3826 build_guc_variables();
3829 * Load all variables with their compiled-in defaults, and initialize
3830 * status fields as needed.
3832 for (i = 0; i < num_guc_variables; i++)
3834 InitializeOneGUCOption(guc_variables[i]);
3839 reporting_enabled = false;
3842 * Prevent any attempt to override the transaction modes from
3843 * non-interactive sources.
3845 SetConfigOption("transaction_isolation", "default",
3846 PGC_POSTMASTER, PGC_S_OVERRIDE);
3847 SetConfigOption("transaction_read_only", "no",
3848 PGC_POSTMASTER, PGC_S_OVERRIDE);
3849 SetConfigOption("transaction_deferrable", "no",
3850 PGC_POSTMASTER, PGC_S_OVERRIDE);
3853 * For historical reasons, some GUC parameters can receive defaults from
3854 * environment variables. Process those settings.
3856 InitializeGUCOptionsFromEnvironment();
3860 * Assign any GUC values that can come from the server's environment.
3862 * This is called from InitializeGUCOptions, and also from ProcessConfigFile
3863 * to deal with the possibility that a setting has been removed from
3864 * postgresql.conf and should now get a value from the environment.
3865 * (The latter is a kludge that should probably go away someday; if so,
3866 * fold this back into InitializeGUCOptions.)
3869 InitializeGUCOptionsFromEnvironment(void)
3874 env = getenv("PGPORT");
3876 SetConfigOption("port", env, PGC_POSTMASTER, PGC_S_ENV_VAR);
3878 env = getenv("PGDATESTYLE");
3880 SetConfigOption("datestyle", env, PGC_POSTMASTER, PGC_S_ENV_VAR);
3882 env = getenv("PGCLIENTENCODING");
3884 SetConfigOption("client_encoding", env, PGC_POSTMASTER, PGC_S_ENV_VAR);
3887 * rlimit isn't exactly an "environment variable", but it behaves about
3888 * the same. If we can identify the platform stack depth rlimit, increase
3889 * default stack depth setting up to whatever is safe (but at most 2MB).
3891 stack_rlimit = get_stack_depth_rlimit();
3892 if (stack_rlimit > 0)
3894 long new_limit = (stack_rlimit - STACK_DEPTH_SLOP) / 1024L;
3896 if (new_limit > 100)
3900 new_limit = Min(new_limit, 2048);
3901 sprintf(limbuf, "%ld", new_limit);
3902 SetConfigOption("max_stack_depth", limbuf,
3903 PGC_POSTMASTER, PGC_S_ENV_VAR);
3909 * Initialize one GUC option variable to its compiled-in default.
3911 * Note: the reason for calling check_hooks is not that we think the boot_val
3912 * might fail, but that the hooks might wish to compute an "extra" struct.
3915 InitializeOneGUCOption(struct config_generic * gconf)
3918 gconf->reset_source = PGC_S_DEFAULT;
3919 gconf->source = PGC_S_DEFAULT;
3920 gconf->stack = NULL;
3921 gconf->extra = NULL;
3922 gconf->sourcefile = NULL;
3923 gconf->sourceline = 0;
3925 switch (gconf->vartype)
3929 struct config_bool *conf = (struct config_bool *) gconf;
3930 bool newval = conf->boot_val;
3933 if (!call_bool_check_hook(conf, &newval, &extra,
3934 PGC_S_DEFAULT, LOG))
3935 elog(FATAL, "failed to initialize %s to %d",
3936 conf->gen.name, (int) newval);
3937 if (conf->assign_hook)
3938 (*conf->assign_hook) (newval, extra);
3939 *conf->variable = conf->reset_val = newval;
3940 conf->gen.extra = conf->reset_extra = extra;
3945 struct config_int *conf = (struct config_int *) gconf;
3946 int newval = conf->boot_val;
3949 Assert(newval >= conf->min);
3950 Assert(newval <= conf->max);
3951 if (!call_int_check_hook(conf, &newval, &extra,
3952 PGC_S_DEFAULT, LOG))
3953 elog(FATAL, "failed to initialize %s to %d",
3954 conf->gen.name, newval);
3955 if (conf->assign_hook)
3956 (*conf->assign_hook) (newval, extra);
3957 *conf->variable = conf->reset_val = newval;
3958 conf->gen.extra = conf->reset_extra = extra;
3963 struct config_real *conf = (struct config_real *) gconf;
3964 double newval = conf->boot_val;
3967 Assert(newval >= conf->min);
3968 Assert(newval <= conf->max);
3969 if (!call_real_check_hook(conf, &newval, &extra,
3970 PGC_S_DEFAULT, LOG))
3971 elog(FATAL, "failed to initialize %s to %g",
3972 conf->gen.name, newval);
3973 if (conf->assign_hook)
3974 (*conf->assign_hook) (newval, extra);
3975 *conf->variable = conf->reset_val = newval;
3976 conf->gen.extra = conf->reset_extra = extra;
3981 struct config_string *conf = (struct config_string *) gconf;
3985 /* non-NULL boot_val must always get strdup'd */
3986 if (conf->boot_val != NULL)
3987 newval = guc_strdup(FATAL, conf->boot_val);
3991 if (!call_string_check_hook(conf, &newval, &extra,
3992 PGC_S_DEFAULT, LOG))
3993 elog(FATAL, "failed to initialize %s to \"%s\"",
3994 conf->gen.name, newval ? newval : "");
3995 if (conf->assign_hook)
3996 (*conf->assign_hook) (newval, extra);
3997 *conf->variable = conf->reset_val = newval;
3998 conf->gen.extra = conf->reset_extra = extra;
4003 struct config_enum *conf = (struct config_enum *) gconf;
4004 int newval = conf->boot_val;
4007 if (!call_enum_check_hook(conf, &newval, &extra,
4008 PGC_S_DEFAULT, LOG))
4009 elog(FATAL, "failed to initialize %s to %d",
4010 conf->gen.name, newval);
4011 if (conf->assign_hook)
4012 (*conf->assign_hook) (newval, extra);
4013 *conf->variable = conf->reset_val = newval;
4014 conf->gen.extra = conf->reset_extra = extra;
4022 * Select the configuration files and data directory to be used, and
4023 * do the initial read of postgresql.conf.
4025 * This is called after processing command-line switches.
4026 * userDoption is the -D switch value if any (NULL if unspecified).
4027 * progname is just for use in error messages.
4029 * Returns true on success; on failure, prints a suitable error message
4030 * to stderr and returns false.
4033 SelectConfigFiles(const char *userDoption, const char *progname)
4037 struct stat stat_buf;
4039 /* configdir is -D option, or $PGDATA if no -D */
4041 configdir = make_absolute_path(userDoption);
4043 configdir = make_absolute_path(getenv("PGDATA"));
4046 * Find the configuration file: if config_file was specified on the
4047 * command line, use it, else use configdir/postgresql.conf. In any case
4048 * ensure the result is an absolute path, so that it will be interpreted
4049 * the same way by future backends.
4052 fname = make_absolute_path(ConfigFileName);
4055 fname = guc_malloc(FATAL,
4056 strlen(configdir) + strlen(CONFIG_FILENAME) + 2);
4057 sprintf(fname, "%s/%s", configdir, CONFIG_FILENAME);
4061 write_stderr("%s does not know where to find the server configuration file.\n"
4062 "You must specify the --config-file or -D invocation "
4063 "option or set the PGDATA environment variable.\n",
4069 * Set the ConfigFileName GUC variable to its final value, ensuring that
4070 * it can't be overridden later.
4072 SetConfigOption("config_file", fname, PGC_POSTMASTER, PGC_S_OVERRIDE);
4076 * Now read the config file for the first time.
4078 if (stat(ConfigFileName, &stat_buf) != 0)
4080 write_stderr("%s cannot access the server configuration file \"%s\": %s\n",
4081 progname, ConfigFileName, strerror(errno));
4085 ProcessConfigFile(PGC_POSTMASTER);
4088 * If the data_directory GUC variable has been set, use that as DataDir;
4089 * otherwise use configdir if set; else punt.
4091 * Note: SetDataDir will copy and absolute-ize its argument, so we don't
4095 SetDataDir(data_directory);
4097 SetDataDir(configdir);
4100 write_stderr("%s does not know where to find the database system data.\n"
4101 "This can be specified as \"data_directory\" in \"%s\", "
4102 "or by the -D invocation option, or by the "
4103 "PGDATA environment variable.\n",
4104 progname, ConfigFileName);
4109 * Reflect the final DataDir value back into the data_directory GUC var.
4110 * (If you are wondering why we don't just make them a single variable,
4111 * it's because the EXEC_BACKEND case needs DataDir to be transmitted to
4112 * child backends specially. XXX is that still true? Given that we now
4113 * chdir to DataDir, EXEC_BACKEND can read the config file without knowing
4114 * DataDir in advance.)
4116 SetConfigOption("data_directory", DataDir, PGC_POSTMASTER, PGC_S_OVERRIDE);
4119 * If timezone_abbreviations wasn't set in the configuration file, install
4120 * the default value. We do it this way because we can't safely install
4121 * a "real" value until my_exec_path is set, which may not have happened
4122 * when InitializeGUCOptions runs, so the bootstrap default value cannot
4123 * be the real desired default.
4125 pg_timezone_abbrev_initialize();
4128 * Figure out where pg_hba.conf is, and make sure the path is absolute.
4131 fname = make_absolute_path(HbaFileName);
4134 fname = guc_malloc(FATAL,
4135 strlen(configdir) + strlen(HBA_FILENAME) + 2);
4136 sprintf(fname, "%s/%s", configdir, HBA_FILENAME);
4140 write_stderr("%s does not know where to find the \"hba\" configuration file.\n"
4141 "This can be specified as \"hba_file\" in \"%s\", "
4142 "or by the -D invocation option, or by the "
4143 "PGDATA environment variable.\n",
4144 progname, ConfigFileName);
4147 SetConfigOption("hba_file", fname, PGC_POSTMASTER, PGC_S_OVERRIDE);
4151 * Likewise for pg_ident.conf.
4154 fname = make_absolute_path(IdentFileName);
4157 fname = guc_malloc(FATAL,
4158 strlen(configdir) + strlen(IDENT_FILENAME) + 2);
4159 sprintf(fname, "%s/%s", configdir, IDENT_FILENAME);
4163 write_stderr("%s does not know where to find the \"ident\" configuration file.\n"
4164 "This can be specified as \"ident_file\" in \"%s\", "
4165 "or by the -D invocation option, or by the "
4166 "PGDATA environment variable.\n",
4167 progname, ConfigFileName);
4170 SetConfigOption("ident_file", fname, PGC_POSTMASTER, PGC_S_OVERRIDE);
4180 * Reset all options to their saved default values (implements RESET ALL)
4183 ResetAllOptions(void)
4187 for (i = 0; i < num_guc_variables; i++)
4189 struct config_generic *gconf = guc_variables[i];
4191 /* Don't reset non-SET-able values */
4192 if (gconf->context != PGC_SUSET &&
4193 gconf->context != PGC_USERSET)
4195 /* Don't reset if special exclusion from RESET ALL */
4196 if (gconf->flags & GUC_NO_RESET_ALL)
4198 /* No need to reset if wasn't SET */
4199 if (gconf->source <= PGC_S_OVERRIDE)
4202 /* Save old value to support transaction abort */
4203 push_old_value(gconf, GUC_ACTION_SET);
4205 switch (gconf->vartype)
4209 struct config_bool *conf = (struct config_bool *) gconf;
4211 if (conf->assign_hook)
4212 (*conf->assign_hook) (conf->reset_val,
4214 *conf->variable = conf->reset_val;
4215 set_extra_field(&conf->gen, &conf->gen.extra,
4221 struct config_int *conf = (struct config_int *) gconf;
4223 if (conf->assign_hook)
4224 (*conf->assign_hook) (conf->reset_val,
4226 *conf->variable = conf->reset_val;
4227 set_extra_field(&conf->gen, &conf->gen.extra,
4233 struct config_real *conf = (struct config_real *) gconf;
4235 if (conf->assign_hook)
4236 (*conf->assign_hook) (conf->reset_val,
4238 *conf->variable = conf->reset_val;
4239 set_extra_field(&conf->gen, &conf->gen.extra,
4245 struct config_string *conf = (struct config_string *) gconf;
4247 if (conf->assign_hook)
4248 (*conf->assign_hook) (conf->reset_val,
4250 set_string_field(conf, conf->variable, conf->reset_val);
4251 set_extra_field(&conf->gen, &conf->gen.extra,
4257 struct config_enum *conf = (struct config_enum *) gconf;
4259 if (conf->assign_hook)
4260 (*conf->assign_hook) (conf->reset_val,
4262 *conf->variable = conf->reset_val;
4263 set_extra_field(&conf->gen, &conf->gen.extra,
4269 gconf->source = gconf->reset_source;
4271 if (gconf->flags & GUC_REPORT)
4272 ReportGUCOption(gconf);
4279 * Push previous state during transactional assignment to a GUC variable.
4282 push_old_value(struct config_generic * gconf, GucAction action)
4286 /* If we're not inside a nest level, do nothing */
4287 if (GUCNestLevel == 0)
4290 /* Do we already have a stack entry of the current nest level? */
4291 stack = gconf->stack;
4292 if (stack && stack->nest_level >= GUCNestLevel)
4294 /* Yes, so adjust its state if necessary */
4295 Assert(stack->nest_level == GUCNestLevel);
4298 case GUC_ACTION_SET:
4299 /* SET overrides any prior action at same nest level */
4300 if (stack->state == GUC_SET_LOCAL)
4302 /* must discard old masked value */
4303 discard_stack_value(gconf, &stack->masked);
4305 stack->state = GUC_SET;
4307 case GUC_ACTION_LOCAL:
4308 if (stack->state == GUC_SET)
4310 /* SET followed by SET LOCAL, remember SET's value */
4311 set_stack_value(gconf, &stack->masked);
4312 stack->state = GUC_SET_LOCAL;
4314 /* in all other cases, no change to stack entry */
4316 case GUC_ACTION_SAVE:
4317 /* Could only have a prior SAVE of same variable */
4318 Assert(stack->state == GUC_SAVE);
4321 Assert(guc_dirty); /* must be set already */
4326 * Push a new stack entry
4328 * We keep all the stack entries in TopTransactionContext for simplicity.
4330 stack = (GucStack *) MemoryContextAllocZero(TopTransactionContext,
4333 stack->prev = gconf->stack;
4334 stack->nest_level = GUCNestLevel;
4337 case GUC_ACTION_SET:
4338 stack->state = GUC_SET;
4340 case GUC_ACTION_LOCAL:
4341 stack->state = GUC_LOCAL;
4343 case GUC_ACTION_SAVE:
4344 stack->state = GUC_SAVE;
4347 stack->source = gconf->source;
4348 set_stack_value(gconf, &stack->prior);
4350 gconf->stack = stack;
4352 /* Ensure we remember to pop at end of xact */
4358 * Do GUC processing at main transaction start.
4364 * The nest level should be 0 between transactions; if it isn't, somebody
4365 * didn't call AtEOXact_GUC, or called it with the wrong nestLevel. We
4366 * throw a warning but make no other effort to clean up.
4368 if (GUCNestLevel != 0)
4369 elog(WARNING, "GUC nest level = %d at transaction start",
4375 * Enter a new nesting level for GUC values. This is called at subtransaction
4376 * start and when entering a function that has proconfig settings. NOTE that
4377 * we must not risk error here, else subtransaction start will be unhappy.
4380 NewGUCNestLevel(void)
4382 return ++GUCNestLevel;
4386 * Do GUC processing at transaction or subtransaction commit or abort, or
4387 * when exiting a function that has proconfig settings. (The name is thus
4388 * a bit of a misnomer; perhaps it should be ExitGUCNestLevel or some such.)
4389 * During abort, we discard all GUC settings that were applied at nesting
4390 * levels >= nestLevel. nestLevel == 1 corresponds to the main transaction.
4393 AtEOXact_GUC(bool isCommit, int nestLevel)
4399 * Note: it's possible to get here with GUCNestLevel == nestLevel-1 during
4400 * abort, if there is a failure during transaction start before
4401 * AtStart_GUC is called.
4403 Assert(nestLevel > 0 &&
4404 (nestLevel <= GUCNestLevel ||
4405 (nestLevel == GUCNestLevel + 1 && !isCommit)));
4407 /* Quick exit if nothing's changed in this transaction */
4410 GUCNestLevel = nestLevel - 1;
4414 still_dirty = false;
4415 for (i = 0; i < num_guc_variables; i++)
4417 struct config_generic *gconf = guc_variables[i];
4421 * Process and pop each stack entry within the nest level. To
4422 * simplify fmgr_security_definer(), we allow failure exit from a
4423 * function-with-SET-options to be recovered at the surrounding
4424 * transaction or subtransaction abort; so there could be more than
4425 * one stack entry to pop.
4427 while ((stack = gconf->stack) != NULL &&
4428 stack->nest_level >= nestLevel)
4430 GucStack *prev = stack->prev;
4431 bool restorePrior = false;
4432 bool restoreMasked = false;
4436 * In this next bit, if we don't set either restorePrior or
4437 * restoreMasked, we must "discard" any unwanted fields of the
4438 * stack entries to avoid leaking memory. If we do set one of
4439 * those flags, unused fields will be cleaned up after restoring.
4441 if (!isCommit) /* if abort, always restore prior value */
4442 restorePrior = true;
4443 else if (stack->state == GUC_SAVE)
4444 restorePrior = true;
4445 else if (stack->nest_level == 1)
4447 /* transaction commit */
4448 if (stack->state == GUC_SET_LOCAL)
4449 restoreMasked = true;
4450 else if (stack->state == GUC_SET)
4452 /* we keep the current active value */
4453 discard_stack_value(gconf, &stack->prior);
4455 else /* must be GUC_LOCAL */
4456 restorePrior = true;
4458 else if (prev == NULL ||
4459 prev->nest_level < stack->nest_level - 1)
4461 /* decrement entry's level and do not pop it */
4462 stack->nest_level--;
4468 * We have to merge this stack entry into prev. See README for
4469 * discussion of this bit.
4471 switch (stack->state)
4474 Assert(false); /* can't get here */
4477 /* next level always becomes SET */
4478 discard_stack_value(gconf, &stack->prior);
4479 if (prev->state == GUC_SET_LOCAL)
4480 discard_stack_value(gconf, &prev->masked);
4481 prev->state = GUC_SET;
4485 if (prev->state == GUC_SET)
4487 /* LOCAL migrates down */
4488 prev->masked = stack->prior;
4489 prev->state = GUC_SET_LOCAL;
4493 /* else just forget this stack level */
4494 discard_stack_value(gconf, &stack->prior);
4499 /* prior state at this level no longer wanted */
4500 discard_stack_value(gconf, &stack->prior);
4501 /* copy down the masked state */
4502 if (prev->state == GUC_SET_LOCAL)
4503 discard_stack_value(gconf, &prev->masked);
4504 prev->masked = stack->masked;
4505 prev->state = GUC_SET_LOCAL;
4512 if (restorePrior || restoreMasked)
4514 /* Perform appropriate restoration of the stacked value */
4515 config_var_value newvalue;
4516 GucSource newsource;
4520 newvalue = stack->masked;
4521 newsource = PGC_S_SESSION;
4525 newvalue = stack->prior;
4526 newsource = stack->source;
4529 switch (gconf->vartype)
4533 struct config_bool *conf = (struct config_bool *) gconf;
4534 bool newval = newvalue.val.boolval;
4535 void *newextra = newvalue.extra;
4537 if (*conf->variable != newval ||
4538 conf->gen.extra != newextra)
4540 if (conf->assign_hook)
4541 (*conf->assign_hook) (newval, newextra);
4542 *conf->variable = newval;
4543 set_extra_field(&conf->gen, &conf->gen.extra,
4551 struct config_int *conf = (struct config_int *) gconf;
4552 int newval = newvalue.val.intval;
4553 void *newextra = newvalue.extra;
4555 if (*conf->variable != newval ||
4556 conf->gen.extra != newextra)
4558 if (conf->assign_hook)
4559 (*conf->assign_hook) (newval, newextra);
4560 *conf->variable = newval;
4561 set_extra_field(&conf->gen, &conf->gen.extra,
4569 struct config_real *conf = (struct config_real *) gconf;
4570 double newval = newvalue.val.realval;
4571 void *newextra = newvalue.extra;
4573 if (*conf->variable != newval ||
4574 conf->gen.extra != newextra)
4576 if (conf->assign_hook)
4577 (*conf->assign_hook) (newval, newextra);
4578 *conf->variable = newval;
4579 set_extra_field(&conf->gen, &conf->gen.extra,
4587 struct config_string *conf = (struct config_string *) gconf;
4588 char *newval = newvalue.val.stringval;
4589 void *newextra = newvalue.extra;
4591 if (*conf->variable != newval ||
4592 conf->gen.extra != newextra)
4594 if (conf->assign_hook)
4595 (*conf->assign_hook) (newval, newextra);
4596 set_string_field(conf, conf->variable, newval);
4597 set_extra_field(&conf->gen, &conf->gen.extra,
4603 * Release stacked values if not used anymore. We
4604 * could use discard_stack_value() here, but since
4605 * we have type-specific code anyway, might as
4608 set_string_field(conf, &stack->prior.val.stringval, NULL);
4609 set_string_field(conf, &stack->masked.val.stringval, NULL);
4614 struct config_enum *conf = (struct config_enum *) gconf;
4615 int newval = newvalue.val.enumval;
4616 void *newextra = newvalue.extra;
4618 if (*conf->variable != newval ||
4619 conf->gen.extra != newextra)
4621 if (conf->assign_hook)
4622 (*conf->assign_hook) (newval, newextra);
4623 *conf->variable = newval;
4624 set_extra_field(&conf->gen, &conf->gen.extra,
4633 * Release stacked extra values if not used anymore.
4635 set_extra_field(gconf, &(stack->prior.extra), NULL);
4636 set_extra_field(gconf, &(stack->masked.extra), NULL);
4638 gconf->source = newsource;
4641 /* Finish popping the state stack */
4642 gconf->stack = prev;
4645 /* Report new value if we changed it */
4646 if (changed && (gconf->flags & GUC_REPORT))
4647 ReportGUCOption(gconf);
4648 } /* end of stack-popping loop */
4654 /* If there are no remaining stack entries, we can reset guc_dirty */
4655 guc_dirty = still_dirty;
4657 /* Update nesting level */
4658 GUCNestLevel = nestLevel - 1;
4663 * Start up automatic reporting of changes to variables marked GUC_REPORT.
4664 * This is executed at completion of backend startup.
4667 BeginReportingGUCOptions(void)
4672 * Don't do anything unless talking to an interactive frontend of protocol
4675 if (whereToSendOutput != DestRemote ||
4676 PG_PROTOCOL_MAJOR(FrontendProtocol) < 3)
4679 reporting_enabled = true;
4681 /* Transmit initial values of interesting variables */
4682 for (i = 0; i < num_guc_variables; i++)
4684 struct config_generic *conf = guc_variables[i];
4686 if (conf->flags & GUC_REPORT)
4687 ReportGUCOption(conf);
4692 * ReportGUCOption: if appropriate, transmit option value to frontend
4695 ReportGUCOption(struct config_generic * record)
4697 if (reporting_enabled && (record->flags & GUC_REPORT))
4699 char *val = _ShowOption(record, false);
4700 StringInfoData msgbuf;
4702 pq_beginmessage(&msgbuf, 'S');
4703 pq_sendstring(&msgbuf, record->name);
4704 pq_sendstring(&msgbuf, val);
4705 pq_endmessage(&msgbuf);
4712 * Try to parse value as an integer. The accepted formats are the
4713 * usual decimal, octal, or hexadecimal formats, optionally followed by
4714 * a unit name if "flags" indicates a unit is allowed.
4716 * If the string parses okay, return true, else false.
4717 * If okay and result is not NULL, return the value in *result.
4718 * If not okay and hintmsg is not NULL, *hintmsg is set to a suitable
4719 * HINT message, or NULL if no hint provided.
4722 parse_int(const char *value, int *result, int flags, const char **hintmsg)
4727 /* To suppress compiler warnings, always set output params */
4733 /* We assume here that int64 is at least as wide as long */
4735 val = strtol(value, &endptr, 0);
4737 if (endptr == value)
4738 return false; /* no HINT for integer syntax error */
4740 if (errno == ERANGE || val != (int64) ((int32) val))
4743 *hintmsg = gettext_noop("Value exceeds integer range.");
4747 /* allow whitespace between integer and unit */
4748 while (isspace((unsigned char) *endptr))
4751 /* Handle possible unit */
4752 if (*endptr != '\0')
4755 * Note: the multiple-switch coding technique here is a bit tedious,
4756 * but seems necessary to avoid intermediate-value overflows.
4758 if (flags & GUC_UNIT_MEMORY)
4760 /* Set hint for use if no match or trailing garbage */
4762 *hintmsg = gettext_noop("Valid units for this parameter are \"kB\", \"MB\", and \"GB\".");
4764 #if BLCKSZ < 1024 || BLCKSZ > (1024*1024)
4765 #error BLCKSZ must be between 1KB and 1MB
4767 #if XLOG_BLCKSZ < 1024 || XLOG_BLCKSZ > (1024*1024)
4768 #error XLOG_BLCKSZ must be between 1KB and 1MB
4771 if (strncmp(endptr, "kB", 2) == 0)
4774 switch (flags & GUC_UNIT_MEMORY)
4776 case GUC_UNIT_BLOCKS:
4777 val /= (BLCKSZ / 1024);
4779 case GUC_UNIT_XBLOCKS:
4780 val /= (XLOG_BLCKSZ / 1024);
4784 else if (strncmp(endptr, "MB", 2) == 0)
4787 switch (flags & GUC_UNIT_MEMORY)
4792 case GUC_UNIT_BLOCKS:
4793 val *= KB_PER_MB / (BLCKSZ / 1024);
4795 case GUC_UNIT_XBLOCKS:
4796 val *= KB_PER_MB / (XLOG_BLCKSZ / 1024);
4800 else if (strncmp(endptr, "GB", 2) == 0)
4803 switch (flags & GUC_UNIT_MEMORY)
4808 case GUC_UNIT_BLOCKS:
4809 val *= KB_PER_GB / (BLCKSZ / 1024);
4811 case GUC_UNIT_XBLOCKS:
4812 val *= KB_PER_GB / (XLOG_BLCKSZ / 1024);
4817 else if (flags & GUC_UNIT_TIME)
4819 /* Set hint for use if no match or trailing garbage */
4821 *hintmsg = gettext_noop("Valid units for this parameter are \"ms\", \"s\", \"min\", \"h\", and \"d\".");
4823 if (strncmp(endptr, "ms", 2) == 0)
4826 switch (flags & GUC_UNIT_TIME)
4836 else if (strncmp(endptr, "s", 1) == 0)
4839 switch (flags & GUC_UNIT_TIME)
4849 else if (strncmp(endptr, "min", 3) == 0)
4852 switch (flags & GUC_UNIT_TIME)
4862 else if (strncmp(endptr, "h", 1) == 0)
4865 switch (flags & GUC_UNIT_TIME)
4878 else if (strncmp(endptr, "d", 1) == 0)
4881 switch (flags & GUC_UNIT_TIME)
4896 /* allow whitespace after unit */
4897 while (isspace((unsigned char) *endptr))
4900 if (*endptr != '\0')
4901 return false; /* appropriate hint, if any, already set */
4903 /* Check for overflow due to units conversion */
4904 if (val != (int64) ((int32) val))
4907 *hintmsg = gettext_noop("Value exceeds integer range.");
4913 *result = (int) val;
4920 * Try to parse value as a floating point number in the usual format.
4921 * If the string parses okay, return true, else false.
4922 * If okay and result is not NULL, return the value in *result.
4925 parse_real(const char *value, double *result)
4931 *result = 0; /* suppress compiler warning */
4934 val = strtod(value, &endptr);
4935 if (endptr == value || errno == ERANGE)
4938 /* allow whitespace after number */
4939 while (isspace((unsigned char) *endptr))
4941 if (*endptr != '\0')
4951 * Lookup the name for an enum option with the selected value.
4952 * Should only ever be called with known-valid values, so throws
4953 * an elog(ERROR) if the enum option is not found.
4955 * The returned string is a pointer to static data and not
4956 * allocated for modification.
4959 config_enum_lookup_by_value(struct config_enum * record, int val)
4961 const struct config_enum_entry *entry;
4963 for (entry = record->options; entry && entry->name; entry++)
4965 if (entry->val == val)
4969 elog(ERROR, "could not find enum option %d for %s",
4970 val, record->gen.name);
4971 return NULL; /* silence compiler */
4976 * Lookup the value for an enum option with the selected name
4977 * (case-insensitive).
4978 * If the enum option is found, sets the retval value and returns
4979 * true. If it's not found, return FALSE and retval is set to 0.
4982 config_enum_lookup_by_name(struct config_enum * record, const char *value,
4985 const struct config_enum_entry *entry;
4987 for (entry = record->options; entry && entry->name; entry++)
4989 if (pg_strcasecmp(value, entry->name) == 0)
4991 *retval = entry->val;
5002 * Return a list of all available options for an enum, excluding
5003 * hidden ones, separated by the given separator.
5004 * If prefix is non-NULL, it is added before the first enum value.
5005 * If suffix is non-NULL, it is added to the end of the string.
5008 config_enum_get_options(struct config_enum * record, const char *prefix,
5009 const char *suffix, const char *separator)
5011 const struct config_enum_entry *entry;
5012 StringInfoData retstr;
5015 initStringInfo(&retstr);
5016 appendStringInfoString(&retstr, prefix);
5018 seplen = strlen(separator);
5019 for (entry = record->options; entry && entry->name; entry++)
5023 appendStringInfoString(&retstr, entry->name);
5024 appendBinaryStringInfo(&retstr, separator, seplen);
5029 * All the entries may have been hidden, leaving the string empty if no
5030 * prefix was given. This indicates a broken GUC setup, since there is no
5031 * use for an enum without any values, so we just check to make sure we
5032 * don't write to invalid memory instead of actually trying to do
5033 * something smart with it.
5035 if (retstr.len >= seplen)
5037 /* Replace final separator */
5038 retstr.data[retstr.len - seplen] = '\0';
5039 retstr.len -= seplen;
5042 appendStringInfoString(&retstr, suffix);
5049 * Sets option `name' to given value.
5051 * The value should be a string, which will be parsed and converted to
5052 * the appropriate data type. The context and source parameters indicate
5053 * in which context this function is being called, so that it can apply the
5054 * access restrictions properly.
5056 * If value is NULL, set the option to its default value (normally the
5057 * reset_val, but if source == PGC_S_DEFAULT we instead use the boot_val).
5059 * action indicates whether to set the value globally in the session, locally
5060 * to the current top transaction, or just for the duration of a function call.
5062 * If changeVal is false then don't really set the option but do all
5063 * the checks to see if it would work.
5066 * +1: the value is valid and was successfully applied.
5067 * 0: the name or value is invalid (but see below).
5068 * -1: the value was not applied because of context, priority, or changeVal.
5070 * If there is an error (non-existing option, invalid value) then an
5071 * ereport(ERROR) is thrown *unless* this is called for a source for which
5072 * we don't want an ERROR (currently, those are defaults, the config file,
5073 * and per-database or per-user settings). In those cases we write a
5074 * suitable error message via ereport() and return 0.
5076 * See also SetConfigOption for an external interface.
5079 set_config_option(const char *name, const char *value,
5080 GucContext context, GucSource source,
5081 GucAction action, bool changeVal)
5083 struct config_generic *record;
5085 bool prohibitValueChange = false;
5088 if (source == PGC_S_DEFAULT || source == PGC_S_FILE)
5091 * To avoid cluttering the log, only the postmaster bleats loudly
5092 * about problems with the config file.
5094 elevel = IsUnderPostmaster ? DEBUG3 : LOG;
5096 else if (source == PGC_S_DATABASE || source == PGC_S_USER ||
5097 source == PGC_S_DATABASE_USER)
5102 record = find_option(name, true, elevel);
5106 (errcode(ERRCODE_UNDEFINED_OBJECT),
5107 errmsg("unrecognized configuration parameter \"%s\"", name)));
5112 * Check if the option can be set at this time. See guc.h for the precise
5115 switch (record->context)
5118 if (context != PGC_INTERNAL)
5121 (errcode(ERRCODE_CANT_CHANGE_RUNTIME_PARAM),
5122 errmsg("parameter \"%s\" cannot be changed",
5127 case PGC_POSTMASTER:
5128 if (context == PGC_SIGHUP)
5131 * We are re-reading a PGC_POSTMASTER variable from
5132 * postgresql.conf. We can't change the setting, so we should
5133 * give a warning if the DBA tries to change it. However,
5134 * because of variant formats, canonicalization by check
5135 * hooks, etc, we can't just compare the given string directly
5136 * to what's stored. Set a flag to check below after we have
5137 * the final storable value.
5139 prohibitValueChange = true;
5141 else if (context != PGC_POSTMASTER)
5144 (errcode(ERRCODE_CANT_CHANGE_RUNTIME_PARAM),
5145 errmsg("parameter \"%s\" cannot be changed without restarting the server",
5151 if (context != PGC_SIGHUP && context != PGC_POSTMASTER)
5154 (errcode(ERRCODE_CANT_CHANGE_RUNTIME_PARAM),
5155 errmsg("parameter \"%s\" cannot be changed now",
5161 * Hmm, the idea of the SIGHUP context is "ought to be global, but
5162 * can be changed after postmaster start". But there's nothing
5163 * that prevents a crafty administrator from sending SIGHUP
5164 * signals to individual backends only.
5168 if (context == PGC_SIGHUP)
5171 * If a PGC_BACKEND parameter is changed in the config file,
5172 * we want to accept the new value in the postmaster (whence
5173 * it will propagate to subsequently-started backends), but
5174 * ignore it in existing backends. This is a tad klugy, but
5175 * necessary because we don't re-read the config file during
5178 if (IsUnderPostmaster)
5181 else if (context != PGC_POSTMASTER && context != PGC_BACKEND &&
5182 source != PGC_S_CLIENT)
5185 (errcode(ERRCODE_CANT_CHANGE_RUNTIME_PARAM),
5186 errmsg("parameter \"%s\" cannot be set after connection start",
5192 if (context == PGC_USERSET || context == PGC_BACKEND)
5195 (errcode(ERRCODE_INSUFFICIENT_PRIVILEGE),
5196 errmsg("permission denied to set parameter \"%s\"",
5207 * Disallow changing GUC_NOT_WHILE_SEC_REST values if we are inside a
5208 * security restriction context. We can reject this regardless of the GUC
5209 * context or source, mainly because sources that it might be reasonable
5210 * to override for won't be seen while inside a function.
5212 * Note: variables marked GUC_NOT_WHILE_SEC_REST should usually be marked
5213 * GUC_NO_RESET_ALL as well, because ResetAllOptions() doesn't check this.
5214 * An exception might be made if the reset value is assumed to be "safe".
5216 * Note: this flag is currently used for "session_authorization" and
5217 * "role". We need to prohibit changing these inside a local userid
5218 * context because when we exit it, GUC won't be notified, leaving things
5219 * out of sync. (This could be fixed by forcing a new GUC nesting level,
5220 * but that would change behavior in possibly-undesirable ways.) Also, we
5221 * prohibit changing these in a security-restricted operation because
5222 * otherwise RESET could be used to regain the session user's privileges.
5224 if (record->flags & GUC_NOT_WHILE_SEC_REST)
5226 if (InLocalUserIdChange())
5229 * Phrasing of this error message is historical, but it's the most
5233 (errcode(ERRCODE_INSUFFICIENT_PRIVILEGE),
5234 errmsg("cannot set parameter \"%s\" within security-definer function",
5238 if (InSecurityRestrictedOperation())
5241 (errcode(ERRCODE_INSUFFICIENT_PRIVILEGE),
5242 errmsg("cannot set parameter \"%s\" within security-restricted operation",
5249 * Should we set reset/stacked values? (If so, the behavior is not
5250 * transactional.) This is done either when we get a default value from
5251 * the database's/user's/client's default settings or when we reset a
5252 * value to its default.
5254 makeDefault = changeVal && (source <= PGC_S_OVERRIDE) &&
5255 ((value != NULL) || source == PGC_S_DEFAULT);
5258 * Ignore attempted set if overridden by previously processed setting.
5259 * However, if changeVal is false then plow ahead anyway since we are
5260 * trying to find out if the value is potentially good, not actually use
5261 * it. Also keep going if makeDefault is true, since we may want to set
5262 * the reset/stacked values even if we can't set the variable itself.
5264 if (record->source > source)
5266 if (changeVal && !makeDefault)
5268 elog(DEBUG3, "\"%s\": setting ignored because previous source is higher priority",
5276 * Evaluate value and set variable.
5278 switch (record->vartype)
5282 struct config_bool *conf = (struct config_bool *) record;
5284 void *newextra = NULL;
5288 if (!parse_bool(value, &newval))
5291 (errcode(ERRCODE_INVALID_PARAMETER_VALUE),
5292 errmsg("parameter \"%s\" requires a Boolean value",
5296 if (!call_bool_check_hook(conf, &newval, &newextra,
5300 else if (source == PGC_S_DEFAULT)
5302 newval = conf->boot_val;
5303 if (!call_bool_check_hook(conf, &newval, &newextra,
5309 newval = conf->reset_val;
5310 newextra = conf->reset_extra;
5311 source = conf->gen.reset_source;
5314 if (prohibitValueChange)
5316 if (*conf->variable != newval)
5319 (errcode(ERRCODE_CANT_CHANGE_RUNTIME_PARAM),
5320 errmsg("parameter \"%s\" cannot be changed without restarting the server",
5329 /* Save old value to support transaction abort */
5331 push_old_value(&conf->gen, action);
5333 if (conf->assign_hook)
5334 (*conf->assign_hook) (newval, newextra);
5335 *conf->variable = newval;
5336 set_extra_field(&conf->gen, &conf->gen.extra,
5338 conf->gen.source = source;
5344 if (conf->gen.reset_source <= source)
5346 conf->reset_val = newval;
5347 set_extra_field(&conf->gen, &conf->reset_extra,
5349 conf->gen.reset_source = source;
5351 for (stack = conf->gen.stack; stack; stack = stack->prev)
5353 if (stack->source <= source)
5355 stack->prior.val.boolval = newval;
5356 set_extra_field(&conf->gen, &stack->prior.extra,
5358 stack->source = source;
5363 /* Perhaps we didn't install newextra anywhere */
5364 if (newextra && !extra_field_used(&conf->gen, newextra))
5371 struct config_int *conf = (struct config_int *) record;
5373 void *newextra = NULL;
5377 const char *hintmsg;
5379 if (!parse_int(value, &newval, conf->gen.flags, &hintmsg))
5382 (errcode(ERRCODE_INVALID_PARAMETER_VALUE),
5383 errmsg("invalid value for parameter \"%s\": \"%s\"",
5385 hintmsg ? errhint("%s", _(hintmsg)) : 0));
5388 if (newval < conf->min || newval > conf->max)
5391 (errcode(ERRCODE_INVALID_PARAMETER_VALUE),
5392 errmsg("%d is outside the valid range for parameter \"%s\" (%d .. %d)",
5393 newval, name, conf->min, conf->max)));
5396 if (!call_int_check_hook(conf, &newval, &newextra,
5400 else if (source == PGC_S_DEFAULT)
5402 newval = conf->boot_val;
5403 if (!call_int_check_hook(conf, &newval, &newextra,
5409 newval = conf->reset_val;
5410 newextra = conf->reset_extra;
5411 source = conf->gen.reset_source;
5414 if (prohibitValueChange)
5416 if (*conf->variable != newval)
5419 (errcode(ERRCODE_CANT_CHANGE_RUNTIME_PARAM),
5420 errmsg("parameter \"%s\" cannot be changed without restarting the server",
5429 /* Save old value to support transaction abort */
5431 push_old_value(&conf->gen, action);
5433 if (conf->assign_hook)
5434 (*conf->assign_hook) (newval, newextra);
5435 *conf->variable = newval;
5436 set_extra_field(&conf->gen, &conf->gen.extra,
5438 conf->gen.source = source;
5444 if (conf->gen.reset_source <= source)
5446 conf->reset_val = newval;
5447 set_extra_field(&conf->gen, &conf->reset_extra,
5449 conf->gen.reset_source = source;
5451 for (stack = conf->gen.stack; stack; stack = stack->prev)
5453 if (stack->source <= source)
5455 stack->prior.val.intval = newval;
5456 set_extra_field(&conf->gen, &stack->prior.extra,
5458 stack->source = source;
5463 /* Perhaps we didn't install newextra anywhere */
5464 if (newextra && !extra_field_used(&conf->gen, newextra))
5471 struct config_real *conf = (struct config_real *) record;
5473 void *newextra = NULL;
5477 if (!parse_real(value, &newval))
5480 (errcode(ERRCODE_INVALID_PARAMETER_VALUE),
5481 errmsg("parameter \"%s\" requires a numeric value",
5485 if (newval < conf->min || newval > conf->max)
5488 (errcode(ERRCODE_INVALID_PARAMETER_VALUE),
5489 errmsg("%g is outside the valid range for parameter \"%s\" (%g .. %g)",
5490 newval, name, conf->min, conf->max)));
5493 if (!call_real_check_hook(conf, &newval, &newextra,
5497 else if (source == PGC_S_DEFAULT)
5499 newval = conf->boot_val;
5500 if (!call_real_check_hook(conf, &newval, &newextra,
5506 newval = conf->reset_val;
5507 newextra = conf->reset_extra;
5508 source = conf->gen.reset_source;
5511 if (prohibitValueChange)
5513 if (*conf->variable != newval)
5516 (errcode(ERRCODE_CANT_CHANGE_RUNTIME_PARAM),
5517 errmsg("parameter \"%s\" cannot be changed without restarting the server",
5526 /* Save old value to support transaction abort */
5528 push_old_value(&conf->gen, action);
5530 if (conf->assign_hook)
5531 (*conf->assign_hook) (newval, newextra);
5532 *conf->variable = newval;
5533 set_extra_field(&conf->gen, &conf->gen.extra,
5535 conf->gen.source = source;
5541 if (conf->gen.reset_source <= source)
5543 conf->reset_val = newval;
5544 set_extra_field(&conf->gen, &conf->reset_extra,
5546 conf->gen.reset_source = source;
5548 for (stack = conf->gen.stack; stack; stack = stack->prev)
5550 if (stack->source <= source)
5552 stack->prior.val.realval = newval;
5553 set_extra_field(&conf->gen, &stack->prior.extra,
5555 stack->source = source;
5560 /* Perhaps we didn't install newextra anywhere */
5561 if (newextra && !extra_field_used(&conf->gen, newextra))
5568 struct config_string *conf = (struct config_string *) record;
5570 void *newextra = NULL;
5575 * The value passed by the caller could be transient, so
5576 * we always strdup it.
5578 newval = guc_strdup(elevel, value);
5583 * The only built-in "parsing" check we have is to apply
5584 * truncation if GUC_IS_NAME.
5586 if (conf->gen.flags & GUC_IS_NAME)
5587 truncate_identifier(newval, strlen(newval), true);
5589 if (!call_string_check_hook(conf, &newval, &newextra,
5596 else if (source == PGC_S_DEFAULT)
5598 /* non-NULL boot_val must always get strdup'd */
5599 if (conf->boot_val != NULL)
5601 newval = guc_strdup(elevel, conf->boot_val);
5608 if (!call_string_check_hook(conf, &newval, &newextra,
5618 * strdup not needed, since reset_val is already under
5621 newval = conf->reset_val;
5622 newextra = conf->reset_extra;
5623 source = conf->gen.reset_source;
5626 if (prohibitValueChange)
5628 /* newval shouldn't be NULL, so we're a bit sloppy here */
5629 if (*conf->variable == NULL || newval == NULL ||
5630 strcmp(*conf->variable, newval) != 0)
5633 (errcode(ERRCODE_CANT_CHANGE_RUNTIME_PARAM),
5634 errmsg("parameter \"%s\" cannot be changed without restarting the server",
5643 /* Save old value to support transaction abort */
5645 push_old_value(&conf->gen, action);
5647 if (conf->assign_hook)
5648 (*conf->assign_hook) (newval, newextra);
5649 set_string_field(conf, conf->variable, newval);
5650 set_extra_field(&conf->gen, &conf->gen.extra,
5652 conf->gen.source = source;
5659 if (conf->gen.reset_source <= source)
5661 set_string_field(conf, &conf->reset_val, newval);
5662 set_extra_field(&conf->gen, &conf->reset_extra,
5664 conf->gen.reset_source = source;
5666 for (stack = conf->gen.stack; stack; stack = stack->prev)
5668 if (stack->source <= source)
5670 set_string_field(conf, &stack->prior.val.stringval,
5672 set_extra_field(&conf->gen, &stack->prior.extra,
5674 stack->source = source;
5679 /* Perhaps we didn't install newval anywhere */
5680 if (newval && !string_field_used(conf, newval))
5682 /* Perhaps we didn't install newextra anywhere */
5683 if (newextra && !extra_field_used(&conf->gen, newextra))
5690 struct config_enum *conf = (struct config_enum *) record;
5692 void *newextra = NULL;
5696 if (!config_enum_lookup_by_name(conf, value, &newval))
5700 hintmsg = config_enum_get_options(conf,
5701 "Available values: ",
5705 (errcode(ERRCODE_INVALID_PARAMETER_VALUE),
5706 errmsg("invalid value for parameter \"%s\": \"%s\"",
5708 hintmsg ? errhint("%s", _(hintmsg)) : 0));
5714 if (!call_enum_check_hook(conf, &newval, &newextra,
5718 else if (source == PGC_S_DEFAULT)
5720 newval = conf->boot_val;
5721 if (!call_enum_check_hook(conf, &newval, &newextra,
5727 newval = conf->reset_val;
5728 newextra = conf->reset_extra;
5729 source = conf->gen.reset_source;
5732 if (prohibitValueChange)
5734 if (*conf->variable != newval)
5737 (errcode(ERRCODE_CANT_CHANGE_RUNTIME_PARAM),
5738 errmsg("parameter \"%s\" cannot be changed without restarting the server",
5747 /* Save old value to support transaction abort */
5749 push_old_value(&conf->gen, action);
5751 if (conf->assign_hook)
5752 (*conf->assign_hook) (newval, newextra);
5753 *conf->variable = newval;
5754 set_extra_field(&conf->gen, &conf->gen.extra,
5756 conf->gen.source = source;
5762 if (conf->gen.reset_source <= source)
5764 conf->reset_val = newval;
5765 set_extra_field(&conf->gen, &conf->reset_extra,
5767 conf->gen.reset_source = source;
5769 for (stack = conf->gen.stack; stack; stack = stack->prev)
5771 if (stack->source <= source)
5773 stack->prior.val.enumval = newval;
5774 set_extra_field(&conf->gen, &stack->prior.extra,
5776 stack->source = source;
5781 /* Perhaps we didn't install newextra anywhere */
5782 if (newextra && !extra_field_used(&conf->gen, newextra))
5788 if (changeVal && (record->flags & GUC_REPORT))
5789 ReportGUCOption(record);
5791 return changeVal ? 1 : -1;
5796 * Set the fields for source file and line number the setting came from.
5799 set_config_sourcefile(const char *name, char *sourcefile, int sourceline)
5801 struct config_generic *record;
5805 * To avoid cluttering the log, only the postmaster bleats loudly about
5806 * problems with the config file.
5808 elevel = IsUnderPostmaster ? DEBUG3 : LOG;
5810 record = find_option(name, true, elevel);
5811 /* should not happen */
5813 elog(ERROR, "unrecognized configuration parameter \"%s\"", name);
5815 sourcefile = guc_strdup(elevel, sourcefile);
5816 if (record->sourcefile)
5817 free(record->sourcefile);
5818 record->sourcefile = sourcefile;
5819 record->sourceline = sourceline;
5823 * Set a config option to the given value. See also set_config_option,
5824 * this is just the wrapper to be called from outside GUC. NB: this
5825 * is used only for non-transactional operations.
5827 * Note: there is no support here for setting source file/line, as it
5828 * is currently not needed.
5831 SetConfigOption(const char *name, const char *value,
5832 GucContext context, GucSource source)
5834 (void) set_config_option(name, value, context, source,
5835 GUC_ACTION_SET, true);
5841 * Fetch the current value of the option `name', as a string.
5843 * If the option doesn't exist, return NULL if missing_ok is true (NOTE that
5844 * this cannot be distinguished from a string variable with a NULL value!),
5845 * otherwise throw an ereport and don't return.
5847 * If restrict_superuser is true, we also enforce that only superusers can
5848 * see GUC_SUPERUSER_ONLY variables. This should only be passed as true
5849 * in user-driven calls.
5851 * The string is *not* allocated for modification and is really only
5852 * valid until the next call to configuration related functions.
5855 GetConfigOption(const char *name, bool missing_ok, bool restrict_superuser)
5857 struct config_generic *record;
5858 static char buffer[256];
5860 record = find_option(name, false, ERROR);
5866 (errcode(ERRCODE_UNDEFINED_OBJECT),
5867 errmsg("unrecognized configuration parameter \"%s\"",
5870 if (restrict_superuser &&
5871 (record->flags & GUC_SUPERUSER_ONLY) &&
5874 (errcode(ERRCODE_INSUFFICIENT_PRIVILEGE),
5875 errmsg("must be superuser to examine \"%s\"", name)));
5877 switch (record->vartype)
5880 return *((struct config_bool *) record)->variable ? "on" : "off";
5883 snprintf(buffer, sizeof(buffer), "%d",
5884 *((struct config_int *) record)->variable);
5888 snprintf(buffer, sizeof(buffer), "%g",
5889 *((struct config_real *) record)->variable);
5893 return *((struct config_string *) record)->variable;
5896 return config_enum_lookup_by_value((struct config_enum *) record,
5897 *((struct config_enum *) record)->variable);
5903 * Get the RESET value associated with the given option.
5905 * Note: this is not re-entrant, due to use of static result buffer;
5906 * not to mention that a string variable could have its reset_val changed.
5907 * Beware of assuming the result value is good for very long.
5910 GetConfigOptionResetString(const char *name)
5912 struct config_generic *record;
5913 static char buffer[256];
5915 record = find_option(name, false, ERROR);
5918 (errcode(ERRCODE_UNDEFINED_OBJECT),
5919 errmsg("unrecognized configuration parameter \"%s\"", name)));
5920 if ((record->flags & GUC_SUPERUSER_ONLY) && !superuser())
5922 (errcode(ERRCODE_INSUFFICIENT_PRIVILEGE),
5923 errmsg("must be superuser to examine \"%s\"", name)));
5925 switch (record->vartype)
5928 return ((struct config_bool *) record)->reset_val ? "on" : "off";
5931 snprintf(buffer, sizeof(buffer), "%d",
5932 ((struct config_int *) record)->reset_val);
5936 snprintf(buffer, sizeof(buffer), "%g",
5937 ((struct config_real *) record)->reset_val);
5941 return ((struct config_string *) record)->reset_val;
5944 return config_enum_lookup_by_value((struct config_enum *) record,
5945 ((struct config_enum *) record)->reset_val);
5952 * flatten_set_variable_args
5953 * Given a parsenode List as emitted by the grammar for SET,
5954 * convert to the flat string representation used by GUC.
5956 * We need to be told the name of the variable the args are for, because
5957 * the flattening rules vary (ugh).
5959 * The result is NULL if args is NIL (ie, SET ... TO DEFAULT), otherwise
5960 * a palloc'd string.
5963 flatten_set_variable_args(const char *name, List *args)
5965 struct config_generic *record;
5970 /* Fast path if just DEFAULT */
5975 * Get flags for the variable; if it's not known, use default flags.
5976 * (Caller might throw error later, but not our business to do so here.)
5978 record = find_option(name, false, WARNING);
5980 flags = record->flags;
5984 /* Complain if list input and non-list variable */
5985 if ((flags & GUC_LIST_INPUT) == 0 &&
5986 list_length(args) != 1)
5988 (errcode(ERRCODE_INVALID_PARAMETER_VALUE),
5989 errmsg("SET %s takes only one argument", name)));
5991 initStringInfo(&buf);
5994 * Each list member may be a plain A_Const node, or an A_Const within a
5995 * TypeCast; the latter case is supported only for ConstInterval arguments
5996 * (for SET TIME ZONE).
6000 Node *arg = (Node *) lfirst(l);
6002 TypeName *typeName = NULL;
6005 if (l != list_head(args))
6006 appendStringInfo(&buf, ", ");
6008 if (IsA(arg, TypeCast))
6010 TypeCast *tc = (TypeCast *) arg;
6013 typeName = tc->typeName;
6016 if (!IsA(arg, A_Const))
6017 elog(ERROR, "unrecognized node type: %d", (int) nodeTag(arg));
6018 con = (A_Const *) arg;
6020 switch (nodeTag(&con->val))
6023 appendStringInfo(&buf, "%ld", intVal(&con->val));
6026 /* represented as a string, so just copy it */
6027 appendStringInfoString(&buf, strVal(&con->val));
6030 val = strVal(&con->val);
6031 if (typeName != NULL)
6034 * Must be a ConstInterval argument for TIME ZONE. Coerce
6035 * to interval and back to normalize the value and account
6043 typenameTypeIdAndMod(NULL, typeName, &typoid, &typmod);
6044 Assert(typoid == INTERVALOID);
6047 DirectFunctionCall3(interval_in,
6048 CStringGetDatum(val),
6049 ObjectIdGetDatum(InvalidOid),
6050 Int32GetDatum(typmod));
6053 DatumGetCString(DirectFunctionCall1(interval_out,
6055 appendStringInfo(&buf, "INTERVAL '%s'", intervalout);
6060 * Plain string literal or identifier. For quote mode,
6061 * quote it if it's not a vanilla identifier.
6063 if (flags & GUC_LIST_QUOTE)
6064 appendStringInfoString(&buf, quote_identifier(val));
6066 appendStringInfoString(&buf, val);
6070 elog(ERROR, "unrecognized node type: %d",
6071 (int) nodeTag(&con->val));
6084 ExecSetVariableStmt(VariableSetStmt *stmt)
6086 GucAction action = stmt->is_local ? GUC_ACTION_LOCAL : GUC_ACTION_SET;
6091 case VAR_SET_CURRENT:
6092 (void) set_config_option(stmt->name,
6093 ExtractSetVariableArgs(stmt),
6094 (superuser() ? PGC_SUSET : PGC_USERSET),
6102 * Special case for special SQL syntax that effectively sets more
6103 * than one variable per statement.
6105 if (strcmp(stmt->name, "TRANSACTION") == 0)
6109 foreach(head, stmt->args)
6111 DefElem *item = (DefElem *) lfirst(head);
6113 if (strcmp(item->defname, "transaction_isolation") == 0)
6114 SetPGVariable("transaction_isolation",
6115 list_make1(item->arg), stmt->is_local);
6116 else if (strcmp(item->defname, "transaction_read_only") == 0)
6117 SetPGVariable("transaction_read_only",
6118 list_make1(item->arg), stmt->is_local);
6119 else if (strcmp(item->defname, "transaction_deferrable") == 0)
6120 SetPGVariable("transaction_deferrable",
6121 list_make1(item->arg), stmt->is_local);
6123 elog(ERROR, "unexpected SET TRANSACTION element: %s",
6127 else if (strcmp(stmt->name, "SESSION CHARACTERISTICS") == 0)
6131 foreach(head, stmt->args)
6133 DefElem *item = (DefElem *) lfirst(head);
6135 if (strcmp(item->defname, "transaction_isolation") == 0)
6136 SetPGVariable("default_transaction_isolation",
6137 list_make1(item->arg), stmt->is_local);
6138 else if (strcmp(item->defname, "transaction_read_only") == 0)
6139 SetPGVariable("default_transaction_read_only",
6140 list_make1(item->arg), stmt->is_local);
6141 else if (strcmp(item->defname, "transaction_deferrable") == 0)
6142 SetPGVariable("default_transaction_deferrable",
6143 list_make1(item->arg), stmt->is_local);
6145 elog(ERROR, "unexpected SET SESSION element: %s",
6150 elog(ERROR, "unexpected SET MULTI element: %s",
6153 case VAR_SET_DEFAULT:
6155 (void) set_config_option(stmt->name,
6157 (superuser() ? PGC_SUSET : PGC_USERSET),
6169 * Get the value to assign for a VariableSetStmt, or NULL if it's RESET.
6170 * The result is palloc'd.
6172 * This is exported for use by actions such as ALTER ROLE SET.
6175 ExtractSetVariableArgs(VariableSetStmt *stmt)
6180 return flatten_set_variable_args(stmt->name, stmt->args);
6181 case VAR_SET_CURRENT:
6182 return GetConfigOptionByName(stmt->name, NULL);
6189 * SetPGVariable - SET command exported as an easily-C-callable function.
6191 * This provides access to SET TO value, as well as SET TO DEFAULT (expressed
6192 * by passing args == NIL), but not SET FROM CURRENT functionality.
6195 SetPGVariable(const char *name, List *args, bool is_local)
6197 char *argstring = flatten_set_variable_args(name, args);
6199 /* Note SET DEFAULT (argstring == NULL) is equivalent to RESET */
6200 (void) set_config_option(name,
6202 (superuser() ? PGC_SUSET : PGC_USERSET),
6204 is_local ? GUC_ACTION_LOCAL : GUC_ACTION_SET,
6209 * SET command wrapped as a SQL callable function.
6212 set_config_by_name(PG_FUNCTION_ARGS)
6219 if (PG_ARGISNULL(0))
6221 (errcode(ERRCODE_NULL_VALUE_NOT_ALLOWED),
6222 errmsg("SET requires parameter name")));
6224 /* Get the GUC variable name */
6225 name = TextDatumGetCString(PG_GETARG_DATUM(0));
6227 /* Get the desired value or set to NULL for a reset request */
6228 if (PG_ARGISNULL(1))
6231 value = TextDatumGetCString(PG_GETARG_DATUM(1));
6234 * Get the desired state of is_local. Default to false if provided value
6237 if (PG_ARGISNULL(2))
6240 is_local = PG_GETARG_BOOL(2);
6242 /* Note SET DEFAULT (argstring == NULL) is equivalent to RESET */
6243 (void) set_config_option(name,
6245 (superuser() ? PGC_SUSET : PGC_USERSET),
6247 is_local ? GUC_ACTION_LOCAL : GUC_ACTION_SET,
6250 /* get the new current value */
6251 new_value = GetConfigOptionByName(name, NULL);
6253 /* Convert return string to text */
6254 PG_RETURN_TEXT_P(cstring_to_text(new_value));
6259 * Common code for DefineCustomXXXVariable subroutines: allocate the
6260 * new variable's config struct and fill in generic fields.
6262 static struct config_generic *
6263 init_custom_variable(const char *name,
6264 const char *short_desc,
6265 const char *long_desc,
6268 enum config_type type,
6271 struct config_generic *gen;
6274 * Only allow custom PGC_POSTMASTER variables to be created during shared
6275 * library preload; any later than that, we can't ensure that the value
6276 * doesn't change after startup. This is a fatal elog if it happens; just
6277 * erroring out isn't safe because we don't know what the calling loadable
6278 * module might already have hooked into.
6280 if (context == PGC_POSTMASTER &&
6281 !process_shared_preload_libraries_in_progress)
6282 elog(FATAL, "cannot create PGC_POSTMASTER variables after startup");
6284 gen = (struct config_generic *) guc_malloc(ERROR, sz);
6287 gen->name = guc_strdup(ERROR, name);
6288 gen->context = context;
6289 gen->group = CUSTOM_OPTIONS;
6290 gen->short_desc = short_desc;
6291 gen->long_desc = long_desc;
6293 gen->vartype = type;
6299 * Common code for DefineCustomXXXVariable subroutines: insert the new
6300 * variable into the GUC variable array, replacing any placeholder.
6303 define_custom_variable(struct config_generic * variable)
6305 const char *name = variable->name;
6306 const char **nameAddr = &name;
6308 struct config_string *pHolder;
6309 GucContext phcontext;
6310 struct config_generic **res;
6313 * See if there's a placeholder by the same name.
6315 res = (struct config_generic **) bsearch((void *) &nameAddr,
6316 (void *) guc_variables,
6318 sizeof(struct config_generic *),
6323 * No placeholder to replace, so we can just add it ... but first,
6324 * make sure it's initialized to its default value.
6326 InitializeOneGUCOption(variable);
6327 add_guc_variable(variable, ERROR);
6332 * This better be a placeholder
6334 if (((*res)->flags & GUC_CUSTOM_PLACEHOLDER) == 0)
6336 (errcode(ERRCODE_INTERNAL_ERROR),
6337 errmsg("attempt to redefine parameter \"%s\"", name)));
6339 Assert((*res)->vartype == PGC_STRING);
6340 pHolder = (struct config_string *) (*res);
6343 * First, set the variable to its default value. We must do this even
6344 * though we intend to immediately apply a new value, since it's possible
6345 * that the new value is invalid.
6347 InitializeOneGUCOption(variable);
6350 * Replace the placeholder. We aren't changing the name, so no re-sorting
6356 * Infer context for assignment based on source of existing value. We
6357 * can't tell this with exact accuracy, but we can at least do something
6358 * reasonable in typical cases.
6360 switch (pHolder->gen.source)
6363 case PGC_S_DYNAMIC_DEFAULT:
6369 * If we got past the check in init_custom_variable, we can safely
6370 * assume that any existing value for a PGC_POSTMASTER variable
6371 * was set in postmaster context.
6373 if (variable->context == PGC_POSTMASTER)
6374 phcontext = PGC_POSTMASTER;
6376 phcontext = PGC_SIGHUP;
6379 case PGC_S_DATABASE:
6381 case PGC_S_DATABASE_USER:
6384 * The existing value came from an ALTER ROLE/DATABASE SET
6385 * command. We can assume that at the time the command was issued,
6386 * we checked that the issuing user was superuser if the variable
6387 * requires superuser privileges to set. So it's safe to use
6388 * SUSET context here.
6390 phcontext = PGC_SUSET;
6398 * We must assume that the value came from an untrusted user, even
6399 * if the current_user is a superuser.
6401 phcontext = PGC_USERSET;
6406 * Assign the string value stored in the placeholder to the real variable.
6408 * XXX this is not really good enough --- it should be a nontransactional
6409 * assignment, since we don't want it to roll back if the current xact
6410 * fails later. (Or do we?)
6412 value = *pHolder->variable;
6416 if (set_config_option(name, value,
6417 phcontext, pHolder->gen.source,
6418 GUC_ACTION_SET, true) > 0)
6420 /* Also copy over any saved source-location information */
6421 if (pHolder->gen.sourcefile)
6422 set_config_sourcefile(name, pHolder->gen.sourcefile,
6423 pHolder->gen.sourceline);
6428 * Free up as much as we conveniently can of the placeholder structure
6429 * (this neglects any stack items...)
6431 set_string_field(pHolder, pHolder->variable, NULL);
6432 set_string_field(pHolder, &pHolder->reset_val, NULL);
6438 DefineCustomBoolVariable(const char *name,
6439 const char *short_desc,
6440 const char *long_desc,
6445 GucBoolCheckHook check_hook,
6446 GucBoolAssignHook assign_hook,
6447 GucShowHook show_hook)
6449 struct config_bool *var;
6451 var = (struct config_bool *)
6452 init_custom_variable(name, short_desc, long_desc, context, flags,
6453 PGC_BOOL, sizeof(struct config_bool));
6454 var->variable = valueAddr;
6455 var->boot_val = bootValue;
6456 var->reset_val = bootValue;
6457 var->check_hook = check_hook;
6458 var->assign_hook = assign_hook;
6459 var->show_hook = show_hook;
6460 define_custom_variable(&var->gen);
6464 DefineCustomIntVariable(const char *name,
6465 const char *short_desc,
6466 const char *long_desc,
6473 GucIntCheckHook check_hook,
6474 GucIntAssignHook assign_hook,
6475 GucShowHook show_hook)
6477 struct config_int *var;
6479 var = (struct config_int *)
6480 init_custom_variable(name, short_desc, long_desc, context, flags,
6481 PGC_INT, sizeof(struct config_int));
6482 var->variable = valueAddr;
6483 var->boot_val = bootValue;
6484 var->reset_val = bootValue;
6485 var->min = minValue;
6486 var->max = maxValue;
6487 var->check_hook = check_hook;
6488 var->assign_hook = assign_hook;
6489 var->show_hook = show_hook;
6490 define_custom_variable(&var->gen);
6494 DefineCustomRealVariable(const char *name,
6495 const char *short_desc,
6496 const char *long_desc,
6503 GucRealCheckHook check_hook,
6504 GucRealAssignHook assign_hook,
6505 GucShowHook show_hook)
6507 struct config_real *var;
6509 var = (struct config_real *)
6510 init_custom_variable(name, short_desc, long_desc, context, flags,
6511 PGC_REAL, sizeof(struct config_real));
6512 var->variable = valueAddr;
6513 var->boot_val = bootValue;
6514 var->reset_val = bootValue;
6515 var->min = minValue;
6516 var->max = maxValue;
6517 var->check_hook = check_hook;
6518 var->assign_hook = assign_hook;
6519 var->show_hook = show_hook;
6520 define_custom_variable(&var->gen);
6524 DefineCustomStringVariable(const char *name,
6525 const char *short_desc,
6526 const char *long_desc,
6528 const char *bootValue,
6531 GucStringCheckHook check_hook,
6532 GucStringAssignHook assign_hook,
6533 GucShowHook show_hook)
6535 struct config_string *var;
6537 var = (struct config_string *)
6538 init_custom_variable(name, short_desc, long_desc, context, flags,
6539 PGC_STRING, sizeof(struct config_string));
6540 var->variable = valueAddr;
6541 var->boot_val = bootValue;
6542 var->check_hook = check_hook;
6543 var->assign_hook = assign_hook;
6544 var->show_hook = show_hook;
6545 define_custom_variable(&var->gen);
6549 DefineCustomEnumVariable(const char *name,
6550 const char *short_desc,
6551 const char *long_desc,
6554 const struct config_enum_entry * options,
6557 GucEnumCheckHook check_hook,
6558 GucEnumAssignHook assign_hook,
6559 GucShowHook show_hook)
6561 struct config_enum *var;
6563 var = (struct config_enum *)
6564 init_custom_variable(name, short_desc, long_desc, context, flags,
6565 PGC_ENUM, sizeof(struct config_enum));
6566 var->variable = valueAddr;
6567 var->boot_val = bootValue;
6568 var->reset_val = bootValue;
6569 var->options = options;
6570 var->check_hook = check_hook;
6571 var->assign_hook = assign_hook;
6572 var->show_hook = show_hook;
6573 define_custom_variable(&var->gen);
6577 EmitWarningsOnPlaceholders(const char *className)
6579 int classLen = strlen(className);
6582 for (i = 0; i < num_guc_variables; i++)
6584 struct config_generic *var = guc_variables[i];
6586 if ((var->flags & GUC_CUSTOM_PLACEHOLDER) != 0 &&
6587 strncmp(className, var->name, classLen) == 0 &&
6588 var->name[classLen] == GUC_QUALIFIER_SEPARATOR)
6591 (errcode(ERRCODE_UNDEFINED_OBJECT),
6592 errmsg("unrecognized configuration parameter \"%s\"",
6603 GetPGVariable(const char *name, DestReceiver *dest)
6605 if (guc_name_compare(name, "all") == 0)
6606 ShowAllGUCConfig(dest);
6608 ShowGUCConfigOption(name, dest);
6612 GetPGVariableResultDesc(const char *name)
6616 if (guc_name_compare(name, "all") == 0)
6618 /* need a tuple descriptor representing three TEXT columns */
6619 tupdesc = CreateTemplateTupleDesc(3, false);
6620 TupleDescInitEntry(tupdesc, (AttrNumber) 1, "name",
6622 TupleDescInitEntry(tupdesc, (AttrNumber) 2, "setting",
6624 TupleDescInitEntry(tupdesc, (AttrNumber) 3, "description",
6629 const char *varname;
6631 /* Get the canonical spelling of name */
6632 (void) GetConfigOptionByName(name, &varname);
6634 /* need a tuple descriptor representing a single TEXT column */
6635 tupdesc = CreateTemplateTupleDesc(1, false);
6636 TupleDescInitEntry(tupdesc, (AttrNumber) 1, varname,
6647 ShowGUCConfigOption(const char *name, DestReceiver *dest)
6649 TupOutputState *tstate;
6651 const char *varname;
6654 /* Get the value and canonical spelling of name */
6655 value = GetConfigOptionByName(name, &varname);
6657 /* need a tuple descriptor representing a single TEXT column */
6658 tupdesc = CreateTemplateTupleDesc(1, false);
6659 TupleDescInitEntry(tupdesc, (AttrNumber) 1, varname,
6662 /* prepare for projection of tuples */
6663 tstate = begin_tup_output_tupdesc(dest, tupdesc);
6666 do_text_output_oneline(tstate, value);
6668 end_tup_output(tstate);
6675 ShowAllGUCConfig(DestReceiver *dest)
6677 bool am_superuser = superuser();
6679 TupOutputState *tstate;
6682 bool isnull[3] = {false, false, false};
6684 /* need a tuple descriptor representing three TEXT columns */
6685 tupdesc = CreateTemplateTupleDesc(3, false);
6686 TupleDescInitEntry(tupdesc, (AttrNumber) 1, "name",
6688 TupleDescInitEntry(tupdesc, (AttrNumber) 2, "setting",
6690 TupleDescInitEntry(tupdesc, (AttrNumber) 3, "description",
6693 /* prepare for projection of tuples */
6694 tstate = begin_tup_output_tupdesc(dest, tupdesc);
6696 for (i = 0; i < num_guc_variables; i++)
6698 struct config_generic *conf = guc_variables[i];
6701 if ((conf->flags & GUC_NO_SHOW_ALL) ||
6702 ((conf->flags & GUC_SUPERUSER_ONLY) && !am_superuser))
6705 /* assign to the values array */
6706 values[0] = PointerGetDatum(cstring_to_text(conf->name));
6708 setting = _ShowOption(conf, true);
6711 values[1] = PointerGetDatum(cstring_to_text(setting));
6716 values[1] = PointerGetDatum(NULL);
6720 values[2] = PointerGetDatum(cstring_to_text(conf->short_desc));
6722 /* send it to dest */
6723 do_tup_output(tstate, values, isnull);
6726 pfree(DatumGetPointer(values[0]));
6730 pfree(DatumGetPointer(values[1]));
6732 pfree(DatumGetPointer(values[2]));
6735 end_tup_output(tstate);
6739 * Return GUC variable value by name; optionally return canonical
6740 * form of name. Return value is palloc'd.
6743 GetConfigOptionByName(const char *name, const char **varname)
6745 struct config_generic *record;
6747 record = find_option(name, false, ERROR);
6750 (errcode(ERRCODE_UNDEFINED_OBJECT),
6751 errmsg("unrecognized configuration parameter \"%s\"", name)));
6752 if ((record->flags & GUC_SUPERUSER_ONLY) && !superuser())
6754 (errcode(ERRCODE_INSUFFICIENT_PRIVILEGE),
6755 errmsg("must be superuser to examine \"%s\"", name)));
6758 *varname = record->name;
6760 return _ShowOption(record, true);
6764 * Return GUC variable value by variable number; optionally return canonical
6765 * form of name. Return value is palloc'd.
6768 GetConfigOptionByNum(int varnum, const char **values, bool *noshow)
6771 struct config_generic *conf;
6773 /* check requested variable number valid */
6774 Assert((varnum >= 0) && (varnum < num_guc_variables));
6776 conf = guc_variables[varnum];
6780 if ((conf->flags & GUC_NO_SHOW_ALL) ||
6781 ((conf->flags & GUC_SUPERUSER_ONLY) && !superuser()))
6787 /* first get the generic attributes */
6790 values[0] = conf->name;
6792 /* setting : use _ShowOption in order to avoid duplicating the logic */
6793 values[1] = _ShowOption(conf, false);
6796 if (conf->vartype == PGC_INT)
6800 switch (conf->flags & (GUC_UNIT_MEMORY | GUC_UNIT_TIME))
6805 case GUC_UNIT_BLOCKS:
6806 snprintf(buf, sizeof(buf), "%dkB", BLCKSZ / 1024);
6809 case GUC_UNIT_XBLOCKS:
6810 snprintf(buf, sizeof(buf), "%dkB", XLOG_BLCKSZ / 1024);
6831 values[3] = config_group_names[conf->group];
6834 values[4] = conf->short_desc;
6837 values[5] = conf->long_desc;
6840 values[6] = GucContext_Names[conf->context];
6843 values[7] = config_type_names[conf->vartype];
6846 values[8] = GucSource_Names[conf->source];
6848 /* now get the type specifc attributes */
6849 switch (conf->vartype)
6853 struct config_bool *lconf = (struct config_bool *) conf;
6865 values[12] = pstrdup(lconf->boot_val ? "on" : "off");
6868 values[13] = pstrdup(lconf->reset_val ? "on" : "off");
6874 struct config_int *lconf = (struct config_int *) conf;
6877 snprintf(buffer, sizeof(buffer), "%d", lconf->min);
6878 values[9] = pstrdup(buffer);
6881 snprintf(buffer, sizeof(buffer), "%d", lconf->max);
6882 values[10] = pstrdup(buffer);
6888 snprintf(buffer, sizeof(buffer), "%d", lconf->boot_val);
6889 values[12] = pstrdup(buffer);
6892 snprintf(buffer, sizeof(buffer), "%d", lconf->reset_val);
6893 values[13] = pstrdup(buffer);
6899 struct config_real *lconf = (struct config_real *) conf;
6902 snprintf(buffer, sizeof(buffer), "%g", lconf->min);
6903 values[9] = pstrdup(buffer);
6906 snprintf(buffer, sizeof(buffer), "%g", lconf->max);
6907 values[10] = pstrdup(buffer);
6913 snprintf(buffer, sizeof(buffer), "%g", lconf->boot_val);
6914 values[12] = pstrdup(buffer);
6917 snprintf(buffer, sizeof(buffer), "%g", lconf->reset_val);
6918 values[13] = pstrdup(buffer);
6924 struct config_string *lconf = (struct config_string *) conf;
6936 if (lconf->boot_val == NULL)
6939 values[12] = pstrdup(lconf->boot_val);
6942 if (lconf->reset_val == NULL)
6945 values[13] = pstrdup(lconf->reset_val);
6951 struct config_enum *lconf = (struct config_enum *) conf;
6962 * NOTE! enumvals with double quotes in them are not
6965 values[11] = config_enum_get_options((struct config_enum *) conf,
6966 "{\"", "\"}", "\",\"");
6969 values[12] = pstrdup(config_enum_lookup_by_value(lconf,
6973 values[13] = pstrdup(config_enum_lookup_by_value(lconf,
6981 * should never get here, but in case we do, set 'em to NULL
7003 * If the setting came from a config file, set the source location. For
7004 * security reasons, we don't show source file/line number for
7007 if (conf->source == PGC_S_FILE && superuser())
7009 values[14] = conf->sourcefile;
7010 snprintf(buffer, sizeof(buffer), "%d", conf->sourceline);
7011 values[15] = pstrdup(buffer);
7021 * Return the total number of GUC variables
7024 GetNumConfigOptions(void)
7026 return num_guc_variables;
7030 * show_config_by_name - equiv to SHOW X command but implemented as
7034 show_config_by_name(PG_FUNCTION_ARGS)
7039 /* Get the GUC variable name */
7040 varname = TextDatumGetCString(PG_GETARG_DATUM(0));
7043 varval = GetConfigOptionByName(varname, NULL);
7045 /* Convert to text */
7046 PG_RETURN_TEXT_P(cstring_to_text(varval));
7050 * show_all_settings - equiv to SHOW ALL command but implemented as
7053 #define NUM_PG_SETTINGS_ATTS 16
7056 show_all_settings(PG_FUNCTION_ARGS)
7058 FuncCallContext *funcctx;
7062 AttInMetadata *attinmeta;
7063 MemoryContext oldcontext;
7065 /* stuff done only on the first call of the function */
7066 if (SRF_IS_FIRSTCALL())
7068 /* create a function context for cross-call persistence */
7069 funcctx = SRF_FIRSTCALL_INIT();
7072 * switch to memory context appropriate for multiple function calls
7074 oldcontext = MemoryContextSwitchTo(funcctx->multi_call_memory_ctx);
7077 * need a tuple descriptor representing NUM_PG_SETTINGS_ATTS columns
7078 * of the appropriate types
7080 tupdesc = CreateTemplateTupleDesc(NUM_PG_SETTINGS_ATTS, false);
7081 TupleDescInitEntry(tupdesc, (AttrNumber) 1, "name",
7083 TupleDescInitEntry(tupdesc, (AttrNumber) 2, "setting",
7085 TupleDescInitEntry(tupdesc, (AttrNumber) 3, "unit",
7087 TupleDescInitEntry(tupdesc, (AttrNumber) 4, "category",
7089 TupleDescInitEntry(tupdesc, (AttrNumber) 5, "short_desc",
7091 TupleDescInitEntry(tupdesc, (AttrNumber) 6, "extra_desc",
7093 TupleDescInitEntry(tupdesc, (AttrNumber) 7, "context",
7095 TupleDescInitEntry(tupdesc, (AttrNumber) 8, "vartype",
7097 TupleDescInitEntry(tupdesc, (AttrNumber) 9, "source",
7099 TupleDescInitEntry(tupdesc, (AttrNumber) 10, "min_val",
7101 TupleDescInitEntry(tupdesc, (AttrNumber) 11, "max_val",
7103 TupleDescInitEntry(tupdesc, (AttrNumber) 12, "enumvals",
7104 TEXTARRAYOID, -1, 0);
7105 TupleDescInitEntry(tupdesc, (AttrNumber) 13, "boot_val",
7107 TupleDescInitEntry(tupdesc, (AttrNumber) 14, "reset_val",
7109 TupleDescInitEntry(tupdesc, (AttrNumber) 15, "sourcefile",
7111 TupleDescInitEntry(tupdesc, (AttrNumber) 16, "sourceline",
7115 * Generate attribute metadata needed later to produce tuples from raw
7118 attinmeta = TupleDescGetAttInMetadata(tupdesc);
7119 funcctx->attinmeta = attinmeta;
7121 /* total number of tuples to be returned */
7122 funcctx->max_calls = GetNumConfigOptions();
7124 MemoryContextSwitchTo(oldcontext);
7127 /* stuff done on every call of the function */
7128 funcctx = SRF_PERCALL_SETUP();
7130 call_cntr = funcctx->call_cntr;
7131 max_calls = funcctx->max_calls;
7132 attinmeta = funcctx->attinmeta;
7134 if (call_cntr < max_calls) /* do when there is more left to send */
7136 char *values[NUM_PG_SETTINGS_ATTS];
7142 * Get the next visible GUC variable name and value
7146 GetConfigOptionByNum(call_cntr, (const char **) values, &noshow);
7149 /* bump the counter and get the next config setting */
7150 call_cntr = ++funcctx->call_cntr;
7152 /* make sure we haven't gone too far now */
7153 if (call_cntr >= max_calls)
7154 SRF_RETURN_DONE(funcctx);
7159 tuple = BuildTupleFromCStrings(attinmeta, values);
7161 /* make the tuple into a datum */
7162 result = HeapTupleGetDatum(tuple);
7164 SRF_RETURN_NEXT(funcctx, result);
7168 /* do when there is no more left */
7169 SRF_RETURN_DONE(funcctx);
7174 _ShowOption(struct config_generic * record, bool use_units)
7179 switch (record->vartype)
7183 struct config_bool *conf = (struct config_bool *) record;
7185 if (conf->show_hook)
7186 val = (*conf->show_hook) ();
7188 val = *conf->variable ? "on" : "off";
7194 struct config_int *conf = (struct config_int *) record;
7196 if (conf->show_hook)
7197 val = (*conf->show_hook) ();
7201 * Use int64 arithmetic to avoid overflows in units
7204 int64 result = *conf->variable;
7207 if (use_units && result > 0 &&
7208 (record->flags & GUC_UNIT_MEMORY))
7210 switch (record->flags & GUC_UNIT_MEMORY)
7212 case GUC_UNIT_BLOCKS:
7213 result *= BLCKSZ / 1024;
7215 case GUC_UNIT_XBLOCKS:
7216 result *= XLOG_BLCKSZ / 1024;
7220 if (result % KB_PER_GB == 0)
7222 result /= KB_PER_GB;
7225 else if (result % KB_PER_MB == 0)
7227 result /= KB_PER_MB;
7235 else if (use_units && result > 0 &&
7236 (record->flags & GUC_UNIT_TIME))
7238 switch (record->flags & GUC_UNIT_TIME)
7244 result *= MS_PER_MIN;
7248 if (result % MS_PER_D == 0)
7253 else if (result % MS_PER_H == 0)
7258 else if (result % MS_PER_MIN == 0)
7260 result /= MS_PER_MIN;
7263 else if (result % MS_PER_S == 0)
7276 snprintf(buffer, sizeof(buffer), INT64_FORMAT "%s",
7285 struct config_real *conf = (struct config_real *) record;
7287 if (conf->show_hook)
7288 val = (*conf->show_hook) ();
7291 snprintf(buffer, sizeof(buffer), "%g",
7300 struct config_string *conf = (struct config_string *) record;
7302 if (conf->show_hook)
7303 val = (*conf->show_hook) ();
7304 else if (*conf->variable && **conf->variable)
7305 val = *conf->variable;
7313 struct config_enum *conf = (struct config_enum *) record;
7315 if (conf->show_hook)
7316 val = (*conf->show_hook) ();
7318 val = config_enum_lookup_by_value(conf, *conf->variable);
7323 /* just to keep compiler quiet */
7328 return pstrdup(val);
7335 * These routines dump out all non-default GUC options into a binary
7336 * file that is read by all exec'ed backends. The format is:
7338 * variable name, string, null terminated
7339 * variable value, string, null terminated
7340 * variable source, integer
7343 write_one_nondefault_variable(FILE *fp, struct config_generic * gconf)
7345 if (gconf->source == PGC_S_DEFAULT)
7348 fprintf(fp, "%s", gconf->name);
7351 switch (gconf->vartype)
7355 struct config_bool *conf = (struct config_bool *) gconf;
7357 if (*conf->variable)
7358 fprintf(fp, "true");
7360 fprintf(fp, "false");
7366 struct config_int *conf = (struct config_int *) gconf;
7368 fprintf(fp, "%d", *conf->variable);
7374 struct config_real *conf = (struct config_real *) gconf;
7376 /* Could lose precision here? */
7377 fprintf(fp, "%f", *conf->variable);
7383 struct config_string *conf = (struct config_string *) gconf;
7385 fprintf(fp, "%s", *conf->variable);
7391 struct config_enum *conf = (struct config_enum *) gconf;
7394 config_enum_lookup_by_value(conf, *conf->variable));
7401 fwrite(&gconf->source, sizeof(gconf->source), 1, fp);
7405 write_nondefault_variables(GucContext context)
7409 struct config_generic *cvc_conf;
7412 Assert(context == PGC_POSTMASTER || context == PGC_SIGHUP);
7414 elevel = (context == PGC_SIGHUP) ? LOG : ERROR;
7419 fp = AllocateFile(CONFIG_EXEC_PARAMS_NEW, "w");
7423 (errcode_for_file_access(),
7424 errmsg("could not write to file \"%s\": %m",
7425 CONFIG_EXEC_PARAMS_NEW)));
7430 * custom_variable_classes must be written out first; otherwise we might
7431 * reject custom variable values while reading the file.
7433 cvc_conf = find_option("custom_variable_classes", false, ERROR);
7435 write_one_nondefault_variable(fp, cvc_conf);
7437 for (i = 0; i < num_guc_variables; i++)
7439 struct config_generic *gconf = guc_variables[i];
7441 if (gconf != cvc_conf)
7442 write_one_nondefault_variable(fp, gconf);
7448 (errcode_for_file_access(),
7449 errmsg("could not write to file \"%s\": %m",
7450 CONFIG_EXEC_PARAMS_NEW)));
7455 * Put new file in place. This could delay on Win32, but we don't hold
7456 * any exclusive locks.
7458 rename(CONFIG_EXEC_PARAMS_NEW, CONFIG_EXEC_PARAMS);
7463 * Read string, including null byte from file
7465 * Return NULL on EOF and nothing read
7468 read_string_with_null(FILE *fp)
7477 if ((ch = fgetc(fp)) == EOF)
7482 elog(FATAL, "invalid format of exec config params file");
7485 str = guc_malloc(FATAL, maxlen);
7486 else if (i == maxlen)
7487 str = guc_realloc(FATAL, str, maxlen *= 2);
7496 * This routine loads a previous postmaster dump of its non-default
7500 read_nondefault_variables(void)
7510 fp = AllocateFile(CONFIG_EXEC_PARAMS, "r");
7513 /* File not found is fine */
7514 if (errno != ENOENT)
7516 (errcode_for_file_access(),
7517 errmsg("could not read from file \"%s\": %m",
7518 CONFIG_EXEC_PARAMS)));
7524 struct config_generic *record;
7526 if ((varname = read_string_with_null(fp)) == NULL)
7529 if ((record = find_option(varname, true, FATAL)) == NULL)
7530 elog(FATAL, "failed to locate variable %s in exec config params file", varname);
7531 if ((varvalue = read_string_with_null(fp)) == NULL)
7532 elog(FATAL, "invalid format of exec config params file");
7533 if (fread(&varsource, sizeof(varsource), 1, fp) == 0)
7534 elog(FATAL, "invalid format of exec config params file");
7536 (void) set_config_option(varname, varvalue, record->context,
7537 varsource, GUC_ACTION_SET, true);
7544 #endif /* EXEC_BACKEND */
7548 * A little "long argument" simulation, although not quite GNU
7549 * compliant. Takes a string of the form "some-option=some value" and
7550 * returns name = "some_option" and value = "some value" in malloc'ed
7551 * storage. Note that '-' is converted to '_' in the option name. If
7552 * there is no '=' in the input string then value will be NULL.
7555 ParseLongOption(const char *string, char **name, char **value)
7564 equal_pos = strcspn(string, "=");
7566 if (string[equal_pos] == '=')
7568 *name = guc_malloc(FATAL, equal_pos + 1);
7569 strlcpy(*name, string, equal_pos + 1);
7571 *value = guc_strdup(FATAL, &string[equal_pos + 1]);
7575 /* no equal sign in string */
7576 *name = guc_strdup(FATAL, string);
7580 for (cp = *name; *cp; cp++)
7587 * Handle options fetched from pg_db_role_setting.setconfig,
7588 * pg_proc.proconfig, etc. Caller must specify proper context/source/action.
7590 * The array parameter must be an array of TEXT (it must not be NULL).
7593 ProcessGUCArray(ArrayType *array,
7594 GucContext context, GucSource source, GucAction action)
7598 Assert(array != NULL);
7599 Assert(ARR_ELEMTYPE(array) == TEXTOID);
7600 Assert(ARR_NDIM(array) == 1);
7601 Assert(ARR_LBOUND(array)[0] == 1);
7603 for (i = 1; i <= ARR_DIMS(array)[0]; i++)
7611 d = array_ref(array, 1, &i,
7612 -1 /* varlenarray */ ,
7613 -1 /* TEXT's typlen */ ,
7614 false /* TEXT's typbyval */ ,
7615 'i' /* TEXT's typalign */ ,
7621 s = TextDatumGetCString(d);
7623 ParseLongOption(s, &name, &value);
7627 (errcode(ERRCODE_SYNTAX_ERROR),
7628 errmsg("could not parse setting for parameter \"%s\"",
7634 (void) set_config_option(name, value, context, source, action, true);
7645 * Add an entry to an option array. The array parameter may be NULL
7646 * to indicate the current table entry is NULL.
7649 GUCArrayAdd(ArrayType *array, const char *name, const char *value)
7651 struct config_generic *record;
7659 /* test if the option is valid and we're allowed to set it */
7660 (void) validate_option_array_item(name, value, false);
7662 /* normalize name (converts obsolete GUC names to modern spellings) */
7663 record = find_option(name, false, WARNING);
7665 name = record->name;
7667 /* build new item for array */
7668 newval = palloc(strlen(name) + 1 + strlen(value) + 1);
7669 sprintf(newval, "%s=%s", name, value);
7670 datum = CStringGetTextDatum(newval);
7678 Assert(ARR_ELEMTYPE(array) == TEXTOID);
7679 Assert(ARR_NDIM(array) == 1);
7680 Assert(ARR_LBOUND(array)[0] == 1);
7682 index = ARR_DIMS(array)[0] + 1; /* add after end */
7684 for (i = 1; i <= ARR_DIMS(array)[0]; i++)
7689 d = array_ref(array, 1, &i,
7690 -1 /* varlenarray */ ,
7691 -1 /* TEXT's typlen */ ,
7692 false /* TEXT's typbyval */ ,
7693 'i' /* TEXT's typalign */ ,
7697 current = TextDatumGetCString(d);
7699 /* check for match up through and including '=' */
7700 if (strncmp(current, newval, strlen(name) + 1) == 0)
7707 a = array_set(array, 1, &index,
7710 -1 /* varlena array */ ,
7711 -1 /* TEXT's typlen */ ,
7712 false /* TEXT's typbyval */ ,
7713 'i' /* TEXT's typalign */ );
7716 a = construct_array(&datum, 1,
7725 * Delete an entry from an option array. The array parameter may be NULL
7726 * to indicate the current table entry is NULL. Also, if the return value
7727 * is NULL then a null should be stored.
7730 GUCArrayDelete(ArrayType *array, const char *name)
7732 struct config_generic *record;
7733 ArrayType *newarray;
7739 /* test if the option is valid and we're allowed to set it */
7740 (void) validate_option_array_item(name, NULL, false);
7742 /* normalize name (converts obsolete GUC names to modern spellings) */
7743 record = find_option(name, false, WARNING);
7745 name = record->name;
7747 /* if array is currently null, then surely nothing to delete */
7754 for (i = 1; i <= ARR_DIMS(array)[0]; i++)
7760 d = array_ref(array, 1, &i,
7761 -1 /* varlenarray */ ,
7762 -1 /* TEXT's typlen */ ,
7763 false /* TEXT's typbyval */ ,
7764 'i' /* TEXT's typalign */ ,
7768 val = TextDatumGetCString(d);
7770 /* ignore entry if it's what we want to delete */
7771 if (strncmp(val, name, strlen(name)) == 0
7772 && val[strlen(name)] == '=')
7775 /* else add it to the output array */
7777 newarray = array_set(newarray, 1, &index,
7780 -1 /* varlenarray */ ,
7781 -1 /* TEXT's typlen */ ,
7782 false /* TEXT's typbyval */ ,
7783 'i' /* TEXT's typalign */ );
7785 newarray = construct_array(&d, 1,
7797 * Given a GUC array, delete all settings from it that our permission
7798 * level allows: if superuser, delete them all; if regular user, only
7799 * those that are PGC_USERSET
7802 GUCArrayReset(ArrayType *array)
7804 ArrayType *newarray;
7808 /* if array is currently null, nothing to do */
7812 /* if we're superuser, we can delete everything, so just do it */
7819 for (i = 1; i <= ARR_DIMS(array)[0]; i++)
7826 d = array_ref(array, 1, &i,
7827 -1 /* varlenarray */ ,
7828 -1 /* TEXT's typlen */ ,
7829 false /* TEXT's typbyval */ ,
7830 'i' /* TEXT's typalign */ ,
7834 val = TextDatumGetCString(d);
7836 eqsgn = strchr(val, '=');
7839 /* skip if we have permission to delete it */
7840 if (validate_option_array_item(val, NULL, true))
7843 /* else add it to the output array */
7845 newarray = array_set(newarray, 1, &index,
7848 -1 /* varlenarray */ ,
7849 -1 /* TEXT's typlen */ ,
7850 false /* TEXT's typbyval */ ,
7851 'i' /* TEXT's typalign */ );
7853 newarray = construct_array(&d, 1,
7865 * Validate a proposed option setting for GUCArrayAdd/Delete/Reset.
7867 * name is the option name. value is the proposed value for the Add case,
7868 * or NULL for the Delete/Reset cases. If skipIfNoPermissions is true, it's
7869 * not an error to have no permissions to set the option.
7871 * Returns TRUE if OK, FALSE if skipIfNoPermissions is true and user does not
7872 * have permission to change this option (all other error cases result in an
7873 * error being thrown).
7876 validate_option_array_item(const char *name, const char *value,
7877 bool skipIfNoPermissions)
7880 struct config_generic *gconf;
7883 * There are three cases to consider:
7885 * name is a known GUC variable. Check the value normally, check
7886 * permissions normally (ie, allow if variable is USERSET, or if it's
7887 * SUSET and user is superuser).
7889 * name is not known, but exists or can be created as a placeholder
7890 * (implying it has a prefix listed in custom_variable_classes). We allow
7891 * this case if you're a superuser, otherwise not. Superusers are assumed
7892 * to know what they're doing. We can't allow it for other users, because
7893 * when the placeholder is resolved it might turn out to be a SUSET
7894 * variable; define_custom_variable assumes we checked that.
7896 * name is not known and can't be created as a placeholder. Throw error,
7897 * unless skipIfNoPermissions is true, in which case return FALSE. (It's
7898 * tempting to allow this case to superusers, if the name is qualified but
7899 * not listed in custom_variable_classes. That would ease restoring of
7900 * dumps containing ALTER ROLE/DATABASE SET. However, it's not clear that
7901 * this usage justifies such a loss of error checking. You can always fix
7902 * custom_variable_classes before you restore.)
7904 gconf = find_option(name, true, WARNING);
7907 /* not known, failed to make a placeholder */
7908 if (skipIfNoPermissions)
7911 (errcode(ERRCODE_UNDEFINED_OBJECT),
7912 errmsg("unrecognized configuration parameter \"%s\"", name)));
7915 if (gconf->flags & GUC_CUSTOM_PLACEHOLDER)
7918 * We cannot do any meaningful check on the value, so only permissions
7919 * are useful to check.
7923 if (skipIfNoPermissions)
7926 (errcode(ERRCODE_INSUFFICIENT_PRIVILEGE),
7927 errmsg("permission denied to set parameter \"%s\"", name)));
7930 /* manual permissions check so we can avoid an error being thrown */
7931 if (gconf->context == PGC_USERSET)
7933 else if (gconf->context == PGC_SUSET && superuser())
7935 else if (skipIfNoPermissions)
7937 /* if a permissions error should be thrown, let set_config_option do it */
7939 /* test for permissions and valid option value */
7940 (void) set_config_option(name, value,
7941 superuser() ? PGC_SUSET : PGC_USERSET,
7942 PGC_S_TEST, GUC_ACTION_SET, false);
7949 * Called by check_hooks that want to override the normal
7950 * ERRCODE_INVALID_PARAMETER_VALUE SQLSTATE for check hook failures.
7952 * Note that GUC_check_errmsg() etc are just macros that result in a direct
7953 * assignment to the associated variables. That is ugly, but forced by the
7954 * limitations of C's macro mechanisms.
7957 GUC_check_errcode(int sqlerrcode)
7959 GUC_check_errcode_value = sqlerrcode;
7964 * Convenience functions to manage calling a variable's check_hook.
7965 * These mostly take care of the protocol for letting check hooks supply
7966 * portions of the error report on failure.
7970 call_bool_check_hook(struct config_bool * conf, bool *newval, void **extra,
7971 GucSource source, int elevel)
7973 /* Quick success if no hook */
7974 if (!conf->check_hook)
7977 /* Reset variables that might be set by hook */
7978 GUC_check_errcode_value = ERRCODE_INVALID_PARAMETER_VALUE;
7979 GUC_check_errmsg_string = NULL;
7980 GUC_check_errdetail_string = NULL;
7981 GUC_check_errhint_string = NULL;
7983 if (!(*conf->check_hook) (newval, extra, source))
7986 (errcode(GUC_check_errcode_value),
7987 GUC_check_errmsg_string ?
7988 errmsg_internal("%s", GUC_check_errmsg_string) :
7989 errmsg("invalid value for parameter \"%s\": %d",
7990 conf->gen.name, (int) *newval),
7991 GUC_check_errdetail_string ?
7992 errdetail_internal("%s", GUC_check_errdetail_string) : 0,
7993 GUC_check_errhint_string ?
7994 errhint("%s", GUC_check_errhint_string) : 0));
7995 /* Flush any strings created in ErrorContext */
8004 call_int_check_hook(struct config_int * conf, int *newval, void **extra,
8005 GucSource source, int elevel)
8007 /* Quick success if no hook */
8008 if (!conf->check_hook)
8011 /* Reset variables that might be set by hook */
8012 GUC_check_errcode_value = ERRCODE_INVALID_PARAMETER_VALUE;
8013 GUC_check_errmsg_string = NULL;
8014 GUC_check_errdetail_string = NULL;
8015 GUC_check_errhint_string = NULL;
8017 if (!(*conf->check_hook) (newval, extra, source))
8020 (errcode(GUC_check_errcode_value),
8021 GUC_check_errmsg_string ?
8022 errmsg_internal("%s", GUC_check_errmsg_string) :
8023 errmsg("invalid value for parameter \"%s\": %d",
8024 conf->gen.name, *newval),
8025 GUC_check_errdetail_string ?
8026 errdetail_internal("%s", GUC_check_errdetail_string) : 0,
8027 GUC_check_errhint_string ?
8028 errhint("%s", GUC_check_errhint_string) : 0));
8029 /* Flush any strings created in ErrorContext */
8038 call_real_check_hook(struct config_real * conf, double *newval, void **extra,
8039 GucSource source, int elevel)
8041 /* Quick success if no hook */
8042 if (!conf->check_hook)
8045 /* Reset variables that might be set by hook */
8046 GUC_check_errcode_value = ERRCODE_INVALID_PARAMETER_VALUE;
8047 GUC_check_errmsg_string = NULL;
8048 GUC_check_errdetail_string = NULL;
8049 GUC_check_errhint_string = NULL;
8051 if (!(*conf->check_hook) (newval, extra, source))
8054 (errcode(GUC_check_errcode_value),
8055 GUC_check_errmsg_string ?
8056 errmsg_internal("%s", GUC_check_errmsg_string) :
8057 errmsg("invalid value for parameter \"%s\": %g",
8058 conf->gen.name, *newval),
8059 GUC_check_errdetail_string ?
8060 errdetail_internal("%s", GUC_check_errdetail_string) : 0,
8061 GUC_check_errhint_string ?
8062 errhint("%s", GUC_check_errhint_string) : 0));
8063 /* Flush any strings created in ErrorContext */
8072 call_string_check_hook(struct config_string * conf, char **newval, void **extra,
8073 GucSource source, int elevel)
8075 /* Quick success if no hook */
8076 if (!conf->check_hook)
8079 /* Reset variables that might be set by hook */
8080 GUC_check_errcode_value = ERRCODE_INVALID_PARAMETER_VALUE;
8081 GUC_check_errmsg_string = NULL;
8082 GUC_check_errdetail_string = NULL;
8083 GUC_check_errhint_string = NULL;
8085 if (!(*conf->check_hook) (newval, extra, source))
8088 (errcode(GUC_check_errcode_value),
8089 GUC_check_errmsg_string ?
8090 errmsg_internal("%s", GUC_check_errmsg_string) :
8091 errmsg("invalid value for parameter \"%s\": \"%s\"",
8092 conf->gen.name, *newval ? *newval : ""),
8093 GUC_check_errdetail_string ?
8094 errdetail_internal("%s", GUC_check_errdetail_string) : 0,
8095 GUC_check_errhint_string ?
8096 errhint("%s", GUC_check_errhint_string) : 0));
8097 /* Flush any strings created in ErrorContext */
8106 call_enum_check_hook(struct config_enum * conf, int *newval, void **extra,
8107 GucSource source, int elevel)
8109 /* Quick success if no hook */
8110 if (!conf->check_hook)
8113 /* Reset variables that might be set by hook */
8114 GUC_check_errcode_value = ERRCODE_INVALID_PARAMETER_VALUE;
8115 GUC_check_errmsg_string = NULL;
8116 GUC_check_errdetail_string = NULL;
8117 GUC_check_errhint_string = NULL;
8119 if (!(*conf->check_hook) (newval, extra, source))
8122 (errcode(GUC_check_errcode_value),
8123 GUC_check_errmsg_string ?
8124 errmsg_internal("%s", GUC_check_errmsg_string) :
8125 errmsg("invalid value for parameter \"%s\": \"%s\"",
8127 config_enum_lookup_by_value(conf, *newval)),
8128 GUC_check_errdetail_string ?
8129 errdetail_internal("%s", GUC_check_errdetail_string) : 0,
8130 GUC_check_errhint_string ?
8131 errhint("%s", GUC_check_errhint_string) : 0));
8132 /* Flush any strings created in ErrorContext */
8142 * check_hook, assign_hook and show_hook subroutines
8146 check_log_destination(char **newval, void **extra, GucSource source)
8154 /* Need a modifiable copy of string */
8155 rawstring = pstrdup(*newval);
8157 /* Parse string into list of identifiers */
8158 if (!SplitIdentifierString(rawstring, ',', &elemlist))
8160 /* syntax error in list */
8161 GUC_check_errdetail("List syntax is invalid.");
8163 list_free(elemlist);
8167 foreach(l, elemlist)
8169 char *tok = (char *) lfirst(l);
8171 if (pg_strcasecmp(tok, "stderr") == 0)
8172 newlogdest |= LOG_DESTINATION_STDERR;
8173 else if (pg_strcasecmp(tok, "csvlog") == 0)
8174 newlogdest |= LOG_DESTINATION_CSVLOG;
8176 else if (pg_strcasecmp(tok, "syslog") == 0)
8177 newlogdest |= LOG_DESTINATION_SYSLOG;
8180 else if (pg_strcasecmp(tok, "eventlog") == 0)
8181 newlogdest |= LOG_DESTINATION_EVENTLOG;
8185 GUC_check_errdetail("Unrecognized key word: \"%s\".", tok);
8187 list_free(elemlist);
8193 list_free(elemlist);
8195 myextra = (int *) guc_malloc(ERROR, sizeof(int));
8196 *myextra = newlogdest;
8197 *extra = (void *) myextra;
8203 assign_log_destination(const char *newval, void *extra)
8205 Log_destination = *((int *) extra);
8209 assign_syslog_facility(int newval, void *extra)
8212 set_syslog_parameters(syslog_ident_str ? syslog_ident_str : "postgres",
8215 /* Without syslog support, just ignore it */
8219 assign_syslog_ident(const char *newval, void *extra)
8222 set_syslog_parameters(newval, syslog_facility);
8224 /* Without syslog support, it will always be set to "none", so ignore */
8229 assign_session_replication_role(int newval, void *extra)
8232 * Must flush the plan cache when changing replication role; but don't
8233 * flush unnecessarily.
8235 if (SessionReplicationRole != newval)
8240 check_temp_buffers(int *newval, void **extra, GucSource source)
8243 * Once local buffers have been initialized, it's too late to change this.
8245 if (NLocBuffer && NLocBuffer != *newval)
8247 GUC_check_errdetail("\"temp_buffers\" cannot be changed after any temporary tables have been accessed in the session.");
8254 check_phony_autocommit(bool *newval, void **extra, GucSource source)
8258 GUC_check_errcode(ERRCODE_FEATURE_NOT_SUPPORTED);
8259 GUC_check_errmsg("SET AUTOCOMMIT TO OFF is no longer supported");
8266 check_custom_variable_classes(char **newval, void **extra, GucSource source)
8269 * Check syntax. newval must be a comma separated list of identifiers.
8270 * Whitespace is allowed but removed from the result.
8272 bool hasSpaceAfterToken = false;
8273 const char *cp = *newval;
8278 /* Default NULL is OK */
8282 initStringInfo(&buf);
8283 while ((c = *cp++) != '\0')
8285 if (isspace((unsigned char) c))
8288 hasSpaceAfterToken = true;
8294 if (symLen > 0) /* terminate identifier */
8296 appendStringInfoChar(&buf, ',');
8299 hasSpaceAfterToken = false;
8303 if (hasSpaceAfterToken || !(isalnum((unsigned char) c) || c == '_'))
8306 * Syntax error due to token following space after token or
8307 * non-identifier character
8312 appendStringInfoChar(&buf, c);
8316 /* Remove stray ',' at end */
8317 if (symLen == 0 && buf.len > 0)
8318 buf.data[--buf.len] = '\0';
8320 /* GUC wants the result malloc'd */
8322 *newval = guc_strdup(LOG, buf.data);
8329 check_debug_assertions(bool *newval, void **extra, GucSource source)
8331 #ifndef USE_ASSERT_CHECKING
8334 GUC_check_errmsg("assertion checking is not supported by this build");
8342 check_bonjour(bool *newval, void **extra, GucSource source)
8347 GUC_check_errmsg("Bonjour is not supported by this build");
8355 check_ssl(bool *newval, void **extra, GucSource source)
8360 GUC_check_errmsg("SSL is not supported by this build");
8368 check_stage_log_stats(bool *newval, void **extra, GucSource source)
8370 if (*newval && log_statement_stats)
8372 GUC_check_errdetail("Cannot enable parameter when \"log_statement_stats\" is true.");
8379 check_log_stats(bool *newval, void **extra, GucSource source)
8382 (log_parser_stats || log_planner_stats || log_executor_stats))
8384 GUC_check_errdetail("Cannot enable \"log_statement_stats\" when "
8385 "\"log_parser_stats\", \"log_planner_stats\", "
8386 "or \"log_executor_stats\" is true.");
8393 check_canonical_path(char **newval, void **extra, GucSource source)
8396 * Since canonicalize_path never enlarges the string, we can just modify
8397 * newval in-place. But watch out for NULL, which is the default value
8398 * for external_pid_file.
8401 canonicalize_path(*newval);
8406 check_timezone_abbreviations(char **newval, void **extra, GucSource source)
8409 * The boot_val given above for timezone_abbreviations is NULL. When we
8410 * see this we just do nothing. If this value isn't overridden from the
8411 * config file then pg_timezone_abbrev_initialize() will eventually
8412 * replace it with "Default". This hack has two purposes: to avoid
8413 * wasting cycles loading values that might soon be overridden from the
8414 * config file, and to avoid trying to read the timezone abbrev files
8415 * during InitializeGUCOptions(). The latter doesn't work in an
8416 * EXEC_BACKEND subprocess because my_exec_path hasn't been set yet and so
8417 * we can't locate PGSHAREDIR.
8419 if (*newval == NULL)
8421 Assert(source == PGC_S_DEFAULT);
8425 /* OK, load the file and produce a malloc'd TimeZoneAbbrevTable */
8426 *extra = load_tzoffsets(*newval);
8428 /* tzparser.c returns NULL on failure, reporting via GUC_check_errmsg */
8436 assign_timezone_abbreviations(const char *newval, void *extra)
8438 /* Do nothing for the boot_val default of NULL */
8442 InstallTimeZoneAbbrevs((TimeZoneAbbrevTable *) extra);
8446 * pg_timezone_abbrev_initialize --- set default value if not done already
8448 * This is called after initial loading of postgresql.conf. If no
8449 * timezone_abbreviations setting was found therein, select default.
8450 * If a non-default value is already installed, nothing will happen.
8452 * This can also be called from ProcessConfigFile to establish the default
8453 * value after a postgresql.conf entry for it is removed.
8456 pg_timezone_abbrev_initialize(void)
8458 SetConfigOption("timezone_abbreviations", "Default",
8459 PGC_POSTMASTER, PGC_S_DYNAMIC_DEFAULT);
8463 show_archive_command(void)
8465 if (XLogArchivingActive())
8466 return XLogArchiveCommand;
8468 return "(disabled)";
8472 assign_tcp_keepalives_idle(int newval, void *extra)
8475 * The kernel API provides no way to test a value without setting it; and
8476 * once we set it we might fail to unset it. So there seems little point
8477 * in fully implementing the check-then-assign GUC API for these
8478 * variables. Instead we just do the assignment on demand. pqcomm.c
8479 * reports any problems via elog(LOG).
8481 * This approach means that the GUC value might have little to do with the
8482 * actual kernel value, so we use a show_hook that retrieves the kernel
8483 * value rather than trusting GUC's copy.
8485 (void) pq_setkeepalivesidle(newval, MyProcPort);
8489 show_tcp_keepalives_idle(void)
8491 /* See comments in assign_tcp_keepalives_idle */
8492 static char nbuf[16];
8494 snprintf(nbuf, sizeof(nbuf), "%d", pq_getkeepalivesidle(MyProcPort));
8499 assign_tcp_keepalives_interval(int newval, void *extra)
8501 /* See comments in assign_tcp_keepalives_idle */
8502 (void) pq_setkeepalivesinterval(newval, MyProcPort);
8506 show_tcp_keepalives_interval(void)
8508 /* See comments in assign_tcp_keepalives_idle */
8509 static char nbuf[16];
8511 snprintf(nbuf, sizeof(nbuf), "%d", pq_getkeepalivesinterval(MyProcPort));
8516 assign_tcp_keepalives_count(int newval, void *extra)
8518 /* See comments in assign_tcp_keepalives_idle */
8519 (void) pq_setkeepalivescount(newval, MyProcPort);
8523 show_tcp_keepalives_count(void)
8525 /* See comments in assign_tcp_keepalives_idle */
8526 static char nbuf[16];
8528 snprintf(nbuf, sizeof(nbuf), "%d", pq_getkeepalivescount(MyProcPort));
8533 check_maxconnections(int *newval, void **extra, GucSource source)
8535 if (*newval + autovacuum_max_workers + 1 > MAX_BACKENDS)
8541 assign_maxconnections(int newval, void *extra)
8543 MaxBackends = newval + autovacuum_max_workers + 1;
8547 check_autovacuum_max_workers(int *newval, void **extra, GucSource source)
8549 if (MaxConnections + *newval + 1 > MAX_BACKENDS)
8555 assign_autovacuum_max_workers(int newval, void *extra)
8557 MaxBackends = MaxConnections + newval + 1;
8561 check_effective_io_concurrency(int *newval, void **extra, GucSource source)
8564 double new_prefetch_pages = 0.0;
8568 * The user-visible GUC parameter is the number of drives (spindles),
8569 * which we need to translate to a number-of-pages-to-prefetch target.
8570 * The target value is stashed in *extra and then assigned to the actual
8571 * variable by assign_effective_io_concurrency.
8573 * The expected number of prefetch pages needed to keep N drives busy is:
8575 * drives | I/O requests
8576 * -------+----------------
8579 * 3 | 3/1 + 3/2 + 3/3 = 5 1/2
8580 * 4 | 4/1 + 4/2 + 4/3 + 4/4 = 8 1/3
8583 * This is called the "coupon collector problem" and H(n) is called the
8584 * harmonic series. This could be approximated by n * ln(n), but for
8585 * reasonable numbers of drives we might as well just compute the series.
8587 * Alternatively we could set the target to the number of pages necessary
8588 * so that the expected number of active spindles is some arbitrary
8589 * percentage of the total. This sounds the same but is actually slightly
8590 * different. The result ends up being ln(1-P)/ln((n-1)/n) where P is
8591 * that desired fraction.
8593 * Experimental results show that both of these formulas aren't aggressive
8594 * enough, but we don't really have any better proposals.
8596 * Note that if *newval = 0 (disabled), we must set target = 0.
8600 for (i = 1; i <= *newval; i++)
8601 new_prefetch_pages += (double) *newval / (double) i;
8603 /* This range check shouldn't fail, but let's be paranoid */
8604 if (new_prefetch_pages >= 0.0 && new_prefetch_pages < (double) INT_MAX)
8606 int *myextra = (int *) guc_malloc(ERROR, sizeof(int));
8608 *myextra = (int) rint(new_prefetch_pages);
8609 *extra = (void *) myextra;
8617 #endif /* USE_PREFETCH */
8621 assign_effective_io_concurrency(int newval, void *extra)
8624 target_prefetch_pages = *((int *) extra);
8625 #endif /* USE_PREFETCH */
8629 assign_pgstat_temp_directory(const char *newval, void *extra)
8631 /* check_canonical_path already canonicalized newval for us */
8635 tname = guc_malloc(ERROR, strlen(newval) + 12); /* /pgstat.tmp */
8636 sprintf(tname, "%s/pgstat.tmp", newval);
8637 fname = guc_malloc(ERROR, strlen(newval) + 13); /* /pgstat.stat */
8638 sprintf(fname, "%s/pgstat.stat", newval);
8640 if (pgstat_stat_tmpname)
8641 free(pgstat_stat_tmpname);
8642 pgstat_stat_tmpname = tname;
8643 if (pgstat_stat_filename)
8644 free(pgstat_stat_filename);
8645 pgstat_stat_filename = fname;
8649 check_application_name(char **newval, void **extra, GucSource source)
8651 /* Only allow clean ASCII chars in the application name */
8654 for (p = *newval; *p; p++)
8656 if (*p < 32 || *p > 126)
8664 assign_application_name(const char *newval, void *extra)
8666 /* Update the pg_stat_activity view */
8667 pgstat_report_appname(newval);
8671 show_unix_socket_permissions(void)
8675 snprintf(buf, sizeof(buf), "%04o", Unix_socket_permissions);
8680 show_log_file_mode(void)
8684 snprintf(buf, sizeof(buf), "%04o", Log_file_mode);
8688 #include "guc-file.c"