cuendillar 0.1.0

Embedded persistent key–value storage engine (LSM-tree based)
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
use std::{collections::HashSet, fmt::Debug, fs::File, io::Seek, path::Path, sync::OnceLock};

use tracing::instrument;

use crate::database::{
    OwnedEntry,
    iterator::merged_iterator::MergedIterator,
    sstable::{
        errors::SSTableError,
        metadata::{
            SSTMetadata, SSTableFooter, SSTableKeyRange, bloom_filter::bloom_factory::BloomFactory,
            index::index_factory::IndexFactory,
        },
        version::version_update::{VersionOperation, VersionUpdate},
    },
};
pub mod version_manager;
pub mod version_update;

#[derive(Clone)]
pub struct Version {
    poisened: bool,
    levels: Vec<Vec<SSTMetadata>>,
    commited_wal_offset: u64,
}
impl Debug for Version {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        let mut ds = f.debug_struct("Version");

        for (level_idx, level) in self.levels.iter().enumerate() {
            ds.field(&format!("level_{}", level_idx), level);
        }

        ds.finish()
    }
}

impl Version {
    pub fn new(levels: Vec<Vec<SSTMetadata>>, commited_wal_offset: u64) -> Self {
        Self {
            poisened: false,
            levels,
            commited_wal_offset: commited_wal_offset,
        }
    }
    pub fn get_commited_wal_offset(&self) -> u64 {
        self.commited_wal_offset
    }
    /// INDEX_SAFETY: This function is used by compaction which will only run if the tables in l0 is > 0
    pub fn get_level_tables(&self, level: usize) -> Option<&Vec<SSTMetadata>> {
        if self.levels.len() <= level {
            None
        } else {
            Some(&self.levels[level])
        }
    }
    #[instrument(name = "Version Find", skip(self))]
    pub fn find(&self, key: &[u8]) -> Result<Option<OwnedEntry>, SSTableError> {
        if self.poisened {
            return Err(SSTableError::PoisonedError);
        }
        // for l0 we will check for each and every sstable
        if self.levels.len() == 0 {
            return Ok(None);
        }
        for metatdata in self.levels[0].iter().rev() {
            // check if the key is in bloom filter and in the range of keys in the current table
            match metatdata.find(key)? {
                Some(val) => return Ok(Some(val)),
                None => {
                    continue;
                }
            }
        }
        // for next levels we will perform the data
        if self.levels.len() < 2 {
            return Ok(None);
        }

        // now for each level we will perform the binary search
        for level in &self.levels[1..] {
            /*
            we can assume that there will be no overlapping between data
            so there will be only one table which may contain the key
            find the table which contain the data and check for that table only
            */
            let target_table_metadata = match level.binary_search_by(|table_metadata| {
                if table_metadata.key_range.first_key.as_slice() <= key
                    && table_metadata.key_range.last_key.as_slice() >= key
                {
                    std::cmp::Ordering::Equal
                } else if table_metadata.key_range.last_key.as_slice() < key {
                    std::cmp::Ordering::Less
                } else {
                    std::cmp::Ordering::Greater
                }
            }) {
                Ok(i) => &level[i],
                _ => {
                    continue;
                }
            };
            // now we will have table which may contain the data in
            match target_table_metadata.find(key)? {
                Some(val) => return Ok(Some(val)),
                None => {
                    continue;
                }
            }
        }
        Ok(None)
    }

    #[instrument(name = "Apply version Update", skip(self, normalized_update))]
    pub fn apply_update(&mut self, normalized_update: VersionUpdate) -> Result<(), SSTableError> {
        use std::collections::HashMap;
        let mut adds: HashMap<usize, Vec<(usize, SSTMetadata)>> = HashMap::new();
        let mut dels: HashMap<usize, Vec<uuid::Uuid>> = HashMap::new();

        let wal_offset = normalized_update.wal_offset;

        for op in normalized_update.operations {
            match op {
                VersionOperation::Add { .. } => {
                    return Err(SSTableError::General(
                        "Add without metadata found in apply_update".into(),
                    ));
                }
                VersionOperation::AddWithMeta { level, meta, index } => {
                    adds.entry(level as usize)
                        .or_default()
                        .push((index as usize, meta));
                }
                VersionOperation::Del { level, id } => {
                    dels.entry(level as usize).or_default().push(id);
                }
            }
        }

        let max_level = adds.keys().chain(dels.keys()).copied().max().unwrap_or(0);

        if max_level >= self.levels.len() {
            self.levels.resize_with(max_level + 1, Vec::new);
        }

        for (level, ids) in dels {
            if level >= self.levels.len() {
                return Err(SSTableError::General(format!(
                    "Invalid level {} in Del",
                    level
                )));
            }

            let id_set: std::collections::HashSet<_> = ids.into_iter().collect();

            self.levels[level].retain(|meta| !id_set.contains(&meta.id));
        }

        // 4️⃣ Apply inserts (sorted by index to preserve intent)
        for (level, mut entries) in adds {
            let level_vec = &mut self.levels[level];

            // Sort by index to apply deterministically
            entries.sort_by_key(|(index, _)| *index);

            for (index, meta) in entries {
                let insert_index = index.min(level_vec.len());
                level_vec.insert(insert_index, meta);
            }
        }

        self.commited_wal_offset = std::cmp::max(wal_offset, self.commited_wal_offset);
        Ok(())
    }
    // this function will convert all the add to add with sstmetadata
    #[instrument(name = "Normalize Version Update Operation", skip(update, root_dir))]
    pub fn normalize_version_update_operation(
        update: &mut VersionUpdate,
        root_dir: &Path,
    ) -> Result<(), SSTableError> {
        // first tables that are added in this changelog so that we can remove deletion for those tables only
        let added_tables: HashSet<_> = update
            .operations
            .iter()
            .filter_map(|operation| match operation {
                VersionOperation::Del { level: _, id: _ } => {
                    return None;
                }
                VersionOperation::Add {
                    level: _,
                    id,
                    index: _,
                } => Some(*id),
                VersionOperation::AddWithMeta {
                    level: _,
                    meta,
                    index: _,
                } => {
                    return Some(meta.id);
                }
            })
            .collect();
        // first we will remove all the tables which are added first in the changelog and then deleted to pervent uneccessary operatons
        let mut removed_tables = HashSet::new();
        let original_updates = std::mem::take(&mut update.operations);
        update.operations = original_updates
            .into_iter()
            .rev()
            .filter(|operation| {
                match operation {
                    VersionOperation::Del { level, id } => {
                        removed_tables.insert(id.clone());
                        update.mark_file_to_be_deleted(root_dir.join(format!("l{}/{}", level, id)));
                        if added_tables.contains(id) {
                            return false;
                        }
                        return true;
                    }
                    VersionOperation::Add {
                        level: _,
                        id,
                        index: _,
                    } => {
                        if removed_tables.contains(id) {
                            return false;
                        } else {
                            return true;
                        }
                    }
                    // below case will not happen
                    VersionOperation::AddWithMeta {
                        level: _,
                        meta,
                        index: _,
                    } => {
                        if removed_tables.contains(&meta.id) {
                            return false;
                        } else {
                            return true;
                        }
                    }
                }
            })
            .collect::<Vec<VersionOperation>>()
            .into_iter()
            .rev()
            .collect();

        for op in &mut update.operations {
            // We only transform Add → AddWithMeta
            let new_op = match op {
                VersionOperation::Add { level, id, index } => {
                    let level = *level;
                    let id = *id;
                    let index = *index;

                    // Build file path
                    let table_file_path = root_dir.join(format!("l{}/{}", level, id));

                    // Open SST file
                    let mut table = File::open(&table_file_path)?;

                    // ---- Read footer ----
                    table.seek(std::io::SeekFrom::End(-32))?;
                    let table_footer = SSTableFooter::deserialize(&mut table)?;

                    // ---- Read bloom filter ----
                    table.seek(std::io::SeekFrom::Start(table_footer.data_block_size))?;

                    let bloom = BloomFactory::deserialize_bloom_filter(&mut table)?;

                    // ---- Read index ----
                    let index_block = IndexFactory::deserialize_index(&mut table)?;

                    // ---- Read key range ----
                    let key_range = SSTableKeyRange::deserialize(&mut table)?;

                    let meta = SSTMetadata::new(
                        id,
                        bloom.into(),
                        index_block.into(),
                        key_range.first_key,
                        key_range.last_key,
                        OnceLock::new(), // no FD caching here
                        table_file_path,
                        table_footer,
                    );

                    VersionOperation::AddWithMeta { level, meta, index }
                }

                // Keep everything else unchanged
                _ => continue,
            };
            // Replace old op with new one
            *op = new_op;
        }
        Ok(())
    }
    fn iter(
        &self,
        start_key: Option<&[u8]>,
        end_key: Option<&[u8]>,
    ) -> Result<MergedIterator, SSTableError> {
        let mut mi = MergedIterator::new();
        // returns true if the sstable lie in the specified range
        fn overlaps(table: &SSTMetadata, start: Option<&[u8]>, end: Option<&[u8]>) -> bool {
            if let Some(start_key) = start {
                if table.key_range.last_key.as_slice() < start_key {
                    return false;
                }
            }
            if let Some(end_key) = end {
                if table.key_range.first_key.as_slice() > end_key {
                    return false;
                }
            }
            true
        }
        for level in &self.levels {
            for table in level {
                if !overlaps(table, start_key, end_key) {
                    break; // safe because sorted & non-overlapping
                }
                let iter = table.iter(start_key, end_key)?;
                mi.add_iterator(iter);
            }
        }
        Ok(mi)
    }
}

