guc.c 137 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
 *
 *
Bruce Momjian's avatar
Bruce Momjian committed
9
 * Copyright (c) 2000-2004, PostgreSQL Global Development Group
10
 * Written by Peter Eisentraut <peter_e@gmx.net>.
11 12
 *
 * IDENTIFICATION
13
 *	  $PostgreSQL: pgsql/src/backend/utils/misc/guc.c,v 1.249 2004/11/14 19:35:33 tgl Exp $
14
 *
15 16 17 18
 *--------------------------------------------------------------------
 */
#include "postgres.h"

19
#include <ctype.h>
20 21 22
#include <float.h>
#include <limits.h>
#include <unistd.h>
23
#include <sys/stat.h>
24 25

#include "utils/guc.h"
26
#include "utils/guc_tables.h"
27

28
#include "catalog/namespace.h"
29
#include "catalog/pg_type.h"
30
#include "commands/async.h"
31
#include "commands/variable.h"
32
#include "commands/vacuum.h"
33
#include "executor/executor.h"
34
#include "fmgr.h"
35
#include "funcapi.h"
36
#include "libpq/auth.h"
37
#include "libpq/pqcomm.h"
38
#include "libpq/pqformat.h"
39
#include "mb/pg_wchar.h"
40 41 42 43
#include "miscadmin.h"
#include "optimizer/cost.h"
#include "optimizer/geqo.h"
#include "optimizer/paths.h"
44
#include "optimizer/prep.h"
45
#include "parser/parse_expr.h"
46
#include "parser/parse_relation.h"
47
#include "postmaster/bgwriter.h"
48
#include "postmaster/syslogger.h"
49
#include "postmaster/postmaster.h"
Jan Wieck's avatar
Jan Wieck committed
50
#include "storage/bufmgr.h"
51
#include "storage/fd.h"
52 53
#include "storage/freespace.h"
#include "storage/lock.h"
54 55
#include "storage/proc.h"
#include "tcop/tcopprot.h"
56 57
#include "utils/array.h"
#include "utils/builtins.h"
58
#include "utils/memutils.h"
59
#include "utils/pg_locale.h"
60
#include "pgstat.h"
61 62


63 64 65 66
#ifndef PG_KRB_SRVTAB
#define PG_KRB_SRVTAB ""
#endif

67 68 69
#define CONFIG_FILENAME	"postgresql.conf"
#define HBA_FILENAME	"pg_hba.conf"
#define IDENT_FILENAME	"pg_ident.conf"
70

Bruce Momjian's avatar
Bruce Momjian committed
71 72 73
#ifdef EXEC_BACKEND
#define CONFIG_EXEC_PARAMS "global/config_exec_params"
#endif
74 75

/* XXX these should appear in other modules' header files */
76
extern bool Log_disconnections;
77
extern DLLIMPORT bool check_function_bodies;
78 79
extern int	CommitDelay;
extern int	CommitSiblings;
80
extern int	DebugSharedBuffers;
81
extern char *default_tablespace;
82

83
static const char *assign_log_destination(const char *value,
Bruce Momjian's avatar
Bruce Momjian committed
84
					   bool doit, GucSource source);
85

Tatsuo Ishii's avatar
Tatsuo Ishii committed
86
#ifdef HAVE_SYSLOG
87
extern char *Syslog_facility;
88
extern char *Syslog_ident;
89

90
static const char *assign_facility(const char *facility,
91
				bool doit, GucSource source);
92
#endif
93

94 95 96
static const char *assign_defaultxactisolevel(const char *newval, bool doit,
						   GucSource source);
static const char *assign_log_min_messages(const char *newval, bool doit,
Bruce Momjian's avatar
Bruce Momjian committed
97
						GucSource source);
98
static const char *assign_client_min_messages(const char *newval,
99
						   bool doit, GucSource source);
100
static const char *assign_min_error_statement(const char *newval, bool doit,
101
						   GucSource source);
102
static const char *assign_msglvl(int *var, const char *newval, bool doit,
Bruce Momjian's avatar
Bruce Momjian committed
103
			  GucSource source);
104
static const char *assign_log_error_verbosity(const char *newval, bool doit,
105
						   GucSource source);
106
static const char *assign_log_statement(const char *newval, bool doit,
Bruce Momjian's avatar
Bruce Momjian committed
107
					 GucSource source);
108
static bool assign_phony_autocommit(bool newval, bool doit, GucSource source);
109
static const char *assign_custom_variable_classes(const char *newval, bool doit,
Bruce Momjian's avatar
Bruce Momjian committed
110
							   GucSource source);
111 112
static bool assign_stage_log_stats(bool newval, bool doit, GucSource source);
static bool assign_log_stats(bool newval, bool doit, GucSource source);
113
static bool assign_transaction_read_only(bool newval, bool doit, GucSource source);
114
static const char *assign_canonical_path(const char *newval, bool doit, GucSource source);
115

116

117 118
/*
 * GUC option variables that are exported from this module
119
 */
120
#ifdef USE_ASSERT_CHECKING
121
bool		assert_enabled = true;
122
#endif
Bruce Momjian's avatar
Bruce Momjian committed
123
bool		log_duration = false;
124 125 126 127
bool		Debug_print_plan = false;
bool		Debug_print_parse = false;
bool		Debug_print_rewritten = false;
bool		Debug_pretty_print = false;
128
bool		Explain_pretty_print = true;
129

Bruce Momjian's avatar
Bruce Momjian committed
130 131 132 133
bool		log_parser_stats = false;
bool		log_planner_stats = false;
bool		log_executor_stats = false;
bool		log_statement_stats = false;		/* this is sort of all
Bruce Momjian's avatar
Bruce Momjian committed
134
												 * three above together */
135
bool		log_btree_build_stats = false;
136

137
bool		SQL_inheritance = true;
138

139 140
bool		Australian_timezones = false;

141
bool		Password_encryption = true;
142

143 144
bool		default_with_oids = true;

145
int			log_min_error_statement = PANIC;
146
int			log_min_messages = NOTICE;
147
int			client_min_messages = NOTICE;
148

149
int			log_min_duration_statement = -1;
150

151 152 153 154
char	   *ConfigFileName;
char	   *HbaFileName;
char	   *IdentFileName;
char	   *external_pid_file;
155

156

157 158 159 160 161
/*
 * 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.
 */
162
static char *client_min_messages_str;
163 164
static char *log_min_messages_str;
static char *log_error_verbosity_str;
165
static char *log_statement_str;
166
static char *log_min_error_statement_str;
167
static char *log_destination_string;
168
static bool phony_autocommit;
169
static bool session_auth_is_superuser;
170 171 172 173
static double phony_random_seed;
static char *client_encoding_string;
static char *datestyle_string;
static char *default_iso_level_string;
174 175
static char *locale_collate;
static char *locale_ctype;
176
static char *regex_flavor_string;
177
static char *server_encoding_string;
178
static char *server_version_string;
179 180
static char *timezone_string;
static char *XactIsoLevel_string;
181
static char *data_directory;
182
static char *custom_variable_classes;
183 184 185 186 187
static int	max_function_args;
static int	max_index_keys;
static int	max_identifier_length;
static int	block_size;
static bool integer_datetimes;
Bruce Momjian's avatar
Bruce Momjian committed
188

189
/* should be static, but commands/variable.c needs to get at it */
Bruce Momjian's avatar
Bruce Momjian committed
190
char	   *session_authorization_string;
191

192

193
/*
194 195 196
 * Displayable names for context types (enum GucContext)
 *
 * Note: these strings are deliberately not localized.
197
 */
Bruce Momjian's avatar
Bruce Momjian committed
198
const char *const GucContext_Names[] =
199
{
Bruce Momjian's avatar
Bruce Momjian committed
200 201 202 203 204 205
	 /* PGC_INTERNAL */ "internal",
	 /* PGC_POSTMASTER */ "postmaster",
	 /* PGC_SIGHUP */ "sighup",
	 /* PGC_BACKEND */ "backend",
	 /* PGC_SUSET */ "superuser",
	 /* PGC_USERSET */ "user"
206 207 208 209 210 211
};

/*
 * Displayable names for source types (enum GucSource)
 *
 * Note: these strings are deliberately not localized.
Bruce Momjian's avatar
Bruce Momjian committed
212 213
 */
const char *const GucSource_Names[] =
214
{
Bruce Momjian's avatar
Bruce Momjian committed
215 216 217 218 219 220 221 222 223 224 225
	 /* 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"
226 227 228 229 230 231 232 233
};

/*
 * Displayable names for the groupings defined in enum config_group
 */
const char *const config_group_names[] =
{
	/* UNGROUPED */
234
	gettext_noop("Ungrouped"),
235 236
	/* FILE_LOCATIONS */
	gettext_noop("File Locations"),
237
	/* CONN_AUTH */
238
	gettext_noop("Connections and Authentication"),
239
	/* CONN_AUTH_SETTINGS */
240
	gettext_noop("Connections and Authentication / Connection Settings"),
241
	/* CONN_AUTH_SECURITY */
242
	gettext_noop("Connections and Authentication / Security and Authentication"),
243
	/* RESOURCES */
244
	gettext_noop("Resource Usage"),
245
	/* RESOURCES_MEM */
246
	gettext_noop("Resource Usage / Memory"),
247
	/* RESOURCES_FSM */
248
	gettext_noop("Resource Usage / Free Space Map"),
249
	/* RESOURCES_KERNEL */
250
	gettext_noop("Resource Usage / Kernel Resources"),
251
	/* WAL */
252
	gettext_noop("Write-Ahead Log"),
253
	/* WAL_SETTINGS */
254
	gettext_noop("Write-Ahead Log / Settings"),
255
	/* WAL_CHECKPOINTS */
256
	gettext_noop("Write-Ahead Log / Checkpoints"),
257
	/* QUERY_TUNING */
258
	gettext_noop("Query Tuning"),
259
	/* QUERY_TUNING_METHOD */
260
	gettext_noop("Query Tuning / Planner Method Configuration"),
261
	/* QUERY_TUNING_COST */
262
	gettext_noop("Query Tuning / Planner Cost Constants"),
263
	/* QUERY_TUNING_GEQO */
264
	gettext_noop("Query Tuning / Genetic Query Optimizer"),
265
	/* QUERY_TUNING_OTHER */
266
	gettext_noop("Query Tuning / Other Planner Options"),
267
	/* LOGGING */
268
	gettext_noop("Reporting and Logging"),
269 270
	/* LOGGING_WHERE */
	gettext_noop("Reporting and Logging / Where to Log"),
271
	/* LOGGING_WHEN */
272
	gettext_noop("Reporting and Logging / When to Log"),
273
	/* LOGGING_WHAT */
274
	gettext_noop("Reporting and Logging / What to Log"),
275
	/* STATS */
276
	gettext_noop("Statistics"),
277
	/* STATS_MONITORING */
278
	gettext_noop("Statistics / Monitoring"),
279
	/* STATS_COLLECTOR */
280
	gettext_noop("Statistics / Query and Index Statistics Collector"),
281
	/* CLIENT_CONN */
282
	gettext_noop("Client Connection Defaults"),
283
	/* CLIENT_CONN_STATEMENT */
284
	gettext_noop("Client Connection Defaults / Statement Behavior"),
285
	/* CLIENT_CONN_LOCALE */
286
	gettext_noop("Client Connection Defaults / Locale and Formatting"),
287
	/* CLIENT_CONN_OTHER */
288
	gettext_noop("Client Connection Defaults / Other Defaults"),
289
	/* LOCK_MANAGEMENT */
290
	gettext_noop("Lock Management"),
291
	/* COMPAT_OPTIONS */
292
	gettext_noop("Version and Platform Compatibility"),
293
	/* COMPAT_OPTIONS_PREVIOUS */
294
	gettext_noop("Version and Platform Compatibility / Previous PostgreSQL Versions"),
295
	/* COMPAT_OPTIONS_CLIENT */
296
	gettext_noop("Version and Platform Compatibility / Other Platforms and Clients"),
297 298 299 300
	/* PRESET_OPTIONS */
	gettext_noop("Preset Options"),
	/* CUSTOM_OPTIONS */
	gettext_noop("Customized Options"),
301
	/* DEVELOPER_OPTIONS */
302
	gettext_noop("Developer Options"),
303
	/* help_config wants this array to be null-terminated */
304 305 306
	NULL
};

307 308 309 310 311
/*
 * Displayable names for GUC variable types (enum config_type)
 *
 * Note: these strings are deliberately not localized.
 */
Bruce Momjian's avatar
Bruce Momjian committed
312
const char *const config_type_names[] =
313
{
Bruce Momjian's avatar
Bruce Momjian committed
314 315 316 317
	 /* PGC_BOOL */ "bool",
	 /* PGC_INT */ "integer",
	 /* PGC_REAL */ "real",
	 /* PGC_STRING */ "string"
318 319
};

320

321
/*
322 323 324 325
 * Contents of GUC tables
 *
 * See src/backend/utils/misc/README for design notes.
 *
326 327 328
 * TO ADD AN OPTION:
 *
 * 1. Declare a global variable of type bool, int, double, or char*
Bruce Momjian's avatar
Bruce Momjian committed
329
 *	  and make use of it.
330 331
 *
 * 2. Decide at what times it's safe to set the option. See guc.h for
Bruce Momjian's avatar
Bruce Momjian committed
332
 *	  details.
333 334
 *
 * 3. Decide on a name, a default value, upper and lower bounds (if
Bruce Momjian's avatar
Bruce Momjian committed
335
 *	  applicable), etc.
336 337 338
 *
 * 4. Add a record below.
 *
339
 * 5. Add it to src/backend/utils/misc/postgresql.conf.sample, if
Bruce Momjian's avatar
Bruce Momjian committed
340
 *	  appropriate
341
 *
342
 * 6. Add it to src/bin/psql/tab-complete.c, if it's a USERSET option.
343
 *
344
 * 7. Don't forget to document the option.
345 346
 *
 * 8. If it's a new GUC_LIST option you must edit pg_dumpall.c to ensure
Bruce Momjian's avatar
Bruce Momjian committed
347
 *	  it is not single quoted at dump time.
348 349
 */

350

351
/******** option records follow ********/
352

353
static struct config_bool ConfigureNamesBool[] =
354
{
355
	{
356
		{"enable_seqscan", PGC_USERSET, QUERY_TUNING_METHOD,
357
			gettext_noop("Enables the planner's use of sequential-scan plans."),
358 359 360
			NULL
		},
		&enable_seqscan,
361
		true, NULL, NULL
362
	},
363
	{
364
		{"enable_indexscan", PGC_USERSET, QUERY_TUNING_METHOD,
365
			gettext_noop("Enables the planner's use of index-scan plans."),
366 367 368
			NULL
		},
		&enable_indexscan,
369
		true, NULL, NULL
370 371
	},
	{
372
		{"enable_tidscan", PGC_USERSET, QUERY_TUNING_METHOD,
373
			gettext_noop("Enables the planner's use of TID scan plans."),
374 375 376
			NULL
		},
		&enable_tidscan,
377
		true, NULL, NULL
378 379
	},
	{
380
		{"enable_sort", PGC_USERSET, QUERY_TUNING_METHOD,
381
			gettext_noop("Enables the planner's use of explicit sort steps."),
382 383 384
			NULL
		},
		&enable_sort,
385
		true, NULL, NULL
386
	},
387
	{
388
		{"enable_hashagg", PGC_USERSET, QUERY_TUNING_METHOD,
389
			gettext_noop("Enables the planner's use of hashed aggregation plans."),
390 391 392
			NULL
		},
		&enable_hashagg,
393 394
		true, NULL, NULL
	},
395
	{
396
		{"enable_nestloop", PGC_USERSET, QUERY_TUNING_METHOD,
397
			gettext_noop("Enables the planner's use of nested-loop join plans."),
398 399 400
			NULL
		},
		&enable_nestloop,
401
		true, NULL, NULL
402 403
	},
	{
404
		{"enable_mergejoin", PGC_USERSET, QUERY_TUNING_METHOD,
405
			gettext_noop("Enables the planner's use of merge join plans."),
406 407 408
			NULL
		},
		&enable_mergejoin,
409
		true, NULL, NULL
410 411
	},
	{
412
		{"enable_hashjoin", PGC_USERSET, QUERY_TUNING_METHOD,
413
			gettext_noop("Enables the planner's use of hash join plans."),
414 415 416
			NULL
		},
		&enable_hashjoin,
417
		true, NULL, NULL
418 419
	},
	{
420
		{"geqo", PGC_USERSET, QUERY_TUNING_GEQO,
421
			gettext_noop("Enables genetic query optimization."),
422
			gettext_noop("This algorithm attempts to do planning without "
423
						 "exhaustive searching.")
424 425
		},
		&enable_geqo,
426
		true, NULL, NULL
427
	},
428
	{
429 430
		/* Not for general use --- used by SET SESSION AUTHORIZATION */
		{"is_superuser", PGC_INTERNAL, UNGROUPED,
431
			gettext_noop("Shows whether the current user is a superuser."),
432 433 434
			NULL,
			GUC_REPORT | GUC_NO_SHOW_ALL | GUC_NO_RESET_ALL | GUC_NOT_IN_SAMPLE | GUC_DISALLOW_IN_FILE
		},
435 436 437
		&session_auth_is_superuser,
		false, NULL, NULL
	},
438
	{
439
		{"ssl", PGC_POSTMASTER, CONN_AUTH_SECURITY,
440
			gettext_noop("Enables SSL connections."),
441 442 443
			NULL
		},
		&EnableSSL,
444
		false, NULL, NULL
445 446
	},
	{
447
		{"fsync", PGC_SIGHUP, WAL_SETTINGS,
448
			gettext_noop("Forces synchronization of updates to disk."),
449
			gettext_noop("The server will use the fsync() system call in several places to make "
450 451
						 "sure that updates are physically written to disk. This insures "
						 "that a database cluster will recover to a consistent state after "
452
						 "an operating system or hardware crash.")
453 454
		},
		&enableFsync,
455
		true, NULL, NULL
456
	},
457
	{
458
		{"zero_damaged_pages", PGC_SUSET, DEVELOPER_OPTIONS,
459
			gettext_noop("Continues processing past damaged page headers."),
460 461 462 463
			gettext_noop("Detection of a damaged page header normally causes PostgreSQL to "
			"report an error, aborting the current transaction. Setting "
						 "zero_damaged_pages to true causes the system to instead report a "
						 "warning, zero out the damaged page, and continue processing. This "
464
						 "behavior will destroy data, namely all the rows on the damaged page."),
465
			GUC_NOT_IN_SAMPLE
466 467
		},
		&zero_damaged_pages,
468 469
		false, NULL, NULL
	},
470
	{
471
		{"silent_mode", PGC_POSTMASTER, LOGGING_WHEN,
472
			gettext_noop("Runs the server silently."),
473
			gettext_noop("If this parameter is set, the server will automatically run in the "
Bruce Momjian's avatar
Bruce Momjian committed
474
			 "background and any controlling terminals are dissociated.")
475 476
		},
		&SilentMode,
477
		false, NULL, NULL
478 479
	},
	{
480
		{"log_connections", PGC_BACKEND, LOGGING_WHAT,
481
			gettext_noop("Logs each successful connection."),
482 483 484
			NULL
		},
		&Log_connections,
485
		false, NULL, NULL
486
	},
487 488
	{
		{"log_disconnections", PGC_BACKEND, LOGGING_WHAT,
Peter Eisentraut's avatar
Peter Eisentraut committed
489
			gettext_noop("Logs end of a session, including duration."),
Bruce Momjian's avatar
Bruce Momjian committed
490
			NULL
491 492 493 494
		},
		&Log_disconnections,
		false, NULL, NULL
	},
495

496
#ifdef USE_ASSERT_CHECKING
497
	{
498
		{"debug_assertions", PGC_USERSET, DEVELOPER_OPTIONS,
499
			gettext_noop("Turns on various assertion checks."),
500
			gettext_noop("This is a debugging aid."),
501 502 503
			GUC_NOT_IN_SAMPLE
		},
		&assert_enabled,
504
		true, NULL, NULL
505
	},
506 507
#endif

508 509
	{
		/* currently undocumented, so don't show in SHOW ALL */
510
		{"exit_on_error", PGC_USERSET, UNGROUPED,
511
			gettext_noop("no description available"),
512 513 514 515
			NULL,
			GUC_NO_SHOW_ALL | GUC_NOT_IN_SAMPLE
		},
		&ExitOnAnyError,
516 517
		false, NULL, NULL
	},
518
	{
519 520
		{"log_duration", PGC_SUSET, LOGGING_WHAT,
			gettext_noop("Logs the duration of each completed SQL statement."),
521 522 523
			NULL
		},
		&log_duration,
524
		false, NULL, NULL
525 526
	},
	{
527
		{"debug_print_parse", PGC_USERSET, LOGGING_WHAT,
528
			gettext_noop("Prints the parse tree to the server log."),
529
			NULL
530 531
		},
		&Debug_print_parse,
532
		false, NULL, NULL
533 534
	},
	{
535
		{"debug_print_rewritten", PGC_USERSET, LOGGING_WHAT,
536
			gettext_noop("Prints the parse tree after rewriting to server log."),
537 538 539
			NULL
		},
		&Debug_print_rewritten,
540
		false, NULL, NULL
541 542
	},
	{
543
		{"debug_print_plan", PGC_USERSET, LOGGING_WHAT,
544
			gettext_noop("Prints the execution plan to server log."),
545 546 547
			NULL
		},
		&Debug_print_plan,
548
		false, NULL, NULL
549 550
	},
	{
551
		{"debug_pretty_print", PGC_USERSET, LOGGING_WHAT,
552
			gettext_noop("Indents parse and plan tree displays."),
553 554 555
			NULL
		},
		&Debug_pretty_print,
556
		false, NULL, NULL
557 558
	},
	{
559
		{"log_parser_stats", PGC_SUSET, STATS_MONITORING,
560
			gettext_noop("Writes parser performance statistics to the server log."),
561 562 563
			NULL
		},
		&log_parser_stats,
564
		false, assign_stage_log_stats, NULL
565 566
	},
	{
567
		{"log_planner_stats", PGC_SUSET, STATS_MONITORING,
568
			gettext_noop("Writes planner performance statistics to the server log."),
569 570 571
			NULL
		},
		&log_planner_stats,
572
		false, assign_stage_log_stats, NULL
573 574
	},
	{
575
		{"log_executor_stats", PGC_SUSET, STATS_MONITORING,
576
			gettext_noop("Writes executor performance statistics to the server log."),
577 578 579
			NULL
		},
		&log_executor_stats,
580
		false, assign_stage_log_stats, NULL
581 582
	},
	{
583
		{"log_statement_stats", PGC_SUSET, STATS_MONITORING,
584
			gettext_noop("Writes cumulative performance statistics to the server log."),
585 586 587
			NULL
		},
		&log_statement_stats,
588
		false, assign_log_stats, NULL
589
	},
590
#ifdef BTREE_BUILD_STATS
591
	{
592
		{"log_btree_build_stats", PGC_SUSET, DEVELOPER_OPTIONS,
593
			gettext_noop("no description available"),
594 595 596 597
			NULL,
			GUC_NOT_IN_SAMPLE
		},
		&log_btree_build_stats,
598
		false, NULL, NULL
599
	},
600 601
#endif

602
	{
603
		{"explain_pretty_print", PGC_USERSET, CLIENT_CONN_OTHER,
604
			gettext_noop("Uses the indented output format for EXPLAIN VERBOSE."),
605 606 607
			NULL
		},
		&Explain_pretty_print,
608
		true, NULL, NULL
609
	},
610
	{
611
		{"stats_start_collector", PGC_POSTMASTER, STATS_COLLECTOR,
612
			gettext_noop("Starts the server statistics-collection subprocess."),
613 614 615
			NULL
		},
		&pgstat_collect_startcollector,
616
		true, NULL, NULL
617 618
	},
	{
619
		{"stats_reset_on_server_start", PGC_POSTMASTER, STATS_COLLECTOR,
620
			gettext_noop("Zeroes collected statistics on server restart."),
621 622 623
			NULL
		},
		&pgstat_collect_resetonpmstart,
624
		true, NULL, NULL
625 626
	},
	{
627
		{"stats_command_string", PGC_SUSET, STATS_COLLECTOR,
628
			gettext_noop("Collects statistics about executing commands."),
629 630 631 632 633
			gettext_noop("Enables the collection of statistics on the currently "
				"executing command of each session, along with the time "
						 "at which that command began execution.")
		},
		&pgstat_collect_querystring,
634
		false, NULL, NULL
635 636
	},
	{
637
		{"stats_row_level", PGC_SUSET, STATS_COLLECTOR,
638
			gettext_noop("Collects row-level statistics on database activity."),
639 640 641
			NULL
		},
		&pgstat_collect_tuplelevel,
642
		false, NULL, NULL
643 644
	},
	{
645
		{"stats_block_level", PGC_SUSET, STATS_COLLECTOR,
646
			gettext_noop("Collects block-level statistics on database activity."),
647 648 649
			NULL
		},
		&pgstat_collect_blocklevel,
650
		false, NULL, NULL
651
	},
652

653
	{
654
		{"trace_notify", PGC_USERSET, DEVELOPER_OPTIONS,
655
			gettext_noop("Generates debugging output for LISTEN and NOTIFY."),
656 657 658 659
			NULL,
			GUC_NOT_IN_SAMPLE
		},
		&Trace_notify,
660
		false, NULL, NULL
661
	},
662 663

#ifdef LOCK_DEBUG
664
	{
665
		{"trace_locks", PGC_SUSET, DEVELOPER_OPTIONS,
666
			gettext_noop("no description available"),
667 668 669 670
			NULL,
			GUC_NOT_IN_SAMPLE
		},
		&Trace_locks,
671
		false, NULL, NULL
672 673
	},
	{
674
		{"trace_userlocks", PGC_SUSET, DEVELOPER_OPTIONS,
675
			gettext_noop("no description available"),
676 677 678 679
			NULL,
			GUC_NOT_IN_SAMPLE
		},
		&Trace_userlocks,
680
		false, NULL, NULL
681 682
	},
	{
683
		{"trace_lwlocks", PGC_SUSET, DEVELOPER_OPTIONS,
684
			gettext_noop("no description available"),
685 686 687 688
			NULL,
			GUC_NOT_IN_SAMPLE
		},
		&Trace_lwlocks,
689
		false, NULL, NULL
690 691
	},
	{
692
		{"debug_deadlocks", PGC_SUSET, DEVELOPER_OPTIONS,
693
			gettext_noop("no description available"),
694 695 696 697
			NULL,
			GUC_NOT_IN_SAMPLE
		},
		&Debug_deadlocks,
698
		false, NULL, NULL
699
	},
700 701
#endif

702
	{
703
		{"log_hostname", PGC_SIGHUP, LOGGING_WHAT,
704
			gettext_noop("Logs the host name in the connection logs."),
705 706 707
			gettext_noop("By default, connection logs only show the IP address "
						 "of the connecting host. If you want them to show the host name you "
						 "can turn this on, but depending on your host name resolution "
708
			"setup it might impose a non-negligible performance penalty.")
709 710
		},
		&log_hostname,
711
		false, NULL, NULL
712 713
	},
	{
714
		{"sql_inheritance", PGC_USERSET, COMPAT_OPTIONS_PREVIOUS,
715
			gettext_noop("Causes subtables to be included by default in various commands."),
716
			NULL
717 718
		},
		&SQL_inheritance,
719
		true, NULL, NULL
720 721
	},
	{
722
		{"australian_timezones", PGC_USERSET, CLIENT_CONN_LOCALE,
723
			gettext_noop("Interprets ACST, CST, EST, and SAT as Australian time zones."),
724
			gettext_noop("Otherwise they are interpreted as North/South American "
725
						 "time zones and Saturday.")
726 727
		},
		&Australian_timezones,
728
		false, ClearDateCache, NULL
729 730
	},
	{
731
		{"password_encryption", PGC_USERSET, CONN_AUTH_SECURITY,
732
			gettext_noop("Encrypt passwords."),
733 734
			gettext_noop("When a password is specified in CREATE USER or "
			"ALTER USER without writing either ENCRYPTED or UNENCRYPTED, "
735
						 "this parameter determines whether the password is to be encrypted.")
736 737
		},
		&Password_encryption,
738
		true, NULL, NULL
739 740
	},
	{
741
		{"transform_null_equals", PGC_USERSET, COMPAT_OPTIONS_CLIENT,
742
			gettext_noop("Treats \"expr=NULL\" as \"expr IS NULL\"."),
743 744 745 746
			gettext_noop("When turned on, expressions of the form expr = NULL "
			"(or NULL = expr) are treated as expr IS NULL, that is, they "
			"return true if expr evaluates to the null value, and false "
			"otherwise. The correct behavior of expr = NULL is to always "
747
						 "return null (unknown).")
748 749
		},
		&Transform_null_equals,
750
		false, NULL, NULL
751
	},
752
	{
753
		{"db_user_namespace", PGC_SIGHUP, CONN_AUTH_SECURITY,
754
			gettext_noop("Enables per-database user names."),
755 756 757
			NULL
		},
		&Db_user_namespace,
758 759
		false, NULL, NULL
	},
760
	{
761 762
		/* only here for backwards compatibility */
		{"autocommit", PGC_USERSET, CLIENT_CONN_STATEMENT,
763 764
			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."),
765 766 767
			GUC_NO_SHOW_ALL | GUC_NOT_IN_SAMPLE
		},
		&phony_autocommit,
768
		true, assign_phony_autocommit, NULL
769
	},
770
	{
771
		{"default_transaction_read_only", PGC_USERSET, CLIENT_CONN_STATEMENT,
772
			gettext_noop("Sets the default read-only status of new transactions."),
773 774 775
			NULL
		},
		&DefaultXactReadOnly,
776 777 778
		false, NULL, NULL
	},
	{
779
		{"transaction_read_only", PGC_USERSET, CLIENT_CONN_STATEMENT,
780
			gettext_noop("Sets the current transaction's read-only status."),
781 782 783 784
			NULL,
			GUC_NO_RESET_ALL | GUC_NOT_IN_SAMPLE | GUC_DISALLOW_IN_FILE
		},
		&XactReadOnly,
785
		false, assign_transaction_read_only, NULL
786
	},
787
	{
788
		{"add_missing_from", PGC_USERSET, COMPAT_OPTIONS_PREVIOUS,
789
			gettext_noop("Automatically adds missing table references to FROM clauses."),
790 791 792
			NULL
		},
		&add_missing_from,
793 794
		true, NULL, NULL
	},
795 796
	{
		{"check_function_bodies", PGC_USERSET, CLIENT_CONN_STATEMENT,
797
			gettext_noop("Check function bodies during CREATE FUNCTION."),
798 799 800 801 802
			NULL
		},
		&check_function_bodies,
		true, NULL, NULL
	},
803 804
	{
		{"default_with_oids", PGC_USERSET, COMPAT_OPTIONS_PREVIOUS,
Peter Eisentraut's avatar
Peter Eisentraut committed
805
			gettext_noop("By default, newly-created tables should have OIDs."),
Bruce Momjian's avatar
Bruce Momjian committed
806
			NULL
807 808 809 810
		},
		&default_with_oids,
		true, NULL, NULL
	},
811
	{
812
		{"redirect_stderr", PGC_POSTMASTER, LOGGING_WHERE,
Peter Eisentraut's avatar
Peter Eisentraut committed
813
			gettext_noop("Start a subprocess to capture stderr output into log files."),
Bruce Momjian's avatar
Bruce Momjian committed
814
			NULL
815
		},
816
		&Redirect_stderr,
817 818
		false, NULL, NULL
	},
819 820
	{
		{"log_truncate_on_rotation", PGC_SIGHUP, LOGGING_WHERE,
Peter Eisentraut's avatar
Peter Eisentraut committed
821
			gettext_noop("Truncate existing log files of same name during log rotation."),
822 823 824 825 826
			NULL
		},
		&Log_truncate_on_rotation,
		false, NULL, NULL
	},
827

828 829 830 831 832 833 834 835 836 837 838 839
#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

840
	{
841
		{"integer_datetimes", PGC_INTERNAL, PRESET_OPTIONS,
842 843
			gettext_noop("Datetimes are integer based"),
			NULL,
844
			GUC_REPORT | GUC_NOT_IN_SAMPLE | GUC_DISALLOW_IN_FILE
845 846 847 848 849 850 851 852 853
		},
		&integer_datetimes,
#ifdef HAVE_INT64_TIMESTAMP
		true, NULL, NULL
#else
		false, NULL, NULL
#endif
	},

854
	/* End-of-list marker */
855
	{
856 857
		{NULL, 0, 0, NULL, NULL}, NULL, false, NULL, NULL
	}
858 859 860
};


861
static struct config_int ConfigureNamesInt[] =
862
{
863
	{
864
		{"default_statistics_target", PGC_USERSET, QUERY_TUNING_OTHER,
865
			gettext_noop("Sets the default statistics target."),
866
			gettext_noop("This applies to table columns that have not had a "
Bruce Momjian's avatar
Bruce Momjian committed
867
			"column-specific target set via ALTER TABLE SET STATISTICS.")
868 869
		},
		&default_statistics_target,
870 871
		10, 1, 1000, NULL, NULL
	},
872
	{
873
		{"from_collapse_limit", PGC_USERSET, QUERY_TUNING_OTHER,
874 875
			gettext_noop("Sets the FROM-list size beyond which subqueries are not "
						 "collapsed."),
876
			gettext_noop("The planner will merge subqueries into upper "
877
			"queries if the resulting FROM list would have no more than "
878
						 "this many items.")
879 880
		},
		&from_collapse_limit,
881 882 883
		8, 1, INT_MAX, NULL, NULL
	},
	{
884
		{"join_collapse_limit", PGC_USERSET, QUERY_TUNING_OTHER,
885 886
			gettext_noop("Sets the FROM-list size beyond which JOIN constructs are not "
						 "flattened."),
887 888
			gettext_noop("The planner will flatten explicit inner JOIN "
						 "constructs into lists of FROM items whenever a list of no more "
889
						 "than this many items would result.")
890 891
		},
		&join_collapse_limit,
892 893 894
		8, 1, INT_MAX, NULL, NULL
	},
	{
895
		{"geqo_threshold", PGC_USERSET, QUERY_TUNING_GEQO,
896
			gettext_noop("Sets the threshold of FROM items beyond which GEQO is used."),
897 898 899
			NULL
		},
		&geqo_threshold,
900
		12, 2, INT_MAX, NULL, NULL
901
	},
902
	{
903 904
		{"geqo_effort", PGC_USERSET, QUERY_TUNING_GEQO,
			gettext_noop("GEQO: effort is used to set the default for other GEQO parameters."),
905 906
			NULL
		},
907 908 909 910 911 912 913 914
		&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.")
		},
915
		&Geqo_pool_size,
916
		0, 0, INT_MAX, NULL, NULL
917 918
	},
	{
919
		{"geqo_generations", PGC_USERSET, QUERY_TUNING_GEQO,
920
			gettext_noop("GEQO: number of iterations of the algorithm."),
921
			gettext_noop("Zero selects a suitable default value.")
922 923
		},
		&Geqo_generations,
924
		0, 0, INT_MAX, NULL, NULL
925 926 927
	},

	{
928
		{"deadlock_timeout", PGC_SIGHUP, LOCK_MANAGEMENT,
929
			gettext_noop("The time in milliseconds to wait on lock before checking for deadlock."),
930 931 932
			NULL
		},
		&DeadlockTimeout,
933
		1000, 0, INT_MAX, NULL, NULL
934
	},
935 936

	/*
937 938
	 * Note: There is some postprocessing done in PostmasterMain() to make
	 * sure the buffers are at least twice the number of backends, so the
939 940 941
	 * constraints here are partially unused. Similarly, the superuser
	 * reserved number is checked to ensure it is less than the max
	 * backends number.
942
	 */
943
	{
944
		{"max_connections", PGC_POSTMASTER, CONN_AUTH_SETTINGS,
945
			gettext_noop("Sets the maximum number of concurrent connections."),
946 947 948
			NULL
		},
		&MaxBackends,
949
		100, 1, INT_MAX / BLCKSZ, NULL, NULL
950
	},
951

952
	{
953
		{"superuser_reserved_connections", PGC_POSTMASTER, CONN_AUTH_SETTINGS,
954
			gettext_noop("Sets the number of connection slots reserved for superusers."),
955 956 957
			NULL
		},
		&ReservedBackends,
958
		2, 0, INT_MAX / BLCKSZ, NULL, NULL
959 960
	},

961
	{
962
		{"shared_buffers", PGC_POSTMASTER, RESOURCES_MEM,
963
			gettext_noop("Sets the number of shared memory buffers used by the server."),
964 965 966
			NULL
		},
		&NBuffers,
967
		1000, 16, INT_MAX / BLCKSZ, NULL, NULL
968
	},
969

970
	{
971
		{"port", PGC_POSTMASTER, CONN_AUTH_SETTINGS,
972
			gettext_noop("Sets the TCP port the server listens on."),
973 974 975
			NULL
		},
		&PostPortNumber,
976
		DEF_PGPORT, 1, 65535, NULL, NULL
977
	},
978

979
	{
980
		{"unix_socket_permissions", PGC_POSTMASTER, CONN_AUTH_SETTINGS,
981
			gettext_noop("Sets the access permissions of the Unix-domain socket."),
982
			gettext_noop("Unix-domain sockets use the usual Unix file system "
983
						 "permission set. The parameter value is expected to be an numeric mode "
984
						 "specification in the form accepted by the chmod and umask system "
985 986 987 988
						 "calls. (To use the customary octal format the number must start with "
						 "a 0 (zero).)")
		},
		&Unix_socket_permissions,
989
		0777, 0000, 0777, NULL, NULL
990
	},
991

992
	{
993 994 995
		{"work_mem", PGC_USERSET, RESOURCES_MEM,
			gettext_noop("Sets the maximum memory to be used for query workspaces."),
			gettext_noop("This much memory may be used by each internal "
Bruce Momjian's avatar
Bruce Momjian committed
996
					 "sort operation and hash table before switching to "
997
						 "temporary disk files.")
998
		},
999 1000
		&work_mem,
		1024, 8 * BLCKSZ / 1024, INT_MAX / 1024, NULL, NULL
1001
	},
1002

1003
	{
1004 1005 1006
		{"maintenance_work_mem", PGC_USERSET, RESOURCES_MEM,
			gettext_noop("Sets the maximum memory to be used for maintenance operations."),
			gettext_noop("This includes operations such as VACUUM and CREATE INDEX.")
1007
		},
1008 1009
		&maintenance_work_mem,
		16384, 1024, INT_MAX / 1024, NULL, NULL
1010
	},
1011

1012 1013 1014 1015 1016 1017 1018 1019 1020
	{
		{"max_stack_depth", PGC_SUSET, RESOURCES_MEM,
			gettext_noop("Sets the maximum stack depth, in kilobytes."),
			NULL
		},
		&max_stack_depth,
		2048, 100, INT_MAX / 1024, assign_max_stack_depth, NULL
	},

Jan Wieck's avatar
Jan Wieck committed
1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057
	{
		{"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
	},

	{
1058 1059
		{"vacuum_cost_delay", PGC_USERSET, RESOURCES,
			gettext_noop("Vacuum cost delay in milliseconds."),
Jan Wieck's avatar
Jan Wieck committed
1060 1061
			NULL
		},
1062
		&VacuumCostDelay,
1063
		0, 0, 1000, NULL, NULL
Jan Wieck's avatar
Jan Wieck committed
1064 1065
	},

1066
	{
1067
		{"max_files_per_process", PGC_POSTMASTER, RESOURCES_KERNEL,
1068
			gettext_noop("Sets the maximum number of simultaneously open files for each server process."),
1069 1070 1071
			NULL
		},
		&max_files_per_process,
1072
		1000, 25, INT_MAX, NULL, NULL
1073
	},
1074

1075
#ifdef LOCK_DEBUG
1076
	{
1077
		{"trace_lock_oidmin", PGC_SUSET, DEVELOPER_OPTIONS,
1078
			gettext_noop("no description available"),
1079 1080 1081 1082
			NULL,
			GUC_NOT_IN_SAMPLE
		},
		&Trace_lock_oidmin,
1083
		BootstrapObjectIdData, 1, INT_MAX, NULL, NULL
1084 1085
	},
	{
1086
		{"trace_lock_table", PGC_SUSET, DEVELOPER_OPTIONS,
1087
			gettext_noop("no description available"),
1088 1089 1090 1091
			NULL,
			GUC_NOT_IN_SAMPLE
		},
		&Trace_lock_table,
1092
		0, 0, INT_MAX, NULL, NULL
1093
	},
1094 1095
#endif

1096
	{
1097
		{"statement_timeout", PGC_USERSET, CLIENT_CONN_STATEMENT,
1098
			gettext_noop("Sets the maximum allowed duration (in milliseconds) of any statement."),
1099
			gettext_noop("A value of 0 turns off the timeout.")
1100 1101
		},
		&StatementTimeout,
1102 1103 1104
		0, 0, INT_MAX, NULL, NULL
	},

1105
	{
1106
		{"max_fsm_relations", PGC_POSTMASTER, RESOURCES_FSM,
1107
			gettext_noop("Sets the maximum number of tables and indexes for which free space is tracked."),
1108 1109 1110
			NULL
		},
		&MaxFSMRelations,
1111
		1000, 100, INT_MAX, NULL, NULL
1112 1113
	},
	{
1114
		{"max_fsm_pages", PGC_POSTMASTER, RESOURCES_FSM,
1115
			gettext_noop("Sets the maximum number of disk pages for which free space is tracked."),
1116 1117 1118
			NULL
		},
		&MaxFSMPages,
1119
		20000, 1000, INT_MAX, NULL, NULL
1120
	},
1121

1122
	{
1123
		{"max_locks_per_transaction", PGC_POSTMASTER, LOCK_MANAGEMENT,
1124
			gettext_noop("Sets the maximum number of locks per transaction."),
1125 1126
			gettext_noop("The shared lock table is sized on the assumption that "
						 "at most max_locks_per_transaction * max_connections distinct "
1127
						 "objects will need to be locked at any one time.")
1128 1129
		},
		&max_locks_per_xact,
1130
		64, 10, INT_MAX, NULL, NULL
1131
	},
1132

1133
	{
1134
		{"authentication_timeout", PGC_SIGHUP, CONN_AUTH_SECURITY,
1135
			gettext_noop("Sets the maximum time in seconds to complete client authentication."),
1136 1137 1138
			NULL
		},
		&AuthenticationTimeout,
1139
		60, 1, 600, NULL, NULL
1140
	},
1141

1142
	{
1143 1144
		/* Not for general use */
		{"pre_auth_delay", PGC_SIGHUP, DEVELOPER_OPTIONS,
1145
			gettext_noop("no description available"),
1146 1147 1148 1149
			NULL,
			GUC_NOT_IN_SAMPLE
		},
		&PreAuthDelay,
1150
		0, 0, 60, NULL, NULL
1151
	},
1152

1153
	{
1154
		{"checkpoint_segments", PGC_SIGHUP, WAL_CHECKPOINTS,
1155
			gettext_noop("Sets the maximum distance in log segments between automatic WAL checkpoints."),
1156 1157 1158
			NULL
		},
		&CheckPointSegments,
1159
		3, 1, INT_MAX, NULL, NULL
1160
	},
Tom Lane's avatar
Tom Lane committed
1161

1162
	{
1163
		{"checkpoint_timeout", PGC_SIGHUP, WAL_CHECKPOINTS,
1164
			gettext_noop("Sets the maximum time in seconds between automatic WAL checkpoints."),
1165 1166 1167
			NULL
		},
		&CheckPointTimeout,
1168
		300, 30, 3600, NULL, NULL
1169
	},
Vadim B. Mikheev's avatar
Vadim B. Mikheev committed
1170

1171
	{
1172
		{"checkpoint_warning", PGC_SIGHUP, WAL_CHECKPOINTS,
1173 1174
			gettext_noop("Logs if filling of checkpoint segments happens more "
						 "frequently than this (in seconds)."),
1175
			gettext_noop("Write a message to the server log if checkpoints "
1176 1177 1178 1179
						 "caused by the filling of checkpoint segment files happens more "
						 "frequently than this number of seconds. Zero turns off the warning.")
		},
		&CheckPointWarning,
1180 1181 1182
		30, 0, INT_MAX, NULL, NULL
	},

1183
	{
1184
		{"wal_buffers", PGC_POSTMASTER, WAL_SETTINGS,
1185
			gettext_noop("Sets the number of disk-page buffers in shared memory for WAL."),
1186 1187 1188
			NULL
		},
		&XLOGbuffers,
1189
		8, 4, INT_MAX / BLCKSZ, NULL, NULL
1190
	},
Vadim B. Mikheev's avatar
Vadim B. Mikheev committed
1191

1192
	{
1193
		{"commit_delay", PGC_USERSET, WAL_CHECKPOINTS,
1194 1195
			gettext_noop("Sets the delay in microseconds between transaction commit and "
						 "flushing WAL to disk."),
1196 1197 1198
			NULL
		},
		&CommitDelay,
1199
		0, 0, 100000, NULL, NULL
1200
	},
Vadim B. Mikheev's avatar
Vadim B. Mikheev committed
1201

1202
	{
1203
		{"commit_siblings", PGC_USERSET, WAL_CHECKPOINTS,
1204 1205
			gettext_noop("Sets the minimum concurrent open transactions before performing "
						 "commit_delay."),
1206 1207 1208
			NULL
		},
		&CommitSiblings,
1209
		5, 1, 1000, NULL, NULL
1210
	},
1211

1212
	{
1213
		{"extra_float_digits", PGC_USERSET, CLIENT_CONN_LOCALE,
1214
			gettext_noop("Sets the number of digits displayed for floating-point values."),
1215
			gettext_noop("This affects real, double precision, and geometric data types. "
1216
						 "The parameter value is added to the standard number of digits "
1217
						 "(FLT_DIG or DBL_DIG as appropriate).")
1218 1219
		},
		&extra_float_digits,
1220 1221 1222
		0, -15, 2, NULL, NULL
	},

1223
	{
1224
		{"log_min_duration_statement", PGC_SUSET, LOGGING_WHEN,
1225 1226 1227
			gettext_noop("Sets the minimum execution time in milliseconds above which statements will "
						 "be logged."),
			gettext_noop("Zero prints all queries. The default is -1 (turning this feature off).")
1228 1229
		},
		&log_min_duration_statement,
1230
		-1, -1, INT_MAX / 1000, NULL, NULL
1231 1232
	},

Jan Wieck's avatar
Jan Wieck committed
1233
	{
1234
		{"debug_shared_buffers", PGC_POSTMASTER, STATS_MONITORING,
1235
			gettext_noop("Interval to report shared buffer status in seconds"),
Jan Wieck's avatar
Jan Wieck committed
1236 1237
			NULL
		},
1238
		&DebugSharedBuffers,
Jan Wieck's avatar
Jan Wieck committed
1239 1240 1241
		0, 0, 600, NULL, NULL
	},

Jan Wieck's avatar
Jan Wieck committed
1242 1243 1244 1245 1246 1247
	{
		{"bgwriter_delay", PGC_SIGHUP, RESOURCES,
			gettext_noop("Background writer sleep time between rounds in milliseconds"),
			NULL
		},
		&BgWriterDelay,
1248
		200, 10, 10000, NULL, NULL
Jan Wieck's avatar
Jan Wieck committed
1249 1250 1251 1252 1253 1254 1255 1256
	},

	{
		{"bgwriter_percent", PGC_SIGHUP, RESOURCES,
			gettext_noop("Background writer percentage of dirty buffers to flush per round"),
			NULL
		},
		&BgWriterPercent,
1257
		1, 0, 100, NULL, NULL
Jan Wieck's avatar
Jan Wieck committed
1258 1259 1260 1261 1262 1263 1264
	},

	{
		{"bgwriter_maxpages", PGC_SIGHUP, RESOURCES,
			gettext_noop("Background writer maximum number of pages to flush per round"),
			NULL
		},
1265
		&BgWriterMaxPages,
1266
		100, 0, 1000, NULL, NULL
Jan Wieck's avatar
Jan Wieck committed
1267 1268
	},

1269 1270
	{
		{"log_rotation_age", PGC_SIGHUP, LOGGING_WHERE,
Peter Eisentraut's avatar
Peter Eisentraut committed
1271
			gettext_noop("Automatic log file rotation will occur after N minutes"),
Bruce Momjian's avatar
Bruce Momjian committed
1272
			NULL
1273 1274
		},
		&Log_RotationAge,
1275
		24 * 60, 0, INT_MAX / 60, NULL, NULL
1276 1277 1278 1279
	},

	{
		{"log_rotation_size", PGC_SIGHUP, LOGGING_WHERE,
Peter Eisentraut's avatar
Peter Eisentraut committed
1280
			gettext_noop("Automatic log file rotation will occur after N kilobytes"),
Bruce Momjian's avatar
Bruce Momjian committed
1281
			NULL
1282 1283
		},
		&Log_RotationSize,
1284
		10 * 1024, 0, INT_MAX / 1024, NULL, NULL
1285 1286
	},

1287
	{
1288
		{"max_function_args", PGC_INTERNAL, PRESET_OPTIONS,
Peter Eisentraut's avatar
Peter Eisentraut committed
1289
			gettext_noop("Shows the maximum number of function arguments."),
1290 1291 1292 1293 1294 1295 1296 1297
			NULL,
			GUC_NOT_IN_SAMPLE | GUC_DISALLOW_IN_FILE
		},
		&max_function_args,
		FUNC_MAX_ARGS, FUNC_MAX_ARGS, FUNC_MAX_ARGS, NULL, NULL
	},

	{
1298
		{"max_index_keys", PGC_INTERNAL, PRESET_OPTIONS,
Peter Eisentraut's avatar
Peter Eisentraut committed
1299
			gettext_noop("Shows the maximum number of index keys."),
1300 1301 1302 1303 1304 1305 1306 1307
			NULL,
			GUC_NOT_IN_SAMPLE | GUC_DISALLOW_IN_FILE
		},
		&max_index_keys,
		INDEX_MAX_KEYS, INDEX_MAX_KEYS, INDEX_MAX_KEYS, NULL, NULL
	},

	{
1308
		{"max_identifier_length", PGC_INTERNAL, PRESET_OPTIONS,
1309 1310 1311 1312 1313 1314 1315 1316 1317
			gettext_noop("Shows the maximum identifier length"),
			NULL,
			GUC_NOT_IN_SAMPLE | GUC_DISALLOW_IN_FILE
		},
		&max_identifier_length,
		NAMEDATALEN - 1, NAMEDATALEN - 1, NAMEDATALEN - 1, NULL, NULL
	},

	{
1318
		{"block_size", PGC_INTERNAL, PRESET_OPTIONS,
1319 1320 1321 1322 1323 1324 1325 1326
			gettext_noop("Shows size of a disk block"),
			NULL,
			GUC_NOT_IN_SAMPLE | GUC_DISALLOW_IN_FILE
		},
		&block_size,
		BLCKSZ, BLCKSZ, BLCKSZ, NULL, NULL
	},

1327
	/* End-of-list marker */
1328
	{
1329
		{NULL, 0, 0, NULL, NULL}, NULL, 0, 0, 0, NULL, NULL
1330
	}
1331 1332 1333
};


1334
static struct config_real ConfigureNamesReal[] =
1335
{
1336
	{
1337
		{"effective_cache_size", PGC_USERSET, QUERY_TUNING_COST,
1338
			gettext_noop("Sets the planner's assumption about size of the disk cache."),
1339 1340 1341 1342 1343
			gettext_noop("That is, the portion of the kernel's disk cache that "
						 "will be used for PostgreSQL data files. This is measured in disk "
						 "pages, which are normally 8 kB each.")
		},
		&effective_cache_size,
1344
		DEFAULT_EFFECTIVE_CACHE_SIZE, 1, DBL_MAX, NULL, NULL
1345
	},
1346
	{
1347
		{"random_page_cost", PGC_USERSET, QUERY_TUNING_COST,
1348 1349
			gettext_noop("Sets the planner's estimate of the cost of a nonsequentially "
						 "fetched disk page."),
1350 1351 1352 1353 1354 1355
			gettext_noop("This is measured as a multiple of the cost of a "
						 "sequential page fetch. A higher value makes it more likely a "
						 "sequential scan will be used, a lower value makes it more likely an "
						 "index scan will be used.")
		},
		&random_page_cost,
1356
		DEFAULT_RANDOM_PAGE_COST, 0, DBL_MAX, NULL, NULL
1357 1358
	},
	{
1359
		{"cpu_tuple_cost", PGC_USERSET, QUERY_TUNING_COST,
1360
			gettext_noop("Sets the planner's estimate of the cost of processing each tuple (row)."),
1361 1362 1363 1364
			gettext_noop("This is measured as a fraction of the cost of a "
						 "sequential page fetch.")
		},
		&cpu_tuple_cost,
1365
		DEFAULT_CPU_TUPLE_COST, 0, DBL_MAX, NULL, NULL
1366 1367
	},
	{
1368
		{"cpu_index_tuple_cost", PGC_USERSET, QUERY_TUNING_COST,
1369 1370
			gettext_noop("Sets the planner's estimate of processing cost for each "
						 "index tuple (row) during index scan."),
1371 1372 1373 1374
			gettext_noop("This is measured as a fraction of the cost of a "
						 "sequential page fetch.")
		},
		&cpu_index_tuple_cost,
1375
		DEFAULT_CPU_INDEX_TUPLE_COST, 0, DBL_MAX, NULL, NULL
1376 1377
	},
	{
1378
		{"cpu_operator_cost", PGC_USERSET, QUERY_TUNING_COST,
1379
			gettext_noop("Sets the planner's estimate of processing cost of each operator in WHERE."),
1380 1381 1382 1383
			gettext_noop("This is measured as a fraction of the cost of a sequential "
						 "page fetch.")
		},
		&cpu_operator_cost,
1384
		DEFAULT_CPU_OPERATOR_COST, 0, DBL_MAX, NULL, NULL
1385 1386 1387
	},

	{
1388
		{"geqo_selection_bias", PGC_USERSET, QUERY_TUNING_GEQO,
1389
			gettext_noop("GEQO: selective pressure within the population."),
1390 1391 1392
			NULL
		},
		&Geqo_selection_bias,
1393 1394
		DEFAULT_GEQO_SELECTION_BIAS, MIN_GEQO_SELECTION_BIAS,
		MAX_GEQO_SELECTION_BIAS, NULL, NULL
1395 1396 1397
	},

	{
1398
		{"seed", PGC_USERSET, UNGROUPED,
1399
			gettext_noop("Sets the seed for random-number generation."),
1400 1401 1402
			NULL,
			GUC_NO_SHOW_ALL | GUC_NO_RESET_ALL | GUC_NOT_IN_SAMPLE | GUC_DISALLOW_IN_FILE
		},
1403 1404 1405 1406
		&phony_random_seed,
		0.5, 0.0, 1.0, assign_random_seed, show_random_seed
	},

1407
	/* End-of-list marker */
1408
	{
1409
		{NULL, 0, 0, NULL, NULL}, NULL, 0.0, 0.0, 0.0, NULL, NULL
1410
	}
1411 1412 1413
};


1414
static struct config_string ConfigureNamesString[] =
1415
{
Bruce Momjian's avatar
Bruce Momjian committed
1416 1417 1418 1419 1420 1421 1422 1423
	{
		{"archive_command", PGC_SIGHUP, WAL_SETTINGS,
			gettext_noop("WAL archiving command."),
			gettext_noop("The shell command that will be called to archive a WAL file.")
		},
		&XLogArchiveCommand,
		"", NULL, NULL
	},
1424

1425
	{
1426
		{"client_encoding", PGC_USERSET, CLIENT_CONN_LOCALE,
1427
			gettext_noop("Sets the client's character set encoding."),
1428 1429 1430
			NULL,
			GUC_REPORT
		},
1431
		&client_encoding_string,
1432
		"SQL_ASCII", assign_client_encoding, NULL
1433 1434
	},

1435
	{
1436
		{"client_min_messages", PGC_USERSET, LOGGING_WHEN,
1437
			gettext_noop("Sets the message levels that are sent to the client."),
1438 1439 1440 1441 1442 1443
			gettext_noop("Valid values are DEBUG5, DEBUG4, DEBUG3, DEBUG2, "
						 "DEBUG1, LOG, NOTICE, WARNING, and ERROR. Each level includes all the "
						 "levels that follow it. The later the level, the fewer messages are "
						 "sent.")
		},
		&client_min_messages_str,
1444
		"notice", assign_client_min_messages, NULL
1445
	},
1446

1447
	{
1448
		{"log_min_messages", PGC_SUSET, LOGGING_WHEN,
1449
			gettext_noop("Sets the message levels that are logged."),
1450 1451
			gettext_noop("Valid values are DEBUG5, DEBUG4, DEBUG3, DEBUG2, DEBUG1, "
						 "INFO, NOTICE, WARNING, ERROR, LOG, FATAL, and PANIC. Each level "
1452
						 "includes all the levels that follow it.")
1453 1454
		},
		&log_min_messages_str,
1455 1456 1457 1458
		"notice", assign_log_min_messages, NULL
	},

	{
1459
		{"log_error_verbosity", PGC_SUSET, LOGGING_WHEN,
1460
			gettext_noop("Sets the verbosity of logged messages."),
1461
			gettext_noop("Valid values are \"terse\", \"default\", and \"verbose\".")
1462 1463
		},
		&log_error_verbosity_str,
1464 1465
		"default", assign_log_error_verbosity, NULL
	},
1466
	{
1467
		{"log_statement", PGC_SUSET, LOGGING_WHAT,
1468
			gettext_noop("Sets the type of statements logged."),
1469
			gettext_noop("Valid values are \"none\", \"ddl\", \"mod\", and \"all\".")
1470 1471 1472 1473
		},
		&log_statement_str,
		"none", assign_log_statement, NULL
	},
1474

1475
	{
1476
		{"log_min_error_statement", PGC_SUSET, LOGGING_WHEN,
1477
			gettext_noop("Causes all statements generating error at or above this level to be logged."),
1478
			gettext_noop("All SQL statements that cause an error of the "
1479
						 "specified level or a higher level are logged.")
1480 1481
		},
		&log_min_error_statement_str,
1482
		"panic", assign_min_error_statement, NULL
1483 1484
	},

Bruce Momjian's avatar
Add:  
Bruce Momjian committed
1485 1486
	{
		{"log_line_prefix", PGC_SIGHUP, LOGGING_WHAT,
Bruce Momjian's avatar
Bruce Momjian committed
1487 1488
			gettext_noop("Controls information prefixed to each log line"),
			gettext_noop("if blank no prefix is used")
Bruce Momjian's avatar
Add:  
Bruce Momjian committed
1489 1490 1491 1492 1493 1494
		},
		&Log_line_prefix,
		"", NULL, NULL
	},


1495
	{
1496
		{"DateStyle", PGC_USERSET, CLIENT_CONN_LOCALE,
1497
			gettext_noop("Sets the display format for date and time values."),
1498
			gettext_noop("Also controls interpretation of ambiguous "
1499
						 "date inputs."),
1500 1501
			GUC_LIST_INPUT | GUC_REPORT
		},
1502
		&datestyle_string,
1503
		"ISO, MDY", assign_datestyle, NULL
1504
	},
1505

1506 1507 1508 1509 1510 1511 1512 1513 1514
	{
		{"default_tablespace", PGC_USERSET, CLIENT_CONN_STATEMENT,
			gettext_noop("Sets the default tablespace to create tables and indexes in."),
			gettext_noop("An empty string selects the database's default tablespace.")
		},
		&default_tablespace,
		"", assign_default_tablespace, NULL
	},

1515
	{
1516
		{"default_transaction_isolation", PGC_USERSET, CLIENT_CONN_STATEMENT,
1517
			gettext_noop("Sets the transaction isolation level of each new transaction."),
1518
			gettext_noop("Each SQL transaction has an isolation level, which "
Bruce Momjian's avatar
Bruce Momjian committed
1519
						 "can be either \"read uncommitted\", \"read committed\", \"repeatable read\", or \"serializable\".")
1520 1521
		},
		&default_iso_level_string,
1522
		"read committed", assign_defaultxactisolevel, NULL
1523 1524
	},

1525
	{
1526
		{"dynamic_library_path", PGC_SUSET, CLIENT_CONN_OTHER,
1527
			gettext_noop("Sets the path for dynamically loadable modules."),
1528
			gettext_noop("If a dynamically loadable module needs to be opened and "
1529
						 "the specified name does not have a directory component (i.e., the "
1530
						 "name does not contain a slash), the system will search this path for "
1531 1532
						 "the specified file."),
			GUC_SUPERUSER_ONLY
1533 1534
		},
		&Dynamic_library_path,
1535
		"$libdir", NULL, NULL
1536 1537 1538
	},

	{
1539
		{"krb_server_keyfile", PGC_POSTMASTER, CONN_AUTH_SECURITY,
1540
			gettext_noop("Sets the location of the Kerberos server key file."),
1541 1542
			NULL,
			GUC_SUPERUSER_ONLY
1543 1544
		},
		&pg_krb_server_keyfile,
1545
		PG_KRB_SRVTAB, NULL, NULL
1546
	},
1547

1548 1549
	{
		{"rendezvous_name", PGC_POSTMASTER, CONN_AUTH_SETTINGS,
1550
			gettext_noop("Sets the Rendezvous broadcast service name."),
1551 1552 1553 1554 1555 1556
			NULL
		},
		&rendezvous_name,
		"", NULL, NULL
	},

1557 1558
	/* See main.c about why defaults for LC_foo are not all alike */

1559
	{
1560
		{"lc_collate", PGC_INTERNAL, CLIENT_CONN_LOCALE,
1561
			gettext_noop("Shows the collation order locale."),
1562 1563 1564 1565
			NULL,
			GUC_NOT_IN_SAMPLE | GUC_DISALLOW_IN_FILE
		},
		&locale_collate,
1566 1567 1568 1569
		"C", NULL, NULL
	},

	{
1570
		{"lc_ctype", PGC_INTERNAL, CLIENT_CONN_LOCALE,
1571
			gettext_noop("Shows the character classification and case conversion locale."),
1572 1573 1574 1575
			NULL,
			GUC_NOT_IN_SAMPLE | GUC_DISALLOW_IN_FILE
		},
		&locale_ctype,
1576 1577 1578
		"C", NULL, NULL
	},

1579
	{
1580
		{"lc_messages", PGC_SUSET, CLIENT_CONN_LOCALE,
1581
			gettext_noop("Sets the language in which messages are displayed."),
1582 1583 1584
			NULL
		},
		&locale_messages,
1585 1586 1587 1588
		"", locale_messages_assign, NULL
	},

	{
1589
		{"lc_monetary", PGC_USERSET, CLIENT_CONN_LOCALE,
1590
			gettext_noop("Sets the locale for formatting monetary amounts."),
1591 1592 1593
			NULL
		},
		&locale_monetary,
1594
		"C", locale_monetary_assign, NULL
1595 1596 1597
	},

	{
1598
		{"lc_numeric", PGC_USERSET, CLIENT_CONN_LOCALE,
1599
			gettext_noop("Sets the locale for formatting numbers."),
1600 1601 1602
			NULL
		},
		&locale_numeric,
1603
		"C", locale_numeric_assign, NULL
1604 1605 1606
	},

	{
1607
		{"lc_time", PGC_USERSET, CLIENT_CONN_LOCALE,
1608
			gettext_noop("Sets the locale for formatting date and time values."),
1609 1610 1611
			NULL
		},
		&locale_time,
1612
		"C", locale_time_assign, NULL
1613 1614
	},

1615
	{
1616
		{"preload_libraries", PGC_POSTMASTER, RESOURCES_KERNEL,
1617
			gettext_noop("Lists shared libraries to preload into server."),
1618
			NULL,
1619
			GUC_LIST_INPUT | GUC_LIST_QUOTE | GUC_SUPERUSER_ONLY
1620
		},
1621
		&preload_libraries_string,
1622
		"", NULL, NULL
1623 1624
	},

1625
	{
1626
		{"regex_flavor", PGC_USERSET, COMPAT_OPTIONS_PREVIOUS,
1627
			gettext_noop("Sets the regular expression \"flavor\"."),
1628
			gettext_noop("This can be set to advanced, extended, or basic.")
1629 1630
		},
		&regex_flavor_string,
1631 1632 1633
		"advanced", assign_regex_flavor, NULL
	},

1634
	{
1635
		{"search_path", PGC_USERSET, CLIENT_CONN_STATEMENT,
1636
			gettext_noop("Sets the schema search order for names that are not schema-qualified."),
1637 1638 1639
			NULL,
			GUC_LIST_INPUT | GUC_LIST_QUOTE
		},
1640 1641
		&namespace_search_path,
		"$user,public", assign_search_path, NULL
1642 1643 1644
	},

	{
1645 1646
		/* Can't be set in postgresql.conf */
		{"server_encoding", PGC_INTERNAL, CLIENT_CONN_LOCALE,
1647
			gettext_noop("Sets the server (database) character set encoding."),
1648
			NULL,
1649
			GUC_REPORT | GUC_NOT_IN_SAMPLE | GUC_DISALLOW_IN_FILE
1650
		},
1651 1652 1653 1654 1655
		&server_encoding_string,
		"SQL_ASCII", NULL, NULL
	},

	{
1656
		/* Can't be set in postgresql.conf */
1657
		{"server_version", PGC_INTERNAL, PRESET_OPTIONS,
1658
			gettext_noop("Shows the server version."),
1659 1660 1661
			NULL,
			GUC_REPORT | GUC_NOT_IN_SAMPLE | GUC_DISALLOW_IN_FILE
		},
1662 1663
		&server_version_string,
		PG_VERSION, NULL, NULL
1664 1665
	},

1666
	{
1667 1668
		/* Not for general use --- used by SET SESSION AUTHORIZATION */
		{"session_authorization", PGC_USERSET, UNGROUPED,
1669
			gettext_noop("Sets the session user name."),
1670
			NULL,
1671
			GUC_REPORT | GUC_NO_SHOW_ALL | GUC_NO_RESET_ALL | GUC_NOT_IN_SAMPLE | GUC_DISALLOW_IN_FILE
1672
		},
1673 1674
		&session_authorization_string,
		NULL, assign_session_authorization, show_session_authorization
1675 1676
	},

1677
	{
1678
		{"log_destination", PGC_SIGHUP, LOGGING_WHERE,
Bruce Momjian's avatar
Bruce Momjian committed
1679
			gettext_noop("Sets the destination for server log output."),
Peter Eisentraut's avatar
Peter Eisentraut committed
1680 1681
			gettext_noop("Valid values are combinations of \"stderr\", \"syslog\", "
						 "and \"eventlog\", depending on the platform."),
Bruce Momjian's avatar
Bruce Momjian committed
1682
			GUC_LIST_INPUT
1683 1684 1685 1686
		},
		&log_destination_string,
		"stderr", assign_log_destination, NULL
	},
1687 1688
	{
		{"log_directory", PGC_SIGHUP, LOGGING_WHERE,
1689
			gettext_noop("Sets the destination directory for log files."),
1690
			gettext_noop("May be specified as relative to the data directory "
1691 1692
						 "or as absolute path."),
			GUC_SUPERUSER_ONLY
1693 1694
		},
		&Log_directory,
1695
		"pg_log", assign_canonical_path, NULL
1696 1697
	},
	{
1698 1699
		{"log_filename", PGC_SIGHUP, LOGGING_WHERE,
			gettext_noop("Sets the file name pattern for log files."),
1700 1701
			NULL,
			GUC_SUPERUSER_ONLY
1702
		},
1703 1704
		&Log_filename,
		"postgresql-%Y-%m-%d_%H%M%S.log", NULL, NULL
1705
	},
1706

Tatsuo Ishii's avatar
Tatsuo Ishii committed
1707
#ifdef HAVE_SYSLOG
1708
	{
1709
		{"syslog_facility", PGC_POSTMASTER, LOGGING_WHERE,
1710
			gettext_noop("Sets the syslog \"facility\" to be used when syslog enabled."),
1711 1712
			gettext_noop("Valid values are LOCAL0, LOCAL1, LOCAL2, LOCAL3, "
						 "LOCAL4, LOCAL5, LOCAL6, LOCAL7.")
1713 1714
		},
		&Syslog_facility,
1715
		"LOCAL0", assign_facility, NULL
1716 1717
	},
	{
1718
		{"syslog_ident", PGC_POSTMASTER, LOGGING_WHERE,
1719 1720
			gettext_noop("Sets the program name used to identify PostgreSQL messages "
						 "in syslog."),
1721 1722 1723
			NULL
		},
		&Syslog_ident,
1724
		"postgres", NULL, NULL
1725
	},
1726
#endif
1727

1728
	{
1729
		{"TimeZone", PGC_USERSET, CLIENT_CONN_LOCALE,
1730
			gettext_noop("Sets the time zone for displaying and interpreting time stamps."),
1731 1732 1733
			NULL
		},
		&timezone_string,
1734 1735 1736 1737
		"UNKNOWN", assign_timezone, show_timezone
	},

	{
1738
		{"transaction_isolation", PGC_USERSET, CLIENT_CONN_STATEMENT,
1739
			gettext_noop("Sets the current transaction's isolation level."),
1740 1741 1742
			NULL,
			GUC_NO_RESET_ALL | GUC_NOT_IN_SAMPLE | GUC_DISALLOW_IN_FILE
		},
1743 1744 1745 1746 1747
		&XactIsoLevel_string,
		NULL, assign_XactIsoLevel, show_XactIsoLevel
	},

	{
1748
		{"unix_socket_group", PGC_POSTMASTER, CONN_AUTH_SETTINGS,
1749
			gettext_noop("Sets the owning group of the Unix-domain socket."),
1750 1751 1752 1753
			gettext_noop("(The owning user of the socket is always the user "
						 "that starts the server.)")
		},
		&Unix_socket_group,
1754
		"", NULL, NULL
1755
	},
1756

1757
	{
1758
		{"unix_socket_directory", PGC_POSTMASTER, CONN_AUTH_SETTINGS,
1759
			gettext_noop("Sets the directory where the Unix-domain socket will be created."),
1760 1761
			NULL,
			GUC_SUPERUSER_ONLY
1762 1763
		},
		&UnixSocketDir,
1764
		"", assign_canonical_path, NULL
1765
	},
1766

1767
	{
1768
		{"listen_addresses", PGC_POSTMASTER, CONN_AUTH_SETTINGS,
1769 1770 1771
			gettext_noop("Sets the host name or IP address(es) to listen to."),
			NULL,
			GUC_LIST_INPUT
1772
		},
1773 1774
		&ListenAddresses,
		"localhost", NULL, NULL
1775
	},
1776

1777
	{
1778
		{"wal_sync_method", PGC_SIGHUP, WAL_SETTINGS,
1779
			gettext_noop("Selects the method used for forcing WAL updates out to disk."),
1780 1781 1782
			NULL
		},
		&XLOG_sync_method,
1783
		XLOG_sync_method_default, assign_xlog_sync_method, NULL
1784
	},
1785

1786 1787
	{
		{"custom_variable_classes", PGC_POSTMASTER, RESOURCES_KERNEL,
1788
			gettext_noop("Sets the list of known custom variable classes."),
1789 1790 1791 1792 1793 1794 1795
			NULL,
			GUC_LIST_INPUT | GUC_LIST_QUOTE
		},
		&custom_variable_classes,
		NULL, assign_custom_variable_classes, NULL
	},

1796
	{
1797
		{"data_directory", PGC_POSTMASTER, FILE_LOCATIONS,
Peter Eisentraut's avatar
Peter Eisentraut committed
1798
		 gettext_noop("Sets the server's data directory."),
1799 1800
		 NULL,
		 GUC_SUPERUSER_ONLY
1801
		},
1802 1803
		&data_directory,
		NULL, NULL, NULL
1804 1805 1806
	},

	{
1807
		{"config_file", PGC_POSTMASTER, FILE_LOCATIONS,
Peter Eisentraut's avatar
Peter Eisentraut committed
1808
		 gettext_noop("Sets the server's main configuration file."),
1809
		 NULL,
1810
		 GUC_DISALLOW_IN_FILE | GUC_SUPERUSER_ONLY
1811 1812 1813 1814 1815 1816 1817 1818
		},
		&ConfigFileName,
		NULL, NULL, NULL
	},

	{
		{"hba_file", PGC_POSTMASTER, FILE_LOCATIONS,
		 gettext_noop("Sets the server's \"hba\" configuration file"),
1819 1820
		 NULL,
		 GUC_SUPERUSER_ONLY
1821
		},
1822 1823
		&HbaFileName,
		NULL, NULL, NULL
1824 1825 1826
	},

	{
1827 1828
		{"ident_file", PGC_POSTMASTER, FILE_LOCATIONS,
		 gettext_noop("Sets the server's \"ident\" configuration file"),
1829 1830
		 NULL,
		 GUC_SUPERUSER_ONLY
1831
		},
1832 1833
		&IdentFileName,
		NULL, NULL, NULL
1834 1835 1836
	},

	{
1837
		{"external_pid_file", PGC_POSTMASTER, FILE_LOCATIONS,
Peter Eisentraut's avatar
Peter Eisentraut committed
1838
		 gettext_noop("Writes the postmaster PID to the specified file."),
1839 1840
		 NULL,
		 GUC_SUPERUSER_ONLY
1841
		},
1842
		&external_pid_file,
1843
		NULL, assign_canonical_path, NULL
1844 1845
	},

1846
	/* End-of-list marker */
1847
	{
1848
		{NULL, 0, 0, NULL, NULL}, NULL, NULL, NULL, NULL
1849
	}
1850 1851 1852
};


1853
/******** end of options list ********/
1854

Bruce Momjian's avatar
Bruce Momjian committed
1855

1856 1857 1858 1859 1860 1861
/*
 * 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.
 */
Bruce Momjian's avatar
Bruce Momjian committed
1862
static const char *const map_old_guc_names[] = {
1863 1864 1865 1866 1867 1868
	"sort_mem", "work_mem",
	"vacuum_mem", "maintenance_work_mem",
	NULL
};


1869
/*
1870
 * Actual lookup of variables is done through this single, sorted array.
1871
 */
1872 1873
static struct config_generic **guc_variables;

1874
/* Current number of variables contained in the vector */
Bruce Momjian's avatar
Bruce Momjian committed
1875
static int	num_guc_variables;
1876

1877
/* Vector capacity */
Bruce Momjian's avatar
Bruce Momjian committed
1878
static int	size_guc_variables;
1879

1880

1881
static bool guc_dirty;			/* TRUE if need to do commit/abort work */
1882

1883 1884
static bool reporting_enabled;	/* TRUE to enable GUC_REPORT */

Bruce Momjian's avatar
Bruce Momjian committed
1885
static char *guc_string_workspace;		/* for avoiding memory leaks */
1886

1887

Bruce Momjian's avatar
Bruce Momjian committed
1888
static int	guc_var_compare(const void *a, const void *b);
1889
static int	guc_name_compare(const char *namea, const char *nameb);
Bruce Momjian's avatar
Bruce Momjian committed
1890
static void push_old_value(struct config_generic * gconf);
1891
static void ReportGUCOption(struct config_generic * record);
1892 1893
static void ShowGUCConfigOption(const char *name, DestReceiver *dest);
static void ShowAllGUCConfig(DestReceiver *dest);
Bruce Momjian's avatar
Bruce Momjian committed
1894
static char *_ShowOption(struct config_generic * record);
1895

1896

1897 1898 1899 1900 1901 1902
/*
 * Some infrastructure for checking malloc/strdup/realloc calls
 */
static void *
guc_malloc(int elevel, size_t size)
{
Bruce Momjian's avatar
Bruce Momjian committed
1903
	void	   *data;
1904 1905 1906 1907 1908 1909 1910 1911 1912 1913 1914 1915

	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)
{
Bruce Momjian's avatar
Bruce Momjian committed
1916
	void	   *data;
1917 1918 1919 1920 1921 1922 1923 1924 1925 1926 1927 1928

	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)
{
Bruce Momjian's avatar
Bruce Momjian committed
1929
	char	   *data;
1930 1931 1932 1933 1934 1935 1936 1937 1938 1939

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


1940 1941 1942 1943 1944 1945
/*
 * 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
Bruce Momjian's avatar
Bruce Momjian committed
1946
set_string_field(struct config_string * conf, char **field, char *newval)
1947
{
Bruce Momjian's avatar
Bruce Momjian committed
1948 1949
	char	   *oldval = *field;
	GucStack   *stack;
1950 1951 1952 1953 1954 1955 1956 1957 1958 1959 1960 1961 1962 1963 1964 1965 1966 1967 1968 1969 1970 1971 1972 1973 1974

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

	/* Exit if any duplicate references, or if old value was NULL anyway */
	if (oldval == NULL ||
		oldval == *(conf->variable) ||
		oldval == conf->reset_val ||
		oldval == conf->tentative_val)
		return;
	for (stack = conf->gen.stack; stack; stack = stack->prev)
	{
		if (oldval == stack->tentative_val.stringval ||
			oldval == stack->value.stringval)
			return;
	}

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

/*
 * Detect whether strval is referenced anywhere in a GUC string item
 */
static bool
Bruce Momjian's avatar
Bruce Momjian committed
1975
string_field_used(struct config_string * conf, char *strval)
1976
{
Bruce Momjian's avatar
Bruce Momjian committed
1977
	GucStack   *stack;
1978 1979 1980 1981 1982 1983 1984 1985 1986 1987 1988 1989 1990 1991 1992 1993 1994

	if (strval == *(conf->variable) ||
		strval == conf->reset_val ||
		strval == conf->tentative_val)
		return true;
	for (stack = conf->gen.stack; stack; stack = stack->prev)
	{
		if (strval == stack->tentative_val.stringval ||
			strval == stack->value.stringval)
			return true;
	}
	return false;
}


struct config_generic **
get_guc_variables(void)
1995 1996 1997
{
	return guc_variables;
}
1998

1999

2000
/*
Bruce Momjian's avatar
Bruce Momjian committed
2001
 * Build the sorted array.	This is split out so that it could be
2002 2003
 * re-executed after startup (eg, we could allow loadable modules to
 * add vars, and then we'd need to re-sort).
2004
 */
2005
void
2006
build_guc_variables(void)
2007
{
Bruce Momjian's avatar
Bruce Momjian committed
2008
	int			size_vars;
2009 2010
	int			num_vars = 0;
	struct config_generic **guc_vars;
2011
	int			i;
2012

2013
	for (i = 0; ConfigureNamesBool[i].gen.name; i++)
2014 2015 2016
	{
		struct config_bool *conf = &ConfigureNamesBool[i];

2017 2018 2019
		/* Rather than requiring vartype to be filled in by hand, do this: */
		conf->gen.vartype = PGC_BOOL;
		num_vars++;
2020
	}
2021

2022
	for (i = 0; ConfigureNamesInt[i].gen.name; i++)
2023 2024 2025
	{
		struct config_int *conf = &ConfigureNamesInt[i];

2026 2027
		conf->gen.vartype = PGC_INT;
		num_vars++;
2028
	}
2029

2030
	for (i = 0; ConfigureNamesReal[i].gen.name; i++)
2031 2032 2033
	{
		struct config_real *conf = &ConfigureNamesReal[i];

2034 2035
		conf->gen.vartype = PGC_REAL;
		num_vars++;
2036
	}
2037

2038
	for (i = 0; ConfigureNamesString[i].gen.name; i++)
2039
	{
2040
		struct config_string *conf = &ConfigureNamesString[i];
2041

2042 2043
		conf->gen.vartype = PGC_STRING;
		num_vars++;
2044 2045
	}

Bruce Momjian's avatar
Bruce Momjian committed
2046 2047
	/*
	 * Create table with 20% slack
2048 2049 2050
	 */
	size_vars = num_vars + num_vars / 4;

2051
	guc_vars = (struct config_generic **)
2052
		guc_malloc(FATAL, size_vars * sizeof(struct config_generic *));
2053

2054
	num_vars = 0;
2055

2056
	for (i = 0; ConfigureNamesBool[i].gen.name; i++)
Bruce Momjian's avatar
Bruce Momjian committed
2057
		guc_vars[num_vars++] = &ConfigureNamesBool[i].gen;
2058

2059
	for (i = 0; ConfigureNamesInt[i].gen.name; i++)
Bruce Momjian's avatar
Bruce Momjian committed
2060
		guc_vars[num_vars++] = &ConfigureNamesInt[i].gen;
2061

2062
	for (i = 0; ConfigureNamesReal[i].gen.name; i++)
Bruce Momjian's avatar
Bruce Momjian committed
2063
		guc_vars[num_vars++] = &ConfigureNamesReal[i].gen;
2064

2065
	for (i = 0; ConfigureNamesString[i].gen.name; i++)
Bruce Momjian's avatar
Bruce Momjian committed
2066
		guc_vars[num_vars++] = &ConfigureNamesString[i].gen;
2067

2068 2069 2070 2071
	if (guc_variables)
		free(guc_variables);
	guc_variables = guc_vars;
	num_guc_variables = num_vars;
2072
	size_guc_variables = size_vars;
Bruce Momjian's avatar
Bruce Momjian committed
2073 2074
	qsort((void *) guc_variables, num_guc_variables,
		  sizeof(struct config_generic *), guc_var_compare);
2075 2076
}

2077 2078 2079
static bool
is_custom_class(const char *name, int dotPos)
{
Bruce Momjian's avatar
Bruce Momjian committed
2080
	/*
2081
	 * assign_custom_variable_classes() has made sure no empty
2082 2083
	 * identifiers or whitespace exists in the variable
	 */
Bruce Momjian's avatar
Bruce Momjian committed
2084
	bool		result = false;
2085
	const char *ccs = GetConfigOption("custom_variable_classes");
Bruce Momjian's avatar
Bruce Momjian committed
2086 2087

	if (ccs != NULL)
2088 2089
	{
		const char *start = ccs;
Bruce Momjian's avatar
Bruce Momjian committed
2090 2091

		for (;; ++ccs)
2092
		{
Bruce Momjian's avatar
Bruce Momjian committed
2093 2094 2095
			int			c = *ccs;

			if (c == 0 || c == ',')
2096
			{
Bruce Momjian's avatar
Bruce Momjian committed
2097
				if (dotPos == ccs - start && strncmp(start, name, dotPos) == 0)
2098 2099 2100 2101
				{
					result = true;
					break;
				}
Bruce Momjian's avatar
Bruce Momjian committed
2102
				if (c == 0)
2103 2104 2105 2106 2107 2108 2109 2110 2111 2112 2113 2114
					break;
				start = ccs + 1;
			}
		}
	}
	return result;
}

/*
 * Add a new GUC variable to the list of known variables. The
 * list is expanded if needed.
 */
2115
static bool
Bruce Momjian's avatar
Bruce Momjian committed
2116
add_guc_variable(struct config_generic * var, int elevel)
2117
{
Bruce Momjian's avatar
Bruce Momjian committed
2118
	if (num_guc_variables + 1 >= size_guc_variables)
2119
	{
Bruce Momjian's avatar
Bruce Momjian committed
2120 2121
		/*
		 * Increase the vector by 25%
2122
		 */
Bruce Momjian's avatar
Bruce Momjian committed
2123 2124
		int			size_vars = size_guc_variables + size_guc_variables / 4;
		struct config_generic **guc_vars;
2125

Bruce Momjian's avatar
Bruce Momjian committed
2126
		if (size_vars == 0)
2127
		{
2128
			size_vars = 100;
Bruce Momjian's avatar
Bruce Momjian committed
2129 2130
			guc_vars = (struct config_generic **)
				guc_malloc(elevel, size_vars * sizeof(struct config_generic *));
2131 2132
		}
		else
2133
		{
Bruce Momjian's avatar
Bruce Momjian committed
2134 2135
			guc_vars = (struct config_generic **)
				guc_realloc(elevel, guc_variables, size_vars * sizeof(struct config_generic *));
2136 2137
		}

Bruce Momjian's avatar
Bruce Momjian committed
2138
		if (guc_vars == NULL)
2139 2140
			return false;		/* out of memory */

2141 2142 2143 2144
		guc_variables = guc_vars;
		size_guc_variables = size_vars;
	}
	guc_variables[num_guc_variables++] = var;
Bruce Momjian's avatar
Bruce Momjian committed
2145 2146
	qsort((void *) guc_variables, num_guc_variables,
		  sizeof(struct config_generic *), guc_var_compare);
2147
	return true;
2148 2149 2150
}

/*
2151
 * Create and add a placeholder variable. It's presumed to belong
2152 2153
 * to a valid custom variable class at this point.
 */
Bruce Momjian's avatar
Bruce Momjian committed
2154
static struct config_string *
2155
add_placeholder_variable(const char *name, int elevel)
2156
{
Bruce Momjian's avatar
Bruce Momjian committed
2157 2158 2159
	size_t		sz = sizeof(struct config_string) + sizeof(char *);
	struct config_string *var;
	struct config_generic *gen;
2160

Bruce Momjian's avatar
Bruce Momjian committed
2161 2162
	var = (struct config_string *) guc_malloc(elevel, sz);
	if (var == NULL)
2163 2164 2165
		return NULL;

	gen = &var->gen;
2166 2167
	memset(var, 0, sz);

2168
	gen->name = guc_strdup(elevel, name);
Bruce Momjian's avatar
Bruce Momjian committed
2169
	if (gen->name == NULL)
2170 2171 2172 2173 2174
	{
		free(var);
		return NULL;
	}

Bruce Momjian's avatar
Bruce Momjian committed
2175 2176
	gen->context = PGC_USERSET;
	gen->group = CUSTOM_OPTIONS;
2177
	gen->short_desc = "GUC placeholder variable";
Bruce Momjian's avatar
Bruce Momjian committed
2178 2179
	gen->flags = GUC_NO_SHOW_ALL | GUC_NOT_IN_SAMPLE | GUC_CUSTOM_PLACEHOLDER;
	gen->vartype = PGC_STRING;
2180

Bruce Momjian's avatar
Bruce Momjian committed
2181 2182 2183 2184 2185
	/*
	 * The char* is allocated at the end of the struct since we have no
	 * 'static' place to point to.
	 */
	var->variable = (char **) (var + 1);
2186

Bruce Momjian's avatar
Bruce Momjian committed
2187
	if (!add_guc_variable((struct config_generic *) var, elevel))
2188 2189 2190 2191 2192 2193
	{
		free((void *) gen->name);
		free(var);
		return NULL;
	}

2194 2195
	return var;
}
2196 2197

/*
2198 2199
 * Look up option NAME. If it exists, return a pointer to its record,
 * else return NULL.
2200
 */
2201
static struct config_generic *
2202
find_option(const char *name, int elevel)
2203
{
2204
	const char *dot;
2205 2206
	const char **key = &name;
	struct config_generic **res;
2207
	int			i;
2208

2209
	Assert(name);
2210

2211
	/*
2212
	 * By equating const char ** with struct config_generic *, we are
2213 2214
	 * assuming the name field is first in config_generic.
	 */
Bruce Momjian's avatar
Bruce Momjian committed
2215 2216 2217 2218 2219
	res = (struct config_generic **) bsearch((void *) &key,
											 (void *) guc_variables,
											 num_guc_variables,
										 sizeof(struct config_generic *),
											 guc_var_compare);
2220 2221
	if (res)
		return *res;
2222 2223

	/*
Bruce Momjian's avatar
Bruce Momjian committed
2224
	 * See if the name is an obsolete name for a variable.	We assume that
2225 2226 2227 2228 2229 2230
	 * the set of supported old names is short enough that a brute-force
	 * search is the best way.
	 */
	for (i = 0; map_old_guc_names[i] != NULL; i += 2)
	{
		if (guc_name_compare(name, map_old_guc_names[i]) == 0)
Bruce Momjian's avatar
Bruce Momjian committed
2231
			return find_option(map_old_guc_names[i + 1], elevel);
2232 2233
	}

2234 2235
	/*
	 * Check if the name is qualified, and if so, check if the qualifier
2236 2237 2238
	 * maps to a custom variable class.
	 */
	dot = strchr(name, GUC_QUALIFIER_SEPARATOR);
Bruce Momjian's avatar
Bruce Momjian committed
2239
	if (dot != NULL && is_custom_class(name, dot - name))
2240
		/* Add a placeholder variable for this name */
Bruce Momjian's avatar
Bruce Momjian committed
2241
		return (struct config_generic *) add_placeholder_variable(name, elevel);
2242

2243
	/* Unknown name */
2244 2245
	return NULL;
}
2246 2247 2248


/*
2249
 * comparator for qsorting and bsearching guc_variables array
2250
 */
2251 2252
static int
guc_var_compare(const void *a, const void *b)
2253
{
2254 2255
	struct config_generic *confa = *(struct config_generic **) a;
	struct config_generic *confb = *(struct config_generic **) b;
2256

2257 2258 2259 2260 2261 2262 2263
	return guc_name_compare(confa->name, confb->name);
}


static int
guc_name_compare(const char *namea, const char *nameb)
{
2264 2265 2266
	/*
	 * The temptation to use strcasecmp() here must be resisted, because
	 * the array ordering has to remain stable across setlocale() calls.
2267
	 * So, build our own with a simple ASCII-only downcasing.
2268
	 */
2269 2270 2271 2272 2273 2274 2275 2276 2277 2278 2279
	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;
2280
	}
2281 2282 2283 2284 2285
	if (*namea)
		return 1;				/* a is longer */
	if (*nameb)
		return -1;				/* b is longer */
	return 0;
2286
}
2287 2288 2289


/*
2290
 * Initialize GUC options during program startup.
2291 2292 2293
 *
 * Note that we cannot read the config file yet, since we have not yet
 * processed command-line switches.
2294
 */
2295 2296
void
InitializeGUCOptions(void)
2297
{
2298 2299
	int			i;
	char	   *env;
2300

2301 2302 2303 2304
	/*
	 * Build sorted array of all GUC variables.
	 */
	build_guc_variables();
2305

2306
	/*
2307 2308
	 * Load all variables with their compiled-in defaults, and initialize
	 * status fields as needed.
2309
	 */
2310
	for (i = 0; i < num_guc_variables; i++)
2311
	{
2312
		struct config_generic *gconf = guc_variables[i];
2313

2314 2315 2316 2317
		gconf->status = 0;
		gconf->reset_source = PGC_S_DEFAULT;
		gconf->tentative_source = PGC_S_DEFAULT;
		gconf->source = PGC_S_DEFAULT;
2318
		gconf->stack = NULL;
2319 2320 2321 2322

		switch (gconf->vartype)
		{
			case PGC_BOOL:
Bruce Momjian's avatar
Bruce Momjian committed
2323 2324
				{
					struct config_bool *conf = (struct config_bool *) gconf;
2325

Bruce Momjian's avatar
Bruce Momjian committed
2326
					if (conf->assign_hook)
2327 2328
						if (!(*conf->assign_hook) (conf->reset_val, true,
												   PGC_S_DEFAULT))
2329 2330
							elog(FATAL, "failed to initialize %s to %d",
								 conf->gen.name, (int) conf->reset_val);
Bruce Momjian's avatar
Bruce Momjian committed
2331 2332 2333
					*conf->variable = conf->reset_val;
					break;
				}
2334
			case PGC_INT:
Bruce Momjian's avatar
Bruce Momjian committed
2335 2336
				{
					struct config_int *conf = (struct config_int *) gconf;
2337

Bruce Momjian's avatar
Bruce Momjian committed
2338 2339 2340
					Assert(conf->reset_val >= conf->min);
					Assert(conf->reset_val <= conf->max);
					if (conf->assign_hook)
2341 2342
						if (!(*conf->assign_hook) (conf->reset_val, true,
												   PGC_S_DEFAULT))
2343 2344
							elog(FATAL, "failed to initialize %s to %d",
								 conf->gen.name, conf->reset_val);
Bruce Momjian's avatar
Bruce Momjian committed
2345 2346 2347
					*conf->variable = conf->reset_val;
					break;
				}
2348 2349
			case PGC_REAL:
				{
Bruce Momjian's avatar
Bruce Momjian committed
2350 2351 2352 2353 2354
					struct config_real *conf = (struct config_real *) gconf;

					Assert(conf->reset_val >= conf->min);
					Assert(conf->reset_val <= conf->max);
					if (conf->assign_hook)
2355 2356
						if (!(*conf->assign_hook) (conf->reset_val, true,
												   PGC_S_DEFAULT))
2357 2358
							elog(FATAL, "failed to initialize %s to %g",
								 conf->gen.name, conf->reset_val);
Bruce Momjian's avatar
Bruce Momjian committed
2359
					*conf->variable = conf->reset_val;
2360 2361
					break;
				}
Bruce Momjian's avatar
Bruce Momjian committed
2362
			case PGC_STRING:
2363
				{
Bruce Momjian's avatar
Bruce Momjian committed
2364 2365 2366 2367 2368 2369
					struct config_string *conf = (struct config_string *) gconf;
					char	   *str;

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

Bruce Momjian's avatar
Bruce Momjian committed
2371
					if (conf->boot_val == NULL)
2372
					{
Bruce Momjian's avatar
Bruce Momjian committed
2373 2374
						/* Cannot set value yet */
						break;
2375
					}
Bruce Momjian's avatar
Bruce Momjian committed
2376

2377
					str = guc_strdup(FATAL, conf->boot_val);
Bruce Momjian's avatar
Bruce Momjian committed
2378 2379 2380
					conf->reset_val = str;

					if (conf->assign_hook)
2381
					{
Bruce Momjian's avatar
Bruce Momjian committed
2382 2383
						const char *newstr;

2384 2385
						newstr = (*conf->assign_hook) (str, true,
													   PGC_S_DEFAULT);
Bruce Momjian's avatar
Bruce Momjian committed
2386 2387
						if (newstr == NULL)
						{
2388 2389
							elog(FATAL, "failed to initialize %s to \"%s\"",
								 conf->gen.name, str);
Bruce Momjian's avatar
Bruce Momjian committed
2390 2391 2392 2393 2394 2395 2396 2397 2398 2399 2400 2401
						}
						else if (newstr != str)
						{
							free(str);

							/*
							 * See notes in set_config_option about
							 * casting
							 */
							str = (char *) newstr;
							conf->reset_val = str;
						}
2402
					}
Bruce Momjian's avatar
Bruce Momjian committed
2403 2404
					*conf->variable = str;
					break;
2405 2406 2407 2408 2409 2410
				}
		}
	}

	guc_dirty = false;

2411 2412
	reporting_enabled = false;

2413 2414 2415
	guc_string_workspace = NULL;

	/*
2416
	 * Prevent any attempt to override the transaction modes from
2417 2418
	 * non-interactive sources.
	 */
2419 2420 2421
	SetConfigOption("transaction_isolation", "default",
					PGC_POSTMASTER, PGC_S_OVERRIDE);
	SetConfigOption("transaction_read_only", "no",
2422 2423 2424 2425
					PGC_POSTMASTER, PGC_S_OVERRIDE);

	/*
	 * For historical reasons, some GUC parameters can receive defaults
Bruce Momjian's avatar
Bruce Momjian committed
2426
	 * from environment variables.	Process those settings.
2427 2428 2429 2430 2431 2432 2433 2434 2435 2436 2437 2438 2439 2440 2441 2442
	 */

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

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

	env = getenv("PGCLIENTENCODING");
	if (env != NULL)
		SetConfigOption("client_encoding", env, PGC_POSTMASTER, PGC_S_ENV_VAR);
}


2443 2444 2445 2446 2447 2448 2449 2450 2451 2452 2453 2454 2455 2456
/*
 * 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)
{
2457 2458
	char	   *configdir;
	char	   *fname;
2459 2460
	struct stat stat_buf;

2461 2462 2463 2464 2465
	/* configdir is -D option, or $PGDATA if no -D */
	if (userDoption)
		configdir = make_absolute_path(userDoption);
	else
		configdir = make_absolute_path(getenv("PGDATA"));
2466 2467

	/*
2468 2469 2470 2471
	 * Find the configuration file: if config_file was specified on the
	 * 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.
2472
	 */
2473 2474 2475
	if (ConfigFileName)
		fname = make_absolute_path(ConfigFileName);
	else if (!configdir)
2476
	{
2477
		write_stderr("%s does not know where to find the server configuration file.\n"
Peter Eisentraut's avatar
Peter Eisentraut committed
2478
					 "You must specify the --config-file or -D invocation "
2479 2480 2481
					 "option or set the PGDATA environment variable.\n",
					 progname);
		return false;
2482 2483 2484
	}
	else
	{
2485 2486 2487
		fname = guc_malloc(FATAL,
						   strlen(configdir) + strlen(CONFIG_FILENAME) + 2);
		sprintf(fname, "%s/%s", configdir, CONFIG_FILENAME);
2488 2489
	}

2490 2491 2492 2493 2494 2495 2496 2497 2498 2499
	/*
	 * Set the ConfigFileName GUC variable to its final value, ensuring
	 * that it can't be overridden later.
	 */
	SetConfigOption("config_file", fname, PGC_POSTMASTER, PGC_S_OVERRIDE);
	free(fname);

	/*
	 * Now read the config file for the first time.
	 */
2500 2501
	if (stat(ConfigFileName, &stat_buf) != 0)
	{
2502
		write_stderr("%s cannot access the server configuration file \"%s\": %s\n",
2503 2504 2505 2506 2507 2508 2509
					 progname, ConfigFileName, strerror(errno));
		return false;
	}

	ProcessConfigFile(PGC_POSTMASTER);

	/*
2510 2511
	 * If the data_directory GUC variable has been set, use that as DataDir;
	 * otherwise use configdir if set; else punt.
2512
	 *
2513
	 * Note: SetDataDir will copy and absolute-ize its argument,
2514 2515
	 * so we don't have to.
	 */
2516 2517 2518 2519
	if (data_directory)
		SetDataDir(data_directory);
	else if (configdir)
		SetDataDir(configdir);
2520 2521 2522
	else
	{
		write_stderr("%s does not know where to find the database system data.\n"
2523 2524 2525 2526 2527 2528 2529 2530 2531 2532 2533 2534 2535 2536 2537 2538 2539 2540 2541 2542 2543 2544 2545 2546 2547 2548
					 "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
	 * child backends specially.)
	 */
	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);
	else if (!configdir)
	{
		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",
2549 2550 2551
					 progname, ConfigFileName);
		return false;
	}
2552 2553 2554 2555 2556 2557 2558 2559
	else
	{
		fname = guc_malloc(FATAL,
						   strlen(configdir) + strlen(HBA_FILENAME) + 2);
		sprintf(fname, "%s/%s", configdir, HBA_FILENAME);
	}
	SetConfigOption("hba_file", fname, PGC_POSTMASTER, PGC_S_OVERRIDE);
	free(fname);
2560 2561

	/*
2562
	 * Likewise for pg_ident.conf.
2563
	 */
2564 2565 2566 2567 2568 2569 2570 2571 2572 2573 2574 2575 2576 2577 2578 2579 2580 2581 2582 2583 2584
	if (IdentFileName)
		fname = make_absolute_path(IdentFileName);
	else if (!configdir)
	{
		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;
	}
	else
	{
		fname = guc_malloc(FATAL,
						   strlen(configdir) + strlen(IDENT_FILENAME) + 2);
		sprintf(fname, "%s/%s", configdir, IDENT_FILENAME);
	}
	SetConfigOption("ident_file", fname, PGC_POSTMASTER, PGC_S_OVERRIDE);
	free(fname);

	free(configdir);
2585 2586 2587 2588 2589 2590 2591 2592

	/* If timezone is not set, determine what the OS uses */
	pg_timezone_initialize();

	return true;
}


