coordinode-lsm-tree 5.7.0

Embedded LSM-tree storage engine: BuRR filters, zstd dictionary compression, MVCC, range tombstones, merge operators, K/V separation, AES-256-GCM at rest.
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
use super::*;
use crate::io::Cursor;
use crate::io::{ByteOrder, LittleEndian, ReadBytesExt};
use crate::{
    coding::Decode,
    comparator::default_comparator,
    table::{
        Block, BlockHandle, BlockOffset, IndexBlock, KeyedBlockHandle,
        block::{BlockType, Header, ParsedItem, Trailer},
    },
};
use varint_rs::VarintReader;

fn make_handles(count: usize) -> Vec<KeyedBlockHandle> {
    (0..count)
        .map(|i| {
            let key = format!("adj:out:vertex-0001:edge-{i:04}");
            KeyedBlockHandle::new(
                key.into(),
                i as u64,
                BlockHandle::new(BlockOffset((i as u64) * 4096), 4096),
            )
        })
        .collect()
}

fn make_index_block(restart_interval: u8) -> IndexBlock {
    let handles = make_handles(16);
    let bytes =
        IndexBlock::encode_into_vec_with_restart_interval(&handles, restart_interval).unwrap();
    IndexBlock::new(Block {
        data: bytes.into(),
        header: Header::test_dummy(BlockType::Index),
    })
}

fn make_corrupted_index_block_with_invalid_first_restart_head() -> IndexBlock {
    let handles = make_handles(16);
    let mut bytes = IndexBlock::encode_into_vec_with_restart_interval(&handles, 8).unwrap();
    let key_len_offset = first_restart_head_key_len_offset(&bytes);
    bytes[key_len_offset] = 0xFF;
    bytes[key_len_offset + 1] = 0xFF;
    bytes[key_len_offset + 2] = 0x03;
    IndexBlock::new(Block {
        data: bytes.into(),
        header: Header::test_dummy(BlockType::Index),
    })
}

fn first_restart_head_key_len_offset(bytes: &[u8]) -> usize {
    let mut cursor = Cursor::new(bytes);
    let marker = cursor.read_u8().unwrap();
    assert_eq!(marker, 0);
    let _ = BlockHandle::decode_from(&mut cursor).unwrap();
    let _ = cursor.read_u64_varint().unwrap();
    usize::try_from(cursor.position()).unwrap()
}

fn make_corrupted_index_block_with_invalid_binary_index_offset() -> IndexBlock {
    let handles = make_handles(16);
    let mut bytes = IndexBlock::encode_into_vec_with_restart_interval(&handles, 8).unwrap();

    let trailer_probe = IndexBlock::new(Block {
        data: bytes.clone().into(),
        header: Header::test_dummy(BlockType::Index),
    });
    let trailer_offset = Trailer::new(&trailer_probe.inner).trailer_offset();
    let binary_index_offset_pos = trailer_offset + 1 + 1 + core::mem::size_of::<u32>();
    #[expect(
        clippy::cast_possible_truncation,
        reason = "test block sizes stay well below u32::MAX"
    )]
    let invalid_binary_index_offset = (bytes.len() as u32).saturating_add(1);
    LittleEndian::write_u32(
        &mut bytes[binary_index_offset_pos..binary_index_offset_pos + core::mem::size_of::<u32>()],
        invalid_binary_index_offset,
    );

    IndexBlock::new(Block {
        data: bytes.into(),
        header: Header::test_dummy(BlockType::Index),
    })
}

#[test]
fn seek_clears_stale_front_cache_before_reposition() {
    let index = make_index_block(8);
    let mut iter = index.iter(default_comparator());
    let mut fresh = index.iter(default_comparator());

    assert!(iter.seek(b"adj:out:vertex-0001:edge-0002", 0));
    let seek_after_reposition = iter.seek(b"adj:out:vertex-0001:edge-0011", 0);
    let item_after_reposition = iter.next().map(|item| item.materialize(index.as_slice()));

    let fresh_seek = fresh.seek(b"adj:out:vertex-0001:edge-0011", 0);
    let fresh_item = fresh.next().map(|item| item.materialize(index.as_slice()));

    assert_eq!(seek_after_reposition, fresh_seek);
    assert_eq!(item_after_reposition, fresh_item);
}

#[test]
fn seek_upper_clears_stale_back_cache_before_reposition() {
    let index = make_index_block(8);
    let mut iter = index.iter(default_comparator());
    let mut fresh = index.iter(default_comparator());

    assert!(iter.seek_upper(b"adj:out:vertex-0001:edge-0011", SeqNo::MAX));
    let seek_after_reposition = iter.seek_upper(b"adj:out:vertex-0001:edge-0003", SeqNo::MAX);
    let item_after_reposition = iter
        .next_back()
        .map(|item| item.materialize(index.as_slice()));

    let fresh_seek = fresh.seek_upper(b"adj:out:vertex-0001:edge-0003", SeqNo::MAX);
    let fresh_item = fresh
        .next_back()
        .map(|item| item.materialize(index.as_slice()));

    assert_eq!(seek_after_reposition, fresh_seek);
    assert_eq!(item_after_reposition, fresh_item);
}

#[test]
fn seek_upper_keeps_first_covering_handle_in_compressed_interval() {
    let index = make_index_block(8);
    let mut iter = index.iter(default_comparator());

    assert!(iter.seek_upper(b"adj:out:vertex-0001:edge-0003z", SeqNo::MAX));
    let selected = iter.next_back().unwrap().materialize(index.as_slice());
    assert_eq!(
        selected.end_key().as_ref(),
        b"adj:out:vertex-0001:edge-0004"
    );
}

#[test]
fn seek_upper_keeps_exact_match_without_restoring_next_item() {
    let index = make_index_block(8);
    let mut iter = index.iter(default_comparator());

    assert!(iter.seek_upper(b"adj:out:vertex-0001:edge-0003", SeqNo::MAX));
    let selected = iter.next_back().unwrap().materialize(index.as_slice());
    assert_eq!(
        selected.end_key().as_ref(),
        b"adj:out:vertex-0001:edge-0003"
    );
}

#[test]
fn seek_upper_with_small_needle_restores_first_item_when_interval_trim_empties_stack() {
    let index = make_index_block(8);
    let mut iter = index.iter(default_comparator());

    assert!(iter.seek_upper(b"adj:out:vertex-0001:edge--001", SeqNo::MAX));
    let selected = iter.next_back().unwrap().materialize(index.as_slice());
    assert_eq!(
        selected.end_key().as_ref(),
        b"adj:out:vertex-0001:edge-0000"
    );
}

#[test]
fn seek_upper_exact_match_restart_interval_one_keeps_exact_handle() {
    let index = make_index_block(1);
    let mut iter = index.iter(default_comparator());

    assert!(iter.seek_upper(b"adj:out:vertex-0001:edge-0003", SeqNo::MAX));
    let selected = iter.next_back().unwrap().materialize(index.as_slice());
    assert_eq!(
        selected.end_key().as_ref(),
        b"adj:out:vertex-0001:edge-0003"
    );
}

#[test]
fn seek_upper_with_large_needle_keeps_back_cursor_at_last_item() {
    let index = make_index_block(8);
    let mut iter = index.iter(default_comparator());

    assert!(iter.seek_upper(b"adj:out:vertex-0001:edge-9999", SeqNo::MAX));
    let selected = iter.next_back().unwrap().materialize(index.as_slice());
    assert_eq!(
        selected.end_key().as_ref(),
        b"adj:out:vertex-0001:edge-0015"
    );
}

#[test]
fn seek_upper_between_intervals_keeps_next_restart_head() {
    let index = make_index_block(8);
    let mut iter = index.iter(default_comparator());

    assert!(iter.seek_upper(b"adj:out:vertex-0001:edge-0007z", SeqNo::MAX));
    let selected = iter.next_back().unwrap().materialize(index.as_slice());
    assert_eq!(
        selected.end_key().as_ref(),
        b"adj:out:vertex-0001:edge-0008"
    );
}

#[test]
fn seek_upper_forward_iteration_stops_after_first_covering_item() {
    let index = make_index_block(8);
    let mut iter = index.iter(default_comparator());

    assert!(iter.seek_upper(b"adj:out:vertex-0001:edge-0003z", SeqNo::MAX));

    let keys: Vec<Vec<u8>> = iter
        .map(|item| item.materialize(index.as_slice()).end_key().to_vec())
        .collect();

    assert_eq!(
        keys,
        vec![
            b"adj:out:vertex-0001:edge-0000".to_vec(),
            b"adj:out:vertex-0001:edge-0001".to_vec(),
            b"adj:out:vertex-0001:edge-0002".to_vec(),
            b"adj:out:vertex-0001:edge-0003".to_vec(),
            b"adj:out:vertex-0001:edge-0004".to_vec(),
        ]
    );
}

