autovacuum.c 79.4 KB
Newer Older
1 2 3 4 5 6
/*-------------------------------------------------------------------------
 *
 * autovacuum.c
 *
 * PostgreSQL Integrated Autovacuum Daemon
 *
7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23
 * The autovacuum system is structured in two different kinds of processes: the
 * autovacuum launcher and the autovacuum worker.  The launcher is an
 * always-running process, started by the postmaster when the autovacuum GUC
 * parameter is set.  The launcher schedules autovacuum workers to be started
 * when appropriate.  The workers are the processes which execute the actual
 * vacuuming; they connect to a database as determined in the launcher, and
 * once connected they examine the catalogs to select the tables to vacuum.
 *
 * The autovacuum launcher cannot start the worker processes by itself,
 * because doing so would cause robustness issues (namely, failure to shut
 * them down on exceptional conditions, and also, since the launcher is
 * connected to shared memory and is thus subject to corruption there, it is
 * not as robust as the postmaster).  So it leaves that task to the postmaster.
 *
 * There is an autovacuum shared memory area, where the launcher stores
 * information about the database it wants vacuumed.  When it wants a new
 * worker to start, it sets a flag in shared memory and sends a signal to the
B
Bruce Momjian 已提交
24 25
 * postmaster.	Then postmaster knows nothing more than it must start a worker;
 * so it forks a new child, which turns into a worker.	This new process
26 27 28 29 30 31
 * connects to shared memory, and there it can inspect the information that the
 * launcher has set up.
 *
 * If the fork() call fails in the postmaster, it sets a flag in the shared
 * memory area, and sends a signal to the launcher.  The launcher, upon
 * noticing the flag, can try starting the worker again by resending the
B
Bruce Momjian 已提交
32
 * signal.	Note that the failure can only be transient (fork failure due to
33 34 35 36 37
 * high load, memory pressure, too many processes, etc); more permanent
 * problems, like failure to connect to a database, are detected later in the
 * worker and dealt with just by having the worker exit normally.  The launcher
 * will launch a new worker again later, per schedule.
 *
B
Bruce Momjian 已提交
38
 * When the worker is done vacuuming it sends SIGUSR1 to the launcher.	The
39 40 41 42 43 44 45 46 47 48 49 50 51
 * launcher then wakes up and is able to launch another worker, if the schedule
 * is so tight that a new worker is needed immediately.  At this time the
 * launcher can also balance the settings for the various remaining workers'
 * cost-based vacuum delay feature.
 *
 * Note that there can be more than one worker in a database concurrently.
 * They will store the table they are currently vacuuming in shared memory, so
 * that other workers avoid being blocked waiting for the vacuum lock for that
 * table.  They will also reload the pgstats data just before vacuuming each
 * table, to avoid vacuuming a table that was just finished being vacuumed by
 * another worker and thus is no longer noted in shared memory.  However,
 * there is a window (caused by pgstat delay) on which a worker may choose a
 * table that was already vacuumed; this is a bug in the current design.
52
 *
53
 * Portions Copyright (c) 1996-2008, PostgreSQL Global Development Group
54 55 56 57
 * Portions Copyright (c) 1994, Regents of the University of California
 *
 *
 * IDENTIFICATION
58
 *	  $PostgreSQL: pgsql/src/backend/postmaster/autovacuum.c,v 1.71 2008/01/14 13:39:25 alvherre Exp $
59 60 61 62 63 64 65
 *
 *-------------------------------------------------------------------------
 */
#include "postgres.h"

#include <signal.h>
#include <sys/types.h>
66
#include <sys/time.h>
67
#include <time.h>
68 69 70 71
#include <unistd.h>

#include "access/genam.h"
#include "access/heapam.h"
72 73
#include "access/transam.h"
#include "access/xact.h"
74
#include "catalog/indexing.h"
75
#include "catalog/namespace.h"
76
#include "catalog/pg_autovacuum.h"
77
#include "catalog/pg_database.h"
78
#include "commands/dbcommands.h"
79 80 81 82 83 84 85 86 87 88
#include "commands/vacuum.h"
#include "libpq/hba.h"
#include "libpq/pqsignal.h"
#include "miscadmin.h"
#include "pgstat.h"
#include "postmaster/autovacuum.h"
#include "postmaster/fork_process.h"
#include "postmaster/postmaster.h"
#include "storage/fd.h"
#include "storage/ipc.h"
89
#include "storage/pmsignal.h"
90
#include "storage/proc.h"
91
#include "storage/procarray.h"
92 93 94 95
#include "storage/sinval.h"
#include "tcop/tcopprot.h"
#include "utils/flatfiles.h"
#include "utils/fmgroids.h"
96
#include "utils/lsyscache.h"
97 98
#include "utils/memutils.h"
#include "utils/ps_status.h"
99
#include "utils/syscache.h"
100 101 102 103 104 105


/*
 * GUC parameters
 */
bool		autovacuum_start_daemon = false;
106
int			autovacuum_max_workers;
107 108 109 110 111
int			autovacuum_naptime;
int			autovacuum_vac_thresh;
double		autovacuum_vac_scale;
int			autovacuum_anl_thresh;
double		autovacuum_anl_scale;
112
int			autovacuum_freeze_max_age;
113

114 115 116
int			autovacuum_vac_cost_delay;
int			autovacuum_vac_cost_limit;

117
int			Log_autovacuum_min_duration = -1;
118

119 120 121
/* how long to keep pgstat data in the launcher, in milliseconds */
#define STATS_READ_DELAY 1000

122

123
/* Flags to tell if we are in an autovacuum process */
124 125
static bool am_autovacuum_launcher = false;
static bool am_autovacuum_worker = false;
126

127 128 129 130 131
/* Flags set by signal handlers */
static volatile sig_atomic_t got_SIGHUP = false;
static volatile sig_atomic_t got_SIGUSR1 = false;
static volatile sig_atomic_t got_SIGTERM = false;

132 133 134 135 136 137
/* Comparison point for determining whether freeze_max_age is exceeded */
static TransactionId recentXid;

/* Default freeze_min_age to use for autovacuum (varies by database) */
static int	default_freeze_min_age;

138
/* Memory context for long-lived data */
B
Bruce Momjian 已提交
139
static MemoryContext AutovacMemCxt;
140

141 142
/* struct to keep track of databases in launcher */
typedef struct avl_dbase
143
{
B
Bruce Momjian 已提交
144 145
	Oid			adl_datid;		/* hash key -- must be first */
	TimestampTz adl_next_worker;
146
	int			adl_score;
147
} avl_dbase;
148 149 150 151 152 153 154 155

/* struct to keep track of databases in worker */
typedef struct avw_dbase
{
	Oid			adw_datid;
	char	   *adw_name;
	TransactionId adw_frozenxid;
	PgStat_StatDBEntry *adw_entry;
156
} avw_dbase;
157

158 159 160
/* struct to keep track of tables to vacuum and/or analyze, in 1st pass */
typedef struct av_relation
{
B
Bruce Momjian 已提交
161 162
	Oid			ar_relid;
	Oid			ar_toastrelid;
163
} av_relation;
164

165
/* struct to keep track of tables to vacuum and/or analyze, after rechecking */
166 167
typedef struct autovac_table
{
168 169 170 171 172 173 174
	Oid			at_relid;
	Oid			at_toastrelid;
	bool		at_dovacuum;
	bool		at_doanalyze;
	int			at_freeze_min_age;
	int			at_vacuum_cost_delay;
	int			at_vacuum_cost_limit;
175
	bool		at_wraparound;
176 177
} autovac_table;

178 179 180 181 182 183 184 185
/*-------------
 * This struct holds information about a single worker's whereabouts.  We keep
 * an array of these in shared memory, sized according to
 * autovacuum_max_workers.
 *
 * wi_links		entry into free list or running list
 * wi_dboid		OID of the database this worker is supposed to work on
 * wi_tableoid	OID of the table currently being vacuumed
186
 * wi_proc		pointer to PGPROC of the running worker, NULL if not started
187 188 189 190 191 192 193 194 195 196 197 198 199
 * wi_launchtime Time at which this worker was launched
 * wi_cost_*	Vacuum cost-based delay parameters current in this worker
 *
 * All fields are protected by AutovacuumLock, except for wi_tableoid which is
 * protected by AutovacuumScheduleLock (which is read-only for everyone except
 * that worker itself).
 *-------------
 */
typedef struct WorkerInfoData
{
	SHM_QUEUE	wi_links;
	Oid			wi_dboid;
	Oid			wi_tableoid;
200
	PGPROC	   *wi_proc;
B
Bruce Momjian 已提交
201
	TimestampTz wi_launchtime;
202 203 204
	int			wi_cost_delay;
	int			wi_cost_limit;
	int			wi_cost_limit_base;
205
} WorkerInfoData;
206 207 208

typedef struct WorkerInfoData *WorkerInfo;

209 210 211 212 213
/*
 * Possible signals received by the launcher from remote processes.  These are
 * stored atomically in shared memory so that other processes can set them
 * without locking.
 */
B
Bruce Momjian 已提交
214
typedef enum
215
{
B
Bruce Momjian 已提交
216 217 218
	AutoVacForkFailed,			/* failed trying to start a worker */
	AutoVacRebalance,			/* rebalance the cost limits */
	AutoVacNumSignals = AutoVacRebalance		/* must be last */
219 220
} AutoVacuumSignal;

221 222
/*-------------
 * The main autovacuum shmem struct.  On shared memory we store this main
B
Bruce Momjian 已提交
223
 * struct and the array of WorkerInfo structs.	This struct keeps:
224
 *
225
 * av_signal		set by other processes to indicate various conditions
226 227 228 229 230 231
 * av_launcherpid	the PID of the autovacuum launcher
 * av_freeWorkers	the WorkerInfo freelist
 * av_runningWorkers the WorkerInfo non-free queue
 * av_startingWorker pointer to WorkerInfo currently being started (cleared by
 *					the worker itself as soon as it's up and running)
 *
232 233
 * This struct is protected by AutovacuumLock, except for av_signal and parts
 * of the worker list (see above).
234 235
 *-------------
 */
236 237
typedef struct
{
B
Bruce Momjian 已提交
238 239 240 241 242
	sig_atomic_t av_signal[AutoVacNumSignals];
	pid_t		av_launcherpid;
	SHMEM_OFFSET av_freeWorkers;
	SHM_QUEUE	av_runningWorkers;
	SHMEM_OFFSET av_startingWorker;
243
} AutoVacuumShmemStruct;
244 245

static AutoVacuumShmemStruct *AutoVacuumShmem;
246

247 248 249 250 251
/* the database list in the launcher, and the context that contains it */
static Dllist *DatabaseList = NULL;
static MemoryContext DatabaseListCxt = NULL;

/* Pointer to my own WorkerInfo, valid on each worker */
B
Bruce Momjian 已提交
252
static WorkerInfo MyWorkerInfo = NULL;
253 254

/* PID of launcher, valid only in worker while shutting down */
B
Bruce Momjian 已提交
255
int			AutovacuumLauncherPid = 0;
256

257
#ifdef EXEC_BACKEND
258 259
static pid_t avlauncher_forkexec(void);
static pid_t avworker_forkexec(void);
260
#endif
261 262 263
NON_EXEC_STATIC void AutoVacWorkerMain(int argc, char *argv[]);
NON_EXEC_STATIC void AutoVacLauncherMain(int argc, char *argv[]);

B
Bruce Momjian 已提交
264
static Oid	do_start_worker(void);
265
static void launcher_determine_sleep(bool canlaunch, bool recursing,
B
Bruce Momjian 已提交
266
						 struct timeval * nap);
267 268 269
static void launch_worker(TimestampTz now);
static List *get_database_list(void);
static void rebuild_database_list(Oid newdb);
B
Bruce Momjian 已提交
270
static int	db_comparator(const void *a, const void *b);
271 272
static void autovac_balance_cost(void);

273
static void do_autovacuum(void);
274
static void FreeWorkerInfo(int code, Datum arg);
275 276

static void relation_check_autovac(Oid relid, Form_pg_class classForm,
B
Bruce Momjian 已提交
277
					Form_pg_autovacuum avForm, PgStat_StatTabEntry *tabentry,
278 279 280 281 282 283
					   List **table_oids, List **table_toast_list,
					   List **toast_oids);
static autovac_table *table_recheck_autovac(Oid relid);
static void relation_needs_vacanalyze(Oid relid, Form_pg_autovacuum avForm,
						  Form_pg_class classForm,
						  PgStat_StatTabEntry *tabentry, bool *dovacuum,
284
						  bool *doanalyze, bool *wraparound);
285

286
static void autovacuum_do_vac_analyze(Oid relid, bool dovacuum,
287 288
						  bool doanalyze, int freeze_min_age,
						  BufferAccessStrategy bstrategy);
289
static HeapTuple get_pg_autovacuum_tuple_relid(Relation avRel, Oid relid);
290 291 292
static PgStat_StatTabEntry *get_pgstat_tabentry_relid(Oid relid, bool isshared,
						  PgStat_StatDBEntry *shared,
						  PgStat_StatDBEntry *dbentry);
293
static void autovac_report_activity(VacuumStmt *vacstmt, Oid relid);
294
static void avl_sighup_handler(SIGNAL_ARGS);
295
static void avl_sigusr1_handler(SIGNAL_ARGS);
296
static void avl_sigterm_handler(SIGNAL_ARGS);
297
static void avl_quickdie(SIGNAL_ARGS);
298
static void autovac_refresh_stats(void);
299 300


301 302

/********************************************************************
B
Bruce Momjian 已提交
303
 *					  AUTOVACUUM LAUNCHER CODE
304 305 306
 ********************************************************************/

#ifdef EXEC_BACKEND
307
/*
308
 * forkexec routine for the autovacuum launcher process.
309
 *
310
 * Format up the arglist, then fork and exec.
311
 */
312 313
static pid_t
avlauncher_forkexec(void)
314
{
315 316
	char	   *av[10];
	int			ac = 0;
317

318 319 320 321
	av[ac++] = "postgres";
	av[ac++] = "--forkavlauncher";
	av[ac++] = NULL;			/* filled in by postmaster_forkexec */
	av[ac] = NULL;
322

323
	Assert(ac < lengthof(av));
324

325 326
	return postmaster_forkexec(ac, av);
}
327