2593 2594 2595 2596 2597 2598 2599 2600 2601 2602 2603 2604 2605
/*
 * 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 */
2606 2607
		if (gconf->context != PGC_SUSET &&
			gconf->context != PGC_USERSET)
2608 2609 2610 2611 2612 2613 2614 2615
			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;

2616 2617 2618
		/* Save old value to support transaction abort */
		push_old_value(gconf);

2619 2620 2621
		switch (gconf->vartype)
		{
			case PGC_BOOL:
Bruce Momjian's avatar
Bruce Momjian committed
2622 2623
				{
					struct config_bool *conf = (struct config_bool *) gconf;
2624

Bruce Momjian's avatar
Bruce Momjian committed
2625
					if (conf->assign_hook)
2626 2627
						if (!(*conf->assign_hook) (conf->reset_val, true,
												   PGC_S_SESSION))
2628
							elog(ERROR, "failed to reset %s", conf->gen.name);
Bruce Momjian's avatar
Bruce Momjian committed
2629 2630 2631 2632 2633 2634 2635 2636
					*conf->variable = conf->reset_val;
					conf->tentative_val = conf->reset_val;
					conf->gen.source = conf->gen.reset_source;
					conf->gen.tentative_source = conf->gen.reset_source;
					conf->gen.status |= GUC_HAVE_TENTATIVE;
					guc_dirty = true;
					break;
				}
2637
			case PGC_INT:
Bruce Momjian's avatar
Bruce Momjian committed
2638 2639
				{
					struct config_int *conf = (struct config_int *) gconf;
2640

Bruce Momjian's avatar
Bruce Momjian committed
2641
					if (conf->assign_hook)
2642 2643
						if (!(*conf->assign_hook) (conf->reset_val, true,
												   PGC_S_SESSION))
2644
							elog(ERROR, "failed to reset %s", conf->gen.name);
Bruce Momjian's avatar
Bruce Momjian committed
2645 2646 2647 2648 2649 2650 2651 2652
					*conf->variable = conf->reset_val;
					conf->tentative_val = conf->reset_val;
					conf->gen.source = conf->gen.reset_source;
					conf->gen.tentative_source = conf->gen.reset_source;
					conf->gen.status |= GUC_HAVE_TENTATIVE;
					guc_dirty = true;
					break;
				}
2653 2654
			case PGC_REAL:
				{
Bruce Momjian's avatar
Bruce Momjian committed
2655 2656 2657
					struct config_real *conf = (struct config_real *) gconf;

					if (conf->assign_hook)
2658 2659
						if (!(*conf->assign_hook) (conf->reset_val, true,
												   PGC_S_SESSION))
2660
							elog(ERROR, "failed to reset %s", conf->gen.name);
Bruce Momjian's avatar
Bruce Momjian committed
2661 2662 2663 2664 2665 2666
					*conf->variable = conf->reset_val;
					conf->tentative_val = conf->reset_val;
					conf->gen.source = conf->gen.reset_source;
					conf->gen.tentative_source = conf->gen.reset_source;
					conf->gen.status |= GUC_HAVE_TENTATIVE;
					guc_dirty = true;
2667 2668
					break;
				}
Bruce Momjian's avatar
Bruce Momjian committed
2669 2670 2671 2672
			case PGC_STRING:
				{
					struct config_string *conf = (struct config_string *) gconf;
					char	   *str;
2673

Bruce Momjian's avatar
Bruce Momjian committed
2674 2675 2676 2677 2678
					if (conf->reset_val == NULL)
					{
						/* Nothing to reset to, as yet; so do nothing */
						break;
					}
2679

Bruce Momjian's avatar
Bruce Momjian committed
2680 2681
					/* We need not strdup here */
					str = conf->reset_val;
2682

Bruce Momjian's avatar
Bruce Momjian committed
2683
					if (conf->assign_hook)
2684
					{
Bruce Momjian's avatar
Bruce Momjian committed
2685 2686
						const char *newstr;

2687 2688
						newstr = (*conf->assign_hook) (str, true,
													   PGC_S_SESSION);
Bruce Momjian's avatar
Bruce Momjian committed
2689
						if (newstr == NULL)
2690
							elog(ERROR, "failed to reset %s", conf->gen.name);
Bruce Momjian's avatar
Bruce Momjian committed
2691 2692 2693 2694 2695 2696 2697 2698
						else if (newstr != str)
						{
							/*
							 * See notes in set_config_option about
							 * casting
							 */
							str = (char *) newstr;
						}
2699 2700
					}

2701 2702
					set_string_field(conf, conf->variable, str);
					set_string_field(conf, &conf->tentative_val, str);
Bruce Momjian's avatar
Bruce Momjian committed
2703 2704 2705 2706 2707 2708
					conf->gen.source = conf->gen.reset_source;
					conf->gen.tentative_source = conf->gen.reset_source;
					conf->gen.status |= GUC_HAVE_TENTATIVE;
					guc_dirty = true;
					break;
				}
2709
		}
