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
use crate::mapper::{Disk, Mapper, Memory};
use crate::sstable::SSTable;
use crate::storage::MemTable;
use crate::writelog::WriteLog;
use std::collections::BTreeMap;
use std::fs;
use std::io;
use std::ops::RangeInclusive;
use std::path::{Path, PathBuf};
use std::sync::atomic::{AtomicUsize, Ordering};
use std::sync::mpsc::{Receiver, Sender};
use std::sync::{Arc, Mutex, RwLock};
use std::thread::JoinHandle;

mod compactor;
mod error;
mod io_utils;
mod mapper;
mod readtx;
mod sstable;
mod storage;
mod writebatch;
mod writelog;

#[macro_use]
extern crate serde_derive;

pub use self::error::{Error, Result};
pub use self::readtx::ReadTx as Snapshot;
pub use self::sstable::Key;
pub use self::writebatch::{Config as WriteBatchConfig, WriteBatch};
pub use self::writelog::Config as LogConfig;

const TABLES_FILE: &str = "tables.meta";
const LOG_FILE: &str = "mem-log";
const DEFAULT_TABLE_SIZE: usize = 64 * 1024 * 1024;
const DEFAULT_MEM_SIZE: usize = 64 * 1024 * 1024;
const DEFAULT_MAX_PAGES: usize = 10;
const COMMIT_ORDERING: Ordering = Ordering::Relaxed;

#[derive(Debug, PartialEq, Copy, Clone)]
pub struct Config {
    pub max_mem: usize,
    pub max_tables: usize,
    pub page_size: usize,
    pub in_memory: bool,
    pub log_config: LogConfig,
}

#[derive(Debug)]
pub struct KvStore {
    config: Config,
    root: PathBuf,
    commit: AtomicUsize,
    mem: RwLock<MemTable>,
    log: Arc<RwLock<WriteLog>>,
    tables: RwLock<Vec<BTreeMap<Key, SSTable>>>,
    mapper: Arc<dyn Mapper>,
    sender: Mutex<Sender<compactor::Req>>,
    receiver: Mutex<Receiver<compactor::Resp>>,
    compactor_handle: JoinHandle<()>,
}

impl KvStore {
    pub fn open_default<P>(root: P) -> Result<Self>
    where
        P: AsRef<Path>,
    {
        let mapper = Disk::single(root.as_ref());
        open(root.as_ref(), Arc::new(mapper), Config::default())
    }

    pub fn open<P>(root: P, config: Config) -> Result<Self>
    where
        P: AsRef<Path>,
    {
        let mapper: Arc<dyn Mapper> = if config.in_memory {
            Arc::new(Memory::new())
        } else {
            Arc::new(Disk::single(root.as_ref()))
        };
        open(root.as_ref(), mapper, config)
    }

    pub fn partitioned<P, P2>(root: P, storage_dirs: &[P2], config: Config) -> Result<Self>
    where
        P: AsRef<Path>,
        P2: AsRef<Path>,
    {
        let mapper = Disk::new(storage_dirs);
        open(root.as_ref(), Arc::new(mapper), config)
    }

    pub fn config(&self) -> &Config {
        &self.config
    }

    pub fn put(&self, key: &Key, data: &[u8]) -> Result<()> {
        let mut memtable = self.mem.write().unwrap();
        let mut log = self.log.write().unwrap();
        let commit = self.commit.fetch_add(1, COMMIT_ORDERING) as i64;

        log.log_put(key, commit, data).unwrap();
        memtable.put(key, commit, data);

        self.ensure_memtable(&mut *memtable, &mut *log)?;

        Ok(())
    }

    pub fn put_many<Iter, Tup, K, V>(&self, rows: Iter) -> Result<()>
    where
        Iter: Iterator<Item = Tup>,
        Tup: std::borrow::Borrow<(K, V)>,
        K: std::borrow::Borrow<Key>,
        V: std::borrow::Borrow<[u8]>,
    {
        let mut memtable = self.mem.write().unwrap();
        let mut log = self.log.write().unwrap();
        let commit = self.commit.fetch_add(1, COMMIT_ORDERING) as i64;

        for pair in rows {
            let (ref k, ref d) = pair.borrow();
            let (key, data) = (k.borrow(), d.borrow());

            log.log_put(key, commit, data).unwrap();
            memtable.put(key, commit, data);
        }

        self.ensure_memtable(&mut *memtable, &mut *log)?;

        Ok(())
    }

    pub fn get(&self, key: &Key) -> Result<Option<Vec<u8>>> {
        self.query_compactor()?;

        let (memtable, tables) = (self.mem.read().unwrap(), self.tables.read().unwrap());

        storage::get(&memtable.values, &*tables, key)
    }

    pub fn delete(&self, key: &Key) -> Result<()> {
        let mut memtable = self.mem.write().unwrap();
        let mut log = self.log.write().unwrap();
        let commit = self.commit.fetch_add(1, COMMIT_ORDERING) as i64;

        log.log_delete(key, commit).unwrap();
        memtable.delete(key, commit);

        self.ensure_memtable(&mut *memtable, &mut *log)?;

        Ok(())
    }

    pub fn delete_many<Iter, K>(&self, rows: Iter) -> Result<()>
    where
        Iter: Iterator<Item = K>,
        K: std::borrow::Borrow<Key>,
    {
        let mut memtable = self.mem.write().unwrap();
        let mut log = self.log.write().unwrap();
        let commit = self.commit.fetch_add(1, COMMIT_ORDERING) as i64;

        for k in rows {
            let key = k.borrow();
            log.log_delete(key, commit).unwrap();
            memtable.delete(key, commit);
        }

        self.ensure_memtable(&mut *memtable, &mut *log)?;

        Ok(())
    }

    pub fn batch(&self, config: WriteBatchConfig) -> WriteBatch {
        let commit = self.commit.fetch_add(1, COMMIT_ORDERING) as i64;

        WriteBatch {
            config,
            commit,
            memtable: MemTable::new(BTreeMap::new()),
            log: Arc::clone(&self.log),
        }
    }

    pub fn commit(&self, mut batch: WriteBatch) -> Result<()> {
        let mut memtable = self.mem.write().unwrap();
        let mut log = self.log.write().unwrap();

        memtable.values.append(&mut batch.memtable.values);
        self.ensure_memtable(&mut *memtable, &mut *log)?;

        Ok(())
    }

    pub fn snapshot(&self) -> Snapshot {
        let (memtable, tables) = (
            self.mem.read().unwrap().values.clone(),
            self.tables.read().unwrap().clone(),
        );

        Snapshot::new(memtable, tables)
    }

    pub fn range(
        &self,
        range: RangeInclusive<Key>,
    ) -> Result<impl Iterator<Item = (Key, Vec<u8>)>> {
        self.query_compactor()?;

        let (memtable, tables) = (self.mem.read().unwrap(), self.tables.read().unwrap());

        storage::range(&memtable.values, &*tables, range)
    }

    pub fn destroy<P>(path: P) -> Result<()>
    where
        P: AsRef<Path>,
    {
        let path = path.as_ref();
        if !path.exists() {
            return Ok(());
        }

        fs::remove_dir_all(path)?;
        Ok(())
    }

    fn query_compactor(&self) -> Result<()> {
        if let (Ok(mut sender), Ok(mut receiver), Ok(mut tables)) = (
            self.sender.try_lock(),
            self.receiver.try_lock(),
            self.tables.try_write(),
        ) {
            query_compactor(
                &self.root,
                &*self.mapper,
                &mut *tables,
                &mut *receiver,
                &mut *sender,
            )?;
        }

        Ok(())
    }

    fn ensure_memtable(&self, mem: &mut MemTable, log: &mut WriteLog) -> Result<()> {
        if mem.mem_size < self.config.max_mem {
            return Ok(());
        }

        let mut tables = self.tables.write().unwrap();

        storage::flush_table(&mem.values, &*self.mapper, &mut *tables)?;
        mem.values.clear();
        mem.mem_size = 0;
        log.reset().expect("Write-log rotation failed");

        if is_lvl0_full(&tables, &self.config) {
            let sender = self.sender.lock().unwrap();

            sender.send(compactor::Req::Start(PathBuf::new()))?;
        }

        Ok(())
    }
}

impl Default for Config {
    fn default() -> Config {
        Config {
            max_mem: DEFAULT_MEM_SIZE,
            max_tables: DEFAULT_MAX_PAGES,
            page_size: DEFAULT_TABLE_SIZE,
            in_memory: false,
            log_config: LogConfig::default(),
        }
    }
}

fn open(root: &Path, mapper: Arc<dyn Mapper>, config: Config) -> Result<KvStore> {
    let root = root.to_path_buf();
    let log_path = root.join(LOG_FILE);
    let restore_log = log_path.exists();

    if !root.exists() {
        fs::create_dir(&root)?;
    }

    let commit = chrono::Utc::now().timestamp();
    let mut log = WriteLog::open(&log_path, config.log_config)?;
    let values = if restore_log && !config.in_memory {
        log.materialize()?
    } else {
        BTreeMap::new()
    };
    let mem = MemTable::new(values);

    let tables = load_tables(&root, &*mapper)?;

    let cfg = compactor::Config {
        max_pages: config.max_tables,
        page_size: config.page_size,
    };
    let (sender, receiver, compactor_handle) = compactor::spawn_compactor(Arc::clone(&mapper), cfg)
        .map_err(|e| io::Error::new(io::ErrorKind::Other, e))?;

    Ok(KvStore {
        config,
        root,
        commit: AtomicUsize::new(commit as usize),
        mem: RwLock::new(mem),
        log: Arc::new(RwLock::new(log)),
        tables: RwLock::new(tables),
        mapper,
        sender: Mutex::new(sender),
        receiver: Mutex::new(receiver),
        compactor_handle,
    })
}

fn load_tables(root: &Path, mapper: &dyn Mapper) -> Result<Vec<BTreeMap<Key, SSTable>>> {
    let mut tables = Vec::new();
    let meta_path = root.join(TABLES_FILE);

    if meta_path.exists() {
        mapper.load_state_from(&meta_path)?;
        tables = SSTable::sorted_tables(&mapper.active_set()?);
    }

    Ok(tables)
}

fn dump_tables(root: &Path, mapper: &Mapper) -> Result<()> {
    mapper.serialize_state_to(&root.join(TABLES_FILE))?;
    Ok(())
}

fn query_compactor(
    root: &Path,
    mapper: &dyn Mapper,
    tables: &mut Vec<BTreeMap<Key, SSTable>>,
    receiver: &mut Receiver<compactor::Resp>,
    sender: &mut Sender<compactor::Req>,
) -> Result<()> {
    match receiver.try_recv() {
        Ok(compactor::Resp::Done(new_tables)) => {
            std::mem::replace(tables, new_tables);
            dump_tables(root, mapper)?;
            sender.send(compactor::Req::Gc).unwrap();
        }
        Ok(compactor::Resp::Failed(e)) => {
            return Err(e);
        }
        // Nothing available, do nothing
        _ => {}
    }

    Ok(())
}

#[inline]
fn is_lvl0_full(tables: &[BTreeMap<Key, SSTable>], config: &Config) -> bool {
    if tables.is_empty() {
        false
    } else {
        tables[0].len() > config.max_tables
    }
}

pub mod test {
    pub mod gen {
        use crate::Key;
        use rand::distributions::Uniform;
        use rand::{rngs::SmallRng, FromEntropy, Rng};
        use std::iter;
        use std::ops::Range;

        pub fn keys() -> impl Iterator<Item = Key> {
            let mut rng = SmallRng::from_entropy();
            iter::repeat_with(move || Key(rng.gen()))
        }

        pub fn data(size: usize) -> impl Iterator<Item = Vec<u8>> {
            iter::repeat(vec![0; size])
        }

        pub fn data_vary(range: Range<u64>) -> impl Iterator<Item = Vec<u8>> {
            let dist = Uniform::from(range);
            let mut rng = SmallRng::from_entropy();

            iter::repeat_with(move || {
                let size: u64 = rng.sample(dist);
                vec![0; size as usize]
            })
        }

        pub fn pairs(size: usize) -> impl Iterator<Item = (Key, Vec<u8>)> {
            keys().zip(data(size))
        }

        pub fn pairs_vary(range: Range<u64>) -> impl Iterator<Item = (Key, Vec<u8>)> {
            keys().zip(data_vary(range))
        }
    }
}