cobble 0.1.0

A flexible embedded key-value storage engine for distributed systems as well as single-node applications.
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
use crate::error::{Error, Result};
use crate::file::{BufferedWriter, File, SequentialWriteFile};
use crate::format::FileBuilder;
use crate::sst::bloom::BloomFilterBuilder;
use crate::sst::compression::{SstCompressionAlgorithm, write_block};
use crate::sst::format::{BlockBuilder, Footer};
use crate::sst::row_codec::{encode_key, encode_value};
use crate::r#type::{Key, KvValue, Value};
use bytes::{BufMut, Bytes, BytesMut};
use metrics::{Histogram, histogram};

#[derive(Clone)]
struct DataBlockMeta {
    first_key: Vec<u8>,
    offset: u64,
    size: u64,
    key_hashes: Vec<u64>,
}

#[derive(Clone)]
pub(crate) struct SSTWriterMetrics {
    compression_ratio: Histogram,
}

impl SSTWriterMetrics {
    pub(crate) fn new(db_id: &str, compression: SstCompressionAlgorithm) -> Self {
        Self {
            compression_ratio: histogram!(
                "sst_block_compression_ratio",
                "db_id" => db_id.to_string(),
                "compression" => compression.label()
            ),
        }
    }
}

#[derive(Clone)]
pub struct SSTWriterOptions {
    /// Optional metrics handles to reuse across writers.
    pub metrics: Option<SSTWriterMetrics>,
    pub block_size: usize,
    pub buffer_size: usize,
    /// Number of columns in the value schema.
    /// Used for encoding values with the row codec.
    pub num_columns: usize,
    /// Enable bloom filter generation for SST files.
    pub bloom_filter_enabled: bool,
    /// Bits per key for bloom filter when enabled.
    pub bloom_bits_per_key: u32,
    /// Enable two-level index/filter blocks.
    pub partitioned_index: bool,
    /// Compression algorithm for data blocks.
    pub compression: SstCompressionAlgorithm,
}

impl Default for SSTWriterOptions {
    fn default() -> Self {
        Self {
            metrics: None,
            block_size: 4096,
            buffer_size: 8192,
            num_columns: 1,
            bloom_filter_enabled: false,
            bloom_bits_per_key: 10,
            partitioned_index: false,
            compression: SstCompressionAlgorithm::None,
        }
    }
}

/// Writer for creating SST files
pub struct SSTWriter<W: SequentialWriteFile> {
    writer: BufferedWriter<W>,
    options: SSTWriterOptions,
    metrics: SSTWriterMetrics,
    data_block_builder: BlockBuilder,
    bloom_filter_builder: Option<BloomFilterBuilder>,
    first_key: Option<Vec<u8>>,
    last_key: Vec<u8>,
    current_block_first_key: Option<Vec<u8>>,
    pending_data_blocks: Vec<DataBlockMeta>,
}

impl<W: SequentialWriteFile> SSTWriter<W> {
    pub fn new(writer: W, options: SSTWriterOptions) -> Self {
        let buffered_writer = BufferedWriter::new(writer, options.buffer_size);
        let data_block_builder = BlockBuilder::new(options.block_size);
        let metrics = options
            .metrics
            .clone()
            .unwrap_or_else(|| SSTWriterMetrics::new("unknown", options.compression));
        let bloom_filter_builder = if options.bloom_filter_enabled {
            Some(BloomFilterBuilder::new(options.bloom_bits_per_key))
        } else {
            None
        };

        Self {
            writer: buffered_writer,
            options,
            metrics,
            data_block_builder,
            bloom_filter_builder,
            first_key: None,
            last_key: Vec::new(),
            current_block_first_key: None,
            pending_data_blocks: Vec::new(),
        }
    }

    /// Add a key-value pair to the SST file
    /// Keys must be added in sorted order
    pub fn add(&mut self, key: &[u8], value: &[u8]) -> Result<()> {
        // Ensure keys are added in sorted order
        if !self.last_key.is_empty() && key <= self.last_key.as_slice() {
            return Err(Error::IoError(format!(
                "Keys must be added in sorted order: {:?} <= {:?}",
                key, self.last_key
            )));
        }

        // Track first key of the entire file
        if self.first_key.is_none() {
            self.first_key = Some(key.to_vec());
        }

        // If this is the first key in the block, remember it for the index
        if self.data_block_builder.is_empty() {
            self.current_block_first_key = Some(key.to_vec());
        }

        // Add to current data block
        self.data_block_builder.add(key, value);
        if let Some(builder) = &mut self.bloom_filter_builder {
            builder.add(key);
        }
        self.last_key = key.to_vec();

        // Check if we should finish the current block
        if self.data_block_builder.should_finish() {
            let first_key = self.current_block_first_key.take().unwrap();
            self.finish_data_block(first_key)?;
        }

        Ok(())
    }

    /// Add a typed Key and Value to the SST file.
    /// Uses the row codec to serialize the key and value.
    /// Keys must be added in sorted order (by encoded key bytes).
    ///
    /// # Arguments
    /// * `key` - The typed Key to add
    /// * `value` - The Value containing optional columns
    pub fn add_kv(&mut self, key: &Key, value: &Value) -> Result<()> {
        let encoded_key = encode_key(key);
        let encoded_value = encode_value(value, self.options.num_columns);
        self.add(&encoded_key, &encoded_value)
    }

    fn finish_data_block(&mut self, first_key: Vec<u8>) -> Result<()> {
        if self.data_block_builder.is_empty() {
            return Ok(());
        }

        // Replace the builder with a new one and build the old one
        let old_builder = std::mem::replace(
            &mut self.data_block_builder,
            BlockBuilder::new(self.options.block_size),
        );
        let mut block = old_builder.build();
        let block_id = self.pending_data_blocks.len() as u32;
        block.set_block_id(block_id);
        let offset = self.writer.offset();
        let encoded = block.encode();
        let raw_len = encoded.len();

        // Write the block
        let size = write_block(&mut self.writer, encoded, self.options.compression)?;
        self.record_compression_ratio(raw_len, size);

        // Remember block info for index
        let mut key_hashes = Vec::new();
        if let Some(builder) = &mut self.bloom_filter_builder
            && self.options.partitioned_index
        {
            // For partitioned index, we need to collect key hashes per data block
            key_hashes = builder.drain_recent_hashes();
        }
        self.pending_data_blocks.push(DataBlockMeta {
            first_key,
            offset: offset as u64,
            size: size as u64,
            key_hashes,
        });

        Ok(())
    }

    fn record_compression_ratio(&self, raw_len: usize, compressed_len: usize) {
        if raw_len == 0 {
            return;
        }
        let ratio = compressed_len as f64 / raw_len as f64;
        self.metrics.compression_ratio.record(ratio);
    }

    /// Finish writing the SST file and return (first_key, last_key, file_size, footer_bytes).
    /// This writes the index block and footer, and returns the key range.
    fn finish_internal(mut self) -> Result<(Vec<u8>, Vec<u8>, usize, Bytes)> {
        // Capture first/last keys before finishing
        let first_key = self.first_key.clone().unwrap_or_default();
        let last_key = self.last_key.clone();

        // Finish any pending data block
        if !self.data_block_builder.is_empty() {
            let block_first_key = self.current_block_first_key.take().unwrap_or_default();
            self.finish_data_block(block_first_key)?;
        }

        if !self.options.partitioned_index {
            // Write single-level index
            let mut index_builder = BlockBuilder::new(self.options.block_size);

            for meta in &self.pending_data_blocks {
                let mut value = BytesMut::with_capacity(16);
                value.put_u64_le(meta.offset);
                value.put_u64_le(meta.size);
                index_builder.add(&meta.first_key, &value);
            }

            // Write index block
            let index_offset = self.writer.offset();
            let index_size = index_builder.write_to(&mut self.writer)?;
            // Write bloom filter block if enabled
            let (filter_offset, filter_size, filter_enabled) =
                if let Some(filter_builder) = &mut self.bloom_filter_builder {
                    let filter_offset = self.writer.offset();
                    let filter_size = filter_builder.write_to(&mut self.writer)?;
                    (filter_offset as u64, filter_size as u64, filter_size > 0)
                } else {
                    (0u64, 0u64, false)
                };

            // Write footer
            let footer = Footer::new(
                index_offset as u64,
                index_size as u64,
                filter_offset,
                filter_size,
                filter_enabled,
                false,
            );
            let footer_encoded = footer.encode();
            self.writer.write(&footer_encoded)?;

            let file_size = self.writer.offset();
            let mut writer = self.writer;
            writer.close()?;

            return Ok((first_key, last_key, file_size, footer_encoded));
        }

        // Write two-level index
        let mut index_top_builder = BlockBuilder::new(self.options.block_size);
        let mut filter_index_builder = BlockBuilder::new(self.options.block_size);

        let mut index_builder = BlockBuilder::new(self.options.block_size);
        let mut index_partition_first_key: Option<&Vec<u8>> = None;
        // Current bloom filter builder for the partition, maybe optional if bloom filter is disabled
        let mut current_filter_builder = self
            .bloom_filter_builder
            .as_ref()
            .map(|_| BloomFilterBuilder::new(self.options.bloom_bits_per_key));

        // Build index and filter blocks for each data block
        for meta in &self.pending_data_blocks {
            if index_partition_first_key.is_none() {
                index_partition_first_key = Some(&meta.first_key);
            }

            let mut value = BytesMut::with_capacity(16);
            value.put_u64_le(meta.offset);
            value.put_u64_le(meta.size);
            index_builder.add(&meta.first_key, &value);

            if let Some(filter_builder) = &mut current_filter_builder {
                filter_builder.extend_hashes(&meta.key_hashes);
            }

            // Finish one partition if needed
            if index_builder.should_finish() {
                let index_offset = self.writer.offset();
                let index_size = index_builder.write_to(&mut self.writer)?;
                let first_key = index_partition_first_key
                    .take()
                    .expect("There should be at least one key");
                let mut top_value = BytesMut::with_capacity(16);
                top_value.put_u64_le(index_offset as u64);
                top_value.put_u64_le(index_size as u64);
                index_top_builder.add(first_key, &top_value);
                index_builder.clear();

                if let Some(filter_builder) = &mut current_filter_builder {
                    let filter_offset = self.writer.offset();
                    let filter_size = filter_builder.write_to(&mut self.writer)?;
                    if filter_size > 0 {
                        let mut filter_value = BytesMut::with_capacity(16);
                        filter_value.put_u64_le(filter_offset as u64);
                        filter_value.put_u64_le(filter_size as u64);
                        filter_index_builder.add(first_key, &filter_value);
                    }
                    *filter_builder = BloomFilterBuilder::new(self.options.bloom_bits_per_key);
                }
            }
        }

        // Finish any remaining index partition
        if !index_builder.is_empty() {
            let index_offset = self.writer.offset();
            let index_size = index_builder.write_to(&mut self.writer)?;
            let first_key = index_partition_first_key
                .take()
                .expect("There should be at least one key");
            let mut top_value = BytesMut::with_capacity(16);
            top_value.put_u64_le(index_offset as u64);
            top_value.put_u64_le(index_size as u64);
            index_top_builder.add(first_key, &top_value);

            if let Some(filter_builder) = &mut current_filter_builder {
                let filter_offset = self.writer.offset();
                let filter_size = filter_builder.write_to(&mut self.writer)?;
                if filter_size > 0 {
                    let mut filter_value = BytesMut::with_capacity(16);
                    filter_value.put_u64_le(filter_offset as u64);
                    filter_value.put_u64_le(filter_size as u64);
                    filter_index_builder.add(first_key, &filter_value);
                }
            }
        }

        // Write filter index block if enabled and not empty
        let filter_enabled =
            self.bloom_filter_builder.is_some() && !filter_index_builder.is_empty();
        let (filter_index_offset, filter_index_size) = if filter_enabled {
            let filter_index_offset = self.writer.offset();
            let filter_index_size = filter_index_builder.write_to(&mut self.writer)?;
            (filter_index_offset, filter_index_size)
        } else {
            (0usize, 0usize)
        };
        // Write top-level index block
        let index_top_offset = self.writer.offset();
        let index_top_size = index_top_builder.write_to(&mut self.writer)?;
        let filter_offset = filter_index_offset as u64;
        let filter_size = filter_index_size as u64;

        // Write footer
        let footer = Footer::new(
            index_top_offset as u64,
            index_top_size as u64,
            filter_offset,
            filter_size,
            filter_enabled,
            self.options.partitioned_index,
        );
        let footer_encoded = footer.encode();
        self.writer.write(&footer_encoded)?;

        // Get final file size before closing
        let file_size = self.writer.offset();

        // Flush and close
        let mut writer = self.writer;
        writer.close()?;

        Ok((first_key, last_key, file_size, footer_encoded))
    }

    /// Finish writing the SST file
    /// This writes the index block and footer
    pub fn finish(self) -> Result<()> {
        self.finish_internal()?;
        Ok(())
    }

    /// Finish writing the SST file and return (first_key, last_key, file_size, footer_bytes).
    /// This writes the index block and footer, and returns the key range and total file size.
    pub fn finish_with_range(self) -> Result<(Vec<u8>, Vec<u8>, usize, Bytes)> {
        self.finish_internal()
    }

    /// Returns the current offset (bytes written) in the file.
    pub fn offset(&self) -> usize {
        self.writer.offset()
    }

    /// Returns true if no keys have been added yet.
    pub fn is_empty(&self) -> bool {
        self.first_key.is_none()
    }

    /// Returns the first key added to this file, if any.
    pub fn first_key(&self) -> Option<&[u8]> {
        self.first_key.as_deref()
    }

    /// Returns the last key added to this file.
    pub fn last_key(&self) -> &[u8] {
        &self.last_key
    }
}

/// Implement FileBuilder trait for SSTWriter to support compaction.
impl<W: SequentialWriteFile + 'static> FileBuilder for SSTWriter<W> {
    fn add(&mut self, key: &[u8], value: &KvValue) -> Result<()> {
        match value {
            KvValue::Encoded(bytes) => SSTWriter::add(self, key, bytes),
            KvValue::Decoded(v) => {
                let encoded = encode_value(v, v.columns().len());
                SSTWriter::add(self, key, &encoded)
            }
        }
    }

    fn finish(self: Box<Self>) -> Result<(Vec<u8>, Vec<u8>, usize, Bytes)> {
        (*self).finish_with_range()
    }

    fn offset(&self) -> usize {
        SSTWriter::offset(self)
    }

    fn is_empty(&self) -> bool {
        SSTWriter::is_empty(self)
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use crate::file::FileSystemRegistry;

    #[test]
    #[serial_test::serial(file)]
    fn test_sst_writer_basic() {
        let _ = std::fs::remove_dir_all("/tmp/sst_writer_test");
        let registry = FileSystemRegistry::new();
        let fs = registry
            .get_or_register("file:///tmp/sst_writer_test".to_string())
            .unwrap();

        let writer_file = fs.open_write("test.sst").unwrap();
        let mut writer = SSTWriter::new(
            writer_file,
            SSTWriterOptions {
                bloom_filter_enabled: true,
                ..SSTWriterOptions::default()
            },
        );

        writer.add(b"key1", b"value1").unwrap();
        writer.add(b"key2", b"value2").unwrap();
        writer.add(b"key3", b"value3").unwrap();

        writer.finish().unwrap();

        assert!(fs.exists("test.sst").unwrap());

        let _ = std::fs::remove_dir_all("/tmp/sst_writer_test");
    }

    #[test]
    #[serial_test::serial(file)]
    fn test_sst_writer_sorted_keys() {
        let _ = std::fs::remove_dir_all("/tmp/sst_writer_test");
        let registry = FileSystemRegistry::new();
        let fs = registry
            .get_or_register("file:///tmp/sst_writer_test".to_string())
            .unwrap();

        let writer_file = fs.open_write("test_order.sst").unwrap();
        let mut writer = SSTWriter::new(
            writer_file,
            SSTWriterOptions {
                bloom_filter_enabled: true,
                ..SSTWriterOptions::default()
            },
        );

        writer.add(b"key1", b"value1").unwrap();

        // Try to add a key out of order
        let result = writer.add(b"key0", b"value0");
        assert!(result.is_err());

        let _ = std::fs::remove_dir_all("/tmp/sst_writer_test");
    }

    #[test]
    #[serial_test::serial(file)]
    fn test_sst_writer_multiple_blocks() {
        let _ = std::fs::remove_dir_all("/tmp/sst_writer_test");
        let registry = FileSystemRegistry::new();
        let fs = registry
            .get_or_register("file:///tmp/sst_writer_test".to_string())
            .unwrap();

        let writer_file = fs.open_write("test_blocks.sst").unwrap();
        let mut writer = SSTWriter::new(
            writer_file,
            SSTWriterOptions {
                metrics: None,
                block_size: 100, // Small block size to force multiple blocks
                buffer_size: 8192,
                num_columns: 1,
                bloom_filter_enabled: true,
                bloom_bits_per_key: 10,
                partitioned_index: false,
                compression: crate::SstCompressionAlgorithm::None,
            },
        );

        for i in 0..20 {
            let key = format!("key{:03}", i);
            let value = format!("value{:03}_with_some_extra_data_to_fill_space", i);
            writer.add(key.as_bytes(), value.as_bytes()).unwrap();
        }

        writer.finish().unwrap();

        assert!(fs.exists("test_blocks.sst").unwrap());

        let _ = std::fs::remove_dir_all("/tmp/sst_writer_test");
    }
}