LCOV - code coverage report
Current view: top level - libs/postgres_ffi/src - pg_constants.rs (source / functions) Coverage Total Hit
Test: 5fe7fa8d483b39476409aee736d6d5e32728bfac.info Lines: 33.3 % 9 3
Test Date: 2025-03-12 16:10:49 Functions: 33.3 % 3 1

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

Generated by: LCOV version 2.1-beta