Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[benchmarking] Reset to genesis storage after each run #5655

Merged
merged 22 commits into from
Sep 22, 2024

Conversation

ggwpez
Copy link
Member

@ggwpez ggwpez commented Sep 9, 2024

The genesis state is currently partially provided via OverlayedChanges, but these changes are reset by the runtime after the first repetition, causing the second repitition to use an invalid genesis state.

Changes:

  • Provide the genesis state as a Storage without any OverlayedChanges to make it work correctly with repetitions.
  • Add --genesis-builder-preset option to use different genesis preset names.
  • Improve error messages.

@ggwpez ggwpez marked this pull request as draft September 9, 2024 17:37
Signed-off-by: Oliver Tale-Yazdi <[email protected]>
@ggwpez ggwpez added the T1-FRAME This PR/Issue is related to core FRAME, the framework. label Sep 9, 2024
@ggwpez ggwpez marked this pull request as ready for review September 9, 2024 18:10
@ggwpez ggwpez requested a review from a team as a code owner September 9, 2024 18:10
@ggwpez ggwpez requested a review from bkontur September 9, 2024 19:30
Copy link
Contributor

@bkontur bkontur left a comment

Choose a reason for hiding this comment

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

lgtm

I will rebase #5327 tomorrow.
There is commit with enabling of the new short benchmarking CI with frame-omni-bencher, so BridgeHubRococo with frame-omni-bencher fails there, so after rebase it should work.

@ggwpez ggwpez requested review from a team as code owners September 10, 2024 17:10
doc:
- audience: Runtime Dev
description: |-
The genesis state is currently partially provided via `OverlayedChanges`, but these changes are reset by the runtime after the first repetition, causing the second repitition to use an invalid genesis state.
Copy link
Member

Choose a reason for hiding this comment

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

but these changes are reset by the runtime after the first repetition

You mean here that this was overridden and not reset?

Copy link
Contributor

@skunert skunert left a comment

Choose a reason for hiding this comment

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

Okay this is funny, did not see this PR but had similar thoughts today: #5694

While at it, should we fix issue 2a from the linked issue too?

})
}