328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345
/*
 * We need this set from the outside, before InitProcess is called
 */
void
AutovacuumLauncherIAm(void)
{
	am_autovacuum_launcher = true;
}
#endif

/*
 * Main entry point for autovacuum launcher process, to be called from the
 * postmaster.
 */
int
StartAutoVacLauncher(void)
{
	pid_t		AutoVacPID;
346 347

#ifdef EXEC_BACKEND
348
	switch ((AutoVacPID = avlauncher_forkexec()))
349
#else
B
Bruce Momjian 已提交
350
	switch ((AutoVacPID = fork_process()))
351 352 353 354
#endif
	{
		case -1:
			ereport(LOG,
B
Bruce Momjian 已提交
355
					(errmsg("could not fork autovacuum process: %m")));
356 357 358 359 360 361 362 363
			return 0;

#ifndef EXEC_BACKEND
		case 0:
			/* in postmaster child ... */
			/* Close the postmaster's sockets */
			ClosePostmasterPorts(false);

364 365 366
			/* Lose the postmaster's on-exit routines */
			on_exit_reset();

367
			AutoVacLauncherMain(0, NULL);
368 369 370 371 372 373 374 375 376 377 378
			break;
#endif
		default:
			return (int) AutoVacPID;
	}

	/* shouldn't get here */
	return 0;
}

/*
379
 * Main loop for the autovacuum launcher process.
380
 */
381 382
NON_EXEC_STATIC void
AutoVacLauncherMain(int argc, char *argv[])
383
{
384 385 386 387 388 389 390 391 392
	sigjmp_buf	local_sigjmp_buf;

	/* we are a postmaster subprocess now */
	IsUnderPostmaster = true;
	am_autovacuum_launcher = true;

	/* reset MyProcPid */
	MyProcPid = getpid();

393 394 395
	/* record Start Time for logging */
	MyStartTime = time(NULL);

396 397 398
	/* Identify myself via ps */
	init_ps_display("autovacuum launcher process", "", "", "");

399 400 401
	if (PostAuthDelay)
		pg_usleep(PostAuthDelay * 1000000L);

402 403 404 405
	SetProcessingMode(InitProcessing);

	/*
	 * If possible, make this process a group leader, so that the postmaster
B
Bruce Momjian 已提交
406 407 408
	 * can signal any child processes too.	(autovacuum probably never has any
	 * child processes, but for consistency we make all postmaster child
	 * processes do this.)
409 410 411 412 413 414 415
	 */
#ifdef HAVE_SETSID
	if (setsid() < 0)
		elog(FATAL, "setsid() failed: %m");
#endif

	/*
416
	 * Set up signal handlers.	Since this is an auxiliary process, it has
417 418 419 420 421 422
	 * particular signal requirements -- no deadlock checker or sinval
	 * catchup, for example.
	 */
	pqsignal(SIGHUP, avl_sighup_handler);

	pqsignal(SIGINT, SIG_IGN);
423
	pqsignal(SIGTERM, avl_sigterm_handler);
424 425 426 427
	pqsignal(SIGQUIT, avl_quickdie);
	pqsignal(SIGALRM, SIG_IGN);

	pqsignal(SIGPIPE, SIG_IGN);
428
	pqsignal(SIGUSR1, avl_sigusr1_handler);
429 430 431 432 433 434 435 436 437 438 439 440 441 442 443
	/* We don't listen for async notifies */
	pqsignal(SIGUSR2, SIG_IGN);
	pqsignal(SIGFPE, FloatExceptionHandler);
	pqsignal(SIGCHLD, SIG_DFL);

	/* Early initialization */
	BaseInit();

	/*
	 * Create a per-backend PGPROC struct in shared memory, except in the
	 * EXEC_BACKEND case where this was done in SubPostmasterMain. We must do
	 * this before we can use LWLocks (and in the EXEC_BACKEND case we already
	 * had to do some stuff with LWLocks).
	 */
#ifndef EXEC_BACKEND
444
	InitAuxiliaryProcess();
445 446 447 448 449 450 451
#endif

	/*
	 * Create a memory context that we will do all our work in.  We do this so
	 * that we can reset the context during error recovery and thereby avoid
	 * possible memory leaks.
	 */
452 453 454 455 456 457
	AutovacMemCxt = AllocSetContextCreate(TopMemoryContext,
										  "Autovacuum Launcher",
										  ALLOCSET_DEFAULT_MINSIZE,
										  ALLOCSET_DEFAULT_INITSIZE,
										  ALLOCSET_DEFAULT_MAXSIZE);
	MemoryContextSwitchTo(AutovacMemCxt);
458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477


	/*
	 * If an exception is encountered, processing resumes here.
	 *
	 * This code is heavily based on bgwriter.c, q.v.
	 */
	if (sigsetjmp(local_sigjmp_buf, 1) != 0)
	{
		/* since not using PG_TRY, must reset error stack by hand */
		error_context_stack = NULL;

		/* Prevents interrupts while cleaning up */
		HOLD_INTERRUPTS();

		/* Report the error to the server log */
		EmitErrorReport();

		/*
		 * These operations are really just a minimal subset of
B
Bruce Momjian 已提交
478
		 * AbortTransaction().	We don't have very many resources to worry
479 480 481 482
		 * about, but we do have LWLocks.
		 */
		LWLockReleaseAll();
		AtEOXact_Files();
483
		AtEOXact_HashTables(false);
484 485 486 487 488

		/*
		 * Now return to normal top-level context and clear ErrorContext for
		 * next time.
		 */
489
		MemoryContextSwitchTo(AutovacMemCxt);
490 491 492
		FlushErrorState();

		/* Flush any leaked data in the top-level context */
493 494 495 496 497
		MemoryContextResetAndDeleteChildren(AutovacMemCxt);

		/* don't leave dangling pointers to freed memory */
		DatabaseListCxt = NULL;
		DatabaseList = NULL;
498

499 500 501 502
		/*
		 * Make sure pgstat also considers our stat data as gone.  Note: we
		 * mustn't use autovac_refresh_stats here.
		 */
503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520
		pgstat_clear_snapshot();

		/* Now we can allow interrupts again */
		RESUME_INTERRUPTS();

		/*
		 * Sleep at least 1 second after any error.  We don't want to be
		 * filling the error logs as fast as we can.
		 */
		pg_usleep(1000000L);
	}

	/* We can now handle ereport(ERROR) */
	PG_exception_stack = &local_sigjmp_buf;

	ereport(LOG,
			(errmsg("autovacuum launcher started")));

521
	/* must unblock signals before calling rebuild_database_list */
522 523
	PG_SETMASK(&UnBlockSig);

524
	/* in emergency mode, just start a worker and go away */
525
	if (!AutoVacuumingActive())
526 527
	{
		do_start_worker();
B
Bruce Momjian 已提交
528
		proc_exit(0);			/* done */
529 530 531 532
	}

	AutoVacuumShmem->av_launcherpid = MyProcPid;

533
	/*
534 535 536 537 538
	 * Create the initial database list.  The invariant we want this list to
	 * keep is that it's ordered by decreasing next_time.  As soon as an entry
	 * is updated to a higher time, it will be moved to the front (which is
	 * correct because the only operation is to add autovacuum_naptime to the
	 * entry, and time always increases).
539
	 */
540
	rebuild_database_list(InvalidOid);
541 542 543

	for (;;)
	{
544
		struct timeval nap;
545
		TimestampTz current_time = 0;
B
Bruce Momjian 已提交
546 547
		bool		can_launch;
		Dlelem	   *elem;
548 549 550 551 552 553 554 555

		/*
		 * Emergency bailout if postmaster has died.  This is to avoid the
		 * necessity for manual cleanup of all postmaster children.
		 */
		if (!PostmasterIsAlive(true))
			exit(1);

556
		launcher_determine_sleep(AutoVacuumShmem->av_freeWorkers !=
B
Bruce Momjian 已提交
557
								 INVALID_OFFSET, false, &nap);
558 559

		/*
560 561 562 563 564 565
		 * Sleep for a while according to schedule.
		 *
		 * On some platforms, signals won't interrupt the sleep.  To ensure we
		 * respond reasonably promptly when someone signals us, break down the
		 * sleep into 1-second increments, and check for interrupts after each
		 * nap.
566 567 568
		 */
		while (nap.tv_sec > 0 || nap.tv_usec > 0)
		{
B
Bruce Momjian 已提交
569
			uint32		sleeptime;
570 571 572

			if (nap.tv_sec > 0)
			{
573 574 575 576 577 578 579
				sleeptime = 1000000;
				nap.tv_sec--;
			}
			else
			{
				sleeptime = nap.tv_usec;
				nap.tv_usec = 0;
580 581 582 583 584 585 586 587 588
			}
			pg_usleep(sleeptime);

			/*
			 * Emergency bailout if postmaster has died.  This is to avoid the
			 * necessity for manual cleanup of all postmaster children.
			 */
			if (!PostmasterIsAlive(true))
				exit(1);
589

590
			if (got_SIGTERM || got_SIGHUP || got_SIGUSR1)
591 592
				break;
		}
593 594

		/* the normal shutdown case */
595
		if (got_SIGTERM)
596 597 598 599 600 601
			break;

		if (got_SIGHUP)
		{
			got_SIGHUP = false;
			ProcessConfigFile(PGC_SIGHUP);
602

603
			/* shutdown requested in config file */
604
			if (!AutoVacuumingActive())
605 606
				break;

607 608 609 610 611 612 613 614 615
			/* rebalance in case the default cost parameters changed */
			LWLockAcquire(AutovacuumLock, LW_EXCLUSIVE);
			autovac_balance_cost();
			LWLockRelease(AutovacuumLock);

			/* rebuild the list in case the naptime changed */
			rebuild_database_list(InvalidOid);
		}

616 617 618 619
		/*
		 * a worker finished, or postmaster signalled failure to start a
		 * worker
		 */
620 621 622 623 624
		if (got_SIGUSR1)
		{
			got_SIGUSR1 = false;

			/* rebalance cost limits, if needed */
625
			if (AutoVacuumShmem->av_signal[AutoVacRebalance])
626 627
			{
				LWLockAcquire(AutovacuumLock, LW_EXCLUSIVE);
628
				AutoVacuumShmem->av_signal[AutoVacRebalance] = false;
629 630 631
				autovac_balance_cost();
				LWLockRelease(AutovacuumLock);
			}
632 633 634 635 636 637 638 639 640 641 642 643 644 645

			if (AutoVacuumShmem->av_signal[AutoVacForkFailed])
			{
				/*
				 * If the postmaster failed to start a new worker, we sleep
				 * for a little while and resend the signal.  The new worker's
				 * state is still in memory, so this is sufficient.  After
				 * that, we restart the main loop.
				 *
				 * XXX should we put a limit to the number of times we retry?
				 * I don't think it makes much sense, because a future start
				 * of a worker will continue to fail in the same way.
				 */
				AutoVacuumShmem->av_signal[AutoVacForkFailed] = false;
B
Bruce Momjian 已提交
646
				pg_usleep(100000L);		/* 100ms */
647 648 649
				SendPostmasterSignal(PMSIGNAL_START_AUTOVAC_WORKER);
				continue;
			}
650 651 652
		}

		/*
653 654
		 * There are some conditions that we need to check before trying to
		 * start a launcher.  First, we need to make sure that there is a
B
Bruce Momjian 已提交
655 656
		 * launcher slot available.  Second, we need to make sure that no
		 * other worker failed while starting up.
657
		 */
658

659
		current_time = GetCurrentTimestamp();
660 661
		LWLockAcquire(AutovacuumLock, LW_SHARED);

662
		can_launch = (AutoVacuumShmem->av_freeWorkers != INVALID_OFFSET);
663

664
		if (AutoVacuumShmem->av_startingWorker != INVALID_OFFSET)
665
		{
B
Bruce Momjian 已提交
666
			int			waittime;
667

B
Bruce Momjian 已提交
668
			WorkerInfo	worker = (WorkerInfo) MAKE_PTR(AutoVacuumShmem->av_startingWorker);
669 670 671

			/*
			 * We can't launch another worker when another one is still
672 673
			 * starting up (or failed while doing so), so just sleep for a bit
			 * more; that worker will wake us up again as soon as it's ready.
B
Bruce Momjian 已提交
674 675 676 677 678 679 680 681 682 683
			 * We will only wait autovacuum_naptime seconds (up to a maximum
			 * of 60 seconds) for this to happen however.  Note that failure
			 * to connect to a particular database is not a problem here,
			 * because the worker removes itself from the startingWorker
			 * pointer before trying to connect.  Problems detected by the
			 * postmaster (like fork() failure) are also reported and handled
			 * differently.  The only problems that may cause this code to
			 * fire are errors in the earlier sections of AutoVacWorkerMain,
			 * before the worker removes the WorkerInfo from the
			 * startingWorker pointer.
684
			 */
685
			waittime = Min(autovacuum_naptime, 60) * 1000;
686
			if (TimestampDifferenceExceeds(worker->wi_launchtime, current_time,
687
										   waittime))
688 689 690
			{
				LWLockRelease(AutovacuumLock);
				LWLockAcquire(AutovacuumLock, LW_EXCLUSIVE);
B
Bruce Momjian 已提交
691

692 693 694 695 696 697 698 699 700 701 702
				/*
				 * No other process can put a worker in starting mode, so if
				 * startingWorker is still INVALID after exchanging our lock,
				 * we assume it's the same one we saw above (so we don't
				 * recheck the launch time).
				 */
				if (AutoVacuumShmem->av_startingWorker != INVALID_OFFSET)
				{
					worker = (WorkerInfo) MAKE_PTR(AutoVacuumShmem->av_startingWorker);
					worker->wi_dboid = InvalidOid;
					worker->wi_tableoid = InvalidOid;
703
					worker->wi_proc = NULL;
704 705 706 707
					worker->wi_launchtime = 0;
					worker->wi_links.next = AutoVacuumShmem->av_freeWorkers;
					AutoVacuumShmem->av_freeWorkers = MAKE_OFFSET(worker);
					AutoVacuumShmem->av_startingWorker = INVALID_OFFSET;
708
					elog(WARNING, "worker took too long to start; cancelled");
709 710
				}
			}
711
			else
712
				can_launch = false;
713
		}
B
Bruce Momjian 已提交
714
		LWLockRelease(AutovacuumLock);	/* either shared or exclusive */
715

716 717 718
		/* if we can't do anything, just go back to sleep */
		if (!can_launch)
			continue;
719

720
		/* We're OK to start a new worker */
721

722 723 724
		elem = DLGetTail(DatabaseList);
		if (elem != NULL)
		{
B
Bruce Momjian 已提交
725
			avl_dbase  *avdb = DLE_VAL(elem);
726

727
			/*
B
Bruce Momjian 已提交
728 729
			 * launch a worker if next_worker is right now or it is in the
			 * past
730 731 732
			 */
			if (TimestampDifferenceExceeds(avdb->adl_next_worker,
										   current_time, 0))
733
				launch_worker(current_time);
734 735 736 737 738 739 740 741 742 743 744 745
		}
		else
		{
			/*
			 * Special case when the list is empty: start a worker right away.
			 * This covers the initial case, when no database is in pgstats
			 * (thus the list is empty).  Note that the constraints in
			 * launcher_determine_sleep keep us from starting workers too
			 * quickly (at most once every autovacuum_naptime when the list is
			 * empty).
			 */
			launch_worker(current_time);
746
		}
747 748 749 750 751
	}

	/* Normal exit from the autovac launcher is here */
	ereport(LOG,
			(errmsg("autovacuum launcher shutting down")));
752
	AutoVacuumShmem->av_launcherpid = 0;
753

B
Bruce Momjian 已提交
754
	proc_exit(0);				/* done */
755 756
}