#[test]
fn seek_upper_bound_cursor_between_intervals_includes_next_restart_head() {
    let index = make_index_block(8);
    let mut iter = index.iter(default_comparator());

    assert!(
        iter.seek_upper_bound_cursor(b"adj:out:vertex-0001:edge-0007z", SeqNo::MAX)
            .unwrap()
    );

    let keys: Vec<Vec<u8>> = iter
        .map(|item| item.materialize(index.as_slice()).end_key().to_vec())
        .collect();

    assert_eq!(
        keys,
        vec![
            b"adj:out:vertex-0001:edge-0000".to_vec(),
            b"adj:out:vertex-0001:edge-0001".to_vec(),
            b"adj:out:vertex-0001:edge-0002".to_vec(),
            b"adj:out:vertex-0001:edge-0003".to_vec(),
            b"adj:out:vertex-0001:edge-0004".to_vec(),
            b"adj:out:vertex-0001:edge-0005".to_vec(),
            b"adj:out:vertex-0001:edge-0006".to_vec(),
            b"adj:out:vertex-0001:edge-0007".to_vec(),
            b"adj:out:vertex-0001:edge-0008".to_vec(),
        ]
    );
}

#[test]
fn seek_reposition_clears_stale_back_cache() {
    let index = make_index_block(8);
    let mut iter = index.iter(default_comparator());
    let mut control = index.iter(default_comparator());

    assert!(iter.seek_upper(b"adj:out:vertex-0001:edge-0011", SeqNo::MAX));
    assert_eq!(
        iter.decoder
            .peek_back()
            .unwrap()
            .materialize(index.as_slice())
            .end_key()
            .as_ref(),
        b"adj:out:vertex-0001:edge-0011"
    );

    assert!(iter.seek(b"adj:out:vertex-0001:edge-0003", 0));
    let item_after_reposition = iter
        .next_back()
        .map(|item| item.materialize(index.as_slice()));

    assert!(control.seek(b"adj:out:vertex-0001:edge-0003", 0));
    let control_item = control
        .next_back()
        .map(|item| item.materialize(index.as_slice()));

    assert_eq!(item_after_reposition, control_item);
    assert_eq!(
        item_after_reposition.unwrap().end_key().as_ref(),
        b"adj:out:vertex-0001:edge-0015"
    );
}

#[test]
fn seek_upper_reposition_clears_stale_front_cache() {
    let index = make_index_block(8);
    let mut iter = index.iter(default_comparator());
    let mut control = index.iter(default_comparator());

    assert!(iter.seek(b"adj:out:vertex-0001:edge-0002", 0));
    let stale_front_key = iter
        .decoder
        .peek()
        .unwrap()
        .materialize(index.as_slice())
        .end_key()
        .to_vec();

    assert!(iter.seek_upper(b"adj:out:vertex-0001:edge-0007", SeqNo::MAX));
    let item_after_reposition = iter
        .next_back()
        .map(|item| item.materialize(index.as_slice()));

    assert!(control.seek(b"adj:out:vertex-0001:edge-0002", 0));
    assert!(control.seek_upper(b"adj:out:vertex-0001:edge-0007", SeqNo::MAX));
    let control_item = control
        .next_back()
        .map(|item| item.materialize(index.as_slice()));

    assert_eq!(item_after_reposition, control_item);
    assert_ne!(
        item_after_reposition.unwrap().end_key().as_ref(),
        stale_front_key.as_slice()
    );
}

#[test]
fn next_stays_none_after_invalid_restart_head_parse() {
    let index = make_corrupted_index_block_with_invalid_first_restart_head();
    let mut iter = index.iter(default_comparator());

    assert!(iter.next().is_none());
    assert!(iter.next().is_none());
}

#[test]
fn try_iter_rejects_invalid_binary_index_offset() {
    let index = make_corrupted_index_block_with_invalid_binary_index_offset();
    // try_iter rejects the block eagerly due to invalid layout metadata
    assert!(
        matches!(
            index.try_iter(default_comparator()),
            Err(crate::Error::InvalidTrailer)
        ),
        "corrupt binary_index_offset must be rejected by try_iter",
    );
}

/// Finds the byte offset of the second restart head by reading the binary
/// index from the block trailer.
fn second_restart_head_byte_offset(bytes: &[u8]) -> usize {
    let probe = IndexBlock::new(Block {
        data: bytes.to_vec().into(),
        header: Header::test_dummy(BlockType::Index),
    });
    let trailer_offset = Trailer::new(&probe.inner).trailer_offset();
    let trailer = &bytes[trailer_offset..];

    // Trailer layout: restart_interval(u8)[0], step_size(u8)[1],
    //   binary_index_len(u32LE)[2..6], binary_index_offset(u32LE)[6..10], ...
    let step_size = trailer[1] as usize;
    let binary_index_offset = LittleEndian::read_u32(&trailer[6..10]) as usize;

    // Entry 1 in the binary index is the second restart head offset
    let entry_pos = binary_index_offset + step_size;
    if step_size == 2 {
        LittleEndian::read_u16(&bytes[entry_pos..entry_pos + 2]) as usize
    } else {
        LittleEndian::read_u32(&bytes[entry_pos..entry_pos + 4]) as usize
    }
}

/// Returns the byte offset of the first truncated (non-head) item in the
/// restart interval starting at `restart_offset`, after skipping the full
/// restart head + its key bytes.
fn first_truncated_item_offset_in_interval(bytes: &[u8], restart_offset: usize) -> usize {
    let mut cursor = Cursor::new(&bytes[restart_offset..]);
    // Restart head: marker(0) + BlockHandle + seqno + key_len + key_bytes
    let marker = cursor.read_u8().unwrap();
    assert_eq!(marker, 0, "expected restart head marker");
    let _ = BlockHandle::decode_from(&mut cursor).unwrap();
    let _ = cursor.read_u64_varint().unwrap();
    let key_len: u64 = cursor.read_u16_varint().unwrap().into();
    cursor.set_position(cursor.position() + key_len);
    // Now at the first truncated item
    let truncated_marker = cursor.read_u8().unwrap();
    assert_eq!(truncated_marker, 1, "second entry should be truncated");
    let _ = cursor.read_u16_varint().unwrap(); // shared prefix len
    // cursor is now at rest_key_len — corrupt THIS to break fill_stack
    restart_offset + usize::try_from(cursor.position()).unwrap()
}

fn make_index_block_with_corrupt_second_interval_item() -> IndexBlock {
    let handles = make_handles(16);
    let mut bytes = IndexBlock::encode_into_vec_with_restart_interval(&handles, 8).unwrap();
    let second_restart = second_restart_head_byte_offset(&bytes);
    let rest_key_len_pos = first_truncated_item_offset_in_interval(&bytes, second_restart);
    // Overwrite rest_key_len with an impossibly large varint
    bytes[rest_key_len_pos] = 0xFF;
    bytes[rest_key_len_pos + 1] = 0xFF;
    bytes[rest_key_len_pos + 2] = 0x03;
    IndexBlock::new(Block {
        data: bytes.into(),
        header: Header::test_dummy(BlockType::Index),
    })
}

#[test]
fn seek_upper_bound_cursor_returns_err_on_poisoned_cursor() {
    // Block layout: 16 entries with restart_interval=8 → 2 restart intervals.
    // First interval (entries 0-7, keys edge-0000..edge-0007) is valid.
    // Second interval has a corrupted non-head item (entry 9): its
    // rest_key_len is overwritten so fill_stack poisons the back cursor.
    // The restart head (entry 8) is valid so binary search still works.
    //
    // Needle "edge-0007z" lands in the first interval via binary search.
    // trim_back_to_upper_bound doesn't pop anything (all first-interval
    // items ≤ needle), but the stack tail "edge-0007" < "edge-0007z" so
    // the advance loop fires.
    // advance_upper_restart_interval clears the stack and tries to fill from
    // the corrupt second interval → fill_stack fails → stack empty →
    // seek_upper_bound_cursor must return Err(InvalidTrailer), not Ok(false).
    let index = make_index_block_with_corrupt_second_interval_item();
    let mut iter = index.iter(default_comparator());

    let result = iter.seek_upper_bound_cursor(b"adj:out:vertex-0001:edge-0007z", SeqNo::MAX);
    assert!(
        matches!(result, Err(crate::Error::InvalidTrailer)),
        "poisoned upper cursor must return Err(InvalidTrailer), got {result:?}",
    );
}