WeightMeter: more consistent naming (#14586)

* Rename WeightMeter functions

* Fixes

Signed-off-by: Oliver Tale-Yazdi <oliver.tale-yazdi@parity.io>

* Fixup and doc + tests

Signed-off-by: Oliver Tale-Yazdi <oliver.tale-yazdi@parity.io>

* One more test

Signed-off-by: Oliver Tale-Yazdi <oliver.tale-yazdi@parity.io>

* Fixup pallets

Signed-off-by: Oliver Tale-Yazdi <oliver.tale-yazdi@parity.io>

* Use correct function 🤦

Signed-off-by: Oliver Tale-Yazdi <oliver.tale-yazdi@parity.io>

* Apply suggestions from code review

Co-authored-by: Juan <juangirini@gmail.com>

* Update primitives/weights/src/weight_meter.rs

Co-authored-by: Bastian Köcher <git@kchr.de>

* Update primitives/weights/src/weight_meter.rs

Co-authored-by: Bastian Köcher <git@kchr.de>

* Update primitives/weights/src/weight_meter.rs

---------

Signed-off-by: Oliver Tale-Yazdi <oliver.tale-yazdi@parity.io>
Co-authored-by: Juan <juangirini@gmail.com>
Co-authored-by: Bastian Köcher <git@kchr.de>
This commit is contained in:
Oliver Tale-Yazdi
2023-07-18 16:38:44 +02:00
committed by GitHub
parent 1dc6610524
commit 892831e55c
8 changed files with 173 additions and 57 deletions
@@ -166,7 +166,7 @@ mod benchmarks {
}
assert_eq!(ServiceHead::<T>::get().unwrap(), 10u32.into());
assert_eq!(weight.consumed, T::WeightInfo::bump_service_head());
assert_eq!(weight.consumed(), T::WeightInfo::bump_service_head());
}
#[benchmark]
+28 -18
View File
@@ -737,7 +737,7 @@ impl<T: Config> Pallet<T> {
///
/// Returns the current head if it got be bumped and `None` otherwise.
fn bump_service_head(weight: &mut WeightMeter) -> Option<MessageOriginOf<T>> {
if !weight.check_accrue(T::WeightInfo::bump_service_head()) {
if weight.try_consume(T::WeightInfo::bump_service_head()).is_err() {
return None
}
@@ -865,7 +865,7 @@ impl<T: Config> Pallet<T> {
book_state.message_count,
book_state.size,
);
Ok(weight_counter.consumed.saturating_add(page_weight))
Ok(weight_counter.consumed().saturating_add(page_weight))
},
}
}
@@ -948,9 +948,13 @@ impl<T: Config> Pallet<T> {
overweight_limit: Weight,
) -> (bool, Option<MessageOriginOf<T>>) {
use PageExecutionStatus::*;
if !weight.check_accrue(
T::WeightInfo::service_queue_base().saturating_add(T::WeightInfo::ready_ring_unknit()),
) {
if weight
.try_consume(
T::WeightInfo::service_queue_base()
.saturating_add(T::WeightInfo::ready_ring_unknit()),
)
.is_err()
{
return (false, None)
}
@@ -1003,10 +1007,13 @@ impl<T: Config> Pallet<T> {
overweight_limit: Weight,
) -> (u32, PageExecutionStatus) {
use PageExecutionStatus::*;
if !weight.check_accrue(
T::WeightInfo::service_page_base_completion()
.max(T::WeightInfo::service_page_base_no_completion()),
) {
if weight
.try_consume(
T::WeightInfo::service_page_base_completion()
.max(T::WeightInfo::service_page_base_no_completion()),
)
.is_err()
{
return (0, Bailed)
}
@@ -1066,7 +1073,7 @@ impl<T: Config> Pallet<T> {
if page.is_complete() {
return ItemExecutionStatus::NoItem
}
if !weight.check_accrue(T::WeightInfo::service_page_item()) {
if weight.try_consume(T::WeightInfo::service_page_item()).is_err() {
return ItemExecutionStatus::Bailed
}
@@ -1163,7 +1170,7 @@ impl<T: Config> Pallet<T> {
) -> MessageExecutionStatus {
let hash = sp_io::hashing::blake2_256(message);
use ProcessMessageError::*;
let prev_consumed = meter.consumed;
let prev_consumed = meter.consumed();
let mut id = hash;
match T::MessageProcessor::process_message(message, origin.clone(), meter, &mut id) {
@@ -1193,7 +1200,7 @@ impl<T: Config> Pallet<T> {
},
Ok(success) => {
// Success
let weight_used = meter.consumed.saturating_sub(prev_consumed);
let weight_used = meter.consumed().saturating_sub(prev_consumed);
Self::deposit_event(Event::<T>::Processed { id, origin, weight_used, success });
MessageExecutionStatus::Processed
},
@@ -1254,7 +1261,7 @@ impl<T: Config> ServiceQueues for Pallet<T> {
let mut next = match Self::bump_service_head(&mut weight) {
Some(h) => h,
None => return weight.consumed,
None => return weight.consumed(),
};
// The last queue that did not make any progress.
// The loop aborts as soon as it arrives at this queue again without making any progress
@@ -1280,7 +1287,7 @@ impl<T: Config> ServiceQueues for Pallet<T> {
None => break,
}
}
weight.consumed
weight.consumed()
}
/// Execute a single overweight message.
@@ -1291,10 +1298,13 @@ impl<T: Config> ServiceQueues for Pallet<T> {
(message_origin, page, index): Self::OverweightMessageAddress,
) -> Result<Weight, ExecuteOverweightError> {
let mut weight = WeightMeter::from_limit(weight_limit);
if !weight.check_accrue(
T::WeightInfo::execute_overweight_page_removed()
.max(T::WeightInfo::execute_overweight_page_updated()),
) {
if weight
.try_consume(
T::WeightInfo::execute_overweight_page_removed()
.max(T::WeightInfo::execute_overweight_page_updated()),
)
.is_err()
{
return Err(ExecuteOverweightError::InsufficientWeight)
}
+2 -2
View File
@@ -188,7 +188,7 @@ impl ProcessMessage for RecordingMessageProcessor {
};
let required = Weight::from_parts(weight, weight);
if meter.check_accrue(required) {
if meter.try_consume(required).is_ok() {
let mut m = MessagesProcessed::get();
m.push((message.to_vec(), origin));
MessagesProcessed::set(m);
@@ -245,7 +245,7 @@ impl ProcessMessage for CountingMessageProcessor {
}
let required = Weight::from_parts(1, 1);
if meter.check_accrue(required) {
if meter.try_consume(required).is_ok() {
NumMessagesProcessed::set(NumMessagesProcessed::get() + 1);
Ok(true)
} else {
@@ -66,7 +66,7 @@ where
) -> Result<bool, ProcessMessageError> {
let required = Weight::from_parts(REQUIRED_WEIGHT, REQUIRED_WEIGHT);
if meter.check_accrue(required) {
if meter.try_consume(required).is_ok() {
Ok(true)
} else {
Err(ProcessMessageError::Overweight(required))
+11 -11
View File
@@ -381,7 +381,7 @@ fn service_queue_bails() {
let mut meter = WeightMeter::from_limit(1.into_weight());
assert_storage_noop!(MessageQueue::service_queue(0u32.into(), &mut meter, Weight::MAX));
assert!(meter.consumed.is_zero());
assert!(meter.consumed().is_zero());
});
// Not enough weight for `ready_ring_unknit`.
test_closure(|| {
@@ -389,7 +389,7 @@ fn service_queue_bails() {
let mut meter = WeightMeter::from_limit(1.into_weight());
assert_storage_noop!(MessageQueue::service_queue(0u32.into(), &mut meter, Weight::MAX));
assert!(meter.consumed.is_zero());
assert!(meter.consumed().is_zero());
});
// Not enough weight for `service_queue_base` and `ready_ring_unknit`.
test_closure(|| {
@@ -398,7 +398,7 @@ fn service_queue_bails() {
let mut meter = WeightMeter::from_limit(3.into_weight());
assert_storage_noop!(MessageQueue::service_queue(0.into(), &mut meter, Weight::MAX));
assert!(meter.consumed.is_zero());
assert!(meter.consumed().is_zero());
});
}
@@ -458,7 +458,7 @@ fn service_page_bails() {
&mut meter,
Weight::MAX
));
assert!(meter.consumed.is_zero());
assert!(meter.consumed().is_zero());
});
// Not enough weight for `service_page_base_no_completion`.
test_closure(|| {
@@ -475,7 +475,7 @@ fn service_page_bails() {
&mut meter,
Weight::MAX
));
assert!(meter.consumed.is_zero());
assert!(meter.consumed().is_zero());
});
}
@@ -586,7 +586,7 @@ fn bump_service_head_bails() {
let _guard = StorageNoopGuard::default();
let mut meter = WeightMeter::from_limit(1.into_weight());
assert!(MessageQueue::bump_service_head(&mut meter).is_none());
assert_eq!(meter.consumed, 0.into_weight());
assert_eq!(meter.consumed(), 0.into_weight());
});
}
@@ -597,16 +597,16 @@ fn bump_service_head_trivial_works() {
let mut meter = WeightMeter::max_limit();
assert_eq!(MessageQueue::bump_service_head(&mut meter), None, "Cannot bump");
assert_eq!(meter.consumed, 2.into_weight());
assert_eq!(meter.consumed(), 2.into_weight());
setup_bump_service_head::<Test>(0.into(), 1.into());
assert_eq!(MessageQueue::bump_service_head(&mut meter), Some(0.into()));
assert_eq!(ServiceHead::<Test>::get().unwrap(), 1.into(), "Bumped the head");
assert_eq!(meter.consumed, 4.into_weight());
assert_eq!(meter.consumed(), 4.into_weight());
assert_eq!(MessageQueue::bump_service_head(&mut meter), None, "Cannot bump");
assert_eq!(meter.consumed, 6.into_weight());
assert_eq!(meter.consumed(), 6.into_weight());
});
}
@@ -649,7 +649,7 @@ fn service_page_item_consumes_correct_weight() {
),
ItemExecutionStatus::Executed(true)
);
assert_eq!(weight.consumed, 5.into_weight());
assert_eq!(weight.consumed(), 5.into_weight());
});
}
@@ -673,7 +673,7 @@ fn service_page_item_skips_perm_overweight_message() {
),
ItemExecutionStatus::Executed(false)
);
assert_eq!(weight.consumed, 2.into_weight());
assert_eq!(weight.consumed(), 2.into_weight());
assert_last_event::<Test>(
Event::OverweightEnqueued {
id: blake2_256(b"TooMuch"),