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-2013, 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)
106 #define KB_PER_MB (1024)
107 #define KB_PER_GB (1024*1024)
109 #define MS_PER_S 1000
111 #define MS_PER_MIN (1000 * 60)
113 #define S_PER_H (60 * 60)
114 #define MS_PER_H (1000 * 60 * 60)
115 #define MIN_PER_D (60 * 24)
116 #define S_PER_D (60 * 60 * 24)
117 #define MS_PER_D (1000 * 60 * 60 * 24)
119 /* XXX these should appear in other modules' header files */
120 extern bool Log_disconnections;
121 extern int CommitDelay;
122 extern int CommitSiblings;
123 extern char *default_tablespace;
124 extern char *temp_tablespaces;
125 extern bool ignore_checksum_failure;
126 extern bool synchronize_seqscans;
127 extern int ssl_renegotiation_limit;
128 extern char *SSLCipherSuites;
131 extern bool trace_sort;
133 #ifdef TRACE_SYNCSCAN
134 extern bool trace_syncscan;
136 #ifdef DEBUG_BOUNDED_SORT
137 extern bool optimize_bounded_sort;
140 static int GUC_check_errcode_value;
142 /* global variables for check hook support */
143 char *GUC_check_errmsg_string;
144 char *GUC_check_errdetail_string;
145 char *GUC_check_errhint_string;
148 static void set_config_sourcefile(const char *name, char *sourcefile,
150 static bool call_bool_check_hook(struct config_bool * conf, bool *newval,
151 void **extra, GucSource source, int elevel);
152 static bool call_int_check_hook(struct config_int * conf, int *newval,
153 void **extra, GucSource source, int elevel);
154 static bool call_real_check_hook(struct config_real * conf, double *newval,
155 void **extra, GucSource source, int elevel);
156 static bool call_string_check_hook(struct config_string * conf, char **newval,
157 void **extra, GucSource source, int elevel);
158 static bool call_enum_check_hook(struct config_enum * conf, int *newval,
159 void **extra, GucSource source, int elevel);
161 static bool check_log_destination(char **newval, void **extra, GucSource source);
162 static void assign_log_destination(const char *newval, void *extra);
165 static int syslog_facility = LOG_LOCAL0;
167 static int syslog_facility = 0;
170 static void assign_syslog_facility(int newval, void *extra);
171 static void assign_syslog_ident(const char *newval, void *extra);
172 static void assign_session_replication_role(int newval, void *extra);
173 static bool check_temp_buffers(int *newval, void **extra, GucSource source);
174 static bool check_phony_autocommit(bool *newval, void **extra, GucSource source);
175 static bool check_debug_assertions(bool *newval, void **extra, GucSource source);
176 static bool check_bonjour(bool *newval, void **extra, GucSource source);
177 static bool check_ssl(bool *newval, void **extra, GucSource source);
178 static bool check_stage_log_stats(bool *newval, void **extra, GucSource source);
179 static bool check_log_stats(bool *newval, void **extra, GucSource source);
180 static bool check_canonical_path(char **newval, void **extra, GucSource source);
181 static bool check_timezone_abbreviations(char **newval, void **extra, GucSource source);
182 static void assign_timezone_abbreviations(const char *newval, void *extra);
183 static void pg_timezone_abbrev_initialize(void);
184 static const char *show_archive_command(void);
185 static void assign_tcp_keepalives_idle(int newval, void *extra);
186 static void assign_tcp_keepalives_interval(int newval, void *extra);
187 static void assign_tcp_keepalives_count(int newval, void *extra);
188 static const char *show_tcp_keepalives_idle(void);
189 static const char *show_tcp_keepalives_interval(void);
190 static const char *show_tcp_keepalives_count(void);
191 static bool check_maxconnections(int *newval, void **extra, GucSource source);
192 static bool check_autovacuum_max_workers(int *newval, void **extra, GucSource source);
193 static bool check_effective_io_concurrency(int *newval, void **extra, GucSource source);
194 static void assign_effective_io_concurrency(int newval, void *extra);
195 static void assign_pgstat_temp_directory(const char *newval, void *extra);
196 static bool check_application_name(char **newval, void **extra, GucSource source);
197 static void assign_application_name(const char *newval, void *extra);
198 static const char *show_unix_socket_permissions(void);
199 static const char *show_log_file_mode(void);
201 static char *config_enum_get_options(struct config_enum * record,
202 const char *prefix, const char *suffix,
203 const char *separator);
207 * Options for enum values defined in this module.
209 * NOTE! Option values may not contain double quotes!
212 static const struct config_enum_entry bytea_output_options[] = {
213 {"escape", BYTEA_OUTPUT_ESCAPE, false},
214 {"hex", BYTEA_OUTPUT_HEX, false},
219 * We have different sets for client and server message level options because
220 * they sort slightly different (see "log" level)
222 static const struct config_enum_entry client_message_level_options[] = {
223 {"debug", DEBUG2, true},
224 {"debug5", DEBUG5, false},
225 {"debug4", DEBUG4, false},
226 {"debug3", DEBUG3, false},
227 {"debug2", DEBUG2, false},
228 {"debug1", DEBUG1, false},
230 {"info", INFO, true},
231 {"notice", NOTICE, false},
232 {"warning", WARNING, false},
233 {"error", ERROR, false},
234 {"fatal", FATAL, true},
235 {"panic", PANIC, true},
239 static const struct config_enum_entry server_message_level_options[] = {
240 {"debug", DEBUG2, true},
241 {"debug5", DEBUG5, false},
242 {"debug4", DEBUG4, false},
243 {"debug3", DEBUG3, false},
244 {"debug2", DEBUG2, false},
245 {"debug1", DEBUG1, false},
246 {"info", INFO, false},
247 {"notice", NOTICE, false},
248 {"warning", WARNING, false},
249 {"error", ERROR, false},
251 {"fatal", FATAL, false},
252 {"panic", PANIC, false},
256 static const struct config_enum_entry intervalstyle_options[] = {
257 {"postgres", INTSTYLE_POSTGRES, false},
258 {"postgres_verbose", INTSTYLE_POSTGRES_VERBOSE, false},
259 {"sql_standard", INTSTYLE_SQL_STANDARD, false},
260 {"iso_8601", INTSTYLE_ISO_8601, false},
264 static const struct config_enum_entry log_error_verbosity_options[] = {
265 {"terse", PGERROR_TERSE, false},
266 {"default", PGERROR_DEFAULT, false},
267 {"verbose", PGERROR_VERBOSE, false},
271 static const struct config_enum_entry log_statement_options[] = {
272 {"none", LOGSTMT_NONE, false},
273 {"ddl", LOGSTMT_DDL, false},
274 {"mod", LOGSTMT_MOD, false},
275 {"all", LOGSTMT_ALL, false},
279 static const struct config_enum_entry isolation_level_options[] = {
280 {"serializable", XACT_SERIALIZABLE, false},
281 {"repeatable read", XACT_REPEATABLE_READ, false},
282 {"read committed", XACT_READ_COMMITTED, false},
283 {"read uncommitted", XACT_READ_UNCOMMITTED, false},
287 static const struct config_enum_entry session_replication_role_options[] = {
288 {"origin", SESSION_REPLICATION_ROLE_ORIGIN, false},
289 {"replica", SESSION_REPLICATION_ROLE_REPLICA, false},
290 {"local", SESSION_REPLICATION_ROLE_LOCAL, false},
294 static const struct config_enum_entry syslog_facility_options[] = {
296 {"local0", LOG_LOCAL0, false},
297 {"local1", LOG_LOCAL1, false},
298 {"local2", LOG_LOCAL2, false},
299 {"local3", LOG_LOCAL3, false},
300 {"local4", LOG_LOCAL4, false},
301 {"local5", LOG_LOCAL5, false},
302 {"local6", LOG_LOCAL6, false},
303 {"local7", LOG_LOCAL7, false},
310 static const struct config_enum_entry track_function_options[] = {
311 {"none", TRACK_FUNC_OFF, false},
312 {"pl", TRACK_FUNC_PL, false},
313 {"all", TRACK_FUNC_ALL, false},
317 static const struct config_enum_entry xmlbinary_options[] = {
318 {"base64", XMLBINARY_BASE64, false},
319 {"hex", XMLBINARY_HEX, false},
323 static const struct config_enum_entry xmloption_options[] = {
324 {"content", XMLOPTION_CONTENT, false},
325 {"document", XMLOPTION_DOCUMENT, false},
330 * Although only "on", "off", and "safe_encoding" are documented, we
331 * accept all the likely variants of "on" and "off".
333 static const struct config_enum_entry backslash_quote_options[] = {
334 {"safe_encoding", BACKSLASH_QUOTE_SAFE_ENCODING, false},
335 {"on", BACKSLASH_QUOTE_ON, false},
336 {"off", BACKSLASH_QUOTE_OFF, false},
337 {"true", BACKSLASH_QUOTE_ON, true},
338 {"false", BACKSLASH_QUOTE_OFF, true},
339 {"yes", BACKSLASH_QUOTE_ON, true},
340 {"no", BACKSLASH_QUOTE_OFF, true},
341 {"1", BACKSLASH_QUOTE_ON, true},
342 {"0", BACKSLASH_QUOTE_OFF, true},
347 * Although only "on", "off", and "partition" are documented, we
348 * accept all the likely variants of "on" and "off".
350 static const struct config_enum_entry constraint_exclusion_options[] = {
351 {"partition", CONSTRAINT_EXCLUSION_PARTITION, false},
352 {"on", CONSTRAINT_EXCLUSION_ON, false},
353 {"off", CONSTRAINT_EXCLUSION_OFF, false},
354 {"true", CONSTRAINT_EXCLUSION_ON, true},
355 {"false", CONSTRAINT_EXCLUSION_OFF, true},
356 {"yes", CONSTRAINT_EXCLUSION_ON, true},
357 {"no", CONSTRAINT_EXCLUSION_OFF, true},
358 {"1", CONSTRAINT_EXCLUSION_ON, true},
359 {"0", CONSTRAINT_EXCLUSION_OFF, true},
364 * Although only "on", "off", "remote_write", and "local" are documented, we
365 * accept all the likely variants of "on" and "off".
367 static const struct config_enum_entry synchronous_commit_options[] = {
368 {"local", SYNCHRONOUS_COMMIT_LOCAL_FLUSH, false},
369 {"remote_write", SYNCHRONOUS_COMMIT_REMOTE_WRITE, false},
370 {"on", SYNCHRONOUS_COMMIT_ON, false},
371 {"off", SYNCHRONOUS_COMMIT_OFF, false},
372 {"true", SYNCHRONOUS_COMMIT_ON, true},
373 {"false", SYNCHRONOUS_COMMIT_OFF, true},
374 {"yes", SYNCHRONOUS_COMMIT_ON, true},
375 {"no", SYNCHRONOUS_COMMIT_OFF, true},
376 {"1", SYNCHRONOUS_COMMIT_ON, true},
377 {"0", SYNCHRONOUS_COMMIT_OFF, true},
382 * Options for enum values stored in other modules
384 extern const struct config_enum_entry wal_level_options[];
385 extern const struct config_enum_entry sync_method_options[];
388 * GUC option variables that are exported from this module
390 #ifdef USE_ASSERT_CHECKING
391 bool assert_enabled = true;
393 bool assert_enabled = false;
395 bool log_duration = false;
396 bool Debug_print_plan = false;
397 bool Debug_print_parse = false;
398 bool Debug_print_rewritten = false;
399 bool Debug_pretty_print = true;
401 bool log_parser_stats = false;
402 bool log_planner_stats = false;
403 bool log_executor_stats = false;
404 bool log_statement_stats = false; /* this is sort of all three
406 bool log_btree_build_stats = false;
409 bool check_function_bodies = true;
410 bool default_with_oids = false;
411 bool SQL_inheritance = true;
413 bool Password_encryption = true;
415 int log_min_error_statement = ERROR;
416 int log_min_messages = WARNING;
417 int client_min_messages = NOTICE;
418 int log_min_duration_statement = -1;
419 int log_temp_files = -1;
420 int trace_recovery_messages = LOG;
422 int temp_file_limit = -1;
424 int num_temp_buffers = 1024;
426 char *data_directory;
427 char *recovery_config_directory;
428 char *ConfigFileName;
431 char *external_pid_file;
433 char *pgstat_temp_directory;
435 char *application_name;
437 int tcp_keepalives_idle;
438 int tcp_keepalives_interval;
439 int tcp_keepalives_count;
442 * These variables are all dummies that don't do anything, except in some
443 * cases provide the value for SHOW to display. The real state is elsewhere
444 * and is kept in sync by assign_hooks.
446 static char *log_destination_string;
448 static char *syslog_ident_str;
449 static bool phony_autocommit;
450 static bool session_auth_is_superuser;
451 static double phony_random_seed;
452 static char *client_encoding_string;
453 static char *datestyle_string;
454 static char *locale_collate;
455 static char *locale_ctype;
456 static char *server_encoding_string;
457 static char *server_version_string;
458 static int server_version_num;
459 static char *timezone_string;
460 static char *log_timezone_string;
461 static char *timezone_abbreviations_string;
462 static char *XactIsoLevel_string;
463 static char *session_authorization_string;
464 static int max_function_args;
465 static int max_index_keys;
466 static int max_identifier_length;
467 static int block_size;
468 static int segment_size;
469 static int wal_block_size;
470 static int wal_segment_size;
471 static bool integer_datetimes;
472 static int effective_io_concurrency;
474 /* should be static, but commands/variable.c needs to get at this */
479 * Displayable names for context types (enum GucContext)
481 * Note: these strings are deliberately not localized.
483 const char *const GucContext_Names[] =
485 /* PGC_INTERNAL */ "internal",
486 /* PGC_POSTMASTER */ "postmaster",
487 /* PGC_SIGHUP */ "sighup",
488 /* PGC_BACKEND */ "backend",
489 /* PGC_SUSET */ "superuser",
490 /* PGC_USERSET */ "user"
494 * Displayable names for source types (enum GucSource)
496 * Note: these strings are deliberately not localized.
498 const char *const GucSource_Names[] =
500 /* PGC_S_DEFAULT */ "default",
501 /* PGC_S_DYNAMIC_DEFAULT */ "default",
502 /* PGC_S_ENV_VAR */ "environment variable",
503 /* PGC_S_FILE */ "configuration file",
504 /* PGC_S_ARGV */ "command line",
505 /* PGC_S_GLOBAL */ "global",
506 /* PGC_S_DATABASE */ "database",
507 /* PGC_S_USER */ "user",
508 /* PGC_S_DATABASE_USER */ "database user",
509 /* PGC_S_CLIENT */ "client",
510 /* PGC_S_OVERRIDE */ "override",
511 /* PGC_S_INTERACTIVE */ "interactive",
512 /* PGC_S_TEST */ "test",
513 /* PGC_S_SESSION */ "session"
517 * Displayable names for the groupings defined in enum config_group
519 const char *const config_group_names[] =
522 gettext_noop("Ungrouped"),
524 gettext_noop("File Locations"),
526 gettext_noop("Connections and Authentication"),
527 /* CONN_AUTH_SETTINGS */
528 gettext_noop("Connections and Authentication / Connection Settings"),
529 /* CONN_AUTH_SECURITY */
530 gettext_noop("Connections and Authentication / Security and Authentication"),
532 gettext_noop("Resource Usage"),
534 gettext_noop("Resource Usage / Memory"),
536 gettext_noop("Resource Usage / Disk"),
537 /* RESOURCES_KERNEL */
538 gettext_noop("Resource Usage / Kernel Resources"),
539 /* RESOURCES_VACUUM_DELAY */
540 gettext_noop("Resource Usage / Cost-Based Vacuum Delay"),
541 /* RESOURCES_BGWRITER */
542 gettext_noop("Resource Usage / Background Writer"),
543 /* RESOURCES_ASYNCHRONOUS */
544 gettext_noop("Resource Usage / Asynchronous Behavior"),
546 gettext_noop("Write-Ahead Log"),
548 gettext_noop("Write-Ahead Log / Settings"),
549 /* WAL_CHECKPOINTS */
550 gettext_noop("Write-Ahead Log / Checkpoints"),
552 gettext_noop("Write-Ahead Log / Archiving"),
554 gettext_noop("Replication"),
555 /* REPLICATION_SENDING */
556 gettext_noop("Replication / Sending Servers"),
557 /* REPLICATION_MASTER */
558 gettext_noop("Replication / Master Server"),
559 /* REPLICATION_STANDBY */
560 gettext_noop("Replication / Standby Servers"),
562 gettext_noop("Query Tuning"),
563 /* QUERY_TUNING_METHOD */
564 gettext_noop("Query Tuning / Planner Method Configuration"),
565 /* QUERY_TUNING_COST */
566 gettext_noop("Query Tuning / Planner Cost Constants"),
567 /* QUERY_TUNING_GEQO */
568 gettext_noop("Query Tuning / Genetic Query Optimizer"),
569 /* QUERY_TUNING_OTHER */
570 gettext_noop("Query Tuning / Other Planner Options"),
572 gettext_noop("Reporting and Logging"),
574 gettext_noop("Reporting and Logging / Where to Log"),
576 gettext_noop("Reporting and Logging / When to Log"),
578 gettext_noop("Reporting and Logging / What to Log"),
580 gettext_noop("Statistics"),
581 /* STATS_MONITORING */
582 gettext_noop("Statistics / Monitoring"),
583 /* STATS_COLLECTOR */
584 gettext_noop("Statistics / Query and Index Statistics Collector"),
586 gettext_noop("Autovacuum"),
588 gettext_noop("Client Connection Defaults"),
589 /* CLIENT_CONN_STATEMENT */
590 gettext_noop("Client Connection Defaults / Statement Behavior"),
591 /* CLIENT_CONN_LOCALE */
592 gettext_noop("Client Connection Defaults / Locale and Formatting"),
593 /* CLIENT_CONN_OTHER */
594 gettext_noop("Client Connection Defaults / Other Defaults"),
595 /* LOCK_MANAGEMENT */
596 gettext_noop("Lock Management"),
598 gettext_noop("Version and Platform Compatibility"),
599 /* COMPAT_OPTIONS_PREVIOUS */
600 gettext_noop("Version and Platform Compatibility / Previous PostgreSQL Versions"),
601 /* COMPAT_OPTIONS_CLIENT */
602 gettext_noop("Version and Platform Compatibility / Other Platforms and Clients"),
604 gettext_noop("Error Handling"),
606 gettext_noop("Preset Options"),
608 gettext_noop("Customized Options"),
609 /* DEVELOPER_OPTIONS */
610 gettext_noop("Developer Options"),
611 /* help_config wants this array to be null-terminated */
616 * Displayable names for GUC variable types (enum config_type)
618 * Note: these strings are deliberately not localized.
620 const char *const config_type_names[] =
622 /* PGC_BOOL */ "bool",
623 /* PGC_INT */ "integer",
624 /* PGC_REAL */ "real",
625 /* PGC_STRING */ "string",
626 /* PGC_ENUM */ "enum"
631 * Contents of GUC tables
633 * See src/backend/utils/misc/README for design notes.
637 * 1. Declare a global variable of type bool, int, double, or char*
638 * and make use of it.
640 * 2. Decide at what times it's safe to set the option. See guc.h for
643 * 3. Decide on a name, a default value, upper and lower bounds (if
646 * 4. Add a record below.
648 * 5. Add it to src/backend/utils/misc/postgresql.conf.sample, if
651 * 6. Don't forget to document the option (at least in config.sgml).
653 * 7. If it's a new GUC_LIST option you must edit pg_dumpall.c to ensure
654 * it is not single quoted at dump time.
658 /******** option records follow ********/
660 static struct config_bool ConfigureNamesBool[] =
663 {"enable_seqscan", PGC_USERSET, QUERY_TUNING_METHOD,
664 gettext_noop("Enables the planner's use of sequential-scan plans."),
672 {"enable_indexscan", PGC_USERSET, QUERY_TUNING_METHOD,
673 gettext_noop("Enables the planner's use of index-scan plans."),
681 {"enable_indexonlyscan", PGC_USERSET, QUERY_TUNING_METHOD,
682 gettext_noop("Enables the planner's use of index-only-scan plans."),
685 &enable_indexonlyscan,
690 {"enable_bitmapscan", PGC_USERSET, QUERY_TUNING_METHOD,
691 gettext_noop("Enables the planner's use of bitmap-scan plans."),
699 {"enable_tidscan", PGC_USERSET, QUERY_TUNING_METHOD,
700 gettext_noop("Enables the planner's use of TID scan plans."),
708 {"enable_sort", PGC_USERSET, QUERY_TUNING_METHOD,
709 gettext_noop("Enables the planner's use of explicit sort steps."),
717 {"enable_hashagg", PGC_USERSET, QUERY_TUNING_METHOD,
718 gettext_noop("Enables the planner's use of hashed aggregation plans."),
726 {"enable_material", PGC_USERSET, QUERY_TUNING_METHOD,
727 gettext_noop("Enables the planner's use of materialization."),
735 {"enable_nestloop", PGC_USERSET, QUERY_TUNING_METHOD,
736 gettext_noop("Enables the planner's use of nested-loop join plans."),
744 {"enable_mergejoin", PGC_USERSET, QUERY_TUNING_METHOD,
745 gettext_noop("Enables the planner's use of merge join plans."),
753 {"enable_hashjoin", PGC_USERSET, QUERY_TUNING_METHOD,
754 gettext_noop("Enables the planner's use of hash join plans."),
762 {"geqo", PGC_USERSET, QUERY_TUNING_GEQO,
763 gettext_noop("Enables genetic query optimization."),
764 gettext_noop("This algorithm attempts to do planning without "
765 "exhaustive searching.")
772 /* Not for general use --- used by SET SESSION AUTHORIZATION */
773 {"is_superuser", PGC_INTERNAL, UNGROUPED,
774 gettext_noop("Shows whether the current user is a superuser."),
776 GUC_REPORT | GUC_NO_SHOW_ALL | GUC_NO_RESET_ALL | GUC_NOT_IN_SAMPLE | GUC_DISALLOW_IN_FILE
778 &session_auth_is_superuser,
783 {"bonjour", PGC_POSTMASTER, CONN_AUTH_SETTINGS,
784 gettext_noop("Enables advertising the server via Bonjour."),
789 check_bonjour, NULL, NULL
792 {"ssl", PGC_POSTMASTER, CONN_AUTH_SECURITY,
793 gettext_noop("Enables SSL connections."),
798 check_ssl, NULL, NULL
801 {"fsync", PGC_SIGHUP, WAL_SETTINGS,
802 gettext_noop("Forces synchronization of updates to disk."),
803 gettext_noop("The server will use the fsync() system call in several places to make "
804 "sure that updates are physically written to disk. This insures "
805 "that a database cluster will recover to a consistent state after "
806 "an operating system or hardware crash.")
813 {"ignore_checksum_failure", PGC_SUSET, DEVELOPER_OPTIONS,
814 gettext_noop("Continues processing after a checksum failure."),
815 gettext_noop("Detection of a checksum failure normally causes PostgreSQL to "
816 "report an error, aborting the current transaction. Setting "
817 "ignore_checksum_failure to true causes the system to ignore the failure "
818 "(but still report a warning), and continue processing. This "
819 "behavior could cause crashes or other serious problems. Only "
820 "has an effect if checksums are enabled."),
823 &ignore_checksum_failure,
828 {"zero_damaged_pages", PGC_SUSET, DEVELOPER_OPTIONS,
829 gettext_noop("Continues processing past damaged page headers."),
830 gettext_noop("Detection of a damaged page header normally causes PostgreSQL to "
831 "report an error, aborting the current transaction. Setting "
832 "zero_damaged_pages to true causes the system to instead report a "
833 "warning, zero out the damaged page, and continue processing. This "
834 "behavior will destroy data, namely all the rows on the damaged page."),
842 {"full_page_writes", PGC_SIGHUP, WAL_SETTINGS,
843 gettext_noop("Writes full pages to WAL when first modified after a checkpoint."),
844 gettext_noop("A page write in process during an operating system crash might be "
845 "only partially written to disk. During recovery, the row changes "
846 "stored in WAL are not enough to recover. This option writes "
847 "pages when first modified after a checkpoint to WAL so full recovery "
855 {"log_checkpoints", PGC_SIGHUP, LOGGING_WHAT,
856 gettext_noop("Logs each checkpoint."),
864 {"log_connections", PGC_BACKEND, LOGGING_WHAT,
865 gettext_noop("Logs each successful connection."),
873 {"log_disconnections", PGC_BACKEND, LOGGING_WHAT,
874 gettext_noop("Logs end of a session, including duration."),
882 {"debug_assertions", PGC_USERSET, DEVELOPER_OPTIONS,
883 gettext_noop("Turns on various assertion checks."),
884 gettext_noop("This is a debugging aid."),
888 #ifdef USE_ASSERT_CHECKING
893 check_debug_assertions, NULL, NULL
897 {"exit_on_error", PGC_USERSET, ERROR_HANDLING_OPTIONS,
898 gettext_noop("Terminate session on any error."),
906 {"restart_after_crash", PGC_SIGHUP, ERROR_HANDLING_OPTIONS,
907 gettext_noop("Reinitialize server after backend crash."),
910 &restart_after_crash,
916 {"log_duration", PGC_SUSET, LOGGING_WHAT,
917 gettext_noop("Logs the duration of each completed SQL statement."),
925 {"debug_print_parse", PGC_USERSET, LOGGING_WHAT,
926 gettext_noop("Logs each query's parse tree."),
934 {"debug_print_rewritten", PGC_USERSET, LOGGING_WHAT,
935 gettext_noop("Logs each query's rewritten parse tree."),
938 &Debug_print_rewritten,
943 {"debug_print_plan", PGC_USERSET, LOGGING_WHAT,
944 gettext_noop("Logs each query's execution plan."),
952 {"debug_pretty_print", PGC_USERSET, LOGGING_WHAT,
953 gettext_noop("Indents parse and plan tree displays."),
961 {"log_parser_stats", PGC_SUSET, STATS_MONITORING,
962 gettext_noop("Writes parser performance statistics to the server log."),
967 check_stage_log_stats, NULL, NULL
970 {"log_planner_stats", PGC_SUSET, STATS_MONITORING,
971 gettext_noop("Writes planner performance statistics to the server log."),
976 check_stage_log_stats, NULL, NULL
979 {"log_executor_stats", PGC_SUSET, STATS_MONITORING,
980 gettext_noop("Writes executor performance statistics to the server log."),
985 check_stage_log_stats, NULL, NULL
988 {"log_statement_stats", PGC_SUSET, STATS_MONITORING,
989 gettext_noop("Writes cumulative performance statistics to the server log."),
992 &log_statement_stats,
994 check_log_stats, NULL, NULL
996 #ifdef BTREE_BUILD_STATS
998 {"log_btree_build_stats", PGC_SUSET, DEVELOPER_OPTIONS,
999 gettext_noop("No description available."),
1003 &log_btree_build_stats,
1010 {"track_activities", PGC_SUSET, STATS_COLLECTOR,
1011 gettext_noop("Collects information about executing commands."),
1012 gettext_noop("Enables the collection of information on the currently "
1013 "executing command of each session, along with "
1014 "the time at which that command began execution.")
1016 &pgstat_track_activities,
1021 {"track_counts", PGC_SUSET, STATS_COLLECTOR,
1022 gettext_noop("Collects statistics on database activity."),
1025 &pgstat_track_counts,
1030 {"track_io_timing", PGC_SUSET, STATS_COLLECTOR,
1031 gettext_noop("Collects timing statistics for database I/O activity."),
1040 {"update_process_title", PGC_SUSET, STATS_COLLECTOR,
1041 gettext_noop("Updates the process title to show the active SQL command."),
1042 gettext_noop("Enables updating of the process title every time a new SQL command is received by the server.")
1044 &update_process_title,
1050 {"autovacuum", PGC_SIGHUP, AUTOVACUUM,
1051 gettext_noop("Starts the autovacuum subprocess."),
1054 &autovacuum_start_daemon,
1060 {"trace_notify", PGC_USERSET, DEVELOPER_OPTIONS,
1061 gettext_noop("Generates debugging output for LISTEN and NOTIFY."),
1072 {"trace_locks", PGC_SUSET, DEVELOPER_OPTIONS,
1073 gettext_noop("No description available."),
1082 {"trace_userlocks", PGC_SUSET, DEVELOPER_OPTIONS,
1083 gettext_noop("No description available."),
1092 {"trace_lwlocks", PGC_SUSET, DEVELOPER_OPTIONS,
1093 gettext_noop("No description available."),
1102 {"debug_deadlocks", PGC_SUSET, DEVELOPER_OPTIONS,
1103 gettext_noop("No description available."),
1114 {"log_lock_waits", PGC_SUSET, LOGGING_WHAT,
1115 gettext_noop("Logs long lock waits."),
1124 {"log_hostname", PGC_SIGHUP, LOGGING_WHAT,
1125 gettext_noop("Logs the host name in the connection logs."),
1126 gettext_noop("By default, connection logs only show the IP address "
1127 "of the connecting host. If you want them to show the host name you "
1128 "can turn this on, but depending on your host name resolution "
1129 "setup it might impose a non-negligible performance penalty.")
1136 {"sql_inheritance", PGC_USERSET, COMPAT_OPTIONS_PREVIOUS,
1137 gettext_noop("Causes subtables to be included by default in various commands."),
1145 {"password_encryption", PGC_USERSET, CONN_AUTH_SECURITY,
1146 gettext_noop("Encrypt passwords."),
1147 gettext_noop("When a password is specified in CREATE USER or "
1148 "ALTER USER without writing either ENCRYPTED or UNENCRYPTED, "
1149 "this parameter determines whether the password is to be encrypted.")
1151 &Password_encryption,
1156 {"transform_null_equals", PGC_USERSET, COMPAT_OPTIONS_CLIENT,
1157 gettext_noop("Treats \"expr=NULL\" as \"expr IS NULL\"."),
1158 gettext_noop("When turned on, expressions of the form expr = NULL "
1159 "(or NULL = expr) are treated as expr IS NULL, that is, they "
1160 "return true if expr evaluates to the null value, and false "
1161 "otherwise. The correct behavior of expr = NULL is to always "
1162 "return null (unknown).")
1164 &Transform_null_equals,
1169 {"db_user_namespace", PGC_SIGHUP, CONN_AUTH_SECURITY,
1170 gettext_noop("Enables per-database user names."),
1178 /* only here for backwards compatibility */
1179 {"autocommit", PGC_USERSET, CLIENT_CONN_STATEMENT,
1180 gettext_noop("This parameter doesn't do anything."),
1181 gettext_noop("It's just here so that we won't choke on SET AUTOCOMMIT TO ON from 7.3-vintage clients."),
1182 GUC_NO_SHOW_ALL | GUC_NOT_IN_SAMPLE
1186 check_phony_autocommit, NULL, NULL
1189 {"default_transaction_read_only", PGC_USERSET, CLIENT_CONN_STATEMENT,
1190 gettext_noop("Sets the default read-only status of new transactions."),
1193 &DefaultXactReadOnly,
1198 {"transaction_read_only", PGC_USERSET, CLIENT_CONN_STATEMENT,
1199 gettext_noop("Sets the current transaction's read-only status."),
1201 GUC_NO_RESET_ALL | GUC_NOT_IN_SAMPLE | GUC_DISALLOW_IN_FILE
1205 check_transaction_read_only, NULL, NULL
1208 {"default_transaction_deferrable", PGC_USERSET, CLIENT_CONN_STATEMENT,
1209 gettext_noop("Sets the default deferrable status of new transactions."),
1212 &DefaultXactDeferrable,
1217 {"transaction_deferrable", PGC_USERSET, CLIENT_CONN_STATEMENT,
1218 gettext_noop("Whether to defer a read-only serializable transaction until it can be executed with no possible serialization failures."),
1220 GUC_NO_RESET_ALL | GUC_NOT_IN_SAMPLE | GUC_DISALLOW_IN_FILE
1224 check_transaction_deferrable, NULL, NULL
1227 {"check_function_bodies", PGC_USERSET, CLIENT_CONN_STATEMENT,
1228 gettext_noop("Check function bodies during CREATE FUNCTION."),
1231 &check_function_bodies,
1236 {"array_nulls", PGC_USERSET, COMPAT_OPTIONS_PREVIOUS,
1237 gettext_noop("Enable input of NULL elements in arrays."),
1238 gettext_noop("When turned on, unquoted NULL in an array input "
1239 "value means a null value; "
1240 "otherwise it is taken literally.")
1247 {"default_with_oids", PGC_USERSET, COMPAT_OPTIONS_PREVIOUS,
1248 gettext_noop("Create new tables with OIDs by default."),
1256 {"logging_collector", PGC_POSTMASTER, LOGGING_WHERE,
1257 gettext_noop("Start a subprocess to capture stderr output and/or csvlogs into log files."),
1265 {"log_truncate_on_rotation", PGC_SIGHUP, LOGGING_WHERE,
1266 gettext_noop("Truncate existing log files of same name during log rotation."),
1269 &Log_truncate_on_rotation,
1276 {"trace_sort", PGC_USERSET, DEVELOPER_OPTIONS,
1277 gettext_noop("Emit information about resource usage in sorting."),
1287 #ifdef TRACE_SYNCSCAN
1288 /* this is undocumented because not exposed in a standard build */
1290 {"trace_syncscan", PGC_USERSET, DEVELOPER_OPTIONS,
1291 gettext_noop("Generate debugging output for synchronized scanning."),
1301 #ifdef DEBUG_BOUNDED_SORT
1302 /* this is undocumented because not exposed in a standard build */
1305 "optimize_bounded_sort", PGC_USERSET, QUERY_TUNING_METHOD,
1306 gettext_noop("Enable bounded sorting using heap sort."),
1310 &optimize_bounded_sort,
1318 {"wal_debug", PGC_SUSET, DEVELOPER_OPTIONS,
1319 gettext_noop("Emit WAL-related debugging output."),
1330 {"integer_datetimes", PGC_INTERNAL, PRESET_OPTIONS,
1331 gettext_noop("Datetimes are integer based."),
1333 GUC_REPORT | GUC_NOT_IN_SAMPLE | GUC_DISALLOW_IN_FILE
1336 #ifdef HAVE_INT64_TIMESTAMP
1345 {"krb_caseins_users", PGC_SIGHUP, CONN_AUTH_SECURITY,
1346 gettext_noop("Sets whether Kerberos and GSSAPI user names should be treated as case-insensitive."),
1349 &pg_krb_caseins_users,
1355 {"escape_string_warning", PGC_USERSET, COMPAT_OPTIONS_PREVIOUS,
1356 gettext_noop("Warn about backslash escapes in ordinary string literals."),
1359 &escape_string_warning,
1365 {"standard_conforming_strings", PGC_USERSET, COMPAT_OPTIONS_PREVIOUS,
1366 gettext_noop("Causes '...' strings to treat backslashes literally."),
1370 &standard_conforming_strings,
1376 {"synchronize_seqscans", PGC_USERSET, COMPAT_OPTIONS_PREVIOUS,
1377 gettext_noop("Enable synchronized sequential scans."),
1380 &synchronize_seqscans,
1386 {"archive_mode", PGC_POSTMASTER, WAL_ARCHIVING,
1387 gettext_noop("Allows archiving of WAL files using archive_command."),
1396 {"hot_standby", PGC_POSTMASTER, REPLICATION_STANDBY,
1397 gettext_noop("Allows connections and queries during recovery."),
1406 {"hot_standby_feedback", PGC_SIGHUP, REPLICATION_STANDBY,
1407 gettext_noop("Allows feedback from a hot standby to the primary that will avoid query conflicts."),
1410 &hot_standby_feedback,
1416 {"allow_system_table_mods", PGC_POSTMASTER, DEVELOPER_OPTIONS,
1417 gettext_noop("Allows modifications of the structure of system tables."),
1421 &allowSystemTableMods,
1427 {"ignore_system_indexes", PGC_BACKEND, DEVELOPER_OPTIONS,
1428 gettext_noop("Disables reading from system indexes."),
1429 gettext_noop("It does not prevent updating the indexes, so it is safe "
1430 "to use. The worst consequence is slowness."),
1433 &IgnoreSystemIndexes,
1439 {"lo_compat_privileges", PGC_SUSET, COMPAT_OPTIONS_PREVIOUS,
1440 gettext_noop("Enables backward compatibility mode for privilege checks on large objects."),
1441 gettext_noop("Skips privilege checks when reading or modifying large objects, "
1442 "for compatibility with PostgreSQL releases prior to 9.0.")
1444 &lo_compat_privileges,
1450 {"quote_all_identifiers", PGC_USERSET, COMPAT_OPTIONS_PREVIOUS,
1451 gettext_noop("When generating SQL fragments, quote all identifiers."),
1454 "e_all_identifiers,
1459 /* End-of-list marker */
1461 {NULL, 0, 0, NULL, NULL}, NULL, false, NULL, NULL, NULL
1466 static struct config_int ConfigureNamesInt[] =
1469 {"archive_timeout", PGC_SIGHUP, WAL_ARCHIVING,
1470 gettext_noop("Forces a switch to the next xlog file if a "
1471 "new file has not been started within N seconds."),
1475 &XLogArchiveTimeout,
1480 {"post_auth_delay", PGC_BACKEND, DEVELOPER_OPTIONS,
1481 gettext_noop("Waits N seconds on connection startup after authentication."),
1482 gettext_noop("This allows attaching a debugger to the process."),
1483 GUC_NOT_IN_SAMPLE | GUC_UNIT_S
1486 0, 0, INT_MAX / 1000000,
1490 {"default_statistics_target", PGC_USERSET, QUERY_TUNING_OTHER,
1491 gettext_noop("Sets the default statistics target."),
1492 gettext_noop("This applies to table columns that have not had a "
1493 "column-specific target set via ALTER TABLE SET STATISTICS.")
1495 &default_statistics_target,
1500 {"from_collapse_limit", PGC_USERSET, QUERY_TUNING_OTHER,
1501 gettext_noop("Sets the FROM-list size beyond which subqueries "
1502 "are not collapsed."),
1503 gettext_noop("The planner will merge subqueries into upper "
1504 "queries if the resulting FROM list would have no more than "
1507 &from_collapse_limit,
1512 {"join_collapse_limit", PGC_USERSET, QUERY_TUNING_OTHER,
1513 gettext_noop("Sets the FROM-list size beyond which JOIN "
1514 "constructs are not flattened."),
1515 gettext_noop("The planner will flatten explicit JOIN "
1516 "constructs into lists of FROM items whenever a "
1517 "list of no more than this many items would result.")
1519 &join_collapse_limit,
1524 {"geqo_threshold", PGC_USERSET, QUERY_TUNING_GEQO,
1525 gettext_noop("Sets the threshold of FROM items beyond which GEQO is used."),
1533 {"geqo_effort", PGC_USERSET, QUERY_TUNING_GEQO,
1534 gettext_noop("GEQO: effort is used to set the default for other GEQO parameters."),
1538 DEFAULT_GEQO_EFFORT, MIN_GEQO_EFFORT, MAX_GEQO_EFFORT,
1542 {"geqo_pool_size", PGC_USERSET, QUERY_TUNING_GEQO,
1543 gettext_noop("GEQO: number of individuals in the population."),
1544 gettext_noop("Zero selects a suitable default value.")
1551 {"geqo_generations", PGC_USERSET, QUERY_TUNING_GEQO,
1552 gettext_noop("GEQO: number of iterations of the algorithm."),
1553 gettext_noop("Zero selects a suitable default value.")
1561 /* This is PGC_SUSET to prevent hiding from log_lock_waits. */
1562 {"deadlock_timeout", PGC_SUSET, LOCK_MANAGEMENT,
1563 gettext_noop("Sets the time to wait on a lock before checking for deadlock."),
1573 {"max_standby_archive_delay", PGC_SIGHUP, REPLICATION_STANDBY,
1574 gettext_noop("Sets the maximum delay before canceling queries when a hot standby server is processing archived WAL data."),
1578 &max_standby_archive_delay,
1579 30 * 1000, -1, INT_MAX,
1584 {"max_standby_streaming_delay", PGC_SIGHUP, REPLICATION_STANDBY,
1585 gettext_noop("Sets the maximum delay before canceling queries when a hot standby server is processing streamed WAL data."),
1589 &max_standby_streaming_delay,
1590 30 * 1000, -1, INT_MAX,
1595 {"wal_receiver_status_interval", PGC_SIGHUP, REPLICATION_STANDBY,
1596 gettext_noop("Sets the maximum interval between WAL receiver status reports to the primary."),
1600 &wal_receiver_status_interval,
1601 10, 0, INT_MAX / 1000,
1606 {"wal_receiver_timeout", PGC_SIGHUP, REPLICATION_STANDBY,
1607 gettext_noop("Sets the maximum wait time to receive data from master."),
1611 &wal_receiver_timeout,
1612 60 * 1000, 0, INT_MAX,
1617 {"max_connections", PGC_POSTMASTER, CONN_AUTH_SETTINGS,
1618 gettext_noop("Sets the maximum number of concurrent connections."),
1622 100, 1, MAX_BACKENDS,
1623 check_maxconnections, NULL, NULL
1627 {"superuser_reserved_connections", PGC_POSTMASTER, CONN_AUTH_SETTINGS,
1628 gettext_noop("Sets the number of connection slots reserved for superusers."),
1637 * We sometimes multiply the number of shared buffers by two without
1638 * checking for overflow, so we mustn't allow more than INT_MAX / 2.
1641 {"shared_buffers", PGC_POSTMASTER, RESOURCES_MEM,
1642 gettext_noop("Sets the number of shared memory buffers used by the server."),
1647 1024, 16, INT_MAX / 2,
1652 {"temp_buffers", PGC_USERSET, RESOURCES_MEM,
1653 gettext_noop("Sets the maximum number of temporary buffers used by each session."),
1658 1024, 100, INT_MAX / 2,
1659 check_temp_buffers, NULL, NULL
1663 {"port", PGC_POSTMASTER, CONN_AUTH_SETTINGS,
1664 gettext_noop("Sets the TCP port the server listens on."),
1668 DEF_PGPORT, 1, 65535,
1673 {"unix_socket_permissions", PGC_POSTMASTER, CONN_AUTH_SETTINGS,
1674 gettext_noop("Sets the access permissions of the Unix-domain socket."),
1675 gettext_noop("Unix-domain sockets use the usual Unix file system "
1676 "permission set. The parameter value is expected "
1677 "to be a numeric mode specification in the form "
1678 "accepted by the chmod and umask system calls. "
1679 "(To use the customary octal format the number must "
1680 "start with a 0 (zero).)")
1682 &Unix_socket_permissions,
1684 NULL, NULL, show_unix_socket_permissions
1688 {"log_file_mode", PGC_SIGHUP, LOGGING_WHERE,
1689 gettext_noop("Sets the file permissions for log files."),
1690 gettext_noop("The parameter value is expected "
1691 "to be a numeric mode specification in the form "
1692 "accepted by the chmod and umask system calls. "
1693 "(To use the customary octal format the number must "
1694 "start with a 0 (zero).)")
1698 NULL, NULL, show_log_file_mode
1702 {"work_mem", PGC_USERSET, RESOURCES_MEM,
1703 gettext_noop("Sets the maximum memory to be used for query workspaces."),
1704 gettext_noop("This much memory can be used by each internal "
1705 "sort operation and hash table before switching to "
1706 "temporary disk files."),
1710 1024, 64, MAX_KILOBYTES,
1715 {"maintenance_work_mem", PGC_USERSET, RESOURCES_MEM,
1716 gettext_noop("Sets the maximum memory to be used for maintenance operations."),
1717 gettext_noop("This includes operations such as VACUUM and CREATE INDEX."),
1720 &maintenance_work_mem,
1721 16384, 1024, MAX_KILOBYTES,
1726 * We use the hopefully-safely-small value of 100kB as the compiled-in
1727 * default for max_stack_depth. InitializeGUCOptions will increase it if
1728 * possible, depending on the actual platform-specific stack limit.
1731 {"max_stack_depth", PGC_SUSET, RESOURCES_MEM,
1732 gettext_noop("Sets the maximum stack depth, in kilobytes."),
1737 100, 100, MAX_KILOBYTES,
1738 check_max_stack_depth, assign_max_stack_depth, NULL
1742 {"temp_file_limit", PGC_SUSET, RESOURCES_DISK,
1743 gettext_noop("Limits the total size of all temporary files used by each session."),
1744 gettext_noop("-1 means no limit."),
1753 {"vacuum_cost_page_hit", PGC_USERSET, RESOURCES_VACUUM_DELAY,
1754 gettext_noop("Vacuum cost for a page found in the buffer cache."),
1763 {"vacuum_cost_page_miss", PGC_USERSET, RESOURCES_VACUUM_DELAY,
1764 gettext_noop("Vacuum cost for a page not found in the buffer cache."),
1767 &VacuumCostPageMiss,
1773 {"vacuum_cost_page_dirty", PGC_USERSET, RESOURCES_VACUUM_DELAY,
1774 gettext_noop("Vacuum cost for a page dirtied by vacuum."),
1777 &VacuumCostPageDirty,
1783 {"vacuum_cost_limit", PGC_USERSET, RESOURCES_VACUUM_DELAY,
1784 gettext_noop("Vacuum cost amount available before napping."),
1793 {"vacuum_cost_delay", PGC_USERSET, RESOURCES_VACUUM_DELAY,
1794 gettext_noop("Vacuum cost delay in milliseconds."),
1804 {"autovacuum_vacuum_cost_delay", PGC_SIGHUP, AUTOVACUUM,
1805 gettext_noop("Vacuum cost delay in milliseconds, for autovacuum."),
1809 &autovacuum_vac_cost_delay,
1815 {"autovacuum_vacuum_cost_limit", PGC_SIGHUP, AUTOVACUUM,
1816 gettext_noop("Vacuum cost amount available before napping, for autovacuum."),
1819 &autovacuum_vac_cost_limit,
1825 {"max_files_per_process", PGC_POSTMASTER, RESOURCES_KERNEL,
1826 gettext_noop("Sets the maximum number of simultaneously open files for each server process."),
1829 &max_files_per_process,
1835 * See also CheckRequiredParameterValues() if this parameter changes
1838 {"max_prepared_transactions", PGC_POSTMASTER, RESOURCES_MEM,
1839 gettext_noop("Sets the maximum number of simultaneously prepared transactions."),
1842 &max_prepared_xacts,
1849 {"trace_lock_oidmin", PGC_SUSET, DEVELOPER_OPTIONS,
1850 gettext_noop("No description available."),
1855 FirstNormalObjectId, 0, INT_MAX,
1859 {"trace_lock_table", PGC_SUSET, DEVELOPER_OPTIONS,
1860 gettext_noop("No description available."),
1871 {"statement_timeout", PGC_USERSET, CLIENT_CONN_STATEMENT,
1872 gettext_noop("Sets the maximum allowed duration of any statement."),
1873 gettext_noop("A value of 0 turns off the timeout."),
1882 {"lock_timeout", PGC_USERSET, CLIENT_CONN_STATEMENT,
1883 gettext_noop("Sets the maximum allowed duration of any wait for a lock."),
1884 gettext_noop("A value of 0 turns off the timeout."),
1893 {"vacuum_freeze_min_age", PGC_USERSET, CLIENT_CONN_STATEMENT,
1894 gettext_noop("Minimum age at which VACUUM should freeze a table row."),
1897 &vacuum_freeze_min_age,
1898 50000000, 0, 1000000000,
1903 {"vacuum_freeze_table_age", PGC_USERSET, CLIENT_CONN_STATEMENT,
1904 gettext_noop("Age at which VACUUM should scan whole table to freeze tuples."),
1907 &vacuum_freeze_table_age,
1908 150000000, 0, 2000000000,
1913 {"vacuum_defer_cleanup_age", PGC_SIGHUP, REPLICATION_MASTER,
1914 gettext_noop("Number of transactions by which VACUUM and HOT cleanup should be deferred, if any."),
1917 &vacuum_defer_cleanup_age,
1923 * See also CheckRequiredParameterValues() if this parameter changes
1926 {"max_locks_per_transaction", PGC_POSTMASTER, LOCK_MANAGEMENT,
1927 gettext_noop("Sets the maximum number of locks per transaction."),
1928 gettext_noop("The shared lock table is sized on the assumption that "
1929 "at most max_locks_per_transaction * max_connections distinct "
1930 "objects will need to be locked at any one time.")
1932 &max_locks_per_xact,
1938 {"max_pred_locks_per_transaction", PGC_POSTMASTER, LOCK_MANAGEMENT,
1939 gettext_noop("Sets the maximum number of predicate locks per transaction."),
1940 gettext_noop("The shared predicate lock table is sized on the assumption that "
1941 "at most max_pred_locks_per_transaction * max_connections distinct "
1942 "objects will need to be locked at any one time.")
1944 &max_predicate_locks_per_xact,
1950 {"authentication_timeout", PGC_SIGHUP, CONN_AUTH_SECURITY,
1951 gettext_noop("Sets the maximum allowed time to complete client authentication."),
1955 &AuthenticationTimeout,
1961 /* Not for general use */
1962 {"pre_auth_delay", PGC_SIGHUP, DEVELOPER_OPTIONS,
1963 gettext_noop("Waits N seconds on connection startup before authentication."),
1964 gettext_noop("This allows attaching a debugger to the process."),
1965 GUC_NOT_IN_SAMPLE | GUC_UNIT_S
1973 {"wal_keep_segments", PGC_SIGHUP, REPLICATION_SENDING,
1974 gettext_noop("Sets the number of WAL files held for standby servers."),
1983 {"checkpoint_segments", PGC_SIGHUP, WAL_CHECKPOINTS,
1984 gettext_noop("Sets the maximum distance in log segments between automatic WAL checkpoints."),
1987 &CheckPointSegments,
1993 {"checkpoint_timeout", PGC_SIGHUP, WAL_CHECKPOINTS,
1994 gettext_noop("Sets the maximum time between automatic WAL checkpoints."),
2004 {"checkpoint_warning", PGC_SIGHUP, WAL_CHECKPOINTS,
2005 gettext_noop("Enables warnings if checkpoint segments are filled more "
2006 "frequently than this."),
2007 gettext_noop("Write a message to the server log if checkpoints "
2008 "caused by the filling of checkpoint segment files happens more "
2009 "frequently than this number of seconds. Zero turns off the warning."),
2018 {"wal_buffers", PGC_POSTMASTER, WAL_SETTINGS,
2019 gettext_noop("Sets the number of disk-page buffers in shared memory for WAL."),
2025 check_wal_buffers, NULL, NULL
2029 {"wal_writer_delay", PGC_SIGHUP, WAL_SETTINGS,
2030 gettext_noop("WAL writer sleep time between WAL flushes."),
2040 /* see max_connections */
2041 {"max_wal_senders", PGC_POSTMASTER, REPLICATION_SENDING,
2042 gettext_noop("Sets the maximum number of simultaneously running WAL sender processes."),
2051 {"wal_sender_timeout", PGC_SIGHUP, REPLICATION_SENDING,
2052 gettext_noop("Sets the maximum time to wait for WAL replication."),
2056 &wal_sender_timeout,
2057 60 * 1000, 0, INT_MAX,
2062 {"commit_delay", PGC_SUSET, WAL_SETTINGS,
2063 gettext_noop("Sets the delay in microseconds between transaction commit and "
2064 "flushing WAL to disk."),
2066 /* we have no microseconds designation, so can't supply units here */
2074 {"commit_siblings", PGC_USERSET, WAL_SETTINGS,
2075 gettext_noop("Sets the minimum concurrent open transactions before performing "
2085 {"extra_float_digits", PGC_USERSET, CLIENT_CONN_LOCALE,
2086 gettext_noop("Sets the number of digits displayed for floating-point values."),
2087 gettext_noop("This affects real, double precision, and geometric data types. "
2088 "The parameter value is added to the standard number of digits "
2089 "(FLT_DIG or DBL_DIG as appropriate).")
2091 &extra_float_digits,
2097 {"log_min_duration_statement", PGC_SUSET, LOGGING_WHEN,
2098 gettext_noop("Sets the minimum execution time above which "
2099 "statements will be logged."),
2100 gettext_noop("Zero prints all queries. -1 turns this feature off."),
2103 &log_min_duration_statement,
2109 {"log_autovacuum_min_duration", PGC_SIGHUP, LOGGING_WHAT,
2110 gettext_noop("Sets the minimum execution time above which "
2111 "autovacuum actions will be logged."),
2112 gettext_noop("Zero prints all actions. -1 turns autovacuum logging off."),
2115 &Log_autovacuum_min_duration,
2121 {"bgwriter_delay", PGC_SIGHUP, RESOURCES_BGWRITER,
2122 gettext_noop("Background writer sleep time between rounds."),
2132 {"bgwriter_lru_maxpages", PGC_SIGHUP, RESOURCES_BGWRITER,
2133 gettext_noop("Background writer maximum number of LRU pages to flush per round."),
2136 &bgwriter_lru_maxpages,
2142 {"effective_io_concurrency",
2148 RESOURCES_ASYNCHRONOUS,
2149 gettext_noop("Number of simultaneous requests that can be handled efficiently by the disk subsystem."),
2150 gettext_noop("For RAID arrays, this should be approximately the number of drive spindles in the array.")
2152 &effective_io_concurrency,
2158 check_effective_io_concurrency, assign_effective_io_concurrency, NULL
2162 {"log_rotation_age", PGC_SIGHUP, LOGGING_WHERE,
2163 gettext_noop("Automatic log file rotation will occur after N minutes."),
2168 HOURS_PER_DAY * MINS_PER_HOUR, 0, INT_MAX / SECS_PER_MINUTE,
2173 {"log_rotation_size", PGC_SIGHUP, LOGGING_WHERE,
2174 gettext_noop("Automatic log file rotation will occur after N kilobytes."),
2179 10 * 1024, 0, INT_MAX / 1024,
2184 {"max_function_args", PGC_INTERNAL, PRESET_OPTIONS,
2185 gettext_noop("Shows the maximum number of function arguments."),
2187 GUC_NOT_IN_SAMPLE | GUC_DISALLOW_IN_FILE
2190 FUNC_MAX_ARGS, FUNC_MAX_ARGS, FUNC_MAX_ARGS,
2195 {"max_index_keys", PGC_INTERNAL, PRESET_OPTIONS,
2196 gettext_noop("Shows the maximum number of index keys."),
2198 GUC_NOT_IN_SAMPLE | GUC_DISALLOW_IN_FILE
2201 INDEX_MAX_KEYS, INDEX_MAX_KEYS, INDEX_MAX_KEYS,
2206 {"max_identifier_length", PGC_INTERNAL, PRESET_OPTIONS,
2207 gettext_noop("Shows the maximum identifier length."),
2209 GUC_NOT_IN_SAMPLE | GUC_DISALLOW_IN_FILE
2211 &max_identifier_length,
2212 NAMEDATALEN - 1, NAMEDATALEN - 1, NAMEDATALEN - 1,
2217 {"block_size", PGC_INTERNAL, PRESET_OPTIONS,
2218 gettext_noop("Shows the size of a disk block."),
2220 GUC_NOT_IN_SAMPLE | GUC_DISALLOW_IN_FILE
2223 BLCKSZ, BLCKSZ, BLCKSZ,
2228 {"segment_size", PGC_INTERNAL, PRESET_OPTIONS,
2229 gettext_noop("Shows the number of pages per disk file."),
2231 GUC_UNIT_BLOCKS | GUC_NOT_IN_SAMPLE | GUC_DISALLOW_IN_FILE
2234 RELSEG_SIZE, RELSEG_SIZE, RELSEG_SIZE,
2239 {"wal_block_size", PGC_INTERNAL, PRESET_OPTIONS,
2240 gettext_noop("Shows the block size in the write ahead log."),
2242 GUC_NOT_IN_SAMPLE | GUC_DISALLOW_IN_FILE
2245 XLOG_BLCKSZ, XLOG_BLCKSZ, XLOG_BLCKSZ,
2250 {"wal_segment_size", PGC_INTERNAL, PRESET_OPTIONS,
2251 gettext_noop("Shows the number of pages per write ahead log segment."),
2253 GUC_UNIT_XBLOCKS | GUC_NOT_IN_SAMPLE | GUC_DISALLOW_IN_FILE
2256 (XLOG_SEG_SIZE / XLOG_BLCKSZ),
2257 (XLOG_SEG_SIZE / XLOG_BLCKSZ),
2258 (XLOG_SEG_SIZE / XLOG_BLCKSZ),
2263 {"autovacuum_naptime", PGC_SIGHUP, AUTOVACUUM,
2264 gettext_noop("Time to sleep between autovacuum runs."),
2268 &autovacuum_naptime,
2269 60, 1, INT_MAX / 1000,
2273 {"autovacuum_vacuum_threshold", PGC_SIGHUP, AUTOVACUUM,
2274 gettext_noop("Minimum number of tuple updates or deletes prior to vacuum."),
2277 &autovacuum_vac_thresh,
2282 {"autovacuum_analyze_threshold", PGC_SIGHUP, AUTOVACUUM,
2283 gettext_noop("Minimum number of tuple inserts, updates, or deletes prior to analyze."),
2286 &autovacuum_anl_thresh,
2291 /* see varsup.c for why this is PGC_POSTMASTER not PGC_SIGHUP */
2292 {"autovacuum_freeze_max_age", PGC_POSTMASTER, AUTOVACUUM,
2293 gettext_noop("Age at which to autovacuum a table to prevent transaction ID wraparound."),
2296 &autovacuum_freeze_max_age,
2297 /* see pg_resetxlog if you change the upper-limit value */
2298 200000000, 100000000, 2000000000,
2302 /* see max_connections */
2303 {"autovacuum_max_workers", PGC_POSTMASTER, AUTOVACUUM,
2304 gettext_noop("Sets the maximum number of simultaneously running autovacuum worker processes."),
2307 &autovacuum_max_workers,
2309 check_autovacuum_max_workers, NULL, NULL
2313 {"tcp_keepalives_idle", PGC_USERSET, CLIENT_CONN_OTHER,
2314 gettext_noop("Time between issuing TCP keepalives."),
2315 gettext_noop("A value of 0 uses the system default."),
2318 &tcp_keepalives_idle,
2320 NULL, assign_tcp_keepalives_idle, show_tcp_keepalives_idle
2324 {"tcp_keepalives_interval", PGC_USERSET, CLIENT_CONN_OTHER,
2325 gettext_noop("Time between TCP keepalive retransmits."),
2326 gettext_noop("A value of 0 uses the system default."),
2329 &tcp_keepalives_interval,
2331 NULL, assign_tcp_keepalives_interval, show_tcp_keepalives_interval
2335 {"ssl_renegotiation_limit", PGC_USERSET, CONN_AUTH_SECURITY,
2336 gettext_noop("Set the amount of traffic to send and receive before renegotiating the encryption keys."),
2340 &ssl_renegotiation_limit,
2341 512 * 1024, 0, MAX_KILOBYTES,
2346 {"tcp_keepalives_count", PGC_USERSET, CLIENT_CONN_OTHER,
2347 gettext_noop("Maximum number of TCP keepalive retransmits."),
2348 gettext_noop("This controls the number of consecutive keepalive retransmits that can be "
2349 "lost before a connection is considered dead. A value of 0 uses the "
2352 &tcp_keepalives_count,
2354 NULL, assign_tcp_keepalives_count, show_tcp_keepalives_count
2358 {"gin_fuzzy_search_limit", PGC_USERSET, CLIENT_CONN_OTHER,
2359 gettext_noop("Sets the maximum allowed result for exact search by GIN."),
2363 &GinFuzzySearchLimit,
2369 {"effective_cache_size", PGC_USERSET, QUERY_TUNING_COST,
2370 gettext_noop("Sets the planner's assumption about the size of the disk cache."),
2371 gettext_noop("That is, the portion of the kernel's disk cache that "
2372 "will be used for PostgreSQL data files. This is measured in disk "
2373 "pages, which are normally 8 kB each."),
2376 &effective_cache_size,
2377 DEFAULT_EFFECTIVE_CACHE_SIZE, 1, INT_MAX,
2382 /* Can't be set in postgresql.conf */
2383 {"server_version_num", PGC_INTERNAL, PRESET_OPTIONS,
2384 gettext_noop("Shows the server version as an integer."),
2386 GUC_NOT_IN_SAMPLE | GUC_DISALLOW_IN_FILE
2388 &server_version_num,
2389 PG_VERSION_NUM, PG_VERSION_NUM, PG_VERSION_NUM,
2394 {"log_temp_files", PGC_SUSET, LOGGING_WHAT,
2395 gettext_noop("Log the use of temporary files larger than this number of kilobytes."),
2396 gettext_noop("Zero logs all files. The default is -1 (turning this feature off)."),
2405 {"track_activity_query_size", PGC_POSTMASTER, RESOURCES_MEM,
2406 gettext_noop("Sets the size reserved for pg_stat_activity.query, in bytes."),
2409 &pgstat_track_activity_query_size,
2414 /* End-of-list marker */
2416 {NULL, 0, 0, NULL, NULL}, NULL, 0, 0, 0, NULL, NULL, NULL
2421 static struct config_real ConfigureNamesReal[] =
2424 {"seq_page_cost", PGC_USERSET, QUERY_TUNING_COST,
2425 gettext_noop("Sets the planner's estimate of the cost of a "
2426 "sequentially fetched disk page."),
2430 DEFAULT_SEQ_PAGE_COST, 0, DBL_MAX,
2434 {"random_page_cost", PGC_USERSET, QUERY_TUNING_COST,
2435 gettext_noop("Sets the planner's estimate of the cost of a "
2436 "nonsequentially fetched disk page."),
2440 DEFAULT_RANDOM_PAGE_COST, 0, DBL_MAX,
2444 {"cpu_tuple_cost", PGC_USERSET, QUERY_TUNING_COST,
2445 gettext_noop("Sets the planner's estimate of the cost of "
2446 "processing each tuple (row)."),
2450 DEFAULT_CPU_TUPLE_COST, 0, DBL_MAX,
2454 {"cpu_index_tuple_cost", PGC_USERSET, QUERY_TUNING_COST,
2455 gettext_noop("Sets the planner's estimate of the cost of "
2456 "processing each index entry during an index scan."),
2459 &cpu_index_tuple_cost,
2460 DEFAULT_CPU_INDEX_TUPLE_COST, 0, DBL_MAX,
2464 {"cpu_operator_cost", PGC_USERSET, QUERY_TUNING_COST,
2465 gettext_noop("Sets the planner's estimate of the cost of "
2466 "processing each operator or function call."),
2470 DEFAULT_CPU_OPERATOR_COST, 0, DBL_MAX,
2475 {"cursor_tuple_fraction", PGC_USERSET, QUERY_TUNING_OTHER,
2476 gettext_noop("Sets the planner's estimate of the fraction of "
2477 "a cursor's rows that will be retrieved."),
2480 &cursor_tuple_fraction,
2481 DEFAULT_CURSOR_TUPLE_FRACTION, 0.0, 1.0,
2486 {"geqo_selection_bias", PGC_USERSET, QUERY_TUNING_GEQO,
2487 gettext_noop("GEQO: selective pressure within the population."),
2490 &Geqo_selection_bias,
2491 DEFAULT_GEQO_SELECTION_BIAS,
2492 MIN_GEQO_SELECTION_BIAS, MAX_GEQO_SELECTION_BIAS,
2496 {"geqo_seed", PGC_USERSET, QUERY_TUNING_GEQO,
2497 gettext_noop("GEQO: seed for random path selection."),
2506 {"bgwriter_lru_multiplier", PGC_SIGHUP, RESOURCES_BGWRITER,
2507 gettext_noop("Multiple of the average buffer usage to free per round."),
2510 &bgwriter_lru_multiplier,
2516 {"seed", PGC_USERSET, UNGROUPED,
2517 gettext_noop("Sets the seed for random-number generation."),
2519 GUC_NO_SHOW_ALL | GUC_NO_RESET_ALL | GUC_NOT_IN_SAMPLE | GUC_DISALLOW_IN_FILE
2523 check_random_seed, assign_random_seed, show_random_seed
2527 {"autovacuum_vacuum_scale_factor", PGC_SIGHUP, AUTOVACUUM,
2528 gettext_noop("Number of tuple updates or deletes prior to vacuum as a fraction of reltuples."),
2531 &autovacuum_vac_scale,
2536 {"autovacuum_analyze_scale_factor", PGC_SIGHUP, AUTOVACUUM,
2537 gettext_noop("Number of tuple inserts, updates, or deletes prior to analyze as a fraction of reltuples."),
2540 &autovacuum_anl_scale,
2546 {"checkpoint_completion_target", PGC_SIGHUP, WAL_CHECKPOINTS,
2547 gettext_noop("Time spent flushing dirty buffers during checkpoint, as fraction of checkpoint interval."),
2550 &CheckPointCompletionTarget,
2555 /* End-of-list marker */
2557 {NULL, 0, 0, NULL, NULL}, NULL, 0.0, 0.0, 0.0, NULL, NULL, NULL
2562 static struct config_string ConfigureNamesString[] =
2565 {"archive_command", PGC_SIGHUP, WAL_ARCHIVING,
2566 gettext_noop("Sets the shell command that will be called to archive a WAL file."),
2569 &XLogArchiveCommand,
2571 NULL, NULL, show_archive_command
2575 {"client_encoding", PGC_USERSET, CLIENT_CONN_LOCALE,
2576 gettext_noop("Sets the client's character set encoding."),
2578 GUC_IS_NAME | GUC_REPORT
2580 &client_encoding_string,
2582 check_client_encoding, assign_client_encoding, NULL
2586 {"log_line_prefix", PGC_SIGHUP, LOGGING_WHAT,
2587 gettext_noop("Controls information prefixed to each log line."),
2588 gettext_noop("If blank, no prefix is used.")
2596 {"log_timezone", PGC_SIGHUP, LOGGING_WHAT,
2597 gettext_noop("Sets the time zone to use in log messages."),
2600 &log_timezone_string,
2602 check_log_timezone, assign_log_timezone, show_log_timezone
2606 {"DateStyle", PGC_USERSET, CLIENT_CONN_LOCALE,
2607 gettext_noop("Sets the display format for date and time values."),
2608 gettext_noop("Also controls interpretation of ambiguous "
2610 GUC_LIST_INPUT | GUC_REPORT
2614 check_datestyle, assign_datestyle, NULL
2618 {"default_tablespace", PGC_USERSET, CLIENT_CONN_STATEMENT,
2619 gettext_noop("Sets the default tablespace to create tables and indexes in."),
2620 gettext_noop("An empty string selects the database's default tablespace."),
2623 &default_tablespace,
2625 check_default_tablespace, NULL, NULL
2629 {"temp_tablespaces", PGC_USERSET, CLIENT_CONN_STATEMENT,
2630 gettext_noop("Sets the tablespace(s) to use for temporary tables and sort files."),
2632 GUC_LIST_INPUT | GUC_LIST_QUOTE
2636 check_temp_tablespaces, assign_temp_tablespaces, NULL
2640 {"dynamic_library_path", PGC_SUSET, CLIENT_CONN_OTHER,
2641 gettext_noop("Sets the path for dynamically loadable modules."),
2642 gettext_noop("If a dynamically loadable module needs to be opened and "
2643 "the specified name does not have a directory component (i.e., the "
2644 "name does not contain a slash), the system will search this path for "
2645 "the specified file."),
2648 &Dynamic_library_path,
2654 {"krb_server_keyfile", PGC_SIGHUP, CONN_AUTH_SECURITY,
2655 gettext_noop("Sets the location of the Kerberos server key file."),
2659 &pg_krb_server_keyfile,
2665 {"krb_srvname", PGC_SIGHUP, CONN_AUTH_SECURITY,
2666 gettext_noop("Sets the name of the Kerberos service."),
2675 {"bonjour_name", PGC_POSTMASTER, CONN_AUTH_SETTINGS,
2676 gettext_noop("Sets the Bonjour service name."),
2684 /* See main.c about why defaults for LC_foo are not all alike */
2687 {"lc_collate", PGC_INTERNAL, CLIENT_CONN_LOCALE,
2688 gettext_noop("Shows the collation order locale."),
2690 GUC_NOT_IN_SAMPLE | GUC_DISALLOW_IN_FILE
2698 {"lc_ctype", PGC_INTERNAL, CLIENT_CONN_LOCALE,
2699 gettext_noop("Shows the character classification and case conversion locale."),
2701 GUC_NOT_IN_SAMPLE | GUC_DISALLOW_IN_FILE
2709 {"lc_messages", PGC_SUSET, CLIENT_CONN_LOCALE,
2710 gettext_noop("Sets the language in which messages are displayed."),
2715 check_locale_messages, assign_locale_messages, NULL
2719 {"lc_monetary", PGC_USERSET, CLIENT_CONN_LOCALE,
2720 gettext_noop("Sets the locale for formatting monetary amounts."),
2725 check_locale_monetary, assign_locale_monetary, NULL
2729 {"lc_numeric", PGC_USERSET, CLIENT_CONN_LOCALE,
2730 gettext_noop("Sets the locale for formatting numbers."),
2735 check_locale_numeric, assign_locale_numeric, NULL
2739 {"lc_time", PGC_USERSET, CLIENT_CONN_LOCALE,
2740 gettext_noop("Sets the locale for formatting date and time values."),
2745 check_locale_time, assign_locale_time, NULL
2749 {"shared_preload_libraries", PGC_POSTMASTER, RESOURCES_KERNEL,
2750 gettext_noop("Lists shared libraries to preload into server."),
2752 GUC_LIST_INPUT | GUC_LIST_QUOTE | GUC_SUPERUSER_ONLY
2754 &shared_preload_libraries_string,
2760 {"local_preload_libraries", PGC_BACKEND, CLIENT_CONN_OTHER,
2761 gettext_noop("Lists shared libraries to preload into each backend."),
2763 GUC_LIST_INPUT | GUC_LIST_QUOTE
2765 &local_preload_libraries_string,
2771 {"search_path", PGC_USERSET, CLIENT_CONN_STATEMENT,
2772 gettext_noop("Sets the schema search order for names that are not schema-qualified."),
2774 GUC_LIST_INPUT | GUC_LIST_QUOTE
2776 &namespace_search_path,
2778 check_search_path, assign_search_path, NULL
2782 /* Can't be set in postgresql.conf */
2783 {"server_encoding", PGC_INTERNAL, CLIENT_CONN_LOCALE,
2784 gettext_noop("Sets the server (database) character set encoding."),
2786 GUC_IS_NAME | GUC_REPORT | GUC_NOT_IN_SAMPLE | GUC_DISALLOW_IN_FILE
2788 &server_encoding_string,
2794 /* Can't be set in postgresql.conf */
2795 {"server_version", PGC_INTERNAL, PRESET_OPTIONS,
2796 gettext_noop("Shows the server version."),
2798 GUC_REPORT | GUC_NOT_IN_SAMPLE | GUC_DISALLOW_IN_FILE
2800 &server_version_string,
2806 /* Not for general use --- used by SET ROLE */
2807 {"role", PGC_USERSET, UNGROUPED,
2808 gettext_noop("Sets the current role."),
2810 GUC_IS_NAME | GUC_NO_SHOW_ALL | GUC_NO_RESET_ALL | GUC_NOT_IN_SAMPLE | GUC_DISALLOW_IN_FILE | GUC_NOT_WHILE_SEC_REST
2814 check_role, assign_role, show_role
2818 /* Not for general use --- used by SET SESSION AUTHORIZATION */
2819 {"session_authorization", PGC_USERSET, UNGROUPED,
2820 gettext_noop("Sets the session user name."),
2822 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
2824 &session_authorization_string,
2826 check_session_authorization, assign_session_authorization, NULL
2830 {"log_destination", PGC_SIGHUP, LOGGING_WHERE,
2831 gettext_noop("Sets the destination for server log output."),
2832 gettext_noop("Valid values are combinations of \"stderr\", "
2833 "\"syslog\", \"csvlog\", and \"eventlog\", "
2834 "depending on the platform."),
2837 &log_destination_string,
2839 check_log_destination, assign_log_destination, NULL
2842 {"log_directory", PGC_SIGHUP, LOGGING_WHERE,
2843 gettext_noop("Sets the destination directory for log files."),
2844 gettext_noop("Can be specified as relative to the data directory "
2845 "or as absolute path."),
2850 check_canonical_path, NULL, NULL
2853 {"log_filename", PGC_SIGHUP, LOGGING_WHERE,
2854 gettext_noop("Sets the file name pattern for log files."),
2859 "postgresql-%Y-%m-%d_%H%M%S.log",
2864 {"syslog_ident", PGC_SIGHUP, LOGGING_WHERE,
2865 gettext_noop("Sets the program name used to identify PostgreSQL "
2866 "messages in syslog."),
2871 NULL, assign_syslog_ident, NULL
2875 {"event_source", PGC_POSTMASTER, LOGGING_WHERE,
2876 gettext_noop("Sets the application name used to identify "
2877 "PostgreSQL messages in the event log."),
2886 {"TimeZone", PGC_USERSET, CLIENT_CONN_LOCALE,
2887 gettext_noop("Sets the time zone for displaying and interpreting time stamps."),
2893 check_timezone, assign_timezone, show_timezone
2896 {"timezone_abbreviations", PGC_USERSET, CLIENT_CONN_LOCALE,
2897 gettext_noop("Selects a file of time zone abbreviations."),
2900 &timezone_abbreviations_string,
2902 check_timezone_abbreviations, assign_timezone_abbreviations, NULL
2906 {"transaction_isolation", PGC_USERSET, CLIENT_CONN_STATEMENT,
2907 gettext_noop("Sets the current transaction's isolation level."),
2909 GUC_NO_RESET_ALL | GUC_NOT_IN_SAMPLE | GUC_DISALLOW_IN_FILE
2911 &XactIsoLevel_string,
2913 check_XactIsoLevel, assign_XactIsoLevel, show_XactIsoLevel
2917 {"unix_socket_group", PGC_POSTMASTER, CONN_AUTH_SETTINGS,
2918 gettext_noop("Sets the owning group of the Unix-domain socket."),
2919 gettext_noop("The owning user of the socket is always the user "
2920 "that starts the server.")
2928 {"unix_socket_directories", PGC_POSTMASTER, CONN_AUTH_SETTINGS,
2929 gettext_noop("Sets the directories where Unix-domain sockets will be created."),
2933 &Unix_socket_directories,
2934 #ifdef HAVE_UNIX_SOCKETS
2935 DEFAULT_PGSOCKET_DIR,
2943 {"listen_addresses", PGC_POSTMASTER, CONN_AUTH_SETTINGS,
2944 gettext_noop("Sets the host name or IP address(es) to listen to."),
2954 {"data_directory", PGC_POSTMASTER, FILE_LOCATIONS,
2955 gettext_noop("Sets the server's data directory."),
2965 {"recovery_config_directory", PGC_POSTMASTER, FILE_LOCATIONS,
2966 gettext_noop("Sets the server's recovery configuration directory."),
2970 &recovery_config_directory,
2976 {"config_file", PGC_POSTMASTER, FILE_LOCATIONS,
2977 gettext_noop("Sets the server's main configuration file."),
2979 GUC_DISALLOW_IN_FILE | GUC_SUPERUSER_ONLY
2987 {"hba_file", PGC_POSTMASTER, FILE_LOCATIONS,
2988 gettext_noop("Sets the server's \"hba\" configuration file."),
2998 {"ident_file", PGC_POSTMASTER, FILE_LOCATIONS,
2999 gettext_noop("Sets the server's \"ident\" configuration file."),
3009 {"external_pid_file", PGC_POSTMASTER, FILE_LOCATIONS,
3010 gettext_noop("Writes the postmaster PID to the specified file."),
3016 check_canonical_path, NULL, NULL
3020 {"ssl_cert_file", PGC_POSTMASTER, CONN_AUTH_SECURITY,
3021 gettext_noop("Location of the SSL server certificate file."),
3030 {"ssl_key_file", PGC_POSTMASTER, CONN_AUTH_SECURITY,
3031 gettext_noop("Location of the SSL server private key file."),
3040 {"ssl_ca_file", PGC_POSTMASTER, CONN_AUTH_SECURITY,
3041 gettext_noop("Location of the SSL certificate authority file."),
3050 {"ssl_crl_file", PGC_POSTMASTER, CONN_AUTH_SECURITY,
3051 gettext_noop("Location of the SSL certificate revocation list file."),
3060 {"stats_temp_directory", PGC_SIGHUP, STATS_COLLECTOR,
3061 gettext_noop("Writes temporary statistics files to the specified directory."),
3065 &pgstat_temp_directory,
3067 check_canonical_path, assign_pgstat_temp_directory, NULL
3071 {"synchronous_standby_names", PGC_SIGHUP, REPLICATION_MASTER,
3072 gettext_noop("List of names of potential synchronous standbys."),
3076 &SyncRepStandbyNames,
3078 check_synchronous_standby_names, NULL, NULL
3082 {"default_text_search_config", PGC_USERSET, CLIENT_CONN_LOCALE,
3083 gettext_noop("Sets default text search configuration."),
3087 "pg_catalog.simple",
3088 check_TSCurrentConfig, assign_TSCurrentConfig, NULL
3092 {"ssl_ciphers", PGC_POSTMASTER, CONN_AUTH_SECURITY,
3093 gettext_noop("Sets the list of allowed SSL ciphers."),
3099 "DEFAULT:!LOW:!EXP:!MD5:@STRENGTH",
3107 {"application_name", PGC_USERSET, LOGGING_WHAT,
3108 gettext_noop("Sets the application name to be reported in statistics and logs."),
3110 GUC_IS_NAME | GUC_REPORT | GUC_NOT_IN_SAMPLE
3114 check_application_name, assign_application_name, NULL
3117 /* End-of-list marker */
3119 {NULL, 0, 0, NULL, NULL}, NULL, NULL, NULL, NULL, NULL
3124 static struct config_enum ConfigureNamesEnum[] =
3127 {"backslash_quote", PGC_USERSET, COMPAT_OPTIONS_PREVIOUS,
3128 gettext_noop("Sets whether \"\\'\" is allowed in string literals."),
3132 BACKSLASH_QUOTE_SAFE_ENCODING, backslash_quote_options,
3137 {"bytea_output", PGC_USERSET, CLIENT_CONN_STATEMENT,
3138 gettext_noop("Sets the output format for bytea."),
3142 BYTEA_OUTPUT_HEX, bytea_output_options,
3147 {"client_min_messages", PGC_USERSET, LOGGING_WHEN,
3148 gettext_noop("Sets the message levels that are sent to the client."),
3149 gettext_noop("Each level includes all the levels that follow it. The later"
3150 " the level, the fewer messages are sent.")
3152 &client_min_messages,
3153 NOTICE, client_message_level_options,
3158 {"constraint_exclusion", PGC_USERSET, QUERY_TUNING_OTHER,
3159 gettext_noop("Enables the planner to use constraints to optimize queries."),
3160 gettext_noop("Table scans will be skipped if their constraints"
3161 " guarantee that no rows match the query.")
3163 &constraint_exclusion,
3164 CONSTRAINT_EXCLUSION_PARTITION, constraint_exclusion_options,
3169 {"default_transaction_isolation", PGC_USERSET, CLIENT_CONN_STATEMENT,
3170 gettext_noop("Sets the transaction isolation level of each new transaction."),
3173 &DefaultXactIsoLevel,
3174 XACT_READ_COMMITTED, isolation_level_options,
3179 {"IntervalStyle", PGC_USERSET, CLIENT_CONN_LOCALE,
3180 gettext_noop("Sets the display format for interval values."),
3185 INTSTYLE_POSTGRES, intervalstyle_options,
3190 {"log_error_verbosity", PGC_SUSET, LOGGING_WHAT,
3191 gettext_noop("Sets the verbosity of logged messages."),
3194 &Log_error_verbosity,
3195 PGERROR_DEFAULT, log_error_verbosity_options,
3200 {"log_min_messages", PGC_SUSET, LOGGING_WHEN,
3201 gettext_noop("Sets the message levels that are logged."),
3202 gettext_noop("Each level includes all the levels that follow it. The later"
3203 " the level, the fewer messages are sent.")
3206 WARNING, server_message_level_options,
3211 {"log_min_error_statement", PGC_SUSET, LOGGING_WHEN,
3212 gettext_noop("Causes all statements generating error at or above this level to be logged."),
3213 gettext_noop("Each level includes all the levels that follow it. The later"
3214 " the level, the fewer messages are sent.")
3216 &log_min_error_statement,
3217 ERROR, server_message_level_options,
3222 {"log_statement", PGC_SUSET, LOGGING_WHAT,
3223 gettext_noop("Sets the type of statements logged."),
3227 LOGSTMT_NONE, log_statement_options,
3232 {"syslog_facility", PGC_SIGHUP, LOGGING_WHERE,
3233 gettext_noop("Sets the syslog \"facility\" to be used when syslog enabled."),
3242 syslog_facility_options,
3243 NULL, assign_syslog_facility, NULL
3247 {"session_replication_role", PGC_SUSET, CLIENT_CONN_STATEMENT,
3248 gettext_noop("Sets the session's behavior for triggers and rewrite rules."),
3251 &SessionReplicationRole,
3252 SESSION_REPLICATION_ROLE_ORIGIN, session_replication_role_options,
3253 NULL, assign_session_replication_role, NULL
3257 {"synchronous_commit", PGC_USERSET, WAL_SETTINGS,
3258 gettext_noop("Sets the current transaction's synchronization level."),
3261 &synchronous_commit,
3262 SYNCHRONOUS_COMMIT_ON, synchronous_commit_options,
3263 NULL, assign_synchronous_commit, NULL
3267 {"trace_recovery_messages", PGC_SIGHUP, DEVELOPER_OPTIONS,
3268 gettext_noop("Enables logging of recovery-related debugging information."),
3269 gettext_noop("Each level includes all the levels that follow it. The later"
3270 " the level, the fewer messages are sent.")
3272 &trace_recovery_messages,
3275 * client_message_level_options allows too many values, really, but
3276 * it's not worth having a separate options array for this.
3278 LOG, client_message_level_options,
3283 {"track_functions", PGC_SUSET, STATS_COLLECTOR,
3284 gettext_noop("Collects function-level statistics on database activity."),
3287 &pgstat_track_functions,
3288 TRACK_FUNC_OFF, track_function_options,
3293 {"wal_level", PGC_POSTMASTER, WAL_SETTINGS,
3294 gettext_noop("Set the level of information written to the WAL."),
3298 WAL_LEVEL_MINIMAL, wal_level_options,
3303 {"wal_sync_method", PGC_SIGHUP, WAL_SETTINGS,
3304 gettext_noop("Selects the method used for forcing WAL updates to disk."),
3308 DEFAULT_SYNC_METHOD, sync_method_options,
3309 NULL, assign_xlog_sync_method, NULL
3313 {"xmlbinary", PGC_USERSET, CLIENT_CONN_STATEMENT,
3314 gettext_noop("Sets how binary values are to be encoded in XML."),
3318 XMLBINARY_BASE64, xmlbinary_options,
3323 {"xmloption", PGC_USERSET, CLIENT_CONN_STATEMENT,
3324 gettext_noop("Sets whether XML data in implicit parsing and serialization "
3325 "operations is to be considered as documents or content fragments."),
3329 XMLOPTION_CONTENT, xmloption_options,
3334 /* End-of-list marker */
3336 {NULL, 0, 0, NULL, NULL}, NULL, 0, NULL, NULL, NULL, NULL
3340 /******** end of options list ********/
3344 * To allow continued support of obsolete names for GUC variables, we apply
3345 * the following mappings to any unrecognized name. Note that an old name
3346 * should be mapped to a new one only if the new variable has very similar
3347 * semantics to the old.
3349 static const char *const map_old_guc_names[] = {
3350 "sort_mem", "work_mem",
3351 "vacuum_mem", "maintenance_work_mem",
3357 * Actual lookup of variables is done through this single, sorted array.
3359 static struct config_generic **guc_variables;
3361 /* Current number of variables contained in the vector */
3362 static int num_guc_variables;
3364 /* Vector capacity */
3365 static int size_guc_variables;
3368 static bool guc_dirty; /* TRUE if need to do commit/abort work */
3370 static bool reporting_enabled; /* TRUE to enable GUC_REPORT */
3372 static int GUCNestLevel = 0; /* 1 when in main transaction */
3375 static int guc_var_compare(const void *a, const void *b);
3376 static int guc_name_compare(const char *namea, const char *nameb);
3377 static void InitializeGUCOptionsFromEnvironment(void);
3378 static void InitializeOneGUCOption(struct config_generic * gconf);
3379 static void push_old_value(struct config_generic * gconf, GucAction action);
3380 static void ReportGUCOption(struct config_generic * record);
3381 static void reapply_stacked_values(struct config_generic * variable,
3382 struct config_string * pHolder,
3384 const char *curvalue,
3385 GucContext curscontext, GucSource cursource);
3386 static void ShowGUCConfigOption(const char *name, DestReceiver *dest);
3387 static void ShowAllGUCConfig(DestReceiver *dest);
3388 static char *_ShowOption(struct config_generic * record, bool use_units);
3389 static bool validate_option_array_item(const char *name, const char *value,
3390 bool skipIfNoPermissions);
3394 * Some infrastructure for checking malloc/strdup/realloc calls
3397 guc_malloc(int elevel, size_t size)
3401 /* Avoid unportable behavior of malloc(0) */
3404 data = malloc(size);
3407 (errcode(ERRCODE_OUT_OF_MEMORY),
3408 errmsg("out of memory")));
3413 guc_realloc(int elevel, void *old, size_t size)
3417 /* Avoid unportable behavior of realloc(NULL, 0) */
3418 if (old == NULL && size == 0)
3420 data = realloc(old, size);
3423 (errcode(ERRCODE_OUT_OF_MEMORY),
3424 errmsg("out of memory")));
3429 guc_strdup(int elevel, const char *src)
3436 (errcode(ERRCODE_OUT_OF_MEMORY),
3437 errmsg("out of memory")));
3443 * Detect whether strval is referenced anywhere in a GUC string item
3446 string_field_used(struct config_string * conf, char *strval)
3450 if (strval == *(conf->variable) ||
3451 strval == conf->reset_val ||
3452 strval == conf->boot_val)
3454 for (stack = conf->gen.stack; stack; stack = stack->prev)
3456 if (strval == stack->prior.val.stringval ||
3457 strval == stack->masked.val.stringval)
3464 * Support for assigning to a field of a string GUC item. Free the prior
3465 * value if it's not referenced anywhere else in the item (including stacked
3469 set_string_field(struct config_string * conf, char **field, char *newval)
3471 char *oldval = *field;
3473 /* Do the assignment */
3476 /* Free old value if it's not NULL and isn't referenced anymore */
3477 if (oldval && !string_field_used(conf, oldval))
3482 * Detect whether an "extra" struct is referenced anywhere in a GUC item
3485 extra_field_used(struct config_generic * gconf, void *extra)
3489 if (extra == gconf->extra)
3491 switch (gconf->vartype)
3494 if (extra == ((struct config_bool *) gconf)->reset_extra)
3498 if (extra == ((struct config_int *) gconf)->reset_extra)
3502 if (extra == ((struct config_real *) gconf)->reset_extra)
3506 if (extra == ((struct config_string *) gconf)->reset_extra)
3510 if (extra == ((struct config_enum *) gconf)->reset_extra)
3514 for (stack = gconf->stack; stack; stack = stack->prev)
3516 if (extra == stack->prior.extra ||
3517 extra == stack->masked.extra)
3525 * Support for assigning to an "extra" field of a GUC item. Free the prior
3526 * value if it's not referenced anywhere else in the item (including stacked
3530 set_extra_field(struct config_generic * gconf, void **field, void *newval)
3532 void *oldval = *field;
3534 /* Do the assignment */
3537 /* Free old value if it's not NULL and isn't referenced anymore */
3538 if (oldval && !extra_field_used(gconf, oldval))
3543 * Support for copying a variable's active value into a stack entry.
3544 * The "extra" field associated with the active value is copied, too.
3546 * NB: be sure stringval and extra fields of a new stack entry are
3547 * initialized to NULL before this is used, else we'll try to free() them.
3550 set_stack_value(struct config_generic * gconf, config_var_value *val)
3552 switch (gconf->vartype)
3556 *((struct config_bool *) gconf)->variable;
3560 *((struct config_int *) gconf)->variable;
3564 *((struct config_real *) gconf)->variable;
3567 set_string_field((struct config_string *) gconf,
3568 &(val->val.stringval),
3569 *((struct config_string *) gconf)->variable);
3573 *((struct config_enum *) gconf)->variable;
3576 set_extra_field(gconf, &(val->extra), gconf->extra);
3580 * Support for discarding a no-longer-needed value in a stack entry.
3581 * The "extra" field associated with the stack entry is cleared, too.
3584 discard_stack_value(struct config_generic * gconf, config_var_value *val)
3586 switch (gconf->vartype)
3592 /* no need to do anything */
3595 set_string_field((struct config_string *) gconf,
3596 &(val->val.stringval),
3600 set_extra_field(gconf, &(val->extra), NULL);
3605 * Fetch the sorted array pointer (exported for help_config.c's use ONLY)
3607 struct config_generic **
3608 get_guc_variables(void)
3610 return guc_variables;
3615 * Build the sorted array. This is split out so that it could be
3616 * re-executed after startup (eg, we could allow loadable modules to
3617 * add vars, and then we'd need to re-sort).
3620 build_guc_variables(void)
3624 struct config_generic **guc_vars;
3627 for (i = 0; ConfigureNamesBool[i].gen.name; i++)
3629 struct config_bool *conf = &ConfigureNamesBool[i];
3631 /* Rather than requiring vartype to be filled in by hand, do this: */
3632 conf->gen.vartype = PGC_BOOL;
3636 for (i = 0; ConfigureNamesInt[i].gen.name; i++)
3638 struct config_int *conf = &ConfigureNamesInt[i];
3640 conf->gen.vartype = PGC_INT;
3644 for (i = 0; ConfigureNamesReal[i].gen.name; i++)
3646 struct config_real *conf = &ConfigureNamesReal[i];
3648 conf->gen.vartype = PGC_REAL;
3652 for (i = 0; ConfigureNamesString[i].gen.name; i++)
3654 struct config_string *conf = &ConfigureNamesString[i];
3656 conf->gen.vartype = PGC_STRING;
3660 for (i = 0; ConfigureNamesEnum[i].gen.name; i++)
3662 struct config_enum *conf = &ConfigureNamesEnum[i];
3664 conf->gen.vartype = PGC_ENUM;
3669 * Create table with 20% slack
3671 size_vars = num_vars + num_vars / 4;
3673 guc_vars = (struct config_generic **)
3674 guc_malloc(FATAL, size_vars * sizeof(struct config_generic *));
3678 for (i = 0; ConfigureNamesBool[i].gen.name; i++)
3679 guc_vars[num_vars++] = &ConfigureNamesBool[i].gen;
3681 for (i = 0; ConfigureNamesInt[i].gen.name; i++)
3682 guc_vars[num_vars++] = &ConfigureNamesInt[i].gen;
3684 for (i = 0; ConfigureNamesReal[i].gen.name; i++)
3685 guc_vars[num_vars++] = &ConfigureNamesReal[i].gen;
3687 for (i = 0; ConfigureNamesString[i].gen.name; i++)
3688 guc_vars[num_vars++] = &ConfigureNamesString[i].gen;
3690 for (i = 0; ConfigureNamesEnum[i].gen.name; i++)
3691 guc_vars[num_vars++] = &ConfigureNamesEnum[i].gen;
3694 free(guc_variables);
3695 guc_variables = guc_vars;
3696 num_guc_variables = num_vars;
3697 size_guc_variables = size_vars;
3698 qsort((void *) guc_variables, num_guc_variables,
3699 sizeof(struct config_generic *), guc_var_compare);
3703 * Add a new GUC variable to the list of known variables. The
3704 * list is expanded if needed.
3707 add_guc_variable(struct config_generic * var, int elevel)
3709 if (num_guc_variables + 1 >= size_guc_variables)
3712 * Increase the vector by 25%
3714 int size_vars = size_guc_variables + size_guc_variables / 4;
3715 struct config_generic **guc_vars;
3720 guc_vars = (struct config_generic **)
3721 guc_malloc(elevel, size_vars * sizeof(struct config_generic *));
3725 guc_vars = (struct config_generic **)
3726 guc_realloc(elevel, guc_variables, size_vars * sizeof(struct config_generic *));
3729 if (guc_vars == NULL)
3730 return false; /* out of memory */
3732 guc_variables = guc_vars;
3733 size_guc_variables = size_vars;
3735 guc_variables[num_guc_variables++] = var;
3736 qsort((void *) guc_variables, num_guc_variables,
3737 sizeof(struct config_generic *), guc_var_compare);
3742 * Create and add a placeholder variable for a custom variable name.
3744 static struct config_generic *
3745 add_placeholder_variable(const char *name, int elevel)
3747 size_t sz = sizeof(struct config_string) + sizeof(char *);
3748 struct config_string *var;
3749 struct config_generic *gen;
3751 var = (struct config_string *) guc_malloc(elevel, sz);
3757 gen->name = guc_strdup(elevel, name);
3758 if (gen->name == NULL)
3764 gen->context = PGC_USERSET;
3765 gen->group = CUSTOM_OPTIONS;
3766 gen->short_desc = "GUC placeholder variable";
3767 gen->flags = GUC_NO_SHOW_ALL | GUC_NOT_IN_SAMPLE | GUC_CUSTOM_PLACEHOLDER;
3768 gen->vartype = PGC_STRING;
3771 * The char* is allocated at the end of the struct since we have no
3772 * 'static' place to point to. Note that the current value, as well as
3773 * the boot and reset values, start out NULL.
3775 var->variable = (char **) (var + 1);
3777 if (!add_guc_variable((struct config_generic *) var, elevel))
3779 free((void *) gen->name);
3788 * Look up option NAME. If it exists, return a pointer to its record,
3789 * else return NULL. If create_placeholders is TRUE, we'll create a
3790 * placeholder record for a valid-looking custom variable name.
3792 static struct config_generic *
3793 find_option(const char *name, bool create_placeholders, int elevel)
3795 const char **key = &name;
3796 struct config_generic **res;
3802 * By equating const char ** with struct config_generic *, we are assuming
3803 * the name field is first in config_generic.
3805 res = (struct config_generic **) bsearch((void *) &key,
3806 (void *) guc_variables,
3808 sizeof(struct config_generic *),
3814 * See if the name is an obsolete name for a variable. We assume that the
3815 * set of supported old names is short enough that a brute-force search is
3818 for (i = 0; map_old_guc_names[i] != NULL; i += 2)
3820 if (guc_name_compare(name, map_old_guc_names[i]) == 0)
3821 return find_option(map_old_guc_names[i + 1], false, elevel);
3824 if (create_placeholders)
3827 * Check if the name is qualified, and if so, add a placeholder.
3829 if (strchr(name, GUC_QUALIFIER_SEPARATOR) != NULL)
3830 return add_placeholder_variable(name, elevel);
3839 * comparator for qsorting and bsearching guc_variables array
3842 guc_var_compare(const void *a, const void *b)
3844 const struct config_generic *confa = *(struct config_generic * const *) a;
3845 const struct config_generic *confb = *(struct config_generic * const *) b;
3847 return guc_name_compare(confa->name, confb->name);
3851 * the bare comparison function for GUC names
3854 guc_name_compare(const char *namea, const char *nameb)
3857 * The temptation to use strcasecmp() here must be resisted, because the
3858 * array ordering has to remain stable across setlocale() calls. So, build
3859 * our own with a simple ASCII-only downcasing.
3861 while (*namea && *nameb)
3863 char cha = *namea++;
3864 char chb = *nameb++;
3866 if (cha >= 'A' && cha <= 'Z')
3868 if (chb >= 'A' && chb <= 'Z')
3874 return 1; /* a is longer */
3876 return -1; /* b is longer */
3882 * Initialize GUC options during program startup.
3884 * Note that we cannot read the config file yet, since we have not yet
3885 * processed command-line switches.
3888 InitializeGUCOptions(void)
3893 * Before log_line_prefix could possibly receive a nonempty setting, make
3894 * sure that timezone processing is minimally alive (see elog.c).
3896 pg_timezone_initialize();
3899 * Build sorted array of all GUC variables.
3901 build_guc_variables();
3904 * Load all variables with their compiled-in defaults, and initialize
3905 * status fields as needed.
3907 for (i = 0; i < num_guc_variables; i++)
3909 InitializeOneGUCOption(guc_variables[i]);
3914 reporting_enabled = false;
3917 * Prevent any attempt to override the transaction modes from
3918 * non-interactive sources.
3920 SetConfigOption("transaction_isolation", "default",
3921 PGC_POSTMASTER, PGC_S_OVERRIDE);
3922 SetConfigOption("transaction_read_only", "no",
3923 PGC_POSTMASTER, PGC_S_OVERRIDE);
3924 SetConfigOption("transaction_deferrable", "no",
3925 PGC_POSTMASTER, PGC_S_OVERRIDE);
3928 * For historical reasons, some GUC parameters can receive defaults from
3929 * environment variables. Process those settings.
3931 InitializeGUCOptionsFromEnvironment();
3935 * Assign any GUC values that can come from the server's environment.
3937 * This is called from InitializeGUCOptions, and also from ProcessConfigFile
3938 * to deal with the possibility that a setting has been removed from
3939 * postgresql.conf and should now get a value from the environment.
3940 * (The latter is a kludge that should probably go away someday; if so,
3941 * fold this back into InitializeGUCOptions.)
3944 InitializeGUCOptionsFromEnvironment(void)
3949 env = getenv("PGPORT");
3951 SetConfigOption("port", env, PGC_POSTMASTER, PGC_S_ENV_VAR);
3953 env = getenv("PGDATESTYLE");
3955 SetConfigOption("datestyle", env, PGC_POSTMASTER, PGC_S_ENV_VAR);
3957 env = getenv("PGCLIENTENCODING");
3959 SetConfigOption("client_encoding", env, PGC_POSTMASTER, PGC_S_ENV_VAR);
3962 * rlimit isn't exactly an "environment variable", but it behaves about
3963 * the same. If we can identify the platform stack depth rlimit, increase
3964 * default stack depth setting up to whatever is safe (but at most 2MB).
3966 stack_rlimit = get_stack_depth_rlimit();
3967 if (stack_rlimit > 0)
3969 long new_limit = (stack_rlimit - STACK_DEPTH_SLOP) / 1024L;
3971 if (new_limit > 100)
3975 new_limit = Min(new_limit, 2048);
3976 sprintf(limbuf, "%ld", new_limit);
3977 SetConfigOption("max_stack_depth", limbuf,
3978 PGC_POSTMASTER, PGC_S_ENV_VAR);
3984 * Initialize one GUC option variable to its compiled-in default.
3986 * Note: the reason for calling check_hooks is not that we think the boot_val
3987 * might fail, but that the hooks might wish to compute an "extra" struct.
3990 InitializeOneGUCOption(struct config_generic * gconf)
3993 gconf->source = PGC_S_DEFAULT;
3994 gconf->reset_source = PGC_S_DEFAULT;
3995 gconf->scontext = PGC_INTERNAL;
3996 gconf->reset_scontext = PGC_INTERNAL;
3997 gconf->stack = NULL;
3998 gconf->extra = NULL;
3999 gconf->sourcefile = NULL;
4000 gconf->sourceline = 0;
4002 switch (gconf->vartype)
4006 struct config_bool *conf = (struct config_bool *) gconf;
4007 bool newval = conf->boot_val;
4010 if (!call_bool_check_hook(conf, &newval, &extra,
4011 PGC_S_DEFAULT, LOG))
4012 elog(FATAL, "failed to initialize %s to %d",
4013 conf->gen.name, (int) newval);
4014 if (conf->assign_hook)
4015 (*conf->assign_hook) (newval, extra);
4016 *conf->variable = conf->reset_val = newval;
4017 conf->gen.extra = conf->reset_extra = extra;
4022 struct config_int *conf = (struct config_int *) gconf;
4023 int newval = conf->boot_val;
4026 Assert(newval >= conf->min);
4027 Assert(newval <= conf->max);
4028 if (!call_int_check_hook(conf, &newval, &extra,
4029 PGC_S_DEFAULT, LOG))
4030 elog(FATAL, "failed to initialize %s to %d",
4031 conf->gen.name, newval);
4032 if (conf->assign_hook)
4033 (*conf->assign_hook) (newval, extra);
4034 *conf->variable = conf->reset_val = newval;
4035 conf->gen.extra = conf->reset_extra = extra;
4040 struct config_real *conf = (struct config_real *) gconf;
4041 double newval = conf->boot_val;
4044 Assert(newval >= conf->min);
4045 Assert(newval <= conf->max);
4046 if (!call_real_check_hook(conf, &newval, &extra,
4047 PGC_S_DEFAULT, LOG))
4048 elog(FATAL, "failed to initialize %s to %g",
4049 conf->gen.name, newval);
4050 if (conf->assign_hook)
4051 (*conf->assign_hook) (newval, extra);
4052 *conf->variable = conf->reset_val = newval;
4053 conf->gen.extra = conf->reset_extra = extra;
4058 struct config_string *conf = (struct config_string *) gconf;
4062 /* non-NULL boot_val must always get strdup'd */
4063 if (conf->boot_val != NULL)
4064 newval = guc_strdup(FATAL, conf->boot_val);
4068 if (!call_string_check_hook(conf, &newval, &extra,
4069 PGC_S_DEFAULT, LOG))
4070 elog(FATAL, "failed to initialize %s to \"%s\"",
4071 conf->gen.name, newval ? newval : "");
4072 if (conf->assign_hook)
4073 (*conf->assign_hook) (newval, extra);
4074 *conf->variable = conf->reset_val = newval;
4075 conf->gen.extra = conf->reset_extra = extra;
4080 struct config_enum *conf = (struct config_enum *) gconf;
4081 int newval = conf->boot_val;
4084 if (!call_enum_check_hook(conf, &newval, &extra,
4085 PGC_S_DEFAULT, LOG))
4086 elog(FATAL, "failed to initialize %s to %d",
4087 conf->gen.name, newval);
4088 if (conf->assign_hook)
4089 (*conf->assign_hook) (newval, extra);
4090 *conf->variable = conf->reset_val = newval;
4091 conf->gen.extra = conf->reset_extra = extra;
4099 * Select the configuration files and data directory to be used, and
4100 * do the initial read of postgresql.conf.
4102 * This is called after processing command-line switches.
4103 * userDoption is the -D switch value if any (NULL if unspecified).
4104 * progname is just for use in error messages.
4106 * Returns true on success; on failure, prints a suitable error message
4107 * to stderr and returns false.
4110 SelectConfigFiles(const char *userDoption, const char *progname)
4114 struct stat stat_buf;
4116 /* configdir is -D option, or $PGDATA if no -D */
4118 configdir = make_absolute_path(userDoption);
4120 configdir = make_absolute_path(getenv("PGDATA"));
4123 * Find the configuration file: if config_file was specified on the
4124 * command line, use it, else use configdir/postgresql.conf. In any case
4125 * ensure the result is an absolute path, so that it will be interpreted
4126 * the same way by future backends.
4129 fname = make_absolute_path(ConfigFileName);
4132 fname = guc_malloc(FATAL,
4133 strlen(configdir) + strlen(CONFIG_FILENAME) + 2);
4134 sprintf(fname, "%s/%s", configdir, CONFIG_FILENAME);
4138 write_stderr("%s does not know where to find the server configuration file.\n"
4139 "You must specify the --config-file or -D invocation "
4140 "option or set the PGDATA environment variable.\n",
4146 * Set the ConfigFileName GUC variable to its final value, ensuring that
4147 * it can't be overridden later.
4149 SetConfigOption("config_file", fname, PGC_POSTMASTER, PGC_S_OVERRIDE);
4153 * Now read the config file for the first time.
4155 if (stat(ConfigFileName, &stat_buf) != 0)
4157 write_stderr("%s cannot access the server configuration file \"%s\": %s\n",
4158 progname, ConfigFileName, strerror(errno));
4163 ProcessConfigFile(PGC_POSTMASTER);
4166 * If the data_directory GUC variable has been set, use that as DataDir;
4167 * otherwise use configdir if set; else punt.
4169 * Note: SetDataDir will copy and absolute-ize its argument, so we don't
4173 SetDataDir(data_directory);
4175 SetDataDir(configdir);
4178 write_stderr("%s does not know where to find the database system data.\n"
4179 "This can be specified as \"data_directory\" in \"%s\", "
4180 "or by the -D invocation option, or by the "
4181 "PGDATA environment variable.\n",
4182 progname, ConfigFileName);
4187 * Reflect the final DataDir value back into the data_directory GUC var.
4188 * (If you are wondering why we don't just make them a single variable,
4189 * it's because the EXEC_BACKEND case needs DataDir to be transmitted to
4190 * child backends specially. XXX is that still true? Given that we now
4191 * chdir to DataDir, EXEC_BACKEND can read the config file without knowing
4192 * DataDir in advance.)
4194 SetConfigOption("data_directory", DataDir, PGC_POSTMASTER, PGC_S_OVERRIDE);
4197 * If the recovery_config_directory GUC variable has been set, use that,
4198 * otherwise use DataDir.
4200 * Note: SetRecoveryConfDir will copy and absolute-ize its argument,
4201 * so we don't have to.
4203 if (recovery_config_directory)
4204 SetRecoveryConfDir(recovery_config_directory);
4206 SetRecoveryConfDir(DataDir);
4209 * If timezone_abbreviations wasn't set in the configuration file, install
4210 * the default value. We do it this way because we can't safely install a
4211 * "real" value until my_exec_path is set, which may not have happened
4212 * when InitializeGUCOptions runs, so the bootstrap default value cannot
4213 * be the real desired default.
4215 pg_timezone_abbrev_initialize();
4218 * Figure out where pg_hba.conf is, and make sure the path is absolute.
4221 fname = make_absolute_path(HbaFileName);
4224 fname = guc_malloc(FATAL,
4225 strlen(configdir) + strlen(HBA_FILENAME) + 2);
4226 sprintf(fname, "%s/%s", configdir, HBA_FILENAME);
4230 write_stderr("%s does not know where to find the \"hba\" configuration file.\n"
4231 "This can be specified as \"hba_file\" in \"%s\", "
4232 "or by the -D invocation option, or by the "
4233 "PGDATA environment variable.\n",
4234 progname, ConfigFileName);
4237 SetConfigOption("hba_file", fname, PGC_POSTMASTER, PGC_S_OVERRIDE);
4241 * Likewise for pg_ident.conf.
4244 fname = make_absolute_path(IdentFileName);
4247 fname = guc_malloc(FATAL,
4248 strlen(configdir) + strlen(IDENT_FILENAME) + 2);
4249 sprintf(fname, "%s/%s", configdir, IDENT_FILENAME);
4253 write_stderr("%s does not know where to find the \"ident\" configuration file.\n"
4254 "This can be specified as \"ident_file\" in \"%s\", "
4255 "or by the -D invocation option, or by the "
4256 "PGDATA environment variable.\n",
4257 progname, ConfigFileName);
4260 SetConfigOption("ident_file", fname, PGC_POSTMASTER, PGC_S_OVERRIDE);
4270 * Reset all options to their saved default values (implements RESET ALL)
4273 ResetAllOptions(void)
4277 for (i = 0; i < num_guc_variables; i++)
4279 struct config_generic *gconf = guc_variables[i];
4281 /* Don't reset non-SET-able values */
4282 if (gconf->context != PGC_SUSET &&
4283 gconf->context != PGC_USERSET)
4285 /* Don't reset if special exclusion from RESET ALL */
4286 if (gconf->flags & GUC_NO_RESET_ALL)
4288 /* No need to reset if wasn't SET */
4289 if (gconf->source <= PGC_S_OVERRIDE)
4292 /* Save old value to support transaction abort */
4293 push_old_value(gconf, GUC_ACTION_SET);
4295 switch (gconf->vartype)
4299 struct config_bool *conf = (struct config_bool *) gconf;
4301 if (conf->assign_hook)
4302 (*conf->assign_hook) (conf->reset_val,
4304 *conf->variable = conf->reset_val;
4305 set_extra_field(&conf->gen, &conf->gen.extra,
4311 struct config_int *conf = (struct config_int *) gconf;
4313 if (conf->assign_hook)
4314 (*conf->assign_hook) (conf->reset_val,
4316 *conf->variable = conf->reset_val;
4317 set_extra_field(&conf->gen, &conf->gen.extra,
4323 struct config_real *conf = (struct config_real *) gconf;
4325 if (conf->assign_hook)
4326 (*conf->assign_hook) (conf->reset_val,
4328 *conf->variable = conf->reset_val;
4329 set_extra_field(&conf->gen, &conf->gen.extra,
4335 struct config_string *conf = (struct config_string *) gconf;
4337 if (conf->assign_hook)
4338 (*conf->assign_hook) (conf->reset_val,
4340 set_string_field(conf, conf->variable, conf->reset_val);
4341 set_extra_field(&conf->gen, &conf->gen.extra,
4347 struct config_enum *conf = (struct config_enum *) gconf;
4349 if (conf->assign_hook)
4350 (*conf->assign_hook) (conf->reset_val,
4352 *conf->variable = conf->reset_val;
4353 set_extra_field(&conf->gen, &conf->gen.extra,
4359 gconf->source = gconf->reset_source;
4360 gconf->scontext = gconf->reset_scontext;
4362 if (gconf->flags & GUC_REPORT)
4363 ReportGUCOption(gconf);
4370 * Push previous state during transactional assignment to a GUC variable.
4373 push_old_value(struct config_generic * gconf, GucAction action)
4377 /* If we're not inside a nest level, do nothing */
4378 if (GUCNestLevel == 0)
4381 /* Do we already have a stack entry of the current nest level? */
4382 stack = gconf->stack;
4383 if (stack && stack->nest_level >= GUCNestLevel)
4385 /* Yes, so adjust its state if necessary */
4386 Assert(stack->nest_level == GUCNestLevel);
4389 case GUC_ACTION_SET:
4390 /* SET overrides any prior action at same nest level */
4391 if (stack->state == GUC_SET_LOCAL)
4393 /* must discard old masked value */
4394 discard_stack_value(gconf, &stack->masked);
4396 stack->state = GUC_SET;
4398 case GUC_ACTION_LOCAL:
4399 if (stack->state == GUC_SET)
4401 /* SET followed by SET LOCAL, remember SET's value */
4402 stack->masked_scontext = gconf->scontext;
4403 set_stack_value(gconf, &stack->masked);
4404 stack->state = GUC_SET_LOCAL;
4406 /* in all other cases, no change to stack entry */
4408 case GUC_ACTION_SAVE:
4409 /* Could only have a prior SAVE of same variable */
4410 Assert(stack->state == GUC_SAVE);
4413 Assert(guc_dirty); /* must be set already */
4418 * Push a new stack entry
4420 * We keep all the stack entries in TopTransactionContext for simplicity.
4422 stack = (GucStack *) MemoryContextAllocZero(TopTransactionContext,
4425 stack->prev = gconf->stack;
4426 stack->nest_level = GUCNestLevel;
4429 case GUC_ACTION_SET:
4430 stack->state = GUC_SET;
4432 case GUC_ACTION_LOCAL:
4433 stack->state = GUC_LOCAL;
4435 case GUC_ACTION_SAVE:
4436 stack->state = GUC_SAVE;
4439 stack->source = gconf->source;
4440 stack->scontext = gconf->scontext;
4441 set_stack_value(gconf, &stack->prior);
4443 gconf->stack = stack;
4445 /* Ensure we remember to pop at end of xact */
4451 * Do GUC processing at main transaction start.
4457 * The nest level should be 0 between transactions; if it isn't, somebody
4458 * didn't call AtEOXact_GUC, or called it with the wrong nestLevel. We
4459 * throw a warning but make no other effort to clean up.
4461 if (GUCNestLevel != 0)
4462 elog(WARNING, "GUC nest level = %d at transaction start",
4468 * Enter a new nesting level for GUC values. This is called at subtransaction
4469 * start, and when entering a function that has proconfig settings, and in
4470 * some other places where we want to set GUC variables transiently.
4471 * NOTE we must not risk error here, else subtransaction start will be unhappy.
4474 NewGUCNestLevel(void)
4476 return ++GUCNestLevel;
4480 * Do GUC processing at transaction or subtransaction commit or abort, or
4481 * when exiting a function that has proconfig settings, or when undoing a
4482 * transient assignment to some GUC variables. (The name is thus a bit of
4483 * a misnomer; perhaps it should be ExitGUCNestLevel or some such.)
4484 * During abort, we discard all GUC settings that were applied at nesting
4485 * levels >= nestLevel. nestLevel == 1 corresponds to the main transaction.
4488 AtEOXact_GUC(bool isCommit, int nestLevel)
4494 * Note: it's possible to get here with GUCNestLevel == nestLevel-1 during
4495 * abort, if there is a failure during transaction start before
4496 * AtStart_GUC is called.
4498 Assert(nestLevel > 0 &&
4499 (nestLevel <= GUCNestLevel ||
4500 (nestLevel == GUCNestLevel + 1 && !isCommit)));
4502 /* Quick exit if nothing's changed in this transaction */
4505 GUCNestLevel = nestLevel - 1;
4509 still_dirty = false;
4510 for (i = 0; i < num_guc_variables; i++)
4512 struct config_generic *gconf = guc_variables[i];
4516 * Process and pop each stack entry within the nest level. To simplify
4517 * fmgr_security_definer() and other places that use GUC_ACTION_SAVE,
4518 * we allow failure exit from code that uses a local nest level to be
4519 * recovered at the surrounding transaction or subtransaction abort;
4520 * so there could be more than one stack entry to pop.
4522 while ((stack = gconf->stack) != NULL &&
4523 stack->nest_level >= nestLevel)
4525 GucStack *prev = stack->prev;
4526 bool restorePrior = false;
4527 bool restoreMasked = false;
4531 * In this next bit, if we don't set either restorePrior or
4532 * restoreMasked, we must "discard" any unwanted fields of the
4533 * stack entries to avoid leaking memory. If we do set one of
4534 * those flags, unused fields will be cleaned up after restoring.
4536 if (!isCommit) /* if abort, always restore prior value */
4537 restorePrior = true;
4538 else if (stack->state == GUC_SAVE)
4539 restorePrior = true;
4540 else if (stack->nest_level == 1)
4542 /* transaction commit */
4543 if (stack->state == GUC_SET_LOCAL)
4544 restoreMasked = true;
4545 else if (stack->state == GUC_SET)
4547 /* we keep the current active value */
4548 discard_stack_value(gconf, &stack->prior);
4550 else /* must be GUC_LOCAL */
4551 restorePrior = true;
4553 else if (prev == NULL ||
4554 prev->nest_level < stack->nest_level - 1)
4556 /* decrement entry's level and do not pop it */
4557 stack->nest_level--;
4563 * We have to merge this stack entry into prev. See README for
4564 * discussion of this bit.
4566 switch (stack->state)
4569 Assert(false); /* can't get here */
4572 /* next level always becomes SET */
4573 discard_stack_value(gconf, &stack->prior);
4574 if (prev->state == GUC_SET_LOCAL)
4575 discard_stack_value(gconf, &prev->masked);
4576 prev->state = GUC_SET;
4580 if (prev->state == GUC_SET)
4582 /* LOCAL migrates down */
4583 prev->masked_scontext = stack->scontext;
4584 prev->masked = stack->prior;
4585 prev->state = GUC_SET_LOCAL;
4589 /* else just forget this stack level */
4590 discard_stack_value(gconf, &stack->prior);
4595 /* prior state at this level no longer wanted */
4596 discard_stack_value(gconf, &stack->prior);
4597 /* copy down the masked state */
4598 prev->masked_scontext = stack->masked_scontext;
4599 if (prev->state == GUC_SET_LOCAL)
4600 discard_stack_value(gconf, &prev->masked);
4601 prev->masked = stack->masked;
4602 prev->state = GUC_SET_LOCAL;
4609 if (restorePrior || restoreMasked)
4611 /* Perform appropriate restoration of the stacked value */
4612 config_var_value newvalue;
4613 GucSource newsource;
4614 GucContext newscontext;
4618 newvalue = stack->masked;
4619 newsource = PGC_S_SESSION;
4620 newscontext = stack->masked_scontext;
4624 newvalue = stack->prior;
4625 newsource = stack->source;
4626 newscontext = stack->scontext;
4629 switch (gconf->vartype)
4633 struct config_bool *conf = (struct config_bool *) gconf;
4634 bool newval = newvalue.val.boolval;
4635 void *newextra = newvalue.extra;
4637 if (*conf->variable != newval ||
4638 conf->gen.extra != newextra)
4640 if (conf->assign_hook)
4641 (*conf->assign_hook) (newval, newextra);
4642 *conf->variable = newval;
4643 set_extra_field(&conf->gen, &conf->gen.extra,
4651 struct config_int *conf = (struct config_int *) gconf;
4652 int newval = newvalue.val.intval;
4653 void *newextra = newvalue.extra;
4655 if (*conf->variable != newval ||
4656 conf->gen.extra != newextra)
4658 if (conf->assign_hook)
4659 (*conf->assign_hook) (newval, newextra);
4660 *conf->variable = newval;
4661 set_extra_field(&conf->gen, &conf->gen.extra,
4669 struct config_real *conf = (struct config_real *) gconf;
4670 double newval = newvalue.val.realval;
4671 void *newextra = newvalue.extra;
4673 if (*conf->variable != newval ||
4674 conf->gen.extra != newextra)
4676 if (conf->assign_hook)
4677 (*conf->assign_hook) (newval, newextra);
4678 *conf->variable = newval;
4679 set_extra_field(&conf->gen, &conf->gen.extra,
4687 struct config_string *conf = (struct config_string *) gconf;
4688 char *newval = newvalue.val.stringval;
4689 void *newextra = newvalue.extra;
4691 if (*conf->variable != newval ||
4692 conf->gen.extra != newextra)
4694 if (conf->assign_hook)
4695 (*conf->assign_hook) (newval, newextra);
4696 set_string_field(conf, conf->variable, newval);
4697 set_extra_field(&conf->gen, &conf->gen.extra,
4703 * Release stacked values if not used anymore. We
4704 * could use discard_stack_value() here, but since
4705 * we have type-specific code anyway, might as
4708 set_string_field(conf, &stack->prior.val.stringval, NULL);
4709 set_string_field(conf, &stack->masked.val.stringval, NULL);
4714 struct config_enum *conf = (struct config_enum *) gconf;
4715 int newval = newvalue.val.enumval;
4716 void *newextra = newvalue.extra;
4718 if (*conf->variable != newval ||
4719 conf->gen.extra != newextra)
4721 if (conf->assign_hook)
4722 (*conf->assign_hook) (newval, newextra);
4723 *conf->variable = newval;
4724 set_extra_field(&conf->gen, &conf->gen.extra,
4733 * Release stacked extra values if not used anymore.
4735 set_extra_field(gconf, &(stack->prior.extra), NULL);
4736 set_extra_field(gconf, &(stack->masked.extra), NULL);
4738 /* And restore source information */
4739 gconf->source = newsource;
4740 gconf->scontext = newscontext;
4743 /* Finish popping the state stack */
4744 gconf->stack = prev;
4747 /* Report new value if we changed it */
4748 if (changed && (gconf->flags & GUC_REPORT))
4749 ReportGUCOption(gconf);
4750 } /* end of stack-popping loop */
4756 /* If there are no remaining stack entries, we can reset guc_dirty */
4757 guc_dirty = still_dirty;
4759 /* Update nesting level */
4760 GUCNestLevel = nestLevel - 1;
4765 * Start up automatic reporting of changes to variables marked GUC_REPORT.
4766 * This is executed at completion of backend startup.
4769 BeginReportingGUCOptions(void)
4774 * Don't do anything unless talking to an interactive frontend of protocol
4777 if (whereToSendOutput != DestRemote ||
4778 PG_PROTOCOL_MAJOR(FrontendProtocol) < 3)
4781 reporting_enabled = true;
4783 /* Transmit initial values of interesting variables */
4784 for (i = 0; i < num_guc_variables; i++)
4786 struct config_generic *conf = guc_variables[i];
4788 if (conf->flags & GUC_REPORT)
4789 ReportGUCOption(conf);
4794 * ReportGUCOption: if appropriate, transmit option value to frontend
4797 ReportGUCOption(struct config_generic * record)
4799 if (reporting_enabled && (record->flags & GUC_REPORT))
4801 char *val = _ShowOption(record, false);
4802 StringInfoData msgbuf;
4804 pq_beginmessage(&msgbuf, 'S');
4805 pq_sendstring(&msgbuf, record->name);
4806 pq_sendstring(&msgbuf, val);
4807 pq_endmessage(&msgbuf);
4814 * Try to parse value as an integer. The accepted formats are the
4815 * usual decimal, octal, or hexadecimal formats, optionally followed by
4816 * a unit name if "flags" indicates a unit is allowed.
4818 * If the string parses okay, return true, else false.
4819 * If okay and result is not NULL, return the value in *result.
4820 * If not okay and hintmsg is not NULL, *hintmsg is set to a suitable
4821 * HINT message, or NULL if no hint provided.
4824 parse_int(const char *value, int *result, int flags, const char **hintmsg)
4829 /* To suppress compiler warnings, always set output params */
4835 /* We assume here that int64 is at least as wide as long */
4837 val = strtol(value, &endptr, 0);
4839 if (endptr == value)
4840 return false; /* no HINT for integer syntax error */
4842 if (errno == ERANGE || val != (int64) ((int32) val))
4845 *hintmsg = gettext_noop("Value exceeds integer range.");
4849 /* allow whitespace between integer and unit */
4850 while (isspace((unsigned char) *endptr))
4853 /* Handle possible unit */
4854 if (*endptr != '\0')
4857 * Note: the multiple-switch coding technique here is a bit tedious,
4858 * but seems necessary to avoid intermediate-value overflows.
4860 if (flags & GUC_UNIT_MEMORY)
4862 /* Set hint for use if no match or trailing garbage */
4864 *hintmsg = gettext_noop("Valid units for this parameter are \"kB\", \"MB\", and \"GB\".");
4866 #if BLCKSZ < 1024 || BLCKSZ > (1024*1024)
4867 #error BLCKSZ must be between 1KB and 1MB
4869 #if XLOG_BLCKSZ < 1024 || XLOG_BLCKSZ > (1024*1024)
4870 #error XLOG_BLCKSZ must be between 1KB and 1MB
4873 if (strncmp(endptr, "kB", 2) == 0)
4876 switch (flags & GUC_UNIT_MEMORY)
4878 case GUC_UNIT_BLOCKS:
4879 val /= (BLCKSZ / 1024);
4881 case GUC_UNIT_XBLOCKS:
4882 val /= (XLOG_BLCKSZ / 1024);
4886 else if (strncmp(endptr, "MB", 2) == 0)
4889 switch (flags & GUC_UNIT_MEMORY)
4894 case GUC_UNIT_BLOCKS:
4895 val *= KB_PER_MB / (BLCKSZ / 1024);
4897 case GUC_UNIT_XBLOCKS:
4898 val *= KB_PER_MB / (XLOG_BLCKSZ / 1024);
4902 else if (strncmp(endptr, "GB", 2) == 0)
4905 switch (flags & GUC_UNIT_MEMORY)
4910 case GUC_UNIT_BLOCKS:
4911 val *= KB_PER_GB / (BLCKSZ / 1024);
4913 case GUC_UNIT_XBLOCKS:
4914 val *= KB_PER_GB / (XLOG_BLCKSZ / 1024);
4919 else if (flags & GUC_UNIT_TIME)
4921 /* Set hint for use if no match or trailing garbage */
4923 *hintmsg = gettext_noop("Valid units for this parameter are \"ms\", \"s\", \"min\", \"h\", and \"d\".");
4925 if (strncmp(endptr, "ms", 2) == 0)
4928 switch (flags & GUC_UNIT_TIME)
4938 else if (strncmp(endptr, "s", 1) == 0)
4941 switch (flags & GUC_UNIT_TIME)
4951 else if (strncmp(endptr, "min", 3) == 0)
4954 switch (flags & GUC_UNIT_TIME)
4964 else if (strncmp(endptr, "h", 1) == 0)
4967 switch (flags & GUC_UNIT_TIME)
4980 else if (strncmp(endptr, "d", 1) == 0)
4983 switch (flags & GUC_UNIT_TIME)
4998 /* allow whitespace after unit */
4999 while (isspace((unsigned char) *endptr))
5002 if (*endptr != '\0')
5003 return false; /* appropriate hint, if any, already set */
5005 /* Check for overflow due to units conversion */
5006 if (val != (int64) ((int32) val))
5009 *hintmsg = gettext_noop("Value exceeds integer range.");
5015 *result = (int) val;
5022 * Try to parse value as a floating point number in the usual format.
5023 * If the string parses okay, return true, else false.
5024 * If okay and result is not NULL, return the value in *result.
5027 parse_real(const char *value, double *result)
5033 *result = 0; /* suppress compiler warning */
5036 val = strtod(value, &endptr);
5037 if (endptr == value || errno == ERANGE)
5040 /* allow whitespace after number */
5041 while (isspace((unsigned char) *endptr))
5043 if (*endptr != '\0')
5053 * Lookup the name for an enum option with the selected value.
5054 * Should only ever be called with known-valid values, so throws
5055 * an elog(ERROR) if the enum option is not found.
5057 * The returned string is a pointer to static data and not
5058 * allocated for modification.
5061 config_enum_lookup_by_value(struct config_enum * record, int val)
5063 const struct config_enum_entry *entry;
5065 for (entry = record->options; entry && entry->name; entry++)
5067 if (entry->val == val)
5071 elog(ERROR, "could not find enum option %d for %s",
5072 val, record->gen.name);
5073 return NULL; /* silence compiler */
5078 * Lookup the value for an enum option with the selected name
5079 * (case-insensitive).
5080 * If the enum option is found, sets the retval value and returns
5081 * true. If it's not found, return FALSE and retval is set to 0.
5084 config_enum_lookup_by_name(struct config_enum * record, const char *value,
5087 const struct config_enum_entry *entry;
5089 for (entry = record->options; entry && entry->name; entry++)
5091 if (pg_strcasecmp(value, entry->name) == 0)
5093 *retval = entry->val;
5104 * Return a list of all available options for an enum, excluding
5105 * hidden ones, separated by the given separator.
5106 * If prefix is non-NULL, it is added before the first enum value.
5107 * If suffix is non-NULL, it is added to the end of the string.
5110 config_enum_get_options(struct config_enum * record, const char *prefix,
5111 const char *suffix, const char *separator)
5113 const struct config_enum_entry *entry;
5114 StringInfoData retstr;
5117 initStringInfo(&retstr);
5118 appendStringInfoString(&retstr, prefix);
5120 seplen = strlen(separator);
5121 for (entry = record->options; entry && entry->name; entry++)
5125 appendStringInfoString(&retstr, entry->name);
5126 appendBinaryStringInfo(&retstr, separator, seplen);
5131 * All the entries may have been hidden, leaving the string empty if no
5132 * prefix was given. This indicates a broken GUC setup, since there is no
5133 * use for an enum without any values, so we just check to make sure we
5134 * don't write to invalid memory instead of actually trying to do
5135 * something smart with it.
5137 if (retstr.len >= seplen)
5139 /* Replace final separator */
5140 retstr.data[retstr.len - seplen] = '\0';
5141 retstr.len -= seplen;
5144 appendStringInfoString(&retstr, suffix);
5151 * Sets option `name' to given value.
5153 * The value should be a string, which will be parsed and converted to
5154 * the appropriate data type. The context and source parameters indicate
5155 * in which context this function is being called, so that it can apply the
5156 * access restrictions properly.
5158 * If value is NULL, set the option to its default value (normally the
5159 * reset_val, but if source == PGC_S_DEFAULT we instead use the boot_val).
5161 * action indicates whether to set the value globally in the session, locally
5162 * to the current top transaction, or just for the duration of a function call.
5164 * If changeVal is false then don't really set the option but do all
5165 * the checks to see if it would work.
5167 * elevel should normally be passed as zero, allowing this function to make
5168 * its standard choice of ereport level. However some callers need to be
5169 * able to override that choice; they should pass the ereport level to use.
5172 * +1: the value is valid and was successfully applied.
5173 * 0: the name or value is invalid (but see below).
5174 * -1: the value was not applied because of context, priority, or changeVal.
5176 * If there is an error (non-existing option, invalid value) then an
5177 * ereport(ERROR) is thrown *unless* this is called for a source for which
5178 * we don't want an ERROR (currently, those are defaults, the config file,
5179 * and per-database or per-user settings, as well as callers who specify
5180 * a less-than-ERROR elevel). In those cases we write a suitable error
5181 * message via ereport() and return 0.
5183 * See also SetConfigOption for an external interface.
5186 set_config_option(const char *name, const char *value,
5187 GucContext context, GucSource source,
5188 GucAction action, bool changeVal, int elevel)
5190 struct config_generic *record;
5191 bool prohibitValueChange = false;
5196 if (source == PGC_S_DEFAULT || source == PGC_S_FILE)
5199 * To avoid cluttering the log, only the postmaster bleats loudly
5200 * about problems with the config file.
5202 elevel = IsUnderPostmaster ? DEBUG3 : LOG;
5204 else if (source == PGC_S_GLOBAL || source == PGC_S_DATABASE || source == PGC_S_USER ||
5205 source == PGC_S_DATABASE_USER)
5211 record = find_option(name, true, elevel);
5215 (errcode(ERRCODE_UNDEFINED_OBJECT),
5216 errmsg("unrecognized configuration parameter \"%s\"", name)));
5221 * Check if the option can be set at this time. See guc.h for the precise
5224 switch (record->context)
5227 if (context != PGC_INTERNAL)
5230 (errcode(ERRCODE_CANT_CHANGE_RUNTIME_PARAM),
5231 errmsg("parameter \"%s\" cannot be changed",
5236 case PGC_POSTMASTER:
5237 if (context == PGC_SIGHUP)
5240 * We are re-reading a PGC_POSTMASTER variable from
5241 * postgresql.conf. We can't change the setting, so we should
5242 * give a warning if the DBA tries to change it. However,
5243 * because of variant formats, canonicalization by check
5244 * hooks, etc, we can't just compare the given string directly
5245 * to what's stored. Set a flag to check below after we have
5246 * the final storable value.
5248 prohibitValueChange = true;
5250 else if (context != PGC_POSTMASTER)
5253 (errcode(ERRCODE_CANT_CHANGE_RUNTIME_PARAM),
5254 errmsg("parameter \"%s\" cannot be changed without restarting the server",
5260 if (context != PGC_SIGHUP && context != PGC_POSTMASTER)
5263 (errcode(ERRCODE_CANT_CHANGE_RUNTIME_PARAM),
5264 errmsg("parameter \"%s\" cannot be changed now",
5270 * Hmm, the idea of the SIGHUP context is "ought to be global, but
5271 * can be changed after postmaster start". But there's nothing
5272 * that prevents a crafty administrator from sending SIGHUP
5273 * signals to individual backends only.
5277 if (context == PGC_SIGHUP)
5280 * If a PGC_BACKEND parameter is changed in the config file,
5281 * we want to accept the new value in the postmaster (whence
5282 * it will propagate to subsequently-started backends), but
5283 * ignore it in existing backends. This is a tad klugy, but
5284 * necessary because we don't re-read the config file during
5287 if (IsUnderPostmaster)
5290 else if (context != PGC_POSTMASTER && context != PGC_BACKEND &&
5291 source != PGC_S_CLIENT)
5294 (errcode(ERRCODE_CANT_CHANGE_RUNTIME_PARAM),
5295 errmsg("parameter \"%s\" cannot be set after connection start",
5301 if (context == PGC_USERSET || context == PGC_BACKEND)
5304 (errcode(ERRCODE_INSUFFICIENT_PRIVILEGE),
5305 errmsg("permission denied to set parameter \"%s\"",
5316 * Disallow changing GUC_NOT_WHILE_SEC_REST values if we are inside a
5317 * security restriction context. We can reject this regardless of the GUC
5318 * context or source, mainly because sources that it might be reasonable
5319 * to override for won't be seen while inside a function.
5321 * Note: variables marked GUC_NOT_WHILE_SEC_REST should usually be marked
5322 * GUC_NO_RESET_ALL as well, because ResetAllOptions() doesn't check this.
5323 * An exception might be made if the reset value is assumed to be "safe".
5325 * Note: this flag is currently used for "session_authorization" and
5326 * "role". We need to prohibit changing these inside a local userid
5327 * context because when we exit it, GUC won't be notified, leaving things
5328 * out of sync. (This could be fixed by forcing a new GUC nesting level,
5329 * but that would change behavior in possibly-undesirable ways.) Also, we
5330 * prohibit changing these in a security-restricted operation because
5331 * otherwise RESET could be used to regain the session user's privileges.
5333 if (record->flags & GUC_NOT_WHILE_SEC_REST)
5335 if (InLocalUserIdChange())
5338 * Phrasing of this error message is historical, but it's the most
5342 (errcode(ERRCODE_INSUFFICIENT_PRIVILEGE),
5343 errmsg("cannot set parameter \"%s\" within security-definer function",
5347 if (InSecurityRestrictedOperation())
5350 (errcode(ERRCODE_INSUFFICIENT_PRIVILEGE),
5351 errmsg("cannot set parameter \"%s\" within security-restricted operation",
5358 * Should we set reset/stacked values? (If so, the behavior is not
5359 * transactional.) This is done either when we get a default value from
5360 * the database's/user's/client's default settings or when we reset a
5361 * value to its default.
5363 makeDefault = changeVal && (source <= PGC_S_OVERRIDE) &&
5364 ((value != NULL) || source == PGC_S_DEFAULT);
5367 * Ignore attempted set if overridden by previously processed setting.
5368 * However, if changeVal is false then plow ahead anyway since we are
5369 * trying to find out if the value is potentially good, not actually use
5370 * it. Also keep going if makeDefault is true, since we may want to set
5371 * the reset/stacked values even if we can't set the variable itself.
5373 if (record->source > source)
5375 if (changeVal && !makeDefault)
5377 elog(DEBUG3, "\"%s\": setting ignored because previous source is higher priority",
5385 * Evaluate value and set variable.
5387 switch (record->vartype)
5391 struct config_bool *conf = (struct config_bool *) record;
5393 void *newextra = NULL;
5397 if (!parse_bool(value, &newval))
5400 (errcode(ERRCODE_INVALID_PARAMETER_VALUE),
5401 errmsg("parameter \"%s\" requires a Boolean value",
5405 if (!call_bool_check_hook(conf, &newval, &newextra,
5409 else if (source == PGC_S_DEFAULT)
5411 newval = conf->boot_val;
5412 if (!call_bool_check_hook(conf, &newval, &newextra,
5418 newval = conf->reset_val;
5419 newextra = conf->reset_extra;
5420 source = conf->gen.reset_source;
5421 context = conf->gen.reset_scontext;
5424 if (prohibitValueChange)
5426 if (*conf->variable != newval)
5429 (errcode(ERRCODE_CANT_CHANGE_RUNTIME_PARAM),
5430 errmsg("parameter \"%s\" cannot be changed without restarting the server",
5439 /* Save old value to support transaction abort */
5441 push_old_value(&conf->gen, action);
5443 if (conf->assign_hook)
5444 (*conf->assign_hook) (newval, newextra);
5445 *conf->variable = newval;
5446 set_extra_field(&conf->gen, &conf->gen.extra,
5448 conf->gen.source = source;
5449 conf->gen.scontext = context;
5455 if (conf->gen.reset_source <= source)
5457 conf->reset_val = newval;
5458 set_extra_field(&conf->gen, &conf->reset_extra,
5460 conf->gen.reset_source = source;
5461 conf->gen.reset_scontext = context;
5463 for (stack = conf->gen.stack; stack; stack = stack->prev)
5465 if (stack->source <= source)
5467 stack->prior.val.boolval = newval;
5468 set_extra_field(&conf->gen, &stack->prior.extra,
5470 stack->source = source;
5471 stack->scontext = context;
5476 /* Perhaps we didn't install newextra anywhere */
5477 if (newextra && !extra_field_used(&conf->gen, newextra))
5484 struct config_int *conf = (struct config_int *) record;
5486 void *newextra = NULL;
5490 const char *hintmsg;
5492 if (!parse_int(value, &newval, conf->gen.flags, &hintmsg))
5495 (errcode(ERRCODE_INVALID_PARAMETER_VALUE),
5496 errmsg("invalid value for parameter \"%s\": \"%s\"",
5498 hintmsg ? errhint("%s", _(hintmsg)) : 0));
5501 if (newval < conf->min || newval > conf->max)
5504 (errcode(ERRCODE_INVALID_PARAMETER_VALUE),
5505 errmsg("%d is outside the valid range for parameter \"%s\" (%d .. %d)",
5506 newval, name, conf->min, conf->max)));
5509 if (!call_int_check_hook(conf, &newval, &newextra,
5513 else if (source == PGC_S_DEFAULT)
5515 newval = conf->boot_val;
5516 if (!call_int_check_hook(conf, &newval, &newextra,
5522 newval = conf->reset_val;
5523 newextra = conf->reset_extra;
5524 source = conf->gen.reset_source;
5525 context = conf->gen.reset_scontext;
5528 if (prohibitValueChange)
5530 if (*conf->variable != newval)
5533 (errcode(ERRCODE_CANT_CHANGE_RUNTIME_PARAM),
5534 errmsg("parameter \"%s\" cannot be changed without restarting the server",
5543 /* Save old value to support transaction abort */
5545 push_old_value(&conf->gen, action);
5547 if (conf->assign_hook)
5548 (*conf->assign_hook) (newval, newextra);
5549 *conf->variable = newval;
5550 set_extra_field(&conf->gen, &conf->gen.extra,
5552 conf->gen.source = source;
5553 conf->gen.scontext = context;
5559 if (conf->gen.reset_source <= source)
5561 conf->reset_val = newval;
5562 set_extra_field(&conf->gen, &conf->reset_extra,
5564 conf->gen.reset_source = source;
5565 conf->gen.reset_scontext = context;
5567 for (stack = conf->gen.stack; stack; stack = stack->prev)
5569 if (stack->source <= source)
5571 stack->prior.val.intval = newval;
5572 set_extra_field(&conf->gen, &stack->prior.extra,
5574 stack->source = source;
5575 stack->scontext = context;
5580 /* Perhaps we didn't install newextra anywhere */
5581 if (newextra && !extra_field_used(&conf->gen, newextra))
5588 struct config_real *conf = (struct config_real *) record;
5590 void *newextra = NULL;
5594 if (!parse_real(value, &newval))
5597 (errcode(ERRCODE_INVALID_PARAMETER_VALUE),
5598 errmsg("parameter \"%s\" requires a numeric value",
5602 if (newval < conf->min || newval > conf->max)
5605 (errcode(ERRCODE_INVALID_PARAMETER_VALUE),
5606 errmsg("%g is outside the valid range for parameter \"%s\" (%g .. %g)",
5607 newval, name, conf->min, conf->max)));
5610 if (!call_real_check_hook(conf, &newval, &newextra,
5614 else if (source == PGC_S_DEFAULT)
5616 newval = conf->boot_val;
5617 if (!call_real_check_hook(conf, &newval, &newextra,
5623 newval = conf->reset_val;
5624 newextra = conf->reset_extra;
5625 source = conf->gen.reset_source;
5626 context = conf->gen.reset_scontext;
5629 if (prohibitValueChange)
5631 if (*conf->variable != newval)
5634 (errcode(ERRCODE_CANT_CHANGE_RUNTIME_PARAM),
5635 errmsg("parameter \"%s\" cannot be changed without restarting the server",
5644 /* Save old value to support transaction abort */
5646 push_old_value(&conf->gen, action);
5648 if (conf->assign_hook)
5649 (*conf->assign_hook) (newval, newextra);
5650 *conf->variable = newval;
5651 set_extra_field(&conf->gen, &conf->gen.extra,
5653 conf->gen.source = source;
5654 conf->gen.scontext = context;
5660 if (conf->gen.reset_source <= source)
5662 conf->reset_val = newval;
5663 set_extra_field(&conf->gen, &conf->reset_extra,
5665 conf->gen.reset_source = source;
5666 conf->gen.reset_scontext = context;
5668 for (stack = conf->gen.stack; stack; stack = stack->prev)
5670 if (stack->source <= source)
5672 stack->prior.val.realval = newval;
5673 set_extra_field(&conf->gen, &stack->prior.extra,
5675 stack->source = source;
5676 stack->scontext = context;
5681 /* Perhaps we didn't install newextra anywhere */
5682 if (newextra && !extra_field_used(&conf->gen, newextra))
5689 struct config_string *conf = (struct config_string *) record;
5691 void *newextra = NULL;
5696 * The value passed by the caller could be transient, so
5697 * we always strdup it.
5699 newval = guc_strdup(elevel, value);
5704 * The only built-in "parsing" check we have is to apply
5705 * truncation if GUC_IS_NAME.
5707 if (conf->gen.flags & GUC_IS_NAME)
5708 truncate_identifier(newval, strlen(newval), true);
5710 if (!call_string_check_hook(conf, &newval, &newextra,
5717 else if (source == PGC_S_DEFAULT)
5719 /* non-NULL boot_val must always get strdup'd */
5720 if (conf->boot_val != NULL)
5722 newval = guc_strdup(elevel, conf->boot_val);
5729 if (!call_string_check_hook(conf, &newval, &newextra,
5739 * strdup not needed, since reset_val is already under
5742 newval = conf->reset_val;
5743 newextra = conf->reset_extra;
5744 source = conf->gen.reset_source;
5745 context = conf->gen.reset_scontext;
5748 if (prohibitValueChange)
5750 /* newval shouldn't be NULL, so we're a bit sloppy here */
5751 if (*conf->variable == NULL || newval == NULL ||
5752 strcmp(*conf->variable, newval) != 0)
5755 (errcode(ERRCODE_CANT_CHANGE_RUNTIME_PARAM),
5756 errmsg("parameter \"%s\" cannot be changed without restarting the server",
5765 /* Save old value to support transaction abort */
5767 push_old_value(&conf->gen, action);
5769 if (conf->assign_hook)
5770 (*conf->assign_hook) (newval, newextra);
5771 set_string_field(conf, conf->variable, newval);
5772 set_extra_field(&conf->gen, &conf->gen.extra,
5774 conf->gen.source = source;
5775 conf->gen.scontext = context;
5782 if (conf->gen.reset_source <= source)
5784 set_string_field(conf, &conf->reset_val, newval);
5785 set_extra_field(&conf->gen, &conf->reset_extra,
5787 conf->gen.reset_source = source;
5788 conf->gen.reset_scontext = context;
5790 for (stack = conf->gen.stack; stack; stack = stack->prev)
5792 if (stack->source <= source)
5794 set_string_field(conf, &stack->prior.val.stringval,
5796 set_extra_field(&conf->gen, &stack->prior.extra,
5798 stack->source = source;
5799 stack->scontext = context;
5804 /* Perhaps we didn't install newval anywhere */
5805 if (newval && !string_field_used(conf, newval))
5807 /* Perhaps we didn't install newextra anywhere */
5808 if (newextra && !extra_field_used(&conf->gen, newextra))
5815 struct config_enum *conf = (struct config_enum *) record;
5817 void *newextra = NULL;
5821 if (!config_enum_lookup_by_name(conf, value, &newval))
5825 hintmsg = config_enum_get_options(conf,
5826 "Available values: ",
5830 (errcode(ERRCODE_INVALID_PARAMETER_VALUE),
5831 errmsg("invalid value for parameter \"%s\": \"%s\"",
5833 hintmsg ? errhint("%s", _(hintmsg)) : 0));
5839 if (!call_enum_check_hook(conf, &newval, &newextra,
5843 else if (source == PGC_S_DEFAULT)
5845 newval = conf->boot_val;
5846 if (!call_enum_check_hook(conf, &newval, &newextra,
5852 newval = conf->reset_val;
5853 newextra = conf->reset_extra;
5854 source = conf->gen.reset_source;
5855 context = conf->gen.reset_scontext;
5858 if (prohibitValueChange)
5860 if (*conf->variable != newval)
5863 (errcode(ERRCODE_CANT_CHANGE_RUNTIME_PARAM),
5864 errmsg("parameter \"%s\" cannot be changed without restarting the server",
5873 /* Save old value to support transaction abort */
5875 push_old_value(&conf->gen, action);
5877 if (conf->assign_hook)
5878 (*conf->assign_hook) (newval, newextra);
5879 *conf->variable = newval;
5880 set_extra_field(&conf->gen, &conf->gen.extra,
5882 conf->gen.source = source;
5883 conf->gen.scontext = context;
5889 if (conf->gen.reset_source <= source)
5891 conf->reset_val = newval;
5892 set_extra_field(&conf->gen, &conf->reset_extra,
5894 conf->gen.reset_source = source;
5895 conf->gen.reset_scontext = context;
5897 for (stack = conf->gen.stack; stack; stack = stack->prev)
5899 if (stack->source <= source)
5901 stack->prior.val.enumval = newval;
5902 set_extra_field(&conf->gen, &stack->prior.extra,
5904 stack->source = source;
5905 stack->scontext = context;
5910 /* Perhaps we didn't install newextra anywhere */
5911 if (newextra && !extra_field_used(&conf->gen, newextra))
5917 if (changeVal && (record->flags & GUC_REPORT))
5918 ReportGUCOption(record);
5920 return changeVal ? 1 : -1;
5925 * Set the fields for source file and line number the setting came from.
5928 set_config_sourcefile(const char *name, char *sourcefile, int sourceline)
5930 struct config_generic *record;
5934 * To avoid cluttering the log, only the postmaster bleats loudly about
5935 * problems with the config file.
5937 elevel = IsUnderPostmaster ? DEBUG3 : LOG;
5939 record = find_option(name, true, elevel);
5940 /* should not happen */
5942 elog(ERROR, "unrecognized configuration parameter \"%s\"", name);
5944 sourcefile = guc_strdup(elevel, sourcefile);
5945 if (record->sourcefile)
5946 free(record->sourcefile);
5947 record->sourcefile = sourcefile;
5948 record->sourceline = sourceline;
5952 * Set a config option to the given value.
5954 * See also set_config_option; this is just the wrapper to be called from
5955 * outside GUC. (This function should be used when possible, because its API
5956 * is more stable than set_config_option's.)
5958 * Note: there is no support here for setting source file/line, as it
5959 * is currently not needed.
5962 SetConfigOption(const char *name, const char *value,
5963 GucContext context, GucSource source)
5965 (void) set_config_option(name, value, context, source,
5966 GUC_ACTION_SET, true, 0);
5972 * Fetch the current value of the option `name', as a string.
5974 * If the option doesn't exist, return NULL if missing_ok is true (NOTE that
5975 * this cannot be distinguished from a string variable with a NULL value!),
5976 * otherwise throw an ereport and don't return.
5978 * If restrict_superuser is true, we also enforce that only superusers can
5979 * see GUC_SUPERUSER_ONLY variables. This should only be passed as true
5980 * in user-driven calls.
5982 * The string is *not* allocated for modification and is really only
5983 * valid until the next call to configuration related functions.
5986 GetConfigOption(const char *name, bool missing_ok, bool restrict_superuser)
5988 struct config_generic *record;
5989 static char buffer[256];
5991 record = find_option(name, false, ERROR);
5997 (errcode(ERRCODE_UNDEFINED_OBJECT),
5998 errmsg("unrecognized configuration parameter \"%s\"",
6001 if (restrict_superuser &&
6002 (record->flags & GUC_SUPERUSER_ONLY) &&
6005 (errcode(ERRCODE_INSUFFICIENT_PRIVILEGE),
6006 errmsg("must be superuser to examine \"%s\"", name)));
6008 switch (record->vartype)
6011 return *((struct config_bool *) record)->variable ? "on" : "off";
6014 snprintf(buffer, sizeof(buffer), "%d",
6015 *((struct config_int *) record)->variable);
6019 snprintf(buffer, sizeof(buffer), "%g",
6020 *((struct config_real *) record)->variable);
6024 return *((struct config_string *) record)->variable;
6027 return config_enum_lookup_by_value((struct config_enum *) record,
6028 *((struct config_enum *) record)->variable);
6034 * Get the RESET value associated with the given option.
6036 * Note: this is not re-entrant, due to use of static result buffer;
6037 * not to mention that a string variable could have its reset_val changed.
6038 * Beware of assuming the result value is good for very long.
6041 GetConfigOptionResetString(const char *name)
6043 struct config_generic *record;
6044 static char buffer[256];
6046 record = find_option(name, false, ERROR);
6049 (errcode(ERRCODE_UNDEFINED_OBJECT),
6050 errmsg("unrecognized configuration parameter \"%s\"", name)));
6051 if ((record->flags & GUC_SUPERUSER_ONLY) && !superuser())
6053 (errcode(ERRCODE_INSUFFICIENT_PRIVILEGE),
6054 errmsg("must be superuser to examine \"%s\"", name)));
6056 switch (record->vartype)
6059 return ((struct config_bool *) record)->reset_val ? "on" : "off";
6062 snprintf(buffer, sizeof(buffer), "%d",
6063 ((struct config_int *) record)->reset_val);
6067 snprintf(buffer, sizeof(buffer), "%g",
6068 ((struct config_real *) record)->reset_val);
6072 return ((struct config_string *) record)->reset_val;
6075 return config_enum_lookup_by_value((struct config_enum *) record,
6076 ((struct config_enum *) record)->reset_val);
6083 * flatten_set_variable_args
6084 * Given a parsenode List as emitted by the grammar for SET,
6085 * convert to the flat string representation used by GUC.
6087 * We need to be told the name of the variable the args are for, because
6088 * the flattening rules vary (ugh).
6090 * The result is NULL if args is NIL (ie, SET ... TO DEFAULT), otherwise
6091 * a palloc'd string.
6094 flatten_set_variable_args(const char *name, List *args)
6096 struct config_generic *record;
6101 /* Fast path if just DEFAULT */
6106 * Get flags for the variable; if it's not known, use default flags.
6107 * (Caller might throw error later, but not our business to do so here.)
6109 record = find_option(name, false, WARNING);
6111 flags = record->flags;
6115 /* Complain if list input and non-list variable */
6116 if ((flags & GUC_LIST_INPUT) == 0 &&
6117 list_length(args) != 1)
6119 (errcode(ERRCODE_INVALID_PARAMETER_VALUE),
6120 errmsg("SET %s takes only one argument", name)));
6122 initStringInfo(&buf);
6125 * Each list member may be a plain A_Const node, or an A_Const within a
6126 * TypeCast; the latter case is supported only for ConstInterval arguments
6127 * (for SET TIME ZONE).
6131 Node *arg = (Node *) lfirst(l);
6133 TypeName *typeName = NULL;
6136 if (l != list_head(args))
6137 appendStringInfo(&buf, ", ");
6139 if (IsA(arg, TypeCast))
6141 TypeCast *tc = (TypeCast *) arg;
6144 typeName = tc->typeName;
6147 if (!IsA(arg, A_Const))
6148 elog(ERROR, "unrecognized node type: %d", (int) nodeTag(arg));
6149 con = (A_Const *) arg;
6151 switch (nodeTag(&con->val))
6154 appendStringInfo(&buf, "%ld", intVal(&con->val));
6157 /* represented as a string, so just copy it */
6158 appendStringInfoString(&buf, strVal(&con->val));
6161 val = strVal(&con->val);
6162 if (typeName != NULL)
6165 * Must be a ConstInterval argument for TIME ZONE. Coerce
6166 * to interval and back to normalize the value and account
6174 typenameTypeIdAndMod(NULL, typeName, &typoid, &typmod);
6175 Assert(typoid == INTERVALOID);
6178 DirectFunctionCall3(interval_in,
6179 CStringGetDatum(val),
6180 ObjectIdGetDatum(InvalidOid),
6181 Int32GetDatum(typmod));
6184 DatumGetCString(DirectFunctionCall1(interval_out,
6186 appendStringInfo(&buf, "INTERVAL '%s'", intervalout);
6191 * Plain string literal or identifier. For quote mode,
6192 * quote it if it's not a vanilla identifier.
6194 if (flags & GUC_LIST_QUOTE)
6195 appendStringInfoString(&buf, quote_identifier(val));
6197 appendStringInfoString(&buf, val);
6201 elog(ERROR, "unrecognized node type: %d",
6202 (int) nodeTag(&con->val));
6215 ExecSetVariableStmt(VariableSetStmt *stmt)
6217 GucAction action = stmt->is_local ? GUC_ACTION_LOCAL : GUC_ACTION_SET;
6222 case VAR_SET_CURRENT:
6223 (void) set_config_option(stmt->name,
6224 ExtractSetVariableArgs(stmt),
6225 (superuser() ? PGC_SUSET : PGC_USERSET),
6234 * Special-case SQL syntaxes. The TRANSACTION and SESSION
6235 * CHARACTERISTICS cases effectively set more than one variable
6236 * per statement. TRANSACTION SNAPSHOT only takes one argument,
6237 * but we put it here anyway since it's a special case and not
6238 * related to any GUC variable.
6240 if (strcmp(stmt->name, "TRANSACTION") == 0)
6244 foreach(head, stmt->args)
6246 DefElem *item = (DefElem *) lfirst(head);
6248 if (strcmp(item->defname, "transaction_isolation") == 0)
6249 SetPGVariable("transaction_isolation",
6250 list_make1(item->arg), stmt->is_local);
6251 else if (strcmp(item->defname, "transaction_read_only") == 0)
6252 SetPGVariable("transaction_read_only",
6253 list_make1(item->arg), stmt->is_local);
6254 else if (strcmp(item->defname, "transaction_deferrable") == 0)
6255 SetPGVariable("transaction_deferrable",
6256 list_make1(item->arg), stmt->is_local);
6258 elog(ERROR, "unexpected SET TRANSACTION element: %s",
6262 else if (strcmp(stmt->name, "SESSION CHARACTERISTICS") == 0)
6266 foreach(head, stmt->args)
6268 DefElem *item = (DefElem *) lfirst(head);
6270 if (strcmp(item->defname, "transaction_isolation") == 0)
6271 SetPGVariable("default_transaction_isolation",
6272 list_make1(item->arg), stmt->is_local);
6273 else if (strcmp(item->defname, "transaction_read_only") == 0)
6274 SetPGVariable("default_transaction_read_only",
6275 list_make1(item->arg), stmt->is_local);
6276 else if (strcmp(item->defname, "transaction_deferrable") == 0)
6277 SetPGVariable("default_transaction_deferrable",
6278 list_make1(item->arg), stmt->is_local);
6280 elog(ERROR, "unexpected SET SESSION element: %s",
6284 else if (strcmp(stmt->name, "TRANSACTION SNAPSHOT") == 0)
6286 A_Const *con = (A_Const *) linitial(stmt->args);
6290 (errcode(ERRCODE_FEATURE_NOT_SUPPORTED),
6291 errmsg("SET LOCAL TRANSACTION SNAPSHOT is not implemented")));
6292 Assert(IsA(con, A_Const));
6293 Assert(nodeTag(&con->val) == T_String);
6294 ImportSnapshot(strVal(&con->val));
6297 elog(ERROR, "unexpected SET MULTI element: %s",
6300 case VAR_SET_DEFAULT:
6302 (void) set_config_option(stmt->name,
6304 (superuser() ? PGC_SUSET : PGC_USERSET),
6317 * Get the value to assign for a VariableSetStmt, or NULL if it's RESET.
6318 * The result is palloc'd.
6320 * This is exported for use by actions such as ALTER ROLE SET.
6323 ExtractSetVariableArgs(VariableSetStmt *stmt)
6328 return flatten_set_variable_args(stmt->name, stmt->args);
6329 case VAR_SET_CURRENT:
6330 return GetConfigOptionByName(stmt->name, NULL);
6337 * SetPGVariable - SET command exported as an easily-C-callable function.
6339 * This provides access to SET TO value, as well as SET TO DEFAULT (expressed
6340 * by passing args == NIL), but not SET FROM CURRENT functionality.
6343 SetPGVariable(const char *name, List *args, bool is_local)
6345 char *argstring = flatten_set_variable_args(name, args);
6347 /* Note SET DEFAULT (argstring == NULL) is equivalent to RESET */
6348 (void) set_config_option(name,
6350 (superuser() ? PGC_SUSET : PGC_USERSET),
6352 is_local ? GUC_ACTION_LOCAL : GUC_ACTION_SET,
6358 * SET command wrapped as a SQL callable function.
6361 set_config_by_name(PG_FUNCTION_ARGS)
6368 if (PG_ARGISNULL(0))
6370 (errcode(ERRCODE_NULL_VALUE_NOT_ALLOWED),
6371 errmsg("SET requires parameter name")));
6373 /* Get the GUC variable name */
6374 name = TextDatumGetCString(PG_GETARG_DATUM(0));
6376 /* Get the desired value or set to NULL for a reset request */
6377 if (PG_ARGISNULL(1))
6380 value = TextDatumGetCString(PG_GETARG_DATUM(1));
6383 * Get the desired state of is_local. Default to false if provided value
6386 if (PG_ARGISNULL(2))
6389 is_local = PG_GETARG_BOOL(2);
6391 /* Note SET DEFAULT (argstring == NULL) is equivalent to RESET */
6392 (void) set_config_option(name,
6394 (superuser() ? PGC_SUSET : PGC_USERSET),
6396 is_local ? GUC_ACTION_LOCAL : GUC_ACTION_SET,
6400 /* get the new current value */
6401 new_value = GetConfigOptionByName(name, NULL);
6403 /* Convert return string to text */
6404 PG_RETURN_TEXT_P(cstring_to_text(new_value));
6409 * Common code for DefineCustomXXXVariable subroutines: allocate the
6410 * new variable's config struct and fill in generic fields.
6412 static struct config_generic *
6413 init_custom_variable(const char *name,
6414 const char *short_desc,
6415 const char *long_desc,
6418 enum config_type type,
6421 struct config_generic *gen;
6424 * Only allow custom PGC_POSTMASTER variables to be created during shared
6425 * library preload; any later than that, we can't ensure that the value
6426 * doesn't change after startup. This is a fatal elog if it happens; just
6427 * erroring out isn't safe because we don't know what the calling loadable
6428 * module might already have hooked into.
6430 if (context == PGC_POSTMASTER &&
6431 !process_shared_preload_libraries_in_progress)
6432 elog(FATAL, "cannot create PGC_POSTMASTER variables after startup");
6434 gen = (struct config_generic *) guc_malloc(ERROR, sz);
6437 gen->name = guc_strdup(ERROR, name);
6438 gen->context = context;
6439 gen->group = CUSTOM_OPTIONS;
6440 gen->short_desc = short_desc;
6441 gen->long_desc = long_desc;
6443 gen->vartype = type;
6449 * Common code for DefineCustomXXXVariable subroutines: insert the new
6450 * variable into the GUC variable array, replacing any placeholder.
6453 define_custom_variable(struct config_generic * variable)
6455 const char *name = variable->name;
6456 const char **nameAddr = &name;
6457 struct config_string *pHolder;
6458 struct config_generic **res;
6461 * See if there's a placeholder by the same name.
6463 res = (struct config_generic **) bsearch((void *) &nameAddr,
6464 (void *) guc_variables,
6466 sizeof(struct config_generic *),
6471 * No placeholder to replace, so we can just add it ... but first,
6472 * make sure it's initialized to its default value.
6474 InitializeOneGUCOption(variable);
6475 add_guc_variable(variable, ERROR);
6480 * This better be a placeholder
6482 if (((*res)->flags & GUC_CUSTOM_PLACEHOLDER) == 0)
6484 (errcode(ERRCODE_INTERNAL_ERROR),
6485 errmsg("attempt to redefine parameter \"%s\"", name)));
6487 Assert((*res)->vartype == PGC_STRING);
6488 pHolder = (struct config_string *) (*res);
6491 * First, set the variable to its default value. We must do this even
6492 * though we intend to immediately apply a new value, since it's possible
6493 * that the new value is invalid.
6495 InitializeOneGUCOption(variable);
6498 * Replace the placeholder. We aren't changing the name, so no re-sorting
6504 * Assign the string value(s) stored in the placeholder to the real
6505 * variable. Essentially, we need to duplicate all the active and stacked
6506 * values, but with appropriate validation and datatype adjustment.
6508 * If an assignment fails, we report a WARNING and keep going. We don't
6509 * want to throw ERROR for bad values, because it'd bollix the add-on
6510 * module that's presumably halfway through getting loaded. In such cases
6511 * the default or previous state will become active instead.
6514 /* First, apply the reset value if any */
6515 if (pHolder->reset_val)
6516 (void) set_config_option(name, pHolder->reset_val,
6517 pHolder->gen.reset_scontext,
6518 pHolder->gen.reset_source,
6519 GUC_ACTION_SET, true, WARNING);
6520 /* That should not have resulted in stacking anything */
6521 Assert(variable->stack == NULL);
6523 /* Now, apply current and stacked values, in the order they were stacked */
6524 reapply_stacked_values(variable, pHolder, pHolder->gen.stack,
6525 *(pHolder->variable),
6526 pHolder->gen.scontext, pHolder->gen.source);
6528 /* Also copy over any saved source-location information */
6529 if (pHolder->gen.sourcefile)
6530 set_config_sourcefile(name, pHolder->gen.sourcefile,
6531 pHolder->gen.sourceline);
6534 * Free up as much as we conveniently can of the placeholder structure.
6535 * (This neglects any stack items, so it's possible for some memory to be
6536 * leaked. Since this can only happen once per session per variable, it
6537 * doesn't seem worth spending much code on.)
6539 set_string_field(pHolder, pHolder->variable, NULL);
6540 set_string_field(pHolder, &pHolder->reset_val, NULL);
6546 * Recursive subroutine for define_custom_variable: reapply non-reset values
6548 * We recurse so that the values are applied in the same order as originally.
6549 * At each recursion level, apply the upper-level value (passed in) in the
6550 * fashion implied by the stack entry.
6553 reapply_stacked_values(struct config_generic * variable,
6554 struct config_string * pHolder,
6556 const char *curvalue,
6557 GucContext curscontext, GucSource cursource)
6559 const char *name = variable->name;
6560 GucStack *oldvarstack = variable->stack;
6564 /* First, recurse, so that stack items are processed bottom to top */
6565 reapply_stacked_values(variable, pHolder, stack->prev,
6566 stack->prior.val.stringval,
6567 stack->scontext, stack->source);
6569 /* See how to apply the passed-in value */
6570 switch (stack->state)
6573 (void) set_config_option(name, curvalue,
6574 curscontext, cursource,
6575 GUC_ACTION_SAVE, true, WARNING);
6579 (void) set_config_option(name, curvalue,
6580 curscontext, cursource,
6581 GUC_ACTION_SET, true, WARNING);
6585 (void) set_config_option(name, curvalue,
6586 curscontext, cursource,
6587 GUC_ACTION_LOCAL, true, WARNING);
6591 /* first, apply the masked value as SET */
6592 (void) set_config_option(name, stack->masked.val.stringval,
6593 stack->masked_scontext, PGC_S_SESSION,
6594 GUC_ACTION_SET, true, WARNING);
6595 /* then apply the current value as LOCAL */
6596 (void) set_config_option(name, curvalue,
6597 curscontext, cursource,
6598 GUC_ACTION_LOCAL, true, WARNING);
6602 /* If we successfully made a stack entry, adjust its nest level */
6603 if (variable->stack != oldvarstack)
6604 variable->stack->nest_level = stack->nest_level;
6609 * We are at the end of the stack. If the active/previous value is
6610 * different from the reset value, it must represent a previously
6611 * committed session value. Apply it, and then drop the stack entry
6612 * that set_config_option will have created under the impression that
6613 * this is to be just a transactional assignment. (We leak the stack
6616 if (curvalue != pHolder->reset_val ||
6617 curscontext != pHolder->gen.reset_scontext ||
6618 cursource != pHolder->gen.reset_source)
6620 (void) set_config_option(name, curvalue,
6621 curscontext, cursource,
6622 GUC_ACTION_SET, true, WARNING);
6623 variable->stack = NULL;
6629 DefineCustomBoolVariable(const char *name,
6630 const char *short_desc,
6631 const char *long_desc,
6636 GucBoolCheckHook check_hook,
6637 GucBoolAssignHook assign_hook,
6638 GucShowHook show_hook)
6640 struct config_bool *var;
6642 var = (struct config_bool *)
6643 init_custom_variable(name, short_desc, long_desc, context, flags,
6644 PGC_BOOL, sizeof(struct config_bool));
6645 var->variable = valueAddr;
6646 var->boot_val = bootValue;
6647 var->reset_val = bootValue;
6648 var->check_hook = check_hook;
6649 var->assign_hook = assign_hook;
6650 var->show_hook = show_hook;
6651 define_custom_variable(&var->gen);
6655 DefineCustomIntVariable(const char *name,
6656 const char *short_desc,
6657 const char *long_desc,
6664 GucIntCheckHook check_hook,
6665 GucIntAssignHook assign_hook,
6666 GucShowHook show_hook)
6668 struct config_int *var;
6670 var = (struct config_int *)
6671 init_custom_variable(name, short_desc, long_desc, context, flags,
6672 PGC_INT, sizeof(struct config_int));
6673 var->variable = valueAddr;
6674 var->boot_val = bootValue;
6675 var->reset_val = bootValue;
6676 var->min = minValue;
6677 var->max = maxValue;
6678 var->check_hook = check_hook;
6679 var->assign_hook = assign_hook;
6680 var->show_hook = show_hook;
6681 define_custom_variable(&var->gen);
6685 DefineCustomRealVariable(const char *name,
6686 const char *short_desc,
6687 const char *long_desc,
6694 GucRealCheckHook check_hook,
6695 GucRealAssignHook assign_hook,
6696 GucShowHook show_hook)
6698 struct config_real *var;
6700 var = (struct config_real *)
6701 init_custom_variable(name, short_desc, long_desc, context, flags,
6702 PGC_REAL, sizeof(struct config_real));
6703 var->variable = valueAddr;
6704 var->boot_val = bootValue;
6705 var->reset_val = bootValue;
6706 var->min = minValue;
6707 var->max = maxValue;
6708 var->check_hook = check_hook;
6709 var->assign_hook = assign_hook;
6710 var->show_hook = show_hook;
6711 define_custom_variable(&var->gen);
6715 DefineCustomStringVariable(const char *name,
6716 const char *short_desc,
6717 const char *long_desc,
6719 const char *bootValue,
6722 GucStringCheckHook check_hook,
6723 GucStringAssignHook assign_hook,
6724 GucShowHook show_hook)
6726 struct config_string *var;
6728 var = (struct config_string *)
6729 init_custom_variable(name, short_desc, long_desc, context, flags,
6730 PGC_STRING, sizeof(struct config_string));
6731 var->variable = valueAddr;
6732 var->boot_val = bootValue;
6733 var->check_hook = check_hook;
6734 var->assign_hook = assign_hook;
6735 var->show_hook = show_hook;
6736 define_custom_variable(&var->gen);
6740 DefineCustomEnumVariable(const char *name,
6741 const char *short_desc,
6742 const char *long_desc,
6745 const struct config_enum_entry * options,
6748 GucEnumCheckHook check_hook,
6749 GucEnumAssignHook assign_hook,
6750 GucShowHook show_hook)
6752 struct config_enum *var;
6754 var = (struct config_enum *)
6755 init_custom_variable(name, short_desc, long_desc, context, flags,
6756 PGC_ENUM, sizeof(struct config_enum));
6757 var->variable = valueAddr;
6758 var->boot_val = bootValue;
6759 var->reset_val = bootValue;
6760 var->options = options;
6761 var->check_hook = check_hook;
6762 var->assign_hook = assign_hook;
6763 var->show_hook = show_hook;
6764 define_custom_variable(&var->gen);
6768 EmitWarningsOnPlaceholders(const char *className)
6770 int classLen = strlen(className);
6773 for (i = 0; i < num_guc_variables; i++)
6775 struct config_generic *var = guc_variables[i];
6777 if ((var->flags & GUC_CUSTOM_PLACEHOLDER) != 0 &&
6778 strncmp(className, var->name, classLen) == 0 &&
6779 var->name[classLen] == GUC_QUALIFIER_SEPARATOR)
6782 (errcode(ERRCODE_UNDEFINED_OBJECT),
6783 errmsg("unrecognized configuration parameter \"%s\"",
6794 GetPGVariable(const char *name, DestReceiver *dest)
6796 if (guc_name_compare(name, "all") == 0)
6797 ShowAllGUCConfig(dest);
6799 ShowGUCConfigOption(name, dest);
6803 GetPGVariableResultDesc(const char *name)
6807 if (guc_name_compare(name, "all") == 0)
6809 /* need a tuple descriptor representing three TEXT columns */
6810 tupdesc = CreateTemplateTupleDesc(3, false);
6811 TupleDescInitEntry(tupdesc, (AttrNumber) 1, "name",
6813 TupleDescInitEntry(tupdesc, (AttrNumber) 2, "setting",
6815 TupleDescInitEntry(tupdesc, (AttrNumber) 3, "description",
6820 const char *varname;
6822 /* Get the canonical spelling of name */
6823 (void) GetConfigOptionByName(name, &varname);
6825 /* need a tuple descriptor representing a single TEXT column */
6826 tupdesc = CreateTemplateTupleDesc(1, false);
6827 TupleDescInitEntry(tupdesc, (AttrNumber) 1, varname,
6838 ShowGUCConfigOption(const char *name, DestReceiver *dest)
6840 TupOutputState *tstate;
6842 const char *varname;
6845 /* Get the value and canonical spelling of name */
6846 value = GetConfigOptionByName(name, &varname);
6848 /* need a tuple descriptor representing a single TEXT column */
6849 tupdesc = CreateTemplateTupleDesc(1, false);
6850 TupleDescInitEntry(tupdesc, (AttrNumber) 1, varname,
6853 /* prepare for projection of tuples */
6854 tstate = begin_tup_output_tupdesc(dest, tupdesc);
6857 do_text_output_oneline(tstate, value);
6859 end_tup_output(tstate);
6866 ShowAllGUCConfig(DestReceiver *dest)
6868 bool am_superuser = superuser();
6870 TupOutputState *tstate;
6873 bool isnull[3] = {false, false, false};
6875 /* need a tuple descriptor representing three TEXT columns */
6876 tupdesc = CreateTemplateTupleDesc(3, false);
6877 TupleDescInitEntry(tupdesc, (AttrNumber) 1, "name",
6879 TupleDescInitEntry(tupdesc, (AttrNumber) 2, "setting",
6881 TupleDescInitEntry(tupdesc, (AttrNumber) 3, "description",
6884 /* prepare for projection of tuples */
6885 tstate = begin_tup_output_tupdesc(dest, tupdesc);
6887 for (i = 0; i < num_guc_variables; i++)
6889 struct config_generic *conf = guc_variables[i];
6892 if ((conf->flags & GUC_NO_SHOW_ALL) ||
6893 ((conf->flags & GUC_SUPERUSER_ONLY) && !am_superuser))
6896 /* assign to the values array */
6897 values[0] = PointerGetDatum(cstring_to_text(conf->name));
6899 setting = _ShowOption(conf, true);
6902 values[1] = PointerGetDatum(cstring_to_text(setting));
6907 values[1] = PointerGetDatum(NULL);
6911 values[2] = PointerGetDatum(cstring_to_text(conf->short_desc));
6913 /* send it to dest */
6914 do_tup_output(tstate, values, isnull);
6917 pfree(DatumGetPointer(values[0]));
6921 pfree(DatumGetPointer(values[1]));
6923 pfree(DatumGetPointer(values[2]));
6926 end_tup_output(tstate);
6930 * Return GUC variable value by name; optionally return canonical
6931 * form of name. Return value is palloc'd.
6934 GetConfigOptionByName(const char *name, const char **varname)
6936 struct config_generic *record;
6938 record = find_option(name, false, ERROR);
6941 (errcode(ERRCODE_UNDEFINED_OBJECT),
6942 errmsg("unrecognized configuration parameter \"%s\"", name)));
6943 if ((record->flags & GUC_SUPERUSER_ONLY) && !superuser())
6945 (errcode(ERRCODE_INSUFFICIENT_PRIVILEGE),
6946 errmsg("must be superuser to examine \"%s\"", name)));
6949 *varname = record->name;
6951 return _ShowOption(record, true);
6955 * Return GUC variable value by variable number; optionally return canonical
6956 * form of name. Return value is palloc'd.
6959 GetConfigOptionByNum(int varnum, const char **values, bool *noshow)
6962 struct config_generic *conf;
6964 /* check requested variable number valid */
6965 Assert((varnum >= 0) && (varnum < num_guc_variables));
6967 conf = guc_variables[varnum];
6971 if ((conf->flags & GUC_NO_SHOW_ALL) ||
6972 ((conf->flags & GUC_SUPERUSER_ONLY) && !superuser()))
6978 /* first get the generic attributes */
6981 values[0] = conf->name;
6983 /* setting : use _ShowOption in order to avoid duplicating the logic */
6984 values[1] = _ShowOption(conf, false);
6987 if (conf->vartype == PGC_INT)
6991 switch (conf->flags & (GUC_UNIT_MEMORY | GUC_UNIT_TIME))
6996 case GUC_UNIT_BLOCKS:
6997 snprintf(buf, sizeof(buf), "%dkB", BLCKSZ / 1024);
7000 case GUC_UNIT_XBLOCKS:
7001 snprintf(buf, sizeof(buf), "%dkB", XLOG_BLCKSZ / 1024);
7022 values[3] = config_group_names[conf->group];
7025 values[4] = conf->short_desc;
7028 values[5] = conf->long_desc;
7031 values[6] = GucContext_Names[conf->context];
7034 values[7] = config_type_names[conf->vartype];
7037 values[8] = GucSource_Names[conf->source];
7039 /* now get the type specifc attributes */
7040 switch (conf->vartype)
7044 struct config_bool *lconf = (struct config_bool *) conf;
7056 values[12] = pstrdup(lconf->boot_val ? "on" : "off");
7059 values[13] = pstrdup(lconf->reset_val ? "on" : "off");
7065 struct config_int *lconf = (struct config_int *) conf;
7068 snprintf(buffer, sizeof(buffer), "%d", lconf->min);
7069 values[9] = pstrdup(buffer);
7072 snprintf(buffer, sizeof(buffer), "%d", lconf->max);
7073 values[10] = pstrdup(buffer);
7079 snprintf(buffer, sizeof(buffer), "%d", lconf->boot_val);
7080 values[12] = pstrdup(buffer);
7083 snprintf(buffer, sizeof(buffer), "%d", lconf->reset_val);
7084 values[13] = pstrdup(buffer);
7090 struct config_real *lconf = (struct config_real *) conf;
7093 snprintf(buffer, sizeof(buffer), "%g", lconf->min);
7094 values[9] = pstrdup(buffer);
7097 snprintf(buffer, sizeof(buffer), "%g", lconf->max);
7098 values[10] = pstrdup(buffer);
7104 snprintf(buffer, sizeof(buffer), "%g", lconf->boot_val);
7105 values[12] = pstrdup(buffer);
7108 snprintf(buffer, sizeof(buffer), "%g", lconf->reset_val);
7109 values[13] = pstrdup(buffer);
7115 struct config_string *lconf = (struct config_string *) conf;
7127 if (lconf->boot_val == NULL)
7130 values[12] = pstrdup(lconf->boot_val);
7133 if (lconf->reset_val == NULL)
7136 values[13] = pstrdup(lconf->reset_val);
7142 struct config_enum *lconf = (struct config_enum *) conf;
7153 * NOTE! enumvals with double quotes in them are not
7156 values[11] = config_enum_get_options((struct config_enum *) conf,
7157 "{\"", "\"}", "\",\"");
7160 values[12] = pstrdup(config_enum_lookup_by_value(lconf,
7164 values[13] = pstrdup(config_enum_lookup_by_value(lconf,
7172 * should never get here, but in case we do, set 'em to NULL
7194 * If the setting came from a config file, set the source location. For
7195 * security reasons, we don't show source file/line number for
7198 if (conf->source == PGC_S_FILE && superuser())
7200 values[14] = conf->sourcefile;
7201 snprintf(buffer, sizeof(buffer), "%d", conf->sourceline);
7202 values[15] = pstrdup(buffer);
7212 * Return the total number of GUC variables
7215 GetNumConfigOptions(void)
7217 return num_guc_variables;
7221 * show_config_by_name - equiv to SHOW X command but implemented as
7225 show_config_by_name(PG_FUNCTION_ARGS)
7230 /* Get the GUC variable name */
7231 varname = TextDatumGetCString(PG_GETARG_DATUM(0));
7234 varval = GetConfigOptionByName(varname, NULL);
7236 /* Convert to text */
7237 PG_RETURN_TEXT_P(cstring_to_text(varval));
7241 * show_all_settings - equiv to SHOW ALL command but implemented as
7244 #define NUM_PG_SETTINGS_ATTS 16
7247 show_all_settings(PG_FUNCTION_ARGS)
7249 FuncCallContext *funcctx;
7253 AttInMetadata *attinmeta;
7254 MemoryContext oldcontext;
7256 /* stuff done only on the first call of the function */
7257 if (SRF_IS_FIRSTCALL())
7259 /* create a function context for cross-call persistence */
7260 funcctx = SRF_FIRSTCALL_INIT();
7263 * switch to memory context appropriate for multiple function calls
7265 oldcontext = MemoryContextSwitchTo(funcctx->multi_call_memory_ctx);
7268 * need a tuple descriptor representing NUM_PG_SETTINGS_ATTS columns
7269 * of the appropriate types
7271 tupdesc = CreateTemplateTupleDesc(NUM_PG_SETTINGS_ATTS, false);
7272 TupleDescInitEntry(tupdesc, (AttrNumber) 1, "name",
7274 TupleDescInitEntry(tupdesc, (AttrNumber) 2, "setting",
7276 TupleDescInitEntry(tupdesc, (AttrNumber) 3, "unit",
7278 TupleDescInitEntry(tupdesc, (AttrNumber) 4, "category",
7280 TupleDescInitEntry(tupdesc, (AttrNumber) 5, "short_desc",
7282 TupleDescInitEntry(tupdesc, (AttrNumber) 6, "extra_desc",
7284 TupleDescInitEntry(tupdesc, (AttrNumber) 7, "context",
7286 TupleDescInitEntry(tupdesc, (AttrNumber) 8, "vartype",
7288 TupleDescInitEntry(tupdesc, (AttrNumber) 9, "source",
7290 TupleDescInitEntry(tupdesc, (AttrNumber) 10, "min_val",
7292 TupleDescInitEntry(tupdesc, (AttrNumber) 11, "max_val",
7294 TupleDescInitEntry(tupdesc, (AttrNumber) 12, "enumvals",
7295 TEXTARRAYOID, -1, 0);
7296 TupleDescInitEntry(tupdesc, (AttrNumber) 13, "boot_val",
7298 TupleDescInitEntry(tupdesc, (AttrNumber) 14, "reset_val",
7300 TupleDescInitEntry(tupdesc, (AttrNumber) 15, "sourcefile",
7302 TupleDescInitEntry(tupdesc, (AttrNumber) 16, "sourceline",
7306 * Generate attribute metadata needed later to produce tuples from raw
7309 attinmeta = TupleDescGetAttInMetadata(tupdesc);
7310 funcctx->attinmeta = attinmeta;
7312 /* total number of tuples to be returned */
7313 funcctx->max_calls = GetNumConfigOptions();
7315 MemoryContextSwitchTo(oldcontext);
7318 /* stuff done on every call of the function */
7319 funcctx = SRF_PERCALL_SETUP();
7321 call_cntr = funcctx->call_cntr;
7322 max_calls = funcctx->max_calls;
7323 attinmeta = funcctx->attinmeta;
7325 if (call_cntr < max_calls) /* do when there is more left to send */
7327 char *values[NUM_PG_SETTINGS_ATTS];
7333 * Get the next visible GUC variable name and value
7337 GetConfigOptionByNum(call_cntr, (const char **) values, &noshow);
7340 /* bump the counter and get the next config setting */
7341 call_cntr = ++funcctx->call_cntr;
7343 /* make sure we haven't gone too far now */
7344 if (call_cntr >= max_calls)
7345 SRF_RETURN_DONE(funcctx);
7350 tuple = BuildTupleFromCStrings(attinmeta, values);
7352 /* make the tuple into a datum */
7353 result = HeapTupleGetDatum(tuple);
7355 SRF_RETURN_NEXT(funcctx, result);
7359 /* do when there is no more left */
7360 SRF_RETURN_DONE(funcctx);
7365 _ShowOption(struct config_generic * record, bool use_units)
7370 switch (record->vartype)
7374 struct config_bool *conf = (struct config_bool *) record;
7376 if (conf->show_hook)
7377 val = (*conf->show_hook) ();
7379 val = *conf->variable ? "on" : "off";
7385 struct config_int *conf = (struct config_int *) record;
7387 if (conf->show_hook)
7388 val = (*conf->show_hook) ();
7392 * Use int64 arithmetic to avoid overflows in units
7395 int64 result = *conf->variable;
7398 if (use_units && result > 0 &&
7399 (record->flags & GUC_UNIT_MEMORY))
7401 switch (record->flags & GUC_UNIT_MEMORY)
7403 case GUC_UNIT_BLOCKS:
7404 result *= BLCKSZ / 1024;
7406 case GUC_UNIT_XBLOCKS:
7407 result *= XLOG_BLCKSZ / 1024;
7411 if (result % KB_PER_GB == 0)
7413 result /= KB_PER_GB;
7416 else if (result % KB_PER_MB == 0)
7418 result /= KB_PER_MB;
7426 else if (use_units && result > 0 &&
7427 (record->flags & GUC_UNIT_TIME))
7429 switch (record->flags & GUC_UNIT_TIME)
7435 result *= MS_PER_MIN;
7439 if (result % MS_PER_D == 0)
7444 else if (result % MS_PER_H == 0)
7449 else if (result % MS_PER_MIN == 0)
7451 result /= MS_PER_MIN;
7454 else if (result % MS_PER_S == 0)
7467 snprintf(buffer, sizeof(buffer), INT64_FORMAT "%s",
7476 struct config_real *conf = (struct config_real *) record;
7478 if (conf->show_hook)
7479 val = (*conf->show_hook) ();
7482 snprintf(buffer, sizeof(buffer), "%g",
7491 struct config_string *conf = (struct config_string *) record;
7493 if (conf->show_hook)
7494 val = (*conf->show_hook) ();
7495 else if (*conf->variable && **conf->variable)
7496 val = *conf->variable;
7504 struct config_enum *conf = (struct config_enum *) record;
7506 if (conf->show_hook)
7507 val = (*conf->show_hook) ();
7509 val = config_enum_lookup_by_value(conf, *conf->variable);
7514 /* just to keep compiler quiet */
7519 return pstrdup(val);
7526 * These routines dump out all non-default GUC options into a binary
7527 * file that is read by all exec'ed backends. The format is:
7529 * variable name, string, null terminated
7530 * variable value, string, null terminated
7531 * variable sourcefile, string, null terminated (empty if none)
7532 * variable sourceline, integer
7533 * variable source, integer
7534 * variable scontext, integer
7537 write_one_nondefault_variable(FILE *fp, struct config_generic * gconf)
7539 if (gconf->source == PGC_S_DEFAULT)
7542 fprintf(fp, "%s", gconf->name);
7545 switch (gconf->vartype)
7549 struct config_bool *conf = (struct config_bool *) gconf;
7551 if (*conf->variable)
7552 fprintf(fp, "true");
7554 fprintf(fp, "false");
7560 struct config_int *conf = (struct config_int *) gconf;
7562 fprintf(fp, "%d", *conf->variable);
7568 struct config_real *conf = (struct config_real *) gconf;
7570 fprintf(fp, "%.17g", *conf->variable);
7576 struct config_string *conf = (struct config_string *) gconf;
7578 fprintf(fp, "%s", *conf->variable);
7584 struct config_enum *conf = (struct config_enum *) gconf;
7587 config_enum_lookup_by_value(conf, *conf->variable));
7594 if (gconf->sourcefile)
7595 fprintf(fp, "%s", gconf->sourcefile);
7598 fwrite(&gconf->sourceline, 1, sizeof(gconf->sourceline), fp);
7599 fwrite(&gconf->source, 1, sizeof(gconf->source), fp);
7600 fwrite(&gconf->scontext, 1, sizeof(gconf->scontext), fp);
7604 write_nondefault_variables(GucContext context)
7610 Assert(context == PGC_POSTMASTER || context == PGC_SIGHUP);
7612 elevel = (context == PGC_SIGHUP) ? LOG : ERROR;
7617 fp = AllocateFile(CONFIG_EXEC_PARAMS_NEW, "w");
7621 (errcode_for_file_access(),
7622 errmsg("could not write to file \"%s\": %m",
7623 CONFIG_EXEC_PARAMS_NEW)));
7627 for (i = 0; i < num_guc_variables; i++)
7629 write_one_nondefault_variable(fp, guc_variables[i]);
7635 (errcode_for_file_access(),
7636 errmsg("could not write to file \"%s\": %m",
7637 CONFIG_EXEC_PARAMS_NEW)));
7642 * Put new file in place. This could delay on Win32, but we don't hold
7643 * any exclusive locks.
7645 rename(CONFIG_EXEC_PARAMS_NEW, CONFIG_EXEC_PARAMS);
7650 * Read string, including null byte from file
7652 * Return NULL on EOF and nothing read
7655 read_string_with_null(FILE *fp)
7664 if ((ch = fgetc(fp)) == EOF)
7669 elog(FATAL, "invalid format of exec config params file");
7672 str = guc_malloc(FATAL, maxlen);
7673 else if (i == maxlen)
7674 str = guc_realloc(FATAL, str, maxlen *= 2);
7683 * This routine loads a previous postmaster dump of its non-default
7687 read_nondefault_variables(void)
7694 GucSource varsource;
7695 GucContext varscontext;
7700 fp = AllocateFile(CONFIG_EXEC_PARAMS, "r");
7703 /* File not found is fine */
7704 if (errno != ENOENT)
7706 (errcode_for_file_access(),
7707 errmsg("could not read from file \"%s\": %m",
7708 CONFIG_EXEC_PARAMS)));
7714 struct config_generic *record;
7716 if ((varname = read_string_with_null(fp)) == NULL)
7719 if ((record = find_option(varname, true, FATAL)) == NULL)
7720 elog(FATAL, "failed to locate variable \"%s\" in exec config params file", varname);
7722 if ((varvalue = read_string_with_null(fp)) == NULL)
7723 elog(FATAL, "invalid format of exec config params file");
7724 if ((varsourcefile = read_string_with_null(fp)) == NULL)
7725 elog(FATAL, "invalid format of exec config params file");
7726 if (fread(&varsourceline, 1, sizeof(varsourceline), fp) != sizeof(varsourceline))
7727 elog(FATAL, "invalid format of exec config params file");
7728 if (fread(&varsource, 1, sizeof(varsource), fp) != sizeof(varsource))
7729 elog(FATAL, "invalid format of exec config params file");
7730 if (fread(&varscontext, 1, sizeof(varscontext), fp) != sizeof(varscontext))
7731 elog(FATAL, "invalid format of exec config params file");
7733 (void) set_config_option(varname, varvalue,
7734 varscontext, varsource,
7735 GUC_ACTION_SET, true, 0);
7736 if (varsourcefile[0])
7737 set_config_sourcefile(varname, varsourcefile, varsourceline);
7741 free(varsourcefile);
7746 #endif /* EXEC_BACKEND */
7750 * A little "long argument" simulation, although not quite GNU
7751 * compliant. Takes a string of the form "some-option=some value" and
7752 * returns name = "some_option" and value = "some value" in malloc'ed
7753 * storage. Note that '-' is converted to '_' in the option name. If
7754 * there is no '=' in the input string then value will be NULL.
7757 ParseLongOption(const char *string, char **name, char **value)
7766 equal_pos = strcspn(string, "=");
7768 if (string[equal_pos] == '=')
7770 *name = guc_malloc(FATAL, equal_pos + 1);
7771 strlcpy(*name, string, equal_pos + 1);
7773 *value = guc_strdup(FATAL, &string[equal_pos + 1]);
7777 /* no equal sign in string */
7778 *name = guc_strdup(FATAL, string);
7782 for (cp = *name; *cp; cp++)
7789 * Handle options fetched from pg_db_role_setting.setconfig,
7790 * pg_proc.proconfig, etc. Caller must specify proper context/source/action.
7792 * The array parameter must be an array of TEXT (it must not be NULL).
7795 ProcessGUCArray(ArrayType *array,
7796 GucContext context, GucSource source, GucAction action)
7800 Assert(array != NULL);
7801 Assert(ARR_ELEMTYPE(array) == TEXTOID);
7802 Assert(ARR_NDIM(array) == 1);
7803 Assert(ARR_LBOUND(array)[0] == 1);
7805 for (i = 1; i <= ARR_DIMS(array)[0]; i++)
7813 d = array_ref(array, 1, &i,
7814 -1 /* varlenarray */ ,
7815 -1 /* TEXT's typlen */ ,
7816 false /* TEXT's typbyval */ ,
7817 'i' /* TEXT's typalign */ ,
7823 s = TextDatumGetCString(d);
7825 ParseLongOption(s, &name, &value);
7829 (errcode(ERRCODE_SYNTAX_ERROR),
7830 errmsg("could not parse setting for parameter \"%s\"",
7836 (void) set_config_option(name, value,
7849 * Add an entry to an option array. The array parameter may be NULL
7850 * to indicate the current table entry is NULL.
7853 GUCArrayAdd(ArrayType *array, const char *name, const char *value)
7855 struct config_generic *record;
7863 /* test if the option is valid and we're allowed to set it */
7864 (void) validate_option_array_item(name, value, false);
7866 /* normalize name (converts obsolete GUC names to modern spellings) */
7867 record = find_option(name, false, WARNING);
7869 name = record->name;
7871 /* build new item for array */
7872 newval = palloc(strlen(name) + 1 + strlen(value) + 1);
7873 sprintf(newval, "%s=%s", name, value);
7874 datum = CStringGetTextDatum(newval);
7882 Assert(ARR_ELEMTYPE(array) == TEXTOID);
7883 Assert(ARR_NDIM(array) == 1);
7884 Assert(ARR_LBOUND(array)[0] == 1);
7886 index = ARR_DIMS(array)[0] + 1; /* add after end */
7888 for (i = 1; i <= ARR_DIMS(array)[0]; i++)
7893 d = array_ref(array, 1, &i,
7894 -1 /* varlenarray */ ,
7895 -1 /* TEXT's typlen */ ,
7896 false /* TEXT's typbyval */ ,
7897 'i' /* TEXT's typalign */ ,
7901 current = TextDatumGetCString(d);
7903 /* check for match up through and including '=' */
7904 if (strncmp(current, newval, strlen(name) + 1) == 0)
7911 a = array_set(array, 1, &index,
7914 -1 /* varlena array */ ,
7915 -1 /* TEXT's typlen */ ,
7916 false /* TEXT's typbyval */ ,
7917 'i' /* TEXT's typalign */ );
7920 a = construct_array(&datum, 1,
7929 * Delete an entry from an option array. The array parameter may be NULL
7930 * to indicate the current table entry is NULL. Also, if the return value
7931 * is NULL then a null should be stored.
7934 GUCArrayDelete(ArrayType *array, const char *name)
7936 struct config_generic *record;
7937 ArrayType *newarray;
7943 /* test if the option is valid and we're allowed to set it */
7944 (void) validate_option_array_item(name, NULL, false);
7946 /* normalize name (converts obsolete GUC names to modern spellings) */
7947 record = find_option(name, false, WARNING);
7949 name = record->name;
7951 /* if array is currently null, then surely nothing to delete */
7958 for (i = 1; i <= ARR_DIMS(array)[0]; i++)
7964 d = array_ref(array, 1, &i,
7965 -1 /* varlenarray */ ,
7966 -1 /* TEXT's typlen */ ,
7967 false /* TEXT's typbyval */ ,
7968 'i' /* TEXT's typalign */ ,
7972 val = TextDatumGetCString(d);
7974 /* ignore entry if it's what we want to delete */
7975 if (strncmp(val, name, strlen(name)) == 0
7976 && val[strlen(name)] == '=')
7979 /* else add it to the output array */
7981 newarray = array_set(newarray, 1, &index,
7984 -1 /* varlenarray */ ,
7985 -1 /* TEXT's typlen */ ,
7986 false /* TEXT's typbyval */ ,
7987 'i' /* TEXT's typalign */ );
7989 newarray = construct_array(&d, 1,
8001 * Given a GUC array, delete all settings from it that our permission
8002 * level allows: if superuser, delete them all; if regular user, only
8003 * those that are PGC_USERSET
8006 GUCArrayReset(ArrayType *array)
8008 ArrayType *newarray;
8012 /* if array is currently null, nothing to do */
8016 /* if we're superuser, we can delete everything, so just do it */
8023 for (i = 1; i <= ARR_DIMS(array)[0]; i++)
8030 d = array_ref(array, 1, &i,
8031 -1 /* varlenarray */ ,
8032 -1 /* TEXT's typlen */ ,
8033 false /* TEXT's typbyval */ ,
8034 'i' /* TEXT's typalign */ ,
8038 val = TextDatumGetCString(d);
8040 eqsgn = strchr(val, '=');
8043 /* skip if we have permission to delete it */
8044 if (validate_option_array_item(val, NULL, true))
8047 /* else add it to the output array */
8049 newarray = array_set(newarray, 1, &index,
8052 -1 /* varlenarray */ ,
8053 -1 /* TEXT's typlen */ ,
8054 false /* TEXT's typbyval */ ,
8055 'i' /* TEXT's typalign */ );
8057 newarray = construct_array(&d, 1,
8069 * Validate a proposed option setting for GUCArrayAdd/Delete/Reset.
8071 * name is the option name. value is the proposed value for the Add case,
8072 * or NULL for the Delete/Reset cases. If skipIfNoPermissions is true, it's
8073 * not an error to have no permissions to set the option.
8075 * Returns TRUE if OK, FALSE if skipIfNoPermissions is true and user does not
8076 * have permission to change this option (all other error cases result in an
8077 * error being thrown).
8080 validate_option_array_item(const char *name, const char *value,
8081 bool skipIfNoPermissions)
8084 struct config_generic *gconf;
8087 * There are three cases to consider:
8089 * name is a known GUC variable. Check the value normally, check
8090 * permissions normally (ie, allow if variable is USERSET, or if it's
8091 * SUSET and user is superuser).
8093 * name is not known, but exists or can be created as a placeholder (i.e.,
8094 * it has a prefixed name). We allow this case if you're a superuser,
8095 * otherwise not. Superusers are assumed to know what they're doing. We
8096 * can't allow it for other users, because when the placeholder is
8097 * resolved it might turn out to be a SUSET variable;
8098 * define_custom_variable assumes we checked that.
8100 * name is not known and can't be created as a placeholder. Throw error,
8101 * unless skipIfNoPermissions is true, in which case return FALSE.
8103 gconf = find_option(name, true, WARNING);
8106 /* not known, failed to make a placeholder */
8107 if (skipIfNoPermissions)
8110 (errcode(ERRCODE_UNDEFINED_OBJECT),
8111 errmsg("unrecognized configuration parameter \"%s\"",
8115 if (gconf->flags & GUC_CUSTOM_PLACEHOLDER)
8118 * We cannot do any meaningful check on the value, so only permissions
8119 * are useful to check.
8123 if (skipIfNoPermissions)
8126 (errcode(ERRCODE_INSUFFICIENT_PRIVILEGE),
8127 errmsg("permission denied to set parameter \"%s\"", name)));
8130 /* manual permissions check so we can avoid an error being thrown */
8131 if (gconf->context == PGC_USERSET)
8133 else if (gconf->context == PGC_SUSET && superuser())
8135 else if (skipIfNoPermissions)
8137 /* if a permissions error should be thrown, let set_config_option do it */
8139 /* test for permissions and valid option value */
8140 (void) set_config_option(name, value,
8141 superuser() ? PGC_SUSET : PGC_USERSET,
8142 PGC_S_TEST, GUC_ACTION_SET, false, 0);
8149 * Called by check_hooks that want to override the normal
8150 * ERRCODE_INVALID_PARAMETER_VALUE SQLSTATE for check hook failures.
8152 * Note that GUC_check_errmsg() etc are just macros that result in a direct
8153 * assignment to the associated variables. That is ugly, but forced by the
8154 * limitations of C's macro mechanisms.
8157 GUC_check_errcode(int sqlerrcode)
8159 GUC_check_errcode_value = sqlerrcode;
8164 * Convenience functions to manage calling a variable's check_hook.
8165 * These mostly take care of the protocol for letting check hooks supply
8166 * portions of the error report on failure.
8170 call_bool_check_hook(struct config_bool * conf, bool *newval, void **extra,
8171 GucSource source, int elevel)
8173 /* Quick success if no hook */
8174 if (!conf->check_hook)
8177 /* Reset variables that might be set by hook */
8178 GUC_check_errcode_value = ERRCODE_INVALID_PARAMETER_VALUE;
8179 GUC_check_errmsg_string = NULL;
8180 GUC_check_errdetail_string = NULL;
8181 GUC_check_errhint_string = NULL;
8183 if (!(*conf->check_hook) (newval, extra, source))
8186 (errcode(GUC_check_errcode_value),
8187 GUC_check_errmsg_string ?
8188 errmsg_internal("%s", GUC_check_errmsg_string) :
8189 errmsg("invalid value for parameter \"%s\": %d",
8190 conf->gen.name, (int) *newval),
8191 GUC_check_errdetail_string ?
8192 errdetail_internal("%s", GUC_check_errdetail_string) : 0,
8193 GUC_check_errhint_string ?
8194 errhint("%s", GUC_check_errhint_string) : 0));
8195 /* Flush any strings created in ErrorContext */
8204 call_int_check_hook(struct config_int * conf, int *newval, void **extra,
8205 GucSource source, int elevel)
8207 /* Quick success if no hook */
8208 if (!conf->check_hook)
8211 /* Reset variables that might be set by hook */
8212 GUC_check_errcode_value = ERRCODE_INVALID_PARAMETER_VALUE;
8213 GUC_check_errmsg_string = NULL;
8214 GUC_check_errdetail_string = NULL;
8215 GUC_check_errhint_string = NULL;
8217 if (!(*conf->check_hook) (newval, extra, source))
8220 (errcode(GUC_check_errcode_value),
8221 GUC_check_errmsg_string ?
8222 errmsg_internal("%s", GUC_check_errmsg_string) :
8223 errmsg("invalid value for parameter \"%s\": %d",
8224 conf->gen.name, *newval),
8225 GUC_check_errdetail_string ?
8226 errdetail_internal("%s", GUC_check_errdetail_string) : 0,
8227 GUC_check_errhint_string ?
8228 errhint("%s", GUC_check_errhint_string) : 0));
8229 /* Flush any strings created in ErrorContext */
8238 call_real_check_hook(struct config_real * conf, double *newval, void **extra,
8239 GucSource source, int elevel)
8241 /* Quick success if no hook */
8242 if (!conf->check_hook)
8245 /* Reset variables that might be set by hook */
8246 GUC_check_errcode_value = ERRCODE_INVALID_PARAMETER_VALUE;
8247 GUC_check_errmsg_string = NULL;
8248 GUC_check_errdetail_string = NULL;
8249 GUC_check_errhint_string = NULL;
8251 if (!(*conf->check_hook) (newval, extra, source))
8254 (errcode(GUC_check_errcode_value),
8255 GUC_check_errmsg_string ?
8256 errmsg_internal("%s", GUC_check_errmsg_string) :
8257 errmsg("invalid value for parameter \"%s\": %g",
8258 conf->gen.name, *newval),
8259 GUC_check_errdetail_string ?
8260 errdetail_internal("%s", GUC_check_errdetail_string) : 0,
8261 GUC_check_errhint_string ?
8262 errhint("%s", GUC_check_errhint_string) : 0));
8263 /* Flush any strings created in ErrorContext */
8272 call_string_check_hook(struct config_string * conf, char **newval, void **extra,
8273 GucSource source, int elevel)
8275 /* Quick success if no hook */
8276 if (!conf->check_hook)
8279 /* Reset variables that might be set by hook */
8280 GUC_check_errcode_value = ERRCODE_INVALID_PARAMETER_VALUE;
8281 GUC_check_errmsg_string = NULL;
8282 GUC_check_errdetail_string = NULL;
8283 GUC_check_errhint_string = NULL;
8285 if (!(*conf->check_hook) (newval, extra, source))
8288 (errcode(GUC_check_errcode_value),
8289 GUC_check_errmsg_string ?
8290 errmsg_internal("%s", GUC_check_errmsg_string) :
8291 errmsg("invalid value for parameter \"%s\": \"%s\"",
8292 conf->gen.name, *newval ? *newval : ""),
8293 GUC_check_errdetail_string ?
8294 errdetail_internal("%s", GUC_check_errdetail_string) : 0,
8295 GUC_check_errhint_string ?
8296 errhint("%s", GUC_check_errhint_string) : 0));
8297 /* Flush any strings created in ErrorContext */
8306 call_enum_check_hook(struct config_enum * conf, int *newval, void **extra,
8307 GucSource source, int elevel)
8309 /* Quick success if no hook */
8310 if (!conf->check_hook)
8313 /* Reset variables that might be set by hook */
8314 GUC_check_errcode_value = ERRCODE_INVALID_PARAMETER_VALUE;
8315 GUC_check_errmsg_string = NULL;
8316 GUC_check_errdetail_string = NULL;
8317 GUC_check_errhint_string = NULL;
8319 if (!(*conf->check_hook) (newval, extra, source))
8322 (errcode(GUC_check_errcode_value),
8323 GUC_check_errmsg_string ?
8324 errmsg_internal("%s", GUC_check_errmsg_string) :
8325 errmsg("invalid value for parameter \"%s\": \"%s\"",
8327 config_enum_lookup_by_value(conf, *newval)),
8328 GUC_check_errdetail_string ?
8329 errdetail_internal("%s", GUC_check_errdetail_string) : 0,
8330 GUC_check_errhint_string ?
8331 errhint("%s", GUC_check_errhint_string) : 0));
8332 /* Flush any strings created in ErrorContext */
8342 * check_hook, assign_hook and show_hook subroutines
8346 check_log_destination(char **newval, void **extra, GucSource source)
8354 /* Need a modifiable copy of string */
8355 rawstring = pstrdup(*newval);
8357 /* Parse string into list of identifiers */
8358 if (!SplitIdentifierString(rawstring, ',', &elemlist))
8360 /* syntax error in list */
8361 GUC_check_errdetail("List syntax is invalid.");
8363 list_free(elemlist);
8367 foreach(l, elemlist)
8369 char *tok = (char *) lfirst(l);
8371 if (pg_strcasecmp(tok, "stderr") == 0)
8372 newlogdest |= LOG_DESTINATION_STDERR;
8373 else if (pg_strcasecmp(tok, "csvlog") == 0)
8374 newlogdest |= LOG_DESTINATION_CSVLOG;
8376 else if (pg_strcasecmp(tok, "syslog") == 0)
8377 newlogdest |= LOG_DESTINATION_SYSLOG;
8380 else if (pg_strcasecmp(tok, "eventlog") == 0)
8381 newlogdest |= LOG_DESTINATION_EVENTLOG;
8385 GUC_check_errdetail("Unrecognized key word: \"%s\".", tok);
8387 list_free(elemlist);
8393 list_free(elemlist);
8395 myextra = (int *) guc_malloc(ERROR, sizeof(int));
8396 *myextra = newlogdest;
8397 *extra = (void *) myextra;
8403 assign_log_destination(const char *newval, void *extra)
8405 Log_destination = *((int *) extra);
8409 assign_syslog_facility(int newval, void *extra)
8412 set_syslog_parameters(syslog_ident_str ? syslog_ident_str : "postgres",
8415 /* Without syslog support, just ignore it */
8419 assign_syslog_ident(const char *newval, void *extra)
8422 set_syslog_parameters(newval, syslog_facility);
8424 /* Without syslog support, it will always be set to "none", so ignore */
8429 assign_session_replication_role(int newval, void *extra)
8432 * Must flush the plan cache when changing replication role; but don't
8433 * flush unnecessarily.
8435 if (SessionReplicationRole != newval)
8440 check_temp_buffers(int *newval, void **extra, GucSource source)
8443 * Once local buffers have been initialized, it's too late to change this.
8445 if (NLocBuffer && NLocBuffer != *newval)
8447 GUC_check_errdetail("\"temp_buffers\" cannot be changed after any temporary tables have been accessed in the session.");
8454 check_phony_autocommit(bool *newval, void **extra, GucSource source)
8458 GUC_check_errcode(ERRCODE_FEATURE_NOT_SUPPORTED);
8459 GUC_check_errmsg("SET AUTOCOMMIT TO OFF is no longer supported");
8466 check_debug_assertions(bool *newval, void **extra, GucSource source)
8468 #ifndef USE_ASSERT_CHECKING
8471 GUC_check_errmsg("assertion checking is not supported by this build");
8479 check_bonjour(bool *newval, void **extra, GucSource source)
8484 GUC_check_errmsg("Bonjour is not supported by this build");
8492 check_ssl(bool *newval, void **extra, GucSource source)
8497 GUC_check_errmsg("SSL is not supported by this build");
8505 check_stage_log_stats(bool *newval, void **extra, GucSource source)
8507 if (*newval && log_statement_stats)
8509 GUC_check_errdetail("Cannot enable parameter when \"log_statement_stats\" is true.");
8516 check_log_stats(bool *newval, void **extra, GucSource source)
8519 (log_parser_stats || log_planner_stats || log_executor_stats))
8521 GUC_check_errdetail("Cannot enable \"log_statement_stats\" when "
8522 "\"log_parser_stats\", \"log_planner_stats\", "
8523 "or \"log_executor_stats\" is true.");
8530 check_canonical_path(char **newval, void **extra, GucSource source)
8533 * Since canonicalize_path never enlarges the string, we can just modify
8534 * newval in-place. But watch out for NULL, which is the default value
8535 * for external_pid_file.
8538 canonicalize_path(*newval);
8543 check_timezone_abbreviations(char **newval, void **extra, GucSource source)
8546 * The boot_val given above for timezone_abbreviations is NULL. When we
8547 * see this we just do nothing. If this value isn't overridden from the
8548 * config file then pg_timezone_abbrev_initialize() will eventually
8549 * replace it with "Default". This hack has two purposes: to avoid
8550 * wasting cycles loading values that might soon be overridden from the
8551 * config file, and to avoid trying to read the timezone abbrev files
8552 * during InitializeGUCOptions(). The latter doesn't work in an
8553 * EXEC_BACKEND subprocess because my_exec_path hasn't been set yet and so
8554 * we can't locate PGSHAREDIR.
8556 if (*newval == NULL)
8558 Assert(source == PGC_S_DEFAULT);
8562 /* OK, load the file and produce a malloc'd TimeZoneAbbrevTable */
8563 *extra = load_tzoffsets(*newval);
8565 /* tzparser.c returns NULL on failure, reporting via GUC_check_errmsg */
8573 assign_timezone_abbreviations(const char *newval, void *extra)
8575 /* Do nothing for the boot_val default of NULL */
8579 InstallTimeZoneAbbrevs((TimeZoneAbbrevTable *) extra);
8583 * pg_timezone_abbrev_initialize --- set default value if not done already
8585 * This is called after initial loading of postgresql.conf. If no
8586 * timezone_abbreviations setting was found therein, select default.
8587 * If a non-default value is already installed, nothing will happen.
8589 * This can also be called from ProcessConfigFile to establish the default
8590 * value after a postgresql.conf entry for it is removed.
8593 pg_timezone_abbrev_initialize(void)
8595 SetConfigOption("timezone_abbreviations", "Default",
8596 PGC_POSTMASTER, PGC_S_DYNAMIC_DEFAULT);
8600 show_archive_command(void)
8602 if (XLogArchivingActive())
8603 return XLogArchiveCommand;
8605 return "(disabled)";
8609 assign_tcp_keepalives_idle(int newval, void *extra)
8612 * The kernel API provides no way to test a value without setting it; and
8613 * once we set it we might fail to unset it. So there seems little point
8614 * in fully implementing the check-then-assign GUC API for these
8615 * variables. Instead we just do the assignment on demand. pqcomm.c
8616 * reports any problems via elog(LOG).
8618 * This approach means that the GUC value might have little to do with the
8619 * actual kernel value, so we use a show_hook that retrieves the kernel
8620 * value rather than trusting GUC's copy.
8622 (void) pq_setkeepalivesidle(newval, MyProcPort);
8626 show_tcp_keepalives_idle(void)
8628 /* See comments in assign_tcp_keepalives_idle */
8629 static char nbuf[16];
8631 snprintf(nbuf, sizeof(nbuf), "%d", pq_getkeepalivesidle(MyProcPort));
8636 assign_tcp_keepalives_interval(int newval, void *extra)
8638 /* See comments in assign_tcp_keepalives_idle */
8639 (void) pq_setkeepalivesinterval(newval, MyProcPort);
8643 show_tcp_keepalives_interval(void)
8645 /* See comments in assign_tcp_keepalives_idle */
8646 static char nbuf[16];
8648 snprintf(nbuf, sizeof(nbuf), "%d", pq_getkeepalivesinterval(MyProcPort));
8653 assign_tcp_keepalives_count(int newval, void *extra)
8655 /* See comments in assign_tcp_keepalives_idle */
8656 (void) pq_setkeepalivescount(newval, MyProcPort);
8660 show_tcp_keepalives_count(void)
8662 /* See comments in assign_tcp_keepalives_idle */
8663 static char nbuf[16];
8665 snprintf(nbuf, sizeof(nbuf), "%d", pq_getkeepalivescount(MyProcPort));
8670 check_maxconnections(int *newval, void **extra, GucSource source)
8672 if (*newval + GetNumShmemAttachedBgworkers() + autovacuum_max_workers + 1 >
8679 check_autovacuum_max_workers(int *newval, void **extra, GucSource source)
8681 if (MaxConnections + *newval + 1 + GetNumShmemAttachedBgworkers() >
8688 check_effective_io_concurrency(int *newval, void **extra, GucSource source)
8691 double new_prefetch_pages = 0.0;
8695 * The user-visible GUC parameter is the number of drives (spindles),
8696 * which we need to translate to a number-of-pages-to-prefetch target.
8697 * The target value is stashed in *extra and then assigned to the actual
8698 * variable by assign_effective_io_concurrency.
8700 * The expected number of prefetch pages needed to keep N drives busy is:
8702 * drives | I/O requests
8703 * -------+----------------
8706 * 3 | 3/1 + 3/2 + 3/3 = 5 1/2
8707 * 4 | 4/1 + 4/2 + 4/3 + 4/4 = 8 1/3
8710 * This is called the "coupon collector problem" and H(n) is called the
8711 * harmonic series. This could be approximated by n * ln(n), but for
8712 * reasonable numbers of drives we might as well just compute the series.
8714 * Alternatively we could set the target to the number of pages necessary
8715 * so that the expected number of active spindles is some arbitrary
8716 * percentage of the total. This sounds the same but is actually slightly
8717 * different. The result ends up being ln(1-P)/ln((n-1)/n) where P is
8718 * that desired fraction.
8720 * Experimental results show that both of these formulas aren't aggressive
8721 * enough, but we don't really have any better proposals.
8723 * Note that if *newval = 0 (disabled), we must set target = 0.
8727 for (i = 1; i <= *newval; i++)
8728 new_prefetch_pages += (double) *newval / (double) i;
8730 /* This range check shouldn't fail, but let's be paranoid */
8731 if (new_prefetch_pages >= 0.0 && new_prefetch_pages < (double) INT_MAX)
8733 int *myextra = (int *) guc_malloc(ERROR, sizeof(int));
8735 *myextra = (int) rint(new_prefetch_pages);
8736 *extra = (void *) myextra;
8744 #endif /* USE_PREFETCH */
8748 assign_effective_io_concurrency(int newval, void *extra)
8751 target_prefetch_pages = *((int *) extra);
8752 #endif /* USE_PREFETCH */
8756 assign_pgstat_temp_directory(const char *newval, void *extra)
8758 /* check_canonical_path already canonicalized newval for us */
8764 dname = guc_malloc(ERROR, strlen(newval) + 1); /* runtime dir */
8765 sprintf(dname, "%s", newval);
8768 tname = guc_malloc(ERROR, strlen(newval) + 12); /* /global.tmp */
8769 sprintf(tname, "%s/global.tmp", newval);
8770 fname = guc_malloc(ERROR, strlen(newval) + 13); /* /global.stat */
8771 sprintf(fname, "%s/global.stat", newval);
8773 if (pgstat_stat_directory)
8774 free(pgstat_stat_directory);
8775 pgstat_stat_directory = dname;
8776 if (pgstat_stat_tmpname)
8777 free(pgstat_stat_tmpname);
8778 pgstat_stat_tmpname = tname;
8779 if (pgstat_stat_filename)
8780 free(pgstat_stat_filename);
8781 pgstat_stat_filename = fname;
8785 check_application_name(char **newval, void **extra, GucSource source)
8787 /* Only allow clean ASCII chars in the application name */
8790 for (p = *newval; *p; p++)
8792 if (*p < 32 || *p > 126)
8800 assign_application_name(const char *newval, void *extra)
8802 /* Update the pg_stat_activity view */
8803 pgstat_report_appname(newval);
8807 show_unix_socket_permissions(void)
8811 snprintf(buf, sizeof(buf), "%04o", Unix_socket_permissions);
8816 show_log_file_mode(void)
8820 snprintf(buf, sizeof(buf), "%04o", Log_file_mode);
8824 #include "guc-file.c"