2710 2711 2712

		if (gconf->flags & GUC_REPORT)
			ReportGUCOption(gconf);
2713 2714 2715 2716 2717
	}
}


/*
2718 2719 2720 2721 2722 2723 2724 2725 2726 2727
 * push_old_value
 *		Push previous state during first assignment to a GUC variable
 *		within a particular transaction.
 *
 * We have to be willing to "back-fill" the state stack if the first
 * assignment occurs within a subtransaction nested several levels deep.
 * This ensures that if an intermediate transaction aborts, it will have
 * the proper value available to restore the setting to.
 */
static void
Bruce Momjian's avatar
Bruce Momjian committed
2728
push_old_value(struct config_generic * gconf)
2729 2730 2731 2732 2733 2734 2735 2736 2737 2738 2739 2740 2741 2742 2743 2744
{
	int			my_level = GetCurrentTransactionNestLevel();
	GucStack   *stack;

	/* If we're not inside a transaction, do nothing */
	if (my_level == 0)
		return;

	for (;;)
	{
		/* Done if we already pushed it at this nesting depth */
		if (gconf->stack && gconf->stack->nest_level >= my_level)
			return;

		/*
		 * We keep all the stack entries in TopTransactionContext so as to
Bruce Momjian's avatar
Bruce Momjian committed
2745 2746
		 * avoid allocation problems when a subtransaction back-fills
		 * stack entries for upper transaction levels.
2747 2748 2749 2750 2751 2752 2753 2754 2755 2756 2757 2758 2759 2760 2761 2762 2763 2764 2765 2766 2767 2768 2769 2770 2771 2772 2773 2774 2775 2776 2777 2778 2779 2780 2781 2782 2783 2784 2785 2786 2787 2788 2789 2790 2791 2792 2793 2794 2795 2796 2797 2798 2799
		 */
		stack = (GucStack *) MemoryContextAlloc(TopTransactionContext,
												sizeof(GucStack));

		stack->prev = gconf->stack;
		stack->nest_level = stack->prev ? stack->prev->nest_level + 1 : 1;
		stack->status = gconf->status;
		stack->tentative_source = gconf->tentative_source;
		stack->source = gconf->source;

		switch (gconf->vartype)
		{
			case PGC_BOOL:
				stack->tentative_val.boolval =
					((struct config_bool *) gconf)->tentative_val;
				stack->value.boolval =
					*((struct config_bool *) gconf)->variable;
				break;

			case PGC_INT:
				stack->tentative_val.intval =
					((struct config_int *) gconf)->tentative_val;
				stack->value.intval =
					*((struct config_int *) gconf)->variable;
				break;

			case PGC_REAL:
				stack->tentative_val.realval =
					((struct config_real *) gconf)->tentative_val;
				stack->value.realval =
					*((struct config_real *) gconf)->variable;
				break;

			case PGC_STRING:
				stack->tentative_val.stringval =
					((struct config_string *) gconf)->tentative_val;
				stack->value.stringval =
					*((struct config_string *) gconf)->variable;
				break;
		}

		gconf->stack = stack;

		/* Set state to indicate nothing happened yet within this level */
		gconf->status = GUC_HAVE_STACK;

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

/*
 * Do GUC processing at transaction or subtransaction commit or abort.
2800 2801
 */
void
2802
AtEOXact_GUC(bool isCommit, bool isSubXact)
2803
{
2804
	int			my_level;
2805 2806 2807 2808 2809 2810
	int			i;

	/* Quick exit if nothing's changed in this transaction */
	if (!guc_dirty)
		return;

2811
	/* Prevent memory leak if ereport during an assign_hook */
2812 2813 2814 2815 2816 2817
	if (guc_string_workspace)
	{
		free(guc_string_workspace);
		guc_string_workspace = NULL;
	}

2818 2819 2820
	my_level = GetCurrentTransactionNestLevel();
	Assert(isSubXact ? (my_level > 1) : (my_level == 1));

2821 2822 2823
	for (i = 0; i < num_guc_variables; i++)
	{
		struct config_generic *gconf = guc_variables[i];
2824 2825 2826
		int			my_status = gconf->status;
		GucStack   *stack = gconf->stack;
		bool		useTentative;
2827
		bool		changed;
2828

2829 2830 2831 2832 2833 2834 2835 2836 2837 2838 2839 2840
		/*
		 * Skip if nothing's happened to this var in this transaction
		 */
		if (my_status == 0)
		{
			Assert(stack == NULL);
			continue;
		}
		/* Assert that we stacked old value before changing it */
		Assert(stack != NULL && (my_status & GUC_HAVE_STACK));
		/* However, the last change may have been at an outer xact level */
		if (stack->nest_level < my_level)
2841
			continue;
2842 2843 2844
		Assert(stack->nest_level == my_level);

		/*
Bruce Momjian's avatar
Bruce Momjian committed
2845 2846 2847 2848
		 * We will pop the stack entry.  Start by restoring outer xact
		 * status (since we may want to modify it below).  Be careful to
		 * use my_status to reference the inner xact status below this
		 * point...
2849 2850 2851 2852 2853 2854
		 */
		gconf->status = stack->status;

		/*
		 * We have two cases:
		 *
Bruce Momjian's avatar
Bruce Momjian committed
2855 2856 2857 2858 2859
		 * If commit and HAVE_TENTATIVE, set actual value to tentative (this
		 * is to override a SET LOCAL if one occurred later than SET). We
		 * keep the tentative value and propagate HAVE_TENTATIVE to the
		 * parent status, allowing the SET's effect to percolate up. (But
		 * if we're exiting the outermost transaction, we'll drop the
2860 2861
		 * HAVE_TENTATIVE bit below.)
		 *
Bruce Momjian's avatar
Bruce Momjian committed
2862 2863 2864 2865
		 * Otherwise, we have a transaction that aborted or executed only SET
		 * LOCAL (or no SET at all).  In either case it should have no
		 * further effect, so restore both tentative and actual values
		 * from the stack entry.
2866
		 */
2867

2868
		useTentative = isCommit && (my_status & GUC_HAVE_TENTATIVE) != 0;
2869 2870
		changed = false;

2871 2872 2873 2874
		switch (gconf->vartype)
		{
			case PGC_BOOL:
				{
Bruce Momjian's avatar
Bruce Momjian committed
2875
					struct config_bool *conf = (struct config_bool *) gconf;
2876 2877
					bool		newval;
					GucSource	newsource;
2878

2879 2880 2881 2882 2883 2884 2885
					if (useTentative)
					{
						newval = conf->tentative_val;
						newsource = conf->gen.tentative_source;
						conf->gen.status |= GUC_HAVE_TENTATIVE;
					}
					else
Bruce Momjian's avatar
Bruce Momjian committed
2886
					{
2887 2888 2889 2890
						newval = stack->value.boolval;
						newsource = stack->source;
						conf->tentative_val = stack->tentative_val.boolval;
						conf->gen.tentative_source = stack->tentative_source;
Bruce Momjian's avatar
Bruce Momjian committed
2891 2892
					}

2893
					if (*conf->variable != newval)
Bruce Momjian's avatar
Bruce Momjian committed
2894 2895
					{
						if (conf->assign_hook)
2896
							if (!(*conf->assign_hook) (newval,
Bruce Momjian's avatar
Bruce Momjian committed
2897
												   true, PGC_S_OVERRIDE))
2898 2899
								elog(LOG, "failed to commit %s",
									 conf->gen.name);
2900
						*conf->variable = newval;
2901
						changed = true;
Bruce Momjian's avatar
Bruce Momjian committed
2902
					}
2903
					conf->gen.source = newsource;
Bruce Momjian's avatar
Bruce Momjian committed
2904
					break;
2905 2906 2907
				}
			case PGC_INT:
				{
Bruce Momjian's avatar
Bruce Momjian committed
2908
					struct config_int *conf = (struct config_int *) gconf;
2909 2910
					int			newval;
					GucSource	newsource;
2911

2912 2913 2914 2915 2916 2917 2918
					if (useTentative)
					{
						newval = conf->tentative_val;
						newsource = conf->gen.tentative_source;
						conf->gen.status |= GUC_HAVE_TENTATIVE;
					}
					else
Bruce Momjian's avatar
Bruce Momjian committed
2919
					{
2920 2921 2922 2923
						newval = stack->value.intval;
						newsource = stack->source;
						conf->tentative_val = stack->tentative_val.intval;
						conf->gen.tentative_source = stack->tentative_source;
Bruce Momjian's avatar
Bruce Momjian committed
2924 2925
					}

2926
					if (*conf->variable != newval)
Bruce Momjian's avatar
Bruce Momjian committed
2927 2928
					{
						if (conf->assign_hook)
2929
							if (!(*conf->assign_hook) (newval,
Bruce Momjian's avatar
Bruce Momjian committed
2930
												   true, PGC_S_OVERRIDE))
2931 2932
								elog(LOG, "failed to commit %s",
									 conf->gen.name);
2933
						*conf->variable = newval;
2934
						changed = true;
Bruce Momjian's avatar
Bruce Momjian committed
2935
					}
2936
					conf->gen.source = newsource;
Bruce Momjian's avatar
Bruce Momjian committed
2937
					break;
2938 2939 2940
				}
			case PGC_REAL:
				{
Bruce Momjian's avatar
Bruce Momjian committed
2941
					struct config_real *conf = (struct config_real *) gconf;
2942 2943
					double		newval;
					GucSource	newsource;
2944

2945
					if (useTentative)
Bruce Momjian's avatar
Bruce Momjian committed
2946
					{
2947 2948 2949 2950 2951 2952 2953 2954 2955 2956
						newval = conf->tentative_val;
						newsource = conf->gen.tentative_source;
						conf->gen.status |= GUC_HAVE_TENTATIVE;
					}
					else
					{
						newval = stack->value.realval;
						newsource = stack->source;
						conf->tentative_val = stack->tentative_val.realval;
						conf->gen.tentative_source = stack->tentative_source;
Bruce Momjian's avatar
Bruce Momjian committed
2957
					}
2958

2959
					if (*conf->variable != newval)
Bruce Momjian's avatar
Bruce Momjian committed
2960 2961
					{
						if (conf->assign_hook)
2962
							if (!(*conf->assign_hook) (newval,
Bruce Momjian's avatar
Bruce Momjian committed
2963
												   true, PGC_S_OVERRIDE))
2964 2965
								elog(LOG, "failed to commit %s",
									 conf->gen.name);
2966
						*conf->variable = newval;
2967
						changed = true;
Bruce Momjian's avatar
Bruce Momjian committed
2968
					}
2969
					conf->gen.source = newsource;
Bruce Momjian's avatar
Bruce Momjian committed
2970
					break;
2971
				}
Bruce Momjian's avatar
Bruce Momjian committed
2972
			case PGC_STRING:
2973
				{
Bruce Momjian's avatar
Bruce Momjian committed
2974
					struct config_string *conf = (struct config_string *) gconf;
2975 2976
					char	   *newval;
					GucSource	newsource;
2977

2978
					if (useTentative)
Bruce Momjian's avatar
Bruce Momjian committed
2979
					{
2980 2981 2982
						newval = conf->tentative_val;
						newsource = conf->gen.tentative_source;
						conf->gen.status |= GUC_HAVE_TENTATIVE;
Bruce Momjian's avatar
Bruce Momjian committed
2983 2984
					}
					else
2985
					{
2986 2987 2988 2989 2990 2991
						newval = stack->value.stringval;
						newsource = stack->source;
						set_string_field(conf, &conf->tentative_val,
										 stack->tentative_val.stringval);
						conf->gen.tentative_source = stack->tentative_source;
					}
2992

2993 2994
					if (*conf->variable != newval)
					{
Bruce Momjian's avatar
Bruce Momjian committed
2995
						if (conf->assign_hook)
2996
						{
Bruce Momjian's avatar
Bruce Momjian committed
2997 2998
							const char *newstr;

2999
							newstr = (*conf->assign_hook) (newval, true,
Bruce Momjian's avatar
Bruce Momjian committed
3000
														 PGC_S_OVERRIDE);
Bruce Momjian's avatar
Bruce Momjian committed
3001
							if (newstr == NULL)
3002 3003
								elog(LOG, "failed to commit %s",
									 conf->gen.name);
3004
							else if (newstr != newval)
Bruce Momjian's avatar
Bruce Momjian committed
3005 3006
							{
								/*
3007 3008 3009
								 * If newval should now be freed, it'll be
								 * taken care of below.
								 *
Bruce Momjian's avatar
Bruce Momjian committed
3010 3011 3012
								 * See notes in set_config_option about
								 * casting
								 */
3013
								newval = (char *) newstr;
Bruce Momjian's avatar
Bruce Momjian committed
3014
							}
3015 3016
						}

3017
						set_string_field(conf, conf->variable, newval);
3018
						changed = true;
Bruce Momjian's avatar
Bruce Momjian committed
3019
					}
3020 3021 3022 3023 3024 3025 3026 3027 3028
					conf->gen.source = newsource;
					/* Release stacked values if not used anymore */
					set_string_field(conf, &stack->value.stringval,
									 NULL);
					set_string_field(conf, &stack->tentative_val.stringval,
									 NULL);
					/* Don't store tentative value separately after commit */
					if (!isSubXact)
						set_string_field(conf, &conf->tentative_val, NULL);
Bruce Momjian's avatar
Bruce Momjian committed
3029
					break;
3030 3031
				}
		}
3032

3033 3034 3035 3036 3037
		/* Finish popping the state stack */
		gconf->stack = stack->prev;
		pfree(stack);

		/*
Bruce Momjian's avatar
Bruce Momjian committed
3038 3039
		 * If we're now out of all xact levels, forget TENTATIVE status
		 * bit; there's nothing tentative about the value anymore.
3040 3041 3042 3043 3044 3045 3046 3047
		 */
		if (!isSubXact)
		{
			Assert(gconf->stack == NULL);
			gconf->status = 0;
		}

		/* Report new value if we changed it */
3048 3049
		if (changed && (gconf->flags & GUC_REPORT))
			ReportGUCOption(gconf);
3050 3051
	}

3052
	/*
Bruce Momjian's avatar
Bruce Momjian committed
3053 3054 3055 3056
	 * If we're now out of all xact levels, we can clear guc_dirty. (Note:
	 * we cannot reset guc_dirty when exiting a subtransaction, because we
	 * know that all outer transaction levels will have stacked values to
	 * deal with.)
3057 3058 3059
	 */
	if (!isSubXact)
		guc_dirty = false;
3060 3061 3062
}


3063 3064 3065 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
/*
 * Start up automatic reporting of changes to variables marked GUC_REPORT.
 * This is executed at completion of backend startup.
 */
void
BeginReportingGUCOptions(void)
{
	int			i;

	/*
	 * Don't do anything unless talking to an interactive frontend of
	 * protocol 3.0 or later.
	 */
	if (whereToSendOutput != Remote ||
		PG_PROTOCOL_MAJOR(FrontendProtocol) < 3)
		return;

	reporting_enabled = true;

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

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

/*
 * ReportGUCOption: if appropriate, transmit option value to frontend
 */
static void
3096
ReportGUCOption(struct config_generic * record)
3097 3098 3099
{
	if (reporting_enabled && (record->flags & GUC_REPORT))
	{
3100
		char	   *val = _ShowOption(record);
3101 3102 3103 3104 3105 3106 3107 3108 3109 3110 3111 3112
		StringInfoData msgbuf;

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

		pfree(val);
	}
}


3113 3114 3115 3116 3117 3118 3119 3120 3121 3122 3123
/*
 * Try to interpret value as boolean value.  Valid values are: true,
 * false, yes, no, on, off, 1, 0.  If the string parses okay, return
 * true, else false.  If result is not NULL, return the parsing result
 * there.
 */
static bool
parse_bool(const char *value, bool *result)
{
	size_t		len = strlen(value);

3124
	if (pg_strncasecmp(value, "true", len) == 0)
3125 3126 3127 3128
	{
		if (result)
			*result = true;
	}
3129
	else if (pg_strncasecmp(value, "false", len) == 0)
3130 3131 3132 3133 3134
	{
		if (result)
			*result = false;
	}

3135
	else if (pg_strncasecmp(value, "yes", len) == 0)
3136 3137 3138 3139
	{
		if (result)
			*result = true;
	}
3140
	else if (pg_strncasecmp(value, "no", len) == 0)
3141 3142 3143 3144 3145
	{
		if (result)
			*result = false;
	}

3146
	else if (pg_strcasecmp(value, "on") == 0)
3147 3148 3149 3150
	{
		if (result)
			*result = true;
	}
3151
	else if (pg_strcasecmp(value, "off") == 0)
3152 3153 3154 3155 3156
	{
		if (result)
			*result = false;
	}

3157
	else if (pg_strcasecmp(value, "1") == 0)
3158 3159 3160 3161
	{
		if (result)
			*result = true;
	}
3162
	else if (pg_strcasecmp(value, "0") == 0)
3163 3164 3165 3166 3167 3168 3169 3170 3171 3172 3173 3174 3175 3176 3177 3178 3179 3180 3181 3182 3183 3184 3185 3186 3187 3188 3189 3190 3191 3192 3193 3194 3195 3196 3197 3198 3199 3200 3201 3202 3203 3204 3205 3206 3207 3208 3209 3210 3211 3212 3213 3214 3215 3216 3217 3218 3219 3220 3221 3222 3223 3224 3225 3226 3227 3228 3229 3230 3231 3232
	{
		if (result)
			*result = false;
	}

	else
		return false;
	return true;
}



/*
 * Try to parse value as an integer.  The accepted formats are the
 * usual decimal, octal, or hexadecimal formats.  If the string parses
 * okay, return true, else false.  If result is not NULL, return the
 * value there.
 */
static bool
parse_int(const char *value, int *result)
{
	long		val;
	char	   *endptr;

	errno = 0;
	val = strtol(value, &endptr, 0);
	if (endptr == value || *endptr != '\0' || errno == ERANGE
#ifdef HAVE_LONG_INT_64
	/* if long > 32 bits, check for overflow of int4 */
		|| val != (long) ((int32) val)
#endif
		)
		return false;
	if (result)
		*result = (int) val;
	return true;
}



/*
 * Try to parse value as a floating point constant in the usual
 * format.	If the value parsed okay return true, else false.  If
 * result is not NULL, return the semantic value there.
 */
static bool
parse_real(const char *value, double *result)
{
	double		val;
	char	   *endptr;

	errno = 0;
	val = strtod(value, &endptr);
	if (endptr == value || *endptr != '\0' || errno == ERANGE)
		return false;
	if (result)
		*result = val;
	return true;
}



/*
 * Sets option `name' to given value. The value should be a string
 * which is going to be parsed and converted to the appropriate data
 * type.  The context and source parameters indicate in which context this
 * function is being called so it can apply the access restrictions
 * properly.
 *
 * If value is NULL, set the option to its default value. If the
3233
 * parameter changeVal is false then don't really set the option but do all
3234 3235 3236
 * the checks to see if it would work.
 *
 * If there is an error (non-existing option, invalid value) then an
3237 3238 3239 3240
 * ereport(ERROR) is thrown *unless* this is called in a context where we
 * don't want to ereport (currently, startup or SIGHUP config file reread).
 * In that case we write a suitable error message via ereport(DEBUG) and
 * return false. This is working around the deficiencies in the ereport
3241 3242 3243 3244 3245 3246 3247 3248 3249
 * mechanism, so don't blame me.  In all other cases, the function
 * returns true, including cases where the input is valid but we chose
 * not to apply it because of context or source-priority considerations.
 *
 * See also SetConfigOption for an external interface.
 */
bool
set_config_option(const char *name, const char *value,
				  GucContext context, GucSource source,
3250
				  bool isLocal, bool changeVal)
3251 3252 3253
{
	struct config_generic *record;
	int			elevel;
3254
	bool		makeDefault;
3255 3256

	if (context == PGC_SIGHUP || source == PGC_S_DEFAULT)
3257 3258 3259 3260 3261 3262 3263
	{
		/*
		 * To avoid cluttering the log, only the postmaster bleats loudly
		 * about problems with the config file.
		 */
		elevel = IsUnderPostmaster ? DEBUG2 : LOG;
	}
3264 3265 3266 3267 3268
	else if (source == PGC_S_DATABASE || source == PGC_S_USER)
		elevel = INFO;
	else
		elevel = ERROR;

3269
	record = find_option(name, elevel);
3270 3271
	if (record == NULL)
	{
3272 3273
		ereport(elevel,
				(errcode(ERRCODE_UNDEFINED_OBJECT),
Bruce Momjian's avatar
Bruce Momjian committed
3274
		   errmsg("unrecognized configuration parameter \"%s\"", name)));
3275 3276 3277 3278 3279 3280 3281 3282 3283 3284 3285
		return false;
	}

	/*
	 * Check if the option can be set at this time. See guc.h for the
	 * precise rules. Note that we don't want to throw errors if we're in
	 * the SIGHUP context. In that case we just ignore the attempt and
	 * return true.
	 */
	switch (record->context)
	{
3286 3287 3288 3289 3290
		case PGC_INTERNAL:
			if (context == PGC_SIGHUP)
				return true;
			if (context != PGC_INTERNAL)
			{
3291 3292
				ereport(elevel,
						(errcode(ERRCODE_CANT_CHANGE_RUNTIME_PARAM),
3293
						 errmsg("parameter \"%s\" cannot be changed",
3294
								name)));
3295 3296 3297
				return false;
			}
			break;
3298 3299 3300 3301 3302
		case PGC_POSTMASTER:
			if (context == PGC_SIGHUP)
				return true;
			if (context != PGC_POSTMASTER)
			{
3303 3304
				ereport(elevel,
						(errcode(ERRCODE_CANT_CHANGE_RUNTIME_PARAM),
Bruce Momjian's avatar
Bruce Momjian committed
3305 3306
						 errmsg("parameter \"%s\" cannot be changed after server start",
								name)));
3307 3308 3309 3310 3311 3312
				return false;
			}
			break;
		case PGC_SIGHUP:
			if (context != PGC_SIGHUP && context != PGC_POSTMASTER)
			{
3313 3314
				ereport(elevel,
						(errcode(ERRCODE_CANT_CHANGE_RUNTIME_PARAM),
3315
						 errmsg("parameter \"%s\" cannot be changed now",
3316
								name)));
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
				return false;
			}

			/*
			 * Hmm, the idea of the SIGHUP context is "ought to be global,
			 * but can be changed after postmaster start". But there's
			 * nothing that prevents a crafty administrator from sending
			 * SIGHUP signals to individual backends only.
			 */
			break;
		case PGC_BACKEND:
			if (context == PGC_SIGHUP)
			{
				/*
				 * If a PGC_BACKEND parameter is changed in the config
				 * file, we want to accept the new value in the postmaster
				 * (whence it will propagate to subsequently-started
				 * backends), but ignore it in existing backends.  This is
				 * a tad klugy, but necessary because we don't re-read the
				 * config file during backend start.
				 */
				if (IsUnderPostmaster)
					return true;
			}
			else if (context != PGC_BACKEND && context != PGC_POSTMASTER)
			{
3343 3344
				ereport(elevel,
						(errcode(ERRCODE_CANT_CHANGE_RUNTIME_PARAM),
Bruce Momjian's avatar
Bruce Momjian committed
3345 3346
						 errmsg("parameter \"%s\" cannot be set after connection start",
								name)));
3347 3348 3349 3350 3351 3352
				return false;
			}
			break;
		case PGC_SUSET:
			if (context == PGC_USERSET || context == PGC_BACKEND)
			{
3353 3354
				ereport(elevel,
						(errcode(ERRCODE_INSUFFICIENT_PRIVILEGE),
Bruce Momjian's avatar
Bruce Momjian committed
3355 3356
					  errmsg("permission denied to set parameter \"%s\"",
							 name)));
3357
				return false;
3358 3359 3360 3361 3362
			}
			break;
		case PGC_USERSET:
			/* always okay */
			break;
3363
	}
3364

3365
	/*
3366
	 * Should we set reset/stacked values?	(If so, the behavior is not
3367 3368
	 * transactional.)
	 */
3369
	makeDefault = changeVal && (source <= PGC_S_OVERRIDE) && (value != NULL);
3370 3371 3372

	/*
	 * Ignore attempted set if overridden by previously processed setting.
3373
	 * However, if changeVal is false then plow ahead anyway since we are
Bruce Momjian's avatar
Bruce Momjian committed
3374 3375
	 * 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
3376
	 * to set the reset/stacked values even if we can't set the variable
Bruce Momjian's avatar
Bruce Momjian committed
3377
	 * itself.
3378 3379 3380
	 */
	if (record->source > source)
	{
3381
		if (changeVal && !makeDefault)
3382
		{
3383
			elog(DEBUG3, "\"%s\": setting ignored because previous source is higher priority",
3384 3385 3386
				 name);
			return true;
		}
3387
		changeVal = false;
3388 3389
	}

3390
	/*
3391
	 * Evaluate value and set variable.
3392
	 */
3393
	switch (record->vartype)
3394 3395 3396
	{
		case PGC_BOOL:
			{
3397
				struct config_bool *conf = (struct config_bool *) record;
3398
				bool		newval;
3399 3400

				if (value)
3401
				{
3402 3403
					if (!parse_bool(value, &newval))
					{
3404 3405
						ereport(elevel,
								(errcode(ERRCODE_INVALID_PARAMETER_VALUE),
3406
								 errmsg("parameter \"%s\" requires a Boolean value",
3407
										name)));
3408 3409 3410 3411 3412 3413 3414 3415
						return false;
					}
				}
				else
				{
					newval = conf->reset_val;
					source = conf->gen.reset_source;
				}
3416

3417
				if (conf->assign_hook)
3418
					if (!(*conf->assign_hook) (newval, changeVal, source))
3419
					{
3420 3421
						ereport(elevel,
								(errcode(ERRCODE_INVALID_PARAMETER_VALUE),
Bruce Momjian's avatar
Bruce Momjian committed
3422 3423
						 errmsg("invalid value for parameter \"%s\": %d",
								name, (int) newval)));
3424 3425
						return false;
					}
3426

3427
				if (changeVal || makeDefault)
3428
				{
3429 3430 3431
					/* Save old value to support transaction abort */
					if (!makeDefault)
						push_old_value(&conf->gen);
3432
					if (changeVal)
3433
					{
3434 3435 3436 3437 3438
						*conf->variable = newval;
						conf->gen.source = source;
					}
					if (makeDefault)
					{
Bruce Momjian's avatar
Bruce Momjian committed
3439
						GucStack   *stack;
3440

3441 3442 3443 3444 3445
						if (conf->gen.reset_source <= source)
						{
							conf->reset_val = newval;
							conf->gen.reset_source = source;
						}
3446
						for (stack = conf->gen.stack; stack; stack = stack->prev)
3447
						{
3448 3449 3450 3451 3452
							if (stack->source <= source)
							{
								stack->value.boolval = newval;
								stack->source = source;
							}
3453 3454 3455 3456 3457 3458 3459 3460 3461 3462 3463 3464 3465
						}
					}
					else if (isLocal)
					{
						conf->gen.status |= GUC_HAVE_LOCAL;
						guc_dirty = true;
					}
					else
					{
						conf->tentative_val = newval;
						conf->gen.tentative_source = source;
						conf->gen.status |= GUC_HAVE_TENTATIVE;
						guc_dirty = true;
3466
					}
3467
				}
3468
				break;
3469
			}
3470 3471

		case PGC_INT:
3472
			{
3473
				struct config_int *conf = (struct config_int *) record;
3474
				int			newval;
3475

3476
				if (value)
3477
				{
3478
					if (!parse_int(value, &newval))
3479
					{
3480 3481
						ereport(elevel,
								(errcode(ERRCODE_INVALID_PARAMETER_VALUE),
Bruce Momjian's avatar
Bruce Momjian committed
3482 3483
								 errmsg("parameter \"%s\" requires an integer value",
										name)));
3484 3485
						return false;
					}
3486
					if (newval < conf->min || newval > conf->max)
3487
					{
3488 3489
						ereport(elevel,
								(errcode(ERRCODE_INVALID_PARAMETER_VALUE),
3490
								 errmsg("%d is outside the valid range for parameter \"%s\" (%d .. %d)",
Bruce Momjian's avatar
Bruce Momjian committed
3491
								   newval, name, conf->min, conf->max)));
3492 3493
						return false;
					}
3494 3495 3496 3497 3498 3499 3500 3501
				}
				else
				{
					newval = conf->reset_val;
					source = conf->gen.reset_source;
				}

				if (conf->assign_hook)
3502
					if (!(*conf->assign_hook) (newval, changeVal, source))
3503
					{
3504 3505
						ereport(elevel,
								(errcode(ERRCODE_INVALID_PARAMETER_VALUE),
Bruce Momjian's avatar
Bruce Momjian committed
3506 3507
						 errmsg("invalid value for parameter \"%s\": %d",
								name, newval)));
3508 3509
						return false;
					}
3510

3511
				if (changeVal || makeDefault)
3512
				{
3513 3514 3515
					/* Save old value to support transaction abort */
					if (!makeDefault)
						push_old_value(&conf->gen);
3516
					if (changeVal)
3517
					{
3518 3519 3520 3521 3522
						*conf->variable = newval;
						conf->gen.source = source;
					}
					if (makeDefault)
					{
Bruce Momjian's avatar
Bruce Momjian committed
3523
						GucStack   *stack;
3524

3525 3526 3527 3528 3529
						if (conf->gen.reset_source <= source)
						{
							conf->reset_val = newval;
							conf->gen.reset_source = source;
						}
3530
						for (stack = conf->gen.stack; stack; stack = stack->prev)
3531
						{
3532 3533 3534 3535 3536
							if (stack->source <= source)
							{
								stack->value.intval = newval;
								stack->source = source;
							}
3537 3538 3539 3540 3541 3542 3543 3544 3545 3546 3547 3548 3549
						}
					}
					else if (isLocal)
					{
						conf->gen.status |= GUC_HAVE_LOCAL;
						guc_dirty = true;
					}
					else
					{
						conf->tentative_val = newval;
						conf->gen.tentative_source = source;
						conf->gen.status |= GUC_HAVE_TENTATIVE;
						guc_dirty = true;
3550
					}
3551
				}
3552
				break;
3553
			}
3554 3555

		case PGC_REAL:
3556
			{
3557
				struct config_real *conf = (struct config_real *) record;
3558
				double		newval;
3559

3560
				if (value)
3561
				{
3562
					if (!parse_real(value, &newval))
3563
					{
3564 3565
						ereport(elevel,
								(errcode(ERRCODE_INVALID_PARAMETER_VALUE),
3566
								 errmsg("parameter \"%s\" requires a numeric value",
3567
										name)));
3568 3569
						return false;
					}
3570
					if (newval < conf->min || newval > conf->max)
3571
					{
3572 3573
						ereport(elevel,
								(errcode(ERRCODE_INVALID_PARAMETER_VALUE),
3574
								 errmsg("%g is outside the valid range for parameter \"%s\" (%g .. %g)",
Bruce Momjian's avatar
Bruce Momjian committed
3575
								   newval, name, conf->min, conf->max)));
3576 3577
						return false;
					}
3578 3579 3580 3581 3582 3583 3584 3585
				}
				else
				{
					newval = conf->reset_val;
					source = conf->gen.reset_source;
				}

				if (conf->assign_hook)
3586
					if (!(*conf->assign_hook) (newval, changeVal, source))
3587
					{
3588 3589
						ereport(elevel,
								(errcode(ERRCODE_INVALID_PARAMETER_VALUE),
Bruce Momjian's avatar
Bruce Momjian committed
3590 3591
						 errmsg("invalid value for parameter \"%s\": %g",
								name, newval)));
3592 3593
						return false;
					}
3594

3595
				if (changeVal || makeDefault)
3596
				{
3597 3598 3599
					/* Save old value to support transaction abort */
					if (!makeDefault)
						push_old_value(&conf->gen);
3600
					if (changeVal)
3601
					{
3602 3603 3604 3605 3606
						*conf->variable = newval;
						conf->gen.source = source;
					}
					if (makeDefault)
					{
Bruce Momjian's avatar
Bruce Momjian committed
3607
						GucStack   *stack;
3608

3609 3610 3611 3612 3613
						if (conf->gen.reset_source <= source)
						{
							conf->reset_val = newval;
							conf->gen.reset_source = source;
						}
3614
						for (stack = conf->gen.stack; stack; stack = stack->prev)
3615
						{
3616 3617 3618 3619 3620
							if (stack->source <= source)
							{
								stack->value.realval = newval;
								stack->source = source;
							}
3621 3622 3623 3624 3625 3626 3627 3628 3629 3630 3631 3632 3633
						}
					}
					else if (isLocal)
					{
						conf->gen.status |= GUC_HAVE_LOCAL;
						guc_dirty = true;
					}
					else
					{
						conf->tentative_val = newval;
						conf->gen.tentative_source = source;
						conf->gen.status |= GUC_HAVE_TENTATIVE;
						guc_dirty = true;
3634
					}
3635
				}
3636
				break;
3637
			}
3638 3639 3640

		case PGC_STRING:
			{
3641
				struct config_string *conf = (struct config_string *) record;
3642
				char	   *newval;
3643 3644

				if (value)
3645
				{
3646
					newval = guc_strdup(elevel, value);
3647 3648 3649 3650 3651
					if (newval == NULL)
						return false;
				}
				else if (conf->reset_val)
				{
3652 3653
					/*
					 * We could possibly avoid strdup here, but easier to
Bruce Momjian's avatar
Bruce Momjian committed
3654 3655
					 * make this case work the same as the normal
					 * assignment case.
3656
					 */
3657
					newval = guc_strdup(elevel, conf->reset_val);
3658 3659 3660 3661 3662 3663 3664 3665 3666 3667 3668 3669
					if (newval == NULL)
						return false;
					source = conf->gen.reset_source;
				}
				else
				{
					/* Nothing to reset to, as yet; so do nothing */
					break;
				}

				/*
				 * Remember string in workspace, so that we can free it
3670
				 * and avoid a permanent memory leak if hook ereports.
3671 3672 3673 3674 3675 3676 3677
				 */
				if (guc_string_workspace)
					free(guc_string_workspace);
				guc_string_workspace = newval;

				if (conf->assign_hook)
				{
Bruce Momjian's avatar
Bruce Momjian committed
3678
					const char *hookresult;
3679 3680

					hookresult = (*conf->assign_hook) (newval,
3681
													   changeVal, source);
3682 3683
					guc_string_workspace = NULL;
					if (hookresult == NULL)
3684
					{
3685
						free(newval);
3686 3687
						ereport(elevel,
								(errcode(ERRCODE_INVALID_PARAMETER_VALUE),
Bruce Momjian's avatar
Bruce Momjian committed
3688 3689
								 errmsg("invalid value for parameter \"%s\": \"%s\"",
										name, value ? value : "")));
3690 3691
						return false;
					}
3692
					else if (hookresult != newval)
3693
					{
3694
						free(newval);
Bruce Momjian's avatar
Bruce Momjian committed
3695

3696
						/*
Bruce Momjian's avatar
Bruce Momjian committed
3697 3698 3699 3700 3701 3702 3703
						 * 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.
3704 3705 3706 3707 3708 3709
						 */
						newval = (char *) hookresult;
					}
				}

				guc_string_workspace = NULL;
3710

3711
				if (changeVal || makeDefault)
3712
				{
3713 3714 3715
					/* Save old value to support transaction abort */
					if (!makeDefault)
						push_old_value(&conf->gen);
3716
					if (changeVal)
3717
					{
3718
						set_string_field(conf, conf->variable, newval);
3719 3720 3721 3722
						conf->gen.source = source;
					}
					if (makeDefault)
					{
Bruce Momjian's avatar
Bruce Momjian committed
3723
						GucStack   *stack;
3724

3725
						if (conf->gen.reset_source <= source)
3726
						{
3727
							set_string_field(conf, &conf->reset_val, newval);
3728
							conf->gen.reset_source = source;
3729
						}
3730
						for (stack = conf->gen.stack; stack; stack = stack->prev)
3731
						{
3732 3733 3734 3735 3736 3737
							if (stack->source <= source)
							{
								set_string_field(conf, &stack->value.stringval,
												 newval);
								stack->source = source;
							}
3738
						}
3739
						/* Perhaps we didn't install newval anywhere */
3740
						if (!string_field_used(conf, newval))
3741
							free(newval);
3742
					}
3743
					else if (isLocal)
3744
					{
3745 3746
						conf->gen.status |= GUC_HAVE_LOCAL;
						guc_dirty = true;
3747
					}
3748
					else
3749
					{
3750
						set_string_field(conf, &conf->tentative_val, newval);
3751 3752 3753
						conf->gen.tentative_source = source;
						conf->gen.status |= GUC_HAVE_TENTATIVE;
						guc_dirty = true;
3754
					}
3755 3756 3757
				}
				else
					free(newval);
3758
				break;
3759
			}
3760
	}
3761

3762
	if (changeVal && (record->flags & GUC_REPORT))
3763
		ReportGUCOption(record);
3764

3765 3766 3767 3768 3769 3770
	return true;
}


/*
 * Set a config option to the given value. See also set_config_option,
Bruce Momjian's avatar
Bruce Momjian committed
3771
 * this is just the wrapper to be called from outside GUC.	NB: this
3772
 * is used only for non-transactional operations.
3773 3774
 */
void
3775
SetConfigOption(const char *name, const char *value,
3776
				GucContext context, GucSource source)
3777
{
3778
	(void) set_config_option(name, value, context, source, false, true);
3779 3780 3781 3782 3783
}



/*
3784
 * Fetch the current value of the option `name'. If the option doesn't exist,
3785
 * throw an ereport and don't return.
3786 3787 3788 3789 3790
 *
 * The string is *not* allocated for modification and is really only
 * valid until the next call to configuration related functions.
 */
const char *
3791
GetConfigOption(const char *name)
3792
{
3793
	struct config_generic *record;
3794 3795
	static char buffer[256];

3796
	record = find_option(name, ERROR);
3797
	if (record == NULL)
3798 3799
		ereport(ERROR,
				(errcode(ERRCODE_UNDEFINED_OBJECT),
Bruce Momjian's avatar
Bruce Momjian committed
3800
		   errmsg("unrecognized configuration parameter \"%s\"", name)));
3801 3802 3803 3804
	if ((record->flags & GUC_SUPERUSER_ONLY) && !superuser())
		ereport(ERROR,
				(errcode(ERRCODE_INSUFFICIENT_PRIVILEGE),
				 errmsg("must be superuser to examine \"%s\"", name)));
3805

3806
	switch (record->vartype)
3807 3808
	{
		case PGC_BOOL:
3809
			return *((struct config_bool *) record)->variable ? "on" : "off";
3810

3811
		case PGC_INT:
3812 3813
			snprintf(buffer, sizeof(buffer), "%d",
					 *((struct config_int *) record)->variable);
3814 3815
			return buffer;

3816
		case PGC_REAL:
3817 3818
			snprintf(buffer, sizeof(buffer), "%g",
					 *((struct config_real *) record)->variable);
3819 3820 3821
			return buffer;

		case PGC_STRING:
3822
			return *((struct config_string *) record)->variable;
3823 3824 3825
	}
	return NULL;
}
3826

3827 3828 3829 3830 3831
/*
 * Get the RESET value associated with the given option.
 */
const char *
GetConfigOptionResetString(const char *name)
3832
{
3833 3834
	struct config_generic *record;
	static char buffer[256];
3835

3836
	record = find_option(name, ERROR);
3837
	if (record == NULL)
3838 3839
		ereport(ERROR,
				(errcode(ERRCODE_UNDEFINED_OBJECT),
Bruce Momjian's avatar
Bruce Momjian committed
3840
		   errmsg("unrecognized configuration parameter \"%s\"", name)));
3841 3842 3843 3844
	if ((record->flags & GUC_SUPERUSER_ONLY) && !superuser())
		ereport(ERROR,
				(errcode(ERRCODE_INSUFFICIENT_PRIVILEGE),
				 errmsg("must be superuser to examine \"%s\"", name)));
3845 3846

	switch (record->vartype)
3847 3848
	{
		case PGC_BOOL:
3849
			return ((struct config_bool *) record)->reset_val ? "on" : "off";
3850

3851
		case PGC_INT:
3852
			snprintf(buffer, sizeof(buffer), "%d",
3853 3854
					 ((struct config_int *) record)->reset_val);
			return buffer;
3855 3856

		case PGC_REAL:
3857
			snprintf(buffer, sizeof(buffer), "%g",
3858 3859
					 ((struct config_real *) record)->reset_val);
			return buffer;
3860 3861

		case PGC_STRING:
3862 3863 3864 3865
			return ((struct config_string *) record)->reset_val;
	}
	return NULL;
}
3866

3867 3868 3869 3870 3871 3872 3873 3874 3875 3876 3877 3878 3879 3880 3881 3882 3883 3884 3885


/*
 * flatten_set_variable_args
 *		Given a parsenode List as emitted by the grammar for SET,
 *		convert to the flat string representation used by GUC.
 *
 * We need to be told the name of the variable the args are for, because
 * the flattening rules vary (ugh).
 *
 * The result is NULL if input is NIL (ie, SET ... TO DEFAULT), otherwise
 * a palloc'd string.
 */
char *
flatten_set_variable_args(const char *name, List *args)
{
	struct config_generic *record;
	int			flags;
	StringInfoData buf;
3886
	ListCell   *l;
3887

3888 3889 3890 3891
	/*
	 * Fast path if just DEFAULT.  We do not check the variable name in
	 * this case --- necessary for RESET ALL to work correctly.
	 */
3892 3893 3894
	if (args == NIL)
		return NULL;

3895
	/* Else get flags for the variable */
3896
	record = find_option(name, ERROR);
3897
	if (record == NULL)
3898 3899
		ereport(ERROR,
				(errcode(ERRCODE_UNDEFINED_OBJECT),
Bruce Momjian's avatar
Bruce Momjian committed
3900
		   errmsg("unrecognized configuration parameter \"%s\"", name)));
3901 3902

	flags = record->flags;
3903 3904 3905

	/* Complain if list input and non-list variable */
	if ((flags & GUC_LIST_INPUT) == 0 &&
3906
		list_length(args) != 1)
3907 3908 3909
		ereport(ERROR,
				(errcode(ERRCODE_INVALID_PARAMETER_VALUE),
				 errmsg("SET %s takes only one argument", name)));
3910 3911 3912 3913 3914 3915 3916 3917

	initStringInfo(&buf);

	foreach(l, args)
	{
		A_Const    *arg = (A_Const *) lfirst(l);
		char	   *val;

3918
		if (l != list_head(args))
3919 3920 3921
			appendStringInfo(&buf, ", ");

		if (!IsA(arg, A_Const))
3922
			elog(ERROR, "unrecognized node type: %d", (int) nodeTag(arg));
3923 3924 3925 3926 3927 3928 3929 3930

		switch (nodeTag(&arg->val))
		{
			case T_Integer:
				appendStringInfo(&buf, "%ld", intVal(&arg->val));
				break;
			case T_Float:
				/* represented as a string, so just copy it */
Neil Conway's avatar
Neil Conway committed
3931
				appendStringInfoString(&buf, strVal(&arg->val));
3932 3933 3934 3935 3936 3937 3938 3939 3940 3941
				break;
			case T_String:
				val = strVal(&arg->val);
				if (arg->typename != NULL)
				{
					/*
					 * Must be a ConstInterval argument for TIME ZONE.
					 * Coerce to interval and back to normalize the value
					 * and account for any typmod.
					 */
3942
					Datum interval;
Bruce Momjian's avatar
Bruce Momjian committed
3943
					char	   *intervalout;
3944 3945

					interval =
3946 3947 3948
					DirectFunctionCall3(interval_in,
										CStringGetDatum(val),
										ObjectIdGetDatum(InvalidOid),
Bruce Momjian's avatar
Bruce Momjian committed
3949
								   Int32GetDatum(arg->typename->typmod));
3950 3951 3952 3953

					intervalout =
						DatumGetCString(DirectFunctionCall3(interval_out,
															interval,
Bruce Momjian's avatar
Bruce Momjian committed
3954 3955
											ObjectIdGetDatum(InvalidOid),
													 Int32GetDatum(-1)));
3956 3957 3958 3959 3960
					appendStringInfo(&buf, "INTERVAL '%s'", intervalout);
				}
				else
				{
					/*
Bruce Momjian's avatar
Bruce Momjian committed
3961 3962
					 * Plain string literal or identifier.	For quote
					 * mode, quote it if it's not a vanilla identifier.
3963 3964
					 */
					if (flags & GUC_LIST_QUOTE)
Neil Conway's avatar
Neil Conway committed
3965
						appendStringInfoString(&buf, quote_identifier(val));
3966
					else
Neil Conway's avatar
Neil Conway committed
3967
						appendStringInfoString(&buf, val);
3968 3969 3970
				}
				break;
			default:
3971 3972
				elog(ERROR, "unrecognized node type: %d",
					 (int) nodeTag(&arg->val));
3973 3974
				break;
		}
3975
	}
3976 3977 3978 3979 3980 3981 3982 3983 3984 3985 3986 3987 3988 3989 3990 3991 3992 3993 3994 3995 3996 3997

	return buf.data;
}


/*
 * SET command
 */
void
SetPGVariable(const char *name, List *args, bool is_local)
{
	char	   *argstring = flatten_set_variable_args(name, args);

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

3998 3999 4000 4001 4002 4003
/*
 * SET command wrapped as a SQL callable function.
 */
Datum
set_config_by_name(PG_FUNCTION_ARGS)
{
Bruce Momjian's avatar
Bruce Momjian committed
4004 4005 4006 4007 4008
	char	   *name;
	char	   *value;
	char	   *new_value;
	bool		is_local;
	text	   *result_text;
4009 4010

	if (PG_ARGISNULL(0))
4011 4012
		ereport(ERROR,
				(errcode(ERRCODE_NULL_VALUE_NOT_ALLOWED),
4013
				 errmsg("SET requires parameter name")));
4014 4015

	/* Get the GUC variable name */
4016
	name = DatumGetCString(DirectFunctionCall1(textout, PG_GETARG_DATUM(0)));
4017 4018 4019 4020 4021

	/* Get the desired value or set to NULL for a reset request */
	if (PG_ARGISNULL(1))
		value = NULL;
	else
4022
		value = DatumGetCString(DirectFunctionCall1(textout, PG_GETARG_DATUM(1)));
4023 4024

	/*
Bruce Momjian's avatar
Bruce Momjian committed
4025 4026
	 * Get the desired state of is_local. Default to false if provided
	 * value is NULL
4027 4028 4029 4030 4031 4032 4033 4034 4035 4036 4037 4038 4039 4040 4041
	 */
	if (PG_ARGISNULL(2))
		is_local = false;
	else
		is_local = PG_GETARG_BOOL(2);

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

	/* get the new current value */
4042
	new_value = GetConfigOptionByName(name, NULL);
4043 4044 4045 4046 4047 4048 4049 4050

	/* Convert return string to text */
	result_text = DatumGetTextP(DirectFunctionCall1(textin, CStringGetDatum(new_value)));

	/* return it */
	PG_RETURN_TEXT_P(result_text);
}

4051
static void
Bruce Momjian's avatar
Bruce Momjian committed
4052
define_custom_variable(struct config_generic * variable)
4053
{
Bruce Momjian's avatar
Bruce Momjian committed
4054 4055 4056 4057 4058 4059 4060 4061 4062 4063 4064 4065
	const char *name = variable->name;
	const char **nameAddr = &name;
	const char *value;
	struct config_string *pHolder;
	struct config_generic **res = (struct config_generic **) bsearch(
													  (void *) &nameAddr,
												  (void *) guc_variables,
													   num_guc_variables,
										 sizeof(struct config_generic *),
														guc_var_compare);

	if (res == NULL)
4066
	{
4067
		add_guc_variable(variable, ERROR);
4068 4069 4070
		return;
	}

Bruce Momjian's avatar
Bruce Momjian committed
4071 4072
	/*
	 * This better be a placeholder
4073
	 */
Bruce Momjian's avatar
Bruce Momjian committed
4074
	if (((*res)->flags & GUC_CUSTOM_PLACEHOLDER) == 0)
4075 4076 4077
		ereport(ERROR,
				(errcode(ERRCODE_INTERNAL_ERROR),
				 errmsg("attempt to redefine parameter \"%s\"", name)));
4078 4079

	Assert((*res)->vartype == PGC_STRING);
Bruce Momjian's avatar
Bruce Momjian committed
4080 4081
	pHolder = (struct config_string *) * res;

4082
	/* We have the same name, no sorting is necessary */
4083 4084 4085 4086
	*res = variable;

	value = *pHolder->variable;

4087
	/*
Bruce Momjian's avatar
Bruce Momjian committed
4088 4089
	 * Assign the string value stored in the placeholder to the real
	 * variable.
4090 4091 4092 4093
	 *
	 * XXX this is not really good enough --- it should be a nontransactional
	 * assignment, since we don't want it to roll back if the current xact
	 * fails later.
4094 4095
	 */
	set_config_option(name, value,
Bruce Momjian's avatar
Bruce Momjian committed
4096 4097
					  pHolder->gen.context, pHolder->gen.source,
					  false, true);
4098

4099 4100 4101
	/*
	 * Free up as much as we conveniently can of the placeholder structure
	 * (this neglects any stack items...)
4102
	 */
4103 4104 4105
	set_string_field(pHolder, pHolder->variable, NULL);
	set_string_field(pHolder, &pHolder->reset_val, NULL);
	set_string_field(pHolder, &pHolder->tentative_val, NULL);
4106 4107 4108 4109

	free(pHolder);
}

Bruce Momjian's avatar
Bruce Momjian committed
4110
static void
4111
init_custom_variable(struct config_generic * gen,
Bruce Momjian's avatar
Bruce Momjian committed
4112 4113 4114 4115 4116
					 const char *name,
					 const char *short_desc,
					 const char *long_desc,
					 GucContext context,
					 enum config_type type)
4117
{
Bruce Momjian's avatar
Bruce Momjian committed
4118 4119 4120
	gen->name = guc_strdup(ERROR, name);
	gen->context = context;
	gen->group = CUSTOM_OPTIONS;
4121
	gen->short_desc = short_desc;
Bruce Momjian's avatar
Bruce Momjian committed
4122 4123
	gen->long_desc = long_desc;
	gen->vartype = type;
4124 4125
}

Bruce Momjian's avatar
Bruce Momjian committed
4126 4127 4128 4129 4130 4131 4132 4133 4134
void
DefineCustomBoolVariable(
						 const char *name,
						 const char *short_desc,
						 const char *long_desc,
						 bool *valueAddr,
						 GucContext context,
						 GucBoolAssignHook assign_hook,
						 GucShowHook show_hook)
4135
{
Bruce Momjian's avatar
Bruce Momjian committed
4136 4137
	size_t		sz = sizeof(struct config_bool);
	struct config_bool *var = (struct config_bool *) guc_malloc(ERROR, sz);
4138 4139 4140 4141

	memset(var, 0, sz);
	init_custom_variable(&var->gen, name, short_desc, long_desc, context, PGC_BOOL);

Bruce Momjian's avatar
Bruce Momjian committed
4142 4143
	var->variable = valueAddr;
	var->reset_val = *valueAddr;
4144
	var->assign_hook = assign_hook;
Bruce Momjian's avatar
Bruce Momjian committed
4145
	var->show_hook = show_hook;
4146 4147 4148
	define_custom_variable(&var->gen);
}

Bruce Momjian's avatar
Bruce Momjian committed
4149 4150 4151 4152 4153 4154 4155 4156 4157
void
DefineCustomIntVariable(
						const char *name,
						const char *short_desc,
						const char *long_desc,
						int *valueAddr,
						GucContext context,
						GucIntAssignHook assign_hook,
						GucShowHook show_hook)
4158
{
Bruce Momjian's avatar
Bruce Momjian committed
4159 4160
	size_t		sz = sizeof(struct config_int);
	struct config_int *var = (struct config_int *) guc_malloc(ERROR, sz);
4161 4162 4163 4164

	memset(var, 0, sz);
	init_custom_variable(&var->gen, name, short_desc, long_desc, context, PGC_INT);

Bruce Momjian's avatar
Bruce Momjian committed
4165 4166
	var->variable = valueAddr;
	var->reset_val = *valueAddr;
4167
	var->assign_hook = assign_hook;
Bruce Momjian's avatar
Bruce Momjian committed
4168
	var->show_hook = show_hook;
4169 4170 4171
	define_custom_variable(&var->gen);
}

Bruce Momjian's avatar
Bruce Momjian committed
4172 4173 4174 4175 4176 4177 4178 4179 4180
void
DefineCustomRealVariable(
						 const char *name,
						 const char *short_desc,
						 const char *long_desc,
						 double *valueAddr,
						 GucContext context,
						 GucRealAssignHook assign_hook,
						 GucShowHook show_hook)
4181
{
Bruce Momjian's avatar
Bruce Momjian committed
4182 4183
	size_t		sz = sizeof(struct config_real);
	struct config_real *var = (struct config_real *) guc_malloc(ERROR, sz);
4184 4185 4186 4187

	memset(var, 0, sz);
	init_custom_variable(&var->gen, name, short_desc, long_desc, context, PGC_REAL);

Bruce Momjian's avatar
Bruce Momjian committed
4188 4189
	var->variable = valueAddr;
	var->reset_val = *valueAddr;
4190
	var->assign_hook = assign_hook;
Bruce Momjian's avatar
Bruce Momjian committed
4191
	var->show_hook = show_hook;
4192 4193 4194
	define_custom_variable(&var->gen);
}

Bruce Momjian's avatar
Bruce Momjian committed
4195 4196 4197 4198 4199 4200 4201 4202 4203
void
DefineCustomStringVariable(
						   const char *name,
						   const char *short_desc,
						   const char *long_desc,
						   char **valueAddr,
						   GucContext context,
						   GucStringAssignHook assign_hook,
						   GucShowHook show_hook)
4204
{
Bruce Momjian's avatar
Bruce Momjian committed
4205 4206
	size_t		sz = sizeof(struct config_string);
	struct config_string *var = (struct config_string *) guc_malloc(ERROR, sz);
4207 4208 4209 4210

	memset(var, 0, sz);
	init_custom_variable(&var->gen, name, short_desc, long_desc, context, PGC_STRING);

Bruce Momjian's avatar
Bruce Momjian committed
4211 4212
	var->variable = valueAddr;
	var->reset_val = *valueAddr;
4213
	var->assign_hook = assign_hook;
Bruce Momjian's avatar
Bruce Momjian committed
4214
	var->show_hook = show_hook;
4215 4216 4217
	define_custom_variable(&var->gen);
}

4218
void
Bruce Momjian's avatar
Bruce Momjian committed
4219
EmitWarningsOnPlaceholders(const char *className)
4220
{
Bruce Momjian's avatar
Bruce Momjian committed
4221 4222 4223 4224
	struct config_generic **vars = guc_variables;
	struct config_generic **last = vars + num_guc_variables;

	int			nameLen = strlen(className);
4225

Bruce Momjian's avatar
Bruce Momjian committed
4226
	while (vars < last)
4227
	{
Bruce Momjian's avatar
Bruce Momjian committed
4228 4229 4230 4231 4232
		struct config_generic *var = *vars++;

		if ((var->flags & GUC_CUSTOM_PLACEHOLDER) != 0 &&
			strncmp(className, var->name, nameLen) == 0 &&
			var->name[nameLen] == GUC_QUALIFIER_SEPARATOR)
4233 4234
		{
			ereport(INFO,
Bruce Momjian's avatar
Bruce Momjian committed
4235 4236
					(errcode(ERRCODE_UNDEFINED_OBJECT),
					 errmsg("unrecognized configuration parameter \"%s\"", var->name)));
4237 4238 4239 4240 4241
		}
	}
}


4242 4243 4244 4245
/*
 * SHOW command
 */
void
4246
GetPGVariable(const char *name, DestReceiver *dest)
4247
{
4248
	if (pg_strcasecmp(name, "all") == 0)
4249
		ShowAllGUCConfig(dest);
4250
	else
4251 4252 4253 4254 4255 4256 4257 4258
		ShowGUCConfigOption(name, dest);
}

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

4259
	if (pg_strcasecmp(name, "all") == 0)
4260 4261 4262 4263
	{
		/* need a tuple descriptor representing two TEXT columns */
		tupdesc = CreateTemplateTupleDesc(2, false);
		TupleDescInitEntry(tupdesc, (AttrNumber) 1, "name",
4264
						   TEXTOID, -1, 0);
4265
		TupleDescInitEntry(tupdesc, (AttrNumber) 2, "setting",
4266
						   TEXTOID, -1, 0);
4267 4268 4269 4270 4271 4272 4273 4274 4275 4276
	}
	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);
4277
		TupleDescInitEntry(tupdesc, (AttrNumber) 1, varname,
4278
						   TEXTOID, -1, 0);
4279 4280
	}
	return tupdesc;
4281 4282 4283 4284 4285 4286 4287 4288
}

/*
 * RESET command
 */
void
ResetPGVariable(const char *name)
{
4289
	if (pg_strcasecmp(name, "all") == 0)
4290 4291 4292 4293 4294 4295 4296 4297 4298 4299 4300 4301 4302 4303
		ResetAllOptions();
	else
		set_config_option(name,
						  NULL,
						  (superuser() ? PGC_SUSET : PGC_USERSET),
						  PGC_S_SESSION,
						  false,
						  true);
}


/*
 * SHOW command
 */
4304
static void
4305
ShowGUCConfigOption(const char *name, DestReceiver *dest)
4306
{
4307
	TupOutputState *tstate;
Bruce Momjian's avatar
Bruce Momjian committed
4308 4309 4310
	TupleDesc	tupdesc;
	const char *varname;
	char	   *value;
4311

4312 4313 4314
	/* Get the value and canonical spelling of name */
	value = GetConfigOptionByName(name, &varname);

4315
	/* need a tuple descriptor representing a single TEXT column */
4316
	tupdesc = CreateTemplateTupleDesc(1, false);
4317
	TupleDescInitEntry(tupdesc, (AttrNumber) 1, varname,
4318
					   TEXTOID, -1, 0);
4319

4320 4321 4322 4323
	/* prepare for projection of tuples */
	tstate = begin_tup_output_tupdesc(dest, tupdesc);

	/* Send it */
4324
	do_text_output_oneline(tstate, value);
4325 4326

	end_tup_output(tstate);
4327 4328
}

4329 4330 4331
/*
 * SHOW ALL command
 */
4332
static void
4333
ShowAllGUCConfig(DestReceiver *dest)
4334
{
4335
	bool		am_superuser = superuser();
4336
	int			i;
4337
	TupOutputState *tstate;
Bruce Momjian's avatar
Bruce Momjian committed
4338 4339
	TupleDesc	tupdesc;
	char	   *values[2];
4340 4341

	/* need a tuple descriptor representing two TEXT columns */
4342
	tupdesc = CreateTemplateTupleDesc(2, false);
4343
	TupleDescInitEntry(tupdesc, (AttrNumber) 1, "name",
4344
					   TEXTOID, -1, 0);
4345
	TupleDescInitEntry(tupdesc, (AttrNumber) 2, "setting",
4346
					   TEXTOID, -1, 0);
4347 4348 4349

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

4351 4352
	for (i = 0; i < num_guc_variables; i++)
	{
4353 4354
		struct config_generic *conf = guc_variables[i];

4355 4356
		if ((conf->flags & GUC_NO_SHOW_ALL) ||
			((conf->flags & GUC_SUPERUSER_ONLY) && !am_superuser))
4357
			continue;
4358 4359

		/* assign to the values array */
4360 4361
		values[0] = (char *) conf->name;
		values[1] = _ShowOption(conf);
4362 4363 4364

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

4366 4367 4368
		/* clean up */
		if (values[1] != NULL)
			pfree(values[1]);
4369
	}
4370 4371

	end_tup_output(tstate);
4372
}
4373

4374
/*
4375 4376
 * Return GUC variable value by name; optionally return canonical
 * form of name.  Return value is palloc'd.
4377 4378
 */
char *
4379
GetConfigOptionByName(const char *name, const char **varname)
4380 4381 4382
{
	struct config_generic *record;

4383
	record = find_option(name, ERROR);
4384
	if (record == NULL)
4385 4386
		ereport(ERROR,
				(errcode(ERRCODE_UNDEFINED_OBJECT),
Bruce Momjian's avatar
Bruce Momjian committed
4387
		   errmsg("unrecognized configuration parameter \"%s\"", name)));
4388 4389 4390 4391
	if ((record->flags & GUC_SUPERUSER_ONLY) && !superuser())
		ereport(ERROR,
				(errcode(ERRCODE_INSUFFICIENT_PRIVILEGE),
				 errmsg("must be superuser to examine \"%s\"", name)));
4392

4393 4394 4395
	if (varname)
		*varname = record->name;

4396 4397 4398 4399
	return _ShowOption(record);
}

/*
4400 4401
 * Return GUC variable value by variable number; optionally return canonical
 * form of name.  Return value is palloc'd.
4402
 */
4403 4404
void
GetConfigOptionByNum(int varnum, const char **values, bool *noshow)
4405
{
Bruce Momjian's avatar
Bruce Momjian committed
4406 4407
	char		buffer[256];
	struct config_generic *conf;
4408 4409 4410 4411 4412

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

	conf = guc_variables[varnum];
4413

4414
	if (noshow)
4415 4416 4417 4418 4419 4420 4421
	{
		if ((conf->flags & GUC_NO_SHOW_ALL) ||
			((conf->flags & GUC_SUPERUSER_ONLY) && !superuser()))
			*noshow = true;
		else
			*noshow = false;
	}
4422

4423 4424 4425 4426 4427 4428 4429 4430
	/* first get the generic attributes */

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

	/* setting : use _ShowOption in order to avoid duplicating the logic */
	values[1] = _ShowOption(conf);

4431 4432 4433 4434 4435 4436 4437 4438 4439
	/* group */
	values[2] = config_group_names[conf->group];

	/* short_desc */
	values[3] = conf->short_desc;

	/* extra_desc */
	values[4] = conf->long_desc;

4440
	/* context */
4441
	values[5] = GucContext_Names[conf->context];
4442 4443

	/* vartype */
4444
	values[6] = config_type_names[conf->vartype];
4445 4446

	/* source */
4447
	values[7] = GucSource_Names[conf->source];
4448 4449 4450 4451 4452 4453 4454

	/* now get the type specifc attributes */
	switch (conf->vartype)
	{
		case PGC_BOOL:
			{
				/* min_val */
4455
				values[8] = NULL;
4456 4457

				/* max_val */
4458
				values[9] = NULL;
4459 4460 4461 4462 4463 4464 4465 4466 4467
			}
			break;

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

				/* min_val */
				snprintf(buffer, sizeof(buffer), "%d", lconf->min);
4468
				values[8] = pstrdup(buffer);
4469 4470 4471

				/* max_val */
				snprintf(buffer, sizeof(buffer), "%d", lconf->max);
4472
				values[9] = pstrdup(buffer);
4473 4474 4475 4476 4477 4478 4479 4480 4481
			}
			break;

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

				/* min_val */
				snprintf(buffer, sizeof(buffer), "%g", lconf->min);
4482
				values[8] = pstrdup(buffer);
4483 4484 4485

				/* max_val */
				snprintf(buffer, sizeof(buffer), "%g", lconf->max);
4486
				values[9] = pstrdup(buffer);
4487 4488 4489 4490 4491 4492
			}
			break;

		case PGC_STRING:
			{
				/* min_val */
4493
				values[8] = NULL;
4494 4495

				/* max_val */
4496
				values[9] = NULL;
4497 4498 4499 4500 4501 4502
			}
			break;

		default:
			{
				/*
Bruce Momjian's avatar
Bruce Momjian committed
4503 4504
				 * should never get here, but in case we do, set 'em to
				 * NULL
4505 4506 4507
				 */

				/* min_val */
4508
				values[8] = NULL;
4509 4510

				/* max_val */
4511
				values[9] = NULL;
4512 4513 4514
			}
			break;
	}
