vacuumlazy.c 31.7 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12
/*-------------------------------------------------------------------------
 *
 * vacuumlazy.c
 *	  Concurrent ("lazy") vacuuming.
 *
 *
 * The major space usage for LAZY VACUUM is storage for the array of dead
 * tuple TIDs, with the next biggest need being storage for per-disk-page
 * free space info.  We want to ensure we can vacuum even the very largest
 * relations with finite memory space usage.  To do that, we set upper bounds
 * on the number of tuples and pages we will keep track of at once.
 *
13 14 15 16 17
 * We are willing to use at most maintenance_work_mem memory space to keep
 * track of dead tuples.  We initially allocate an array of TIDs of that size.
 * If the array threatens to overflow, we suspend the heap scan phase and
 * perform a pass of index cleanup and page compaction, then resume the heap
 * scan with an empty TID array.
18 19 20
 *
 * We can limit the storage for page free space to MaxFSMPages entries,
 * since that's the most the free space map will be willing to remember
21 22
 * anyway.	If the relation has fewer than that many pages with free space,
 * life is easy: just build an array of per-page info.	If it has more,
23 24 25 26 27 28
 * we store the free space info as a heap ordered by amount of free space,
 * so that we can discard the pages with least free space to ensure we never
 * have more than MaxFSMPages entries in all.  The surviving page entries
 * are passed to the free space map at conclusion of the scan.
 *
 *
B
Bruce Momjian 已提交
29
 * Portions Copyright (c) 1996-2004, PostgreSQL Global Development Group
30 31 32 33
 * Portions Copyright (c) 1994, Regents of the University of California
 *
 *
 * IDENTIFICATION
34
 *	  $PostgreSQL: pgsql/src/backend/commands/vacuumlazy.c,v 1.48 2004/10/25 15:42:02 tgl Exp $
35 36 37 38 39 40 41 42 43 44 45 46 47
 *
 *-------------------------------------------------------------------------
 */
#include "postgres.h"

#include "access/genam.h"
#include "access/heapam.h"
#include "access/xlog.h"
#include "commands/vacuum.h"
#include "miscadmin.h"
#include "storage/freespace.h"
#include "storage/sinval.h"
#include "storage/smgr.h"
48
#include "utils/lsyscache.h"
49 50 51 52 53 54


/*
 * Space/time tradeoff parameters: do these need to be user-tunable?
 *
 * To consider truncating the relation, we want there to be at least
55 56
 * REL_TRUNCATE_MINIMUM or (relsize / REL_TRUNCATE_FRACTION) (whichever
 * is less) potentially-freeable pages.
57
 */
58
#define REL_TRUNCATE_MINIMUM	1000
59 60 61 62 63 64 65 66 67
#define REL_TRUNCATE_FRACTION	16

/* MAX_TUPLES_PER_PAGE can be a conservative upper limit */
#define MAX_TUPLES_PER_PAGE		((int) (BLCKSZ / sizeof(HeapTupleHeaderData)))


typedef struct LVRelStats
{
	/* Overall statistics about rel */
68
	BlockNumber rel_pages;
69
	double		rel_tuples;
70
	BlockNumber nonempty_pages; /* actually, last nonempty page + 1 */
71
	Size		threshold;		/* minimum interesting free space */
72 73
	/* List of TIDs of tuples we intend to delete */
	/* NB: this list is ordered by TID address */
74 75
	int			num_dead_tuples;	/* current # of entries */
	int			max_dead_tuples;	/* # slots allocated in array */
76
	ItemPointer dead_tuples;	/* array of ItemPointerData */
77 78
	/* Array or heap of per-page info about free space */
	/* We use a simple array until it fills up, then convert to heap */
79 80
	bool		fs_is_heap;		/* are we using heap organization? */
	int			num_free_pages; /* current # of entries */
81
	int			max_free_pages; /* # slots allocated in array */
B
Bruce Momjian 已提交
82
	PageFreeSpaceInfo *free_pages;		/* array or heap of blkno/avail */
83 84 85
} LVRelStats;


B
Bruce Momjian 已提交
86
static int	elevel = -1;
87

88 89
static TransactionId OldestXmin;
static TransactionId FreezeLimit;
90 91 92 93


/* non-export function prototypes */
static void lazy_scan_heap(Relation onerel, LVRelStats *vacrelstats,
94
			   Relation *Irel, int nindexes);
95
static void lazy_vacuum_heap(Relation onerel, LVRelStats *vacrelstats);
96
static void lazy_scan_index(Relation indrel, LVRelStats *vacrelstats);
97
static void lazy_vacuum_index(Relation indrel, LVRelStats *vacrelstats);
98 99
static int lazy_vacuum_page(Relation onerel, BlockNumber blkno, Buffer buffer,
				 int tupindex, LVRelStats *vacrelstats);
100 101
static void lazy_truncate_heap(Relation onerel, LVRelStats *vacrelstats);
static BlockNumber count_nondeletable_pages(Relation onerel,
102
						 LVRelStats *vacrelstats);
103 104
static void lazy_space_alloc(LVRelStats *vacrelstats, BlockNumber relblocks);
static void lazy_record_dead_tuple(LVRelStats *vacrelstats,
105
					   ItemPointer itemptr);
106
static void lazy_record_free_space(LVRelStats *vacrelstats,
107
					   BlockNumber page, Size avail);
