guc.c 188.6 KB
Newer Older
1 2 3 4 5
/*--------------------------------------------------------------------
 * guc.c
 *
 * Support for grand unified configuration scheme, including SET
 * command, configuration file, and command line options.
6
 * See src/backend/utils/misc/README for more information.
7 8
 *
 *
B
Bruce Momjian 已提交
9
 * Copyright (c) 2000-2009, PostgreSQL Global Development Group
10
 * Written by Peter Eisentraut <peter_e@gmx.net>.
11 12
 *
 * IDENTIFICATION
B
Bruce Momjian 已提交
13
 *	  $PostgreSQL: pgsql/src/backend/utils/misc/guc.c,v 1.501 2009/04/07 22:22:19 momjian Exp $
14
 *
15 16 17 18
 *--------------------------------------------------------------------
 */
#include "postgres.h"

19
#include <ctype.h>
20
#include <float.h>
21
#include <math.h>
22 23
#include <limits.h>
#include <unistd.h>
24
#include <sys/stat.h>
25 26 27
#ifdef HAVE_SYSLOG
#include <syslog.h>
#endif
28

29
#include "access/gin.h"
30
#include "access/transam.h"
31
#include "access/twophase.h"
32
#include "access/xact.h"
33
#include "catalog/namespace.h"
34
#include "commands/async.h"
35
#include "commands/prepare.h"
36
#include "commands/vacuum.h"
37
#include "commands/variable.h"
38
#include "commands/trigger.h"
39
#include "funcapi.h"
40
#include "libpq/auth.h"
41
#include "libpq/pqformat.h"
42 43 44 45
#include "miscadmin.h"
#include "optimizer/cost.h"
#include "optimizer/geqo.h"
#include "optimizer/paths.h"
46
#include "optimizer/planmain.h"
47
#include "parser/gramparse.h"
48
#include "parser/parse_expr.h"
49
#include "parser/parse_relation.h"
50
#include "parser/parse_type.h"
51
#include "parser/scansup.h"
52
#include "pgstat.h"
53
#include "postmaster/autovacuum.h"
54 55
#include "postmaster/bgwriter.h"
#include "postmaster/postmaster.h"
56
#include "postmaster/syslogger.h"
57
#include "postmaster/walwriter.h"
58
#include "regex/regex.h"
59
#include "storage/bufmgr.h"
60
#include "storage/fd.h"
61
#include "tcop/tcopprot.h"
62
#include "tsearch/ts_cache.h"
63
#include "utils/builtins.h"
64
#include "utils/guc_tables.h"
65
#include "utils/memutils.h"
66
#include "utils/pg_locale.h"
67
#include "utils/plancache.h"
68
#include "utils/portal.h"
69
#include "utils/ps_status.h"
70
#include "utils/tzparser.h"
71
#include "utils/xml.h"
72

73 74 75
#ifndef PG_KRB_SRVTAB
#define PG_KRB_SRVTAB ""
#endif
B
 
Bruce Momjian 已提交
76 77 78
#ifndef PG_KRB_SRVNAM
#define PG_KRB_SRVNAM ""
#endif
79

B
Bruce Momjian 已提交
80
#define CONFIG_FILENAME "postgresql.conf"
81 82
#define HBA_FILENAME	"pg_hba.conf"
#define IDENT_FILENAME	"pg_ident.conf"
83

B
Bruce Momjian 已提交
84 85
#ifdef EXEC_BACKEND
#define CONFIG_EXEC_PARAMS "global/config_exec_params"
86
#define CONFIG_EXEC_PARAMS_NEW "global/config_exec_params.new"
B
Bruce Momjian 已提交
87
#endif
88

89 90 91 92 93 94 95
/* upper limit for GUC variables measured in kilobytes of memory */
#if SIZEOF_SIZE_T > 4
#define MAX_KILOBYTES	INT_MAX
#else
#define MAX_KILOBYTES	(INT_MAX / 1024)
#endif

96 97 98 99
#define KB_PER_MB (1024)
#define KB_PER_GB (1024*1024)

#define MS_PER_S 1000
100
#define S_PER_MIN 60
101
#define MS_PER_MIN (1000 * 60)
102 103
#define MIN_PER_H 60
#define S_PER_H (60 * 60)
104
#define MS_PER_H (1000 * 60 * 60)
105 106
#define MIN_PER_D (60 * 24)
#define S_PER_D (60 * 60 * 24)
107 108
#define MS_PER_D (1000 * 60 * 60 * 24)

109
/* XXX these should appear in other modules' header files */
110
extern bool Log_disconnections;
B
Bruce Momjian 已提交
111 112
extern int	CommitDelay;
extern int	CommitSiblings;
113
extern char *default_tablespace;
114
extern char *temp_tablespaces;
115
extern bool synchronize_seqscans;
B
Bruce Momjian 已提交
116 117
extern bool fullPageWrites;

118
#ifdef TRACE_SORT
B
Bruce Momjian 已提交
119
extern bool trace_sort;
120
#endif
121 122 123
#ifdef TRACE_SYNCSCAN
extern bool trace_syncscan;
#endif
124 125 126
#ifdef DEBUG_BOUNDED_SORT
extern bool optimize_bounded_sort;
#endif
127

T
Tom Lane 已提交
128 129 130 131
#ifdef USE_SSL
extern char *SSLCipherSuites;
#endif

132 133
static void set_config_sourcefile(const char *name, char *sourcefile,
					  int sourceline);
T
Tom Lane 已提交
134

135
static const char *assign_log_destination(const char *value,
B
Bruce Momjian 已提交
136
					   bool doit, GucSource source);
137

T
Tatsuo Ishii 已提交
138
#ifdef HAVE_SYSLOG
139
static int	syslog_facility = LOG_LOCAL0;
140

141 142
static bool assign_syslog_facility(int newval,
				    bool doit, GucSource source);
143
static const char *assign_syslog_ident(const char *ident,
B
Bruce Momjian 已提交
144
					bool doit, GucSource source);
145
#endif
146

147
static bool assign_session_replication_role(int newval, bool doit,
B
Bruce Momjian 已提交
148
								GucSource source);
149
static const char *show_num_temp_buffers(void);
150
static bool assign_phony_autocommit(bool newval, bool doit, GucSource source);
151
static const char *assign_custom_variable_classes(const char *newval, bool doit,
B
Bruce Momjian 已提交
152
							   GucSource source);
153
static bool assign_debug_assertions(bool newval, bool doit, GucSource source);
154
static bool assign_ssl(bool newval, bool doit, GucSource source);
155 156
static bool assign_stage_log_stats(bool newval, bool doit, GucSource source);
static bool assign_log_stats(bool newval, bool doit, GucSource source);
157
static bool assign_transaction_read_only(bool newval, bool doit, GucSource source);
158
static const char *assign_canonical_path(const char *newval, bool doit, GucSource source);
159
static const char *assign_timezone_abbreviations(const char *newval, bool doit, GucSource source);
160
static const char *show_archive_command(void);
161 162 163 164 165 166
static bool assign_tcp_keepalives_idle(int newval, bool doit, GucSource source);
static bool assign_tcp_keepalives_interval(int newval, bool doit, GucSource source);
static bool assign_tcp_keepalives_count(int newval, bool doit, GucSource source);
static const char *show_tcp_keepalives_idle(void);
static const char *show_tcp_keepalives_interval(void);
static const char *show_tcp_keepalives_count(void);
167
static bool assign_maxconnections(int newval, bool doit, GucSource source);
168 169
static bool assign_autovacuum_max_workers(int newval, bool doit, GucSource source);
static bool assign_effective_io_concurrency(int newval, bool doit, GucSource source);
170
static const char *assign_pgstat_temp_directory(const char *newval, bool doit, GucSource source);
171

172
static char *config_enum_get_options(struct config_enum *record, 
173 174
									 const char *prefix, const char *suffix,
									 const char *separator);
175 176


177 178
/*
 * Options for enum values defined in this module.
179 180
 *
 * NOTE! Option values may not contain double quotes!
181
 */
182 183 184 185 186 187

/*
 * We have different sets for client and server message level options because
 * they sort slightly different (see "log" level)
 */
static const struct config_enum_entry client_message_level_options[] = {
188
	{"debug", DEBUG2, true},
189 190 191 192 193 194
	{"debug5", DEBUG5, false},
	{"debug4", DEBUG4, false},
	{"debug3", DEBUG3, false},
	{"debug2", DEBUG2, false},
	{"debug1", DEBUG1, false},
	{"log", LOG, false},
195 196 197 198 199 200 201 202 203 204
	{"info", INFO, true},
	{"notice", NOTICE, false},
	{"warning", WARNING, false},
	{"error", ERROR, false},
	{"fatal", FATAL, true},
	{"panic", PANIC, true},
	{NULL, 0, false}
};

static const struct config_enum_entry server_message_level_options[] = {
205
	{"debug", DEBUG2, true},
206 207 208 209 210
	{"debug5", DEBUG5, false},
	{"debug4", DEBUG4, false},
	{"debug3", DEBUG3, false},
	{"debug2", DEBUG2, false},
	{"debug1", DEBUG1, false},
211 212 213 214
	{"info", INFO, false},
	{"notice", NOTICE, false},
	{"warning", WARNING, false},
	{"error", ERROR, false},
215
	{"log", LOG, false},
216 217 218
	{"fatal", FATAL, false},
	{"panic", PANIC, false},
	{NULL, 0, false}
219 220
};

221 222 223 224
static const struct config_enum_entry intervalstyle_options[] = {
	{"postgres", INTSTYLE_POSTGRES, false},
	{"postgres_verbose", INTSTYLE_POSTGRES_VERBOSE, false},
	{"sql_standard", INTSTYLE_SQL_STANDARD, false},
225
	{"iso_8601", INTSTYLE_ISO_8601, false},
226 227 228
	{NULL, 0, false}
};

229
static const struct config_enum_entry log_error_verbosity_options[] = {
230
	{"terse", PGERROR_TERSE, false},
231
	{"default", PGERROR_DEFAULT, false},
232 233
	{"verbose", PGERROR_VERBOSE, false},
	{NULL, 0, false}
234 235 236
};

static const struct config_enum_entry log_statement_options[] = {
237 238 239 240 241
	{"none", LOGSTMT_NONE, false},
	{"ddl", LOGSTMT_DDL, false},
	{"mod", LOGSTMT_MOD, false},
	{"all", LOGSTMT_ALL, false},
	{NULL, 0, false}
242 243
};

244
static const struct config_enum_entry regex_flavor_options[] = {
245 246 247 248
    {"advanced", REG_ADVANCED, false},
    {"extended", REG_EXTENDED, false},
    {"basic", REG_BASIC, false},
    {NULL, 0, false}
249 250 251
};

static const struct config_enum_entry isolation_level_options[] = {
252 253 254 255
	{"serializable", XACT_SERIALIZABLE, false},
	{"repeatable read", XACT_REPEATABLE_READ, false},
	{"read committed", XACT_READ_COMMITTED, false},
	{"read uncommitted", XACT_READ_UNCOMMITTED, false},
256 257 258 259
	{NULL, 0}
};

static const struct config_enum_entry session_replication_role_options[] = {
260 261 262 263
	{"origin", SESSION_REPLICATION_ROLE_ORIGIN, false},
	{"replica", SESSION_REPLICATION_ROLE_REPLICA, false},
	{"local", SESSION_REPLICATION_ROLE_LOCAL, false},
	{NULL, 0, false}
264 265
};

266
#ifdef HAVE_SYSLOG
267
static const struct config_enum_entry syslog_facility_options[] = {
268 269 270 271 272 273 274 275
	{"local0", LOG_LOCAL0, false},
	{"local1", LOG_LOCAL1, false},
	{"local2", LOG_LOCAL2, false},
	{"local3", LOG_LOCAL3, false},
	{"local4", LOG_LOCAL4, false},
	{"local5", LOG_LOCAL5, false},
	{"local6", LOG_LOCAL6, false},
	{"local7", LOG_LOCAL7, false},
276 277
	{NULL, 0}
};
278
#endif
279

280
static const struct config_enum_entry track_function_options[] = {
281 282 283 284
	{"none", TRACK_FUNC_OFF, false},
	{"pl", TRACK_FUNC_PL, false},
	{"all", TRACK_FUNC_ALL, false},
	{NULL, 0, false}
285 286
};

287
static const struct config_enum_entry xmlbinary_options[] = {
288 289 290
	{"base64", XMLBINARY_BASE64, false},
	{"hex", XMLBINARY_HEX, false},
	{NULL, 0, false}
291 292 293
};

static const struct config_enum_entry xmloption_options[] = {
294 295 296
	{"content", XMLOPTION_CONTENT, false},
	{"document", XMLOPTION_DOCUMENT, false},
	{NULL, 0, false}
297
};
298

299 300 301 302 303
/*
 * Although only "on", "off", and "safe_encoding" are documented, we
 * accept all the likely variants of "on" and "off".
 */
static const struct config_enum_entry backslash_quote_options[] = {
304 305 306 307 308 309 310 311 312 313
	{"safe_encoding", BACKSLASH_QUOTE_SAFE_ENCODING, false},
	{"on", BACKSLASH_QUOTE_ON, false},
	{"off", BACKSLASH_QUOTE_OFF, false},
	{"true", BACKSLASH_QUOTE_ON, true},
	{"false", BACKSLASH_QUOTE_OFF, true},
	{"yes", BACKSLASH_QUOTE_ON, true},
	{"no", BACKSLASH_QUOTE_OFF, true},
	{"1", BACKSLASH_QUOTE_ON, true},
	{"0", BACKSLASH_QUOTE_OFF, true},
	{NULL, 0, false}
314 315
};

316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332
/*
 * Although only "on", "off", and "partition" are documented, we
 * accept all the likely variants of "on" and "off".
 */
static const struct config_enum_entry constraint_exclusion_options[] = {
	{"partition", CONSTRAINT_EXCLUSION_PARTITION, false},
	{"on", CONSTRAINT_EXCLUSION_ON, false},
	{"off", CONSTRAINT_EXCLUSION_OFF, false},
	{"true", CONSTRAINT_EXCLUSION_ON, true},
	{"false", CONSTRAINT_EXCLUSION_OFF, true},
	{"yes", CONSTRAINT_EXCLUSION_ON, true},
	{"no", CONSTRAINT_EXCLUSION_OFF, true},
	{"1", CONSTRAINT_EXCLUSION_ON, true},
	{"0", CONSTRAINT_EXCLUSION_OFF, true},
	{NULL, 0, false}
};

333 334 335 336 337
/*
 * Options for enum values stored in other modules
 */
extern const struct config_enum_entry sync_method_options[];

338 339
/*
 * GUC option variables that are exported from this module
340
 */
341
#ifdef USE_ASSERT_CHECKING
B
Bruce Momjian 已提交
342
bool		assert_enabled = true;
343 344 345
#else
bool		assert_enabled = false;
#endif
B
Rename:  
Bruce Momjian 已提交
346
bool		log_duration = false;
B
Bruce Momjian 已提交
347 348 349
bool		Debug_print_plan = false;
bool		Debug_print_parse = false;
bool		Debug_print_rewritten = false;
350
bool		Debug_pretty_print = true;
351

B
Rename:  
Bruce Momjian 已提交
352 353 354
bool		log_parser_stats = false;
bool		log_planner_stats = false;
bool		log_executor_stats = false;
B
Bruce Momjian 已提交
355 356
bool		log_statement_stats = false;		/* this is sort of all three
												 * above together */
357
bool		log_btree_build_stats = false;
358

359 360
bool		check_function_bodies = true;
bool		default_with_oids = false;
B
Bruce Momjian 已提交
361
bool		SQL_inheritance = true;
362

363
bool		Password_encryption = true;
364

365
int			log_min_error_statement = ERROR;
366
int			log_min_messages = WARNING;
367
int			client_min_messages = NOTICE;
368
int			log_min_duration_statement = -1;
369
int			log_temp_files = -1;
370

371 372
int			num_temp_buffers = 1000;

373 374 375 376
char	   *ConfigFileName;
char	   *HbaFileName;
char	   *IdentFileName;
char	   *external_pid_file;
377

378 379
char	   *pgstat_temp_directory;

B
Bruce Momjian 已提交
380 381 382
int			tcp_keepalives_idle;
int			tcp_keepalives_interval;
int			tcp_keepalives_count;
383

384 385 386 387 388
/*
 * These variables are all dummies that don't do anything, except in some
 * cases provide the value for SHOW to display.  The real state is elsewhere
 * and is kept in sync by assign_hooks.
 */
389
static char *log_destination_string;
B
Bruce Momjian 已提交
390

391
#ifdef HAVE_SYSLOG
392
static char *syslog_ident_str;
393
#endif
394
static bool phony_autocommit;
395
static bool session_auth_is_superuser;
396 397 398
static double phony_random_seed;
static char *client_encoding_string;
static char *datestyle_string;
399 400
static char *locale_collate;
static char *locale_ctype;
401
static char *server_encoding_string;
402
static char *server_version_string;
B
Bruce Momjian 已提交
403
static int	server_version_num;
404
static char *timezone_string;
405
static char *log_timezone_string;
406
static char *timezone_abbreviations_string;
407
static char *XactIsoLevel_string;
408
static char *data_directory;
409
static char *custom_variable_classes;
410 411 412 413
static int	max_function_args;
static int	max_index_keys;
static int	max_identifier_length;
static int	block_size;
414 415 416
static int	segment_size;
static int	wal_block_size;
static int	wal_segment_size;
B
Bruce Momjian 已提交
417
static bool integer_datetimes;
418
static int	effective_io_concurrency;
B
Bruce Momjian 已提交
419

420 421
/* should be static, but commands/variable.c needs to get at these */
char	   *role_string;
B
Bruce Momjian 已提交
422
char	   *session_authorization_string;
423

424

425
/*
426 427 428
 * Displayable names for context types (enum GucContext)
 *
 * Note: these strings are deliberately not localized.
429
 */
B
Bruce Momjian 已提交
430
const char *const GucContext_Names[] =
431
{
B
Bruce Momjian 已提交
432 433 434 435 436 437
	 /* PGC_INTERNAL */ "internal",
	 /* PGC_POSTMASTER */ "postmaster",
	 /* PGC_SIGHUP */ "sighup",
	 /* PGC_BACKEND */ "backend",
	 /* PGC_SUSET */ "superuser",
	 /* PGC_USERSET */ "user"
438 439 440 441 442 443
};

/*
 * Displayable names for source types (enum GucSource)
 *
 * Note: these strings are deliberately not localized.
B
Bruce Momjian 已提交
444 445
 */
const char *const GucSource_Names[] =
446
{
B
Bruce Momjian 已提交
447 448 449 450 451 452 453 454 455 456 457
	 /* PGC_S_DEFAULT */ "default",
	 /* PGC_S_ENV_VAR */ "environment variable",
	 /* PGC_S_FILE */ "configuration file",
	 /* PGC_S_ARGV */ "command line",
	 /* PGC_S_DATABASE */ "database",
	 /* PGC_S_USER */ "user",
	 /* PGC_S_CLIENT */ "client",
	 /* PGC_S_OVERRIDE */ "override",
	 /* PGC_S_INTERACTIVE */ "interactive",
	 /* PGC_S_TEST */ "test",
	 /* PGC_S_SESSION */ "session"
458 459 460 461 462 463 464 465
};

/*
 * Displayable names for the groupings defined in enum config_group
 */
const char *const config_group_names[] =
{
	/* UNGROUPED */
466
	gettext_noop("Ungrouped"),
467 468
	/* FILE_LOCATIONS */
	gettext_noop("File Locations"),
469
	/* CONN_AUTH */
470
	gettext_noop("Connections and Authentication"),
471
	/* CONN_AUTH_SETTINGS */
472
	gettext_noop("Connections and Authentication / Connection Settings"),
473
	/* CONN_AUTH_SECURITY */
474
	gettext_noop("Connections and Authentication / Security and Authentication"),
475
	/* RESOURCES */
476
	gettext_noop("Resource Usage"),
477
	/* RESOURCES_MEM */
478
	gettext_noop("Resource Usage / Memory"),
479
	/* RESOURCES_KERNEL */
480
	gettext_noop("Resource Usage / Kernel Resources"),
481
	/* WAL */
482
	gettext_noop("Write-Ahead Log"),
483
	/* WAL_SETTINGS */
484
	gettext_noop("Write-Ahead Log / Settings"),
485
	/* WAL_CHECKPOINTS */
486
	gettext_noop("Write-Ahead Log / Checkpoints"),
487
	/* QUERY_TUNING */
488
	gettext_noop("Query Tuning"),
489
	/* QUERY_TUNING_METHOD */
490
	gettext_noop("Query Tuning / Planner Method Configuration"),
491
	/* QUERY_TUNING_COST */
492
	gettext_noop("Query Tuning / Planner Cost Constants"),
493
	/* QUERY_TUNING_GEQO */
494
	gettext_noop("Query Tuning / Genetic Query Optimizer"),
495
	/* QUERY_TUNING_OTHER */
496
	gettext_noop("Query Tuning / Other Planner Options"),
497
	/* LOGGING */
498
	gettext_noop("Reporting and Logging"),
499 500
	/* LOGGING_WHERE */
	gettext_noop("Reporting and Logging / Where to Log"),
501
	/* LOGGING_WHEN */
502
	gettext_noop("Reporting and Logging / When to Log"),
503
	/* LOGGING_WHAT */
504
	gettext_noop("Reporting and Logging / What to Log"),
505
	/* STATS */
506
	gettext_noop("Statistics"),
507
	/* STATS_MONITORING */
508
	gettext_noop("Statistics / Monitoring"),
509
	/* STATS_COLLECTOR */
510
	gettext_noop("Statistics / Query and Index Statistics Collector"),
511
	/* AUTOVACUUM */
512
	gettext_noop("Autovacuum"),
513
	/* CLIENT_CONN */
514
	gettext_noop("Client Connection Defaults"),
515
	/* CLIENT_CONN_STATEMENT */
516
	gettext_noop("Client Connection Defaults / Statement Behavior"),
517
	/* CLIENT_CONN_LOCALE */
518
	gettext_noop("Client Connection Defaults / Locale and Formatting"),
519
	/* CLIENT_CONN_OTHER */
520
	gettext_noop("Client Connection Defaults / Other Defaults"),
521
	/* LOCK_MANAGEMENT */
522
	gettext_noop("Lock Management"),
523
	/* COMPAT_OPTIONS */
524
	gettext_noop("Version and Platform Compatibility"),
525
	/* COMPAT_OPTIONS_PREVIOUS */
526
	gettext_noop("Version and Platform Compatibility / Previous PostgreSQL Versions"),
527
	/* COMPAT_OPTIONS_CLIENT */
528
	gettext_noop("Version and Platform Compatibility / Other Platforms and Clients"),
529 530 531 532
	/* PRESET_OPTIONS */
	gettext_noop("Preset Options"),
	/* CUSTOM_OPTIONS */
	gettext_noop("Customized Options"),
533
	/* DEVELOPER_OPTIONS */
534
	gettext_noop("Developer Options"),
535
	/* help_config wants this array to be null-terminated */
536 537 538
	NULL
};

539 540 541 542 543
/*
 * Displayable names for GUC variable types (enum config_type)
 *
 * Note: these strings are deliberately not localized.
 */
B
Bruce Momjian 已提交
544
const char *const config_type_names[] =
545
{
B
Bruce Momjian 已提交
546 547 548
	 /* PGC_BOOL */ "bool",
	 /* PGC_INT */ "integer",
	 /* PGC_REAL */ "real",
549 550
	 /* PGC_STRING */ "string",
	 /* PGC_ENUM */ "enum"
551 552
};

553

554
/*
555 556 557 558
 * Contents of GUC tables
 *
 * See src/backend/utils/misc/README for design notes.
 *
559 560 561
 * TO ADD AN OPTION:
 *
 * 1. Declare a global variable of type bool, int, double, or char*
B
Bruce Momjian 已提交
562
 *	  and make use of it.
563 564
 *
 * 2. Decide at what times it's safe to set the option. See guc.h for
B
Bruce Momjian 已提交
565
 *	  details.
566 567
 *
 * 3. Decide on a name, a default value, upper and lower bounds (if
B
Bruce Momjian 已提交
568
 *	  applicable), etc.
569 570 571
 *
 * 4. Add a record below.
 *
572
 * 5. Add it to src/backend/utils/misc/postgresql.conf.sample, if
573
 *	  appropriate.
574
 *
575
 * 6. Don't forget to document the option (at least in config.sgml).
576
 *
577
 * 7. If it's a new GUC_LIST option you must edit pg_dumpall.c to ensure
B
Bruce Momjian 已提交
578
 *	  it is not single quoted at dump time.
579 580
 */

581

582
/******** option records follow ********/
583

584
static struct config_bool ConfigureNamesBool[] =
585
{
586
	{
587
		{"enable_seqscan", PGC_USERSET, QUERY_TUNING_METHOD,
588
			gettext_noop("Enables the planner's use of sequential-scan plans."),
589 590 591
			NULL
		},
		&enable_seqscan,
592
		true, NULL, NULL
593
	},
594
	{
595
		{"enable_indexscan", PGC_USERSET, QUERY_TUNING_METHOD,
596
			gettext_noop("Enables the planner's use of index-scan plans."),
597 598 599
			NULL
		},
		&enable_indexscan,
600
		true, NULL, NULL
601
	},
602 603 604 605 606 607 608 609
	{
		{"enable_bitmapscan", PGC_USERSET, QUERY_TUNING_METHOD,
			gettext_noop("Enables the planner's use of bitmap-scan plans."),
			NULL
		},
		&enable_bitmapscan,
		true, NULL, NULL
	},
610
	{
611
		{"enable_tidscan", PGC_USERSET, QUERY_TUNING_METHOD,
612
			gettext_noop("Enables the planner's use of TID scan plans."),
613 614 615
			NULL
		},
		&enable_tidscan,
616
		true, NULL, NULL
617 618
	},
	{
619
		{"enable_sort", PGC_USERSET, QUERY_TUNING_METHOD,
620
			gettext_noop("Enables the planner's use of explicit sort steps."),
621 622 623
			NULL
		},
		&enable_sort,
624
		true, NULL, NULL
625
	},
626
	{
627
		{"enable_hashagg", PGC_USERSET, QUERY_TUNING_METHOD,
628
			gettext_noop("Enables the planner's use of hashed aggregation plans."),
629 630 631
			NULL
		},
		&enable_hashagg,
632 633
		true, NULL, NULL
	},
634
	{
635
		{"enable_nestloop", PGC_USERSET, QUERY_TUNING_METHOD,
636
			gettext_noop("Enables the planner's use of nested-loop join plans."),
637 638 639
			NULL
		},
		&enable_nestloop,
640
		true, NULL, NULL
641 642
	},
	{
643
		{"enable_mergejoin", PGC_USERSET, QUERY_TUNING_METHOD,
644
			gettext_noop("Enables the planner's use of merge join plans."),
645 646 647
			NULL
		},
		&enable_mergejoin,
648
		true, NULL, NULL
649 650
	},
	{
651
		{"enable_hashjoin", PGC_USERSET, QUERY_TUNING_METHOD,
652
			gettext_noop("Enables the planner's use of hash join plans."),
653 654 655
			NULL
		},
		&enable_hashjoin,
656
		true, NULL, NULL
657 658
	},
	{
659
		{"geqo", PGC_USERSET, QUERY_TUNING_GEQO,
660
			gettext_noop("Enables genetic query optimization."),
661
			gettext_noop("This algorithm attempts to do planning without "
662
						 "exhaustive searching.")
663 664
		},
		&enable_geqo,
665
		true, NULL, NULL
666
	},
667
	{
668 669
		/* Not for general use --- used by SET SESSION AUTHORIZATION */
		{"is_superuser", PGC_INTERNAL, UNGROUPED,
670
			gettext_noop("Shows whether the current user is a superuser."),
671 672 673
			NULL,
			GUC_REPORT | GUC_NO_SHOW_ALL | GUC_NO_RESET_ALL | GUC_NOT_IN_SAMPLE | GUC_DISALLOW_IN_FILE
		},
674 675 676
		&session_auth_is_superuser,
		false, NULL, NULL
	},
677
	{
678
		{"ssl", PGC_POSTMASTER, CONN_AUTH_SECURITY,
679
			gettext_noop("Enables SSL connections."),
680 681 682
			NULL
		},
		&EnableSSL,
683
		false, assign_ssl, NULL
684 685
	},
	{
686
		{"fsync", PGC_SIGHUP, WAL_SETTINGS,
687
			gettext_noop("Forces synchronization of updates to disk."),
688
			gettext_noop("The server will use the fsync() system call in several places to make "
689
			"sure that updates are physically written to disk. This insures "
690
						 "that a database cluster will recover to a consistent state after "
691
						 "an operating system or hardware crash.")
692 693
		},
		&enableFsync,
694
		true, NULL, NULL
695
	},
696 697 698 699 700 701
	{
		{"synchronous_commit", PGC_USERSET, WAL_SETTINGS,
			gettext_noop("Sets immediate fsync at commit."),
			NULL
		},
		&XactSyncCommit,
702
		true, NULL, NULL
703
	},
704
	{
705
		{"zero_damaged_pages", PGC_SUSET, DEVELOPER_OPTIONS,
706
			gettext_noop("Continues processing past damaged page headers."),
707
			gettext_noop("Detection of a damaged page header normally causes PostgreSQL to "
B
Bruce Momjian 已提交
708
				"report an error, aborting the current transaction. Setting "
709 710
						 "zero_damaged_pages to true causes the system to instead report a "
						 "warning, zero out the damaged page, and continue processing. This "
711
						 "behavior will destroy data, namely all the rows on the damaged page."),
712
			GUC_NOT_IN_SAMPLE
713 714
		},
		&zero_damaged_pages,
715 716
		false, NULL, NULL
	},
717 718 719 720
	{
		{"full_page_writes", PGC_SIGHUP, WAL_SETTINGS,
			gettext_noop("Writes full pages to WAL when first modified after a checkpoint."),
			gettext_noop("A page write in process during an operating system crash might be "
B
Bruce Momjian 已提交
721
						 "only partially written to disk.  During recovery, the row changes "
722
			  "stored in WAL are not enough to recover.  This option writes "
723 724 725 726 727 728
						 "pages when first modified after a checkpoint to WAL so full recovery "
						 "is possible.")
		},
		&fullPageWrites,
		true, NULL, NULL
	},
729
	{
730
		{"silent_mode", PGC_POSTMASTER, LOGGING_WHEN,
731
			gettext_noop("Runs the server silently."),
732
			gettext_noop("If this parameter is set, the server will automatically run in the "
B
Bruce Momjian 已提交
733
				 "background and any controlling terminals are dissociated.")
734 735
		},
		&SilentMode,
736
		false, NULL, NULL
737
	},
738 739 740 741 742 743 744 745
	{
		{"log_checkpoints", PGC_SIGHUP, LOGGING_WHAT,
			gettext_noop("Logs each checkpoint."),
			NULL
		},
		&log_checkpoints,
		false, NULL, NULL
	},
746
	{
747
		{"log_connections", PGC_BACKEND, LOGGING_WHAT,
748
			gettext_noop("Logs each successful connection."),
749 750 751
			NULL
		},
		&Log_connections,
752
		false, NULL, NULL
753
	},
754 755
	{
		{"log_disconnections", PGC_BACKEND, LOGGING_WHAT,
P
Peter Eisentraut 已提交
756
			gettext_noop("Logs end of a session, including duration."),
B
Bruce Momjian 已提交
757
			NULL
758 759 760 761
		},
		&Log_disconnections,
		false, NULL, NULL
	},
762
	{
763
		{"debug_assertions", PGC_USERSET, DEVELOPER_OPTIONS,
764
			gettext_noop("Turns on various assertion checks."),
765
			gettext_noop("This is a debugging aid."),
766 767 768
			GUC_NOT_IN_SAMPLE
		},
		&assert_enabled,
769 770 771 772
#ifdef USE_ASSERT_CHECKING
		true,
#else
		false,
773
#endif
774 775
		assign_debug_assertions, NULL
	},
776 777
	{
		/* currently undocumented, so don't show in SHOW ALL */
778
		{"exit_on_error", PGC_USERSET, UNGROUPED,
779
			gettext_noop("No description available."),
780 781 782 783
			NULL,
			GUC_NO_SHOW_ALL | GUC_NOT_IN_SAMPLE
		},
		&ExitOnAnyError,
784 785
		false, NULL, NULL
	},
786
	{
787 788
		{"log_duration", PGC_SUSET, LOGGING_WHAT,
			gettext_noop("Logs the duration of each completed SQL statement."),
789 790 791
			NULL
		},
		&log_duration,
792
		false, NULL, NULL
793 794
	},
	{
795
		{"debug_print_parse", PGC_USERSET, LOGGING_WHAT,
796
			gettext_noop("Logs each query's parse tree."),
797
			NULL
798 799
		},
		&Debug_print_parse,
800
		false, NULL, NULL
801 802
	},
	{
803
		{"debug_print_rewritten", PGC_USERSET, LOGGING_WHAT,
804
			gettext_noop("Logs each query's rewritten parse tree."),
805 806 807
			NULL
		},
		&Debug_print_rewritten,
808
		false, NULL, NULL
809 810
	},
	{
811
		{"debug_print_plan", PGC_USERSET, LOGGING_WHAT,
812
			gettext_noop("Logs each query's execution plan."),
813 814 815
			NULL
		},
		&Debug_print_plan,
816
		false, NULL, NULL
817 818
	},
	{
819
		{"debug_pretty_print", PGC_USERSET, LOGGING_WHAT,
820
			gettext_noop("Indents parse and plan tree displays."),
821 822 823
			NULL
		},
		&Debug_pretty_print,
824
		true, NULL, NULL
825 826
	},
	{
827
		{"log_parser_stats", PGC_SUSET, STATS_MONITORING,
828
			gettext_noop("Writes parser performance statistics to the server log."),
829 830 831
			NULL
		},
		&log_parser_stats,
832
		false, assign_stage_log_stats, NULL
833 834
	},
	{
835
		{"log_planner_stats", PGC_SUSET, STATS_MONITORING,
836
			gettext_noop("Writes planner performance statistics to the server log."),
837 838 839
			NULL
		},
		&log_planner_stats,
840
		false, assign_stage_log_stats, NULL
841 842
	},
	{
843
		{"log_executor_stats", PGC_SUSET, STATS_MONITORING,
844
			gettext_noop("Writes executor performance statistics to the server log."),
845 846 847
			NULL
		},
		&log_executor_stats,
848
		false, assign_stage_log_stats, NULL
849 850
	},
	{
851
		{"log_statement_stats", PGC_SUSET, STATS_MONITORING,
852
			gettext_noop("Writes cumulative performance statistics to the server log."),
853 854 855
			NULL
		},
		&log_statement_stats,
856
		false, assign_log_stats, NULL
857
	},
858
#ifdef BTREE_BUILD_STATS
859
	{
860
		{"log_btree_build_stats", PGC_SUSET, DEVELOPER_OPTIONS,
861
			gettext_noop("No description available."),
862 863 864 865
			NULL,
			GUC_NOT_IN_SAMPLE
		},
		&log_btree_build_stats,
866
		false, NULL, NULL
867
	},
868 869
#endif

870
	{
871 872 873 874 875
		{"track_activities", PGC_SUSET, STATS_COLLECTOR,
			gettext_noop("Collects information about executing commands."),
			gettext_noop("Enables the collection of information on the currently "
						 "executing command of each session, along with "
						 "the time at which that command began execution.")
876
		},
877
		&pgstat_track_activities,
878
		true, NULL, NULL
879 880
	},
	{
881 882
		{"track_counts", PGC_SUSET, STATS_COLLECTOR,
			gettext_noop("Collects statistics on database activity."),
883 884
			NULL
		},
885
		&pgstat_track_counts,
886
		true, NULL, NULL
887 888
	},

889 890 891
	{
		{"update_process_title", PGC_SUSET, STATS_COLLECTOR,
			gettext_noop("Updates the process title to show the active SQL command."),
892
			gettext_noop("Enables updating of the process title every time a new SQL command is received by the server.")
893 894 895 896 897
		},
		&update_process_title,
		true, NULL, NULL
	},

898 899
	{
		{"autovacuum", PGC_SIGHUP, AUTOVACUUM,
P
Peter Eisentraut 已提交
900
			gettext_noop("Starts the autovacuum subprocess."),
901 902 903
			NULL
		},
		&autovacuum_start_daemon,
904
		true, NULL, NULL
905 906
	},

907
	{
908
		{"trace_notify", PGC_USERSET, DEVELOPER_OPTIONS,
909
			gettext_noop("Generates debugging output for LISTEN and NOTIFY."),
910 911 912 913
			NULL,
			GUC_NOT_IN_SAMPLE
		},
		&Trace_notify,
914
		false, NULL, NULL
915
	},
916 917

#ifdef LOCK_DEBUG
918
	{
919
		{"trace_locks", PGC_SUSET, DEVELOPER_OPTIONS,
920
			gettext_noop("No description available."),
921 922 923 924
			NULL,
			GUC_NOT_IN_SAMPLE
		},
		&Trace_locks,
925
		false, NULL, NULL
926 927
	},
	{
928
		{"trace_userlocks", PGC_SUSET, DEVELOPER_OPTIONS,
929
			gettext_noop("No description available."),
930 931 932 933
			NULL,
			GUC_NOT_IN_SAMPLE
		},
		&Trace_userlocks,
934
		false, NULL, NULL
935 936
	},
	{
937
		{"trace_lwlocks", PGC_SUSET, DEVELOPER_OPTIONS,
938
			gettext_noop("No description available."),
939 940 941 942
			NULL,
			GUC_NOT_IN_SAMPLE
		},
		&Trace_lwlocks,
943
		false, NULL, NULL
944 945
	},
	{
946
		{"debug_deadlocks", PGC_SUSET, DEVELOPER_OPTIONS,
947
			gettext_noop("No description available."),
948 949 950 951
			NULL,
			GUC_NOT_IN_SAMPLE
		},
		&Debug_deadlocks,
952
		false, NULL, NULL
953
	},
954 955
#endif

956
	{
957 958
		{"log_lock_waits", PGC_SUSET, LOGGING_WHAT,
			gettext_noop("Logs long lock waits."),
959 960 961 962 963
			NULL
		},
		&log_lock_waits,
		false, NULL, NULL
	},
964

965
	{
966
		{"log_hostname", PGC_SIGHUP, LOGGING_WHAT,
967
			gettext_noop("Logs the host name in the connection logs."),
968 969
			gettext_noop("By default, connection logs only show the IP address "
						 "of the connecting host. If you want them to show the host name you "
B
Bruce Momjian 已提交
970 971
			  "can turn this on, but depending on your host name resolution "
			   "setup it might impose a non-negligible performance penalty.")
972 973
		},
		&log_hostname,
974
		false, NULL, NULL
975 976
	},
	{
977
		{"sql_inheritance", PGC_USERSET, COMPAT_OPTIONS_PREVIOUS,
978
			gettext_noop("Causes subtables to be included by default in various commands."),
979
			NULL
980 981
		},
		&SQL_inheritance,
982
		true, NULL, NULL
983 984
	},
	{
985
		{"password_encryption", PGC_USERSET, CONN_AUTH_SECURITY,
986
			gettext_noop("Encrypt passwords."),
987
			gettext_noop("When a password is specified in CREATE USER or "
B
Bruce Momjian 已提交
988
			   "ALTER USER without writing either ENCRYPTED or UNENCRYPTED, "
989
						 "this parameter determines whether the password is to be encrypted.")
990 991
		},
		&Password_encryption,
992
		true, NULL, NULL
993 994
	},
	{
995
		{"transform_null_equals", PGC_USERSET, COMPAT_OPTIONS_CLIENT,
996
			gettext_noop("Treats \"expr=NULL\" as \"expr IS NULL\"."),
997
			gettext_noop("When turned on, expressions of the form expr = NULL "
B
Bruce Momjian 已提交
998 999 1000
			   "(or NULL = expr) are treated as expr IS NULL, that is, they "
				"return true if expr evaluates to the null value, and false "
			   "otherwise. The correct behavior of expr = NULL is to always "
1001
						 "return null (unknown).")
1002 1003
		},
		&Transform_null_equals,
1004
		false, NULL, NULL
1005
	},
1006
	{
1007
		{"db_user_namespace", PGC_SIGHUP, CONN_AUTH_SECURITY,
1008
			gettext_noop("Enables per-database user names."),
1009 1010 1011
			NULL
		},
		&Db_user_namespace,
1012 1013
		false, NULL, NULL
	},
1014
	{
1015 1016
		/* only here for backwards compatibility */
		{"autocommit", PGC_USERSET, CLIENT_CONN_STATEMENT,
1017 1018
			gettext_noop("This parameter doesn't do anything."),
			gettext_noop("It's just here so that we won't choke on SET AUTOCOMMIT TO ON from 7.3-vintage clients."),
1019 1020 1021
			GUC_NO_SHOW_ALL | GUC_NOT_IN_SAMPLE
		},
		&phony_autocommit,
1022
		true, assign_phony_autocommit, NULL
1023
	},
1024
	{
1025
		{"default_transaction_read_only", PGC_USERSET, CLIENT_CONN_STATEMENT,
1026
			gettext_noop("Sets the default read-only status of new transactions."),
1027 1028 1029
			NULL
		},
		&DefaultXactReadOnly,
1030 1031 1032
		false, NULL, NULL
	},
	{
1033
		{"transaction_read_only", PGC_USERSET, CLIENT_CONN_STATEMENT,
1034
			gettext_noop("Sets the current transaction's read-only status."),
1035 1036 1037 1038
			NULL,
			GUC_NO_RESET_ALL | GUC_NOT_IN_SAMPLE | GUC_DISALLOW_IN_FILE
		},
		&XactReadOnly,
1039
		false, assign_transaction_read_only, NULL
1040
	},
1041
	{
1042
		{"add_missing_from", PGC_USERSET, COMPAT_OPTIONS_PREVIOUS,
1043
			gettext_noop("Automatically adds missing table references to FROM clauses."),
1044 1045 1046
			NULL
		},
		&add_missing_from,
1047
		false, NULL, NULL
1048
	},
1049 1050
	{
		{"check_function_bodies", PGC_USERSET, CLIENT_CONN_STATEMENT,
1051
			gettext_noop("Check function bodies during CREATE FUNCTION."),
1052 1053 1054 1055 1056
			NULL
		},
		&check_function_bodies,
		true, NULL, NULL
	},
1057 1058 1059 1060
	{
		{"array_nulls", PGC_USERSET, COMPAT_OPTIONS_PREVIOUS,
			gettext_noop("Enable input of NULL elements in arrays."),
			gettext_noop("When turned on, unquoted NULL in an array input "
P
Peter Eisentraut 已提交
1061
						 "value means a null value; "
1062 1063 1064 1065 1066
						 "otherwise it is taken literally.")
		},
		&Array_nulls,
		true, NULL, NULL
	},
1067 1068
	{
		{"default_with_oids", PGC_USERSET, COMPAT_OPTIONS_PREVIOUS,
1069
			gettext_noop("Create new tables with OIDs by default."),
B
Bruce Momjian 已提交
1070
			NULL
1071 1072
		},
		&default_with_oids,
1073
		false, NULL, NULL
1074
	},
1075
	{
1076 1077
		{"logging_collector", PGC_POSTMASTER, LOGGING_WHERE,
			gettext_noop("Start a subprocess to capture stderr output and/or csvlogs into log files."),
B
Bruce Momjian 已提交
1078
			NULL
1079
		},
1080
		&Logging_collector,
1081 1082
		false, NULL, NULL
	},
1083 1084
	{
		{"log_truncate_on_rotation", PGC_SIGHUP, LOGGING_WHERE,
P
Peter Eisentraut 已提交
1085
			gettext_noop("Truncate existing log files of same name during log rotation."),
1086 1087 1088 1089 1090
			NULL
		},
		&Log_truncate_on_rotation,
		false, NULL, NULL
	},
1091

1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103
#ifdef TRACE_SORT
	{
		{"trace_sort", PGC_USERSET, DEVELOPER_OPTIONS,
			gettext_noop("Emit information about resource usage in sorting."),
			NULL,
			GUC_NOT_IN_SAMPLE
		},
		&trace_sort,
		false, NULL, NULL
	},
#endif

1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116
#ifdef TRACE_SYNCSCAN
	/* this is undocumented because not exposed in a standard build */
	{
		{"trace_syncscan", PGC_USERSET, DEVELOPER_OPTIONS,
			gettext_noop("Generate debugging output for synchronized scanning."),
			NULL,
			GUC_NOT_IN_SAMPLE
		},
		&trace_syncscan,
		false, NULL, NULL
	},
#endif

1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130
#ifdef DEBUG_BOUNDED_SORT
	/* this is undocumented because not exposed in a standard build */
	{
		{
			"optimize_bounded_sort", PGC_USERSET, QUERY_TUNING_METHOD,
			gettext_noop("Enable bounded sorting using heap sort."),
			NULL,
			GUC_NOT_IN_SAMPLE
		},
		&optimize_bounded_sort,
		true, NULL, NULL
	},
#endif

1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142
#ifdef WAL_DEBUG
	{
		{"wal_debug", PGC_SUSET, DEVELOPER_OPTIONS,
			gettext_noop("Emit WAL-related debugging output."),
			NULL,
			GUC_NOT_IN_SAMPLE
		},
		&XLOG_DEBUG,
		false, NULL, NULL
	},
#endif

1143
	{
1144
		{"integer_datetimes", PGC_INTERNAL, PRESET_OPTIONS,
1145
			gettext_noop("Datetimes are integer based."),
1146
			NULL,
1147
			GUC_REPORT | GUC_NOT_IN_SAMPLE | GUC_DISALLOW_IN_FILE
1148 1149 1150 1151 1152 1153 1154 1155 1156
		},
		&integer_datetimes,
#ifdef HAVE_INT64_TIMESTAMP
		true, NULL, NULL
#else
		false, NULL, NULL
#endif
	},

B
 
Bruce Momjian 已提交
1157
	{
1158
		{"krb_caseins_users", PGC_SIGHUP, CONN_AUTH_SECURITY,
1159
			gettext_noop("Sets whether Kerberos and GSSAPI user names should be treated as case-insensitive."),
B
 
Bruce Momjian 已提交
1160 1161 1162 1163 1164 1165
			NULL
		},
		&pg_krb_caseins_users,
		false, NULL, NULL
	},

1166 1167
	{
		{"escape_string_warning", PGC_USERSET, COMPAT_OPTIONS_PREVIOUS,
1168
			gettext_noop("Warn about backslash escapes in ordinary string literals."),
1169 1170 1171
			NULL
		},
		&escape_string_warning,
1172
		true, NULL, NULL
1173 1174 1175
	},

	{
1176
		{"standard_conforming_strings", PGC_USERSET, COMPAT_OPTIONS_PREVIOUS,
1177
			gettext_noop("Causes '...' strings to treat backslashes literally."),
1178
			NULL,
1179
			GUC_REPORT
1180
		},
1181
		&standard_conforming_strings,
1182 1183 1184
		false, NULL, NULL
	},

1185 1186 1187 1188 1189 1190 1191 1192 1193
	{
		{"synchronize_seqscans", PGC_USERSET, COMPAT_OPTIONS_PREVIOUS,
			gettext_noop("Enable synchronized sequential scans."),
			NULL
		},
		&synchronize_seqscans,
		true, NULL, NULL
	},

B
Bruce Momjian 已提交
1194 1195 1196 1197 1198 1199 1200 1201
	{
		{"archive_mode", PGC_POSTMASTER, WAL_SETTINGS,
			gettext_noop("Allows archiving of WAL files using archive_command."),
			NULL
		},
		&XLogArchiveMode,
		false, NULL, NULL
	},
1202

1203
	{
1204
		{"allow_system_table_mods", PGC_POSTMASTER, DEVELOPER_OPTIONS,
B
Bruce Momjian 已提交
1205 1206 1207
			gettext_noop("Allows modifications of the structure of system tables."),
			NULL,
			GUC_NOT_IN_SAMPLE
1208 1209 1210 1211 1212 1213 1214
		},
		&allowSystemTableMods,
		false, NULL, NULL
	},

	{
		{"ignore_system_indexes", PGC_BACKEND, DEVELOPER_OPTIONS,
B
Bruce Momjian 已提交
1215 1216 1217 1218
			gettext_noop("Disables reading from system indexes."),
			gettext_noop("It does not prevent updating the indexes, so it is safe "
						 "to use.  The worst consequence is slowness."),
			GUC_NOT_IN_SAMPLE
1219 1220 1221 1222 1223
		},
		&IgnoreSystemIndexes,
		false, NULL, NULL
	},

1224
	/* End-of-list marker */
1225
	{
1226 1227
		{NULL, 0, 0, NULL, NULL}, NULL, false, NULL, NULL
	}
1228 1229 1230
};


1231
static struct config_int ConfigureNamesInt[] =
1232
{
1233 1234
	{
		{"archive_timeout", PGC_SIGHUP, WAL_SETTINGS,
B
Bruce Momjian 已提交
1235 1236 1237 1238
			gettext_noop("Forces a switch to the next xlog file if a "
						 "new file has not been started within N seconds."),
			NULL,
			GUC_UNIT_S
1239 1240 1241 1242
		},
		&XLogArchiveTimeout,
		0, 0, INT_MAX, NULL, NULL
	},
1243 1244
	{
		{"post_auth_delay", PGC_BACKEND, DEVELOPER_OPTIONS,
B
Bruce Momjian 已提交
1245 1246 1247
			gettext_noop("Waits N seconds on connection startup after authentication."),
			gettext_noop("This allows attaching a debugger to the process."),
			GUC_NOT_IN_SAMPLE | GUC_UNIT_S
1248 1249 1250 1251
		},
		&PostAuthDelay,
		0, 0, INT_MAX, NULL, NULL
	},
1252
	{
1253
		{"default_statistics_target", PGC_USERSET, QUERY_TUNING_OTHER,
1254
			gettext_noop("Sets the default statistics target."),
1255
			gettext_noop("This applies to table columns that have not had a "
B
Bruce Momjian 已提交
1256
				"column-specific target set via ALTER TABLE SET STATISTICS.")
1257 1258
		},
		&default_statistics_target,
1259
		100, 1, 10000, NULL, NULL
1260
	},
1261
	{
1262
		{"from_collapse_limit", PGC_USERSET, QUERY_TUNING_OTHER,
1263 1264
			gettext_noop("Sets the FROM-list size beyond which subqueries "
						 "are not collapsed."),
1265
			gettext_noop("The planner will merge subqueries into upper "
B
Bruce Momjian 已提交
1266
				"queries if the resulting FROM list would have no more than "
1267
						 "this many items.")
1268 1269
		},
		&from_collapse_limit,
1270 1271 1272
		8, 1, INT_MAX, NULL, NULL
	},
	{
1273
		{"join_collapse_limit", PGC_USERSET, QUERY_TUNING_OTHER,
1274 1275
			gettext_noop("Sets the FROM-list size beyond which JOIN "
						 "constructs are not flattened."),
1276
			gettext_noop("The planner will flatten explicit JOIN "
1277 1278
						 "constructs into lists of FROM items whenever a "
						 "list of no more than this many items would result.")
1279 1280
		},
		&join_collapse_limit,
1281 1282 1283
		8, 1, INT_MAX, NULL, NULL
	},
	{
1284
		{"geqo_threshold", PGC_USERSET, QUERY_TUNING_GEQO,
1285
			gettext_noop("Sets the threshold of FROM items beyond which GEQO is used."),
1286 1287 1288
			NULL
		},
		&geqo_threshold,
1289
		12, 2, INT_MAX, NULL, NULL
1290
	},
1291
	{
1292 1293
		{"geqo_effort", PGC_USERSET, QUERY_TUNING_GEQO,
			gettext_noop("GEQO: effort is used to set the default for other GEQO parameters."),
1294 1295
			NULL
		},
1296 1297 1298 1299 1300 1301 1302 1303
		&Geqo_effort,
		DEFAULT_GEQO_EFFORT, MIN_GEQO_EFFORT, MAX_GEQO_EFFORT, NULL, NULL
	},
	{
		{"geqo_pool_size", PGC_USERSET, QUERY_TUNING_GEQO,
			gettext_noop("GEQO: number of individuals in the population."),
			gettext_noop("Zero selects a suitable default value.")
		},
1304
		&Geqo_pool_size,
1305
		0, 0, INT_MAX, NULL, NULL
1306 1307
	},
	{
1308
		{"geqo_generations", PGC_USERSET, QUERY_TUNING_GEQO,
1309
			gettext_noop("GEQO: number of iterations of the algorithm."),
1310
			gettext_noop("Zero selects a suitable default value.")
1311 1312
		},
		&Geqo_generations,
1313
		0, 0, INT_MAX, NULL, NULL
1314 1315 1316
	},

	{
1317
		/* This is PGC_SIGHUP so all backends have the same value. */
1318
		{"deadlock_timeout", PGC_SIGHUP, LOCK_MANAGEMENT,
B
Bruce Momjian 已提交
1319
			gettext_noop("Sets the time to wait on a lock before checking for deadlock, in milliseconds."),
1320 1321
			NULL,
			GUC_UNIT_MS
1322 1323
		},
		&DeadlockTimeout,
B
Bruce Momjian 已提交
1324
		1000, 1, INT_MAX / 1000, NULL, NULL
1325
	},
1326 1327

	/*
1328 1329
	 * Note: MaxBackends is limited to INT_MAX/4 because some places compute
	 * 4*MaxBackends without any overflow check.  This check is made in
B
Bruce Momjian 已提交
1330
	 * assign_maxconnections, since MaxBackends is computed as MaxConnections
1331
	 * plus autovacuum_max_workers.
1332 1333
	 *
	 * Likewise we have to limit NBuffers to INT_MAX/2.
1334
	 */
1335
	{
1336
		{"max_connections", PGC_POSTMASTER, CONN_AUTH_SETTINGS,
1337
			gettext_noop("Sets the maximum number of concurrent connections."),
1338 1339
			NULL
		},
1340 1341
		&MaxConnections,
		100, 1, INT_MAX / 4, assign_maxconnections, NULL
1342
	},
1343

1344
	{
1345
		{"superuser_reserved_connections", PGC_POSTMASTER, CONN_AUTH_SETTINGS,
1346
			gettext_noop("Sets the number of connection slots reserved for superusers."),
1347 1348 1349
			NULL
		},
		&ReservedBackends,
1350
		3, 0, INT_MAX / 4, NULL, NULL
1351 1352
	},

1353
	{
1354
		{"shared_buffers", PGC_POSTMASTER, RESOURCES_MEM,
1355
			gettext_noop("Sets the number of shared memory buffers used by the server."),
1356 1357
			NULL,
			GUC_UNIT_BLOCKS
1358 1359
		},
		&NBuffers,
1360
		1024, 16, INT_MAX / 2, NULL, NULL
1361
	},
1362

1363 1364 1365
	{
		{"temp_buffers", PGC_USERSET, RESOURCES_MEM,
			gettext_noop("Sets the maximum number of temporary buffers used by each session."),
1366 1367
			NULL,
			GUC_UNIT_BLOCKS
1368 1369
		},
		&num_temp_buffers,
1370
		1024, 100, INT_MAX / 2, NULL, show_num_temp_buffers
1371 1372
	},

1373
	{
1374
		{"port", PGC_POSTMASTER, CONN_AUTH_SETTINGS,
1375
			gettext_noop("Sets the TCP port the server listens on."),
1376 1377 1378
			NULL
		},
		&PostPortNumber,
1379
		DEF_PGPORT, 1, 65535, NULL, NULL
1380
	},
1381

1382
	{
1383
		{"unix_socket_permissions", PGC_POSTMASTER, CONN_AUTH_SETTINGS,
1384
			gettext_noop("Sets the access permissions of the Unix-domain socket."),
1385
			gettext_noop("Unix-domain sockets use the usual Unix file system "
1386
						 "permission set. The parameter value is expected to be a numeric mode "
1387
						 "specification in the form accepted by the chmod and umask system "
1388 1389 1390 1391
						 "calls. (To use the customary octal format the number must start with "
						 "a 0 (zero).)")
		},
		&Unix_socket_permissions,
1392
		0777, 0000, 0777, NULL, NULL
1393
	},
1394

1395
	{
1396 1397
		{"work_mem", PGC_USERSET, RESOURCES_MEM,
			gettext_noop("Sets the maximum memory to be used for query workspaces."),
1398
			gettext_noop("This much memory can be used by each internal "
B
Bruce Momjian 已提交
1399
						 "sort operation and hash table before switching to "
1400 1401
						 "temporary disk files."),
			GUC_UNIT_KB
1402
		},
1403
		&work_mem,
1404
		1024, 64, MAX_KILOBYTES, NULL, NULL
1405
	},
1406

1407
	{
1408
		{"maintenance_work_mem", PGC_USERSET, RESOURCES_MEM,
B
Bruce Momjian 已提交
1409
			gettext_noop("Sets the maximum memory to be used for maintenance operations, in kilobytes."),
1410 1411
			gettext_noop("This includes operations such as VACUUM and CREATE INDEX."),
			GUC_UNIT_KB
1412
		},
1413
		&maintenance_work_mem,
1414
		16384, 1024, MAX_KILOBYTES, NULL, NULL
1415
	},
1416

1417 1418 1419
	{
		{"max_stack_depth", PGC_SUSET, RESOURCES_MEM,
			gettext_noop("Sets the maximum stack depth, in kilobytes."),
1420 1421
			NULL,
			GUC_UNIT_KB
1422 1423
		},
		&max_stack_depth,
1424
		100, 100, MAX_KILOBYTES, assign_max_stack_depth, NULL
1425 1426
	},

J
Jan Wieck 已提交
1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463
	{
		{"vacuum_cost_page_hit", PGC_USERSET, RESOURCES,
			gettext_noop("Vacuum cost for a page found in the buffer cache."),
			NULL
		},
		&VacuumCostPageHit,
		1, 0, 10000, NULL, NULL
	},

	{
		{"vacuum_cost_page_miss", PGC_USERSET, RESOURCES,
			gettext_noop("Vacuum cost for a page not found in the buffer cache."),
			NULL
		},
		&VacuumCostPageMiss,
		10, 0, 10000, NULL, NULL
	},

	{
		{"vacuum_cost_page_dirty", PGC_USERSET, RESOURCES,
			gettext_noop("Vacuum cost for a page dirtied by vacuum."),
			NULL
		},
		&VacuumCostPageDirty,
		20, 0, 10000, NULL, NULL
	},

	{
		{"vacuum_cost_limit", PGC_USERSET, RESOURCES,
			gettext_noop("Vacuum cost amount available before napping."),
			NULL
		},
		&VacuumCostLimit,
		200, 1, 10000, NULL, NULL
	},

	{
1464 1465
		{"vacuum_cost_delay", PGC_USERSET, RESOURCES,
			gettext_noop("Vacuum cost delay in milliseconds."),
1466 1467
			NULL,
			GUC_UNIT_MS
J
Jan Wieck 已提交
1468
		},
1469
		&VacuumCostDelay,
1470
		0, 0, 100, NULL, NULL
J
Jan Wieck 已提交
1471 1472
	},

1473 1474 1475
	{
		{"autovacuum_vacuum_cost_delay", PGC_SIGHUP, AUTOVACUUM,
			gettext_noop("Vacuum cost delay in milliseconds, for autovacuum."),
1476 1477
			NULL,
			GUC_UNIT_MS
1478 1479
		},
		&autovacuum_vac_cost_delay,
1480
		20, -1, 100, NULL, NULL
1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491
	},

	{
		{"autovacuum_vacuum_cost_limit", PGC_SIGHUP, AUTOVACUUM,
			gettext_noop("Vacuum cost amount available before napping, for autovacuum."),
			NULL
		},
		&autovacuum_vac_cost_limit,
		-1, -1, 10000, NULL, NULL
	},

1492
	{
1493
		{"max_files_per_process", PGC_POSTMASTER, RESOURCES_KERNEL,
1494
			gettext_noop("Sets the maximum number of simultaneously open files for each server process."),
1495 1496 1497
			NULL
		},
		&max_files_per_process,
1498
		1000, 25, INT_MAX, NULL, NULL
1499
	},
1500

1501 1502 1503 1504 1505 1506
	{
		{"max_prepared_transactions", PGC_POSTMASTER, RESOURCES,
			gettext_noop("Sets the maximum number of simultaneously prepared transactions."),
			NULL
		},
		&max_prepared_xacts,
1507
		5, 0, INT_MAX, NULL, NULL
1508 1509
	},

1510
#ifdef LOCK_DEBUG
1511
	{
1512
		{"trace_lock_oidmin", PGC_SUSET, DEVELOPER_OPTIONS,
1513
			gettext_noop("No description available."),
1514 1515 1516 1517
			NULL,
			GUC_NOT_IN_SAMPLE
		},
		&Trace_lock_oidmin,
1518
		FirstNormalObjectId, 0, INT_MAX, NULL, NULL
1519 1520
	},
	{
1521
		{"trace_lock_table", PGC_SUSET, DEVELOPER_OPTIONS,
1522
			gettext_noop("No description available."),
1523 1524 1525 1526
			NULL,
			GUC_NOT_IN_SAMPLE
		},
		&Trace_lock_table,
1527
		0, 0, INT_MAX, NULL, NULL
1528
	},
1529 1530
#endif

1531
	{
1532
		{"statement_timeout", PGC_USERSET, CLIENT_CONN_STATEMENT,
1533
			gettext_noop("Sets the maximum duration of any statement, in milliseconds."),
1534 1535
			gettext_noop("A value of 0 turns off the timeout."),
			GUC_UNIT_MS
1536 1537
		},
		&StatementTimeout,
1538 1539 1540
		0, 0, INT_MAX, NULL, NULL
	},

1541 1542 1543 1544 1545 1546
	{
		{"vacuum_freeze_min_age", PGC_USERSET, CLIENT_CONN_STATEMENT,
			gettext_noop("Minimum age at which VACUUM should freeze a table row."),
			NULL
		},
		&vacuum_freeze_min_age,
1547 1548 1549 1550 1551 1552 1553 1554 1555 1556
		50000000, 0, 1000000000, NULL, NULL
	},

	{
		{"vacuum_freeze_table_age", PGC_USERSET, CLIENT_CONN_STATEMENT,
			gettext_noop("Age at which VACUUM should scan whole table to freeze tuples."),
			NULL
		},
		&vacuum_freeze_table_age,
		150000000, 0, 2000000000, NULL, NULL
1557 1558
	},

1559
	{
1560
		{"max_locks_per_transaction", PGC_POSTMASTER, LOCK_MANAGEMENT,
1561
			gettext_noop("Sets the maximum number of locks per transaction."),
1562
			gettext_noop("The shared lock table is sized on the assumption that "
B
Bruce Momjian 已提交
1563
			  "at most max_locks_per_transaction * max_connections distinct "
1564
						 "objects will need to be locked at any one time.")
1565 1566
		},
		&max_locks_per_xact,
1567
		64, 10, INT_MAX, NULL, NULL
1568
	},
1569

1570
	{
1571
		{"authentication_timeout", PGC_SIGHUP, CONN_AUTH_SECURITY,
B
Bruce Momjian 已提交
1572
			gettext_noop("Sets the maximum allowed time to complete client authentication, in seconds."),
1573 1574
			NULL,
			GUC_UNIT_S
1575 1576
		},
		&AuthenticationTimeout,
1577
		60, 1, 600, NULL, NULL
1578
	},
1579

1580
	{
1581 1582
		/* Not for general use */
		{"pre_auth_delay", PGC_SIGHUP, DEVELOPER_OPTIONS,
1583 1584
			gettext_noop("Waits N seconds on connection startup before authentication."),
			gettext_noop("This allows attaching a debugger to the process."),
1585
			GUC_NOT_IN_SAMPLE | GUC_UNIT_S
1586 1587
		},
		&PreAuthDelay,
1588
		0, 0, 60, NULL, NULL
1589
	},
1590

1591
	{
1592
		{"checkpoint_segments", PGC_SIGHUP, WAL_CHECKPOINTS,
1593
			gettext_noop("Sets the maximum distance in log segments between automatic WAL checkpoints."),
1594 1595 1596
			NULL
		},
		&CheckPointSegments,
1597
		3, 1, INT_MAX, NULL, NULL
1598
	},
T
Tom Lane 已提交
1599

1600
	{
1601
		{"checkpoint_timeout", PGC_SIGHUP, WAL_CHECKPOINTS,
B
Bruce Momjian 已提交
1602
			gettext_noop("Sets the maximum time between automatic WAL checkpoints, in seconds."),
1603 1604
			NULL,
			GUC_UNIT_S
1605 1606
		},
		&CheckPointTimeout,
1607
		300, 30, 3600, NULL, NULL
1608
	},
V
Vadim B. Mikheev 已提交
1609

1610
	{
1611
		{"checkpoint_warning", PGC_SIGHUP, WAL_CHECKPOINTS,
1612 1613
			gettext_noop("Enables warnings if checkpoint segments are filled more "
						 "frequently than this."),
1614
			gettext_noop("Write a message to the server log if checkpoints "
B
Bruce Momjian 已提交
1615
			"caused by the filling of checkpoint segment files happens more "
1616 1617
						 "frequently than this number of seconds. Zero turns off the warning."),
			GUC_UNIT_S
1618 1619
		},
		&CheckPointWarning,
1620 1621 1622
		30, 0, INT_MAX, NULL, NULL
	},

1623
	{
1624
		{"wal_buffers", PGC_POSTMASTER, WAL_SETTINGS,
1625
			gettext_noop("Sets the number of disk-page buffers in shared memory for WAL."),
1626 1627
			NULL,
			GUC_UNIT_XBLOCKS
1628 1629
		},
		&XLOGbuffers,
1630
		8, 4, INT_MAX, NULL, NULL
1631
	},
V
Vadim B. Mikheev 已提交
1632

1633 1634
	{
		{"wal_writer_delay", PGC_SIGHUP, WAL_SETTINGS,
B
Bruce Momjian 已提交
1635
			gettext_noop("WAL writer sleep time between WAL flushes, in milliseconds."),
1636 1637 1638 1639 1640 1641 1642
			NULL,
			GUC_UNIT_MS
		},
		&WalWriterDelay,
		200, 1, 10000, NULL, NULL
	},

1643
	{
1644
		{"commit_delay", PGC_USERSET, WAL_SETTINGS,
1645 1646
			gettext_noop("Sets the delay in microseconds between transaction commit and "
						 "flushing WAL to disk."),
1647 1648 1649
			NULL
		},
		&CommitDelay,
1650
		0, 0, 100000, NULL, NULL
1651
	},
V
Vadim B. Mikheev 已提交
1652

1653
	{
1654
		{"commit_siblings", PGC_USERSET, WAL_SETTINGS,
1655 1656
			gettext_noop("Sets the minimum concurrent open transactions before performing "
						 "commit_delay."),
1657 1658 1659
			NULL
		},
		&CommitSiblings,
1660
		5, 1, 1000, NULL, NULL
1661
	},
1662

1663
	{
1664
		{"extra_float_digits", PGC_USERSET, CLIENT_CONN_LOCALE,
1665
			gettext_noop("Sets the number of digits displayed for floating-point values."),
1666
			gettext_noop("This affects real, double precision, and geometric data types. "
B
Bruce Momjian 已提交
1667
			 "The parameter value is added to the standard number of digits "
1668
						 "(FLT_DIG or DBL_DIG as appropriate).")
1669 1670
		},
		&extra_float_digits,
1671 1672 1673
		0, -15, 2, NULL, NULL
	},

B
Bruce Momjian 已提交
1674
	{
1675
		{"log_min_duration_statement", PGC_SUSET, LOGGING_WHEN,
B
Bruce Momjian 已提交
1676 1677
			gettext_noop("Sets the minimum execution time (in milliseconds) above "
						 "which statements will be logged."),
1678
			gettext_noop("Zero prints all queries. -1 turns this feature off."),
1679
			GUC_UNIT_MS
1680 1681
		},
		&log_min_duration_statement,
1682
		-1, -1, INT_MAX / 1000, NULL, NULL
B
Bruce Momjian 已提交
1683 1684
	},

1685
	{
1686
		{"log_autovacuum_min_duration", PGC_SIGHUP, LOGGING_WHAT,
B
Bruce Momjian 已提交
1687
			gettext_noop("Sets the minimum execution in milliseconds above which "
1688 1689
						 "autovacuum actions will be logged."),
			gettext_noop("Zero prints all actions. -1 turns autovacuum logging off."),
1690 1691
			GUC_UNIT_MS
		},
1692
		&Log_autovacuum_min_duration,
1693 1694 1695
		-1, -1, INT_MAX / 1000, NULL, NULL
	},

J
Jan Wieck 已提交
1696 1697
	{
		{"bgwriter_delay", PGC_SIGHUP, RESOURCES,
B
Bruce Momjian 已提交
1698
			gettext_noop("Background writer sleep time between rounds, in milliseconds."),
1699 1700
			NULL,
			GUC_UNIT_MS
J
Jan Wieck 已提交
1701 1702
		},
		&BgWriterDelay,
1703
		200, 10, 10000, NULL, NULL
J
Jan Wieck 已提交
1704 1705 1706
	},

	{
1707
		{"bgwriter_lru_maxpages", PGC_SIGHUP, RESOURCES,
1708
			gettext_noop("Background writer maximum number of LRU pages to flush per round."),
J
Jan Wieck 已提交
1709 1710
			NULL
		},
1711
		&bgwriter_lru_maxpages,
1712
		100, 0, 1000, NULL, NULL
J
Jan Wieck 已提交
1713 1714
	},

1715
	{
1716 1717 1718 1719 1720 1721 1722
		{"effective_io_concurrency",
#ifdef USE_PREFETCH
		PGC_USERSET,
#else
		PGC_INTERNAL,
#endif
		RESOURCES,
1723 1724 1725 1726 1727 1728 1729 1730 1731 1732 1733 1734
			gettext_noop("Number of simultaneous requests that can be handled efficiently by the disk subsystem."),
			gettext_noop("For RAID arrays, this should be approximately the number of drive spindles in the array.")
		},
		&effective_io_concurrency,
#ifdef USE_PREFETCH
		1, 0, 1000,
#else
		0, 0, 0,
#endif
		assign_effective_io_concurrency, NULL
	},

1735 1736
	{
		{"log_rotation_age", PGC_SIGHUP, LOGGING_WHERE,
1737
			gettext_noop("Automatic log file rotation will occur after N minutes."),
1738 1739
			NULL,
			GUC_UNIT_MIN
1740 1741
		},
		&Log_RotationAge,
B
Bruce Momjian 已提交
1742
		HOURS_PER_DAY * MINS_PER_HOUR, 0, INT_MAX / MINS_PER_HOUR, NULL, NULL
1743 1744 1745 1746
	},

	{
		{"log_rotation_size", PGC_SIGHUP, LOGGING_WHERE,
1747
			gettext_noop("Automatic log file rotation will occur after N kilobytes."),
1748 1749
			NULL,
			GUC_UNIT_KB
1750 1751
		},
		&Log_RotationSize,
1752
		10 * 1024, 0, INT_MAX / 1024, NULL, NULL
1753 1754
	},

1755
	{
1756
		{"max_function_args", PGC_INTERNAL, PRESET_OPTIONS,
P
Peter Eisentraut 已提交
1757
			gettext_noop("Shows the maximum number of function arguments."),
1758 1759 1760 1761 1762 1763 1764 1765
			NULL,
			GUC_NOT_IN_SAMPLE | GUC_DISALLOW_IN_FILE
		},
		&max_function_args,
		FUNC_MAX_ARGS, FUNC_MAX_ARGS, FUNC_MAX_ARGS, NULL, NULL
	},

	{
1766
		{"max_index_keys", PGC_INTERNAL, PRESET_OPTIONS,
P
Peter Eisentraut 已提交
1767
			gettext_noop("Shows the maximum number of index keys."),
1768 1769 1770 1771 1772 1773 1774 1775
			NULL,
			GUC_NOT_IN_SAMPLE | GUC_DISALLOW_IN_FILE
		},
		&max_index_keys,
		INDEX_MAX_KEYS, INDEX_MAX_KEYS, INDEX_MAX_KEYS, NULL, NULL
	},

	{
1776
		{"max_identifier_length", PGC_INTERNAL, PRESET_OPTIONS,
1777
			gettext_noop("Shows the maximum identifier length."),
1778 1779 1780 1781 1782 1783 1784 1785
			NULL,
			GUC_NOT_IN_SAMPLE | GUC_DISALLOW_IN_FILE
		},
		&max_identifier_length,
		NAMEDATALEN - 1, NAMEDATALEN - 1, NAMEDATALEN - 1, NULL, NULL
	},

	{
1786
		{"block_size", PGC_INTERNAL, PRESET_OPTIONS,
1787
			gettext_noop("Shows the size of a disk block."),
1788 1789 1790 1791 1792 1793 1794
			NULL,
			GUC_NOT_IN_SAMPLE | GUC_DISALLOW_IN_FILE
		},
		&block_size,
		BLCKSZ, BLCKSZ, BLCKSZ, NULL, NULL
	},

1795 1796 1797 1798 1799 1800 1801 1802 1803 1804 1805 1806 1807 1808 1809 1810 1811 1812 1813 1814 1815 1816 1817 1818 1819 1820 1821 1822 1823 1824 1825 1826 1827
	{
		{"segment_size", PGC_INTERNAL, PRESET_OPTIONS,
		    gettext_noop("Shows the number of pages per disk file."),
		    NULL,
		    GUC_UNIT_BLOCKS | GUC_NOT_IN_SAMPLE | GUC_DISALLOW_IN_FILE
		},
		&segment_size,
		RELSEG_SIZE, RELSEG_SIZE, RELSEG_SIZE, NULL, NULL
	},

	{
		{"wal_block_size", PGC_INTERNAL, PRESET_OPTIONS,
			gettext_noop("Shows the block size in the write ahead log."),
			NULL,
			GUC_NOT_IN_SAMPLE | GUC_DISALLOW_IN_FILE
		},
		&wal_block_size,
		XLOG_BLCKSZ, XLOG_BLCKSZ, XLOG_BLCKSZ, NULL, NULL
	},

	{
		{"wal_segment_size", PGC_INTERNAL, PRESET_OPTIONS,
			gettext_noop("Shows the number of pages per write ahead log segment."),
			NULL,
			GUC_UNIT_XBLOCKS | GUC_NOT_IN_SAMPLE | GUC_DISALLOW_IN_FILE
		},
		&wal_segment_size,
		(XLOG_SEG_SIZE / XLOG_BLCKSZ), 
		(XLOG_SEG_SIZE / XLOG_BLCKSZ), 
		(XLOG_SEG_SIZE / XLOG_BLCKSZ),
		NULL, NULL
	},

1828 1829
	{
		{"autovacuum_naptime", PGC_SIGHUP, AUTOVACUUM,
B
Bruce Momjian 已提交
1830
			gettext_noop("Time to sleep between autovacuum runs, in seconds."),
1831 1832
			NULL,
			GUC_UNIT_S
1833 1834
		},
		&autovacuum_naptime,
1835
		60, 1, INT_MAX / 1000, NULL, NULL
1836 1837 1838 1839 1840 1841 1842
	},
	{
		{"autovacuum_vacuum_threshold", PGC_SIGHUP, AUTOVACUUM,
			gettext_noop("Minimum number of tuple updates or deletes prior to vacuum."),
			NULL
		},
		&autovacuum_vac_thresh,
1843
		50, 0, INT_MAX, NULL, NULL
1844 1845 1846 1847 1848 1849 1850
	},
	{
		{"autovacuum_analyze_threshold", PGC_SIGHUP, AUTOVACUUM,
			gettext_noop("Minimum number of tuple inserts, updates or deletes prior to analyze."),
			NULL
		},
		&autovacuum_anl_thresh,
1851
		50, 0, INT_MAX, NULL, NULL
1852
	},
1853 1854 1855
	{
		/* see varsup.c for why this is PGC_POSTMASTER not PGC_SIGHUP */
		{"autovacuum_freeze_max_age", PGC_POSTMASTER, AUTOVACUUM,
P
Peter Eisentraut 已提交
1856
			gettext_noop("Age at which to autovacuum a table to prevent transaction ID wraparound."),
1857 1858 1859 1860 1861
			NULL
		},
		&autovacuum_freeze_max_age,
		200000000, 100000000, 2000000000, NULL, NULL
	},
1862 1863 1864 1865 1866 1867 1868 1869 1870
	{
		/* see max_connections */
		{"autovacuum_max_workers", PGC_POSTMASTER, AUTOVACUUM,
			gettext_noop("Sets the maximum number of simultaneously running autovacuum worker processes."),
			NULL
		},
		&autovacuum_max_workers,
		3, 1, INT_MAX / 4, assign_autovacuum_max_workers, NULL
	},
1871

1872 1873
	{
		{"tcp_keepalives_idle", PGC_USERSET, CLIENT_CONN_OTHER,
1874
			gettext_noop("Seconds between issuing TCP keepalives."),
B
Bruce Momjian 已提交
1875
			gettext_noop("A value of 0 uses the system default."),
1876
			GUC_UNIT_S
B
Bruce Momjian 已提交
1877
		},
1878 1879 1880 1881 1882 1883
		&tcp_keepalives_idle,
		0, 0, INT_MAX, assign_tcp_keepalives_idle, show_tcp_keepalives_idle
	},

	{
		{"tcp_keepalives_interval", PGC_USERSET, CLIENT_CONN_OTHER,
1884
			gettext_noop("Seconds between TCP keepalive retransmits."),
B
Bruce Momjian 已提交
1885
			gettext_noop("A value of 0 uses the system default."),
1886
			GUC_UNIT_S
B
Bruce Momjian 已提交
1887
		},
1888 1889 1890 1891 1892 1893
		&tcp_keepalives_interval,
		0, 0, INT_MAX, assign_tcp_keepalives_interval, show_tcp_keepalives_interval
	},

	{
		{"tcp_keepalives_count", PGC_USERSET, CLIENT_CONN_OTHER,
B
Bruce Momjian 已提交
1894 1895 1896 1897 1898
			gettext_noop("Maximum number of TCP keepalive retransmits."),
			gettext_noop("This controls the number of consecutive keepalive retransmits that can be "
						 "lost before a connection is considered dead. A value of 0 uses the "
						 "system default."),
		},
1899 1900 1901 1902
		&tcp_keepalives_count,
		0, 0, INT_MAX, assign_tcp_keepalives_count, show_tcp_keepalives_count
	},

T
Teodor Sigaev 已提交
1903
	{
1904
		{"gin_fuzzy_search_limit", PGC_USERSET, CLIENT_CONN_OTHER,
P
Peter Eisentraut 已提交
1905
			gettext_noop("Sets the maximum allowed result for exact search by GIN."),
T
Teodor Sigaev 已提交
1906 1907 1908 1909 1910 1911 1912
			NULL,
			0
		},
		&GinFuzzySearchLimit,
		0, 0, INT_MAX, NULL, NULL
	},

1913 1914
	{
		{"effective_cache_size", PGC_USERSET, QUERY_TUNING_COST,
1915
			gettext_noop("Sets the planner's assumption about the size of the disk cache."),
1916 1917
			gettext_noop("That is, the portion of the kernel's disk cache that "
						 "will be used for PostgreSQL data files. This is measured in disk "
1918 1919
						 "pages, which are normally 8 kB each."),
			GUC_UNIT_BLOCKS,
1920 1921 1922 1923 1924
		},
		&effective_cache_size,
		DEFAULT_EFFECTIVE_CACHE_SIZE, 1, INT_MAX, NULL, NULL
	},

1925 1926 1927 1928 1929
	{
		/* Can't be set in postgresql.conf */
		{"server_version_num", PGC_INTERNAL, PRESET_OPTIONS,
			gettext_noop("Shows the server version as an integer."),
			NULL,
1930
			GUC_NOT_IN_SAMPLE | GUC_DISALLOW_IN_FILE
1931 1932 1933 1934
		},
		&server_version_num,
		PG_VERSION_NUM, PG_VERSION_NUM, PG_VERSION_NUM, NULL, NULL
	},
1935

1936
	{
1937
		{"log_temp_files", PGC_SUSET, LOGGING_WHAT,
1938
			gettext_noop("Log the use of temporary files larger than this number of kilobytes."),
1939
			gettext_noop("Zero logs all files. The default is -1 (turning this feature off)."),
1940
			GUC_UNIT_KB
1941 1942 1943 1944
		},
		&log_temp_files,
		-1, -1, INT_MAX, NULL, NULL
	},
1945

1946 1947 1948 1949 1950 1951 1952 1953 1954
	{
		{"track_activity_query_size", PGC_POSTMASTER, RESOURCES_MEM,
			gettext_noop("Sets the size reserved for pg_stat_activity.current_query, in bytes."),
			NULL,
		},
		&pgstat_track_activity_query_size,
		1024, 100, 102400, NULL, NULL
	},

1955
	/* End-of-list marker */
1956
	{
1957
		{NULL, 0, 0, NULL, NULL}, NULL, 0, 0, 0, NULL, NULL
1958
	}
1959 1960 1961
};


