83 lines
2.8 KiB
Rust
83 lines
2.8 KiB
Rust
// Copyright (C) Parity Technologies (UK) Ltd.
|
|
// This file is part of Pezkuwi.
|
|
|
|
// Pezkuwi 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.
|
|
|
|
// Pezkuwi 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 Pezkuwi. If not, see <http://www.gnu.org/licenses/>.
|
|
|
|
//! Common traits and types used by the scheduler and assignment providers.
|
|
|
|
use pezsp_runtime::{
|
|
codec::{Decode, Encode},
|
|
RuntimeDebug,
|
|
};
|
|
use scale_info::TypeInfo;
|
|
|
|
use pezkuwi_primitives::{CoreIndex, Id as ParaId};
|
|
|
|
/// Assignment (ParaId -> CoreIndex).
|
|
#[derive(Encode, Decode, TypeInfo, RuntimeDebug, Clone, PartialEq)]
|
|
pub enum Assignment {
|
|
/// A pool assignment.
|
|
Pool {
|
|
/// The assigned para id.
|
|
para_id: ParaId,
|
|
/// The core index the para got assigned to.
|
|
core_index: CoreIndex,
|
|
},
|
|
/// A bulk assignment.
|
|
Bulk(ParaId),
|
|
}
|
|
|
|
impl Assignment {
|
|
/// Returns the [`ParaId`] this assignment is associated to.
|
|
pub fn para_id(&self) -> ParaId {
|
|
match self {
|
|
Self::Pool { para_id, .. } => *para_id,
|
|
Self::Bulk(para_id) => *para_id,
|
|
}
|
|
}
|
|
}
|
|
|
|
pub trait AssignmentProvider<BlockNumber> {
|
|
/// Pops an [`Assignment`] from the provider for a specified [`CoreIndex`].
|
|
///
|
|
/// This is where assignments come into existence.
|
|
fn pop_assignment_for_core(core_idx: CoreIndex) -> Option<Assignment>;
|
|
|
|
/// A previously popped `Assignment` has been fully processed.
|
|
///
|
|
/// Report back to the assignment provider that an assignment is done and no longer present in
|
|
/// the scheduler.
|
|
///
|
|
/// This is one way of the life of an assignment coming to an end.
|
|
fn report_processed(assignment: Assignment);
|
|
|
|
/// Push back a previously popped assignment.
|
|
///
|
|
/// If the assignment could not be processed within the current session, it can be pushed back
|
|
/// to the assignment provider in order to be popped again later.
|
|
///
|
|
/// This is the second way the life of an assignment can come to an end.
|
|
fn push_back_assignment(assignment: Assignment);
|
|
|
|
/// Push some assignment for mocking/benchmarks purposes.
|
|
///
|
|
/// Useful for benchmarks and testing. The returned assignment is "valid" and can if need be
|
|
/// passed into `report_processed` for example.
|
|
#[cfg(any(feature = "runtime-benchmarks", test))]
|
|
fn get_mock_assignment(core_idx: CoreIndex, para_id: ParaId) -> Assignment;
|
|
|
|
/// Report that an assignment was duplicated by the scheduler.
|
|
fn assignment_duplicated(assignment: &Assignment);
|
|
}
|