757
/*
758
 * Determine the time to sleep, based on the database list.
759 760
 *
 * The "canlaunch" parameter indicates whether we can start a worker right now,
761 762
 * for example due to the workers being all busy.  If this is false, we will
 * cause a long sleep, which will be interrupted when a worker exits.
763
 */
764
static void
B
Bruce Momjian 已提交
765
launcher_determine_sleep(bool canlaunch, bool recursing, struct timeval * nap)
766
{
B
Bruce Momjian 已提交
767
	Dlelem	   *elem;
768 769 770

	/*
	 * We sleep until the next scheduled vacuum.  We trust that when the
B
Bruce Momjian 已提交
771 772
	 * database list was built, care was taken so that no entries have times
	 * in the past; if the first entry has too close a next_worker value, or a
773 774 775 776
	 * time in the past, we will sleep a small nominal time.
	 */
	if (!canlaunch)
	{
777 778
		nap->tv_sec = autovacuum_naptime;
		nap->tv_usec = 0;
779 780 781 782
	}
	else if ((elem = DLGetTail(DatabaseList)) != NULL)
	{
		avl_dbase  *avdb = DLE_VAL(elem);
B
Bruce Momjian 已提交
783 784 785 786
		TimestampTz current_time = GetCurrentTimestamp();
		TimestampTz next_wakeup;
		long		secs;
		int			usecs;
787 788 789

		next_wakeup = avdb->adl_next_worker;
		TimestampDifference(current_time, next_wakeup, &secs, &usecs);
790 791 792

		nap->tv_sec = secs;
		nap->tv_usec = usecs;
793 794 795 796
	}
	else
	{
		/* list is empty, sleep for whole autovacuum_naptime seconds  */
797 798
		nap->tv_sec = autovacuum_naptime;
		nap->tv_usec = 0;
799 800 801 802 803 804 805 806 807 808 809 810
	}

	/*
	 * If the result is exactly zero, it means a database had an entry with
	 * time in the past.  Rebuild the list so that the databases are evenly
	 * distributed again, and recalculate the time to sleep.  This can happen
	 * if there are more tables needing vacuum than workers, and they all take
	 * longer to vacuum than autovacuum_naptime.
	 *
	 * We only recurse once.  rebuild_database_list should always return times
	 * in the future, but it seems best not to trust too much on that.
	 */
811
	if (nap->tv_sec == 0 && nap->tv_usec == 0 && !recursing)
812 813
	{
		rebuild_database_list(InvalidOid);
814 815
		launcher_determine_sleep(canlaunch, true, nap);
		return;
816 817 818
	}

	/* 100ms is the smallest time we'll allow the launcher to sleep */
819
	if (nap->tv_sec <= 0 && nap->tv_usec <= 100000)
820
	{
821
		nap->tv_sec = 0;
822
		nap->tv_usec = 100000;	/* 100 ms */
823 824 825 826 827 828 829 830 831 832 833 834
	}
}

/*
 * Build an updated DatabaseList.  It must only contain databases that appear
 * in pgstats, and must be sorted by next_worker from highest to lowest,
 * distributed regularly across the next autovacuum_naptime interval.
 *
 * Receives the Oid of the database that made this list be generated (we call
 * this the "new" database, because when the database was already present on
 * the list, we expect that this function is not called at all).  The
 * preexisting list, if any, will be used to preserve the order of the
B
Bruce Momjian 已提交
835
 * databases in the autovacuum_naptime period.	The new database is put at the
836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852
 * end of the interval.  The actual values are not saved, which should not be
 * much of a problem.
 */
static void
rebuild_database_list(Oid newdb)
{
	List	   *dblist;
	ListCell   *cell;
	MemoryContext newcxt;
	MemoryContext oldcxt;
	MemoryContext tmpcxt;
	HASHCTL		hctl;
	int			score;
	int			nelems;
	HTAB	   *dbhash;

	/* use fresh stats */
853
	autovac_refresh_stats();
854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869

	newcxt = AllocSetContextCreate(AutovacMemCxt,
								   "AV dblist",
								   ALLOCSET_DEFAULT_MINSIZE,
								   ALLOCSET_DEFAULT_INITSIZE,
								   ALLOCSET_DEFAULT_MAXSIZE);
	tmpcxt = AllocSetContextCreate(newcxt,
								   "tmp AV dblist",
								   ALLOCSET_DEFAULT_MINSIZE,
								   ALLOCSET_DEFAULT_INITSIZE,
								   ALLOCSET_DEFAULT_MAXSIZE);
	oldcxt = MemoryContextSwitchTo(tmpcxt);

	/*
	 * Implementing this is not as simple as it sounds, because we need to put
	 * the new database at the end of the list; next the databases that were
B
Bruce Momjian 已提交
870 871
	 * already on the list, and finally (at the tail of the list) all the
	 * other databases that are not on the existing list.
872 873
	 *
	 * To do this, we build an empty hash table of scored databases.  We will
B
Bruce Momjian 已提交
874 875 876 877
	 * start with the lowest score (zero) for the new database, then
	 * increasing scores for the databases in the existing list, in order, and
	 * lastly increasing scores for all databases gotten via
	 * get_database_list() that are not already on the hash.
878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893
	 *
	 * Then we will put all the hash elements into an array, sort the array by
	 * score, and finally put the array elements into the new doubly linked
	 * list.
	 */
	hctl.keysize = sizeof(Oid);
	hctl.entrysize = sizeof(avl_dbase);
	hctl.hash = oid_hash;
	hctl.hcxt = tmpcxt;
	dbhash = hash_create("db hash", 20, &hctl,	/* magic number here FIXME */
						 HASH_ELEM | HASH_FUNCTION | HASH_CONTEXT);

	/* start by inserting the new database */
	score = 0;
	if (OidIsValid(newdb))
	{
B
Bruce Momjian 已提交
894
		avl_dbase  *db;
895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912
		PgStat_StatDBEntry *entry;

		/* only consider this database if it has a pgstat entry */
		entry = pgstat_fetch_stat_dbentry(newdb);
		if (entry != NULL)
		{
			/* we assume it isn't found because the hash was just created */
			db = hash_search(dbhash, &newdb, HASH_ENTER, NULL);

			/* hash_search already filled in the key */
			db->adl_score = score++;
			/* next_worker is filled in later */
		}
	}

	/* Now insert the databases from the existing list */
	if (DatabaseList != NULL)
	{
B
Bruce Momjian 已提交
913
		Dlelem	   *elem;
914 915 916 917 918 919 920 921 922 923 924 925

		elem = DLGetHead(DatabaseList);
		while (elem != NULL)
		{
			avl_dbase  *avdb = DLE_VAL(elem);
			avl_dbase  *db;
			bool		found;
			PgStat_StatDBEntry *entry;

			elem = DLGetSucc(elem);

			/*
B
Bruce Momjian 已提交
926 927
			 * skip databases with no stat entries -- in particular, this gets
			 * rid of dropped databases
928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974
			 */
			entry = pgstat_fetch_stat_dbentry(avdb->adl_datid);
			if (entry == NULL)
				continue;

			db = hash_search(dbhash, &(avdb->adl_datid), HASH_ENTER, &found);

			if (!found)
			{
				/* hash_search already filled in the key */
				db->adl_score = score++;
				/* next_worker is filled in later */
			}
		}
	}

	/* finally, insert all qualifying databases not previously inserted */
	dblist = get_database_list();
	foreach(cell, dblist)
	{
		avw_dbase  *avdb = lfirst(cell);
		avl_dbase  *db;
		bool		found;
		PgStat_StatDBEntry *entry;

		/* only consider databases with a pgstat entry */
		entry = pgstat_fetch_stat_dbentry(avdb->adw_datid);
		if (entry == NULL)
			continue;

		db = hash_search(dbhash, &(avdb->adw_datid), HASH_ENTER, &found);
		/* only update the score if the database was not already on the hash */
		if (!found)
		{
			/* hash_search already filled in the key */
			db->adl_score = score++;
			/* next_worker is filled in later */
		}
	}
	nelems = score;

	/* from here on, the allocated memory belongs to the new list */
	MemoryContextSwitchTo(newcxt);
	DatabaseList = DLNewList();

	if (nelems > 0)
	{
B
Bruce Momjian 已提交
975 976 977 978 979 980
		TimestampTz current_time;
		int			millis_increment;
		avl_dbase  *dbary;
		avl_dbase  *db;
		HASH_SEQ_STATUS seq;
		int			i;
981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997

		/* put all the hash elements into an array */
		dbary = palloc(nelems * sizeof(avl_dbase));

		i = 0;
		hash_seq_init(&seq, dbhash);
		while ((db = hash_seq_search(&seq)) != NULL)
			memcpy(&(dbary[i++]), db, sizeof(avl_dbase));

		/* sort the array */
		qsort(dbary, nelems, sizeof(avl_dbase), db_comparator);

		/* this is the time interval between databases in the schedule */
		millis_increment = 1000.0 * autovacuum_naptime / nelems;
		current_time = GetCurrentTimestamp();

		/*
B
Bruce Momjian 已提交
998
		 * move the elements from the array into the dllist, setting the
999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033
		 * next_worker while walking the array
		 */
		for (i = 0; i < nelems; i++)
		{
			avl_dbase  *db = &(dbary[i]);
			Dlelem	   *elem;

			current_time = TimestampTzPlusMilliseconds(current_time,
													   millis_increment);
			db->adl_next_worker = current_time;

			elem = DLNewElem(db);
			/* later elements should go closer to the head of the list */
			DLAddHead(DatabaseList, elem);
		}
	}

	/* all done, clean up memory */
	if (DatabaseListCxt != NULL)
		MemoryContextDelete(DatabaseListCxt);
	MemoryContextDelete(tmpcxt);
	DatabaseListCxt = newcxt;
	MemoryContextSwitchTo(oldcxt);
}

/* qsort comparator for avl_dbase, using adl_score */
static int
db_comparator(const void *a, const void *b)
{
	if (((avl_dbase *) a)->adl_score == ((avl_dbase *) b)->adl_score)
		return 0;
	else
		return (((avl_dbase *) a)->adl_score < ((avl_dbase *) b)->adl_score) ? 1 : -1;
}

1034 1035 1036 1037 1038
/*
 * do_start_worker
 *
 * Bare-bones procedure for starting an autovacuum worker from the launcher.
 * It determines what database to work on, sets up shared memory stuff and
B
Bruce Momjian 已提交
1039
 * signals postmaster to start the worker.	It fails gracefully if invoked when
1040 1041 1042 1043
 * autovacuum_workers are already active.
 *
 * Return value is the OID of the database that the worker is going to process,
 * or InvalidOid if no worker was actually started.
1044
 */