4515 4516 4517 4518 4519 4520 4521 4522 4523 4524 4525 4526 4527 4528 4529 4530 4531 4532
}

/*
 * 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)
{
Bruce Momjian's avatar
Bruce Momjian committed
4533 4534 4535
	char	   *varname;
	char	   *varval;
	text	   *result_text;
4536 4537

	/* Get the GUC variable name */
4538
	varname = DatumGetCString(DirectFunctionCall1(textout, PG_GETARG_DATUM(0)));
4539 4540

	/* Get the value */
4541
	varval = GetConfigOptionByName(varname, NULL);
4542 4543 4544 4545 4546 4547 4548 4549

	/* Convert to text */
	result_text = DatumGetTextP(DirectFunctionCall1(textin, CStringGetDatum(varval)));

	/* return it */
	PG_RETURN_TEXT_P(result_text);
}

4550 4551 4552 4553
/*
 * show_all_settings - equiv to SHOW ALL command but implemented as
 * a Table Function.
 */
4554
#define NUM_PG_SETTINGS_ATTS	10
4555

4556 4557 4558
Datum
show_all_settings(PG_FUNCTION_ARGS)
{
Bruce Momjian's avatar
Bruce Momjian committed
4559 4560 4561 4562 4563 4564
	FuncCallContext *funcctx;
	TupleDesc	tupdesc;
	int			call_cntr;
	int			max_calls;
	AttInMetadata *attinmeta;
	MemoryContext oldcontext;
4565 4566

	/* stuff done only on the first call of the function */
Bruce Momjian's avatar
Bruce Momjian committed
4567 4568
	if (SRF_IS_FIRSTCALL())
	{
4569
		/* create a function context for cross-call persistence */
Bruce Momjian's avatar
Bruce Momjian committed
4570
		funcctx = SRF_FIRSTCALL_INIT();
4571

Bruce Momjian's avatar
Bruce Momjian committed
4572 4573 4574 4575
		/*
		 * switch to memory context appropriate for multiple function
		 * calls
		 */
4576 4577
		oldcontext = MemoryContextSwitchTo(funcctx->multi_call_memory_ctx);

4578
		/*
Bruce Momjian's avatar
Bruce Momjian committed
4579 4580
		 * need a tuple descriptor representing NUM_PG_SETTINGS_ATTS
		 * columns of the appropriate types
4581 4582
		 */
		tupdesc = CreateTemplateTupleDesc(NUM_PG_SETTINGS_ATTS, false);
4583
		TupleDescInitEntry(tupdesc, (AttrNumber) 1, "name",
4584
						   TEXTOID, -1, 0);
4585
		TupleDescInitEntry(tupdesc, (AttrNumber) 2, "setting",
4586
						   TEXTOID, -1, 0);
4587
		TupleDescInitEntry(tupdesc, (AttrNumber) 3, "category",
4588
						   TEXTOID, -1, 0);
4589
		TupleDescInitEntry(tupdesc, (AttrNumber) 4, "short_desc",
4590
						   TEXTOID, -1, 0);
4591
		TupleDescInitEntry(tupdesc, (AttrNumber) 5, "extra_desc",
4592
						   TEXTOID, -1, 0);
4593
		TupleDescInitEntry(tupdesc, (AttrNumber) 6, "context",
4594
						   TEXTOID, -1, 0);
4595
		TupleDescInitEntry(tupdesc, (AttrNumber) 7, "vartype",
4596
						   TEXTOID, -1, 0);
4597
		TupleDescInitEntry(tupdesc, (AttrNumber) 8, "source",
4598
						   TEXTOID, -1, 0);
4599
		TupleDescInitEntry(tupdesc, (AttrNumber) 9, "min_val",
4600
						   TEXTOID, -1, 0);
4601
		TupleDescInitEntry(tupdesc, (AttrNumber) 10, "max_val",
4602
						   TEXTOID, -1, 0);
4603 4604

		/*
Bruce Momjian's avatar
Bruce Momjian committed
4605 4606
		 * Generate attribute metadata needed later to produce tuples from
		 * raw C strings
4607 4608 4609 4610 4611 4612
		 */
		attinmeta = TupleDescGetAttInMetadata(tupdesc);
		funcctx->attinmeta = attinmeta;

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

		MemoryContextSwitchTo(oldcontext);
Bruce Momjian's avatar
Bruce Momjian committed
4615
	}
4616 4617

	/* stuff done on every call of the function */
Bruce Momjian's avatar
Bruce Momjian committed
4618
	funcctx = SRF_PERCALL_SETUP();
4619 4620 4621 4622 4623

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

Bruce Momjian's avatar
Bruce Momjian committed
4624 4625
	if (call_cntr < max_calls)	/* do when there is more left to send */
	{
4626
		char	   *values[NUM_PG_SETTINGS_ATTS];
4627 4628 4629 4630 4631 4632 4633 4634 4635
		bool		noshow;
		HeapTuple	tuple;
		Datum		result;

		/*
		 * Get the next visible GUC variable name and value
		 */
		do
		{
4636
			GetConfigOptionByNum(call_cntr, (const char **) values, &noshow);
4637 4638 4639 4640 4641 4642 4643
			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)
Bruce Momjian's avatar
Bruce Momjian committed
4644
					SRF_RETURN_DONE(funcctx);
4645 4646 4647 4648 4649 4650 4651
			}
		} while (noshow);

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

		/* make the tuple into a datum */