108
static bool lazy_tid_reaped(ItemPointer itemptr, void *state);
109
static bool dummy_tid_reaped(ItemPointer itemptr, void *state);
110 111
static void lazy_update_fsm(Relation onerel, LVRelStats *vacrelstats);
static int	vac_cmp_itemptr(const void *left, const void *right);
112
static int	vac_cmp_page_spaces(const void *left, const void *right);
113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130


/*
 *	lazy_vacuum_rel() -- perform LAZY VACUUM for one heap relation
 *
 *		This routine vacuums a single heap, cleans out its indexes, and
 *		updates its num_pages and num_tuples statistics.
 *
 *		At entry, we have already established a transaction and opened
 *		and locked the relation.
 */
void
lazy_vacuum_rel(Relation onerel, VacuumStmt *vacstmt)
{
	LVRelStats *vacrelstats;
	Relation   *Irel;
	int			nindexes;
	bool		hasindex;
131
	BlockNumber possibly_freeable;
132 133

	if (vacstmt->verbose)
134
		elevel = INFO;
135
	else
136
		elevel = DEBUG2;
B
Bruce Momjian 已提交
137

138 139
	vacuum_set_xid_limits(vacstmt, onerel->rd_rel->relisshared,
						  &OldestXmin, &FreezeLimit);
140

141
	vacrelstats = (LVRelStats *) palloc0(sizeof(LVRelStats));
142

143 144 145 146
	/* Set threshold for interesting free space = average request size */
	/* XXX should we scale it up or down?  Adjust vacuum.c too, if so */
	vacrelstats->threshold = GetAvgFSMRequestSize(&onerel->rd_node);

147
	/* Open all indexes of the relation */
148
	vac_open_indexes(onerel, ShareUpdateExclusiveLock, &nindexes, &Irel);
149 150 151 152 153 154
	hasindex = (nindexes > 0);

	/* Do the vacuuming */
	lazy_scan_heap(onerel, vacrelstats, Irel, nindexes);

	/* Done with indexes */
155
	vac_close_indexes(nindexes, Irel, NoLock);
156 157 158 159

	/*
	 * Optionally truncate the relation.
	 *
160 161
	 * Don't even think about it unless we have a shot at releasing a goodly
	 * number of pages.  Otherwise, the time taken isn't worth it.
162 163
	 */
	possibly_freeable = vacrelstats->rel_pages - vacrelstats->nonempty_pages;
164
	if (possibly_freeable >= REL_TRUNCATE_MINIMUM ||
B
Bruce Momjian 已提交
165
	 possibly_freeable >= vacrelstats->rel_pages / REL_TRUNCATE_FRACTION)
166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192
		lazy_truncate_heap(onerel, vacrelstats);

	/* Update shared free space map with final free space info */
	lazy_update_fsm(onerel, vacrelstats);

	/* Update statistics in pg_class */
	vac_update_relstats(RelationGetRelid(onerel), vacrelstats->rel_pages,
						vacrelstats->rel_tuples, hasindex);
}


/*
 *	lazy_scan_heap() -- scan an open heap relation
 *
 *		This routine sets commit status bits, builds lists of dead tuples
 *		and pages with free space, and calculates statistics on the number
 *		of live tuples in the heap.  When done, or when we run low on space
 *		for dead-tuple TIDs, invoke vacuuming of indexes and heap.
 */
