forked from paritytech/polkadot-sdk
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
slot-based-collator: Refactor some internals (paritytech#6935)
Move `RelayChainDataFetcher` to its own module and rename it to `RelayChainDataCache`. Also move the `core_selector` function to the `slot_based` module. Related issue: paritytech#6495
- Loading branch information
Showing
3 changed files
with
172 additions
and
134 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
127 changes: 127 additions & 0 deletions
127
cumulus/client/consensus/aura/src/collators/slot_based/relay_chain_data_cache.rs
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 |
|---|---|---|
| @@ -0,0 +1,127 @@ | ||
| // Copyright (C) Parity Technologies (UK) Ltd. | ||
| // This file is part of Cumulus. | ||
|
|
||
| // Cumulus is free software: you can redistribute it and/or modify | ||
| // it under the terms of the GNU General Public License as published by | ||
| // the Free Software Foundation, either version 3 of the License, or | ||
| // (at your option) any later version. | ||
|
|
||
| // Cumulus is distributed in the hope that it will be useful, | ||
| // but WITHOUT ANY WARRANTY; without even the implied warranty of | ||
| // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | ||
| // GNU General Public License for more details. | ||
|
|
||
| // You should have received a copy of the GNU General Public License | ||
| // along with Cumulus. If not, see <http://www.gnu.org/licenses/>. | ||
|
|
||
| //! Utility for caching [`RelayChainData`] for different relay blocks. | ||
| use crate::collators::cores_scheduled_for_para; | ||
| use cumulus_primitives_core::ClaimQueueOffset; | ||
| use cumulus_relay_chain_interface::RelayChainInterface; | ||
| use polkadot_primitives::{ | ||
| CoreIndex, Hash as RelayHash, Header as RelayHeader, Id as ParaId, OccupiedCoreAssumption, | ||
| }; | ||
| use sp_runtime::generic::BlockId; | ||
| use std::collections::BTreeSet; | ||
|
|
||
| /// Contains relay chain data necessary for parachain block building. | ||
| #[derive(Clone)] | ||
| pub struct RelayChainData { | ||
| /// Current relay chain parent header. | ||
| pub relay_parent_header: RelayHeader, | ||
| /// The cores on which the para is scheduled at the configured claim queue offset. | ||
| pub scheduled_cores: Vec<CoreIndex>, | ||
| /// Maximum configured PoV size on the relay chain. | ||
| pub max_pov_size: u32, | ||
| /// The claimed cores at a relay parent. | ||
| pub claimed_cores: BTreeSet<CoreIndex>, | ||
| } | ||
|
|
||
| /// Simple helper to fetch relay chain data and cache it based on the current relay chain best block | ||
| /// hash. | ||
| pub struct RelayChainDataCache<RI> { | ||
| relay_client: RI, | ||
| para_id: ParaId, | ||
| cached_data: schnellru::LruMap<RelayHash, RelayChainData>, | ||
| } | ||
|
|
||
| impl<RI> RelayChainDataCache<RI> | ||
| where | ||
| RI: RelayChainInterface + Clone + 'static, | ||
| { | ||
| pub fn new(relay_client: RI, para_id: ParaId) -> Self { | ||
| Self { | ||
| relay_client, | ||
| para_id, | ||
| // 50 cached relay chain blocks should be more than enough. | ||
| cached_data: schnellru::LruMap::new(schnellru::ByLength::new(50)), | ||
| } | ||
| } | ||
|
|
||
| /// Fetch required [`RelayChainData`] from the relay chain. | ||
| /// If this data has been fetched in the past for the incoming hash, it will reuse | ||
| /// cached data. | ||
| pub async fn get_mut_relay_chain_data( | ||
| &mut self, | ||
| relay_parent: RelayHash, | ||
| claim_queue_offset: ClaimQueueOffset, | ||
| ) -> Result<&mut RelayChainData, ()> { | ||
| let insert_data = if self.cached_data.peek(&relay_parent).is_some() { | ||
| tracing::trace!(target: crate::LOG_TARGET, %relay_parent, "Using cached data for relay parent."); | ||
| None | ||
| } else { | ||
| tracing::trace!(target: crate::LOG_TARGET, %relay_parent, "Relay chain best block changed, fetching new data from relay chain."); | ||
| Some(self.update_for_relay_parent(relay_parent, claim_queue_offset).await?) | ||
| }; | ||
|
|
||
| Ok(self | ||
| .cached_data | ||
| .get_or_insert(relay_parent, || { | ||
| insert_data.expect("`insert_data` exists if not cached yet; qed") | ||
| }) | ||
| .expect("There is space for at least one element; qed")) | ||
| } | ||
|
|
||
| /// Fetch fresh data from the relay chain for the given relay parent hash. | ||
| async fn update_for_relay_parent( | ||
| &self, | ||
| relay_parent: RelayHash, | ||
| claim_queue_offset: ClaimQueueOffset, | ||
| ) -> Result<RelayChainData, ()> { | ||
| let scheduled_cores = cores_scheduled_for_para( | ||
| relay_parent, | ||
| self.para_id, | ||
| &self.relay_client, | ||
| claim_queue_offset, | ||
| ) | ||
| .await; | ||
|
|
||
| let Ok(Some(relay_parent_header)) = | ||
| self.relay_client.header(BlockId::Hash(relay_parent)).await | ||
| else { | ||
| tracing::warn!(target: crate::LOG_TARGET, "Unable to fetch latest relay chain block header."); | ||
| return Err(()) | ||
| }; | ||
|
|
||
| let max_pov_size = match self | ||
| .relay_client | ||
| .persisted_validation_data(relay_parent, self.para_id, OccupiedCoreAssumption::Included) | ||
| .await | ||
| { | ||
| Ok(None) => return Err(()), | ||
| Ok(Some(pvd)) => pvd.max_pov_size, | ||
| Err(err) => { | ||
| tracing::error!(target: crate::LOG_TARGET, ?err, "Failed to gather information from relay-client"); | ||
| return Err(()) | ||
| }, | ||
| }; | ||
|
|
||
| Ok(RelayChainData { | ||
| relay_parent_header, | ||
| scheduled_cores, | ||
| max_pov_size, | ||
| claimed_cores: BTreeSet::new(), | ||
| }) | ||
| } | ||
| } |