Create sp-weights crate to store weight primitives (#12219)

* Create sp-weights crate to store weight primitives

* Fix templates

* Fix templates

* Fixes

* Fixes

* cargo fmt

* Fixes

* Fixes

* Use deprecated type alias instead of deprecated unit types

* Use deprecated subtraits instead of deprecated hollow new traits

* Fixes

* Allow deprecation in macro expansion

* Add missing where clause during call macro expansion

* cargo fmt

* Fixes

* cargo fmt

* Fixes

* Fixes

* Fixes

* Fixes

* Move FRAME-specific weight files back to frame_support

* Fixes

* Update frame/support/src/dispatch.rs

Co-authored-by: Kian Paimani <5588131+kianenigma@users.noreply.github.com>

* Update frame/support/src/dispatch.rs

Co-authored-by: Kian Paimani <5588131+kianenigma@users.noreply.github.com>

* Update frame/support/src/dispatch.rs

Co-authored-by: Kian Paimani <5588131+kianenigma@users.noreply.github.com>

* Add missing header

* Rewrite module docs

* Fixes

* Fixes

* Fixes

* Fixes

* cargo fmt

Co-authored-by: Shawn Tabrizi <shawntabrizi@gmail.com>
Co-authored-by: Kian Paimani <5588131+kianenigma@users.noreply.github.com>

substrate/frame/support/src/weights/block_weights.rs

@@ -34,10 +34,8 @@
 //   --warmup=10
 //   --repeat=100
 
-use frame_support::{
-	parameter_types,
-	weights::{constants::WEIGHT_PER_NANOS, Weight},
-};
+use sp_core::parameter_types;
+use sp_weights::{constants::WEIGHT_PER_NANOS, Weight};
 
 parameter_types! {
 	/// Time to execute an empty block.
@@ -58,7 +56,7 @@ parameter_types! {
 
 #[cfg(test)]
 mod test_weights {
-	use frame_support::weights::constants;
+	use sp_weights::constants;
 
 	/// Checks that the weight exists and is sane.
 	// NOTE: If this test fails but you are sure that the generated values are fine,

substrate/frame/support/src/weights/extrinsic_weights.rs

@@ -34,10 +34,8 @@
 //   --warmup=10
 //   --repeat=100
 
-use frame_support::{
-	parameter_types,
-	weights::{constants::WEIGHT_PER_NANOS, Weight},
-};
+use sp_core::parameter_types;
+use sp_weights::{constants::WEIGHT_PER_NANOS, Weight};
 
 parameter_types! {
 	/// Time to execute a NO-OP extrinsic, for example `System::remark`.
@@ -58,7 +56,7 @@ parameter_types! {
 
 #[cfg(test)]
 mod test_weights {
-	use frame_support::weights::constants;
+	use sp_weights::constants;
 
 	/// Checks that the weight exists and is sane.
 	// NOTE: If this test fails but you are sure that the generated values are fine,

substrate/frame/support/src/weights/paritydb_weights.rs

@@ -16,10 +16,9 @@
 // limitations under the License.
 
 pub mod constants {
-	use frame_support::{
-		parameter_types,
-		weights::{constants, RuntimeDbWeight},
-	};
+	use frame_support::weights::constants;
+	use sp_core::parameter_types;
+	use sp_weights::RuntimeDbWeight;
 
 	parameter_types! {
 		/// ParityDB can be enabled with a feature flag, but is still experimental. These weights
@@ -33,7 +32,7 @@ pub mod constants {
 	#[cfg(test)]
 	mod test_db_weights {
 		use super::constants::ParityDbWeight as W;
-		use frame_support::weights::constants;
+		use sp_weights::constants;
 
 		/// Checks that all weights exist and have sane values.
 		// NOTE: If this test fails but you are sure that the generated values are fine,

substrate/frame/support/src/weights/rocksdb_weights.rs

@@ -16,10 +16,9 @@
 // limitations under the License.
 
 pub mod constants {
-	use frame_support::{
-		parameter_types,
-		weights::{constants, RuntimeDbWeight},
-	};
+	use frame_support::weights::constants;
+	use sp_core::parameter_types;
+	use sp_weights::RuntimeDbWeight;
 
 	parameter_types! {
 		/// By default, Substrate uses RocksDB, so this will be the weight used throughout
@@ -33,7 +32,7 @@ pub mod constants {
 	#[cfg(test)]
 	mod test_db_weights {
 		use super::constants::RocksDbWeight as W;
-		use frame_support::weights::constants;
+		use sp_weights::constants;
 
 		/// Checks that all weights exist and have sane values.
 		// NOTE: If this test fails but you are sure that the generated values are fine,

substrate/frame/support/src/weights/weight_v2.rs

@@ -1,526 +0,0 @@
-// 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.
-
-use codec::{CompactAs, Decode, Encode, MaxEncodedLen};
-use core::ops::{Add, AddAssign, Div, Mul, Sub, SubAssign};
-use sp_runtime::{
-	traits::{Bounded, CheckedAdd, CheckedSub, Zero},
-	RuntimeDebug,
-};
-
-use super::*;
-
-#[derive(
-	Encode,
-	Decode,
-	MaxEncodedLen,
-	TypeInfo,
-	Eq,
-	PartialEq,
-	Copy,
-	Clone,
-	RuntimeDebug,
-	Default,
-	CompactAs,
-)]
-#[cfg_attr(feature = "std", derive(Serialize, Deserialize))]
-pub struct Weight {
-	/// The weight of computational time used based on some reference hardware.
-	ref_time: u64,
-}
-
-impl Weight {
-	/// Set the reference time part of the weight.
-	pub const fn set_ref_time(mut self, c: u64) -> Self {
-		self.ref_time = c;
-		self
-	}
-
-	/// Return the reference time part of the weight.
-	pub const fn ref_time(&self) -> u64 {
-		self.ref_time
-	}
-
-	/// Return a mutable reference time part of the weight.
-	pub fn ref_time_mut(&mut self) -> &mut u64 {
-		&mut self.ref_time
-	}
-
-	pub const MAX: Self = Self { ref_time: u64::MAX };
-
-	/// Get the conservative min of `self` and `other` weight.
-	pub fn min(&self, other: Self) -> Self {
-		Self { ref_time: self.ref_time.min(other.ref_time) }
-	}
-
-	/// Get the aggressive max of `self` and `other` weight.
-	pub fn max(&self, other: Self) -> Self {
-		Self { ref_time: self.ref_time.max(other.ref_time) }
-	}
-
-	/// Try to add some `other` weight while upholding the `limit`.
-	pub fn try_add(&self, other: &Self, limit: &Self) -> Option<Self> {
-		let total = self.checked_add(other)?;
-		if total.ref_time > limit.ref_time {
-			None
-		} else {
-			Some(total)
-		}
-	}
-
-	/// Construct [`Weight`] with reference time weight.
-	pub const fn from_ref_time(ref_time: u64) -> Self {
-		Self { ref_time }
-	}
-
-	/// Saturating [`Weight`] addition. Computes `self + rhs`, saturating at the numeric bounds of
-	/// all fields instead of overflowing.
-	pub const fn saturating_add(self, rhs: Self) -> Self {
-		Self { ref_time: self.ref_time.saturating_add(rhs.ref_time) }
-	}
-
-	/// Saturating [`Weight`] subtraction. Computes `self - rhs`, saturating at the numeric bounds
-	/// of all fields instead of overflowing.
-	pub const fn saturating_sub(self, rhs: Self) -> Self {
-		Self { ref_time: self.ref_time.saturating_sub(rhs.ref_time) }
-	}
-
-	/// Saturating [`Weight`] scalar multiplication. Computes `self.field * scalar` for all fields,
-	/// saturating at the numeric bounds of all fields instead of overflowing.
-	pub const fn saturating_mul(self, scalar: u64) -> Self {
-		Self { ref_time: self.ref_time.saturating_mul(scalar) }
-	}
-
-	/// Saturating [`Weight`] scalar division. Computes `self.field / scalar` for all fields,
-	/// saturating at the numeric bounds of all fields instead of overflowing.
-	pub const fn saturating_div(self, scalar: u64) -> Self {
-		Self { ref_time: self.ref_time.saturating_div(scalar) }
-	}
-
-	/// Saturating [`Weight`] scalar exponentiation. Computes `self.field.pow(exp)` for all fields,
-	/// saturating at the numeric bounds of all fields instead of overflowing.
-	pub const fn saturating_pow(self, exp: u32) -> Self {
-		Self { ref_time: self.ref_time.saturating_pow(exp) }
-	}
-
-	/// Increment [`Weight`] by `amount` via saturating addition.
-	pub fn saturating_accrue(&mut self, amount: Self) {
-		*self = self.saturating_add(amount);
-	}
-
-	/// Checked [`Weight`] addition. Computes `self + rhs`, returning `None` if overflow occurred.
-	pub const fn checked_add(&self, rhs: &Self) -> Option<Self> {
-		match self.ref_time.checked_add(rhs.ref_time) {
-			Some(ref_time) => Some(Self { ref_time }),
-			None => None,
-		}
-	}
-
-	/// Checked [`Weight`] subtraction. Computes `self - rhs`, returning `None` if overflow
-	/// occurred.
-	pub const fn checked_sub(&self, rhs: &Self) -> Option<Self> {
-		match self.ref_time.checked_sub(rhs.ref_time) {
-			Some(ref_time) => Some(Self { ref_time }),
-			None => None,
-		}
-	}
-
-	/// Checked [`Weight`] scalar multiplication. Computes `self.field * scalar` for each field,
-	/// returning `None` if overflow occurred.
-	pub const fn checked_mul(self, scalar: u64) -> Option<Self> {
-		match self.ref_time.checked_mul(scalar) {
-			Some(ref_time) => Some(Self { ref_time }),
-			None => None,
-		}
-	}
-
-	/// Checked [`Weight`] scalar division. Computes `self.field / scalar` for each field, returning
-	/// `None` if overflow occurred.
-	pub const fn checked_div(self, scalar: u64) -> Option<Self> {
-		match self.ref_time.checked_div(scalar) {
-			Some(ref_time) => Some(Self { ref_time }),
-			None => None,
-		}
-	}
-
-	/// Return a [`Weight`] where all fields are zero.
-	pub const fn zero() -> Self {
-		Self { ref_time: 0 }
-	}
-
-	/// Returns true if any of `self`'s constituent weights is strictly greater than that of the
-	/// `other`'s, otherwise returns false.
-	pub const fn any_gt(self, other: Self) -> bool {
-		self.ref_time > other.ref_time
-	}
-
-	/// Returns true if all of `self`'s constituent weights is strictly greater than that of the
-	/// `other`'s, otherwise returns false.
-	pub const fn all_gt(self, other: Self) -> bool {
-		self.ref_time > other.ref_time
-	}
-
-	/// Returns true if any of `self`'s constituent weights is strictly less than that of the
-	/// `other`'s, otherwise returns false.
-	pub const fn any_lt(self, other: Self) -> bool {
-		self.ref_time < other.ref_time
-	}
-
-	/// Returns true if all of `self`'s constituent weights is strictly less than that of the
-	/// `other`'s, otherwise returns false.
-	pub const fn all_lt(self, other: Self) -> bool {
-		self.ref_time < other.ref_time
-	}
-
-	/// Returns true if any of `self`'s constituent weights is greater than or equal to that of the
-	/// `other`'s, otherwise returns false.
-	pub const fn any_gte(self, other: Self) -> bool {
-		self.ref_time >= other.ref_time
-	}
-
-	/// Returns true if all of `self`'s constituent weights is greater than or equal to that of the
-	/// `other`'s, otherwise returns false.
-	pub const fn all_gte(self, other: Self) -> bool {
-		self.ref_time >= other.ref_time
-	}
-
-	/// Returns true if any of `self`'s constituent weights is less than or equal to that of the
-	/// `other`'s, otherwise returns false.
-	pub const fn any_lte(self, other: Self) -> bool {
-		self.ref_time <= other.ref_time
-	}
-
-	/// Returns true if all of `self`'s constituent weights is less than or equal to that of the
-	/// `other`'s, otherwise returns false.
-	pub const fn all_lte(self, other: Self) -> bool {
-		self.ref_time <= other.ref_time
-	}
-
-	/// Returns true if any of `self`'s constituent weights is equal to that of the `other`'s,
-	/// otherwise returns false.
-	pub const fn any_eq(self, other: Self) -> bool {
-		self.ref_time == other.ref_time
-	}
-
-	// NOTE: `all_eq` does not exist, as it's simply the `eq` method from the `PartialEq` trait.
-}
-
-impl Zero for Weight {
-	fn zero() -> Self {
-		Self::zero()
-	}
-
-	fn is_zero(&self) -> bool {
-		self.ref_time == 0
-	}
-}
-
-impl Add for Weight {
-	type Output = Self;
-	fn add(self, rhs: Self) -> Self {
-		Self { ref_time: self.ref_time + rhs.ref_time }
-	}
-}
-
-impl Sub for Weight {
-	type Output = Self;
-	fn sub(self, rhs: Self) -> Self {
-		Self { ref_time: self.ref_time - rhs.ref_time }
-	}
-}
-
-impl<T> Mul<T> for Weight
-where
-	T: Mul<u64, Output = u64> + Copy,
-{
-	type Output = Self;
-	fn mul(self, b: T) -> Self {
-		Self { ref_time: b * self.ref_time }
-	}
-}
-
-macro_rules! weight_mul_per_impl {
-	($($t:ty),* $(,)?) => {
-		$(
-			impl Mul<Weight> for $t {
-				type Output = Weight;
-				fn mul(self, b: Weight) -> Weight {
-					Weight { ref_time: self * b.ref_time }
-				}
-			}
-		)*
-	}
-}
-weight_mul_per_impl!(
-	sp_runtime::Percent,
-	sp_runtime::PerU16,
-	sp_runtime::Permill,
-	sp_runtime::Perbill,
-	sp_runtime::Perquintill,
-);
-
-macro_rules! weight_mul_primitive_impl {
-	($($t:ty),* $(,)?) => {
-		$(
-			impl Mul<Weight> for $t {
-				type Output = Weight;
-				fn mul(self, b: Weight) -> Weight {
-					Weight { ref_time: u64::from(self) * b.ref_time }
-				}
-			}
-		)*
-	}
-}
-weight_mul_primitive_impl!(u8, u16, u32, u64);
-
-impl<T> Div<T> for Weight
-where
-	u64: Div<T, Output = u64>,
-	T: Copy,
-{
-	type Output = Self;
-	fn div(self, b: T) -> Self {
-		Self { ref_time: self.ref_time / b }
-	}
-}
-
-impl CheckedAdd for Weight {
-	fn checked_add(&self, rhs: &Self) -> Option<Self> {
-		self.checked_add(rhs)
-	}
-}
-
-impl CheckedSub for Weight {
-	fn checked_sub(&self, rhs: &Self) -> Option<Self> {
-		self.checked_sub(rhs)
-	}
-}
-
-impl<T> PaysFee<T> for (Weight, DispatchClass, Pays) {
-	fn pays_fee(&self, _: T) -> Pays {
-		self.2
-	}
-}
-
-impl<T> WeighData<T> for (Weight, DispatchClass) {
-	fn weigh_data(&self, args: T) -> Weight {
-		return self.0.weigh_data(args)
-	}
-}
-
-impl<T> WeighData<T> for (Weight, DispatchClass, Pays) {
-	fn weigh_data(&self, args: T) -> Weight {
-		return self.0.weigh_data(args)
-	}
-}
-
-impl<T> ClassifyDispatch<T> for (Weight, DispatchClass) {
-	fn classify_dispatch(&self, _: T) -> DispatchClass {
-		self.1
-	}
-}
-
-impl<T> PaysFee<T> for (Weight, DispatchClass) {
-	fn pays_fee(&self, _: T) -> Pays {
-		Pays::Yes
-	}
-}
-
-impl<T> WeighData<T> for (Weight, Pays) {
-	fn weigh_data(&self, args: T) -> Weight {
-		return self.0.weigh_data(args)
-	}
-}
-
-impl<T> ClassifyDispatch<T> for (Weight, Pays) {
-	fn classify_dispatch(&self, _: T) -> DispatchClass {
-		DispatchClass::Normal
-	}
-}
-
-impl<T> PaysFee<T> for (Weight, Pays) {
-	fn pays_fee(&self, _: T) -> Pays {
-		self.1
-	}
-}
-
-impl From<(Option<Weight>, Pays)> for PostDispatchInfo {
-	fn from(post_weight_info: (Option<Weight>, Pays)) -> Self {
-		let (actual_weight, pays_fee) = post_weight_info;
-		Self { actual_weight, pays_fee }
-	}
-}
-
-impl From<Option<Weight>> for PostDispatchInfo {
-	fn from(actual_weight: Option<Weight>) -> Self {
-		Self { actual_weight, pays_fee: Default::default() }
-	}
-}
-
-impl<T> WeighData<T> for Weight {
-	fn weigh_data(&self, _: T) -> Weight {
-		return *self
-	}
-}
-
-impl<T> ClassifyDispatch<T> for Weight {
-	fn classify_dispatch(&self, _: T) -> DispatchClass {
-		DispatchClass::Normal
-	}
-}
-
-impl<T> PaysFee<T> for Weight {
-	fn pays_fee(&self, _: T) -> Pays {
-		Pays::Yes
-	}
-}
-
-impl<T> ClassifyDispatch<T> for (Weight, DispatchClass, Pays) {
-	fn classify_dispatch(&self, _: T) -> DispatchClass {
-		self.1
-	}
-}
-
-impl core::fmt::Display for Weight {
-	fn fmt(&self, f: &mut core::fmt::Formatter<'_>) -> core::fmt::Result {
-		write!(f, "Weight(ref_time: {})", self.ref_time)
-	}
-}
-
-impl Bounded for Weight {
-	fn min_value() -> Self {
-		Zero::zero()
-	}
-	fn max_value() -> Self {
-		Self::MAX
-	}
-}
-
-impl AddAssign for Weight {
-	fn add_assign(&mut self, other: Self) {
-		*self = Self { ref_time: self.ref_time + other.ref_time };
-	}
-}
-
-impl SubAssign for Weight {
-	fn sub_assign(&mut self, other: Self) {
-		*self = Self { ref_time: self.ref_time - other.ref_time };
-	}
-}
-
-impl sp_runtime::traits::Printable for Weight {
-	fn print(&self) {
-		self.ref_time().print()
-	}
-}
-
-// TODO: Eventually remove these
-
-impl From<Option<u64>> for PostDispatchInfo {
-	fn from(maybe_actual_computation: Option<u64>) -> Self {
-		let actual_weight = match maybe_actual_computation {
-			Some(actual_computation) => Some(Weight::zero().set_ref_time(actual_computation)),
-			None => None,
-		};
-		Self { actual_weight, pays_fee: Default::default() }
-	}
-}
-
-impl From<(Option<u64>, Pays)> for PostDispatchInfo {
-	fn from(post_weight_info: (Option<u64>, Pays)) -> Self {
-		let (maybe_actual_time, pays_fee) = post_weight_info;
-		let actual_weight = match maybe_actual_time {
-			Some(actual_time) => Some(Weight::zero().set_ref_time(actual_time)),
-			None => None,
-		};
-		Self { actual_weight, pays_fee }
-	}
-}
-
-impl<T> WeighData<T> for u64 {
-	fn weigh_data(&self, _: T) -> Weight {
-		return Weight::zero().set_ref_time(*self)
-	}
-}
-
-impl<T> ClassifyDispatch<T> for u64 {
-	fn classify_dispatch(&self, _: T) -> DispatchClass {
-		DispatchClass::Normal
-	}
-}
-
-impl<T> PaysFee<T> for u64 {
-	fn pays_fee(&self, _: T) -> Pays {
-		Pays::Yes
-	}
-}
-
-impl<T> WeighData<T> for (u64, DispatchClass, Pays) {
-	fn weigh_data(&self, args: T) -> Weight {
-		return self.0.weigh_data(args)
-	}
-}
-
-impl<T> ClassifyDispatch<T> for (u64, DispatchClass, Pays) {
-	fn classify_dispatch(&self, _: T) -> DispatchClass {
-		self.1
-	}
-}
-
-impl<T> PaysFee<T> for (u64, DispatchClass, Pays) {
-	fn pays_fee(&self, _: T) -> Pays {
-		self.2
-	}
-}
-
-impl<T> WeighData<T> for (u64, DispatchClass) {
-	fn weigh_data(&self, args: T) -> Weight {
-		return self.0.weigh_data(args)
-	}
-}
-
-impl<T> ClassifyDispatch<T> for (u64, DispatchClass) {
-	fn classify_dispatch(&self, _: T) -> DispatchClass {
-		self.1
-	}
-}
-
-impl<T> PaysFee<T> for (u64, DispatchClass) {
-	fn pays_fee(&self, _: T) -> Pays {
-		Pays::Yes
-	}
-}
-
-impl<T> WeighData<T> for (u64, Pays) {
-	fn weigh_data(&self, args: T) -> Weight {
-		return self.0.weigh_data(args)
-	}
-}
-
-impl<T> ClassifyDispatch<T> for (u64, Pays) {
-	fn classify_dispatch(&self, _: T) -> DispatchClass {
-		DispatchClass::Normal
-	}
-}
-
-impl<T> PaysFee<T> for (u64, Pays) {
-	fn pays_fee(&self, _: T) -> Pays {
-		self.1
-	}
-}
-
-// END TODO