1045
static Oid
1046 1047 1048
do_start_worker(void)
{
	List	   *dblist;
1049
	ListCell   *cell;
1050
	TransactionId xidForceLimit;
1051 1052
	bool		for_xid_wrap;
	avw_dbase  *avdb;
B
Bruce Momjian 已提交
1053
	TimestampTz current_time;
1054
	bool		skipit = false;
1055 1056
	Oid			retval = InvalidOid;
	MemoryContext tmpcxt,
B
Bruce Momjian 已提交
1057
				oldcxt;
1058 1059 1060 1061 1062 1063 1064 1065 1066 1067

	/* return quickly when there are no free workers */
	LWLockAcquire(AutovacuumLock, LW_SHARED);
	if (AutoVacuumShmem->av_freeWorkers == INVALID_OFFSET)
	{
		LWLockRelease(AutovacuumLock);
		return InvalidOid;
	}
	LWLockRelease(AutovacuumLock);

1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078
	/*
	 * Create and switch to a temporary context to avoid leaking the memory
	 * allocated for the database list.
	 */
	tmpcxt = AllocSetContextCreate(CurrentMemoryContext,
								   "Start worker tmp cxt",
								   ALLOCSET_DEFAULT_MINSIZE,
								   ALLOCSET_DEFAULT_INITSIZE,
								   ALLOCSET_DEFAULT_MAXSIZE);
	oldcxt = MemoryContextSwitchTo(tmpcxt);

1079
	/* use fresh stats */
1080
	autovac_refresh_stats();
1081 1082

	/* Get a list of databases */
1083
	dblist = get_database_list();
1084 1085

	/*
B
Bruce Momjian 已提交
1086 1087
	 * Determine the oldest datfrozenxid/relfrozenxid that we will allow to
	 * pass without forcing a vacuum.  (This limit can be tightened for
1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114
	 * particular tables, but not loosened.)
	 */
	recentXid = ReadNewTransactionId();
	xidForceLimit = recentXid - autovacuum_freeze_max_age;
	/* ensure it's a "normal" XID, else TransactionIdPrecedes misbehaves */
	if (xidForceLimit < FirstNormalTransactionId)
		xidForceLimit -= FirstNormalTransactionId;

	/*
	 * Choose a database to connect to.  We pick the database that was least
	 * recently auto-vacuumed, or one that needs vacuuming to prevent Xid
	 * wraparound-related data loss.  If any db at risk of wraparound is
	 * found, we pick the one with oldest datfrozenxid, independently of
	 * autovacuum times.
	 *
	 * Note that a database with no stats entry is not considered, except for
	 * Xid wraparound purposes.  The theory is that if no one has ever
	 * connected to it since the stats were last initialized, it doesn't need
	 * vacuuming.
	 *
	 * XXX This could be improved if we had more info about whether it needs
	 * vacuuming before connecting to it.  Perhaps look through the pgstats
	 * data for the database's tables?  One idea is to keep track of the
	 * number of new and dead tuples per database in pgstats.  However it
	 * isn't clear how to construct a metric that measures that and not cause
	 * starvation for less busy databases.
	 */
1115
	avdb = NULL;
1116
	for_xid_wrap = false;
1117
	current_time = GetCurrentTimestamp();
1118 1119
	foreach(cell, dblist)
	{
1120 1121
		avw_dbase  *tmp = lfirst(cell);
		Dlelem	   *elem;
1122 1123

		/* Check to see if this one is at risk of wraparound */
1124
		if (TransactionIdPrecedes(tmp->adw_frozenxid, xidForceLimit))
1125
		{
1126
			if (avdb == NULL ||
B
Bruce Momjian 已提交
1127
			  TransactionIdPrecedes(tmp->adw_frozenxid, avdb->adw_frozenxid))
1128
				avdb = tmp;
1129 1130 1131 1132 1133 1134
			for_xid_wrap = true;
			continue;
		}
		else if (for_xid_wrap)
			continue;			/* ignore not-at-risk DBs */

1135 1136 1137
		/* Find pgstat entry if any */
		tmp->adw_entry = pgstat_fetch_stat_dbentry(tmp->adw_datid);

1138
		/*
1139 1140
		 * Skip a database with no pgstat entry; it means it hasn't seen any
		 * activity.
1141
		 */
1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156
		if (!tmp->adw_entry)
			continue;

		/*
		 * Also, skip a database that appears on the database list as having
		 * been processed recently (less than autovacuum_naptime seconds ago).
		 * We do this so that we don't select a database which we just
		 * selected, but that pgstat hasn't gotten around to updating the last
		 * autovacuum time yet.
		 */
		skipit = false;
		elem = DatabaseList ? DLGetTail(DatabaseList) : NULL;

		while (elem != NULL)
		{
B
Bruce Momjian 已提交
1157
			avl_dbase  *dbp = DLE_VAL(elem);
1158 1159 1160 1161

			if (dbp->adl_datid == tmp->adw_datid)
			{
				/*
1162
				 * Skip this database if its next_worker value falls between
1163 1164
				 * the current time and the current time plus naptime.
				 */
1165
				if (!TimestampDifferenceExceeds(dbp->adl_next_worker,
B
Bruce Momjian 已提交
1166
												current_time, 0) &&
1167 1168 1169
					!TimestampDifferenceExceeds(current_time,
												dbp->adl_next_worker,
												autovacuum_naptime * 1000))
1170 1171 1172 1173 1174 1175 1176
					skipit = true;

				break;
			}
			elem = DLGetPred(elem);
		}
		if (skipit)
1177 1178 1179
			continue;

		/*
B
Bruce Momjian 已提交
1180 1181
		 * Remember the db with oldest autovac time.  (If we are here, both
		 * tmp->entry and db->entry must be non-null.)
1182
		 */
1183 1184 1185
		if (avdb == NULL ||
			tmp->adw_entry->last_autovac_time < avdb->adw_entry->last_autovac_time)
			avdb = tmp;
1186 1187 1188
	}

	/* Found a database -- process it */
1189
	if (avdb != NULL)
1190
	{
1191 1192 1193
		WorkerInfo	worker;
		SHMEM_OFFSET sworker;

1194
		LWLockAcquire(AutovacuumLock, LW_EXCLUSIVE);
1195 1196 1197

		/*
		 * Get a worker entry from the freelist.  We checked above, so there
B
Bruce Momjian 已提交
1198 1199
		 * really should be a free slot -- complain very loudly if there
		 * isn't.
1200 1201 1202 1203 1204 1205 1206 1207 1208
		 */
		sworker = AutoVacuumShmem->av_freeWorkers;
		if (sworker == INVALID_OFFSET)
			elog(FATAL, "no free worker found");

		worker = (WorkerInfo) MAKE_PTR(sworker);
		AutoVacuumShmem->av_freeWorkers = worker->wi_links.next;

		worker->wi_dboid = avdb->adw_datid;
1209
		worker->wi_proc = NULL;
1210 1211 1212 1213
		worker->wi_launchtime = GetCurrentTimestamp();

		AutoVacuumShmem->av_startingWorker = sworker;

1214 1215 1216
		LWLockRelease(AutovacuumLock);

		SendPostmasterSignal(PMSIGNAL_START_AUTOVAC_WORKER);
1217

1218
		retval = avdb->adw_datid;
1219 1220 1221 1222 1223 1224 1225 1226 1227 1228
	}
	else if (skipit)
	{
		/*
		 * If we skipped all databases on the list, rebuild it, because it
		 * probably contains a dropped database.
		 */
		rebuild_database_list(InvalidOid);
	}

1229 1230 1231 1232
	MemoryContextSwitchTo(oldcxt);
	MemoryContextDelete(tmpcxt);

	return retval;
1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249
}

/*
 * launch_worker
 *
 * Wrapper for starting a worker from the launcher.  Besides actually starting
 * it, update the database list to reflect the next time that another one will
 * need to be started on the selected database.  The actual database choice is
 * left to do_start_worker.
 *
 * This routine is also expected to insert an entry into the database list if
 * the selected database was previously absent from the list.  It returns the
 * new database list.
 */
static void
launch_worker(TimestampTz now)
{
B
Bruce Momjian 已提交
1250 1251
	Oid			dbid;
	Dlelem	   *elem;
1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262

	dbid = do_start_worker();
	if (OidIsValid(dbid))
	{
		/*
		 * Walk the database list and update the corresponding entry.  If the
		 * database is not on the list, we'll recreate the list.
		 */
		elem = (DatabaseList == NULL) ? NULL : DLGetHead(DatabaseList);
		while (elem != NULL)
		{
B
Bruce Momjian 已提交
1263
			avl_dbase  *avdb = DLE_VAL(elem);
1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280

			if (avdb->adl_datid == dbid)
			{
				/*
				 * add autovacuum_naptime seconds to the current time, and use
				 * that as the new "next_worker" field for this database.
				 */
				avdb->adl_next_worker =
					TimestampTzPlusMilliseconds(now, autovacuum_naptime * 1000);

				DLMoveToFront(elem);
				break;
			}
			elem = DLGetSucc(elem);
		}

		/*
B
Bruce Momjian 已提交
1281 1282 1283 1284 1285
		 * If the database was not present in the database list, we rebuild
		 * the list.  It's possible that the database does not get into the
		 * list anyway, for example if it's a database that doesn't have a
		 * pgstat entry, but this is not a problem because we don't want to
		 * schedule workers regularly into those in any case.
1286 1287 1288
		 */
		if (elem == NULL)
			rebuild_database_list(dbid);
1289 1290 1291
	}
}

1292 1293
/*
 * Called from postmaster to signal a failure to fork a process to become
B
Bruce Momjian 已提交
1294
 * worker.	The postmaster should kill(SIGUSR1) the launcher shortly
1295 1296 1297 1298 1299 1300 1301 1302
 * after calling this function.
 */
void
AutoVacWorkerFailed(void)
{
	AutoVacuumShmem->av_signal[AutoVacForkFailed] = true;
}

1303 1304 1305 1306 1307
/* SIGHUP: set flag to re-read config file at next convenient time */
static void
avl_sighup_handler(SIGNAL_ARGS)
{
	got_SIGHUP = true;
1308 1309
}

1310 1311 1312 1313 1314 1315 1316
/* SIGUSR1: a worker is up and running, or just finished */
static void
avl_sigusr1_handler(SIGNAL_ARGS)
{
	got_SIGUSR1 = true;
}

1317
/* SIGTERM: time to die */
1318
static void
1319
avl_sigterm_handler(SIGNAL_ARGS)
1320
{
1321
	got_SIGTERM = true;
1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349
}

/*
 * avl_quickdie occurs when signalled SIGQUIT from postmaster.
 *
 * Some backend has bought the farm, so we need to stop what we're doing
 * and exit.
 */
static void
avl_quickdie(SIGNAL_ARGS)
{
	PG_SETMASK(&BlockSig);

	/*
	 * DO NOT proc_exit() -- we're here because shared memory may be
	 * corrupted, so we don't want to try to clean up our transaction. Just
	 * nail the windows shut and get out of town.
	 *
	 * Note we do exit(2) not exit(0).	This is to force the postmaster into a
	 * system reset cycle if some idiot DBA sends a manual SIGQUIT to a random
	 * backend.  This is necessary precisely because we don't clean up our
	 * shared memory state.
	 */
	exit(2);
}


/********************************************************************
B
Bruce Momjian 已提交
1350
 *					  AUTOVACUUM WORKER CODE
1351 1352
 ********************************************************************/

1353 1354
#ifdef EXEC_BACKEND
/*
1355
 * forkexec routines for the autovacuum worker.
1356
 *
1357
 * Format up the arglist, then fork and exec.
1358 1359
 */
static pid_t
1360
avworker_forkexec(void)
1361 1362 1363 1364 1365
{
	char	   *av[10];
	int			ac = 0;

	av[ac++] = "postgres";
1366
	av[ac++] = "--forkavworker";
B
Bruce Momjian 已提交
1367
	av[ac++] = NULL;			/* filled in by postmaster_forkexec */
1368 1369 1370 1371 1372 1373
	av[ac] = NULL;

	Assert(ac < lengthof(av));

	return postmaster_forkexec(ac, av);
}
1374 1375 1376 1377 1378

/*
 * We need this set from the outside, before InitProcess is called
 */
void
1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391
AutovacuumWorkerIAm(void)
{
	am_autovacuum_worker = true;
}
#endif

/*
 * Main entry point for autovacuum worker process.
 *
 * This code is heavily based on pgarch.c, q.v.
 */
int
StartAutoVacWorker(void)
1392
{
1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423
	pid_t		worker_pid;

#ifdef EXEC_BACKEND
	switch ((worker_pid = avworker_forkexec()))
#else
	switch ((worker_pid = fork_process()))
#endif
	{
		case -1:
			ereport(LOG,
					(errmsg("could not fork autovacuum process: %m")));
			return 0;

#ifndef EXEC_BACKEND
		case 0:
			/* in postmaster child ... */
			/* Close the postmaster's sockets */
			ClosePostmasterPorts(false);

			/* Lose the postmaster's on-exit routines */
			on_exit_reset();

			AutoVacWorkerMain(0, NULL);
			break;
#endif
		default:
			return (int) worker_pid;
	}

	/* shouldn't get here */
	return 0;
1424
}
1425 1426

/*
1427
 * AutoVacWorkerMain
1428 1429
 */