#[cfg(test)]
mod test {

    use std::sync::Arc;

    use crate::database::{
        Entry,
        config::DbConfig,
        memtable::{Memtable, vector_memtable::VectorMemtable},
        sstable::version::{version_manager::VersionManager, version_update::VersionUpdate},
    };

    #[test]
    fn version_test_new_and_find() {
        let mut vm = VectorMemtable::new(None);
        let entities = vec![
            Entry::Row {
                seq_no: 1,
                key: b"id3",
                value: b"value3",
            },
            Entry::Row {
                seq_no: 2,
                key: b"id2",
                value: b"value2",
            },
            Entry::Row {
                seq_no: 3,
                key: b"id1",
                value: b"value1",
            },
        ];
        for i in entities.clone().into_iter().enumerate() {
            vm.insert(i.1, i.0 as u64);
        }

        let (config, _dir) = DbConfig::get_test_config();
        let (cleaner_channel_producer, _cleaner_channel_receiver) = std::sync::mpsc::channel();

        let version_manager = VersionManager::new(config, cleaner_channel_producer).unwrap();
        let v1 = version_manager.push_memtable(Arc::new(vm)).unwrap();
        assert_eq!(
            v1.find(b"id3").unwrap(),
            Some(
                Entry::Row {
                    seq_no: 1,
                    key: b"id3",
                    value: b"value3",
                }
                .into(),
            )
        );
        assert_eq!(
            v1.find(b"id2").unwrap(),
            Some(
                Entry::Row {
                    seq_no: 2,
                    key: b"id2",
                    value: b"value2",
                }
                .into(),
            )
        );
        assert_eq!(v1.find(b"id345").unwrap(), None);
    }
    #[test]
    fn version_test_add_lo_and_find() {
        let mut vm = VectorMemtable::new(None);
        let entities1 = vec![
            Entry::Row {
                seq_no: 1,
                key: b"id3",
                value: b"value3",
            },
            Entry::Row {
                seq_no: 2,
                key: b"id2",
                value: b"value2",
            },
            Entry::Row {
                seq_no: 3,
                key: b"id1",
                value: b"value1",
            },
        ];
        for i in entities1.clone().into_iter().enumerate() {
            vm.insert(i.1, i.0 as u64);
        }
        let vm = Arc::new(vm);
        let (config, _dir) = DbConfig::get_test_config();
        let (cleaner_channel_producer, _cleaner_channel_receiver) = std::sync::mpsc::channel();

        let mut version_manager = VersionManager::new(config, cleaner_channel_producer).unwrap();

        let v1 = version_manager.push_memtable(vm.clone()).unwrap();
        let mut vu1 = VersionUpdate::new(0);
        vu1.add_operation(
            crate::database::sstable::version::version_update::VersionOperation::AddWithMeta {
                level: 0,
                meta: v1,
                index: u32::MAX,
            },
        );
        version_manager.push_version_update(vu1).unwrap();
        // version_manager.push_l0_update(v1, vm.get_wal_offset());
        let entities2 = vec![
            Entry::Row {
                seq_no: 4,
                key: b"id3",
                value: b"2value3",
            },
            Entry::Row {
                seq_no: 5,
                key: b"id2",
                value: b"2value2",
            },
        ];
        let mut vm2 = VectorMemtable::new(None);
        for i in entities2.clone().into_iter().enumerate() {
            vm2.insert(i.1, (i.0 + 5) as u64);
        }
        let vm2 = Arc::new(vm2);
        let v2 = version_manager.push_memtable(vm2.clone()).unwrap();
        let mut vu2 = VersionUpdate::new(0);
        vu2.add_operation(
            crate::database::sstable::version::version_update::VersionOperation::AddWithMeta {
                level: 0,
                meta: v2,
                index: u32::MAX,
            },
        );
        version_manager.push_version_update(vu2).unwrap();
        // version_manager.push_l0_update(v2, vm2.get_wal_offset());
        let version = version_manager.get_latest_version();

        assert_eq!(
            version.find(b"id3").unwrap(),
            Some(
                Entry::Row {
                    seq_no: 4,
                    key: b"id3",
                    value: b"2value3",
                }
                .into(),
            )
        );
        assert_eq!(
            version.find(b"id1").unwrap(),
            Some(
                Entry::Row {
                    seq_no: 3,
                    key: b"id1",
                    value: b"value1",
                }
                .into(),
            )
        );
        assert_eq!(version.find(b"id34").unwrap(), None);
    }
}