static void
lazy_scan_heap(Relation onerel, LVRelStats *vacrelstats,
			   Relation *Irel, int nindexes)
{
	BlockNumber nblocks,
				blkno;
	HeapTupleData tuple;
	char	   *relname;
193
	BlockNumber empty_pages;
194 195 196 197 198 199 200 201 202 203
	double		num_tuples,
				tups_vacuumed,
				nkeep,
				nunused;
	int			i;
	VacRUsage	ru0;

	vac_init_rusage(&ru0);

	relname = RelationGetRelationName(onerel);
204 205 206 207
	ereport(elevel,
			(errmsg("vacuuming \"%s.%s\"",
					get_namespace_name(RelationGetNamespace(onerel)),
					relname)));
208

209
	empty_pages = 0;
210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228
	num_tuples = tups_vacuumed = nkeep = nunused = 0;

	nblocks = RelationGetNumberOfBlocks(onerel);
	vacrelstats->rel_pages = nblocks;
	vacrelstats->nonempty_pages = 0;

	lazy_space_alloc(vacrelstats, nblocks);

	for (blkno = 0; blkno < nblocks; blkno++)
	{
		Buffer		buf;
		Page		page;
		OffsetNumber offnum,
					maxoff;
		bool		pgchanged,
					tupgone,
					hastup;
		int			prev_dead_count;

229
		vacuum_delay_point();
J
Jan Wieck 已提交
230

231
		/*
232 233 234
		 * If we are close to overrunning the available space for
		 * dead-tuple TIDs, pause and do a cycle of vacuuming before we
		 * tackle this page.
235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261
		 */
		if ((vacrelstats->max_dead_tuples - vacrelstats->num_dead_tuples) < MAX_TUPLES_PER_PAGE &&
			vacrelstats->num_dead_tuples > 0)
		{
			/* Remove index entries */
			for (i = 0; i < nindexes; i++)
				lazy_vacuum_index(Irel[i], vacrelstats);
			/* Remove tuples from heap */
			lazy_vacuum_heap(onerel, vacrelstats);
			/* Forget the now-vacuumed tuples, and press on */
			vacrelstats->num_dead_tuples = 0;
		}

		buf = ReadBuffer(onerel, blkno);

		/* In this phase we only need shared access to the buffer */
		LockBuffer(buf, BUFFER_LOCK_SHARE);

		page = BufferGetPage(buf);

		if (PageIsNew(page))
		{
			/* Not sure we still need to handle this case, but... */
			LockBuffer(buf, BUFFER_LOCK_UNLOCK);
			LockBuffer(buf, BUFFER_LOCK_EXCLUSIVE);
			if (PageIsNew(page))
			{
262 263 264
				ereport(WARNING,
						(errmsg("relation \"%s\" page %u is uninitialized --- fixing",
								relname, blkno)));
265
				PageInit(page, BufferGetPageSize(buf), 0);
266
				empty_pages++;
267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309
				lazy_record_free_space(vacrelstats, blkno,
									   PageGetFreeSpace(page));
			}
			LockBuffer(buf, BUFFER_LOCK_UNLOCK);
			WriteBuffer(buf);
			continue;
		}

		if (PageIsEmpty(page))
		{
			empty_pages++;
			lazy_record_free_space(vacrelstats, blkno,
								   PageGetFreeSpace(page));
			LockBuffer(buf, BUFFER_LOCK_UNLOCK);
			ReleaseBuffer(buf);
			continue;
		}

		pgchanged = false;
		hastup = false;
		prev_dead_count = vacrelstats->num_dead_tuples;
		maxoff = PageGetMaxOffsetNumber(page);
		for (offnum = FirstOffsetNumber;
			 offnum <= maxoff;
			 offnum = OffsetNumberNext(offnum))
		{
			ItemId		itemid;

			itemid = PageGetItemId(page, offnum);

			if (!ItemIdIsUsed(itemid))
			{
				nunused += 1;
				continue;
			}

			tuple.t_datamcxt = NULL;
			tuple.t_data = (HeapTupleHeader) PageGetItem(page, itemid);
			tuple.t_len = ItemIdGetLength(itemid);
			ItemPointerSet(&(tuple.t_self), blkno, offnum);

			tupgone = false;

310
			switch (HeapTupleSatisfiesVacuum(tuple.t_data, OldestXmin, buf))
311 312
			{
				case HEAPTUPLE_DEAD:
313
					tupgone = true;		/* we can delete the tuple */
314 315
					break;
				case HEAPTUPLE_LIVE:
316

317
					/*
318 319
					 * Tuple is good.  Consider whether to replace its
					 * xmin value with FrozenTransactionId.
T
Tom Lane 已提交
320
					 *
321 322 323 324
					 * NB: Since we hold only a shared buffer lock here, we
					 * are assuming that TransactionId read/write is
					 * atomic.	This is not the only place that makes such
					 * an assumption.  It'd be possible to avoid the
T
Tom Lane 已提交
325 326
					 * assumption by momentarily acquiring exclusive lock,
					 * but for the moment I see no need to.
327
					 */
328 329
					if (TransactionIdIsNormal(HeapTupleHeaderGetXmin(tuple.t_data)) &&
						TransactionIdPrecedes(HeapTupleHeaderGetXmin(tuple.t_data),
330 331
											  FreezeLimit))
					{
332
						HeapTupleHeaderSetXmin(tuple.t_data, FrozenTransactionId);
T
Tom Lane 已提交
333 334
						/* infomask should be okay already */
						Assert(tuple.t_data->t_infomask & HEAP_XMIN_COMMITTED);
335 336
						pgchanged = true;
					}
337 338 339 340 341 342 343 344

					/*
					 * Other checks...
					 */
					if (onerel->rd_rel->relhasoids &&
						!OidIsValid(HeapTupleGetOid(&tuple)))
						elog(WARNING, "relation \"%s\" TID %u/%u: OID is invalid",
							 relname, blkno, offnum);
345 346
					break;
				case HEAPTUPLE_RECENTLY_DEAD:
347

348
					/*
349 350
					 * If tuple is recently deleted then we must not
					 * remove it from relation.
351 352 353 354 355 356 357 358 359 360
					 */
					nkeep += 1;
					break;
				case HEAPTUPLE_INSERT_IN_PROGRESS:
					/* This is an expected case during concurrent vacuum */
					break;
				case HEAPTUPLE_DELETE_IN_PROGRESS:
					/* This is an expected case during concurrent vacuum */
					break;
				default:
361
					elog(ERROR, "unexpected HeapTupleSatisfiesVacuum result");
362 363 364 365 366 367 368 369 370 371 372 373 374
					break;
			}

			if (tupgone)
			{
				lazy_record_dead_tuple(vacrelstats, &(tuple.t_self));
				tups_vacuumed += 1;
			}
			else
			{
				num_tuples += 1;
				hastup = true;
			}
375
		}						/* scan along page */
376 377

		/*
378 379
		 * If we remembered any tuples for deletion, then the page will be
		 * visited again by lazy_vacuum_heap, which will compute and
380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395
		 * record its post-compaction free space.  If not, then we're done
		 * with this page, so remember its free space as-is.
		 */
		if (vacrelstats->num_dead_tuples == prev_dead_count)
		{
			lazy_record_free_space(vacrelstats, blkno,
								   PageGetFreeSpace(page));
		}

		/* Remember the location of the last page with nonremovable tuples */
		if (hastup)
			vacrelstats->nonempty_pages = blkno + 1;

		LockBuffer(buf, BUFFER_LOCK_UNLOCK);

		if (pgchanged)
396 397 398
			WriteBuffer(buf);
		else
			ReleaseBuffer(buf);
399 400
	}

401 402 403
	/* save stats for use later */
	vacrelstats->rel_tuples = num_tuples;

404
	/* If any tuples need to be deleted, perform final vacuum cycle */
405
	/* XXX put a threshold on min number of tuples here? */
406 407 408 409 410 411 412 413
	if (vacrelstats->num_dead_tuples > 0)
	{
		/* Remove index entries */
		for (i = 0; i < nindexes; i++)
			lazy_vacuum_index(Irel[i], vacrelstats);
		/* Remove tuples from heap */
		lazy_vacuum_heap(onerel, vacrelstats);
	}
414
	else
415
	{
416
		/* Must do post-vacuum cleanup and statistics update anyway */
417 418 419
		for (i = 0; i < nindexes; i++)
			lazy_scan_index(Irel[i], vacrelstats);
	}
420

421
	ereport(elevel,
422
			(errmsg("\"%s\": found %.0f removable, %.0f nonremovable row versions in %u pages",
423 424
					RelationGetRelationName(onerel),
					tups_vacuumed, num_tuples, nblocks),
425
			 errdetail("%.0f dead row versions cannot be removed yet.\n"
426 427 428 429 430 431 432
					   "There were %.0f unused item pointers.\n"
					   "%u pages are entirely empty.\n"
					   "%s",
					   nkeep,
					   nunused,
					   empty_pages,
					   vac_show_rusage(&ru0))));
433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459
}


