amaters-core 0.2.2

Core kernel for AmateRS - Fully Homomorphic Encrypted Database
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

//! Storage engine module (Iwato - The Rock Cave)
//!
//! This module provides persistent storage with LSM-Tree architecture.
//!
//! # Phase 1 Complete ✅
//! - [x] Implement in-memory storage for MVP
//!
//! # Phase 2 In Progress 🚧
//! - [x] Implement Memtable (in-memory sorted map)
//! - [x] Implement WAL (Write-Ahead Log)
//! - [x] Implement SSTable format and writer
//! - [x] Implement Block Cache (LRU)
//! - [x] Implement LSM-Tree basic structure
//! - [x] Implement compaction strategy
//! - [x] Implement Bloom filters for fast key lookups
//! - [x] Implement Manifest for metadata tracking
//! - [x] Implement WiscKey value separation (value_log.rs, value_log_gc.rs, GcWorker)
//! - [x] Add io_uring WAL writer for Linux (feature = "io-uring")
//! - [x] Memory-mapped SSTable reader with madvise prefetching (feature = "mmap")
//!
//! ## Component Layout
//!
//! ```text
//!  ┌─────────────────────────────────────────────┐
//!  │                   Iwato                     │
//!  │             (LSM-Tree Storage)              │
//!  ├──────────────┬──────────────┬───────────────┤
//!  │  MemTable    │  SSTables    │  WAL           │
//!  │  (writes)    │  (reads)     │  (durability)  │
//!  ├──────────────┴──────────────┴───────────────┤
//!  │  BlockCache  │  BloomFilter │  ValueLog(WK)  │
//!  └──────────────┴──────────────┴───────────────┘
//! ```

// Module declarations
pub mod backup;
pub mod block_cache;
pub mod bloom_filter;
pub mod buffer_pool;
pub mod compaction;
pub mod compression;
pub mod encrypted_index;
pub mod index_registry;
pub mod lsm_storage;
pub mod lsm_tree;
pub mod manifest;
pub mod memory;
pub mod memtable;
#[cfg(feature = "mmap")]
pub mod mmap_reader;
pub mod secondary_index;
pub mod sstable;
pub mod value_log;
pub mod value_log_gc;
pub mod value_log_gc_worker;
pub mod wal;
#[cfg(all(target_os = "linux", feature = "io-uring"))]
pub mod wal_uring;

#[cfg(feature = "mmap")]
pub use mmap_reader::{MadviseHint, MmapPrefetcher, MmapReaderPool, MmapSstableReader};
#[cfg(all(target_os = "linux", feature = "io-uring"))]
pub use wal_uring::{UringWalConfig, UringWalWriter};

pub use backup::{BackupManager, BackupMetadata, BackupType};
pub use block_cache::{BlockCache, BlockCacheConfig, BlockCacheKey, CacheStats, CachedBlock};
pub use bloom_filter::{BloomFilter, BloomFilterConfig, BloomFilterMetadata};
pub use buffer_pool::{BufferPool, BufferPoolStats, PooledBuffer};
pub use compaction::{
    CompactionConfig, CompactionExecutor, CompactionPlanner, CompactionStats,
    CompactionStatsSnapshot, CompactionStrategy, CompactionTask, CompactionThrottler, SizeTier,
    TombstoneEntry,
};
pub use compression::CompressionType;
pub use encrypted_index::EncryptedIndex;
pub use index_registry::IndexRegistry;
pub use lsm_storage::LsmTreeStorage;
pub use lsm_tree::{
    LevelInfo, LsmTree, LsmTreeConfig, LsmTreeStats, PrefetchConfig, SSTableMetadata,
};
pub use manifest::{Manifest, ManifestConfig, ManifestEntry, ManifestSnapshot, ManifestVersion};
pub use memory::MemoryStorage;
pub use memtable::{Memtable, MemtableConfig};
pub use secondary_index::{
    IndexConfig, IndexEntry, IndexExtractor, IndexManager, IndexStats, IndexType, IndexedField,
    SecondaryIndex,
};
pub use sstable::{SSTableConfig, SSTableReader, SSTableWriter};
pub use value_log::{GcStats, ValueLog, ValueLogConfig, ValuePointer};
pub use value_log_gc::{GcConfig, GcResult, SegmentStats};
pub use value_log_gc_worker::{
    BgGcStats, GcWorker, GcWorkerBuilder, GcWorkerHandle, spawn_gc_worker,
};
pub use wal::{Wal, WalConfig, WalEntry, WalEntryType, WalReader};

#[cfg(test)]
mod chaos_tests;

#[cfg(test)]
mod concurrency_tests;