2019-05-21 08:49:24 +00:00
|
|
|
//! Storage functionality for Lighthouse.
|
|
|
|
//!
|
|
|
|
//! Provides the following stores:
|
|
|
|
//!
|
2020-05-31 22:13:49 +00:00
|
|
|
//! - `HotColdDB`: an on-disk store backed by leveldb. Used in production.
|
2019-05-21 08:49:24 +00:00
|
|
|
//! - `MemoryStore`: an in-memory store backed by a hash-map. Used for testing.
|
|
|
|
//!
|
|
|
|
//! Provides a simple API for storing/retrieving all types that sometimes needs type-hints. See
|
|
|
|
//! tests for implementation examples.
|
2019-08-19 11:02:34 +00:00
|
|
|
#[macro_use]
|
|
|
|
extern crate lazy_static;
|
2019-05-21 08:49:24 +00:00
|
|
|
|
2019-12-06 07:52:11 +00:00
|
|
|
pub mod chunked_iter;
|
2019-11-26 23:54:46 +00:00
|
|
|
pub mod chunked_vector;
|
2019-12-06 03:29:06 +00:00
|
|
|
pub mod config;
|
2020-06-09 23:55:44 +00:00
|
|
|
pub mod errors;
|
2019-12-06 07:52:11 +00:00
|
|
|
mod forwards_iter;
|
2020-04-20 09:59:56 +00:00
|
|
|
pub mod hot_cold_store;
|
2019-05-20 08:01:51 +00:00
|
|
|
mod impls;
|
2019-05-21 06:29:34 +00:00
|
|
|
mod leveldb_store;
|
2019-05-21 08:49:24 +00:00
|
|
|
mod memory_store;
|
2020-09-30 02:36:07 +00:00
|
|
|
mod metadata;
|
2019-08-19 11:02:34 +00:00
|
|
|
mod metrics;
|
2019-11-26 23:54:46 +00:00
|
|
|
mod partial_beacon_state;
|
2019-02-14 01:09:18 +00:00
|
|
|
|
2019-06-15 13:56:41 +00:00
|
|
|
pub mod iter;
|
|
|
|
|
2020-07-01 02:45:57 +00:00
|
|
|
use std::borrow::Cow;
|
|
|
|
|
2019-12-06 03:29:06 +00:00
|
|
|
pub use self::config::StoreConfig;
|
2020-08-26 09:24:55 +00:00
|
|
|
pub use self::hot_cold_store::{BlockReplay, HotColdDB, HotStateSummary, Split};
|
2020-05-31 22:13:49 +00:00
|
|
|
pub use self::leveldb_store::LevelDB;
|
2019-05-21 08:49:24 +00:00
|
|
|
pub use self::memory_store::MemoryStore;
|
2019-11-26 23:54:46 +00:00
|
|
|
pub use self::partial_beacon_state::PartialBeaconState;
|
2019-05-20 08:01:51 +00:00
|
|
|
pub use errors::Error;
|
2019-12-06 05:44:03 +00:00
|
|
|
pub use impls::beacon_state::StorageContainer as BeaconStateStorageContainer;
|
2019-08-19 11:02:34 +00:00
|
|
|
pub use metrics::scrape_for_metrics;
|
2019-05-20 08:01:51 +00:00
|
|
|
pub use types::*;
|
|
|
|
|
2020-05-31 22:13:49 +00:00
|
|
|
pub trait KeyValueStore<E: EthSpec>: Sync + Send + Sized + 'static {
|
2019-11-26 23:54:46 +00:00
|
|
|
/// Retrieve some bytes in `column` with `key`.
|
|
|
|
fn get_bytes(&self, column: &str, key: &[u8]) -> Result<Option<Vec<u8>>, Error>;
|
|
|
|
|
|
|
|
/// Store some `value` in `column`, indexed with `key`.
|
|
|
|
fn put_bytes(&self, column: &str, key: &[u8], value: &[u8]) -> Result<(), Error>;
|
|
|
|
|
2020-07-02 23:47:31 +00:00
|
|
|
/// Same as put_bytes() but also force a flush to disk
|
|
|
|
fn put_bytes_sync(&self, column: &str, key: &[u8], value: &[u8]) -> Result<(), Error>;
|
|
|
|
|
|
|
|
/// Flush to disk. See
|
|
|
|
/// https://chromium.googlesource.com/external/leveldb/+/HEAD/doc/index.md#synchronous-writes
|
|
|
|
/// for details.
|
|
|
|
fn sync(&self) -> Result<(), Error>;
|
|
|
|
|
2019-11-26 23:54:46 +00:00
|
|
|
/// Return `true` if `key` exists in `column`.
|
|
|
|
fn key_exists(&self, column: &str, key: &[u8]) -> Result<bool, Error>;
|
|
|
|
|
|
|
|
/// Removes `key` from `column`.
|
|
|
|
fn key_delete(&self, column: &str, key: &[u8]) -> Result<(), Error>;
|
|
|
|
|
2020-05-31 22:13:49 +00:00
|
|
|
/// Execute either all of the operations in `batch` or none at all, returning an error.
|
2020-07-01 02:45:57 +00:00
|
|
|
fn do_atomically(&self, batch: Vec<KeyValueStoreOp>) -> Result<(), Error>;
|
2020-06-16 01:34:04 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
pub fn get_key_for_col(column: &str, key: &[u8]) -> Vec<u8> {
|
|
|
|
let mut result = column.as_bytes().to_vec();
|
|
|
|
result.extend_from_slice(key);
|
|
|
|
result
|
|
|
|
}
|
|
|
|
|
|
|
|
pub enum KeyValueStoreOp {
|
2020-07-01 02:45:57 +00:00
|
|
|
PutKeyValue(Vec<u8>, Vec<u8>),
|
2020-06-16 01:34:04 +00:00
|
|
|
DeleteKey(Vec<u8>),
|
2020-05-31 22:13:49 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
pub trait ItemStore<E: EthSpec>: KeyValueStore<E> + Sync + Send + Sized + 'static {
|
2019-05-21 08:49:24 +00:00
|
|
|
/// Store an item in `Self`.
|
2020-05-31 22:13:49 +00:00
|
|
|
fn put<I: StoreItem>(&self, key: &Hash256, item: &I) -> Result<(), Error> {
|
2020-05-25 00:26:54 +00:00
|
|
|
let column = I::db_column().into();
|
|
|
|
let key = key.as_bytes();
|
|
|
|
|
|
|
|
self.put_bytes(column, key, &item.as_store_bytes())
|
|
|
|
.map_err(Into::into)
|
2019-05-20 08:01:51 +00:00
|
|
|
}
|
|
|
|
|
2020-07-02 23:47:31 +00:00
|
|
|
fn put_sync<I: StoreItem>(&self, key: &Hash256, item: &I) -> Result<(), Error> {
|
|
|
|
let column = I::db_column().into();
|
|
|
|
let key = key.as_bytes();
|
|
|
|
|
|
|
|
self.put_bytes_sync(column, key, &item.as_store_bytes())
|
|
|
|
.map_err(Into::into)
|
|
|
|
}
|
|
|
|
|
2019-05-21 08:49:24 +00:00
|
|
|
/// Retrieve an item from `Self`.
|
2020-05-31 22:13:49 +00:00
|
|
|
fn get<I: StoreItem>(&self, key: &Hash256) -> Result<Option<I>, Error> {
|
2020-05-25 00:26:54 +00:00
|
|
|
let column = I::db_column().into();
|
|
|
|
let key = key.as_bytes();
|
|
|
|
|
|
|
|
match self.get_bytes(column, key)? {
|
|
|
|
Some(bytes) => Ok(Some(I::from_store_bytes(&bytes[..])?)),
|
|
|
|
None => Ok(None),
|
|
|
|
}
|
2019-05-20 08:01:51 +00:00
|
|
|
}
|
|
|
|
|
2019-05-21 08:49:24 +00:00
|
|
|
/// Returns `true` if the given key represents an item in `Self`.
|
2020-05-31 22:13:49 +00:00
|
|
|
fn exists<I: StoreItem>(&self, key: &Hash256) -> Result<bool, Error> {
|
2020-05-25 00:26:54 +00:00
|
|
|
let column = I::db_column().into();
|
|
|
|
let key = key.as_bytes();
|
|
|
|
|
|
|
|
self.key_exists(column, key)
|
2019-05-20 08:01:51 +00:00
|
|
|
}
|
|
|
|
|
2019-05-21 08:49:24 +00:00
|
|
|
/// Remove an item from `Self`.
|
2020-05-31 22:13:49 +00:00
|
|
|
fn delete<I: StoreItem>(&self, key: &Hash256) -> Result<(), Error> {
|
2020-05-25 00:26:54 +00:00
|
|
|
let column = I::db_column().into();
|
|
|
|
let key = key.as_bytes();
|
|
|
|
|
|
|
|
self.key_delete(column, key)
|
2019-05-20 08:01:51 +00:00
|
|
|
}
|
2020-05-31 22:13:49 +00:00
|
|
|
}
|
|
|
|
|
2020-05-16 03:23:32 +00:00
|
|
|
/// Reified key-value storage operation. Helps in modifying the storage atomically.
|
|
|
|
/// See also https://github.com/sigp/lighthouse/issues/692
|
2020-07-01 02:45:57 +00:00
|
|
|
#[allow(clippy::large_enum_variant)]
|
|
|
|
pub enum StoreOp<'a, E: EthSpec> {
|
|
|
|
PutBlock(SignedBeaconBlockHash, SignedBeaconBlock<E>),
|
|
|
|
PutState(BeaconStateHash, Cow<'a, BeaconState<E>>),
|
|
|
|
PutStateSummary(BeaconStateHash, HotStateSummary),
|
2020-05-16 03:23:32 +00:00
|
|
|
DeleteBlock(SignedBeaconBlockHash),
|
|
|
|
DeleteState(BeaconStateHash, Slot),
|
|
|
|
}
|
|
|
|
|
2019-05-21 08:49:24 +00:00
|
|
|
/// A unique column identifier.
|
2019-11-26 23:54:46 +00:00
|
|
|
#[derive(Debug, Clone, Copy, PartialEq)]
|
2019-05-20 08:01:51 +00:00
|
|
|
pub enum DBColumn {
|
2019-11-26 23:54:46 +00:00
|
|
|
/// For data related to the database itself.
|
|
|
|
BeaconMeta,
|
2019-05-20 08:01:51 +00:00
|
|
|
BeaconBlock,
|
|
|
|
BeaconState,
|
2020-03-06 05:09:41 +00:00
|
|
|
/// For persisting in-memory state to the database.
|
2019-05-20 08:01:51 +00:00
|
|
|
BeaconChain,
|
2020-03-06 05:09:41 +00:00
|
|
|
OpPool,
|
|
|
|
Eth1Cache,
|
|
|
|
ForkChoice,
|
2019-12-06 03:29:06 +00:00
|
|
|
/// For the table mapping restore point numbers to state roots.
|
|
|
|
BeaconRestorePoint,
|
2020-01-08 02:58:01 +00:00
|
|
|
/// For the mapping from state roots to their slots or summaries.
|
|
|
|
BeaconStateSummary,
|
2019-11-26 23:54:46 +00:00
|
|
|
BeaconBlockRoots,
|
|
|
|
BeaconStateRoots,
|
|
|
|
BeaconHistoricalRoots,
|
|
|
|
BeaconRandaoMixes,
|
2020-01-23 07:16:11 +00:00
|
|
|
DhtEnrs,
|
2019-05-20 08:01:51 +00:00
|
|
|
}
|
|
|
|
|
2019-11-26 23:54:46 +00:00
|
|
|
impl Into<&'static str> for DBColumn {
|
2020-09-30 02:36:07 +00:00
|
|
|
/// Returns a `&str` prefix to be added to keys before they hit the key-value database.
|
2019-11-26 23:54:46 +00:00
|
|
|
fn into(self) -> &'static str {
|
2019-05-20 08:01:51 +00:00
|
|
|
match self {
|
2019-11-26 23:54:46 +00:00
|
|
|
DBColumn::BeaconMeta => "bma",
|
|
|
|
DBColumn::BeaconBlock => "blk",
|
|
|
|
DBColumn::BeaconState => "ste",
|
|
|
|
DBColumn::BeaconChain => "bch",
|
2020-03-06 05:09:41 +00:00
|
|
|
DBColumn::OpPool => "opo",
|
|
|
|
DBColumn::Eth1Cache => "etc",
|
|
|
|
DBColumn::ForkChoice => "frk",
|
2019-12-06 03:29:06 +00:00
|
|
|
DBColumn::BeaconRestorePoint => "brp",
|
2020-01-08 02:58:01 +00:00
|
|
|
DBColumn::BeaconStateSummary => "bss",
|
2019-11-26 23:54:46 +00:00
|
|
|
DBColumn::BeaconBlockRoots => "bbr",
|
|
|
|
DBColumn::BeaconStateRoots => "bsr",
|
|
|
|
DBColumn::BeaconHistoricalRoots => "bhr",
|
|
|
|
DBColumn::BeaconRandaoMixes => "brm",
|
2020-01-23 07:16:11 +00:00
|
|
|
DBColumn::DhtEnrs => "dht",
|
2019-05-20 08:01:51 +00:00
|
|
|
}
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2019-11-26 23:54:46 +00:00
|
|
|
/// An item that may stored in a `Store` by serializing and deserializing from bytes.
|
2020-05-31 22:13:49 +00:00
|
|
|
pub trait StoreItem: Sized {
|
2019-05-21 08:49:24 +00:00
|
|
|
/// Identifies which column this item should be placed in.
|
2019-05-20 08:01:51 +00:00
|
|
|
fn db_column() -> DBColumn;
|
|
|
|
|
2019-05-21 08:49:24 +00:00
|
|
|
/// Serialize `self` as bytes.
|
2019-05-20 08:01:51 +00:00
|
|
|
fn as_store_bytes(&self) -> Vec<u8>;
|
|
|
|
|
2019-05-21 08:49:24 +00:00
|
|
|
/// De-serialize `self` from bytes.
|
2019-11-26 23:54:46 +00:00
|
|
|
///
|
|
|
|
/// Return an instance of the type and the number of bytes that were read.
|
|
|
|
fn from_store_bytes(bytes: &[u8]) -> Result<Self, Error>;
|
2020-07-01 02:45:57 +00:00
|
|
|
|
|
|
|
fn as_kv_store_op(&self, key: Hash256) -> KeyValueStoreOp {
|
|
|
|
let db_key = get_key_for_col(Self::db_column().into(), key.as_bytes());
|
|
|
|
KeyValueStoreOp::PutKeyValue(db_key, self.as_store_bytes())
|
|
|
|
}
|
2019-11-26 23:54:46 +00:00
|
|
|
}
|
|
|
|
|
2019-05-20 08:01:51 +00:00
|
|
|
#[cfg(test)]
|
|
|
|
mod tests {
|
|
|
|
use super::*;
|
|
|
|
use ssz::{Decode, Encode};
|
|
|
|
use ssz_derive::{Decode, Encode};
|
2019-05-21 06:29:34 +00:00
|
|
|
use tempfile::tempdir;
|
2019-05-20 08:01:51 +00:00
|
|
|
|
|
|
|
#[derive(PartialEq, Debug, Encode, Decode)]
|
|
|
|
struct StorableThing {
|
|
|
|
a: u64,
|
|
|
|
b: u64,
|
|
|
|
}
|
|
|
|
|
2020-05-31 22:13:49 +00:00
|
|
|
impl StoreItem for StorableThing {
|
2019-05-20 08:01:51 +00:00
|
|
|
fn db_column() -> DBColumn {
|
|
|
|
DBColumn::BeaconBlock
|
|
|
|
}
|
|
|
|
|
|
|
|
fn as_store_bytes(&self) -> Vec<u8> {
|
|
|
|
self.as_ssz_bytes()
|
|
|
|
}
|
|
|
|
|
2019-11-26 23:54:46 +00:00
|
|
|
fn from_store_bytes(bytes: &[u8]) -> Result<Self, Error> {
|
2019-05-20 08:01:51 +00:00
|
|
|
Self::from_ssz_bytes(bytes).map_err(Into::into)
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2020-05-31 22:13:49 +00:00
|
|
|
fn test_impl(store: impl ItemStore<MinimalEthSpec>) {
|
2019-05-21 06:29:34 +00:00
|
|
|
let key = Hash256::random();
|
|
|
|
let item = StorableThing { a: 1, b: 42 };
|
|
|
|
|
2020-05-21 00:21:44 +00:00
|
|
|
assert_eq!(store.exists::<StorableThing>(&key).unwrap(), false);
|
2019-05-21 06:37:15 +00:00
|
|
|
|
2019-05-21 06:29:34 +00:00
|
|
|
store.put(&key, &item).unwrap();
|
|
|
|
|
2020-05-21 00:21:44 +00:00
|
|
|
assert_eq!(store.exists::<StorableThing>(&key).unwrap(), true);
|
2019-05-21 06:29:34 +00:00
|
|
|
|
2019-05-21 06:37:15 +00:00
|
|
|
let retrieved = store.get(&key).unwrap().unwrap();
|
2019-05-21 06:29:34 +00:00
|
|
|
assert_eq!(item, retrieved);
|
2019-05-21 06:37:15 +00:00
|
|
|
|
|
|
|
store.delete::<StorableThing>(&key).unwrap();
|
|
|
|
|
2020-05-21 00:21:44 +00:00
|
|
|
assert_eq!(store.exists::<StorableThing>(&key).unwrap(), false);
|
2019-05-21 06:37:15 +00:00
|
|
|
|
2020-05-21 00:21:44 +00:00
|
|
|
assert_eq!(store.get::<StorableThing>(&key).unwrap(), None);
|
2019-05-21 06:29:34 +00:00
|
|
|
}
|
|
|
|
|
2019-11-26 23:54:46 +00:00
|
|
|
#[test]
|
|
|
|
fn simplediskdb() {
|
2019-05-21 06:37:15 +00:00
|
|
|
let dir = tempdir().unwrap();
|
|
|
|
let path = dir.path();
|
2020-05-31 22:13:49 +00:00
|
|
|
let store = LevelDB::open(&path).unwrap();
|
2019-05-20 08:01:51 +00:00
|
|
|
|
2019-05-21 06:37:15 +00:00
|
|
|
test_impl(store);
|
|
|
|
}
|
2019-05-20 08:01:51 +00:00
|
|
|
|
2019-05-21 06:37:15 +00:00
|
|
|
#[test]
|
|
|
|
fn memorydb() {
|
2019-05-21 08:20:23 +00:00
|
|
|
let store = MemoryStore::open();
|
2019-05-20 08:01:51 +00:00
|
|
|
|
2019-05-21 06:37:15 +00:00
|
|
|
test_impl(store);
|
2019-05-20 08:01:51 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
#[test]
|
|
|
|
fn exists() {
|
2019-12-06 07:52:11 +00:00
|
|
|
let store = MemoryStore::<MinimalEthSpec>::open();
|
2019-05-20 08:01:51 +00:00
|
|
|
let key = Hash256::random();
|
|
|
|
let item = StorableThing { a: 1, b: 42 };
|
|
|
|
|
|
|
|
assert_eq!(store.exists::<StorableThing>(&key).unwrap(), false);
|
|
|
|
|
|
|
|
store.put(&key, &item).unwrap();
|
|
|
|
|
|
|
|
assert_eq!(store.exists::<StorableThing>(&key).unwrap(), true);
|
|
|
|
|
|
|
|
store.delete::<StorableThing>(&key).unwrap();
|
2019-02-27 23:24:27 +00:00
|
|
|
|
2019-05-20 08:01:51 +00:00
|
|
|
assert_eq!(store.exists::<StorableThing>(&key).unwrap(), false);
|
|
|
|
}
|
2019-02-27 23:24:27 +00:00
|
|
|
}
|