/*
 *	lazy_vacuum_heap() -- second pass over the heap
 *
 *		This routine marks dead tuples as unused and compacts out free
 *		space on their pages.  Pages not having dead tuples recorded from
 *		lazy_scan_heap are not visited at all.
 *
 * Note: the reason for doing this as a second pass is we cannot remove
 * the tuples until we've removed their index entries, and we want to
 * process index entry removal in batches as large as possible.
 */
static void
lazy_vacuum_heap(Relation onerel, LVRelStats *vacrelstats)
{
	int			tupindex;
	int			npages;
	VacRUsage	ru0;

	vac_init_rusage(&ru0);
	npages = 0;

	tupindex = 0;
	while (tupindex < vacrelstats->num_dead_tuples)
	{
460
		BlockNumber tblk;
461 462 463
		Buffer		buf;
		Page		page;

464
		vacuum_delay_point();
J
Jan Wieck 已提交
465

466 467 468 469 470 471 472 473 474 475 476 477 478
		tblk = ItemPointerGetBlockNumber(&vacrelstats->dead_tuples[tupindex]);
		buf = ReadBuffer(onerel, tblk);
		LockBufferForCleanup(buf);
		tupindex = lazy_vacuum_page(onerel, tblk, buf, tupindex, vacrelstats);
		/* Now that we've compacted the page, record its available space */
		page = BufferGetPage(buf);
		lazy_record_free_space(vacrelstats, tblk,
							   PageGetFreeSpace(page));
		LockBuffer(buf, BUFFER_LOCK_UNLOCK);
		WriteBuffer(buf);
		npages++;
	}

479
	ereport(elevel,
480
			(errmsg("\"%s\": removed %d row versions in %d pages",
481 482 483 484
					RelationGetRelationName(onerel),
					tupindex, npages),
			 errdetail("%s",
					   vac_show_rusage(&ru0))));
485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500
}

/*
 *	lazy_vacuum_page() -- free dead tuples on a page
 *					 and repair its fragmentation.
 *
 * Caller is expected to handle reading, locking, and writing the buffer.
 *
 * tupindex is the index in vacrelstats->dead_tuples of the first dead
 * tuple for this page.  We assume the rest follow sequentially.
 * The return value is the first tupindex after the tuples of this page.
 */
static int
lazy_vacuum_page(Relation onerel, BlockNumber blkno, Buffer buffer,
				 int tupindex, LVRelStats *vacrelstats)
{
501
	OffsetNumber unused[BLCKSZ / sizeof(OffsetNumber)];
502 503 504 505 506 507 508
	int			uncnt;
	Page		page = BufferGetPage(buffer);
	ItemId		itemid;

	START_CRIT_SECTION();
	for (; tupindex < vacrelstats->num_dead_tuples; tupindex++)
	{
509 510
		BlockNumber tblk;
		OffsetNumber toff;
511 512 513 514 515 516 517 518 519 520 521

		tblk = ItemPointerGetBlockNumber(&vacrelstats->dead_tuples[tupindex]);
		if (tblk != blkno)
			break;				/* past end of tuples for this block */
		toff = ItemPointerGetOffsetNumber(&vacrelstats->dead_tuples[tupindex]);
		itemid = PageGetItemId(page, toff);
		itemid->lp_flags &= ~LP_USED;
	}

	uncnt = PageRepairFragmentation(page, unused);

522 523
	/* XLOG stuff */
	if (!onerel->rd_istemp)
524 525 526
	{
		XLogRecPtr	recptr;

527
		recptr = log_heap_clean(onerel, buffer, unused, uncnt);
528
		PageSetLSN(page, recptr);
529
		PageSetTLI(page, ThisTimeLineID);
530
	}
531 532 533 534 535 536
	else
	{
		/* No XLOG record, but still need to flag that XID exists on disk */
		MyXactMadeTempRelUpdate = true;
	}

537 538 539 540 541
	END_CRIT_SECTION();

	return tupindex;
}

542 543 544 545 546 547 548 549 550
/*
 *	lazy_scan_index() -- scan one index relation to update pg_class statistic.
 *
 * We use this when we have no deletions to do.
 */
static void
lazy_scan_index(Relation indrel, LVRelStats *vacrelstats)
{
	IndexBulkDeleteResult *stats;
551
	IndexVacuumCleanupInfo vcinfo;
552 553 554 555 556
	VacRUsage	ru0;

	vac_init_rusage(&ru0);

	/*
557 558
	 * Acquire appropriate type of lock on index: must be exclusive if
	 * index AM isn't concurrent-safe.
559
	 */
560 561 562
	if (indrel->rd_am->amconcurrent)
		LockRelation(indrel, RowExclusiveLock);
	else
563
		LockRelation(indrel, AccessExclusiveLock);
564 565

	/*
566 567 568 569
	 * Even though we're not planning to delete anything, we use the
	 * ambulkdelete call, because (a) the scan happens within the index AM
	 * for more speed, and (b) it may want to pass private statistics to
	 * the amvacuumcleanup call.
570 571 572
	 */
	stats = index_bulk_delete(indrel, dummy_tid_reaped, NULL);

573 574 575 576 577 578
	/* Do post-VACUUM cleanup, even though we deleted nothing */
	vcinfo.vacuum_full = false;
	vcinfo.message_level = elevel;

	stats = index_vacuum_cleanup(indrel, &vcinfo, stats);

579 580 581
	/*
	 * Release lock acquired above.
	 */
582 583 584
	if (indrel->rd_am->amconcurrent)
		UnlockRelation(indrel, RowExclusiveLock);
	else
585
		UnlockRelation(indrel, AccessExclusiveLock);
586 587 588 589 590 591 592 593 594

	if (!stats)
		return;

	/* now update statistics in pg_class */
	vac_update_relstats(RelationGetRelid(indrel),
						stats->num_pages, stats->num_index_tuples,
						false);

595
	ereport(elevel,
B
Bruce Momjian 已提交
596 597 598 599 600 601 602 603
	   (errmsg("index \"%s\" now contains %.0f row versions in %u pages",
			   RelationGetRelationName(indrel),
			   stats->num_index_tuples,
			   stats->num_pages),
		errdetail("%u index pages have been deleted, %u are currently reusable.\n"
				  "%s",
				  stats->pages_deleted, stats->pages_free,
				  vac_show_rusage(&ru0))));
604 605 606 607

	pfree(stats);
}

608 609 610 611 612 613 614 615 616 617 618 619
/*
 *	lazy_vacuum_index() -- vacuum one index relation.
 *
 *		Delete all the index entries pointing to tuples listed in
 *		vacrelstats->dead_tuples.
 *
 *		Finally, we arrange to update the index relation's statistics in
 *		pg_class.
 */
static void
lazy_vacuum_index(Relation indrel, LVRelStats *vacrelstats)
{
620
	IndexBulkDeleteResult *stats;
621
	IndexVacuumCleanupInfo vcinfo;
622 623 624 625 626
	VacRUsage	ru0;

	vac_init_rusage(&ru0);

	/*
627 628
	 * Acquire appropriate type of lock on index: must be exclusive if
	 * index AM isn't concurrent-safe.
629
	 */
630 631 632
	if (indrel->rd_am->amconcurrent)
		LockRelation(indrel, RowExclusiveLock);
	else
633 634
		LockRelation(indrel, AccessExclusiveLock);

635 636
	/* Do bulk deletion */
	stats = index_bulk_delete(indrel, lazy_tid_reaped, (void *) vacrelstats);
637

638 639 640 641 642 643
	/* Do post-VACUUM cleanup */
	vcinfo.vacuum_full = false;
	vcinfo.message_level = elevel;

	stats = index_vacuum_cleanup(indrel, &vcinfo, stats);

644 645 646
	/*
	 * Release lock acquired above.
	 */
647 648 649
	if (indrel->rd_am->amconcurrent)
		UnlockRelation(indrel, RowExclusiveLock);
	else
650 651
		UnlockRelation(indrel, AccessExclusiveLock);

652 653 654
	if (!stats)
		return;

655
	/* now update statistics in pg_class */
656 657 658
	vac_update_relstats(RelationGetRelid(indrel),
						stats->num_pages, stats->num_index_tuples,
						false);
659

660
	ereport(elevel,
B
Bruce Momjian 已提交
661 662 663 664 665
	   (errmsg("index \"%s\" now contains %.0f row versions in %u pages",
			   RelationGetRelationName(indrel),
			   stats->num_index_tuples,
			   stats->num_pages),
		errdetail("%.0f index row versions were removed.\n"
B
Bruce Momjian 已提交
666
		 "%u index pages have been deleted, %u are currently reusable.\n"
B
Bruce Momjian 已提交
667 668 669 670
				  "%s",
				  stats->tuples_removed,
				  stats->pages_deleted, stats->pages_free,
				  vac_show_rusage(&ru0))));
671

672
	pfree(stats);
673 674 675 676 677 678 679 680
}

/*
 * lazy_truncate_heap - try to truncate off any empty pages at the end
 */
static void
lazy_truncate_heap(Relation onerel, LVRelStats *vacrelstats)
{
681 682
	BlockNumber old_rel_pages = vacrelstats->rel_pages;
	BlockNumber new_rel_pages;
683
	PageFreeSpaceInfo *pageSpaces;
684 685 686 687 688 689 690 691
	int			n;
	int			i,
				j;
	VacRUsage	ru0;

	vac_init_rusage(&ru0);

	/*
692 693 694 695 696
	 * We need full exclusive lock on the relation in order to do
	 * truncation. If we can't get it, give up rather than waiting --- we
	 * don't want to block other backends, and we don't want to deadlock
	 * (which is quite possible considering we already hold a lower-grade
	 * lock).
697
	 */
698
	if (!ConditionalLockRelation(onerel, AccessExclusiveLock))
699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716
		return;

	/*
	 * Now that we have exclusive lock, look to see if the rel has grown
	 * whilst we were vacuuming with non-exclusive lock.  If so, give up;
	 * the newly added pages presumably contain non-deletable tuples.
	 */
	new_rel_pages = RelationGetNumberOfBlocks(onerel);
	if (new_rel_pages != old_rel_pages)
	{
		/* might as well use the latest news when we update pg_class stats */
		vacrelstats->rel_pages = new_rel_pages;
		UnlockRelation(onerel, AccessExclusiveLock);
		return;
	}

	/*
	 * Scan backwards from the end to verify that the end pages actually
717 718 719
	 * contain nothing we need to keep.  This is *necessary*, not
	 * optional, because other backends could have added tuples to these
	 * pages whilst we were vacuuming.
720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737
	 */
	new_rel_pages = count_nondeletable_pages(onerel, vacrelstats);

	if (new_rel_pages >= old_rel_pages)
	{
		/* can't do anything after all */
		UnlockRelation(onerel, AccessExclusiveLock);
		return;
	}

	/*
	 * Okay to truncate.
	 *
	 * First, flush any shared buffers for the blocks we intend to delete.
	 * FlushRelationBuffers is a bit more than we need for this, since it
	 * will also write out dirty buffers for blocks we aren't deleting,
	 * but it's the closest thing in bufmgr's API.
	 */
738
	FlushRelationBuffers(onerel, new_rel_pages);
739 740 741 742

	/*
	 * Do the physical truncation.
	 */
743
	RelationTruncate(onerel, new_rel_pages);
744 745
	vacrelstats->rel_pages = new_rel_pages;		/* save new number of
												 * blocks */
746 747 748 749 750

	/*
	 * Drop free-space info for removed blocks; these must not get entered
	 * into the FSM!
	 */
751
	pageSpaces = vacrelstats->free_pages;
752 753 754 755
	n = vacrelstats->num_free_pages;
	j = 0;
	for (i = 0; i < n; i++)
	{
756
		if (pageSpaces[i].blkno < new_rel_pages)
757
		{
758
			pageSpaces[j] = pageSpaces[i];
759 760 761 762
			j++;
		}
	}
	vacrelstats->num_free_pages = j;
763 764
	/* We destroyed the heap ordering, so mark array unordered */
	vacrelstats->fs_is_heap = false;
765 766 767 768 769

	/*
	 * We keep the exclusive lock until commit (perhaps not necessary)?
	 */

770 771 772 773 774 775
	ereport(elevel,
			(errmsg("\"%s\": truncated %u to %u pages",
					RelationGetRelationName(onerel),
					old_rel_pages, new_rel_pages),
			 errdetail("%s",
					   vac_show_rusage(&ru0))));
776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796
}

/*
 * Rescan end pages to verify that they are (still) empty of needed tuples.
 *
 * Returns number of nondeletable pages (last nonempty page + 1).
 */
static BlockNumber
count_nondeletable_pages(Relation onerel, LVRelStats *vacrelstats)
{
	BlockNumber blkno;
	HeapTupleData tuple;

	/* Strange coding of loop control is needed because blkno is unsigned */
	blkno = vacrelstats->rel_pages;
	while (blkno > vacrelstats->nonempty_pages)
	{
		Buffer		buf;
		Page		page;
		OffsetNumber offnum,
					maxoff;
797
		bool		tupgone,
798 799
					hastup;

800
		vacuum_delay_point();
J
Jan Wieck 已提交
801

802 803 804 805 806 807 808 809 810 811 812
		blkno--;

		buf = ReadBuffer(onerel, blkno);

		/* In this phase we only need shared access to the buffer */
		LockBuffer(buf, BUFFER_LOCK_SHARE);

		page = BufferGetPage(buf);

		if (PageIsNew(page) || PageIsEmpty(page))
		{
813
			/* PageIsNew probably shouldn't happen... */
814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838
			LockBuffer(buf, BUFFER_LOCK_UNLOCK);
			ReleaseBuffer(buf);
			continue;
		}

		hastup = false;
		maxoff = PageGetMaxOffsetNumber(page);
		for (offnum = FirstOffsetNumber;
			 offnum <= maxoff;
			 offnum = OffsetNumberNext(offnum))
		{
			ItemId		itemid;

			itemid = PageGetItemId(page, offnum);

			if (!ItemIdIsUsed(itemid))
				continue;

			tuple.t_datamcxt = NULL;
			tuple.t_data = (HeapTupleHeader) PageGetItem(page, itemid);
			tuple.t_len = ItemIdGetLength(itemid);
			ItemPointerSet(&(tuple.t_self), blkno, offnum);

			tupgone = false;

839
			switch (HeapTupleSatisfiesVacuum(tuple.t_data, OldestXmin, buf))
840 841
			{
				case HEAPTUPLE_DEAD:
842
					tupgone = true;		/* we can delete the tuple */
843 844
					break;
				case HEAPTUPLE_LIVE:
845
					/* Shouldn't be necessary to re-freeze anything */
846 847
					break;
				case HEAPTUPLE_RECENTLY_DEAD:
848

849
					/*
850 851
					 * If tuple is recently deleted then we must not
					 * remove it from relation.
852 853 854 855 856 857 858 859 860
					 */
					break;
				case HEAPTUPLE_INSERT_IN_PROGRESS:
					/* This is an expected case during concurrent vacuum */
					break;
				case HEAPTUPLE_DELETE_IN_PROGRESS:
					/* This is an expected case during concurrent vacuum */
					break;
				default:
861
					elog(ERROR, "unexpected HeapTupleSatisfiesVacuum result");
862 863 864 865 866 867 868 869
					break;
			}

			if (!tupgone)
			{
				hastup = true;
				break;			/* can stop scanning */
			}
870
		}						/* scan along page */
871 872 873

		LockBuffer(buf, BUFFER_LOCK_UNLOCK);

874
		ReleaseBuffer(buf);
875 876 877 878 879 880 881 882

		/* Done scanning if we found a tuple here */
		if (hastup)
			return blkno + 1;
	}

	/*
	 * If we fall out of the loop, all the previously-thought-to-be-empty
883 884
	 * pages really are; we need not bother to look at the last
	 * known-nonempty page.
885 886 887 888 889 890 891 892 893 894 895 896 897 898 899
	 */
	return vacrelstats->nonempty_pages;
}

