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-2012, 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/syncrep.h"
61 #include "replication/walreceiver.h"
62 #include "replication/walsender.h"
63 #include "storage/bufmgr.h"
64 #include "storage/standby.h"
65 #include "storage/fd.h"
66 #include "storage/proc.h"
67 #include "storage/predicate.h"
68 #include "tcop/tcopprot.h"
69 #include "tsearch/ts_cache.h"
70 #include "utils/builtins.h"
71 #include "utils/bytea.h"
72 #include "utils/guc_tables.h"
73 #include "utils/memutils.h"
74 #include "utils/pg_locale.h"
75 #include "utils/plancache.h"
76 #include "utils/portal.h"
77 #include "utils/ps_status.h"
78 #include "utils/snapmgr.h"
79 #include "utils/tzparser.h"
80 #include "utils/xml.h"
83 #define PG_KRB_SRVTAB ""
86 #define PG_KRB_SRVNAM ""
89 #define CONFIG_FILENAME "postgresql.conf"
90 #define HBA_FILENAME "pg_hba.conf"
91 #define IDENT_FILENAME "pg_ident.conf"
94 #define CONFIG_EXEC_PARAMS "global/config_exec_params"
95 #define CONFIG_EXEC_PARAMS_NEW "global/config_exec_params.new"
98 /* upper limit for GUC variables measured in kilobytes of memory */
99 /* note that various places assume the byte size fits in a "long" variable */
100 #if SIZEOF_SIZE_T > 4 && SIZEOF_LONG > 4
101 #define MAX_KILOBYTES INT_MAX
103 #define MAX_KILOBYTES (INT_MAX / 1024)
107 * Note: MAX_BACKENDS is limited to 2^23-1 because inval.c stores the
108 * backend ID as a 3-byte signed integer. Even if that limitation were
109 * removed, we still could not exceed INT_MAX/4 because some places compute
110 * 4*MaxBackends without any overflow check. This is rechecked in
111 * check_maxconnections, since MaxBackends is computed as MaxConnections
112 * plus the number of bgworkers plus autovacuum_max_workers plus one (for the
113 * autovacuum launcher).
115 #define MAX_BACKENDS 0x7fffff
117 #define KB_PER_MB (1024)
118 #define KB_PER_GB (1024*1024)
120 #define MS_PER_S 1000
122 #define MS_PER_MIN (1000 * 60)
124 #define S_PER_H (60 * 60)
125 #define MS_PER_H (1000 * 60 * 60)
126 #define MIN_PER_D (60 * 24)
127 #define S_PER_D (60 * 60 * 24)
128 #define MS_PER_D (1000 * 60 * 60 * 24)
130 /* XXX these should appear in other modules' header files */
131 extern bool Log_disconnections;
132 extern int CommitDelay;
133 extern int CommitSiblings;
134 extern char *default_tablespace;
135 extern char *temp_tablespaces;
136 extern bool synchronize_seqscans;
137 extern int ssl_renegotiation_limit;
138 extern char *SSLCipherSuites;
141 extern bool trace_sort;
143 #ifdef TRACE_SYNCSCAN
144 extern bool trace_syncscan;
146 #ifdef DEBUG_BOUNDED_SORT
147 extern bool optimize_bounded_sort;
150 static int GUC_check_errcode_value;
152 /* global variables for check hook support */
153 char *GUC_check_errmsg_string;
154 char *GUC_check_errdetail_string;
155 char *GUC_check_errhint_string;
158 static void set_config_sourcefile(const char *name, char *sourcefile,
160 static bool call_bool_check_hook(struct config_bool * conf, bool *newval,
161 void **extra, GucSource source, int elevel);
162 static bool call_int_check_hook(struct config_int * conf, int *newval,
163 void **extra, GucSource source, int elevel);
164 static bool call_real_check_hook(struct config_real * conf, double *newval,
165 void **extra, GucSource source, int elevel);
166 static bool call_string_check_hook(struct config_string * conf, char **newval,
167 void **extra, GucSource source, int elevel);
168 static bool call_enum_check_hook(struct config_enum * conf, int *newval,
169 void **extra, GucSource source, int elevel);
171 static bool check_log_destination(char **newval, void **extra, GucSource source);
172 static void assign_log_destination(const char *newval, void *extra);
175 static int syslog_facility = LOG_LOCAL0;
177 static int syslog_facility = 0;
180 static void assign_syslog_facility(int newval, void *extra);
181 static void assign_syslog_ident(const char *newval, void *extra);
182 static void assign_session_replication_role(int newval, void *extra);
183 static bool check_temp_buffers(int *newval, void **extra, GucSource source);
184 static bool check_phony_autocommit(bool *newval, void **extra, GucSource source);
185 static bool check_debug_assertions(bool *newval, void **extra, GucSource source);
186 static bool check_bonjour(bool *newval, void **extra, GucSource source);
187 static bool check_ssl(bool *newval, void **extra, GucSource source);
188 static bool check_stage_log_stats(bool *newval, void **extra, GucSource source);
189 static bool check_log_stats(bool *newval, void **extra, GucSource source);
190 static bool check_canonical_path(char **newval, void **extra, GucSource source);
191 static bool check_timezone_abbreviations(char **newval, void **extra, GucSource source);
192 static void assign_timezone_abbreviations(const char *newval, void *extra);
193 static void pg_timezone_abbrev_initialize(void);
194 static const char *show_archive_command(void);
195 static void assign_tcp_keepalives_idle(int newval, void *extra);
196 static void assign_tcp_keepalives_interval(int newval, void *extra);
197 static void assign_tcp_keepalives_count(int newval, void *extra);
198 static const char *show_tcp_keepalives_idle(void);
199 static const char *show_tcp_keepalives_interval(void);
200 static const char *show_tcp_keepalives_count(void);
201 static bool check_maxconnections(int *newval, void **extra, GucSource source);
202 static void assign_maxconnections(int newval, void *extra);
203 static bool check_autovacuum_max_workers(int *newval, void **extra, GucSource source);
204 static void assign_autovacuum_max_workers(int newval, void *extra);
205 static bool check_effective_io_concurrency(int *newval, void **extra, GucSource source);
206 static void assign_effective_io_concurrency(int newval, void *extra);
207 static void assign_pgstat_temp_directory(const char *newval, void *extra);
208 static bool check_application_name(char **newval, void **extra, GucSource source);
209 static void assign_application_name(const char *newval, void *extra);
210 static const char *show_unix_socket_permissions(void);
211 static const char *show_log_file_mode(void);
213 static char *config_enum_get_options(struct config_enum * record,
214 const char *prefix, const char *suffix,
215 const char *separator);
219 * Options for enum values defined in this module.
221 * NOTE! Option values may not contain double quotes!
224 static const struct config_enum_entry bytea_output_options[] = {
225 {"escape", BYTEA_OUTPUT_ESCAPE, false},
226 {"hex", BYTEA_OUTPUT_HEX, false},
231 * We have different sets for client and server message level options because
232 * they sort slightly different (see "log" level)
234 static const struct config_enum_entry client_message_level_options[] = {
235 {"debug", DEBUG2, true},
236 {"debug5", DEBUG5, false},
237 {"debug4", DEBUG4, false},
238 {"debug3", DEBUG3, false},
239 {"debug2", DEBUG2, false},
240 {"debug1", DEBUG1, false},
242 {"info", INFO, true},
243 {"notice", NOTICE, false},
244 {"warning", WARNING, false},
245 {"error", ERROR, false},
246 {"fatal", FATAL, true},
247 {"panic", PANIC, true},
251 static const struct config_enum_entry server_message_level_options[] = {
252 {"debug", DEBUG2, true},
253 {"debug5", DEBUG5, false},
254 {"debug4", DEBUG4, false},
255 {"debug3", DEBUG3, false},
256 {"debug2", DEBUG2, false},
257 {"debug1", DEBUG1, false},
258 {"info", INFO, false},
259 {"notice", NOTICE, false},
260 {"warning", WARNING, false},
261 {"error", ERROR, false},
263 {"fatal", FATAL, false},
264 {"panic", PANIC, false},
268 static const struct config_enum_entry intervalstyle_options[] = {
269 {"postgres", INTSTYLE_POSTGRES, false},
270 {"postgres_verbose", INTSTYLE_POSTGRES_VERBOSE, false},
271 {"sql_standard", INTSTYLE_SQL_STANDARD, false},
272 {"iso_8601", INTSTYLE_ISO_8601, false},
276 static const struct config_enum_entry log_error_verbosity_options[] = {
277 {"terse", PGERROR_TERSE, false},
278 {"default", PGERROR_DEFAULT, false},
279 {"verbose", PGERROR_VERBOSE, false},
283 static const struct config_enum_entry log_statement_options[] = {
284 {"none", LOGSTMT_NONE, false},
285 {"ddl", LOGSTMT_DDL, false},
286 {"mod", LOGSTMT_MOD, false},
287 {"all", LOGSTMT_ALL, false},
291 static const struct config_enum_entry isolation_level_options[] = {
292 {"serializable", XACT_SERIALIZABLE, false},
293 {"repeatable read", XACT_REPEATABLE_READ, false},
294 {"read committed", XACT_READ_COMMITTED, false},
295 {"read uncommitted", XACT_READ_UNCOMMITTED, false},
299 static const struct config_enum_entry session_replication_role_options[] = {
300 {"origin", SESSION_REPLICATION_ROLE_ORIGIN, false},
301 {"replica", SESSION_REPLICATION_ROLE_REPLICA, false},
302 {"local", SESSION_REPLICATION_ROLE_LOCAL, false},
306 static const struct config_enum_entry syslog_facility_options[] = {
308 {"local0", LOG_LOCAL0, false},
309 {"local1", LOG_LOCAL1, false},
310 {"local2", LOG_LOCAL2, false},
311 {"local3", LOG_LOCAL3, false},
312 {"local4", LOG_LOCAL4, false},
313 {"local5", LOG_LOCAL5, false},
314 {"local6", LOG_LOCAL6, false},
315 {"local7", LOG_LOCAL7, false},
322 static const struct config_enum_entry track_function_options[] = {
323 {"none", TRACK_FUNC_OFF, false},
324 {"pl", TRACK_FUNC_PL, false},
325 {"all", TRACK_FUNC_ALL, false},
329 static const struct config_enum_entry xmlbinary_options[] = {
330 {"base64", XMLBINARY_BASE64, false},
331 {"hex", XMLBINARY_HEX, false},
335 static const struct config_enum_entry xmloption_options[] = {
336 {"content", XMLOPTION_CONTENT, false},
337 {"document", XMLOPTION_DOCUMENT, false},
342 * Although only "on", "off", and "safe_encoding" are documented, we
343 * accept all the likely variants of "on" and "off".
345 static const struct config_enum_entry backslash_quote_options[] = {
346 {"safe_encoding", BACKSLASH_QUOTE_SAFE_ENCODING, false},
347 {"on", BACKSLASH_QUOTE_ON, false},
348 {"off", BACKSLASH_QUOTE_OFF, false},
349 {"true", BACKSLASH_QUOTE_ON, true},
350 {"false", BACKSLASH_QUOTE_OFF, true},
351 {"yes", BACKSLASH_QUOTE_ON, true},
352 {"no", BACKSLASH_QUOTE_OFF, true},
353 {"1", BACKSLASH_QUOTE_ON, true},
354 {"0", BACKSLASH_QUOTE_OFF, true},
359 * Although only "on", "off", and "partition" are documented, we
360 * accept all the likely variants of "on" and "off".
362 static const struct config_enum_entry constraint_exclusion_options[] = {
363 {"partition", CONSTRAINT_EXCLUSION_PARTITION, false},
364 {"on", CONSTRAINT_EXCLUSION_ON, false},
365 {"off", CONSTRAINT_EXCLUSION_OFF, false},
366 {"true", CONSTRAINT_EXCLUSION_ON, true},
367 {"false", CONSTRAINT_EXCLUSION_OFF, true},
368 {"yes", CONSTRAINT_EXCLUSION_ON, true},
369 {"no", CONSTRAINT_EXCLUSION_OFF, true},
370 {"1", CONSTRAINT_EXCLUSION_ON, true},
371 {"0", CONSTRAINT_EXCLUSION_OFF, true},
376 * Although only "on", "off", "remote_write", and "local" are documented, we
377 * accept all the likely variants of "on" and "off".
379 static const struct config_enum_entry synchronous_commit_options[] = {
380 {"local", SYNCHRONOUS_COMMIT_LOCAL_FLUSH, false},
381 {"remote_write", SYNCHRONOUS_COMMIT_REMOTE_WRITE, false},
382 {"on", SYNCHRONOUS_COMMIT_ON, false},
383 {"off", SYNCHRONOUS_COMMIT_OFF, false},
384 {"true", SYNCHRONOUS_COMMIT_ON, true},
385 {"false", SYNCHRONOUS_COMMIT_OFF, true},
386 {"yes", SYNCHRONOUS_COMMIT_ON, true},
387 {"no", SYNCHRONOUS_COMMIT_OFF, true},
388 {"1", SYNCHRONOUS_COMMIT_ON, true},
389 {"0", SYNCHRONOUS_COMMIT_OFF, true},
394 * Options for enum values stored in other modules
396 extern const struct config_enum_entry wal_level_options[];
397 extern const struct config_enum_entry sync_method_options[];
400 * GUC option variables that are exported from this module
402 #ifdef USE_ASSERT_CHECKING
403 bool assert_enabled = true;
405 bool assert_enabled = false;
407 bool log_duration = false;
408 bool Debug_print_plan = false;
409 bool Debug_print_parse = false;
410 bool Debug_print_rewritten = false;
411 bool Debug_pretty_print = true;
413 bool log_parser_stats = false;
414 bool log_planner_stats = false;
415 bool log_executor_stats = false;
416 bool log_statement_stats = false; /* this is sort of all three
418 bool log_btree_build_stats = false;
421 bool check_function_bodies = true;
422 bool default_with_oids = false;
423 bool SQL_inheritance = true;
425 bool Password_encryption = true;
427 int log_min_error_statement = ERROR;
428 int log_min_messages = WARNING;
429 int client_min_messages = NOTICE;
430 int log_min_duration_statement = -1;
431 int log_temp_files = -1;
432 int trace_recovery_messages = LOG;
434 int temp_file_limit = -1;
436 int num_temp_buffers = 1024;
438 char *data_directory;
439 char *ConfigFileName;
442 char *external_pid_file;
444 char *pgstat_temp_directory;
446 char *application_name;
448 int tcp_keepalives_idle;
449 int tcp_keepalives_interval;
450 int tcp_keepalives_count;
453 * These variables are all dummies that don't do anything, except in some
454 * cases provide the value for SHOW to display. The real state is elsewhere
455 * and is kept in sync by assign_hooks.
457 static char *log_destination_string;
459 static char *syslog_ident_str;
460 static bool phony_autocommit;
461 static bool session_auth_is_superuser;
462 static double phony_random_seed;
463 static char *client_encoding_string;
464 static char *datestyle_string;
465 static char *locale_collate;
466 static char *locale_ctype;
467 static char *server_encoding_string;
468 static char *server_version_string;
469 static int server_version_num;
470 static char *timezone_string;
471 static char *log_timezone_string;
472 static char *timezone_abbreviations_string;
473 static char *XactIsoLevel_string;
474 static char *session_authorization_string;
475 static int max_function_args;
476 static int max_index_keys;
477 static int max_identifier_length;
478 static int block_size;
479 static int segment_size;
480 static int wal_block_size;
481 static int wal_segment_size;
482 static bool integer_datetimes;
483 static int effective_io_concurrency;
485 /* should be static, but commands/variable.c needs to get at this */
490 * Displayable names for context types (enum GucContext)
492 * Note: these strings are deliberately not localized.
494 const char *const GucContext_Names[] =
496 /* PGC_INTERNAL */ "internal",
497 /* PGC_POSTMASTER */ "postmaster",
498 /* PGC_SIGHUP */ "sighup",
499 /* PGC_BACKEND */ "backend",
500 /* PGC_SUSET */ "superuser",
501 /* PGC_USERSET */ "user"
505 * Displayable names for source types (enum GucSource)
507 * Note: these strings are deliberately not localized.
509 const char *const GucSource_Names[] =
511 /* PGC_S_DEFAULT */ "default",
512 /* PGC_S_DYNAMIC_DEFAULT */ "default",
513 /* PGC_S_ENV_VAR */ "environment variable",
514 /* PGC_S_FILE */ "configuration file",
515 /* PGC_S_ARGV */ "command line",
516 /* PGC_S_DATABASE */ "database",
517 /* PGC_S_USER */ "user",
518 /* PGC_S_DATABASE_USER */ "database user",
519 /* PGC_S_CLIENT */ "client",
520 /* PGC_S_OVERRIDE */ "override",
521 /* PGC_S_INTERACTIVE */ "interactive",
522 /* PGC_S_TEST */ "test",
523 /* PGC_S_SESSION */ "session"
527 * Displayable names for the groupings defined in enum config_group
529 const char *const config_group_names[] =
532 gettext_noop("Ungrouped"),
534 gettext_noop("File Locations"),
536 gettext_noop("Connections and Authentication"),
537 /* CONN_AUTH_SETTINGS */
538 gettext_noop("Connections and Authentication / Connection Settings"),
539 /* CONN_AUTH_SECURITY */
540 gettext_noop("Connections and Authentication / Security and Authentication"),
542 gettext_noop("Resource Usage"),
544 gettext_noop("Resource Usage / Memory"),
546 gettext_noop("Resource Usage / Disk"),
547 /* RESOURCES_KERNEL */
548 gettext_noop("Resource Usage / Kernel Resources"),
549 /* RESOURCES_VACUUM_DELAY */
550 gettext_noop("Resource Usage / Cost-Based Vacuum Delay"),
551 /* RESOURCES_BGWRITER */
552 gettext_noop("Resource Usage / Background Writer"),
553 /* RESOURCES_ASYNCHRONOUS */
554 gettext_noop("Resource Usage / Asynchronous Behavior"),
556 gettext_noop("Write-Ahead Log"),
558 gettext_noop("Write-Ahead Log / Settings"),
559 /* WAL_CHECKPOINTS */
560 gettext_noop("Write-Ahead Log / Checkpoints"),
562 gettext_noop("Write-Ahead Log / Archiving"),
564 gettext_noop("Replication"),
565 /* REPLICATION_SENDING */
566 gettext_noop("Replication / Sending Servers"),
567 /* REPLICATION_MASTER */
568 gettext_noop("Replication / Master Server"),
569 /* REPLICATION_STANDBY */
570 gettext_noop("Replication / Standby Servers"),
572 gettext_noop("Query Tuning"),
573 /* QUERY_TUNING_METHOD */
574 gettext_noop("Query Tuning / Planner Method Configuration"),
575 /* QUERY_TUNING_COST */
576 gettext_noop("Query Tuning / Planner Cost Constants"),
577 /* QUERY_TUNING_GEQO */
578 gettext_noop("Query Tuning / Genetic Query Optimizer"),
579 /* QUERY_TUNING_OTHER */
580 gettext_noop("Query Tuning / Other Planner Options"),
582 gettext_noop("Reporting and Logging"),
584 gettext_noop("Reporting and Logging / Where to Log"),
586 gettext_noop("Reporting and Logging / When to Log"),
588 gettext_noop("Reporting and Logging / What to Log"),
590 gettext_noop("Statistics"),
591 /* STATS_MONITORING */
592 gettext_noop("Statistics / Monitoring"),
593 /* STATS_COLLECTOR */
594 gettext_noop("Statistics / Query and Index Statistics Collector"),
596 gettext_noop("Autovacuum"),
598 gettext_noop("Client Connection Defaults"),
599 /* CLIENT_CONN_STATEMENT */
600 gettext_noop("Client Connection Defaults / Statement Behavior"),
601 /* CLIENT_CONN_LOCALE */
602 gettext_noop("Client Connection Defaults / Locale and Formatting"),
603 /* CLIENT_CONN_OTHER */
604 gettext_noop("Client Connection Defaults / Other Defaults"),
605 /* LOCK_MANAGEMENT */
606 gettext_noop("Lock Management"),
608 gettext_noop("Version and Platform Compatibility"),
609 /* COMPAT_OPTIONS_PREVIOUS */
610 gettext_noop("Version and Platform Compatibility / Previous PostgreSQL Versions"),
611 /* COMPAT_OPTIONS_CLIENT */
612 gettext_noop("Version and Platform Compatibility / Other Platforms and Clients"),
614 gettext_noop("Error Handling"),
616 gettext_noop("Preset Options"),
618 gettext_noop("Customized Options"),
619 /* DEVELOPER_OPTIONS */
620 gettext_noop("Developer Options"),
621 /* help_config wants this array to be null-terminated */
626 * Displayable names for GUC variable types (enum config_type)
628 * Note: these strings are deliberately not localized.
630 const char *const config_type_names[] =
632 /* PGC_BOOL */ "bool",
633 /* PGC_INT */ "integer",
634 /* PGC_REAL */ "real",
635 /* PGC_STRING */ "string",
636 /* PGC_ENUM */ "enum"
641 * Contents of GUC tables
643 * See src/backend/utils/misc/README for design notes.
647 * 1. Declare a global variable of type bool, int, double, or char*
648 * and make use of it.
650 * 2. Decide at what times it's safe to set the option. See guc.h for
653 * 3. Decide on a name, a default value, upper and lower bounds (if
656 * 4. Add a record below.
658 * 5. Add it to src/backend/utils/misc/postgresql.conf.sample, if
661 * 6. Don't forget to document the option (at least in config.sgml).
663 * 7. If it's a new GUC_LIST option you must edit pg_dumpall.c to ensure
664 * it is not single quoted at dump time.
668 /******** option records follow ********/
670 static struct config_bool ConfigureNamesBool[] =
673 {"enable_seqscan", PGC_USERSET, QUERY_TUNING_METHOD,
674 gettext_noop("Enables the planner's use of sequential-scan plans."),
682 {"enable_indexscan", PGC_USERSET, QUERY_TUNING_METHOD,
683 gettext_noop("Enables the planner's use of index-scan plans."),
691 {"enable_indexonlyscan", PGC_USERSET, QUERY_TUNING_METHOD,
692 gettext_noop("Enables the planner's use of index-only-scan plans."),
695 &enable_indexonlyscan,
700 {"enable_bitmapscan", PGC_USERSET, QUERY_TUNING_METHOD,
701 gettext_noop("Enables the planner's use of bitmap-scan plans."),
709 {"enable_tidscan", PGC_USERSET, QUERY_TUNING_METHOD,
710 gettext_noop("Enables the planner's use of TID scan plans."),
718 {"enable_sort", PGC_USERSET, QUERY_TUNING_METHOD,
719 gettext_noop("Enables the planner's use of explicit sort steps."),
727 {"enable_hashagg", PGC_USERSET, QUERY_TUNING_METHOD,
728 gettext_noop("Enables the planner's use of hashed aggregation plans."),
736 {"enable_material", PGC_USERSET, QUERY_TUNING_METHOD,
737 gettext_noop("Enables the planner's use of materialization."),
745 {"enable_nestloop", PGC_USERSET, QUERY_TUNING_METHOD,
746 gettext_noop("Enables the planner's use of nested-loop join plans."),
754 {"enable_mergejoin", PGC_USERSET, QUERY_TUNING_METHOD,
755 gettext_noop("Enables the planner's use of merge join plans."),
763 {"enable_hashjoin", PGC_USERSET, QUERY_TUNING_METHOD,
764 gettext_noop("Enables the planner's use of hash join plans."),
772 {"geqo", PGC_USERSET, QUERY_TUNING_GEQO,
773 gettext_noop("Enables genetic query optimization."),
774 gettext_noop("This algorithm attempts to do planning without "
775 "exhaustive searching.")
782 /* Not for general use --- used by SET SESSION AUTHORIZATION */
783 {"is_superuser", PGC_INTERNAL, UNGROUPED,
784 gettext_noop("Shows whether the current user is a superuser."),
786 GUC_REPORT | GUC_NO_SHOW_ALL | GUC_NO_RESET_ALL | GUC_NOT_IN_SAMPLE | GUC_DISALLOW_IN_FILE
788 &session_auth_is_superuser,
793 {"bonjour", PGC_POSTMASTER, CONN_AUTH_SETTINGS,
794 gettext_noop("Enables advertising the server via Bonjour."),
799 check_bonjour, NULL, NULL
802 {"ssl", PGC_POSTMASTER, CONN_AUTH_SECURITY,
803 gettext_noop("Enables SSL connections."),
808 check_ssl, NULL, NULL
811 {"fsync", PGC_SIGHUP, WAL_SETTINGS,
812 gettext_noop("Forces synchronization of updates to disk."),
813 gettext_noop("The server will use the fsync() system call in several places to make "
814 "sure that updates are physically written to disk. This insures "
815 "that a database cluster will recover to a consistent state after "
816 "an operating system or hardware crash.")
823 {"zero_damaged_pages", PGC_SUSET, DEVELOPER_OPTIONS,
824 gettext_noop("Continues processing past damaged page headers."),
825 gettext_noop("Detection of a damaged page header normally causes PostgreSQL to "
826 "report an error, aborting the current transaction. Setting "
827 "zero_damaged_pages to true causes the system to instead report a "
828 "warning, zero out the damaged page, and continue processing. This "
829 "behavior will destroy data, namely all the rows on the damaged page."),
837 {"full_page_writes", PGC_SIGHUP, WAL_SETTINGS,
838 gettext_noop("Writes full pages to WAL when first modified after a checkpoint."),
839 gettext_noop("A page write in process during an operating system crash might be "
840 "only partially written to disk. During recovery, the row changes "
841 "stored in WAL are not enough to recover. This option writes "
842 "pages when first modified after a checkpoint to WAL so full recovery "
850 {"log_checkpoints", PGC_SIGHUP, LOGGING_WHAT,
851 gettext_noop("Logs each checkpoint."),
859 {"log_connections", PGC_BACKEND, LOGGING_WHAT,
860 gettext_noop("Logs each successful connection."),
868 {"log_disconnections", PGC_BACKEND, LOGGING_WHAT,
869 gettext_noop("Logs end of a session, including duration."),
877 {"debug_assertions", PGC_USERSET, DEVELOPER_OPTIONS,
878 gettext_noop("Turns on various assertion checks."),
879 gettext_noop("This is a debugging aid."),
883 #ifdef USE_ASSERT_CHECKING
888 check_debug_assertions, NULL, NULL
892 {"exit_on_error", PGC_USERSET, ERROR_HANDLING_OPTIONS,
893 gettext_noop("Terminate session on any error."),
901 {"restart_after_crash", PGC_SIGHUP, ERROR_HANDLING_OPTIONS,
902 gettext_noop("Reinitialize server after backend crash."),
905 &restart_after_crash,
911 {"log_duration", PGC_SUSET, LOGGING_WHAT,
912 gettext_noop("Logs the duration of each completed SQL statement."),
920 {"debug_print_parse", PGC_USERSET, LOGGING_WHAT,
921 gettext_noop("Logs each query's parse tree."),
929 {"debug_print_rewritten", PGC_USERSET, LOGGING_WHAT,
930 gettext_noop("Logs each query's rewritten parse tree."),
933 &Debug_print_rewritten,
938 {"debug_print_plan", PGC_USERSET, LOGGING_WHAT,
939 gettext_noop("Logs each query's execution plan."),
947 {"debug_pretty_print", PGC_USERSET, LOGGING_WHAT,
948 gettext_noop("Indents parse and plan tree displays."),
956 {"log_parser_stats", PGC_SUSET, STATS_MONITORING,
957 gettext_noop("Writes parser performance statistics to the server log."),
962 check_stage_log_stats, NULL, NULL
965 {"log_planner_stats", PGC_SUSET, STATS_MONITORING,
966 gettext_noop("Writes planner performance statistics to the server log."),
971 check_stage_log_stats, NULL, NULL
974 {"log_executor_stats", PGC_SUSET, STATS_MONITORING,
975 gettext_noop("Writes executor performance statistics to the server log."),
980 check_stage_log_stats, NULL, NULL
983 {"log_statement_stats", PGC_SUSET, STATS_MONITORING,
984 gettext_noop("Writes cumulative performance statistics to the server log."),
987 &log_statement_stats,
989 check_log_stats, NULL, NULL
991 #ifdef BTREE_BUILD_STATS
993 {"log_btree_build_stats", PGC_SUSET, DEVELOPER_OPTIONS,
994 gettext_noop("No description available."),
998 &log_btree_build_stats,
1005 {"track_activities", PGC_SUSET, STATS_COLLECTOR,
1006 gettext_noop("Collects information about executing commands."),
1007 gettext_noop("Enables the collection of information on the currently "
1008 "executing command of each session, along with "
1009 "the time at which that command began execution.")
1011 &pgstat_track_activities,
1016 {"track_counts", PGC_SUSET, STATS_COLLECTOR,
1017 gettext_noop("Collects statistics on database activity."),
1020 &pgstat_track_counts,
1025 {"track_io_timing", PGC_SUSET, STATS_COLLECTOR,
1026 gettext_noop("Collects timing statistics for database I/O activity."),
1035 {"update_process_title", PGC_SUSET, STATS_COLLECTOR,
1036 gettext_noop("Updates the process title to show the active SQL command."),
1037 gettext_noop("Enables updating of the process title every time a new SQL command is received by the server.")
1039 &update_process_title,
1045 {"autovacuum", PGC_SIGHUP, AUTOVACUUM,
1046 gettext_noop("Starts the autovacuum subprocess."),
1049 &autovacuum_start_daemon,
1055 {"trace_notify", PGC_USERSET, DEVELOPER_OPTIONS,
1056 gettext_noop("Generates debugging output for LISTEN and NOTIFY."),
1067 {"trace_locks", PGC_SUSET, DEVELOPER_OPTIONS,
1068 gettext_noop("No description available."),
1077 {"trace_userlocks", PGC_SUSET, DEVELOPER_OPTIONS,
1078 gettext_noop("No description available."),
1087 {"trace_lwlocks", PGC_SUSET, DEVELOPER_OPTIONS,
1088 gettext_noop("No description available."),
1097 {"debug_deadlocks", PGC_SUSET, DEVELOPER_OPTIONS,
1098 gettext_noop("No description available."),
1109 {"log_lock_waits", PGC_SUSET, LOGGING_WHAT,
1110 gettext_noop("Logs long lock waits."),
1119 {"log_hostname", PGC_SIGHUP, LOGGING_WHAT,
1120 gettext_noop("Logs the host name in the connection logs."),
1121 gettext_noop("By default, connection logs only show the IP address "
1122 "of the connecting host. If you want them to show the host name you "
1123 "can turn this on, but depending on your host name resolution "
1124 "setup it might impose a non-negligible performance penalty.")
1131 {"sql_inheritance", PGC_USERSET, COMPAT_OPTIONS_PREVIOUS,
1132 gettext_noop("Causes subtables to be included by default in various commands."),
1140 {"password_encryption", PGC_USERSET, CONN_AUTH_SECURITY,
1141 gettext_noop("Encrypt passwords."),
1142 gettext_noop("When a password is specified in CREATE USER or "
1143 "ALTER USER without writing either ENCRYPTED or UNENCRYPTED, "
1144 "this parameter determines whether the password is to be encrypted.")
1146 &Password_encryption,
1151 {"transform_null_equals", PGC_USERSET, COMPAT_OPTIONS_CLIENT,
1152 gettext_noop("Treats \"expr=NULL\" as \"expr IS NULL\"."),
1153 gettext_noop("When turned on, expressions of the form expr = NULL "
1154 "(or NULL = expr) are treated as expr IS NULL, that is, they "
1155 "return true if expr evaluates to the null value, and false "
1156 "otherwise. The correct behavior of expr = NULL is to always "
1157 "return null (unknown).")
1159 &Transform_null_equals,
1164 {"db_user_namespace", PGC_SIGHUP, CONN_AUTH_SECURITY,
1165 gettext_noop("Enables per-database user names."),
1173 /* only here for backwards compatibility */
1174 {"autocommit", PGC_USERSET, CLIENT_CONN_STATEMENT,
1175 gettext_noop("This parameter doesn't do anything."),
1176 gettext_noop("It's just here so that we won't choke on SET AUTOCOMMIT TO ON from 7.3-vintage clients."),
1177 GUC_NO_SHOW_ALL | GUC_NOT_IN_SAMPLE
1181 check_phony_autocommit, NULL, NULL
1184 {"default_transaction_read_only", PGC_USERSET, CLIENT_CONN_STATEMENT,
1185 gettext_noop("Sets the default read-only status of new transactions."),
1188 &DefaultXactReadOnly,
1193 {"transaction_read_only", PGC_USERSET, CLIENT_CONN_STATEMENT,
1194 gettext_noop("Sets the current transaction's read-only status."),
1196 GUC_NO_RESET_ALL | GUC_NOT_IN_SAMPLE | GUC_DISALLOW_IN_FILE
1200 check_transaction_read_only, NULL, NULL
1203 {"default_transaction_deferrable", PGC_USERSET, CLIENT_CONN_STATEMENT,
1204 gettext_noop("Sets the default deferrable status of new transactions."),
1207 &DefaultXactDeferrable,
1212 {"transaction_deferrable", PGC_USERSET, CLIENT_CONN_STATEMENT,
1213 gettext_noop("Whether to defer a read-only serializable transaction until it can be executed with no possible serialization failures."),
1215 GUC_NO_RESET_ALL | GUC_NOT_IN_SAMPLE | GUC_DISALLOW_IN_FILE
1219 check_transaction_deferrable, NULL, NULL
1222 {"check_function_bodies", PGC_USERSET, CLIENT_CONN_STATEMENT,
1223 gettext_noop("Check function bodies during CREATE FUNCTION."),
1226 &check_function_bodies,
1231 {"array_nulls", PGC_USERSET, COMPAT_OPTIONS_PREVIOUS,
1232 gettext_noop("Enable input of NULL elements in arrays."),
1233 gettext_noop("When turned on, unquoted NULL in an array input "
1234 "value means a null value; "
1235 "otherwise it is taken literally.")
1242 {"default_with_oids", PGC_USERSET, COMPAT_OPTIONS_PREVIOUS,
1243 gettext_noop("Create new tables with OIDs by default."),
1251 {"logging_collector", PGC_POSTMASTER, LOGGING_WHERE,
1252 gettext_noop("Start a subprocess to capture stderr output and/or csvlogs into log files."),
1260 {"log_truncate_on_rotation", PGC_SIGHUP, LOGGING_WHERE,
1261 gettext_noop("Truncate existing log files of same name during log rotation."),
1264 &Log_truncate_on_rotation,
1271 {"trace_sort", PGC_USERSET, DEVELOPER_OPTIONS,
1272 gettext_noop("Emit information about resource usage in sorting."),
1282 #ifdef TRACE_SYNCSCAN
1283 /* this is undocumented because not exposed in a standard build */
1285 {"trace_syncscan", PGC_USERSET, DEVELOPER_OPTIONS,
1286 gettext_noop("Generate debugging output for synchronized scanning."),
1296 #ifdef DEBUG_BOUNDED_SORT
1297 /* this is undocumented because not exposed in a standard build */
1300 "optimize_bounded_sort", PGC_USERSET, QUERY_TUNING_METHOD,
1301 gettext_noop("Enable bounded sorting using heap sort."),
1305 &optimize_bounded_sort,
1313 {"wal_debug", PGC_SUSET, DEVELOPER_OPTIONS,
1314 gettext_noop("Emit WAL-related debugging output."),
1325 {"integer_datetimes", PGC_INTERNAL, PRESET_OPTIONS,
1326 gettext_noop("Datetimes are integer based."),
1328 GUC_REPORT | GUC_NOT_IN_SAMPLE | GUC_DISALLOW_IN_FILE
1331 #ifdef HAVE_INT64_TIMESTAMP
1340 {"krb_caseins_users", PGC_SIGHUP, CONN_AUTH_SECURITY,
1341 gettext_noop("Sets whether Kerberos and GSSAPI user names should be treated as case-insensitive."),
1344 &pg_krb_caseins_users,
1350 {"escape_string_warning", PGC_USERSET, COMPAT_OPTIONS_PREVIOUS,
1351 gettext_noop("Warn about backslash escapes in ordinary string literals."),
1354 &escape_string_warning,
1360 {"standard_conforming_strings", PGC_USERSET, COMPAT_OPTIONS_PREVIOUS,
1361 gettext_noop("Causes '...' strings to treat backslashes literally."),
1365 &standard_conforming_strings,
1371 {"synchronize_seqscans", PGC_USERSET, COMPAT_OPTIONS_PREVIOUS,
1372 gettext_noop("Enable synchronized sequential scans."),
1375 &synchronize_seqscans,
1381 {"archive_mode", PGC_POSTMASTER, WAL_ARCHIVING,
1382 gettext_noop("Allows archiving of WAL files using archive_command."),
1391 {"hot_standby", PGC_POSTMASTER, REPLICATION_STANDBY,
1392 gettext_noop("Allows connections and queries during recovery."),
1401 {"hot_standby_feedback", PGC_SIGHUP, REPLICATION_STANDBY,
1402 gettext_noop("Allows feedback from a hot standby to the primary that will avoid query conflicts."),
1405 &hot_standby_feedback,
1411 {"allow_system_table_mods", PGC_POSTMASTER, DEVELOPER_OPTIONS,
1412 gettext_noop("Allows modifications of the structure of system tables."),
1416 &allowSystemTableMods,
1422 {"ignore_system_indexes", PGC_BACKEND, DEVELOPER_OPTIONS,
1423 gettext_noop("Disables reading from system indexes."),
1424 gettext_noop("It does not prevent updating the indexes, so it is safe "
1425 "to use. The worst consequence is slowness."),
1428 &IgnoreSystemIndexes,
1434 {"lo_compat_privileges", PGC_SUSET, COMPAT_OPTIONS_PREVIOUS,
1435 gettext_noop("Enables backward compatibility mode for privilege checks on large objects."),
1436 gettext_noop("Skips privilege checks when reading or modifying large objects, "
1437 "for compatibility with PostgreSQL releases prior to 9.0.")
1439 &lo_compat_privileges,
1445 {"quote_all_identifiers", PGC_USERSET, COMPAT_OPTIONS_PREVIOUS,
1446 gettext_noop("When generating SQL fragments, quote all identifiers."),
1449 "e_all_identifiers,
1454 /* End-of-list marker */
1456 {NULL, 0, 0, NULL, NULL}, NULL, false, NULL, NULL, NULL
1461 static struct config_int ConfigureNamesInt[] =
1464 {"archive_timeout", PGC_SIGHUP, WAL_ARCHIVING,
1465 gettext_noop("Forces a switch to the next xlog file if a "
1466 "new file has not been started within N seconds."),
1470 &XLogArchiveTimeout,
1475 {"post_auth_delay", PGC_BACKEND, DEVELOPER_OPTIONS,
1476 gettext_noop("Waits N seconds on connection startup after authentication."),
1477 gettext_noop("This allows attaching a debugger to the process."),
1478 GUC_NOT_IN_SAMPLE | GUC_UNIT_S
1481 0, 0, INT_MAX / 1000000,
1485 {"default_statistics_target", PGC_USERSET, QUERY_TUNING_OTHER,
1486 gettext_noop("Sets the default statistics target."),
1487 gettext_noop("This applies to table columns that have not had a "
1488 "column-specific target set via ALTER TABLE SET STATISTICS.")
1490 &default_statistics_target,
1495 {"from_collapse_limit", PGC_USERSET, QUERY_TUNING_OTHER,
1496 gettext_noop("Sets the FROM-list size beyond which subqueries "
1497 "are not collapsed."),
1498 gettext_noop("The planner will merge subqueries into upper "
1499 "queries if the resulting FROM list would have no more than "
1502 &from_collapse_limit,
1507 {"join_collapse_limit", PGC_USERSET, QUERY_TUNING_OTHER,
1508 gettext_noop("Sets the FROM-list size beyond which JOIN "
1509 "constructs are not flattened."),
1510 gettext_noop("The planner will flatten explicit JOIN "
1511 "constructs into lists of FROM items whenever a "
1512 "list of no more than this many items would result.")
1514 &join_collapse_limit,
1519 {"geqo_threshold", PGC_USERSET, QUERY_TUNING_GEQO,
1520 gettext_noop("Sets the threshold of FROM items beyond which GEQO is used."),
1528 {"geqo_effort", PGC_USERSET, QUERY_TUNING_GEQO,
1529 gettext_noop("GEQO: effort is used to set the default for other GEQO parameters."),
1533 DEFAULT_GEQO_EFFORT, MIN_GEQO_EFFORT, MAX_GEQO_EFFORT,
1537 {"geqo_pool_size", PGC_USERSET, QUERY_TUNING_GEQO,
1538 gettext_noop("GEQO: number of individuals in the population."),
1539 gettext_noop("Zero selects a suitable default value.")
1546 {"geqo_generations", PGC_USERSET, QUERY_TUNING_GEQO,
1547 gettext_noop("GEQO: number of iterations of the algorithm."),
1548 gettext_noop("Zero selects a suitable default value.")
1556 /* This is PGC_SUSET to prevent hiding from log_lock_waits. */
1557 {"deadlock_timeout", PGC_SUSET, LOCK_MANAGEMENT,
1558 gettext_noop("Sets the time to wait on a lock before checking for deadlock."),
1568 {"max_standby_archive_delay", PGC_SIGHUP, REPLICATION_STANDBY,
1569 gettext_noop("Sets the maximum delay before canceling queries when a hot standby server is processing archived WAL data."),
1573 &max_standby_archive_delay,
1574 30 * 1000, -1, INT_MAX,
1579 {"max_standby_streaming_delay", PGC_SIGHUP, REPLICATION_STANDBY,
1580 gettext_noop("Sets the maximum delay before canceling queries when a hot standby server is processing streamed WAL data."),
1584 &max_standby_streaming_delay,
1585 30 * 1000, -1, INT_MAX,
1590 {"wal_receiver_status_interval", PGC_SIGHUP, REPLICATION_STANDBY,
1591 gettext_noop("Sets the maximum interval between WAL receiver status reports to the primary."),
1595 &wal_receiver_status_interval,
1596 10, 0, INT_MAX / 1000,
1601 {"wal_receiver_timeout", PGC_SIGHUP, REPLICATION_STANDBY,
1602 gettext_noop("Sets the maximum wait time to receive data from master."),
1606 &wal_receiver_timeout,
1607 60 * 1000, 0, INT_MAX,
1612 {"max_connections", PGC_POSTMASTER, CONN_AUTH_SETTINGS,
1613 gettext_noop("Sets the maximum number of concurrent connections."),
1617 100, 1, MAX_BACKENDS,
1618 check_maxconnections, assign_maxconnections, NULL
1622 {"superuser_reserved_connections", PGC_POSTMASTER, CONN_AUTH_SETTINGS,
1623 gettext_noop("Sets the number of connection slots reserved for superusers."),
1632 * We sometimes multiply the number of shared buffers by two without
1633 * checking for overflow, so we mustn't allow more than INT_MAX / 2.
1636 {"shared_buffers", PGC_POSTMASTER, RESOURCES_MEM,
1637 gettext_noop("Sets the number of shared memory buffers used by the server."),
1642 1024, 16, INT_MAX / 2,
1647 {"temp_buffers", PGC_USERSET, RESOURCES_MEM,
1648 gettext_noop("Sets the maximum number of temporary buffers used by each session."),
1653 1024, 100, INT_MAX / 2,
1654 check_temp_buffers, NULL, NULL
1658 {"port", PGC_POSTMASTER, CONN_AUTH_SETTINGS,
1659 gettext_noop("Sets the TCP port the server listens on."),
1663 DEF_PGPORT, 1, 65535,
1668 {"unix_socket_permissions", PGC_POSTMASTER, CONN_AUTH_SETTINGS,
1669 gettext_noop("Sets the access permissions of the Unix-domain socket."),
1670 gettext_noop("Unix-domain sockets use the usual Unix file system "
1671 "permission set. The parameter value is expected "
1672 "to be a numeric mode specification in the form "
1673 "accepted by the chmod and umask system calls. "
1674 "(To use the customary octal format the number must "
1675 "start with a 0 (zero).)")
1677 &Unix_socket_permissions,
1679 NULL, NULL, show_unix_socket_permissions
1683 {"log_file_mode", PGC_SIGHUP, LOGGING_WHERE,
1684 gettext_noop("Sets the file permissions for log files."),
1685 gettext_noop("The parameter value is expected "
1686 "to be a numeric mode specification in the form "
1687 "accepted by the chmod and umask system calls. "
1688 "(To use the customary octal format the number must "
1689 "start with a 0 (zero).)")
1693 NULL, NULL, show_log_file_mode
1697 {"work_mem", PGC_USERSET, RESOURCES_MEM,
1698 gettext_noop("Sets the maximum memory to be used for query workspaces."),
1699 gettext_noop("This much memory can be used by each internal "
1700 "sort operation and hash table before switching to "
1701 "temporary disk files."),
1705 1024, 64, MAX_KILOBYTES,
1710 {"maintenance_work_mem", PGC_USERSET, RESOURCES_MEM,
1711 gettext_noop("Sets the maximum memory to be used for maintenance operations."),
1712 gettext_noop("This includes operations such as VACUUM and CREATE INDEX."),
1715 &maintenance_work_mem,
1716 16384, 1024, MAX_KILOBYTES,
1721 * We use the hopefully-safely-small value of 100kB as the compiled-in
1722 * default for max_stack_depth. InitializeGUCOptions will increase it if
1723 * possible, depending on the actual platform-specific stack limit.
1726 {"max_stack_depth", PGC_SUSET, RESOURCES_MEM,
1727 gettext_noop("Sets the maximum stack depth, in kilobytes."),
1732 100, 100, MAX_KILOBYTES,
1733 check_max_stack_depth, assign_max_stack_depth, NULL
1737 {"temp_file_limit", PGC_SUSET, RESOURCES_DISK,
1738 gettext_noop("Limits the total size of all temporary files used by each session."),
1739 gettext_noop("-1 means no limit."),
1748 {"vacuum_cost_page_hit", PGC_USERSET, RESOURCES_VACUUM_DELAY,
1749 gettext_noop("Vacuum cost for a page found in the buffer cache."),
1758 {"vacuum_cost_page_miss", PGC_USERSET, RESOURCES_VACUUM_DELAY,
1759 gettext_noop("Vacuum cost for a page not found in the buffer cache."),
1762 &VacuumCostPageMiss,
1768 {"vacuum_cost_page_dirty", PGC_USERSET, RESOURCES_VACUUM_DELAY,
1769 gettext_noop("Vacuum cost for a page dirtied by vacuum."),
1772 &VacuumCostPageDirty,
1778 {"vacuum_cost_limit", PGC_USERSET, RESOURCES_VACUUM_DELAY,
1779 gettext_noop("Vacuum cost amount available before napping."),
1788 {"vacuum_cost_delay", PGC_USERSET, RESOURCES_VACUUM_DELAY,
1789 gettext_noop("Vacuum cost delay in milliseconds."),
1799 {"autovacuum_vacuum_cost_delay", PGC_SIGHUP, AUTOVACUUM,
1800 gettext_noop("Vacuum cost delay in milliseconds, for autovacuum."),
1804 &autovacuum_vac_cost_delay,
1810 {"autovacuum_vacuum_cost_limit", PGC_SIGHUP, AUTOVACUUM,
1811 gettext_noop("Vacuum cost amount available before napping, for autovacuum."),
1814 &autovacuum_vac_cost_limit,
1820 {"max_files_per_process", PGC_POSTMASTER, RESOURCES_KERNEL,
1821 gettext_noop("Sets the maximum number of simultaneously open files for each server process."),
1824 &max_files_per_process,
1830 * See also CheckRequiredParameterValues() if this parameter changes
1833 {"max_prepared_transactions", PGC_POSTMASTER, RESOURCES_MEM,
1834 gettext_noop("Sets the maximum number of simultaneously prepared transactions."),
1837 &max_prepared_xacts,
1844 {"trace_lock_oidmin", PGC_SUSET, DEVELOPER_OPTIONS,
1845 gettext_noop("No description available."),
1850 FirstNormalObjectId, 0, INT_MAX,
1854 {"trace_lock_table", PGC_SUSET, DEVELOPER_OPTIONS,
1855 gettext_noop("No description available."),
1866 {"statement_timeout", PGC_USERSET, CLIENT_CONN_STATEMENT,
1867 gettext_noop("Sets the maximum allowed duration of any statement."),
1868 gettext_noop("A value of 0 turns off the timeout."),
1877 {"vacuum_freeze_min_age", PGC_USERSET, CLIENT_CONN_STATEMENT,
1878 gettext_noop("Minimum age at which VACUUM should freeze a table row."),
1881 &vacuum_freeze_min_age,
1882 50000000, 0, 1000000000,
1887 {"vacuum_freeze_table_age", PGC_USERSET, CLIENT_CONN_STATEMENT,
1888 gettext_noop("Age at which VACUUM should scan whole table to freeze tuples."),
1891 &vacuum_freeze_table_age,
1892 150000000, 0, 2000000000,
1897 {"vacuum_defer_cleanup_age", PGC_SIGHUP, REPLICATION_MASTER,
1898 gettext_noop("Number of transactions by which VACUUM and HOT cleanup should be deferred, if any."),
1901 &vacuum_defer_cleanup_age,
1907 * See also CheckRequiredParameterValues() if this parameter changes
1910 {"max_locks_per_transaction", PGC_POSTMASTER, LOCK_MANAGEMENT,
1911 gettext_noop("Sets the maximum number of locks per transaction."),
1912 gettext_noop("The shared lock table is sized on the assumption that "
1913 "at most max_locks_per_transaction * max_connections distinct "
1914 "objects will need to be locked at any one time.")
1916 &max_locks_per_xact,
1922 {"max_pred_locks_per_transaction", PGC_POSTMASTER, LOCK_MANAGEMENT,
1923 gettext_noop("Sets the maximum number of predicate locks per transaction."),
1924 gettext_noop("The shared predicate lock table is sized on the assumption that "
1925 "at most max_pred_locks_per_transaction * max_connections distinct "
1926 "objects will need to be locked at any one time.")
1928 &max_predicate_locks_per_xact,
1934 {"authentication_timeout", PGC_SIGHUP, CONN_AUTH_SECURITY,
1935 gettext_noop("Sets the maximum allowed time to complete client authentication."),
1939 &AuthenticationTimeout,
1945 /* Not for general use */
1946 {"pre_auth_delay", PGC_SIGHUP, DEVELOPER_OPTIONS,
1947 gettext_noop("Waits N seconds on connection startup before authentication."),
1948 gettext_noop("This allows attaching a debugger to the process."),
1949 GUC_NOT_IN_SAMPLE | GUC_UNIT_S
1957 {"wal_keep_segments", PGC_SIGHUP, REPLICATION_SENDING,
1958 gettext_noop("Sets the number of WAL files held for standby servers."),
1967 {"checkpoint_segments", PGC_SIGHUP, WAL_CHECKPOINTS,
1968 gettext_noop("Sets the maximum distance in log segments between automatic WAL checkpoints."),
1971 &CheckPointSegments,
1977 {"checkpoint_timeout", PGC_SIGHUP, WAL_CHECKPOINTS,
1978 gettext_noop("Sets the maximum time between automatic WAL checkpoints."),
1988 {"checkpoint_warning", PGC_SIGHUP, WAL_CHECKPOINTS,
1989 gettext_noop("Enables warnings if checkpoint segments are filled more "
1990 "frequently than this."),
1991 gettext_noop("Write a message to the server log if checkpoints "
1992 "caused by the filling of checkpoint segment files happens more "
1993 "frequently than this number of seconds. Zero turns off the warning."),
2002 {"wal_buffers", PGC_POSTMASTER, WAL_SETTINGS,
2003 gettext_noop("Sets the number of disk-page buffers in shared memory for WAL."),
2009 check_wal_buffers, NULL, NULL
2013 {"wal_writer_delay", PGC_SIGHUP, WAL_SETTINGS,
2014 gettext_noop("WAL writer sleep time between WAL flushes."),
2024 /* see max_connections */
2025 {"max_wal_senders", PGC_POSTMASTER, REPLICATION_SENDING,
2026 gettext_noop("Sets the maximum number of simultaneously running WAL sender processes."),
2035 {"wal_sender_timeout", PGC_SIGHUP, REPLICATION_SENDING,
2036 gettext_noop("Sets the maximum time to wait for WAL replication."),
2040 &wal_sender_timeout,
2041 60 * 1000, 0, INT_MAX,
2046 {"commit_delay", PGC_USERSET, WAL_SETTINGS,
2047 gettext_noop("Sets the delay in microseconds between transaction commit and "
2048 "flushing WAL to disk."),
2050 /* we have no microseconds designation, so can't supply units here */
2058 {"commit_siblings", PGC_USERSET, WAL_SETTINGS,
2059 gettext_noop("Sets the minimum concurrent open transactions before performing "
2069 {"extra_float_digits", PGC_USERSET, CLIENT_CONN_LOCALE,
2070 gettext_noop("Sets the number of digits displayed for floating-point values."),
2071 gettext_noop("This affects real, double precision, and geometric data types. "
2072 "The parameter value is added to the standard number of digits "
2073 "(FLT_DIG or DBL_DIG as appropriate).")
2075 &extra_float_digits,
2081 {"log_min_duration_statement", PGC_SUSET, LOGGING_WHEN,
2082 gettext_noop("Sets the minimum execution time above which "
2083 "statements will be logged."),
2084 gettext_noop("Zero prints all queries. -1 turns this feature off."),
2087 &log_min_duration_statement,
2093 {"log_autovacuum_min_duration", PGC_SIGHUP, LOGGING_WHAT,
2094 gettext_noop("Sets the minimum execution time above which "
2095 "autovacuum actions will be logged."),
2096 gettext_noop("Zero prints all actions. -1 turns autovacuum logging off."),
2099 &Log_autovacuum_min_duration,
2105 {"bgwriter_delay", PGC_SIGHUP, RESOURCES_BGWRITER,
2106 gettext_noop("Background writer sleep time between rounds."),
2116 {"bgwriter_lru_maxpages", PGC_SIGHUP, RESOURCES_BGWRITER,
2117 gettext_noop("Background writer maximum number of LRU pages to flush per round."),
2120 &bgwriter_lru_maxpages,
2126 {"effective_io_concurrency",
2132 RESOURCES_ASYNCHRONOUS,
2133 gettext_noop("Number of simultaneous requests that can be handled efficiently by the disk subsystem."),
2134 gettext_noop("For RAID arrays, this should be approximately the number of drive spindles in the array.")
2136 &effective_io_concurrency,
2142 check_effective_io_concurrency, assign_effective_io_concurrency, NULL
2146 {"log_rotation_age", PGC_SIGHUP, LOGGING_WHERE,
2147 gettext_noop("Automatic log file rotation will occur after N minutes."),
2152 HOURS_PER_DAY * MINS_PER_HOUR, 0, INT_MAX / SECS_PER_MINUTE,
2157 {"log_rotation_size", PGC_SIGHUP, LOGGING_WHERE,
2158 gettext_noop("Automatic log file rotation will occur after N kilobytes."),
2163 10 * 1024, 0, INT_MAX / 1024,
2168 {"max_function_args", PGC_INTERNAL, PRESET_OPTIONS,
2169 gettext_noop("Shows the maximum number of function arguments."),
2171 GUC_NOT_IN_SAMPLE | GUC_DISALLOW_IN_FILE
2174 FUNC_MAX_ARGS, FUNC_MAX_ARGS, FUNC_MAX_ARGS,
2179 {"max_index_keys", PGC_INTERNAL, PRESET_OPTIONS,
2180 gettext_noop("Shows the maximum number of index keys."),
2182 GUC_NOT_IN_SAMPLE | GUC_DISALLOW_IN_FILE
2185 INDEX_MAX_KEYS, INDEX_MAX_KEYS, INDEX_MAX_KEYS,
2190 {"max_identifier_length", PGC_INTERNAL, PRESET_OPTIONS,
2191 gettext_noop("Shows the maximum identifier length."),
2193 GUC_NOT_IN_SAMPLE | GUC_DISALLOW_IN_FILE
2195 &max_identifier_length,
2196 NAMEDATALEN - 1, NAMEDATALEN - 1, NAMEDATALEN - 1,
2201 {"block_size", PGC_INTERNAL, PRESET_OPTIONS,
2202 gettext_noop("Shows the size of a disk block."),
2204 GUC_NOT_IN_SAMPLE | GUC_DISALLOW_IN_FILE
2207 BLCKSZ, BLCKSZ, BLCKSZ,
2212 {"segment_size", PGC_INTERNAL, PRESET_OPTIONS,
2213 gettext_noop("Shows the number of pages per disk file."),
2215 GUC_UNIT_BLOCKS | GUC_NOT_IN_SAMPLE | GUC_DISALLOW_IN_FILE
2218 RELSEG_SIZE, RELSEG_SIZE, RELSEG_SIZE,
2223 {"wal_block_size", PGC_INTERNAL, PRESET_OPTIONS,
2224 gettext_noop("Shows the block size in the write ahead log."),
2226 GUC_NOT_IN_SAMPLE | GUC_DISALLOW_IN_FILE
2229 XLOG_BLCKSZ, XLOG_BLCKSZ, XLOG_BLCKSZ,
2234 {"wal_segment_size", PGC_INTERNAL, PRESET_OPTIONS,
2235 gettext_noop("Shows the number of pages per write ahead log segment."),
2237 GUC_UNIT_XBLOCKS | GUC_NOT_IN_SAMPLE | GUC_DISALLOW_IN_FILE
2240 (XLOG_SEG_SIZE / XLOG_BLCKSZ),
2241 (XLOG_SEG_SIZE / XLOG_BLCKSZ),
2242 (XLOG_SEG_SIZE / XLOG_BLCKSZ),
2247 {"autovacuum_naptime", PGC_SIGHUP, AUTOVACUUM,
2248 gettext_noop("Time to sleep between autovacuum runs."),
2252 &autovacuum_naptime,
2253 60, 1, INT_MAX / 1000,
2257 {"autovacuum_vacuum_threshold", PGC_SIGHUP, AUTOVACUUM,
2258 gettext_noop("Minimum number of tuple updates or deletes prior to vacuum."),
2261 &autovacuum_vac_thresh,
2266 {"autovacuum_analyze_threshold", PGC_SIGHUP, AUTOVACUUM,
2267 gettext_noop("Minimum number of tuple inserts, updates, or deletes prior to analyze."),
2270 &autovacuum_anl_thresh,
2275 /* see varsup.c for why this is PGC_POSTMASTER not PGC_SIGHUP */
2276 {"autovacuum_freeze_max_age", PGC_POSTMASTER, AUTOVACUUM,
2277 gettext_noop("Age at which to autovacuum a table to prevent transaction ID wraparound."),
2280 &autovacuum_freeze_max_age,
2281 /* see pg_resetxlog if you change the upper-limit value */
2282 200000000, 100000000, 2000000000,
2286 /* see max_connections */
2287 {"autovacuum_max_workers", PGC_POSTMASTER, AUTOVACUUM,
2288 gettext_noop("Sets the maximum number of simultaneously running autovacuum worker processes."),
2291 &autovacuum_max_workers,
2293 check_autovacuum_max_workers, assign_autovacuum_max_workers, NULL
2297 {"tcp_keepalives_idle", PGC_USERSET, CLIENT_CONN_OTHER,
2298 gettext_noop("Time between issuing TCP keepalives."),
2299 gettext_noop("A value of 0 uses the system default."),
2302 &tcp_keepalives_idle,
2304 NULL, assign_tcp_keepalives_idle, show_tcp_keepalives_idle
2308 {"tcp_keepalives_interval", PGC_USERSET, CLIENT_CONN_OTHER,
2309 gettext_noop("Time between TCP keepalive retransmits."),
2310 gettext_noop("A value of 0 uses the system default."),
2313 &tcp_keepalives_interval,
2315 NULL, assign_tcp_keepalives_interval, show_tcp_keepalives_interval
2319 {"ssl_renegotiation_limit", PGC_USERSET, CONN_AUTH_SECURITY,
2320 gettext_noop("Set the amount of traffic to send and receive before renegotiating the encryption keys."),
2324 &ssl_renegotiation_limit,
2325 512 * 1024, 0, MAX_KILOBYTES,
2330 {"tcp_keepalives_count", PGC_USERSET, CLIENT_CONN_OTHER,
2331 gettext_noop("Maximum number of TCP keepalive retransmits."),
2332 gettext_noop("This controls the number of consecutive keepalive retransmits that can be "
2333 "lost before a connection is considered dead. A value of 0 uses the "
2336 &tcp_keepalives_count,
2338 NULL, assign_tcp_keepalives_count, show_tcp_keepalives_count
2342 {"gin_fuzzy_search_limit", PGC_USERSET, CLIENT_CONN_OTHER,
2343 gettext_noop("Sets the maximum allowed result for exact search by GIN."),
2347 &GinFuzzySearchLimit,
2353 {"effective_cache_size", PGC_USERSET, QUERY_TUNING_COST,
2354 gettext_noop("Sets the planner's assumption about the size of the disk cache."),
2355 gettext_noop("That is, the portion of the kernel's disk cache that "
2356 "will be used for PostgreSQL data files. This is measured in disk "
2357 "pages, which are normally 8 kB each."),
2360 &effective_cache_size,
2361 DEFAULT_EFFECTIVE_CACHE_SIZE, 1, INT_MAX,
2366 /* Can't be set in postgresql.conf */
2367 {"server_version_num", PGC_INTERNAL, PRESET_OPTIONS,
2368 gettext_noop("Shows the server version as an integer."),
2370 GUC_NOT_IN_SAMPLE | GUC_DISALLOW_IN_FILE
2372 &server_version_num,
2373 PG_VERSION_NUM, PG_VERSION_NUM, PG_VERSION_NUM,
2378 {"log_temp_files", PGC_SUSET, LOGGING_WHAT,
2379 gettext_noop("Log the use of temporary files larger than this number of kilobytes."),
2380 gettext_noop("Zero logs all files. The default is -1 (turning this feature off)."),
2389 {"track_activity_query_size", PGC_POSTMASTER, RESOURCES_MEM,
2390 gettext_noop("Sets the size reserved for pg_stat_activity.query, in bytes."),
2393 &pgstat_track_activity_query_size,
2398 /* End-of-list marker */
2400 {NULL, 0, 0, NULL, NULL}, NULL, 0, 0, 0, NULL, NULL, NULL
2405 static struct config_real ConfigureNamesReal[] =
2408 {"seq_page_cost", PGC_USERSET, QUERY_TUNING_COST,
2409 gettext_noop("Sets the planner's estimate of the cost of a "
2410 "sequentially fetched disk page."),
2414 DEFAULT_SEQ_PAGE_COST, 0, DBL_MAX,
2418 {"random_page_cost", PGC_USERSET, QUERY_TUNING_COST,
2419 gettext_noop("Sets the planner's estimate of the cost of a "
2420 "nonsequentially fetched disk page."),
2424 DEFAULT_RANDOM_PAGE_COST, 0, DBL_MAX,
2428 {"cpu_tuple_cost", PGC_USERSET, QUERY_TUNING_COST,
2429 gettext_noop("Sets the planner's estimate of the cost of "
2430 "processing each tuple (row)."),
2434 DEFAULT_CPU_TUPLE_COST, 0, DBL_MAX,
2438 {"cpu_index_tuple_cost", PGC_USERSET, QUERY_TUNING_COST,
2439 gettext_noop("Sets the planner's estimate of the cost of "
2440 "processing each index entry during an index scan."),
2443 &cpu_index_tuple_cost,
2444 DEFAULT_CPU_INDEX_TUPLE_COST, 0, DBL_MAX,
2448 {"cpu_operator_cost", PGC_USERSET, QUERY_TUNING_COST,
2449 gettext_noop("Sets the planner's estimate of the cost of "
2450 "processing each operator or function call."),
2454 DEFAULT_CPU_OPERATOR_COST, 0, DBL_MAX,
2459 {"cursor_tuple_fraction", PGC_USERSET, QUERY_TUNING_OTHER,
2460 gettext_noop("Sets the planner's estimate of the fraction of "
2461 "a cursor's rows that will be retrieved."),
2464 &cursor_tuple_fraction,
2465 DEFAULT_CURSOR_TUPLE_FRACTION, 0.0, 1.0,
2470 {"geqo_selection_bias", PGC_USERSET, QUERY_TUNING_GEQO,
2471 gettext_noop("GEQO: selective pressure within the population."),
2474 &Geqo_selection_bias,
2475 DEFAULT_GEQO_SELECTION_BIAS,
2476 MIN_GEQO_SELECTION_BIAS, MAX_GEQO_SELECTION_BIAS,
2480 {"geqo_seed", PGC_USERSET, QUERY_TUNING_GEQO,
2481 gettext_noop("GEQO: seed for random path selection."),
2490 {"bgwriter_lru_multiplier", PGC_SIGHUP, RESOURCES_BGWRITER,
2491 gettext_noop("Multiple of the average buffer usage to free per round."),
2494 &bgwriter_lru_multiplier,
2500 {"seed", PGC_USERSET, UNGROUPED,
2501 gettext_noop("Sets the seed for random-number generation."),
2503 GUC_NO_SHOW_ALL | GUC_NO_RESET_ALL | GUC_NOT_IN_SAMPLE | GUC_DISALLOW_IN_FILE
2507 check_random_seed, assign_random_seed, show_random_seed
2511 {"autovacuum_vacuum_scale_factor", PGC_SIGHUP, AUTOVACUUM,
2512 gettext_noop("Number of tuple updates or deletes prior to vacuum as a fraction of reltuples."),
2515 &autovacuum_vac_scale,
2520 {"autovacuum_analyze_scale_factor", PGC_SIGHUP, AUTOVACUUM,
2521 gettext_noop("Number of tuple inserts, updates, or deletes prior to analyze as a fraction of reltuples."),
2524 &autovacuum_anl_scale,
2530 {"checkpoint_completion_target", PGC_SIGHUP, WAL_CHECKPOINTS,
2531 gettext_noop("Time spent flushing dirty buffers during checkpoint, as fraction of checkpoint interval."),
2534 &CheckPointCompletionTarget,
2539 /* End-of-list marker */
2541 {NULL, 0, 0, NULL, NULL}, NULL, 0.0, 0.0, 0.0, NULL, NULL, NULL
2546 static struct config_string ConfigureNamesString[] =
2549 {"archive_command", PGC_SIGHUP, WAL_ARCHIVING,
2550 gettext_noop("Sets the shell command that will be called to archive a WAL file."),
2553 &XLogArchiveCommand,
2555 NULL, NULL, show_archive_command
2559 {"client_encoding", PGC_USERSET, CLIENT_CONN_LOCALE,
2560 gettext_noop("Sets the client's character set encoding."),
2562 GUC_IS_NAME | GUC_REPORT
2564 &client_encoding_string,
2566 check_client_encoding, assign_client_encoding, NULL
2570 {"log_line_prefix", PGC_SIGHUP, LOGGING_WHAT,
2571 gettext_noop("Controls information prefixed to each log line."),
2572 gettext_noop("If blank, no prefix is used.")
2580 {"log_timezone", PGC_SIGHUP, LOGGING_WHAT,
2581 gettext_noop("Sets the time zone to use in log messages."),
2584 &log_timezone_string,
2586 check_log_timezone, assign_log_timezone, show_log_timezone
2590 {"DateStyle", PGC_USERSET, CLIENT_CONN_LOCALE,
2591 gettext_noop("Sets the display format for date and time values."),
2592 gettext_noop("Also controls interpretation of ambiguous "
2594 GUC_LIST_INPUT | GUC_REPORT
2598 check_datestyle, assign_datestyle, NULL
2602 {"default_tablespace", PGC_USERSET, CLIENT_CONN_STATEMENT,
2603 gettext_noop("Sets the default tablespace to create tables and indexes in."),
2604 gettext_noop("An empty string selects the database's default tablespace."),
2607 &default_tablespace,
2609 check_default_tablespace, NULL, NULL
2613 {"temp_tablespaces", PGC_USERSET, CLIENT_CONN_STATEMENT,
2614 gettext_noop("Sets the tablespace(s) to use for temporary tables and sort files."),
2616 GUC_LIST_INPUT | GUC_LIST_QUOTE
2620 check_temp_tablespaces, assign_temp_tablespaces, NULL
2624 {"dynamic_library_path", PGC_SUSET, CLIENT_CONN_OTHER,
2625 gettext_noop("Sets the path for dynamically loadable modules."),
2626 gettext_noop("If a dynamically loadable module needs to be opened and "
2627 "the specified name does not have a directory component (i.e., the "
2628 "name does not contain a slash), the system will search this path for "
2629 "the specified file."),
2632 &Dynamic_library_path,
2638 {"krb_server_keyfile", PGC_SIGHUP, CONN_AUTH_SECURITY,
2639 gettext_noop("Sets the location of the Kerberos server key file."),
2643 &pg_krb_server_keyfile,
2649 {"krb_srvname", PGC_SIGHUP, CONN_AUTH_SECURITY,
2650 gettext_noop("Sets the name of the Kerberos service."),
2659 {"bonjour_name", PGC_POSTMASTER, CONN_AUTH_SETTINGS,
2660 gettext_noop("Sets the Bonjour service name."),
2668 /* See main.c about why defaults for LC_foo are not all alike */
2671 {"lc_collate", PGC_INTERNAL, CLIENT_CONN_LOCALE,
2672 gettext_noop("Shows the collation order locale."),
2674 GUC_NOT_IN_SAMPLE | GUC_DISALLOW_IN_FILE
2682 {"lc_ctype", PGC_INTERNAL, CLIENT_CONN_LOCALE,
2683 gettext_noop("Shows the character classification and case conversion locale."),
2685 GUC_NOT_IN_SAMPLE | GUC_DISALLOW_IN_FILE
2693 {"lc_messages", PGC_SUSET, CLIENT_CONN_LOCALE,
2694 gettext_noop("Sets the language in which messages are displayed."),
2699 check_locale_messages, assign_locale_messages, NULL
2703 {"lc_monetary", PGC_USERSET, CLIENT_CONN_LOCALE,
2704 gettext_noop("Sets the locale for formatting monetary amounts."),
2709 check_locale_monetary, assign_locale_monetary, NULL
2713 {"lc_numeric", PGC_USERSET, CLIENT_CONN_LOCALE,
2714 gettext_noop("Sets the locale for formatting numbers."),
2719 check_locale_numeric, assign_locale_numeric, NULL
2723 {"lc_time", PGC_USERSET, CLIENT_CONN_LOCALE,
2724 gettext_noop("Sets the locale for formatting date and time values."),
2729 check_locale_time, assign_locale_time, NULL
2733 {"shared_preload_libraries", PGC_POSTMASTER, RESOURCES_KERNEL,
2734 gettext_noop("Lists shared libraries to preload into server."),
2736 GUC_LIST_INPUT | GUC_LIST_QUOTE | GUC_SUPERUSER_ONLY
2738 &shared_preload_libraries_string,
2744 {"local_preload_libraries", PGC_BACKEND, CLIENT_CONN_OTHER,
2745 gettext_noop("Lists shared libraries to preload into each backend."),
2747 GUC_LIST_INPUT | GUC_LIST_QUOTE
2749 &local_preload_libraries_string,
2755 {"search_path", PGC_USERSET, CLIENT_CONN_STATEMENT,
2756 gettext_noop("Sets the schema search order for names that are not schema-qualified."),
2758 GUC_LIST_INPUT | GUC_LIST_QUOTE
2760 &namespace_search_path,
2762 check_search_path, assign_search_path, NULL
2766 /* Can't be set in postgresql.conf */
2767 {"server_encoding", PGC_INTERNAL, CLIENT_CONN_LOCALE,
2768 gettext_noop("Sets the server (database) character set encoding."),
2770 GUC_IS_NAME | GUC_REPORT | GUC_NOT_IN_SAMPLE | GUC_DISALLOW_IN_FILE
2772 &server_encoding_string,
2778 /* Can't be set in postgresql.conf */
2779 {"server_version", PGC_INTERNAL, PRESET_OPTIONS,
2780 gettext_noop("Shows the server version."),
2782 GUC_REPORT | GUC_NOT_IN_SAMPLE | GUC_DISALLOW_IN_FILE
2784 &server_version_string,
2790 /* Not for general use --- used by SET ROLE */
2791 {"role", PGC_USERSET, UNGROUPED,
2792 gettext_noop("Sets the current role."),
2794 GUC_IS_NAME | GUC_NO_SHOW_ALL | GUC_NO_RESET_ALL | GUC_NOT_IN_SAMPLE | GUC_DISALLOW_IN_FILE | GUC_NOT_WHILE_SEC_REST
2798 check_role, assign_role, show_role
2802 /* Not for general use --- used by SET SESSION AUTHORIZATION */
2803 {"session_authorization", PGC_USERSET, UNGROUPED,
2804 gettext_noop("Sets the session user name."),
2806 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
2808 &session_authorization_string,
2810 check_session_authorization, assign_session_authorization, NULL
2814 {"log_destination", PGC_SIGHUP, LOGGING_WHERE,
2815 gettext_noop("Sets the destination for server log output."),
2816 gettext_noop("Valid values are combinations of \"stderr\", "
2817 "\"syslog\", \"csvlog\", and \"eventlog\", "
2818 "depending on the platform."),
2821 &log_destination_string,
2823 check_log_destination, assign_log_destination, NULL
2826 {"log_directory", PGC_SIGHUP, LOGGING_WHERE,
2827 gettext_noop("Sets the destination directory for log files."),
2828 gettext_noop("Can be specified as relative to the data directory "
2829 "or as absolute path."),
2834 check_canonical_path, NULL, NULL
2837 {"log_filename", PGC_SIGHUP, LOGGING_WHERE,
2838 gettext_noop("Sets the file name pattern for log files."),
2843 "postgresql-%Y-%m-%d_%H%M%S.log",
2848 {"syslog_ident", PGC_SIGHUP, LOGGING_WHERE,
2849 gettext_noop("Sets the program name used to identify PostgreSQL "
2850 "messages in syslog."),
2855 NULL, assign_syslog_ident, NULL
2859 {"event_source", PGC_POSTMASTER, LOGGING_WHERE,
2860 gettext_noop("Sets the application name used to identify "
2861 "PostgreSQL messages in the event log."),
2870 {"TimeZone", PGC_USERSET, CLIENT_CONN_LOCALE,
2871 gettext_noop("Sets the time zone for displaying and interpreting time stamps."),
2877 check_timezone, assign_timezone, show_timezone
2880 {"timezone_abbreviations", PGC_USERSET, CLIENT_CONN_LOCALE,
2881 gettext_noop("Selects a file of time zone abbreviations."),
2884 &timezone_abbreviations_string,
2886 check_timezone_abbreviations, assign_timezone_abbreviations, NULL
2890 {"transaction_isolation", PGC_USERSET, CLIENT_CONN_STATEMENT,
2891 gettext_noop("Sets the current transaction's isolation level."),
2893 GUC_NO_RESET_ALL | GUC_NOT_IN_SAMPLE | GUC_DISALLOW_IN_FILE
2895 &XactIsoLevel_string,
2897 check_XactIsoLevel, assign_XactIsoLevel, show_XactIsoLevel
2901 {"unix_socket_group", PGC_POSTMASTER, CONN_AUTH_SETTINGS,
2902 gettext_noop("Sets the owning group of the Unix-domain socket."),
2903 gettext_noop("The owning user of the socket is always the user "
2904 "that starts the server.")
2912 {"unix_socket_directories", PGC_POSTMASTER, CONN_AUTH_SETTINGS,
2913 gettext_noop("Sets the directories where Unix-domain sockets will be created."),
2917 &Unix_socket_directories,
2918 #ifdef HAVE_UNIX_SOCKETS
2919 DEFAULT_PGSOCKET_DIR,
2927 {"listen_addresses", PGC_POSTMASTER, CONN_AUTH_SETTINGS,
2928 gettext_noop("Sets the host name or IP address(es) to listen to."),
2938 {"data_directory", PGC_POSTMASTER, FILE_LOCATIONS,
2939 gettext_noop("Sets the server's data directory."),
2949 {"config_file", PGC_POSTMASTER, FILE_LOCATIONS,
2950 gettext_noop("Sets the server's main configuration file."),
2952 GUC_DISALLOW_IN_FILE | GUC_SUPERUSER_ONLY
2960 {"hba_file", PGC_POSTMASTER, FILE_LOCATIONS,
2961 gettext_noop("Sets the server's \"hba\" configuration file."),
2971 {"ident_file", PGC_POSTMASTER, FILE_LOCATIONS,
2972 gettext_noop("Sets the server's \"ident\" configuration file."),
2982 {"external_pid_file", PGC_POSTMASTER, FILE_LOCATIONS,
2983 gettext_noop("Writes the postmaster PID to the specified file."),
2989 check_canonical_path, NULL, NULL
2993 {"ssl_cert_file", PGC_POSTMASTER, CONN_AUTH_SECURITY,
2994 gettext_noop("Location of the SSL server certificate file."),
3003 {"ssl_key_file", PGC_POSTMASTER, CONN_AUTH_SECURITY,
3004 gettext_noop("Location of the SSL server private key file."),
3013 {"ssl_ca_file", PGC_POSTMASTER, CONN_AUTH_SECURITY,
3014 gettext_noop("Location of the SSL certificate authority file."),
3023 {"ssl_crl_file", PGC_POSTMASTER, CONN_AUTH_SECURITY,
3024 gettext_noop("Location of the SSL certificate revocation list file."),
3033 {"stats_temp_directory", PGC_SIGHUP, STATS_COLLECTOR,
3034 gettext_noop("Writes temporary statistics files to the specified directory."),
3038 &pgstat_temp_directory,
3040 check_canonical_path, assign_pgstat_temp_directory, NULL
3044 {"synchronous_standby_names", PGC_SIGHUP, REPLICATION_MASTER,
3045 gettext_noop("List of names of potential synchronous standbys."),
3049 &SyncRepStandbyNames,
3051 check_synchronous_standby_names, NULL, NULL
3055 {"default_text_search_config", PGC_USERSET, CLIENT_CONN_LOCALE,
3056 gettext_noop("Sets default text search configuration."),
3060 "pg_catalog.simple",
3061 check_TSCurrentConfig, assign_TSCurrentConfig, NULL
3065 {"ssl_ciphers", PGC_POSTMASTER, CONN_AUTH_SECURITY,
3066 gettext_noop("Sets the list of allowed SSL ciphers."),
3072 "ALL:!ADH:!LOW:!EXP:!MD5:@STRENGTH",
3080 {"application_name", PGC_USERSET, LOGGING_WHAT,
3081 gettext_noop("Sets the application name to be reported in statistics and logs."),
3083 GUC_IS_NAME | GUC_REPORT | GUC_NOT_IN_SAMPLE
3087 check_application_name, assign_application_name, NULL
3090 /* End-of-list marker */
3092 {NULL, 0, 0, NULL, NULL}, NULL, NULL, NULL, NULL, NULL
3097 static struct config_enum ConfigureNamesEnum[] =
3100 {"backslash_quote", PGC_USERSET, COMPAT_OPTIONS_PREVIOUS,
3101 gettext_noop("Sets whether \"\\'\" is allowed in string literals."),
3105 BACKSLASH_QUOTE_SAFE_ENCODING, backslash_quote_options,
3110 {"bytea_output", PGC_USERSET, CLIENT_CONN_STATEMENT,
3111 gettext_noop("Sets the output format for bytea."),
3115 BYTEA_OUTPUT_HEX, bytea_output_options,
3120 {"client_min_messages", PGC_USERSET, LOGGING_WHEN,
3121 gettext_noop("Sets the message levels that are sent to the client."),
3122 gettext_noop("Each level includes all the levels that follow it. The later"
3123 " the level, the fewer messages are sent.")
3125 &client_min_messages,
3126 NOTICE, client_message_level_options,
3131 {"constraint_exclusion", PGC_USERSET, QUERY_TUNING_OTHER,
3132 gettext_noop("Enables the planner to use constraints to optimize queries."),
3133 gettext_noop("Table scans will be skipped if their constraints"
3134 " guarantee that no rows match the query.")
3136 &constraint_exclusion,
3137 CONSTRAINT_EXCLUSION_PARTITION, constraint_exclusion_options,
3142 {"default_transaction_isolation", PGC_USERSET, CLIENT_CONN_STATEMENT,
3143 gettext_noop("Sets the transaction isolation level of each new transaction."),
3146 &DefaultXactIsoLevel,
3147 XACT_READ_COMMITTED, isolation_level_options,
3152 {"IntervalStyle", PGC_USERSET, CLIENT_CONN_LOCALE,
3153 gettext_noop("Sets the display format for interval values."),
3158 INTSTYLE_POSTGRES, intervalstyle_options,
3163 {"log_error_verbosity", PGC_SUSET, LOGGING_WHAT,
3164 gettext_noop("Sets the verbosity of logged messages."),
3167 &Log_error_verbosity,
3168 PGERROR_DEFAULT, log_error_verbosity_options,
3173 {"log_min_messages", PGC_SUSET, LOGGING_WHEN,
3174 gettext_noop("Sets the message levels that are logged."),
3175 gettext_noop("Each level includes all the levels that follow it. The later"
3176 " the level, the fewer messages are sent.")
3179 WARNING, server_message_level_options,
3184 {"log_min_error_statement", PGC_SUSET, LOGGING_WHEN,
3185 gettext_noop("Causes all statements generating error at or above this level to be logged."),
3186 gettext_noop("Each level includes all the levels that follow it. The later"
3187 " the level, the fewer messages are sent.")
3189 &log_min_error_statement,
3190 ERROR, server_message_level_options,
3195 {"log_statement", PGC_SUSET, LOGGING_WHAT,
3196 gettext_noop("Sets the type of statements logged."),
3200 LOGSTMT_NONE, log_statement_options,
3205 {"syslog_facility", PGC_SIGHUP, LOGGING_WHERE,
3206 gettext_noop("Sets the syslog \"facility\" to be used when syslog enabled."),
3215 syslog_facility_options,
3216 NULL, assign_syslog_facility, NULL
3220 {"session_replication_role", PGC_SUSET, CLIENT_CONN_STATEMENT,
3221 gettext_noop("Sets the session's behavior for triggers and rewrite rules."),
3224 &SessionReplicationRole,
3225 SESSION_REPLICATION_ROLE_ORIGIN, session_replication_role_options,
3226 NULL, assign_session_replication_role, NULL
3230 {"synchronous_commit", PGC_USERSET, WAL_SETTINGS,
3231 gettext_noop("Sets the current transaction's synchronization level."),
3234 &synchronous_commit,
3235 SYNCHRONOUS_COMMIT_ON, synchronous_commit_options,
3236 NULL, assign_synchronous_commit, NULL
3240 {"trace_recovery_messages", PGC_SIGHUP, DEVELOPER_OPTIONS,
3241 gettext_noop("Enables logging of recovery-related debugging information."),
3242 gettext_noop("Each level includes all the levels that follow it. The later"
3243 " the level, the fewer messages are sent.")
3245 &trace_recovery_messages,
3248 * client_message_level_options allows too many values, really, but
3249 * it's not worth having a separate options array for this.
3251 LOG, client_message_level_options,
3256 {"track_functions", PGC_SUSET, STATS_COLLECTOR,
3257 gettext_noop("Collects function-level statistics on database activity."),
3260 &pgstat_track_functions,
3261 TRACK_FUNC_OFF, track_function_options,
3266 {"wal_level", PGC_POSTMASTER, WAL_SETTINGS,
3267 gettext_noop("Set the level of information written to the WAL."),
3271 WAL_LEVEL_MINIMAL, wal_level_options,
3276 {"wal_sync_method", PGC_SIGHUP, WAL_SETTINGS,
3277 gettext_noop("Selects the method used for forcing WAL updates to disk."),
3281 DEFAULT_SYNC_METHOD, sync_method_options,
3282 NULL, assign_xlog_sync_method, NULL
3286 {"xmlbinary", PGC_USERSET, CLIENT_CONN_STATEMENT,
3287 gettext_noop("Sets how binary values are to be encoded in XML."),
3291 XMLBINARY_BASE64, xmlbinary_options,
3296 {"xmloption", PGC_USERSET, CLIENT_CONN_STATEMENT,
3297 gettext_noop("Sets whether XML data in implicit parsing and serialization "
3298 "operations is to be considered as documents or content fragments."),
3302 XMLOPTION_CONTENT, xmloption_options,
3307 /* End-of-list marker */
3309 {NULL, 0, 0, NULL, NULL}, NULL, 0, NULL, NULL, NULL, NULL
3313 /******** end of options list ********/
3317 * To allow continued support of obsolete names for GUC variables, we apply
3318 * the following mappings to any unrecognized name. Note that an old name
3319 * should be mapped to a new one only if the new variable has very similar
3320 * semantics to the old.
3322 static const char *const map_old_guc_names[] = {
3323 "sort_mem", "work_mem",
3324 "vacuum_mem", "maintenance_work_mem",
3330 * Actual lookup of variables is done through this single, sorted array.
3332 static struct config_generic **guc_variables;
3334 /* Current number of variables contained in the vector */
3335 static int num_guc_variables;
3337 /* Vector capacity */
3338 static int size_guc_variables;
3341 static bool guc_dirty; /* TRUE if need to do commit/abort work */
3343 static bool reporting_enabled; /* TRUE to enable GUC_REPORT */
3345 static int GUCNestLevel = 0; /* 1 when in main transaction */
3348 static int guc_var_compare(const void *a, const void *b);
3349 static int guc_name_compare(const char *namea, const char *nameb);
3350 static void InitializeGUCOptionsFromEnvironment(void);
3351 static void InitializeOneGUCOption(struct config_generic * gconf);
3352 static void push_old_value(struct config_generic * gconf, GucAction action);
3353 static void ReportGUCOption(struct config_generic * record);
3354 static void reapply_stacked_values(struct config_generic * variable,
3355 struct config_string * pHolder,
3357 const char *curvalue,
3358 GucContext curscontext, GucSource cursource);
3359 static void ShowGUCConfigOption(const char *name, DestReceiver *dest);
3360 static void ShowAllGUCConfig(DestReceiver *dest);
3361 static char *_ShowOption(struct config_generic * record, bool use_units);
3362 static bool validate_option_array_item(const char *name, const char *value,
3363 bool skipIfNoPermissions);
3367 * Some infrastructure for checking malloc/strdup/realloc calls
3370 guc_malloc(int elevel, size_t size)
3374 /* Avoid unportable behavior of malloc(0) */
3377 data = malloc(size);
3380 (errcode(ERRCODE_OUT_OF_MEMORY),
3381 errmsg("out of memory")));
3386 guc_realloc(int elevel, void *old, size_t size)
3390 /* Avoid unportable behavior of realloc(NULL, 0) */
3391 if (old == NULL && size == 0)
3393 data = realloc(old, size);
3396 (errcode(ERRCODE_OUT_OF_MEMORY),
3397 errmsg("out of memory")));
3402 guc_strdup(int elevel, const char *src)
3409 (errcode(ERRCODE_OUT_OF_MEMORY),
3410 errmsg("out of memory")));
3416 * Detect whether strval is referenced anywhere in a GUC string item
3419 string_field_used(struct config_string * conf, char *strval)
3423 if (strval == *(conf->variable) ||
3424 strval == conf->reset_val ||
3425 strval == conf->boot_val)
3427 for (stack = conf->gen.stack; stack; stack = stack->prev)
3429 if (strval == stack->prior.val.stringval ||
3430 strval == stack->masked.val.stringval)
3437 * Support for assigning to a field of a string GUC item. Free the prior
3438 * value if it's not referenced anywhere else in the item (including stacked
3442 set_string_field(struct config_string * conf, char **field, char *newval)
3444 char *oldval = *field;
3446 /* Do the assignment */
3449 /* Free old value if it's not NULL and isn't referenced anymore */
3450 if (oldval && !string_field_used(conf, oldval))
3455 * Detect whether an "extra" struct is referenced anywhere in a GUC item
3458 extra_field_used(struct config_generic * gconf, void *extra)
3462 if (extra == gconf->extra)
3464 switch (gconf->vartype)
3467 if (extra == ((struct config_bool *) gconf)->reset_extra)
3471 if (extra == ((struct config_int *) gconf)->reset_extra)
3475 if (extra == ((struct config_real *) gconf)->reset_extra)
3479 if (extra == ((struct config_string *) gconf)->reset_extra)
3483 if (extra == ((struct config_enum *) gconf)->reset_extra)
3487 for (stack = gconf->stack; stack; stack = stack->prev)
3489 if (extra == stack->prior.extra ||
3490 extra == stack->masked.extra)
3498 * Support for assigning to an "extra" field of a GUC item. Free the prior
3499 * value if it's not referenced anywhere else in the item (including stacked
3503 set_extra_field(struct config_generic * gconf, void **field, void *newval)
3505 void *oldval = *field;
3507 /* Do the assignment */
3510 /* Free old value if it's not NULL and isn't referenced anymore */
3511 if (oldval && !extra_field_used(gconf, oldval))
3516 * Support for copying a variable's active value into a stack entry.
3517 * The "extra" field associated with the active value is copied, too.
3519 * NB: be sure stringval and extra fields of a new stack entry are
3520 * initialized to NULL before this is used, else we'll try to free() them.
3523 set_stack_value(struct config_generic * gconf, config_var_value *val)
3525 switch (gconf->vartype)
3529 *((struct config_bool *) gconf)->variable;
3533 *((struct config_int *) gconf)->variable;
3537 *((struct config_real *) gconf)->variable;
3540 set_string_field((struct config_string *) gconf,
3541 &(val->val.stringval),
3542 *((struct config_string *) gconf)->variable);
3546 *((struct config_enum *) gconf)->variable;
3549 set_extra_field(gconf, &(val->extra), gconf->extra);
3553 * Support for discarding a no-longer-needed value in a stack entry.
3554 * The "extra" field associated with the stack entry is cleared, too.
3557 discard_stack_value(struct config_generic * gconf, config_var_value *val)
3559 switch (gconf->vartype)
3565 /* no need to do anything */
3568 set_string_field((struct config_string *) gconf,
3569 &(val->val.stringval),
3573 set_extra_field(gconf, &(val->extra), NULL);
3578 * Fetch the sorted array pointer (exported for help_config.c's use ONLY)
3580 struct config_generic **
3581 get_guc_variables(void)
3583 return guc_variables;
3588 * Build the sorted array. This is split out so that it could be
3589 * re-executed after startup (eg, we could allow loadable modules to
3590 * add vars, and then we'd need to re-sort).
3593 build_guc_variables(void)
3597 struct config_generic **guc_vars;
3600 for (i = 0; ConfigureNamesBool[i].gen.name; i++)
3602 struct config_bool *conf = &ConfigureNamesBool[i];
3604 /* Rather than requiring vartype to be filled in by hand, do this: */
3605 conf->gen.vartype = PGC_BOOL;
3609 for (i = 0; ConfigureNamesInt[i].gen.name; i++)
3611 struct config_int *conf = &ConfigureNamesInt[i];
3613 conf->gen.vartype = PGC_INT;
3617 for (i = 0; ConfigureNamesReal[i].gen.name; i++)
3619 struct config_real *conf = &ConfigureNamesReal[i];
3621 conf->gen.vartype = PGC_REAL;
3625 for (i = 0; ConfigureNamesString[i].gen.name; i++)
3627 struct config_string *conf = &ConfigureNamesString[i];
3629 conf->gen.vartype = PGC_STRING;
3633 for (i = 0; ConfigureNamesEnum[i].gen.name; i++)
3635 struct config_enum *conf = &ConfigureNamesEnum[i];
3637 conf->gen.vartype = PGC_ENUM;
3642 * Create table with 20% slack
3644 size_vars = num_vars + num_vars / 4;
3646 guc_vars = (struct config_generic **)
3647 guc_malloc(FATAL, size_vars * sizeof(struct config_generic *));
3651 for (i = 0; ConfigureNamesBool[i].gen.name; i++)
3652 guc_vars[num_vars++] = &ConfigureNamesBool[i].gen;
3654 for (i = 0; ConfigureNamesInt[i].gen.name; i++)
3655 guc_vars[num_vars++] = &ConfigureNamesInt[i].gen;
3657 for (i = 0; ConfigureNamesReal[i].gen.name; i++)
3658 guc_vars[num_vars++] = &ConfigureNamesReal[i].gen;
3660 for (i = 0; ConfigureNamesString[i].gen.name; i++)
3661 guc_vars[num_vars++] = &ConfigureNamesString[i].gen;
3663 for (i = 0; ConfigureNamesEnum[i].gen.name; i++)
3664 guc_vars[num_vars++] = &ConfigureNamesEnum[i].gen;
3667 free(guc_variables);
3668 guc_variables = guc_vars;
3669 num_guc_variables = num_vars;
3670 size_guc_variables = size_vars;
3671 qsort((void *) guc_variables, num_guc_variables,
3672 sizeof(struct config_generic *), guc_var_compare);
3676 * Add a new GUC variable to the list of known variables. The
3677 * list is expanded if needed.
3680 add_guc_variable(struct config_generic * var, int elevel)
3682 if (num_guc_variables + 1 >= size_guc_variables)
3685 * Increase the vector by 25%
3687 int size_vars = size_guc_variables + size_guc_variables / 4;
3688 struct config_generic **guc_vars;
3693 guc_vars = (struct config_generic **)
3694 guc_malloc(elevel, size_vars * sizeof(struct config_generic *));
3698 guc_vars = (struct config_generic **)
3699 guc_realloc(elevel, guc_variables, size_vars * sizeof(struct config_generic *));
3702 if (guc_vars == NULL)
3703 return false; /* out of memory */
3705 guc_variables = guc_vars;
3706 size_guc_variables = size_vars;
3708 guc_variables[num_guc_variables++] = var;
3709 qsort((void *) guc_variables, num_guc_variables,
3710 sizeof(struct config_generic *), guc_var_compare);
3715 * Create and add a placeholder variable for a custom variable name.
3717 static struct config_generic *
3718 add_placeholder_variable(const char *name, int elevel)
3720 size_t sz = sizeof(struct config_string) + sizeof(char *);
3721 struct config_string *var;
3722 struct config_generic *gen;
3724 var = (struct config_string *) guc_malloc(elevel, sz);
3730 gen->name = guc_strdup(elevel, name);
3731 if (gen->name == NULL)
3737 gen->context = PGC_USERSET;
3738 gen->group = CUSTOM_OPTIONS;
3739 gen->short_desc = "GUC placeholder variable";
3740 gen->flags = GUC_NO_SHOW_ALL | GUC_NOT_IN_SAMPLE | GUC_CUSTOM_PLACEHOLDER;
3741 gen->vartype = PGC_STRING;
3744 * The char* is allocated at the end of the struct since we have no
3745 * 'static' place to point to. Note that the current value, as well as
3746 * the boot and reset values, start out NULL.
3748 var->variable = (char **) (var + 1);
3750 if (!add_guc_variable((struct config_generic *) var, elevel))
3752 free((void *) gen->name);
3761 * Look up option NAME. If it exists, return a pointer to its record,
3762 * else return NULL. If create_placeholders is TRUE, we'll create a
3763 * placeholder record for a valid-looking custom variable name.
3765 static struct config_generic *
3766 find_option(const char *name, bool create_placeholders, int elevel)
3768 const char **key = &name;
3769 struct config_generic **res;
3775 * By equating const char ** with struct config_generic *, we are assuming
3776 * the name field is first in config_generic.
3778 res = (struct config_generic **) bsearch((void *) &key,
3779 (void *) guc_variables,
3781 sizeof(struct config_generic *),
3787 * See if the name is an obsolete name for a variable. We assume that the
3788 * set of supported old names is short enough that a brute-force search is
3791 for (i = 0; map_old_guc_names[i] != NULL; i += 2)
3793 if (guc_name_compare(name, map_old_guc_names[i]) == 0)
3794 return find_option(map_old_guc_names[i + 1], false, elevel);
3797 if (create_placeholders)
3800 * Check if the name is qualified, and if so, add a placeholder.
3802 if (strchr(name, GUC_QUALIFIER_SEPARATOR) != NULL)
3803 return add_placeholder_variable(name, elevel);
3812 * comparator for qsorting and bsearching guc_variables array
3815 guc_var_compare(const void *a, const void *b)
3817 const struct config_generic *confa = *(struct config_generic * const *) a;
3818 const struct config_generic *confb = *(struct config_generic * const *) b;
3820 return guc_name_compare(confa->name, confb->name);
3824 * the bare comparison function for GUC names
3827 guc_name_compare(const char *namea, const char *nameb)
3830 * The temptation to use strcasecmp() here must be resisted, because the
3831 * array ordering has to remain stable across setlocale() calls. So, build
3832 * our own with a simple ASCII-only downcasing.
3834 while (*namea && *nameb)
3836 char cha = *namea++;
3837 char chb = *nameb++;
3839 if (cha >= 'A' && cha <= 'Z')
3841 if (chb >= 'A' && chb <= 'Z')
3847 return 1; /* a is longer */
3849 return -1; /* b is longer */
3855 * Initialize GUC options during program startup.
3857 * Note that we cannot read the config file yet, since we have not yet
3858 * processed command-line switches.
3861 InitializeGUCOptions(void)
3866 * Before log_line_prefix could possibly receive a nonempty setting, make
3867 * sure that timezone processing is minimally alive (see elog.c).
3869 pg_timezone_initialize();
3872 * Build sorted array of all GUC variables.
3874 build_guc_variables();
3877 * Load all variables with their compiled-in defaults, and initialize
3878 * status fields as needed.
3880 for (i = 0; i < num_guc_variables; i++)
3882 InitializeOneGUCOption(guc_variables[i]);
3887 reporting_enabled = false;
3890 * Prevent any attempt to override the transaction modes from
3891 * non-interactive sources.
3893 SetConfigOption("transaction_isolation", "default",
3894 PGC_POSTMASTER, PGC_S_OVERRIDE);
3895 SetConfigOption("transaction_read_only", "no",
3896 PGC_POSTMASTER, PGC_S_OVERRIDE);
3897 SetConfigOption("transaction_deferrable", "no",
3898 PGC_POSTMASTER, PGC_S_OVERRIDE);
3901 * For historical reasons, some GUC parameters can receive defaults from
3902 * environment variables. Process those settings.
3904 InitializeGUCOptionsFromEnvironment();
3908 * Assign any GUC values that can come from the server's environment.
3910 * This is called from InitializeGUCOptions, and also from ProcessConfigFile
3911 * to deal with the possibility that a setting has been removed from
3912 * postgresql.conf and should now get a value from the environment.
3913 * (The latter is a kludge that should probably go away someday; if so,
3914 * fold this back into InitializeGUCOptions.)
3917 InitializeGUCOptionsFromEnvironment(void)
3922 env = getenv("PGPORT");
3924 SetConfigOption("port", env, PGC_POSTMASTER, PGC_S_ENV_VAR);
3926 env = getenv("PGDATESTYLE");
3928 SetConfigOption("datestyle", env, PGC_POSTMASTER, PGC_S_ENV_VAR);
3930 env = getenv("PGCLIENTENCODING");
3932 SetConfigOption("client_encoding", env, PGC_POSTMASTER, PGC_S_ENV_VAR);
3935 * rlimit isn't exactly an "environment variable", but it behaves about
3936 * the same. If we can identify the platform stack depth rlimit, increase
3937 * default stack depth setting up to whatever is safe (but at most 2MB).
3939 stack_rlimit = get_stack_depth_rlimit();
3940 if (stack_rlimit > 0)
3942 long new_limit = (stack_rlimit - STACK_DEPTH_SLOP) / 1024L;
3944 if (new_limit > 100)
3948 new_limit = Min(new_limit, 2048);
3949 sprintf(limbuf, "%ld", new_limit);
3950 SetConfigOption("max_stack_depth", limbuf,
3951 PGC_POSTMASTER, PGC_S_ENV_VAR);
3957 * Initialize one GUC option variable to its compiled-in default.
3959 * Note: the reason for calling check_hooks is not that we think the boot_val
3960 * might fail, but that the hooks might wish to compute an "extra" struct.
3963 InitializeOneGUCOption(struct config_generic * gconf)
3966 gconf->source = PGC_S_DEFAULT;
3967 gconf->reset_source = PGC_S_DEFAULT;
3968 gconf->scontext = PGC_INTERNAL;
3969 gconf->reset_scontext = PGC_INTERNAL;
3970 gconf->stack = NULL;
3971 gconf->extra = NULL;
3972 gconf->sourcefile = NULL;
3973 gconf->sourceline = 0;
3975 switch (gconf->vartype)
3979 struct config_bool *conf = (struct config_bool *) gconf;
3980 bool newval = conf->boot_val;
3983 if (!call_bool_check_hook(conf, &newval, &extra,
3984 PGC_S_DEFAULT, LOG))
3985 elog(FATAL, "failed to initialize %s to %d",
3986 conf->gen.name, (int) newval);
3987 if (conf->assign_hook)
3988 (*conf->assign_hook) (newval, extra);
3989 *conf->variable = conf->reset_val = newval;
3990 conf->gen.extra = conf->reset_extra = extra;
3995 struct config_int *conf = (struct config_int *) gconf;
3996 int newval = conf->boot_val;
3999 Assert(newval >= conf->min);
4000 Assert(newval <= conf->max);
4001 if (!call_int_check_hook(conf, &newval, &extra,
4002 PGC_S_DEFAULT, LOG))
4003 elog(FATAL, "failed to initialize %s to %d",
4004 conf->gen.name, newval);
4005 if (conf->assign_hook)
4006 (*conf->assign_hook) (newval, extra);
4007 *conf->variable = conf->reset_val = newval;
4008 conf->gen.extra = conf->reset_extra = extra;
4013 struct config_real *conf = (struct config_real *) gconf;
4014 double newval = conf->boot_val;
4017 Assert(newval >= conf->min);
4018 Assert(newval <= conf->max);
4019 if (!call_real_check_hook(conf, &newval, &extra,
4020 PGC_S_DEFAULT, LOG))
4021 elog(FATAL, "failed to initialize %s to %g",
4022 conf->gen.name, newval);
4023 if (conf->assign_hook)
4024 (*conf->assign_hook) (newval, extra);
4025 *conf->variable = conf->reset_val = newval;
4026 conf->gen.extra = conf->reset_extra = extra;
4031 struct config_string *conf = (struct config_string *) gconf;
4035 /* non-NULL boot_val must always get strdup'd */
4036 if (conf->boot_val != NULL)
4037 newval = guc_strdup(FATAL, conf->boot_val);
4041 if (!call_string_check_hook(conf, &newval, &extra,
4042 PGC_S_DEFAULT, LOG))
4043 elog(FATAL, "failed to initialize %s to \"%s\"",
4044 conf->gen.name, newval ? newval : "");
4045 if (conf->assign_hook)
4046 (*conf->assign_hook) (newval, extra);
4047 *conf->variable = conf->reset_val = newval;
4048 conf->gen.extra = conf->reset_extra = extra;
4053 struct config_enum *conf = (struct config_enum *) gconf;
4054 int newval = conf->boot_val;
4057 if (!call_enum_check_hook(conf, &newval, &extra,
4058 PGC_S_DEFAULT, LOG))
4059 elog(FATAL, "failed to initialize %s to %d",
4060 conf->gen.name, newval);
4061 if (conf->assign_hook)
4062 (*conf->assign_hook) (newval, extra);
4063 *conf->variable = conf->reset_val = newval;
4064 conf->gen.extra = conf->reset_extra = extra;
4072 * Select the configuration files and data directory to be used, and
4073 * do the initial read of postgresql.conf.
4075 * This is called after processing command-line switches.
4076 * userDoption is the -D switch value if any (NULL if unspecified).
4077 * progname is just for use in error messages.
4079 * Returns true on success; on failure, prints a suitable error message
4080 * to stderr and returns false.
4083 SelectConfigFiles(const char *userDoption, const char *progname)
4087 struct stat stat_buf;
4089 /* configdir is -D option, or $PGDATA if no -D */
4091 configdir = make_absolute_path(userDoption);
4093 configdir = make_absolute_path(getenv("PGDATA"));
4096 * Find the configuration file: if config_file was specified on the
4097 * command line, use it, else use configdir/postgresql.conf. In any case
4098 * ensure the result is an absolute path, so that it will be interpreted
4099 * the same way by future backends.
4102 fname = make_absolute_path(ConfigFileName);
4105 fname = guc_malloc(FATAL,
4106 strlen(configdir) + strlen(CONFIG_FILENAME) + 2);
4107 sprintf(fname, "%s/%s", configdir, CONFIG_FILENAME);
4111 write_stderr("%s does not know where to find the server configuration file.\n"
4112 "You must specify the --config-file or -D invocation "
4113 "option or set the PGDATA environment variable.\n",
4119 * Set the ConfigFileName GUC variable to its final value, ensuring that
4120 * it can't be overridden later.
4122 SetConfigOption("config_file", fname, PGC_POSTMASTER, PGC_S_OVERRIDE);
4126 * Now read the config file for the first time.
4128 if (stat(ConfigFileName, &stat_buf) != 0)
4130 write_stderr("%s cannot access the server configuration file \"%s\": %s\n",
4131 progname, ConfigFileName, strerror(errno));
4136 ProcessConfigFile(PGC_POSTMASTER);
4139 * If the data_directory GUC variable has been set, use that as DataDir;
4140 * otherwise use configdir if set; else punt.
4142 * Note: SetDataDir will copy and absolute-ize its argument, so we don't
4146 SetDataDir(data_directory);
4148 SetDataDir(configdir);
4151 write_stderr("%s does not know where to find the database system data.\n"
4152 "This can be specified as \"data_directory\" in \"%s\", "
4153 "or by the -D invocation option, or by the "
4154 "PGDATA environment variable.\n",
4155 progname, ConfigFileName);
4160 * Reflect the final DataDir value back into the data_directory GUC var.
4161 * (If you are wondering why we don't just make them a single variable,
4162 * it's because the EXEC_BACKEND case needs DataDir to be transmitted to
4163 * child backends specially. XXX is that still true? Given that we now
4164 * chdir to DataDir, EXEC_BACKEND can read the config file without knowing
4165 * DataDir in advance.)
4167 SetConfigOption("data_directory", DataDir, PGC_POSTMASTER, PGC_S_OVERRIDE);
4170 * If timezone_abbreviations wasn't set in the configuration file, install
4171 * the default value. We do it this way because we can't safely install a
4172 * "real" value until my_exec_path is set, which may not have happened
4173 * when InitializeGUCOptions runs, so the bootstrap default value cannot
4174 * be the real desired default.
4176 pg_timezone_abbrev_initialize();
4179 * Figure out where pg_hba.conf is, and make sure the path is absolute.
4182 fname = make_absolute_path(HbaFileName);
4185 fname = guc_malloc(FATAL,
4186 strlen(configdir) + strlen(HBA_FILENAME) + 2);
4187 sprintf(fname, "%s/%s", configdir, HBA_FILENAME);
4191 write_stderr("%s does not know where to find the \"hba\" configuration file.\n"
4192 "This can be specified as \"hba_file\" in \"%s\", "
4193 "or by the -D invocation option, or by the "
4194 "PGDATA environment variable.\n",
4195 progname, ConfigFileName);
4198 SetConfigOption("hba_file", fname, PGC_POSTMASTER, PGC_S_OVERRIDE);
4202 * Likewise for pg_ident.conf.
4205 fname = make_absolute_path(IdentFileName);
4208 fname = guc_malloc(FATAL,
4209 strlen(configdir) + strlen(IDENT_FILENAME) + 2);
4210 sprintf(fname, "%s/%s", configdir, IDENT_FILENAME);
4214 write_stderr("%s does not know where to find the \"ident\" configuration file.\n"
4215 "This can be specified as \"ident_file\" in \"%s\", "
4216 "or by the -D invocation option, or by the "
4217 "PGDATA environment variable.\n",
4218 progname, ConfigFileName);
4221 SetConfigOption("ident_file", fname, PGC_POSTMASTER, PGC_S_OVERRIDE);
4231 * Reset all options to their saved default values (implements RESET ALL)
4234 ResetAllOptions(void)
4238 for (i = 0; i < num_guc_variables; i++)
4240 struct config_generic *gconf = guc_variables[i];
4242 /* Don't reset non-SET-able values */
4243 if (gconf->context != PGC_SUSET &&
4244 gconf->context != PGC_USERSET)
4246 /* Don't reset if special exclusion from RESET ALL */
4247 if (gconf->flags & GUC_NO_RESET_ALL)
4249 /* No need to reset if wasn't SET */
4250 if (gconf->source <= PGC_S_OVERRIDE)
4253 /* Save old value to support transaction abort */
4254 push_old_value(gconf, GUC_ACTION_SET);
4256 switch (gconf->vartype)
4260 struct config_bool *conf = (struct config_bool *) gconf;
4262 if (conf->assign_hook)
4263 (*conf->assign_hook) (conf->reset_val,
4265 *conf->variable = conf->reset_val;
4266 set_extra_field(&conf->gen, &conf->gen.extra,
4272 struct config_int *conf = (struct config_int *) gconf;
4274 if (conf->assign_hook)
4275 (*conf->assign_hook) (conf->reset_val,
4277 *conf->variable = conf->reset_val;
4278 set_extra_field(&conf->gen, &conf->gen.extra,
4284 struct config_real *conf = (struct config_real *) gconf;
4286 if (conf->assign_hook)
4287 (*conf->assign_hook) (conf->reset_val,
4289 *conf->variable = conf->reset_val;
4290 set_extra_field(&conf->gen, &conf->gen.extra,
4296 struct config_string *conf = (struct config_string *) gconf;
4298 if (conf->assign_hook)
4299 (*conf->assign_hook) (conf->reset_val,
4301 set_string_field(conf, conf->variable, conf->reset_val);
4302 set_extra_field(&conf->gen, &conf->gen.extra,
4308 struct config_enum *conf = (struct config_enum *) gconf;
4310 if (conf->assign_hook)
4311 (*conf->assign_hook) (conf->reset_val,
4313 *conf->variable = conf->reset_val;
4314 set_extra_field(&conf->gen, &conf->gen.extra,
4320 gconf->source = gconf->reset_source;
4321 gconf->scontext = gconf->reset_scontext;
4323 if (gconf->flags & GUC_REPORT)
4324 ReportGUCOption(gconf);
4331 * Push previous state during transactional assignment to a GUC variable.
4334 push_old_value(struct config_generic * gconf, GucAction action)
4338 /* If we're not inside a nest level, do nothing */
4339 if (GUCNestLevel == 0)
4342 /* Do we already have a stack entry of the current nest level? */
4343 stack = gconf->stack;
4344 if (stack && stack->nest_level >= GUCNestLevel)
4346 /* Yes, so adjust its state if necessary */
4347 Assert(stack->nest_level == GUCNestLevel);
4350 case GUC_ACTION_SET:
4351 /* SET overrides any prior action at same nest level */
4352 if (stack->state == GUC_SET_LOCAL)
4354 /* must discard old masked value */
4355 discard_stack_value(gconf, &stack->masked);
4357 stack->state = GUC_SET;
4359 case GUC_ACTION_LOCAL:
4360 if (stack->state == GUC_SET)
4362 /* SET followed by SET LOCAL, remember SET's value */
4363 stack->masked_scontext = gconf->scontext;
4364 set_stack_value(gconf, &stack->masked);
4365 stack->state = GUC_SET_LOCAL;
4367 /* in all other cases, no change to stack entry */
4369 case GUC_ACTION_SAVE:
4370 /* Could only have a prior SAVE of same variable */
4371 Assert(stack->state == GUC_SAVE);
4374 Assert(guc_dirty); /* must be set already */
4379 * Push a new stack entry
4381 * We keep all the stack entries in TopTransactionContext for simplicity.
4383 stack = (GucStack *) MemoryContextAllocZero(TopTransactionContext,
4386 stack->prev = gconf->stack;
4387 stack->nest_level = GUCNestLevel;
4390 case GUC_ACTION_SET:
4391 stack->state = GUC_SET;
4393 case GUC_ACTION_LOCAL:
4394 stack->state = GUC_LOCAL;
4396 case GUC_ACTION_SAVE:
4397 stack->state = GUC_SAVE;
4400 stack->source = gconf->source;
4401 stack->scontext = gconf->scontext;
4402 set_stack_value(gconf, &stack->prior);
4404 gconf->stack = stack;
4406 /* Ensure we remember to pop at end of xact */
4412 * Do GUC processing at main transaction start.
4418 * The nest level should be 0 between transactions; if it isn't, somebody
4419 * didn't call AtEOXact_GUC, or called it with the wrong nestLevel. We
4420 * throw a warning but make no other effort to clean up.
4422 if (GUCNestLevel != 0)
4423 elog(WARNING, "GUC nest level = %d at transaction start",
4429 * Enter a new nesting level for GUC values. This is called at subtransaction
4430 * start, and when entering a function that has proconfig settings, and in
4431 * some other places where we want to set GUC variables transiently.
4432 * NOTE we must not risk error here, else subtransaction start will be unhappy.
4435 NewGUCNestLevel(void)
4437 return ++GUCNestLevel;
4441 * Do GUC processing at transaction or subtransaction commit or abort, or
4442 * when exiting a function that has proconfig settings, or when undoing a
4443 * transient assignment to some GUC variables. (The name is thus a bit of
4444 * a misnomer; perhaps it should be ExitGUCNestLevel or some such.)
4445 * During abort, we discard all GUC settings that were applied at nesting
4446 * levels >= nestLevel. nestLevel == 1 corresponds to the main transaction.
4449 AtEOXact_GUC(bool isCommit, int nestLevel)
4455 * Note: it's possible to get here with GUCNestLevel == nestLevel-1 during
4456 * abort, if there is a failure during transaction start before
4457 * AtStart_GUC is called.
4459 Assert(nestLevel > 0 &&
4460 (nestLevel <= GUCNestLevel ||
4461 (nestLevel == GUCNestLevel + 1 && !isCommit)));
4463 /* Quick exit if nothing's changed in this transaction */
4466 GUCNestLevel = nestLevel - 1;
4470 still_dirty = false;
4471 for (i = 0; i < num_guc_variables; i++)
4473 struct config_generic *gconf = guc_variables[i];
4477 * Process and pop each stack entry within the nest level. To simplify
4478 * fmgr_security_definer() and other places that use GUC_ACTION_SAVE,
4479 * we allow failure exit from code that uses a local nest level to be
4480 * recovered at the surrounding transaction or subtransaction abort;
4481 * so there could be more than one stack entry to pop.
4483 while ((stack = gconf->stack) != NULL &&
4484 stack->nest_level >= nestLevel)
4486 GucStack *prev = stack->prev;
4487 bool restorePrior = false;
4488 bool restoreMasked = false;
4492 * In this next bit, if we don't set either restorePrior or
4493 * restoreMasked, we must "discard" any unwanted fields of the
4494 * stack entries to avoid leaking memory. If we do set one of
4495 * those flags, unused fields will be cleaned up after restoring.
4497 if (!isCommit) /* if abort, always restore prior value */
4498 restorePrior = true;
4499 else if (stack->state == GUC_SAVE)
4500 restorePrior = true;
4501 else if (stack->nest_level == 1)
4503 /* transaction commit */
4504 if (stack->state == GUC_SET_LOCAL)
4505 restoreMasked = true;
4506 else if (stack->state == GUC_SET)
4508 /* we keep the current active value */
4509 discard_stack_value(gconf, &stack->prior);
4511 else /* must be GUC_LOCAL */
4512 restorePrior = true;
4514 else if (prev == NULL ||
4515 prev->nest_level < stack->nest_level - 1)
4517 /* decrement entry's level and do not pop it */
4518 stack->nest_level--;
4524 * We have to merge this stack entry into prev. See README for
4525 * discussion of this bit.
4527 switch (stack->state)
4530 Assert(false); /* can't get here */
4533 /* next level always becomes SET */
4534 discard_stack_value(gconf, &stack->prior);
4535 if (prev->state == GUC_SET_LOCAL)
4536 discard_stack_value(gconf, &prev->masked);
4537 prev->state = GUC_SET;
4541 if (prev->state == GUC_SET)
4543 /* LOCAL migrates down */
4544 prev->masked_scontext = stack->scontext;
4545 prev->masked = stack->prior;
4546 prev->state = GUC_SET_LOCAL;
4550 /* else just forget this stack level */
4551 discard_stack_value(gconf, &stack->prior);
4556 /* prior state at this level no longer wanted */
4557 discard_stack_value(gconf, &stack->prior);
4558 /* copy down the masked state */
4559 prev->masked_scontext = stack->masked_scontext;
4560 if (prev->state == GUC_SET_LOCAL)
4561 discard_stack_value(gconf, &prev->masked);
4562 prev->masked = stack->masked;
4563 prev->state = GUC_SET_LOCAL;
4570 if (restorePrior || restoreMasked)
4572 /* Perform appropriate restoration of the stacked value */
4573 config_var_value newvalue;
4574 GucSource newsource;
4575 GucContext newscontext;
4579 newvalue = stack->masked;
4580 newsource = PGC_S_SESSION;
4581 newscontext = stack->masked_scontext;
4585 newvalue = stack->prior;
4586 newsource = stack->source;
4587 newscontext = stack->scontext;
4590 switch (gconf->vartype)
4594 struct config_bool *conf = (struct config_bool *) gconf;
4595 bool newval = newvalue.val.boolval;
4596 void *newextra = newvalue.extra;
4598 if (*conf->variable != newval ||
4599 conf->gen.extra != newextra)
4601 if (conf->assign_hook)
4602 (*conf->assign_hook) (newval, newextra);
4603 *conf->variable = newval;
4604 set_extra_field(&conf->gen, &conf->gen.extra,
4612 struct config_int *conf = (struct config_int *) gconf;
4613 int newval = newvalue.val.intval;
4614 void *newextra = newvalue.extra;
4616 if (*conf->variable != newval ||
4617 conf->gen.extra != newextra)
4619 if (conf->assign_hook)
4620 (*conf->assign_hook) (newval, newextra);
4621 *conf->variable = newval;
4622 set_extra_field(&conf->gen, &conf->gen.extra,
4630 struct config_real *conf = (struct config_real *) gconf;
4631 double newval = newvalue.val.realval;
4632 void *newextra = newvalue.extra;
4634 if (*conf->variable != newval ||
4635 conf->gen.extra != newextra)
4637 if (conf->assign_hook)
4638 (*conf->assign_hook) (newval, newextra);
4639 *conf->variable = newval;
4640 set_extra_field(&conf->gen, &conf->gen.extra,
4648 struct config_string *conf = (struct config_string *) gconf;
4649 char *newval = newvalue.val.stringval;
4650 void *newextra = newvalue.extra;
4652 if (*conf->variable != newval ||
4653 conf->gen.extra != newextra)
4655 if (conf->assign_hook)
4656 (*conf->assign_hook) (newval, newextra);
4657 set_string_field(conf, conf->variable, newval);
4658 set_extra_field(&conf->gen, &conf->gen.extra,
4664 * Release stacked values if not used anymore. We
4665 * could use discard_stack_value() here, but since
4666 * we have type-specific code anyway, might as
4669 set_string_field(conf, &stack->prior.val.stringval, NULL);
4670 set_string_field(conf, &stack->masked.val.stringval, NULL);
4675 struct config_enum *conf = (struct config_enum *) gconf;
4676 int newval = newvalue.val.enumval;
4677 void *newextra = newvalue.extra;
4679 if (*conf->variable != newval ||
4680 conf->gen.extra != newextra)
4682 if (conf->assign_hook)
4683 (*conf->assign_hook) (newval, newextra);
4684 *conf->variable = newval;
4685 set_extra_field(&conf->gen, &conf->gen.extra,
4694 * Release stacked extra values if not used anymore.
4696 set_extra_field(gconf, &(stack->prior.extra), NULL);
4697 set_extra_field(gconf, &(stack->masked.extra), NULL);
4699 /* And restore source information */
4700 gconf->source = newsource;
4701 gconf->scontext = newscontext;
4704 /* Finish popping the state stack */
4705 gconf->stack = prev;
4708 /* Report new value if we changed it */
4709 if (changed && (gconf->flags & GUC_REPORT))
4710 ReportGUCOption(gconf);
4711 } /* end of stack-popping loop */
4717 /* If there are no remaining stack entries, we can reset guc_dirty */
4718 guc_dirty = still_dirty;
4720 /* Update nesting level */
4721 GUCNestLevel = nestLevel - 1;
4726 * Start up automatic reporting of changes to variables marked GUC_REPORT.
4727 * This is executed at completion of backend startup.
4730 BeginReportingGUCOptions(void)
4735 * Don't do anything unless talking to an interactive frontend of protocol
4738 if (whereToSendOutput != DestRemote ||
4739 PG_PROTOCOL_MAJOR(FrontendProtocol) < 3)
4742 reporting_enabled = true;
4744 /* Transmit initial values of interesting variables */
4745 for (i = 0; i < num_guc_variables; i++)
4747 struct config_generic *conf = guc_variables[i];
4749 if (conf->flags & GUC_REPORT)
4750 ReportGUCOption(conf);
4755 * ReportGUCOption: if appropriate, transmit option value to frontend
4758 ReportGUCOption(struct config_generic * record)
4760 if (reporting_enabled && (record->flags & GUC_REPORT))
4762 char *val = _ShowOption(record, false);
4763 StringInfoData msgbuf;
4765 pq_beginmessage(&msgbuf, 'S');
4766 pq_sendstring(&msgbuf, record->name);
4767 pq_sendstring(&msgbuf, val);
4768 pq_endmessage(&msgbuf);
4775 * Try to parse value as an integer. The accepted formats are the
4776 * usual decimal, octal, or hexadecimal formats, optionally followed by
4777 * a unit name if "flags" indicates a unit is allowed.
4779 * If the string parses okay, return true, else false.
4780 * If okay and result is not NULL, return the value in *result.
4781 * If not okay and hintmsg is not NULL, *hintmsg is set to a suitable
4782 * HINT message, or NULL if no hint provided.
4785 parse_int(const char *value, int *result, int flags, const char **hintmsg)
4790 /* To suppress compiler warnings, always set output params */
4796 /* We assume here that int64 is at least as wide as long */
4798 val = strtol(value, &endptr, 0);
4800 if (endptr == value)
4801 return false; /* no HINT for integer syntax error */
4803 if (errno == ERANGE || val != (int64) ((int32) val))
4806 *hintmsg = gettext_noop("Value exceeds integer range.");
4810 /* allow whitespace between integer and unit */
4811 while (isspace((unsigned char) *endptr))
4814 /* Handle possible unit */
4815 if (*endptr != '\0')
4818 * Note: the multiple-switch coding technique here is a bit tedious,
4819 * but seems necessary to avoid intermediate-value overflows.
4821 if (flags & GUC_UNIT_MEMORY)
4823 /* Set hint for use if no match or trailing garbage */
4825 *hintmsg = gettext_noop("Valid units for this parameter are \"kB\", \"MB\", and \"GB\".");
4827 #if BLCKSZ < 1024 || BLCKSZ > (1024*1024)
4828 #error BLCKSZ must be between 1KB and 1MB
4830 #if XLOG_BLCKSZ < 1024 || XLOG_BLCKSZ > (1024*1024)
4831 #error XLOG_BLCKSZ must be between 1KB and 1MB
4834 if (strncmp(endptr, "kB", 2) == 0)
4837 switch (flags & GUC_UNIT_MEMORY)
4839 case GUC_UNIT_BLOCKS:
4840 val /= (BLCKSZ / 1024);
4842 case GUC_UNIT_XBLOCKS:
4843 val /= (XLOG_BLCKSZ / 1024);
4847 else if (strncmp(endptr, "MB", 2) == 0)
4850 switch (flags & GUC_UNIT_MEMORY)
4855 case GUC_UNIT_BLOCKS:
4856 val *= KB_PER_MB / (BLCKSZ / 1024);
4858 case GUC_UNIT_XBLOCKS:
4859 val *= KB_PER_MB / (XLOG_BLCKSZ / 1024);
4863 else if (strncmp(endptr, "GB", 2) == 0)
4866 switch (flags & GUC_UNIT_MEMORY)
4871 case GUC_UNIT_BLOCKS:
4872 val *= KB_PER_GB / (BLCKSZ / 1024);
4874 case GUC_UNIT_XBLOCKS:
4875 val *= KB_PER_GB / (XLOG_BLCKSZ / 1024);
4880 else if (flags & GUC_UNIT_TIME)
4882 /* Set hint for use if no match or trailing garbage */
4884 *hintmsg = gettext_noop("Valid units for this parameter are \"ms\", \"s\", \"min\", \"h\", and \"d\".");
4886 if (strncmp(endptr, "ms", 2) == 0)
4889 switch (flags & GUC_UNIT_TIME)
4899 else if (strncmp(endptr, "s", 1) == 0)
4902 switch (flags & GUC_UNIT_TIME)
4912 else if (strncmp(endptr, "min", 3) == 0)
4915 switch (flags & GUC_UNIT_TIME)
4925 else if (strncmp(endptr, "h", 1) == 0)
4928 switch (flags & GUC_UNIT_TIME)
4941 else if (strncmp(endptr, "d", 1) == 0)
4944 switch (flags & GUC_UNIT_TIME)
4959 /* allow whitespace after unit */
4960 while (isspace((unsigned char) *endptr))
4963 if (*endptr != '\0')
4964 return false; /* appropriate hint, if any, already set */
4966 /* Check for overflow due to units conversion */
4967 if (val != (int64) ((int32) val))
4970 *hintmsg = gettext_noop("Value exceeds integer range.");
4976 *result = (int) val;
4983 * Try to parse value as a floating point number in the usual format.
4984 * If the string parses okay, return true, else false.
4985 * If okay and result is not NULL, return the value in *result.
4988 parse_real(const char *value, double *result)
4994 *result = 0; /* suppress compiler warning */
4997 val = strtod(value, &endptr);
4998 if (endptr == value || errno == ERANGE)
5001 /* allow whitespace after number */
5002 while (isspace((unsigned char) *endptr))
5004 if (*endptr != '\0')
5014 * Lookup the name for an enum option with the selected value.
5015 * Should only ever be called with known-valid values, so throws
5016 * an elog(ERROR) if the enum option is not found.
5018 * The returned string is a pointer to static data and not
5019 * allocated for modification.
5022 config_enum_lookup_by_value(struct config_enum * record, int val)
5024 const struct config_enum_entry *entry;
5026 for (entry = record->options; entry && entry->name; entry++)
5028 if (entry->val == val)
5032 elog(ERROR, "could not find enum option %d for %s",
5033 val, record->gen.name);
5034 return NULL; /* silence compiler */
5039 * Lookup the value for an enum option with the selected name
5040 * (case-insensitive).
5041 * If the enum option is found, sets the retval value and returns
5042 * true. If it's not found, return FALSE and retval is set to 0.
5045 config_enum_lookup_by_name(struct config_enum * record, const char *value,
5048 const struct config_enum_entry *entry;
5050 for (entry = record->options; entry && entry->name; entry++)
5052 if (pg_strcasecmp(value, entry->name) == 0)
5054 *retval = entry->val;
5065 * Return a list of all available options for an enum, excluding
5066 * hidden ones, separated by the given separator.
5067 * If prefix is non-NULL, it is added before the first enum value.
5068 * If suffix is non-NULL, it is added to the end of the string.
5071 config_enum_get_options(struct config_enum * record, const char *prefix,
5072 const char *suffix, const char *separator)
5074 const struct config_enum_entry *entry;
5075 StringInfoData retstr;
5078 initStringInfo(&retstr);
5079 appendStringInfoString(&retstr, prefix);
5081 seplen = strlen(separator);
5082 for (entry = record->options; entry && entry->name; entry++)
5086 appendStringInfoString(&retstr, entry->name);
5087 appendBinaryStringInfo(&retstr, separator, seplen);
5092 * All the entries may have been hidden, leaving the string empty if no
5093 * prefix was given. This indicates a broken GUC setup, since there is no
5094 * use for an enum without any values, so we just check to make sure we
5095 * don't write to invalid memory instead of actually trying to do
5096 * something smart with it.
5098 if (retstr.len >= seplen)
5100 /* Replace final separator */
5101 retstr.data[retstr.len - seplen] = '\0';
5102 retstr.len -= seplen;
5105 appendStringInfoString(&retstr, suffix);
5112 * Sets option `name' to given value.
5114 * The value should be a string, which will be parsed and converted to
5115 * the appropriate data type. The context and source parameters indicate
5116 * in which context this function is being called, so that it can apply the
5117 * access restrictions properly.
5119 * If value is NULL, set the option to its default value (normally the
5120 * reset_val, but if source == PGC_S_DEFAULT we instead use the boot_val).
5122 * action indicates whether to set the value globally in the session, locally
5123 * to the current top transaction, or just for the duration of a function call.
5125 * If changeVal is false then don't really set the option but do all
5126 * the checks to see if it would work.
5128 * elevel should normally be passed as zero, allowing this function to make
5129 * its standard choice of ereport level. However some callers need to be
5130 * able to override that choice; they should pass the ereport level to use.
5133 * +1: the value is valid and was successfully applied.
5134 * 0: the name or value is invalid (but see below).
5135 * -1: the value was not applied because of context, priority, or changeVal.
5137 * If there is an error (non-existing option, invalid value) then an
5138 * ereport(ERROR) is thrown *unless* this is called for a source for which
5139 * we don't want an ERROR (currently, those are defaults, the config file,
5140 * and per-database or per-user settings, as well as callers who specify
5141 * a less-than-ERROR elevel). In those cases we write a suitable error
5142 * message via ereport() and return 0.
5144 * See also SetConfigOption for an external interface.
5147 set_config_option(const char *name, const char *value,
5148 GucContext context, GucSource source,
5149 GucAction action, bool changeVal, int elevel)
5151 struct config_generic *record;
5152 bool prohibitValueChange = false;
5157 if (source == PGC_S_DEFAULT || source == PGC_S_FILE)
5160 * To avoid cluttering the log, only the postmaster bleats loudly
5161 * about problems with the config file.
5163 elevel = IsUnderPostmaster ? DEBUG3 : LOG;
5165 else if (source == PGC_S_DATABASE || source == PGC_S_USER ||
5166 source == PGC_S_DATABASE_USER)
5172 record = find_option(name, true, elevel);
5176 (errcode(ERRCODE_UNDEFINED_OBJECT),
5177 errmsg("unrecognized configuration parameter \"%s\"", name)));
5182 * Check if the option can be set at this time. See guc.h for the precise
5185 switch (record->context)
5188 if (context != PGC_INTERNAL)
5191 (errcode(ERRCODE_CANT_CHANGE_RUNTIME_PARAM),
5192 errmsg("parameter \"%s\" cannot be changed",
5197 case PGC_POSTMASTER:
5198 if (context == PGC_SIGHUP)
5201 * We are re-reading a PGC_POSTMASTER variable from
5202 * postgresql.conf. We can't change the setting, so we should
5203 * give a warning if the DBA tries to change it. However,
5204 * because of variant formats, canonicalization by check
5205 * hooks, etc, we can't just compare the given string directly
5206 * to what's stored. Set a flag to check below after we have
5207 * the final storable value.
5209 prohibitValueChange = true;
5211 else if (context != PGC_POSTMASTER)
5214 (errcode(ERRCODE_CANT_CHANGE_RUNTIME_PARAM),
5215 errmsg("parameter \"%s\" cannot be changed without restarting the server",
5221 if (context != PGC_SIGHUP && context != PGC_POSTMASTER)
5224 (errcode(ERRCODE_CANT_CHANGE_RUNTIME_PARAM),
5225 errmsg("parameter \"%s\" cannot be changed now",
5231 * Hmm, the idea of the SIGHUP context is "ought to be global, but
5232 * can be changed after postmaster start". But there's nothing
5233 * that prevents a crafty administrator from sending SIGHUP
5234 * signals to individual backends only.
5238 if (context == PGC_SIGHUP)
5241 * If a PGC_BACKEND parameter is changed in the config file,
5242 * we want to accept the new value in the postmaster (whence
5243 * it will propagate to subsequently-started backends), but
5244 * ignore it in existing backends. This is a tad klugy, but
5245 * necessary because we don't re-read the config file during
5248 if (IsUnderPostmaster)
5251 else if (context != PGC_POSTMASTER && context != PGC_BACKEND &&
5252 source != PGC_S_CLIENT)
5255 (errcode(ERRCODE_CANT_CHANGE_RUNTIME_PARAM),
5256 errmsg("parameter \"%s\" cannot be set after connection start",
5262 if (context == PGC_USERSET || context == PGC_BACKEND)
5265 (errcode(ERRCODE_INSUFFICIENT_PRIVILEGE),
5266 errmsg("permission denied to set parameter \"%s\"",
5277 * Disallow changing GUC_NOT_WHILE_SEC_REST values if we are inside a
5278 * security restriction context. We can reject this regardless of the GUC
5279 * context or source, mainly because sources that it might be reasonable
5280 * to override for won't be seen while inside a function.
5282 * Note: variables marked GUC_NOT_WHILE_SEC_REST should usually be marked
5283 * GUC_NO_RESET_ALL as well, because ResetAllOptions() doesn't check this.
5284 * An exception might be made if the reset value is assumed to be "safe".
5286 * Note: this flag is currently used for "session_authorization" and
5287 * "role". We need to prohibit changing these inside a local userid
5288 * context because when we exit it, GUC won't be notified, leaving things
5289 * out of sync. (This could be fixed by forcing a new GUC nesting level,
5290 * but that would change behavior in possibly-undesirable ways.) Also, we
5291 * prohibit changing these in a security-restricted operation because
5292 * otherwise RESET could be used to regain the session user's privileges.
5294 if (record->flags & GUC_NOT_WHILE_SEC_REST)
5296 if (InLocalUserIdChange())
5299 * Phrasing of this error message is historical, but it's the most
5303 (errcode(ERRCODE_INSUFFICIENT_PRIVILEGE),
5304 errmsg("cannot set parameter \"%s\" within security-definer function",
5308 if (InSecurityRestrictedOperation())
5311 (errcode(ERRCODE_INSUFFICIENT_PRIVILEGE),
5312 errmsg("cannot set parameter \"%s\" within security-restricted operation",
5319 * Should we set reset/stacked values? (If so, the behavior is not
5320 * transactional.) This is done either when we get a default value from
5321 * the database's/user's/client's default settings or when we reset a
5322 * value to its default.
5324 makeDefault = changeVal && (source <= PGC_S_OVERRIDE) &&
5325 ((value != NULL) || source == PGC_S_DEFAULT);
5328 * Ignore attempted set if overridden by previously processed setting.
5329 * However, if changeVal is false then plow ahead anyway since we are
5330 * trying to find out if the value is potentially good, not actually use
5331 * it. Also keep going if makeDefault is true, since we may want to set
5332 * the reset/stacked values even if we can't set the variable itself.
5334 if (record->source > source)
5336 if (changeVal && !makeDefault)
5338 elog(DEBUG3, "\"%s\": setting ignored because previous source is higher priority",
5346 * Evaluate value and set variable.
5348 switch (record->vartype)
5352 struct config_bool *conf = (struct config_bool *) record;
5354 void *newextra = NULL;
5358 if (!parse_bool(value, &newval))
5361 (errcode(ERRCODE_INVALID_PARAMETER_VALUE),
5362 errmsg("parameter \"%s\" requires a Boolean value",
5366 if (!call_bool_check_hook(conf, &newval, &newextra,
5370 else if (source == PGC_S_DEFAULT)
5372 newval = conf->boot_val;
5373 if (!call_bool_check_hook(conf, &newval, &newextra,
5379 newval = conf->reset_val;
5380 newextra = conf->reset_extra;
5381 source = conf->gen.reset_source;
5382 context = conf->gen.reset_scontext;
5385 if (prohibitValueChange)
5387 if (*conf->variable != newval)
5390 (errcode(ERRCODE_CANT_CHANGE_RUNTIME_PARAM),
5391 errmsg("parameter \"%s\" cannot be changed without restarting the server",
5400 /* Save old value to support transaction abort */
5402 push_old_value(&conf->gen, action);
5404 if (conf->assign_hook)
5405 (*conf->assign_hook) (newval, newextra);
5406 *conf->variable = newval;
5407 set_extra_field(&conf->gen, &conf->gen.extra,
5409 conf->gen.source = source;
5410 conf->gen.scontext = context;
5416 if (conf->gen.reset_source <= source)
5418 conf->reset_val = newval;
5419 set_extra_field(&conf->gen, &conf->reset_extra,
5421 conf->gen.reset_source = source;
5422 conf->gen.reset_scontext = context;
5424 for (stack = conf->gen.stack; stack; stack = stack->prev)
5426 if (stack->source <= source)
5428 stack->prior.val.boolval = newval;
5429 set_extra_field(&conf->gen, &stack->prior.extra,
5431 stack->source = source;
5432 stack->scontext = context;
5437 /* Perhaps we didn't install newextra anywhere */
5438 if (newextra && !extra_field_used(&conf->gen, newextra))
5445 struct config_int *conf = (struct config_int *) record;
5447 void *newextra = NULL;
5451 const char *hintmsg;
5453 if (!parse_int(value, &newval, conf->gen.flags, &hintmsg))
5456 (errcode(ERRCODE_INVALID_PARAMETER_VALUE),
5457 errmsg("invalid value for parameter \"%s\": \"%s\"",
5459 hintmsg ? errhint("%s", _(hintmsg)) : 0));
5462 if (newval < conf->min || newval > conf->max)
5465 (errcode(ERRCODE_INVALID_PARAMETER_VALUE),
5466 errmsg("%d is outside the valid range for parameter \"%s\" (%d .. %d)",
5467 newval, name, conf->min, conf->max)));
5470 if (!call_int_check_hook(conf, &newval, &newextra,
5474 else if (source == PGC_S_DEFAULT)
5476 newval = conf->boot_val;
5477 if (!call_int_check_hook(conf, &newval, &newextra,
5483 newval = conf->reset_val;
5484 newextra = conf->reset_extra;
5485 source = conf->gen.reset_source;
5486 context = conf->gen.reset_scontext;
5489 if (prohibitValueChange)
5491 if (*conf->variable != newval)
5494 (errcode(ERRCODE_CANT_CHANGE_RUNTIME_PARAM),
5495 errmsg("parameter \"%s\" cannot be changed without restarting the server",
5504 /* Save old value to support transaction abort */
5506 push_old_value(&conf->gen, action);
5508 if (conf->assign_hook)
5509 (*conf->assign_hook) (newval, newextra);
5510 *conf->variable = newval;
5511 set_extra_field(&conf->gen, &conf->gen.extra,
5513 conf->gen.source = source;
5514 conf->gen.scontext = context;
5520 if (conf->gen.reset_source <= source)
5522 conf->reset_val = newval;
5523 set_extra_field(&conf->gen, &conf->reset_extra,
5525 conf->gen.reset_source = source;
5526 conf->gen.reset_scontext = context;
5528 for (stack = conf->gen.stack; stack; stack = stack->prev)
5530 if (stack->source <= source)
5532 stack->prior.val.intval = newval;
5533 set_extra_field(&conf->gen, &stack->prior.extra,
5535 stack->source = source;
5536 stack->scontext = context;
5541 /* Perhaps we didn't install newextra anywhere */
5542 if (newextra && !extra_field_used(&conf->gen, newextra))
5549 struct config_real *conf = (struct config_real *) record;
5551 void *newextra = NULL;
5555 if (!parse_real(value, &newval))
5558 (errcode(ERRCODE_INVALID_PARAMETER_VALUE),
5559 errmsg("parameter \"%s\" requires a numeric value",
5563 if (newval < conf->min || newval > conf->max)
5566 (errcode(ERRCODE_INVALID_PARAMETER_VALUE),
5567 errmsg("%g is outside the valid range for parameter \"%s\" (%g .. %g)",
5568 newval, name, conf->min, conf->max)));
5571 if (!call_real_check_hook(conf, &newval, &newextra,
5575 else if (source == PGC_S_DEFAULT)
5577 newval = conf->boot_val;
5578 if (!call_real_check_hook(conf, &newval, &newextra,
5584 newval = conf->reset_val;
5585 newextra = conf->reset_extra;
5586 source = conf->gen.reset_source;
5587 context = conf->gen.reset_scontext;
5590 if (prohibitValueChange)
5592 if (*conf->variable != newval)
5595 (errcode(ERRCODE_CANT_CHANGE_RUNTIME_PARAM),
5596 errmsg("parameter \"%s\" cannot be changed without restarting the server",
5605 /* Save old value to support transaction abort */
5607 push_old_value(&conf->gen, action);
5609 if (conf->assign_hook)
5610 (*conf->assign_hook) (newval, newextra);
5611 *conf->variable = newval;
5612 set_extra_field(&conf->gen, &conf->gen.extra,
5614 conf->gen.source = source;
5615 conf->gen.scontext = context;
5621 if (conf->gen.reset_source <= source)
5623 conf->reset_val = newval;
5624 set_extra_field(&conf->gen, &conf->reset_extra,
5626 conf->gen.reset_source = source;
5627 conf->gen.reset_scontext = context;
5629 for (stack = conf->gen.stack; stack; stack = stack->prev)
5631 if (stack->source <= source)
5633 stack->prior.val.realval = newval;
5634 set_extra_field(&conf->gen, &stack->prior.extra,
5636 stack->source = source;
5637 stack->scontext = context;
5642 /* Perhaps we didn't install newextra anywhere */
5643 if (newextra && !extra_field_used(&conf->gen, newextra))
5650 struct config_string *conf = (struct config_string *) record;
5652 void *newextra = NULL;
5657 * The value passed by the caller could be transient, so
5658 * we always strdup it.
5660 newval = guc_strdup(elevel, value);
5665 * The only built-in "parsing" check we have is to apply
5666 * truncation if GUC_IS_NAME.
5668 if (conf->gen.flags & GUC_IS_NAME)
5669 truncate_identifier(newval, strlen(newval), true);
5671 if (!call_string_check_hook(conf, &newval, &newextra,
5678 else if (source == PGC_S_DEFAULT)
5680 /* non-NULL boot_val must always get strdup'd */
5681 if (conf->boot_val != NULL)
5683 newval = guc_strdup(elevel, conf->boot_val);
5690 if (!call_string_check_hook(conf, &newval, &newextra,
5700 * strdup not needed, since reset_val is already under
5703 newval = conf->reset_val;
5704 newextra = conf->reset_extra;
5705 source = conf->gen.reset_source;
5706 context = conf->gen.reset_scontext;
5709 if (prohibitValueChange)
5711 /* newval shouldn't be NULL, so we're a bit sloppy here */
5712 if (*conf->variable == NULL || newval == NULL ||
5713 strcmp(*conf->variable, newval) != 0)
5716 (errcode(ERRCODE_CANT_CHANGE_RUNTIME_PARAM),
5717 errmsg("parameter \"%s\" cannot be changed without restarting the server",
5726 /* Save old value to support transaction abort */
5728 push_old_value(&conf->gen, action);
5730 if (conf->assign_hook)
5731 (*conf->assign_hook) (newval, newextra);
5732 set_string_field(conf, conf->variable, newval);
5733 set_extra_field(&conf->gen, &conf->gen.extra,
5735 conf->gen.source = source;
5736 conf->gen.scontext = context;
5743 if (conf->gen.reset_source <= source)
5745 set_string_field(conf, &conf->reset_val, newval);
5746 set_extra_field(&conf->gen, &conf->reset_extra,
5748 conf->gen.reset_source = source;
5749 conf->gen.reset_scontext = context;
5751 for (stack = conf->gen.stack; stack; stack = stack->prev)
5753 if (stack->source <= source)
5755 set_string_field(conf, &stack->prior.val.stringval,
5757 set_extra_field(&conf->gen, &stack->prior.extra,
5759 stack->source = source;
5760 stack->scontext = context;
5765 /* Perhaps we didn't install newval anywhere */
5766 if (newval && !string_field_used(conf, newval))
5768 /* Perhaps we didn't install newextra anywhere */
5769 if (newextra && !extra_field_used(&conf->gen, newextra))
5776 struct config_enum *conf = (struct config_enum *) record;
5778 void *newextra = NULL;
5782 if (!config_enum_lookup_by_name(conf, value, &newval))
5786 hintmsg = config_enum_get_options(conf,
5787 "Available values: ",
5791 (errcode(ERRCODE_INVALID_PARAMETER_VALUE),
5792 errmsg("invalid value for parameter \"%s\": \"%s\"",
5794 hintmsg ? errhint("%s", _(hintmsg)) : 0));
5800 if (!call_enum_check_hook(conf, &newval, &newextra,
5804 else if (source == PGC_S_DEFAULT)
5806 newval = conf->boot_val;
5807 if (!call_enum_check_hook(conf, &newval, &newextra,
5813 newval = conf->reset_val;
5814 newextra = conf->reset_extra;
5815 source = conf->gen.reset_source;
5816 context = conf->gen.reset_scontext;
5819 if (prohibitValueChange)
5821 if (*conf->variable != newval)
5824 (errcode(ERRCODE_CANT_CHANGE_RUNTIME_PARAM),
5825 errmsg("parameter \"%s\" cannot be changed without restarting the server",
5834 /* Save old value to support transaction abort */
5836 push_old_value(&conf->gen, action);
5838 if (conf->assign_hook)
5839 (*conf->assign_hook) (newval, newextra);
5840 *conf->variable = newval;
5841 set_extra_field(&conf->gen, &conf->gen.extra,
5843 conf->gen.source = source;
5844 conf->gen.scontext = context;
5850 if (conf->gen.reset_source <= source)
5852 conf->reset_val = newval;
5853 set_extra_field(&conf->gen, &conf->reset_extra,
5855 conf->gen.reset_source = source;
5856 conf->gen.reset_scontext = context;
5858 for (stack = conf->gen.stack; stack; stack = stack->prev)
5860 if (stack->source <= source)
5862 stack->prior.val.enumval = newval;
5863 set_extra_field(&conf->gen, &stack->prior.extra,
5865 stack->source = source;
5866 stack->scontext = context;
5871 /* Perhaps we didn't install newextra anywhere */
5872 if (newextra && !extra_field_used(&conf->gen, newextra))
5878 if (changeVal && (record->flags & GUC_REPORT))
5879 ReportGUCOption(record);
5881 return changeVal ? 1 : -1;
5886 * Set the fields for source file and line number the setting came from.
5889 set_config_sourcefile(const char *name, char *sourcefile, int sourceline)
5891 struct config_generic *record;
5895 * To avoid cluttering the log, only the postmaster bleats loudly about
5896 * problems with the config file.
5898 elevel = IsUnderPostmaster ? DEBUG3 : LOG;
5900 record = find_option(name, true, elevel);
5901 /* should not happen */
5903 elog(ERROR, "unrecognized configuration parameter \"%s\"", name);
5905 sourcefile = guc_strdup(elevel, sourcefile);
5906 if (record->sourcefile)
5907 free(record->sourcefile);
5908 record->sourcefile = sourcefile;
5909 record->sourceline = sourceline;
5913 * Set a config option to the given value.
5915 * See also set_config_option; this is just the wrapper to be called from
5916 * outside GUC. (This function should be used when possible, because its API
5917 * is more stable than set_config_option's.)
5919 * Note: there is no support here for setting source file/line, as it
5920 * is currently not needed.
5923 SetConfigOption(const char *name, const char *value,
5924 GucContext context, GucSource source)
5926 (void) set_config_option(name, value, context, source,
5927 GUC_ACTION_SET, true, 0);
5933 * Fetch the current value of the option `name', as a string.
5935 * If the option doesn't exist, return NULL if missing_ok is true (NOTE that
5936 * this cannot be distinguished from a string variable with a NULL value!),
5937 * otherwise throw an ereport and don't return.
5939 * If restrict_superuser is true, we also enforce that only superusers can
5940 * see GUC_SUPERUSER_ONLY variables. This should only be passed as true
5941 * in user-driven calls.
5943 * The string is *not* allocated for modification and is really only
5944 * valid until the next call to configuration related functions.
5947 GetConfigOption(const char *name, bool missing_ok, bool restrict_superuser)
5949 struct config_generic *record;
5950 static char buffer[256];
5952 record = find_option(name, false, ERROR);
5958 (errcode(ERRCODE_UNDEFINED_OBJECT),
5959 errmsg("unrecognized configuration parameter \"%s\"",
5962 if (restrict_superuser &&
5963 (record->flags & GUC_SUPERUSER_ONLY) &&
5966 (errcode(ERRCODE_INSUFFICIENT_PRIVILEGE),
5967 errmsg("must be superuser to examine \"%s\"", name)));
5969 switch (record->vartype)
5972 return *((struct config_bool *) record)->variable ? "on" : "off";
5975 snprintf(buffer, sizeof(buffer), "%d",
5976 *((struct config_int *) record)->variable);
5980 snprintf(buffer, sizeof(buffer), "%g",
5981 *((struct config_real *) record)->variable);
5985 return *((struct config_string *) record)->variable;
5988 return config_enum_lookup_by_value((struct config_enum *) record,
5989 *((struct config_enum *) record)->variable);
5995 * Get the RESET value associated with the given option.
5997 * Note: this is not re-entrant, due to use of static result buffer;
5998 * not to mention that a string variable could have its reset_val changed.
5999 * Beware of assuming the result value is good for very long.
6002 GetConfigOptionResetString(const char *name)
6004 struct config_generic *record;
6005 static char buffer[256];
6007 record = find_option(name, false, ERROR);
6010 (errcode(ERRCODE_UNDEFINED_OBJECT),
6011 errmsg("unrecognized configuration parameter \"%s\"", name)));
6012 if ((record->flags & GUC_SUPERUSER_ONLY) && !superuser())
6014 (errcode(ERRCODE_INSUFFICIENT_PRIVILEGE),
6015 errmsg("must be superuser to examine \"%s\"", name)));
6017 switch (record->vartype)
6020 return ((struct config_bool *) record)->reset_val ? "on" : "off";
6023 snprintf(buffer, sizeof(buffer), "%d",
6024 ((struct config_int *) record)->reset_val);
6028 snprintf(buffer, sizeof(buffer), "%g",
6029 ((struct config_real *) record)->reset_val);
6033 return ((struct config_string *) record)->reset_val;
6036 return config_enum_lookup_by_value((struct config_enum *) record,
6037 ((struct config_enum *) record)->reset_val);
6044 * flatten_set_variable_args
6045 * Given a parsenode List as emitted by the grammar for SET,
6046 * convert to the flat string representation used by GUC.
6048 * We need to be told the name of the variable the args are for, because
6049 * the flattening rules vary (ugh).
6051 * The result is NULL if args is NIL (ie, SET ... TO DEFAULT), otherwise
6052 * a palloc'd string.
6055 flatten_set_variable_args(const char *name, List *args)
6057 struct config_generic *record;
6062 /* Fast path if just DEFAULT */
6067 * Get flags for the variable; if it's not known, use default flags.
6068 * (Caller might throw error later, but not our business to do so here.)
6070 record = find_option(name, false, WARNING);
6072 flags = record->flags;
6076 /* Complain if list input and non-list variable */
6077 if ((flags & GUC_LIST_INPUT) == 0 &&
6078 list_length(args) != 1)
6080 (errcode(ERRCODE_INVALID_PARAMETER_VALUE),
6081 errmsg("SET %s takes only one argument", name)));
6083 initStringInfo(&buf);
6086 * Each list member may be a plain A_Const node, or an A_Const within a
6087 * TypeCast; the latter case is supported only for ConstInterval arguments
6088 * (for SET TIME ZONE).
6092 Node *arg = (Node *) lfirst(l);
6094 TypeName *typeName = NULL;
6097 if (l != list_head(args))
6098 appendStringInfo(&buf, ", ");
6100 if (IsA(arg, TypeCast))
6102 TypeCast *tc = (TypeCast *) arg;
6105 typeName = tc->typeName;
6108 if (!IsA(arg, A_Const))
6109 elog(ERROR, "unrecognized node type: %d", (int) nodeTag(arg));
6110 con = (A_Const *) arg;
6112 switch (nodeTag(&con->val))
6115 appendStringInfo(&buf, "%ld", intVal(&con->val));
6118 /* represented as a string, so just copy it */
6119 appendStringInfoString(&buf, strVal(&con->val));
6122 val = strVal(&con->val);
6123 if (typeName != NULL)
6126 * Must be a ConstInterval argument for TIME ZONE. Coerce
6127 * to interval and back to normalize the value and account
6135 typenameTypeIdAndMod(NULL, typeName, &typoid, &typmod);
6136 Assert(typoid == INTERVALOID);
6139 DirectFunctionCall3(interval_in,
6140 CStringGetDatum(val),
6141 ObjectIdGetDatum(InvalidOid),
6142 Int32GetDatum(typmod));
6145 DatumGetCString(DirectFunctionCall1(interval_out,
6147 appendStringInfo(&buf, "INTERVAL '%s'", intervalout);
6152 * Plain string literal or identifier. For quote mode,
6153 * quote it if it's not a vanilla identifier.
6155 if (flags & GUC_LIST_QUOTE)
6156 appendStringInfoString(&buf, quote_identifier(val));
6158 appendStringInfoString(&buf, val);
6162 elog(ERROR, "unrecognized node type: %d",
6163 (int) nodeTag(&con->val));
6176 ExecSetVariableStmt(VariableSetStmt *stmt)
6178 GucAction action = stmt->is_local ? GUC_ACTION_LOCAL : GUC_ACTION_SET;
6183 case VAR_SET_CURRENT:
6184 (void) set_config_option(stmt->name,
6185 ExtractSetVariableArgs(stmt),
6186 (superuser() ? PGC_SUSET : PGC_USERSET),
6195 * Special-case SQL syntaxes. The TRANSACTION and SESSION
6196 * CHARACTERISTICS cases effectively set more than one variable
6197 * per statement. TRANSACTION SNAPSHOT only takes one argument,
6198 * but we put it here anyway since it's a special case and not
6199 * related to any GUC variable.
6201 if (strcmp(stmt->name, "TRANSACTION") == 0)
6205 foreach(head, stmt->args)
6207 DefElem *item = (DefElem *) lfirst(head);
6209 if (strcmp(item->defname, "transaction_isolation") == 0)
6210 SetPGVariable("transaction_isolation",
6211 list_make1(item->arg), stmt->is_local);
6212 else if (strcmp(item->defname, "transaction_read_only") == 0)
6213 SetPGVariable("transaction_read_only",
6214 list_make1(item->arg), stmt->is_local);
6215 else if (strcmp(item->defname, "transaction_deferrable") == 0)
6216 SetPGVariable("transaction_deferrable",
6217 list_make1(item->arg), stmt->is_local);
6219 elog(ERROR, "unexpected SET TRANSACTION element: %s",
6223 else if (strcmp(stmt->name, "SESSION CHARACTERISTICS") == 0)
6227 foreach(head, stmt->args)
6229 DefElem *item = (DefElem *) lfirst(head);
6231 if (strcmp(item->defname, "transaction_isolation") == 0)
6232 SetPGVariable("default_transaction_isolation",
6233 list_make1(item->arg), stmt->is_local);
6234 else if (strcmp(item->defname, "transaction_read_only") == 0)
6235 SetPGVariable("default_transaction_read_only",
6236 list_make1(item->arg), stmt->is_local);
6237 else if (strcmp(item->defname, "transaction_deferrable") == 0)
6238 SetPGVariable("default_transaction_deferrable",
6239 list_make1(item->arg), stmt->is_local);
6241 elog(ERROR, "unexpected SET SESSION element: %s",
6245 else if (strcmp(stmt->name, "TRANSACTION SNAPSHOT") == 0)
6247 A_Const *con = (A_Const *) linitial(stmt->args);
6251 (errcode(ERRCODE_FEATURE_NOT_SUPPORTED),
6252 errmsg("SET LOCAL TRANSACTION SNAPSHOT is not implemented")));
6253 Assert(IsA(con, A_Const));
6254 Assert(nodeTag(&con->val) == T_String);
6255 ImportSnapshot(strVal(&con->val));
6258 elog(ERROR, "unexpected SET MULTI element: %s",
6261 case VAR_SET_DEFAULT:
6263 (void) set_config_option(stmt->name,
6265 (superuser() ? PGC_SUSET : PGC_USERSET),
6278 * Get the value to assign for a VariableSetStmt, or NULL if it's RESET.
6279 * The result is palloc'd.
6281 * This is exported for use by actions such as ALTER ROLE SET.
6284 ExtractSetVariableArgs(VariableSetStmt *stmt)
6289 return flatten_set_variable_args(stmt->name, stmt->args);
6290 case VAR_SET_CURRENT:
6291 return GetConfigOptionByName(stmt->name, NULL);
6298 * SetPGVariable - SET command exported as an easily-C-callable function.
6300 * This provides access to SET TO value, as well as SET TO DEFAULT (expressed
6301 * by passing args == NIL), but not SET FROM CURRENT functionality.
6304 SetPGVariable(const char *name, List *args, bool is_local)
6306 char *argstring = flatten_set_variable_args(name, args);
6308 /* Note SET DEFAULT (argstring == NULL) is equivalent to RESET */
6309 (void) set_config_option(name,
6311 (superuser() ? PGC_SUSET : PGC_USERSET),
6313 is_local ? GUC_ACTION_LOCAL : GUC_ACTION_SET,
6319 * SET command wrapped as a SQL callable function.
6322 set_config_by_name(PG_FUNCTION_ARGS)
6329 if (PG_ARGISNULL(0))
6331 (errcode(ERRCODE_NULL_VALUE_NOT_ALLOWED),
6332 errmsg("SET requires parameter name")));
6334 /* Get the GUC variable name */
6335 name = TextDatumGetCString(PG_GETARG_DATUM(0));
6337 /* Get the desired value or set to NULL for a reset request */
6338 if (PG_ARGISNULL(1))
6341 value = TextDatumGetCString(PG_GETARG_DATUM(1));
6344 * Get the desired state of is_local. Default to false if provided value
6347 if (PG_ARGISNULL(2))
6350 is_local = PG_GETARG_BOOL(2);
6352 /* Note SET DEFAULT (argstring == NULL) is equivalent to RESET */
6353 (void) set_config_option(name,
6355 (superuser() ? PGC_SUSET : PGC_USERSET),
6357 is_local ? GUC_ACTION_LOCAL : GUC_ACTION_SET,
6361 /* get the new current value */
6362 new_value = GetConfigOptionByName(name, NULL);
6364 /* Convert return string to text */
6365 PG_RETURN_TEXT_P(cstring_to_text(new_value));
6370 * Common code for DefineCustomXXXVariable subroutines: allocate the
6371 * new variable's config struct and fill in generic fields.
6373 static struct config_generic *
6374 init_custom_variable(const char *name,
6375 const char *short_desc,
6376 const char *long_desc,
6379 enum config_type type,
6382 struct config_generic *gen;
6385 * Only allow custom PGC_POSTMASTER variables to be created during shared
6386 * library preload; any later than that, we can't ensure that the value
6387 * doesn't change after startup. This is a fatal elog if it happens; just
6388 * erroring out isn't safe because we don't know what the calling loadable
6389 * module might already have hooked into.
6391 if (context == PGC_POSTMASTER &&
6392 !process_shared_preload_libraries_in_progress)
6393 elog(FATAL, "cannot create PGC_POSTMASTER variables after startup");
6395 gen = (struct config_generic *) guc_malloc(ERROR, sz);
6398 gen->name = guc_strdup(ERROR, name);
6399 gen->context = context;
6400 gen->group = CUSTOM_OPTIONS;
6401 gen->short_desc = short_desc;
6402 gen->long_desc = long_desc;
6404 gen->vartype = type;
6410 * Common code for DefineCustomXXXVariable subroutines: insert the new
6411 * variable into the GUC variable array, replacing any placeholder.
6414 define_custom_variable(struct config_generic * variable)
6416 const char *name = variable->name;
6417 const char **nameAddr = &name;
6418 struct config_string *pHolder;
6419 struct config_generic **res;
6422 * See if there's a placeholder by the same name.
6424 res = (struct config_generic **) bsearch((void *) &nameAddr,
6425 (void *) guc_variables,
6427 sizeof(struct config_generic *),
6432 * No placeholder to replace, so we can just add it ... but first,
6433 * make sure it's initialized to its default value.
6435 InitializeOneGUCOption(variable);
6436 add_guc_variable(variable, ERROR);
6441 * This better be a placeholder
6443 if (((*res)->flags & GUC_CUSTOM_PLACEHOLDER) == 0)
6445 (errcode(ERRCODE_INTERNAL_ERROR),
6446 errmsg("attempt to redefine parameter \"%s\"", name)));
6448 Assert((*res)->vartype == PGC_STRING);
6449 pHolder = (struct config_string *) (*res);
6452 * First, set the variable to its default value. We must do this even
6453 * though we intend to immediately apply a new value, since it's possible
6454 * that the new value is invalid.
6456 InitializeOneGUCOption(variable);
6459 * Replace the placeholder. We aren't changing the name, so no re-sorting
6465 * Assign the string value(s) stored in the placeholder to the real
6466 * variable. Essentially, we need to duplicate all the active and stacked
6467 * values, but with appropriate validation and datatype adjustment.
6469 * If an assignment fails, we report a WARNING and keep going. We don't
6470 * want to throw ERROR for bad values, because it'd bollix the add-on
6471 * module that's presumably halfway through getting loaded. In such cases
6472 * the default or previous state will become active instead.
6475 /* First, apply the reset value if any */
6476 if (pHolder->reset_val)
6477 (void) set_config_option(name, pHolder->reset_val,
6478 pHolder->gen.reset_scontext,
6479 pHolder->gen.reset_source,
6480 GUC_ACTION_SET, true, WARNING);
6481 /* That should not have resulted in stacking anything */
6482 Assert(variable->stack == NULL);
6484 /* Now, apply current and stacked values, in the order they were stacked */
6485 reapply_stacked_values(variable, pHolder, pHolder->gen.stack,
6486 *(pHolder->variable),
6487 pHolder->gen.scontext, pHolder->gen.source);
6489 /* Also copy over any saved source-location information */
6490 if (pHolder->gen.sourcefile)
6491 set_config_sourcefile(name, pHolder->gen.sourcefile,
6492 pHolder->gen.sourceline);
6495 * Free up as much as we conveniently can of the placeholder structure.
6496 * (This neglects any stack items, so it's possible for some memory to be
6497 * leaked. Since this can only happen once per session per variable, it
6498 * doesn't seem worth spending much code on.)
6500 set_string_field(pHolder, pHolder->variable, NULL);
6501 set_string_field(pHolder, &pHolder->reset_val, NULL);
6507 * Recursive subroutine for define_custom_variable: reapply non-reset values
6509 * We recurse so that the values are applied in the same order as originally.
6510 * At each recursion level, apply the upper-level value (passed in) in the
6511 * fashion implied by the stack entry.
6514 reapply_stacked_values(struct config_generic * variable,
6515 struct config_string * pHolder,
6517 const char *curvalue,
6518 GucContext curscontext, GucSource cursource)
6520 const char *name = variable->name;
6521 GucStack *oldvarstack = variable->stack;
6525 /* First, recurse, so that stack items are processed bottom to top */
6526 reapply_stacked_values(variable, pHolder, stack->prev,
6527 stack->prior.val.stringval,
6528 stack->scontext, stack->source);
6530 /* See how to apply the passed-in value */
6531 switch (stack->state)
6534 (void) set_config_option(name, curvalue,
6535 curscontext, cursource,
6536 GUC_ACTION_SAVE, true, WARNING);
6540 (void) set_config_option(name, curvalue,
6541 curscontext, cursource,
6542 GUC_ACTION_SET, true, WARNING);
6546 (void) set_config_option(name, curvalue,
6547 curscontext, cursource,
6548 GUC_ACTION_LOCAL, true, WARNING);
6552 /* first, apply the masked value as SET */
6553 (void) set_config_option(name, stack->masked.val.stringval,
6554 stack->masked_scontext, PGC_S_SESSION,
6555 GUC_ACTION_SET, true, WARNING);
6556 /* then apply the current value as LOCAL */
6557 (void) set_config_option(name, curvalue,
6558 curscontext, cursource,
6559 GUC_ACTION_LOCAL, true, WARNING);
6563 /* If we successfully made a stack entry, adjust its nest level */
6564 if (variable->stack != oldvarstack)
6565 variable->stack->nest_level = stack->nest_level;
6570 * We are at the end of the stack. If the active/previous value is
6571 * different from the reset value, it must represent a previously
6572 * committed session value. Apply it, and then drop the stack entry
6573 * that set_config_option will have created under the impression that
6574 * this is to be just a transactional assignment. (We leak the stack
6577 if (curvalue != pHolder->reset_val ||
6578 curscontext != pHolder->gen.reset_scontext ||
6579 cursource != pHolder->gen.reset_source)
6581 (void) set_config_option(name, curvalue,
6582 curscontext, cursource,
6583 GUC_ACTION_SET, true, WARNING);
6584 variable->stack = NULL;
6590 DefineCustomBoolVariable(const char *name,
6591 const char *short_desc,
6592 const char *long_desc,
6597 GucBoolCheckHook check_hook,
6598 GucBoolAssignHook assign_hook,
6599 GucShowHook show_hook)
6601 struct config_bool *var;
6603 var = (struct config_bool *)
6604 init_custom_variable(name, short_desc, long_desc, context, flags,
6605 PGC_BOOL, sizeof(struct config_bool));
6606 var->variable = valueAddr;
6607 var->boot_val = bootValue;
6608 var->reset_val = bootValue;
6609 var->check_hook = check_hook;
6610 var->assign_hook = assign_hook;
6611 var->show_hook = show_hook;
6612 define_custom_variable(&var->gen);
6616 DefineCustomIntVariable(const char *name,
6617 const char *short_desc,
6618 const char *long_desc,
6625 GucIntCheckHook check_hook,
6626 GucIntAssignHook assign_hook,
6627 GucShowHook show_hook)
6629 struct config_int *var;
6631 var = (struct config_int *)
6632 init_custom_variable(name, short_desc, long_desc, context, flags,
6633 PGC_INT, sizeof(struct config_int));
6634 var->variable = valueAddr;
6635 var->boot_val = bootValue;
6636 var->reset_val = bootValue;
6637 var->min = minValue;
6638 var->max = maxValue;
6639 var->check_hook = check_hook;
6640 var->assign_hook = assign_hook;
6641 var->show_hook = show_hook;
6642 define_custom_variable(&var->gen);
6646 DefineCustomRealVariable(const char *name,
6647 const char *short_desc,
6648 const char *long_desc,
6655 GucRealCheckHook check_hook,
6656 GucRealAssignHook assign_hook,
6657 GucShowHook show_hook)
6659 struct config_real *var;
6661 var = (struct config_real *)
6662 init_custom_variable(name, short_desc, long_desc, context, flags,
6663 PGC_REAL, sizeof(struct config_real));
6664 var->variable = valueAddr;
6665 var->boot_val = bootValue;
6666 var->reset_val = bootValue;
6667 var->min = minValue;
6668 var->max = maxValue;
6669 var->check_hook = check_hook;
6670 var->assign_hook = assign_hook;
6671 var->show_hook = show_hook;
6672 define_custom_variable(&var->gen);
6676 DefineCustomStringVariable(const char *name,
6677 const char *short_desc,
6678 const char *long_desc,
6680 const char *bootValue,
6683 GucStringCheckHook check_hook,
6684 GucStringAssignHook assign_hook,
6685 GucShowHook show_hook)
6687 struct config_string *var;
6689 var = (struct config_string *)
6690 init_custom_variable(name, short_desc, long_desc, context, flags,
6691 PGC_STRING, sizeof(struct config_string));
6692 var->variable = valueAddr;
6693 var->boot_val = bootValue;
6694 var->check_hook = check_hook;
6695 var->assign_hook = assign_hook;
6696 var->show_hook = show_hook;
6697 define_custom_variable(&var->gen);
6701 DefineCustomEnumVariable(const char *name,
6702 const char *short_desc,
6703 const char *long_desc,
6706 const struct config_enum_entry * options,
6709 GucEnumCheckHook check_hook,
6710 GucEnumAssignHook assign_hook,
6711 GucShowHook show_hook)
6713 struct config_enum *var;
6715 var = (struct config_enum *)
6716 init_custom_variable(name, short_desc, long_desc, context, flags,
6717 PGC_ENUM, sizeof(struct config_enum));
6718 var->variable = valueAddr;
6719 var->boot_val = bootValue;
6720 var->reset_val = bootValue;
6721 var->options = options;
6722 var->check_hook = check_hook;
6723 var->assign_hook = assign_hook;
6724 var->show_hook = show_hook;
6725 define_custom_variable(&var->gen);
6729 EmitWarningsOnPlaceholders(const char *className)
6731 int classLen = strlen(className);
6734 for (i = 0; i < num_guc_variables; i++)
6736 struct config_generic *var = guc_variables[i];
6738 if ((var->flags & GUC_CUSTOM_PLACEHOLDER) != 0 &&
6739 strncmp(className, var->name, classLen) == 0 &&
6740 var->name[classLen] == GUC_QUALIFIER_SEPARATOR)
6743 (errcode(ERRCODE_UNDEFINED_OBJECT),
6744 errmsg("unrecognized configuration parameter \"%s\"",
6755 GetPGVariable(const char *name, DestReceiver *dest)
6757 if (guc_name_compare(name, "all") == 0)
6758 ShowAllGUCConfig(dest);
6760 ShowGUCConfigOption(name, dest);
6764 GetPGVariableResultDesc(const char *name)
6768 if (guc_name_compare(name, "all") == 0)
6770 /* need a tuple descriptor representing three TEXT columns */
6771 tupdesc = CreateTemplateTupleDesc(3, false);
6772 TupleDescInitEntry(tupdesc, (AttrNumber) 1, "name",
6774 TupleDescInitEntry(tupdesc, (AttrNumber) 2, "setting",
6776 TupleDescInitEntry(tupdesc, (AttrNumber) 3, "description",
6781 const char *varname;
6783 /* Get the canonical spelling of name */
6784 (void) GetConfigOptionByName(name, &varname);
6786 /* need a tuple descriptor representing a single TEXT column */
6787 tupdesc = CreateTemplateTupleDesc(1, false);
6788 TupleDescInitEntry(tupdesc, (AttrNumber) 1, varname,
6799 ShowGUCConfigOption(const char *name, DestReceiver *dest)
6801 TupOutputState *tstate;
6803 const char *varname;
6806 /* Get the value and canonical spelling of name */
6807 value = GetConfigOptionByName(name, &varname);
6809 /* need a tuple descriptor representing a single TEXT column */
6810 tupdesc = CreateTemplateTupleDesc(1, false);
6811 TupleDescInitEntry(tupdesc, (AttrNumber) 1, varname,
6814 /* prepare for projection of tuples */
6815 tstate = begin_tup_output_tupdesc(dest, tupdesc);
6818 do_text_output_oneline(tstate, value);
6820 end_tup_output(tstate);
6827 ShowAllGUCConfig(DestReceiver *dest)
6829 bool am_superuser = superuser();
6831 TupOutputState *tstate;
6834 bool isnull[3] = {false, false, false};
6836 /* need a tuple descriptor representing three TEXT columns */
6837 tupdesc = CreateTemplateTupleDesc(3, false);
6838 TupleDescInitEntry(tupdesc, (AttrNumber) 1, "name",
6840 TupleDescInitEntry(tupdesc, (AttrNumber) 2, "setting",
6842 TupleDescInitEntry(tupdesc, (AttrNumber) 3, "description",
6845 /* prepare for projection of tuples */
6846 tstate = begin_tup_output_tupdesc(dest, tupdesc);
6848 for (i = 0; i < num_guc_variables; i++)
6850 struct config_generic *conf = guc_variables[i];
6853 if ((conf->flags & GUC_NO_SHOW_ALL) ||
6854 ((conf->flags & GUC_SUPERUSER_ONLY) && !am_superuser))
6857 /* assign to the values array */
6858 values[0] = PointerGetDatum(cstring_to_text(conf->name));
6860 setting = _ShowOption(conf, true);
6863 values[1] = PointerGetDatum(cstring_to_text(setting));
6868 values[1] = PointerGetDatum(NULL);
6872 values[2] = PointerGetDatum(cstring_to_text(conf->short_desc));
6874 /* send it to dest */
6875 do_tup_output(tstate, values, isnull);
6878 pfree(DatumGetPointer(values[0]));
6882 pfree(DatumGetPointer(values[1]));
6884 pfree(DatumGetPointer(values[2]));
6887 end_tup_output(tstate);
6891 * Return GUC variable value by name; optionally return canonical
6892 * form of name. Return value is palloc'd.
6895 GetConfigOptionByName(const char *name, const char **varname)
6897 struct config_generic *record;
6899 record = find_option(name, false, ERROR);
6902 (errcode(ERRCODE_UNDEFINED_OBJECT),
6903 errmsg("unrecognized configuration parameter \"%s\"", name)));
6904 if ((record->flags & GUC_SUPERUSER_ONLY) && !superuser())
6906 (errcode(ERRCODE_INSUFFICIENT_PRIVILEGE),
6907 errmsg("must be superuser to examine \"%s\"", name)));
6910 *varname = record->name;
6912 return _ShowOption(record, true);
6916 * Return GUC variable value by variable number; optionally return canonical
6917 * form of name. Return value is palloc'd.
6920 GetConfigOptionByNum(int varnum, const char **values, bool *noshow)
6923 struct config_generic *conf;
6925 /* check requested variable number valid */
6926 Assert((varnum >= 0) && (varnum < num_guc_variables));
6928 conf = guc_variables[varnum];
6932 if ((conf->flags & GUC_NO_SHOW_ALL) ||
6933 ((conf->flags & GUC_SUPERUSER_ONLY) && !superuser()))
6939 /* first get the generic attributes */
6942 values[0] = conf->name;
6944 /* setting : use _ShowOption in order to avoid duplicating the logic */
6945 values[1] = _ShowOption(conf, false);
6948 if (conf->vartype == PGC_INT)
6952 switch (conf->flags & (GUC_UNIT_MEMORY | GUC_UNIT_TIME))
6957 case GUC_UNIT_BLOCKS:
6958 snprintf(buf, sizeof(buf), "%dkB", BLCKSZ / 1024);
6961 case GUC_UNIT_XBLOCKS:
6962 snprintf(buf, sizeof(buf), "%dkB", XLOG_BLCKSZ / 1024);
6983 values[3] = config_group_names[conf->group];
6986 values[4] = conf->short_desc;
6989 values[5] = conf->long_desc;
6992 values[6] = GucContext_Names[conf->context];
6995 values[7] = config_type_names[conf->vartype];
6998 values[8] = GucSource_Names[conf->source];
7000 /* now get the type specifc attributes */
7001 switch (conf->vartype)
7005 struct config_bool *lconf = (struct config_bool *) conf;
7017 values[12] = pstrdup(lconf->boot_val ? "on" : "off");
7020 values[13] = pstrdup(lconf->reset_val ? "on" : "off");
7026 struct config_int *lconf = (struct config_int *) conf;
7029 snprintf(buffer, sizeof(buffer), "%d", lconf->min);
7030 values[9] = pstrdup(buffer);
7033 snprintf(buffer, sizeof(buffer), "%d", lconf->max);
7034 values[10] = pstrdup(buffer);
7040 snprintf(buffer, sizeof(buffer), "%d", lconf->boot_val);
7041 values[12] = pstrdup(buffer);
7044 snprintf(buffer, sizeof(buffer), "%d", lconf->reset_val);
7045 values[13] = pstrdup(buffer);
7051 struct config_real *lconf = (struct config_real *) conf;
7054 snprintf(buffer, sizeof(buffer), "%g", lconf->min);
7055 values[9] = pstrdup(buffer);
7058 snprintf(buffer, sizeof(buffer), "%g", lconf->max);
7059 values[10] = pstrdup(buffer);
7065 snprintf(buffer, sizeof(buffer), "%g", lconf->boot_val);
7066 values[12] = pstrdup(buffer);
7069 snprintf(buffer, sizeof(buffer), "%g", lconf->reset_val);
7070 values[13] = pstrdup(buffer);
7076 struct config_string *lconf = (struct config_string *) conf;
7088 if (lconf->boot_val == NULL)
7091 values[12] = pstrdup(lconf->boot_val);
7094 if (lconf->reset_val == NULL)
7097 values[13] = pstrdup(lconf->reset_val);
7103 struct config_enum *lconf = (struct config_enum *) conf;
7114 * NOTE! enumvals with double quotes in them are not
7117 values[11] = config_enum_get_options((struct config_enum *) conf,
7118 "{\"", "\"}", "\",\"");
7121 values[12] = pstrdup(config_enum_lookup_by_value(lconf,
7125 values[13] = pstrdup(config_enum_lookup_by_value(lconf,
7133 * should never get here, but in case we do, set 'em to NULL
7155 * If the setting came from a config file, set the source location. For
7156 * security reasons, we don't show source file/line number for
7159 if (conf->source == PGC_S_FILE && superuser())
7161 values[14] = conf->sourcefile;
7162 snprintf(buffer, sizeof(buffer), "%d", conf->sourceline);
7163 values[15] = pstrdup(buffer);
7173 * Return the total number of GUC variables
7176 GetNumConfigOptions(void)
7178 return num_guc_variables;
7182 * show_config_by_name - equiv to SHOW X command but implemented as
7186 show_config_by_name(PG_FUNCTION_ARGS)
7191 /* Get the GUC variable name */
7192 varname = TextDatumGetCString(PG_GETARG_DATUM(0));
7195 varval = GetConfigOptionByName(varname, NULL);
7197 /* Convert to text */
7198 PG_RETURN_TEXT_P(cstring_to_text(varval));
7202 * show_all_settings - equiv to SHOW ALL command but implemented as
7205 #define NUM_PG_SETTINGS_ATTS 16
7208 show_all_settings(PG_FUNCTION_ARGS)
7210 FuncCallContext *funcctx;
7214 AttInMetadata *attinmeta;
7215 MemoryContext oldcontext;
7217 /* stuff done only on the first call of the function */
7218 if (SRF_IS_FIRSTCALL())
7220 /* create a function context for cross-call persistence */
7221 funcctx = SRF_FIRSTCALL_INIT();
7224 * switch to memory context appropriate for multiple function calls
7226 oldcontext = MemoryContextSwitchTo(funcctx->multi_call_memory_ctx);
7229 * need a tuple descriptor representing NUM_PG_SETTINGS_ATTS columns
7230 * of the appropriate types
7232 tupdesc = CreateTemplateTupleDesc(NUM_PG_SETTINGS_ATTS, false);
7233 TupleDescInitEntry(tupdesc, (AttrNumber) 1, "name",
7235 TupleDescInitEntry(tupdesc, (AttrNumber) 2, "setting",
7237 TupleDescInitEntry(tupdesc, (AttrNumber) 3, "unit",
7239 TupleDescInitEntry(tupdesc, (AttrNumber) 4, "category",
7241 TupleDescInitEntry(tupdesc, (AttrNumber) 5, "short_desc",
7243 TupleDescInitEntry(tupdesc, (AttrNumber) 6, "extra_desc",
7245 TupleDescInitEntry(tupdesc, (AttrNumber) 7, "context",
7247 TupleDescInitEntry(tupdesc, (AttrNumber) 8, "vartype",
7249 TupleDescInitEntry(tupdesc, (AttrNumber) 9, "source",
7251 TupleDescInitEntry(tupdesc, (AttrNumber) 10, "min_val",
7253 TupleDescInitEntry(tupdesc, (AttrNumber) 11, "max_val",
7255 TupleDescInitEntry(tupdesc, (AttrNumber) 12, "enumvals",
7256 TEXTARRAYOID, -1, 0);
7257 TupleDescInitEntry(tupdesc, (AttrNumber) 13, "boot_val",
7259 TupleDescInitEntry(tupdesc, (AttrNumber) 14, "reset_val",
7261 TupleDescInitEntry(tupdesc, (AttrNumber) 15, "sourcefile",
7263 TupleDescInitEntry(tupdesc, (AttrNumber) 16, "sourceline",
7267 * Generate attribute metadata needed later to produce tuples from raw
7270 attinmeta = TupleDescGetAttInMetadata(tupdesc);
7271 funcctx->attinmeta = attinmeta;
7273 /* total number of tuples to be returned */
7274 funcctx->max_calls = GetNumConfigOptions();
7276 MemoryContextSwitchTo(oldcontext);
7279 /* stuff done on every call of the function */
7280 funcctx = SRF_PERCALL_SETUP();
7282 call_cntr = funcctx->call_cntr;
7283 max_calls = funcctx->max_calls;
7284 attinmeta = funcctx->attinmeta;
7286 if (call_cntr < max_calls) /* do when there is more left to send */
7288 char *values[NUM_PG_SETTINGS_ATTS];
7294 * Get the next visible GUC variable name and value
7298 GetConfigOptionByNum(call_cntr, (const char **) values, &noshow);
7301 /* bump the counter and get the next config setting */
7302 call_cntr = ++funcctx->call_cntr;
7304 /* make sure we haven't gone too far now */
7305 if (call_cntr >= max_calls)
7306 SRF_RETURN_DONE(funcctx);
7311 tuple = BuildTupleFromCStrings(attinmeta, values);
7313 /* make the tuple into a datum */
7314 result = HeapTupleGetDatum(tuple);
7316 SRF_RETURN_NEXT(funcctx, result);
7320 /* do when there is no more left */
7321 SRF_RETURN_DONE(funcctx);
7326 _ShowOption(struct config_generic * record, bool use_units)
7331 switch (record->vartype)
7335 struct config_bool *conf = (struct config_bool *) record;
7337 if (conf->show_hook)
7338 val = (*conf->show_hook) ();
7340 val = *conf->variable ? "on" : "off";
7346 struct config_int *conf = (struct config_int *) record;
7348 if (conf->show_hook)
7349 val = (*conf->show_hook) ();
7353 * Use int64 arithmetic to avoid overflows in units
7356 int64 result = *conf->variable;
7359 if (use_units && result > 0 &&
7360 (record->flags & GUC_UNIT_MEMORY))
7362 switch (record->flags & GUC_UNIT_MEMORY)
7364 case GUC_UNIT_BLOCKS:
7365 result *= BLCKSZ / 1024;
7367 case GUC_UNIT_XBLOCKS:
7368 result *= XLOG_BLCKSZ / 1024;
7372 if (result % KB_PER_GB == 0)
7374 result /= KB_PER_GB;
7377 else if (result % KB_PER_MB == 0)
7379 result /= KB_PER_MB;
7387 else if (use_units && result > 0 &&
7388 (record->flags & GUC_UNIT_TIME))
7390 switch (record->flags & GUC_UNIT_TIME)
7396 result *= MS_PER_MIN;
7400 if (result % MS_PER_D == 0)
7405 else if (result % MS_PER_H == 0)
7410 else if (result % MS_PER_MIN == 0)
7412 result /= MS_PER_MIN;
7415 else if (result % MS_PER_S == 0)
7428 snprintf(buffer, sizeof(buffer), INT64_FORMAT "%s",
7437 struct config_real *conf = (struct config_real *) record;
7439 if (conf->show_hook)
7440 val = (*conf->show_hook) ();
7443 snprintf(buffer, sizeof(buffer), "%g",
7452 struct config_string *conf = (struct config_string *) record;
7454 if (conf->show_hook)
7455 val = (*conf->show_hook) ();
7456 else if (*conf->variable && **conf->variable)
7457 val = *conf->variable;
7465 struct config_enum *conf = (struct config_enum *) record;
7467 if (conf->show_hook)
7468 val = (*conf->show_hook) ();
7470 val = config_enum_lookup_by_value(conf, *conf->variable);
7475 /* just to keep compiler quiet */
7480 return pstrdup(val);
7487 * These routines dump out all non-default GUC options into a binary
7488 * file that is read by all exec'ed backends. The format is:
7490 * variable name, string, null terminated
7491 * variable value, string, null terminated
7492 * variable sourcefile, string, null terminated (empty if none)
7493 * variable sourceline, integer
7494 * variable source, integer
7495 * variable scontext, integer
7498 write_one_nondefault_variable(FILE *fp, struct config_generic * gconf)
7500 if (gconf->source == PGC_S_DEFAULT)
7503 fprintf(fp, "%s", gconf->name);
7506 switch (gconf->vartype)
7510 struct config_bool *conf = (struct config_bool *) gconf;
7512 if (*conf->variable)
7513 fprintf(fp, "true");
7515 fprintf(fp, "false");
7521 struct config_int *conf = (struct config_int *) gconf;
7523 fprintf(fp, "%d", *conf->variable);
7529 struct config_real *conf = (struct config_real *) gconf;
7531 fprintf(fp, "%.17g", *conf->variable);
7537 struct config_string *conf = (struct config_string *) gconf;
7539 fprintf(fp, "%s", *conf->variable);
7545 struct config_enum *conf = (struct config_enum *) gconf;
7548 config_enum_lookup_by_value(conf, *conf->variable));
7555 if (gconf->sourcefile)
7556 fprintf(fp, "%s", gconf->sourcefile);
7559 fwrite(&gconf->sourceline, 1, sizeof(gconf->sourceline), fp);
7560 fwrite(&gconf->source, 1, sizeof(gconf->source), fp);
7561 fwrite(&gconf->scontext, 1, sizeof(gconf->scontext), fp);
7565 write_nondefault_variables(GucContext context)
7571 Assert(context == PGC_POSTMASTER || context == PGC_SIGHUP);
7573 elevel = (context == PGC_SIGHUP) ? LOG : ERROR;
7578 fp = AllocateFile(CONFIG_EXEC_PARAMS_NEW, "w");
7582 (errcode_for_file_access(),
7583 errmsg("could not write to file \"%s\": %m",
7584 CONFIG_EXEC_PARAMS_NEW)));
7588 for (i = 0; i < num_guc_variables; i++)
7590 write_one_nondefault_variable(fp, guc_variables[i]);
7596 (errcode_for_file_access(),
7597 errmsg("could not write to file \"%s\": %m",
7598 CONFIG_EXEC_PARAMS_NEW)));
7603 * Put new file in place. This could delay on Win32, but we don't hold
7604 * any exclusive locks.
7606 rename(CONFIG_EXEC_PARAMS_NEW, CONFIG_EXEC_PARAMS);
7611 * Read string, including null byte from file
7613 * Return NULL on EOF and nothing read
7616 read_string_with_null(FILE *fp)
7625 if ((ch = fgetc(fp)) == EOF)
7630 elog(FATAL, "invalid format of exec config params file");
7633 str = guc_malloc(FATAL, maxlen);
7634 else if (i == maxlen)
7635 str = guc_realloc(FATAL, str, maxlen *= 2);
7644 * This routine loads a previous postmaster dump of its non-default
7648 read_nondefault_variables(void)
7655 GucSource varsource;
7656 GucContext varscontext;
7661 fp = AllocateFile(CONFIG_EXEC_PARAMS, "r");
7664 /* File not found is fine */
7665 if (errno != ENOENT)
7667 (errcode_for_file_access(),
7668 errmsg("could not read from file \"%s\": %m",
7669 CONFIG_EXEC_PARAMS)));
7675 struct config_generic *record;
7677 if ((varname = read_string_with_null(fp)) == NULL)
7680 if ((record = find_option(varname, true, FATAL)) == NULL)
7681 elog(FATAL, "failed to locate variable \"%s\" in exec config params file", varname);
7683 if ((varvalue = read_string_with_null(fp)) == NULL)
7684 elog(FATAL, "invalid format of exec config params file");
7685 if ((varsourcefile = read_string_with_null(fp)) == NULL)
7686 elog(FATAL, "invalid format of exec config params file");
7687 if (fread(&varsourceline, 1, sizeof(varsourceline), fp) != sizeof(varsourceline))
7688 elog(FATAL, "invalid format of exec config params file");
7689 if (fread(&varsource, 1, sizeof(varsource), fp) != sizeof(varsource))
7690 elog(FATAL, "invalid format of exec config params file");
7691 if (fread(&varscontext, 1, sizeof(varscontext), fp) != sizeof(varscontext))
7692 elog(FATAL, "invalid format of exec config params file");
7694 (void) set_config_option(varname, varvalue,
7695 varscontext, varsource,
7696 GUC_ACTION_SET, true, 0);
7697 if (varsourcefile[0])
7698 set_config_sourcefile(varname, varsourcefile, varsourceline);
7702 free(varsourcefile);
7707 #endif /* EXEC_BACKEND */
7711 * A little "long argument" simulation, although not quite GNU
7712 * compliant. Takes a string of the form "some-option=some value" and
7713 * returns name = "some_option" and value = "some value" in malloc'ed
7714 * storage. Note that '-' is converted to '_' in the option name. If
7715 * there is no '=' in the input string then value will be NULL.
7718 ParseLongOption(const char *string, char **name, char **value)
7727 equal_pos = strcspn(string, "=");
7729 if (string[equal_pos] == '=')
7731 *name = guc_malloc(FATAL, equal_pos + 1);
7732 strlcpy(*name, string, equal_pos + 1);
7734 *value = guc_strdup(FATAL, &string[equal_pos + 1]);
7738 /* no equal sign in string */
7739 *name = guc_strdup(FATAL, string);
7743 for (cp = *name; *cp; cp++)
7750 * Handle options fetched from pg_db_role_setting.setconfig,
7751 * pg_proc.proconfig, etc. Caller must specify proper context/source/action.
7753 * The array parameter must be an array of TEXT (it must not be NULL).
7756 ProcessGUCArray(ArrayType *array,
7757 GucContext context, GucSource source, GucAction action)
7761 Assert(array != NULL);
7762 Assert(ARR_ELEMTYPE(array) == TEXTOID);
7763 Assert(ARR_NDIM(array) == 1);
7764 Assert(ARR_LBOUND(array)[0] == 1);
7766 for (i = 1; i <= ARR_DIMS(array)[0]; i++)
7774 d = array_ref(array, 1, &i,
7775 -1 /* varlenarray */ ,
7776 -1 /* TEXT's typlen */ ,
7777 false /* TEXT's typbyval */ ,
7778 'i' /* TEXT's typalign */ ,
7784 s = TextDatumGetCString(d);
7786 ParseLongOption(s, &name, &value);
7790 (errcode(ERRCODE_SYNTAX_ERROR),
7791 errmsg("could not parse setting for parameter \"%s\"",
7797 (void) set_config_option(name, value,
7810 * Add an entry to an option array. The array parameter may be NULL
7811 * to indicate the current table entry is NULL.
7814 GUCArrayAdd(ArrayType *array, const char *name, const char *value)
7816 struct config_generic *record;
7824 /* test if the option is valid and we're allowed to set it */
7825 (void) validate_option_array_item(name, value, false);
7827 /* normalize name (converts obsolete GUC names to modern spellings) */
7828 record = find_option(name, false, WARNING);
7830 name = record->name;
7832 /* build new item for array */
7833 newval = palloc(strlen(name) + 1 + strlen(value) + 1);
7834 sprintf(newval, "%s=%s", name, value);
7835 datum = CStringGetTextDatum(newval);
7843 Assert(ARR_ELEMTYPE(array) == TEXTOID);
7844 Assert(ARR_NDIM(array) == 1);
7845 Assert(ARR_LBOUND(array)[0] == 1);
7847 index = ARR_DIMS(array)[0] + 1; /* add after end */
7849 for (i = 1; i <= ARR_DIMS(array)[0]; i++)
7854 d = array_ref(array, 1, &i,
7855 -1 /* varlenarray */ ,
7856 -1 /* TEXT's typlen */ ,
7857 false /* TEXT's typbyval */ ,
7858 'i' /* TEXT's typalign */ ,
7862 current = TextDatumGetCString(d);
7864 /* check for match up through and including '=' */
7865 if (strncmp(current, newval, strlen(name) + 1) == 0)
7872 a = array_set(array, 1, &index,
7875 -1 /* varlena array */ ,
7876 -1 /* TEXT's typlen */ ,
7877 false /* TEXT's typbyval */ ,
7878 'i' /* TEXT's typalign */ );
7881 a = construct_array(&datum, 1,
7890 * Delete an entry from an option array. The array parameter may be NULL
7891 * to indicate the current table entry is NULL. Also, if the return value
7892 * is NULL then a null should be stored.
7895 GUCArrayDelete(ArrayType *array, const char *name)
7897 struct config_generic *record;
7898 ArrayType *newarray;
7904 /* test if the option is valid and we're allowed to set it */
7905 (void) validate_option_array_item(name, NULL, false);
7907 /* normalize name (converts obsolete GUC names to modern spellings) */
7908 record = find_option(name, false, WARNING);
7910 name = record->name;
7912 /* if array is currently null, then surely nothing to delete */
7919 for (i = 1; i <= ARR_DIMS(array)[0]; i++)
7925 d = array_ref(array, 1, &i,
7926 -1 /* varlenarray */ ,
7927 -1 /* TEXT's typlen */ ,
7928 false /* TEXT's typbyval */ ,
7929 'i' /* TEXT's typalign */ ,
7933 val = TextDatumGetCString(d);
7935 /* ignore entry if it's what we want to delete */
7936 if (strncmp(val, name, strlen(name)) == 0
7937 && val[strlen(name)] == '=')
7940 /* else add it to the output array */
7942 newarray = array_set(newarray, 1, &index,
7945 -1 /* varlenarray */ ,
7946 -1 /* TEXT's typlen */ ,
7947 false /* TEXT's typbyval */ ,
7948 'i' /* TEXT's typalign */ );
7950 newarray = construct_array(&d, 1,
7962 * Given a GUC array, delete all settings from it that our permission
7963 * level allows: if superuser, delete them all; if regular user, only
7964 * those that are PGC_USERSET
7967 GUCArrayReset(ArrayType *array)
7969 ArrayType *newarray;
7973 /* if array is currently null, nothing to do */
7977 /* if we're superuser, we can delete everything, so just do it */
7984 for (i = 1; i <= ARR_DIMS(array)[0]; i++)
7991 d = array_ref(array, 1, &i,
7992 -1 /* varlenarray */ ,
7993 -1 /* TEXT's typlen */ ,
7994 false /* TEXT's typbyval */ ,
7995 'i' /* TEXT's typalign */ ,
7999 val = TextDatumGetCString(d);
8001 eqsgn = strchr(val, '=');
8004 /* skip if we have permission to delete it */
8005 if (validate_option_array_item(val, NULL, true))
8008 /* else add it to the output array */
8010 newarray = array_set(newarray, 1, &index,
8013 -1 /* varlenarray */ ,
8014 -1 /* TEXT's typlen */ ,
8015 false /* TEXT's typbyval */ ,
8016 'i' /* TEXT's typalign */ );
8018 newarray = construct_array(&d, 1,
8030 * Validate a proposed option setting for GUCArrayAdd/Delete/Reset.
8032 * name is the option name. value is the proposed value for the Add case,
8033 * or NULL for the Delete/Reset cases. If skipIfNoPermissions is true, it's
8034 * not an error to have no permissions to set the option.
8036 * Returns TRUE if OK, FALSE if skipIfNoPermissions is true and user does not
8037 * have permission to change this option (all other error cases result in an
8038 * error being thrown).
8041 validate_option_array_item(const char *name, const char *value,
8042 bool skipIfNoPermissions)
8045 struct config_generic *gconf;
8048 * There are three cases to consider:
8050 * name is a known GUC variable. Check the value normally, check
8051 * permissions normally (ie, allow if variable is USERSET, or if it's
8052 * SUSET and user is superuser).
8054 * name is not known, but exists or can be created as a placeholder (i.e.,
8055 * it has a prefixed name). We allow this case if you're a superuser,
8056 * otherwise not. Superusers are assumed to know what they're doing. We
8057 * can't allow it for other users, because when the placeholder is
8058 * resolved it might turn out to be a SUSET variable;
8059 * define_custom_variable assumes we checked that.
8061 * name is not known and can't be created as a placeholder. Throw error,
8062 * unless skipIfNoPermissions is true, in which case return FALSE.
8064 gconf = find_option(name, true, WARNING);
8067 /* not known, failed to make a placeholder */
8068 if (skipIfNoPermissions)
8071 (errcode(ERRCODE_UNDEFINED_OBJECT),
8072 errmsg("unrecognized configuration parameter \"%s\"",
8076 if (gconf->flags & GUC_CUSTOM_PLACEHOLDER)
8079 * We cannot do any meaningful check on the value, so only permissions
8080 * are useful to check.
8084 if (skipIfNoPermissions)
8087 (errcode(ERRCODE_INSUFFICIENT_PRIVILEGE),
8088 errmsg("permission denied to set parameter \"%s\"", name)));
8091 /* manual permissions check so we can avoid an error being thrown */
8092 if (gconf->context == PGC_USERSET)
8094 else if (gconf->context == PGC_SUSET && superuser())
8096 else if (skipIfNoPermissions)
8098 /* if a permissions error should be thrown, let set_config_option do it */
8100 /* test for permissions and valid option value */
8101 (void) set_config_option(name, value,
8102 superuser() ? PGC_SUSET : PGC_USERSET,
8103 PGC_S_TEST, GUC_ACTION_SET, false, 0);
8110 * Called by check_hooks that want to override the normal
8111 * ERRCODE_INVALID_PARAMETER_VALUE SQLSTATE for check hook failures.
8113 * Note that GUC_check_errmsg() etc are just macros that result in a direct
8114 * assignment to the associated variables. That is ugly, but forced by the
8115 * limitations of C's macro mechanisms.
8118 GUC_check_errcode(int sqlerrcode)
8120 GUC_check_errcode_value = sqlerrcode;
8125 * Convenience functions to manage calling a variable's check_hook.
8126 * These mostly take care of the protocol for letting check hooks supply
8127 * portions of the error report on failure.
8131 call_bool_check_hook(struct config_bool * conf, bool *newval, void **extra,
8132 GucSource source, int elevel)
8134 /* Quick success if no hook */
8135 if (!conf->check_hook)
8138 /* Reset variables that might be set by hook */
8139 GUC_check_errcode_value = ERRCODE_INVALID_PARAMETER_VALUE;
8140 GUC_check_errmsg_string = NULL;
8141 GUC_check_errdetail_string = NULL;
8142 GUC_check_errhint_string = NULL;
8144 if (!(*conf->check_hook) (newval, extra, source))
8147 (errcode(GUC_check_errcode_value),
8148 GUC_check_errmsg_string ?
8149 errmsg_internal("%s", GUC_check_errmsg_string) :
8150 errmsg("invalid value for parameter \"%s\": %d",
8151 conf->gen.name, (int) *newval),
8152 GUC_check_errdetail_string ?
8153 errdetail_internal("%s", GUC_check_errdetail_string) : 0,
8154 GUC_check_errhint_string ?
8155 errhint("%s", GUC_check_errhint_string) : 0));
8156 /* Flush any strings created in ErrorContext */
8165 call_int_check_hook(struct config_int * conf, int *newval, void **extra,
8166 GucSource source, int elevel)
8168 /* Quick success if no hook */
8169 if (!conf->check_hook)
8172 /* Reset variables that might be set by hook */
8173 GUC_check_errcode_value = ERRCODE_INVALID_PARAMETER_VALUE;
8174 GUC_check_errmsg_string = NULL;
8175 GUC_check_errdetail_string = NULL;
8176 GUC_check_errhint_string = NULL;
8178 if (!(*conf->check_hook) (newval, extra, source))
8181 (errcode(GUC_check_errcode_value),
8182 GUC_check_errmsg_string ?
8183 errmsg_internal("%s", GUC_check_errmsg_string) :
8184 errmsg("invalid value for parameter \"%s\": %d",
8185 conf->gen.name, *newval),
8186 GUC_check_errdetail_string ?
8187 errdetail_internal("%s", GUC_check_errdetail_string) : 0,
8188 GUC_check_errhint_string ?
8189 errhint("%s", GUC_check_errhint_string) : 0));
8190 /* Flush any strings created in ErrorContext */
8199 call_real_check_hook(struct config_real * conf, double *newval, void **extra,
8200 GucSource source, int elevel)
8202 /* Quick success if no hook */
8203 if (!conf->check_hook)
8206 /* Reset variables that might be set by hook */
8207 GUC_check_errcode_value = ERRCODE_INVALID_PARAMETER_VALUE;
8208 GUC_check_errmsg_string = NULL;
8209 GUC_check_errdetail_string = NULL;
8210 GUC_check_errhint_string = NULL;
8212 if (!(*conf->check_hook) (newval, extra, source))
8215 (errcode(GUC_check_errcode_value),
8216 GUC_check_errmsg_string ?
8217 errmsg_internal("%s", GUC_check_errmsg_string) :
8218 errmsg("invalid value for parameter \"%s\": %g",
8219 conf->gen.name, *newval),
8220 GUC_check_errdetail_string ?
8221 errdetail_internal("%s", GUC_check_errdetail_string) : 0,
8222 GUC_check_errhint_string ?
8223 errhint("%s", GUC_check_errhint_string) : 0));
8224 /* Flush any strings created in ErrorContext */
8233 call_string_check_hook(struct config_string * conf, char **newval, void **extra,
8234 GucSource source, int elevel)
8236 /* Quick success if no hook */
8237 if (!conf->check_hook)
8240 /* Reset variables that might be set by hook */
8241 GUC_check_errcode_value = ERRCODE_INVALID_PARAMETER_VALUE;
8242 GUC_check_errmsg_string = NULL;
8243 GUC_check_errdetail_string = NULL;
8244 GUC_check_errhint_string = NULL;
8246 if (!(*conf->check_hook) (newval, extra, source))
8249 (errcode(GUC_check_errcode_value),
8250 GUC_check_errmsg_string ?
8251 errmsg_internal("%s", GUC_check_errmsg_string) :
8252 errmsg("invalid value for parameter \"%s\": \"%s\"",
8253 conf->gen.name, *newval ? *newval : ""),
8254 GUC_check_errdetail_string ?
8255 errdetail_internal("%s", GUC_check_errdetail_string) : 0,
8256 GUC_check_errhint_string ?
8257 errhint("%s", GUC_check_errhint_string) : 0));
8258 /* Flush any strings created in ErrorContext */
8267 call_enum_check_hook(struct config_enum * conf, int *newval, void **extra,
8268 GucSource source, int elevel)
8270 /* Quick success if no hook */
8271 if (!conf->check_hook)
8274 /* Reset variables that might be set by hook */
8275 GUC_check_errcode_value = ERRCODE_INVALID_PARAMETER_VALUE;
8276 GUC_check_errmsg_string = NULL;
8277 GUC_check_errdetail_string = NULL;
8278 GUC_check_errhint_string = NULL;
8280 if (!(*conf->check_hook) (newval, extra, source))
8283 (errcode(GUC_check_errcode_value),
8284 GUC_check_errmsg_string ?
8285 errmsg_internal("%s", GUC_check_errmsg_string) :
8286 errmsg("invalid value for parameter \"%s\": \"%s\"",
8288 config_enum_lookup_by_value(conf, *newval)),
8289 GUC_check_errdetail_string ?
8290 errdetail_internal("%s", GUC_check_errdetail_string) : 0,
8291 GUC_check_errhint_string ?
8292 errhint("%s", GUC_check_errhint_string) : 0));
8293 /* Flush any strings created in ErrorContext */
8303 * check_hook, assign_hook and show_hook subroutines
8307 check_log_destination(char **newval, void **extra, GucSource source)
8315 /* Need a modifiable copy of string */
8316 rawstring = pstrdup(*newval);
8318 /* Parse string into list of identifiers */
8319 if (!SplitIdentifierString(rawstring, ',', &elemlist))
8321 /* syntax error in list */
8322 GUC_check_errdetail("List syntax is invalid.");
8324 list_free(elemlist);
8328 foreach(l, elemlist)
8330 char *tok = (char *) lfirst(l);
8332 if (pg_strcasecmp(tok, "stderr") == 0)
8333 newlogdest |= LOG_DESTINATION_STDERR;
8334 else if (pg_strcasecmp(tok, "csvlog") == 0)
8335 newlogdest |= LOG_DESTINATION_CSVLOG;
8337 else if (pg_strcasecmp(tok, "syslog") == 0)
8338 newlogdest |= LOG_DESTINATION_SYSLOG;
8341 else if (pg_strcasecmp(tok, "eventlog") == 0)
8342 newlogdest |= LOG_DESTINATION_EVENTLOG;
8346 GUC_check_errdetail("Unrecognized key word: \"%s\".", tok);
8348 list_free(elemlist);
8354 list_free(elemlist);
8356 myextra = (int *) guc_malloc(ERROR, sizeof(int));
8357 *myextra = newlogdest;
8358 *extra = (void *) myextra;
8364 assign_log_destination(const char *newval, void *extra)
8366 Log_destination = *((int *) extra);
8370 assign_syslog_facility(int newval, void *extra)
8373 set_syslog_parameters(syslog_ident_str ? syslog_ident_str : "postgres",
8376 /* Without syslog support, just ignore it */
8380 assign_syslog_ident(const char *newval, void *extra)
8383 set_syslog_parameters(newval, syslog_facility);
8385 /* Without syslog support, it will always be set to "none", so ignore */
8390 assign_session_replication_role(int newval, void *extra)
8393 * Must flush the plan cache when changing replication role; but don't
8394 * flush unnecessarily.
8396 if (SessionReplicationRole != newval)
8401 check_temp_buffers(int *newval, void **extra, GucSource source)
8404 * Once local buffers have been initialized, it's too late to change this.
8406 if (NLocBuffer && NLocBuffer != *newval)
8408 GUC_check_errdetail("\"temp_buffers\" cannot be changed after any temporary tables have been accessed in the session.");
8415 check_phony_autocommit(bool *newval, void **extra, GucSource source)
8419 GUC_check_errcode(ERRCODE_FEATURE_NOT_SUPPORTED);
8420 GUC_check_errmsg("SET AUTOCOMMIT TO OFF is no longer supported");
8427 check_debug_assertions(bool *newval, void **extra, GucSource source)
8429 #ifndef USE_ASSERT_CHECKING
8432 GUC_check_errmsg("assertion checking is not supported by this build");
8440 check_bonjour(bool *newval, void **extra, GucSource source)
8445 GUC_check_errmsg("Bonjour is not supported by this build");
8453 check_ssl(bool *newval, void **extra, GucSource source)
8458 GUC_check_errmsg("SSL is not supported by this build");
8466 check_stage_log_stats(bool *newval, void **extra, GucSource source)
8468 if (*newval && log_statement_stats)
8470 GUC_check_errdetail("Cannot enable parameter when \"log_statement_stats\" is true.");
8477 check_log_stats(bool *newval, void **extra, GucSource source)
8480 (log_parser_stats || log_planner_stats || log_executor_stats))
8482 GUC_check_errdetail("Cannot enable \"log_statement_stats\" when "
8483 "\"log_parser_stats\", \"log_planner_stats\", "
8484 "or \"log_executor_stats\" is true.");
8491 check_canonical_path(char **newval, void **extra, GucSource source)
8494 * Since canonicalize_path never enlarges the string, we can just modify
8495 * newval in-place. But watch out for NULL, which is the default value
8496 * for external_pid_file.
8499 canonicalize_path(*newval);
8504 check_timezone_abbreviations(char **newval, void **extra, GucSource source)
8507 * The boot_val given above for timezone_abbreviations is NULL. When we
8508 * see this we just do nothing. If this value isn't overridden from the
8509 * config file then pg_timezone_abbrev_initialize() will eventually
8510 * replace it with "Default". This hack has two purposes: to avoid
8511 * wasting cycles loading values that might soon be overridden from the
8512 * config file, and to avoid trying to read the timezone abbrev files
8513 * during InitializeGUCOptions(). The latter doesn't work in an
8514 * EXEC_BACKEND subprocess because my_exec_path hasn't been set yet and so
8515 * we can't locate PGSHAREDIR.
8517 if (*newval == NULL)
8519 Assert(source == PGC_S_DEFAULT);
8523 /* OK, load the file and produce a malloc'd TimeZoneAbbrevTable */
8524 *extra = load_tzoffsets(*newval);
8526 /* tzparser.c returns NULL on failure, reporting via GUC_check_errmsg */
8534 assign_timezone_abbreviations(const char *newval, void *extra)
8536 /* Do nothing for the boot_val default of NULL */
8540 InstallTimeZoneAbbrevs((TimeZoneAbbrevTable *) extra);
8544 * pg_timezone_abbrev_initialize --- set default value if not done already
8546 * This is called after initial loading of postgresql.conf. If no
8547 * timezone_abbreviations setting was found therein, select default.
8548 * If a non-default value is already installed, nothing will happen.
8550 * This can also be called from ProcessConfigFile to establish the default
8551 * value after a postgresql.conf entry for it is removed.
8554 pg_timezone_abbrev_initialize(void)
8556 SetConfigOption("timezone_abbreviations", "Default",
8557 PGC_POSTMASTER, PGC_S_DYNAMIC_DEFAULT);
8561 show_archive_command(void)
8563 if (XLogArchivingActive())
8564 return XLogArchiveCommand;
8566 return "(disabled)";
8570 assign_tcp_keepalives_idle(int newval, void *extra)
8573 * The kernel API provides no way to test a value without setting it; and
8574 * once we set it we might fail to unset it. So there seems little point
8575 * in fully implementing the check-then-assign GUC API for these
8576 * variables. Instead we just do the assignment on demand. pqcomm.c
8577 * reports any problems via elog(LOG).
8579 * This approach means that the GUC value might have little to do with the
8580 * actual kernel value, so we use a show_hook that retrieves the kernel
8581 * value rather than trusting GUC's copy.
8583 (void) pq_setkeepalivesidle(newval, MyProcPort);
8587 show_tcp_keepalives_idle(void)
8589 /* See comments in assign_tcp_keepalives_idle */
8590 static char nbuf[16];
8592 snprintf(nbuf, sizeof(nbuf), "%d", pq_getkeepalivesidle(MyProcPort));
8597 assign_tcp_keepalives_interval(int newval, void *extra)
8599 /* See comments in assign_tcp_keepalives_idle */
8600 (void) pq_setkeepalivesinterval(newval, MyProcPort);
8604 show_tcp_keepalives_interval(void)
8606 /* See comments in assign_tcp_keepalives_idle */
8607 static char nbuf[16];
8609 snprintf(nbuf, sizeof(nbuf), "%d", pq_getkeepalivesinterval(MyProcPort));
8614 assign_tcp_keepalives_count(int newval, void *extra)
8616 /* See comments in assign_tcp_keepalives_idle */
8617 (void) pq_setkeepalivescount(newval, MyProcPort);
8621 show_tcp_keepalives_count(void)
8623 /* See comments in assign_tcp_keepalives_idle */
8624 static char nbuf[16];
8626 snprintf(nbuf, sizeof(nbuf), "%d", pq_getkeepalivescount(MyProcPort));
8631 check_maxconnections(int *newval, void **extra, GucSource source)
8633 if (*newval + GetNumShmemAttachedBgworkers() + autovacuum_max_workers + 1 >
8640 assign_maxconnections(int newval, void *extra)
8642 MaxBackends = newval + autovacuum_max_workers + 1 +
8643 GetNumShmemAttachedBgworkers();
8647 check_autovacuum_max_workers(int *newval, void **extra, GucSource source)
8649 if (MaxConnections + *newval + 1 + GetNumShmemAttachedBgworkers() >
8656 assign_autovacuum_max_workers(int newval, void *extra)
8658 MaxBackends = MaxConnections + newval + 1 + GetNumShmemAttachedBgworkers();
8662 check_effective_io_concurrency(int *newval, void **extra, GucSource source)
8665 double new_prefetch_pages = 0.0;
8669 * The user-visible GUC parameter is the number of drives (spindles),
8670 * which we need to translate to a number-of-pages-to-prefetch target.
8671 * The target value is stashed in *extra and then assigned to the actual
8672 * variable by assign_effective_io_concurrency.
8674 * The expected number of prefetch pages needed to keep N drives busy is:
8676 * drives | I/O requests
8677 * -------+----------------
8680 * 3 | 3/1 + 3/2 + 3/3 = 5 1/2
8681 * 4 | 4/1 + 4/2 + 4/3 + 4/4 = 8 1/3
8684 * This is called the "coupon collector problem" and H(n) is called the
8685 * harmonic series. This could be approximated by n * ln(n), but for
8686 * reasonable numbers of drives we might as well just compute the series.
8688 * Alternatively we could set the target to the number of pages necessary
8689 * so that the expected number of active spindles is some arbitrary
8690 * percentage of the total. This sounds the same but is actually slightly
8691 * different. The result ends up being ln(1-P)/ln((n-1)/n) where P is
8692 * that desired fraction.
8694 * Experimental results show that both of these formulas aren't aggressive
8695 * enough, but we don't really have any better proposals.
8697 * Note that if *newval = 0 (disabled), we must set target = 0.
8701 for (i = 1; i <= *newval; i++)
8702 new_prefetch_pages += (double) *newval / (double) i;
8704 /* This range check shouldn't fail, but let's be paranoid */
8705 if (new_prefetch_pages >= 0.0 && new_prefetch_pages < (double) INT_MAX)
8707 int *myextra = (int *) guc_malloc(ERROR, sizeof(int));
8709 *myextra = (int) rint(new_prefetch_pages);
8710 *extra = (void *) myextra;
8718 #endif /* USE_PREFETCH */
8722 assign_effective_io_concurrency(int newval, void *extra)
8725 target_prefetch_pages = *((int *) extra);
8726 #endif /* USE_PREFETCH */
8730 assign_pgstat_temp_directory(const char *newval, void *extra)
8732 /* check_canonical_path already canonicalized newval for us */
8736 tname = guc_malloc(ERROR, strlen(newval) + 12); /* /pgstat.tmp */
8737 sprintf(tname, "%s/pgstat.tmp", newval);
8738 fname = guc_malloc(ERROR, strlen(newval) + 13); /* /pgstat.stat */
8739 sprintf(fname, "%s/pgstat.stat", newval);
8741 if (pgstat_stat_tmpname)
8742 free(pgstat_stat_tmpname);
8743 pgstat_stat_tmpname = tname;
8744 if (pgstat_stat_filename)
8745 free(pgstat_stat_filename);
8746 pgstat_stat_filename = fname;
8750 check_application_name(char **newval, void **extra, GucSource source)
8752 /* Only allow clean ASCII chars in the application name */
8755 for (p = *newval; *p; p++)
8757 if (*p < 32 || *p > 126)
8765 assign_application_name(const char *newval, void *extra)
8767 /* Update the pg_stat_activity view */
8768 pgstat_report_appname(newval);
8772 show_unix_socket_permissions(void)
8776 snprintf(buf, sizeof(buf), "%04o", Unix_socket_permissions);
8781 show_log_file_mode(void)
8785 snprintf(buf, sizeof(buf), "%04o", Log_file_mode);
8789 #include "guc-file.c"