kstone-core 0.1.0

Core storage engine for KeystoneDB - LSM tree, WAL, and DynamoDB-compatible API
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
/// Block-based SST implementation for Phase 1.4+
///
/// Format:
/// - Data blocks (4KB each) with prefix-compressed records
/// - Index block mapping keys to data block offsets
/// - Bloom filter block (one filter per data block)
/// - Footer with metadata
///
/// Each data block contains sorted records with prefix compression.
/// Bloom filters reduce unnecessary block reads.

use bytes::{Bytes, BytesMut, BufMut, Buf};
use std::collections::BTreeMap;
use std::fs::File;
use crate::{
    Error, Result, Record, Key,
    layout::BLOCK_SIZE,
    block::{Block, BlockWriter, BlockReader},
    bloom::BloomFilter,
    extent::{Extent, ExtentAllocator},
    types::checksum,
};

const BITS_PER_KEY: usize = 10; // ~1% false positive rate
const MAX_RECORDS_PER_BLOCK: usize = 100; // Limit for simplicity

/// SST footer (last block)
/// Format: [num_data_blocks(4) | index_offset(8) | bloom_offset(8) | crc32c(4)]
const FOOTER_SIZE: usize = 24;

/// Block-based SST writer
pub struct SstBlockWriter {
    records: Vec<Record>,
    compress: bool,
}

impl SstBlockWriter {
    pub fn new() -> Self {
        Self {
            records: Vec::new(),
            compress: false,
        }
    }

    pub fn with_compression() -> Self {
        Self {
            records: Vec::new(),
            compress: true,
        }
    }

    pub fn add(&mut self, record: Record) {
        self.records.push(record);
    }

    /// Finish writing SST to extent
    pub fn finish(
        mut self,
        file: &mut File,
        allocator: &ExtentAllocator,
    ) -> Result<SstBlockHandle> {
        // Sort records
        self.records.sort_by(|a, b| {
            a.key.encode().cmp(&b.key.encode())
        });

        // Split into data blocks
        let data_blocks = self.split_into_blocks();

        // Estimate total size
        let estimated_blocks = data_blocks.len() + 2; // data + index + bloom + footer
        let extent = allocator.allocate((estimated_blocks * BLOCK_SIZE) as u64)?;

        let mut writer = BlockWriter::new(file.try_clone()?);
        let mut block_index = Vec::new();
        let mut bloom_filters = Vec::new();
        let mut current_offset = extent.offset;

        // Write data blocks
        for (idx, records) in data_blocks.iter().enumerate() {
            let first_key = records[0].key.encode();

            // Build bloom filter for this block
            let mut bloom = BloomFilter::new(records.len(), BITS_PER_KEY);
            for rec in records {
                bloom.add(&rec.key.encode());
            }
            bloom_filters.push(bloom);

            // Encode block with prefix compression
            let block_data = self.encode_data_block(records)?;

            // Optionally compress
            let final_data = if self.compress {
                self.compress_data(&block_data)?
            } else {
                block_data
            };

            let block = Block::new(idx as u64, final_data);
            writer.write(&block, current_offset)?;

            block_index.push((first_key, current_offset));
            current_offset += BLOCK_SIZE as u64;
        }

        let index_offset = current_offset;

        // Write index block
        let index_data = self.encode_index_block(&block_index)?;
        let index_block = Block::new(data_blocks.len() as u64, index_data);
        writer.write(&index_block, current_offset)?;
        current_offset += BLOCK_SIZE as u64;

        let bloom_offset = current_offset;

        // Write bloom filter block
        let bloom_data = self.encode_bloom_block(&bloom_filters)?;
        let bloom_block = Block::new((data_blocks.len() + 1) as u64, bloom_data);
        writer.write(&bloom_block, current_offset)?;
        current_offset += BLOCK_SIZE as u64;

        // Write footer
        let footer_data = self.encode_footer(data_blocks.len(), index_offset, bloom_offset)?;
        let footer_block = Block::new((data_blocks.len() + 2) as u64, footer_data);
        writer.write(&footer_block, current_offset)?;

        writer.flush()?;

        Ok(SstBlockHandle {
            extent,
            num_data_blocks: data_blocks.len(),
            index_offset,
            bloom_offset,
            compressed: self.compress,
        })
    }

    fn split_into_blocks(&self) -> Vec<Vec<Record>> {
        let mut blocks = Vec::new();
        let mut current_block = Vec::new();

        for record in &self.records {
            current_block.push(record.clone());

            if current_block.len() >= MAX_RECORDS_PER_BLOCK {
                blocks.push(current_block);
                current_block = Vec::new();
            }
        }

        if !current_block.is_empty() {
            blocks.push(current_block);
        }

        blocks
    }

    fn encode_data_block(&self, records: &[Record]) -> Result<Bytes> {
        let mut buf = BytesMut::new();

        buf.put_u32_le(records.len() as u32);

        let mut prev_key = Bytes::new();

        for record in records {
            let key_enc = record.key.encode();

            // Prefix compression: store shared prefix length
            let shared = Self::shared_prefix_len(&prev_key, &key_enc);
            let unshared = key_enc.len() - shared;

            buf.put_u32_le(shared as u32);
            buf.put_u32_le(unshared as u32);
            buf.put_slice(&key_enc[shared..]);

            // Encode record
            let rec_data = bincode::serialize(record)
                .map_err(|e| Error::Internal(format!("Serialize error: {}", e)))?;
            buf.put_u32_le(rec_data.len() as u32);
            buf.put_slice(&rec_data);

            prev_key = key_enc;
        }

        Ok(buf.freeze())
    }

    fn encode_index_block(&self, index: &[(Bytes, u64)]) -> Result<Bytes> {
        let mut buf = BytesMut::new();

        buf.put_u32_le(index.len() as u32);

        for (key, offset) in index {
            buf.put_u32_le(key.len() as u32);
            buf.put_slice(key);
            buf.put_u64_le(*offset);
        }

        Ok(buf.freeze())
    }

    fn encode_bloom_block(&self, blooms: &[BloomFilter]) -> Result<Bytes> {
        let mut buf = BytesMut::new();

        buf.put_u32_le(blooms.len() as u32);

        for bloom in blooms {
            let bloom_data = bloom.encode();
            buf.put_u32_le(bloom_data.len() as u32);
            buf.put_slice(&bloom_data);
        }

        Ok(buf.freeze())
    }

    fn encode_footer(&self, num_blocks: usize, index_offset: u64, bloom_offset: u64) -> Result<Bytes> {
        let mut buf = BytesMut::with_capacity(FOOTER_SIZE);

        buf.put_u32_le(num_blocks as u32);
        buf.put_u64_le(index_offset);
        buf.put_u64_le(bloom_offset);

        let crc = checksum::compute(&buf);
        buf.put_u32_le(crc);

        Ok(buf.freeze())
    }

    fn shared_prefix_len(a: &[u8], b: &[u8]) -> usize {
        let mut i = 0;
        while i < a.len() && i < b.len() && a[i] == b[i] {
            i += 1;
        }
        i
    }

    fn compress_data(&self, data: &Bytes) -> Result<Bytes> {
        // Compression support will be added with zstd dependency
        // For now, return uncompressed data
        Ok(data.clone())
    }
}

/// SST block handle (metadata for reading)
#[derive(Debug, Clone, serde::Serialize, serde::Deserialize)]
pub struct SstBlockHandle {
    pub extent: Extent,
    pub num_data_blocks: usize,
    pub index_offset: u64,
    pub bloom_offset: u64,
    pub compressed: bool,
}

/// Block-based SST reader
pub struct SstBlockReader {
    file: File,
    index: BTreeMap<Bytes, u64>, // key -> block offset
    blooms: Vec<BloomFilter>,
}

impl SstBlockReader {
    pub fn open(file: File, handle: SstBlockHandle) -> Result<Self> {
        let mut reader = BlockReader::new(file.try_clone()?);

        // Read index block
        let index_block = reader.read(handle.num_data_blocks as u64, handle.index_offset)?;
        let index = Self::decode_index_block(&index_block.data)?;

        // Read bloom filters
        let bloom_block = reader.read((handle.num_data_blocks + 1) as u64, handle.bloom_offset)?;
        let blooms = Self::decode_bloom_block(&bloom_block.data)?;

        Ok(Self {
            file,
            index,
            blooms,
        })
    }