/*
 * lazy_space_alloc - space allocation decisions for lazy vacuum
 *
 * See the comments at the head of this file for rationale.
 */
static void
lazy_space_alloc(LVRelStats *vacrelstats, BlockNumber relblocks)
{
	int			maxtuples;
	int			maxpages;

900 901
	maxtuples = (int) ((maintenance_work_mem * 1024L) / sizeof(ItemPointerData));
	/* stay sane if small maintenance_work_mem */
902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917
	if (maxtuples < MAX_TUPLES_PER_PAGE)
		maxtuples = MAX_TUPLES_PER_PAGE;

	vacrelstats->num_dead_tuples = 0;
	vacrelstats->max_dead_tuples = maxtuples;
	vacrelstats->dead_tuples = (ItemPointer)
		palloc(maxtuples * sizeof(ItemPointerData));

	maxpages = MaxFSMPages;
	/* No need to allocate more pages than the relation has blocks */
	if (relblocks < (BlockNumber) maxpages)
		maxpages = (int) relblocks;

	vacrelstats->fs_is_heap = false;
	vacrelstats->num_free_pages = 0;
	vacrelstats->max_free_pages = maxpages;
918 919
	vacrelstats->free_pages = (PageFreeSpaceInfo *)
		palloc(maxpages * sizeof(PageFreeSpaceInfo));
920 921 922 923 924 925 926 927 928 929
}

/*
 * lazy_record_dead_tuple - remember one deletable tuple
 */
static void
lazy_record_dead_tuple(LVRelStats *vacrelstats,
					   ItemPointer itemptr)
{
	/*
930
	 * The array shouldn't overflow under normal behavior, but perhaps it
931 932
	 * could if we are given a really small maintenance_work_mem. In that
	 * case, just forget the last few tuples.
933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948
	 */
	if (vacrelstats->num_dead_tuples < vacrelstats->max_dead_tuples)
	{
		vacrelstats->dead_tuples[vacrelstats->num_dead_tuples] = *itemptr;
		vacrelstats->num_dead_tuples++;
	}
}

/*
 * lazy_record_free_space - remember free space on one page
 */