/// Convert some overlayed changes to a storage.
fn changes_to_storage<H: Hash>(
Copy link
Contributor

Choose a reason for hiding this comment

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

Why not get rid of all of this and genesis_from_runtime and just use GenesisConfigBuilderRuntimeCaller? It has all the machinery ready and we get rid of the manual json merging stuff too.

Copy link
Contributor

Choose a reason for hiding this comment

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

I'd also try using GenesisConfigBuilderRuntimeCaller to have genesis storage building in one place. If something is missing it can be adjusted / reworked.

Copy link
Member Author

Choose a reason for hiding this comment

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

I changed it now.

Signed-off-by: Oliver Tale-Yazdi <[email protected]>
@ggwpez ggwpez requested a review from skunert September 13, 2024 17:14
@skunert
Copy link
Contributor

skunert commented Sep 19, 2024

@ggwpez Anything speaks against merging this? I have a follow up that could share some code.

Signed-off-by: Oliver Tale-Yazdi <[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]>
Signed-off-by: Oliver Tale-Yazdi <[email protected]>
github-merge-queue bot pushed a commit that referenced this pull request Sep 22, 2024
It is a first step for switching to the `frame-omni-bencher` for CI.

This PR includes several changes related to generating chain specs plus:

- [x] pallet `assigned_slots` fix missing `#[serde(skip)]` for phantom
- [x] pallet `paras_inherent` benchmark fix - cherry-picked from
#5688
- [x] migrates `get_preset` to the relevant runtimes
- [x] fixes Rococo genesis presets - does not work
https://gitlab.parity.io/parity/mirrors/polkadot-sdk/-/jobs/7317249
- [x] fixes Rococo benchmarks for CI 
- [x] migrate westend genesis
- [x] remove wococo stuff

Closes: #5680

## Follow-ups
- Fix for frame-omni-bencher
#5655
- Enable new short-benchmarking CI -
#5706
- Remove gitlab pipelines for short benchmarking
- refactor all Cumulus runtimes to use `get_preset` -
#5704
- #5705
- #5700
- [ ] Backport to the stable

---------

Co-authored-by: command-bot <>
Co-authored-by: ordian <[email protected]>
bkontur added a commit that referenced this pull request Sep 22, 2024
It is a first step for switching to the `frame-omni-bencher` for CI.

This PR includes several changes related to generating chain specs plus:

- [x] pallet `assigned_slots` fix missing `#[serde(skip)]` for phantom
- [x] pallet `paras_inherent` benchmark fix - cherry-picked from
#5688
- [x] migrates `get_preset` to the relevant runtimes
- [x] fixes Rococo genesis presets - does not work
https://gitlab.parity.io/parity/mirrors/polkadot-sdk/-/jobs/7317249
- [x] fixes Rococo benchmarks for CI
- [x] migrate westend genesis
- [x] remove wococo stuff

Closes: #5680

- Fix for frame-omni-bencher
#5655
- Enable new short-benchmarking CI -
#5706
- Remove gitlab pipelines for short benchmarking
- refactor all Cumulus runtimes to use `get_preset` -
#5704
- #5705
- #5700
- [ ] Backport to the stable

---------

Co-authored-by: command-bot <>
Co-authored-by: ordian <[email protected]>
(cherry picked from commit 8735c66)
prdoc/pr_5655.prdoc Outdated Show resolved Hide resolved
@bkontur
Copy link
Contributor

bkontur commented Sep 22, 2024

@bkontur bkontur added this pull request to the merge queue Sep 22, 2024
Merged via the queue into master with commit 2e4e5bf Sep 22, 2024
207 of 209 checks passed
@bkontur bkontur deleted the oty-omni-bencher-fix branch September 22, 2024 23:03
@paritytech-cmd-bot-polkadot-sdk

Created backport PR for stable2407:

Please cherry-pick the changes locally and resolve any conflicts.

git fetch origin backport-5655-to-stable2407
git worktree add --checkout .worktree/backport-5655-to-stable2407 backport-5655-to-stable2407
cd .worktree/backport-5655-to-stable2407
git reset --hard HEAD^
git cherry-pick -x 2e4e5bf2fd0ae19fa38951c7e5f495dd1453b2bb
git push --force-with-lease

github-actions bot pushed a commit that referenced this pull request Sep 22, 2024
The genesis state is currently partially provided via
`OverlayedChanges`, but these changes are reset by the runtime after the
first repetition, causing the second repitition to use an invalid
genesis state.

Changes:
- Provide the genesis state as a `Storage` without any
`OverlayedChanges` to make it work correctly with repetitions.
- Add `--genesis-builder-preset` option to use different genesis preset
names.
- Improve error messages.

---------

Signed-off-by: Oliver Tale-Yazdi <[email protected]>
Co-authored-by: ggwpez <[email protected]>
Co-authored-by: Bastian Köcher <[email protected]>
Co-authored-by: Branislav Kontur <[email protected]>
(cherry picked from commit 2e4e5bf)
@paritytech-cmd-bot-polkadot-sdk

Successfully created backport PR for stable2409:

ggwpez added a commit that referenced this pull request Sep 24, 2024
Backport #5655 into `stable2409` from ggwpez.

See the
[documentation](https://github.com/paritytech/polkadot-sdk/blob/master/docs/BACKPORT.md)
on how to use this bot.

<!--
  # To be used by other automation, do not modify:
  original-pr-number: #${pull_number}
-->

---------

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

bkontur commented Sep 30, 2024

@ggwpez Oliver, we probably didn’t realize this earlier, but with this PR, frame-omni-bencher now requires get_preset("development") from the runtime. Otherwise, the benchmarking fails. This creates a problem for runtimes that do not implement get_preset, e.g., Kitchensink is missing it, and several testnet runtimes are now failing: #5706 — due to the missing get_preset("development"). Here's the issue to address this. The question is, should omni-bencher be this strict, or should it work with a get_preset -> None result?

cc: @mordamax

@ggwpez
Copy link
Member Author

ggwpez commented Nov 25, 2024

We have a flag to make it run with None, but the benchmarks themselves are possibly not written in a way that this would work.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
A4-needs-backport Pull request must be backported to all maintained releases. T1-FRAME This PR/Issue is related to core FRAME, the framework.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants