candystore 1.0.0

A lean, efficient and fast persistent in-process key-value store
Documentation
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
use parking_lot::{Mutex, RwLock};
use smallvec::SmallVec;
use zerocopy::{FromBytes, Immutable, IntoBytes, KnownLayout};

use std::{
    collections::VecDeque,
    fs::File,
    mem::size_of,
    path::Path,
    sync::{
        Arc,
        atomic::{AtomicBool, AtomicU64, Ordering},
    },
};

use crate::internal::{
    DATA_ENTRY_OFFSET_MASK, DATA_FILE_SIGNATURE, DATA_FILE_VERSION, EntryType,
    FILE_OFFSET_ALIGNMENT, KEY_NAMESPACE_BITS, KVBuf, KVRef, KeyNamespace, MAX_KEY_NAMESPACE,
    PAGE_SIZE, READ_BUFFER_SIZE, SIZE_HINT_UNIT, data_file_path, entry_magic_offset,
    invalid_data_error, read_available_at, read_into_at, sync_dir, sync_file_range, write_all_at,
};
use crate::types::{Config, Error, MAX_USER_KEY_SIZE, MAX_USER_VALUE_SIZE, Result};

const INLINE_SCRATCH_BUFFER_SIZE: usize = 1024;

struct ParsedDataEntry {
    data_len: usize,
    vlen: u16,
    ns: u8,
}

#[derive(Clone, Copy, FromBytes, IntoBytes, KnownLayout, Immutable)]
#[repr(C)]
struct DataFileHeader {
    magic: [u8; 8],
    version: u32,
    _padding0: u32,
    ordinal: u64,
    _trailer: [u8; 4096 - 24],
}

const _: () = assert!(size_of::<DataFileHeader>() == PAGE_SIZE);

struct InflightSlot {
    seq: AtomicU64,
    ordinal: AtomicU64,
    offset: AtomicU64,
}

pub(crate) struct InflightTracker {
    snapshot_barrier: RwLock<()>,
    next_seq: AtomicU64,
    slots: Vec<InflightSlot>,
    completed_deltas: Vec<Mutex<VecDeque<(u64, i64)>>>,
}

impl InflightTracker {
    pub(crate) fn new(num_shards: usize) -> Self {
        Self {
            snapshot_barrier: RwLock::new(()),
            next_seq: AtomicU64::new(1),
            slots: (0..num_shards)
                .map(|_| InflightSlot {
                    seq: AtomicU64::new(0),
                    ordinal: AtomicU64::new(0),
                    offset: AtomicU64::new(0),
                })
                .collect(),
            completed_deltas: (0..num_shards)
                .map(|_| Mutex::new(VecDeque::new()))
                .collect(),
        }
    }

