forked from solana-labs/solana
-
Notifications
You must be signed in to change notification settings - Fork 259
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Clean up Partitioned Epoch Rewards feature logic (#4186)
* Remove feature from syscall logic * Remove is_partitioned_rewards_code_enabled * Update test_bank_hash_consistency, which runs with all features off * Fixup test_bank_update_rewards_determinism * Remove is_partitioned_rewards_feature_enabled * Remove feature-gate logic * Remove superfluous total_rewards pass-through * Start removing old rewards logic: update_rewards_with_thread_pool and PER compare fns * Remove more old rewards logic: helper fns; and fixup tests * Remove more old rewards logic: StakesCache helpers * Remove remaining old rewards logic: type aliases and helper structs * remove partitioned reward test code * Remove superfluous test attribute Co-authored-by: Brooks <brooks@prumo.org> --------- Co-authored-by: HaoranYi <haoran.yi@anza.xyz> Co-authored-by: Tyera <tyera@solana.com> Co-authored-by: Brooks <brooks@prumo.org>
- Loading branch information
4 people
authored
Dec 30, 2024
1 parent
7f2bbd3
commit 5662eee
Showing
16 changed files
with
242 additions
and
1,166 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,98 +1,39 @@ | ||
| //! Code related to partitioned rewards distribution | ||
| #[derive(Debug)] | ||
| /// # stake accounts to store in one block during partitioned reward interval | ||
| /// Target to store 64 rewards per entry/tick in a block. A block has a minimum of 64 | ||
| /// entries/tick. This gives 4096 total rewards to store in one block. | ||
| /// This constant affects consensus. | ||
| const MAX_PARTITIONED_REWARDS_PER_BLOCK: u64 = 4096; | ||
|
|
||
| #[derive(Debug, Clone, Copy)] | ||
| /// Configuration options for partitioned epoch rewards. | ||
| /// This struct allows various forms of testing, especially prior to feature activation. | ||
| pub struct PartitionedEpochRewardsConfig { | ||
| /// number of stake accounts to store in one block during partitioned reward interval | ||
| /// normally, this is a number tuned for reasonable performance, such as 4096 accounts/block | ||
| /// if force_one_slot_partitioned_rewards, this will usually be u64::MAX so that all stake accounts are written in the first block | ||
| pub stake_account_stores_per_block: u64, | ||
| /// if true, end of epoch bank rewards will force using partitioned rewards distribution. | ||
| /// see `set_test_enable_partitioned_rewards` | ||
| pub test_enable_partitioned_rewards: bool, | ||
| /// if true, end of epoch non-partitioned bank rewards will test the partitioned rewards distribution vote and stake accounts | ||
| /// This has a significant performance impact on the first slot in each new epoch. | ||
| pub test_compare_partitioned_epoch_rewards: bool, | ||
| } | ||
|
|
||
| /// Convenient constant for default partitioned epoch rewards configuration | ||
| /// used for benchmarks and tests. | ||
| pub const DEFAULT_PARTITIONED_EPOCH_REWARDS_CONFIG: PartitionedEpochRewardsConfig = | ||
| PartitionedEpochRewardsConfig { | ||
| stake_account_stores_per_block: MAX_PARTITIONED_REWARDS_PER_BLOCK, | ||
| }; | ||
|
|
||
| impl Default for PartitionedEpochRewardsConfig { | ||
| fn default() -> Self { | ||
| Self { | ||
| // # stake accounts to store in one block during partitioned reward interval | ||
| // Target to store 64 rewards per entry/tick in a block. A block has a minimum of 64 | ||
| // entries/tick. This gives 4096 total rewards to store in one block. | ||
| // This constant affects consensus. | ||
| stake_account_stores_per_block: 4096, | ||
| test_enable_partitioned_rewards: false, | ||
| test_compare_partitioned_epoch_rewards: false, | ||
| stake_account_stores_per_block: MAX_PARTITIONED_REWARDS_PER_BLOCK, | ||
| } | ||
| } | ||
| } | ||
|
|
||
| #[derive(Debug, Default, Clone, Copy)] | ||
| pub enum TestPartitionedEpochRewards { | ||
| #[default] | ||
| None, | ||
| CompareResults, | ||
| ForcePartitionedEpochRewardsInOneBlock, | ||
| PartitionedEpochRewardsConfigRewardBlocks { | ||
| stake_account_stores_per_block: u64, | ||
| }, | ||
| } | ||
|
|
||
| impl PartitionedEpochRewardsConfig { | ||
| pub fn new(test: TestPartitionedEpochRewards) -> Self { | ||
| match test { | ||
| TestPartitionedEpochRewards::None => Self::default(), | ||
| TestPartitionedEpochRewards::CompareResults => { | ||
| Self::set_test_compare_partitioned_epoch_rewards() | ||
| } | ||
| TestPartitionedEpochRewards::ForcePartitionedEpochRewardsInOneBlock => { | ||
| Self::set_test_enable_partitioned_rewards() | ||
| } | ||
| TestPartitionedEpochRewards::PartitionedEpochRewardsConfigRewardBlocks { | ||
| stake_account_stores_per_block, | ||
| } => { | ||
| Self::set_test_enable_partitioned_rewards_with_custom_number_of_stake_accounts_per_block( | ||
| stake_account_stores_per_block | ||
| ) | ||
| } | ||
| } | ||
| } | ||
|
|
||
| /// All rewards will be distributed in the first block in the epoch, matching | ||
| /// consensus for the non-partitioned rewards, but running all the partitioned rewards | ||
| /// code. | ||
| fn set_test_enable_partitioned_rewards() -> Self { | ||
| Self { | ||
| stake_account_stores_per_block: u64::MAX, | ||
| test_enable_partitioned_rewards: true, | ||
| // irrelevant if we are not running old code path | ||
| test_compare_partitioned_epoch_rewards: false, | ||
| } | ||
| } | ||
|
|
||
| /// All rewards will be distributed in the first block in the epoch as normal. | ||
| /// Then, the partitioned rewards code will calculate expected results and compare to | ||
| /// the old code path's results. | ||
| fn set_test_compare_partitioned_epoch_rewards() -> Self { | ||
| Self { | ||
| test_compare_partitioned_epoch_rewards: true, | ||
| ..PartitionedEpochRewardsConfig::default() | ||
| } | ||
| } | ||
|
|
||
| /// A method that configures how many reward reward calculation blocks and how many stake | ||
| /// accounts to store per reward block. | ||
| fn set_test_enable_partitioned_rewards_with_custom_number_of_stake_accounts_per_block( | ||
| stake_account_stores_per_block: u64, | ||
| ) -> Self { | ||
| /// Only for tests and benchmarks | ||
| pub fn new_for_test(stake_account_stores_per_block: u64) -> Self { | ||
| Self { | ||
| stake_account_stores_per_block, | ||
| test_enable_partitioned_rewards: true, | ||
| // irrelevant if we are not running old code path | ||
| test_compare_partitioned_epoch_rewards: false, | ||
| } | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.