1 /*------------------------------------------------------------------------- 2 * 3 * heapam.h 4 * POSTGRES heap access method definitions. 5 * 6 * 7 * Portions Copyright (c) 1996-2020, PostgreSQL Global Development Group 8 * Portions Copyright (c) 1994, Regents of the University of California 9 * 10 * src/include/access/heapam.h 11 * 12 *------------------------------------------------------------------------- 13 */ 14 #ifndef HEAPAM_H 15 #define HEAPAM_H 16 17 #include "access/relation.h" /* for backward compatibility */ 18 #include "access/relscan.h" 19 #include "access/sdir.h" 20 #include "access/skey.h" 21 #include "access/table.h" /* for backward compatibility */ 22 #include "access/tableam.h" 23 #include "nodes/lockoptions.h" 24 #include "nodes/primnodes.h" 25 #include "storage/bufpage.h" 26 #include "storage/dsm.h" 27 #include "storage/lockdefs.h" 28 #include "storage/shm_toc.h" 29 #include "utils/relcache.h" 30 #include "utils/snapshot.h" 31 32 33 /* "options" flag bits for heap_insert */ 34 #define HEAP_INSERT_SKIP_FSM TABLE_INSERT_SKIP_FSM 35 #define HEAP_INSERT_FROZEN TABLE_INSERT_FROZEN 36 #define HEAP_INSERT_NO_LOGICAL TABLE_INSERT_NO_LOGICAL 37 #define HEAP_INSERT_SPECULATIVE 0x0010 38 39 typedef struct BulkInsertStateData *BulkInsertState; 40 struct TupleTableSlot; 41 42 #define MaxLockTupleMode LockTupleExclusive 43 44 /* 45 * Descriptor for heap table scans. 46 */ 47 typedef struct HeapScanDescData 48 { 49 TableScanDescData rs_base; /* AM independent part of the descriptor */ 50 51 /* state set up at initscan time */ 52 BlockNumber rs_nblocks; /* total number of blocks in rel */ 53 BlockNumber rs_startblock; /* block # to start at */ 54 BlockNumber rs_numblocks; /* max number of blocks to scan */ 55 /* rs_numblocks is usually InvalidBlockNumber, meaning "scan whole rel" */ 56 57 /* scan current state */ 58 bool rs_inited; /* false = scan not init'd yet */ 59 BlockNumber rs_cblock; /* current block # in scan, if any */ 60 Buffer rs_cbuf; /* current buffer in scan, if any */ 61 /* NB: if rs_cbuf is not InvalidBuffer, we hold a pin on that buffer */ 62 63 /* rs_numblocks is usually InvalidBlockNumber, meaning "scan whole rel" */ 64 BufferAccessStrategy rs_strategy; /* access strategy for reads */ 65 66 HeapTupleData rs_ctup; /* current tuple in scan, if any */ 67 68 /* these fields only used in page-at-a-time mode and for bitmap scans */ 69 int rs_cindex; /* current tuple's index in vistuples */ 70 int rs_ntuples; /* number of visible tuples on page */ 71 OffsetNumber rs_vistuples[MaxHeapTuplesPerPage]; /* their offsets */ 72 } HeapScanDescData; 73 typedef struct HeapScanDescData *HeapScanDesc; 74 75 /* 76 * Descriptor for fetches from heap via an index. 77 */ 78 typedef struct IndexFetchHeapData 79 { 80 IndexFetchTableData xs_base; /* AM independent part of the descriptor */ 81 82 Buffer xs_cbuf; /* current heap buffer in scan, if any */ 83 /* NB: if xs_cbuf is not InvalidBuffer, we hold a pin on that buffer */ 84 } IndexFetchHeapData; 85 86 /* Result codes for HeapTupleSatisfiesVacuum */ 87 typedef enum 88 { 89 HEAPTUPLE_DEAD, /* tuple is dead and deletable */ 90 HEAPTUPLE_LIVE, /* tuple is live (committed, no deleter) */ 91 HEAPTUPLE_RECENTLY_DEAD, /* tuple is dead, but not deletable yet */ 92 HEAPTUPLE_INSERT_IN_PROGRESS, /* inserting xact is still in progress */ 93 HEAPTUPLE_DELETE_IN_PROGRESS /* deleting xact is still in progress */ 94 } HTSV_Result; 95 96 /* ---------------- 97 * function prototypes for heap access method 98 * 99 * heap_create, heap_create_with_catalog, and heap_drop_with_catalog 100 * are declared in catalog/heap.h 101 * ---------------- 102 */ 103 104 105 /* 106 * HeapScanIsValid 107 * True iff the heap scan is valid. 108 */ 109 #define HeapScanIsValid(scan) PointerIsValid(scan) 110 111 extern TableScanDesc heap_beginscan(Relation relation, Snapshot snapshot, 112 int nkeys, ScanKey key, 113 ParallelTableScanDesc parallel_scan, 114 uint32 flags); 115 extern void heap_setscanlimits(TableScanDesc scan, BlockNumber startBlk, 116 BlockNumber numBlks); 117 extern void heapgetpage(TableScanDesc scan, BlockNumber page); 118 extern void heap_rescan(TableScanDesc scan, ScanKey key, bool set_params, 119 bool allow_strat, bool allow_sync, bool allow_pagemode); 120 extern void heap_endscan(TableScanDesc scan); 121 extern HeapTuple heap_getnext(TableScanDesc scan, ScanDirection direction); 122 extern bool heap_getnextslot(TableScanDesc sscan, 123 ScanDirection direction, struct TupleTableSlot *slot); 124 125 extern bool heap_fetch(Relation relation, Snapshot snapshot, 126 HeapTuple tuple, Buffer *userbuf); 127 extern bool heap_hot_search_buffer(ItemPointer tid, Relation relation, 128 Buffer buffer, Snapshot snapshot, HeapTuple heapTuple, 129 bool *all_dead, bool first_call); 130 131 extern void heap_get_latest_tid(TableScanDesc scan, ItemPointer tid); 132 extern void setLastTid(const ItemPointer tid); 133 134 extern BulkInsertState GetBulkInsertState(void); 135 extern void FreeBulkInsertState(BulkInsertState); 136 extern void ReleaseBulkInsertStatePin(BulkInsertState bistate); 137 138 extern void heap_insert(Relation relation, HeapTuple tup, CommandId cid, 139 int options, BulkInsertState bistate); 140 extern void heap_multi_insert(Relation relation, struct TupleTableSlot **slots, 141 int ntuples, CommandId cid, int options, 142 BulkInsertState bistate); 143 extern TM_Result heap_delete(Relation relation, ItemPointer tid, 144 CommandId cid, Snapshot crosscheck, bool wait, 145 struct TM_FailureData *tmfd, bool changingPart); 146 extern void heap_finish_speculative(Relation relation, ItemPointer tid); 147 extern void heap_abort_speculative(Relation relation, ItemPointer tid); 148 extern TM_Result heap_update(Relation relation, ItemPointer otid, 149 HeapTuple newtup, 150 CommandId cid, Snapshot crosscheck, bool wait, 151 struct TM_FailureData *tmfd, LockTupleMode *lockmode); 152 extern TM_Result heap_lock_tuple(Relation relation, HeapTuple tuple, 153 CommandId cid, LockTupleMode mode, LockWaitPolicy wait_policy, 154 bool follow_update, 155 Buffer *buffer, struct TM_FailureData *tmfd); 156 157 extern void heap_inplace_update(Relation relation, HeapTuple tuple); 158 extern bool heap_freeze_tuple(HeapTupleHeader tuple, 159 TransactionId relfrozenxid, TransactionId relminmxid, 160 TransactionId cutoff_xid, TransactionId cutoff_multi); 161 extern bool heap_tuple_needs_freeze(HeapTupleHeader tuple, TransactionId cutoff_xid, 162 MultiXactId cutoff_multi, Buffer buf); 163 extern bool heap_tuple_needs_eventual_freeze(HeapTupleHeader tuple); 164 165 extern void simple_heap_insert(Relation relation, HeapTuple tup); 166 extern void simple_heap_delete(Relation relation, ItemPointer tid); 167 extern void simple_heap_update(Relation relation, ItemPointer otid, 168 HeapTuple tup); 169 170 extern TransactionId heap_compute_xid_horizon_for_tuples(Relation rel, 171 ItemPointerData *items, 172 int nitems); 173 174 /* in heap/pruneheap.c */ 175 extern void heap_page_prune_opt(Relation relation, Buffer buffer); 176 extern int heap_page_prune(Relation relation, Buffer buffer, 177 TransactionId OldestXmin, 178 bool report_stats, TransactionId *latestRemovedXid); 179 extern void heap_page_prune_execute(Buffer buffer, 180 OffsetNumber *redirected, int nredirected, 181 OffsetNumber *nowdead, int ndead, 182 OffsetNumber *nowunused, int nunused); 183 extern void heap_get_root_tuples(Page page, OffsetNumber *root_offsets); 184 185 /* in heap/syncscan.c */ 186 extern void ss_report_location(Relation rel, BlockNumber location); 187 extern BlockNumber ss_get_location(Relation rel, BlockNumber relnblocks); 188 extern void SyncScanShmemInit(void); 189 extern Size SyncScanShmemSize(void); 190 191 /* in heap/vacuumlazy.c */ 192 struct VacuumParams; 193 extern void heap_vacuum_rel(Relation onerel, 194 struct VacuumParams *params, BufferAccessStrategy bstrategy); 195 extern void parallel_vacuum_main(dsm_segment *seg, shm_toc *toc); 196 197 /* in heap/heapam_visibility.c */ 198 extern bool HeapTupleSatisfiesVisibility(HeapTuple stup, Snapshot snapshot, 199 Buffer buffer); 200 extern TM_Result HeapTupleSatisfiesUpdate(HeapTuple stup, CommandId curcid, 201 Buffer buffer); 202 extern HTSV_Result HeapTupleSatisfiesVacuum(HeapTuple stup, TransactionId OldestXmin, 203 Buffer buffer); 204 extern void HeapTupleSetHintBits(HeapTupleHeader tuple, Buffer buffer, 205 uint16 infomask, TransactionId xid); 206 extern bool HeapTupleHeaderIsOnlyLocked(HeapTupleHeader tuple); 207 extern bool XidInMVCCSnapshot(TransactionId xid, Snapshot snapshot); 208 extern bool HeapTupleIsSurelyDead(HeapTuple htup, TransactionId OldestXmin); 209 210 /* 211 * To avoid leaking too much knowledge about reorderbuffer implementation 212 * details this is implemented in reorderbuffer.c not heapam_visibility.c 213 */ 214 struct HTAB; 215 extern bool ResolveCminCmaxDuringDecoding(struct HTAB *tuplecid_data, 216 Snapshot snapshot, 217 HeapTuple htup, 218 Buffer buffer, 219 CommandId *cmin, CommandId *cmax); 220 extern void HeapCheckForSerializableConflictOut(bool valid, Relation relation, HeapTuple tuple, 221 Buffer buffer, Snapshot snapshot); 222 223 #endif /* HEAPAM_H */ 224