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
// Copyright (c) The Diem Core Contributors
// SPDX-License-Identifier: Apache-2.0
use crate::DbReader;
use anyhow::{format_err, Result};
use diem_crypto::{hash::SPARSE_MERKLE_PLACEHOLDER_HASH, HashValue};
use diem_scratchpad::{AccountStatus, SparseMerkleTree};
use diem_state_view::{StateView, StateViewId};
use diem_types::{
access_path::AccessPath,
account_address::{AccountAddress, HashAccountAddress},
account_state::AccountState,
account_state_blob::AccountStateBlob,
proof::SparseMerkleProof,
transaction::{Version, PRE_GENESIS_VERSION},
};
use parking_lot::RwLock;
use std::{
collections::{hash_map::Entry, HashMap},
convert::TryInto,
sync::Arc,
};
/// `VerifiedStateView` is like a snapshot of the global state comprised of state view at two
/// levels, persistent storage and memory.
pub struct VerifiedStateView<'a> {
/// For logging and debugging purpose, identifies what this view is for.
id: StateViewId,
/// A gateway implementing persistent storage interface, which can be a RPC client or direct
/// accessor.
reader: Arc<dyn DbReader>,
/// The most recent version in persistent storage.
latest_persistent_version: Option<Version>,
/// The most recent state root hash in persistent storage.
latest_persistent_state_root: HashValue,
/// The in-momery version of sparse Merkle tree of which the states haven't been committed.
speculative_state: &'a SparseMerkleTree<AccountStateBlob>,
/// The cache of verified account states from `reader` and `speculative_state_view`,
/// represented by a hashmap with an account address as key and a pair of an ordered
/// account state map and an an optional account state proof as value. When the VM queries an
/// `access_path`, this cache will first check whether `reader_cache` is hit. If hit, it
/// will return the corresponding value of that `access_path`; otherwise, the account state
/// will be loaded into the cache from diem-scratchpad or persistent storage in order as a
/// deserialized ordered map and then be returned. If the VM queries this account again,
/// the cached data can be read directly without bothering storage layer. The proofs in
/// cache are needed by ScratchPad after VM execution to construct an in-memory sparse Merkle
/// tree.
/// ```text
/// +----------------------------+
/// | In-memory SparseMerkleTree <------+
/// +-------------^--------------+ |
/// | |
/// write sets |
/// | cached account state map
/// +-------+-------+ proof
/// | V M | |
/// +-------^-------+ |
/// | |
/// value of `account_address/path` |
/// | |
/// +---------------------------+---------------------+-------+
/// | +-------------------------+---------------------+-----+ |
/// | | account_to_state_cache, account_to_proof_cache | |
/// | +---------------^---------------------------^---------+ |
/// | | | |
/// | account state blob only account state blob |
/// | | proof |
/// | | | |
/// | +---------------+--------------+ +----------+---------+ |
/// | | speculative_state | | reader | |
/// | +------------------------------+ +--------------------+ |
/// +---------------------------------------------------------+
/// ```
account_to_state_cache: RwLock<HashMap<AccountAddress, AccountState>>,
account_to_proof_cache: RwLock<HashMap<HashValue, SparseMerkleProof<AccountStateBlob>>>,
}
impl<'a> VerifiedStateView<'a> {
/// Constructs a [`VerifiedStateView`] with persistent state view represented by
/// `latest_persistent_state_root` plus a storage reader, and the in-memory speculative state
/// on top of it represented by `speculative_state`.
pub fn new(
id: StateViewId,
reader: Arc<dyn DbReader>,
latest_persistent_version: Option<Version>,
latest_persistent_state_root: HashValue,
speculative_state: &'a SparseMerkleTree<AccountStateBlob>,
) -> Self {
// Hack: When there's no transaction in the db but state tree root hash is not the
// placeholder hash, it implies that there's pre-genesis state present.
let latest_persistent_version = latest_persistent_version.or_else(|| {
if latest_persistent_state_root != *SPARSE_MERKLE_PLACEHOLDER_HASH {
Some(PRE_GENESIS_VERSION)
} else {
None
}
});
Self {
id,
reader,
latest_persistent_version,
latest_persistent_state_root,
speculative_state,
account_to_state_cache: RwLock::new(HashMap::new()),
account_to_proof_cache: RwLock::new(HashMap::new()),
}
}
}
impl<'a> From<VerifiedStateView<'a>>
for (
HashMap<AccountAddress, AccountState>,
HashMap<HashValue, SparseMerkleProof<AccountStateBlob>>,
)
{
fn from(view: VerifiedStateView<'a>) -> Self {
(
view.account_to_state_cache.into_inner(),
view.account_to_proof_cache.into_inner(),
)
}
}
impl<'a> StateView for VerifiedStateView<'a> {
fn id(&self) -> StateViewId {
self.id
}
fn get(&self, access_path: &AccessPath) -> Result<Option<Vec<u8>>> {
let address = access_path.address;
let path = &access_path.path;
// Lock for read first:
if let Some(contents) = self.account_to_state_cache.read().get(&address) {
return Ok(contents.get(path).cloned());
}
// Do most of the work outside the write lock.
let address_hash = address.hash();
let account_blob_option = match self.speculative_state.get(address_hash) {
AccountStatus::ExistsInScratchPad(blob) => Some(blob),
AccountStatus::DoesNotExist => None,
// No matter it is in db or unknown, we have to query from db since even the
// former case, we don't have the blob data but only its hash.
AccountStatus::ExistsInDB | AccountStatus::Unknown => {
let (blob, proof) = match self.latest_persistent_version {
Some(version) => self
.reader
.get_account_state_with_proof_by_version(address, version)?,
None => (None, SparseMerkleProof::new(None, vec![])),
};
proof
.verify(
self.latest_persistent_state_root,
address.hash(),
blob.as_ref(),
)
.map_err(|err| {
format_err!(
"Proof is invalid for address {:?} with state root hash {:?}: {}",
address,
self.latest_persistent_state_root,
err
)
})?;
// multiple threads may enter this code, and another thread might add
// an address before this one. Thus the insertion might return a None here.
self.account_to_proof_cache
.write()
.insert(address_hash, proof);
blob
}
};
// Now enter the locked region, and write if still empty.
let new_account_blob = account_blob_option
.as_ref()
.map(TryInto::try_into)
.transpose()?
.unwrap_or_default();
match self.account_to_state_cache.write().entry(address) {
Entry::Occupied(occupied) => Ok(occupied.get().get(path).cloned()),
Entry::Vacant(vacant) => Ok(vacant.insert(new_account_blob).get(path).cloned()),
}
}
fn is_genesis(&self) -> bool {
self.latest_persistent_version.is_none()
}
}