    fn reserve<'a>(
        &'a self,
        data_file: &DataFile,
        shard_idx: usize,
        len: u64,
        delta: i8,
    ) -> Result<(u64, InflightGuard<'a>)> {
        let _barrier = self.snapshot_barrier.read();
        let offset = data_file.allocate(len)?;
        let ordinal = data_file.file_ordinal;
        let seq = self.next_seq.fetch_add(1, Ordering::Relaxed);
        let slot = &self.slots[shard_idx];
        slot.ordinal.store(ordinal, Ordering::Relaxed);
        slot.offset.store(offset, Ordering::Relaxed);
        slot.seq.store(seq, Ordering::Release);

        Ok((
            offset,
            InflightGuard {
                tracker: self,
                shard_idx,
                seq,
                delta,
                armed: true,
            },
        ))
    }

    pub(crate) fn checkpoint_progress(&self, active_file: &DataFile) -> (u64, u64, i64) {
        let _barrier = self.snapshot_barrier.write();

        let mut min_slot: Option<(u64, u64, u64)> = None;
        for slot in &self.slots {
            let seq = slot.seq.load(Ordering::Acquire);
            if seq == 0 {
                continue;
            }
            let ordinal = slot.ordinal.load(Ordering::Relaxed);
            let offset = slot.offset.load(Ordering::Relaxed);
            let current = (seq, ordinal, offset);
            min_slot = Some(min_slot.map_or(current, |min_current| min_current.min(current)));
        }

        let checkpoint = min_slot
            .map(|(_, ordinal, offset)| (ordinal, offset))
            .unwrap_or_else(|| (active_file.file_ordinal, active_file.used_bytes()));
        let completed_before_seq = min_slot.map_or(u64::MAX, |(seq, _, _)| seq);
        let mut committed_delta = 0i64;
        for queue in &self.completed_deltas {
            let mut queue = queue.lock();
            while let Some(&(seq, delta)) = queue.front() {
                if seq >= completed_before_seq {
                    break;
                }
                queue.pop_front();
                committed_delta += delta;
            }
        }

        (checkpoint.0, checkpoint.1, committed_delta)
    }

    pub(crate) fn clear_all(&self) {
        let _barrier = self.snapshot_barrier.write();
        for slot in &self.slots {
            slot.seq.store(0, Ordering::Release);
            slot.ordinal.store(0, Ordering::Relaxed);
            slot.offset.store(0, Ordering::Relaxed);
        }
        for queue in &self.completed_deltas {
            queue.lock().clear();
        }
    }

    fn clear_matching(&self, shard_idx: usize, expected_seq: u64) {
        let _barrier = self.snapshot_barrier.read();
        let slot = &self.slots[shard_idx];
        if slot.seq.load(Ordering::Acquire) == expected_seq {
            slot.seq.store(0, Ordering::Release);
        }
    }

    fn complete_matching(&self, shard_idx: usize, expected_seq: u64, delta: i8) {
        let _barrier = self.snapshot_barrier.read();
        let slot = &self.slots[shard_idx];
        if slot.seq.load(Ordering::Acquire) == expected_seq {
            slot.seq.store(0, Ordering::Release);
            if delta != 0 {
                self.completed_deltas[shard_idx]
                    .lock()
                    .push_back((expected_seq, i64::from(delta)));
            }
        }
    }
}

pub(crate) struct InflightGuard<'a> {
    tracker: &'a InflightTracker,
    shard_idx: usize,
    seq: u64,
    delta: i8,
    armed: bool,
}

impl InflightGuard<'_> {
    pub(crate) fn complete(mut self) {
        if self.armed {
            self.tracker
                .complete_matching(self.shard_idx, self.seq, self.delta);
            self.armed = false;
        }
    }
}

impl Drop for InflightGuard<'_> {
    fn drop(&mut self) {
        if self.armed {
            self.tracker.clear_matching(self.shard_idx, self.seq);
        }
    }
}

pub(crate) struct DataFile {
    pub(crate) file: File,
    file_offset: AtomicU64,
    last_synced_offset: AtomicU64,
    sealed_for_rotation: AtomicBool,
    config: Arc<Config>,
    pub(crate) file_idx: u16,
    pub(crate) file_ordinal: u64,
    preallocated: bool,
    recovery_tail_upper_bound: u64,
}

impl DataFile {
    fn read_header(file: &File) -> Result<DataFileHeader> {
        let header =
            read_available_at(file, size_of::<DataFileHeader>(), 0).map_err(Error::IOError)?;
        if header.len() < size_of::<DataFileHeader>() {
            return Err(Error::IOError(std::io::Error::new(
                std::io::ErrorKind::UnexpectedEof,
                "data file header too short",
            )));
        }

        let header = DataFileHeader::read_from_bytes(&header).map_err(|_| {
            Error::IOError(std::io::Error::new(
                std::io::ErrorKind::InvalidData,
                "invalid data file header size",
            ))
        })?;
        if &header.magic != DATA_FILE_SIGNATURE || header.version != DATA_FILE_VERSION {
            return Err(Error::IOError(std::io::Error::new(
                std::io::ErrorKind::InvalidData,
                "invalid data file header",
            )));
        }

        Ok(header)
    }