NON_EXEC_STATIC void
1430
AutoVacWorkerMain(int argc, char *argv[])
1431
{
B
Bruce Momjian 已提交
1432
	sigjmp_buf	local_sigjmp_buf;
1433
	Oid			dbid;
1434 1435 1436

	/* we are a postmaster subprocess now */
	IsUnderPostmaster = true;
1437
	am_autovacuum_worker = true;
1438 1439 1440 1441

	/* reset MyProcPid */
	MyProcPid = getpid();

1442 1443 1444
	/* record Start Time for logging */
	MyStartTime = time(NULL);

1445
	/* Identify myself via ps */
1446
	init_ps_display("autovacuum worker process", "", "", "");
1447 1448 1449

	SetProcessingMode(InitProcessing);

1450 1451
	/*
	 * If possible, make this process a group leader, so that the postmaster
B
Bruce Momjian 已提交
1452 1453 1454
	 * can signal any child processes too.	(autovacuum probably never has any
	 * child processes, but for consistency we make all postmaster child
	 * processes do this.)
1455 1456 1457 1458 1459 1460
	 */
#ifdef HAVE_SETSID
	if (setsid() < 0)
		elog(FATAL, "setsid() failed: %m");
#endif

1461
	/*
B
Bruce Momjian 已提交
1462 1463 1464
	 * Set up signal handlers.	We operate on databases much like a regular
	 * backend, so we use the same signal handling.  See equivalent code in
	 * tcop/postgres.c.
1465
	 *
1466 1467
	 * Currently, we don't pay attention to postgresql.conf changes that
	 * happen during a single daemon iteration, so we can ignore SIGHUP.
1468 1469
	 */
	pqsignal(SIGHUP, SIG_IGN);
B
Bruce Momjian 已提交
1470

1471
	/*
B
Bruce Momjian 已提交
1472 1473
	 * SIGINT is used to signal cancelling the current table's vacuum; SIGTERM
	 * means abort and exit cleanly, and SIGQUIT means abandon ship.
1474 1475 1476 1477 1478 1479 1480 1481 1482 1483
	 */
	pqsignal(SIGINT, StatementCancelHandler);
	pqsignal(SIGTERM, die);
	pqsignal(SIGQUIT, quickdie);
	pqsignal(SIGALRM, handle_sig_alarm);

	pqsignal(SIGPIPE, SIG_IGN);
	pqsignal(SIGUSR1, CatchupInterruptHandler);
	/* We don't listen for async notifies */
	pqsignal(SIGUSR2, SIG_IGN);
1484
	pqsignal(SIGFPE, FloatExceptionHandler);
1485 1486 1487 1488 1489
	pqsignal(SIGCHLD, SIG_DFL);

	/* Early initialization */
	BaseInit();

1490
	/*
B
Bruce Momjian 已提交
1491 1492 1493 1494
	 * Create a per-backend PGPROC struct in shared memory, except in the
	 * EXEC_BACKEND case where this was done in SubPostmasterMain. We must do
	 * this before we can use LWLocks (and in the EXEC_BACKEND case we already
	 * had to do some stuff with LWLocks).
1495 1496 1497 1498 1499
	 */
#ifndef EXEC_BACKEND
	InitProcess();
#endif

1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513
	/*
	 * If an exception is encountered, processing resumes here.
	 *
	 * See notes in postgres.c about the design of this coding.
	 */
	if (sigsetjmp(local_sigjmp_buf, 1) != 0)
	{
		/* Prevents interrupts while cleaning up */
		HOLD_INTERRUPTS();

		/* Report the error to the server log */
		EmitErrorReport();

		/*
1514 1515
		 * We can now go away.	Note that because we called InitProcess, a
		 * callback was registered to do ProcKill, which will clean up
B
Bruce Momjian 已提交
1516
		 * necessary state.
1517 1518 1519 1520 1521 1522 1523 1524 1525
		 */
		proc_exit(0);
	}

	/* We can now handle ereport(ERROR) */
	PG_exception_stack = &local_sigjmp_buf;

	PG_SETMASK(&UnBlockSig);

1526
	/*
B
Bruce Momjian 已提交
1527 1528 1529
	 * Force zero_damaged_pages OFF in the autovac process, even if it is set
	 * in postgresql.conf.	We don't really want such a dangerous option being
	 * applied non-interactively.
1530 1531 1532
	 */
	SetConfigOption("zero_damaged_pages", "false", PGC_SUSET, PGC_S_OVERRIDE);

1533
	/*
1534 1535
	 * Force statement_timeout to zero to avoid a timeout setting from
	 * preventing regular maintenance from being executed.
1536
	 */
1537
	SetConfigOption("statement_timeout", "0", PGC_SUSET, PGC_S_OVERRIDE);
1538

1539 1540 1541 1542
	/*
	 * Get the info about the database we're going to work on.
	 */
	LWLockAcquire(AutovacuumLock, LW_EXCLUSIVE);
1543

1544
	/*
B
Bruce Momjian 已提交
1545 1546 1547 1548
	 * beware of startingWorker being INVALID; this should normally not
	 * happen, but if a worker fails after forking and before this, the
	 * launcher might have decided to remove it from the queue and start
	 * again.
1549
	 */
1550 1551 1552 1553
	if (AutoVacuumShmem->av_startingWorker != INVALID_OFFSET)
	{
		MyWorkerInfo = (WorkerInfo) MAKE_PTR(AutoVacuumShmem->av_startingWorker);
		dbid = MyWorkerInfo->wi_dboid;
1554
		MyWorkerInfo->wi_proc = MyProc;
1555

1556
		/* insert into the running list */
B
Bruce Momjian 已提交
1557
		SHMQueueInsertBefore(&AutoVacuumShmem->av_runningWorkers,
1558
							 &MyWorkerInfo->wi_links);
1559

1560
		/*
1561 1562
		 * remove from the "starting" pointer, so that the launcher can start
		 * a new worker if required
1563 1564 1565
		 */
		AutoVacuumShmem->av_startingWorker = INVALID_OFFSET;
		LWLockRelease(AutovacuumLock);
1566

1567 1568 1569 1570 1571 1572 1573
		on_shmem_exit(FreeWorkerInfo, 0);

		/* wake up the launcher */
		if (AutoVacuumShmem->av_launcherpid != 0)
			kill(AutoVacuumShmem->av_launcherpid, SIGUSR1);
	}
	else
1574
	{
1575
		/* no worker entry for me, go away */
1576
		elog(WARNING, "autovacuum worker started without a worker entry");
1577
		dbid = InvalidOid;
1578
		LWLockRelease(AutovacuumLock);
1579
	}
1580

1581
	if (OidIsValid(dbid))
1582
	{
B
Bruce Momjian 已提交
1583
		char	   *dbname;
1584

1585
		/*
B
Bruce Momjian 已提交
1586 1587 1588 1589 1590 1591
		 * Report autovac startup to the stats collector.  We deliberately do
		 * this before InitPostgres, so that the last_autovac_time will get
		 * updated even if the connection attempt fails.  This is to prevent
		 * autovac from getting "stuck" repeatedly selecting an unopenable
		 * database, rather than making any progress on stuff it can connect
		 * to.
1592
		 */
1593
		pgstat_report_autovac(dbid);
1594

1595 1596
		/*
		 * Connect to the selected database
1597 1598 1599
		 *
		 * Note: if we have selected a just-deleted database (due to using
		 * stale stats info), we'll fail and exit here.
1600
		 */
1601
		InitPostgres(NULL, dbid, NULL, &dbname);
1602
		SetProcessingMode(NormalProcessing);
1603
		set_ps_display(dbname, false);
1604
		ereport(DEBUG1,
1605
				(errmsg("autovacuum: processing database \"%s\"", dbname)));
1606

1607 1608 1609
		if (PostAuthDelay)
			pg_usleep(PostAuthDelay * 1000000L);

1610 1611
		/* And do an appropriate amount of work */
		recentXid = ReadNewTransactionId();
1612
		do_autovacuum();
1613 1614
	}

1615
	/*
1616 1617
	 * The launcher will be notified of my death in ProcKill, *if* we managed
	 * to get a worker slot at all
1618 1619 1620
	 */

	/* All done, go away */
1621 1622 1623 1624
	proc_exit(0);
}

/*
1625 1626
 * Return a WorkerInfo to the free list
 */
1627 1628 1629 1630 1631 1632 1633 1634
static void
FreeWorkerInfo(int code, Datum arg)
{
	if (MyWorkerInfo != NULL)
	{
		LWLockAcquire(AutovacuumLock, LW_EXCLUSIVE);

		/*
1635 1636
		 * Wake the launcher up so that he can launch a new worker immediately
		 * if required.  We only save the launcher's PID in local memory here;
B
Bruce Momjian 已提交
1637
		 * the actual signal will be sent when the PGPROC is recycled.	Note
1638 1639
		 * that we always do this, so that the launcher can rebalance the cost
		 * limit setting of the remaining workers.
1640 1641 1642 1643 1644 1645
		 *
		 * We somewhat ignore the risk that the launcher changes its PID
		 * between we reading it and the actual kill; we expect ProcKill to be
		 * called shortly after us, and we assume that PIDs are not reused too
		 * quickly after a process exits.
		 */
1646
		AutovacuumLauncherPid = AutoVacuumShmem->av_launcherpid;
1647 1648 1649 1650 1651

		SHMQueueDelete(&MyWorkerInfo->wi_links);
		MyWorkerInfo->wi_links.next = AutoVacuumShmem->av_freeWorkers;
		MyWorkerInfo->wi_dboid = InvalidOid;
		MyWorkerInfo->wi_tableoid = InvalidOid;
1652
		MyWorkerInfo->wi_proc = NULL;
1653 1654 1655 1656 1657 1658 1659 1660 1661 1662 1663 1664
		MyWorkerInfo->wi_launchtime = 0;
		MyWorkerInfo->wi_cost_delay = 0;
		MyWorkerInfo->wi_cost_limit = 0;
		MyWorkerInfo->wi_cost_limit_base = 0;
		AutoVacuumShmem->av_freeWorkers = MAKE_OFFSET(MyWorkerInfo);
		/* not mine anymore */
		MyWorkerInfo = NULL;

		/*
		 * now that we're inactive, cause a rebalancing of the surviving
		 * workers
		 */
1665
		AutoVacuumShmem->av_signal[AutoVacRebalance] = true;
1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681 1682 1683 1684 1685 1686 1687 1688 1689 1690 1691 1692 1693
		LWLockRelease(AutovacuumLock);
	}
}

/*
 * Update the cost-based delay parameters, so that multiple workers consume
 * each a fraction of the total available I/O.
 */
void
AutoVacuumUpdateDelay(void)
{
	if (MyWorkerInfo)
	{
		VacuumCostDelay = MyWorkerInfo->wi_cost_delay;
		VacuumCostLimit = MyWorkerInfo->wi_cost_limit;
	}
}

/*
 * autovac_balance_cost
 *		Recalculate the cost limit setting for each active workers.
 *
 * Caller must hold the AutovacuumLock in exclusive mode.
 */
static void
autovac_balance_cost(void)
{
	WorkerInfo	worker;
B
Bruce Momjian 已提交
1694

1695 1696 1697 1698
	/*
	 * note: in cost_limit, zero also means use value from elsewhere, because
	 * zero is not a valid value.
	 */
B
Bruce Momjian 已提交
1699 1700 1701 1702 1703 1704
	int			vac_cost_limit = (autovacuum_vac_cost_limit > 0 ?
								autovacuum_vac_cost_limit : VacuumCostLimit);
	int			vac_cost_delay = (autovacuum_vac_cost_delay >= 0 ?
								autovacuum_vac_cost_delay : VacuumCostDelay);
	double		cost_total;
	double		cost_avail;
1705 1706 1707 1708 1709 1710 1711 1712 1713 1714 1715 1716

	/* not set? nothing to do */
	if (vac_cost_limit <= 0 || vac_cost_delay <= 0)
		return;

	/* caculate the total base cost limit of active workers */
	cost_total = 0.0;
	worker = (WorkerInfo) SHMQueueNext(&AutoVacuumShmem->av_runningWorkers,
									   &AutoVacuumShmem->av_runningWorkers,
									   offsetof(WorkerInfoData, wi_links));
	while (worker)
	{
1717
		if (worker->wi_proc != NULL &&
1718 1719 1720 1721 1722 1723
			worker->wi_cost_limit_base > 0 && worker->wi_cost_delay > 0)
			cost_total +=
				(double) worker->wi_cost_limit_base / worker->wi_cost_delay;

		worker = (WorkerInfo) SHMQueueNext(&AutoVacuumShmem->av_runningWorkers,
										   &worker->wi_links,
B
Bruce Momjian 已提交
1724
										 offsetof(WorkerInfoData, wi_links));
1725 1726 1727 1728 1729 1730
	}
	/* there are no cost limits -- nothing to do */
	if (cost_total <= 0)
		return;

	/*
B
Bruce Momjian 已提交
1731 1732
	 * Adjust each cost limit of active workers to balance the total of cost
	 * limit to autovacuum_vacuum_cost_limit.
1733 1734 1735 1736 1737 1738 1739
	 */
	cost_avail = (double) vac_cost_limit / vac_cost_delay;
	worker = (WorkerInfo) SHMQueueNext(&AutoVacuumShmem->av_runningWorkers,
									   &AutoVacuumShmem->av_runningWorkers,
									   offsetof(WorkerInfoData, wi_links));
	while (worker)
	{
1740
		if (worker->wi_proc != NULL &&
1741 1742
			worker->wi_cost_limit_base > 0 && worker->wi_cost_delay > 0)
		{
B
Bruce Momjian 已提交
1743 1744
			int			limit = (int)
			(cost_avail * worker->wi_cost_limit_base / cost_total);
1745

1746 1747 1748 1749 1750
			/*
			 * We put a lower bound of 1 to the cost_limit, to avoid division-
			 * by-zero in the vacuum code.
			 */
			worker->wi_cost_limit = Max(Min(limit, worker->wi_cost_limit_base), 1);
1751 1752

			elog(DEBUG2, "autovac_balance_cost(pid=%u db=%u, rel=%u, cost_limit=%d, cost_delay=%d)",
1753
				 worker->wi_proc->pid, worker->wi_dboid,
1754 1755 1756 1757 1758
				 worker->wi_tableoid, worker->wi_cost_limit, worker->wi_cost_delay);
		}

		worker = (WorkerInfo) SHMQueueNext(&AutoVacuumShmem->av_runningWorkers,
										   &worker->wi_links,
B
Bruce Momjian 已提交
1759
										 offsetof(WorkerInfoData, wi_links));
1760 1761 1762 1763 1764
	}
}

/*
 * get_database_list
1765
 *
B
Bruce Momjian 已提交
1766
 *		Return a list of all databases.  Note we cannot use pg_database,
1767
 *		because we aren't connected; we use the flat database file.
1768 1769
 */
static List *
1770
get_database_list(void)
1771
{
B
Bruce Momjian 已提交
1772 1773 1774 1775 1776 1777
	char	   *filename;
	List	   *dblist = NIL;
	char		thisname[NAMEDATALEN];
	FILE	   *db_file;
	Oid			db_id;
	Oid			db_tablespace;
1778
	TransactionId db_frozenxid;
1779 1780 1781 1782 1783 1784 1785 1786

	filename = database_getflatfilename();
	db_file = AllocateFile(filename, "r");
	if (db_file == NULL)
		ereport(FATAL,
				(errcode_for_file_access(),
				 errmsg("could not open file \"%s\": %m", filename)));

1787
	while (read_pg_database_line(db_file, thisname, &db_id,
1788
								 &db_tablespace, &db_frozenxid))
1789
	{
B
Bruce Momjian 已提交
1790
		avw_dbase  *avdb;
1791

1792
		avdb = (avw_dbase *) palloc(sizeof(avw_dbase));
1793

1794 1795 1796
		avdb->adw_datid = db_id;
		avdb->adw_name = pstrdup(thisname);
		avdb->adw_frozenxid = db_frozenxid;
1797
		/* this gets set later: */
1798
		avdb->adw_entry = NULL;
1799

1800
		dblist = lappend(dblist, avdb);
1801 1802 1803 1804 1805 1806 1807 1808
	}

	FreeFile(db_file);
	pfree(filename);

	return dblist;
}

1809 1810
/*
 * Process a database table-by-table
1811
 *
1812 1813 1814 1815
 * Note that CHECK_FOR_INTERRUPTS is supposed to be used in certain spots in
 * order not to ignore shutdown commands for too long.
 */
static void
1816
do_autovacuum(void)
1817
{
B
Bruce Momjian 已提交
1818 1819 1820 1821
	Relation	classRel,
				avRel;
	HeapTuple	tuple;
	HeapScanDesc relScan;
1822
	Form_pg_database dbForm;
1823 1824 1825
	List	   *table_oids = NIL;
	List	   *toast_oids = NIL;
	List	   *table_toast_list = NIL;
B
Bruce Momjian 已提交
1826
	ListCell   *volatile cell;
1827
	PgStat_StatDBEntry *shared;
1828
	PgStat_StatDBEntry *dbentry;
1829
	BufferAccessStrategy bstrategy;
1830

1831 1832 1833 1834 1835 1836 1837 1838 1839 1840 1841 1842
	/*
	 * StartTransactionCommand and CommitTransactionCommand will automatically
	 * switch to other contexts.  We need this one to keep the list of
	 * relations to vacuum/analyze across transactions.
	 */
	AutovacMemCxt = AllocSetContextCreate(TopMemoryContext,
										  "AV worker",
										  ALLOCSET_DEFAULT_MINSIZE,
										  ALLOCSET_DEFAULT_INITSIZE,
										  ALLOCSET_DEFAULT_MAXSIZE);
	MemoryContextSwitchTo(AutovacMemCxt);

1843
	/*
B
Bruce Momjian 已提交
1844 1845
	 * may be NULL if we couldn't find an entry (only happens if we are
	 * forcing a vacuum for anti-wrap purposes).
1846
	 */
1847
	dbentry = pgstat_fetch_stat_dbentry(MyDatabaseId);
1848 1849 1850 1851

	/* Start a transaction so our commands have one to play into. */
	StartTransactionCommand();

B
Bruce Momjian 已提交
1852
	/* functions in indexes may want a snapshot set */
1853 1854
	ActiveSnapshot = CopySnapshot(GetTransactionSnapshot());

1855
	/*
B
Bruce Momjian 已提交
1856 1857 1858
	 * Clean up any dead statistics collector entries for this DB. We always
	 * want to do this exactly once per DB-processing cycle, even if we find
	 * nothing worth vacuuming in the database.
1859 1860 1861
	 */
	pgstat_vacuum_tabstat();

1862
	/*
B
Bruce Momjian 已提交
1863 1864 1865
	 * Find the pg_database entry and select the default freeze_min_age. We
	 * use zero in template and nonconnectable databases, else the system-wide
	 * default.
1866 1867 1868 1869 1870 1871 1872 1873 1874 1875 1876 1877 1878 1879 1880
	 */
	tuple = SearchSysCache(DATABASEOID,
						   ObjectIdGetDatum(MyDatabaseId),
						   0, 0, 0);
	if (!HeapTupleIsValid(tuple))
		elog(ERROR, "cache lookup failed for database %u", MyDatabaseId);
	dbForm = (Form_pg_database) GETSTRUCT(tuple);

	if (dbForm->datistemplate || !dbForm->datallowconn)
		default_freeze_min_age = 0;
	else
		default_freeze_min_age = vacuum_freeze_min_age;

	ReleaseSysCache(tuple);

1881
	/* StartTransactionCommand changed elsewhere */
1882 1883
	MemoryContextSwitchTo(AutovacMemCxt);

1884 1885
	/* The database hash where pgstat keeps shared relations */
	shared = pgstat_fetch_stat_dbentry(InvalidOid);
1886

1887 1888
	classRel = heap_open(RelationRelationId, AccessShareLock);
	avRel = heap_open(AutovacuumRelationId, AccessShareLock);
1889

1890 1891 1892
	/*
	 * Scan pg_class and determine which tables to vacuum.
	 *
1893 1894 1895 1896
	 * The stats subsystem collects stats for toast tables independently of
	 * the stats for their parent tables.  We need to check those stats since
	 * in cases with short, wide tables there might be proportionally much
	 * more activity in the toast table than in its parent.
1897 1898 1899
	 *
	 * Since we can only issue VACUUM against the parent table, we need to
	 * transpose a decision to vacuum a toast table into a decision to vacuum
B
Bruce Momjian 已提交
1900 1901
	 * its parent.	There's no point in considering ANALYZE on a toast table,
	 * either.	To support this, we keep a list of OIDs of toast tables that
1902 1903
	 * need vacuuming alongside the list of regular tables.  Regular tables
	 * will be entered into the table list even if they appear not to need
B
Bruce Momjian 已提交
1904 1905
	 * vacuuming; we go back and re-mark them after finding all the vacuumable
	 * toast tables.
1906
	 */
1907
	relScan = heap_beginscan(classRel, SnapshotNow, 0, NULL);
1908

1909 1910 1911 1912 1913 1914 1915 1916
	while ((tuple = heap_getnext(relScan, ForwardScanDirection)) != NULL)
	{
		Form_pg_class classForm = (Form_pg_class) GETSTRUCT(tuple);
		Form_pg_autovacuum avForm = NULL;
		PgStat_StatTabEntry *tabentry;
		HeapTuple	avTup;
		Oid			relid;

1917 1918 1919
		/* Consider only regular and toast tables. */
		if (classForm->relkind != RELKIND_RELATION &&
			classForm->relkind != RELKIND_TOASTVALUE)
1920
			continue;
1921

1922
		/*
B
Bruce Momjian 已提交
1923 1924
		 * Skip temp tables (i.e. those in temp namespaces).  We cannot safely
		 * process other backends' temp tables.
1925
		 */
1926
		if (isAnyTempNamespace(classForm->relnamespace))
1927
			continue;
1928

1929
		relid = HeapTupleGetOid(tuple);
1930

1931 1932
		/* Fetch the pg_autovacuum tuple for the relation, if any */
		avTup = get_pg_autovacuum_tuple_relid(avRel, relid);
1933 1934
		if (HeapTupleIsValid(avTup))
			avForm = (Form_pg_autovacuum) GETSTRUCT(avTup);
1935

1936 1937 1938
		/* Fetch the pgstat entry for this table */
		tabentry = get_pgstat_tabentry_relid(relid, classForm->relisshared,
											 shared, dbentry);
1939

1940 1941
		relation_check_autovac(relid, classForm, avForm, tabentry,
							   &table_oids, &table_toast_list, &toast_oids);
1942

1943 1944
		if (HeapTupleIsValid(avTup))
			heap_freetuple(avTup);
1945
	}
1946

1947 1948 1949
	heap_endscan(relScan);
	heap_close(avRel, AccessShareLock);
	heap_close(classRel, AccessShareLock);
1950

1951 1952 1953 1954
	/*
	 * Add to the list of tables to vacuum, the OIDs of the tables that
	 * correspond to the saved OIDs of toast tables needing vacuum.
	 */
1955
	foreach(cell, toast_oids)
1956
	{
B
Bruce Momjian 已提交
1957 1958
		Oid			toastoid = lfirst_oid(cell);
		ListCell   *cell2;
1959

1960
		foreach(cell2, table_toast_list)
1961
		{
B
Bruce Momjian 已提交
1962
			av_relation *ar = lfirst(cell2);
1963 1964 1965 1966 1967 1968 1969 1970 1971 1972 1973 1974 1975 1976

			if (ar->ar_toastrelid == toastoid)
			{
				table_oids = lappend_oid(table_oids, ar->ar_relid);
				break;
			}
		}
	}

	list_free_deep(table_toast_list);
	table_toast_list = NIL;
	list_free(toast_oids);
	toast_oids = NIL;

1977
	/*
B
Bruce Momjian 已提交
1978 1979 1980
	 * Create a buffer access strategy object for VACUUM to use.  We want to
	 * use the same one across all the vacuum operations we perform, since the
	 * point is for VACUUM not to blow out the shared cache.
1981 1982 1983
	 */
	bstrategy = GetAccessStrategy(BAS_VACUUM);

1984 1985 1986 1987 1988 1989 1990 1991 1992 1993
	/*
	 * create a memory context to act as fake PortalContext, so that the
	 * contexts created in the vacuum code are cleaned up for each table.
	 */
	PortalContext = AllocSetContextCreate(AutovacMemCxt,
										  "Autovacuum Portal",
										  ALLOCSET_DEFAULT_INITSIZE,
										  ALLOCSET_DEFAULT_MINSIZE,
										  ALLOCSET_DEFAULT_MAXSIZE);

1994 1995 1996
	/*
	 * Perform operations on collected tables.
	 */
1997
	foreach(cell, table_oids)
1998
	{
B
Bruce Momjian 已提交
1999
		Oid			relid = lfirst_oid(cell);
2000
		autovac_table *tab;
2001
		WorkerInfo	worker;
B
Bruce Momjian 已提交
2002
		bool		skipit;
2003 2004 2005
		char	   *datname,
				   *nspname,
				   *relname;
2006

2007
		CHECK_FOR_INTERRUPTS();
2008

2009
		/*
B
Bruce Momjian 已提交
2010 2011 2012
		 * hold schedule lock from here until we're sure that this table still
		 * needs vacuuming.  We also need the AutovacuumLock to walk the
		 * worker array, but we'll let go of that one quickly.
2013 2014 2015 2016 2017 2018 2019 2020 2021 2022
		 */
		LWLockAcquire(AutovacuumScheduleLock, LW_EXCLUSIVE);
		LWLockAcquire(AutovacuumLock, LW_SHARED);

		/*
		 * Check whether the table is being vacuumed concurrently by another
		 * worker.
		 */
		skipit = false;
		worker = (WorkerInfo) SHMQueueNext(&AutoVacuumShmem->av_runningWorkers,
B
Bruce Momjian 已提交
2023 2024
										 &AutoVacuumShmem->av_runningWorkers,
										 offsetof(WorkerInfoData, wi_links));
2025 2026 2027 2028 2029 2030 2031 2032 2033 2034 2035 2036 2037 2038 2039 2040
		while (worker)
		{
			/* ignore myself */
			if (worker == MyWorkerInfo)
				goto next_worker;

			/* ignore workers in other databases */
			if (worker->wi_dboid != MyDatabaseId)
				goto next_worker;

			if (worker->wi_tableoid == relid)
			{
				skipit = true;
				break;
			}

B
Bruce Momjian 已提交
2041
	next_worker:
2042 2043
			worker = (WorkerInfo) SHMQueueNext(&AutoVacuumShmem->av_runningWorkers,
											   &worker->wi_links,
B
Bruce Momjian 已提交
2044
										 offsetof(WorkerInfoData, wi_links));
2045 2046 2047 2048 2049 2050 2051 2052
		}
		LWLockRelease(AutovacuumLock);
		if (skipit)
		{
			LWLockRelease(AutovacuumScheduleLock);
			continue;
		}

2053
		/*
2054
		 * Check whether pgstat data still says we need to vacuum this table.
B
Bruce Momjian 已提交
2055 2056
		 * It could have changed if something else processed the table while
		 * we weren't looking.
2057 2058 2059
		 *
		 * FIXME we ignore the possibility that the table was finished being
		 * vacuumed in the last 500ms (PGSTAT_STAT_INTERVAL).  This is a bug.
2060
		 */
2061
		MemoryContextSwitchTo(AutovacMemCxt);
2062 2063
		tab = table_recheck_autovac(relid);
		if (tab == NULL)
2064
		{
2065
			/* someone else vacuumed the table */
2066
			LWLockRelease(AutovacuumScheduleLock);
2067
			continue;
2068
		}
2069

2070
		/*
B
Bruce Momjian 已提交
2071
		 * Ok, good to go.	Store the table in shared memory before releasing
2072 2073 2074 2075 2076 2077
		 * the lock so that other workers don't vacuum it concurrently.
		 */
		MyWorkerInfo->wi_tableoid = relid;
		LWLockRelease(AutovacuumScheduleLock);

		/* Set the initial vacuum cost parameters for this table */
2078 2079
		VacuumCostDelay = tab->at_vacuum_cost_delay;
		VacuumCostLimit = tab->at_vacuum_cost_limit;
2080

2081
		/* Last fixups before actually starting to work */
2082
		LWLockAcquire(AutovacuumLock, LW_EXCLUSIVE);
2083 2084

		/* advertise my cost delay parameters for the balancing algorithm */
2085 2086 2087
		MyWorkerInfo->wi_cost_delay = tab->at_vacuum_cost_delay;
		MyWorkerInfo->wi_cost_limit = tab->at_vacuum_cost_limit;
		MyWorkerInfo->wi_cost_limit_base = tab->at_vacuum_cost_limit;
2088 2089

		/* do a balance */
2090
		autovac_balance_cost();
2091 2092

		/* done */
2093 2094
		LWLockRelease(AutovacuumLock);

2095 2096 2097
		/* clean up memory before each iteration */
		MemoryContextResetAndDeleteChildren(PortalContext);

2098 2099 2100 2101 2102 2103 2104 2105
		/* set the "vacuum for wraparound" flag in PGPROC */
		if (tab->at_wraparound)
		{
			LWLockAcquire(ProcArrayLock, LW_EXCLUSIVE);
			MyProc->vacuumFlags |= PROC_VACUUM_FOR_WRAPAROUND;
			LWLockRelease(ProcArrayLock);
		}

2106 2107
		/*
		 * Save the relation name for a possible error message, to avoid a
B
Bruce Momjian 已提交
2108
		 * catalog lookup in case of an error.	Note: they must live in a
2109 2110
		 * long-lived memory context because we call vacuum and analyze in
		 * different transactions.
2111 2112 2113 2114 2115
		 */
		datname = get_database_name(MyDatabaseId);
		nspname = get_namespace_name(get_rel_namespace(tab->at_relid));
		relname = get_rel_name(tab->at_relid);

2116
		/*
2117 2118 2119
		 * We will abort vacuuming the current table if something errors out,
		 * and continue with the next one in schedule; in particular, this
		 * happens if we are interrupted with SIGINT.
2120 2121 2122 2123
		 */
		PG_TRY();
		{
			/* have at it */
2124
			MemoryContextSwitchTo(TopTransactionContext);
2125 2126 2127 2128 2129
			autovacuum_do_vac_analyze(tab->at_relid,
									  tab->at_dovacuum,
									  tab->at_doanalyze,
									  tab->at_freeze_min_age,
									  bstrategy);
2130 2131 2132

			/*
			 * Clear a possible query-cancel signal, to avoid a late reaction
B
Bruce Momjian 已提交
2133 2134 2135
			 * to an automatically-sent signal because of vacuuming the
			 * current table (we're done with it, so it would make no sense to
			 * cancel at this point.)
2136 2137
			 */
			QueryCancelPending = false;
2138 2139 2140 2141
		}
		PG_CATCH();
		{
			/*
2142 2143
			 * Abort the transaction, start a new one, and proceed with the
			 * next table in our list.
2144
			 */
2145 2146 2147
			HOLD_INTERRUPTS();
			if (tab->at_dovacuum)
				errcontext("automatic vacuum of table \"%s.%s.%s\"",
2148
						   datname, nspname, relname);
2149
			else
2150
				errcontext("automatic analyze of table \"%s.%s.%s\"",
2151
						   datname, nspname, relname);
2152 2153
			EmitErrorReport();

2154
			/* this resets the PGPROC flags too */
2155 2156 2157 2158 2159 2160 2161
			AbortOutOfAnyTransaction();
			FlushErrorState();
			MemoryContextResetAndDeleteChildren(PortalContext);

			/* restart our transaction for the following operations */
			StartTransactionCommand();
			RESUME_INTERRUPTS();
2162 2163 2164
		}
		PG_END_TRY();

2165
		/* the PGPROC flags are reset at the next end of transaction */
2166

2167 2168
		/* be tidy */
		pfree(tab);
2169 2170 2171
		pfree(datname);
		pfree(nspname);
		pfree(relname);
2172 2173 2174 2175 2176

		/* remove my info from shared memory */
		LWLockAcquire(AutovacuumLock, LW_EXCLUSIVE);
		MyWorkerInfo->wi_tableoid = InvalidOid;
		LWLockRelease(AutovacuumLock);
2177
	}
2178

2179
	/*
B
Bruce Momjian 已提交
2180 2181
	 * Update pg_database.datfrozenxid, and truncate pg_clog if possible. We
	 * only need to do this once, not after each table.
2182 2183 2184
	 */
	vac_update_datfrozenxid();

2185 2186 2187 2188
	/* Finally close out the last transaction. */
	CommitTransactionCommand();
}

