Skip to content
This repository has been archived by the owner on Nov 15, 2023. It is now read-only.

Remove Copy from Ensure* traits #13043

Merged
merged 8 commits into from
Jan 4, 2023
Merged

Conversation

ggwpez
Copy link
Member

@ggwpez ggwpez commented Jan 2, 2023

Follow up on #12967 (comment) to make BaseArithmetic work with Ensure.
It re-uses the code from EnsureOpAssign in EnsureOp, instead of the other way around, which incurred the Copy requirement.
It does contain an artificial dependence of EnsureOp on EnsureOpAssign to re-use code, but that should be fine since the trait bounds would be the same anyway.

Removes the Copy requirement from:

  • EnsureOp and EnsureOpAssign
  • EnsureFrom and EnsureInto: Not sure about this one since we now generate the error in every case. Could be slightly slower.
  • Require Ensure for BaseArithmetic

cc @lemunozm

Signed-off-by: Oliver Tale-Yazdi <[email protected]>
@ggwpez ggwpez added A0-please_review Pull request needs code review. B7-runtimenoteworthy C1-low PR touches the given topic and has a low impact on builders. D3-trivial 🧸 PR contains trivial changes in a runtime directory that do not require an audit labels Jan 2, 2023
@ggwpez ggwpez marked this pull request as draft January 2, 2023 12:18
@ggwpez ggwpez added A3-in_progress Pull request is in progress. No review needed at this stage. and removed A0-please_review Pull request needs code review. labels Jan 2, 2023
Signed-off-by: Oliver Tale-Yazdi <[email protected]>
@ggwpez ggwpez marked this pull request as ready for review January 2, 2023 12:27
@github-actions github-actions bot added A0-please_review Pull request needs code review. and removed A3-in_progress Pull request is in progress. No review needed at this stage. labels Jan 2, 2023
Copy link
Contributor

@lemunozm lemunozm left a comment

Choose a reason for hiding this comment

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

I like this without the Copy dependency 😄 . Some comments below

@@ -728,14 +725,13 @@ mod ensure {
/// assert_eq!(underflow(), Err(ArithmeticError::Underflow));
/// ```
fn ensure_from(other: T) -> Result<Self, ArithmeticError> {
Self::try_from(other).map_err(|_| error::equivalent(other))
let err = error::equivalent(&other);
Copy link
Contributor

Choose a reason for hiding this comment

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

Regarding the performance of this, it seems like the assembly resulting code of this can be easily reordered by the compiler and should not be penalty

Copy link
Member

Choose a reason for hiding this comment

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

Did you check this?

Copy link
Contributor

Choose a reason for hiding this comment

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

Not empirically (not sure how to do it well).

To extend my argument, error::equivalent has no side effects, and if the resulting value is only read under a condition, the compiler can only execute that for that condition. I understand that this works for any T that is not really consumed by the try_from(), which means that T is in fact a Copy type. The compiler could not optimize this if T is not Copy.

Copy link
Member

Choose a reason for hiding this comment

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

Okay ;)

primitives/arithmetic/src/traits.rs Outdated Show resolved Hide resolved
primitives/arithmetic/src/traits.rs Outdated Show resolved Hide resolved
primitives/arithmetic/src/traits.rs Outdated Show resolved Hide resolved
primitives/arithmetic/src/traits.rs Show resolved Hide resolved
Co-authored-by: Luis Enrique Muñoz Martín <[email protected]>

Signed-off-by: Oliver Tale-Yazdi <[email protected]>
Signed-off-by: Oliver Tale-Yazdi <[email protected]>
Signed-off-by: Oliver Tale-Yazdi <[email protected]>
Copy link
Contributor

@lemunozm lemunozm left a comment

Choose a reason for hiding this comment

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

LGTM!
Nice tests 🚀

@ggwpez ggwpez requested a review from bkchr January 2, 2023 15:35
@bkchr bkchr requested a review from kianenigma January 2, 2023 23:05
@ggwpez
Copy link
Member Author

ggwpez commented Jan 4, 2023

bot merge

@paritytech-processbot paritytech-processbot bot merged commit 68fc275 into master Jan 4, 2023
@paritytech-processbot paritytech-processbot bot deleted the oty-ensure-without-copy branch January 4, 2023 13:00
Copy link
Contributor

@sam0x17 sam0x17 left a comment

Choose a reason for hiding this comment

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

Looks good to me!

ltfschoen pushed a commit to ltfschoen/substrate that referenced this pull request Feb 22, 2023
* Remove Copy from EnsureOp and EnsureOpAssign

Signed-off-by: Oliver Tale-Yazdi <[email protected]>

* Remove Copy from EnsureFrom and EnsureInto

Signed-off-by: Oliver Tale-Yazdi <[email protected]>

* Fix default impl

Signed-off-by: Oliver Tale-Yazdi <[email protected]>

* Reuse assignment code in Ensure trait

Signed-off-by: Oliver Tale-Yazdi <[email protected]>

* Require Ensure for all BaseArithmetic types

Signed-off-by: Oliver Tale-Yazdi <[email protected]>

* Fix assign impls

Co-authored-by: Luis Enrique Muñoz Martín <[email protected]>

Signed-off-by: Oliver Tale-Yazdi <[email protected]>

* Add tests

Signed-off-by: Oliver Tale-Yazdi <[email protected]>

* Add success doc tests

Signed-off-by: Oliver Tale-Yazdi <[email protected]>

Signed-off-by: Oliver Tale-Yazdi <[email protected]>
ark0f pushed a commit to gear-tech/substrate that referenced this pull request Feb 27, 2023
* Remove Copy from EnsureOp and EnsureOpAssign

Signed-off-by: Oliver Tale-Yazdi <[email protected]>

* Remove Copy from EnsureFrom and EnsureInto

Signed-off-by: Oliver Tale-Yazdi <[email protected]>

* Fix default impl

Signed-off-by: Oliver Tale-Yazdi <[email protected]>

* Reuse assignment code in Ensure trait

Signed-off-by: Oliver Tale-Yazdi <[email protected]>

* Require Ensure for all BaseArithmetic types

Signed-off-by: Oliver Tale-Yazdi <[email protected]>

* Fix assign impls

Co-authored-by: Luis Enrique Muñoz Martín <[email protected]>

Signed-off-by: Oliver Tale-Yazdi <[email protected]>

* Add tests

Signed-off-by: Oliver Tale-Yazdi <[email protected]>

* Add success doc tests

Signed-off-by: Oliver Tale-Yazdi <[email protected]>

Signed-off-by: Oliver Tale-Yazdi <[email protected]>
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
A0-please_review Pull request needs code review. C1-low PR touches the given topic and has a low impact on builders. D3-trivial 🧸 PR contains trivial changes in a runtime directory that do not require an audit
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants