src/include/access/visibilitymap.h

   1 /*-------------------------------------------------------------------------
   2  *
   3  * visibilitymap.h
   4  *              visibility map interface
   5  *
   6  *
   7  * Portions Copyright (c) 2007-2025, PostgreSQL Global Development Group
   8  * Portions Copyright (c) 1994, Regents of the University of California
   9  *
  10  * src/include/access/visibilitymap.h
  11  *
  12  *-------------------------------------------------------------------------
  13  */
  14 #ifndef VISIBILITYMAP_H
  15 #define VISIBILITYMAP_H
  16
  17 #include "access/visibilitymapdefs.h"
  18 #include "access/xlogdefs.h"
  19 #include "storage/block.h"
  20 #include "storage/buf.h"
  21 #include "utils/relcache.h"
  22
  23 /* Macros for visibilitymap test */
  24 #define VM_ALL_VISIBLE(r, b, v) \
  25         ((visibilitymap_get_status((r), (b), (v)) & VISIBILITYMAP_ALL_VISIBLE) != 0)
  26 #define VM_ALL_FROZEN(r, b, v) \
  27         ((visibilitymap_get_status((r), (b), (v)) & VISIBILITYMAP_ALL_FROZEN) != 0)
  28
  29 extern bool visibilitymap_clear(Relation rel, BlockNumber heapBlk,
  30                                                                 Buffer vmbuf, uint8 flags);
  31 extern void visibilitymap_pin(Relation rel, BlockNumber heapBlk,
  32                                                           Buffer *vmbuf);
  33 extern bool visibilitymap_pin_ok(BlockNumber heapBlk, Buffer vmbuf);
  34 extern uint8 visibilitymap_set(Relation rel,
  35                                                            BlockNumber heapBlk, Buffer heapBuf,
  36                                                            XLogRecPtr recptr,
  37                                                            Buffer vmBuf,
  38                                                            TransactionId cutoff_xid,
  39                                                            uint8 flags);
  40 extern uint8 visibilitymap_get_status(Relation rel, BlockNumber heapBlk, Buffer *vmbuf);
  41 extern void visibilitymap_count(Relation rel, BlockNumber *all_visible, BlockNumber *all_frozen);
  42 extern BlockNumber visibilitymap_prepare_truncate(Relation rel,
  43                                                                                                   BlockNumber nheapblocks);
  44
  45 #endif                                                  /* VISIBILITYMAP_H */