Coretime Feature branch (relay chain) (#1694)

Also fixes: https://github.com/paritytech/polkadot-sdk/issues/1417

- [x] CoreIndex -> AssignmentProvider mapping will be able to change any
time.
- [x] Implement
- [x] Provide Migrations
- [x] Add and fix tests
- [x] Implement bulk assigner logic
- [x] bulk assigner tests
- [x] Port over current assigner to use bulk designer (+ share on-demand
with bulk): top-level assigner has core ranges: legacy, bulk
- [x] Adjust migrations to reflect new assigner structure
- [x] Move migration code to Assignment code directly and make it
recursive (make it possible to skip releases) -> follow up ticket.
- [x] Test migrations
- [x] Add migration PR to runtimes repo -> follow up ticket.
- [x] Wire up with actual UMP messages
- [x] Write PR docs

---------

Co-authored-by: eskimor <eskimor@no-such-url.com>
Co-authored-by: Bradley Olson <34992650+BradleyOlson64@users.noreply.github.com>
Co-authored-by: BradleyOlson64 <lotrftw9@gmail.com>
Co-authored-by: Anton Vilhelm Ásgeirsson <antonva@users.noreply.github.com>
Co-authored-by: antonva <anton.asgeirsson@parity.io>
Co-authored-by: Bastian Köcher <git@kchr.de>
Co-authored-by: Marcin S. <marcin@realemail.net>
Co-authored-by: Bastian Köcher <info@kchr.de>
Co-authored-by: command-bot <>

substrate/frame/broker/src/benchmarking.rs

@@ -705,7 +705,7 @@ mod benches {
 
 		let core_count = n.try_into().unwrap();
 
-		<T::Coretime as CoretimeInterface>::ensure_notify_core_count(core_count);
+		CoreCountInbox::<T>::put(core_count);
 
 		let mut status = Status::<T>::get().ok_or(BenchmarkError::Weightless)?;
 

substrate/frame/broker/src/coretime_interface.rs

@@ -107,11 +107,6 @@ pub trait CoretimeInterface {
 		end_hint: Option<RCBlockNumberOf<Self>>,
 	);
 
-	/// Indicate that from this block onwards, the range of acceptable values of the `core`
-	/// parameter of `assign_core` message is `[0, count)`. `assign_core` will be a no-op if
-	/// provided with a value for `core` outside of this range.
-	fn check_notify_core_count() -> Option<u16>;
-
 	/// Provide the amount of revenue accumulated from Instantaneous Coretime Sales from Relay-chain
 	/// block number `last_until` to `until`, not including `until` itself. `last_until` is defined
 	/// as being the `until` argument of the last `notify_revenue` message sent, or zero for the
@@ -123,12 +118,6 @@ pub trait CoretimeInterface {
 	/// single revenue information destination exists.
 	fn check_notify_revenue_info() -> Option<(RCBlockNumberOf<Self>, Self::Balance)>;
 
-	/// Ensure that core count is updated to the provided value.
-	///
-	/// This is only used for benchmarking.
-	#[cfg(feature = "runtime-benchmarks")]
-	fn ensure_notify_core_count(count: u16);
-
 	/// Ensure that revenue information is updated to the provided value.
 	///
 	/// This is only used for benchmarking.
@@ -151,14 +140,9 @@ impl CoretimeInterface for () {
 		_end_hint: Option<RCBlockNumberOf<Self>>,
 	) {
 	}
-	fn check_notify_core_count() -> Option<u16> {
-		None
-	}
 	fn check_notify_revenue_info() -> Option<(RCBlockNumberOf<Self>, Self::Balance)> {
 		None
 	}
 	#[cfg(feature = "runtime-benchmarks")]
-	fn ensure_notify_core_count(_count: u16) {}
-	#[cfg(feature = "runtime-benchmarks")]
 	fn ensure_notify_revenue_info(_when: RCBlockNumberOf<Self>, _revenue: Self::Balance) {}
 }

substrate/frame/broker/src/dispatchable_impls.rs

@@ -37,6 +37,11 @@ impl<T: Config> Pallet<T> {
 		Ok(())
 	}
 
+	pub(crate) fn do_notify_core_count(core_count: CoreIndex) -> DispatchResult {
+		CoreCountInbox::<T>::put(core_count);
+		Ok(())
+	}
+
 	pub(crate) fn do_reserve(workload: Schedule) -> DispatchResult {
 		let mut r = Reservations::<T>::get();
 		let index = r.len() as u32;

substrate/frame/broker/src/lib.rs

@@ -159,6 +159,10 @@ pub mod pallet {
 	pub type InstaPoolHistory<T> =
 		StorageMap<_, Blake2_128Concat, Timeslice, InstaPoolHistoryRecordOf<T>>;
 
+	/// Received core count change from the relay chain.
+	#[pallet::storage]
+	pub type CoreCountInbox<T> = StorageValue<_, CoreIndex, OptionQuery>;
+
 	#[pallet::event]
 	#[pallet::generate_deposit(pub(super) fn deposit_event)]
 	pub enum Event<T: Config> {
@@ -774,5 +778,13 @@ pub mod pallet {
 			Self::do_request_core_count(core_count)?;
 			Ok(())
 		}
+
+		#[pallet::call_index(19)]
+		#[pallet::weight(T::WeightInfo::notify_core_count())]
+		pub fn notify_core_count(origin: OriginFor<T>, core_count: CoreIndex) -> DispatchResult {
+			T::AdminOrigin::ensure_origin_or_root(origin)?;
+			Self::do_notify_core_count(core_count)?;
+			Ok(())
+		}
 	}
 }

substrate/frame/broker/src/mock.rs

@@ -70,7 +70,6 @@ parameter_types! {
 	pub static CoretimeWorkplan: BTreeMap<(u32, CoreIndex), Vec<(CoreAssignment, PartsOf57600)>> = Default::default();
 	pub static CoretimeUsage: BTreeMap<CoreIndex, Vec<(CoreAssignment, PartsOf57600)>> = Default::default();
 	pub static CoretimeInPool: CoreMaskBitCount = 0;
-	pub static NotifyCoreCount: Vec<u16> = Default::default();
 	pub static NotifyRevenueInfo: Vec<(u32, u64)> = Default::default();
 }
 
@@ -80,7 +79,7 @@ impl CoretimeInterface for TestCoretimeProvider {
 	type Balance = u64;
 	type RealyChainBlockNumberProvider = System;
 	fn request_core_count(count: CoreIndex) {
-		NotifyCoreCount::mutate(|s| s.insert(0, count));
+		CoreCountInbox::<Test>::put(count);
 	}
 	fn request_revenue_info_at(when: RCBlockNumberOf<Self>) {
 		if when > RCBlockNumberProviderOf::<Self>::current_block_number() {
@@ -126,17 +125,10 @@ impl CoretimeInterface for TestCoretimeProvider {
 		);
 		CoretimeTrace::mutate(|v| v.push(item));
 	}
-	fn check_notify_core_count() -> Option<u16> {
-		NotifyCoreCount::mutate(|s| s.pop())
-	}
 	fn check_notify_revenue_info() -> Option<(RCBlockNumberOf<Self>, Self::Balance)> {
 		NotifyRevenueInfo::mutate(|s| s.pop()).map(|v| (v.0 as _, v.1))
 	}
 	#[cfg(feature = "runtime-benchmarks")]
-	fn ensure_notify_core_count(count: u16) {
-		NotifyCoreCount::mutate(|s| s.insert(0, count));
-	}
-	#[cfg(feature = "runtime-benchmarks")]
 	fn ensure_notify_revenue_info(when: RCBlockNumberOf<Self>, revenue: Self::Balance) {
 		NotifyRevenueInfo::mutate(|s| s.push((when as u32, revenue)));
 	}

substrate/frame/broker/src/tick_impls.rs

@@ -87,7 +87,7 @@ impl<T: Config> Pallet<T> {
 	}
 
 	pub(crate) fn process_core_count(status: &mut StatusRecord) -> bool {
-		if let Some(core_count) = T::Coretime::check_notify_core_count() {
+		if let Some(core_count) = CoreCountInbox::<T>::take() {
 			status.core_count = core_count;
 			Self::deposit_event(Event::<T>::CoreCountChanged { core_count });
 			return true

substrate/frame/broker/src/weights.rs

@@ -74,6 +74,7 @@ pub trait WeightInfo {
 	fn process_pool() -> Weight;
 	fn process_core_schedule() -> Weight;
 	fn request_revenue_info_at() -> Weight;
+	fn notify_core_count() -> Weight;
 	fn do_tick_base() -> Weight;
 }
 
@@ -447,6 +448,9 @@ impl<T: frame_system::Config> WeightInfo for SubstrateWeight<T> {
 		// Minimum execution time: 147_000 picoseconds.
 		Weight::from_parts(184_000, 0)
 	}
+	fn notify_core_count() -> Weight {
+		T::DbWeight::get().reads_writes(1, 1)
+	}
 	/// Storage: `Broker::Status` (r:1 w:1)
 	/// Proof: `Broker::Status` (`max_values`: Some(1), `max_size`: Some(18), added: 513, mode: `MaxEncodedLen`)
 	/// Storage: `Broker::Configuration` (r:1 w:0)
@@ -835,6 +839,10 @@ impl WeightInfo for () {
 		// Minimum execution time: 147_000 picoseconds.
 		Weight::from_parts(184_000, 0)
 	}
+	fn notify_core_count() -> Weight {
+		RocksDbWeight::get().reads(1)
+			.saturating_add(RocksDbWeight::get().writes(1))
+	}
 	/// Storage: `Broker::Status` (r:1 w:1)
 	/// Proof: `Broker::Status` (`max_values`: Some(1), `max_size`: Some(18), added: 513, mode: `MaxEncodedLen`)
 	/// Storage: `Broker::Configuration` (r:1 w:0)