1962
static struct config_real ConfigureNamesReal[] =
1963
{
1964
	{
1965 1966 1967 1968
		{"seq_page_cost", PGC_USERSET, QUERY_TUNING_COST,
			gettext_noop("Sets the planner's estimate of the cost of a "
						 "sequentially fetched disk page."),
			NULL
1969
		},
1970 1971
		&seq_page_cost,
		DEFAULT_SEQ_PAGE_COST, 0, DBL_MAX, NULL, NULL
1972
	},
1973
	{
1974
		{"random_page_cost", PGC_USERSET, QUERY_TUNING_COST,
1975 1976 1977
			gettext_noop("Sets the planner's estimate of the cost of a "
						 "nonsequentially fetched disk page."),
			NULL
1978 1979
		},
		&random_page_cost,
1980
		DEFAULT_RANDOM_PAGE_COST, 0, DBL_MAX, NULL, NULL
1981 1982
	},
	{
1983
		{"cpu_tuple_cost", PGC_USERSET, QUERY_TUNING_COST,
1984 1985 1986
			gettext_noop("Sets the planner's estimate of the cost of "
						 "processing each tuple (row)."),
			NULL
1987 1988
		},
		&cpu_tuple_cost,
1989
		DEFAULT_CPU_TUPLE_COST, 0, DBL_MAX, NULL, NULL
1990 1991
	},
	{
1992
		{"cpu_index_tuple_cost", PGC_USERSET, QUERY_TUNING_COST,
1993 1994 1995
			gettext_noop("Sets the planner's estimate of the cost of "
						 "processing each index entry during an index scan."),
			NULL
1996 1997
		},
		&cpu_index_tuple_cost,
1998
		DEFAULT_CPU_INDEX_TUPLE_COST, 0, DBL_MAX, NULL, NULL
1999 2000
	},
	{
2001
		{"cpu_operator_cost", PGC_USERSET, QUERY_TUNING_COST,
2002 2003 2004
			gettext_noop("Sets the planner's estimate of the cost of "
						 "processing each operator or function call."),
			NULL
2005 2006
		},
		&cpu_operator_cost,
2007
		DEFAULT_CPU_OPERATOR_COST, 0, DBL_MAX, NULL, NULL
2008 2009
	},

2010 2011 2012 2013 2014 2015 2016 2017 2018 2019
	{
		{"cursor_tuple_fraction", PGC_USERSET, QUERY_TUNING_OTHER,
			gettext_noop("Sets the planner's estimate of the fraction of "
						 "a cursor's rows that will be retrieved."),
			NULL
		},
		&cursor_tuple_fraction,
		DEFAULT_CURSOR_TUPLE_FRACTION, 0.0, 1.0, NULL, NULL
	},

2020
	{
2021
		{"geqo_selection_bias", PGC_USERSET, QUERY_TUNING_GEQO,
2022
			gettext_noop("GEQO: selective pressure within the population."),
2023 2024 2025
			NULL
		},
		&Geqo_selection_bias,
2026 2027
		DEFAULT_GEQO_SELECTION_BIAS, MIN_GEQO_SELECTION_BIAS,
		MAX_GEQO_SELECTION_BIAS, NULL, NULL
2028 2029
	},

2030
	{
2031
		{"bgwriter_lru_multiplier", PGC_SIGHUP, RESOURCES,
2032
			gettext_noop("Multiple of the average buffer usage to free per round."),
2033 2034
			NULL
		},
2035 2036
		&bgwriter_lru_multiplier,
		2.0, 0.0, 10.0, NULL, NULL
2037 2038
	},

2039
	{
2040
		{"seed", PGC_USERSET, UNGROUPED,
2041
			gettext_noop("Sets the seed for random-number generation."),
2042 2043 2044
			NULL,
			GUC_NO_SHOW_ALL | GUC_NO_RESET_ALL | GUC_NOT_IN_SAMPLE | GUC_DISALLOW_IN_FILE
		},
2045
		&phony_random_seed,
2046
		0.0, -1.0, 1.0, assign_random_seed, show_random_seed
2047 2048
	},

2049 2050 2051 2052 2053 2054
	{
		{"autovacuum_vacuum_scale_factor", PGC_SIGHUP, AUTOVACUUM,
			gettext_noop("Number of tuple updates or deletes prior to vacuum as a fraction of reltuples."),
			NULL
		},
		&autovacuum_vac_scale,
2055
		0.2, 0.0, 100.0, NULL, NULL
2056 2057 2058 2059 2060 2061 2062
	},
	{
		{"autovacuum_analyze_scale_factor", PGC_SIGHUP, AUTOVACUUM,
			gettext_noop("Number of tuple inserts, updates or deletes prior to analyze as a fraction of reltuples."),
			NULL
		},
		&autovacuum_anl_scale,
2063
		0.1, 0.0, 100.0, NULL, NULL
2064 2065
	},

2066 2067 2068 2069 2070 2071 2072 2073 2074
	{
		{"checkpoint_completion_target", PGC_SIGHUP, WAL_CHECKPOINTS,
			gettext_noop("Time spent flushing dirty buffers during checkpoint, as fraction of checkpoint interval."),
			NULL
		},
		&CheckPointCompletionTarget,
		0.5, 0.0, 1.0, NULL, NULL
	},

2075
	/* End-of-list marker */
2076
	{
2077
		{NULL, 0, 0, NULL, NULL}, NULL, 0.0, 0.0, 0.0, NULL, NULL
2078
	}
2079 2080 2081
};


2082
static struct config_string ConfigureNamesString[] =
2083
{
B
Bruce Momjian 已提交
2084 2085
	{
		{"archive_command", PGC_SIGHUP, WAL_SETTINGS,
2086 2087
			gettext_noop("Sets the shell command that will be called to archive a WAL file."),
			NULL
B
Bruce Momjian 已提交
2088 2089
		},
		&XLogArchiveCommand,
2090
		"", NULL, show_archive_command
B
Bruce Momjian 已提交
2091
	},
2092

2093
	{
2094
		{"client_encoding", PGC_USERSET, CLIENT_CONN_LOCALE,
2095
			gettext_noop("Sets the client's character set encoding."),
2096
			NULL,
2097
			GUC_IS_NAME | GUC_REPORT
2098
		},
2099
		&client_encoding_string,
2100
		"SQL_ASCII", assign_client_encoding, NULL
2101 2102
	},

B
Add:  
Bruce Momjian 已提交
2103 2104
	{
		{"log_line_prefix", PGC_SIGHUP, LOGGING_WHAT,
2105 2106
			gettext_noop("Controls information prefixed to each log line."),
			gettext_noop("If blank, no prefix is used.")
B
Add:  
Bruce Momjian 已提交
2107 2108 2109 2110 2111
		},
		&Log_line_prefix,
		"", NULL, NULL
	},

2112 2113 2114 2115 2116 2117 2118 2119
	{
		{"log_timezone", PGC_SIGHUP, LOGGING_WHAT,
			gettext_noop("Sets the time zone to use in log messages."),
			NULL
		},
		&log_timezone_string,
		"UNKNOWN", assign_log_timezone, show_log_timezone
	},
B
Add:  
Bruce Momjian 已提交
2120

2121
	{
2122
		{"DateStyle", PGC_USERSET, CLIENT_CONN_LOCALE,
2123
			gettext_noop("Sets the display format for date and time values."),
2124
			gettext_noop("Also controls interpretation of ambiguous "
2125
						 "date inputs."),
2126 2127
			GUC_LIST_INPUT | GUC_REPORT
		},
2128
		&datestyle_string,
2129
		"ISO, MDY", assign_datestyle, NULL
2130
	},
2131

2132 2133 2134
	{
		{"default_tablespace", PGC_USERSET, CLIENT_CONN_STATEMENT,
			gettext_noop("Sets the default tablespace to create tables and indexes in."),
2135
			gettext_noop("An empty string selects the database's default tablespace."),
B
Bruce Momjian 已提交
2136
			GUC_IS_NAME
2137 2138 2139 2140 2141
		},
		&default_tablespace,
		"", assign_default_tablespace, NULL
	},

2142 2143 2144 2145 2146 2147 2148 2149 2150 2151
	{
		{"temp_tablespaces", PGC_USERSET, CLIENT_CONN_STATEMENT,
			gettext_noop("Sets the tablespace(s) to use for temporary tables and sort files."),
			NULL,
			GUC_LIST_INPUT | GUC_LIST_QUOTE
		},
		&temp_tablespaces,
		"", assign_temp_tablespaces, NULL
	},

2152
	{
2153
		{"dynamic_library_path", PGC_SUSET, CLIENT_CONN_OTHER,
2154
			gettext_noop("Sets the path for dynamically loadable modules."),
2155
			gettext_noop("If a dynamically loadable module needs to be opened and "
2156
						 "the specified name does not have a directory component (i.e., the "
2157
						 "name does not contain a slash), the system will search this path for "
2158 2159
						 "the specified file."),
			GUC_SUPERUSER_ONLY
2160 2161
		},
		&Dynamic_library_path,
2162
		"$libdir", NULL, NULL
2163 2164 2165
	},

	{
2166
		{"krb_server_keyfile", PGC_SIGHUP, CONN_AUTH_SECURITY,
2167
			gettext_noop("Sets the location of the Kerberos server key file."),
2168 2169
			NULL,
			GUC_SUPERUSER_ONLY
2170 2171
		},
		&pg_krb_server_keyfile,
2172
		PG_KRB_SRVTAB, NULL, NULL
2173
	},
2174

B
 
Bruce Momjian 已提交
2175
	{
2176
		{"krb_srvname", PGC_SIGHUP, CONN_AUTH_SECURITY,
B
 
Bruce Momjian 已提交
2177 2178 2179 2180 2181 2182 2183
			gettext_noop("Sets the name of the Kerberos service."),
			NULL
		},
		&pg_krb_srvnam,
		PG_KRB_SRVNAM, NULL, NULL
	},

2184
	{
2185 2186
		{"bonjour_name", PGC_POSTMASTER, CONN_AUTH_SETTINGS,
			gettext_noop("Sets the Bonjour broadcast service name."),
2187 2188
			NULL
		},
2189
		&bonjour_name,
2190 2191 2192
		"", NULL, NULL
	},

2193 2194
	/* See main.c about why defaults for LC_foo are not all alike */

2195
	{
2196
		{"lc_collate", PGC_INTERNAL, CLIENT_CONN_LOCALE,
2197
			gettext_noop("Shows the collation order locale."),
2198 2199 2200 2201
			NULL,
			GUC_NOT_IN_SAMPLE | GUC_DISALLOW_IN_FILE
		},
		&locale_collate,
2202 2203 2204 2205
		"C", NULL, NULL
	},

	{
2206
		{"lc_ctype", PGC_INTERNAL, CLIENT_CONN_LOCALE,
2207
			gettext_noop("Shows the character classification and case conversion locale."),
2208 2209 2210 2211
			NULL,
			GUC_NOT_IN_SAMPLE | GUC_DISALLOW_IN_FILE
		},
		&locale_ctype,
2212 2213 2214
		"C", NULL, NULL
	},

2215
	{
2216
		{"lc_messages", PGC_SUSET, CLIENT_CONN_LOCALE,
2217
			gettext_noop("Sets the language in which messages are displayed."),
2218 2219 2220
			NULL
		},
		&locale_messages,
2221 2222 2223 2224
		"", locale_messages_assign, NULL
	},

	{
2225
		{"lc_monetary", PGC_USERSET, CLIENT_CONN_LOCALE,
2226
			gettext_noop("Sets the locale for formatting monetary amounts."),
2227 2228 2229
			NULL
		},
		&locale_monetary,
2230
		"C", locale_monetary_assign, NULL
2231 2232 2233
	},

	{
2234
		{"lc_numeric", PGC_USERSET, CLIENT_CONN_LOCALE,
2235
			gettext_noop("Sets the locale for formatting numbers."),
2236 2237 2238
			NULL
		},
		&locale_numeric,
2239
		"C", locale_numeric_assign, NULL
2240 2241 2242
	},

	{
2243
		{"lc_time", PGC_USERSET, CLIENT_CONN_LOCALE,
2244
			gettext_noop("Sets the locale for formatting date and time values."),
2245 2246 2247
			NULL
		},
		&locale_time,
2248
		"C", locale_time_assign, NULL
2249 2250
	},

2251
	{
2252
		{"shared_preload_libraries", PGC_POSTMASTER, RESOURCES_KERNEL,
2253
			gettext_noop("Lists shared libraries to preload into server."),
2254
			NULL,
2255
			GUC_LIST_INPUT | GUC_LIST_QUOTE | GUC_SUPERUSER_ONLY
2256
		},
2257 2258 2259 2260 2261 2262 2263 2264 2265 2266 2267
		&shared_preload_libraries_string,
		"", NULL, NULL
	},

	{
		{"local_preload_libraries", PGC_BACKEND, CLIENT_CONN_OTHER,
			gettext_noop("Lists shared libraries to preload into each backend."),
			NULL,
			GUC_LIST_INPUT | GUC_LIST_QUOTE
		},
		&local_preload_libraries_string,
2268
		"", NULL, NULL
2269 2270
	},

2271
	{
2272
		{"search_path", PGC_USERSET, CLIENT_CONN_STATEMENT,
2273
			gettext_noop("Sets the schema search order for names that are not schema-qualified."),
2274 2275 2276
			NULL,
			GUC_LIST_INPUT | GUC_LIST_QUOTE
		},
2277
		&namespace_search_path,
2278
		"\"$user\",public", assign_search_path, NULL
2279 2280 2281
	},

	{
2282 2283
		/* Can't be set in postgresql.conf */
		{"server_encoding", PGC_INTERNAL, CLIENT_CONN_LOCALE,
2284
			gettext_noop("Sets the server (database) character set encoding."),
2285
			NULL,
2286
			GUC_IS_NAME | GUC_REPORT | GUC_NOT_IN_SAMPLE | GUC_DISALLOW_IN_FILE
2287
		},
2288 2289 2290 2291 2292
		&server_encoding_string,
		"SQL_ASCII", NULL, NULL
	},

	{
2293
		/* Can't be set in postgresql.conf */
2294
		{"server_version", PGC_INTERNAL, PRESET_OPTIONS,
2295
			gettext_noop("Shows the server version."),
2296 2297 2298
			NULL,
			GUC_REPORT | GUC_NOT_IN_SAMPLE | GUC_DISALLOW_IN_FILE
		},
2299 2300
		&server_version_string,
		PG_VERSION, NULL, NULL
2301 2302
	},

2303 2304 2305 2306 2307
	{
		/* Not for general use --- used by SET ROLE */
		{"role", PGC_USERSET, UNGROUPED,
			gettext_noop("Sets the current role."),
			NULL,
2308
			GUC_IS_NAME | GUC_NO_SHOW_ALL | GUC_NO_RESET_ALL | GUC_NOT_IN_SAMPLE | GUC_DISALLOW_IN_FILE
2309 2310 2311 2312 2313
		},
		&role_string,
		"none", assign_role, show_role
	},

2314
	{
2315 2316
		/* Not for general use --- used by SET SESSION AUTHORIZATION */
		{"session_authorization", PGC_USERSET, UNGROUPED,
2317
			gettext_noop("Sets the session user name."),
2318
			NULL,
2319
			GUC_IS_NAME | GUC_REPORT | GUC_NO_SHOW_ALL | GUC_NO_RESET_ALL | GUC_NOT_IN_SAMPLE | GUC_DISALLOW_IN_FILE
2320
		},
2321 2322
		&session_authorization_string,
		NULL, assign_session_authorization, show_session_authorization
2323 2324
	},

2325
	{
2326
		{"log_destination", PGC_SIGHUP, LOGGING_WHERE,
B
Bruce Momjian 已提交
2327
			gettext_noop("Sets the destination for server log output."),
2328 2329 2330
			gettext_noop("Valid values are combinations of \"stderr\", "
						 "\"syslog\", \"csvlog\", and \"eventlog\", "
						 "depending on the platform."),
B
Bruce Momjian 已提交
2331
			GUC_LIST_INPUT
2332 2333 2334 2335
		},
		&log_destination_string,
		"stderr", assign_log_destination, NULL
	},
2336 2337
	{
		{"log_directory", PGC_SIGHUP, LOGGING_WHERE,
2338
			gettext_noop("Sets the destination directory for log files."),
2339
			gettext_noop("Can be specified as relative to the data directory "
2340 2341
						 "or as absolute path."),
			GUC_SUPERUSER_ONLY
2342 2343
		},
		&Log_directory,
2344
		"pg_log", assign_canonical_path, NULL
2345 2346
	},
	{
2347 2348
		{"log_filename", PGC_SIGHUP, LOGGING_WHERE,
			gettext_noop("Sets the file name pattern for log files."),
2349 2350
			NULL,
			GUC_SUPERUSER_ONLY
2351
		},
2352 2353
		&Log_filename,
		"postgresql-%Y-%m-%d_%H%M%S.log", NULL, NULL
2354
	},
2355

T
Tatsuo Ishii 已提交
2356
#ifdef HAVE_SYSLOG
2357
	{
2358 2359 2360
		{"syslog_ident", PGC_SIGHUP, LOGGING_WHERE,
			gettext_noop("Sets the program name used to identify PostgreSQL "
						 "messages in syslog."),
2361 2362
			NULL
		},
2363 2364
		&syslog_ident_str,
		"postgres", assign_syslog_ident, NULL
2365
	},
2366
#endif
2367

2368
	{
2369
		{"TimeZone", PGC_USERSET, CLIENT_CONN_LOCALE,
2370
			gettext_noop("Sets the time zone for displaying and interpreting time stamps."),
2371 2372
			NULL,
			GUC_REPORT
2373 2374
		},
		&timezone_string,
2375 2376
		"UNKNOWN", assign_timezone, show_timezone
	},
2377 2378
	{
		{"timezone_abbreviations", PGC_USERSET, CLIENT_CONN_LOCALE,
2379
			gettext_noop("Selects a file of time zone abbreviations."),
2380
			NULL
2381
		},
2382 2383
		&timezone_abbreviations_string,
		"UNKNOWN", assign_timezone_abbreviations, NULL
2384
	},
2385 2386

	{
2387
		{"transaction_isolation", PGC_USERSET, CLIENT_CONN_STATEMENT,
2388
			gettext_noop("Sets the current transaction's isolation level."),
2389 2390 2391
			NULL,
			GUC_NO_RESET_ALL | GUC_NOT_IN_SAMPLE | GUC_DISALLOW_IN_FILE
		},
2392 2393 2394 2395 2396
		&XactIsoLevel_string,
		NULL, assign_XactIsoLevel, show_XactIsoLevel
	},

	{
2397
		{"unix_socket_group", PGC_POSTMASTER, CONN_AUTH_SETTINGS,
2398
			gettext_noop("Sets the owning group of the Unix-domain socket."),
2399 2400
			gettext_noop("The owning user of the socket is always the user "
						 "that starts the server.")
2401 2402
		},
		&Unix_socket_group,
2403
		"", NULL, NULL
2404
	},
2405

2406
	{
2407
		{"unix_socket_directory", PGC_POSTMASTER, CONN_AUTH_SETTINGS,
2408
			gettext_noop("Sets the directory where the Unix-domain socket will be created."),
2409 2410
			NULL,
			GUC_SUPERUSER_ONLY
2411 2412
		},
		&UnixSocketDir,
2413
		"", assign_canonical_path, NULL
2414
	},
2415

2416
	{
2417
		{"listen_addresses", PGC_POSTMASTER, CONN_AUTH_SETTINGS,
2418 2419 2420
			gettext_noop("Sets the host name or IP address(es) to listen to."),
			NULL,
			GUC_LIST_INPUT
2421
		},
2422 2423
		&ListenAddresses,
		"localhost", NULL, NULL
2424
	},
2425

2426
	{
2427
		{"custom_variable_classes", PGC_SIGHUP, CUSTOM_OPTIONS,
2428
			gettext_noop("Sets the list of known custom variable classes."),
2429 2430 2431 2432 2433 2434 2435
			NULL,
			GUC_LIST_INPUT | GUC_LIST_QUOTE
		},
		&custom_variable_classes,
		NULL, assign_custom_variable_classes, NULL
	},

2436
	{
2437
		{"data_directory", PGC_POSTMASTER, FILE_LOCATIONS,
B
Bruce Momjian 已提交
2438 2439 2440
			gettext_noop("Sets the server's data directory."),
			NULL,
			GUC_SUPERUSER_ONLY
2441
		},
2442 2443
		&data_directory,
		NULL, NULL, NULL
2444 2445 2446
	},

	{
2447
		{"config_file", PGC_POSTMASTER, FILE_LOCATIONS,
B
Bruce Momjian 已提交
2448 2449 2450
			gettext_noop("Sets the server's main configuration file."),
			NULL,
			GUC_DISALLOW_IN_FILE | GUC_SUPERUSER_ONLY
2451 2452 2453 2454 2455 2456 2457
		},
		&ConfigFileName,
		NULL, NULL, NULL
	},

	{
		{"hba_file", PGC_POSTMASTER, FILE_LOCATIONS,
2458
			gettext_noop("Sets the server's \"hba\" configuration file."),
B
Bruce Momjian 已提交
2459 2460
			NULL,
			GUC_SUPERUSER_ONLY
2461
		},
2462 2463
		&HbaFileName,
		NULL, NULL, NULL
2464 2465 2466
	},

	{
2467
		{"ident_file", PGC_POSTMASTER, FILE_LOCATIONS,
2468
			gettext_noop("Sets the server's \"ident\" configuration file."),
B
Bruce Momjian 已提交
2469 2470
			NULL,
			GUC_SUPERUSER_ONLY
2471
		},
2472 2473
		&IdentFileName,
		NULL, NULL, NULL
2474 2475 2476
	},

	{
2477
		{"external_pid_file", PGC_POSTMASTER, FILE_LOCATIONS,
B
Bruce Momjian 已提交
2478 2479 2480
			gettext_noop("Writes the postmaster PID to the specified file."),
			NULL,
			GUC_SUPERUSER_ONLY
2481
		},
2482
		&external_pid_file,
2483
		NULL, assign_canonical_path, NULL
2484 2485
	},

2486
	{
2487
		{"stats_temp_directory", PGC_SIGHUP, STATS_COLLECTOR,
2488 2489 2490 2491 2492 2493 2494 2495
			gettext_noop("Writes temporary statistics files to the specified directory."),
			NULL,
			GUC_SUPERUSER_ONLY
		},
		&pgstat_temp_directory,
		"pg_stat_tmp", assign_pgstat_temp_directory, NULL
	},

2496 2497 2498 2499 2500 2501 2502 2503 2504
	{
		{"default_text_search_config", PGC_USERSET, CLIENT_CONN_LOCALE,
			gettext_noop("Sets default text search configuration."),
			NULL
		},
		&TSCurrentConfig,
		"pg_catalog.simple", assignTSCurrentConfig, NULL
	},

T
Tom Lane 已提交
2505
#ifdef USE_SSL
B
Bruce Momjian 已提交
2506 2507 2508 2509 2510 2511 2512 2513 2514
	{
		{"ssl_ciphers", PGC_POSTMASTER, CONN_AUTH_SECURITY,
			gettext_noop("Sets the list of allowed SSL ciphers."),
			NULL,
			GUC_SUPERUSER_ONLY
		},
		&SSLCipherSuites,
		"ALL:!ADH:!LOW:!EXP:!MD5:@STRENGTH", NULL, NULL
	},
B
Bruce Momjian 已提交
2515
#endif   /* USE_SSL */
T
Tom Lane 已提交
2516

2517
	/* End-of-list marker */
2518
	{
2519
		{NULL, 0, 0, NULL, NULL}, NULL, NULL, NULL, NULL
2520
	}
2521 2522 2523
};


2524 2525
static struct config_enum ConfigureNamesEnum[] =
{
2526 2527 2528
	{
		{"backslash_quote", PGC_USERSET, COMPAT_OPTIONS_PREVIOUS,
			gettext_noop("Sets whether \"\\'\" is allowed in string literals."),
2529
			NULL
2530 2531 2532 2533 2534
		},
		&backslash_quote,
		BACKSLASH_QUOTE_SAFE_ENCODING, backslash_quote_options, NULL, NULL
	},

2535 2536 2537
	{
		{"client_min_messages", PGC_USERSET, LOGGING_WHEN,
			gettext_noop("Sets the message levels that are sent to the client."),
2538 2539
			gettext_noop("Each level includes all the levels that follow it. The later"
						 " the level, the fewer messages are sent.")
2540 2541
		},
		&client_min_messages,
2542
		NOTICE, client_message_level_options, NULL, NULL
2543 2544
	},

2545 2546 2547 2548 2549 2550 2551 2552 2553 2554 2555
	{
		{"constraint_exclusion", PGC_USERSET, QUERY_TUNING_OTHER,
			gettext_noop("Enables the planner to use constraints to optimize queries."),
			gettext_noop("Table scans will be skipped if their constraints"
						 " guarantee that no rows match the query.")
		},
		&constraint_exclusion,
		CONSTRAINT_EXCLUSION_PARTITION, constraint_exclusion_options,
		NULL, NULL
	},

2556 2557 2558
	{
		{"default_transaction_isolation", PGC_USERSET, CLIENT_CONN_STATEMENT,
			gettext_noop("Sets the transaction isolation level of each new transaction."),
2559
			NULL
2560 2561 2562 2563 2564
		},
		&DefaultXactIsoLevel,
		XACT_READ_COMMITTED, isolation_level_options, NULL, NULL
	},

2565 2566 2567 2568 2569 2570 2571 2572 2573 2574
 	{
		{"IntervalStyle", PGC_USERSET, CLIENT_CONN_LOCALE,
			gettext_noop("Sets the display format for interval values."),
			NULL,
			GUC_REPORT
		},
		&IntervalStyle,
		INTSTYLE_POSTGRES, intervalstyle_options, NULL, NULL
	},

2575 2576 2577
	{
		{"log_error_verbosity", PGC_SUSET, LOGGING_WHEN,
			gettext_noop("Sets the verbosity of logged messages."),
2578
			NULL
2579 2580 2581 2582 2583 2584 2585 2586
		},
		&Log_error_verbosity,
		PGERROR_DEFAULT, log_error_verbosity_options, NULL, NULL
	},

	{
		{"log_min_messages", PGC_SUSET, LOGGING_WHEN,
			gettext_noop("Sets the message levels that are logged."),
2587 2588
			gettext_noop("Each level includes all the levels that follow it. The later"
						 " the level, the fewer messages are sent.")
2589 2590
		},
		&log_min_messages,
2591
		WARNING, server_message_level_options, NULL, NULL
2592 2593 2594 2595 2596
	},

	{
		{"log_min_error_statement", PGC_SUSET, LOGGING_WHEN,
			gettext_noop("Causes all statements generating error at or above this level to be logged."),
2597 2598
			gettext_noop("Each level includes all the levels that follow it. The later"
						 " the level, the fewer messages are sent.")
2599 2600
		},
		&log_min_error_statement,
2601
		ERROR, server_message_level_options, NULL, NULL
2602 2603 2604 2605 2606
	},