static void
lazy_record_free_space(LVRelStats *vacrelstats,
					   BlockNumber page,
					   Size avail)
{
949
	PageFreeSpaceInfo *pageSpaces;
950 951
	int			n;

952 953 954
	/*
	 * A page with less than stats->threshold free space will be forgotten
	 * immediately, and never passed to the free space map.  Removing the
B
Bruce Momjian 已提交
955 956 957 958 959
	 * uselessly small entries early saves cycles, and in particular
	 * reduces the amount of time we spend holding the FSM lock when we
	 * finally call RecordRelationFreeSpace.  Since the FSM will probably
	 * drop pages with little free space anyway, there's no point in
	 * making this really small.
960
	 *
B
Bruce Momjian 已提交
961 962 963 964 965 966
	 * XXX Is it worth trying to measure average tuple size, and using that
	 * to adjust the threshold?  Would be worthwhile if FSM has no stats
	 * yet for this relation.  But changing the threshold as we scan the
	 * rel might lead to bizarre behavior, too.  Also, it's probably
	 * better if vacuum.c has the same thresholding behavior as we do
	 * here.
967 968
	 */
	if (avail < vacrelstats->threshold)
969 970 971
		return;

	/* Copy pointers to local variables for notational simplicity */
972
	pageSpaces = vacrelstats->free_pages;
973 974 975 976 977
	n = vacrelstats->max_free_pages;

	/* If we haven't filled the array yet, just keep adding entries */
	if (vacrelstats->num_free_pages < n)
	{
978 979
		pageSpaces[vacrelstats->num_free_pages].blkno = page;
		pageSpaces[vacrelstats->num_free_pages].avail = avail;
980 981 982 983 984 985 986
		vacrelstats->num_free_pages++;
		return;
	}

	/*----------
	 * The rest of this routine works with "heap" organization of the
	 * free space arrays, wherein we maintain the heap property
B
Bruce Momjian 已提交
987
	 *			avail[(j-1) div 2] <= avail[j]	for 0 < j < n.
988 989 990 991 992 993 994 995
	 * In particular, the zero'th element always has the smallest available
	 * space and can be discarded to make room for a new page with more space.
	 * See Knuth's discussion of heap-based priority queues, sec 5.2.3;
	 * but note he uses 1-origin array subscripts, not 0-origin.
	 *----------
	 */

	/* If we haven't yet converted the array to heap organization, do it */
996
	if (!vacrelstats->fs_is_heap)
997 998 999
	{
		/*
		 * Scan backwards through the array, "sift-up" each value into its
1000 1001
		 * correct position.  We can start the scan at n/2-1 since each
		 * entry above that position has no children to worry about.
1002
		 */
1003
		int			l = n / 2;
1004 1005 1006

		while (--l >= 0)
		{
1007 1008
			BlockNumber R = pageSpaces[l].blkno;
			Size		K = pageSpaces[l].avail;
1009 1010 1011 1012 1013
			int			i;		/* i is where the "hole" is */

			i = l;
			for (;;)
			{
1014
				int			j = 2 * i + 1;
1015 1016 1017

				if (j >= n)
					break;
1018
				if (j + 1 < n && pageSpaces[j].avail > pageSpaces[j + 1].avail)
1019
					j++;
1020
				if (K <= pageSpaces[j].avail)
1021
					break;
1022
				pageSpaces[i] = pageSpaces[j];
1023 1024
				i = j;
			}
1025 1026
			pageSpaces[i].blkno = R;
			pageSpaces[i].avail = K;
1027 1028 1029 1030 1031 1032
		}

		vacrelstats->fs_is_heap = true;
	}

	/* If new page has more than zero'th entry, insert it into heap */
1033
	if (avail > pageSpaces[0].avail)
1034 1035
	{
		/*
1036 1037 1038 1039
		 * Notionally, we replace the zero'th entry with the new data, and
		 * then sift-up to maintain the heap property.	Physically, the
		 * new data doesn't get stored into the arrays until we find the
		 * right location for it.
1040
		 */
1041
		int			i = 0;		/* i is where the "hole" is */
1042 1043 1044

		for (;;)
		{
1045
			int			j = 2 * i + 1;
1046 1047 1048

			if (j >= n)
				break;
1049
			if (j + 1 < n && pageSpaces[j].avail > pageSpaces[j + 1].avail)
1050
				j++;
1051
			if (avail <= pageSpaces[j].avail)
1052
				break;
1053
			pageSpaces[i] = pageSpaces[j];
1054 1055
			i = j;
		}
1056 1057
		pageSpaces[i].blkno = page;
		pageSpaces[i].avail = avail;
1058 1059 1060 1061 1062 1063
	}
}

/*
 *	lazy_tid_reaped() -- is a particular tid deletable?
 *
1064 1065
 *		This has the right signature to be an IndexBulkDeleteCallback.
 *
1066 1067 1068
 *		Assumes dead_tuples array is in sorted order.
 */
static bool
1069
lazy_tid_reaped(ItemPointer itemptr, void *state)
1070
{
1071
	LVRelStats *vacrelstats = (LVRelStats *) state;
1072
	ItemPointer res;
1073 1074 1075 1076 1077 1078 1079 1080 1081 1082

	res = (ItemPointer) bsearch((void *) itemptr,
								(void *) vacrelstats->dead_tuples,
								vacrelstats->num_dead_tuples,
								sizeof(ItemPointerData),
								vac_cmp_itemptr);

	return (res != NULL);
}

1083 1084 1085 1086 1087 1088 1089 1090 1091
/*
 * Dummy version for lazy_scan_index.
 */
static bool
dummy_tid_reaped(ItemPointer itemptr, void *state)
{
	return false;
}

1092 1093 1094 1095 1096 1097 1098
/*
 * Update the shared Free Space Map with the info we now have about
 * free space in the relation, discarding any old info the map may have.
 */
static void
lazy_update_fsm(Relation onerel, LVRelStats *vacrelstats)
{
1099 1100 1101
	PageFreeSpaceInfo *pageSpaces = vacrelstats->free_pages;
	int			nPages = vacrelstats->num_free_pages;

1102
	/*
1103
	 * Sort data into order, as required by RecordRelationFreeSpace.
1104
	 */
1105 1106 1107 1108
	if (nPages > 1)
		qsort(pageSpaces, nPages, sizeof(PageFreeSpaceInfo),
			  vac_cmp_page_spaces);

1109
	RecordRelationFreeSpace(&onerel->rd_node, nPages, pageSpaces);
1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140
}

/*
 * Comparator routines for use with qsort() and bsearch().
 */
static int
vac_cmp_itemptr(const void *left, const void *right)
{
	BlockNumber lblk,
				rblk;
	OffsetNumber loff,
				roff;

	lblk = ItemPointerGetBlockNumber((ItemPointer) left);
	rblk = ItemPointerGetBlockNumber((ItemPointer) right);

	if (lblk < rblk)
		return -1;
	if (lblk > rblk)
		return 1;

	loff = ItemPointerGetOffsetNumber((ItemPointer) left);
	roff = ItemPointerGetOffsetNumber((ItemPointer) right);

	if (loff < roff)
		return -1;
	if (loff > roff)
		return 1;

	return 0;
}
1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153

static int
vac_cmp_page_spaces(const void *left, const void *right)
{
	PageFreeSpaceInfo *linfo = (PageFreeSpaceInfo *) left;
	PageFreeSpaceInfo *rinfo = (PageFreeSpaceInfo *) right;

	if (linfo->blkno < rinfo->blkno)
		return -1;
	else if (linfo->blkno > rinfo->blkno)
		return 1;
	return 0;
}