Struct sc_client_db::bench::BenchmarkingState

pub struct BenchmarkingState<B: BlockT> { /* fields omitted */ }

State that manages the backend database reference. Allows runtime to control the database.

Implementations

impl<B: BlockT> BenchmarkingState<B>

pub fn new(
    genesis: Storage,
    _cache_size_mb: Option<usize>,
    record_proof: bool,
    enable_tracking: bool
) -> Result<Self, String>

Create a new instance that creates a database in a temporary dir.

Trait Implementations

impl<B: BlockT> Backend<<<B as Block>::Header as Header>::Hashing> for BenchmarkingState<B>

fn read_write_count(&self) -> (u32, u32, u32, u32)

Get the key tracking information for the state db.

1. reads - Total number of DB reads.
2. repeat_reads - Total number of in-memory reads.
3. writes - Total number of DB writes.
4. repeat_writes - Total number of in-memory writes.

fn reset_read_write_count(&self)

Reset the key tracking information for the state db.

type Error = <TrieBackend<Arc<dyn Storage<HashFor<B>>>, HashFor<B>> as StateBackend<HashFor<B>>>::Error

An error type when fetching data is not possible.

type Transaction = <TrieBackend<Arc<dyn Storage<HashFor<B>>>, HashFor<B>> as StateBackend<HashFor<B>>>::Transaction

Storage changes to be applied if committing

type TrieBackendStorage = <TrieBackend<Arc<dyn Storage<HashFor<B>>>, HashFor<B>> as StateBackend<HashFor<B>>>::TrieBackendStorage

Type of trie backend storage.

fn storage(&self, key: &[u8]) -> Result<Option<Vec<u8>>, Self::Error>

Get keyed storage or None if there is nothing associated.

fn storage_hash(&self, key: &[u8]) -> Result<Option<B::Hash>, Self::Error>

Get keyed storage value hash or None if there is nothing associated.

fn child_storage(
    &self,
    child_info: &ChildInfo,
    key: &[u8]
) -> Result<Option<Vec<u8>>, Self::Error>

Get keyed child storage or None if there is nothing associated.

fn exists_storage(&self, key: &[u8]) -> Result<bool, Self::Error>

true if a key exists in storage.

fn exists_child_storage(
    &self,
    child_info: &ChildInfo,
    key: &[u8]
) -> Result<bool, Self::Error>

true if a key exists in child storage.

fn next_storage_key(&self, key: &[u8]) -> Result<Option<Vec<u8>>, Self::Error>

Return the next key in storage in lexicographic order or None if there is no value.

fn next_child_storage_key(
    &self,
    child_info: &ChildInfo,
    key: &[u8]
) -> Result<Option<Vec<u8>>, Self::Error>

Return the next key in child storage in lexicographic order or None if there is no value.

fn for_keys_with_prefix<F: FnMut(&[u8])>(&self, prefix: &[u8], f: F)

Retrieve all entries keys which start with the given prefix and call f for each of those keys.

fn for_key_values_with_prefix<F: FnMut(&[u8], &[u8])>(
    &self,
    prefix: &[u8],
    f: F
)

Retrieve all entries keys and values of which start with the given prefix and call f for each of those keys.

fn apply_to_key_values_while<F: FnMut(Vec<u8>, Vec<u8>) -> bool>(
    &self,
    child_info: Option<&ChildInfo>,
    prefix: Option<&[u8]>,
    start_at: Option<&[u8]>,
    f: F,
    allow_missing: bool
) -> Result<bool, Self::Error>

Iterate over storage starting at key, for a given prefix and child trie. Aborts as soon as f returns false. Warning, this fails at first error when usual iteration skips errors. If allow_missing is true, iteration stops when it reaches a missing trie node. Otherwise an error is produced.

fn apply_to_keys_while<F: FnMut(&[u8]) -> bool>(
    &self,
    child_info: Option<&ChildInfo>,
    prefix: Option<&[u8]>,
    f: F
)

Retrieve all entries keys of storage and call f for each of those keys. Aborts as soon as f returns false.

fn for_child_keys_with_prefix<F: FnMut(&[u8])>(
    &self,
    child_info: &ChildInfo,
    prefix: &[u8],
    f: F
)

Retrieve all child entries keys which start with the given prefix and call f for each of those keys.

fn storage_root<'a>(
    &self,
    delta: impl Iterator<Item = (&'a [u8], Option<&'a [u8]>)>
) -> (B::Hash, Self::Transaction) where
    B::Hash: Ord, 

Calculate the storage root, with given delta over what is already stored in the backend, and produce a “transaction” that can be used to commit. Does not include child storage updates.

fn child_storage_root<'a>(
    &self,
    child_info: &ChildInfo,
    delta: impl Iterator<Item = (&'a [u8], Option<&'a [u8]>)>
) -> (B::Hash, bool, Self::Transaction) where
    B::Hash: Ord, 

Calculate the child storage root, with given delta over what is already stored in the backend, and produce a “transaction” that can be used to commit. The second argument is true if child storage root equals default storage root.

fn pairs(&self) -> Vec<(Vec<u8>, Vec<u8>)>

Get all key/value pairs into a Vec.

fn keys(&self, prefix: &[u8]) -> Vec<Vec<u8>>

Get all keys with given prefix

fn child_keys(&self, child_info: &ChildInfo, prefix: &[u8]) -> Vec<Vec<u8>>

Get all keys of child storage with given prefix

fn as_trie_backend(
    &mut self
) -> Option<&TrieBackend<Self::TrieBackendStorage, HashFor<B>>>

Try convert into trie backend.

fn commit(
    &self,
    storage_root: <HashFor<B> as Hasher>::Out,
    transaction: Self::Transaction,
    main_storage_changes: StorageCollection,
    child_storage_changes: ChildStorageCollection
) -> Result<(), Self::Error>

Commit given transaction to storage.

fn wipe(&self) -> Result<(), Self::Error>

Wipe the state database.

fn get_whitelist(&self) -> Vec<TrackedStorageKey>

Get the whitelist for tracking db reads/writes

fn set_whitelist(&self, new: Vec<TrackedStorageKey>)

Update the whitelist for tracking db reads/writes

fn get_read_and_written_keys(&self) -> Vec<(Vec<u8>, u32, u32, bool)>

Extend storage info for benchmarking db

fn register_overlay_stats(&self, stats: &StateMachineStats)

Register stats from overlay of state machine.

fn usage_info(&self) -> UsageInfo

Query backend usage statistics (i/o, memory)

fn proof_size(&self) -> Option<u32>

Estimate proof size

fn child_storage_hash(
    &self,
    child_info: &ChildInfo,
    key: &[u8]
) -> Result<Option<<H as Hasher>::Out>, Self::Error>

Get child keyed storage value hash or None if there is nothing associated.

fn full_storage_root<'a>(
    &self,
    delta: impl Iterator<Item = (&'a [u8], Option<&'a [u8]>)>,
    child_deltas: impl Iterator<Item = (&'a ChildInfo, impl Iterator<Item = (&'a [u8], Option<&'a [u8]>)>)>
) -> (<H as Hasher>::Out, Self::Transaction) where
    <H as Hasher>::Out: Ord,
    <H as Hasher>::Out: Encode, 

Calculate the storage root, with given delta over what is already stored in the backend, and produce a “transaction” that can be used to commit. Does include child storage updates.

impl<Block: BlockT> Debug for BenchmarkingState<Block>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.