LCOV - code coverage report
Current view: top level - libs/postgres_ffi/src - xlog_utils.rs (source / functions) Coverage Total Hit
Test: fabb29a6339542ee130cd1d32b534fafdc0be240.info Lines: 65.1 % 332 216
Test Date: 2024-06-25 13:20:00 Functions: 69.1 % 97 67

            Line data    Source code
       1              : //
       2              : // This file contains common utilities for dealing with PostgreSQL WAL files and
       3              : // LSNs.
       4              : //
       5              : // Many of these functions have been copied from PostgreSQL, and rewritten in
       6              : // Rust. That's why they don't follow the usual Rust naming conventions, they
       7              : // have been named the same as the corresponding PostgreSQL functions instead.
       8              : //
       9              : 
      10              : use crc32c::crc32c_append;
      11              : 
      12              : use super::super::waldecoder::WalStreamDecoder;
      13              : use super::bindings::{
      14              :     CheckPoint, ControlFileData, DBState_DB_SHUTDOWNED, FullTransactionId, TimeLineID, TimestampTz,
      15              :     XLogLongPageHeaderData, XLogPageHeaderData, XLogRecPtr, XLogRecord, XLogSegNo, XLOG_PAGE_MAGIC,
      16              : };
      17              : use super::PG_MAJORVERSION;
      18              : use crate::pg_constants;
      19              : use crate::PG_TLI;
      20              : use crate::{uint32, uint64, Oid};
      21              : use crate::{WAL_SEGMENT_SIZE, XLOG_BLCKSZ};
      22              : 
      23              : use bytes::BytesMut;
      24              : use bytes::{Buf, Bytes};
      25              : 
      26              : use log::*;
      27              : 
      28              : use serde::Serialize;
      29              : use std::fs::File;
      30              : use std::io::prelude::*;
      31              : use std::io::ErrorKind;
      32              : use std::io::SeekFrom;
      33              : use std::path::{Path, PathBuf};
      34              : use std::time::SystemTime;
      35              : use utils::bin_ser::DeserializeError;
      36              : use utils::bin_ser::SerializeError;
      37              : 
      38              : use utils::lsn::Lsn;
      39              : 
      40              : pub const XLOG_FNAME_LEN: usize = 24;
      41              : pub const XLP_FIRST_IS_CONTRECORD: u16 = 0x0001;
      42              : pub const XLP_REM_LEN_OFFS: usize = 2 + 2 + 4 + 8;
      43              : pub const XLOG_RECORD_CRC_OFFS: usize = 4 + 4 + 8 + 1 + 1 + 2;
      44              : 
      45              : pub const XLOG_SIZE_OF_XLOG_SHORT_PHD: usize = std::mem::size_of::<XLogPageHeaderData>();
      46              : pub const XLOG_SIZE_OF_XLOG_LONG_PHD: usize = std::mem::size_of::<XLogLongPageHeaderData>();
      47              : pub const XLOG_SIZE_OF_XLOG_RECORD: usize = std::mem::size_of::<XLogRecord>();
      48              : #[allow(clippy::identity_op)]
      49              : pub const SIZE_OF_XLOG_RECORD_DATA_HEADER_SHORT: usize = 1 * 2;
      50              : 
      51              : /// Interval of checkpointing metadata file. We should store metadata file to enforce
      52              : /// predicate that checkpoint.nextXid is larger than any XID in WAL.
      53              : /// But flushing checkpoint file for each transaction seems to be too expensive,
      54              : /// so XID_CHECKPOINT_INTERVAL is used to forward align nextXid and so perform
      55              : /// metadata checkpoint only once per XID_CHECKPOINT_INTERVAL transactions.
      56              : /// XID_CHECKPOINT_INTERVAL should not be larger than BLCKSZ*CLOG_XACTS_PER_BYTE
      57              : /// in order to let CLOG_TRUNCATE mechanism correctly extend CLOG.
      58              : const XID_CHECKPOINT_INTERVAL: u32 = 1024;
      59              : 
      60          208 : pub fn XLogSegmentsPerXLogId(wal_segsz_bytes: usize) -> XLogSegNo {
      61          208 :     (0x100000000u64 / wal_segsz_bytes as u64) as XLogSegNo
      62          208 : }
      63              : 
      64        65428 : pub fn XLogSegNoOffsetToRecPtr(
      65        65428 :     segno: XLogSegNo,
      66        65428 :     offset: u32,
      67        65428 :     wal_segsz_bytes: usize,
      68        65428 : ) -> XLogRecPtr {
      69        65428 :     segno * (wal_segsz_bytes as u64) + (offset as u64)
      70        65428 : }
      71              : 
      72           62 : pub fn XLogFileName(tli: TimeLineID, logSegNo: XLogSegNo, wal_segsz_bytes: usize) -> String {
      73           62 :     format!(
      74           62 :         "{:>08X}{:>08X}{:>08X}",
      75           62 :         tli,
      76           62 :         logSegNo / XLogSegmentsPerXLogId(wal_segsz_bytes),
      77           62 :         logSegNo % XLogSegmentsPerXLogId(wal_segsz_bytes)
      78           62 :     )
      79           62 : }
      80              : 
      81           84 : pub fn XLogFromFileName(fname: &str, wal_seg_size: usize) -> (XLogSegNo, TimeLineID) {
      82           84 :     let tli = u32::from_str_radix(&fname[0..8], 16).unwrap();
      83           84 :     let log = u32::from_str_radix(&fname[8..16], 16).unwrap() as XLogSegNo;
      84           84 :     let seg = u32::from_str_radix(&fname[16..24], 16).unwrap() as XLogSegNo;
      85           84 :     (log * XLogSegmentsPerXLogId(wal_seg_size) + seg, tli)
      86           84 : }
      87              : 
      88          180 : pub fn IsXLogFileName(fname: &str) -> bool {
      89         2736 :     return fname.len() == XLOG_FNAME_LEN && fname.chars().all(|c| c.is_ascii_hexdigit());
      90          180 : }
      91              : 
      92            0 : pub fn IsPartialXLogFileName(fname: &str) -> bool {
      93            0 :     fname.ends_with(".partial") && IsXLogFileName(&fname[0..fname.len() - 8])
      94            0 : }
      95              : 
      96              : /// If LSN points to the beginning of the page, then shift it to first record,
      97              : /// otherwise align on 8-bytes boundary (required for WAL records)
      98            0 : pub fn normalize_lsn(lsn: Lsn, seg_sz: usize) -> Lsn {
      99            0 :     if lsn.0 % XLOG_BLCKSZ as u64 == 0 {
     100            0 :         let hdr_size = if lsn.0 % seg_sz as u64 == 0 {
     101            0 :             XLOG_SIZE_OF_XLOG_LONG_PHD
     102              :         } else {
     103            0 :             XLOG_SIZE_OF_XLOG_SHORT_PHD
     104              :         };
     105            0 :         lsn + hdr_size as u64
     106              :     } else {
     107            0 :         lsn.align()
     108              :     }
     109            0 : }
     110              : 
     111            0 : pub fn generate_pg_control(
     112            0 :     pg_control_bytes: &[u8],
     113            0 :     checkpoint_bytes: &[u8],
     114            0 :     lsn: Lsn,
     115            0 : ) -> anyhow::Result<(Bytes, u64)> {
     116            0 :     let mut pg_control = ControlFileData::decode(pg_control_bytes)?;
     117            0 :     let mut checkpoint = CheckPoint::decode(checkpoint_bytes)?;
     118              : 
     119              :     // Generate new pg_control needed for bootstrap
     120            0 :     checkpoint.redo = normalize_lsn(lsn, WAL_SEGMENT_SIZE).0;
     121            0 : 
     122            0 :     //save new values in pg_control
     123            0 :     pg_control.checkPoint = 0;
     124            0 :     pg_control.checkPointCopy = checkpoint;
     125            0 :     pg_control.state = DBState_DB_SHUTDOWNED;
     126            0 : 
     127            0 :     Ok((pg_control.encode(), pg_control.system_identifier))
     128            0 : }
     129              : 
     130            6 : pub fn get_current_timestamp() -> TimestampTz {
     131            6 :     to_pg_timestamp(SystemTime::now())
     132            6 : }
     133              : 
     134              : // Module to reduce the scope of the constants
     135              : mod timestamp_conversions {
     136              :     use std::time::Duration;
     137              : 
     138              :     use super::*;
     139              : 
     140              :     const UNIX_EPOCH_JDATE: u64 = 2440588; // == date2j(1970, 1, 1)
     141              :     const POSTGRES_EPOCH_JDATE: u64 = 2451545; // == date2j(2000, 1, 1)
     142              :     const SECS_PER_DAY: u64 = 86400;
     143              :     const USECS_PER_SEC: u64 = 1000000;
     144              :     const SECS_DIFF_UNIX_TO_POSTGRES_EPOCH: u64 =
     145              :         (POSTGRES_EPOCH_JDATE - UNIX_EPOCH_JDATE) * SECS_PER_DAY;
     146              : 
     147           18 :     pub fn to_pg_timestamp(time: SystemTime) -> TimestampTz {
     148           18 :         match time.duration_since(SystemTime::UNIX_EPOCH) {
     149           18 :             Ok(n) => {
     150           18 :                 ((n.as_secs() - SECS_DIFF_UNIX_TO_POSTGRES_EPOCH) * USECS_PER_SEC
     151           18 :                     + n.subsec_micros() as u64) as i64
     152              :             }
     153            0 :             Err(_) => panic!("SystemTime before UNIX EPOCH!"),
     154              :         }
     155           18 :     }
     156              : 
     157           12 :     pub fn from_pg_timestamp(time: TimestampTz) -> SystemTime {
     158           12 :         let time: u64 = time
     159           12 :             .try_into()
     160           12 :             .expect("timestamp before millenium (postgres epoch)");
     161           12 :         let since_unix_epoch = time + SECS_DIFF_UNIX_TO_POSTGRES_EPOCH * USECS_PER_SEC;
     162           12 :         SystemTime::UNIX_EPOCH
     163           12 :             .checked_add(Duration::from_micros(since_unix_epoch))
     164           12 :             .expect("SystemTime overflow")
     165           12 :     }
     166              : }
     167              : 
     168              : pub use timestamp_conversions::{from_pg_timestamp, to_pg_timestamp};
     169              : 
     170              : // Returns (aligned) end_lsn of the last record in data_dir with WAL segments.
     171              : // start_lsn must point to some previously known record boundary (beginning of
     172              : // the next record). If no valid record after is found, start_lsn is returned
     173              : // back.
     174           48 : pub fn find_end_of_wal(
     175           48 :     data_dir: &Path,
     176           48 :     wal_seg_size: usize,
     177           48 :     start_lsn: Lsn, // start reading WAL at this point; must point at record start_lsn.
     178           48 : ) -> anyhow::Result<Lsn> {
     179           48 :     let mut result = start_lsn;
     180           48 :     let mut curr_lsn = start_lsn;
     181           48 :     let mut buf = [0u8; XLOG_BLCKSZ];
     182           48 :     let pg_version = PG_MAJORVERSION[1..3].parse::<u32>().unwrap();
     183           48 :     debug!("find_end_of_wal PG_VERSION: {}", pg_version);
     184              : 
     185           48 :     let mut decoder = WalStreamDecoder::new(start_lsn, pg_version);
     186              : 
     187              :     // loop over segments
     188           60 :     loop {
     189           60 :         let segno = curr_lsn.segment_number(wal_seg_size);
     190           60 :         let seg_file_name = XLogFileName(PG_TLI, segno, wal_seg_size);
     191           60 :         let seg_file_path = data_dir.join(seg_file_name);
     192           60 :         match open_wal_segment(&seg_file_path)? {
     193              :             None => {
     194              :                 // no more segments
     195            0 :                 debug!(
     196            0 :                     "find_end_of_wal reached end at {:?}, segment {:?} doesn't exist",
     197              :                     result, seg_file_path
     198              :                 );
     199            0 :                 return Ok(result);
     200              :             }
     201           60 :             Some(mut segment) => {
     202           60 :                 let seg_offs = curr_lsn.segment_offset(wal_seg_size);
     203           60 :                 segment.seek(SeekFrom::Start(seg_offs as u64))?;
     204              :                 // loop inside segment
     205        24758 :                 while curr_lsn.segment_number(wal_seg_size) == segno {
     206        24746 :                     let bytes_read = segment.read(&mut buf)?;
     207        24746 :                     if bytes_read == 0 {
     208            0 :                         debug!(
     209            0 :                             "find_end_of_wal reached end at {:?}, EOF in segment {:?} at offset {}",
     210            0 :                             result,
     211            0 :                             seg_file_path,
     212            0 :                             curr_lsn.segment_offset(wal_seg_size)
     213              :                         );
     214            0 :                         return Ok(result);
     215        24746 :                     }
     216        24746 :                     curr_lsn += bytes_read as u64;
     217        24746 :                     decoder.feed_bytes(&buf[0..bytes_read]);
     218              : 
     219              :                     // advance result past all completely read records
     220              :                     loop {
     221        24998 :                         match decoder.poll_decode() {
     222          252 :                             Ok(Some(record)) => result = record.0,
     223           48 :                             Err(e) => {
     224           48 :                                 debug!(
     225           48 :                                     "find_end_of_wal reached end at {:?}, decode error: {:?}",
     226              :                                     result, e
     227              :                                 );
     228           48 :                                 return Ok(result);
     229              :                             }
     230        24698 :                             Ok(None) => break, // need more data
     231              :                         }
     232              :                     }
     233              :                 }
     234              :             }
     235              :         }
     236              :     }
     237           48 : }
     238              : 
     239              : // Open .partial or full WAL segment file, if present.
     240           60 : fn open_wal_segment(seg_file_path: &Path) -> anyhow::Result<Option<File>> {
     241           60 :     let mut partial_path = seg_file_path.to_owned();
     242           60 :     partial_path.set_extension("partial");
     243           60 :     match File::open(partial_path) {
     244           48 :         Ok(file) => Ok(Some(file)),
     245           12 :         Err(e) => match e.kind() {
     246              :             ErrorKind::NotFound => {
     247              :                 // .partial not found, try full
     248           12 :                 match File::open(seg_file_path) {
     249           12 :                     Ok(file) => Ok(Some(file)),
     250            0 :                     Err(e) => match e.kind() {
     251            0 :                         ErrorKind::NotFound => Ok(None),
     252            0 :                         _ => Err(e.into()),
     253              :                     },
     254              :                 }
     255              :             }
     256            0 :             _ => Err(e.into()),
     257              :         },
     258              :     }
     259           60 : }
     260              : 
     261            0 : pub fn main() {
     262            0 :     let mut data_dir = PathBuf::new();
     263            0 :     data_dir.push(".");
     264            0 :     let wal_end = find_end_of_wal(&data_dir, WAL_SEGMENT_SIZE, Lsn(0)).unwrap();
     265            0 :     println!("wal_end={:?}", wal_end);
     266            0 : }
     267              : 
     268              : impl XLogRecord {
     269       221100 :     pub fn from_slice(buf: &[u8]) -> Result<XLogRecord, DeserializeError> {
     270       221100 :         use utils::bin_ser::LeSer;
     271       221100 :         XLogRecord::des(buf)
     272       221100 :     }
     273              : 
     274       145852 :     pub fn from_bytes<B: Buf>(buf: &mut B) -> Result<XLogRecord, DeserializeError> {
     275       145852 :         use utils::bin_ser::LeSer;
     276       145852 :         XLogRecord::des_from(&mut buf.reader())
     277       145852 :     }
     278              : 
     279        65356 :     pub fn encode(&self) -> Result<Bytes, SerializeError> {
     280        65356 :         use utils::bin_ser::LeSer;
     281        65356 :         Ok(self.ser()?.into())
     282        65356 :     }
     283              : 
     284              :     // Is this record an XLOG_SWITCH record? They need some special processing,
     285       221100 :     pub fn is_xlog_switch_record(&self) -> bool {
     286       221100 :         self.xl_info == pg_constants::XLOG_SWITCH && self.xl_rmid == pg_constants::RM_XLOG_ID
     287       221100 :     }
     288              : }
     289              : 
     290              : impl XLogPageHeaderData {
     291        27963 :     pub fn from_bytes<B: Buf>(buf: &mut B) -> Result<XLogPageHeaderData, DeserializeError> {
     292        27963 :         use utils::bin_ser::LeSer;
     293        27963 :         XLogPageHeaderData::des_from(&mut buf.reader())
     294        27963 :     }
     295              : 
     296          177 :     pub fn encode(&self) -> Result<Bytes, SerializeError> {
     297          177 :         use utils::bin_ser::LeSer;
     298          177 :         self.ser().map(|b| b.into())
     299          177 :     }
     300              : }
     301              : 
     302              : impl XLogLongPageHeaderData {
     303           12 :     pub fn from_bytes<B: Buf>(buf: &mut B) -> Result<XLogLongPageHeaderData, DeserializeError> {
     304           12 :         use utils::bin_ser::LeSer;
     305           12 :         XLogLongPageHeaderData::des_from(&mut buf.reader())
     306           12 :     }
     307              : 
     308            0 :     pub fn encode(&self) -> Result<Bytes, SerializeError> {
     309            0 :         use utils::bin_ser::LeSer;
     310            0 :         self.ser().map(|b| b.into())
     311            0 :     }
     312              : }
     313              : 
     314              : pub const SIZEOF_CHECKPOINT: usize = std::mem::size_of::<CheckPoint>();
     315              : 
     316              : impl CheckPoint {
     317            8 :     pub fn encode(&self) -> Result<Bytes, SerializeError> {
     318            8 :         use utils::bin_ser::LeSer;
     319            8 :         Ok(self.ser()?.into())
     320            8 :     }
     321              : 
     322           20 :     pub fn decode(buf: &[u8]) -> Result<CheckPoint, DeserializeError> {
     323           20 :         use utils::bin_ser::LeSer;
     324           20 :         CheckPoint::des(buf)
     325           20 :     }
     326              : 
     327              :     /// Update next XID based on provided new_xid and stored epoch.
     328              :     /// Next XID should be greater than new_xid. This handles 32-bit
     329              :     /// XID wraparound correctly.
     330              :     ///
     331              :     /// Returns 'true' if the XID was updated.
     332       145858 :     pub fn update_next_xid(&mut self, xid: u32) -> bool {
     333       145858 :         // nextXid should be greater than any XID in WAL, so increment provided XID and check for wraparround.
     334       145858 :         let mut new_xid = std::cmp::max(
     335       145858 :             xid.wrapping_add(1),
     336       145858 :             pg_constants::FIRST_NORMAL_TRANSACTION_ID,
     337       145858 :         );
     338       145858 :         // To reduce number of metadata checkpoints, we forward align XID on XID_CHECKPOINT_INTERVAL.
     339       145858 :         // XID_CHECKPOINT_INTERVAL should not be larger than BLCKSZ*CLOG_XACTS_PER_BYTE
     340       145858 :         new_xid =
     341       145858 :             new_xid.wrapping_add(XID_CHECKPOINT_INTERVAL - 1) & !(XID_CHECKPOINT_INTERVAL - 1);
     342       145858 :         let full_xid = self.nextXid.value;
     343       145858 :         let old_xid = full_xid as u32;
     344       145858 :         if new_xid.wrapping_sub(old_xid) as i32 > 0 {
     345           14 :             let mut epoch = full_xid >> 32;
     346           14 :             if new_xid < old_xid {
     347            0 :                 // wrap-around
     348            0 :                 epoch += 1;
     349           14 :             }
     350           14 :             let nextXid = (epoch << 32) | new_xid as u64;
     351           14 : 
     352           14 :             if nextXid != self.nextXid.value {
     353           14 :                 self.nextXid = FullTransactionId { value: nextXid };
     354           14 :                 return true;
     355            0 :             }
     356       145844 :         }
     357       145844 :         false
     358       145858 :     }
     359              : }
     360              : 
     361              : /// Generate new, empty WAL segment, with correct block headers at the first
     362              : /// page of the segment and the page that contains the given LSN.
     363              : /// We need this segment to start compute node.
     364            0 : pub fn generate_wal_segment(segno: u64, system_id: u64, lsn: Lsn) -> Result<Bytes, SerializeError> {
     365            0 :     let mut seg_buf = BytesMut::with_capacity(WAL_SEGMENT_SIZE);
     366            0 : 
     367            0 :     let pageaddr = XLogSegNoOffsetToRecPtr(segno, 0, WAL_SEGMENT_SIZE);
     368            0 : 
     369            0 :     let page_off = lsn.block_offset();
     370            0 :     let seg_off = lsn.segment_offset(WAL_SEGMENT_SIZE);
     371            0 : 
     372            0 :     let first_page_only = seg_off < XLOG_BLCKSZ;
     373              :     // If first records starts in the middle of the page, pretend in page header
     374              :     // there is a fake record which ends where first real record starts. This
     375              :     // makes pg_waldump etc happy.
     376            0 :     let (shdr_rem_len, infoflags) = if first_page_only && seg_off > 0 {
     377            0 :         assert!(seg_off >= XLOG_SIZE_OF_XLOG_LONG_PHD);
     378              :         // xlp_rem_len doesn't include page header, hence the subtraction.
     379            0 :         (
     380            0 :             seg_off - XLOG_SIZE_OF_XLOG_LONG_PHD,
     381            0 :             pg_constants::XLP_FIRST_IS_CONTRECORD,
     382            0 :         )
     383              :     } else {
     384            0 :         (0, 0)
     385              :     };
     386              : 
     387            0 :     let hdr = XLogLongPageHeaderData {
     388            0 :         std: {
     389            0 :             XLogPageHeaderData {
     390            0 :                 xlp_magic: XLOG_PAGE_MAGIC as u16,
     391            0 :                 xlp_info: pg_constants::XLP_LONG_HEADER | infoflags,
     392            0 :                 xlp_tli: PG_TLI,
     393            0 :                 xlp_pageaddr: pageaddr,
     394            0 :                 xlp_rem_len: shdr_rem_len as u32,
     395            0 :                 ..Default::default() // Put 0 in padding fields.
     396            0 :             }
     397            0 :         },
     398            0 :         xlp_sysid: system_id,
     399            0 :         xlp_seg_size: WAL_SEGMENT_SIZE as u32,
     400            0 :         xlp_xlog_blcksz: XLOG_BLCKSZ as u32,
     401            0 :     };
     402              : 
     403            0 :     let hdr_bytes = hdr.encode()?;
     404            0 :     seg_buf.extend_from_slice(&hdr_bytes);
     405            0 : 
     406            0 :     //zero out the rest of the file
     407            0 :     seg_buf.resize(WAL_SEGMENT_SIZE, 0);
     408            0 : 
     409            0 :     if !first_page_only {
     410            0 :         let block_offset = lsn.page_offset_in_segment(WAL_SEGMENT_SIZE) as usize;
     411              :         // see comments above about XLP_FIRST_IS_CONTRECORD and xlp_rem_len.
     412            0 :         let (xlp_rem_len, xlp_info) = if page_off > 0 {
     413            0 :             assert!(page_off >= XLOG_SIZE_OF_XLOG_SHORT_PHD as u64);
     414            0 :             (
     415            0 :                 (page_off - XLOG_SIZE_OF_XLOG_SHORT_PHD as u64) as u32,
     416            0 :                 pg_constants::XLP_FIRST_IS_CONTRECORD,
     417            0 :             )
     418              :         } else {
     419            0 :             (0, 0)
     420              :         };
     421            0 :         let header = XLogPageHeaderData {
     422            0 :             xlp_magic: XLOG_PAGE_MAGIC as u16,
     423            0 :             xlp_info,
     424            0 :             xlp_tli: PG_TLI,
     425            0 :             xlp_pageaddr: lsn.page_lsn().0,
     426            0 :             xlp_rem_len,
     427            0 :             ..Default::default() // Put 0 in padding fields.
     428            0 :         };
     429            0 :         let hdr_bytes = header.encode()?;
     430              : 
     431            0 :         debug_assert!(seg_buf.len() > block_offset + hdr_bytes.len());
     432            0 :         debug_assert_ne!(block_offset, 0);
     433              : 
     434            0 :         seg_buf[block_offset..block_offset + hdr_bytes.len()].copy_from_slice(&hdr_bytes[..]);
     435            0 :     }
     436              : 
     437            0 :     Ok(seg_buf.freeze())
     438            0 : }
     439              : 
     440              : #[repr(C)]
     441              : #[derive(Serialize)]
     442              : pub struct XlLogicalMessage {
     443              :     pub db_id: Oid,
     444              :     pub transactional: uint32, // bool, takes 4 bytes due to alignment in C structures
     445              :     pub prefix_size: uint64,
     446              :     pub message_size: uint64,
     447              : }
     448              : 
     449              : impl XlLogicalMessage {
     450        32678 :     pub fn encode(&self) -> Bytes {
     451        32678 :         use utils::bin_ser::LeSer;
     452        32678 :         self.ser().unwrap().into()
     453        32678 :     }
     454              : }
     455              : 
     456              : /// Create new WAL record for non-transactional logical message.
     457              : /// Used for creating artificial WAL for tests, as LogicalMessage
     458              : /// record is basically no-op.
     459              : ///
     460              : /// NOTE: This leaves the xl_prev field zero. The safekeeper and
     461              : /// pageserver tolerate that, but PostgreSQL does not.
     462            6 : pub fn encode_logical_message(prefix: &str, message: &str) -> Vec<u8> {
     463            6 :     let mut prefix_bytes: Vec<u8> = Vec::with_capacity(prefix.len() + 1);
     464            6 :     prefix_bytes.write_all(prefix.as_bytes()).unwrap();
     465            6 :     prefix_bytes.push(0);
     466            6 : 
     467            6 :     let message_bytes = message.as_bytes();
     468            6 : 
     469            6 :     let logical_message = XlLogicalMessage {
     470            6 :         db_id: 0,
     471            6 :         transactional: 0,
     472            6 :         prefix_size: prefix_bytes.len() as u64,
     473            6 :         message_size: message_bytes.len() as u64,
     474            6 :     };
     475            6 : 
     476            6 :     let mainrdata = logical_message.encode();
     477            6 :     let mainrdata_len: usize = mainrdata.len() + prefix_bytes.len() + message_bytes.len();
     478            6 :     // only short mainrdata is supported for now
     479            6 :     assert!(mainrdata_len <= 255);
     480            6 :     let mainrdata_len = mainrdata_len as u8;
     481            6 : 
     482            6 :     let mut data: Vec<u8> = vec![pg_constants::XLR_BLOCK_ID_DATA_SHORT, mainrdata_len];
     483            6 :     data.extend_from_slice(&mainrdata);
     484            6 :     data.extend_from_slice(&prefix_bytes);
     485            6 :     data.extend_from_slice(message_bytes);
     486            6 : 
     487            6 :     let total_len = XLOG_SIZE_OF_XLOG_RECORD + data.len();
     488            6 : 
     489            6 :     let mut header = XLogRecord {
     490            6 :         xl_tot_len: total_len as u32,
     491            6 :         xl_xid: 0,
     492            6 :         xl_prev: 0,
     493            6 :         xl_info: 0,
     494            6 :         xl_rmid: 21,
     495            6 :         __bindgen_padding_0: [0u8; 2usize],
     496            6 :         xl_crc: 0, // crc will be calculated later
     497            6 :     };
     498            6 : 
     499            6 :     let header_bytes = header.encode().expect("failed to encode header");
     500            6 :     let crc = crc32c_append(0, &data);
     501            6 :     let crc = crc32c_append(crc, &header_bytes[0..XLOG_RECORD_CRC_OFFS]);
     502            6 :     header.xl_crc = crc;
     503            6 : 
     504            6 :     let mut wal: Vec<u8> = Vec::new();
     505            6 :     wal.extend_from_slice(&header.encode().expect("failed to encode header"));
     506            6 :     wal.extend_from_slice(&data);
     507            6 : 
     508            6 :     // WAL start position must be aligned at 8 bytes,
     509            6 :     // this will add padding for the next WAL record.
     510            6 :     const PADDING: usize = 8;
     511            6 :     let padding_rem = wal.len() % PADDING;
     512            6 :     if padding_rem != 0 {
     513            0 :         wal.resize(wal.len() + PADDING - padding_rem, 0);
     514            6 :     }
     515              : 
     516            6 :     wal
     517            6 : }
     518              : 
     519              : #[cfg(test)]
     520              : mod tests {
     521              :     use super::*;
     522              : 
     523              :     #[test]
     524            6 :     fn test_ts_conversion() {
     525            6 :         let now = SystemTime::now();
     526            6 :         let round_trip = from_pg_timestamp(to_pg_timestamp(now));
     527            6 : 
     528            6 :         let now_since = now.duration_since(SystemTime::UNIX_EPOCH).unwrap();
     529            6 :         let round_trip_since = round_trip.duration_since(SystemTime::UNIX_EPOCH).unwrap();
     530            6 :         assert_eq!(now_since.as_micros(), round_trip_since.as_micros());
     531              : 
     532            6 :         let now_pg = get_current_timestamp();
     533            6 :         let round_trip_pg = to_pg_timestamp(from_pg_timestamp(now_pg));
     534            6 : 
     535            6 :         assert_eq!(now_pg, round_trip_pg);
     536            6 :     }
     537              : 
     538              :     // If you need to craft WAL and write tests for this module, put it at wal_craft crate.
     539              : }
        

Generated by: LCOV version 2.1-beta