mirror of
https://github.com/pezkuwichain/pezkuwi-subxt.git
synced 2026-07-15 04:25:43 +00:00
Add Proof Size to Weight Output (#11637)
* initial impl * add template test * linear fit proof size * always record proof when tracking storage * calculate worst case pov * remove duplicate worst case * cargo run --quiet --profile=production --features=runtime-benchmarks --manifest-path=bin/node/cli/Cargo.toml -- benchmark pallet --chain=dev --steps=50 --repeat=20 --pallet=pallet_assets --extrinsic=* --execution=wasm --wasm-execution=compiled --heap-pages=4096 --output=./frame/assets/src/weights.rs --template=./.maintain/frame-weight-template.hbs * more comment output * add cli for worst case map size * update name * clap does not support underscores * rename * expose worst case map values * improve some comments * cargo run --quiet --profile=production --features=runtime-benchmarks --manifest-path=bin/node/cli/Cargo.toml -- benchmark pallet --chain=dev --steps=50 --repeat=20 --pallet=pallet_assets --extrinsic=* --execution=wasm --wasm-execution=compiled --heap-pages=4096 --output=./frame/assets/src/weights.rs --template=./.maintain/frame-weight-template.hbs * update template * cargo run --quiet --profile=production --features=runtime-benchmarks --manifest-path=bin/node/cli/Cargo.toml -- benchmark pallet --chain=dev --steps=50 --repeat=20 --pallet=pallet_assets --extrinsic=* --execution=wasm --wasm-execution=compiled --heap-pages=4096 --output=./frame/assets/src/weights.rs --template=./.maintain/frame-weight-template.hbs * fix fmt * more fmt * more fmt * Dont panic when there is no proof Signed-off-by: Oliver Tale-Yazdi <oliver.tale-yazdi@parity.io> * Fix test features Signed-off-by: Oliver Tale-Yazdi <oliver.tale-yazdi@parity.io> * Whitelist :extrinsic_index Signed-off-by: Oliver Tale-Yazdi <oliver.tale-yazdi@parity.io> * Use whitelist when recording proof Signed-off-by: Oliver Tale-Yazdi <oliver.tale-yazdi@parity.io> * Add logs Signed-off-by: Oliver Tale-Yazdi <oliver.tale-yazdi@parity.io> * Add PoV testing pallet Signed-off-by: Oliver Tale-Yazdi <oliver.tale-yazdi@parity.io> * Deploy PoV testing pallet Signed-off-by: Oliver Tale-Yazdi <oliver.tale-yazdi@parity.io> * Storage benches reside in the PoV pallet Signed-off-by: Oliver Tale-Yazdi <oliver.tale-yazdi@parity.io> * Linear regress PoV per component Splits the PoV calculation into "measured" and "estimated". The measured part is reported by the Proof recorder and linear regressed over all components at once. The estimated part is calculated as worst-case by using the max PoV size per storage access and calculating one linear regress per component. This gives each component a (possibly) independent PoV. For now the measured size will always be lower than the PoV on Polkadot since it is measured on an empty snapshot. The measured part is therefor only used as diagnostic for debugging. Signed-off-by: Oliver Tale-Yazdi <oliver.tale-yazdi@parity.io> * Put PoV into the weight templates Signed-off-by: Oliver Tale-Yazdi <oliver.tale-yazdi@parity.io> * fmt Signed-off-by: Oliver Tale-Yazdi <oliver.tale-yazdi@parity.io> * Extra alanysis choise for PoV Signed-off-by: Oliver Tale-Yazdi <oliver.tale-yazdi@parity.io> * Add+Fix tests Signed-off-by: Oliver Tale-Yazdi <oliver.tale-yazdi@parity.io> * Make benches faster Signed-off-by: Oliver Tale-Yazdi <oliver.tale-yazdi@parity.io> * Cleanup Signed-off-by: Oliver Tale-Yazdi <oliver.tale-yazdi@parity.io> * Use same template comments Signed-off-by: Oliver Tale-Yazdi <oliver.tale-yazdi@parity.io> * ".git/.scripts/bench-bot.sh" pallet dev pallet_balances * ".git/.scripts/bench-bot.sh" pallet dev pallet_democracy * Update referenda mock BlockWeights Signed-off-by: Oliver Tale-Yazdi <oliver.tale-yazdi@parity.io> * Take measured value size into account Signed-off-by: Oliver Tale-Yazdi <oliver.tale-yazdi@parity.io> * clippy Signed-off-by: Oliver Tale-Yazdi <oliver.tale-yazdi@parity.io> * ".git/.scripts/bench-bot.sh" pallet dev pallet_scheduler * WIP Signed-off-by: Oliver Tale-Yazdi <oliver.tale-yazdi@parity.io> * proof_size: None Signed-off-by: Oliver Tale-Yazdi <oliver.tale-yazdi@parity.io> * WIP Signed-off-by: Oliver Tale-Yazdi <oliver.tale-yazdi@parity.io> * WIP Signed-off-by: Oliver Tale-Yazdi <oliver.tale-yazdi@parity.io> * WIP Signed-off-by: Oliver Tale-Yazdi <oliver.tale-yazdi@parity.io> * ugly, but works Signed-off-by: Oliver Tale-Yazdi <oliver.tale-yazdi@parity.io> * WIP Signed-off-by: Oliver Tale-Yazdi <oliver.tale-yazdi@parity.io> * WIP Signed-off-by: Oliver Tale-Yazdi <oliver.tale-yazdi@parity.io> * WIP Signed-off-by: Oliver Tale-Yazdi <oliver.tale-yazdi@parity.io> * wup Signed-off-by: Oliver Tale-Yazdi <oliver.tale-yazdi@parity.io> * WIP Signed-off-by: Oliver Tale-Yazdi <oliver.tale-yazdi@parity.io> * WIP Signed-off-by: Oliver Tale-Yazdi <oliver.tale-yazdi@parity.io> * WIP Signed-off-by: Oliver Tale-Yazdi <oliver.tale-yazdi@parity.io> * WIP Signed-off-by: Oliver Tale-Yazdi <oliver.tale-yazdi@parity.io> * Add pov_mode attribute to the benchmarks! macro Signed-off-by: Oliver Tale-Yazdi <oliver.tale-yazdi@parity.io> * Use pov_mode attribute in PoV benchmarking Signed-off-by: Oliver Tale-Yazdi <oliver.tale-yazdi@parity.io> * Update tests Signed-off-by: Oliver Tale-Yazdi <oliver.tale-yazdi@parity.io> * Scheduler, Whitelist: Add pov_mode attr Signed-off-by: Oliver Tale-Yazdi <oliver.tale-yazdi@parity.io> * Update PoV weights * Add CLI arg: default-pov-mode Signed-off-by: Oliver Tale-Yazdi <oliver.tale-yazdi@parity.io> * Fix tests Signed-off-by: Oliver Tale-Yazdi <oliver.tale-yazdi@parity.io> * fmt Signed-off-by: Oliver Tale-Yazdi <oliver.tale-yazdi@parity.io> * fix Signed-off-by: Oliver Tale-Yazdi <oliver.tale-yazdi@parity.io> * Revert "Update PoV weights" This reverts commit 2f3ac2387396470b118122a6ff8fa4ee12216f4b. * Revert "WIP" This reverts commit c34b538cd2bc45da4544e887180184e30957904a. * Revert first approach This reverts commit range 8ddaa2fffe5930f225a30bee314d0b7c94c344dd^..4c84f8748e5395852a9e0e25b0404953fee1a59e Signed-off-by: Oliver Tale-Yazdi <oliver.tale-yazdi@parity.io> * Clippy Signed-off-by: Oliver Tale-Yazdi <oliver.tale-yazdi@parity.io> * Add extra benchmarks Signed-off-by: Oliver Tale-Yazdi <oliver.tale-yazdi@parity.io> * ".git/.scripts/commands/bench/bench.sh" pallet dev pallet_alliance * ".git/.scripts/commands/bench/bench.sh" pallet dev pallet_whitelist * ".git/.scripts/commands/bench/bench.sh" pallet dev pallet_scheduler * fmt Signed-off-by: Oliver Tale-Yazdi <oliver.tale-yazdi@parity.io> * Clippy Signed-off-by: Oliver Tale-Yazdi <oliver.tale-yazdi@parity.io> * Clippy 🤦 Signed-off-by: Oliver Tale-Yazdi <oliver.tale-yazdi@parity.io> * Add reference benchmarks Signed-off-by: Oliver Tale-Yazdi <oliver.tale-yazdi@parity.io> * Fix doc comments Signed-off-by: Oliver Tale-Yazdi <oliver.tale-yazdi@parity.io> * Undo logging Signed-off-by: Oliver Tale-Yazdi <oliver.tale-yazdi@parity.io> * Add 'Ignored' pov_mode Signed-off-by: Oliver Tale-Yazdi <oliver.tale-yazdi@parity.io> * Allow multiple attributes per benchmark Turns out that the current benchmarking syntax does not support multiple attributes per bench 🤦. Changing it to support that since otherwise the `pov_mode` would conflict with the others. Signed-off-by: Oliver Tale-Yazdi <oliver.tale-yazdi@parity.io> * Validate pov_mode syntax Signed-off-by: Oliver Tale-Yazdi <oliver.tale-yazdi@parity.io> * Ignore PoV for all contract benchmarks Signed-off-by: Oliver Tale-Yazdi <oliver.tale-yazdi@parity.io> * Test Signed-off-by: Oliver Tale-Yazdi <oliver.tale-yazdi@parity.io> * test Signed-off-by: Oliver Tale-Yazdi <oliver.tale-yazdi@parity.io> * Bump macro recursion limit Signed-off-by: Oliver Tale-Yazdi <oliver.tale-yazdi@parity.io> * fmt Signed-off-by: Oliver Tale-Yazdi <oliver.tale-yazdi@parity.io> * Update contract weights They dont have a PoV component anymore. Signed-off-by: Oliver Tale-Yazdi <oliver.tale-yazdi@parity.io> * fix test ffs Signed-off-by: Oliver Tale-Yazdi <oliver.tale-yazdi@parity.io> * pov_mode is unsupported in V2 syntax Signed-off-by: Oliver Tale-Yazdi <oliver.tale-yazdi@parity.io> * Fix pallet ui tests Signed-off-by: Oliver Tale-Yazdi <oliver.tale-yazdi@parity.io> * update pallet ui Signed-off-by: Oliver Tale-Yazdi <oliver.tale-yazdi@parity.io> * Fix pallet ui tests Signed-off-by: Oliver Tale-Yazdi <oliver.tale-yazdi@parity.io> * Update weights Signed-off-by: Oliver Tale-Yazdi <oliver.tale-yazdi@parity.io> Signed-off-by: Oliver Tale-Yazdi <oliver.tale-yazdi@parity.io> Co-authored-by: Parity Bot <admin@parity.io> Co-authored-by: Oliver Tale-Yazdi <oliver.tale-yazdi@parity.io> Co-authored-by: command-bot <> Co-authored-by: Your Name <you@example.com>
This commit is contained in:
Shawn Tabrizi
@@ -0,0 +1,211 @@
|
||||
// This file is part of Substrate.
|
||||
|
||||
// Copyright (C) 2022 Parity Technologies (UK) Ltd.
|
||||
// SPDX-License-Identifier: Apache-2.0
|
||||
|
||||
// Licensed under the Apache License, Version 2.0 (the "License");
|
||||
// you may not use this file except in compliance with the License.
|
||||
// You may obtain a copy of the License at
|
||||
//
|
||||
// http://www.apache.org/licenses/LICENSE-2.0
|
||||
//
|
||||
// Unless required by applicable law or agreed to in writing, software
|
||||
// distributed under the License is distributed on an "AS IS" BASIS,
|
||||
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
// See the License for the specific language governing permissions and
|
||||
// limitations under the License.
|
||||
|
||||
//! Test the produces weight functions.
|
||||
|
||||
#![cfg(test)]
|
||||
|
||||
use super::weights::WeightInfo;
|
||||
use mock::Test as T;
|
||||
type W = crate::weights::SubstrateWeight<T>;
|
||||
|
||||
#[test]
|
||||
fn writing_is_free() {
|
||||
let w = W::storage_single_value_write().proof_size();
|
||||
assert_eq!(w, 0, "Writing is free");
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn killing_is_free() {
|
||||
// NOTE: This only applies to state version 1.
|
||||
let w = W::storage_single_value_kill().proof_size();
|
||||
assert_eq!(w, 0, "Killing is free");
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn reading_twice_is_the_same_as_once() {
|
||||
let w = W::storage_single_value_read().proof_size();
|
||||
let w2 = W::storage_single_value_read_twice().proof_size();
|
||||
assert_eq!(w, w2, "Reading twice is the same as once");
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn storage_single_value_ignored_read_no_pov() {
|
||||
let w = W::storage_single_value_ignored_read();
|
||||
assert_eq!(w.proof_size(), 0, "Ignored PoV does not result in PoV");
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn storage_single_value_ignored_some_read_has_pov() {
|
||||
let w = W::storage_single_value_ignored_some_read();
|
||||
assert!(w.proof_size() != 0, "Ignored some does result in PoV");
|
||||
}
|
||||
|
||||
/// Reading the same value from a map does not increase the PoV.
|
||||
#[test]
|
||||
fn storage_1m_map_one_entry_repeated_read_const() {
|
||||
let weight = W::storage_1m_map_one_entry_repeated_read;
|
||||
let w0 = weight(0).proof_size();
|
||||
assert!(w0 > 0, "There is a base weight");
|
||||
|
||||
let w1 = weight(1).proof_size();
|
||||
assert_eq!(w0, w1, "Component does not matter");
|
||||
}
|
||||
|
||||
/// Reading multiple values multiple times from a map increases the PoV by the number of reads.
|
||||
#[test]
|
||||
fn storage_1m_map_multiple_entry_repeated_read_single_linear() {
|
||||
let weight = W::storage_1m_map_multiple_entry_repeated_read;
|
||||
let w0 = weight(0).proof_size();
|
||||
|
||||
let w1 = weight(1).proof_size() - w0;
|
||||
assert!(w1 > 0, "Component matters");
|
||||
|
||||
let wm = weight(1000).proof_size();
|
||||
assert_eq!(w1 * 1000 + w0, wm, "x scales linearly");
|
||||
}
|
||||
|
||||
/// Check that reading two maps at once increases the PoV linearly per map.
|
||||
#[test]
|
||||
fn storage_map_read_per_component_double_linear() {
|
||||
let weight = W::storage_map_read_per_component;
|
||||
let w00 = weight(0, 0).proof_size();
|
||||
|
||||
let w10 = weight(1, 0).proof_size() - w00;
|
||||
let w01 = weight(0, 1).proof_size() - w00;
|
||||
assert!(w10 > 0 && w01 > 0, "Components matter");
|
||||
assert!(w10 != w01, "Each map has its own component");
|
||||
|
||||
let wm0 = weight(1000, 0).proof_size();
|
||||
let w0m = weight(0, 1000).proof_size();
|
||||
assert_eq!(w00 + w10 * 1000, wm0, "x scales linearly");
|
||||
assert_eq!(w00 + w01 * 1000, w0m, "y scales linearly");
|
||||
|
||||
let wmm = weight(1000, 1000).proof_size();
|
||||
assert_eq!(wmm + w00, wm0 + w0m, "x + y scales linearly");
|
||||
}
|
||||
|
||||
/// The proof size estimation takes the measured sizes into account and therefore increases with the
|
||||
/// number of layers.
|
||||
#[test]
|
||||
fn additional_layers_do_not_matter() {
|
||||
let w2 = W::storage_1m_map_read_one_value_two_additional_layers().proof_size();
|
||||
let w3 = W::storage_1m_map_read_one_value_three_additional_layers().proof_size();
|
||||
let w4 = W::storage_1m_map_read_one_value_four_additional_layers().proof_size();
|
||||
assert!(w3 > w2 && w4 > w3, "Additional layers do matter");
|
||||
}
|
||||
|
||||
/// Check that the measured value size instead of the MEL is used.
|
||||
#[test]
|
||||
fn linear_measured_size_works() {
|
||||
let weight = W::measured_storage_value_read_linear_size;
|
||||
|
||||
let w0 = weight(0).proof_size();
|
||||
let w1 = weight(1).proof_size() - w0;
|
||||
|
||||
assert_eq!(w1, 1, "x scales with a factor of 1");
|
||||
let wm = weight(1000).proof_size();
|
||||
assert_eq!(w1 * 1000 + w0, wm, "x scales linearly");
|
||||
}
|
||||
|
||||
// vice-versa of above `linear_measured_size_works`.
|
||||
#[test]
|
||||
fn linear_mel_size_works() {
|
||||
let weight = W::mel_storage_value_read_linear_size;
|
||||
|
||||
let w1 = weight(1).proof_size();
|
||||
let wm = weight(1000).proof_size();
|
||||
assert_eq!(w1, wm, "PoV size is const");
|
||||
}
|
||||
|
||||
/// Although there is no estimation possible, it uses the recorded proof size as best effort.
|
||||
#[test]
|
||||
fn unbounded_read_best_effort() {
|
||||
let w = W::storage_value_unbounded_read().proof_size();
|
||||
assert!(w > 0, "There is a weight");
|
||||
}
|
||||
|
||||
/// For mixed unbounded and bounded reads, the bounded part still increases the PoV.
|
||||
#[test]
|
||||
fn partial_unbounded_read_best_effort() {
|
||||
let w_unbounded = W::storage_value_unbounded_read().proof_size();
|
||||
let w_bounded = W::storage_value_bounded_read().proof_size();
|
||||
let w_partial = W::storage_value_bounded_and_unbounded_read().proof_size();
|
||||
|
||||
assert_eq!(w_bounded + w_unbounded, w_partial, "The bounded part increases the PoV");
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn emit_event_is_free() {
|
||||
let w = W::emit_event().proof_size();
|
||||
assert_eq!(w, 0, "Emitting an event is free");
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn noop_is_free() {
|
||||
let w = W::noop().proof_size();
|
||||
assert_eq!(w, 0, "Noop is free");
|
||||
}
|
||||
|
||||
mod mock {
|
||||
use sp_runtime::testing::H256;
|
||||
|
||||
type UncheckedExtrinsic = frame_system::mocking::MockUncheckedExtrinsic<Test>;
|
||||
type Block = frame_system::mocking::MockBlock<Test>;
|
||||
|
||||
frame_support::construct_runtime!(
|
||||
pub enum Test where
|
||||
Block = Block,
|
||||
NodeBlock = Block,
|
||||
UncheckedExtrinsic = UncheckedExtrinsic,
|
||||
{
|
||||
System: frame_system::{Pallet, Call, Config, Storage, Event<T>},
|
||||
Baseline: crate::{Pallet, Call, Storage, Event<T>},
|
||||
}
|
||||
);
|
||||
|
||||
impl frame_system::Config for Test {
|
||||
type BaseCallFilter = frame_support::traits::Everything;
|
||||
type BlockWeights = ();
|
||||
type BlockLength = ();
|
||||
type DbWeight = ();
|
||||
type RuntimeOrigin = RuntimeOrigin;
|
||||
type Index = u32;
|
||||
type BlockNumber = u64;
|
||||
type RuntimeCall = RuntimeCall;
|
||||
type Hash = H256;
|
||||
type Hashing = ::sp_runtime::traits::BlakeTwo256;
|
||||
type AccountId = u32;
|
||||
type Lookup = sp_runtime::traits::IdentityLookup<Self::AccountId>;
|
||||
type Header = sp_runtime::testing::Header;
|
||||
type RuntimeEvent = RuntimeEvent;
|
||||
type BlockHashCount = ();
|
||||
type Version = ();
|
||||
type PalletInfo = PalletInfo;
|
||||
type AccountData = ();
|
||||
type OnNewAccount = ();
|
||||
type OnKilledAccount = ();
|
||||
type SystemWeightInfo = ();
|
||||
type SS58Prefix = ();
|
||||
type OnSetCode = ();
|
||||
type MaxConsumers = frame_support::traits::ConstU32<16>;
|
||||
}
|
||||
|
||||
impl crate::Config for Test {
|
||||
type RuntimeEvent = RuntimeEvent;
|
||||
}
|
||||
}
|
||||
Reference in New Issue
Block a user