openethereum/ethcore/src/extras.rs

310 lines
7.3 KiB
Rust
Raw Normal View History

2016-02-05 13:40:41 +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-02-02 15:29:53 +01:00
//! Blockchain DB extras.
use util::*;
use header::BlockNumber;
2015-12-17 01:54:24 +01:00
use rocksdb::{DB, Writable};
2015-12-13 17:33:11 +01:00
2015-12-17 01:54:24 +01:00
/// Represents index of extra data in database
2016-01-18 19:23:28 +01:00
#[derive(Copy, Debug, Hash, Eq, PartialEq, Clone)]
2015-12-13 22:39:01 +01:00
pub enum ExtrasIndex {
2016-02-03 16:43:48 +01:00
/// Block details index
2015-12-13 22:39:01 +01:00
BlockDetails = 0,
2016-02-03 16:43:48 +01:00
/// Block hash index
2015-12-13 22:39:01 +01:00
BlockHash = 1,
2016-02-03 16:43:48 +01:00
/// Transaction address index
TransactionAddress = 2,
2016-02-03 16:43:48 +01:00
/// Block log blooms index
BlockLogBlooms = 3,
2016-02-03 16:43:48 +01:00
/// Block blooms index
BlocksBlooms = 4
}
2015-12-13 22:39:01 +01:00
2015-12-17 01:54:24 +01:00
/// trait used to write Extras data to db
pub trait ExtrasWritable {
2016-02-03 16:43:48 +01:00
/// Write extra data to db
2015-12-17 01:54:24 +01:00
fn put_extras<K, T>(&self, hash: &K, value: &T) where
T: ExtrasIndexable + Encodable,
K: ExtrasSliceConvertable;
}
2015-12-13 22:39:01 +01:00
2015-12-17 01:54:24 +01:00
/// trait used to read Extras data from db
pub trait ExtrasReadable {
2016-02-03 16:43:48 +01:00
/// Read extra data from db
2015-12-17 01:54:24 +01:00
fn get_extras<K, T>(&self, hash: &K) -> Option<T> where
T: ExtrasIndexable + Decodable,
K: ExtrasSliceConvertable;
2016-02-03 16:43:48 +01:00
/// Check if extra data exists in the db
2015-12-17 01:54:24 +01:00
fn extras_exists<K, T>(&self, hash: &K) -> bool where
T: ExtrasIndexable,
K: ExtrasSliceConvertable;
}
2015-12-13 22:39:01 +01:00
2015-12-17 01:54:24 +01:00
impl<W> ExtrasWritable for W where W: Writable {
fn put_extras<K, T>(&self, hash: &K, value: &T) where
T: ExtrasIndexable + Encodable,
K: ExtrasSliceConvertable {
self.put(&hash.to_extras_slice(T::extras_index()), &encode(value)).unwrap()
}
2015-12-13 22:39:01 +01:00
}
2015-12-17 01:54:24 +01:00
impl ExtrasReadable for DB {
fn get_extras<K, T>(&self, hash: &K) -> Option<T> where
T: ExtrasIndexable + Decodable,
K: ExtrasSliceConvertable {
self.get(&hash.to_extras_slice(T::extras_index())).unwrap()
.map(|v| decode(&v))
}
fn extras_exists<K, T>(&self, hash: &K) -> bool where
T: ExtrasIndexable,
K: ExtrasSliceConvertable {
2015-12-13 22:39:01 +01:00
2015-12-17 01:54:24 +01:00
self.get(&hash.to_extras_slice(T::extras_index())).unwrap().is_some()
2015-12-13 22:39:01 +01:00
}
}
2015-12-17 01:54:24 +01:00
/// Implementations should convert arbitrary type to database key slice
2015-12-13 22:39:01 +01:00
pub trait ExtrasSliceConvertable {
2016-02-03 13:20:32 +01:00
/// Convert self, with `i` (the index), to a 264-bit extras DB key.
2015-12-13 22:39:01 +01:00
fn to_extras_slice(&self, i: ExtrasIndex) -> H264;
2016-02-03 13:20:32 +01:00
/// Interpret self as a 256-bit hash, if natively `H256`.
2016-01-18 19:23:28 +01:00
fn as_h256(&self) -> Option<&H256> { None }
2015-12-13 22:39:01 +01:00
}
impl ExtrasSliceConvertable for H256 {
fn to_extras_slice(&self, i: ExtrasIndex) -> H264 {
let mut slice = H264::from_slice(self);
slice[32] = i as u8;
slice
}
2016-01-18 19:23:28 +01:00
fn as_h256(&self) -> Option<&H256> { Some(self) }
2015-12-13 22:39:01 +01:00
}
impl ExtrasSliceConvertable for U256 {
fn to_extras_slice(&self, i: ExtrasIndex) -> H264 {
H256::from(self).to_extras_slice(i)
}
}
// NICE: make less horrible.
impl ExtrasSliceConvertable for BlockNumber {
fn to_extras_slice(&self, i: ExtrasIndex) -> H264 {
U256::from(*self).to_extras_slice(i)
}
}
2015-12-17 01:54:24 +01:00
/// Types implementing this trait can be indexed in extras database
pub trait ExtrasIndexable {
2016-02-03 16:43:48 +01:00
/// Returns this data index
2015-12-17 01:54:24 +01:00
fn extras_index() -> ExtrasIndex;
}
impl ExtrasIndexable for H256 {
fn extras_index() -> ExtrasIndex {
ExtrasIndex::BlockHash
}
}
2015-12-13 22:39:01 +01:00
2015-12-17 01:54:24 +01:00
/// Familial details concerning a block
2015-12-17 17:20:10 +01:00
#[derive(Debug, Clone)]
2015-12-13 17:33:11 +01:00
pub struct BlockDetails {
2016-02-03 16:43:48 +01:00
/// Block number
pub number: BlockNumber,
2016-02-03 16:43:48 +01:00
/// Total difficulty of the block and all its parents
2015-12-13 17:33:11 +01:00
pub total_difficulty: U256,
2016-02-03 16:43:48 +01:00
/// Parent block hash
2015-12-13 17:33:11 +01:00
pub parent: H256,
2016-02-03 16:43:48 +01:00
/// List of children block hashes
2015-12-13 17:33:11 +01:00
pub children: Vec<H256>
}
2015-12-17 01:54:24 +01:00
impl ExtrasIndexable for BlockDetails {
fn extras_index() -> ExtrasIndex {
ExtrasIndex::BlockDetails
}
}
2015-12-16 17:39:15 +01:00
impl HeapSizeOf for BlockDetails {
fn heap_size_of_children(&self) -> usize {
self.children.heap_size_of_children()
}
}
2015-12-13 17:33:11 +01:00
impl Decodable for BlockDetails {
fn decode<D>(decoder: &D) -> Result<Self, DecoderError> where D: Decoder {
2016-01-29 13:59:29 +01:00
let d = decoder.as_rlp();
2015-12-14 12:18:53 +01:00
let details = BlockDetails {
2016-01-29 13:59:29 +01:00
number: try!(d.val_at(0)),
total_difficulty: try!(d.val_at(1)),
parent: try!(d.val_at(2)),
children: try!(d.val_at(3)),
2015-12-14 12:18:53 +01:00
};
Ok(details)
2015-12-13 17:33:11 +01:00
}
}
impl Encodable for BlockDetails {
2016-01-27 17:22:01 +01:00
fn rlp_append(&self, s: &mut RlpStream) {
s.begin_list(4);
s.append(&self.number);
s.append(&self.total_difficulty);
s.append(&self.parent);
2016-01-28 20:13:05 +01:00
s.append(&self.children);
2015-12-13 17:33:11 +01:00
}
}
2015-12-17 01:54:24 +01:00
/// Log blooms of certain block
#[derive(Clone)]
pub struct BlockLogBlooms {
2016-02-03 16:43:48 +01:00
/// List of log blooms for the block
pub blooms: Vec<H2048>
}
2015-12-17 01:54:24 +01:00
impl ExtrasIndexable for BlockLogBlooms {
fn extras_index() -> ExtrasIndex {
ExtrasIndex::BlockLogBlooms
}
}
2015-12-16 17:39:15 +01:00
impl HeapSizeOf for BlockLogBlooms {
fn heap_size_of_children(&self) -> usize {
self.blooms.heap_size_of_children()
}
}
impl Decodable for BlockLogBlooms {
fn decode<D>(decoder: &D) -> Result<Self, DecoderError> where D: Decoder {
let block_blooms = BlockLogBlooms {
blooms: try!(Decodable::decode(decoder))
};
Ok(block_blooms)
}
}
impl Encodable for BlockLogBlooms {
2016-01-27 17:22:01 +01:00
fn rlp_append(&self, s: &mut RlpStream) {
2016-01-28 20:13:05 +01:00
s.append(&self.blooms);
}
}
2015-12-17 01:54:24 +01:00
/// Neighboring log blooms on certain level
pub struct BlocksBlooms {
2016-02-03 16:43:48 +01:00
/// List of block blooms.
pub blooms: [H2048; 16]
}
impl BlocksBlooms {
pub fn new() -> Self {
BlocksBlooms { blooms: unsafe { ::std::mem::zeroed() }}
}
}
2015-12-17 01:54:24 +01:00
impl ExtrasIndexable for BlocksBlooms {
fn extras_index() -> ExtrasIndex {
ExtrasIndex::BlocksBlooms
}
}
2015-12-16 17:39:15 +01:00
impl HeapSizeOf for BlocksBlooms {
fn heap_size_of_children(&self) -> usize { 0 }
}
impl Clone for BlocksBlooms {
fn clone(&self) -> Self {
let mut blooms: [H2048; 16] = unsafe { ::std::mem::uninitialized() };
for i in 0..self.blooms.len() {
blooms[i] = self.blooms[i].clone();
}
BlocksBlooms {
blooms: blooms
}
}
}
impl Decodable for BlocksBlooms {
fn decode<D>(decoder: &D) -> Result<Self, DecoderError> where D: Decoder {
let blocks_blooms = BlocksBlooms {
blooms: try!(Decodable::decode(decoder))
};
Ok(blocks_blooms)
}
}
impl Encodable for BlocksBlooms {
2016-01-27 17:22:01 +01:00
fn rlp_append(&self, s: &mut RlpStream) {
let blooms_ref: &[H2048] = &self.blooms;
2016-01-28 20:13:05 +01:00
s.append(&blooms_ref);
}
}
/// Represents location of bloom in database.
2016-02-16 11:41:34 +01:00
#[derive(Debug)]
pub struct BlocksBloomLocation {
/// Unique hash of BlocksBloom
pub hash: H256,
/// Index within BlocksBloom
pub index: usize
}
2015-12-17 01:54:24 +01:00
/// Represents address of certain transaction within block
#[derive(Clone)]
pub struct TransactionAddress {
2016-02-03 16:43:48 +01:00
/// Block hash
pub block_hash: H256,
2016-02-03 16:43:48 +01:00
/// Transaction index within the block
2016-02-08 15:53:22 +01:00
pub index: usize
}
2015-12-17 01:54:24 +01:00
impl ExtrasIndexable for TransactionAddress {
fn extras_index() -> ExtrasIndex {
ExtrasIndex::TransactionAddress
}
}
2015-12-16 17:39:15 +01:00
impl HeapSizeOf for TransactionAddress {
fn heap_size_of_children(&self) -> usize { 0 }
}
impl Decodable for TransactionAddress {
fn decode<D>(decoder: &D) -> Result<Self, DecoderError> where D: Decoder {
2016-01-29 13:59:29 +01:00
let d = decoder.as_rlp();
let tx_address = TransactionAddress {
2016-01-29 13:59:29 +01:00
block_hash: try!(d.val_at(0)),
index: try!(d.val_at(1)),
};
Ok(tx_address)
}
}
impl Encodable for TransactionAddress {
2016-01-27 17:22:01 +01:00
fn rlp_append(&self, s: &mut RlpStream) {
s.begin_list(2);
s.append(&self.block_hash);
s.append(&self.index);
}
}