1 /*--------------------------------------------------------------------
4 * Support for grand unified configuration scheme, including SET
5 * command, configuration file, and command line options.
6 * See src/backend/utils/misc/README for more information.
9 * Copyright (c) 2000-2005, PostgreSQL Global Development Group
10 * Written by Peter Eisentraut <peter_e@gmx.net>.
13 * $PostgreSQL: pgsql/src/backend/utils/misc/guc.c,v 1.288 2005/09/12 02:26:32 tgl Exp $
15 *--------------------------------------------------------------------
25 #include "utils/guc.h"
26 #include "utils/guc_tables.h"
28 #include "access/twophase.h"
29 #include "catalog/namespace.h"
30 #include "catalog/pg_type.h"
31 #include "commands/async.h"
32 #include "commands/variable.h"
33 #include "commands/vacuum.h"
34 #include "executor/executor.h"
37 #include "libpq/auth.h"
38 #include "libpq/pqcomm.h"
39 #include "libpq/pqformat.h"
40 #include "mb/pg_wchar.h"
41 #include "miscadmin.h"
42 #include "optimizer/cost.h"
43 #include "optimizer/geqo.h"
44 #include "optimizer/paths.h"
45 #include "optimizer/prep.h"
46 #include "parser/parse_expr.h"
47 #include "parser/parse_relation.h"
48 #include "postmaster/autovacuum.h"
49 #include "postmaster/bgwriter.h"
50 #include "postmaster/syslogger.h"
51 #include "postmaster/postmaster.h"
52 #include "storage/bufmgr.h"
53 #include "storage/fd.h"
54 #include "storage/freespace.h"
55 #include "storage/lock.h"
56 #include "storage/proc.h"
57 #include "tcop/tcopprot.h"
58 #include "utils/array.h"
59 #include "utils/builtins.h"
60 #include "utils/memutils.h"
61 #include "utils/pg_locale.h"
66 #define PG_KRB_SRVTAB ""
69 #define PG_KRB_SRVNAM ""
72 #define CONFIG_FILENAME "postgresql.conf"
73 #define HBA_FILENAME "pg_hba.conf"
74 #define IDENT_FILENAME "pg_ident.conf"
77 #define CONFIG_EXEC_PARAMS "global/config_exec_params"
78 #define CONFIG_EXEC_PARAMS_NEW "global/config_exec_params.new"
81 /* upper limit for GUC variables measured in kilobytes of memory */
83 #define MAX_KILOBYTES INT_MAX
85 #define MAX_KILOBYTES (INT_MAX / 1024)
88 /* XXX these should appear in other modules' header files */
89 extern bool Log_disconnections;
90 extern DLLIMPORT bool check_function_bodies;
91 extern int CommitDelay;
92 extern int CommitSiblings;
93 extern char *default_tablespace;
94 extern bool fullPageWrites;
96 static const char *assign_log_destination(const char *value,
97 bool doit, GucSource source);
100 extern char *Syslog_facility;
101 extern char *Syslog_ident;
103 static const char *assign_facility(const char *facility,
104 bool doit, GucSource source);
107 static const char *assign_defaultxactisolevel(const char *newval, bool doit,
109 static const char *assign_log_min_messages(const char *newval, bool doit,
111 static const char *assign_client_min_messages(const char *newval,
112 bool doit, GucSource source);
113 static const char *assign_min_error_statement(const char *newval, bool doit,
115 static const char *assign_msglvl(int *var, const char *newval, bool doit,
117 static const char *assign_log_error_verbosity(const char *newval, bool doit,
119 static const char *assign_log_statement(const char *newval, bool doit,
121 static const char *show_num_temp_buffers(void);
122 static bool assign_phony_autocommit(bool newval, bool doit, GucSource source);
123 static const char *assign_custom_variable_classes(const char *newval, bool doit,
125 static bool assign_stage_log_stats(bool newval, bool doit, GucSource source);
126 static bool assign_log_stats(bool newval, bool doit, GucSource source);
127 static bool assign_transaction_read_only(bool newval, bool doit, GucSource source);
128 static const char *assign_canonical_path(const char *newval, bool doit, GucSource source);
130 static bool assign_tcp_keepalives_idle(int newval, bool doit, GucSource source);
131 static bool assign_tcp_keepalives_interval(int newval, bool doit, GucSource source);
132 static bool assign_tcp_keepalives_count(int newval, bool doit, GucSource source);
133 static const char *show_tcp_keepalives_idle(void);
134 static const char *show_tcp_keepalives_interval(void);
135 static const char *show_tcp_keepalives_count(void);
138 * GUC option variables that are exported from this module
140 #ifdef USE_ASSERT_CHECKING
141 bool assert_enabled = true;
143 bool log_duration = false;
144 bool Debug_print_plan = false;
145 bool Debug_print_parse = false;
146 bool Debug_print_rewritten = false;
147 bool Debug_pretty_print = false;
148 bool Explain_pretty_print = true;
150 bool log_parser_stats = false;
151 bool log_planner_stats = false;
152 bool log_executor_stats = false;
153 bool log_statement_stats = false; /* this is sort of all
154 * three above together */
155 bool log_btree_build_stats = false;
157 bool SQL_inheritance = true;
159 bool Australian_timezones = false;
161 bool Password_encryption = true;
163 bool default_with_oids = false;
165 int log_min_error_statement = PANIC;
166 int log_min_messages = NOTICE;
167 int client_min_messages = NOTICE;
168 int log_min_duration_statement = -1;
170 int num_temp_buffers = 1000;
172 char *ConfigFileName;
175 char *external_pid_file;
177 int tcp_keepalives_idle;
178 int tcp_keepalives_interval;
179 int tcp_keepalives_count;
182 * These variables are all dummies that don't do anything, except in some
183 * cases provide the value for SHOW to display. The real state is elsewhere
184 * and is kept in sync by assign_hooks.
186 static char *client_min_messages_str;
187 static char *log_min_messages_str;
188 static char *log_error_verbosity_str;
189 static char *log_statement_str;
190 static char *log_min_error_statement_str;
191 static char *log_destination_string;
192 static bool phony_autocommit;
193 static bool session_auth_is_superuser;
194 static double phony_random_seed;
195 static char *client_encoding_string;
196 static char *datestyle_string;
197 static char *default_iso_level_string;
198 static char *locale_collate;
199 static char *locale_ctype;
200 static char *regex_flavor_string;
201 static char *server_encoding_string;
202 static char *server_version_string;
203 static char *timezone_string;
204 static char *XactIsoLevel_string;
205 static char *data_directory;
206 static char *custom_variable_classes;
207 static int max_function_args;
208 static int max_index_keys;
209 static int max_identifier_length;
210 static int block_size;
211 static bool integer_datetimes;
212 static bool standard_conforming_strings;
214 /* should be static, but commands/variable.c needs to get at these */
216 char *session_authorization_string;
220 * Displayable names for context types (enum GucContext)
222 * Note: these strings are deliberately not localized.
224 const char *const GucContext_Names[] =
226 /* PGC_INTERNAL */ "internal",
227 /* PGC_POSTMASTER */ "postmaster",
228 /* PGC_SIGHUP */ "sighup",
229 /* PGC_BACKEND */ "backend",
230 /* PGC_SUSET */ "superuser",
231 /* PGC_USERSET */ "user"
235 * Displayable names for source types (enum GucSource)
237 * Note: these strings are deliberately not localized.
239 const char *const GucSource_Names[] =
241 /* PGC_S_DEFAULT */ "default",
242 /* PGC_S_ENV_VAR */ "environment variable",
243 /* PGC_S_FILE */ "configuration file",
244 /* PGC_S_ARGV */ "command line",
245 /* PGC_S_DATABASE */ "database",
246 /* PGC_S_USER */ "user",
247 /* PGC_S_CLIENT */ "client",
248 /* PGC_S_OVERRIDE */ "override",
249 /* PGC_S_INTERACTIVE */ "interactive",
250 /* PGC_S_TEST */ "test",
251 /* PGC_S_SESSION */ "session"
255 * Displayable names for the groupings defined in enum config_group
257 const char *const config_group_names[] =
260 gettext_noop("Ungrouped"),
262 gettext_noop("File Locations"),
264 gettext_noop("Connections and Authentication"),
265 /* CONN_AUTH_SETTINGS */
266 gettext_noop("Connections and Authentication / Connection Settings"),
267 /* CONN_AUTH_SECURITY */
268 gettext_noop("Connections and Authentication / Security and Authentication"),
270 gettext_noop("Resource Usage"),
272 gettext_noop("Resource Usage / Memory"),
274 gettext_noop("Resource Usage / Free Space Map"),
275 /* RESOURCES_KERNEL */
276 gettext_noop("Resource Usage / Kernel Resources"),
278 gettext_noop("Write-Ahead Log"),
280 gettext_noop("Write-Ahead Log / Settings"),
281 /* WAL_CHECKPOINTS */
282 gettext_noop("Write-Ahead Log / Checkpoints"),
284 gettext_noop("Query Tuning"),
285 /* QUERY_TUNING_METHOD */
286 gettext_noop("Query Tuning / Planner Method Configuration"),
287 /* QUERY_TUNING_COST */
288 gettext_noop("Query Tuning / Planner Cost Constants"),
289 /* QUERY_TUNING_GEQO */
290 gettext_noop("Query Tuning / Genetic Query Optimizer"),
291 /* QUERY_TUNING_OTHER */
292 gettext_noop("Query Tuning / Other Planner Options"),
294 gettext_noop("Reporting and Logging"),
296 gettext_noop("Reporting and Logging / Where to Log"),
298 gettext_noop("Reporting and Logging / When to Log"),
300 gettext_noop("Reporting and Logging / What to Log"),
302 gettext_noop("Statistics"),
303 /* STATS_MONITORING */
304 gettext_noop("Statistics / Monitoring"),
305 /* STATS_COLLECTOR */
306 gettext_noop("Statistics / Query and Index Statistics Collector"),
308 gettext_noop("Auto Vacuum"),
310 gettext_noop("Client Connection Defaults"),
311 /* CLIENT_CONN_STATEMENT */
312 gettext_noop("Client Connection Defaults / Statement Behavior"),
313 /* CLIENT_CONN_LOCALE */
314 gettext_noop("Client Connection Defaults / Locale and Formatting"),
315 /* CLIENT_CONN_OTHER */
316 gettext_noop("Client Connection Defaults / Other Defaults"),
317 /* LOCK_MANAGEMENT */
318 gettext_noop("Lock Management"),
320 gettext_noop("Version and Platform Compatibility"),
321 /* COMPAT_OPTIONS_PREVIOUS */
322 gettext_noop("Version and Platform Compatibility / Previous PostgreSQL Versions"),
323 /* COMPAT_OPTIONS_CLIENT */
324 gettext_noop("Version and Platform Compatibility / Other Platforms and Clients"),
326 gettext_noop("Preset Options"),
328 gettext_noop("Customized Options"),
329 /* DEVELOPER_OPTIONS */
330 gettext_noop("Developer Options"),
331 /* help_config wants this array to be null-terminated */
336 * Displayable names for GUC variable types (enum config_type)
338 * Note: these strings are deliberately not localized.
340 const char *const config_type_names[] =
342 /* PGC_BOOL */ "bool",
343 /* PGC_INT */ "integer",
344 /* PGC_REAL */ "real",
345 /* PGC_STRING */ "string"
350 * Contents of GUC tables
352 * See src/backend/utils/misc/README for design notes.
356 * 1. Declare a global variable of type bool, int, double, or char*
357 * and make use of it.
359 * 2. Decide at what times it's safe to set the option. See guc.h for
362 * 3. Decide on a name, a default value, upper and lower bounds (if
365 * 4. Add a record below.
367 * 5. Add it to src/backend/utils/misc/postgresql.conf.sample, if
370 * 6. Add it to src/bin/psql/tab-complete.c, if it's a USERSET option.
372 * 7. Don't forget to document the option.
374 * 8. If it's a new GUC_LIST option you must edit pg_dumpall.c to ensure
375 * it is not single quoted at dump time.
379 /******** option records follow ********/
381 static struct config_bool ConfigureNamesBool[] =
384 {"enable_seqscan", PGC_USERSET, QUERY_TUNING_METHOD,
385 gettext_noop("Enables the planner's use of sequential-scan plans."),
392 {"enable_indexscan", PGC_USERSET, QUERY_TUNING_METHOD,
393 gettext_noop("Enables the planner's use of index-scan plans."),
400 {"enable_bitmapscan", PGC_USERSET, QUERY_TUNING_METHOD,
401 gettext_noop("Enables the planner's use of bitmap-scan plans."),
408 {"enable_tidscan", PGC_USERSET, QUERY_TUNING_METHOD,
409 gettext_noop("Enables the planner's use of TID scan plans."),
416 {"enable_sort", PGC_USERSET, QUERY_TUNING_METHOD,
417 gettext_noop("Enables the planner's use of explicit sort steps."),
424 {"enable_hashagg", PGC_USERSET, QUERY_TUNING_METHOD,
425 gettext_noop("Enables the planner's use of hashed aggregation plans."),
432 {"enable_nestloop", PGC_USERSET, QUERY_TUNING_METHOD,
433 gettext_noop("Enables the planner's use of nested-loop join plans."),
440 {"enable_mergejoin", PGC_USERSET, QUERY_TUNING_METHOD,
441 gettext_noop("Enables the planner's use of merge join plans."),
448 {"enable_hashjoin", PGC_USERSET, QUERY_TUNING_METHOD,
449 gettext_noop("Enables the planner's use of hash join plans."),
456 {"constraint_exclusion", PGC_USERSET, QUERY_TUNING_OTHER,
457 gettext_noop("Enables the planner to use constraints to limit table access."),
458 gettext_noop("This prevents table access if the table constraints "
459 "guarantee that table access is necessary.")
461 &constraint_exclusion,
465 {"geqo", PGC_USERSET, QUERY_TUNING_GEQO,
466 gettext_noop("Enables genetic query optimization."),
467 gettext_noop("This algorithm attempts to do planning without "
468 "exhaustive searching.")
474 /* Not for general use --- used by SET SESSION AUTHORIZATION */
475 {"is_superuser", PGC_INTERNAL, UNGROUPED,
476 gettext_noop("Shows whether the current user is a superuser."),
478 GUC_REPORT | GUC_NO_SHOW_ALL | GUC_NO_RESET_ALL | GUC_NOT_IN_SAMPLE | GUC_DISALLOW_IN_FILE
480 &session_auth_is_superuser,
484 {"ssl", PGC_POSTMASTER, CONN_AUTH_SECURITY,
485 gettext_noop("Enables SSL connections."),
492 {"fsync", PGC_SIGHUP, WAL_SETTINGS,
493 gettext_noop("Forces synchronization of updates to disk."),
494 gettext_noop("The server will use the fsync() system call in several places to make "
495 "sure that updates are physically written to disk. This insures "
496 "that a database cluster will recover to a consistent state after "
497 "an operating system or hardware crash.")
503 {"zero_damaged_pages", PGC_SUSET, DEVELOPER_OPTIONS,
504 gettext_noop("Continues processing past damaged page headers."),
505 gettext_noop("Detection of a damaged page header normally causes PostgreSQL to "
506 "report an error, aborting the current transaction. Setting "
507 "zero_damaged_pages to true causes the system to instead report a "
508 "warning, zero out the damaged page, and continue processing. This "
509 "behavior will destroy data, namely all the rows on the damaged page."),
516 {"full_page_writes", PGC_SIGHUP, WAL_SETTINGS,
517 gettext_noop("Writes full pages to WAL when first modified after a checkpoint."),
518 gettext_noop("A page write in process during an operating system crash might be "
519 "only partially written to disk. During recovery, the row changes"
520 "stored in WAL are not enough to recover. This option writes "
521 "pages when first modified after a checkpoint to WAL so full recovery "
528 {"silent_mode", PGC_POSTMASTER, LOGGING_WHEN,
529 gettext_noop("Runs the server silently."),
530 gettext_noop("If this parameter is set, the server will automatically run in the "
531 "background and any controlling terminals are dissociated.")
537 {"log_connections", PGC_BACKEND, LOGGING_WHAT,
538 gettext_noop("Logs each successful connection."),
545 {"log_disconnections", PGC_BACKEND, LOGGING_WHAT,
546 gettext_noop("Logs end of a session, including duration."),
553 #ifdef USE_ASSERT_CHECKING
555 {"debug_assertions", PGC_USERSET, DEVELOPER_OPTIONS,
556 gettext_noop("Turns on various assertion checks."),
557 gettext_noop("This is a debugging aid."),
566 /* currently undocumented, so don't show in SHOW ALL */
567 {"exit_on_error", PGC_USERSET, UNGROUPED,
568 gettext_noop("no description available"),
570 GUC_NO_SHOW_ALL | GUC_NOT_IN_SAMPLE
576 {"log_duration", PGC_SUSET, LOGGING_WHAT,
577 gettext_noop("Logs the duration of each completed SQL statement."),
584 {"debug_print_parse", PGC_USERSET, LOGGING_WHAT,
585 gettext_noop("Prints the parse tree to the server log."),
592 {"debug_print_rewritten", PGC_USERSET, LOGGING_WHAT,
593 gettext_noop("Prints the parse tree after rewriting to server log."),
596 &Debug_print_rewritten,
600 {"debug_print_plan", PGC_USERSET, LOGGING_WHAT,
601 gettext_noop("Prints the execution plan to server log."),
608 {"debug_pretty_print", PGC_USERSET, LOGGING_WHAT,
609 gettext_noop("Indents parse and plan tree displays."),
616 {"log_parser_stats", PGC_SUSET, STATS_MONITORING,
617 gettext_noop("Writes parser performance statistics to the server log."),
621 false, assign_stage_log_stats, NULL
624 {"log_planner_stats", PGC_SUSET, STATS_MONITORING,
625 gettext_noop("Writes planner performance statistics to the server log."),
629 false, assign_stage_log_stats, NULL
632 {"log_executor_stats", PGC_SUSET, STATS_MONITORING,
633 gettext_noop("Writes executor performance statistics to the server log."),
637 false, assign_stage_log_stats, NULL
640 {"log_statement_stats", PGC_SUSET, STATS_MONITORING,
641 gettext_noop("Writes cumulative performance statistics to the server log."),
644 &log_statement_stats,
645 false, assign_log_stats, NULL
647 #ifdef BTREE_BUILD_STATS
649 {"log_btree_build_stats", PGC_SUSET, DEVELOPER_OPTIONS,
650 gettext_noop("no description available"),
654 &log_btree_build_stats,
660 {"explain_pretty_print", PGC_USERSET, CLIENT_CONN_OTHER,
661 gettext_noop("Uses the indented output format for EXPLAIN VERBOSE."),
664 &Explain_pretty_print,
668 {"stats_start_collector", PGC_POSTMASTER, STATS_COLLECTOR,
669 gettext_noop("Starts the server statistics-collection subprocess."),
672 &pgstat_collect_startcollector,
676 {"stats_reset_on_server_start", PGC_POSTMASTER, STATS_COLLECTOR,
677 gettext_noop("Zeroes collected statistics on server restart."),
680 &pgstat_collect_resetonpmstart,
684 {"stats_command_string", PGC_SUSET, STATS_COLLECTOR,
685 gettext_noop("Collects statistics about executing commands."),
686 gettext_noop("Enables the collection of statistics on the currently "
687 "executing command of each session, along with the time "
688 "at which that command began execution.")
690 &pgstat_collect_querystring,
694 {"stats_row_level", PGC_SUSET, STATS_COLLECTOR,
695 gettext_noop("Collects row-level statistics on database activity."),
698 &pgstat_collect_tuplelevel,
702 {"stats_block_level", PGC_SUSET, STATS_COLLECTOR,
703 gettext_noop("Collects block-level statistics on database activity."),
706 &pgstat_collect_blocklevel,
711 {"autovacuum", PGC_SIGHUP, AUTOVACUUM,
712 gettext_noop("Starts the auto vacuum subprocess."),
715 &autovacuum_start_daemon,
720 {"trace_notify", PGC_USERSET, DEVELOPER_OPTIONS,
721 gettext_noop("Generates debugging output for LISTEN and NOTIFY."),
731 {"trace_locks", PGC_SUSET, DEVELOPER_OPTIONS,
732 gettext_noop("no description available"),
740 {"trace_userlocks", PGC_SUSET, DEVELOPER_OPTIONS,
741 gettext_noop("no description available"),
749 {"trace_lwlocks", PGC_SUSET, DEVELOPER_OPTIONS,
750 gettext_noop("no description available"),
758 {"debug_deadlocks", PGC_SUSET, DEVELOPER_OPTIONS,
759 gettext_noop("no description available"),
769 {"log_hostname", PGC_SIGHUP, LOGGING_WHAT,
770 gettext_noop("Logs the host name in the connection logs."),
771 gettext_noop("By default, connection logs only show the IP address "
772 "of the connecting host. If you want them to show the host name you "
773 "can turn this on, but depending on your host name resolution "
774 "setup it might impose a non-negligible performance penalty.")
780 {"sql_inheritance", PGC_USERSET, COMPAT_OPTIONS_PREVIOUS,
781 gettext_noop("Causes subtables to be included by default in various commands."),
788 {"australian_timezones", PGC_USERSET, CLIENT_CONN_LOCALE,
789 gettext_noop("Interprets ACST, CST, EST, and SAT as Australian time zones."),
790 gettext_noop("Otherwise they are interpreted as North/South American "
791 "time zones and Saturday.")
793 &Australian_timezones,
794 false, ClearDateCache, NULL
797 {"password_encryption", PGC_USERSET, CONN_AUTH_SECURITY,
798 gettext_noop("Encrypt passwords."),
799 gettext_noop("When a password is specified in CREATE USER or "
800 "ALTER USER without writing either ENCRYPTED or UNENCRYPTED, "
801 "this parameter determines whether the password is to be encrypted.")
803 &Password_encryption,
807 {"transform_null_equals", PGC_USERSET, COMPAT_OPTIONS_CLIENT,
808 gettext_noop("Treats \"expr=NULL\" as \"expr IS NULL\"."),
809 gettext_noop("When turned on, expressions of the form expr = NULL "
810 "(or NULL = expr) are treated as expr IS NULL, that is, they "
811 "return true if expr evaluates to the null value, and false "
812 "otherwise. The correct behavior of expr = NULL is to always "
813 "return null (unknown).")
815 &Transform_null_equals,
819 {"db_user_namespace", PGC_SIGHUP, CONN_AUTH_SECURITY,
820 gettext_noop("Enables per-database user names."),
827 /* only here for backwards compatibility */
828 {"autocommit", PGC_USERSET, CLIENT_CONN_STATEMENT,
829 gettext_noop("This parameter doesn't do anything."),
830 gettext_noop("It's just here so that we won't choke on SET AUTOCOMMIT TO ON from 7.3-vintage clients."),
831 GUC_NO_SHOW_ALL | GUC_NOT_IN_SAMPLE
834 true, assign_phony_autocommit, NULL
837 {"default_transaction_read_only", PGC_USERSET, CLIENT_CONN_STATEMENT,
838 gettext_noop("Sets the default read-only status of new transactions."),
841 &DefaultXactReadOnly,
845 {"transaction_read_only", PGC_USERSET, CLIENT_CONN_STATEMENT,
846 gettext_noop("Sets the current transaction's read-only status."),
848 GUC_NO_RESET_ALL | GUC_NOT_IN_SAMPLE | GUC_DISALLOW_IN_FILE
851 false, assign_transaction_read_only, NULL
854 {"add_missing_from", PGC_USERSET, COMPAT_OPTIONS_PREVIOUS,
855 gettext_noop("Automatically adds missing table references to FROM clauses."),
862 {"check_function_bodies", PGC_USERSET, CLIENT_CONN_STATEMENT,
863 gettext_noop("Check function bodies during CREATE FUNCTION."),
866 &check_function_bodies,
870 {"default_with_oids", PGC_USERSET, COMPAT_OPTIONS_PREVIOUS,
871 gettext_noop("Create new tables with OIDs by default."),
878 {"redirect_stderr", PGC_POSTMASTER, LOGGING_WHERE,
879 gettext_noop("Start a subprocess to capture stderr output into log files."),
886 {"log_truncate_on_rotation", PGC_SIGHUP, LOGGING_WHERE,
887 gettext_noop("Truncate existing log files of same name during log rotation."),
890 &Log_truncate_on_rotation,
896 {"wal_debug", PGC_SUSET, DEVELOPER_OPTIONS,
897 gettext_noop("Emit WAL-related debugging output."),
907 {"integer_datetimes", PGC_INTERNAL, PRESET_OPTIONS,
908 gettext_noop("Datetimes are integer based"),
910 GUC_REPORT | GUC_NOT_IN_SAMPLE | GUC_DISALLOW_IN_FILE
913 #ifdef HAVE_INT64_TIMESTAMP
921 {"krb_caseins_users", PGC_POSTMASTER, CONN_AUTH_SECURITY,
922 gettext_noop("Sets whether Kerberos user names should be treated case insensitive."),
925 &pg_krb_caseins_users,
930 {"escape_string_warning", PGC_USERSET, COMPAT_OPTIONS_PREVIOUS,
931 gettext_noop("Warn about backslash escapes in ordinary string literals."),
934 &escape_string_warning,
939 {"standard_conforming_strings", PGC_INTERNAL, PRESET_OPTIONS,
940 gettext_noop("'...' strings treat backslashes literally."),
942 GUC_REPORT | GUC_NOT_IN_SAMPLE | GUC_DISALLOW_IN_FILE
944 &standard_conforming_strings,
948 /* End-of-list marker */
950 {NULL, 0, 0, NULL, NULL}, NULL, false, NULL, NULL
955 static struct config_int ConfigureNamesInt[] =
958 {"default_statistics_target", PGC_USERSET, QUERY_TUNING_OTHER,
959 gettext_noop("Sets the default statistics target."),
960 gettext_noop("This applies to table columns that have not had a "
961 "column-specific target set via ALTER TABLE SET STATISTICS.")
963 &default_statistics_target,
964 10, 1, 1000, NULL, NULL
967 {"from_collapse_limit", PGC_USERSET, QUERY_TUNING_OTHER,
968 gettext_noop("Sets the FROM-list size beyond which subqueries are not "
970 gettext_noop("The planner will merge subqueries into upper "
971 "queries if the resulting FROM list would have no more than "
974 &from_collapse_limit,
975 8, 1, INT_MAX, NULL, NULL
978 {"join_collapse_limit", PGC_USERSET, QUERY_TUNING_OTHER,
979 gettext_noop("Sets the FROM-list size beyond which JOIN constructs are not "
981 gettext_noop("The planner will flatten explicit inner JOIN "
982 "constructs into lists of FROM items whenever a list of no more "
983 "than this many items would result.")
985 &join_collapse_limit,
986 8, 1, INT_MAX, NULL, NULL
989 {"geqo_threshold", PGC_USERSET, QUERY_TUNING_GEQO,
990 gettext_noop("Sets the threshold of FROM items beyond which GEQO is used."),
994 12, 2, INT_MAX, NULL, NULL
997 {"geqo_effort", PGC_USERSET, QUERY_TUNING_GEQO,
998 gettext_noop("GEQO: effort is used to set the default for other GEQO parameters."),
1002 DEFAULT_GEQO_EFFORT, MIN_GEQO_EFFORT, MAX_GEQO_EFFORT, NULL, NULL
1005 {"geqo_pool_size", PGC_USERSET, QUERY_TUNING_GEQO,
1006 gettext_noop("GEQO: number of individuals in the population."),
1007 gettext_noop("Zero selects a suitable default value.")
1010 0, 0, INT_MAX, NULL, NULL
1013 {"geqo_generations", PGC_USERSET, QUERY_TUNING_GEQO,
1014 gettext_noop("GEQO: number of iterations of the algorithm."),
1015 gettext_noop("Zero selects a suitable default value.")
1018 0, 0, INT_MAX, NULL, NULL
1022 {"deadlock_timeout", PGC_SIGHUP, LOCK_MANAGEMENT,
1023 gettext_noop("The time in milliseconds to wait on lock before checking for deadlock."),
1027 1000, 0, INT_MAX, NULL, NULL
1031 * Note: There is some postprocessing done in PostmasterMain() to make
1032 * sure the buffers are at least twice the number of backends, so the
1033 * constraints here are partially unused. Similarly, the superuser
1034 * reserved number is checked to ensure it is less than the max
1037 * MaxBackends is limited to INT_MAX/4 because some places compute
1038 * 4*MaxBackends without any overflow check. Likewise we have to
1039 * limit NBuffers to INT_MAX/2.
1042 {"max_connections", PGC_POSTMASTER, CONN_AUTH_SETTINGS,
1043 gettext_noop("Sets the maximum number of concurrent connections."),
1047 100, 1, INT_MAX / 4, NULL, NULL
1051 {"superuser_reserved_connections", PGC_POSTMASTER, CONN_AUTH_SETTINGS,
1052 gettext_noop("Sets the number of connection slots reserved for superusers."),
1056 2, 0, INT_MAX / 4, NULL, NULL
1060 {"shared_buffers", PGC_POSTMASTER, RESOURCES_MEM,
1061 gettext_noop("Sets the number of shared memory buffers used by the server."),
1065 1000, 16, INT_MAX / 2, NULL, NULL
1069 {"temp_buffers", PGC_USERSET, RESOURCES_MEM,
1070 gettext_noop("Sets the maximum number of temporary buffers used by each session."),
1074 1000, 100, INT_MAX / 2, NULL, show_num_temp_buffers
1078 {"port", PGC_POSTMASTER, CONN_AUTH_SETTINGS,
1079 gettext_noop("Sets the TCP port the server listens on."),
1083 DEF_PGPORT, 1, 65535, NULL, NULL
1087 {"unix_socket_permissions", PGC_POSTMASTER, CONN_AUTH_SETTINGS,
1088 gettext_noop("Sets the access permissions of the Unix-domain socket."),
1089 gettext_noop("Unix-domain sockets use the usual Unix file system "
1090 "permission set. The parameter value is expected to be an numeric mode "
1091 "specification in the form accepted by the chmod and umask system "
1092 "calls. (To use the customary octal format the number must start with "
1095 &Unix_socket_permissions,
1096 0777, 0000, 0777, NULL, NULL
1100 {"work_mem", PGC_USERSET, RESOURCES_MEM,
1101 gettext_noop("Sets the maximum memory to be used for query workspaces."),
1102 gettext_noop("This much memory may be used by each internal "
1103 "sort operation and hash table before switching to "
1104 "temporary disk files.")
1107 1024, 8 * BLCKSZ / 1024, MAX_KILOBYTES, NULL, NULL
1111 {"maintenance_work_mem", PGC_USERSET, RESOURCES_MEM,
1112 gettext_noop("Sets the maximum memory to be used for maintenance operations."),
1113 gettext_noop("This includes operations such as VACUUM and CREATE INDEX.")
1115 &maintenance_work_mem,
1116 16384, 1024, MAX_KILOBYTES, NULL, NULL
1120 {"max_stack_depth", PGC_SUSET, RESOURCES_MEM,
1121 gettext_noop("Sets the maximum stack depth, in kilobytes."),
1125 2048, 100, MAX_KILOBYTES, assign_max_stack_depth, NULL
1129 {"vacuum_cost_page_hit", PGC_USERSET, RESOURCES,
1130 gettext_noop("Vacuum cost for a page found in the buffer cache."),
1134 1, 0, 10000, NULL, NULL
1138 {"vacuum_cost_page_miss", PGC_USERSET, RESOURCES,
1139 gettext_noop("Vacuum cost for a page not found in the buffer cache."),
1142 &VacuumCostPageMiss,
1143 10, 0, 10000, NULL, NULL
1147 {"vacuum_cost_page_dirty", PGC_USERSET, RESOURCES,
1148 gettext_noop("Vacuum cost for a page dirtied by vacuum."),
1151 &VacuumCostPageDirty,
1152 20, 0, 10000, NULL, NULL
1156 {"vacuum_cost_limit", PGC_USERSET, RESOURCES,
1157 gettext_noop("Vacuum cost amount available before napping."),
1161 200, 1, 10000, NULL, NULL
1165 {"vacuum_cost_delay", PGC_USERSET, RESOURCES,
1166 gettext_noop("Vacuum cost delay in milliseconds."),
1170 0, 0, 1000, NULL, NULL
1174 {"autovacuum_vacuum_cost_delay", PGC_SIGHUP, AUTOVACUUM,
1175 gettext_noop("Vacuum cost delay in milliseconds, for autovacuum."),
1178 &autovacuum_vac_cost_delay,
1179 -1, -1, 1000, NULL, NULL
1183 {"autovacuum_vacuum_cost_limit", PGC_SIGHUP, AUTOVACUUM,
1184 gettext_noop("Vacuum cost amount available before napping, for autovacuum."),
1187 &autovacuum_vac_cost_limit,
1188 -1, -1, 10000, NULL, NULL
1192 {"max_files_per_process", PGC_POSTMASTER, RESOURCES_KERNEL,
1193 gettext_noop("Sets the maximum number of simultaneously open files for each server process."),
1196 &max_files_per_process,
1197 1000, 25, INT_MAX, NULL, NULL
1201 {"max_prepared_transactions", PGC_POSTMASTER, RESOURCES,
1202 gettext_noop("Sets the maximum number of simultaneously prepared transactions."),
1205 &max_prepared_xacts,
1206 5, 0, INT_MAX, NULL, NULL
1211 {"trace_lock_oidmin", PGC_SUSET, DEVELOPER_OPTIONS,
1212 gettext_noop("no description available"),
1217 FirstNormalObjectId, 0, INT_MAX, NULL, NULL
1220 {"trace_lock_table", PGC_SUSET, DEVELOPER_OPTIONS,
1221 gettext_noop("no description available"),
1226 0, 0, INT_MAX, NULL, NULL
1231 {"statement_timeout", PGC_USERSET, CLIENT_CONN_STATEMENT,
1232 gettext_noop("Sets the maximum allowed duration (in milliseconds) of any statement."),
1233 gettext_noop("A value of 0 turns off the timeout.")
1236 0, 0, INT_MAX, NULL, NULL
1240 {"max_fsm_relations", PGC_POSTMASTER, RESOURCES_FSM,
1241 gettext_noop("Sets the maximum number of tables and indexes for which free space is tracked."),
1245 1000, 100, INT_MAX, NULL, NULL
1248 {"max_fsm_pages", PGC_POSTMASTER, RESOURCES_FSM,
1249 gettext_noop("Sets the maximum number of disk pages for which free space is tracked."),
1253 20000, 1000, INT_MAX, NULL, NULL
1257 {"max_locks_per_transaction", PGC_POSTMASTER, LOCK_MANAGEMENT,
1258 gettext_noop("Sets the maximum number of locks per transaction."),
1259 gettext_noop("The shared lock table is sized on the assumption that "
1260 "at most max_locks_per_transaction * max_connections distinct "
1261 "objects will need to be locked at any one time.")
1263 &max_locks_per_xact,
1264 64, 10, INT_MAX, NULL, NULL
1268 {"authentication_timeout", PGC_SIGHUP, CONN_AUTH_SECURITY,
1269 gettext_noop("Sets the maximum time in seconds to complete client authentication."),
1272 &AuthenticationTimeout,
1273 60, 1, 600, NULL, NULL
1277 /* Not for general use */
1278 {"pre_auth_delay", PGC_SIGHUP, DEVELOPER_OPTIONS,
1279 gettext_noop("no description available"),
1284 0, 0, 60, NULL, NULL
1288 {"checkpoint_segments", PGC_SIGHUP, WAL_CHECKPOINTS,
1289 gettext_noop("Sets the maximum distance in log segments between automatic WAL checkpoints."),
1292 &CheckPointSegments,
1293 3, 1, INT_MAX, NULL, NULL
1297 {"checkpoint_timeout", PGC_SIGHUP, WAL_CHECKPOINTS,
1298 gettext_noop("Sets the maximum time in seconds between automatic WAL checkpoints."),
1302 300, 30, 3600, NULL, NULL
1306 {"checkpoint_warning", PGC_SIGHUP, WAL_CHECKPOINTS,
1307 gettext_noop("Logs if filling of checkpoint segments happens more "
1308 "frequently than this (in seconds)."),
1309 gettext_noop("Write a message to the server log if checkpoints "
1310 "caused by the filling of checkpoint segment files happens more "
1311 "frequently than this number of seconds. Zero turns off the warning.")
1314 30, 0, INT_MAX, NULL, NULL
1318 {"wal_buffers", PGC_POSTMASTER, WAL_SETTINGS,
1319 gettext_noop("Sets the number of disk-page buffers in shared memory for WAL."),
1323 8, 4, INT_MAX, NULL, NULL
1327 {"commit_delay", PGC_USERSET, WAL_CHECKPOINTS,
1328 gettext_noop("Sets the delay in microseconds between transaction commit and "
1329 "flushing WAL to disk."),
1333 0, 0, 100000, NULL, NULL
1337 {"commit_siblings", PGC_USERSET, WAL_CHECKPOINTS,
1338 gettext_noop("Sets the minimum concurrent open transactions before performing "
1343 5, 1, 1000, NULL, NULL
1347 {"extra_float_digits", PGC_USERSET, CLIENT_CONN_LOCALE,
1348 gettext_noop("Sets the number of digits displayed for floating-point values."),
1349 gettext_noop("This affects real, double precision, and geometric data types. "
1350 "The parameter value is added to the standard number of digits "
1351 "(FLT_DIG or DBL_DIG as appropriate).")
1353 &extra_float_digits,
1354 0, -15, 2, NULL, NULL
1358 {"log_min_duration_statement", PGC_SUSET, LOGGING_WHEN,
1359 gettext_noop("Sets the minimum execution time in milliseconds above which statements will "
1361 gettext_noop("Zero prints all queries. The default is -1 (turning this feature off).")
1363 &log_min_duration_statement,
1364 -1, -1, INT_MAX / 1000, NULL, NULL
1368 {"bgwriter_delay", PGC_SIGHUP, RESOURCES,
1369 gettext_noop("Background writer sleep time between rounds in milliseconds"),
1373 200, 10, 10000, NULL, NULL
1377 {"bgwriter_lru_maxpages", PGC_SIGHUP, RESOURCES,
1378 gettext_noop("Background writer maximum number of LRU pages to flush per round"),
1381 &bgwriter_lru_maxpages,
1382 5, 0, 1000, NULL, NULL
1386 {"bgwriter_all_maxpages", PGC_SIGHUP, RESOURCES,
1387 gettext_noop("Background writer maximum number of all pages to flush per round"),
1390 &bgwriter_all_maxpages,
1391 5, 0, 1000, NULL, NULL
1395 {"log_rotation_age", PGC_SIGHUP, LOGGING_WHERE,
1396 gettext_noop("Automatic log file rotation will occur after N minutes"),
1400 HOURS_PER_DAY * MINS_PER_HOUR, 0, INT_MAX / MINS_PER_HOUR, NULL, NULL
1404 {"log_rotation_size", PGC_SIGHUP, LOGGING_WHERE,
1405 gettext_noop("Automatic log file rotation will occur after N kilobytes"),
1409 10 * 1024, 0, INT_MAX / 1024, NULL, NULL
1413 {"max_function_args", PGC_INTERNAL, PRESET_OPTIONS,
1414 gettext_noop("Shows the maximum number of function arguments."),
1416 GUC_NOT_IN_SAMPLE | GUC_DISALLOW_IN_FILE
1419 FUNC_MAX_ARGS, FUNC_MAX_ARGS, FUNC_MAX_ARGS, NULL, NULL
1423 {"max_index_keys", PGC_INTERNAL, PRESET_OPTIONS,
1424 gettext_noop("Shows the maximum number of index keys."),
1426 GUC_NOT_IN_SAMPLE | GUC_DISALLOW_IN_FILE
1429 INDEX_MAX_KEYS, INDEX_MAX_KEYS, INDEX_MAX_KEYS, NULL, NULL
1433 {"max_identifier_length", PGC_INTERNAL, PRESET_OPTIONS,
1434 gettext_noop("Shows the maximum identifier length"),
1436 GUC_NOT_IN_SAMPLE | GUC_DISALLOW_IN_FILE
1438 &max_identifier_length,
1439 NAMEDATALEN - 1, NAMEDATALEN - 1, NAMEDATALEN - 1, NULL, NULL
1443 {"block_size", PGC_INTERNAL, PRESET_OPTIONS,
1444 gettext_noop("Shows size of a disk block"),
1446 GUC_NOT_IN_SAMPLE | GUC_DISALLOW_IN_FILE
1449 BLCKSZ, BLCKSZ, BLCKSZ, NULL, NULL
1453 {"autovacuum_naptime", PGC_SIGHUP, AUTOVACUUM,
1454 gettext_noop("Time to sleep between autovacuum runs, in seconds."),
1457 &autovacuum_naptime,
1458 60, 1, INT_MAX, NULL, NULL
1461 {"autovacuum_vacuum_threshold", PGC_SIGHUP, AUTOVACUUM,
1462 gettext_noop("Minimum number of tuple updates or deletes prior to vacuum."),
1465 &autovacuum_vac_thresh,
1466 1000, 0, INT_MAX, NULL, NULL
1469 {"autovacuum_analyze_threshold", PGC_SIGHUP, AUTOVACUUM,
1470 gettext_noop("Minimum number of tuple inserts, updates or deletes prior to analyze."),
1473 &autovacuum_anl_thresh,
1474 500, 0, INT_MAX, NULL, NULL
1478 {"tcp_keepalives_idle", PGC_USERSET, CLIENT_CONN_OTHER,
1479 gettext_noop("Seconds between issuing TCP keepalives."),
1480 gettext_noop("A value of 0 uses the system default."),
1482 &tcp_keepalives_idle,
1483 0, 0, INT_MAX, assign_tcp_keepalives_idle, show_tcp_keepalives_idle
1487 {"tcp_keepalives_interval", PGC_USERSET, CLIENT_CONN_OTHER,
1488 gettext_noop("Seconds between TCP keepalive retransmits."),
1489 gettext_noop("A value of 0 uses the system default."),
1491 &tcp_keepalives_interval,
1492 0, 0, INT_MAX, assign_tcp_keepalives_interval, show_tcp_keepalives_interval
1496 {"tcp_keepalives_count", PGC_USERSET, CLIENT_CONN_OTHER,
1497 gettext_noop("Maximum number of TCP keepalive retransmits."),
1498 gettext_noop("This controls the number of consecutive keepalive retransmits that can be "
1499 "lost before a connection is considered dead. A value of 0 uses the "
1502 &tcp_keepalives_count,
1503 0, 0, INT_MAX, assign_tcp_keepalives_count, show_tcp_keepalives_count
1506 /* End-of-list marker */
1508 {NULL, 0, 0, NULL, NULL}, NULL, 0, 0, 0, NULL, NULL
1513 static struct config_real ConfigureNamesReal[] =
1516 {"effective_cache_size", PGC_USERSET, QUERY_TUNING_COST,
1517 gettext_noop("Sets the planner's assumption about size of the disk cache."),
1518 gettext_noop("That is, the portion of the kernel's disk cache that "
1519 "will be used for PostgreSQL data files. This is measured in disk "
1520 "pages, which are normally 8 kB each.")
1522 &effective_cache_size,
1523 DEFAULT_EFFECTIVE_CACHE_SIZE, 1, DBL_MAX, NULL, NULL
1526 {"random_page_cost", PGC_USERSET, QUERY_TUNING_COST,
1527 gettext_noop("Sets the planner's estimate of the cost of a nonsequentially "
1528 "fetched disk page."),
1529 gettext_noop("This is measured as a multiple of the cost of a "
1530 "sequential page fetch. A higher value makes it more likely a "
1531 "sequential scan will be used, a lower value makes it more likely an "
1532 "index scan will be used.")
1535 DEFAULT_RANDOM_PAGE_COST, 0, DBL_MAX, NULL, NULL
1538 {"cpu_tuple_cost", PGC_USERSET, QUERY_TUNING_COST,
1539 gettext_noop("Sets the planner's estimate of the cost of processing each tuple (row)."),
1540 gettext_noop("This is measured as a fraction of the cost of a "
1541 "sequential page fetch.")
1544 DEFAULT_CPU_TUPLE_COST, 0, DBL_MAX, NULL, NULL
1547 {"cpu_index_tuple_cost", PGC_USERSET, QUERY_TUNING_COST,
1548 gettext_noop("Sets the planner's estimate of processing cost for each "
1549 "index tuple (row) during index scan."),
1550 gettext_noop("This is measured as a fraction of the cost of a "
1551 "sequential page fetch.")
1553 &cpu_index_tuple_cost,
1554 DEFAULT_CPU_INDEX_TUPLE_COST, 0, DBL_MAX, NULL, NULL
1557 {"cpu_operator_cost", PGC_USERSET, QUERY_TUNING_COST,
1558 gettext_noop("Sets the planner's estimate of processing cost of each operator in WHERE."),
1559 gettext_noop("This is measured as a fraction of the cost of a sequential "
1563 DEFAULT_CPU_OPERATOR_COST, 0, DBL_MAX, NULL, NULL
1567 {"geqo_selection_bias", PGC_USERSET, QUERY_TUNING_GEQO,
1568 gettext_noop("GEQO: selective pressure within the population."),
1571 &Geqo_selection_bias,
1572 DEFAULT_GEQO_SELECTION_BIAS, MIN_GEQO_SELECTION_BIAS,
1573 MAX_GEQO_SELECTION_BIAS, NULL, NULL
1577 {"bgwriter_lru_percent", PGC_SIGHUP, RESOURCES,
1578 gettext_noop("Background writer percentage of LRU buffers to flush per round"),
1581 &bgwriter_lru_percent,
1582 1.0, 0.0, 100.0, NULL, NULL
1586 {"bgwriter_all_percent", PGC_SIGHUP, RESOURCES,
1587 gettext_noop("Background writer percentage of all buffers to flush per round"),
1590 &bgwriter_all_percent,
1591 0.333, 0.0, 100.0, NULL, NULL
1595 {"seed", PGC_USERSET, UNGROUPED,
1596 gettext_noop("Sets the seed for random-number generation."),
1598 GUC_NO_SHOW_ALL | GUC_NO_RESET_ALL | GUC_NOT_IN_SAMPLE | GUC_DISALLOW_IN_FILE
1601 0.5, 0.0, 1.0, assign_random_seed, show_random_seed
1605 {"autovacuum_vacuum_scale_factor", PGC_SIGHUP, AUTOVACUUM,
1606 gettext_noop("Number of tuple updates or deletes prior to vacuum as a fraction of reltuples."),
1609 &autovacuum_vac_scale,
1610 0.4, 0.0, 100.0, NULL, NULL
1613 {"autovacuum_analyze_scale_factor", PGC_SIGHUP, AUTOVACUUM,
1614 gettext_noop("Number of tuple inserts, updates or deletes prior to analyze as a fraction of reltuples."),
1617 &autovacuum_anl_scale,
1618 0.2, 0.0, 100.0, NULL, NULL
1621 /* End-of-list marker */
1623 {NULL, 0, 0, NULL, NULL}, NULL, 0.0, 0.0, 0.0, NULL, NULL
1628 static struct config_string ConfigureNamesString[] =
1631 {"archive_command", PGC_SIGHUP, WAL_SETTINGS,
1632 gettext_noop("WAL archiving command."),
1633 gettext_noop("The shell command that will be called to archive a WAL file.")
1635 &XLogArchiveCommand,
1640 {"client_encoding", PGC_USERSET, CLIENT_CONN_LOCALE,
1641 gettext_noop("Sets the client's character set encoding."),
1645 &client_encoding_string,
1646 "SQL_ASCII", assign_client_encoding, NULL
1650 {"client_min_messages", PGC_USERSET, LOGGING_WHEN,
1651 gettext_noop("Sets the message levels that are sent to the client."),
1652 gettext_noop("Valid values are DEBUG5, DEBUG4, DEBUG3, DEBUG2, "
1653 "DEBUG1, LOG, NOTICE, WARNING, and ERROR. Each level includes all the "
1654 "levels that follow it. The later the level, the fewer messages are "
1657 &client_min_messages_str,
1658 "notice", assign_client_min_messages, NULL
1662 {"log_min_messages", PGC_SUSET, LOGGING_WHEN,
1663 gettext_noop("Sets the message levels that are logged."),
1664 gettext_noop("Valid values are DEBUG5, DEBUG4, DEBUG3, DEBUG2, DEBUG1, "
1665 "INFO, NOTICE, WARNING, ERROR, LOG, FATAL, and PANIC. Each level "
1666 "includes all the levels that follow it.")
1668 &log_min_messages_str,
1669 "notice", assign_log_min_messages, NULL
1673 {"log_error_verbosity", PGC_SUSET, LOGGING_WHEN,
1674 gettext_noop("Sets the verbosity of logged messages."),
1675 gettext_noop("Valid values are \"terse\", \"default\", and \"verbose\".")
1677 &log_error_verbosity_str,
1678 "default", assign_log_error_verbosity, NULL
1681 {"log_statement", PGC_SUSET, LOGGING_WHAT,
1682 gettext_noop("Sets the type of statements logged."),
1683 gettext_noop("Valid values are \"none\", \"ddl\", \"mod\", and \"all\".")
1686 "none", assign_log_statement, NULL
1690 {"log_min_error_statement", PGC_SUSET, LOGGING_WHEN,
1691 gettext_noop("Causes all statements generating error at or above this level to be logged."),
1692 gettext_noop("All SQL statements that cause an error of the "
1693 "specified level or a higher level are logged.")
1695 &log_min_error_statement_str,
1696 "panic", assign_min_error_statement, NULL
1700 {"log_line_prefix", PGC_SIGHUP, LOGGING_WHAT,
1701 gettext_noop("Controls information prefixed to each log line"),
1702 gettext_noop("if blank no prefix is used")
1710 {"DateStyle", PGC_USERSET, CLIENT_CONN_LOCALE,
1711 gettext_noop("Sets the display format for date and time values."),
1712 gettext_noop("Also controls interpretation of ambiguous "
1714 GUC_LIST_INPUT | GUC_REPORT
1717 "ISO, MDY", assign_datestyle, NULL
1721 {"default_tablespace", PGC_USERSET, CLIENT_CONN_STATEMENT,
1722 gettext_noop("Sets the default tablespace to create tables and indexes in."),
1723 gettext_noop("An empty string selects the database's default tablespace.")
1725 &default_tablespace,
1726 "", assign_default_tablespace, NULL
1730 {"default_transaction_isolation", PGC_USERSET, CLIENT_CONN_STATEMENT,
1731 gettext_noop("Sets the transaction isolation level of each new transaction."),
1732 gettext_noop("Each SQL transaction has an isolation level, which "
1733 "can be either \"read uncommitted\", \"read committed\", \"repeatable read\", or \"serializable\".")
1735 &default_iso_level_string,
1736 "read committed", assign_defaultxactisolevel, NULL
1740 {"dynamic_library_path", PGC_SUSET, CLIENT_CONN_OTHER,
1741 gettext_noop("Sets the path for dynamically loadable modules."),
1742 gettext_noop("If a dynamically loadable module needs to be opened and "
1743 "the specified name does not have a directory component (i.e., the "
1744 "name does not contain a slash), the system will search this path for "
1745 "the specified file."),
1748 &Dynamic_library_path,
1749 "$libdir", NULL, NULL
1753 {"krb_server_keyfile", PGC_POSTMASTER, CONN_AUTH_SECURITY,
1754 gettext_noop("Sets the location of the Kerberos server key file."),
1758 &pg_krb_server_keyfile,
1759 PG_KRB_SRVTAB, NULL, NULL
1763 {"krb_srvname", PGC_POSTMASTER, CONN_AUTH_SECURITY,
1764 gettext_noop("Sets the name of the Kerberos service."),
1768 PG_KRB_SRVNAM, NULL, NULL
1772 {"krb_server_hostname", PGC_POSTMASTER, CONN_AUTH_SECURITY,
1773 gettext_noop("Sets the hostname of the Kerberos server."),
1776 &pg_krb_server_hostname,
1781 {"bonjour_name", PGC_POSTMASTER, CONN_AUTH_SETTINGS,
1782 gettext_noop("Sets the Bonjour broadcast service name."),
1789 /* See main.c about why defaults for LC_foo are not all alike */
1792 {"lc_collate", PGC_INTERNAL, CLIENT_CONN_LOCALE,
1793 gettext_noop("Shows the collation order locale."),
1795 GUC_NOT_IN_SAMPLE | GUC_DISALLOW_IN_FILE
1802 {"lc_ctype", PGC_INTERNAL, CLIENT_CONN_LOCALE,
1803 gettext_noop("Shows the character classification and case conversion locale."),
1805 GUC_NOT_IN_SAMPLE | GUC_DISALLOW_IN_FILE
1812 {"lc_messages", PGC_SUSET, CLIENT_CONN_LOCALE,
1813 gettext_noop("Sets the language in which messages are displayed."),
1817 "", locale_messages_assign, NULL
1821 {"lc_monetary", PGC_USERSET, CLIENT_CONN_LOCALE,
1822 gettext_noop("Sets the locale for formatting monetary amounts."),
1826 "C", locale_monetary_assign, NULL
1830 {"lc_numeric", PGC_USERSET, CLIENT_CONN_LOCALE,
1831 gettext_noop("Sets the locale for formatting numbers."),
1835 "C", locale_numeric_assign, NULL
1839 {"lc_time", PGC_USERSET, CLIENT_CONN_LOCALE,
1840 gettext_noop("Sets the locale for formatting date and time values."),
1844 "C", locale_time_assign, NULL
1848 {"preload_libraries", PGC_POSTMASTER, RESOURCES_KERNEL,
1849 gettext_noop("Lists shared libraries to preload into server."),
1851 GUC_LIST_INPUT | GUC_LIST_QUOTE | GUC_SUPERUSER_ONLY
1853 &preload_libraries_string,
1858 {"regex_flavor", PGC_USERSET, COMPAT_OPTIONS_PREVIOUS,
1859 gettext_noop("Sets the regular expression \"flavor\"."),
1860 gettext_noop("This can be set to advanced, extended, or basic.")
1862 ®ex_flavor_string,
1863 "advanced", assign_regex_flavor, NULL
1867 {"search_path", PGC_USERSET, CLIENT_CONN_STATEMENT,
1868 gettext_noop("Sets the schema search order for names that are not schema-qualified."),
1870 GUC_LIST_INPUT | GUC_LIST_QUOTE
1872 &namespace_search_path,
1873 "$user,public", assign_search_path, NULL
1877 /* Can't be set in postgresql.conf */
1878 {"server_encoding", PGC_INTERNAL, CLIENT_CONN_LOCALE,
1879 gettext_noop("Sets the server (database) character set encoding."),
1881 GUC_REPORT | GUC_NOT_IN_SAMPLE | GUC_DISALLOW_IN_FILE
1883 &server_encoding_string,
1884 "SQL_ASCII", NULL, NULL
1888 /* Can't be set in postgresql.conf */
1889 {"server_version", PGC_INTERNAL, PRESET_OPTIONS,
1890 gettext_noop("Shows the server version."),
1892 GUC_REPORT | GUC_NOT_IN_SAMPLE | GUC_DISALLOW_IN_FILE
1894 &server_version_string,
1895 PG_VERSION, NULL, NULL
1899 /* Not for general use --- used by SET ROLE */
1900 {"role", PGC_USERSET, UNGROUPED,
1901 gettext_noop("Sets the current role."),
1903 GUC_NO_SHOW_ALL | GUC_NO_RESET_ALL | GUC_NOT_IN_SAMPLE | GUC_DISALLOW_IN_FILE
1906 "none", assign_role, show_role
1910 /* Not for general use --- used by SET SESSION AUTHORIZATION */
1911 {"session_authorization", PGC_USERSET, UNGROUPED,
1912 gettext_noop("Sets the session user name."),
1914 GUC_REPORT | GUC_NO_SHOW_ALL | GUC_NO_RESET_ALL | GUC_NOT_IN_SAMPLE | GUC_DISALLOW_IN_FILE
1916 &session_authorization_string,
1917 NULL, assign_session_authorization, show_session_authorization
1921 {"log_destination", PGC_SIGHUP, LOGGING_WHERE,
1922 gettext_noop("Sets the destination for server log output."),
1923 gettext_noop("Valid values are combinations of \"stderr\", \"syslog\", "
1924 "and \"eventlog\", depending on the platform."),
1927 &log_destination_string,
1928 "stderr", assign_log_destination, NULL
1931 {"log_directory", PGC_SIGHUP, LOGGING_WHERE,
1932 gettext_noop("Sets the destination directory for log files."),
1933 gettext_noop("May be specified as relative to the data directory "
1934 "or as absolute path."),
1938 "pg_log", assign_canonical_path, NULL
1941 {"log_filename", PGC_SIGHUP, LOGGING_WHERE,
1942 gettext_noop("Sets the file name pattern for log files."),
1947 "postgresql-%Y-%m-%d_%H%M%S.log", NULL, NULL
1952 {"syslog_facility", PGC_POSTMASTER, LOGGING_WHERE,
1953 gettext_noop("Sets the syslog \"facility\" to be used when syslog enabled."),
1954 gettext_noop("Valid values are LOCAL0, LOCAL1, LOCAL2, LOCAL3, "
1955 "LOCAL4, LOCAL5, LOCAL6, LOCAL7.")
1958 "LOCAL0", assign_facility, NULL
1961 {"syslog_ident", PGC_POSTMASTER, LOGGING_WHERE,
1962 gettext_noop("Sets the program name used to identify PostgreSQL messages "
1967 "postgres", NULL, NULL
1972 {"TimeZone", PGC_USERSET, CLIENT_CONN_LOCALE,
1973 gettext_noop("Sets the time zone for displaying and interpreting time stamps."),
1978 "UNKNOWN", assign_timezone, show_timezone
1982 {"transaction_isolation", PGC_USERSET, CLIENT_CONN_STATEMENT,
1983 gettext_noop("Sets the current transaction's isolation level."),
1985 GUC_NO_RESET_ALL | GUC_NOT_IN_SAMPLE | GUC_DISALLOW_IN_FILE
1987 &XactIsoLevel_string,
1988 NULL, assign_XactIsoLevel, show_XactIsoLevel
1992 {"unix_socket_group", PGC_POSTMASTER, CONN_AUTH_SETTINGS,
1993 gettext_noop("Sets the owning group of the Unix-domain socket."),
1994 gettext_noop("(The owning user of the socket is always the user "
1995 "that starts the server.)")
2002 {"unix_socket_directory", PGC_POSTMASTER, CONN_AUTH_SETTINGS,
2003 gettext_noop("Sets the directory where the Unix-domain socket will be created."),
2008 "", assign_canonical_path, NULL
2012 {"listen_addresses", PGC_POSTMASTER, CONN_AUTH_SETTINGS,
2013 gettext_noop("Sets the host name or IP address(es) to listen to."),
2018 "localhost", NULL, NULL
2022 {"wal_sync_method", PGC_SIGHUP, WAL_SETTINGS,
2023 gettext_noop("Selects the method used for forcing WAL updates out to disk."),
2027 XLOG_sync_method_default, assign_xlog_sync_method, NULL
2031 {"custom_variable_classes", PGC_SIGHUP, CUSTOM_OPTIONS,
2032 gettext_noop("Sets the list of known custom variable classes."),
2034 GUC_LIST_INPUT | GUC_LIST_QUOTE
2036 &custom_variable_classes,
2037 NULL, assign_custom_variable_classes, NULL
2041 {"data_directory", PGC_POSTMASTER, FILE_LOCATIONS,
2042 gettext_noop("Sets the server's data directory."),
2051 {"config_file", PGC_POSTMASTER, FILE_LOCATIONS,
2052 gettext_noop("Sets the server's main configuration file."),
2054 GUC_DISALLOW_IN_FILE | GUC_SUPERUSER_ONLY
2061 {"hba_file", PGC_POSTMASTER, FILE_LOCATIONS,
2062 gettext_noop("Sets the server's \"hba\" configuration file"),
2071 {"ident_file", PGC_POSTMASTER, FILE_LOCATIONS,
2072 gettext_noop("Sets the server's \"ident\" configuration file"),
2081 {"external_pid_file", PGC_POSTMASTER, FILE_LOCATIONS,
2082 gettext_noop("Writes the postmaster PID to the specified file."),
2087 NULL, assign_canonical_path, NULL
2090 /* End-of-list marker */
2092 {NULL, 0, 0, NULL, NULL}, NULL, NULL, NULL, NULL
2097 /******** end of options list ********/
2101 * To allow continued support of obsolete names for GUC variables, we apply
2102 * the following mappings to any unrecognized name. Note that an old name
2103 * should be mapped to a new one only if the new variable has very similar
2104 * semantics to the old.
2106 static const char *const map_old_guc_names[] = {
2107 "sort_mem", "work_mem",
2108 "vacuum_mem", "maintenance_work_mem",
2114 * Actual lookup of variables is done through this single, sorted array.
2116 static struct config_generic **guc_variables;
2118 /* Current number of variables contained in the vector */
2119 static int num_guc_variables;
2121 /* Vector capacity */
2122 static int size_guc_variables;
2125 static bool guc_dirty; /* TRUE if need to do commit/abort work */
2127 static bool reporting_enabled; /* TRUE to enable GUC_REPORT */
2130 static int guc_var_compare(const void *a, const void *b);
2131 static int guc_name_compare(const char *namea, const char *nameb);
2132 static void push_old_value(struct config_generic * gconf);
2133 static void ReportGUCOption(struct config_generic * record);
2134 static void ShowGUCConfigOption(const char *name, DestReceiver *dest);
2135 static void ShowAllGUCConfig(DestReceiver *dest);
2136 static char *_ShowOption(struct config_generic * record);
2140 * Some infrastructure for checking malloc/strdup/realloc calls
2143 guc_malloc(int elevel, size_t size)
2147 data = malloc(size);
2150 (errcode(ERRCODE_OUT_OF_MEMORY),
2151 errmsg("out of memory")));
2156 guc_realloc(int elevel, void *old, size_t size)
2160 data = realloc(old, size);
2163 (errcode(ERRCODE_OUT_OF_MEMORY),
2164 errmsg("out of memory")));
2169 guc_strdup(int elevel, const char *src)
2176 (errcode(ERRCODE_OUT_OF_MEMORY),
2177 errmsg("out of memory")));
2183 * Support for assigning to a field of a string GUC item. Free the prior
2184 * value if it's not referenced anywhere else in the item (including stacked
2188 set_string_field(struct config_string * conf, char **field, char *newval)
2190 char *oldval = *field;
2193 /* Do the assignment */
2196 /* Exit if any duplicate references, or if old value was NULL anyway */
2197 if (oldval == NULL ||
2198 oldval == *(conf->variable) ||
2199 oldval == conf->reset_val ||
2200 oldval == conf->tentative_val)
2202 for (stack = conf->gen.stack; stack; stack = stack->prev)
2204 if (oldval == stack->tentative_val.stringval ||
2205 oldval == stack->value.stringval)
2209 /* Not used anymore, so free it */
2214 * Detect whether strval is referenced anywhere in a GUC string item
2217 string_field_used(struct config_string * conf, char *strval)
2221 if (strval == *(conf->variable) ||
2222 strval == conf->reset_val ||
2223 strval == conf->tentative_val)
2225 for (stack = conf->gen.stack; stack; stack = stack->prev)
2227 if (strval == stack->tentative_val.stringval ||
2228 strval == stack->value.stringval)
2235 struct config_generic **
2236 get_guc_variables(void)
2238 return guc_variables;
2243 * Build the sorted array. This is split out so that it could be
2244 * re-executed after startup (eg, we could allow loadable modules to
2245 * add vars, and then we'd need to re-sort).
2248 build_guc_variables(void)
2252 struct config_generic **guc_vars;
2255 for (i = 0; ConfigureNamesBool[i].gen.name; i++)
2257 struct config_bool *conf = &ConfigureNamesBool[i];
2259 /* Rather than requiring vartype to be filled in by hand, do this: */
2260 conf->gen.vartype = PGC_BOOL;
2264 for (i = 0; ConfigureNamesInt[i].gen.name; i++)
2266 struct config_int *conf = &ConfigureNamesInt[i];
2268 conf->gen.vartype = PGC_INT;
2272 for (i = 0; ConfigureNamesReal[i].gen.name; i++)
2274 struct config_real *conf = &ConfigureNamesReal[i];
2276 conf->gen.vartype = PGC_REAL;
2280 for (i = 0; ConfigureNamesString[i].gen.name; i++)
2282 struct config_string *conf = &ConfigureNamesString[i];
2284 conf->gen.vartype = PGC_STRING;
2289 * Create table with 20% slack
2291 size_vars = num_vars + num_vars / 4;
2293 guc_vars = (struct config_generic **)
2294 guc_malloc(FATAL, size_vars * sizeof(struct config_generic *));
2298 for (i = 0; ConfigureNamesBool[i].gen.name; i++)
2299 guc_vars[num_vars++] = &ConfigureNamesBool[i].gen;
2301 for (i = 0; ConfigureNamesInt[i].gen.name; i++)
2302 guc_vars[num_vars++] = &ConfigureNamesInt[i].gen;
2304 for (i = 0; ConfigureNamesReal[i].gen.name; i++)
2305 guc_vars[num_vars++] = &ConfigureNamesReal[i].gen;
2307 for (i = 0; ConfigureNamesString[i].gen.name; i++)
2308 guc_vars[num_vars++] = &ConfigureNamesString[i].gen;
2311 free(guc_variables);
2312 guc_variables = guc_vars;
2313 num_guc_variables = num_vars;
2314 size_guc_variables = size_vars;
2315 qsort((void *) guc_variables, num_guc_variables,
2316 sizeof(struct config_generic *), guc_var_compare);
2320 is_custom_class(const char *name, int dotPos)
2323 * assign_custom_variable_classes() has made sure no empty
2324 * identifiers or whitespace exists in the variable
2326 bool result = false;
2327 const char *ccs = GetConfigOption("custom_variable_classes");
2331 const char *start = ccs;
2337 if (c == 0 || c == ',')
2339 if (dotPos == ccs - start && strncmp(start, name, dotPos) == 0)
2354 * Add a new GUC variable to the list of known variables. The
2355 * list is expanded if needed.
2358 add_guc_variable(struct config_generic * var, int elevel)
2360 if (num_guc_variables + 1 >= size_guc_variables)
2363 * Increase the vector by 25%
2365 int size_vars = size_guc_variables + size_guc_variables / 4;
2366 struct config_generic **guc_vars;
2371 guc_vars = (struct config_generic **)
2372 guc_malloc(elevel, size_vars * sizeof(struct config_generic *));
2376 guc_vars = (struct config_generic **)
2377 guc_realloc(elevel, guc_variables, size_vars * sizeof(struct config_generic *));
2380 if (guc_vars == NULL)
2381 return false; /* out of memory */
2383 guc_variables = guc_vars;
2384 size_guc_variables = size_vars;
2386 guc_variables[num_guc_variables++] = var;
2387 qsort((void *) guc_variables, num_guc_variables,
2388 sizeof(struct config_generic *), guc_var_compare);
2393 * Create and add a placeholder variable. It's presumed to belong
2394 * to a valid custom variable class at this point.
2396 static struct config_string *
2397 add_placeholder_variable(const char *name, int elevel)
2399 size_t sz = sizeof(struct config_string) + sizeof(char *);
2400 struct config_string *var;
2401 struct config_generic *gen;
2403 var = (struct config_string *) guc_malloc(elevel, sz);
2410 gen->name = guc_strdup(elevel, name);
2411 if (gen->name == NULL)
2417 gen->context = PGC_USERSET;
2418 gen->group = CUSTOM_OPTIONS;
2419 gen->short_desc = "GUC placeholder variable";
2420 gen->flags = GUC_NO_SHOW_ALL | GUC_NOT_IN_SAMPLE | GUC_CUSTOM_PLACEHOLDER;
2421 gen->vartype = PGC_STRING;
2424 * The char* is allocated at the end of the struct since we have no
2425 * 'static' place to point to.
2427 var->variable = (char **) (var + 1);
2429 if (!add_guc_variable((struct config_generic *) var, elevel))
2431 free((void *) gen->name);
2440 * Look up option NAME. If it exists, return a pointer to its record,
2443 static struct config_generic *
2444 find_option(const char *name, int elevel)
2447 const char **key = &name;
2448 struct config_generic **res;
2454 * By equating const char ** with struct config_generic *, we are
2455 * assuming the name field is first in config_generic.
2457 res = (struct config_generic **) bsearch((void *) &key,
2458 (void *) guc_variables,
2460 sizeof(struct config_generic *),
2466 * See if the name is an obsolete name for a variable. We assume that
2467 * the set of supported old names is short enough that a brute-force
2468 * search is the best way.
2470 for (i = 0; map_old_guc_names[i] != NULL; i += 2)
2472 if (guc_name_compare(name, map_old_guc_names[i]) == 0)
2473 return find_option(map_old_guc_names[i + 1], elevel);
2477 * Check if the name is qualified, and if so, check if the qualifier
2478 * maps to a custom variable class.
2480 dot = strchr(name, GUC_QUALIFIER_SEPARATOR);
2481 if (dot != NULL && is_custom_class(name, dot - name))
2482 /* Add a placeholder variable for this name */
2483 return (struct config_generic *) add_placeholder_variable(name, elevel);
2491 * comparator for qsorting and bsearching guc_variables array
2494 guc_var_compare(const void *a, const void *b)
2496 struct config_generic *confa = *(struct config_generic **) a;
2497 struct config_generic *confb = *(struct config_generic **) b;
2499 return guc_name_compare(confa->name, confb->name);
2504 guc_name_compare(const char *namea, const char *nameb)
2507 * The temptation to use strcasecmp() here must be resisted, because
2508 * the array ordering has to remain stable across setlocale() calls.
2509 * So, build our own with a simple ASCII-only downcasing.
2511 while (*namea && *nameb)
2513 char cha = *namea++;
2514 char chb = *nameb++;
2516 if (cha >= 'A' && cha <= 'Z')
2518 if (chb >= 'A' && chb <= 'Z')
2524 return 1; /* a is longer */
2526 return -1; /* b is longer */
2532 * Initialize GUC options during program startup.
2534 * Note that we cannot read the config file yet, since we have not yet
2535 * processed command-line switches.
2538 InitializeGUCOptions(void)
2544 * Build sorted array of all GUC variables.
2546 build_guc_variables();
2549 * Load all variables with their compiled-in defaults, and initialize
2550 * status fields as needed.
2552 for (i = 0; i < num_guc_variables; i++)
2554 struct config_generic *gconf = guc_variables[i];
2557 gconf->reset_source = PGC_S_DEFAULT;
2558 gconf->tentative_source = PGC_S_DEFAULT;
2559 gconf->source = PGC_S_DEFAULT;
2560 gconf->stack = NULL;
2562 switch (gconf->vartype)
2566 struct config_bool *conf = (struct config_bool *) gconf;
2568 if (conf->assign_hook)
2569 if (!(*conf->assign_hook) (conf->reset_val, true,
2571 elog(FATAL, "failed to initialize %s to %d",
2572 conf->gen.name, (int) conf->reset_val);
2573 *conf->variable = conf->reset_val;
2578 struct config_int *conf = (struct config_int *) gconf;
2580 Assert(conf->reset_val >= conf->min);
2581 Assert(conf->reset_val <= conf->max);
2582 if (conf->assign_hook)
2583 if (!(*conf->assign_hook) (conf->reset_val, true,
2585 elog(FATAL, "failed to initialize %s to %d",
2586 conf->gen.name, conf->reset_val);
2587 *conf->variable = conf->reset_val;
2592 struct config_real *conf = (struct config_real *) gconf;
2594 Assert(conf->reset_val >= conf->min);
2595 Assert(conf->reset_val <= conf->max);
2596 if (conf->assign_hook)
2597 if (!(*conf->assign_hook) (conf->reset_val, true,
2599 elog(FATAL, "failed to initialize %s to %g",
2600 conf->gen.name, conf->reset_val);
2601 *conf->variable = conf->reset_val;
2606 struct config_string *conf = (struct config_string *) gconf;
2609 *conf->variable = NULL;
2610 conf->reset_val = NULL;
2611 conf->tentative_val = NULL;
2613 if (conf->boot_val == NULL)
2615 /* Cannot set value yet */
2619 str = guc_strdup(FATAL, conf->boot_val);
2620 conf->reset_val = str;
2622 if (conf->assign_hook)
2626 newstr = (*conf->assign_hook) (str, true,
2630 elog(FATAL, "failed to initialize %s to \"%s\"",
2631 conf->gen.name, str);
2633 else if (newstr != str)
2638 * See notes in set_config_option about
2641 str = (char *) newstr;
2642 conf->reset_val = str;
2645 *conf->variable = str;
2653 reporting_enabled = false;
2656 * Prevent any attempt to override the transaction modes from
2657 * non-interactive sources.
2659 SetConfigOption("transaction_isolation", "default",
2660 PGC_POSTMASTER, PGC_S_OVERRIDE);
2661 SetConfigOption("transaction_read_only", "no",
2662 PGC_POSTMASTER, PGC_S_OVERRIDE);
2665 * For historical reasons, some GUC parameters can receive defaults
2666 * from environment variables. Process those settings.
2669 env = getenv("PGPORT");
2671 SetConfigOption("port", env, PGC_POSTMASTER, PGC_S_ENV_VAR);
2673 env = getenv("PGDATESTYLE");
2675 SetConfigOption("datestyle", env, PGC_POSTMASTER, PGC_S_ENV_VAR);
2677 env = getenv("PGCLIENTENCODING");
2679 SetConfigOption("client_encoding", env, PGC_POSTMASTER, PGC_S_ENV_VAR);
2684 * Select the configuration files and data directory to be used, and
2685 * do the initial read of postgresql.conf.
2687 * This is called after processing command-line switches.
2688 * userDoption is the -D switch value if any (NULL if unspecified).
2689 * progname is just for use in error messages.
2691 * Returns true on success; on failure, prints a suitable error message
2692 * to stderr and returns false.
2695 SelectConfigFiles(const char *userDoption, const char *progname)
2699 struct stat stat_buf;
2701 /* configdir is -D option, or $PGDATA if no -D */
2703 configdir = make_absolute_path(userDoption);
2705 configdir = make_absolute_path(getenv("PGDATA"));
2708 * Find the configuration file: if config_file was specified on the
2709 * command line, use it, else use configdir/postgresql.conf. In any
2710 * case ensure the result is an absolute path, so that it will be
2711 * interpreted the same way by future backends.
2714 fname = make_absolute_path(ConfigFileName);
2717 fname = guc_malloc(FATAL,
2718 strlen(configdir) + strlen(CONFIG_FILENAME) + 2);
2719 sprintf(fname, "%s/%s", configdir, CONFIG_FILENAME);
2723 write_stderr("%s does not know where to find the server configuration file.\n"
2724 "You must specify the --config-file or -D invocation "
2725 "option or set the PGDATA environment variable.\n",
2731 * Set the ConfigFileName GUC variable to its final value, ensuring
2732 * that it can't be overridden later.
2734 SetConfigOption("config_file", fname, PGC_POSTMASTER, PGC_S_OVERRIDE);
2738 * Now read the config file for the first time.
2740 if (stat(ConfigFileName, &stat_buf) != 0)
2742 write_stderr("%s cannot access the server configuration file \"%s\": %s\n",
2743 progname, ConfigFileName, strerror(errno));
2747 ProcessConfigFile(PGC_POSTMASTER);
2750 * If the data_directory GUC variable has been set, use that as DataDir;
2751 * otherwise use configdir if set; else punt.
2753 * Note: SetDataDir will copy and absolute-ize its argument,
2754 * so we don't have to.
2757 SetDataDir(data_directory);
2759 SetDataDir(configdir);
2762 write_stderr("%s does not know where to find the database system data.\n"
2763 "This can be specified as \"data_directory\" in \"%s\", "
2764 "or by the -D invocation option, or by the "
2765 "PGDATA environment variable.\n",
2766 progname, ConfigFileName);
2771 * Reflect the final DataDir value back into the data_directory GUC var.
2772 * (If you are wondering why we don't just make them a single variable,
2773 * it's because the EXEC_BACKEND case needs DataDir to be transmitted to
2774 * child backends specially. XXX is that still true? Given that we
2775 * now chdir to DataDir, EXEC_BACKEND can read the config file without
2776 * knowing DataDir in advance.)
2778 SetConfigOption("data_directory", DataDir, PGC_POSTMASTER, PGC_S_OVERRIDE);
2781 * Figure out where pg_hba.conf is, and make sure the path is absolute.
2784 fname = make_absolute_path(HbaFileName);
2787 fname = guc_malloc(FATAL,
2788 strlen(configdir) + strlen(HBA_FILENAME) + 2);
2789 sprintf(fname, "%s/%s", configdir, HBA_FILENAME);
2793 write_stderr("%s does not know where to find the \"hba\" configuration file.\n"
2794 "This can be specified as \"hba_file\" in \"%s\", "
2795 "or by the -D invocation option, or by the "
2796 "PGDATA environment variable.\n",
2797 progname, ConfigFileName);
2800 SetConfigOption("hba_file", fname, PGC_POSTMASTER, PGC_S_OVERRIDE);
2804 * Likewise for pg_ident.conf.
2807 fname = make_absolute_path(IdentFileName);
2810 fname = guc_malloc(FATAL,
2811 strlen(configdir) + strlen(IDENT_FILENAME) + 2);
2812 sprintf(fname, "%s/%s", configdir, IDENT_FILENAME);
2816 write_stderr("%s does not know where to find the \"ident\" configuration file.\n"
2817 "This can be specified as \"ident_file\" in \"%s\", "
2818 "or by the -D invocation option, or by the "
2819 "PGDATA environment variable.\n",
2820 progname, ConfigFileName);
2823 SetConfigOption("ident_file", fname, PGC_POSTMASTER, PGC_S_OVERRIDE);
2828 /* If timezone is not set, determine what the OS uses */
2829 pg_timezone_initialize();
2836 * Reset all options to their saved default values (implements RESET ALL)
2839 ResetAllOptions(void)
2843 for (i = 0; i < num_guc_variables; i++)
2845 struct config_generic *gconf = guc_variables[i];
2847 /* Don't reset non-SET-able values */
2848 if (gconf->context != PGC_SUSET &&
2849 gconf->context != PGC_USERSET)
2851 /* Don't reset if special exclusion from RESET ALL */
2852 if (gconf->flags & GUC_NO_RESET_ALL)
2854 /* No need to reset if wasn't SET */
2855 if (gconf->source <= PGC_S_OVERRIDE)
2858 /* Save old value to support transaction abort */
2859 push_old_value(gconf);
2861 switch (gconf->vartype)
2865 struct config_bool *conf = (struct config_bool *) gconf;
2867 if (conf->assign_hook)
2868 if (!(*conf->assign_hook) (conf->reset_val, true,
2870 elog(ERROR, "failed to reset %s", conf->gen.name);
2871 *conf->variable = conf->reset_val;
2872 conf->tentative_val = conf->reset_val;
2873 conf->gen.source = conf->gen.reset_source;
2874 conf->gen.tentative_source = conf->gen.reset_source;
2875 conf->gen.status |= GUC_HAVE_TENTATIVE;
2881 struct config_int *conf = (struct config_int *) gconf;
2883 if (conf->assign_hook)
2884 if (!(*conf->assign_hook) (conf->reset_val, true,
2886 elog(ERROR, "failed to reset %s", conf->gen.name);
2887 *conf->variable = conf->reset_val;
2888 conf->tentative_val = conf->reset_val;
2889 conf->gen.source = conf->gen.reset_source;
2890 conf->gen.tentative_source = conf->gen.reset_source;
2891 conf->gen.status |= GUC_HAVE_TENTATIVE;
2897 struct config_real *conf = (struct config_real *) gconf;
2899 if (conf->assign_hook)
2900 if (!(*conf->assign_hook) (conf->reset_val, true,
2902 elog(ERROR, "failed to reset %s", conf->gen.name);
2903 *conf->variable = conf->reset_val;
2904 conf->tentative_val = conf->reset_val;
2905 conf->gen.source = conf->gen.reset_source;
2906 conf->gen.tentative_source = conf->gen.reset_source;
2907 conf->gen.status |= GUC_HAVE_TENTATIVE;
2913 struct config_string *conf = (struct config_string *) gconf;
2916 if (conf->reset_val == NULL)
2918 /* Nothing to reset to, as yet; so do nothing */
2922 /* We need not strdup here */
2923 str = conf->reset_val;
2925 if (conf->assign_hook)
2929 newstr = (*conf->assign_hook) (str, true,
2932 elog(ERROR, "failed to reset %s", conf->gen.name);
2933 else if (newstr != str)
2936 * See notes in set_config_option about
2939 str = (char *) newstr;
2943 set_string_field(conf, conf->variable, str);
2944 set_string_field(conf, &conf->tentative_val, str);
2945 conf->gen.source = conf->gen.reset_source;
2946 conf->gen.tentative_source = conf->gen.reset_source;
2947 conf->gen.status |= GUC_HAVE_TENTATIVE;
2953 if (gconf->flags & GUC_REPORT)
2954 ReportGUCOption(gconf);
2961 * Push previous state during first assignment to a GUC variable
2962 * within a particular transaction.
2964 * We have to be willing to "back-fill" the state stack if the first
2965 * assignment occurs within a subtransaction nested several levels deep.
2966 * This ensures that if an intermediate transaction aborts, it will have
2967 * the proper value available to restore the setting to.
2970 push_old_value(struct config_generic * gconf)
2972 int my_level = GetCurrentTransactionNestLevel();
2975 /* If we're not inside a transaction, do nothing */
2981 /* Done if we already pushed it at this nesting depth */
2982 if (gconf->stack && gconf->stack->nest_level >= my_level)
2986 * We keep all the stack entries in TopTransactionContext so as to
2987 * avoid allocation problems when a subtransaction back-fills
2988 * stack entries for upper transaction levels.
2990 stack = (GucStack *) MemoryContextAlloc(TopTransactionContext,
2993 stack->prev = gconf->stack;
2994 stack->nest_level = stack->prev ? stack->prev->nest_level + 1 : 1;
2995 stack->status = gconf->status;
2996 stack->tentative_source = gconf->tentative_source;
2997 stack->source = gconf->source;
2999 switch (gconf->vartype)
3002 stack->tentative_val.boolval =
3003 ((struct config_bool *) gconf)->tentative_val;
3004 stack->value.boolval =
3005 *((struct config_bool *) gconf)->variable;
3009 stack->tentative_val.intval =
3010 ((struct config_int *) gconf)->tentative_val;
3011 stack->value.intval =
3012 *((struct config_int *) gconf)->variable;
3016 stack->tentative_val.realval =
3017 ((struct config_real *) gconf)->tentative_val;
3018 stack->value.realval =
3019 *((struct config_real *) gconf)->variable;
3023 stack->tentative_val.stringval =
3024 ((struct config_string *) gconf)->tentative_val;
3025 stack->value.stringval =
3026 *((struct config_string *) gconf)->variable;
3030 gconf->stack = stack;
3032 /* Set state to indicate nothing happened yet within this level */
3033 gconf->status = GUC_HAVE_STACK;
3035 /* Ensure we remember to pop at end of xact */
3041 * Do GUC processing at transaction or subtransaction commit or abort.
3044 AtEOXact_GUC(bool isCommit, bool isSubXact)
3049 /* Quick exit if nothing's changed in this transaction */
3053 my_level = GetCurrentTransactionNestLevel();
3054 Assert(isSubXact ? (my_level > 1) : (my_level == 1));
3056 for (i = 0; i < num_guc_variables; i++)
3058 struct config_generic *gconf = guc_variables[i];
3059 int my_status = gconf->status;
3060 GucStack *stack = gconf->stack;
3065 * Skip if nothing's happened to this var in this transaction
3069 Assert(stack == NULL);
3072 /* Assert that we stacked old value before changing it */
3073 Assert(stack != NULL && (my_status & GUC_HAVE_STACK));
3074 /* However, the last change may have been at an outer xact level */
3075 if (stack->nest_level < my_level)
3077 Assert(stack->nest_level == my_level);
3080 * We will pop the stack entry. Start by restoring outer xact
3081 * status (since we may want to modify it below). Be careful to
3082 * use my_status to reference the inner xact status below this
3085 gconf->status = stack->status;
3088 * We have two cases:
3090 * If commit and HAVE_TENTATIVE, set actual value to tentative (this
3091 * is to override a SET LOCAL if one occurred later than SET). We
3092 * keep the tentative value and propagate HAVE_TENTATIVE to the
3093 * parent status, allowing the SET's effect to percolate up. (But
3094 * if we're exiting the outermost transaction, we'll drop the
3095 * HAVE_TENTATIVE bit below.)
3097 * Otherwise, we have a transaction that aborted or executed only SET
3098 * LOCAL (or no SET at all). In either case it should have no
3099 * further effect, so restore both tentative and actual values
3100 * from the stack entry.
3103 useTentative = isCommit && (my_status & GUC_HAVE_TENTATIVE) != 0;
3106 switch (gconf->vartype)
3110 struct config_bool *conf = (struct config_bool *) gconf;
3112 GucSource newsource;
3116 newval = conf->tentative_val;
3117 newsource = conf->gen.tentative_source;
3118 conf->gen.status |= GUC_HAVE_TENTATIVE;
3122 newval = stack->value.boolval;
3123 newsource = stack->source;
3124 conf->tentative_val = stack->tentative_val.boolval;
3125 conf->gen.tentative_source = stack->tentative_source;
3128 if (*conf->variable != newval)
3130 if (conf->assign_hook)
3131 if (!(*conf->assign_hook) (newval,
3132 true, PGC_S_OVERRIDE))
3133 elog(LOG, "failed to commit %s",
3135 *conf->variable = newval;
3138 conf->gen.source = newsource;
3143 struct config_int *conf = (struct config_int *) gconf;
3145 GucSource newsource;
3149 newval = conf->tentative_val;
3150 newsource = conf->gen.tentative_source;
3151 conf->gen.status |= GUC_HAVE_TENTATIVE;
3155 newval = stack->value.intval;
3156 newsource = stack->source;
3157 conf->tentative_val = stack->tentative_val.intval;
3158 conf->gen.tentative_source = stack->tentative_source;
3161 if (*conf->variable != newval)
3163 if (conf->assign_hook)
3164 if (!(*conf->assign_hook) (newval,
3165 true, PGC_S_OVERRIDE))
3166 elog(LOG, "failed to commit %s",
3168 *conf->variable = newval;
3171 conf->gen.source = newsource;
3176 struct config_real *conf = (struct config_real *) gconf;
3178 GucSource newsource;
3182 newval = conf->tentative_val;
3183 newsource = conf->gen.tentative_source;
3184 conf->gen.status |= GUC_HAVE_TENTATIVE;
3188 newval = stack->value.realval;
3189 newsource = stack->source;
3190 conf->tentative_val = stack->tentative_val.realval;
3191 conf->gen.tentative_source = stack->tentative_source;
3194 if (*conf->variable != newval)
3196 if (conf->assign_hook)
3197 if (!(*conf->assign_hook) (newval,
3198 true, PGC_S_OVERRIDE))
3199 elog(LOG, "failed to commit %s",
3201 *conf->variable = newval;
3204 conf->gen.source = newsource;
3209 struct config_string *conf = (struct config_string *) gconf;
3211 GucSource newsource;
3215 newval = conf->tentative_val;
3216 newsource = conf->gen.tentative_source;
3217 conf->gen.status |= GUC_HAVE_TENTATIVE;
3221 newval = stack->value.stringval;
3222 newsource = stack->source;
3223 set_string_field(conf, &conf->tentative_val,
3224 stack->tentative_val.stringval);
3225 conf->gen.tentative_source = stack->tentative_source;
3228 if (*conf->variable != newval)
3230 if (conf->assign_hook)
3234 newstr = (*conf->assign_hook) (newval, true,
3237 elog(LOG, "failed to commit %s",
3239 else if (newstr != newval)
3242 * If newval should now be freed, it'll be
3243 * taken care of below.
3245 * See notes in set_config_option about
3248 newval = (char *) newstr;
3252 set_string_field(conf, conf->variable, newval);
3255 conf->gen.source = newsource;
3256 /* Release stacked values if not used anymore */
3257 set_string_field(conf, &stack->value.stringval,
3259 set_string_field(conf, &stack->tentative_val.stringval,
3261 /* Don't store tentative value separately after commit */
3263 set_string_field(conf, &conf->tentative_val, NULL);
3268 /* Finish popping the state stack */
3269 gconf->stack = stack->prev;
3273 * If we're now out of all xact levels, forget TENTATIVE status
3274 * bit; there's nothing tentative about the value anymore.
3278 Assert(gconf->stack == NULL);
3282 /* Report new value if we changed it */
3283 if (changed && (gconf->flags & GUC_REPORT))
3284 ReportGUCOption(gconf);
3288 * If we're now out of all xact levels, we can clear guc_dirty. (Note:
3289 * we cannot reset guc_dirty when exiting a subtransaction, because we
3290 * know that all outer transaction levels will have stacked values to
3299 * Start up automatic reporting of changes to variables marked GUC_REPORT.
3300 * This is executed at completion of backend startup.
3303 BeginReportingGUCOptions(void)
3308 * Don't do anything unless talking to an interactive frontend of
3309 * protocol 3.0 or later.
3311 if (whereToSendOutput != Remote ||
3312 PG_PROTOCOL_MAJOR(FrontendProtocol) < 3)
3315 reporting_enabled = true;
3317 /* Transmit initial values of interesting variables */
3318 for (i = 0; i < num_guc_variables; i++)
3320 struct config_generic *conf = guc_variables[i];
3322 if (conf->flags & GUC_REPORT)
3323 ReportGUCOption(conf);
3328 * ReportGUCOption: if appropriate, transmit option value to frontend
3331 ReportGUCOption(struct config_generic * record)
3333 if (reporting_enabled && (record->flags & GUC_REPORT))
3335 char *val = _ShowOption(record);
3336 StringInfoData msgbuf;
3338 pq_beginmessage(&msgbuf, 'S');
3339 pq_sendstring(&msgbuf, record->name);
3340 pq_sendstring(&msgbuf, val);
3341 pq_endmessage(&msgbuf);
3349 * Try to interpret value as boolean value. Valid values are: true,
3350 * false, yes, no, on, off, 1, 0. If the string parses okay, return
3351 * true, else false. If result is not NULL, return the parsing result
3355 parse_bool(const char *value, bool *result)
3357 size_t len = strlen(value);
3359 if (pg_strncasecmp(value, "true", len) == 0)
3364 else if (pg_strncasecmp(value, "false", len) == 0)
3370 else if (pg_strncasecmp(value, "yes", len) == 0)
3375 else if (pg_strncasecmp(value, "no", len) == 0)
3381 else if (pg_strcasecmp(value, "on") == 0)
3386 else if (pg_strcasecmp(value, "off") == 0)
3392 else if (pg_strcasecmp(value, "1") == 0)
3397 else if (pg_strcasecmp(value, "0") == 0)
3411 * Try to parse value as an integer. The accepted formats are the
3412 * usual decimal, octal, or hexadecimal formats. If the string parses
3413 * okay, return true, else false. If result is not NULL, return the
3417 parse_int(const char *value, int *result)
3423 val = strtol(value, &endptr, 0);
3424 if (endptr == value || *endptr != '\0' || errno == ERANGE
3425 #ifdef HAVE_LONG_INT_64
3426 /* if long > 32 bits, check for overflow of int4 */
3427 || val != (long) ((int32) val)
3432 *result = (int) val;
3439 * Try to parse value as a floating point constant in the usual
3440 * format. If the value parsed okay return true, else false. If
3441 * result is not NULL, return the semantic value there.
3444 parse_real(const char *value, double *result)
3450 val = strtod(value, &endptr);
3451 if (endptr == value || *endptr != '\0' || errno == ERANGE)
3460 * Call a GucStringAssignHook function, being careful to free the
3461 * "newval" string if the hook ereports.
3463 * This is split out of set_config_option just to avoid the "volatile"
3464 * qualifiers that would otherwise have to be plastered all over.
3467 call_string_assign_hook(GucStringAssignHook assign_hook,
3468 char *newval, bool doit, GucSource source)
3474 result = (*assign_hook) (newval, doit, source);
3488 * Sets option `name' to given value. The value should be a string
3489 * which is going to be parsed and converted to the appropriate data
3490 * type. The context and source parameters indicate in which context this
3491 * function is being called so it can apply the access restrictions
3494 * If value is NULL, set the option to its default value. If the
3495 * parameter changeVal is false then don't really set the option but do all
3496 * the checks to see if it would work.
3498 * If there is an error (non-existing option, invalid value) then an
3499 * ereport(ERROR) is thrown *unless* this is called in a context where we
3500 * don't want to ereport (currently, startup or SIGHUP config file reread).
3501 * In that case we write a suitable error message via ereport(DEBUG) and
3502 * return false. This is working around the deficiencies in the ereport
3503 * mechanism, so don't blame me. In all other cases, the function
3504 * returns true, including cases where the input is valid but we chose
3505 * not to apply it because of context or source-priority considerations.
3507 * See also SetConfigOption for an external interface.
3510 set_config_option(const char *name, const char *value,
3511 GucContext context, GucSource source,
3512 bool isLocal, bool changeVal)
3514 struct config_generic *record;
3518 if (context == PGC_SIGHUP || source == PGC_S_DEFAULT)
3521 * To avoid cluttering the log, only the postmaster bleats loudly
3522 * about problems with the config file.
3524 elevel = IsUnderPostmaster ? DEBUG2 : LOG;
3526 else if (source == PGC_S_DATABASE || source == PGC_S_USER)
3531 record = find_option(name, elevel);
3535 (errcode(ERRCODE_UNDEFINED_OBJECT),
3536 errmsg("unrecognized configuration parameter \"%s\"", name)));
3541 * Check if the option can be set at this time. See guc.h for the
3542 * precise rules. Note that we don't want to throw errors if we're in
3543 * the SIGHUP context. In that case we just ignore the attempt and
3546 switch (record->context)
3549 if (context == PGC_SIGHUP)
3551 if (context != PGC_INTERNAL)
3554 (errcode(ERRCODE_CANT_CHANGE_RUNTIME_PARAM),
3555 errmsg("parameter \"%s\" cannot be changed",
3560 case PGC_POSTMASTER:
3561 if (context == PGC_SIGHUP)
3563 if (context != PGC_POSTMASTER)
3566 (errcode(ERRCODE_CANT_CHANGE_RUNTIME_PARAM),
3567 errmsg("parameter \"%s\" cannot be changed after server start",
3573 if (context != PGC_SIGHUP && context != PGC_POSTMASTER)
3576 (errcode(ERRCODE_CANT_CHANGE_RUNTIME_PARAM),
3577 errmsg("parameter \"%s\" cannot be changed now",
3583 * Hmm, the idea of the SIGHUP context is "ought to be global,
3584 * but can be changed after postmaster start". But there's
3585 * nothing that prevents a crafty administrator from sending
3586 * SIGHUP signals to individual backends only.
3590 if (context == PGC_SIGHUP)
3593 * If a PGC_BACKEND parameter is changed in the config
3594 * file, we want to accept the new value in the postmaster
3595 * (whence it will propagate to subsequently-started
3596 * backends), but ignore it in existing backends. This is
3597 * a tad klugy, but necessary because we don't re-read the
3598 * config file during backend start.
3600 if (IsUnderPostmaster)
3603 else if (context != PGC_BACKEND && context != PGC_POSTMASTER)
3606 (errcode(ERRCODE_CANT_CHANGE_RUNTIME_PARAM),
3607 errmsg("parameter \"%s\" cannot be set after connection start",
3613 if (context == PGC_USERSET || context == PGC_BACKEND)
3616 (errcode(ERRCODE_INSUFFICIENT_PRIVILEGE),
3617 errmsg("permission denied to set parameter \"%s\"",
3628 * Should we set reset/stacked values? (If so, the behavior is not
3631 makeDefault = changeVal && (source <= PGC_S_OVERRIDE) && (value != NULL);
3634 * Ignore attempted set if overridden by previously processed setting.
3635 * However, if changeVal is false then plow ahead anyway since we are
3636 * trying to find out if the value is potentially good, not actually
3637 * use it. Also keep going if makeDefault is true, since we may want
3638 * to set the reset/stacked values even if we can't set the variable
3641 if (record->source > source)
3643 if (changeVal && !makeDefault)
3645 elog(DEBUG3, "\"%s\": setting ignored because previous source is higher priority",
3653 * Evaluate value and set variable.
3655 switch (record->vartype)
3659 struct config_bool *conf = (struct config_bool *) record;
3664 if (!parse_bool(value, &newval))
3667 (errcode(ERRCODE_INVALID_PARAMETER_VALUE),
3668 errmsg("parameter \"%s\" requires a Boolean value",
3675 newval = conf->reset_val;
3676 source = conf->gen.reset_source;
3679 if (conf->assign_hook)
3680 if (!(*conf->assign_hook) (newval, changeVal, source))
3683 (errcode(ERRCODE_INVALID_PARAMETER_VALUE),
3684 errmsg("invalid value for parameter \"%s\": %d",
3685 name, (int) newval)));
3689 if (changeVal || makeDefault)
3691 /* Save old value to support transaction abort */
3693 push_old_value(&conf->gen);
3696 *conf->variable = newval;
3697 conf->gen.source = source;
3703 if (conf->gen.reset_source <= source)
3705 conf->reset_val = newval;
3706 conf->gen.reset_source = source;
3708 for (stack = conf->gen.stack; stack; stack = stack->prev)
3710 if (stack->source <= source)
3712 stack->value.boolval = newval;
3713 stack->source = source;
3719 conf->gen.status |= GUC_HAVE_LOCAL;
3724 conf->tentative_val = newval;
3725 conf->gen.tentative_source = source;
3726 conf->gen.status |= GUC_HAVE_TENTATIVE;
3735 struct config_int *conf = (struct config_int *) record;
3740 if (!parse_int(value, &newval))
3743 (errcode(ERRCODE_INVALID_PARAMETER_VALUE),
3744 errmsg("parameter \"%s\" requires an integer value",
3748 if (newval < conf->min || newval > conf->max)
3751 (errcode(ERRCODE_INVALID_PARAMETER_VALUE),
3752 errmsg("%d is outside the valid range for parameter \"%s\" (%d .. %d)",
3753 newval, name, conf->min, conf->max)));
3759 newval = conf->reset_val;
3760 source = conf->gen.reset_source;
3763 if (conf->assign_hook)
3764 if (!(*conf->assign_hook) (newval, changeVal, source))
3767 (errcode(ERRCODE_INVALID_PARAMETER_VALUE),
3768 errmsg("invalid value for parameter \"%s\": %d",
3773 if (changeVal || makeDefault)
3775 /* Save old value to support transaction abort */
3777 push_old_value(&conf->gen);
3780 *conf->variable = newval;
3781 conf->gen.source = source;
3787 if (conf->gen.reset_source <= source)
3789 conf->reset_val = newval;
3790 conf->gen.reset_source = source;
3792 for (stack = conf->gen.stack; stack; stack = stack->prev)
3794 if (stack->source <= source)
3796 stack->value.intval = newval;
3797 stack->source = source;
3803 conf->gen.status |= GUC_HAVE_LOCAL;
3808 conf->tentative_val = newval;
3809 conf->gen.tentative_source = source;
3810 conf->gen.status |= GUC_HAVE_TENTATIVE;
3819 struct config_real *conf = (struct config_real *) record;
3824 if (!parse_real(value, &newval))
3827 (errcode(ERRCODE_INVALID_PARAMETER_VALUE),
3828 errmsg("parameter \"%s\" requires a numeric value",
3832 if (newval < conf->min || newval > conf->max)
3835 (errcode(ERRCODE_INVALID_PARAMETER_VALUE),
3836 errmsg("%g is outside the valid range for parameter \"%s\" (%g .. %g)",
3837 newval, name, conf->min, conf->max)));
3843 newval = conf->reset_val;
3844 source = conf->gen.reset_source;
3847 if (conf->assign_hook)
3848 if (!(*conf->assign_hook) (newval, changeVal, source))
3851 (errcode(ERRCODE_INVALID_PARAMETER_VALUE),
3852 errmsg("invalid value for parameter \"%s\": %g",
3857 if (changeVal || makeDefault)
3859 /* Save old value to support transaction abort */
3861 push_old_value(&conf->gen);
3864 *conf->variable = newval;
3865 conf->gen.source = source;
3871 if (conf->gen.reset_source <= source)
3873 conf->reset_val = newval;
3874 conf->gen.reset_source = source;
3876 for (stack = conf->gen.stack; stack; stack = stack->prev)
3878 if (stack->source <= source)
3880 stack->value.realval = newval;
3881 stack->source = source;
3887 conf->gen.status |= GUC_HAVE_LOCAL;
3892 conf->tentative_val = newval;
3893 conf->gen.tentative_source = source;
3894 conf->gen.status |= GUC_HAVE_TENTATIVE;
3903 struct config_string *conf = (struct config_string *) record;
3908 newval = guc_strdup(elevel, value);
3912 else if (conf->reset_val)
3915 * We could possibly avoid strdup here, but easier to
3916 * make this case work the same as the normal
3919 newval = guc_strdup(elevel, conf->reset_val);
3922 source = conf->gen.reset_source;
3926 /* Nothing to reset to, as yet; so do nothing */
3930 if (conf->assign_hook)
3932 const char *hookresult;
3935 * If the hook ereports, we have to make sure we free
3936 * newval, else it will be a permanent memory leak.
3938 hookresult = call_string_assign_hook(conf->assign_hook,
3942 if (hookresult == NULL)
3946 (errcode(ERRCODE_INVALID_PARAMETER_VALUE),
3947 errmsg("invalid value for parameter \"%s\": \"%s\"",
3948 name, value ? value : "")));
3951 else if (hookresult != newval)
3956 * Having to cast away const here is annoying, but
3957 * the alternative is to declare assign_hooks as
3958 * returning char*, which would mean they'd have
3959 * to cast away const, or as both taking and
3960 * returning char*, which doesn't seem attractive
3961 * either --- we don't want them to scribble on
3964 newval = (char *) hookresult;
3968 if (changeVal || makeDefault)
3970 /* Save old value to support transaction abort */
3972 push_old_value(&conf->gen);
3975 set_string_field(conf, conf->variable, newval);
3976 conf->gen.source = source;
3982 if (conf->gen.reset_source <= source)
3984 set_string_field(conf, &conf->reset_val, newval);
3985 conf->gen.reset_source = source;
3987 for (stack = conf->gen.stack; stack; stack = stack->prev)
3989 if (stack->source <= source)
3991 set_string_field(conf, &stack->value.stringval,
3993 stack->source = source;
3996 /* Perhaps we didn't install newval anywhere */
3997 if (!string_field_used(conf, newval))
4002 conf->gen.status |= GUC_HAVE_LOCAL;
4007 set_string_field(conf, &conf->tentative_val, newval);
4008 conf->gen.tentative_source = source;
4009 conf->gen.status |= GUC_HAVE_TENTATIVE;
4019 if (changeVal && (record->flags & GUC_REPORT))
4020 ReportGUCOption(record);
4027 * Set a config option to the given value. See also set_config_option,
4028 * this is just the wrapper to be called from outside GUC. NB: this
4029 * is used only for non-transactional operations.
4032 SetConfigOption(const char *name, const char *value,
4033 GucContext context, GucSource source)
4035 (void) set_config_option(name, value, context, source, false, true);
4041 * Fetch the current value of the option `name'. If the option doesn't exist,
4042 * throw an ereport and don't return.
4044 * The string is *not* allocated for modification and is really only
4045 * valid until the next call to configuration related functions.
4048 GetConfigOption(const char *name)
4050 struct config_generic *record;
4051 static char buffer[256];
4053 record = find_option(name, ERROR);
4056 (errcode(ERRCODE_UNDEFINED_OBJECT),
4057 errmsg("unrecognized configuration parameter \"%s\"", name)));
4058 if ((record->flags & GUC_SUPERUSER_ONLY) && !superuser())
4060 (errcode(ERRCODE_INSUFFICIENT_PRIVILEGE),
4061 errmsg("must be superuser to examine \"%s\"", name)));
4063 switch (record->vartype)
4066 return *((struct config_bool *) record)->variable ? "on" : "off";
4069 snprintf(buffer, sizeof(buffer), "%d",
4070 *((struct config_int *) record)->variable);
4074 snprintf(buffer, sizeof(buffer), "%g",
4075 *((struct config_real *) record)->variable);
4079 return *((struct config_string *) record)->variable;
4085 * Get the RESET value associated with the given option.
4088 GetConfigOptionResetString(const char *name)
4090 struct config_generic *record;
4091 static char buffer[256];
4093 record = find_option(name, ERROR);
4096 (errcode(ERRCODE_UNDEFINED_OBJECT),
4097 errmsg("unrecognized configuration parameter \"%s\"", name)));
4098 if ((record->flags & GUC_SUPERUSER_ONLY) && !superuser())
4100 (errcode(ERRCODE_INSUFFICIENT_PRIVILEGE),
4101 errmsg("must be superuser to examine \"%s\"", name)));
4103 switch (record->vartype)
4106 return ((struct config_bool *) record)->reset_val ? "on" : "off";
4109 snprintf(buffer, sizeof(buffer), "%d",
4110 ((struct config_int *) record)->reset_val);
4114 snprintf(buffer, sizeof(buffer), "%g",
4115 ((struct config_real *) record)->reset_val);
4119 return ((struct config_string *) record)->reset_val;
4125 * Detect whether the given configuration option can only be set by
4129 IsSuperuserConfigOption(const char *name)
4131 struct config_generic *record;
4133 record = find_option(name, ERROR);
4134 /* On an unrecognized name, don't error, just return false. */
4137 return (record->context == PGC_SUSET);
4142 * flatten_set_variable_args
4143 * Given a parsenode List as emitted by the grammar for SET,
4144 * convert to the flat string representation used by GUC.
4146 * We need to be told the name of the variable the args are for, because
4147 * the flattening rules vary (ugh).
4149 * The result is NULL if input is NIL (ie, SET ... TO DEFAULT), otherwise
4150 * a palloc'd string.
4153 flatten_set_variable_args(const char *name, List *args)
4155 struct config_generic *record;
4161 * Fast path if just DEFAULT. We do not check the variable name in
4162 * this case --- necessary for RESET ALL to work correctly.
4167 /* Else get flags for the variable */
4168 record = find_option(name, ERROR);
4171 (errcode(ERRCODE_UNDEFINED_OBJECT),
4172 errmsg("unrecognized configuration parameter \"%s\"", name)));
4174 flags = record->flags;
4176 /* Complain if list input and non-list variable */
4177 if ((flags & GUC_LIST_INPUT) == 0 &&
4178 list_length(args) != 1)
4180 (errcode(ERRCODE_INVALID_PARAMETER_VALUE),
4181 errmsg("SET %s takes only one argument", name)));
4183 initStringInfo(&buf);
4187 A_Const *arg = (A_Const *) lfirst(l);
4190 if (l != list_head(args))
4191 appendStringInfo(&buf, ", ");
4193 if (!IsA(arg, A_Const))
4194 elog(ERROR, "unrecognized node type: %d", (int) nodeTag(arg));
4196 switch (nodeTag(&arg->val))
4199 appendStringInfo(&buf, "%ld", intVal(&arg->val));
4202 /* represented as a string, so just copy it */
4203 appendStringInfoString(&buf, strVal(&arg->val));
4206 val = strVal(&arg->val);
4207 if (arg->typename != NULL)
4210 * Must be a ConstInterval argument for TIME ZONE.
4211 * Coerce to interval and back to normalize the value
4212 * and account for any typmod.
4218 DirectFunctionCall3(interval_in,
4219 CStringGetDatum(val),
4220 ObjectIdGetDatum(InvalidOid),
4221 Int32GetDatum(arg->typename->typmod));
4224 DatumGetCString(DirectFunctionCall1(interval_out,
4226 appendStringInfo(&buf, "INTERVAL '%s'", intervalout);
4231 * Plain string literal or identifier. For quote
4232 * mode, quote it if it's not a vanilla identifier.
4234 if (flags & GUC_LIST_QUOTE)
4235 appendStringInfoString(&buf, quote_identifier(val));
4237 appendStringInfoString(&buf, val);
4241 elog(ERROR, "unrecognized node type: %d",
4242 (int) nodeTag(&arg->val));
4255 SetPGVariable(const char *name, List *args, bool is_local)
4257 char *argstring = flatten_set_variable_args(name, args);
4259 /* Note SET DEFAULT (argstring == NULL) is equivalent to RESET */
4260 set_config_option(name,
4262 (superuser() ? PGC_SUSET : PGC_USERSET),
4269 * SET command wrapped as a SQL callable function.
4272 set_config_by_name(PG_FUNCTION_ARGS)
4280 if (PG_ARGISNULL(0))
4282 (errcode(ERRCODE_NULL_VALUE_NOT_ALLOWED),
4283 errmsg("SET requires parameter name")));
4285 /* Get the GUC variable name */
4286 name = DatumGetCString(DirectFunctionCall1(textout, PG_GETARG_DATUM(0)));
4288 /* Get the desired value or set to NULL for a reset request */
4289 if (PG_ARGISNULL(1))
4292 value = DatumGetCString(DirectFunctionCall1(textout, PG_GETARG_DATUM(1)));
4295 * Get the desired state of is_local. Default to false if provided
4298 if (PG_ARGISNULL(2))
4301 is_local = PG_GETARG_BOOL(2);
4303 /* Note SET DEFAULT (argstring == NULL) is equivalent to RESET */
4304 set_config_option(name,
4306 (superuser() ? PGC_SUSET : PGC_USERSET),
4311 /* get the new current value */
4312 new_value = GetConfigOptionByName(name, NULL);
4314 /* Convert return string to text */
4315 result_text = DatumGetTextP(DirectFunctionCall1(textin, CStringGetDatum(new_value)));
4318 PG_RETURN_TEXT_P(result_text);
4322 define_custom_variable(struct config_generic * variable)
4324 const char *name = variable->name;
4325 const char **nameAddr = &name;
4327 struct config_string *pHolder;
4328 struct config_generic **res = (struct config_generic **) bsearch(
4330 (void *) guc_variables,
4332 sizeof(struct config_generic *),
4337 add_guc_variable(variable, ERROR);
4342 * This better be a placeholder
4344 if (((*res)->flags & GUC_CUSTOM_PLACEHOLDER) == 0)
4346 (errcode(ERRCODE_INTERNAL_ERROR),
4347 errmsg("attempt to redefine parameter \"%s\"", name)));
4349 Assert((*res)->vartype == PGC_STRING);
4350 pHolder = (struct config_string *) * res;
4352 /* We have the same name, no sorting is necessary */
4355 value = *pHolder->variable;
4358 * Assign the string value stored in the placeholder to the real
4361 * XXX this is not really good enough --- it should be a nontransactional
4362 * assignment, since we don't want it to roll back if the current xact
4365 set_config_option(name, value,
4366 pHolder->gen.context, pHolder->gen.source,
4370 * Free up as much as we conveniently can of the placeholder structure
4371 * (this neglects any stack items...)
4373 set_string_field(pHolder, pHolder->variable, NULL);
4374 set_string_field(pHolder, &pHolder->reset_val, NULL);
4375 set_string_field(pHolder, &pHolder->tentative_val, NULL);
4381 init_custom_variable(struct config_generic * gen,
4383 const char *short_desc,
4384 const char *long_desc,
4386 enum config_type type)
4388 gen->name = guc_strdup(ERROR, name);
4389 gen->context = context;
4390 gen->group = CUSTOM_OPTIONS;
4391 gen->short_desc = short_desc;
4392 gen->long_desc = long_desc;
4393 gen->vartype = type;
4397 DefineCustomBoolVariable(const char *name,
4398 const char *short_desc,
4399 const char *long_desc,
4402 GucBoolAssignHook assign_hook,
4403 GucShowHook show_hook)
4405 size_t sz = sizeof(struct config_bool);
4406 struct config_bool *var = (struct config_bool *) guc_malloc(ERROR, sz);
4409 init_custom_variable(&var->gen, name, short_desc, long_desc, context, PGC_BOOL);
4411 var->variable = valueAddr;
4412 var->reset_val = *valueAddr;
4413 var->assign_hook = assign_hook;
4414 var->show_hook = show_hook;
4415 define_custom_variable(&var->gen);
4419 DefineCustomIntVariable(const char *name,
4420 const char *short_desc,
4421 const char *long_desc,
4426 GucIntAssignHook assign_hook,
4427 GucShowHook show_hook)
4429 size_t sz = sizeof(struct config_int);
4430 struct config_int *var = (struct config_int *) guc_malloc(ERROR, sz);
4433 init_custom_variable(&var->gen, name, short_desc, long_desc, context, PGC_INT);
4435 var->variable = valueAddr;
4436 var->reset_val = *valueAddr;
4437 var->min = minValue;
4438 var->max = maxValue;
4439 var->assign_hook = assign_hook;
4440 var->show_hook = show_hook;
4441 define_custom_variable(&var->gen);
4445 DefineCustomRealVariable(const char *name,
4446 const char *short_desc,
4447 const char *long_desc,
4452 GucRealAssignHook assign_hook,
4453 GucShowHook show_hook)
4455 size_t sz = sizeof(struct config_real);
4456 struct config_real *var = (struct config_real *) guc_malloc(ERROR, sz);
4459 init_custom_variable(&var->gen, name, short_desc, long_desc, context, PGC_REAL);
4461 var->variable = valueAddr;
4462 var->reset_val = *valueAddr;
4463 var->min = minValue;
4464 var->max = maxValue;
4465 var->assign_hook = assign_hook;
4466 var->show_hook = show_hook;
4467 define_custom_variable(&var->gen);
4471 DefineCustomStringVariable(const char *name,
4472 const char *short_desc,
4473 const char *long_desc,
4476 GucStringAssignHook assign_hook,
4477 GucShowHook show_hook)
4479 size_t sz = sizeof(struct config_string);
4480 struct config_string *var = (struct config_string *) guc_malloc(ERROR, sz);
4483 init_custom_variable(&var->gen, name, short_desc, long_desc, context, PGC_STRING);
4485 var->variable = valueAddr;
4486 var->reset_val = *valueAddr;
4487 var->assign_hook = assign_hook;
4488 var->show_hook = show_hook;
4489 define_custom_variable(&var->gen);
4493 EmitWarningsOnPlaceholders(const char *className)
4495 struct config_generic **vars = guc_variables;
4496 struct config_generic **last = vars + num_guc_variables;
4498 int nameLen = strlen(className);
4502 struct config_generic *var = *vars++;
4504 if ((var->flags & GUC_CUSTOM_PLACEHOLDER) != 0 &&
4505 strncmp(className, var->name, nameLen) == 0 &&
4506 var->name[nameLen] == GUC_QUALIFIER_SEPARATOR)
4509 (errcode(ERRCODE_UNDEFINED_OBJECT),
4510 errmsg("unrecognized configuration parameter \"%s\"", var->name)));
4520 GetPGVariable(const char *name, DestReceiver *dest)
4522 if (pg_strcasecmp(name, "all") == 0)
4523 ShowAllGUCConfig(dest);
4525 ShowGUCConfigOption(name, dest);
4529 GetPGVariableResultDesc(const char *name)
4533 if (pg_strcasecmp(name, "all") == 0)
4535 /* need a tuple descriptor representing three TEXT columns */
4536 tupdesc = CreateTemplateTupleDesc(3, false);
4537 TupleDescInitEntry(tupdesc, (AttrNumber) 1, "name",
4539 TupleDescInitEntry(tupdesc, (AttrNumber) 2, "setting",
4541 TupleDescInitEntry(tupdesc, (AttrNumber) 3, "description",
4547 const char *varname;
4549 /* Get the canonical spelling of name */
4550 (void) GetConfigOptionByName(name, &varname);
4552 /* need a tuple descriptor representing a single TEXT column */
4553 tupdesc = CreateTemplateTupleDesc(1, false);
4554 TupleDescInitEntry(tupdesc, (AttrNumber) 1, varname,
4564 ResetPGVariable(const char *name)
4566 if (pg_strcasecmp(name, "all") == 0)
4569 set_config_option(name,
4571 (superuser() ? PGC_SUSET : PGC_USERSET),
4582 ShowGUCConfigOption(const char *name, DestReceiver *dest)
4584 TupOutputState *tstate;
4586 const char *varname;
4589 /* Get the value and canonical spelling of name */
4590 value = GetConfigOptionByName(name, &varname);
4592 /* need a tuple descriptor representing a single TEXT column */
4593 tupdesc = CreateTemplateTupleDesc(1, false);
4594 TupleDescInitEntry(tupdesc, (AttrNumber) 1, varname,
4597 /* prepare for projection of tuples */
4598 tstate = begin_tup_output_tupdesc(dest, tupdesc);
4601 do_text_output_oneline(tstate, value);
4603 end_tup_output(tstate);
4610 ShowAllGUCConfig(DestReceiver *dest)
4612 bool am_superuser = superuser();
4614 TupOutputState *tstate;
4618 /* need a tuple descriptor representing three TEXT columns */
4619 tupdesc = CreateTemplateTupleDesc(3, false);
4620 TupleDescInitEntry(tupdesc, (AttrNumber) 1, "name",
4622 TupleDescInitEntry(tupdesc, (AttrNumber) 2, "setting",
4624 TupleDescInitEntry(tupdesc, (AttrNumber) 3, "description",
4628 /* prepare for projection of tuples */
4629 tstate = begin_tup_output_tupdesc(dest, tupdesc);
4631 for (i = 0; i < num_guc_variables; i++)
4633 struct config_generic *conf = guc_variables[i];
4635 if ((conf->flags & GUC_NO_SHOW_ALL) ||
4636 ((conf->flags & GUC_SUPERUSER_ONLY) && !am_superuser))
4639 /* assign to the values array */
4640 values[0] = (char *) conf->name;
4641 values[1] = _ShowOption(conf);
4642 values[2] = (char *) conf->short_desc;
4644 /* send it to dest */
4645 do_tup_output(tstate, values);
4648 if (values[1] != NULL)
4652 end_tup_output(tstate);
4656 * Return GUC variable value by name; optionally return canonical
4657 * form of name. Return value is palloc'd.
4660 GetConfigOptionByName(const char *name, const char **varname)
4662 struct config_generic *record;
4664 record = find_option(name, ERROR);
4667 (errcode(ERRCODE_UNDEFINED_OBJECT),
4668 errmsg("unrecognized configuration parameter \"%s\"", name)));
4669 if ((record->flags & GUC_SUPERUSER_ONLY) && !superuser())
4671 (errcode(ERRCODE_INSUFFICIENT_PRIVILEGE),
4672 errmsg("must be superuser to examine \"%s\"", name)));
4675 *varname = record->name;
4677 return _ShowOption(record);
4681 * Return GUC variable value by variable number; optionally return canonical
4682 * form of name. Return value is palloc'd.
4685 GetConfigOptionByNum(int varnum, const char **values, bool *noshow)
4688 struct config_generic *conf;
4690 /* check requested variable number valid */
4691 Assert((varnum >= 0) && (varnum < num_guc_variables));
4693 conf = guc_variables[varnum];
4697 if ((conf->flags & GUC_NO_SHOW_ALL) ||
4698 ((conf->flags & GUC_SUPERUSER_ONLY) && !superuser()))
4704 /* first get the generic attributes */
4707 values[0] = conf->name;
4709 /* setting : use _ShowOption in order to avoid duplicating the logic */
4710 values[1] = _ShowOption(conf);
4713 values[2] = config_group_names[conf->group];
4716 values[3] = conf->short_desc;
4719 values[4] = conf->long_desc;
4722 values[5] = GucContext_Names[conf->context];
4725 values[6] = config_type_names[conf->vartype];
4728 values[7] = GucSource_Names[conf->source];
4730 /* now get the type specifc attributes */
4731 switch (conf->vartype)
4745 struct config_int *lconf = (struct config_int *) conf;
4748 snprintf(buffer, sizeof(buffer), "%d", lconf->min);
4749 values[8] = pstrdup(buffer);
4752 snprintf(buffer, sizeof(buffer), "%d", lconf->max);
4753 values[9] = pstrdup(buffer);
4759 struct config_real *lconf = (struct config_real *) conf;
4762 snprintf(buffer, sizeof(buffer), "%g", lconf->min);
4763 values[8] = pstrdup(buffer);
4766 snprintf(buffer, sizeof(buffer), "%g", lconf->max);
4767 values[9] = pstrdup(buffer);
4784 * should never get here, but in case we do, set 'em to
4799 * Return the total number of GUC variables
4802 GetNumConfigOptions(void)
4804 return num_guc_variables;
4808 * show_config_by_name - equiv to SHOW X command but implemented as
4812 show_config_by_name(PG_FUNCTION_ARGS)
4818 /* Get the GUC variable name */
4819 varname = DatumGetCString(DirectFunctionCall1(textout, PG_GETARG_DATUM(0)));
4822 varval = GetConfigOptionByName(varname, NULL);
4824 /* Convert to text */
4825 result_text = DatumGetTextP(DirectFunctionCall1(textin, CStringGetDatum(varval)));
4828 PG_RETURN_TEXT_P(result_text);
4832 * show_all_settings - equiv to SHOW ALL command but implemented as
4835 #define NUM_PG_SETTINGS_ATTS 10
4838 show_all_settings(PG_FUNCTION_ARGS)
4840 FuncCallContext *funcctx;
4844 AttInMetadata *attinmeta;
4845 MemoryContext oldcontext;
4847 /* stuff done only on the first call of the function */
4848 if (SRF_IS_FIRSTCALL())
4850 /* create a function context for cross-call persistence */
4851 funcctx = SRF_FIRSTCALL_INIT();
4854 * switch to memory context appropriate for multiple function
4857 oldcontext = MemoryContextSwitchTo(funcctx->multi_call_memory_ctx);
4860 * need a tuple descriptor representing NUM_PG_SETTINGS_ATTS
4861 * columns of the appropriate types
4863 tupdesc = CreateTemplateTupleDesc(NUM_PG_SETTINGS_ATTS, false);
4864 TupleDescInitEntry(tupdesc, (AttrNumber) 1, "name",
4866 TupleDescInitEntry(tupdesc, (AttrNumber) 2, "setting",
4868 TupleDescInitEntry(tupdesc, (AttrNumber) 3, "category",
4870 TupleDescInitEntry(tupdesc, (AttrNumber) 4, "short_desc",
4872 TupleDescInitEntry(tupdesc, (AttrNumber) 5, "extra_desc",
4874 TupleDescInitEntry(tupdesc, (AttrNumber) 6, "context",
4876 TupleDescInitEntry(tupdesc, (AttrNumber) 7, "vartype",
4878 TupleDescInitEntry(tupdesc, (AttrNumber) 8, "source",
4880 TupleDescInitEntry(tupdesc, (AttrNumber) 9, "min_val",
4882 TupleDescInitEntry(tupdesc, (AttrNumber) 10, "max_val",
4886 * Generate attribute metadata needed later to produce tuples from
4889 attinmeta = TupleDescGetAttInMetadata(tupdesc);
4890 funcctx->attinmeta = attinmeta;
4892 /* total number of tuples to be returned */
4893 funcctx->max_calls = GetNumConfigOptions();
4895 MemoryContextSwitchTo(oldcontext);
4898 /* stuff done on every call of the function */
4899 funcctx = SRF_PERCALL_SETUP();
4901 call_cntr = funcctx->call_cntr;
4902 max_calls = funcctx->max_calls;
4903 attinmeta = funcctx->attinmeta;
4905 if (call_cntr < max_calls) /* do when there is more left to send */
4907 char *values[NUM_PG_SETTINGS_ATTS];
4913 * Get the next visible GUC variable name and value
4917 GetConfigOptionByNum(call_cntr, (const char **) values, &noshow);
4920 /* bump the counter and get the next config setting */
4921 call_cntr = ++funcctx->call_cntr;
4923 /* make sure we haven't gone too far now */
4924 if (call_cntr >= max_calls)
4925 SRF_RETURN_DONE(funcctx);
4930 tuple = BuildTupleFromCStrings(attinmeta, values);
4932 /* make the tuple into a datum */
4933 result = HeapTupleGetDatum(tuple);
4935 SRF_RETURN_NEXT(funcctx, result);
4939 /* do when there is no more left */
4940 SRF_RETURN_DONE(funcctx);
4945 _ShowOption(struct config_generic * record)
4950 switch (record->vartype)
4954 struct config_bool *conf = (struct config_bool *) record;
4956 if (conf->show_hook)
4957 val = (*conf->show_hook) ();
4959 val = *conf->variable ? "on" : "off";
4965 struct config_int *conf = (struct config_int *) record;
4967 if (conf->show_hook)
4968 val = (*conf->show_hook) ();
4971 snprintf(buffer, sizeof(buffer), "%d",
4980 struct config_real *conf = (struct config_real *) record;
4982 if (conf->show_hook)
4983 val = (*conf->show_hook) ();
4986 snprintf(buffer, sizeof(buffer), "%g",
4995 struct config_string *conf = (struct config_string *) record;
4997 if (conf->show_hook)
4998 val = (*conf->show_hook) ();
4999 else if (*conf->variable && **conf->variable)
5000 val = *conf->variable;
5007 /* just to keep compiler quiet */
5012 return pstrdup(val);
5019 * This routine dumps out all non-default GUC options into a binary
5020 * file that is read by all exec'ed backends. The format is:
5022 * variable name, string, null terminated
5023 * variable value, string, null terminated
5024 * variable source, integer
5027 write_nondefault_variables(GucContext context)
5033 Assert(context == PGC_POSTMASTER || context == PGC_SIGHUP);
5035 elevel = (context == PGC_SIGHUP) ? LOG : ERROR;
5040 fp = AllocateFile(CONFIG_EXEC_PARAMS_NEW, "w");
5044 (errcode_for_file_access(),
5045 errmsg("could not write to file \"%s\": %m",
5046 CONFIG_EXEC_PARAMS_NEW)));
5050 for (i = 0; i < num_guc_variables; i++)
5052 struct config_generic *gconf = guc_variables[i];
5054 if (gconf->source != PGC_S_DEFAULT)
5056 fprintf(fp, "%s", gconf->name);
5059 switch (gconf->vartype)
5063 struct config_bool *conf = (struct config_bool *) gconf;
5065 if (*conf->variable == 0)
5066 fprintf(fp, "false");
5068 fprintf(fp, "true");
5074 struct config_int *conf = (struct config_int *) gconf;
5076 fprintf(fp, "%d", *conf->variable);
5082 struct config_real *conf = (struct config_real *) gconf;
5084 /* Could lose precision here? */
5085 fprintf(fp, "%f", *conf->variable);
5091 struct config_string *conf = (struct config_string *) gconf;
5093 fprintf(fp, "%s", *conf->variable);
5100 fwrite(&gconf->source, sizeof(gconf->source), 1, fp);
5107 (errcode_for_file_access(),
5108 errmsg("could not write to file \"%s\": %m",
5109 CONFIG_EXEC_PARAMS_NEW)));
5114 * Put new file in place. This could delay on Win32, but we don't
5115 * hold any exclusive locks.
5117 rename(CONFIG_EXEC_PARAMS_NEW, CONFIG_EXEC_PARAMS);
5122 * Read string, including null byte from file
5124 * Return NULL on EOF and nothing read
5127 read_string_with_null(FILE *fp)
5136 if ((ch = fgetc(fp)) == EOF)
5141 elog(FATAL, "invalid format of exec config params file");
5144 str = guc_malloc(FATAL, maxlen);
5145 else if (i == maxlen)
5146 str = guc_realloc(FATAL, str, maxlen *= 2);
5155 * This routine loads a previous postmaster dump of its non-default
5159 read_nondefault_variables(void)
5169 fp = AllocateFile(CONFIG_EXEC_PARAMS, "r");
5172 /* File not found is fine */
5173 if (errno != ENOENT)
5175 (errcode_for_file_access(),
5176 errmsg("could not read from file \"%s\": %m",
5177 CONFIG_EXEC_PARAMS)));
5183 struct config_generic *record;
5185 if ((varname = read_string_with_null(fp)) == NULL)
5188 if ((record = find_option(varname, FATAL)) == NULL)
5189 elog(FATAL, "failed to locate variable %s in exec config params file", varname);
5190 if ((varvalue = read_string_with_null(fp)) == NULL)
5191 elog(FATAL, "invalid format of exec config params file");
5192 if (fread(&varsource, sizeof(varsource), 1, fp) == 0)
5193 elog(FATAL, "invalid format of exec config params file");
5195 (void) set_config_option(varname, varvalue, record->context,
5196 varsource, false, true);
5204 #endif /* EXEC_BACKEND */
5208 * A little "long argument" simulation, although not quite GNU
5209 * compliant. Takes a string of the form "some-option=some value" and
5210 * returns name = "some_option" and value = "some value" in malloc'ed
5211 * storage. Note that '-' is converted to '_' in the option name. If
5212 * there is no '=' in the input string then value will be NULL.
5215 ParseLongOption(const char *string, char **name, char **value)
5224 equal_pos = strcspn(string, "=");
5226 if (string[equal_pos] == '=')
5228 *name = guc_malloc(FATAL, equal_pos + 1);
5229 strncpy(*name, string, equal_pos);
5230 (*name)[equal_pos] = '\0';
5232 *value = guc_strdup(FATAL, &string[equal_pos + 1]);
5236 /* no equal sign in string */
5237 *name = guc_strdup(FATAL, string);
5241 for (cp = *name; *cp; cp++)
5248 * Handle options fetched from pg_database.datconfig or pg_authid.rolconfig.
5249 * The array parameter must be an array of TEXT (it must not be NULL).
5252 ProcessGUCArray(ArrayType *array, GucSource source)
5256 Assert(array != NULL);
5257 Assert(ARR_ELEMTYPE(array) == TEXTOID);
5258 Assert(ARR_NDIM(array) == 1);
5259 Assert(ARR_LBOUND(array)[0] == 1);
5260 Assert(source == PGC_S_DATABASE || source == PGC_S_USER);
5262 for (i = 1; i <= ARR_DIMS(array)[0]; i++)
5270 d = array_ref(array, 1, &i,
5271 -1 /* varlenarray */ ,
5272 -1 /* TEXT's typlen */ ,
5273 false /* TEXT's typbyval */ ,
5274 'i' /* TEXT's typalign */ ,
5280 s = DatumGetCString(DirectFunctionCall1(textout, d));
5282 ParseLongOption(s, &name, &value);
5286 (errcode(ERRCODE_SYNTAX_ERROR),
5287 errmsg("could not parse setting for parameter \"%s\"", name)));
5293 * We process all these options at SUSET level. We assume that
5294 * the right to insert an option into pg_database or pg_authid was
5295 * checked when it was inserted.
5297 SetConfigOption(name, value, PGC_SUSET, source);
5307 * Add an entry to an option array. The array parameter may be NULL
5308 * to indicate the current table entry is NULL.
5311 GUCArrayAdd(ArrayType *array, const char *name, const char *value)
5313 const char *varname;
5321 /* test if the option is valid */
5322 set_config_option(name, value,
5323 superuser() ? PGC_SUSET : PGC_USERSET,
5324 PGC_S_TEST, false, false);
5326 /* convert name to canonical spelling, so we can use plain strcmp */
5327 (void) GetConfigOptionByName(name, &varname);
5330 newval = palloc(strlen(name) + 1 + strlen(value) + 1);
5331 sprintf(newval, "%s=%s", name, value);
5332 datum = DirectFunctionCall1(textin, CStringGetDatum(newval));
5340 Assert(ARR_ELEMTYPE(array) == TEXTOID);
5341 Assert(ARR_NDIM(array) == 1);
5342 Assert(ARR_LBOUND(array)[0] == 1);
5344 index = ARR_DIMS(array)[0] + 1; /* add after end */
5346 for (i = 1; i <= ARR_DIMS(array)[0]; i++)
5351 d = array_ref(array, 1, &i,
5352 -1 /* varlenarray */ ,
5353 -1 /* TEXT's typlen */ ,
5354 false /* TEXT's typbyval */ ,
5355 'i' /* TEXT's typalign */ ,
5359 current = DatumGetCString(DirectFunctionCall1(textout, d));
5360 if (strncmp(current, newval, strlen(name) + 1) == 0)
5368 a = array_set(array, 1, &index,
5370 -1 /* varlenarray */ ,
5371 -1 /* TEXT's typlen */ ,
5372 false /* TEXT's typbyval */ ,
5373 'i' /* TEXT's typalign */ ,
5377 a = construct_array(&datum, 1,
5386 * Delete an entry from an option array. The array parameter may be NULL
5387 * to indicate the current table entry is NULL. Also, if the return value
5388 * is NULL then a null should be stored.
5391 GUCArrayDelete(ArrayType *array, const char *name)
5393 const char *varname;
5394 ArrayType *newarray;
5400 /* test if the option is valid */
5401 set_config_option(name, NULL,
5402 superuser() ? PGC_SUSET : PGC_USERSET,
5403 PGC_S_TEST, false, false);
5405 /* convert name to canonical spelling, so we can use plain strcmp */
5406 (void) GetConfigOptionByName(name, &varname);
5409 /* if array is currently null, then surely nothing to delete */
5416 for (i = 1; i <= ARR_DIMS(array)[0]; i++)
5422 d = array_ref(array, 1, &i,
5423 -1 /* varlenarray */ ,
5424 -1 /* TEXT's typlen */ ,
5425 false /* TEXT's typbyval */ ,
5426 'i' /* TEXT's typalign */ ,
5430 val = DatumGetCString(DirectFunctionCall1(textout, d));
5432 /* ignore entry if it's what we want to delete */
5433 if (strncmp(val, name, strlen(name)) == 0
5434 && val[strlen(name)] == '=')
5437 /* else add it to the output array */
5441 newarray = array_set(newarray, 1, &index,
5443 -1 /* varlenarray */ ,
5444 -1 /* TEXT's typlen */ ,
5445 false /* TEXT's typbyval */ ,
5446 'i' /* TEXT's typalign */ ,
5450 newarray = construct_array(&d, 1,
5462 * assign_hook subroutines
5466 assign_log_destination(const char *value, bool doit, GucSource source)
5473 /* Need a modifiable copy of string */
5474 rawstring = pstrdup(value);
5476 /* Parse string into list of identifiers */
5477 if (!SplitIdentifierString(rawstring, ',', &elemlist))
5479 /* syntax error in list */
5481 list_free(elemlist);
5482 if (source >= PGC_S_INTERACTIVE)
5484 (errcode(ERRCODE_INVALID_PARAMETER_VALUE),
5485 errmsg("invalid list syntax for parameter \"log_destination\"")));
5489 foreach(l, elemlist)
5491 char *tok = (char *) lfirst(l);
5493 if (pg_strcasecmp(tok, "stderr") == 0)
5494 newlogdest |= LOG_DESTINATION_STDERR;
5496 else if (pg_strcasecmp(tok, "syslog") == 0)
5497 newlogdest |= LOG_DESTINATION_SYSLOG;
5500 else if (pg_strcasecmp(tok, "eventlog") == 0)
5501 newlogdest |= LOG_DESTINATION_EVENTLOG;
5505 if (source >= PGC_S_INTERACTIVE)
5507 (errcode(ERRCODE_INVALID_PARAMETER_VALUE),
5508 errmsg("unrecognized \"log_destination\" key word: \"%s\"",
5511 list_free(elemlist);
5517 Log_destination = newlogdest;
5520 list_free(elemlist);
5528 assign_facility(const char *facility, bool doit, GucSource source)
5530 if (pg_strcasecmp(facility, "LOCAL0") == 0)
5532 if (pg_strcasecmp(facility, "LOCAL1") == 0)
5534 if (pg_strcasecmp(facility, "LOCAL2") == 0)
5536 if (pg_strcasecmp(facility, "LOCAL3") == 0)
5538 if (pg_strcasecmp(facility, "LOCAL4") == 0)
5540 if (pg_strcasecmp(facility, "LOCAL5") == 0)
5542 if (pg_strcasecmp(facility, "LOCAL6") == 0)
5544 if (pg_strcasecmp(facility, "LOCAL7") == 0)
5552 assign_defaultxactisolevel(const char *newval, bool doit, GucSource source)
5554 if (pg_strcasecmp(newval, "serializable") == 0)
5557 DefaultXactIsoLevel = XACT_SERIALIZABLE;
5559 else if (pg_strcasecmp(newval, "repeatable read") == 0)
5562 DefaultXactIsoLevel = XACT_REPEATABLE_READ;
5564 else if (pg_strcasecmp(newval, "read committed") == 0)
5567 DefaultXactIsoLevel = XACT_READ_COMMITTED;
5569 else if (pg_strcasecmp(newval, "read uncommitted") == 0)
5572 DefaultXactIsoLevel = XACT_READ_UNCOMMITTED;
5580 assign_log_min_messages(const char *newval,
5581 bool doit, GucSource source)
5583 return (assign_msglvl(&log_min_messages, newval, doit, source));
5587 assign_client_min_messages(const char *newval, bool doit, GucSource source)
5589 return (assign_msglvl(&client_min_messages, newval, doit, source));
5593 assign_min_error_statement(const char *newval, bool doit, GucSource source)
5595 return (assign_msglvl(&log_min_error_statement, newval, doit, source));
5599 assign_msglvl(int *var, const char *newval, bool doit, GucSource source)
5601 if (pg_strcasecmp(newval, "debug") == 0)
5606 else if (pg_strcasecmp(newval, "debug5") == 0)
5611 else if (pg_strcasecmp(newval, "debug4") == 0)
5616 else if (pg_strcasecmp(newval, "debug3") == 0)
5621 else if (pg_strcasecmp(newval, "debug2") == 0)
5626 else if (pg_strcasecmp(newval, "debug1") == 0)
5631 else if (pg_strcasecmp(newval, "log") == 0)
5638 * Client_min_messages always prints 'info', but we allow it as a
5641 else if (pg_strcasecmp(newval, "info") == 0)
5646 else if (pg_strcasecmp(newval, "notice") == 0)
5651 else if (pg_strcasecmp(newval, "warning") == 0)
5656 else if (pg_strcasecmp(newval, "error") == 0)
5661 /* We allow FATAL/PANIC for client-side messages too. */
5662 else if (pg_strcasecmp(newval, "fatal") == 0)
5667 else if (pg_strcasecmp(newval, "panic") == 0)
5673 return NULL; /* fail */
5674 return newval; /* OK */
5678 assign_log_error_verbosity(const char *newval, bool doit, GucSource source)
5680 if (pg_strcasecmp(newval, "terse") == 0)
5683 Log_error_verbosity = PGERROR_TERSE;
5685 else if (pg_strcasecmp(newval, "default") == 0)
5688 Log_error_verbosity = PGERROR_DEFAULT;
5690 else if (pg_strcasecmp(newval, "verbose") == 0)
5693 Log_error_verbosity = PGERROR_VERBOSE;
5696 return NULL; /* fail */
5697 return newval; /* OK */
5701 assign_log_statement(const char *newval, bool doit, GucSource source)
5703 if (pg_strcasecmp(newval, "none") == 0)
5706 log_statement = LOGSTMT_NONE;
5708 else if (pg_strcasecmp(newval, "ddl") == 0)
5711 log_statement = LOGSTMT_DDL;
5713 else if (pg_strcasecmp(newval, "mod") == 0)
5716 log_statement = LOGSTMT_MOD;
5718 else if (pg_strcasecmp(newval, "all") == 0)
5721 log_statement = LOGSTMT_ALL;
5724 return NULL; /* fail */
5725 return newval; /* OK */
5729 show_num_temp_buffers(void)
5732 * We show the GUC var until local buffers have been initialized,
5733 * and NLocBuffer afterwards.
5735 static char nbuf[32];
5737 sprintf(nbuf, "%d", NLocBuffer ? NLocBuffer : num_temp_buffers);
5742 assign_phony_autocommit(bool newval, bool doit, GucSource source)
5746 if (doit && source >= PGC_S_INTERACTIVE)
5748 (errcode(ERRCODE_FEATURE_NOT_SUPPORTED),
5749 errmsg("SET AUTOCOMMIT TO OFF is no longer supported")));
5756 assign_custom_variable_classes(const char *newval, bool doit, GucSource source)
5759 * Check syntax. newval must be a comma separated list of identifiers.
5760 * Whitespace is allowed but skipped.
5762 bool hasSpaceAfterToken = false;
5763 const char *cp = newval;
5768 initStringInfo(&buf);
5769 while ((c = *cp++) != 0)
5774 hasSpaceAfterToken = true;
5780 hasSpaceAfterToken = false;
5784 appendStringInfoChar(&buf, ',');
5789 if (hasSpaceAfterToken || !isalnum(c))
5792 * Syntax error due to token following space after token or
5793 * non alpha numeric character
5796 (errcode(ERRCODE_SYNTAX_ERROR),
5797 errmsg("invalid syntax for \"custom_variable_classes\": \"%s\"", newval)));
5802 appendStringInfoChar(&buf, (char) c);
5805 /* Remove stray ',' at end */
5806 if (symLen == 0 && buf.len > 0)
5807 buf.data[--buf.len] = '\0';
5812 newval = strdup(buf.data);
5819 assign_stage_log_stats(bool newval, bool doit, GucSource source)
5821 if (newval && log_statement_stats)
5823 if (source >= PGC_S_INTERACTIVE)
5825 (errcode(ERRCODE_INVALID_PARAMETER_VALUE),
5826 errmsg("cannot enable parameter when \"log_statement_stats\" is true")));
5827 /* source == PGC_S_OVERRIDE means do it anyway, eg at xact abort */
5828 else if (source != PGC_S_OVERRIDE)
5835 assign_log_stats(bool newval, bool doit, GucSource source)
5838 (log_parser_stats || log_planner_stats || log_executor_stats))
5840 if (source >= PGC_S_INTERACTIVE)
5842 (errcode(ERRCODE_INVALID_PARAMETER_VALUE),
5843 errmsg("cannot enable \"log_statement_stats\" when "
5844 "\"log_parser_stats\", \"log_planner_stats\", "
5845 "or \"log_executor_stats\" is true")));
5846 /* source == PGC_S_OVERRIDE means do it anyway, eg at xact abort */
5847 else if (source != PGC_S_OVERRIDE)
5854 assign_transaction_read_only(bool newval, bool doit, GucSource source)
5856 /* Can't go to r/w mode inside a r/o transaction */
5857 if (newval == false && XactReadOnly && IsSubTransaction())
5859 if (source >= PGC_S_INTERACTIVE)
5861 (errcode(ERRCODE_INVALID_PARAMETER_VALUE),
5862 errmsg("cannot set transaction read-write mode inside a read-only transaction")));
5863 /* source == PGC_S_OVERRIDE means do it anyway, eg at xact abort */
5864 else if (source != PGC_S_OVERRIDE)
5871 assign_canonical_path(const char *newval, bool doit, GucSource source)
5875 char *canon_val = guc_strdup(ERROR, newval);
5877 canonicalize_path(canon_val);
5885 assign_tcp_keepalives_idle(int newval, bool doit, GucSource source)
5888 return (pq_setkeepalivesidle(newval, MyProcPort) == STATUS_OK);
5894 show_tcp_keepalives_idle(void)
5896 static char nbuf[16];
5898 snprintf(nbuf, sizeof(nbuf), "%d", pq_getkeepalivesidle(MyProcPort));
5903 assign_tcp_keepalives_interval(int newval, bool doit, GucSource source)
5906 return (pq_setkeepalivesinterval(newval, MyProcPort) == STATUS_OK);
5912 show_tcp_keepalives_interval(void)
5914 static char nbuf[16];
5916 snprintf(nbuf, sizeof(nbuf), "%d", pq_getkeepalivesinterval(MyProcPort));
5921 assign_tcp_keepalives_count(int newval, bool doit, GucSource source)
5924 return (pq_setkeepalivescount(newval, MyProcPort) == STATUS_OK);
5930 show_tcp_keepalives_count(void)
5932 static char nbuf[16];
5934 snprintf(nbuf, sizeof(nbuf), "%d", pq_getkeepalivescount(MyProcPort));
5939 #include "guc-file.c"