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_debug_assertions(bool *newval, void **extra, GucSource source);
182 static bool check_bonjour(bool *newval, void **extra, GucSource source);
183 static bool check_ssl(bool *newval, void **extra, GucSource source);
184 static bool check_stage_log_stats(bool *newval, void **extra, GucSource source);
185 static bool check_log_stats(bool *newval, void **extra, GucSource source);
186 static bool check_canonical_path(char **newval, void **extra, GucSource source);
187 static bool check_timezone_abbreviations(char **newval, void **extra, GucSource source);
188 static void assign_timezone_abbreviations(const char *newval, void *extra);
189 static void pg_timezone_abbrev_initialize(void);
190 static const char *show_archive_command(void);
191 static void assign_tcp_keepalives_idle(int newval, void *extra);
192 static void assign_tcp_keepalives_interval(int newval, void *extra);
193 static void assign_tcp_keepalives_count(int newval, void *extra);
194 static const char *show_tcp_keepalives_idle(void);
195 static const char *show_tcp_keepalives_interval(void);
196 static const char *show_tcp_keepalives_count(void);
197 static bool check_maxconnections(int *newval, void **extra, GucSource source);
198 static void assign_maxconnections(int newval, void *extra);
199 static bool check_autovacuum_max_workers(int *newval, void **extra, GucSource source);
200 static void assign_autovacuum_max_workers(int newval, void *extra);
201 static bool check_effective_io_concurrency(int *newval, void **extra, GucSource source);
202 static void assign_effective_io_concurrency(int newval, void *extra);
203 static void assign_pgstat_temp_directory(const char *newval, void *extra);
204 static bool check_application_name(char **newval, void **extra, GucSource source);
205 static void assign_application_name(const char *newval, void *extra);
206 static const char *show_unix_socket_permissions(void);
207 static const char *show_log_file_mode(void);
209 static char *config_enum_get_options(struct config_enum * record,
210 const char *prefix, const char *suffix,
211 const char *separator);
215 * Options for enum values defined in this module.
217 * NOTE! Option values may not contain double quotes!
220 static const struct config_enum_entry bytea_output_options[] = {
221 {"escape", BYTEA_OUTPUT_ESCAPE, false},
222 {"hex", BYTEA_OUTPUT_HEX, false},
227 * We have different sets for client and server message level options because
228 * they sort slightly different (see "log" level)
230 static const struct config_enum_entry client_message_level_options[] = {
231 {"debug", DEBUG2, true},
232 {"debug5", DEBUG5, false},
233 {"debug4", DEBUG4, false},
234 {"debug3", DEBUG3, false},
235 {"debug2", DEBUG2, false},
236 {"debug1", DEBUG1, false},
238 {"info", INFO, true},
239 {"notice", NOTICE, false},
240 {"warning", WARNING, false},
241 {"error", ERROR, false},
242 {"fatal", FATAL, true},
243 {"panic", PANIC, true},
247 static const struct config_enum_entry server_message_level_options[] = {
248 {"debug", DEBUG2, true},
249 {"debug5", DEBUG5, false},
250 {"debug4", DEBUG4, false},
251 {"debug3", DEBUG3, false},
252 {"debug2", DEBUG2, false},
253 {"debug1", DEBUG1, false},
254 {"info", INFO, false},
255 {"notice", NOTICE, false},
256 {"warning", WARNING, false},
257 {"error", ERROR, false},
259 {"fatal", FATAL, false},
260 {"panic", PANIC, false},
264 static const struct config_enum_entry intervalstyle_options[] = {
265 {"postgres", INTSTYLE_POSTGRES, false},
266 {"postgres_verbose", INTSTYLE_POSTGRES_VERBOSE, false},
267 {"sql_standard", INTSTYLE_SQL_STANDARD, false},
268 {"iso_8601", INTSTYLE_ISO_8601, false},
272 static const struct config_enum_entry log_error_verbosity_options[] = {
273 {"terse", PGERROR_TERSE, false},
274 {"default", PGERROR_DEFAULT, false},
275 {"verbose", PGERROR_VERBOSE, false},
279 static const struct config_enum_entry log_statement_options[] = {
280 {"none", LOGSTMT_NONE, false},
281 {"ddl", LOGSTMT_DDL, false},
282 {"mod", LOGSTMT_MOD, false},
283 {"all", LOGSTMT_ALL, false},
287 static const struct config_enum_entry isolation_level_options[] = {
288 {"serializable", XACT_SERIALIZABLE, false},
289 {"repeatable read", XACT_REPEATABLE_READ, false},
290 {"read committed", XACT_READ_COMMITTED, false},
291 {"read uncommitted", XACT_READ_UNCOMMITTED, false},
295 static const struct config_enum_entry session_replication_role_options[] = {
296 {"origin", SESSION_REPLICATION_ROLE_ORIGIN, false},
297 {"replica", SESSION_REPLICATION_ROLE_REPLICA, false},
298 {"local", SESSION_REPLICATION_ROLE_LOCAL, false},
302 static const struct config_enum_entry syslog_facility_options[] = {
304 {"local0", LOG_LOCAL0, false},
305 {"local1", LOG_LOCAL1, false},
306 {"local2", LOG_LOCAL2, false},
307 {"local3", LOG_LOCAL3, false},
308 {"local4", LOG_LOCAL4, false},
309 {"local5", LOG_LOCAL5, false},
310 {"local6", LOG_LOCAL6, false},
311 {"local7", LOG_LOCAL7, false},
318 static const struct config_enum_entry track_function_options[] = {
319 {"none", TRACK_FUNC_OFF, false},
320 {"pl", TRACK_FUNC_PL, false},
321 {"all", TRACK_FUNC_ALL, false},
325 static const struct config_enum_entry xmlbinary_options[] = {
326 {"base64", XMLBINARY_BASE64, false},
327 {"hex", XMLBINARY_HEX, false},
331 static const struct config_enum_entry xmloption_options[] = {
332 {"content", XMLOPTION_CONTENT, false},
333 {"document", XMLOPTION_DOCUMENT, false},
338 * Although only "on", "off", and "safe_encoding" are documented, we
339 * accept all the likely variants of "on" and "off".
341 static const struct config_enum_entry backslash_quote_options[] = {
342 {"safe_encoding", BACKSLASH_QUOTE_SAFE_ENCODING, false},
343 {"on", BACKSLASH_QUOTE_ON, false},
344 {"off", BACKSLASH_QUOTE_OFF, false},
345 {"true", BACKSLASH_QUOTE_ON, true},
346 {"false", BACKSLASH_QUOTE_OFF, true},
347 {"yes", BACKSLASH_QUOTE_ON, true},
348 {"no", BACKSLASH_QUOTE_OFF, true},
349 {"1", BACKSLASH_QUOTE_ON, true},
350 {"0", BACKSLASH_QUOTE_OFF, true},
355 * Although only "on", "off", and "partition" are documented, we
356 * accept all the likely variants of "on" and "off".
358 static const struct config_enum_entry constraint_exclusion_options[] = {
359 {"partition", CONSTRAINT_EXCLUSION_PARTITION, false},
360 {"on", CONSTRAINT_EXCLUSION_ON, false},
361 {"off", CONSTRAINT_EXCLUSION_OFF, false},
362 {"true", CONSTRAINT_EXCLUSION_ON, true},
363 {"false", CONSTRAINT_EXCLUSION_OFF, true},
364 {"yes", CONSTRAINT_EXCLUSION_ON, true},
365 {"no", CONSTRAINT_EXCLUSION_OFF, true},
366 {"1", CONSTRAINT_EXCLUSION_ON, true},
367 {"0", CONSTRAINT_EXCLUSION_OFF, true},
372 * Although only "on", "off", and "local" are documented, we
373 * accept all the likely variants of "on" and "off".
375 static const struct config_enum_entry synchronous_commit_options[] = {
376 {"local", SYNCHRONOUS_COMMIT_LOCAL_FLUSH, false},
377 {"on", SYNCHRONOUS_COMMIT_ON, false},
378 {"off", SYNCHRONOUS_COMMIT_OFF, false},
379 {"true", SYNCHRONOUS_COMMIT_ON, true},
380 {"false", SYNCHRONOUS_COMMIT_OFF, true},
381 {"yes", SYNCHRONOUS_COMMIT_ON, true},
382 {"no", SYNCHRONOUS_COMMIT_OFF, true},
383 {"1", SYNCHRONOUS_COMMIT_ON, true},
384 {"0", SYNCHRONOUS_COMMIT_OFF, true},
389 * Options for enum values stored in other modules
391 extern const struct config_enum_entry wal_level_options[];
392 extern const struct config_enum_entry sync_method_options[];
395 * GUC option variables that are exported from this module
397 #ifdef USE_ASSERT_CHECKING
398 bool assert_enabled = true;
400 bool assert_enabled = false;
402 bool log_duration = false;
403 bool Debug_print_plan = false;
404 bool Debug_print_parse = false;
405 bool Debug_print_rewritten = false;
406 bool Debug_pretty_print = true;
408 bool log_parser_stats = false;
409 bool log_planner_stats = false;
410 bool log_executor_stats = false;
411 bool log_statement_stats = false; /* this is sort of all three
413 bool log_btree_build_stats = false;
415 bool check_function_bodies = true;
416 bool default_with_oids = false;
417 bool SQL_inheritance = true;
419 bool Password_encryption = true;
421 int log_min_error_statement = ERROR;
422 int log_min_messages = WARNING;
423 int client_min_messages = NOTICE;
424 int log_min_duration_statement = -1;
425 int log_temp_files = -1;
426 int trace_recovery_messages = LOG;
428 int temp_file_limit = -1;
430 int num_temp_buffers = 1024;
432 char *data_directory;
433 char *ConfigFileName;
436 char *external_pid_file;
438 char *pgstat_temp_directory;
440 char *application_name;
442 int tcp_keepalives_idle;
443 int tcp_keepalives_interval;
444 int tcp_keepalives_count;
447 * These variables are all dummies that don't do anything, except in some
448 * cases provide the value for SHOW to display. The real state is elsewhere
449 * and is kept in sync by assign_hooks.
451 static char *log_destination_string;
453 static char *syslog_ident_str;
454 static bool phony_autocommit;
455 static bool session_auth_is_superuser;
456 static double phony_random_seed;
457 static char *client_encoding_string;
458 static char *datestyle_string;
459 static char *locale_collate;
460 static char *locale_ctype;
461 static char *server_encoding_string;
462 static char *server_version_string;
463 static int server_version_num;
464 static char *timezone_string;
465 static char *log_timezone_string;
466 static char *timezone_abbreviations_string;
467 static char *XactIsoLevel_string;
468 static char *session_authorization_string;
469 static int max_function_args;
470 static int max_index_keys;
471 static int max_identifier_length;
472 static int block_size;
473 static int segment_size;
474 static int wal_block_size;
475 static int wal_segment_size;
476 static bool integer_datetimes;
477 static int effective_io_concurrency;
479 /* should be static, but commands/variable.c needs to get at this */
484 * Displayable names for context types (enum GucContext)
486 * Note: these strings are deliberately not localized.
488 const char *const GucContext_Names[] =
490 /* PGC_INTERNAL */ "internal",
491 /* PGC_POSTMASTER */ "postmaster",
492 /* PGC_SIGHUP */ "sighup",
493 /* PGC_BACKEND */ "backend",
494 /* PGC_SUSET */ "superuser",
495 /* PGC_USERSET */ "user"
499 * Displayable names for source types (enum GucSource)
501 * Note: these strings are deliberately not localized.
503 const char *const GucSource_Names[] =
505 /* PGC_S_DEFAULT */ "default",
506 /* PGC_S_DYNAMIC_DEFAULT */ "default",
507 /* PGC_S_ENV_VAR */ "environment variable",
508 /* PGC_S_FILE */ "configuration file",
509 /* PGC_S_ARGV */ "command line",
510 /* PGC_S_DATABASE */ "database",
511 /* PGC_S_USER */ "user",
512 /* PGC_S_DATABASE_USER */ "database user",
513 /* PGC_S_CLIENT */ "client",
514 /* PGC_S_OVERRIDE */ "override",
515 /* PGC_S_INTERACTIVE */ "interactive",
516 /* PGC_S_TEST */ "test",
517 /* PGC_S_SESSION */ "session"
521 * Displayable names for the groupings defined in enum config_group
523 const char *const config_group_names[] =
526 gettext_noop("Ungrouped"),
528 gettext_noop("File Locations"),
530 gettext_noop("Connections and Authentication"),
531 /* CONN_AUTH_SETTINGS */
532 gettext_noop("Connections and Authentication / Connection Settings"),
533 /* CONN_AUTH_SECURITY */
534 gettext_noop("Connections and Authentication / Security and Authentication"),
536 gettext_noop("Resource Usage"),
538 gettext_noop("Resource Usage / Memory"),
540 gettext_noop("Resource Usage / Disk"),
541 /* RESOURCES_KERNEL */
542 gettext_noop("Resource Usage / Kernel Resources"),
543 /* RESOURCES_VACUUM_DELAY */
544 gettext_noop("Resource Usage / Cost-Based Vacuum Delay"),
545 /* RESOURCES_BGWRITER */
546 gettext_noop("Resource Usage / Background Writer"),
547 /* RESOURCES_ASYNCHRONOUS */
548 gettext_noop("Resource Usage / Asynchronous Behavior"),
550 gettext_noop("Write-Ahead Log"),
552 gettext_noop("Write-Ahead Log / Settings"),
553 /* WAL_CHECKPOINTS */
554 gettext_noop("Write-Ahead Log / Checkpoints"),
556 gettext_noop("Write-Ahead Log / Archiving"),
558 gettext_noop("Replication"),
559 /* REPLICATION_SENDING */
560 gettext_noop("Replication / Sending Servers"),
561 /* REPLICATION_MASTER */
562 gettext_noop("Replication / Master Server"),
563 /* REPLICATION_STANDBY */
564 gettext_noop("Replication / Standby Servers"),
566 gettext_noop("Query Tuning"),
567 /* QUERY_TUNING_METHOD */
568 gettext_noop("Query Tuning / Planner Method Configuration"),
569 /* QUERY_TUNING_COST */
570 gettext_noop("Query Tuning / Planner Cost Constants"),
571 /* QUERY_TUNING_GEQO */
572 gettext_noop("Query Tuning / Genetic Query Optimizer"),
573 /* QUERY_TUNING_OTHER */
574 gettext_noop("Query Tuning / Other Planner Options"),
576 gettext_noop("Reporting and Logging"),
578 gettext_noop("Reporting and Logging / Where to Log"),
580 gettext_noop("Reporting and Logging / When to Log"),
582 gettext_noop("Reporting and Logging / What to Log"),
584 gettext_noop("Statistics"),
585 /* STATS_MONITORING */
586 gettext_noop("Statistics / Monitoring"),
587 /* STATS_COLLECTOR */
588 gettext_noop("Statistics / Query and Index Statistics Collector"),
590 gettext_noop("Autovacuum"),
592 gettext_noop("Client Connection Defaults"),
593 /* CLIENT_CONN_STATEMENT */
594 gettext_noop("Client Connection Defaults / Statement Behavior"),
595 /* CLIENT_CONN_LOCALE */
596 gettext_noop("Client Connection Defaults / Locale and Formatting"),
597 /* CLIENT_CONN_OTHER */
598 gettext_noop("Client Connection Defaults / Other Defaults"),
599 /* LOCK_MANAGEMENT */
600 gettext_noop("Lock Management"),
602 gettext_noop("Version and Platform Compatibility"),
603 /* COMPAT_OPTIONS_PREVIOUS */
604 gettext_noop("Version and Platform Compatibility / Previous PostgreSQL Versions"),
605 /* COMPAT_OPTIONS_CLIENT */
606 gettext_noop("Version and Platform Compatibility / Other Platforms and Clients"),
608 gettext_noop("Error Handling"),
610 gettext_noop("Preset Options"),
612 gettext_noop("Customized Options"),
613 /* DEVELOPER_OPTIONS */
614 gettext_noop("Developer Options"),
615 /* help_config wants this array to be null-terminated */
620 * Displayable names for GUC variable types (enum config_type)
622 * Note: these strings are deliberately not localized.
624 const char *const config_type_names[] =
626 /* PGC_BOOL */ "bool",
627 /* PGC_INT */ "integer",
628 /* PGC_REAL */ "real",
629 /* PGC_STRING */ "string",
630 /* PGC_ENUM */ "enum"
635 * Contents of GUC tables
637 * See src/backend/utils/misc/README for design notes.
641 * 1. Declare a global variable of type bool, int, double, or char*
642 * and make use of it.
644 * 2. Decide at what times it's safe to set the option. See guc.h for
647 * 3. Decide on a name, a default value, upper and lower bounds (if
650 * 4. Add a record below.
652 * 5. Add it to src/backend/utils/misc/postgresql.conf.sample, if
655 * 6. Don't forget to document the option (at least in config.sgml).
657 * 7. If it's a new GUC_LIST option you must edit pg_dumpall.c to ensure
658 * it is not single quoted at dump time.
662 /******** option records follow ********/
664 static struct config_bool ConfigureNamesBool[] =
667 {"enable_seqscan", PGC_USERSET, QUERY_TUNING_METHOD,
668 gettext_noop("Enables the planner's use of sequential-scan plans."),
676 {"enable_indexscan", PGC_USERSET, QUERY_TUNING_METHOD,
677 gettext_noop("Enables the planner's use of index-scan plans."),
685 {"enable_bitmapscan", PGC_USERSET, QUERY_TUNING_METHOD,
686 gettext_noop("Enables the planner's use of bitmap-scan plans."),
694 {"enable_tidscan", PGC_USERSET, QUERY_TUNING_METHOD,
695 gettext_noop("Enables the planner's use of TID scan plans."),
703 {"enable_sort", PGC_USERSET, QUERY_TUNING_METHOD,
704 gettext_noop("Enables the planner's use of explicit sort steps."),
712 {"enable_hashagg", PGC_USERSET, QUERY_TUNING_METHOD,
713 gettext_noop("Enables the planner's use of hashed aggregation plans."),
721 {"enable_material", PGC_USERSET, QUERY_TUNING_METHOD,
722 gettext_noop("Enables the planner's use of materialization."),
730 {"enable_nestloop", PGC_USERSET, QUERY_TUNING_METHOD,
731 gettext_noop("Enables the planner's use of nested-loop join plans."),
739 {"enable_mergejoin", PGC_USERSET, QUERY_TUNING_METHOD,
740 gettext_noop("Enables the planner's use of merge join plans."),
748 {"enable_hashjoin", PGC_USERSET, QUERY_TUNING_METHOD,
749 gettext_noop("Enables the planner's use of hash join plans."),
757 {"geqo", PGC_USERSET, QUERY_TUNING_GEQO,
758 gettext_noop("Enables genetic query optimization."),
759 gettext_noop("This algorithm attempts to do planning without "
760 "exhaustive searching.")
767 /* Not for general use --- used by SET SESSION AUTHORIZATION */
768 {"is_superuser", PGC_INTERNAL, UNGROUPED,
769 gettext_noop("Shows whether the current user is a superuser."),
771 GUC_REPORT | GUC_NO_SHOW_ALL | GUC_NO_RESET_ALL | GUC_NOT_IN_SAMPLE | GUC_DISALLOW_IN_FILE
773 &session_auth_is_superuser,
778 {"bonjour", PGC_POSTMASTER, CONN_AUTH_SETTINGS,
779 gettext_noop("Enables advertising the server via Bonjour."),
784 check_bonjour, NULL, NULL
787 {"ssl", PGC_POSTMASTER, CONN_AUTH_SECURITY,
788 gettext_noop("Enables SSL connections."),
793 check_ssl, NULL, NULL
796 {"fsync", PGC_SIGHUP, WAL_SETTINGS,
797 gettext_noop("Forces synchronization of updates to disk."),
798 gettext_noop("The server will use the fsync() system call in several places to make "
799 "sure that updates are physically written to disk. This insures "
800 "that a database cluster will recover to a consistent state after "
801 "an operating system or hardware crash.")
808 {"zero_damaged_pages", PGC_SUSET, DEVELOPER_OPTIONS,
809 gettext_noop("Continues processing past damaged page headers."),
810 gettext_noop("Detection of a damaged page header normally causes PostgreSQL to "
811 "report an error, aborting the current transaction. Setting "
812 "zero_damaged_pages to true causes the system to instead report a "
813 "warning, zero out the damaged page, and continue processing. This "
814 "behavior will destroy data, namely all the rows on the damaged page."),
822 {"full_page_writes", PGC_SIGHUP, WAL_SETTINGS,
823 gettext_noop("Writes full pages to WAL when first modified after a checkpoint."),
824 gettext_noop("A page write in process during an operating system crash might be "
825 "only partially written to disk. During recovery, the row changes "
826 "stored in WAL are not enough to recover. This option writes "
827 "pages when first modified after a checkpoint to WAL so full recovery "
835 {"log_checkpoints", PGC_SIGHUP, LOGGING_WHAT,
836 gettext_noop("Logs each checkpoint."),
844 {"log_connections", PGC_BACKEND, LOGGING_WHAT,
845 gettext_noop("Logs each successful connection."),
853 {"log_disconnections", PGC_BACKEND, LOGGING_WHAT,
854 gettext_noop("Logs end of a session, including duration."),
862 {"debug_assertions", PGC_USERSET, DEVELOPER_OPTIONS,
863 gettext_noop("Turns on various assertion checks."),
864 gettext_noop("This is a debugging aid."),
868 #ifdef USE_ASSERT_CHECKING
873 check_debug_assertions, NULL, NULL
877 {"exit_on_error", PGC_USERSET, ERROR_HANDLING_OPTIONS,
878 gettext_noop("Terminate session on any error."),
886 {"restart_after_crash", PGC_SIGHUP, ERROR_HANDLING_OPTIONS,
887 gettext_noop("Reinitialize server after backend crash."),
890 &restart_after_crash,
896 {"log_duration", PGC_SUSET, LOGGING_WHAT,
897 gettext_noop("Logs the duration of each completed SQL statement."),
905 {"debug_print_parse", PGC_USERSET, LOGGING_WHAT,
906 gettext_noop("Logs each query's parse tree."),
914 {"debug_print_rewritten", PGC_USERSET, LOGGING_WHAT,
915 gettext_noop("Logs each query's rewritten parse tree."),
918 &Debug_print_rewritten,
923 {"debug_print_plan", PGC_USERSET, LOGGING_WHAT,
924 gettext_noop("Logs each query's execution plan."),
932 {"debug_pretty_print", PGC_USERSET, LOGGING_WHAT,
933 gettext_noop("Indents parse and plan tree displays."),
941 {"log_parser_stats", PGC_SUSET, STATS_MONITORING,
942 gettext_noop("Writes parser performance statistics to the server log."),
947 check_stage_log_stats, NULL, NULL
950 {"log_planner_stats", PGC_SUSET, STATS_MONITORING,
951 gettext_noop("Writes planner performance statistics to the server log."),
956 check_stage_log_stats, NULL, NULL
959 {"log_executor_stats", PGC_SUSET, STATS_MONITORING,
960 gettext_noop("Writes executor performance statistics to the server log."),
965 check_stage_log_stats, NULL, NULL
968 {"log_statement_stats", PGC_SUSET, STATS_MONITORING,
969 gettext_noop("Writes cumulative performance statistics to the server log."),
972 &log_statement_stats,
974 check_log_stats, NULL, NULL
976 #ifdef BTREE_BUILD_STATS
978 {"log_btree_build_stats", PGC_SUSET, DEVELOPER_OPTIONS,
979 gettext_noop("No description available."),
983 &log_btree_build_stats,
990 {"track_activities", PGC_SUSET, STATS_COLLECTOR,
991 gettext_noop("Collects information about executing commands."),
992 gettext_noop("Enables the collection of information on the currently "
993 "executing command of each session, along with "
994 "the time at which that command began execution.")
996 &pgstat_track_activities,
1001 {"track_counts", PGC_SUSET, STATS_COLLECTOR,
1002 gettext_noop("Collects statistics on database activity."),
1005 &pgstat_track_counts,
1011 {"update_process_title", PGC_SUSET, STATS_COLLECTOR,
1012 gettext_noop("Updates the process title to show the active SQL command."),
1013 gettext_noop("Enables updating of the process title every time a new SQL command is received by the server.")
1015 &update_process_title,
1021 {"autovacuum", PGC_SIGHUP, AUTOVACUUM,
1022 gettext_noop("Starts the autovacuum subprocess."),
1025 &autovacuum_start_daemon,
1031 {"trace_notify", PGC_USERSET, DEVELOPER_OPTIONS,
1032 gettext_noop("Generates debugging output for LISTEN and NOTIFY."),
1043 {"trace_locks", PGC_SUSET, DEVELOPER_OPTIONS,
1044 gettext_noop("No description available."),
1053 {"trace_userlocks", PGC_SUSET, DEVELOPER_OPTIONS,
1054 gettext_noop("No description available."),
1063 {"trace_lwlocks", PGC_SUSET, DEVELOPER_OPTIONS,
1064 gettext_noop("No description available."),
1073 {"debug_deadlocks", PGC_SUSET, DEVELOPER_OPTIONS,
1074 gettext_noop("No description available."),
1085 {"log_lock_waits", PGC_SUSET, LOGGING_WHAT,
1086 gettext_noop("Logs long lock waits."),
1095 {"log_hostname", PGC_SIGHUP, LOGGING_WHAT,
1096 gettext_noop("Logs the host name in the connection logs."),
1097 gettext_noop("By default, connection logs only show the IP address "
1098 "of the connecting host. If you want them to show the host name you "
1099 "can turn this on, but depending on your host name resolution "
1100 "setup it might impose a non-negligible performance penalty.")
1107 {"sql_inheritance", PGC_USERSET, COMPAT_OPTIONS_PREVIOUS,
1108 gettext_noop("Causes subtables to be included by default in various commands."),
1116 {"password_encryption", PGC_USERSET, CONN_AUTH_SECURITY,
1117 gettext_noop("Encrypt passwords."),
1118 gettext_noop("When a password is specified in CREATE USER or "
1119 "ALTER USER without writing either ENCRYPTED or UNENCRYPTED, "
1120 "this parameter determines whether the password is to be encrypted.")
1122 &Password_encryption,
1127 {"transform_null_equals", PGC_USERSET, COMPAT_OPTIONS_CLIENT,
1128 gettext_noop("Treats \"expr=NULL\" as \"expr IS NULL\"."),
1129 gettext_noop("When turned on, expressions of the form expr = NULL "
1130 "(or NULL = expr) are treated as expr IS NULL, that is, they "
1131 "return true if expr evaluates to the null value, and false "
1132 "otherwise. The correct behavior of expr = NULL is to always "
1133 "return null (unknown).")
1135 &Transform_null_equals,
1140 {"db_user_namespace", PGC_SIGHUP, CONN_AUTH_SECURITY,
1141 gettext_noop("Enables per-database user names."),
1149 /* only here for backwards compatibility */
1150 {"autocommit", PGC_USERSET, CLIENT_CONN_STATEMENT,
1151 gettext_noop("This parameter doesn't do anything."),
1152 gettext_noop("It's just here so that we won't choke on SET AUTOCOMMIT TO ON from 7.3-vintage clients."),
1153 GUC_NO_SHOW_ALL | GUC_NOT_IN_SAMPLE
1157 check_phony_autocommit, NULL, NULL
1160 {"default_transaction_read_only", PGC_USERSET, CLIENT_CONN_STATEMENT,
1161 gettext_noop("Sets the default read-only status of new transactions."),
1164 &DefaultXactReadOnly,
1169 {"transaction_read_only", PGC_USERSET, CLIENT_CONN_STATEMENT,
1170 gettext_noop("Sets the current transaction's read-only status."),
1172 GUC_NO_RESET_ALL | GUC_NOT_IN_SAMPLE | GUC_DISALLOW_IN_FILE
1176 check_transaction_read_only, NULL, NULL
1179 {"default_transaction_deferrable", PGC_USERSET, CLIENT_CONN_STATEMENT,
1180 gettext_noop("Sets the default deferrable status of new transactions."),
1183 &DefaultXactDeferrable,
1188 {"transaction_deferrable", PGC_USERSET, CLIENT_CONN_STATEMENT,
1189 gettext_noop("Whether to defer a read-only serializable transaction until it can be executed with no possible serialization failures."),
1191 GUC_NO_RESET_ALL | GUC_NOT_IN_SAMPLE | GUC_DISALLOW_IN_FILE
1195 check_transaction_deferrable, NULL, NULL
1198 {"check_function_bodies", PGC_USERSET, CLIENT_CONN_STATEMENT,
1199 gettext_noop("Check function bodies during CREATE FUNCTION."),
1202 &check_function_bodies,
1207 {"array_nulls", PGC_USERSET, COMPAT_OPTIONS_PREVIOUS,
1208 gettext_noop("Enable input of NULL elements in arrays."),
1209 gettext_noop("When turned on, unquoted NULL in an array input "
1210 "value means a null value; "
1211 "otherwise it is taken literally.")
1218 {"default_with_oids", PGC_USERSET, COMPAT_OPTIONS_PREVIOUS,
1219 gettext_noop("Create new tables with OIDs by default."),
1227 {"logging_collector", PGC_POSTMASTER, LOGGING_WHERE,
1228 gettext_noop("Start a subprocess to capture stderr output and/or csvlogs into log files."),
1236 {"log_truncate_on_rotation", PGC_SIGHUP, LOGGING_WHERE,
1237 gettext_noop("Truncate existing log files of same name during log rotation."),
1240 &Log_truncate_on_rotation,
1247 {"trace_sort", PGC_USERSET, DEVELOPER_OPTIONS,
1248 gettext_noop("Emit information about resource usage in sorting."),
1258 #ifdef TRACE_SYNCSCAN
1259 /* this is undocumented because not exposed in a standard build */
1261 {"trace_syncscan", PGC_USERSET, DEVELOPER_OPTIONS,
1262 gettext_noop("Generate debugging output for synchronized scanning."),
1272 #ifdef DEBUG_BOUNDED_SORT
1273 /* this is undocumented because not exposed in a standard build */
1276 "optimize_bounded_sort", PGC_USERSET, QUERY_TUNING_METHOD,
1277 gettext_noop("Enable bounded sorting using heap sort."),
1281 &optimize_bounded_sort,
1289 {"wal_debug", PGC_SUSET, DEVELOPER_OPTIONS,
1290 gettext_noop("Emit WAL-related debugging output."),
1301 {"integer_datetimes", PGC_INTERNAL, PRESET_OPTIONS,
1302 gettext_noop("Datetimes are integer based."),
1304 GUC_REPORT | GUC_NOT_IN_SAMPLE | GUC_DISALLOW_IN_FILE
1307 #ifdef HAVE_INT64_TIMESTAMP
1316 {"krb_caseins_users", PGC_SIGHUP, CONN_AUTH_SECURITY,
1317 gettext_noop("Sets whether Kerberos and GSSAPI user names should be treated as case-insensitive."),
1320 &pg_krb_caseins_users,
1326 {"escape_string_warning", PGC_USERSET, COMPAT_OPTIONS_PREVIOUS,
1327 gettext_noop("Warn about backslash escapes in ordinary string literals."),
1330 &escape_string_warning,
1336 {"standard_conforming_strings", PGC_USERSET, COMPAT_OPTIONS_PREVIOUS,
1337 gettext_noop("Causes '...' strings to treat backslashes literally."),
1341 &standard_conforming_strings,
1347 {"synchronize_seqscans", PGC_USERSET, COMPAT_OPTIONS_PREVIOUS,
1348 gettext_noop("Enable synchronized sequential scans."),
1351 &synchronize_seqscans,
1357 {"archive_mode", PGC_POSTMASTER, WAL_ARCHIVING,
1358 gettext_noop("Allows archiving of WAL files using archive_command."),
1367 {"hot_standby", PGC_POSTMASTER, REPLICATION_STANDBY,
1368 gettext_noop("Allows connections and queries during recovery."),
1377 {"hot_standby_feedback", PGC_SIGHUP, REPLICATION_STANDBY,
1378 gettext_noop("Allows feedback from a hot standby to the primary that will avoid query conflicts."),
1381 &hot_standby_feedback,
1387 {"allow_system_table_mods", PGC_POSTMASTER, DEVELOPER_OPTIONS,
1388 gettext_noop("Allows modifications of the structure of system tables."),
1392 &allowSystemTableMods,
1398 {"ignore_system_indexes", PGC_BACKEND, DEVELOPER_OPTIONS,
1399 gettext_noop("Disables reading from system indexes."),
1400 gettext_noop("It does not prevent updating the indexes, so it is safe "
1401 "to use. The worst consequence is slowness."),
1404 &IgnoreSystemIndexes,
1410 {"lo_compat_privileges", PGC_SUSET, COMPAT_OPTIONS_PREVIOUS,
1411 gettext_noop("Enables backward compatibility mode for privilege checks on large objects."),
1412 gettext_noop("Skips privilege checks when reading or modifying large objects, "
1413 "for compatibility with PostgreSQL releases prior to 9.0.")
1415 &lo_compat_privileges,
1421 {"quote_all_identifiers", PGC_USERSET, COMPAT_OPTIONS_PREVIOUS,
1422 gettext_noop("When generating SQL fragments, quote all identifiers."),
1425 "e_all_identifiers,
1430 /* End-of-list marker */
1432 {NULL, 0, 0, NULL, NULL}, NULL, false, NULL, NULL, NULL
1437 static struct config_int ConfigureNamesInt[] =
1440 {"archive_timeout", PGC_SIGHUP, WAL_ARCHIVING,
1441 gettext_noop("Forces a switch to the next xlog file if a "
1442 "new file has not been started within N seconds."),
1446 &XLogArchiveTimeout,
1451 {"post_auth_delay", PGC_BACKEND, DEVELOPER_OPTIONS,
1452 gettext_noop("Waits N seconds on connection startup after authentication."),
1453 gettext_noop("This allows attaching a debugger to the process."),
1454 GUC_NOT_IN_SAMPLE | GUC_UNIT_S
1461 {"default_statistics_target", PGC_USERSET, QUERY_TUNING_OTHER,
1462 gettext_noop("Sets the default statistics target."),
1463 gettext_noop("This applies to table columns that have not had a "
1464 "column-specific target set via ALTER TABLE SET STATISTICS.")
1466 &default_statistics_target,
1471 {"from_collapse_limit", PGC_USERSET, QUERY_TUNING_OTHER,
1472 gettext_noop("Sets the FROM-list size beyond which subqueries "
1473 "are not collapsed."),
1474 gettext_noop("The planner will merge subqueries into upper "
1475 "queries if the resulting FROM list would have no more than "
1478 &from_collapse_limit,
1483 {"join_collapse_limit", PGC_USERSET, QUERY_TUNING_OTHER,
1484 gettext_noop("Sets the FROM-list size beyond which JOIN "
1485 "constructs are not flattened."),
1486 gettext_noop("The planner will flatten explicit JOIN "
1487 "constructs into lists of FROM items whenever a "
1488 "list of no more than this many items would result.")
1490 &join_collapse_limit,
1495 {"geqo_threshold", PGC_USERSET, QUERY_TUNING_GEQO,
1496 gettext_noop("Sets the threshold of FROM items beyond which GEQO is used."),
1504 {"geqo_effort", PGC_USERSET, QUERY_TUNING_GEQO,
1505 gettext_noop("GEQO: effort is used to set the default for other GEQO parameters."),
1509 DEFAULT_GEQO_EFFORT, MIN_GEQO_EFFORT, MAX_GEQO_EFFORT,
1513 {"geqo_pool_size", PGC_USERSET, QUERY_TUNING_GEQO,
1514 gettext_noop("GEQO: number of individuals in the population."),
1515 gettext_noop("Zero selects a suitable default value.")
1522 {"geqo_generations", PGC_USERSET, QUERY_TUNING_GEQO,
1523 gettext_noop("GEQO: number of iterations of the algorithm."),
1524 gettext_noop("Zero selects a suitable default value.")
1532 /* This is PGC_SUSET to prevent hiding from log_lock_waits. */
1533 {"deadlock_timeout", PGC_SUSET, LOCK_MANAGEMENT,
1534 gettext_noop("Sets the time to wait on a lock before checking for deadlock."),
1544 {"max_standby_archive_delay", PGC_SIGHUP, REPLICATION_STANDBY,
1545 gettext_noop("Sets the maximum delay before canceling queries when a hot standby server is processing archived WAL data."),
1549 &max_standby_archive_delay,
1550 30 * 1000, -1, INT_MAX,
1555 {"max_standby_streaming_delay", PGC_SIGHUP, REPLICATION_STANDBY,
1556 gettext_noop("Sets the maximum delay before canceling queries when a hot standby server is processing streamed WAL data."),
1560 &max_standby_streaming_delay,
1561 30 * 1000, -1, INT_MAX,
1566 {"wal_receiver_status_interval", PGC_SIGHUP, REPLICATION_STANDBY,
1567 gettext_noop("Sets the maximum interval between WAL receiver status reports to the primary."),
1571 &wal_receiver_status_interval,
1572 10, 0, INT_MAX / 1000,
1577 {"max_connections", PGC_POSTMASTER, CONN_AUTH_SETTINGS,
1578 gettext_noop("Sets the maximum number of concurrent connections."),
1582 100, 1, MAX_BACKENDS,
1583 check_maxconnections, assign_maxconnections, NULL
1587 {"superuser_reserved_connections", PGC_POSTMASTER, CONN_AUTH_SETTINGS,
1588 gettext_noop("Sets the number of connection slots reserved for superusers."),
1597 * We sometimes multiply the number of shared buffers by two without
1598 * checking for overflow, so we mustn't allow more than INT_MAX / 2.
1601 {"shared_buffers", PGC_POSTMASTER, RESOURCES_MEM,
1602 gettext_noop("Sets the number of shared memory buffers used by the server."),
1607 1024, 16, INT_MAX / 2,
1612 {"temp_buffers", PGC_USERSET, RESOURCES_MEM,
1613 gettext_noop("Sets the maximum number of temporary buffers used by each session."),
1618 1024, 100, INT_MAX / 2,
1619 check_temp_buffers, NULL, NULL
1623 {"port", PGC_POSTMASTER, CONN_AUTH_SETTINGS,
1624 gettext_noop("Sets the TCP port the server listens on."),
1628 DEF_PGPORT, 1, 65535,
1633 {"unix_socket_permissions", PGC_POSTMASTER, CONN_AUTH_SETTINGS,
1634 gettext_noop("Sets the access permissions of the Unix-domain socket."),
1635 gettext_noop("Unix-domain sockets use the usual Unix file system "
1636 "permission set. The parameter value is expected "
1637 "to be a numeric mode specification in the form "
1638 "accepted by the chmod and umask system calls. "
1639 "(To use the customary octal format the number must "
1640 "start with a 0 (zero).)")
1642 &Unix_socket_permissions,
1644 NULL, NULL, show_unix_socket_permissions
1648 {"log_file_mode", PGC_SIGHUP, LOGGING_WHERE,
1649 gettext_noop("Sets the file permissions for log files."),
1650 gettext_noop("The parameter value is expected "
1651 "to be a numeric mode specification in the form "
1652 "accepted by the chmod and umask system calls. "
1653 "(To use the customary octal format the number must "
1654 "start with a 0 (zero).)")
1658 NULL, NULL, show_log_file_mode
1662 {"work_mem", PGC_USERSET, RESOURCES_MEM,
1663 gettext_noop("Sets the maximum memory to be used for query workspaces."),
1664 gettext_noop("This much memory can be used by each internal "
1665 "sort operation and hash table before switching to "
1666 "temporary disk files."),
1670 1024, 64, MAX_KILOBYTES,
1675 {"maintenance_work_mem", PGC_USERSET, RESOURCES_MEM,
1676 gettext_noop("Sets the maximum memory to be used for maintenance operations."),
1677 gettext_noop("This includes operations such as VACUUM and CREATE INDEX."),
1680 &maintenance_work_mem,
1681 16384, 1024, MAX_KILOBYTES,
1686 * We use the hopefully-safely-small value of 100kB as the compiled-in
1687 * default for max_stack_depth. InitializeGUCOptions will increase it if
1688 * possible, depending on the actual platform-specific stack limit.
1691 {"max_stack_depth", PGC_SUSET, RESOURCES_MEM,
1692 gettext_noop("Sets the maximum stack depth, in kilobytes."),
1697 100, 100, MAX_KILOBYTES,
1698 check_max_stack_depth, assign_max_stack_depth, NULL
1702 {"temp_file_limit", PGC_SUSET, RESOURCES_DISK,
1703 gettext_noop("Limits the total size of all temp files used by each session."),
1704 gettext_noop("-1 means no limit."),
1713 {"vacuum_cost_page_hit", PGC_USERSET, RESOURCES_VACUUM_DELAY,
1714 gettext_noop("Vacuum cost for a page found in the buffer cache."),
1723 {"vacuum_cost_page_miss", PGC_USERSET, RESOURCES_VACUUM_DELAY,
1724 gettext_noop("Vacuum cost for a page not found in the buffer cache."),
1727 &VacuumCostPageMiss,
1733 {"vacuum_cost_page_dirty", PGC_USERSET, RESOURCES_VACUUM_DELAY,
1734 gettext_noop("Vacuum cost for a page dirtied by vacuum."),
1737 &VacuumCostPageDirty,
1743 {"vacuum_cost_limit", PGC_USERSET, RESOURCES_VACUUM_DELAY,
1744 gettext_noop("Vacuum cost amount available before napping."),
1753 {"vacuum_cost_delay", PGC_USERSET, RESOURCES_VACUUM_DELAY,
1754 gettext_noop("Vacuum cost delay in milliseconds."),
1764 {"autovacuum_vacuum_cost_delay", PGC_SIGHUP, AUTOVACUUM,
1765 gettext_noop("Vacuum cost delay in milliseconds, for autovacuum."),
1769 &autovacuum_vac_cost_delay,
1775 {"autovacuum_vacuum_cost_limit", PGC_SIGHUP, AUTOVACUUM,
1776 gettext_noop("Vacuum cost amount available before napping, for autovacuum."),
1779 &autovacuum_vac_cost_limit,
1785 {"max_files_per_process", PGC_POSTMASTER, RESOURCES_KERNEL,
1786 gettext_noop("Sets the maximum number of simultaneously open files for each server process."),
1789 &max_files_per_process,
1795 * See also CheckRequiredParameterValues() if this parameter changes
1798 {"max_prepared_transactions", PGC_POSTMASTER, RESOURCES_MEM,
1799 gettext_noop("Sets the maximum number of simultaneously prepared transactions."),
1802 &max_prepared_xacts,
1809 {"trace_lock_oidmin", PGC_SUSET, DEVELOPER_OPTIONS,
1810 gettext_noop("No description available."),
1815 FirstNormalObjectId, 0, INT_MAX,
1819 {"trace_lock_table", PGC_SUSET, DEVELOPER_OPTIONS,
1820 gettext_noop("No description available."),
1831 {"statement_timeout", PGC_USERSET, CLIENT_CONN_STATEMENT,
1832 gettext_noop("Sets the maximum allowed duration of any statement."),
1833 gettext_noop("A value of 0 turns off the timeout."),
1842 {"vacuum_freeze_min_age", PGC_USERSET, CLIENT_CONN_STATEMENT,
1843 gettext_noop("Minimum age at which VACUUM should freeze a table row."),
1846 &vacuum_freeze_min_age,
1847 50000000, 0, 1000000000,
1852 {"vacuum_freeze_table_age", PGC_USERSET, CLIENT_CONN_STATEMENT,
1853 gettext_noop("Age at which VACUUM should scan whole table to freeze tuples."),
1856 &vacuum_freeze_table_age,
1857 150000000, 0, 2000000000,
1862 {"vacuum_defer_cleanup_age", PGC_SIGHUP, REPLICATION_MASTER,
1863 gettext_noop("Number of transactions by which VACUUM and HOT cleanup should be deferred, if any."),
1866 &vacuum_defer_cleanup_age,
1872 * See also CheckRequiredParameterValues() if this parameter changes
1875 {"max_locks_per_transaction", PGC_POSTMASTER, LOCK_MANAGEMENT,
1876 gettext_noop("Sets the maximum number of locks per transaction."),
1877 gettext_noop("The shared lock table is sized on the assumption that "
1878 "at most max_locks_per_transaction * max_connections distinct "
1879 "objects will need to be locked at any one time.")
1881 &max_locks_per_xact,
1887 {"max_pred_locks_per_transaction", PGC_POSTMASTER, LOCK_MANAGEMENT,
1888 gettext_noop("Sets the maximum number of predicate locks per transaction."),
1889 gettext_noop("The shared predicate lock table is sized on the assumption that "
1890 "at most max_pred_locks_per_transaction * max_connections distinct "
1891 "objects will need to be locked at any one time.")
1893 &max_predicate_locks_per_xact,
1899 {"authentication_timeout", PGC_SIGHUP, CONN_AUTH_SECURITY,
1900 gettext_noop("Sets the maximum allowed time to complete client authentication."),
1904 &AuthenticationTimeout,
1910 /* Not for general use */
1911 {"pre_auth_delay", PGC_SIGHUP, DEVELOPER_OPTIONS,
1912 gettext_noop("Waits N seconds on connection startup before authentication."),
1913 gettext_noop("This allows attaching a debugger to the process."),
1914 GUC_NOT_IN_SAMPLE | GUC_UNIT_S
1922 {"wal_keep_segments", PGC_SIGHUP, REPLICATION_SENDING,
1923 gettext_noop("Sets the number of WAL files held for standby servers."),
1932 {"checkpoint_segments", PGC_SIGHUP, WAL_CHECKPOINTS,
1933 gettext_noop("Sets the maximum distance in log segments between automatic WAL checkpoints."),
1936 &CheckPointSegments,
1942 {"checkpoint_timeout", PGC_SIGHUP, WAL_CHECKPOINTS,
1943 gettext_noop("Sets the maximum time between automatic WAL checkpoints."),
1953 {"checkpoint_warning", PGC_SIGHUP, WAL_CHECKPOINTS,
1954 gettext_noop("Enables warnings if checkpoint segments are filled more "
1955 "frequently than this."),
1956 gettext_noop("Write a message to the server log if checkpoints "
1957 "caused by the filling of checkpoint segment files happens more "
1958 "frequently than this number of seconds. Zero turns off the warning."),
1967 {"wal_buffers", PGC_POSTMASTER, WAL_SETTINGS,
1968 gettext_noop("Sets the number of disk-page buffers in shared memory for WAL."),
1974 check_wal_buffers, NULL, NULL
1978 {"wal_writer_delay", PGC_SIGHUP, WAL_SETTINGS,
1979 gettext_noop("WAL writer sleep time between WAL flushes."),
1989 /* see max_connections */
1990 {"max_wal_senders", PGC_POSTMASTER, REPLICATION_SENDING,
1991 gettext_noop("Sets the maximum number of simultaneously running WAL sender processes."),
2000 {"replication_timeout", PGC_SIGHUP, REPLICATION_SENDING,
2001 gettext_noop("Sets the maximum time to wait for WAL replication."),
2005 &replication_timeout,
2006 60 * 1000, 0, INT_MAX,
2011 {"commit_delay", PGC_USERSET, WAL_SETTINGS,
2012 gettext_noop("Sets the delay in microseconds between transaction commit and "
2013 "flushing WAL to disk."),
2022 {"commit_siblings", PGC_USERSET, WAL_SETTINGS,
2023 gettext_noop("Sets the minimum concurrent open transactions before performing "
2033 {"extra_float_digits", PGC_USERSET, CLIENT_CONN_LOCALE,
2034 gettext_noop("Sets the number of digits displayed for floating-point values."),
2035 gettext_noop("This affects real, double precision, and geometric data types. "
2036 "The parameter value is added to the standard number of digits "
2037 "(FLT_DIG or DBL_DIG as appropriate).")
2039 &extra_float_digits,
2045 {"log_min_duration_statement", PGC_SUSET, LOGGING_WHEN,
2046 gettext_noop("Sets the minimum execution time above which "
2047 "statements will be logged."),
2048 gettext_noop("Zero prints all queries. -1 turns this feature off."),
2051 &log_min_duration_statement,
2057 {"log_autovacuum_min_duration", PGC_SIGHUP, LOGGING_WHAT,
2058 gettext_noop("Sets the minimum execution time above which "
2059 "autovacuum actions will be logged."),
2060 gettext_noop("Zero prints all actions. -1 turns autovacuum logging off."),
2063 &Log_autovacuum_min_duration,
2069 {"bgwriter_delay", PGC_SIGHUP, RESOURCES_BGWRITER,
2070 gettext_noop("Background writer sleep time between rounds."),
2080 {"bgwriter_lru_maxpages", PGC_SIGHUP, RESOURCES_BGWRITER,
2081 gettext_noop("Background writer maximum number of LRU pages to flush per round."),
2084 &bgwriter_lru_maxpages,
2090 {"effective_io_concurrency",
2096 RESOURCES_ASYNCHRONOUS,
2097 gettext_noop("Number of simultaneous requests that can be handled efficiently by the disk subsystem."),
2098 gettext_noop("For RAID arrays, this should be approximately the number of drive spindles in the array.")
2100 &effective_io_concurrency,
2106 check_effective_io_concurrency, assign_effective_io_concurrency, NULL
2110 {"log_rotation_age", PGC_SIGHUP, LOGGING_WHERE,
2111 gettext_noop("Automatic log file rotation will occur after N minutes."),
2116 HOURS_PER_DAY * MINS_PER_HOUR, 0, INT_MAX / MINS_PER_HOUR,
2121 {"log_rotation_size", PGC_SIGHUP, LOGGING_WHERE,
2122 gettext_noop("Automatic log file rotation will occur after N kilobytes."),
2127 10 * 1024, 0, INT_MAX / 1024,
2132 {"max_function_args", PGC_INTERNAL, PRESET_OPTIONS,
2133 gettext_noop("Shows the maximum number of function arguments."),
2135 GUC_NOT_IN_SAMPLE | GUC_DISALLOW_IN_FILE
2138 FUNC_MAX_ARGS, FUNC_MAX_ARGS, FUNC_MAX_ARGS,
2143 {"max_index_keys", PGC_INTERNAL, PRESET_OPTIONS,
2144 gettext_noop("Shows the maximum number of index keys."),
2146 GUC_NOT_IN_SAMPLE | GUC_DISALLOW_IN_FILE
2149 INDEX_MAX_KEYS, INDEX_MAX_KEYS, INDEX_MAX_KEYS,
2154 {"max_identifier_length", PGC_INTERNAL, PRESET_OPTIONS,
2155 gettext_noop("Shows the maximum identifier length."),
2157 GUC_NOT_IN_SAMPLE | GUC_DISALLOW_IN_FILE
2159 &max_identifier_length,
2160 NAMEDATALEN - 1, NAMEDATALEN - 1, NAMEDATALEN - 1,
2165 {"block_size", PGC_INTERNAL, PRESET_OPTIONS,
2166 gettext_noop("Shows the size of a disk block."),
2168 GUC_NOT_IN_SAMPLE | GUC_DISALLOW_IN_FILE
2171 BLCKSZ, BLCKSZ, BLCKSZ,
2176 {"segment_size", PGC_INTERNAL, PRESET_OPTIONS,
2177 gettext_noop("Shows the number of pages per disk file."),
2179 GUC_UNIT_BLOCKS | GUC_NOT_IN_SAMPLE | GUC_DISALLOW_IN_FILE
2182 RELSEG_SIZE, RELSEG_SIZE, RELSEG_SIZE,
2187 {"wal_block_size", PGC_INTERNAL, PRESET_OPTIONS,
2188 gettext_noop("Shows the block size in the write ahead log."),
2190 GUC_NOT_IN_SAMPLE | GUC_DISALLOW_IN_FILE
2193 XLOG_BLCKSZ, XLOG_BLCKSZ, XLOG_BLCKSZ,
2198 {"wal_segment_size", PGC_INTERNAL, PRESET_OPTIONS,
2199 gettext_noop("Shows the number of pages per write ahead log segment."),
2201 GUC_UNIT_XBLOCKS | GUC_NOT_IN_SAMPLE | GUC_DISALLOW_IN_FILE
2204 (XLOG_SEG_SIZE / XLOG_BLCKSZ),
2205 (XLOG_SEG_SIZE / XLOG_BLCKSZ),
2206 (XLOG_SEG_SIZE / XLOG_BLCKSZ),
2211 {"autovacuum_naptime", PGC_SIGHUP, AUTOVACUUM,
2212 gettext_noop("Time to sleep between autovacuum runs."),
2216 &autovacuum_naptime,
2217 60, 1, INT_MAX / 1000,
2221 {"autovacuum_vacuum_threshold", PGC_SIGHUP, AUTOVACUUM,
2222 gettext_noop("Minimum number of tuple updates or deletes prior to vacuum."),
2225 &autovacuum_vac_thresh,
2230 {"autovacuum_analyze_threshold", PGC_SIGHUP, AUTOVACUUM,
2231 gettext_noop("Minimum number of tuple inserts, updates or deletes prior to analyze."),
2234 &autovacuum_anl_thresh,
2239 /* see varsup.c for why this is PGC_POSTMASTER not PGC_SIGHUP */
2240 {"autovacuum_freeze_max_age", PGC_POSTMASTER, AUTOVACUUM,
2241 gettext_noop("Age at which to autovacuum a table to prevent transaction ID wraparound."),
2244 &autovacuum_freeze_max_age,
2245 /* see pg_resetxlog if you change the upper-limit value */
2246 200000000, 100000000, 2000000000,
2250 /* see max_connections */
2251 {"autovacuum_max_workers", PGC_POSTMASTER, AUTOVACUUM,
2252 gettext_noop("Sets the maximum number of simultaneously running autovacuum worker processes."),
2255 &autovacuum_max_workers,
2257 check_autovacuum_max_workers, assign_autovacuum_max_workers, NULL
2261 {"tcp_keepalives_idle", PGC_USERSET, CLIENT_CONN_OTHER,
2262 gettext_noop("Time between issuing TCP keepalives."),
2263 gettext_noop("A value of 0 uses the system default."),
2266 &tcp_keepalives_idle,
2268 NULL, assign_tcp_keepalives_idle, show_tcp_keepalives_idle
2272 {"tcp_keepalives_interval", PGC_USERSET, CLIENT_CONN_OTHER,
2273 gettext_noop("Time between TCP keepalive retransmits."),
2274 gettext_noop("A value of 0 uses the system default."),
2277 &tcp_keepalives_interval,
2279 NULL, assign_tcp_keepalives_interval, show_tcp_keepalives_interval
2283 {"ssl_renegotiation_limit", PGC_USERSET, CONN_AUTH_SECURITY,
2284 gettext_noop("Set the amount of traffic to send and receive before renegotiating the encryption keys."),
2288 &ssl_renegotiation_limit,
2289 512 * 1024, 0, MAX_KILOBYTES,
2294 {"tcp_keepalives_count", PGC_USERSET, CLIENT_CONN_OTHER,
2295 gettext_noop("Maximum number of TCP keepalive retransmits."),
2296 gettext_noop("This controls the number of consecutive keepalive retransmits that can be "
2297 "lost before a connection is considered dead. A value of 0 uses the "
2300 &tcp_keepalives_count,
2302 NULL, assign_tcp_keepalives_count, show_tcp_keepalives_count
2306 {"gin_fuzzy_search_limit", PGC_USERSET, CLIENT_CONN_OTHER,
2307 gettext_noop("Sets the maximum allowed result for exact search by GIN."),
2311 &GinFuzzySearchLimit,
2317 {"effective_cache_size", PGC_USERSET, QUERY_TUNING_COST,
2318 gettext_noop("Sets the planner's assumption about the size of the disk cache."),
2319 gettext_noop("That is, the portion of the kernel's disk cache that "
2320 "will be used for PostgreSQL data files. This is measured in disk "
2321 "pages, which are normally 8 kB each."),
2324 &effective_cache_size,
2325 DEFAULT_EFFECTIVE_CACHE_SIZE, 1, INT_MAX,
2330 /* Can't be set in postgresql.conf */
2331 {"server_version_num", PGC_INTERNAL, PRESET_OPTIONS,
2332 gettext_noop("Shows the server version as an integer."),
2334 GUC_NOT_IN_SAMPLE | GUC_DISALLOW_IN_FILE
2336 &server_version_num,
2337 PG_VERSION_NUM, PG_VERSION_NUM, PG_VERSION_NUM,
2342 {"log_temp_files", PGC_SUSET, LOGGING_WHAT,
2343 gettext_noop("Log the use of temporary files larger than this number of kilobytes."),
2344 gettext_noop("Zero logs all files. The default is -1 (turning this feature off)."),
2353 {"track_activity_query_size", PGC_POSTMASTER, RESOURCES_MEM,
2354 gettext_noop("Sets the size reserved for pg_stat_activity.current_query, in bytes."),
2357 &pgstat_track_activity_query_size,
2362 /* End-of-list marker */
2364 {NULL, 0, 0, NULL, NULL}, NULL, 0, 0, 0, NULL, NULL, NULL
2369 static struct config_real ConfigureNamesReal[] =
2372 {"seq_page_cost", PGC_USERSET, QUERY_TUNING_COST,
2373 gettext_noop("Sets the planner's estimate of the cost of a "
2374 "sequentially fetched disk page."),
2378 DEFAULT_SEQ_PAGE_COST, 0, DBL_MAX,
2382 {"random_page_cost", PGC_USERSET, QUERY_TUNING_COST,
2383 gettext_noop("Sets the planner's estimate of the cost of a "
2384 "nonsequentially fetched disk page."),
2388 DEFAULT_RANDOM_PAGE_COST, 0, DBL_MAX,
2392 {"cpu_tuple_cost", PGC_USERSET, QUERY_TUNING_COST,
2393 gettext_noop("Sets the planner's estimate of the cost of "
2394 "processing each tuple (row)."),
2398 DEFAULT_CPU_TUPLE_COST, 0, DBL_MAX,
2402 {"cpu_index_tuple_cost", PGC_USERSET, QUERY_TUNING_COST,
2403 gettext_noop("Sets the planner's estimate of the cost of "
2404 "processing each index entry during an index scan."),
2407 &cpu_index_tuple_cost,
2408 DEFAULT_CPU_INDEX_TUPLE_COST, 0, DBL_MAX,
2412 {"cpu_operator_cost", PGC_USERSET, QUERY_TUNING_COST,
2413 gettext_noop("Sets the planner's estimate of the cost of "
2414 "processing each operator or function call."),
2418 DEFAULT_CPU_OPERATOR_COST, 0, DBL_MAX,
2423 {"cursor_tuple_fraction", PGC_USERSET, QUERY_TUNING_OTHER,
2424 gettext_noop("Sets the planner's estimate of the fraction of "
2425 "a cursor's rows that will be retrieved."),
2428 &cursor_tuple_fraction,
2429 DEFAULT_CURSOR_TUPLE_FRACTION, 0.0, 1.0,
2434 {"geqo_selection_bias", PGC_USERSET, QUERY_TUNING_GEQO,
2435 gettext_noop("GEQO: selective pressure within the population."),
2438 &Geqo_selection_bias,
2439 DEFAULT_GEQO_SELECTION_BIAS,
2440 MIN_GEQO_SELECTION_BIAS, MAX_GEQO_SELECTION_BIAS,
2444 {"geqo_seed", PGC_USERSET, QUERY_TUNING_GEQO,
2445 gettext_noop("GEQO: seed for random path selection."),
2454 {"bgwriter_lru_multiplier", PGC_SIGHUP, RESOURCES_BGWRITER,
2455 gettext_noop("Multiple of the average buffer usage to free per round."),
2458 &bgwriter_lru_multiplier,
2464 {"seed", PGC_USERSET, UNGROUPED,
2465 gettext_noop("Sets the seed for random-number generation."),
2467 GUC_NO_SHOW_ALL | GUC_NO_RESET_ALL | GUC_NOT_IN_SAMPLE | GUC_DISALLOW_IN_FILE
2471 check_random_seed, assign_random_seed, show_random_seed
2475 {"autovacuum_vacuum_scale_factor", PGC_SIGHUP, AUTOVACUUM,
2476 gettext_noop("Number of tuple updates or deletes prior to vacuum as a fraction of reltuples."),
2479 &autovacuum_vac_scale,
2484 {"autovacuum_analyze_scale_factor", PGC_SIGHUP, AUTOVACUUM,
2485 gettext_noop("Number of tuple inserts, updates or deletes prior to analyze as a fraction of reltuples."),
2488 &autovacuum_anl_scale,
2494 {"checkpoint_completion_target", PGC_SIGHUP, WAL_CHECKPOINTS,
2495 gettext_noop("Time spent flushing dirty buffers during checkpoint, as fraction of checkpoint interval."),
2498 &CheckPointCompletionTarget,
2503 /* End-of-list marker */
2505 {NULL, 0, 0, NULL, NULL}, NULL, 0.0, 0.0, 0.0, NULL, NULL, NULL
2510 static struct config_string ConfigureNamesString[] =
2513 {"archive_command", PGC_SIGHUP, WAL_ARCHIVING,
2514 gettext_noop("Sets the shell command that will be called to archive a WAL file."),
2517 &XLogArchiveCommand,
2519 NULL, NULL, show_archive_command
2523 {"client_encoding", PGC_USERSET, CLIENT_CONN_LOCALE,
2524 gettext_noop("Sets the client's character set encoding."),
2526 GUC_IS_NAME | GUC_REPORT
2528 &client_encoding_string,
2530 check_client_encoding, assign_client_encoding, NULL
2534 {"log_line_prefix", PGC_SIGHUP, LOGGING_WHAT,
2535 gettext_noop("Controls information prefixed to each log line."),
2536 gettext_noop("If blank, no prefix is used.")
2544 {"log_timezone", PGC_SIGHUP, LOGGING_WHAT,
2545 gettext_noop("Sets the time zone to use in log messages."),
2548 &log_timezone_string,
2550 check_log_timezone, assign_log_timezone, show_log_timezone
2554 {"DateStyle", PGC_USERSET, CLIENT_CONN_LOCALE,
2555 gettext_noop("Sets the display format for date and time values."),
2556 gettext_noop("Also controls interpretation of ambiguous "
2558 GUC_LIST_INPUT | GUC_REPORT
2562 check_datestyle, assign_datestyle, NULL
2566 {"default_tablespace", PGC_USERSET, CLIENT_CONN_STATEMENT,
2567 gettext_noop("Sets the default tablespace to create tables and indexes in."),
2568 gettext_noop("An empty string selects the database's default tablespace."),
2571 &default_tablespace,
2573 check_default_tablespace, NULL, NULL
2577 {"temp_tablespaces", PGC_USERSET, CLIENT_CONN_STATEMENT,
2578 gettext_noop("Sets the tablespace(s) to use for temporary tables and sort files."),
2580 GUC_LIST_INPUT | GUC_LIST_QUOTE
2584 check_temp_tablespaces, assign_temp_tablespaces, NULL
2588 {"dynamic_library_path", PGC_SUSET, CLIENT_CONN_OTHER,
2589 gettext_noop("Sets the path for dynamically loadable modules."),
2590 gettext_noop("If a dynamically loadable module needs to be opened and "
2591 "the specified name does not have a directory component (i.e., the "
2592 "name does not contain a slash), the system will search this path for "
2593 "the specified file."),
2596 &Dynamic_library_path,
2602 {"krb_server_keyfile", PGC_SIGHUP, CONN_AUTH_SECURITY,
2603 gettext_noop("Sets the location of the Kerberos server key file."),
2607 &pg_krb_server_keyfile,
2613 {"krb_srvname", PGC_SIGHUP, CONN_AUTH_SECURITY,
2614 gettext_noop("Sets the name of the Kerberos service."),
2623 {"bonjour_name", PGC_POSTMASTER, CONN_AUTH_SETTINGS,
2624 gettext_noop("Sets the Bonjour service name."),
2632 /* See main.c about why defaults for LC_foo are not all alike */
2635 {"lc_collate", PGC_INTERNAL, CLIENT_CONN_LOCALE,
2636 gettext_noop("Shows the collation order locale."),
2638 GUC_NOT_IN_SAMPLE | GUC_DISALLOW_IN_FILE
2646 {"lc_ctype", PGC_INTERNAL, CLIENT_CONN_LOCALE,
2647 gettext_noop("Shows the character classification and case conversion locale."),
2649 GUC_NOT_IN_SAMPLE | GUC_DISALLOW_IN_FILE
2657 {"lc_messages", PGC_SUSET, CLIENT_CONN_LOCALE,
2658 gettext_noop("Sets the language in which messages are displayed."),
2663 check_locale_messages, assign_locale_messages, NULL
2667 {"lc_monetary", PGC_USERSET, CLIENT_CONN_LOCALE,
2668 gettext_noop("Sets the locale for formatting monetary amounts."),
2673 check_locale_monetary, assign_locale_monetary, NULL
2677 {"lc_numeric", PGC_USERSET, CLIENT_CONN_LOCALE,
2678 gettext_noop("Sets the locale for formatting numbers."),
2683 check_locale_numeric, assign_locale_numeric, NULL
2687 {"lc_time", PGC_USERSET, CLIENT_CONN_LOCALE,
2688 gettext_noop("Sets the locale for formatting date and time values."),
2693 check_locale_time, assign_locale_time, NULL
2697 {"shared_preload_libraries", PGC_POSTMASTER, RESOURCES_KERNEL,
2698 gettext_noop("Lists shared libraries to preload into server."),
2700 GUC_LIST_INPUT | GUC_LIST_QUOTE | GUC_SUPERUSER_ONLY
2702 &shared_preload_libraries_string,
2708 {"local_preload_libraries", PGC_BACKEND, CLIENT_CONN_OTHER,
2709 gettext_noop("Lists shared libraries to preload into each backend."),
2711 GUC_LIST_INPUT | GUC_LIST_QUOTE
2713 &local_preload_libraries_string,
2719 {"search_path", PGC_USERSET, CLIENT_CONN_STATEMENT,
2720 gettext_noop("Sets the schema search order for names that are not schema-qualified."),
2722 GUC_LIST_INPUT | GUC_LIST_QUOTE
2724 &namespace_search_path,
2726 check_search_path, assign_search_path, NULL
2730 /* Can't be set in postgresql.conf */
2731 {"server_encoding", PGC_INTERNAL, CLIENT_CONN_LOCALE,
2732 gettext_noop("Sets the server (database) character set encoding."),
2734 GUC_IS_NAME | GUC_REPORT | GUC_NOT_IN_SAMPLE | GUC_DISALLOW_IN_FILE
2736 &server_encoding_string,
2742 /* Can't be set in postgresql.conf */
2743 {"server_version", PGC_INTERNAL, PRESET_OPTIONS,
2744 gettext_noop("Shows the server version."),
2746 GUC_REPORT | GUC_NOT_IN_SAMPLE | GUC_DISALLOW_IN_FILE
2748 &server_version_string,
2754 /* Not for general use --- used by SET ROLE */
2755 {"role", PGC_USERSET, UNGROUPED,
2756 gettext_noop("Sets the current role."),
2758 GUC_IS_NAME | GUC_NO_SHOW_ALL | GUC_NO_RESET_ALL | GUC_NOT_IN_SAMPLE | GUC_DISALLOW_IN_FILE | GUC_NOT_WHILE_SEC_REST
2762 check_role, assign_role, show_role
2766 /* Not for general use --- used by SET SESSION AUTHORIZATION */
2767 {"session_authorization", PGC_USERSET, UNGROUPED,
2768 gettext_noop("Sets the session user name."),
2770 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
2772 &session_authorization_string,
2774 check_session_authorization, assign_session_authorization, NULL
2778 {"log_destination", PGC_SIGHUP, LOGGING_WHERE,
2779 gettext_noop("Sets the destination for server log output."),
2780 gettext_noop("Valid values are combinations of \"stderr\", "
2781 "\"syslog\", \"csvlog\", and \"eventlog\", "
2782 "depending on the platform."),
2785 &log_destination_string,
2787 check_log_destination, assign_log_destination, NULL
2790 {"log_directory", PGC_SIGHUP, LOGGING_WHERE,
2791 gettext_noop("Sets the destination directory for log files."),
2792 gettext_noop("Can be specified as relative to the data directory "
2793 "or as absolute path."),
2798 check_canonical_path, NULL, NULL
2801 {"log_filename", PGC_SIGHUP, LOGGING_WHERE,
2802 gettext_noop("Sets the file name pattern for log files."),
2807 "postgresql-%Y-%m-%d_%H%M%S.log",
2812 {"syslog_ident", PGC_SIGHUP, LOGGING_WHERE,
2813 gettext_noop("Sets the program name used to identify PostgreSQL "
2814 "messages in syslog."),
2819 NULL, assign_syslog_ident, NULL
2823 {"TimeZone", PGC_USERSET, CLIENT_CONN_LOCALE,
2824 gettext_noop("Sets the time zone for displaying and interpreting time stamps."),
2830 check_timezone, assign_timezone, show_timezone
2833 {"timezone_abbreviations", PGC_USERSET, CLIENT_CONN_LOCALE,
2834 gettext_noop("Selects a file of time zone abbreviations."),
2837 &timezone_abbreviations_string,
2839 check_timezone_abbreviations, assign_timezone_abbreviations, NULL
2843 {"transaction_isolation", PGC_USERSET, CLIENT_CONN_STATEMENT,
2844 gettext_noop("Sets the current transaction's isolation level."),
2846 GUC_NO_RESET_ALL | GUC_NOT_IN_SAMPLE | GUC_DISALLOW_IN_FILE
2848 &XactIsoLevel_string,
2850 check_XactIsoLevel, assign_XactIsoLevel, show_XactIsoLevel
2854 {"unix_socket_group", PGC_POSTMASTER, CONN_AUTH_SETTINGS,
2855 gettext_noop("Sets the owning group of the Unix-domain socket."),
2856 gettext_noop("The owning user of the socket is always the user "
2857 "that starts the server.")
2865 {"unix_socket_directory", PGC_POSTMASTER, CONN_AUTH_SETTINGS,
2866 gettext_noop("Sets the directory where the Unix-domain socket will be created."),
2872 check_canonical_path, NULL, NULL
2876 {"listen_addresses", PGC_POSTMASTER, CONN_AUTH_SETTINGS,
2877 gettext_noop("Sets the host name or IP address(es) to listen to."),
2887 {"data_directory", PGC_POSTMASTER, FILE_LOCATIONS,
2888 gettext_noop("Sets the server's data directory."),
2898 {"config_file", PGC_POSTMASTER, FILE_LOCATIONS,
2899 gettext_noop("Sets the server's main configuration file."),
2901 GUC_DISALLOW_IN_FILE | GUC_SUPERUSER_ONLY
2909 {"hba_file", PGC_POSTMASTER, FILE_LOCATIONS,
2910 gettext_noop("Sets the server's \"hba\" configuration file."),
2920 {"ident_file", PGC_POSTMASTER, FILE_LOCATIONS,
2921 gettext_noop("Sets the server's \"ident\" configuration file."),
2931 {"external_pid_file", PGC_POSTMASTER, FILE_LOCATIONS,
2932 gettext_noop("Writes the postmaster PID to the specified file."),
2938 check_canonical_path, NULL, NULL
2942 {"stats_temp_directory", PGC_SIGHUP, STATS_COLLECTOR,
2943 gettext_noop("Writes temporary statistics files to the specified directory."),
2947 &pgstat_temp_directory,
2949 check_canonical_path, assign_pgstat_temp_directory, NULL
2953 {"synchronous_standby_names", PGC_SIGHUP, REPLICATION_MASTER,
2954 gettext_noop("List of names of potential synchronous standbys."),
2958 &SyncRepStandbyNames,
2960 check_synchronous_standby_names, NULL, NULL
2964 {"default_text_search_config", PGC_USERSET, CLIENT_CONN_LOCALE,
2965 gettext_noop("Sets default text search configuration."),
2969 "pg_catalog.simple",
2970 check_TSCurrentConfig, assign_TSCurrentConfig, NULL
2974 {"ssl_ciphers", PGC_POSTMASTER, CONN_AUTH_SECURITY,
2975 gettext_noop("Sets the list of allowed SSL ciphers."),
2981 "ALL:!ADH:!LOW:!EXP:!MD5:@STRENGTH",
2989 {"application_name", PGC_USERSET, LOGGING_WHAT,
2990 gettext_noop("Sets the application name to be reported in statistics and logs."),
2992 GUC_IS_NAME | GUC_REPORT | GUC_NOT_IN_SAMPLE
2996 check_application_name, assign_application_name, NULL
2999 /* End-of-list marker */
3001 {NULL, 0, 0, NULL, NULL}, NULL, NULL, NULL, NULL, NULL
3006 static struct config_enum ConfigureNamesEnum[] =
3009 {"backslash_quote", PGC_USERSET, COMPAT_OPTIONS_PREVIOUS,
3010 gettext_noop("Sets whether \"\\'\" is allowed in string literals."),
3014 BACKSLASH_QUOTE_SAFE_ENCODING, backslash_quote_options,
3019 {"bytea_output", PGC_USERSET, CLIENT_CONN_STATEMENT,
3020 gettext_noop("Sets the output format for bytea."),
3024 BYTEA_OUTPUT_HEX, bytea_output_options,
3029 {"client_min_messages", PGC_USERSET, LOGGING_WHEN,
3030 gettext_noop("Sets the message levels that are sent to the client."),
3031 gettext_noop("Each level includes all the levels that follow it. The later"
3032 " the level, the fewer messages are sent.")
3034 &client_min_messages,
3035 NOTICE, client_message_level_options,
3040 {"constraint_exclusion", PGC_USERSET, QUERY_TUNING_OTHER,
3041 gettext_noop("Enables the planner to use constraints to optimize queries."),
3042 gettext_noop("Table scans will be skipped if their constraints"
3043 " guarantee that no rows match the query.")
3045 &constraint_exclusion,
3046 CONSTRAINT_EXCLUSION_PARTITION, constraint_exclusion_options,
3051 {"default_transaction_isolation", PGC_USERSET, CLIENT_CONN_STATEMENT,
3052 gettext_noop("Sets the transaction isolation level of each new transaction."),
3055 &DefaultXactIsoLevel,
3056 XACT_READ_COMMITTED, isolation_level_options,
3061 {"IntervalStyle", PGC_USERSET, CLIENT_CONN_LOCALE,
3062 gettext_noop("Sets the display format for interval values."),
3067 INTSTYLE_POSTGRES, intervalstyle_options,
3072 {"log_error_verbosity", PGC_SUSET, LOGGING_WHAT,
3073 gettext_noop("Sets the verbosity of logged messages."),
3076 &Log_error_verbosity,
3077 PGERROR_DEFAULT, log_error_verbosity_options,
3082 {"log_min_messages", PGC_SUSET, LOGGING_WHEN,
3083 gettext_noop("Sets the message levels that are logged."),
3084 gettext_noop("Each level includes all the levels that follow it. The later"
3085 " the level, the fewer messages are sent.")
3088 WARNING, server_message_level_options,
3093 {"log_min_error_statement", PGC_SUSET, LOGGING_WHEN,
3094 gettext_noop("Causes all statements generating error at or above this level to be logged."),
3095 gettext_noop("Each level includes all the levels that follow it. The later"
3096 " the level, the fewer messages are sent.")
3098 &log_min_error_statement,
3099 ERROR, server_message_level_options,
3104 {"log_statement", PGC_SUSET, LOGGING_WHAT,
3105 gettext_noop("Sets the type of statements logged."),
3109 LOGSTMT_NONE, log_statement_options,
3114 {"syslog_facility", PGC_SIGHUP, LOGGING_WHERE,
3115 gettext_noop("Sets the syslog \"facility\" to be used when syslog enabled."),
3124 syslog_facility_options,
3125 NULL, assign_syslog_facility, NULL
3129 {"session_replication_role", PGC_SUSET, CLIENT_CONN_STATEMENT,
3130 gettext_noop("Sets the session's behavior for triggers and rewrite rules."),
3133 &SessionReplicationRole,
3134 SESSION_REPLICATION_ROLE_ORIGIN, session_replication_role_options,
3135 NULL, assign_session_replication_role, NULL
3139 {"synchronous_commit", PGC_USERSET, WAL_SETTINGS,
3140 gettext_noop("Sets the current transaction's synchronization level."),
3143 &synchronous_commit,
3144 SYNCHRONOUS_COMMIT_ON, synchronous_commit_options,
3149 {"trace_recovery_messages", PGC_SIGHUP, DEVELOPER_OPTIONS,
3150 gettext_noop("Enables logging of recovery-related debugging information."),
3151 gettext_noop("Each level includes all the levels that follow it. The later"
3152 " the level, the fewer messages are sent.")
3154 &trace_recovery_messages,
3157 * client_message_level_options allows too many values, really, but
3158 * it's not worth having a separate options array for this.
3160 LOG, client_message_level_options,
3165 {"track_functions", PGC_SUSET, STATS_COLLECTOR,
3166 gettext_noop("Collects function-level statistics on database activity."),
3169 &pgstat_track_functions,
3170 TRACK_FUNC_OFF, track_function_options,
3175 {"wal_level", PGC_POSTMASTER, WAL_SETTINGS,
3176 gettext_noop("Set the level of information written to the WAL."),
3180 WAL_LEVEL_MINIMAL, wal_level_options,
3185 {"wal_sync_method", PGC_SIGHUP, WAL_SETTINGS,
3186 gettext_noop("Selects the method used for forcing WAL updates to disk."),
3190 DEFAULT_SYNC_METHOD, sync_method_options,
3191 NULL, assign_xlog_sync_method, NULL
3195 {"xmlbinary", PGC_USERSET, CLIENT_CONN_STATEMENT,
3196 gettext_noop("Sets how binary values are to be encoded in XML."),
3200 XMLBINARY_BASE64, xmlbinary_options,
3205 {"xmloption", PGC_USERSET, CLIENT_CONN_STATEMENT,
3206 gettext_noop("Sets whether XML data in implicit parsing and serialization "
3207 "operations is to be considered as documents or content fragments."),
3211 XMLOPTION_CONTENT, xmloption_options,
3216 /* End-of-list marker */
3218 {NULL, 0, 0, NULL, NULL}, NULL, 0, NULL, NULL, NULL, NULL
3222 /******** end of options list ********/
3226 * To allow continued support of obsolete names for GUC variables, we apply
3227 * the following mappings to any unrecognized name. Note that an old name
3228 * should be mapped to a new one only if the new variable has very similar
3229 * semantics to the old.
3231 static const char *const map_old_guc_names[] = {
3232 "sort_mem", "work_mem",
3233 "vacuum_mem", "maintenance_work_mem",
3239 * Actual lookup of variables is done through this single, sorted array.
3241 static struct config_generic **guc_variables;
3243 /* Current number of variables contained in the vector */
3244 static int num_guc_variables;
3246 /* Vector capacity */
3247 static int size_guc_variables;
3250 static bool guc_dirty; /* TRUE if need to do commit/abort work */
3252 static bool reporting_enabled; /* TRUE to enable GUC_REPORT */
3254 static int GUCNestLevel = 0; /* 1 when in main transaction */
3257 static int guc_var_compare(const void *a, const void *b);
3258 static int guc_name_compare(const char *namea, const char *nameb);
3259 static void InitializeGUCOptionsFromEnvironment(void);
3260 static void InitializeOneGUCOption(struct config_generic * gconf);
3261 static void push_old_value(struct config_generic * gconf, GucAction action);
3262 static void ReportGUCOption(struct config_generic * record);
3263 static void ShowGUCConfigOption(const char *name, DestReceiver *dest);
3264 static void ShowAllGUCConfig(DestReceiver *dest);
3265 static char *_ShowOption(struct config_generic * record, bool use_units);
3266 static bool validate_option_array_item(const char *name, const char *value,
3267 bool skipIfNoPermissions);
3271 * Some infrastructure for checking malloc/strdup/realloc calls
3274 guc_malloc(int elevel, size_t size)
3278 data = malloc(size);
3281 (errcode(ERRCODE_OUT_OF_MEMORY),
3282 errmsg("out of memory")));
3287 guc_realloc(int elevel, void *old, size_t size)
3291 data = realloc(old, size);
3294 (errcode(ERRCODE_OUT_OF_MEMORY),
3295 errmsg("out of memory")));
3300 guc_strdup(int elevel, const char *src)
3307 (errcode(ERRCODE_OUT_OF_MEMORY),
3308 errmsg("out of memory")));
3314 * Detect whether strval is referenced anywhere in a GUC string item
3317 string_field_used(struct config_string * conf, char *strval)
3321 if (strval == *(conf->variable) ||
3322 strval == conf->reset_val ||
3323 strval == conf->boot_val)
3325 for (stack = conf->gen.stack; stack; stack = stack->prev)
3327 if (strval == stack->prior.val.stringval ||
3328 strval == stack->masked.val.stringval)
3335 * Support for assigning to a field of a string GUC item. Free the prior
3336 * value if it's not referenced anywhere else in the item (including stacked
3340 set_string_field(struct config_string * conf, char **field, char *newval)
3342 char *oldval = *field;
3344 /* Do the assignment */
3347 /* Free old value if it's not NULL and isn't referenced anymore */
3348 if (oldval && !string_field_used(conf, oldval))
3353 * Detect whether an "extra" struct is referenced anywhere in a GUC item
3356 extra_field_used(struct config_generic * gconf, void *extra)
3360 if (extra == gconf->extra)
3362 switch (gconf->vartype)
3365 if (extra == ((struct config_bool *) gconf)->reset_extra)
3369 if (extra == ((struct config_int *) gconf)->reset_extra)
3373 if (extra == ((struct config_real *) gconf)->reset_extra)
3377 if (extra == ((struct config_string *) gconf)->reset_extra)
3381 if (extra == ((struct config_enum *) gconf)->reset_extra)
3385 for (stack = gconf->stack; stack; stack = stack->prev)
3387 if (extra == stack->prior.extra ||
3388 extra == stack->masked.extra)
3396 * Support for assigning to an "extra" field of a GUC item. Free the prior
3397 * value if it's not referenced anywhere else in the item (including stacked
3401 set_extra_field(struct config_generic * gconf, void **field, void *newval)
3403 void *oldval = *field;
3405 /* Do the assignment */
3408 /* Free old value if it's not NULL and isn't referenced anymore */
3409 if (oldval && !extra_field_used(gconf, oldval))
3414 * Support for copying a variable's active value into a stack entry.
3415 * The "extra" field associated with the active value is copied, too.
3417 * NB: be sure stringval and extra fields of a new stack entry are
3418 * initialized to NULL before this is used, else we'll try to free() them.
3421 set_stack_value(struct config_generic * gconf, config_var_value *val)
3423 switch (gconf->vartype)
3427 *((struct config_bool *) gconf)->variable;
3431 *((struct config_int *) gconf)->variable;
3435 *((struct config_real *) gconf)->variable;
3438 set_string_field((struct config_string *) gconf,
3439 &(val->val.stringval),
3440 *((struct config_string *) gconf)->variable);
3444 *((struct config_enum *) gconf)->variable;
3447 set_extra_field(gconf, &(val->extra), gconf->extra);
3451 * Support for discarding a no-longer-needed value in a stack entry.
3452 * The "extra" field associated with the stack entry is cleared, too.
3455 discard_stack_value(struct config_generic * gconf, config_var_value *val)
3457 switch (gconf->vartype)
3463 /* no need to do anything */
3466 set_string_field((struct config_string *) gconf,
3467 &(val->val.stringval),
3471 set_extra_field(gconf, &(val->extra), NULL);
3476 * Fetch the sorted array pointer (exported for help_config.c's use ONLY)
3478 struct config_generic **
3479 get_guc_variables(void)
3481 return guc_variables;
3486 * Build the sorted array. This is split out so that it could be
3487 * re-executed after startup (eg, we could allow loadable modules to
3488 * add vars, and then we'd need to re-sort).
3491 build_guc_variables(void)
3495 struct config_generic **guc_vars;
3498 for (i = 0; ConfigureNamesBool[i].gen.name; i++)
3500 struct config_bool *conf = &ConfigureNamesBool[i];
3502 /* Rather than requiring vartype to be filled in by hand, do this: */
3503 conf->gen.vartype = PGC_BOOL;
3507 for (i = 0; ConfigureNamesInt[i].gen.name; i++)
3509 struct config_int *conf = &ConfigureNamesInt[i];
3511 conf->gen.vartype = PGC_INT;
3515 for (i = 0; ConfigureNamesReal[i].gen.name; i++)
3517 struct config_real *conf = &ConfigureNamesReal[i];
3519 conf->gen.vartype = PGC_REAL;
3523 for (i = 0; ConfigureNamesString[i].gen.name; i++)
3525 struct config_string *conf = &ConfigureNamesString[i];
3527 conf->gen.vartype = PGC_STRING;
3531 for (i = 0; ConfigureNamesEnum[i].gen.name; i++)
3533 struct config_enum *conf = &ConfigureNamesEnum[i];
3535 conf->gen.vartype = PGC_ENUM;
3540 * Create table with 20% slack
3542 size_vars = num_vars + num_vars / 4;
3544 guc_vars = (struct config_generic **)
3545 guc_malloc(FATAL, size_vars * sizeof(struct config_generic *));
3549 for (i = 0; ConfigureNamesBool[i].gen.name; i++)
3550 guc_vars[num_vars++] = &ConfigureNamesBool[i].gen;
3552 for (i = 0; ConfigureNamesInt[i].gen.name; i++)
3553 guc_vars[num_vars++] = &ConfigureNamesInt[i].gen;
3555 for (i = 0; ConfigureNamesReal[i].gen.name; i++)
3556 guc_vars[num_vars++] = &ConfigureNamesReal[i].gen;
3558 for (i = 0; ConfigureNamesString[i].gen.name; i++)
3559 guc_vars[num_vars++] = &ConfigureNamesString[i].gen;
3561 for (i = 0; ConfigureNamesEnum[i].gen.name; i++)
3562 guc_vars[num_vars++] = &ConfigureNamesEnum[i].gen;
3565 free(guc_variables);
3566 guc_variables = guc_vars;
3567 num_guc_variables = num_vars;
3568 size_guc_variables = size_vars;
3569 qsort((void *) guc_variables, num_guc_variables,
3570 sizeof(struct config_generic *), guc_var_compare);
3574 * Add a new GUC variable to the list of known variables. The
3575 * list is expanded if needed.
3578 add_guc_variable(struct config_generic * var, int elevel)
3580 if (num_guc_variables + 1 >= size_guc_variables)
3583 * Increase the vector by 25%
3585 int size_vars = size_guc_variables + size_guc_variables / 4;
3586 struct config_generic **guc_vars;
3591 guc_vars = (struct config_generic **)
3592 guc_malloc(elevel, size_vars * sizeof(struct config_generic *));
3596 guc_vars = (struct config_generic **)
3597 guc_realloc(elevel, guc_variables, size_vars * sizeof(struct config_generic *));
3600 if (guc_vars == NULL)
3601 return false; /* out of memory */
3603 guc_variables = guc_vars;
3604 size_guc_variables = size_vars;
3606 guc_variables[num_guc_variables++] = var;
3607 qsort((void *) guc_variables, num_guc_variables,
3608 sizeof(struct config_generic *), guc_var_compare);
3613 * Create and add a placeholder variable for a custom variable name.
3615 static struct config_generic *
3616 add_placeholder_variable(const char *name, int elevel)
3618 size_t sz = sizeof(struct config_string) + sizeof(char *);
3619 struct config_string *var;
3620 struct config_generic *gen;
3622 var = (struct config_string *) guc_malloc(elevel, sz);
3628 gen->name = guc_strdup(elevel, name);
3629 if (gen->name == NULL)
3635 gen->context = PGC_USERSET;
3636 gen->group = CUSTOM_OPTIONS;
3637 gen->short_desc = "GUC placeholder variable";
3638 gen->flags = GUC_NO_SHOW_ALL | GUC_NOT_IN_SAMPLE | GUC_CUSTOM_PLACEHOLDER;
3639 gen->vartype = PGC_STRING;
3642 * The char* is allocated at the end of the struct since we have no
3643 * 'static' place to point to. Note that the current value, as well as
3644 * the boot and reset values, start out NULL.
3646 var->variable = (char **) (var + 1);
3648 if (!add_guc_variable((struct config_generic *) var, elevel))
3650 free((void *) gen->name);
3659 * Look up option NAME. If it exists, return a pointer to its record,
3660 * else return NULL. If create_placeholders is TRUE, we'll create a
3661 * placeholder record for a valid-looking custom variable name.
3663 static struct config_generic *
3664 find_option(const char *name, bool create_placeholders, int elevel)
3666 const char **key = &name;
3667 struct config_generic **res;
3673 * By equating const char ** with struct config_generic *, we are assuming
3674 * the name field is first in config_generic.
3676 res = (struct config_generic **) bsearch((void *) &key,
3677 (void *) guc_variables,
3679 sizeof(struct config_generic *),
3685 * See if the name is an obsolete name for a variable. We assume that the
3686 * set of supported old names is short enough that a brute-force search is
3689 for (i = 0; map_old_guc_names[i] != NULL; i += 2)
3691 if (guc_name_compare(name, map_old_guc_names[i]) == 0)
3692 return find_option(map_old_guc_names[i + 1], false, elevel);
3695 if (create_placeholders)
3698 * Check if the name is qualified, and if so, add a placeholder.
3700 if (strchr(name, GUC_QUALIFIER_SEPARATOR) != NULL)
3701 return add_placeholder_variable(name, elevel);
3710 * comparator for qsorting and bsearching guc_variables array
3713 guc_var_compare(const void *a, const void *b)
3715 struct config_generic *confa = *(struct config_generic **) a;
3716 struct config_generic *confb = *(struct config_generic **) b;
3718 return guc_name_compare(confa->name, confb->name);
3722 * the bare comparison function for GUC names
3725 guc_name_compare(const char *namea, const char *nameb)
3728 * The temptation to use strcasecmp() here must be resisted, because the
3729 * array ordering has to remain stable across setlocale() calls. So, build
3730 * our own with a simple ASCII-only downcasing.
3732 while (*namea && *nameb)
3734 char cha = *namea++;
3735 char chb = *nameb++;
3737 if (cha >= 'A' && cha <= 'Z')
3739 if (chb >= 'A' && chb <= 'Z')
3745 return 1; /* a is longer */
3747 return -1; /* b is longer */
3753 * Initialize GUC options during program startup.
3755 * Note that we cannot read the config file yet, since we have not yet
3756 * processed command-line switches.
3759 InitializeGUCOptions(void)
3764 * Before log_line_prefix could possibly receive a nonempty setting, make
3765 * sure that timezone processing is minimally alive (see elog.c).
3767 pg_timezone_initialize();
3770 * Build sorted array of all GUC variables.
3772 build_guc_variables();
3775 * Load all variables with their compiled-in defaults, and initialize
3776 * status fields as needed.
3778 for (i = 0; i < num_guc_variables; i++)
3780 InitializeOneGUCOption(guc_variables[i]);
3785 reporting_enabled = false;
3788 * Prevent any attempt to override the transaction modes from
3789 * non-interactive sources.
3791 SetConfigOption("transaction_isolation", "default",
3792 PGC_POSTMASTER, PGC_S_OVERRIDE);
3793 SetConfigOption("transaction_read_only", "no",
3794 PGC_POSTMASTER, PGC_S_OVERRIDE);
3795 SetConfigOption("transaction_deferrable", "no",
3796 PGC_POSTMASTER, PGC_S_OVERRIDE);
3799 * For historical reasons, some GUC parameters can receive defaults from
3800 * environment variables. Process those settings.
3802 InitializeGUCOptionsFromEnvironment();
3806 * Assign any GUC values that can come from the server's environment.
3808 * This is called from InitializeGUCOptions, and also from ProcessConfigFile
3809 * to deal with the possibility that a setting has been removed from
3810 * postgresql.conf and should now get a value from the environment.
3811 * (The latter is a kludge that should probably go away someday; if so,
3812 * fold this back into InitializeGUCOptions.)
3815 InitializeGUCOptionsFromEnvironment(void)
3820 env = getenv("PGPORT");
3822 SetConfigOption("port", env, PGC_POSTMASTER, PGC_S_ENV_VAR);
3824 env = getenv("PGDATESTYLE");
3826 SetConfigOption("datestyle", env, PGC_POSTMASTER, PGC_S_ENV_VAR);
3828 env = getenv("PGCLIENTENCODING");
3830 SetConfigOption("client_encoding", env, PGC_POSTMASTER, PGC_S_ENV_VAR);
3833 * rlimit isn't exactly an "environment variable", but it behaves about
3834 * the same. If we can identify the platform stack depth rlimit, increase
3835 * default stack depth setting up to whatever is safe (but at most 2MB).
3837 stack_rlimit = get_stack_depth_rlimit();
3838 if (stack_rlimit > 0)
3840 long new_limit = (stack_rlimit - STACK_DEPTH_SLOP) / 1024L;
3842 if (new_limit > 100)
3846 new_limit = Min(new_limit, 2048);
3847 sprintf(limbuf, "%ld", new_limit);
3848 SetConfigOption("max_stack_depth", limbuf,
3849 PGC_POSTMASTER, PGC_S_ENV_VAR);
3855 * Initialize one GUC option variable to its compiled-in default.
3857 * Note: the reason for calling check_hooks is not that we think the boot_val
3858 * might fail, but that the hooks might wish to compute an "extra" struct.
3861 InitializeOneGUCOption(struct config_generic * gconf)
3864 gconf->source = PGC_S_DEFAULT;
3865 gconf->reset_source = PGC_S_DEFAULT;
3866 gconf->scontext = PGC_INTERNAL;
3867 gconf->reset_scontext = PGC_INTERNAL;
3868 gconf->stack = NULL;
3869 gconf->extra = NULL;
3870 gconf->sourcefile = NULL;
3871 gconf->sourceline = 0;
3873 switch (gconf->vartype)
3877 struct config_bool *conf = (struct config_bool *) gconf;
3878 bool newval = conf->boot_val;
3881 if (!call_bool_check_hook(conf, &newval, &extra,
3882 PGC_S_DEFAULT, LOG))
3883 elog(FATAL, "failed to initialize %s to %d",
3884 conf->gen.name, (int) newval);
3885 if (conf->assign_hook)
3886 (*conf->assign_hook) (newval, extra);
3887 *conf->variable = conf->reset_val = newval;
3888 conf->gen.extra = conf->reset_extra = extra;
3893 struct config_int *conf = (struct config_int *) gconf;
3894 int newval = conf->boot_val;
3897 Assert(newval >= conf->min);
3898 Assert(newval <= conf->max);
3899 if (!call_int_check_hook(conf, &newval, &extra,
3900 PGC_S_DEFAULT, LOG))
3901 elog(FATAL, "failed to initialize %s to %d",
3902 conf->gen.name, newval);
3903 if (conf->assign_hook)
3904 (*conf->assign_hook) (newval, extra);
3905 *conf->variable = conf->reset_val = newval;
3906 conf->gen.extra = conf->reset_extra = extra;
3911 struct config_real *conf = (struct config_real *) gconf;
3912 double newval = conf->boot_val;
3915 Assert(newval >= conf->min);
3916 Assert(newval <= conf->max);
3917 if (!call_real_check_hook(conf, &newval, &extra,
3918 PGC_S_DEFAULT, LOG))
3919 elog(FATAL, "failed to initialize %s to %g",
3920 conf->gen.name, newval);
3921 if (conf->assign_hook)
3922 (*conf->assign_hook) (newval, extra);
3923 *conf->variable = conf->reset_val = newval;
3924 conf->gen.extra = conf->reset_extra = extra;
3929 struct config_string *conf = (struct config_string *) gconf;
3933 /* non-NULL boot_val must always get strdup'd */
3934 if (conf->boot_val != NULL)
3935 newval = guc_strdup(FATAL, conf->boot_val);
3939 if (!call_string_check_hook(conf, &newval, &extra,
3940 PGC_S_DEFAULT, LOG))
3941 elog(FATAL, "failed to initialize %s to \"%s\"",
3942 conf->gen.name, newval ? newval : "");
3943 if (conf->assign_hook)
3944 (*conf->assign_hook) (newval, extra);
3945 *conf->variable = conf->reset_val = newval;
3946 conf->gen.extra = conf->reset_extra = extra;
3951 struct config_enum *conf = (struct config_enum *) gconf;
3952 int newval = conf->boot_val;
3955 if (!call_enum_check_hook(conf, &newval, &extra,
3956 PGC_S_DEFAULT, LOG))
3957 elog(FATAL, "failed to initialize %s to %d",
3958 conf->gen.name, newval);
3959 if (conf->assign_hook)
3960 (*conf->assign_hook) (newval, extra);
3961 *conf->variable = conf->reset_val = newval;
3962 conf->gen.extra = conf->reset_extra = extra;
3970 * Select the configuration files and data directory to be used, and
3971 * do the initial read of postgresql.conf.
3973 * This is called after processing command-line switches.
3974 * userDoption is the -D switch value if any (NULL if unspecified).
3975 * progname is just for use in error messages.
3977 * Returns true on success; on failure, prints a suitable error message
3978 * to stderr and returns false.
3981 SelectConfigFiles(const char *userDoption, const char *progname)
3985 struct stat stat_buf;
3987 /* configdir is -D option, or $PGDATA if no -D */
3989 configdir = make_absolute_path(userDoption);
3991 configdir = make_absolute_path(getenv("PGDATA"));
3994 * Find the configuration file: if config_file was specified on the
3995 * command line, use it, else use configdir/postgresql.conf. In any case
3996 * ensure the result is an absolute path, so that it will be interpreted
3997 * the same way by future backends.
4000 fname = make_absolute_path(ConfigFileName);
4003 fname = guc_malloc(FATAL,
4004 strlen(configdir) + strlen(CONFIG_FILENAME) + 2);
4005 sprintf(fname, "%s/%s", configdir, CONFIG_FILENAME);
4009 write_stderr("%s does not know where to find the server configuration file.\n"
4010 "You must specify the --config-file or -D invocation "
4011 "option or set the PGDATA environment variable.\n",
4017 * Set the ConfigFileName GUC variable to its final value, ensuring that
4018 * it can't be overridden later.
4020 SetConfigOption("config_file", fname, PGC_POSTMASTER, PGC_S_OVERRIDE);
4024 * Now read the config file for the first time.
4026 if (stat(ConfigFileName, &stat_buf) != 0)
4028 write_stderr("%s cannot access the server configuration file \"%s\": %s\n",
4029 progname, ConfigFileName, strerror(errno));
4033 ProcessConfigFile(PGC_POSTMASTER);
4036 * If the data_directory GUC variable has been set, use that as DataDir;
4037 * otherwise use configdir if set; else punt.
4039 * Note: SetDataDir will copy and absolute-ize its argument, so we don't
4043 SetDataDir(data_directory);
4045 SetDataDir(configdir);
4048 write_stderr("%s does not know where to find the database system data.\n"
4049 "This can be specified as \"data_directory\" in \"%s\", "
4050 "or by the -D invocation option, or by the "
4051 "PGDATA environment variable.\n",
4052 progname, ConfigFileName);
4057 * Reflect the final DataDir value back into the data_directory GUC var.
4058 * (If you are wondering why we don't just make them a single variable,
4059 * it's because the EXEC_BACKEND case needs DataDir to be transmitted to
4060 * child backends specially. XXX is that still true? Given that we now
4061 * chdir to DataDir, EXEC_BACKEND can read the config file without knowing
4062 * DataDir in advance.)
4064 SetConfigOption("data_directory", DataDir, PGC_POSTMASTER, PGC_S_OVERRIDE);
4067 * If timezone_abbreviations wasn't set in the configuration file, install
4068 * the default value. We do it this way because we can't safely install
4069 * a "real" value until my_exec_path is set, which may not have happened
4070 * when InitializeGUCOptions runs, so the bootstrap default value cannot
4071 * be the real desired default.
4073 pg_timezone_abbrev_initialize();
4076 * Figure out where pg_hba.conf is, and make sure the path is absolute.
4079 fname = make_absolute_path(HbaFileName);
4082 fname = guc_malloc(FATAL,
4083 strlen(configdir) + strlen(HBA_FILENAME) + 2);
4084 sprintf(fname, "%s/%s", configdir, HBA_FILENAME);
4088 write_stderr("%s does not know where to find the \"hba\" configuration file.\n"
4089 "This can be specified as \"hba_file\" in \"%s\", "
4090 "or by the -D invocation option, or by the "
4091 "PGDATA environment variable.\n",
4092 progname, ConfigFileName);
4095 SetConfigOption("hba_file", fname, PGC_POSTMASTER, PGC_S_OVERRIDE);
4099 * Likewise for pg_ident.conf.
4102 fname = make_absolute_path(IdentFileName);
4105 fname = guc_malloc(FATAL,
4106 strlen(configdir) + strlen(IDENT_FILENAME) + 2);
4107 sprintf(fname, "%s/%s", configdir, IDENT_FILENAME);
4111 write_stderr("%s does not know where to find the \"ident\" configuration file.\n"
4112 "This can be specified as \"ident_file\" in \"%s\", "
4113 "or by the -D invocation option, or by the "
4114 "PGDATA environment variable.\n",
4115 progname, ConfigFileName);
4118 SetConfigOption("ident_file", fname, PGC_POSTMASTER, PGC_S_OVERRIDE);
4128 * Reset all options to their saved default values (implements RESET ALL)
4131 ResetAllOptions(void)
4135 for (i = 0; i < num_guc_variables; i++)
4137 struct config_generic *gconf = guc_variables[i];
4139 /* Don't reset non-SET-able values */
4140 if (gconf->context != PGC_SUSET &&
4141 gconf->context != PGC_USERSET)
4143 /* Don't reset if special exclusion from RESET ALL */
4144 if (gconf->flags & GUC_NO_RESET_ALL)
4146 /* No need to reset if wasn't SET */
4147 if (gconf->source <= PGC_S_OVERRIDE)
4150 /* Save old value to support transaction abort */
4151 push_old_value(gconf, GUC_ACTION_SET);
4153 switch (gconf->vartype)
4157 struct config_bool *conf = (struct config_bool *) gconf;
4159 if (conf->assign_hook)
4160 (*conf->assign_hook) (conf->reset_val,
4162 *conf->variable = conf->reset_val;
4163 set_extra_field(&conf->gen, &conf->gen.extra,
4169 struct config_int *conf = (struct config_int *) gconf;
4171 if (conf->assign_hook)
4172 (*conf->assign_hook) (conf->reset_val,
4174 *conf->variable = conf->reset_val;
4175 set_extra_field(&conf->gen, &conf->gen.extra,
4181 struct config_real *conf = (struct config_real *) gconf;
4183 if (conf->assign_hook)
4184 (*conf->assign_hook) (conf->reset_val,
4186 *conf->variable = conf->reset_val;
4187 set_extra_field(&conf->gen, &conf->gen.extra,
4193 struct config_string *conf = (struct config_string *) gconf;
4195 if (conf->assign_hook)
4196 (*conf->assign_hook) (conf->reset_val,
4198 set_string_field(conf, conf->variable, conf->reset_val);
4199 set_extra_field(&conf->gen, &conf->gen.extra,
4205 struct config_enum *conf = (struct config_enum *) gconf;
4207 if (conf->assign_hook)
4208 (*conf->assign_hook) (conf->reset_val,
4210 *conf->variable = conf->reset_val;
4211 set_extra_field(&conf->gen, &conf->gen.extra,
4217 gconf->source = gconf->reset_source;
4218 gconf->scontext = gconf->reset_scontext;
4220 if (gconf->flags & GUC_REPORT)
4221 ReportGUCOption(gconf);
4228 * Push previous state during transactional assignment to a GUC variable.
4231 push_old_value(struct config_generic * gconf, GucAction action)
4235 /* If we're not inside a nest level, do nothing */
4236 if (GUCNestLevel == 0)
4239 /* Do we already have a stack entry of the current nest level? */
4240 stack = gconf->stack;
4241 if (stack && stack->nest_level >= GUCNestLevel)
4243 /* Yes, so adjust its state if necessary */
4244 Assert(stack->nest_level == GUCNestLevel);
4247 case GUC_ACTION_SET:
4248 /* SET overrides any prior action at same nest level */
4249 if (stack->state == GUC_SET_LOCAL)
4251 /* must discard old masked value */
4252 discard_stack_value(gconf, &stack->masked);
4254 stack->state = GUC_SET;
4256 case GUC_ACTION_LOCAL:
4257 if (stack->state == GUC_SET)
4259 /* SET followed by SET LOCAL, remember SET's value */
4260 stack->masked_scontext = gconf->scontext;
4261 set_stack_value(gconf, &stack->masked);
4262 stack->state = GUC_SET_LOCAL;
4264 /* in all other cases, no change to stack entry */
4266 case GUC_ACTION_SAVE:
4267 /* Could only have a prior SAVE of same variable */
4268 Assert(stack->state == GUC_SAVE);
4271 Assert(guc_dirty); /* must be set already */
4276 * Push a new stack entry
4278 * We keep all the stack entries in TopTransactionContext for simplicity.
4280 stack = (GucStack *) MemoryContextAllocZero(TopTransactionContext,
4283 stack->prev = gconf->stack;
4284 stack->nest_level = GUCNestLevel;
4287 case GUC_ACTION_SET:
4288 stack->state = GUC_SET;
4290 case GUC_ACTION_LOCAL:
4291 stack->state = GUC_LOCAL;
4293 case GUC_ACTION_SAVE:
4294 stack->state = GUC_SAVE;
4297 stack->source = gconf->source;
4298 stack->scontext = gconf->scontext;
4299 set_stack_value(gconf, &stack->prior);
4301 gconf->stack = stack;
4303 /* Ensure we remember to pop at end of xact */
4309 * Do GUC processing at main transaction start.
4315 * The nest level should be 0 between transactions; if it isn't, somebody
4316 * didn't call AtEOXact_GUC, or called it with the wrong nestLevel. We
4317 * throw a warning but make no other effort to clean up.
4319 if (GUCNestLevel != 0)
4320 elog(WARNING, "GUC nest level = %d at transaction start",
4326 * Enter a new nesting level for GUC values. This is called at subtransaction
4327 * start and when entering a function that has proconfig settings. NOTE that
4328 * we must not risk error here, else subtransaction start will be unhappy.
4331 NewGUCNestLevel(void)
4333 return ++GUCNestLevel;
4337 * Do GUC processing at transaction or subtransaction commit or abort, or
4338 * when exiting a function that has proconfig settings. (The name is thus
4339 * a bit of a misnomer; perhaps it should be ExitGUCNestLevel or some such.)
4340 * During abort, we discard all GUC settings that were applied at nesting
4341 * levels >= nestLevel. nestLevel == 1 corresponds to the main transaction.
4344 AtEOXact_GUC(bool isCommit, int nestLevel)
4350 * Note: it's possible to get here with GUCNestLevel == nestLevel-1 during
4351 * abort, if there is a failure during transaction start before
4352 * AtStart_GUC is called.
4354 Assert(nestLevel > 0 &&
4355 (nestLevel <= GUCNestLevel ||
4356 (nestLevel == GUCNestLevel + 1 && !isCommit)));
4358 /* Quick exit if nothing's changed in this transaction */
4361 GUCNestLevel = nestLevel - 1;
4365 still_dirty = false;
4366 for (i = 0; i < num_guc_variables; i++)
4368 struct config_generic *gconf = guc_variables[i];
4372 * Process and pop each stack entry within the nest level. To
4373 * simplify fmgr_security_definer(), we allow failure exit from a
4374 * function-with-SET-options to be recovered at the surrounding
4375 * transaction or subtransaction abort; so there could be more than
4376 * one stack entry to pop.
4378 while ((stack = gconf->stack) != NULL &&
4379 stack->nest_level >= nestLevel)
4381 GucStack *prev = stack->prev;
4382 bool restorePrior = false;
4383 bool restoreMasked = false;
4387 * In this next bit, if we don't set either restorePrior or
4388 * restoreMasked, we must "discard" any unwanted fields of the
4389 * stack entries to avoid leaking memory. If we do set one of
4390 * those flags, unused fields will be cleaned up after restoring.
4392 if (!isCommit) /* if abort, always restore prior value */
4393 restorePrior = true;
4394 else if (stack->state == GUC_SAVE)
4395 restorePrior = true;
4396 else if (stack->nest_level == 1)
4398 /* transaction commit */
4399 if (stack->state == GUC_SET_LOCAL)
4400 restoreMasked = true;
4401 else if (stack->state == GUC_SET)
4403 /* we keep the current active value */
4404 discard_stack_value(gconf, &stack->prior);
4406 else /* must be GUC_LOCAL */
4407 restorePrior = true;
4409 else if (prev == NULL ||
4410 prev->nest_level < stack->nest_level - 1)
4412 /* decrement entry's level and do not pop it */
4413 stack->nest_level--;
4419 * We have to merge this stack entry into prev. See README for
4420 * discussion of this bit.
4422 switch (stack->state)
4425 Assert(false); /* can't get here */
4428 /* next level always becomes SET */
4429 discard_stack_value(gconf, &stack->prior);
4430 if (prev->state == GUC_SET_LOCAL)
4431 discard_stack_value(gconf, &prev->masked);
4432 prev->state = GUC_SET;
4436 if (prev->state == GUC_SET)
4438 /* LOCAL migrates down */
4439 prev->masked_scontext = stack->scontext;
4440 prev->masked = stack->prior;
4441 prev->state = GUC_SET_LOCAL;
4445 /* else just forget this stack level */
4446 discard_stack_value(gconf, &stack->prior);
4451 /* prior state at this level no longer wanted */
4452 discard_stack_value(gconf, &stack->prior);
4453 /* copy down the masked state */
4454 prev->masked_scontext = stack->masked_scontext;
4455 if (prev->state == GUC_SET_LOCAL)
4456 discard_stack_value(gconf, &prev->masked);
4457 prev->masked = stack->masked;
4458 prev->state = GUC_SET_LOCAL;
4465 if (restorePrior || restoreMasked)
4467 /* Perform appropriate restoration of the stacked value */
4468 config_var_value newvalue;
4469 GucSource newsource;
4470 GucContext newscontext;
4474 newvalue = stack->masked;
4475 newsource = PGC_S_SESSION;
4476 newscontext = stack->masked_scontext;
4480 newvalue = stack->prior;
4481 newsource = stack->source;
4482 newscontext = stack->scontext;
4485 switch (gconf->vartype)
4489 struct config_bool *conf = (struct config_bool *) gconf;
4490 bool newval = newvalue.val.boolval;
4491 void *newextra = newvalue.extra;
4493 if (*conf->variable != newval ||
4494 conf->gen.extra != newextra)
4496 if (conf->assign_hook)
4497 (*conf->assign_hook) (newval, newextra);
4498 *conf->variable = newval;
4499 set_extra_field(&conf->gen, &conf->gen.extra,
4507 struct config_int *conf = (struct config_int *) gconf;
4508 int newval = newvalue.val.intval;
4509 void *newextra = newvalue.extra;
4511 if (*conf->variable != newval ||
4512 conf->gen.extra != newextra)
4514 if (conf->assign_hook)
4515 (*conf->assign_hook) (newval, newextra);
4516 *conf->variable = newval;
4517 set_extra_field(&conf->gen, &conf->gen.extra,
4525 struct config_real *conf = (struct config_real *) gconf;
4526 double newval = newvalue.val.realval;
4527 void *newextra = newvalue.extra;
4529 if (*conf->variable != newval ||
4530 conf->gen.extra != newextra)
4532 if (conf->assign_hook)
4533 (*conf->assign_hook) (newval, newextra);
4534 *conf->variable = newval;
4535 set_extra_field(&conf->gen, &conf->gen.extra,
4543 struct config_string *conf = (struct config_string *) gconf;
4544 char *newval = newvalue.val.stringval;
4545 void *newextra = newvalue.extra;
4547 if (*conf->variable != newval ||
4548 conf->gen.extra != newextra)
4550 if (conf->assign_hook)
4551 (*conf->assign_hook) (newval, newextra);
4552 set_string_field(conf, conf->variable, newval);
4553 set_extra_field(&conf->gen, &conf->gen.extra,
4559 * Release stacked values if not used anymore. We
4560 * could use discard_stack_value() here, but since
4561 * we have type-specific code anyway, might as
4564 set_string_field(conf, &stack->prior.val.stringval, NULL);
4565 set_string_field(conf, &stack->masked.val.stringval, NULL);
4570 struct config_enum *conf = (struct config_enum *) gconf;
4571 int newval = newvalue.val.enumval;
4572 void *newextra = newvalue.extra;
4574 if (*conf->variable != newval ||
4575 conf->gen.extra != newextra)
4577 if (conf->assign_hook)
4578 (*conf->assign_hook) (newval, newextra);
4579 *conf->variable = newval;
4580 set_extra_field(&conf->gen, &conf->gen.extra,
4589 * Release stacked extra values if not used anymore.
4591 set_extra_field(gconf, &(stack->prior.extra), NULL);
4592 set_extra_field(gconf, &(stack->masked.extra), NULL);
4594 /* And restore source information */
4595 gconf->source = newsource;
4596 gconf->scontext = newscontext;
4599 /* Finish popping the state stack */
4600 gconf->stack = prev;
4603 /* Report new value if we changed it */
4604 if (changed && (gconf->flags & GUC_REPORT))
4605 ReportGUCOption(gconf);
4606 } /* end of stack-popping loop */
4612 /* If there are no remaining stack entries, we can reset guc_dirty */
4613 guc_dirty = still_dirty;
4615 /* Update nesting level */
4616 GUCNestLevel = nestLevel - 1;
4621 * Start up automatic reporting of changes to variables marked GUC_REPORT.
4622 * This is executed at completion of backend startup.
4625 BeginReportingGUCOptions(void)
4630 * Don't do anything unless talking to an interactive frontend of protocol
4633 if (whereToSendOutput != DestRemote ||
4634 PG_PROTOCOL_MAJOR(FrontendProtocol) < 3)
4637 reporting_enabled = true;
4639 /* Transmit initial values of interesting variables */
4640 for (i = 0; i < num_guc_variables; i++)
4642 struct config_generic *conf = guc_variables[i];
4644 if (conf->flags & GUC_REPORT)
4645 ReportGUCOption(conf);
4650 * ReportGUCOption: if appropriate, transmit option value to frontend
4653 ReportGUCOption(struct config_generic * record)
4655 if (reporting_enabled && (record->flags & GUC_REPORT))
4657 char *val = _ShowOption(record, false);
4658 StringInfoData msgbuf;
4660 pq_beginmessage(&msgbuf, 'S');
4661 pq_sendstring(&msgbuf, record->name);
4662 pq_sendstring(&msgbuf, val);
4663 pq_endmessage(&msgbuf);
4670 * Try to parse value as an integer. The accepted formats are the
4671 * usual decimal, octal, or hexadecimal formats, optionally followed by
4672 * a unit name if "flags" indicates a unit is allowed.
4674 * If the string parses okay, return true, else false.
4675 * If okay and result is not NULL, return the value in *result.
4676 * If not okay and hintmsg is not NULL, *hintmsg is set to a suitable
4677 * HINT message, or NULL if no hint provided.
4680 parse_int(const char *value, int *result, int flags, const char **hintmsg)
4685 /* To suppress compiler warnings, always set output params */
4691 /* We assume here that int64 is at least as wide as long */
4693 val = strtol(value, &endptr, 0);
4695 if (endptr == value)
4696 return false; /* no HINT for integer syntax error */
4698 if (errno == ERANGE || val != (int64) ((int32) val))
4701 *hintmsg = gettext_noop("Value exceeds integer range.");
4705 /* allow whitespace between integer and unit */
4706 while (isspace((unsigned char) *endptr))
4709 /* Handle possible unit */
4710 if (*endptr != '\0')
4713 * Note: the multiple-switch coding technique here is a bit tedious,
4714 * but seems necessary to avoid intermediate-value overflows.
4716 if (flags & GUC_UNIT_MEMORY)
4718 /* Set hint for use if no match or trailing garbage */
4720 *hintmsg = gettext_noop("Valid units for this parameter are \"kB\", \"MB\", and \"GB\".");
4722 #if BLCKSZ < 1024 || BLCKSZ > (1024*1024)
4723 #error BLCKSZ must be between 1KB and 1MB
4725 #if XLOG_BLCKSZ < 1024 || XLOG_BLCKSZ > (1024*1024)
4726 #error XLOG_BLCKSZ must be between 1KB and 1MB
4729 if (strncmp(endptr, "kB", 2) == 0)
4732 switch (flags & GUC_UNIT_MEMORY)
4734 case GUC_UNIT_BLOCKS:
4735 val /= (BLCKSZ / 1024);
4737 case GUC_UNIT_XBLOCKS:
4738 val /= (XLOG_BLCKSZ / 1024);
4742 else if (strncmp(endptr, "MB", 2) == 0)
4745 switch (flags & GUC_UNIT_MEMORY)
4750 case GUC_UNIT_BLOCKS:
4751 val *= KB_PER_MB / (BLCKSZ / 1024);
4753 case GUC_UNIT_XBLOCKS:
4754 val *= KB_PER_MB / (XLOG_BLCKSZ / 1024);
4758 else if (strncmp(endptr, "GB", 2) == 0)
4761 switch (flags & GUC_UNIT_MEMORY)
4766 case GUC_UNIT_BLOCKS:
4767 val *= KB_PER_GB / (BLCKSZ / 1024);
4769 case GUC_UNIT_XBLOCKS:
4770 val *= KB_PER_GB / (XLOG_BLCKSZ / 1024);
4775 else if (flags & GUC_UNIT_TIME)
4777 /* Set hint for use if no match or trailing garbage */
4779 *hintmsg = gettext_noop("Valid units for this parameter are \"ms\", \"s\", \"min\", \"h\", and \"d\".");
4781 if (strncmp(endptr, "ms", 2) == 0)
4784 switch (flags & GUC_UNIT_TIME)
4794 else if (strncmp(endptr, "s", 1) == 0)
4797 switch (flags & GUC_UNIT_TIME)
4807 else if (strncmp(endptr, "min", 3) == 0)
4810 switch (flags & GUC_UNIT_TIME)
4820 else if (strncmp(endptr, "h", 1) == 0)
4823 switch (flags & GUC_UNIT_TIME)
4836 else if (strncmp(endptr, "d", 1) == 0)
4839 switch (flags & GUC_UNIT_TIME)
4854 /* allow whitespace after unit */
4855 while (isspace((unsigned char) *endptr))
4858 if (*endptr != '\0')
4859 return false; /* appropriate hint, if any, already set */
4861 /* Check for overflow due to units conversion */
4862 if (val != (int64) ((int32) val))
4865 *hintmsg = gettext_noop("Value exceeds integer range.");
4871 *result = (int) val;
4878 * Try to parse value as a floating point number in the usual format.
4879 * If the string parses okay, return true, else false.
4880 * If okay and result is not NULL, return the value in *result.
4883 parse_real(const char *value, double *result)
4889 *result = 0; /* suppress compiler warning */
4892 val = strtod(value, &endptr);
4893 if (endptr == value || errno == ERANGE)
4896 /* allow whitespace after number */
4897 while (isspace((unsigned char) *endptr))
4899 if (*endptr != '\0')
4909 * Lookup the name for an enum option with the selected value.
4910 * Should only ever be called with known-valid values, so throws
4911 * an elog(ERROR) if the enum option is not found.
4913 * The returned string is a pointer to static data and not
4914 * allocated for modification.
4917 config_enum_lookup_by_value(struct config_enum * record, int val)
4919 const struct config_enum_entry *entry;
4921 for (entry = record->options; entry && entry->name; entry++)
4923 if (entry->val == val)
4927 elog(ERROR, "could not find enum option %d for %s",
4928 val, record->gen.name);
4929 return NULL; /* silence compiler */
4934 * Lookup the value for an enum option with the selected name
4935 * (case-insensitive).
4936 * If the enum option is found, sets the retval value and returns
4937 * true. If it's not found, return FALSE and retval is set to 0.
4940 config_enum_lookup_by_name(struct config_enum * record, const char *value,
4943 const struct config_enum_entry *entry;
4945 for (entry = record->options; entry && entry->name; entry++)
4947 if (pg_strcasecmp(value, entry->name) == 0)
4949 *retval = entry->val;
4960 * Return a list of all available options for an enum, excluding
4961 * hidden ones, separated by the given separator.
4962 * If prefix is non-NULL, it is added before the first enum value.
4963 * If suffix is non-NULL, it is added to the end of the string.
4966 config_enum_get_options(struct config_enum * record, const char *prefix,
4967 const char *suffix, const char *separator)
4969 const struct config_enum_entry *entry;
4970 StringInfoData retstr;
4973 initStringInfo(&retstr);
4974 appendStringInfoString(&retstr, prefix);
4976 seplen = strlen(separator);
4977 for (entry = record->options; entry && entry->name; entry++)
4981 appendStringInfoString(&retstr, entry->name);
4982 appendBinaryStringInfo(&retstr, separator, seplen);
4987 * All the entries may have been hidden, leaving the string empty if no
4988 * prefix was given. This indicates a broken GUC setup, since there is no
4989 * use for an enum without any values, so we just check to make sure we
4990 * don't write to invalid memory instead of actually trying to do
4991 * something smart with it.
4993 if (retstr.len >= seplen)
4995 /* Replace final separator */
4996 retstr.data[retstr.len - seplen] = '\0';
4997 retstr.len -= seplen;
5000 appendStringInfoString(&retstr, suffix);
5007 * Sets option `name' to given value.
5009 * The value should be a string, which will be parsed and converted to
5010 * the appropriate data type. The context and source parameters indicate
5011 * in which context this function is being called, so that it can apply the
5012 * access restrictions properly.
5014 * If value is NULL, set the option to its default value (normally the
5015 * reset_val, but if source == PGC_S_DEFAULT we instead use the boot_val).
5017 * action indicates whether to set the value globally in the session, locally
5018 * to the current top transaction, or just for the duration of a function call.
5020 * If changeVal is false then don't really set the option but do all
5021 * the checks to see if it would work.
5024 * +1: the value is valid and was successfully applied.
5025 * 0: the name or value is invalid (but see below).
5026 * -1: the value was not applied because of context, priority, or changeVal.
5028 * If there is an error (non-existing option, invalid value) then an
5029 * ereport(ERROR) is thrown *unless* this is called for a source for which
5030 * we don't want an ERROR (currently, those are defaults, the config file,
5031 * and per-database or per-user settings). In those cases we write a
5032 * suitable error message via ereport() and return 0.
5034 * See also SetConfigOption for an external interface.
5037 set_config_option(const char *name, const char *value,
5038 GucContext context, GucSource source,
5039 GucAction action, bool changeVal)
5041 struct config_generic *record;
5043 bool prohibitValueChange = false;
5046 if (source == PGC_S_DEFAULT || source == PGC_S_FILE)
5049 * To avoid cluttering the log, only the postmaster bleats loudly
5050 * about problems with the config file.
5052 elevel = IsUnderPostmaster ? DEBUG3 : LOG;
5054 else if (source == PGC_S_DATABASE || source == PGC_S_USER ||
5055 source == PGC_S_DATABASE_USER)
5060 record = find_option(name, true, elevel);
5064 (errcode(ERRCODE_UNDEFINED_OBJECT),
5065 errmsg("unrecognized configuration parameter \"%s\"", name)));
5070 * Check if the option can be set at this time. See guc.h for the precise
5073 switch (record->context)
5076 if (context != PGC_INTERNAL)
5079 (errcode(ERRCODE_CANT_CHANGE_RUNTIME_PARAM),
5080 errmsg("parameter \"%s\" cannot be changed",
5085 case PGC_POSTMASTER:
5086 if (context == PGC_SIGHUP)
5089 * We are re-reading a PGC_POSTMASTER variable from
5090 * postgresql.conf. We can't change the setting, so we should
5091 * give a warning if the DBA tries to change it. However,
5092 * because of variant formats, canonicalization by check
5093 * hooks, etc, we can't just compare the given string directly
5094 * to what's stored. Set a flag to check below after we have
5095 * the final storable value.
5097 prohibitValueChange = true;
5099 else if (context != PGC_POSTMASTER)
5102 (errcode(ERRCODE_CANT_CHANGE_RUNTIME_PARAM),
5103 errmsg("parameter \"%s\" cannot be changed without restarting the server",
5109 if (context != PGC_SIGHUP && context != PGC_POSTMASTER)
5112 (errcode(ERRCODE_CANT_CHANGE_RUNTIME_PARAM),
5113 errmsg("parameter \"%s\" cannot be changed now",
5119 * Hmm, the idea of the SIGHUP context is "ought to be global, but
5120 * can be changed after postmaster start". But there's nothing
5121 * that prevents a crafty administrator from sending SIGHUP
5122 * signals to individual backends only.
5126 if (context == PGC_SIGHUP)
5129 * If a PGC_BACKEND parameter is changed in the config file,
5130 * we want to accept the new value in the postmaster (whence
5131 * it will propagate to subsequently-started backends), but
5132 * ignore it in existing backends. This is a tad klugy, but
5133 * necessary because we don't re-read the config file during
5136 if (IsUnderPostmaster)
5139 else if (context != PGC_POSTMASTER && context != PGC_BACKEND &&
5140 source != PGC_S_CLIENT)
5143 (errcode(ERRCODE_CANT_CHANGE_RUNTIME_PARAM),
5144 errmsg("parameter \"%s\" cannot be set after connection start",
5150 if (context == PGC_USERSET || context == PGC_BACKEND)
5153 (errcode(ERRCODE_INSUFFICIENT_PRIVILEGE),
5154 errmsg("permission denied to set parameter \"%s\"",
5165 * Disallow changing GUC_NOT_WHILE_SEC_REST values if we are inside a
5166 * security restriction context. We can reject this regardless of the GUC
5167 * context or source, mainly because sources that it might be reasonable
5168 * to override for won't be seen while inside a function.
5170 * Note: variables marked GUC_NOT_WHILE_SEC_REST should usually be marked
5171 * GUC_NO_RESET_ALL as well, because ResetAllOptions() doesn't check this.
5172 * An exception might be made if the reset value is assumed to be "safe".
5174 * Note: this flag is currently used for "session_authorization" and
5175 * "role". We need to prohibit changing these inside a local userid
5176 * context because when we exit it, GUC won't be notified, leaving things
5177 * out of sync. (This could be fixed by forcing a new GUC nesting level,
5178 * but that would change behavior in possibly-undesirable ways.) Also, we
5179 * prohibit changing these in a security-restricted operation because
5180 * otherwise RESET could be used to regain the session user's privileges.
5182 if (record->flags & GUC_NOT_WHILE_SEC_REST)
5184 if (InLocalUserIdChange())
5187 * Phrasing of this error message is historical, but it's the most
5191 (errcode(ERRCODE_INSUFFICIENT_PRIVILEGE),
5192 errmsg("cannot set parameter \"%s\" within security-definer function",
5196 if (InSecurityRestrictedOperation())
5199 (errcode(ERRCODE_INSUFFICIENT_PRIVILEGE),
5200 errmsg("cannot set parameter \"%s\" within security-restricted operation",
5207 * Should we set reset/stacked values? (If so, the behavior is not
5208 * transactional.) This is done either when we get a default value from
5209 * the database's/user's/client's default settings or when we reset a
5210 * value to its default.
5212 makeDefault = changeVal && (source <= PGC_S_OVERRIDE) &&
5213 ((value != NULL) || source == PGC_S_DEFAULT);
5216 * Ignore attempted set if overridden by previously processed setting.
5217 * However, if changeVal is false then plow ahead anyway since we are
5218 * trying to find out if the value is potentially good, not actually use
5219 * it. Also keep going if makeDefault is true, since we may want to set
5220 * the reset/stacked values even if we can't set the variable itself.
5222 if (record->source > source)
5224 if (changeVal && !makeDefault)
5226 elog(DEBUG3, "\"%s\": setting ignored because previous source is higher priority",
5234 * Evaluate value and set variable.
5236 switch (record->vartype)
5240 struct config_bool *conf = (struct config_bool *) record;
5242 void *newextra = NULL;
5246 if (!parse_bool(value, &newval))
5249 (errcode(ERRCODE_INVALID_PARAMETER_VALUE),
5250 errmsg("parameter \"%s\" requires a Boolean value",
5254 if (!call_bool_check_hook(conf, &newval, &newextra,
5258 else if (source == PGC_S_DEFAULT)
5260 newval = conf->boot_val;
5261 if (!call_bool_check_hook(conf, &newval, &newextra,
5267 newval = conf->reset_val;
5268 newextra = conf->reset_extra;
5269 source = conf->gen.reset_source;
5270 context = conf->gen.reset_scontext;
5273 if (prohibitValueChange)
5275 if (*conf->variable != newval)
5278 (errcode(ERRCODE_CANT_CHANGE_RUNTIME_PARAM),
5279 errmsg("parameter \"%s\" cannot be changed without restarting the server",
5288 /* Save old value to support transaction abort */
5290 push_old_value(&conf->gen, action);
5292 if (conf->assign_hook)
5293 (*conf->assign_hook) (newval, newextra);
5294 *conf->variable = newval;
5295 set_extra_field(&conf->gen, &conf->gen.extra,
5297 conf->gen.source = source;
5298 conf->gen.scontext = context;
5304 if (conf->gen.reset_source <= source)
5306 conf->reset_val = newval;
5307 set_extra_field(&conf->gen, &conf->reset_extra,
5309 conf->gen.reset_source = source;
5310 conf->gen.reset_scontext = context;
5312 for (stack = conf->gen.stack; stack; stack = stack->prev)
5314 if (stack->source <= source)
5316 stack->prior.val.boolval = newval;
5317 set_extra_field(&conf->gen, &stack->prior.extra,
5319 stack->source = source;
5320 stack->scontext = context;
5325 /* Perhaps we didn't install newextra anywhere */
5326 if (newextra && !extra_field_used(&conf->gen, newextra))
5333 struct config_int *conf = (struct config_int *) record;
5335 void *newextra = NULL;
5339 const char *hintmsg;
5341 if (!parse_int(value, &newval, conf->gen.flags, &hintmsg))
5344 (errcode(ERRCODE_INVALID_PARAMETER_VALUE),
5345 errmsg("invalid value for parameter \"%s\": \"%s\"",
5347 hintmsg ? errhint("%s", _(hintmsg)) : 0));
5350 if (newval < conf->min || newval > conf->max)
5353 (errcode(ERRCODE_INVALID_PARAMETER_VALUE),
5354 errmsg("%d is outside the valid range for parameter \"%s\" (%d .. %d)",
5355 newval, name, conf->min, conf->max)));
5358 if (!call_int_check_hook(conf, &newval, &newextra,
5362 else if (source == PGC_S_DEFAULT)
5364 newval = conf->boot_val;
5365 if (!call_int_check_hook(conf, &newval, &newextra,
5371 newval = conf->reset_val;
5372 newextra = conf->reset_extra;
5373 source = conf->gen.reset_source;
5374 context = conf->gen.reset_scontext;
5377 if (prohibitValueChange)
5379 if (*conf->variable != newval)
5382 (errcode(ERRCODE_CANT_CHANGE_RUNTIME_PARAM),
5383 errmsg("parameter \"%s\" cannot be changed without restarting the server",
5392 /* Save old value to support transaction abort */
5394 push_old_value(&conf->gen, action);
5396 if (conf->assign_hook)
5397 (*conf->assign_hook) (newval, newextra);
5398 *conf->variable = newval;
5399 set_extra_field(&conf->gen, &conf->gen.extra,
5401 conf->gen.source = source;
5402 conf->gen.scontext = context;
5408 if (conf->gen.reset_source <= source)
5410 conf->reset_val = newval;
5411 set_extra_field(&conf->gen, &conf->reset_extra,
5413 conf->gen.reset_source = source;
5414 conf->gen.reset_scontext = context;
5416 for (stack = conf->gen.stack; stack; stack = stack->prev)
5418 if (stack->source <= source)
5420 stack->prior.val.intval = newval;
5421 set_extra_field(&conf->gen, &stack->prior.extra,
5423 stack->source = source;
5424 stack->scontext = context;
5429 /* Perhaps we didn't install newextra anywhere */
5430 if (newextra && !extra_field_used(&conf->gen, newextra))
5437 struct config_real *conf = (struct config_real *) record;
5439 void *newextra = NULL;
5443 if (!parse_real(value, &newval))
5446 (errcode(ERRCODE_INVALID_PARAMETER_VALUE),
5447 errmsg("parameter \"%s\" requires a numeric value",
5451 if (newval < conf->min || newval > conf->max)
5454 (errcode(ERRCODE_INVALID_PARAMETER_VALUE),
5455 errmsg("%g is outside the valid range for parameter \"%s\" (%g .. %g)",
5456 newval, name, conf->min, conf->max)));
5459 if (!call_real_check_hook(conf, &newval, &newextra,
5463 else if (source == PGC_S_DEFAULT)
5465 newval = conf->boot_val;
5466 if (!call_real_check_hook(conf, &newval, &newextra,
5472 newval = conf->reset_val;
5473 newextra = conf->reset_extra;
5474 source = conf->gen.reset_source;
5475 context = conf->gen.reset_scontext;
5478 if (prohibitValueChange)
5480 if (*conf->variable != newval)
5483 (errcode(ERRCODE_CANT_CHANGE_RUNTIME_PARAM),
5484 errmsg("parameter \"%s\" cannot be changed without restarting the server",
5493 /* Save old value to support transaction abort */
5495 push_old_value(&conf->gen, action);
5497 if (conf->assign_hook)
5498 (*conf->assign_hook) (newval, newextra);
5499 *conf->variable = newval;
5500 set_extra_field(&conf->gen, &conf->gen.extra,
5502 conf->gen.source = source;
5503 conf->gen.scontext = context;
5509 if (conf->gen.reset_source <= source)
5511 conf->reset_val = newval;
5512 set_extra_field(&conf->gen, &conf->reset_extra,
5514 conf->gen.reset_source = source;
5515 conf->gen.reset_scontext = context;
5517 for (stack = conf->gen.stack; stack; stack = stack->prev)
5519 if (stack->source <= source)
5521 stack->prior.val.realval = newval;
5522 set_extra_field(&conf->gen, &stack->prior.extra,
5524 stack->source = source;
5525 stack->scontext = context;
5530 /* Perhaps we didn't install newextra anywhere */
5531 if (newextra && !extra_field_used(&conf->gen, newextra))
5538 struct config_string *conf = (struct config_string *) record;
5540 void *newextra = NULL;
5545 * The value passed by the caller could be transient, so
5546 * we always strdup it.
5548 newval = guc_strdup(elevel, value);
5553 * The only built-in "parsing" check we have is to apply
5554 * truncation if GUC_IS_NAME.
5556 if (conf->gen.flags & GUC_IS_NAME)
5557 truncate_identifier(newval, strlen(newval), true);
5559 if (!call_string_check_hook(conf, &newval, &newextra,
5566 else if (source == PGC_S_DEFAULT)
5568 /* non-NULL boot_val must always get strdup'd */
5569 if (conf->boot_val != NULL)
5571 newval = guc_strdup(elevel, conf->boot_val);
5578 if (!call_string_check_hook(conf, &newval, &newextra,
5588 * strdup not needed, since reset_val is already under
5591 newval = conf->reset_val;
5592 newextra = conf->reset_extra;
5593 source = conf->gen.reset_source;
5594 context = conf->gen.reset_scontext;
5597 if (prohibitValueChange)
5599 /* newval shouldn't be NULL, so we're a bit sloppy here */
5600 if (*conf->variable == NULL || newval == NULL ||
5601 strcmp(*conf->variable, newval) != 0)
5604 (errcode(ERRCODE_CANT_CHANGE_RUNTIME_PARAM),
5605 errmsg("parameter \"%s\" cannot be changed without restarting the server",
5614 /* Save old value to support transaction abort */
5616 push_old_value(&conf->gen, action);
5618 if (conf->assign_hook)
5619 (*conf->assign_hook) (newval, newextra);
5620 set_string_field(conf, conf->variable, newval);
5621 set_extra_field(&conf->gen, &conf->gen.extra,
5623 conf->gen.source = source;
5624 conf->gen.scontext = context;
5631 if (conf->gen.reset_source <= source)
5633 set_string_field(conf, &conf->reset_val, newval);
5634 set_extra_field(&conf->gen, &conf->reset_extra,
5636 conf->gen.reset_source = source;
5637 conf->gen.reset_scontext = context;
5639 for (stack = conf->gen.stack; stack; stack = stack->prev)
5641 if (stack->source <= source)
5643 set_string_field(conf, &stack->prior.val.stringval,
5645 set_extra_field(&conf->gen, &stack->prior.extra,
5647 stack->source = source;
5648 stack->scontext = context;
5653 /* Perhaps we didn't install newval anywhere */
5654 if (newval && !string_field_used(conf, newval))
5656 /* Perhaps we didn't install newextra anywhere */
5657 if (newextra && !extra_field_used(&conf->gen, newextra))
5664 struct config_enum *conf = (struct config_enum *) record;
5666 void *newextra = NULL;
5670 if (!config_enum_lookup_by_name(conf, value, &newval))
5674 hintmsg = config_enum_get_options(conf,
5675 "Available values: ",
5679 (errcode(ERRCODE_INVALID_PARAMETER_VALUE),
5680 errmsg("invalid value for parameter \"%s\": \"%s\"",
5682 hintmsg ? errhint("%s", _(hintmsg)) : 0));
5688 if (!call_enum_check_hook(conf, &newval, &newextra,
5692 else if (source == PGC_S_DEFAULT)
5694 newval = conf->boot_val;
5695 if (!call_enum_check_hook(conf, &newval, &newextra,
5701 newval = conf->reset_val;
5702 newextra = conf->reset_extra;
5703 source = conf->gen.reset_source;
5704 context = conf->gen.reset_scontext;
5707 if (prohibitValueChange)
5709 if (*conf->variable != newval)
5712 (errcode(ERRCODE_CANT_CHANGE_RUNTIME_PARAM),
5713 errmsg("parameter \"%s\" cannot be changed without restarting the server",
5722 /* Save old value to support transaction abort */
5724 push_old_value(&conf->gen, action);
5726 if (conf->assign_hook)
5727 (*conf->assign_hook) (newval, newextra);
5728 *conf->variable = newval;
5729 set_extra_field(&conf->gen, &conf->gen.extra,
5731 conf->gen.source = source;
5732 conf->gen.scontext = context;
5738 if (conf->gen.reset_source <= source)
5740 conf->reset_val = newval;
5741 set_extra_field(&conf->gen, &conf->reset_extra,
5743 conf->gen.reset_source = source;
5744 conf->gen.reset_scontext = context;
5746 for (stack = conf->gen.stack; stack; stack = stack->prev)
5748 if (stack->source <= source)
5750 stack->prior.val.enumval = newval;
5751 set_extra_field(&conf->gen, &stack->prior.extra,
5753 stack->source = source;
5754 stack->scontext = context;
5759 /* Perhaps we didn't install newextra anywhere */
5760 if (newextra && !extra_field_used(&conf->gen, newextra))
5766 if (changeVal && (record->flags & GUC_REPORT))
5767 ReportGUCOption(record);
5769 return changeVal ? 1 : -1;
5774 * Set the fields for source file and line number the setting came from.
5777 set_config_sourcefile(const char *name, char *sourcefile, int sourceline)
5779 struct config_generic *record;
5783 * To avoid cluttering the log, only the postmaster bleats loudly about
5784 * problems with the config file.
5786 elevel = IsUnderPostmaster ? DEBUG3 : LOG;
5788 record = find_option(name, true, elevel);
5789 /* should not happen */
5791 elog(ERROR, "unrecognized configuration parameter \"%s\"", name);
5793 sourcefile = guc_strdup(elevel, sourcefile);
5794 if (record->sourcefile)
5795 free(record->sourcefile);
5796 record->sourcefile = sourcefile;
5797 record->sourceline = sourceline;
5801 * Set a config option to the given value. See also set_config_option,
5802 * this is just the wrapper to be called from outside GUC. NB: this
5803 * is used only for non-transactional operations.
5805 * Note: there is no support here for setting source file/line, as it
5806 * is currently not needed.
5809 SetConfigOption(const char *name, const char *value,
5810 GucContext context, GucSource source)
5812 (void) set_config_option(name, value, context, source,
5813 GUC_ACTION_SET, true);
5819 * Fetch the current value of the option `name', as a string.
5821 * If the option doesn't exist, return NULL if missing_ok is true (NOTE that
5822 * this cannot be distinguished from a string variable with a NULL value!),
5823 * otherwise throw an ereport and don't return.
5825 * If restrict_superuser is true, we also enforce that only superusers can
5826 * see GUC_SUPERUSER_ONLY variables. This should only be passed as true
5827 * in user-driven calls.
5829 * The string is *not* allocated for modification and is really only
5830 * valid until the next call to configuration related functions.
5833 GetConfigOption(const char *name, bool missing_ok, bool restrict_superuser)
5835 struct config_generic *record;
5836 static char buffer[256];
5838 record = find_option(name, false, ERROR);
5844 (errcode(ERRCODE_UNDEFINED_OBJECT),
5845 errmsg("unrecognized configuration parameter \"%s\"",
5848 if (restrict_superuser &&
5849 (record->flags & GUC_SUPERUSER_ONLY) &&
5852 (errcode(ERRCODE_INSUFFICIENT_PRIVILEGE),
5853 errmsg("must be superuser to examine \"%s\"", name)));
5855 switch (record->vartype)
5858 return *((struct config_bool *) record)->variable ? "on" : "off";
5861 snprintf(buffer, sizeof(buffer), "%d",
5862 *((struct config_int *) record)->variable);
5866 snprintf(buffer, sizeof(buffer), "%g",
5867 *((struct config_real *) record)->variable);
5871 return *((struct config_string *) record)->variable;
5874 return config_enum_lookup_by_value((struct config_enum *) record,
5875 *((struct config_enum *) record)->variable);
5881 * Get the RESET value associated with the given option.
5883 * Note: this is not re-entrant, due to use of static result buffer;
5884 * not to mention that a string variable could have its reset_val changed.
5885 * Beware of assuming the result value is good for very long.
5888 GetConfigOptionResetString(const char *name)
5890 struct config_generic *record;
5891 static char buffer[256];
5893 record = find_option(name, false, ERROR);
5896 (errcode(ERRCODE_UNDEFINED_OBJECT),
5897 errmsg("unrecognized configuration parameter \"%s\"", name)));
5898 if ((record->flags & GUC_SUPERUSER_ONLY) && !superuser())
5900 (errcode(ERRCODE_INSUFFICIENT_PRIVILEGE),
5901 errmsg("must be superuser to examine \"%s\"", name)));
5903 switch (record->vartype)
5906 return ((struct config_bool *) record)->reset_val ? "on" : "off";
5909 snprintf(buffer, sizeof(buffer), "%d",
5910 ((struct config_int *) record)->reset_val);
5914 snprintf(buffer, sizeof(buffer), "%g",
5915 ((struct config_real *) record)->reset_val);
5919 return ((struct config_string *) record)->reset_val;
5922 return config_enum_lookup_by_value((struct config_enum *) record,
5923 ((struct config_enum *) record)->reset_val);
5930 * flatten_set_variable_args
5931 * Given a parsenode List as emitted by the grammar for SET,
5932 * convert to the flat string representation used by GUC.
5934 * We need to be told the name of the variable the args are for, because
5935 * the flattening rules vary (ugh).
5937 * The result is NULL if args is NIL (ie, SET ... TO DEFAULT), otherwise
5938 * a palloc'd string.
5941 flatten_set_variable_args(const char *name, List *args)
5943 struct config_generic *record;
5948 /* Fast path if just DEFAULT */
5953 * Get flags for the variable; if it's not known, use default flags.
5954 * (Caller might throw error later, but not our business to do so here.)
5956 record = find_option(name, false, WARNING);
5958 flags = record->flags;
5962 /* Complain if list input and non-list variable */
5963 if ((flags & GUC_LIST_INPUT) == 0 &&
5964 list_length(args) != 1)
5966 (errcode(ERRCODE_INVALID_PARAMETER_VALUE),
5967 errmsg("SET %s takes only one argument", name)));
5969 initStringInfo(&buf);
5972 * Each list member may be a plain A_Const node, or an A_Const within a
5973 * TypeCast; the latter case is supported only for ConstInterval arguments
5974 * (for SET TIME ZONE).
5978 Node *arg = (Node *) lfirst(l);
5980 TypeName *typeName = NULL;
5983 if (l != list_head(args))
5984 appendStringInfo(&buf, ", ");
5986 if (IsA(arg, TypeCast))
5988 TypeCast *tc = (TypeCast *) arg;
5991 typeName = tc->typeName;
5994 if (!IsA(arg, A_Const))
5995 elog(ERROR, "unrecognized node type: %d", (int) nodeTag(arg));
5996 con = (A_Const *) arg;
5998 switch (nodeTag(&con->val))
6001 appendStringInfo(&buf, "%ld", intVal(&con->val));
6004 /* represented as a string, so just copy it */
6005 appendStringInfoString(&buf, strVal(&con->val));
6008 val = strVal(&con->val);
6009 if (typeName != NULL)
6012 * Must be a ConstInterval argument for TIME ZONE. Coerce
6013 * to interval and back to normalize the value and account
6021 typenameTypeIdAndMod(NULL, typeName, &typoid, &typmod);
6022 Assert(typoid == INTERVALOID);
6025 DirectFunctionCall3(interval_in,
6026 CStringGetDatum(val),
6027 ObjectIdGetDatum(InvalidOid),
6028 Int32GetDatum(typmod));
6031 DatumGetCString(DirectFunctionCall1(interval_out,
6033 appendStringInfo(&buf, "INTERVAL '%s'", intervalout);
6038 * Plain string literal or identifier. For quote mode,
6039 * quote it if it's not a vanilla identifier.
6041 if (flags & GUC_LIST_QUOTE)
6042 appendStringInfoString(&buf, quote_identifier(val));
6044 appendStringInfoString(&buf, val);
6048 elog(ERROR, "unrecognized node type: %d",
6049 (int) nodeTag(&con->val));
6062 ExecSetVariableStmt(VariableSetStmt *stmt)
6064 GucAction action = stmt->is_local ? GUC_ACTION_LOCAL : GUC_ACTION_SET;
6069 case VAR_SET_CURRENT:
6070 (void) set_config_option(stmt->name,
6071 ExtractSetVariableArgs(stmt),
6072 (superuser() ? PGC_SUSET : PGC_USERSET),
6080 * Special case for special SQL syntax that effectively sets more
6081 * than one variable per statement.
6083 if (strcmp(stmt->name, "TRANSACTION") == 0)
6087 foreach(head, stmt->args)
6089 DefElem *item = (DefElem *) lfirst(head);
6091 if (strcmp(item->defname, "transaction_isolation") == 0)
6092 SetPGVariable("transaction_isolation",
6093 list_make1(item->arg), stmt->is_local);
6094 else if (strcmp(item->defname, "transaction_read_only") == 0)
6095 SetPGVariable("transaction_read_only",
6096 list_make1(item->arg), stmt->is_local);
6097 else if (strcmp(item->defname, "transaction_deferrable") == 0)
6098 SetPGVariable("transaction_deferrable",
6099 list_make1(item->arg), stmt->is_local);
6101 elog(ERROR, "unexpected SET TRANSACTION element: %s",
6105 else if (strcmp(stmt->name, "SESSION CHARACTERISTICS") == 0)
6109 foreach(head, stmt->args)
6111 DefElem *item = (DefElem *) lfirst(head);
6113 if (strcmp(item->defname, "transaction_isolation") == 0)
6114 SetPGVariable("default_transaction_isolation",
6115 list_make1(item->arg), stmt->is_local);
6116 else if (strcmp(item->defname, "transaction_read_only") == 0)
6117 SetPGVariable("default_transaction_read_only",
6118 list_make1(item->arg), stmt->is_local);
6119 else if (strcmp(item->defname, "transaction_deferrable") == 0)
6120 SetPGVariable("default_transaction_deferrable",
6121 list_make1(item->arg), stmt->is_local);
6123 elog(ERROR, "unexpected SET SESSION element: %s",
6128 elog(ERROR, "unexpected SET MULTI element: %s",
6131 case VAR_SET_DEFAULT:
6133 (void) set_config_option(stmt->name,
6135 (superuser() ? PGC_SUSET : PGC_USERSET),
6147 * Get the value to assign for a VariableSetStmt, or NULL if it's RESET.
6148 * The result is palloc'd.
6150 * This is exported for use by actions such as ALTER ROLE SET.
6153 ExtractSetVariableArgs(VariableSetStmt *stmt)
6158 return flatten_set_variable_args(stmt->name, stmt->args);
6159 case VAR_SET_CURRENT:
6160 return GetConfigOptionByName(stmt->name, NULL);
6167 * SetPGVariable - SET command exported as an easily-C-callable function.
6169 * This provides access to SET TO value, as well as SET TO DEFAULT (expressed
6170 * by passing args == NIL), but not SET FROM CURRENT functionality.
6173 SetPGVariable(const char *name, List *args, bool is_local)
6175 char *argstring = flatten_set_variable_args(name, args);
6177 /* Note SET DEFAULT (argstring == NULL) is equivalent to RESET */
6178 (void) set_config_option(name,
6180 (superuser() ? PGC_SUSET : PGC_USERSET),
6182 is_local ? GUC_ACTION_LOCAL : GUC_ACTION_SET,
6187 * SET command wrapped as a SQL callable function.
6190 set_config_by_name(PG_FUNCTION_ARGS)
6197 if (PG_ARGISNULL(0))
6199 (errcode(ERRCODE_NULL_VALUE_NOT_ALLOWED),
6200 errmsg("SET requires parameter name")));
6202 /* Get the GUC variable name */
6203 name = TextDatumGetCString(PG_GETARG_DATUM(0));
6205 /* Get the desired value or set to NULL for a reset request */
6206 if (PG_ARGISNULL(1))
6209 value = TextDatumGetCString(PG_GETARG_DATUM(1));
6212 * Get the desired state of is_local. Default to false if provided value
6215 if (PG_ARGISNULL(2))
6218 is_local = PG_GETARG_BOOL(2);
6220 /* Note SET DEFAULT (argstring == NULL) is equivalent to RESET */
6221 (void) set_config_option(name,
6223 (superuser() ? PGC_SUSET : PGC_USERSET),
6225 is_local ? GUC_ACTION_LOCAL : GUC_ACTION_SET,
6228 /* get the new current value */
6229 new_value = GetConfigOptionByName(name, NULL);
6231 /* Convert return string to text */
6232 PG_RETURN_TEXT_P(cstring_to_text(new_value));
6237 * Common code for DefineCustomXXXVariable subroutines: allocate the
6238 * new variable's config struct and fill in generic fields.
6240 static struct config_generic *
6241 init_custom_variable(const char *name,
6242 const char *short_desc,
6243 const char *long_desc,
6246 enum config_type type,
6249 struct config_generic *gen;
6252 * Only allow custom PGC_POSTMASTER variables to be created during shared
6253 * library preload; any later than that, we can't ensure that the value
6254 * doesn't change after startup. This is a fatal elog if it happens; just
6255 * erroring out isn't safe because we don't know what the calling loadable
6256 * module might already have hooked into.
6258 if (context == PGC_POSTMASTER &&
6259 !process_shared_preload_libraries_in_progress)
6260 elog(FATAL, "cannot create PGC_POSTMASTER variables after startup");
6262 gen = (struct config_generic *) guc_malloc(ERROR, sz);
6265 gen->name = guc_strdup(ERROR, name);
6266 gen->context = context;
6267 gen->group = CUSTOM_OPTIONS;
6268 gen->short_desc = short_desc;
6269 gen->long_desc = long_desc;
6271 gen->vartype = type;
6277 * Common code for DefineCustomXXXVariable subroutines: insert the new
6278 * variable into the GUC variable array, replacing any placeholder.
6281 define_custom_variable(struct config_generic * variable)
6283 const char *name = variable->name;
6284 const char **nameAddr = &name;
6286 struct config_string *pHolder;
6287 struct config_generic **res;
6290 * See if there's a placeholder by the same name.
6292 res = (struct config_generic **) bsearch((void *) &nameAddr,
6293 (void *) guc_variables,
6295 sizeof(struct config_generic *),
6300 * No placeholder to replace, so we can just add it ... but first,
6301 * make sure it's initialized to its default value.
6303 InitializeOneGUCOption(variable);
6304 add_guc_variable(variable, ERROR);
6309 * This better be a placeholder
6311 if (((*res)->flags & GUC_CUSTOM_PLACEHOLDER) == 0)
6313 (errcode(ERRCODE_INTERNAL_ERROR),
6314 errmsg("attempt to redefine parameter \"%s\"", name)));
6316 Assert((*res)->vartype == PGC_STRING);
6317 pHolder = (struct config_string *) (*res);
6320 * First, set the variable to its default value. We must do this even
6321 * though we intend to immediately apply a new value, since it's possible
6322 * that the new value is invalid.
6324 InitializeOneGUCOption(variable);
6327 * Replace the placeholder. We aren't changing the name, so no re-sorting
6333 * Assign the string value stored in the placeholder to the real variable.
6335 * XXX this is not really good enough --- it should be a nontransactional
6336 * assignment, since we don't want it to roll back if the current xact
6337 * fails later. (Or do we?)
6339 value = *pHolder->variable;
6343 if (set_config_option(name, value,
6344 pHolder->gen.scontext, pHolder->gen.source,
6345 GUC_ACTION_SET, true) != 0)
6347 /* Also copy over any saved source-location information */
6348 if (pHolder->gen.sourcefile)
6349 set_config_sourcefile(name, pHolder->gen.sourcefile,
6350 pHolder->gen.sourceline);
6355 * Free up as much as we conveniently can of the placeholder structure
6356 * (this neglects any stack items...)
6358 set_string_field(pHolder, pHolder->variable, NULL);
6359 set_string_field(pHolder, &pHolder->reset_val, NULL);
6365 DefineCustomBoolVariable(const char *name,
6366 const char *short_desc,
6367 const char *long_desc,
6372 GucBoolCheckHook check_hook,
6373 GucBoolAssignHook assign_hook,
6374 GucShowHook show_hook)
6376 struct config_bool *var;
6378 var = (struct config_bool *)
6379 init_custom_variable(name, short_desc, long_desc, context, flags,
6380 PGC_BOOL, sizeof(struct config_bool));
6381 var->variable = valueAddr;
6382 var->boot_val = bootValue;
6383 var->reset_val = bootValue;
6384 var->check_hook = check_hook;
6385 var->assign_hook = assign_hook;
6386 var->show_hook = show_hook;
6387 define_custom_variable(&var->gen);
6391 DefineCustomIntVariable(const char *name,
6392 const char *short_desc,
6393 const char *long_desc,
6400 GucIntCheckHook check_hook,
6401 GucIntAssignHook assign_hook,
6402 GucShowHook show_hook)
6404 struct config_int *var;
6406 var = (struct config_int *)
6407 init_custom_variable(name, short_desc, long_desc, context, flags,
6408 PGC_INT, sizeof(struct config_int));
6409 var->variable = valueAddr;
6410 var->boot_val = bootValue;
6411 var->reset_val = bootValue;
6412 var->min = minValue;
6413 var->max = maxValue;
6414 var->check_hook = check_hook;
6415 var->assign_hook = assign_hook;
6416 var->show_hook = show_hook;
6417 define_custom_variable(&var->gen);
6421 DefineCustomRealVariable(const char *name,
6422 const char *short_desc,
6423 const char *long_desc,
6430 GucRealCheckHook check_hook,
6431 GucRealAssignHook assign_hook,
6432 GucShowHook show_hook)
6434 struct config_real *var;
6436 var = (struct config_real *)
6437 init_custom_variable(name, short_desc, long_desc, context, flags,
6438 PGC_REAL, sizeof(struct config_real));
6439 var->variable = valueAddr;
6440 var->boot_val = bootValue;
6441 var->reset_val = bootValue;
6442 var->min = minValue;
6443 var->max = maxValue;
6444 var->check_hook = check_hook;
6445 var->assign_hook = assign_hook;
6446 var->show_hook = show_hook;
6447 define_custom_variable(&var->gen);
6451 DefineCustomStringVariable(const char *name,
6452 const char *short_desc,
6453 const char *long_desc,
6455 const char *bootValue,
6458 GucStringCheckHook check_hook,
6459 GucStringAssignHook assign_hook,
6460 GucShowHook show_hook)
6462 struct config_string *var;
6464 var = (struct config_string *)
6465 init_custom_variable(name, short_desc, long_desc, context, flags,
6466 PGC_STRING, sizeof(struct config_string));
6467 var->variable = valueAddr;
6468 var->boot_val = bootValue;
6469 var->check_hook = check_hook;
6470 var->assign_hook = assign_hook;
6471 var->show_hook = show_hook;
6472 define_custom_variable(&var->gen);
6476 DefineCustomEnumVariable(const char *name,
6477 const char *short_desc,
6478 const char *long_desc,
6481 const struct config_enum_entry * options,
6484 GucEnumCheckHook check_hook,
6485 GucEnumAssignHook assign_hook,
6486 GucShowHook show_hook)
6488 struct config_enum *var;
6490 var = (struct config_enum *)
6491 init_custom_variable(name, short_desc, long_desc, context, flags,
6492 PGC_ENUM, sizeof(struct config_enum));
6493 var->variable = valueAddr;
6494 var->boot_val = bootValue;
6495 var->reset_val = bootValue;
6496 var->options = options;
6497 var->check_hook = check_hook;
6498 var->assign_hook = assign_hook;
6499 var->show_hook = show_hook;
6500 define_custom_variable(&var->gen);
6504 EmitWarningsOnPlaceholders(const char *className)
6506 int classLen = strlen(className);
6509 for (i = 0; i < num_guc_variables; i++)
6511 struct config_generic *var = guc_variables[i];
6513 if ((var->flags & GUC_CUSTOM_PLACEHOLDER) != 0 &&
6514 strncmp(className, var->name, classLen) == 0 &&
6515 var->name[classLen] == GUC_QUALIFIER_SEPARATOR)
6518 (errcode(ERRCODE_UNDEFINED_OBJECT),
6519 errmsg("unrecognized configuration parameter \"%s\"",
6530 GetPGVariable(const char *name, DestReceiver *dest)
6532 if (guc_name_compare(name, "all") == 0)
6533 ShowAllGUCConfig(dest);
6535 ShowGUCConfigOption(name, dest);
6539 GetPGVariableResultDesc(const char *name)
6543 if (guc_name_compare(name, "all") == 0)
6545 /* need a tuple descriptor representing three TEXT columns */
6546 tupdesc = CreateTemplateTupleDesc(3, false);
6547 TupleDescInitEntry(tupdesc, (AttrNumber) 1, "name",
6549 TupleDescInitEntry(tupdesc, (AttrNumber) 2, "setting",
6551 TupleDescInitEntry(tupdesc, (AttrNumber) 3, "description",
6556 const char *varname;
6558 /* Get the canonical spelling of name */
6559 (void) GetConfigOptionByName(name, &varname);
6561 /* need a tuple descriptor representing a single TEXT column */
6562 tupdesc = CreateTemplateTupleDesc(1, false);
6563 TupleDescInitEntry(tupdesc, (AttrNumber) 1, varname,
6574 ShowGUCConfigOption(const char *name, DestReceiver *dest)
6576 TupOutputState *tstate;
6578 const char *varname;
6581 /* Get the value and canonical spelling of name */
6582 value = GetConfigOptionByName(name, &varname);
6584 /* need a tuple descriptor representing a single TEXT column */
6585 tupdesc = CreateTemplateTupleDesc(1, false);
6586 TupleDescInitEntry(tupdesc, (AttrNumber) 1, varname,
6589 /* prepare for projection of tuples */
6590 tstate = begin_tup_output_tupdesc(dest, tupdesc);
6593 do_text_output_oneline(tstate, value);
6595 end_tup_output(tstate);
6602 ShowAllGUCConfig(DestReceiver *dest)
6604 bool am_superuser = superuser();
6606 TupOutputState *tstate;
6609 bool isnull[3] = {false, false, false};
6611 /* need a tuple descriptor representing three TEXT columns */
6612 tupdesc = CreateTemplateTupleDesc(3, false);
6613 TupleDescInitEntry(tupdesc, (AttrNumber) 1, "name",
6615 TupleDescInitEntry(tupdesc, (AttrNumber) 2, "setting",
6617 TupleDescInitEntry(tupdesc, (AttrNumber) 3, "description",
6620 /* prepare for projection of tuples */
6621 tstate = begin_tup_output_tupdesc(dest, tupdesc);
6623 for (i = 0; i < num_guc_variables; i++)
6625 struct config_generic *conf = guc_variables[i];
6628 if ((conf->flags & GUC_NO_SHOW_ALL) ||
6629 ((conf->flags & GUC_SUPERUSER_ONLY) && !am_superuser))
6632 /* assign to the values array */
6633 values[0] = PointerGetDatum(cstring_to_text(conf->name));
6635 setting = _ShowOption(conf, true);
6638 values[1] = PointerGetDatum(cstring_to_text(setting));
6643 values[1] = PointerGetDatum(NULL);
6647 values[2] = PointerGetDatum(cstring_to_text(conf->short_desc));
6649 /* send it to dest */
6650 do_tup_output(tstate, values, isnull);
6653 pfree(DatumGetPointer(values[0]));
6657 pfree(DatumGetPointer(values[1]));
6659 pfree(DatumGetPointer(values[2]));
6662 end_tup_output(tstate);
6666 * Return GUC variable value by name; optionally return canonical
6667 * form of name. Return value is palloc'd.
6670 GetConfigOptionByName(const char *name, const char **varname)
6672 struct config_generic *record;
6674 record = find_option(name, false, ERROR);
6677 (errcode(ERRCODE_UNDEFINED_OBJECT),
6678 errmsg("unrecognized configuration parameter \"%s\"", name)));
6679 if ((record->flags & GUC_SUPERUSER_ONLY) && !superuser())
6681 (errcode(ERRCODE_INSUFFICIENT_PRIVILEGE),
6682 errmsg("must be superuser to examine \"%s\"", name)));
6685 *varname = record->name;
6687 return _ShowOption(record, true);
6691 * Return GUC variable value by variable number; optionally return canonical
6692 * form of name. Return value is palloc'd.
6695 GetConfigOptionByNum(int varnum, const char **values, bool *noshow)
6698 struct config_generic *conf;
6700 /* check requested variable number valid */
6701 Assert((varnum >= 0) && (varnum < num_guc_variables));
6703 conf = guc_variables[varnum];
6707 if ((conf->flags & GUC_NO_SHOW_ALL) ||
6708 ((conf->flags & GUC_SUPERUSER_ONLY) && !superuser()))
6714 /* first get the generic attributes */
6717 values[0] = conf->name;
6719 /* setting : use _ShowOption in order to avoid duplicating the logic */
6720 values[1] = _ShowOption(conf, false);
6723 if (conf->vartype == PGC_INT)
6727 switch (conf->flags & (GUC_UNIT_MEMORY | GUC_UNIT_TIME))
6732 case GUC_UNIT_BLOCKS:
6733 snprintf(buf, sizeof(buf), "%dkB", BLCKSZ / 1024);
6736 case GUC_UNIT_XBLOCKS:
6737 snprintf(buf, sizeof(buf), "%dkB", XLOG_BLCKSZ / 1024);
6758 values[3] = config_group_names[conf->group];
6761 values[4] = conf->short_desc;
6764 values[5] = conf->long_desc;
6767 values[6] = GucContext_Names[conf->context];
6770 values[7] = config_type_names[conf->vartype];
6773 values[8] = GucSource_Names[conf->source];
6775 /* now get the type specifc attributes */
6776 switch (conf->vartype)
6780 struct config_bool *lconf = (struct config_bool *) conf;
6792 values[12] = pstrdup(lconf->boot_val ? "on" : "off");
6795 values[13] = pstrdup(lconf->reset_val ? "on" : "off");
6801 struct config_int *lconf = (struct config_int *) conf;
6804 snprintf(buffer, sizeof(buffer), "%d", lconf->min);
6805 values[9] = pstrdup(buffer);
6808 snprintf(buffer, sizeof(buffer), "%d", lconf->max);
6809 values[10] = pstrdup(buffer);
6815 snprintf(buffer, sizeof(buffer), "%d", lconf->boot_val);
6816 values[12] = pstrdup(buffer);
6819 snprintf(buffer, sizeof(buffer), "%d", lconf->reset_val);
6820 values[13] = pstrdup(buffer);
6826 struct config_real *lconf = (struct config_real *) conf;
6829 snprintf(buffer, sizeof(buffer), "%g", lconf->min);
6830 values[9] = pstrdup(buffer);
6833 snprintf(buffer, sizeof(buffer), "%g", lconf->max);
6834 values[10] = pstrdup(buffer);
6840 snprintf(buffer, sizeof(buffer), "%g", lconf->boot_val);
6841 values[12] = pstrdup(buffer);
6844 snprintf(buffer, sizeof(buffer), "%g", lconf->reset_val);
6845 values[13] = pstrdup(buffer);
6851 struct config_string *lconf = (struct config_string *) conf;
6863 if (lconf->boot_val == NULL)
6866 values[12] = pstrdup(lconf->boot_val);
6869 if (lconf->reset_val == NULL)
6872 values[13] = pstrdup(lconf->reset_val);
6878 struct config_enum *lconf = (struct config_enum *) conf;
6889 * NOTE! enumvals with double quotes in them are not
6892 values[11] = config_enum_get_options((struct config_enum *) conf,
6893 "{\"", "\"}", "\",\"");
6896 values[12] = pstrdup(config_enum_lookup_by_value(lconf,
6900 values[13] = pstrdup(config_enum_lookup_by_value(lconf,
6908 * should never get here, but in case we do, set 'em to NULL
6930 * If the setting came from a config file, set the source location. For
6931 * security reasons, we don't show source file/line number for
6934 if (conf->source == PGC_S_FILE && superuser())
6936 values[14] = conf->sourcefile;
6937 snprintf(buffer, sizeof(buffer), "%d", conf->sourceline);
6938 values[15] = pstrdup(buffer);
6948 * Return the total number of GUC variables
6951 GetNumConfigOptions(void)
6953 return num_guc_variables;
6957 * show_config_by_name - equiv to SHOW X command but implemented as
6961 show_config_by_name(PG_FUNCTION_ARGS)
6966 /* Get the GUC variable name */
6967 varname = TextDatumGetCString(PG_GETARG_DATUM(0));
6970 varval = GetConfigOptionByName(varname, NULL);
6972 /* Convert to text */
6973 PG_RETURN_TEXT_P(cstring_to_text(varval));
6977 * show_all_settings - equiv to SHOW ALL command but implemented as
6980 #define NUM_PG_SETTINGS_ATTS 16
6983 show_all_settings(PG_FUNCTION_ARGS)
6985 FuncCallContext *funcctx;
6989 AttInMetadata *attinmeta;
6990 MemoryContext oldcontext;
6992 /* stuff done only on the first call of the function */
6993 if (SRF_IS_FIRSTCALL())
6995 /* create a function context for cross-call persistence */
6996 funcctx = SRF_FIRSTCALL_INIT();
6999 * switch to memory context appropriate for multiple function calls
7001 oldcontext = MemoryContextSwitchTo(funcctx->multi_call_memory_ctx);
7004 * need a tuple descriptor representing NUM_PG_SETTINGS_ATTS columns
7005 * of the appropriate types
7007 tupdesc = CreateTemplateTupleDesc(NUM_PG_SETTINGS_ATTS, false);
7008 TupleDescInitEntry(tupdesc, (AttrNumber) 1, "name",
7010 TupleDescInitEntry(tupdesc, (AttrNumber) 2, "setting",
7012 TupleDescInitEntry(tupdesc, (AttrNumber) 3, "unit",
7014 TupleDescInitEntry(tupdesc, (AttrNumber) 4, "category",
7016 TupleDescInitEntry(tupdesc, (AttrNumber) 5, "short_desc",
7018 TupleDescInitEntry(tupdesc, (AttrNumber) 6, "extra_desc",
7020 TupleDescInitEntry(tupdesc, (AttrNumber) 7, "context",
7022 TupleDescInitEntry(tupdesc, (AttrNumber) 8, "vartype",
7024 TupleDescInitEntry(tupdesc, (AttrNumber) 9, "source",
7026 TupleDescInitEntry(tupdesc, (AttrNumber) 10, "min_val",
7028 TupleDescInitEntry(tupdesc, (AttrNumber) 11, "max_val",
7030 TupleDescInitEntry(tupdesc, (AttrNumber) 12, "enumvals",
7031 TEXTARRAYOID, -1, 0);
7032 TupleDescInitEntry(tupdesc, (AttrNumber) 13, "boot_val",
7034 TupleDescInitEntry(tupdesc, (AttrNumber) 14, "reset_val",
7036 TupleDescInitEntry(tupdesc, (AttrNumber) 15, "sourcefile",
7038 TupleDescInitEntry(tupdesc, (AttrNumber) 16, "sourceline",
7042 * Generate attribute metadata needed later to produce tuples from raw
7045 attinmeta = TupleDescGetAttInMetadata(tupdesc);
7046 funcctx->attinmeta = attinmeta;
7048 /* total number of tuples to be returned */
7049 funcctx->max_calls = GetNumConfigOptions();
7051 MemoryContextSwitchTo(oldcontext);
7054 /* stuff done on every call of the function */
7055 funcctx = SRF_PERCALL_SETUP();
7057 call_cntr = funcctx->call_cntr;
7058 max_calls = funcctx->max_calls;
7059 attinmeta = funcctx->attinmeta;
7061 if (call_cntr < max_calls) /* do when there is more left to send */
7063 char *values[NUM_PG_SETTINGS_ATTS];
7069 * Get the next visible GUC variable name and value
7073 GetConfigOptionByNum(call_cntr, (const char **) values, &noshow);
7076 /* bump the counter and get the next config setting */
7077 call_cntr = ++funcctx->call_cntr;
7079 /* make sure we haven't gone too far now */
7080 if (call_cntr >= max_calls)
7081 SRF_RETURN_DONE(funcctx);
7086 tuple = BuildTupleFromCStrings(attinmeta, values);
7088 /* make the tuple into a datum */
7089 result = HeapTupleGetDatum(tuple);
7091 SRF_RETURN_NEXT(funcctx, result);
7095 /* do when there is no more left */
7096 SRF_RETURN_DONE(funcctx);
7101 _ShowOption(struct config_generic * record, bool use_units)
7106 switch (record->vartype)
7110 struct config_bool *conf = (struct config_bool *) record;
7112 if (conf->show_hook)
7113 val = (*conf->show_hook) ();
7115 val = *conf->variable ? "on" : "off";
7121 struct config_int *conf = (struct config_int *) record;
7123 if (conf->show_hook)
7124 val = (*conf->show_hook) ();
7128 * Use int64 arithmetic to avoid overflows in units
7131 int64 result = *conf->variable;
7134 if (use_units && result > 0 &&
7135 (record->flags & GUC_UNIT_MEMORY))
7137 switch (record->flags & GUC_UNIT_MEMORY)
7139 case GUC_UNIT_BLOCKS:
7140 result *= BLCKSZ / 1024;
7142 case GUC_UNIT_XBLOCKS:
7143 result *= XLOG_BLCKSZ / 1024;
7147 if (result % KB_PER_GB == 0)
7149 result /= KB_PER_GB;
7152 else if (result % KB_PER_MB == 0)
7154 result /= KB_PER_MB;
7162 else if (use_units && result > 0 &&
7163 (record->flags & GUC_UNIT_TIME))
7165 switch (record->flags & GUC_UNIT_TIME)
7171 result *= MS_PER_MIN;
7175 if (result % MS_PER_D == 0)
7180 else if (result % MS_PER_H == 0)
7185 else if (result % MS_PER_MIN == 0)
7187 result /= MS_PER_MIN;
7190 else if (result % MS_PER_S == 0)
7203 snprintf(buffer, sizeof(buffer), INT64_FORMAT "%s",
7212 struct config_real *conf = (struct config_real *) record;
7214 if (conf->show_hook)
7215 val = (*conf->show_hook) ();
7218 snprintf(buffer, sizeof(buffer), "%g",
7227 struct config_string *conf = (struct config_string *) record;
7229 if (conf->show_hook)
7230 val = (*conf->show_hook) ();
7231 else if (*conf->variable && **conf->variable)
7232 val = *conf->variable;
7240 struct config_enum *conf = (struct config_enum *) record;
7242 if (conf->show_hook)
7243 val = (*conf->show_hook) ();
7245 val = config_enum_lookup_by_value(conf, *conf->variable);
7250 /* just to keep compiler quiet */
7255 return pstrdup(val);
7262 * These routines dump out all non-default GUC options into a binary
7263 * file that is read by all exec'ed backends. The format is:
7265 * variable name, string, null terminated
7266 * variable value, string, null terminated
7267 * variable source, integer
7268 * variable scontext, integer
7271 write_one_nondefault_variable(FILE *fp, struct config_generic * gconf)
7273 if (gconf->source == PGC_S_DEFAULT)
7276 fprintf(fp, "%s", gconf->name);
7279 switch (gconf->vartype)
7283 struct config_bool *conf = (struct config_bool *) gconf;
7285 if (*conf->variable)
7286 fprintf(fp, "true");
7288 fprintf(fp, "false");
7294 struct config_int *conf = (struct config_int *) gconf;
7296 fprintf(fp, "%d", *conf->variable);
7302 struct config_real *conf = (struct config_real *) gconf;
7304 fprintf(fp, "%.17g", *conf->variable);
7310 struct config_string *conf = (struct config_string *) gconf;
7312 fprintf(fp, "%s", *conf->variable);
7318 struct config_enum *conf = (struct config_enum *) gconf;
7321 config_enum_lookup_by_value(conf, *conf->variable));
7328 fwrite(&gconf->source, 1, sizeof(gconf->source), fp);
7329 fwrite(&gconf->scontext, 1, sizeof(gconf->scontext), fp);
7333 write_nondefault_variables(GucContext context)
7339 Assert(context == PGC_POSTMASTER || context == PGC_SIGHUP);
7341 elevel = (context == PGC_SIGHUP) ? LOG : ERROR;
7346 fp = AllocateFile(CONFIG_EXEC_PARAMS_NEW, "w");
7350 (errcode_for_file_access(),
7351 errmsg("could not write to file \"%s\": %m",
7352 CONFIG_EXEC_PARAMS_NEW)));
7356 for (i = 0; i < num_guc_variables; i++)
7358 write_one_nondefault_variable(fp, guc_variables[i]);
7364 (errcode_for_file_access(),
7365 errmsg("could not write to file \"%s\": %m",
7366 CONFIG_EXEC_PARAMS_NEW)));
7371 * Put new file in place. This could delay on Win32, but we don't hold
7372 * any exclusive locks.
7374 rename(CONFIG_EXEC_PARAMS_NEW, CONFIG_EXEC_PARAMS);
7379 * Read string, including null byte from file
7381 * Return NULL on EOF and nothing read
7384 read_string_with_null(FILE *fp)
7393 if ((ch = fgetc(fp)) == EOF)
7398 elog(FATAL, "invalid format of exec config params file");
7401 str = guc_malloc(FATAL, maxlen);
7402 else if (i == maxlen)
7403 str = guc_realloc(FATAL, str, maxlen *= 2);
7412 * This routine loads a previous postmaster dump of its non-default
7416 read_nondefault_variables(void)
7421 GucSource varsource;
7422 GucContext varscontext;
7427 fp = AllocateFile(CONFIG_EXEC_PARAMS, "r");
7430 /* File not found is fine */
7431 if (errno != ENOENT)
7433 (errcode_for_file_access(),
7434 errmsg("could not read from file \"%s\": %m",
7435 CONFIG_EXEC_PARAMS)));
7441 struct config_generic *record;
7443 if ((varname = read_string_with_null(fp)) == NULL)
7446 if ((record = find_option(varname, true, FATAL)) == NULL)
7447 elog(FATAL, "failed to locate variable %s in exec config params file", varname);
7448 if ((varvalue = read_string_with_null(fp)) == NULL)
7449 elog(FATAL, "invalid format of exec config params file");
7450 if (fread(&varsource, 1, sizeof(varsource), fp) != sizeof(varsource))
7451 elog(FATAL, "invalid format of exec config params file");
7452 if (fread(&varscontext, 1, sizeof(varscontext), fp) != sizeof(varscontext))
7453 elog(FATAL, "invalid format of exec config params file");
7455 (void) set_config_option(varname, varvalue,
7456 varscontext, varsource,
7457 GUC_ACTION_SET, true);
7464 #endif /* EXEC_BACKEND */
7468 * A little "long argument" simulation, although not quite GNU
7469 * compliant. Takes a string of the form "some-option=some value" and
7470 * returns name = "some_option" and value = "some value" in malloc'ed
7471 * storage. Note that '-' is converted to '_' in the option name. If
7472 * there is no '=' in the input string then value will be NULL.
7475 ParseLongOption(const char *string, char **name, char **value)
7484 equal_pos = strcspn(string, "=");
7486 if (string[equal_pos] == '=')
7488 *name = guc_malloc(FATAL, equal_pos + 1);
7489 strlcpy(*name, string, equal_pos + 1);
7491 *value = guc_strdup(FATAL, &string[equal_pos + 1]);
7495 /* no equal sign in string */
7496 *name = guc_strdup(FATAL, string);
7500 for (cp = *name; *cp; cp++)
7507 * Handle options fetched from pg_db_role_setting.setconfig,
7508 * pg_proc.proconfig, etc. Caller must specify proper context/source/action.
7510 * The array parameter must be an array of TEXT (it must not be NULL).
7513 ProcessGUCArray(ArrayType *array,
7514 GucContext context, GucSource source, GucAction action)
7518 Assert(array != NULL);
7519 Assert(ARR_ELEMTYPE(array) == TEXTOID);
7520 Assert(ARR_NDIM(array) == 1);
7521 Assert(ARR_LBOUND(array)[0] == 1);
7523 for (i = 1; i <= ARR_DIMS(array)[0]; i++)
7531 d = array_ref(array, 1, &i,
7532 -1 /* varlenarray */ ,
7533 -1 /* TEXT's typlen */ ,
7534 false /* TEXT's typbyval */ ,
7535 'i' /* TEXT's typalign */ ,
7541 s = TextDatumGetCString(d);
7543 ParseLongOption(s, &name, &value);
7547 (errcode(ERRCODE_SYNTAX_ERROR),
7548 errmsg("could not parse setting for parameter \"%s\"",
7554 (void) set_config_option(name, value, context, source, action, true);
7565 * Add an entry to an option array. The array parameter may be NULL
7566 * to indicate the current table entry is NULL.
7569 GUCArrayAdd(ArrayType *array, const char *name, const char *value)
7571 struct config_generic *record;
7579 /* test if the option is valid and we're allowed to set it */
7580 (void) validate_option_array_item(name, value, false);
7582 /* normalize name (converts obsolete GUC names to modern spellings) */
7583 record = find_option(name, false, WARNING);
7585 name = record->name;
7587 /* build new item for array */
7588 newval = palloc(strlen(name) + 1 + strlen(value) + 1);
7589 sprintf(newval, "%s=%s", name, value);
7590 datum = CStringGetTextDatum(newval);
7598 Assert(ARR_ELEMTYPE(array) == TEXTOID);
7599 Assert(ARR_NDIM(array) == 1);
7600 Assert(ARR_LBOUND(array)[0] == 1);
7602 index = ARR_DIMS(array)[0] + 1; /* add after end */
7604 for (i = 1; i <= ARR_DIMS(array)[0]; i++)
7609 d = array_ref(array, 1, &i,
7610 -1 /* varlenarray */ ,
7611 -1 /* TEXT's typlen */ ,
7612 false /* TEXT's typbyval */ ,
7613 'i' /* TEXT's typalign */ ,
7617 current = TextDatumGetCString(d);
7619 /* check for match up through and including '=' */
7620 if (strncmp(current, newval, strlen(name) + 1) == 0)
7627 a = array_set(array, 1, &index,
7630 -1 /* varlena array */ ,
7631 -1 /* TEXT's typlen */ ,
7632 false /* TEXT's typbyval */ ,
7633 'i' /* TEXT's typalign */ );
7636 a = construct_array(&datum, 1,
7645 * Delete an entry from an option array. The array parameter may be NULL
7646 * to indicate the current table entry is NULL. Also, if the return value
7647 * is NULL then a null should be stored.
7650 GUCArrayDelete(ArrayType *array, const char *name)
7652 struct config_generic *record;
7653 ArrayType *newarray;
7659 /* test if the option is valid and we're allowed to set it */
7660 (void) validate_option_array_item(name, NULL, false);
7662 /* normalize name (converts obsolete GUC names to modern spellings) */
7663 record = find_option(name, false, WARNING);
7665 name = record->name;
7667 /* if array is currently null, then surely nothing to delete */
7674 for (i = 1; i <= ARR_DIMS(array)[0]; i++)
7680 d = array_ref(array, 1, &i,
7681 -1 /* varlenarray */ ,
7682 -1 /* TEXT's typlen */ ,
7683 false /* TEXT's typbyval */ ,
7684 'i' /* TEXT's typalign */ ,
7688 val = TextDatumGetCString(d);
7690 /* ignore entry if it's what we want to delete */
7691 if (strncmp(val, name, strlen(name)) == 0
7692 && val[strlen(name)] == '=')
7695 /* else add it to the output array */
7697 newarray = array_set(newarray, 1, &index,
7700 -1 /* varlenarray */ ,
7701 -1 /* TEXT's typlen */ ,
7702 false /* TEXT's typbyval */ ,
7703 'i' /* TEXT's typalign */ );
7705 newarray = construct_array(&d, 1,
7717 * Given a GUC array, delete all settings from it that our permission
7718 * level allows: if superuser, delete them all; if regular user, only
7719 * those that are PGC_USERSET
7722 GUCArrayReset(ArrayType *array)
7724 ArrayType *newarray;
7728 /* if array is currently null, nothing to do */
7732 /* if we're superuser, we can delete everything, so just do it */
7739 for (i = 1; i <= ARR_DIMS(array)[0]; i++)
7746 d = array_ref(array, 1, &i,
7747 -1 /* varlenarray */ ,
7748 -1 /* TEXT's typlen */ ,
7749 false /* TEXT's typbyval */ ,
7750 'i' /* TEXT's typalign */ ,
7754 val = TextDatumGetCString(d);
7756 eqsgn = strchr(val, '=');
7759 /* skip if we have permission to delete it */
7760 if (validate_option_array_item(val, NULL, true))
7763 /* else add it to the output array */
7765 newarray = array_set(newarray, 1, &index,
7768 -1 /* varlenarray */ ,
7769 -1 /* TEXT's typlen */ ,
7770 false /* TEXT's typbyval */ ,
7771 'i' /* TEXT's typalign */ );
7773 newarray = construct_array(&d, 1,
7785 * Validate a proposed option setting for GUCArrayAdd/Delete/Reset.
7787 * name is the option name. value is the proposed value for the Add case,
7788 * or NULL for the Delete/Reset cases. If skipIfNoPermissions is true, it's
7789 * not an error to have no permissions to set the option.
7791 * Returns TRUE if OK, FALSE if skipIfNoPermissions is true and user does not
7792 * have permission to change this option (all other error cases result in an
7793 * error being thrown).
7796 validate_option_array_item(const char *name, const char *value,
7797 bool skipIfNoPermissions)
7800 struct config_generic *gconf;
7803 * There are three cases to consider:
7805 * name is a known GUC variable. Check the value normally, check
7806 * permissions normally (ie, allow if variable is USERSET, or if it's
7807 * SUSET and user is superuser).
7809 * name is not known, but exists or can be created as a placeholder (i.e.,
7810 * it has a prefixed name). We allow this case if you're a superuser,
7811 * otherwise not. Superusers are assumed to know what they're doing.
7812 * We can't allow it for other users, because when the placeholder is
7813 * resolved it might turn out to be a SUSET variable;
7814 * define_custom_variable assumes we checked that.
7816 * name is not known and can't be created as a placeholder. Throw error,
7817 * unless skipIfNoPermissions is true, in which case return FALSE.
7819 gconf = find_option(name, true, WARNING);
7822 /* not known, failed to make a placeholder */
7823 if (skipIfNoPermissions)
7826 (errcode(ERRCODE_UNDEFINED_OBJECT),
7827 errmsg("unrecognized configuration parameter \"%s\"",
7831 if (gconf->flags & GUC_CUSTOM_PLACEHOLDER)
7834 * We cannot do any meaningful check on the value, so only permissions
7835 * are useful to check.
7839 if (skipIfNoPermissions)
7842 (errcode(ERRCODE_INSUFFICIENT_PRIVILEGE),
7843 errmsg("permission denied to set parameter \"%s\"", name)));
7846 /* manual permissions check so we can avoid an error being thrown */
7847 if (gconf->context == PGC_USERSET)
7849 else if (gconf->context == PGC_SUSET && superuser())
7851 else if (skipIfNoPermissions)
7853 /* if a permissions error should be thrown, let set_config_option do it */
7855 /* test for permissions and valid option value */
7856 (void) set_config_option(name, value,
7857 superuser() ? PGC_SUSET : PGC_USERSET,
7858 PGC_S_TEST, GUC_ACTION_SET, false);
7865 * Called by check_hooks that want to override the normal
7866 * ERRCODE_INVALID_PARAMETER_VALUE SQLSTATE for check hook failures.
7868 * Note that GUC_check_errmsg() etc are just macros that result in a direct
7869 * assignment to the associated variables. That is ugly, but forced by the
7870 * limitations of C's macro mechanisms.
7873 GUC_check_errcode(int sqlerrcode)
7875 GUC_check_errcode_value = sqlerrcode;
7880 * Convenience functions to manage calling a variable's check_hook.
7881 * These mostly take care of the protocol for letting check hooks supply
7882 * portions of the error report on failure.
7886 call_bool_check_hook(struct config_bool * conf, bool *newval, void **extra,
7887 GucSource source, int elevel)
7889 /* Quick success if no hook */
7890 if (!conf->check_hook)
7893 /* Reset variables that might be set by hook */
7894 GUC_check_errcode_value = ERRCODE_INVALID_PARAMETER_VALUE;
7895 GUC_check_errmsg_string = NULL;
7896 GUC_check_errdetail_string = NULL;
7897 GUC_check_errhint_string = NULL;
7899 if (!(*conf->check_hook) (newval, extra, source))
7902 (errcode(GUC_check_errcode_value),
7903 GUC_check_errmsg_string ?
7904 errmsg_internal("%s", GUC_check_errmsg_string) :
7905 errmsg("invalid value for parameter \"%s\": %d",
7906 conf->gen.name, (int) *newval),
7907 GUC_check_errdetail_string ?
7908 errdetail_internal("%s", GUC_check_errdetail_string) : 0,
7909 GUC_check_errhint_string ?
7910 errhint("%s", GUC_check_errhint_string) : 0));
7911 /* Flush any strings created in ErrorContext */
7920 call_int_check_hook(struct config_int * conf, int *newval, void **extra,
7921 GucSource source, int elevel)
7923 /* Quick success if no hook */
7924 if (!conf->check_hook)
7927 /* Reset variables that might be set by hook */
7928 GUC_check_errcode_value = ERRCODE_INVALID_PARAMETER_VALUE;
7929 GUC_check_errmsg_string = NULL;
7930 GUC_check_errdetail_string = NULL;
7931 GUC_check_errhint_string = NULL;
7933 if (!(*conf->check_hook) (newval, extra, source))
7936 (errcode(GUC_check_errcode_value),
7937 GUC_check_errmsg_string ?
7938 errmsg_internal("%s", GUC_check_errmsg_string) :
7939 errmsg("invalid value for parameter \"%s\": %d",
7940 conf->gen.name, *newval),
7941 GUC_check_errdetail_string ?
7942 errdetail_internal("%s", GUC_check_errdetail_string) : 0,
7943 GUC_check_errhint_string ?
7944 errhint("%s", GUC_check_errhint_string) : 0));
7945 /* Flush any strings created in ErrorContext */
7954 call_real_check_hook(struct config_real * conf, double *newval, void **extra,
7955 GucSource source, int elevel)
7957 /* Quick success if no hook */
7958 if (!conf->check_hook)
7961 /* Reset variables that might be set by hook */
7962 GUC_check_errcode_value = ERRCODE_INVALID_PARAMETER_VALUE;
7963 GUC_check_errmsg_string = NULL;
7964 GUC_check_errdetail_string = NULL;
7965 GUC_check_errhint_string = NULL;
7967 if (!(*conf->check_hook) (newval, extra, source))
7970 (errcode(GUC_check_errcode_value),
7971 GUC_check_errmsg_string ?
7972 errmsg_internal("%s", GUC_check_errmsg_string) :
7973 errmsg("invalid value for parameter \"%s\": %g",
7974 conf->gen.name, *newval),
7975 GUC_check_errdetail_string ?
7976 errdetail_internal("%s", GUC_check_errdetail_string) : 0,
7977 GUC_check_errhint_string ?
7978 errhint("%s", GUC_check_errhint_string) : 0));
7979 /* Flush any strings created in ErrorContext */
7988 call_string_check_hook(struct config_string * conf, char **newval, void **extra,
7989 GucSource source, int elevel)
7991 /* Quick success if no hook */
7992 if (!conf->check_hook)
7995 /* Reset variables that might be set by hook */
7996 GUC_check_errcode_value = ERRCODE_INVALID_PARAMETER_VALUE;
7997 GUC_check_errmsg_string = NULL;
7998 GUC_check_errdetail_string = NULL;
7999 GUC_check_errhint_string = NULL;
8001 if (!(*conf->check_hook) (newval, extra, source))
8004 (errcode(GUC_check_errcode_value),
8005 GUC_check_errmsg_string ?
8006 errmsg_internal("%s", GUC_check_errmsg_string) :
8007 errmsg("invalid value for parameter \"%s\": \"%s\"",
8008 conf->gen.name, *newval ? *newval : ""),
8009 GUC_check_errdetail_string ?
8010 errdetail_internal("%s", GUC_check_errdetail_string) : 0,
8011 GUC_check_errhint_string ?
8012 errhint("%s", GUC_check_errhint_string) : 0));
8013 /* Flush any strings created in ErrorContext */
8022 call_enum_check_hook(struct config_enum * conf, int *newval, void **extra,
8023 GucSource source, int elevel)
8025 /* Quick success if no hook */
8026 if (!conf->check_hook)
8029 /* Reset variables that might be set by hook */
8030 GUC_check_errcode_value = ERRCODE_INVALID_PARAMETER_VALUE;
8031 GUC_check_errmsg_string = NULL;
8032 GUC_check_errdetail_string = NULL;
8033 GUC_check_errhint_string = NULL;
8035 if (!(*conf->check_hook) (newval, extra, source))
8038 (errcode(GUC_check_errcode_value),
8039 GUC_check_errmsg_string ?
8040 errmsg_internal("%s", GUC_check_errmsg_string) :
8041 errmsg("invalid value for parameter \"%s\": \"%s\"",
8043 config_enum_lookup_by_value(conf, *newval)),
8044 GUC_check_errdetail_string ?
8045 errdetail_internal("%s", GUC_check_errdetail_string) : 0,
8046 GUC_check_errhint_string ?
8047 errhint("%s", GUC_check_errhint_string) : 0));
8048 /* Flush any strings created in ErrorContext */
8058 * check_hook, assign_hook and show_hook subroutines
8062 check_log_destination(char **newval, void **extra, GucSource source)
8070 /* Need a modifiable copy of string */
8071 rawstring = pstrdup(*newval);
8073 /* Parse string into list of identifiers */
8074 if (!SplitIdentifierString(rawstring, ',', &elemlist))
8076 /* syntax error in list */
8077 GUC_check_errdetail("List syntax is invalid.");
8079 list_free(elemlist);
8083 foreach(l, elemlist)
8085 char *tok = (char *) lfirst(l);
8087 if (pg_strcasecmp(tok, "stderr") == 0)
8088 newlogdest |= LOG_DESTINATION_STDERR;
8089 else if (pg_strcasecmp(tok, "csvlog") == 0)
8090 newlogdest |= LOG_DESTINATION_CSVLOG;
8092 else if (pg_strcasecmp(tok, "syslog") == 0)
8093 newlogdest |= LOG_DESTINATION_SYSLOG;
8096 else if (pg_strcasecmp(tok, "eventlog") == 0)
8097 newlogdest |= LOG_DESTINATION_EVENTLOG;
8101 GUC_check_errdetail("Unrecognized key word: \"%s\".", tok);
8103 list_free(elemlist);
8109 list_free(elemlist);
8111 myextra = (int *) guc_malloc(ERROR, sizeof(int));
8112 *myextra = newlogdest;
8113 *extra = (void *) myextra;
8119 assign_log_destination(const char *newval, void *extra)
8121 Log_destination = *((int *) extra);
8125 assign_syslog_facility(int newval, void *extra)
8128 set_syslog_parameters(syslog_ident_str ? syslog_ident_str : "postgres",
8131 /* Without syslog support, just ignore it */
8135 assign_syslog_ident(const char *newval, void *extra)
8138 set_syslog_parameters(newval, syslog_facility);
8140 /* Without syslog support, it will always be set to "none", so ignore */
8145 assign_session_replication_role(int newval, void *extra)
8148 * Must flush the plan cache when changing replication role; but don't
8149 * flush unnecessarily.
8151 if (SessionReplicationRole != newval)
8156 check_temp_buffers(int *newval, void **extra, GucSource source)
8159 * Once local buffers have been initialized, it's too late to change this.
8161 if (NLocBuffer && NLocBuffer != *newval)
8163 GUC_check_errdetail("\"temp_buffers\" cannot be changed after any temporary tables have been accessed in the session.");
8170 check_phony_autocommit(bool *newval, void **extra, GucSource source)
8174 GUC_check_errcode(ERRCODE_FEATURE_NOT_SUPPORTED);
8175 GUC_check_errmsg("SET AUTOCOMMIT TO OFF is no longer supported");
8182 check_debug_assertions(bool *newval, void **extra, GucSource source)
8184 #ifndef USE_ASSERT_CHECKING
8187 GUC_check_errmsg("assertion checking is not supported by this build");
8195 check_bonjour(bool *newval, void **extra, GucSource source)
8200 GUC_check_errmsg("Bonjour is not supported by this build");
8208 check_ssl(bool *newval, void **extra, GucSource source)
8213 GUC_check_errmsg("SSL is not supported by this build");
8221 check_stage_log_stats(bool *newval, void **extra, GucSource source)
8223 if (*newval && log_statement_stats)
8225 GUC_check_errdetail("Cannot enable parameter when \"log_statement_stats\" is true.");
8232 check_log_stats(bool *newval, void **extra, GucSource source)
8235 (log_parser_stats || log_planner_stats || log_executor_stats))
8237 GUC_check_errdetail("Cannot enable \"log_statement_stats\" when "
8238 "\"log_parser_stats\", \"log_planner_stats\", "
8239 "or \"log_executor_stats\" is true.");
8246 check_canonical_path(char **newval, void **extra, GucSource source)
8249 * Since canonicalize_path never enlarges the string, we can just modify
8250 * newval in-place. But watch out for NULL, which is the default value
8251 * for external_pid_file.
8254 canonicalize_path(*newval);
8259 check_timezone_abbreviations(char **newval, void **extra, GucSource source)
8262 * The boot_val given above for timezone_abbreviations is NULL. When we
8263 * see this we just do nothing. If this value isn't overridden from the
8264 * config file then pg_timezone_abbrev_initialize() will eventually
8265 * replace it with "Default". This hack has two purposes: to avoid
8266 * wasting cycles loading values that might soon be overridden from the
8267 * config file, and to avoid trying to read the timezone abbrev files
8268 * during InitializeGUCOptions(). The latter doesn't work in an
8269 * EXEC_BACKEND subprocess because my_exec_path hasn't been set yet and so
8270 * we can't locate PGSHAREDIR.
8272 if (*newval == NULL)
8274 Assert(source == PGC_S_DEFAULT);
8278 /* OK, load the file and produce a malloc'd TimeZoneAbbrevTable */
8279 *extra = load_tzoffsets(*newval);
8281 /* tzparser.c returns NULL on failure, reporting via GUC_check_errmsg */
8289 assign_timezone_abbreviations(const char *newval, void *extra)
8291 /* Do nothing for the boot_val default of NULL */
8295 InstallTimeZoneAbbrevs((TimeZoneAbbrevTable *) extra);
8299 * pg_timezone_abbrev_initialize --- set default value if not done already
8301 * This is called after initial loading of postgresql.conf. If no
8302 * timezone_abbreviations setting was found therein, select default.
8303 * If a non-default value is already installed, nothing will happen.
8305 * This can also be called from ProcessConfigFile to establish the default
8306 * value after a postgresql.conf entry for it is removed.
8309 pg_timezone_abbrev_initialize(void)
8311 SetConfigOption("timezone_abbreviations", "Default",
8312 PGC_POSTMASTER, PGC_S_DYNAMIC_DEFAULT);
8316 show_archive_command(void)
8318 if (XLogArchivingActive())
8319 return XLogArchiveCommand;
8321 return "(disabled)";
8325 assign_tcp_keepalives_idle(int newval, void *extra)
8328 * The kernel API provides no way to test a value without setting it; and
8329 * once we set it we might fail to unset it. So there seems little point
8330 * in fully implementing the check-then-assign GUC API for these
8331 * variables. Instead we just do the assignment on demand. pqcomm.c
8332 * reports any problems via elog(LOG).
8334 * This approach means that the GUC value might have little to do with the
8335 * actual kernel value, so we use a show_hook that retrieves the kernel
8336 * value rather than trusting GUC's copy.
8338 (void) pq_setkeepalivesidle(newval, MyProcPort);
8342 show_tcp_keepalives_idle(void)
8344 /* See comments in assign_tcp_keepalives_idle */
8345 static char nbuf[16];
8347 snprintf(nbuf, sizeof(nbuf), "%d", pq_getkeepalivesidle(MyProcPort));
8352 assign_tcp_keepalives_interval(int newval, void *extra)
8354 /* See comments in assign_tcp_keepalives_idle */
8355 (void) pq_setkeepalivesinterval(newval, MyProcPort);
8359 show_tcp_keepalives_interval(void)
8361 /* See comments in assign_tcp_keepalives_idle */
8362 static char nbuf[16];
8364 snprintf(nbuf, sizeof(nbuf), "%d", pq_getkeepalivesinterval(MyProcPort));
8369 assign_tcp_keepalives_count(int newval, void *extra)
8371 /* See comments in assign_tcp_keepalives_idle */
8372 (void) pq_setkeepalivescount(newval, MyProcPort);
8376 show_tcp_keepalives_count(void)
8378 /* See comments in assign_tcp_keepalives_idle */
8379 static char nbuf[16];
8381 snprintf(nbuf, sizeof(nbuf), "%d", pq_getkeepalivescount(MyProcPort));
8386 check_maxconnections(int *newval, void **extra, GucSource source)
8388 if (*newval + autovacuum_max_workers + 1 > MAX_BACKENDS)
8394 assign_maxconnections(int newval, void *extra)
8396 MaxBackends = newval + autovacuum_max_workers + 1;
8400 check_autovacuum_max_workers(int *newval, void **extra, GucSource source)
8402 if (MaxConnections + *newval + 1 > MAX_BACKENDS)
8408 assign_autovacuum_max_workers(int newval, void *extra)
8410 MaxBackends = MaxConnections + newval + 1;
8414 check_effective_io_concurrency(int *newval, void **extra, GucSource source)
8417 double new_prefetch_pages = 0.0;
8421 * The user-visible GUC parameter is the number of drives (spindles),
8422 * which we need to translate to a number-of-pages-to-prefetch target.
8423 * The target value is stashed in *extra and then assigned to the actual
8424 * variable by assign_effective_io_concurrency.
8426 * The expected number of prefetch pages needed to keep N drives busy is:
8428 * drives | I/O requests
8429 * -------+----------------
8432 * 3 | 3/1 + 3/2 + 3/3 = 5 1/2
8433 * 4 | 4/1 + 4/2 + 4/3 + 4/4 = 8 1/3
8436 * This is called the "coupon collector problem" and H(n) is called the
8437 * harmonic series. This could be approximated by n * ln(n), but for
8438 * reasonable numbers of drives we might as well just compute the series.
8440 * Alternatively we could set the target to the number of pages necessary
8441 * so that the expected number of active spindles is some arbitrary
8442 * percentage of the total. This sounds the same but is actually slightly
8443 * different. The result ends up being ln(1-P)/ln((n-1)/n) where P is
8444 * that desired fraction.
8446 * Experimental results show that both of these formulas aren't aggressive
8447 * enough, but we don't really have any better proposals.
8449 * Note that if *newval = 0 (disabled), we must set target = 0.
8453 for (i = 1; i <= *newval; i++)
8454 new_prefetch_pages += (double) *newval / (double) i;
8456 /* This range check shouldn't fail, but let's be paranoid */
8457 if (new_prefetch_pages >= 0.0 && new_prefetch_pages < (double) INT_MAX)
8459 int *myextra = (int *) guc_malloc(ERROR, sizeof(int));
8461 *myextra = (int) rint(new_prefetch_pages);
8462 *extra = (void *) myextra;
8470 #endif /* USE_PREFETCH */
8474 assign_effective_io_concurrency(int newval, void *extra)
8477 target_prefetch_pages = *((int *) extra);
8478 #endif /* USE_PREFETCH */
8482 assign_pgstat_temp_directory(const char *newval, void *extra)
8484 /* check_canonical_path already canonicalized newval for us */
8488 tname = guc_malloc(ERROR, strlen(newval) + 12); /* /pgstat.tmp */
8489 sprintf(tname, "%s/pgstat.tmp", newval);
8490 fname = guc_malloc(ERROR, strlen(newval) + 13); /* /pgstat.stat */
8491 sprintf(fname, "%s/pgstat.stat", newval);
8493 if (pgstat_stat_tmpname)
8494 free(pgstat_stat_tmpname);
8495 pgstat_stat_tmpname = tname;
8496 if (pgstat_stat_filename)
8497 free(pgstat_stat_filename);
8498 pgstat_stat_filename = fname;
8502 check_application_name(char **newval, void **extra, GucSource source)
8504 /* Only allow clean ASCII chars in the application name */
8507 for (p = *newval; *p; p++)
8509 if (*p < 32 || *p > 126)
8517 assign_application_name(const char *newval, void *extra)
8519 /* Update the pg_stat_activity view */
8520 pgstat_report_appname(newval);
8524 show_unix_socket_permissions(void)
8528 snprintf(buf, sizeof(buf), "%04o", Unix_socket_permissions);
8533 show_log_file_mode(void)
8537 snprintf(buf, sizeof(buf), "%04o", Log_file_mode);
8541 #include "guc-file.c"