	{
		{"log_statement", PGC_SUSET, LOGGING_WHAT,
			gettext_noop("Sets the type of statements logged."),
2607
			NULL
2608 2609 2610 2611 2612
		},
		&log_statement,
		LOGSTMT_NONE, log_statement_options, NULL, NULL
	},

2613 2614 2615 2616
#ifdef HAVE_SYSLOG
	{
		{"syslog_facility", PGC_SIGHUP, LOGGING_WHERE,
			gettext_noop("Sets the syslog \"facility\" to be used when syslog enabled."),
2617
			NULL
2618 2619 2620 2621 2622 2623
		},
		&syslog_facility,
		LOG_LOCAL0, syslog_facility_options, assign_syslog_facility, NULL
	},
#endif

2624 2625 2626
	{
		{"regex_flavor", PGC_USERSET, COMPAT_OPTIONS_PREVIOUS,
			gettext_noop("Sets the regular expression \"flavor\"."),
2627
			NULL
2628 2629 2630 2631
		},
		&regex_flavor,
		REG_ADVANCED, regex_flavor_options, NULL, NULL
	},
2632

2633 2634 2635
	{
		{"session_replication_role", PGC_SUSET, CLIENT_CONN_STATEMENT,
			gettext_noop("Sets the session's behavior for triggers and rewrite rules."),
2636
			NULL
2637 2638 2639 2640 2641
		},
		&SessionReplicationRole,
		SESSION_REPLICATION_ROLE_ORIGIN, session_replication_role_options,
		assign_session_replication_role, NULL
	},
2642

2643 2644 2645
	{
		{"track_functions", PGC_SUSET, STATS_COLLECTOR,
			gettext_noop("Collects function-level statistics on database activity."),
2646
			NULL
2647 2648 2649 2650 2651
		},
		&pgstat_track_functions,
		TRACK_FUNC_OFF, track_function_options, NULL, NULL
	},

2652 2653 2654 2655 2656 2657 2658 2659 2660 2661
	{
		{"wal_sync_method", PGC_SIGHUP, WAL_SETTINGS,
			gettext_noop("Selects the method used for forcing WAL updates to disk."),
			NULL
		},
		&sync_method,
		DEFAULT_SYNC_METHOD, sync_method_options, 
		assign_xlog_sync_method, NULL
	},

2662 2663 2664
	{
		{"xmlbinary", PGC_USERSET, CLIENT_CONN_STATEMENT,
			gettext_noop("Sets how binary values are to be encoded in XML."),
2665
			NULL
2666 2667 2668 2669 2670 2671 2672 2673 2674
		},
		&xmlbinary,
		XMLBINARY_BASE64, xmlbinary_options, NULL, NULL
	},

	{
		{"xmloption", PGC_USERSET, CLIENT_CONN_STATEMENT,
			gettext_noop("Sets whether XML data in implicit parsing and serialization "
						 "operations is to be considered as documents or content fragments."),
2675
			NULL
2676 2677 2678 2679 2680
		},
		&xmloption,
		XMLOPTION_CONTENT, xmloption_options, NULL, NULL
	},

2681 2682 2683 2684 2685 2686 2687

	/* End-of-list marker */
	{
		{NULL, 0, 0, NULL, NULL}, NULL, 0, NULL, NULL, NULL
	}
};

2688
/******** end of options list ********/
2689

B
Bruce Momjian 已提交
2690

2691 2692 2693 2694 2695 2696
/*
 * To allow continued support of obsolete names for GUC variables, we apply
 * the following mappings to any unrecognized name.  Note that an old name
 * should be mapped to a new one only if the new variable has very similar
 * semantics to the old.
 */
B
Bruce Momjian 已提交
2697
static const char *const map_old_guc_names[] = {
2698 2699 2700 2701 2702 2703
	"sort_mem", "work_mem",
	"vacuum_mem", "maintenance_work_mem",
	NULL
};


2704
/*
2705
 * Actual lookup of variables is done through this single, sorted array.
2706
 */
2707 2708
static struct config_generic **guc_variables;

2709
/* Current number of variables contained in the vector */
B
Bruce Momjian 已提交
2710
static int	num_guc_variables;
2711

2712
/* Vector capacity */
B
Bruce Momjian 已提交
2713
static int	size_guc_variables;
2714

2715

2716
static bool guc_dirty;			/* TRUE if need to do commit/abort work */
2717

2718 2719
static bool reporting_enabled;	/* TRUE to enable GUC_REPORT */

2720 2721
static int	GUCNestLevel = 0;	/* 1 when in main transaction */

2722

B
Bruce Momjian 已提交
2723
static int	guc_var_compare(const void *a, const void *b);
2724
static int	guc_name_compare(const char *namea, const char *nameb);
2725
static void InitializeOneGUCOption(struct config_generic *gconf);
2726
static void push_old_value(struct config_generic * gconf, GucAction action);
2727
static void ReportGUCOption(struct config_generic * record);
2728 2729
static void ShowGUCConfigOption(const char *name, DestReceiver *dest);
static void ShowAllGUCConfig(DestReceiver *dest);
2730
static char *_ShowOption(struct config_generic * record, bool use_units);
B
Bruce Momjian 已提交
2731
static bool is_newvalue_equal(struct config_generic * record, const char *newvalue);
2732

2733

2734 2735 2736 2737 2738 2739
/*
 * Some infrastructure for checking malloc/strdup/realloc calls
 */
static void *
guc_malloc(int elevel, size_t size)
{
B
Bruce Momjian 已提交
2740
	void	   *data;
2741 2742 2743 2744 2745 2746 2747 2748 2749 2750 2751 2752

	data = malloc(size);
	if (data == NULL)
		ereport(elevel,
				(errcode(ERRCODE_OUT_OF_MEMORY),
				 errmsg("out of memory")));
	return data;
}

static void *
guc_realloc(int elevel, void *old, size_t size)
{
B
Bruce Momjian 已提交
2753
	void	   *data;
2754 2755 2756 2757 2758 2759 2760 2761 2762 2763 2764 2765

	data = realloc(old, size);
	if (data == NULL)
		ereport(elevel,
				(errcode(ERRCODE_OUT_OF_MEMORY),
				 errmsg("out of memory")));
	return data;
}

static char *
guc_strdup(int elevel, const char *src)
{
B
Bruce Momjian 已提交
2766
	char	   *data;
2767 2768 2769 2770 2771 2772 2773 2774 2775 2776

	data = strdup(src);
	if (data == NULL)
		ereport(elevel,
				(errcode(ERRCODE_OUT_OF_MEMORY),
				 errmsg("out of memory")));
	return data;
}


2777 2778 2779 2780 2781 2782
/*
 * Support for assigning to a field of a string GUC item.  Free the prior
 * value if it's not referenced anywhere else in the item (including stacked
 * states).
 */
static void
2783
set_string_field(struct config_string * conf, char **field, char *newval)
2784
{
B
Bruce Momjian 已提交
2785 2786
	char	   *oldval = *field;
	GucStack   *stack;
2787 2788 2789 2790 2791 2792 2793 2794

	/* Do the assignment */
	*field = newval;

	/* Exit if any duplicate references, or if old value was NULL anyway */
	if (oldval == NULL ||
		oldval == *(conf->variable) ||
		oldval == conf->reset_val ||
2795
		oldval == conf->boot_val)
2796 2797 2798
		return;
	for (stack = conf->gen.stack; stack; stack = stack->prev)
	{
2799 2800
		if (oldval == stack->prior.stringval ||
			oldval == stack->masked.stringval)
2801 2802 2803 2804 2805 2806 2807 2808 2809 2810 2811
			return;
	}

	/* Not used anymore, so free it */
	free(oldval);
}

/*
 * Detect whether strval is referenced anywhere in a GUC string item
 */
static bool
B
Bruce Momjian 已提交
2812
string_field_used(struct config_string * conf, char *strval)
2813
{
B
Bruce Momjian 已提交
2814
	GucStack   *stack;
2815 2816 2817

	if (strval == *(conf->variable) ||
		strval == conf->reset_val ||
2818
		strval == conf->boot_val)
2819 2820 2821
		return true;
	for (stack = conf->gen.stack; stack; stack = stack->prev)
	{
2822 2823
		if (strval == stack->prior.stringval ||
			strval == stack->masked.stringval)
2824 2825 2826 2827 2828
			return true;
	}
	return false;
}

2829 2830 2831 2832 2833 2834 2835 2836 2837 2838 2839 2840 2841 2842 2843 2844 2845 2846 2847 2848 2849 2850 2851 2852 2853 2854
/*
 * Support for copying a variable's active value into a stack entry
 */
static void
set_stack_value(struct config_generic * gconf, union config_var_value * val)
{
	switch (gconf->vartype)
	{
		case PGC_BOOL:
			val->boolval =
				*((struct config_bool *) gconf)->variable;
			break;
		case PGC_INT:
			val->intval =
				*((struct config_int *) gconf)->variable;
			break;
		case PGC_REAL:
			val->realval =
				*((struct config_real *) gconf)->variable;
			break;
		case PGC_STRING:
			/* we assume stringval is NULL if not valid */
			set_string_field((struct config_string *) gconf,
							 &(val->stringval),
							 *((struct config_string *) gconf)->variable);
			break;
2855 2856 2857 2858
		case PGC_ENUM:
			val->enumval = 
				*((struct config_enum *) gconf)->variable;
			break;
2859 2860 2861 2862 2863 2864 2865
	}
}

/*
 * Support for discarding a no-longer-needed value in a stack entry
 */
static void
B
Bruce Momjian 已提交
2866
discard_stack_value(struct config_generic * gconf, union config_var_value * val)
2867 2868 2869 2870 2871 2872
{
	switch (gconf->vartype)
	{
		case PGC_BOOL:
		case PGC_INT:
		case PGC_REAL:
2873
		case PGC_ENUM:
2874 2875 2876 2877 2878 2879 2880 2881 2882 2883
			/* no need to do anything */
			break;
		case PGC_STRING:
			set_string_field((struct config_string *) gconf,
							 &(val->stringval),
							 NULL);
			break;
	}
}

2884

2885 2886 2887
/*
 * Fetch the sorted array pointer (exported for help_config.c's use ONLY)
 */
2888 2889
struct config_generic **
get_guc_variables(void)
2890 2891 2892
{
	return guc_variables;
}
2893

2894

2895
/*
B
Bruce Momjian 已提交
2896
 * Build the sorted array.	This is split out so that it could be
2897 2898
 * re-executed after startup (eg, we could allow loadable modules to
 * add vars, and then we'd need to re-sort).
2899
 */
2900
void
2901
build_guc_variables(void)
2902
{
B
Bruce Momjian 已提交
2903
	int			size_vars;
2904 2905
	int			num_vars = 0;
	struct config_generic **guc_vars;
B
Bruce Momjian 已提交
2906
	int			i;
2907

2908
	for (i = 0; ConfigureNamesBool[i].gen.name; i++)
2909 2910 2911
	{
		struct config_bool *conf = &ConfigureNamesBool[i];

2912 2913 2914
		/* Rather than requiring vartype to be filled in by hand, do this: */
		conf->gen.vartype = PGC_BOOL;
		num_vars++;
2915
	}
2916

2917
	for (i = 0; ConfigureNamesInt[i].gen.name; i++)
2918 2919 2920
	{
		struct config_int *conf = &ConfigureNamesInt[i];

2921 2922
		conf->gen.vartype = PGC_INT;
		num_vars++;
2923
	}
2924

2925
	for (i = 0; ConfigureNamesReal[i].gen.name; i++)
2926 2927 2928
	{
		struct config_real *conf = &ConfigureNamesReal[i];

2929 2930
		conf->gen.vartype = PGC_REAL;
		num_vars++;
2931
	}
2932

2933
	for (i = 0; ConfigureNamesString[i].gen.name; i++)
2934
	{
2935
		struct config_string *conf = &ConfigureNamesString[i];
2936

2937 2938
		conf->gen.vartype = PGC_STRING;
		num_vars++;
2939 2940
	}

2941 2942 2943 2944 2945 2946 2947 2948
	for (i = 0; ConfigureNamesEnum[i].gen.name; i++)
	{
		struct config_enum *conf = &ConfigureNamesEnum[i];

		conf->gen.vartype = PGC_ENUM;
		num_vars++;
	}

B
Bruce Momjian 已提交
2949 2950
	/*
	 * Create table with 20% slack
2951 2952 2953
	 */
	size_vars = num_vars + num_vars / 4;

2954
	guc_vars = (struct config_generic **)
2955
		guc_malloc(FATAL, size_vars * sizeof(struct config_generic *));
2956

2957
	num_vars = 0;
2958

2959
	for (i = 0; ConfigureNamesBool[i].gen.name; i++)
B
Bruce Momjian 已提交
2960
		guc_vars[num_vars++] = &ConfigureNamesBool[i].gen;
2961

2962
	for (i = 0; ConfigureNamesInt[i].gen.name; i++)
B
Bruce Momjian 已提交
2963
		guc_vars[num_vars++] = &ConfigureNamesInt[i].gen;
2964

2965
	for (i = 0; ConfigureNamesReal[i].gen.name; i++)
B
Bruce Momjian 已提交
2966
		guc_vars[num_vars++] = &ConfigureNamesReal[i].gen;
2967

2968
	for (i = 0; ConfigureNamesString[i].gen.name; i++)
B
Bruce Momjian 已提交
2969
		guc_vars[num_vars++] = &ConfigureNamesString[i].gen;
2970

2971 2972 2973
	for (i = 0; ConfigureNamesEnum[i].gen.name; i++)
		guc_vars[num_vars++] = &ConfigureNamesEnum[i].gen;

2974 2975 2976 2977
	if (guc_variables)
		free(guc_variables);
	guc_variables = guc_vars;
	num_guc_variables = num_vars;
2978
	size_guc_variables = size_vars;
B
Bruce Momjian 已提交
2979 2980
	qsort((void *) guc_variables, num_guc_variables,
		  sizeof(struct config_generic *), guc_var_compare);
2981 2982
}

2983 2984 2985 2986
/*
 * Add a new GUC variable to the list of known variables. The
 * list is expanded if needed.
 */
2987
static bool
B
Bruce Momjian 已提交
2988
add_guc_variable(struct config_generic * var, int elevel)
2989
{
B
Bruce Momjian 已提交
2990
	if (num_guc_variables + 1 >= size_guc_variables)
2991
	{
B
Bruce Momjian 已提交
2992 2993
		/*
		 * Increase the vector by 25%
2994
		 */
B
Bruce Momjian 已提交
2995 2996
		int			size_vars = size_guc_variables + size_guc_variables / 4;
		struct config_generic **guc_vars;
2997

B
Bruce Momjian 已提交
2998
		if (size_vars == 0)
2999
		{
3000
			size_vars = 100;
B
Bruce Momjian 已提交
3001 3002
			guc_vars = (struct config_generic **)
				guc_malloc(elevel, size_vars * sizeof(struct config_generic *));
3003 3004
		}
		else
3005
		{
B
Bruce Momjian 已提交
3006 3007
			guc_vars = (struct config_generic **)
				guc_realloc(elevel, guc_variables, size_vars * sizeof(struct config_generic *));
3008 3009
		}

B
Bruce Momjian 已提交
3010
		if (guc_vars == NULL)
3011 3012
			return false;		/* out of memory */

3013 3014 3015 3016
		guc_variables = guc_vars;
		size_guc_variables = size_vars;
	}
	guc_variables[num_guc_variables++] = var;
B
Bruce Momjian 已提交
3017 3018
	qsort((void *) guc_variables, num_guc_variables,
		  sizeof(struct config_generic *), guc_var_compare);
3019
	return true;
3020 3021 3022
}

/*
3023
 * Create and add a placeholder variable. It's presumed to belong
3024 3025
 * to a valid custom variable class at this point.
 */
3026
static struct config_generic *
3027
add_placeholder_variable(const char *name, int elevel)
3028
{
B
Bruce Momjian 已提交
3029 3030 3031
	size_t		sz = sizeof(struct config_string) + sizeof(char *);
	struct config_string *var;
	struct config_generic *gen;
3032

B
Bruce Momjian 已提交
3033 3034
	var = (struct config_string *) guc_malloc(elevel, sz);
	if (var == NULL)
3035
		return NULL;
3036
	memset(var, 0, sz);
3037
	gen = &var->gen;
3038

3039 3040
	gen->name = guc_strdup(elevel, name);
	if (gen->name == NULL)
3041 3042 3043 3044 3045
	{
		free(var);
		return NULL;
	}

B
Bruce Momjian 已提交
3046 3047
	gen->context = PGC_USERSET;
	gen->group = CUSTOM_OPTIONS;
3048
	gen->short_desc = "GUC placeholder variable";
B
Bruce Momjian 已提交
3049 3050
	gen->flags = GUC_NO_SHOW_ALL | GUC_NOT_IN_SAMPLE | GUC_CUSTOM_PLACEHOLDER;
	gen->vartype = PGC_STRING;
3051

B
Bruce Momjian 已提交
3052 3053
	/*
	 * The char* is allocated at the end of the struct since we have no
B
Bruce Momjian 已提交
3054 3055
	 * 'static' place to point to.	Note that the current value, as well as
	 * the boot and reset values, start out NULL.
B
Bruce Momjian 已提交
3056 3057
	 */
	var->variable = (char **) (var + 1);
3058

B
Bruce Momjian 已提交
3059
	if (!add_guc_variable((struct config_generic *) var, elevel))
3060 3061 3062 3063 3064 3065
	{
		free((void *) gen->name);
		free(var);
		return NULL;
	}

3066 3067 3068 3069 3070 3071 3072 3073 3074 3075 3076 3077 3078 3079 3080 3081 3082 3083 3084 3085 3086 3087 3088 3089 3090 3091 3092 3093 3094 3095 3096 3097 3098 3099 3100 3101 3102
	return gen;
}

/*
 * Detect whether the portion of "name" before dotPos matches any custom
 * variable class name listed in custom_var_classes.  The latter must be
 * formatted the way that assign_custom_variable_classes does it, ie,
 * no whitespace.  NULL is valid for custom_var_classes.
 */
static bool
is_custom_class(const char *name, int dotPos, const char *custom_var_classes)
{
	bool		result = false;
	const char *ccs = custom_var_classes;

	if (ccs != NULL)
	{
		const char *start = ccs;

		for (;; ++ccs)
		{
			char		c = *ccs;

			if (c == '\0' || c == ',')
			{
				if (dotPos == ccs - start && strncmp(start, name, dotPos) == 0)
				{
					result = true;
					break;
				}
				if (c == '\0')
					break;
				start = ccs + 1;
			}
		}
	}
	return result;
3103
}
3104 3105

/*
3106 3107 3108
 * Look up option NAME.  If it exists, return a pointer to its record,
 * else return NULL.  If create_placeholders is TRUE, we'll create a
 * placeholder record for a valid-looking custom variable name.
3109
 */
3110
static struct config_generic *
3111
find_option(const char *name, bool create_placeholders, int elevel)
3112
{
3113 3114
	const char **key = &name;
	struct config_generic **res;
3115
	int			i;
3116

3117
	Assert(name);
3118

3119
	/*
B
Bruce Momjian 已提交
3120 3121
	 * By equating const char ** with struct config_generic *, we are assuming
	 * the name field is first in config_generic.
3122
	 */
B
Bruce Momjian 已提交
3123 3124 3125
	res = (struct config_generic **) bsearch((void *) &key,
											 (void *) guc_variables,
											 num_guc_variables,
B
Bruce Momjian 已提交
3126
											 sizeof(struct config_generic *),
B
Bruce Momjian 已提交
3127
											 guc_var_compare);
3128 3129
	if (res)
		return *res;
3130 3131

	/*
B
Bruce Momjian 已提交
3132 3133 3134
	 * See if the name is an obsolete name for a variable.	We assume that the
	 * set of supported old names is short enough that a brute-force search is
	 * the best way.
3135 3136 3137 3138
	 */
	for (i = 0; map_old_guc_names[i] != NULL; i += 2)
	{
		if (guc_name_compare(name, map_old_guc_names[i]) == 0)
3139
			return find_option(map_old_guc_names[i + 1], false, elevel);
3140 3141
	}

3142 3143 3144 3145 3146 3147 3148 3149 3150 3151 3152 3153
	if (create_placeholders)
	{
		/*
		 * Check if the name is qualified, and if so, check if the qualifier
		 * matches any custom variable class.  If so, add a placeholder.
		 */
		const char *dot = strchr(name, GUC_QUALIFIER_SEPARATOR);

		if (dot != NULL &&
			is_custom_class(name, dot - name, custom_variable_classes))
			return add_placeholder_variable(name, elevel);
	}
3154

3155
	/* Unknown name */
3156 3157
	return NULL;
}
3158 3159 3160


/*
3161
 * comparator for qsorting and bsearching guc_variables array
3162
 */
3163 3164
static int
guc_var_compare(const void *a, const void *b)
3165
{
3166 3167
	struct config_generic *confa = *(struct config_generic **) a;
	struct config_generic *confb = *(struct config_generic **) b;
3168

3169 3170 3171
	return guc_name_compare(confa->name, confb->name);
}

3172 3173 3174
/*
 * the bare comparison function for GUC names
 */
3175 3176 3177
static int
guc_name_compare(const char *namea, const char *nameb)
{
3178
	/*
B
Bruce Momjian 已提交
3179 3180 3181
	 * The temptation to use strcasecmp() here must be resisted, because the
	 * array ordering has to remain stable across setlocale() calls. So, build
	 * our own with a simple ASCII-only downcasing.
3182
	 */
3183 3184 3185 3186 3187 3188 3189 3190 3191 3192 3193
	while (*namea && *nameb)
	{
		char		cha = *namea++;
		char		chb = *nameb++;

		if (cha >= 'A' && cha <= 'Z')
			cha += 'a' - 'A';
		if (chb >= 'A' && chb <= 'Z')
			chb += 'a' - 'A';
		if (cha != chb)
			return cha - chb;
3194
	}
3195 3196 3197 3198 3199
	if (*namea)
		return 1;				/* a is longer */
	if (*nameb)
		return -1;				/* b is longer */
	return 0;
3200
}
3201 3202 3203


/*
3204
 * Initialize GUC options during program startup.
3205 3206 3207
 *
 * Note that we cannot read the config file yet, since we have not yet
 * processed command-line switches.
3208
 */
3209 3210
void
InitializeGUCOptions(void)
3211
{
3212 3213
	int			i;
	char	   *env;
3214
	long		stack_rlimit;
3215

3216
	/*
B
Bruce Momjian 已提交
3217 3218
	 * Before log_line_prefix could possibly receive a nonempty setting, make
	 * sure that timezone processing is minimally alive (see elog.c).
3219 3220 3221
	 */
	pg_timezone_pre_initialize();

3222 3223 3224 3225
	/*
	 * Build sorted array of all GUC variables.
	 */
	build_guc_variables();
3226

3227
	/*
3228 3229
	 * Load all variables with their compiled-in defaults, and initialize
	 * status fields as needed.
3230
	 */
3231
	for (i = 0; i < num_guc_variables; i++)
3232
	{
3233
		InitializeOneGUCOption(guc_variables[i]);
3234 3235 3236 3237
	}

	guc_dirty = false;

3238 3239
	reporting_enabled = false;

3240
	/*
3241
	 * Prevent any attempt to override the transaction modes from
3242 3243
	 * non-interactive sources.
	 */
3244 3245 3246
	SetConfigOption("transaction_isolation", "default",
					PGC_POSTMASTER, PGC_S_OVERRIDE);
	SetConfigOption("transaction_read_only", "no",
3247 3248 3249
					PGC_POSTMASTER, PGC_S_OVERRIDE);

	/*
B
Bruce Momjian 已提交
3250
	 * For historical reasons, some GUC parameters can receive defaults from
B
Bruce Momjian 已提交
3251
	 * environment variables.  Process those settings.	NB: if you add or
3252
	 * remove anything here, see also ProcessConfigFile().
3253 3254 3255 3256 3257 3258
	 */

	env = getenv("PGPORT");
	if (env != NULL)
		SetConfigOption("port", env, PGC_POSTMASTER, PGC_S_ENV_VAR);

3259 3260
	env = getenv("PGDATESTYLE");
	if (env != NULL)
3261 3262
		SetConfigOption("datestyle", env, PGC_POSTMASTER, PGC_S_ENV_VAR);

3263 3264
	env = getenv("PGCLIENTENCODING");
	if (env != NULL)
3265
		SetConfigOption("client_encoding", env, PGC_POSTMASTER, PGC_S_ENV_VAR);
3266 3267 3268 3269 3270 3271 3272 3273 3274

	/*
	 * rlimit isn't exactly an "environment variable", but it behaves about
	 * the same.  If we can identify the platform stack depth rlimit, increase
	 * default stack depth setting up to whatever is safe (but at most 2MB).
	 */
	stack_rlimit = get_stack_depth_rlimit();
	if (stack_rlimit > 0)
	{
B
Bruce Momjian 已提交
3275
		int			new_limit = (stack_rlimit - STACK_DEPTH_SLOP) / 1024L;
3276 3277 3278

		if (new_limit > 100)
		{
B
Bruce Momjian 已提交
3279
			char		limbuf[16];
3280 3281 3282 3283 3284 3285 3286

			new_limit = Min(new_limit, 2048);
			sprintf(limbuf, "%d", new_limit);
			SetConfigOption("max_stack_depth", limbuf,
							PGC_POSTMASTER, PGC_S_ENV_VAR);
		}
	}
3287 3288
}

3289 3290 3291 3292 3293 3294 3295 3296 3297 3298 3299 3300 3301 3302 3303 3304 3305 3306 3307 3308 3309 3310 3311 3312 3313 3314 3315 3316 3317 3318 3319 3320 3321 3322 3323 3324 3325 3326 3327 3328 3329 3330 3331 3332 3333 3334 3335 3336 3337 3338 3339 3340 3341 3342 3343 3344 3345 3346 3347 3348 3349 3350 3351 3352 3353 3354 3355 3356 3357 3358 3359 3360 3361 3362 3363 3364 3365 3366 3367 3368 3369 3370 3371 3372 3373 3374 3375 3376 3377 3378 3379 3380 3381 3382 3383 3384 3385 3386 3387 3388 3389 3390 3391 3392 3393 3394 3395 3396 3397 3398 3399 3400 3401
/*
 * Initialize one GUC option variable to its compiled-in default.
 */
static void
InitializeOneGUCOption(struct config_generic *gconf)
{
	gconf->status = 0;
	gconf->reset_source = PGC_S_DEFAULT;
	gconf->source = PGC_S_DEFAULT;
	gconf->stack = NULL;
	gconf->sourcefile = NULL;
	gconf->sourceline = 0;

	switch (gconf->vartype)
	{
		case PGC_BOOL:
		{
			struct config_bool *conf = (struct config_bool *) gconf;

			if (conf->assign_hook)
				if (!(*conf->assign_hook) (conf->boot_val, true,
										   PGC_S_DEFAULT))
					elog(FATAL, "failed to initialize %s to %d",
						 conf->gen.name, (int) conf->boot_val);
			*conf->variable = conf->reset_val = conf->boot_val;
			break;
		}
		case PGC_INT:
		{
			struct config_int *conf = (struct config_int *) gconf;

			Assert(conf->boot_val >= conf->min);
			Assert(conf->boot_val <= conf->max);
			if (conf->assign_hook)
				if (!(*conf->assign_hook) (conf->boot_val, true,
										   PGC_S_DEFAULT))
					elog(FATAL, "failed to initialize %s to %d",
						 conf->gen.name, conf->boot_val);
			*conf->variable = conf->reset_val = conf->boot_val;
			break;
		}
		case PGC_REAL:
		{
			struct config_real *conf = (struct config_real *) gconf;

			Assert(conf->boot_val >= conf->min);
			Assert(conf->boot_val <= conf->max);
			if (conf->assign_hook)
				if (!(*conf->assign_hook) (conf->boot_val, true,
										   PGC_S_DEFAULT))
					elog(FATAL, "failed to initialize %s to %g",
						 conf->gen.name, conf->boot_val);
			*conf->variable = conf->reset_val = conf->boot_val;
			break;
		}
		case PGC_STRING:
		{
			struct config_string *conf = (struct config_string *) gconf;
			char	   *str;

			*conf->variable = NULL;
			conf->reset_val = NULL;

			if (conf->boot_val == NULL)
			{
				/* leave the value NULL, do not call assign hook */
				break;
			}

			str = guc_strdup(FATAL, conf->boot_val);
			conf->reset_val = str;

			if (conf->assign_hook)
			{
				const char *newstr;

				newstr = (*conf->assign_hook) (str, true,
											   PGC_S_DEFAULT);
				if (newstr == NULL)
				{
					elog(FATAL, "failed to initialize %s to \"%s\"",
						 conf->gen.name, str);
				}
				else if (newstr != str)
				{
					free(str);

					/*
					 * See notes in set_config_option about casting
					 */
					str = (char *) newstr;
					conf->reset_val = str;
				}
			}
			*conf->variable = str;
			break;
		}
		case PGC_ENUM:
		{
			struct config_enum *conf = (struct config_enum *) gconf;

			if (conf->assign_hook)
				if (!(*conf->assign_hook) (conf->boot_val, true,
										   PGC_S_DEFAULT))
					elog(FATAL, "failed to initialize %s to %s",
						 conf->gen.name, 
						 config_enum_lookup_by_value(conf, conf->boot_val));
			*conf->variable = conf->reset_val = conf->boot_val;
			break;
		}
	}
}

3402

3403 3404 3405 3406 3407 3408 3409 3410 3411 3412 3413 3414 3415 3416
/*
 * Select the configuration files and data directory to be used, and
 * do the initial read of postgresql.conf.
 *
 * This is called after processing command-line switches.
 *		userDoption is the -D switch value if any (NULL if unspecified).
 *		progname is just for use in error messages.
 *
 * Returns true on success; on failure, prints a suitable error message
 * to stderr and returns false.
 */
bool
SelectConfigFiles(const char *userDoption, const char *progname)
{
3417 3418
	char	   *configdir;
	char	   *fname;
3419 3420
	struct stat stat_buf;

3421 3422 3423 3424 3425
	/* configdir is -D option, or $PGDATA if no -D */
	if (userDoption)
		configdir = make_absolute_path(userDoption);
	else
		configdir = make_absolute_path(getenv("PGDATA"));
3426 3427

	/*
3428
	 * Find the configuration file: if config_file was specified on the
B
Bruce Momjian 已提交
3429 3430 3431
	 * command line, use it, else use configdir/postgresql.conf.  In any case
	 * ensure the result is an absolute path, so that it will be interpreted
	 * the same way by future backends.
3432
	 */
3433 3434
	if (ConfigFileName)
		fname = make_absolute_path(ConfigFileName);
3435 3436 3437 3438 3439 3440 3441
	else if (configdir)
	{
		fname = guc_malloc(FATAL,
						   strlen(configdir) + strlen(CONFIG_FILENAME) + 2);
		sprintf(fname, "%s/%s", configdir, CONFIG_FILENAME);
	}
	else
3442
	{
3443
		write_stderr("%s does not know where to find the server configuration file.\n"
P
Peter Eisentraut 已提交
3444
					 "You must specify the --config-file or -D invocation "
3445 3446 3447
					 "option or set the PGDATA environment variable.\n",
					 progname);
		return false;
3448 3449
	}

3450
	/*
B
Bruce Momjian 已提交
3451 3452
	 * Set the ConfigFileName GUC variable to its final value, ensuring that
	 * it can't be overridden later.
3453 3454 3455 3456 3457 3458 3459
	 */
	SetConfigOption("config_file", fname, PGC_POSTMASTER, PGC_S_OVERRIDE);
	free(fname);

	/*
	 * Now read the config file for the first time.
	 */
3460 3461
	if (stat(ConfigFileName, &stat_buf) != 0)
	{
3462
		write_stderr("%s cannot access the server configuration file \"%s\": %s\n",
3463 3464 3465 3466 3467 3468 3469
					 progname, ConfigFileName, strerror(errno));
		return false;
	}

	ProcessConfigFile(PGC_POSTMASTER);

	/*
3470 3471
	 * If the data_directory GUC variable has been set, use that as DataDir;
	 * otherwise use configdir if set; else punt.
3472
	 *
3473 3474
	 * Note: SetDataDir will copy and absolute-ize its argument, so we don't
	 * have to.
3475
	 */
3476 3477 3478 3479
	if (data_directory)
		SetDataDir(data_directory);
	else if (configdir)
		SetDataDir(configdir);
3480 3481 3482
	else
	{
		write_stderr("%s does not know where to find the database system data.\n"
3483 3484 3485 3486 3487 3488 3489 3490 3491 3492 3493
					 "This can be specified as \"data_directory\" in \"%s\", "
					 "or by the -D invocation option, or by the "
					 "PGDATA environment variable.\n",
					 progname, ConfigFileName);
		return false;
	}

	/*
	 * Reflect the final DataDir value back into the data_directory GUC var.
	 * (If you are wondering why we don't just make them a single variable,
	 * it's because the EXEC_BACKEND case needs DataDir to be transmitted to
B
Bruce Momjian 已提交
3494 3495 3496
	 * child backends specially.  XXX is that still true?  Given that we now
	 * chdir to DataDir, EXEC_BACKEND can read the config file without knowing
	 * DataDir in advance.)
3497 3498 3499 3500 3501 3502 3503 3504
	 */
	SetConfigOption("data_directory", DataDir, PGC_POSTMASTER, PGC_S_OVERRIDE);

	/*
	 * Figure out where pg_hba.conf is, and make sure the path is absolute.
	 */
	if (HbaFileName)
		fname = make_absolute_path(HbaFileName);
3505 3506 3507 3508 3509 3510 3511
	else if (configdir)
	{
		fname = guc_malloc(FATAL,
						   strlen(configdir) + strlen(HBA_FILENAME) + 2);
		sprintf(fname, "%s/%s", configdir, HBA_FILENAME);
	}
	else
3512 3513 3514 3515 3516
	{
		write_stderr("%s does not know where to find the \"hba\" configuration file.\n"
					 "This can be specified as \"hba_file\" in \"%s\", "
					 "or by the -D invocation option, or by the "
					 "PGDATA environment variable.\n",
3517 3518 3519
					 progname, ConfigFileName);
		return false;
	}
3520 3521
	SetConfigOption("hba_file", fname, PGC_POSTMASTER, PGC_S_OVERRIDE);
	free(fname);
3522 3523

	/*
3524
	 * Likewise for pg_ident.conf.
3525
	 */
3526 3527
	if (IdentFileName)
		fname = make_absolute_path(IdentFileName);
3528 3529 3530 3531 3532 3533 3534
	else if (configdir)
	{
		fname = guc_malloc(FATAL,
						   strlen(configdir) + strlen(IDENT_FILENAME) + 2);
		sprintf(fname, "%s/%s", configdir, IDENT_FILENAME);
	}
	else
3535 3536 3537 3538 3539 3540 3541 3542 3543 3544 3545 3546
	{
		write_stderr("%s does not know where to find the \"ident\" configuration file.\n"
					 "This can be specified as \"ident_file\" in \"%s\", "
					 "or by the -D invocation option, or by the "
					 "PGDATA environment variable.\n",
					 progname, ConfigFileName);
		return false;
	}
	SetConfigOption("ident_file", fname, PGC_POSTMASTER, PGC_S_OVERRIDE);
	free(fname);

	free(configdir);
3547 3548 3549 3550 3551

	return true;
}


3552 3553 3554 3555 3556 3557 3558 3559 3560 3561 3562 3563 3564
/*
 * Reset all options to their saved default values (implements RESET ALL)
 */
void
ResetAllOptions(void)
{
	int			i;

	for (i = 0; i < num_guc_variables; i++)
	{
		struct config_generic *gconf = guc_variables[i];

		/* Don't reset non-SET-able values */
3565 3566
		if (gconf->context != PGC_SUSET &&
			gconf->context != PGC_USERSET)
3567 3568 3569 3570 3571 3572 3573 3574
			continue;
		/* Don't reset if special exclusion from RESET ALL */
		if (gconf->flags & GUC_NO_RESET_ALL)
			continue;
		/* No need to reset if wasn't SET */
		if (gconf->source <= PGC_S_OVERRIDE)
			continue;

3575
		/* Save old value to support transaction abort */
3576
		push_old_value(gconf, GUC_ACTION_SET);
3577

3578 3579 3580
		switch (gconf->vartype)
		{
			case PGC_BOOL:
B
Bruce Momjian 已提交
3581 3582
				{
					struct config_bool *conf = (struct config_bool *) gconf;
3583

B
Bruce Momjian 已提交
3584
					if (conf->assign_hook)
3585 3586
						if (!(*conf->assign_hook) (conf->reset_val, true,
												   PGC_S_SESSION))
3587 3588
							elog(ERROR, "failed to reset %s to %d",
								 conf->gen.name, (int) conf->reset_val);
B
Bruce Momjian 已提交
3589 3590 3591
					*conf->variable = conf->reset_val;
					break;
				}
3592
			case PGC_INT:
B
Bruce Momjian 已提交
3593 3594
				{
					struct config_int *conf = (struct config_int *) gconf;
3595

B
Bruce Momjian 已提交
3596
					if (conf->assign_hook)
3597 3598
						if (!(*conf->assign_hook) (conf->reset_val, true,
												   PGC_S_SESSION))
3599 3600
							elog(ERROR, "failed to reset %s to %d",
								 conf->gen.name, conf->reset_val);
B
Bruce Momjian 已提交
3601 3602 3603
					*conf->variable = conf->reset_val;
					break;
				}
3604 3605
			case PGC_REAL:
				{
B
Bruce Momjian 已提交
3606 3607 3608
					struct config_real *conf = (struct config_real *) gconf;

					if (conf->assign_hook)
3609 3610
						if (!(*conf->assign_hook) (conf->reset_val, true,
												   PGC_S_SESSION))
3611 3612
							elog(ERROR, "failed to reset %s to %g",
								 conf->gen.name, conf->reset_val);
B
Bruce Momjian 已提交
3613
					*conf->variable = conf->reset_val;
3614 3615
					break;
				}
B
Bruce Momjian 已提交
3616 3617 3618 3619
			case PGC_STRING:
				{
					struct config_string *conf = (struct config_string *) gconf;
					char	   *str;
3620

B
Bruce Momjian 已提交
3621 3622
					/* We need not strdup here */
					str = conf->reset_val;
3623

3624
					if (conf->assign_hook && str)
3625
					{
B
Bruce Momjian 已提交
3626 3627
						const char *newstr;

3628 3629
						newstr = (*conf->assign_hook) (str, true,
													   PGC_S_SESSION);
B
Bruce Momjian 已提交
3630
						if (newstr == NULL)
3631 3632
							elog(ERROR, "failed to reset %s to \"%s\"",
								 conf->gen.name, str);
B
Bruce Momjian 已提交
3633 3634 3635
						else if (newstr != str)
						{
							/*
B
Bruce Momjian 已提交
3636
							 * See notes in set_config_option about casting
B
Bruce Momjian 已提交
3637 3638 3639
							 */
							str = (char *) newstr;
						}
3640 3641
					}

3642
					set_string_field(conf, conf->variable, str);
B
Bruce Momjian 已提交
3643 3644
					break;
				}
3645 3646 3647 3648 3649 3650 3651
			case PGC_ENUM:
				{
					struct config_enum *conf = (struct config_enum *) gconf;

					if (conf->assign_hook)
						if (!(*conf->assign_hook) (conf->reset_val, true,
												   PGC_S_SESSION))
3652 3653 3654
							elog(ERROR, "failed to reset %s to %s",
								 conf->gen.name,
								 config_enum_lookup_by_value(conf, conf->reset_val));
3655 3656 3657
					*conf->variable = conf->reset_val;
					break;
				}
3658
		}
3659

3660 3661
		gconf->source = gconf->reset_source;

3662 3663
		if (gconf->flags & GUC_REPORT)
			ReportGUCOption(gconf);
3664 3665 3666 3667 3668
	}
}