2189 2190 2191 2192 2193 2194 2195 2196 2197 2198 2199 2200 2201 2202 2203 2204 2205 2206 2207 2208 2209 2210 2211 2212 2213 2214 2215 2216 2217
/*
 * Returns a copy of the pg_autovacuum tuple for the given relid, or NULL if
 * there isn't any.  avRel is pg_autovacuum, already open and suitably locked.
 */
static HeapTuple
get_pg_autovacuum_tuple_relid(Relation avRel, Oid relid)
{
	ScanKeyData entry[1];
	SysScanDesc avScan;
	HeapTuple	avTup;

	ScanKeyInit(&entry[0],
				Anum_pg_autovacuum_vacrelid,
				BTEqualStrategyNumber, F_OIDEQ,
				ObjectIdGetDatum(relid));

	avScan = systable_beginscan(avRel, AutovacuumRelidIndexId, true,
								SnapshotNow, 1, entry);

	avTup = systable_getnext(avScan);

	if (HeapTupleIsValid(avTup))
		avTup = heap_copytuple(avTup);

	systable_endscan(avScan);

	return avTup;
}

2218 2219 2220 2221 2222 2223 2224 2225 2226 2227 2228 2229 2230 2231 2232 2233 2234 2235 2236 2237 2238 2239 2240 2241
/*
 * get_pgstat_tabentry_relid
 *
 * Fetch the pgstat entry of a table, either local to a database or shared.
 */
static PgStat_StatTabEntry *
get_pgstat_tabentry_relid(Oid relid, bool isshared, PgStat_StatDBEntry *shared,
						  PgStat_StatDBEntry *dbentry)
{
	PgStat_StatTabEntry *tabentry = NULL;

	if (isshared)
	{
		if (PointerIsValid(shared))
			tabentry = hash_search(shared->tables, &relid,
								   HASH_FIND, NULL);
	}
	else if (PointerIsValid(dbentry))
		tabentry = hash_search(dbentry->tables, &relid,
							   HASH_FIND, NULL);

	return tabentry;
}

2242
/*
2243
 * relation_check_autovac
2244
 *
2245 2246 2247 2248 2249 2250 2251 2252 2253 2254 2255 2256 2257
 * For a given relation (either a plain table or TOAST table), check whether it
 * needs vacuum or analyze.
 *
 * Plain tables that need either are added to the table_list.  TOAST tables
 * that need vacuum are added to toast_list.  Plain tables that don't need
 * either but which have a TOAST table are added, as a struct, to
 * table_toast_list.  The latter is to allow appending the OIDs of the plain
 * tables whose TOAST table needs vacuuming into the plain tables list, which
 * allows us to substantially reduce the number of "rechecks" that we need to
 * do later on.
 */
static void
relation_check_autovac(Oid relid, Form_pg_class classForm,
B
Bruce Momjian 已提交
2258
					Form_pg_autovacuum avForm, PgStat_StatTabEntry *tabentry,
2259 2260 2261
					   List **table_oids, List **table_toast_list,
					   List **toast_oids)
{
B
Bruce Momjian 已提交
2262 2263 2264
	bool		dovacuum;
	bool		doanalyze;
	bool		dummy;
2265 2266

	relation_needs_vacanalyze(relid, avForm, classForm, tabentry,
2267
							  &dovacuum, &doanalyze, &dummy);
2268 2269 2270 2271 2272 2273 2274 2275 2276 2277 2278 2279 2280 2281

	if (classForm->relkind == RELKIND_TOASTVALUE)
	{
		if (dovacuum)
			*toast_oids = lappend_oid(*toast_oids, relid);
	}
	else
	{
		Assert(classForm->relkind == RELKIND_RELATION);

		if (dovacuum || doanalyze)
			*table_oids = lappend_oid(*table_oids, relid);
		else if (OidIsValid(classForm->reltoastrelid))
		{
B
Bruce Momjian 已提交
2282
			av_relation *rel = palloc(sizeof(av_relation));
2283 2284 2285 2286 2287 2288 2289 2290 2291 2292 2293 2294 2295 2296 2297 2298 2299 2300 2301 2302 2303 2304 2305 2306 2307 2308 2309 2310 2311 2312 2313

			rel->ar_relid = relid;
			rel->ar_toastrelid = classForm->reltoastrelid;

			*table_toast_list = lappend(*table_toast_list, rel);
		}
	}
}

/*
 * table_recheck_autovac
 *
 * Recheck whether a plain table still needs vacuum or analyze; be it because
 * it does directly, or because its TOAST table does.  Return value is a valid
 * autovac_table pointer if it does, NULL otherwise.
 */
static autovac_table *
table_recheck_autovac(Oid relid)
{
	Form_pg_autovacuum avForm = NULL;
	Form_pg_class classForm;
	HeapTuple	classTup;
	HeapTuple	avTup;
	Relation	avRel;
	bool		dovacuum;
	bool		doanalyze;
	autovac_table *tab = NULL;
	PgStat_StatTabEntry *tabentry;
	bool		doit = false;
	PgStat_StatDBEntry *shared;
	PgStat_StatDBEntry *dbentry;
2314 2315
	bool		wraparound,
				toast_wraparound = false;
2316

2317
	/* use fresh stats */
2318
	autovac_refresh_stats();
2319 2320 2321 2322 2323 2324

	shared = pgstat_fetch_stat_dbentry(InvalidOid);
	dbentry = pgstat_fetch_stat_dbentry(MyDatabaseId);

	/* fetch the relation's relcache entry */
	classTup = SearchSysCacheCopy(RELOID,
2325 2326
								  ObjectIdGetDatum(relid),
								  0, 0, 0);
2327 2328 2329 2330 2331 2332 2333 2334 2335 2336 2337 2338 2339 2340 2341
	if (!HeapTupleIsValid(classTup))
		return NULL;
	classForm = (Form_pg_class) GETSTRUCT(classTup);

	/* fetch the pg_autovacuum entry, if any */
	avRel = heap_open(AutovacuumRelationId, AccessShareLock);
	avTup = get_pg_autovacuum_tuple_relid(avRel, relid);
	if (HeapTupleIsValid(avTup))
		avForm = (Form_pg_autovacuum) GETSTRUCT(avTup);

	/* fetch the pgstat table entry */
	tabentry = get_pgstat_tabentry_relid(relid, classForm->relisshared,
										 shared, dbentry);

	relation_needs_vacanalyze(relid, avForm, classForm, tabentry,
2342
							  &dovacuum, &doanalyze, &wraparound);
2343 2344 2345 2346 2347 2348 2349

	/* OK, it needs vacuum by itself */
	if (dovacuum)
		doit = true;
	/* it doesn't need vacuum, but what about it's TOAST table? */
	else if (OidIsValid(classForm->reltoastrelid))
	{
B
Bruce Momjian 已提交
2350
		Oid			toastrelid = classForm->reltoastrelid;
2351 2352 2353 2354 2355 2356 2357
		HeapTuple	toastClassTup;

		toastClassTup = SearchSysCacheCopy(RELOID,
										   ObjectIdGetDatum(toastrelid),
										   0, 0, 0);
		if (HeapTupleIsValid(toastClassTup))
		{
B
Bruce Momjian 已提交
2358 2359 2360 2361
			bool		toast_dovacuum;
			bool		toast_doanalyze;
			bool		toast_wraparound;
			Form_pg_class toastClassForm;
2362 2363 2364 2365
			PgStat_StatTabEntry *toasttabentry;

			toastClassForm = (Form_pg_class) GETSTRUCT(toastClassTup);
			toasttabentry = get_pgstat_tabentry_relid(toastrelid,
B
Bruce Momjian 已提交
2366
												 toastClassForm->relisshared,
2367 2368 2369
													  shared, dbentry);

			/* note we use the pg_autovacuum entry for the main table */
2370 2371 2372 2373
			relation_needs_vacanalyze(toastrelid, avForm,
									  toastClassForm, toasttabentry,
									  &toast_dovacuum, &toast_doanalyze,
									  &toast_wraparound);
2374 2375 2376 2377 2378 2379 2380 2381 2382 2383 2384 2385 2386 2387 2388 2389 2390 2391 2392 2393 2394
			/* we only consider VACUUM for toast tables */
			if (toast_dovacuum)
			{
				dovacuum = true;
				doit = true;
			}

			heap_freetuple(toastClassTup);
		}
	}

	if (doanalyze)
		doit = true;

	if (doit)
	{
		int			freeze_min_age;
		int			vac_cost_limit;
		int			vac_cost_delay;

		/*
2395 2396
		 * Calculate the vacuum cost parameters and the minimum freeze age. If
		 * there is a tuple in pg_autovacuum, use it; else, use the GUC
2397 2398
		 * defaults.  Note that the fields may contain "-1" (or indeed any
		 * negative value), which means use the GUC defaults for each setting.
2399 2400
		 * In cost_limit, the value 0 also means to use the value from
		 * elsewhere.
2401 2402 2403
		 */
		if (avForm != NULL)
		{
2404
			vac_cost_limit = (avForm->vac_cost_limit > 0) ?
2405
				avForm->vac_cost_limit :
2406
				((autovacuum_vac_cost_limit > 0) ?
2407 2408 2409 2410 2411 2412 2413 2414 2415 2416 2417 2418
				 autovacuum_vac_cost_limit : VacuumCostLimit);

			vac_cost_delay = (avForm->vac_cost_delay >= 0) ?
				avForm->vac_cost_delay :
				((autovacuum_vac_cost_delay >= 0) ?
				 autovacuum_vac_cost_delay : VacuumCostDelay);

			freeze_min_age = (avForm->freeze_min_age >= 0) ?
				avForm->freeze_min_age : default_freeze_min_age;
		}
		else
		{
2419
			vac_cost_limit = (autovacuum_vac_cost_limit > 0) ?
2420 2421 2422 2423 2424 2425 2426 2427 2428 2429 2430 2431 2432 2433 2434
				autovacuum_vac_cost_limit : VacuumCostLimit;

			vac_cost_delay = (autovacuum_vac_cost_delay >= 0) ?
				autovacuum_vac_cost_delay : VacuumCostDelay;

			freeze_min_age = default_freeze_min_age;
		}

		tab = palloc(sizeof(autovac_table));
		tab->at_relid = relid;
		tab->at_dovacuum = dovacuum;
		tab->at_doanalyze = doanalyze;
		tab->at_freeze_min_age = freeze_min_age;
		tab->at_vacuum_cost_limit = vac_cost_limit;
		tab->at_vacuum_cost_delay = vac_cost_delay;
2435
		tab->at_wraparound = wraparound || toast_wraparound;
2436 2437 2438 2439 2440 2441 2442 2443 2444 2445 2446 2447 2448 2449
	}

	heap_close(avRel, AccessShareLock);
	if (HeapTupleIsValid(avTup))
		heap_freetuple(avTup);
	heap_freetuple(classTup);

	return tab;
}

/*
 * relation_needs_vacanalyze
 *
 * Check whether a relation needs to be vacuumed or analyzed; return each into
2450
 * "dovacuum" and "doanalyze", respectively.  Also return whether the vacuum is
B
Bruce Momjian 已提交
2451
 * being forced because of Xid wraparound.	avForm and tabentry can be NULL,
2452
 * classForm shouldn't.
2453 2454 2455 2456 2457 2458 2459 2460 2461 2462 2463 2464
 *
 * A table needs to be vacuumed if the number of dead tuples exceeds a
 * threshold.  This threshold is calculated as
 *
 * threshold = vac_base_thresh + vac_scale_factor * reltuples
 *
 * For analyze, the analysis done is that the number of tuples inserted,
 * deleted and updated since the last analyze exceeds a threshold calculated
 * in the same fashion as above.  Note that the collector actually stores
 * the number of tuples (both live and dead) that there were as of the last
 * analyze.  This is asymmetric to the VACUUM case.
 *
2465 2466 2467
 * We also force vacuum if the table's relfrozenxid is more than freeze_max_age
 * transactions back.
 *
2468
 * A table whose pg_autovacuum.enabled value is false, is automatically
2469
 * skipped (unless we have to vacuum it due to freeze_max_age).  Thus
B
Bruce Momjian 已提交
2470
 * autovacuum can be disabled for specific tables.	Also, when the stats
2471
 * collector does not have data about a table, it will be skipped.
2472 2473 2474 2475 2476 2477 2478
 *
 * A table whose vac_base_thresh value is <0 takes the base value from the
 * autovacuum_vacuum_threshold GUC variable.  Similarly, a vac_scale_factor
 * value <0 is substituted with the value of
 * autovacuum_vacuum_scale_factor GUC variable.  Ditto for analyze.
 */
static void
2479 2480 2481 2482
relation_needs_vacanalyze(Oid relid,
						  Form_pg_autovacuum avForm,
						  Form_pg_class classForm,
						  PgStat_StatTabEntry *tabentry,
B
Bruce Momjian 已提交
2483
 /* output params below */
2484
						  bool *dovacuum,
2485 2486
						  bool *doanalyze,
						  bool *wraparound)