    pub(crate) fn read_ordinal(base_path: &Path, file_idx: u16) -> Result<u64> {
        let file = File::options()
            .read(true)
            .open(data_file_path(base_path, file_idx))
            .map_err(Error::IOError)?;
        Ok(Self::read_header(&file)?.ordinal)
    }

    pub(crate) fn used_bytes(&self) -> u64 {
        self.file_offset.load(Ordering::Acquire)
    }

    pub(crate) fn recovery_tail_upper_bound(&self) -> u64 {
        self.recovery_tail_upper_bound
    }

    pub(crate) fn sync_data(&self, start_offset: u64, end_offset: u64) -> Result<()> {
        let used_bytes = self.used_bytes();
        let start_offset = start_offset.min(used_bytes);
        let end_offset = end_offset.min(used_bytes);
        if end_offset <= start_offset {
            return Ok(());
        }

        if !self.preallocated {
            self.file.sync_data().map_err(Error::IOError)?;
        } else {
            sync_file_range(
                &self.file,
                size_of::<DataFileHeader>() as u64 + start_offset,
                end_offset - start_offset,
            )?;
        }
        self.last_synced_offset
            .fetch_max(end_offset, Ordering::Release);
        Ok(())
    }

    pub(crate) fn sync_to_current(&self) -> Result<()> {
        let start = self.last_synced_offset.load(Ordering::Acquire);
        self.sync_data(start, self.used_bytes())
    }

    pub(crate) fn truncate_to_offset(&self, file_offset: u64) -> Result<()> {
        debug_assert_eq!(file_offset % FILE_OFFSET_ALIGNMENT, 0);
        if self.preallocated {
            // A crash between the two set_len calls would leave the file
            // non-preallocated.  That is harmless: the next open will
            // detect it as non-preallocated and fall back to sync_all
            // until rotation creates a fresh preallocated file.
            self.file
                .set_len(size_of::<DataFileHeader>() as u64 + file_offset)
                .map_err(Error::IOError)?;
            self.file
                .set_len(size_of::<DataFileHeader>() as u64 + self.config.max_data_file_size as u64)
                .map_err(Error::IOError)?;
        } else {
            self.file
                .set_len(size_of::<DataFileHeader>() as u64 + file_offset)
                .map_err(Error::IOError)?;
        }
        self.file_offset.store(file_offset, Ordering::Release);
        self.file.sync_all().map_err(Error::IOError)?;
        self.last_synced_offset
            .store(file_offset, Ordering::Release);
        Ok(())
    }

    fn used_data_upper_bound(file: &File, physical_data_len: u64) -> Result<u64> {
        if physical_data_len == 0 {
            return Ok(0);
        }

        let mut end = physical_data_len;
        while end > 0 {
            let start = end.saturating_sub(READ_BUFFER_SIZE as u64);
            let chunk = read_available_at(
                file,
                (end - start) as usize,
                size_of::<DataFileHeader>() as u64 + start,
            )
            .map_err(Error::IOError)?;
            if let Some(rel) = chunk.iter().rposition(|byte| *byte != 0) {
                let aligned = (start + rel as u64 + 1).next_multiple_of(FILE_OFFSET_ALIGNMENT);
                return Ok(aligned.min(physical_data_len));
            }
            end = start;
        }

        Ok(0)
    }

    /// Scans forward from offset 0, parsing each entry, and returns the
    /// aligned end of the last valid entry.  We temporarily set `file_offset`
    /// to `tail_upper_bound` so that `read_next_entry_ref` won't short-circuit
    /// before reaching it.  This is safe because `open` is single-threaded;
    /// the real value is overwritten by the caller immediately after.
    fn detect_used_bytes(&self, tail_upper_bound: u64) -> Result<u64> {
        if tail_upper_bound == 0 {
            return Ok(0);
        }

        self.file_offset.store(tail_upper_bound, Ordering::Release);

        let mut offset = 0u64;
        let mut read_buf = Vec::new();
        let mut buf_file_offset = 0u64;
        let mut last_durable_offset = 0u64;
        while let Some((_, _, next_offset)) =
            self.read_next_entry_ref(offset, &mut read_buf, &mut buf_file_offset)?
        {
            offset = next_offset;
            last_durable_offset = next_offset.next_multiple_of(FILE_OFFSET_ALIGNMENT);
        }

        Ok(last_durable_offset)
    }