/*
3669
 * push_old_value
3670
 *		Push previous state during transactional assignment to a GUC variable.
3671 3672
 */
static void
3673
push_old_value(struct config_generic * gconf, GucAction action)
3674 3675 3676
{
	GucStack   *stack;

3677
	/* If we're not inside a nest level, do nothing */
3678
	if (GUCNestLevel == 0)
3679 3680
		return;

3681 3682 3683
	/* Do we already have a stack entry of the current nest level? */
	stack = gconf->stack;
	if (stack && stack->nest_level >= GUCNestLevel)
3684
	{
3685 3686 3687
		/* Yes, so adjust its state if necessary */
		Assert(stack->nest_level == GUCNestLevel);
		switch (action)
3688
		{
3689 3690 3691 3692 3693 3694 3695 3696
			case GUC_ACTION_SET:
				/* SET overrides any prior action at same nest level */
				if (stack->state == GUC_SET_LOCAL)
				{
					/* must discard old masked value */
					discard_stack_value(gconf, &stack->masked);
				}
				stack->state = GUC_SET;
3697
				break;
3698 3699 3700 3701 3702 3703 3704 3705
			case GUC_ACTION_LOCAL:
				if (stack->state == GUC_SET)
				{
					/* SET followed by SET LOCAL, remember SET's value */
					set_stack_value(gconf, &stack->masked);
					stack->state = GUC_SET_LOCAL;
				}
				/* in all other cases, no change to stack entry */
3706
				break;
3707 3708 3709
			case GUC_ACTION_SAVE:
				/* Could only have a prior SAVE of same variable */
				Assert(stack->state == GUC_SAVE);
3710 3711
				break;
		}
3712 3713 3714
		Assert(guc_dirty);		/* must be set already */
		return;
	}
3715

3716 3717 3718 3719 3720 3721 3722
	/*
	 * Push a new stack entry
	 *
	 * We keep all the stack entries in TopTransactionContext for simplicity.
	 */
	stack = (GucStack *) MemoryContextAllocZero(TopTransactionContext,
												sizeof(GucStack));
3723

3724 3725 3726 3727 3728 3729 3730 3731 3732 3733 3734 3735 3736
	stack->prev = gconf->stack;
	stack->nest_level = GUCNestLevel;
	switch (action)
	{
		case GUC_ACTION_SET:
			stack->state = GUC_SET;
			break;
		case GUC_ACTION_LOCAL:
			stack->state = GUC_LOCAL;
			break;
		case GUC_ACTION_SAVE:
			stack->state = GUC_SAVE;
			break;
3737
	}
3738 3739 3740 3741 3742 3743 3744
	stack->source = gconf->source;
	set_stack_value(gconf, &stack->prior);

	gconf->stack = stack;

	/* Ensure we remember to pop at end of xact */
	guc_dirty = true;
3745 3746
}

3747

3748
/*
3749
 * Do GUC processing at main transaction start.
3750 3751
 */
void
3752 3753 3754
AtStart_GUC(void)
{
	/*
B
Bruce Momjian 已提交
3755 3756 3757
	 * The nest level should be 0 between transactions; if it isn't, somebody
	 * didn't call AtEOXact_GUC, or called it with the wrong nestLevel.  We
	 * throw a warning but make no other effort to clean up.
3758 3759 3760 3761 3762 3763 3764 3765 3766
	 */
	if (GUCNestLevel != 0)
		elog(WARNING, "GUC nest level = %d at transaction start",
			 GUCNestLevel);
	GUCNestLevel = 1;
}

/*
 * Enter a new nesting level for GUC values.  This is called at subtransaction
B
Bruce Momjian 已提交
3767
 * start and when entering a function that has proconfig settings.	NOTE that
3768 3769 3770 3771 3772 3773 3774 3775 3776 3777 3778 3779 3780 3781 3782 3783 3784
 * we must not risk error here, else subtransaction start will be unhappy.
 */
int
NewGUCNestLevel(void)
{
	return ++GUCNestLevel;
}

/*
 * Do GUC processing at transaction or subtransaction commit or abort, or
 * when exiting a function that has proconfig settings.  (The name is thus
 * a bit of a misnomer; perhaps it should be ExitGUCNestLevel or some such.)
 * During abort, we discard all GUC settings that were applied at nesting
 * levels >= nestLevel.  nestLevel == 1 corresponds to the main transaction.
 */
void
AtEOXact_GUC(bool isCommit, int nestLevel)
3785
{
3786
	bool		still_dirty;
3787 3788
	int			i;

3789 3790
	Assert(nestLevel > 0 && nestLevel <= GUCNestLevel);

3791 3792
	/* Quick exit if nothing's changed in this transaction */
	if (!guc_dirty)
3793 3794
	{
		GUCNestLevel = nestLevel - 1;
3795
		return;
3796
	}
3797

3798
	still_dirty = false;
3799 3800 3801
	for (i = 0; i < num_guc_variables; i++)
	{
		struct config_generic *gconf = guc_variables[i];
3802
		GucStack   *stack;
3803

3804
		/*
B
Bruce Momjian 已提交
3805 3806 3807
		 * Process and pop each stack entry within the nest level.	To
		 * simplify fmgr_security_definer(), we allow failure exit from a
		 * function-with-SET-options to be recovered at the surrounding
3808 3809
		 * transaction or subtransaction abort; so there could be more than
		 * one stack entry to pop.
3810
		 */
3811 3812
		while ((stack = gconf->stack) != NULL &&
			   stack->nest_level >= nestLevel)
3813
		{
3814 3815 3816 3817
			GucStack   *prev = stack->prev;
			bool		restorePrior = false;
			bool		restoreMasked = false;
			bool		changed;
3818

3819 3820 3821 3822 3823 3824
			/*
			 * In this next bit, if we don't set either restorePrior or
			 * restoreMasked, we must "discard" any unwanted fields of the
			 * stack entries to avoid leaking memory.  If we do set one of
			 * those flags, unused fields will be cleaned up after restoring.
			 */
B
Bruce Momjian 已提交
3825
			if (!isCommit)		/* if abort, always restore prior value */
3826 3827 3828 3829 3830 3831 3832 3833 3834
				restorePrior = true;
			else if (stack->state == GUC_SAVE)
				restorePrior = true;
			else if (stack->nest_level == 1)
			{
				/* transaction commit */
				if (stack->state == GUC_SET_LOCAL)
					restoreMasked = true;
				else if (stack->state == GUC_SET)
3835
				{
3836 3837 3838
					/* we keep the current active value */
					discard_stack_value(gconf, &stack->prior);
				}
B
Bruce Momjian 已提交
3839
				else	/* must be GUC_LOCAL */
3840 3841 3842 3843 3844 3845 3846 3847 3848 3849 3850 3851
					restorePrior = true;
			}
			else if (prev == NULL ||
					 prev->nest_level < stack->nest_level - 1)
			{
				/* decrement entry's level and do not pop it */
				stack->nest_level--;
				continue;
			}
			else
			{
				/*
B
Bruce Momjian 已提交
3852 3853
				 * We have to merge this stack entry into prev. See README for
				 * discussion of this bit.
3854 3855 3856 3857
				 */
				switch (stack->state)
				{
					case GUC_SAVE:
B
Bruce Momjian 已提交
3858
						Assert(false);	/* can't get here */
3859 3860 3861 3862 3863 3864 3865 3866

					case GUC_SET:
						/* next level always becomes SET */
						discard_stack_value(gconf, &stack->prior);
						if (prev->state == GUC_SET_LOCAL)
							discard_stack_value(gconf, &prev->masked);
						prev->state = GUC_SET;
						break;
3867

3868 3869 3870 3871 3872 3873 3874 3875 3876 3877 3878 3879 3880
					case GUC_LOCAL:
						if (prev->state == GUC_SET)
						{
							/* LOCAL migrates down */
							prev->masked = stack->prior;
							prev->state = GUC_SET_LOCAL;
						}
						else
						{
							/* else just forget this stack level */
							discard_stack_value(gconf, &stack->prior);
						}
						break;
B
Bruce Momjian 已提交
3881

3882 3883 3884 3885 3886 3887 3888 3889 3890
					case GUC_SET_LOCAL:
						/* prior state at this level no longer wanted */
						discard_stack_value(gconf, &stack->prior);
						/* copy down the masked state */
						if (prev->state == GUC_SET_LOCAL)
							discard_stack_value(gconf, &prev->masked);
						prev->masked = stack->masked;
						prev->state = GUC_SET_LOCAL;
						break;
3891
				}
3892
			}
3893

3894
			changed = false;
B
Bruce Momjian 已提交
3895

3896 3897 3898 3899 3900 3901 3902 3903 3904 3905
			if (restorePrior || restoreMasked)
			{
				/* Perform appropriate restoration of the stacked value */
				union config_var_value newvalue;
				GucSource	newsource;

				if (restoreMasked)
				{
					newvalue = stack->masked;
					newsource = PGC_S_SESSION;
3906
				}
3907
				else
3908
				{
3909 3910 3911
					newvalue = stack->prior;
					newsource = stack->source;
				}
3912

3913 3914 3915 3916
				switch (gconf->vartype)
				{
					case PGC_BOOL:
						{
B
Bruce Momjian 已提交
3917 3918 3919 3920 3921 3922 3923 3924
							struct config_bool *conf = (struct config_bool *) gconf;
							bool		newval = newvalue.boolval;

							if (*conf->variable != newval)
							{
								if (conf->assign_hook)
									if (!(*conf->assign_hook) (newval,
													   true, PGC_S_OVERRIDE))
3925 3926
										elog(LOG, "failed to commit %s as %d",
											 conf->gen.name, (int) newval);
B
Bruce Momjian 已提交
3927 3928 3929 3930
								*conf->variable = newval;
								changed = true;
							}
							break;
3931 3932 3933
						}
					case PGC_INT:
						{
B
Bruce Momjian 已提交
3934 3935 3936 3937 3938 3939 3940 3941
							struct config_int *conf = (struct config_int *) gconf;
							int			newval = newvalue.intval;

							if (*conf->variable != newval)
							{
								if (conf->assign_hook)
									if (!(*conf->assign_hook) (newval,
													   true, PGC_S_OVERRIDE))
3942 3943
										elog(LOG, "failed to commit %s as %d",
											 conf->gen.name, newval);
B
Bruce Momjian 已提交
3944 3945 3946 3947
								*conf->variable = newval;
								changed = true;
							}
							break;
3948 3949 3950
						}
					case PGC_REAL:
						{
B
Bruce Momjian 已提交
3951 3952 3953 3954 3955 3956 3957 3958
							struct config_real *conf = (struct config_real *) gconf;
							double		newval = newvalue.realval;

							if (*conf->variable != newval)
							{
								if (conf->assign_hook)
									if (!(*conf->assign_hook) (newval,
													   true, PGC_S_OVERRIDE))
3959 3960
										elog(LOG, "failed to commit %s as %g",
											 conf->gen.name, newval);
B
Bruce Momjian 已提交
3961 3962 3963 3964
								*conf->variable = newval;
								changed = true;
							}
							break;
3965 3966
						}
					case PGC_STRING:
3967
						{
B
Bruce Momjian 已提交
3968 3969 3970 3971
							struct config_string *conf = (struct config_string *) gconf;
							char	   *newval = newvalue.stringval;

							if (*conf->variable != newval)
B
Bruce Momjian 已提交
3972
							{
B
Bruce Momjian 已提交
3973
								if (conf->assign_hook && newval)
3974
								{
B
Bruce Momjian 已提交
3975 3976 3977 3978 3979
									const char *newstr;

									newstr = (*conf->assign_hook) (newval, true,
															 PGC_S_OVERRIDE);
									if (newstr == NULL)
3980 3981
										elog(LOG, "failed to commit %s as \"%s\"",
											 conf->gen.name, newval);
B
Bruce Momjian 已提交
3982 3983 3984 3985 3986 3987 3988 3989 3990 3991 3992
									else if (newstr != newval)
									{
										/*
										 * If newval should now be freed,
										 * it'll be taken care of below.
										 *
										 * See notes in set_config_option
										 * about casting
										 */
										newval = (char *) newstr;
									}
3993
								}
B
Bruce Momjian 已提交
3994 3995 3996

								set_string_field(conf, conf->variable, newval);
								changed = true;
B
Bruce Momjian 已提交
3997
							}
3998

B
Bruce Momjian 已提交
3999 4000 4001 4002 4003 4004 4005 4006 4007
							/*
							 * Release stacked values if not used anymore. We
							 * could use discard_stack_value() here, but since
							 * we have type-specific code anyway, might as
							 * well inline it.
							 */
							set_string_field(conf, &stack->prior.stringval, NULL);
							set_string_field(conf, &stack->masked.stringval, NULL);
							break;
4008
						}
4009 4010 4011 4012 4013 4014 4015 4016 4017 4018
					case PGC_ENUM:
						{
							struct config_enum *conf = (struct config_enum *) gconf;
							int newval = newvalue.enumval;

							if (*conf->variable != newval)
							{
								if (conf->assign_hook)
									if (!(*conf->assign_hook) (newval,
															   true, PGC_S_OVERRIDE))
4019 4020 4021
										elog(LOG, "failed to commit %s as %s",
											 conf->gen.name,
											 config_enum_lookup_by_value(conf, newval));
4022 4023 4024 4025 4026
								*conf->variable = newval;
								changed = true;
							}
							break;
						}
4027
				}
4028

4029 4030
				gconf->source = newsource;
			}
4031

4032 4033 4034
			/* Finish popping the state stack */
			gconf->stack = prev;
			pfree(stack);
4035

4036 4037 4038
			/* Report new value if we changed it */
			if (changed && (gconf->flags & GUC_REPORT))
				ReportGUCOption(gconf);
B
Bruce Momjian 已提交
4039
		}						/* end of stack-popping loop */
4040 4041 4042

		if (stack != NULL)
			still_dirty = true;
4043 4044
	}

4045 4046
	/* If there are no remaining stack entries, we can reset guc_dirty */
	guc_dirty = still_dirty;
4047 4048 4049

	/* Update nesting level */
	GUCNestLevel = nestLevel - 1;
4050 4051 4052
}


4053 4054 4055 4056 4057 4058 4059 4060 4061 4062
/*
 * Start up automatic reporting of changes to variables marked GUC_REPORT.
 * This is executed at completion of backend startup.
 */
void
BeginReportingGUCOptions(void)
{
	int			i;

	/*
B
Bruce Momjian 已提交
4063 4064
	 * Don't do anything unless talking to an interactive frontend of protocol
	 * 3.0 or later.
4065
	 */
4066
	if (whereToSendOutput != DestRemote ||
4067 4068 4069 4070 4071 4072 4073 4074 4075 4076 4077 4078 4079 4080 4081 4082 4083 4084 4085
		PG_PROTOCOL_MAJOR(FrontendProtocol) < 3)
		return;

	reporting_enabled = true;

	/* Transmit initial values of interesting variables */
	for (i = 0; i < num_guc_variables; i++)
	{
		struct config_generic *conf = guc_variables[i];

		if (conf->flags & GUC_REPORT)
			ReportGUCOption(conf);
	}
}

/*
 * ReportGUCOption: if appropriate, transmit option value to frontend
 */
static void
4086
ReportGUCOption(struct config_generic * record)
4087 4088 4089
{
	if (reporting_enabled && (record->flags & GUC_REPORT))
	{
4090
		char	   *val = _ShowOption(record, false);
4091 4092 4093 4094 4095 4096 4097 4098 4099 4100 4101
		StringInfoData msgbuf;

		pq_beginmessage(&msgbuf, 'S');
		pq_sendstring(&msgbuf, record->name);
		pq_sendstring(&msgbuf, val);
		pq_endmessage(&msgbuf);

		pfree(val);
	}
}

4102 4103
/*
 * Try to parse value as an integer.  The accepted formats are the
4104 4105 4106 4107 4108 4109 4110
 * usual decimal, octal, or hexadecimal formats, optionally followed by
 * a unit name if "flags" indicates a unit is allowed.
 *
 * If the string parses okay, return true, else false.
 * If okay and result is not NULL, return the value in *result.
 * If not okay and hintmsg is not NULL, *hintmsg is set to a suitable
 *	HINT message, or NULL if no hint provided.
4111
 */
4112
bool
4113
parse_int(const char *value, int *result, int flags, const char **hintmsg)
4114
{
4115
	int64		val;
4116 4117
	char	   *endptr;

4118 4119 4120 4121 4122 4123 4124
	/* To suppress compiler warnings, always set output params */
	if (result)
		*result = 0;
	if (hintmsg)
		*hintmsg = NULL;

	/* We assume here that int64 is at least as wide as long */
4125 4126
	errno = 0;
	val = strtol(value, &endptr, 0);
4127

4128 4129 4130 4131
	if (endptr == value)
		return false;			/* no HINT for integer syntax error */

	if (errno == ERANGE || val != (int64) ((int32) val))
4132
	{
4133 4134 4135 4136
		if (hintmsg)
			*hintmsg = gettext_noop("Value exceeds integer range.");
		return false;
	}
4137

4138 4139 4140
	/* allow whitespace between integer and unit */
	while (isspace((unsigned char) *endptr))
		endptr++;
4141

4142 4143 4144 4145 4146 4147 4148 4149 4150 4151 4152 4153
	/* Handle possible unit */
	if (*endptr != '\0')
	{
		/*
		 * Note: the multiple-switch coding technique here is a bit tedious,
		 * but seems necessary to avoid intermediate-value overflows.
		 *
		 * If INT64_IS_BUSTED (ie, it's really int32) we will fail to detect
		 * overflow due to units conversion, but there are few enough such
		 * machines that it does not seem worth trying to be smarter.
		 */
		if (flags & GUC_UNIT_MEMORY)
4154
		{
4155 4156 4157
			/* Set hint for use if no match or trailing garbage */
			if (hintmsg)
				*hintmsg = gettext_noop("Valid units for this parameter are \"kB\", \"MB\", and \"GB\".");
4158

4159 4160 4161 4162 4163
#if BLCKSZ < 1024 || BLCKSZ > (1024*1024)
#error BLCKSZ must be between 1KB and 1MB
#endif
#if XLOG_BLCKSZ < 1024 || XLOG_BLCKSZ > (1024*1024)
#error XLOG_BLCKSZ must be between 1KB and 1MB
4164 4165
#endif

4166
			if (strncmp(endptr, "kB", 2) == 0)
4167
			{
4168 4169 4170 4171 4172 4173 4174 4175 4176 4177 4178 4179 4180 4181 4182 4183 4184 4185 4186 4187 4188 4189 4190 4191 4192 4193 4194 4195 4196 4197 4198 4199 4200 4201 4202 4203 4204 4205 4206 4207 4208 4209
				endptr += 2;
				switch (flags & GUC_UNIT_MEMORY)
				{
					case GUC_UNIT_BLOCKS:
						val /= (BLCKSZ / 1024);
						break;
					case GUC_UNIT_XBLOCKS:
						val /= (XLOG_BLCKSZ / 1024);
						break;
				}
			}
			else if (strncmp(endptr, "MB", 2) == 0)
			{
				endptr += 2;
				switch (flags & GUC_UNIT_MEMORY)
				{
					case GUC_UNIT_KB:
						val *= KB_PER_MB;
						break;
					case GUC_UNIT_BLOCKS:
						val *= KB_PER_MB / (BLCKSZ / 1024);
						break;
					case GUC_UNIT_XBLOCKS:
						val *= KB_PER_MB / (XLOG_BLCKSZ / 1024);
						break;
				}
			}
			else if (strncmp(endptr, "GB", 2) == 0)
			{
				endptr += 2;
				switch (flags & GUC_UNIT_MEMORY)
				{
					case GUC_UNIT_KB:
						val *= KB_PER_GB;
						break;
					case GUC_UNIT_BLOCKS:
						val *= KB_PER_GB / (BLCKSZ / 1024);
						break;
					case GUC_UNIT_XBLOCKS:
						val *= KB_PER_GB / (XLOG_BLCKSZ / 1024);
						break;
				}
4210 4211
			}
		}
4212 4213 4214 4215 4216
		else if (flags & GUC_UNIT_TIME)
		{
			/* Set hint for use if no match or trailing garbage */
			if (hintmsg)
				*hintmsg = gettext_noop("Valid units for this parameter are \"ms\", \"s\", \"min\", \"h\", and \"d\".");
4217

4218 4219 4220 4221 4222 4223 4224 4225 4226 4227 4228 4229 4230 4231 4232 4233 4234 4235 4236 4237 4238 4239 4240 4241 4242 4243 4244 4245 4246 4247 4248 4249 4250 4251 4252 4253 4254 4255 4256 4257 4258 4259 4260 4261 4262 4263 4264 4265 4266 4267 4268 4269 4270 4271 4272 4273 4274 4275 4276 4277 4278 4279 4280 4281 4282 4283 4284 4285 4286 4287 4288 4289
			if (strncmp(endptr, "ms", 2) == 0)
			{
				endptr += 2;
				switch (flags & GUC_UNIT_TIME)
				{
					case GUC_UNIT_S:
						val /= MS_PER_S;
						break;
					case GUC_UNIT_MIN:
						val /= MS_PER_MIN;
						break;
				}
			}
			else if (strncmp(endptr, "s", 1) == 0)
			{
				endptr += 1;
				switch (flags & GUC_UNIT_TIME)
				{
					case GUC_UNIT_MS:
						val *= MS_PER_S;
						break;
					case GUC_UNIT_MIN:
						val /= S_PER_MIN;
						break;
				}
			}
			else if (strncmp(endptr, "min", 3) == 0)
			{
				endptr += 3;
				switch (flags & GUC_UNIT_TIME)
				{
					case GUC_UNIT_MS:
						val *= MS_PER_MIN;
						break;
					case GUC_UNIT_S:
						val *= S_PER_MIN;
						break;
				}
			}
			else if (strncmp(endptr, "h", 1) == 0)
			{
				endptr += 1;
				switch (flags & GUC_UNIT_TIME)
				{
					case GUC_UNIT_MS:
						val *= MS_PER_H;
						break;
					case GUC_UNIT_S:
						val *= S_PER_H;
						break;
					case GUC_UNIT_MIN:
						val *= MIN_PER_H;
						break;
				}
			}
			else if (strncmp(endptr, "d", 1) == 0)
			{
				endptr += 1;
				switch (flags & GUC_UNIT_TIME)
				{
					case GUC_UNIT_MS:
						val *= MS_PER_D;
						break;
					case GUC_UNIT_S:
						val *= S_PER_D;
						break;
					case GUC_UNIT_MIN:
						val *= MIN_PER_D;
						break;
				}
			}
		}
4290

4291 4292
		/* allow whitespace after unit */
		while (isspace((unsigned char) *endptr))
4293 4294
			endptr++;

4295 4296
		if (*endptr != '\0')
			return false;		/* appropriate hint, if any, already set */
4297

4298 4299
		/* Check for overflow due to units conversion */
		if (val != (int64) ((int32) val))
4300
		{
4301 4302 4303
			if (hintmsg)
				*hintmsg = gettext_noop("Value exceeds integer range.");
			return false;
4304
		}
4305 4306
	}

4307 4308 4309 4310 4311 4312 4313 4314
	if (result)
		*result = (int) val;
	return true;
}



/*
4315 4316 4317
 * Try to parse value as a floating point number in the usual format.
 * If the string parses okay, return true, else false.
 * If okay and result is not NULL, return the value in *result.
4318
 */
4319
bool
4320 4321 4322 4323 4324
parse_real(const char *value, double *result)
{
	double		val;
	char	   *endptr;

4325 4326 4327
	if (result)
		*result = 0;			/* suppress compiler warning */

4328 4329
	errno = 0;
	val = strtod(value, &endptr);
4330
	if (endptr == value || errno == ERANGE)
4331
		return false;
4332 4333 4334 4335 4336 4337 4338

	/* allow whitespace after number */
	while (isspace((unsigned char) *endptr))
		endptr++;
	if (*endptr != '\0')
		return false;

4339 4340 4341 4342 4343 4344
	if (result)
		*result = val;
	return true;
}


4345 4346 4347 4348 4349 4350 4351 4352
/*
 * Lookup the name for an enum option with the selected value.
 * Should only ever be called with known-valid values, so throws
 * an elog(ERROR) if the enum option is not found.
 *
 * The returned string is a pointer to static data and not
 * allocated for modification.
 */
4353 4354
const char *
config_enum_lookup_by_value(struct config_enum *record, int val)
4355
{
A
Alvaro Herrera 已提交
4356 4357 4358
	const struct config_enum_entry *entry;

	for (entry = record->options; entry && entry->name; entry++)
4359 4360 4361 4362
	{
		if (entry->val == val)
			return entry->name;
	}
A
Alvaro Herrera 已提交
4363

4364 4365
	elog(ERROR, "could not find enum option %d for %s",
		 val, record->gen.name);
A
Alvaro Herrera 已提交
4366
	return NULL;		/* silence compiler */
4367 4368 4369 4370 4371 4372 4373
}


/*
 * Lookup the value for an enum option with the selected name
 * (case-insensitive).
 * If the enum option is found, sets the retval value and returns
4374
 * true. If it's not found, return FALSE and retval is set to 0.
4375
 */
4376
bool
A
Alvaro Herrera 已提交
4377 4378
config_enum_lookup_by_name(struct config_enum *record, const char *value,
						   int *retval)
4379
{
A
Alvaro Herrera 已提交
4380 4381 4382
	const struct config_enum_entry *entry;

	for (entry = record->options; entry && entry->name; entry++)
4383
	{
4384
		if (pg_strcasecmp(value, entry->name) == 0)
4385 4386 4387 4388 4389
		{
			*retval = entry->val;
			return TRUE;
		}
	}
A
Alvaro Herrera 已提交
4390 4391

	*retval = 0;
4392 4393 4394 4395 4396
	return FALSE;
}


/*
4397
 * Return a list of all available options for an enum, excluding
A
Alvaro Herrera 已提交
4398
 * hidden ones, separated by the given separator.
4399 4400
 * If prefix is non-NULL, it is added before the first enum value.
 * If suffix is non-NULL, it is added to the end of the string.
4401 4402
 */
static char *
4403 4404
config_enum_get_options(struct config_enum *record, const char *prefix,
						const char *suffix, const char *separator)
4405
{
A
Alvaro Herrera 已提交
4406 4407 4408
	const struct config_enum_entry *entry;
	StringInfoData	retstr;
	int			seplen;
4409

A
Alvaro Herrera 已提交
4410 4411
	initStringInfo(&retstr);
	appendStringInfoString(&retstr, prefix);
4412
	
A
Alvaro Herrera 已提交
4413 4414
	seplen = strlen(separator);
	for (entry = record->options; entry && entry->name; entry++)
4415
	{
4416 4417
		if (!entry->hidden)
		{
A
Alvaro Herrera 已提交
4418 4419
			appendStringInfoString(&retstr, entry->name);
			appendBinaryStringInfo(&retstr, separator, seplen);
4420
		}
4421 4422
	}

4423 4424 4425 4426 4427 4428 4429
	/*
	 * All the entries may have been hidden, leaving the string empty
	 * if no prefix was given. This indicates a broken GUC setup, since
	 * there is no use for an enum without any values, so we just check
	 * to make sure we don't write to invalid memory instead of actually
	 * trying to do something smart with it.
	 */
A
Alvaro Herrera 已提交
4430 4431
	if (retstr.len >= seplen)
	{
4432
		/* Replace final separator */
A
Alvaro Herrera 已提交
4433 4434 4435
		retstr.data[retstr.len - seplen] = '\0';
		retstr.len -= seplen;
	}
4436

A
Alvaro Herrera 已提交
4437
	appendStringInfoString(&retstr, suffix);
4438

A
Alvaro Herrera 已提交
4439
	return retstr.data;
4440 4441
}

4442 4443 4444 4445 4446 4447 4448 4449 4450 4451 4452 4453 4454 4455 4456 4457 4458 4459 4460 4461 4462 4463 4464 4465 4466 4467 4468
/*
 * Call a GucStringAssignHook function, being careful to free the
 * "newval" string if the hook ereports.
 *
 * This is split out of set_config_option just to avoid the "volatile"
 * qualifiers that would otherwise have to be plastered all over.
 */
static const char *
call_string_assign_hook(GucStringAssignHook assign_hook,
						char *newval, bool doit, GucSource source)
{
	const char *result;

	PG_TRY();
	{
		result = (*assign_hook) (newval, doit, source);
	}
	PG_CATCH();
	{
		free(newval);
		PG_RE_THROW();
	}
	PG_END_TRY();

	return result;
}

4469

4470
/*
4471 4472 4473 4474 4475 4476
 * Sets option `name' to given value. The value should be a string
 * which is going to be parsed and converted to the appropriate data
 * type.  The context and source parameters indicate in which context this
 * function is being called so it can apply the access restrictions
 * properly.
 *
4477 4478 4479 4480 4481 4482 4483
 * If value is NULL, set the option to its default value (normally the
 * reset_val, but if source == PGC_S_DEFAULT we instead use the boot_val).
 *
 * action indicates whether to set the value globally in the session, locally
 * to the current top transaction, or just for the duration of a function call.
 *
 * If changeVal is false then don't really set the option but do all
4484 4485 4486 4487 4488
 * the checks to see if it would work.
 *
 * If there is an error (non-existing option, invalid value) then an
 * ereport(ERROR) is thrown *unless* this is called in a context where we
 * don't want to ereport (currently, startup or SIGHUP config file reread).
4489
 * In that case we write a suitable error message via ereport(LOG) and
4490 4491 4492 4493 4494 4495
 * return false. This is working around the deficiencies in the ereport
 * mechanism, so don't blame me.  In all other cases, the function
 * returns true, including cases where the input is valid but we chose
 * not to apply it because of context or source-priority considerations.
 *
 * See also SetConfigOption for an external interface.
4496
 */
4497 4498 4499
bool
set_config_option(const char *name, const char *value,
				  GucContext context, GucSource source,
4500
				  GucAction action, bool changeVal)
