/*-------------------------------------------------------------------- * guc.c * * Support for grand unified configuration scheme, including SET * command, configuration file, and command line options. * See src/backend/utils/misc/README for more information. * * * Copyright (c) 2000-2004, PostgreSQL Global Development Group * Written by Peter Eisentraut . * * IDENTIFICATION * $PostgreSQL: pgsql/src/backend/utils/misc/guc.c,v 1.240 2004/10/08 01:36:35 tgl Exp $ * *-------------------------------------------------------------------- */ #include "postgres.h" #include #include #include #include #include #include "utils/guc.h" #include "utils/guc_tables.h" #include "catalog/namespace.h" #include "catalog/pg_type.h" #include "commands/async.h" #include "commands/variable.h" #include "commands/vacuum.h" #include "executor/executor.h" #include "fmgr.h" #include "funcapi.h" #include "libpq/auth.h" #include "libpq/pqcomm.h" #include "libpq/pqformat.h" #include "mb/pg_wchar.h" #include "miscadmin.h" #include "optimizer/cost.h" #include "optimizer/geqo.h" #include "optimizer/paths.h" #include "optimizer/prep.h" #include "parser/parse_expr.h" #include "parser/parse_relation.h" #include "postmaster/bgwriter.h" #include "postmaster/syslogger.h" #include "postmaster/postmaster.h" #include "storage/bufmgr.h" #include "storage/fd.h" #include "storage/freespace.h" #include "storage/lock.h" #include "storage/proc.h" #include "tcop/tcopprot.h" #include "utils/array.h" #include "utils/builtins.h" #include "utils/memutils.h" #include "utils/pg_locale.h" #include "pgstat.h" #ifndef PG_KRB_SRVTAB #define PG_KRB_SRVTAB "" #endif #define CONFIG_FILENAME "postgresql.conf" #ifdef EXEC_BACKEND #define CONFIG_EXEC_PARAMS "global/config_exec_params" #endif /* XXX these should appear in other modules' header files */ extern bool Log_disconnections; extern DLLIMPORT bool check_function_bodies; extern int CommitDelay; extern int CommitSiblings; extern int DebugSharedBuffers; static const char *assign_log_destination(const char *value, bool doit, GucSource source); #ifdef HAVE_SYSLOG extern char *Syslog_facility; extern char *Syslog_ident; static const char *assign_facility(const char *facility, bool doit, GucSource source); #endif static const char *assign_defaultxactisolevel(const char *newval, bool doit, GucSource source); static const char *assign_log_min_messages(const char *newval, bool doit, GucSource source); static const char *assign_client_min_messages(const char *newval, bool doit, GucSource source); static const char *assign_min_error_statement(const char *newval, bool doit, GucSource source); static const char *assign_msglvl(int *var, const char *newval, bool doit, GucSource source); static const char *assign_log_error_verbosity(const char *newval, bool doit, GucSource source); static const char *assign_log_statement(const char *newval, bool doit, GucSource source); static const char *assign_log_stmtlvl(int *var, const char *newval, bool doit, GucSource source); static bool assign_phony_autocommit(bool newval, bool doit, GucSource source); static const char *assign_custom_variable_classes(const char *newval, bool doit, GucSource source); static bool assign_stage_log_stats(bool newval, bool doit, GucSource source); static bool assign_log_stats(bool newval, bool doit, GucSource source); static bool assign_transaction_read_only(bool newval, bool doit, GucSource source); static const char *assign_canonical_path(const char *newval, bool doit, GucSource source); /* * These are initialized by SelectConfigFiles. */ char *ConfigDir = NULL; char *ConfigFileName = NULL; /* * GUC option variables that are exported from this module */ #ifdef USE_ASSERT_CHECKING bool assert_enabled = true; #endif bool log_duration = false; bool Debug_print_plan = false; bool Debug_print_parse = false; bool Debug_print_rewritten = false; bool Debug_pretty_print = false; bool Explain_pretty_print = true; bool log_parser_stats = false; bool log_planner_stats = false; bool log_executor_stats = false; bool log_statement_stats = false; /* this is sort of all * three above together */ bool log_btree_build_stats = false; bool SQL_inheritance = true; bool Australian_timezones = false; bool Password_encryption = true; bool default_with_oids = true; int log_min_error_statement = PANIC; int log_min_messages = NOTICE; int client_min_messages = NOTICE; int log_min_duration_statement = -1; char *guc_hbafile; char *guc_identfile; char *external_pidfile; /* * These variables are all dummies that don't do anything, except in some * cases provide the value for SHOW to display. The real state is elsewhere * and is kept in sync by assign_hooks. */ static char *client_min_messages_str; static char *log_min_messages_str; static char *log_error_verbosity_str; static char *log_statement_str; static char *log_min_error_statement_str; static char *log_destination_string; static bool phony_autocommit; static bool session_auth_is_superuser; static double phony_random_seed; static char *client_encoding_string; static char *datestyle_string; static char *default_iso_level_string; static char *locale_collate; static char *locale_ctype; static char *regex_flavor_string; static char *server_encoding_string; static char *server_version_string; static char *timezone_string; static char *XactIsoLevel_string; static char *guc_pgdata; static char *custom_variable_classes; static int max_function_args; static int max_index_keys; static int max_identifier_length; static int block_size; static bool integer_datetimes; /* should be static, but commands/variable.c needs to get at it */ char *session_authorization_string; /* * Displayable names for context types (enum GucContext) * * Note: these strings are deliberately not localized. */ const char *const GucContext_Names[] = { /* PGC_INTERNAL */ "internal", /* PGC_POSTMASTER */ "postmaster", /* PGC_SIGHUP */ "sighup", /* PGC_BACKEND */ "backend", /* PGC_SUSET */ "superuser", /* PGC_USERLIMIT */ "userlimit", /* PGC_USERSET */ "user" }; /* * Displayable names for source types (enum GucSource) * * Note: these strings are deliberately not localized. */ const char *const GucSource_Names[] = { /* PGC_S_DEFAULT */ "default", /* PGC_S_ENV_VAR */ "environment variable", /* PGC_S_FILE */ "configuration file", /* PGC_S_ARGV */ "command line", /* PGC_S_UNPRIVILEGED */ "unprivileged", /* PGC_S_DATABASE */ "database", /* PGC_S_USER */ "user", /* PGC_S_CLIENT */ "client", /* PGC_S_OVERRIDE */ "override", /* PGC_S_INTERACTIVE */ "interactive", /* PGC_S_TEST */ "test", /* PGC_S_SESSION */ "session" }; /* * Displayable names for the groupings defined in enum config_group */ const char *const config_group_names[] = { /* UNGROUPED */ gettext_noop("Ungrouped"), /* FILE_LOCATIONS */ gettext_noop("File Locations"), /* CONN_AUTH */ gettext_noop("Connections and Authentication"), /* CONN_AUTH_SETTINGS */ gettext_noop("Connections and Authentication / Connection Settings"), /* CONN_AUTH_SECURITY */ gettext_noop("Connections and Authentication / Security and Authentication"), /* RESOURCES */ gettext_noop("Resource Usage"), /* RESOURCES_MEM */ gettext_noop("Resource Usage / Memory"), /* RESOURCES_FSM */ gettext_noop("Resource Usage / Free Space Map"), /* RESOURCES_KERNEL */ gettext_noop("Resource Usage / Kernel Resources"), /* WAL */ gettext_noop("Write-Ahead Log"), /* WAL_SETTINGS */ gettext_noop("Write-Ahead Log / Settings"), /* WAL_CHECKPOINTS */ gettext_noop("Write-Ahead Log / Checkpoints"), /* QUERY_TUNING */ gettext_noop("Query Tuning"), /* QUERY_TUNING_METHOD */ gettext_noop("Query Tuning / Planner Method Configuration"), /* QUERY_TUNING_COST */ gettext_noop("Query Tuning / Planner Cost Constants"), /* QUERY_TUNING_GEQO */ gettext_noop("Query Tuning / Genetic Query Optimizer"), /* QUERY_TUNING_OTHER */ gettext_noop("Query Tuning / Other Planner Options"), /* LOGGING */ gettext_noop("Reporting and Logging"), /* LOGGING_WHERE */ gettext_noop("Reporting and Logging / Where to Log"), /* LOGGING_WHEN */ gettext_noop("Reporting and Logging / When to Log"), /* LOGGING_WHAT */ gettext_noop("Reporting and Logging / What to Log"), /* STATS */ gettext_noop("Statistics"), /* STATS_MONITORING */ gettext_noop("Statistics / Monitoring"), /* STATS_COLLECTOR */ gettext_noop("Statistics / Query and Index Statistics Collector"), /* CLIENT_CONN */ gettext_noop("Client Connection Defaults"), /* CLIENT_CONN_STATEMENT */ gettext_noop("Client Connection Defaults / Statement Behavior"), /* CLIENT_CONN_LOCALE */ gettext_noop("Client Connection Defaults / Locale and Formatting"), /* CLIENT_CONN_OTHER */ gettext_noop("Client Connection Defaults / Other Defaults"), /* LOCK_MANAGEMENT */ gettext_noop("Lock Management"), /* COMPAT_OPTIONS */ gettext_noop("Version and Platform Compatibility"), /* COMPAT_OPTIONS_PREVIOUS */ gettext_noop("Version and Platform Compatibility / Previous PostgreSQL Versions"), /* COMPAT_OPTIONS_CLIENT */ gettext_noop("Version and Platform Compatibility / Other Platforms and Clients"), /* PRESET_OPTIONS */ gettext_noop("Preset Options"), /* CUSTOM_OPTIONS */ gettext_noop("Customized Options"), /* DEVELOPER_OPTIONS */ gettext_noop("Developer Options"), /* help_config wants this array to be null-terminated */ NULL }; /* * Displayable names for GUC variable types (enum config_type) * * Note: these strings are deliberately not localized. */ const char *const config_type_names[] = { /* PGC_BOOL */ "bool", /* PGC_INT */ "integer", /* PGC_REAL */ "real", /* PGC_STRING */ "string" }; /* * Contents of GUC tables * * See src/backend/utils/misc/README for design notes. * * TO ADD AN OPTION: * * 1. Declare a global variable of type bool, int, double, or char* * and make use of it. * * 2. Decide at what times it's safe to set the option. See guc.h for * details. * * 3. Decide on a name, a default value, upper and lower bounds (if * applicable), etc. * * 4. Add a record below. * * 5. Add it to src/backend/utils/misc/postgresql.conf.sample, if * appropriate * * 6. Add it to src/bin/psql/tab-complete.c, if it's a USERSET option. * * 7. Don't forget to document the option. * * 8. If it's a new GUC_LIST option you must edit pg_dumpall.c to ensure * it is not single quoted at dump time. */ /******** option records follow ********/ static struct config_bool ConfigureNamesBool[] = { { {"enable_seqscan", PGC_USERSET, QUERY_TUNING_METHOD, gettext_noop("Enables the planner's use of sequential-scan plans."), NULL }, &enable_seqscan, true, NULL, NULL }, { {"enable_indexscan", PGC_USERSET, QUERY_TUNING_METHOD, gettext_noop("Enables the planner's use of index-scan plans."), NULL }, &enable_indexscan, true, NULL, NULL }, { {"enable_tidscan", PGC_USERSET, QUERY_TUNING_METHOD, gettext_noop("Enables the planner's use of TID scan plans."), NULL }, &enable_tidscan, true, NULL, NULL }, { {"enable_sort", PGC_USERSET, QUERY_TUNING_METHOD, gettext_noop("Enables the planner's use of explicit sort steps."), NULL }, &enable_sort, true, NULL, NULL }, { {"enable_hashagg", PGC_USERSET, QUERY_TUNING_METHOD, gettext_noop("Enables the planner's use of hashed aggregation plans."), NULL }, &enable_hashagg, true, NULL, NULL }, { {"enable_nestloop", PGC_USERSET, QUERY_TUNING_METHOD, gettext_noop("Enables the planner's use of nested-loop join plans."), NULL }, &enable_nestloop, true, NULL, NULL }, { {"enable_mergejoin", PGC_USERSET, QUERY_TUNING_METHOD, gettext_noop("Enables the planner's use of merge join plans."), NULL }, &enable_mergejoin, true, NULL, NULL }, { {"enable_hashjoin", PGC_USERSET, QUERY_TUNING_METHOD, gettext_noop("Enables the planner's use of hash join plans."), NULL }, &enable_hashjoin, true, NULL, NULL }, { {"geqo", PGC_USERSET, QUERY_TUNING_GEQO, gettext_noop("Enables genetic query optimization."), gettext_noop("This algorithm attempts to do planning without " "exhaustive searching.") }, &enable_geqo, true, NULL, NULL }, { /* Not for general use --- used by SET SESSION AUTHORIZATION */ {"is_superuser", PGC_INTERNAL, UNGROUPED, gettext_noop("Shows whether the current user is a superuser."), NULL, GUC_REPORT | GUC_NO_SHOW_ALL | GUC_NO_RESET_ALL | GUC_NOT_IN_SAMPLE | GUC_DISALLOW_IN_FILE }, &session_auth_is_superuser, false, NULL, NULL }, { {"ssl", PGC_POSTMASTER, CONN_AUTH_SECURITY, gettext_noop("Enables SSL connections."), NULL }, &EnableSSL, false, NULL, NULL }, { {"fsync", PGC_SIGHUP, WAL_SETTINGS, gettext_noop("Forces synchronization of updates to disk."), gettext_noop("The server will use the fsync() system call in several places to make " "sure that updates are physically written to disk. This insures " "that a database cluster will recover to a consistent state after " "an operating system or hardware crash.") }, &enableFsync, true, NULL, NULL }, { {"zero_damaged_pages", PGC_SUSET, DEVELOPER_OPTIONS, gettext_noop("Continues processing past damaged page headers."), gettext_noop("Detection of a damaged page header normally causes PostgreSQL to " "report an error, aborting the current transaction. Setting " "zero_damaged_pages to true causes the system to instead report a " "warning, zero out the damaged page, and continue processing. This " "behavior will destroy data, namely all the rows on the damaged page."), GUC_NOT_IN_SAMPLE }, &zero_damaged_pages, false, NULL, NULL }, { {"silent_mode", PGC_POSTMASTER, LOGGING_WHEN, gettext_noop("Runs the server silently."), gettext_noop("If this parameter is set, the server will automatically run in the " "background and any controlling terminals are dissociated.") }, &SilentMode, false, NULL, NULL }, { {"log_connections", PGC_BACKEND, LOGGING_WHAT, gettext_noop("Logs each successful connection."), NULL }, &Log_connections, false, NULL, NULL }, { {"log_disconnections", PGC_BACKEND, LOGGING_WHAT, gettext_noop("Logs end of a session, including duration"), NULL }, &Log_disconnections, false, NULL, NULL }, #ifdef USE_ASSERT_CHECKING { {"debug_assertions", PGC_USERSET, DEVELOPER_OPTIONS, gettext_noop("Turns on various assertion checks."), gettext_noop("This is a debugging aid."), GUC_NOT_IN_SAMPLE }, &assert_enabled, true, NULL, NULL }, #endif { /* currently undocumented, so don't show in SHOW ALL */ {"exit_on_error", PGC_USERSET, UNGROUPED, gettext_noop("no description available"), NULL, GUC_NO_SHOW_ALL | GUC_NOT_IN_SAMPLE }, &ExitOnAnyError, false, NULL, NULL }, { {"log_duration", PGC_USERLIMIT, LOGGING_WHAT, gettext_noop("Logs the duration each completed SQL statement."), NULL }, &log_duration, false, NULL, NULL }, { {"debug_print_parse", PGC_USERSET, LOGGING_WHAT, gettext_noop("Prints the parse tree to the server log."), NULL }, &Debug_print_parse, false, NULL, NULL }, { {"debug_print_rewritten", PGC_USERSET, LOGGING_WHAT, gettext_noop("Prints the parse tree after rewriting to server log."), NULL }, &Debug_print_rewritten, false, NULL, NULL }, { {"debug_print_plan", PGC_USERSET, LOGGING_WHAT, gettext_noop("Prints the execution plan to server log."), NULL }, &Debug_print_plan, false, NULL, NULL }, { {"debug_pretty_print", PGC_USERSET, LOGGING_WHAT, gettext_noop("Indents parse and plan tree displays."), NULL }, &Debug_pretty_print, false, NULL, NULL }, { {"log_parser_stats", PGC_USERLIMIT, STATS_MONITORING, gettext_noop("Writes parser performance statistics to the server log."), NULL }, &log_parser_stats, false, assign_stage_log_stats, NULL }, { {"log_planner_stats", PGC_USERLIMIT, STATS_MONITORING, gettext_noop("Writes planner performance statistics to the server log."), NULL }, &log_planner_stats, false, assign_stage_log_stats, NULL }, { {"log_executor_stats", PGC_USERLIMIT, STATS_MONITORING, gettext_noop("Writes executor performance statistics to the server log."), NULL }, &log_executor_stats, false, assign_stage_log_stats, NULL }, { {"log_statement_stats", PGC_USERLIMIT, STATS_MONITORING, gettext_noop("Writes cumulative performance statistics to the server log."), NULL }, &log_statement_stats, false, assign_log_stats, NULL }, #ifdef BTREE_BUILD_STATS { {"log_btree_build_stats", PGC_SUSET, DEVELOPER_OPTIONS, gettext_noop("no description available"), NULL, GUC_NOT_IN_SAMPLE }, &log_btree_build_stats, false, NULL, NULL }, #endif { {"explain_pretty_print", PGC_USERSET, CLIENT_CONN_OTHER, gettext_noop("Uses the indented output format for EXPLAIN VERBOSE."), NULL }, &Explain_pretty_print, true, NULL, NULL }, { {"stats_start_collector", PGC_POSTMASTER, STATS_COLLECTOR, gettext_noop("Starts the server statistics-collection subprocess."), NULL }, &pgstat_collect_startcollector, true, NULL, NULL }, { {"stats_reset_on_server_start", PGC_POSTMASTER, STATS_COLLECTOR, gettext_noop("Zeroes collected statistics on server restart."), NULL }, &pgstat_collect_resetonpmstart, true, NULL, NULL }, { {"stats_command_string", PGC_SUSET, STATS_COLLECTOR, gettext_noop("Collects statistics about executing commands."), gettext_noop("Enables the collection of statistics on the currently " "executing command of each session, along with the time " "at which that command began execution.") }, &pgstat_collect_querystring, false, NULL, NULL }, { {"stats_row_level", PGC_SUSET, STATS_COLLECTOR, gettext_noop("Collects row-level statistics on database activity."), NULL }, &pgstat_collect_tuplelevel, false, NULL, NULL }, { {"stats_block_level", PGC_SUSET, STATS_COLLECTOR, gettext_noop("Collects block-level statistics on database activity."), NULL }, &pgstat_collect_blocklevel, false, NULL, NULL }, { {"trace_notify", PGC_USERSET, DEVELOPER_OPTIONS, gettext_noop("Generates debugging output for LISTEN and NOTIFY."), NULL, GUC_NOT_IN_SAMPLE }, &Trace_notify, false, NULL, NULL }, #ifdef LOCK_DEBUG { {"trace_locks", PGC_SUSET, DEVELOPER_OPTIONS, gettext_noop("no description available"), NULL, GUC_NOT_IN_SAMPLE }, &Trace_locks, false, NULL, NULL }, { {"trace_userlocks", PGC_SUSET, DEVELOPER_OPTIONS, gettext_noop("no description available"), NULL, GUC_NOT_IN_SAMPLE }, &Trace_userlocks, false, NULL, NULL }, { {"trace_lwlocks", PGC_SUSET, DEVELOPER_OPTIONS, gettext_noop("no description available"), NULL, GUC_NOT_IN_SAMPLE }, &Trace_lwlocks, false, NULL, NULL }, { {"debug_deadlocks", PGC_SUSET, DEVELOPER_OPTIONS, gettext_noop("no description available"), NULL, GUC_NOT_IN_SAMPLE }, &Debug_deadlocks, false, NULL, NULL }, #endif { {"log_hostname", PGC_SIGHUP, LOGGING_WHAT, gettext_noop("Logs the host name in the connection logs."), gettext_noop("By default, connection logs only show the IP address " "of the connecting host. If you want them to show the host name you " "can turn this on, but depending on your host name resolution " "setup it might impose a non-negligible performance penalty.") }, &log_hostname, false, NULL, NULL }, { {"sql_inheritance", PGC_USERSET, COMPAT_OPTIONS_PREVIOUS, gettext_noop("Causes subtables to be included by default in various commands."), NULL }, &SQL_inheritance, true, NULL, NULL }, { {"australian_timezones", PGC_USERSET, CLIENT_CONN_LOCALE, gettext_noop("Interprets ACST, CST, EST, and SAT as Australian time zones."), gettext_noop("Otherwise they are interpreted as North/South American " "time zones and Saturday.") }, &Australian_timezones, false, ClearDateCache, NULL }, { {"password_encryption", PGC_USERSET, CONN_AUTH_SECURITY, gettext_noop("Encrypt passwords."), gettext_noop("When a password is specified in CREATE USER or " "ALTER USER without writing either ENCRYPTED or UNENCRYPTED, " "this parameter determines whether the password is to be encrypted.") }, &Password_encryption, true, NULL, NULL }, { {"transform_null_equals", PGC_USERSET, COMPAT_OPTIONS_CLIENT, gettext_noop("Treats \"expr=NULL\" as \"expr IS NULL\"."), gettext_noop("When turned on, expressions of the form expr = NULL " "(or NULL = expr) are treated as expr IS NULL, that is, they " "return true if expr evaluates to the null value, and false " "otherwise. The correct behavior of expr = NULL is to always " "return null (unknown).") }, &Transform_null_equals, false, NULL, NULL }, { {"db_user_namespace", PGC_SIGHUP, CONN_AUTH_SECURITY, gettext_noop("Enables per-database user names."), NULL }, &Db_user_namespace, false, NULL, NULL }, { /* only here for backwards compatibility */ {"autocommit", PGC_USERSET, CLIENT_CONN_STATEMENT, gettext_noop("This parameter doesn't do anything."), gettext_noop("It's just here so that we won't choke on SET AUTOCOMMIT TO ON from 7.3-vintage clients."), GUC_NO_SHOW_ALL | GUC_NOT_IN_SAMPLE }, &phony_autocommit, true, assign_phony_autocommit, NULL }, { {"default_transaction_read_only", PGC_USERSET, CLIENT_CONN_STATEMENT, gettext_noop("Sets the default read-only status of new transactions."), NULL }, &DefaultXactReadOnly, false, NULL, NULL }, { {"transaction_read_only", PGC_USERSET, CLIENT_CONN_STATEMENT, gettext_noop("Sets the current transaction's read-only status."), NULL, GUC_NO_RESET_ALL | GUC_NOT_IN_SAMPLE | GUC_DISALLOW_IN_FILE }, &XactReadOnly, false, assign_transaction_read_only, NULL }, { {"add_missing_from", PGC_USERSET, COMPAT_OPTIONS_PREVIOUS, gettext_noop("Automatically adds missing table references to FROM clauses."), NULL }, &add_missing_from, true, NULL, NULL }, { {"check_function_bodies", PGC_USERSET, CLIENT_CONN_STATEMENT, gettext_noop("Check function bodies during CREATE FUNCTION."), NULL }, &check_function_bodies, true, NULL, NULL }, { {"default_with_oids", PGC_USERSET, COMPAT_OPTIONS_PREVIOUS, gettext_noop("By default, newly-created tables should have OIDs"), NULL }, &default_with_oids, true, NULL, NULL }, { {"redirect_stderr", PGC_POSTMASTER, LOGGING_WHERE, gettext_noop("Start a subprocess to capture stderr output into log files"), NULL }, &Redirect_stderr, false, NULL, NULL }, { {"log_truncate_on_rotation", PGC_SIGHUP, LOGGING_WHERE, gettext_noop("Truncate existing log files of same name during log rotation"), NULL }, &Log_truncate_on_rotation, false, NULL, NULL }, #ifdef WAL_DEBUG { {"wal_debug", PGC_SUSET, DEVELOPER_OPTIONS, gettext_noop("Emit WAL-related debugging output."), NULL, GUC_NOT_IN_SAMPLE }, &XLOG_DEBUG, false, NULL, NULL }, #endif { {"integer_datetimes", PGC_INTERNAL, PRESET_OPTIONS, gettext_noop("Datetimes are integer based"), NULL, GUC_REPORT | GUC_NOT_IN_SAMPLE | GUC_DISALLOW_IN_FILE }, &integer_datetimes, #ifdef HAVE_INT64_TIMESTAMP true, NULL, NULL #else false, NULL, NULL #endif }, /* End-of-list marker */ { {NULL, 0, 0, NULL, NULL}, NULL, false, NULL, NULL } }; static struct config_int ConfigureNamesInt[] = { { {"default_statistics_target", PGC_USERSET, QUERY_TUNING_OTHER, gettext_noop("Sets the default statistics target."), gettext_noop("This applies to table columns that have not had a " "column-specific target set via ALTER TABLE SET STATISTICS.") }, &default_statistics_target, 10, 1, 1000, NULL, NULL }, { {"from_collapse_limit", PGC_USERSET, QUERY_TUNING_OTHER, gettext_noop("Sets the FROM-list size beyond which subqueries are not " "collapsed."), gettext_noop("The planner will merge subqueries into upper " "queries if the resulting FROM list would have no more than " "this many items.") }, &from_collapse_limit, 8, 1, INT_MAX, NULL, NULL }, { {"join_collapse_limit", PGC_USERSET, QUERY_TUNING_OTHER, gettext_noop("Sets the FROM-list size beyond which JOIN constructs are not " "flattened."), gettext_noop("The planner will flatten explicit inner JOIN " "constructs into lists of FROM items whenever a list of no more " "than this many items would result.") }, &join_collapse_limit, 8, 1, INT_MAX, NULL, NULL }, { {"geqo_threshold", PGC_USERSET, QUERY_TUNING_GEQO, gettext_noop("Sets the threshold of FROM items beyond which GEQO is used."), NULL }, &geqo_threshold, 12, 2, INT_MAX, NULL, NULL }, { {"geqo_effort", PGC_USERSET, QUERY_TUNING_GEQO, gettext_noop("GEQO: effort is used to set the default for other GEQO parameters."), NULL }, &Geqo_effort, DEFAULT_GEQO_EFFORT, MIN_GEQO_EFFORT, MAX_GEQO_EFFORT, NULL, NULL }, { {"geqo_pool_size", PGC_USERSET, QUERY_TUNING_GEQO, gettext_noop("GEQO: number of individuals in the population."), gettext_noop("Zero selects a suitable default value.") }, &Geqo_pool_size, 0, 0, INT_MAX, NULL, NULL }, { {"geqo_generations", PGC_USERSET, QUERY_TUNING_GEQO, gettext_noop("GEQO: number of iterations of the algorithm."), gettext_noop("Zero selects a suitable default value.") }, &Geqo_generations, 0, 0, INT_MAX, NULL, NULL }, { {"deadlock_timeout", PGC_SIGHUP, LOCK_MANAGEMENT, gettext_noop("The time in milliseconds to wait on lock before checking for deadlock."), NULL }, &DeadlockTimeout, 1000, 0, INT_MAX, NULL, NULL }, /* * Note: There is some postprocessing done in PostmasterMain() to make * sure the buffers are at least twice the number of backends, so the * constraints here are partially unused. Similarly, the superuser * reserved number is checked to ensure it is less than the max * backends number. */ { {"max_connections", PGC_POSTMASTER, CONN_AUTH_SETTINGS, gettext_noop("Sets the maximum number of concurrent connections."), NULL }, &MaxBackends, 100, 1, INT_MAX, NULL, NULL }, { {"superuser_reserved_connections", PGC_POSTMASTER, CONN_AUTH_SETTINGS, gettext_noop("Sets the number of connection slots reserved for superusers."), NULL }, &ReservedBackends, 2, 0, INT_MAX, NULL, NULL }, { {"shared_buffers", PGC_POSTMASTER, RESOURCES_MEM, gettext_noop("Sets the number of shared memory buffers used by the server."), NULL }, &NBuffers, 1000, 16, INT_MAX, NULL, NULL }, { {"port", PGC_POSTMASTER, CONN_AUTH_SETTINGS, gettext_noop("Sets the TCP port the server listens on."), NULL }, &PostPortNumber, DEF_PGPORT, 1, 65535, NULL, NULL }, { {"unix_socket_permissions", PGC_POSTMASTER, CONN_AUTH_SETTINGS, gettext_noop("Sets the access permissions of the Unix-domain socket."), gettext_noop("Unix-domain sockets use the usual Unix file system " "permission set. The parameter value is expected to be an numeric mode " "specification in the form accepted by the chmod and umask system " "calls. (To use the customary octal format the number must start with " "a 0 (zero).)") }, &Unix_socket_permissions, 0777, 0000, 0777, NULL, NULL }, { {"work_mem", PGC_USERSET, RESOURCES_MEM, gettext_noop("Sets the maximum memory to be used for query workspaces."), gettext_noop("This much memory may be used by each internal " "sort operation and hash table before switching to " "temporary disk files.") }, &work_mem, 1024, 8 * BLCKSZ / 1024, INT_MAX / 1024, NULL, NULL }, { {"maintenance_work_mem", PGC_USERSET, RESOURCES_MEM, gettext_noop("Sets the maximum memory to be used for maintenance operations."), gettext_noop("This includes operations such as VACUUM and CREATE INDEX.") }, &maintenance_work_mem, 16384, 1024, INT_MAX / 1024, NULL, NULL }, { {"max_stack_depth", PGC_SUSET, RESOURCES_MEM, gettext_noop("Sets the maximum stack depth, in kilobytes."), NULL }, &max_stack_depth, 2048, 100, INT_MAX / 1024, assign_max_stack_depth, NULL }, { {"vacuum_cost_page_hit", PGC_USERSET, RESOURCES, gettext_noop("Vacuum cost for a page found in the buffer cache."), NULL }, &VacuumCostPageHit, 1, 0, 10000, NULL, NULL }, { {"vacuum_cost_page_miss", PGC_USERSET, RESOURCES, gettext_noop("Vacuum cost for a page not found in the buffer cache."), NULL }, &VacuumCostPageMiss, 10, 0, 10000, NULL, NULL }, { {"vacuum_cost_page_dirty", PGC_USERSET, RESOURCES, gettext_noop("Vacuum cost for a page dirtied by vacuum."), NULL }, &VacuumCostPageDirty, 20, 0, 10000, NULL, NULL }, { {"vacuum_cost_limit", PGC_USERSET, RESOURCES, gettext_noop("Vacuum cost amount available before napping."), NULL }, &VacuumCostLimit, 200, 1, 10000, NULL, NULL }, { {"vacuum_cost_delay", PGC_USERSET, RESOURCES, gettext_noop("Vacuum cost delay in milliseconds."), NULL }, &VacuumCostDelay, 0, 0, 1000, NULL, NULL }, { {"max_files_per_process", PGC_POSTMASTER, RESOURCES_KERNEL, gettext_noop("Sets the maximum number of simultaneously open files for each server process."), NULL }, &max_files_per_process, 1000, 25, INT_MAX, NULL, NULL }, #ifdef LOCK_DEBUG { {"trace_lock_oidmin", PGC_SUSET, DEVELOPER_OPTIONS, gettext_noop("no description available"), NULL, GUC_NOT_IN_SAMPLE }, &Trace_lock_oidmin, BootstrapObjectIdData, 1, INT_MAX, NULL, NULL }, { {"trace_lock_table", PGC_SUSET, DEVELOPER_OPTIONS, gettext_noop("no description available"), NULL, GUC_NOT_IN_SAMPLE }, &Trace_lock_table, 0, 0, INT_MAX, NULL, NULL }, #endif { {"statement_timeout", PGC_USERSET, CLIENT_CONN_STATEMENT, gettext_noop("Sets the maximum allowed duration (in milliseconds) of any statement."), gettext_noop("A value of 0 turns off the timeout.") }, &StatementTimeout, 0, 0, INT_MAX, NULL, NULL }, { {"max_fsm_relations", PGC_POSTMASTER, RESOURCES_FSM, gettext_noop("Sets the maximum number of tables and indexes for which free space is " "tracked."), NULL }, &MaxFSMRelations, 1000, 100, INT_MAX, NULL, NULL }, { {"max_fsm_pages", PGC_POSTMASTER, RESOURCES_FSM, gettext_noop("Sets the maximum number of disk pages for which free space is " "tracked."), NULL }, &MaxFSMPages, 20000, 1000, INT_MAX, NULL, NULL }, { {"max_locks_per_transaction", PGC_POSTMASTER, LOCK_MANAGEMENT, gettext_noop("Sets the maximum number of locks per transaction."), gettext_noop("The shared lock table is sized on the assumption that " "at most max_locks_per_transaction * max_connections distinct " "objects will need to be locked at any one time.") }, &max_locks_per_xact, 64, 10, INT_MAX, NULL, NULL }, { {"authentication_timeout", PGC_SIGHUP, CONN_AUTH_SECURITY, gettext_noop("Sets the maximum time in seconds to complete client authentication."), NULL }, &AuthenticationTimeout, 60, 1, 600, NULL, NULL }, { /* Not for general use */ {"pre_auth_delay", PGC_SIGHUP, DEVELOPER_OPTIONS, gettext_noop("no description available"), NULL, GUC_NOT_IN_SAMPLE }, &PreAuthDelay, 0, 0, 60, NULL, NULL }, { {"checkpoint_segments", PGC_SIGHUP, WAL_CHECKPOINTS, gettext_noop("Sets the maximum distance in log segments between automatic WAL checkpoints."), NULL }, &CheckPointSegments, 3, 1, INT_MAX, NULL, NULL }, { {"checkpoint_timeout", PGC_SIGHUP, WAL_CHECKPOINTS, gettext_noop("Sets the maximum time in seconds between automatic WAL checkpoints."), NULL }, &CheckPointTimeout, 300, 30, 3600, NULL, NULL }, { {"checkpoint_warning", PGC_SIGHUP, WAL_CHECKPOINTS, gettext_noop("Logs if filling of checkpoint segments happens more " "frequently than this (in seconds)."), gettext_noop("Write a message to the server log if checkpoints " "caused by the filling of checkpoint segment files happens more " "frequently than this number of seconds. Zero turns off the warning.") }, &CheckPointWarning, 30, 0, INT_MAX, NULL, NULL }, { {"wal_buffers", PGC_POSTMASTER, WAL_SETTINGS, gettext_noop("Sets the number of disk-page buffers in shared memory for WAL."), NULL }, &XLOGbuffers, 8, 4, INT_MAX, NULL, NULL }, { {"commit_delay", PGC_USERSET, WAL_CHECKPOINTS, gettext_noop("Sets the delay in microseconds between transaction commit and " "flushing WAL to disk."), NULL }, &CommitDelay, 0, 0, 100000, NULL, NULL }, { {"commit_siblings", PGC_USERSET, WAL_CHECKPOINTS, gettext_noop("Sets the minimum concurrent open transactions before performing " "commit_delay."), NULL }, &CommitSiblings, 5, 1, 1000, NULL, NULL }, { {"extra_float_digits", PGC_USERSET, CLIENT_CONN_LOCALE, gettext_noop("Sets the number of digits displayed for floating-point values."), gettext_noop("This affects real, double precision, and geometric data types. " "The parameter value is added to the standard number of digits " "(FLT_DIG or DBL_DIG as appropriate).") }, &extra_float_digits, 0, -15, 2, NULL, NULL }, { {"log_min_duration_statement", PGC_USERLIMIT, LOGGING_WHEN, gettext_noop("Sets the minimum execution time in milliseconds above which statements will " "be logged."), gettext_noop("Zero prints all queries. The default is -1 (turning this feature off).") }, &log_min_duration_statement, -1, -1, INT_MAX / 1000, NULL, NULL }, { {"debug_shared_buffers", PGC_POSTMASTER, STATS_MONITORING, gettext_noop("Interval to report shared buffer status in seconds"), NULL }, &DebugSharedBuffers, 0, 0, 600, NULL, NULL }, { {"bgwriter_delay", PGC_SIGHUP, RESOURCES, gettext_noop("Background writer sleep time between rounds in milliseconds"), NULL }, &BgWriterDelay, 200, 10, 5000, NULL, NULL }, { {"bgwriter_percent", PGC_SIGHUP, RESOURCES, gettext_noop("Background writer percentage of dirty buffers to flush per round"), NULL }, &BgWriterPercent, 1, 1, 100, NULL, NULL }, { {"bgwriter_maxpages", PGC_SIGHUP, RESOURCES, gettext_noop("Background writer maximum number of pages to flush per round"), NULL }, &BgWriterMaxPages, 100, 1, 1000, NULL, NULL }, { {"log_rotation_age", PGC_SIGHUP, LOGGING_WHERE, gettext_noop("Automatic logfile rotation will occur after N minutes"), NULL }, &Log_RotationAge, 24 * 60, 0, INT_MAX, NULL, NULL }, { {"log_rotation_size", PGC_SIGHUP, LOGGING_WHERE, gettext_noop("Automatic logfile rotation will occur after N kilobytes"), NULL }, &Log_RotationSize, 10 * 1024, 0, INT_MAX, NULL, NULL }, { {"max_function_args", PGC_INTERNAL, PRESET_OPTIONS, gettext_noop("Shows the maximum number of function arguments"), NULL, GUC_NOT_IN_SAMPLE | GUC_DISALLOW_IN_FILE }, &max_function_args, FUNC_MAX_ARGS, FUNC_MAX_ARGS, FUNC_MAX_ARGS, NULL, NULL }, { {"max_index_keys", PGC_INTERNAL, PRESET_OPTIONS, gettext_noop("Shows the maximum number of index keys"), NULL, GUC_NOT_IN_SAMPLE | GUC_DISALLOW_IN_FILE }, &max_index_keys, INDEX_MAX_KEYS, INDEX_MAX_KEYS, INDEX_MAX_KEYS, NULL, NULL }, { {"max_identifier_length", PGC_INTERNAL, PRESET_OPTIONS, gettext_noop("Shows the maximum identifier length"), NULL, GUC_NOT_IN_SAMPLE | GUC_DISALLOW_IN_FILE }, &max_identifier_length, NAMEDATALEN - 1, NAMEDATALEN - 1, NAMEDATALEN - 1, NULL, NULL }, { {"block_size", PGC_INTERNAL, PRESET_OPTIONS, gettext_noop("Shows size of a disk block"), NULL, GUC_NOT_IN_SAMPLE | GUC_DISALLOW_IN_FILE }, &block_size, BLCKSZ, BLCKSZ, BLCKSZ, NULL, NULL }, /* End-of-list marker */ { {NULL, 0, 0, NULL, NULL}, NULL, 0, 0, 0, NULL, NULL } }; static struct config_real ConfigureNamesReal[] = { { {"effective_cache_size", PGC_USERSET, QUERY_TUNING_COST, gettext_noop("Sets the planner's assumption about size of the disk cache."), gettext_noop("That is, the portion of the kernel's disk cache that " "will be used for PostgreSQL data files. This is measured in disk " "pages, which are normally 8 kB each.") }, &effective_cache_size, DEFAULT_EFFECTIVE_CACHE_SIZE, 0, DBL_MAX, NULL, NULL }, { {"random_page_cost", PGC_USERSET, QUERY_TUNING_COST, gettext_noop("Sets the planner's estimate of the cost of a nonsequentially " "fetched disk page."), gettext_noop("This is measured as a multiple of the cost of a " "sequential page fetch. A higher value makes it more likely a " "sequential scan will be used, a lower value makes it more likely an " "index scan will be used.") }, &random_page_cost, DEFAULT_RANDOM_PAGE_COST, 0, DBL_MAX, NULL, NULL }, { {"cpu_tuple_cost", PGC_USERSET, QUERY_TUNING_COST, gettext_noop("Sets the planner's estimate of the cost of processing each tuple (row)."), gettext_noop("This is measured as a fraction of the cost of a " "sequential page fetch.") }, &cpu_tuple_cost, DEFAULT_CPU_TUPLE_COST, 0, DBL_MAX, NULL, NULL }, { {"cpu_index_tuple_cost", PGC_USERSET, QUERY_TUNING_COST, gettext_noop("Sets the planner's estimate of processing cost for each " "index tuple (row) during index scan."), gettext_noop("This is measured as a fraction of the cost of a " "sequential page fetch.") }, &cpu_index_tuple_cost, DEFAULT_CPU_INDEX_TUPLE_COST, 0, DBL_MAX, NULL, NULL }, { {"cpu_operator_cost", PGC_USERSET, QUERY_TUNING_COST, gettext_noop("Sets the planner's estimate of processing cost of each operator in WHERE."), gettext_noop("This is measured as a fraction of the cost of a sequential " "page fetch.") }, &cpu_operator_cost, DEFAULT_CPU_OPERATOR_COST, 0, DBL_MAX, NULL, NULL }, { {"geqo_selection_bias", PGC_USERSET, QUERY_TUNING_GEQO, gettext_noop("GEQO: selective pressure within the population."), NULL }, &Geqo_selection_bias, DEFAULT_GEQO_SELECTION_BIAS, MIN_GEQO_SELECTION_BIAS, MAX_GEQO_SELECTION_BIAS, NULL, NULL }, { {"seed", PGC_USERSET, UNGROUPED, gettext_noop("Sets the seed for random-number generation."), NULL, GUC_NO_SHOW_ALL | GUC_NO_RESET_ALL | GUC_NOT_IN_SAMPLE | GUC_DISALLOW_IN_FILE }, &phony_random_seed, 0.5, 0.0, 1.0, assign_random_seed, show_random_seed }, /* End-of-list marker */ { {NULL, 0, 0, NULL, NULL}, NULL, 0.0, 0.0, 0.0, NULL, NULL } }; static struct config_string ConfigureNamesString[] = { { {"archive_command", PGC_SIGHUP, WAL_SETTINGS, gettext_noop("WAL archiving command."), gettext_noop("The shell command that will be called to archive a WAL file.") }, &XLogArchiveCommand, "", NULL, NULL }, { {"client_encoding", PGC_USERSET, CLIENT_CONN_LOCALE, gettext_noop("Sets the client's character set encoding."), NULL, GUC_REPORT }, &client_encoding_string, "SQL_ASCII", assign_client_encoding, NULL }, { {"client_min_messages", PGC_USERSET, LOGGING_WHEN, gettext_noop("Sets the message levels that are sent to the client."), gettext_noop("Valid values are DEBUG5, DEBUG4, DEBUG3, DEBUG2, " "DEBUG1, LOG, NOTICE, WARNING, and ERROR. Each level includes all the " "levels that follow it. The later the level, the fewer messages are " "sent.") }, &client_min_messages_str, "notice", assign_client_min_messages, NULL }, { {"log_min_messages", PGC_USERLIMIT, LOGGING_WHEN, gettext_noop("Sets the message levels that are logged."), gettext_noop("Valid values are DEBUG5, DEBUG4, DEBUG3, DEBUG2, DEBUG1, " "INFO, NOTICE, WARNING, ERROR, LOG, FATAL, and PANIC. Each level " "includes all the levels that follow it.") }, &log_min_messages_str, "notice", assign_log_min_messages, NULL }, { {"log_error_verbosity", PGC_SUSET, LOGGING_WHEN, gettext_noop("Sets the verbosity of logged messages."), gettext_noop("Valid values are \"terse\", \"default\", and \"verbose\".") }, &log_error_verbosity_str, "default", assign_log_error_verbosity, NULL }, { {"log_statement", PGC_USERLIMIT, LOGGING_WHAT, gettext_noop("Sets the type of statements logged."), gettext_noop("Valid values are \"none\", \"mod\", \"ddl\", and \"all\".") }, &log_statement_str, "none", assign_log_statement, NULL }, { {"log_min_error_statement", PGC_USERLIMIT, LOGGING_WHEN, gettext_noop("Causes all statements generating error at or above this level to be logged."), gettext_noop("All SQL statements that cause an error of the " "specified level or a higher level are logged.") }, &log_min_error_statement_str, "panic", assign_min_error_statement, NULL }, { {"log_line_prefix", PGC_SIGHUP, LOGGING_WHAT, gettext_noop("Controls information prefixed to each log line"), gettext_noop("if blank no prefix is used") }, &Log_line_prefix, "", NULL, NULL }, { {"DateStyle", PGC_USERSET, CLIENT_CONN_LOCALE, gettext_noop("Sets the display format for date and time values."), gettext_noop("Also controls interpretation of ambiguous " "date inputs."), GUC_LIST_INPUT | GUC_REPORT }, &datestyle_string, "ISO, MDY", assign_datestyle, NULL }, { {"default_transaction_isolation", PGC_USERSET, CLIENT_CONN_STATEMENT, gettext_noop("Sets the transaction isolation level of each new transaction."), gettext_noop("Each SQL transaction has an isolation level, which " "can be either \"read uncommitted\", \"read committed\", \"repeatable read\", or \"serializable\".") }, &default_iso_level_string, "read committed", assign_defaultxactisolevel, NULL }, { {"dynamic_library_path", PGC_SUSET, CLIENT_CONN_OTHER, gettext_noop("Sets the path for dynamically loadable modules."), gettext_noop("If a dynamically loadable module needs to be opened and " "the specified name does not have a directory component (i.e., the " "name does not contain a slash), the system will search this path for " "the specified file.") }, &Dynamic_library_path, "$libdir", NULL, NULL }, { {"krb_server_keyfile", PGC_POSTMASTER, CONN_AUTH_SECURITY, gettext_noop("Sets the location of the Kerberos server key file."), NULL }, &pg_krb_server_keyfile, PG_KRB_SRVTAB, NULL, NULL }, { {"rendezvous_name", PGC_POSTMASTER, CONN_AUTH_SETTINGS, gettext_noop("Sets the Rendezvous broadcast service name."), NULL }, &rendezvous_name, "", NULL, NULL }, /* See main.c about why defaults for LC_foo are not all alike */ { {"lc_collate", PGC_INTERNAL, CLIENT_CONN_LOCALE, gettext_noop("Shows the collation order locale."), NULL, GUC_NOT_IN_SAMPLE | GUC_DISALLOW_IN_FILE }, &locale_collate, "C", NULL, NULL }, { {"lc_ctype", PGC_INTERNAL, CLIENT_CONN_LOCALE, gettext_noop("Shows the character classification and case conversion locale."), NULL, GUC_NOT_IN_SAMPLE | GUC_DISALLOW_IN_FILE }, &locale_ctype, "C", NULL, NULL }, { {"lc_messages", PGC_SUSET, CLIENT_CONN_LOCALE, gettext_noop("Sets the language in which messages are displayed."), NULL }, &locale_messages, "", locale_messages_assign, NULL }, { {"lc_monetary", PGC_USERSET, CLIENT_CONN_LOCALE, gettext_noop("Sets the locale for formatting monetary amounts."), NULL }, &locale_monetary, "C", locale_monetary_assign, NULL }, { {"lc_numeric", PGC_USERSET, CLIENT_CONN_LOCALE, gettext_noop("Sets the locale for formatting numbers."), NULL }, &locale_numeric, "C", locale_numeric_assign, NULL }, { {"lc_time", PGC_USERSET, CLIENT_CONN_LOCALE, gettext_noop("Sets the locale for formatting date and time values."), NULL }, &locale_time, "C", locale_time_assign, NULL }, { {"preload_libraries", PGC_POSTMASTER, RESOURCES_KERNEL, gettext_noop("Lists shared libraries to preload into server."), NULL, GUC_LIST_INPUT | GUC_LIST_QUOTE }, &preload_libraries_string, "", NULL, NULL }, { {"regex_flavor", PGC_USERSET, COMPAT_OPTIONS_PREVIOUS, gettext_noop("Sets the regular expression \"flavor\"."), gettext_noop("This can be set to advanced, extended, or basic.") }, ®ex_flavor_string, "advanced", assign_regex_flavor, NULL }, { {"search_path", PGC_USERSET, CLIENT_CONN_STATEMENT, gettext_noop("Sets the schema search order for names that are not schema-qualified."), NULL, GUC_LIST_INPUT | GUC_LIST_QUOTE }, &namespace_search_path, "$user,public", assign_search_path, NULL }, { /* Can't be set in postgresql.conf */ {"server_encoding", PGC_INTERNAL, CLIENT_CONN_LOCALE, gettext_noop("Sets the server (database) character set encoding."), NULL, GUC_REPORT | GUC_NOT_IN_SAMPLE | GUC_DISALLOW_IN_FILE }, &server_encoding_string, "SQL_ASCII", NULL, NULL }, { /* Can't be set in postgresql.conf */ {"server_version", PGC_INTERNAL, PRESET_OPTIONS, gettext_noop("Shows the server version."), NULL, GUC_REPORT | GUC_NOT_IN_SAMPLE | GUC_DISALLOW_IN_FILE }, &server_version_string, PG_VERSION, NULL, NULL }, { /* Not for general use --- used by SET SESSION AUTHORIZATION */ {"session_authorization", PGC_USERSET, UNGROUPED, gettext_noop("Sets the session user name."), NULL, GUC_REPORT | GUC_NO_SHOW_ALL | GUC_NO_RESET_ALL | GUC_NOT_IN_SAMPLE | GUC_DISALLOW_IN_FILE }, &session_authorization_string, NULL, assign_session_authorization, show_session_authorization }, { {"log_destination", PGC_SIGHUP, LOGGING_WHERE, gettext_noop("Sets the destination for server log output."), gettext_noop("Valid values are combinations of stderr, syslog " "and eventlog, depending on platform."), GUC_LIST_INPUT }, &log_destination_string, "stderr", assign_log_destination, NULL }, { {"log_directory", PGC_SIGHUP, LOGGING_WHERE, gettext_noop("Sets the destination directory for log files."), gettext_noop("May be specified as relative to the cluster directory " "or as absolute path.") }, &Log_directory, "pg_log", NULL, NULL }, { {"log_filename", PGC_SIGHUP, LOGGING_WHERE, gettext_noop("Sets the file name pattern for log files."), NULL }, &Log_filename, "postgresql-%Y-%m-%d_%H%M%S.log", NULL, NULL }, #ifdef HAVE_SYSLOG { {"syslog_facility", PGC_POSTMASTER, LOGGING_WHERE, gettext_noop("Sets the syslog \"facility\" to be used when syslog enabled."), gettext_noop("Valid values are LOCAL0, LOCAL1, LOCAL2, LOCAL3, " "LOCAL4, LOCAL5, LOCAL6, LOCAL7.") }, &Syslog_facility, "LOCAL0", assign_facility, NULL }, { {"syslog_ident", PGC_POSTMASTER, LOGGING_WHERE, gettext_noop("Sets the program name used to identify PostgreSQL messages " "in syslog."), NULL }, &Syslog_ident, "postgres", NULL, NULL }, #endif { {"TimeZone", PGC_USERSET, CLIENT_CONN_LOCALE, gettext_noop("Sets the time zone for displaying and interpreting time stamps."), NULL }, &timezone_string, "UNKNOWN", assign_timezone, show_timezone }, { {"transaction_isolation", PGC_USERSET, CLIENT_CONN_STATEMENT, gettext_noop("Sets the current transaction's isolation level."), NULL, GUC_NO_RESET_ALL | GUC_NOT_IN_SAMPLE | GUC_DISALLOW_IN_FILE }, &XactIsoLevel_string, NULL, assign_XactIsoLevel, show_XactIsoLevel }, { {"unix_socket_group", PGC_POSTMASTER, CONN_AUTH_SETTINGS, gettext_noop("Sets the owning group of the Unix-domain socket."), gettext_noop("(The owning user of the socket is always the user " "that starts the server.)") }, &Unix_socket_group, "", NULL, NULL }, { {"unix_socket_directory", PGC_POSTMASTER, CONN_AUTH_SETTINGS, gettext_noop("Sets the directory where the Unix-domain socket will be created."), NULL }, &UnixSocketDir, "", assign_canonical_path, NULL }, { {"listen_addresses", PGC_POSTMASTER, CONN_AUTH_SETTINGS, gettext_noop("Sets the host name or IP address(es) to listen to."), NULL, GUC_LIST_INPUT }, &ListenAddresses, "localhost", NULL, NULL }, { {"wal_sync_method", PGC_SIGHUP, WAL_SETTINGS, gettext_noop("Selects the method used for forcing WAL updates out to disk."), NULL }, &XLOG_sync_method, XLOG_sync_method_default, assign_xlog_sync_method, NULL }, { {"custom_variable_classes", PGC_POSTMASTER, RESOURCES_KERNEL, gettext_noop("Sets the list of known custom variable classes"), NULL, GUC_LIST_INPUT | GUC_LIST_QUOTE }, &custom_variable_classes, NULL, assign_custom_variable_classes, NULL }, { {"pgdata", PGC_POSTMASTER, FILE_LOCATIONS, gettext_noop("Sets the location of the data directory"), NULL }, &guc_pgdata, NULL, assign_canonical_path, NULL }, { {"hba_conf", PGC_SIGHUP, FILE_LOCATIONS, gettext_noop("Sets the location of the \"hba\" configuration file"), NULL }, &guc_hbafile, NULL, assign_canonical_path, NULL }, { {"ident_conf", PGC_SIGHUP, FILE_LOCATIONS, gettext_noop("Sets the location of the \"ident\" configuration file"), NULL }, &guc_identfile, NULL, assign_canonical_path, NULL }, { {"external_pidfile", PGC_POSTMASTER, FILE_LOCATIONS, gettext_noop("Writes the postmaster PID to the specified file"), NULL }, &external_pidfile, NULL, assign_canonical_path, NULL }, /* End-of-list marker */ { {NULL, 0, 0, NULL, NULL}, NULL, NULL, NULL, NULL } }; /******** end of options list ********/ /* * To allow continued support of obsolete names for GUC variables, we apply * the following mappings to any unrecognized name. Note that an old name * should be mapped to a new one only if the new variable has very similar * semantics to the old. */ static const char *const map_old_guc_names[] = { "sort_mem", "work_mem", "vacuum_mem", "maintenance_work_mem", NULL }; /* * Actual lookup of variables is done through this single, sorted array. */ static struct config_generic **guc_variables; /* Current number of variables contained in the vector */ static int num_guc_variables; /* Vector capacity */ static int size_guc_variables; static bool guc_dirty; /* TRUE if need to do commit/abort work */ static bool reporting_enabled; /* TRUE to enable GUC_REPORT */ static char *guc_string_workspace; /* for avoiding memory leaks */ static int guc_var_compare(const void *a, const void *b); static int guc_name_compare(const char *namea, const char *nameb); static void push_old_value(struct config_generic * gconf); static void ReportGUCOption(struct config_generic * record); static char *_ShowOption(struct config_generic * record); static bool check_userlimit_privilege(struct config_generic *record, GucSource source, int elevel); static bool check_userlimit_override(struct config_generic *record, GucSource source); /* * Some infrastructure for checking malloc/strdup/realloc calls */ static void * guc_malloc(int elevel, size_t size) { void *data; data = malloc(size); if (data == NULL) ereport(elevel, (errcode(ERRCODE_OUT_OF_MEMORY), errmsg("out of memory"))); return data; } static void * guc_realloc(int elevel, void *old, size_t size) { void *data; data = realloc(old, size); if (data == NULL) ereport(elevel, (errcode(ERRCODE_OUT_OF_MEMORY), errmsg("out of memory"))); return data; } static char * guc_strdup(int elevel, const char *src) { char *data; data = strdup(src); if (data == NULL) ereport(elevel, (errcode(ERRCODE_OUT_OF_MEMORY), errmsg("out of memory"))); return data; } /* * Support for assigning to a field of a string GUC item. Free the prior * value if it's not referenced anywhere else in the item (including stacked * states). */ static void set_string_field(struct config_string * conf, char **field, char *newval) { char *oldval = *field; GucStack *stack; /* Do the assignment */ *field = newval; /* Exit if any duplicate references, or if old value was NULL anyway */ if (oldval == NULL || oldval == *(conf->variable) || oldval == conf->reset_val || oldval == conf->tentative_val) return; for (stack = conf->gen.stack; stack; stack = stack->prev) { if (oldval == stack->tentative_val.stringval || oldval == stack->value.stringval) return; } /* Not used anymore, so free it */ free(oldval); } /* * Detect whether strval is referenced anywhere in a GUC string item */ static bool string_field_used(struct config_string * conf, char *strval) { GucStack *stack; if (strval == *(conf->variable) || strval == conf->reset_val || strval == conf->tentative_val) return true; for (stack = conf->gen.stack; stack; stack = stack->prev) { if (strval == stack->tentative_val.stringval || strval == stack->value.stringval) return true; } return false; } struct config_generic ** get_guc_variables(void) { return guc_variables; } /* * Build the sorted array. This is split out so that it could be * re-executed after startup (eg, we could allow loadable modules to * add vars, and then we'd need to re-sort). */ void build_guc_variables(void) { int size_vars; int num_vars = 0; struct config_generic **guc_vars; int i; for (i = 0; ConfigureNamesBool[i].gen.name; i++) { struct config_bool *conf = &ConfigureNamesBool[i]; /* Rather than requiring vartype to be filled in by hand, do this: */ conf->gen.vartype = PGC_BOOL; num_vars++; } for (i = 0; ConfigureNamesInt[i].gen.name; i++) { struct config_int *conf = &ConfigureNamesInt[i]; conf->gen.vartype = PGC_INT; num_vars++; } for (i = 0; ConfigureNamesReal[i].gen.name; i++) { struct config_real *conf = &ConfigureNamesReal[i]; conf->gen.vartype = PGC_REAL; num_vars++; } for (i = 0; ConfigureNamesString[i].gen.name; i++) { struct config_string *conf = &ConfigureNamesString[i]; conf->gen.vartype = PGC_STRING; num_vars++; } /* * Create table with 20% slack */ size_vars = num_vars + num_vars / 4; guc_vars = (struct config_generic **) guc_malloc(FATAL, size_vars * sizeof(struct config_generic *)); num_vars = 0; for (i = 0; ConfigureNamesBool[i].gen.name; i++) guc_vars[num_vars++] = &ConfigureNamesBool[i].gen; for (i = 0; ConfigureNamesInt[i].gen.name; i++) guc_vars[num_vars++] = &ConfigureNamesInt[i].gen; for (i = 0; ConfigureNamesReal[i].gen.name; i++) guc_vars[num_vars++] = &ConfigureNamesReal[i].gen; for (i = 0; ConfigureNamesString[i].gen.name; i++) guc_vars[num_vars++] = &ConfigureNamesString[i].gen; if (guc_variables) free(guc_variables); guc_variables = guc_vars; num_guc_variables = num_vars; size_guc_variables = size_vars; qsort((void *) guc_variables, num_guc_variables, sizeof(struct config_generic *), guc_var_compare); } static bool is_custom_class(const char *name, int dotPos) { /* * assign_custom_variable_classes() has made sure no empty * identifiers or whitespace exists in the variable */ bool result = false; const char *ccs = GetConfigOption("custom_variable_classes"); if (ccs != NULL) { const char *start = ccs; for (;; ++ccs) { int c = *ccs; if (c == 0 || c == ',') { if (dotPos == ccs - start && strncmp(start, name, dotPos) == 0) { result = true; break; } if (c == 0) break; start = ccs + 1; } } } return result; } /* * Add a new GUC variable to the list of known variables. The * list is expanded if needed. */ static bool add_guc_variable(struct config_generic * var, int elevel) { if (num_guc_variables + 1 >= size_guc_variables) { /* * Increase the vector by 25% */ int size_vars = size_guc_variables + size_guc_variables / 4; struct config_generic **guc_vars; if (size_vars == 0) { size_vars = 100; guc_vars = (struct config_generic **) guc_malloc(elevel, size_vars * sizeof(struct config_generic *)); } else { guc_vars = (struct config_generic **) guc_realloc(elevel, guc_variables, size_vars * sizeof(struct config_generic *)); } if (guc_vars == NULL) return false; /* out of memory */ guc_variables = guc_vars; size_guc_variables = size_vars; } guc_variables[num_guc_variables++] = var; qsort((void *) guc_variables, num_guc_variables, sizeof(struct config_generic *), guc_var_compare); return true; } /* * Create and add a placeholder variable. It's presumed to belong * to a valid custom variable class at this point. */ static struct config_string * add_placeholder_variable(const char *name, int elevel) { size_t sz = sizeof(struct config_string) + sizeof(char *); struct config_string *var; struct config_generic *gen; var = (struct config_string *) guc_malloc(elevel, sz); if (var == NULL) return NULL; gen = &var->gen; memset(var, 0, sz); gen->name = guc_strdup(elevel, name); if (gen->name == NULL) { free(var); return NULL; } gen->context = PGC_USERSET; gen->group = CUSTOM_OPTIONS; gen->short_desc = "GUC placeholder variable"; gen->flags = GUC_NO_SHOW_ALL | GUC_NOT_IN_SAMPLE | GUC_CUSTOM_PLACEHOLDER; gen->vartype = PGC_STRING; /* * The char* is allocated at the end of the struct since we have no * 'static' place to point to. */ var->variable = (char **) (var + 1); if (!add_guc_variable((struct config_generic *) var, elevel)) { free((void *) gen->name); free(var); return NULL; } return var; } /* * Look up option NAME. If it exists, return a pointer to its record, * else return NULL. */ static struct config_generic * find_option(const char *name, int elevel) { const char *dot; const char **key = &name; struct config_generic **res; int i; Assert(name); /* * By equating const char ** with struct config_generic *, we are * assuming the name field is first in config_generic. */ res = (struct config_generic **) bsearch((void *) &key, (void *) guc_variables, num_guc_variables, sizeof(struct config_generic *), guc_var_compare); if (res) return *res; /* * See if the name is an obsolete name for a variable. We assume that * the set of supported old names is short enough that a brute-force * search is the best way. */ for (i = 0; map_old_guc_names[i] != NULL; i += 2) { if (guc_name_compare(name, map_old_guc_names[i]) == 0) return find_option(map_old_guc_names[i + 1], elevel); } /* * Check if the name is qualified, and if so, check if the qualifier * maps to a custom variable class. */ dot = strchr(name, GUC_QUALIFIER_SEPARATOR); if (dot != NULL && is_custom_class(name, dot - name)) /* Add a placeholder variable for this name */ return (struct config_generic *) add_placeholder_variable(name, elevel); /* Unknown name */ return NULL; } /* * comparator for qsorting and bsearching guc_variables array */ static int guc_var_compare(const void *a, const void *b) { struct config_generic *confa = *(struct config_generic **) a; struct config_generic *confb = *(struct config_generic **) b; return guc_name_compare(confa->name, confb->name); } static int guc_name_compare(const char *namea, const char *nameb) { /* * The temptation to use strcasecmp() here must be resisted, because * the array ordering has to remain stable across setlocale() calls. * So, build our own with a simple ASCII-only downcasing. */ while (*namea && *nameb) { char cha = *namea++; char chb = *nameb++; if (cha >= 'A' && cha <= 'Z') cha += 'a' - 'A'; if (chb >= 'A' && chb <= 'Z') chb += 'a' - 'A'; if (cha != chb) return cha - chb; } if (*namea) return 1; /* a is longer */ if (*nameb) return -1; /* b is longer */ return 0; } /* * Initialize GUC options during program startup. * * Note that we cannot read the config file yet, since we have not yet * processed command-line switches. */ void InitializeGUCOptions(void) { int i; char *env; /* * Build sorted array of all GUC variables. */ build_guc_variables(); /* * Load all variables with their compiled-in defaults, and initialize * status fields as needed. */ for (i = 0; i < num_guc_variables; i++) { struct config_generic *gconf = guc_variables[i]; gconf->status = 0; gconf->reset_source = PGC_S_DEFAULT; gconf->tentative_source = PGC_S_DEFAULT; gconf->source = PGC_S_DEFAULT; gconf->stack = NULL; switch (gconf->vartype) { case PGC_BOOL: { struct config_bool *conf = (struct config_bool *) gconf; if (conf->assign_hook) if (!(*conf->assign_hook) (conf->reset_val, true, PGC_S_DEFAULT)) elog(FATAL, "failed to initialize %s to %d", conf->gen.name, (int) conf->reset_val); *conf->variable = conf->reset_val; break; } case PGC_INT: { struct config_int *conf = (struct config_int *) gconf; Assert(conf->reset_val >= conf->min); Assert(conf->reset_val <= conf->max); /* * Check to make sure we only have valid * PGC_USERLIMITs */ Assert(conf->gen.context != PGC_USERLIMIT || strcmp(conf->gen.name, "log_min_duration_statement") == 0); if (conf->assign_hook) if (!(*conf->assign_hook) (conf->reset_val, true, PGC_S_DEFAULT)) elog(FATAL, "failed to initialize %s to %d", conf->gen.name, conf->reset_val); *conf->variable = conf->reset_val; break; } case PGC_REAL: { struct config_real *conf = (struct config_real *) gconf; Assert(conf->reset_val >= conf->min); Assert(conf->reset_val <= conf->max); Assert(conf->gen.context != PGC_USERLIMIT); if (conf->assign_hook) if (!(*conf->assign_hook) (conf->reset_val, true, PGC_S_DEFAULT)) elog(FATAL, "failed to initialize %s to %g", conf->gen.name, conf->reset_val); *conf->variable = conf->reset_val; break; } case PGC_STRING: { struct config_string *conf = (struct config_string *) gconf; char *str; /* * Check to make sure we only have valid * PGC_USERLIMITs */ Assert(conf->gen.context != PGC_USERLIMIT || conf->assign_hook == assign_log_min_messages || conf->assign_hook == assign_min_error_statement || conf->assign_hook == assign_log_statement); *conf->variable = NULL; conf->reset_val = NULL; conf->tentative_val = NULL; if (conf->boot_val == NULL) { /* Cannot set value yet */ break; } str = guc_strdup(FATAL, conf->boot_val); conf->reset_val = str; if (conf->assign_hook) { const char *newstr; newstr = (*conf->assign_hook) (str, true, PGC_S_DEFAULT); if (newstr == NULL) { elog(FATAL, "failed to initialize %s to \"%s\"", conf->gen.name, str); } else if (newstr != str) { free(str); /* * See notes in set_config_option about * casting */ str = (char *) newstr; conf->reset_val = str; } } *conf->variable = str; break; } } } guc_dirty = false; reporting_enabled = false; guc_string_workspace = NULL; /* * Prevent any attempt to override the transaction modes from * non-interactive sources. */ SetConfigOption("transaction_isolation", "default", PGC_POSTMASTER, PGC_S_OVERRIDE); SetConfigOption("transaction_read_only", "no", PGC_POSTMASTER, PGC_S_OVERRIDE); /* * For historical reasons, some GUC parameters can receive defaults * from environment variables. Process those settings. */ env = getenv("PGPORT"); if (env != NULL) SetConfigOption("port", env, PGC_POSTMASTER, PGC_S_ENV_VAR); env = getenv("PGDATESTYLE"); if (env != NULL) SetConfigOption("datestyle", env, PGC_POSTMASTER, PGC_S_ENV_VAR); env = getenv("PGCLIENTENCODING"); if (env != NULL) SetConfigOption("client_encoding", env, PGC_POSTMASTER, PGC_S_ENV_VAR); } /* * Select the configuration files and data directory to be used, and * do the initial read of postgresql.conf. * * This is called after processing command-line switches. * userDoption is the -D switch value if any (NULL if unspecified). * progname is just for use in error messages. * * Returns true on success; on failure, prints a suitable error message * to stderr and returns false. */ bool SelectConfigFiles(const char *userDoption, const char *progname) { char *Doption; struct stat stat_buf; /* If user did not specify -D, it defaults to $PGDATA */ if (!userDoption) userDoption = getenv("PGDATA"); /* If no PGDATA either, we are completely lost */ if (!userDoption) { write_stderr("%s does not know where to find the database system data.\n" "You must specify the -D invocation option or set the " "PGDATA environment variable.\n", progname); return false; } /* Get a writable copy and canonicalize the path */ Doption = guc_strdup(FATAL, userDoption); canonicalize_path(Doption); /* * If it is a directory, point ConfigDir to it, and expect to * find postgresql.conf within. Otherwise it had better be * the actual config file, and the file had better set "pgdata". */ if (stat(Doption, &stat_buf) == 0 && S_ISDIR(stat_buf.st_mode)) { ConfigDir = Doption; ConfigFileName = guc_malloc(FATAL, strlen(ConfigDir) + strlen(CONFIG_FILENAME) + 2); sprintf(ConfigFileName, "%s/%s", ConfigDir, CONFIG_FILENAME); } else { ConfigFileName = Doption; } if (stat(ConfigFileName, &stat_buf) != 0) { write_stderr("%s cannot access the data directory or configuration file \"%s\": %s\n", progname, ConfigFileName, strerror(errno)); return false; } ProcessConfigFile(PGC_POSTMASTER); /* * If the config file specified pgdata, use that as DataDir; * otherwise use ConfigDir (the original Doption) if set; * else punt. * * Note: SetDataDir will copy and canonicalize its argument, * so we don't have to. */ if (guc_pgdata) SetDataDir(guc_pgdata); else if (ConfigDir) SetDataDir(ConfigDir); else { write_stderr("%s does not know where to find the database system data.\n" "This should be specified as \"pgdata\" in \"%s\".\n", progname, ConfigFileName); return false; } /* * Set ConfigDir as DataDir unless we had another value (which is to say, * Doption pointed to a directory). This determines the default location * of secondary configuration files that will be read later. */ if (!ConfigDir) ConfigDir = DataDir; /* If timezone is not set, determine what the OS uses */ pg_timezone_initialize(); return true; } /* * Reset all options to their saved default values (implements RESET ALL) */ void ResetAllOptions(void) { int i; for (i = 0; i < num_guc_variables; i++) { struct config_generic *gconf = guc_variables[i]; /* Don't reset non-SET-able values */ if (gconf->context != PGC_SUSET && gconf->context != PGC_USERLIMIT && gconf->context != PGC_USERSET) continue; /* Don't reset if special exclusion from RESET ALL */ if (gconf->flags & GUC_NO_RESET_ALL) continue; /* No need to reset if wasn't SET */ if (gconf->source <= PGC_S_OVERRIDE) continue; /* Save old value to support transaction abort */ push_old_value(gconf); switch (gconf->vartype) { case PGC_BOOL: { struct config_bool *conf = (struct config_bool *) gconf; if (conf->assign_hook) if (!(*conf->assign_hook) (conf->reset_val, true, PGC_S_SESSION)) elog(ERROR, "failed to reset %s", conf->gen.name); *conf->variable = conf->reset_val; conf->tentative_val = conf->reset_val; conf->gen.source = conf->gen.reset_source; conf->gen.tentative_source = conf->gen.reset_source; conf->gen.status |= GUC_HAVE_TENTATIVE; guc_dirty = true; break; } case PGC_INT: { struct config_int *conf = (struct config_int *) gconf; if (conf->assign_hook) if (!(*conf->assign_hook) (conf->reset_val, true, PGC_S_SESSION)) elog(ERROR, "failed to reset %s", conf->gen.name); *conf->variable = conf->reset_val; conf->tentative_val = conf->reset_val; conf->gen.source = conf->gen.reset_source; conf->gen.tentative_source = conf->gen.reset_source; conf->gen.status |= GUC_HAVE_TENTATIVE; guc_dirty = true; break; } case PGC_REAL: { struct config_real *conf = (struct config_real *) gconf; if (conf->assign_hook) if (!(*conf->assign_hook) (conf->reset_val, true, PGC_S_SESSION)) elog(ERROR, "failed to reset %s", conf->gen.name); *conf->variable = conf->reset_val; conf->tentative_val = conf->reset_val; conf->gen.source = conf->gen.reset_source; conf->gen.tentative_source = conf->gen.reset_source; conf->gen.status |= GUC_HAVE_TENTATIVE; guc_dirty = true; break; } case PGC_STRING: { struct config_string *conf = (struct config_string *) gconf; char *str; if (conf->reset_val == NULL) { /* Nothing to reset to, as yet; so do nothing */ break; } /* We need not strdup here */ str = conf->reset_val; if (conf->assign_hook) { const char *newstr; newstr = (*conf->assign_hook) (str, true, PGC_S_SESSION); if (newstr == NULL) elog(ERROR, "failed to reset %s", conf->gen.name); else if (newstr != str) { /* * See notes in set_config_option about * casting */ str = (char *) newstr; } } set_string_field(conf, conf->variable, str); set_string_field(conf, &conf->tentative_val, str); conf->gen.source = conf->gen.reset_source; conf->gen.tentative_source = conf->gen.reset_source; conf->gen.status |= GUC_HAVE_TENTATIVE; guc_dirty = true; break; } } if (gconf->flags & GUC_REPORT) ReportGUCOption(gconf); } } /* * push_old_value * Push previous state during first assignment to a GUC variable * within a particular transaction. * * We have to be willing to "back-fill" the state stack if the first * assignment occurs within a subtransaction nested several levels deep. * This ensures that if an intermediate transaction aborts, it will have * the proper value available to restore the setting to. */ static void push_old_value(struct config_generic * gconf) { int my_level = GetCurrentTransactionNestLevel(); GucStack *stack; /* If we're not inside a transaction, do nothing */ if (my_level == 0) return; for (;;) { /* Done if we already pushed it at this nesting depth */ if (gconf->stack && gconf->stack->nest_level >= my_level) return; /* * We keep all the stack entries in TopTransactionContext so as to * avoid allocation problems when a subtransaction back-fills * stack entries for upper transaction levels. */ stack = (GucStack *) MemoryContextAlloc(TopTransactionContext, sizeof(GucStack)); stack->prev = gconf->stack; stack->nest_level = stack->prev ? stack->prev->nest_level + 1 : 1; stack->status = gconf->status; stack->tentative_source = gconf->tentative_source; stack->source = gconf->source; switch (gconf->vartype) { case PGC_BOOL: stack->tentative_val.boolval = ((struct config_bool *) gconf)->tentative_val; stack->value.boolval = *((struct config_bool *) gconf)->variable; break; case PGC_INT: stack->tentative_val.intval = ((struct config_int *) gconf)->tentative_val; stack->value.intval = *((struct config_int *) gconf)->variable; break; case PGC_REAL: stack->tentative_val.realval = ((struct config_real *) gconf)->tentative_val; stack->value.realval = *((struct config_real *) gconf)->variable; break; case PGC_STRING: stack->tentative_val.stringval = ((struct config_string *) gconf)->tentative_val; stack->value.stringval = *((struct config_string *) gconf)->variable; break; } gconf->stack = stack; /* Set state to indicate nothing happened yet within this level */ gconf->status = GUC_HAVE_STACK; /* Ensure we remember to pop at end of xact */ guc_dirty = true; } } /* * Do GUC processing at transaction or subtransaction commit or abort. */ void AtEOXact_GUC(bool isCommit, bool isSubXact) { int my_level; int i; /* Quick exit if nothing's changed in this transaction */ if (!guc_dirty) return; /* Prevent memory leak if ereport during an assign_hook */ if (guc_string_workspace) { free(guc_string_workspace); guc_string_workspace = NULL; } my_level = GetCurrentTransactionNestLevel(); Assert(isSubXact ? (my_level > 1) : (my_level == 1)); for (i = 0; i < num_guc_variables; i++) { struct config_generic *gconf = guc_variables[i]; int my_status = gconf->status; GucStack *stack = gconf->stack; bool useTentative; bool changed; /* * Skip if nothing's happened to this var in this transaction */ if (my_status == 0) { Assert(stack == NULL); continue; } /* Assert that we stacked old value before changing it */ Assert(stack != NULL && (my_status & GUC_HAVE_STACK)); /* However, the last change may have been at an outer xact level */ if (stack->nest_level < my_level) continue; Assert(stack->nest_level == my_level); /* * We will pop the stack entry. Start by restoring outer xact * status (since we may want to modify it below). Be careful to * use my_status to reference the inner xact status below this * point... */ gconf->status = stack->status; /* * We have two cases: * * If commit and HAVE_TENTATIVE, set actual value to tentative (this * is to override a SET LOCAL if one occurred later than SET). We * keep the tentative value and propagate HAVE_TENTATIVE to the * parent status, allowing the SET's effect to percolate up. (But * if we're exiting the outermost transaction, we'll drop the * HAVE_TENTATIVE bit below.) * * Otherwise, we have a transaction that aborted or executed only SET * LOCAL (or no SET at all). In either case it should have no * further effect, so restore both tentative and actual values * from the stack entry. */ useTentative = isCommit && (my_status & GUC_HAVE_TENTATIVE) != 0; changed = false; switch (gconf->vartype) { case PGC_BOOL: { struct config_bool *conf = (struct config_bool *) gconf; bool newval; GucSource newsource; if (useTentative) { newval = conf->tentative_val; newsource = conf->gen.tentative_source; conf->gen.status |= GUC_HAVE_TENTATIVE; } else { newval = stack->value.boolval; newsource = stack->source; conf->tentative_val = stack->tentative_val.boolval; conf->gen.tentative_source = stack->tentative_source; } if (*conf->variable != newval) { if (conf->assign_hook) if (!(*conf->assign_hook) (newval, true, PGC_S_OVERRIDE)) elog(LOG, "failed to commit %s", conf->gen.name); *conf->variable = newval; changed = true; } conf->gen.source = newsource; break; } case PGC_INT: { struct config_int *conf = (struct config_int *) gconf; int newval; GucSource newsource; if (useTentative) { newval = conf->tentative_val; newsource = conf->gen.tentative_source; conf->gen.status |= GUC_HAVE_TENTATIVE; } else { newval = stack->value.intval; newsource = stack->source; conf->tentative_val = stack->tentative_val.intval; conf->gen.tentative_source = stack->tentative_source; } if (*conf->variable != newval) { if (conf->assign_hook) if (!(*conf->assign_hook) (newval, true, PGC_S_OVERRIDE)) elog(LOG, "failed to commit %s", conf->gen.name); *conf->variable = newval; changed = true; } conf->gen.source = newsource; break; } case PGC_REAL: { struct config_real *conf = (struct config_real *) gconf; double newval; GucSource newsource; if (useTentative) { newval = conf->tentative_val; newsource = conf->gen.tentative_source; conf->gen.status |= GUC_HAVE_TENTATIVE; } else { newval = stack->value.realval; newsource = stack->source; conf->tentative_val = stack->tentative_val.realval; conf->gen.tentative_source = stack->tentative_source; } if (*conf->variable != newval) { if (conf->assign_hook) if (!(*conf->assign_hook) (newval, true, PGC_S_OVERRIDE)) elog(LOG, "failed to commit %s", conf->gen.name); *conf->variable = newval; changed = true; } conf->gen.source = newsource; break; } case PGC_STRING: { struct config_string *conf = (struct config_string *) gconf; char *newval; GucSource newsource; if (useTentative) { newval = conf->tentative_val; newsource = conf->gen.tentative_source; conf->gen.status |= GUC_HAVE_TENTATIVE; } else { newval = stack->value.stringval; newsource = stack->source; set_string_field(conf, &conf->tentative_val, stack->tentative_val.stringval); conf->gen.tentative_source = stack->tentative_source; } if (*conf->variable != newval) { if (conf->assign_hook) { const char *newstr; newstr = (*conf->assign_hook) (newval, true, PGC_S_OVERRIDE); if (newstr == NULL) elog(LOG, "failed to commit %s", conf->gen.name); else if (newstr != newval) { /* * If newval should now be freed, it'll be * taken care of below. * * See notes in set_config_option about * casting */ newval = (char *) newstr; } } set_string_field(conf, conf->variable, newval); changed = true; } conf->gen.source = newsource; /* Release stacked values if not used anymore */ set_string_field(conf, &stack->value.stringval, NULL); set_string_field(conf, &stack->tentative_val.stringval, NULL); /* Don't store tentative value separately after commit */ if (!isSubXact) set_string_field(conf, &conf->tentative_val, NULL); break; } } /* Finish popping the state stack */ gconf->stack = stack->prev; pfree(stack); /* * If we're now out of all xact levels, forget TENTATIVE status * bit; there's nothing tentative about the value anymore. */ if (!isSubXact) { Assert(gconf->stack == NULL); gconf->status = 0; } /* Report new value if we changed it */ if (changed && (gconf->flags & GUC_REPORT)) ReportGUCOption(gconf); } /* * If we're now out of all xact levels, we can clear guc_dirty. (Note: * we cannot reset guc_dirty when exiting a subtransaction, because we * know that all outer transaction levels will have stacked values to * deal with.) */ if (!isSubXact) guc_dirty = false; } /* * Start up automatic reporting of changes to variables marked GUC_REPORT. * This is executed at completion of backend startup. */ void BeginReportingGUCOptions(void) { int i; /* * Don't do anything unless talking to an interactive frontend of * protocol 3.0 or later. */ if (whereToSendOutput != Remote || PG_PROTOCOL_MAJOR(FrontendProtocol) < 3) return; reporting_enabled = true; /* Transmit initial values of interesting variables */ for (i = 0; i < num_guc_variables; i++) { struct config_generic *conf = guc_variables[i]; if (conf->flags & GUC_REPORT) ReportGUCOption(conf); } } /* * ReportGUCOption: if appropriate, transmit option value to frontend */ static void ReportGUCOption(struct config_generic * record) { if (reporting_enabled && (record->flags & GUC_REPORT)) { char *val = _ShowOption(record); StringInfoData msgbuf; pq_beginmessage(&msgbuf, 'S'); pq_sendstring(&msgbuf, record->name); pq_sendstring(&msgbuf, val); pq_endmessage(&msgbuf); pfree(val); } } /* * Try to interpret value as boolean value. Valid values are: true, * false, yes, no, on, off, 1, 0. If the string parses okay, return * true, else false. If result is not NULL, return the parsing result * there. */ static bool parse_bool(const char *value, bool *result) { size_t len = strlen(value); if (pg_strncasecmp(value, "true", len) == 0) { if (result) *result = true; } else if (pg_strncasecmp(value, "false", len) == 0) { if (result) *result = false; } else if (pg_strncasecmp(value, "yes", len) == 0) { if (result) *result = true; } else if (pg_strncasecmp(value, "no", len) == 0) { if (result) *result = false; } else if (pg_strcasecmp(value, "on") == 0) { if (result) *result = true; } else if (pg_strcasecmp(value, "off") == 0) { if (result) *result = false; } else if (pg_strcasecmp(value, "1") == 0) { if (result) *result = true; } else if (pg_strcasecmp(value, "0") == 0) { if (result) *result = false; } else return false; return true; } /* * Try to parse value as an integer. The accepted formats are the * usual decimal, octal, or hexadecimal formats. If the string parses * okay, return true, else false. If result is not NULL, return the * value there. */ static bool parse_int(const char *value, int *result) { long val; char *endptr; errno = 0; val = strtol(value, &endptr, 0); if (endptr == value || *endptr != '\0' || errno == ERANGE #ifdef HAVE_LONG_INT_64 /* if long > 32 bits, check for overflow of int4 */ || val != (long) ((int32) val) #endif ) return false; if (result) *result = (int) val; return true; } /* * Try to parse value as a floating point constant in the usual * format. If the value parsed okay return true, else false. If * result is not NULL, return the semantic value there. */ static bool parse_real(const char *value, double *result) { double val; char *endptr; errno = 0; val = strtod(value, &endptr); if (endptr == value || *endptr != '\0' || errno == ERANGE) return false; if (result) *result = val; return true; } /* * Sets option `name' to given value. The value should be a string * which is going to be parsed and converted to the appropriate data * type. The context and source parameters indicate in which context this * function is being called so it can apply the access restrictions * properly. * * If value is NULL, set the option to its default value. If the * parameter changeVal is false then don't really set the option but do all * the checks to see if it would work. * * If there is an error (non-existing option, invalid value) then an * ereport(ERROR) is thrown *unless* this is called in a context where we * don't want to ereport (currently, startup or SIGHUP config file reread). * In that case we write a suitable error message via ereport(DEBUG) and * return false. This is working around the deficiencies in the ereport * mechanism, so don't blame me. In all other cases, the function * returns true, including cases where the input is valid but we chose * not to apply it because of context or source-priority considerations. * * See also SetConfigOption for an external interface. */ bool set_config_option(const char *name, const char *value, GucContext context, GucSource source, bool isLocal, bool changeVal) { struct config_generic *record; int elevel; bool makeDefault, changeValOrig = changeVal; if (context == PGC_SIGHUP || source == PGC_S_DEFAULT) { /* * To avoid cluttering the log, only the postmaster bleats loudly * about problems with the config file. */ elevel = IsUnderPostmaster ? DEBUG2 : LOG; } else if (source == PGC_S_DATABASE || source == PGC_S_USER) elevel = INFO; else elevel = ERROR; record = find_option(name, elevel); if (record == NULL) { ereport(elevel, (errcode(ERRCODE_UNDEFINED_OBJECT), errmsg("unrecognized configuration parameter \"%s\"", name))); return false; } /* * Check if the option can be set at this time. See guc.h for the * precise rules. Note that we don't want to throw errors if we're in * the SIGHUP context. In that case we just ignore the attempt and * return true. */ switch (record->context) { case PGC_INTERNAL: if (context == PGC_SIGHUP) return true; if (context != PGC_INTERNAL) { ereport(elevel, (errcode(ERRCODE_CANT_CHANGE_RUNTIME_PARAM), errmsg("parameter \"%s\" cannot be changed", name))); return false; } break; case PGC_POSTMASTER: if (context == PGC_SIGHUP) return true; if (context != PGC_POSTMASTER) { ereport(elevel, (errcode(ERRCODE_CANT_CHANGE_RUNTIME_PARAM), errmsg("parameter \"%s\" cannot be changed after server start", name))); return false; } break; case PGC_SIGHUP: if (context != PGC_SIGHUP && context != PGC_POSTMASTER) { ereport(elevel, (errcode(ERRCODE_CANT_CHANGE_RUNTIME_PARAM), errmsg("parameter \"%s\" cannot be changed now", name))); return false; } /* * Hmm, the idea of the SIGHUP context is "ought to be global, * but can be changed after postmaster start". But there's * nothing that prevents a crafty administrator from sending * SIGHUP signals to individual backends only. */ break; case PGC_BACKEND: if (context == PGC_SIGHUP) { /* * If a PGC_BACKEND parameter is changed in the config * file, we want to accept the new value in the postmaster * (whence it will propagate to subsequently-started * backends), but ignore it in existing backends. This is * a tad klugy, but necessary because we don't re-read the * config file during backend start. */ if (IsUnderPostmaster) return true; } else if (context != PGC_BACKEND && context != PGC_POSTMASTER) { ereport(elevel, (errcode(ERRCODE_CANT_CHANGE_RUNTIME_PARAM), errmsg("parameter \"%s\" cannot be set after connection start", name))); return false; } break; case PGC_SUSET: if (context == PGC_USERSET || context == PGC_BACKEND) { ereport(elevel, (errcode(ERRCODE_INSUFFICIENT_PRIVILEGE), errmsg("permission denied to set parameter \"%s\"", name))); return false; } break; case PGC_USERLIMIT: /* USERLIMIT permissions checked below */ break; case PGC_USERSET: /* always okay */ break; } /* * Should we set reset/stacked values? (If so, the behavior is not * transactional.) */ makeDefault = changeVal && (source <= PGC_S_OVERRIDE) && (value != NULL); /* * Ignore attempted set if overridden by previously processed setting. * However, if changeVal is false then plow ahead anyway since we are * trying to find out if the value is potentially good, not actually * use it. Also keep going if makeDefault is true, since we may want * to set the reset/stacked values even if we can't set the variable * itself. */ if (record->source > source) { if (changeVal && !makeDefault) { elog(DEBUG3, "\"%s\": setting ignored because previous source is higher priority", name); return true; } changeVal = false; /* this might be reset in USERLIMIT */ } /* * Evaluate value and set variable. USERLIMIT checks two things: 1) * is the user making a change that is blocked by an administrator * setting. 2) is the administrator changing a setting and doing a * SIGHUP that requires us to override a user setting. */ switch (record->vartype) { case PGC_BOOL: { struct config_bool *conf = (struct config_bool *) record; bool newval; if (value) { if (!parse_bool(value, &newval)) { ereport(elevel, (errcode(ERRCODE_INVALID_PARAMETER_VALUE), errmsg("parameter \"%s\" requires a Boolean value", name))); return false; } if (record->context == PGC_USERLIMIT) { if (newval < conf->reset_val) { /* Limit non-superuser changes */ if (!check_userlimit_privilege(record, source, elevel)) return false; } if (newval > *conf->variable) { /* Allow change if admin should override */ if (check_userlimit_override(record, source)) changeVal = changeValOrig; } } } else { newval = conf->reset_val; source = conf->gen.reset_source; } if (conf->assign_hook) if (!(*conf->assign_hook) (newval, changeVal, source)) { ereport(elevel, (errcode(ERRCODE_INVALID_PARAMETER_VALUE), errmsg("invalid value for parameter \"%s\": %d", name, (int) newval))); return false; } if (changeVal || makeDefault) { /* Save old value to support transaction abort */ if (!makeDefault) push_old_value(&conf->gen); if (changeVal) { *conf->variable = newval; conf->gen.source = source; } if (makeDefault) { GucStack *stack; if (conf->gen.reset_source <= source) { conf->reset_val = newval; conf->gen.reset_source = source; } for (stack = conf->gen.stack; stack; stack = stack->prev) { if (stack->source <= source) { stack->value.boolval = newval; stack->source = source; } } } else if (isLocal) { conf->gen.status |= GUC_HAVE_LOCAL; guc_dirty = true; } else { conf->tentative_val = newval; conf->gen.tentative_source = source; conf->gen.status |= GUC_HAVE_TENTATIVE; guc_dirty = true; } } break; } case PGC_INT: { struct config_int *conf = (struct config_int *) record; int newval; if (value) { if (!parse_int(value, &newval)) { ereport(elevel, (errcode(ERRCODE_INVALID_PARAMETER_VALUE), errmsg("parameter \"%s\" requires an integer value", name))); return false; } if (newval < conf->min || newval > conf->max) { ereport(elevel, (errcode(ERRCODE_INVALID_PARAMETER_VALUE), errmsg("%d is outside the valid range for parameter \"%s\" (%d .. %d)", newval, name, conf->min, conf->max))); return false; } if (record->context == PGC_USERLIMIT) { /* * handle log_min_duration_statement: if it's enabled * then either turning it off or increasing it * requires privileges. */ if (conf->reset_val != -1 && (newval == -1 || newval > conf->reset_val)) { /* Limit non-superuser changes */ if (!check_userlimit_privilege(record, source, elevel)) return false; } /* Admin override includes turning on or decreasing */ if (newval != -1 && (*conf->variable == -1 || newval < *conf->variable)) { /* Allow change if admin should override */ if (check_userlimit_override(record, source)) changeVal = changeValOrig; } } } else { newval = conf->reset_val; source = conf->gen.reset_source; } if (conf->assign_hook) if (!(*conf->assign_hook) (newval, changeVal, source)) { ereport(elevel, (errcode(ERRCODE_INVALID_PARAMETER_VALUE), errmsg("invalid value for parameter \"%s\": %d", name, newval))); return false; } if (changeVal || makeDefault) { /* Save old value to support transaction abort */ if (!makeDefault) push_old_value(&conf->gen); if (changeVal) { *conf->variable = newval; conf->gen.source = source; } if (makeDefault) { GucStack *stack; if (conf->gen.reset_source <= source) { conf->reset_val = newval; conf->gen.reset_source = source; } for (stack = conf->gen.stack; stack; stack = stack->prev) { if (stack->source <= source) { stack->value.intval = newval; stack->source = source; } } } else if (isLocal) { conf->gen.status |= GUC_HAVE_LOCAL; guc_dirty = true; } else { conf->tentative_val = newval; conf->gen.tentative_source = source; conf->gen.status |= GUC_HAVE_TENTATIVE; guc_dirty = true; } } break; } case PGC_REAL: { struct config_real *conf = (struct config_real *) record; double newval; if (value) { if (!parse_real(value, &newval)) { ereport(elevel, (errcode(ERRCODE_INVALID_PARAMETER_VALUE), errmsg("parameter \"%s\" requires a numeric value", name))); return false; } if (newval < conf->min || newval > conf->max) { ereport(elevel, (errcode(ERRCODE_INVALID_PARAMETER_VALUE), errmsg("%g is outside the valid range for parameter \"%s\" (%g .. %g)", newval, name, conf->min, conf->max))); return false; } if (record->context == PGC_USERLIMIT) { /* No REAL PGC_USERLIMIT at present */ if (newval < conf->reset_val) { /* Limit non-superuser changes */ if (!check_userlimit_privilege(record, source, elevel)) return false; } if (newval > *conf->variable) { /* Allow change if admin should override */ if (check_userlimit_override(record, source)) changeVal = changeValOrig; } } } else { newval = conf->reset_val; source = conf->gen.reset_source; } if (conf->assign_hook) if (!(*conf->assign_hook) (newval, changeVal, source)) { ereport(elevel, (errcode(ERRCODE_INVALID_PARAMETER_VALUE), errmsg("invalid value for parameter \"%s\": %g", name, newval))); return false; } if (changeVal || makeDefault) { /* Save old value to support transaction abort */ if (!makeDefault) push_old_value(&conf->gen); if (changeVal) { *conf->variable = newval; conf->gen.source = source; } if (makeDefault) { GucStack *stack; if (conf->gen.reset_source <= source) { conf->reset_val = newval; conf->gen.reset_source = source; } for (stack = conf->gen.stack; stack; stack = stack->prev) { if (stack->source <= source) { stack->value.realval = newval; stack->source = source; } } } else if (isLocal) { conf->gen.status |= GUC_HAVE_LOCAL; guc_dirty = true; } else { conf->tentative_val = newval; conf->gen.tentative_source = source; conf->gen.status |= GUC_HAVE_TENTATIVE; guc_dirty = true; } } break; } case PGC_STRING: { struct config_string *conf = (struct config_string *) record; char *newval; if (value) { newval = guc_strdup(elevel, value); if (newval == NULL) return false; if (record->context == PGC_USERLIMIT) { int var_value, reset_value, new_value; const char *(*var_hook) (int *var, const char *newval, bool doit, GucSource source); if (conf->assign_hook == assign_log_statement) var_hook = assign_log_stmtlvl; else var_hook = assign_msglvl; (*var_hook) (&new_value, newval, true, source); (*var_hook) (&reset_value, conf->reset_val, true, source); (*var_hook) (&var_value, *conf->variable, true, source); if (new_value > reset_value) { /* Limit non-superuser changes */ if (!check_userlimit_privilege(record, source, elevel)) return false; } if (new_value < var_value) { /* Allow change if admin should override */ if (check_userlimit_override(record, source)) changeVal = changeValOrig; } } } else if (conf->reset_val) { /* * We could possibly avoid strdup here, but easier to * make this case work the same as the normal * assignment case. */ newval = guc_strdup(elevel, conf->reset_val); if (newval == NULL) return false; source = conf->gen.reset_source; } else { /* Nothing to reset to, as yet; so do nothing */ break; } /* * Remember string in workspace, so that we can free it * and avoid a permanent memory leak if hook ereports. */ if (guc_string_workspace) free(guc_string_workspace); guc_string_workspace = newval; if (conf->assign_hook) { const char *hookresult; hookresult = (*conf->assign_hook) (newval, changeVal, source); guc_string_workspace = NULL; if (hookresult == NULL) { free(newval); ereport(elevel, (errcode(ERRCODE_INVALID_PARAMETER_VALUE), errmsg("invalid value for parameter \"%s\": \"%s\"", name, value ? value : ""))); return false; } else if (hookresult != newval) { free(newval); /* * Having to cast away const here is annoying, but * the alternative is to declare assign_hooks as * returning char*, which would mean they'd have * to cast away const, or as both taking and * returning char*, which doesn't seem attractive * either --- we don't want them to scribble on * the passed str. */ newval = (char *) hookresult; } } guc_string_workspace = NULL; if (changeVal || makeDefault) { /* Save old value to support transaction abort */ if (!makeDefault) push_old_value(&conf->gen); if (changeVal) { set_string_field(conf, conf->variable, newval); conf->gen.source = source; } if (makeDefault) { GucStack *stack; if (conf->gen.reset_source <= source) { set_string_field(conf, &conf->reset_val, newval); conf->gen.reset_source = source; } for (stack = conf->gen.stack; stack; stack = stack->prev) { if (stack->source <= source) { set_string_field(conf, &stack->value.stringval, newval); stack->source = source; } } /* Perhaps we didn't install newval anywhere */ if (!string_field_used(conf, newval)) free(newval); } else if (isLocal) { conf->gen.status |= GUC_HAVE_LOCAL; guc_dirty = true; } else { set_string_field(conf, &conf->tentative_val, newval); conf->gen.tentative_source = source; conf->gen.status |= GUC_HAVE_TENTATIVE; guc_dirty = true; } } else free(newval); break; } } if (changeVal && (record->flags & GUC_REPORT)) ReportGUCOption(record); return true; } /* * Check whether we should allow a USERLIMIT parameter to be set * * This is invoked only when the desired new setting is "less" than the * old and so appropriate privileges are needed. If the setting should * be disallowed, either throw an error (in interactive case) or return false. */ static bool check_userlimit_privilege(struct config_generic *record, GucSource source, int elevel) { /* Allow if trusted source (e.g., config file) */ if (source < PGC_S_UNPRIVILEGED) return true; /* * Allow if superuser. We can only check this inside a transaction, * though, so assume not-superuser otherwise. (In practice this means * that settings coming from PGOPTIONS will be treated as non-superuser) */ if (IsTransactionState() && superuser()) return true; ereport(elevel, (errcode(ERRCODE_INSUFFICIENT_PRIVILEGE), errmsg("permission denied to set parameter \"%s\"", record->name), (record->vartype == PGC_BOOL) ? errhint("Must be superuser to change this value to false.") : ((record->vartype == PGC_INT) ? errhint("Must be superuser to increase this value or turn it off.") : errhint("Must be superuser to increase this value.")))); return false; } /* * Check whether we should allow a USERLIMIT parameter to be overridden * * This is invoked when the desired new setting is "greater" than the * old; if the old setting was unprivileged and the new one is privileged, * we should apply it, even though the normal rule would be not to. */ static bool check_userlimit_override(struct config_generic *record, GucSource source) { /* Unprivileged source never gets to override this way */ if (source > PGC_S_UNPRIVILEGED) return false; /* If existing setting is from privileged source, keep it */ if (record->source < PGC_S_UNPRIVILEGED) return false; /* * If user is a superuser, he gets to keep his setting. We can't check * this unless inside a transaction, though. XXX in practice that * restriction means this code is essentially worthless, because the * result will depend on whether we happen to be inside a transaction * block when SIGHUP arrives. Dike out until we can think of something * that actually works. */ #ifdef NOT_USED if (IsTransactionState() && superuser()) return false; #endif /* Otherwise override */ return true; } /* * Set a config option to the given value. See also set_config_option, * this is just the wrapper to be called from outside GUC. NB: this * is used only for non-transactional operations. */ void SetConfigOption(const char *name, const char *value, GucContext context, GucSource source) { (void) set_config_option(name, value, context, source, false, true); } /* * Fetch the current value of the option `name'. If the option doesn't exist, * throw an ereport and don't return. * * The string is *not* allocated for modification and is really only * valid until the next call to configuration related functions. */ const char * GetConfigOption(const char *name) { struct config_generic *record; static char buffer[256]; record = find_option(name, ERROR); if (record == NULL) ereport(ERROR, (errcode(ERRCODE_UNDEFINED_OBJECT), errmsg("unrecognized configuration parameter \"%s\"", name))); switch (record->vartype) { case PGC_BOOL: return *((struct config_bool *) record)->variable ? "on" : "off"; case PGC_INT: snprintf(buffer, sizeof(buffer), "%d", *((struct config_int *) record)->variable); return buffer; case PGC_REAL: snprintf(buffer, sizeof(buffer), "%g", *((struct config_real *) record)->variable); return buffer; case PGC_STRING: return *((struct config_string *) record)->variable; } return NULL; } /* * Get the RESET value associated with the given option. */ const char * GetConfigOptionResetString(const char *name) { struct config_generic *record; static char buffer[256]; record = find_option(name, ERROR); if (record == NULL) ereport(ERROR, (errcode(ERRCODE_UNDEFINED_OBJECT), errmsg("unrecognized configuration parameter \"%s\"", name))); switch (record->vartype) { case PGC_BOOL: return ((struct config_bool *) record)->reset_val ? "on" : "off"; case PGC_INT: snprintf(buffer, sizeof(buffer), "%d", ((struct config_int *) record)->reset_val); return buffer; case PGC_REAL: snprintf(buffer, sizeof(buffer), "%g", ((struct config_real *) record)->reset_val); return buffer; case PGC_STRING: return ((struct config_string *) record)->reset_val; } return NULL; } /* * flatten_set_variable_args * Given a parsenode List as emitted by the grammar for SET, * convert to the flat string representation used by GUC. * * We need to be told the name of the variable the args are for, because * the flattening rules vary (ugh). * * The result is NULL if input is NIL (ie, SET ... TO DEFAULT), otherwise * a palloc'd string. */ char * flatten_set_variable_args(const char *name, List *args) { struct config_generic *record; int flags; StringInfoData buf; ListCell *l; /* * Fast path if just DEFAULT. We do not check the variable name in * this case --- necessary for RESET ALL to work correctly. */ if (args == NIL) return NULL; /* Else get flags for the variable */ record = find_option(name, ERROR); if (record == NULL) ereport(ERROR, (errcode(ERRCODE_UNDEFINED_OBJECT), errmsg("unrecognized configuration parameter \"%s\"", name))); flags = record->flags; /* Complain if list input and non-list variable */ if ((flags & GUC_LIST_INPUT) == 0 && list_length(args) != 1) ereport(ERROR, (errcode(ERRCODE_INVALID_PARAMETER_VALUE), errmsg("SET %s takes only one argument", name))); initStringInfo(&buf); foreach(l, args) { A_Const *arg = (A_Const *) lfirst(l); char *val; if (l != list_head(args)) appendStringInfo(&buf, ", "); if (!IsA(arg, A_Const)) elog(ERROR, "unrecognized node type: %d", (int) nodeTag(arg)); switch (nodeTag(&arg->val)) { case T_Integer: appendStringInfo(&buf, "%ld", intVal(&arg->val)); break; case T_Float: /* represented as a string, so just copy it */ appendStringInfoString(&buf, strVal(&arg->val)); break; case T_String: val = strVal(&arg->val); if (arg->typename != NULL) { /* * Must be a ConstInterval argument for TIME ZONE. * Coerce to interval and back to normalize the value * and account for any typmod. */ Datum interval; char *intervalout; interval = DirectFunctionCall3(interval_in, CStringGetDatum(val), ObjectIdGetDatum(InvalidOid), Int32GetDatum(arg->typename->typmod)); intervalout = DatumGetCString(DirectFunctionCall3(interval_out, interval, ObjectIdGetDatum(InvalidOid), Int32GetDatum(-1))); appendStringInfo(&buf, "INTERVAL '%s'", intervalout); } else { /* * Plain string literal or identifier. For quote * mode, quote it if it's not a vanilla identifier. */ if (flags & GUC_LIST_QUOTE) appendStringInfoString(&buf, quote_identifier(val)); else appendStringInfoString(&buf, val); } break; default: elog(ERROR, "unrecognized node type: %d", (int) nodeTag(&arg->val)); break; } } return buf.data; } /* * SET command */ void SetPGVariable(const char *name, List *args, bool is_local) { char *argstring = flatten_set_variable_args(name, args); /* Note SET DEFAULT (argstring == NULL) is equivalent to RESET */ set_config_option(name, argstring, (superuser() ? PGC_SUSET : PGC_USERSET), PGC_S_SESSION, is_local, true); } /* * SET command wrapped as a SQL callable function. */ Datum set_config_by_name(PG_FUNCTION_ARGS) { char *name; char *value; char *new_value; bool is_local; text *result_text; if (PG_ARGISNULL(0)) ereport(ERROR, (errcode(ERRCODE_NULL_VALUE_NOT_ALLOWED), errmsg("SET requires parameter name"))); /* Get the GUC variable name */ name = DatumGetCString(DirectFunctionCall1(textout, PG_GETARG_DATUM(0))); /* Get the desired value or set to NULL for a reset request */ if (PG_ARGISNULL(1)) value = NULL; else value = DatumGetCString(DirectFunctionCall1(textout, PG_GETARG_DATUM(1))); /* * Get the desired state of is_local. Default to false if provided * value is NULL */ if (PG_ARGISNULL(2)) is_local = false; else is_local = PG_GETARG_BOOL(2); /* Note SET DEFAULT (argstring == NULL) is equivalent to RESET */ set_config_option(name, value, (superuser() ? PGC_SUSET : PGC_USERSET), PGC_S_SESSION, is_local, true); /* get the new current value */ new_value = GetConfigOptionByName(name, NULL); /* Convert return string to text */ result_text = DatumGetTextP(DirectFunctionCall1(textin, CStringGetDatum(new_value))); /* return it */ PG_RETURN_TEXT_P(result_text); } static void define_custom_variable(struct config_generic * variable) { const char *name = variable->name; const char **nameAddr = &name; const char *value; struct config_string *pHolder; struct config_generic **res = (struct config_generic **) bsearch( (void *) &nameAddr, (void *) guc_variables, num_guc_variables, sizeof(struct config_generic *), guc_var_compare); if (res == NULL) { add_guc_variable(variable, ERROR); return; } /* * This better be a placeholder */ if (((*res)->flags & GUC_CUSTOM_PLACEHOLDER) == 0) ereport(ERROR, (errcode(ERRCODE_INTERNAL_ERROR), errmsg("attempt to redefine parameter \"%s\"", name))); Assert((*res)->vartype == PGC_STRING); pHolder = (struct config_string *) * res; /* We have the same name, no sorting is necessary */ *res = variable; value = *pHolder->variable; /* * Assign the string value stored in the placeholder to the real * variable. * * XXX this is not really good enough --- it should be a nontransactional * assignment, since we don't want it to roll back if the current xact * fails later. */ set_config_option(name, value, pHolder->gen.context, pHolder->gen.source, false, true); /* * Free up as much as we conveniently can of the placeholder structure * (this neglects any stack items...) */ set_string_field(pHolder, pHolder->variable, NULL); set_string_field(pHolder, &pHolder->reset_val, NULL); set_string_field(pHolder, &pHolder->tentative_val, NULL); free(pHolder); } static void init_custom_variable( struct config_generic * gen, const char *name, const char *short_desc, const char *long_desc, GucContext context, enum config_type type) { gen->name = guc_strdup(ERROR, name); gen->context = context; gen->group = CUSTOM_OPTIONS; gen->short_desc = short_desc; gen->long_desc = long_desc; gen->vartype = type; } void DefineCustomBoolVariable( const char *name, const char *short_desc, const char *long_desc, bool *valueAddr, GucContext context, GucBoolAssignHook assign_hook, GucShowHook show_hook) { size_t sz = sizeof(struct config_bool); struct config_bool *var = (struct config_bool *) guc_malloc(ERROR, sz); memset(var, 0, sz); init_custom_variable(&var->gen, name, short_desc, long_desc, context, PGC_BOOL); var->variable = valueAddr; var->reset_val = *valueAddr; var->assign_hook = assign_hook; var->show_hook = show_hook; define_custom_variable(&var->gen); } void DefineCustomIntVariable( const char *name, const char *short_desc, const char *long_desc, int *valueAddr, GucContext context, GucIntAssignHook assign_hook, GucShowHook show_hook) { size_t sz = sizeof(struct config_int); struct config_int *var = (struct config_int *) guc_malloc(ERROR, sz); memset(var, 0, sz); init_custom_variable(&var->gen, name, short_desc, long_desc, context, PGC_INT); var->variable = valueAddr; var->reset_val = *valueAddr; var->assign_hook = assign_hook; var->show_hook = show_hook; define_custom_variable(&var->gen); } void DefineCustomRealVariable( const char *name, const char *short_desc, const char *long_desc, double *valueAddr, GucContext context, GucRealAssignHook assign_hook, GucShowHook show_hook) { size_t sz = sizeof(struct config_real); struct config_real *var = (struct config_real *) guc_malloc(ERROR, sz); memset(var, 0, sz); init_custom_variable(&var->gen, name, short_desc, long_desc, context, PGC_REAL); var->variable = valueAddr; var->reset_val = *valueAddr; var->assign_hook = assign_hook; var->show_hook = show_hook; define_custom_variable(&var->gen); } void DefineCustomStringVariable( const char *name, const char *short_desc, const char *long_desc, char **valueAddr, GucContext context, GucStringAssignHook assign_hook, GucShowHook show_hook) { size_t sz = sizeof(struct config_string); struct config_string *var = (struct config_string *) guc_malloc(ERROR, sz); memset(var, 0, sz); init_custom_variable(&var->gen, name, short_desc, long_desc, context, PGC_STRING); var->variable = valueAddr; var->reset_val = *valueAddr; var->assign_hook = assign_hook; var->show_hook = show_hook; define_custom_variable(&var->gen); } extern void EmitWarningsOnPlaceholders(const char *className) { struct config_generic **vars = guc_variables; struct config_generic **last = vars + num_guc_variables; int nameLen = strlen(className); while (vars < last) { struct config_generic *var = *vars++; if ((var->flags & GUC_CUSTOM_PLACEHOLDER) != 0 && strncmp(className, var->name, nameLen) == 0 && var->name[nameLen] == GUC_QUALIFIER_SEPARATOR) { ereport(INFO, (errcode(ERRCODE_UNDEFINED_OBJECT), errmsg("unrecognized configuration parameter \"%s\"", var->name))); } } } /* * SHOW command */ void GetPGVariable(const char *name, DestReceiver *dest) { if (pg_strcasecmp(name, "all") == 0) ShowAllGUCConfig(dest); else ShowGUCConfigOption(name, dest); } TupleDesc GetPGVariableResultDesc(const char *name) { TupleDesc tupdesc; if (pg_strcasecmp(name, "all") == 0) { /* need a tuple descriptor representing two TEXT columns */ tupdesc = CreateTemplateTupleDesc(2, false); TupleDescInitEntry(tupdesc, (AttrNumber) 1, "name", TEXTOID, -1, 0); TupleDescInitEntry(tupdesc, (AttrNumber) 2, "setting", TEXTOID, -1, 0); } else { const char *varname; /* Get the canonical spelling of name */ (void) GetConfigOptionByName(name, &varname); /* need a tuple descriptor representing a single TEXT column */ tupdesc = CreateTemplateTupleDesc(1, false); TupleDescInitEntry(tupdesc, (AttrNumber) 1, varname, TEXTOID, -1, 0); } return tupdesc; } /* * RESET command */ void ResetPGVariable(const char *name) { if (pg_strcasecmp(name, "all") == 0) ResetAllOptions(); else set_config_option(name, NULL, (superuser() ? PGC_SUSET : PGC_USERSET), PGC_S_SESSION, false, true); } /* * SHOW command */ void ShowGUCConfigOption(const char *name, DestReceiver *dest) { TupOutputState *tstate; TupleDesc tupdesc; const char *varname; char *value; /* Get the value and canonical spelling of name */ value = GetConfigOptionByName(name, &varname); /* need a tuple descriptor representing a single TEXT column */ tupdesc = CreateTemplateTupleDesc(1, false); TupleDescInitEntry(tupdesc, (AttrNumber) 1, varname, TEXTOID, -1, 0); /* prepare for projection of tuples */ tstate = begin_tup_output_tupdesc(dest, tupdesc); /* Send it */ do_text_output_oneline(tstate, value); end_tup_output(tstate); } /* * SHOW ALL command */ void ShowAllGUCConfig(DestReceiver *dest) { int i; TupOutputState *tstate; TupleDesc tupdesc; char *values[2]; /* need a tuple descriptor representing two TEXT columns */ tupdesc = CreateTemplateTupleDesc(2, false); TupleDescInitEntry(tupdesc, (AttrNumber) 1, "name", TEXTOID, -1, 0); TupleDescInitEntry(tupdesc, (AttrNumber) 2, "setting", TEXTOID, -1, 0); /* prepare for projection of tuples */ tstate = begin_tup_output_tupdesc(dest, tupdesc); for (i = 0; i < num_guc_variables; i++) { struct config_generic *conf = guc_variables[i]; if (conf->flags & GUC_NO_SHOW_ALL) continue; /* assign to the values array */ values[0] = (char *) conf->name; values[1] = _ShowOption(conf); /* send it to dest */ do_tup_output(tstate, values); /* clean up */ if (values[1] != NULL) pfree(values[1]); } end_tup_output(tstate); } /* * Return GUC variable value by name; optionally return canonical * form of name. Return value is palloc'd. */ char * GetConfigOptionByName(const char *name, const char **varname) { struct config_generic *record; record = find_option(name, ERROR); if (record == NULL) ereport(ERROR, (errcode(ERRCODE_UNDEFINED_OBJECT), errmsg("unrecognized configuration parameter \"%s\"", name))); if (varname) *varname = record->name; return _ShowOption(record); } /* * Return GUC variable value by variable number; optionally return canonical * form of name. Return value is palloc'd. */ void GetConfigOptionByNum(int varnum, const char **values, bool *noshow) { char buffer[256]; struct config_generic *conf; /* check requested variable number valid */ Assert((varnum >= 0) && (varnum < num_guc_variables)); conf = guc_variables[varnum]; if (noshow) *noshow = (conf->flags & GUC_NO_SHOW_ALL) ? true : false; /* first get the generic attributes */ /* name */ values[0] = conf->name; /* setting : use _ShowOption in order to avoid duplicating the logic */ values[1] = _ShowOption(conf); /* group */ values[2] = config_group_names[conf->group]; /* short_desc */ values[3] = conf->short_desc; /* extra_desc */ values[4] = conf->long_desc; /* context */ values[5] = GucContext_Names[conf->context]; /* vartype */ values[6] = config_type_names[conf->vartype]; /* source */ values[7] = GucSource_Names[conf->source]; /* now get the type specifc attributes */ switch (conf->vartype) { case PGC_BOOL: { /* min_val */ values[8] = NULL; /* max_val */ values[9] = NULL; } break; case PGC_INT: { struct config_int *lconf = (struct config_int *) conf; /* min_val */ snprintf(buffer, sizeof(buffer), "%d", lconf->min); values[8] = pstrdup(buffer); /* max_val */ snprintf(buffer, sizeof(buffer), "%d", lconf->max); values[9] = pstrdup(buffer); } break; case PGC_REAL: { struct config_real *lconf = (struct config_real *) conf; /* min_val */ snprintf(buffer, sizeof(buffer), "%g", lconf->min); values[8] = pstrdup(buffer); /* max_val */ snprintf(buffer, sizeof(buffer), "%g", lconf->max); values[9] = pstrdup(buffer); } break; case PGC_STRING: { /* min_val */ values[8] = NULL; /* max_val */ values[9] = NULL; } break; default: { /* * should never get here, but in case we do, set 'em to * NULL */ /* min_val */ values[8] = NULL; /* max_val */ values[9] = NULL; } break; } } /* * Return the total number of GUC variables */ int GetNumConfigOptions(void) { return num_guc_variables; } /* * show_config_by_name - equiv to SHOW X command but implemented as * a function. */ Datum show_config_by_name(PG_FUNCTION_ARGS) { char *varname; char *varval; text *result_text; /* Get the GUC variable name */ varname = DatumGetCString(DirectFunctionCall1(textout, PG_GETARG_DATUM(0))); /* Get the value */ varval = GetConfigOptionByName(varname, NULL); /* Convert to text */ result_text = DatumGetTextP(DirectFunctionCall1(textin, CStringGetDatum(varval))); /* return it */ PG_RETURN_TEXT_P(result_text); } /* * show_all_settings - equiv to SHOW ALL command but implemented as * a Table Function. */ #define NUM_PG_SETTINGS_ATTS 10 Datum show_all_settings(PG_FUNCTION_ARGS) { FuncCallContext *funcctx; TupleDesc tupdesc; int call_cntr; int max_calls; AttInMetadata *attinmeta; MemoryContext oldcontext; /* stuff done only on the first call of the function */ if (SRF_IS_FIRSTCALL()) { /* create a function context for cross-call persistence */ funcctx = SRF_FIRSTCALL_INIT(); /* * switch to memory context appropriate for multiple function * calls */ oldcontext = MemoryContextSwitchTo(funcctx->multi_call_memory_ctx); /* * need a tuple descriptor representing NUM_PG_SETTINGS_ATTS * columns of the appropriate types */ tupdesc = CreateTemplateTupleDesc(NUM_PG_SETTINGS_ATTS, false); TupleDescInitEntry(tupdesc, (AttrNumber) 1, "name", TEXTOID, -1, 0); TupleDescInitEntry(tupdesc, (AttrNumber) 2, "setting", TEXTOID, -1, 0); TupleDescInitEntry(tupdesc, (AttrNumber) 3, "category", TEXTOID, -1, 0); TupleDescInitEntry(tupdesc, (AttrNumber) 4, "short_desc", TEXTOID, -1, 0); TupleDescInitEntry(tupdesc, (AttrNumber) 5, "extra_desc", TEXTOID, -1, 0); TupleDescInitEntry(tupdesc, (AttrNumber) 6, "context", TEXTOID, -1, 0); TupleDescInitEntry(tupdesc, (AttrNumber) 7, "vartype", TEXTOID, -1, 0); TupleDescInitEntry(tupdesc, (AttrNumber) 8, "source", TEXTOID, -1, 0); TupleDescInitEntry(tupdesc, (AttrNumber) 9, "min_val", TEXTOID, -1, 0); TupleDescInitEntry(tupdesc, (AttrNumber) 10, "max_val", TEXTOID, -1, 0); /* * Generate attribute metadata needed later to produce tuples from * raw C strings */ attinmeta = TupleDescGetAttInMetadata(tupdesc); funcctx->attinmeta = attinmeta; /* total number of tuples to be returned */ funcctx->max_calls = GetNumConfigOptions(); MemoryContextSwitchTo(oldcontext); } /* stuff done on every call of the function */ funcctx = SRF_PERCALL_SETUP(); call_cntr = funcctx->call_cntr; max_calls = funcctx->max_calls; attinmeta = funcctx->attinmeta; if (call_cntr < max_calls) /* do when there is more left to send */ { char *values[NUM_PG_SETTINGS_ATTS]; bool noshow; HeapTuple tuple; Datum result; /* * Get the next visible GUC variable name and value */ do { GetConfigOptionByNum(call_cntr, (const char **) values, &noshow); if (noshow) { /* bump the counter and get the next config setting */ call_cntr = ++funcctx->call_cntr; /* make sure we haven't gone too far now */ if (call_cntr >= max_calls) SRF_RETURN_DONE(funcctx); } } while (noshow); /* build a tuple */ tuple = BuildTupleFromCStrings(attinmeta, values); /* make the tuple into a datum */ result = HeapTupleGetDatum(tuple); SRF_RETURN_NEXT(funcctx, result); } else { /* do when there is no more left */ SRF_RETURN_DONE(funcctx); } } static char * _ShowOption(struct config_generic * record) { char buffer[256]; const char *val; switch (record->vartype) { case PGC_BOOL: { struct config_bool *conf = (struct config_bool *) record; if (conf->show_hook) val = (*conf->show_hook) (); else val = *conf->variable ? "on" : "off"; } break; case PGC_INT: { struct config_int *conf = (struct config_int *) record; if (conf->show_hook) val = (*conf->show_hook) (); else { snprintf(buffer, sizeof(buffer), "%d", *conf->variable); val = buffer; } } break; case PGC_REAL: { struct config_real *conf = (struct config_real *) record; if (conf->show_hook) val = (*conf->show_hook) (); else { snprintf(buffer, sizeof(buffer), "%g", *conf->variable); val = buffer; } } break; case PGC_STRING: { struct config_string *conf = (struct config_string *) record; if (conf->show_hook) val = (*conf->show_hook) (); else if (*conf->variable && **conf->variable) val = *conf->variable; else val = "unset"; } break; default: /* just to keep compiler quiet */ val = "???"; break; } return pstrdup(val); } #ifdef EXEC_BACKEND /* * This routine dumps out all non-default GUC options into a binary * file that is read by all exec'ed backends. The format is: * * variable name, string, null terminated * variable value, string, null terminated * variable source, integer */ void write_nondefault_variables(GucContext context) { int i; char *new_filename, *filename; int elevel; FILE *fp; Assert(context == PGC_POSTMASTER || context == PGC_SIGHUP); Assert(DataDir); elevel = (context == PGC_SIGHUP) ? LOG : ERROR; /* * Open file */ new_filename = guc_malloc(elevel, strlen(DataDir) + strlen(CONFIG_EXEC_PARAMS) + strlen(".new") + 2); if (new_filename == NULL) return; filename = guc_malloc(elevel, strlen(DataDir) + strlen(CONFIG_EXEC_PARAMS) + 2); if (filename == NULL) { free(new_filename); return; } sprintf(new_filename, "%s/" CONFIG_EXEC_PARAMS ".new", DataDir); sprintf(filename, "%s/" CONFIG_EXEC_PARAMS, DataDir); fp = AllocateFile(new_filename, "w"); if (!fp) { free(new_filename); free(filename); ereport(elevel, (errcode_for_file_access(), errmsg("could not write to file \"%s\": %m", CONFIG_EXEC_PARAMS))); return; } for (i = 0; i < num_guc_variables; i++) { struct config_generic *gconf = guc_variables[i]; if (gconf->source != PGC_S_DEFAULT) { fprintf(fp, "%s", gconf->name); fputc(0, fp); switch (gconf->vartype) { case PGC_BOOL: { struct config_bool *conf = (struct config_bool *) gconf; if (*conf->variable == 0) fprintf(fp, "false"); else fprintf(fp, "true"); } break; case PGC_INT: { struct config_int *conf = (struct config_int *) gconf; fprintf(fp, "%d", *conf->variable); } break; case PGC_REAL: { struct config_real *conf = (struct config_real *) gconf; /* Could lose precision here? */ fprintf(fp, "%f", *conf->variable); } break; case PGC_STRING: { struct config_string *conf = (struct config_string *) gconf; fprintf(fp, "%s", *conf->variable); } break; } fputc(0, fp); fwrite(&gconf->source, sizeof(gconf->source), 1, fp); } } if (FreeFile(fp)) { free(new_filename); free(filename); ereport(elevel, (errcode_for_file_access(), errmsg("could not write to file \"%s\": %m", CONFIG_EXEC_PARAMS))); return; } /* * Put new file in place. This could delay on Win32, but we don't * hold any exclusive locks. */ rename(new_filename, filename); free(new_filename); free(filename); } /* * Read string, including null byte from file * * Return NULL on EOF and nothing read */ static char * read_string_with_null(FILE *fp) { int i = 0, ch, maxlen = 256; char *str = NULL; do { if ((ch = fgetc(fp)) == EOF) { if (i == 0) return NULL; else elog(FATAL, "invalid format of exec config params file"); } if (i == 0) str = guc_malloc(FATAL, maxlen); else if (i == maxlen) str = guc_realloc(FATAL, str, maxlen *= 2); str[i++] = ch; } while (ch != 0); return str; } /* * This routine loads a previous postmaster dump of its non-default * settings. */ void read_nondefault_variables(void) { char *filename; FILE *fp; char *varname, *varvalue; int varsource; Assert(DataDir); /* * Open file */ filename = guc_malloc(FATAL, strlen(DataDir) + strlen(CONFIG_EXEC_PARAMS) + 2); sprintf(filename, "%s/" CONFIG_EXEC_PARAMS, DataDir); fp = AllocateFile(filename, "r"); if (!fp) { free(filename); /* File not found is fine */ if (errno != ENOENT) ereport(FATAL, (errcode_for_file_access(), errmsg("could not read from file \"%s\": %m", CONFIG_EXEC_PARAMS))); return; } for (;;) { struct config_generic *record; if ((varname = read_string_with_null(fp)) == NULL) break; if ((record = find_option(varname, FATAL)) == NULL) elog(FATAL, "failed to locate variable %s in exec config params file", varname); if ((varvalue = read_string_with_null(fp)) == NULL) elog(FATAL, "invalid format of exec config params file"); if (fread(&varsource, sizeof(varsource), 1, fp) == 0) elog(FATAL, "invalid format of exec config params file"); (void) set_config_option(varname, varvalue, record->context, varsource, false, true); free(varname); free(varvalue); } FreeFile(fp); free(filename); return; } #endif /* * A little "long argument" simulation, although not quite GNU * compliant. Takes a string of the form "some-option=some value" and * returns name = "some_option" and value = "some value" in malloc'ed * storage. Note that '-' is converted to '_' in the option name. If * there is no '=' in the input string then value will be NULL. */ void ParseLongOption(const char *string, char **name, char **value) { size_t equal_pos; char *cp; AssertArg(string); AssertArg(name); AssertArg(value); equal_pos = strcspn(string, "="); if (string[equal_pos] == '=') { *name = guc_malloc(FATAL, equal_pos + 1); strncpy(*name, string, equal_pos); (*name)[equal_pos] = '\0'; *value = guc_strdup(FATAL, &string[equal_pos + 1]); } else { /* no equal sign in string */ *name = guc_strdup(FATAL, string); *value = NULL; } for (cp = *name; *cp; cp++) if (*cp == '-') *cp = '_'; } /* * Handle options fetched from pg_database.datconfig or pg_shadow.useconfig. * The array parameter must be an array of TEXT (it must not be NULL). */ void ProcessGUCArray(ArrayType *array, GucSource source) { int i; Assert(array != NULL); Assert(ARR_ELEMTYPE(array) == TEXTOID); Assert(ARR_NDIM(array) == 1); Assert(ARR_LBOUND(array)[0] == 1); Assert(source == PGC_S_DATABASE || source == PGC_S_USER); for (i = 1; i <= ARR_DIMS(array)[0]; i++) { Datum d; bool isnull; char *s; char *name; char *value; d = array_ref(array, 1, &i, -1 /* varlenarray */ , -1 /* TEXT's typlen */ , false /* TEXT's typbyval */ , 'i' /* TEXT's typalign */ , &isnull); if (isnull) continue; s = DatumGetCString(DirectFunctionCall1(textout, d)); ParseLongOption(s, &name, &value); if (!value) { ereport(WARNING, (errcode(ERRCODE_SYNTAX_ERROR), errmsg("could not parse setting for parameter \"%s\"", name))); free(name); continue; } /* * We process all these options at SUSET level. We assume that * the right to insert an option into pg_database or pg_shadow was * checked when it was inserted. */ SetConfigOption(name, value, PGC_SUSET, source); free(name); if (value) free(value); } } /* * Add an entry to an option array. The array parameter may be NULL * to indicate the current table entry is NULL. */ ArrayType * GUCArrayAdd(ArrayType *array, const char *name, const char *value) { const char *varname; Datum datum; char *newval; ArrayType *a; Assert(name); Assert(value); /* test if the option is valid */ set_config_option(name, value, superuser() ? PGC_SUSET : PGC_USERSET, PGC_S_TEST, false, false); /* convert name to canonical spelling, so we can use plain strcmp */ (void) GetConfigOptionByName(name, &varname); name = varname; newval = palloc(strlen(name) + 1 + strlen(value) + 1); sprintf(newval, "%s=%s", name, value); datum = DirectFunctionCall1(textin, CStringGetDatum(newval)); if (array) { int index; bool isnull; int i; Assert(ARR_ELEMTYPE(array) == TEXTOID); Assert(ARR_NDIM(array) == 1); Assert(ARR_LBOUND(array)[0] == 1); index = ARR_DIMS(array)[0] + 1; /* add after end */ for (i = 1; i <= ARR_DIMS(array)[0]; i++) { Datum d; char *current; d = array_ref(array, 1, &i, -1 /* varlenarray */ , -1 /* TEXT's typlen */ , false /* TEXT's typbyval */ , 'i' /* TEXT's typalign */ , &isnull); if (isnull) continue; current = DatumGetCString(DirectFunctionCall1(textout, d)); if (strncmp(current, newval, strlen(name) + 1) == 0) { index = i; break; } } isnull = false; a = array_set(array, 1, &index, datum, -1 /* varlenarray */ , -1 /* TEXT's typlen */ , false /* TEXT's typbyval */ , 'i' /* TEXT's typalign */ , &isnull); } else a = construct_array(&datum, 1, TEXTOID, -1, false, 'i'); return a; } /* * Delete an entry from an option array. The array parameter may be NULL * to indicate the current table entry is NULL. Also, if the return value * is NULL then a null should be stored. */ ArrayType * GUCArrayDelete(ArrayType *array, const char *name) { const char *varname; ArrayType *newarray; int i; int index; Assert(name); /* test if the option is valid */ set_config_option(name, NULL, superuser() ? PGC_SUSET : PGC_USERSET, PGC_S_TEST, false, false); /* convert name to canonical spelling, so we can use plain strcmp */ (void) GetConfigOptionByName(name, &varname); name = varname; /* if array is currently null, then surely nothing to delete */ if (!array) return NULL; newarray = NULL; index = 1; for (i = 1; i <= ARR_DIMS(array)[0]; i++) { Datum d; char *val; bool isnull; d = array_ref(array, 1, &i, -1 /* varlenarray */ , -1 /* TEXT's typlen */ , false /* TEXT's typbyval */ , 'i' /* TEXT's typalign */ , &isnull); if (isnull) continue; val = DatumGetCString(DirectFunctionCall1(textout, d)); /* ignore entry if it's what we want to delete */ if (strncmp(val, name, strlen(name)) == 0 && val[strlen(name)] == '=') continue; /* else add it to the output array */ if (newarray) { isnull = false; newarray = array_set(newarray, 1, &index, d, -1 /* varlenarray */ , -1 /* TEXT's typlen */ , false /* TEXT's typbyval */ , 'i' /* TEXT's typalign */ , &isnull); } else newarray = construct_array(&d, 1, TEXTOID, -1, false, 'i'); index++; } return newarray; } /* * assign_hook subroutines */ static const char * assign_log_destination(const char *value, bool doit, GucSource source) { char *rawstring; List *elemlist; ListCell *l; int newlogdest = 0; /* Need a modifiable copy of string */ rawstring = pstrdup(value); /* Parse string into list of identifiers */ if (!SplitIdentifierString(rawstring, ',', &elemlist)) { /* syntax error in list */ pfree(rawstring); list_free(elemlist); if (source >= PGC_S_INTERACTIVE) ereport(ERROR, (errcode(ERRCODE_INVALID_PARAMETER_VALUE), errmsg("invalid list syntax for parameter \"log_destination\""))); return NULL; } foreach(l, elemlist) { char *tok = (char *) lfirst(l); if (pg_strcasecmp(tok, "stderr") == 0) newlogdest |= LOG_DESTINATION_STDERR; #ifdef HAVE_SYSLOG else if (pg_strcasecmp(tok, "syslog") == 0) newlogdest |= LOG_DESTINATION_SYSLOG; #endif #ifdef WIN32 else if (pg_strcasecmp(tok, "eventlog") == 0) newlogdest |= LOG_DESTINATION_EVENTLOG; #endif else { if (source >= PGC_S_INTERACTIVE) ereport(ERROR, (errcode(ERRCODE_INVALID_PARAMETER_VALUE), errmsg("unrecognised \"log_destination\" key word: \"%s\"", tok))); pfree(rawstring); list_free(elemlist); return NULL; } } if (doit) Log_destination = newlogdest; pfree(rawstring); list_free(elemlist); return value; } #ifdef HAVE_SYSLOG static const char * assign_facility(const char *facility, bool doit, GucSource source) { if (pg_strcasecmp(facility, "LOCAL0") == 0) return facility; if (pg_strcasecmp(facility, "LOCAL1") == 0) return facility; if (pg_strcasecmp(facility, "LOCAL2") == 0) return facility; if (pg_strcasecmp(facility, "LOCAL3") == 0) return facility; if (pg_strcasecmp(facility, "LOCAL4") == 0) return facility; if (pg_strcasecmp(facility, "LOCAL5") == 0) return facility; if (pg_strcasecmp(facility, "LOCAL6") == 0) return facility; if (pg_strcasecmp(facility, "LOCAL7") == 0) return facility; return NULL; } #endif static const char * assign_defaultxactisolevel(const char *newval, bool doit, GucSource source) { if (pg_strcasecmp(newval, "serializable") == 0) { if (doit) DefaultXactIsoLevel = XACT_SERIALIZABLE; } else if (pg_strcasecmp(newval, "repeatable read") == 0) { if (doit) DefaultXactIsoLevel = XACT_REPEATABLE_READ; } else if (pg_strcasecmp(newval, "read committed") == 0) { if (doit) DefaultXactIsoLevel = XACT_READ_COMMITTED; } else if (pg_strcasecmp(newval, "read uncommitted") == 0) { if (doit) DefaultXactIsoLevel = XACT_READ_UNCOMMITTED; } else return NULL; return newval; } static const char * assign_log_min_messages(const char *newval, bool doit, GucSource source) { return (assign_msglvl(&log_min_messages, newval, doit, source)); } static const char * assign_client_min_messages(const char *newval, bool doit, GucSource source) { return (assign_msglvl(&client_min_messages, newval, doit, source)); } static const char * assign_min_error_statement(const char *newval, bool doit, GucSource source) { return (assign_msglvl(&log_min_error_statement, newval, doit, source)); } static const char * assign_msglvl(int *var, const char *newval, bool doit, GucSource source) { if (pg_strcasecmp(newval, "debug") == 0) { if (doit) (*var) = DEBUG2; } else if (pg_strcasecmp(newval, "debug5") == 0) { if (doit) (*var) = DEBUG5; } else if (pg_strcasecmp(newval, "debug4") == 0) { if (doit) (*var) = DEBUG4; } else if (pg_strcasecmp(newval, "debug3") == 0) { if (doit) (*var) = DEBUG3; } else if (pg_strcasecmp(newval, "debug2") == 0) { if (doit) (*var) = DEBUG2; } else if (pg_strcasecmp(newval, "debug1") == 0) { if (doit) (*var) = DEBUG1; } else if (pg_strcasecmp(newval, "log") == 0) { if (doit) (*var) = LOG; } /* * Client_min_messages always prints 'info', but we allow it as a * value anyway. */ else if (pg_strcasecmp(newval, "info") == 0) { if (doit) (*var) = INFO; } else if (pg_strcasecmp(newval, "notice") == 0) { if (doit) (*var) = NOTICE; } else if (pg_strcasecmp(newval, "warning") == 0) { if (doit) (*var) = WARNING; } else if (pg_strcasecmp(newval, "error") == 0) { if (doit) (*var) = ERROR; } /* We allow FATAL/PANIC for client-side messages too. */ else if (pg_strcasecmp(newval, "fatal") == 0) { if (doit) (*var) = FATAL; } else if (pg_strcasecmp(newval, "panic") == 0) { if (doit) (*var) = PANIC; } else return NULL; /* fail */ return newval; /* OK */ } static const char * assign_log_error_verbosity(const char *newval, bool doit, GucSource source) { if (pg_strcasecmp(newval, "terse") == 0) { if (doit) Log_error_verbosity = PGERROR_TERSE; } else if (pg_strcasecmp(newval, "default") == 0) { if (doit) Log_error_verbosity = PGERROR_DEFAULT; } else if (pg_strcasecmp(newval, "verbose") == 0) { if (doit) Log_error_verbosity = PGERROR_VERBOSE; } else return NULL; /* fail */ return newval; /* OK */ } static const char * assign_log_statement(const char *newval, bool doit, GucSource source) { return (assign_log_stmtlvl((int *) &log_statement, newval, doit, source)); } static const char * assign_log_stmtlvl(int *var, const char *newval, bool doit, GucSource source) { if (pg_strcasecmp(newval, "none") == 0) { if (doit) (*var) = LOGSTMT_NONE; } else if (pg_strcasecmp(newval, "mod") == 0) { if (doit) (*var) = LOGSTMT_MOD; } else if (pg_strcasecmp(newval, "ddl") == 0) { if (doit) (*var) = LOGSTMT_DDL; } else if (pg_strcasecmp(newval, "all") == 0) { if (doit) (*var) = LOGSTMT_ALL; } else return NULL; /* fail */ return newval; /* OK */ } static bool assign_phony_autocommit(bool newval, bool doit, GucSource source) { if (!newval) { if (doit && source >= PGC_S_INTERACTIVE) ereport(ERROR, (errcode(ERRCODE_FEATURE_NOT_SUPPORTED), errmsg("SET AUTOCOMMIT TO OFF is no longer supported"))); return false; } return true; } static const char * assign_custom_variable_classes(const char *newval, bool doit, GucSource source) { /* * Check syntax. newval must be a comma separated list of identifiers. * Whitespace is allowed but skipped. */ bool hasSpaceAfterToken = false; const char *cp = newval; int symLen = 0; int c; StringInfoData buf; initStringInfo(&buf); while ((c = *cp++) != 0) { if (isspace(c)) { if (symLen > 0) hasSpaceAfterToken = true; continue; } if (c == ',') { hasSpaceAfterToken = false; if (symLen > 0) { symLen = 0; appendStringInfoChar(&buf, ','); } continue; } if (hasSpaceAfterToken || !isalnum(c)) { /* * Syntax error due to token following space after token or * non alpha numeric character */ ereport(LOG, (errcode(ERRCODE_SYNTAX_ERROR), errmsg("invalid syntax for custom_variable_classes: \"%s\"", newval))); pfree(buf.data); return NULL; } symLen++; appendStringInfoChar(&buf, (char) c); } /* Remove stray ',' at end */ if (symLen == 0 && buf.len > 0) buf.data[--buf.len] = '\0'; if (buf.len == 0) newval = NULL; else if (doit) newval = strdup(buf.data); pfree(buf.data); return newval; } static bool assign_stage_log_stats(bool newval, bool doit, GucSource source) { if (newval && log_statement_stats) { if (source >= PGC_S_INTERACTIVE) ereport(ERROR, (errcode(ERRCODE_INVALID_PARAMETER_VALUE), errmsg("cannot enable parameter when \"log_statement_stats\" is true"))); /* source == PGC_S_OVERRIDE means do it anyway, eg at xact abort */ else if (source != PGC_S_OVERRIDE) return false; } return true; } static bool assign_log_stats(bool newval, bool doit, GucSource source) { if (newval && (log_parser_stats || log_planner_stats || log_executor_stats)) { if (source >= PGC_S_INTERACTIVE) ereport(ERROR, (errcode(ERRCODE_INVALID_PARAMETER_VALUE), errmsg("cannot enable \"log_statement_stats\" when " "\"log_parser_stats\", \"log_planner_stats\", " "or \"log_executor_stats\" is true"))); /* source == PGC_S_OVERRIDE means do it anyway, eg at xact abort */ else if (source != PGC_S_OVERRIDE) return false; } return true; } static bool assign_transaction_read_only(bool newval, bool doit, GucSource source) { /* Can't go to r/w mode inside a r/o transaction */ if (newval == false && XactReadOnly && IsSubTransaction()) { if (source >= PGC_S_INTERACTIVE) ereport(ERROR, (errcode(ERRCODE_INVALID_PARAMETER_VALUE), errmsg("cannot set transaction read-write mode inside a read-only transaction"))); /* source == PGC_S_OVERRIDE means do it anyway, eg at xact abort */ else if (source != PGC_S_OVERRIDE) return false; } return true; } static const char * assign_canonical_path(const char *newval, bool doit, GucSource source) { if (doit) { /* We have to create a new pointer to force the change */ char *canon_val = guc_strdup(ERROR, newval); canonicalize_path(canon_val); return canon_val; } else return newval; } #include "guc-file.c"