Skip to main content

mysql_replication/
frame.rs

1use crate::{Error, Result, error::invalid, event_type as event, events::EventHeader};
2pub const MAX_EVENT_BYTES: usize = 64 * 1024 * 1024;
3
4/// A validated frame. Body excludes the original checksum trailer; raw_data does not.
5#[derive(Debug, Clone, Copy)]
6pub struct BinlogFrame<'a> {
7    pub raw_data: &'a [u8],
8    pub header: EventHeader,
9    pub body: &'a [u8],
10}
11#[derive(Debug, Default)]
12pub struct FrameDecoder {
13    crc32: Option<bool>,
14}
15impl FrameDecoder {
16    pub fn new() -> Self {
17        Self::default()
18    }
19    pub(crate) fn set_checksum(&mut self, crc32: bool) {
20        self.crc32 = Some(crc32);
21    }
22    pub fn has_format(&self) -> bool {
23        self.crc32.is_some()
24    }
25    pub fn decode<'a>(&mut self, raw: &'a [u8]) -> Result<BinlogFrame<'a>> {
26        self.decode_inner(raw, false)
27    }
28    pub(crate) fn decode_network<'a>(&mut self, raw: &'a [u8]) -> Result<BinlogFrame<'a>> {
29        self.decode_inner(raw, true)
30    }
31    fn decode_inner<'a>(&mut self, raw: &'a [u8], network: bool) -> Result<BinlogFrame<'a>> {
32        let header_bytes = raw.get(..EventHeader::LEN).ok_or(Error::Truncated {
33            need: EventHeader::LEN,
34            have: raw.len(),
35        })?;
36        let header = EventHeader::parse(header_bytes)?;
37        let len = header.event_size as usize;
38        if !(EventHeader::LEN..=MAX_EVENT_BYTES).contains(&len) || raw.len() != len {
39            return Err(invalid("event size does not match bounded raw frame"));
40        }
41        let is_fde = header.event_type == event::FORMAT_DESCRIPTION_EVENT;
42        let crc32 = if is_fde {
43            if raw.len() < 19 + 57 + 32 + 5 {
44                return Err(invalid("short FORMAT_DESCRIPTION"));
45            }
46            match raw[raw.len() - 5] {
47                0 => false,
48                1 => true,
49                n => return Err(Error::Unsupported(format!("checksum algorithm {n}"))),
50            }
51        } else if let Some(value) = self.crc32 {
52            value
53        } else if header.event_type == event::ROTATE_EVENT {
54            false
55        } else {
56            return Err(invalid("event before FORMAT_DESCRIPTION"));
57        };
58        let trailer = if is_fde {
59            5
60        } else if crc32 {
61            4
62        } else {
63            0
64        };
65        let end = raw
66            .len()
67            .checked_sub(trailer)
68            .filter(|&end| end >= 19)
69            .ok_or_else(|| invalid("missing checksum"))?;
70        if crc32 || (is_fde && !(network && header.log_pos == 0)) {
71            let mut hash = crc32fast::Hasher::new();
72            let mut checksum_header = [0; 19];
73            checksum_header.copy_from_slice(header_bytes);
74            if is_fde {
75                checksum_header[17] &= !1;
76            }
77            hash.update(&checksum_header);
78            hash.update(&raw[19..raw.len() - 4]);
79            let mut expected = [0; 4];
80            expected.copy_from_slice(&raw[raw.len() - 4..]);
81            if hash.finalize() != u32::from_le_bytes(expected) {
82                return Err(Error::Checksum);
83            }
84        }
85        if is_fde {
86            self.crc32 = Some(crc32);
87        }
88        Ok(BinlogFrame {
89            raw_data: raw,
90            header,
91            body: &raw[19..end],
92        })
93    }
94}
95
96/// A body view for consumers that do not retain the complete event. Network
97/// readers borrow the driver buffer directly, without assembling a second copy.
98#[derive(Debug, Clone, Copy)]
99pub struct EventView<'a> {
100    pub header: EventHeader,
101    pub body: &'a [u8],
102}