PostgreSQL Source Code git master
Loading...
Searching...
No Matches
guc.h File Reference
#include "nodes/parsenodes.h"
#include "tcop/dest.h"
#include "utils/array.h"
Include dependency graph for guc.h:
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures

struct  ConfigVariable
 
struct  config_enum_entry
 

Macros

#define MAX_KILOBYTES   (INT_MAX / 1024)
 
#define PG_AUTOCONF_FILENAME   "postgresql.auto.conf"
 
#define GUC_QUALIFIER_SEPARATOR   '.'
 
#define GUC_LIST_INPUT   0x000001 /* input can be list format */
 
#define GUC_LIST_QUOTE   0x000002 /* double-quote list elements */
 
#define GUC_NO_SHOW_ALL   0x000004 /* exclude from SHOW ALL */
 
#define GUC_NO_RESET   0x000008 /* disallow RESET and SAVE */
 
#define GUC_NO_RESET_ALL   0x000010 /* exclude from RESET ALL */
 
#define GUC_EXPLAIN   0x000020 /* include in EXPLAIN */
 
#define GUC_REPORT   0x000040 /* auto-report changes to client */
 
#define GUC_NOT_IN_SAMPLE   0x000080 /* not in postgresql.conf.sample */
 
#define GUC_DISALLOW_IN_FILE   0x000100 /* can't set in postgresql.conf */
 
#define GUC_CUSTOM_PLACEHOLDER   0x000200 /* placeholder for custom variable */
 
#define GUC_SUPERUSER_ONLY   0x000400 /* show only to superusers */
 
#define GUC_IS_NAME   0x000800 /* limit string to NAMEDATALEN-1 */
 
#define GUC_NOT_WHILE_SEC_REST   0x001000 /* can't set if security restricted */
 
#define GUC_DISALLOW_IN_AUTO_FILE    0x002000 /* can't set in PG_AUTOCONF_FILENAME */
 
#define GUC_RUNTIME_COMPUTED   0x004000 /* delay processing in 'postgres -C' */
 
#define GUC_ALLOW_IN_PARALLEL   0x008000 /* allow setting in parallel mode */
 
#define GUC_UNIT_KB   0x01000000 /* value is in kilobytes */
 
#define GUC_UNIT_BLOCKS   0x02000000 /* value is in blocks */
 
#define GUC_UNIT_XBLOCKS   0x03000000 /* value is in xlog blocks */
 
#define GUC_UNIT_MB   0x04000000 /* value is in megabytes */
 
#define GUC_UNIT_BYTE   0x05000000 /* value is in bytes */
 
#define GUC_UNIT_MEMORY   0x0F000000 /* mask for size-related units */
 
#define GUC_UNIT_MS   0x10000000 /* value is in milliseconds */
 
#define GUC_UNIT_S   0x20000000 /* value is in seconds */
 
#define GUC_UNIT_MIN   0x30000000 /* value is in minutes */
 
#define GUC_UNIT_TIME   0x70000000 /* mask for time-related units */
 
#define GUC_UNIT   (GUC_UNIT_MEMORY | GUC_UNIT_TIME)
 
#define EmitWarningsOnPlaceholders(className)   MarkGUCPrefixReserved(className)
 
#define GUC_check_errmsg
 
#define GUC_check_errdetail
 
#define GUC_check_errhint
 

Typedefs

typedef struct ConfigVariable ConfigVariable
 
typedef struct config_generic config_handle
 
typedef bool(* GucBoolCheckHook) (bool *newval, void **extra, GucSource source)
 
typedef bool(* GucIntCheckHook) (int *newval, void **extra, GucSource source)
 
typedef bool(* GucRealCheckHook) (double *newval, void **extra, GucSource source)
 
typedef bool(* GucStringCheckHook) (char **newval, void **extra, GucSource source)
 
typedef bool(* GucEnumCheckHook) (int *newval, void **extra, GucSource source)
 
typedef void(* GucBoolAssignHook) (bool newval, void *extra)
 
typedef void(* GucIntAssignHook) (int newval, void *extra)
 
typedef void(* GucRealAssignHook) (double newval, void *extra)
 
typedef void(* GucStringAssignHook) (const char *newval, void *extra)
 
typedef void(* GucEnumAssignHook) (int newval, void *extra)
 
typedef const char *(* GucShowHook) (void)
 

Enumerations

enum  GucContext {
  PGC_INTERNAL , PGC_POSTMASTER , PGC_SIGHUP , PGC_SU_BACKEND ,
  PGC_BACKEND , PGC_SUSET , PGC_USERSET
}
 
enum  GucSource {
  PGC_S_DEFAULT , PGC_S_DYNAMIC_DEFAULT , PGC_S_ENV_VAR , PGC_S_FILE ,
  PGC_S_ARGV , PGC_S_GLOBAL , PGC_S_DATABASE , PGC_S_USER ,
  PGC_S_DATABASE_USER , PGC_S_CLIENT , PGC_S_OVERRIDE , PGC_S_INTERACTIVE ,
  PGC_S_TEST , PGC_S_SESSION
}
 
enum  GucAction { GUC_ACTION_SET , GUC_ACTION_LOCAL , GUC_ACTION_SAVE }
 

Functions

bool ParseConfigFile (const char *config_file, bool strict, const char *calling_file, int calling_lineno, int depth, int elevel, ConfigVariable **head_p, ConfigVariable **tail_p)
 
bool ParseConfigFp (FILE *fp, const char *config_file, int depth, int elevel, ConfigVariable **head_p, ConfigVariable **tail_p)
 
bool ParseConfigDirectory (const char *includedir, const char *calling_file, int calling_lineno, int depth, int elevel, ConfigVariable **head_p, ConfigVariable **tail_p)
 
void FreeConfigVariables (ConfigVariable *list)
 
char * DeescapeQuotedString (const char *s)
 
void SetConfigOption (const char *name, const char *value, GucContext context, GucSource source)
 
