Fix xslt_process() to ensure that it inserts a NULL terminator after the
[PostgreSQL.git] / src / backend / utils / misc / guc.c
blob24301852b856a8cf56def5b98d9c314c12ffbf91
1 /*--------------------------------------------------------------------
2 * guc.c
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-2009, PostgreSQL Global Development Group
10 * Written by Peter Eisentraut <peter_e@gmx.net>.
12 * IDENTIFICATION
13 * $PostgreSQL$
15 *--------------------------------------------------------------------
17 #include "postgres.h"
19 #include <ctype.h>
20 #include <float.h>
21 #include <math.h>
22 #include <limits.h>
23 #include <unistd.h>
24 #include <sys/stat.h>
25 #ifdef HAVE_SYSLOG
26 #include <syslog.h>
27 #endif
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"
39 #include "funcapi.h"
40 #include "libpq/auth.h"
41 #include "libpq/pqformat.h"
42 #include "miscadmin.h"
43 #include "optimizer/cost.h"
44 #include "optimizer/geqo.h"
45 #include "optimizer/paths.h"
46 #include "optimizer/planmain.h"
47 #include "parser/gramparse.h"
48 #include "parser/parse_expr.h"
49 #include "parser/parse_relation.h"
50 #include "parser/parse_type.h"
51 #include "parser/scansup.h"
52 #include "pgstat.h"
53 #include "postmaster/autovacuum.h"
54 #include "postmaster/bgwriter.h"
55 #include "postmaster/postmaster.h"
56 #include "postmaster/syslogger.h"
57 #include "postmaster/walwriter.h"
58 #include "regex/regex.h"
59 #include "storage/bufmgr.h"
60 #include "storage/fd.h"
61 #include "tcop/tcopprot.h"
62 #include "tsearch/ts_cache.h"
63 #include "utils/builtins.h"
64 #include "utils/guc_tables.h"
65 #include "utils/memutils.h"
66 #include "utils/pg_locale.h"
67 #include "utils/plancache.h"
68 #include "utils/portal.h"
69 #include "utils/ps_status.h"
70 #include "utils/tzparser.h"
71 #include "utils/xml.h"
73 #ifndef PG_KRB_SRVTAB
74 #define PG_KRB_SRVTAB ""
75 #endif
76 #ifndef PG_KRB_SRVNAM
77 #define PG_KRB_SRVNAM ""
78 #endif
80 #define CONFIG_FILENAME "postgresql.conf"
81 #define HBA_FILENAME "pg_hba.conf"
82 #define IDENT_FILENAME "pg_ident.conf"
84 #ifdef EXEC_BACKEND
85 #define CONFIG_EXEC_PARAMS "global/config_exec_params"
86 #define CONFIG_EXEC_PARAMS_NEW "global/config_exec_params.new"
87 #endif
89 /* upper limit for GUC variables measured in kilobytes of memory */
90 #if SIZEOF_SIZE_T > 4
91 #define MAX_KILOBYTES INT_MAX
92 #else
93 #define MAX_KILOBYTES (INT_MAX / 1024)
94 #endif
96 #define KB_PER_MB (1024)
97 #define KB_PER_GB (1024*1024)
99 #define MS_PER_S 1000
100 #define S_PER_MIN 60
101 #define MS_PER_MIN (1000 * 60)
102 #define MIN_PER_H 60
103 #define S_PER_H (60 * 60)
104 #define MS_PER_H (1000 * 60 * 60)
105 #define MIN_PER_D (60 * 24)
106 #define S_PER_D (60 * 60 * 24)
107 #define MS_PER_D (1000 * 60 * 60 * 24)
109 /* XXX these should appear in other modules' header files */
110 extern bool Log_disconnections;
111 extern int CommitDelay;
112 extern int CommitSiblings;
113 extern char *default_tablespace;
114 extern char *temp_tablespaces;
115 extern bool synchronize_seqscans;
116 extern bool fullPageWrites;
118 #ifdef TRACE_SORT
119 extern bool trace_sort;
120 #endif
121 #ifdef TRACE_SYNCSCAN
122 extern bool trace_syncscan;
123 #endif
124 #ifdef DEBUG_BOUNDED_SORT
125 extern bool optimize_bounded_sort;
126 #endif
128 #ifdef USE_SSL
129 extern char *SSLCipherSuites;
130 #endif
132 static void set_config_sourcefile(const char *name, char *sourcefile,
133 int sourceline);
135 static const char *assign_log_destination(const char *value,
136 bool doit, GucSource source);
138 #ifdef HAVE_SYSLOG
139 static int syslog_facility = LOG_LOCAL0;
141 static bool assign_syslog_facility(int newval,
142 bool doit, GucSource source);
143 static const char *assign_syslog_ident(const char *ident,
144 bool doit, GucSource source);
145 #endif
147 static bool assign_session_replication_role(int newval, bool doit,
148 GucSource source);
149 static const char *show_num_temp_buffers(void);
150 static bool assign_phony_autocommit(bool newval, bool doit, GucSource source);
151 static const char *assign_custom_variable_classes(const char *newval, bool doit,
152 GucSource source);
153 static bool assign_debug_assertions(bool newval, bool doit, GucSource source);
154 static bool assign_ssl(bool newval, bool doit, GucSource source);
155 static bool assign_stage_log_stats(bool newval, bool doit, GucSource source);
156 static bool assign_log_stats(bool newval, bool doit, GucSource source);
157 static bool assign_transaction_read_only(bool newval, bool doit, GucSource source);
158 static const char *assign_canonical_path(const char *newval, bool doit, GucSource source);
159 static const char *assign_timezone_abbreviations(const char *newval, bool doit, GucSource source);
160 static const char *show_archive_command(void);
161 static bool assign_tcp_keepalives_idle(int newval, bool doit, GucSource source);
162 static bool assign_tcp_keepalives_interval(int newval, bool doit, GucSource source);
163 static bool assign_tcp_keepalives_count(int newval, bool doit, GucSource source);
164 static const char *show_tcp_keepalives_idle(void);
165 static const char *show_tcp_keepalives_interval(void);
166 static const char *show_tcp_keepalives_count(void);
167 static bool assign_maxconnections(int newval, bool doit, GucSource source);
168 static bool assign_autovacuum_max_workers(int newval, bool doit, GucSource source);
169 static bool assign_effective_io_concurrency(int newval, bool doit, GucSource source);
170 static const char *assign_pgstat_temp_directory(const char *newval, bool doit, GucSource source);
172 static char *config_enum_get_options(struct config_enum * record,
173 const char *prefix, const char *suffix,
174 const char *separator);
178 * Options for enum values defined in this module.
180 * NOTE! Option values may not contain double quotes!
184 * We have different sets for client and server message level options because
185 * they sort slightly different (see "log" level)
187 static const struct config_enum_entry client_message_level_options[] = {
188 {"debug", DEBUG2, true},
189 {"debug5", DEBUG5, false},
190 {"debug4", DEBUG4, false},
191 {"debug3", DEBUG3, false},
192 {"debug2", DEBUG2, false},
193 {"debug1", DEBUG1, false},
194 {"log", LOG, false},
195 {"info", INFO, true},
196 {"notice", NOTICE, false},
197 {"warning", WARNING, false},
198 {"error", ERROR, false},
199 {"fatal", FATAL, true},
200 {"panic", PANIC, true},
201 {NULL, 0, false}
204 static const struct config_enum_entry server_message_level_options[] = {
205 {"debug", DEBUG2, true},
206 {"debug5", DEBUG5, false},
207 {"debug4", DEBUG4, false},
208 {"debug3", DEBUG3, false},
209 {"debug2", DEBUG2, false},
210 {"debug1", DEBUG1, false},
211 {"info", INFO, false},
212 {"notice", NOTICE, false},
213 {"warning", WARNING, false},
214 {"error", ERROR, false},
215 {"log", LOG, false},
216 {"fatal", FATAL, false},
217 {"panic", PANIC, false},
218 {NULL, 0, false}
221 static const struct config_enum_entry intervalstyle_options[] = {
222 {"postgres", INTSTYLE_POSTGRES, false},
223 {"postgres_verbose", INTSTYLE_POSTGRES_VERBOSE, false},
224 {"sql_standard", INTSTYLE_SQL_STANDARD, false},
225 {"iso_8601", INTSTYLE_ISO_8601, false},
226 {NULL, 0, false}
229 static const struct config_enum_entry log_error_verbosity_options[] = {
230 {"terse", PGERROR_TERSE, false},
231 {"default", PGERROR_DEFAULT, false},
232 {"verbose", PGERROR_VERBOSE, false},
233 {NULL, 0, false}
236 static const struct config_enum_entry log_statement_options[] = {
237 {"none", LOGSTMT_NONE, false},
238 {"ddl", LOGSTMT_DDL, false},
239 {"mod", LOGSTMT_MOD, false},
240 {"all", LOGSTMT_ALL, false},
241 {NULL, 0, false}
244 static const struct config_enum_entry regex_flavor_options[] = {
245 {"advanced", REG_ADVANCED, false},
246 {"extended", REG_EXTENDED, false},
247 {"basic", REG_BASIC, false},
248 {NULL, 0, false}
251 static const struct config_enum_entry isolation_level_options[] = {
252 {"serializable", XACT_SERIALIZABLE, false},
253 {"repeatable read", XACT_REPEATABLE_READ, false},
254 {"read committed", XACT_READ_COMMITTED, false},
255 {"read uncommitted", XACT_READ_UNCOMMITTED, false},
256 {NULL, 0}
259 static const struct config_enum_entry session_replication_role_options[] = {
260 {"origin", SESSION_REPLICATION_ROLE_ORIGIN, false},
261 {"replica", SESSION_REPLICATION_ROLE_REPLICA, false},
262 {"local", SESSION_REPLICATION_ROLE_LOCAL, false},
263 {NULL, 0, false}
266 #ifdef HAVE_SYSLOG
267 static const struct config_enum_entry syslog_facility_options[] = {
268 {"local0", LOG_LOCAL0, false},
269 {"local1", LOG_LOCAL1, false},
270 {"local2", LOG_LOCAL2, false},
271 {"local3", LOG_LOCAL3, false},
272 {"local4", LOG_LOCAL4, false},
273 {"local5", LOG_LOCAL5, false},
274 {"local6", LOG_LOCAL6, false},
275 {"local7", LOG_LOCAL7, false},
276 {NULL, 0}
278 #endif
280 static const struct config_enum_entry track_function_options[] = {
281 {"none", TRACK_FUNC_OFF, false},
282 {"pl", TRACK_FUNC_PL, false},
283 {"all", TRACK_FUNC_ALL, false},
284 {NULL, 0, false}
287 static const struct config_enum_entry xmlbinary_options[] = {
288 {"base64", XMLBINARY_BASE64, false},
289 {"hex", XMLBINARY_HEX, false},
290 {NULL, 0, false}
293 static const struct config_enum_entry xmloption_options[] = {
294 {"content", XMLOPTION_CONTENT, false},
295 {"document", XMLOPTION_DOCUMENT, false},
296 {NULL, 0, false}
300 * Although only "on", "off", and "safe_encoding" are documented, we
301 * accept all the likely variants of "on" and "off".
303 static const struct config_enum_entry backslash_quote_options[] = {
304 {"safe_encoding", BACKSLASH_QUOTE_SAFE_ENCODING, false},
305 {"on", BACKSLASH_QUOTE_ON, false},
306 {"off", BACKSLASH_QUOTE_OFF, false},
307 {"true", BACKSLASH_QUOTE_ON, true},
308 {"false", BACKSLASH_QUOTE_OFF, true},
309 {"yes", BACKSLASH_QUOTE_ON, true},
310 {"no", BACKSLASH_QUOTE_OFF, true},
311 {"1", BACKSLASH_QUOTE_ON, true},
312 {"0", BACKSLASH_QUOTE_OFF, true},
313 {NULL, 0, false}
317 * Although only "on", "off", and "partition" are documented, we
318 * accept all the likely variants of "on" and "off".
320 static const struct config_enum_entry constraint_exclusion_options[] = {
321 {"partition", CONSTRAINT_EXCLUSION_PARTITION, false},
322 {"on", CONSTRAINT_EXCLUSION_ON, false},
323 {"off", CONSTRAINT_EXCLUSION_OFF, false},
324 {"true", CONSTRAINT_EXCLUSION_ON, true},
325 {"false", CONSTRAINT_EXCLUSION_OFF, true},
326 {"yes", CONSTRAINT_EXCLUSION_ON, true},
327 {"no", CONSTRAINT_EXCLUSION_OFF, true},
328 {"1", CONSTRAINT_EXCLUSION_ON, true},
329 {"0", CONSTRAINT_EXCLUSION_OFF, true},
330 {NULL, 0, false}
334 * Options for enum values stored in other modules
336 extern const struct config_enum_entry sync_method_options[];
339 * GUC option variables that are exported from this module
341 #ifdef USE_ASSERT_CHECKING
342 bool assert_enabled = true;
343 #else
344 bool assert_enabled = false;
345 #endif
346 bool log_duration = false;
347 bool Debug_print_plan = false;
348 bool Debug_print_parse = false;
349 bool Debug_print_rewritten = false;
350 bool Debug_pretty_print = true;
352 bool log_parser_stats = false;
353 bool log_planner_stats = false;
354 bool log_executor_stats = false;
355 bool log_statement_stats = false; /* this is sort of all three
356 * above together */
357 bool log_btree_build_stats = false;
359 bool check_function_bodies = true;
360 bool default_with_oids = false;
361 bool SQL_inheritance = true;
363 bool Password_encryption = true;
365 int log_min_error_statement = ERROR;
366 int log_min_messages = WARNING;
367 int client_min_messages = NOTICE;
368 int log_min_duration_statement = -1;
369 int log_temp_files = -1;
371 int num_temp_buffers = 1000;
373 char *ConfigFileName;
374 char *HbaFileName;
375 char *IdentFileName;
376 char *external_pid_file;
378 char *pgstat_temp_directory;
380 int tcp_keepalives_idle;
381 int tcp_keepalives_interval;
382 int tcp_keepalives_count;
385 * These variables are all dummies that don't do anything, except in some
386 * cases provide the value for SHOW to display. The real state is elsewhere
387 * and is kept in sync by assign_hooks.
389 static char *log_destination_string;
391 #ifdef HAVE_SYSLOG
392 static char *syslog_ident_str;
393 #endif
394 static bool phony_autocommit;
395 static bool session_auth_is_superuser;
396 static double phony_random_seed;
397 static char *client_encoding_string;
398 static char *datestyle_string;
399 static char *locale_collate;
400 static char *locale_ctype;
401 static char *server_encoding_string;
402 static char *server_version_string;
403 static int server_version_num;
404 static char *timezone_string;
405 static char *log_timezone_string;
406 static char *timezone_abbreviations_string;
407 static char *XactIsoLevel_string;
408 static char *data_directory;
409 static char *custom_variable_classes;
410 static int max_function_args;
411 static int max_index_keys;
412 static int max_identifier_length;
413 static int block_size;
414 static int segment_size;
415 static int wal_block_size;
416 static int wal_segment_size;
417 static bool integer_datetimes;
418 static int effective_io_concurrency;
420 /* should be static, but commands/variable.c needs to get at these */
421 char *role_string;
422 char *session_authorization_string;
426 * Displayable names for context types (enum GucContext)
428 * Note: these strings are deliberately not localized.
430 const char *const GucContext_Names[] =
432 /* PGC_INTERNAL */ "internal",
433 /* PGC_POSTMASTER */ "postmaster",
434 /* PGC_SIGHUP */ "sighup",
435 /* PGC_BACKEND */ "backend",
436 /* PGC_SUSET */ "superuser",
437 /* PGC_USERSET */ "user"
441 * Displayable names for source types (enum GucSource)
443 * Note: these strings are deliberately not localized.
445 const char *const GucSource_Names[] =
447 /* PGC_S_DEFAULT */ "default",
448 /* PGC_S_ENV_VAR */ "environment variable",
449 /* PGC_S_FILE */ "configuration file",
450 /* PGC_S_ARGV */ "command line",
451 /* PGC_S_DATABASE */ "database",
452 /* PGC_S_USER */ "user",
453 /* PGC_S_CLIENT */ "client",
454 /* PGC_S_OVERRIDE */ "override",
455 /* PGC_S_INTERACTIVE */ "interactive",
456 /* PGC_S_TEST */ "test",
457 /* PGC_S_SESSION */ "session"
461 * Displayable names for the groupings defined in enum config_group
463 const char *const config_group_names[] =
465 /* UNGROUPED */
466 gettext_noop("Ungrouped"),
467 /* FILE_LOCATIONS */
468 gettext_noop("File Locations"),
469 /* CONN_AUTH */
470 gettext_noop("Connections and Authentication"),
471 /* CONN_AUTH_SETTINGS */
472 gettext_noop("Connections and Authentication / Connection Settings"),
473 /* CONN_AUTH_SECURITY */
474 gettext_noop("Connections and Authentication / Security and Authentication"),
475 /* RESOURCES */
476 gettext_noop("Resource Usage"),
477 /* RESOURCES_MEM */
478 gettext_noop("Resource Usage / Memory"),
479 /* RESOURCES_KERNEL */
480 gettext_noop("Resource Usage / Kernel Resources"),
481 /* WAL */
482 gettext_noop("Write-Ahead Log"),
483 /* WAL_SETTINGS */
484 gettext_noop("Write-Ahead Log / Settings"),
485 /* WAL_CHECKPOINTS */
486 gettext_noop("Write-Ahead Log / Checkpoints"),
487 /* QUERY_TUNING */
488 gettext_noop("Query Tuning"),
489 /* QUERY_TUNING_METHOD */
490 gettext_noop("Query Tuning / Planner Method Configuration"),
491 /* QUERY_TUNING_COST */
492 gettext_noop("Query Tuning / Planner Cost Constants"),
493 /* QUERY_TUNING_GEQO */
494 gettext_noop("Query Tuning / Genetic Query Optimizer"),
495 /* QUERY_TUNING_OTHER */
496 gettext_noop("Query Tuning / Other Planner Options"),
497 /* LOGGING */
498 gettext_noop("Reporting and Logging"),
499 /* LOGGING_WHERE */
500 gettext_noop("Reporting and Logging / Where to Log"),
501 /* LOGGING_WHEN */
502 gettext_noop("Reporting and Logging / When to Log"),
503 /* LOGGING_WHAT */
504 gettext_noop("Reporting and Logging / What to Log"),
505 /* STATS */
506 gettext_noop("Statistics"),
507 /* STATS_MONITORING */
508 gettext_noop("Statistics / Monitoring"),
509 /* STATS_COLLECTOR */
510 gettext_noop("Statistics / Query and Index Statistics Collector"),
511 /* AUTOVACUUM */
512 gettext_noop("Autovacuum"),
513 /* CLIENT_CONN */
514 gettext_noop("Client Connection Defaults"),
515 /* CLIENT_CONN_STATEMENT */
516 gettext_noop("Client Connection Defaults / Statement Behavior"),
517 /* CLIENT_CONN_LOCALE */
518 gettext_noop("Client Connection Defaults / Locale and Formatting"),
519 /* CLIENT_CONN_OTHER */
520 gettext_noop("Client Connection Defaults / Other Defaults"),
521 /* LOCK_MANAGEMENT */
522 gettext_noop("Lock Management"),
523 /* COMPAT_OPTIONS */
524 gettext_noop("Version and Platform Compatibility"),
525 /* COMPAT_OPTIONS_PREVIOUS */
526 gettext_noop("Version and Platform Compatibility / Previous PostgreSQL Versions"),
527 /* COMPAT_OPTIONS_CLIENT */
528 gettext_noop("Version and Platform Compatibility / Other Platforms and Clients"),
529 /* PRESET_OPTIONS */
530 gettext_noop("Preset Options"),
531 /* CUSTOM_OPTIONS */
532 gettext_noop("Customized Options"),
533 /* DEVELOPER_OPTIONS */
534 gettext_noop("Developer Options"),
535 /* help_config wants this array to be null-terminated */
536 NULL
540 * Displayable names for GUC variable types (enum config_type)
542 * Note: these strings are deliberately not localized.
544 const char *const config_type_names[] =
546 /* PGC_BOOL */ "bool",
547 /* PGC_INT */ "integer",
548 /* PGC_REAL */ "real",
549 /* PGC_STRING */ "string",
550 /* PGC_ENUM */ "enum"
555 * Contents of GUC tables
557 * See src/backend/utils/misc/README for design notes.
559 * TO ADD AN OPTION:
561 * 1. Declare a global variable of type bool, int, double, or char*
562 * and make use of it.
564 * 2. Decide at what times it's safe to set the option. See guc.h for
565 * details.
567 * 3. Decide on a name, a default value, upper and lower bounds (if
568 * applicable), etc.
570 * 4. Add a record below.
572 * 5. Add it to src/backend/utils/misc/postgresql.conf.sample, if
573 * appropriate.
575 * 6. Don't forget to document the option (at least in config.sgml).
577 * 7. If it's a new GUC_LIST option you must edit pg_dumpall.c to ensure
578 * it is not single quoted at dump time.
582 /******** option records follow ********/
584 static struct config_bool ConfigureNamesBool[] =
587 {"enable_seqscan", PGC_USERSET, QUERY_TUNING_METHOD,
588 gettext_noop("Enables the planner's use of sequential-scan plans."),
589 NULL
591 &enable_seqscan,
592 true, NULL, NULL
595 {"enable_indexscan", PGC_USERSET, QUERY_TUNING_METHOD,
596 gettext_noop("Enables the planner's use of index-scan plans."),
597 NULL
599 &enable_indexscan,
600 true, NULL, NULL
603 {"enable_bitmapscan", PGC_USERSET, QUERY_TUNING_METHOD,
604 gettext_noop("Enables the planner's use of bitmap-scan plans."),
605 NULL
607 &enable_bitmapscan,
608 true, NULL, NULL
611 {"enable_tidscan", PGC_USERSET, QUERY_TUNING_METHOD,
612 gettext_noop("Enables the planner's use of TID scan plans."),
613 NULL
615 &enable_tidscan,
616 true, NULL, NULL
619 {"enable_sort", PGC_USERSET, QUERY_TUNING_METHOD,
620 gettext_noop("Enables the planner's use of explicit sort steps."),
621 NULL
623 &enable_sort,
624 true, NULL, NULL
627 {"enable_hashagg", PGC_USERSET, QUERY_TUNING_METHOD,
628 gettext_noop("Enables the planner's use of hashed aggregation plans."),
629 NULL
631 &enable_hashagg,
632 true, NULL, NULL
635 {"enable_nestloop", PGC_USERSET, QUERY_TUNING_METHOD,
636 gettext_noop("Enables the planner's use of nested-loop join plans."),
637 NULL
639 &enable_nestloop,
640 true, NULL, NULL
643 {"enable_mergejoin", PGC_USERSET, QUERY_TUNING_METHOD,
644 gettext_noop("Enables the planner's use of merge join plans."),
645 NULL
647 &enable_mergejoin,
648 true, NULL, NULL
651 {"enable_hashjoin", PGC_USERSET, QUERY_TUNING_METHOD,
652 gettext_noop("Enables the planner's use of hash join plans."),
653 NULL
655 &enable_hashjoin,
656 true, NULL, NULL
659 {"geqo", PGC_USERSET, QUERY_TUNING_GEQO,
660 gettext_noop("Enables genetic query optimization."),
661 gettext_noop("This algorithm attempts to do planning without "
662 "exhaustive searching.")
664 &enable_geqo,
665 true, NULL, NULL
668 /* Not for general use --- used by SET SESSION AUTHORIZATION */
669 {"is_superuser", PGC_INTERNAL, UNGROUPED,
670 gettext_noop("Shows whether the current user is a superuser."),
671 NULL,
672 GUC_REPORT | GUC_NO_SHOW_ALL | GUC_NO_RESET_ALL | GUC_NOT_IN_SAMPLE | GUC_DISALLOW_IN_FILE
674 &session_auth_is_superuser,
675 false, NULL, NULL
678 {"ssl", PGC_POSTMASTER, CONN_AUTH_SECURITY,
679 gettext_noop("Enables SSL connections."),
680 NULL
682 &EnableSSL,
683 false, assign_ssl, NULL
686 {"fsync", PGC_SIGHUP, WAL_SETTINGS,
687 gettext_noop("Forces synchronization of updates to disk."),
688 gettext_noop("The server will use the fsync() system call in several places to make "
689 "sure that updates are physically written to disk. This insures "
690 "that a database cluster will recover to a consistent state after "
691 "an operating system or hardware crash.")
693 &enableFsync,
694 true, NULL, NULL
697 {"synchronous_commit", PGC_USERSET, WAL_SETTINGS,
698 gettext_noop("Sets immediate fsync at commit."),
699 NULL
701 &XactSyncCommit,
702 true, NULL, NULL
705 {"zero_damaged_pages", PGC_SUSET, DEVELOPER_OPTIONS,
706 gettext_noop("Continues processing past damaged page headers."),
707 gettext_noop("Detection of a damaged page header normally causes PostgreSQL to "
708 "report an error, aborting the current transaction. Setting "
709 "zero_damaged_pages to true causes the system to instead report a "
710 "warning, zero out the damaged page, and continue processing. This "
711 "behavior will destroy data, namely all the rows on the damaged page."),
712 GUC_NOT_IN_SAMPLE
714 &zero_damaged_pages,
715 false, NULL, NULL
718 {"full_page_writes", PGC_SIGHUP, WAL_SETTINGS,
719 gettext_noop("Writes full pages to WAL when first modified after a checkpoint."),
720 gettext_noop("A page write in process during an operating system crash might be "
721 "only partially written to disk. During recovery, the row changes "
722 "stored in WAL are not enough to recover. This option writes "
723 "pages when first modified after a checkpoint to WAL so full recovery "
724 "is possible.")
726 &fullPageWrites,
727 true, NULL, NULL
730 {"silent_mode", PGC_POSTMASTER, LOGGING_WHEN,
731 gettext_noop("Runs the server silently."),
732 gettext_noop("If this parameter is set, the server will automatically run in the "
733 "background and any controlling terminals are dissociated.")
735 &SilentMode,
736 false, NULL, NULL
739 {"log_checkpoints", PGC_SIGHUP, LOGGING_WHAT,
740 gettext_noop("Logs each checkpoint."),
741 NULL
743 &log_checkpoints,
744 false, NULL, NULL
747 {"log_connections", PGC_BACKEND, LOGGING_WHAT,
748 gettext_noop("Logs each successful connection."),
749 NULL
751 &Log_connections,
752 false, NULL, NULL
755 {"log_disconnections", PGC_BACKEND, LOGGING_WHAT,
756 gettext_noop("Logs end of a session, including duration."),
757 NULL
759 &Log_disconnections,
760 false, NULL, NULL
763 {"debug_assertions", PGC_USERSET, DEVELOPER_OPTIONS,
764 gettext_noop("Turns on various assertion checks."),
765 gettext_noop("This is a debugging aid."),
766 GUC_NOT_IN_SAMPLE
768 &assert_enabled,
769 #ifdef USE_ASSERT_CHECKING
770 true,
771 #else
772 false,
773 #endif
774 assign_debug_assertions, NULL
777 /* currently undocumented, so don't show in SHOW ALL */
778 {"exit_on_error", PGC_USERSET, UNGROUPED,
779 gettext_noop("No description available."),
780 NULL,
781 GUC_NO_SHOW_ALL | GUC_NOT_IN_SAMPLE
783 &ExitOnAnyError,
784 false, NULL, NULL
787 {"log_duration", PGC_SUSET, LOGGING_WHAT,
788 gettext_noop("Logs the duration of each completed SQL statement."),
789 NULL
791 &log_duration,
792 false, NULL, NULL
795 {"debug_print_parse", PGC_USERSET, LOGGING_WHAT,
796 gettext_noop("Logs each query's parse tree."),
797 NULL
799 &Debug_print_parse,
800 false, NULL, NULL
803 {"debug_print_rewritten", PGC_USERSET, LOGGING_WHAT,
804 gettext_noop("Logs each query's rewritten parse tree."),
805 NULL
807 &Debug_print_rewritten,
808 false, NULL, NULL
811 {"debug_print_plan", PGC_USERSET, LOGGING_WHAT,
812 gettext_noop("Logs each query's execution plan."),
813 NULL
815 &Debug_print_plan,
816 false, NULL, NULL
819 {"debug_pretty_print", PGC_USERSET, LOGGING_WHAT,
820 gettext_noop("Indents parse and plan tree displays."),
821 NULL
823 &Debug_pretty_print,
824 true, NULL, NULL
827 {"log_parser_stats", PGC_SUSET, STATS_MONITORING,
828 gettext_noop("Writes parser performance statistics to the server log."),
829 NULL
831 &log_parser_stats,
832 false, assign_stage_log_stats, NULL
835 {"log_planner_stats", PGC_SUSET, STATS_MONITORING,
836 gettext_noop("Writes planner performance statistics to the server log."),
837 NULL
839 &log_planner_stats,
840 false, assign_stage_log_stats, NULL
843 {"log_executor_stats", PGC_SUSET, STATS_MONITORING,
844 gettext_noop("Writes executor performance statistics to the server log."),
845 NULL
847 &log_executor_stats,
848 false, assign_stage_log_stats, NULL
851 {"log_statement_stats", PGC_SUSET, STATS_MONITORING,
852 gettext_noop("Writes cumulative performance statistics to the server log."),
853 NULL
855 &log_statement_stats,
856 false, assign_log_stats, NULL
858 #ifdef BTREE_BUILD_STATS
860 {"log_btree_build_stats", PGC_SUSET, DEVELOPER_OPTIONS,
861 gettext_noop("No description available."),
862 NULL,
863 GUC_NOT_IN_SAMPLE
865 &log_btree_build_stats,
866 false, NULL, NULL
868 #endif
871 {"track_activities", PGC_SUSET, STATS_COLLECTOR,
872 gettext_noop("Collects information about executing commands."),
873 gettext_noop("Enables the collection of information on the currently "
874 "executing command of each session, along with "
875 "the time at which that command began execution.")
877 &pgstat_track_activities,
878 true, NULL, NULL
881 {"track_counts", PGC_SUSET, STATS_COLLECTOR,
882 gettext_noop("Collects statistics on database activity."),
883 NULL
885 &pgstat_track_counts,
886 true, NULL, NULL
890 {"update_process_title", PGC_SUSET, STATS_COLLECTOR,
891 gettext_noop("Updates the process title to show the active SQL command."),
892 gettext_noop("Enables updating of the process title every time a new SQL command is received by the server.")
894 &update_process_title,
895 true, NULL, NULL
899 {"autovacuum", PGC_SIGHUP, AUTOVACUUM,
900 gettext_noop("Starts the autovacuum subprocess."),
901 NULL
903 &autovacuum_start_daemon,
904 true, NULL, NULL
908 {"trace_notify", PGC_USERSET, DEVELOPER_OPTIONS,
909 gettext_noop("Generates debugging output for LISTEN and NOTIFY."),
910 NULL,
911 GUC_NOT_IN_SAMPLE
913 &Trace_notify,
914 false, NULL, NULL
917 #ifdef LOCK_DEBUG
919 {"trace_locks", PGC_SUSET, DEVELOPER_OPTIONS,
920 gettext_noop("No description available."),
921 NULL,
922 GUC_NOT_IN_SAMPLE
924 &Trace_locks,
925 false, NULL, NULL
928 {"trace_userlocks", PGC_SUSET, DEVELOPER_OPTIONS,
929 gettext_noop("No description available."),
930 NULL,
931 GUC_NOT_IN_SAMPLE
933 &Trace_userlocks,
934 false, NULL, NULL
937 {"trace_lwlocks", PGC_SUSET, DEVELOPER_OPTIONS,
938 gettext_noop("No description available."),
939 NULL,
940 GUC_NOT_IN_SAMPLE
942 &Trace_lwlocks,
943 false, NULL, NULL
946 {"debug_deadlocks", PGC_SUSET, DEVELOPER_OPTIONS,
947 gettext_noop("No description available."),
948 NULL,
949 GUC_NOT_IN_SAMPLE
951 &Debug_deadlocks,
952 false, NULL, NULL
954 #endif
957 {"log_lock_waits", PGC_SUSET, LOGGING_WHAT,
958 gettext_noop("Logs long lock waits."),
959 NULL
961 &log_lock_waits,
962 false, NULL, NULL
966 {"log_hostname", PGC_SIGHUP, LOGGING_WHAT,
967 gettext_noop("Logs the host name in the connection logs."),
968 gettext_noop("By default, connection logs only show the IP address "
969 "of the connecting host. If you want them to show the host name you "
970 "can turn this on, but depending on your host name resolution "
971 "setup it might impose a non-negligible performance penalty.")
973 &log_hostname,
974 false, NULL, NULL
977 {"sql_inheritance", PGC_USERSET, COMPAT_OPTIONS_PREVIOUS,
978 gettext_noop("Causes subtables to be included by default in various commands."),
979 NULL
981 &SQL_inheritance,
982 true, NULL, NULL
985 {"password_encryption", PGC_USERSET, CONN_AUTH_SECURITY,
986 gettext_noop("Encrypt passwords."),
987 gettext_noop("When a password is specified in CREATE USER or "
988 "ALTER USER without writing either ENCRYPTED or UNENCRYPTED, "
989 "this parameter determines whether the password is to be encrypted.")
991 &Password_encryption,
992 true, NULL, NULL
995 {"transform_null_equals", PGC_USERSET, COMPAT_OPTIONS_CLIENT,
996 gettext_noop("Treats \"expr=NULL\" as \"expr IS NULL\"."),
997 gettext_noop("When turned on, expressions of the form expr = NULL "
998 "(or NULL = expr) are treated as expr IS NULL, that is, they "
999 "return true if expr evaluates to the null value, and false "
1000 "otherwise. The correct behavior of expr = NULL is to always "
1001 "return null (unknown).")
1003 &Transform_null_equals,
1004 false, NULL, NULL
1007 {"db_user_namespace", PGC_SIGHUP, CONN_AUTH_SECURITY,
1008 gettext_noop("Enables per-database user names."),
1009 NULL
1011 &Db_user_namespace,
1012 false, NULL, NULL
1015 /* only here for backwards compatibility */
1016 {"autocommit", PGC_USERSET, CLIENT_CONN_STATEMENT,
1017 gettext_noop("This parameter doesn't do anything."),
1018 gettext_noop("It's just here so that we won't choke on SET AUTOCOMMIT TO ON from 7.3-vintage clients."),
1019 GUC_NO_SHOW_ALL | GUC_NOT_IN_SAMPLE
1021 &phony_autocommit,
1022 true, assign_phony_autocommit, NULL
1025 {"default_transaction_read_only", PGC_USERSET, CLIENT_CONN_STATEMENT,
1026 gettext_noop("Sets the default read-only status of new transactions."),
1027 NULL
1029 &DefaultXactReadOnly,
1030 false, NULL, NULL
1033 {"transaction_read_only", PGC_USERSET, CLIENT_CONN_STATEMENT,
1034 gettext_noop("Sets the current transaction's read-only status."),
1035 NULL,
1036 GUC_NO_RESET_ALL | GUC_NOT_IN_SAMPLE | GUC_DISALLOW_IN_FILE
1038 &XactReadOnly,
1039 false, assign_transaction_read_only, NULL
1042 {"add_missing_from", PGC_USERSET, COMPAT_OPTIONS_PREVIOUS,
1043 gettext_noop("Automatically adds missing table references to FROM clauses."),
1044 NULL
1046 &add_missing_from,
1047 false, NULL, NULL
1050 {"check_function_bodies", PGC_USERSET, CLIENT_CONN_STATEMENT,
1051 gettext_noop("Check function bodies during CREATE FUNCTION."),
1052 NULL
1054 &check_function_bodies,
1055 true, NULL, NULL
1058 {"array_nulls", PGC_USERSET, COMPAT_OPTIONS_PREVIOUS,
1059 gettext_noop("Enable input of NULL elements in arrays."),
1060 gettext_noop("When turned on, unquoted NULL in an array input "
1061 "value means a null value; "
1062 "otherwise it is taken literally.")
1064 &Array_nulls,
1065 true, NULL, NULL
1068 {"default_with_oids", PGC_USERSET, COMPAT_OPTIONS_PREVIOUS,
1069 gettext_noop("Create new tables with OIDs by default."),
1070 NULL
1072 &default_with_oids,
1073 false, NULL, NULL
1076 {"logging_collector", PGC_POSTMASTER, LOGGING_WHERE,
1077 gettext_noop("Start a subprocess to capture stderr output and/or csvlogs into log files."),
1078 NULL
1080 &Logging_collector,
1081 false, NULL, NULL
1084 {"log_truncate_on_rotation", PGC_SIGHUP, LOGGING_WHERE,
1085 gettext_noop("Truncate existing log files of same name during log rotation."),
1086 NULL
1088 &Log_truncate_on_rotation,
1089 false, NULL, NULL
1092 #ifdef TRACE_SORT
1094 {"trace_sort", PGC_USERSET, DEVELOPER_OPTIONS,
1095 gettext_noop("Emit information about resource usage in sorting."),
1096 NULL,
1097 GUC_NOT_IN_SAMPLE
1099 &trace_sort,
1100 false, NULL, NULL
1102 #endif
1104 #ifdef TRACE_SYNCSCAN
1105 /* this is undocumented because not exposed in a standard build */
1107 {"trace_syncscan", PGC_USERSET, DEVELOPER_OPTIONS,
1108 gettext_noop("Generate debugging output for synchronized scanning."),
1109 NULL,
1110 GUC_NOT_IN_SAMPLE
1112 &trace_syncscan,
1113 false, NULL, NULL
1115 #endif
1117 #ifdef DEBUG_BOUNDED_SORT
1118 /* this is undocumented because not exposed in a standard build */
1121 "optimize_bounded_sort", PGC_USERSET, QUERY_TUNING_METHOD,
1122 gettext_noop("Enable bounded sorting using heap sort."),
1123 NULL,
1124 GUC_NOT_IN_SAMPLE
1126 &optimize_bounded_sort,
1127 true, NULL, NULL
1129 #endif
1131 #ifdef WAL_DEBUG
1133 {"wal_debug", PGC_SUSET, DEVELOPER_OPTIONS,
1134 gettext_noop("Emit WAL-related debugging output."),
1135 NULL,
1136 GUC_NOT_IN_SAMPLE
1138 &XLOG_DEBUG,
1139 false, NULL, NULL
1141 #endif
1144 {"integer_datetimes", PGC_INTERNAL, PRESET_OPTIONS,
1145 gettext_noop("Datetimes are integer based."),
1146 NULL,
1147 GUC_REPORT | GUC_NOT_IN_SAMPLE | GUC_DISALLOW_IN_FILE
1149 &integer_datetimes,
1150 #ifdef HAVE_INT64_TIMESTAMP
1151 true, NULL, NULL
1152 #else
1153 false, NULL, NULL
1154 #endif
1158 {"krb_caseins_users", PGC_SIGHUP, CONN_AUTH_SECURITY,
1159 gettext_noop("Sets whether Kerberos and GSSAPI user names should be treated as case-insensitive."),
1160 NULL
1162 &pg_krb_caseins_users,
1163 false, NULL, NULL
1167 {"escape_string_warning", PGC_USERSET, COMPAT_OPTIONS_PREVIOUS,
1168 gettext_noop("Warn about backslash escapes in ordinary string literals."),
1169 NULL
1171 &escape_string_warning,
1172 true, NULL, NULL
1176 {"standard_conforming_strings", PGC_USERSET, COMPAT_OPTIONS_PREVIOUS,
1177 gettext_noop("Causes '...' strings to treat backslashes literally."),
1178 NULL,
1179 GUC_REPORT
1181 &standard_conforming_strings,
1182 false, NULL, NULL
1186 {"synchronize_seqscans", PGC_USERSET, COMPAT_OPTIONS_PREVIOUS,
1187 gettext_noop("Enable synchronized sequential scans."),
1188 NULL
1190 &synchronize_seqscans,
1191 true, NULL, NULL
1195 {"archive_mode", PGC_POSTMASTER, WAL_SETTINGS,
1196 gettext_noop("Allows archiving of WAL files using archive_command."),
1197 NULL
1199 &XLogArchiveMode,
1200 false, NULL, NULL
1204 {"allow_system_table_mods", PGC_POSTMASTER, DEVELOPER_OPTIONS,
1205 gettext_noop("Allows modifications of the structure of system tables."),
1206 NULL,
1207 GUC_NOT_IN_SAMPLE
1209 &allowSystemTableMods,
1210 false, NULL, NULL
1214 {"ignore_system_indexes", PGC_BACKEND, DEVELOPER_OPTIONS,
1215 gettext_noop("Disables reading from system indexes."),
1216 gettext_noop("It does not prevent updating the indexes, so it is safe "
1217 "to use. The worst consequence is slowness."),
1218 GUC_NOT_IN_SAMPLE
1220 &IgnoreSystemIndexes,
1221 false, NULL, NULL
1224 /* End-of-list marker */
1226 {NULL, 0, 0, NULL, NULL}, NULL, false, NULL, NULL
1231 static struct config_int ConfigureNamesInt[] =
1234 {"archive_timeout", PGC_SIGHUP, WAL_SETTINGS,
1235 gettext_noop("Forces a switch to the next xlog file if a "
1236 "new file has not been started within N seconds."),
1237 NULL,
1238 GUC_UNIT_S
1240 &XLogArchiveTimeout,
1241 0, 0, INT_MAX, NULL, NULL
1244 {"post_auth_delay", PGC_BACKEND, DEVELOPER_OPTIONS,
1245 gettext_noop("Waits N seconds on connection startup after authentication."),
1246 gettext_noop("This allows attaching a debugger to the process."),
1247 GUC_NOT_IN_SAMPLE | GUC_UNIT_S
1249 &PostAuthDelay,
1250 0, 0, INT_MAX, NULL, NULL
1253 {"default_statistics_target", PGC_USERSET, QUERY_TUNING_OTHER,
1254 gettext_noop("Sets the default statistics target."),
1255 gettext_noop("This applies to table columns that have not had a "
1256 "column-specific target set via ALTER TABLE SET STATISTICS.")
1258 &default_statistics_target,
1259 100, 1, 10000, NULL, NULL
1262 {"from_collapse_limit", PGC_USERSET, QUERY_TUNING_OTHER,
1263 gettext_noop("Sets the FROM-list size beyond which subqueries "
1264 "are not collapsed."),
1265 gettext_noop("The planner will merge subqueries into upper "
1266 "queries if the resulting FROM list would have no more than "
1267 "this many items.")
1269 &from_collapse_limit,
1270 8, 1, INT_MAX, NULL, NULL
1273 {"join_collapse_limit", PGC_USERSET, QUERY_TUNING_OTHER,
1274 gettext_noop("Sets the FROM-list size beyond which JOIN "
1275 "constructs are not flattened."),
1276 gettext_noop("The planner will flatten explicit JOIN "
1277 "constructs into lists of FROM items whenever a "
1278 "list of no more than this many items would result.")
1280 &join_collapse_limit,
1281 8, 1, INT_MAX, NULL, NULL
1284 {"geqo_threshold", PGC_USERSET, QUERY_TUNING_GEQO,
1285 gettext_noop("Sets the threshold of FROM items beyond which GEQO is used."),
1286 NULL
1288 &geqo_threshold,
1289 12, 2, INT_MAX, NULL, NULL
1292 {"geqo_effort", PGC_USERSET, QUERY_TUNING_GEQO,
1293 gettext_noop("GEQO: effort is used to set the default for other GEQO parameters."),
1294 NULL
1296 &Geqo_effort,
1297 DEFAULT_GEQO_EFFORT, MIN_GEQO_EFFORT, MAX_GEQO_EFFORT, NULL, NULL
1300 {"geqo_pool_size", PGC_USERSET, QUERY_TUNING_GEQO,
1301 gettext_noop("GEQO: number of individuals in the population."),
1302 gettext_noop("Zero selects a suitable default value.")
1304 &Geqo_pool_size,
1305 0, 0, INT_MAX, NULL, NULL
1308 {"geqo_generations", PGC_USERSET, QUERY_TUNING_GEQO,
1309 gettext_noop("GEQO: number of iterations of the algorithm."),
1310 gettext_noop("Zero selects a suitable default value.")
1312 &Geqo_generations,
1313 0, 0, INT_MAX, NULL, NULL
1317 /* This is PGC_SIGHUP so all backends have the same value. */
1318 {"deadlock_timeout", PGC_SIGHUP, LOCK_MANAGEMENT,
1319 gettext_noop("Sets the time to wait on a lock before checking for deadlock."),
1320 NULL,
1321 GUC_UNIT_MS
1323 &DeadlockTimeout,
1324 1000, 1, INT_MAX / 1000, NULL, NULL
1328 * Note: MaxBackends is limited to INT_MAX/4 because some places compute
1329 * 4*MaxBackends without any overflow check. This check is made in
1330 * assign_maxconnections, since MaxBackends is computed as MaxConnections
1331 * plus autovacuum_max_workers.
1333 * Likewise we have to limit NBuffers to INT_MAX/2.
1336 {"max_connections", PGC_POSTMASTER, CONN_AUTH_SETTINGS,
1337 gettext_noop("Sets the maximum number of concurrent connections."),
1338 NULL
1340 &MaxConnections,
1341 100, 1, INT_MAX / 4, assign_maxconnections, NULL
1345 {"superuser_reserved_connections", PGC_POSTMASTER, CONN_AUTH_SETTINGS,
1346 gettext_noop("Sets the number of connection slots reserved for superusers."),
1347 NULL
1349 &ReservedBackends,
1350 3, 0, INT_MAX / 4, NULL, NULL
1354 {"shared_buffers", PGC_POSTMASTER, RESOURCES_MEM,
1355 gettext_noop("Sets the number of shared memory buffers used by the server."),
1356 NULL,
1357 GUC_UNIT_BLOCKS
1359 &NBuffers,
1360 1024, 16, INT_MAX / 2, NULL, NULL
1364 {"temp_buffers", PGC_USERSET, RESOURCES_MEM,
1365 gettext_noop("Sets the maximum number of temporary buffers used by each session."),
1366 NULL,
1367 GUC_UNIT_BLOCKS
1369 &num_temp_buffers,
1370 1024, 100, INT_MAX / 2, NULL, show_num_temp_buffers
1374 {"port", PGC_POSTMASTER, CONN_AUTH_SETTINGS,
1375 gettext_noop("Sets the TCP port the server listens on."),
1376 NULL
1378 &PostPortNumber,
1379 DEF_PGPORT, 1, 65535, NULL, NULL
1383 {"unix_socket_permissions", PGC_POSTMASTER, CONN_AUTH_SETTINGS,
1384 gettext_noop("Sets the access permissions of the Unix-domain socket."),
1385 gettext_noop("Unix-domain sockets use the usual Unix file system "
1386 "permission set. The parameter value is expected to be a numeric mode "
1387 "specification in the form accepted by the chmod and umask system "
1388 "calls. (To use the customary octal format the number must start with "
1389 "a 0 (zero).)")
1391 &Unix_socket_permissions,
1392 0777, 0000, 0777, NULL, NULL
1396 {"work_mem", PGC_USERSET, RESOURCES_MEM,
1397 gettext_noop("Sets the maximum memory to be used for query workspaces."),
1398 gettext_noop("This much memory can be used by each internal "
1399 "sort operation and hash table before switching to "
1400 "temporary disk files."),
1401 GUC_UNIT_KB
1403 &work_mem,
1404 1024, 64, MAX_KILOBYTES, NULL, NULL
1408 {"maintenance_work_mem", PGC_USERSET, RESOURCES_MEM,
1409 gettext_noop("Sets the maximum memory to be used for maintenance operations."),
1410 gettext_noop("This includes operations such as VACUUM and CREATE INDEX."),
1411 GUC_UNIT_KB
1413 &maintenance_work_mem,
1414 16384, 1024, MAX_KILOBYTES, NULL, NULL
1418 {"max_stack_depth", PGC_SUSET, RESOURCES_MEM,
1419 gettext_noop("Sets the maximum stack depth, in kilobytes."),
1420 NULL,
1421 GUC_UNIT_KB
1423 &max_stack_depth,
1424 100, 100, MAX_KILOBYTES, assign_max_stack_depth, NULL
1428 {"vacuum_cost_page_hit", PGC_USERSET, RESOURCES,
1429 gettext_noop("Vacuum cost for a page found in the buffer cache."),
1430 NULL
1432 &VacuumCostPageHit,
1433 1, 0, 10000, NULL, NULL
1437 {"vacuum_cost_page_miss", PGC_USERSET, RESOURCES,
1438 gettext_noop("Vacuum cost for a page not found in the buffer cache."),
1439 NULL
1441 &VacuumCostPageMiss,
1442 10, 0, 10000, NULL, NULL
1446 {"vacuum_cost_page_dirty", PGC_USERSET, RESOURCES,
1447 gettext_noop("Vacuum cost for a page dirtied by vacuum."),
1448 NULL
1450 &VacuumCostPageDirty,
1451 20, 0, 10000, NULL, NULL
1455 {"vacuum_cost_limit", PGC_USERSET, RESOURCES,
1456 gettext_noop("Vacuum cost amount available before napping."),
1457 NULL
1459 &VacuumCostLimit,
1460 200, 1, 10000, NULL, NULL
1464 {"vacuum_cost_delay", PGC_USERSET, RESOURCES,
1465 gettext_noop("Vacuum cost delay in milliseconds."),
1466 NULL,
1467 GUC_UNIT_MS
1469 &VacuumCostDelay,
1470 0, 0, 100, NULL, NULL
1474 {"autovacuum_vacuum_cost_delay", PGC_SIGHUP, AUTOVACUUM,
1475 gettext_noop("Vacuum cost delay in milliseconds, for autovacuum."),
1476 NULL,
1477 GUC_UNIT_MS
1479 &autovacuum_vac_cost_delay,
1480 20, -1, 100, NULL, NULL
1484 {"autovacuum_vacuum_cost_limit", PGC_SIGHUP, AUTOVACUUM,
1485 gettext_noop("Vacuum cost amount available before napping, for autovacuum."),
1486 NULL
1488 &autovacuum_vac_cost_limit,
1489 -1, -1, 10000, NULL, NULL
1493 {"max_files_per_process", PGC_POSTMASTER, RESOURCES_KERNEL,
1494 gettext_noop("Sets the maximum number of simultaneously open files for each server process."),
1495 NULL
1497 &max_files_per_process,
1498 1000, 25, INT_MAX, NULL, NULL
1502 {"max_prepared_transactions", PGC_POSTMASTER, RESOURCES,
1503 gettext_noop("Sets the maximum number of simultaneously prepared transactions."),
1504 NULL
1506 &max_prepared_xacts,
1507 0, 0, INT_MAX / 4, NULL, NULL
1510 #ifdef LOCK_DEBUG
1512 {"trace_lock_oidmin", PGC_SUSET, DEVELOPER_OPTIONS,
1513 gettext_noop("No description available."),
1514 NULL,
1515 GUC_NOT_IN_SAMPLE
1517 &Trace_lock_oidmin,
1518 FirstNormalObjectId, 0, INT_MAX, NULL, NULL
1521 {"trace_lock_table", PGC_SUSET, DEVELOPER_OPTIONS,
1522 gettext_noop("No description available."),
1523 NULL,
1524 GUC_NOT_IN_SAMPLE
1526 &Trace_lock_table,
1527 0, 0, INT_MAX, NULL, NULL
1529 #endif
1532 {"statement_timeout", PGC_USERSET, CLIENT_CONN_STATEMENT,
1533 gettext_noop("Sets the maximum allowed duration of any statement."),
1534 gettext_noop("A value of 0 turns off the timeout."),
1535 GUC_UNIT_MS
1537 &StatementTimeout,
1538 0, 0, INT_MAX, NULL, NULL
1542 {"vacuum_freeze_min_age", PGC_USERSET, CLIENT_CONN_STATEMENT,
1543 gettext_noop("Minimum age at which VACUUM should freeze a table row."),
1544 NULL
1546 &vacuum_freeze_min_age,
1547 50000000, 0, 1000000000, NULL, NULL
1551 {"vacuum_freeze_table_age", PGC_USERSET, CLIENT_CONN_STATEMENT,
1552 gettext_noop("Age at which VACUUM should scan whole table to freeze tuples."),
1553 NULL
1555 &vacuum_freeze_table_age,
1556 150000000, 0, 2000000000, NULL, NULL
1560 {"max_locks_per_transaction", PGC_POSTMASTER, LOCK_MANAGEMENT,
1561 gettext_noop("Sets the maximum number of locks per transaction."),
1562 gettext_noop("The shared lock table is sized on the assumption that "
1563 "at most max_locks_per_transaction * max_connections distinct "
1564 "objects will need to be locked at any one time.")
1566 &max_locks_per_xact,
1567 64, 10, INT_MAX, NULL, NULL
1571 {"authentication_timeout", PGC_SIGHUP, CONN_AUTH_SECURITY,
1572 gettext_noop("Sets the maximum allowed time to complete client authentication."),
1573 NULL,
1574 GUC_UNIT_S
1576 &AuthenticationTimeout,
1577 60, 1, 600, NULL, NULL
1581 /* Not for general use */
1582 {"pre_auth_delay", PGC_SIGHUP, DEVELOPER_OPTIONS,
1583 gettext_noop("Waits N seconds on connection startup before authentication."),
1584 gettext_noop("This allows attaching a debugger to the process."),
1585 GUC_NOT_IN_SAMPLE | GUC_UNIT_S
1587 &PreAuthDelay,
1588 0, 0, 60, NULL, NULL
1592 {"checkpoint_segments", PGC_SIGHUP, WAL_CHECKPOINTS,
1593 gettext_noop("Sets the maximum distance in log segments between automatic WAL checkpoints."),
1594 NULL
1596 &CheckPointSegments,
1597 3, 1, INT_MAX, NULL, NULL
1601 {"checkpoint_timeout", PGC_SIGHUP, WAL_CHECKPOINTS,
1602 gettext_noop("Sets the maximum time between automatic WAL checkpoints."),
1603 NULL,
1604 GUC_UNIT_S
1606 &CheckPointTimeout,
1607 300, 30, 3600, NULL, NULL
1611 {"checkpoint_warning", PGC_SIGHUP, WAL_CHECKPOINTS,
1612 gettext_noop("Enables warnings if checkpoint segments are filled more "
1613 "frequently than this."),
1614 gettext_noop("Write a message to the server log if checkpoints "
1615 "caused by the filling of checkpoint segment files happens more "
1616 "frequently than this number of seconds. Zero turns off the warning."),
1617 GUC_UNIT_S
1619 &CheckPointWarning,
1620 30, 0, INT_MAX, NULL, NULL
1624 {"wal_buffers", PGC_POSTMASTER, WAL_SETTINGS,
1625 gettext_noop("Sets the number of disk-page buffers in shared memory for WAL."),
1626 NULL,
1627 GUC_UNIT_XBLOCKS
1629 &XLOGbuffers,
1630 8, 4, INT_MAX, NULL, NULL
1634 {"wal_writer_delay", PGC_SIGHUP, WAL_SETTINGS,
1635 gettext_noop("WAL writer sleep time between WAL flushes."),
1636 NULL,
1637 GUC_UNIT_MS
1639 &WalWriterDelay,
1640 200, 1, 10000, NULL, NULL
1644 {"commit_delay", PGC_USERSET, WAL_SETTINGS,
1645 gettext_noop("Sets the delay in microseconds between transaction commit and "
1646 "flushing WAL to disk."),
1647 NULL
1649 &CommitDelay,
1650 0, 0, 100000, NULL, NULL
1654 {"commit_siblings", PGC_USERSET, WAL_SETTINGS,
1655 gettext_noop("Sets the minimum concurrent open transactions before performing "
1656 "commit_delay."),
1657 NULL
1659 &CommitSiblings,
1660 5, 1, 1000, NULL, NULL
1664 {"extra_float_digits", PGC_USERSET, CLIENT_CONN_LOCALE,
1665 gettext_noop("Sets the number of digits displayed for floating-point values."),
1666 gettext_noop("This affects real, double precision, and geometric data types. "
1667 "The parameter value is added to the standard number of digits "
1668 "(FLT_DIG or DBL_DIG as appropriate).")
1670 &extra_float_digits,
1671 0, -15, 2, NULL, NULL
1675 {"log_min_duration_statement", PGC_SUSET, LOGGING_WHEN,
1676 gettext_noop("Sets the minimum execution time above which "
1677 "statements will be logged."),
1678 gettext_noop("Zero prints all queries. -1 turns this feature off."),
1679 GUC_UNIT_MS
1681 &log_min_duration_statement,
1682 -1, -1, INT_MAX / 1000, NULL, NULL
1686 {"log_autovacuum_min_duration", PGC_SIGHUP, LOGGING_WHAT,
1687 gettext_noop("Sets the minimum execution time above which "
1688 "autovacuum actions will be logged."),
1689 gettext_noop("Zero prints all actions. -1 turns autovacuum logging off."),
1690 GUC_UNIT_MS
1692 &Log_autovacuum_min_duration,
1693 -1, -1, INT_MAX / 1000, NULL, NULL
1697 {"bgwriter_delay", PGC_SIGHUP, RESOURCES,
1698 gettext_noop("Background writer sleep time between rounds."),
1699 NULL,
1700 GUC_UNIT_MS
1702 &BgWriterDelay,
1703 200, 10, 10000, NULL, NULL
1707 {"bgwriter_lru_maxpages", PGC_SIGHUP, RESOURCES,
1708 gettext_noop("Background writer maximum number of LRU pages to flush per round."),
1709 NULL
1711 &bgwriter_lru_maxpages,
1712 100, 0, 1000, NULL, NULL
1716 {"effective_io_concurrency",
1717 #ifdef USE_PREFETCH
1718 PGC_USERSET,
1719 #else
1720 PGC_INTERNAL,
1721 #endif
1722 RESOURCES,
1723 gettext_noop("Number of simultaneous requests that can be handled efficiently by the disk subsystem."),
1724 gettext_noop("For RAID arrays, this should be approximately the number of drive spindles in the array.")
1726 &effective_io_concurrency,
1727 #ifdef USE_PREFETCH
1728 1, 0, 1000,
1729 #else
1730 0, 0, 0,
1731 #endif
1732 assign_effective_io_concurrency, NULL
1736 {"log_rotation_age", PGC_SIGHUP, LOGGING_WHERE,
1737 gettext_noop("Automatic log file rotation will occur after N minutes."),
1738 NULL,
1739 GUC_UNIT_MIN
1741 &Log_RotationAge,
1742 HOURS_PER_DAY * MINS_PER_HOUR, 0, INT_MAX / MINS_PER_HOUR, NULL, NULL
1746 {"log_rotation_size", PGC_SIGHUP, LOGGING_WHERE,
1747 gettext_noop("Automatic log file rotation will occur after N kilobytes."),
1748 NULL,
1749 GUC_UNIT_KB
1751 &Log_RotationSize,
1752 10 * 1024, 0, INT_MAX / 1024, NULL, NULL
1756 {"max_function_args", PGC_INTERNAL, PRESET_OPTIONS,
1757 gettext_noop("Shows the maximum number of function arguments."),
1758 NULL,
1759 GUC_NOT_IN_SAMPLE | GUC_DISALLOW_IN_FILE
1761 &max_function_args,
1762 FUNC_MAX_ARGS, FUNC_MAX_ARGS, FUNC_MAX_ARGS, NULL, NULL
1766 {"max_index_keys", PGC_INTERNAL, PRESET_OPTIONS,
1767 gettext_noop("Shows the maximum number of index keys."),
1768 NULL,
1769 GUC_NOT_IN_SAMPLE | GUC_DISALLOW_IN_FILE
1771 &max_index_keys,
1772 INDEX_MAX_KEYS, INDEX_MAX_KEYS, INDEX_MAX_KEYS, NULL, NULL
1776 {"max_identifier_length", PGC_INTERNAL, PRESET_OPTIONS,
1777 gettext_noop("Shows the maximum identifier length."),
1778 NULL,
1779 GUC_NOT_IN_SAMPLE | GUC_DISALLOW_IN_FILE
1781 &max_identifier_length,
1782 NAMEDATALEN - 1, NAMEDATALEN - 1, NAMEDATALEN - 1, NULL, NULL
1786 {"block_size", PGC_INTERNAL, PRESET_OPTIONS,
1787 gettext_noop("Shows the size of a disk block."),
1788 NULL,
1789 GUC_NOT_IN_SAMPLE | GUC_DISALLOW_IN_FILE
1791 &block_size,
1792 BLCKSZ, BLCKSZ, BLCKSZ, NULL, NULL
1796 {"segment_size", PGC_INTERNAL, PRESET_OPTIONS,
1797 gettext_noop("Shows the number of pages per disk file."),
1798 NULL,
1799 GUC_UNIT_BLOCKS | GUC_NOT_IN_SAMPLE | GUC_DISALLOW_IN_FILE
1801 &segment_size,
1802 RELSEG_SIZE, RELSEG_SIZE, RELSEG_SIZE, NULL, NULL
1806 {"wal_block_size", PGC_INTERNAL, PRESET_OPTIONS,
1807 gettext_noop("Shows the block size in the write ahead log."),
1808 NULL,
1809 GUC_NOT_IN_SAMPLE | GUC_DISALLOW_IN_FILE
1811 &wal_block_size,
1812 XLOG_BLCKSZ, XLOG_BLCKSZ, XLOG_BLCKSZ, NULL, NULL
1816 {"wal_segment_size", PGC_INTERNAL, PRESET_OPTIONS,
1817 gettext_noop("Shows the number of pages per write ahead log segment."),
1818 NULL,
1819 GUC_UNIT_XBLOCKS | GUC_NOT_IN_SAMPLE | GUC_DISALLOW_IN_FILE
1821 &wal_segment_size,
1822 (XLOG_SEG_SIZE / XLOG_BLCKSZ),
1823 (XLOG_SEG_SIZE / XLOG_BLCKSZ),
1824 (XLOG_SEG_SIZE / XLOG_BLCKSZ),
1825 NULL, NULL
1829 {"autovacuum_naptime", PGC_SIGHUP, AUTOVACUUM,
1830 gettext_noop("Time to sleep between autovacuum runs."),
1831 NULL,
1832 GUC_UNIT_S
1834 &autovacuum_naptime,
1835 60, 1, INT_MAX / 1000, NULL, NULL
1838 {"autovacuum_vacuum_threshold", PGC_SIGHUP, AUTOVACUUM,
1839 gettext_noop("Minimum number of tuple updates or deletes prior to vacuum."),
1840 NULL
1842 &autovacuum_vac_thresh,
1843 50, 0, INT_MAX, NULL, NULL
1846 {"autovacuum_analyze_threshold", PGC_SIGHUP, AUTOVACUUM,
1847 gettext_noop("Minimum number of tuple inserts, updates or deletes prior to analyze."),
1848 NULL
1850 &autovacuum_anl_thresh,
1851 50, 0, INT_MAX, NULL, NULL
1854 /* see varsup.c for why this is PGC_POSTMASTER not PGC_SIGHUP */
1855 {"autovacuum_freeze_max_age", PGC_POSTMASTER, AUTOVACUUM,
1856 gettext_noop("Age at which to autovacuum a table to prevent transaction ID wraparound."),
1857 NULL
1859 &autovacuum_freeze_max_age,
1860 200000000, 100000000, 2000000000, NULL, NULL
1863 /* see max_connections */
1864 {"autovacuum_max_workers", PGC_POSTMASTER, AUTOVACUUM,
1865 gettext_noop("Sets the maximum number of simultaneously running autovacuum worker processes."),
1866 NULL
1868 &autovacuum_max_workers,
1869 3, 1, INT_MAX / 4, assign_autovacuum_max_workers, NULL
1873 {"tcp_keepalives_idle", PGC_USERSET, CLIENT_CONN_OTHER,
1874 gettext_noop("Time between issuing TCP keepalives."),
1875 gettext_noop("A value of 0 uses the system default."),
1876 GUC_UNIT_S
1878 &tcp_keepalives_idle,
1879 0, 0, INT_MAX, assign_tcp_keepalives_idle, show_tcp_keepalives_idle
1883 {"tcp_keepalives_interval", PGC_USERSET, CLIENT_CONN_OTHER,
1884 gettext_noop("Time between TCP keepalive retransmits."),
1885 gettext_noop("A value of 0 uses the system default."),
1886 GUC_UNIT_S
1888 &tcp_keepalives_interval,
1889 0, 0, INT_MAX, assign_tcp_keepalives_interval, show_tcp_keepalives_interval
1893 {"tcp_keepalives_count", PGC_USERSET, CLIENT_CONN_OTHER,
1894 gettext_noop("Maximum number of TCP keepalive retransmits."),
1895 gettext_noop("This controls the number of consecutive keepalive retransmits that can be "
1896 "lost before a connection is considered dead. A value of 0 uses the "
1897 "system default."),
1899 &tcp_keepalives_count,
1900 0, 0, INT_MAX, assign_tcp_keepalives_count, show_tcp_keepalives_count
1904 {"gin_fuzzy_search_limit", PGC_USERSET, CLIENT_CONN_OTHER,
1905 gettext_noop("Sets the maximum allowed result for exact search by GIN."),
1906 NULL,
1909 &GinFuzzySearchLimit,
1910 0, 0, INT_MAX, NULL, NULL
1914 {"effective_cache_size", PGC_USERSET, QUERY_TUNING_COST,
1915 gettext_noop("Sets the planner's assumption about the size of the disk cache."),
1916 gettext_noop("That is, the portion of the kernel's disk cache that "
1917 "will be used for PostgreSQL data files. This is measured in disk "
1918 "pages, which are normally 8 kB each."),
1919 GUC_UNIT_BLOCKS,
1921 &effective_cache_size,
1922 DEFAULT_EFFECTIVE_CACHE_SIZE, 1, INT_MAX, NULL, NULL
1926 /* Can't be set in postgresql.conf */
1927 {"server_version_num", PGC_INTERNAL, PRESET_OPTIONS,
1928 gettext_noop("Shows the server version as an integer."),
1929 NULL,
1930 GUC_NOT_IN_SAMPLE | GUC_DISALLOW_IN_FILE
1932 &server_version_num,
1933 PG_VERSION_NUM, PG_VERSION_NUM, PG_VERSION_NUM, NULL, NULL
1937 {"log_temp_files", PGC_SUSET, LOGGING_WHAT,
1938 gettext_noop("Log the use of temporary files larger than this number of kilobytes."),
1939 gettext_noop("Zero logs all files. The default is -1 (turning this feature off)."),
1940 GUC_UNIT_KB
1942 &log_temp_files,
1943 -1, -1, INT_MAX, NULL, NULL
1947 {"track_activity_query_size", PGC_POSTMASTER, RESOURCES_MEM,
1948 gettext_noop("Sets the size reserved for pg_stat_activity.current_query, in bytes."),
1949 NULL,
1951 &pgstat_track_activity_query_size,
1952 1024, 100, 102400, NULL, NULL
1955 /* End-of-list marker */
1957 {NULL, 0, 0, NULL, NULL}, NULL, 0, 0, 0, NULL, NULL
1962 static struct config_real ConfigureNamesReal[] =
1965 {"seq_page_cost", PGC_USERSET, QUERY_TUNING_COST,
1966 gettext_noop("Sets the planner's estimate of the cost of a "
1967 "sequentially fetched disk page."),
1968 NULL
1970 &seq_page_cost,
1971 DEFAULT_SEQ_PAGE_COST, 0, DBL_MAX, NULL, NULL
1974 {"random_page_cost", PGC_USERSET, QUERY_TUNING_COST,
1975 gettext_noop("Sets the planner's estimate of the cost of a "
1976 "nonsequentially fetched disk page."),
1977 NULL
1979 &random_page_cost,
1980 DEFAULT_RANDOM_PAGE_COST, 0, DBL_MAX, NULL, NULL
1983 {"cpu_tuple_cost", PGC_USERSET, QUERY_TUNING_COST,
1984 gettext_noop("Sets the planner's estimate of the cost of "
1985 "processing each tuple (row)."),
1986 NULL
1988 &cpu_tuple_cost,
1989 DEFAULT_CPU_TUPLE_COST, 0, DBL_MAX, NULL, NULL
1992 {"cpu_index_tuple_cost", PGC_USERSET, QUERY_TUNING_COST,
1993 gettext_noop("Sets the planner's estimate of the cost of "
1994 "processing each index entry during an index scan."),
1995 NULL
1997 &cpu_index_tuple_cost,
1998 DEFAULT_CPU_INDEX_TUPLE_COST, 0, DBL_MAX, NULL, NULL
2001 {"cpu_operator_cost", PGC_USERSET, QUERY_TUNING_COST,
2002 gettext_noop("Sets the planner's estimate of the cost of "
2003 "processing each operator or function call."),
2004 NULL
2006 &cpu_operator_cost,
2007 DEFAULT_CPU_OPERATOR_COST, 0, DBL_MAX, NULL, NULL
2011 {"cursor_tuple_fraction", PGC_USERSET, QUERY_TUNING_OTHER,
2012 gettext_noop("Sets the planner's estimate of the fraction of "
2013 "a cursor's rows that will be retrieved."),
2014 NULL
2016 &cursor_tuple_fraction,
2017 DEFAULT_CURSOR_TUPLE_FRACTION, 0.0, 1.0, NULL, NULL
2021 {"geqo_selection_bias", PGC_USERSET, QUERY_TUNING_GEQO,
2022 gettext_noop("GEQO: selective pressure within the population."),
2023 NULL
2025 &Geqo_selection_bias,
2026 DEFAULT_GEQO_SELECTION_BIAS, MIN_GEQO_SELECTION_BIAS,
2027 MAX_GEQO_SELECTION_BIAS, NULL, NULL
2031 {"bgwriter_lru_multiplier", PGC_SIGHUP, RESOURCES,
2032 gettext_noop("Multiple of the average buffer usage to free per round."),
2033 NULL
2035 &bgwriter_lru_multiplier,
2036 2.0, 0.0, 10.0, NULL, NULL
2040 {"seed", PGC_USERSET, UNGROUPED,
2041 gettext_noop("Sets the seed for random-number generation."),
2042 NULL,
2043 GUC_NO_SHOW_ALL | GUC_NO_RESET_ALL | GUC_NOT_IN_SAMPLE | GUC_DISALLOW_IN_FILE
2045 &phony_random_seed,
2046 0.0, -1.0, 1.0, assign_random_seed, show_random_seed
2050 {"autovacuum_vacuum_scale_factor", PGC_SIGHUP, AUTOVACUUM,
2051 gettext_noop("Number of tuple updates or deletes prior to vacuum as a fraction of reltuples."),
2052 NULL
2054 &autovacuum_vac_scale,
2055 0.2, 0.0, 100.0, NULL, NULL
2058 {"autovacuum_analyze_scale_factor", PGC_SIGHUP, AUTOVACUUM,
2059 gettext_noop("Number of tuple inserts, updates or deletes prior to analyze as a fraction of reltuples."),
2060 NULL
2062 &autovacuum_anl_scale,
2063 0.1, 0.0, 100.0, NULL, NULL
2067 {"checkpoint_completion_target", PGC_SIGHUP, WAL_CHECKPOINTS,
2068 gettext_noop("Time spent flushing dirty buffers during checkpoint, as fraction of checkpoint interval."),
2069 NULL
2071 &CheckPointCompletionTarget,
2072 0.5, 0.0, 1.0, NULL, NULL
2075 /* End-of-list marker */
2077 {NULL, 0, 0, NULL, NULL}, NULL, 0.0, 0.0, 0.0, NULL, NULL
2082 static struct config_string ConfigureNamesString[] =
2085 {"archive_command", PGC_SIGHUP, WAL_SETTINGS,
2086 gettext_noop("Sets the shell command that will be called to archive a WAL file."),
2087 NULL
2089 &XLogArchiveCommand,
2090 "", NULL, show_archive_command
2094 {"client_encoding", PGC_USERSET, CLIENT_CONN_LOCALE,
2095 gettext_noop("Sets the client's character set encoding."),
2096 NULL,
2097 GUC_IS_NAME | GUC_REPORT
2099 &client_encoding_string,
2100 "SQL_ASCII", assign_client_encoding, NULL
2104 {"log_line_prefix", PGC_SIGHUP, LOGGING_WHAT,
2105 gettext_noop("Controls information prefixed to each log line."),
2106 gettext_noop("If blank, no prefix is used.")
2108 &Log_line_prefix,
2109 "", NULL, NULL
2113 {"log_timezone", PGC_SIGHUP, LOGGING_WHAT,
2114 gettext_noop("Sets the time zone to use in log messages."),
2115 NULL
2117 &log_timezone_string,
2118 "UNKNOWN", assign_log_timezone, show_log_timezone
2122 {"DateStyle", PGC_USERSET, CLIENT_CONN_LOCALE,
2123 gettext_noop("Sets the display format for date and time values."),
2124 gettext_noop("Also controls interpretation of ambiguous "
2125 "date inputs."),
2126 GUC_LIST_INPUT | GUC_REPORT
2128 &datestyle_string,
2129 "ISO, MDY", assign_datestyle, NULL
2133 {"default_tablespace", PGC_USERSET, CLIENT_CONN_STATEMENT,
2134 gettext_noop("Sets the default tablespace to create tables and indexes in."),
2135 gettext_noop("An empty string selects the database's default tablespace."),
2136 GUC_IS_NAME
2138 &default_tablespace,
2139 "", assign_default_tablespace, NULL
2143 {"temp_tablespaces", PGC_USERSET, CLIENT_CONN_STATEMENT,
2144 gettext_noop("Sets the tablespace(s) to use for temporary tables and sort files."),
2145 NULL,
2146 GUC_LIST_INPUT | GUC_LIST_QUOTE
2148 &temp_tablespaces,
2149 "", assign_temp_tablespaces, NULL
2153 {"dynamic_library_path", PGC_SUSET, CLIENT_CONN_OTHER,
2154 gettext_noop("Sets the path for dynamically loadable modules."),
2155 gettext_noop("If a dynamically loadable module needs to be opened and "
2156 "the specified name does not have a directory component (i.e., the "
2157 "name does not contain a slash), the system will search this path for "
2158 "the specified file."),
2159 GUC_SUPERUSER_ONLY
2161 &Dynamic_library_path,
2162 "$libdir", NULL, NULL
2166 {"krb_server_keyfile", PGC_SIGHUP, CONN_AUTH_SECURITY,
2167 gettext_noop("Sets the location of the Kerberos server key file."),
2168 NULL,
2169 GUC_SUPERUSER_ONLY
2171 &pg_krb_server_keyfile,
2172 PG_KRB_SRVTAB, NULL, NULL
2176 {"krb_srvname", PGC_SIGHUP, CONN_AUTH_SECURITY,
2177 gettext_noop("Sets the name of the Kerberos service."),
2178 NULL
2180 &pg_krb_srvnam,
2181 PG_KRB_SRVNAM, NULL, NULL
2185 {"bonjour_name", PGC_POSTMASTER, CONN_AUTH_SETTINGS,
2186 gettext_noop("Sets the Bonjour broadcast service name."),
2187 NULL
2189 &bonjour_name,
2190 "", NULL, NULL
2193 /* See main.c about why defaults for LC_foo are not all alike */
2196 {"lc_collate", PGC_INTERNAL, CLIENT_CONN_LOCALE,
2197 gettext_noop("Shows the collation order locale."),
2198 NULL,
2199 GUC_NOT_IN_SAMPLE | GUC_DISALLOW_IN_FILE
2201 &locale_collate,
2202 "C", NULL, NULL
2206 {"lc_ctype", PGC_INTERNAL, CLIENT_CONN_LOCALE,
2207 gettext_noop("Shows the character classification and case conversion locale."),
2208 NULL,
2209 GUC_NOT_IN_SAMPLE | GUC_DISALLOW_IN_FILE
2211 &locale_ctype,
2212 "C", NULL, NULL
2216 {"lc_messages", PGC_SUSET, CLIENT_CONN_LOCALE,
2217 gettext_noop("Sets the language in which messages are displayed."),
2218 NULL
2220 &locale_messages,
2221 "", locale_messages_assign, NULL
2225 {"lc_monetary", PGC_USERSET, CLIENT_CONN_LOCALE,
2226 gettext_noop("Sets the locale for formatting monetary amounts."),
2227 NULL
2229 &locale_monetary,
2230 "C", locale_monetary_assign, NULL
2234 {"lc_numeric", PGC_USERSET, CLIENT_CONN_LOCALE,
2235 gettext_noop("Sets the locale for formatting numbers."),
2236 NULL
2238 &locale_numeric,
2239 "C", locale_numeric_assign, NULL
2243 {"lc_time", PGC_USERSET, CLIENT_CONN_LOCALE,
2244 gettext_noop("Sets the locale for formatting date and time values."),
2245 NULL
2247 &locale_time,
2248 "C", locale_time_assign, NULL
2252 {"shared_preload_libraries", PGC_POSTMASTER, RESOURCES_KERNEL,
2253 gettext_noop("Lists shared libraries to preload into server."),
2254 NULL,
2255 GUC_LIST_INPUT | GUC_LIST_QUOTE | GUC_SUPERUSER_ONLY
2257 &shared_preload_libraries_string,
2258 "", NULL, NULL
2262 {"local_preload_libraries", PGC_BACKEND, CLIENT_CONN_OTHER,
2263 gettext_noop("Lists shared libraries to preload into each backend."),
2264 NULL,
2265 GUC_LIST_INPUT | GUC_LIST_QUOTE
2267 &local_preload_libraries_string,
2268 "", NULL, NULL
2272 {"search_path", PGC_USERSET, CLIENT_CONN_STATEMENT,
2273 gettext_noop("Sets the schema search order for names that are not schema-qualified."),
2274 NULL,
2275 GUC_LIST_INPUT | GUC_LIST_QUOTE
2277 &namespace_search_path,
2278 "\"$user\",public", assign_search_path, NULL
2282 /* Can't be set in postgresql.conf */
2283 {"server_encoding", PGC_INTERNAL, CLIENT_CONN_LOCALE,
2284 gettext_noop("Sets the server (database) character set encoding."),
2285 NULL,
2286 GUC_IS_NAME | GUC_REPORT | GUC_NOT_IN_SAMPLE | GUC_DISALLOW_IN_FILE
2288 &server_encoding_string,
2289 "SQL_ASCII", NULL, NULL
2293 /* Can't be set in postgresql.conf */
2294 {"server_version", PGC_INTERNAL, PRESET_OPTIONS,
2295 gettext_noop("Shows the server version."),
2296 NULL,
2297 GUC_REPORT | GUC_NOT_IN_SAMPLE | GUC_DISALLOW_IN_FILE
2299 &server_version_string,
2300 PG_VERSION, NULL, NULL
2304 /* Not for general use --- used by SET ROLE */
2305 {"role", PGC_USERSET, UNGROUPED,
2306 gettext_noop("Sets the current role."),
2307 NULL,
2308 GUC_IS_NAME | GUC_NO_SHOW_ALL | GUC_NO_RESET_ALL | GUC_NOT_IN_SAMPLE | GUC_DISALLOW_IN_FILE
2310 &role_string,
2311 "none", assign_role, show_role
2315 /* Not for general use --- used by SET SESSION AUTHORIZATION */
2316 {"session_authorization", PGC_USERSET, UNGROUPED,
2317 gettext_noop("Sets the session user name."),
2318 NULL,
2319 GUC_IS_NAME | GUC_REPORT | GUC_NO_SHOW_ALL | GUC_NO_RESET_ALL | GUC_NOT_IN_SAMPLE | GUC_DISALLOW_IN_FILE
2321 &session_authorization_string,
2322 NULL, assign_session_authorization, show_session_authorization
2326 {"log_destination", PGC_SIGHUP, LOGGING_WHERE,
2327 gettext_noop("Sets the destination for server log output."),
2328 gettext_noop("Valid values are combinations of \"stderr\", "
2329 "\"syslog\", \"csvlog\", and \"eventlog\", "
2330 "depending on the platform."),
2331 GUC_LIST_INPUT
2333 &log_destination_string,
2334 "stderr", assign_log_destination, NULL
2337 {"log_directory", PGC_SIGHUP, LOGGING_WHERE,
2338 gettext_noop("Sets the destination directory for log files."),
2339 gettext_noop("Can be specified as relative to the data directory "
2340 "or as absolute path."),
2341 GUC_SUPERUSER_ONLY
2343 &Log_directory,
2344 "pg_log", assign_canonical_path, NULL
2347 {"log_filename", PGC_SIGHUP, LOGGING_WHERE,
2348 gettext_noop("Sets the file name pattern for log files."),
2349 NULL,
2350 GUC_SUPERUSER_ONLY
2352 &Log_filename,
2353 "postgresql-%Y-%m-%d_%H%M%S.log", NULL, NULL
2356 #ifdef HAVE_SYSLOG
2358 {"syslog_ident", PGC_SIGHUP, LOGGING_WHERE,
2359 gettext_noop("Sets the program name used to identify PostgreSQL "
2360 "messages in syslog."),
2361 NULL
2363 &syslog_ident_str,
2364 "postgres", assign_syslog_ident, NULL
2366 #endif
2369 {"TimeZone", PGC_USERSET, CLIENT_CONN_LOCALE,
2370 gettext_noop("Sets the time zone for displaying and interpreting time stamps."),
2371 NULL,
2372 GUC_REPORT
2374 &timezone_string,
2375 "UNKNOWN", assign_timezone, show_timezone
2378 {"timezone_abbreviations", PGC_USERSET, CLIENT_CONN_LOCALE,
2379 gettext_noop("Selects a file of time zone abbreviations."),
2380 NULL
2382 &timezone_abbreviations_string,
2383 "UNKNOWN", assign_timezone_abbreviations, NULL
2387 {"transaction_isolation", PGC_USERSET, CLIENT_CONN_STATEMENT,
2388 gettext_noop("Sets the current transaction's isolation level."),
2389 NULL,
2390 GUC_NO_RESET_ALL | GUC_NOT_IN_SAMPLE | GUC_DISALLOW_IN_FILE
2392 &XactIsoLevel_string,
2393 NULL, assign_XactIsoLevel, show_XactIsoLevel
2397 {"unix_socket_group", PGC_POSTMASTER, CONN_AUTH_SETTINGS,
2398 gettext_noop("Sets the owning group of the Unix-domain socket."),
2399 gettext_noop("The owning user of the socket is always the user "
2400 "that starts the server.")
2402 &Unix_socket_group,
2403 "", NULL, NULL
2407 {"unix_socket_directory", PGC_POSTMASTER, CONN_AUTH_SETTINGS,
2408 gettext_noop("Sets the directory where the Unix-domain socket will be created."),
2409 NULL,
2410 GUC_SUPERUSER_ONLY
2412 &UnixSocketDir,
2413 "", assign_canonical_path, NULL
2417 {"listen_addresses", PGC_POSTMASTER, CONN_AUTH_SETTINGS,
2418 gettext_noop("Sets the host name or IP address(es) to listen to."),
2419 NULL,
2420 GUC_LIST_INPUT
2422 &ListenAddresses,
2423 "localhost", NULL, NULL
2427 {"custom_variable_classes", PGC_SIGHUP, CUSTOM_OPTIONS,
2428 gettext_noop("Sets the list of known custom variable classes."),
2429 NULL,
2430 GUC_LIST_INPUT | GUC_LIST_QUOTE
2432 &custom_variable_classes,
2433 NULL, assign_custom_variable_classes, NULL
2437 {"data_directory", PGC_POSTMASTER, FILE_LOCATIONS,
2438 gettext_noop("Sets the server's data directory."),
2439 NULL,
2440 GUC_SUPERUSER_ONLY
2442 &data_directory,
2443 NULL, NULL, NULL
2447 {"config_file", PGC_POSTMASTER, FILE_LOCATIONS,
2448 gettext_noop("Sets the server's main configuration file."),
2449 NULL,
2450 GUC_DISALLOW_IN_FILE | GUC_SUPERUSER_ONLY
2452 &ConfigFileName,
2453 NULL, NULL, NULL
2457 {"hba_file", PGC_POSTMASTER, FILE_LOCATIONS,
2458 gettext_noop("Sets the server's \"hba\" configuration file."),
2459 NULL,
2460 GUC_SUPERUSER_ONLY
2462 &HbaFileName,
2463 NULL, NULL, NULL
2467 {"ident_file", PGC_POSTMASTER, FILE_LOCATIONS,
2468 gettext_noop("Sets the server's \"ident\" configuration file."),
2469 NULL,
2470 GUC_SUPERUSER_ONLY
2472 &IdentFileName,
2473 NULL, NULL, NULL
2477 {"external_pid_file", PGC_POSTMASTER, FILE_LOCATIONS,
2478 gettext_noop("Writes the postmaster PID to the specified file."),
2479 NULL,
2480 GUC_SUPERUSER_ONLY
2482 &external_pid_file,
2483 NULL, assign_canonical_path, NULL
2487 {"stats_temp_directory", PGC_SIGHUP, STATS_COLLECTOR,
2488 gettext_noop("Writes temporary statistics files to the specified directory."),
2489 NULL,
2490 GUC_SUPERUSER_ONLY
2492 &pgstat_temp_directory,
2493 "pg_stat_tmp", assign_pgstat_temp_directory, NULL
2497 {"default_text_search_config", PGC_USERSET, CLIENT_CONN_LOCALE,
2498 gettext_noop("Sets default text search configuration."),
2499 NULL
2501 &TSCurrentConfig,
2502 "pg_catalog.simple", assignTSCurrentConfig, NULL
2505 #ifdef USE_SSL
2507 {"ssl_ciphers", PGC_POSTMASTER, CONN_AUTH_SECURITY,
2508 gettext_noop("Sets the list of allowed SSL ciphers."),
2509 NULL,
2510 GUC_SUPERUSER_ONLY
2512 &SSLCipherSuites,
2513 "ALL:!ADH:!LOW:!EXP:!MD5:@STRENGTH", NULL, NULL
2515 #endif /* USE_SSL */
2517 /* End-of-list marker */
2519 {NULL, 0, 0, NULL, NULL}, NULL, NULL, NULL, NULL
2524 static struct config_enum ConfigureNamesEnum[] =
2527 {"backslash_quote", PGC_USERSET, COMPAT_OPTIONS_PREVIOUS,
2528 gettext_noop("Sets whether \"\\'\" is allowed in string literals."),
2529 NULL
2531 &backslash_quote,
2532 BACKSLASH_QUOTE_SAFE_ENCODING, backslash_quote_options, NULL, NULL
2536 {"client_min_messages", PGC_USERSET, LOGGING_WHEN,
2537 gettext_noop("Sets the message levels that are sent to the client."),
2538 gettext_noop("Each level includes all the levels that follow it. The later"
2539 " the level, the fewer messages are sent.")
2541 &client_min_messages,
2542 NOTICE, client_message_level_options, NULL, NULL
2546 {"constraint_exclusion", PGC_USERSET, QUERY_TUNING_OTHER,
2547 gettext_noop("Enables the planner to use constraints to optimize queries."),
2548 gettext_noop("Table scans will be skipped if their constraints"
2549 " guarantee that no rows match the query.")
2551 &constraint_exclusion,
2552 CONSTRAINT_EXCLUSION_PARTITION, constraint_exclusion_options,
2553 NULL, NULL
2557 {"default_transaction_isolation", PGC_USERSET, CLIENT_CONN_STATEMENT,
2558 gettext_noop("Sets the transaction isolation level of each new transaction."),
2559 NULL
2561 &DefaultXactIsoLevel,
2562 XACT_READ_COMMITTED, isolation_level_options, NULL, NULL
2566 {"IntervalStyle", PGC_USERSET, CLIENT_CONN_LOCALE,
2567 gettext_noop("Sets the display format for interval values."),
2568 NULL,
2569 GUC_REPORT
2571 &IntervalStyle,
2572 INTSTYLE_POSTGRES, intervalstyle_options, NULL, NULL
2576 {"log_error_verbosity", PGC_SUSET, LOGGING_WHEN,
2577 gettext_noop("Sets the verbosity of logged messages."),
2578 NULL
2580 &Log_error_verbosity,
2581 PGERROR_DEFAULT, log_error_verbosity_options, NULL, NULL
2585 {"log_min_messages", PGC_SUSET, LOGGING_WHEN,
2586 gettext_noop("Sets the message levels that are logged."),
2587 gettext_noop("Each level includes all the levels that follow it. The later"
2588 " the level, the fewer messages are sent.")
2590 &log_min_messages,
2591 WARNING, server_message_level_options, NULL, NULL
2595 {"log_min_error_statement", PGC_SUSET, LOGGING_WHEN,
2596 gettext_noop("Causes all statements generating error at or above this level to be logged."),
2597 gettext_noop("Each level includes all the levels that follow it. The later"
2598 " the level, the fewer messages are sent.")
2600 &log_min_error_statement,
2601 ERROR, server_message_level_options, NULL, NULL
2605 {"log_statement", PGC_SUSET, LOGGING_WHAT,
2606 gettext_noop("Sets the type of statements logged."),
2607 NULL
2609 &log_statement,
2610 LOGSTMT_NONE, log_statement_options, NULL, NULL
2613 #ifdef HAVE_SYSLOG
2615 {"syslog_facility", PGC_SIGHUP, LOGGING_WHERE,
2616 gettext_noop("Sets the syslog \"facility\" to be used when syslog enabled."),
2617 NULL
2619 &syslog_facility,
2620 LOG_LOCAL0, syslog_facility_options, assign_syslog_facility, NULL
2622 #endif
2625 {"regex_flavor", PGC_USERSET, COMPAT_OPTIONS_PREVIOUS,
2626 gettext_noop("Sets the regular expression \"flavor\"."),
2627 NULL
2629 &regex_flavor,
2630 REG_ADVANCED, regex_flavor_options, NULL, NULL
2634 {"session_replication_role", PGC_SUSET, CLIENT_CONN_STATEMENT,
2635 gettext_noop("Sets the session's behavior for triggers and rewrite rules."),
2636 NULL
2638 &SessionReplicationRole,
2639 SESSION_REPLICATION_ROLE_ORIGIN, session_replication_role_options,
2640 assign_session_replication_role, NULL
2644 {"track_functions", PGC_SUSET, STATS_COLLECTOR,
2645 gettext_noop("Collects function-level statistics on database activity."),
2646 NULL
2648 &pgstat_track_functions,
2649 TRACK_FUNC_OFF, track_function_options, NULL, NULL
2653 {"wal_sync_method", PGC_SIGHUP, WAL_SETTINGS,
2654 gettext_noop("Selects the method used for forcing WAL updates to disk."),
2655 NULL
2657 &sync_method,
2658 DEFAULT_SYNC_METHOD, sync_method_options,
2659 assign_xlog_sync_method, NULL
2663 {"xmlbinary", PGC_USERSET, CLIENT_CONN_STATEMENT,
2664 gettext_noop("Sets how binary values are to be encoded in XML."),
2665 NULL
2667 &xmlbinary,
2668 XMLBINARY_BASE64, xmlbinary_options, NULL, NULL
2672 {"xmloption", PGC_USERSET, CLIENT_CONN_STATEMENT,
2673 gettext_noop("Sets whether XML data in implicit parsing and serialization "
2674 "operations is to be considered as documents or content fragments."),
2675 NULL
2677 &xmloption,
2678 XMLOPTION_CONTENT, xmloption_options, NULL, NULL
2682 /* End-of-list marker */
2684 {NULL, 0, 0, NULL, NULL}, NULL, 0, NULL, NULL, NULL
2688 /******** end of options list ********/
2692 * To allow continued support of obsolete names for GUC variables, we apply
2693 * the following mappings to any unrecognized name. Note that an old name
2694 * should be mapped to a new one only if the new variable has very similar
2695 * semantics to the old.
2697 static const char *const map_old_guc_names[] = {
2698 "sort_mem", "work_mem",
2699 "vacuum_mem", "maintenance_work_mem",
2700 NULL
2705 * Actual lookup of variables is done through this single, sorted array.
2707 static struct config_generic **guc_variables;
2709 /* Current number of variables contained in the vector */
2710 static int num_guc_variables;
2712 /* Vector capacity */
2713 static int size_guc_variables;
2716 static bool guc_dirty; /* TRUE if need to do commit/abort work */
2718 static bool reporting_enabled; /* TRUE to enable GUC_REPORT */
2720 static int GUCNestLevel = 0; /* 1 when in main transaction */
2723 static int guc_var_compare(const void *a, const void *b);
2724 static int guc_name_compare(const char *namea, const char *nameb);
2725 static void InitializeOneGUCOption(struct config_generic * gconf);
2726 static void push_old_value(struct config_generic * gconf, GucAction action);
2727 static void ReportGUCOption(struct config_generic * record);
2728 static void ShowGUCConfigOption(const char *name, DestReceiver *dest);
2729 static void ShowAllGUCConfig(DestReceiver *dest);
2730 static char *_ShowOption(struct config_generic * record, bool use_units);
2731 static bool is_newvalue_equal(struct config_generic * record, const char *newvalue);
2735 * Some infrastructure for checking malloc/strdup/realloc calls
2737 static void *
2738 guc_malloc(int elevel, size_t size)
2740 void *data;
2742 data = malloc(size);
2743 if (data == NULL)
2744 ereport(elevel,
2745 (errcode(ERRCODE_OUT_OF_MEMORY),
2746 errmsg("out of memory")));
2747 return data;
2750 static void *
2751 guc_realloc(int elevel, void *old, size_t size)
2753 void *data;
2755 data = realloc(old, size);
2756 if (data == NULL)
2757 ereport(elevel,
2758 (errcode(ERRCODE_OUT_OF_MEMORY),
2759 errmsg("out of memory")));
2760 return data;
2763 static char *
2764 guc_strdup(int elevel, const char *src)
2766 char *data;
2768 data = strdup(src);
2769 if (data == NULL)
2770 ereport(elevel,
2771 (errcode(ERRCODE_OUT_OF_MEMORY),
2772 errmsg("out of memory")));
2773 return data;
2778 * Support for assigning to a field of a string GUC item. Free the prior
2779 * value if it's not referenced anywhere else in the item (including stacked
2780 * states).
2782 static void
2783 set_string_field(struct config_string * conf, char **field, char *newval)
2785 char *oldval = *field;
2786 GucStack *stack;
2788 /* Do the assignment */
2789 *field = newval;
2791 /* Exit if any duplicate references, or if old value was NULL anyway */
2792 if (oldval == NULL ||
2793 oldval == *(conf->variable) ||
2794 oldval == conf->reset_val ||
2795 oldval == conf->boot_val)
2796 return;
2797 for (stack = conf->gen.stack; stack; stack = stack->prev)
2799 if (oldval == stack->prior.stringval ||
2800 oldval == stack->masked.stringval)
2801 return;
2804 /* Not used anymore, so free it */
2805 free(oldval);
2809 * Detect whether strval is referenced anywhere in a GUC string item
2811 static bool
2812 string_field_used(struct config_string * conf, char *strval)
2814 GucStack *stack;
2816 if (strval == *(conf->variable) ||
2817 strval == conf->reset_val ||
2818 strval == conf->boot_val)
2819 return true;
2820 for (stack = conf->gen.stack; stack; stack = stack->prev)
2822 if (strval == stack->prior.stringval ||
2823 strval == stack->masked.stringval)
2824 return true;
2826 return false;
2830 * Support for copying a variable's active value into a stack entry
2832 static void
2833 set_stack_value(struct config_generic * gconf, union config_var_value * val)
2835 switch (gconf->vartype)
2837 case PGC_BOOL:
2838 val->boolval =
2839 *((struct config_bool *) gconf)->variable;
2840 break;
2841 case PGC_INT:
2842 val->intval =
2843 *((struct config_int *) gconf)->variable;
2844 break;
2845 case PGC_REAL:
2846 val->realval =
2847 *((struct config_real *) gconf)->variable;
2848 break;
2849 case PGC_STRING:
2850 /* we assume stringval is NULL if not valid */
2851 set_string_field((struct config_string *) gconf,
2852 &(val->stringval),
2853 *((struct config_string *) gconf)->variable);
2854 break;
2855 case PGC_ENUM:
2856 val->enumval =
2857 *((struct config_enum *) gconf)->variable;
2858 break;
2863 * Support for discarding a no-longer-needed value in a stack entry
2865 static void
2866 discard_stack_value(struct config_generic * gconf, union config_var_value * val)
2868 switch (gconf->vartype)
2870 case PGC_BOOL:
2871 case PGC_INT:
2872 case PGC_REAL:
2873 case PGC_ENUM:
2874 /* no need to do anything */
2875 break;
2876 case PGC_STRING:
2877 set_string_field((struct config_string *) gconf,
2878 &(val->stringval),
2879 NULL);
2880 break;
2886 * Fetch the sorted array pointer (exported for help_config.c's use ONLY)
2888 struct config_generic **
2889 get_guc_variables(void)
2891 return guc_variables;
2896 * Build the sorted array. This is split out so that it could be
2897 * re-executed after startup (eg, we could allow loadable modules to
2898 * add vars, and then we'd need to re-sort).
2900 void
2901 build_guc_variables(void)
2903 int size_vars;
2904 int num_vars = 0;
2905 struct config_generic **guc_vars;
2906 int i;
2908 for (i = 0; ConfigureNamesBool[i].gen.name; i++)
2910 struct config_bool *conf = &ConfigureNamesBool[i];
2912 /* Rather than requiring vartype to be filled in by hand, do this: */
2913 conf->gen.vartype = PGC_BOOL;
2914 num_vars++;
2917 for (i = 0; ConfigureNamesInt[i].gen.name; i++)
2919 struct config_int *conf = &ConfigureNamesInt[i];
2921 conf->gen.vartype = PGC_INT;
2922 num_vars++;
2925 for (i = 0; ConfigureNamesReal[i].gen.name; i++)
2927 struct config_real *conf = &ConfigureNamesReal[i];
2929 conf->gen.vartype = PGC_REAL;
2930 num_vars++;
2933 for (i = 0; ConfigureNamesString[i].gen.name; i++)
2935 struct config_string *conf = &ConfigureNamesString[i];
2937 conf->gen.vartype = PGC_STRING;
2938 num_vars++;
2941 for (i = 0; ConfigureNamesEnum[i].gen.name; i++)
2943 struct config_enum *conf = &ConfigureNamesEnum[i];
2945 conf->gen.vartype = PGC_ENUM;
2946 num_vars++;
2950 * Create table with 20% slack
2952 size_vars = num_vars + num_vars / 4;
2954 guc_vars = (struct config_generic **)
2955 guc_malloc(FATAL, size_vars * sizeof(struct config_generic *));
2957 num_vars = 0;
2959 for (i = 0; ConfigureNamesBool[i].gen.name; i++)
2960 guc_vars[num_vars++] = &ConfigureNamesBool[i].gen;
2962 for (i = 0; ConfigureNamesInt[i].gen.name; i++)
2963 guc_vars[num_vars++] = &ConfigureNamesInt[i].gen;
2965 for (i = 0; ConfigureNamesReal[i].gen.name; i++)
2966 guc_vars[num_vars++] = &ConfigureNamesReal[i].gen;
2968 for (i = 0; ConfigureNamesString[i].gen.name; i++)
2969 guc_vars[num_vars++] = &ConfigureNamesString[i].gen;
2971 for (i = 0; ConfigureNamesEnum[i].gen.name; i++)
2972 guc_vars[num_vars++] = &ConfigureNamesEnum[i].gen;
2974 if (guc_variables)
2975 free(guc_variables);
2976 guc_variables = guc_vars;
2977 num_guc_variables = num_vars;
2978 size_guc_variables = size_vars;
2979 qsort((void *) guc_variables, num_guc_variables,
2980 sizeof(struct config_generic *), guc_var_compare);
2984 * Add a new GUC variable to the list of known variables. The
2985 * list is expanded if needed.
2987 static bool
2988 add_guc_variable(struct config_generic * var, int elevel)
2990 if (num_guc_variables + 1 >= size_guc_variables)
2993 * Increase the vector by 25%
2995 int size_vars = size_guc_variables + size_guc_variables / 4;
2996 struct config_generic **guc_vars;
2998 if (size_vars == 0)
3000 size_vars = 100;
3001 guc_vars = (struct config_generic **)
3002 guc_malloc(elevel, size_vars * sizeof(struct config_generic *));
3004 else
3006 guc_vars = (struct config_generic **)
3007 guc_realloc(elevel, guc_variables, size_vars * sizeof(struct config_generic *));
3010 if (guc_vars == NULL)
3011 return false; /* out of memory */
3013 guc_variables = guc_vars;
3014 size_guc_variables = size_vars;
3016 guc_variables[num_guc_variables++] = var;
3017 qsort((void *) guc_variables, num_guc_variables,
3018 sizeof(struct config_generic *), guc_var_compare);
3019 return true;
3023 * Create and add a placeholder variable. It's presumed to belong
3024 * to a valid custom variable class at this point.
3026 static struct config_generic *
3027 add_placeholder_variable(const char *name, int elevel)
3029 size_t sz = sizeof(struct config_string) + sizeof(char *);
3030 struct config_string *var;
3031 struct config_generic *gen;
3033 var = (struct config_string *) guc_malloc(elevel, sz);
3034 if (var == NULL)
3035 return NULL;
3036 memset(var, 0, sz);
3037 gen = &var->gen;
3039 gen->name = guc_strdup(elevel, name);
3040 if (gen->name == NULL)
3042 free(var);
3043 return NULL;
3046 gen->context = PGC_USERSET;
3047 gen->group = CUSTOM_OPTIONS;
3048 gen->short_desc = "GUC placeholder variable";
3049 gen->flags = GUC_NO_SHOW_ALL | GUC_NOT_IN_SAMPLE | GUC_CUSTOM_PLACEHOLDER;
3050 gen->vartype = PGC_STRING;
3053 * The char* is allocated at the end of the struct since we have no
3054 * 'static' place to point to. Note that the current value, as well as
3055 * the boot and reset values, start out NULL.
3057 var->variable = (char **) (var + 1);
3059 if (!add_guc_variable((struct config_generic *) var, elevel))
3061 free((void *) gen->name);
3062 free(var);
3063 return NULL;
3066 return gen;
3070 * Detect whether the portion of "name" before dotPos matches any custom
3071 * variable class name listed in custom_var_classes. The latter must be
3072 * formatted the way that assign_custom_variable_classes does it, ie,
3073 * no whitespace. NULL is valid for custom_var_classes.
3075 static bool
3076 is_custom_class(const char *name, int dotPos, const char *custom_var_classes)
3078 bool result = false;
3079 const char *ccs = custom_var_classes;
3081 if (ccs != NULL)
3083 const char *start = ccs;
3085 for (;; ++ccs)
3087 char c = *ccs;
3089 if (c == '\0' || c == ',')
3091 if (dotPos == ccs - start && strncmp(start, name, dotPos) == 0)
3093 result = true;
3094 break;
3096 if (c == '\0')
3097 break;
3098 start = ccs + 1;
3102 return result;
3106 * Look up option NAME. If it exists, return a pointer to its record,
3107 * else return NULL. If create_placeholders is TRUE, we'll create a
3108 * placeholder record for a valid-looking custom variable name.
3110 static struct config_generic *
3111 find_option(const char *name, bool create_placeholders, int elevel)
3113 const char **key = &name;
3114 struct config_generic **res;
3115 int i;
3117 Assert(name);
3120 * By equating const char ** with struct config_generic *, we are assuming
3121 * the name field is first in config_generic.
3123 res = (struct config_generic **) bsearch((void *) &key,
3124 (void *) guc_variables,
3125 num_guc_variables,
3126 sizeof(struct config_generic *),
3127 guc_var_compare);
3128 if (res)
3129 return *res;
3132 * See if the name is an obsolete name for a variable. We assume that the
3133 * set of supported old names is short enough that a brute-force search is
3134 * the best way.
3136 for (i = 0; map_old_guc_names[i] != NULL; i += 2)
3138 if (guc_name_compare(name, map_old_guc_names[i]) == 0)
3139 return find_option(map_old_guc_names[i + 1], false, elevel);
3142 if (create_placeholders)
3145 * Check if the name is qualified, and if so, check if the qualifier
3146 * matches any custom variable class. If so, add a placeholder.
3148 const char *dot = strchr(name, GUC_QUALIFIER_SEPARATOR);
3150 if (dot != NULL &&
3151 is_custom_class(name, dot - name, custom_variable_classes))
3152 return add_placeholder_variable(name, elevel);
3155 /* Unknown name */
3156 return NULL;
3161 * comparator for qsorting and bsearching guc_variables array
3163 static int
3164 guc_var_compare(const void *a, const void *b)
3166 struct config_generic *confa = *(struct config_generic **) a;
3167 struct config_generic *confb = *(struct config_generic **) b;
3169 return guc_name_compare(confa->name, confb->name);
3173 * the bare comparison function for GUC names
3175 static int
3176 guc_name_compare(const char *namea, const char *nameb)
3179 * The temptation to use strcasecmp() here must be resisted, because the
3180 * array ordering has to remain stable across setlocale() calls. So, build
3181 * our own with a simple ASCII-only downcasing.
3183 while (*namea && *nameb)
3185 char cha = *namea++;
3186 char chb = *nameb++;
3188 if (cha >= 'A' && cha <= 'Z')
3189 cha += 'a' - 'A';
3190 if (chb >= 'A' && chb <= 'Z')
3191 chb += 'a' - 'A';
3192 if (cha != chb)
3193 return cha - chb;
3195 if (*namea)
3196 return 1; /* a is longer */
3197 if (*nameb)
3198 return -1; /* b is longer */
3199 return 0;
3204 * Initialize GUC options during program startup.
3206 * Note that we cannot read the config file yet, since we have not yet
3207 * processed command-line switches.
3209 void
3210 InitializeGUCOptions(void)
3212 int i;
3213 char *env;
3214 long stack_rlimit;
3217 * Before log_line_prefix could possibly receive a nonempty setting, make
3218 * sure that timezone processing is minimally alive (see elog.c).
3220 pg_timezone_pre_initialize();
3223 * Build sorted array of all GUC variables.
3225 build_guc_variables();
3228 * Load all variables with their compiled-in defaults, and initialize
3229 * status fields as needed.
3231 for (i = 0; i < num_guc_variables; i++)
3233 InitializeOneGUCOption(guc_variables[i]);
3236 guc_dirty = false;
3238 reporting_enabled = false;
3241 * Prevent any attempt to override the transaction modes from
3242 * non-interactive sources.
3244 SetConfigOption("transaction_isolation", "default",
3245 PGC_POSTMASTER, PGC_S_OVERRIDE);
3246 SetConfigOption("transaction_read_only", "no",
3247 PGC_POSTMASTER, PGC_S_OVERRIDE);
3250 * For historical reasons, some GUC parameters can receive defaults from
3251 * environment variables. Process those settings. NB: if you add or
3252 * remove anything here, see also ProcessConfigFile().
3255 env = getenv("PGPORT");
3256 if (env != NULL)
3257 SetConfigOption("port", env, PGC_POSTMASTER, PGC_S_ENV_VAR);
3259 env = getenv("PGDATESTYLE");
3260 if (env != NULL)
3261 SetConfigOption("datestyle", env, PGC_POSTMASTER, PGC_S_ENV_VAR);
3263 env = getenv("PGCLIENTENCODING");
3264 if (env != NULL)
3265 SetConfigOption("client_encoding", env, PGC_POSTMASTER, PGC_S_ENV_VAR);
3268 * rlimit isn't exactly an "environment variable", but it behaves about
3269 * the same. If we can identify the platform stack depth rlimit, increase
3270 * default stack depth setting up to whatever is safe (but at most 2MB).
3272 stack_rlimit = get_stack_depth_rlimit();
3273 if (stack_rlimit > 0)
3275 int new_limit = (stack_rlimit - STACK_DEPTH_SLOP) / 1024L;
3277 if (new_limit > 100)
3279 char limbuf[16];
3281 new_limit = Min(new_limit, 2048);
3282 sprintf(limbuf, "%d", new_limit);
3283 SetConfigOption("max_stack_depth", limbuf,
3284 PGC_POSTMASTER, PGC_S_ENV_VAR);
3290 * Initialize one GUC option variable to its compiled-in default.
3292 static void
3293 InitializeOneGUCOption(struct config_generic * gconf)
3295 gconf->status = 0;
3296 gconf->reset_source = PGC_S_DEFAULT;
3297 gconf->source = PGC_S_DEFAULT;
3298 gconf->stack = NULL;
3299 gconf->sourcefile = NULL;
3300 gconf->sourceline = 0;
3302 switch (gconf->vartype)
3304 case PGC_BOOL:
3306 struct config_bool *conf = (struct config_bool *) gconf;
3308 if (conf->assign_hook)
3309 if (!(*conf->assign_hook) (conf->boot_val, true,
3310 PGC_S_DEFAULT))
3311 elog(FATAL, "failed to initialize %s to %d",
3312 conf->gen.name, (int) conf->boot_val);
3313 *conf->variable = conf->reset_val = conf->boot_val;
3314 break;
3316 case PGC_INT:
3318 struct config_int *conf = (struct config_int *) gconf;
3320 Assert(conf->boot_val >= conf->min);
3321 Assert(conf->boot_val <= conf->max);
3322 if (conf->assign_hook)
3323 if (!(*conf->assign_hook) (conf->boot_val, true,
3324 PGC_S_DEFAULT))
3325 elog(FATAL, "failed to initialize %s to %d",
3326 conf->gen.name, conf->boot_val);
3327 *conf->variable = conf->reset_val = conf->boot_val;
3328 break;
3330 case PGC_REAL:
3332 struct config_real *conf = (struct config_real *) gconf;
3334 Assert(conf->boot_val >= conf->min);
3335 Assert(conf->boot_val <= conf->max);
3336 if (conf->assign_hook)
3337 if (!(*conf->assign_hook) (conf->boot_val, true,
3338 PGC_S_DEFAULT))
3339 elog(FATAL, "failed to initialize %s to %g",
3340 conf->gen.name, conf->boot_val);
3341 *conf->variable = conf->reset_val = conf->boot_val;
3342 break;
3344 case PGC_STRING:
3346 struct config_string *conf = (struct config_string *) gconf;
3347 char *str;
3349 *conf->variable = NULL;
3350 conf->reset_val = NULL;
3352 if (conf->boot_val == NULL)
3354 /* leave the value NULL, do not call assign hook */
3355 break;
3358 str = guc_strdup(FATAL, conf->boot_val);
3359 conf->reset_val = str;
3361 if (conf->assign_hook)
3363 const char *newstr;
3365 newstr = (*conf->assign_hook) (str, true,
3366 PGC_S_DEFAULT);
3367 if (newstr == NULL)
3369 elog(FATAL, "failed to initialize %s to \"%s\"",
3370 conf->gen.name, str);
3372 else if (newstr != str)
3374 free(str);
3377 * See notes in set_config_option about casting
3379 str = (char *) newstr;
3380 conf->reset_val = str;
3383 *conf->variable = str;
3384 break;
3386 case PGC_ENUM:
3388 struct config_enum *conf = (struct config_enum *) gconf;
3390 if (conf->assign_hook)
3391 if (!(*conf->assign_hook) (conf->boot_val, true,
3392 PGC_S_DEFAULT))
3393 elog(FATAL, "failed to initialize %s to %s",
3394 conf->gen.name,
3395 config_enum_lookup_by_value(conf, conf->boot_val));
3396 *conf->variable = conf->reset_val = conf->boot_val;
3397 break;
3404 * Select the configuration files and data directory to be used, and
3405 * do the initial read of postgresql.conf.
3407 * This is called after processing command-line switches.
3408 * userDoption is the -D switch value if any (NULL if unspecified).
3409 * progname is just for use in error messages.
3411 * Returns true on success; on failure, prints a suitable error message
3412 * to stderr and returns false.
3414 bool
3415 SelectConfigFiles(const char *userDoption, const char *progname)
3417 char *configdir;
3418 char *fname;
3419 struct stat stat_buf;
3421 /* configdir is -D option, or $PGDATA if no -D */
3422 if (userDoption)
3423 configdir = make_absolute_path(userDoption);
3424 else
3425 configdir = make_absolute_path(getenv("PGDATA"));
3428 * Find the configuration file: if config_file was specified on the
3429 * command line, use it, else use configdir/postgresql.conf. In any case
3430 * ensure the result is an absolute path, so that it will be interpreted
3431 * the same way by future backends.
3433 if (ConfigFileName)
3434 fname = make_absolute_path(ConfigFileName);
3435 else if (configdir)
3437 fname = guc_malloc(FATAL,
3438 strlen(configdir) + strlen(CONFIG_FILENAME) + 2);
3439 sprintf(fname, "%s/%s", configdir, CONFIG_FILENAME);
3441 else
3443 write_stderr("%s does not know where to find the server configuration file.\n"
3444 "You must specify the --config-file or -D invocation "
3445 "option or set the PGDATA environment variable.\n",
3446 progname);
3447 return false;
3451 * Set the ConfigFileName GUC variable to its final value, ensuring that
3452 * it can't be overridden later.
3454 SetConfigOption("config_file", fname, PGC_POSTMASTER, PGC_S_OVERRIDE);
3455 free(fname);
3458 * Now read the config file for the first time.
3460 if (stat(ConfigFileName, &stat_buf) != 0)
3462 write_stderr("%s cannot access the server configuration file \"%s\": %s\n",
3463 progname, ConfigFileName, strerror(errno));
3464 return false;
3467 ProcessConfigFile(PGC_POSTMASTER);
3470 * If the data_directory GUC variable has been set, use that as DataDir;
3471 * otherwise use configdir if set; else punt.
3473 * Note: SetDataDir will copy and absolute-ize its argument, so we don't
3474 * have to.
3476 if (data_directory)
3477 SetDataDir(data_directory);
3478 else if (configdir)
3479 SetDataDir(configdir);
3480 else
3482 write_stderr("%s does not know where to find the database system data.\n"
3483 "This can be specified as \"data_directory\" in \"%s\", "
3484 "or by the -D invocation option, or by the "
3485 "PGDATA environment variable.\n",
3486 progname, ConfigFileName);
3487 return false;
3491 * Reflect the final DataDir value back into the data_directory GUC var.
3492 * (If you are wondering why we don't just make them a single variable,
3493 * it's because the EXEC_BACKEND case needs DataDir to be transmitted to
3494 * child backends specially. XXX is that still true? Given that we now
3495 * chdir to DataDir, EXEC_BACKEND can read the config file without knowing
3496 * DataDir in advance.)
3498 SetConfigOption("data_directory", DataDir, PGC_POSTMASTER, PGC_S_OVERRIDE);
3501 * Figure out where pg_hba.conf is, and make sure the path is absolute.
3503 if (HbaFileName)
3504 fname = make_absolute_path(HbaFileName);
3505 else if (configdir)
3507 fname = guc_malloc(FATAL,
3508 strlen(configdir) + strlen(HBA_FILENAME) + 2);
3509 sprintf(fname, "%s/%s", configdir, HBA_FILENAME);
3511 else
3513 write_stderr("%s does not know where to find the \"hba\" configuration file.\n"
3514 "This can be specified as \"hba_file\" in \"%s\", "
3515 "or by the -D invocation option, or by the "
3516 "PGDATA environment variable.\n",
3517 progname, ConfigFileName);
3518 return false;
3520 SetConfigOption("hba_file", fname, PGC_POSTMASTER, PGC_S_OVERRIDE);
3521 free(fname);
3524 * Likewise for pg_ident.conf.
3526 if (IdentFileName)
3527 fname = make_absolute_path(IdentFileName);
3528 else if (configdir)
3530 fname = guc_malloc(FATAL,
3531 strlen(configdir) + strlen(IDENT_FILENAME) + 2);
3532 sprintf(fname, "%s/%s", configdir, IDENT_FILENAME);
3534 else
3536 write_stderr("%s does not know where to find the \"ident\" configuration file.\n"
3537 "This can be specified as \"ident_file\" in \"%s\", "
3538 "or by the -D invocation option, or by the "
3539 "PGDATA environment variable.\n",
3540 progname, ConfigFileName);
3541 return false;
3543 SetConfigOption("ident_file", fname, PGC_POSTMASTER, PGC_S_OVERRIDE);
3544 free(fname);
3546 free(configdir);
3548 return true;
3553 * Reset all options to their saved default values (implements RESET ALL)
3555 void
3556 ResetAllOptions(void)
3558 int i;
3560 for (i = 0; i < num_guc_variables; i++)
3562 struct config_generic *gconf = guc_variables[i];
3564 /* Don't reset non-SET-able values */
3565 if (gconf->context != PGC_SUSET &&
3566 gconf->context != PGC_USERSET)
3567 continue;
3568 /* Don't reset if special exclusion from RESET ALL */
3569 if (gconf->flags & GUC_NO_RESET_ALL)
3570 continue;
3571 /* No need to reset if wasn't SET */
3572 if (gconf->source <= PGC_S_OVERRIDE)
3573 continue;
3575 /* Save old value to support transaction abort */
3576 push_old_value(gconf, GUC_ACTION_SET);
3578 switch (gconf->vartype)
3580 case PGC_BOOL:
3582 struct config_bool *conf = (struct config_bool *) gconf;
3584 if (conf->assign_hook)
3585 if (!(*conf->assign_hook) (conf->reset_val, true,
3586 PGC_S_SESSION))
3587 elog(ERROR, "failed to reset %s to %d",
3588 conf->gen.name, (int) conf->reset_val);
3589 *conf->variable = conf->reset_val;
3590 break;
3592 case PGC_INT:
3594 struct config_int *conf = (struct config_int *) gconf;
3596 if (conf->assign_hook)
3597 if (!(*conf->assign_hook) (conf->reset_val, true,
3598 PGC_S_SESSION))
3599 elog(ERROR, "failed to reset %s to %d",
3600 conf->gen.name, conf->reset_val);
3601 *conf->variable = conf->reset_val;
3602 break;
3604 case PGC_REAL:
3606 struct config_real *conf = (struct config_real *) gconf;
3608 if (conf->assign_hook)
3609 if (!(*conf->assign_hook) (conf->reset_val, true,
3610 PGC_S_SESSION))
3611 elog(ERROR, "failed to reset %s to %g",
3612 conf->gen.name, conf->reset_val);
3613 *conf->variable = conf->reset_val;
3614 break;
3616 case PGC_STRING:
3618 struct config_string *conf = (struct config_string *) gconf;
3619 char *str;
3621 /* We need not strdup here */
3622 str = conf->reset_val;
3624 if (conf->assign_hook && str)
3626 const char *newstr;
3628 newstr = (*conf->assign_hook) (str, true,
3629 PGC_S_SESSION);
3630 if (newstr == NULL)
3631 elog(ERROR, "failed to reset %s to \"%s\"",
3632 conf->gen.name, str);
3633 else if (newstr != str)
3636 * See notes in set_config_option about casting
3638 str = (char *) newstr;
3642 set_string_field(conf, conf->variable, str);
3643 break;
3645 case PGC_ENUM:
3647 struct config_enum *conf = (struct config_enum *) gconf;
3649 if (conf->assign_hook)
3650 if (!(*conf->assign_hook) (conf->reset_val, true,
3651 PGC_S_SESSION))
3652 elog(ERROR, "failed to reset %s to %s",
3653 conf->gen.name,
3654 config_enum_lookup_by_value(conf, conf->reset_val));
3655 *conf->variable = conf->reset_val;
3656 break;
3660 gconf->source = gconf->reset_source;
3662 if (gconf->flags & GUC_REPORT)
3663 ReportGUCOption(gconf);
3669 * push_old_value
3670 * Push previous state during transactional assignment to a GUC variable.
3672 static void
3673 push_old_value(struct config_generic * gconf, GucAction action)
3675 GucStack *stack;
3677 /* If we're not inside a nest level, do nothing */
3678 if (GUCNestLevel == 0)
3679 return;
3681 /* Do we already have a stack entry of the current nest level? */
3682 stack = gconf->stack;
3683 if (stack && stack->nest_level >= GUCNestLevel)
3685 /* Yes, so adjust its state if necessary */
3686 Assert(stack->nest_level == GUCNestLevel);
3687 switch (action)
3689 case GUC_ACTION_SET:
3690 /* SET overrides any prior action at same nest level */
3691 if (stack->state == GUC_SET_LOCAL)
3693 /* must discard old masked value */
3694 discard_stack_value(gconf, &stack->masked);
3696 stack->state = GUC_SET;
3697 break;
3698 case GUC_ACTION_LOCAL:
3699 if (stack->state == GUC_SET)
3701 /* SET followed by SET LOCAL, remember SET's value */
3702 set_stack_value(gconf, &stack->masked);
3703 stack->state = GUC_SET_LOCAL;
3705 /* in all other cases, no change to stack entry */
3706 break;
3707 case GUC_ACTION_SAVE:
3708 /* Could only have a prior SAVE of same variable */
3709 Assert(stack->state == GUC_SAVE);
3710 break;
3712 Assert(guc_dirty); /* must be set already */
3713 return;
3717 * Push a new stack entry
3719 * We keep all the stack entries in TopTransactionContext for simplicity.
3721 stack = (GucStack *) MemoryContextAllocZero(TopTransactionContext,
3722 sizeof(GucStack));
3724 stack->prev = gconf->stack;
3725 stack->nest_level = GUCNestLevel;
3726 switch (action)
3728 case GUC_ACTION_SET:
3729 stack->state = GUC_SET;
3730 break;
3731 case GUC_ACTION_LOCAL:
3732 stack->state = GUC_LOCAL;
3733 break;
3734 case GUC_ACTION_SAVE:
3735 stack->state = GUC_SAVE;
3736 break;
3738 stack->source = gconf->source;
3739 set_stack_value(gconf, &stack->prior);
3741 gconf->stack = stack;
3743 /* Ensure we remember to pop at end of xact */
3744 guc_dirty = true;
3749 * Do GUC processing at main transaction start.
3751 void
3752 AtStart_GUC(void)
3755 * The nest level should be 0 between transactions; if it isn't, somebody
3756 * didn't call AtEOXact_GUC, or called it with the wrong nestLevel. We
3757 * throw a warning but make no other effort to clean up.
3759 if (GUCNestLevel != 0)
3760 elog(WARNING, "GUC nest level = %d at transaction start",
3761 GUCNestLevel);
3762 GUCNestLevel = 1;
3766 * Enter a new nesting level for GUC values. This is called at subtransaction
3767 * start and when entering a function that has proconfig settings. NOTE that
3768 * we must not risk error here, else subtransaction start will be unhappy.
3771 NewGUCNestLevel(void)
3773 return ++GUCNestLevel;
3777 * Do GUC processing at transaction or subtransaction commit or abort, or
3778 * when exiting a function that has proconfig settings. (The name is thus
3779 * a bit of a misnomer; perhaps it should be ExitGUCNestLevel or some such.)
3780 * During abort, we discard all GUC settings that were applied at nesting
3781 * levels >= nestLevel. nestLevel == 1 corresponds to the main transaction.
3783 void
3784 AtEOXact_GUC(bool isCommit, int nestLevel)
3786 bool still_dirty;
3787 int i;
3789 Assert(nestLevel > 0 && nestLevel <= GUCNestLevel);
3791 /* Quick exit if nothing's changed in this transaction */
3792 if (!guc_dirty)
3794 GUCNestLevel = nestLevel - 1;
3795 return;
3798 still_dirty = false;
3799 for (i = 0; i < num_guc_variables; i++)
3801 struct config_generic *gconf = guc_variables[i];
3802 GucStack *stack;
3805 * Process and pop each stack entry within the nest level. To
3806 * simplify fmgr_security_definer(), we allow failure exit from a
3807 * function-with-SET-options to be recovered at the surrounding
3808 * transaction or subtransaction abort; so there could be more than
3809 * one stack entry to pop.
3811 while ((stack = gconf->stack) != NULL &&
3812 stack->nest_level >= nestLevel)
3814 GucStack *prev = stack->prev;
3815 bool restorePrior = false;
3816 bool restoreMasked = false;
3817 bool changed;
3820 * In this next bit, if we don't set either restorePrior or
3821 * restoreMasked, we must "discard" any unwanted fields of the
3822 * stack entries to avoid leaking memory. If we do set one of
3823 * those flags, unused fields will be cleaned up after restoring.
3825 if (!isCommit) /* if abort, always restore prior value */
3826 restorePrior = true;
3827 else if (stack->state == GUC_SAVE)
3828 restorePrior = true;
3829 else if (stack->nest_level == 1)
3831 /* transaction commit */
3832 if (stack->state == GUC_SET_LOCAL)
3833 restoreMasked = true;
3834 else if (stack->state == GUC_SET)
3836 /* we keep the current active value */
3837 discard_stack_value(gconf, &stack->prior);
3839 else /* must be GUC_LOCAL */
3840 restorePrior = true;
3842 else if (prev == NULL ||
3843 prev->nest_level < stack->nest_level - 1)
3845 /* decrement entry's level and do not pop it */
3846 stack->nest_level--;
3847 continue;
3849 else
3852 * We have to merge this stack entry into prev. See README for
3853 * discussion of this bit.
3855 switch (stack->state)
3857 case GUC_SAVE:
3858 Assert(false); /* can't get here */
3860 case GUC_SET:
3861 /* next level always becomes SET */
3862 discard_stack_value(gconf, &stack->prior);
3863 if (prev->state == GUC_SET_LOCAL)
3864 discard_stack_value(gconf, &prev->masked);
3865 prev->state = GUC_SET;
3866 break;
3868 case GUC_LOCAL:
3869 if (prev->state == GUC_SET)
3871 /* LOCAL migrates down */
3872 prev->masked = stack->prior;
3873 prev->state = GUC_SET_LOCAL;
3875 else
3877 /* else just forget this stack level */
3878 discard_stack_value(gconf, &stack->prior);
3880 break;
3882 case GUC_SET_LOCAL:
3883 /* prior state at this level no longer wanted */
3884 discard_stack_value(gconf, &stack->prior);
3885 /* copy down the masked state */
3886 if (prev->state == GUC_SET_LOCAL)
3887 discard_stack_value(gconf, &prev->masked);
3888 prev->masked = stack->masked;
3889 prev->state = GUC_SET_LOCAL;
3890 break;
3894 changed = false;
3896 if (restorePrior || restoreMasked)
3898 /* Perform appropriate restoration of the stacked value */
3899 union config_var_value newvalue;
3900 GucSource newsource;
3902 if (restoreMasked)
3904 newvalue = stack->masked;
3905 newsource = PGC_S_SESSION;
3907 else
3909 newvalue = stack->prior;
3910 newsource = stack->source;
3913 switch (gconf->vartype)
3915 case PGC_BOOL:
3917 struct config_bool *conf = (struct config_bool *) gconf;
3918 bool newval = newvalue.boolval;
3920 if (*conf->variable != newval)
3922 if (conf->assign_hook)
3923 if (!(*conf->assign_hook) (newval,
3924 true, PGC_S_OVERRIDE))
3925 elog(LOG, "failed to commit %s as %d",
3926 conf->gen.name, (int) newval);
3927 *conf->variable = newval;
3928 changed = true;
3930 break;
3932 case PGC_INT:
3934 struct config_int *conf = (struct config_int *) gconf;
3935 int newval = newvalue.intval;
3937 if (*conf->variable != newval)
3939 if (conf->assign_hook)
3940 if (!(*conf->assign_hook) (newval,
3941 true, PGC_S_OVERRIDE))
3942 elog(LOG, "failed to commit %s as %d",
3943 conf->gen.name, newval);
3944 *conf->variable = newval;
3945 changed = true;
3947 break;
3949 case PGC_REAL:
3951 struct config_real *conf = (struct config_real *) gconf;
3952 double newval = newvalue.realval;
3954 if (*conf->variable != newval)
3956 if (conf->assign_hook)
3957 if (!(*conf->assign_hook) (newval,
3958 true, PGC_S_OVERRIDE))
3959 elog(LOG, "failed to commit %s as %g",
3960 conf->gen.name, newval);
3961 *conf->variable = newval;
3962 changed = true;
3964 break;
3966 case PGC_STRING:
3968 struct config_string *conf = (struct config_string *) gconf;
3969 char *newval = newvalue.stringval;
3971 if (*conf->variable != newval)
3973 if (conf->assign_hook && newval)
3975 const char *newstr;
3977 newstr = (*conf->assign_hook) (newval, true,
3978 PGC_S_OVERRIDE);
3979 if (newstr == NULL)
3980 elog(LOG, "failed to commit %s as \"%s\"",
3981 conf->gen.name, newval);
3982 else if (newstr != newval)
3985 * If newval should now be freed,
3986 * it'll be taken care of below.
3988 * See notes in set_config_option
3989 * about casting
3991 newval = (char *) newstr;
3995 set_string_field(conf, conf->variable, newval);
3996 changed = true;
4000 * Release stacked values if not used anymore. We
4001 * could use discard_stack_value() here, but since
4002 * we have type-specific code anyway, might as
4003 * well inline it.
4005 set_string_field(conf, &stack->prior.stringval, NULL);
4006 set_string_field(conf, &stack->masked.stringval, NULL);
4007 break;
4009 case PGC_ENUM:
4011 struct config_enum *conf = (struct config_enum *) gconf;
4012 int newval = newvalue.enumval;
4014 if (*conf->variable != newval)
4016 if (conf->assign_hook)
4017 if (!(*conf->assign_hook) (newval,
4018 true, PGC_S_OVERRIDE))
4019 elog(LOG, "failed to commit %s as %s",
4020 conf->gen.name,
4021 config_enum_lookup_by_value(conf, newval));
4022 *conf->variable = newval;
4023 changed = true;
4025 break;
4029 gconf->source = newsource;
4032 /* Finish popping the state stack */
4033 gconf->stack = prev;
4034 pfree(stack);
4036 /* Report new value if we changed it */
4037 if (changed && (gconf->flags & GUC_REPORT))
4038 ReportGUCOption(gconf);
4039 } /* end of stack-popping loop */
4041 if (stack != NULL)
4042 still_dirty = true;
4045 /* If there are no remaining stack entries, we can reset guc_dirty */
4046 guc_dirty = still_dirty;
4048 /* Update nesting level */
4049 GUCNestLevel = nestLevel - 1;
4054 * Start up automatic reporting of changes to variables marked GUC_REPORT.
4055 * This is executed at completion of backend startup.
4057 void
4058 BeginReportingGUCOptions(void)
4060 int i;
4063 * Don't do anything unless talking to an interactive frontend of protocol
4064 * 3.0 or later.
4066 if (whereToSendOutput != DestRemote ||
4067 PG_PROTOCOL_MAJOR(FrontendProtocol) < 3)
4068 return;
4070 reporting_enabled = true;
4072 /* Transmit initial values of interesting variables */
4073 for (i = 0; i < num_guc_variables; i++)
4075 struct config_generic *conf = guc_variables[i];
4077 if (conf->flags & GUC_REPORT)
4078 ReportGUCOption(conf);
4083 * ReportGUCOption: if appropriate, transmit option value to frontend
4085 static void
4086 ReportGUCOption(struct config_generic * record)
4088 if (reporting_enabled && (record->flags & GUC_REPORT))
4090 char *val = _ShowOption(record, false);
4091 StringInfoData msgbuf;
4093 pq_beginmessage(&msgbuf, 'S');
4094 pq_sendstring(&msgbuf, record->name);
4095 pq_sendstring(&msgbuf, val);
4096 pq_endmessage(&msgbuf);
4098 pfree(val);
4103 * Try to parse value as an integer. The accepted formats are the
4104 * usual decimal, octal, or hexadecimal formats, optionally followed by
4105 * a unit name if "flags" indicates a unit is allowed.
4107 * If the string parses okay, return true, else false.
4108 * If okay and result is not NULL, return the value in *result.
4109 * If not okay and hintmsg is not NULL, *hintmsg is set to a suitable
4110 * HINT message, or NULL if no hint provided.
4112 bool
4113 parse_int(const char *value, int *result, int flags, const char **hintmsg)
4115 int64 val;
4116 char *endptr;
4118 /* To suppress compiler warnings, always set output params */
4119 if (result)
4120 *result = 0;
4121 if (hintmsg)
4122 *hintmsg = NULL;
4124 /* We assume here that int64 is at least as wide as long */
4125 errno = 0;
4126 val = strtol(value, &endptr, 0);
4128 if (endptr == value)
4129 return false; /* no HINT for integer syntax error */
4131 if (errno == ERANGE || val != (int64) ((int32) val))
4133 if (hintmsg)
4134 *hintmsg = gettext_noop("Value exceeds integer range.");
4135 return false;
4138 /* allow whitespace between integer and unit */
4139 while (isspace((unsigned char) *endptr))
4140 endptr++;
4142 /* Handle possible unit */
4143 if (*endptr != '\0')
4146 * Note: the multiple-switch coding technique here is a bit tedious,
4147 * but seems necessary to avoid intermediate-value overflows.
4149 * If INT64_IS_BUSTED (ie, it's really int32) we will fail to detect
4150 * overflow due to units conversion, but there are few enough such
4151 * machines that it does not seem worth trying to be smarter.
4153 if (flags & GUC_UNIT_MEMORY)
4155 /* Set hint for use if no match or trailing garbage */
4156 if (hintmsg)
4157 *hintmsg = gettext_noop("Valid units for this parameter are \"kB\", \"MB\", and \"GB\".");
4159 #if BLCKSZ < 1024 || BLCKSZ > (1024*1024)
4160 #error BLCKSZ must be between 1KB and 1MB
4161 #endif
4162 #if XLOG_BLCKSZ < 1024 || XLOG_BLCKSZ > (1024*1024)
4163 #error XLOG_BLCKSZ must be between 1KB and 1MB
4164 #endif
4166 if (strncmp(endptr, "kB", 2) == 0)
4168 endptr += 2;
4169 switch (flags & GUC_UNIT_MEMORY)
4171 case GUC_UNIT_BLOCKS:
4172 val /= (BLCKSZ / 1024);
4173 break;
4174 case GUC_UNIT_XBLOCKS:
4175 val /= (XLOG_BLCKSZ / 1024);
4176 break;
4179 else if (strncmp(endptr, "MB", 2) == 0)
4181 endptr += 2;
4182 switch (flags & GUC_UNIT_MEMORY)
4184 case GUC_UNIT_KB:
4185 val *= KB_PER_MB;
4186 break;
4187 case GUC_UNIT_BLOCKS:
4188 val *= KB_PER_MB / (BLCKSZ / 1024);
4189 break;
4190 case GUC_UNIT_XBLOCKS:
4191 val *= KB_PER_MB / (XLOG_BLCKSZ / 1024);
4192 break;
4195 else if (strncmp(endptr, "GB", 2) == 0)
4197 endptr += 2;
4198 switch (flags & GUC_UNIT_MEMORY)
4200 case GUC_UNIT_KB:
4201 val *= KB_PER_GB;
4202 break;
4203 case GUC_UNIT_BLOCKS:
4204 val *= KB_PER_GB / (BLCKSZ / 1024);
4205 break;
4206 case GUC_UNIT_XBLOCKS:
4207 val *= KB_PER_GB / (XLOG_BLCKSZ / 1024);
4208 break;
4212 else if (flags & GUC_UNIT_TIME)
4214 /* Set hint for use if no match or trailing garbage */
4215 if (hintmsg)
4216 *hintmsg = gettext_noop("Valid units for this parameter are \"ms\", \"s\", \"min\", \"h\", and \"d\".");
4218 if (strncmp(endptr, "ms", 2) == 0)
4220 endptr += 2;
4221 switch (flags & GUC_UNIT_TIME)
4223 case GUC_UNIT_S:
4224 val /= MS_PER_S;
4225 break;
4226 case GUC_UNIT_MIN:
4227 val /= MS_PER_MIN;
4228 break;
4231 else if (strncmp(endptr, "s", 1) == 0)
4233 endptr += 1;
4234 switch (flags & GUC_UNIT_TIME)
4236 case GUC_UNIT_MS:
4237 val *= MS_PER_S;
4238 break;
4239 case GUC_UNIT_MIN:
4240 val /= S_PER_MIN;
4241 break;
4244 else if (strncmp(endptr, "min", 3) == 0)
4246 endptr += 3;
4247 switch (flags & GUC_UNIT_TIME)
4249 case GUC_UNIT_MS:
4250 val *= MS_PER_MIN;
4251 break;
4252 case GUC_UNIT_S:
4253 val *= S_PER_MIN;
4254 break;
4257 else if (strncmp(endptr, "h", 1) == 0)
4259 endptr += 1;
4260 switch (flags & GUC_UNIT_TIME)
4262 case GUC_UNIT_MS:
4263 val *= MS_PER_H;
4264 break;
4265 case GUC_UNIT_S:
4266 val *= S_PER_H;
4267 break;
4268 case GUC_UNIT_MIN:
4269 val *= MIN_PER_H;
4270 break;
4273 else if (strncmp(endptr, "d", 1) == 0)
4275 endptr += 1;
4276 switch (flags & GUC_UNIT_TIME)
4278 case GUC_UNIT_MS:
4279 val *= MS_PER_D;
4280 break;
4281 case GUC_UNIT_S:
4282 val *= S_PER_D;
4283 break;
4284 case GUC_UNIT_MIN:
4285 val *= MIN_PER_D;
4286 break;
4291 /* allow whitespace after unit */
4292 while (isspace((unsigned char) *endptr))
4293 endptr++;
4295 if (*endptr != '\0')
4296 return false; /* appropriate hint, if any, already set */
4298 /* Check for overflow due to units conversion */
4299 if (val != (int64) ((int32) val))
4301 if (hintmsg)
4302 *hintmsg = gettext_noop("Value exceeds integer range.");
4303 return false;
4307 if (result)
4308 *result = (int) val;
4309 return true;
4315 * Try to parse value as a floating point number in the usual format.
4316 * If the string parses okay, return true, else false.
4317 * If okay and result is not NULL, return the value in *result.
4319 bool
4320 parse_real(const char *value, double *result)
4322 double val;
4323 char *endptr;
4325 if (result)
4326 *result = 0; /* suppress compiler warning */
4328 errno = 0;
4329 val = strtod(value, &endptr);
4330 if (endptr == value || errno == ERANGE)
4331 return false;
4333 /* allow whitespace after number */
4334 while (isspace((unsigned char) *endptr))
4335 endptr++;
4336 if (*endptr != '\0')
4337 return false;
4339 if (result)
4340 *result = val;
4341 return true;
4346 * Lookup the name for an enum option with the selected value.
4347 * Should only ever be called with known-valid values, so throws
4348 * an elog(ERROR) if the enum option is not found.
4350 * The returned string is a pointer to static data and not
4351 * allocated for modification.
4353 const char *
4354 config_enum_lookup_by_value(struct config_enum * record, int val)
4356 const struct config_enum_entry *entry;
4358 for (entry = record->options; entry && entry->name; entry++)
4360 if (entry->val == val)
4361 return entry->name;
4364 elog(ERROR, "could not find enum option %d for %s",
4365 val, record->gen.name);
4366 return NULL; /* silence compiler */
4371 * Lookup the value for an enum option with the selected name
4372 * (case-insensitive).
4373 * If the enum option is found, sets the retval value and returns
4374 * true. If it's not found, return FALSE and retval is set to 0.
4376 bool
4377 config_enum_lookup_by_name(struct config_enum * record, const char *value,
4378 int *retval)
4380 const struct config_enum_entry *entry;
4382 for (entry = record->options; entry && entry->name; entry++)
4384 if (pg_strcasecmp(value, entry->name) == 0)
4386 *retval = entry->val;
4387 return TRUE;
4391 *retval = 0;
4392 return FALSE;
4397 * Return a list of all available options for an enum, excluding
4398 * hidden ones, separated by the given separator.
4399 * If prefix is non-NULL, it is added before the first enum value.
4400 * If suffix is non-NULL, it is added to the end of the string.
4402 static char *
4403 config_enum_get_options(struct config_enum * record, const char *prefix,
4404 const char *suffix, const char *separator)
4406 const struct config_enum_entry *entry;
4407 StringInfoData retstr;
4408 int seplen;
4410 initStringInfo(&retstr);
4411 appendStringInfoString(&retstr, prefix);
4413 seplen = strlen(separator);
4414 for (entry = record->options; entry && entry->name; entry++)
4416 if (!entry->hidden)
4418 appendStringInfoString(&retstr, entry->name);
4419 appendBinaryStringInfo(&retstr, separator, seplen);
4424 * All the entries may have been hidden, leaving the string empty if no
4425 * prefix was given. This indicates a broken GUC setup, since there is no
4426 * use for an enum without any values, so we just check to make sure we
4427 * don't write to invalid memory instead of actually trying to do
4428 * something smart with it.
4430 if (retstr.len >= seplen)
4432 /* Replace final separator */
4433 retstr.data[retstr.len - seplen] = '\0';
4434 retstr.len -= seplen;
4437 appendStringInfoString(&retstr, suffix);
4439 return retstr.data;
4443 * Call a GucStringAssignHook function, being careful to free the
4444 * "newval" string if the hook ereports.
4446 * This is split out of set_config_option just to avoid the "volatile"
4447 * qualifiers that would otherwise have to be plastered all over.
4449 static const char *
4450 call_string_assign_hook(GucStringAssignHook assign_hook,
4451 char *newval, bool doit, GucSource source)
4453 const char *result;
4455 PG_TRY();
4457 result = (*assign_hook) (newval, doit, source);
4459 PG_CATCH();
4461 free(newval);
4462 PG_RE_THROW();
4464 PG_END_TRY();
4466 return result;
4471 * Sets option `name' to given value. The value should be a string
4472 * which is going to be parsed and converted to the appropriate data
4473 * type. The context and source parameters indicate in which context this
4474 * function is being called so it can apply the access restrictions
4475 * properly.
4477 * If value is NULL, set the option to its default value (normally the
4478 * reset_val, but if source == PGC_S_DEFAULT we instead use the boot_val).
4480 * action indicates whether to set the value globally in the session, locally
4481 * to the current top transaction, or just for the duration of a function call.
4483 * If changeVal is false then don't really set the option but do all
4484 * the checks to see if it would work.
4486 * If there is an error (non-existing option, invalid value) then an
4487 * ereport(ERROR) is thrown *unless* this is called in a context where we
4488 * don't want to ereport (currently, startup or SIGHUP config file reread).
4489 * In that case we write a suitable error message via ereport(LOG) and
4490 * return false. This is working around the deficiencies in the ereport
4491 * mechanism, so don't blame me. In all other cases, the function
4492 * returns true, including cases where the input is valid but we chose
4493 * not to apply it because of context or source-priority considerations.
4495 * See also SetConfigOption for an external interface.
4497 bool
4498 set_config_option(const char *name, const char *value,
4499 GucContext context, GucSource source,
4500 GucAction action, bool changeVal)
4502 struct config_generic *record;
4503 int elevel;
4504 bool makeDefault;
4506 if (context == PGC_SIGHUP || source == PGC_S_DEFAULT)
4509 * To avoid cluttering the log, only the postmaster bleats loudly
4510 * about problems with the config file.
4512 elevel = IsUnderPostmaster ? DEBUG3 : LOG;
4514 else if (source == PGC_S_DATABASE || source == PGC_S_USER)
4515 elevel = WARNING;
4516 else
4517 elevel = ERROR;
4519 record = find_option(name, true, elevel);
4520 if (record == NULL)
4522 ereport(elevel,
4523 (errcode(ERRCODE_UNDEFINED_OBJECT),
4524 errmsg("unrecognized configuration parameter \"%s\"", name)));
4525 return false;
4529 * If source is postgresql.conf, mark the found record with
4530 * GUC_IS_IN_FILE. This is for the convenience of ProcessConfigFile. Note
4531 * that we do it even if changeVal is false, since ProcessConfigFile wants
4532 * the marking to occur during its testing pass.
4534 if (source == PGC_S_FILE)
4535 record->status |= GUC_IS_IN_FILE;
4538 * Check if the option can be set at this time. See guc.h for the precise
4539 * rules. Note that we don't want to throw errors if we're in the SIGHUP
4540 * context. In that case we just ignore the attempt and return true.
4542 switch (record->context)
4544 case PGC_INTERNAL:
4545 if (context == PGC_SIGHUP)
4546 return true;
4547 if (context != PGC_INTERNAL)
4549 ereport(elevel,
4550 (errcode(ERRCODE_CANT_CHANGE_RUNTIME_PARAM),
4551 errmsg("parameter \"%s\" cannot be changed",
4552 name)));
4553 return false;
4555 break;
4556 case PGC_POSTMASTER:
4557 if (context == PGC_SIGHUP)
4560 * We are reading a PGC_POSTMASTER var from postgresql.conf.
4561 * We can't change the setting, so give a warning if the DBA
4562 * tries to change it. (Throwing an error would be more
4563 * consistent, but seems overly rigid.)
4565 if (changeVal && !is_newvalue_equal(record, value))
4566 ereport(elevel,
4567 (errcode(ERRCODE_CANT_CHANGE_RUNTIME_PARAM),
4568 errmsg("attempted change of parameter \"%s\" ignored",
4569 name),
4570 errdetail("This parameter cannot be changed after server start.")));
4571 return true;
4573 if (context != PGC_POSTMASTER)
4575 ereport(elevel,
4576 (errcode(ERRCODE_CANT_CHANGE_RUNTIME_PARAM),
4577 errmsg("attempted change of parameter \"%s\" ignored",
4578 name),
4579 errdetail("This parameter cannot be changed after server start.")));
4580 return false;
4582 break;
4583 case PGC_SIGHUP:
4584 if (context != PGC_SIGHUP && context != PGC_POSTMASTER)
4586 ereport(elevel,
4587 (errcode(ERRCODE_CANT_CHANGE_RUNTIME_PARAM),
4588 errmsg("parameter \"%s\" cannot be changed now",
4589 name)));
4590 return false;
4594 * Hmm, the idea of the SIGHUP context is "ought to be global, but
4595 * can be changed after postmaster start". But there's nothing
4596 * that prevents a crafty administrator from sending SIGHUP
4597 * signals to individual backends only.
4599 break;
4600 case PGC_BACKEND:
4601 if (context == PGC_SIGHUP)
4604 * If a PGC_BACKEND parameter is changed in the config file,
4605 * we want to accept the new value in the postmaster (whence
4606 * it will propagate to subsequently-started backends), but
4607 * ignore it in existing backends. This is a tad klugy, but
4608 * necessary because we don't re-read the config file during
4609 * backend start.
4611 if (IsUnderPostmaster)
4612 return true;
4614 else if (context != PGC_BACKEND && context != PGC_POSTMASTER)
4616 ereport(elevel,
4617 (errcode(ERRCODE_CANT_CHANGE_RUNTIME_PARAM),
4618 errmsg("parameter \"%s\" cannot be set after connection start",
4619 name)));
4620 return false;
4622 break;
4623 case PGC_SUSET:
4624 if (context == PGC_USERSET || context == PGC_BACKEND)
4626 ereport(elevel,
4627 (errcode(ERRCODE_INSUFFICIENT_PRIVILEGE),
4628 errmsg("permission denied to set parameter \"%s\"",
4629 name)));
4630 return false;
4632 break;
4633 case PGC_USERSET:
4634 /* always okay */
4635 break;
4639 * Should we set reset/stacked values? (If so, the behavior is not
4640 * transactional.) This is done either when we get a default value from
4641 * the database's/user's/client's default settings or when we reset a
4642 * value to its default.
4644 makeDefault = changeVal && (source <= PGC_S_OVERRIDE) &&
4645 ((value != NULL) || source == PGC_S_DEFAULT);
4648 * Ignore attempted set if overridden by previously processed setting.
4649 * However, if changeVal is false then plow ahead anyway since we are
4650 * trying to find out if the value is potentially good, not actually use
4651 * it. Also keep going if makeDefault is true, since we may want to set
4652 * the reset/stacked values even if we can't set the variable itself.
4654 if (record->source > source)
4656 if (changeVal && !makeDefault)
4658 elog(DEBUG3, "\"%s\": setting ignored because previous source is higher priority",
4659 name);
4660 return true;
4662 changeVal = false;
4666 * Evaluate value and set variable.
4668 switch (record->vartype)
4670 case PGC_BOOL:
4672 struct config_bool *conf = (struct config_bool *) record;
4673 bool newval;
4675 if (value)
4677 if (!parse_bool(value, &newval))
4679 ereport(elevel,
4680 (errcode(ERRCODE_INVALID_PARAMETER_VALUE),
4681 errmsg("parameter \"%s\" requires a Boolean value",
4682 name)));
4683 return false;
4686 else if (source == PGC_S_DEFAULT)
4687 newval = conf->boot_val;
4688 else
4690 newval = conf->reset_val;
4691 source = conf->gen.reset_source;
4694 /* Save old value to support transaction abort */
4695 if (changeVal && !makeDefault)
4696 push_old_value(&conf->gen, action);
4698 if (conf->assign_hook)
4699 if (!(*conf->assign_hook) (newval, changeVal, source))
4701 ereport(elevel,
4702 (errcode(ERRCODE_INVALID_PARAMETER_VALUE),
4703 errmsg("invalid value for parameter \"%s\": %d",
4704 name, (int) newval)));
4705 return false;
4708 if (changeVal)
4710 *conf->variable = newval;
4711 conf->gen.source = source;
4713 if (makeDefault)
4715 GucStack *stack;
4717 if (conf->gen.reset_source <= source)
4719 conf->reset_val = newval;
4720 conf->gen.reset_source = source;
4722 for (stack = conf->gen.stack; stack; stack = stack->prev)
4724 if (stack->source <= source)
4726 stack->prior.boolval = newval;
4727 stack->source = source;
4731 break;
4734 case PGC_INT:
4736 struct config_int *conf = (struct config_int *) record;
4737 int newval;
4739 if (value)
4741 const char *hintmsg;
4743 if (!parse_int(value, &newval, conf->gen.flags, &hintmsg))
4745 ereport(elevel,
4746 (errcode(ERRCODE_INVALID_PARAMETER_VALUE),
4747 errmsg("invalid value for parameter \"%s\": \"%s\"",
4748 name, value),
4749 hintmsg ? errhint("%s", _(hintmsg)) : 0));
4750 return false;
4752 if (newval < conf->min || newval > conf->max)
4754 ereport(elevel,
4755 (errcode(ERRCODE_INVALID_PARAMETER_VALUE),
4756 errmsg("%d is outside the valid range for parameter \"%s\" (%d .. %d)",
4757 newval, name, conf->min, conf->max)));
4758 return false;
4761 else if (source == PGC_S_DEFAULT)
4762 newval = conf->boot_val;
4763 else
4765 newval = conf->reset_val;
4766 source = conf->gen.reset_source;
4769 /* Save old value to support transaction abort */
4770 if (changeVal && !makeDefault)
4771 push_old_value(&conf->gen, action);
4773 if (conf->assign_hook)
4774 if (!(*conf->assign_hook) (newval, changeVal, source))
4776 ereport(elevel,
4777 (errcode(ERRCODE_INVALID_PARAMETER_VALUE),
4778 errmsg("invalid value for parameter \"%s\": %d",
4779 name, newval)));
4780 return false;
4783 if (changeVal)
4785 *conf->variable = newval;
4786 conf->gen.source = source;
4788 if (makeDefault)
4790 GucStack *stack;
4792 if (conf->gen.reset_source <= source)
4794 conf->reset_val = newval;
4795 conf->gen.reset_source = source;
4797 for (stack = conf->gen.stack; stack; stack = stack->prev)
4799 if (stack->source <= source)
4801 stack->prior.intval = newval;
4802 stack->source = source;
4806 break;
4809 case PGC_REAL:
4811 struct config_real *conf = (struct config_real *) record;
4812 double newval;
4814 if (value)
4816 if (!parse_real(value, &newval))
4818 ereport(elevel,
4819 (errcode(ERRCODE_INVALID_PARAMETER_VALUE),
4820 errmsg("parameter \"%s\" requires a numeric value",
4821 name)));
4822 return false;
4824 if (newval < conf->min || newval > conf->max)
4826 ereport(elevel,
4827 (errcode(ERRCODE_INVALID_PARAMETER_VALUE),
4828 errmsg("%g is outside the valid range for parameter \"%s\" (%g .. %g)",
4829 newval, name, conf->min, conf->max)));
4830 return false;
4833 else if (source == PGC_S_DEFAULT)
4834 newval = conf->boot_val;
4835 else
4837 newval = conf->reset_val;
4838 source = conf->gen.reset_source;
4841 /* Save old value to support transaction abort */
4842 if (changeVal && !makeDefault)
4843 push_old_value(&conf->gen, action);
4845 if (conf->assign_hook)
4846 if (!(*conf->assign_hook) (newval, changeVal, source))
4848 ereport(elevel,
4849 (errcode(ERRCODE_INVALID_PARAMETER_VALUE),
4850 errmsg("invalid value for parameter \"%s\": %g",
4851 name, newval)));
4852 return false;
4855 if (changeVal)
4857 *conf->variable = newval;
4858 conf->gen.source = source;
4860 if (makeDefault)
4862 GucStack *stack;
4864 if (conf->gen.reset_source <= source)
4866 conf->reset_val = newval;
4867 conf->gen.reset_source = source;
4869 for (stack = conf->gen.stack; stack; stack = stack->prev)
4871 if (stack->source <= source)
4873 stack->prior.realval = newval;
4874 stack->source = source;
4878 break;
4881 case PGC_STRING:
4883 struct config_string *conf = (struct config_string *) record;
4884 char *newval;
4886 if (value)
4888 newval = guc_strdup(elevel, value);
4889 if (newval == NULL)
4890 return false;
4893 * The only sort of "parsing" check we need to do is apply
4894 * truncation if GUC_IS_NAME.
4896 if (conf->gen.flags & GUC_IS_NAME)
4897 truncate_identifier(newval, strlen(newval), true);
4899 else if (source == PGC_S_DEFAULT)
4901 if (conf->boot_val == NULL)
4902 newval = NULL;
4903 else
4905 newval = guc_strdup(elevel, conf->boot_val);
4906 if (newval == NULL)
4907 return false;
4910 else
4913 * We could possibly avoid strdup here, but easier to make
4914 * this case work the same as the normal assignment case;
4915 * note the possible free of newval below.
4917 if (conf->reset_val == NULL)
4918 newval = NULL;
4919 else
4921 newval = guc_strdup(elevel, conf->reset_val);
4922 if (newval == NULL)
4923 return false;
4925 source = conf->gen.reset_source;
4928 /* Save old value to support transaction abort */
4929 if (changeVal && !makeDefault)
4930 push_old_value(&conf->gen, action);
4932 if (conf->assign_hook && newval)
4934 const char *hookresult;
4937 * If the hook ereports, we have to make sure we free
4938 * newval, else it will be a permanent memory leak.
4940 hookresult = call_string_assign_hook(conf->assign_hook,
4941 newval,
4942 changeVal,
4943 source);
4944 if (hookresult == NULL)
4946 free(newval);
4947 ereport(elevel,
4948 (errcode(ERRCODE_INVALID_PARAMETER_VALUE),
4949 errmsg("invalid value for parameter \"%s\": \"%s\"",
4950 name, value ? value : "")));
4951 return false;
4953 else if (hookresult != newval)
4955 free(newval);
4958 * Having to cast away const here is annoying, but the
4959 * alternative is to declare assign_hooks as returning
4960 * char*, which would mean they'd have to cast away
4961 * const, or as both taking and returning char*, which
4962 * doesn't seem attractive either --- we don't want
4963 * them to scribble on the passed str.
4965 newval = (char *) hookresult;
4969 if (changeVal)
4971 set_string_field(conf, conf->variable, newval);
4972 conf->gen.source = source;
4974 if (makeDefault)
4976 GucStack *stack;
4978 if (conf->gen.reset_source <= source)
4980 set_string_field(conf, &conf->reset_val, newval);
4981 conf->gen.reset_source = source;
4983 for (stack = conf->gen.stack; stack; stack = stack->prev)
4985 if (stack->source <= source)
4987 set_string_field(conf, &stack->prior.stringval,
4988 newval);
4989 stack->source = source;
4993 /* Perhaps we didn't install newval anywhere */
4994 if (newval && !string_field_used(conf, newval))
4995 free(newval);
4996 break;
4998 case PGC_ENUM:
5000 struct config_enum *conf = (struct config_enum *) record;
5001 int newval;
5003 if (value)
5005 if (!config_enum_lookup_by_name(conf, value, &newval))
5007 char *hintmsg;
5009 hintmsg = config_enum_get_options(conf,
5010 "Available values: ",
5011 ".", ", ");
5013 ereport(elevel,
5014 (errcode(ERRCODE_INVALID_PARAMETER_VALUE),
5015 errmsg("invalid value for parameter \"%s\": \"%s\"",
5016 name, value),
5017 hintmsg ? errhint("%s", _(hintmsg)) : 0));
5019 if (hintmsg)
5020 pfree(hintmsg);
5021 return false;
5024 else if (source == PGC_S_DEFAULT)
5025 newval = conf->boot_val;
5026 else
5028 newval = conf->reset_val;
5029 source = conf->gen.reset_source;
5032 /* Save old value to support transaction abort */
5033 if (changeVal && !makeDefault)
5034 push_old_value(&conf->gen, action);
5036 if (conf->assign_hook)
5037 if (!(*conf->assign_hook) (newval, changeVal, source))
5039 ereport(elevel,
5040 (errcode(ERRCODE_INVALID_PARAMETER_VALUE),
5041 errmsg("invalid value for parameter \"%s\": \"%s\"",
5042 name,
5043 config_enum_lookup_by_value(conf, newval))));
5044 return false;
5047 if (changeVal)
5049 *conf->variable = newval;
5050 conf->gen.source = source;
5052 if (makeDefault)
5054 GucStack *stack;
5056 if (conf->gen.reset_source <= source)
5058 conf->reset_val = newval;
5059 conf->gen.reset_source = source;
5061 for (stack = conf->gen.stack; stack; stack = stack->prev)
5063 if (stack->source <= source)
5065 stack->prior.enumval = newval;
5066 stack->source = source;
5070 break;
5074 if (changeVal && (record->flags & GUC_REPORT))
5075 ReportGUCOption(record);
5077 return true;
5082 * Set the fields for source file and line number the setting came from.
5084 static void
5085 set_config_sourcefile(const char *name, char *sourcefile, int sourceline)
5087 struct config_generic *record;
5088 int elevel;
5091 * To avoid cluttering the log, only the postmaster bleats loudly about
5092 * problems with the config file.
5094 elevel = IsUnderPostmaster ? DEBUG3 : LOG;
5096 record = find_option(name, true, elevel);
5097 /* should not happen */
5098 if (record == NULL)
5099 elog(ERROR, "unrecognized configuration parameter \"%s\"", name);
5101 sourcefile = guc_strdup(elevel, sourcefile);
5102 if (record->sourcefile)
5103 free(record->sourcefile);
5104 record->sourcefile = sourcefile;
5105 record->sourceline = sourceline;
5109 * Set a config option to the given value. See also set_config_option,
5110 * this is just the wrapper to be called from outside GUC. NB: this
5111 * is used only for non-transactional operations.
5113 * Note: there is no support here for setting source file/line, as it
5114 * is currently not needed.
5116 void
5117 SetConfigOption(const char *name, const char *value,
5118 GucContext context, GucSource source)
5120 (void) set_config_option(name, value, context, source,
5121 GUC_ACTION_SET, true);
5127 * Fetch the current value of the option `name'. If the option doesn't exist,
5128 * throw an ereport and don't return.
5130 * The string is *not* allocated for modification and is really only
5131 * valid until the next call to configuration related functions.
5133 const char *
5134 GetConfigOption(const char *name)
5136 struct config_generic *record;
5137 static char buffer[256];
5139 record = find_option(name, false, ERROR);
5140 if (record == NULL)
5141 ereport(ERROR,
5142 (errcode(ERRCODE_UNDEFINED_OBJECT),
5143 errmsg("unrecognized configuration parameter \"%s\"", name)));
5144 if ((record->flags & GUC_SUPERUSER_ONLY) && !superuser())
5145 ereport(ERROR,
5146 (errcode(ERRCODE_INSUFFICIENT_PRIVILEGE),
5147 errmsg("must be superuser to examine \"%s\"", name)));
5149 switch (record->vartype)
5151 case PGC_BOOL:
5152 return *((struct config_bool *) record)->variable ? "on" : "off";
5154 case PGC_INT:
5155 snprintf(buffer, sizeof(buffer), "%d",
5156 *((struct config_int *) record)->variable);
5157 return buffer;
5159 case PGC_REAL:
5160 snprintf(buffer, sizeof(buffer), "%g",
5161 *((struct config_real *) record)->variable);
5162 return buffer;
5164 case PGC_STRING:
5165 return *((struct config_string *) record)->variable;
5167 case PGC_ENUM:
5168 return config_enum_lookup_by_value((struct config_enum *) record,
5169 *((struct config_enum *) record)->variable);
5171 return NULL;
5175 * Get the RESET value associated with the given option.
5177 * Note: this is not re-entrant, due to use of static result buffer;
5178 * not to mention that a string variable could have its reset_val changed.
5179 * Beware of assuming the result value is good for very long.
5181 const char *
5182 GetConfigOptionResetString(const char *name)
5184 struct config_generic *record;
5185 static char buffer[256];
5187 record = find_option(name, false, ERROR);
5188 if (record == NULL)
5189 ereport(ERROR,
5190 (errcode(ERRCODE_UNDEFINED_OBJECT),
5191 errmsg("unrecognized configuration parameter \"%s\"", name)));
5192 if ((record->flags & GUC_SUPERUSER_ONLY) && !superuser())
5193 ereport(ERROR,
5194 (errcode(ERRCODE_INSUFFICIENT_PRIVILEGE),
5195 errmsg("must be superuser to examine \"%s\"", name)));
5197 switch (record->vartype)
5199 case PGC_BOOL:
5200 return ((struct config_bool *) record)->reset_val ? "on" : "off";
5202 case PGC_INT:
5203 snprintf(buffer, sizeof(buffer), "%d",
5204 ((struct config_int *) record)->reset_val);
5205 return buffer;
5207 case PGC_REAL:
5208 snprintf(buffer, sizeof(buffer), "%g",
5209 ((struct config_real *) record)->reset_val);
5210 return buffer;
5212 case PGC_STRING:
5213 return ((struct config_string *) record)->reset_val;
5215 case PGC_ENUM:
5216 return config_enum_lookup_by_value((struct config_enum *) record,
5217 ((struct config_enum *) record)->reset_val);
5219 return NULL;
5223 * Detect whether the given configuration option can only be set by
5224 * a superuser.
5226 bool
5227 IsSuperuserConfigOption(const char *name)
5229 struct config_generic *record;
5231 record = find_option(name, false, ERROR);
5232 /* On an unrecognized name, don't error, just return false. */
5233 if (record == NULL)
5234 return false;
5235 return (record->context == PGC_SUSET);
5240 * GUC_complaint_elevel
5241 * Get the ereport error level to use in an assign_hook's error report.
5243 * This should be used by assign hooks that want to emit a custom error
5244 * report (in addition to the generic "invalid value for option FOO" that
5245 * guc.c will provide). Note that the result might be ERROR or a lower
5246 * level, so the caller must be prepared for control to return from ereport,
5247 * or not. If control does return, return false/NULL from the hook function.
5249 * At some point it'd be nice to replace this with a mechanism that allows
5250 * the custom message to become the DETAIL line of guc.c's generic message.
5253 GUC_complaint_elevel(GucSource source)
5255 int elevel;
5257 if (source == PGC_S_FILE)
5260 * To avoid cluttering the log, only the postmaster bleats loudly
5261 * about problems with the config file.
5263 elevel = IsUnderPostmaster ? DEBUG3 : LOG;
5265 else if (source == PGC_S_OVERRIDE)
5268 * If we're a postmaster child, this is probably "undo" during
5269 * transaction abort, so we don't want to clutter the log. There's a
5270 * small chance of a real problem with an OVERRIDE setting, though, so
5271 * suppressing the message entirely wouldn't be desirable.
5273 elevel = IsUnderPostmaster ? DEBUG5 : LOG;
5275 else if (source < PGC_S_INTERACTIVE)
5276 elevel = LOG;
5277 else
5278 elevel = ERROR;
5280 return elevel;
5285 * flatten_set_variable_args
5286 * Given a parsenode List as emitted by the grammar for SET,
5287 * convert to the flat string representation used by GUC.
5289 * We need to be told the name of the variable the args are for, because
5290 * the flattening rules vary (ugh).
5292 * The result is NULL if args is NIL (ie, SET ... TO DEFAULT), otherwise
5293 * a palloc'd string.
5295 static char *
5296 flatten_set_variable_args(const char *name, List *args)
5298 struct config_generic *record;
5299 int flags;
5300 StringInfoData buf;
5301 ListCell *l;
5303 /* Fast path if just DEFAULT */
5304 if (args == NIL)
5305 return NULL;
5307 /* Else get flags for the variable */
5308 record = find_option(name, true, ERROR);
5309 if (record == NULL)
5310 ereport(ERROR,
5311 (errcode(ERRCODE_UNDEFINED_OBJECT),
5312 errmsg("unrecognized configuration parameter \"%s\"", name)));
5314 flags = record->flags;
5316 /* Complain if list input and non-list variable */
5317 if ((flags & GUC_LIST_INPUT) == 0 &&
5318 list_length(args) != 1)
5319 ereport(ERROR,
5320 (errcode(ERRCODE_INVALID_PARAMETER_VALUE),
5321 errmsg("SET %s takes only one argument", name)));
5323 initStringInfo(&buf);
5326 * Each list member may be a plain A_Const node, or an A_Const within a
5327 * TypeCast; the latter case is supported only for ConstInterval arguments
5328 * (for SET TIME ZONE).
5330 foreach(l, args)
5332 Node *arg = (Node *) lfirst(l);
5333 char *val;
5334 TypeName *typename = NULL;
5335 A_Const *con;
5337 if (l != list_head(args))
5338 appendStringInfo(&buf, ", ");
5340 if (IsA(arg, TypeCast))
5342 TypeCast *tc = (TypeCast *) arg;
5344 arg = tc->arg;
5345 typename = tc->typename;
5348 if (!IsA(arg, A_Const))
5349 elog(ERROR, "unrecognized node type: %d", (int) nodeTag(arg));
5350 con = (A_Const *) arg;
5352 switch (nodeTag(&con->val))
5354 case T_Integer:
5355 appendStringInfo(&buf, "%ld", intVal(&con->val));
5356 break;
5357 case T_Float:
5358 /* represented as a string, so just copy it */
5359 appendStringInfoString(&buf, strVal(&con->val));
5360 break;
5361 case T_String:
5362 val = strVal(&con->val);
5363 if (typename != NULL)
5366 * Must be a ConstInterval argument for TIME ZONE. Coerce
5367 * to interval and back to normalize the value and account
5368 * for any typmod.
5370 Oid typoid;
5371 int32 typmod;
5372 Datum interval;
5373 char *intervalout;
5375 typoid = typenameTypeId(NULL, typename, &typmod);
5376 Assert(typoid == INTERVALOID);
5378 interval =
5379 DirectFunctionCall3(interval_in,
5380 CStringGetDatum(val),
5381 ObjectIdGetDatum(InvalidOid),
5382 Int32GetDatum(typmod));
5384 intervalout =
5385 DatumGetCString(DirectFunctionCall1(interval_out,
5386 interval));
5387 appendStringInfo(&buf, "INTERVAL '%s'", intervalout);
5389 else
5392 * Plain string literal or identifier. For quote mode,
5393 * quote it if it's not a vanilla identifier.
5395 if (flags & GUC_LIST_QUOTE)
5396 appendStringInfoString(&buf, quote_identifier(val));
5397 else
5398 appendStringInfoString(&buf, val);
5400 break;
5401 default:
5402 elog(ERROR, "unrecognized node type: %d",
5403 (int) nodeTag(&con->val));
5404 break;
5408 return buf.data;
5413 * SET command
5415 void
5416 ExecSetVariableStmt(VariableSetStmt *stmt)
5418 GucAction action = stmt->is_local ? GUC_ACTION_LOCAL : GUC_ACTION_SET;
5420 switch (stmt->kind)
5422 case VAR_SET_VALUE:
5423 case VAR_SET_CURRENT:
5424 set_config_option(stmt->name,
5425 ExtractSetVariableArgs(stmt),
5426 (superuser() ? PGC_SUSET : PGC_USERSET),
5427 PGC_S_SESSION,
5428 action,
5429 true);
5430 break;
5431 case VAR_SET_MULTI:
5434 * Special case for special SQL syntax that effectively sets more
5435 * than one variable per statement.
5437 if (strcmp(stmt->name, "TRANSACTION") == 0)
5439 ListCell *head;
5441 foreach(head, stmt->args)
5443 DefElem *item = (DefElem *) lfirst(head);
5445 if (strcmp(item->defname, "transaction_isolation") == 0)
5446 SetPGVariable("transaction_isolation",
5447 list_make1(item->arg), stmt->is_local);
5448 else if (strcmp(item->defname, "transaction_read_only") == 0)
5449 SetPGVariable("transaction_read_only",
5450 list_make1(item->arg), stmt->is_local);
5451 else
5452 elog(ERROR, "unexpected SET TRANSACTION element: %s",
5453 item->defname);
5456 else if (strcmp(stmt->name, "SESSION CHARACTERISTICS") == 0)
5458 ListCell *head;
5460 foreach(head, stmt->args)
5462 DefElem *item = (DefElem *) lfirst(head);
5464 if (strcmp(item->defname, "transaction_isolation") == 0)
5465 SetPGVariable("default_transaction_isolation",
5466 list_make1(item->arg), stmt->is_local);
5467 else if (strcmp(item->defname, "transaction_read_only") == 0)
5468 SetPGVariable("default_transaction_read_only",
5469 list_make1(item->arg), stmt->is_local);
5470 else
5471 elog(ERROR, "unexpected SET SESSION element: %s",
5472 item->defname);
5475 else
5476 elog(ERROR, "unexpected SET MULTI element: %s",
5477 stmt->name);
5478 break;
5479 case VAR_SET_DEFAULT:
5480 case VAR_RESET:
5481 set_config_option(stmt->name,
5482 NULL,
5483 (superuser() ? PGC_SUSET : PGC_USERSET),
5484 PGC_S_SESSION,
5485 action,
5486 true);
5487 break;
5488 case VAR_RESET_ALL:
5489 ResetAllOptions();
5490 break;
5495 * Get the value to assign for a VariableSetStmt, or NULL if it's RESET.
5496 * The result is palloc'd.
5498 * This is exported for use by actions such as ALTER ROLE SET.
5500 char *
5501 ExtractSetVariableArgs(VariableSetStmt *stmt)
5503 switch (stmt->kind)
5505 case VAR_SET_VALUE:
5506 return flatten_set_variable_args(stmt->name, stmt->args);
5507 case VAR_SET_CURRENT:
5508 return GetConfigOptionByName(stmt->name, NULL);
5509 default:
5510 return NULL;
5515 * SetPGVariable - SET command exported as an easily-C-callable function.
5517 * This provides access to SET TO value, as well as SET TO DEFAULT (expressed
5518 * by passing args == NIL), but not SET FROM CURRENT functionality.
5520 void
5521 SetPGVariable(const char *name, List *args, bool is_local)
5523 char *argstring = flatten_set_variable_args(name, args);
5525 /* Note SET DEFAULT (argstring == NULL) is equivalent to RESET */
5526 set_config_option(name,
5527 argstring,
5528 (superuser() ? PGC_SUSET : PGC_USERSET),
5529 PGC_S_SESSION,
5530 is_local ? GUC_ACTION_LOCAL : GUC_ACTION_SET,
5531 true);
5535 * SET command wrapped as a SQL callable function.
5537 Datum
5538 set_config_by_name(PG_FUNCTION_ARGS)
5540 char *name;
5541 char *value;
5542 char *new_value;
5543 bool is_local;
5545 if (PG_ARGISNULL(0))
5546 ereport(ERROR,
5547 (errcode(ERRCODE_NULL_VALUE_NOT_ALLOWED),
5548 errmsg("SET requires parameter name")));
5550 /* Get the GUC variable name */
5551 name = TextDatumGetCString(PG_GETARG_DATUM(0));
5553 /* Get the desired value or set to NULL for a reset request */
5554 if (PG_ARGISNULL(1))
5555 value = NULL;
5556 else
5557 value = TextDatumGetCString(PG_GETARG_DATUM(1));
5560 * Get the desired state of is_local. Default to false if provided value
5561 * is NULL
5563 if (PG_ARGISNULL(2))
5564 is_local = false;
5565 else
5566 is_local = PG_GETARG_BOOL(2);
5568 /* Note SET DEFAULT (argstring == NULL) is equivalent to RESET */
5569 set_config_option(name,
5570 value,
5571 (superuser() ? PGC_SUSET : PGC_USERSET),
5572 PGC_S_SESSION,
5573 is_local ? GUC_ACTION_LOCAL : GUC_ACTION_SET,
5574 true);
5576 /* get the new current value */
5577 new_value = GetConfigOptionByName(name, NULL);
5579 /* Convert return string to text */
5580 PG_RETURN_TEXT_P(cstring_to_text(new_value));
5585 * Common code for DefineCustomXXXVariable subroutines: allocate the
5586 * new variable's config struct and fill in generic fields.
5588 static struct config_generic *
5589 init_custom_variable(const char *name,
5590 const char *short_desc,
5591 const char *long_desc,
5592 GucContext context,
5593 int flags,
5594 enum config_type type,
5595 size_t sz)
5597 struct config_generic *gen;
5600 * Only allow custom PGC_POSTMASTER variables to be created during shared
5601 * library preload; any later than that, we can't ensure that the value
5602 * doesn't change after startup. This is a fatal elog if it happens; just
5603 * erroring out isn't safe because we don't know what the calling loadable
5604 * module might already have hooked into.
5606 if (context == PGC_POSTMASTER &&
5607 !process_shared_preload_libraries_in_progress)
5608 elog(FATAL, "cannot create PGC_POSTMASTER variables after startup");
5610 gen = (struct config_generic *) guc_malloc(ERROR, sz);
5611 memset(gen, 0, sz);
5613 gen->name = guc_strdup(ERROR, name);
5614 gen->context = context;
5615 gen->group = CUSTOM_OPTIONS;
5616 gen->short_desc = short_desc;
5617 gen->long_desc = long_desc;
5618 gen->flags = flags;
5619 gen->vartype = type;
5621 return gen;
5625 * Common code for DefineCustomXXXVariable subroutines: insert the new
5626 * variable into the GUC variable array, replacing any placeholder.
5628 static void
5629 define_custom_variable(struct config_generic * variable)
5631 const char *name = variable->name;
5632 const char **nameAddr = &name;
5633 const char *value;
5634 struct config_string *pHolder;
5635 GucContext phcontext;
5636 struct config_generic **res;
5639 * See if there's a placeholder by the same name.
5641 res = (struct config_generic **) bsearch((void *) &nameAddr,
5642 (void *) guc_variables,
5643 num_guc_variables,
5644 sizeof(struct config_generic *),
5645 guc_var_compare);
5646 if (res == NULL)
5649 * No placeholder to replace, so we can just add it ... but first,
5650 * make sure it's initialized to its default value.
5652 InitializeOneGUCOption(variable);
5653 add_guc_variable(variable, ERROR);
5654 return;
5658 * This better be a placeholder
5660 if (((*res)->flags & GUC_CUSTOM_PLACEHOLDER) == 0)
5661 ereport(ERROR,
5662 (errcode(ERRCODE_INTERNAL_ERROR),
5663 errmsg("attempt to redefine parameter \"%s\"", name)));
5665 Assert((*res)->vartype == PGC_STRING);
5666 pHolder = (struct config_string *) (*res);
5669 * First, set the variable to its default value. We must do this even
5670 * though we intend to immediately apply a new value, since it's possible
5671 * that the new value is invalid.
5673 InitializeOneGUCOption(variable);
5676 * Replace the placeholder. We aren't changing the name, so no re-sorting
5677 * is necessary
5679 *res = variable;
5682 * Infer context for assignment based on source of existing value. We
5683 * can't tell this with exact accuracy, but we can at least do something
5684 * reasonable in typical cases.
5686 switch (pHolder->gen.source)
5688 case PGC_S_DEFAULT:
5689 case PGC_S_ENV_VAR:
5690 case PGC_S_FILE:
5691 case PGC_S_ARGV:
5694 * If we got past the check in init_custom_variable, we can safely
5695 * assume that any existing value for a PGC_POSTMASTER variable
5696 * was set in postmaster context.
5698 if (variable->context == PGC_POSTMASTER)
5699 phcontext = PGC_POSTMASTER;
5700 else
5701 phcontext = PGC_SIGHUP;
5702 break;
5703 case PGC_S_DATABASE:
5704 case PGC_S_USER:
5705 case PGC_S_CLIENT:
5706 case PGC_S_SESSION:
5707 default:
5708 phcontext = PGC_USERSET;
5709 break;
5713 * Assign the string value stored in the placeholder to the real variable.
5715 * XXX this is not really good enough --- it should be a nontransactional
5716 * assignment, since we don't want it to roll back if the current xact
5717 * fails later. (Or do we?)
5719 value = *pHolder->variable;
5721 if (value)
5723 if (set_config_option(name, value,
5724 phcontext, pHolder->gen.source,
5725 GUC_ACTION_SET, true))
5727 /* Also copy over any saved source-location information */
5728 if (pHolder->gen.sourcefile)
5729 set_config_sourcefile(name, pHolder->gen.sourcefile,
5730 pHolder->gen.sourceline);
5735 * Free up as much as we conveniently can of the placeholder structure
5736 * (this neglects any stack items...)
5738 set_string_field(pHolder, pHolder->variable, NULL);
5739 set_string_field(pHolder, &pHolder->reset_val, NULL);
5741 free(pHolder);
5744 void
5745 DefineCustomBoolVariable(const char *name,
5746 const char *short_desc,
5747 const char *long_desc,
5748 bool *valueAddr,
5749 bool bootValue,
5750 GucContext context,
5751 int flags,
5752 GucBoolAssignHook assign_hook,
5753 GucShowHook show_hook)
5755 struct config_bool *var;
5757 var = (struct config_bool *)
5758 init_custom_variable(name, short_desc, long_desc, context, flags,
5759 PGC_BOOL, sizeof(struct config_bool));
5760 var->variable = valueAddr;
5761 var->boot_val = bootValue;
5762 var->reset_val = bootValue;
5763 var->assign_hook = assign_hook;
5764 var->show_hook = show_hook;
5765 define_custom_variable(&var->gen);
5768 void
5769 DefineCustomIntVariable(const char *name,
5770 const char *short_desc,
5771 const char *long_desc,
5772 int *valueAddr,
5773 int bootValue,
5774 int minValue,
5775 int maxValue,
5776 GucContext context,
5777 int flags,
5778 GucIntAssignHook assign_hook,
5779 GucShowHook show_hook)
5781 struct config_int *var;
5783 var = (struct config_int *)
5784 init_custom_variable(name, short_desc, long_desc, context, flags,
5785 PGC_INT, sizeof(struct config_int));
5786 var->variable = valueAddr;
5787 var->boot_val = bootValue;
5788 var->reset_val = bootValue;
5789 var->min = minValue;
5790 var->max = maxValue;
5791 var->assign_hook = assign_hook;
5792 var->show_hook = show_hook;
5793 define_custom_variable(&var->gen);
5796 void
5797 DefineCustomRealVariable(const char *name,
5798 const char *short_desc,
5799 const char *long_desc,
5800 double *valueAddr,
5801 double bootValue,
5802 double minValue,
5803 double maxValue,
5804 GucContext context,
5805 int flags,
5806 GucRealAssignHook assign_hook,
5807 GucShowHook show_hook)
5809 struct config_real *var;
5811 var = (struct config_real *)
5812 init_custom_variable(name, short_desc, long_desc, context, flags,
5813 PGC_REAL, sizeof(struct config_real));
5814 var->variable = valueAddr;
5815 var->boot_val = bootValue;
5816 var->reset_val = bootValue;
5817 var->min = minValue;
5818 var->max = maxValue;
5819 var->assign_hook = assign_hook;
5820 var->show_hook = show_hook;
5821 define_custom_variable(&var->gen);
5824 void
5825 DefineCustomStringVariable(const char *name,
5826 const char *short_desc,
5827 const char *long_desc,
5828 char **valueAddr,
5829 const char *bootValue,
5830 GucContext context,
5831 int flags,
5832 GucStringAssignHook assign_hook,
5833 GucShowHook show_hook)
5835 struct config_string *var;
5837 var = (struct config_string *)
5838 init_custom_variable(name, short_desc, long_desc, context, flags,
5839 PGC_STRING, sizeof(struct config_string));
5840 var->variable = valueAddr;
5841 var->boot_val = bootValue;
5842 /* we could probably do without strdup, but keep it like normal case */
5843 if (var->boot_val)
5844 var->reset_val = guc_strdup(ERROR, var->boot_val);
5845 var->assign_hook = assign_hook;
5846 var->show_hook = show_hook;
5847 define_custom_variable(&var->gen);
5850 void
5851 DefineCustomEnumVariable(const char *name,
5852 const char *short_desc,
5853 const char *long_desc,
5854 int *valueAddr,
5855 int bootValue,
5856 const struct config_enum_entry * options,
5857 GucContext context,
5858 int flags,
5859 GucEnumAssignHook assign_hook,
5860 GucShowHook show_hook)
5862 struct config_enum *var;
5864 var = (struct config_enum *)
5865 init_custom_variable(name, short_desc, long_desc, context, flags,
5866 PGC_ENUM, sizeof(struct config_enum));
5867 var->variable = valueAddr;
5868 var->boot_val = bootValue;
5869 var->reset_val = bootValue;
5870 var->options = options;
5871 var->assign_hook = assign_hook;
5872 var->show_hook = show_hook;
5873 define_custom_variable(&var->gen);
5876 void
5877 EmitWarningsOnPlaceholders(const char *className)
5879 int classLen = strlen(className);
5880 int i;
5882 for (i = 0; i < num_guc_variables; i++)
5884 struct config_generic *var = guc_variables[i];
5886 if ((var->flags & GUC_CUSTOM_PLACEHOLDER) != 0 &&
5887 strncmp(className, var->name, classLen) == 0 &&
5888 var->name[classLen] == GUC_QUALIFIER_SEPARATOR)
5890 ereport(WARNING,
5891 (errcode(ERRCODE_UNDEFINED_OBJECT),
5892 errmsg("unrecognized configuration parameter \"%s\"",
5893 var->name)));
5900 * SHOW command
5902 void
5903 GetPGVariable(const char *name, DestReceiver *dest)
5905 if (guc_name_compare(name, "all") == 0)
5906 ShowAllGUCConfig(dest);
5907 else
5908 ShowGUCConfigOption(name, dest);
5911 TupleDesc
5912 GetPGVariableResultDesc(const char *name)
5914 TupleDesc tupdesc;
5916 if (guc_name_compare(name, "all") == 0)
5918 /* need a tuple descriptor representing three TEXT columns */
5919 tupdesc = CreateTemplateTupleDesc(3, false);
5920 TupleDescInitEntry(tupdesc, (AttrNumber) 1, "name",
5921 TEXTOID, -1, 0);
5922 TupleDescInitEntry(tupdesc, (AttrNumber) 2, "setting",
5923 TEXTOID, -1, 0);
5924 TupleDescInitEntry(tupdesc, (AttrNumber) 3, "description",
5925 TEXTOID, -1, 0);
5927 else
5929 const char *varname;
5931 /* Get the canonical spelling of name */
5932 (void) GetConfigOptionByName(name, &varname);
5934 /* need a tuple descriptor representing a single TEXT column */
5935 tupdesc = CreateTemplateTupleDesc(1, false);
5936 TupleDescInitEntry(tupdesc, (AttrNumber) 1, varname,
5937 TEXTOID, -1, 0);
5939 return tupdesc;
5944 * SHOW command
5946 static void
5947 ShowGUCConfigOption(const char *name, DestReceiver *dest)
5949 TupOutputState *tstate;
5950 TupleDesc tupdesc;
5951 const char *varname;
5952 char *value;
5954 /* Get the value and canonical spelling of name */
5955 value = GetConfigOptionByName(name, &varname);
5957 /* need a tuple descriptor representing a single TEXT column */
5958 tupdesc = CreateTemplateTupleDesc(1, false);
5959 TupleDescInitEntry(tupdesc, (AttrNumber) 1, varname,
5960 TEXTOID, -1, 0);
5962 /* prepare for projection of tuples */
5963 tstate = begin_tup_output_tupdesc(dest, tupdesc);
5965 /* Send it */
5966 do_text_output_oneline(tstate, value);
5968 end_tup_output(tstate);
5972 * SHOW ALL command
5974 static void
5975 ShowAllGUCConfig(DestReceiver *dest)
5977 bool am_superuser = superuser();
5978 int i;
5979 TupOutputState *tstate;
5980 TupleDesc tupdesc;
5981 char *values[3];
5983 /* need a tuple descriptor representing three TEXT columns */
5984 tupdesc = CreateTemplateTupleDesc(3, false);
5985 TupleDescInitEntry(tupdesc, (AttrNumber) 1, "name",
5986 TEXTOID, -1, 0);
5987 TupleDescInitEntry(tupdesc, (AttrNumber) 2, "setting",
5988 TEXTOID, -1, 0);
5989 TupleDescInitEntry(tupdesc, (AttrNumber) 3, "description",
5990 TEXTOID, -1, 0);
5993 /* prepare for projection of tuples */
5994 tstate = begin_tup_output_tupdesc(dest, tupdesc);
5996 for (i = 0; i < num_guc_variables; i++)
5998 struct config_generic *conf = guc_variables[i];
6000 if ((conf->flags & GUC_NO_SHOW_ALL) ||
6001 ((conf->flags & GUC_SUPERUSER_ONLY) && !am_superuser))
6002 continue;
6004 /* assign to the values array */
6005 values[0] = (char *) conf->name;
6006 values[1] = _ShowOption(conf, true);
6007 values[2] = (char *) conf->short_desc;
6009 /* send it to dest */
6010 do_tup_output(tstate, values);
6012 /* clean up */
6013 if (values[1] != NULL)
6014 pfree(values[1]);
6017 end_tup_output(tstate);
6021 * Return GUC variable value by name; optionally return canonical
6022 * form of name. Return value is palloc'd.
6024 char *
6025 GetConfigOptionByName(const char *name, const char **varname)
6027 struct config_generic *record;
6029 record = find_option(name, false, ERROR);
6030 if (record == NULL)
6031 ereport(ERROR,
6032 (errcode(ERRCODE_UNDEFINED_OBJECT),
6033 errmsg("unrecognized configuration parameter \"%s\"", name)));
6034 if ((record->flags & GUC_SUPERUSER_ONLY) && !superuser())
6035 ereport(ERROR,
6036 (errcode(ERRCODE_INSUFFICIENT_PRIVILEGE),
6037 errmsg("must be superuser to examine \"%s\"", name)));
6039 if (varname)
6040 *varname = record->name;
6042 return _ShowOption(record, true);
6046 * Return GUC variable value by variable number; optionally return canonical
6047 * form of name. Return value is palloc'd.
6049 void
6050 GetConfigOptionByNum(int varnum, const char **values, bool *noshow)
6052 char buffer[256];
6053 struct config_generic *conf;
6055 /* check requested variable number valid */
6056 Assert((varnum >= 0) && (varnum < num_guc_variables));
6058 conf = guc_variables[varnum];
6060 if (noshow)
6062 if ((conf->flags & GUC_NO_SHOW_ALL) ||
6063 ((conf->flags & GUC_SUPERUSER_ONLY) && !superuser()))
6064 *noshow = true;
6065 else
6066 *noshow = false;
6069 /* first get the generic attributes */
6071 /* name */
6072 values[0] = conf->name;
6074 /* setting : use _ShowOption in order to avoid duplicating the logic */
6075 values[1] = _ShowOption(conf, false);
6077 /* unit */
6078 if (conf->vartype == PGC_INT)
6080 static char buf[8];
6082 switch (conf->flags & (GUC_UNIT_MEMORY | GUC_UNIT_TIME))
6084 case GUC_UNIT_KB:
6085 values[2] = "kB";
6086 break;
6087 case GUC_UNIT_BLOCKS:
6088 snprintf(buf, sizeof(buf), "%dkB", BLCKSZ / 1024);
6089 values[2] = buf;
6090 break;
6091 case GUC_UNIT_XBLOCKS:
6092 snprintf(buf, sizeof(buf), "%dkB", XLOG_BLCKSZ / 1024);
6093 values[2] = buf;
6094 break;
6095 case GUC_UNIT_MS:
6096 values[2] = "ms";
6097 break;
6098 case GUC_UNIT_S:
6099 values[2] = "s";
6100 break;
6101 case GUC_UNIT_MIN:
6102 values[2] = "min";
6103 break;
6104 default:
6105 values[2] = "";
6106 break;
6109 else
6110 values[2] = NULL;
6112 /* group */
6113 values[3] = config_group_names[conf->group];
6115 /* short_desc */
6116 values[4] = conf->short_desc;
6118 /* extra_desc */
6119 values[5] = conf->long_desc;
6121 /* context */
6122 values[6] = GucContext_Names[conf->context];
6124 /* vartype */
6125 values[7] = config_type_names[conf->vartype];
6127 /* source */
6128 values[8] = GucSource_Names[conf->source];
6130 /* now get the type specifc attributes */
6131 switch (conf->vartype)
6133 case PGC_BOOL:
6135 struct config_bool *lconf = (struct config_bool *) conf;
6137 /* min_val */
6138 values[9] = NULL;
6140 /* max_val */
6141 values[10] = NULL;
6143 /* enumvals */
6144 values[11] = NULL;
6146 /* boot_val */
6147 values[12] = pstrdup(lconf->boot_val ? "on" : "off");
6149 /* reset_val */
6150 values[13] = pstrdup(lconf->reset_val ? "on" : "off");
6152 break;
6154 case PGC_INT:
6156 struct config_int *lconf = (struct config_int *) conf;
6158 /* min_val */
6159 snprintf(buffer, sizeof(buffer), "%d", lconf->min);
6160 values[9] = pstrdup(buffer);
6162 /* max_val */
6163 snprintf(buffer, sizeof(buffer), "%d", lconf->max);
6164 values[10] = pstrdup(buffer);
6166 /* enumvals */
6167 values[11] = NULL;
6169 /* boot_val */
6170 snprintf(buffer, sizeof(buffer), "%d", lconf->boot_val);
6171 values[12] = pstrdup(buffer);
6173 /* reset_val */
6174 snprintf(buffer, sizeof(buffer), "%d", lconf->reset_val);
6175 values[13] = pstrdup(buffer);
6177 break;
6179 case PGC_REAL:
6181 struct config_real *lconf = (struct config_real *) conf;
6183 /* min_val */
6184 snprintf(buffer, sizeof(buffer), "%g", lconf->min);
6185 values[9] = pstrdup(buffer);
6187 /* max_val */
6188 snprintf(buffer, sizeof(buffer), "%g", lconf->max);
6189 values[10] = pstrdup(buffer);
6191 /* enumvals */
6192 values[11] = NULL;
6194 /* boot_val */
6195 snprintf(buffer, sizeof(buffer), "%g", lconf->boot_val);
6196 values[12] = pstrdup(buffer);
6198 /* reset_val */
6199 snprintf(buffer, sizeof(buffer), "%g", lconf->reset_val);
6200 values[13] = pstrdup(buffer);
6202 break;
6204 case PGC_STRING:
6206 struct config_string *lconf = (struct config_string *) conf;
6208 /* min_val */
6209 values[9] = NULL;
6211 /* max_val */
6212 values[10] = NULL;
6214 /* enumvals */
6215 values[11] = NULL;
6217 /* boot_val */
6218 if (lconf->boot_val == NULL)
6219 values[12] = NULL;
6220 else
6221 values[12] = pstrdup(lconf->boot_val);
6223 /* reset_val */
6224 if (lconf->reset_val == NULL)
6225 values[13] = NULL;
6226 else
6227 values[13] = pstrdup(lconf->reset_val);
6229 break;
6231 case PGC_ENUM:
6233 struct config_enum *lconf = (struct config_enum *) conf;
6235 /* min_val */
6236 values[9] = NULL;
6238 /* max_val */
6239 values[10] = NULL;
6241 /* enumvals */
6244 * NOTE! enumvals with double quotes in them are not
6245 * supported!
6247 values[11] = config_enum_get_options((struct config_enum *) conf,
6248 "{\"", "\"}", "\",\"");
6250 /* boot_val */
6251 values[12] = pstrdup(config_enum_lookup_by_value(lconf,
6252 lconf->boot_val));
6254 /* reset_val */
6255 values[13] = pstrdup(config_enum_lookup_by_value(lconf,
6256 lconf->reset_val));
6258 break;
6260 default:
6263 * should never get here, but in case we do, set 'em to NULL
6266 /* min_val */
6267 values[9] = NULL;
6269 /* max_val */
6270 values[10] = NULL;
6272 /* enumvals */
6273 values[11] = NULL;
6275 /* boot_val */
6276 values[12] = NULL;
6278 /* reset_val */
6279 values[13] = NULL;
6281 break;
6285 * If the setting came from a config file, set the source location. For
6286 * security reasons, we don't show source file/line number for
6287 * non-superusers.
6289 if (conf->source == PGC_S_FILE && superuser())
6291 values[14] = conf->sourcefile;
6292 snprintf(buffer, sizeof(buffer), "%d", conf->sourceline);
6293 values[15] = pstrdup(buffer);
6295 else
6297 values[14] = NULL;
6298 values[15] = NULL;
6303 * Return the total number of GUC variables
6306 GetNumConfigOptions(void)
6308 return num_guc_variables;
6312 * show_config_by_name - equiv to SHOW X command but implemented as
6313 * a function.
6315 Datum
6316 show_config_by_name(PG_FUNCTION_ARGS)
6318 char *varname;
6319 char *varval;
6321 /* Get the GUC variable name */
6322 varname = TextDatumGetCString(PG_GETARG_DATUM(0));
6324 /* Get the value */
6325 varval = GetConfigOptionByName(varname, NULL);
6327 /* Convert to text */
6328 PG_RETURN_TEXT_P(cstring_to_text(varval));
6332 * show_all_settings - equiv to SHOW ALL command but implemented as
6333 * a Table Function.
6335 #define NUM_PG_SETTINGS_ATTS 16
6337 Datum
6338 show_all_settings(PG_FUNCTION_ARGS)
6340 FuncCallContext *funcctx;
6341 TupleDesc tupdesc;
6342 int call_cntr;
6343 int max_calls;
6344 AttInMetadata *attinmeta;
6345 MemoryContext oldcontext;
6347 /* stuff done only on the first call of the function */
6348 if (SRF_IS_FIRSTCALL())
6350 /* create a function context for cross-call persistence */
6351 funcctx = SRF_FIRSTCALL_INIT();
6354 * switch to memory context appropriate for multiple function calls
6356 oldcontext = MemoryContextSwitchTo(funcctx->multi_call_memory_ctx);
6359 * need a tuple descriptor representing NUM_PG_SETTINGS_ATTS columns
6360 * of the appropriate types
6362 tupdesc = CreateTemplateTupleDesc(NUM_PG_SETTINGS_ATTS, false);
6363 TupleDescInitEntry(tupdesc, (AttrNumber) 1, "name",
6364 TEXTOID, -1, 0);
6365 TupleDescInitEntry(tupdesc, (AttrNumber) 2, "setting",
6366 TEXTOID, -1, 0);
6367 TupleDescInitEntry(tupdesc, (AttrNumber) 3, "unit",
6368 TEXTOID, -1, 0);
6369 TupleDescInitEntry(tupdesc, (AttrNumber) 4, "category",
6370 TEXTOID, -1, 0);
6371 TupleDescInitEntry(tupdesc, (AttrNumber) 5, "short_desc",
6372 TEXTOID, -1, 0);
6373 TupleDescInitEntry(tupdesc, (AttrNumber) 6, "extra_desc",
6374 TEXTOID, -1, 0);
6375 TupleDescInitEntry(tupdesc, (AttrNumber) 7, "context",
6376 TEXTOID, -1, 0);
6377 TupleDescInitEntry(tupdesc, (AttrNumber) 8, "vartype",
6378 TEXTOID, -1, 0);
6379 TupleDescInitEntry(tupdesc, (AttrNumber) 9, "source",
6380 TEXTOID, -1, 0);
6381 TupleDescInitEntry(tupdesc, (AttrNumber) 10, "min_val",
6382 TEXTOID, -1, 0);
6383 TupleDescInitEntry(tupdesc, (AttrNumber) 11, "max_val",
6384 TEXTOID, -1, 0);
6385 TupleDescInitEntry(tupdesc, (AttrNumber) 12, "enumvals",
6386 TEXTARRAYOID, -1, 0);
6387 TupleDescInitEntry(tupdesc, (AttrNumber) 13, "boot_val",
6388 TEXTOID, -1, 0);
6389 TupleDescInitEntry(tupdesc, (AttrNumber) 14, "reset_val",
6390 TEXTOID, -1, 0);
6391 TupleDescInitEntry(tupdesc, (AttrNumber) 15, "sourcefile",
6392 TEXTOID, -1, 0);
6393 TupleDescInitEntry(tupdesc, (AttrNumber) 16, "sourceline",
6394 INT4OID, -1, 0);
6397 * Generate attribute metadata needed later to produce tuples from raw
6398 * C strings
6400 attinmeta = TupleDescGetAttInMetadata(tupdesc);
6401 funcctx->attinmeta = attinmeta;
6403 /* total number of tuples to be returned */
6404 funcctx->max_calls = GetNumConfigOptions();
6406 MemoryContextSwitchTo(oldcontext);
6409 /* stuff done on every call of the function */
6410 funcctx = SRF_PERCALL_SETUP();
6412 call_cntr = funcctx->call_cntr;
6413 max_calls = funcctx->max_calls;
6414 attinmeta = funcctx->attinmeta;
6416 if (call_cntr < max_calls) /* do when there is more left to send */
6418 char *values[NUM_PG_SETTINGS_ATTS];
6419 bool noshow;
6420 HeapTuple tuple;
6421 Datum result;
6424 * Get the next visible GUC variable name and value
6428 GetConfigOptionByNum(call_cntr, (const char **) values, &noshow);
6429 if (noshow)
6431 /* bump the counter and get the next config setting */
6432 call_cntr = ++funcctx->call_cntr;
6434 /* make sure we haven't gone too far now */
6435 if (call_cntr >= max_calls)
6436 SRF_RETURN_DONE(funcctx);
6438 } while (noshow);
6440 /* build a tuple */
6441 tuple = BuildTupleFromCStrings(attinmeta, values);
6443 /* make the tuple into a datum */
6444 result = HeapTupleGetDatum(tuple);
6446 SRF_RETURN_NEXT(funcctx, result);
6448 else
6450 /* do when there is no more left */
6451 SRF_RETURN_DONE(funcctx);
6455 static char *
6456 _ShowOption(struct config_generic * record, bool use_units)
6458 char buffer[256];
6459 const char *val;
6461 switch (record->vartype)
6463 case PGC_BOOL:
6465 struct config_bool *conf = (struct config_bool *) record;
6467 if (conf->show_hook)
6468 val = (*conf->show_hook) ();
6469 else
6470 val = *conf->variable ? "on" : "off";
6472 break;
6474 case PGC_INT:
6476 struct config_int *conf = (struct config_int *) record;
6478 if (conf->show_hook)
6479 val = (*conf->show_hook) ();
6480 else
6483 * Use int64 arithmetic to avoid overflows in units
6484 * conversion. If INT64_IS_BUSTED we might overflow
6485 * anyway and print bogus answers, but there are few
6486 * enough such machines that it doesn't seem worth trying
6487 * harder.
6489 int64 result = *conf->variable;
6490 const char *unit;
6492 if (use_units && result > 0 &&
6493 (record->flags & GUC_UNIT_MEMORY))
6495 switch (record->flags & GUC_UNIT_MEMORY)
6497 case GUC_UNIT_BLOCKS:
6498 result *= BLCKSZ / 1024;
6499 break;
6500 case GUC_UNIT_XBLOCKS:
6501 result *= XLOG_BLCKSZ / 1024;
6502 break;
6505 if (result % KB_PER_GB == 0)
6507 result /= KB_PER_GB;
6508 unit = "GB";
6510 else if (result % KB_PER_MB == 0)
6512 result /= KB_PER_MB;
6513 unit = "MB";
6515 else
6517 unit = "kB";
6520 else if (use_units && result > 0 &&
6521 (record->flags & GUC_UNIT_TIME))
6523 switch (record->flags & GUC_UNIT_TIME)
6525 case GUC_UNIT_S:
6526 result *= MS_PER_S;
6527 break;
6528 case GUC_UNIT_MIN:
6529 result *= MS_PER_MIN;
6530 break;
6533 if (result % MS_PER_D == 0)
6535 result /= MS_PER_D;
6536 unit = "d";
6538 else if (result % MS_PER_H == 0)
6540 result /= MS_PER_H;
6541 unit = "h";
6543 else if (result % MS_PER_MIN == 0)
6545 result /= MS_PER_MIN;
6546 unit = "min";
6548 else if (result % MS_PER_S == 0)
6550 result /= MS_PER_S;
6551 unit = "s";
6553 else
6555 unit = "ms";
6558 else
6559 unit = "";
6561 snprintf(buffer, sizeof(buffer), INT64_FORMAT "%s",
6562 result, unit);
6563 val = buffer;
6566 break;
6568 case PGC_REAL:
6570 struct config_real *conf = (struct config_real *) record;
6572 if (conf->show_hook)
6573 val = (*conf->show_hook) ();
6574 else
6576 snprintf(buffer, sizeof(buffer), "%g",
6577 *conf->variable);
6578 val = buffer;
6581 break;
6583 case PGC_STRING:
6585 struct config_string *conf = (struct config_string *) record;
6587 if (conf->show_hook)
6588 val = (*conf->show_hook) ();
6589 else if (*conf->variable && **conf->variable)
6590 val = *conf->variable;
6591 else
6592 val = "";
6594 break;
6596 case PGC_ENUM:
6598 struct config_enum *conf = (struct config_enum *) record;
6600 if (conf->show_hook)
6601 val = (*conf->show_hook) ();
6602 else
6603 val = config_enum_lookup_by_value(conf, *conf->variable);
6605 break;
6607 default:
6608 /* just to keep compiler quiet */
6609 val = "???";
6610 break;
6613 return pstrdup(val);
6618 * Attempt (badly) to detect if a proposed new GUC setting is the same
6619 * as the current value.
6621 * XXX this does not really work because it doesn't account for the
6622 * effects of canonicalization of string values by assign_hooks.
6624 static bool
6625 is_newvalue_equal(struct config_generic * record, const char *newvalue)
6627 /* newvalue == NULL isn't supported */
6628 Assert(newvalue != NULL);
6630 switch (record->vartype)
6632 case PGC_BOOL:
6634 struct config_bool *conf = (struct config_bool *) record;
6635 bool newval;
6637 return parse_bool(newvalue, &newval)
6638 && *conf->variable == newval;
6640 case PGC_INT:
6642 struct config_int *conf = (struct config_int *) record;
6643 int newval;
6645 return parse_int(newvalue, &newval, record->flags, NULL)
6646 && *conf->variable == newval;
6648 case PGC_REAL:
6650 struct config_real *conf = (struct config_real *) record;
6651 double newval;
6653 return parse_real(newvalue, &newval)
6654 && *conf->variable == newval;
6656 case PGC_STRING:
6658 struct config_string *conf = (struct config_string *) record;
6660 return *conf->variable != NULL &&
6661 strcmp(*conf->variable, newvalue) == 0;
6664 case PGC_ENUM:
6666 struct config_enum *conf = (struct config_enum *) record;
6667 int newval;
6669 return config_enum_lookup_by_name(conf, newvalue, &newval) &&
6670 *conf->variable == newval;
6674 return false;
6678 #ifdef EXEC_BACKEND
6681 * These routines dump out all non-default GUC options into a binary
6682 * file that is read by all exec'ed backends. The format is:
6684 * variable name, string, null terminated
6685 * variable value, string, null terminated
6686 * variable source, integer
6688 static void
6689 write_one_nondefault_variable(FILE *fp, struct config_generic * gconf)
6691 if (gconf->source == PGC_S_DEFAULT)
6692 return;
6694 fprintf(fp, "%s", gconf->name);
6695 fputc(0, fp);
6697 switch (gconf->vartype)
6699 case PGC_BOOL:
6701 struct config_bool *conf = (struct config_bool *) gconf;
6703 if (*conf->variable)
6704 fprintf(fp, "true");
6705 else
6706 fprintf(fp, "false");
6708 break;
6710 case PGC_INT:
6712 struct config_int *conf = (struct config_int *) gconf;
6714 fprintf(fp, "%d", *conf->variable);
6716 break;
6718 case PGC_REAL:
6720 struct config_real *conf = (struct config_real *) gconf;
6722 /* Could lose precision here? */
6723 fprintf(fp, "%f", *conf->variable);
6725 break;
6727 case PGC_STRING:
6729 struct config_string *conf = (struct config_string *) gconf;
6731 fprintf(fp, "%s", *conf->variable);
6733 break;
6735 case PGC_ENUM:
6737 struct config_enum *conf = (struct config_enum *) gconf;
6739 fprintf(fp, "%s",
6740 config_enum_lookup_by_value(conf, *conf->variable));
6742 break;
6745 fputc(0, fp);
6747 fwrite(&gconf->source, sizeof(gconf->source), 1, fp);
6750 void
6751 write_nondefault_variables(GucContext context)
6753 int elevel;
6754 FILE *fp;
6755 struct config_generic *cvc_conf;
6756 int i;
6758 Assert(context == PGC_POSTMASTER || context == PGC_SIGHUP);
6760 elevel = (context == PGC_SIGHUP) ? LOG : ERROR;
6763 * Open file
6765 fp = AllocateFile(CONFIG_EXEC_PARAMS_NEW, "w");
6766 if (!fp)
6768 ereport(elevel,
6769 (errcode_for_file_access(),
6770 errmsg("could not write to file \"%s\": %m",
6771 CONFIG_EXEC_PARAMS_NEW)));
6772 return;
6776 * custom_variable_classes must be written out first; otherwise we might
6777 * reject custom variable values while reading the file.
6779 cvc_conf = find_option("custom_variable_classes", false, ERROR);
6780 if (cvc_conf)
6781 write_one_nondefault_variable(fp, cvc_conf);
6783 for (i = 0; i < num_guc_variables; i++)
6785 struct config_generic *gconf = guc_variables[i];
6787 if (gconf != cvc_conf)
6788 write_one_nondefault_variable(fp, gconf);
6791 if (FreeFile(fp))
6793 ereport(elevel,
6794 (errcode_for_file_access(),
6795 errmsg("could not write to file \"%s\": %m",
6796 CONFIG_EXEC_PARAMS_NEW)));
6797 return;
6801 * Put new file in place. This could delay on Win32, but we don't hold
6802 * any exclusive locks.
6804 rename(CONFIG_EXEC_PARAMS_NEW, CONFIG_EXEC_PARAMS);
6809 * Read string, including null byte from file
6811 * Return NULL on EOF and nothing read
6813 static char *
6814 read_string_with_null(FILE *fp)
6816 int i = 0,
6818 maxlen = 256;
6819 char *str = NULL;
6823 if ((ch = fgetc(fp)) == EOF)
6825 if (i == 0)
6826 return NULL;
6827 else
6828 elog(FATAL, "invalid format of exec config params file");
6830 if (i == 0)
6831 str = guc_malloc(FATAL, maxlen);
6832 else if (i == maxlen)
6833 str = guc_realloc(FATAL, str, maxlen *= 2);
6834 str[i++] = ch;
6835 } while (ch != 0);
6837 return str;
6842 * This routine loads a previous postmaster dump of its non-default
6843 * settings.
6845 void
6846 read_nondefault_variables(void)
6848 FILE *fp;
6849 char *varname,
6850 *varvalue;
6851 int varsource;
6854 * Open file
6856 fp = AllocateFile(CONFIG_EXEC_PARAMS, "r");
6857 if (!fp)
6859 /* File not found is fine */
6860 if (errno != ENOENT)
6861 ereport(FATAL,
6862 (errcode_for_file_access(),
6863 errmsg("could not read from file \"%s\": %m",
6864 CONFIG_EXEC_PARAMS)));
6865 return;
6868 for (;;)
6870 struct config_generic *record;
6872 if ((varname = read_string_with_null(fp)) == NULL)
6873 break;
6875 if ((record = find_option(varname, true, FATAL)) == NULL)
6876 elog(FATAL, "failed to locate variable %s in exec config params file", varname);
6877 if ((varvalue = read_string_with_null(fp)) == NULL)
6878 elog(FATAL, "invalid format of exec config params file");
6879 if (fread(&varsource, sizeof(varsource), 1, fp) == 0)
6880 elog(FATAL, "invalid format of exec config params file");
6882 (void) set_config_option(varname, varvalue, record->context,
6883 varsource, GUC_ACTION_SET, true);
6884 free(varname);
6885 free(varvalue);
6888 FreeFile(fp);
6890 #endif /* EXEC_BACKEND */
6894 * A little "long argument" simulation, although not quite GNU
6895 * compliant. Takes a string of the form "some-option=some value" and
6896 * returns name = "some_option" and value = "some value" in malloc'ed
6897 * storage. Note that '-' is converted to '_' in the option name. If
6898 * there is no '=' in the input string then value will be NULL.
6900 void
6901 ParseLongOption(const char *string, char **name, char **value)
6903 size_t equal_pos;
6904 char *cp;
6906 AssertArg(string);
6907 AssertArg(name);
6908 AssertArg(value);
6910 equal_pos = strcspn(string, "=");
6912 if (string[equal_pos] == '=')
6914 *name = guc_malloc(FATAL, equal_pos + 1);
6915 strlcpy(*name, string, equal_pos + 1);
6917 *value = guc_strdup(FATAL, &string[equal_pos + 1]);
6919 else
6921 /* no equal sign in string */
6922 *name = guc_strdup(FATAL, string);
6923 *value = NULL;
6926 for (cp = *name; *cp; cp++)
6927 if (*cp == '-')
6928 *cp = '_';
6933 * Handle options fetched from pg_database.datconfig, pg_authid.rolconfig,
6934 * pg_proc.proconfig, etc. Caller must specify proper context/source/action.
6936 * The array parameter must be an array of TEXT (it must not be NULL).
6938 void
6939 ProcessGUCArray(ArrayType *array,
6940 GucContext context, GucSource source, GucAction action)
6942 int i;
6944 Assert(array != NULL);
6945 Assert(ARR_ELEMTYPE(array) == TEXTOID);
6946 Assert(ARR_NDIM(array) == 1);
6947 Assert(ARR_LBOUND(array)[0] == 1);
6949 for (i = 1; i <= ARR_DIMS(array)[0]; i++)
6951 Datum d;
6952 bool isnull;
6953 char *s;
6954 char *name;
6955 char *value;
6957 d = array_ref(array, 1, &i,
6958 -1 /* varlenarray */ ,
6959 -1 /* TEXT's typlen */ ,
6960 false /* TEXT's typbyval */ ,
6961 'i' /* TEXT's typalign */ ,
6962 &isnull);
6964 if (isnull)
6965 continue;
6967 s = TextDatumGetCString(d);
6969 ParseLongOption(s, &name, &value);
6970 if (!value)
6972 ereport(WARNING,
6973 (errcode(ERRCODE_SYNTAX_ERROR),
6974 errmsg("could not parse setting for parameter \"%s\"",
6975 name)));
6976 free(name);
6977 continue;
6980 (void) set_config_option(name, value, context, source, action, true);
6982 free(name);
6983 if (value)
6984 free(value);
6990 * Add an entry to an option array. The array parameter may be NULL
6991 * to indicate the current table entry is NULL.
6993 ArrayType *
6994 GUCArrayAdd(ArrayType *array, const char *name, const char *value)
6996 const char *varname;
6997 Datum datum;
6998 char *newval;
6999 ArrayType *a;
7001 Assert(name);
7002 Assert(value);
7004 /* test if the option is valid */
7005 set_config_option(name, value,
7006 superuser() ? PGC_SUSET : PGC_USERSET,
7007 PGC_S_TEST, GUC_ACTION_SET, false);
7009 /* convert name to canonical spelling, so we can use plain strcmp */
7010 (void) GetConfigOptionByName(name, &varname);
7011 name = varname;
7013 newval = palloc(strlen(name) + 1 + strlen(value) + 1);
7014 sprintf(newval, "%s=%s", name, value);
7015 datum = CStringGetTextDatum(newval);
7017 if (array)
7019 int index;
7020 bool isnull;
7021 int i;
7023 Assert(ARR_ELEMTYPE(array) == TEXTOID);
7024 Assert(ARR_NDIM(array) == 1);
7025 Assert(ARR_LBOUND(array)[0] == 1);
7027 index = ARR_DIMS(array)[0] + 1; /* add after end */
7029 for (i = 1; i <= ARR_DIMS(array)[0]; i++)
7031 Datum d;
7032 char *current;
7034 d = array_ref(array, 1, &i,
7035 -1 /* varlenarray */ ,
7036 -1 /* TEXT's typlen */ ,
7037 false /* TEXT's typbyval */ ,
7038 'i' /* TEXT's typalign */ ,
7039 &isnull);
7040 if (isnull)
7041 continue;
7042 current = TextDatumGetCString(d);
7043 if (strncmp(current, newval, strlen(name) + 1) == 0)
7045 index = i;
7046 break;
7050 a = array_set(array, 1, &index,
7051 datum,
7052 false,
7053 -1 /* varlena array */ ,
7054 -1 /* TEXT's typlen */ ,
7055 false /* TEXT's typbyval */ ,
7056 'i' /* TEXT's typalign */ );
7058 else
7059 a = construct_array(&datum, 1,
7060 TEXTOID,
7061 -1, false, 'i');
7063 return a;
7068 * Delete an entry from an option array. The array parameter may be NULL
7069 * to indicate the current table entry is NULL. Also, if the return value
7070 * is NULL then a null should be stored.
7072 ArrayType *
7073 GUCArrayDelete(ArrayType *array, const char *name)
7075 const char *varname;
7076 ArrayType *newarray;
7077 int i;
7078 int index;
7080 Assert(name);
7082 /* test if the option is valid */
7083 set_config_option(name, NULL,
7084 superuser() ? PGC_SUSET : PGC_USERSET,
7085 PGC_S_TEST, GUC_ACTION_SET, false);
7087 /* convert name to canonical spelling, so we can use plain strcmp */
7088 (void) GetConfigOptionByName(name, &varname);
7089 name = varname;
7091 /* if array is currently null, then surely nothing to delete */
7092 if (!array)
7093 return NULL;
7095 newarray = NULL;
7096 index = 1;
7098 for (i = 1; i <= ARR_DIMS(array)[0]; i++)
7100 Datum d;
7101 char *val;
7102 bool isnull;
7104 d = array_ref(array, 1, &i,
7105 -1 /* varlenarray */ ,
7106 -1 /* TEXT's typlen */ ,
7107 false /* TEXT's typbyval */ ,
7108 'i' /* TEXT's typalign */ ,
7109 &isnull);
7110 if (isnull)
7111 continue;
7112 val = TextDatumGetCString(d);
7114 /* ignore entry if it's what we want to delete */
7115 if (strncmp(val, name, strlen(name)) == 0
7116 && val[strlen(name)] == '=')
7117 continue;
7119 /* else add it to the output array */
7120 if (newarray)
7122 newarray = array_set(newarray, 1, &index,
7124 false,
7125 -1 /* varlenarray */ ,
7126 -1 /* TEXT's typlen */ ,
7127 false /* TEXT's typbyval */ ,
7128 'i' /* TEXT's typalign */ );
7130 else
7131 newarray = construct_array(&d, 1,
7132 TEXTOID,
7133 -1, false, 'i');
7135 index++;
7138 return newarray;
7143 * assign_hook and show_hook subroutines
7146 static const char *
7147 assign_log_destination(const char *value, bool doit, GucSource source)
7149 char *rawstring;
7150 List *elemlist;
7151 ListCell *l;
7152 int newlogdest = 0;
7154 /* Need a modifiable copy of string */
7155 rawstring = pstrdup(value);
7157 /* Parse string into list of identifiers */
7158 if (!SplitIdentifierString(rawstring, ',', &elemlist))
7160 /* syntax error in list */
7161 pfree(rawstring);
7162 list_free(elemlist);
7163 ereport(GUC_complaint_elevel(source),
7164 (errcode(ERRCODE_INVALID_PARAMETER_VALUE),
7165 errmsg("invalid list syntax for parameter \"log_destination\"")));
7166 return NULL;
7169 foreach(l, elemlist)
7171 char *tok = (char *) lfirst(l);
7173 if (pg_strcasecmp(tok, "stderr") == 0)
7174 newlogdest |= LOG_DESTINATION_STDERR;
7175 else if (pg_strcasecmp(tok, "csvlog") == 0)
7176 newlogdest |= LOG_DESTINATION_CSVLOG;
7177 #ifdef HAVE_SYSLOG
7178 else if (pg_strcasecmp(tok, "syslog") == 0)
7179 newlogdest |= LOG_DESTINATION_SYSLOG;
7180 #endif
7181 #ifdef WIN32
7182 else if (pg_strcasecmp(tok, "eventlog") == 0)
7183 newlogdest |= LOG_DESTINATION_EVENTLOG;
7184 #endif
7185 else
7187 ereport(GUC_complaint_elevel(source),
7188 (errcode(ERRCODE_INVALID_PARAMETER_VALUE),
7189 errmsg("unrecognized \"log_destination\" key word: \"%s\"",
7190 tok)));
7191 pfree(rawstring);
7192 list_free(elemlist);
7193 return NULL;
7197 if (doit)
7198 Log_destination = newlogdest;
7200 pfree(rawstring);
7201 list_free(elemlist);
7203 return value;
7206 #ifdef HAVE_SYSLOG
7208 static bool
7209 assign_syslog_facility(int newval, bool doit, GucSource source)
7211 if (doit)
7212 set_syslog_parameters(syslog_ident_str ? syslog_ident_str : "postgres",
7213 newval);
7215 return true;
7218 static const char *
7219 assign_syslog_ident(const char *ident, bool doit, GucSource source)
7221 if (doit)
7222 set_syslog_parameters(ident, syslog_facility);
7224 return ident;
7226 #endif /* HAVE_SYSLOG */
7229 static bool
7230 assign_session_replication_role(int newval, bool doit, GucSource source)
7233 * Must flush the plan cache when changing replication role; but don't
7234 * flush unnecessarily.
7236 if (doit && SessionReplicationRole != newval)
7238 ResetPlanCache();
7241 return true;
7244 static const char *
7245 show_num_temp_buffers(void)
7248 * We show the GUC var until local buffers have been initialized, and
7249 * NLocBuffer afterwards.
7251 static char nbuf[32];
7253 sprintf(nbuf, "%d", NLocBuffer ? NLocBuffer : num_temp_buffers);
7254 return nbuf;
7257 static bool
7258 assign_phony_autocommit(bool newval, bool doit, GucSource source)
7260 if (!newval)
7262 ereport(GUC_complaint_elevel(source),
7263 (errcode(ERRCODE_FEATURE_NOT_SUPPORTED),
7264 errmsg("SET AUTOCOMMIT TO OFF is no longer supported")));
7265 return false;
7267 return true;
7270 static const char *
7271 assign_custom_variable_classes(const char *newval, bool doit, GucSource source)
7274 * Check syntax. newval must be a comma separated list of identifiers.
7275 * Whitespace is allowed but removed from the result.
7277 bool hasSpaceAfterToken = false;
7278 const char *cp = newval;
7279 int symLen = 0;
7280 char c;
7281 StringInfoData buf;
7283 initStringInfo(&buf);
7284 while ((c = *cp++) != '\0')
7286 if (isspace((unsigned char) c))
7288 if (symLen > 0)
7289 hasSpaceAfterToken = true;
7290 continue;
7293 if (c == ',')
7295 if (symLen > 0) /* terminate identifier */
7297 appendStringInfoChar(&buf, ',');
7298 symLen = 0;
7300 hasSpaceAfterToken = false;
7301 continue;
7304 if (hasSpaceAfterToken || !(isalnum((unsigned char) c) || c == '_'))
7307 * Syntax error due to token following space after token or
7308 * non-identifier character
7310 pfree(buf.data);
7311 return NULL;
7313 appendStringInfoChar(&buf, c);
7314 symLen++;
7317 /* Remove stray ',' at end */
7318 if (symLen == 0 && buf.len > 0)
7319 buf.data[--buf.len] = '\0';
7321 /* GUC wants the result malloc'd */
7322 newval = guc_strdup(LOG, buf.data);
7324 pfree(buf.data);
7325 return newval;
7328 static bool
7329 assign_debug_assertions(bool newval, bool doit, GucSource source)
7331 #ifndef USE_ASSERT_CHECKING
7332 if (newval)
7334 ereport(GUC_complaint_elevel(source),
7335 (errcode(ERRCODE_INVALID_PARAMETER_VALUE),
7336 errmsg("assertion checking is not supported by this build")));
7337 return false;
7339 #endif
7340 return true;
7343 static bool
7344 assign_ssl(bool newval, bool doit, GucSource source)
7346 #ifndef USE_SSL
7347 if (newval)
7349 ereport(GUC_complaint_elevel(source),
7350 (errcode(ERRCODE_INVALID_PARAMETER_VALUE),
7351 errmsg("SSL is not supported by this build")));
7352 return false;
7354 #endif
7355 return true;
7358 static bool
7359 assign_stage_log_stats(bool newval, bool doit, GucSource source)
7361 if (newval && log_statement_stats)
7363 ereport(GUC_complaint_elevel(source),
7364 (errcode(ERRCODE_INVALID_PARAMETER_VALUE),
7365 errmsg("cannot enable parameter when \"log_statement_stats\" is true")));
7366 /* source == PGC_S_OVERRIDE means do it anyway, eg at xact abort */
7367 if (source != PGC_S_OVERRIDE)
7368 return false;
7370 return true;
7373 static bool
7374 assign_log_stats(bool newval, bool doit, GucSource source)
7376 if (newval &&
7377 (log_parser_stats || log_planner_stats || log_executor_stats))
7379 ereport(GUC_complaint_elevel(source),
7380 (errcode(ERRCODE_INVALID_PARAMETER_VALUE),
7381 errmsg("cannot enable \"log_statement_stats\" when "
7382 "\"log_parser_stats\", \"log_planner_stats\", "
7383 "or \"log_executor_stats\" is true")));
7384 /* source == PGC_S_OVERRIDE means do it anyway, eg at xact abort */
7385 if (source != PGC_S_OVERRIDE)
7386 return false;
7388 return true;
7391 static bool
7392 assign_transaction_read_only(bool newval, bool doit, GucSource source)
7394 /* Can't go to r/w mode inside a r/o transaction */
7395 if (newval == false && XactReadOnly && IsSubTransaction())
7397 ereport(GUC_complaint_elevel(source),
7398 (errcode(ERRCODE_INVALID_PARAMETER_VALUE),
7399 errmsg("cannot set transaction read-write mode inside a read-only transaction")));
7400 /* source == PGC_S_OVERRIDE means do it anyway, eg at xact abort */
7401 if (source != PGC_S_OVERRIDE)
7402 return false;
7404 return true;
7407 static const char *
7408 assign_canonical_path(const char *newval, bool doit, GucSource source)
7410 if (doit)
7412 char *canon_val = guc_strdup(ERROR, newval);
7414 canonicalize_path(canon_val);
7415 return canon_val;
7417 else
7418 return newval;
7421 static const char *
7422 assign_timezone_abbreviations(const char *newval, bool doit, GucSource source)
7425 * The powerup value shown above for timezone_abbreviations is "UNKNOWN".
7426 * When we see this we just do nothing. If this value isn't overridden
7427 * from the config file then pg_timezone_abbrev_initialize() will
7428 * eventually replace it with "Default". This hack has two purposes: to
7429 * avoid wasting cycles loading values that might soon be overridden from
7430 * the config file, and to avoid trying to read the timezone abbrev files
7431 * during InitializeGUCOptions(). The latter doesn't work in an
7432 * EXEC_BACKEND subprocess because my_exec_path hasn't been set yet and so
7433 * we can't locate PGSHAREDIR. (Essentially the same hack is used to
7434 * delay initializing TimeZone ... if we have any more, we should try to
7435 * clean up and centralize this mechanism ...)
7437 if (strcmp(newval, "UNKNOWN") == 0)
7439 return newval;
7442 /* Loading abbrev file is expensive, so only do it when value changes */
7443 if (timezone_abbreviations_string == NULL ||
7444 strcmp(timezone_abbreviations_string, newval) != 0)
7446 int elevel;
7449 * If reading config file, only the postmaster should bleat loudly
7450 * about problems. Otherwise, it's just this one process doing it,
7451 * and we use WARNING message level.
7453 if (source == PGC_S_FILE)
7454 elevel = IsUnderPostmaster ? DEBUG3 : LOG;
7455 else
7456 elevel = WARNING;
7457 if (!load_tzoffsets(newval, doit, elevel))
7458 return NULL;
7460 return newval;
7464 * pg_timezone_abbrev_initialize --- set default value if not done already
7466 * This is called after initial loading of postgresql.conf. If no
7467 * timezone_abbreviations setting was found therein, select default.
7469 void
7470 pg_timezone_abbrev_initialize(void)
7472 if (strcmp(timezone_abbreviations_string, "UNKNOWN") == 0)
7474 SetConfigOption("timezone_abbreviations", "Default",
7475 PGC_POSTMASTER, PGC_S_ARGV);
7479 static const char *
7480 show_archive_command(void)
7482 if (XLogArchiveMode)
7483 return XLogArchiveCommand;
7484 else
7485 return "(disabled)";
7488 static bool
7489 assign_tcp_keepalives_idle(int newval, bool doit, GucSource source)
7491 if (doit)
7492 return (pq_setkeepalivesidle(newval, MyProcPort) == STATUS_OK);
7494 return true;
7497 static const char *
7498 show_tcp_keepalives_idle(void)
7500 static char nbuf[16];
7502 snprintf(nbuf, sizeof(nbuf), "%d", pq_getkeepalivesidle(MyProcPort));
7503 return nbuf;
7506 static bool
7507 assign_tcp_keepalives_interval(int newval, bool doit, GucSource source)
7509 if (doit)
7510 return (pq_setkeepalivesinterval(newval, MyProcPort) == STATUS_OK);
7512 return true;
7515 static const char *
7516 show_tcp_keepalives_interval(void)
7518 static char nbuf[16];
7520 snprintf(nbuf, sizeof(nbuf), "%d", pq_getkeepalivesinterval(MyProcPort));
7521 return nbuf;
7524 static bool
7525 assign_tcp_keepalives_count(int newval, bool doit, GucSource source)
7527 if (doit)
7528 return (pq_setkeepalivescount(newval, MyProcPort) == STATUS_OK);
7530 return true;
7533 static const char *
7534 show_tcp_keepalives_count(void)
7536 static char nbuf[16];
7538 snprintf(nbuf, sizeof(nbuf), "%d", pq_getkeepalivescount(MyProcPort));
7539 return nbuf;
7542 static bool
7543 assign_maxconnections(int newval, bool doit, GucSource source)
7545 if (newval + autovacuum_max_workers > INT_MAX / 4)
7546 return false;
7548 if (doit)
7549 MaxBackends = newval + autovacuum_max_workers;
7551 return true;
7554 static bool
7555 assign_autovacuum_max_workers(int newval, bool doit, GucSource source)
7557 if (newval + MaxConnections > INT_MAX / 4)
7558 return false;
7560 if (doit)
7561 MaxBackends = newval + MaxConnections;
7563 return true;
7566 static bool
7567 assign_effective_io_concurrency(int newval, bool doit, GucSource source)
7569 #ifdef USE_PREFETCH
7570 double new_prefetch_pages = 0.0;
7571 int i;
7573 /*----------
7574 * The user-visible GUC parameter is the number of drives (spindles),
7575 * which we need to translate to a number-of-pages-to-prefetch target.
7577 * The expected number of prefetch pages needed to keep N drives busy is:
7579 * drives | I/O requests
7580 * -------+----------------
7581 * 1 | 1
7582 * 2 | 2/1 + 2/2 = 3
7583 * 3 | 3/1 + 3/2 + 3/3 = 5 1/2
7584 * 4 | 4/1 + 4/2 + 4/3 + 4/4 = 8 1/3
7585 * n | n * H(n)
7587 * This is called the "coupon collector problem" and H(n) is called the
7588 * harmonic series. This could be approximated by n * ln(n), but for
7589 * reasonable numbers of drives we might as well just compute the series.
7591 * Alternatively we could set the target to the number of pages necessary
7592 * so that the expected number of active spindles is some arbitrary
7593 * percentage of the total. This sounds the same but is actually slightly
7594 * different. The result ends up being ln(1-P)/ln((n-1)/n) where P is
7595 * that desired fraction.
7597 * Experimental results show that both of these formulas aren't aggressive
7598 * enough, but we don't really have any better proposals.
7600 * Note that if newval = 0 (disabled), we must set target = 0.
7601 *----------
7604 for (i = 1; i <= newval; i++)
7605 new_prefetch_pages += (double) newval / (double) i;
7607 /* This range check shouldn't fail, but let's be paranoid */
7608 if (new_prefetch_pages >= 0.0 && new_prefetch_pages < (double) INT_MAX)
7610 if (doit)
7611 target_prefetch_pages = (int) rint(new_prefetch_pages);
7612 return true;
7614 else
7615 return false;
7616 #else
7617 return true;
7618 #endif /* USE_PREFETCH */
7621 static const char *
7622 assign_pgstat_temp_directory(const char *newval, bool doit, GucSource source)
7624 if (doit)
7626 char *canon_val = guc_strdup(ERROR, newval);
7627 char *tname;
7628 char *fname;
7630 canonicalize_path(canon_val);
7632 tname = guc_malloc(ERROR, strlen(canon_val) + 12); /* /pgstat.tmp */
7633 sprintf(tname, "%s/pgstat.tmp", canon_val);
7634 fname = guc_malloc(ERROR, strlen(canon_val) + 13); /* /pgstat.stat */
7635 sprintf(fname, "%s/pgstat.stat", canon_val);
7637 if (pgstat_stat_tmpname)
7638 free(pgstat_stat_tmpname);
7639 pgstat_stat_tmpname = tname;
7640 if (pgstat_stat_filename)
7641 free(pgstat_stat_filename);
7642 pgstat_stat_filename = fname;
7644 return canon_val;
7646 else
7647 return newval;
7650 #include "guc-file.c"