Line data Source code
1 : //!
2 : //! Misc constants, copied from PostgreSQL headers.
3 : //!
4 : //! Only place version-independent constants here.
5 : //!
6 : //! TODO: These probably should be auto-generated using bindgen,
7 : //! rather than copied by hand. Although on the other hand, it's nice
8 : //! to have them all here in one place, and have the ability to add
9 : //! comments on them.
10 : //!
11 :
12 : use crate::{BLCKSZ, PageHeaderData};
13 :
14 : // Note: There are a few more widely-used constants in the postgres_ffi_types::constants crate.
15 :
16 : // From storage_xlog.h
17 : pub const XLOG_SMGR_CREATE: u8 = 0x10;
18 : pub const XLOG_SMGR_TRUNCATE: u8 = 0x20;
19 :
20 : pub const SMGR_TRUNCATE_HEAP: u32 = 0x0001;
21 : pub const SMGR_TRUNCATE_VM: u32 = 0x0002;
22 : pub const SMGR_TRUNCATE_FSM: u32 = 0x0004;
23 :
24 : //
25 : // From bufpage.h
26 : //
27 :
28 : // Assumes 8 byte alignment
29 : const SIZEOF_PAGE_HEADER_DATA: usize = size_of::<PageHeaderData>();
30 : pub const MAXALIGN_SIZE_OF_PAGE_HEADER_DATA: usize = (SIZEOF_PAGE_HEADER_DATA + 7) & !7;
31 :
32 : //
33 : // constants from clog.h
34 : //
35 : pub const CLOG_XACTS_PER_BYTE: u32 = 4;
36 : pub const CLOG_XACTS_PER_PAGE: u32 = BLCKSZ as u32 * CLOG_XACTS_PER_BYTE;
37 : pub const CLOG_BITS_PER_XACT: u8 = 2;
38 : pub const CLOG_XACT_BITMASK: u8 = (1 << CLOG_BITS_PER_XACT) - 1;
39 :
40 : pub const TRANSACTION_STATUS_COMMITTED: u8 = 0x01;
41 : pub const TRANSACTION_STATUS_ABORTED: u8 = 0x02;
42 : pub const TRANSACTION_STATUS_SUB_COMMITTED: u8 = 0x03;
43 :
44 : pub const CLOG_ZEROPAGE: u8 = 0x00;
45 : pub const CLOG_TRUNCATE: u8 = 0x10;
46 :
47 : //
48 : // Constants from visibilitymap.h, visibilitymapdefs.h and visibilitymap.c
49 : //
50 : pub const SIZE_OF_PAGE_HEADER: u16 = 24;
51 : pub const BITS_PER_BYTE: u16 = 8;
52 : pub const HEAPBLOCKS_PER_PAGE: u32 =
53 : (BLCKSZ - SIZE_OF_PAGE_HEADER) as u32 * 8 / BITS_PER_HEAPBLOCK as u32;
54 : pub const HEAPBLOCKS_PER_BYTE: u16 = BITS_PER_BYTE / BITS_PER_HEAPBLOCK;
55 :
56 12 : pub const fn HEAPBLK_TO_MAPBLOCK(x: u32) -> u32 {
57 12 : x / HEAPBLOCKS_PER_PAGE
58 12 : }
59 0 : pub const fn HEAPBLK_TO_MAPBYTE(x: u32) -> u32 {
60 0 : (x % HEAPBLOCKS_PER_PAGE) / HEAPBLOCKS_PER_BYTE as u32
61 0 : }
62 0 : pub const fn HEAPBLK_TO_OFFSET(x: u32) -> u32 {
63 0 : (x % HEAPBLOCKS_PER_BYTE as u32) * BITS_PER_HEAPBLOCK as u32
64 0 : }
65 :
66 : pub const BITS_PER_HEAPBLOCK: u16 = 2;
67 : pub const VISIBILITYMAP_ALL_VISIBLE: u8 = 0x01;
68 : pub const VISIBILITYMAP_ALL_FROZEN: u8 = 0x02;
69 : pub const VISIBILITYMAP_VALID_BITS: u8 = 0x03;
70 :
71 : // From xact.h
72 : pub const XLOG_XACT_COMMIT: u8 = 0x00;
73 : pub const XLOG_XACT_PREPARE: u8 = 0x10;
74 : pub const XLOG_XACT_ABORT: u8 = 0x20;
75 : pub const XLOG_XACT_COMMIT_PREPARED: u8 = 0x30;
76 : pub const XLOG_XACT_ABORT_PREPARED: u8 = 0x40;
77 :
78 : // From standbydefs.h
79 : pub const XLOG_RUNNING_XACTS: u8 = 0x10;
80 :
81 : // From srlu.h
82 : pub const SLRU_PAGES_PER_SEGMENT: u32 = 32;
83 : pub const SLRU_SEG_SIZE: usize = BLCKSZ as usize * SLRU_PAGES_PER_SEGMENT as usize;
84 :
85 : /* mask for filtering opcodes out of xl_info */
86 : pub const XLOG_XACT_OPMASK: u8 = 0x70;
87 : pub const XLOG_HEAP_OPMASK: u8 = 0x70;
88 : /* does this record have a 'xinfo' field or not */
89 : pub const XLOG_XACT_HAS_INFO: u8 = 0x80;
90 :
91 : /*
92 : * The following flags, stored in xinfo, determine which information is
93 : * contained in commit/abort records.
94 : */
95 : pub const XACT_XINFO_HAS_DBINFO: u32 = 1u32 << 0;
96 : pub const XACT_XINFO_HAS_SUBXACTS: u32 = 1u32 << 1;
97 : pub const XACT_XINFO_HAS_RELFILENODES: u32 = 1u32 << 2;
98 : pub const XACT_XINFO_HAS_INVALS: u32 = 1u32 << 3;
99 : pub const XACT_XINFO_HAS_TWOPHASE: u32 = 1u32 << 4;
100 : pub const XACT_XINFO_HAS_ORIGIN: u32 = 1u32 << 5;
101 : // pub const XACT_XINFO_HAS_AE_LOCKS: u32 = 1u32 << 6;
102 : // pub const XACT_XINFO_HAS_GID: u32 = 1u32 << 7;
103 :
104 : // From pg_control.h and rmgrlist.h
105 : pub const XLOG_NEXTOID: u8 = 0x30;
106 : pub const XLOG_SWITCH: u8 = 0x40;
107 : pub const XLOG_FPI_FOR_HINT: u8 = 0xA0;
108 : pub const XLOG_FPI: u8 = 0xB0;
109 :
110 : // From multixact.h
111 : pub const FIRST_MULTIXACT_ID: u32 = 1;
112 : pub const MAX_MULTIXACT_ID: u32 = 0xFFFFFFFF;
113 : pub const MAX_MULTIXACT_OFFSET: u32 = 0xFFFFFFFF;
114 :
115 : pub const XLOG_MULTIXACT_ZERO_OFF_PAGE: u8 = 0x00;
116 : pub const XLOG_MULTIXACT_ZERO_MEM_PAGE: u8 = 0x10;
117 : pub const XLOG_MULTIXACT_CREATE_ID: u8 = 0x20;
118 : pub const XLOG_MULTIXACT_TRUNCATE_ID: u8 = 0x30;
119 :
120 : pub const MULTIXACT_OFFSETS_PER_PAGE: u16 = BLCKSZ / 4;
121 : pub const MXACT_MEMBER_BITS_PER_XACT: u16 = 8;
122 : pub const MXACT_MEMBER_FLAGS_PER_BYTE: u16 = 1;
123 : pub const MULTIXACT_FLAGBYTES_PER_GROUP: u16 = 4;
124 : pub const MULTIXACT_MEMBERS_PER_MEMBERGROUP: u16 =
125 : MULTIXACT_FLAGBYTES_PER_GROUP * MXACT_MEMBER_FLAGS_PER_BYTE;
126 : /* size in bytes of a complete group */
127 : pub const MULTIXACT_MEMBERGROUP_SIZE: u16 =
128 : 4 * MULTIXACT_MEMBERS_PER_MEMBERGROUP + MULTIXACT_FLAGBYTES_PER_GROUP;
129 : pub const MULTIXACT_MEMBERGROUPS_PER_PAGE: u16 = BLCKSZ / MULTIXACT_MEMBERGROUP_SIZE;
130 : pub const MULTIXACT_MEMBERS_PER_PAGE: u16 =
131 : MULTIXACT_MEMBERGROUPS_PER_PAGE * MULTIXACT_MEMBERS_PER_MEMBERGROUP;
132 :
133 : // From heapam_xlog.h
134 : pub const XLOG_HEAP_INSERT: u8 = 0x00;
135 : pub const XLOG_HEAP_DELETE: u8 = 0x10;
136 : pub const XLOG_HEAP_UPDATE: u8 = 0x20;
137 : pub const XLOG_HEAP_HOT_UPDATE: u8 = 0x40;
138 : pub const XLOG_HEAP_LOCK: u8 = 0x60;
139 : pub const XLOG_HEAP_INIT_PAGE: u8 = 0x80;
140 : pub const XLOG_HEAP2_VISIBLE: u8 = 0x40;
141 : pub const XLOG_HEAP2_MULTI_INSERT: u8 = 0x50;
142 : pub const XLOG_HEAP2_LOCK_UPDATED: u8 = 0x60;
143 : pub const XLH_LOCK_ALL_FROZEN_CLEARED: u8 = 0x01;
144 : pub const XLH_INSERT_ALL_FROZEN_SET: u8 = (1 << 5) as u8;
145 : pub const XLH_INSERT_ALL_VISIBLE_CLEARED: u8 = (1 << 0) as u8;
146 : pub const XLH_UPDATE_OLD_ALL_VISIBLE_CLEARED: u8 = (1 << 0) as u8;
147 : pub const XLH_UPDATE_NEW_ALL_VISIBLE_CLEARED: u8 = (1 << 1) as u8;
148 : pub const XLH_DELETE_ALL_VISIBLE_CLEARED: u8 = (1 << 0) as u8;
149 :
150 : // From heapam_xlog.h
151 : pub const XLOG_HEAP2_REWRITE: u8 = 0x00;
152 :
153 : // From replication/message.h
154 : pub const XLOG_LOGICAL_MESSAGE: u8 = 0x00;
155 :
156 : // From rmgrlist.h
157 : pub const RM_XLOG_ID: u8 = 0;
158 : pub const RM_XACT_ID: u8 = 1;
159 : pub const RM_SMGR_ID: u8 = 2;
160 : pub const RM_CLOG_ID: u8 = 3;
161 : pub const RM_DBASE_ID: u8 = 4;
162 : pub const RM_TBLSPC_ID: u8 = 5;
163 : pub const RM_MULTIXACT_ID: u8 = 6;
164 : pub const RM_RELMAP_ID: u8 = 7;
165 : pub const RM_STANDBY_ID: u8 = 8;
166 : pub const RM_HEAP2_ID: u8 = 9;
167 : pub const RM_HEAP_ID: u8 = 10;
168 : pub const RM_REPLORIGIN_ID: u8 = 19;
169 : pub const RM_LOGICALMSG_ID: u8 = 21;
170 :
171 : // from neon_rmgr.h
172 : pub const RM_NEON_ID: u8 = 134;
173 :
174 : pub const XLOG_NEON_HEAP_INIT_PAGE: u8 = 0x80;
175 :
176 : pub const XLOG_NEON_HEAP_INSERT: u8 = 0x00;
177 : pub const XLOG_NEON_HEAP_DELETE: u8 = 0x10;
178 : pub const XLOG_NEON_HEAP_UPDATE: u8 = 0x20;
179 : pub const XLOG_NEON_HEAP_HOT_UPDATE: u8 = 0x30;
180 : pub const XLOG_NEON_HEAP_LOCK: u8 = 0x40;
181 : pub const XLOG_NEON_HEAP_MULTI_INSERT: u8 = 0x50;
182 :
183 : pub const XLOG_NEON_HEAP_VISIBLE: u8 = 0x40;
184 :
185 : // from xlogreader.h
186 : pub const XLR_INFO_MASK: u8 = 0x0F;
187 : pub const XLR_RMGR_INFO_MASK: u8 = 0xF0;
188 :
189 : pub const XLOG_TBLSPC_CREATE: u8 = 0x00;
190 : pub const XLOG_TBLSPC_DROP: u8 = 0x10;
191 :
192 : //
193 : // from xlogrecord.h
194 : //
195 : pub const XLR_MAX_BLOCK_ID: u8 = 32;
196 :
197 : pub const XLR_BLOCK_ID_DATA_SHORT: u8 = 255;
198 : pub const XLR_BLOCK_ID_DATA_LONG: u8 = 254;
199 : pub const XLR_BLOCK_ID_ORIGIN: u8 = 253;
200 : pub const XLR_BLOCK_ID_TOPLEVEL_XID: u8 = 252;
201 :
202 : pub const BKPBLOCK_FORK_MASK: u8 = 0x0F;
203 : pub const _BKPBLOCK_FLAG_MASK: u8 = 0xF0;
204 : pub const BKPBLOCK_HAS_IMAGE: u8 = 0x10; /* block data is an XLogRecordBlockImage */
205 : pub const BKPBLOCK_HAS_DATA: u8 = 0x20;
206 : pub const BKPBLOCK_WILL_INIT: u8 = 0x40; /* redo will re-init the page */
207 : pub const BKPBLOCK_SAME_REL: u8 = 0x80; /* RelFileNode omitted, same as previous */
208 :
209 : /* Information stored in bimg_info */
210 : pub const BKPIMAGE_HAS_HOLE: u8 = 0x01; /* page image has "hole" */
211 :
212 : /* From transam.h */
213 : pub const FIRST_NORMAL_TRANSACTION_ID: u32 = 3;
214 : pub const INVALID_TRANSACTION_ID: u32 = 0;
215 :
216 : /* pg_control.h */
217 : pub const XLOG_CHECKPOINT_SHUTDOWN: u8 = 0x00;
218 : pub const XLOG_CHECKPOINT_ONLINE: u8 = 0x10;
219 : pub const XLOG_PARAMETER_CHANGE: u8 = 0x60;
220 : pub const XLOG_END_OF_RECOVERY: u8 = 0x90;
221 :
222 : /* From xlog.h */
223 : pub const XLOG_REPLORIGIN_SET: u8 = 0x00;
224 : pub const XLOG_REPLORIGIN_DROP: u8 = 0x10;
225 :
226 : /* xlog_internal.h */
227 : pub const XLP_FIRST_IS_CONTRECORD: u16 = 0x0001;
228 : pub const XLP_LONG_HEADER: u16 = 0x0002;
229 :
230 : /* From replication/slot.h */
231 : pub const REPL_SLOT_ON_DISK_OFFSETOF_RESTART_LSN: usize = 4*4 /* offset of `slotdata` in ReplicationSlotOnDisk */
232 : + 64 /* NameData */ + 4*4;
233 :
234 : /* From fsm_internals.h */
235 : const FSM_NODES_PER_PAGE: usize = BLCKSZ as usize - SIZEOF_PAGE_HEADER_DATA - 4;
236 : const FSM_NON_LEAF_NODES_PER_PAGE: usize = BLCKSZ as usize / 2 - 1;
237 : const FSM_LEAF_NODES_PER_PAGE: usize = FSM_NODES_PER_PAGE - FSM_NON_LEAF_NODES_PER_PAGE;
238 : pub const SLOTS_PER_FSM_PAGE: u32 = FSM_LEAF_NODES_PER_PAGE as u32;
239 :
240 : /* From visibilitymap.c */
241 :
242 : pub const VM_MAPSIZE: usize = BLCKSZ as usize - MAXALIGN_SIZE_OF_PAGE_HEADER_DATA;
243 : pub const VM_BITS_PER_HEAPBLOCK: usize = 2;
244 : pub const VM_HEAPBLOCKS_PER_BYTE: usize = 8 / VM_BITS_PER_HEAPBLOCK;
245 : pub const VM_HEAPBLOCKS_PER_PAGE: usize = VM_MAPSIZE * VM_HEAPBLOCKS_PER_BYTE;
246 :
247 : /* From origin.c */
248 : pub const REPLICATION_STATE_MAGIC: u32 = 0x1257DADE;
249 :
250 : // Don't include postgresql.conf as it is inconvenient on node start:
251 : // we need postgresql.conf before basebackup to synchronize safekeepers
252 : // so no point in overwriting it during backup restore. Rest of the files
253 : // here are not needed before backup so it is okay to edit them after.
254 : pub const PGDATA_SPECIAL_FILES: [&str; 3] =
255 : ["pg_hba.conf", "pg_ident.conf", "postgresql.auto.conf"];
256 :
257 : pub static PG_HBA: &str = include_str!("../samples/pg_hba.conf");
|
