PostgreSQL Source Code  git master
visibilitymap.h File Reference
#include "access/visibilitymapdefs.h"
#include "access/xlogdefs.h"
#include "storage/block.h"
#include "storage/buf.h"
#include "utils/relcache.h"
Include dependency graph for visibilitymap.h:
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Macros

#define VM_ALL_VISIBLE(r, b, v)    ((visibilitymap_get_status((r), (b), (v)) & VISIBILITYMAP_ALL_VISIBLE) != 0)
 
#define VM_ALL_FROZEN(r, b, v)    ((visibilitymap_get_status((r), (b), (v)) & VISIBILITYMAP_ALL_FROZEN) != 0)
 

Functions

bool visibilitymap_clear (Relation rel, BlockNumber heapBlk, Buffer vmbuf, uint8 flags)
 
void visibilitymap_pin (Relation rel, BlockNumber heapBlk, Buffer *vmbuf)
 
bool visibilitymap_pin_ok (BlockNumber heapBlk, Buffer vmbuf)
 
void visibilitymap_set (Relation rel, BlockNumber heapBlk, Buffer heapBuf, XLogRecPtr recptr, Buffer vmBuf, TransactionId cutoff_xid, uint8 flags)
 
uint8 visibilitymap_get_status (Relation rel, BlockNumber heapBlk, Buffer *vmbuf)
 
void visibilitymap_count (Relation rel, BlockNumber *all_visible, BlockNumber *all_frozen)
 
BlockNumber visibilitymap_prepare_truncate (Relation rel, BlockNumber nheapblocks)
 

Macro Definition Documentation

◆ VM_ALL_FROZEN

#define VM_ALL_FROZEN (   r,
  b,
 
)     ((visibilitymap_get_status((r), (b), (v)) & VISIBILITYMAP_ALL_FROZEN) != 0)

Definition at line 26 of file visibilitymap.h.

◆ VM_ALL_VISIBLE

#define VM_ALL_VISIBLE (   r,
  b,
 
)     ((visibilitymap_get_status((r), (b), (v)) & VISIBILITYMAP_ALL_VISIBLE) != 0)

Definition at line 24 of file visibilitymap.h.

Function Documentation

◆ visibilitymap_clear()

bool visibilitymap_clear ( Relation  rel,
BlockNumber  heapBlk,
Buffer  vmbuf,
uint8  flags 
)

Definition at line 138 of file visibilitymap.c.

141 {
142  BlockNumber mapBlock = HEAPBLK_TO_MAPBLOCK(heapBlk);
143  int mapByte = HEAPBLK_TO_MAPBYTE(heapBlk);
144  int mapOffset = HEAPBLK_TO_OFFSET(heapBlk);
145  uint8 mask = flags << mapOffset;
146  char *map;
147  bool cleared = false;
148 
150 
151 #ifdef TRACE_VISIBILITYMAP
152  elog(DEBUG1, "vm_clear %s %d", RelationGetRelationName(rel), heapBlk);
153 #endif
154 
155  if (!BufferIsValid(buf) || BufferGetBlockNumber(buf) != mapBlock)
156  elog(ERROR, "wrong buffer passed to visibilitymap_clear");
157 
160 
161  if (map[mapByte] & mask)
162  {
163  map[mapByte] &= ~mask;
164 
166  cleared = true;
167  }
168 
170 
uint32 BlockNumber
Definition: block.h:31
BlockNumber BufferGetBlockNumber(Buffer buffer)
Definition: bufmgr.c:2755
void MarkBufferDirty(Buffer buffer)
Definition: bufmgr.c:1573
void LockBuffer(Buffer buffer, int mode)
Definition: bufmgr.c:4156
#define BUFFER_LOCK_UNLOCK
Definition: bufmgr.h:96
#define BufferIsValid(bufnum)
Definition: bufmgr.h:123
#define BUFFER_LOCK_EXCLUSIVE
Definition: bufmgr.h:98
#define BufferGetPage(buffer)
Definition: bufmgr.h:169
#define PageGetContents(page)
Definition: bufpage.h:245
unsigned char uint8
Definition: c.h:439
#define DEBUG1
Definition: elog.h:24
#define ERROR
Definition: elog.h:33
#define elog(elevel,...)
Definition: elog.h:218
Assert(fmt[strlen(fmt) - 1] !='\n')
static char * buf
Definition: pg_test_fsync.c:67
#define RelationGetRelationName(relation)
Definition: rel.h:522
#define HEAPBLK_TO_OFFSET(x)
#define HEAPBLK_TO_MAPBLOCK(x)
#define HEAPBLK_TO_MAPBYTE(x)
#define VISIBILITYMAP_VALID_BITS

References Assert(), buf, BUFFER_LOCK_EXCLUSIVE, BUFFER_LOCK_UNLOCK, BufferGetBlockNumber(), BufferGetPage, BufferIsValid, DEBUG1, elog, ERROR, HEAPBLK_TO_MAPBLOCK, HEAPBLK_TO_MAPBYTE, HEAPBLK_TO_OFFSET, LockBuffer(), MarkBufferDirty(), PageGetContents, RelationGetRelationName, and VISIBILITYMAP_VALID_BITS.

Referenced by heap_delete(), heap_force_common(), heap_insert(), heap_lock_tuple(), heap_lock_updated_tuple_rec(), heap_multi_insert(), heap_update(), heap_xlog_delete(), heap_xlog_insert(), heap_xlog_lock(), heap_xlog_lock_updated(), heap_xlog_multi_insert(), heap_xlog_update(), and lazy_scan_heap().

◆ visibilitymap_count()

void visibilitymap_count ( Relation  rel,
BlockNumber all_visible,
BlockNumber all_frozen 
)

Definition at line 377 of file visibilitymap.c.

380 {
381  BlockNumber mapBlock;
382  BlockNumber nvisible = 0;
383  BlockNumber nfrozen = 0;
384 
385  /* all_visible must be specified */
386  Assert(all_visible);
387 
388  for (mapBlock = 0;; mapBlock++)
389  {
390  Buffer mapBuffer;
391  uint64 *map;
392  int i;
393 
394  /*
395  * Read till we fall off the end of the map. We assume that any extra
396  * bytes in the last page are zeroed, so we don't bother excluding
397  * them from the count.
398  */
399  mapBuffer = vm_readbuf(rel, mapBlock, false);
400  if (!BufferIsValid(mapBuffer))
401  break;
402 
403  /*
404  * We choose not to lock the page, since the result is going to be
405  * immediately stale anyway if anyone is concurrently setting or
406  * clearing bits, and we only really need an approximate value.
407  */
408  map = (uint64 *) PageGetContents(BufferGetPage(mapBuffer));
409 
410  StaticAssertStmt(MAPSIZE % sizeof(uint64) == 0,
411  "unsupported MAPSIZE");
412  if (all_frozen == NULL)
413  {
414  for (i = 0; i < MAPSIZE / sizeof(uint64); i++)
415  nvisible += pg_popcount64(map[i] & VISIBLE_MASK64);
416  }
417  else
418  {
419  for (i = 0; i < MAPSIZE / sizeof(uint64); i++)
420  {
421  nvisible += pg_popcount64(map[i] & VISIBLE_MASK64);
422  nfrozen += pg_popcount64(map[i] & FROZEN_MASK64);
423  }
424  }
425 
426  ReleaseBuffer(mapBuffer);
427  }
428 
429  *all_visible = nvisible;
430  if (all_frozen)
int Buffer
Definition: buf.h:23
void ReleaseBuffer(Buffer buffer)
Definition: bufmgr.c:3915
#define StaticAssertStmt(condition, errmessage)
Definition: c.h:918
int i
Definition: isn.c:73
int pg_popcount64(uint64 word)
Definition: pg_bitutils.c:284
#define MAPSIZE
#define VISIBLE_MASK64
static Buffer vm_readbuf(Relation rel, BlockNumber blkno, bool extend)
#define FROZEN_MASK64

References Assert(), BufferGetPage, BufferIsValid, FROZEN_MASK64, i, MAPSIZE, PageGetContents, pg_popcount64(), ReleaseBuffer(), StaticAssertStmt, VISIBLE_MASK64, and vm_readbuf().

Referenced by do_analyze_rel(), heap_vacuum_rel(), and index_update_stats().

◆ visibilitymap_get_status()

uint8 visibilitymap_get_status ( Relation  rel,
BlockNumber  heapBlk,
Buffer vmbuf 
)

Definition at line 329 of file visibilitymap.c.

332 {
333  BlockNumber mapBlock = HEAPBLK_TO_MAPBLOCK(heapBlk);
334  uint32 mapByte = HEAPBLK_TO_MAPBYTE(heapBlk);
335  uint8 mapOffset = HEAPBLK_TO_OFFSET(heapBlk);
336  char *map;
337  uint8 result;
338 
339 #ifdef TRACE_VISIBILITYMAP
340  elog(DEBUG1, "vm_get_status %s %d", RelationGetRelationName(rel), heapBlk);
341 #endif
342 
343  /* Reuse the old pinned buffer if possible */
344  if (BufferIsValid(*buf))
345  {
346  if (BufferGetBlockNumber(*buf) != mapBlock)
347  {
348  ReleaseBuffer(*buf);
349  *buf = InvalidBuffer;
350  }
351  }
352 
353  if (!BufferIsValid(*buf))
354  {
355  *buf = vm_readbuf(rel, mapBlock, false);
356  if (!BufferIsValid(*buf))
357  return false;
358  }
359 
361 
362  /*
363  * A single byte read is atomic. There could be memory-ordering effects
364  * here, but for performance reasons we make it the caller's job to worry
365  * about that.
366  */
367  result = ((map[mapByte] >> mapOffset) & VISIBILITYMAP_VALID_BITS);
#define InvalidBuffer
Definition: buf.h:25
unsigned int uint32
Definition: c.h:441

References buf, BufferGetBlockNumber(), BufferGetPage, BufferIsValid, DEBUG1, elog, HEAPBLK_TO_MAPBLOCK, HEAPBLK_TO_MAPBYTE, HEAPBLK_TO_OFFSET, InvalidBuffer, PageGetContents, RelationGetRelationName, ReleaseBuffer(), VISIBILITYMAP_VALID_BITS, and vm_readbuf().

Referenced by collect_visibility_data(), lazy_scan_skip(), lazy_vacuum_heap_page(), pg_visibility(), pg_visibility_map(), pg_visibility_map_summary(), and verify_heapam().

◆ visibilitymap_pin()

void visibilitymap_pin ( Relation  rel,
BlockNumber  heapBlk,
Buffer vmbuf 
)

◆ visibilitymap_pin_ok()

bool visibilitymap_pin_ok ( BlockNumber  heapBlk,
Buffer  vmbuf 
)

Definition at line 213 of file visibilitymap.c.

216 {
217  BlockNumber mapBlock = HEAPBLK_TO_MAPBLOCK(heapBlk);
218 

References buf, BufferGetBlockNumber(), BufferIsValid, and HEAPBLK_TO_MAPBLOCK.

Referenced by GetVisibilityMapPins(), and heap_multi_insert().

◆ visibilitymap_prepare_truncate()

BlockNumber visibilitymap_prepare_truncate ( Relation  rel,
BlockNumber  nheapblocks 
)

Definition at line 444 of file visibilitymap.c.

447 {
448  BlockNumber newnblocks;
449 
450  /* last remaining block, byte, and bit */
451  BlockNumber truncBlock = HEAPBLK_TO_MAPBLOCK(nheapblocks);
452  uint32 truncByte = HEAPBLK_TO_MAPBYTE(nheapblocks);
453  uint8 truncOffset = HEAPBLK_TO_OFFSET(nheapblocks);
454 
455 #ifdef TRACE_VISIBILITYMAP
456  elog(DEBUG1, "vm_truncate %s %d", RelationGetRelationName(rel), nheapblocks);
457 #endif
458 
459  /*
460  * If no visibility map has been created yet for this relation, there's
461  * nothing to truncate.
462  */
464  return InvalidBlockNumber;
465 
466  /*
467  * Unless the new size is exactly at a visibility map page boundary, the
468  * tail bits in the last remaining map page, representing truncated heap
469  * blocks, need to be cleared. This is not only tidy, but also necessary
470  * because we don't get a chance to clear the bits if the heap is extended
471  * again.
472  */
473  if (truncByte != 0 || truncOffset != 0)
474  {
475  Buffer mapBuffer;
476  Page page;
477  char *map;
478 
479  newnblocks = truncBlock + 1;
480 
481  mapBuffer = vm_readbuf(rel, truncBlock, false);
482  if (!BufferIsValid(mapBuffer))
483  {
484  /* nothing to do, the file was already smaller */
485  return InvalidBlockNumber;
486  }
487 
488  page = BufferGetPage(mapBuffer);
489  map = PageGetContents(page);
490 
491  LockBuffer(mapBuffer, BUFFER_LOCK_EXCLUSIVE);
492 
493  /* NO EREPORT(ERROR) from here till changes are logged */
495 
496  /* Clear out the unwanted bytes. */
497  MemSet(&map[truncByte + 1], 0, MAPSIZE - (truncByte + 1));
498 
499  /*----
500  * Mask out the unwanted bits of the last remaining byte.
501  *
502  * ((1 << 0) - 1) = 00000000
503  * ((1 << 1) - 1) = 00000001
504  * ...
505  * ((1 << 6) - 1) = 00111111
506  * ((1 << 7) - 1) = 01111111
507  *----
508  */
509  map[truncByte] &= (1 << truncOffset) - 1;
510 
511  /*
512  * Truncation of a relation is WAL-logged at a higher-level, and we
513  * will be called at WAL replay. But if checksums are enabled, we need
514  * to still write a WAL record to protect against a torn page, if the
515  * page is flushed to disk before the truncation WAL record. We cannot
516  * use MarkBufferDirtyHint here, because that will not dirty the page
517  * during recovery.
518  */
519  MarkBufferDirty(mapBuffer);
521  log_newpage_buffer(mapBuffer, false);
522 
524 
525  UnlockReleaseBuffer(mapBuffer);
526  }
527  else
528  newnblocks = truncBlock;
529 
530  if (smgrnblocks(RelationGetSmgr(rel), VISIBILITYMAP_FORKNUM) <= newnblocks)
531  {
532  /* nothing to do, the file was already smaller than requested size */
533  return InvalidBlockNumber;
534  }
535 
#define InvalidBlockNumber
Definition: block.h:33
void UnlockReleaseBuffer(Buffer buffer)
Definition: bufmgr.c:3938
Pointer Page
Definition: bufpage.h:78
#define MemSet(start, val, len)
Definition: c.h:1008
#define START_CRIT_SECTION()
Definition: miscadmin.h:148
#define END_CRIT_SECTION()
Definition: miscadmin.h:150
static SMgrRelation RelationGetSmgr(Relation rel)
Definition: rel.h:555
#define RelationNeedsWAL(relation)
Definition: rel.h:612
@ VISIBILITYMAP_FORKNUM
Definition: relpath.h:45
BlockNumber smgrnblocks(SMgrRelation reln, ForkNumber forknum)
Definition: smgr.c:579
bool smgrexists(SMgrRelation reln, ForkNumber forknum)
Definition: smgr.c:247
#define XLogHintBitIsNeeded()
Definition: xlog.h:115
XLogRecPtr log_newpage_buffer(Buffer buffer, bool page_std)
Definition: xloginsert.c:1177
bool InRecovery
Definition: xlogutils.c:53

References BUFFER_LOCK_EXCLUSIVE, BufferGetPage, BufferIsValid, DEBUG1, elog, END_CRIT_SECTION, HEAPBLK_TO_MAPBLOCK, HEAPBLK_TO_MAPBYTE, HEAPBLK_TO_OFFSET, InRecovery, InvalidBlockNumber, LockBuffer(), log_newpage_buffer(), MAPSIZE, MarkBufferDirty(), MemSet, PageGetContents, RelationGetRelationName, RelationGetSmgr(), RelationNeedsWAL, smgrexists(), smgrnblocks(), START_CRIT_SECTION, UnlockReleaseBuffer(), VISIBILITYMAP_FORKNUM, vm_readbuf(), and XLogHintBitIsNeeded.

Referenced by pg_truncate_visibility_map(), RelationTruncate(), and smgr_redo().

◆ visibilitymap_set()

void visibilitymap_set ( Relation  rel,
BlockNumber  heapBlk,
Buffer  heapBuf,
XLogRecPtr  recptr,
Buffer  vmBuf,
TransactionId  cutoff_xid,
uint8  flags 
)

Definition at line 242 of file visibilitymap.c.

247 {
248  BlockNumber mapBlock = HEAPBLK_TO_MAPBLOCK(heapBlk);
249  uint32 mapByte = HEAPBLK_TO_MAPBYTE(heapBlk);
250  uint8 mapOffset = HEAPBLK_TO_OFFSET(heapBlk);
251  Page page;
252  uint8 *map;
253 
254 #ifdef TRACE_VISIBILITYMAP
255  elog(DEBUG1, "vm_set %s %d", RelationGetRelationName(rel), heapBlk);
256 #endif
257 
259  Assert(InRecovery || BufferIsValid(heapBuf));
261 
262  /* Check that we have the right heap page pinned, if present */
263  if (BufferIsValid(heapBuf) && BufferGetBlockNumber(heapBuf) != heapBlk)
264  elog(ERROR, "wrong heap buffer passed to visibilitymap_set");
265 
266  /* Check that we have the right VM page pinned */
267  if (!BufferIsValid(vmBuf) || BufferGetBlockNumber(vmBuf) != mapBlock)
268  elog(ERROR, "wrong VM buffer passed to visibilitymap_set");
269 
270  page = BufferGetPage(vmBuf);
271  map = (uint8 *) PageGetContents(page);
273 
274  if (flags != (map[mapByte] >> mapOffset & VISIBILITYMAP_VALID_BITS))
275  {
277 
278  map[mapByte] |= (flags << mapOffset);
279  MarkBufferDirty(vmBuf);
280 
281  if (RelationNeedsWAL(rel))
282  {
283  if (XLogRecPtrIsInvalid(recptr))
284  {
285  Assert(!InRecovery);
286  recptr = log_heap_visible(rel->rd_node, heapBuf, vmBuf,
287  cutoff_xid, flags);
288 
289  /*
290  * If data checksums are enabled (or wal_log_hints=on), we
291  * need to protect the heap page from being torn.
292  */
293  if (XLogHintBitIsNeeded())
294  {
295  Page heapPage = BufferGetPage(heapBuf);
296 
297  /* caller is expected to set PD_ALL_VISIBLE first */
298  Assert(PageIsAllVisible(heapPage));
299  PageSetLSN(heapPage, recptr);
300  }
301  }
302  PageSetLSN(page, recptr);
303  }
304 
306  }
307 
#define PageIsAllVisible(page)
Definition: bufpage.h:384
#define PageSetLSN(page, lsn)
Definition: bufpage.h:367
XLogRecPtr log_heap_visible(RelFileNode rnode, Buffer heap_buffer, Buffer vm_buffer, TransactionId cutoff_xid, uint8 vmflags)
Definition: heapam.c:8192
RelFileNode rd_node
Definition: rel.h:56
#define XLogRecPtrIsInvalid(r)
Definition: xlogdefs.h:29

References Assert(), BUFFER_LOCK_EXCLUSIVE, BUFFER_LOCK_UNLOCK, BufferGetBlockNumber(), BufferGetPage, BufferIsValid, DEBUG1, elog, END_CRIT_SECTION, ERROR, HEAPBLK_TO_MAPBLOCK, HEAPBLK_TO_MAPBYTE, HEAPBLK_TO_OFFSET, InRecovery, LockBuffer(), log_heap_visible(), MarkBufferDirty(), PageGetContents, PageIsAllVisible, PageSetLSN, RelationData::rd_node, RelationGetRelationName, RelationNeedsWAL, START_CRIT_SECTION, VISIBILITYMAP_VALID_BITS, XLogHintBitIsNeeded, and XLogRecPtrIsInvalid.

Referenced by heap_multi_insert(), heap_xlog_visible(), lazy_scan_heap(), lazy_scan_new_or_empty(), and lazy_vacuum_heap_page().