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
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
/// Manifest system for metadata management (Phase 1.5+)
///
/// Tracks:
/// - SST metadata (extent, stripe, key range)
/// - Checkpoint LSN and SeqNo
/// - Stripe assignments
///
/// Uses a ring buffer format with copy-on-write updates.

use bytes::{Bytes, BytesMut, BufMut};
use parking_lot::Mutex;
use serde::{Deserialize, Serialize};
use std::collections::{HashMap, BTreeMap};
use std::fs::{File, OpenOptions};
use std::io::{Read, Write, Seek, SeekFrom};
use std::path::Path;
use std::sync::Arc;
use crate::{
    Error, Result, Lsn, SeqNo,
    layout::Region,
    extent::Extent,
    types::checksum,
    sst_block::SstBlockHandle,
    index::TableSchema,
};

/// Manifest sequence number
pub type ManifestSeq = u64;

/// Manifest record types
#[derive(Debug, Clone, Serialize, Deserialize)]
pub enum ManifestRecord {
    /// Register a new SST
    AddSst {
        sst_id: u64,
        stripe: u8,
        extent: Extent,
        handle: SstBlockHandle,
        first_key: Bytes,
        last_key: Bytes,
    },

    /// Remove an SST (for compaction)
    RemoveSst {
        sst_id: u64,
    },

    /// Update checkpoint
    Checkpoint {
        lsn: Lsn,
        seq: SeqNo,
    },

    /// Stripe assignment (for Phase 1.6)
    AssignStripe {
        stripe: u8,
        sst_id: u64,
    },

    /// Update table schema (Phase 3.1+)
    UpdateSchema {
        schema: TableSchema,
    },
}

/// SST metadata
#[derive(Debug, Clone)]
pub struct SstMetadata {
    pub sst_id: u64,
    pub stripe: u8,
    pub extent: Extent,
    pub handle: SstBlockHandle,
    pub first_key: Bytes,
    pub last_key: Bytes,
}

/// Manifest state
#[derive(Debug, Clone)]
pub struct ManifestState {
    /// Active SSTs
    pub ssts: HashMap<u64, SstMetadata>,
    /// Checkpoint LSN
    pub checkpoint_lsn: Lsn,
    /// Checkpoint SeqNo
    pub checkpoint_seq: SeqNo,
    /// Stripe assignments
    pub stripe_assignments: BTreeMap<u8, Vec<u64>>, // stripe -> sst_ids
    /// Table schema with index definitions (Phase 3.1+)
    pub schema: TableSchema,
}

impl Default for ManifestState {
    fn default() -> Self {
        Self {
            ssts: HashMap::new(),
            checkpoint_lsn: 0,
            checkpoint_seq: 0,
            stripe_assignments: BTreeMap::new(),
            schema: TableSchema::new(),
        }
    }
}

/// Manifest ring buffer
pub struct Manifest {
    inner: Arc<Mutex<ManifestInner>>,
}

struct ManifestInner {
    file: File,
    region: Region,
    state: ManifestState,
    next_seq: ManifestSeq,
    write_offset: u64,
    pending: Vec<(ManifestSeq, ManifestRecord)>,
}

impl Manifest {
    /// Create a new manifest
    pub fn create(path: impl AsRef<Path>, region: Region) -> Result<Self> {
        let mut file = OpenOptions::new()
            .read(true)
            .write(true)
            .create(true)
            .open(path)?;

        // Initialize ring buffer with zeros
        file.seek(SeekFrom::Start(region.offset))?;
        let zeros = vec![0u8; region.size as usize];
        file.write_all(&zeros)?;
        file.sync_all()?;

        Ok(Self {
            inner: Arc::new(Mutex::new(ManifestInner {
                file,
                region,
                state: ManifestState::default(),
                next_seq: 1,
                write_offset: 0,
                pending: Vec::new(),
            })),
        })
    }

    /// Open existing manifest and recover state
    pub fn open(path: impl AsRef<Path>, region: Region) -> Result<Self> {
        let mut file = OpenOptions::new()
            .read(true)
            .write(true)
            .open(path)?;

        // Recover all records
        let records = Self::recover(&mut file, &region)?;

        // Replay to build state
        let mut state = ManifestState::default();
        let mut max_seq = 0;

        for (seq, record) in records {
            max_seq = max_seq.max(seq);
            Self::apply_record(&mut state, record);
        }

        Ok(Self {
            inner: Arc::new(Mutex::new(ManifestInner {
                file,
                region,
                state,
                next_seq: max_seq + 1,
                write_offset: 0, // Reset to beginning
                pending: Vec::new(),
            })),
        })
    }

    /// Append a manifest record
    pub fn append(&self, record: ManifestRecord) -> Result<ManifestSeq> {
        let mut inner = self.inner.lock();

        let seq = inner.next_seq;
        inner.next_seq += 1;

        inner.pending.push((seq, record.clone()));

        // Apply to in-memory state
        Self::apply_record(&mut inner.state, record);

        Ok(seq)
    }

    /// Flush pending records to disk
    pub fn flush(&self) -> Result<()> {
        let mut inner = self.inner.lock();

        if inner.pending.is_empty() {
            return Ok(());
        }

        // Serialize all pending records
        let mut buf = BytesMut::new();

        for (seq, record) in &inner.pending {
            let data = bincode::serialize(record)
                .map_err(|e| Error::Internal(format!("Serialize error: {}", e)))?;

            // Record: [seq(8) | len(4) | data | crc32c(4)]
            buf.put_u64_le(*seq);
            buf.put_u32_le(data.len() as u32);
            buf.put_slice(&data);

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

        let total_size = buf.len() as u64;

        // Check if we need to wrap around
        if inner.write_offset + total_size > inner.region.size {
            inner.write_offset = 0;
        }

        // Write to file
        let file_offset = inner.region.offset + inner.write_offset;
        inner.file.seek(SeekFrom::Start(file_offset))?;
        inner.file.write_all(&buf)?;
        inner.file.sync_all()?;

        inner.write_offset += total_size;
        inner.pending.clear();

        Ok(())
    }

    /// Get current manifest state
    pub fn state(&self) -> ManifestState {
        let inner = self.inner.lock();
        inner.state.clone()
    }

    /// Get SST metadata
    pub fn get_sst(&self, sst_id: u64) -> Option<SstMetadata> {
        let inner = self.inner.lock();
        inner.state.ssts.get(&sst_id).cloned()
    }

    /// Update table schema (Phase 3.1+)
    pub fn update_schema(&self, schema: TableSchema) -> Result<ManifestSeq> {
        self.append(ManifestRecord::UpdateSchema { schema })
    }

    /// Get current table schema (Phase 3.1+)
    pub fn get_schema(&self) -> TableSchema {
        let inner = self.inner.lock();
        inner.state.schema.clone()
    }

    /// Compact manifest by rewriting only active records
    pub fn compact(&self) -> Result<()> {
        let mut inner = self.inner.lock();

        // Collect all active SSTs first to avoid borrow checker issues
        let ssts: Vec<_> = inner.state.ssts.values().cloned().collect();
        let mut records = Vec::new();

        for sst in ssts {
            records.push((
                inner.next_seq,
                ManifestRecord::AddSst {
                    sst_id: sst.sst_id,
                    stripe: sst.stripe,
                    extent: sst.extent,
                    handle: sst.handle.clone(),
                    first_key: sst.first_key.clone(),
                    last_key: sst.last_key.clone(),
                },
            ));
            inner.next_seq += 1;
        }

        // Add checkpoint record
        records.push((
            inner.next_seq,
            ManifestRecord::Checkpoint {
                lsn: inner.state.checkpoint_lsn,
                seq: inner.state.checkpoint_seq,
            },
        ));
        inner.next_seq += 1;

        // Add schema record (Phase 3.1+)
        if !inner.state.schema.local_indexes.is_empty() || !inner.state.schema.global_indexes.is_empty() {
            records.push((
                inner.next_seq,
                ManifestRecord::UpdateSchema {
                    schema: inner.state.schema.clone(),
                },
            ));
            inner.next_seq += 1;
        }

        // Write compacted records
        inner.pending = records;
        inner.write_offset = 0; // Start fresh

        drop(inner);
        self.flush()?;

        Ok(())
    }

    // Internal helpers

    fn apply_record(state: &mut ManifestState, record: ManifestRecord) {
        match record {
            ManifestRecord::AddSst {
                sst_id,
                stripe,
                extent,
                handle,
                first_key,
                last_key,
            } => {
                state.ssts.insert(
                    sst_id,
                    SstMetadata {
                        sst_id,
                        stripe,
                        extent,
                        handle,
                        first_key,
                        last_key,
                    },
                );

                state
                    .stripe_assignments
                    .entry(stripe)
                    .or_insert_with(Vec::new)
                    .push(sst_id);
            }

            ManifestRecord::RemoveSst { sst_id } => {
                if let Some(meta) = state.ssts.remove(&sst_id) {
                    if let Some(ssts) = state.stripe_assignments.get_mut(&meta.stripe) {
                        ssts.retain(|&id| id != sst_id);
                    }
                }
            }

            ManifestRecord::Checkpoint { lsn, seq } => {
                state.checkpoint_lsn = lsn;
                state.checkpoint_seq = seq;
            }

            ManifestRecord::AssignStripe { stripe, sst_id } => {
                state
                    .stripe_assignments
                    .entry(stripe)
                    .or_insert_with(Vec::new)
                    .push(sst_id);
            }

            ManifestRecord::UpdateSchema { schema } => {
                state.schema = schema;
            }
        }
    }

    fn recover(file: &mut File, region: &Region) -> Result<Vec<(ManifestSeq, ManifestRecord)>> {
        let mut records = Vec::new();

        // Read entire ring buffer
        file.seek(SeekFrom::Start(region.offset))?;
        let mut ring_data = vec![0u8; region.size as usize];

        let bytes_read = file.read(&mut ring_data)?;
        if bytes_read == 0 {
            return Ok(records);
        }

        let mut offset = 0usize;

        // Scan for valid records
        while offset + 16 < ring_data.len() {
            // Record header: seq(8) + len(4)
            let seq = u64::from_le_bytes([
                ring_data[offset],
                ring_data[offset + 1],
                ring_data[offset + 2],
                ring_data[offset + 3],
                ring_data[offset + 4],
                ring_data[offset + 5],
                ring_data[offset + 6],
                ring_data[offset + 7],
            ]);

            // Seq 0 indicates empty space
            if seq == 0 {
                break;
            }

            let len = u32::from_le_bytes([
                ring_data[offset + 8],
                ring_data[offset + 9],
                ring_data[offset + 10],
                ring_data[offset + 11],
            ]) as usize;

            if offset + 12 + len + 4 > ring_data.len() {
                break;
            }

            // Extract data and CRC
            let data_start = offset + 12;
            let data_end = data_start + len;
            let data = &ring_data[data_start..data_end];

            let crc_offset = data_end;
            let expected_crc = u32::from_le_bytes([
                ring_data[crc_offset],
                ring_data[crc_offset + 1],
                ring_data[crc_offset + 2],
                ring_data[crc_offset + 3],
            ]);

            // Verify checksum
            if checksum::verify(data, expected_crc) {
                match bincode::deserialize::<ManifestRecord>(data) {
                    Ok(record) => {
                        records.push((seq, record));
                        offset = crc_offset + 4;
                    }
                    Err(_) => break,
                }
            } else {
                break;
            }
        }

        // Sort by seq
        records.sort_by_key(|(seq, _)| *seq);

        Ok(records)
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use tempfile::NamedTempFile;

    #[test]
    fn test_manifest_create_and_append() {
        let tmp = NamedTempFile::new().unwrap();
        let region = Region::new(0, 64 * 1024);

        let manifest = Manifest::create(tmp.path(), region).unwrap();

        let extent = Extent::new(1, 0, 4096);
        let handle = SstBlockHandle {
            extent,
            num_data_blocks: 1,
            index_offset: 0,
            bloom_offset: 0,
            compressed: false,
        };

        manifest
            .append(ManifestRecord::AddSst {
                sst_id: 1,
                stripe: 0,
                extent,
                handle,
                first_key: Bytes::from("a"),
                last_key: Bytes::from("z"),
            })
            .unwrap();

        manifest.flush().unwrap();

        let state = manifest.state();
        assert_eq!(state.ssts.len(), 1);
        assert!(state.ssts.contains_key(&1));
    }

    #[test]
    fn test_manifest_recovery() {
        let tmp = NamedTempFile::new().unwrap();
        let region = Region::new(0, 64 * 1024);

        // Write some records
        {
            let manifest = Manifest::create(tmp.path(), region).unwrap();

            for i in 1..=5 {
                let extent = Extent::new(i, 0, 4096);
                let handle = SstBlockHandle {
                    extent,
                    num_data_blocks: 1,
                    index_offset: 0,
                    bloom_offset: 0,
                    compressed: false,
                };

                manifest
                    .append(ManifestRecord::AddSst {
                        sst_id: i,
                        stripe: 0,
                        extent,
                        handle,
                        first_key: Bytes::from(format!("key{}", i)),
                        last_key: Bytes::from(format!("key{}", i + 100)),
                    })
                    .unwrap();
            }

            manifest.flush().unwrap();
        }

        // Reopen and verify
        let manifest = Manifest::open(tmp.path(), region).unwrap();
        let state = manifest.state();
        assert_eq!(state.ssts.len(), 5);
    }

    #[test]
    fn test_manifest_remove_sst() {
        let tmp = NamedTempFile::new().unwrap();
        let region = Region::new(0, 64 * 1024);

        let manifest = Manifest::create(tmp.path(), region).unwrap();

        let extent = Extent::new(1, 0, 4096);
        let handle = SstBlockHandle {
            extent,
            num_data_blocks: 1,
            index_offset: 0,
            bloom_offset: 0,
            compressed: false,
        };

        manifest
            .append(ManifestRecord::AddSst {
                sst_id: 1,
                stripe: 0,
                extent,
                handle,
                first_key: Bytes::from("a"),
                last_key: Bytes::from("z"),
            })
            .unwrap();

        manifest.append(ManifestRecord::RemoveSst { sst_id: 1 }).unwrap();
        manifest.flush().unwrap();

        let state = manifest.state();
        assert_eq!(state.ssts.len(), 0);
    }

    #[test]
    fn test_manifest_checkpoint() {
        let tmp = NamedTempFile::new().unwrap();
        let region = Region::new(0, 64 * 1024);

        let manifest = Manifest::create(tmp.path(), region).unwrap();

        manifest
            .append(ManifestRecord::Checkpoint { lsn: 100, seq: 50 })
            .unwrap();

        manifest.flush().unwrap();

        let state = manifest.state();
        assert_eq!(state.checkpoint_lsn, 100);
        assert_eq!(state.checkpoint_seq, 50);
    }

    #[test]
    fn test_manifest_compact() {
        let tmp = NamedTempFile::new().unwrap();
        let region = Region::new(0, 64 * 1024);

        let manifest = Manifest::create(tmp.path(), region).unwrap();

        // Add and remove SSTs
        for i in 1..=10 {
            let extent = Extent::new(i, 0, 4096);
            let handle = SstBlockHandle {
                extent,
                num_data_blocks: 1,
                index_offset: 0,
                bloom_offset: 0,
                compressed: false,
            };

            manifest
                .append(ManifestRecord::AddSst {
                    sst_id: i,
                    stripe: 0,
                    extent,
                    handle,
                    first_key: Bytes::from(format!("key{}", i)),
                    last_key: Bytes::from(format!("key{}", i + 100)),
                })
                .unwrap();
        }

        // Remove half
        for i in 1..=5 {
            manifest.append(ManifestRecord::RemoveSst { sst_id: i }).unwrap();
        }

        manifest.flush().unwrap();

        // Compact
        manifest.compact().unwrap();

        // Should still have 5 SSTs
        let state = manifest.state();
        assert_eq!(state.ssts.len(), 5);
    }
}