Add statistics to benchmarking-cli output

Cargo.toml

@@ -146,6 +146,7 @@ members = [
 	"primitives/std",
 	"primitives/version",
 	"primitives/state-machine",
+	"primitives/stats",
 	"primitives/timestamp",
 	"primitives/test-primitives",
 	"primitives/transaction-pool",

bin/node/runtime/Cargo.toml

@@ -43,6 +43,7 @@ pallet-authority-discovery = { version = "2.0.0-alpha.2", default-features = fal
 pallet-authorship = { version = "2.0.0-alpha.2", default-features = false, path = "../../../frame/authorship" }
 pallet-babe = { version = "2.0.0-alpha.2", default-features = false, path = "../../../frame/babe" }
 pallet-balances = { version = "2.0.0-alpha.2", default-features = false, path = "../../../frame/balances" }
+pallet-benchmark = { version = "2.0.0-alpha.2", default-features = false, path = "../../../frame/benchmark" }
 pallet-collective = { version = "2.0.0-alpha.2", default-features = false, path = "../../../frame/collective" }
 pallet-contracts = { version = "2.0.0-alpha.2", default-features = false, path = "../../../frame/contracts" }
 pallet-contracts-primitives = { version = "2.0.0-alpha.2", default-features = false, path = "../../../frame/contracts/common/" }
@@ -96,6 +97,7 @@ std = [
 	"frame-executive/std",
 	"pallet-finality-tracker/std",
 	"pallet-grandpa/std",
+	"pallet-benchmark/std",
 	"pallet-im-online/std",
 	"pallet-indices/std",
 	"sp-inherents/std",

bin/node/runtime/src/lib.rs

@@ -612,6 +612,11 @@ impl pallet_vesting::Trait for Runtime {
 	type MinVestedTransfer = MinVestedTransfer;
 }
 
+impl pallet_benchmark::Trait for Runtime {
+	type Event = Event;
+	type Currency = Balances;
+}
+
 construct_runtime!(
 	pub enum Runtime where
 		Block = Block,
@@ -646,6 +651,7 @@ construct_runtime!(
 		Society: pallet_society::{Module, Call, Storage, Event<T>, Config<T>},
 		Recovery: pallet_recovery::{Module, Call, Storage, Event<T>},
 		Vesting: pallet_vesting::{Module, Call, Storage, Event<T>, Config<T>},
+		Benchmark: pallet_benchmark::{Module, Call, Storage, Event<T>},
 	}
 );
 

client/Cargo.toml

@@ -34,6 +34,7 @@ sp-blockchain = { version = "2.0.0-alpha.2", path = "../primitives/blockchain" }
 sp-state-machine = { version = "0.8.0-alpha.2", path = "../primitives/state-machine" }
 sc-telemetry = { version = "2.0.0-alpha.2", path = "telemetry" }
 sp-trie = { version = "2.0.0-alpha.2", path = "../primitives/trie" }
+sp-stats = { version = "2.0.0-alpha.2", path = "../primitives/stats" }
 prometheus-endpoint = { package = "substrate-prometheus-endpoint", version = "0.8.0-alpha.2", path = "../utils/prometheus" }
 tracing = "0.1.10"
 

client/api/src/client.rs

@@ -172,8 +172,12 @@ pub struct IoInfo {
 	pub state_reads: u64,
 	/// State reads (keys) from cache.
 	pub state_reads_cache: u64,
-	/// State reads (keys) from cache.
+	/// State reads (keys)
 	pub state_writes: u64,
+	/// State write (keys) already cached.
+	pub state_writes_cache: u64,
+	/// State write (trie nodes) to backend db.
+	pub state_writes_nodes: u64,
 }
 
 /// Usage statistics for running client instance.
@@ -195,7 +199,7 @@ impl fmt::Display for UsageInfo {
 			f,
 			"caches: ({} state, {} db overlay), \
 			 state db: ({} non-canonical, {} pruning, {} pinned), \
-			 i/o: ({} tx, {} write, {} read, {} avg tx, {}/{} key cache reads/total, {} key writes)",
+			 i/o: ({} tx, {} write, {} read, {} avg tx, {}/{} key cache reads/total, {} trie nodes writes)",
 			self.memory.state_cache,
 			self.memory.database_cache,
 			self.memory.state_db.non_canonical,
@@ -207,7 +211,7 @@ impl fmt::Display for UsageInfo {
 			self.io.average_transaction_size,
 			self.io.state_reads_cache,
 			self.io.state_reads,
-			self.io.state_writes,
+			self.io.state_writes_nodes,
 		)
 	}
 }

client/db/Cargo.toml

@@ -25,6 +25,7 @@ sp-core = { version = "2.0.0-alpha.2", path = "../../primitives/core" }
 sp-runtime = { version = "2.0.0-alpha.2", path = "../../primitives/runtime" }
 sc-client = { version = "0.8.0-alpha.2", path = "../" }
 sp-state-machine = { version = "0.8.0-alpha.2", path = "../../primitives/state-machine" }
+sp-stats= { version = "2.0.0-alpha.2", path = "../../primitives/stats" }
 sc-executor = { version = "0.8.0-alpha.2", path = "../executor" }
 sc-state-db = { version = "0.8.0-alpha.2", path = "../state-db" }
 sp-trie = { version = "2.0.0-alpha.2", path = "../../primitives/trie" }

client/db/src/bench.rs

@@ -29,6 +29,7 @@ use sp_runtime::Storage;
 use sp_state_machine::{DBValue, backend::Backend as StateBackend};
 use kvdb::{KeyValueDB, DBTransaction};
 use kvdb_rocksdb::{Database, DatabaseConfig};
+use sp_stats::UsageInfo;
 
 type DbState<B> = sp_state_machine::TrieBackend<
 	Arc<dyn sp_state_machine::Storage<HashFor<B>>>, HashFor<B>
@@ -54,6 +55,7 @@ pub struct BenchmarkingState<B: BlockT> {
 	state: RefCell<Option<DbState<B>>>,
 	db: Cell<Option<Arc<dyn KeyValueDB>>>,
 	genesis: <DbState<B> as StateBackend<HashFor<B>>>::Transaction,
+	usage_info: RefCell<UsageInfo>,
 }
 
 impl<B: BlockT> BenchmarkingState<B> {
@@ -74,6 +76,7 @@ impl<B: BlockT> BenchmarkingState<B> {
 			path,
 			root: Cell::new(root),
 			genesis: Default::default(),
+			usage_info: RefCell::new(UsageInfo::empty()),
 		};
 
 		state.reopen()?;
@@ -132,7 +135,13 @@ impl<B: BlockT> StateBackend<HashFor<B>> for BenchmarkingState<B> {
 	type TrieBackendStorage = <DbState<B> as StateBackend<HashFor<B>>>::TrieBackendStorage;
 
 	fn storage(&self, key: &[u8]) -> Result<Option<Vec<u8>>, Self::Error> {
-		self.state.borrow().as_ref().ok_or_else(state_err)?.storage(key)
+		let state = self.state.borrow_mut();
+		let db_state = state.as_ref().ok_or_else(state_err)?;
+		let _ = self.usage_info.try_borrow_mut().map(|mut usage_info| {
+			usage_info.reads.ops += 1;
+			usage_info.reads.bytes += key.len() as u64;
+		});
+		db_state.storage(key)
 	}
 
 	fn storage_hash(&self, key: &[u8]) -> Result<Option<B::Hash>, Self::Error> {
@@ -254,15 +263,21 @@ impl<B: BlockT> StateBackend<HashFor<B>> for BenchmarkingState<B> {
 	{
 		if let Some(db) = self.db.take() {
 			let mut db_transaction = DBTransaction::new();
+			let mut bytes = 0;
 
 			for (key, (val, rc)) in transaction.drain() {
 				if rc > 0 {
 					db_transaction.put(0, &key, &val);
 				} else if rc < 0 {
 					db_transaction.delete(0, &key);
 				}
+				bytes += key.len() as u64;
 			}
 			db.write(db_transaction).map_err(|_| String::from("Error committing transaction"))?;
+			let _ = self.usage_info.try_borrow_mut().map(|mut usage_info| {
+				usage_info.writes.ops += 1;
+				usage_info.writes.bytes += bytes;
+			});
 			self.root.set(storage_root);
 		} else {
 			return Err("Trying to commit to a closed db".into())
@@ -276,6 +291,14 @@ impl<B: BlockT> StateBackend<HashFor<B>> for BenchmarkingState<B> {
 		self.commit(self.root.get(), self.genesis.clone())?;
 		Ok(())
 	}
+
+	fn register_overlay_stats(&mut self, stats: &sp_stats::StateMachineStats) {
+		self.state.borrow_mut().as_mut().map(|s| s.register_overlay_stats(stats));
+	}
+
+	fn usage_info(&self) -> UsageInfo {
+		self.usage_info.try_borrow().map_or(UsageInfo::empty(), |info| info.clone())
+	}
 }
 
 impl<Block: BlockT> std::fmt::Debug for BenchmarkingState<Block> {

client/db/src/lib.rs

@@ -71,10 +71,11 @@ use sp_runtime::traits::{
 };
 use sc_executor::RuntimeInfo;
 use sp_state_machine::{
-	DBValue, ChangesTrieTransaction, ChangesTrieCacheAction, UsageInfo as StateUsageInfo,
+	DBValue, ChangesTrieTransaction, ChangesTrieCacheAction, 
 	StorageCollection, ChildStorageCollection,
 	backend::Backend as StateBackend,
 };
+use sp_stats::{StateMachineStats, UsageInfo as StateUsageInfo};
 use crate::utils::{DatabaseType, Meta, db_err, meta_keys, read_db, read_meta};
 use crate::changes_tries_storage::{DbChangesTrieStorage, DbChangesTrieStorageTransaction};
 use sc_client::leaves::{LeafSet, FinalizationDisplaced};
@@ -256,6 +257,14 @@ impl<B: BlockT> StateBackend<HashFor<B>> for RefTrackingState<B> {
 	{
 		self.state.as_trie_backend()
 	}
+
+	fn register_overlay_stats(&mut self, stats: &StateMachineStats) {
+		self.state.register_overlay_stats(stats);
+	}
+
+	fn usage_info(&self) -> StateUsageInfo {
+		self.state.usage_info()
+	}
 }
 
 /// Database settings.
@@ -1116,21 +1125,35 @@ impl<Block: BlockT> Backend<Block> {
 				let mut changeset: sc_state_db::ChangeSet<Vec<u8>> = sc_state_db::ChangeSet::default();
 				let mut ops: u64 = 0;
 				let mut bytes: u64 = 0;
+				let mut removal: u64 = 0;
+				let mut bytes_removal: u64 = 0;
 				for (key, (val, rc)) in operation.db_updates.drain() {
 					if rc > 0 {
 						ops += 1;
 						bytes += key.len() as u64 + val.len() as u64;
 
 						changeset.inserted.push((key, val.to_vec()));
 					} else if rc < 0 {
-						ops += 1;
-						bytes += key.len() as u64;
+						removal += 1;
+						bytes_removal += key.len() as u64;
 
 						changeset.deleted.push(key);
 					}
 				}
-				self.state_usage.tally_writes(ops, bytes);
+				self.state_usage.tally_writes_nodes(ops, bytes);
+				self.state_usage.tally_removed_nodes(removal, bytes_removal);
 
+				let mut ops: u64 = 0;
+				let mut bytes: u64 = 0;
+				for (key, value) in operation.storage_updates.iter()
+					.chain(operation.child_storage_updates.iter().flat_map(|(_, s)| s.iter())) {
+						ops += 1;
+						bytes += key.len() as u64;
+						if let Some(v) = value.as_ref() {
+							bytes += v.len() as u64;
+						}
+				}
+				self.state_usage.tally_writes(ops, bytes);
 				let number_u64 = number.saturated_into::<u64>();
 				let commit = self.storage.state_db.insert_block(
 					&hash,
@@ -1498,8 +1521,10 @@ impl<Block: BlockT> sc_client_api::backend::Backend<Block> for Backend<Block> {
 				reads: io_stats.reads,
 				average_transaction_size: io_stats.avg_transaction_size() as u64,
 				state_reads: state_stats.reads.ops,
-				state_reads_cache: state_stats.cache_reads.ops,
 				state_writes: state_stats.writes.ops,
+				state_writes_cache: state_stats.overlay_writes.ops,
+				state_reads_cache: state_stats.cache_reads.ops,
+				state_writes_nodes: state_stats.nodes_writes.ops,
 			},
 		})
 	}
@@ -1676,6 +1701,7 @@ impl<Block: BlockT> sc_client_api::backend::Backend<Block> for Backend<Block> {
 	fn get_import_lock(&self) -> &RwLock<()> {
 		&*self.import_lock
 	}
+
 }
 
 impl<Block: BlockT> sc_client_api::backend::LocalBackend<Block> for Backend<Block> {}

client/db/src/light.rs

@@ -592,8 +592,10 @@ impl<Block> LightBlockchainStorage<Block> for LightStorage<Block>
 				average_transaction_size: io_stats.avg_transaction_size() as u64,
 				// Light client does not track those
 				state_reads: 0,
-				state_reads_cache: 0,
 				state_writes: 0,
+				state_reads_cache: 0,
+				state_writes_cache: 0,
+				state_writes_nodes: 0,
 			}
 		})
 	}