Branch data Line data Source code
1 : : /*-------------------------------------------------------------------------
2 : : *
3 : : * pruneheap.c
4 : : * heap page pruning and HOT-chain management code
5 : : *
6 : : * Portions Copyright (c) 1996-2026, PostgreSQL Global Development Group
7 : : * Portions Copyright (c) 1994, Regents of the University of California
8 : : *
9 : : *
10 : : * IDENTIFICATION
11 : : * src/backend/access/heap/pruneheap.c
12 : : *
13 : : *-------------------------------------------------------------------------
14 : : */
15 : : #include "postgres.h"
16 : :
17 : : #include "access/heapam.h"
18 : : #include "access/heapam_xlog.h"
19 : : #include "access/htup_details.h"
20 : : #include "access/multixact.h"
21 : : #include "access/transam.h"
22 : : #include "access/visibilitymap.h"
23 : : #include "access/xlog.h"
24 : : #include "access/xloginsert.h"
25 : : #include "commands/vacuum.h"
26 : : #include "executor/instrument.h"
27 : : #include "miscadmin.h"
28 : : #include "pgstat.h"
29 : : #include "storage/bufmgr.h"
30 : : #include "storage/freespace.h"
31 : : #include "utils/rel.h"
32 : : #include "utils/snapmgr.h"
33 : :
34 : : /* Working data for heap_page_prune_and_freeze() and subroutines */
35 : : typedef struct
36 : : {
37 : : /*-------------------------------------------------------
38 : : * Arguments passed to heap_page_prune_and_freeze()
39 : : *-------------------------------------------------------
40 : : */
41 : :
42 : : /* tuple visibility test, initialized for the relation */
43 : : GlobalVisState *vistest;
44 : : /* whether or not dead items can be set LP_UNUSED during pruning */
45 : : bool mark_unused_now;
46 : : /* whether to attempt freezing tuples */
47 : : bool attempt_freeze;
48 : : /* whether to attempt setting the VM */
49 : : bool attempt_set_vm;
50 : : struct VacuumCutoffs *cutoffs;
51 : : Relation relation;
52 : :
53 : : /*
54 : : * Keep the buffer, block, and page handy so that helpers needing to
55 : : * access them don't need to make repeated calls to BufferGetBlockNumber()
56 : : * and BufferGetPage().
57 : : */
58 : : BlockNumber block;
59 : : Buffer buffer;
60 : : Page page;
61 : :
62 : : /*-------------------------------------------------------
63 : : * Fields describing what to do to the page
64 : : *-------------------------------------------------------
65 : : */
66 : : TransactionId new_prune_xid; /* new prune hint value */
67 : : TransactionId latest_xid_removed;
68 : : int nredirected; /* numbers of entries in arrays below */
69 : : int ndead;
70 : : int nunused;
71 : : int nfrozen;
72 : : /* arrays that accumulate indexes of items to be changed */
73 : : OffsetNumber redirected[MaxHeapTuplesPerPage * 2];
74 : : OffsetNumber nowdead[MaxHeapTuplesPerPage];
75 : : OffsetNumber nowunused[MaxHeapTuplesPerPage];
76 : : HeapTupleFreeze frozen[MaxHeapTuplesPerPage];
77 : :
78 : : /*
79 : : * set_all_visible and set_all_frozen indicate if the all-visible and
80 : : * all-frozen bits in the visibility map can be set for this page after
81 : : * pruning. They are only tracked when the caller requests VM updates
82 : : * (attempt_set_vm); otherwise they remain false throughout.
83 : : *
84 : : * NOTE: set_all_visible and set_all_frozen initially don't include
85 : : * LP_DEAD items. That's convenient for heap_page_prune_and_freeze() to
86 : : * use them to decide whether to opportunistically freeze the page or not.
87 : : * The set_all_visible and set_all_frozen values ultimately used to set
88 : : * the VM are adjusted to include LP_DEAD items after we determine whether
89 : : * or not to opportunistically freeze.
90 : : */
91 : : bool set_all_visible;
92 : : bool set_all_frozen;
93 : :
94 : : /*-------------------------------------------------------
95 : : * Working state for HOT chain processing
96 : : *-------------------------------------------------------
97 : : */
98 : :
99 : : /*
100 : : * 'root_items' contains offsets of all LP_REDIRECT line pointers and
101 : : * normal non-HOT tuples. They can be stand-alone items or the first item
102 : : * in a HOT chain. 'heaponly_items' contains heap-only tuples which can
103 : : * only be removed as part of a HOT chain.
104 : : */
105 : : int nroot_items;
106 : : OffsetNumber root_items[MaxHeapTuplesPerPage];
107 : : int nheaponly_items;
108 : : OffsetNumber heaponly_items[MaxHeapTuplesPerPage];
109 : :
110 : : /*
111 : : * processed[offnum] is true if item at offnum has been processed.
112 : : *
113 : : * This needs to be MaxHeapTuplesPerPage + 1 long as FirstOffsetNumber is
114 : : * 1. Otherwise every access would need to subtract 1.
115 : : */
116 : : bool processed[MaxHeapTuplesPerPage + 1];
117 : :
118 : : /*
119 : : * Tuple visibility is only computed once for each tuple, for correctness
120 : : * and efficiency reasons; see comment in heap_page_prune_and_freeze() for
121 : : * details. This is of type int8[], instead of HTSV_Result[], so we can
122 : : * use -1 to indicate no visibility has been computed, e.g. for LP_DEAD
123 : : * items.
124 : : *
125 : : * This needs to be MaxHeapTuplesPerPage + 1 long as FirstOffsetNumber is
126 : : * 1. Otherwise every access would need to subtract 1.
127 : : */
128 : : int8 htsv[MaxHeapTuplesPerPage + 1];
129 : :
130 : : /*-------------------------------------------------------
131 : : * Working state for freezing
132 : : *-------------------------------------------------------
133 : : */
134 : : HeapPageFreeze pagefrz;
135 : :
136 : : /*-------------------------------------------------------
137 : : * Working state for visibility map processing
138 : : *-------------------------------------------------------
139 : : */
140 : :
141 : : /*
142 : : * Caller must provide a pinned vmbuffer corresponding to the heap block
143 : : * passed to heap_page_prune_and_freeze(). We will fix any corruption
144 : : * found in the VM and set the VM if the page is all-visible/all-frozen.
145 : : */
146 : : Buffer vmbuffer;
147 : :
148 : : /*
149 : : * The state of the VM bits at the beginning of pruning and the state they
150 : : * will be in at the end.
151 : : */
152 : : uint8 old_vmbits;
153 : : uint8 new_vmbits;
154 : :
155 : : /* The newest xmin of live tuples on the page */
156 : : TransactionId newest_live_xid;
157 : :
158 : : /*-------------------------------------------------------
159 : : * Information about what was done
160 : : *
161 : : * These fields are not used by pruning itself for the most part, but are
162 : : * used to collect information about what was pruned and what state the
163 : : * page is in after pruning, for the benefit of the caller. They are
164 : : * copied to the caller's PruneFreezeResult at the end.
165 : : * -------------------------------------------------------
166 : : */
167 : :
168 : : int ndeleted; /* Number of tuples deleted from the page */
169 : :
170 : : /* Number of live and recently dead tuples, after pruning */
171 : : int live_tuples;
172 : : int recently_dead_tuples;
173 : :
174 : : /* Whether or not the page makes rel truncation unsafe */
175 : : bool hastup;
176 : :
177 : : /*
178 : : * LP_DEAD items on the page after pruning. Includes existing LP_DEAD
179 : : * items
180 : : */
181 : : int lpdead_items; /* number of items in the array */
182 : : OffsetNumber *deadoffsets; /* points directly to presult->deadoffsets */
183 : : } PruneState;
184 : :
185 : : /*
186 : : * Type of visibility map corruption detected on a heap page and its
187 : : * associated VM page. Passed to heap_page_fix_vm_corruption() so the caller
188 : : * can specify what it found rather than having the function rederive the
189 : : * corruption from page state.
190 : : */
191 : : typedef enum VMCorruptionType
192 : : {
193 : : /* VM bits are set but the heap page-level PD_ALL_VISIBLE flag is not */
194 : : VM_CORRUPT_MISSING_PAGE_HINT,
195 : : /* LP_DEAD line pointers found on a page marked all-visible */
196 : : VM_CORRUPT_LPDEAD,
197 : : /* Tuple not visible to all transactions on a page marked all-visible */
198 : : VM_CORRUPT_TUPLE_VISIBILITY,
199 : : } VMCorruptionType;
200 : :
201 : : /* Local functions */
202 : : static void prune_freeze_setup(PruneFreezeParams *params,
203 : : TransactionId *new_relfrozen_xid,
204 : : MultiXactId *new_relmin_mxid,
205 : : PruneFreezeResult *presult,
206 : : PruneState *prstate);
207 : : static void heap_page_fix_vm_corruption(PruneState *prstate,
208 : : OffsetNumber offnum,
209 : : VMCorruptionType corruption_type);
210 : : static void prune_freeze_fast_path(PruneState *prstate,
211 : : PruneFreezeResult *presult);
212 : : static void prune_freeze_plan(PruneState *prstate,
213 : : OffsetNumber *off_loc);
214 : : static HTSV_Result heap_prune_satisfies_vacuum(PruneState *prstate,
215 : : HeapTuple tup);
216 : : static inline HTSV_Result htsv_get_valid_status(int status);
217 : : static void heap_prune_chain(OffsetNumber maxoff,
218 : : OffsetNumber rootoffnum, PruneState *prstate);
219 : : static void heap_prune_record_prunable(PruneState *prstate, TransactionId xid,
220 : : OffsetNumber offnum);
221 : : static void heap_prune_record_redirect(PruneState *prstate,
222 : : OffsetNumber offnum, OffsetNumber rdoffnum,
223 : : bool was_normal);
224 : : static void heap_prune_record_dead(PruneState *prstate, OffsetNumber offnum,
225 : : bool was_normal);
226 : : static void heap_prune_record_dead_or_unused(PruneState *prstate, OffsetNumber offnum,
227 : : bool was_normal);
228 : : static void heap_prune_record_unused(PruneState *prstate, OffsetNumber offnum, bool was_normal);
229 : :
230 : : static void heap_prune_record_unchanged_lp_unused(PruneState *prstate, OffsetNumber offnum);
231 : : static void heap_prune_record_unchanged_lp_normal(PruneState *prstate, OffsetNumber offnum);
232 : : static void heap_prune_record_unchanged_lp_dead(PruneState *prstate, OffsetNumber offnum);
233 : : static void heap_prune_record_unchanged_lp_redirect(PruneState *prstate, OffsetNumber offnum);
234 : :
235 : : static void page_verify_redirects(Page page);
236 : :
237 : : static bool heap_page_will_freeze(bool did_tuple_hint_fpi, bool do_prune, bool do_hint_prune,
238 : : PruneState *prstate);
239 : : static bool heap_page_will_set_vm(PruneState *prstate, PruneReason reason,
240 : : bool do_prune, bool do_freeze);
241 : :
242 : :
243 : : /*
244 : : * Optionally prune and repair fragmentation in the specified page.
245 : : *
246 : : * This is an opportunistic function. It will perform housekeeping
247 : : * only if the page heuristically looks like a candidate for pruning and we
248 : : * can acquire buffer cleanup lock without blocking.
249 : : *
250 : : * Note: this is called quite often. It's important that it fall out quickly
251 : : * if there's not any use in pruning.
252 : : *
253 : : * Caller must have pin on the buffer, and must *not* have a lock on it.
254 : : *
255 : : * This function may pin *vmbuffer. It's passed by reference so the caller can
256 : : * reuse the pin across calls, avoiding repeated pin/unpin cycles. If we find
257 : : * VM corruption during pruning, we will fix it. Caller is responsible for
258 : : * unpinning *vmbuffer.
259 : : *
260 : : * rel_read_only is true if we determined at plan time that the query does not
261 : : * modify the relation. It is counterproductive to set the VM if the query
262 : : * will immediately clear it.
263 : : *
264 : : * As noted in ScanRelIsReadOnly(), INSERT ... SELECT from the same table will
265 : : * report the scan relation as read-only. This is usually harmless in
266 : : * practice. It is useful to set scanned pages all-visible that won't be
267 : : * inserted into. Pages it does insert to will rarely meet the criteria for
268 : : * pruning, and those that do are likely to contain in-progress inserts which
269 : : * make the page not fully all-visible.
270 : : */
271 : : void
272 : 20534861 : heap_page_prune_opt(Relation relation, Buffer buffer, Buffer *vmbuffer,
273 : : bool rel_read_only)
274 : : {
275 : 20534861 : Page page = BufferGetPage(buffer);
276 : : TransactionId prune_xid;
277 : : GlobalVisState *vistest;
278 : : Size minfree;
279 : :
280 : : /*
281 : : * We can't write WAL in recovery mode, so there's no point trying to
282 : : * clean the page. The primary will likely issue a cleaning WAL record
283 : : * soon anyway, so this is no particular loss.
284 : : */
285 [ + + ]: 20534861 : if (RecoveryInProgress())
286 : 263710 : return;
287 : :
288 : : /*
289 : : * First check whether there's any chance there's something to prune,
290 : : * determining the appropriate horizon is a waste if there's no prune_xid
291 : : * (i.e. no updates/deletes left potentially dead tuples around and no
292 : : * inserts inserted new tuples that may be visible to all).
293 : : */
294 : 20271151 : prune_xid = PageGetPruneXid(page);
295 [ + + ]: 20271151 : if (!TransactionIdIsValid(prune_xid))
296 : 8689730 : return;
297 : :
298 : : /*
299 : : * Check whether prune_xid indicates that there may be dead rows that can
300 : : * be cleaned up.
301 : : */
302 : 11581421 : vistest = GlobalVisTestFor(relation);
303 : :
304 [ + + ]: 11581421 : if (!GlobalVisTestIsRemovableXid(vistest, prune_xid, true))
305 : 9087829 : return;
306 : :
307 : : /*
308 : : * We prune when a previous UPDATE failed to find enough space on the page
309 : : * for a new tuple version, or when free space falls below the relation's
310 : : * fill-factor target (but not less than 10%).
311 : : *
312 : : * Checking free space here is questionable since we aren't holding any
313 : : * lock on the buffer; in the worst case we could get a bogus answer. It's
314 : : * unlikely to be *seriously* wrong, though, since reading either pd_lower
315 : : * or pd_upper is probably atomic. Avoiding taking a lock seems more
316 : : * important than sometimes getting a wrong answer in what is after all
317 : : * just a heuristic estimate.
318 : : */
319 [ + + ]: 2493592 : minfree = RelationGetTargetPageFreeSpace(relation,
320 : : HEAP_DEFAULT_FILLFACTOR);
321 : 2493592 : minfree = Max(minfree, BLCKSZ / 10);
322 : :
323 [ + + + + ]: 2493592 : if (PageIsFull(page) || PageGetHeapFreeSpace(page) < minfree)
324 : : {
325 : 135704 : bool record_free_space = false;
326 : 135704 : Size freespace = 0;
327 : :
328 : : /* OK, try to get exclusive buffer lock */
329 [ + + ]: 135704 : if (!ConditionalLockBufferForCleanup(buffer))
330 : 2105 : return;
331 : :
332 : : /*
333 : : * Now that we have buffer lock, get accurate information about the
334 : : * page's free space, and recheck the heuristic about whether to
335 : : * prune.
336 : : */
337 [ + + + - ]: 133599 : if (PageIsFull(page) || PageGetHeapFreeSpace(page) < minfree)
338 : : {
339 : : OffsetNumber dummy_off_loc;
340 : : PruneFreezeResult presult;
341 : : PruneFreezeParams params;
342 : :
343 : 133599 : visibilitymap_pin(relation, BufferGetBlockNumber(buffer),
344 : : vmbuffer);
345 : :
346 : 133599 : params.relation = relation;
347 : 133599 : params.buffer = buffer;
348 : 133599 : params.vmbuffer = *vmbuffer;
349 : 133599 : params.reason = PRUNE_ON_ACCESS;
350 : 133599 : params.vistest = vistest;
351 : 133599 : params.cutoffs = NULL;
352 : :
353 : : /*
354 : : * We don't pass the HEAP_PAGE_PRUNE_MARK_UNUSED_NOW option
355 : : * regardless of whether or not the relation has indexes, since we
356 : : * cannot safely determine that during on-access pruning with the
357 : : * current implementation.
358 : : */
359 : 133599 : params.options = HEAP_PAGE_PRUNE_ALLOW_FAST_PATH;
360 [ + + ]: 133599 : if (rel_read_only)
361 : 38268 : params.options |= HEAP_PAGE_PRUNE_SET_VM;
362 : :
363 : 133599 : heap_page_prune_and_freeze(¶ms, &presult, &dummy_off_loc,
364 : : NULL, NULL);
365 : :
366 : : /*
367 : : * Report the number of tuples reclaimed to pgstats. This is
368 : : * presult.ndeleted minus the number of newly-LP_DEAD-set items.
369 : : *
370 : : * We derive the number of dead tuples like this to avoid totally
371 : : * forgetting about items that were set to LP_DEAD, since they
372 : : * still need to be cleaned up by VACUUM. We only want to count
373 : : * heap-only tuples that just became LP_UNUSED in our report,
374 : : * which don't.
375 : : *
376 : : * VACUUM doesn't have to compensate in the same way when it
377 : : * tracks ndeleted, since it will set the same LP_DEAD items to
378 : : * LP_UNUSED separately.
379 : : */
380 [ + + ]: 133599 : if (presult.ndeleted > presult.nnewlpdead)
381 : 21917 : pgstat_update_heap_dead_tuples(relation,
382 : 21917 : presult.ndeleted - presult.nnewlpdead);
383 : :
384 : : /*
385 : : * If this prune newly set the page all-visible, VACUUM may later
386 : : * skip the page and not update the free space map (FSM) for it.
387 : : * Keep the FSM from going stale by recording it now. We do not
388 : : * want to update the freespace map otherwise, to reserve
389 : : * freespace on this page for HOT updates.
390 : : */
391 [ + + ]: 133599 : if (presult.newly_all_visible)
392 : : {
393 : 13462 : record_free_space = true;
394 : 13462 : freespace = PageGetHeapFreeSpace(page);
395 : : }
396 : : }
397 : :
398 : : /* And release buffer lock */
399 : 133599 : LockBuffer(buffer, BUFFER_LOCK_UNLOCK);
400 : :
401 : : /*
402 : : * RecordPageWithFreeSpace() only dirties the FSM when the recorded
403 : : * free-space category actually changes. Note that vacuum will still
404 : : * do FreeSpaceMapVacuum() for ranges of pages that are skipped, so we
405 : : * don't have to worry about that here.
406 : : */
407 [ + + ]: 133599 : if (record_free_space)
408 : 13462 : RecordPageWithFreeSpace(relation, BufferGetBlockNumber(buffer), freespace);
409 : : }
410 : : }
411 : :
412 : : /*
413 : : * Helper for heap_page_prune_and_freeze() to initialize the PruneState using
414 : : * the provided parameters.
415 : : *
416 : : * params, new_relfrozen_xid, new_relmin_mxid, and presult are input
417 : : * parameters and are not modified by this function. Only prstate is modified.
418 : : */
419 : : static void
420 : 627165 : prune_freeze_setup(PruneFreezeParams *params,
421 : : TransactionId *new_relfrozen_xid,
422 : : MultiXactId *new_relmin_mxid,
423 : : PruneFreezeResult *presult,
424 : : PruneState *prstate)
425 : : {
426 : : /* Copy parameters to prstate */
427 : 627165 : prstate->vistest = params->vistest;
428 : 627165 : prstate->mark_unused_now =
429 : 627165 : (params->options & HEAP_PAGE_PRUNE_MARK_UNUSED_NOW) != 0;
430 : :
431 : : /* cutoffs must be provided if we will attempt freezing */
432 : : Assert(!(params->options & HEAP_PAGE_PRUNE_FREEZE) || params->cutoffs);
433 : 627165 : prstate->attempt_freeze = (params->options & HEAP_PAGE_PRUNE_FREEZE) != 0;
434 : 627165 : prstate->attempt_set_vm = (params->options & HEAP_PAGE_PRUNE_SET_VM) != 0;
435 : 627165 : prstate->cutoffs = params->cutoffs;
436 : 627165 : prstate->relation = params->relation;
437 : 627165 : prstate->block = BufferGetBlockNumber(params->buffer);
438 : 627165 : prstate->buffer = params->buffer;
439 : 627165 : prstate->page = BufferGetPage(params->buffer);
440 : :
441 : : Assert(BufferIsValid(params->vmbuffer));
442 : 627165 : prstate->vmbuffer = params->vmbuffer;
443 : 627165 : prstate->new_vmbits = 0;
444 : 627165 : prstate->old_vmbits = visibilitymap_get_status(prstate->relation,
445 : : prstate->block,
446 : : &prstate->vmbuffer);
447 : :
448 : : /*
449 : : * Our strategy is to scan the page and make lists of items to change,
450 : : * then apply the changes within a critical section. This keeps as much
451 : : * logic as possible out of the critical section, and also ensures that
452 : : * WAL replay will work the same as the normal case.
453 : : *
454 : : * First, initialize the new pd_prune_xid value to zero (indicating no
455 : : * prunable tuples). If we find any tuples which may soon become
456 : : * prunable, we will save the lowest relevant XID in new_prune_xid. Also
457 : : * initialize the rest of our working state.
458 : : */
459 : 627165 : prstate->new_prune_xid = InvalidTransactionId;
460 : 627165 : prstate->latest_xid_removed = InvalidTransactionId;
461 : 627165 : prstate->nredirected = prstate->ndead = prstate->nunused = 0;
462 : 627165 : prstate->nfrozen = 0;
463 : 627165 : prstate->nroot_items = 0;
464 : 627165 : prstate->nheaponly_items = 0;
465 : :
466 : : /* initialize page freezing working state */
467 : 627165 : prstate->pagefrz.freeze_required = false;
468 : 627165 : prstate->pagefrz.FreezePageConflictXid = InvalidTransactionId;
469 [ + + ]: 627165 : if (prstate->attempt_freeze)
470 : : {
471 : : Assert(new_relfrozen_xid && new_relmin_mxid);
472 : 493566 : prstate->pagefrz.FreezePageRelfrozenXid = *new_relfrozen_xid;
473 : 493566 : prstate->pagefrz.NoFreezePageRelfrozenXid = *new_relfrozen_xid;
474 : 493566 : prstate->pagefrz.FreezePageRelminMxid = *new_relmin_mxid;
475 : 493566 : prstate->pagefrz.NoFreezePageRelminMxid = *new_relmin_mxid;
476 : : }
477 : : else
478 : : {
479 : : Assert(!new_relfrozen_xid && !new_relmin_mxid);
480 : 133599 : prstate->pagefrz.FreezePageRelminMxid = InvalidMultiXactId;
481 : 133599 : prstate->pagefrz.NoFreezePageRelminMxid = InvalidMultiXactId;
482 : 133599 : prstate->pagefrz.FreezePageRelfrozenXid = InvalidTransactionId;
483 : 133599 : prstate->pagefrz.NoFreezePageRelfrozenXid = InvalidTransactionId;
484 : : }
485 : :
486 : 627165 : prstate->ndeleted = 0;
487 : 627165 : prstate->live_tuples = 0;
488 : 627165 : prstate->recently_dead_tuples = 0;
489 : 627165 : prstate->hastup = false;
490 : 627165 : prstate->lpdead_items = 0;
491 : :
492 : : /*
493 : : * deadoffsets are filled in during pruning but are only used to populate
494 : : * PruneFreezeResult->deadoffsets. To avoid needing two copies of the
495 : : * array, just save a pointer to the result offsets array in the
496 : : * PruneState.
497 : : */
498 : 627165 : prstate->deadoffsets = presult->deadoffsets;
499 : :
500 : : /*
501 : : * We track whether the page will be all-visible/all-frozen at the end of
502 : : * pruning and freezing. While examining tuple visibility, we'll set
503 : : * set_all_visible to false if there are tuples on the page not visible to
504 : : * all running and future transactions. If setting the VM is enabled for
505 : : * this scan, we will do so if the page ends up being all-visible.
506 : : *
507 : : * We also keep track of the newest live XID, which is used to calculate
508 : : * the snapshot conflict horizon for a WAL record setting the VM.
509 : : */
510 : 627165 : prstate->set_all_visible = prstate->attempt_set_vm;
511 : 627165 : prstate->newest_live_xid = InvalidTransactionId;
512 : :
513 : : /*
514 : : * Currently, only VACUUM performs freezing, but other callers may in the
515 : : * future. We must initialize set_all_frozen based on whether or not the
516 : : * caller passed HEAP_PAGE_PRUNE_FREEZE, because if they did not, we won't
517 : : * call heap_prepare_freeze_tuple() for each tuple, and set_all_frozen
518 : : * will never be cleared for tuples that need freezing. This would lead to
519 : : * incorrectly setting the visibility map all-frozen for this page. We
520 : : * can't set the page all-frozen in the VM if the caller didn't pass
521 : : * HEAP_PAGE_PRUNE_SET_VM.
522 : : *
523 : : * When freezing is not required (no XIDs/MXIDs older than the freeze
524 : : * cutoff), we may still choose to "opportunistically" freeze if doing so
525 : : * would make the page all-frozen.
526 : : *
527 : : * We will not be able to freeze the whole page at the end of vacuum if
528 : : * there are tuples present that are not visible to everyone or if there
529 : : * are dead tuples which will not be removable. However, dead tuples that
530 : : * will be removed by the end of vacuum should not prevent this
531 : : * opportunistic freezing.
532 : : *
533 : : * Therefore, we do not clear set_all_visible and set_all_frozen when we
534 : : * encounter LP_DEAD items. Instead, we correct them after deciding
535 : : * whether to freeze, but before updating the VM, to avoid setting the VM
536 : : * bits incorrectly.
537 : : */
538 [ + + + - ]: 627165 : prstate->set_all_frozen = prstate->attempt_freeze && prstate->attempt_set_vm;
539 : 627165 : }
540 : :
541 : : /*
542 : : * Helper for heap_page_prune_and_freeze(). Iterates over every tuple on the
543 : : * page, examines its visibility information, and determines the appropriate
544 : : * action for each tuple. All tuples are processed and classified during this
545 : : * phase, but no modifications are made to the page until the later execution
546 : : * stage.
547 : : *
548 : : * *off_loc is used for error callback and cleared before returning.
549 : : */
550 : : static void
551 : 432336 : prune_freeze_plan(PruneState *prstate, OffsetNumber *off_loc)
552 : : {
553 : 432336 : Page page = prstate->page;
554 : 432336 : BlockNumber blockno = prstate->block;
555 : 432336 : OffsetNumber maxoff = PageGetMaxOffsetNumber(prstate->page);
556 : : OffsetNumber offnum;
557 : : HeapTupleData tup;
558 : :
559 : 432336 : tup.t_tableOid = RelationGetRelid(prstate->relation);
560 : :
561 : : /*
562 : : * Determine HTSV for all tuples, and queue them up for processing as HOT
563 : : * chain roots or as heap-only items.
564 : : *
565 : : * Determining HTSV only once for each tuple is required for correctness,
566 : : * to deal with cases where running HTSV twice could result in different
567 : : * results. For example, RECENTLY_DEAD can turn to DEAD if another
568 : : * checked item causes GlobalVisTestIsRemovableFullXid() to update the
569 : : * horizon, or INSERT_IN_PROGRESS can change to DEAD if the inserting
570 : : * transaction aborts.
571 : : *
572 : : * It's also good for performance. Most commonly tuples within a page are
573 : : * stored at decreasing offsets (while the items are stored at increasing
574 : : * offsets). When processing all tuples on a page this leads to reading
575 : : * memory at decreasing offsets within a page, with a variable stride.
576 : : * That's hard for CPU prefetchers to deal with. Processing the items in
577 : : * reverse order (and thus the tuples in increasing order) increases
578 : : * prefetching efficiency significantly / decreases the number of cache
579 : : * misses.
580 : : */
581 : 432336 : for (offnum = maxoff;
582 [ + + ]: 28686730 : offnum >= FirstOffsetNumber;
583 : 28254394 : offnum = OffsetNumberPrev(offnum))
584 : : {
585 : 28254394 : ItemId itemid = PageGetItemId(page, offnum);
586 : : HeapTupleHeader htup;
587 : :
588 : : /*
589 : : * Set the offset number so that we can display it along with any
590 : : * error that occurred while processing this tuple.
591 : : */
592 : 28254394 : *off_loc = offnum;
593 : :
594 : 28254394 : prstate->processed[offnum] = false;
595 : 28254394 : prstate->htsv[offnum] = -1;
596 : :
597 : : /* Nothing to do if slot doesn't contain a tuple */
598 [ + + ]: 28254394 : if (!ItemIdIsUsed(itemid))
599 : : {
600 : 115533 : heap_prune_record_unchanged_lp_unused(prstate, offnum);
601 : 115533 : continue;
602 : : }
603 : :
604 [ + + ]: 28138861 : if (ItemIdIsDead(itemid))
605 : : {
606 : : /*
607 : : * If the caller set mark_unused_now true, we can set dead line
608 : : * pointers LP_UNUSED now.
609 : : */
610 [ + + ]: 1767690 : if (unlikely(prstate->mark_unused_now))
611 : 1577 : heap_prune_record_unused(prstate, offnum, false);
612 : : else
613 : 1766113 : heap_prune_record_unchanged_lp_dead(prstate, offnum);
614 : 1767690 : continue;
615 : : }
616 : :
617 [ + + ]: 26371171 : if (ItemIdIsRedirected(itemid))
618 : : {
619 : : /* This is the start of a HOT chain */
620 : 210614 : prstate->root_items[prstate->nroot_items++] = offnum;
621 : 210614 : continue;
622 : : }
623 : :
624 : : Assert(ItemIdIsNormal(itemid));
625 : :
626 : : /*
627 : : * Get the tuple's visibility status and queue it up for processing.
628 : : */
629 : 26160557 : htup = (HeapTupleHeader) PageGetItem(page, itemid);
630 : 26160557 : tup.t_data = htup;
631 : 26160557 : tup.t_len = ItemIdGetLength(itemid);
632 : 26160557 : ItemPointerSet(&tup.t_self, blockno, offnum);
633 : :
634 : 26160557 : prstate->htsv[offnum] = heap_prune_satisfies_vacuum(prstate, &tup);
635 : :
636 [ + + ]: 26160557 : if (!HeapTupleHeaderIsHeapOnly(htup))
637 : 25801641 : prstate->root_items[prstate->nroot_items++] = offnum;
638 : : else
639 : 358916 : prstate->heaponly_items[prstate->nheaponly_items++] = offnum;
640 : : }
641 : :
642 : : /*
643 : : * Process HOT chains.
644 : : *
645 : : * We added the items to the array starting from 'maxoff', so by
646 : : * processing the array in reverse order, we process the items in
647 : : * ascending offset number order. The order doesn't matter for
648 : : * correctness, but some quick micro-benchmarking suggests that this is
649 : : * faster. (Earlier PostgreSQL versions, which scanned all the items on
650 : : * the page instead of using the root_items array, also did it in
651 : : * ascending offset number order.)
652 : : */
653 [ + + ]: 26444591 : for (int i = prstate->nroot_items - 1; i >= 0; i--)
654 : : {
655 : 26012255 : offnum = prstate->root_items[i];
656 : :
657 : : /* Ignore items already processed as part of an earlier chain */
658 [ - + ]: 26012255 : if (prstate->processed[offnum])
659 : 0 : continue;
660 : :
661 : : /* see preceding loop */
662 : 26012255 : *off_loc = offnum;
663 : :
664 : : /* Process this item or chain of items */
665 : 26012255 : heap_prune_chain(maxoff, offnum, prstate);
666 : : }
667 : :
668 : : /*
669 : : * Process any heap-only tuples that were not already processed as part of
670 : : * a HOT chain.
671 : : */
672 [ + + ]: 791252 : for (int i = prstate->nheaponly_items - 1; i >= 0; i--)
673 : : {
674 : 358916 : offnum = prstate->heaponly_items[i];
675 : :
676 [ + + ]: 358916 : if (prstate->processed[offnum])
677 : 342198 : continue;
678 : :
679 : : /* see preceding loop */
680 : 16718 : *off_loc = offnum;
681 : :
682 : : /*
683 : : * If the tuple is DEAD and doesn't chain to anything else, mark it
684 : : * unused. (If it does chain, we can only remove it as part of
685 : : * pruning its chain.)
686 : : *
687 : : * We need this primarily to handle aborted HOT updates, that is,
688 : : * XMIN_INVALID heap-only tuples. Those might not be linked to by any
689 : : * chain, since the parent tuple might be re-updated before any
690 : : * pruning occurs. So we have to be able to reap them separately from
691 : : * chain-pruning. (Note that HeapTupleHeaderIsHotUpdated will never
692 : : * return true for an XMIN_INVALID tuple, so this code will work even
693 : : * when there were sequential updates within the aborted transaction.)
694 : : */
695 [ + + ]: 16718 : if (prstate->htsv[offnum] == HEAPTUPLE_DEAD)
696 : : {
697 : 3283 : ItemId itemid = PageGetItemId(page, offnum);
698 : 3283 : HeapTupleHeader htup = (HeapTupleHeader) PageGetItem(page, itemid);
699 : :
700 [ + - ]: 3283 : if (likely(!HeapTupleHeaderIsHotUpdated(htup)))
701 : : {
702 : 3283 : HeapTupleHeaderAdvanceConflictHorizon(htup,
703 : : &prstate->latest_xid_removed);
704 : 3283 : heap_prune_record_unused(prstate, offnum, true);
705 : : }
706 : : else
707 : : {
708 : : /*
709 : : * This tuple should've been processed and removed as part of
710 : : * a HOT chain, so something's wrong. To preserve evidence,
711 : : * we don't dare to remove it. We cannot leave behind a DEAD
712 : : * tuple either, because that will cause VACUUM to error out.
713 : : * Throwing an error with a distinct error message seems like
714 : : * the least bad option.
715 : : */
716 [ # # ]: 0 : elog(ERROR, "dead heap-only tuple (%u, %d) is not linked to from any HOT chain",
717 : : blockno, offnum);
718 : : }
719 : : }
720 : : else
721 : 13435 : heap_prune_record_unchanged_lp_normal(prstate, offnum);
722 : : }
723 : :
724 : : /* We should now have processed every tuple exactly once */
725 : : #ifdef USE_ASSERT_CHECKING
726 : : for (offnum = FirstOffsetNumber;
727 : : offnum <= maxoff;
728 : : offnum = OffsetNumberNext(offnum))
729 : : {
730 : : *off_loc = offnum;
731 : :
732 : : Assert(prstate->processed[offnum]);
733 : : }
734 : : #endif
735 : :
736 : : /* Clear the offset information once we have processed the given page. */
737 : 432336 : *off_loc = InvalidOffsetNumber;
738 : 432336 : }
739 : :
740 : : /*
741 : : * Decide whether to proceed with freezing according to the freeze plans
742 : : * prepared for the current heap buffer. If freezing is chosen, this function
743 : : * performs several pre-freeze checks.
744 : : *
745 : : * The values of do_prune, do_hint_prune, and did_tuple_hint_fpi must be
746 : : * determined before calling this function.
747 : : *
748 : : * prstate is both an input and output parameter.
749 : : *
750 : : * Returns true if we should apply the freeze plans and freeze tuples on the
751 : : * page, and false otherwise.
752 : : */
753 : : static bool
754 : 432336 : heap_page_will_freeze(bool did_tuple_hint_fpi,
755 : : bool do_prune,
756 : : bool do_hint_prune,
757 : : PruneState *prstate)
758 : : {
759 : 432336 : bool do_freeze = false;
760 : :
761 : : /*
762 : : * If the caller specified we should not attempt to freeze any tuples,
763 : : * validate that everything is in the right state and return.
764 : : */
765 [ + + ]: 432336 : if (!prstate->attempt_freeze)
766 : : {
767 : : Assert(!prstate->set_all_frozen && prstate->nfrozen == 0);
768 : 133501 : return false;
769 : : }
770 : :
771 [ + + ]: 298835 : if (prstate->pagefrz.freeze_required)
772 : : {
773 : : /*
774 : : * heap_prepare_freeze_tuple indicated that at least one XID/MXID from
775 : : * before FreezeLimit/MultiXactCutoff is present. Must freeze to
776 : : * advance relfrozenxid/relminmxid.
777 : : */
778 : 23654 : do_freeze = true;
779 : : }
780 : : else
781 : : {
782 : : /*
783 : : * Opportunistically freeze the page if we are generating an FPI
784 : : * anyway and if doing so means that we can set the page all-frozen
785 : : * afterwards (might not happen until VACUUM's final heap pass).
786 : : *
787 : : * XXX: Previously, we knew if pruning emitted an FPI by checking
788 : : * pgWalUsage.wal_fpi before and after pruning. Once the freeze and
789 : : * prune records were combined, this heuristic couldn't be used
790 : : * anymore. The opportunistic freeze heuristic must be improved;
791 : : * however, for now, try to approximate the old logic.
792 : : */
793 [ + + + + ]: 275181 : if (prstate->set_all_frozen && prstate->nfrozen > 0)
794 : : {
795 : : Assert(prstate->set_all_visible);
796 : :
797 : : /*
798 : : * Freezing would make the page all-frozen. Have already emitted
799 : : * an FPI or will do so anyway?
800 : : */
801 [ + + + + : 18948 : if (RelationNeedsWAL(prstate->relation))
+ - + - ]
802 : : {
803 [ + + ]: 17290 : if (did_tuple_hint_fpi)
804 : 966 : do_freeze = true;
805 [ + + ]: 16324 : else if (do_prune)
806 : : {
807 [ + + ]: 1595 : if (XLogCheckBufferNeedsBackup(prstate->buffer))
808 : 914 : do_freeze = true;
809 : : }
810 [ + + ]: 14729 : else if (do_hint_prune)
811 : : {
812 [ + + + - : 17618 : if (XLogHintBitIsNeeded() &&
+ + ]
813 : 8809 : XLogCheckBufferNeedsBackup(prstate->buffer))
814 : 943 : do_freeze = true;
815 : : }
816 : : }
817 : : }
818 : : }
819 : :
820 [ + + ]: 298835 : if (do_freeze)
821 : : {
822 : : /*
823 : : * Validate the tuples we will be freezing before entering the
824 : : * critical section.
825 : : */
826 : 26477 : heap_pre_freeze_checks(prstate->buffer, prstate->frozen, prstate->nfrozen);
827 : : Assert(TransactionIdPrecedes(prstate->pagefrz.FreezePageConflictXid,
828 : : prstate->cutoffs->OldestXmin));
829 : : }
830 [ + + ]: 272358 : else if (prstate->nfrozen > 0)
831 : : {
832 : : /*
833 : : * The page contained some tuples that were not already frozen, and we
834 : : * chose not to freeze them now. The page won't be all-frozen then.
835 : : */
836 : : Assert(!prstate->pagefrz.freeze_required);
837 : :
838 : 16830 : prstate->set_all_frozen = false;
839 : 16830 : prstate->nfrozen = 0; /* avoid miscounts in instrumentation */
840 : : }
841 : : else
842 : : {
843 : : /*
844 : : * We have no freeze plans to execute. The page might already be
845 : : * all-frozen (perhaps only following pruning), though. Such pages
846 : : * can be marked all-frozen in the VM by our caller, even though none
847 : : * of its tuples were newly frozen here.
848 : : */
849 : : }
850 : :
851 : 298835 : return do_freeze;
852 : : }
853 : :
854 : : /*
855 : : * Emit a warning about and fix visibility map corruption on the given page.
856 : : *
857 : : * The caller specifies the type of corruption it has already detected via
858 : : * corruption_type, so that we can emit the appropriate warning. All cases
859 : : * result in the VM bits being cleared; corruption types where PD_ALL_VISIBLE
860 : : * is incorrectly set also clear PD_ALL_VISIBLE.
861 : : *
862 : : * Must be called while holding an exclusive lock on the heap buffer. Dead
863 : : * items and not all-visible tuples must have been discovered under that same
864 : : * lock. Although we do not hold a lock on the VM buffer, it is pinned, and
865 : : * the heap buffer is exclusively locked, ensuring that no other backend can
866 : : * update the VM bits corresponding to this heap page.
867 : : *
868 : : * This function makes changes to the VM and, potentially, the heap page, but
869 : : * it does not need to be done in a critical section.
870 : : */
871 : : static void
872 : 0 : heap_page_fix_vm_corruption(PruneState *prstate, OffsetNumber offnum,
873 : : VMCorruptionType corruption_type)
874 : : {
875 : 0 : const char *relname = RelationGetRelationName(prstate->relation);
876 : 0 : bool do_clear_vm = false;
877 : 0 : bool do_clear_heap = false;
878 : :
879 : : Assert(BufferIsLockedByMeInMode(prstate->buffer, BUFFER_LOCK_EXCLUSIVE));
880 : :
881 [ # # # # ]: 0 : switch (corruption_type)
882 : : {
883 : 0 : case VM_CORRUPT_LPDEAD:
884 [ # # ]: 0 : ereport(WARNING,
885 : : (errcode(ERRCODE_DATA_CORRUPTED),
886 : : errmsg("dead line pointer found on page marked all-visible"),
887 : : errcontext("relation \"%s\", page %u, tuple %u",
888 : : relname, prstate->block, offnum)));
889 : 0 : do_clear_vm = true;
890 : 0 : do_clear_heap = true;
891 : 0 : break;
892 : :
893 : 0 : case VM_CORRUPT_TUPLE_VISIBILITY:
894 : :
895 : : /*
896 : : * A HEAPTUPLE_LIVE tuple on an all-visible page can appear to not
897 : : * be visible to everyone when
898 : : * GetOldestNonRemovableTransactionId() returns a conservative
899 : : * value that's older than the real safe xmin. That is not
900 : : * corruption -- the PD_ALL_VISIBLE flag is still correct.
901 : : *
902 : : * However, dead tuple versions, in-progress inserts, and
903 : : * in-progress deletes should never appear on a page marked
904 : : * all-visible. That indicates real corruption. PD_ALL_VISIBLE
905 : : * should have been cleared by the DML operation that deleted or
906 : : * inserted the tuple.
907 : : */
908 [ # # ]: 0 : ereport(WARNING,
909 : : (errcode(ERRCODE_DATA_CORRUPTED),
910 : : errmsg("tuple not visible to all transactions found on page marked all-visible"),
911 : : errcontext("relation \"%s\", page %u, tuple %u",
912 : : relname, prstate->block, offnum)));
913 : 0 : do_clear_vm = true;
914 : 0 : do_clear_heap = true;
915 : 0 : break;
916 : :
917 : 0 : case VM_CORRUPT_MISSING_PAGE_HINT:
918 : :
919 : : /*
920 : : * As of PostgreSQL 9.2, the visibility map bit should never be
921 : : * set if the page-level bit is clear. However, for vacuum, it's
922 : : * possible that the bit got cleared after
923 : : * heap_vac_scan_next_block() was called, so we must recheck now
924 : : * that we have the buffer lock before concluding that the VM is
925 : : * corrupt.
926 : : */
927 : : Assert(!PageIsAllVisible(prstate->page));
928 : : Assert(prstate->old_vmbits & VISIBILITYMAP_VALID_BITS);
929 [ # # ]: 0 : ereport(WARNING,
930 : : (errcode(ERRCODE_DATA_CORRUPTED),
931 : : errmsg("page is not marked all-visible but visibility map bit is set"),
932 : : errcontext("relation \"%s\", page %u",
933 : : relname, prstate->block)));
934 : 0 : do_clear_vm = true;
935 : 0 : break;
936 : : }
937 : :
938 : : Assert(do_clear_heap || do_clear_vm);
939 : :
940 : : /* Avoid marking the buffer dirty if PD_ALL_VISIBLE is already clear */
941 [ # # ]: 0 : if (do_clear_heap)
942 : : {
943 : : Assert(PageIsAllVisible(prstate->page));
944 : 0 : PageClearAllVisible(prstate->page);
945 : 0 : MarkBufferDirtyHint(prstate->buffer, true);
946 : : }
947 : :
948 [ # # ]: 0 : if (do_clear_vm)
949 : : {
950 : 0 : visibilitymap_clear(prstate->relation, prstate->block,
951 : : prstate->vmbuffer,
952 : : VISIBILITYMAP_VALID_BITS);
953 : 0 : prstate->old_vmbits = 0;
954 : : }
955 : 0 : }
956 : :
957 : : /*
958 : : * Decide whether to set the visibility map bits (all-visible and all-frozen)
959 : : * for the current page using information from the PruneState and VM.
960 : : *
961 : : * This function does not actually set the VM bits or page-level visibility
962 : : * hint, PD_ALL_VISIBLE.
963 : : *
964 : : * This should be called only after do_freeze has been decided (and do_prune
965 : : * has been set), as these factor into our heuristic-based decision.
966 : : *
967 : : * Returns true if one or both VM bits should be set and false otherwise.
968 : : */
969 : : static bool
970 : 432336 : heap_page_will_set_vm(PruneState *prstate, PruneReason reason,
971 : : bool do_prune, bool do_freeze)
972 : : {
973 [ + + ]: 432336 : if (!prstate->attempt_set_vm)
974 : 95331 : return false;
975 : :
976 [ + + ]: 337005 : if (!prstate->set_all_visible)
977 : 261357 : return false;
978 : :
979 : : /*
980 : : * If this is an on-access call and we're not actually pruning, avoid
981 : : * setting the visibility map if it would newly dirty the heap page or, if
982 : : * the page is already dirty, if doing so would require including a
983 : : * full-page image (FPI) of the heap page in the WAL.
984 : : */
985 [ + + + + : 75648 : if (reason == PRUNE_ON_ACCESS && !do_prune && !do_freeze &&
+ - ]
986 [ + + + + ]: 29357 : (!BufferIsDirty(prstate->buffer) || XLogCheckBufferNeedsBackup(prstate->buffer)))
987 : : {
988 : 15982 : prstate->set_all_visible = prstate->set_all_frozen = false;
989 : 15982 : return false;
990 : : }
991 : :
992 : 59666 : prstate->new_vmbits = VISIBILITYMAP_ALL_VISIBLE;
993 : :
994 [ + + ]: 59666 : if (prstate->set_all_frozen)
995 : 33594 : prstate->new_vmbits |= VISIBILITYMAP_ALL_FROZEN;
996 : :
997 [ + + ]: 59666 : if (prstate->new_vmbits == prstate->old_vmbits)
998 : : {
999 : 1632 : prstate->new_vmbits = 0;
1000 : 1632 : return false;
1001 : : }
1002 : :
1003 : 58034 : return true;
1004 : : }
1005 : :
1006 : : /*
1007 : : * If the page is already all-frozen, or already all-visible and freezing
1008 : : * won't be attempted, there is no remaining work and we can use the fast path
1009 : : * to avoid the expensive overhead of heap_page_prune_and_freeze().
1010 : : *
1011 : : * This can happen when the page has a stale prune hint, or if VACUUM is
1012 : : * scanning an already all-frozen page due to SKIP_PAGES_THRESHOLD.
1013 : : *
1014 : : * The caller must already have examined the visibility map and saved the
1015 : : * status of the page's VM bits in prstate->old_vmbits. Caller must hold a
1016 : : * content lock on the heap page since it will examine line pointers.
1017 : : *
1018 : : * Before calling prune_freeze_fast_path(), the caller should first
1019 : : * check for and fix any discrepancy between the page-level visibility hint
1020 : : * and the visibility map. Otherwise, the fast path will always prevent us
1021 : : * from getting them in sync. Note that if there are tuples on the page that
1022 : : * are not visible to all but the VM is incorrectly marked
1023 : : * all-visible/all-frozen, we will not get the chance to fix that corruption
1024 : : * when using the fast path.
1025 : : */
1026 : : static void
1027 : 194829 : prune_freeze_fast_path(PruneState *prstate, PruneFreezeResult *presult)
1028 : : {
1029 : 194829 : OffsetNumber maxoff = PageGetMaxOffsetNumber(prstate->page);
1030 : 194829 : Page page = prstate->page;
1031 : :
1032 : : Assert((prstate->old_vmbits & VISIBILITYMAP_ALL_FROZEN) ||
1033 : : ((prstate->old_vmbits & VISIBILITYMAP_ALL_VISIBLE) &&
1034 : : !prstate->attempt_freeze));
1035 : :
1036 : : /* We'll fill in presult for the caller */
1037 : 194829 : memset(presult, 0, sizeof(PruneFreezeResult));
1038 : :
1039 : : /* Clear any stale prune hint */
1040 [ + + ]: 194829 : if (TransactionIdIsValid(PageGetPruneXid(page)))
1041 : : {
1042 : 98 : PageClearPrunable(page);
1043 : 98 : MarkBufferDirtyHint(prstate->buffer, true);
1044 : : }
1045 : :
1046 [ - + ]: 194829 : if (PageIsEmpty(page))
1047 : 0 : return;
1048 : :
1049 : : /*
1050 : : * Since the page is all-visible, a count of the normal ItemIds on the
1051 : : * page should be sufficient for vacuum's live tuple count.
1052 : : */
1053 : 194829 : for (OffsetNumber off = FirstOffsetNumber;
1054 [ + + ]: 11279187 : off <= maxoff;
1055 : 11084358 : off = OffsetNumberNext(off))
1056 : : {
1057 : 11084358 : ItemId lp = PageGetItemId(page, off);
1058 : :
1059 [ + + ]: 11084358 : if (!ItemIdIsUsed(lp))
1060 : 180430 : continue;
1061 : :
1062 : 10903928 : presult->hastup = true;
1063 : :
1064 [ + + ]: 10903928 : if (ItemIdIsNormal(lp))
1065 : 10707863 : prstate->live_tuples++;
1066 : : }
1067 : :
1068 : 194829 : presult->live_tuples = prstate->live_tuples;
1069 : : }
1070 : :
1071 : : /*
1072 : : * Prune and repair fragmentation and potentially freeze tuples on the
1073 : : * specified page. If the page's visibility status has changed, update it in
1074 : : * the VM.
1075 : : *
1076 : : * Caller must have pin and buffer cleanup lock on the page. Note that we
1077 : : * don't update the FSM information for page on caller's behalf. Caller might
1078 : : * also need to account for a reduction in the length of the line pointer
1079 : : * array following array truncation by us.
1080 : : *
1081 : : * params contains the input parameters used to control freezing and pruning
1082 : : * behavior. See the definition of PruneFreezeParams for more on what each
1083 : : * parameter does.
1084 : : *
1085 : : * If the HEAP_PAGE_PRUNE_FREEZE option is set in params, we will freeze
1086 : : * tuples if it's required in order to advance relfrozenxid / relminmxid, or
1087 : : * if it's considered advantageous for overall system performance to do so
1088 : : * now. The 'params.cutoffs', 'presult', 'new_relfrozen_xid' and
1089 : : * 'new_relmin_mxid' arguments are required when freezing.
1090 : : *
1091 : : * A vmbuffer corresponding to the heap page is also passed and if the page is
1092 : : * found to be all-visible/all-frozen, we will set it in the VM.
1093 : : *
1094 : : * presult contains output parameters needed by callers, such as the number of
1095 : : * tuples removed and the offsets of dead items on the page after pruning.
1096 : : * heap_page_prune_and_freeze() is responsible for initializing it. Required
1097 : : * by all callers.
1098 : : *
1099 : : * off_loc is the offset location required by the caller to use in error
1100 : : * callback.
1101 : : *
1102 : : * new_relfrozen_xid and new_relmin_mxid must be provided by the caller if the
1103 : : * HEAP_PAGE_PRUNE_FREEZE option is set in params. On entry, they contain the
1104 : : * oldest XID and multi-XID seen on the relation so far. They will be updated
1105 : : * with the oldest values present on the page after pruning. After processing
1106 : : * the whole relation, VACUUM can use these values as the new
1107 : : * relfrozenxid/relminmxid for the relation.
1108 : : */
1109 : : void
1110 : 627165 : heap_page_prune_and_freeze(PruneFreezeParams *params,
1111 : : PruneFreezeResult *presult,
1112 : : OffsetNumber *off_loc,
1113 : : TransactionId *new_relfrozen_xid,
1114 : : MultiXactId *new_relmin_mxid)
1115 : : {
1116 : : PruneState prstate;
1117 : : bool do_freeze;
1118 : : bool do_prune;
1119 : : bool do_hint_prune;
1120 : : bool do_set_vm;
1121 : : bool did_tuple_hint_fpi;
1122 : 627165 : int64 fpi_before = pgWalUsage.wal_fpi;
1123 : : TransactionId conflict_xid;
1124 : :
1125 : : /* Initialize prstate */
1126 : 627165 : prune_freeze_setup(params,
1127 : : new_relfrozen_xid, new_relmin_mxid,
1128 : : presult, &prstate);
1129 : :
1130 : : /*
1131 : : * If the VM is set but PD_ALL_VISIBLE is clear, fix that corruption
1132 : : * before pruning and freezing so that the page and VM start out in a
1133 : : * consistent state.
1134 : : */
1135 [ + + ]: 627165 : if ((prstate.old_vmbits & VISIBILITYMAP_VALID_BITS) &&
1136 [ - + ]: 199953 : !PageIsAllVisible(prstate.page))
1137 : 0 : heap_page_fix_vm_corruption(&prstate, InvalidOffsetNumber,
1138 : : VM_CORRUPT_MISSING_PAGE_HINT);
1139 : :
1140 : : /*
1141 : : * If the page is already all-frozen, or already all-visible when freezing
1142 : : * is not being attempted, take the fast path, skipping pruning and
1143 : : * freezing code entirely. This must be done after fixing any discrepancy
1144 : : * between the page-level visibility hint and the VM, since that may have
1145 : : * cleared old_vmbits.
1146 : : */
1147 [ + + ]: 627165 : if ((params->options & HEAP_PAGE_PRUNE_ALLOW_FAST_PATH) != 0 &&
1148 [ + + ]: 625866 : ((prstate.old_vmbits & VISIBILITYMAP_ALL_FROZEN) ||
1149 [ + + ]: 431037 : ((prstate.old_vmbits & VISIBILITYMAP_ALL_VISIBLE) &&
1150 [ - + ]: 4664 : !prstate.attempt_freeze)))
1151 : : {
1152 : 194829 : prune_freeze_fast_path(&prstate, presult);
1153 : 194829 : return;
1154 : : }
1155 : :
1156 : : /*
1157 : : * Examine all line pointers and tuple visibility information to determine
1158 : : * which line pointers should change state and which tuples may be frozen.
1159 : : * Prepare queue of state changes to later be executed in a critical
1160 : : * section.
1161 : : */
1162 : 432336 : prune_freeze_plan(&prstate, off_loc);
1163 : :
1164 : : /*
1165 : : * After processing all the live tuples on the page, if the newest xmin
1166 : : * amongst them may be considered running by any snapshot, the page cannot
1167 : : * be all-visible. This should be done before determining whether or not
1168 : : * to opportunistically freeze.
1169 : : */
1170 [ + + ]: 432336 : if (prstate.set_all_visible &&
1171 [ + + + + ]: 181368 : TransactionIdIsNormal(prstate.newest_live_xid) &&
1172 : 76782 : GlobalVisTestXidConsideredRunning(prstate.vistest,
1173 : : prstate.newest_live_xid,
1174 : : true))
1175 : 2753 : prstate.set_all_visible = prstate.set_all_frozen = false;
1176 : :
1177 : : /*
1178 : : * If checksums are enabled, calling heap_prune_satisfies_vacuum() while
1179 : : * checking tuple visibility information in prune_freeze_plan() may have
1180 : : * caused an FPI to be emitted.
1181 : : */
1182 : 432336 : did_tuple_hint_fpi = fpi_before != pgWalUsage.wal_fpi;
1183 : :
1184 : 1278620 : do_prune = prstate.nredirected > 0 ||
1185 [ + + + + ]: 794102 : prstate.ndead > 0 ||
1186 [ + + ]: 361766 : prstate.nunused > 0;
1187 : :
1188 : : /*
1189 : : * Even if we don't prune anything, if we found a new value for the
1190 : : * pd_prune_xid field or the page was marked full, we will update the hint
1191 : : * bit.
1192 : : */
1193 [ + + + + ]: 691670 : do_hint_prune = PageGetPruneXid(prstate.page) != prstate.new_prune_xid ||
1194 : 259334 : PageIsFull(prstate.page);
1195 : :
1196 : : /*
1197 : : * Decide if we want to go ahead with freezing according to the freeze
1198 : : * plans we prepared, or not.
1199 : : */
1200 : 432336 : do_freeze = heap_page_will_freeze(did_tuple_hint_fpi,
1201 : : do_prune,
1202 : : do_hint_prune,
1203 : : &prstate);
1204 : :
1205 : : /*
1206 : : * While scanning the line pointers, we did not clear
1207 : : * set_all_visible/set_all_frozen when encountering LP_DEAD items because
1208 : : * we wanted the decision whether or not to freeze the page to be
1209 : : * unaffected by the short-term presence of LP_DEAD items. These LP_DEAD
1210 : : * items are effectively assumed to be LP_UNUSED items in the making. It
1211 : : * doesn't matter which vacuum heap pass (initial pass or final pass) ends
1212 : : * up setting the page all-frozen, as long as the ongoing VACUUM does it.
1213 : : *
1214 : : * Now that we finished determining whether or not to freeze the page,
1215 : : * update set_all_visible and set_all_frozen so that they reflect the true
1216 : : * state of the page for setting PD_ALL_VISIBLE and VM bits.
1217 : : */
1218 [ + + ]: 432336 : if (prstate.lpdead_items > 0)
1219 : 73041 : prstate.set_all_visible = prstate.set_all_frozen = false;
1220 : :
1221 : : Assert(!prstate.set_all_frozen || prstate.set_all_visible);
1222 : : Assert(!prstate.set_all_visible || prstate.attempt_set_vm);
1223 : : Assert(!prstate.set_all_visible || (prstate.lpdead_items == 0));
1224 : :
1225 : 432336 : do_set_vm = heap_page_will_set_vm(&prstate, params->reason, do_prune, do_freeze);
1226 : :
1227 : : /*
1228 : : * new_vmbits should be 0 regardless of whether or not the page is
1229 : : * all-visible if we do not intend to set the VM.
1230 : : */
1231 : : Assert(do_set_vm || prstate.new_vmbits == 0);
1232 : :
1233 : : /*
1234 : : * The snapshot conflict horizon for the whole record is the most
1235 : : * conservative (newest) horizon required by any change in the record.
1236 : : */
1237 : 432336 : conflict_xid = InvalidTransactionId;
1238 [ + + ]: 432336 : if (do_set_vm)
1239 : 58034 : conflict_xid = prstate.newest_live_xid;
1240 [ + + + + ]: 432336 : if (do_freeze && TransactionIdFollows(prstate.pagefrz.FreezePageConflictXid, conflict_xid))
1241 : 4521 : conflict_xid = prstate.pagefrz.FreezePageConflictXid;
1242 [ + + + + ]: 432336 : if (do_prune && TransactionIdFollows(prstate.latest_xid_removed, conflict_xid))
1243 : 63429 : conflict_xid = prstate.latest_xid_removed;
1244 : :
1245 : : /* Lock vmbuffer before entering a critical section */
1246 [ + + ]: 432336 : if (do_set_vm)
1247 : 58034 : LockBuffer(prstate.vmbuffer, BUFFER_LOCK_EXCLUSIVE);
1248 : :
1249 : : /* Any error while applying the changes is critical */
1250 : 432336 : START_CRIT_SECTION();
1251 : :
1252 [ + + ]: 432336 : if (do_hint_prune)
1253 : : {
1254 : : /*
1255 : : * Update the page's pd_prune_xid field to either zero, or the lowest
1256 : : * XID of any soon-prunable tuple.
1257 : : */
1258 : 173071 : ((PageHeader) prstate.page)->pd_prune_xid = prstate.new_prune_xid;
1259 : :
1260 : : /*
1261 : : * Also clear the "page is full" flag, since there's no point in
1262 : : * repeating the prune/defrag process until something else happens to
1263 : : * the page.
1264 : : */
1265 : 173071 : PageClearFull(prstate.page);
1266 : :
1267 : : /*
1268 : : * If that's all we had to do to the page, this is a non-WAL-logged
1269 : : * hint. If we are going to freeze or prune the page or set
1270 : : * PD_ALL_VISIBLE, we will mark the buffer dirty below.
1271 : : *
1272 : : * Setting PD_ALL_VISIBLE is fully WAL-logged because it is forbidden
1273 : : * for the VM to be set and PD_ALL_VISIBLE to be clear.
1274 : : */
1275 [ + + + + : 173071 : if (!do_freeze && !do_prune && !do_set_vm)
+ + ]
1276 : 66020 : MarkBufferDirtyHint(prstate.buffer, true);
1277 : : }
1278 : :
1279 [ + + + + : 432336 : if (do_prune || do_freeze || do_set_vm)
+ + ]
1280 : : {
1281 : : /* Apply the planned item changes and repair page fragmentation. */
1282 [ + + ]: 131007 : if (do_prune)
1283 : : {
1284 : 71013 : heap_page_prune_execute(prstate.buffer, false,
1285 : : prstate.redirected, prstate.nredirected,
1286 : : prstate.nowdead, prstate.ndead,
1287 : : prstate.nowunused, prstate.nunused);
1288 : : }
1289 : :
1290 [ + + ]: 131007 : if (do_freeze)
1291 : 26477 : heap_freeze_prepared_tuples(prstate.buffer, prstate.frozen, prstate.nfrozen);
1292 : :
1293 : : /* Set the visibility map and page visibility hint */
1294 [ + + ]: 131007 : if (do_set_vm)
1295 : : {
1296 : : /*
1297 : : * While it is valid for PD_ALL_VISIBLE to be set when the
1298 : : * corresponding VM bit is clear, we strongly prefer to keep them
1299 : : * in sync.
1300 : : *
1301 : : * The heap buffer must be marked dirty before adding it to the
1302 : : * WAL chain when setting the VM. We don't worry about
1303 : : * unnecessarily dirtying the heap buffer if PD_ALL_VISIBLE is
1304 : : * already set, though. It is extremely rare to have a clean heap
1305 : : * buffer with PD_ALL_VISIBLE already set and the VM bits clear,
1306 : : * so there is no point in optimizing it.
1307 : : */
1308 : 58034 : PageSetAllVisible(prstate.page);
1309 : 58034 : PageClearPrunable(prstate.page);
1310 : 58034 : visibilitymap_set(prstate.block, prstate.vmbuffer, prstate.new_vmbits,
1311 : 58034 : prstate.relation->rd_locator);
1312 : : }
1313 : :
1314 : 131007 : MarkBufferDirty(prstate.buffer);
1315 : :
1316 : : /*
1317 : : * Emit a WAL XLOG_HEAP2_PRUNE* record showing what we did
1318 : : */
1319 [ + + + + : 131007 : if (RelationNeedsWAL(prstate.relation))
+ - + - ]
1320 : : {
1321 [ + + + + ]: 184741 : log_heap_prune_and_freeze(prstate.relation, prstate.buffer,
1322 : : do_set_vm ? prstate.vmbuffer : InvalidBuffer,
1323 : 56438 : do_set_vm ? prstate.new_vmbits : 0,
1324 : : conflict_xid,
1325 : : true, /* cleanup lock */
1326 : : params->reason,
1327 : : prstate.frozen, prstate.nfrozen,
1328 : : prstate.redirected, prstate.nredirected,
1329 : : prstate.nowdead, prstate.ndead,
1330 : : prstate.nowunused, prstate.nunused);
1331 : : }
1332 : : }
1333 : :
1334 : 432336 : END_CRIT_SECTION();
1335 : :
1336 [ + + ]: 432336 : if (do_set_vm)
1337 : 58034 : LockBuffer(prstate.vmbuffer, BUFFER_LOCK_UNLOCK);
1338 : :
1339 : : /*
1340 : : * During its second pass over the heap, VACUUM calls
1341 : : * heap_page_would_be_all_visible() to determine whether a page is
1342 : : * all-visible and all-frozen. The logic here is similar. After completing
1343 : : * pruning and freezing, use an assertion to verify that our results
1344 : : * remain consistent with heap_page_would_be_all_visible(). It's also a
1345 : : * valuable cross-check of the page state after pruning and freezing.
1346 : : */
1347 : : #ifdef USE_ASSERT_CHECKING
1348 : : if (prstate.set_all_visible)
1349 : : {
1350 : : TransactionId debug_cutoff;
1351 : : bool debug_all_frozen;
1352 : :
1353 : : Assert(prstate.lpdead_items == 0);
1354 : :
1355 : : Assert(heap_page_is_all_visible(prstate.relation, prstate.buffer,
1356 : : prstate.vistest,
1357 : : &debug_all_frozen,
1358 : : &debug_cutoff, off_loc));
1359 : :
1360 : : Assert(!TransactionIdIsValid(debug_cutoff) ||
1361 : : debug_cutoff == prstate.newest_live_xid);
1362 : :
1363 : : /*
1364 : : * It's possible the page is composed entirely of frozen tuples but is
1365 : : * not set all-frozen in the VM and did not pass
1366 : : * HEAP_PAGE_PRUNE_FREEZE. In this case, it's possible
1367 : : * heap_page_is_all_visible() finds the page completely frozen, even
1368 : : * though prstate.set_all_frozen is false.
1369 : : */
1370 : : Assert(!prstate.set_all_frozen || debug_all_frozen);
1371 : : }
1372 : : #endif
1373 : :
1374 : : /* Copy information back for caller */
1375 : 432336 : presult->ndeleted = prstate.ndeleted;
1376 : 432336 : presult->nnewlpdead = prstate.ndead;
1377 : 432336 : presult->nfrozen = prstate.nfrozen;
1378 : 432336 : presult->live_tuples = prstate.live_tuples;
1379 : 432336 : presult->recently_dead_tuples = prstate.recently_dead_tuples;
1380 : 432336 : presult->hastup = prstate.hastup;
1381 : :
1382 : 432336 : presult->lpdead_items = prstate.lpdead_items;
1383 : : /* the presult->deadoffsets array was already filled in */
1384 : :
1385 : 432336 : presult->newly_all_visible = false;
1386 : 432336 : presult->newly_all_frozen = false;
1387 : 432336 : presult->newly_all_visible_frozen = false;
1388 [ + + ]: 432336 : if (do_set_vm)
1389 : : {
1390 [ + + ]: 58034 : if ((prstate.old_vmbits & VISIBILITYMAP_ALL_VISIBLE) == 0)
1391 : : {
1392 : 54542 : presult->newly_all_visible = true;
1393 [ + + ]: 54542 : if (prstate.set_all_frozen)
1394 : 29643 : presult->newly_all_visible_frozen = true;
1395 : : }
1396 [ + - ]: 3492 : else if ((prstate.old_vmbits & VISIBILITYMAP_ALL_FROZEN) == 0 &&
1397 [ + - ]: 3492 : prstate.set_all_frozen)
1398 : 3492 : presult->newly_all_frozen = true;
1399 : : }
1400 : :
1401 [ + + ]: 432336 : if (prstate.attempt_freeze)
1402 : : {
1403 [ + + ]: 298835 : if (presult->nfrozen > 0)
1404 : : {
1405 : 26477 : *new_relfrozen_xid = prstate.pagefrz.FreezePageRelfrozenXid;
1406 : 26477 : *new_relmin_mxid = prstate.pagefrz.FreezePageRelminMxid;
1407 : : }
1408 : : else
1409 : : {
1410 : 272358 : *new_relfrozen_xid = prstate.pagefrz.NoFreezePageRelfrozenXid;
1411 : 272358 : *new_relmin_mxid = prstate.pagefrz.NoFreezePageRelminMxid;
1412 : : }
1413 : : }
1414 : : }
1415 : :
1416 : :
1417 : : /*
1418 : : * Perform visibility checks for heap pruning.
1419 : : */
1420 : : static HTSV_Result
1421 : 26160557 : heap_prune_satisfies_vacuum(PruneState *prstate, HeapTuple tup)
1422 : : {
1423 : : HTSV_Result res;
1424 : : TransactionId dead_after;
1425 : :
1426 : 26160557 : res = HeapTupleSatisfiesVacuumHorizon(tup, prstate->buffer, &dead_after);
1427 : :
1428 [ + + ]: 26160557 : if (res != HEAPTUPLE_RECENTLY_DEAD)
1429 : 21972264 : return res;
1430 : :
1431 : : /*
1432 : : * For VACUUM, we must be sure to prune tuples with xmax older than
1433 : : * OldestXmin -- a visibility cutoff determined at the beginning of
1434 : : * vacuuming the relation. OldestXmin is used for freezing determination
1435 : : * and we cannot freeze dead tuples' xmaxes.
1436 : : */
1437 [ + + ]: 4188293 : if (prstate->cutoffs &&
1438 [ + - ]: 1110926 : TransactionIdIsValid(prstate->cutoffs->OldestXmin) &&
1439 [ + + ]: 1110926 : NormalTransactionIdPrecedes(dead_after, prstate->cutoffs->OldestXmin))
1440 : 782200 : return HEAPTUPLE_DEAD;
1441 : :
1442 : : /*
1443 : : * Determine whether or not the tuple is considered dead when compared
1444 : : * with the provided GlobalVisState. On-access pruning does not provide
1445 : : * VacuumCutoffs. And for vacuum, even if the tuple's xmax is not older
1446 : : * than OldestXmin, GlobalVisTestIsRemovableXid() could find the row dead
1447 : : * if the GlobalVisState has been updated since the beginning of vacuuming
1448 : : * the relation.
1449 : : */
1450 [ + + ]: 3406093 : if (GlobalVisTestIsRemovableXid(prstate->vistest, dead_after, true))
1451 : 3015943 : return HEAPTUPLE_DEAD;
1452 : :
1453 : 390150 : return res;
1454 : : }
1455 : :
1456 : :
1457 : : /*
1458 : : * Pruning calculates tuple visibility once and saves the results in an array
1459 : : * of int8. See PruneState.htsv for details. This helper function is meant
1460 : : * to guard against examining visibility status array members which have not
1461 : : * yet been computed.
1462 : : */
1463 : : static inline HTSV_Result
1464 : 26143839 : htsv_get_valid_status(int status)
1465 : : {
1466 : : Assert(status >= HEAPTUPLE_DEAD &&
1467 : : status <= HEAPTUPLE_DELETE_IN_PROGRESS);
1468 : 26143839 : return (HTSV_Result) status;
1469 : : }
1470 : :
1471 : : /*
1472 : : * Prune specified line pointer or a HOT chain originating at line pointer.
1473 : : *
1474 : : * Tuple visibility information is provided in prstate->htsv.
1475 : : *
1476 : : * If the item is an index-referenced tuple (i.e. not a heap-only tuple),
1477 : : * the HOT chain is pruned by removing all DEAD tuples at the start of the HOT
1478 : : * chain. We also prune any RECENTLY_DEAD tuples preceding a DEAD tuple.
1479 : : * This is OK because a RECENTLY_DEAD tuple preceding a DEAD tuple is really
1480 : : * DEAD, our visibility test is just too coarse to detect it.
1481 : : *
1482 : : * Pruning must never leave behind a DEAD tuple that still has tuple storage.
1483 : : * VACUUM isn't prepared to deal with that case.
1484 : : *
1485 : : * The root line pointer is redirected to the tuple immediately after the
1486 : : * latest DEAD tuple. If all tuples in the chain are DEAD, the root line
1487 : : * pointer is marked LP_DEAD. (This includes the case of a DEAD simple
1488 : : * tuple, which we treat as a chain of length 1.)
1489 : : *
1490 : : * We don't actually change the page here. We just add entries to the arrays in
1491 : : * prstate showing the changes to be made. Items to be redirected are added
1492 : : * to the redirected[] array (two entries per redirection); items to be set to
1493 : : * LP_DEAD state are added to nowdead[]; and items to be set to LP_UNUSED
1494 : : * state are added to nowunused[]. We perform bookkeeping of live tuples,
1495 : : * visibility etc. based on what the page will look like after the changes
1496 : : * applied. All that bookkeeping is performed in the heap_prune_record_*()
1497 : : * subroutines. The division of labor is that heap_prune_chain() decides the
1498 : : * fate of each tuple, ie. whether it's going to be removed, redirected or
1499 : : * left unchanged, and the heap_prune_record_*() subroutines update PruneState
1500 : : * based on that outcome.
1501 : : */
1502 : : static void
1503 : 26012255 : heap_prune_chain(OffsetNumber maxoff, OffsetNumber rootoffnum,
1504 : : PruneState *prstate)
1505 : : {
1506 : 26012255 : TransactionId priorXmax = InvalidTransactionId;
1507 : : ItemId rootlp;
1508 : : OffsetNumber offnum;
1509 : : OffsetNumber chainitems[MaxHeapTuplesPerPage];
1510 : 26012255 : Page page = prstate->page;
1511 : :
1512 : : /*
1513 : : * After traversing the HOT chain, ndeadchain is the index in chainitems
1514 : : * of the first live successor after the last dead item.
1515 : : */
1516 : 26012255 : int ndeadchain = 0,
1517 : 26012255 : nchain = 0;
1518 : :
1519 : 26012255 : rootlp = PageGetItemId(page, rootoffnum);
1520 : :
1521 : : /* Start from the root tuple */
1522 : 26012255 : offnum = rootoffnum;
1523 : :
1524 : : /* while not end of the chain */
1525 : : for (;;)
1526 : 342198 : {
1527 : : HeapTupleHeader htup;
1528 : : ItemId lp;
1529 : :
1530 : : /* Sanity check (pure paranoia) */
1531 [ - + ]: 26354453 : if (offnum < FirstOffsetNumber)
1532 : 0 : break;
1533 : :
1534 : : /*
1535 : : * An offset past the end of page's line pointer array is possible
1536 : : * when the array was truncated (original item must have been unused)
1537 : : */
1538 [ - + ]: 26354453 : if (offnum > maxoff)
1539 : 0 : break;
1540 : :
1541 : : /* If item is already processed, stop --- it must not be same chain */
1542 [ - + ]: 26354453 : if (prstate->processed[offnum])
1543 : 0 : break;
1544 : :
1545 : 26354453 : lp = PageGetItemId(page, offnum);
1546 : :
1547 : : /*
1548 : : * Unused item obviously isn't part of the chain. Likewise, a dead
1549 : : * line pointer can't be part of the chain. Both of those cases were
1550 : : * already marked as processed.
1551 : : */
1552 : : Assert(ItemIdIsUsed(lp));
1553 : : Assert(!ItemIdIsDead(lp));
1554 : :
1555 : : /*
1556 : : * If we are looking at the redirected root line pointer, jump to the
1557 : : * first normal tuple in the chain. If we find a redirect somewhere
1558 : : * else, stop --- it must not be same chain.
1559 : : */
1560 [ + + ]: 26354453 : if (ItemIdIsRedirected(lp))
1561 : : {
1562 [ - + ]: 210614 : if (nchain > 0)
1563 : 0 : break; /* not at start of chain */
1564 : 210614 : chainitems[nchain++] = offnum;
1565 : 210614 : offnum = ItemIdGetRedirect(rootlp);
1566 : 210614 : continue;
1567 : : }
1568 : :
1569 : : Assert(ItemIdIsNormal(lp));
1570 : :
1571 : 26143839 : htup = (HeapTupleHeader) PageGetItem(page, lp);
1572 : :
1573 : : /*
1574 : : * Check the tuple XMIN against prior XMAX, if any
1575 : : */
1576 [ + + - + ]: 26275423 : if (TransactionIdIsValid(priorXmax) &&
1577 : 131584 : !TransactionIdEquals(HeapTupleHeaderGetXmin(htup), priorXmax))
1578 : 0 : break;
1579 : :
1580 : : /*
1581 : : * OK, this tuple is indeed a member of the chain.
1582 : : */
1583 : 26143839 : chainitems[nchain++] = offnum;
1584 : :
1585 [ + + + - ]: 26143839 : switch (htsv_get_valid_status(prstate->htsv[offnum]))
1586 : : {
1587 : 3870051 : case HEAPTUPLE_DEAD:
1588 : :
1589 : : /* Remember the last DEAD tuple seen */
1590 : 3870051 : ndeadchain = nchain;
1591 : 3870051 : HeapTupleHeaderAdvanceConflictHorizon(htup,
1592 : : &prstate->latest_xid_removed);
1593 : : /* Advance to next chain member */
1594 : 3870051 : break;
1595 : :
1596 : 390150 : case HEAPTUPLE_RECENTLY_DEAD:
1597 : :
1598 : : /*
1599 : : * We don't need to advance the conflict horizon for
1600 : : * RECENTLY_DEAD tuples, even if we are removing them. This
1601 : : * is because we only remove RECENTLY_DEAD tuples if they
1602 : : * precede a DEAD tuple, and the DEAD tuple must have been
1603 : : * inserted by a newer transaction than the RECENTLY_DEAD
1604 : : * tuple by virtue of being later in the chain. We will have
1605 : : * advanced the conflict horizon for the DEAD tuple.
1606 : : */
1607 : :
1608 : : /*
1609 : : * Advance past RECENTLY_DEAD tuples just in case there's a
1610 : : * DEAD one after them. We have to make sure that we don't
1611 : : * miss any DEAD tuples, since DEAD tuples that still have
1612 : : * tuple storage after pruning will confuse VACUUM.
1613 : : */
1614 : 390150 : break;
1615 : :
1616 : 21883638 : case HEAPTUPLE_DELETE_IN_PROGRESS:
1617 : : case HEAPTUPLE_LIVE:
1618 : : case HEAPTUPLE_INSERT_IN_PROGRESS:
1619 : 21883638 : goto process_chain;
1620 : :
1621 : 0 : default:
1622 [ # # ]: 0 : elog(ERROR, "unexpected HeapTupleSatisfiesVacuum result");
1623 : : goto process_chain;
1624 : : }
1625 : :
1626 : : /*
1627 : : * If the tuple is not HOT-updated, then we are at the end of this
1628 : : * HOT-update chain.
1629 : : */
1630 [ + + ]: 4260201 : if (!HeapTupleHeaderIsHotUpdated(htup))
1631 : 4128617 : goto process_chain;
1632 : :
1633 : : /* HOT implies it can't have moved to different partition */
1634 : : Assert(!HeapTupleHeaderIndicatesMovedPartitions(htup));
1635 : :
1636 : : /*
1637 : : * Advance to next chain member.
1638 : : */
1639 : : Assert(ItemPointerGetBlockNumber(&htup->t_ctid) == prstate->block);
1640 : 131584 : offnum = ItemPointerGetOffsetNumber(&htup->t_ctid);
1641 : 131584 : priorXmax = HeapTupleHeaderGetUpdateXid(htup);
1642 : : }
1643 : :
1644 [ # # # # ]: 0 : if (ItemIdIsRedirected(rootlp) && nchain < 2)
1645 : : {
1646 : : /*
1647 : : * We found a redirect item that doesn't point to a valid follow-on
1648 : : * item. This can happen if the loop in heap_page_prune_and_freeze()
1649 : : * caused us to visit the dead successor of a redirect item before
1650 : : * visiting the redirect item. We can clean up by setting the
1651 : : * redirect item to LP_DEAD state or LP_UNUSED if the caller
1652 : : * indicated.
1653 : : */
1654 : 0 : heap_prune_record_dead_or_unused(prstate, rootoffnum, false);
1655 : 0 : return;
1656 : : }
1657 : :
1658 : 0 : process_chain:
1659 : :
1660 [ + + ]: 26012255 : if (ndeadchain == 0)
1661 : : {
1662 : : /*
1663 : : * No DEAD tuple was found, so the chain is entirely composed of
1664 : : * normal, unchanged tuples. Leave it alone.
1665 : : */
1666 : 22191472 : int i = 0;
1667 : :
1668 [ + + ]: 22191472 : if (ItemIdIsRedirected(rootlp))
1669 : : {
1670 : 188140 : heap_prune_record_unchanged_lp_redirect(prstate, rootoffnum);
1671 : 188140 : i++;
1672 : : }
1673 [ + + ]: 44388666 : for (; i < nchain; i++)
1674 : 22197194 : heap_prune_record_unchanged_lp_normal(prstate, chainitems[i]);
1675 : : }
1676 [ + + ]: 3820783 : else if (ndeadchain == nchain)
1677 : : {
1678 : : /*
1679 : : * The entire chain is dead. Mark the root line pointer LP_DEAD, and
1680 : : * fully remove the other tuples in the chain.
1681 : : */
1682 : 3746143 : heap_prune_record_dead_or_unused(prstate, rootoffnum, ItemIdIsNormal(rootlp));
1683 [ + + ]: 3794196 : for (int i = 1; i < nchain; i++)
1684 : 48053 : heap_prune_record_unused(prstate, chainitems[i], true);
1685 : : }
1686 : : else
1687 : : {
1688 : : /*
1689 : : * We found a DEAD tuple in the chain. Redirect the root line pointer
1690 : : * to the first non-DEAD tuple, and mark as unused each intermediate
1691 : : * item that we are able to remove from the chain.
1692 : : */
1693 : 74640 : heap_prune_record_redirect(prstate, rootoffnum, chainitems[ndeadchain],
1694 : 74640 : ItemIdIsNormal(rootlp));
1695 [ + + ]: 98329 : for (int i = 1; i < ndeadchain; i++)
1696 : 23689 : heap_prune_record_unused(prstate, chainitems[i], true);
1697 : :
1698 : : /* the rest of tuples in the chain are normal, unchanged tuples */
1699 [ + + ]: 151234 : for (int i = ndeadchain; i < nchain; i++)
1700 : 76594 : heap_prune_record_unchanged_lp_normal(prstate, chainitems[i]);
1701 : : }
1702 : : }
1703 : :
1704 : : /* Record lowest soon-prunable XID */
1705 : : static void
1706 : 6256028 : heap_prune_record_prunable(PruneState *prstate, TransactionId xid,
1707 : : OffsetNumber offnum)
1708 : : {
1709 : : /*
1710 : : * This should exactly match the PageSetPrunable macro. We can't store
1711 : : * directly into the page header yet, so we update working state.
1712 : : */
1713 : : Assert(TransactionIdIsNormal(xid));
1714 [ + + + + ]: 12250266 : if (!TransactionIdIsValid(prstate->new_prune_xid) ||
1715 : 5994238 : TransactionIdPrecedes(xid, prstate->new_prune_xid))
1716 : 263478 : prstate->new_prune_xid = xid;
1717 : :
1718 : : /*
1719 : : * It's incorrect for a page to be marked all-visible if it contains
1720 : : * prunable items.
1721 : : */
1722 [ - + ]: 6256028 : if (PageIsAllVisible(prstate->page))
1723 : 0 : heap_page_fix_vm_corruption(prstate, offnum,
1724 : : VM_CORRUPT_TUPLE_VISIBILITY);
1725 : 6256028 : }
1726 : :
1727 : : /* Record line pointer to be redirected */
1728 : : static void
1729 : 74640 : heap_prune_record_redirect(PruneState *prstate,
1730 : : OffsetNumber offnum, OffsetNumber rdoffnum,
1731 : : bool was_normal)
1732 : : {
1733 : : Assert(!prstate->processed[offnum]);
1734 : 74640 : prstate->processed[offnum] = true;
1735 : :
1736 : : /*
1737 : : * Do not mark the redirect target here. It needs to be counted
1738 : : * separately as an unchanged tuple.
1739 : : */
1740 : :
1741 : : Assert(prstate->nredirected < MaxHeapTuplesPerPage);
1742 : 74640 : prstate->redirected[prstate->nredirected * 2] = offnum;
1743 : 74640 : prstate->redirected[prstate->nredirected * 2 + 1] = rdoffnum;
1744 : :
1745 : 74640 : prstate->nredirected++;
1746 : :
1747 : : /*
1748 : : * If the root entry had been a normal tuple, we are deleting it, so count
1749 : : * it in the result. But changing a redirect (even to DEAD state) doesn't
1750 : : * count.
1751 : : */
1752 [ + + ]: 74640 : if (was_normal)
1753 : 64718 : prstate->ndeleted++;
1754 : :
1755 : 74640 : prstate->hastup = true;
1756 : 74640 : }
1757 : :
1758 : : /* Record line pointer to be marked dead */
1759 : : static void
1760 : 3711835 : heap_prune_record_dead(PruneState *prstate, OffsetNumber offnum,
1761 : : bool was_normal)
1762 : : {
1763 : : Assert(!prstate->processed[offnum]);
1764 : 3711835 : prstate->processed[offnum] = true;
1765 : :
1766 : : Assert(prstate->ndead < MaxHeapTuplesPerPage);
1767 : 3711835 : prstate->nowdead[prstate->ndead] = offnum;
1768 : 3711835 : prstate->ndead++;
1769 : :
1770 : : /*
1771 : : * Deliberately delay unsetting set_all_visible and set_all_frozen until
1772 : : * later during pruning. Removable dead tuples shouldn't preclude freezing
1773 : : * the page.
1774 : : */
1775 : :
1776 : : /* Record the dead offset for vacuum */
1777 : 3711835 : prstate->deadoffsets[prstate->lpdead_items++] = offnum;
1778 : :
1779 : : /*
1780 : : * If the root entry had been a normal tuple, we are deleting it, so count
1781 : : * it in the result. But changing a redirect (even to DEAD state) doesn't
1782 : : * count.
1783 : : */
1784 [ + + ]: 3711835 : if (was_normal)
1785 : 3699283 : prstate->ndeleted++;
1786 : 3711835 : }
1787 : :
1788 : : /*
1789 : : * Depending on whether or not the caller set mark_unused_now to true, record that a
1790 : : * line pointer should be marked LP_DEAD or LP_UNUSED. There are other cases in
1791 : : * which we will mark line pointers LP_UNUSED, but we will not mark line
1792 : : * pointers LP_DEAD if mark_unused_now is true.
1793 : : */
1794 : : static void
1795 : 3746143 : heap_prune_record_dead_or_unused(PruneState *prstate, OffsetNumber offnum,
1796 : : bool was_normal)
1797 : : {
1798 : : /*
1799 : : * If the caller set mark_unused_now to true, we can remove dead tuples
1800 : : * during pruning instead of marking their line pointers dead. Set this
1801 : : * tuple's line pointer LP_UNUSED. We hint that this option is less
1802 : : * likely.
1803 : : */
1804 [ + + ]: 3746143 : if (unlikely(prstate->mark_unused_now))
1805 : 34308 : heap_prune_record_unused(prstate, offnum, was_normal);
1806 : : else
1807 : 3711835 : heap_prune_record_dead(prstate, offnum, was_normal);
1808 : :
1809 : : /*
1810 : : * It's incorrect for the page to be set all-visible if it contains dead
1811 : : * items. Fix that on the heap page and check the VM for corruption as
1812 : : * well. Do that here rather than in heap_prune_record_dead() so we also
1813 : : * cover tuples that are directly marked LP_UNUSED via mark_unused_now.
1814 : : */
1815 [ - + ]: 3746143 : if (PageIsAllVisible(prstate->page))
1816 : 0 : heap_page_fix_vm_corruption(prstate, offnum, VM_CORRUPT_LPDEAD);
1817 : 3746143 : }
1818 : :
1819 : : /* Record line pointer to be marked unused */
1820 : : static void
1821 : 110910 : heap_prune_record_unused(PruneState *prstate, OffsetNumber offnum, bool was_normal)
1822 : : {
1823 : : Assert(!prstate->processed[offnum]);
1824 : 110910 : prstate->processed[offnum] = true;
1825 : :
1826 : : Assert(prstate->nunused < MaxHeapTuplesPerPage);
1827 : 110910 : prstate->nowunused[prstate->nunused] = offnum;
1828 : 110910 : prstate->nunused++;
1829 : :
1830 : : /*
1831 : : * If the root entry had been a normal tuple, we are deleting it, so count
1832 : : * it in the result. But changing a redirect (even to DEAD state) doesn't
1833 : : * count.
1834 : : */
1835 [ + + ]: 110910 : if (was_normal)
1836 : 109333 : prstate->ndeleted++;
1837 : 110910 : }
1838 : :
1839 : : /*
1840 : : * Record an unused line pointer that is left unchanged.
1841 : : */
1842 : : static void
1843 : 115533 : heap_prune_record_unchanged_lp_unused(PruneState *prstate, OffsetNumber offnum)
1844 : : {
1845 : : Assert(!prstate->processed[offnum]);
1846 : 115533 : prstate->processed[offnum] = true;
1847 : 115533 : }
1848 : :
1849 : : /*
1850 : : * Record line pointer that is left unchanged. We consider freezing it, and
1851 : : * update bookkeeping of tuple counts and page visibility.
1852 : : */
1853 : : static void
1854 : 22287223 : heap_prune_record_unchanged_lp_normal(PruneState *prstate, OffsetNumber offnum)
1855 : : {
1856 : : HeapTupleHeader htup;
1857 : : TransactionId xmin;
1858 : 22287223 : Page page = prstate->page;
1859 : :
1860 : : Assert(!prstate->processed[offnum]);
1861 : 22287223 : prstate->processed[offnum] = true;
1862 : :
1863 : 22287223 : prstate->hastup = true; /* the page is not empty */
1864 : :
1865 : : /*
1866 : : * The criteria for counting a tuple as live in this block need to match
1867 : : * what analyze.c's acquire_sample_rows() does, otherwise VACUUM and
1868 : : * ANALYZE may produce wildly different reltuples values, e.g. when there
1869 : : * are many recently-dead tuples.
1870 : : *
1871 : : * The logic here is a bit simpler than acquire_sample_rows(), as VACUUM
1872 : : * can't run inside a transaction block, which makes some cases impossible
1873 : : * (e.g. in-progress insert from the same transaction).
1874 : : *
1875 : : * HEAPTUPLE_DEAD are handled by the other heap_prune_record_*()
1876 : : * subroutines. They don't count dead items like acquire_sample_rows()
1877 : : * does, because we assume that all dead items will become LP_UNUSED
1878 : : * before VACUUM finishes. This difference is only superficial. VACUUM
1879 : : * effectively agrees with ANALYZE about DEAD items, in the end. VACUUM
1880 : : * won't remember LP_DEAD items, but only because they're not supposed to
1881 : : * be left behind when it is done. (Cases where we bypass index vacuuming
1882 : : * will violate this optimistic assumption, but the overall impact of that
1883 : : * should be negligible.)
1884 : : */
1885 : 22287223 : htup = (HeapTupleHeader) PageGetItem(page, PageGetItemId(page, offnum));
1886 : :
1887 [ + + + + : 22287223 : switch (prstate->htsv[offnum])
- ]
1888 : : {
1889 : 16031195 : case HEAPTUPLE_LIVE:
1890 : :
1891 : : /*
1892 : : * Count it as live. Not only is this natural, but it's also what
1893 : : * acquire_sample_rows() does.
1894 : : */
1895 : 16031195 : prstate->live_tuples++;
1896 : :
1897 : : /*
1898 : : * Is the tuple definitely visible to all transactions?
1899 : : *
1900 : : * NB: Like with per-tuple hint bits, we can't set the
1901 : : * PD_ALL_VISIBLE flag if the inserter committed asynchronously.
1902 : : * See SetHintBits for more info. Check that the tuple is hinted
1903 : : * xmin-committed because of that.
1904 : : */
1905 [ + + ]: 16031195 : if (!HeapTupleHeaderXminCommitted(htup))
1906 : : {
1907 : 40044 : prstate->set_all_visible = false;
1908 : 40044 : prstate->set_all_frozen = false;
1909 : 40044 : break;
1910 : : }
1911 : :
1912 : : /*
1913 : : * The inserter definitely committed. But we don't know if it is
1914 : : * old enough that everyone sees it as committed. Later, after
1915 : : * processing all the tuples on the page, we'll check if there is
1916 : : * any snapshot that still considers the newest xid on the page to
1917 : : * be running. If so, we don't consider the page all-visible.
1918 : : */
1919 : 15991151 : xmin = HeapTupleHeaderGetXmin(htup);
1920 : :
1921 : : /* Track newest xmin on page. */
1922 [ + + + + ]: 15991151 : if (TransactionIdFollows(xmin, prstate->newest_live_xid) &&
1923 : : TransactionIdIsNormal(xmin))
1924 : 626835 : prstate->newest_live_xid = xmin;
1925 : :
1926 : 15991151 : break;
1927 : :
1928 : 390150 : case HEAPTUPLE_RECENTLY_DEAD:
1929 : 390150 : prstate->recently_dead_tuples++;
1930 : 390150 : prstate->set_all_visible = false;
1931 : 390150 : prstate->set_all_frozen = false;
1932 : :
1933 : : /*
1934 : : * This tuple will soon become DEAD. Update the hint field so
1935 : : * that the page is reconsidered for pruning in future.
1936 : : */
1937 : 390150 : heap_prune_record_prunable(prstate,
1938 : : HeapTupleHeaderGetUpdateXid(htup),
1939 : : offnum);
1940 : 390150 : break;
1941 : :
1942 : 140230 : case HEAPTUPLE_INSERT_IN_PROGRESS:
1943 : :
1944 : : /*
1945 : : * We do not count these rows as live, because we expect the
1946 : : * inserting transaction to update the counters at commit, and we
1947 : : * assume that will happen only after we report our results. This
1948 : : * assumption is a bit shaky, but it is what acquire_sample_rows()
1949 : : * does, so be consistent.
1950 : : */
1951 : 140230 : prstate->set_all_visible = false;
1952 : 140230 : prstate->set_all_frozen = false;
1953 : :
1954 : : /*
1955 : : * Though there is nothing "prunable" on the page, we maintain
1956 : : * pd_prune_xid for inserts so that we have the opportunity to
1957 : : * mark them all-visible during the next round of pruning.
1958 : : */
1959 : 140230 : heap_prune_record_prunable(prstate,
1960 : : HeapTupleHeaderGetXmin(htup),
1961 : : offnum);
1962 : 140230 : break;
1963 : :
1964 : 5725648 : case HEAPTUPLE_DELETE_IN_PROGRESS:
1965 : :
1966 : : /*
1967 : : * This an expected case during concurrent vacuum. Count such
1968 : : * rows as live. As above, we assume the deleting transaction
1969 : : * will commit and update the counters after we report.
1970 : : */
1971 : 5725648 : prstate->live_tuples++;
1972 : 5725648 : prstate->set_all_visible = false;
1973 : 5725648 : prstate->set_all_frozen = false;
1974 : :
1975 : : /*
1976 : : * This tuple may soon become DEAD. Update the hint field so that
1977 : : * the page is reconsidered for pruning in future.
1978 : : */
1979 : 5725648 : heap_prune_record_prunable(prstate,
1980 : : HeapTupleHeaderGetUpdateXid(htup),
1981 : : offnum);
1982 : 5725648 : break;
1983 : :
1984 : 0 : default:
1985 : :
1986 : : /*
1987 : : * DEAD tuples should've been passed to heap_prune_record_dead()
1988 : : * or heap_prune_record_unused() instead.
1989 : : */
1990 [ # # ]: 0 : elog(ERROR, "unexpected HeapTupleSatisfiesVacuum result %d",
1991 : : prstate->htsv[offnum]);
1992 : : break;
1993 : : }
1994 : :
1995 : : /* Consider freezing any normal tuples which will not be removed */
1996 [ + + ]: 22287223 : if (prstate->attempt_freeze)
1997 : : {
1998 : : bool totally_frozen;
1999 : :
2000 [ + + ]: 12280714 : if ((heap_prepare_freeze_tuple(htup,
2001 : 12280714 : prstate->cutoffs,
2002 : : &prstate->pagefrz,
2003 : 12280714 : &prstate->frozen[prstate->nfrozen],
2004 : : &totally_frozen)))
2005 : : {
2006 : : /* Save prepared freeze plan for later */
2007 : 2870943 : prstate->frozen[prstate->nfrozen++].offset = offnum;
2008 : : }
2009 : :
2010 : : /*
2011 : : * If any tuple isn't either totally frozen already or eligible to
2012 : : * become totally frozen (according to its freeze plan), then the page
2013 : : * definitely cannot be set all-frozen in the visibility map later on.
2014 : : */
2015 [ + + ]: 12280714 : if (!totally_frozen)
2016 : 6452162 : prstate->set_all_frozen = false;
2017 : : }
2018 : 22287223 : }
2019 : :
2020 : :
2021 : : /*
2022 : : * Record line pointer that was already LP_DEAD and is left unchanged.
2023 : : */
2024 : : static void
2025 : 1766113 : heap_prune_record_unchanged_lp_dead(PruneState *prstate, OffsetNumber offnum)
2026 : : {
2027 : : Assert(!prstate->processed[offnum]);
2028 : 1766113 : prstate->processed[offnum] = true;
2029 : :
2030 : : /*
2031 : : * Deliberately don't set hastup for LP_DEAD items. We make the soft
2032 : : * assumption that any LP_DEAD items encountered here will become
2033 : : * LP_UNUSED later on, before count_nondeletable_pages is reached. If we
2034 : : * don't make this assumption then rel truncation will only happen every
2035 : : * other VACUUM, at most. Besides, VACUUM must treat
2036 : : * hastup/nonempty_pages as provisional no matter how LP_DEAD items are
2037 : : * handled (handled here, or handled later on).
2038 : : *
2039 : : * Similarly, don't unset set_all_visible and set_all_frozen until later,
2040 : : * at the end of heap_page_prune_and_freeze(). This will allow us to
2041 : : * attempt to freeze the page after pruning. As long as we unset it
2042 : : * before updating the visibility map, this will be correct.
2043 : : */
2044 : :
2045 : : /* Record the dead offset for vacuum */
2046 : 1766113 : prstate->deadoffsets[prstate->lpdead_items++] = offnum;
2047 : :
2048 : : /*
2049 : : * It's incorrect for a page to be marked all-visible if it contains dead
2050 : : * items.
2051 : : */
2052 [ - + ]: 1766113 : if (PageIsAllVisible(prstate->page))
2053 : 0 : heap_page_fix_vm_corruption(prstate, offnum, VM_CORRUPT_LPDEAD);
2054 : 1766113 : }
2055 : :
2056 : : /*
2057 : : * Record LP_REDIRECT that is left unchanged.
2058 : : */
2059 : : static void
2060 : 188140 : heap_prune_record_unchanged_lp_redirect(PruneState *prstate, OffsetNumber offnum)
2061 : : {
2062 : : /*
2063 : : * A redirect line pointer doesn't count as a live tuple.
2064 : : *
2065 : : * If we leave a redirect line pointer in place, there will be another
2066 : : * tuple on the page that it points to. We will do the bookkeeping for
2067 : : * that separately. So we have nothing to do here, except remember that
2068 : : * we processed this item.
2069 : : */
2070 : : Assert(!prstate->processed[offnum]);
2071 : 188140 : prstate->processed[offnum] = true;
2072 : 188140 : }
2073 : :
2074 : : /*
2075 : : * Perform the actual page changes needed by heap_page_prune_and_freeze().
2076 : : *
2077 : : * If 'lp_truncate_only' is set, we are merely marking LP_DEAD line pointers
2078 : : * as unused, not redirecting or removing anything else. The
2079 : : * PageRepairFragmentation() call is skipped in that case.
2080 : : *
2081 : : * If 'lp_truncate_only' is not set, the caller must hold a cleanup lock on
2082 : : * the buffer. If it is set, an ordinary exclusive lock suffices.
2083 : : */
2084 : : void
2085 : 81818 : heap_page_prune_execute(Buffer buffer, bool lp_truncate_only,
2086 : : OffsetNumber *redirected, int nredirected,
2087 : : OffsetNumber *nowdead, int ndead,
2088 : : OffsetNumber *nowunused, int nunused)
2089 : : {
2090 : 81818 : Page page = BufferGetPage(buffer);
2091 : : OffsetNumber *offnum;
2092 : : HeapTupleHeader htup PG_USED_FOR_ASSERTS_ONLY;
2093 : :
2094 : : /* Shouldn't be called unless there's something to do */
2095 : : Assert(nredirected > 0 || ndead > 0 || nunused > 0);
2096 : :
2097 : : /* If 'lp_truncate_only', we can only remove already-dead line pointers */
2098 : : Assert(!lp_truncate_only || (nredirected == 0 && ndead == 0));
2099 : :
2100 : : /* Update all redirected line pointers */
2101 : 81818 : offnum = redirected;
2102 [ + + ]: 176032 : for (int i = 0; i < nredirected; i++)
2103 : : {
2104 : 94214 : OffsetNumber fromoff = *offnum++;
2105 : 94214 : OffsetNumber tooff = *offnum++;
2106 : 94214 : ItemId fromlp = PageGetItemId(page, fromoff);
2107 : : ItemId tolp PG_USED_FOR_ASSERTS_ONLY;
2108 : :
2109 : : #ifdef USE_ASSERT_CHECKING
2110 : :
2111 : : /*
2112 : : * Any existing item that we set as an LP_REDIRECT (any 'from' item)
2113 : : * must be the first item from a HOT chain. If the item has tuple
2114 : : * storage then it can't be a heap-only tuple. Otherwise we are just
2115 : : * maintaining an existing LP_REDIRECT from an existing HOT chain that
2116 : : * has been pruned at least once before now.
2117 : : */
2118 : : if (!ItemIdIsRedirected(fromlp))
2119 : : {
2120 : : Assert(ItemIdHasStorage(fromlp) && ItemIdIsNormal(fromlp));
2121 : :
2122 : : htup = (HeapTupleHeader) PageGetItem(page, fromlp);
2123 : : Assert(!HeapTupleHeaderIsHeapOnly(htup));
2124 : : }
2125 : : else
2126 : : {
2127 : : /* We shouldn't need to redundantly set the redirect */
2128 : : Assert(ItemIdGetRedirect(fromlp) != tooff);
2129 : : }
2130 : :
2131 : : /*
2132 : : * The item that we're about to set as an LP_REDIRECT (the 'from'
2133 : : * item) will point to an existing item (the 'to' item) that is
2134 : : * already a heap-only tuple. There can be at most one LP_REDIRECT
2135 : : * item per HOT chain.
2136 : : *
2137 : : * We need to keep around an LP_REDIRECT item (after original
2138 : : * non-heap-only root tuple gets pruned away) so that it's always
2139 : : * possible for VACUUM to easily figure out what TID to delete from
2140 : : * indexes when an entire HOT chain becomes dead. A heap-only tuple
2141 : : * can never become LP_DEAD; an LP_REDIRECT item or a regular heap
2142 : : * tuple can.
2143 : : *
2144 : : * This check may miss problems, e.g. the target of a redirect could
2145 : : * be marked as unused subsequently. The page_verify_redirects() check
2146 : : * below will catch such problems.
2147 : : */
2148 : : tolp = PageGetItemId(page, tooff);
2149 : : Assert(ItemIdHasStorage(tolp) && ItemIdIsNormal(tolp));
2150 : : htup = (HeapTupleHeader) PageGetItem(page, tolp);
2151 : : Assert(HeapTupleHeaderIsHeapOnly(htup));
2152 : : #endif
2153 : :
2154 : 94214 : ItemIdSetRedirect(fromlp, tooff);
2155 : : }
2156 : :
2157 : : /* Update all now-dead line pointers */
2158 : 81818 : offnum = nowdead;
2159 [ + + ]: 4079080 : for (int i = 0; i < ndead; i++)
2160 : : {
2161 : 3997262 : OffsetNumber off = *offnum++;
2162 : 3997262 : ItemId lp = PageGetItemId(page, off);
2163 : :
2164 : : #ifdef USE_ASSERT_CHECKING
2165 : :
2166 : : /*
2167 : : * An LP_DEAD line pointer must be left behind when the original item
2168 : : * (which is dead to everybody) could still be referenced by a TID in
2169 : : * an index. This should never be necessary with any individual
2170 : : * heap-only tuple item, though. (It's not clear how much of a problem
2171 : : * that would be, but there is no reason to allow it.)
2172 : : */
2173 : : if (ItemIdHasStorage(lp))
2174 : : {
2175 : : Assert(ItemIdIsNormal(lp));
2176 : : htup = (HeapTupleHeader) PageGetItem(page, lp);
2177 : : Assert(!HeapTupleHeaderIsHeapOnly(htup));
2178 : : }
2179 : : else
2180 : : {
2181 : : /* Whole HOT chain becomes dead */
2182 : : Assert(ItemIdIsRedirected(lp));
2183 : : }
2184 : : #endif
2185 : :
2186 : 3997262 : ItemIdSetDead(lp);
2187 : : }
2188 : :
2189 : : /* Update all now-unused line pointers */
2190 : 81818 : offnum = nowunused;
2191 [ + + ]: 405256 : for (int i = 0; i < nunused; i++)
2192 : : {
2193 : 323438 : OffsetNumber off = *offnum++;
2194 : 323438 : ItemId lp = PageGetItemId(page, off);
2195 : :
2196 : : #ifdef USE_ASSERT_CHECKING
2197 : :
2198 : : if (lp_truncate_only)
2199 : : {
2200 : : /* Setting LP_DEAD to LP_UNUSED in vacuum's second pass */
2201 : : Assert(ItemIdIsDead(lp) && !ItemIdHasStorage(lp));
2202 : : }
2203 : : else
2204 : : {
2205 : : /*
2206 : : * When heap_page_prune_and_freeze() was called, mark_unused_now
2207 : : * may have been passed as true, which allows would-be LP_DEAD
2208 : : * items to be made LP_UNUSED instead. This is only possible if
2209 : : * the relation has no indexes. If there are any dead items, then
2210 : : * mark_unused_now was not true and every item being marked
2211 : : * LP_UNUSED must refer to a heap-only tuple.
2212 : : */
2213 : : if (ndead > 0)
2214 : : {
2215 : : Assert(ItemIdHasStorage(lp) && ItemIdIsNormal(lp));
2216 : : htup = (HeapTupleHeader) PageGetItem(page, lp);
2217 : : Assert(HeapTupleHeaderIsHeapOnly(htup));
2218 : : }
2219 : : else
2220 : : Assert(ItemIdIsUsed(lp));
2221 : : }
2222 : :
2223 : : #endif
2224 : :
2225 : 323438 : ItemIdSetUnused(lp);
2226 : : }
2227 : :
2228 [ + + ]: 81818 : if (lp_truncate_only)
2229 : 2270 : PageTruncateLinePointerArray(page);
2230 : : else
2231 : : {
2232 : : /*
2233 : : * Finally, repair any fragmentation, and update the page's hint bit
2234 : : * about whether it has free pointers.
2235 : : */
2236 : 79548 : PageRepairFragmentation(page);
2237 : :
2238 : : /*
2239 : : * Now that the page has been modified, assert that redirect items
2240 : : * still point to valid targets.
2241 : : */
2242 : 79548 : page_verify_redirects(page);
2243 : : }
2244 : 81818 : }
2245 : :
2246 : :
2247 : : /*
2248 : : * If built with assertions, verify that all LP_REDIRECT items point to a
2249 : : * valid item.
2250 : : *
2251 : : * One way that bugs related to HOT pruning show is redirect items pointing to
2252 : : * removed tuples. It's not trivial to reliably check that marking an item
2253 : : * unused will not orphan a redirect item during heap_prune_chain() /
2254 : : * heap_page_prune_execute(), so we additionally check the whole page after
2255 : : * pruning. Without this check such bugs would typically only cause asserts
2256 : : * later, potentially well after the corruption has been introduced.
2257 : : *
2258 : : * Also check comments in heap_page_prune_execute()'s redirection loop.
2259 : : */
2260 : : static void
2261 : 79548 : page_verify_redirects(Page page)
2262 : : {
2263 : : #ifdef USE_ASSERT_CHECKING
2264 : : OffsetNumber offnum;
2265 : : OffsetNumber maxoff;
2266 : :
2267 : : maxoff = PageGetMaxOffsetNumber(page);
2268 : : for (offnum = FirstOffsetNumber;
2269 : : offnum <= maxoff;
2270 : : offnum = OffsetNumberNext(offnum))
2271 : : {
2272 : : ItemId itemid = PageGetItemId(page, offnum);
2273 : : OffsetNumber targoff;
2274 : : ItemId targitem;
2275 : : HeapTupleHeader htup;
2276 : :
2277 : : if (!ItemIdIsRedirected(itemid))
2278 : : continue;
2279 : :
2280 : : targoff = ItemIdGetRedirect(itemid);
2281 : : targitem = PageGetItemId(page, targoff);
2282 : :
2283 : : Assert(ItemIdIsUsed(targitem));
2284 : : Assert(ItemIdIsNormal(targitem));
2285 : : Assert(ItemIdHasStorage(targitem));
2286 : : htup = (HeapTupleHeader) PageGetItem(page, targitem);
2287 : : Assert(HeapTupleHeaderIsHeapOnly(htup));
2288 : : }
2289 : : #endif
2290 : 79548 : }
2291 : :
2292 : :
2293 : : /*
2294 : : * For all items in this page, find their respective root line pointers.
2295 : : * If item k is part of a HOT-chain with root at item j, then we set
2296 : : * root_offsets[k - 1] = j.
2297 : : *
2298 : : * The passed-in root_offsets array must have MaxHeapTuplesPerPage entries.
2299 : : * Unused entries are filled with InvalidOffsetNumber (zero).
2300 : : *
2301 : : * The function must be called with at least share lock on the buffer, to
2302 : : * prevent concurrent prune operations.
2303 : : *
2304 : : * Note: The information collected here is valid only as long as the caller
2305 : : * holds a pin on the buffer. Once pin is released, a tuple might be pruned
2306 : : * and reused by a completely unrelated tuple.
2307 : : */
2308 : : void
2309 : 136160 : heap_get_root_tuples(Page page, OffsetNumber *root_offsets)
2310 : : {
2311 : : OffsetNumber offnum,
2312 : : maxoff;
2313 : :
2314 [ + - - + : 136160 : MemSet(root_offsets, InvalidOffsetNumber,
- - - - -
- ]
2315 : : MaxHeapTuplesPerPage * sizeof(OffsetNumber));
2316 : :
2317 : 136160 : maxoff = PageGetMaxOffsetNumber(page);
2318 [ + + ]: 10949590 : for (offnum = FirstOffsetNumber; offnum <= maxoff; offnum = OffsetNumberNext(offnum))
2319 : : {
2320 : 10813430 : ItemId lp = PageGetItemId(page, offnum);
2321 : : HeapTupleHeader htup;
2322 : : OffsetNumber nextoffnum;
2323 : : TransactionId priorXmax;
2324 : :
2325 : : /* skip unused and dead items */
2326 [ + + + + ]: 10813430 : if (!ItemIdIsUsed(lp) || ItemIdIsDead(lp))
2327 : 9398 : continue;
2328 : :
2329 [ + + ]: 10804032 : if (ItemIdIsNormal(lp))
2330 : : {
2331 : 10800135 : htup = (HeapTupleHeader) PageGetItem(page, lp);
2332 : :
2333 : : /*
2334 : : * Check if this tuple is part of a HOT-chain rooted at some other
2335 : : * tuple. If so, skip it for now; we'll process it when we find
2336 : : * its root.
2337 : : */
2338 [ + + ]: 10800135 : if (HeapTupleHeaderIsHeapOnly(htup))
2339 : 4237 : continue;
2340 : :
2341 : : /*
2342 : : * This is either a plain tuple or the root of a HOT-chain.
2343 : : * Remember it in the mapping.
2344 : : */
2345 : 10795898 : root_offsets[offnum - 1] = offnum;
2346 : :
2347 : : /* If it's not the start of a HOT-chain, we're done with it */
2348 [ + + ]: 10795898 : if (!HeapTupleHeaderIsHotUpdated(htup))
2349 : 10795634 : continue;
2350 : :
2351 : : /* Set up to scan the HOT-chain */
2352 : 264 : nextoffnum = ItemPointerGetOffsetNumber(&htup->t_ctid);
2353 : 264 : priorXmax = HeapTupleHeaderGetUpdateXid(htup);
2354 : : }
2355 : : else
2356 : : {
2357 : : /* Must be a redirect item. We do not set its root_offsets entry */
2358 : : Assert(ItemIdIsRedirected(lp));
2359 : : /* Set up to scan the HOT-chain */
2360 : 3897 : nextoffnum = ItemIdGetRedirect(lp);
2361 : 3897 : priorXmax = InvalidTransactionId;
2362 : : }
2363 : :
2364 : : /*
2365 : : * Now follow the HOT-chain and collect other tuples in the chain.
2366 : : *
2367 : : * Note: Even though this is a nested loop, the complexity of the
2368 : : * function is O(N) because a tuple in the page should be visited not
2369 : : * more than twice, once in the outer loop and once in HOT-chain
2370 : : * chases.
2371 : : */
2372 : : for (;;)
2373 : : {
2374 : : /* Sanity check (pure paranoia) */
2375 [ - + ]: 4233 : if (offnum < FirstOffsetNumber)
2376 : 0 : break;
2377 : :
2378 : : /*
2379 : : * An offset past the end of page's line pointer array is possible
2380 : : * when the array was truncated
2381 : : */
2382 [ - + ]: 4233 : if (offnum > maxoff)
2383 : 0 : break;
2384 : :
2385 : 4233 : lp = PageGetItemId(page, nextoffnum);
2386 : :
2387 : : /* Check for broken chains */
2388 [ - + ]: 4233 : if (!ItemIdIsNormal(lp))
2389 : 0 : break;
2390 : :
2391 : 4233 : htup = (HeapTupleHeader) PageGetItem(page, lp);
2392 : :
2393 [ + + - + ]: 4569 : if (TransactionIdIsValid(priorXmax) &&
2394 : 336 : !TransactionIdEquals(priorXmax, HeapTupleHeaderGetXmin(htup)))
2395 : 0 : break;
2396 : :
2397 : : /* Remember the root line pointer for this item */
2398 : 4233 : root_offsets[nextoffnum - 1] = offnum;
2399 : :
2400 : : /* Advance to next chain member, if any */
2401 [ + + ]: 4233 : if (!HeapTupleHeaderIsHotUpdated(htup))
2402 : 4161 : break;
2403 : :
2404 : : /* HOT implies it can't have moved to different partition */
2405 : : Assert(!HeapTupleHeaderIndicatesMovedPartitions(htup));
2406 : :
2407 : 72 : nextoffnum = ItemPointerGetOffsetNumber(&htup->t_ctid);
2408 : 72 : priorXmax = HeapTupleHeaderGetUpdateXid(htup);
2409 : : }
2410 : : }
2411 : 136160 : }
2412 : :
2413 : :
2414 : : /*
2415 : : * Compare fields that describe actions required to freeze tuple with caller's
2416 : : * open plan. If everything matches then the frz tuple plan is equivalent to
2417 : : * caller's plan.
2418 : : */
2419 : : static inline bool
2420 : 1203237 : heap_log_freeze_eq(xlhp_freeze_plan *plan, HeapTupleFreeze *frz)
2421 : : {
2422 [ + + ]: 1203237 : if (plan->xmax == frz->xmax &&
2423 [ + + ]: 1201942 : plan->t_infomask2 == frz->t_infomask2 &&
2424 [ + + ]: 1201104 : plan->t_infomask == frz->t_infomask &&
2425 [ + - ]: 1197869 : plan->frzflags == frz->frzflags)
2426 : 1197869 : return true;
2427 : :
2428 : : /* Caller must call heap_log_freeze_new_plan again for frz */
2429 : 5368 : return false;
2430 : : }
2431 : :
2432 : : /*
2433 : : * Comparator used to deduplicate the freeze plans used in WAL records.
2434 : : */
2435 : : static int
2436 : 1667562 : heap_log_freeze_cmp(const void *arg1, const void *arg2)
2437 : : {
2438 : 1667562 : const HeapTupleFreeze *frz1 = arg1;
2439 : 1667562 : const HeapTupleFreeze *frz2 = arg2;
2440 : :
2441 [ + + ]: 1667562 : if (frz1->xmax < frz2->xmax)
2442 : 13171 : return -1;
2443 [ + + ]: 1654391 : else if (frz1->xmax > frz2->xmax)
2444 : 14428 : return 1;
2445 : :
2446 [ + + ]: 1639963 : if (frz1->t_infomask2 < frz2->t_infomask2)
2447 : 3695 : return -1;
2448 [ + + ]: 1636268 : else if (frz1->t_infomask2 > frz2->t_infomask2)
2449 : 5896 : return 1;
2450 : :
2451 [ + + ]: 1630372 : if (frz1->t_infomask < frz2->t_infomask)
2452 : 13721 : return -1;
2453 [ + + ]: 1616651 : else if (frz1->t_infomask > frz2->t_infomask)
2454 : 17092 : return 1;
2455 : :
2456 [ - + ]: 1599559 : if (frz1->frzflags < frz2->frzflags)
2457 : 0 : return -1;
2458 [ - + ]: 1599559 : else if (frz1->frzflags > frz2->frzflags)
2459 : 0 : return 1;
2460 : :
2461 : : /*
2462 : : * heap_log_freeze_eq would consider these tuple-wise plans to be equal.
2463 : : * (So the tuples will share a single canonical freeze plan.)
2464 : : *
2465 : : * We tiebreak on page offset number to keep each freeze plan's page
2466 : : * offset number array individually sorted. (Unnecessary, but be tidy.)
2467 : : */
2468 [ + + ]: 1599559 : if (frz1->offset < frz2->offset)
2469 : 1362263 : return -1;
2470 [ + - ]: 237296 : else if (frz1->offset > frz2->offset)
2471 : 237296 : return 1;
2472 : :
2473 : : Assert(false);
2474 : 0 : return 0;
2475 : : }
2476 : :
2477 : : /*
2478 : : * Start new plan initialized using tuple-level actions. At least one tuple
2479 : : * will have steps required to freeze described by caller's plan during REDO.
2480 : : */
2481 : : static inline void
2482 : 31842 : heap_log_freeze_new_plan(xlhp_freeze_plan *plan, HeapTupleFreeze *frz)
2483 : : {
2484 : 31842 : plan->xmax = frz->xmax;
2485 : 31842 : plan->t_infomask2 = frz->t_infomask2;
2486 : 31842 : plan->t_infomask = frz->t_infomask;
2487 : 31842 : plan->frzflags = frz->frzflags;
2488 : 31842 : plan->ntuples = 1; /* for now */
2489 : 31842 : }
2490 : :
2491 : : /*
2492 : : * Deduplicate tuple-based freeze plans so that each distinct set of
2493 : : * processing steps is only stored once in the WAL record.
2494 : : * Called during original execution of freezing (for logged relations).
2495 : : *
2496 : : * Return value is number of plans set in *plans_out for caller. Also writes
2497 : : * an array of offset numbers into *offsets_out output argument for caller
2498 : : * (actually there is one array per freeze plan, but that's not of immediate
2499 : : * concern to our caller).
2500 : : */
2501 : : static int
2502 : 26474 : heap_log_freeze_plan(HeapTupleFreeze *tuples, int ntuples,
2503 : : xlhp_freeze_plan *plans_out,
2504 : : OffsetNumber *offsets_out)
2505 : : {
2506 : 26474 : int nplans = 0;
2507 : :
2508 : : /* Sort tuple-based freeze plans in the order required to deduplicate */
2509 : 26474 : qsort(tuples, ntuples, sizeof(HeapTupleFreeze), heap_log_freeze_cmp);
2510 : :
2511 [ + + ]: 1256185 : for (int i = 0; i < ntuples; i++)
2512 : : {
2513 : 1229711 : HeapTupleFreeze *frz = tuples + i;
2514 : :
2515 [ + + ]: 1229711 : if (i == 0)
2516 : : {
2517 : : /* New canonical freeze plan starting with first tup */
2518 : 26474 : heap_log_freeze_new_plan(plans_out, frz);
2519 : 26474 : nplans++;
2520 : : }
2521 [ + + ]: 1203237 : else if (heap_log_freeze_eq(plans_out, frz))
2522 : : {
2523 : : /* tup matches open canonical plan -- include tup in it */
2524 : : Assert(offsets_out[i - 1] < frz->offset);
2525 : 1197869 : plans_out->ntuples++;
2526 : : }
2527 : : else
2528 : : {
2529 : : /* Tup doesn't match current plan -- done with it now */
2530 : 5368 : plans_out++;
2531 : :
2532 : : /* New canonical freeze plan starting with this tup */
2533 : 5368 : heap_log_freeze_new_plan(plans_out, frz);
2534 : 5368 : nplans++;
2535 : : }
2536 : :
2537 : : /*
2538 : : * Save page offset number in dedicated buffer in passing.
2539 : : *
2540 : : * REDO routine relies on the record's offset numbers array grouping
2541 : : * offset numbers by freeze plan. The sort order within each grouping
2542 : : * is ascending offset number order, just to keep things tidy.
2543 : : */
2544 : 1229711 : offsets_out[i] = frz->offset;
2545 : : }
2546 : :
2547 : : Assert(nplans > 0 && nplans <= ntuples);
2548 : :
2549 : 26474 : return nplans;
2550 : : }
2551 : :
2552 : : /*
2553 : : * Write an XLOG_HEAP2_PRUNE* WAL record
2554 : : *
2555 : : * This is used for several different page maintenance operations:
2556 : : *
2557 : : * - Page pruning, in VACUUM's 1st pass or on access: Some items are
2558 : : * redirected, some marked dead, and some removed altogether.
2559 : : *
2560 : : * - Freezing: Items are marked as 'frozen'.
2561 : : *
2562 : : * - Vacuum, 2nd pass: Items that are already LP_DEAD are marked as unused.
2563 : : *
2564 : : * They have enough commonalities that we use a single WAL record for them
2565 : : * all.
2566 : : *
2567 : : * If replaying the record requires a cleanup lock, pass cleanup_lock = true.
2568 : : * Replaying 'redirected' or 'dead' items always requires a cleanup lock, but
2569 : : * replaying 'unused' items depends on whether they were all previously marked
2570 : : * as dead.
2571 : : *
2572 : : * If the VM is being updated, vmflags will contain the bits to set. In this
2573 : : * case, vmbuffer should already have been updated and marked dirty and should
2574 : : * still be pinned and locked.
2575 : : *
2576 : : * Note: This function scribbles on the 'frozen' array.
2577 : : *
2578 : : * Note: This is called in a critical section, so careful what you do here.
2579 : : */
2580 : : void
2581 : 143056 : log_heap_prune_and_freeze(Relation relation, Buffer buffer,
2582 : : Buffer vmbuffer, uint8 vmflags,
2583 : : TransactionId conflict_xid,
2584 : : bool cleanup_lock,
2585 : : PruneReason reason,
2586 : : HeapTupleFreeze *frozen, int nfrozen,
2587 : : OffsetNumber *redirected, int nredirected,
2588 : : OffsetNumber *dead, int ndead,
2589 : : OffsetNumber *unused, int nunused)
2590 : : {
2591 : : xl_heap_prune xlrec;
2592 : : XLogRecPtr recptr;
2593 : : uint8 info;
2594 : : uint8 regbuf_flags_heap;
2595 : :
2596 : 143056 : Page heap_page = BufferGetPage(buffer);
2597 : :
2598 : : /* The following local variables hold data registered in the WAL record: */
2599 : : xlhp_freeze_plan plans[MaxHeapTuplesPerPage];
2600 : : xlhp_freeze_plans freeze_plans;
2601 : : xlhp_prune_items redirect_items;
2602 : : xlhp_prune_items dead_items;
2603 : : xlhp_prune_items unused_items;
2604 : : OffsetNumber frz_offsets[MaxHeapTuplesPerPage];
2605 [ + + + + : 143056 : bool do_prune = nredirected > 0 || ndead > 0 || nunused > 0;
+ + ]
2606 : 143056 : bool do_set_vm = vmflags & VISIBILITYMAP_VALID_BITS;
2607 : 143056 : bool heap_fpi_allowed = true;
2608 : :
2609 : : Assert((vmflags & VISIBILITYMAP_VALID_BITS) == vmflags);
2610 : :
2611 : 143056 : xlrec.flags = 0;
2612 : 143056 : regbuf_flags_heap = REGBUF_STANDARD;
2613 : :
2614 : : /*
2615 : : * We can avoid an FPI of the heap page if the only modification we are
2616 : : * making to it is to set PD_ALL_VISIBLE and checksums/wal_log_hints are
2617 : : * disabled.
2618 : : *
2619 : : * However, if the page has never been WAL-logged (LSN is invalid), we
2620 : : * must force an FPI regardless. This can happen when another backend
2621 : : * extends the heap, initializes the page, and then fails before WAL-
2622 : : * logging it. Since heap extension is not WAL-logged, recovery might try
2623 : : * to replay our record and find that the page isn't initialized, which
2624 : : * would cause a PANIC.
2625 : : */
2626 [ - + ]: 143056 : if (!XLogRecPtrIsValid(PageGetLSN(heap_page)))
2627 : 0 : regbuf_flags_heap |= REGBUF_FORCE_IMAGE;
2628 [ + + + + : 143056 : else if (!do_prune && nfrozen == 0 && (!do_set_vm || !XLogHintBitIsNeeded()))
+ - + + +
+ ]
2629 : : {
2630 : 2664 : regbuf_flags_heap |= REGBUF_NO_IMAGE;
2631 : 2664 : heap_fpi_allowed = false;
2632 : : }
2633 : :
2634 : : /*
2635 : : * Prepare data for the buffer. The arrays are not actually in the
2636 : : * buffer, but we pretend that they are. When XLogInsert stores a full
2637 : : * page image, the arrays can be omitted.
2638 : : */
2639 : 143056 : XLogBeginInsert();
2640 : 143056 : XLogRegisterBuffer(0, buffer, regbuf_flags_heap);
2641 : :
2642 [ + + ]: 143056 : if (do_set_vm)
2643 : 71156 : XLogRegisterBuffer(1, vmbuffer, 0);
2644 : :
2645 [ + + ]: 143056 : if (nfrozen > 0)
2646 : : {
2647 : : int nplans;
2648 : :
2649 : 26474 : xlrec.flags |= XLHP_HAS_FREEZE_PLANS;
2650 : :
2651 : : /*
2652 : : * Prepare deduplicated representation for use in the WAL record. This
2653 : : * destructively sorts frozen tuples array in-place.
2654 : : */
2655 : 26474 : nplans = heap_log_freeze_plan(frozen, nfrozen, plans, frz_offsets);
2656 : :
2657 : 26474 : freeze_plans.nplans = nplans;
2658 : 26474 : XLogRegisterBufData(0, &freeze_plans,
2659 : : offsetof(xlhp_freeze_plans, plans));
2660 : 26474 : XLogRegisterBufData(0, plans,
2661 : : sizeof(xlhp_freeze_plan) * nplans);
2662 : : }
2663 [ + + ]: 143056 : if (nredirected > 0)
2664 : : {
2665 : 18381 : xlrec.flags |= XLHP_HAS_REDIRECTIONS;
2666 : :
2667 : 18381 : redirect_items.ntargets = nredirected;
2668 : 18381 : XLogRegisterBufData(0, &redirect_items,
2669 : : offsetof(xlhp_prune_items, data));
2670 : 18381 : XLogRegisterBufData(0, redirected,
2671 : : sizeof(OffsetNumber[2]) * nredirected);
2672 : : }
2673 [ + + ]: 143056 : if (ndead > 0)
2674 : : {
2675 : 56448 : xlrec.flags |= XLHP_HAS_DEAD_ITEMS;
2676 : :
2677 : 56448 : dead_items.ntargets = ndead;
2678 : 56448 : XLogRegisterBufData(0, &dead_items,
2679 : : offsetof(xlhp_prune_items, data));
2680 : 56448 : XLogRegisterBufData(0, dead,
2681 : : sizeof(OffsetNumber) * ndead);
2682 : : }
2683 [ + + ]: 143056 : if (nunused > 0)
2684 : : {
2685 : 29543 : xlrec.flags |= XLHP_HAS_NOW_UNUSED_ITEMS;
2686 : :
2687 : 29543 : unused_items.ntargets = nunused;
2688 : 29543 : XLogRegisterBufData(0, &unused_items,
2689 : : offsetof(xlhp_prune_items, data));
2690 : 29543 : XLogRegisterBufData(0, unused,
2691 : : sizeof(OffsetNumber) * nunused);
2692 : : }
2693 [ + + ]: 143056 : if (nfrozen > 0)
2694 : 26474 : XLogRegisterBufData(0, frz_offsets,
2695 : : sizeof(OffsetNumber) * nfrozen);
2696 : :
2697 : : /*
2698 : : * Prepare the main xl_heap_prune record. We already set the XLHP_HAS_*
2699 : : * flag above.
2700 : : */
2701 [ + + ]: 143056 : if (vmflags & VISIBILITYMAP_ALL_VISIBLE)
2702 : : {
2703 : 71156 : xlrec.flags |= XLHP_VM_ALL_VISIBLE;
2704 [ + + ]: 71156 : if (vmflags & VISIBILITYMAP_ALL_FROZEN)
2705 : 44396 : xlrec.flags |= XLHP_VM_ALL_FROZEN;
2706 : : }
2707 [ + + + + : 143056 : if (RelationIsAccessibleInLogicalDecoding(relation))
+ - - + -
- - - + +
+ + - + -
- + - ]
2708 : 631 : xlrec.flags |= XLHP_IS_CATALOG_REL;
2709 [ + + ]: 143056 : if (TransactionIdIsValid(conflict_xid))
2710 : 114489 : xlrec.flags |= XLHP_HAS_CONFLICT_HORIZON;
2711 [ + + ]: 143056 : if (cleanup_lock)
2712 : 128303 : xlrec.flags |= XLHP_CLEANUP_LOCK;
2713 : : else
2714 : : {
2715 : : Assert(nredirected == 0 && ndead == 0);
2716 : : /* also, any items in 'unused' must've been LP_DEAD previously */
2717 : : }
2718 : 143056 : XLogRegisterData(&xlrec, SizeOfHeapPrune);
2719 [ + + ]: 143056 : if (TransactionIdIsValid(conflict_xid))
2720 : 114489 : XLogRegisterData(&conflict_xid, sizeof(TransactionId));
2721 : :
2722 [ + + + - ]: 143056 : switch (reason)
2723 : : {
2724 : 71292 : case PRUNE_ON_ACCESS:
2725 : 71292 : info = XLOG_HEAP2_PRUNE_ON_ACCESS;
2726 : 71292 : break;
2727 : 57011 : case PRUNE_VACUUM_SCAN:
2728 : 57011 : info = XLOG_HEAP2_PRUNE_VACUUM_SCAN;
2729 : 57011 : break;
2730 : 14753 : case PRUNE_VACUUM_CLEANUP:
2731 : 14753 : info = XLOG_HEAP2_PRUNE_VACUUM_CLEANUP;
2732 : 14753 : break;
2733 : 0 : default:
2734 [ # # ]: 0 : elog(ERROR, "unrecognized prune reason: %d", (int) reason);
2735 : : break;
2736 : : }
2737 : 143056 : recptr = XLogInsert(RM_HEAP2_ID, info);
2738 : :
2739 [ + + ]: 143056 : if (do_set_vm)
2740 : : {
2741 : : Assert(BufferIsDirty(vmbuffer));
2742 : 71156 : PageSetLSN(BufferGetPage(vmbuffer), recptr);
2743 : : }
2744 : :
2745 : : /*
2746 : : * If we explicitly skip an FPI, we must not stamp the heap page with this
2747 : : * record's LSN. Recovery skips records <= the stamped LSN, so this could
2748 : : * lead to skipping an earlier FPI needed to repair a torn page.
2749 : : */
2750 [ + + ]: 143056 : if (heap_fpi_allowed)
2751 : : {
2752 : : Assert(BufferIsDirty(buffer));
2753 : 140392 : PageSetLSN(heap_page, recptr);
2754 : : }
2755 : 143056 : }
|