    pub fn get(&self, key: &Key) -> Result<Option<Record>> {
        let key_enc = key.encode();

        // Find block containing this key
        let block_offset = self.find_block(&key_enc)?;

        if let Some(offset) = block_offset {
            // Check bloom filter first
            let block_idx = self.index.values().position(|&o| o == offset).unwrap();
            if !self.blooms[block_idx].contains(&key_enc) {
                return Ok(None); // Definitely not present
            }

            // Read and search block
            let mut reader = BlockReader::new(self.file.try_clone()?);
            let block = reader.read(block_idx as u64, offset)?;

            let records = self.decode_data_block(&block.data)?;

            for record in records {
                if record.key == *key {
                    return Ok(Some(record));
                }
            }
        }

        Ok(None)
    }

    fn find_block(&self, key: &Bytes) -> Result<Option<u64>> {
        // Binary search in index
        let mut result = None;

        for (first_key, offset) in &self.index {
            if key >= first_key {
                result = Some(*offset);
            } else {
                break;
            }
        }

        Ok(result)
    }

    fn decode_index_block(data: &Bytes) -> Result<BTreeMap<Bytes, u64>> {
        let mut buf = data.clone();
        let count = buf.get_u32_le() as usize;

        let mut index = BTreeMap::new();

        for _ in 0..count {
            let key_len = buf.get_u32_le() as usize;
            let key = buf.copy_to_bytes(key_len);
            let offset = buf.get_u64_le();
            index.insert(key, offset);
        }

        Ok(index)
    }

    fn decode_bloom_block(data: &Bytes) -> Result<Vec<BloomFilter>> {
        let mut buf = data.clone();
        let count = buf.get_u32_le() as usize;

        let mut blooms = Vec::new();

        for _ in 0..count {
            let bloom_len = buf.get_u32_le() as usize;
            let bloom_data = buf.copy_to_bytes(bloom_len);
            let bloom = BloomFilter::decode(&bloom_data)
                .ok_or_else(|| Error::Corruption("Invalid bloom filter".to_string()))?;
            blooms.push(bloom);
        }

        Ok(blooms)
    }

    fn decode_data_block(&self, data: &Bytes) -> Result<Vec<Record>> {
        let mut buf = data.clone();
        let count = buf.get_u32_le() as usize;

        let mut records = Vec::new();
        let mut prev_key = BytesMut::new();

        for _ in 0..count {
            let shared = buf.get_u32_le() as usize;
            let unshared = buf.get_u32_le() as usize;

            // Reconstruct key
            prev_key.truncate(shared);
            prev_key.extend_from_slice(&buf.copy_to_bytes(unshared));

            // Decode record
            let rec_len = buf.get_u32_le() as usize;
            let rec_data = buf.copy_to_bytes(rec_len);

            let record: Record = bincode::deserialize(&rec_data)
                .map_err(|e| Error::Corruption(format!("Deserialize error: {}", e)))?;

            records.push(record);
        }

        Ok(records)
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use crate::Value;
    use tempfile::NamedTempFile;
    use std::collections::HashMap;

    #[test]
    fn test_sst_block_write_read() {
        let tmp = NamedTempFile::new().unwrap();
        let mut file = tmp.reopen().unwrap();

        let allocator = ExtentAllocator::new(0);
        let mut writer = SstBlockWriter::new();

        for i in 0..10 {
            let key = Key::new(format!("key{:03}", i).into_bytes());
            let mut item = HashMap::new();
            item.insert("value".to_string(), Value::number(i));
            writer.add(Record::put(key, item, i));
        }

        let handle = writer.finish(&mut file, &allocator).unwrap();

        // Read
        let file = tmp.reopen().unwrap();
        let reader = SstBlockReader::open(file, handle).unwrap();

        let key = Key::new(b"key005".to_vec());
        let rec = reader.get(&key).unwrap().unwrap();
        assert_eq!(rec.key, key);
    }
}