mirror of
https://github.com/pezkuwichain/pezkuwi-subxt.git
synced 2026-05-30 17:31:03 +00:00
PoV Reclaim Runtime Side (#3002)
# Runtime side for PoV Reclaim ## Implementation Overview - Hostfunction to fetch the storage proof size has been added to the PVF. It uses the size tracking recorder that was introduced in my previous PR. - Mechanisms to use the reclaim HostFunction have been introduced. - 1. A SignedExtension that checks the node-reported proof size before and after application of an extrinsic. Then it reclaims the difference. - 2. A manual helper to make reclaiming easier when manual interaction is required, for example in `on_idle` or other hooks. - In order to utilize the manual reclaiming, I modified `WeightMeter` to support the reduction of consumed weight, at least for storage proof size. ## How to use To enable the general functionality for a parachain: 1. Add the SignedExtension to your parachain runtime. 2. Provide the HostFunction to the node 3. Enable proof recording during block import ## TODO - [x] PRDoc --------- Co-authored-by: Dmitry Markin <dmitry@markin.tech> Co-authored-by: Davide Galassi <davxy@datawok.net> Co-authored-by: Bastian Köcher <git@kchr.de>
This commit is contained in:
@@ -0,0 +1,46 @@
|
||||
[package]
|
||||
name = "cumulus-primitives-storage-weight-reclaim"
|
||||
version = "1.0.0"
|
||||
authors.workspace = true
|
||||
edition.workspace = true
|
||||
description = "Utilities to reclaim storage weight."
|
||||
license = "Apache-2.0"
|
||||
|
||||
[lints]
|
||||
workspace = true
|
||||
|
||||
[dependencies]
|
||||
codec = { package = "parity-scale-codec", version = "3.0.0", default-features = false, features = ["derive"] }
|
||||
log = { workspace = true }
|
||||
scale-info = { version = "2.10.0", default-features = false, features = ["derive"] }
|
||||
|
||||
frame-support = { path = "../../../substrate/frame/support", default-features = false }
|
||||
frame-system = { path = "../../../substrate/frame/system", default-features = false }
|
||||
|
||||
sp-runtime = { path = "../../../substrate/primitives/runtime", default-features = false }
|
||||
sp-std = { path = "../../../substrate/primitives/std", default-features = false }
|
||||
|
||||
cumulus-primitives-core = { path = "../../primitives/core", default-features = false }
|
||||
cumulus-primitives-proof-size-hostfunction = { path = "../../primitives/proof-size-hostfunction", default-features = false }
|
||||
docify = "0.2.7"
|
||||
|
||||
[dev-dependencies]
|
||||
sp-trie = { path = "../../../substrate/primitives/trie", default-features = false }
|
||||
sp-io = { path = "../../../substrate/primitives/io", default-features = false }
|
||||
cumulus-test-runtime = { path = "../../test/runtime" }
|
||||
|
||||
[features]
|
||||
default = ["std"]
|
||||
std = [
|
||||
"codec/std",
|
||||
"cumulus-primitives-core/std",
|
||||
"cumulus-primitives-proof-size-hostfunction/std",
|
||||
"frame-support/std",
|
||||
"frame-system/std",
|
||||
"log/std",
|
||||
"scale-info/std",
|
||||
"sp-io/std",
|
||||
"sp-runtime/std",
|
||||
"sp-std/std",
|
||||
"sp-trie/std",
|
||||
]
|
||||
@@ -0,0 +1,663 @@
|
||||
// Copyright (C) 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.
|
||||
|
||||
//! Mechanism to reclaim PoV proof size weight after an extrinsic has been applied.
|
||||
|
||||
#![cfg_attr(not(feature = "std"), no_std)]
|
||||
|
||||
use codec::{Decode, Encode};
|
||||
use cumulus_primitives_core::Weight;
|
||||
use cumulus_primitives_proof_size_hostfunction::{
|
||||
storage_proof_size::storage_proof_size, PROOF_RECORDING_DISABLED,
|
||||
};
|
||||
use frame_support::{
|
||||
dispatch::{DispatchInfo, PostDispatchInfo},
|
||||
weights::WeightMeter,
|
||||
};
|
||||
use frame_system::Config;
|
||||
use scale_info::TypeInfo;
|
||||
use sp_runtime::{
|
||||
traits::{DispatchInfoOf, Dispatchable, PostDispatchInfoOf, SignedExtension},
|
||||
transaction_validity::TransactionValidityError,
|
||||
DispatchResult,
|
||||
};
|
||||
use sp_std::marker::PhantomData;
|
||||
|
||||
const LOG_TARGET: &'static str = "runtime::storage_reclaim";
|
||||
|
||||
/// `StorageWeightReclaimer` is a mechanism for manually reclaiming storage weight.
|
||||
///
|
||||
/// It internally keeps track of the proof size and storage weight at initialization time. At
|
||||
/// reclaim it computes the real consumed storage weight and refunds excess weight.
|
||||
///
|
||||
/// # Example
|
||||
#[doc = docify::embed!("src/lib.rs", simple_reclaimer_example)]
|
||||
pub struct StorageWeightReclaimer {
|
||||
previous_remaining_proof_size: u64,
|
||||
previous_reported_proof_size: Option<u64>,
|
||||
}
|
||||
|
||||
impl StorageWeightReclaimer {
|
||||
/// Creates a new `StorageWeightReclaimer` instance and initializes it with the storage
|
||||
/// size provided by `weight_meter` and reported proof size from the node.
|
||||
#[must_use = "Must call `reclaim_with_meter` to reclaim the weight"]
|
||||
pub fn new(weight_meter: &WeightMeter) -> StorageWeightReclaimer {
|
||||
let previous_remaining_proof_size = weight_meter.remaining().proof_size();
|
||||
let previous_reported_proof_size = get_proof_size();
|
||||
Self { previous_remaining_proof_size, previous_reported_proof_size }
|
||||
}
|
||||
|
||||
/// Check the consumed storage weight and calculate the consumed excess weight.
|
||||
fn reclaim(&mut self, remaining_weight: Weight) -> Option<Weight> {
|
||||
let current_remaining_weight = remaining_weight.proof_size();
|
||||
let current_storage_proof_size = get_proof_size()?;
|
||||
let previous_storage_proof_size = self.previous_reported_proof_size?;
|
||||
let used_weight =
|
||||
self.previous_remaining_proof_size.saturating_sub(current_remaining_weight);
|
||||
let reported_used_size =
|
||||
current_storage_proof_size.saturating_sub(previous_storage_proof_size);
|
||||
let reclaimable = used_weight.saturating_sub(reported_used_size);
|
||||
log::trace!(
|
||||
target: LOG_TARGET,
|
||||
"Found reclaimable storage weight. benchmarked: {used_weight}, consumed: {reported_used_size}"
|
||||
);
|
||||
|
||||
self.previous_remaining_proof_size = current_remaining_weight.saturating_add(reclaimable);
|
||||
self.previous_reported_proof_size = Some(current_storage_proof_size);
|
||||
Some(Weight::from_parts(0, reclaimable))
|
||||
}
|
||||
|
||||
/// Check the consumed storage weight and add the reclaimed
|
||||
/// weight budget back to `weight_meter`.
|
||||
pub fn reclaim_with_meter(&mut self, weight_meter: &mut WeightMeter) -> Option<Weight> {
|
||||
let reclaimed = self.reclaim(weight_meter.remaining())?;
|
||||
weight_meter.reclaim_proof_size(reclaimed.proof_size());
|
||||
Some(reclaimed)
|
||||
}
|
||||
}
|
||||
|
||||
/// Returns the current storage proof size from the host side.
|
||||
///
|
||||
/// Returns `None` if proof recording is disabled on the host.
|
||||
pub fn get_proof_size() -> Option<u64> {
|
||||
let proof_size = storage_proof_size();
|
||||
(proof_size != PROOF_RECORDING_DISABLED).then_some(proof_size)
|
||||
}
|
||||
|
||||
/// Storage weight reclaim mechanism.
|
||||
///
|
||||
/// This extension checks the size of the node-side storage proof
|
||||
/// before and after executing a given extrinsic. The difference between
|
||||
/// benchmarked and spent weight can be reclaimed.
|
||||
#[derive(Encode, Decode, Clone, Eq, PartialEq, Default, TypeInfo)]
|
||||
#[scale_info(skip_type_params(T))]
|
||||
pub struct StorageWeightReclaim<T: Config + Send + Sync>(PhantomData<T>);
|
||||
|
||||
impl<T: Config + Send + Sync> StorageWeightReclaim<T> {
|
||||
/// Create a new `StorageWeightReclaim` instance.
|
||||
pub fn new() -> Self {
|
||||
Self(Default::default())
|
||||
}
|
||||
}
|
||||
|
||||
impl<T: Config + Send + Sync> core::fmt::Debug for StorageWeightReclaim<T> {
|
||||
fn fmt(&self, f: &mut core::fmt::Formatter<'_>) -> Result<(), core::fmt::Error> {
|
||||
let _ = write!(f, "StorageWeightReclaim");
|
||||
Ok(())
|
||||
}
|
||||
}
|
||||
|
||||
impl<T: Config + Send + Sync> SignedExtension for StorageWeightReclaim<T>
|
||||
where
|
||||
T::RuntimeCall: Dispatchable<Info = DispatchInfo, PostInfo = PostDispatchInfo>,
|
||||
{
|
||||
const IDENTIFIER: &'static str = "StorageWeightReclaim";
|
||||
|
||||
type AccountId = T::AccountId;
|
||||
type Call = T::RuntimeCall;
|
||||
type AdditionalSigned = ();
|
||||
type Pre = Option<u64>;
|
||||
|
||||
fn additional_signed(
|
||||
&self,
|
||||
) -> Result<Self::AdditionalSigned, sp_runtime::transaction_validity::TransactionValidityError>
|
||||
{
|
||||
Ok(())
|
||||
}
|
||||
|
||||
fn pre_dispatch(
|
||||
self,
|
||||
_who: &Self::AccountId,
|
||||
_call: &Self::Call,
|
||||
_info: &sp_runtime::traits::DispatchInfoOf<Self::Call>,
|
||||
_len: usize,
|
||||
) -> Result<Self::Pre, sp_runtime::transaction_validity::TransactionValidityError> {
|
||||
Ok(get_proof_size())
|
||||
}
|
||||
|
||||
fn post_dispatch(
|
||||
pre: Option<Self::Pre>,
|
||||
info: &DispatchInfoOf<Self::Call>,
|
||||
post_info: &PostDispatchInfoOf<Self::Call>,
|
||||
_len: usize,
|
||||
_result: &DispatchResult,
|
||||
) -> Result<(), TransactionValidityError> {
|
||||
let Some(Some(pre_dispatch_proof_size)) = pre else {
|
||||
return Ok(());
|
||||
};
|
||||
|
||||
let Some(post_dispatch_proof_size) = get_proof_size() else {
|
||||
log::debug!(
|
||||
target: LOG_TARGET,
|
||||
"Proof recording enabled during pre-dispatch, now disabled. This should not happen."
|
||||
);
|
||||
return Ok(())
|
||||
};
|
||||
let benchmarked_weight = info.weight.proof_size();
|
||||
let consumed_weight = post_dispatch_proof_size.saturating_sub(pre_dispatch_proof_size);
|
||||
|
||||
// Unspent weight according to the `actual_weight` from `PostDispatchInfo`
|
||||
// This unspent weight will be refunded by the `CheckWeight` extension, so we need to
|
||||
// account for that.
|
||||
let unspent = post_info.calc_unspent(info).proof_size();
|
||||
let storage_size_diff =
|
||||
benchmarked_weight.saturating_sub(unspent).abs_diff(consumed_weight as u64);
|
||||
|
||||
// This value will be reclaimed by [`frame_system::CheckWeight`], so we need to calculate
|
||||
// that in.
|
||||
frame_system::BlockWeight::<T>::mutate(|current| {
|
||||
if consumed_weight > benchmarked_weight {
|
||||
log::error!(
|
||||
target: LOG_TARGET,
|
||||
"Benchmarked storage weight smaller than consumed storage weight. benchmarked: {benchmarked_weight} consumed: {consumed_weight} unspent: {unspent}"
|
||||
);
|
||||
current.accrue(Weight::from_parts(0, storage_size_diff), info.class)
|
||||
} else {
|
||||
log::trace!(
|
||||
target: LOG_TARGET,
|
||||
"Reclaiming storage weight. benchmarked: {benchmarked_weight}, consumed: {consumed_weight} unspent: {unspent}"
|
||||
);
|
||||
current.reduce(Weight::from_parts(0, storage_size_diff), info.class)
|
||||
}
|
||||
});
|
||||
Ok(())
|
||||
}
|
||||
}
|
||||
|
||||
#[cfg(test)]
|
||||
mod tests {
|
||||
use super::*;
|
||||
use frame_support::{
|
||||
assert_ok,
|
||||
dispatch::DispatchClass,
|
||||
weights::{Weight, WeightMeter},
|
||||
};
|
||||
use frame_system::{BlockWeight, CheckWeight};
|
||||
use sp_runtime::{AccountId32, BuildStorage};
|
||||
use sp_std::marker::PhantomData;
|
||||
use sp_trie::proof_size_extension::ProofSizeExt;
|
||||
|
||||
type Test = cumulus_test_runtime::Runtime;
|
||||
const CALL: &<Test as Config>::RuntimeCall =
|
||||
&cumulus_test_runtime::RuntimeCall::System(frame_system::Call::set_heap_pages {
|
||||
pages: 0u64,
|
||||
});
|
||||
const ALICE: AccountId32 = AccountId32::new([1u8; 32]);
|
||||
const LEN: usize = 0;
|
||||
|
||||
pub fn new_test_ext() -> sp_io::TestExternalities {
|
||||
let ext: sp_io::TestExternalities = cumulus_test_runtime::RuntimeGenesisConfig::default()
|
||||
.build_storage()
|
||||
.unwrap()
|
||||
.into();
|
||||
ext
|
||||
}
|
||||
|
||||
struct TestRecorder {
|
||||
return_values: Box<[usize]>,
|
||||
counter: std::sync::atomic::AtomicUsize,
|
||||
}
|
||||
|
||||
impl TestRecorder {
|
||||
fn new(values: &[usize]) -> Self {
|
||||
TestRecorder { return_values: values.into(), counter: Default::default() }
|
||||
}
|
||||
}
|
||||
|
||||
impl sp_trie::ProofSizeProvider for TestRecorder {
|
||||
fn estimate_encoded_size(&self) -> usize {
|
||||
let counter = self.counter.fetch_add(1, core::sync::atomic::Ordering::Relaxed);
|
||||
self.return_values[counter]
|
||||
}
|
||||
}
|
||||
|
||||
fn setup_test_externalities(proof_values: &[usize]) -> sp_io::TestExternalities {
|
||||
let mut test_ext = new_test_ext();
|
||||
let test_recorder = TestRecorder::new(proof_values);
|
||||
test_ext.register_extension(ProofSizeExt::new(test_recorder));
|
||||
test_ext
|
||||
}
|
||||
|
||||
fn set_current_storage_weight(new_weight: u64) {
|
||||
BlockWeight::<Test>::mutate(|current_weight| {
|
||||
current_weight.set(Weight::from_parts(0, new_weight), DispatchClass::Normal);
|
||||
});
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn basic_refund() {
|
||||
// The real cost will be 100 bytes of storage size
|
||||
let mut test_ext = setup_test_externalities(&[0, 100]);
|
||||
|
||||
test_ext.execute_with(|| {
|
||||
set_current_storage_weight(1000);
|
||||
|
||||
// Benchmarked storage weight: 500
|
||||
let info = DispatchInfo { weight: Weight::from_parts(0, 500), ..Default::default() };
|
||||
let post_info = PostDispatchInfo::default();
|
||||
|
||||
let pre = StorageWeightReclaim::<Test>(PhantomData)
|
||||
.pre_dispatch(&ALICE, CALL, &info, LEN)
|
||||
.unwrap();
|
||||
assert_eq!(pre, Some(0));
|
||||
|
||||
assert_ok!(CheckWeight::<Test>::post_dispatch(None, &info, &post_info, 0, &Ok(())));
|
||||
// We expect a refund of 400
|
||||
assert_ok!(StorageWeightReclaim::<Test>::post_dispatch(
|
||||
Some(pre),
|
||||
&info,
|
||||
&post_info,
|
||||
LEN,
|
||||
&Ok(())
|
||||
));
|
||||
|
||||
assert_eq!(BlockWeight::<Test>::get().total().proof_size(), 600);
|
||||
})
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn does_nothing_without_extension() {
|
||||
let mut test_ext = new_test_ext();
|
||||
|
||||
// Proof size extension not registered
|
||||
test_ext.execute_with(|| {
|
||||
set_current_storage_weight(1000);
|
||||
|
||||
// Benchmarked storage weight: 500
|
||||
let info = DispatchInfo { weight: Weight::from_parts(0, 500), ..Default::default() };
|
||||
let post_info = PostDispatchInfo::default();
|
||||
|
||||
let pre = StorageWeightReclaim::<Test>(PhantomData)
|
||||
.pre_dispatch(&ALICE, CALL, &info, LEN)
|
||||
.unwrap();
|
||||
assert_eq!(pre, None);
|
||||
|
||||
assert_ok!(CheckWeight::<Test>::post_dispatch(None, &info, &post_info, 0, &Ok(())));
|
||||
assert_ok!(StorageWeightReclaim::<Test>::post_dispatch(
|
||||
Some(pre),
|
||||
&info,
|
||||
&post_info,
|
||||
LEN,
|
||||
&Ok(())
|
||||
));
|
||||
|
||||
assert_eq!(BlockWeight::<Test>::get().total().proof_size(), 1000);
|
||||
})
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn negative_refund_is_added_to_weight() {
|
||||
let mut test_ext = setup_test_externalities(&[100, 300]);
|
||||
|
||||
test_ext.execute_with(|| {
|
||||
set_current_storage_weight(1000);
|
||||
// Benchmarked storage weight: 100
|
||||
let info = DispatchInfo { weight: Weight::from_parts(0, 100), ..Default::default() };
|
||||
let post_info = PostDispatchInfo::default();
|
||||
|
||||
let pre = StorageWeightReclaim::<Test>(PhantomData)
|
||||
.pre_dispatch(&ALICE, CALL, &info, LEN)
|
||||
.unwrap();
|
||||
assert_eq!(pre, Some(100));
|
||||
|
||||
// We expect no refund
|
||||
assert_ok!(CheckWeight::<Test>::post_dispatch(None, &info, &post_info, 0, &Ok(())));
|
||||
assert_ok!(StorageWeightReclaim::<Test>::post_dispatch(
|
||||
Some(pre),
|
||||
&info,
|
||||
&post_info,
|
||||
LEN,
|
||||
&Ok(())
|
||||
));
|
||||
|
||||
assert_eq!(BlockWeight::<Test>::get().total().proof_size(), 1100);
|
||||
})
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn test_zero_proof_size() {
|
||||
let mut test_ext = setup_test_externalities(&[0, 0]);
|
||||
|
||||
test_ext.execute_with(|| {
|
||||
let info = DispatchInfo { weight: Weight::from_parts(0, 500), ..Default::default() };
|
||||
let post_info = PostDispatchInfo::default();
|
||||
|
||||
let pre = StorageWeightReclaim::<Test>(PhantomData)
|
||||
.pre_dispatch(&ALICE, CALL, &info, LEN)
|
||||
.unwrap();
|
||||
assert_eq!(pre, Some(0));
|
||||
|
||||
assert_ok!(CheckWeight::<Test>::post_dispatch(None, &info, &post_info, 0, &Ok(())));
|
||||
assert_ok!(StorageWeightReclaim::<Test>::post_dispatch(
|
||||
Some(pre),
|
||||
&info,
|
||||
&post_info,
|
||||
LEN,
|
||||
&Ok(())
|
||||
));
|
||||
|
||||
assert_eq!(BlockWeight::<Test>::get().total().proof_size(), 0);
|
||||
});
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn test_larger_pre_dispatch_proof_size() {
|
||||
let mut test_ext = setup_test_externalities(&[300, 100]);
|
||||
|
||||
test_ext.execute_with(|| {
|
||||
set_current_storage_weight(1300);
|
||||
|
||||
let info = DispatchInfo { weight: Weight::from_parts(0, 500), ..Default::default() };
|
||||
let post_info = PostDispatchInfo::default();
|
||||
|
||||
let pre = StorageWeightReclaim::<Test>(PhantomData)
|
||||
.pre_dispatch(&ALICE, CALL, &info, LEN)
|
||||
.unwrap();
|
||||
assert_eq!(pre, Some(300));
|
||||
|
||||
assert_ok!(CheckWeight::<Test>::post_dispatch(None, &info, &post_info, 0, &Ok(())));
|
||||
assert_ok!(StorageWeightReclaim::<Test>::post_dispatch(
|
||||
Some(pre),
|
||||
&info,
|
||||
&post_info,
|
||||
LEN,
|
||||
&Ok(())
|
||||
));
|
||||
|
||||
assert_eq!(BlockWeight::<Test>::get().total().proof_size(), 800);
|
||||
});
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn test_incorporates_check_weight_unspent_weight() {
|
||||
let mut test_ext = setup_test_externalities(&[100, 300]);
|
||||
|
||||
test_ext.execute_with(|| {
|
||||
set_current_storage_weight(1000);
|
||||
|
||||
// Benchmarked storage weight: 300
|
||||
let info = DispatchInfo { weight: Weight::from_parts(100, 300), ..Default::default() };
|
||||
|
||||
// Actual weight is 50
|
||||
let post_info = PostDispatchInfo {
|
||||
actual_weight: Some(Weight::from_parts(50, 250)),
|
||||
pays_fee: Default::default(),
|
||||
};
|
||||
|
||||
let pre = StorageWeightReclaim::<Test>(PhantomData)
|
||||
.pre_dispatch(&ALICE, CALL, &info, LEN)
|
||||
.unwrap();
|
||||
assert_eq!(pre, Some(100));
|
||||
|
||||
// The `CheckWeight` extension will refunt `actual_weight` from `PostDispatchInfo`
|
||||
// we always need to call `post_dispatch` to verify that they interoperate correctly.
|
||||
assert_ok!(CheckWeight::<Test>::post_dispatch(None, &info, &post_info, 0, &Ok(())));
|
||||
assert_ok!(StorageWeightReclaim::<Test>::post_dispatch(
|
||||
Some(pre),
|
||||
&info,
|
||||
&post_info,
|
||||
LEN,
|
||||
&Ok(())
|
||||
));
|
||||
|
||||
assert_eq!(BlockWeight::<Test>::get().total().proof_size(), 900);
|
||||
})
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn test_incorporates_check_weight_unspent_weight_on_negative() {
|
||||
let mut test_ext = setup_test_externalities(&[100, 300]);
|
||||
|
||||
test_ext.execute_with(|| {
|
||||
set_current_storage_weight(1000);
|
||||
// Benchmarked storage weight: 50
|
||||
let info = DispatchInfo { weight: Weight::from_parts(100, 50), ..Default::default() };
|
||||
|
||||
// Actual weight is 25
|
||||
let post_info = PostDispatchInfo {
|
||||
actual_weight: Some(Weight::from_parts(50, 25)),
|
||||
pays_fee: Default::default(),
|
||||
};
|
||||
|
||||
let pre = StorageWeightReclaim::<Test>(PhantomData)
|
||||
.pre_dispatch(&ALICE, CALL, &info, LEN)
|
||||
.unwrap();
|
||||
assert_eq!(pre, Some(100));
|
||||
|
||||
// The `CheckWeight` extension will refunt `actual_weight` from `PostDispatchInfo`
|
||||
// we always need to call `post_dispatch` to verify that they interoperate correctly.
|
||||
assert_ok!(CheckWeight::<Test>::post_dispatch(None, &info, &post_info, 0, &Ok(())));
|
||||
assert_ok!(StorageWeightReclaim::<Test>::post_dispatch(
|
||||
Some(pre),
|
||||
&info,
|
||||
&post_info,
|
||||
LEN,
|
||||
&Ok(())
|
||||
));
|
||||
|
||||
assert_eq!(BlockWeight::<Test>::get().total().proof_size(), 1150);
|
||||
})
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn test_incorporates_check_weight_unspent_weight_reverse_order() {
|
||||
let mut test_ext = setup_test_externalities(&[100, 300]);
|
||||
|
||||
test_ext.execute_with(|| {
|
||||
set_current_storage_weight(1000);
|
||||
|
||||
// Benchmarked storage weight: 300
|
||||
let info = DispatchInfo { weight: Weight::from_parts(100, 300), ..Default::default() };
|
||||
|
||||
// Actual weight is 50
|
||||
let post_info = PostDispatchInfo {
|
||||
actual_weight: Some(Weight::from_parts(50, 250)),
|
||||
pays_fee: Default::default(),
|
||||
};
|
||||
|
||||
let pre = StorageWeightReclaim::<Test>(PhantomData)
|
||||
.pre_dispatch(&ALICE, CALL, &info, LEN)
|
||||
.unwrap();
|
||||
assert_eq!(pre, Some(100));
|
||||
|
||||
assert_ok!(StorageWeightReclaim::<Test>::post_dispatch(
|
||||
Some(pre),
|
||||
&info,
|
||||
&post_info,
|
||||
LEN,
|
||||
&Ok(())
|
||||
));
|
||||
// `CheckWeight` gets called after `StorageWeightReclaim` this time.
|
||||
// The `CheckWeight` extension will refunt `actual_weight` from `PostDispatchInfo`
|
||||
// we always need to call `post_dispatch` to verify that they interoperate correctly.
|
||||
assert_ok!(CheckWeight::<Test>::post_dispatch(None, &info, &post_info, 0, &Ok(())));
|
||||
|
||||
assert_eq!(BlockWeight::<Test>::get().total().proof_size(), 900);
|
||||
})
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn test_incorporates_check_weight_unspent_weight_on_negative_reverse_order() {
|
||||
let mut test_ext = setup_test_externalities(&[100, 300]);
|
||||
|
||||
test_ext.execute_with(|| {
|
||||
set_current_storage_weight(1000);
|
||||
// Benchmarked storage weight: 50
|
||||
let info = DispatchInfo { weight: Weight::from_parts(100, 50), ..Default::default() };
|
||||
|
||||
// Actual weight is 25
|
||||
let post_info = PostDispatchInfo {
|
||||
actual_weight: Some(Weight::from_parts(50, 25)),
|
||||
pays_fee: Default::default(),
|
||||
};
|
||||
|
||||
let pre = StorageWeightReclaim::<Test>(PhantomData)
|
||||
.pre_dispatch(&ALICE, CALL, &info, LEN)
|
||||
.unwrap();
|
||||
assert_eq!(pre, Some(100));
|
||||
|
||||
assert_ok!(StorageWeightReclaim::<Test>::post_dispatch(
|
||||
Some(pre),
|
||||
&info,
|
||||
&post_info,
|
||||
LEN,
|
||||
&Ok(())
|
||||
));
|
||||
// `CheckWeight` gets called after `StorageWeightReclaim` this time.
|
||||
// The `CheckWeight` extension will refunt `actual_weight` from `PostDispatchInfo`
|
||||
// we always need to call `post_dispatch` to verify that they interoperate correctly.
|
||||
assert_ok!(CheckWeight::<Test>::post_dispatch(None, &info, &post_info, 0, &Ok(())));
|
||||
|
||||
assert_eq!(BlockWeight::<Test>::get().total().proof_size(), 1150);
|
||||
})
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn storage_size_reported_correctly() {
|
||||
let mut test_ext = setup_test_externalities(&[1000]);
|
||||
test_ext.execute_with(|| {
|
||||
assert_eq!(get_proof_size(), Some(1000));
|
||||
});
|
||||
|
||||
let mut test_ext = new_test_ext();
|
||||
|
||||
let test_recorder = TestRecorder::new(&[0]);
|
||||
|
||||
test_ext.register_extension(ProofSizeExt::new(test_recorder));
|
||||
|
||||
test_ext.execute_with(|| {
|
||||
assert_eq!(get_proof_size(), Some(0));
|
||||
});
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn storage_size_disabled_reported_correctly() {
|
||||
let mut test_ext = setup_test_externalities(&[PROOF_RECORDING_DISABLED as usize]);
|
||||
|
||||
test_ext.execute_with(|| {
|
||||
assert_eq!(get_proof_size(), None);
|
||||
});
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn test_reclaim_helper() {
|
||||
let mut test_ext = setup_test_externalities(&[1000, 1300, 1800]);
|
||||
|
||||
test_ext.execute_with(|| {
|
||||
let mut remaining_weight_meter = WeightMeter::with_limit(Weight::from_parts(0, 2000));
|
||||
let mut reclaim_helper = StorageWeightReclaimer::new(&remaining_weight_meter);
|
||||
remaining_weight_meter.consume(Weight::from_parts(0, 500));
|
||||
let reclaimed = reclaim_helper.reclaim_with_meter(&mut remaining_weight_meter);
|
||||
|
||||
assert_eq!(reclaimed, Some(Weight::from_parts(0, 200)));
|
||||
|
||||
remaining_weight_meter.consume(Weight::from_parts(0, 800));
|
||||
let reclaimed = reclaim_helper.reclaim_with_meter(&mut remaining_weight_meter);
|
||||
assert_eq!(reclaimed, Some(Weight::from_parts(0, 300)));
|
||||
assert_eq!(remaining_weight_meter.remaining(), Weight::from_parts(0, 1200));
|
||||
});
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn test_reclaim_helper_does_not_reclaim_negative() {
|
||||
// Benchmarked weight does not change at all
|
||||
let mut test_ext = setup_test_externalities(&[1000, 1300]);
|
||||
|
||||
test_ext.execute_with(|| {
|
||||
let mut remaining_weight_meter = WeightMeter::with_limit(Weight::from_parts(0, 1000));
|
||||
let mut reclaim_helper = StorageWeightReclaimer::new(&remaining_weight_meter);
|
||||
let reclaimed = reclaim_helper.reclaim_with_meter(&mut remaining_weight_meter);
|
||||
|
||||
assert_eq!(reclaimed, Some(Weight::from_parts(0, 0)));
|
||||
assert_eq!(remaining_weight_meter.remaining(), Weight::from_parts(0, 1000));
|
||||
});
|
||||
|
||||
// Benchmarked weight increases less than storage proof consumes
|
||||
let mut test_ext = setup_test_externalities(&[1000, 1300]);
|
||||
|
||||
test_ext.execute_with(|| {
|
||||
let mut remaining_weight_meter = WeightMeter::with_limit(Weight::from_parts(0, 1000));
|
||||
let mut reclaim_helper = StorageWeightReclaimer::new(&remaining_weight_meter);
|
||||
remaining_weight_meter.consume(Weight::from_parts(0, 0));
|
||||
let reclaimed = reclaim_helper.reclaim_with_meter(&mut remaining_weight_meter);
|
||||
|
||||
assert_eq!(reclaimed, Some(Weight::from_parts(0, 0)));
|
||||
});
|
||||
}
|
||||
|
||||
/// Just here for doc purposes
|
||||
fn get_benched_weight() -> Weight {
|
||||
Weight::from_parts(0, 5)
|
||||
}
|
||||
|
||||
/// Just here for doc purposes
|
||||
fn do_work() {}
|
||||
|
||||
#[docify::export_content(simple_reclaimer_example)]
|
||||
fn reclaim_with_weight_meter() {
|
||||
let mut remaining_weight_meter = WeightMeter::with_limit(Weight::from_parts(10, 10));
|
||||
|
||||
let benched_weight = get_benched_weight();
|
||||
|
||||
// It is important to instantiate the `StorageWeightReclaimer` before we consume the weight
|
||||
// for a piece of work from the weight meter.
|
||||
let mut reclaim_helper = StorageWeightReclaimer::new(&remaining_weight_meter);
|
||||
|
||||
if remaining_weight_meter.try_consume(benched_weight).is_ok() {
|
||||
// Perform some work that takes has `benched_weight` storage weight.
|
||||
do_work();
|
||||
|
||||
// Reclaimer will detect that we only consumed 2 bytes, so 3 bytes are reclaimed.
|
||||
let reclaimed = reclaim_helper.reclaim_with_meter(&mut remaining_weight_meter);
|
||||
|
||||
// We reclaimed 3 bytes of storage size!
|
||||
assert_eq!(reclaimed, Some(Weight::from_parts(0, 3)));
|
||||
assert_eq!(BlockWeight::<Test>::get().total().proof_size(), 10);
|
||||
assert_eq!(remaining_weight_meter.remaining(), Weight::from_parts(10, 8));
|
||||
}
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn test_reclaim_helper_works_with_meter() {
|
||||
// The node will report 12 - 10 = 2 consumed storage size between the calls.
|
||||
let mut test_ext = setup_test_externalities(&[10, 12]);
|
||||
|
||||
test_ext.execute_with(|| {
|
||||
// Initial storage size is 10.
|
||||
set_current_storage_weight(10);
|
||||
reclaim_with_weight_meter();
|
||||
});
|
||||
}
|
||||
}
|
||||
Reference in New Issue
Block a user