Weight V2 (Chromatic Weight) #10918

shawntabrizi · 2022-02-25T02:19:48Z

This is an initial PR where we change the Weight type from an primitive u64 to:

pub struct Weight {
	/// The weight of computational time used.
	ref_time: ComputationalWeight,
	/// The weight of the storage bandwidth used.
	proof_size: StorageWeight,
}

Fields are private to allow adding of new fields without needing to touch everything, again.

The strategy here is to migrate the core weight checking logic within frame_system and frame_support. Majority of pallets will still use type ComputationWeight = u64. We will convert all the places that still use the primitive types in a follow up PR.

Right now the bandwidth parameter correctly handled in frame_executive and frame_system, and we will make sure that new extrinsics do not bypass that limit, but basically all Pallets simply return 0 bandwidth for now, so this logic is not really used.

The check_weight extension takes the bandwith into account. The transaction-payment extension only looks at the computation. We will need to come up with a way to fee PoV usage in a follow up. So right now we only make sure that not too much bandwith is used but don't incur a fee for it.

For migrating existing pallets to the new Weight definition we will simply use a Weight instance with computation: weight_v1, bandwidth: 0. The computation part can be accessed with a simple getter weight.computation().

After this PR is merged, each pallet can be migrated one by one to correctly handle the bandwidth parameter.

Remove all notions of WeightV1 and replace it by a normal Weight with computation = 0.
Make fields of Weight private so we can add more fields later without breaking all the users

fixes #9584

Polkadot companion: paritytech/polkadot#5435

ggwpez · 2022-02-25T13:54:51Z

The StorageWeight is mainly POV size I assume?

Not sure what is nicer from the naming, but when we do not want to litter the weights mod we could add a v2 mod:

use frame_support::weights::v2::Weight;
// vs
use frame_support::weights::Weight2 as Weight;

athei · 2022-02-25T14:39:19Z

The StorageWeight is mainly POV size I assume?

FRAME is oblivious to this concept. PoV is what a collator sends to a validator for validation. In the cumulus case this is roughly a witness + extrinsics. For the extrinsics we already account in FRAME (this is the block lenght). The witness is what is missing from the equation. This PoV metering just assumes that accessing storage will grow the witness.

frame/support/src/weights/weight_v2.rs

ggwpez · 2022-02-25T15:35:38Z

Thanks for the explanation @athei !

kianenigma

I think there's a little bit of leftover cleaning and work such as removing TODOs left, but overall it looks good.

I still find the dimension names (computation and bandwidth as opposed to time and IO/storage) a bit strange, see: #10918 (comment)

ggwpez · 2022-05-17T19:34:44Z

I think we still need to run the bench bot, to see if the template still works.

gavofyork · 2022-05-27T15:25:45Z

bin/node/runtime/src/lib.rs

 	// weight estimate function is wired to this call's weight.
 	fn solution_weight(v: u32, t: u32, a: u32, d: u32) -> Weight {
-		<
+		Weight::from_computation(<


does the WeightInfo not now give the new Weight back from its functions?

gavofyork · 2022-05-27T15:39:00Z

frame/bounties/src/weights.rs

 #![allow(unused_imports)]

-use frame_support::{traits::Get, weights::{Weight, constants::RocksDbWeight}};
+use frame_support::{traits::Get, weights::{ComputationWeight as Weight, constants::RocksDbWeight}};


Shouldn't the weights.rs files be returning the full weight, not just computation weight? Where would we expect the PoV bandwidth weight dimension to come from?

Yes, this is a needed follow up to regenerate weights with the proper template and values. This is just a backwards compat hack for now.

pepyakin · 2022-06-23T11:18:53Z

frame/support/src/weights/weight_v2.rs

+		}
+	}
+
+	/// Construct with computation weight only (zero `bandwith`).


Suggested change

/// Construct with computation weight only (zero `bandwith`).

/// Construct with computation weight only (zero `bandwidth`).

pepyakin · 2022-06-23T11:19:55Z

frame/support/src/weights/weight_v2.rs

+		}
+	}
+
+	/// Try to add some `other` weight while upholding the `limit`.


Needs explicitly mentioning what happens in case of overflow or exceeding any of the limits

pepyakin · 2022-06-23T11:20:13Z

frame/support/src/weights/weight_v2.rs

+		}
+	}
+
+	/// Get the aggressive max of `self` and `other` weight.


Unclear what does aggressive mean here

pepyakin · 2022-06-23T11:20:22Z

frame/support/src/weights/weight_v2.rs

+	pub const MAX: Self =
+		Self { computation: ComputationWeight::MAX, bandwidth: BandwidthWeight::MAX };
+
+	/// Get the conservative min of `self` and `other` weight.


same as aggressive

kianenigma · 2022-08-05T12:58:30Z

Canonical names:

ref_time
proof_size

Would be good to make a function explicitly named for backwards compatibility, like from_legacy() or from_v1() that is equivalent to from_ref_time, so that it can be easily identified and used as TODO.

