difftreelog
Style fix
in: master
2 files changed
pallets/scheduler/src/benchmarking.rsdiffbeforeafterboth1// This file is part of Substrate.23// Copyright (C) 2020-2022 Parity Technologies (UK) Ltd.4// SPDX-License-Identifier: Apache-2.056// Licensed under the Apache License, Version 2.0 (the "License");7// you may not use this file except in compliance with the License.8// You may obtain a copy of the License at9//10// http://www.apache.org/licenses/LICENSE-2.011//12// Unless required by applicable law or agreed to in writing, software13// distributed under the License is distributed on an "AS IS" BASIS,14// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.15// See the License for the specific language governing permissions and16// limitations under the License.1718//! Scheduler pallet benchmarking.1920use super::*;21use frame_benchmarking::benchmarks;22use frame_support::{23 ensure,24 traits::{OnInitialize, PreimageProvider, PreimageRecipient},25};26use frame_system::RawOrigin;27use sp_runtime::traits::Hash;28use sp_std::{prelude::*, vec};2930use crate::Pallet as Scheduler;31use frame_system::Pallet as System;3233const BLOCK_NUMBER: u32 = 2;3435/// Add `n` named items to the schedule.36///37/// For `resolved`:38/// - `None`: aborted (hash without preimage)39/// - `Some(true)`: hash resolves into call if possible, plain call otherwise40/// - `Some(false)`: plain call41fn fill_schedule<T: Config>(42 when: T::BlockNumber,43 n: u32,44 periodic: bool,45 named: bool,46 resolved: Option<bool>,47) -> Result<(), &'static str> {48 for i in 0..n {49 // Named schedule is strictly heavier than anonymous50 let (call, hash) = call_and_hash::<T>(i);51 let call_or_hash = match resolved {52 Some(true) => {53 T::PreimageProvider::note_preimage(call.encode().try_into().unwrap());54 if T::PreimageProvider::have_preimage(&hash) {55 CallOrHashOf::<T>::Hash(hash)56 } else {57 call.into()58 }59 },60 Some(false) => call.into(),61 None => CallOrHashOf::<T>::Hash(hash),62 };63 let period = match periodic {64 true => Some(((i + 100).into(), 100)),65 false => None,66 };67 let t = DispatchTime::At(when);68 let origin = frame_system::RawOrigin::Root.into();69 if named {70 Scheduler::<T>::do_schedule_named(i.encode().try_into().unwrap_or([0; MAX_TASK_ID_LENGTH_IN_BYTES as usize]),71 t, period, 0, origin, call_or_hash)?;72 } else {73 Scheduler::<T>::do_schedule(t, period, 0, origin, call_or_hash)?;74 }75 }76 ensure!(Agenda::<T>::get(when).len() == n as usize, "didn't fill schedule");77 Ok(())78}7980fn call_and_hash<T: Config>(i: u32) -> (<T as Config>::Call, T::Hash) {81 // Essentially a no-op call.82 let call: <T as Config>::Call = frame_system::Call::remark { remark: i.encode() }.into();83 let hash = T::Hashing::hash_of(&call);84 (call, hash)85}868788benchmarks! {89 on_initialize_periodic_named_resolved {90 let s in 1 .. T::MaxScheduledPerBlock::get();91 let when = BLOCK_NUMBER.into();92 fill_schedule::<T>(when, s, true, true, Some(true))?;93 }: { Scheduler::<T>::on_initialize(BLOCK_NUMBER.into()); }94 verify {95 assert_eq!(System::<T>::event_count(), s * 2);96 for i in 0..s {97 assert_eq!(Agenda::<T>::get(when + (i + 100).into()).len(), 1 as usize);98 }99 }100101 on_initialize_named_resolved {102 let s in 1 .. T::MaxScheduledPerBlock::get();103 let when = BLOCK_NUMBER.into();104 fill_schedule::<T>(when, s, false, true, Some(true))?;105 }: { Scheduler::<T>::on_initialize(BLOCK_NUMBER.into()); }106 verify {107 assert_eq!(System::<T>::event_count(), s * 2);108 assert!(Agenda::<T>::iter().count() == 0);109 }110111 on_initialize_periodic_resolved {112 let s in 1 .. T::MaxScheduledPerBlock::get();113 let when = BLOCK_NUMBER.into();114 fill_schedule::<T>(when, s, true, false, Some(true))?;115 }: { Scheduler::<T>::on_initialize(BLOCK_NUMBER.into()); }116 verify {117 assert_eq!(System::<T>::event_count(), s * 2);118 for i in 0..s {119 assert_eq!(Agenda::<T>::get(when + (i + 100).into()).len(), 1 as usize);120 }121 }122123 on_initialize_resolved {124 let s in 1 .. T::MaxScheduledPerBlock::get();125 let when = BLOCK_NUMBER.into();126 fill_schedule::<T>(when, s, false, false, Some(true))?;127 }: { Scheduler::<T>::on_initialize(BLOCK_NUMBER.into()); }128 verify {129 assert_eq!(System::<T>::event_count(), s * 2);130 assert!(Agenda::<T>::iter().count() == 0);131 }132133 on_initialize_named_aborted {134 let s in 1 .. T::MaxScheduledPerBlock::get();135 let when = BLOCK_NUMBER.into();136 fill_schedule::<T>(when, s, false, true, None)?;137 }: { Scheduler::<T>::on_initialize(BLOCK_NUMBER.into()); }138 verify {139 assert_eq!(System::<T>::event_count(), 0);140 if let Some(delay) = T::NoPreimagePostponement::get() {141 assert_eq!(Agenda::<T>::get(when + delay).len(), s as usize);142 } else {143 assert!(Agenda::<T>::iter().count() == 0);144 }145 }146147 on_initialize_aborted {148 let s in 1 .. T::MaxScheduledPerBlock::get();149 let when = BLOCK_NUMBER.into();150 fill_schedule::<T>(when, s, false, false, None)?;151 }: { Scheduler::<T>::on_initialize(BLOCK_NUMBER.into()); }152 verify {153 assert_eq!(System::<T>::event_count(), 0);154 if let Some(delay) = T::NoPreimagePostponement::get() {155 assert_eq!(Agenda::<T>::get(when + delay).len(), s as usize);156 } else {157 assert!(Agenda::<T>::iter().count() == 0);158 }159 }160161 on_initialize_periodic_named {162 let s in 1 .. T::MaxScheduledPerBlock::get();163 let when = BLOCK_NUMBER.into();164 fill_schedule::<T>(when, s, true, true, Some(false))?;165 }: { Scheduler::<T>::on_initialize(BLOCK_NUMBER.into()); }166 verify {167 assert_eq!(System::<T>::event_count(), s);168 for i in 0..s {169 assert_eq!(Agenda::<T>::get(when + (i + 100).into()).len(), 1 as usize);170 }171 }172173 on_initialize_periodic {174 let s in 1 .. T::MaxScheduledPerBlock::get();175 let when = BLOCK_NUMBER.into();176 fill_schedule::<T>(when, s, true, false, Some(false))?;177 }: { Scheduler::<T>::on_initialize(when); }178 verify {179 assert_eq!(System::<T>::event_count(), s);180 for i in 0..s {181 assert_eq!(Agenda::<T>::get(when + (i + 100).into()).len(), 1 as usize);182 }183 }184185 on_initialize_named {186 let s in 1 .. T::MaxScheduledPerBlock::get();187 let when = BLOCK_NUMBER.into();188 fill_schedule::<T>(when, s, false, true, Some(false))?;189 }: { Scheduler::<T>::on_initialize(BLOCK_NUMBER.into()); }190 verify {191 assert_eq!(System::<T>::event_count(), s);192 assert!(Agenda::<T>::iter().count() == 0);193 }194195 on_initialize {196 let s in 1 .. T::MaxScheduledPerBlock::get();197 let when = BLOCK_NUMBER.into();198 fill_schedule::<T>(when, s, false, false, Some(false))?;199 }: { Scheduler::<T>::on_initialize(BLOCK_NUMBER.into()); }200 verify {201 assert_eq!(System::<T>::event_count(), s);202 assert!(Agenda::<T>::iter().count() == 0);203 }204205 schedule_named {206 let s in 0 .. T::MaxScheduledPerBlock::get();207 let id = s.encode().try_into().unwrap_or([0; MAX_TASK_ID_LENGTH_IN_BYTES as usize]);208 let when = BLOCK_NUMBER.into();209 let periodic = Some((T::BlockNumber::one(), 100));210 let priority = 0;211 // Essentially a no-op call.212 let inner_call = frame_system::Call::set_storage { items: vec![] }.into();213 let call = Box::new(CallOrHashOf::<T>::Value(inner_call));214215 fill_schedule::<T>(when, s, true, true, Some(false))?;216 }: _(RawOrigin::Root, id, when, periodic, priority, call)217 verify {218 ensure!(219 Agenda::<T>::get(when).len() == (s + 1) as usize,220 "didn't add to schedule"221 );222 }223224 cancel_named {225 let s in 1 .. T::MaxScheduledPerBlock::get();226 let when = BLOCK_NUMBER.into();227 let id = 0.encode().try_into().unwrap_or([0; MAX_TASK_ID_LENGTH_IN_BYTES as usize]);228229 fill_schedule::<T>(when, s, true, true, Some(false))?;230 }: _(RawOrigin::Root, id)231 verify {232 ensure!(233 Lookup::<T>::get(id).is_none(),234 "didn't remove from lookup"235 );236 // Removed schedule is NONE237 ensure!(238 Agenda::<T>::get(when)[0].is_none(),239 "didn't remove from schedule"240 );241 }242243 impl_benchmark_test_suite!(Scheduler, crate::mock::new_test_ext(), crate::mock::Test);244}1// This file is part of Substrate.23// Copyright (C) 2020-2022 Parity Technologies (UK) Ltd.4// SPDX-License-Identifier: Apache-2.056// Licensed under the Apache License, Version 2.0 (the "License");7// you may not use this file except in compliance with the License.8// You may obtain a copy of the License at9//10// http://www.apache.org/licenses/LICENSE-2.011//12// Unless required by applicable law or agreed to in writing, software13// distributed under the License is distributed on an "AS IS" BASIS,14// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.15// See the License for the specific language governing permissions and16// limitations under the License.1718//! Scheduler pallet benchmarking.1920use super::*;21use frame_benchmarking::benchmarks;22use frame_support::{23 ensure,24 traits::{OnInitialize, PreimageProvider, PreimageRecipient},25};26use frame_system::RawOrigin;27use sp_runtime::traits::Hash;28use sp_std::{prelude::*, vec};2930use crate::Pallet as Scheduler;31use frame_system::Pallet as System;3233const BLOCK_NUMBER: u32 = 2;3435/// Add `n` named items to the schedule.36///37/// For `resolved`:38/// - `None`: aborted (hash without preimage)39/// - `Some(true)`: hash resolves into call if possible, plain call otherwise40/// - `Some(false)`: plain call41fn fill_schedule<T: Config>(42 when: T::BlockNumber,43 n: u32,44 periodic: bool,45 named: bool,46 resolved: Option<bool>,47) -> Result<(), &'static str> {48 for i in 0..n {49 // Named schedule is strictly heavier than anonymous50 let (call, hash) = call_and_hash::<T>(i);51 let call_or_hash = match resolved {52 Some(true) => {53 T::PreimageProvider::note_preimage(call.encode().try_into().unwrap());54 if T::PreimageProvider::have_preimage(&hash) {55 CallOrHashOf::<T>::Hash(hash)56 } else {57 call.into()58 }59 }60 Some(false) => call.into(),61 None => CallOrHashOf::<T>::Hash(hash),62 };63 let period = match periodic {64 true => Some(((i + 100).into(), 100)),65 false => None,66 };67 let t = DispatchTime::At(when);68 let origin = frame_system::RawOrigin::Root.into();69 if named {70 Scheduler::<T>::do_schedule_named(71 i.encode()72 .try_into()73 .unwrap_or([0; MAX_TASK_ID_LENGTH_IN_BYTES as usize]),74 t,75 period,76 0,77 origin,78 call_or_hash,79 )?;80 } else {81 Scheduler::<T>::do_schedule(t, period, 0, origin, call_or_hash)?;82 }83 }84 ensure!(85 Agenda::<T>::get(when).len() == n as usize,86 "didn't fill schedule"87 );88 Ok(())89}9091fn call_and_hash<T: Config>(i: u32) -> (<T as Config>::Call, T::Hash) {92 // Essentially a no-op call.93 let call: <T as Config>::Call = frame_system::Call::remark { remark: i.encode() }.into();94 let hash = T::Hashing::hash_of(&call);95 (call, hash)96}9798benchmarks! {99 on_initialize_periodic_named_resolved {100 let s in 1 .. T::MaxScheduledPerBlock::get();101 let when = BLOCK_NUMBER.into();102 fill_schedule::<T>(when, s, true, true, Some(true))?;103 }: { Scheduler::<T>::on_initialize(BLOCK_NUMBER.into()); }104 verify {105 assert_eq!(System::<T>::event_count(), s * 2);106 for i in 0..s {107 assert_eq!(Agenda::<T>::get(when + (i + 100).into()).len(), 1 as usize);108 }109 }110111 on_initialize_named_resolved {112 let s in 1 .. T::MaxScheduledPerBlock::get();113 let when = BLOCK_NUMBER.into();114 fill_schedule::<T>(when, s, false, true, Some(true))?;115 }: { Scheduler::<T>::on_initialize(BLOCK_NUMBER.into()); }116 verify {117 assert_eq!(System::<T>::event_count(), s * 2);118 assert!(Agenda::<T>::iter().count() == 0);119 }120121 on_initialize_periodic_resolved {122 let s in 1 .. T::MaxScheduledPerBlock::get();123 let when = BLOCK_NUMBER.into();124 fill_schedule::<T>(when, s, true, false, Some(true))?;125 }: { Scheduler::<T>::on_initialize(BLOCK_NUMBER.into()); }126 verify {127 assert_eq!(System::<T>::event_count(), s * 2);128 for i in 0..s {129 assert_eq!(Agenda::<T>::get(when + (i + 100).into()).len(), 1 as usize);130 }131 }132133 on_initialize_resolved {134 let s in 1 .. T::MaxScheduledPerBlock::get();135 let when = BLOCK_NUMBER.into();136 fill_schedule::<T>(when, s, false, false, Some(true))?;137 }: { Scheduler::<T>::on_initialize(BLOCK_NUMBER.into()); }138 verify {139 assert_eq!(System::<T>::event_count(), s * 2);140 assert!(Agenda::<T>::iter().count() == 0);141 }142143 on_initialize_named_aborted {144 let s in 1 .. T::MaxScheduledPerBlock::get();145 let when = BLOCK_NUMBER.into();146 fill_schedule::<T>(when, s, false, true, None)?;147 }: { Scheduler::<T>::on_initialize(BLOCK_NUMBER.into()); }148 verify {149 assert_eq!(System::<T>::event_count(), 0);150 if let Some(delay) = T::NoPreimagePostponement::get() {151 assert_eq!(Agenda::<T>::get(when + delay).len(), s as usize);152 } else {153 assert!(Agenda::<T>::iter().count() == 0);154 }155 }156157 on_initialize_aborted {158 let s in 1 .. T::MaxScheduledPerBlock::get();159 let when = BLOCK_NUMBER.into();160 fill_schedule::<T>(when, s, false, false, None)?;161 }: { Scheduler::<T>::on_initialize(BLOCK_NUMBER.into()); }162 verify {163 assert_eq!(System::<T>::event_count(), 0);164 if let Some(delay) = T::NoPreimagePostponement::get() {165 assert_eq!(Agenda::<T>::get(when + delay).len(), s as usize);166 } else {167 assert!(Agenda::<T>::iter().count() == 0);168 }169 }170171 on_initialize_periodic_named {172 let s in 1 .. T::MaxScheduledPerBlock::get();173 let when = BLOCK_NUMBER.into();174 fill_schedule::<T>(when, s, true, true, Some(false))?;175 }: { Scheduler::<T>::on_initialize(BLOCK_NUMBER.into()); }176 verify {177 assert_eq!(System::<T>::event_count(), s);178 for i in 0..s {179 assert_eq!(Agenda::<T>::get(when + (i + 100).into()).len(), 1 as usize);180 }181 }182183 on_initialize_periodic {184 let s in 1 .. T::MaxScheduledPerBlock::get();185 let when = BLOCK_NUMBER.into();186 fill_schedule::<T>(when, s, true, false, Some(false))?;187 }: { Scheduler::<T>::on_initialize(when); }188 verify {189 assert_eq!(System::<T>::event_count(), s);190 for i in 0..s {191 assert_eq!(Agenda::<T>::get(when + (i + 100).into()).len(), 1 as usize);192 }193 }194195 on_initialize_named {196 let s in 1 .. T::MaxScheduledPerBlock::get();197 let when = BLOCK_NUMBER.into();198 fill_schedule::<T>(when, s, false, true, Some(false))?;199 }: { Scheduler::<T>::on_initialize(BLOCK_NUMBER.into()); }200 verify {201 assert_eq!(System::<T>::event_count(), s);202 assert!(Agenda::<T>::iter().count() == 0);203 }204205 on_initialize {206 let s in 1 .. T::MaxScheduledPerBlock::get();207 let when = BLOCK_NUMBER.into();208 fill_schedule::<T>(when, s, false, false, Some(false))?;209 }: { Scheduler::<T>::on_initialize(BLOCK_NUMBER.into()); }210 verify {211 assert_eq!(System::<T>::event_count(), s);212 assert!(Agenda::<T>::iter().count() == 0);213 }214215 schedule_named {216 let s in 0 .. T::MaxScheduledPerBlock::get();217 let id = s.encode().try_into().unwrap_or([0; MAX_TASK_ID_LENGTH_IN_BYTES as usize]);218 let when = BLOCK_NUMBER.into();219 let periodic = Some((T::BlockNumber::one(), 100));220 let priority = 0;221 // Essentially a no-op call.222 let inner_call = frame_system::Call::set_storage { items: vec![] }.into();223 let call = Box::new(CallOrHashOf::<T>::Value(inner_call));224225 fill_schedule::<T>(when, s, true, true, Some(false))?;226 }: _(RawOrigin::Root, id, when, periodic, priority, call)227 verify {228 ensure!(229 Agenda::<T>::get(when).len() == (s + 1) as usize,230 "didn't add to schedule"231 );232 }233234 cancel_named {235 let s in 1 .. T::MaxScheduledPerBlock::get();236 let when = BLOCK_NUMBER.into();237 let id = 0.encode().try_into().unwrap_or([0; MAX_TASK_ID_LENGTH_IN_BYTES as usize]);238239 fill_schedule::<T>(when, s, true, true, Some(false))?;240 }: _(RawOrigin::Root, id)241 verify {242 ensure!(243 Lookup::<T>::get(id).is_none(),244 "didn't remove from lookup"245 );246 // Removed schedule is NONE247 ensure!(248 Agenda::<T>::get(when)[0].is_none(),249 "didn't remove from schedule"250 );251 }252253 impl_benchmark_test_suite!(Scheduler, crate::mock::new_test_ext(), crate::mock::Test);254}pallets/scheduler/src/lib.rsdiffbeforeafterboth--- a/pallets/scheduler/src/lib.rs
+++ b/pallets/scheduler/src/lib.rs
@@ -730,3 +730,4 @@
}
})
}
+}