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-2014, 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/libpq.h"
43 #include "libpq/pqformat.h"
44 #include "miscadmin.h"
45 #include "optimizer/cost.h"
46 #include "optimizer/geqo.h"
47 #include "optimizer/paths.h"
48 #include "optimizer/planmain.h"
49 #include "parser/parse_expr.h"
50 #include "parser/parse_type.h"
51 #include "parser/parser.h"
52 #include "parser/scansup.h"
54 #include "postmaster/autovacuum.h"
55 #include "postmaster/bgworker.h"
56 #include "postmaster/bgwriter.h"
57 #include "postmaster/postmaster.h"
58 #include "postmaster/syslogger.h"
59 #include "postmaster/walwriter.h"
60 #include "replication/slot.h"
61 #include "replication/syncrep.h"
62 #include "replication/walreceiver.h"
63 #include "replication/walsender.h"
64 #include "storage/bufmgr.h"
65 #include "storage/dsm_impl.h"
66 #include "storage/standby.h"
67 #include "storage/fd.h"
68 #include "storage/pg_shmem.h"
69 #include "storage/proc.h"
70 #include "storage/predicate.h"
71 #include "tcop/tcopprot.h"
72 #include "tsearch/ts_cache.h"
73 #include "utils/builtins.h"
74 #include "utils/bytea.h"
75 #include "utils/guc_tables.h"
76 #include "utils/memutils.h"
77 #include "utils/pg_locale.h"
78 #include "utils/plancache.h"
79 #include "utils/portal.h"
80 #include "utils/ps_status.h"
81 #include "utils/snapmgr.h"
82 #include "utils/tzparser.h"
83 #include "utils/xml.h"
86 #define PG_KRB_SRVTAB ""
89 #define PG_KRB_SRVNAM ""
92 #define CONFIG_FILENAME "postgresql.conf"
93 #define HBA_FILENAME "pg_hba.conf"
94 #define IDENT_FILENAME "pg_ident.conf"
97 #define CONFIG_EXEC_PARAMS "global/config_exec_params"
98 #define CONFIG_EXEC_PARAMS_NEW "global/config_exec_params.new"
101 /* upper limit for GUC variables measured in kilobytes of memory */
102 /* note that various places assume the byte size fits in a "long" variable */
103 #if SIZEOF_SIZE_T > 4 && SIZEOF_LONG > 4
104 #define MAX_KILOBYTES INT_MAX
106 #define MAX_KILOBYTES (INT_MAX / 1024)
109 #define KB_PER_MB (1024)
110 #define KB_PER_GB (1024*1024)
111 #define KB_PER_TB (1024*1024*1024)
113 #define MS_PER_S 1000
115 #define MS_PER_MIN (1000 * 60)
117 #define S_PER_H (60 * 60)
118 #define MS_PER_H (1000 * 60 * 60)
119 #define MIN_PER_D (60 * 24)
120 #define S_PER_D (60 * 60 * 24)
121 #define MS_PER_D (1000 * 60 * 60 * 24)
123 /* XXX these should appear in other modules' header files */
124 extern bool Log_disconnections;
125 extern int CommitDelay;
126 extern int CommitSiblings;
127 extern char *default_tablespace;
128 extern char *temp_tablespaces;
129 extern bool ignore_checksum_failure;
130 extern bool synchronize_seqscans;
131 extern char *SSLCipherSuites;
132 extern char *SSLECDHCurve;
133 extern bool SSLPreferServerCiphers;
136 extern bool trace_sort;
138 #ifdef TRACE_SYNCSCAN
139 extern bool trace_syncscan;
141 #ifdef DEBUG_BOUNDED_SORT
142 extern bool optimize_bounded_sort;
145 static int GUC_check_errcode_value;
147 /* global variables for check hook support */
148 char *GUC_check_errmsg_string;
149 char *GUC_check_errdetail_string;
150 char *GUC_check_errhint_string;
153 static void set_config_sourcefile(const char *name, char *sourcefile,
155 static bool call_bool_check_hook(struct config_bool * conf, bool *newval,
156 void **extra, GucSource source, int elevel);
157 static bool call_int_check_hook(struct config_int * conf, int *newval,
158 void **extra, GucSource source, int elevel);
159 static bool call_real_check_hook(struct config_real * conf, double *newval,
160 void **extra, GucSource source, int elevel);
161 static bool call_string_check_hook(struct config_string * conf, char **newval,
162 void **extra, GucSource source, int elevel);
163 static bool call_enum_check_hook(struct config_enum * conf, int *newval,
164 void **extra, GucSource source, int elevel);
166 static bool check_log_destination(char **newval, void **extra, GucSource source);
167 static void assign_log_destination(const char *newval, void *extra);
170 static int syslog_facility = LOG_LOCAL0;
172 static int syslog_facility = 0;
175 static void assign_syslog_facility(int newval, void *extra);
176 static void assign_syslog_ident(const char *newval, void *extra);
177 static void assign_session_replication_role(int newval, void *extra);
178 static bool check_temp_buffers(int *newval, void **extra, GucSource source);
179 static bool check_phony_autocommit(bool *newval, void **extra, GucSource source);
180 static bool check_debug_assertions(bool *newval, void **extra, GucSource source);
181 static bool check_bonjour(bool *newval, void **extra, GucSource source);
182 static bool check_ssl(bool *newval, void **extra, GucSource source);
183 static bool check_stage_log_stats(bool *newval, void **extra, GucSource source);
184 static bool check_log_stats(bool *newval, void **extra, GucSource source);
185 static bool check_canonical_path(char **newval, void **extra, GucSource source);
186 static bool check_timezone_abbreviations(char **newval, void **extra, GucSource source);
187 static void assign_timezone_abbreviations(const char *newval, void *extra);
188 static void pg_timezone_abbrev_initialize(void);
189 static const char *show_archive_command(void);
190 static void assign_tcp_keepalives_idle(int newval, void *extra);
191 static void assign_tcp_keepalives_interval(int newval, void *extra);
192 static void assign_tcp_keepalives_count(int newval, void *extra);
193 static const char *show_tcp_keepalives_idle(void);
194 static const char *show_tcp_keepalives_interval(void);
195 static const char *show_tcp_keepalives_count(void);
196 static bool check_maxconnections(int *newval, void **extra, GucSource source);
197 static bool check_max_worker_processes(int *newval, void **extra, GucSource source);
198 static bool check_autovacuum_max_workers(int *newval, void **extra, GucSource source);
199 static bool check_autovacuum_work_mem(int *newval, void **extra, GucSource source);
200 static bool check_effective_io_concurrency(int *newval, void **extra, GucSource source);
201 static void assign_effective_io_concurrency(int newval, void *extra);
202 static void assign_pgstat_temp_directory(const char *newval, void *extra);
203 static bool check_application_name(char **newval, void **extra, GucSource source);
204 static void assign_application_name(const char *newval, void *extra);
205 static const char *show_unix_socket_permissions(void);
206 static const char *show_log_file_mode(void);
208 static char *config_enum_get_options(struct config_enum * record,
209 const char *prefix, const char *suffix,
210 const char *separator);
212 static bool validate_conf_option(struct config_generic * record,
213 const char *name, const char *value, GucSource source,
214 int elevel, bool freemem, void *newval, void **newextra);
218 * Options for enum values defined in this module.
220 * NOTE! Option values may not contain double quotes!
223 static const struct config_enum_entry bytea_output_options[] = {
224 {"escape", BYTEA_OUTPUT_ESCAPE, false},
225 {"hex", BYTEA_OUTPUT_HEX, false},
230 * We have different sets for client and server message level options because
231 * they sort slightly different (see "log" level)
233 static const struct config_enum_entry client_message_level_options[] = {
234 {"debug", DEBUG2, true},
235 {"debug5", DEBUG5, false},
236 {"debug4", DEBUG4, false},
237 {"debug3", DEBUG3, false},
238 {"debug2", DEBUG2, false},
239 {"debug1", DEBUG1, false},
241 {"info", INFO, true},
242 {"notice", NOTICE, false},
243 {"warning", WARNING, false},
244 {"error", ERROR, false},
245 {"fatal", FATAL, true},
246 {"panic", PANIC, true},
250 static const struct config_enum_entry server_message_level_options[] = {
251 {"debug", DEBUG2, true},
252 {"debug5", DEBUG5, false},
253 {"debug4", DEBUG4, false},
254 {"debug3", DEBUG3, false},
255 {"debug2", DEBUG2, false},
256 {"debug1", DEBUG1, false},
257 {"info", INFO, false},
258 {"notice", NOTICE, false},
259 {"warning", WARNING, false},
260 {"error", ERROR, false},
262 {"fatal", FATAL, false},
263 {"panic", PANIC, false},
267 static const struct config_enum_entry intervalstyle_options[] = {
268 {"postgres", INTSTYLE_POSTGRES, false},
269 {"postgres_verbose", INTSTYLE_POSTGRES_VERBOSE, false},
270 {"sql_standard", INTSTYLE_SQL_STANDARD, false},
271 {"iso_8601", INTSTYLE_ISO_8601, false},
275 static const struct config_enum_entry log_error_verbosity_options[] = {
276 {"terse", PGERROR_TERSE, false},
277 {"default", PGERROR_DEFAULT, false},
278 {"verbose", PGERROR_VERBOSE, false},
282 static const struct config_enum_entry log_statement_options[] = {
283 {"none", LOGSTMT_NONE, false},
284 {"ddl", LOGSTMT_DDL, false},
285 {"mod", LOGSTMT_MOD, false},
286 {"all", LOGSTMT_ALL, false},
290 static const struct config_enum_entry isolation_level_options[] = {
291 {"serializable", XACT_SERIALIZABLE, false},
292 {"repeatable read", XACT_REPEATABLE_READ, false},
293 {"read committed", XACT_READ_COMMITTED, false},
294 {"read uncommitted", XACT_READ_UNCOMMITTED, false},
298 static const struct config_enum_entry session_replication_role_options[] = {
299 {"origin", SESSION_REPLICATION_ROLE_ORIGIN, false},
300 {"replica", SESSION_REPLICATION_ROLE_REPLICA, false},
301 {"local", SESSION_REPLICATION_ROLE_LOCAL, false},
305 static const struct config_enum_entry syslog_facility_options[] = {
307 {"local0", LOG_LOCAL0, false},
308 {"local1", LOG_LOCAL1, false},
309 {"local2", LOG_LOCAL2, false},
310 {"local3", LOG_LOCAL3, false},
311 {"local4", LOG_LOCAL4, false},
312 {"local5", LOG_LOCAL5, false},
313 {"local6", LOG_LOCAL6, false},
314 {"local7", LOG_LOCAL7, false},
321 static const struct config_enum_entry track_function_options[] = {
322 {"none", TRACK_FUNC_OFF, false},
323 {"pl", TRACK_FUNC_PL, false},
324 {"all", TRACK_FUNC_ALL, false},
328 static const struct config_enum_entry xmlbinary_options[] = {
329 {"base64", XMLBINARY_BASE64, false},
330 {"hex", XMLBINARY_HEX, false},
334 static const struct config_enum_entry xmloption_options[] = {
335 {"content", XMLOPTION_CONTENT, false},
336 {"document", XMLOPTION_DOCUMENT, false},
341 * Although only "on", "off", and "safe_encoding" are documented, we
342 * accept all the likely variants of "on" and "off".
344 static const struct config_enum_entry backslash_quote_options[] = {
345 {"safe_encoding", BACKSLASH_QUOTE_SAFE_ENCODING, false},
346 {"on", BACKSLASH_QUOTE_ON, false},
347 {"off", BACKSLASH_QUOTE_OFF, false},
348 {"true", BACKSLASH_QUOTE_ON, true},
349 {"false", BACKSLASH_QUOTE_OFF, true},
350 {"yes", BACKSLASH_QUOTE_ON, true},
351 {"no", BACKSLASH_QUOTE_OFF, true},
352 {"1", BACKSLASH_QUOTE_ON, true},
353 {"0", BACKSLASH_QUOTE_OFF, true},
358 * Although only "on", "off", and "partition" are documented, we
359 * accept all the likely variants of "on" and "off".
361 static const struct config_enum_entry constraint_exclusion_options[] = {
362 {"partition", CONSTRAINT_EXCLUSION_PARTITION, false},
363 {"on", CONSTRAINT_EXCLUSION_ON, false},
364 {"off", CONSTRAINT_EXCLUSION_OFF, false},
365 {"true", CONSTRAINT_EXCLUSION_ON, true},
366 {"false", CONSTRAINT_EXCLUSION_OFF, true},
367 {"yes", CONSTRAINT_EXCLUSION_ON, true},
368 {"no", CONSTRAINT_EXCLUSION_OFF, true},
369 {"1", CONSTRAINT_EXCLUSION_ON, true},
370 {"0", CONSTRAINT_EXCLUSION_OFF, true},
375 * Although only "on", "off", "remote_write", and "local" are documented, we
376 * accept all the likely variants of "on" and "off".
378 static const struct config_enum_entry synchronous_commit_options[] = {
379 {"local", SYNCHRONOUS_COMMIT_LOCAL_FLUSH, false},
380 {"remote_write", SYNCHRONOUS_COMMIT_REMOTE_WRITE, false},
381 {"on", SYNCHRONOUS_COMMIT_ON, false},
382 {"off", SYNCHRONOUS_COMMIT_OFF, false},
383 {"true", SYNCHRONOUS_COMMIT_ON, true},
384 {"false", SYNCHRONOUS_COMMIT_OFF, true},
385 {"yes", SYNCHRONOUS_COMMIT_ON, true},
386 {"no", SYNCHRONOUS_COMMIT_OFF, true},
387 {"1", SYNCHRONOUS_COMMIT_ON, true},
388 {"0", SYNCHRONOUS_COMMIT_OFF, true},
393 * Although only "on", "off", "try" are documented, we accept all the likely
394 * variants of "on" and "off".
396 static const struct config_enum_entry huge_tlb_options[] = {
397 {"off", HUGE_TLB_OFF, false},
398 {"on", HUGE_TLB_ON, false},
399 {"try", HUGE_TLB_TRY, false},
400 {"true", HUGE_TLB_ON, true},
401 {"false", HUGE_TLB_OFF, true},
402 {"yes", HUGE_TLB_ON, true},
403 {"no", HUGE_TLB_OFF, true},
404 {"1", HUGE_TLB_ON, true},
405 {"0", HUGE_TLB_OFF, true},
410 * Options for enum values stored in other modules
412 extern const struct config_enum_entry wal_level_options[];
413 extern const struct config_enum_entry sync_method_options[];
414 extern const struct config_enum_entry dynamic_shared_memory_options[];
417 * GUC option variables that are exported from this module
419 #ifdef USE_ASSERT_CHECKING
420 bool assert_enabled = true;
422 bool assert_enabled = false;
424 bool log_duration = false;
425 bool Debug_print_plan = false;
426 bool Debug_print_parse = false;
427 bool Debug_print_rewritten = false;
428 bool Debug_pretty_print = true;
430 bool log_parser_stats = false;
431 bool log_planner_stats = false;
432 bool log_executor_stats = false;
433 bool log_statement_stats = false; /* this is sort of all three
435 bool log_btree_build_stats = false;
438 bool check_function_bodies = true;
439 bool default_with_oids = false;
440 bool SQL_inheritance = true;
442 bool Password_encryption = true;
444 int log_min_error_statement = ERROR;
445 int log_min_messages = WARNING;
446 int client_min_messages = NOTICE;
447 int log_min_duration_statement = -1;
448 int log_temp_files = -1;
449 int trace_recovery_messages = LOG;
451 int temp_file_limit = -1;
453 int num_temp_buffers = 1024;
455 char *data_directory;
456 char *ConfigFileName;
459 char *external_pid_file;
461 char *pgstat_temp_directory;
463 char *application_name;
465 int tcp_keepalives_idle;
466 int tcp_keepalives_interval;
467 int tcp_keepalives_count;
470 * This really belongs in pg_shmem.c, but is defined here so that it doesn't
471 * need to be duplicated in all the different implementations of pg_shmem.c.
476 * These variables are all dummies that don't do anything, except in some
477 * cases provide the value for SHOW to display. The real state is elsewhere
478 * and is kept in sync by assign_hooks.
480 static char *syslog_ident_str;
481 static bool phony_autocommit;
482 static bool session_auth_is_superuser;
483 static double phony_random_seed;
484 static char *client_encoding_string;
485 static char *datestyle_string;
486 static char *locale_collate;
487 static char *locale_ctype;
488 static char *server_encoding_string;
489 static char *server_version_string;
490 static int server_version_num;
491 static char *timezone_string;
492 static char *log_timezone_string;
493 static char *timezone_abbreviations_string;
494 static char *XactIsoLevel_string;
495 static char *session_authorization_string;
496 static int max_function_args;
497 static int max_index_keys;
498 static int max_identifier_length;
499 static int block_size;
500 static int segment_size;
501 static int wal_block_size;
502 static bool data_checksums;
503 static int wal_segment_size;
504 static bool integer_datetimes;
505 static int effective_io_concurrency;
507 /* should be static, but commands/variable.c needs to get at this */
512 * Displayable names for context types (enum GucContext)
514 * Note: these strings are deliberately not localized.
516 const char *const GucContext_Names[] =
518 /* PGC_INTERNAL */ "internal",
519 /* PGC_POSTMASTER */ "postmaster",
520 /* PGC_SIGHUP */ "sighup",
521 /* PGC_BACKEND */ "backend",
522 /* PGC_SUSET */ "superuser",
523 /* PGC_USERSET */ "user"
527 * Displayable names for source types (enum GucSource)
529 * Note: these strings are deliberately not localized.
531 const char *const GucSource_Names[] =
533 /* PGC_S_DEFAULT */ "default",
534 /* PGC_S_DYNAMIC_DEFAULT */ "default",
535 /* PGC_S_ENV_VAR */ "environment variable",
536 /* PGC_S_FILE */ "configuration file",
537 /* PGC_S_ARGV */ "command line",
538 /* PGC_S_GLOBAL */ "global",
539 /* PGC_S_DATABASE */ "database",
540 /* PGC_S_USER */ "user",
541 /* PGC_S_DATABASE_USER */ "database user",
542 /* PGC_S_CLIENT */ "client",
543 /* PGC_S_OVERRIDE */ "override",
544 /* PGC_S_INTERACTIVE */ "interactive",
545 /* PGC_S_TEST */ "test",
546 /* PGC_S_SESSION */ "session"
550 * Displayable names for the groupings defined in enum config_group
552 const char *const config_group_names[] =
555 gettext_noop("Ungrouped"),
557 gettext_noop("File Locations"),
559 gettext_noop("Connections and Authentication"),
560 /* CONN_AUTH_SETTINGS */
561 gettext_noop("Connections and Authentication / Connection Settings"),
562 /* CONN_AUTH_SECURITY */
563 gettext_noop("Connections and Authentication / Security and Authentication"),
565 gettext_noop("Resource Usage"),
567 gettext_noop("Resource Usage / Memory"),
569 gettext_noop("Resource Usage / Disk"),
570 /* RESOURCES_KERNEL */
571 gettext_noop("Resource Usage / Kernel Resources"),
572 /* RESOURCES_VACUUM_DELAY */
573 gettext_noop("Resource Usage / Cost-Based Vacuum Delay"),
574 /* RESOURCES_BGWRITER */
575 gettext_noop("Resource Usage / Background Writer"),
576 /* RESOURCES_ASYNCHRONOUS */
577 gettext_noop("Resource Usage / Asynchronous Behavior"),
579 gettext_noop("Write-Ahead Log"),
581 gettext_noop("Write-Ahead Log / Settings"),
582 /* WAL_CHECKPOINTS */
583 gettext_noop("Write-Ahead Log / Checkpoints"),
585 gettext_noop("Write-Ahead Log / Archiving"),
587 gettext_noop("Replication"),
588 /* REPLICATION_SENDING */
589 gettext_noop("Replication / Sending Servers"),
590 /* REPLICATION_MASTER */
591 gettext_noop("Replication / Master Server"),
592 /* REPLICATION_STANDBY */
593 gettext_noop("Replication / Standby Servers"),
595 gettext_noop("Query Tuning"),
596 /* QUERY_TUNING_METHOD */
597 gettext_noop("Query Tuning / Planner Method Configuration"),
598 /* QUERY_TUNING_COST */
599 gettext_noop("Query Tuning / Planner Cost Constants"),
600 /* QUERY_TUNING_GEQO */
601 gettext_noop("Query Tuning / Genetic Query Optimizer"),
602 /* QUERY_TUNING_OTHER */
603 gettext_noop("Query Tuning / Other Planner Options"),
605 gettext_noop("Reporting and Logging"),
607 gettext_noop("Reporting and Logging / Where to Log"),
609 gettext_noop("Reporting and Logging / When to Log"),
611 gettext_noop("Reporting and Logging / What to Log"),
613 gettext_noop("Statistics"),
614 /* STATS_MONITORING */
615 gettext_noop("Statistics / Monitoring"),
616 /* STATS_COLLECTOR */
617 gettext_noop("Statistics / Query and Index Statistics Collector"),
619 gettext_noop("Autovacuum"),
621 gettext_noop("Client Connection Defaults"),
622 /* CLIENT_CONN_STATEMENT */
623 gettext_noop("Client Connection Defaults / Statement Behavior"),
624 /* CLIENT_CONN_LOCALE */
625 gettext_noop("Client Connection Defaults / Locale and Formatting"),
626 /* CLIENT_CONN_PRELOAD */
627 gettext_noop("Client Connection Defaults / Shared Library Preloading"),
628 /* CLIENT_CONN_OTHER */
629 gettext_noop("Client Connection Defaults / Other Defaults"),
630 /* LOCK_MANAGEMENT */
631 gettext_noop("Lock Management"),
633 gettext_noop("Version and Platform Compatibility"),
634 /* COMPAT_OPTIONS_PREVIOUS */
635 gettext_noop("Version and Platform Compatibility / Previous PostgreSQL Versions"),
636 /* COMPAT_OPTIONS_CLIENT */
637 gettext_noop("Version and Platform Compatibility / Other Platforms and Clients"),
639 gettext_noop("Error Handling"),
641 gettext_noop("Preset Options"),
643 gettext_noop("Customized Options"),
644 /* DEVELOPER_OPTIONS */
645 gettext_noop("Developer Options"),
646 /* help_config wants this array to be null-terminated */
651 * Displayable names for GUC variable types (enum config_type)
653 * Note: these strings are deliberately not localized.
655 const char *const config_type_names[] =
657 /* PGC_BOOL */ "bool",
658 /* PGC_INT */ "integer",
659 /* PGC_REAL */ "real",
660 /* PGC_STRING */ "string",
661 /* PGC_ENUM */ "enum"
666 * Contents of GUC tables
668 * See src/backend/utils/misc/README for design notes.
672 * 1. Declare a global variable of type bool, int, double, or char*
673 * and make use of it.
675 * 2. Decide at what times it's safe to set the option. See guc.h for
678 * 3. Decide on a name, a default value, upper and lower bounds (if
681 * 4. Add a record below.
683 * 5. Add it to src/backend/utils/misc/postgresql.conf.sample, if
686 * 6. Don't forget to document the option (at least in config.sgml).
688 * 7. If it's a new GUC_LIST option you must edit pg_dumpall.c to ensure
689 * it is not single quoted at dump time.
693 /******** option records follow ********/
695 static struct config_bool ConfigureNamesBool[] =
698 {"enable_seqscan", PGC_USERSET, QUERY_TUNING_METHOD,
699 gettext_noop("Enables the planner's use of sequential-scan plans."),
707 {"enable_indexscan", PGC_USERSET, QUERY_TUNING_METHOD,
708 gettext_noop("Enables the planner's use of index-scan plans."),
716 {"enable_indexonlyscan", PGC_USERSET, QUERY_TUNING_METHOD,
717 gettext_noop("Enables the planner's use of index-only-scan plans."),
720 &enable_indexonlyscan,
725 {"enable_bitmapscan", PGC_USERSET, QUERY_TUNING_METHOD,
726 gettext_noop("Enables the planner's use of bitmap-scan plans."),
734 {"enable_tidscan", PGC_USERSET, QUERY_TUNING_METHOD,
735 gettext_noop("Enables the planner's use of TID scan plans."),
743 {"enable_sort", PGC_USERSET, QUERY_TUNING_METHOD,
744 gettext_noop("Enables the planner's use of explicit sort steps."),
752 {"enable_hashagg", PGC_USERSET, QUERY_TUNING_METHOD,
753 gettext_noop("Enables the planner's use of hashed aggregation plans."),
761 {"enable_material", PGC_USERSET, QUERY_TUNING_METHOD,
762 gettext_noop("Enables the planner's use of materialization."),
770 {"enable_nestloop", PGC_USERSET, QUERY_TUNING_METHOD,
771 gettext_noop("Enables the planner's use of nested-loop join plans."),
779 {"enable_mergejoin", PGC_USERSET, QUERY_TUNING_METHOD,
780 gettext_noop("Enables the planner's use of merge join plans."),
788 {"enable_hashjoin", PGC_USERSET, QUERY_TUNING_METHOD,
789 gettext_noop("Enables the planner's use of hash join plans."),
797 {"geqo", PGC_USERSET, QUERY_TUNING_GEQO,
798 gettext_noop("Enables genetic query optimization."),
799 gettext_noop("This algorithm attempts to do planning without "
800 "exhaustive searching.")
807 /* Not for general use --- used by SET SESSION AUTHORIZATION */
808 {"is_superuser", PGC_INTERNAL, UNGROUPED,
809 gettext_noop("Shows whether the current user is a superuser."),
811 GUC_REPORT | GUC_NO_SHOW_ALL | GUC_NO_RESET_ALL | GUC_NOT_IN_SAMPLE | GUC_DISALLOW_IN_FILE
813 &session_auth_is_superuser,
818 {"bonjour", PGC_POSTMASTER, CONN_AUTH_SETTINGS,
819 gettext_noop("Enables advertising the server via Bonjour."),
824 check_bonjour, NULL, NULL
827 {"ssl", PGC_POSTMASTER, CONN_AUTH_SECURITY,
828 gettext_noop("Enables SSL connections."),
833 check_ssl, NULL, NULL
836 {"ssl_prefer_server_ciphers", PGC_POSTMASTER, CONN_AUTH_SECURITY,
837 gettext_noop("Give priority to server ciphersuite order."),
840 &SSLPreferServerCiphers,
845 {"fsync", PGC_SIGHUP, WAL_SETTINGS,
846 gettext_noop("Forces synchronization of updates to disk."),
847 gettext_noop("The server will use the fsync() system call in several places to make "
848 "sure that updates are physically written to disk. This insures "
849 "that a database cluster will recover to a consistent state after "
850 "an operating system or hardware crash.")
857 {"ignore_checksum_failure", PGC_SUSET, DEVELOPER_OPTIONS,
858 gettext_noop("Continues processing after a checksum failure."),
859 gettext_noop("Detection of a checksum failure normally causes PostgreSQL to "
860 "report an error, aborting the current transaction. Setting "
861 "ignore_checksum_failure to true causes the system to ignore the failure "
862 "(but still report a warning), and continue processing. This "
863 "behavior could cause crashes or other serious problems. Only "
864 "has an effect if checksums are enabled."),
867 &ignore_checksum_failure,
872 {"zero_damaged_pages", PGC_SUSET, DEVELOPER_OPTIONS,
873 gettext_noop("Continues processing past damaged page headers."),
874 gettext_noop("Detection of a damaged page header normally causes PostgreSQL to "
875 "report an error, aborting the current transaction. Setting "
876 "zero_damaged_pages to true causes the system to instead report a "
877 "warning, zero out the damaged page, and continue processing. This "
878 "behavior will destroy data, namely all the rows on the damaged page."),
886 {"full_page_writes", PGC_SIGHUP, WAL_SETTINGS,
887 gettext_noop("Writes full pages to WAL when first modified after a checkpoint."),
888 gettext_noop("A page write in process during an operating system crash might be "
889 "only partially written to disk. During recovery, the row changes "
890 "stored in WAL are not enough to recover. This option writes "
891 "pages when first modified after a checkpoint to WAL so full recovery "
900 {"wal_log_hints", PGC_POSTMASTER, WAL_SETTINGS,
901 gettext_noop("Writes full pages to WAL when first modified after a checkpoint, even for a non-critical modifications"),
910 {"log_checkpoints", PGC_SIGHUP, LOGGING_WHAT,
911 gettext_noop("Logs each checkpoint."),
919 {"log_connections", PGC_BACKEND, LOGGING_WHAT,
920 gettext_noop("Logs each successful connection."),
928 {"log_disconnections", PGC_BACKEND, LOGGING_WHAT,
929 gettext_noop("Logs end of a session, including duration."),
937 {"debug_assertions", PGC_USERSET, DEVELOPER_OPTIONS,
938 gettext_noop("Turns on various assertion checks."),
939 gettext_noop("This is a debugging aid."),
943 #ifdef USE_ASSERT_CHECKING
948 check_debug_assertions, NULL, NULL
952 {"exit_on_error", PGC_USERSET, ERROR_HANDLING_OPTIONS,
953 gettext_noop("Terminate session on any error."),
961 {"restart_after_crash", PGC_SIGHUP, ERROR_HANDLING_OPTIONS,
962 gettext_noop("Reinitialize server after backend crash."),
965 &restart_after_crash,
971 {"log_duration", PGC_SUSET, LOGGING_WHAT,
972 gettext_noop("Logs the duration of each completed SQL statement."),
980 {"debug_print_parse", PGC_USERSET, LOGGING_WHAT,
981 gettext_noop("Logs each query's parse tree."),
989 {"debug_print_rewritten", PGC_USERSET, LOGGING_WHAT,
990 gettext_noop("Logs each query's rewritten parse tree."),
993 &Debug_print_rewritten,
998 {"debug_print_plan", PGC_USERSET, LOGGING_WHAT,
999 gettext_noop("Logs each query's execution plan."),
1007 {"debug_pretty_print", PGC_USERSET, LOGGING_WHAT,
1008 gettext_noop("Indents parse and plan tree displays."),
1011 &Debug_pretty_print,
1016 {"log_parser_stats", PGC_SUSET, STATS_MONITORING,
1017 gettext_noop("Writes parser performance statistics to the server log."),
1022 check_stage_log_stats, NULL, NULL
1025 {"log_planner_stats", PGC_SUSET, STATS_MONITORING,
1026 gettext_noop("Writes planner performance statistics to the server log."),
1031 check_stage_log_stats, NULL, NULL
1034 {"log_executor_stats", PGC_SUSET, STATS_MONITORING,
1035 gettext_noop("Writes executor performance statistics to the server log."),
1038 &log_executor_stats,
1040 check_stage_log_stats, NULL, NULL
1043 {"log_statement_stats", PGC_SUSET, STATS_MONITORING,
1044 gettext_noop("Writes cumulative performance statistics to the server log."),
1047 &log_statement_stats,
1049 check_log_stats, NULL, NULL
1051 #ifdef BTREE_BUILD_STATS
1053 {"log_btree_build_stats", PGC_SUSET, DEVELOPER_OPTIONS,
1054 gettext_noop("Logs system resource usage statistics (memory and CPU) on various B-tree operations."),
1058 &log_btree_build_stats,
1065 {"track_activities", PGC_SUSET, STATS_COLLECTOR,
1066 gettext_noop("Collects information about executing commands."),
1067 gettext_noop("Enables the collection of information on the currently "
1068 "executing command of each session, along with "
1069 "the time at which that command began execution.")
1071 &pgstat_track_activities,
1076 {"track_counts", PGC_SUSET, STATS_COLLECTOR,
1077 gettext_noop("Collects statistics on database activity."),
1080 &pgstat_track_counts,
1085 {"track_io_timing", PGC_SUSET, STATS_COLLECTOR,
1086 gettext_noop("Collects timing statistics for database I/O activity."),
1095 {"update_process_title", PGC_SUSET, STATS_COLLECTOR,
1096 gettext_noop("Updates the process title to show the active SQL command."),
1097 gettext_noop("Enables updating of the process title every time a new SQL command is received by the server.")
1099 &update_process_title,
1105 {"autovacuum", PGC_SIGHUP, AUTOVACUUM,
1106 gettext_noop("Starts the autovacuum subprocess."),
1109 &autovacuum_start_daemon,
1115 {"trace_notify", PGC_USERSET, DEVELOPER_OPTIONS,
1116 gettext_noop("Generates debugging output for LISTEN and NOTIFY."),
1127 {"trace_locks", PGC_SUSET, DEVELOPER_OPTIONS,
1128 gettext_noop("Emits information about lock usage."),
1137 {"trace_userlocks", PGC_SUSET, DEVELOPER_OPTIONS,
1138 gettext_noop("Emits information about user lock usage."),
1147 {"trace_lwlocks", PGC_SUSET, DEVELOPER_OPTIONS,
1148 gettext_noop("Emits information about lightweight lock usage."),
1157 {"debug_deadlocks", PGC_SUSET, DEVELOPER_OPTIONS,
1158 gettext_noop("Dumps information about all current locks when a deadlock timeout occurs."),
1169 {"log_lock_waits", PGC_SUSET, LOGGING_WHAT,
1170 gettext_noop("Logs long lock waits."),
1179 {"log_hostname", PGC_SIGHUP, LOGGING_WHAT,
1180 gettext_noop("Logs the host name in the connection logs."),
1181 gettext_noop("By default, connection logs only show the IP address "
1182 "of the connecting host. If you want them to show the host name you "
1183 "can turn this on, but depending on your host name resolution "
1184 "setup it might impose a non-negligible performance penalty.")
1191 {"sql_inheritance", PGC_USERSET, COMPAT_OPTIONS_PREVIOUS,
1192 gettext_noop("Causes subtables to be included by default in various commands."),
1200 {"password_encryption", PGC_USERSET, CONN_AUTH_SECURITY,
1201 gettext_noop("Encrypt passwords."),
1202 gettext_noop("When a password is specified in CREATE USER or "
1203 "ALTER USER without writing either ENCRYPTED or UNENCRYPTED, "
1204 "this parameter determines whether the password is to be encrypted.")
1206 &Password_encryption,
1211 {"transform_null_equals", PGC_USERSET, COMPAT_OPTIONS_CLIENT,
1212 gettext_noop("Treats \"expr=NULL\" as \"expr IS NULL\"."),
1213 gettext_noop("When turned on, expressions of the form expr = NULL "
1214 "(or NULL = expr) are treated as expr IS NULL, that is, they "
1215 "return true if expr evaluates to the null value, and false "
1216 "otherwise. The correct behavior of expr = NULL is to always "
1217 "return null (unknown).")
1219 &Transform_null_equals,
1224 {"db_user_namespace", PGC_SIGHUP, CONN_AUTH_SECURITY,
1225 gettext_noop("Enables per-database user names."),
1233 /* only here for backwards compatibility */
1234 {"autocommit", PGC_USERSET, CLIENT_CONN_STATEMENT,
1235 gettext_noop("This parameter doesn't do anything."),
1236 gettext_noop("It's just here so that we won't choke on SET AUTOCOMMIT TO ON from 7.3-vintage clients."),
1237 GUC_NO_SHOW_ALL | GUC_NOT_IN_SAMPLE
1241 check_phony_autocommit, NULL, NULL
1244 {"default_transaction_read_only", PGC_USERSET, CLIENT_CONN_STATEMENT,
1245 gettext_noop("Sets the default read-only status of new transactions."),
1248 &DefaultXactReadOnly,
1253 {"transaction_read_only", PGC_USERSET, CLIENT_CONN_STATEMENT,
1254 gettext_noop("Sets the current transaction's read-only status."),
1256 GUC_NO_RESET_ALL | GUC_NOT_IN_SAMPLE | GUC_DISALLOW_IN_FILE
1260 check_transaction_read_only, NULL, NULL
1263 {"default_transaction_deferrable", PGC_USERSET, CLIENT_CONN_STATEMENT,
1264 gettext_noop("Sets the default deferrable status of new transactions."),
1267 &DefaultXactDeferrable,
1272 {"transaction_deferrable", PGC_USERSET, CLIENT_CONN_STATEMENT,
1273 gettext_noop("Whether to defer a read-only serializable transaction until it can be executed with no possible serialization failures."),
1275 GUC_NO_RESET_ALL | GUC_NOT_IN_SAMPLE | GUC_DISALLOW_IN_FILE
1279 check_transaction_deferrable, NULL, NULL
1282 {"check_function_bodies", PGC_USERSET, CLIENT_CONN_STATEMENT,
1283 gettext_noop("Check function bodies during CREATE FUNCTION."),
1286 &check_function_bodies,
1291 {"array_nulls", PGC_USERSET, COMPAT_OPTIONS_PREVIOUS,
1292 gettext_noop("Enable input of NULL elements in arrays."),
1293 gettext_noop("When turned on, unquoted NULL in an array input "
1294 "value means a null value; "
1295 "otherwise it is taken literally.")
1302 {"default_with_oids", PGC_USERSET, COMPAT_OPTIONS_PREVIOUS,
1303 gettext_noop("Create new tables with OIDs by default."),
1311 {"logging_collector", PGC_POSTMASTER, LOGGING_WHERE,
1312 gettext_noop("Start a subprocess to capture stderr output and/or csvlogs into log files."),
1320 {"log_truncate_on_rotation", PGC_SIGHUP, LOGGING_WHERE,
1321 gettext_noop("Truncate existing log files of same name during log rotation."),
1324 &Log_truncate_on_rotation,
1331 {"trace_sort", PGC_USERSET, DEVELOPER_OPTIONS,
1332 gettext_noop("Emit information about resource usage in sorting."),
1342 #ifdef TRACE_SYNCSCAN
1343 /* this is undocumented because not exposed in a standard build */
1345 {"trace_syncscan", PGC_USERSET, DEVELOPER_OPTIONS,
1346 gettext_noop("Generate debugging output for synchronized scanning."),
1356 #ifdef DEBUG_BOUNDED_SORT
1357 /* this is undocumented because not exposed in a standard build */
1360 "optimize_bounded_sort", PGC_USERSET, QUERY_TUNING_METHOD,
1361 gettext_noop("Enable bounded sorting using heap sort."),
1365 &optimize_bounded_sort,
1373 {"wal_debug", PGC_SUSET, DEVELOPER_OPTIONS,
1374 gettext_noop("Emit WAL-related debugging output."),
1385 {"integer_datetimes", PGC_INTERNAL, PRESET_OPTIONS,
1386 gettext_noop("Datetimes are integer based."),
1388 GUC_REPORT | GUC_NOT_IN_SAMPLE | GUC_DISALLOW_IN_FILE
1391 #ifdef HAVE_INT64_TIMESTAMP
1400 {"krb_caseins_users", PGC_SIGHUP, CONN_AUTH_SECURITY,
1401 gettext_noop("Sets whether Kerberos and GSSAPI user names should be treated as case-insensitive."),
1404 &pg_krb_caseins_users,
1410 {"escape_string_warning", PGC_USERSET, COMPAT_OPTIONS_PREVIOUS,
1411 gettext_noop("Warn about backslash escapes in ordinary string literals."),
1414 &escape_string_warning,
1420 {"standard_conforming_strings", PGC_USERSET, COMPAT_OPTIONS_PREVIOUS,
1421 gettext_noop("Causes '...' strings to treat backslashes literally."),
1425 &standard_conforming_strings,
1431 {"synchronize_seqscans", PGC_USERSET, COMPAT_OPTIONS_PREVIOUS,
1432 gettext_noop("Enable synchronized sequential scans."),
1435 &synchronize_seqscans,
1441 {"archive_mode", PGC_POSTMASTER, WAL_ARCHIVING,
1442 gettext_noop("Allows archiving of WAL files using archive_command."),
1451 {"hot_standby", PGC_POSTMASTER, REPLICATION_STANDBY,
1452 gettext_noop("Allows connections and queries during recovery."),
1461 {"hot_standby_feedback", PGC_SIGHUP, REPLICATION_STANDBY,
1462 gettext_noop("Allows feedback from a hot standby to the primary that will avoid query conflicts."),
1465 &hot_standby_feedback,
1471 {"allow_system_table_mods", PGC_POSTMASTER, DEVELOPER_OPTIONS,
1472 gettext_noop("Allows modifications of the structure of system tables."),
1476 &allowSystemTableMods,
1482 {"ignore_system_indexes", PGC_BACKEND, DEVELOPER_OPTIONS,
1483 gettext_noop("Disables reading from system indexes."),
1484 gettext_noop("It does not prevent updating the indexes, so it is safe "
1485 "to use. The worst consequence is slowness."),
1488 &IgnoreSystemIndexes,
1494 {"lo_compat_privileges", PGC_SUSET, COMPAT_OPTIONS_PREVIOUS,
1495 gettext_noop("Enables backward compatibility mode for privilege checks on large objects."),
1496 gettext_noop("Skips privilege checks when reading or modifying large objects, "
1497 "for compatibility with PostgreSQL releases prior to 9.0.")
1499 &lo_compat_privileges,
1505 {"quote_all_identifiers", PGC_USERSET, COMPAT_OPTIONS_PREVIOUS,
1506 gettext_noop("When generating SQL fragments, quote all identifiers."),
1509 "e_all_identifiers,
1515 {"data_checksums", PGC_INTERNAL, PRESET_OPTIONS,
1516 gettext_noop("Shows whether data checksums are turned on for this cluster"),
1518 GUC_NOT_IN_SAMPLE | GUC_DISALLOW_IN_FILE
1525 /* End-of-list marker */
1527 {NULL, 0, 0, NULL, NULL}, NULL, false, NULL, NULL, NULL
1532 static struct config_int ConfigureNamesInt[] =
1535 {"archive_timeout", PGC_SIGHUP, WAL_ARCHIVING,
1536 gettext_noop("Forces a switch to the next xlog file if a "
1537 "new file has not been started within N seconds."),
1541 &XLogArchiveTimeout,
1546 {"post_auth_delay", PGC_BACKEND, DEVELOPER_OPTIONS,
1547 gettext_noop("Waits N seconds on connection startup after authentication."),
1548 gettext_noop("This allows attaching a debugger to the process."),
1549 GUC_NOT_IN_SAMPLE | GUC_UNIT_S
1552 0, 0, INT_MAX / 1000000,
1556 {"default_statistics_target", PGC_USERSET, QUERY_TUNING_OTHER,
1557 gettext_noop("Sets the default statistics target."),
1558 gettext_noop("This applies to table columns that have not had a "
1559 "column-specific target set via ALTER TABLE SET STATISTICS.")
1561 &default_statistics_target,
1566 {"from_collapse_limit", PGC_USERSET, QUERY_TUNING_OTHER,
1567 gettext_noop("Sets the FROM-list size beyond which subqueries "
1568 "are not collapsed."),
1569 gettext_noop("The planner will merge subqueries into upper "
1570 "queries if the resulting FROM list would have no more than "
1573 &from_collapse_limit,
1578 {"join_collapse_limit", PGC_USERSET, QUERY_TUNING_OTHER,
1579 gettext_noop("Sets the FROM-list size beyond which JOIN "
1580 "constructs are not flattened."),
1581 gettext_noop("The planner will flatten explicit JOIN "
1582 "constructs into lists of FROM items whenever a "
1583 "list of no more than this many items would result.")
1585 &join_collapse_limit,
1590 {"geqo_threshold", PGC_USERSET, QUERY_TUNING_GEQO,
1591 gettext_noop("Sets the threshold of FROM items beyond which GEQO is used."),
1599 {"geqo_effort", PGC_USERSET, QUERY_TUNING_GEQO,
1600 gettext_noop("GEQO: effort is used to set the default for other GEQO parameters."),
1604 DEFAULT_GEQO_EFFORT, MIN_GEQO_EFFORT, MAX_GEQO_EFFORT,
1608 {"geqo_pool_size", PGC_USERSET, QUERY_TUNING_GEQO,
1609 gettext_noop("GEQO: number of individuals in the population."),
1610 gettext_noop("Zero selects a suitable default value.")
1617 {"geqo_generations", PGC_USERSET, QUERY_TUNING_GEQO,
1618 gettext_noop("GEQO: number of iterations of the algorithm."),
1619 gettext_noop("Zero selects a suitable default value.")
1627 /* This is PGC_SUSET to prevent hiding from log_lock_waits. */
1628 {"deadlock_timeout", PGC_SUSET, LOCK_MANAGEMENT,
1629 gettext_noop("Sets the time to wait on a lock before checking for deadlock."),
1639 {"max_standby_archive_delay", PGC_SIGHUP, REPLICATION_STANDBY,
1640 gettext_noop("Sets the maximum delay before canceling queries when a hot standby server is processing archived WAL data."),
1644 &max_standby_archive_delay,
1645 30 * 1000, -1, INT_MAX,
1650 {"max_standby_streaming_delay", PGC_SIGHUP, REPLICATION_STANDBY,
1651 gettext_noop("Sets the maximum delay before canceling queries when a hot standby server is processing streamed WAL data."),
1655 &max_standby_streaming_delay,
1656 30 * 1000, -1, INT_MAX,
1661 {"wal_receiver_status_interval", PGC_SIGHUP, REPLICATION_STANDBY,
1662 gettext_noop("Sets the maximum interval between WAL receiver status reports to the primary."),
1666 &wal_receiver_status_interval,
1667 10, 0, INT_MAX / 1000,
1672 {"wal_receiver_timeout", PGC_SIGHUP, REPLICATION_STANDBY,
1673 gettext_noop("Sets the maximum wait time to receive data from the primary."),
1677 &wal_receiver_timeout,
1678 60 * 1000, 0, INT_MAX,
1683 {"max_connections", PGC_POSTMASTER, CONN_AUTH_SETTINGS,
1684 gettext_noop("Sets the maximum number of concurrent connections."),
1688 100, 1, MAX_BACKENDS,
1689 check_maxconnections, NULL, NULL
1693 {"superuser_reserved_connections", PGC_POSTMASTER, CONN_AUTH_SETTINGS,
1694 gettext_noop("Sets the number of connection slots reserved for superusers."),
1703 * We sometimes multiply the number of shared buffers by two without
1704 * checking for overflow, so we mustn't allow more than INT_MAX / 2.
1707 {"shared_buffers", PGC_POSTMASTER, RESOURCES_MEM,
1708 gettext_noop("Sets the number of shared memory buffers used by the server."),
1713 1024, 16, INT_MAX / 2,
1718 {"temp_buffers", PGC_USERSET, RESOURCES_MEM,
1719 gettext_noop("Sets the maximum number of temporary buffers used by each session."),
1724 1024, 100, INT_MAX / 2,
1725 check_temp_buffers, NULL, NULL
1729 {"port", PGC_POSTMASTER, CONN_AUTH_SETTINGS,
1730 gettext_noop("Sets the TCP port the server listens on."),
1734 DEF_PGPORT, 1, 65535,
1739 {"unix_socket_permissions", PGC_POSTMASTER, CONN_AUTH_SETTINGS,
1740 gettext_noop("Sets the access permissions of the Unix-domain socket."),
1741 gettext_noop("Unix-domain sockets use the usual Unix file system "
1742 "permission set. The parameter value is expected "
1743 "to be a numeric mode specification in the form "
1744 "accepted by the chmod and umask system calls. "
1745 "(To use the customary octal format the number must "
1746 "start with a 0 (zero).)")
1748 &Unix_socket_permissions,
1750 NULL, NULL, show_unix_socket_permissions
1754 {"log_file_mode", PGC_SIGHUP, LOGGING_WHERE,
1755 gettext_noop("Sets the file permissions for log files."),
1756 gettext_noop("The parameter value is expected "
1757 "to be a numeric mode specification in the form "
1758 "accepted by the chmod and umask system calls. "
1759 "(To use the customary octal format the number must "
1760 "start with a 0 (zero).)")
1764 NULL, NULL, show_log_file_mode
1768 {"work_mem", PGC_USERSET, RESOURCES_MEM,
1769 gettext_noop("Sets the maximum memory to be used for query workspaces."),
1770 gettext_noop("This much memory can be used by each internal "
1771 "sort operation and hash table before switching to "
1772 "temporary disk files."),
1776 4096, 64, MAX_KILOBYTES,
1781 {"maintenance_work_mem", PGC_USERSET, RESOURCES_MEM,
1782 gettext_noop("Sets the maximum memory to be used for maintenance operations."),
1783 gettext_noop("This includes operations such as VACUUM and CREATE INDEX."),
1786 &maintenance_work_mem,
1787 65536, 1024, MAX_KILOBYTES,
1792 * We use the hopefully-safely-small value of 100kB as the compiled-in
1793 * default for max_stack_depth. InitializeGUCOptions will increase it if
1794 * possible, depending on the actual platform-specific stack limit.
1797 {"max_stack_depth", PGC_SUSET, RESOURCES_MEM,
1798 gettext_noop("Sets the maximum stack depth, in kilobytes."),
1803 100, 100, MAX_KILOBYTES,
1804 check_max_stack_depth, assign_max_stack_depth, NULL
1808 {"temp_file_limit", PGC_SUSET, RESOURCES_DISK,
1809 gettext_noop("Limits the total size of all temporary files used by each session."),
1810 gettext_noop("-1 means no limit."),
1819 {"vacuum_cost_page_hit", PGC_USERSET, RESOURCES_VACUUM_DELAY,
1820 gettext_noop("Vacuum cost for a page found in the buffer cache."),
1829 {"vacuum_cost_page_miss", PGC_USERSET, RESOURCES_VACUUM_DELAY,
1830 gettext_noop("Vacuum cost for a page not found in the buffer cache."),
1833 &VacuumCostPageMiss,
1839 {"vacuum_cost_page_dirty", PGC_USERSET, RESOURCES_VACUUM_DELAY,
1840 gettext_noop("Vacuum cost for a page dirtied by vacuum."),
1843 &VacuumCostPageDirty,
1849 {"vacuum_cost_limit", PGC_USERSET, RESOURCES_VACUUM_DELAY,
1850 gettext_noop("Vacuum cost amount available before napping."),
1859 {"vacuum_cost_delay", PGC_USERSET, RESOURCES_VACUUM_DELAY,
1860 gettext_noop("Vacuum cost delay in milliseconds."),
1870 {"autovacuum_vacuum_cost_delay", PGC_SIGHUP, AUTOVACUUM,
1871 gettext_noop("Vacuum cost delay in milliseconds, for autovacuum."),
1875 &autovacuum_vac_cost_delay,
1881 {"autovacuum_vacuum_cost_limit", PGC_SIGHUP, AUTOVACUUM,
1882 gettext_noop("Vacuum cost amount available before napping, for autovacuum."),
1885 &autovacuum_vac_cost_limit,
1891 {"max_files_per_process", PGC_POSTMASTER, RESOURCES_KERNEL,
1892 gettext_noop("Sets the maximum number of simultaneously open files for each server process."),
1895 &max_files_per_process,
1901 * See also CheckRequiredParameterValues() if this parameter changes
1904 {"max_prepared_transactions", PGC_POSTMASTER, RESOURCES_MEM,
1905 gettext_noop("Sets the maximum number of simultaneously prepared transactions."),
1908 &max_prepared_xacts,
1915 {"trace_lock_oidmin", PGC_SUSET, DEVELOPER_OPTIONS,
1916 gettext_noop("Sets the minimum OID of tables for tracking locks."),
1917 gettext_noop("Is used to avoid output on system tables."),
1921 FirstNormalObjectId, 0, INT_MAX,
1925 {"trace_lock_table", PGC_SUSET, DEVELOPER_OPTIONS,
1926 gettext_noop("Sets the OID of the table with unconditionally lock tracing."),
1937 {"statement_timeout", PGC_USERSET, CLIENT_CONN_STATEMENT,
1938 gettext_noop("Sets the maximum allowed duration of any statement."),
1939 gettext_noop("A value of 0 turns off the timeout."),
1948 {"lock_timeout", PGC_USERSET, CLIENT_CONN_STATEMENT,
1949 gettext_noop("Sets the maximum allowed duration of any wait for a lock."),
1950 gettext_noop("A value of 0 turns off the timeout."),
1959 {"vacuum_freeze_min_age", PGC_USERSET, CLIENT_CONN_STATEMENT,
1960 gettext_noop("Minimum age at which VACUUM should freeze a table row."),
1963 &vacuum_freeze_min_age,
1964 50000000, 0, 1000000000,
1969 {"vacuum_freeze_table_age", PGC_USERSET, CLIENT_CONN_STATEMENT,
1970 gettext_noop("Age at which VACUUM should scan whole table to freeze tuples."),
1973 &vacuum_freeze_table_age,
1974 150000000, 0, 2000000000,
1979 {"vacuum_multixact_freeze_min_age", PGC_USERSET, CLIENT_CONN_STATEMENT,
1980 gettext_noop("Minimum age at which VACUUM should freeze a MultiXactId in a table row."),
1983 &vacuum_multixact_freeze_min_age,
1984 5000000, 0, 1000000000,
1989 {"vacuum_multixact_freeze_table_age", PGC_USERSET, CLIENT_CONN_STATEMENT,
1990 gettext_noop("Multixact age at which VACUUM should scan whole table to freeze tuples."),
1993 &vacuum_multixact_freeze_table_age,
1994 150000000, 0, 2000000000,
1999 {"vacuum_defer_cleanup_age", PGC_SIGHUP, REPLICATION_MASTER,
2000 gettext_noop("Number of transactions by which VACUUM and HOT cleanup should be deferred, if any."),
2003 &vacuum_defer_cleanup_age,
2009 * See also CheckRequiredParameterValues() if this parameter changes
2012 {"max_locks_per_transaction", PGC_POSTMASTER, LOCK_MANAGEMENT,
2013 gettext_noop("Sets the maximum number of locks per transaction."),
2014 gettext_noop("The shared lock table is sized on the assumption that "
2015 "at most max_locks_per_transaction * max_connections distinct "
2016 "objects will need to be locked at any one time.")
2018 &max_locks_per_xact,
2024 {"max_pred_locks_per_transaction", PGC_POSTMASTER, LOCK_MANAGEMENT,
2025 gettext_noop("Sets the maximum number of predicate locks per transaction."),
2026 gettext_noop("The shared predicate lock table is sized on the assumption that "
2027 "at most max_pred_locks_per_transaction * max_connections distinct "
2028 "objects will need to be locked at any one time.")
2030 &max_predicate_locks_per_xact,
2036 {"authentication_timeout", PGC_SIGHUP, CONN_AUTH_SECURITY,
2037 gettext_noop("Sets the maximum allowed time to complete client authentication."),
2041 &AuthenticationTimeout,
2047 /* Not for general use */
2048 {"pre_auth_delay", PGC_SIGHUP, DEVELOPER_OPTIONS,
2049 gettext_noop("Waits N seconds on connection startup before authentication."),
2050 gettext_noop("This allows attaching a debugger to the process."),
2051 GUC_NOT_IN_SAMPLE | GUC_UNIT_S
2059 {"wal_keep_segments", PGC_SIGHUP, REPLICATION_SENDING,
2060 gettext_noop("Sets the number of WAL files held for standby servers."),
2069 {"checkpoint_segments", PGC_SIGHUP, WAL_CHECKPOINTS,
2070 gettext_noop("Sets the maximum distance in log segments between automatic WAL checkpoints."),
2073 &CheckPointSegments,
2079 {"checkpoint_timeout", PGC_SIGHUP, WAL_CHECKPOINTS,
2080 gettext_noop("Sets the maximum time between automatic WAL checkpoints."),
2090 {"checkpoint_warning", PGC_SIGHUP, WAL_CHECKPOINTS,
2091 gettext_noop("Enables warnings if checkpoint segments are filled more "
2092 "frequently than this."),
2093 gettext_noop("Write a message to the server log if checkpoints "
2094 "caused by the filling of checkpoint segment files happens more "
2095 "frequently than this number of seconds. Zero turns off the warning."),
2104 {"wal_buffers", PGC_POSTMASTER, WAL_SETTINGS,
2105 gettext_noop("Sets the number of disk-page buffers in shared memory for WAL."),
2111 check_wal_buffers, NULL, NULL
2115 {"wal_writer_delay", PGC_SIGHUP, WAL_SETTINGS,
2116 gettext_noop("WAL writer sleep time between WAL flushes."),
2126 {"xloginsert_slots", PGC_POSTMASTER, WAL_SETTINGS,
2127 gettext_noop("Sets the number of slots for concurrent xlog insertions."),
2131 &num_xloginsert_slots,
2137 /* see max_connections */
2138 {"max_wal_senders", PGC_POSTMASTER, REPLICATION_SENDING,
2139 gettext_noop("Sets the maximum number of simultaneously running WAL sender processes."),
2148 /* see max_connections */
2149 {"max_replication_slots", PGC_POSTMASTER, REPLICATION_SENDING,
2150 gettext_noop("Sets the maximum number of simultaneously defined replication slots."),
2153 &max_replication_slots,
2154 0, 0, MAX_BACKENDS /* XXX?*/,
2159 {"wal_sender_timeout", PGC_SIGHUP, REPLICATION_SENDING,
2160 gettext_noop("Sets the maximum time to wait for WAL replication."),
2164 &wal_sender_timeout,
2165 60 * 1000, 0, INT_MAX,
2170 {"commit_delay", PGC_SUSET, WAL_SETTINGS,
2171 gettext_noop("Sets the delay in microseconds between transaction commit and "
2172 "flushing WAL to disk."),
2174 /* we have no microseconds designation, so can't supply units here */
2182 {"commit_siblings", PGC_USERSET, WAL_SETTINGS,
2183 gettext_noop("Sets the minimum concurrent open transactions before performing "
2193 {"extra_float_digits", PGC_USERSET, CLIENT_CONN_LOCALE,
2194 gettext_noop("Sets the number of digits displayed for floating-point values."),
2195 gettext_noop("This affects real, double precision, and geometric data types. "
2196 "The parameter value is added to the standard number of digits "
2197 "(FLT_DIG or DBL_DIG as appropriate).")
2199 &extra_float_digits,
2205 {"log_min_duration_statement", PGC_SUSET, LOGGING_WHEN,
2206 gettext_noop("Sets the minimum execution time above which "
2207 "statements will be logged."),
2208 gettext_noop("Zero prints all queries. -1 turns this feature off."),
2211 &log_min_duration_statement,
2217 {"log_autovacuum_min_duration", PGC_SIGHUP, LOGGING_WHAT,
2218 gettext_noop("Sets the minimum execution time above which "
2219 "autovacuum actions will be logged."),
2220 gettext_noop("Zero prints all actions. -1 turns autovacuum logging off."),
2223 &Log_autovacuum_min_duration,
2229 {"bgwriter_delay", PGC_SIGHUP, RESOURCES_BGWRITER,
2230 gettext_noop("Background writer sleep time between rounds."),
2240 {"bgwriter_lru_maxpages", PGC_SIGHUP, RESOURCES_BGWRITER,
2241 gettext_noop("Background writer maximum number of LRU pages to flush per round."),
2244 &bgwriter_lru_maxpages,
2250 {"effective_io_concurrency",
2256 RESOURCES_ASYNCHRONOUS,
2257 gettext_noop("Number of simultaneous requests that can be handled efficiently by the disk subsystem."),
2258 gettext_noop("For RAID arrays, this should be approximately the number of drive spindles in the array.")
2260 &effective_io_concurrency,
2266 check_effective_io_concurrency, assign_effective_io_concurrency, NULL
2270 {"max_worker_processes",
2272 RESOURCES_ASYNCHRONOUS,
2273 gettext_noop("Maximum number of concurrent worker processes."),
2276 &max_worker_processes,
2278 check_max_worker_processes, NULL, NULL
2282 {"log_rotation_age", PGC_SIGHUP, LOGGING_WHERE,
2283 gettext_noop("Automatic log file rotation will occur after N minutes."),
2288 HOURS_PER_DAY * MINS_PER_HOUR, 0, INT_MAX / SECS_PER_MINUTE,
2293 {"log_rotation_size", PGC_SIGHUP, LOGGING_WHERE,
2294 gettext_noop("Automatic log file rotation will occur after N kilobytes."),
2299 10 * 1024, 0, INT_MAX / 1024,
2304 {"max_function_args", PGC_INTERNAL, PRESET_OPTIONS,
2305 gettext_noop("Shows the maximum number of function arguments."),
2307 GUC_NOT_IN_SAMPLE | GUC_DISALLOW_IN_FILE
2310 FUNC_MAX_ARGS, FUNC_MAX_ARGS, FUNC_MAX_ARGS,
2315 {"max_index_keys", PGC_INTERNAL, PRESET_OPTIONS,
2316 gettext_noop("Shows the maximum number of index keys."),
2318 GUC_NOT_IN_SAMPLE | GUC_DISALLOW_IN_FILE
2321 INDEX_MAX_KEYS, INDEX_MAX_KEYS, INDEX_MAX_KEYS,
2326 {"max_identifier_length", PGC_INTERNAL, PRESET_OPTIONS,
2327 gettext_noop("Shows the maximum identifier length."),
2329 GUC_NOT_IN_SAMPLE | GUC_DISALLOW_IN_FILE
2331 &max_identifier_length,
2332 NAMEDATALEN - 1, NAMEDATALEN - 1, NAMEDATALEN - 1,
2337 {"block_size", PGC_INTERNAL, PRESET_OPTIONS,
2338 gettext_noop("Shows the size of a disk block."),
2340 GUC_NOT_IN_SAMPLE | GUC_DISALLOW_IN_FILE
2343 BLCKSZ, BLCKSZ, BLCKSZ,
2348 {"segment_size", PGC_INTERNAL, PRESET_OPTIONS,
2349 gettext_noop("Shows the number of pages per disk file."),
2351 GUC_UNIT_BLOCKS | GUC_NOT_IN_SAMPLE | GUC_DISALLOW_IN_FILE
2354 RELSEG_SIZE, RELSEG_SIZE, RELSEG_SIZE,
2359 {"wal_block_size", PGC_INTERNAL, PRESET_OPTIONS,
2360 gettext_noop("Shows the block size in the write ahead log."),
2362 GUC_NOT_IN_SAMPLE | GUC_DISALLOW_IN_FILE
2365 XLOG_BLCKSZ, XLOG_BLCKSZ, XLOG_BLCKSZ,
2370 {"wal_segment_size", PGC_INTERNAL, PRESET_OPTIONS,
2371 gettext_noop("Shows the number of pages per write ahead log segment."),
2373 GUC_UNIT_XBLOCKS | GUC_NOT_IN_SAMPLE | GUC_DISALLOW_IN_FILE
2376 (XLOG_SEG_SIZE / XLOG_BLCKSZ),
2377 (XLOG_SEG_SIZE / XLOG_BLCKSZ),
2378 (XLOG_SEG_SIZE / XLOG_BLCKSZ),
2383 {"autovacuum_naptime", PGC_SIGHUP, AUTOVACUUM,
2384 gettext_noop("Time to sleep between autovacuum runs."),
2388 &autovacuum_naptime,
2389 60, 1, INT_MAX / 1000,
2393 {"autovacuum_vacuum_threshold", PGC_SIGHUP, AUTOVACUUM,
2394 gettext_noop("Minimum number of tuple updates or deletes prior to vacuum."),
2397 &autovacuum_vac_thresh,
2402 {"autovacuum_analyze_threshold", PGC_SIGHUP, AUTOVACUUM,
2403 gettext_noop("Minimum number of tuple inserts, updates, or deletes prior to analyze."),
2406 &autovacuum_anl_thresh,
2411 /* see varsup.c for why this is PGC_POSTMASTER not PGC_SIGHUP */
2412 {"autovacuum_freeze_max_age", PGC_POSTMASTER, AUTOVACUUM,
2413 gettext_noop("Age at which to autovacuum a table to prevent transaction ID wraparound."),
2416 &autovacuum_freeze_max_age,
2417 /* see pg_resetxlog if you change the upper-limit value */
2418 200000000, 100000000, 2000000000,
2422 /* see varsup.c for why this is PGC_POSTMASTER not PGC_SIGHUP */
2423 {"autovacuum_multixact_freeze_max_age", PGC_POSTMASTER, AUTOVACUUM,
2424 gettext_noop("Multixact age at which to autovacuum a table to prevent multixact wraparound."),
2427 &autovacuum_multixact_freeze_max_age,
2428 400000000, 10000000, 2000000000,
2432 /* see max_connections */
2433 {"autovacuum_max_workers", PGC_POSTMASTER, AUTOVACUUM,
2434 gettext_noop("Sets the maximum number of simultaneously running autovacuum worker processes."),
2437 &autovacuum_max_workers,
2439 check_autovacuum_max_workers, NULL, NULL
2443 {"autovacuum_work_mem", PGC_SIGHUP, RESOURCES_MEM,
2444 gettext_noop("Sets the maximum memory to be used by each autovacuum worker process."),
2448 &autovacuum_work_mem,
2449 -1, -1, MAX_KILOBYTES,
2450 check_autovacuum_work_mem, NULL, NULL
2454 {"tcp_keepalives_idle", PGC_USERSET, CLIENT_CONN_OTHER,
2455 gettext_noop("Time between issuing TCP keepalives."),
2456 gettext_noop("A value of 0 uses the system default."),
2459 &tcp_keepalives_idle,
2461 NULL, assign_tcp_keepalives_idle, show_tcp_keepalives_idle
2465 {"tcp_keepalives_interval", PGC_USERSET, CLIENT_CONN_OTHER,
2466 gettext_noop("Time between TCP keepalive retransmits."),
2467 gettext_noop("A value of 0 uses the system default."),
2470 &tcp_keepalives_interval,
2472 NULL, assign_tcp_keepalives_interval, show_tcp_keepalives_interval
2476 {"ssl_renegotiation_limit", PGC_USERSET, CONN_AUTH_SECURITY,
2477 gettext_noop("Set the amount of traffic to send and receive before renegotiating the encryption keys."),
2481 &ssl_renegotiation_limit,
2482 512 * 1024, 0, MAX_KILOBYTES,
2487 {"tcp_keepalives_count", PGC_USERSET, CLIENT_CONN_OTHER,
2488 gettext_noop("Maximum number of TCP keepalive retransmits."),
2489 gettext_noop("This controls the number of consecutive keepalive retransmits that can be "
2490 "lost before a connection is considered dead. A value of 0 uses the "
2493 &tcp_keepalives_count,
2495 NULL, assign_tcp_keepalives_count, show_tcp_keepalives_count
2499 {"gin_fuzzy_search_limit", PGC_USERSET, CLIENT_CONN_OTHER,
2500 gettext_noop("Sets the maximum allowed result for exact search by GIN."),
2504 &GinFuzzySearchLimit,
2510 {"effective_cache_size", PGC_USERSET, QUERY_TUNING_COST,
2511 gettext_noop("Sets the planner's assumption about the size of the disk cache."),
2512 gettext_noop("That is, the portion of the kernel's disk cache that "
2513 "will be used for PostgreSQL data files. This is measured in disk "
2514 "pages, which are normally 8 kB each."),
2517 &effective_cache_size,
2519 check_effective_cache_size, NULL, NULL
2523 /* Can't be set in postgresql.conf */
2524 {"server_version_num", PGC_INTERNAL, PRESET_OPTIONS,
2525 gettext_noop("Shows the server version as an integer."),
2527 GUC_NOT_IN_SAMPLE | GUC_DISALLOW_IN_FILE
2529 &server_version_num,
2530 PG_VERSION_NUM, PG_VERSION_NUM, PG_VERSION_NUM,
2535 {"log_temp_files", PGC_SUSET, LOGGING_WHAT,
2536 gettext_noop("Log the use of temporary files larger than this number of kilobytes."),
2537 gettext_noop("Zero logs all files. The default is -1 (turning this feature off)."),
2546 {"track_activity_query_size", PGC_POSTMASTER, RESOURCES_MEM,
2547 gettext_noop("Sets the size reserved for pg_stat_activity.query, in bytes."),
2550 &pgstat_track_activity_query_size,
2555 /* End-of-list marker */
2557 {NULL, 0, 0, NULL, NULL}, NULL, 0, 0, 0, NULL, NULL, NULL
2562 static struct config_real ConfigureNamesReal[] =
2565 {"seq_page_cost", PGC_USERSET, QUERY_TUNING_COST,
2566 gettext_noop("Sets the planner's estimate of the cost of a "
2567 "sequentially fetched disk page."),
2571 DEFAULT_SEQ_PAGE_COST, 0, DBL_MAX,
2575 {"random_page_cost", PGC_USERSET, QUERY_TUNING_COST,
2576 gettext_noop("Sets the planner's estimate of the cost of a "
2577 "nonsequentially fetched disk page."),
2581 DEFAULT_RANDOM_PAGE_COST, 0, DBL_MAX,
2585 {"cpu_tuple_cost", PGC_USERSET, QUERY_TUNING_COST,
2586 gettext_noop("Sets the planner's estimate of the cost of "
2587 "processing each tuple (row)."),
2591 DEFAULT_CPU_TUPLE_COST, 0, DBL_MAX,
2595 {"cpu_index_tuple_cost", PGC_USERSET, QUERY_TUNING_COST,
2596 gettext_noop("Sets the planner's estimate of the cost of "
2597 "processing each index entry during an index scan."),
2600 &cpu_index_tuple_cost,
2601 DEFAULT_CPU_INDEX_TUPLE_COST, 0, DBL_MAX,
2605 {"cpu_operator_cost", PGC_USERSET, QUERY_TUNING_COST,
2606 gettext_noop("Sets the planner's estimate of the cost of "
2607 "processing each operator or function call."),
2611 DEFAULT_CPU_OPERATOR_COST, 0, DBL_MAX,
2616 {"cursor_tuple_fraction", PGC_USERSET, QUERY_TUNING_OTHER,
2617 gettext_noop("Sets the planner's estimate of the fraction of "
2618 "a cursor's rows that will be retrieved."),
2621 &cursor_tuple_fraction,
2622 DEFAULT_CURSOR_TUPLE_FRACTION, 0.0, 1.0,
2627 {"geqo_selection_bias", PGC_USERSET, QUERY_TUNING_GEQO,
2628 gettext_noop("GEQO: selective pressure within the population."),
2631 &Geqo_selection_bias,
2632 DEFAULT_GEQO_SELECTION_BIAS,
2633 MIN_GEQO_SELECTION_BIAS, MAX_GEQO_SELECTION_BIAS,
2637 {"geqo_seed", PGC_USERSET, QUERY_TUNING_GEQO,
2638 gettext_noop("GEQO: seed for random path selection."),
2647 {"bgwriter_lru_multiplier", PGC_SIGHUP, RESOURCES_BGWRITER,
2648 gettext_noop("Multiple of the average buffer usage to free per round."),
2651 &bgwriter_lru_multiplier,
2657 {"seed", PGC_USERSET, UNGROUPED,
2658 gettext_noop("Sets the seed for random-number generation."),
2660 GUC_NO_SHOW_ALL | GUC_NO_RESET_ALL | GUC_NOT_IN_SAMPLE | GUC_DISALLOW_IN_FILE
2664 check_random_seed, assign_random_seed, show_random_seed
2668 {"autovacuum_vacuum_scale_factor", PGC_SIGHUP, AUTOVACUUM,
2669 gettext_noop("Number of tuple updates or deletes prior to vacuum as a fraction of reltuples."),
2672 &autovacuum_vac_scale,
2677 {"autovacuum_analyze_scale_factor", PGC_SIGHUP, AUTOVACUUM,
2678 gettext_noop("Number of tuple inserts, updates, or deletes prior to analyze as a fraction of reltuples."),
2681 &autovacuum_anl_scale,
2687 {"checkpoint_completion_target", PGC_SIGHUP, WAL_CHECKPOINTS,
2688 gettext_noop("Time spent flushing dirty buffers during checkpoint, as fraction of checkpoint interval."),
2691 &CheckPointCompletionTarget,
2696 /* End-of-list marker */
2698 {NULL, 0, 0, NULL, NULL}, NULL, 0.0, 0.0, 0.0, NULL, NULL, NULL
2703 static struct config_string ConfigureNamesString[] =
2706 {"archive_command", PGC_SIGHUP, WAL_ARCHIVING,
2707 gettext_noop("Sets the shell command that will be called to archive a WAL file."),
2710 &XLogArchiveCommand,
2712 NULL, NULL, show_archive_command
2716 {"client_encoding", PGC_USERSET, CLIENT_CONN_LOCALE,
2717 gettext_noop("Sets the client's character set encoding."),
2719 GUC_IS_NAME | GUC_REPORT
2721 &client_encoding_string,
2723 check_client_encoding, assign_client_encoding, NULL
2727 {"log_line_prefix", PGC_SIGHUP, LOGGING_WHAT,
2728 gettext_noop("Controls information prefixed to each log line."),
2729 gettext_noop("If blank, no prefix is used.")
2737 {"log_timezone", PGC_SIGHUP, LOGGING_WHAT,
2738 gettext_noop("Sets the time zone to use in log messages."),
2741 &log_timezone_string,
2743 check_log_timezone, assign_log_timezone, show_log_timezone
2747 {"DateStyle", PGC_USERSET, CLIENT_CONN_LOCALE,
2748 gettext_noop("Sets the display format for date and time values."),
2749 gettext_noop("Also controls interpretation of ambiguous "
2751 GUC_LIST_INPUT | GUC_REPORT
2755 check_datestyle, assign_datestyle, NULL
2759 {"default_tablespace", PGC_USERSET, CLIENT_CONN_STATEMENT,
2760 gettext_noop("Sets the default tablespace to create tables and indexes in."),
2761 gettext_noop("An empty string selects the database's default tablespace."),
2764 &default_tablespace,
2766 check_default_tablespace, NULL, NULL
2770 {"temp_tablespaces", PGC_USERSET, CLIENT_CONN_STATEMENT,
2771 gettext_noop("Sets the tablespace(s) to use for temporary tables and sort files."),
2773 GUC_LIST_INPUT | GUC_LIST_QUOTE
2777 check_temp_tablespaces, assign_temp_tablespaces, NULL
2781 {"dynamic_library_path", PGC_SUSET, CLIENT_CONN_OTHER,
2782 gettext_noop("Sets the path for dynamically loadable modules."),
2783 gettext_noop("If a dynamically loadable module needs to be opened and "
2784 "the specified name does not have a directory component (i.e., the "
2785 "name does not contain a slash), the system will search this path for "
2786 "the specified file."),
2789 &Dynamic_library_path,
2795 {"krb_server_keyfile", PGC_SIGHUP, CONN_AUTH_SECURITY,
2796 gettext_noop("Sets the location of the Kerberos server key file."),
2800 &pg_krb_server_keyfile,
2806 {"krb_srvname", PGC_SIGHUP, CONN_AUTH_SECURITY,
2807 gettext_noop("Sets the name of the Kerberos service."),
2816 {"bonjour_name", PGC_POSTMASTER, CONN_AUTH_SETTINGS,
2817 gettext_noop("Sets the Bonjour service name."),
2825 /* See main.c about why defaults for LC_foo are not all alike */
2828 {"lc_collate", PGC_INTERNAL, CLIENT_CONN_LOCALE,
2829 gettext_noop("Shows the collation order locale."),
2831 GUC_NOT_IN_SAMPLE | GUC_DISALLOW_IN_FILE
2839 {"lc_ctype", PGC_INTERNAL, CLIENT_CONN_LOCALE,
2840 gettext_noop("Shows the character classification and case conversion locale."),
2842 GUC_NOT_IN_SAMPLE | GUC_DISALLOW_IN_FILE
2850 {"lc_messages", PGC_SUSET, CLIENT_CONN_LOCALE,
2851 gettext_noop("Sets the language in which messages are displayed."),
2856 check_locale_messages, assign_locale_messages, NULL
2860 {"lc_monetary", PGC_USERSET, CLIENT_CONN_LOCALE,
2861 gettext_noop("Sets the locale for formatting monetary amounts."),
2866 check_locale_monetary, assign_locale_monetary, NULL
2870 {"lc_numeric", PGC_USERSET, CLIENT_CONN_LOCALE,
2871 gettext_noop("Sets the locale for formatting numbers."),
2876 check_locale_numeric, assign_locale_numeric, NULL
2880 {"lc_time", PGC_USERSET, CLIENT_CONN_LOCALE,
2881 gettext_noop("Sets the locale for formatting date and time values."),
2886 check_locale_time, assign_locale_time, NULL
2890 {"session_preload_libraries", PGC_SUSET, CLIENT_CONN_PRELOAD,
2891 gettext_noop("Lists shared libraries to preload into each backend."),
2893 GUC_LIST_INPUT | GUC_LIST_QUOTE | GUC_SUPERUSER_ONLY
2895 &session_preload_libraries_string,
2901 {"shared_preload_libraries", PGC_POSTMASTER, CLIENT_CONN_PRELOAD,
2902 gettext_noop("Lists shared libraries to preload into server."),
2904 GUC_LIST_INPUT | GUC_LIST_QUOTE | GUC_SUPERUSER_ONLY
2906 &shared_preload_libraries_string,
2912 {"local_preload_libraries", PGC_BACKEND, CLIENT_CONN_PRELOAD,
2913 gettext_noop("Lists unprivileged shared libraries to preload into each backend."),
2915 GUC_LIST_INPUT | GUC_LIST_QUOTE
2917 &local_preload_libraries_string,
2923 {"search_path", PGC_USERSET, CLIENT_CONN_STATEMENT,
2924 gettext_noop("Sets the schema search order for names that are not schema-qualified."),
2926 GUC_LIST_INPUT | GUC_LIST_QUOTE
2928 &namespace_search_path,
2930 check_search_path, assign_search_path, NULL
2934 /* Can't be set in postgresql.conf */
2935 {"server_encoding", PGC_INTERNAL, CLIENT_CONN_LOCALE,
2936 gettext_noop("Sets the server (database) character set encoding."),
2938 GUC_IS_NAME | GUC_REPORT | GUC_NOT_IN_SAMPLE | GUC_DISALLOW_IN_FILE
2940 &server_encoding_string,
2946 /* Can't be set in postgresql.conf */
2947 {"server_version", PGC_INTERNAL, PRESET_OPTIONS,
2948 gettext_noop("Shows the server version."),
2950 GUC_REPORT | GUC_NOT_IN_SAMPLE | GUC_DISALLOW_IN_FILE
2952 &server_version_string,
2958 /* Not for general use --- used by SET ROLE */
2959 {"role", PGC_USERSET, UNGROUPED,
2960 gettext_noop("Sets the current role."),
2962 GUC_IS_NAME | GUC_NO_SHOW_ALL | GUC_NO_RESET_ALL | GUC_NOT_IN_SAMPLE | GUC_DISALLOW_IN_FILE | GUC_NOT_WHILE_SEC_REST
2966 check_role, assign_role, show_role
2970 /* Not for general use --- used by SET SESSION AUTHORIZATION */
2971 {"session_authorization", PGC_USERSET, UNGROUPED,
2972 gettext_noop("Sets the session user name."),
2974 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
2976 &session_authorization_string,
2978 check_session_authorization, assign_session_authorization, NULL
2982 {"log_destination", PGC_SIGHUP, LOGGING_WHERE,
2983 gettext_noop("Sets the destination for server log output."),
2984 gettext_noop("Valid values are combinations of \"stderr\", "
2985 "\"syslog\", \"csvlog\", and \"eventlog\", "
2986 "depending on the platform."),
2989 &Log_destination_string,
2991 check_log_destination, assign_log_destination, NULL
2994 {"log_directory", PGC_SIGHUP, LOGGING_WHERE,
2995 gettext_noop("Sets the destination directory for log files."),
2996 gettext_noop("Can be specified as relative to the data directory "
2997 "or as absolute path."),
3002 check_canonical_path, NULL, NULL
3005 {"log_filename", PGC_SIGHUP, LOGGING_WHERE,
3006 gettext_noop("Sets the file name pattern for log files."),
3011 "postgresql-%Y-%m-%d_%H%M%S.log",
3016 {"syslog_ident", PGC_SIGHUP, LOGGING_WHERE,
3017 gettext_noop("Sets the program name used to identify PostgreSQL "
3018 "messages in syslog."),
3023 NULL, assign_syslog_ident, NULL
3027 {"event_source", PGC_POSTMASTER, LOGGING_WHERE,
3028 gettext_noop("Sets the application name used to identify "
3029 "PostgreSQL messages in the event log."),
3038 {"TimeZone", PGC_USERSET, CLIENT_CONN_LOCALE,
3039 gettext_noop("Sets the time zone for displaying and interpreting time stamps."),
3045 check_timezone, assign_timezone, show_timezone
3048 {"timezone_abbreviations", PGC_USERSET, CLIENT_CONN_LOCALE,
3049 gettext_noop("Selects a file of time zone abbreviations."),
3052 &timezone_abbreviations_string,
3054 check_timezone_abbreviations, assign_timezone_abbreviations, NULL
3058 {"transaction_isolation", PGC_USERSET, CLIENT_CONN_STATEMENT,
3059 gettext_noop("Sets the current transaction's isolation level."),
3061 GUC_NO_RESET_ALL | GUC_NOT_IN_SAMPLE | GUC_DISALLOW_IN_FILE
3063 &XactIsoLevel_string,
3065 check_XactIsoLevel, assign_XactIsoLevel, show_XactIsoLevel
3069 {"unix_socket_group", PGC_POSTMASTER, CONN_AUTH_SETTINGS,
3070 gettext_noop("Sets the owning group of the Unix-domain socket."),
3071 gettext_noop("The owning user of the socket is always the user "
3072 "that starts the server.")
3080 {"unix_socket_directories", PGC_POSTMASTER, CONN_AUTH_SETTINGS,
3081 gettext_noop("Sets the directories where Unix-domain sockets will be created."),
3085 &Unix_socket_directories,
3086 #ifdef HAVE_UNIX_SOCKETS
3087 DEFAULT_PGSOCKET_DIR,
3095 {"listen_addresses", PGC_POSTMASTER, CONN_AUTH_SETTINGS,
3096 gettext_noop("Sets the host name or IP address(es) to listen to."),
3106 {"data_directory", PGC_POSTMASTER, FILE_LOCATIONS,
3107 gettext_noop("Sets the server's data directory."),
3117 {"config_file", PGC_POSTMASTER, FILE_LOCATIONS,
3118 gettext_noop("Sets the server's main configuration file."),
3120 GUC_DISALLOW_IN_FILE | GUC_SUPERUSER_ONLY
3128 {"hba_file", PGC_POSTMASTER, FILE_LOCATIONS,
3129 gettext_noop("Sets the server's \"hba\" configuration file."),
3139 {"ident_file", PGC_POSTMASTER, FILE_LOCATIONS,
3140 gettext_noop("Sets the server's \"ident\" configuration file."),
3150 {"external_pid_file", PGC_POSTMASTER, FILE_LOCATIONS,
3151 gettext_noop("Writes the postmaster PID to the specified file."),
3157 check_canonical_path, NULL, NULL
3161 {"ssl_cert_file", PGC_POSTMASTER, CONN_AUTH_SECURITY,
3162 gettext_noop("Location of the SSL server certificate file."),
3171 {"ssl_key_file", PGC_POSTMASTER, CONN_AUTH_SECURITY,
3172 gettext_noop("Location of the SSL server private key file."),
3181 {"ssl_ca_file", PGC_POSTMASTER, CONN_AUTH_SECURITY,
3182 gettext_noop("Location of the SSL certificate authority file."),
3191 {"ssl_crl_file", PGC_POSTMASTER, CONN_AUTH_SECURITY,
3192 gettext_noop("Location of the SSL certificate revocation list file."),
3201 {"stats_temp_directory", PGC_SIGHUP, STATS_COLLECTOR,
3202 gettext_noop("Writes temporary statistics files to the specified directory."),
3206 &pgstat_temp_directory,
3208 check_canonical_path, assign_pgstat_temp_directory, NULL
3212 {"synchronous_standby_names", PGC_SIGHUP, REPLICATION_MASTER,
3213 gettext_noop("List of names of potential synchronous standbys."),
3217 &SyncRepStandbyNames,
3219 check_synchronous_standby_names, NULL, NULL
3223 {"default_text_search_config", PGC_USERSET, CLIENT_CONN_LOCALE,
3224 gettext_noop("Sets default text search configuration."),
3228 "pg_catalog.simple",
3229 check_TSCurrentConfig, assign_TSCurrentConfig, NULL
3233 {"ssl_ciphers", PGC_POSTMASTER, CONN_AUTH_SECURITY,
3234 gettext_noop("Sets the list of allowed SSL ciphers."),
3240 "HIGH:MEDIUM:+3DES:!aNULL",
3248 {"ssl_ecdh_curve", PGC_POSTMASTER, CONN_AUTH_SECURITY,
3249 gettext_noop("Sets the curve to use for ECDH."),
3263 {"application_name", PGC_USERSET, LOGGING_WHAT,
3264 gettext_noop("Sets the application name to be reported in statistics and logs."),
3266 GUC_IS_NAME | GUC_REPORT | GUC_NOT_IN_SAMPLE
3270 check_application_name, assign_application_name, NULL
3273 /* End-of-list marker */
3275 {NULL, 0, 0, NULL, NULL}, NULL, NULL, NULL, NULL, NULL
3280 static struct config_enum ConfigureNamesEnum[] =
3283 {"backslash_quote", PGC_USERSET, COMPAT_OPTIONS_PREVIOUS,
3284 gettext_noop("Sets whether \"\\'\" is allowed in string literals."),
3288 BACKSLASH_QUOTE_SAFE_ENCODING, backslash_quote_options,
3293 {"bytea_output", PGC_USERSET, CLIENT_CONN_STATEMENT,
3294 gettext_noop("Sets the output format for bytea."),
3298 BYTEA_OUTPUT_HEX, bytea_output_options,
3303 {"client_min_messages", PGC_USERSET, LOGGING_WHEN,
3304 gettext_noop("Sets the message levels that are sent to the client."),
3305 gettext_noop("Each level includes all the levels that follow it. The later"
3306 " the level, the fewer messages are sent.")
3308 &client_min_messages,
3309 NOTICE, client_message_level_options,
3314 {"constraint_exclusion", PGC_USERSET, QUERY_TUNING_OTHER,
3315 gettext_noop("Enables the planner to use constraints to optimize queries."),
3316 gettext_noop("Table scans will be skipped if their constraints"
3317 " guarantee that no rows match the query.")
3319 &constraint_exclusion,
3320 CONSTRAINT_EXCLUSION_PARTITION, constraint_exclusion_options,
3325 {"default_transaction_isolation", PGC_USERSET, CLIENT_CONN_STATEMENT,
3326 gettext_noop("Sets the transaction isolation level of each new transaction."),
3329 &DefaultXactIsoLevel,
3330 XACT_READ_COMMITTED, isolation_level_options,
3335 {"IntervalStyle", PGC_USERSET, CLIENT_CONN_LOCALE,
3336 gettext_noop("Sets the display format for interval values."),
3341 INTSTYLE_POSTGRES, intervalstyle_options,
3346 {"log_error_verbosity", PGC_SUSET, LOGGING_WHAT,
3347 gettext_noop("Sets the verbosity of logged messages."),
3350 &Log_error_verbosity,
3351 PGERROR_DEFAULT, log_error_verbosity_options,
3356 {"log_min_messages", PGC_SUSET, LOGGING_WHEN,
3357 gettext_noop("Sets the message levels that are logged."),
3358 gettext_noop("Each level includes all the levels that follow it. The later"
3359 " the level, the fewer messages are sent.")
3362 WARNING, server_message_level_options,
3367 {"log_min_error_statement", PGC_SUSET, LOGGING_WHEN,
3368 gettext_noop("Causes all statements generating error at or above this level to be logged."),
3369 gettext_noop("Each level includes all the levels that follow it. The later"
3370 " the level, the fewer messages are sent.")
3372 &log_min_error_statement,
3373 ERROR, server_message_level_options,
3378 {"log_statement", PGC_SUSET, LOGGING_WHAT,
3379 gettext_noop("Sets the type of statements logged."),
3383 LOGSTMT_NONE, log_statement_options,
3388 {"syslog_facility", PGC_SIGHUP, LOGGING_WHERE,
3389 gettext_noop("Sets the syslog \"facility\" to be used when syslog enabled."),
3398 syslog_facility_options,
3399 NULL, assign_syslog_facility, NULL
3403 {"session_replication_role", PGC_SUSET, CLIENT_CONN_STATEMENT,
3404 gettext_noop("Sets the session's behavior for triggers and rewrite rules."),
3407 &SessionReplicationRole,
3408 SESSION_REPLICATION_ROLE_ORIGIN, session_replication_role_options,
3409 NULL, assign_session_replication_role, NULL
3413 {"synchronous_commit", PGC_USERSET, WAL_SETTINGS,
3414 gettext_noop("Sets the current transaction's synchronization level."),
3417 &synchronous_commit,
3418 SYNCHRONOUS_COMMIT_ON, synchronous_commit_options,
3419 NULL, assign_synchronous_commit, NULL
3423 {"trace_recovery_messages", PGC_SIGHUP, DEVELOPER_OPTIONS,
3424 gettext_noop("Enables logging of recovery-related debugging information."),
3425 gettext_noop("Each level includes all the levels that follow it. The later"
3426 " the level, the fewer messages are sent.")
3428 &trace_recovery_messages,
3431 * client_message_level_options allows too many values, really, but
3432 * it's not worth having a separate options array for this.
3434 LOG, client_message_level_options,
3439 {"track_functions", PGC_SUSET, STATS_COLLECTOR,
3440 gettext_noop("Collects function-level statistics on database activity."),
3443 &pgstat_track_functions,
3444 TRACK_FUNC_OFF, track_function_options,
3449 {"wal_level", PGC_POSTMASTER, WAL_SETTINGS,
3450 gettext_noop("Set the level of information written to the WAL."),
3454 WAL_LEVEL_MINIMAL, wal_level_options,
3459 {"dynamic_shared_memory_type", PGC_POSTMASTER, RESOURCES_MEM,
3460 gettext_noop("Selects the dynamic shared memory implementation used."),
3463 &dynamic_shared_memory_type,
3464 DEFAULT_DYNAMIC_SHARED_MEMORY_TYPE, dynamic_shared_memory_options,
3469 {"wal_sync_method", PGC_SIGHUP, WAL_SETTINGS,
3470 gettext_noop("Selects the method used for forcing WAL updates to disk."),
3474 DEFAULT_SYNC_METHOD, sync_method_options,
3475 NULL, assign_xlog_sync_method, NULL
3479 {"xmlbinary", PGC_USERSET, CLIENT_CONN_STATEMENT,
3480 gettext_noop("Sets how binary values are to be encoded in XML."),
3484 XMLBINARY_BASE64, xmlbinary_options,
3489 {"xmloption", PGC_USERSET, CLIENT_CONN_STATEMENT,
3490 gettext_noop("Sets whether XML data in implicit parsing and serialization "
3491 "operations is to be considered as documents or content fragments."),
3495 XMLOPTION_CONTENT, xmloption_options,
3500 {"huge_tlb_pages", PGC_POSTMASTER, RESOURCES_MEM,
3501 gettext_noop("Use of huge TLB pages on Linux"),
3505 HUGE_TLB_TRY, huge_tlb_options,
3509 /* End-of-list marker */
3511 {NULL, 0, 0, NULL, NULL}, NULL, 0, NULL, NULL, NULL, NULL
3515 /******** end of options list ********/
3519 * To allow continued support of obsolete names for GUC variables, we apply
3520 * the following mappings to any unrecognized name. Note that an old name
3521 * should be mapped to a new one only if the new variable has very similar
3522 * semantics to the old.
3524 static const char *const map_old_guc_names[] = {
3525 "sort_mem", "work_mem",
3526 "vacuum_mem", "maintenance_work_mem",
3532 * Actual lookup of variables is done through this single, sorted array.
3534 static struct config_generic **guc_variables;
3536 /* Current number of variables contained in the vector */
3537 static int num_guc_variables;
3539 /* Vector capacity */
3540 static int size_guc_variables;
3543 static bool guc_dirty; /* TRUE if need to do commit/abort work */
3545 static bool reporting_enabled; /* TRUE to enable GUC_REPORT */
3547 static int GUCNestLevel = 0; /* 1 when in main transaction */
3550 static int guc_var_compare(const void *a, const void *b);
3551 static int guc_name_compare(const char *namea, const char *nameb);
3552 static void InitializeGUCOptionsFromEnvironment(void);
3553 static void InitializeOneGUCOption(struct config_generic * gconf);
3554 static void push_old_value(struct config_generic * gconf, GucAction action);
3555 static void ReportGUCOption(struct config_generic * record);
3556 static void reapply_stacked_values(struct config_generic * variable,
3557 struct config_string * pHolder,
3559 const char *curvalue,
3560 GucContext curscontext, GucSource cursource);
3561 static void ShowGUCConfigOption(const char *name, DestReceiver *dest);
3562 static void ShowAllGUCConfig(DestReceiver *dest);
3563 static char *_ShowOption(struct config_generic * record, bool use_units);
3564 static bool validate_option_array_item(const char *name, const char *value,
3565 bool skipIfNoPermissions);
3566 static void write_auto_conf_file(int fd, const char *filename, ConfigVariable **head_p);
3567 static void replace_auto_config_value(ConfigVariable **head_p, ConfigVariable **tail_p,
3568 char *config_file, char *name, char *value);
3572 * Some infrastructure for checking malloc/strdup/realloc calls
3575 guc_malloc(int elevel, size_t size)
3579 /* Avoid unportable behavior of malloc(0) */
3582 data = malloc(size);
3585 (errcode(ERRCODE_OUT_OF_MEMORY),
3586 errmsg("out of memory")));
3591 guc_realloc(int elevel, void *old, size_t size)
3595 /* Avoid unportable behavior of realloc(NULL, 0) */
3596 if (old == NULL && size == 0)
3598 data = realloc(old, size);
3601 (errcode(ERRCODE_OUT_OF_MEMORY),
3602 errmsg("out of memory")));
3607 guc_strdup(int elevel, const char *src)
3614 (errcode(ERRCODE_OUT_OF_MEMORY),
3615 errmsg("out of memory")));
3621 * Detect whether strval is referenced anywhere in a GUC string item
3624 string_field_used(struct config_string * conf, char *strval)
3628 if (strval == *(conf->variable) ||
3629 strval == conf->reset_val ||
3630 strval == conf->boot_val)
3632 for (stack = conf->gen.stack; stack; stack = stack->prev)
3634 if (strval == stack->prior.val.stringval ||
3635 strval == stack->masked.val.stringval)
3642 * Support for assigning to a field of a string GUC item. Free the prior
3643 * value if it's not referenced anywhere else in the item (including stacked
3647 set_string_field(struct config_string * conf, char **field, char *newval)
3649 char *oldval = *field;
3651 /* Do the assignment */
3654 /* Free old value if it's not NULL and isn't referenced anymore */
3655 if (oldval && !string_field_used(conf, oldval))
3660 * Detect whether an "extra" struct is referenced anywhere in a GUC item
3663 extra_field_used(struct config_generic * gconf, void *extra)
3667 if (extra == gconf->extra)
3669 switch (gconf->vartype)
3672 if (extra == ((struct config_bool *) gconf)->reset_extra)
3676 if (extra == ((struct config_int *) gconf)->reset_extra)
3680 if (extra == ((struct config_real *) gconf)->reset_extra)
3684 if (extra == ((struct config_string *) gconf)->reset_extra)
3688 if (extra == ((struct config_enum *) gconf)->reset_extra)
3692 for (stack = gconf->stack; stack; stack = stack->prev)
3694 if (extra == stack->prior.extra ||
3695 extra == stack->masked.extra)
3703 * Support for assigning to an "extra" field of a GUC item. Free the prior
3704 * value if it's not referenced anywhere else in the item (including stacked
3708 set_extra_field(struct config_generic * gconf, void **field, void *newval)
3710 void *oldval = *field;
3712 /* Do the assignment */
3715 /* Free old value if it's not NULL and isn't referenced anymore */
3716 if (oldval && !extra_field_used(gconf, oldval))
3721 * Support for copying a variable's active value into a stack entry.
3722 * The "extra" field associated with the active value is copied, too.
3724 * NB: be sure stringval and extra fields of a new stack entry are
3725 * initialized to NULL before this is used, else we'll try to free() them.
3728 set_stack_value(struct config_generic * gconf, config_var_value *val)
3730 switch (gconf->vartype)
3734 *((struct config_bool *) gconf)->variable;
3738 *((struct config_int *) gconf)->variable;
3742 *((struct config_real *) gconf)->variable;
3745 set_string_field((struct config_string *) gconf,
3746 &(val->val.stringval),
3747 *((struct config_string *) gconf)->variable);
3751 *((struct config_enum *) gconf)->variable;
3754 set_extra_field(gconf, &(val->extra), gconf->extra);
3758 * Support for discarding a no-longer-needed value in a stack entry.
3759 * The "extra" field associated with the stack entry is cleared, too.
3762 discard_stack_value(struct config_generic * gconf, config_var_value *val)
3764 switch (gconf->vartype)
3770 /* no need to do anything */
3773 set_string_field((struct config_string *) gconf,
3774 &(val->val.stringval),
3778 set_extra_field(gconf, &(val->extra), NULL);
3783 * Fetch the sorted array pointer (exported for help_config.c's use ONLY)
3785 struct config_generic **
3786 get_guc_variables(void)
3788 return guc_variables;
3793 * Build the sorted array. This is split out so that it could be
3794 * re-executed after startup (eg, we could allow loadable modules to
3795 * add vars, and then we'd need to re-sort).
3798 build_guc_variables(void)
3802 struct config_generic **guc_vars;
3805 for (i = 0; ConfigureNamesBool[i].gen.name; i++)
3807 struct config_bool *conf = &ConfigureNamesBool[i];
3809 /* Rather than requiring vartype to be filled in by hand, do this: */
3810 conf->gen.vartype = PGC_BOOL;
3814 for (i = 0; ConfigureNamesInt[i].gen.name; i++)
3816 struct config_int *conf = &ConfigureNamesInt[i];
3818 conf->gen.vartype = PGC_INT;
3822 for (i = 0; ConfigureNamesReal[i].gen.name; i++)
3824 struct config_real *conf = &ConfigureNamesReal[i];
3826 conf->gen.vartype = PGC_REAL;
3830 for (i = 0; ConfigureNamesString[i].gen.name; i++)
3832 struct config_string *conf = &ConfigureNamesString[i];
3834 conf->gen.vartype = PGC_STRING;
3838 for (i = 0; ConfigureNamesEnum[i].gen.name; i++)
3840 struct config_enum *conf = &ConfigureNamesEnum[i];
3842 conf->gen.vartype = PGC_ENUM;
3847 * Create table with 20% slack
3849 size_vars = num_vars + num_vars / 4;
3851 guc_vars = (struct config_generic **)
3852 guc_malloc(FATAL, size_vars * sizeof(struct config_generic *));
3856 for (i = 0; ConfigureNamesBool[i].gen.name; i++)
3857 guc_vars[num_vars++] = &ConfigureNamesBool[i].gen;
3859 for (i = 0; ConfigureNamesInt[i].gen.name; i++)
3860 guc_vars[num_vars++] = &ConfigureNamesInt[i].gen;
3862 for (i = 0; ConfigureNamesReal[i].gen.name; i++)
3863 guc_vars[num_vars++] = &ConfigureNamesReal[i].gen;
3865 for (i = 0; ConfigureNamesString[i].gen.name; i++)
3866 guc_vars[num_vars++] = &ConfigureNamesString[i].gen;
3868 for (i = 0; ConfigureNamesEnum[i].gen.name; i++)
3869 guc_vars[num_vars++] = &ConfigureNamesEnum[i].gen;
3872 free(guc_variables);
3873 guc_variables = guc_vars;
3874 num_guc_variables = num_vars;
3875 size_guc_variables = size_vars;
3876 qsort((void *) guc_variables, num_guc_variables,
3877 sizeof(struct config_generic *), guc_var_compare);
3881 * Add a new GUC variable to the list of known variables. The
3882 * list is expanded if needed.
3885 add_guc_variable(struct config_generic * var, int elevel)
3887 if (num_guc_variables + 1 >= size_guc_variables)
3890 * Increase the vector by 25%
3892 int size_vars = size_guc_variables + size_guc_variables / 4;
3893 struct config_generic **guc_vars;
3898 guc_vars = (struct config_generic **)
3899 guc_malloc(elevel, size_vars * sizeof(struct config_generic *));
3903 guc_vars = (struct config_generic **)
3904 guc_realloc(elevel, guc_variables, size_vars * sizeof(struct config_generic *));
3907 if (guc_vars == NULL)
3908 return false; /* out of memory */
3910 guc_variables = guc_vars;
3911 size_guc_variables = size_vars;
3913 guc_variables[num_guc_variables++] = var;
3914 qsort((void *) guc_variables, num_guc_variables,
3915 sizeof(struct config_generic *), guc_var_compare);
3920 * Create and add a placeholder variable for a custom variable name.
3922 static struct config_generic *
3923 add_placeholder_variable(const char *name, int elevel)
3925 size_t sz = sizeof(struct config_string) + sizeof(char *);
3926 struct config_string *var;
3927 struct config_generic *gen;
3929 var = (struct config_string *) guc_malloc(elevel, sz);
3935 gen->name = guc_strdup(elevel, name);
3936 if (gen->name == NULL)
3942 gen->context = PGC_USERSET;
3943 gen->group = CUSTOM_OPTIONS;
3944 gen->short_desc = "GUC placeholder variable";
3945 gen->flags = GUC_NO_SHOW_ALL | GUC_NOT_IN_SAMPLE | GUC_CUSTOM_PLACEHOLDER;
3946 gen->vartype = PGC_STRING;
3949 * The char* is allocated at the end of the struct since we have no
3950 * 'static' place to point to. Note that the current value, as well as
3951 * the boot and reset values, start out NULL.
3953 var->variable = (char **) (var + 1);
3955 if (!add_guc_variable((struct config_generic *) var, elevel))
3957 free((void *) gen->name);
3966 * Look up option NAME. If it exists, return a pointer to its record,
3967 * else return NULL. If create_placeholders is TRUE, we'll create a
3968 * placeholder record for a valid-looking custom variable name.
3970 static struct config_generic *
3971 find_option(const char *name, bool create_placeholders, int elevel)
3973 const char **key = &name;
3974 struct config_generic **res;
3980 * By equating const char ** with struct config_generic *, we are assuming
3981 * the name field is first in config_generic.
3983 res = (struct config_generic **) bsearch((void *) &key,
3984 (void *) guc_variables,
3986 sizeof(struct config_generic *),
3992 * See if the name is an obsolete name for a variable. We assume that the
3993 * set of supported old names is short enough that a brute-force search is
3996 for (i = 0; map_old_guc_names[i] != NULL; i += 2)
3998 if (guc_name_compare(name, map_old_guc_names[i]) == 0)
3999 return find_option(map_old_guc_names[i + 1], false, elevel);
4002 if (create_placeholders)
4005 * Check if the name is qualified, and if so, add a placeholder.
4007 if (strchr(name, GUC_QUALIFIER_SEPARATOR) != NULL)
4008 return add_placeholder_variable(name, elevel);
4017 * comparator for qsorting and bsearching guc_variables array
4020 guc_var_compare(const void *a, const void *b)
4022 const struct config_generic *confa = *(struct config_generic * const *) a;
4023 const struct config_generic *confb = *(struct config_generic * const *) b;
4025 return guc_name_compare(confa->name, confb->name);
4029 * the bare comparison function for GUC names
4032 guc_name_compare(const char *namea, const char *nameb)
4035 * The temptation to use strcasecmp() here must be resisted, because the
4036 * array ordering has to remain stable across setlocale() calls. So, build
4037 * our own with a simple ASCII-only downcasing.
4039 while (*namea && *nameb)
4041 char cha = *namea++;
4042 char chb = *nameb++;
4044 if (cha >= 'A' && cha <= 'Z')
4046 if (chb >= 'A' && chb <= 'Z')
4052 return 1; /* a is longer */
4054 return -1; /* b is longer */
4060 * Initialize GUC options during program startup.
4062 * Note that we cannot read the config file yet, since we have not yet
4063 * processed command-line switches.
4066 InitializeGUCOptions(void)
4071 * Before log_line_prefix could possibly receive a nonempty setting, make
4072 * sure that timezone processing is minimally alive (see elog.c).
4074 pg_timezone_initialize();
4077 * Build sorted array of all GUC variables.
4079 build_guc_variables();
4082 * Load all variables with their compiled-in defaults, and initialize
4083 * status fields as needed.
4085 for (i = 0; i < num_guc_variables; i++)
4087 InitializeOneGUCOption(guc_variables[i]);
4092 reporting_enabled = false;
4095 * Prevent any attempt to override the transaction modes from
4096 * non-interactive sources.
4098 SetConfigOption("transaction_isolation", "default",
4099 PGC_POSTMASTER, PGC_S_OVERRIDE);
4100 SetConfigOption("transaction_read_only", "no",
4101 PGC_POSTMASTER, PGC_S_OVERRIDE);
4102 SetConfigOption("transaction_deferrable", "no",
4103 PGC_POSTMASTER, PGC_S_OVERRIDE);
4106 * For historical reasons, some GUC parameters can receive defaults from
4107 * environment variables. Process those settings.
4109 InitializeGUCOptionsFromEnvironment();
4113 * Assign any GUC values that can come from the server's environment.
4115 * This is called from InitializeGUCOptions, and also from ProcessConfigFile
4116 * to deal with the possibility that a setting has been removed from
4117 * postgresql.conf and should now get a value from the environment.
4118 * (The latter is a kludge that should probably go away someday; if so,
4119 * fold this back into InitializeGUCOptions.)
4122 InitializeGUCOptionsFromEnvironment(void)
4127 env = getenv("PGPORT");
4129 SetConfigOption("port", env, PGC_POSTMASTER, PGC_S_ENV_VAR);
4131 env = getenv("PGDATESTYLE");
4133 SetConfigOption("datestyle", env, PGC_POSTMASTER, PGC_S_ENV_VAR);
4135 env = getenv("PGCLIENTENCODING");
4137 SetConfigOption("client_encoding", env, PGC_POSTMASTER, PGC_S_ENV_VAR);
4140 * rlimit isn't exactly an "environment variable", but it behaves about
4141 * the same. If we can identify the platform stack depth rlimit, increase
4142 * default stack depth setting up to whatever is safe (but at most 2MB).
4144 stack_rlimit = get_stack_depth_rlimit();
4145 if (stack_rlimit > 0)
4147 long new_limit = (stack_rlimit - STACK_DEPTH_SLOP) / 1024L;
4149 if (new_limit > 100)
4153 new_limit = Min(new_limit, 2048);
4154 sprintf(limbuf, "%ld", new_limit);
4155 SetConfigOption("max_stack_depth", limbuf,
4156 PGC_POSTMASTER, PGC_S_ENV_VAR);
4162 * Initialize one GUC option variable to its compiled-in default.
4164 * Note: the reason for calling check_hooks is not that we think the boot_val
4165 * might fail, but that the hooks might wish to compute an "extra" struct.
4168 InitializeOneGUCOption(struct config_generic * gconf)
4171 gconf->source = PGC_S_DEFAULT;
4172 gconf->reset_source = PGC_S_DEFAULT;
4173 gconf->scontext = PGC_INTERNAL;
4174 gconf->reset_scontext = PGC_INTERNAL;
4175 gconf->stack = NULL;
4176 gconf->extra = NULL;
4177 gconf->sourcefile = NULL;
4178 gconf->sourceline = 0;
4180 switch (gconf->vartype)
4184 struct config_bool *conf = (struct config_bool *) gconf;
4185 bool newval = conf->boot_val;
4188 if (!call_bool_check_hook(conf, &newval, &extra,
4189 PGC_S_DEFAULT, LOG))
4190 elog(FATAL, "failed to initialize %s to %d",
4191 conf->gen.name, (int) newval);
4192 if (conf->assign_hook)
4193 (*conf->assign_hook) (newval, extra);
4194 *conf->variable = conf->reset_val = newval;
4195 conf->gen.extra = conf->reset_extra = extra;
4200 struct config_int *conf = (struct config_int *) gconf;
4201 int newval = conf->boot_val;
4204 Assert(newval >= conf->min);
4205 Assert(newval <= conf->max);
4206 if (!call_int_check_hook(conf, &newval, &extra,
4207 PGC_S_DEFAULT, LOG))
4208 elog(FATAL, "failed to initialize %s to %d",
4209 conf->gen.name, newval);
4210 if (conf->assign_hook)
4211 (*conf->assign_hook) (newval, extra);
4212 *conf->variable = conf->reset_val = newval;
4213 conf->gen.extra = conf->reset_extra = extra;
4218 struct config_real *conf = (struct config_real *) gconf;
4219 double newval = conf->boot_val;
4222 Assert(newval >= conf->min);
4223 Assert(newval <= conf->max);
4224 if (!call_real_check_hook(conf, &newval, &extra,
4225 PGC_S_DEFAULT, LOG))
4226 elog(FATAL, "failed to initialize %s to %g",
4227 conf->gen.name, newval);
4228 if (conf->assign_hook)
4229 (*conf->assign_hook) (newval, extra);
4230 *conf->variable = conf->reset_val = newval;
4231 conf->gen.extra = conf->reset_extra = extra;
4236 struct config_string *conf = (struct config_string *) gconf;
4240 /* non-NULL boot_val must always get strdup'd */
4241 if (conf->boot_val != NULL)
4242 newval = guc_strdup(FATAL, conf->boot_val);
4246 if (!call_string_check_hook(conf, &newval, &extra,
4247 PGC_S_DEFAULT, LOG))
4248 elog(FATAL, "failed to initialize %s to \"%s\"",
4249 conf->gen.name, newval ? newval : "");
4250 if (conf->assign_hook)
4251 (*conf->assign_hook) (newval, extra);
4252 *conf->variable = conf->reset_val = newval;
4253 conf->gen.extra = conf->reset_extra = extra;
4258 struct config_enum *conf = (struct config_enum *) gconf;
4259 int newval = conf->boot_val;
4262 if (!call_enum_check_hook(conf, &newval, &extra,
4263 PGC_S_DEFAULT, LOG))
4264 elog(FATAL, "failed to initialize %s to %d",
4265 conf->gen.name, newval);
4266 if (conf->assign_hook)
4267 (*conf->assign_hook) (newval, extra);
4268 *conf->variable = conf->reset_val = newval;
4269 conf->gen.extra = conf->reset_extra = extra;
4277 * Select the configuration files and data directory to be used, and
4278 * do the initial read of postgresql.conf.
4280 * This is called after processing command-line switches.
4281 * userDoption is the -D switch value if any (NULL if unspecified).
4282 * progname is just for use in error messages.
4284 * Returns true on success; on failure, prints a suitable error message
4285 * to stderr and returns false.
4288 SelectConfigFiles(const char *userDoption, const char *progname)
4292 struct stat stat_buf;
4294 /* configdir is -D option, or $PGDATA if no -D */
4296 configdir = make_absolute_path(userDoption);
4298 configdir = make_absolute_path(getenv("PGDATA"));
4301 * Find the configuration file: if config_file was specified on the
4302 * command line, use it, else use configdir/postgresql.conf. In any case
4303 * ensure the result is an absolute path, so that it will be interpreted
4304 * the same way by future backends.
4307 fname = make_absolute_path(ConfigFileName);
4310 fname = guc_malloc(FATAL,
4311 strlen(configdir) + strlen(CONFIG_FILENAME) + 2);
4312 sprintf(fname, "%s/%s", configdir, CONFIG_FILENAME);
4316 write_stderr("%s does not know where to find the server configuration file.\n"
4317 "You must specify the --config-file or -D invocation "
4318 "option or set the PGDATA environment variable.\n",
4324 * Set the ConfigFileName GUC variable to its final value, ensuring that
4325 * it can't be overridden later.
4327 SetConfigOption("config_file", fname, PGC_POSTMASTER, PGC_S_OVERRIDE);
4331 * Now read the config file for the first time.
4333 if (stat(ConfigFileName, &stat_buf) != 0)
4335 write_stderr("%s cannot access the server configuration file \"%s\": %s\n",
4336 progname, ConfigFileName, strerror(errno));
4341 ProcessConfigFile(PGC_POSTMASTER);
4344 * If the data_directory GUC variable has been set, use that as DataDir;
4345 * otherwise use configdir if set; else punt.
4347 * Note: SetDataDir will copy and absolute-ize its argument, so we don't
4351 SetDataDir(data_directory);
4353 SetDataDir(configdir);
4356 write_stderr("%s does not know where to find the database system data.\n"
4357 "This can be specified as \"data_directory\" in \"%s\", "
4358 "or by the -D invocation option, or by the "
4359 "PGDATA environment variable.\n",
4360 progname, ConfigFileName);
4365 * Reflect the final DataDir value back into the data_directory GUC var.
4366 * (If you are wondering why we don't just make them a single variable,
4367 * it's because the EXEC_BACKEND case needs DataDir to be transmitted to
4368 * child backends specially. XXX is that still true? Given that we now
4369 * chdir to DataDir, EXEC_BACKEND can read the config file without knowing
4370 * DataDir in advance.)
4372 SetConfigOption("data_directory", DataDir, PGC_POSTMASTER, PGC_S_OVERRIDE);
4375 * If timezone_abbreviations wasn't set in the configuration file, install
4376 * the default value. We do it this way because we can't safely install a
4377 * "real" value until my_exec_path is set, which may not have happened
4378 * when InitializeGUCOptions runs, so the bootstrap default value cannot
4379 * be the real desired default.
4381 pg_timezone_abbrev_initialize();
4383 /* Also install the correct value for effective_cache_size */
4384 set_default_effective_cache_size();
4387 * Figure out where pg_hba.conf is, and make sure the path is absolute.
4390 fname = make_absolute_path(HbaFileName);
4393 fname = guc_malloc(FATAL,
4394 strlen(configdir) + strlen(HBA_FILENAME) + 2);
4395 sprintf(fname, "%s/%s", configdir, HBA_FILENAME);
4399 write_stderr("%s does not know where to find the \"hba\" configuration file.\n"
4400 "This can be specified as \"hba_file\" in \"%s\", "
4401 "or by the -D invocation option, or by the "
4402 "PGDATA environment variable.\n",
4403 progname, ConfigFileName);
4406 SetConfigOption("hba_file", fname, PGC_POSTMASTER, PGC_S_OVERRIDE);
4410 * Likewise for pg_ident.conf.
4413 fname = make_absolute_path(IdentFileName);
4416 fname = guc_malloc(FATAL,
4417 strlen(configdir) + strlen(IDENT_FILENAME) + 2);
4418 sprintf(fname, "%s/%s", configdir, IDENT_FILENAME);
4422 write_stderr("%s does not know where to find the \"ident\" configuration file.\n"
4423 "This can be specified as \"ident_file\" in \"%s\", "
4424 "or by the -D invocation option, or by the "
4425 "PGDATA environment variable.\n",
4426 progname, ConfigFileName);
4429 SetConfigOption("ident_file", fname, PGC_POSTMASTER, PGC_S_OVERRIDE);
4439 * Reset all options to their saved default values (implements RESET ALL)
4442 ResetAllOptions(void)
4446 for (i = 0; i < num_guc_variables; i++)
4448 struct config_generic *gconf = guc_variables[i];
4450 /* Don't reset non-SET-able values */
4451 if (gconf->context != PGC_SUSET &&
4452 gconf->context != PGC_USERSET)
4454 /* Don't reset if special exclusion from RESET ALL */
4455 if (gconf->flags & GUC_NO_RESET_ALL)
4457 /* No need to reset if wasn't SET */
4458 if (gconf->source <= PGC_S_OVERRIDE)
4461 /* Save old value to support transaction abort */
4462 push_old_value(gconf, GUC_ACTION_SET);
4464 switch (gconf->vartype)
4468 struct config_bool *conf = (struct config_bool *) gconf;
4470 if (conf->assign_hook)
4471 (*conf->assign_hook) (conf->reset_val,
4473 *conf->variable = conf->reset_val;
4474 set_extra_field(&conf->gen, &conf->gen.extra,
4480 struct config_int *conf = (struct config_int *) gconf;
4482 if (conf->assign_hook)
4483 (*conf->assign_hook) (conf->reset_val,
4485 *conf->variable = conf->reset_val;
4486 set_extra_field(&conf->gen, &conf->gen.extra,
4492 struct config_real *conf = (struct config_real *) gconf;
4494 if (conf->assign_hook)
4495 (*conf->assign_hook) (conf->reset_val,
4497 *conf->variable = conf->reset_val;
4498 set_extra_field(&conf->gen, &conf->gen.extra,
4504 struct config_string *conf = (struct config_string *) gconf;
4506 if (conf->assign_hook)
4507 (*conf->assign_hook) (conf->reset_val,
4509 set_string_field(conf, conf->variable, conf->reset_val);
4510 set_extra_field(&conf->gen, &conf->gen.extra,
4516 struct config_enum *conf = (struct config_enum *) gconf;
4518 if (conf->assign_hook)
4519 (*conf->assign_hook) (conf->reset_val,
4521 *conf->variable = conf->reset_val;
4522 set_extra_field(&conf->gen, &conf->gen.extra,
4528 gconf->source = gconf->reset_source;
4529 gconf->scontext = gconf->reset_scontext;
4531 if (gconf->flags & GUC_REPORT)
4532 ReportGUCOption(gconf);
4539 * Push previous state during transactional assignment to a GUC variable.
4542 push_old_value(struct config_generic * gconf, GucAction action)
4546 /* If we're not inside a nest level, do nothing */
4547 if (GUCNestLevel == 0)
4550 /* Do we already have a stack entry of the current nest level? */
4551 stack = gconf->stack;
4552 if (stack && stack->nest_level >= GUCNestLevel)
4554 /* Yes, so adjust its state if necessary */
4555 Assert(stack->nest_level == GUCNestLevel);
4558 case GUC_ACTION_SET:
4559 /* SET overrides any prior action at same nest level */
4560 if (stack->state == GUC_SET_LOCAL)
4562 /* must discard old masked value */
4563 discard_stack_value(gconf, &stack->masked);
4565 stack->state = GUC_SET;
4567 case GUC_ACTION_LOCAL:
4568 if (stack->state == GUC_SET)
4570 /* SET followed by SET LOCAL, remember SET's value */
4571 stack->masked_scontext = gconf->scontext;
4572 set_stack_value(gconf, &stack->masked);
4573 stack->state = GUC_SET_LOCAL;
4575 /* in all other cases, no change to stack entry */
4577 case GUC_ACTION_SAVE:
4578 /* Could only have a prior SAVE of same variable */
4579 Assert(stack->state == GUC_SAVE);
4582 Assert(guc_dirty); /* must be set already */
4587 * Push a new stack entry
4589 * We keep all the stack entries in TopTransactionContext for simplicity.
4591 stack = (GucStack *) MemoryContextAllocZero(TopTransactionContext,
4594 stack->prev = gconf->stack;
4595 stack->nest_level = GUCNestLevel;
4598 case GUC_ACTION_SET:
4599 stack->state = GUC_SET;
4601 case GUC_ACTION_LOCAL:
4602 stack->state = GUC_LOCAL;
4604 case GUC_ACTION_SAVE:
4605 stack->state = GUC_SAVE;
4608 stack->source = gconf->source;
4609 stack->scontext = gconf->scontext;
4610 set_stack_value(gconf, &stack->prior);
4612 gconf->stack = stack;
4614 /* Ensure we remember to pop at end of xact */
4620 * Do GUC processing at main transaction start.
4626 * The nest level should be 0 between transactions; if it isn't, somebody
4627 * didn't call AtEOXact_GUC, or called it with the wrong nestLevel. We
4628 * throw a warning but make no other effort to clean up.
4630 if (GUCNestLevel != 0)
4631 elog(WARNING, "GUC nest level = %d at transaction start",
4637 * Enter a new nesting level for GUC values. This is called at subtransaction
4638 * start, and when entering a function that has proconfig settings, and in
4639 * some other places where we want to set GUC variables transiently.
4640 * NOTE we must not risk error here, else subtransaction start will be unhappy.
4643 NewGUCNestLevel(void)
4645 return ++GUCNestLevel;
4649 * Do GUC processing at transaction or subtransaction commit or abort, or
4650 * when exiting a function that has proconfig settings, or when undoing a
4651 * transient assignment to some GUC variables. (The name is thus a bit of
4652 * a misnomer; perhaps it should be ExitGUCNestLevel or some such.)
4653 * During abort, we discard all GUC settings that were applied at nesting
4654 * levels >= nestLevel. nestLevel == 1 corresponds to the main transaction.
4657 AtEOXact_GUC(bool isCommit, int nestLevel)
4663 * Note: it's possible to get here with GUCNestLevel == nestLevel-1 during
4664 * abort, if there is a failure during transaction start before
4665 * AtStart_GUC is called.
4667 Assert(nestLevel > 0 &&
4668 (nestLevel <= GUCNestLevel ||
4669 (nestLevel == GUCNestLevel + 1 && !isCommit)));
4671 /* Quick exit if nothing's changed in this transaction */
4674 GUCNestLevel = nestLevel - 1;
4678 still_dirty = false;
4679 for (i = 0; i < num_guc_variables; i++)
4681 struct config_generic *gconf = guc_variables[i];
4685 * Process and pop each stack entry within the nest level. To simplify
4686 * fmgr_security_definer() and other places that use GUC_ACTION_SAVE,
4687 * we allow failure exit from code that uses a local nest level to be
4688 * recovered at the surrounding transaction or subtransaction abort;
4689 * so there could be more than one stack entry to pop.
4691 while ((stack = gconf->stack) != NULL &&
4692 stack->nest_level >= nestLevel)
4694 GucStack *prev = stack->prev;
4695 bool restorePrior = false;
4696 bool restoreMasked = false;
4700 * In this next bit, if we don't set either restorePrior or
4701 * restoreMasked, we must "discard" any unwanted fields of the
4702 * stack entries to avoid leaking memory. If we do set one of
4703 * those flags, unused fields will be cleaned up after restoring.
4705 if (!isCommit) /* if abort, always restore prior value */
4706 restorePrior = true;
4707 else if (stack->state == GUC_SAVE)
4708 restorePrior = true;
4709 else if (stack->nest_level == 1)
4711 /* transaction commit */
4712 if (stack->state == GUC_SET_LOCAL)
4713 restoreMasked = true;
4714 else if (stack->state == GUC_SET)
4716 /* we keep the current active value */
4717 discard_stack_value(gconf, &stack->prior);
4719 else /* must be GUC_LOCAL */
4720 restorePrior = true;
4722 else if (prev == NULL ||
4723 prev->nest_level < stack->nest_level - 1)
4725 /* decrement entry's level and do not pop it */
4726 stack->nest_level--;
4732 * We have to merge this stack entry into prev. See README for
4733 * discussion of this bit.
4735 switch (stack->state)
4738 Assert(false); /* can't get here */
4741 /* next level always becomes SET */
4742 discard_stack_value(gconf, &stack->prior);
4743 if (prev->state == GUC_SET_LOCAL)
4744 discard_stack_value(gconf, &prev->masked);
4745 prev->state = GUC_SET;
4749 if (prev->state == GUC_SET)
4751 /* LOCAL migrates down */
4752 prev->masked_scontext = stack->scontext;
4753 prev->masked = stack->prior;
4754 prev->state = GUC_SET_LOCAL;
4758 /* else just forget this stack level */
4759 discard_stack_value(gconf, &stack->prior);
4764 /* prior state at this level no longer wanted */
4765 discard_stack_value(gconf, &stack->prior);
4766 /* copy down the masked state */
4767 prev->masked_scontext = stack->masked_scontext;
4768 if (prev->state == GUC_SET_LOCAL)
4769 discard_stack_value(gconf, &prev->masked);
4770 prev->masked = stack->masked;
4771 prev->state = GUC_SET_LOCAL;
4778 if (restorePrior || restoreMasked)
4780 /* Perform appropriate restoration of the stacked value */
4781 config_var_value newvalue;
4782 GucSource newsource;
4783 GucContext newscontext;
4787 newvalue = stack->masked;
4788 newsource = PGC_S_SESSION;
4789 newscontext = stack->masked_scontext;
4793 newvalue = stack->prior;
4794 newsource = stack->source;
4795 newscontext = stack->scontext;
4798 switch (gconf->vartype)
4802 struct config_bool *conf = (struct config_bool *) gconf;
4803 bool newval = newvalue.val.boolval;
4804 void *newextra = newvalue.extra;
4806 if (*conf->variable != newval ||
4807 conf->gen.extra != newextra)
4809 if (conf->assign_hook)
4810 (*conf->assign_hook) (newval, newextra);
4811 *conf->variable = newval;
4812 set_extra_field(&conf->gen, &conf->gen.extra,
4820 struct config_int *conf = (struct config_int *) gconf;
4821 int newval = newvalue.val.intval;
4822 void *newextra = newvalue.extra;
4824 if (*conf->variable != newval ||
4825 conf->gen.extra != newextra)
4827 if (conf->assign_hook)
4828 (*conf->assign_hook) (newval, newextra);
4829 *conf->variable = newval;
4830 set_extra_field(&conf->gen, &conf->gen.extra,
4838 struct config_real *conf = (struct config_real *) gconf;
4839 double newval = newvalue.val.realval;
4840 void *newextra = newvalue.extra;
4842 if (*conf->variable != newval ||
4843 conf->gen.extra != newextra)
4845 if (conf->assign_hook)
4846 (*conf->assign_hook) (newval, newextra);
4847 *conf->variable = newval;
4848 set_extra_field(&conf->gen, &conf->gen.extra,
4856 struct config_string *conf = (struct config_string *) gconf;
4857 char *newval = newvalue.val.stringval;
4858 void *newextra = newvalue.extra;
4860 if (*conf->variable != newval ||
4861 conf->gen.extra != newextra)
4863 if (conf->assign_hook)
4864 (*conf->assign_hook) (newval, newextra);
4865 set_string_field(conf, conf->variable, newval);
4866 set_extra_field(&conf->gen, &conf->gen.extra,
4872 * Release stacked values if not used anymore. We
4873 * could use discard_stack_value() here, but since
4874 * we have type-specific code anyway, might as
4877 set_string_field(conf, &stack->prior.val.stringval, NULL);
4878 set_string_field(conf, &stack->masked.val.stringval, NULL);
4883 struct config_enum *conf = (struct config_enum *) gconf;
4884 int newval = newvalue.val.enumval;
4885 void *newextra = newvalue.extra;
4887 if (*conf->variable != newval ||
4888 conf->gen.extra != newextra)
4890 if (conf->assign_hook)
4891 (*conf->assign_hook) (newval, newextra);
4892 *conf->variable = newval;
4893 set_extra_field(&conf->gen, &conf->gen.extra,
4902 * Release stacked extra values if not used anymore.
4904 set_extra_field(gconf, &(stack->prior.extra), NULL);
4905 set_extra_field(gconf, &(stack->masked.extra), NULL);
4907 /* And restore source information */
4908 gconf->source = newsource;
4909 gconf->scontext = newscontext;
4912 /* Finish popping the state stack */
4913 gconf->stack = prev;
4916 /* Report new value if we changed it */
4917 if (changed && (gconf->flags & GUC_REPORT))
4918 ReportGUCOption(gconf);
4919 } /* end of stack-popping loop */
4925 /* If there are no remaining stack entries, we can reset guc_dirty */
4926 guc_dirty = still_dirty;
4928 /* Update nesting level */
4929 GUCNestLevel = nestLevel - 1;
4934 * Start up automatic reporting of changes to variables marked GUC_REPORT.
4935 * This is executed at completion of backend startup.
4938 BeginReportingGUCOptions(void)
4943 * Don't do anything unless talking to an interactive frontend of protocol
4946 if (whereToSendOutput != DestRemote ||
4947 PG_PROTOCOL_MAJOR(FrontendProtocol) < 3)
4950 reporting_enabled = true;
4952 /* Transmit initial values of interesting variables */
4953 for (i = 0; i < num_guc_variables; i++)
4955 struct config_generic *conf = guc_variables[i];
4957 if (conf->flags & GUC_REPORT)
4958 ReportGUCOption(conf);
4963 * ReportGUCOption: if appropriate, transmit option value to frontend
4966 ReportGUCOption(struct config_generic * record)
4968 if (reporting_enabled && (record->flags & GUC_REPORT))
4970 char *val = _ShowOption(record, false);
4971 StringInfoData msgbuf;
4973 pq_beginmessage(&msgbuf, 'S');
4974 pq_sendstring(&msgbuf, record->name);
4975 pq_sendstring(&msgbuf, val);
4976 pq_endmessage(&msgbuf);
4983 * Try to parse value as an integer. The accepted formats are the
4984 * usual decimal, octal, or hexadecimal formats, optionally followed by
4985 * a unit name if "flags" indicates a unit is allowed.
4987 * If the string parses okay, return true, else false.
4988 * If okay and result is not NULL, return the value in *result.
4989 * If not okay and hintmsg is not NULL, *hintmsg is set to a suitable
4990 * HINT message, or NULL if no hint provided.
4993 parse_int(const char *value, int *result, int flags, const char **hintmsg)
4998 /* To suppress compiler warnings, always set output params */
5004 /* We assume here that int64 is at least as wide as long */
5006 val = strtol(value, &endptr, 0);
5008 if (endptr == value)
5009 return false; /* no HINT for integer syntax error */
5011 if (errno == ERANGE || val != (int64) ((int32) val))
5014 *hintmsg = gettext_noop("Value exceeds integer range.");
5018 /* allow whitespace between integer and unit */
5019 while (isspace((unsigned char) *endptr))
5022 /* Handle possible unit */
5023 if (*endptr != '\0')
5026 * Note: the multiple-switch coding technique here is a bit tedious,
5027 * but seems necessary to avoid intermediate-value overflows.
5029 if (flags & GUC_UNIT_MEMORY)
5031 /* Set hint for use if no match or trailing garbage */
5033 *hintmsg = gettext_noop("Valid units for this parameter are \"kB\", \"MB\", \"GB\", and \"TB\".");
5035 #if BLCKSZ < 1024 || BLCKSZ > (1024*1024)
5036 #error BLCKSZ must be between 1KB and 1MB
5038 #if XLOG_BLCKSZ < 1024 || XLOG_BLCKSZ > (1024*1024)
5039 #error XLOG_BLCKSZ must be between 1KB and 1MB
5042 if (strncmp(endptr, "kB", 2) == 0)
5045 switch (flags & GUC_UNIT_MEMORY)
5047 case GUC_UNIT_BLOCKS:
5048 val /= (BLCKSZ / 1024);
5050 case GUC_UNIT_XBLOCKS:
5051 val /= (XLOG_BLCKSZ / 1024);
5055 else if (strncmp(endptr, "MB", 2) == 0)
5058 switch (flags & GUC_UNIT_MEMORY)
5063 case GUC_UNIT_BLOCKS:
5064 val *= KB_PER_MB / (BLCKSZ / 1024);
5066 case GUC_UNIT_XBLOCKS:
5067 val *= KB_PER_MB / (XLOG_BLCKSZ / 1024);
5071 else if (strncmp(endptr, "GB", 2) == 0)
5074 switch (flags & GUC_UNIT_MEMORY)
5079 case GUC_UNIT_BLOCKS:
5080 val *= KB_PER_GB / (BLCKSZ / 1024);
5082 case GUC_UNIT_XBLOCKS:
5083 val *= KB_PER_GB / (XLOG_BLCKSZ / 1024);
5087 else if (strncmp(endptr, "TB", 2) == 0)
5090 switch (flags & GUC_UNIT_MEMORY)
5095 case GUC_UNIT_BLOCKS:
5096 val *= KB_PER_TB / (BLCKSZ / 1024);
5098 case GUC_UNIT_XBLOCKS:
5099 val *= KB_PER_TB / (XLOG_BLCKSZ / 1024);
5104 else if (flags & GUC_UNIT_TIME)
5106 /* Set hint for use if no match or trailing garbage */
5108 *hintmsg = gettext_noop("Valid units for this parameter are \"ms\", \"s\", \"min\", \"h\", and \"d\".");
5110 if (strncmp(endptr, "ms", 2) == 0)
5113 switch (flags & GUC_UNIT_TIME)
5123 else if (strncmp(endptr, "s", 1) == 0)
5126 switch (flags & GUC_UNIT_TIME)
5136 else if (strncmp(endptr, "min", 3) == 0)
5139 switch (flags & GUC_UNIT_TIME)
5149 else if (strncmp(endptr, "h", 1) == 0)
5152 switch (flags & GUC_UNIT_TIME)
5165 else if (strncmp(endptr, "d", 1) == 0)
5168 switch (flags & GUC_UNIT_TIME)
5183 /* allow whitespace after unit */
5184 while (isspace((unsigned char) *endptr))
5187 if (*endptr != '\0')
5188 return false; /* appropriate hint, if any, already set */
5190 /* Check for overflow due to units conversion */
5191 if (val != (int64) ((int32) val))
5194 *hintmsg = gettext_noop("Value exceeds integer range.");
5200 *result = (int) val;
5207 * Try to parse value as a floating point number in the usual format.
5208 * If the string parses okay, return true, else false.
5209 * If okay and result is not NULL, return the value in *result.
5212 parse_real(const char *value, double *result)
5218 *result = 0; /* suppress compiler warning */
5221 val = strtod(value, &endptr);
5222 if (endptr == value || errno == ERANGE)
5225 /* allow whitespace after number */
5226 while (isspace((unsigned char) *endptr))
5228 if (*endptr != '\0')
5238 * Lookup the name for an enum option with the selected value.
5239 * Should only ever be called with known-valid values, so throws
5240 * an elog(ERROR) if the enum option is not found.
5242 * The returned string is a pointer to static data and not
5243 * allocated for modification.
5246 config_enum_lookup_by_value(struct config_enum * record, int val)
5248 const struct config_enum_entry *entry;
5250 for (entry = record->options; entry && entry->name; entry++)
5252 if (entry->val == val)
5256 elog(ERROR, "could not find enum option %d for %s",
5257 val, record->gen.name);
5258 return NULL; /* silence compiler */
5263 * Lookup the value for an enum option with the selected name
5264 * (case-insensitive).
5265 * If the enum option is found, sets the retval value and returns
5266 * true. If it's not found, return FALSE and retval is set to 0.
5269 config_enum_lookup_by_name(struct config_enum * record, const char *value,
5272 const struct config_enum_entry *entry;
5274 for (entry = record->options; entry && entry->name; entry++)
5276 if (pg_strcasecmp(value, entry->name) == 0)
5278 *retval = entry->val;
5289 * Return a list of all available options for an enum, excluding
5290 * hidden ones, separated by the given separator.
5291 * If prefix is non-NULL, it is added before the first enum value.
5292 * If suffix is non-NULL, it is added to the end of the string.
5295 config_enum_get_options(struct config_enum * record, const char *prefix,
5296 const char *suffix, const char *separator)
5298 const struct config_enum_entry *entry;
5299 StringInfoData retstr;
5302 initStringInfo(&retstr);
5303 appendStringInfoString(&retstr, prefix);
5305 seplen = strlen(separator);
5306 for (entry = record->options; entry && entry->name; entry++)
5310 appendStringInfoString(&retstr, entry->name);
5311 appendBinaryStringInfo(&retstr, separator, seplen);
5316 * All the entries may have been hidden, leaving the string empty if no
5317 * prefix was given. This indicates a broken GUC setup, since there is no
5318 * use for an enum without any values, so we just check to make sure we
5319 * don't write to invalid memory instead of actually trying to do
5320 * something smart with it.
5322 if (retstr.len >= seplen)
5324 /* Replace final separator */
5325 retstr.data[retstr.len - seplen] = '\0';
5326 retstr.len -= seplen;
5329 appendStringInfoString(&retstr, suffix);
5335 * Validates configuration parameter and value, by calling check hook functions
5336 * depending on record's vartype. It validates if the parameter
5337 * value given is in range of expected predefined value for that parameter.
5339 * freemem - true indicates memory for newval and newextra will be
5340 * freed in this function, false indicates it will be freed
5343 * 1: the value is valid
5344 * 0: the name or value is invalid
5347 validate_conf_option(struct config_generic * record, const char *name,
5348 const char *value, GucSource source, int elevel,
5349 bool freemem, void *newval, void **newextra)
5352 * Validate the value for the passed record, to ensure it is in expected
5355 switch (record->vartype)
5360 struct config_bool *conf = (struct config_bool *) record;
5364 newval = &tmpnewval;
5368 if (!parse_bool(value, newval))
5371 (errcode(ERRCODE_INVALID_PARAMETER_VALUE),
5372 errmsg("parameter \"%s\" requires a Boolean value",
5377 if (!call_bool_check_hook(conf, newval, newextra,
5381 if (*newextra && freemem)
5388 struct config_int *conf = (struct config_int *) record;
5392 newval = &tmpnewval;
5396 const char *hintmsg;
5398 if (!parse_int(value, newval, conf->gen.flags, &hintmsg))
5401 (errcode(ERRCODE_INVALID_PARAMETER_VALUE),
5402 errmsg("invalid value for parameter \"%s\": \"%s\"",
5404 hintmsg ? errhint("%s", _(hintmsg)) : 0));
5408 if (*((int *) newval) < conf->min || *((int *) newval) > conf->max)
5411 (errcode(ERRCODE_INVALID_PARAMETER_VALUE),
5412 errmsg("%d is outside the valid range for parameter \"%s\" (%d .. %d)",
5413 *((int *) newval), name, conf->min, conf->max)));
5417 if (!call_int_check_hook(conf, newval, newextra,
5421 if (*newextra && freemem)
5428 struct config_real *conf = (struct config_real *) record;
5432 newval = &tmpnewval;
5436 if (!parse_real(value, newval))
5439 (errcode(ERRCODE_INVALID_PARAMETER_VALUE),
5440 errmsg("parameter \"%s\" requires a numeric value",
5445 if (*((double *) newval) < conf->min || *((double *) newval) > conf->max)
5448 (errcode(ERRCODE_INVALID_PARAMETER_VALUE),
5449 errmsg("%g is outside the valid range for parameter \"%s\" (%g .. %g)",
5450 *((double *) newval), name, conf->min, conf->max)));
5454 if (!call_real_check_hook(conf, newval, newextra,
5458 if (*newextra && freemem)
5465 struct config_string *conf = (struct config_string *) record;
5467 char **tmpnewval = newval;
5470 tmpnewval = &tempPtr;
5475 * The value passed by the caller could be transient, so
5476 * we always strdup it.
5478 *tmpnewval = guc_strdup(elevel, value);
5479 if (*tmpnewval == NULL)
5483 * The only built-in "parsing" check we have is to apply
5484 * truncation if GUC_IS_NAME.
5486 if (conf->gen.flags & GUC_IS_NAME)
5487 truncate_identifier(*tmpnewval, strlen(*tmpnewval), true);
5489 if (!call_string_check_hook(conf, tmpnewval, newextra,
5496 /* Free the malloc'd data if any */
5499 if (*tmpnewval != NULL)
5501 if (*newextra != NULL)
5509 struct config_enum *conf = (struct config_enum *) record;
5513 newval = &tmpnewval;
5517 if (!config_enum_lookup_by_name(conf, value, newval))
5521 hintmsg = config_enum_get_options(conf,
5522 "Available values: ",
5526 (errcode(ERRCODE_INVALID_PARAMETER_VALUE),
5527 errmsg("invalid value for parameter \"%s\": \"%s\"",
5529 hintmsg ? errhint("%s", _(hintmsg)) : 0));
5531 if (hintmsg != NULL)
5535 if (!call_enum_check_hook(conf, newval, newextra,
5539 if (*newextra && freemem)
5550 * Sets option `name' to given value.
5552 * The value should be a string, which will be parsed and converted to
5553 * the appropriate data type. The context and source parameters indicate
5554 * in which context this function is being called, so that it can apply the
5555 * access restrictions properly.
5557 * If value is NULL, set the option to its default value (normally the
5558 * reset_val, but if source == PGC_S_DEFAULT we instead use the boot_val).
5560 * action indicates whether to set the value globally in the session, locally
5561 * to the current top transaction, or just for the duration of a function call.
5563 * If changeVal is false then don't really set the option but do all
5564 * the checks to see if it would work.
5566 * elevel should normally be passed as zero, allowing this function to make
5567 * its standard choice of ereport level. However some callers need to be
5568 * able to override that choice; they should pass the ereport level to use.
5571 * +1: the value is valid and was successfully applied.
5572 * 0: the name or value is invalid (but see below).
5573 * -1: the value was not applied because of context, priority, or changeVal.
5575 * If there is an error (non-existing option, invalid value) then an
5576 * ereport(ERROR) is thrown *unless* this is called for a source for which
5577 * we don't want an ERROR (currently, those are defaults, the config file,
5578 * and per-database or per-user settings, as well as callers who specify
5579 * a less-than-ERROR elevel). In those cases we write a suitable error
5580 * message via ereport() and return 0.
5582 * See also SetConfigOption for an external interface.
5585 set_config_option(const char *name, const char *value,
5586 GucContext context, GucSource source,
5587 GucAction action, bool changeVal, int elevel)
5589 struct config_generic *record;
5590 bool prohibitValueChange = false;
5595 if (source == PGC_S_DEFAULT || source == PGC_S_FILE)
5598 * To avoid cluttering the log, only the postmaster bleats loudly
5599 * about problems with the config file.
5601 elevel = IsUnderPostmaster ? DEBUG3 : LOG;
5603 else if (source == PGC_S_GLOBAL || source == PGC_S_DATABASE || source == PGC_S_USER ||
5604 source == PGC_S_DATABASE_USER)
5610 record = find_option(name, true, elevel);
5614 (errcode(ERRCODE_UNDEFINED_OBJECT),
5615 errmsg("unrecognized configuration parameter \"%s\"", name)));
5620 * Check if the option can be set at this time. See guc.h for the precise
5623 switch (record->context)
5626 if (context != PGC_INTERNAL)
5629 (errcode(ERRCODE_CANT_CHANGE_RUNTIME_PARAM),
5630 errmsg("parameter \"%s\" cannot be changed",
5635 case PGC_POSTMASTER:
5636 if (context == PGC_SIGHUP)
5639 * We are re-reading a PGC_POSTMASTER variable from
5640 * postgresql.conf. We can't change the setting, so we should
5641 * give a warning if the DBA tries to change it. However,
5642 * because of variant formats, canonicalization by check
5643 * hooks, etc, we can't just compare the given string directly
5644 * to what's stored. Set a flag to check below after we have
5645 * the final storable value.
5647 prohibitValueChange = true;
5649 else if (context != PGC_POSTMASTER)
5652 (errcode(ERRCODE_CANT_CHANGE_RUNTIME_PARAM),
5653 errmsg("parameter \"%s\" cannot be changed without restarting the server",
5659 if (context != PGC_SIGHUP && context != PGC_POSTMASTER)
5662 (errcode(ERRCODE_CANT_CHANGE_RUNTIME_PARAM),
5663 errmsg("parameter \"%s\" cannot be changed now",
5669 * Hmm, the idea of the SIGHUP context is "ought to be global, but
5670 * can be changed after postmaster start". But there's nothing
5671 * that prevents a crafty administrator from sending SIGHUP
5672 * signals to individual backends only.
5676 if (context == PGC_SIGHUP)
5679 * If a PGC_BACKEND parameter is changed in the config file,
5680 * we want to accept the new value in the postmaster (whence
5681 * it will propagate to subsequently-started backends), but
5682 * ignore it in existing backends. This is a tad klugy, but
5683 * necessary because we don't re-read the config file during
5686 if (IsUnderPostmaster)
5689 else if (context != PGC_POSTMASTER && context != PGC_BACKEND &&
5690 source != PGC_S_CLIENT)
5693 (errcode(ERRCODE_CANT_CHANGE_RUNTIME_PARAM),
5694 errmsg("parameter \"%s\" cannot be set after connection start",
5700 if (context == PGC_USERSET || context == PGC_BACKEND)
5703 (errcode(ERRCODE_INSUFFICIENT_PRIVILEGE),
5704 errmsg("permission denied to set parameter \"%s\"",
5715 * Disallow changing GUC_NOT_WHILE_SEC_REST values if we are inside a
5716 * security restriction context. We can reject this regardless of the GUC
5717 * context or source, mainly because sources that it might be reasonable
5718 * to override for won't be seen while inside a function.
5720 * Note: variables marked GUC_NOT_WHILE_SEC_REST should usually be marked
5721 * GUC_NO_RESET_ALL as well, because ResetAllOptions() doesn't check this.
5722 * An exception might be made if the reset value is assumed to be "safe".
5724 * Note: this flag is currently used for "session_authorization" and
5725 * "role". We need to prohibit changing these inside a local userid
5726 * context because when we exit it, GUC won't be notified, leaving things
5727 * out of sync. (This could be fixed by forcing a new GUC nesting level,
5728 * but that would change behavior in possibly-undesirable ways.) Also, we
5729 * prohibit changing these in a security-restricted operation because
5730 * otherwise RESET could be used to regain the session user's privileges.
5732 if (record->flags & GUC_NOT_WHILE_SEC_REST)
5734 if (InLocalUserIdChange())
5737 * Phrasing of this error message is historical, but it's the most
5741 (errcode(ERRCODE_INSUFFICIENT_PRIVILEGE),
5742 errmsg("cannot set parameter \"%s\" within security-definer function",
5746 if (InSecurityRestrictedOperation())
5749 (errcode(ERRCODE_INSUFFICIENT_PRIVILEGE),
5750 errmsg("cannot set parameter \"%s\" within security-restricted operation",
5757 * Should we set reset/stacked values? (If so, the behavior is not
5758 * transactional.) This is done either when we get a default value from
5759 * the database's/user's/client's default settings or when we reset a
5760 * value to its default.
5762 makeDefault = changeVal && (source <= PGC_S_OVERRIDE) &&
5763 ((value != NULL) || source == PGC_S_DEFAULT);
5766 * Ignore attempted set if overridden by previously processed setting.
5767 * However, if changeVal is false then plow ahead anyway since we are
5768 * trying to find out if the value is potentially good, not actually use
5769 * it. Also keep going if makeDefault is true, since we may want to set
5770 * the reset/stacked values even if we can't set the variable itself.
5772 if (record->source > source)
5774 if (changeVal && !makeDefault)
5776 elog(DEBUG3, "\"%s\": setting ignored because previous source is higher priority",
5784 * Evaluate value and set variable.
5786 switch (record->vartype)
5790 struct config_bool *conf = (struct config_bool *) record;
5792 void *newextra = NULL;
5796 if (!validate_conf_option(record, name, value, source,
5797 elevel, false, &newval,
5801 else if (source == PGC_S_DEFAULT)
5803 newval = conf->boot_val;
5804 if (!call_bool_check_hook(conf, &newval, &newextra,
5810 newval = conf->reset_val;
5811 newextra = conf->reset_extra;
5812 source = conf->gen.reset_source;
5813 context = conf->gen.reset_scontext;
5816 if (prohibitValueChange)
5818 if (*conf->variable != newval)
5821 (errcode(ERRCODE_CANT_CHANGE_RUNTIME_PARAM),
5822 errmsg("parameter \"%s\" cannot be changed without restarting the server",
5831 /* Save old value to support transaction abort */
5833 push_old_value(&conf->gen, action);
5835 if (conf->assign_hook)
5836 (*conf->assign_hook) (newval, newextra);
5837 *conf->variable = newval;
5838 set_extra_field(&conf->gen, &conf->gen.extra,
5840 conf->gen.source = source;
5841 conf->gen.scontext = context;
5847 if (conf->gen.reset_source <= source)
5849 conf->reset_val = newval;
5850 set_extra_field(&conf->gen, &conf->reset_extra,
5852 conf->gen.reset_source = source;
5853 conf->gen.reset_scontext = context;
5855 for (stack = conf->gen.stack; stack; stack = stack->prev)
5857 if (stack->source <= source)
5859 stack->prior.val.boolval = newval;
5860 set_extra_field(&conf->gen, &stack->prior.extra,
5862 stack->source = source;
5863 stack->scontext = context;
5868 /* Perhaps we didn't install newextra anywhere */
5869 if (newextra && !extra_field_used(&conf->gen, newextra))
5876 struct config_int *conf = (struct config_int *) record;
5878 void *newextra = NULL;
5882 if (!validate_conf_option(record, name, value, source,
5883 elevel, false, &newval,
5887 else if (source == PGC_S_DEFAULT)
5889 newval = conf->boot_val;
5890 if (!call_int_check_hook(conf, &newval, &newextra,
5896 newval = conf->reset_val;
5897 newextra = conf->reset_extra;
5898 source = conf->gen.reset_source;
5899 context = conf->gen.reset_scontext;
5902 if (prohibitValueChange)
5904 if (*conf->variable != newval)
5907 (errcode(ERRCODE_CANT_CHANGE_RUNTIME_PARAM),
5908 errmsg("parameter \"%s\" cannot be changed without restarting the server",
5917 /* Save old value to support transaction abort */
5919 push_old_value(&conf->gen, action);
5921 if (conf->assign_hook)
5922 (*conf->assign_hook) (newval, newextra);
5923 *conf->variable = newval;
5924 set_extra_field(&conf->gen, &conf->gen.extra,
5926 conf->gen.source = source;
5927 conf->gen.scontext = context;
5933 if (conf->gen.reset_source <= source)
5935 conf->reset_val = newval;
5936 set_extra_field(&conf->gen, &conf->reset_extra,
5938 conf->gen.reset_source = source;
5939 conf->gen.reset_scontext = context;
5941 for (stack = conf->gen.stack; stack; stack = stack->prev)
5943 if (stack->source <= source)
5945 stack->prior.val.intval = newval;
5946 set_extra_field(&conf->gen, &stack->prior.extra,
5948 stack->source = source;
5949 stack->scontext = context;
5954 /* Perhaps we didn't install newextra anywhere */
5955 if (newextra && !extra_field_used(&conf->gen, newextra))
5962 struct config_real *conf = (struct config_real *) record;
5964 void *newextra = NULL;
5968 if (!validate_conf_option(record, name, value, source,
5969 elevel, false, &newval,
5973 else if (source == PGC_S_DEFAULT)
5975 newval = conf->boot_val;
5976 if (!call_real_check_hook(conf, &newval, &newextra,
5982 newval = conf->reset_val;
5983 newextra = conf->reset_extra;
5984 source = conf->gen.reset_source;
5985 context = conf->gen.reset_scontext;
5988 if (prohibitValueChange)
5990 if (*conf->variable != newval)
5993 (errcode(ERRCODE_CANT_CHANGE_RUNTIME_PARAM),
5994 errmsg("parameter \"%s\" cannot be changed without restarting the server",
6003 /* Save old value to support transaction abort */
6005 push_old_value(&conf->gen, action);
6007 if (conf->assign_hook)
6008 (*conf->assign_hook) (newval, newextra);
6009 *conf->variable = newval;
6010 set_extra_field(&conf->gen, &conf->gen.extra,
6012 conf->gen.source = source;
6013 conf->gen.scontext = context;
6019 if (conf->gen.reset_source <= source)
6021 conf->reset_val = newval;
6022 set_extra_field(&conf->gen, &conf->reset_extra,
6024 conf->gen.reset_source = source;
6025 conf->gen.reset_scontext = context;
6027 for (stack = conf->gen.stack; stack; stack = stack->prev)
6029 if (stack->source <= source)
6031 stack->prior.val.realval = newval;
6032 set_extra_field(&conf->gen, &stack->prior.extra,
6034 stack->source = source;
6035 stack->scontext = context;
6040 /* Perhaps we didn't install newextra anywhere */
6041 if (newextra && !extra_field_used(&conf->gen, newextra))
6048 struct config_string *conf = (struct config_string *) record;
6050 void *newextra = NULL;
6054 if (!validate_conf_option(record, name, value, source,
6055 elevel, false, &newval,
6059 else if (source == PGC_S_DEFAULT)
6061 /* non-NULL boot_val must always get strdup'd */
6062 if (conf->boot_val != NULL)
6064 newval = guc_strdup(elevel, conf->boot_val);
6071 if (!call_string_check_hook(conf, &newval, &newextra,
6081 * strdup not needed, since reset_val is already under
6084 newval = conf->reset_val;
6085 newextra = conf->reset_extra;
6086 source = conf->gen.reset_source;
6087 context = conf->gen.reset_scontext;
6090 if (prohibitValueChange)
6092 /* newval shouldn't be NULL, so we're a bit sloppy here */
6093 if (*conf->variable == NULL || newval == NULL ||
6094 strcmp(*conf->variable, newval) != 0)
6097 (errcode(ERRCODE_CANT_CHANGE_RUNTIME_PARAM),
6098 errmsg("parameter \"%s\" cannot be changed without restarting the server",
6107 /* Save old value to support transaction abort */
6109 push_old_value(&conf->gen, action);
6111 if (conf->assign_hook)
6112 (*conf->assign_hook) (newval, newextra);
6113 set_string_field(conf, conf->variable, newval);
6114 set_extra_field(&conf->gen, &conf->gen.extra,
6116 conf->gen.source = source;
6117 conf->gen.scontext = context;
6124 if (conf->gen.reset_source <= source)
6126 set_string_field(conf, &conf->reset_val, newval);
6127 set_extra_field(&conf->gen, &conf->reset_extra,
6129 conf->gen.reset_source = source;
6130 conf->gen.reset_scontext = context;
6132 for (stack = conf->gen.stack; stack; stack = stack->prev)
6134 if (stack->source <= source)
6136 set_string_field(conf, &stack->prior.val.stringval,
6138 set_extra_field(&conf->gen, &stack->prior.extra,
6140 stack->source = source;
6141 stack->scontext = context;
6146 /* Perhaps we didn't install newval anywhere */
6147 if (newval && !string_field_used(conf, newval))
6149 /* Perhaps we didn't install newextra anywhere */
6150 if (newextra && !extra_field_used(&conf->gen, newextra))
6157 struct config_enum *conf = (struct config_enum *) record;
6159 void *newextra = NULL;
6163 if (!validate_conf_option(record, name, value, source,
6164 elevel, false, &newval,
6168 else if (source == PGC_S_DEFAULT)
6170 newval = conf->boot_val;
6171 if (!call_enum_check_hook(conf, &newval, &newextra,
6177 newval = conf->reset_val;
6178 newextra = conf->reset_extra;
6179 source = conf->gen.reset_source;
6180 context = conf->gen.reset_scontext;
6183 if (prohibitValueChange)
6185 if (*conf->variable != newval)
6188 (errcode(ERRCODE_CANT_CHANGE_RUNTIME_PARAM),
6189 errmsg("parameter \"%s\" cannot be changed without restarting the server",
6198 /* Save old value to support transaction abort */
6200 push_old_value(&conf->gen, action);
6202 if (conf->assign_hook)
6203 (*conf->assign_hook) (newval, newextra);
6204 *conf->variable = newval;
6205 set_extra_field(&conf->gen, &conf->gen.extra,
6207 conf->gen.source = source;
6208 conf->gen.scontext = context;
6214 if (conf->gen.reset_source <= source)
6216 conf->reset_val = newval;
6217 set_extra_field(&conf->gen, &conf->reset_extra,
6219 conf->gen.reset_source = source;
6220 conf->gen.reset_scontext = context;
6222 for (stack = conf->gen.stack; stack; stack = stack->prev)
6224 if (stack->source <= source)
6226 stack->prior.val.enumval = newval;
6227 set_extra_field(&conf->gen, &stack->prior.extra,
6229 stack->source = source;
6230 stack->scontext = context;
6235 /* Perhaps we didn't install newextra anywhere */
6236 if (newextra && !extra_field_used(&conf->gen, newextra))
6242 if (changeVal && (record->flags & GUC_REPORT))
6243 ReportGUCOption(record);
6245 return changeVal ? 1 : -1;
6250 * Set the fields for source file and line number the setting came from.
6253 set_config_sourcefile(const char *name, char *sourcefile, int sourceline)
6255 struct config_generic *record;
6259 * To avoid cluttering the log, only the postmaster bleats loudly about
6260 * problems with the config file.
6262 elevel = IsUnderPostmaster ? DEBUG3 : LOG;
6264 record = find_option(name, true, elevel);
6265 /* should not happen */
6267 elog(ERROR, "unrecognized configuration parameter \"%s\"", name);
6269 sourcefile = guc_strdup(elevel, sourcefile);
6270 if (record->sourcefile)
6271 free(record->sourcefile);
6272 record->sourcefile = sourcefile;
6273 record->sourceline = sourceline;
6277 * Set a config option to the given value.
6279 * See also set_config_option; this is just the wrapper to be called from
6280 * outside GUC. (This function should be used when possible, because its API
6281 * is more stable than set_config_option's.)
6283 * Note: there is no support here for setting source file/line, as it
6284 * is currently not needed.
6287 SetConfigOption(const char *name, const char *value,
6288 GucContext context, GucSource source)
6290 (void) set_config_option(name, value, context, source,
6291 GUC_ACTION_SET, true, 0);
6297 * Fetch the current value of the option `name', as a string.
6299 * If the option doesn't exist, return NULL if missing_ok is true (NOTE that
6300 * this cannot be distinguished from a string variable with a NULL value!),
6301 * otherwise throw an ereport and don't return.
6303 * If restrict_superuser is true, we also enforce that only superusers can
6304 * see GUC_SUPERUSER_ONLY variables. This should only be passed as true
6305 * in user-driven calls.
6307 * The string is *not* allocated for modification and is really only
6308 * valid until the next call to configuration related functions.
6311 GetConfigOption(const char *name, bool missing_ok, bool restrict_superuser)
6313 struct config_generic *record;
6314 static char buffer[256];
6316 record = find_option(name, false, ERROR);
6322 (errcode(ERRCODE_UNDEFINED_OBJECT),
6323 errmsg("unrecognized configuration parameter \"%s\"",
6326 if (restrict_superuser &&
6327 (record->flags & GUC_SUPERUSER_ONLY) &&
6330 (errcode(ERRCODE_INSUFFICIENT_PRIVILEGE),
6331 errmsg("must be superuser to examine \"%s\"", name)));
6333 switch (record->vartype)
6336 return *((struct config_bool *) record)->variable ? "on" : "off";
6339 snprintf(buffer, sizeof(buffer), "%d",
6340 *((struct config_int *) record)->variable);
6344 snprintf(buffer, sizeof(buffer), "%g",
6345 *((struct config_real *) record)->variable);
6349 return *((struct config_string *) record)->variable;
6352 return config_enum_lookup_by_value((struct config_enum *) record,
6353 *((struct config_enum *) record)->variable);
6359 * Get the RESET value associated with the given option.
6361 * Note: this is not re-entrant, due to use of static result buffer;
6362 * not to mention that a string variable could have its reset_val changed.
6363 * Beware of assuming the result value is good for very long.
6366 GetConfigOptionResetString(const char *name)
6368 struct config_generic *record;
6369 static char buffer[256];
6371 record = find_option(name, false, ERROR);
6374 (errcode(ERRCODE_UNDEFINED_OBJECT),
6375 errmsg("unrecognized configuration parameter \"%s\"", name)));
6376 if ((record->flags & GUC_SUPERUSER_ONLY) && !superuser())
6378 (errcode(ERRCODE_INSUFFICIENT_PRIVILEGE),
6379 errmsg("must be superuser to examine \"%s\"", name)));
6381 switch (record->vartype)
6384 return ((struct config_bool *) record)->reset_val ? "on" : "off";
6387 snprintf(buffer, sizeof(buffer), "%d",
6388 ((struct config_int *) record)->reset_val);
6392 snprintf(buffer, sizeof(buffer), "%g",
6393 ((struct config_real *) record)->reset_val);
6397 return ((struct config_string *) record)->reset_val;
6400 return config_enum_lookup_by_value((struct config_enum *) record,
6401 ((struct config_enum *) record)->reset_val);
6408 * flatten_set_variable_args
6409 * Given a parsenode List as emitted by the grammar for SET,
6410 * convert to the flat string representation used by GUC.
6412 * We need to be told the name of the variable the args are for, because
6413 * the flattening rules vary (ugh).
6415 * The result is NULL if args is NIL (ie, SET ... TO DEFAULT), otherwise
6416 * a palloc'd string.
6419 flatten_set_variable_args(const char *name, List *args)
6421 struct config_generic *record;
6426 /* Fast path if just DEFAULT */
6431 * Get flags for the variable; if it's not known, use default flags.
6432 * (Caller might throw error later, but not our business to do so here.)
6434 record = find_option(name, false, WARNING);
6436 flags = record->flags;
6440 /* Complain if list input and non-list variable */
6441 if ((flags & GUC_LIST_INPUT) == 0 &&
6442 list_length(args) != 1)
6444 (errcode(ERRCODE_INVALID_PARAMETER_VALUE),
6445 errmsg("SET %s takes only one argument", name)));
6447 initStringInfo(&buf);
6450 * Each list member may be a plain A_Const node, or an A_Const within a
6451 * TypeCast; the latter case is supported only for ConstInterval arguments
6452 * (for SET TIME ZONE).
6456 Node *arg = (Node *) lfirst(l);
6458 TypeName *typeName = NULL;
6461 if (l != list_head(args))
6462 appendStringInfoString(&buf, ", ");
6464 if (IsA(arg, TypeCast))
6466 TypeCast *tc = (TypeCast *) arg;
6469 typeName = tc->typeName;
6472 if (!IsA(arg, A_Const))
6473 elog(ERROR, "unrecognized node type: %d", (int) nodeTag(arg));
6474 con = (A_Const *) arg;
6476 switch (nodeTag(&con->val))
6479 appendStringInfo(&buf, "%ld", intVal(&con->val));
6482 /* represented as a string, so just copy it */
6483 appendStringInfoString(&buf, strVal(&con->val));
6486 val = strVal(&con->val);
6487 if (typeName != NULL)
6490 * Must be a ConstInterval argument for TIME ZONE. Coerce
6491 * to interval and back to normalize the value and account
6499 typenameTypeIdAndMod(NULL, typeName, &typoid, &typmod);
6500 Assert(typoid == INTERVALOID);
6503 DirectFunctionCall3(interval_in,
6504 CStringGetDatum(val),
6505 ObjectIdGetDatum(InvalidOid),
6506 Int32GetDatum(typmod));
6509 DatumGetCString(DirectFunctionCall1(interval_out,
6511 appendStringInfo(&buf, "INTERVAL '%s'", intervalout);
6516 * Plain string literal or identifier. For quote mode,
6517 * quote it if it's not a vanilla identifier.
6519 if (flags & GUC_LIST_QUOTE)
6520 appendStringInfoString(&buf, quote_identifier(val));
6522 appendStringInfoString(&buf, val);
6526 elog(ERROR, "unrecognized node type: %d",
6527 (int) nodeTag(&con->val));
6536 * Write updated configuration parameter values into a temporary file.
6537 * This function traverses the list of parameters and quotes the string
6538 * values before writing them.
6541 write_auto_conf_file(int fd, const char *filename, ConfigVariable **head_p)
6543 ConfigVariable *item;
6546 initStringInfo(&buf);
6547 appendStringInfoString(&buf, "# Do not edit this file manually!\n");
6548 appendStringInfoString(&buf, "# It will be overwritten by ALTER SYSTEM command.\n");
6551 * write the file header message before contents, so that if there is no
6552 * item it can contain message
6554 if (write(fd, buf.data, buf.len) < 0)
6556 (errmsg("failed to write to \"%s\" file", filename)));
6557 resetStringInfo(&buf);
6560 * traverse the list of parameters, quote the string parameter and write
6561 * it to file. Once all parameters are written fsync the file.
6564 for (item = *head_p; item != NULL; item = item->next)
6568 appendStringInfoString(&buf, item->name);
6569 appendStringInfoString(&buf, " = ");
6571 appendStringInfoString(&buf, "\'");
6572 escaped = escape_single_quotes_ascii(item->value);
6573 appendStringInfoString(&buf, escaped);
6575 appendStringInfoString(&buf, "\'");
6577 appendStringInfoString(&buf, "\n");
6579 if (write(fd, buf.data, buf.len) < 0)
6581 (errmsg("failed to write to \"%s\" file", filename)));
6582 resetStringInfo(&buf);
6585 if (pg_fsync(fd) != 0)
6587 (errcode_for_file_access(),
6588 errmsg("could not fsync file \"%s\": %m", filename)));
6595 * This function takes list of all configuration parameters in
6596 * PG_AUTOCONF_FILENAME and parameter to be updated as input arguments and
6597 * replace the updated configuration parameter value in a list. If the
6598 * parameter to be updated is new then it is appended to the list of
6602 replace_auto_config_value(ConfigVariable **head_p, ConfigVariable **tail_p,
6604 char *name, char *value)
6606 ConfigVariable *item,
6609 if (*head_p != NULL)
6611 for (item = *head_p; item != NULL; item = item->next)
6613 if (strcmp(item->name, name) == 0)
6617 /* update the parameter value */
6618 item->value = pstrdup(value);
6621 /* delete the configuration parameter from list */
6622 if (*head_p == item)
6623 *head_p = item->next;
6625 prev->next = item->next;
6627 if (*tail_p == item)
6631 pfree(item->filename);
6643 item = palloc(sizeof *item);
6644 item->name = pstrdup(name);
6645 item->value = pstrdup(value);
6646 item->filename = pstrdup(config_file);
6649 if (*head_p == NULL)
6651 item->sourceline = 1;
6656 item->sourceline = (*tail_p)->sourceline + 1;
6657 (*tail_p)->next = item;
6667 * Persist the configuration parameter value.
6669 * This function takes all previous configuration parameters
6670 * set by ALTER SYSTEM command and the currently set ones
6671 * and write them all to the automatic configuration file.
6673 * The configuration parameters are written to a temporary
6674 * file then renamed to the final name.
6676 * An LWLock is used to serialize writing to the same file.
6678 * In case of an error, we leave the original automatic
6679 * configuration file (PG_AUTOCONF_FILENAME) intact.
6682 AlterSystemSetConfigFile(AlterSystemStmt * altersysstmt)
6688 struct config_generic *record;
6689 ConfigVariable *head = NULL;
6690 ConfigVariable *tail = NULL;
6691 char AutoConfFileName[MAXPGPATH];
6692 char AutoConfTmpFileName[MAXPGPATH];
6694 void *newextra = NULL;
6698 (errcode(ERRCODE_INSUFFICIENT_PRIVILEGE),
6699 (errmsg("must be superuser to execute ALTER SYSTEM command"))));
6702 * Validate the name and arguments [value1, value2 ... ].
6704 name = altersysstmt->setstmt->name;
6706 switch (altersysstmt->setstmt->kind)
6709 value = ExtractSetVariableArgs(altersysstmt->setstmt);
6712 case VAR_SET_DEFAULT:
6716 elog(ERROR, "unrecognized alter system stmt type: %d",
6717 altersysstmt->setstmt->kind);
6721 record = find_option(name, false, LOG);
6724 (errcode(ERRCODE_UNDEFINED_OBJECT),
6725 errmsg("unrecognized configuration parameter \"%s\"", name)));
6727 if ((record->context == PGC_INTERNAL) ||
6728 (record->flags & GUC_DISALLOW_IN_FILE))
6730 (errcode(ERRCODE_CANT_CHANGE_RUNTIME_PARAM),
6731 errmsg("parameter \"%s\" cannot be changed",
6734 if (!validate_conf_option(record, name, value, PGC_S_FILE,
6738 (errmsg("invalid value for parameter \"%s\": \"%s\"", name, value)));
6742 * Use data directory as reference path for PG_AUTOCONF_FILENAME and its
6743 * corresponding temporary file.
6745 join_path_components(AutoConfFileName, data_directory, PG_AUTOCONF_FILENAME);
6746 canonicalize_path(AutoConfFileName);
6747 snprintf(AutoConfTmpFileName, sizeof(AutoConfTmpFileName), "%s.%s",
6752 * One backend is allowed to operate on file PG_AUTOCONF_FILENAME, to
6753 * ensure that we need to update the contents of the file with
6754 * AutoFileLock. To ensure crash safety, first the contents are written to
6755 * a temporary file which is then renameed to PG_AUTOCONF_FILENAME. In case
6756 * there exists a temp file from previous crash, that can be reused.
6759 LWLockAcquire(AutoFileLock, LW_EXCLUSIVE);
6761 Tmpfd = open(AutoConfTmpFileName, O_CREAT | O_RDWR | O_TRUNC, S_IRUSR | S_IWUSR);
6764 (errcode_for_file_access(),
6765 errmsg("failed to open auto conf temp file \"%s\": %m ",
6766 AutoConfTmpFileName)));
6770 if (stat(AutoConfFileName, &st) == 0)
6772 /* open file PG_AUTOCONF_FILENAME */
6773 infile = AllocateFile(AutoConfFileName, "r");
6776 (errmsg("failed to open auto conf file \"%s\": %m ",
6777 AutoConfFileName)));
6780 ParseConfigFp(infile, AutoConfFileName, 0, LOG, &head, &tail);
6786 * replace with new value if the configuration parameter already
6787 * exists OR add it as a new cofiguration parameter in the file.
6789 replace_auto_config_value(&head, &tail, AutoConfFileName, name, value);
6791 /* Write and sync the new contents to the temporary file */
6792 write_auto_conf_file(Tmpfd, AutoConfTmpFileName, &head);
6798 * As the rename is atomic operation, if any problem occurs after this
6799 * at max it can loose the parameters set by last ALTER SYSTEM
6802 if (rename(AutoConfTmpFileName, AutoConfFileName) < 0)
6804 (errcode_for_file_access(),
6805 errmsg("could not rename file \"%s\" to \"%s\" : %m",
6806 AutoConfTmpFileName, AutoConfFileName)));
6813 unlink(AutoConfTmpFileName);
6814 FreeConfigVariables(head);
6819 FreeConfigVariables(head);
6820 LWLockRelease(AutoFileLock);
6828 ExecSetVariableStmt(VariableSetStmt *stmt, bool isTopLevel)
6830 GucAction action = stmt->is_local ? GUC_ACTION_LOCAL : GUC_ACTION_SET;
6835 case VAR_SET_CURRENT:
6837 WarnNoTransactionChain(isTopLevel, "SET LOCAL");
6838 (void) set_config_option(stmt->name,
6839 ExtractSetVariableArgs(stmt),
6840 (superuser() ? PGC_SUSET : PGC_USERSET),
6848 * Special-case SQL syntaxes. The TRANSACTION and SESSION
6849 * CHARACTERISTICS cases effectively set more than one variable
6850 * per statement. TRANSACTION SNAPSHOT only takes one argument,
6851 * but we put it here anyway since it's a special case and not
6852 * related to any GUC variable.
6854 if (strcmp(stmt->name, "TRANSACTION") == 0)
6858 WarnNoTransactionChain(isTopLevel, "SET TRANSACTION");
6860 foreach(head, stmt->args)
6862 DefElem *item = (DefElem *) lfirst(head);
6864 if (strcmp(item->defname, "transaction_isolation") == 0)
6865 SetPGVariable("transaction_isolation",
6866 list_make1(item->arg), stmt->is_local);
6867 else if (strcmp(item->defname, "transaction_read_only") == 0)
6868 SetPGVariable("transaction_read_only",
6869 list_make1(item->arg), stmt->is_local);
6870 else if (strcmp(item->defname, "transaction_deferrable") == 0)
6871 SetPGVariable("transaction_deferrable",
6872 list_make1(item->arg), stmt->is_local);
6874 elog(ERROR, "unexpected SET TRANSACTION element: %s",
6878 else if (strcmp(stmt->name, "SESSION CHARACTERISTICS") == 0)
6882 foreach(head, stmt->args)
6884 DefElem *item = (DefElem *) lfirst(head);
6886 if (strcmp(item->defname, "transaction_isolation") == 0)
6887 SetPGVariable("default_transaction_isolation",
6888 list_make1(item->arg), stmt->is_local);
6889 else if (strcmp(item->defname, "transaction_read_only") == 0)
6890 SetPGVariable("default_transaction_read_only",
6891 list_make1(item->arg), stmt->is_local);
6892 else if (strcmp(item->defname, "transaction_deferrable") == 0)
6893 SetPGVariable("default_transaction_deferrable",
6894 list_make1(item->arg), stmt->is_local);
6896 elog(ERROR, "unexpected SET SESSION element: %s",
6900 else if (strcmp(stmt->name, "TRANSACTION SNAPSHOT") == 0)
6902 A_Const *con = (A_Const *) linitial(stmt->args);
6906 (errcode(ERRCODE_FEATURE_NOT_SUPPORTED),
6907 errmsg("SET LOCAL TRANSACTION SNAPSHOT is not implemented")));
6909 WarnNoTransactionChain(isTopLevel, "SET TRANSACTION");
6910 Assert(IsA(con, A_Const));
6911 Assert(nodeTag(&con->val) == T_String);
6912 ImportSnapshot(strVal(&con->val));
6915 elog(ERROR, "unexpected SET MULTI element: %s",
6918 case VAR_SET_DEFAULT:
6920 WarnNoTransactionChain(isTopLevel, "SET LOCAL");
6923 if (strcmp(stmt->name, "transaction_isolation") == 0)
6924 WarnNoTransactionChain(isTopLevel, "RESET TRANSACTION");
6926 (void) set_config_option(stmt->name,
6928 (superuser() ? PGC_SUSET : PGC_USERSET),
6941 * Get the value to assign for a VariableSetStmt, or NULL if it's RESET.
6942 * The result is palloc'd.
6944 * This is exported for use by actions such as ALTER ROLE SET.
6947 ExtractSetVariableArgs(VariableSetStmt *stmt)
6952 return flatten_set_variable_args(stmt->name, stmt->args);
6953 case VAR_SET_CURRENT:
6954 return GetConfigOptionByName(stmt->name, NULL);
6961 * SetPGVariable - SET command exported as an easily-C-callable function.
6963 * This provides access to SET TO value, as well as SET TO DEFAULT (expressed
6964 * by passing args == NIL), but not SET FROM CURRENT functionality.
6967 SetPGVariable(const char *name, List *args, bool is_local)
6969 char *argstring = flatten_set_variable_args(name, args);
6971 /* Note SET DEFAULT (argstring == NULL) is equivalent to RESET */
6972 (void) set_config_option(name,
6974 (superuser() ? PGC_SUSET : PGC_USERSET),
6976 is_local ? GUC_ACTION_LOCAL : GUC_ACTION_SET,
6982 * SET command wrapped as a SQL callable function.
6985 set_config_by_name(PG_FUNCTION_ARGS)
6992 if (PG_ARGISNULL(0))
6994 (errcode(ERRCODE_NULL_VALUE_NOT_ALLOWED),
6995 errmsg("SET requires parameter name")));
6997 /* Get the GUC variable name */
6998 name = TextDatumGetCString(PG_GETARG_DATUM(0));
7000 /* Get the desired value or set to NULL for a reset request */
7001 if (PG_ARGISNULL(1))
7004 value = TextDatumGetCString(PG_GETARG_DATUM(1));
7007 * Get the desired state of is_local. Default to false if provided value
7010 if (PG_ARGISNULL(2))
7013 is_local = PG_GETARG_BOOL(2);
7015 /* Note SET DEFAULT (argstring == NULL) is equivalent to RESET */
7016 (void) set_config_option(name,
7018 (superuser() ? PGC_SUSET : PGC_USERSET),
7020 is_local ? GUC_ACTION_LOCAL : GUC_ACTION_SET,
7024 /* get the new current value */
7025 new_value = GetConfigOptionByName(name, NULL);
7027 /* Convert return string to text */
7028 PG_RETURN_TEXT_P(cstring_to_text(new_value));
7033 * Common code for DefineCustomXXXVariable subroutines: allocate the
7034 * new variable's config struct and fill in generic fields.
7036 static struct config_generic *
7037 init_custom_variable(const char *name,
7038 const char *short_desc,
7039 const char *long_desc,
7042 enum config_type type,
7045 struct config_generic *gen;
7048 * Only allow custom PGC_POSTMASTER variables to be created during shared
7049 * library preload; any later than that, we can't ensure that the value
7050 * doesn't change after startup. This is a fatal elog if it happens; just
7051 * erroring out isn't safe because we don't know what the calling loadable
7052 * module might already have hooked into.
7054 if (context == PGC_POSTMASTER &&
7055 !process_shared_preload_libraries_in_progress)
7056 elog(FATAL, "cannot create PGC_POSTMASTER variables after startup");
7058 gen = (struct config_generic *) guc_malloc(ERROR, sz);
7061 gen->name = guc_strdup(ERROR, name);
7062 gen->context = context;
7063 gen->group = CUSTOM_OPTIONS;
7064 gen->short_desc = short_desc;
7065 gen->long_desc = long_desc;
7067 gen->vartype = type;
7073 * Common code for DefineCustomXXXVariable subroutines: insert the new
7074 * variable into the GUC variable array, replacing any placeholder.
7077 define_custom_variable(struct config_generic * variable)
7079 const char *name = variable->name;
7080 const char **nameAddr = &name;
7081 struct config_string *pHolder;
7082 struct config_generic **res;
7085 * See if there's a placeholder by the same name.
7087 res = (struct config_generic **) bsearch((void *) &nameAddr,
7088 (void *) guc_variables,
7090 sizeof(struct config_generic *),
7095 * No placeholder to replace, so we can just add it ... but first,
7096 * make sure it's initialized to its default value.
7098 InitializeOneGUCOption(variable);
7099 add_guc_variable(variable, ERROR);
7104 * This better be a placeholder
7106 if (((*res)->flags & GUC_CUSTOM_PLACEHOLDER) == 0)
7108 (errcode(ERRCODE_INTERNAL_ERROR),
7109 errmsg("attempt to redefine parameter \"%s\"", name)));
7111 Assert((*res)->vartype == PGC_STRING);
7112 pHolder = (struct config_string *) (*res);
7115 * First, set the variable to its default value. We must do this even
7116 * though we intend to immediately apply a new value, since it's possible
7117 * that the new value is invalid.
7119 InitializeOneGUCOption(variable);
7122 * Replace the placeholder. We aren't changing the name, so no re-sorting
7128 * Assign the string value(s) stored in the placeholder to the real
7129 * variable. Essentially, we need to duplicate all the active and stacked
7130 * values, but with appropriate validation and datatype adjustment.
7132 * If an assignment fails, we report a WARNING and keep going. We don't
7133 * want to throw ERROR for bad values, because it'd bollix the add-on
7134 * module that's presumably halfway through getting loaded. In such cases
7135 * the default or previous state will become active instead.
7138 /* First, apply the reset value if any */
7139 if (pHolder->reset_val)
7140 (void) set_config_option(name, pHolder->reset_val,
7141 pHolder->gen.reset_scontext,
7142 pHolder->gen.reset_source,
7143 GUC_ACTION_SET, true, WARNING);
7144 /* That should not have resulted in stacking anything */
7145 Assert(variable->stack == NULL);
7147 /* Now, apply current and stacked values, in the order they were stacked */
7148 reapply_stacked_values(variable, pHolder, pHolder->gen.stack,
7149 *(pHolder->variable),
7150 pHolder->gen.scontext, pHolder->gen.source);
7152 /* Also copy over any saved source-location information */
7153 if (pHolder->gen.sourcefile)
7154 set_config_sourcefile(name, pHolder->gen.sourcefile,
7155 pHolder->gen.sourceline);
7158 * Free up as much as we conveniently can of the placeholder structure.
7159 * (This neglects any stack items, so it's possible for some memory to be
7160 * leaked. Since this can only happen once per session per variable, it
7161 * doesn't seem worth spending much code on.)
7163 set_string_field(pHolder, pHolder->variable, NULL);
7164 set_string_field(pHolder, &pHolder->reset_val, NULL);
7170 * Recursive subroutine for define_custom_variable: reapply non-reset values
7172 * We recurse so that the values are applied in the same order as originally.
7173 * At each recursion level, apply the upper-level value (passed in) in the
7174 * fashion implied by the stack entry.
7177 reapply_stacked_values(struct config_generic * variable,
7178 struct config_string * pHolder,
7180 const char *curvalue,
7181 GucContext curscontext, GucSource cursource)
7183 const char *name = variable->name;
7184 GucStack *oldvarstack = variable->stack;
7188 /* First, recurse, so that stack items are processed bottom to top */
7189 reapply_stacked_values(variable, pHolder, stack->prev,
7190 stack->prior.val.stringval,
7191 stack->scontext, stack->source);
7193 /* See how to apply the passed-in value */
7194 switch (stack->state)
7197 (void) set_config_option(name, curvalue,
7198 curscontext, cursource,
7199 GUC_ACTION_SAVE, true, WARNING);
7203 (void) set_config_option(name, curvalue,
7204 curscontext, cursource,
7205 GUC_ACTION_SET, true, WARNING);
7209 (void) set_config_option(name, curvalue,
7210 curscontext, cursource,
7211 GUC_ACTION_LOCAL, true, WARNING);
7215 /* first, apply the masked value as SET */
7216 (void) set_config_option(name, stack->masked.val.stringval,
7217 stack->masked_scontext, PGC_S_SESSION,
7218 GUC_ACTION_SET, true, WARNING);
7219 /* then apply the current value as LOCAL */
7220 (void) set_config_option(name, curvalue,
7221 curscontext, cursource,
7222 GUC_ACTION_LOCAL, true, WARNING);
7226 /* If we successfully made a stack entry, adjust its nest level */
7227 if (variable->stack != oldvarstack)
7228 variable->stack->nest_level = stack->nest_level;
7233 * We are at the end of the stack. If the active/previous value is
7234 * different from the reset value, it must represent a previously
7235 * committed session value. Apply it, and then drop the stack entry
7236 * that set_config_option will have created under the impression that
7237 * this is to be just a transactional assignment. (We leak the stack
7240 if (curvalue != pHolder->reset_val ||
7241 curscontext != pHolder->gen.reset_scontext ||
7242 cursource != pHolder->gen.reset_source)
7244 (void) set_config_option(name, curvalue,
7245 curscontext, cursource,
7246 GUC_ACTION_SET, true, WARNING);
7247 variable->stack = NULL;
7253 DefineCustomBoolVariable(const char *name,
7254 const char *short_desc,
7255 const char *long_desc,
7260 GucBoolCheckHook check_hook,
7261 GucBoolAssignHook assign_hook,
7262 GucShowHook show_hook)
7264 struct config_bool *var;
7266 var = (struct config_bool *)
7267 init_custom_variable(name, short_desc, long_desc, context, flags,
7268 PGC_BOOL, sizeof(struct config_bool));
7269 var->variable = valueAddr;
7270 var->boot_val = bootValue;
7271 var->reset_val = bootValue;
7272 var->check_hook = check_hook;
7273 var->assign_hook = assign_hook;
7274 var->show_hook = show_hook;
7275 define_custom_variable(&var->gen);
7279 DefineCustomIntVariable(const char *name,
7280 const char *short_desc,
7281 const char *long_desc,
7288 GucIntCheckHook check_hook,
7289 GucIntAssignHook assign_hook,
7290 GucShowHook show_hook)
7292 struct config_int *var;
7294 var = (struct config_int *)
7295 init_custom_variable(name, short_desc, long_desc, context, flags,
7296 PGC_INT, sizeof(struct config_int));
7297 var->variable = valueAddr;
7298 var->boot_val = bootValue;
7299 var->reset_val = bootValue;
7300 var->min = minValue;
7301 var->max = maxValue;
7302 var->check_hook = check_hook;
7303 var->assign_hook = assign_hook;
7304 var->show_hook = show_hook;
7305 define_custom_variable(&var->gen);
7309 DefineCustomRealVariable(const char *name,
7310 const char *short_desc,
7311 const char *long_desc,
7318 GucRealCheckHook check_hook,
7319 GucRealAssignHook assign_hook,
7320 GucShowHook show_hook)
7322 struct config_real *var;
7324 var = (struct config_real *)
7325 init_custom_variable(name, short_desc, long_desc, context, flags,
7326 PGC_REAL, sizeof(struct config_real));
7327 var->variable = valueAddr;
7328 var->boot_val = bootValue;
7329 var->reset_val = bootValue;
7330 var->min = minValue;
7331 var->max = maxValue;
7332 var->check_hook = check_hook;
7333 var->assign_hook = assign_hook;
7334 var->show_hook = show_hook;
7335 define_custom_variable(&var->gen);
7339 DefineCustomStringVariable(const char *name,
7340 const char *short_desc,
7341 const char *long_desc,
7343 const char *bootValue,
7346 GucStringCheckHook check_hook,
7347 GucStringAssignHook assign_hook,
7348 GucShowHook show_hook)
7350 struct config_string *var;
7352 var = (struct config_string *)
7353 init_custom_variable(name, short_desc, long_desc, context, flags,
7354 PGC_STRING, sizeof(struct config_string));
7355 var->variable = valueAddr;
7356 var->boot_val = bootValue;
7357 var->check_hook = check_hook;
7358 var->assign_hook = assign_hook;
7359 var->show_hook = show_hook;
7360 define_custom_variable(&var->gen);
7364 DefineCustomEnumVariable(const char *name,
7365 const char *short_desc,
7366 const char *long_desc,
7369 const struct config_enum_entry * options,
7372 GucEnumCheckHook check_hook,
7373 GucEnumAssignHook assign_hook,
7374 GucShowHook show_hook)
7376 struct config_enum *var;
7378 var = (struct config_enum *)
7379 init_custom_variable(name, short_desc, long_desc, context, flags,
7380 PGC_ENUM, sizeof(struct config_enum));
7381 var->variable = valueAddr;
7382 var->boot_val = bootValue;
7383 var->reset_val = bootValue;
7384 var->options = options;
7385 var->check_hook = check_hook;
7386 var->assign_hook = assign_hook;
7387 var->show_hook = show_hook;
7388 define_custom_variable(&var->gen);
7392 EmitWarningsOnPlaceholders(const char *className)
7394 int classLen = strlen(className);
7397 for (i = 0; i < num_guc_variables; i++)
7399 struct config_generic *var = guc_variables[i];
7401 if ((var->flags & GUC_CUSTOM_PLACEHOLDER) != 0 &&
7402 strncmp(className, var->name, classLen) == 0 &&
7403 var->name[classLen] == GUC_QUALIFIER_SEPARATOR)
7406 (errcode(ERRCODE_UNDEFINED_OBJECT),
7407 errmsg("unrecognized configuration parameter \"%s\"",
7418 GetPGVariable(const char *name, DestReceiver *dest)
7420 if (guc_name_compare(name, "all") == 0)
7421 ShowAllGUCConfig(dest);
7423 ShowGUCConfigOption(name, dest);
7427 GetPGVariableResultDesc(const char *name)
7431 if (guc_name_compare(name, "all") == 0)
7433 /* need a tuple descriptor representing three TEXT columns */
7434 tupdesc = CreateTemplateTupleDesc(3, false);
7435 TupleDescInitEntry(tupdesc, (AttrNumber) 1, "name",
7437 TupleDescInitEntry(tupdesc, (AttrNumber) 2, "setting",
7439 TupleDescInitEntry(tupdesc, (AttrNumber) 3, "description",
7444 const char *varname;
7446 /* Get the canonical spelling of name */
7447 (void) GetConfigOptionByName(name, &varname);
7449 /* need a tuple descriptor representing a single TEXT column */
7450 tupdesc = CreateTemplateTupleDesc(1, false);
7451 TupleDescInitEntry(tupdesc, (AttrNumber) 1, varname,
7462 ShowGUCConfigOption(const char *name, DestReceiver *dest)
7464 TupOutputState *tstate;
7466 const char *varname;
7469 /* Get the value and canonical spelling of name */
7470 value = GetConfigOptionByName(name, &varname);
7472 /* need a tuple descriptor representing a single TEXT column */
7473 tupdesc = CreateTemplateTupleDesc(1, false);
7474 TupleDescInitEntry(tupdesc, (AttrNumber) 1, varname,
7477 /* prepare for projection of tuples */
7478 tstate = begin_tup_output_tupdesc(dest, tupdesc);
7481 do_text_output_oneline(tstate, value);
7483 end_tup_output(tstate);
7490 ShowAllGUCConfig(DestReceiver *dest)
7492 bool am_superuser = superuser();
7494 TupOutputState *tstate;
7497 bool isnull[3] = {false, false, false};
7499 /* need a tuple descriptor representing three TEXT columns */
7500 tupdesc = CreateTemplateTupleDesc(3, false);
7501 TupleDescInitEntry(tupdesc, (AttrNumber) 1, "name",
7503 TupleDescInitEntry(tupdesc, (AttrNumber) 2, "setting",
7505 TupleDescInitEntry(tupdesc, (AttrNumber) 3, "description",
7508 /* prepare for projection of tuples */
7509 tstate = begin_tup_output_tupdesc(dest, tupdesc);
7511 for (i = 0; i < num_guc_variables; i++)
7513 struct config_generic *conf = guc_variables[i];
7516 if ((conf->flags & GUC_NO_SHOW_ALL) ||
7517 ((conf->flags & GUC_SUPERUSER_ONLY) && !am_superuser))
7520 /* assign to the values array */
7521 values[0] = PointerGetDatum(cstring_to_text(conf->name));
7523 setting = _ShowOption(conf, true);
7526 values[1] = PointerGetDatum(cstring_to_text(setting));
7531 values[1] = PointerGetDatum(NULL);
7535 values[2] = PointerGetDatum(cstring_to_text(conf->short_desc));
7537 /* send it to dest */
7538 do_tup_output(tstate, values, isnull);
7541 pfree(DatumGetPointer(values[0]));
7545 pfree(DatumGetPointer(values[1]));
7547 pfree(DatumGetPointer(values[2]));
7550 end_tup_output(tstate);
7554 * Return GUC variable value by name; optionally return canonical
7555 * form of name. Return value is palloc'd.
7558 GetConfigOptionByName(const char *name, const char **varname)
7560 struct config_generic *record;
7562 record = find_option(name, false, ERROR);
7565 (errcode(ERRCODE_UNDEFINED_OBJECT),
7566 errmsg("unrecognized configuration parameter \"%s\"", name)));
7567 if ((record->flags & GUC_SUPERUSER_ONLY) && !superuser())
7569 (errcode(ERRCODE_INSUFFICIENT_PRIVILEGE),
7570 errmsg("must be superuser to examine \"%s\"", name)));
7573 *varname = record->name;
7575 return _ShowOption(record, true);
7579 * Return GUC variable value by variable number; optionally return canonical
7580 * form of name. Return value is palloc'd.
7583 GetConfigOptionByNum(int varnum, const char **values, bool *noshow)
7586 struct config_generic *conf;
7588 /* check requested variable number valid */
7589 Assert((varnum >= 0) && (varnum < num_guc_variables));
7591 conf = guc_variables[varnum];
7595 if ((conf->flags & GUC_NO_SHOW_ALL) ||
7596 ((conf->flags & GUC_SUPERUSER_ONLY) && !superuser()))
7602 /* first get the generic attributes */
7605 values[0] = conf->name;
7607 /* setting : use _ShowOption in order to avoid duplicating the logic */
7608 values[1] = _ShowOption(conf, false);
7611 if (conf->vartype == PGC_INT)
7615 switch (conf->flags & (GUC_UNIT_MEMORY | GUC_UNIT_TIME))
7620 case GUC_UNIT_BLOCKS:
7621 snprintf(buf, sizeof(buf), "%dkB", BLCKSZ / 1024);
7624 case GUC_UNIT_XBLOCKS:
7625 snprintf(buf, sizeof(buf), "%dkB", XLOG_BLCKSZ / 1024);
7646 values[3] = config_group_names[conf->group];
7649 values[4] = conf->short_desc;
7652 values[5] = conf->long_desc;
7655 values[6] = GucContext_Names[conf->context];
7658 values[7] = config_type_names[conf->vartype];
7661 values[8] = GucSource_Names[conf->source];
7663 /* now get the type specifc attributes */
7664 switch (conf->vartype)
7668 struct config_bool *lconf = (struct config_bool *) conf;
7680 values[12] = pstrdup(lconf->boot_val ? "on" : "off");
7683 values[13] = pstrdup(lconf->reset_val ? "on" : "off");
7689 struct config_int *lconf = (struct config_int *) conf;
7692 snprintf(buffer, sizeof(buffer), "%d", lconf->min);
7693 values[9] = pstrdup(buffer);
7696 snprintf(buffer, sizeof(buffer), "%d", lconf->max);
7697 values[10] = pstrdup(buffer);
7703 snprintf(buffer, sizeof(buffer), "%d", lconf->boot_val);
7704 values[12] = pstrdup(buffer);
7707 snprintf(buffer, sizeof(buffer), "%d", lconf->reset_val);
7708 values[13] = pstrdup(buffer);
7714 struct config_real *lconf = (struct config_real *) conf;
7717 snprintf(buffer, sizeof(buffer), "%g", lconf->min);
7718 values[9] = pstrdup(buffer);
7721 snprintf(buffer, sizeof(buffer), "%g", lconf->max);
7722 values[10] = pstrdup(buffer);
7728 snprintf(buffer, sizeof(buffer), "%g", lconf->boot_val);
7729 values[12] = pstrdup(buffer);
7732 snprintf(buffer, sizeof(buffer), "%g", lconf->reset_val);
7733 values[13] = pstrdup(buffer);
7739 struct config_string *lconf = (struct config_string *) conf;
7751 if (lconf->boot_val == NULL)
7754 values[12] = pstrdup(lconf->boot_val);
7757 if (lconf->reset_val == NULL)
7760 values[13] = pstrdup(lconf->reset_val);
7766 struct config_enum *lconf = (struct config_enum *) conf;
7777 * NOTE! enumvals with double quotes in them are not
7780 values[11] = config_enum_get_options((struct config_enum *) conf,
7781 "{\"", "\"}", "\",\"");
7784 values[12] = pstrdup(config_enum_lookup_by_value(lconf,
7788 values[13] = pstrdup(config_enum_lookup_by_value(lconf,
7796 * should never get here, but in case we do, set 'em to NULL
7818 * If the setting came from a config file, set the source location. For
7819 * security reasons, we don't show source file/line number for
7822 if (conf->source == PGC_S_FILE && superuser())
7824 values[14] = conf->sourcefile;
7825 snprintf(buffer, sizeof(buffer), "%d", conf->sourceline);
7826 values[15] = pstrdup(buffer);
7836 * Return the total number of GUC variables
7839 GetNumConfigOptions(void)
7841 return num_guc_variables;
7845 * show_config_by_name - equiv to SHOW X command but implemented as
7849 show_config_by_name(PG_FUNCTION_ARGS)
7854 /* Get the GUC variable name */
7855 varname = TextDatumGetCString(PG_GETARG_DATUM(0));
7858 varval = GetConfigOptionByName(varname, NULL);
7860 /* Convert to text */
7861 PG_RETURN_TEXT_P(cstring_to_text(varval));
7865 * show_all_settings - equiv to SHOW ALL command but implemented as
7868 #define NUM_PG_SETTINGS_ATTS 16
7871 show_all_settings(PG_FUNCTION_ARGS)
7873 FuncCallContext *funcctx;
7877 AttInMetadata *attinmeta;
7878 MemoryContext oldcontext;
7880 /* stuff done only on the first call of the function */
7881 if (SRF_IS_FIRSTCALL())
7883 /* create a function context for cross-call persistence */
7884 funcctx = SRF_FIRSTCALL_INIT();
7887 * switch to memory context appropriate for multiple function calls
7889 oldcontext = MemoryContextSwitchTo(funcctx->multi_call_memory_ctx);
7892 * need a tuple descriptor representing NUM_PG_SETTINGS_ATTS columns
7893 * of the appropriate types
7895 tupdesc = CreateTemplateTupleDesc(NUM_PG_SETTINGS_ATTS, false);
7896 TupleDescInitEntry(tupdesc, (AttrNumber) 1, "name",
7898 TupleDescInitEntry(tupdesc, (AttrNumber) 2, "setting",
7900 TupleDescInitEntry(tupdesc, (AttrNumber) 3, "unit",
7902 TupleDescInitEntry(tupdesc, (AttrNumber) 4, "category",
7904 TupleDescInitEntry(tupdesc, (AttrNumber) 5, "short_desc",
7906 TupleDescInitEntry(tupdesc, (AttrNumber) 6, "extra_desc",
7908 TupleDescInitEntry(tupdesc, (AttrNumber) 7, "context",
7910 TupleDescInitEntry(tupdesc, (AttrNumber) 8, "vartype",
7912 TupleDescInitEntry(tupdesc, (AttrNumber) 9, "source",
7914 TupleDescInitEntry(tupdesc, (AttrNumber) 10, "min_val",
7916 TupleDescInitEntry(tupdesc, (AttrNumber) 11, "max_val",
7918 TupleDescInitEntry(tupdesc, (AttrNumber) 12, "enumvals",
7919 TEXTARRAYOID, -1, 0);
7920 TupleDescInitEntry(tupdesc, (AttrNumber) 13, "boot_val",
7922 TupleDescInitEntry(tupdesc, (AttrNumber) 14, "reset_val",
7924 TupleDescInitEntry(tupdesc, (AttrNumber) 15, "sourcefile",
7926 TupleDescInitEntry(tupdesc, (AttrNumber) 16, "sourceline",
7930 * Generate attribute metadata needed later to produce tuples from raw
7933 attinmeta = TupleDescGetAttInMetadata(tupdesc);
7934 funcctx->attinmeta = attinmeta;
7936 /* total number of tuples to be returned */
7937 funcctx->max_calls = GetNumConfigOptions();
7939 MemoryContextSwitchTo(oldcontext);
7942 /* stuff done on every call of the function */
7943 funcctx = SRF_PERCALL_SETUP();
7945 call_cntr = funcctx->call_cntr;
7946 max_calls = funcctx->max_calls;
7947 attinmeta = funcctx->attinmeta;
7949 if (call_cntr < max_calls) /* do when there is more left to send */
7951 char *values[NUM_PG_SETTINGS_ATTS];
7957 * Get the next visible GUC variable name and value
7961 GetConfigOptionByNum(call_cntr, (const char **) values, &noshow);
7964 /* bump the counter and get the next config setting */
7965 call_cntr = ++funcctx->call_cntr;
7967 /* make sure we haven't gone too far now */
7968 if (call_cntr >= max_calls)
7969 SRF_RETURN_DONE(funcctx);
7974 tuple = BuildTupleFromCStrings(attinmeta, values);
7976 /* make the tuple into a datum */
7977 result = HeapTupleGetDatum(tuple);
7979 SRF_RETURN_NEXT(funcctx, result);
7983 /* do when there is no more left */
7984 SRF_RETURN_DONE(funcctx);
7989 _ShowOption(struct config_generic * record, bool use_units)
7994 switch (record->vartype)
7998 struct config_bool *conf = (struct config_bool *) record;
8000 if (conf->show_hook)
8001 val = (*conf->show_hook) ();
8003 val = *conf->variable ? "on" : "off";
8009 struct config_int *conf = (struct config_int *) record;
8011 if (conf->show_hook)
8012 val = (*conf->show_hook) ();
8016 * Use int64 arithmetic to avoid overflows in units
8019 int64 result = *conf->variable;
8022 if (use_units && result > 0 &&
8023 (record->flags & GUC_UNIT_MEMORY))
8025 switch (record->flags & GUC_UNIT_MEMORY)
8027 case GUC_UNIT_BLOCKS:
8028 result *= BLCKSZ / 1024;
8030 case GUC_UNIT_XBLOCKS:
8031 result *= XLOG_BLCKSZ / 1024;
8035 if (result % KB_PER_TB == 0)
8037 result /= KB_PER_TB;
8040 else if (result % KB_PER_GB == 0)
8042 result /= KB_PER_GB;
8045 else if (result % KB_PER_MB == 0)
8047 result /= KB_PER_MB;
8055 else if (use_units && result > 0 &&
8056 (record->flags & GUC_UNIT_TIME))
8058 switch (record->flags & GUC_UNIT_TIME)
8064 result *= MS_PER_MIN;
8068 if (result % MS_PER_D == 0)
8073 else if (result % MS_PER_H == 0)
8078 else if (result % MS_PER_MIN == 0)
8080 result /= MS_PER_MIN;
8083 else if (result % MS_PER_S == 0)
8096 snprintf(buffer, sizeof(buffer), INT64_FORMAT "%s",
8105 struct config_real *conf = (struct config_real *) record;
8107 if (conf->show_hook)
8108 val = (*conf->show_hook) ();
8111 snprintf(buffer, sizeof(buffer), "%g",
8120 struct config_string *conf = (struct config_string *) record;
8122 if (conf->show_hook)
8123 val = (*conf->show_hook) ();
8124 else if (*conf->variable && **conf->variable)
8125 val = *conf->variable;
8133 struct config_enum *conf = (struct config_enum *) record;
8135 if (conf->show_hook)
8136 val = (*conf->show_hook) ();
8138 val = config_enum_lookup_by_value(conf, *conf->variable);
8143 /* just to keep compiler quiet */
8148 return pstrdup(val);
8155 * These routines dump out all non-default GUC options into a binary
8156 * file that is read by all exec'ed backends. The format is:
8158 * variable name, string, null terminated
8159 * variable value, string, null terminated
8160 * variable sourcefile, string, null terminated (empty if none)
8161 * variable sourceline, integer
8162 * variable source, integer
8163 * variable scontext, integer
8166 write_one_nondefault_variable(FILE *fp, struct config_generic * gconf)
8168 if (gconf->source == PGC_S_DEFAULT)
8171 fprintf(fp, "%s", gconf->name);
8174 switch (gconf->vartype)
8178 struct config_bool *conf = (struct config_bool *) gconf;
8180 if (*conf->variable)
8181 fprintf(fp, "true");
8183 fprintf(fp, "false");
8189 struct config_int *conf = (struct config_int *) gconf;
8191 fprintf(fp, "%d", *conf->variable);
8197 struct config_real *conf = (struct config_real *) gconf;
8199 fprintf(fp, "%.17g", *conf->variable);
8205 struct config_string *conf = (struct config_string *) gconf;
8207 fprintf(fp, "%s", *conf->variable);
8213 struct config_enum *conf = (struct config_enum *) gconf;
8216 config_enum_lookup_by_value(conf, *conf->variable));
8223 if (gconf->sourcefile)
8224 fprintf(fp, "%s", gconf->sourcefile);
8227 fwrite(&gconf->sourceline, 1, sizeof(gconf->sourceline), fp);
8228 fwrite(&gconf->source, 1, sizeof(gconf->source), fp);
8229 fwrite(&gconf->scontext, 1, sizeof(gconf->scontext), fp);
8233 write_nondefault_variables(GucContext context)
8239 Assert(context == PGC_POSTMASTER || context == PGC_SIGHUP);
8241 elevel = (context == PGC_SIGHUP) ? LOG : ERROR;
8246 fp = AllocateFile(CONFIG_EXEC_PARAMS_NEW, "w");
8250 (errcode_for_file_access(),
8251 errmsg("could not write to file \"%s\": %m",
8252 CONFIG_EXEC_PARAMS_NEW)));
8256 for (i = 0; i < num_guc_variables; i++)
8258 write_one_nondefault_variable(fp, guc_variables[i]);
8264 (errcode_for_file_access(),
8265 errmsg("could not write to file \"%s\": %m",
8266 CONFIG_EXEC_PARAMS_NEW)));
8271 * Put new file in place. This could delay on Win32, but we don't hold
8272 * any exclusive locks.
8274 rename(CONFIG_EXEC_PARAMS_NEW, CONFIG_EXEC_PARAMS);
8279 * Read string, including null byte from file
8281 * Return NULL on EOF and nothing read
8284 read_string_with_null(FILE *fp)
8293 if ((ch = fgetc(fp)) == EOF)
8298 elog(FATAL, "invalid format of exec config params file");
8301 str = guc_malloc(FATAL, maxlen);
8302 else if (i == maxlen)
8303 str = guc_realloc(FATAL, str, maxlen *= 2);
8312 * This routine loads a previous postmaster dump of its non-default
8316 read_nondefault_variables(void)
8323 GucSource varsource;
8324 GucContext varscontext;
8329 fp = AllocateFile(CONFIG_EXEC_PARAMS, "r");
8332 /* File not found is fine */
8333 if (errno != ENOENT)
8335 (errcode_for_file_access(),
8336 errmsg("could not read from file \"%s\": %m",
8337 CONFIG_EXEC_PARAMS)));
8343 struct config_generic *record;
8345 if ((varname = read_string_with_null(fp)) == NULL)
8348 if ((record = find_option(varname, true, FATAL)) == NULL)
8349 elog(FATAL, "failed to locate variable \"%s\" in exec config params file", varname);
8351 if ((varvalue = read_string_with_null(fp)) == NULL)
8352 elog(FATAL, "invalid format of exec config params file");
8353 if ((varsourcefile = read_string_with_null(fp)) == NULL)
8354 elog(FATAL, "invalid format of exec config params file");
8355 if (fread(&varsourceline, 1, sizeof(varsourceline), fp) != sizeof(varsourceline))
8356 elog(FATAL, "invalid format of exec config params file");
8357 if (fread(&varsource, 1, sizeof(varsource), fp) != sizeof(varsource))
8358 elog(FATAL, "invalid format of exec config params file");
8359 if (fread(&varscontext, 1, sizeof(varscontext), fp) != sizeof(varscontext))
8360 elog(FATAL, "invalid format of exec config params file");
8362 (void) set_config_option(varname, varvalue,
8363 varscontext, varsource,
8364 GUC_ACTION_SET, true, 0);
8365 if (varsourcefile[0])
8366 set_config_sourcefile(varname, varsourcefile, varsourceline);
8370 free(varsourcefile);
8375 #endif /* EXEC_BACKEND */
8379 * A little "long argument" simulation, although not quite GNU
8380 * compliant. Takes a string of the form "some-option=some value" and
8381 * returns name = "some_option" and value = "some value" in malloc'ed
8382 * storage. Note that '-' is converted to '_' in the option name. If
8383 * there is no '=' in the input string then value will be NULL.
8386 ParseLongOption(const char *string, char **name, char **value)
8395 equal_pos = strcspn(string, "=");
8397 if (string[equal_pos] == '=')
8399 *name = guc_malloc(FATAL, equal_pos + 1);
8400 strlcpy(*name, string, equal_pos + 1);
8402 *value = guc_strdup(FATAL, &string[equal_pos + 1]);
8406 /* no equal sign in string */
8407 *name = guc_strdup(FATAL, string);
8411 for (cp = *name; *cp; cp++)
8418 * Handle options fetched from pg_db_role_setting.setconfig,
8419 * pg_proc.proconfig, etc. Caller must specify proper context/source/action.
8421 * The array parameter must be an array of TEXT (it must not be NULL).
8424 ProcessGUCArray(ArrayType *array,
8425 GucContext context, GucSource source, GucAction action)
8429 Assert(array != NULL);
8430 Assert(ARR_ELEMTYPE(array) == TEXTOID);
8431 Assert(ARR_NDIM(array) == 1);
8432 Assert(ARR_LBOUND(array)[0] == 1);
8434 for (i = 1; i <= ARR_DIMS(array)[0]; i++)
8442 d = array_ref(array, 1, &i,
8443 -1 /* varlenarray */ ,
8444 -1 /* TEXT's typlen */ ,
8445 false /* TEXT's typbyval */ ,
8446 'i' /* TEXT's typalign */ ,
8452 s = TextDatumGetCString(d);
8454 ParseLongOption(s, &name, &value);
8458 (errcode(ERRCODE_SYNTAX_ERROR),
8459 errmsg("could not parse setting for parameter \"%s\"",
8465 (void) set_config_option(name, value,
8478 * Add an entry to an option array. The array parameter may be NULL
8479 * to indicate the current table entry is NULL.
8482 GUCArrayAdd(ArrayType *array, const char *name, const char *value)
8484 struct config_generic *record;
8492 /* test if the option is valid and we're allowed to set it */
8493 (void) validate_option_array_item(name, value, false);
8495 /* normalize name (converts obsolete GUC names to modern spellings) */
8496 record = find_option(name, false, WARNING);
8498 name = record->name;
8500 /* build new item for array */
8501 newval = psprintf("%s=%s", name, value);
8502 datum = CStringGetTextDatum(newval);
8510 Assert(ARR_ELEMTYPE(array) == TEXTOID);
8511 Assert(ARR_NDIM(array) == 1);
8512 Assert(ARR_LBOUND(array)[0] == 1);
8514 index = ARR_DIMS(array)[0] + 1; /* add after end */
8516 for (i = 1; i <= ARR_DIMS(array)[0]; i++)
8521 d = array_ref(array, 1, &i,
8522 -1 /* varlenarray */ ,
8523 -1 /* TEXT's typlen */ ,
8524 false /* TEXT's typbyval */ ,
8525 'i' /* TEXT's typalign */ ,
8529 current = TextDatumGetCString(d);
8531 /* check for match up through and including '=' */
8532 if (strncmp(current, newval, strlen(name) + 1) == 0)
8539 a = array_set(array, 1, &index,
8542 -1 /* varlena array */ ,
8543 -1 /* TEXT's typlen */ ,
8544 false /* TEXT's typbyval */ ,
8545 'i' /* TEXT's typalign */ );
8548 a = construct_array(&datum, 1,
8557 * Delete an entry from an option array. The array parameter may be NULL
8558 * to indicate the current table entry is NULL. Also, if the return value
8559 * is NULL then a null should be stored.
8562 GUCArrayDelete(ArrayType *array, const char *name)
8564 struct config_generic *record;
8565 ArrayType *newarray;
8571 /* test if the option is valid and we're allowed to set it */
8572 (void) validate_option_array_item(name, NULL, false);
8574 /* normalize name (converts obsolete GUC names to modern spellings) */
8575 record = find_option(name, false, WARNING);
8577 name = record->name;
8579 /* if array is currently null, then surely nothing to delete */
8586 for (i = 1; i <= ARR_DIMS(array)[0]; i++)
8592 d = array_ref(array, 1, &i,
8593 -1 /* varlenarray */ ,
8594 -1 /* TEXT's typlen */ ,
8595 false /* TEXT's typbyval */ ,
8596 'i' /* TEXT's typalign */ ,
8600 val = TextDatumGetCString(d);
8602 /* ignore entry if it's what we want to delete */
8603 if (strncmp(val, name, strlen(name)) == 0
8604 && val[strlen(name)] == '=')
8607 /* else add it to the output array */
8609 newarray = array_set(newarray, 1, &index,
8612 -1 /* varlenarray */ ,
8613 -1 /* TEXT's typlen */ ,
8614 false /* TEXT's typbyval */ ,
8615 'i' /* TEXT's typalign */ );
8617 newarray = construct_array(&d, 1,
8629 * Given a GUC array, delete all settings from it that our permission
8630 * level allows: if superuser, delete them all; if regular user, only
8631 * those that are PGC_USERSET
8634 GUCArrayReset(ArrayType *array)
8636 ArrayType *newarray;
8640 /* if array is currently null, nothing to do */
8644 /* if we're superuser, we can delete everything, so just do it */
8651 for (i = 1; i <= ARR_DIMS(array)[0]; i++)
8658 d = array_ref(array, 1, &i,
8659 -1 /* varlenarray */ ,
8660 -1 /* TEXT's typlen */ ,
8661 false /* TEXT's typbyval */ ,
8662 'i' /* TEXT's typalign */ ,
8666 val = TextDatumGetCString(d);
8668 eqsgn = strchr(val, '=');
8671 /* skip if we have permission to delete it */
8672 if (validate_option_array_item(val, NULL, true))
8675 /* else add it to the output array */
8677 newarray = array_set(newarray, 1, &index,
8680 -1 /* varlenarray */ ,
8681 -1 /* TEXT's typlen */ ,
8682 false /* TEXT's typbyval */ ,
8683 'i' /* TEXT's typalign */ );
8685 newarray = construct_array(&d, 1,
8697 * Validate a proposed option setting for GUCArrayAdd/Delete/Reset.
8699 * name is the option name. value is the proposed value for the Add case,
8700 * or NULL for the Delete/Reset cases. If skipIfNoPermissions is true, it's
8701 * not an error to have no permissions to set the option.
8703 * Returns TRUE if OK, FALSE if skipIfNoPermissions is true and user does not
8704 * have permission to change this option (all other error cases result in an
8705 * error being thrown).
8708 validate_option_array_item(const char *name, const char *value,
8709 bool skipIfNoPermissions)
8712 struct config_generic *gconf;
8715 * There are three cases to consider:
8717 * name is a known GUC variable. Check the value normally, check
8718 * permissions normally (ie, allow if variable is USERSET, or if it's
8719 * SUSET and user is superuser).
8721 * name is not known, but exists or can be created as a placeholder (i.e.,
8722 * it has a prefixed name). We allow this case if you're a superuser,
8723 * otherwise not. Superusers are assumed to know what they're doing. We
8724 * can't allow it for other users, because when the placeholder is
8725 * resolved it might turn out to be a SUSET variable;
8726 * define_custom_variable assumes we checked that.
8728 * name is not known and can't be created as a placeholder. Throw error,
8729 * unless skipIfNoPermissions is true, in which case return FALSE.
8731 gconf = find_option(name, true, WARNING);
8734 /* not known, failed to make a placeholder */
8735 if (skipIfNoPermissions)
8738 (errcode(ERRCODE_UNDEFINED_OBJECT),
8739 errmsg("unrecognized configuration parameter \"%s\"",
8743 if (gconf->flags & GUC_CUSTOM_PLACEHOLDER)
8746 * We cannot do any meaningful check on the value, so only permissions
8747 * are useful to check.
8751 if (skipIfNoPermissions)
8754 (errcode(ERRCODE_INSUFFICIENT_PRIVILEGE),
8755 errmsg("permission denied to set parameter \"%s\"", name)));
8758 /* manual permissions check so we can avoid an error being thrown */
8759 if (gconf->context == PGC_USERSET)
8761 else if (gconf->context == PGC_SUSET && superuser())
8763 else if (skipIfNoPermissions)
8765 /* if a permissions error should be thrown, let set_config_option do it */
8767 /* test for permissions and valid option value */
8768 (void) set_config_option(name, value,
8769 superuser() ? PGC_SUSET : PGC_USERSET,
8770 PGC_S_TEST, GUC_ACTION_SET, false, 0);
8777 * Called by check_hooks that want to override the normal
8778 * ERRCODE_INVALID_PARAMETER_VALUE SQLSTATE for check hook failures.
8780 * Note that GUC_check_errmsg() etc are just macros that result in a direct
8781 * assignment to the associated variables. That is ugly, but forced by the
8782 * limitations of C's macro mechanisms.
8785 GUC_check_errcode(int sqlerrcode)
8787 GUC_check_errcode_value = sqlerrcode;
8792 * Convenience functions to manage calling a variable's check_hook.
8793 * These mostly take care of the protocol for letting check hooks supply
8794 * portions of the error report on failure.
8798 call_bool_check_hook(struct config_bool * conf, bool *newval, void **extra,
8799 GucSource source, int elevel)
8801 /* Quick success if no hook */
8802 if (!conf->check_hook)
8805 /* Reset variables that might be set by hook */
8806 GUC_check_errcode_value = ERRCODE_INVALID_PARAMETER_VALUE;
8807 GUC_check_errmsg_string = NULL;
8808 GUC_check_errdetail_string = NULL;
8809 GUC_check_errhint_string = NULL;
8811 if (!(*conf->check_hook) (newval, extra, source))
8814 (errcode(GUC_check_errcode_value),
8815 GUC_check_errmsg_string ?
8816 errmsg_internal("%s", GUC_check_errmsg_string) :
8817 errmsg("invalid value for parameter \"%s\": %d",
8818 conf->gen.name, (int) *newval),
8819 GUC_check_errdetail_string ?
8820 errdetail_internal("%s", GUC_check_errdetail_string) : 0,
8821 GUC_check_errhint_string ?
8822 errhint("%s", GUC_check_errhint_string) : 0));
8823 /* Flush any strings created in ErrorContext */
8832 call_int_check_hook(struct config_int * conf, int *newval, void **extra,
8833 GucSource source, int elevel)
8835 /* Quick success if no hook */
8836 if (!conf->check_hook)
8839 /* Reset variables that might be set by hook */
8840 GUC_check_errcode_value = ERRCODE_INVALID_PARAMETER_VALUE;
8841 GUC_check_errmsg_string = NULL;
8842 GUC_check_errdetail_string = NULL;
8843 GUC_check_errhint_string = NULL;
8845 if (!(*conf->check_hook) (newval, extra, source))
8848 (errcode(GUC_check_errcode_value),
8849 GUC_check_errmsg_string ?
8850 errmsg_internal("%s", GUC_check_errmsg_string) :
8851 errmsg("invalid value for parameter \"%s\": %d",
8852 conf->gen.name, *newval),
8853 GUC_check_errdetail_string ?
8854 errdetail_internal("%s", GUC_check_errdetail_string) : 0,
8855 GUC_check_errhint_string ?
8856 errhint("%s", GUC_check_errhint_string) : 0));
8857 /* Flush any strings created in ErrorContext */
8866 call_real_check_hook(struct config_real * conf, double *newval, void **extra,
8867 GucSource source, int elevel)
8869 /* Quick success if no hook */
8870 if (!conf->check_hook)
8873 /* Reset variables that might be set by hook */
8874 GUC_check_errcode_value = ERRCODE_INVALID_PARAMETER_VALUE;
8875 GUC_check_errmsg_string = NULL;
8876 GUC_check_errdetail_string = NULL;
8877 GUC_check_errhint_string = NULL;
8879 if (!(*conf->check_hook) (newval, extra, source))
8882 (errcode(GUC_check_errcode_value),
8883 GUC_check_errmsg_string ?
8884 errmsg_internal("%s", GUC_check_errmsg_string) :
8885 errmsg("invalid value for parameter \"%s\": %g",
8886 conf->gen.name, *newval),
8887 GUC_check_errdetail_string ?
8888 errdetail_internal("%s", GUC_check_errdetail_string) : 0,
8889 GUC_check_errhint_string ?
8890 errhint("%s", GUC_check_errhint_string) : 0));
8891 /* Flush any strings created in ErrorContext */
8900 call_string_check_hook(struct config_string * conf, char **newval, void **extra,
8901 GucSource source, int elevel)
8903 /* Quick success if no hook */
8904 if (!conf->check_hook)
8907 /* Reset variables that might be set by hook */
8908 GUC_check_errcode_value = ERRCODE_INVALID_PARAMETER_VALUE;
8909 GUC_check_errmsg_string = NULL;
8910 GUC_check_errdetail_string = NULL;
8911 GUC_check_errhint_string = NULL;
8913 if (!(*conf->check_hook) (newval, extra, source))
8916 (errcode(GUC_check_errcode_value),
8917 GUC_check_errmsg_string ?
8918 errmsg_internal("%s", GUC_check_errmsg_string) :
8919 errmsg("invalid value for parameter \"%s\": \"%s\"",
8920 conf->gen.name, *newval ? *newval : ""),
8921 GUC_check_errdetail_string ?
8922 errdetail_internal("%s", GUC_check_errdetail_string) : 0,
8923 GUC_check_errhint_string ?
8924 errhint("%s", GUC_check_errhint_string) : 0));
8925 /* Flush any strings created in ErrorContext */
8934 call_enum_check_hook(struct config_enum * conf, int *newval, void **extra,
8935 GucSource source, int elevel)
8937 /* Quick success if no hook */
8938 if (!conf->check_hook)
8941 /* Reset variables that might be set by hook */
8942 GUC_check_errcode_value = ERRCODE_INVALID_PARAMETER_VALUE;
8943 GUC_check_errmsg_string = NULL;
8944 GUC_check_errdetail_string = NULL;
8945 GUC_check_errhint_string = NULL;
8947 if (!(*conf->check_hook) (newval, extra, source))
8950 (errcode(GUC_check_errcode_value),
8951 GUC_check_errmsg_string ?
8952 errmsg_internal("%s", GUC_check_errmsg_string) :
8953 errmsg("invalid value for parameter \"%s\": \"%s\"",
8955 config_enum_lookup_by_value(conf, *newval)),
8956 GUC_check_errdetail_string ?
8957 errdetail_internal("%s", GUC_check_errdetail_string) : 0,
8958 GUC_check_errhint_string ?
8959 errhint("%s", GUC_check_errhint_string) : 0));
8960 /* Flush any strings created in ErrorContext */
8970 * check_hook, assign_hook and show_hook subroutines
8974 check_log_destination(char **newval, void **extra, GucSource source)
8982 /* Need a modifiable copy of string */
8983 rawstring = pstrdup(*newval);
8985 /* Parse string into list of identifiers */
8986 if (!SplitIdentifierString(rawstring, ',', &elemlist))
8988 /* syntax error in list */
8989 GUC_check_errdetail("List syntax is invalid.");
8991 list_free(elemlist);
8995 foreach(l, elemlist)
8997 char *tok = (char *) lfirst(l);
8999 if (pg_strcasecmp(tok, "stderr") == 0)
9000 newlogdest |= LOG_DESTINATION_STDERR;
9001 else if (pg_strcasecmp(tok, "csvlog") == 0)
9002 newlogdest |= LOG_DESTINATION_CSVLOG;
9004 else if (pg_strcasecmp(tok, "syslog") == 0)
9005 newlogdest |= LOG_DESTINATION_SYSLOG;
9008 else if (pg_strcasecmp(tok, "eventlog") == 0)
9009 newlogdest |= LOG_DESTINATION_EVENTLOG;
9013 GUC_check_errdetail("Unrecognized key word: \"%s\".", tok);
9015 list_free(elemlist);
9021 list_free(elemlist);
9023 myextra = (int *) guc_malloc(ERROR, sizeof(int));
9024 *myextra = newlogdest;
9025 *extra = (void *) myextra;
9031 assign_log_destination(const char *newval, void *extra)
9033 Log_destination = *((int *) extra);
9037 assign_syslog_facility(int newval, void *extra)
9040 set_syslog_parameters(syslog_ident_str ? syslog_ident_str : "postgres",
9043 /* Without syslog support, just ignore it */
9047 assign_syslog_ident(const char *newval, void *extra)
9050 set_syslog_parameters(newval, syslog_facility);
9052 /* Without syslog support, it will always be set to "none", so ignore */
9057 assign_session_replication_role(int newval, void *extra)
9060 * Must flush the plan cache when changing replication role; but don't
9061 * flush unnecessarily.
9063 if (SessionReplicationRole != newval)
9068 check_temp_buffers(int *newval, void **extra, GucSource source)
9071 * Once local buffers have been initialized, it's too late to change this.
9073 if (NLocBuffer && NLocBuffer != *newval)
9075 GUC_check_errdetail("\"temp_buffers\" cannot be changed after any temporary tables have been accessed in the session.");
9082 check_phony_autocommit(bool *newval, void **extra, GucSource source)
9086 GUC_check_errcode(ERRCODE_FEATURE_NOT_SUPPORTED);
9087 GUC_check_errmsg("SET AUTOCOMMIT TO OFF is no longer supported");
9094 check_debug_assertions(bool *newval, void **extra, GucSource source)
9096 #ifndef USE_ASSERT_CHECKING
9099 GUC_check_errmsg("assertion checking is not supported by this build");
9107 check_bonjour(bool *newval, void **extra, GucSource source)
9112 GUC_check_errmsg("Bonjour is not supported by this build");
9120 check_ssl(bool *newval, void **extra, GucSource source)
9125 GUC_check_errmsg("SSL is not supported by this build");
9133 check_stage_log_stats(bool *newval, void **extra, GucSource source)
9135 if (*newval && log_statement_stats)
9137 GUC_check_errdetail("Cannot enable parameter when \"log_statement_stats\" is true.");
9144 check_log_stats(bool *newval, void **extra, GucSource source)
9147 (log_parser_stats || log_planner_stats || log_executor_stats))
9149 GUC_check_errdetail("Cannot enable \"log_statement_stats\" when "
9150 "\"log_parser_stats\", \"log_planner_stats\", "
9151 "or \"log_executor_stats\" is true.");
9158 check_canonical_path(char **newval, void **extra, GucSource source)
9161 * Since canonicalize_path never enlarges the string, we can just modify
9162 * newval in-place. But watch out for NULL, which is the default value
9163 * for external_pid_file.
9166 canonicalize_path(*newval);
9171 check_timezone_abbreviations(char **newval, void **extra, GucSource source)
9174 * The boot_val given above for timezone_abbreviations is NULL. When we
9175 * see this we just do nothing. If this value isn't overridden from the
9176 * config file then pg_timezone_abbrev_initialize() will eventually
9177 * replace it with "Default". This hack has two purposes: to avoid
9178 * wasting cycles loading values that might soon be overridden from the
9179 * config file, and to avoid trying to read the timezone abbrev files
9180 * during InitializeGUCOptions(). The latter doesn't work in an
9181 * EXEC_BACKEND subprocess because my_exec_path hasn't been set yet and so
9182 * we can't locate PGSHAREDIR.
9184 if (*newval == NULL)
9186 Assert(source == PGC_S_DEFAULT);
9190 /* OK, load the file and produce a malloc'd TimeZoneAbbrevTable */
9191 *extra = load_tzoffsets(*newval);
9193 /* tzparser.c returns NULL on failure, reporting via GUC_check_errmsg */
9201 assign_timezone_abbreviations(const char *newval, void *extra)
9203 /* Do nothing for the boot_val default of NULL */
9207 InstallTimeZoneAbbrevs((TimeZoneAbbrevTable *) extra);
9211 * pg_timezone_abbrev_initialize --- set default value if not done already
9213 * This is called after initial loading of postgresql.conf. If no
9214 * timezone_abbreviations setting was found therein, select default.
9215 * If a non-default value is already installed, nothing will happen.
9217 * This can also be called from ProcessConfigFile to establish the default
9218 * value after a postgresql.conf entry for it is removed.
9221 pg_timezone_abbrev_initialize(void)
9223 SetConfigOption("timezone_abbreviations", "Default",
9224 PGC_POSTMASTER, PGC_S_DYNAMIC_DEFAULT);
9228 show_archive_command(void)
9230 if (XLogArchivingActive())
9231 return XLogArchiveCommand;
9233 return "(disabled)";
9237 assign_tcp_keepalives_idle(int newval, void *extra)
9240 * The kernel API provides no way to test a value without setting it; and
9241 * once we set it we might fail to unset it. So there seems little point
9242 * in fully implementing the check-then-assign GUC API for these
9243 * variables. Instead we just do the assignment on demand. pqcomm.c
9244 * reports any problems via elog(LOG).
9246 * This approach means that the GUC value might have little to do with the
9247 * actual kernel value, so we use a show_hook that retrieves the kernel
9248 * value rather than trusting GUC's copy.
9250 (void) pq_setkeepalivesidle(newval, MyProcPort);
9254 show_tcp_keepalives_idle(void)
9256 /* See comments in assign_tcp_keepalives_idle */
9257 static char nbuf[16];
9259 snprintf(nbuf, sizeof(nbuf), "%d", pq_getkeepalivesidle(MyProcPort));
9264 assign_tcp_keepalives_interval(int newval, void *extra)
9266 /* See comments in assign_tcp_keepalives_idle */
9267 (void) pq_setkeepalivesinterval(newval, MyProcPort);
9271 show_tcp_keepalives_interval(void)
9273 /* See comments in assign_tcp_keepalives_idle */
9274 static char nbuf[16];
9276 snprintf(nbuf, sizeof(nbuf), "%d", pq_getkeepalivesinterval(MyProcPort));
9281 assign_tcp_keepalives_count(int newval, void *extra)
9283 /* See comments in assign_tcp_keepalives_idle */
9284 (void) pq_setkeepalivescount(newval, MyProcPort);
9288 show_tcp_keepalives_count(void)
9290 /* See comments in assign_tcp_keepalives_idle */
9291 static char nbuf[16];
9293 snprintf(nbuf, sizeof(nbuf), "%d", pq_getkeepalivescount(MyProcPort));
9298 check_maxconnections(int *newval, void **extra, GucSource source)
9300 if (*newval + autovacuum_max_workers + 1 +
9301 max_worker_processes > MAX_BACKENDS)
9307 check_autovacuum_max_workers(int *newval, void **extra, GucSource source)
9309 if (MaxConnections + *newval + 1 + max_worker_processes > MAX_BACKENDS)
9315 check_autovacuum_work_mem(int *newval, void **extra, GucSource source)
9318 * -1 indicates fallback.
9320 * If we haven't yet changed the boot_val default of -1, just let it be.
9321 * Autovacuum will look to maintenance_work_mem instead.
9327 * We clamp manually-set values to at least 1MB. Since
9328 * maintenance_work_mem is always set to at least this value, do the same
9338 check_max_worker_processes(int *newval, void **extra, GucSource source)
9340 if (MaxConnections + autovacuum_max_workers + 1 + *newval > MAX_BACKENDS)
9346 check_effective_io_concurrency(int *newval, void **extra, GucSource source)
9349 double new_prefetch_pages = 0.0;
9353 * The user-visible GUC parameter is the number of drives (spindles),
9354 * which we need to translate to a number-of-pages-to-prefetch target.
9355 * The target value is stashed in *extra and then assigned to the actual
9356 * variable by assign_effective_io_concurrency.
9358 * The expected number of prefetch pages needed to keep N drives busy is:
9360 * drives | I/O requests
9361 * -------+----------------
9364 * 3 | 3/1 + 3/2 + 3/3 = 5 1/2
9365 * 4 | 4/1 + 4/2 + 4/3 + 4/4 = 8 1/3
9368 * This is called the "coupon collector problem" and H(n) is called the
9369 * harmonic series. This could be approximated by n * ln(n), but for
9370 * reasonable numbers of drives we might as well just compute the series.
9372 * Alternatively we could set the target to the number of pages necessary
9373 * so that the expected number of active spindles is some arbitrary
9374 * percentage of the total. This sounds the same but is actually slightly
9375 * different. The result ends up being ln(1-P)/ln((n-1)/n) where P is
9376 * that desired fraction.
9378 * Experimental results show that both of these formulas aren't aggressive
9379 * enough, but we don't really have any better proposals.
9381 * Note that if *newval = 0 (disabled), we must set target = 0.
9385 for (i = 1; i <= *newval; i++)
9386 new_prefetch_pages += (double) *newval / (double) i;
9388 /* This range check shouldn't fail, but let's be paranoid */
9389 if (new_prefetch_pages >= 0.0 && new_prefetch_pages < (double) INT_MAX)
9391 int *myextra = (int *) guc_malloc(ERROR, sizeof(int));
9393 *myextra = (int) rint(new_prefetch_pages);
9394 *extra = (void *) myextra;
9402 #endif /* USE_PREFETCH */
9406 assign_effective_io_concurrency(int newval, void *extra)
9409 target_prefetch_pages = *((int *) extra);
9410 #endif /* USE_PREFETCH */
9414 assign_pgstat_temp_directory(const char *newval, void *extra)
9416 /* check_canonical_path already canonicalized newval for us */
9422 dname = guc_malloc(ERROR, strlen(newval) + 1); /* runtime dir */
9423 sprintf(dname, "%s", newval);
9426 tname = guc_malloc(ERROR, strlen(newval) + 12); /* /global.tmp */
9427 sprintf(tname, "%s/global.tmp", newval);
9428 fname = guc_malloc(ERROR, strlen(newval) + 13); /* /global.stat */
9429 sprintf(fname, "%s/global.stat", newval);
9431 if (pgstat_stat_directory)
9432 free(pgstat_stat_directory);
9433 pgstat_stat_directory = dname;
9434 if (pgstat_stat_tmpname)
9435 free(pgstat_stat_tmpname);
9436 pgstat_stat_tmpname = tname;
9437 if (pgstat_stat_filename)
9438 free(pgstat_stat_filename);
9439 pgstat_stat_filename = fname;
9443 check_application_name(char **newval, void **extra, GucSource source)
9445 /* Only allow clean ASCII chars in the application name */
9448 for (p = *newval; *p; p++)
9450 if (*p < 32 || *p > 126)
9458 assign_application_name(const char *newval, void *extra)
9460 /* Update the pg_stat_activity view */
9461 pgstat_report_appname(newval);
9465 show_unix_socket_permissions(void)
9469 snprintf(buf, sizeof(buf), "%04o", Unix_socket_permissions);
9474 show_log_file_mode(void)
9478 snprintf(buf, sizeof(buf), "%04o", Log_file_mode);
9482 #include "guc-file.c"