louismerlin · 2022-08-18T09:42:02Z

frame/support/src/weights/weight_v2.rs

+		self.computation < other.computation || self.bandwidth < other.bandwidth
+	}
+
+	/// Checks if any param of `self` is less than `other`.


Suggested change

/// Checks if any param of `self` is less than `other`.

/// Checks if any param of `self` is greater than `other`.

shawntabrizi added 12 commits February 14, 2022 11:22

initial stuff

97d70b2

Merge branch 'master' into shawntabrizi-weight-v2

89c2b4f

fix merge

8f5a2ea

a direction

5953db8

more stuff

a4ecc76

frame_system compiles

0c66a30

fix system tests

75a51f7

fix support tests

ad38154

update tests

1ec5af7

simplify

c946aeb

fix some todos, add others

6b1806a

Update weight_v2.rs

bf300dc

github-actions bot added the A0-please_review Pull request needs code review. label Feb 25, 2022

shawntabrizi added 4 commits February 24, 2022 22:22

fix test

0ae536b

move some stuff around

d34ce88

better variable name

132641b

fix mul stuff

e843a10

athei reviewed Feb 25, 2022

View reviewed changes

frame/support/src/weights/weight_v2.rs Outdated Show resolved Hide resolved

shawntabrizi added 5 commits February 26, 2022 14:27

Merge branch 'master' into shawntabrizi-weight-v2

707c2fd

naming

8594902

naming

9d90430

transaction payment

6f1b4c7

update simple_max

134905d

shawntabrizi requested review from andresilva and kianenigma as code owners February 26, 2022 20:38

shawntabrizi added 2 commits February 26, 2022 16:40

fix balances

8689d2d

multisig

a771ca1

kianenigma approved these changes May 3, 2022

View reviewed changes

This was referenced May 12, 2022

Change weight template outputs to (x * constants::WEIGH_PER_NANOS) #11233

Closed

Use weight constants:: in the weight template #11215

Closed

shawntabrizi added 5 commits May 23, 2022 17:17

Merge branch 'master' into shawntabrizi-weight-v2

376a40c

fix merge

f6651bd

fmt

ce882e8

fix test compile

4f10008

fix comments

969e4af

gavofyork reviewed May 27, 2022

View reviewed changes

pepyakin reviewed Jun 23, 2022

View reviewed changes

lamafab mentioned this pull request Jul 22, 2022

[WIP] Base weights for Host implementations w3f/PSPs#49

Closed

mustermeiszer mentioned this pull request Aug 8, 2022

Migration to substrate Weight V2 centrifuge/centrifuge-chain#898

Open

2 tasks

akhilesharora mentioned this pull request Aug 10, 2022

Migrate to Weights V2 centrifuge/centrifuge-chain#905

Closed

louismerlin reviewed Aug 18, 2022

View reviewed changes

kianenigma mentioned this pull request Aug 21, 2022

Consider changing Weight to be a 1-element tuple struct rather than a type alias to u64 #9584

Closed

shawntabrizi mentioned this pull request Aug 29, 2022

Weight v1.5: Opaque Struct #12138

Merged

gregdhill mentioned this pull request Sep 15, 2022

Integrate weight v1.5 changes interlay/interbtc#718

Closed

kianenigma mentioned this pull request Sep 19, 2022

Runtime-exporter crashes on startup "TypeError: weight.normal.toNumber is not a function" paritytech/polkadot-runtime-prom-exporter#35

Open

arjanz mentioned this pull request Oct 5, 2022

Implement Weight V2 (Chromatic Weight) JAMdotTech/py-polkadot-sdk#252

Closed

svyatonik mentioned this pull request Oct 6, 2022

Migrate to weights V2 paritytech/parity-bridges-common#1543

Closed

shawntabrizi closed this Oct 10, 2022

shawntabrizi deleted the shawntabrizi-weight-v2 branch October 10, 2022 14:36

louismerlin removed the D9-needsaudit 👮 PR contains changes to fund-managing logic that should be properly reviewed and externally audited label May 4, 2023

	/// Construct with computation weight only (zero `bandwith`).
	/// Construct with computation weight only (zero `bandwidth`).

	/// Checks if any param of `self` is less than `other`.
	/// Checks if any param of `self` is greater than `other`.

Weight V2 (Chromatic Weight) #10918

Weight V2 (Chromatic Weight) #10918

Uh oh!

Conversation

shawntabrizi commented Feb 25, 2022 • edited by kianenigma Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

ggwpez commented Feb 25, 2022

Uh oh!

athei commented Feb 25, 2022

Uh oh!

Uh oh!

ggwpez commented Feb 25, 2022

Uh oh!

kianenigma left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

ggwpez commented May 17, 2022

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

kianenigma commented Aug 5, 2022

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

8 participants

shawntabrizi commented Feb 25, 2022 •

edited by kianenigma

Loading

kianenigma left a comment •

edited

Loading