4501
{
4502 4503 4504
	struct config_generic *record;
	int			elevel;
	bool		makeDefault;
4505

4506 4507 4508 4509 4510 4511
	if (context == PGC_SIGHUP || source == PGC_S_DEFAULT)
	{
		/*
		 * To avoid cluttering the log, only the postmaster bleats loudly
		 * about problems with the config file.
		 */
4512
		elevel = IsUnderPostmaster ? DEBUG3 : LOG;
4513 4514
	}
	else if (source == PGC_S_DATABASE || source == PGC_S_USER)
4515
		elevel = WARNING;
4516 4517
	else
		elevel = ERROR;
4518

4519
	record = find_option(name, true, elevel);
4520 4521 4522 4523 4524 4525
	if (record == NULL)
	{
		ereport(elevel,
				(errcode(ERRCODE_UNDEFINED_OBJECT),
			   errmsg("unrecognized configuration parameter \"%s\"", name)));
		return false;
4526 4527
	}

4528
	/*
B
Bruce Momjian 已提交
4529 4530 4531 4532
	 * If source is postgresql.conf, mark the found record with
	 * GUC_IS_IN_FILE. This is for the convenience of ProcessConfigFile.  Note
	 * that we do it even if changeVal is false, since ProcessConfigFile wants
	 * the marking to occur during its testing pass.
4533
	 */
4534 4535
	if (source == PGC_S_FILE)
		record->status |= GUC_IS_IN_FILE;
4536

4537 4538 4539 4540 4541
	/*
	 * Check if the option can be set at this time. See guc.h for the precise
	 * rules. Note that we don't want to throw errors if we're in the SIGHUP
	 * context. In that case we just ignore the attempt and return true.
	 */
4542 4543
	switch (record->context)
	{
4544
		case PGC_INTERNAL:
4545 4546
			if (context == PGC_SIGHUP)
				return true;
4547 4548
			if (context != PGC_INTERNAL)
			{
4549 4550
				ereport(elevel,
						(errcode(ERRCODE_CANT_CHANGE_RUNTIME_PARAM),
4551
						 errmsg("parameter \"%s\" cannot be changed",
4552
								name)));
4553 4554 4555
				return false;
			}
			break;
4556 4557
		case PGC_POSTMASTER:
			if (context == PGC_SIGHUP)
4558
			{
4559 4560 4561
				/*
				 * We are reading a PGC_POSTMASTER var from postgresql.conf.
				 * We can't change the setting, so give a warning if the DBA
B
Bruce Momjian 已提交
4562
				 * tries to change it.	(Throwing an error would be more
4563 4564
				 * consistent, but seems overly rigid.)
				 */
4565 4566 4567
				if (changeVal && !is_newvalue_equal(record, value))
					ereport(elevel,
							(errcode(ERRCODE_CANT_CHANGE_RUNTIME_PARAM),
4568 4569 4570
							 errmsg("attempted change of parameter \"%s\" ignored",
									name),
							 errdetail("This parameter cannot be changed after server start.")));
4571 4572
				return true;
			}
4573 4574
			if (context != PGC_POSTMASTER)
			{
4575 4576
				ereport(elevel,
						(errcode(ERRCODE_CANT_CHANGE_RUNTIME_PARAM),
4577 4578 4579
						 errmsg("attempted change of parameter \"%s\" ignored",
								name),
						 errdetail("This parameter cannot be changed after server start.")));
4580 4581 4582 4583 4584 4585
				return false;
			}
			break;
		case PGC_SIGHUP:
			if (context != PGC_SIGHUP && context != PGC_POSTMASTER)
			{
4586 4587
				ereport(elevel,
						(errcode(ERRCODE_CANT_CHANGE_RUNTIME_PARAM),
4588
						 errmsg("parameter \"%s\" cannot be changed now",
4589
								name)));
4590 4591 4592 4593
				return false;
			}

			/*
B
Bruce Momjian 已提交
4594 4595 4596 4597
			 * Hmm, the idea of the SIGHUP context is "ought to be global, but
			 * can be changed after postmaster start". But there's nothing
			 * that prevents a crafty administrator from sending SIGHUP
			 * signals to individual backends only.
4598 4599 4600 4601 4602 4603
			 */
			break;
		case PGC_BACKEND:
			if (context == PGC_SIGHUP)
			{
				/*
B
Bruce Momjian 已提交
4604 4605 4606 4607 4608 4609
				 * If a PGC_BACKEND parameter is changed in the config file,
				 * we want to accept the new value in the postmaster (whence
				 * it will propagate to subsequently-started backends), but
				 * ignore it in existing backends.	This is a tad klugy, but
				 * necessary because we don't re-read the config file during
				 * backend start.
4610 4611
				 */
				if (IsUnderPostmaster)
4612
					return true;
4613 4614 4615
			}
			else if (context != PGC_BACKEND && context != PGC_POSTMASTER)
			{
4616 4617
				ereport(elevel,
						(errcode(ERRCODE_CANT_CHANGE_RUNTIME_PARAM),
B
Bruce Momjian 已提交
4618
						 errmsg("parameter \"%s\" cannot be set after connection start",
4619
								name)));
4620 4621 4622 4623 4624 4625
				return false;
			}
			break;
		case PGC_SUSET:
			if (context == PGC_USERSET || context == PGC_BACKEND)
			{
4626 4627
				ereport(elevel,
						(errcode(ERRCODE_INSUFFICIENT_PRIVILEGE),
B
Bruce Momjian 已提交
4628
						 errmsg("permission denied to set parameter \"%s\"",
4629
								name)));
4630
				return false;
4631 4632 4633 4634 4635
			}
			break;
		case PGC_USERSET:
			/* always okay */
			break;
4636
	}
4637

4638
	/*
B
Bruce Momjian 已提交
4639 4640 4641 4642
	 * Should we set reset/stacked values?	(If so, the behavior is not
	 * transactional.)	This is done either when we get a default value from
	 * the database's/user's/client's default settings or when we reset a
	 * value to its default.
4643
	 */
4644 4645
	makeDefault = changeVal && (source <= PGC_S_OVERRIDE) &&
		((value != NULL) || source == PGC_S_DEFAULT);
4646 4647

	/*
4648 4649 4650 4651 4652
	 * Ignore attempted set if overridden by previously processed setting.
	 * However, if changeVal is false then plow ahead anyway since we are
	 * trying to find out if the value is potentially good, not actually use
	 * it. Also keep going if makeDefault is true, since we may want to set
	 * the reset/stacked values even if we can't set the variable itself.
4653
	 */
4654
	if (record->source > source)
4655
	{
4656
		if (changeVal && !makeDefault)
4657
		{
4658
			elog(DEBUG3, "\"%s\": setting ignored because previous source is higher priority",
4659 4660 4661
				 name);
			return true;
		}
4662
		changeVal = false;
4663 4664
	}

4665
	/*
4666
	 * Evaluate value and set variable.
4667
	 */
4668
	switch (record->vartype)
4669 4670 4671
	{
		case PGC_BOOL:
			{
B
Bruce Momjian 已提交
4672
				struct config_bool *conf = (struct config_bool *) record;
4673
				bool		newval;
4674 4675 4676 4677 4678 4679 4680 4681 4682 4683 4684 4685

				if (value)
				{
					if (!parse_bool(value, &newval))
					{
						ereport(elevel,
								(errcode(ERRCODE_INVALID_PARAMETER_VALUE),
						  errmsg("parameter \"%s\" requires a Boolean value",
								 name)));
						return false;
					}
				}
4686 4687
				else if (source == PGC_S_DEFAULT)
					newval = conf->boot_val;
4688 4689 4690 4691 4692 4693
				else
				{
					newval = conf->reset_val;
					source = conf->gen.reset_source;
				}

4694 4695 4696 4697
				/* Save old value to support transaction abort */
				if (changeVal && !makeDefault)
					push_old_value(&conf->gen, action);

4698 4699 4700 4701 4702 4703 4704 4705 4706
				if (conf->assign_hook)
					if (!(*conf->assign_hook) (newval, changeVal, source))
					{
						ereport(elevel,
								(errcode(ERRCODE_INVALID_PARAMETER_VALUE),
							 errmsg("invalid value for parameter \"%s\": %d",
									name, (int) newval)));
						return false;
					}
4707

4708 4709 4710 4711 4712 4713
				if (changeVal)
				{
					*conf->variable = newval;
					conf->gen.source = source;
				}
				if (makeDefault)
4714
				{
4715 4716 4717
					GucStack   *stack;

					if (conf->gen.reset_source <= source)
4718
					{
4719 4720
						conf->reset_val = newval;
						conf->gen.reset_source = source;
4721
					}
4722
					for (stack = conf->gen.stack; stack; stack = stack->prev)
4723
					{
4724
						if (stack->source <= source)
4725
						{
4726 4727
							stack->prior.boolval = newval;
							stack->source = source;
4728 4729
						}
					}
4730
				}
B
Bruce Momjian 已提交
4731
				break;
4732
			}
4733 4734

		case PGC_INT:
4735
			{
B
Bruce Momjian 已提交
4736
				struct config_int *conf = (struct config_int *) record;
4737
				int			newval;
4738

4739 4740
				if (value)
				{
4741 4742 4743
					const char *hintmsg;

					if (!parse_int(value, &newval, conf->gen.flags, &hintmsg))
4744 4745 4746
					{
						ereport(elevel,
								(errcode(ERRCODE_INVALID_PARAMETER_VALUE),
B
Bruce Momjian 已提交
4747 4748
						 errmsg("invalid value for parameter \"%s\": \"%s\"",
								name, value),
4749
								 hintmsg ? errhint("%s", _(hintmsg)) : 0));
4750 4751 4752 4753 4754 4755 4756 4757 4758 4759 4760
						return false;
					}
					if (newval < conf->min || newval > conf->max)
					{
						ereport(elevel,
								(errcode(ERRCODE_INVALID_PARAMETER_VALUE),
								 errmsg("%d is outside the valid range for parameter \"%s\" (%d .. %d)",
										newval, name, conf->min, conf->max)));
						return false;
					}
				}
4761 4762
				else if (source == PGC_S_DEFAULT)
					newval = conf->boot_val;
4763 4764 4765 4766 4767 4768
				else
				{
					newval = conf->reset_val;
					source = conf->gen.reset_source;
				}

4769 4770 4771 4772
				/* Save old value to support transaction abort */
				if (changeVal && !makeDefault)
					push_old_value(&conf->gen, action);

4773 4774 4775 4776 4777 4778 4779 4780 4781
				if (conf->assign_hook)
					if (!(*conf->assign_hook) (newval, changeVal, source))
					{
						ereport(elevel,
								(errcode(ERRCODE_INVALID_PARAMETER_VALUE),
							 errmsg("invalid value for parameter \"%s\": %d",
									name, newval)));
						return false;
					}
4782

4783 4784 4785 4786 4787 4788
				if (changeVal)
				{
					*conf->variable = newval;
					conf->gen.source = source;
				}
				if (makeDefault)
4789
				{
4790 4791 4792
					GucStack   *stack;

					if (conf->gen.reset_source <= source)
4793
					{
4794 4795
						conf->reset_val = newval;
						conf->gen.reset_source = source;
4796
					}
4797
					for (stack = conf->gen.stack; stack; stack = stack->prev)
4798
					{
4799
						if (stack->source <= source)
4800
						{
4801 4802
							stack->prior.intval = newval;
							stack->source = source;
4803 4804
						}
					}
4805
				}
B
Bruce Momjian 已提交
4806
				break;
4807
			}
4808 4809

		case PGC_REAL:
4810
			{
B
Bruce Momjian 已提交
4811
				struct config_real *conf = (struct config_real *) record;
4812
				double		newval;
4813

4814 4815 4816 4817 4818 4819 4820 4821 4822 4823 4824 4825 4826 4827 4828 4829 4830 4831 4832
				if (value)
				{
					if (!parse_real(value, &newval))
					{
						ereport(elevel,
								(errcode(ERRCODE_INVALID_PARAMETER_VALUE),
						  errmsg("parameter \"%s\" requires a numeric value",
								 name)));
						return false;
					}
					if (newval < conf->min || newval > conf->max)
					{
						ereport(elevel,
								(errcode(ERRCODE_INVALID_PARAMETER_VALUE),
								 errmsg("%g is outside the valid range for parameter \"%s\" (%g .. %g)",
										newval, name, conf->min, conf->max)));
						return false;
					}
				}
4833 4834
				else if (source == PGC_S_DEFAULT)
					newval = conf->boot_val;
4835 4836 4837 4838 4839 4840
				else
				{
					newval = conf->reset_val;
					source = conf->gen.reset_source;
				}

4841 4842 4843 4844
				/* Save old value to support transaction abort */
				if (changeVal && !makeDefault)
					push_old_value(&conf->gen, action);

4845 4846 4847 4848 4849 4850 4851 4852 4853
				if (conf->assign_hook)
					if (!(*conf->assign_hook) (newval, changeVal, source))
					{
						ereport(elevel,
								(errcode(ERRCODE_INVALID_PARAMETER_VALUE),
							 errmsg("invalid value for parameter \"%s\": %g",
									name, newval)));
						return false;
					}
4854

4855 4856 4857 4858 4859 4860
				if (changeVal)
				{
					*conf->variable = newval;
					conf->gen.source = source;
				}
				if (makeDefault)
4861
				{
4862 4863 4864
					GucStack   *stack;

					if (conf->gen.reset_source <= source)
4865
					{
4866 4867
						conf->reset_val = newval;
						conf->gen.reset_source = source;
4868
					}
4869
					for (stack = conf->gen.stack; stack; stack = stack->prev)
4870
					{
4871
						if (stack->source <= source)
4872
						{
4873 4874
							stack->prior.realval = newval;
							stack->source = source;
4875 4876
						}
					}
4877
				}
B
Bruce Momjian 已提交
4878
				break;
4879
			}
4880 4881 4882

		case PGC_STRING:
			{
B
Bruce Momjian 已提交
4883
				struct config_string *conf = (struct config_string *) record;
4884
				char	   *newval;
B
Bruce Momjian 已提交
4885

4886 4887 4888 4889 4890
				if (value)
				{
					newval = guc_strdup(elevel, value);
					if (newval == NULL)
						return false;
B
Bruce Momjian 已提交
4891

4892
					/*
B
Bruce Momjian 已提交
4893 4894
					 * The only sort of "parsing" check we need to do is apply
					 * truncation if GUC_IS_NAME.
4895 4896 4897 4898
					 */
					if (conf->gen.flags & GUC_IS_NAME)
						truncate_identifier(newval, strlen(newval), true);
				}
4899 4900 4901 4902 4903 4904 4905 4906 4907 4908 4909
				else if (source == PGC_S_DEFAULT)
				{
					if (conf->boot_val == NULL)
						newval = NULL;
					else
					{
						newval = guc_strdup(elevel, conf->boot_val);
						if (newval == NULL)
							return false;
					}
				}
4910
				else
4911 4912 4913
				{
					/*
					 * We could possibly avoid strdup here, but easier to make
4914 4915
					 * this case work the same as the normal assignment case;
					 * note the possible free of newval below.
4916
					 */
4917 4918 4919 4920 4921 4922 4923 4924
					if (conf->reset_val == NULL)
						newval = NULL;
					else
					{
						newval = guc_strdup(elevel, conf->reset_val);
						if (newval == NULL)
							return false;
					}
4925 4926 4927
					source = conf->gen.reset_source;
				}

4928 4929 4930 4931
				/* Save old value to support transaction abort */
				if (changeVal && !makeDefault)
					push_old_value(&conf->gen, action);

4932
				if (conf->assign_hook && newval)
4933 4934 4935 4936 4937 4938 4939 4940 4941 4942 4943 4944 4945 4946 4947 4948 4949 4950 4951 4952 4953 4954 4955 4956 4957 4958 4959 4960 4961 4962 4963 4964 4965 4966 4967
				{
					const char *hookresult;

					/*
					 * If the hook ereports, we have to make sure we free
					 * newval, else it will be a permanent memory leak.
					 */
					hookresult = call_string_assign_hook(conf->assign_hook,
														 newval,
														 changeVal,
														 source);
					if (hookresult == NULL)
					{
						free(newval);
						ereport(elevel,
								(errcode(ERRCODE_INVALID_PARAMETER_VALUE),
						 errmsg("invalid value for parameter \"%s\": \"%s\"",
								name, value ? value : "")));
						return false;
					}
					else if (hookresult != newval)
					{
						free(newval);

						/*
						 * Having to cast away const here is annoying, but the
						 * alternative is to declare assign_hooks as returning
						 * char*, which would mean they'd have to cast away
						 * const, or as both taking and returning char*, which
						 * doesn't seem attractive either --- we don't want
						 * them to scribble on the passed str.
						 */
						newval = (char *) hookresult;
					}
				}
4968

4969
				if (changeVal)
4970
				{
4971 4972 4973 4974 4975 4976 4977 4978
					set_string_field(conf, conf->variable, newval);
					conf->gen.source = source;
				}
				if (makeDefault)
				{
					GucStack   *stack;

					if (conf->gen.reset_source <= source)
4979
					{
4980 4981
						set_string_field(conf, &conf->reset_val, newval);
						conf->gen.reset_source = source;
4982
					}
4983
					for (stack = conf->gen.stack; stack; stack = stack->prev)
4984
					{
4985
						if (stack->source <= source)
4986
						{
4987 4988 4989
							set_string_field(conf, &stack->prior.stringval,
											 newval);
							stack->source = source;
4990
						}
B
Bruce Momjian 已提交
4991
					}
4992
				}
4993 4994
				/* Perhaps we didn't install newval anywhere */
				if (newval && !string_field_used(conf, newval))
4995
					free(newval);
B
Bruce Momjian 已提交
4996
				break;
4997
			}
4998 4999 5000 5001 5002 5003 5004
		case PGC_ENUM:
			{
				struct config_enum *conf = (struct config_enum *) record;
				int			newval;

				if (value)
				{
5005
					if (!config_enum_lookup_by_name(conf, value, &newval))
5006
					{
A
Alvaro Herrera 已提交
5007 5008 5009 5010 5011
						char *hintmsg;
					   
						hintmsg	= config_enum_get_options(conf,
														  "Available values: ",
														  ".", ", ");
5012 5013 5014 5015 5016

						ereport(elevel,
								(errcode(ERRCODE_INVALID_PARAMETER_VALUE),
								 errmsg("invalid value for parameter \"%s\": \"%s\"",
										name, value),
5017
								 hintmsg ? errhint("%s", _(hintmsg)) : 0));
5018 5019 5020 5021 5022 5023 5024 5025 5026 5027 5028 5029 5030 5031

						if (hintmsg)
							pfree(hintmsg);
						return false;
					}
				}
				else if (source == PGC_S_DEFAULT)
					newval = conf->boot_val;
				else
				{
					newval = conf->reset_val;
					source = conf->gen.reset_source;
				}

5032 5033 5034 5035
				/* Save old value to support transaction abort */
				if (changeVal && !makeDefault)
					push_old_value(&conf->gen, action);

5036 5037 5038 5039 5040
				if (conf->assign_hook)
					if (!(*conf->assign_hook) (newval, changeVal, source))
					{
						ereport(elevel,
								(errcode(ERRCODE_INVALID_PARAMETER_VALUE),
5041 5042
								 errmsg("invalid value for parameter \"%s\": \"%s\"",
										name, 
5043
										config_enum_lookup_by_value(conf, newval))));
5044 5045 5046
						return false;
					}

5047
				if (changeVal)
5048
				{
5049 5050 5051 5052 5053 5054 5055 5056
					*conf->variable = newval;
					conf->gen.source = source;
				}
				if (makeDefault)
				{
					GucStack   *stack;

					if (conf->gen.reset_source <= source)
5057
					{
5058 5059
						conf->reset_val = newval;
						conf->gen.reset_source = source;
5060
					}
5061
					for (stack = conf->gen.stack; stack; stack = stack->prev)
5062
					{
5063
						if (stack->source <= source)
5064
						{
5065 5066
							stack->prior.enumval = newval;
							stack->source = source;
5067 5068 5069 5070 5071
						}
					}
				}
				break;
			}
5072
	}
5073

5074
	if (changeVal && (record->flags & GUC_REPORT))
5075
		ReportGUCOption(record);
5076

5077 5078 5079 5080
	return true;
}


5081 5082 5083 5084 5085 5086 5087 5088 5089 5090 5091 5092 5093 5094 5095 5096 5097 5098 5099 5100
/*
 * Set the fields for source file and line number the setting came from.
 */
static void
set_config_sourcefile(const char *name, char *sourcefile, int sourceline)
{
	struct config_generic *record;
	int			elevel;

	/*
	 * To avoid cluttering the log, only the postmaster bleats loudly
	 * about problems with the config file.
	 */
	elevel = IsUnderPostmaster ? DEBUG3 : LOG;

	record = find_option(name, true, elevel);
	/* should not happen */
	if (record == NULL)
		elog(ERROR, "unrecognized configuration parameter \"%s\"", name);

5101
	sourcefile = guc_strdup(elevel, sourcefile);
5102 5103
	if (record->sourcefile)
		free(record->sourcefile);
5104
	record->sourcefile = sourcefile;
5105 5106 5107
	record->sourceline = sourceline;
}

5108 5109
/*
 * Set a config option to the given value. See also set_config_option,
B
Bruce Momjian 已提交
5110
 * this is just the wrapper to be called from outside GUC.	NB: this
5111
 * is used only for non-transactional operations.
5112 5113 5114
 *
 * Note: there is no support here for setting source file/line, as it
 * is currently not needed.
5115 5116
 */
void
5117
SetConfigOption(const char *name, const char *value,
5118
				GucContext context, GucSource source)
5119
{
5120 5121
	(void) set_config_option(name, value, context, source,
							 GUC_ACTION_SET, true);
5122 5123 5124 5125 5126
}



/*
5127
 * Fetch the current value of the option `name'. If the option doesn't exist,
5128
 * throw an ereport and don't return.
5129 5130 5131 5132 5133
 *
 * The string is *not* allocated for modification and is really only
 * valid until the next call to configuration related functions.
 */
const char *
B
Bruce Momjian 已提交
5134
GetConfigOption(const char *name)
5135
{
B
Bruce Momjian 已提交
5136
	struct config_generic *record;
5137 5138
	static char buffer[256];

5139
	record = find_option(name, false, ERROR);
5140
	if (record == NULL)
5141 5142
		ereport(ERROR,
				(errcode(ERRCODE_UNDEFINED_OBJECT),
B
Bruce Momjian 已提交
5143
			   errmsg("unrecognized configuration parameter \"%s\"", name)));
5144 5145 5146 5147
	if ((record->flags & GUC_SUPERUSER_ONLY) && !superuser())
		ereport(ERROR,
				(errcode(ERRCODE_INSUFFICIENT_PRIVILEGE),
				 errmsg("must be superuser to examine \"%s\"", name)));
5148

5149
	switch (record->vartype)
5150 5151
	{
		case PGC_BOOL:
B
Bruce Momjian 已提交
5152
			return *((struct config_bool *) record)->variable ? "on" : "off";
5153

5154
		case PGC_INT:
5155 5156
			snprintf(buffer, sizeof(buffer), "%d",
					 *((struct config_int *) record)->variable);
5157 5158
			return buffer;

5159
		case PGC_REAL:
5160 5161
			snprintf(buffer, sizeof(buffer), "%g",
					 *((struct config_real *) record)->variable);
5162 5163 5164
			return buffer;

		case PGC_STRING:
B
Bruce Momjian 已提交
5165
			return *((struct config_string *) record)->variable;
5166 5167

		case PGC_ENUM:
5168
			return config_enum_lookup_by_value((struct config_enum *) record,
5169
											*((struct config_enum *) record)->variable);
5170 5171 5172
	}
	return NULL;
}
5173

5174 5175
/*
 * Get the RESET value associated with the given option.
5176 5177 5178 5179
 *
 * Note: this is not re-entrant, due to use of static result buffer;
 * not to mention that a string variable could have its reset_val changed.
 * Beware of assuming the result value is good for very long.
5180 5181 5182
 */
const char *
GetConfigOptionResetString(const char *name)
5183
{
5184 5185
	struct config_generic *record;
	static char buffer[256];
5186

5187
	record = find_option(name, false, ERROR);
5188
	if (record == NULL)
5189 5190
		ereport(ERROR,
				(errcode(ERRCODE_UNDEFINED_OBJECT),
B
Bruce Momjian 已提交
5191
			   errmsg("unrecognized configuration parameter \"%s\"", name)));
5192 5193 5194 5195
	if ((record->flags & GUC_SUPERUSER_ONLY) && !superuser())
		ereport(ERROR,
				(errcode(ERRCODE_INSUFFICIENT_PRIVILEGE),
				 errmsg("must be superuser to examine \"%s\"", name)));
5196 5197

	switch (record->vartype)
5198 5199
	{
		case PGC_BOOL:
5200
			return ((struct config_bool *) record)->reset_val ? "on" : "off";
5201

5202
		case PGC_INT:
5203
			snprintf(buffer, sizeof(buffer), "%d",
5204 5205
					 ((struct config_int *) record)->reset_val);
			return buffer;
5206 5207

		case PGC_REAL:
5208
			snprintf(buffer, sizeof(buffer), "%g",
5209 5210
					 ((struct config_real *) record)->reset_val);
			return buffer;
5211 5212

		case PGC_STRING:
5213
			return ((struct config_string *) record)->reset_val;
5214 5215

		case PGC_ENUM:
5216
			return config_enum_lookup_by_value((struct config_enum *) record,
5217
										    ((struct config_enum *) record)->reset_val);
5218 5219 5220
	}
	return NULL;
}
5221

5222 5223 5224 5225 5226 5227 5228 5229 5230
/*
 * Detect whether the given configuration option can only be set by
 * a superuser.
 */
bool
IsSuperuserConfigOption(const char *name)
{
	struct config_generic *record;

5231
	record = find_option(name, false, ERROR);
5232 5233 5234 5235 5236
	/* On an unrecognized name, don't error, just return false. */
	if (record == NULL)
		return false;
	return (record->context == PGC_SUSET);
}
5237 5238


5239 5240 5241 5242 5243 5244 5245 5246 5247 5248 5249 5250 5251 5252 5253 5254 5255 5256 5257 5258 5259 5260 5261 5262 5263 5264
/*
 * GUC_complaint_elevel
 *		Get the ereport error level to use in an assign_hook's error report.
 *
 * This should be used by assign hooks that want to emit a custom error
 * report (in addition to the generic "invalid value for option FOO" that
 * guc.c will provide).  Note that the result might be ERROR or a lower
 * level, so the caller must be prepared for control to return from ereport,
 * or not.  If control does return, return false/NULL from the hook function.
 *
 * At some point it'd be nice to replace this with a mechanism that allows
 * the custom message to become the DETAIL line of guc.c's generic message.
 */
int
GUC_complaint_elevel(GucSource source)
{
	int			elevel;

	if (source == PGC_S_FILE)
	{
		/*
		 * To avoid cluttering the log, only the postmaster bleats loudly
		 * about problems with the config file.
		 */
		elevel = IsUnderPostmaster ? DEBUG3 : LOG;
	}
5265 5266 5267 5268 5269 5270 5271 5272 5273 5274
	else if (source == PGC_S_OVERRIDE)
	{
		/*
		 * If we're a postmaster child, this is probably "undo" during
		 * transaction abort, so we don't want to clutter the log.  There's
		 * a small chance of a real problem with an OVERRIDE setting,
		 * though, so suppressing the message entirely wouldn't be desirable.
		 */
		elevel = IsUnderPostmaster ? DEBUG5 : LOG;
	}
5275 5276 5277 5278 5279 5280 5281 5282 5283
	else if (source < PGC_S_INTERACTIVE)
		elevel = LOG;
	else
		elevel = ERROR;

	return elevel;
}


5284 5285 5286 5287 5288 5289 5290 5291
/*
 * flatten_set_variable_args
 *		Given a parsenode List as emitted by the grammar for SET,
 *		convert to the flat string representation used by GUC.
 *
 * We need to be told the name of the variable the args are for, because
 * the flattening rules vary (ugh).
 *
5292
 * The result is NULL if args is NIL (ie, SET ... TO DEFAULT), otherwise
5293 5294
 * a palloc'd string.
 */
5295
static char *
5296 5297 5298 5299 5300
flatten_set_variable_args(const char *name, List *args)
{
	struct config_generic *record;
	int			flags;
	StringInfoData buf;
5301
	ListCell   *l;
5302

5303
	/* Fast path if just DEFAULT */
5304 5305 5306
	if (args == NIL)
		return NULL;

5307
	/* Else get flags for the variable */
5308
	record = find_option(name, true, ERROR);
5309
	if (record == NULL)
5310 5311
		ereport(ERROR,
				(errcode(ERRCODE_UNDEFINED_OBJECT),
B
Bruce Momjian 已提交
5312
			   errmsg("unrecognized configuration parameter \"%s\"", name)));
5313 5314

	flags = record->flags;
5315 5316 5317

	/* Complain if list input and non-list variable */
	if ((flags & GUC_LIST_INPUT) == 0 &&
5318
		list_length(args) != 1)
5319 5320 5321
		ereport(ERROR,
				(errcode(ERRCODE_INVALID_PARAMETER_VALUE),
				 errmsg("SET %s takes only one argument", name)));
5322 5323 5324

	initStringInfo(&buf);

A
Alvaro Herrera 已提交
5325 5326
	/*
	 * Each list member may be a plain A_Const node, or an A_Const within a
5327 5328
	 * TypeCast; the latter case is supported only for ConstInterval
	 * arguments (for SET TIME ZONE).
A
Alvaro Herrera 已提交
5329
	 */
5330 5331
	foreach(l, args)
	{
A
Alvaro Herrera 已提交
5332
		Node       *arg = (Node *) lfirst(l);
5333
		char	   *val;
A
Alvaro Herrera 已提交
5334 5335
		TypeName   *typename = NULL;
		A_Const	   *con;
5336

5337
		if (l != list_head(args))
5338 5339
			appendStringInfo(&buf, ", ");

A
Alvaro Herrera 已提交
5340 5341 5342 5343 5344 5345 5346 5347
		if (IsA(arg, TypeCast))
		{
			TypeCast *tc = (TypeCast *) arg;

			arg = tc->arg;
			typename = tc->typename;
		}

5348
		if (!IsA(arg, A_Const))
5349
			elog(ERROR, "unrecognized node type: %d", (int) nodeTag(arg));
A
Alvaro Herrera 已提交
5350
		con = (A_Const *) arg;
5351

A
Alvaro Herrera 已提交
5352
		switch (nodeTag(&con->val))
5353 5354
		{
			case T_Integer:
A
Alvaro Herrera 已提交
5355
				appendStringInfo(&buf, "%ld", intVal(&con->val));
5356 5357 5358
				break;
			case T_Float:
				/* represented as a string, so just copy it */
A
Alvaro Herrera 已提交
5359
				appendStringInfoString(&buf, strVal(&con->val));
5360 5361
				break;
			case T_String:
A
Alvaro Herrera 已提交
5362 5363
				val = strVal(&con->val);
				if (typename != NULL)
5364 5365
				{
					/*
B
Bruce Momjian 已提交
5366 5367 5368
					 * Must be a ConstInterval argument for TIME ZONE. Coerce
					 * to interval and back to normalize the value and account
					 * for any typmod.
5369
					 */
5370
					Oid			typoid;
5371
					int32		typmod;
B
Bruce Momjian 已提交
5372
					Datum		interval;
B
Bruce Momjian 已提交
5373
					char	   *intervalout;
5374

A
Alvaro Herrera 已提交
5375
					typoid = typenameTypeId(NULL, typename, &typmod);
5376
					Assert(typoid == INTERVALOID);
5377

5378
					interval =
B
Bruce Momjian 已提交
5379 5380 5381
						DirectFunctionCall3(interval_in,
											CStringGetDatum(val),
											ObjectIdGetDatum(InvalidOid),
5382
											Int32GetDatum(typmod));
5383 5384

					intervalout =
5385 5386
						DatumGetCString(DirectFunctionCall1(interval_out,
															interval));
5387 5388 5389 5390
					appendStringInfo(&buf, "INTERVAL '%s'", intervalout);
				}
				else
				{
5391 5392 5393 5394
					/*
					 * Plain string literal or identifier.	For quote mode,
					 * quote it if it's not a vanilla identifier.
					 */
5395
					if (flags & GUC_LIST_QUOTE)
N
Neil Conway 已提交
5396
						appendStringInfoString(&buf, quote_identifier(val));
5397
					else
N
Neil Conway 已提交
5398
						appendStringInfoString(&buf, val);
5399 5400 5401
				}
				break;
			default:
5402
				elog(ERROR, "unrecognized node type: %d",
A
Alvaro Herrera 已提交
5403
					 (int) nodeTag(&con->val));
5404 5405
				break;
		}
5406
	}
5407 5408 5409 5410 5411 5412 5413 5414 5415

	return buf.data;
}


/*
 * SET command
 */
void
5416 5417
ExecSetVariableStmt(VariableSetStmt *stmt)
{
B
Bruce Momjian 已提交
5418
	GucAction	action = stmt->is_local ? GUC_ACTION_LOCAL : GUC_ACTION_SET;
5419

5420 5421 5422 5423 5424 5425 5426 5427
	switch (stmt->kind)
	{
		case VAR_SET_VALUE:
		case VAR_SET_CURRENT:
			set_config_option(stmt->name,
							  ExtractSetVariableArgs(stmt),
							  (superuser() ? PGC_SUSET : PGC_USERSET),
							  PGC_S_SESSION,
5428
							  action,
5429 5430 5431
							  true);
			break;
		case VAR_SET_MULTI:
B
Bruce Momjian 已提交
5432

5433
			/*
B
Bruce Momjian 已提交
5434 5435
			 * Special case for special SQL syntax that effectively sets more
			 * than one variable per statement.
5436 5437 5438 5439 5440 5441 5442 5443 5444 5445 5446 5447 5448 5449 5450 5451 5452 5453 5454 5455 5456 5457 5458 5459 5460 5461 5462 5463 5464 5465 5466 5467 5468 5469 5470 5471 5472 5473 5474 5475 5476 5477 5478 5479 5480 5481 5482 5483 5484
			 */
			if (strcmp(stmt->name, "TRANSACTION") == 0)
			{
				ListCell   *head;

				foreach(head, stmt->args)
				{
					DefElem    *item = (DefElem *) lfirst(head);

					if (strcmp(item->defname, "transaction_isolation") == 0)
						SetPGVariable("transaction_isolation",
									  list_make1(item->arg), stmt->is_local);
					else if (strcmp(item->defname, "transaction_read_only") == 0)
						SetPGVariable("transaction_read_only",
									  list_make1(item->arg), stmt->is_local);
					else
						elog(ERROR, "unexpected SET TRANSACTION element: %s",
							 item->defname);
				}
			}
			else if (strcmp(stmt->name, "SESSION CHARACTERISTICS") == 0)
			{
				ListCell   *head;

				foreach(head, stmt->args)
				{
					DefElem    *item = (DefElem *) lfirst(head);

					if (strcmp(item->defname, "transaction_isolation") == 0)
						SetPGVariable("default_transaction_isolation",
									  list_make1(item->arg), stmt->is_local);
					else if (strcmp(item->defname, "transaction_read_only") == 0)
						SetPGVariable("default_transaction_read_only",
									  list_make1(item->arg), stmt->is_local);
					else
						elog(ERROR, "unexpected SET SESSION element: %s",
							 item->defname);
				}
			}
			else
				elog(ERROR, "unexpected SET MULTI element: %s",
					 stmt->name);
			break;
		case VAR_SET_DEFAULT:
		case VAR_RESET:
			set_config_option(stmt->name,
							  NULL,
							  (superuser() ? PGC_SUSET : PGC_USERSET),
							  PGC_S_SESSION,
5485
							  action,
5486 5487 5488 5489 5490 5491 5492 5493 5494 5495 5496 5497 5498 5499 5500 5501 5502 5503 5504 5505 5506 5507 5508 5509 5510 5511 5512 5513 5514 5515 5516 5517 5518 5519 5520
							  true);
			break;
		case VAR_RESET_ALL:
			ResetAllOptions();
			break;
	}
}

/*
 * Get the value to assign for a VariableSetStmt, or NULL if it's RESET.
 * The result is palloc'd.
 *
 * This is exported for use by actions such as ALTER ROLE SET.
 */
char *
ExtractSetVariableArgs(VariableSetStmt *stmt)
{
	switch (stmt->kind)
	{
		case VAR_SET_VALUE:
			return flatten_set_variable_args(stmt->name, stmt->args);
		case VAR_SET_CURRENT:
			return GetConfigOptionByName(stmt->name, NULL);
		default:
			return NULL;
	}
}

/*
 * SetPGVariable - SET command exported as an easily-C-callable function.
 *
 * This provides access to SET TO value, as well as SET TO DEFAULT (expressed
 * by passing args == NIL), but not SET FROM CURRENT functionality.
 */
void
5521 5522 5523 5524 5525 5526 5527 5528 5529
SetPGVariable(const char *name, List *args, bool is_local)
{
	char	   *argstring = flatten_set_variable_args(name, args);

	/* Note SET DEFAULT (argstring == NULL) is equivalent to RESET */
	set_config_option(name,
					  argstring,
					  (superuser() ? PGC_SUSET : PGC_USERSET),
					  PGC_S_SESSION,
5530
					  is_local ? GUC_ACTION_LOCAL : GUC_ACTION_SET,
5531 5532 5533
					  true);
}

5534 5535 5536 5537 5538 5539
/*
 * SET command wrapped as a SQL callable function.
 */
Datum
set_config_by_name(PG_FUNCTION_ARGS)
{
B
Bruce Momjian 已提交
5540 5541 5542 5543
	char	   *name;
	char	   *value;
	char	   *new_value;
	bool		is_local;
5544 5545

	if (PG_ARGISNULL(0))
5546 5547
		ereport(ERROR,
				(errcode(ERRCODE_NULL_VALUE_NOT_ALLOWED),
5548
				 errmsg("SET requires parameter name")));
5549 5550

	/* Get the GUC variable name */
5551
	name = TextDatumGetCString(PG_GETARG_DATUM(0));
5552 5553 5554 5555 5556

	/* Get the desired value or set to NULL for a reset request */
	if (PG_ARGISNULL(1))
		value = NULL;
	else
5557
		value = TextDatumGetCString(PG_GETARG_DATUM(1));
5558 5559

	/*
B
Bruce Momjian 已提交
5560 5561
	 * Get the desired state of is_local. Default to false if provided value
	 * is NULL
5562 5563 5564 5565 5566 5567 5568 5569 5570 5571 5572
	 */
	if (PG_ARGISNULL(2))
		is_local = false;
	else
		is_local = PG_GETARG_BOOL(2);

	/* Note SET DEFAULT (argstring == NULL) is equivalent to RESET */
	set_config_option(name,
					  value,
					  (superuser() ? PGC_SUSET : PGC_USERSET),
					  PGC_S_SESSION,
5573
					  is_local ? GUC_ACTION_LOCAL : GUC_ACTION_SET,
5574 5575 5576
					  true);

	/* get the new current value */
5577
	new_value = GetConfigOptionByName(name, NULL);
5578 5579

	/* Convert return string to text */
5580
	PG_RETURN_TEXT_P(cstring_to_text(new_value));
5581 5582
}

5583

5584 5585 5586 5587 5588 5589 5590 5591 5592
/*
 * Common code for DefineCustomXXXVariable subroutines: allocate the
 * new variable's config struct and fill in generic fields.
 */
static struct config_generic *
init_custom_variable(const char *name,
					 const char *short_desc,
					 const char *long_desc,
					 GucContext context,
5593
					 int flags,
5594 5595 5596 5597 5598
					 enum config_type type,
					 size_t sz)
{
	struct config_generic *gen;

5599 5600 5601 5602 5603 5604 5605 5606 5607 5608 5609
	/*
	 * Only allow custom PGC_POSTMASTER variables to be created during
	 * shared library preload; any later than that, we can't ensure that
	 * the value doesn't change after startup.  This is a fatal elog if it
	 * happens; just erroring out isn't safe because we don't know what
	 * the calling loadable module might already have hooked into.
	 */
	if (context == PGC_POSTMASTER &&
		!process_shared_preload_libraries_in_progress)
		elog(FATAL, "cannot create PGC_POSTMASTER variables after startup");

5610 5611 5612 5613 5614 5615 5616 5617
	gen = (struct config_generic *) guc_malloc(ERROR, sz);
	memset(gen, 0, sz);

	gen->name = guc_strdup(ERROR, name);
	gen->context = context;
	gen->group = CUSTOM_OPTIONS;
	gen->short_desc = short_desc;
	gen->long_desc = long_desc;
5618
	gen->flags = flags;
5619 5620 5621 5622 5623 5624 5625 5626 5627
	gen->vartype = type;

	return gen;
}

/*
 * Common code for DefineCustomXXXVariable subroutines: insert the new
 * variable into the GUC variable array, replacing any placeholder.
 */
5628
static void
B
Bruce Momjian 已提交
5629
define_custom_variable(struct config_generic * variable)
5630
{
B
Bruce Momjian 已提交
5631 5632 5633 5634
	const char *name = variable->name;
	const char **nameAddr = &name;
	const char *value;
	struct config_string *pHolder;
5635
	GucContext phcontext;
5636
	struct config_generic **res;
B
Bruce Momjian 已提交
5637

5638 5639 5640
	/*
	 * See if there's a placeholder by the same name.
	 */
5641 5642 5643 5644 5645
	res = (struct config_generic **) bsearch((void *) &nameAddr,
											 (void *) guc_variables,
											 num_guc_variables,
											 sizeof(struct config_generic *),
											 guc_var_compare);
B
Bruce Momjian 已提交
5646
	if (res == NULL)
5647
	{
5648 5649 5650 5651 5652
		/*
		 * No placeholder to replace, so we can just add it ... but first,
		 * make sure it's initialized to its default value.
		 */
		InitializeOneGUCOption(variable);
5653
		add_guc_variable(variable, ERROR);
5654 5655 5656
		return;
	}

B
Bruce Momjian 已提交
5657 5658
	/*
	 * This better be a placeholder
5659
	 */
B
Bruce Momjian 已提交
5660
	if (((*res)->flags & GUC_CUSTOM_PLACEHOLDER) == 0)
5661 5662 5663
		ereport(ERROR,
				(errcode(ERRCODE_INTERNAL_ERROR),
				 errmsg("attempt to redefine parameter \"%s\"", name)));
5664 5665

	Assert((*res)->vartype == PGC_STRING);
5666
	pHolder = (struct config_string *) (*res);
B
Bruce Momjian 已提交
5667

5668 5669 5670 5671 5672 5673 5674
	/*
	 * First, set the variable to its default value.  We must do this even
	 * though we intend to immediately apply a new value, since it's possible
	 * that the new value is invalid.
	 */
	InitializeOneGUCOption(variable);

5675
	/*
B
Bruce Momjian 已提交
5676 5677
	 * Replace the placeholder. We aren't changing the name, so no re-sorting
	 * is necessary
5678
	 */
5679 5680
	*res = variable;

5681 5682 5683 5684 5685 5686 5687 5688 5689 5690 5691
	/*
	 * Infer context for assignment based on source of existing value.
	 * We can't tell this with exact accuracy, but we can at least do
	 * something reasonable in typical cases.
	 */
	switch (pHolder->gen.source)
	{
		case PGC_S_DEFAULT:
		case PGC_S_ENV_VAR:
		case PGC_S_FILE:
		case PGC_S_ARGV:
5692 5693 5694 5695 5696 5697 5698 5699 5700
			/*
			 * If we got past the check in init_custom_variable, we can
			 * safely assume that any existing value for a PGC_POSTMASTER
			 * variable was set in postmaster context.
			 */
			if (variable->context == PGC_POSTMASTER)
				phcontext = PGC_POSTMASTER;
			else
				phcontext = PGC_SIGHUP;
5701 5702 5703 5704 5705 5706 5707 5708 5709 5710
			break;
		case PGC_S_DATABASE:
		case PGC_S_USER:
		case PGC_S_CLIENT:
		case PGC_S_SESSION:
		default:
			phcontext = PGC_USERSET;
			break;
	}

5711
	/*
B
Bruce Momjian 已提交
5712
	 * Assign the string value stored in the placeholder to the real variable.
5713 5714 5715
	 *
	 * XXX this is not really good enough --- it should be a nontransactional
	 * assignment, since we don't want it to roll back if the current xact
5716
	 * fails later.  (Or do we?)
5717
	 */
5718 5719 5720
	value = *pHolder->variable;

	if (value)
5721 5722 5723 5724 5725 5726 5727 5728 5729 5730 5731
	{
		if (set_config_option(name, value,
							  phcontext, pHolder->gen.source,
							  GUC_ACTION_SET, true))
		{
			/* Also copy over any saved source-location information */
			if (pHolder->gen.sourcefile)
				set_config_sourcefile(name, pHolder->gen.sourcefile,
									  pHolder->gen.sourceline);
		}
	}
5732

5733 5734 5735
	/*
	 * Free up as much as we conveniently can of the placeholder structure
	 * (this neglects any stack items...)
5736
	 */
5737 5738
	set_string_field(pHolder, pHolder->variable, NULL);
	set_string_field(pHolder, &pHolder->reset_val, NULL);
5739 5740 5741 5742

	free(pHolder);
}

B
Bruce Momjian 已提交
5743
void
5744
DefineCustomBoolVariable(const char *name,
B
Bruce Momjian 已提交
5745 5746 5747
						 const char *short_desc,
						 const char *long_desc,
						 bool *valueAddr,
5748
						 bool bootValue,
B
Bruce Momjian 已提交
5749
						 GucContext context,
5750
						 int flags,
B
Bruce Momjian 已提交
5751 5752
						 GucBoolAssignHook assign_hook,
						 GucShowHook show_hook)
5753
{
5754
	struct config_bool *var;
5755

5756
	var = (struct config_bool *)
5757
		init_custom_variable(name, short_desc, long_desc, context, flags,
5758
							 PGC_BOOL, sizeof(struct config_bool));
B
Bruce Momjian 已提交
5759
	var->variable = valueAddr;
5760 5761
	var->boot_val = bootValue;
	var->reset_val = bootValue;
5762
	var->assign_hook = assign_hook;
B
Bruce Momjian 已提交
5763
	var->show_hook = show_hook;
5764 5765 5766
	define_custom_variable(&var->gen);
}

B
Bruce Momjian 已提交
5767
void
5768
DefineCustomIntVariable(const char *name,
B
Bruce Momjian 已提交
5769 5770 5771
						const char *short_desc,
						const char *long_desc,
						int *valueAddr,
5772
						int bootValue,
5773 5774
						int minValue,
						int maxValue,
B
Bruce Momjian 已提交
5775
						GucContext context,
5776
						int flags,
B
Bruce Momjian 已提交
5777 5778
						GucIntAssignHook assign_hook,
						GucShowHook show_hook)
5779
{
5780
	struct config_int *var;
5781

5782
	var = (struct config_int *)
5783
		init_custom_variable(name, short_desc, long_desc, context, flags,
5784
							 PGC_INT, sizeof(struct config_int));
B
Bruce Momjian 已提交
5785
	var->variable = valueAddr;
5786 5787
	var->boot_val = bootValue;
	var->reset_val = bootValue;
5788 5789
	var->min = minValue;
	var->max = maxValue;
5790
	var->assign_hook = assign_hook;
B
Bruce Momjian 已提交
5791
	var->show_hook = show_hook;
5792 5793 5794
	define_custom_variable(&var->gen);
}

B
Bruce Momjian 已提交
5795
void
5796
DefineCustomRealVariable(const char *name,
B
Bruce Momjian 已提交
5797 5798 5799
						 const char *short_desc,
						 const char *long_desc,
						 double *valueAddr,
5800
						 double bootValue,
5801 5802
						 double minValue,
						 double maxValue,
B
Bruce Momjian 已提交
5803
						 GucContext context,
5804
						 int flags,
B
Bruce Momjian 已提交
5805 5806
						 GucRealAssignHook assign_hook,
						 GucShowHook show_hook)
5807
{
5808
	struct config_real *var;
5809

5810
	var = (struct config_real *)
5811
		init_custom_variable(name, short_desc, long_desc, context, flags,
5812
							 PGC_REAL, sizeof(struct config_real));
B
Bruce Momjian 已提交
5813
	var->variable = valueAddr;
5814 5815
	var->boot_val = bootValue;
	var->reset_val = bootValue;
5816 5817
	var->min = minValue;
	var->max = maxValue;
5818
	var->assign_hook = assign_hook;
B
Bruce Momjian 已提交
5819
	var->show_hook = show_hook;
5820 5821 5822
	define_custom_variable(&var->gen);
}

B
Bruce Momjian 已提交
5823
void
5824
DefineCustomStringVariable(const char *name,
B
Bruce Momjian 已提交
5825 5826 5827
						   const char *short_desc,
						   const char *long_desc,
						   char **valueAddr,
5828
						   const char *bootValue,
B
Bruce Momjian 已提交
5829
						   GucContext context,
5830
						   int flags,
B
Bruce Momjian 已提交
5831 5832
						   GucStringAssignHook assign_hook,
						   GucShowHook show_hook)
5833
{
5834
	struct config_string *var;
5835

5836
	var = (struct config_string *)
5837
		init_custom_variable(name, short_desc, long_desc, context, flags,
5838
							 PGC_STRING, sizeof(struct config_string));
B
Bruce Momjian 已提交
5839
	var->variable = valueAddr;
5840
	var->boot_val = bootValue;
5841 5842 5843
	/* we could probably do without strdup, but keep it like normal case */
	if (var->boot_val)
		var->reset_val = guc_strdup(ERROR, var->boot_val);
5844
	var->assign_hook = assign_hook;
B
Bruce Momjian 已提交
5845
	var->show_hook = show_hook;
5846 5847 5848
	define_custom_variable(&var->gen);
}

5849 5850 5851 5852 5853
void
DefineCustomEnumVariable(const char *name,
						 const char *short_desc,
						 const char *long_desc,
						 int *valueAddr,
5854
						 int bootValue,
5855 5856
						 const struct config_enum_entry *options,
						 GucContext context,
5857
						 int flags,
5858 5859 5860 5861 5862 5863
						 GucEnumAssignHook assign_hook,
						 GucShowHook show_hook)
{
	struct config_enum *var;

	var = (struct config_enum *)
5864
		init_custom_variable(name, short_desc, long_desc, context, flags,
5865 5866
							 PGC_ENUM, sizeof(struct config_enum));
	var->variable = valueAddr;
5867 5868
	var->boot_val = bootValue;
	var->reset_val = bootValue;
5869 5870 5871 5872 5873 5874
	var->options = options;
	var->assign_hook = assign_hook;
	var->show_hook = show_hook;
	define_custom_variable(&var->gen);
}

N
Neil Conway 已提交
5875
void
B
Bruce Momjian 已提交
5876
EmitWarningsOnPlaceholders(const char *className)
5877
{
5878 5879
	int			classLen = strlen(className);
	int			i;
5880

5881
	for (i = 0; i < num_guc_variables; i++)
5882
	{
5883
		struct config_generic *var = guc_variables[i];
B
Bruce Momjian 已提交
5884 5885

		if ((var->flags & GUC_CUSTOM_PLACEHOLDER) != 0 &&
5886 5887
			strncmp(className, var->name, classLen) == 0 &&
			var->name[classLen] == GUC_QUALIFIER_SEPARATOR)
5888
		{
5889
			ereport(WARNING,
B
Bruce Momjian 已提交
5890
					(errcode(ERRCODE_UNDEFINED_OBJECT),
5891 5892
					 errmsg("unrecognized configuration parameter \"%s\"",
							var->name)));
5893 5894 5895 5896 5897
		}
	}
}


5898 5899 5900 5901
/*
 * SHOW command
 */
void
5902
GetPGVariable(const char *name, DestReceiver *dest)
5903
{
5904
	if (guc_name_compare(name, "all") == 0)
5905
		ShowAllGUCConfig(dest);
5906
	else
5907 5908 5909 5910 5911 5912 5913 5914
		ShowGUCConfigOption(name, dest);
}

TupleDesc
GetPGVariableResultDesc(const char *name)
{
	TupleDesc	tupdesc;

5915
	if (guc_name_compare(name, "all") == 0)
5916
	{
5917 5918
		/* need a tuple descriptor representing three TEXT columns */
		tupdesc = CreateTemplateTupleDesc(3, false);
5919
		TupleDescInitEntry(tupdesc, (AttrNumber) 1, "name",
5920
						   TEXTOID, -1, 0);
5921
		TupleDescInitEntry(tupdesc, (AttrNumber) 2, "setting",
5922
						   TEXTOID, -1, 0);
5923 5924
		TupleDescInitEntry(tupdesc, (AttrNumber) 3, "description",
						   TEXTOID, -1, 0);
5925 5926 5927 5928 5929 5930 5931 5932 5933 5934
	}
	else
	{
		const char *varname;

		/* Get the canonical spelling of name */
		(void) GetConfigOptionByName(name, &varname);

		/* need a tuple descriptor representing a single TEXT column */
		tupdesc = CreateTemplateTupleDesc(1, false);
5935 5936
		TupleDescInitEntry(tupdesc, (AttrNumber) 1, varname,
						   TEXTOID, -1, 0);
5937 5938
	}
	return tupdesc;
5939 5940 5941 5942 5943 5944
}


/*
 * SHOW command
 */
5945
static void
5946
ShowGUCConfigOption(const char *name, DestReceiver *dest)
5947
{
5948
	TupOutputState *tstate;
B
Bruce Momjian 已提交
5949 5950 5951
	TupleDesc	tupdesc;
	const char *varname;
	char	   *value;
5952

5953 5954 5955
	/* Get the value and canonical spelling of name */
	value = GetConfigOptionByName(name, &varname);

5956
	/* need a tuple descriptor representing a single TEXT column */
5957
	tupdesc = CreateTemplateTupleDesc(1, false);
5958
	TupleDescInitEntry(tupdesc, (AttrNumber) 1, varname,
5959
					   TEXTOID, -1, 0);
5960

5961 5962 5963 5964
	/* prepare for projection of tuples */
	tstate = begin_tup_output_tupdesc(dest, tupdesc);

	/* Send it */
5965
	do_text_output_oneline(tstate, value);
5966 5967

	end_tup_output(tstate);
5968 5969
}

5970 5971 5972
/*
 * SHOW ALL command
 */
5973
static void
5974
ShowAllGUCConfig(DestReceiver *dest)
5975
{
5976
	bool		am_superuser = superuser();
5977
	int			i;
5978
	TupOutputState *tstate;
B
Bruce Momjian 已提交
5979
	TupleDesc	tupdesc;
5980
	char	   *values[3];
5981

5982 5983
	/* need a tuple descriptor representing three TEXT columns */
	tupdesc = CreateTemplateTupleDesc(3, false);
5984
	TupleDescInitEntry(tupdesc, (AttrNumber) 1, "name",
5985
					   TEXTOID, -1, 0);
5986
	TupleDescInitEntry(tupdesc, (AttrNumber) 2, "setting",
5987
					   TEXTOID, -1, 0);
5988 5989
	TupleDescInitEntry(tupdesc, (AttrNumber) 3, "description",
					   TEXTOID, -1, 0);
B
Bruce Momjian 已提交
5990

5991 5992 5993

	/* prepare for projection of tuples */
	tstate = begin_tup_output_tupdesc(dest, tupdesc);
5994

5995 5996
	for (i = 0; i < num_guc_variables; i++)
	{
5997 5998
		struct config_generic *conf = guc_variables[i];

5999 6000
		if ((conf->flags & GUC_NO_SHOW_ALL) ||
			((conf->flags & GUC_SUPERUSER_ONLY) && !am_superuser))
6001
			continue;
6002 6003

		/* assign to the values array */
6004
		values[0] = (char *) conf->name;
6005
		values[1] = _ShowOption(conf, true);
6006
		values[2] = (char *) conf->short_desc;
6007 6008 6009

		/* send it to dest */
		do_tup_output(tstate, values);
6010

6011
		/* clean up */
6012 6013
		if (values[1] != NULL)
			pfree(values[1]);
6014
	}
6015 6016

	end_tup_output(tstate);
6017
}
6018

6019
/*
6020 6021
 * Return GUC variable value by name; optionally return canonical
 * form of name.  Return value is palloc'd.
6022 6023
 */
char *
6024
GetConfigOptionByName(const char *name, const char **varname)
6025 6026 6027
{
	struct config_generic *record;

6028
	record = find_option(name, false, ERROR);
6029
	if (record == NULL)
6030 6031
		ereport(ERROR,
				(errcode(ERRCODE_UNDEFINED_OBJECT),
B
Bruce Momjian 已提交
6032
			   errmsg("unrecognized configuration parameter \"%s\"", name)));
6033 6034 6035 6036
	if ((record->flags & GUC_SUPERUSER_ONLY) && !superuser())
		ereport(ERROR,
				(errcode(ERRCODE_INSUFFICIENT_PRIVILEGE),
				 errmsg("must be superuser to examine \"%s\"", name)));
6037

6038 6039 6040
	if (varname)
		*varname = record->name;

6041
	return _ShowOption(record, true);
6042 6043 6044
}

/*
6045 6046
 * Return GUC variable value by variable number; optionally return canonical
 * form of name.  Return value is palloc'd.
6047
 */
6048 6049
void
GetConfigOptionByNum(int varnum, const char **values, bool *noshow)
6050
{
B
Bruce Momjian 已提交
6051 6052
	char		buffer[256];
	struct config_generic *conf;
6053 6054 6055 6056 6057

	/* check requested variable number valid */
	Assert((varnum >= 0) && (varnum < num_guc_variables));

	conf = guc_variables[varnum];
6058

6059
	if (noshow)
6060 6061 6062 6063 6064 6065 6066
	{
		if ((conf->flags & GUC_NO_SHOW_ALL) ||
			((conf->flags & GUC_SUPERUSER_ONLY) && !superuser()))
			*noshow = true;
		else
			*noshow = false;
	}
6067

6068 6069 6070 6071 6072 6073
	/* first get the generic attributes */

	/* name */
	values[0] = conf->name;

	/* setting : use _ShowOption in order to avoid duplicating the logic */
6074 6075 6076 6077 6078
	values[1] = _ShowOption(conf, false);

	/* unit */
	if (conf->vartype == PGC_INT)
	{
6079
		static char buf[8];
6080

6081 6082 6083 6084 6085 6086
		switch (conf->flags & (GUC_UNIT_MEMORY | GUC_UNIT_TIME))
		{
			case GUC_UNIT_KB:
				values[2] = "kB";
				break;
			case GUC_UNIT_BLOCKS:
B
Bruce Momjian 已提交
6087
				snprintf(buf, sizeof(buf), "%dkB", BLCKSZ / 1024);
6088 6089 6090
				values[2] = buf;
				break;
			case GUC_UNIT_XBLOCKS:
B
Bruce Momjian 已提交
6091
				snprintf(buf, sizeof(buf), "%dkB", XLOG_BLCKSZ / 1024);
6092 6093 6094 6095 6096 6097 6098 6099 6100 6101 6102 6103 6104 6105
				values[2] = buf;
				break;
			case GUC_UNIT_MS:
				values[2] = "ms";
				break;
			case GUC_UNIT_S:
				values[2] = "s";
				break;
			case GUC_UNIT_MIN:
				values[2] = "min";
				break;
			default:
				values[2] = "";
				break;
6106 6107 6108 6109
		}
	}
	else
		values[2] = NULL;
6110

6111
	/* group */
6112
	values[3] = config_group_names[conf->group];
6113 6114

	/* short_desc */
6115
	values[4] = conf->short_desc;
6116 6117

	/* extra_desc */
6118
	values[5] = conf->long_desc;
6119

6120
	/* context */
6121
	values[6] = GucContext_Names[conf->context];
6122 6123

	/* vartype */
6124
	values[7] = config_type_names[conf->vartype];
6125 6126

	/* source */
6127
	values[8] = GucSource_Names[conf->source];
6128 6129 6130 6131 6132 6133

	/* now get the type specifc attributes */
	switch (conf->vartype)
	{
		case PGC_BOOL:
			{
6134 6135
				struct config_bool *lconf = (struct config_bool *) conf;

6136
				/* min_val */
6137
				values[9] = NULL;
6138 6139

				/* max_val */
6140
				values[10] = NULL;
6141 6142 6143

				/* enumvals */
				values[11] = NULL;
6144 6145 6146 6147 6148 6149

				/* boot_val */
				values[12] = pstrdup(lconf->boot_val ? "on" : "off");

				/* reset_val */
				values[13] = pstrdup(lconf->reset_val ? "on" : "off");
6150 6151 6152 6153 6154 6155 6156 6157 6158
			}
			break;

		case PGC_INT:
			{
				struct config_int *lconf = (struct config_int *) conf;

				/* min_val */
				snprintf(buffer, sizeof(buffer), "%d", lconf->min);
6159
				values[9] = pstrdup(buffer);
6160 6161 6162

				/* max_val */
				snprintf(buffer, sizeof(buffer), "%d", lconf->max);
6163
				values[10] = pstrdup(buffer);
6164 6165 6166

				/* enumvals */
				values[11] = NULL;
6167 6168 6169 6170 6171 6172 6173 6174

 				/* boot_val */
 				snprintf(buffer, sizeof(buffer), "%d", lconf->boot_val);
 				values[12] = pstrdup(buffer);

 				/* reset_val */
 				snprintf(buffer, sizeof(buffer), "%d", lconf->reset_val);
 				values[13] = pstrdup(buffer);
6175 6176 6177 6178 6179 6180 6181 6182 6183
			}
			break;

		case PGC_REAL:
			{
				struct config_real *lconf = (struct config_real *) conf;

				/* min_val */
				snprintf(buffer, sizeof(buffer), "%g", lconf->min);
6184
				values[9] = pstrdup(buffer);
6185 6186 6187

				/* max_val */
				snprintf(buffer, sizeof(buffer), "%g", lconf->max);
6188
				values[10] = pstrdup(buffer);
6189 6190 6191

				/* enumvals */
				values[11] = NULL;
6192 6193 6194 6195 6196 6197 6198 6199

 				/* boot_val */
 				snprintf(buffer, sizeof(buffer), "%g", lconf->boot_val);
 				values[12] = pstrdup(buffer);

 				/* reset_val */
 				snprintf(buffer, sizeof(buffer), "%g", lconf->reset_val);
 				values[13] = pstrdup(buffer);
6200 6201 6202 6203 6204
			}
			break;

		case PGC_STRING:
			{
6205 6206
 				struct config_string *lconf = (struct config_string *) conf;

6207
				/* min_val */
6208
				values[9] = NULL;
6209 6210

				/* max_val */
6211
				values[10] = NULL;
6212 6213 6214

				/* enumvals */
				values[11] = NULL;
6215 6216 6217 6218 6219 6220 6221 6222 6223 6224 6225 6226

 				/* boot_val */
 				if (lconf->boot_val == NULL)
 					values[12] = NULL;
				else
					values[12] = pstrdup(lconf->boot_val);

 				/* reset_val */
 				if (lconf->reset_val == NULL)
 					values[13] = NULL;
				else
					values[13] = pstrdup(lconf->reset_val);
6227 6228 6229 6230 6231
			}
			break;

		case PGC_ENUM:
			{
6232 6233
 				struct config_enum *lconf = (struct config_enum *) conf;

6234 6235 6236 6237 6238 6239 6240
				/* min_val */
				values[9] = NULL;

				/* max_val */
				values[10] = NULL;

				/* enumvals */
6241
				/* NOTE! enumvals with double quotes in them are not supported! */
A
Alvaro Herrera 已提交
6242 6243
				values[11] = config_enum_get_options((struct config_enum *) conf,
													 "{\"", "\"}", "\",\"");
6244 6245

 				/* boot_val */
A
Alvaro Herrera 已提交
6246 6247
				values[12] = pstrdup(config_enum_lookup_by_value(lconf,
																 lconf->boot_val));
6248 6249

 				/* reset_val */
A
Alvaro Herrera 已提交
6250 6251
				values[13] = pstrdup(config_enum_lookup_by_value(lconf,
																 lconf->reset_val));
6252 6253 6254 6255 6256 6257
			}
			break;

		default:
			{
				/*
B
Bruce Momjian 已提交
6258
				 * should never get here, but in case we do, set 'em to NULL
6259 6260 6261
				 */

				/* min_val */
6262
				values[9] = NULL;
6263 6264

				/* max_val */
6265
				values[10] = NULL;
6266 6267 6268

				/* enumvals */
				values[11] = NULL;
6269 6270 6271 6272 6273 6274

 				/* boot_val */
 				values[12] = NULL;

 				/* reset_val */
 				values[13] = NULL;
6275 6276 6277
			}
			break;
	}
6278

6279 6280 6281 6282 6283 6284
	/* 
	 * If the setting came from a config file, set the source location.
	 * For security reasons, we don't show source file/line number for
	 * non-superusers.
	 */
	if (conf->source == PGC_S_FILE && superuser())
6285
	{
6286
		values[14] = conf->sourcefile;
6287
		snprintf(buffer, sizeof(buffer), "%d", conf->sourceline);
6288
		values[15] = pstrdup(buffer);
6289 6290 6291
	}
	else
	{
6292 6293
		values[14] = NULL;
		values[15] = NULL;
6294
	}
6295 6296 6297 6298 6299 6300 6301 6302 6303 6304 6305 6306 6307 6308 6309 6310 6311 6312
}

/*
 * Return the total number of GUC variables
 */
int
GetNumConfigOptions(void)
{
	return num_guc_variables;
}

/*
 * show_config_by_name - equiv to SHOW X command but implemented as
 * a function.
 */
Datum
show_config_by_name(PG_FUNCTION_ARGS)
{
B
Bruce Momjian 已提交
6313 6314
	char	   *varname;
	char	   *varval;
6315 6316

	/* Get the GUC variable name */
6317
	varname = TextDatumGetCString(PG_GETARG_DATUM(0));
6318 6319

	/* Get the value */
6320
	varval = GetConfigOptionByName(varname, NULL);
6321 6322

	/* Convert to text */
6323
	PG_RETURN_TEXT_P(cstring_to_text(varval));
6324 6325
}

6326 6327 6328 6329
/*
 * show_all_settings - equiv to SHOW ALL command but implemented as
 * a Table Function.
 */
6330
#define NUM_PG_SETTINGS_ATTS	16
6331

6332 6333 6334
Datum
show_all_settings(PG_FUNCTION_ARGS)
{
B
Bruce Momjian 已提交
6335 6336 6337 6338 6339 6340
	FuncCallContext *funcctx;
	TupleDesc	tupdesc;
	int			call_cntr;
	int			max_calls;
	AttInMetadata *attinmeta;
	MemoryContext oldcontext;
6341 6342

	/* stuff done only on the first call of the function */
B
Bruce Momjian 已提交
6343 6344
	if (SRF_IS_FIRSTCALL())
	{
6345
		/* create a function context for cross-call persistence */
B
Bruce Momjian 已提交
6346
		funcctx = SRF_FIRSTCALL_INIT();
6347

B
Bruce Momjian 已提交
6348
		/*
B
Bruce Momjian 已提交
6349
		 * switch to memory context appropriate for multiple function calls
B
Bruce Momjian 已提交
6350
		 */
6351 6352
		oldcontext = MemoryContextSwitchTo(funcctx->multi_call_memory_ctx);

6353
		/*
B
Bruce Momjian 已提交
6354 6355
		 * need a tuple descriptor representing NUM_PG_SETTINGS_ATTS columns
		 * of the appropriate types
6356 6357
		 */
		tupdesc = CreateTemplateTupleDesc(NUM_PG_SETTINGS_ATTS, false);
6358
		TupleDescInitEntry(tupdesc, (AttrNumber) 1, "name",
6359
						   TEXTOID, -1, 0);
6360
		TupleDescInitEntry(tupdesc, (AttrNumber) 2, "setting",
6361
						   TEXTOID, -1, 0);
6362 6363 6364
		TupleDescInitEntry(tupdesc, (AttrNumber) 3, "unit",
						   TEXTOID, -1, 0);
		TupleDescInitEntry(tupdesc, (AttrNumber) 4, "category",
6365
						   TEXTOID, -1, 0);
6366
		TupleDescInitEntry(tupdesc, (AttrNumber) 5, "short_desc",
6367
						   TEXTOID, -1, 0);
6368
		TupleDescInitEntry(tupdesc, (AttrNumber) 6, "extra_desc",
6369
						   TEXTOID, -1, 0);
6370
		TupleDescInitEntry(tupdesc, (AttrNumber) 7, "context",
6371
						   TEXTOID, -1, 0);
6372
		TupleDescInitEntry(tupdesc, (AttrNumber) 8, "vartype",
6373
						   TEXTOID, -1, 0);
6374
		TupleDescInitEntry(tupdesc, (AttrNumber) 9, "source",
6375
						   TEXTOID, -1, 0);
6376
		TupleDescInitEntry(tupdesc, (AttrNumber) 10, "min_val",
6377
						   TEXTOID, -1, 0);
6378
		TupleDescInitEntry(tupdesc, (AttrNumber) 11, "max_val",
6379
						   TEXTOID, -1, 0);
6380
		TupleDescInitEntry(tupdesc, (AttrNumber) 12, "enumvals",
6381
						   TEXTARRAYOID, -1, 0);
6382 6383 6384 6385 6386
 		TupleDescInitEntry(tupdesc, (AttrNumber) 13, "boot_val",
 						   TEXTOID, -1, 0);
 		TupleDescInitEntry(tupdesc, (AttrNumber) 14, "reset_val",
 						   TEXTOID, -1, 0);
		TupleDescInitEntry(tupdesc, (AttrNumber) 15, "sourcefile",
6387
						   TEXTOID, -1, 0);
6388
		TupleDescInitEntry(tupdesc, (AttrNumber) 16, "sourceline",
6389
						   INT4OID, -1, 0);
6390 6391

		/*
B
Bruce Momjian 已提交
6392 6393
		 * Generate attribute metadata needed later to produce tuples from raw
		 * C strings
6394 6395 6396 6397 6398 6399
		 */
		attinmeta = TupleDescGetAttInMetadata(tupdesc);
		funcctx->attinmeta = attinmeta;

		/* total number of tuples to be returned */
		funcctx->max_calls = GetNumConfigOptions();
6400 6401

		MemoryContextSwitchTo(oldcontext);
B
Bruce Momjian 已提交
6402
	}
6403 6404

	/* stuff done on every call of the function */
B
Bruce Momjian 已提交
6405
	funcctx = SRF_PERCALL_SETUP();
6406 6407 6408 6409 6410

	call_cntr = funcctx->call_cntr;
	max_calls = funcctx->max_calls;
	attinmeta = funcctx->attinmeta;

B
Bruce Momjian 已提交
6411 6412
	if (call_cntr < max_calls)	/* do when there is more left to send */
	{
6413
		char	   *values[NUM_PG_SETTINGS_ATTS];
6414 6415 6416 6417 6418 6419 6420 6421 6422
		bool		noshow;
		HeapTuple	tuple;
		Datum		result;

		/*
		 * Get the next visible GUC variable name and value
		 */
		do
		{
6423
			GetConfigOptionByNum(call_cntr, (const char **) values, &noshow);
6424 6425 6426 6427 6428 6429 6430
			if (noshow)
			{
				/* bump the counter and get the next config setting */
				call_cntr = ++funcctx->call_cntr;

				/* make sure we haven't gone too far now */
				if (call_cntr >= max_calls)
B
Bruce Momjian 已提交
6431
					SRF_RETURN_DONE(funcctx);
6432 6433 6434 6435 6436 6437 6438
			}
		} while (noshow);

		/* build a tuple */
		tuple = BuildTupleFromCStrings(attinmeta, values);

		/* make the tuple into a datum */
6439
		result = HeapTupleGetDatum(tuple);
6440

B
Bruce Momjian 已提交
6441 6442 6443
		SRF_RETURN_NEXT(funcctx, result);
	}
	else
6444 6445
	{
		/* do when there is no more left */
B
Bruce Momjian 已提交
6446
		SRF_RETURN_DONE(funcctx);
6447
	}
6448 6449
}

6450
static char *
6451
_ShowOption(struct config_generic * record, bool use_units)
6452 6453 6454
{
	char		buffer[256];
	const char *val;
6455

6456 6457 6458 6459 6460
	switch (record->vartype)
	{
		case PGC_BOOL:
			{
				struct config_bool *conf = (struct config_bool *) record;
6461

6462 6463 6464 6465 6466 6467 6468 6469 6470 6471 6472 6473 6474 6475 6476
				if (conf->show_hook)
					val = (*conf->show_hook) ();
				else
					val = *conf->variable ? "on" : "off";
			}
			break;

		case PGC_INT:
			{
				struct config_int *conf = (struct config_int *) record;

				if (conf->show_hook)
					val = (*conf->show_hook) ();
				else
				{
6477 6478 6479 6480 6481 6482 6483 6484 6485
					/*
					 * Use int64 arithmetic to avoid overflows in units
					 * conversion.  If INT64_IS_BUSTED we might overflow
					 * anyway and print bogus answers, but there are few
					 * enough such machines that it doesn't seem worth
					 * trying harder.
					 */
					int64		result = *conf->variable;
					const char *unit;
6486

6487 6488
					if (use_units && result > 0 &&
						(record->flags & GUC_UNIT_MEMORY))
6489
					{
6490 6491 6492
						switch (record->flags & GUC_UNIT_MEMORY)
						{
							case GUC_UNIT_BLOCKS:
B
Bruce Momjian 已提交
6493
								result *= BLCKSZ / 1024;
6494 6495
								break;
							case GUC_UNIT_XBLOCKS:
B
Bruce Momjian 已提交
6496
								result *= XLOG_BLCKSZ / 1024;
6497 6498
								break;
						}
6499 6500 6501 6502

						if (result % KB_PER_GB == 0)
						{
							result /= KB_PER_GB;
6503
							unit = "GB";
6504 6505 6506 6507
						}
						else if (result % KB_PER_MB == 0)
						{
							result /= KB_PER_MB;
6508
							unit = "MB";
6509 6510 6511
						}
						else
						{
6512
							unit = "kB";
6513 6514
						}
					}
6515 6516
					else if (use_units && result > 0 &&
							 (record->flags & GUC_UNIT_TIME))
6517
					{
6518 6519 6520 6521 6522 6523 6524 6525 6526
						switch (record->flags & GUC_UNIT_TIME)
						{
							case GUC_UNIT_S:
								result *= MS_PER_S;
								break;
							case GUC_UNIT_MIN:
								result *= MS_PER_MIN;
								break;
						}
6527 6528 6529 6530

						if (result % MS_PER_D == 0)
						{
							result /= MS_PER_D;
6531
							unit = "d";
6532 6533 6534 6535
						}
						else if (result % MS_PER_H == 0)
						{
							result /= MS_PER_H;
6536
							unit = "h";
6537 6538 6539 6540
						}
						else if (result % MS_PER_MIN == 0)
						{
							result /= MS_PER_MIN;
6541
							unit = "min";
6542 6543 6544 6545
						}
						else if (result % MS_PER_S == 0)
						{
							result /= MS_PER_S;
6546
							unit = "s";
6547 6548 6549
						}
						else
						{
6550
							unit = "ms";
6551 6552 6553
						}
					}
					else
6554
						unit = "";
6555

6556 6557
					snprintf(buffer, sizeof(buffer), INT64_FORMAT "%s",
							 result, unit);
6558 6559 6560 6561 6562 6563 6564 6565 6566 6567 6568 6569 6570 6571 6572 6573 6574 6575 6576 6577 6578 6579 6580
					val = buffer;
				}
			}
			break;

		case PGC_REAL:
			{
				struct config_real *conf = (struct config_real *) record;

				if (conf->show_hook)
					val = (*conf->show_hook) ();
				else
				{
					snprintf(buffer, sizeof(buffer), "%g",
							 *conf->variable);
					val = buffer;
				}
			}
			break;

		case PGC_STRING:
			{
				struct config_string *conf = (struct config_string *) record;
6581

6582 6583 6584 6585 6586
				if (conf->show_hook)
					val = (*conf->show_hook) ();
				else if (*conf->variable && **conf->variable)
					val = *conf->variable;
				else
6587
					val = "";
6588 6589
			}
			break;
6590

6591 6592 6593 6594 6595 6596 6597
		case PGC_ENUM:
			{
				struct config_enum *conf = (struct config_enum *) record;

				if(conf->show_hook)
					val = (*conf->show_hook) ();
				else
6598
					val = config_enum_lookup_by_value(conf, *conf->variable);
6599 6600 6601
			}
			break;

6602 6603 6604 6605 6606
		default:
			/* just to keep compiler quiet */
			val = "???";
			break;
	}
6607

6608
	return pstrdup(val);
6609
}
6610 6611


6612 6613 6614 6615 6616 6617 6618
/*
 * Attempt (badly) to detect if a proposed new GUC setting is the same
 * as the current value.
 *
 * XXX this does not really work because it doesn't account for the
 * effects of canonicalization of string values by assign_hooks.
 */
6619
static bool
B
Bruce Momjian 已提交
6620
is_newvalue_equal(struct config_generic * record, const char *newvalue)
6621
{
6622 6623 6624
	/* newvalue == NULL isn't supported */
	Assert(newvalue != NULL);

6625 6626 6627
	switch (record->vartype)
	{
		case PGC_BOOL:
B
Bruce Momjian 已提交
6628 6629 6630
			{
				struct config_bool *conf = (struct config_bool *) record;
				bool		newval;
6631

6632 6633
				return parse_bool(newvalue, &newval)
					&& *conf->variable == newval;
B
Bruce Momjian 已提交
6634
			}
6635
		case PGC_INT:
B
Bruce Momjian 已提交
6636 6637 6638
			{
				struct config_int *conf = (struct config_int *) record;
				int			newval;
6639

6640 6641
				return parse_int(newvalue, &newval, record->flags, NULL)
					&& *conf->variable == newval;
B
Bruce Momjian 已提交
6642
			}
6643
		case PGC_REAL:
B
Bruce Momjian 已提交
6644 6645 6646
			{
				struct config_real *conf = (struct config_real *) record;
				double		newval;
6647

6648 6649
				return parse_real(newvalue, &newval)
					&& *conf->variable == newval;
B
Bruce Momjian 已提交
6650
			}
6651
		case PGC_STRING:
B
Bruce Momjian 已提交
6652 6653
			{
				struct config_string *conf = (struct config_string *) record;
6654

6655 6656
				return *conf->variable != NULL &&
					strcmp(*conf->variable, newvalue) == 0;
B
Bruce Momjian 已提交
6657
			}
6658 6659 6660 6661 6662 6663

		case PGC_ENUM:
			{
				struct config_enum *conf = (struct config_enum *) record;
				int			newval;

A
Alvaro Herrera 已提交
6664 6665
				return config_enum_lookup_by_name(conf, newvalue, &newval) &&
					*conf->variable == newval;
6666
			}
6667 6668 6669 6670 6671 6672
	}

	return false;
}


B
Bruce Momjian 已提交
6673
#ifdef EXEC_BACKEND
6674

B
Bruce Momjian 已提交
6675
/*
6676
 *	These routines dump out all non-default GUC options into a binary
B
Bruce Momjian 已提交
6677 6678 6679 6680 6681 6682
 *	file that is read by all exec'ed backends.  The format is:
 *
 *		variable name, string, null terminated
 *		variable value, string, null terminated
 *		variable source, integer
 */
6683 6684 6685 6686 6687 6688 6689 6690 6691 6692 6693 6694 6695 6696 6697 6698 6699 6700 6701 6702 6703 6704 6705 6706 6707 6708 6709 6710 6711 6712 6713 6714 6715 6716 6717 6718 6719 6720 6721 6722 6723 6724 6725 6726 6727 6728 6729 6730 6731 6732 6733 6734 6735 6736 6737 6738 6739 6740 6741 6742 6743 6744
static void
write_one_nondefault_variable(FILE *fp, struct config_generic *gconf)
{
	if (gconf->source == PGC_S_DEFAULT)
		return;

	fprintf(fp, "%s", gconf->name);
	fputc(0, fp);

	switch (gconf->vartype)
	{
		case PGC_BOOL:
		{
			struct config_bool *conf = (struct config_bool *) gconf;

			if (*conf->variable)
				fprintf(fp, "true");
			else
				fprintf(fp, "false");
		}
		break;

		case PGC_INT:
		{
			struct config_int *conf = (struct config_int *) gconf;

			fprintf(fp, "%d", *conf->variable);
		}
		break;

		case PGC_REAL:
		{
			struct config_real *conf = (struct config_real *) gconf;

			/* Could lose precision here? */
			fprintf(fp, "%f", *conf->variable);
		}
		break;

		case PGC_STRING:
		{
			struct config_string *conf = (struct config_string *) gconf;

			fprintf(fp, "%s", *conf->variable);
		}
		break;

		case PGC_ENUM:
		{
			struct config_enum *conf = (struct config_enum *) gconf;
						
			fprintf(fp, "%s",
					config_enum_lookup_by_value(conf, *conf->variable));
		}
		break;
	}

	fputc(0, fp);

	fwrite(&gconf->source, sizeof(gconf->source), 1, fp);
}

B
Bruce Momjian 已提交
6745 6746 6747
void
write_nondefault_variables(GucContext context)
{
6748 6749
	int			elevel;
	FILE	   *fp;
6750 6751
	struct config_generic *cvc_conf;
	int			i;
B
Bruce Momjian 已提交
6752 6753

	Assert(context == PGC_POSTMASTER || context == PGC_SIGHUP);
6754 6755

	elevel = (context == PGC_SIGHUP) ? LOG : ERROR;
B
Bruce Momjian 已提交
6756 6757 6758 6759

	/*
	 * Open file
	 */
6760
	fp = AllocateFile(CONFIG_EXEC_PARAMS_NEW, "w");
6761 6762
	if (!fp)
	{
6763 6764
		ereport(elevel,
				(errcode_for_file_access(),
6765 6766
				 errmsg("could not write to file \"%s\": %m",
						CONFIG_EXEC_PARAMS_NEW)));
B
Bruce Momjian 已提交
6767 6768 6769
		return;
	}

6770 6771 6772 6773 6774 6775 6776 6777
	/*
	 * custom_variable_classes must be written out first; otherwise we might
	 * reject custom variable values while reading the file.
	 */
	cvc_conf = find_option("custom_variable_classes", false, ERROR);
	if (cvc_conf)
		write_one_nondefault_variable(fp, cvc_conf);

B
Bruce Momjian 已提交
6778 6779 6780 6781
	for (i = 0; i < num_guc_variables; i++)
	{
		struct config_generic *gconf = guc_variables[i];

6782 6783
		if (gconf != cvc_conf)
			write_one_nondefault_variable(fp, gconf);
B
Bruce Momjian 已提交
6784 6785
	}

6786 6787 6788 6789
	if (FreeFile(fp))
	{
		ereport(elevel,
				(errcode_for_file_access(),
6790 6791
				 errmsg("could not write to file \"%s\": %m",
						CONFIG_EXEC_PARAMS_NEW)));
6792 6793 6794
		return;
	}

6795
	/*
B
Bruce Momjian 已提交
6796 6797
	 * Put new file in place.  This could delay on Win32, but we don't hold
	 * any exclusive locks.
6798
	 */
6799
	rename(CONFIG_EXEC_PARAMS_NEW, CONFIG_EXEC_PARAMS);
B
Bruce Momjian 已提交
6800 6801 6802 6803 6804 6805 6806 6807 6808 6809 6810
}


/*
 *	Read string, including null byte from file
 *
 *	Return NULL on EOF and nothing read
 */
static char *
read_string_with_null(FILE *fp)
{
6811 6812 6813 6814
	int			i = 0,
				ch,
				maxlen = 256;
	char	   *str = NULL;
B
Bruce Momjian 已提交
6815 6816 6817 6818 6819 6820 6821 6822

	do
	{
		if ((ch = fgetc(fp)) == EOF)
		{
			if (i == 0)
				return NULL;
			else
6823
				elog(FATAL, "invalid format of exec config params file");
B
Bruce Momjian 已提交
6824 6825
		}
		if (i == 0)
6826
			str = guc_malloc(FATAL, maxlen);
B
Bruce Momjian 已提交
6827
		else if (i == maxlen)
6828
			str = guc_realloc(FATAL, str, maxlen *= 2);
B
Bruce Momjian 已提交
6829 6830 6831 6832 6833 6834 6835 6836 6837 6838 6839 6840 6841 6842
		str[i++] = ch;
	} while (ch != 0);

	return str;
}


/*
 *	This routine loads a previous postmaster dump of its non-default
 *	settings.
 */
void
read_nondefault_variables(void)
{
6843 6844 6845 6846
	FILE	   *fp;
	char	   *varname,
			   *varvalue;
	int			varsource;
B
Bruce Momjian 已提交
6847 6848 6849 6850

	/*
	 * Open file
	 */
6851
	fp = AllocateFile(CONFIG_EXEC_PARAMS, "r");
6852 6853 6854 6855
	if (!fp)
	{
		/* File not found is fine */
		if (errno != ENOENT)
6856 6857
			ereport(FATAL,
					(errcode_for_file_access(),
6858 6859
					 errmsg("could not read from file \"%s\": %m",
							CONFIG_EXEC_PARAMS)));
B
Bruce Momjian 已提交
6860
		return;
6861
	}
B
Bruce Momjian 已提交
6862

6863
	for (;;)
B
Bruce Momjian 已提交
6864
	{
6865 6866
		struct config_generic *record;

B
Bruce Momjian 已提交
6867 6868 6869
		if ((varname = read_string_with_null(fp)) == NULL)
			break;

6870
		if ((record = find_option(varname, true, FATAL)) == NULL)
B
Bruce Momjian 已提交
6871
			elog(FATAL, "failed to locate variable %s in exec config params file", varname);
B
Bruce Momjian 已提交
6872
		if ((varvalue = read_string_with_null(fp)) == NULL)
6873
			elog(FATAL, "invalid format of exec config params file");
6874
		if (fread(&varsource, sizeof(varsource), 1, fp) == 0)
6875
			elog(FATAL, "invalid format of exec config params file");
B
Bruce Momjian 已提交
6876

6877
		(void) set_config_option(varname, varvalue, record->context,
6878
								 varsource, GUC_ACTION_SET, true);
B
Bruce Momjian 已提交
6879 6880 6881 6882 6883 6884
		free(varname);
		free(varvalue);
	}

	FreeFile(fp);
}
B
Bruce Momjian 已提交
6885
#endif   /* EXEC_BACKEND */
B
Bruce Momjian 已提交
6886 6887


6888 6889 6890 6891 6892 6893 6894 6895
/*
 * A little "long argument" simulation, although not quite GNU
 * compliant. Takes a string of the form "some-option=some value" and
 * returns name = "some_option" and value = "some value" in malloc'ed
 * storage. Note that '-' is converted to '_' in the option name. If
 * there is no '=' in the input string then value will be NULL.
 */
void
B
Bruce Momjian 已提交
6896
ParseLongOption(const char *string, char **name, char **value)
6897
{
B
Bruce Momjian 已提交
6898 6899
	size_t		equal_pos;
	char	   *cp;
6900 6901 6902 6903 6904 6905 6906 6907 6908

	AssertArg(string);
	AssertArg(name);
	AssertArg(value);

	equal_pos = strcspn(string, "=");

	if (string[equal_pos] == '=')
	{
6909
		*name = guc_malloc(FATAL, equal_pos + 1);
6910
		strlcpy(*name, string, equal_pos + 1);
6911

6912
		*value = guc_strdup(FATAL, &string[equal_pos + 1]);
6913
	}
B
Bruce Momjian 已提交
6914
	else
6915
	{
6916
		/* no equal sign in string */
6917
		*name = guc_strdup(FATAL, string);
6918 6919 6920
		*value = NULL;
	}

B
Bruce Momjian 已提交
6921
	for (cp = *name; *cp; cp++)
6922 6923 6924
		if (*cp == '-')
			*cp = '_';
}
6925 6926


6927
/*
6928
 * Handle options fetched from pg_database.datconfig, pg_authid.rolconfig,
B
Bruce Momjian 已提交
6929
 * pg_proc.proconfig, etc.	Caller must specify proper context/source/action.
6930
 *
6931
 * The array parameter must be an array of TEXT (it must not be NULL).
6932
 */
6933
void
6934
ProcessGUCArray(ArrayType *array,
6935
				GucContext context, GucSource source, GucAction action)
6936
{
B
Bruce Momjian 已提交
6937
	int			i;
6938

6939
	Assert(array != NULL);
6940 6941 6942
	Assert(ARR_ELEMTYPE(array) == TEXTOID);
	Assert(ARR_NDIM(array) == 1);
	Assert(ARR_LBOUND(array)[0] == 1);
6943 6944 6945 6946 6947 6948 6949 6950 6951 6952

	for (i = 1; i <= ARR_DIMS(array)[0]; i++)
	{
		Datum		d;
		bool		isnull;
		char	   *s;
		char	   *name;
		char	   *value;

		d = array_ref(array, 1, &i,
B
Bruce Momjian 已提交
6953 6954 6955 6956
					  -1 /* varlenarray */ ,
					  -1 /* TEXT's typlen */ ,
					  false /* TEXT's typbyval */ ,
					  'i' /* TEXT's typalign */ ,
6957 6958 6959 6960 6961
					  &isnull);

		if (isnull)
			continue;

6962
		s = TextDatumGetCString(d);
6963

6964 6965 6966
		ParseLongOption(s, &name, &value);
		if (!value)
		{
6967 6968
			ereport(WARNING,
					(errcode(ERRCODE_SYNTAX_ERROR),
6969 6970
					 errmsg("could not parse setting for parameter \"%s\"",
							name)));
6971
			free(name);
B
Bruce Momjian 已提交
6972
			continue;
6973 6974
		}

6975
		(void) set_config_option(name, value, context, source, action, true);
6976 6977 6978 6979

		free(name);
		if (value)
			free(value);
6980 6981 6982 6983
	}
}


6984 6985 6986 6987
/*
 * Add an entry to an option array.  The array parameter may be NULL
 * to indicate the current table entry is NULL.
 */
6988 6989 6990
ArrayType *
GUCArrayAdd(ArrayType *array, const char *name, const char *value)
{
6991
	const char *varname;
6992 6993 6994 6995 6996 6997 6998 6999 7000 7001
	Datum		datum;
	char	   *newval;
	ArrayType  *a;

	Assert(name);
	Assert(value);

	/* test if the option is valid */
	set_config_option(name, value,
					  superuser() ? PGC_SUSET : PGC_USERSET,
7002
					  PGC_S_TEST, GUC_ACTION_SET, false);
7003

7004 7005 7006 7007
	/* convert name to canonical spelling, so we can use plain strcmp */
	(void) GetConfigOptionByName(name, &varname);
	name = varname;

7008 7009
	newval = palloc(strlen(name) + 1 + strlen(value) + 1);
	sprintf(newval, "%s=%s", name, value);
7010
	datum = CStringGetTextDatum(newval);
B
Bruce Momjian 已提交
7011

7012 7013
	if (array)
	{
B
Bruce Momjian 已提交
7014 7015 7016
		int			index;
		bool		isnull;
		int			i;
7017

7018 7019 7020 7021
		Assert(ARR_ELEMTYPE(array) == TEXTOID);
		Assert(ARR_NDIM(array) == 1);
		Assert(ARR_LBOUND(array)[0] == 1);

B
Bruce Momjian 已提交
7022
		index = ARR_DIMS(array)[0] + 1; /* add after end */
7023 7024 7025 7026 7027 7028 7029

		for (i = 1; i <= ARR_DIMS(array)[0]; i++)
		{
			Datum		d;
			char	   *current;

			d = array_ref(array, 1, &i,
B
Bruce Momjian 已提交
7030 7031 7032 7033
						  -1 /* varlenarray */ ,
						  -1 /* TEXT's typlen */ ,
						  false /* TEXT's typbyval */ ,
						  'i' /* TEXT's typalign */ ,
7034
						  &isnull);
7035 7036
			if (isnull)
				continue;
7037
			current = TextDatumGetCString(d);
B
Bruce Momjian 已提交
7038
			if (strncmp(current, newval, strlen(name) + 1) == 0)
7039 7040 7041 7042 7043 7044
			{
				index = i;
				break;
			}
		}

7045 7046
		a = array_set(array, 1, &index,
					  datum,
7047 7048
					  false,
					  -1 /* varlena array */ ,
B
Bruce Momjian 已提交
7049 7050
					  -1 /* TEXT's typlen */ ,
					  false /* TEXT's typbyval */ ,
7051
					  'i' /* TEXT's typalign */ );
7052 7053
	}
	else
7054 7055 7056
		a = construct_array(&datum, 1,
							TEXTOID,
							-1, false, 'i');
7057 7058 7059 7060 7061

	return a;
}


7062 7063 7064 7065 7066
/*
 * Delete an entry from an option array.  The array parameter may be NULL
 * to indicate the current table entry is NULL.  Also, if the return value
 * is NULL then a null should be stored.
 */
7067 7068 7069
ArrayType *
GUCArrayDelete(ArrayType *array, const char *name)
{
7070
	const char *varname;
B
Bruce Momjian 已提交
7071 7072 7073
	ArrayType  *newarray;
	int			i;
	int			index;
7074 7075 7076 7077 7078 7079

	Assert(name);

	/* test if the option is valid */
	set_config_option(name, NULL,
					  superuser() ? PGC_SUSET : PGC_USERSET,
7080
					  PGC_S_TEST, GUC_ACTION_SET, false);
7081

7082 7083 7084 7085
	/* convert name to canonical spelling, so we can use plain strcmp */
	(void) GetConfigOptionByName(name, &varname);
	name = varname;

7086 7087 7088 7089 7090
	/* if array is currently null, then surely nothing to delete */
	if (!array)
		return NULL;

	newarray = NULL;
7091 7092 7093 7094 7095 7096 7097 7098 7099
	index = 1;

	for (i = 1; i <= ARR_DIMS(array)[0]; i++)
	{
		Datum		d;
		char	   *val;
		bool		isnull;

		d = array_ref(array, 1, &i,
B
Bruce Momjian 已提交
7100 7101 7102 7103
					  -1 /* varlenarray */ ,
					  -1 /* TEXT's typlen */ ,
					  false /* TEXT's typbyval */ ,
					  'i' /* TEXT's typalign */ ,
7104
					  &isnull);
7105 7106
		if (isnull)
			continue;
7107
		val = TextDatumGetCString(d);
7108

7109
		/* ignore entry if it's what we want to delete */
B
Bruce Momjian 已提交
7110
		if (strncmp(val, name, strlen(name)) == 0
7111 7112 7113
			&& val[strlen(name)] == '=')
			continue;

7114 7115 7116 7117 7118
		/* else add it to the output array */
		if (newarray)
		{
			newarray = array_set(newarray, 1, &index,
								 d,
7119
								 false,
7120 7121 7122
								 -1 /* varlenarray */ ,
								 -1 /* TEXT's typlen */ ,
								 false /* TEXT's typbyval */ ,
7123
								 'i' /* TEXT's typalign */ );
7124 7125 7126 7127 7128 7129
		}
		else
			newarray = construct_array(&d, 1,
									   TEXTOID,
									   -1, false, 'i');

7130 7131 7132 7133 7134
		index++;
	}

	return newarray;
}
7135

7136 7137

/*
7138
 * assign_hook and show_hook subroutines
7139 7140
 */

7141 7142 7143
static const char *
assign_log_destination(const char *value, bool doit, GucSource source)
{
B
Bruce Momjian 已提交
7144 7145 7146 7147 7148
	char	   *rawstring;
	List	   *elemlist;
	ListCell   *l;
	int			newlogdest = 0;

7149 7150 7151 7152
	/* Need a modifiable copy of string */
	rawstring = pstrdup(value);

	/* Parse string into list of identifiers */
B
Bruce Momjian 已提交
7153
	if (!SplitIdentifierString(rawstring, ',', &elemlist))
7154 7155 7156
	{
		/* syntax error in list */
		pfree(rawstring);
7157
		list_free(elemlist);
7158 7159
		ereport(GUC_complaint_elevel(source),
				(errcode(ERRCODE_INVALID_PARAMETER_VALUE),
B
Bruce Momjian 已提交
7160
			errmsg("invalid list syntax for parameter \"log_destination\"")));
7161 7162 7163 7164 7165
		return NULL;
	}

	foreach(l, elemlist)
	{
B
Bruce Momjian 已提交
7166 7167 7168
		char	   *tok = (char *) lfirst(l);

		if (pg_strcasecmp(tok, "stderr") == 0)
7169
			newlogdest |= LOG_DESTINATION_STDERR;
7170
		else if (pg_strcasecmp(tok, "csvlog") == 0)
B
Bruce Momjian 已提交
7171
			newlogdest |= LOG_DESTINATION_CSVLOG;
7172
#ifdef HAVE_SYSLOG
B
Bruce Momjian 已提交
7173
		else if (pg_strcasecmp(tok, "syslog") == 0)
7174 7175 7176
			newlogdest |= LOG_DESTINATION_SYSLOG;
#endif
#ifdef WIN32
B
Bruce Momjian 已提交
7177
		else if (pg_strcasecmp(tok, "eventlog") == 0)
7178 7179
			newlogdest |= LOG_DESTINATION_EVENTLOG;
#endif
B
Bruce Momjian 已提交
7180 7181
		else
		{
7182 7183
			ereport(GUC_complaint_elevel(source),
					(errcode(ERRCODE_INVALID_PARAMETER_VALUE),
B
Bruce Momjian 已提交
7184 7185
				  errmsg("unrecognized \"log_destination\" key word: \"%s\"",
						 tok)));
7186
			pfree(rawstring);
7187
			list_free(elemlist);
7188 7189 7190 7191
			return NULL;
		}
	}

7192 7193 7194
	if (doit)
		Log_destination = newlogdest;

7195
	pfree(rawstring);
7196
	list_free(elemlist);
7197 7198 7199 7200

	return value;
}

7201 7202
#ifdef HAVE_SYSLOG

7203 7204
static bool
assign_syslog_facility(int newval, bool doit, GucSource source)
7205
{
7206 7207
	if (doit)
		set_syslog_parameters(syslog_ident_str ? syslog_ident_str : "postgres",
7208
							  newval);
7209

7210
	return true;
7211
}
7212 7213 7214 7215 7216 7217 7218 7219 7220

static const char *
assign_syslog_ident(const char *ident, bool doit, GucSource source)
{
	if (doit)
		set_syslog_parameters(ident, syslog_facility);

	return ident;
}
B
Bruce Momjian 已提交
7221
#endif   /* HAVE_SYSLOG */
7222 7223


7224 7225
static bool
assign_session_replication_role(int newval, bool doit, GucSource source)
7226
{
7227 7228 7229 7230
	/*
	 * Must flush the plan cache when changing replication role; but don't
	 * flush unnecessarily.
	 */
7231
	if (doit && SessionReplicationRole != newval)
7232 7233 7234 7235
	{
		ResetPlanCache();
	}

7236
	return true;
7237 7238
}

7239 7240 7241 7242
static const char *
show_num_temp_buffers(void)
{
	/*
B
Bruce Momjian 已提交
7243 7244
	 * We show the GUC var until local buffers have been initialized, and
	 * NLocBuffer afterwards.
7245 7246 7247 7248 7249 7250 7251
	 */
	static char nbuf[32];

	sprintf(nbuf, "%d", NLocBuffer ? NLocBuffer : num_temp_buffers);
	return nbuf;
}

7252
static bool
7253
assign_phony_autocommit(bool newval, bool doit, GucSource source)
7254 7255 7256
{
	if (!newval)
	{
7257 7258 7259
		ereport(GUC_complaint_elevel(source),
				(errcode(ERRCODE_FEATURE_NOT_SUPPORTED),
				 errmsg("SET AUTOCOMMIT TO OFF is no longer supported")));
7260 7261 7262 7263 7264
		return false;
	}
	return true;
}

7265 7266 7267
static const char *
assign_custom_variable_classes(const char *newval, bool doit, GucSource source)
{
B
Bruce Momjian 已提交
7268 7269
	/*
	 * Check syntax. newval must be a comma separated list of identifiers.
7270
	 * Whitespace is allowed but removed from the result.
7271
	 */
B
Bruce Momjian 已提交
7272
	bool		hasSpaceAfterToken = false;
7273
	const char *cp = newval;
B
Bruce Momjian 已提交
7274
	int			symLen = 0;
7275
	char		c;
7276 7277 7278
	StringInfoData buf;

	initStringInfo(&buf);
7279
	while ((c = *cp++) != '\0')
7280
	{
7281
		if (isspace((unsigned char) c))
7282
		{
B
Bruce Momjian 已提交
7283
			if (symLen > 0)
7284 7285 7286 7287
				hasSpaceAfterToken = true;
			continue;
		}

B
Bruce Momjian 已提交
7288
		if (c == ',')
7289
		{
7290
			if (symLen > 0)		/* terminate identifier */
7291 7292
			{
				appendStringInfoChar(&buf, ',');
7293
				symLen = 0;
7294
			}
7295
			hasSpaceAfterToken = false;
7296 7297 7298
			continue;
		}

7299
		if (hasSpaceAfterToken || !(isalnum((unsigned char) c) || c == '_'))
7300
		{
B
Bruce Momjian 已提交
7301
			/*
7302 7303
			 * Syntax error due to token following space after token or
			 * non-identifier character
7304
			 */
7305
			pfree(buf.data);
7306 7307
			return NULL;
		}
7308
		appendStringInfoChar(&buf, c);
7309 7310 7311
		symLen++;
	}

7312
	/* Remove stray ',' at end */
B
Bruce Momjian 已提交
7313
	if (symLen == 0 && buf.len > 0)
7314
		buf.data[--buf.len] = '\0';
7315

7316 7317
	/* GUC wants the result malloc'd */
	newval = guc_strdup(LOG, buf.data);
7318 7319 7320 7321

	pfree(buf.data);
	return newval;
}
7322

7323 7324 7325 7326 7327
static bool
assign_debug_assertions(bool newval, bool doit, GucSource source)
{
#ifndef USE_ASSERT_CHECKING
	if (newval)
7328 7329
	{
		ereport(GUC_complaint_elevel(source),
7330
				(errcode(ERRCODE_INVALID_PARAMETER_VALUE),
B
Bruce Momjian 已提交
7331
			   errmsg("assertion checking is not supported by this build")));
7332 7333
		return false;
	}
7334 7335 7336 7337
#endif
	return true;
}

7338 7339 7340 7341 7342
static bool
assign_ssl(bool newval, bool doit, GucSource source)
{
#ifndef USE_SSL
	if (newval)
7343 7344
	{
		ereport(GUC_complaint_elevel(source),
7345 7346
				(errcode(ERRCODE_INVALID_PARAMETER_VALUE),
				 errmsg("SSL is not supported by this build")));
7347 7348
		return false;
	}
7349 7350 7351 7352
#endif
	return true;
}

7353 7354 7355
static bool
assign_stage_log_stats(bool newval, bool doit, GucSource source)
{
7356
	if (newval && log_statement_stats)
7357
	{
7358 7359 7360
		ereport(GUC_complaint_elevel(source),
				(errcode(ERRCODE_INVALID_PARAMETER_VALUE),
				 errmsg("cannot enable parameter when \"log_statement_stats\" is true")));
7361
		/* source == PGC_S_OVERRIDE means do it anyway, eg at xact abort */
7362
		if (source != PGC_S_OVERRIDE)
7363
			return false;
7364 7365 7366 7367 7368 7369 7370
	}
	return true;
}

static bool
assign_log_stats(bool newval, bool doit, GucSource source)
{
7371 7372
	if (newval &&
		(log_parser_stats || log_planner_stats || log_executor_stats))
7373
	{
7374 7375 7376 7377 7378
		ereport(GUC_complaint_elevel(source),
				(errcode(ERRCODE_INVALID_PARAMETER_VALUE),
				 errmsg("cannot enable \"log_statement_stats\" when "
						"\"log_parser_stats\", \"log_planner_stats\", "
						"or \"log_executor_stats\" is true")));
7379
		/* source == PGC_S_OVERRIDE means do it anyway, eg at xact abort */
7380
		if (source != PGC_S_OVERRIDE)
7381
			return false;
7382 7383 7384 7385
	}
	return true;
}

7386 7387 7388
static bool
assign_transaction_read_only(bool newval, bool doit, GucSource source)
{
7389 7390 7391
	/* Can't go to r/w mode inside a r/o transaction */
	if (newval == false && XactReadOnly && IsSubTransaction())
	{
7392 7393 7394
		ereport(GUC_complaint_elevel(source),
				(errcode(ERRCODE_INVALID_PARAMETER_VALUE),
				 errmsg("cannot set transaction read-write mode inside a read-only transaction")));
7395
		/* source == PGC_S_OVERRIDE means do it anyway, eg at xact abort */
7396
		if (source != PGC_S_OVERRIDE)
7397
			return false;
7398
	}
7399 7400
	return true;
}
7401

7402 7403 7404 7405 7406
static const char *
assign_canonical_path(const char *newval, bool doit, GucSource source)
{
	if (doit)
	{
B
Bruce Momjian 已提交
7407 7408
		char	   *canon_val = guc_strdup(ERROR, newval);

7409 7410 7411 7412 7413 7414 7415
		canonicalize_path(canon_val);
		return canon_val;
	}
	else
		return newval;
}

7416 7417 7418
static const char *
assign_timezone_abbreviations(const char *newval, bool doit, GucSource source)
{
7419 7420 7421 7422
	/*
	 * The powerup value shown above for timezone_abbreviations is "UNKNOWN".
	 * When we see this we just do nothing.  If this value isn't overridden
	 * from the config file then pg_timezone_abbrev_initialize() will
B
Bruce Momjian 已提交
7423 7424 7425 7426 7427 7428 7429 7430
	 * eventually replace it with "Default".  This hack has two purposes: to
	 * avoid wasting cycles loading values that might soon be overridden from
	 * the config file, and to avoid trying to read the timezone abbrev files
	 * during InitializeGUCOptions().  The latter doesn't work in an
	 * EXEC_BACKEND subprocess because my_exec_path hasn't been set yet and so
	 * we can't locate PGSHAREDIR.  (Essentially the same hack is used to
	 * delay initializing TimeZone ... if we have any more, we should try to
	 * clean up and centralize this mechanism ...)
7431 7432 7433 7434 7435 7436
	 */
	if (strcmp(newval, "UNKNOWN") == 0)
	{
		return newval;
	}

7437
	/* Loading abbrev file is expensive, so only do it when value changes */
7438 7439
	if (timezone_abbreviations_string == NULL ||
		strcmp(timezone_abbreviations_string, newval) != 0)
7440
	{
B
Bruce Momjian 已提交
7441
		int			elevel;
7442 7443 7444

		/*
		 * If reading config file, only the postmaster should bleat loudly
B
Bruce Momjian 已提交
7445
		 * about problems.	Otherwise, it's just this one process doing it,
7446 7447 7448
		 * and we use WARNING message level.
		 */
		if (source == PGC_S_FILE)
7449
			elevel = IsUnderPostmaster ? DEBUG3 : LOG;
7450 7451 7452 7453 7454 7455 7456 7457
		else
			elevel = WARNING;
		if (!load_tzoffsets(newval, doit, elevel))
			return NULL;
	}
	return newval;
}

7458 7459 7460 7461 7462 7463 7464 7465 7466 7467 7468 7469 7470 7471 7472 7473
/*
 * pg_timezone_abbrev_initialize --- set default value if not done already
 *
 * This is called after initial loading of postgresql.conf.  If no
 * timezone_abbreviations setting was found therein, select default.
 */
void
pg_timezone_abbrev_initialize(void)
{
	if (strcmp(timezone_abbreviations_string, "UNKNOWN") == 0)
	{
		SetConfigOption("timezone_abbreviations", "Default",
						PGC_POSTMASTER, PGC_S_ARGV);
	}
}

7474 7475 7476 7477 7478 7479 7480 7481 7482
static const char *
show_archive_command(void)
{
	if (XLogArchiveMode)
		return XLogArchiveCommand;
	else
		return "(disabled)";
}

7483 7484 7485
static bool
assign_tcp_keepalives_idle(int newval, bool doit, GucSource source)
{
7486
	if (doit)
7487 7488 7489 7490 7491 7492 7493 7494
		return (pq_setkeepalivesidle(newval, MyProcPort) == STATUS_OK);

	return true;
}

static const char *
show_tcp_keepalives_idle(void)
{
7495 7496 7497
	static char nbuf[16];

	snprintf(nbuf, sizeof(nbuf), "%d", pq_getkeepalivesidle(MyProcPort));
7498 7499 7500 7501 7502 7503
	return nbuf;
}

static bool
assign_tcp_keepalives_interval(int newval, bool doit, GucSource source)
{
7504
	if (doit)
7505 7506 7507 7508 7509 7510 7511 7512
		return (pq_setkeepalivesinterval(newval, MyProcPort) == STATUS_OK);

	return true;
}

static const char *
show_tcp_keepalives_interval(void)
{
7513 7514 7515
	static char nbuf[16];

	snprintf(nbuf, sizeof(nbuf), "%d", pq_getkeepalivesinterval(MyProcPort));
7516 7517 7518 7519 7520 7521
	return nbuf;
}

static bool
assign_tcp_keepalives_count(int newval, bool doit, GucSource source)
{
7522
	if (doit)
7523 7524 7525 7526 7527 7528 7529 7530
		return (pq_setkeepalivescount(newval, MyProcPort) == STATUS_OK);

	return true;
}

static const char *
show_tcp_keepalives_count(void)
{
7531 7532 7533
	static char nbuf[16];

	snprintf(nbuf, sizeof(nbuf), "%d", pq_getkeepalivescount(MyProcPort));
7534 7535
	return nbuf;
}
7536

7537 7538 7539
static bool
assign_maxconnections(int newval, bool doit, GucSource source)
{
7540 7541
	if (newval + autovacuum_max_workers > INT_MAX / 4)
		return false;
7542

7543
	if (doit)
7544 7545 7546 7547 7548 7549 7550 7551
		MaxBackends = newval + autovacuum_max_workers;

	return true;
}

static bool
assign_autovacuum_max_workers(int newval, bool doit, GucSource source)
{
7552 7553
	if (newval + MaxConnections > INT_MAX / 4)
		return false;
7554

7555
	if (doit)
7556 7557 7558 7559
		MaxBackends = newval + MaxConnections;

	return true;
}
7560

7561 7562 7563 7564 7565 7566 7567 7568 7569 7570 7571 7572 7573 7574 7575 7576 7577 7578 7579 7580 7581 7582 7583 7584 7585 7586 7587 7588 7589 7590 7591 7592 7593 7594 7595 7596 7597 7598 7599 7600 7601 7602 7603 7604 7605 7606 7607 7608 7609 7610 7611 7612 7613 7614 7615
static bool
assign_effective_io_concurrency(int newval, bool doit, GucSource source)
{
#ifdef USE_PREFETCH
	double		new_prefetch_pages = 0.0;
	int			i;

	/*----------
	 * The user-visible GUC parameter is the number of drives (spindles),
	 * which we need to translate to a number-of-pages-to-prefetch target.
	 *
	 * The expected number of prefetch pages needed to keep N drives busy is:
	 *
	 * drives |   I/O requests
	 * -------+----------------
	 *      1 |   1
	 *      2 |   2/1 + 2/2 = 3
	 *      3 |   3/1 + 3/2 + 3/3 = 5 1/2
	 *      4 |   4/1 + 4/2 + 4/3 + 4/4 = 8 1/3
	 *      n |   n * H(n)
	 *
	 * This is called the "coupon collector problem" and H(n) is called the
	 * harmonic series.  This could be approximated by n * ln(n), but for
	 * reasonable numbers of drives we might as well just compute the series.
	 *
	 * Alternatively we could set the target to the number of pages necessary
	 * so that the expected number of active spindles is some arbitrary
	 * percentage of the total.  This sounds the same but is actually slightly
	 * different.  The result ends up being ln(1-P)/ln((n-1)/n) where P is
	 * that desired fraction.
	 *
	 * Experimental results show that both of these formulas aren't aggressive
	 * enough, but we don't really have any better proposals.
	 *
	 * Note that if newval = 0 (disabled), we must set target = 0.
	 *----------
	 */

	for (i = 1; i <= newval; i++)
		new_prefetch_pages += (double) newval / (double) i;

	/* This range check shouldn't fail, but let's be paranoid */
	if (new_prefetch_pages >= 0.0 && new_prefetch_pages < (double) INT_MAX)
	{
		if (doit)
			target_prefetch_pages = (int) rint(new_prefetch_pages);
		return true;
	}
	else
		return false;
#else
	return true;
#endif /* USE_PREFETCH */
}

7616 7617 7618 7619 7620 7621 7622 7623 7624 7625 7626 7627 7628 7629 7630 7631 7632 7633 7634 7635
static const char *
assign_pgstat_temp_directory(const char *newval, bool doit, GucSource source)
{
	if (doit)
	{
		if (pgstat_stat_tmpname)
			free(pgstat_stat_tmpname);
		if (pgstat_stat_filename)
			free(pgstat_stat_filename);

		pgstat_stat_tmpname = guc_malloc(FATAL, strlen(newval) + 12);  /* /pgstat.tmp */
		pgstat_stat_filename = guc_malloc(FATAL, strlen(newval) + 13); /* /pgstat.stat */

		sprintf(pgstat_stat_tmpname, "%s/pgstat.tmp", newval);
		sprintf(pgstat_stat_filename, "%s/pgstat.stat", newval);
	}

	return newval;
}

7636
#include "guc-file.c"