    fn parse_data_entry(buf: &[u8], offset: u64) -> Result<ParsedDataEntry> {
        if buf.len() < 8 {
            return Err(Error::IOError(std::io::Error::new(
                std::io::ErrorKind::UnexpectedEof,
                "entry too short",
            )));
        }

        let header = u32::from_le_bytes(buf[0..4].try_into().unwrap());
        let magic_offset = entry_magic_offset(offset);

        if header & DATA_ENTRY_OFFSET_MASK != magic_offset {
            return Err(Error::IOError(std::io::Error::new(
                std::io::ErrorKind::InvalidData,
                "corrupt entry magic",
            )));
        }

        let klen = u16::from_le_bytes(buf[4..6].try_into().unwrap());
        let vlen = u16::from_le_bytes(buf[6..8].try_into().unwrap());
        let entry_len = 4 + 4 + klen as usize + vlen as usize + 2;
        if buf.len() < entry_len {
            return Err(Error::IOError(std::io::Error::new(
                std::io::ErrorKind::UnexpectedEof,
                "entry too short",
            )));
        }

        let checksum = u16::from_le_bytes(buf[entry_len - 2..entry_len].try_into().unwrap());
        if checksum != crc16_ibm3740_fast::hash(&buf[..entry_len - 2]) as u16 {
            return Err(Error::IOError(std::io::Error::new(
                std::io::ErrorKind::InvalidData,
                "checksum mismatch",
            )));
        }

        let ns = ((header >> 24) & ((1 << KEY_NAMESPACE_BITS) - 1)) as u8;
        let entry_type = (header >> 30) & 0b11;
        if entry_type != EntryType::Insert as u32 && entry_type != EntryType::Update as u32 {
            return Err(Error::IOError(std::io::Error::new(
                std::io::ErrorKind::InvalidData,
                "invalid entry type",
            )));
        }

        Ok(ParsedDataEntry {
            data_len: 8 + vlen as usize + klen as usize,
            vlen,
            ns,
        })
    }

    pub(crate) fn open(
        base_path: &Path,
        config: Arc<Config>,
        file_idx: u16,
        validate_tail: bool,
    ) -> Result<Self> {
        let file = File::options()
            .read(true)
            .write(true)
            .open(data_file_path(base_path, file_idx))
            .map_err(Error::IOError)?;
        let header = Self::read_header(&file)?;
        let physical_data_len = file
            .metadata()
            .map_err(Error::IOError)?
            .len()
            .saturating_sub(size_of::<DataFileHeader>() as u64);
        let preallocated = physical_data_len == config.max_data_file_size as u64;
        let recovery_tail_upper_bound = Self::used_data_upper_bound(&file, physical_data_len)?;

        let inst = Self {
            file,
            file_offset: AtomicU64::new(physical_data_len),
            last_synced_offset: AtomicU64::new(0),
            sealed_for_rotation: AtomicBool::new(false),
            config,
            file_idx,
            file_ordinal: header.ordinal,
            preallocated,
            recovery_tail_upper_bound,
        };
        let used_bytes = if validate_tail {
            inst.detect_used_bytes(recovery_tail_upper_bound)?
        } else {
            recovery_tail_upper_bound
        };
        inst.file_offset.store(used_bytes, Ordering::Release);
        inst.last_synced_offset.store(used_bytes, Ordering::Release);

        Ok(inst)
    }