void DefineCustomBoolVariable (const char *name, const char *short_desc, const char *long_desc, bool *valueAddr, bool bootValue, GucContext context, int flags, GucBoolCheckHook check_hook, GucBoolAssignHook assign_hook, GucShowHook show_hook) pg_attribute_nonnull(1
 
void void DefineCustomIntVariable (const char *name, const char *short_desc, const char *long_desc, int *valueAddr, int bootValue, int minValue, int maxValue, GucContext context, int flags, GucIntCheckHook check_hook, GucIntAssignHook assign_hook, GucShowHook show_hook) pg_attribute_nonnull(1
 
void void void DefineCustomRealVariable (const char *name, const char *short_desc, const char *long_desc, double *valueAddr, double bootValue, double minValue, double maxValue, GucContext context, int flags, GucRealCheckHook check_hook, GucRealAssignHook assign_hook, GucShowHook show_hook) pg_attribute_nonnull(1
 
void void void void DefineCustomStringVariable (const char *name, const char *short_desc, const char *long_desc, char **valueAddr, const char *bootValue, GucContext context, int flags, GucStringCheckHook check_hook, GucStringAssignHook assign_hook, GucShowHook show_hook) pg_attribute_nonnull(1
 
void void void void void DefineCustomEnumVariable (const char *name, const char *short_desc, const char *long_desc, int *valueAddr, int bootValue, const struct config_enum_entry *options, GucContext context, int flags, GucEnumCheckHook check_hook, GucEnumAssignHook assign_hook, GucShowHook show_hook) pg_attribute_nonnull(1
 
void void void void void void MarkGUCPrefixReserved (const char *className)
 
const char * GetConfigOption (const char *name, bool missing_ok, bool restrict_privileged)
 
const char * GetConfigOptionResetString (const char *name)
 
int GetConfigOptionFlags (const char *name, bool missing_ok)
 
void ProcessConfigFile (GucContext context)
 
char * convert_GUC_name_for_parameter_acl (const char *name)
 
void check_GUC_name_for_parameter_acl (const char *name)
 
void InitializeGUCOptions (void)
 
bool SelectConfigFiles (const char *userDoption, const char *progname)
 
void ResetAllOptions (void)
 
void AtStart_GUC (void)
 
int NewGUCNestLevel (void)
 
void RestrictSearchPath (void)
 
void AtEOXact_GUC (bool isCommit, int nestLevel)
 
void BeginReportingGUCOptions (void)
 
void ReportChangedGUCOptions (void)
 
void ParseLongOption (const char *string, char **name, char **value)
 
const char * get_config_unit_name (int flags)
 
bool parse_int (const char *value, int *result, int flags, const char **hintmsg)
 
bool parse_real (const char *value, double *result, int flags, const char **hintmsg)
 
int set_config_option (const char *name, const char *value, GucContext context, GucSource source, GucAction action, bool changeVal, int elevel, bool is_reload)
 
int set_config_option_ext (const char *name, const char *value, GucContext context, GucSource source, Oid srole, GucAction action, bool changeVal, int elevel, bool is_reload)
 
int set_config_with_handle (const char *name, config_handle *handle, const char *value, GucContext context, GucSource source, Oid srole, GucAction action, bool changeVal, int elevel, bool is_reload)
 
config_handleget_config_handle (const char *name)
 
void AlterSystemSetConfigFile (AlterSystemStmt *altersysstmt)
 
char * GetConfigOptionByName (const char *name, const char **varname, bool missing_ok)
 
void TransformGUCArray (ArrayType *array, List **names, List **values)
 
void ProcessGUCArray (ArrayType *array, GucContext context, GucSource source, GucAction action)
 
ArrayTypeGUCArrayAdd (ArrayType *array, const char *name, const char *value)
 
ArrayTypeGUCArrayDelete (ArrayType *array, const char *name)
 
ArrayTypeGUCArrayReset (ArrayType *array)
 
void * guc_malloc (int elevel, size_t size)
 
pg_nodiscard void * guc_realloc (int elevel, void *old, size_t size)
 
char * guc_strdup (int elevel, const char *src)
 
void guc_free (void *ptr)
 
Size EstimateGUCStateSpace (void)
 
void SerializeGUCState (Size maxsize, char *start_address)
 
void RestoreGUCState (void *gucstate)
 
void ExecSetVariableStmt (VariableSetStmt *stmt, bool isTopLevel)
 
char * ExtractSetVariableArgs (VariableSetStmt *stmt)
 
void SetPGVariable (const char *name, List *args, bool is_local)
 
void GetPGVariable (const char *name, DestReceiver *dest)
 
TupleDesc GetPGVariableResultDesc (const char *name)
 
void GUC_check_errcode (int sqlerrcode)
 

Variables

PGDLLIMPORT bool Debug_print_plan
 
PGDLLIMPORT bool Debug_print_parse
 
PGDLLIMPORT bool Debug_print_raw_parse
 
PGDLLIMPORT bool Debug_print_rewritten
 
PGDLLIMPORT bool Debug_pretty_print
 
PGDLLIMPORT bool log_parser_stats
 
PGDLLIMPORT bool log_planner_stats
 
PGDLLIMPORT bool log_executor_stats
 
PGDLLIMPORT bool log_statement_stats
 
PGDLLIMPORT bool log_btree_build_stats
 
PGDLLIMPORT char * event_source
 
PGDLLIMPORT bool check_function_bodies
 
PGDLLIMPORT bool current_role_is_superuser
 
PGDLLIMPORT bool AllowAlterSystem
 
PGDLLIMPORT bool log_duration
 
PGDLLIMPORT int log_parameter_max_length
 
PGDLLIMPORT int log_parameter_max_length_on_error
 
PGDLLIMPORT int log_min_error_statement
 
PGDLLIMPORT int log_min_messages []
 
PGDLLIMPORT int client_min_messages
 
PGDLLIMPORT int log_min_duration_sample
 
PGDLLIMPORT int log_min_duration_statement
 
PGDLLIMPORT int log_temp_files
 
PGDLLIMPORT double log_statement_sample_rate
 
PGDLLIMPORT double log_xact_sample_rate
 
PGDLLIMPORT char * backtrace_functions
 
PGDLLIMPORT int temp_file_limit
 
PGDLLIMPORT int num_temp_buffers
 
PGDLLIMPORT char * cluster_name
 
PGDLLIMPORT char * ConfigFileName
 
PGDLLIMPORT char * HbaFileName
 
PGDLLIMPORT char * IdentFileName
 
PGDLLIMPORT char * HostsFileName
 
PGDLLIMPORT char * external_pid_file
 
PGDLLIMPORT char * application_name
 
PGDLLIMPORT int tcp_keepalives_idle
 
PGDLLIMPORT int tcp_keepalives_interval
 
PGDLLIMPORT int tcp_keepalives_count
 
PGDLLIMPORT int tcp_user_timeout
 
PGDLLIMPORT char * role_string
 
PGDLLIMPORT bool in_hot_standby_guc
 
PGDLLIMPORT bool trace_sort
 
PGDLLIMPORT const struct config_enum_entry archive_mode_options []
 
PGDLLIMPORT const struct config_enum_entry dynamic_shared_memory_options []
 
PGDLLIMPORT const struct config_enum_entry io_method_options []
 
PGDLLIMPORT const struct config_enum_entry recovery_target_action_options []
 
PGDLLIMPORT const struct config_enum_entry server_message_level_options []
 
PGDLLIMPORT const struct config_enum_entry wal_level_options []
 
PGDLLIMPORT const struct config_enum_entry wal_sync_method_options []
 
PGDLLIMPORT char * GUC_check_errmsg_string
 
PGDLLIMPORT char * GUC_check_errdetail_string
 
PGDLLIMPORT char * GUC_check_errhint_string
 

Macro Definition Documentation

◆ EmitWarningsOnPlaceholders

#define EmitWarningsOnPlaceholders (   className)    MarkGUCPrefixReserved(className)

Definition at line 421 of file guc.h.

◆ GUC_ALLOW_IN_PARALLEL

#define GUC_ALLOW_IN_PARALLEL   0x008000 /* allow setting in parallel mode */

Definition at line 230 of file guc.h.

◆ GUC_check_errdetail

#define GUC_check_errdetail
Value:
char * format_elog_string(const char *fmt,...)
Definition elog.c:1850
void pre_format_elog_string(int errnumber, const char *domain)
Definition elog.c:1841
#define TEXTDOMAIN
Definition elog.h:155
PGDLLIMPORT char * GUC_check_errdetail_string
Definition guc.c:84

Definition at line 507 of file guc.h.

◆ GUC_check_errhint

#define GUC_check_errhint
Value:
PGDLLIMPORT char * GUC_check_errhint_string
Definition guc.c:85

Definition at line 511 of file guc.h.

◆ GUC_check_errmsg

#define GUC_check_errmsg
Value:
PGDLLIMPORT char * GUC_check_errmsg_string
Definition guc.c:83

Definition at line 503 of file guc.h.

◆ GUC_CUSTOM_PLACEHOLDER

#define GUC_CUSTOM_PLACEHOLDER   0x000200 /* placeholder for custom variable */

Definition at line 223 of file guc.h.

◆ GUC_DISALLOW_IN_AUTO_FILE

#define GUC_DISALLOW_IN_AUTO_FILE    0x002000 /* can't set in PG_AUTOCONF_FILENAME */

Definition at line 227 of file guc.h.

◆ GUC_DISALLOW_IN_FILE

#define GUC_DISALLOW_IN_FILE   0x000100 /* can't set in postgresql.conf */

Definition at line 222 of file guc.h.

◆ GUC_EXPLAIN

#define GUC_EXPLAIN   0x000020 /* include in EXPLAIN */

Definition at line 219 of file guc.h.

◆ GUC_IS_NAME

#define GUC_IS_NAME   0x000800 /* limit string to NAMEDATALEN-1 */

Definition at line 225 of file guc.h.

◆ GUC_LIST_INPUT

#define GUC_LIST_INPUT   0x000001 /* input can be list format */

Definition at line 214 of file guc.h.

◆ GUC_LIST_QUOTE

#define GUC_LIST_QUOTE   0x000002 /* double-quote list elements */

Definition at line 215 of file guc.h.

◆ GUC_NO_RESET

#define GUC_NO_RESET   0x000008 /* disallow RESET and SAVE */

Definition at line 217 of file guc.h.

◆ GUC_NO_RESET_ALL

#define GUC_NO_RESET_ALL   0x000010 /* exclude from RESET ALL */

Definition at line 218 of file guc.h.

◆ GUC_NO_SHOW_ALL

#define GUC_NO_SHOW_ALL   0x000004 /* exclude from SHOW ALL */

Definition at line 216 of file guc.h.

◆ GUC_NOT_IN_SAMPLE

#define GUC_NOT_IN_SAMPLE   0x000080 /* not in postgresql.conf.sample */

Definition at line 221 of file guc.h.

◆ GUC_NOT_WHILE_SEC_REST

#define GUC_NOT_WHILE_SEC_REST   0x001000 /* can't set if security restricted */

Definition at line 226 of file guc.h.

◆ GUC_QUALIFIER_SEPARATOR

#define GUC_QUALIFIER_SEPARATOR   '.'

Definition at line 208 of file guc.h.

◆ GUC_REPORT

#define GUC_REPORT   0x000040 /* auto-report changes to client */

Definition at line 220 of file guc.h.

◆ GUC_RUNTIME_COMPUTED

#define GUC_RUNTIME_COMPUTED   0x004000 /* delay processing in 'postgres -C' */

Definition at line 229 of file guc.h.

◆ GUC_SUPERUSER_ONLY

#define GUC_SUPERUSER_ONLY   0x000400 /* show only to superusers */

Definition at line 224 of file guc.h.

◆ GUC_UNIT

#define GUC_UNIT   (GUC_UNIT_MEMORY | GUC_UNIT_TIME)

Definition at line 244 of file guc.h.

◆ GUC_UNIT_BLOCKS

#define GUC_UNIT_BLOCKS   0x02000000 /* value is in blocks */

Definition at line 233 of file guc.h.

◆ GUC_UNIT_BYTE

#define GUC_UNIT_BYTE   0x05000000 /* value is in bytes */

Definition at line 236 of file guc.h.

◆ GUC_UNIT_KB

#define GUC_UNIT_KB   0x01000000 /* value is in kilobytes */

Definition at line 232 of file guc.h.

◆ GUC_UNIT_MB

#define GUC_UNIT_MB   0x04000000 /* value is in megabytes */

Definition at line 235 of file guc.h.

◆ GUC_UNIT_MEMORY

#define GUC_UNIT_MEMORY   0x0F000000 /* mask for size-related units */

Definition at line 237 of file guc.h.

◆ GUC_UNIT_MIN

#define GUC_UNIT_MIN   0x30000000 /* value is in minutes */

Definition at line 241 of file guc.h.

◆ GUC_UNIT_MS

#define GUC_UNIT_MS   0x10000000 /* value is in milliseconds */

Definition at line 239 of file guc.h.

◆ GUC_UNIT_S

#define GUC_UNIT_S   0x20000000 /* value is in seconds */

Definition at line 240 of file guc.h.

◆ GUC_UNIT_TIME

#define GUC_UNIT_TIME   0x70000000 /* mask for time-related units */

Definition at line 242 of file guc.h.

◆ GUC_UNIT_XBLOCKS

#define GUC_UNIT_XBLOCKS   0x03000000 /* value is in xlog blocks */

Definition at line 234 of file guc.h.

◆ MAX_KILOBYTES

#define MAX_KILOBYTES   (INT_MAX / 1024)

Definition at line 29 of file guc.h.

◆ PG_AUTOCONF_FILENAME

#define PG_AUTOCONF_FILENAME   "postgresql.auto.conf"

Definition at line 37 of file guc.h.

Typedef Documentation

◆ config_handle

typedef struct config_generic config_handle

Definition at line 151 of file guc.h.

◆ ConfigVariable

◆ GucBoolAssignHook

typedef void(* GucBoolAssignHook) (bool newval, void *extra)

Definition at line 189 of file guc.h.

◆ GucBoolCheckHook

typedef bool(* GucBoolCheckHook) (bool *newval, void **extra, GucSource source)

Definition at line 183 of file guc.h.

◆ GucEnumAssignHook

typedef void(* GucEnumAssignHook) (int newval, void *extra)

Definition at line 193 of file guc.h.

◆ GucEnumCheckHook

typedef bool(* GucEnumCheckHook) (int *newval, void **extra, GucSource source)

Definition at line 187 of file guc.h.

◆ GucIntAssignHook

typedef void(* GucIntAssignHook) (int newval, void *extra)

Definition at line 190 of file guc.h.

◆ GucIntCheckHook

typedef bool(* GucIntCheckHook) (int *newval, void **extra, GucSource source)

Definition at line 184 of file guc.h.

◆ GucRealAssignHook

typedef void(* GucRealAssignHook) (double newval, void *extra)

Definition at line 191 of file guc.h.

◆ GucRealCheckHook

typedef bool(* GucRealCheckHook) (double *newval, void **extra, GucSource source)

Definition at line 185 of file guc.h.

◆ GucShowHook

typedef const char *(* GucShowHook) (void)

Definition at line 195 of file guc.h.

◆ GucStringAssignHook

typedef void(* GucStringAssignHook) (const char *newval, void *extra)

Definition at line 192 of file guc.h.

◆ GucStringCheckHook

typedef bool(* GucStringCheckHook) (char **newval, void **extra, GucSource source)

Definition at line 186 of file guc.h.

Enumeration Type Documentation

◆ GucAction

enum GucAction
Enumerator
GUC_ACTION_SET 
GUC_ACTION_LOCAL 
GUC_ACTION_SAVE 

Definition at line 200 of file guc.h.

201{
202 /* Types of set_config_option actions */
203 GUC_ACTION_SET, /* regular SET command */
204 GUC_ACTION_LOCAL, /* SET LOCAL command */
205 GUC_ACTION_SAVE, /* function SET option, or temp assignment */
206} GucAction;
GucAction
Definition guc.h:201
@ GUC_ACTION_SAVE
Definition guc.h:205
@ GUC_ACTION_SET
Definition guc.h:203
@ GUC_ACTION_LOCAL
Definition guc.h:204

◆ GucContext

enum GucContext
Enumerator
PGC_INTERNAL 
PGC_POSTMASTER 
PGC_SIGHUP 
PGC_SU_BACKEND 
PGC_BACKEND 
PGC_SUSET 
PGC_USERSET 

Definition at line 71 of file guc.h.

72{
GucContext
Definition guc.h:72
@ PGC_SUSET
Definition guc.h:78
@ PGC_INTERNAL
Definition guc.h:73
@ PGC_USERSET
Definition guc.h:79
@ PGC_SU_BACKEND
Definition guc.h:76
@ PGC_POSTMASTER
Definition guc.h:74
@ PGC_SIGHUP
Definition guc.h:75
@ PGC_BACKEND
Definition guc.h:77

◆ GucSource

enum GucSource
Enumerator
PGC_S_DEFAULT 
PGC_S_DYNAMIC_DEFAULT 
PGC_S_ENV_VAR 
PGC_S_FILE 
PGC_S_ARGV 
PGC_S_GLOBAL 
PGC_S_DATABASE 
PGC_S_USER 
PGC_S_DATABASE_USER 
PGC_S_CLIENT 
PGC_S_OVERRIDE 
PGC_S_INTERACTIVE 
PGC_S_TEST 
PGC_S_SESSION 

Definition at line 111 of file guc.h.

112{
113 PGC_S_DEFAULT, /* hard-wired default ("boot_val") */
114 PGC_S_DYNAMIC_DEFAULT, /* default computed during initialization */
115 PGC_S_ENV_VAR, /* postmaster environment variable */
116 PGC_S_FILE, /* postgresql.conf */
117 PGC_S_ARGV, /* postmaster command line */
118 PGC_S_GLOBAL, /* global in-database setting */
119 PGC_S_DATABASE, /* per-database setting */
120 PGC_S_USER, /* per-user setting */
121 PGC_S_DATABASE_USER, /* per-user-and-database setting */
122 PGC_S_CLIENT, /* from client connection request */
123 PGC_S_OVERRIDE, /* special case to forcibly set default */
124 PGC_S_INTERACTIVE, /* dividing line for error reporting */
125 PGC_S_TEST, /* test per-database or per-user setting */
126 PGC_S_SESSION, /* SET command */
127} GucSource;
GucSource
Definition guc.h:112
@ PGC_S_DEFAULT
Definition guc.h:113
@ PGC_S_DYNAMIC_DEFAULT
Definition guc.h:114
@ PGC_S_FILE
Definition guc.h:116
@ PGC_S_GLOBAL
Definition guc.h:118
@ PGC_S_DATABASE
Definition guc.h:119
@ PGC_S_OVERRIDE
Definition guc.h:123
@ PGC_S_ARGV
Definition guc.h:117
@ PGC_S_SESSION
Definition guc.h:126
@ PGC_S_CLIENT
Definition guc.h:122
@ PGC_S_DATABASE_USER
Definition guc.h:121
@ PGC_S_ENV_VAR
Definition guc.h:115
@ PGC_S_USER
Definition guc.h:120
@ PGC_S_TEST
Definition guc.h:125
@ PGC_S_INTERACTIVE
Definition guc.h:124

Function Documentation

◆ AlterSystemSetConfigFile()

void AlterSystemSetConfigFile ( AlterSystemStmt altersysstmt)
extern

Definition at line 4508 of file guc.c.

4509{
4510 char *name;
4511 char *value;
4512 bool resetall = false;
4513 ConfigVariable *head = NULL;
4514 ConfigVariable *tail = NULL;
4515 volatile int Tmpfd;
4516 char AutoConfFileName[MAXPGPATH];
4517 char AutoConfTmpFileName[MAXPGPATH];
4518
4519 /*
4520 * Extract statement arguments
4521 */
4522 name = altersysstmt->setstmt->name;
4523
4524 if (!AllowAlterSystem)
4525 ereport(ERROR,
4526 (errcode(ERRCODE_FEATURE_NOT_SUPPORTED),
4527 errmsg("ALTER SYSTEM is not allowed in this environment")));
4528
4529 switch (altersysstmt->setstmt->kind)
4530 {
4531 case VAR_SET_VALUE:
4532 value = ExtractSetVariableArgs(altersysstmt->setstmt);
4533 break;
4534
4535 case VAR_SET_DEFAULT:
4536 case VAR_RESET:
4537 value = NULL;
4538 break;
4539
4540 case VAR_RESET_ALL:
4541 value = NULL;
4542 resetall = true;
4543 break;
4544
4545 default:
4546 elog(ERROR, "unrecognized alter system stmt type: %d",
4547 altersysstmt->setstmt->kind);
4548 break;
4549 }
4550
4551 /*
4552 * Check permission to run ALTER SYSTEM on the target variable
4553 */
4554 if (!superuser())
4555 {
4556 if (resetall)
4557 ereport(ERROR,
4558 (errcode(ERRCODE_INSUFFICIENT_PRIVILEGE),
4559 errmsg("permission denied to perform ALTER SYSTEM RESET ALL")));
4560 else
4561 {
4562 AclResult aclresult;
4563
4564 aclresult = pg_parameter_aclcheck(name, GetUserId(),
4566 if (aclresult != ACLCHECK_OK)
4567 ereport(ERROR,
4568 (errcode(ERRCODE_INSUFFICIENT_PRIVILEGE),
4569 errmsg("permission denied to set parameter \"%s\"",
4570 name)));
4571 }
4572 }
4573
4574 /*
4575 * Unless it's RESET_ALL, validate the target variable and value
4576 */
4577 if (!resetall)
4578 {
4579 struct config_generic *record;
4580
4581 /* We don't want to create a placeholder if there's not one already */
4582 record = find_option(name, false, true, DEBUG5);
4583 if (record != NULL)
4584 {
4585 /*
4586 * Don't allow parameters that can't be set in configuration files
4587 * to be set in PG_AUTOCONF_FILENAME file.
4588 */
4589 if ((record->context == PGC_INTERNAL) ||
4590 (record->flags & GUC_DISALLOW_IN_FILE) ||
4591 (record->flags & GUC_DISALLOW_IN_AUTO_FILE))
4592 ereport(ERROR,
4593 (errcode(ERRCODE_CANT_CHANGE_RUNTIME_PARAM),
4594 errmsg("parameter \"%s\" cannot be changed",
4595 name)));
4596
4597 /*
4598 * If a value is specified, verify that it's sane.
4599 */
4600 if (value)
4601 {
4602 union config_var_val newval;
4603 void *newextra = NULL;
4604
4605 if (!parse_and_validate_value(record, value,
4607 &newval, &newextra))
4608 ereport(ERROR,
4609 (errcode(ERRCODE_INVALID_PARAMETER_VALUE),
4610 errmsg("invalid value for parameter \"%s\": \"%s\"",
4611 name, value)));
4612
4613 if (record->vartype == PGC_STRING && newval.stringval != NULL)
4614 guc_free(newval.stringval);
4615 guc_free(newextra);
4616 }
4617 }
4618 else
4619 {
4620 /*
4621 * Variable not known; check we'd be allowed to create it. (We
4622 * cannot validate the value, but that's fine. A non-core GUC in
4623 * the config file cannot cause postmaster start to fail, so we
4624 * don't have to be too tense about possibly installing a bad
4625 * value.)
4626 *
4627 * As an exception, we skip this check if this is a RESET command
4628 * for an unknown custom GUC, else there'd be no way for users to
4629 * remove such settings with reserved prefixes.
4630 */
4633 }
4634
4635 /*
4636 * We must also reject values containing newlines, because the grammar
4637 * for config files doesn't support embedded newlines in string
4638 * literals.
4639 */
4640 if (value && strchr(value, '\n'))
4641 ereport(ERROR,
4642 (errcode(ERRCODE_INVALID_PARAMETER_VALUE),
4643 errmsg("parameter value for ALTER SYSTEM must not contain a newline")));
4644 }
4645
4646 /*
4647 * PG_AUTOCONF_FILENAME and its corresponding temporary file are always in
4648 * the data directory, so we can reference them by simple relative paths.
4649 */
4650 snprintf(AutoConfFileName, sizeof(AutoConfFileName), "%s",
4652 snprintf(AutoConfTmpFileName, sizeof(AutoConfTmpFileName), "%s.%s",
4653 AutoConfFileName,
4654 "tmp");
4655
4656 /*
4657 * Only one backend is allowed to operate on PG_AUTOCONF_FILENAME at a
4658 * time. Use AutoFileLock to ensure that. We must hold the lock while
4659 * reading the old file contents.
4660 */
4661 LWLockAcquire(AutoFileLock, LW_EXCLUSIVE);
4662
4663 /*
4664 * If we're going to reset everything, then no need to open or parse the
4665 * old file. We'll just write out an empty list.
4666 */
4667 if (!resetall)
4668 {
4669 struct stat st;
4670
4671 if (stat(AutoConfFileName, &st) == 0)
4672 {
4673 /* open old file PG_AUTOCONF_FILENAME */
4674 FILE *infile;
4675
4676 infile = AllocateFile(AutoConfFileName, "r");
4677 if (infile == NULL)
4678 ereport(ERROR,
4680 errmsg("could not open file \"%s\": %m",
4681 AutoConfFileName)));
4682
4683 /* parse it */
4684 if (!ParseConfigFp(infile, AutoConfFileName, CONF_FILE_START_DEPTH,
4685 LOG, &head, &tail))
4686 ereport(ERROR,
4687 (errcode(ERRCODE_CONFIG_FILE_ERROR),
4688 errmsg("could not parse contents of file \"%s\"",
4689 AutoConfFileName)));
4690
4692 }
4693
4694 /*
4695 * Now, replace any existing entry with the new value, or add it if
4696 * not present.
4697 */
4698 replace_auto_config_value(&head, &tail, name, value);
4699 }
4700
4701 /*
4702 * Invoke the post-alter hook for setting this GUC variable. GUCs
4703 * typically do not have corresponding entries in pg_parameter_acl, so we
4704 * call the hook using the name rather than a potentially-non-existent
4705 * OID. Nonetheless, we pass ParameterAclRelationId so that this call
4706 * context can be distinguished from others. (Note that "name" will be
4707 * NULL in the RESET ALL case.)
4708 *
4709 * We do this here rather than at the end, because ALTER SYSTEM is not
4710 * transactional. If the hook aborts our transaction, it will be cleaner
4711 * to do so before we touch any files.
4712 */
4713 InvokeObjectPostAlterHookArgStr(ParameterAclRelationId, name,
4715 altersysstmt->setstmt->kind,
4716 false);
4717
4718 /*
4719 * To ensure crash safety, first write the new file data to a temp file,
4720 * then atomically rename it into place.
4721 *
4722 * If there is a temp file left over due to a previous crash, it's okay to
4723 * truncate and reuse it.
4724 */
4725 Tmpfd = BasicOpenFile(AutoConfTmpFileName,
4726 O_CREAT | O_RDWR | O_TRUNC);
4727 if (Tmpfd < 0)
4728 ereport(ERROR,
4730 errmsg("could not open file \"%s\": %m",
4731 AutoConfTmpFileName)));
4732
4733 /*
4734 * Use a TRY block to clean up the file if we fail. Since we need a TRY
4735 * block anyway, OK to use BasicOpenFile rather than OpenTransientFile.
4736 */
4737 PG_TRY();
4738 {
4739 /* Write and sync the new contents to the temporary file */
4740 write_auto_conf_file(Tmpfd, AutoConfTmpFileName, head);
4741
4742 /* Close before renaming; may be required on some platforms */
4743 close(Tmpfd);
4744 Tmpfd = -1;
4745
4746 /*
4747 * As the rename is atomic operation, if any problem occurs after this
4748 * at worst it can lose the parameters set by last ALTER SYSTEM
4749 * command.
4750 */
4751 durable_rename(AutoConfTmpFileName, AutoConfFileName, ERROR);
4752 }
4753 PG_CATCH();
4754 {
4755 /* Close file first, else unlink might fail on some platforms */
4756 if (Tmpfd >= 0)
4757 close(Tmpfd);
4758
4759 /* Unlink, but ignore any error */
4760 (void) unlink(AutoConfTmpFileName);
4761
4762 PG_RE_THROW();
4763 }
4764 PG_END_TRY();
4765
4766 FreeConfigVariables(head);
4767
4768 LWLockRelease(AutoFileLock);
4769}
AclResult
Definition acl.h:183
@ ACLCHECK_OK
Definition acl.h:184
AclResult pg_parameter_aclcheck(const char *name, Oid roleid, AclMode mode)
Definition aclchk.c:4107
#define CONF_FILE_START_DEPTH
Definition conffiles.h:17
int errcode_for_file_access(void)
Definition elog.c:898
int errcode(int sqlerrcode)
Definition elog.c:875
#define LOG
Definition elog.h:32
#define PG_RE_THROW()
Definition elog.h:407
#define PG_TRY(...)
Definition elog.h:374
#define PG_END_TRY(...)
Definition elog.h:399
#define ERROR
Definition elog.h:40
#define PG_CATCH(...)
Definition elog.h:384
#define elog(elevel,...)
Definition elog.h:228
#define ereport(elevel,...)
Definition elog.h:152
#define DEBUG5
Definition elog.h:27
int durable_rename(const char *oldfile, const char *newfile, int elevel)
Definition fd.c:783
int BasicOpenFile(const char *fileName, int fileFlags)
Definition fd.c:1090
int FreeFile(FILE *file)
Definition fd.c:2827
FILE * AllocateFile(const char *name, const char *mode)
Definition fd.c:2628
void FreeConfigVariables(ConfigVariable *list)
Definition guc-file.l:617
bool ParseConfigFp(FILE *fp, const char *config_file, int depth, int elevel, ConfigVariable **head_p, ConfigVariable **tail_p)
Definition guc-file.l:350
static bool assignable_custom_variable_name(const char *name, bool skip_errors, int elevel)
Definition guc.c:1002
void guc_free(void *ptr)
Definition guc.c:688
static bool valid_custom_variable_name(const char *name)
Definition guc.c:957
static void write_auto_conf_file(int fd, const char *filename, ConfigVariable *head)
Definition guc.c:4371
#define newval
struct config_generic * find_option(const char *name, bool create_placeholders, bool skip_errors, int elevel)
Definition guc.c:1114
static bool parse_and_validate_value(const struct config_generic *record, const char *value, GucSource source, int elevel, union config_var_val *newval, void **newextra)
Definition guc.c:3028
static void replace_auto_config_value(ConfigVariable **head_p, ConfigVariable **tail_p, const char *name, const char *value)
Definition guc.c:4438
#define GUC_DISALLOW_IN_FILE
Definition guc.h:222
#define GUC_DISALLOW_IN_AUTO_FILE
Definition guc.h:227
char * ExtractSetVariableArgs(VariableSetStmt *stmt)
Definition guc_funcs.c:169
bool AllowAlterSystem
Definition guc_tables.c:534
@ PGC_STRING
Definition guc_tables.h:28
static struct @177 value
#define close(a)
Definition win32.h:12
bool LWLockAcquire(LWLock *lock, LWLockMode mode)
Definition lwlock.c:1150
void LWLockRelease(LWLock *lock)
Definition lwlock.c:1767
@ LW_EXCLUSIVE
Definition lwlock.h:104
Oid GetUserId(void)
Definition miscinit.c:470
static char * errmsg
#define InvokeObjectPostAlterHookArgStr(classId, objectName, subId, auxiliaryId, is_internal)
@ VAR_SET_DEFAULT
@ VAR_RESET
@ VAR_SET_VALUE
@ VAR_RESET_ALL
#define ACL_ALTER_SYSTEM
Definition parsenodes.h:89
#define MAXPGPATH
#define PG_AUTOCONF_FILENAME
#define snprintf
Definition port.h:260
VariableSetStmt * setstmt
VariableSetKind kind
GucContext context
Definition guc_tables.h:254
enum config_type vartype
Definition guc_tables.h:259
bool superuser(void)
Definition superuser.c:47
const char * name
#define stat
Definition win32_port.h:74
static void infile(const char *name)
Definition zic.c:1257

References ACL_ALTER_SYSTEM, ACLCHECK_OK, AllocateFile(), AllowAlterSystem, assignable_custom_variable_name(), BasicOpenFile(), close, CONF_FILE_START_DEPTH, config_generic::context, DEBUG5, durable_rename(), elog, ereport, errcode(), errcode_for_file_access(), errmsg, ERROR, ExtractSetVariableArgs(), find_option(), config_generic::flags, FreeConfigVariables(), FreeFile(), GetUserId(), GUC_DISALLOW_IN_AUTO_FILE, GUC_DISALLOW_IN_FILE, guc_free(), infile(), InvokeObjectPostAlterHookArgStr, VariableSetStmt::kind, LOG, LW_EXCLUSIVE, LWLockAcquire(), LWLockRelease(), MAXPGPATH, name, VariableSetStmt::name, newval, parse_and_validate_value(), ParseConfigFp(), PG_AUTOCONF_FILENAME, PG_CATCH, PG_END_TRY, pg_parameter_aclcheck(), PG_RE_THROW, PG_TRY, PGC_INTERNAL, PGC_S_FILE, PGC_STRING, replace_auto_config_value(), AlterSystemStmt::setstmt, snprintf, stat, superuser(), valid_custom_variable_name(), value, VAR_RESET, VAR_RESET_ALL, VAR_SET_DEFAULT, VAR_SET_VALUE, config_generic::vartype, and write_auto_conf_file().

Referenced by standard_ProcessUtility().

◆ AtEOXact_GUC()

void AtEOXact_GUC ( bool  isCommit,
int  nestLevel 
)
extern

Definition at line 2169 of file guc.c.

2170{
2171 slist_mutable_iter iter;
2172
2173 /*
2174 * Note: it's possible to get here with GUCNestLevel == nestLevel-1 during
2175 * abort, if there is a failure during transaction start before
2176 * AtStart_GUC is called.
2177 */
2178 Assert(nestLevel > 0 &&
2179 (nestLevel <= GUCNestLevel ||
2180 (nestLevel == GUCNestLevel + 1 && !isCommit)));
2181
2182 /* We need only process GUCs having nonempty stacks */
2184 {
2185 struct config_generic *gconf = slist_container(struct config_generic,
2186 stack_link, iter.cur);
2187 GucStack *stack;
2188
2189 /*
2190 * Process and pop each stack entry within the nest level. To simplify
2191 * fmgr_security_definer() and other places that use GUC_ACTION_SAVE,
2192 * we allow failure exit from code that uses a local nest level to be
2193 * recovered at the surrounding transaction or subtransaction abort;
2194 * so there could be more than one stack entry to pop.
2195 */
2196 while ((stack = gconf->stack) != NULL &&
2197 stack->nest_level >= nestLevel)
2198 {
2199 GucStack *prev = stack->prev;
2200 bool restorePrior = false;
2201 bool restoreMasked = false;
2202 bool changed;
2203
2204 /*
2205 * In this next bit, if we don't set either restorePrior or
2206 * restoreMasked, we must "discard" any unwanted fields of the
2207 * stack entries to avoid leaking memory. If we do set one of
2208 * those flags, unused fields will be cleaned up after restoring.
2209 */
2210 if (!isCommit) /* if abort, always restore prior value */
2211 restorePrior = true;
2212 else if (stack->state == GUC_SAVE)
2213 restorePrior = true;
2214 else if (stack->nest_level == 1)
2215 {
2216 /* transaction commit */
2217 if (stack->state == GUC_SET_LOCAL)
2218 restoreMasked = true;
2219 else if (stack->state == GUC_SET)
2220 {
2221 /* we keep the current active value */
2223 }
2224 else /* must be GUC_LOCAL */
2225 restorePrior = true;
2226 }
2227 else if (prev == NULL ||
2228 prev->nest_level < stack->nest_level - 1)
2229 {
2230 /* decrement entry's level and do not pop it */
2231 stack->nest_level--;
2232 continue;
2233 }
2234 else
2235 {
2236 /*
2237 * We have to merge this stack entry into prev. See README for
2238 * discussion of this bit.
2239 */
2240 switch (stack->state)
2241 {
2242 case GUC_SAVE:
2243 Assert(false); /* can't get here */
2244 break;
2245
2246 case GUC_SET:
2247 /* next level always becomes SET */
2249 if (prev->state == GUC_SET_LOCAL)
2250 discard_stack_value(gconf, &prev->masked);
2251 prev->state = GUC_SET;
2252 break;
2253
2254 case GUC_LOCAL:
2255 if (prev->state == GUC_SET)
2256 {
2257 /* LOCAL migrates down */
2259 prev->masked_srole = stack->srole;
2260 prev->masked = stack->prior;
2261 prev->state = GUC_SET_LOCAL;
2262 }
2263 else
2264 {
2265 /* else just forget this stack level */
2267 }
2268 break;
2269
2270 case GUC_SET_LOCAL:
2271 /* prior state at this level no longer wanted */
2273 /* copy down the masked state */
2276 if (prev->state == GUC_SET_LOCAL)
2277 discard_stack_value(gconf, &prev->masked);
2278 prev->masked = stack->masked;
2279 prev->state = GUC_SET_LOCAL;
2280 break;
2281 }
2282 }
2283
2284 changed = false;
2285
2286 if (restorePrior || restoreMasked)
2287 {
2288 /* Perform appropriate restoration of the stacked value */
2289 config_var_value newvalue;
2290 GucSource newsource;
2291 GucContext newscontext;
2292 Oid newsrole;
2293
2294 if (restoreMasked)
2295 {
2296 newvalue = stack->masked;
2297 newsource = PGC_S_SESSION;
2298 newscontext = stack->masked_scontext;
2299 newsrole = stack->masked_srole;
2300 }
2301 else
2302 {
2303 newvalue = stack->prior;
2304 newsource = stack->source;
2305 newscontext = stack->scontext;
2306 newsrole = stack->srole;
2307 }
2308
2309 switch (gconf->vartype)
2310 {
2311 case PGC_BOOL:
2312 {
2313 struct config_bool *conf = &gconf->_bool;
2314 bool newval = newvalue.val.boolval;
2315 void *newextra = newvalue.extra;
2316
2317 if (*conf->variable != newval ||
2318 gconf->extra != newextra)
2319 {
2320 if (conf->assign_hook)
2321 conf->assign_hook(newval, newextra);
2322 *conf->variable = newval;
2323 set_extra_field(gconf, &gconf->extra,
2324 newextra);
2325 changed = true;
2326 }
2327 break;
2328 }
2329 case PGC_INT:
2330 {
2331 struct config_int *conf = &gconf->_int;
2332 int newval = newvalue.val.intval;
2333 void *newextra = newvalue.extra;
2334
2335 if (*conf->variable != newval ||
2336 gconf->extra != newextra)
2337 {
2338 if (conf->assign_hook)
2339 conf->assign_hook(newval, newextra);
2340 *conf->variable = newval;
2341 set_extra_field(gconf, &gconf->extra,
2342 newextra);
2343 changed = true;
2344 }
2345 break;
2346 }
2347 case PGC_REAL:
2348 {
2349 struct config_real *conf = &gconf->_real;
2350 double newval = newvalue.val.realval;
2351 void *newextra = newvalue.extra;
2352
2353 if (*conf->variable != newval ||
2354 gconf->extra != newextra)
2355 {
2356 if (conf->assign_hook)
2357 conf->assign_hook(newval, newextra);
2358 *conf->variable = newval;
2359 set_extra_field(gconf, &gconf->extra,
2360 newextra);
2361 changed = true;
2362 }
2363 break;
2364 }
2365 case PGC_STRING:
2366 {
2367 struct config_string *conf = &gconf->_string;
2368 char *newval = newvalue.val.stringval;
2369 void *newextra = newvalue.extra;
2370
2371 if (*conf->variable != newval ||
2372 gconf->extra != newextra)
2373 {
2374 if (conf->assign_hook)
2375 conf->assign_hook(newval, newextra);
2376 set_string_field(gconf, conf->variable, newval);
2377 set_extra_field(gconf, &gconf->extra,
2378 newextra);
2379 changed = true;
2380 }
2381
2382 /*
2383 * Release stacked values if not used anymore. We
2384 * could use discard_stack_value() here, but since
2385 * we have type-specific code anyway, might as
2386 * well inline it.
2387 */
2388 set_string_field(gconf, &stack->prior.val.stringval, NULL);
2389 set_string_field(gconf, &stack->masked.val.stringval, NULL);
2390 break;
2391 }
2392 case PGC_ENUM:
2393 {
2394 struct config_enum *conf = &gconf->_enum;
2395 int newval = newvalue.val.enumval;
2396 void *newextra = newvalue.extra;
2397
2398 if (*conf->variable != newval ||
2399 gconf->extra != newextra)
2400 {
2401 if (conf->assign_hook)
2402 conf->assign_hook(newval, newextra);
2403 *conf->variable = newval;
2404 set_extra_field(gconf, &gconf->extra,
2405 newextra);
2406 changed = true;
2407 }
2408 break;
2409 }
2410 }
2411
2412 /*
2413 * Release stacked extra values if not used anymore.
2414 */
2415 set_extra_field(gconf, &(stack->prior.extra), NULL);
2416 set_extra_field(gconf, &(stack->masked.extra), NULL);
2417
2418 /* And restore source information */
2419 set_guc_source(gconf, newsource);
2420 gconf->scontext = newscontext;
2421 gconf->srole = newsrole;
2422 }
2423
2424 /*
2425 * Pop the GUC's state stack; if it's now empty, remove the GUC
2426 * from guc_stack_list.
2427 */
2428 gconf->stack = prev;
2429 if (prev == NULL)
2430 slist_delete_current(&iter);
2431 pfree(stack);
2432
2433 /* Report new value if we changed it */
2434 if (changed && (gconf->flags & GUC_REPORT) &&
2435 !(gconf->status & GUC_NEEDS_REPORT))
2436 {
2437 gconf->status |= GUC_NEEDS_REPORT;
2439 }
2440 } /* end of stack-popping loop */
2441 }
2442
2443 /* Update nesting level */
2444 GUCNestLevel = nestLevel - 1;
2445}
#define Assert(condition)
Definition c.h:943
static slist_head guc_report_list
Definition guc.c:228
static void set_string_field(struct config_generic *conf, char **field, char *newval)
Definition guc.c:728
static int GUCNestLevel
Definition guc.c:233
static void discard_stack_value(struct config_generic *gconf, config_var_value *val)
Definition guc.c:814
static slist_head guc_stack_list
Definition guc.c:226
static void set_guc_source(struct config_generic *gconf, GucSource newsource)
Definition guc.c:2018
static void set_extra_field(struct config_generic *gconf, void **field, void *newval)
Definition guc.c:766
#define GUC_REPORT
Definition guc.h:220
@ GUC_SET_LOCAL
Definition guc_tables.h:118
@ GUC_SET
Definition guc_tables.h:116
@ GUC_SAVE
Definition guc_tables.h:115
@ GUC_LOCAL
Definition guc_tables.h:117
#define GUC_NEEDS_REPORT
Definition guc_tables.h:301
@ PGC_BOOL
Definition guc_tables.h:25
@ PGC_ENUM
Definition guc_tables.h:29
@ PGC_REAL
Definition guc_tables.h:27
@ PGC_INT
Definition guc_tables.h:26
static void slist_delete_current(slist_mutable_iter *iter)
Definition ilist.h:1084
#define slist_foreach_modify(iter, lhead)
Definition ilist.h:1148
static void slist_push_head(slist_head *head, slist_node *node)
Definition ilist.h:1006
#define slist_container(type, membername, ptr)
Definition ilist.h:1106
void pfree(void *pointer)
Definition mcxt.c:1616
unsigned int Oid
bool * variable
Definition guc_tables.h:142
GucBoolAssignHook assign_hook
Definition guc_tables.h:145
int * variable
Definition guc_tables.h:204
GucEnumAssignHook assign_hook
Definition guc_tables.h:208
struct config_bool _bool
Definition guc_tables.h:286
GucContext scontext
Definition guc_tables.h:264
struct config_string _string
Definition guc_tables.h:289
struct config_real _real
Definition guc_tables.h:288
slist_node stack_link
Definition guc_tables.h:273
struct config_int _int
Definition guc_tables.h:287
GucStack * stack
Definition guc_tables.h:268
slist_node report_link
Definition guc_tables.h:275
struct config_enum _enum
Definition guc_tables.h:290
GucIntAssignHook assign_hook
Definition guc_tables.h:159
int * variable
Definition guc_tables.h:154
GucRealAssignHook assign_hook
Definition guc_tables.h:173
double * variable
Definition guc_tables.h:168
GucStringAssignHook assign_hook
Definition guc_tables.h:195
char ** variable
Definition guc_tables.h:192
union config_var_val val
Definition guc_tables.h:47
struct guc_stack * prev
Definition guc_tables.h:123
Oid masked_srole
Definition guc_tables.h:131
int nest_level
Definition guc_tables.h:124
config_var_value masked
Definition guc_tables.h:133
config_var_value prior
Definition guc_tables.h:132
GucContext scontext
Definition guc_tables.h:128
GucStackState state
Definition guc_tables.h:125
GucSource source
Definition guc_tables.h:126
GucContext masked_scontext
Definition guc_tables.h:129
slist_node * cur
Definition ilist.h:274
char * stringval
Definition guc_tables.h:37

References config_generic::_bool, config_generic::_enum, config_generic::_int, config_generic::_real, config_generic::_string, Assert, config_bool::assign_hook, config_int::assign_hook, config_real::assign_hook, config_string::assign_hook, config_enum::assign_hook, config_var_val::boolval, slist_mutable_iter::cur, discard_stack_value(), config_var_val::enumval, config_var_value::extra, config_generic::extra, config_generic::flags, GUC_LOCAL, GUC_NEEDS_REPORT, GUC_REPORT, guc_report_list, GUC_SAVE, GUC_SET, GUC_SET_LOCAL, guc_stack_list, GUCNestLevel, config_var_val::intval, guc_stack::masked, guc_stack::masked_scontext, guc_stack::masked_srole, guc_stack::nest_level, newval, pfree(), PGC_BOOL, PGC_ENUM, PGC_INT, PGC_REAL, PGC_S_SESSION, PGC_STRING, guc_stack::prev, guc_stack::prior, config_var_val::realval, config_generic::report_link, guc_stack::scontext, config_generic::scontext, set_extra_field(), set_guc_source(), set_string_field(), slist_container, slist_delete_current(), slist_foreach_modify, slist_push_head(), guc_stack::source, guc_stack::srole, config_generic::srole, config_generic::stack, config_generic::stack_link, guc_stack::state, config_generic::status, config_var_val::stringval, config_var_value::val, config_bool::variable, config_int::variable, config_real::variable, config_string::variable, config_enum::variable, and config_generic::vartype.

Referenced by AbortSubTransaction(), AbortTransaction(), amcheck_lock_relation_and_check(), ATExecMergePartitions(), ATExecSplitPartition(), brin_summarize_range(), cluster_rel(), CommitSubTransaction(), CommitTransaction(), ComputeIndexAttrs(), CreateSchemaCommand(), DefineIndex(), do_analyze_rel(), execute_extension_script(), fmgr_security_definer(), index_build(), index_concurrently_build(), PrepareTransaction(), ProcedureCreate(), RefreshMatViewByOid(), reindex_index(), ReindexRelationConcurrently(), reset_transmission_modes(), restoreLocalGucs(), RestoreUserContext(), RI_Initial_Check(), RI_PartitionRemove_Check(), test_plan_advice_advisor(), vacuum_rel(), and validate_index().

◆ AtStart_GUC()

void AtStart_GUC ( void  )
extern

Definition at line 2122 of file guc.c.

2123{
2124 /*
2125 * The nest level should be 0 between transactions; if it isn't, somebody
2126 * didn't call AtEOXact_GUC, or called it with the wrong nestLevel. We
2127 * throw a warning but make no other effort to clean up.
2128 */
2129 if (GUCNestLevel != 0)
2130 elog(WARNING, "GUC nest level = %d at transaction start",
2131 GUCNestLevel);
2132 GUCNestLevel = 1;
2133}
#define WARNING
Definition elog.h:37

References elog, GUCNestLevel, and WARNING.

Referenced by StartTransaction().

◆ BeginReportingGUCOptions()

void BeginReportingGUCOptions ( void  )
extern

Definition at line 2453 of file guc.c.

2454{
2455 HASH_SEQ_STATUS status;
2456 GUCHashEntry *hentry;
2457
2458 /*
2459 * Don't do anything unless talking to an interactive frontend.
2460 */
2462 return;
2463
2464 reporting_enabled = true;
2465
2466 /*
2467 * Hack for in_hot_standby: set the GUC value true if appropriate. This
2468 * is kind of an ugly place to do it, but there's few better options.
2469 *
2470 * (This could be out of date by the time we actually send it, in which
2471 * case the next ReportChangedGUCOptions call will send a duplicate
2472 * report.)
2473 */
2474 if (RecoveryInProgress())
2475 SetConfigOption("in_hot_standby", "true",
2477
2478 /* Transmit initial values of interesting variables */
2479 hash_seq_init(&status, guc_hashtab);
2480 while ((hentry = (GUCHashEntry *) hash_seq_search(&status)) != NULL)
2481 {
2482 struct config_generic *conf = hentry->gucvar;
2483
2484 if (conf->flags & GUC_REPORT)
2485 ReportGUCOption(conf);
2486 }
2487}
@ DestRemote
Definition dest.h:89
void * hash_seq_search(HASH_SEQ_STATUS *status)
Definition dynahash.c:1352
void hash_seq_init(HASH_SEQ_STATUS *status, HTAB *hashp)
Definition dynahash.c:1317
static void ReportGUCOption(struct config_generic *record)
Definition guc.c:2541
void SetConfigOption(const char *name, const char *value, GucContext context, GucSource source)
Definition guc.c:4234
static HTAB * guc_hashtab
Definition guc.c:214
static bool reporting_enabled
Definition guc.c:231
CommandDest whereToSendOutput
Definition postgres.c:97
struct config_generic * gucvar
Definition guc.c:211
bool RecoveryInProgress(void)
Definition xlog.c:6830

References DestRemote, config_generic::flags, guc_hashtab, GUC_REPORT, GUCHashEntry::gucvar, hash_seq_init(), hash_seq_search(), PGC_INTERNAL, PGC_S_OVERRIDE, RecoveryInProgress(), ReportGUCOption(), reporting_enabled, SetConfigOption(), and whereToSendOutput.

Referenced by PostgresMain().

◆ check_GUC_name_for_parameter_acl()

void check_GUC_name_for_parameter_acl ( const char *  name)
extern

Definition at line 1288 of file guc.c.

1289{
1290 /* OK if the GUC exists. */
1291 if (find_option(name, false, true, DEBUG5) != NULL)
1292 return;
1293 /* Otherwise, it'd better be a valid custom GUC name. */
1295}

References assignable_custom_variable_name(), DEBUG5, ERROR, find_option(), and name.

Referenced by ParameterAclCreate().

◆ convert_GUC_name_for_parameter_acl()

char * convert_GUC_name_for_parameter_acl ( const char *  name)
extern

Definition at line 1252 of file guc.c.

1253{
1254 char *result;
1255
1256 /* Apply old-GUC-name mapping. */
1257 for (int i = 0; map_old_guc_names[i] != NULL; i += 2)
1258 {
1260 {
1261 name = map_old_guc_names[i + 1];
1262 break;
1263 }
1264 }
1265
1266 /* Apply case-folding that matches guc_name_compare(). */
1267 result = pstrdup(name);
1268 for (char *ptr = result; *ptr != '\0'; ptr++)
1269 {
1270 char ch = *ptr;
1271
1272 if (ch >= 'A' && ch <= 'Z')
1273 {
1274 ch += 'a' - 'A';
1275 *ptr = ch;
1276 }
1277 }
1278
1279 return result;
1280}
uint32 result
static const char *const map_old_guc_names[]
Definition guc.c:192
int guc_name_compare(const char *namea, const char *nameb)
Definition guc.c:1178
int i
Definition isn.c:77
char * pstrdup(const char *in)
Definition mcxt.c:1781

References guc_name_compare(), i, map_old_guc_names, name, pstrdup(), and result.

Referenced by ParameterAclCreate(), ParameterAclLookup(), and pg_parameter_aclmask().

◆ DeescapeQuotedString()

char * DeescapeQuotedString ( const char *  s)
extern

Definition at line 661 of file guc-file.l.

662{
663 char *newStr;
664 int len,
665 i,
666 j;
667
668 /* We just Assert that there are leading and trailing quotes */
669 Assert(s != NULL && s[0] == '\'');
670 len = strlen(s);
671 Assert(len >= 2);
672 Assert(s[len - 1] == '\'');
673
674 /* Skip the leading quote; we'll handle the trailing quote below */
675 s++, len--;
676
677 /* Since len still includes trailing quote, this is enough space */
678 newStr = palloc(len);
679
680 for (i = 0, j = 0; i < len; i++)
681 {
682 if (s[i] == '\\')
683 {
684 i++;
685 switch (s[i])
686 {
687 case 'b':
688 newStr[j] = '\b';
689 break;
690 case 'f':
691 newStr[j] = '\f';
692 break;
693 case 'n':
694 newStr[j] = '\n';
695 break;
696 case 'r':
697 newStr[j] = '\r';
698 break;
699 case 't':
700 newStr[j] = '\t';
701 break;
702 case '0':
703 case '1':
704 case '2':
705 case '3':
706 case '4':
707 case '5':
708 case '6':
709 case '7':
710 {
711 int k;
712 long octVal = 0;
713
714 for (k = 0;
715 s[i + k] >= '0' && s[i + k] <= '7' && k < 3;
716 k++)
717 octVal = (octVal << 3) + (s[i + k] - '0');
718 i += k - 1;
719 newStr[j] = ((char) octVal);
720 }
721 break;
722 default:
723 newStr[j] = s[i];
724 break;
725 } /* switch */
726 }
727 else if (s[i] == '\'' && s[i + 1] == '\'')
728 {
729 /* doubled quote becomes just one quote */
730 newStr[j] = s[++i];
731 }
732 else
733 newStr[j] = s[i];
734 j++;
735 }
736
737 /* We copied the ending quote to newStr, so replace with \0 */
738 Assert(j > 0 && j <= len);
739 newStr[--j] = '\0';
740
741 return newStr;
742}
int j
Definition isn.c:78
void * palloc(Size size)
Definition mcxt.c:1387
const void size_t len

References Assert, i, j, len, and palloc().

Referenced by ParseConfigFp().

◆ DefineCustomBoolVariable()

void DefineCustomBoolVariable ( const char *  name,
const char *  short_desc,
const char *  long_desc,
bool *  valueAddr,
bool  bootValue,
GucContext  context,
int  flags,
GucBoolCheckHook  check_hook,
GucBoolAssignHook  assign_hook,
GucShowHook  show_hook 
)
extern

◆ DefineCustomEnumVariable()

void void void void void DefineCustomEnumVariable ( const char *  name,
const char *  short_desc,
const char *  long_desc,
int *  valueAddr,
int  bootValue,
const struct config_enum_entry options,
GucContext  context,
int  flags,
GucEnumCheckHook  check_hook,
GucEnumAssignHook  assign_hook,
GucShowHook  show_hook 
)
extern

◆ DefineCustomIntVariable()

void void DefineCustomIntVariable ( const char *  name,
const char *  short_desc,
const char *  long_desc,
int *  valueAddr,
int  bootValue,
int  minValue,
int  maxValue,
GucContext  context,
int  flags,
GucIntCheckHook  check_hook,
GucIntAssignHook  assign_hook,
GucShowHook  show_hook 
)
extern

◆ DefineCustomRealVariable()

void void void DefineCustomRealVariable ( const char *  name,
const char *  short_desc,
const char *  long_desc,
double *  valueAddr,
double  bootValue,
double  minValue,
double  maxValue,
GucContext  context,
int  flags,
GucRealCheckHook  check_hook,
GucRealAssignHook  assign_hook,
GucShowHook  show_hook 
)
extern

◆ DefineCustomStringVariable()

void void void void DefineCustomStringVariable ( const char *  name,
const char *  short_desc,
const char *  long_desc,
char **  valueAddr,
const char *  bootValue,
GucContext  context,
int  flags,
GucStringCheckHook  check_hook,
GucStringAssignHook  assign_hook,
GucShowHook  show_hook 
)
extern

◆ EstimateGUCStateSpace()

Size EstimateGUCStateSpace ( void  )
extern

Definition at line 5855 of file guc.c.

5856{
5857 Size size;
5858 dlist_iter iter;
5859
5860 /* Add space reqd for saving the data size of the guc state */
5861 size = sizeof(Size);
5862
5863 /*
5864 * Add up the space needed for each GUC variable.
5865 *
5866 * We need only process non-default GUCs.
5867 */
5869 {
5870 struct config_generic *gconf = dlist_container(struct config_generic,
5871 nondef_link, iter.cur);
5872
5873 size = add_size(size, estimate_variable_size(gconf));
5874 }
5875
5876 return size;
5877}
size_t Size
Definition c.h:689
static dlist_head guc_nondef_list
Definition guc.c:224
static Size estimate_variable_size(struct config_generic *gconf)
Definition guc.c:5755
#define dlist_foreach(iter, lhead)
Definition ilist.h:623
#define dlist_container(type, membername, ptr)
Definition ilist.h:593
Size add_size(Size s1, Size s2)
Definition shmem.c:1048
dlist_node nondef_link
Definition guc_tables.h:271
dlist_node * cur
Definition ilist.h:179

References add_size(), dlist_iter::cur, dlist_container, dlist_foreach, estimate_variable_size(), guc_nondef_list, and config_generic::nondef_link.

Referenced by InitializeParallelDSM().

◆ ExecSetVariableStmt()

void ExecSetVariableStmt ( VariableSetStmt stmt,
bool  isTopLevel 
)
extern

Definition at line 45 of file guc_funcs.c.

46{
48
49 /*
50 * Workers synchronize these parameters at the start of the parallel
51 * operation; then, we block SET during the operation.
52 */
53 if (IsInParallelMode())
55 (errcode(ERRCODE_INVALID_TRANSACTION_STATE),
56 errmsg("cannot set parameters during a parallel operation")));
57
58 switch (stmt->kind)
59 {
60 case VAR_SET_VALUE:
61 case VAR_SET_CURRENT:
62 if (stmt->is_local)
63 WarnNoTransactionBlock(isTopLevel, "SET LOCAL");
64 (void) set_config_option(stmt->name,
68 action, true, 0, false);
69 break;
70 case VAR_SET_MULTI:
71
72 /*
73 * Special-case SQL syntaxes. The TRANSACTION and SESSION
74 * CHARACTERISTICS cases effectively set more than one variable
75 * per statement. TRANSACTION SNAPSHOT only takes one argument,
76 * but we put it here anyway since it's a special case and not
77 * related to any GUC variable.
78 */
79 if (strcmp(stmt->name, "TRANSACTION") == 0)
80 {
81 ListCell *head;
82
83 WarnNoTransactionBlock(isTopLevel, "SET TRANSACTION");
84
85 foreach(head, stmt->args)
86 {
87 DefElem *item = (DefElem *) lfirst(head);
88
89 if (strcmp(item->defname, "transaction_isolation") == 0)
90 SetPGVariable("transaction_isolation",
91 list_make1(item->arg), stmt->is_local);
92 else if (strcmp(item->defname, "transaction_read_only") == 0)
93 SetPGVariable("transaction_read_only",
94 list_make1(item->arg), stmt->is_local);
95 else if (strcmp(item->defname, "transaction_deferrable") == 0)
96 SetPGVariable("transaction_deferrable",
97 list_make1(item->arg), stmt->is_local);
98 else
99 elog(ERROR, "unexpected SET TRANSACTION element: %s",
100 item->defname);
101 }
102 }
103 else if (strcmp(stmt->name, "SESSION CHARACTERISTICS") == 0)
104 {
105 ListCell *head;
106
107 foreach(head, stmt->args)
108 {
109 DefElem *item = (DefElem *) lfirst(head);
110
111 if (strcmp(item->defname, "transaction_isolation") == 0)
112 SetPGVariable("default_transaction_isolation",
113 list_make1(item->arg), stmt->is_local);
114 else if (strcmp(item->defname, "transaction_read_only") == 0)
115 SetPGVariable("default_transaction_read_only",
116 list_make1(item->arg), stmt->is_local);
117 else if (strcmp(item->defname, "transaction_deferrable") == 0)
118 SetPGVariable("default_transaction_deferrable",
119 list_make1(item->arg), stmt->is_local);
120 else
121 elog(ERROR, "unexpected SET SESSION element: %s",
122 item->defname);
123 }
124 }
125 else if (strcmp(stmt->name, "TRANSACTION SNAPSHOT") == 0)
126 {
127 A_Const *con = linitial_node(A_Const, stmt->args);
128
129 if (stmt->is_local)
131 (errcode(ERRCODE_FEATURE_NOT_SUPPORTED),
132 errmsg("SET LOCAL TRANSACTION SNAPSHOT is not implemented")));
133
134 WarnNoTransactionBlock(isTopLevel, "SET TRANSACTION");
135 ImportSnapshot(strVal(&con->val));
136 }
137 else
138 elog(ERROR, "unexpected SET MULTI element: %s",
139 stmt->name);
140 break;
141 case VAR_SET_DEFAULT:
142 if (stmt->is_local)
143 WarnNoTransactionBlock(isTopLevel, "SET LOCAL");
145 case VAR_RESET:
146 (void) set_config_option(stmt->name,
147 NULL,
150 action, true, 0, false);
151 break;
152 case VAR_RESET_ALL:
154 break;
155 }
156
157 /* Invoke the post-alter hook for setting this GUC variable, by name. */
158 InvokeObjectPostAlterHookArgStr(ParameterAclRelationId, stmt->name,
159 ACL_SET, stmt->kind, false);
160}
#define pg_fallthrough
Definition c.h:161
void ResetAllOptions(void)
Definition guc.c:1910
int set_config_option(const char *name, const char *value, GucContext context, GucSource source, GucAction action, bool changeVal, int elevel, bool is_reload)
Definition guc.c:3248
void SetPGVariable(const char *name, List *args, bool is_local)
Definition guc_funcs.c:343
#define stmt
#define false
return true
Definition isn.c:130
#define ACL_SET
Definition parsenodes.h:88
@ VAR_SET_MULTI
@ VAR_SET_CURRENT
#define lfirst(lc)
Definition pg_list.h:172
#define linitial_node(type, l)
Definition pg_list.h:181
#define list_make1(x1)
Definition pg_list.h:244
void ImportSnapshot(const char *idstr)
Definition snapmgr.c:1387
union ValUnion val
Definition parsenodes.h:390
char * defname
Definition parsenodes.h:860
Node * arg
Definition parsenodes.h:861
#define strVal(v)
Definition value.h:82
void WarnNoTransactionBlock(bool isTopLevel, const char *stmtType)
Definition xact.c:3761
bool IsInParallelMode(void)
Definition xact.c:1119

References ACL_SET, DefElem::arg, DefElem::defname, elog, ereport, errcode(), errmsg, ERROR, ExtractSetVariableArgs(), GUC_ACTION_LOCAL, GUC_ACTION_SET, ImportSnapshot(), InvokeObjectPostAlterHookArgStr, IsInParallelMode(), lfirst, linitial_node, list_make1, pg_fallthrough, PGC_S_SESSION, PGC_SUSET, PGC_USERSET, ResetAllOptions(), set_config_option(), SetPGVariable(), stmt, strVal, superuser(), A_Const::val, VAR_RESET, VAR_RESET_ALL, VAR_SET_CURRENT, VAR_SET_DEFAULT, VAR_SET_MULTI, VAR_SET_VALUE, and WarnNoTransactionBlock().

Referenced by standard_ProcessUtility().

◆ ExtractSetVariableArgs()

char * ExtractSetVariableArgs ( VariableSetStmt stmt)
extern

Definition at line 169 of file guc_funcs.c.

170{
171 switch (stmt->kind)
172 {
173 case VAR_SET_VALUE:
174 return flatten_set_variable_args(stmt->name, stmt->args);
175 case VAR_SET_CURRENT:
176 return GetConfigOptionByName(stmt->name, NULL, false);
177 default:
178 return NULL;
179 }
180}
char * GetConfigOptionByName(const char *name, const char **varname, bool missing_ok)
Definition guc.c:5339
static char * flatten_set_variable_args(const char *name, List *args)
Definition guc_funcs.c:194

References flatten_set_variable_args(), GetConfigOptionByName(), stmt, VAR_SET_CURRENT, and VAR_SET_VALUE.

Referenced by AlterSetting(), AlterSystemSetConfigFile(), ExecSetVariableStmt(), and update_proconfig_value().

◆ FreeConfigVariables()

void FreeConfigVariables ( ConfigVariable list)
extern

Definition at line 617 of file guc-file.l.

618{
619 ConfigVariable *item;
620
621 item = list;
622 while (item)
623 {
624 ConfigVariable *next = item->next;
625
626 FreeConfigVariable(item);
627 item = next;
628 }
629}
static int32 next
Definition blutils.c:225
static void FreeConfigVariable(ConfigVariable *item)
Definition guc-file.l:635
struct ConfigVariable * next
Definition guc.h:148

References FreeConfigVariable(), next, and ConfigVariable::next.

Referenced by AlterSystemSetConfigFile(), and parse_extension_control_file().

◆ get_config_handle()

config_handle * get_config_handle ( const char *  name)
extern

Definition at line 4186 of file guc.c.

4187{
4188 struct config_generic *gen = find_option(name, false, false, 0);
4189
4190 if (gen && ((gen->flags & GUC_CUSTOM_PLACEHOLDER) == 0))
4191 return gen;
4192
4193 return NULL;
4194}
#define GUC_CUSTOM_PLACEHOLDER
Definition guc.h:223

References find_option(), config_generic::flags, GUC_CUSTOM_PLACEHOLDER, and name.

Referenced by fmgr_security_definer().

◆ get_config_unit_name()

const char * get_config_unit_name ( int  flags)
extern

Definition at line 2718 of file guc.c.

2719{
2720 switch (flags & GUC_UNIT)
2721 {
2722 case 0:
2723 return NULL; /* GUC has no units */
2724 case GUC_UNIT_BYTE:
2725 return "B";
2726 case GUC_UNIT_KB:
2727 return "kB";
2728 case GUC_UNIT_MB:
2729 return "MB";
2730 case GUC_UNIT_BLOCKS:
2731 {
2732 static char bbuf[8];
2733
2734 /* initialize if first time through */
2735 if (bbuf[0] == '\0')
2736 snprintf(bbuf, sizeof(bbuf), "%dkB", BLCKSZ / 1024);
2737 return bbuf;
2738 }
2739 case GUC_UNIT_XBLOCKS:
2740 {
2741 static char xbuf[8];
2742
2743 /* initialize if first time through */
2744 if (xbuf[0] == '\0')
2745 snprintf(xbuf, sizeof(xbuf), "%dkB", XLOG_BLCKSZ / 1024);
2746 return xbuf;
2747 }
2748 case GUC_UNIT_MS:
2749 return "ms";
2750 case GUC_UNIT_S:
2751 return "s";
2752 case GUC_UNIT_MIN:
2753 return "min";
2754 default:
2755 elog(ERROR, "unrecognized GUC units value: %d",
2756 flags & GUC_UNIT);
2757 return NULL;
2758 }
2759}
#define GUC_UNIT_MB
Definition guc.h:235
#define GUC_UNIT
Definition guc.h:244
#define GUC_UNIT_MS
Definition guc.h:239
#define GUC_UNIT_BLOCKS
Definition guc.h:233
#define GUC_UNIT_XBLOCKS
Definition guc.h:234
#define GUC_UNIT_BYTE
Definition guc.h:236
#define GUC_UNIT_S
Definition guc.h:240
#define GUC_UNIT_KB
Definition guc.h:232
#define GUC_UNIT_MIN
Definition guc.h:241

References elog, ERROR, config_generic::flags, GUC_UNIT, GUC_UNIT_BLOCKS, GUC_UNIT_BYTE, GUC_UNIT_KB, GUC_UNIT_MB, GUC_UNIT_MIN, GUC_UNIT_MS, GUC_UNIT_S, GUC_UNIT_XBLOCKS, and snprintf.

Referenced by GetConfigOptionValues(), and parse_and_validate_value().

◆ GetConfigOption()

const char * GetConfigOption ( const char *  name,
bool  missing_ok,
bool  restrict_privileged 
)
extern

Definition at line 4257 of file guc.c.

4258{
4259 struct config_generic *record;
4260 static char buffer[256];
4261
4262 record = find_option(name, false, missing_ok, ERROR);
4263 if (record == NULL)
4264 return NULL;
4265 if (restrict_privileged &&
4266 !ConfigOptionIsVisible(record))
4267 ereport(ERROR,
4268 (errcode(ERRCODE_INSUFFICIENT_PRIVILEGE),
4269 errmsg("permission denied to examine \"%s\"", name),
4270 errdetail("Only roles with privileges of the \"%s\" role may examine this parameter.",
4271 "pg_read_all_settings")));
4272
4273 switch (record->vartype)
4274 {
4275 case PGC_BOOL:
4276 return *record->_bool.variable ? "on" : "off";
4277
4278 case PGC_INT:
4279 snprintf(buffer, sizeof(buffer), "%d",
4280 *record->_int.variable);
4281 return buffer;
4282
4283 case PGC_REAL:
4284 snprintf(buffer, sizeof(buffer), "%g",
4285 *record->_real.variable);
4286 return buffer;
4287
4288 case PGC_STRING:
4289 return *record->_string.variable ?
4290 *record->_string.variable : "";
4291
4292 case PGC_ENUM:
4293 return config_enum_lookup_by_value(record,
4294 *record->_enum.variable);
4295 }
4296 return NULL;
4297}
int errdetail(const char *fmt,...) pg_attribute_printf(1
const char * config_enum_lookup_by_value(const struct config_generic *record, int val)
Definition guc.c:2927
bool ConfigOptionIsVisible(const struct config_generic *conf)
Definition guc_funcs.c:612

References config_generic::_bool, config_generic::_enum, config_generic::_int, config_generic::_real, config_generic::_string, config_enum_lookup_by_value(), ConfigOptionIsVisible(), ereport, errcode(), errdetail(), errmsg, ERROR, find_option(), name, PGC_BOOL, PGC_ENUM, PGC_INT, PGC_REAL, PGC_STRING, snprintf, config_bool::variable, config_int::variable, config_real::variable, config_string::variable, config_enum::variable, and config_generic::vartype.

Referenced by applyRemoteGucs(), be_tls_init(), CreateSharedMemoryAndSemaphores(), PostmasterMain(), ProcessConfigFileInternal(), and test_translation().

◆ GetConfigOptionByName()

char * GetConfigOptionByName ( const char *  name,
const char **  varname,
bool  missing_ok 
)
extern

Definition at line 5339 of file guc.c.

5340{
5341 struct config_generic *record;
5342
5343 record = find_option(name, false, missing_ok, ERROR);
5344 if (record == NULL)
5345 {
5346 if (varname)
5347 *varname = NULL;
5348 return NULL;
5349 }
5350
5351 if (!ConfigOptionIsVisible(record))
5352 ereport(ERROR,
5353 (errcode(ERRCODE_INSUFFICIENT_PRIVILEGE),
5354 errmsg("permission denied to examine \"%s\"", name),
5355 errdetail("Only roles with privileges of the \"%s\" role may examine this parameter.",
5356 "pg_read_all_settings")));
5357
5358 if (varname)
5359 *varname = record->name;
5360
5361 return ShowGUCOption(record, true);
5362}
char * ShowGUCOption(const struct config_generic *record, bool use_units)
Definition guc.c:5372
const char * name
Definition guc_tables.h:253

References ConfigOptionIsVisible(), ereport, errcode(), errdetail(), errmsg, ERROR, find_option(), name, config_generic::name, and ShowGUCOption().

Referenced by ExplainPrintSettings(), ExtractSetVariableArgs(), GetPGVariableResultDesc(), set_config_by_name(), show_config_by_name(), show_config_by_name_missing_ok(), and ShowGUCConfigOption().

◆ GetConfigOptionFlags()

int GetConfigOptionFlags ( const char *  name,
bool  missing_ok 
)
extern

Definition at line 4354 of file guc.c.

4355{
4356 struct config_generic *record;
4357
4358 record = find_option(name, false, missing_ok, ERROR);
4359 if (record == NULL)
4360 return 0;
4361 return record->flags;
4362}

References ERROR, find_option(), config_generic::flags, and name.

Referenced by append_guc_value(), pg_get_functiondef(), and PostmasterMain().

◆ GetConfigOptionResetString()

const char * GetConfigOptionResetString ( const char *  name)
extern

Definition at line 4307 of file guc.c.

4308{
4309 struct config_generic *record;
4310 static char buffer[256];
4311
4312 record = find_option(name, false, false, ERROR);
4313 Assert(record != NULL);
4314 if (!ConfigOptionIsVisible(record))
4315 ereport(ERROR,
4316 (errcode(ERRCODE_INSUFFICIENT_PRIVILEGE),
4317 errmsg("permission denied to examine \"%s\"", name),
4318 errdetail("Only roles with privileges of the \"%s\" role may examine this parameter.",
4319 "pg_read_all_settings")));
4320
4321 switch (record->vartype)
4322 {
4323 case PGC_BOOL:
4324 return record->_bool.reset_val ? "on" : "off";
4325
4326 case PGC_INT:
4327 snprintf(buffer, sizeof(buffer), "%d",
4328 record->_int.reset_val);
4329 return buffer;
4330
4331 case PGC_REAL:
4332 snprintf(buffer, sizeof(buffer), "%g",
4333 record->_real.reset_val);
4334 return buffer;
4335
4336 case PGC_STRING:
4337 return record->_string.reset_val ?
4338 record->_string.reset_val : "";
4339
4340 case PGC_ENUM:
4341 return config_enum_lookup_by_value(record,
4342 record->_enum.reset_val);
4343 }
4344 return NULL;
4345}
double reset_val
Definition guc_tables.h:176
char * reset_val
Definition guc_tables.h:198

References config_generic::_bool, config_generic::_enum, config_generic::_int, config_generic::_real, config_generic::_string, Assert, config_enum_lookup_by_value(), ConfigOptionIsVisible(), ereport, errcode(), errdetail(), errmsg, ERROR, find_option(), name, PGC_BOOL, PGC_ENUM, PGC_INT, PGC_REAL, PGC_STRING, config_bool::reset_val, config_int::reset_val, config_real::reset_val, config_string::reset_val, config_enum::reset_val, snprintf, and config_generic::vartype.

Referenced by check_datestyle().

◆ GetPGVariable()

void GetPGVariable ( const char *  name,
DestReceiver dest 
)
extern

Definition at line 410 of file guc_funcs.c.

411{
412 if (guc_name_compare(name, "all") == 0)
413 ShowAllGUCConfig(dest);
414 else
416}
static void ShowGUCConfigOption(const char *name, DestReceiver *dest)
Definition guc_funcs.c:457
static void ShowAllGUCConfig(DestReceiver *dest)
Definition guc_funcs.c:486

References guc_name_compare(), name, ShowAllGUCConfig(), and ShowGUCConfigOption().

Referenced by exec_replication_command(), and standard_ProcessUtility().

◆ GetPGVariableResultDesc()

TupleDesc GetPGVariableResultDesc ( const char *  name)
extern

Definition at line 422 of file guc_funcs.c.

423{
424 TupleDesc tupdesc;
425
426 if (guc_name_compare(name, "all") == 0)
427 {
428 /* need a tuple descriptor representing three TEXT columns */
429 tupdesc = CreateTemplateTupleDesc(3);
430 TupleDescInitEntry(tupdesc, (AttrNumber) 1, "name",
431 TEXTOID, -1, 0);
432 TupleDescInitEntry(tupdesc, (AttrNumber) 2, "setting",
433 TEXTOID, -1, 0);
434 TupleDescInitEntry(tupdesc, (AttrNumber) 3, "description",
435 TEXTOID, -1, 0);
436 }
437 else
438 {
439 const char *varname;
440
441 /* Get the canonical spelling of name */
442 (void) GetConfigOptionByName(name, &varname, false);
443
444 /* need a tuple descriptor representing a single TEXT column */
445 tupdesc = CreateTemplateTupleDesc(1);
446 TupleDescInitEntry(tupdesc, (AttrNumber) 1, varname,
447 TEXTOID, -1, 0);
448 }
449 TupleDescFinalize(tupdesc);
450 return tupdesc;
451}
int16 AttrNumber
Definition attnum.h:21
TupleDesc CreateTemplateTupleDesc(int natts)
Definition tupdesc.c:165
void TupleDescFinalize(TupleDesc tupdesc)
Definition tupdesc.c:511
void TupleDescInitEntry(TupleDesc desc, AttrNumber attributeNumber, const char *attributeName, Oid oidtypeid, int32 typmod, int attdim)
Definition tupdesc.c:900

References CreateTemplateTupleDesc(), GetConfigOptionByName(), guc_name_compare(), name, TupleDescFinalize(), and TupleDescInitEntry().

Referenced by UtilityTupleDescriptor().

◆ GUC_check_errcode()

◆ guc_free()

void guc_free ( void *  ptr)
extern

Definition at line 688 of file guc.c.

689{
690 /*
691 * Historically, GUC-related code has relied heavily on the ability to do
692 * free(NULL), so we allow that here even though pfree() doesn't.
693 */
694 if (ptr != NULL)
695 {
696 /* This is to help catch old code that malloc's GUC data. */
698 pfree(ptr);
699 }
700}
static MemoryContext GUCMemoryContext
Definition guc.c:201
MemoryContext GetMemoryChunkContext(void *pointer)
Definition mcxt.c:756

References Assert, GetMemoryChunkContext(), GUCMemoryContext, and pfree().

Referenced by add_placeholder_variable(), AlterSystemSetConfigFile(), call_string_check_hook(), check_application_name(), check_client_encoding(), check_cluster_name(), check_datestyle(), check_default_text_search_config(), check_log_extension_options(), check_log_min_messages(), free_placeholder(), parse_and_validate_value(), ReportGUCOption(), RestoreGUCState(), SelectConfigFiles(), set_config_sourcefile(), set_config_with_handle(), set_extra_field(), and set_string_field().

◆ guc_malloc()

void * guc_malloc ( int  elevel,
size_t  size 
)
extern

◆ guc_realloc()

pg_nodiscard void * guc_realloc ( int  elevel,
void *  old,
size_t  size 
)
extern

Definition at line 651 of file guc.c.

652{
653 void *data;
654
655 if (old != NULL)
656 {
657 /* This is to help catch old code that malloc's GUC data. */
659 data = repalloc_extended(old, size,
661 }
662 else
663 {
664 /* Like realloc(3), but not like repalloc(), we allow old == NULL. */
667 }
668 if (unlikely(data == NULL))
669 ereport(elevel,
670 (errcode(ERRCODE_OUT_OF_MEMORY),
671 errmsg("out of memory")));
672 return data;
673}
void * repalloc_extended(void *pointer, Size size, int flags)
Definition mcxt.c:1667

References Assert, data, ereport, errcode(), errmsg, GetMemoryChunkContext(), GUCMemoryContext, MCXT_ALLOC_NO_OOM, MemoryContextAllocExtended(), repalloc_extended(), and unlikely.

◆ guc_strdup()

char * guc_strdup ( int  elevel,
const char *  src 
)
extern

Definition at line 676 of file guc.c.

677{
678 char *data;
679 size_t len = strlen(src) + 1;
680
681 data = guc_malloc(elevel, len);
682 if (likely(data != NULL))
683 memcpy(data, src, len);
684 return data;
685}
#define likely(x)
Definition c.h:437
memcpy(sums, checksumBaseOffsets, sizeof(checksumBaseOffsets))
void * guc_malloc(int elevel, size_t size)
Definition guc.c:637

References data, guc_malloc(), len, likely, and memcpy().

Referenced by add_placeholder_variable(), check_application_name(), check_client_encoding(), check_cluster_name(), check_datestyle(), check_default_text_search_config(), check_log_min_messages(), init_custom_variable(), InitializeOneGUCOption(), parse_and_validate_value(), ReportGUCOption(), set_config_sourcefile(), and set_config_with_handle().

◆ GUCArrayAdd()

ArrayType * GUCArrayAdd ( ArrayType array,
const char *  name,
const char *  value 
)
extern

Definition at line 6366 of file guc.c.

6367{
6368 struct config_generic *record;
6369 Datum datum;
6370 char *newval;
6371 ArrayType *a;
6372
6373 Assert(name);
6374 Assert(value);
6375
6376 /* test if the option is valid and we're allowed to set it */
6377 (void) validate_option_array_item(name, value, false);
6378
6379 /* normalize name (converts obsolete GUC names to modern spellings) */
6380 record = find_option(name, false, true, WARNING);
6381 if (record)
6382 name = record->name;
6383
6384 /* build new item for array */
6385 newval = psprintf("%s=%s", name, value);
6386 datum = CStringGetTextDatum(newval);
6387
6388 if (array)
6389 {
6390 int index;
6391 bool isnull;
6392
6393 Assert(ARR_ELEMTYPE(array) == TEXTOID);
6394 Assert(ARR_NDIM(array) == 1);
6395 Assert(ARR_LBOUND(array)[0] == 1);
6396
6397 index = ARR_DIMS(array)[0] + 1; /* add after end */
6398
6399 for (int i = 1; i <= ARR_DIMS(array)[0]; i++)
6400 {
6401 Datum d;
6402 char *current;
6403
6404 d = array_ref(array, 1, &i,
6405 -1 /* varlenarray */ ,
6406 -1 /* TEXT's typlen */ ,
6407 false /* TEXT's typbyval */ ,
6408 TYPALIGN_INT /* TEXT's typalign */ ,
6409 &isnull);
6410 if (isnull)
6411 continue;
6412 current = TextDatumGetCString(d);
6413
6414 /* check for match up through and including '=' */
6415 if (strncmp(current, newval, strlen(name) + 1) == 0)
6416 {
6417 index = i;
6418 break;
6419 }
6420 }
6421
6422 a = array_set(array, 1, &index,
6423 datum,
6424 false,
6425 -1 /* varlena array */ ,
6426 -1 /* TEXT's typlen */ ,
6427 false /* TEXT's typbyval */ ,
6428 TYPALIGN_INT /* TEXT's typalign */ );
6429 }
6430 else
6431 a = construct_array_builtin(&datum, 1, TEXTOID);
6432
6433 return a;
6434}
#define ARR_NDIM(a)
Definition array.h:290
#define ARR_ELEMTYPE(a)
Definition array.h:292
#define ARR_DIMS(a)
Definition array.h:294
#define ARR_LBOUND(a)
Definition array.h:296
ArrayType * array_set(ArrayType *array, int nSubscripts, int *indx, Datum dataValue, bool isNull, int arraytyplen, int elmlen, bool elmbyval, char elmalign)
Datum array_ref(ArrayType *array, int nSubscripts, int *indx, int arraytyplen, int elmlen, bool elmbyval, char elmalign, bool *isNull)
ArrayType * construct_array_builtin(Datum *elems, int nelems, Oid elmtype)
#define CStringGetTextDatum(s)
Definition builtins.h:98
#define TextDatumGetCString(d)
Definition builtins.h:99
static bool validate_option_array_item(const char *name, const char *value, bool skipIfNoPermissions)
Definition guc.c:6583
int a
Definition isn.c:73
uint64_t Datum
Definition postgres.h:70
char * psprintf(const char *fmt,...)
Definition psprintf.c:43
Definition type.h:96

References a, ARR_DIMS, ARR_ELEMTYPE, ARR_LBOUND, ARR_NDIM, array_ref(), array_set(), Assert, construct_array_builtin(), CStringGetTextDatum, find_option(), i, name, config_generic::name, newval, psprintf(), TextDatumGetCString, validate_option_array_item(), value, and WARNING.

Referenced by AlterSetting(), and update_proconfig_value().

◆ GUCArrayDelete()

ArrayType * GUCArrayDelete ( ArrayType array,
const char *  name 
)
extern

Definition at line 6443 of file guc.c.

6444{
6445 struct config_generic *record;
6446 ArrayType *newarray;
6447 int index;
6448
6449 Assert(name);
6450
6451 /* test if the option is valid and we're allowed to set it */
6452 (void) validate_option_array_item(name, NULL, false);
6453
6454 /* normalize name (converts obsolete GUC names to modern spellings) */
6455 record = find_option(name, false, true, WARNING);
6456 if (record)
6457 name = record->name;
6458
6459 /* if array is currently null, then surely nothing to delete */
6460 if (!array)
6461 return NULL;
6462
6463 newarray = NULL;
6464 index = 1;
6465
6466 for (int i = 1; i <= ARR_DIMS(array)[0]; i++)
6467 {
6468 Datum d;
6469 char *val;
6470 bool isnull;
6471
6472 d = array_ref(array, 1, &i,
6473 -1 /* varlenarray */ ,
6474 -1 /* TEXT's typlen */ ,
6475 false /* TEXT's typbyval */ ,
6476 TYPALIGN_INT /* TEXT's typalign */ ,
6477 &isnull);
6478 if (isnull)
6479 continue;
6481
6482 /* ignore entry if it's what we want to delete */
6483 if (strncmp(val, name, strlen(name)) == 0
6484 && val[strlen(name)] == '=')
6485 continue;
6486
6487 /* else add it to the output array */
6488 if (newarray)
6489 newarray = array_set(newarray, 1, &index,
6490 d,
6491 false,
6492 -1 /* varlenarray */ ,
6493 -1 /* TEXT's typlen */ ,
6494 false /* TEXT's typbyval */ ,
6495 TYPALIGN_INT /* TEXT's typalign */ );
6496 else
6497 newarray = construct_array_builtin(&d, 1, TEXTOID);
6498
6499 index++;
6500 }
6501
6502 return newarray;
6503}
long val
Definition informix.c:689

References ARR_DIMS, array_ref(), array_set(), Assert, construct_array_builtin(), find_option(), i, name, config_generic::name, TextDatumGetCString, val, validate_option_array_item(), and WARNING.

Referenced by AlterSetting(), and update_proconfig_value().

◆ GUCArrayReset()

ArrayType * GUCArrayReset ( ArrayType array)
extern

Definition at line 6512 of file guc.c.

6513{
6514 ArrayType *newarray;
6515 int index;
6516
6517 /* if array is currently null, nothing to do */
6518 if (!array)
6519 return NULL;
6520
6521 /* if we're superuser, we can delete everything, so just do it */
6522 if (superuser())
6523 return NULL;
6524
6525 newarray = NULL;
6526 index = 1;
6527
6528 for (int i = 1; i <= ARR_DIMS(array)[0]; i++)
6529 {
6530 Datum d;
6531 char *val;
6532 char *eqsgn;
6533 bool isnull;
6534
6535 d = array_ref(array, 1, &i,
6536 -1 /* varlenarray */ ,
6537 -1 /* TEXT's typlen */ ,
6538 false /* TEXT's typbyval */ ,
6539 TYPALIGN_INT /* TEXT's typalign */ ,
6540 &isnull);
6541 if (isnull)
6542 continue;
6544
6545 eqsgn = strchr(val, '=');
6546 *eqsgn = '\0';
6547
6548 /* skip if we have permission to delete it */
6549 if (validate_option_array_item(val, NULL, true))
6550 continue;
6551
6552 /* else add it to the output array */
6553 if (newarray)
6554 newarray = array_set(newarray, 1, &index,
6555 d,
6556 false,
6557 -1 /* varlenarray */ ,
6558 -1 /* TEXT's typlen */ ,
6559 false /* TEXT's typbyval */ ,
6560 TYPALIGN_INT /* TEXT's typalign */ );
6561 else
6562 newarray = construct_array_builtin(&d, 1, TEXTOID);
6563
6564 index++;
6565 pfree(val);
6566 }
6567
6568 return newarray;
6569}

References ARR_DIMS, array_ref(), array_set(), construct_array_builtin(), i, pfree(), superuser(), TextDatumGetCString, val, and validate_option_array_item().

Referenced by AlterSetting().

◆ InitializeGUCOptions()

void InitializeGUCOptions ( void  )
extern

Definition at line 1408 of file guc.c.

1409{
1410 HASH_SEQ_STATUS status;
1411 GUCHashEntry *hentry;
1412
1413 /*
1414 * Before log_line_prefix could possibly receive a nonempty setting, make
1415 * sure that timezone processing is minimally alive (see elog.c).
1416 */
1418
1419 /*
1420 * Create GUCMemoryContext and build hash table of all GUC variables.
1421 */
1423
1424 /*
1425 * Load all variables with their compiled-in defaults, and initialize
1426 * status fields as needed.
1427 */
1428 hash_seq_init(&status, guc_hashtab);
1429 while ((hentry = (GUCHashEntry *) hash_seq_search(&status)) != NULL)
1430 {
1431 /* Check mapping between initial and default value */
1432 Assert(check_GUC_init(hentry->gucvar));
1433
1435 }
1436
1437 reporting_enabled = false;
1438
1439 /*
1440 * Prevent any attempt to override the transaction modes from
1441 * non-interactive sources.
1442 */
1443 SetConfigOption("transaction_isolation", "read committed",
1445 SetConfigOption("transaction_read_only", "no",
1447 SetConfigOption("transaction_deferrable", "no",
1449
1450 /*
1451 * For historical reasons, some GUC parameters can receive defaults from
1452 * environment variables. Process those settings.
1453 */
1455}
static void InitializeOneGUCOption(struct config_generic *gconf)
Definition guc.c:1522
void build_guc_variables(void)
Definition guc.c:871
static void InitializeGUCOptionsFromEnvironment(void)
Definition guc.c:1467
void pg_timezone_initialize(void)
Definition pgtz.c:361

References Assert, build_guc_variables(), guc_hashtab, GUCHashEntry::gucvar, hash_seq_init(), hash_seq_search(), InitializeGUCOptionsFromEnvironment(), InitializeOneGUCOption(), pg_timezone_initialize(), PGC_POSTMASTER, PGC_S_OVERRIDE, reporting_enabled, and SetConfigOption().

Referenced by BootstrapModeMain(), PostgresSingleUserMain(), and PostmasterMain().

◆ MarkGUCPrefixReserved()

void void void void void void MarkGUCPrefixReserved ( const char *  className)
extern

Definition at line 5186 of file guc.c.

5187{
5188 int classLen = strlen(className);
5189 HASH_SEQ_STATUS status;
5190 GUCHashEntry *hentry;
5191 MemoryContext oldcontext;
5192
5193 /*
5194 * Check for existing placeholders. We must actually remove invalid
5195 * placeholders, else future parallel worker startups will fail.
5196 */
5197 hash_seq_init(&status, guc_hashtab);
5198 while ((hentry = (GUCHashEntry *) hash_seq_search(&status)) != NULL)
5199 {
5200 struct config_generic *var = hentry->gucvar;
5201
5202 if ((var->flags & GUC_CUSTOM_PLACEHOLDER) != 0 &&
5203 strncmp(className, var->name, classLen) == 0 &&
5204 var->name[classLen] == GUC_QUALIFIER_SEPARATOR)
5205 {
5207 (errcode(ERRCODE_INVALID_NAME),
5208 errmsg("invalid configuration parameter name \"%s\", removing it",
5209 var->name),
5210 errdetail("\"%s\" is now a reserved prefix.",
5211 className)));
5212 /* Remove it from the hash table */
5214 &var->name,
5216 NULL);
5217 /* Remove it from any lists it's in, too */
5218 RemoveGUCFromLists(var);
5219 /* And free it */
5220 free_placeholder(var);
5221 }
5222 }
5223
5224 /* And remember the name so we can prevent future mistakes. */
5227 MemoryContextSwitchTo(oldcontext);
5228}
void * hash_search(HTAB *hashp, const void *keyPtr, HASHACTION action, bool *foundPtr)
Definition dynahash.c:889
static void free_placeholder(struct config_generic *pHolder)
Definition guc.c:5034
static void RemoveGUCFromLists(struct config_generic *gconf)
Definition guc.c:1633
static List * reserved_class_prefix
Definition guc.c:80
#define GUC_QUALIFIER_SEPARATOR
Definition guc.h:208
@ HASH_REMOVE
Definition hsearch.h:110
List * lappend(List *list, void *datum)
Definition list.c:339
static MemoryContext MemoryContextSwitchTo(MemoryContext context)
Definition palloc.h:124

References ereport, errcode(), errdetail(), errmsg, config_generic::flags, free_placeholder(), GUC_CUSTOM_PLACEHOLDER, guc_hashtab, GUC_QUALIFIER_SEPARATOR, GUCMemoryContext, GUCHashEntry::gucvar, HASH_REMOVE, hash_search(), hash_seq_init(), hash_seq_search(), lappend(), MemoryContextSwitchTo(), config_generic::name, pstrdup(), RemoveGUCFromLists(), reserved_class_prefix, config_generic::status, and WARNING.

Referenced by _PG_init().

◆ NewGUCNestLevel()

◆ parse_int()

bool parse_int ( const char *  value,
int *  result,
int  flags,
const char **  hintmsg 
)
extern

Definition at line 2775 of file guc.c.

2776{
2777 /*
2778 * We assume here that double is wide enough to represent any integer
2779 * value with adequate precision.
2780 */
2781 double val;
2782 char *endptr;
2783
2784 /* To suppress compiler warnings, always set output params */
2785 if (result)
2786 *result = 0;
2787 if (hintmsg)
2788 *hintmsg = NULL;
2789
2790 /*
2791 * Try to parse as an integer (allowing octal or hex input). If the
2792 * conversion stops at a decimal point or 'e', or overflows, re-parse as
2793 * float. This should work fine as long as we have no unit names starting
2794 * with 'e'. If we ever do, the test could be extended to check for a
2795 * sign or digit after 'e', but for now that's unnecessary.
2796 */
2797 errno = 0;
2798 val = strtol(value, &endptr, 0);
2799 if (*endptr == '.' || *endptr == 'e' || *endptr == 'E' ||
2800 errno == ERANGE)
2801 {
2802 errno = 0;
2803 val = strtod(value, &endptr);
2804 }
2805
2806 if (endptr == value || errno == ERANGE)
2807 return false; /* no HINT for these cases */
2808
2809 /* reject NaN (infinities will fail range check below) */
2810 if (isnan(val))
2811 return false; /* treat same as syntax error; no HINT */
2812
2813 /* allow whitespace between number and unit */
2814 while (isspace((unsigned char) *endptr))
2815 endptr++;
2816
2817 /* Handle possible unit */
2818 if (*endptr != '\0')
2819 {
2820 if ((flags & GUC_UNIT) == 0)
2821 return false; /* this setting does not accept a unit */
2822
2824 endptr, (flags & GUC_UNIT),
2825 &val))
2826 {
2827 /* invalid unit, or garbage after the unit; set hint and fail. */
2828 if (hintmsg)
2829 {
2830 if (flags & GUC_UNIT_MEMORY)
2831 *hintmsg = memory_units_hint;
2832 else
2833 *hintmsg = time_units_hint;
2834 }
2835 return false;
2836 }
2837 }
2838
2839 /* Round to int, then check for overflow */
2840 val = rint(val);
2841
2842 if (val > INT_MAX || val < INT_MIN)
2843 {
2844 if (hintmsg)
2845 *hintmsg = gettext_noop("Value exceeds integer range.");
2846 return false;
2847 }
2848
2849 if (result)
2850 *result = (int) val;
2851 return true;
2852}
#define gettext_noop(x)
Definition c.h:1285
static bool convert_to_base_unit(double value, const char *unit, int base_unit, double *base_value)
Definition guc.c:2578
static const char *const memory_units_hint
Definition guc.c:121
static const char *const time_units_hint
Definition guc.c:158
#define GUC_UNIT_MEMORY
Definition guc.h:237

References convert_to_base_unit(), config_generic::flags, gettext_noop, GUC_UNIT, GUC_UNIT_MEMORY, memory_units_hint, result, time_units_hint, val, and value.

Referenced by apply_server_options(), apply_table_options(), ExecVacuum(), get_batch_size_option(), parse_and_validate_value(), parse_one_reloption(), parse_subscription_options(), postgres_fdw_validator(), postgresAcquireSampleRowsFunc(), and set_wal_receiver_timeout().

◆ parse_real()

bool parse_real ( const char *  value,
double *  result,
int  flags,
const char **  hintmsg 
)
extern

Definition at line 2865 of file guc.c.

2866{
2867 double val;
2868 char *endptr;
2869
2870 /* To suppress compiler warnings, always set output params */
2871 if (result)
2872 *result = 0;
2873 if (hintmsg)
2874 *hintmsg = NULL;
2875
2876 errno = 0;
2877 val = strtod(value, &endptr);
2878
2879 if (endptr == value || errno == ERANGE)
2880 return false; /* no HINT for these cases */
2881
2882 /* reject NaN (infinities will fail range checks later) */
2883 if (isnan(val))
2884 return false; /* treat same as syntax error; no HINT */
2885
2886 /* allow whitespace between number and unit */
2887 while (isspace((unsigned char) *endptr))
2888 endptr++;
2889
2890 /* Handle possible unit */
2891 if (*endptr != '\0')
2892 {
2893 if ((flags & GUC_UNIT) == 0)
2894 return false; /* this setting does not accept a unit */
2895
2897 endptr, (flags & GUC_UNIT),
2898 &val))
2899 {
2900 /* invalid unit, or garbage after the unit; set hint and fail. */
2901 if (hintmsg)
2902 {
2903 if (flags & GUC_UNIT_MEMORY)
2904 *hintmsg = memory_units_hint;
2905 else
2906 *hintmsg = time_units_hint;
2907 }
2908 return false;
2909 }
2910 }
2911
2912 if (result)
2913 *result = val;
2914 return true;
2915}

References convert_to_base_unit(), config_generic::flags, GUC_UNIT, GUC_UNIT_MEMORY, memory_units_hint, result, time_units_hint, val, and value.

Referenced by apply_server_options(), ExecWaitStmt(), parse_and_validate_value(), parse_one_reloption(), and postgres_fdw_validator().

◆ ParseConfigDirectory()

bool ParseConfigDirectory ( const char *  includedir,
const char *  calling_file,
int  calling_lineno,
int  depth,
int  elevel,
ConfigVariable **  head_p,
ConfigVariable **  tail_p 
)
extern

Definition at line 581 of file guc-file.l.

586{
587 char *err_msg;
588 char **filenames;
589 int num_filenames;
590
591 filenames = GetConfFilesInDir(includedir, calling_file, elevel,
592 &num_filenames, &err_msg);
593
594 if (!filenames)
595 {
596 record_config_file_error(err_msg, calling_file, calling_lineno, head_p,
597 tail_p);
598 return false;
599 }
600
601 for (int i = 0; i < num_filenames; i++)
602 {
603 if (!ParseConfigFile(filenames[i], true,
604 calling_file, calling_lineno,
605 depth, elevel,
606 head_p, tail_p))
607 return false;
608 }
609
610 return true;
611}
char ** GetConfFilesInDir(const char *includedir, const char *calling_file, int elevel, int *num_filenames, char **err_msg)
Definition conffiles.c:70
void record_config_file_error(const char *errmsg, const char *config_file, int lineno, ConfigVariable **head_p, ConfigVariable **tail_p)
Definition guc-file.l:278
bool ParseConfigFile(const char *config_file, bool strict, const char *calling_file, int calling_lineno, int depth, int elevel, ConfigVariable **head_p, ConfigVariable **tail_p)
Definition guc-file.l:175

References GetConfFilesInDir(), i, ParseConfigFile(), and record_config_file_error().

Referenced by ParseConfigFp().

◆ ParseConfigFile()

bool ParseConfigFile ( const char *  config_file,
bool  strict,
const char *  calling_file,
int  calling_lineno,
int  depth,
int  elevel,
ConfigVariable **  head_p,
ConfigVariable **  tail_p 
)
extern

Definition at line 175 of file guc-file.l.

180{
181 char *abs_path;
182 bool OK = true;
183 FILE *fp;
184
185 /*
186 * Reject file name that is all-blank (including empty), as that leads to
187 * confusion --- we'd try to read the containing directory as a file.
188 */
189 if (strspn(config_file, " \t\r\n") == strlen(config_file))
190 {
191 ereport(elevel,
192 (errcode(ERRCODE_INVALID_PARAMETER_VALUE),
193 errmsg("empty configuration file name: \"%s\"",
194 config_file)));
195 record_config_file_error("empty configuration file name",
196 calling_file, calling_lineno,
197 head_p, tail_p);
198 return false;
199 }
200
201 /*
202 * Reject too-deep include nesting depth. This is just a safety check to
203 * avoid dumping core due to stack overflow if an include file loops back
204 * to itself. The maximum nesting depth is pretty arbitrary.
205 */
206 if (depth > CONF_FILE_MAX_DEPTH)
207 {
208 ereport(elevel,
209 (errcode(ERRCODE_PROGRAM_LIMIT_EXCEEDED),
210 errmsg("could not open configuration file \"%s\": maximum nesting depth exceeded",
211 config_file)));
212 record_config_file_error("nesting depth exceeded",
213 calling_file, calling_lineno,
214 head_p, tail_p);
215 return false;
216 }
217
218 abs_path = AbsoluteConfigLocation(config_file, calling_file);
219
220 /*
221 * Reject direct recursion. Indirect recursion is also possible, but it's
222 * harder to detect and so doesn't seem worth the trouble. (We test at
223 * this step because the canonicalization done by AbsoluteConfigLocation
224 * makes it more likely that a simple strcmp comparison will match.)
225 */
226 if (calling_file && strcmp(abs_path, calling_file) == 0)
227 {
228 ereport(elevel,
229 (errcode(ERRCODE_INVALID_PARAMETER_VALUE),
230 errmsg("configuration file recursion in \"%s\"",
231 calling_file)));
232 record_config_file_error("configuration file recursion",
233 calling_file, calling_lineno,
234 head_p, tail_p);
235 pfree(abs_path);
236 return false;
237 }
238
239 fp = AllocateFile(abs_path, "r");
240 if (!fp)
241 {
242 if (strict)
243 {
244 ereport(elevel,
246 errmsg("could not open configuration file \"%s\": %m",
247 abs_path)));
248 record_config_file_error(psprintf("could not open file \"%s\"",
249 abs_path),
250 calling_file, calling_lineno,
251 head_p, tail_p);
252 OK = false;
253 }
254 else
255 {
256 ereport(LOG,
257 (errmsg("skipping missing configuration file \"%s\"",
258 abs_path)));
259 }
260 goto cleanup;
261 }
262
263 OK = ParseConfigFp(fp, abs_path, depth, elevel, head_p, tail_p);
264
265cleanup:
266 if (fp)
267 FreeFile(fp);
268 pfree(abs_path);
269
270 return OK;
271}
static void cleanup(void)
Definition bootstrap.c:886
char * AbsoluteConfigLocation(const char *location, const char *calling_file)
Definition conffiles.c:36
#define CONF_FILE_MAX_DEPTH
Definition conffiles.h:18
static char * config_file
Definition pg_rewind.c:71

References AbsoluteConfigLocation(), AllocateFile(), cleanup(), CONF_FILE_MAX_DEPTH, config_file, ereport, errcode(), errcode_for_file_access(), errmsg, FreeFile(), LOG, ParseConfigFp(), pfree(), psprintf(), and record_config_file_error().

Referenced by ParseConfigDirectory(), ParseConfigFp(), and ProcessConfigFileInternal().

◆ ParseConfigFp()

bool ParseConfigFp ( FILE *  fp,
const char *  config_file,
int  depth,
int  elevel,
ConfigVariable **  head_p,
ConfigVariable **  tail_p 
)
extern

Definition at line 350 of file guc-file.l.

352{
353 volatile bool OK = true;
354 unsigned int save_ConfigFileLineno = ConfigFileLineno;
355 sigjmp_buf *save_GUC_flex_fatal_jmp = GUC_flex_fatal_jmp;
356 sigjmp_buf flex_fatal_jmp;
357 yyscan_t scanner;
358 struct yyguts_t *yyg; /* needed for yytext macro */
359 volatile YY_BUFFER_STATE lex_buffer = NULL;
360 int errorcount;
361 int token;
362
363 if (sigsetjmp(flex_fatal_jmp, 1) == 0)
364 GUC_flex_fatal_jmp = &flex_fatal_jmp;
365 else
366 {
367 /*
368 * Regain control after a fatal, internal flex error. It may have
369 * corrupted parser state. Consequently, abandon the file, but trust
370 * that the state remains sane enough for yy_delete_buffer().
371 */
372 elog(elevel, "%s at file \"%s\" line %u",
376 head_p, tail_p);
377 OK = false;
378 goto cleanup;
379 }
380
381 /*
382 * Parse
383 */
385 errorcount = 0;
386
387 if (yylex_init(&scanner) != 0)
388 elog(elevel, "yylex_init() failed: %m");
389 yyg = (struct yyguts_t *) scanner;
390
391 lex_buffer = yy_create_buffer(fp, YY_BUF_SIZE, scanner);
392 yy_switch_to_buffer(lex_buffer, scanner);
393
394 /* This loop iterates once per logical line */
395 while ((token = yylex(scanner)))
396 {
397 char *opt_name = NULL;
398 char *opt_value = NULL;
399 ConfigVariable *item;
400
401 if (token == GUC_EOL) /* empty or comment line */
402 continue;
403
404 /* first token on line is option name */
405 if (token != GUC_ID && token != GUC_QUALIFIED_ID)
406 goto parse_error;
407 opt_name = pstrdup(yytext);
408
409 /* next we have an optional equal sign; discard if present */
410 token = yylex(scanner);
411 if (token == GUC_EQUALS)
412 token = yylex(scanner);
413
414 /* now we must have the option value */
415 if (token != GUC_ID &&
416 token != GUC_STRING &&
417 token != GUC_INTEGER &&
418 token != GUC_REAL &&
420 goto parse_error;
421 if (token == GUC_STRING) /* strip quotes and escapes */
422 opt_value = DeescapeQuotedString(yytext);
423 else
424 opt_value = pstrdup(yytext);
425
426 /* now we'd like an end of line, or possibly EOF */
427 token = yylex(scanner);
428 if (token != GUC_EOL)
429 {
430 if (token != 0)
431 goto parse_error;
432 /* treat EOF like \n for line numbering purposes, cf bug 4752 */
434 }
435
436 /* OK, process the option name and value */
437 if (guc_name_compare(opt_name, "include_dir") == 0)
438 {
439 /*
440 * An include_dir directive isn't a variable and should be
441 * processed immediately.
442 */
443 if (!ParseConfigDirectory(opt_value,
445 depth + 1, elevel,
446 head_p, tail_p))
447 OK = false;
448 yy_switch_to_buffer(lex_buffer, scanner);
449 pfree(opt_name);
450 pfree(opt_value);
451 }
452 else if (guc_name_compare(opt_name, "include_if_exists") == 0)
453 {
454 /*
455 * An include_if_exists directive isn't a variable and should be
456 * processed immediately.
457 */
458 if (!ParseConfigFile(opt_value, false,
460 depth + 1, elevel,
461 head_p, tail_p))
462 OK = false;
463 yy_switch_to_buffer(lex_buffer, scanner);
464 pfree(opt_name);
465 pfree(opt_value);
466 }
467 else if (guc_name_compare(opt_name, "include") == 0)
468 {
469 /*
470 * An include directive isn't a variable and should be processed
471 * immediately.
472 */
473 if (!ParseConfigFile(opt_value, true,
475 depth + 1, elevel,
476 head_p, tail_p))
477 OK = false;
478 yy_switch_to_buffer(lex_buffer, scanner);
479 pfree(opt_name);
480 pfree(opt_value);
481 }
482 else
483 {
484 /* ordinary variable, append to list */
486 item->name = opt_name;
487 item->value = opt_value;
488 item->errmsg = NULL;
490 item->sourceline = ConfigFileLineno - 1;
491 item->ignore = false;
492 item->applied = false;
493 item->next = NULL;
494 if (*head_p == NULL)
495 *head_p = item;
496 else
497 (*tail_p)->next = item;
498 *tail_p = item;
499 }
500
501 /* break out of loop if read EOF, else loop for next line */
502 if (token == 0)
503 break;
504 continue;
505
506parse_error:
507 /* release storage if we allocated any on this line */
508 if (opt_name)
509 pfree(opt_name);
510 if (opt_value)
511 pfree(opt_value);
512
513 /* report the error */
514 if (token == GUC_EOL || token == 0)
515 {
516 ereport(elevel,
517 (errcode(ERRCODE_SYNTAX_ERROR),
518 errmsg("syntax error in file \"%s\" line %u, near end of line",
520 record_config_file_error("syntax error",
522 head_p, tail_p);
523 }
524 else
525 {
526 ereport(elevel,
527 (errcode(ERRCODE_SYNTAX_ERROR),
528 errmsg("syntax error in file \"%s\" line %u, near token \"%s\"",
529 config_file, ConfigFileLineno, yytext)));
530 record_config_file_error("syntax error",
532 head_p, tail_p);
533 }
534 OK = false;
535 errorcount++;
536
537 /*
538 * To avoid producing too much noise when fed a totally bogus file,
539 * give up after 100 syntax errors per file (an arbitrary number).
540 * Also, if we're only logging the errors at DEBUG level anyway, might
541 * as well give up immediately. (This prevents postmaster children
542 * from bloating the logs with duplicate complaints.)
543 */
544 if (errorcount >= 100 || elevel <= DEBUG1)
545 {
546 ereport(elevel,
547 (errcode(ERRCODE_PROGRAM_LIMIT_EXCEEDED),
548 errmsg("too many syntax errors found, abandoning file \"%s\"",
549 config_file)));
550 break;
551 }
552
553 /* resync to next end-of-line or EOF */
554 while (token != GUC_EOL && token != 0)
555 token = yylex(scanner);
556 /* break out of loop on EOF */
557 if (token == 0)
558 break;
559 }
560
561cleanup:
562 yy_delete_buffer(lex_buffer, scanner);
563 yylex_destroy(scanner);
564 /* Each recursion level must save and restore these static variables. */
565 ConfigFileLineno = save_ConfigFileLineno;
566 GUC_flex_fatal_jmp = save_GUC_flex_fatal_jmp;
567 return OK;
568}
void * yyscan_t
Definition cubedata.h:65
#define DEBUG1
Definition elog.h:31
#define palloc_object(type)
Definition fe_memutils.h:74
static sigjmp_buf * GUC_flex_fatal_jmp
Definition guc-file.l:50
@ GUC_STRING
Definition guc-file.l:38
@ GUC_UNQUOTED_STRING
Definition guc-file.l:42
@ GUC_INTEGER
Definition guc-file.l:39
@ GUC_QUALIFIED_ID
Definition guc-file.l:43
@ GUC_REAL
Definition guc-file.l:40
@ GUC_ID
Definition guc-file.l:37
@ GUC_EOL
Definition guc-file.l:44
@ GUC_EQUALS
Definition guc-file.l:41
static unsigned int ConfigFileLineno
Definition guc-file.l:48
static const char * GUC_flex_fatal_errmsg
Definition guc-file.l:49
char * DeescapeQuotedString(const char *s)
Definition guc-file.l:661
bool ParseConfigDirectory(const char *includedir, const char *calling_file, int calling_lineno, int depth, int elevel, ConfigVariable **head_p, ConfigVariable **tail_p)
Definition guc-file.l:581
#define token
int yylex(void)
Definition pgc.l:465
struct yy_buffer_state * YY_BUFFER_STATE
char * name
Definition guc.h:141
bool ignore
Definition guc.h:146
bool applied
Definition guc.h:147
char * filename
Definition guc.h:144
int sourceline
Definition guc.h:145
char * value
Definition guc.h:142
char * errmsg
Definition guc.h:143

References ConfigVariable::applied, cleanup(), config_file, ConfigFileLineno, DEBUG1, DeescapeQuotedString(), elog, ereport, errcode(), ConfigVariable::errmsg, errmsg, ConfigVariable::filename, GUC_EOL, GUC_EQUALS, GUC_flex_fatal_errmsg, GUC_flex_fatal_jmp, GUC_ID, GUC_INTEGER, guc_name_compare(), GUC_QUALIFIED_ID, GUC_REAL, GUC_STRING, GUC_UNQUOTED_STRING, ConfigVariable::ignore, ConfigVariable::name, ConfigVariable::next, palloc_object, ParseConfigDirectory(), ParseConfigFile(), pfree(), pstrdup(), record_config_file_error(), ConfigVariable::sourceline, token, ConfigVariable::value, and yylex().

Referenced by AlterSystemSetConfigFile(), parse_extension_control_file(), and ParseConfigFile().

◆ ParseLongOption()

void ParseLongOption ( const char *  string,
char **  name,
char **  value 
)
extern

Definition at line 6243 of file guc.c.

6244{
6245 size_t equal_pos;
6246
6247 Assert(string);
6248 Assert(name);
6249 Assert(value);
6250
6251 equal_pos = strcspn(string, "=");
6252
6253 if (string[equal_pos] == '=')
6254 {
6255 *name = palloc(equal_pos + 1);
6256 strlcpy(*name, string, equal_pos + 1);
6257
6258 *value = pstrdup(&string[equal_pos + 1]);
6259 }
6260 else
6261 {
6262 /* no equal sign in string */
6263 *name = pstrdup(string);
6264 *value = NULL;
6265 }
6266
6267 for (char *cp = *name; *cp; cp++)
6268 if (*cp == '-')
6269 *cp = '_';
6270}
size_t strlcpy(char *dst, const char *src, size_t siz)
Definition strlcpy.c:45

References Assert, name, palloc(), pstrdup(), strlcpy(), and value.

Referenced by BootstrapModeMain(), PostmasterMain(), process_postgres_switches(), and TransformGUCArray().

◆ ProcessConfigFile()

void ProcessConfigFile ( GucContext  context)
extern

Definition at line 120 of file guc-file.l.

121{
122 int elevel;
123 MemoryContext config_cxt;
124 MemoryContext caller_cxt;
125
126 /*
127 * Config files are processed on startup (by the postmaster only) and on
128 * SIGHUP (by the postmaster and its children)
129 */
130 Assert((context == PGC_POSTMASTER && !IsUnderPostmaster) ||
131 context == PGC_SIGHUP);
132
133 /*
134 * To avoid cluttering the log, only the postmaster bleats loudly about
135 * problems with the config file.
136 */
137 elevel = IsUnderPostmaster ? DEBUG2 : LOG;
138
139 /*
140 * This function is usually called within a process-lifespan memory
141 * context. To ensure that any memory leaked during GUC processing does
142 * not accumulate across repeated SIGHUP cycles, do the work in a private
143 * context that we can free at exit.
144 */
146 "config file processing",
148 caller_cxt = MemoryContextSwitchTo(config_cxt);
149
150 /*
151 * Read and apply the config file. We don't need to examine the result.
152 */
153 (void) ProcessConfigFileInternal(context, true, elevel);
154
155 /* Clean up */
156 MemoryContextSwitchTo(caller_cxt);
157 MemoryContextDelete(config_cxt);
158}
#define DEBUG2
Definition elog.h:30
bool IsUnderPostmaster
Definition globals.c:122
ConfigVariable * ProcessConfigFileInternal(GucContext context, bool applySettings, int elevel)
Definition guc.c:285
MemoryContext CurrentMemoryContext
Definition mcxt.c:160
void MemoryContextDelete(MemoryContext context)
Definition mcxt.c:472
#define AllocSetContextCreate
Definition memutils.h:129
#define ALLOCSET_DEFAULT_SIZES
Definition memutils.h:160

References ALLOCSET_DEFAULT_SIZES, AllocSetContextCreate, Assert, CurrentMemoryContext, DEBUG2, IsUnderPostmaster, LOG, MemoryContextDelete(), MemoryContextSwitchTo(), PGC_POSTMASTER, PGC_SIGHUP, and ProcessConfigFileInternal().

Referenced by ApplyLauncherMain(), autoprewarm_main(), CheckpointWriteDelay(), copy_sequences(), do_autovacuum(), IoWorkerMain(), LogicalRepApplyLoop(), pg_stash_advice_worker_main(), PostgresMain(), process_pm_reload_request(), ProcessAutoVacLauncherInterrupts(), ProcessCheckpointerInterrupts(), ProcessMainLoopInterrupts(), ProcessParallelApplyInterrupts(), ProcessPgArchInterrupts(), ProcessWalSummarizerInterrupts(), SelectConfigFiles(), slotsync_reread_config(), StartupRereadConfig(), SysLoggerMain(), vacuum_delay_point(), WaitForStandbyConfirmation(), WalReceiverMain(), WalSndHandleConfigReload(), and worker_spi_main().

◆ ProcessGUCArray()

void ProcessGUCArray ( ArrayType array,
GucContext  context,
GucSource  source,
GucAction  action 
)
extern

Definition at line 6334 of file guc.c.

6336{
6337 List *gucNames;
6338 List *gucValues;
6339 ListCell *lc1;
6340 ListCell *lc2;
6341
6342 TransformGUCArray(array, &gucNames, &gucValues);
6343 forboth(lc1, gucNames, lc2, gucValues)
6344 {
6345 char *name = lfirst(lc1);
6346 char *value = lfirst(lc2);
6347
6349 context, source,
6350 action, true, 0, false);
6351
6352 pfree(name);
6353 pfree(value);
6354 }
6355
6356 list_free(gucNames);
6357 list_free(gucValues);
6358}
void TransformGUCArray(ArrayType *array, List **names, List **values)
Definition guc.c:6279
void list_free(List *list)
Definition list.c:1546
#define forboth(cell1, list1, cell2, list2)
Definition pg_list.h:550
static rewind_source * source
Definition pg_rewind.c:89
Definition pg_list.h:54

References forboth, lfirst, list_free(), name, pfree(), set_config_option(), source, TransformGUCArray(), and value.

Referenced by ApplySetting(), and ProcedureCreate().

◆ ReportChangedGUCOptions()

void ReportChangedGUCOptions ( void  )
extern

Definition at line 2503 of file guc.c.

2504{
2505 slist_mutable_iter iter;
2506
2507 /* Quick exit if not (yet) enabled */
2508 if (!reporting_enabled)
2509 return;
2510
2511 /*
2512 * Since in_hot_standby isn't actually changed by normal GUC actions, we
2513 * need a hack to check whether a new value needs to be reported to the
2514 * client. For speed, we rely on the assumption that it can never
2515 * transition from false to true.
2516 */
2518 SetConfigOption("in_hot_standby", "false",
2520
2521 /* Transmit new values of interesting variables */
2523 {
2524 struct config_generic *conf = slist_container(struct config_generic,
2525 report_link, iter.cur);
2526
2527 Assert((conf->flags & GUC_REPORT) && (conf->status & GUC_NEEDS_REPORT));
2528 ReportGUCOption(conf);
2529 conf->status &= ~GUC_NEEDS_REPORT;
2530 slist_delete_current(&iter);
2531 }
2532}
bool in_hot_standby_guc
Definition guc_tables.c:676

References Assert, slist_mutable_iter::cur, config_generic::flags, GUC_NEEDS_REPORT, GUC_REPORT, guc_report_list, in_hot_standby_guc, PGC_INTERNAL, PGC_S_OVERRIDE, RecoveryInProgress(), config_generic::report_link, ReportGUCOption(), reporting_enabled, SetConfigOption(), slist_container, slist_delete_current(), slist_foreach_modify, and config_generic::status.

Referenced by PostgresMain().

◆ ResetAllOptions()

void ResetAllOptions ( void  )
extern

Definition at line 1910 of file guc.c.

1911{
1912 dlist_mutable_iter iter;
1913
1914 /* We need only consider GUCs not already at PGC_S_DEFAULT */
1916 {
1917 struct config_generic *gconf = dlist_container(struct config_generic,
1918 nondef_link, iter.cur);
1919
1920 /* Don't reset non-SET-able values */
1921 if (gconf->context != PGC_SUSET &&
1922 gconf->context != PGC_USERSET)
1923 continue;
1924 /* Don't reset if special exclusion from RESET ALL */
1925 if (gconf->flags & GUC_NO_RESET_ALL)
1926 continue;
1927 /* No need to reset if wasn't SET */
1928 if (gconf->source <= PGC_S_OVERRIDE)
1929 continue;
1930
1931 /* Save old value to support transaction abort */
1933
1934 switch (gconf->vartype)
1935 {
1936 case PGC_BOOL:
1937 {
1938 struct config_bool *conf = &gconf->_bool;
1939
1940 if (conf->assign_hook)
1941 conf->assign_hook(conf->reset_val,
1942 gconf->reset_extra);
1943 *conf->variable = conf->reset_val;
1944 set_extra_field(gconf, &gconf->extra,
1945 gconf->reset_extra);
1946 break;
1947 }
1948 case PGC_INT:
1949 {
1950 struct config_int *conf = &gconf->_int;
1951
1952 if (conf->assign_hook)
1953 conf->assign_hook(conf->reset_val,
1954 gconf->reset_extra);
1955 *conf->variable = conf->reset_val;
1956 set_extra_field(gconf, &gconf->extra,
1957 gconf->reset_extra);
1958 break;
1959 }
1960 case PGC_REAL:
1961 {
1962 struct config_real *conf = &gconf->_real;
1963
1964 if (conf->assign_hook)
1965 conf->assign_hook(conf->reset_val,
1966 gconf->reset_extra);
1967 *conf->variable = conf->reset_val;
1968 set_extra_field(gconf, &gconf->extra,
1969 gconf->reset_extra);
1970 break;
1971 }
1972 case PGC_STRING:
1973 {
1974 struct config_string *conf = &gconf->_string;
1975
1976 if (conf->assign_hook)
1977 conf->assign_hook(conf->reset_val,
1978 gconf->reset_extra);
1979 set_string_field(gconf, conf->variable, conf->reset_val);
1980 set_extra_field(gconf, &gconf->extra,
1981 gconf->reset_extra);
1982 break;
1983 }
1984 case PGC_ENUM:
1985 {
1986 struct config_enum *conf = &gconf->_enum;
1987
1988 if (conf->assign_hook)
1989 conf->assign_hook(conf->reset_val,
1990 gconf->reset_extra);
1991 *conf->variable = conf->reset_val;
1992 set_extra_field(gconf, &gconf->extra,
1993 gconf->reset_extra);
1994 break;
1995 }
1996 }
1997
1998 set_guc_source(gconf, gconf->reset_source);
1999 gconf->scontext = gconf->reset_scontext;
2000 gconf->srole = gconf->reset_srole;
2001
2002 if ((gconf->flags & GUC_REPORT) && !(gconf->status & GUC_NEEDS_REPORT))
2003 {
2004 gconf->status |= GUC_NEEDS_REPORT;
2006 }
2007 }
2008}
static void push_old_value(struct config_generic *gconf, GucAction action)
Definition guc.c:2041
#define GUC_NO_RESET_ALL
Definition guc.h:218
#define dlist_foreach_modify(iter, lhead)
Definition ilist.h:640
GucContext reset_scontext
Definition guc_tables.h:265
GucSource source
Definition guc_tables.h:262
void * reset_extra
Definition guc_tables.h:270
GucSource reset_source
Definition guc_tables.h:263
dlist_node * cur
Definition ilist.h:200

References config_generic::_bool, config_generic::_enum, config_generic::_int, config_generic::_real, config_generic::_string, config_bool::assign_hook, config_int::assign_hook, config_real::assign_hook, config_string::assign_hook, config_enum::assign_hook, config_generic::context, dlist_mutable_iter::cur, dlist_container, dlist_foreach_modify, config_generic::extra, config_generic::flags, GUC_ACTION_SET, GUC_NEEDS_REPORT, GUC_NO_RESET_ALL, guc_nondef_list, GUC_REPORT, guc_report_list, config_generic::nondef_link, PGC_BOOL, PGC_ENUM, PGC_INT, PGC_REAL, PGC_S_OVERRIDE, PGC_STRING, PGC_SUSET, PGC_USERSET, push_old_value(), config_generic::report_link, config_generic::reset_extra, config_generic::reset_scontext, config_generic::reset_source, config_generic::reset_srole, config_bool::reset_val, config_int::reset_val, config_real::reset_val, config_string::reset_val, config_enum::reset_val, config_generic::scontext, set_extra_field(), set_guc_source(), set_string_field(), slist_push_head(), config_generic::source, config_generic::srole, config_generic::status, config_bool::variable, config_int::variable, config_real::variable, config_string::variable, config_enum::variable, and config_generic::vartype.

Referenced by DiscardAll(), and ExecSetVariableStmt().

◆ RestoreGUCState()

void RestoreGUCState ( void *  gucstate)
extern

Definition at line 6100 of file guc.c.

6101{
6102 char *varname,
6103 *varvalue,
6104 *varsourcefile;
6105 int varsourceline;
6106 GucSource varsource;
6107 GucContext varscontext;
6108 Oid varsrole;
6109 char *srcptr = (char *) gucstate;
6110 char *srcend;
6111 Size len;
6112 dlist_mutable_iter iter;
6113 ErrorContextCallback error_context_callback;
6114
6115 /*
6116 * First, ensure that all potentially-shippable GUCs are reset to their
6117 * default values. We must not touch those GUCs that the leader will
6118 * never ship, while there is no need to touch those that are shippable
6119 * but already have their default values. Thus, this ends up being the
6120 * same test that SerializeGUCState uses, even though the sets of
6121 * variables involved may well be different since the leader's set of
6122 * variables-not-at-default-values can differ from the set that are
6123 * not-default in this freshly started worker.
6124 *
6125 * Once we have set all the potentially-shippable GUCs to default values,
6126 * restoring the GUCs that the leader sent (because they had non-default
6127 * values over there) leads us to exactly the set of GUC values that the
6128 * leader has. This is true even though the worker may have initially
6129 * absorbed postgresql.conf settings that the leader hasn't yet seen, or
6130 * ALTER USER/DATABASE SET settings that were established after the leader
6131 * started.
6132 *
6133 * Note that ensuring all the potential target GUCs are at PGC_S_DEFAULT
6134 * also ensures that set_config_option won't refuse to set them because of
6135 * source-priority comparisons.
6136 */
6138 {
6139 struct config_generic *gconf = dlist_container(struct config_generic,
6140 nondef_link, iter.cur);
6141
6142 /* Do nothing if non-shippable or if already at PGC_S_DEFAULT. */
6143 if (can_skip_gucvar(gconf))
6144 continue;
6145
6146 /*
6147 * We can use InitializeOneGUCOption to reset the GUC to default, but
6148 * first we must free any existing subsidiary data to avoid leaking
6149 * memory. The stack must be empty, but we have to clean up all other
6150 * fields. Beware that there might be duplicate value or "extra"
6151 * pointers. We also have to be sure to take it out of any lists it's
6152 * in.
6153 */
6154 Assert(gconf->stack == NULL);
6155 guc_free(gconf->extra);
6156 guc_free(gconf->last_reported);
6157 guc_free(gconf->sourcefile);
6158 switch (gconf->vartype)
6159 {
6160 case PGC_BOOL:
6161 case PGC_INT:
6162 case PGC_REAL:
6163 case PGC_ENUM:
6164 /* no need to do anything */
6165 break;
6166 case PGC_STRING:
6167 {
6168 struct config_string *conf = &gconf->_string;
6169
6170 guc_free(*conf->variable);
6171 if (conf->reset_val && conf->reset_val != *conf->variable)
6172 guc_free(conf->reset_val);
6173 break;
6174 }
6175 }
6176 if (gconf->reset_extra && gconf->reset_extra != gconf->extra)
6177 guc_free(gconf->reset_extra);
6178 /* Remove it from any lists it's in. */
6179 RemoveGUCFromLists(gconf);
6180 /* Now we can reset the struct to PGS_S_DEFAULT state. */
6182 }
6183
6184 /* First item is the length of the subsequent data */
6185 memcpy(&len, gucstate, sizeof(len));
6186
6187 srcptr += sizeof(len);
6188 srcend = srcptr + len;
6189
6190 /* If the GUC value check fails, we want errors to show useful context. */
6191 error_context_callback.callback = guc_restore_error_context_callback;
6192 error_context_callback.previous = error_context_stack;
6193 error_context_callback.arg = NULL;
6194 error_context_stack = &error_context_callback;
6195
6196 /* Restore all the listed GUCs. */
6197 while (srcptr < srcend)
6198 {
6199 int result;
6200 char *error_context_name_and_value[2];
6201
6202 varname = read_gucstate(&srcptr, srcend);
6203 varvalue = read_gucstate(&srcptr, srcend);
6204 varsourcefile = read_gucstate(&srcptr, srcend);
6205 if (varsourcefile[0])
6206 read_gucstate_binary(&srcptr, srcend,
6207 &varsourceline, sizeof(varsourceline));
6208 else
6209 varsourceline = 0;
6210 read_gucstate_binary(&srcptr, srcend,
6211 &varsource, sizeof(varsource));
6212 read_gucstate_binary(&srcptr, srcend,
6213 &varscontext, sizeof(varscontext));
6214 read_gucstate_binary(&srcptr, srcend,
6215 &varsrole, sizeof(varsrole));
6216
6217 error_context_name_and_value[0] = varname;
6218 error_context_name_and_value[1] = varvalue;
6219 error_context_callback.arg = &error_context_name_and_value[0];
6220 result = set_config_option_ext(varname, varvalue,
6221 varscontext, varsource, varsrole,
6222 GUC_ACTION_SET, true, ERROR, true);
6223 if (result <= 0)
6224 ereport(ERROR,
6225 (errcode(ERRCODE_INTERNAL_ERROR),
6226 errmsg("parameter \"%s\" could not be set", varname)));
6227 if (varsourcefile[0])
6228 set_config_sourcefile(varname, varsourcefile, varsourceline);
6229 error_context_callback.arg = NULL;
6230 }
6231
6232 error_context_stack = error_context_callback.previous;
6233}
ErrorContextCallback * error_context_stack
Definition elog.c:100
static void guc_restore_error_context_callback(void *arg)
Definition guc.c:6078
int set_config_option_ext(const char *name, const char *value, GucContext context, GucSource source, Oid srole, GucAction action, bool changeVal, int elevel, bool is_reload)
Definition guc.c:3288
static void set_config_sourcefile(const char *name, char *sourcefile, int sourceline)
Definition guc.c:4201
static bool can_skip_gucvar(struct config_generic *gconf)
Definition guc.c:5721
static void read_gucstate_binary(char **srcptr, char *srcend, void *dest, Size size)
Definition guc.c:6064
static char * read_gucstate(char **srcptr, char *srcend)
Definition guc.c:6041
struct ErrorContextCallback * previous
Definition elog.h:299
void(* callback)(void *arg)
Definition elog.h:300
char * last_reported
Definition guc_tables.h:277
char * sourcefile
Definition guc_tables.h:279

References config_generic::_string, ErrorContextCallback::arg, Assert, ErrorContextCallback::callback, can_skip_gucvar(), dlist_mutable_iter::cur, dlist_container, dlist_foreach_modify, ereport, errcode(), errmsg, ERROR, error_context_stack, config_generic::extra, GUC_ACTION_SET, guc_free(), guc_nondef_list, guc_restore_error_context_callback(), InitializeOneGUCOption(), config_generic::last_reported, len, memcpy(), config_generic::nondef_link, PGC_BOOL, PGC_ENUM, PGC_INT, PGC_REAL, PGC_STRING, ErrorContextCallback::previous, read_gucstate(), read_gucstate_binary(), RemoveGUCFromLists(), config_generic::reset_extra, config_string::reset_val, result, set_config_option_ext(), set_config_sourcefile(), config_generic::sourcefile, config_generic::stack, config_string::variable, and config_generic::vartype.

Referenced by ParallelWorkerMain().

◆ RestrictSearchPath()

◆ SelectConfigFiles()

bool SelectConfigFiles ( const char *  userDoption,
const char *  progname 
)
extern

Definition at line 1656 of file guc.c.

1657{
1658 char *configdir;
1659 char *fname;
1660 bool fname_is_malloced;
1661 struct stat stat_buf;
1662 struct config_generic *data_directory_rec;
1663
1664 /* configdir is -D option, or $PGDATA if no -D */
1665 if (userDoption)
1666 configdir = make_absolute_path(userDoption);
1667 else
1668 configdir = make_absolute_path(getenv("PGDATA"));
1669
1670 if (configdir && stat(configdir, &stat_buf) != 0)
1671 {
1672 write_stderr("%s: could not access directory \"%s\": %m\n",
1673 progname,
1674 configdir);
1675 if (errno == ENOENT)
1676 write_stderr("Run initdb or pg_basebackup to initialize a PostgreSQL data directory.\n");
1677 goto fail;
1678 }
1679
1680 /*
1681 * Find the configuration file: if config_file was specified on the
1682 * command line, use it, else use configdir/postgresql.conf. In any case
1683 * ensure the result is an absolute path, so that it will be interpreted
1684 * the same way by future backends.
1685 */
1686 if (ConfigFileName)
1687 {
1689 fname_is_malloced = true;
1690 }
1691 else if (configdir)
1692 {
1693 fname = guc_malloc(FATAL,
1694 strlen(configdir) + strlen(CONFIG_FILENAME) + 2);
1695 sprintf(fname, "%s/%s", configdir, CONFIG_FILENAME);
1696 fname_is_malloced = false;
1697 }
1698 else
1699 {
1700 write_stderr("%s does not know where to find the server configuration file.\n"
1701 "You must specify the --config-file or -D invocation "
1702 "option or set the PGDATA environment variable.\n",
1703 progname);
1704 goto fail;
1705 }
1706
1707 /*
1708 * Set the ConfigFileName GUC variable to its final value, ensuring that
1709 * it can't be overridden later.
1710 */
1711 SetConfigOption("config_file", fname, PGC_POSTMASTER, PGC_S_OVERRIDE);
1712
1713 if (fname_is_malloced)
1714 free(fname);
1715 else
1716 guc_free(fname);
1717
1718 /*
1719 * Now read the config file for the first time.
1720 */
1721 if (stat(ConfigFileName, &stat_buf) != 0)
1722 {
1723 write_stderr("%s: could not access the server configuration file \"%s\": %m\n",
1725 goto fail;
1726 }
1727
1728 /*
1729 * Read the configuration file for the first time. This time only the
1730 * data_directory parameter is picked up to determine the data directory,
1731 * so that we can read the PG_AUTOCONF_FILENAME file next time.
1732 */
1734
1735 /*
1736 * If the data_directory GUC variable has been set, use that as DataDir;
1737 * otherwise use configdir if set; else punt.
1738 *
1739 * Note: SetDataDir will copy and absolute-ize its argument, so we don't
1740 * have to.
1741 */
1742 data_directory_rec =
1743 find_option("data_directory", false, false, PANIC);
1744 if (*data_directory_rec->_string.variable)
1745 SetDataDir(*data_directory_rec->_string.variable);
1746 else if (configdir)
1747 SetDataDir(configdir);
1748 else
1749 {
1750 write_stderr("%s does not know where to find the database system data.\n"
1751 "This can be specified as \"data_directory\" in \"%s\", "
1752 "or by the -D invocation option, or by the "
1753 "PGDATA environment variable.\n",
1755 goto fail;
1756 }
1757
1758 /*
1759 * Reflect the final DataDir value back into the data_directory GUC var.
1760 * (If you are wondering why we don't just make them a single variable,
1761 * it's because the EXEC_BACKEND case needs DataDir to be transmitted to
1762 * child backends specially. XXX is that still true? Given that we now
1763 * chdir to DataDir, EXEC_BACKEND can read the config file without knowing
1764 * DataDir in advance.)
1765 */
1767
1768 /*
1769 * Now read the config file a second time, allowing any settings in the
1770 * PG_AUTOCONF_FILENAME file to take effect. (This is pretty ugly, but
1771 * since we have to determine the DataDir before we can find the autoconf
1772 * file, the alternatives seem worse.)
1773 */
1775
1776 /*
1777 * If timezone_abbreviations wasn't set in the configuration file, install
1778 * the default value. We do it this way because we can't safely install a
1779 * "real" value until my_exec_path is set, which may not have happened
1780 * when InitializeGUCOptions runs, so the bootstrap default value cannot
1781 * be the real desired default.
1782 */
1784
1785 /*
1786 * Figure out where pg_hba.conf is, and make sure the path is absolute.
1787 */
1788 if (HbaFileName)
1789 {
1791 fname_is_malloced = true;
1792 }
1793 else if (configdir)
1794 {
1795 fname = guc_malloc(FATAL,
1796 strlen(configdir) + strlen(HBA_FILENAME) + 2);
1797 sprintf(fname, "%s/%s", configdir, HBA_FILENAME);
1798 fname_is_malloced = false;
1799 }
1800 else
1801 {
1802 write_stderr("%s does not know where to find the \"hba\" configuration file.\n"
1803 "This can be specified as \"hba_file\" in \"%s\", "
1804 "or by the -D invocation option, or by the "
1805 "PGDATA environment variable.\n",
1807 goto fail;
1808 }
1809 SetConfigOption("hba_file", fname, PGC_POSTMASTER, PGC_S_OVERRIDE);
1810
1811 if (fname_is_malloced)
1812 free(fname);
1813 else
1814 guc_free(fname);
1815
1816 /*
1817 * Likewise for pg_ident.conf.
1818 */
1819 if (IdentFileName)
1820 {
1822 fname_is_malloced = true;
1823 }
1824 else if (configdir)
1825 {
1826 fname = guc_malloc(FATAL,
1827 strlen(configdir) + strlen(IDENT_FILENAME) + 2);
1828 sprintf(fname, "%s/%s", configdir, IDENT_FILENAME);
1829 fname_is_malloced = false;
1830 }
1831 else
1832 {
1833 write_stderr("%s does not know where to find the \"ident\" configuration file.\n"
1834 "This can be specified as \"ident_file\" in \"%s\", "
1835 "or by the -D invocation option, or by the "
1836 "PGDATA environment variable.\n",
1838 goto fail;
1839 }
1840 SetConfigOption("ident_file", fname, PGC_POSTMASTER, PGC_S_OVERRIDE);
1841
1842 if (fname_is_malloced)
1843 free(fname);
1844 else
1845 guc_free(fname);
1846
1847 /*
1848 * Likewise for pg_hosts.conf.
1849 */
1850 if (HostsFileName)
1851 {
1853 fname_is_malloced = true;
1854 }
1855 else if (configdir)
1856 {
1857 fname = guc_malloc(FATAL,
1858 strlen(configdir) + strlen(HOSTS_FILENAME) + 2);
1859 sprintf(fname, "%s/%s", configdir, HOSTS_FILENAME);
1860 fname_is_malloced = false;
1861 }
1862 else
1863 {
1864 write_stderr("%s does not know where to find the \"hosts\" configuration file.\n"
1865 "This can be specified as \"hosts_file\" in \"%s\", "
1866 "or by the -D invocation option, or by the "
1867 "PGDATA environment variable.\n",
1869 goto fail;
1870 }
1871 SetConfigOption("hosts_file", fname, PGC_POSTMASTER, PGC_S_OVERRIDE);
1872
1873 if (fname_is_malloced)
1874 free(fname);
1875 else
1876 guc_free(fname);
1877
1878 free(configdir);
1879
1880 return true;
1881
1882fail:
1883 free(configdir);
1884
1885 return false;
1886}
#define write_stderr(str)
Definition parallel.c:186
#define FATAL
Definition elog.h:42
#define PANIC
Definition elog.h:44
char * DataDir
Definition globals.c:73
void ProcessConfigFile(GucContext context)
Definition guc-file.l:120
static void pg_timezone_abbrev_initialize(void)
Definition guc.c:1899
#define IDENT_FILENAME
Definition guc.c:58
#define HOSTS_FILENAME
Definition guc.c:59
#define HBA_FILENAME
Definition guc.c:57
#define CONFIG_FILENAME
Definition guc.c:56
char * HbaFileName
Definition guc_tables.c:584
char * HostsFileName
Definition guc_tables.c:586
char * ConfigFileName
Definition guc_tables.c:583
char * IdentFileName
Definition guc_tables.c:585
const char * progname
Definition main.c:44
void SetDataDir(const char *dir)
Definition miscinit.c:390
#define sprintf
Definition port.h:262
char * make_absolute_path(const char *path)
Definition path.c:807
static const char * userDoption
Definition postgres.c:167
#define free(a)

References config_generic::_string, CONFIG_FILENAME, ConfigFileName, DataDir, FATAL, find_option(), free, guc_free(), guc_malloc(), HBA_FILENAME, HbaFileName, HOSTS_FILENAME, HostsFileName, IDENT_FILENAME, IdentFileName, make_absolute_path(), PANIC, pg_timezone_abbrev_initialize(), PGC_POSTMASTER, PGC_S_OVERRIDE, ProcessConfigFile(), progname, SetConfigOption(), SetDataDir(), sprintf, stat, userDoption, config_string::variable, and write_stderr.

Referenced by BootstrapModeMain(), PostgresSingleUserMain(), and PostmasterMain().

◆ SerializeGUCState()

void SerializeGUCState ( Size  maxsize,
char *  start_address 
)
extern

Definition at line 6008 of file guc.c.

6009{
6010 char *curptr;
6011 Size actual_size;
6012 Size bytes_left;
6013 dlist_iter iter;
6014
6015 /* Reserve space for saving the actual size of the guc state */
6016 Assert(maxsize > sizeof(actual_size));
6017 curptr = start_address + sizeof(actual_size);
6018 bytes_left = maxsize - sizeof(actual_size);
6019
6020 /* We need only consider GUCs with source not PGC_S_DEFAULT */
6022 {
6023 struct config_generic *gconf = dlist_container(struct config_generic,
6024 nondef_link, iter.cur);
6025
6026 serialize_variable(&curptr, &bytes_left, gconf);
6027 }
6028
6029 /* Store actual size without assuming alignment of start_address. */
6030 actual_size = maxsize - bytes_left - sizeof(actual_size);
6031 memcpy(start_address, &actual_size, sizeof(actual_size));
6032}
static void serialize_variable(char **destptr, Size *maxbytes, struct config_generic *gconf)
Definition guc.c:5931

References Assert, dlist_iter::cur, dlist_container, dlist_foreach, guc_nondef_list, memcpy(), config_generic::nondef_link, and serialize_variable().

Referenced by InitializeParallelDSM().

◆ set_config_option()

int set_config_option ( const char *  name,
const char *  value,
GucContext  context,
GucSource  source,
GucAction  action,
bool  changeVal,
int  elevel,
bool  is_reload 
)
extern

Definition at line 3248 of file guc.c.

3252{
3253 Oid srole;
3254
3255 /*
3256 * Non-interactive sources should be treated as having all privileges,
3257 * except for PGC_S_CLIENT. Note in particular that this is true for
3258 * pg_db_role_setting sources (PGC_S_GLOBAL etc): we assume a suitable
3259 * privilege check was done when the pg_db_role_setting entry was made.
3260 */
3262 srole = GetUserId();
3263 else
3264 srole = BOOTSTRAP_SUPERUSERID;
3265
3266 return set_config_with_handle(name, NULL, value,
3267 context, source, srole,
3268 action, changeVal, elevel,
3269 is_reload);
3270}
int set_config_with_handle(const char *name, config_handle *handle, const char *value, GucContext context, GucSource source, Oid srole, GucAction action, bool changeVal, int elevel, bool is_reload)
Definition guc.c:3311

References GetUserId(), name, PGC_S_CLIENT, PGC_S_INTERACTIVE, set_config_with_handle(), source, and value.

Referenced by accept_weak_input(), applyRemoteGucs(), CreateSchemaCommand(), DefineIndex(), ExecSetVariableStmt(), execute_extension_script(), parse_subscription_options(), ProcessConfigFileInternal(), ProcessGUCArray(), RestrictSearchPath(), RI_Initial_Check(), RI_PartitionRemove_Check(), set_config_by_name(), set_transmission_modes(), SetConfigOption(), SetPGVariable(), test_plan_advice_advisor(), and validate_option_array_item().

◆ set_config_option_ext()

int set_config_option_ext ( const char *  name,
const char *  value,
GucContext  context,
GucSource  source,
Oid  srole,
GucAction  action,
bool  changeVal,
int  elevel,
bool  is_reload 
)
extern

Definition at line 3288 of file guc.c.

3292{
3293 return set_config_with_handle(name, NULL, value,
3294 context, source, srole,
3295 action, changeVal, elevel,
3296 is_reload);
3297}

References name, set_config_with_handle(), source, and value.

Referenced by define_custom_variable(), execute_extension_script(), InitializeWalConsistencyChecking(), reapply_stacked_values(), and RestoreGUCState().

◆ set_config_with_handle()

int set_config_with_handle ( const char *  name,
config_handle handle,
const char *  value,
GucContext  context,
GucSource  source,
Oid  srole,
GucAction  action,
bool  changeVal,
int  elevel,
bool  is_reload 
)
extern

Definition at line 3311 of file guc.c.

3316{
3317 struct config_generic *record;
3318 union config_var_val newval_union;
3319 void *newextra = NULL;
3320 bool prohibitValueChange = false;
3321 bool makeDefault;
3322
3323 if (elevel == 0)
3324 {
3326 {
3327 /*
3328 * To avoid cluttering the log, only the postmaster bleats loudly
3329 * about problems with the config file.
3330 */
3331 elevel = IsUnderPostmaster ? DEBUG3 : LOG;
3332 }
3333 else if (source == PGC_S_GLOBAL ||
3335 source == PGC_S_USER ||
3337 elevel = WARNING;
3338 else
3339 elevel = ERROR;
3340 }
3341
3342 /* if handle is specified, no need to look up option */
3343 if (!handle)
3344 {
3345 record = find_option(name, true, false, elevel);
3346 if (record == NULL)
3347 return 0;
3348 }
3349 else
3350 record = handle;
3351
3352 /*
3353 * GUC_ACTION_SAVE changes are acceptable during a parallel operation,
3354 * because the current worker will also pop the change. We're probably
3355 * dealing with a function having a proconfig entry. Only the function's
3356 * body should observe the change, and peer workers do not share in the
3357 * execution of a function call started by this worker.
3358 *
3359 * Also allow normal setting if the GUC is marked GUC_ALLOW_IN_PARALLEL.
3360 *
3361 * Other changes might need to affect other workers, so forbid them. Note,
3362 * that parallel autovacuum leader is an exception because cost-based
3363 * delays need to be affected to parallel autovacuum workers. These
3364 * parameters are propagated to its workers during parallel vacuum (see
3365 * vacuumparallel.c for details). All other changes will affect only the
3366 * parallel autovacuum leader.
3367 */
3368 if (IsInParallelMode() && !AmAutoVacuumWorkerProcess() && changeVal &&
3369 action != GUC_ACTION_SAVE &&
3370 (record->flags & GUC_ALLOW_IN_PARALLEL) == 0)
3371 {
3372 ereport(elevel,
3373 (errcode(ERRCODE_INVALID_TRANSACTION_STATE),
3374 errmsg("parameter \"%s\" cannot be set during a parallel operation",
3375 record->name)));
3376 return 0;
3377 }
3378
3379 /*
3380 * Check if the option can be set at this time. See guc.h for the precise
3381 * rules.
3382 */
3383 switch (record->context)
3384 {
3385 case PGC_INTERNAL:
3386 if (context != PGC_INTERNAL)
3387 {
3388 ereport(elevel,
3389 (errcode(ERRCODE_CANT_CHANGE_RUNTIME_PARAM),
3390 errmsg("parameter \"%s\" cannot be changed",
3391 record->name)));
3392 return 0;
3393 }
3394 break;
3395 case PGC_POSTMASTER:
3396 if (context == PGC_SIGHUP)
3397 {
3398 /*
3399 * We are re-reading a PGC_POSTMASTER variable from
3400 * postgresql.conf. We can't change the setting, so we should
3401 * give a warning if the DBA tries to change it. However,
3402 * because of variant formats, canonicalization by check
3403 * hooks, etc, we can't just compare the given string directly
3404 * to what's stored. Set a flag to check below after we have
3405 * the final storable value.
3406 */
3407 prohibitValueChange = true;
3408 }
3409 else if (context != PGC_POSTMASTER)
3410 {
3411 ereport(elevel,
3412 (errcode(ERRCODE_CANT_CHANGE_RUNTIME_PARAM),
3413 errmsg("parameter \"%s\" cannot be changed without restarting the server",
3414 record->name)));
3415 return 0;
3416 }
3417 break;
3418 case PGC_SIGHUP:
3419 if (context != PGC_SIGHUP && context != PGC_POSTMASTER)
3420 {
3421 ereport(elevel,
3422 (errcode(ERRCODE_CANT_CHANGE_RUNTIME_PARAM),
3423 errmsg("parameter \"%s\" cannot be changed now",
3424 record->name)));
3425 return 0;
3426 }
3427
3428 /*
3429 * Hmm, the idea of the SIGHUP context is "ought to be global, but
3430 * can be changed after postmaster start". But there's nothing
3431 * that prevents a crafty administrator from sending SIGHUP
3432 * signals to individual backends only.
3433 */
3434 break;
3435 case PGC_SU_BACKEND:
3436 if (context == PGC_BACKEND)
3437 {
3438 /*
3439 * Check whether the requesting user has been granted
3440 * privilege to set this GUC.
3441 */
3442 AclResult aclresult;
3443
3444 aclresult = pg_parameter_aclcheck(record->name, srole, ACL_SET);
3445 if (aclresult != ACLCHECK_OK)
3446 {
3447 /* No granted privilege */
3448 ereport(elevel,
3449 (errcode(ERRCODE_INSUFFICIENT_PRIVILEGE),
3450 errmsg("permission denied to set parameter \"%s\"",
3451 record->name)));
3452 return 0;
3453 }
3454 }
3455 /* fall through to process the same as PGC_BACKEND */
3457 case PGC_BACKEND:
3458 if (context == PGC_SIGHUP)
3459 {
3460 /*
3461 * If a PGC_BACKEND or PGC_SU_BACKEND parameter is changed in
3462 * the config file, we want to accept the new value in the
3463 * postmaster (whence it will propagate to
3464 * subsequently-started backends), but ignore it in existing
3465 * backends. This is a tad klugy, but necessary because we
3466 * don't re-read the config file during backend start.
3467 *
3468 * However, if changeVal is false then plow ahead anyway since
3469 * we are trying to find out if the value is potentially good,
3470 * not actually use it.
3471 *
3472 * In EXEC_BACKEND builds, this works differently: we load all
3473 * non-default settings from the CONFIG_EXEC_PARAMS file
3474 * during backend start. In that case we must accept
3475 * PGC_SIGHUP settings, so as to have the same value as if
3476 * we'd forked from the postmaster. This can also happen when
3477 * using RestoreGUCState() within a background worker that
3478 * needs to have the same settings as the user backend that
3479 * started it. is_reload will be true when either situation
3480 * applies.
3481 */
3482 if (IsUnderPostmaster && changeVal && !is_reload)
3483 return -1;
3484 }
3485 else if (context != PGC_POSTMASTER &&
3486 context != PGC_BACKEND &&
3487 context != PGC_SU_BACKEND &&
3489 {
3490 ereport(elevel,
3491 (errcode(ERRCODE_CANT_CHANGE_RUNTIME_PARAM),
3492 errmsg("parameter \"%s\" cannot be set after connection start",
3493 record->name)));
3494 return 0;
3495 }
3496 break;
3497 case PGC_SUSET:
3498 if (context == PGC_USERSET || context == PGC_BACKEND)
3499 {
3500 /*
3501 * Check whether the requesting user has been granted
3502 * privilege to set this GUC.
3503 */
3504 AclResult aclresult;
3505
3506 aclresult = pg_parameter_aclcheck(record->name, srole, ACL_SET);
3507 if (aclresult != ACLCHECK_OK)
3508 {
3509 /* No granted privilege */
3510 ereport(elevel,
3511 (errcode(ERRCODE_INSUFFICIENT_PRIVILEGE),
3512 errmsg("permission denied to set parameter \"%s\"",
3513 record->name)));
3514 return 0;
3515 }
3516 }
3517 break;
3518 case PGC_USERSET:
3519 /* always okay */
3520 break;
3521 }
3522
3523 /*
3524 * Disallow changing GUC_NOT_WHILE_SEC_REST values if we are inside a
3525 * security restriction context. We can reject this regardless of the GUC
3526 * context or source, mainly because sources that it might be reasonable
3527 * to override for won't be seen while inside a function.
3528 *
3529 * Note: variables marked GUC_NOT_WHILE_SEC_REST should usually be marked
3530 * GUC_NO_RESET_ALL as well, because ResetAllOptions() doesn't check this.
3531 * An exception might be made if the reset value is assumed to be "safe".
3532 *
3533 * Note: this flag is currently used for "session_authorization" and
3534 * "role". We need to prohibit changing these inside a local userid
3535 * context because when we exit it, GUC won't be notified, leaving things
3536 * out of sync. (This could be fixed by forcing a new GUC nesting level,
3537 * but that would change behavior in possibly-undesirable ways.) Also, we
3538 * prohibit changing these in a security-restricted operation because
3539 * otherwise RESET could be used to regain the session user's privileges.
3540 */
3541 if (record->flags & GUC_NOT_WHILE_SEC_REST)
3542 {
3543 if (InLocalUserIdChange())
3544 {
3545 /*
3546 * Phrasing of this error message is historical, but it's the most
3547 * common case.
3548 */
3549 ereport(elevel,
3550 (errcode(ERRCODE_INSUFFICIENT_PRIVILEGE),
3551 errmsg("cannot set parameter \"%s\" within security-definer function",
3552 record->name)));
3553 return 0;
3554 }
3556 {
3557 ereport(elevel,
3558 (errcode(ERRCODE_INSUFFICIENT_PRIVILEGE),
3559 errmsg("cannot set parameter \"%s\" within security-restricted operation",
3560 record->name)));
3561 return 0;
3562 }
3563 }
3564
3565 /* Disallow resetting and saving GUC_NO_RESET values */
3566 if (record->flags & GUC_NO_RESET)
3567 {
3568 if (value == NULL)
3569 {
3570 ereport(elevel,
3571 (errcode(ERRCODE_FEATURE_NOT_SUPPORTED),
3572 errmsg("parameter \"%s\" cannot be reset", record->name)));
3573 return 0;
3574 }
3575 if (action == GUC_ACTION_SAVE)
3576 {
3577 ereport(elevel,
3578 (errcode(ERRCODE_FEATURE_NOT_SUPPORTED),
3579 errmsg("parameter \"%s\" cannot be set locally in functions",
3580 record->name)));
3581 return 0;
3582 }
3583 }
3584
3585 /*
3586 * Should we set reset/stacked values? (If so, the behavior is not
3587 * transactional.) This is done either when we get a default value from
3588 * the database's/user's/client's default settings or when we reset a
3589 * value to its default.
3590 */
3591 makeDefault = changeVal && (source <= PGC_S_OVERRIDE) &&
3592 ((value != NULL) || source == PGC_S_DEFAULT);
3593
3594 /*
3595 * Ignore attempted set if overridden by previously processed setting.
3596 * However, if changeVal is false then plow ahead anyway since we are
3597 * trying to find out if the value is potentially good, not actually use
3598 * it. Also keep going if makeDefault is true, since we may want to set
3599 * the reset/stacked values even if we can't set the variable itself.
3600 */
3601 if (record->source > source)
3602 {
3603 if (changeVal && !makeDefault)
3604 {
3605 elog(DEBUG3, "\"%s\": setting ignored because previous source is higher priority",
3606 record->name);
3607 return -1;
3608 }
3609 changeVal = false;
3610 }
3611
3612 /*
3613 * Evaluate value and set variable.
3614 */
3615 switch (record->vartype)
3616 {
3617 case PGC_BOOL:
3618 {
3619 struct config_bool *conf = &record->_bool;
3620
3621#define newval (newval_union.boolval)
3622
3623 if (value)
3624 {
3625 if (!parse_and_validate_value(record, value,
3626 source, elevel,
3627 &newval_union, &newextra))
3628 return 0;
3629 }
3630 else if (source == PGC_S_DEFAULT)
3631 {
3632 newval = conf->boot_val;
3633 if (!call_bool_check_hook(record, &newval, &newextra,
3634 source, elevel))
3635 return 0;
3636 }
3637 else
3638 {
3639 newval = conf->reset_val;
3640 newextra = record->reset_extra;
3641 source = record->reset_source;
3642 context = record->reset_scontext;
3643 srole = record->reset_srole;
3644 }
3645
3646 if (prohibitValueChange)
3647 {
3648 /* Release newextra, unless it's reset_extra */
3649 if (newextra && !extra_field_used(record, newextra))
3650 guc_free(newextra);
3651
3652 if (*conf->variable != newval)
3653 {
3654 record->status |= GUC_PENDING_RESTART;
3655 ereport(elevel,
3656 (errcode(ERRCODE_CANT_CHANGE_RUNTIME_PARAM),
3657 errmsg("parameter \"%s\" cannot be changed without restarting the server",
3658 record->name)));
3659 return 0;
3660 }
3661 record->status &= ~GUC_PENDING_RESTART;
3662 return -1;
3663 }
3664
3665 if (changeVal)
3666 {
3667 /* Save old value to support transaction abort */
3668 if (!makeDefault)
3669 push_old_value(record, action);
3670
3671 if (conf->assign_hook)
3672 conf->assign_hook(newval, newextra);
3673 *conf->variable = newval;
3674 set_extra_field(record, &record->extra,
3675 newextra);
3676 set_guc_source(record, source);
3677 record->scontext = context;
3678 record->srole = srole;
3679 }
3680 if (makeDefault)
3681 {
3682 if (record->reset_source <= source)
3683 {
3684 conf->reset_val = newval;
3685 set_extra_field(record, &record->reset_extra,
3686 newextra);
3687 record->reset_source = source;
3688 record->reset_scontext = context;
3689 record->reset_srole = srole;
3690 }
3691 for (GucStack *stack = record->stack; stack; stack = stack->prev)
3692 {
3693 if (stack->source <= source)
3694 {
3695 stack->prior.val.boolval = newval;
3696 set_extra_field(record, &stack->prior.extra,
3697 newextra);
3698 stack->source = source;
3699 stack->scontext = context;
3700 stack->srole = srole;
3701 }
3702 }
3703 }
3704
3705 /* Perhaps we didn't install newextra anywhere */
3706 if (newextra && !extra_field_used(record, newextra))
3707 guc_free(newextra);
3708 break;
3709
3710#undef newval
3711 }
3712
3713 case PGC_INT:
3714 {
3715 struct config_int *conf = &record->_int;
3716
3717#define newval (newval_union.intval)
3718
3719 if (value)
3720 {
3721 if (!parse_and_validate_value(record, value,
3722 source, elevel,
3723 &newval_union, &newextra))
3724 return 0;
3725 }
3726 else if (source == PGC_S_DEFAULT)
3727 {
3728 newval = conf->boot_val;
3729 if (!call_int_check_hook(record, &newval, &newextra,
3730 source, elevel))
3731 return 0;
3732 }
3733 else
3734 {
3735 newval = conf->reset_val;
3736 newextra = record->reset_extra;
3737 source = record->reset_source;
3738 context = record->reset_scontext;
3739 srole = record->reset_srole;
3740 }
3741
3742 if (prohibitValueChange)
3743 {
3744 /* Release newextra, unless it's reset_extra */
3745 if (newextra && !extra_field_used(record, newextra))
3746 guc_free(newextra);
3747
3748 if (*conf->variable != newval)
3749 {
3750 record->status |= GUC_PENDING_RESTART;
3751 ereport(elevel,
3752 (errcode(ERRCODE_CANT_CHANGE_RUNTIME_PARAM),
3753 errmsg("parameter \"%s\" cannot be changed without restarting the server",
3754 record->name)));
3755 return 0;
3756 }
3757 record->status &= ~GUC_PENDING_RESTART;
3758 return -1;
3759 }
3760
3761 if (changeVal)
3762 {
3763 /* Save old value to support transaction abort */
3764 if (!makeDefault)
3765 push_old_value(record, action);
3766
3767 if (conf->assign_hook)
3768 conf->assign_hook(newval, newextra);
3769 *conf->variable = newval;
3770 set_extra_field(record, &record->extra,
3771 newextra);
3772 set_guc_source(record, source);
3773 record->scontext = context;
3774 record->srole = srole;
3775 }
3776 if (makeDefault)
3777 {
3778 if (record->reset_source <= source)
3779 {
3780 conf->reset_val = newval;
3781 set_extra_field(record, &record->reset_extra,
3782 newextra);
3783 record->reset_source = source;
3784 record->reset_scontext = context;
3785 record->reset_srole = srole;
3786 }
3787 for (GucStack *stack = record->stack; stack; stack = stack->prev)
3788 {
3789 if (stack->source <= source)
3790 {
3791 stack->prior.val.intval = newval;
3792 set_extra_field(record, &stack->prior.extra,
3793 newextra);
3794 stack->source = source;
3795 stack->scontext = context;
3796 stack->srole = srole;
3797 }
3798 }
3799 }
3800
3801 /* Perhaps we didn't install newextra anywhere */
3802 if (newextra && !extra_field_used(record, newextra))
3803 guc_free(newextra);
3804 break;
3805
3806#undef newval
3807 }
3808
3809 case PGC_REAL:
3810 {
3811 struct config_real *conf = &record->_real;
3812
3813#define newval (newval_union.realval)
3814
3815 if (value)
3816 {
3817 if (!parse_and_validate_value(record, value,
3818 source, elevel,
3819 &newval_union, &newextra))
3820 return 0;
3821 }
3822 else if (source == PGC_S_DEFAULT)
3823 {
3824 newval = conf->boot_val;
3825 if (!call_real_check_hook(record, &newval, &newextra,
3826 source, elevel))
3827 return 0;
3828 }
3829 else
3830 {
3831 newval = conf->reset_val;
3832 newextra = record->reset_extra;
3833 source = record->reset_source;
3834 context = record->reset_scontext;
3835 srole = record->reset_srole;
3836 }
3837
3838 if (prohibitValueChange)
3839 {
3840 /* Release newextra, unless it's reset_extra */
3841 if (newextra && !extra_field_used(record, newextra))
3842 guc_free(newextra);
3843
3844 if (*conf->variable != newval)
3845 {
3846 record->status |= GUC_PENDING_RESTART;
3847 ereport(elevel,
3848 (errcode(ERRCODE_CANT_CHANGE_RUNTIME_PARAM),
3849 errmsg("parameter \"%s\" cannot be changed without restarting the server",
3850 record->name)));
3851 return 0;
3852 }
3853 record->status &= ~GUC_PENDING_RESTART;
3854 return -1;
3855 }
3856
3857 if (changeVal)
3858 {
3859 /* Save old value to support transaction abort */
3860 if (!makeDefault)
3861 push_old_value(record, action);
3862
3863 if (conf->assign_hook)
3864 conf->assign_hook(newval, newextra);
3865 *conf->variable = newval;
3866 set_extra_field(record, &record->extra,
3867 newextra);
3868 set_guc_source(record, source);
3869 record->scontext = context;
3870 record->srole = srole;
3871 }
3872 if (makeDefault)
3873 {
3874 if (record->reset_source <= source)
3875 {
3876 conf->reset_val = newval;
3877 set_extra_field(record, &record->reset_extra,
3878 newextra);
3879 record->reset_source = source;
3880 record->reset_scontext = context;
3881 record->reset_srole = srole;
3882 }
3883 for (GucStack *stack = record->stack; stack; stack = stack->prev)
3884 {
3885 if (stack->source <= source)
3886 {
3887 stack->prior.val.realval = newval;
3888 set_extra_field(record, &stack->prior.extra,
3889 newextra);
3890 stack->source = source;
3891 stack->scontext = context;
3892 stack->srole = srole;
3893 }
3894 }
3895 }
3896
3897 /* Perhaps we didn't install newextra anywhere */
3898 if (newextra && !extra_field_used(record, newextra))
3899 guc_free(newextra);
3900 break;
3901
3902#undef newval
3903 }
3904
3905 case PGC_STRING:
3906 {
3907 struct config_string *conf = &record->_string;
3908 GucContext orig_context = context;
3909 GucSource orig_source = source;
3910 Oid orig_srole = srole;
3911
3912#define newval (newval_union.stringval)
3913
3914 if (value)
3915 {
3916 if (!parse_and_validate_value(record, value,
3917 source, elevel,
3918 &newval_union, &newextra))
3919 return 0;
3920 }
3921 else if (source == PGC_S_DEFAULT)
3922 {
3923 /* non-NULL boot_val must always get strdup'd */
3924 if (conf->boot_val != NULL)
3925 {
3926 newval = guc_strdup(elevel, conf->boot_val);
3927 if (newval == NULL)
3928 return 0;
3929 }
3930 else
3931 newval = NULL;
3932
3933 if (!call_string_check_hook(record, &newval, &newextra,
3934 source, elevel))
3935 {
3937 return 0;
3938 }
3939 }
3940 else
3941 {
3942 /*
3943 * strdup not needed, since reset_val is already under
3944 * guc.c's control
3945 */
3946 newval = conf->reset_val;
3947 newextra = record->reset_extra;
3948 source = record->reset_source;
3949 context = record->reset_scontext;
3950 srole = record->reset_srole;
3951 }
3952
3953 if (prohibitValueChange)
3954 {
3955 bool newval_different;
3956
3957 /* newval shouldn't be NULL, so we're a bit sloppy here */
3958 newval_different = (*conf->variable == NULL ||
3959 newval == NULL ||
3960 strcmp(*conf->variable, newval) != 0);
3961
3962 /* Release newval, unless it's reset_val */
3963 if (newval && !string_field_used(record, newval))
3965 /* Release newextra, unless it's reset_extra */
3966 if (newextra && !extra_field_used(record, newextra))
3967 guc_free(newextra);
3968
3969 if (newval_different)
3970 {
3971 record->status |= GUC_PENDING_RESTART;
3972 ereport(elevel,
3973 (errcode(ERRCODE_CANT_CHANGE_RUNTIME_PARAM),
3974 errmsg("parameter \"%s\" cannot be changed without restarting the server",
3975 record->name)));
3976 return 0;
3977 }
3978 record->status &= ~GUC_PENDING_RESTART;
3979 return -1;
3980 }
3981
3982 if (changeVal)
3983 {
3984 /* Save old value to support transaction abort */
3985 if (!makeDefault)
3986 push_old_value(record, action);
3987
3988 if (conf->assign_hook)
3989 conf->assign_hook(newval, newextra);
3990 set_string_field(record, conf->variable, newval);
3991 set_extra_field(record, &record->extra,
3992 newextra);
3993 set_guc_source(record, source);
3994 record->scontext = context;
3995 record->srole = srole;
3996
3997 /*
3998 * Ugly hack: during SET session_authorization, forcibly
3999 * do SET ROLE NONE with the same context/source/etc, so
4000 * that the effects will have identical lifespan. This is
4001 * required by the SQL spec, and it's not possible to do
4002 * it within the variable's check hook or assign hook
4003 * because our APIs for those don't pass enough info.
4004 * However, don't do it if is_reload: in that case we
4005 * expect that if "role" isn't supposed to be default, it
4006 * has been or will be set by a separate reload action.
4007 *
4008 * Also, for the call from InitializeSessionUserId with
4009 * source == PGC_S_OVERRIDE, use PGC_S_DYNAMIC_DEFAULT for
4010 * "role"'s source, so that it's still possible to set
4011 * "role" from pg_db_role_setting entries. (See notes in
4012 * InitializeSessionUserId before changing this.)
4013 *
4014 * A fine point: for RESET session_authorization, we do
4015 * "RESET role" not "SET ROLE NONE" (by passing down NULL
4016 * rather than "none" for the value). This would have the
4017 * same effects in typical cases, but if the reset value
4018 * of "role" is not "none" it seems better to revert to
4019 * that.
4020 */
4021 if (!is_reload &&
4022 strcmp(record->name, "session_authorization") == 0)
4023 (void) set_config_with_handle("role", NULL,
4024 value ? "none" : NULL,
4025 orig_context,
4026 (orig_source == PGC_S_OVERRIDE)
4028 : orig_source,
4029 orig_srole,
4030 action,
4031 true,
4032 elevel,
4033 false);
4034 }
4035
4036 if (makeDefault)
4037 {
4038 if (record->reset_source <= source)
4039 {
4040 set_string_field(record, &conf->reset_val, newval);
4041 set_extra_field(record, &record->reset_extra,
4042 newextra);
4043 record->reset_source = source;
4044 record->reset_scontext = context;
4045 record->reset_srole = srole;
4046 }
4047 for (GucStack *stack = record->stack; stack; stack = stack->prev)
4048 {
4049 if (stack->source <= source)
4050 {
4051 set_string_field(record, &stack->prior.val.stringval,
4052 newval);
4053 set_extra_field(record, &stack->prior.extra,
4054 newextra);
4055 stack->source = source;
4056 stack->scontext = context;
4057 stack->srole = srole;
4058 }
4059 }
4060 }
4061
4062 /* Perhaps we didn't install newval anywhere */
4063 if (newval && !string_field_used(record, newval))
4065 /* Perhaps we didn't install newextra anywhere */
4066 if (newextra && !extra_field_used(record, newextra))
4067 guc_free(newextra);
4068 break;
4069
4070#undef newval
4071 }
4072
4073 case PGC_ENUM:
4074 {
4075 struct config_enum *conf = &record->_enum;
4076
4077#define newval (newval_union.enumval)
4078
4079 if (value)
4080 {
4081 if (!parse_and_validate_value(record, value,
4082 source, elevel,
4083 &newval_union, &newextra))
4084 return 0;
4085 }
4086 else if (source == PGC_S_DEFAULT)
4087 {
4088 newval = conf->boot_val;
4089 if (!call_enum_check_hook(record, &newval, &newextra,
4090 source, elevel))
4091 return 0;
4092 }
4093 else
4094 {
4095 newval = conf->reset_val;
4096 newextra = record->reset_extra;
4097 source = record->reset_source;
4098 context = record->reset_scontext;
4099 srole = record->reset_srole;
4100 }
4101
4102 if (prohibitValueChange)
4103 {
4104 /* Release newextra, unless it's reset_extra */
4105 if (newextra && !extra_field_used(record, newextra))
4106 guc_free(newextra);
4107
4108 if (*conf->variable != newval)
4109 {
4110 record->status |= GUC_PENDING_RESTART;
4111 ereport(elevel,
4112 (errcode(ERRCODE_CANT_CHANGE_RUNTIME_PARAM),
4113 errmsg("parameter \"%s\" cannot be changed without restarting the server",
4114 record->name)));
4115 return 0;
4116 }
4117 record->status &= ~GUC_PENDING_RESTART;
4118 return -1;
4119 }
4120
4121 if (changeVal)
4122 {
4123 /* Save old value to support transaction abort */
4124 if (!makeDefault)
4125 push_old_value(record, action);
4126
4127 if (conf->assign_hook)
4128 conf->assign_hook(newval, newextra);
4129 *conf->variable = newval;
4130 set_extra_field(record, &record->extra,
4131 newextra);
4132 set_guc_source(record, source);
4133 record->scontext = context;
4134 record->srole = srole;
4135 }
4136 if (makeDefault)
4137 {
4138 if (record->reset_source <= source)
4139 {
4140 conf->reset_val = newval;
4141 set_extra_field(record, &record->reset_extra,
4142 newextra);
4143 record->reset_source = source;
4144 record->reset_scontext = context;
4145 record->reset_srole = srole;
4146 }
4147 for (GucStack *stack = record->stack; stack; stack = stack->prev)
4148 {
4149 if (stack->source <= source)
4150 {
4151 stack->prior.val.enumval = newval;
4152 set_extra_field(record, &stack->prior.extra,
4153 newextra);
4154 stack->source = source;
4155 stack->scontext = context;
4156 stack->srole = srole;
4157 }
4158 }
4159 }
4160
4161 /* Perhaps we didn't install newextra anywhere */
4162 if (newextra && !extra_field_used(record, newextra))
4163 guc_free(newextra);
4164 break;
4165
4166#undef newval
4167 }
4168 }
4169
4170 if (changeVal && (record->flags & GUC_REPORT) &&
4171 !(record->status & GUC_NEEDS_REPORT))
4172 {
4173 record->status |= GUC_NEEDS_REPORT;
4175 }
4176
4177 return changeVal ? 1 : -1;
4178}
#define DEBUG3
Definition elog.h:29
static bool call_real_check_hook(const struct config_generic *conf, double *newval, void **extra, GucSource source, int elevel)
Definition guc.c:6747
static bool call_enum_check_hook(const struct config_generic *conf, int *newval, void **extra, GucSource source, int elevel)
Definition guc.c:6831
static bool call_int_check_hook(const struct config_generic *conf, int *newval, void **extra, GucSource source, int elevel)
Definition guc.c:6713
static bool extra_field_used(struct config_generic *gconf, void *extra)
Definition guc.c:744
static void static bool call_bool_check_hook(const struct config_generic *conf, bool *newval, void **extra, GucSource source, int elevel)
Definition guc.c:6679
char * guc_strdup(int elevel, const char *src)
Definition guc.c:676
static bool string_field_used(struct config_generic *conf, char *strval)
Definition guc.c:707
static bool call_string_check_hook(const struct config_generic *conf, char **newval, void **extra, GucSource source, int elevel)
Definition guc.c:6781
#define GUC_NO_RESET
Definition guc.h:217
#define GUC_NOT_WHILE_SEC_REST
Definition guc.h:226
#define GUC_ALLOW_IN_PARALLEL
Definition guc.h:230
#define GUC_PENDING_RESTART
Definition guc_tables.h:300
#define AmAutoVacuumWorkerProcess()
Definition miscadmin.h:398
bool InSecurityRestrictedOperation(void)
Definition miscinit.c:640
bool InLocalUserIdChange(void)
Definition miscinit.c:631
double boot_val
Definition guc_tables.h:169
const char * boot_val
Definition guc_tables.h:193

References config_generic::_bool, config_generic::_enum, config_generic::_int, config_generic::_real, config_generic::_string, ACL_SET, ACLCHECK_OK, AmAutoVacuumWorkerProcess, config_bool::assign_hook, config_int::assign_hook, config_real::assign_hook, config_string::assign_hook, config_enum::assign_hook, config_bool::boot_val, config_int::boot_val, config_real::boot_val, config_string::boot_val, config_enum::boot_val, call_bool_check_hook(), call_enum_check_hook(), call_int_check_hook(), call_real_check_hook(), call_string_check_hook(), config_generic::context, DEBUG3, elog, ereport, errcode(), errmsg, ERROR, config_generic::extra, extra_field_used(), find_option(), config_generic::flags, GUC_ACTION_SAVE, GUC_ALLOW_IN_PARALLEL, guc_free(), GUC_NEEDS_REPORT, GUC_NO_RESET, GUC_NOT_WHILE_SEC_REST, GUC_PENDING_RESTART, GUC_REPORT, guc_report_list, guc_strdup(), InLocalUserIdChange(), InSecurityRestrictedOperation(), IsInParallelMode(), IsUnderPostmaster, LOG, name, config_generic::name, newval, parse_and_validate_value(), pg_fallthrough, pg_parameter_aclcheck(), PGC_BACKEND, PGC_BOOL, PGC_ENUM, PGC_INT, PGC_INTERNAL, PGC_POSTMASTER, PGC_REAL, PGC_S_CLIENT, PGC_S_DATABASE, PGC_S_DATABASE_USER, PGC_S_DEFAULT, PGC_S_DYNAMIC_DEFAULT, PGC_S_FILE, PGC_S_GLOBAL, PGC_S_OVERRIDE, PGC_S_USER, PGC_SIGHUP, PGC_STRING, PGC_SU_BACKEND, PGC_SUSET, PGC_USERSET, push_old_value(), config_generic::report_link, config_generic::reset_extra, config_generic::reset_scontext, config_generic::reset_source, config_generic::reset_srole, config_bool::reset_val, config_int::reset_val, config_real::reset_val, config_string::reset_val, config_enum::reset_val, config_generic::scontext, set_config_with_handle(), set_extra_field(), set_guc_source(), set_string_field(), slist_push_head(), source, config_generic::source, config_generic::srole, config_generic::stack, config_generic::status, string_field_used(), value, config_bool::variable, config_int::variable, config_real::variable, config_string::variable, config_enum::variable, config_generic::vartype, and WARNING.

Referenced by fmgr_security_definer(), set_config_option(), set_config_option_ext(), and set_config_with_handle().

◆ SetConfigOption()

◆ SetPGVariable()

void SetPGVariable ( const char *  name,
List args,
bool  is_local 
)
extern

Definition at line 343 of file guc_funcs.c.

344{
345 char *argstring = flatten_set_variable_args(name, args);
346
347 /* Note SET DEFAULT (argstring == NULL) is equivalent to RESET */
348 (void) set_config_option(name,
349 argstring,
352 is_local ? GUC_ACTION_LOCAL : GUC_ACTION_SET,
353 true, 0, false);
354}

References flatten_set_variable_args(), GUC_ACTION_LOCAL, GUC_ACTION_SET, name, PGC_S_SESSION, PGC_SUSET, PGC_USERSET, set_config_option(), and superuser().

Referenced by DiscardAll(), ExecSetVariableStmt(), and standard_ProcessUtility().

◆ TransformGUCArray()

void TransformGUCArray ( ArrayType array,
List **  names,
List **  values 
)
extern

Definition at line 6279 of file guc.c.

6280{
6281 Assert(array != NULL);
6282 Assert(ARR_ELEMTYPE(array) == TEXTOID);
6283 Assert(ARR_NDIM(array) == 1);
6284 Assert(ARR_LBOUND(array)[0] == 1);
6285
6286 *names = NIL;
6287 *values = NIL;
6288 for (int i = 1; i <= ARR_DIMS(array)[0]; i++)
6289 {
6290 Datum d;
6291 bool isnull;
6292 char *s;
6293 char *name;
6294 char *value;
6295
6296 d = array_ref(array, 1, &i,
6297 -1 /* varlenarray */ ,
6298 -1 /* TEXT's typlen */ ,
6299 false /* TEXT's typbyval */ ,
6300 TYPALIGN_INT /* TEXT's typalign */ ,
6301 &isnull);
6302
6303 if (isnull)
6304 continue;
6305
6306 s = TextDatumGetCString(d);
6307
6308 ParseLongOption(s, &name, &value);
6309 if (!value)
6310 {
6312 (errcode(ERRCODE_SYNTAX_ERROR),
6313 errmsg("could not parse setting for parameter \"%s\"",
6314 name)));
6315 pfree(name);
6316 continue;
6317 }
6318
6319 *names = lappend(*names, name);
6320 *values = lappend(*values, value);
6321
6322 pfree(s);
6323 }
6324}
static Datum values[MAXATTR]
Definition bootstrap.c:190
void ParseLongOption(const char *string, char **name, char **value)
Definition guc.c:6243
#define NIL
Definition pg_list.h:68

References ARR_DIMS, ARR_ELEMTYPE, ARR_LBOUND, ARR_NDIM, array_ref(), Assert, ereport, errcode(), errmsg, i, lappend(), name, NIL, ParseLongOption(), pfree(), TextDatumGetCString, value, values, and WARNING.

Referenced by fmgr_security_definer(), and ProcessGUCArray().

Variable Documentation

◆ AllowAlterSystem

PGDLLIMPORT bool AllowAlterSystem
extern

Definition at line 534 of file guc_tables.c.

Referenced by AlterSystemSetConfigFile().

◆ application_name

◆ archive_mode_options

PGDLLIMPORT const struct config_enum_entry archive_mode_options[]
extern

Definition at line 198 of file xlog.c.

198 {
199 {"always", ARCHIVE_MODE_ALWAYS, false},
200 {"on", ARCHIVE_MODE_ON, false},
201 {"off", ARCHIVE_MODE_OFF, false},
202 {"true", ARCHIVE_MODE_ON, true},
203 {"false", ARCHIVE_MODE_OFF, true},
204 {"yes", ARCHIVE_MODE_ON, true},
205 {"no", ARCHIVE_MODE_OFF, true},
206 {"1", ARCHIVE_MODE_ON, true},
207 {"0", ARCHIVE_MODE_OFF, true},
208 {NULL, 0, false}
209};
@ ARCHIVE_MODE_ALWAYS
Definition xlog.h:69
@ ARCHIVE_MODE_OFF
Definition xlog.h:67
@ ARCHIVE_MODE_ON
Definition xlog.h:68

◆ backtrace_functions

PGDLLIMPORT char* backtrace_functions
extern

Definition at line 576 of file guc_tables.c.

Referenced by errfinish().

◆ check_function_bodies

◆ client_min_messages

PGDLLIMPORT int client_min_messages
extern

Definition at line 568 of file guc_tables.c.

Referenced by execute_extension_script(), and should_output_to_client().

◆ cluster_name

◆ ConfigFileName

PGDLLIMPORT char* ConfigFileName
extern

Definition at line 583 of file guc_tables.c.

Referenced by ProcessConfigFileInternal(), and SelectConfigFiles().

◆ current_role_is_superuser

PGDLLIMPORT bool current_role_is_superuser
extern

Definition at line 565 of file guc_tables.c.

Referenced by check_role(), and InitializeParallelDSM().

◆ Debug_pretty_print

PGDLLIMPORT bool Debug_pretty_print
extern

Definition at line 540 of file guc_tables.c.

Referenced by pg_parse_query(), pg_plan_query(), and pg_rewrite_query().

◆ Debug_print_parse

PGDLLIMPORT bool Debug_print_parse
extern

Definition at line 537 of file guc_tables.c.

Referenced by pg_rewrite_query().

◆ Debug_print_plan

PGDLLIMPORT bool Debug_print_plan
extern

Definition at line 536 of file guc_tables.c.

Referenced by pg_plan_query().

◆ Debug_print_raw_parse

PGDLLIMPORT bool Debug_print_raw_parse
extern

Definition at line 538 of file guc_tables.c.

Referenced by pg_parse_query().

◆ Debug_print_rewritten

PGDLLIMPORT bool Debug_print_rewritten
extern

Definition at line 539 of file guc_tables.c.

Referenced by pg_rewrite_query().

◆ dynamic_shared_memory_options

PGDLLIMPORT const struct config_enum_entry dynamic_shared_memory_options[]
extern

Definition at line 96 of file dsm_impl.c.

96 {
97#ifdef USE_DSM_POSIX
98 {"posix", DSM_IMPL_POSIX, false},
99#endif
100#ifdef USE_DSM_SYSV
101 {"sysv", DSM_IMPL_SYSV, false},
102#endif
103#ifdef USE_DSM_WINDOWS
104 {"windows", DSM_IMPL_WINDOWS, false},
105#endif
106#ifdef USE_DSM_MMAP
107 {"mmap", DSM_IMPL_MMAP, false},
108#endif
109 {NULL, 0, false}
110};
#define DSM_IMPL_WINDOWS
Definition dsm_impl.h:19
#define DSM_IMPL_POSIX
Definition dsm_impl.h:17
#define DSM_IMPL_SYSV
Definition dsm_impl.h:18
#define DSM_IMPL_MMAP
Definition dsm_impl.h:20

◆ event_source

PGDLLIMPORT char* event_source
extern

Definition at line 554 of file guc_tables.c.

◆ external_pid_file

PGDLLIMPORT char* external_pid_file
extern

Definition at line 587 of file guc_tables.c.

Referenced by PostmasterMain(), and unlink_external_pid_file().

◆ GUC_check_errdetail_string

PGDLLIMPORT char* GUC_check_errdetail_string
extern

◆ GUC_check_errhint_string

PGDLLIMPORT char* GUC_check_errhint_string
extern

◆ GUC_check_errmsg_string

PGDLLIMPORT char* GUC_check_errmsg_string
extern

◆ HbaFileName

◆ HostsFileName

PGDLLIMPORT char* HostsFileName
extern

Definition at line 586 of file guc_tables.c.

Referenced by load_hosts(), and SelectConfigFiles().

◆ IdentFileName

PGDLLIMPORT char* IdentFileName
extern

◆ in_hot_standby_guc

PGDLLIMPORT bool in_hot_standby_guc
extern

Definition at line 676 of file guc_tables.c.

Referenced by ReportChangedGUCOptions().

◆ io_method_options

PGDLLIMPORT const struct config_enum_entry io_method_options[]
extern

Definition at line 64 of file aio.c.

64 {
65 {"sync", IOMETHOD_SYNC, false},
66 {"worker", IOMETHOD_WORKER, false},
67#ifdef IOMETHOD_IO_URING_ENABLED
68 {"io_uring", IOMETHOD_IO_URING, false},
69#endif
70 {NULL, 0, false}
71};
@ IOMETHOD_WORKER
Definition aio.h:35
@ IOMETHOD_SYNC
Definition aio.h:34

◆ log_btree_build_stats

PGDLLIMPORT bool log_btree_build_stats
extern

◆ log_duration

PGDLLIMPORT bool log_duration
extern

Definition at line 535 of file guc_tables.c.

Referenced by check_log_duration().

◆ log_executor_stats

PGDLLIMPORT bool log_executor_stats
extern

Definition at line 550 of file guc_tables.c.

Referenced by check_log_stats(), PortalRun(), and PortalRunMulti().

◆ log_min_duration_sample

PGDLLIMPORT int log_min_duration_sample
extern

Definition at line 569 of file guc_tables.c.

Referenced by check_log_duration().

◆ log_min_duration_statement

PGDLLIMPORT int log_min_duration_statement
extern

Definition at line 570 of file guc_tables.c.

Referenced by check_log_duration().

◆ log_min_error_statement

PGDLLIMPORT int log_min_error_statement
extern

Definition at line 567 of file guc_tables.c.

Referenced by check_log_of_query().

◆ log_min_messages

PGDLLIMPORT int log_min_messages[]
extern

Definition at line 681 of file guc_tables.c.

681 {
682#define PG_PROCTYPE(bktype, bkcategory, description, main_func, shmem_attach) \
683 [bktype] = WARNING,
685#undef PG_PROCTYPE
686};

Referenced by assign_log_min_messages(), execute_extension_script(), and should_output_to_server().

◆ log_parameter_max_length

PGDLLIMPORT int log_parameter_max_length
extern

Definition at line 571 of file guc_tables.c.

Referenced by errdetail_params().

◆ log_parameter_max_length_on_error

PGDLLIMPORT int log_parameter_max_length_on_error
extern

Definition at line 572 of file guc_tables.c.

Referenced by bind_param_error_callback(), and exec_bind_message().

◆ log_parser_stats

◆ log_planner_stats

PGDLLIMPORT bool log_planner_stats
extern

Definition at line 549 of file guc_tables.c.

Referenced by check_log_stats(), and pg_plan_query().

◆ log_statement_sample_rate

PGDLLIMPORT double log_statement_sample_rate
extern

Definition at line 574 of file guc_tables.c.

Referenced by check_log_duration().

◆ log_statement_stats

PGDLLIMPORT bool log_statement_stats
extern

◆ log_temp_files

PGDLLIMPORT int log_temp_files
extern

Definition at line 573 of file guc_tables.c.

Referenced by ReportTemporaryFileUsage().

◆ log_xact_sample_rate

PGDLLIMPORT double log_xact_sample_rate
extern

Definition at line 575 of file guc_tables.c.

Referenced by StartTransaction().

◆ num_temp_buffers

PGDLLIMPORT int num_temp_buffers
extern

◆ recovery_target_action_options

PGDLLIMPORT const struct config_enum_entry recovery_target_action_options[]
extern

Definition at line 78 of file xlogrecovery.c.

78 {
79 {"pause", RECOVERY_TARGET_ACTION_PAUSE, false},
80 {"promote", RECOVERY_TARGET_ACTION_PROMOTE, false},
81 {"shutdown", RECOVERY_TARGET_ACTION_SHUTDOWN, false},
82 {NULL, 0, false}
83};
@ RECOVERY_TARGET_ACTION_PAUSE
@ RECOVERY_TARGET_ACTION_PROMOTE
@ RECOVERY_TARGET_ACTION_SHUTDOWN

◆ role_string

PGDLLIMPORT char* role_string
extern

Definition at line 673 of file guc_tables.c.

Referenced by show_role().

◆ server_message_level_options

PGDLLIMPORT const struct config_enum_entry server_message_level_options[]
extern

Definition at line 152 of file guc_tables.c.

152 {
153 {"debug5", DEBUG5, false},
154 {"debug4", DEBUG4, false},
155 {"debug3", DEBUG3, false},
156 {"debug2", DEBUG2, false},
157 {"debug1", DEBUG1, false},
158 {"debug", DEBUG2, true},
159 {"info", INFO, false},
160 {"notice", NOTICE, false},
161 {"warning", WARNING, false},
162 {"error", ERROR, false},
163 {"log", LOG, false},
164 {"fatal", FATAL, false},
165 {"panic", PANIC, false},
166 {NULL, 0, false}
167};
#define NOTICE
Definition elog.h:36
#define INFO
Definition elog.h:35
#define DEBUG4
Definition elog.h:28

Referenced by check_log_min_messages().

◆ tcp_keepalives_count

PGDLLIMPORT int tcp_keepalives_count
extern

Definition at line 593 of file guc_tables.c.

Referenced by pq_init().

◆ tcp_keepalives_idle

PGDLLIMPORT int tcp_keepalives_idle
extern

Definition at line 591 of file guc_tables.c.

Referenced by pq_init().

◆ tcp_keepalives_interval

PGDLLIMPORT int tcp_keepalives_interval
extern

Definition at line 592 of file guc_tables.c.

Referenced by pq_init().

◆ tcp_user_timeout

PGDLLIMPORT int tcp_user_timeout
extern

Definition at line 594 of file guc_tables.c.

Referenced by pq_init().

◆ temp_file_limit

PGDLLIMPORT int temp_file_limit
extern

Definition at line 578 of file guc_tables.c.

Referenced by FileWriteV().

◆ trace_sort

◆ wal_level_options

PGDLLIMPORT const struct config_enum_entry wal_level_options[]
extern

Definition at line 28 of file xlogdesc.c.

28 {
29 {"minimal", WAL_LEVEL_MINIMAL, false},
30 {"replica", WAL_LEVEL_REPLICA, false},
31 {"archive", WAL_LEVEL_REPLICA, true}, /* deprecated */
32 {"hot_standby", WAL_LEVEL_REPLICA, true}, /* deprecated */
33 {"logical", WAL_LEVEL_LOGICAL, false},
34 {NULL, 0, false}
35};
@ WAL_LEVEL_REPLICA
Definition xlog.h:77
@ WAL_LEVEL_LOGICAL
Definition xlog.h:78
@ WAL_LEVEL_MINIMAL
Definition xlog.h:76

Referenced by get_wal_level_string().

◆ wal_sync_method_options

PGDLLIMPORT const struct config_enum_entry wal_sync_method_options[]
extern

Definition at line 178 of file xlog.c.

178 {
179 {"fsync", WAL_SYNC_METHOD_FSYNC, false},
180#ifdef HAVE_FSYNC_WRITETHROUGH
181 {"fsync_writethrough", WAL_SYNC_METHOD_FSYNC_WRITETHROUGH, false},
182#endif
183 {"fdatasync", WAL_SYNC_METHOD_FDATASYNC, false},
184#ifdef O_SYNC
185 {"open_sync", WAL_SYNC_METHOD_OPEN, false},
186#endif
187#ifdef O_DSYNC
188 {"open_datasync", WAL_SYNC_METHOD_OPEN_DSYNC, false},
189#endif
190 {NULL, 0, false}
191};
@ WAL_SYNC_METHOD_OPEN
Definition xlog.h:27
@ WAL_SYNC_METHOD_FDATASYNC
Definition xlog.h:26
@ WAL_SYNC_METHOD_FSYNC_WRITETHROUGH
Definition xlog.h:28
@ WAL_SYNC_METHOD_OPEN_DSYNC
Definition xlog.h:29
@ WAL_SYNC_METHOD_FSYNC
Definition xlog.h:25