A Pallet for Benchmarking Common Runtime Operations (#4902)

* Benchmark pallet * Add a bunch more benchmarks * do nothing test * new benchmarks * Clean up extra tests * Encode and Decode Vec<T::AccountId> * Starting to migrate benchmarks to macro * Use macro * Remove call and storage * Update Cargo.toml * Add storage recalc benchmark * Add support for custom functions in benchmark! macro * Reset DB for storage recalc * Feedback from review * Add more comments * Remove benchmark pallet from node * Fix cargo files * Fix comments * Change `crate` to `super` * missed one * Use results of benchmark encode/decode * Pass generic to extra functions * reset macro to master * Update lib.rs * Update to use standard syntax
2026-07-06 17:17:22 +00:00 · 2020-03-04 18:21:42 +02:00
parent e366b5bd2c
commit 3d6329a22d
11 changed files with 359 additions and 8 deletions
@@ -0,0 +1,131 @@
+// Copyright 2020 Parity Technologies (UK) Ltd.
+// This file is part of Substrate.
+
+// Substrate 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.
+
+// Substrate 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 Substrate.  If not, see <http://www.gnu.org/licenses/>.
+
+//! Benchmarks for common FRAME Pallet operations.
+
+use super::*;
+
+use frame_system::RawOrigin;
+use sp_std::prelude::*;
+use frame_benchmarking::{benchmarks, account};
+
+use crate::Module as Benchmark;
+
+const SEED: u32 = 0;
+
+benchmarks! {
+	_ {
+		let m in 1 .. 1000 => {
+			let origin = RawOrigin::Signed(account("member", m, SEED));
+			Benchmark::<T>::add_member_list(origin.into())?
+		};
+		let i in 1 .. 1000 => {
+			MyMap::insert(i, i);
+		};
+		let d in 1 .. 1000 => {
+			for i in 0..d {
+				for j in 0..100 {
+					MyDoubleMap::insert(i, j, d);
+				}
+			}
+		};
+	}
+
+	add_member_list {
+		let m in ...;
+	}: _(RawOrigin::Signed(account("member", m + 1, SEED)))
+
+	append_member_list {
+		let m in ...;
+	}: _(RawOrigin::Signed(account("member", m + 1, SEED)))
+
+	read_value {
+		let n in 1 .. 1000;
+		MyValue::put(n);
+	}: _(RawOrigin::Signed(account("user", 0, SEED)), n)
+
+	put_value {
+		let n in 1 .. 1000;
+	}: _(RawOrigin::Signed(account("user", 0, SEED)), n)
+
+	exists_value {
+		let n in 1 .. 1000;
+		MyValue::put(n);
+	}: _(RawOrigin::Signed(account("user", 0, SEED)), n)
+
+	remove_value {
+		let i in ...;
+	}: _(RawOrigin::Signed(account("user", 0, SEED)), i)
+
+	read_map {
+		let i in ...;
+	}: _(RawOrigin::Signed(account("user", 0, SEED)), i)
+
+	insert_map {
+		let n in 1 .. 1000;
+	}: _(RawOrigin::Signed(account("user", 0, SEED)), n)
+
+	contains_key_map {
+		let i in ...;
+	}: _(RawOrigin::Signed(account("user", 0, SEED)), i)
+
+	remove_prefix {
+		let d in ...;
+	}: _(RawOrigin::Signed(account("user", 0, SEED)), d)
+
+	do_nothing {
+		let n in 1 .. 1000;
+	}: _(RawOrigin::Signed(account("user", 0, SEED)), n)
+
+	encode_accounts {
+		let a in 1 .. 1000;
+		let mut accounts = Vec::new();
+		for _ in 0..a {
+			accounts.push(account::<T::AccountId>("encode", a, SEED));
+		}
+	}: _(RawOrigin::Signed(account("user", 0, SEED)), accounts)
+
+	decode_accounts {
+		let a in 1 .. 1000;
+		let mut accounts = Vec::new();
+		for _ in 0..a {
+			accounts.push(account::<T::AccountId>("encode", a, SEED));
+		}
+		let bytes = accounts.encode();
+	}: _(RawOrigin::Signed(account("user", 0, SEED)), bytes)
+
+	// Custom implementation to handle benchmarking of storage recalculation.
+	// Puts `repeat` number of items into random storage keys, and then times how
+	// long it takes to recalculate the storage root.
+	storage_root {
+		let z in 0 .. 10000;
+	}: {
+		for index in 0 .. z {
+			let random = (index).using_encoded(sp_io::hashing::blake2_256);
+			sp_io::storage::set(&random, &random);
+		}
+	}
+
+	// Custom implementation to handle benchmarking of calling a host function.
+	// Will check how long it takes to call `current_time()`.
+	current_time {
+		let z in 0 .. 1000;
+	}: {
+		for _ in 0 .. z {
+			let _ = frame_benchmarking::benchmarking::current_time();
+		}
+	}
+}