    pub(crate) fn create(
        base_path: &Path,
        config: Arc<Config>,
        file_idx: u16,
        ordinal: u64,
    ) -> Result<Self> {
        let file = File::options()
            .create(true)
            .truncate(true)
            .read(true)
            .write(true)
            .open(data_file_path(base_path, file_idx))
            .map_err(Error::IOError)?;
        file.set_len(size_of::<DataFileHeader>() as u64 + config.max_data_file_size as u64)
            .map_err(Error::IOError)?;
        let header = DataFileHeader {
            magic: *DATA_FILE_SIGNATURE,
            version: DATA_FILE_VERSION,
            _padding0: 0,
            ordinal,
            _trailer: [0; 4096 - 24],
        };
        write_all_at(&file, header.as_bytes(), 0).map_err(Error::IOError)?;
        file.sync_all().map_err(Error::IOError)?;
        sync_dir(base_path)?;
        Ok(Self {
            file,
            file_offset: AtomicU64::new(0),
            last_synced_offset: AtomicU64::new(0),
            sealed_for_rotation: AtomicBool::new(false),
            config,
            file_idx,
            file_ordinal: ordinal,
            preallocated: true,
            recovery_tail_upper_bound: 0,
        })
    }

    pub(crate) fn seal_for_rotation(&self) {
        self.sealed_for_rotation.store(true, Ordering::SeqCst);
    }

    fn allocate(&self, len: u64) -> Result<u64> {
        if self.sealed_for_rotation.load(Ordering::SeqCst) {
            return Err(Error::RotateDataFile(self.file_idx));
        }
        let mut file_offset = self.file_offset.load(Ordering::Relaxed);
        loop {
            if file_offset + len > self.config.max_data_file_size as u64 {
                return Err(Error::RotateDataFile(self.file_idx));
            }
            match self.file_offset.compare_exchange(
                file_offset,
                file_offset + len,
                Ordering::Relaxed,
                Ordering::Relaxed,
            ) {
                Ok(_) => return Ok(file_offset),
                Err(current) => file_offset = current,
            }
        }
    }

