1/*-------------------------------------------------------------------------
4 * xlog declarations for SP-GiST access method.
6 * Portions Copyright (c) 1996-2025, PostgreSQL Global Development Group
7 * Portions Copyright (c) 1994, Regents of the University of California
9 * src/include/access/spgxlog.h
11 *-------------------------------------------------------------------------
20/* XLOG record types for SPGiST */
21 /* #define XLOG_SPGIST_CREATE_INDEX 0x00 */ /* not used anymore */
22 #define XLOG_SPGIST_ADD_LEAF 0x10
23 #define XLOG_SPGIST_MOVE_LEAFS 0x20
24 #define XLOG_SPGIST_ADD_NODE 0x30
25 #define XLOG_SPGIST_SPLIT_TUPLE 0x40
26 #define XLOG_SPGIST_PICKSPLIT 0x50
27 #define XLOG_SPGIST_VACUUM_LEAF 0x60
28 #define XLOG_SPGIST_VACUUM_ROOT 0x70
29 #define XLOG_SPGIST_VACUUM_REDIRECT 0x80
32 * Some redo functions need an SpGistState, although only a few of its fields
33 * need to be valid. spgxlogState carries the required info in xlog records.
34 * (See fillFakeState in spgxlog.c for more comments.)
43 * Backup Blk 0: destination page for leaf tuple
44 * Backup Blk 1: parent page (if any)
56 /* new leaf tuple follows (unaligned!) */
60 * Backup Blk 0: source leaf page
61 * Backup Blk 1: destination leaf page
62 * Backup Blk 2: parent page
71 /* where the parent downlink is */
79 * array of deleted tuple numbers, length nMoves
80 * array of inserted tuple numbers, length nMoves + 1 or 1
81 * list of leaf tuples, length nMoves + 1 or 1 (unaligned!)
83 * Note: if replaceDead is true then there is only one inserted tuple
84 * number and only one leaf tuple in the data, because we are not copying
85 * the dead tuple from the source
91 #define SizeOfSpgxlogMoveLeafs offsetof(spgxlogMoveLeafs, offsets)
94 * Backup Blk 0: original page
95 * Backup Blk 1: where new tuple goes, if not same place
96 * Backup Blk 2: where parent downlink is, if updated and different from
102 * Offset of the original inner tuple, in the original page (on backup
108 * Offset of the new tuple, on the new page (on backup block 1). Invalid,
109 * if we overwrote the old tuple in the original page).
115 * Where is the parent downlink? parentBlk indicates which page it's on,
116 * and offnumParent is the offset within the page. The possible values for
119 * 0: parent == original page
120 * 1: parent == new page
121 * 2: parent == different page (blk ref 2)
122 * -1: parent not updated
133 * updated inner tuple follows (unaligned!)
138 * Backup Blk 0: where the prefix tuple goes
139 * Backup Blk 1: where the postfix tuple goes (if different page)
143 /* where the prefix tuple goes */
146 /* where the postfix tuple goes */
153 * new prefix inner tuple follows, then new postfix inner tuple (both are
159 * Buffer references in the rdata array are:
160 * Backup Blk 0: Src page (only if not root)
161 * Backup Blk 1: Dest page (if used)
162 * Backup Blk 2: Inner page
163 * Backup Blk 3: Parent page (if any, and different from Inner)
174 /* where to put new inner tuple */
180 /* where the parent downlink is, if any */
189 * array of deleted tuple numbers, length nDelete
190 * array of inserted tuple numbers, length nInsert
191 * array of page selector bytes for inserted tuples, length nInsert
192 * new inner tuple (unaligned!)
193 * list of leaf tuples, length nInsert (unaligned!)
199 #define SizeOfSpgxlogPickSplit offsetof(spgxlogPickSplit, offsets)
212 * tuple numbers to become DEAD
213 * tuple numbers to become PLACEHOLDER
214 * tuple numbers to move from (and replace with PLACEHOLDER)
215 * tuple numbers to move to (replacing what is there)
216 * tuple numbers to update nextOffset links of
217 * tuple numbers to insert in nextOffset links
223 #define SizeOfSpgxlogVacuumLeaf offsetof(spgxlogVacuumLeaf, offsets)
227 /* vacuum a root page when it is also a leaf */
232 /* offsets of tuples to delete follow */
236 #define SizeOfSpgxlogVacuumRoot offsetof(spgxlogVacuumRoot, offsets)
244 * decoding on standby */
246 /* offsets of redirect tuples to make placeholders follow */
250 #define SizeOfSpgxlogVacuumRedirect offsetof(spgxlogVacuumRedirect, offsets)
259#endif /* SPGXLOG_H */
#define FLEXIBLE_ARRAY_MEMBER
struct spgxlogSplitTuple spgxlogSplitTuple
void spg_redo(XLogReaderState *record)
struct spgxlogAddLeaf spgxlogAddLeaf
struct spgxlogMoveLeafs spgxlogMoveLeafs
struct spgxlogVacuumRedirect spgxlogVacuumRedirect
struct spgxlogVacuumRoot spgxlogVacuumRoot
struct spgxlogVacuumLeaf spgxlogVacuumLeaf
void spg_xlog_cleanup(void)
void spg_mask(char *pagedata, BlockNumber blkno)
struct spgxlogAddNode spgxlogAddNode
void spg_xlog_startup(void)
struct spgxlogState spgxlogState
const char * spg_identify(uint8 info)
struct spgxlogPickSplit spgxlogPickSplit
void spg_desc(StringInfo buf, XLogReaderState *record)
OffsetNumber offnumHeadLeaf
OffsetNumber offnumParent
OffsetNumber offnumParent
OffsetNumber offnumParent
OffsetNumber offsets[FLEXIBLE_ARRAY_MEMBER]
OffsetNumber offsets[FLEXIBLE_ARRAY_MEMBER]
OffsetNumber offnumParent
OffsetNumber offnumPostfix
OffsetNumber offnumPrefix
TransactionId redirectXid
OffsetNumber offsets[FLEXIBLE_ARRAY_MEMBER]
OffsetNumber firstPlaceholder
TransactionId snapshotConflictHorizon
OffsetNumber offsets[FLEXIBLE_ARRAY_MEMBER]
OffsetNumber offsets[FLEXIBLE_ARRAY_MEMBER]