4652
		result = HeapTupleGetDatum(tuple);
4653

Bruce Momjian's avatar
Bruce Momjian committed
4654 4655 4656
		SRF_RETURN_NEXT(funcctx, result);
	}
	else
4657 4658
	{
		/* do when there is no more left */
Bruce Momjian's avatar
Bruce Momjian committed
4659
		SRF_RETURN_DONE(funcctx);
4660
	}
4661 4662
}

4663
static char *
Bruce Momjian's avatar
Bruce Momjian committed
4664
_ShowOption(struct config_generic * record)
4665 4666 4667
{
	char		buffer[256];
	const char *val;
4668

4669 4670 4671 4672 4673
	switch (record->vartype)
	{
		case PGC_BOOL:
			{
				struct config_bool *conf = (struct config_bool *) record;
4674

4675 4676 4677 4678 4679 4680 4681 4682 4683 4684 4685 4686 4687 4688 4689 4690 4691 4692 4693 4694 4695 4696 4697 4698 4699 4700 4701 4702 4703 4704 4705 4706 4707 4708 4709 4710 4711 4712 4713 4714
				if (conf->show_hook)
					val = (*conf->show_hook) ();
				else
					val = *conf->variable ? "on" : "off";
			}
			break;

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

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

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

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

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

4716 4717 4718 4719 4720 4721 4722 4723
				if (conf->show_hook)
					val = (*conf->show_hook) ();
				else if (*conf->variable && **conf->variable)
					val = *conf->variable;
				else
					val = "unset";
			}
			break;
4724

4725 4726 4727 4728 4729
		default:
			/* just to keep compiler quiet */
			val = "???";
			break;
	}
4730

4731
	return pstrdup(val);
4732
}
4733 4734


Bruce Momjian's avatar
Bruce Momjian committed
4735 4736 4737 4738 4739 4740 4741 4742 4743 4744 4745 4746
#ifdef EXEC_BACKEND
/*
 *	This routine dumps out all non-default GUC options into a binary
 *	file that is read by all exec'ed backends.  The format is:
 *
 *		variable name, string, null terminated
 *		variable value, string, null terminated
 *		variable source, integer
 */
void
write_nondefault_variables(GucContext context)
{
4747 4748 4749 4750 4751
	int			i;
	char	   *new_filename,
			   *filename;
	int			elevel;
	FILE	   *fp;
Bruce Momjian's avatar
Bruce Momjian committed
4752 4753 4754

	Assert(context == PGC_POSTMASTER || context == PGC_SIGHUP);
	Assert(DataDir);
4755 4756

	elevel = (context == PGC_SIGHUP) ? LOG : ERROR;
Bruce Momjian's avatar
Bruce Momjian committed
4757 4758 4759 4760

	/*
	 * Open file
	 */
4761
	new_filename = guc_malloc(elevel, strlen(DataDir) + strlen(CONFIG_EXEC_PARAMS) +
Bruce Momjian's avatar
Bruce Momjian committed
4762 4763
							  strlen(".new") + 2);
	if (new_filename == NULL)
4764 4765 4766 4767
		return;

	filename = guc_malloc(elevel, strlen(DataDir) + strlen(CONFIG_EXEC_PARAMS) + 2);
	if (filename == NULL)
Bruce Momjian's avatar
Bruce Momjian committed
4768
	{
4769
		free(new_filename);
Bruce Momjian's avatar
Bruce Momjian committed
4770 4771
		return;
	}
4772

Bruce Momjian's avatar
Bruce Momjian committed
4773 4774 4775
	sprintf(new_filename, "%s/" CONFIG_EXEC_PARAMS ".new", DataDir);
	sprintf(filename, "%s/" CONFIG_EXEC_PARAMS, DataDir);

4776 4777 4778 4779
	fp = AllocateFile(new_filename, "w");
	if (!fp)
	{
		free(new_filename);
Bruce Momjian's avatar
Bruce Momjian committed
4780
		free(filename);
4781 4782
		ereport(elevel,
				(errcode_for_file_access(),
4783
				 errmsg("could not write to file \"%s\": %m", CONFIG_EXEC_PARAMS)));
Bruce Momjian's avatar
Bruce Momjian committed
4784 4785 4786 4787 4788 4789 4790 4791 4792 4793 4794 4795 4796 4797 4798 4799 4800 4801 4802 4803 4804 4805 4806 4807 4808 4809 4810 4811 4812 4813 4814 4815 4816 4817 4818 4819 4820 4821 4822 4823 4824 4825 4826 4827 4828 4829 4830 4831 4832 4833 4834 4835 4836 4837 4838 4839 4840
		return;
	}

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

		if (gconf->source != PGC_S_DEFAULT)
		{
			fprintf(fp, "%s", gconf->name);
			fputc(0, fp);

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

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

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

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

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

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

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

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

			fputc(0, fp);

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

4841 4842 4843 4844 4845 4846 4847 4848 4849 4850
	if (FreeFile(fp))
	{
		free(new_filename);
		free(filename);
		ereport(elevel,
				(errcode_for_file_access(),
				 errmsg("could not write to file \"%s\": %m", CONFIG_EXEC_PARAMS)));
		return;
	}

4851
	/*
Bruce Momjian's avatar
Bruce Momjian committed
4852 4853
	 * Put new file in place.  This could delay on Win32, but we don't
	 * hold any exclusive locks.
4854
	 */
Bruce Momjian's avatar
Bruce Momjian committed
4855 4856 4857 4858 4859 4860 4861 4862 4863 4864 4865 4866 4867 4868
	rename(new_filename, filename);
	free(new_filename);
	free(filename);
}


/*
 *	Read string, including null byte from file
 *
 *	Return NULL on EOF and nothing read
 */
static char *
read_string_with_null(FILE *fp)
{
4869 4870 4871 4872
	int			i = 0,
				ch,
				maxlen = 256;
	char	   *str = NULL;
Bruce Momjian's avatar
Bruce Momjian committed
4873 4874 4875 4876 4877 4878 4879 4880

	do
	{
		if ((ch = fgetc(fp)) == EOF)
		{
			if (i == 0)
				return NULL;
			else
4881
				elog(FATAL, "invalid format of exec config params file");
Bruce Momjian's avatar
Bruce Momjian committed
4882 4883
		}
		if (i == 0)
4884
			str = guc_malloc(FATAL, maxlen);
Bruce Momjian's avatar
Bruce Momjian committed
4885
		else if (i == maxlen)
4886
			str = guc_realloc(FATAL, str, maxlen *= 2);
Bruce Momjian's avatar
Bruce Momjian committed
4887 4888 4889 4890 4891 4892 4893 4894 4895 4896 4897 4898 4899 4900
		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)
{
4901 4902 4903 4904 4905
	char	   *filename;
	FILE	   *fp;
	char	   *varname,
			   *varvalue;
	int			varsource;
Bruce Momjian's avatar
Bruce Momjian committed
4906 4907 4908 4909 4910 4911

	Assert(DataDir);

	/*
	 * Open file
	 */
4912
	filename = guc_malloc(FATAL, strlen(DataDir) + strlen(CONFIG_EXEC_PARAMS) + 2);
Bruce Momjian's avatar
Bruce Momjian committed
4913 4914
	sprintf(filename, "%s/" CONFIG_EXEC_PARAMS, DataDir);

4915 4916 4917
	fp = AllocateFile(filename, "r");
	if (!fp)
	{
Bruce Momjian's avatar
Bruce Momjian committed
4918
		free(filename);
4919 4920
		/* File not found is fine */
		if (errno != ENOENT)
4921 4922
			ereport(FATAL,
					(errcode_for_file_access(),
4923
					 errmsg("could not read from file \"%s\": %m", CONFIG_EXEC_PARAMS)));
Bruce Momjian's avatar
Bruce Momjian committed
4924
		return;
4925
	}
Bruce Momjian's avatar
Bruce Momjian committed
4926

4927
	for (;;)
Bruce Momjian's avatar
Bruce Momjian committed
4928
	{
4929 4930
		struct config_generic *record;

Bruce Momjian's avatar
Bruce Momjian committed
4931 4932 4933
		if ((varname = read_string_with_null(fp)) == NULL)
			break;

4934
		if ((record = find_option(varname, FATAL)) == NULL)
Bruce Momjian's avatar
Bruce Momjian committed
4935
			elog(FATAL, "failed to locate variable %s in exec config params file", varname);
Bruce Momjian's avatar
Bruce Momjian committed
4936
		if ((varvalue = read_string_with_null(fp)) == NULL)
4937
			elog(FATAL, "invalid format of exec config params file");
4938
		if (fread(&varsource, sizeof(varsource), 1, fp) == 0)
4939
			elog(FATAL, "invalid format of exec config params file");
Bruce Momjian's avatar
Bruce Momjian committed
4940

4941
		(void) set_config_option(varname, varvalue, record->context,
4942
								 varsource, false, true);
Bruce Momjian's avatar
Bruce Momjian committed
4943 4944 4945 4946 4947 4948 4949 4950 4951 4952 4953
		free(varname);
		free(varvalue);
	}

	FreeFile(fp);
	free(filename);
	return;
}
#endif


4954 4955 4956 4957 4958 4959 4960 4961
/*
 * 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
4962
ParseLongOption(const char *string, char **name, char **value)
4963
{
4964 4965
	size_t		equal_pos;
	char	   *cp;
4966 4967 4968 4969 4970 4971 4972 4973 4974

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

	equal_pos = strcspn(string, "=");

	if (string[equal_pos] == '=')
	{
4975
		*name = guc_malloc(FATAL, equal_pos + 1);
4976 4977 4978
		strncpy(*name, string, equal_pos);
		(*name)[equal_pos] = '\0';

4979
		*value = guc_strdup(FATAL, &string[equal_pos + 1]);
4980
	}
4981
	else
4982
	{
4983
		/* no equal sign in string */
4984
		*name = guc_strdup(FATAL, string);
4985 4986 4987
		*value = NULL;
	}

4988
	for (cp = *name; *cp; cp++)
4989 4990 4991
		if (*cp == '-')
			*cp = '_';
}
4992 4993