2487
{
2488
	bool		force_vacuum;
B
Bruce Momjian 已提交
2489
	float4		reltuples;		/* pg_class.reltuples */
B
Bruce Momjian 已提交
2490

2491
	/* constants from pg_autovacuum or GUC variables */
B
Bruce Momjian 已提交
2492 2493 2494 2495
	int			vac_base_thresh,
				anl_base_thresh;
	float4		vac_scale_factor,
				anl_scale_factor;
B
Bruce Momjian 已提交
2496

2497
	/* thresholds calculated from above constants */
B
Bruce Momjian 已提交
2498 2499
	float4		vacthresh,
				anlthresh;
B
Bruce Momjian 已提交
2500

2501
	/* number of vacuum (resp. analyze) tuples at this time */
B
Bruce Momjian 已提交
2502 2503
	float4		vactuples,
				anltuples;
B
Bruce Momjian 已提交
2504

2505 2506 2507
	/* freeze parameters */
	int			freeze_max_age;
	TransactionId xidForceLimit;
2508 2509 2510

	AssertArg(classForm != NULL);
	AssertArg(OidIsValid(relid));
2511 2512

	/*
2513
	 * Determine vacuum/analyze equation parameters.  If there is a tuple in
B
Bruce Momjian 已提交
2514 2515 2516
	 * pg_autovacuum, use it; else, use the GUC defaults.  Note that the
	 * fields may contain "-1" (or indeed any negative value), which means use
	 * the GUC defaults for each setting.
2517 2518 2519
	 */
	if (avForm != NULL)
	{
2520 2521 2522 2523 2524 2525 2526 2527 2528 2529
		vac_scale_factor = (avForm->vac_scale_factor >= 0) ?
			avForm->vac_scale_factor : autovacuum_vac_scale;
		vac_base_thresh = (avForm->vac_base_thresh >= 0) ?
			avForm->vac_base_thresh : autovacuum_vac_thresh;

		anl_scale_factor = (avForm->anl_scale_factor >= 0) ?
			avForm->anl_scale_factor : autovacuum_anl_scale;
		anl_base_thresh = (avForm->anl_base_thresh >= 0) ?
			avForm->anl_base_thresh : autovacuum_anl_thresh;

2530 2531 2532
		freeze_max_age = (avForm->freeze_max_age >= 0) ?
			Min(avForm->freeze_max_age, autovacuum_freeze_max_age) :
			autovacuum_freeze_max_age;
2533 2534 2535 2536 2537 2538 2539 2540
	}
	else
	{
		vac_scale_factor = autovacuum_vac_scale;
		vac_base_thresh = autovacuum_vac_thresh;

		anl_scale_factor = autovacuum_anl_scale;
		anl_base_thresh = autovacuum_anl_thresh;
2541

2542
		freeze_max_age = autovacuum_freeze_max_age;
2543 2544
	}

2545 2546 2547 2548 2549 2550 2551
	/* Force vacuum if table is at risk of wraparound */
	xidForceLimit = recentXid - freeze_max_age;
	if (xidForceLimit < FirstNormalTransactionId)
		xidForceLimit -= FirstNormalTransactionId;
	force_vacuum = (TransactionIdIsNormal(classForm->relfrozenxid) &&
					TransactionIdPrecedes(classForm->relfrozenxid,
										  xidForceLimit));
2552
	*wraparound = force_vacuum;
2553

2554 2555
	/* User disabled it in pg_autovacuum?  (But ignore if at risk) */
	if (avForm && !avForm->enabled && !force_vacuum)
2556 2557 2558
	{
		*doanalyze = false;
		*dovacuum = false;
2559
		return;
2560
	}
2561

2562 2563 2564 2565 2566 2567
	if (PointerIsValid(tabentry))
	{
		reltuples = classForm->reltuples;
		vactuples = tabentry->n_dead_tuples;
		anltuples = tabentry->n_live_tuples + tabentry->n_dead_tuples -
			tabentry->last_anl_tuples;
2568

2569 2570 2571 2572 2573 2574 2575 2576 2577 2578 2579 2580 2581
		vacthresh = (float4) vac_base_thresh + vac_scale_factor * reltuples;
		anlthresh = (float4) anl_base_thresh + anl_scale_factor * reltuples;

		/*
		 * Note that we don't need to take special consideration for stat
		 * reset, because if that happens, the last vacuum and analyze counts
		 * will be reset too.
		 */
		elog(DEBUG3, "%s: vac: %.0f (threshold %.0f), anl: %.0f (threshold %.0f)",
			 NameStr(classForm->relname),
			 vactuples, vacthresh, anltuples, anlthresh);

		/* Determine if this table needs vacuum or analyze. */
2582 2583
		*dovacuum = force_vacuum || (vactuples > vacthresh);
		*doanalyze = (anltuples > anlthresh);
2584 2585 2586 2587
	}
	else
	{
		/*
B
Bruce Momjian 已提交
2588 2589 2590
		 * Skip a table not found in stat hash, unless we have to force vacuum
		 * for anti-wrap purposes.	If it's not acted upon, there's no need to
		 * vacuum it.
2591
		 */
2592 2593
		*dovacuum = force_vacuum;
		*doanalyze = false;
2594
	}
2595 2596 2597

	/* ANALYZE refuses to work with pg_statistics */
	if (relid == StatisticRelationId)
2598
		*doanalyze = false;
2599 2600 2601 2602
}

/*
 * autovacuum_do_vac_analyze
2603
 *		Vacuum and/or analyze the specified table
2604 2605
 */
static void
2606
autovacuum_do_vac_analyze(Oid relid, bool dovacuum, bool doanalyze,
2607 2608
						  int freeze_min_age,
						  BufferAccessStrategy bstrategy)
2609
{
2610
	VacuumStmt	vacstmt;
B
Bruce Momjian 已提交
2611 2612
	MemoryContext old_cxt;

A
Alvaro Herrera 已提交
2613 2614
	MemSet(&vacstmt, 0, sizeof(vacstmt));

2615
	/*
2616
	 * The list must survive transaction boundaries, so make sure we create it
2617 2618 2619
	 * in a long-lived context
	 */
	old_cxt = MemoryContextSwitchTo(AutovacMemCxt);
B
Bruce Momjian 已提交
2620

2621
	/* Set up command parameters */
A
Alvaro Herrera 已提交
2622
	vacstmt.type = T_VacuumStmt;
2623 2624 2625 2626 2627 2628 2629
	vacstmt.vacuum = dovacuum;
	vacstmt.full = false;
	vacstmt.analyze = doanalyze;
	vacstmt.freeze_min_age = freeze_min_age;
	vacstmt.verbose = false;
	vacstmt.relation = NULL;	/* not used since we pass a relids list */
	vacstmt.va_cols = NIL;
2630

2631
	/* Let pgstat know what we're doing */
2632
	autovac_report_activity(&vacstmt, relid);
2633

2634
	vacuum(&vacstmt, list_make1_oid(relid), bstrategy, true);
2635
	MemoryContextSwitchTo(old_cxt);
2636 2637
}

2638 2639
/*
 * autovac_report_activity
B
Bruce Momjian 已提交
2640
 *		Report to pgstat what autovacuum is doing
2641 2642 2643 2644 2645
 *
 * We send a SQL string corresponding to what the user would see if the
 * equivalent command was to be issued manually.
 *
 * Note we assume that we are going to report the next command as soon as we're
2646
 * done with the current one, and exit right after the last one, so we don't
2647 2648 2649
 * bother to report "<IDLE>" or some such.
 */
static void
2650
autovac_report_activity(VacuumStmt *vacstmt, Oid relid)
2651
{
2652 2653
	char	   *relname = get_rel_name(relid);
	char	   *nspname = get_namespace_name(get_rel_namespace(relid));
B
Bruce Momjian 已提交
2654

2655
#define MAX_AUTOVAC_ACTIV_LEN (NAMEDATALEN * 2 + 32)
2656 2657 2658 2659 2660
	char		activity[MAX_AUTOVAC_ACTIV_LEN];

	/* Report the command and possible options */
	if (vacstmt->vacuum)
		snprintf(activity, MAX_AUTOVAC_ACTIV_LEN,
2661
				 "autovacuum: VACUUM%s",
2662
				 vacstmt->analyze ? " ANALYZE" : "");
2663
	else
2664
		snprintf(activity, MAX_AUTOVAC_ACTIV_LEN,
2665
				 "autovacuum: ANALYZE");
2666

2667 2668 2669
	/*
	 * Report the qualified name of the relation.
	 *
B
Bruce Momjian 已提交
2670 2671 2672
	 * Paranoia is appropriate here in case relation was recently dropped ---
	 * the lsyscache routines we just invoked will return NULL rather than
	 * failing.
2673 2674
	 */
	if (relname && nspname)
2675
	{
2676
		int			len = strlen(activity);
2677

2678 2679
		snprintf(activity + len, MAX_AUTOVAC_ACTIV_LEN - len,
				 " %s.%s", nspname, relname);
2680 2681
	}

2682 2683 2684
	/* Set statement_timestamp() to current time for pg_stat_activity */
	SetCurrentStatementStartTimestamp();

2685 2686 2687
	pgstat_report_activity(activity);
}

2688 2689
/*
 * AutoVacuumingActive
B
Bruce Momjian 已提交
2690 2691
 *		Check GUC vars and report whether the autovacuum process should be
 *		running.
2692 2693 2694 2695
 */
bool
AutoVacuumingActive(void)
{
2696
	if (!autovacuum_start_daemon || !pgstat_track_counts)
2697 2698 2699 2700 2701 2702
		return false;
	return true;
}

/*
 * autovac_init
B
Bruce Momjian 已提交
2703
 *		This is called at postmaster initialization.
2704
 *
2705
 * All we do here is annoy the user if he got it wrong.
2706 2707 2708 2709
 */
void
autovac_init(void)
{
2710
	if (autovacuum_start_daemon && !pgstat_track_counts)
2711 2712
		ereport(WARNING,
				(errmsg("autovacuum not started because of misconfiguration"),
2713
				 errhint("Enable the \"track_counts\" option.")));
2714 2715 2716
}

/*
2717 2718 2719
 * IsAutoVacuum functions
 *		Return whether this is either a launcher autovacuum process or a worker
 *		process.
2720 2721
 */
bool
2722 2723 2724 2725 2726 2727 2728
IsAutoVacuumLauncherProcess(void)
{
	return am_autovacuum_launcher;
}

bool
IsAutoVacuumWorkerProcess(void)
2729
{
2730 2731 2732 2733 2734 2735
	return am_autovacuum_worker;
}


/*
 * AutoVacuumShmemSize
B
Bruce Momjian 已提交
2736
 *		Compute space needed for autovacuum-related shared memory
2737 2738 2739 2740
 */
Size
AutoVacuumShmemSize(void)
{
B
Bruce Momjian 已提交
2741
	Size		size;
2742 2743 2744 2745 2746 2747 2748 2749 2750

	/*
	 * Need the fixed struct and the array of WorkerInfoData.
	 */
	size = sizeof(AutoVacuumShmemStruct);
	size = MAXALIGN(size);
	size = add_size(size, mul_size(autovacuum_max_workers,
								   sizeof(WorkerInfoData)));
	return size;
2751 2752 2753 2754 2755 2756 2757 2758 2759
}

/*
 * AutoVacuumShmemInit
 *		Allocate and initialize autovacuum-related shared memory
 */
void
AutoVacuumShmemInit(void)
{
B
Bruce Momjian 已提交
2760
	bool		found;
2761 2762 2763 2764 2765 2766 2767 2768 2769 2770

	AutoVacuumShmem = (AutoVacuumShmemStruct *)
		ShmemInitStruct("AutoVacuum Data",
						AutoVacuumShmemSize(),
						&found);
	if (AutoVacuumShmem == NULL)
		ereport(FATAL,
				(errcode(ERRCODE_OUT_OF_MEMORY),
				 errmsg("not enough shared memory for autovacuum")));

2771 2772 2773 2774 2775 2776 2777 2778 2779 2780 2781 2782 2783 2784 2785 2786 2787 2788 2789 2790 2791 2792 2793 2794
	if (!IsUnderPostmaster)
	{
		WorkerInfo	worker;
		int			i;

		Assert(!found);

		AutoVacuumShmem->av_launcherpid = 0;
		AutoVacuumShmem->av_freeWorkers = INVALID_OFFSET;
		SHMQueueInit(&AutoVacuumShmem->av_runningWorkers);
		AutoVacuumShmem->av_startingWorker = INVALID_OFFSET;

		worker = (WorkerInfo) ((char *) AutoVacuumShmem +
							   MAXALIGN(sizeof(AutoVacuumShmemStruct)));

		/* initialize the WorkerInfo free list */
		for (i = 0; i < autovacuum_max_workers; i++)
		{
			worker[i].wi_links.next = AutoVacuumShmem->av_freeWorkers;
			AutoVacuumShmem->av_freeWorkers = MAKE_OFFSET(&worker[i]);
		}
	}
	else
		Assert(found);
2795
}
2796 2797 2798

/*
 * autovac_refresh_stats
B
Bruce Momjian 已提交
2799
 *		Refresh pgstats data for an autovacuum process
2800 2801
 *
 * Cause the next pgstats read operation to obtain fresh data, but throttle
B
Bruce Momjian 已提交
2802
 * such refreshing in the autovacuum launcher.	This is mostly to avoid
2803 2804 2805 2806 2807 2808 2809 2810 2811 2812 2813
 * rereading the pgstats files too many times in quick succession when there
 * are many databases.
 *
 * Note: we avoid throttling in the autovac worker, as it would be
 * counterproductive in the recheck logic.
 */
static void
autovac_refresh_stats(void)
{
	if (IsAutoVacuumLauncherProcess())
	{
B
Bruce Momjian 已提交
2814 2815
		static TimestampTz last_read = 0;
		TimestampTz current_time;
2816 2817 2818 2819 2820 2821 2822 2823 2824 2825 2826 2827

		current_time = GetCurrentTimestamp();

		if (!TimestampDifferenceExceeds(last_read, current_time,
										STATS_READ_DELAY))
			return;

		last_read = current_time;
	}

	pgstat_clear_snapshot();
}