cfx_storage/impls/
recording_storage.rs

1// Copyright 2020 Conflux Foundation. All rights reserved.
2// Conflux is free software and distributed under GNU General Public License.
3// See http://www.gnu.org/licenses/
4
5// `RecordingStorage` is a wrapper around other storage implementations that
6// tracks all read accesses. It can then be turned into a `StateProof` that is
7// able to prove all key-value accesses.
8
9pub struct RecordingStorage<Storage: StateTrait> {
10    storage: Storage,
11
12    // note: we need interior mutability so that we can record accesses and we
13    // need to use Mutex for this as State implementations need to be Send and
14    // Sync. However, the current execution logic is single-threaded.
15    proof_merger: Mutex<StateProofMerger>,
16}
17
18impl<Storage: StateTrait> RecordingStorage<Storage> {
19    pub fn new(storage: Storage) -> Self {
20        Self {
21            storage,
22            proof_merger: Default::default(),
23        }
24    }
25
26    pub fn try_into_proof(self) -> Result<StateProof> {
27        self.proof_merger.into_inner().finish()
28    }
29}
30
31impl<Storage: StateTrait + StateTraitExt> RecordingStorage<Storage> {
32    fn record_kvs(&self, kvs: &Vec<MptKeyValue>) -> Result<()> {
33        let mut proof_merger = self.proof_merger.lock();
34
35        for (k, _) in kvs {
36            let access_key =
37                StorageKeyWithSpace::from_key_bytes::<CheckInput>(k)?;
38            let (_, proof) = self.storage.get_with_proof(access_key)?;
39            proof_merger.merge(proof);
40        }
41
42        Ok(())
43    }
44}
45
46impl<Storage: StateTrait + StateTraitExt> StateTrait
47    for RecordingStorage<Storage>
48{
49    delegate! {
50        to self.storage {
51            fn set(&mut self, access_key: StorageKeyWithSpace, value: Box<[u8]>) -> Result<()>;
52            fn delete(&mut self, access_key: StorageKeyWithSpace) -> Result<()>;
53            fn delete_test_only(&mut self, access_key: StorageKeyWithSpace) -> Result<Option<Box<[u8]>>>;
54            fn compute_state_root(&mut self) -> Result<StateRootWithAuxInfo>;
55            fn get_state_root(&self) -> Result<StateRootWithAuxInfo>;
56            fn commit(&mut self, epoch_id: EpochId) -> Result<StateRootWithAuxInfo>;
57            fn read_all_with_callback(&mut self, access_key_prefix: StorageKeyWithSpace, callback: &mut dyn FnMut(MptKeyValue), only_account_key: bool) -> Result<()>;
58        }
59    }
60
61    // we need to record `get` operations
62    fn get(
63        &self, access_key: StorageKeyWithSpace,
64    ) -> Result<Option<Box<[u8]>>> {
65        let (val, proof) = self.storage.get_with_proof(access_key)?;
66        self.proof_merger.lock().merge(proof);
67        Ok(val)
68    }
69
70    fn delete_all(
71        &mut self, access_key_prefix: StorageKeyWithSpace,
72    ) -> Result<Option<Vec<MptKeyValue>>> {
73        match self.storage.delete_all(access_key_prefix)? {
74            None => Ok(None),
75            Some(kvs) => {
76                self.record_kvs(&kvs)?;
77                Ok(Some(kvs))
78            }
79        }
80    }
81
82    fn read_all(
83        &mut self, access_key_prefix: StorageKeyWithSpace,
84    ) -> Result<Option<Vec<MptKeyValue>>> {
85        match self.storage.read_all(access_key_prefix)? {
86            None => Ok(None),
87            Some(kvs) => {
88                self.record_kvs(&kvs)?;
89                Ok(Some(kvs))
90            }
91        }
92    }
93}
94
95use crate::{
96    impls::{
97        errors::*, merkle_patricia_trie::MptKeyValue, state_proof::StateProof,
98    },
99    state::*,
100    StateProofMerger,
101};
102use cfx_internal_common::StateRootWithAuxInfo;
103use delegate::delegate;
104use parking_lot::Mutex;
105use primitives::{CheckInput, EpochId, StorageKeyWithSpace};
cfx_storage/impls/recording_storage.rs

cfx_storage/impls/
recording_storage.rs