    fn append_entry<'a>(
        &self,
        entry_type: EntryType,
        ns: KeyNamespace,
        key: &[u8],
        val: Option<&[u8]>,
        shard_idx: usize,
        inflight_tracker: &'a InflightTracker,
    ) -> Result<(u64, usize, InflightGuard<'a>)> {
        debug_assert!(key.len() <= MAX_USER_KEY_SIZE);
        debug_assert!(ns as u8 <= MAX_KEY_NAMESPACE);

        let val_len = val.map_or(0, |v| v.len());
        if let Some(v) = val {
            debug_assert!(v.len() <= MAX_USER_VALUE_SIZE);
        }

        let entry_len = 4 + if val.is_some() { 4 } else { 2 } + val_len + key.len() + 2;
        let aligned_len = entry_len.next_multiple_of(FILE_OFFSET_ALIGNMENT as usize);
        let delta = match entry_type {
            EntryType::Insert => 1,
            EntryType::Tombstone => -1,
            _ => 0,
        };
        let (file_offset, inflight_guard) =
            inflight_tracker.reserve(self, shard_idx, aligned_len as u64, delta)?;
        debug_assert!(file_offset % FILE_OFFSET_ALIGNMENT == 0);

        let mut buf = SmallVec::<[u8; INLINE_SCRATCH_BUFFER_SIZE]>::with_capacity(aligned_len);
        // We overwrite the entry bytes below and only zero the alignment padding.
        unsafe { buf.set_len(aligned_len) };
        let buf = &mut buf[..];

        let magic_offset = entry_magic_offset(file_offset);
        let header = magic_offset | ((entry_type as u32) << 30) | ((ns as u32) << 24);

        buf[0..4].copy_from_slice(&header.to_le_bytes());
        buf[4..6].copy_from_slice(&(key.len() as u16).to_le_bytes());

        if let Some(v) = val {
            buf[6..8].copy_from_slice(&(v.len() as u16).to_le_bytes());
            buf[8..8 + v.len()].copy_from_slice(v);
            buf[8 + v.len()..8 + v.len() + key.len()].copy_from_slice(key);
        } else {
            buf[6..6 + key.len()].copy_from_slice(key);
        }

        // use a non-zero padding byte
        buf[entry_len..aligned_len].fill(0xff);
        let checksum = crc16_ibm3740_fast::hash(&buf[..entry_len - 2]) as u16;
        buf[entry_len - 2..entry_len].copy_from_slice(&checksum.to_le_bytes());

        let res = write_all_at(
            &self.file,
            buf,
            size_of::<DataFileHeader>() as u64 + file_offset,
        )
        .map_err(Error::IOError);
        res?;

        Ok((file_offset, aligned_len, inflight_guard))
    }

    pub(crate) fn append_kv<'a>(
        &self,
        entry_type: EntryType,
        ns: KeyNamespace,
        key: &[u8],
        val: &[u8],
        shard_idx: usize,
        inflight_tracker: &'a InflightTracker,
    ) -> Result<(u64, usize, InflightGuard<'a>)> {
        debug_assert!(matches!(entry_type, EntryType::Insert | EntryType::Update));
        self.append_entry(entry_type, ns, key, Some(val), shard_idx, inflight_tracker)
    }

    pub(crate) fn append_tombstone<'a>(
        &self,
        ns: KeyNamespace,
        key: &[u8],
        shard_idx: usize,
        inflight_tracker: &'a InflightTracker,
    ) -> Result<(u64, usize, InflightGuard<'a>)> {
        self.append_entry(
            EntryType::Tombstone,
            ns,
            key,
            None,
            shard_idx,
            inflight_tracker,
        )
    }

    pub(crate) fn read_kv_into<'a>(
        &self,
        offset: u64,
        size_hint: usize,
        buf: &'a mut Vec<u8>,
    ) -> Result<KVRef<'a>> {
        debug_assert!(size_hint >= SIZE_HINT_UNIT);
        read_into_at(
            &self.file,
            buf,
            size_hint,
            size_of::<DataFileHeader>() as u64 + offset,
        )
        .map_err(Error::IOError)?;
        let parsed = Self::parse_data_entry(buf, offset)?;
        buf.truncate(parsed.data_len);
        Ok(KVRef {
            buf,
            vlen: parsed.vlen,
            header_len: 8,
            ns: parsed.ns,
            entry_type: EntryType::Insert,
        })
    }

    pub(crate) fn read_kv(&self, offset: u64, size_hint: usize) -> Result<KVBuf> {
        debug_assert!(size_hint >= SIZE_HINT_UNIT);
        let mut buf = read_available_at(
            &self.file,
            size_hint,
            size_of::<DataFileHeader>() as u64 + offset,
        )
        .map_err(Error::IOError)?;
        let parsed = Self::parse_data_entry(&buf, offset)?;
        buf.truncate(parsed.data_len);
        Ok(KVBuf {
            buf,
            vlen: parsed.vlen,
            header_len: 8,
            ns: parsed.ns,
            entry_type: EntryType::Insert,
        })
    }

    fn ensure_verified_entry(
        &self,
        read_buf: &mut Vec<u8>,
        buf_file_offset: &mut u64,
        rel: usize,
        entry_len: usize,
        offset: u64,
    ) -> Result<Option<usize>> {
        let start = if read_buf.len() - rel >= entry_len {
            rel
        } else {
            read_into_at(
                &self.file,
                read_buf,
                entry_len,
                size_of::<DataFileHeader>() as u64 + offset,
            )
            .map_err(Error::IOError)?;
            *buf_file_offset = offset;
            if read_buf.len() < entry_len {
                return Ok(None);
            }
            0
        };

        let entry_bytes = &read_buf[start..start + entry_len];
        let checksum =
            u16::from_le_bytes(entry_bytes[entry_len - 2..entry_len].try_into().unwrap());
        if checksum != crc16_ibm3740_fast::hash(&entry_bytes[..entry_len - 2]) as u16 {
            return Ok(None);
        }

        Ok(Some(start))
    }

    pub(crate) fn read_next_entry_ref<'a>(
        &self,
        mut offset: u64,
        read_buf: &'a mut Vec<u8>,
        buf_file_offset: &mut u64,
    ) -> Result<Option<(KVRef<'a>, u64, u64)>> {
        let used_bytes = self.used_bytes();
        if offset >= used_bytes {
            return Ok(None);
        }
        offset = offset.next_multiple_of(FILE_OFFSET_ALIGNMENT);

        loop {
            if offset >= used_bytes {
                return Ok(None);
            }
            let buf_start = if offset >= *buf_file_offset {
                (offset - *buf_file_offset) as usize
            } else {
                read_buf.clear();
                0
            };

            if buf_start >= read_buf.len() || read_buf.len() - buf_start < 8 {
                read_into_at(
                    &self.file,
                    read_buf,
                    READ_BUFFER_SIZE,
                    size_of::<DataFileHeader>() as u64 + offset,
                )
                .map_err(Error::IOError)?;
                *buf_file_offset = offset;
                if read_buf.len() < 8 {
                    return Ok(None);
                }
            }

            let rel = (offset - *buf_file_offset) as usize;
            let avail = &read_buf[rel..];

            let header = u32::from_le_bytes(avail[0..4].try_into().unwrap());
            let magic_offset = entry_magic_offset(offset);
            if header & DATA_ENTRY_OFFSET_MASK != magic_offset {
                offset += FILE_OFFSET_ALIGNMENT;
                continue;
            }

            let ns = ((header >> 24) & ((1 << KEY_NAMESPACE_BITS) - 1)) as u8;
            let entry_type = (header >> 30) & 0b11;

            match entry_type {
                x if x == EntryType::Insert as u32 || x == EntryType::Update as u32 => {
                    let resolved_type = if x == EntryType::Insert as u32 {
                        EntryType::Insert
                    } else {
                        EntryType::Update
                    };
                    let klen = u16::from_le_bytes(avail[4..6].try_into().unwrap());
                    let vlen = u16::from_le_bytes(avail[6..8].try_into().unwrap());
                    let entry_len = 4 + 4 + klen as usize + vlen as usize + 2;

                    let Some(start) = self.ensure_verified_entry(
                        read_buf,
                        buf_file_offset,
                        rel,
                        entry_len,
                        offset,
                    )?
                    else {
                        offset += FILE_OFFSET_ALIGNMENT;
                        continue;
                    };
                    let buf = &read_buf[start..start + 8 + vlen as usize + klen as usize];

                    return Ok(Some((
                        KVRef {
                            buf,
                            vlen,
                            header_len: 8,
                            ns,
                            entry_type: resolved_type,
                        },
                        offset,
                        offset + entry_len as u64,
                    )));
                }
                x if x == EntryType::Tombstone as u32 => {
                    let klen = u16::from_le_bytes(avail[4..6].try_into().unwrap());
                    let entry_len = 4 + 2 + klen as usize + 2;

                    let Some(start) = self.ensure_verified_entry(
                        read_buf,
                        buf_file_offset,
                        rel,
                        entry_len,
                        offset,
                    )?
                    else {
                        offset += FILE_OFFSET_ALIGNMENT;
                        continue;
                    };
                    let buf = &read_buf[start..start + 6 + klen as usize];

                    return Ok(Some((
                        KVRef {
                            buf,
                            vlen: 0,
                            header_len: 6,
                            ns,
                            entry_type: EntryType::Tombstone,
                        },
                        offset,
                        offset + entry_len as u64,
                    )));
                }
                _ => {
                    return Err(invalid_data_error("unknown data entry type"));
                }
            }
        }
    }
}