Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Pallet parameters account for all parameters read weight #8

Merged
merged 6 commits into from
Aug 6, 2024
Merged

Pallet parameters account for all parameters read weight #8

Show file tree
Hide file tree
Changes from 4 commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
5861a10
account for all parameters on_initialize
TarekkMA Aug 2, 2024
60d3b3a
whitelist storage
TarekkMA Aug 2, 2024
5276bf9
remove whitelist
TarekkMA Aug 5, 2024
34af46a
add proof size
TarekkMA Aug 5, 2024
f9559c8
Apply suggestions from code review
TarekkMA Aug 5, 2024
3c15d2d
rewrite weight
TarekkMA Aug 5, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions Cargo.lock
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 2 additions & 0 deletions substrate/frame/parameters/Cargo.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@ frame-system = { path = "../system", default-features = false }
sp-core = { path = "../../primitives/core", default-features = false }
sp-runtime = { path = "../../primitives/runtime", default-features = false }
sp-std = { path = "../../primitives/std", default-features = false }
cumulus-primitives-storage-weight-reclaim = { path = "../../../cumulus/primitives/storage-weight-reclaim", default-features = false}
frame-benchmarking = { path = "../benchmarking", default-features = false, optional = true }

[dev-dependencies]
Expand All @@ -39,6 +40,7 @@ std = [
"sp-core/std",
"sp-runtime/std",
"sp-std/std",
"cumulus-primitives-storage-weight-reclaim/std",
]
runtime-benchmarks = [
"frame-benchmarking/runtime-benchmarks",
Expand Down
23 changes: 23 additions & 0 deletions substrate/frame/parameters/src/lib.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -125,6 +125,7 @@ use frame_support::traits::{
dynamic_params::{AggregatedKeyValue, IntoKey, Key, RuntimeParameterStore, TryIntoKey},
EnsureOriginWithArg,
};
use cumulus_primitives_storage_weight_reclaim::get_proof_size;

mod benchmarking;
#[cfg(test)]
Expand Down Expand Up @@ -167,6 +168,23 @@ pub mod pallet {
type WeightInfo: WeightInfo;
}

#[pallet::hooks]
impl<T: Config> Hooks<BlockNumberFor<T>> for Pallet<T> {
fn on_initialize(_: BlockNumberFor<T>) -> Weight {
let proof_size_before: u64 = get_proof_size().unwrap_or(0);

let items = Parameters::<T>::iter().count() as u64;
Copy link

@RomarQ RomarQ Aug 2, 2024 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looking at the support/procedural/src/dynamic_params.rs in polkadot-sdk, I do not see any storage being set for the initial values (it fallbacks to the defaults when storage is not present). Instead we should get the length from T::RuntimeParameters::default(), because the storage will be empty in the benchmarks.

polkadot-sdk/substrate/frame/support/procedural/src/dynamic_params.rs

Line 345 in ad86209

impl #scrate::__private::Get<#value_types> for #key_names {

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I do not see any insert for the initial values

We don't need to insert initial values in production, only in benchmark setup (for the on_initialize benchmark scenario that still need to be added in this PR)

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I still do not agree with the need for a on_initialize hook here. Also Parameters::<T>::iter() will be empty until set_parameter is called.

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not all parameter usage is captured by our benchmarks. For instance, some parameters may be read within xcm or in other unaccounted areas. As a result, we can't rely solely on benchmark coverage to determine parameter impact.
To mitigate potential issues, we should assume that all parameters stored in each block will be read.

This approach helps us avoid hitting the proof size limit and prevents our chain from stalling, which would otherwise require recovery through relay chain governance.

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Parameters::<T>::iter() initially will be empty, but as we add more and more parameters it will report all the stored ones


let proof_size_after: u64 = get_proof_size().unwrap_or(0);

let proof_size_diff = proof_size_after.saturating_sub(proof_size_before);

Weight::zero()
.saturating_add(T::DbWeight::get().reads(items))
.saturating_add(Weight::from_parts(0, proof_size_diff))
TarekkMA marked this conversation as resolved.
Show resolved Hide resolved
}
}

#[pallet::event]
#[pallet::generate_deposit(pub(crate) fn deposit_event)]
pub enum Event<T: Config> {
Expand All @@ -184,7 +202,12 @@ pub mod pallet {
}

/// Stored parameters.
///
/// ## Storage Whitelist
/// Since we account for all parameters read weight for each block,
/// don't double count it in other pallet benchmarks
#[pallet::storage]
// #[pallet::whitelist_storage]
TarekkMA marked this conversation as resolved.
Show resolved Hide resolved
pub type Parameters<T: Config> =
StorageMap<_, Blake2_128Concat, KeyOf<T>, ValueOf<T>, OptionQuery>;

Expand Down
Loading