4994 4995
/*
 * Handle options fetched from pg_database.datconfig or pg_shadow.useconfig.
4996
 * The array parameter must be an array of TEXT (it must not be NULL).
4997
 */
4998 4999 5000
void
ProcessGUCArray(ArrayType *array, GucSource source)
{
Bruce Momjian's avatar
Bruce Momjian committed
5001
	int			i;
5002

5003
	Assert(array != NULL);
5004 5005 5006
	Assert(ARR_ELEMTYPE(array) == TEXTOID);
	Assert(ARR_NDIM(array) == 1);
	Assert(ARR_LBOUND(array)[0] == 1);
5007
	Assert(source == PGC_S_DATABASE || source == PGC_S_USER);
5008 5009 5010 5011 5012 5013 5014 5015 5016 5017

	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,
Bruce Momjian's avatar
Bruce Momjian committed
5018 5019 5020 5021
					  -1 /* varlenarray */ ,
					  -1 /* TEXT's typlen */ ,
					  false /* TEXT's typbyval */ ,
					  'i' /* TEXT's typalign */ ,
5022 5023 5024 5025 5026 5027
					  &isnull);

		if (isnull)
			continue;

		s = DatumGetCString(DirectFunctionCall1(textout, d));
5028

5029 5030 5031
		ParseLongOption(s, &name, &value);
		if (!value)
		{
5032 5033
			ereport(WARNING,
					(errcode(ERRCODE_SYNTAX_ERROR),
5034
					 errmsg("could not parse setting for parameter \"%s\"", name)));
5035
			free(name);
Bruce Momjian's avatar
Bruce Momjian committed
5036
			continue;
5037 5038
		}

5039
		/*
Bruce Momjian's avatar
Bruce Momjian committed
5040 5041
		 * We process all these options at SUSET level.  We assume that
		 * the right to insert an option into pg_database or pg_shadow was
5042 5043
		 * checked when it was inserted.
		 */
5044
		SetConfigOption(name, value, PGC_SUSET, source);
5045 5046 5047 5048

		free(name);
		if (value)
			free(value);
5049 5050 5051 5052
	}
}


5053 5054 5055 5056
/*
 * Add an entry to an option array.  The array parameter may be NULL
 * to indicate the current table entry is NULL.
 */
5057 5058 5059
ArrayType *
GUCArrayAdd(ArrayType *array, const char *name, const char *value)
{
5060
	const char *varname;
5061 5062 5063 5064 5065 5066 5067 5068 5069 5070
	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,
5071
					  PGC_S_TEST, false, false);
5072

5073 5074 5075 5076
	/* convert name to canonical spelling, so we can use plain strcmp */
	(void) GetConfigOptionByName(name, &varname);
	name = varname;

5077 5078 5079
	newval = palloc(strlen(name) + 1 + strlen(value) + 1);
	sprintf(newval, "%s=%s", name, value);
	datum = DirectFunctionCall1(textin, CStringGetDatum(newval));
Bruce Momjian's avatar
Bruce Momjian committed
5080

5081 5082
	if (array)
	{
Bruce Momjian's avatar
Bruce Momjian committed
5083 5084 5085
		int			index;
		bool		isnull;
		int			i;
5086

5087 5088 5089 5090
		Assert(ARR_ELEMTYPE(array) == TEXTOID);
		Assert(ARR_NDIM(array) == 1);
		Assert(ARR_LBOUND(array)[0] == 1);

Bruce Momjian's avatar
Bruce Momjian committed
5091
		index = ARR_DIMS(array)[0] + 1; /* add after end */
5092 5093 5094 5095 5096 5097 5098

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

			d = array_ref(array, 1, &i,
Bruce Momjian's avatar
Bruce Momjian committed
5099 5100 5101 5102
						  -1 /* varlenarray */ ,
						  -1 /* TEXT's typlen */ ,
						  false /* TEXT's typbyval */ ,
						  'i' /* TEXT's typalign */ ,
5103
						  &isnull);
5104 5105
			if (isnull)
				continue;
5106
			current = DatumGetCString(DirectFunctionCall1(textout, d));
Bruce Momjian's avatar
Bruce Momjian committed
5107
			if (strncmp(current, newval, strlen(name) + 1) == 0)
5108 5109 5110 5111 5112 5113 5114
			{
				index = i;
				break;
			}
		}

		isnull = false;
5115 5116
		a = array_set(array, 1, &index,
					  datum,
Bruce Momjian's avatar
Bruce Momjian committed
5117 5118 5119 5120
					  -1 /* varlenarray */ ,
					  -1 /* TEXT's typlen */ ,
					  false /* TEXT's typbyval */ ,
					  'i' /* TEXT's typalign */ ,
5121
					  &isnull);
5122 5123
	}
	else
5124 5125 5126
		a = construct_array(&datum, 1,
							TEXTOID,
							-1, false, 'i');
5127 5128 5129 5130 5131

	return a;
}


5132 5133 5134 5135 5136
/*
 * 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.
 */
5137 5138 5139
ArrayType *
GUCArrayDelete(ArrayType *array, const char *name)
{
5140
	const char *varname;
Bruce Momjian's avatar
Bruce Momjian committed
5141 5142 5143
	ArrayType  *newarray;
	int			i;
	int			index;
5144 5145 5146 5147 5148 5149

	Assert(name);

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

5152 5153 5154 5155
	/* convert name to canonical spelling, so we can use plain strcmp */
	(void) GetConfigOptionByName(name, &varname);
	name = varname;

5156 5157 5158 5159 5160
	/* if array is currently null, then surely nothing to delete */
	if (!array)
		return NULL;

	newarray = NULL;
5161 5162 5163 5164 5165 5166 5167 5168 5169
	index = 1;

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

		d = array_ref(array, 1, &i,
Bruce Momjian's avatar
Bruce Momjian committed
5170 5171 5172 5173
					  -1 /* varlenarray */ ,
					  -1 /* TEXT's typlen */ ,
					  false /* TEXT's typbyval */ ,
					  'i' /* TEXT's typalign */ ,
5174
					  &isnull);
5175 5176
		if (isnull)
			continue;
5177 5178
		val = DatumGetCString(DirectFunctionCall1(textout, d));

5179
		/* ignore entry if it's what we want to delete */
Bruce Momjian's avatar
Bruce Momjian committed
5180
		if (strncmp(val, name, strlen(name)) == 0
5181 5182 5183
			&& val[strlen(name)] == '=')
			continue;

5184 5185 5186 5187 5188 5189 5190 5191 5192 5193 5194 5195 5196 5197 5198 5199 5200
		/* else add it to the output array */
		if (newarray)
		{
			isnull = false;
			newarray = array_set(newarray, 1, &index,
								 d,
								 -1 /* varlenarray */ ,
								 -1 /* TEXT's typlen */ ,
								 false /* TEXT's typbyval */ ,
								 'i' /* TEXT's typalign */ ,
								 &isnull);
		}
		else
			newarray = construct_array(&d, 1,
									   TEXTOID,
									   -1, false, 'i');

5201 5202 5203 5204 5205
		index++;
	}

	return newarray;
}
5206

5207 5208 5209 5210 5211

/*
 * assign_hook subroutines
 */

5212 5213 5214
static const char *
assign_log_destination(const char *value, bool doit, GucSource source)
{
Bruce Momjian's avatar
Bruce Momjian committed
5215 5216 5217 5218 5219
	char	   *rawstring;
	List	   *elemlist;
	ListCell   *l;
	int			newlogdest = 0;

5220 5221 5222 5223
	/* Need a modifiable copy of string */
	rawstring = pstrdup(value);

	/* Parse string into list of identifiers */
Bruce Momjian's avatar
Bruce Momjian committed
5224
	if (!SplitIdentifierString(rawstring, ',', &elemlist))
5225 5226 5227
	{
		/* syntax error in list */
		pfree(rawstring);
5228
		list_free(elemlist);
5229 5230 5231 5232 5233 5234 5235 5236 5237
		if (source >= PGC_S_INTERACTIVE)
			ereport(ERROR,
					(errcode(ERRCODE_INVALID_PARAMETER_VALUE),
					 errmsg("invalid list syntax for parameter \"log_destination\"")));
		return NULL;
	}

	foreach(l, elemlist)
	{
Bruce Momjian's avatar
Bruce Momjian committed
5238 5239 5240
		char	   *tok = (char *) lfirst(l);

		if (pg_strcasecmp(tok, "stderr") == 0)
5241 5242
			newlogdest |= LOG_DESTINATION_STDERR;
#ifdef HAVE_SYSLOG
Bruce Momjian's avatar
Bruce Momjian committed
5243
		else if (pg_strcasecmp(tok, "syslog") == 0)
5244 5245 5246
			newlogdest |= LOG_DESTINATION_SYSLOG;
#endif
#ifdef WIN32
Bruce Momjian's avatar
Bruce Momjian committed
5247
		else if (pg_strcasecmp(tok, "eventlog") == 0)
5248 5249
			newlogdest |= LOG_DESTINATION_EVENTLOG;
#endif
Bruce Momjian's avatar
Bruce Momjian committed
5250 5251
		else
		{
5252 5253 5254
			if (source >= PGC_S_INTERACTIVE)
				ereport(ERROR,
						(errcode(ERRCODE_INVALID_PARAMETER_VALUE),
Peter Eisentraut's avatar
Peter Eisentraut committed
5255
						 errmsg("unrecognized \"log_destination\" key word: \"%s\"",
5256 5257
								tok)));
			pfree(rawstring);
5258
			list_free(elemlist);
5259 5260 5261 5262
			return NULL;
		}
	}

5263 5264 5265
	if (doit)
		Log_destination = newlogdest;

5266
	pfree(rawstring);
5267
	list_free(elemlist);
5268 5269 5270 5271

	return value;
}

5272 5273 5274
#ifdef HAVE_SYSLOG

static const char *
5275
assign_facility(const char *facility, bool doit, GucSource source)
5276
{
5277
	if (pg_strcasecmp(facility, "LOCAL0") == 0)
5278
		return facility;
5279
	if (pg_strcasecmp(facility, "LOCAL1") == 0)
5280
		return facility;
5281
	if (pg_strcasecmp(facility, "LOCAL2") == 0)
5282
		return facility;
5283
	if (pg_strcasecmp(facility, "LOCAL3") == 0)
5284
		return facility;
5285
	if (pg_strcasecmp(facility, "LOCAL4") == 0)
5286
		return facility;
5287
	if (pg_strcasecmp(facility, "LOCAL5") == 0)
5288
		return facility;
5289
	if (pg_strcasecmp(facility, "LOCAL6") == 0)
5290
		return facility;
5291
	if (pg_strcasecmp(facility, "LOCAL7") == 0)
5292 5293 5294 5295 5296 5297 5298
		return facility;
	return NULL;
}
#endif


static const char *
5299
assign_defaultxactisolevel(const char *newval, bool doit, GucSource source)
5300
{
5301
	if (pg_strcasecmp(newval, "serializable") == 0)
5302 5303 5304 5305
	{
		if (doit)
			DefaultXactIsoLevel = XACT_SERIALIZABLE;
	}
5306
	else if (pg_strcasecmp(newval, "repeatable read") == 0)
5307 5308 5309 5310
	{
		if (doit)
			DefaultXactIsoLevel = XACT_REPEATABLE_READ;
	}
5311
	else if (pg_strcasecmp(newval, "read committed") == 0)
5312 5313 5314 5315
	{
		if (doit)
			DefaultXactIsoLevel = XACT_READ_COMMITTED;
	}
5316
	else if (pg_strcasecmp(newval, "read uncommitted") == 0)
5317 5318 5319 5320
	{
		if (doit)
			DefaultXactIsoLevel = XACT_READ_UNCOMMITTED;
	}
5321 5322 5323 5324 5325 5326
	else
		return NULL;
	return newval;
}

static const char *
5327
assign_log_min_messages(const char *newval,
5328
						bool doit, GucSource source)
5329
{
5330
	return (assign_msglvl(&log_min_messages, newval, doit, source));
5331 5332
}

5333
static const char *
5334
assign_client_min_messages(const char *newval, bool doit, GucSource source)
5335
{
5336
	return (assign_msglvl(&client_min_messages, newval, doit, source));
5337 5338
}

5339
static const char *
5340
assign_min_error_statement(const char *newval, bool doit, GucSource source)
5341
{
5342
	return (assign_msglvl(&log_min_error_statement, newval, doit, source));
5343 5344 5345
}

static const char *
5346
assign_msglvl(int *var, const char *newval, bool doit, GucSource source)
5347
{
5348
	if (pg_strcasecmp(newval, "debug") == 0)
Bruce Momjian's avatar
Bruce Momjian committed
5349 5350
	{
		if (doit)
5351
			(*var) = DEBUG2;
Bruce Momjian's avatar
Bruce Momjian committed
5352
	}
5353
	else if (pg_strcasecmp(newval, "debug5") == 0)
Bruce Momjian's avatar
Bruce Momjian committed
5354 5355 5356 5357
	{
		if (doit)
			(*var) = DEBUG5;
	}
5358
	else if (pg_strcasecmp(newval, "debug4") == 0)
Bruce Momjian's avatar
Bruce Momjian committed
5359 5360 5361 5362
	{
		if (doit)
			(*var) = DEBUG4;
	}
5363
	else if (pg_strcasecmp(newval, "debug3") == 0)
Bruce Momjian's avatar
Bruce Momjian committed
5364 5365 5366 5367
	{
		if (doit)
			(*var) = DEBUG3;
	}
5368
	else if (pg_strcasecmp(newval, "debug2") == 0)
Bruce Momjian's avatar
Bruce Momjian committed
5369 5370 5371 5372
	{
		if (doit)
			(*var) = DEBUG2;
	}
5373
	else if (pg_strcasecmp(newval, "debug1") == 0)
Bruce Momjian's avatar
Bruce Momjian committed
5374 5375 5376 5377
	{
		if (doit)
			(*var) = DEBUG1;
	}
5378
	else if (pg_strcasecmp(newval, "log") == 0)
Bruce Momjian's avatar
Bruce Momjian committed
5379 5380 5381 5382
	{
		if (doit)
			(*var) = LOG;
	}
Bruce Momjian's avatar
Bruce Momjian committed
5383

5384
	/*
Bruce Momjian's avatar
Bruce Momjian committed
5385 5386
	 * Client_min_messages always prints 'info', but we allow it as a
	 * value anyway.
5387
	 */
5388
	else if (pg_strcasecmp(newval, "info") == 0)
Bruce Momjian's avatar
Bruce Momjian committed
5389 5390 5391 5392
	{
		if (doit)
			(*var) = INFO;
	}
5393
	else if (pg_strcasecmp(newval, "notice") == 0)
Bruce Momjian's avatar
Bruce Momjian committed
5394 5395 5396 5397
	{
		if (doit)
			(*var) = NOTICE;
	}
5398
	else if (pg_strcasecmp(newval, "warning") == 0)
Bruce Momjian's avatar
Bruce Momjian committed
5399 5400 5401 5402
	{
		if (doit)
			(*var) = WARNING;
	}
5403
	else if (pg_strcasecmp(newval, "error") == 0)
Bruce Momjian's avatar
Bruce Momjian committed
5404 5405 5406 5407
	{
		if (doit)
			(*var) = ERROR;
	}
5408
	/* We allow FATAL/PANIC for client-side messages too. */
5409
	else if (pg_strcasecmp(newval, "fatal") == 0)
5410 5411 5412 5413
	{
		if (doit)
			(*var) = FATAL;
	}
5414
	else if (pg_strcasecmp(newval, "panic") == 0)
5415 5416 5417 5418
	{
		if (doit)
			(*var) = PANIC;
	}
5419 5420 5421 5422
	else
		return NULL;			/* fail */
	return newval;				/* OK */
}
5423

5424
static const char *
5425
assign_log_error_verbosity(const char *newval, bool doit, GucSource source)
5426
{
5427
	if (pg_strcasecmp(newval, "terse") == 0)
5428 5429 5430 5431
	{
		if (doit)
			Log_error_verbosity = PGERROR_TERSE;
	}
5432
	else if (pg_strcasecmp(newval, "default") == 0)
5433 5434 5435 5436
	{
		if (doit)
			Log_error_verbosity = PGERROR_DEFAULT;
	}
5437
	else if (pg_strcasecmp(newval, "verbose") == 0)
5438 5439 5440 5441 5442 5443 5444 5445 5446
	{
		if (doit)
			Log_error_verbosity = PGERROR_VERBOSE;
	}
	else
		return NULL;			/* fail */
	return newval;				/* OK */
}

5447 5448 5449
static const char *
assign_log_statement(const char *newval, bool doit, GucSource source)
{
5450
	if (pg_strcasecmp(newval, "none") == 0)
5451 5452
	{
		if (doit)
5453
			log_statement = LOGSTMT_NONE;
5454
	}
5455
	else if (pg_strcasecmp(newval, "ddl") == 0)
5456 5457
	{
		if (doit)
5458
			log_statement = LOGSTMT_DDL;
5459
	}
5460
	else if (pg_strcasecmp(newval, "mod") == 0)
5461 5462
	{
		if (doit)
5463
			log_statement = LOGSTMT_MOD;
5464
	}
5465
	else if (pg_strcasecmp(newval, "all") == 0)
5466 5467
	{
		if (doit)
5468
			log_statement = LOGSTMT_ALL;
5469 5470 5471 5472 5473 5474
	}
	else
		return NULL;			/* fail */
	return newval;				/* OK */
}

5475
static bool
5476
assign_phony_autocommit(bool newval, bool doit, GucSource source)
5477 5478 5479
{
	if (!newval)
	{
5480
		if (doit && source >= PGC_S_INTERACTIVE)
5481 5482
			ereport(ERROR,
					(errcode(ERRCODE_FEATURE_NOT_SUPPORTED),
Bruce Momjian's avatar
Bruce Momjian committed
5483
				errmsg("SET AUTOCOMMIT TO OFF is no longer supported")));
5484 5485 5486 5487 5488
		return false;
	}
	return true;
}

5489 5490 5491
static const char *
assign_custom_variable_classes(const char *newval, bool doit, GucSource source)
{
Bruce Momjian's avatar
Bruce Momjian committed
5492 5493
	/*
	 * Check syntax. newval must be a comma separated list of identifiers.
5494 5495
	 * Whitespace is allowed but skipped.
	 */
Bruce Momjian's avatar
Bruce Momjian committed
5496
	bool		hasSpaceAfterToken = false;
5497
	const char *cp = newval;
Bruce Momjian's avatar
Bruce Momjian committed
5498 5499
	int			symLen = 0;
	int			c;
5500 5501 5502
	StringInfoData buf;

	initStringInfo(&buf);
Bruce Momjian's avatar
Bruce Momjian committed
5503
	while ((c = *cp++) != 0)
5504
	{
Bruce Momjian's avatar
Bruce Momjian committed
5505
		if (isspace(c))
5506
		{
Bruce Momjian's avatar
Bruce Momjian committed
5507
			if (symLen > 0)
5508 5509 5510 5511
				hasSpaceAfterToken = true;
			continue;
		}

Bruce Momjian's avatar
Bruce Momjian committed
5512
		if (c == ',')
5513 5514
		{
			hasSpaceAfterToken = false;
Bruce Momjian's avatar
Bruce Momjian committed
5515
			if (symLen > 0)
5516 5517 5518 5519 5520 5521 5522
			{
				symLen = 0;
				appendStringInfoChar(&buf, ',');
			}
			continue;
		}

Bruce Momjian's avatar
Bruce Momjian committed
5523
		if (hasSpaceAfterToken || !isalnum(c))
5524
		{
Bruce Momjian's avatar
Bruce Momjian committed
5525 5526 5527
			/*
			 * Syntax error due to token following space after token or
			 * non alpha numeric character
5528
			 */
5529
			ereport(LOG,
5530
					(errcode(ERRCODE_SYNTAX_ERROR),
Peter Eisentraut's avatar
Peter Eisentraut committed
5531
					 errmsg("invalid syntax for \"custom_variable_classes\": \"%s\"", newval)));
5532
			pfree(buf.data);
5533 5534 5535
			return NULL;
		}
		symLen++;
Bruce Momjian's avatar
Bruce Momjian committed
5536
		appendStringInfoChar(&buf, (char) c);
5537 5538
	}

5539
	/* Remove stray ',' at end */
Bruce Momjian's avatar
Bruce Momjian committed
5540
	if (symLen == 0 && buf.len > 0)
5541
		buf.data[--buf.len] = '\0';
5542

Bruce Momjian's avatar
Bruce Momjian committed
5543
	if (buf.len == 0)
5544
		newval = NULL;
Bruce Momjian's avatar
Bruce Momjian committed
5545
	else if (doit)
5546 5547 5548 5549 5550
		newval = strdup(buf.data);

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

5552 5553 5554
static bool
assign_stage_log_stats(bool newval, bool doit, GucSource source)
{
5555
	if (newval && log_statement_stats)
5556
	{
5557 5558 5559 5560
		if (source >= PGC_S_INTERACTIVE)
			ereport(ERROR,
					(errcode(ERRCODE_INVALID_PARAMETER_VALUE),
					 errmsg("cannot enable parameter when \"log_statement_stats\" is true")));
5561 5562
		/* source == PGC_S_OVERRIDE means do it anyway, eg at xact abort */
		else if (source != PGC_S_OVERRIDE)
5563
			return false;
5564 5565 5566 5567 5568 5569 5570
	}
	return true;
}

static bool
assign_log_stats(bool newval, bool doit, GucSource source)
{
5571 5572
	if (newval &&
		(log_parser_stats || log_planner_stats || log_executor_stats))
5573
	{
5574 5575 5576 5577 5578 5579
		if (source >= PGC_S_INTERACTIVE)
			ereport(ERROR,
					(errcode(ERRCODE_INVALID_PARAMETER_VALUE),
					 errmsg("cannot enable \"log_statement_stats\" when "
							"\"log_parser_stats\", \"log_planner_stats\", "
							"or \"log_executor_stats\" is true")));
5580 5581
		/* source == PGC_S_OVERRIDE means do it anyway, eg at xact abort */
		else if (source != PGC_S_OVERRIDE)
5582
			return false;
5583 5584 5585 5586
	}
	return true;
}

5587 5588 5589
static bool
assign_transaction_read_only(bool newval, bool doit, GucSource source)
{
5590 5591 5592 5593 5594 5595 5596
	/* Can't go to r/w mode inside a r/o transaction */
	if (newval == false && XactReadOnly && IsSubTransaction())
	{
		if (source >= PGC_S_INTERACTIVE)
			ereport(ERROR,
					(errcode(ERRCODE_INVALID_PARAMETER_VALUE),
					 errmsg("cannot set transaction read-write mode inside a read-only transaction")));
5597 5598 5599
		/* source == PGC_S_OVERRIDE means do it anyway, eg at xact abort */
		else if (source != PGC_S_OVERRIDE)
			return false;
5600
	}
5601 5602
	return true;
}
5603

5604 5605 5606 5607 5608
static const char *
assign_canonical_path(const char *newval, bool doit, GucSource source)
{
	if (doit)
	{
Bruce Momjian's avatar
Bruce Momjian committed
5609 5610
		char	   *canon_val = guc_strdup(ERROR, newval);

5611 5612 5613 5614 5615 5616 5617
		canonicalize_path(canon_val);
		return canon_val;
	}
	else
		return newval;
}

5618

5619
#include "guc-file.c"