openethereum/util/src/journaldb/archivedb.rs

507 lines
13 KiB
Rust
Raw Normal View History

2016-03-11 13:50:39 +01:00
// Copyright 2015, 2016 Ethcore (UK) Ltd.
// This file is part of Parity.
// Parity is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
// Parity is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
// GNU General Public License for more details.
// You should have received a copy of the GNU General Public License
// along with Parity. If not, see <http://www.gnu.org/licenses/>.
2016-04-06 10:07:24 +02:00
//! Disk-backed `HashDB` implementation.
2016-03-11 13:50:39 +01:00
use common::*;
use rlp::*;
use hashdb::*;
use memorydb::*;
use super::{DB_PREFIX_LEN, LATEST_ERA_KEY};
2016-03-11 13:50:39 +01:00
use super::traits::JournalDB;
use kvdb::{Database, DBTransaction};
2016-03-11 13:50:39 +01:00
#[cfg(test)]
use std::env;
/// Suffix appended to auxiliary keys to distinguish them from normal keys.
/// Would be nich to use rocksdb columns for this eventually.
2016-06-27 09:16:34 +02:00
const AUX_FLAG: u8 = 255;
2016-04-06 10:07:24 +02:00
/// Implementation of the `HashDB` trait for a disk-backed database with a memory overlay
2016-03-11 13:50:39 +01:00
/// and latent-removal semantics.
///
2016-04-06 10:07:24 +02:00
/// Like `OverlayDB`, there is a memory overlay; `commit()` must be called in order to
/// write operations out to disk. Unlike `OverlayDB`, `remove()` operations do not take effect
/// immediately. As this is an "archive" database, nothing is ever removed. This means
/// that the states of any block the node has ever processed will be accessible.
2016-03-11 13:50:39 +01:00
pub struct ArchiveDB {
overlay: MemoryDB,
backing: Arc<Database>,
latest_era: Option<u64>,
column: Option<u32>,
2016-03-11 13:50:39 +01:00
}
impl ArchiveDB {
/// Create a new instance from file
pub fn new(backing: Arc<Database>, col: Option<u32>) -> ArchiveDB {
let latest_era = backing.get(col, &LATEST_ERA_KEY).expect("Low-level database error.").map(|val| decode::<u64>(&val));
2016-03-11 13:50:39 +01:00
ArchiveDB {
overlay: MemoryDB::new(),
backing: backing,
latest_era: latest_era,
column: col,
2016-03-11 13:50:39 +01:00
}
}
/// Create a new instance with an anonymous temporary database.
#[cfg(test)]
fn new_temp() -> ArchiveDB {
let mut dir = env::temp_dir();
dir.push(H32::random().hex());
let backing = Arc::new(Database::open_default(dir.to_str().unwrap()).unwrap());
Self::new(backing, None)
2016-03-11 13:50:39 +01:00
}
fn payload(&self, key: &H256) -> Option<Bytes> {
self.backing.get(self.column, key).expect("Low-level database error. Some issue with your hard disk?").map(|v| v.to_vec())
2016-03-11 13:50:39 +01:00
}
}
impl HashDB for ArchiveDB {
fn keys(&self) -> HashMap<H256, i32> {
let mut ret: HashMap<H256, i32> = HashMap::new();
for (key, _) in self.backing.iter(self.column) {
let h = H256::from_slice(&*key);
2016-03-11 13:50:39 +01:00
ret.insert(h, 1);
}
for (key, refs) in self.overlay.keys().into_iter() {
let refs = *ret.get(&key).unwrap_or(&0) + refs;
ret.insert(key, refs);
}
ret
}
fn get(&self, key: &H256) -> Option<&[u8]> {
2016-03-11 13:50:39 +01:00
let k = self.overlay.raw(key);
match k {
Some((d, rc)) if rc > 0 => Some(d),
2016-03-11 13:50:39 +01:00
_ => {
if let Some(x) = self.payload(key) {
Some(self.overlay.denote(key, x).0)
2016-03-11 13:50:39 +01:00
}
else {
None
}
}
}
}
fn contains(&self, key: &H256) -> bool {
self.get(key).is_some()
2016-03-11 13:50:39 +01:00
}
fn insert(&mut self, value: &[u8]) -> H256 {
self.overlay.insert(value)
}
2016-03-11 13:50:39 +01:00
fn emplace(&mut self, key: H256, value: Bytes) {
self.overlay.emplace(key, value);
}
fn remove(&mut self, key: &H256) {
self.overlay.remove(key);
2016-03-11 13:50:39 +01:00
}
2016-06-27 09:16:34 +02:00
fn insert_aux(&mut self, hash: Vec<u8>, value: Vec<u8>) {
self.overlay.insert_aux(hash, value);
}
fn get_aux(&self, hash: &[u8]) -> Option<Vec<u8>> {
if let Some(res) = self.overlay.get_aux(hash) {
return Some(res)
}
let mut db_hash = hash.to_vec();
db_hash.push(AUX_FLAG);
self.backing.get(self.column, &db_hash)
2016-06-27 09:16:34 +02:00
.expect("Low-level database error. Some issue with your hard disk?")
.map(|v| v.to_vec())
}
fn remove_aux(&mut self, hash: &[u8]) {
self.overlay.remove_aux(hash);
}
2016-03-11 13:50:39 +01:00
}
impl JournalDB for ArchiveDB {
2016-03-28 09:42:50 +02:00
fn boxed_clone(&self) -> Box<JournalDB> {
2016-03-11 13:50:39 +01:00
Box::new(ArchiveDB {
2016-03-27 14:35:27 +02:00
overlay: self.overlay.clone(),
2016-03-11 13:50:39 +01:00
backing: self.backing.clone(),
2016-03-13 19:22:42 +01:00
latest_era: self.latest_era,
column: self.column.clone(),
2016-03-11 13:50:39 +01:00
})
}
fn mem_used(&self) -> usize {
self.overlay.mem_used()
}
fn is_empty(&self) -> bool {
self.latest_era.is_none()
2016-03-11 13:50:39 +01:00
}
fn journal_under(&mut self, batch: &mut DBTransaction, now: u64, _id: &H256) -> Result<u32, UtilError> {
2016-03-11 13:50:39 +01:00
let mut inserts = 0usize;
let mut deletes = 0usize;
2016-06-27 09:16:34 +02:00
2016-03-11 13:50:39 +01:00
for i in self.overlay.drain().into_iter() {
let (key, (value, rc)) = i;
if rc > 0 {
batch.put(self.column, &key, &value);
2016-03-11 13:50:39 +01:00
inserts += 1;
}
if rc < 0 {
assert!(rc == -1);
deletes += 1;
}
}
2016-06-27 09:16:34 +02:00
for (mut key, value) in self.overlay.drain_aux().into_iter() {
key.push(AUX_FLAG);
batch.put(self.column, &key, &value);
2016-06-27 09:16:34 +02:00
}
2016-03-13 19:22:42 +01:00
if self.latest_era.map_or(true, |e| now > e) {
batch.put(self.column, &LATEST_ERA_KEY, &encode(&now));
2016-03-13 19:22:42 +01:00
self.latest_era = Some(now);
}
2016-03-11 13:50:39 +01:00
Ok((inserts + deletes) as u32)
}
2016-03-11 19:15:56 +01:00
fn mark_canonical(&mut self, _batch: &mut DBTransaction, _end_era: u64, _canon_id: &H256) -> Result<u32, UtilError> {
// keep everything! it's an archive, after all.
Ok(0)
}
fn inject(&mut self, batch: &mut DBTransaction) -> Result<u32, UtilError> {
let mut inserts = 0usize;
let mut deletes = 0usize;
for i in self.overlay.drain().into_iter() {
let (key, (value, rc)) = i;
if rc > 0 {
if try!(self.backing.get(self.column, &key)).is_some() {
return Err(BaseDataError::AlreadyExists(key).into());
}
batch.put(self.column, &key, &value);
inserts += 1;
}
if rc < 0 {
assert!(rc == -1);
if try!(self.backing.get(self.column, &key)).is_none() {
return Err(BaseDataError::NegativelyReferencedHash(key).into());
}
batch.delete(self.column, &key);
deletes += 1;
}
}
for (mut key, value) in self.overlay.drain_aux().into_iter() {
key.push(AUX_FLAG);
batch.put(self.column, &key, &value);
}
Ok((inserts + deletes) as u32)
}
2016-04-12 03:42:50 +02:00
fn latest_era(&self) -> Option<u64> { self.latest_era }
2016-04-12 00:51:14 +02:00
2016-03-11 19:15:56 +01:00
fn state(&self, id: &H256) -> Option<Bytes> {
self.backing.get_by_prefix(self.column, &id[0..DB_PREFIX_LEN]).map(|b| b.to_vec())
2016-03-11 19:15:56 +01:00
}
2016-06-03 12:10:10 +02:00
fn is_pruned(&self) -> bool { false }
fn backing(&self) -> &Arc<Database> {
&self.backing
}
fn consolidate(&mut self, with: MemoryDB) {
self.overlay.consolidate(with);
}
2016-03-11 13:50:39 +01:00
}
#[cfg(test)]
mod tests {
2016-03-18 10:14:19 +01:00
#![cfg_attr(feature="dev", allow(blacklisted_name))]
2016-04-06 10:07:24 +02:00
#![cfg_attr(feature="dev", allow(similar_names))]
2016-03-18 10:14:19 +01:00
2016-03-11 13:50:39 +01:00
use common::*;
use super::*;
use hashdb::*;
2016-03-11 15:54:28 +01:00
use journaldb::traits::JournalDB;
use kvdb::Database;
2016-03-11 13:50:39 +01:00
#[test]
fn insert_same_in_fork() {
// history is 1
let mut jdb = ArchiveDB::new_temp();
let x = jdb.insert(b"X");
jdb.commit_batch(1, &b"1".sha3(), None).unwrap();
jdb.commit_batch(2, &b"2".sha3(), None).unwrap();
jdb.commit_batch(3, &b"1002a".sha3(), Some((1, b"1".sha3()))).unwrap();
jdb.commit_batch(4, &b"1003a".sha3(), Some((2, b"2".sha3()))).unwrap();
2016-03-11 13:50:39 +01:00
jdb.remove(&x);
jdb.commit_batch(3, &b"1002b".sha3(), Some((1, b"1".sha3()))).unwrap();
2016-03-11 13:50:39 +01:00
let x = jdb.insert(b"X");
jdb.commit_batch(4, &b"1003b".sha3(), Some((2, b"2".sha3()))).unwrap();
2016-03-11 13:50:39 +01:00
jdb.commit_batch(5, &b"1004a".sha3(), Some((3, b"1002a".sha3()))).unwrap();
jdb.commit_batch(6, &b"1005a".sha3(), Some((4, b"1003a".sha3()))).unwrap();
2016-03-11 13:50:39 +01:00
assert!(jdb.contains(&x));
2016-03-11 13:50:39 +01:00
}
#[test]
fn long_history() {
// history is 3
let mut jdb = ArchiveDB::new_temp();
let h = jdb.insert(b"foo");
jdb.commit_batch(0, &b"0".sha3(), None).unwrap();
assert!(jdb.contains(&h));
2016-03-11 13:50:39 +01:00
jdb.remove(&h);
jdb.commit_batch(1, &b"1".sha3(), None).unwrap();
assert!(jdb.contains(&h));
jdb.commit_batch(2, &b"2".sha3(), None).unwrap();
assert!(jdb.contains(&h));
jdb.commit_batch(3, &b"3".sha3(), Some((0, b"0".sha3()))).unwrap();
assert!(jdb.contains(&h));
jdb.commit_batch(4, &b"4".sha3(), Some((1, b"1".sha3()))).unwrap();
2016-03-11 13:50:39 +01:00
}
#[test]
fn complex() {
// history is 1
let mut jdb = ArchiveDB::new_temp();
let foo = jdb.insert(b"foo");
let bar = jdb.insert(b"bar");
jdb.commit_batch(0, &b"0".sha3(), None).unwrap();
assert!(jdb.contains(&foo));
assert!(jdb.contains(&bar));
2016-03-11 13:50:39 +01:00
jdb.remove(&foo);
jdb.remove(&bar);
let baz = jdb.insert(b"baz");
jdb.commit_batch(1, &b"1".sha3(), Some((0, b"0".sha3()))).unwrap();
assert!(jdb.contains(&foo));
assert!(jdb.contains(&bar));
assert!(jdb.contains(&baz));
2016-03-11 13:50:39 +01:00
let foo = jdb.insert(b"foo");
jdb.remove(&baz);
jdb.commit_batch(2, &b"2".sha3(), Some((1, b"1".sha3()))).unwrap();
assert!(jdb.contains(&foo));
assert!(jdb.contains(&baz));
2016-03-11 13:50:39 +01:00
jdb.remove(&foo);
jdb.commit_batch(3, &b"3".sha3(), Some((2, b"2".sha3()))).unwrap();
assert!(jdb.contains(&foo));
2016-03-11 13:50:39 +01:00
jdb.commit_batch(4, &b"4".sha3(), Some((3, b"3".sha3()))).unwrap();
2016-03-11 13:50:39 +01:00
}
#[test]
fn fork() {
// history is 1
let mut jdb = ArchiveDB::new_temp();
let foo = jdb.insert(b"foo");
let bar = jdb.insert(b"bar");
jdb.commit_batch(0, &b"0".sha3(), None).unwrap();
assert!(jdb.contains(&foo));
assert!(jdb.contains(&bar));
2016-03-11 13:50:39 +01:00
jdb.remove(&foo);
let baz = jdb.insert(b"baz");
jdb.commit_batch(1, &b"1a".sha3(), Some((0, b"0".sha3()))).unwrap();
2016-03-11 13:50:39 +01:00
jdb.remove(&bar);
jdb.commit_batch(1, &b"1b".sha3(), Some((0, b"0".sha3()))).unwrap();
2016-03-11 13:50:39 +01:00
assert!(jdb.contains(&foo));
assert!(jdb.contains(&bar));
assert!(jdb.contains(&baz));
2016-03-11 13:50:39 +01:00
jdb.commit_batch(2, &b"2b".sha3(), Some((1, b"1b".sha3()))).unwrap();
assert!(jdb.contains(&foo));
2016-03-11 13:50:39 +01:00
}
#[test]
fn overwrite() {
// history is 1
let mut jdb = ArchiveDB::new_temp();
let foo = jdb.insert(b"foo");
jdb.commit_batch(0, &b"0".sha3(), None).unwrap();
assert!(jdb.contains(&foo));
2016-03-11 13:50:39 +01:00
jdb.remove(&foo);
jdb.commit_batch(1, &b"1".sha3(), Some((0, b"0".sha3()))).unwrap();
2016-03-11 13:50:39 +01:00
jdb.insert(b"foo");
assert!(jdb.contains(&foo));
jdb.commit_batch(2, &b"2".sha3(), Some((1, b"1".sha3()))).unwrap();
assert!(jdb.contains(&foo));
jdb.commit_batch(3, &b"2".sha3(), Some((0, b"2".sha3()))).unwrap();
assert!(jdb.contains(&foo));
2016-03-11 13:50:39 +01:00
}
#[test]
fn fork_same_key() {
// history is 1
let mut jdb = ArchiveDB::new_temp();
jdb.commit_batch(0, &b"0".sha3(), None).unwrap();
2016-03-11 13:50:39 +01:00
let foo = jdb.insert(b"foo");
jdb.commit_batch(1, &b"1a".sha3(), Some((0, b"0".sha3()))).unwrap();
2016-03-11 13:50:39 +01:00
jdb.insert(b"foo");
jdb.commit_batch(1, &b"1b".sha3(), Some((0, b"0".sha3()))).unwrap();
assert!(jdb.contains(&foo));
2016-03-11 13:50:39 +01:00
jdb.commit_batch(2, &b"2a".sha3(), Some((1, b"1a".sha3()))).unwrap();
assert!(jdb.contains(&foo));
2016-03-11 13:50:39 +01:00
}
fn new_db(dir: &Path) -> ArchiveDB {
let db = Database::open_default(dir.to_str().unwrap()).unwrap();
ArchiveDB::new(Arc::new(db), None)
}
2016-03-11 13:50:39 +01:00
#[test]
fn reopen() {
let mut dir = ::std::env::temp_dir();
dir.push(H32::random().hex());
let bar = H256::random();
let foo = {
let mut jdb = new_db(&dir);
2016-03-11 13:50:39 +01:00
// history is 1
let foo = jdb.insert(b"foo");
jdb.emplace(bar.clone(), b"bar".to_vec());
jdb.commit_batch(0, &b"0".sha3(), None).unwrap();
2016-03-11 13:50:39 +01:00
foo
};
{
let mut jdb = new_db(&dir);
2016-03-11 13:50:39 +01:00
jdb.remove(&foo);
jdb.commit_batch(1, &b"1".sha3(), Some((0, b"0".sha3()))).unwrap();
2016-03-11 13:50:39 +01:00
}
{
let mut jdb = new_db(&dir);
assert!(jdb.contains(&foo));
assert!(jdb.contains(&bar));
jdb.commit_batch(2, &b"2".sha3(), Some((1, b"1".sha3()))).unwrap();
2016-03-11 13:50:39 +01:00
}
}
#[test]
fn reopen_remove() {
let mut dir = ::std::env::temp_dir();
dir.push(H32::random().hex());
let foo = {
let mut jdb = new_db(&dir);
2016-03-11 13:50:39 +01:00
// history is 1
let foo = jdb.insert(b"foo");
jdb.commit_batch(0, &b"0".sha3(), None).unwrap();
jdb.commit_batch(1, &b"1".sha3(), Some((0, b"0".sha3()))).unwrap();
2016-03-11 13:50:39 +01:00
// foo is ancient history.
jdb.insert(b"foo");
jdb.commit_batch(2, &b"2".sha3(), Some((1, b"1".sha3()))).unwrap();
2016-03-11 13:50:39 +01:00
foo
};
{
let mut jdb = new_db(&dir);
2016-03-11 13:50:39 +01:00
jdb.remove(&foo);
jdb.commit_batch(3, &b"3".sha3(), Some((2, b"2".sha3()))).unwrap();
assert!(jdb.contains(&foo));
2016-03-11 13:50:39 +01:00
jdb.remove(&foo);
jdb.commit_batch(4, &b"4".sha3(), Some((3, b"3".sha3()))).unwrap();
jdb.commit_batch(5, &b"5".sha3(), Some((4, b"4".sha3()))).unwrap();
2016-03-11 13:50:39 +01:00
}
}
2016-03-18 10:14:19 +01:00
2016-03-11 13:50:39 +01:00
#[test]
fn reopen_fork() {
let mut dir = ::std::env::temp_dir();
dir.push(H32::random().hex());
let (foo, _, _) = {
let mut jdb = new_db(&dir);
2016-03-11 13:50:39 +01:00
// history is 1
let foo = jdb.insert(b"foo");
let bar = jdb.insert(b"bar");
jdb.commit_batch(0, &b"0".sha3(), None).unwrap();
2016-03-11 13:50:39 +01:00
jdb.remove(&foo);
let baz = jdb.insert(b"baz");
jdb.commit_batch(1, &b"1a".sha3(), Some((0, b"0".sha3()))).unwrap();
2016-03-11 13:50:39 +01:00
jdb.remove(&bar);
jdb.commit_batch(1, &b"1b".sha3(), Some((0, b"0".sha3()))).unwrap();
2016-03-11 13:50:39 +01:00
(foo, bar, baz)
};
{
let mut jdb = new_db(&dir);
jdb.commit_batch(2, &b"2b".sha3(), Some((1, b"1b".sha3()))).unwrap();
assert!(jdb.contains(&foo));
2016-03-11 13:50:39 +01:00
}
}
2016-03-11 19:15:56 +01:00
#[test]
fn returns_state() {
let temp = ::devtools::RandomTempPath::new();
let key = {
let mut jdb = new_db(temp.as_path().as_path());
2016-03-11 19:15:56 +01:00
let key = jdb.insert(b"foo");
jdb.commit_batch(0, &b"0".sha3(), None).unwrap();
2016-03-11 19:15:56 +01:00
key
};
{
let jdb = new_db(temp.as_path().as_path());
2016-03-11 19:15:56 +01:00
let state = jdb.state(&key);
assert!(state.is_some());
}
}
#[test]
fn inject() {
let temp = ::devtools::RandomTempPath::new();
let mut jdb = new_db(temp.as_path().as_path());
let key = jdb.insert(b"dog");
jdb.inject_batch().unwrap();
assert_eq!(jdb.get(&key).unwrap(), b"dog");
jdb.remove(&key);
jdb.inject_batch().unwrap();
assert!(jdb.get(&key).is_none());
}
2016-03-11 13:50:39 +01:00
}