Unverified Commit 656dd280 authored by Lldenaurois's avatar Lldenaurois Committed by GitHub
Browse files

Revert "remove provisioner checks (#4254)" (#4375)

* Revert "remove provisioner checks (#4254)"

This reverts commit 71e76705.

* Remove TODO in implementer's guide
parent 20187da7
Pipeline #168592 failed with stages
in 45 minutes and 53 seconds
...@@ -567,9 +567,9 @@ dependencies = [ ...@@ -567,9 +567,9 @@ dependencies = [
[[package]] [[package]]
name = "bitvec" name = "bitvec"
version = "0.20.4" version = "0.20.1"
source = "registry+https://github.com/rust-lang/crates.io-index" source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "7774144344a4faa177370406a7ff5f1da24303817368584c6206c8303eb07848" checksum = "f5011ffc90248764d7005b0e10c7294f5aa1bd87d9dd7248f4ad475b347c294d"
dependencies = [ dependencies = [
"funty", "funty",
"radium 0.6.2", "radium 0.6.2",
...@@ -729,7 +729,7 @@ dependencies = [ ...@@ -729,7 +729,7 @@ dependencies = [
name = "bp-messages" name = "bp-messages"
version = "0.1.0" version = "0.1.0"
dependencies = [ dependencies = [
"bitvec 0.20.4", "bitvec 0.20.1",
"bp-runtime", "bp-runtime",
"frame-support", "frame-support",
"frame-system", "frame-system",
...@@ -3179,7 +3179,7 @@ name = "kusama-runtime" ...@@ -3179,7 +3179,7 @@ name = "kusama-runtime"
version = "0.9.13" version = "0.9.13"
dependencies = [ dependencies = [
"beefy-primitives", "beefy-primitives",
"bitvec 0.20.4", "bitvec 0.20.1",
"frame-benchmarking", "frame-benchmarking",
"frame-election-provider-support", "frame-election-provider-support",
"frame-executive", "frame-executive",
...@@ -4878,7 +4878,7 @@ dependencies = [ ...@@ -4878,7 +4878,7 @@ dependencies = [
name = "pallet-bridge-messages" name = "pallet-bridge-messages"
version = "0.1.0" version = "0.1.0"
dependencies = [ dependencies = [
"bitvec 0.20.4", "bitvec 0.20.1",
"bp-message-dispatch", "bp-message-dispatch",
"bp-messages", "bp-messages",
"bp-rialto", "bp-rialto",
...@@ -5559,7 +5559,7 @@ source = "registry+https://github.com/rust-lang/crates.io-index" ...@@ -5559,7 +5559,7 @@ source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "373b1a4c1338d9cd3d1fa53b3a11bdab5ab6bd80a20f7f7becd76953ae2be909" checksum = "373b1a4c1338d9cd3d1fa53b3a11bdab5ab6bd80a20f7f7becd76953ae2be909"
dependencies = [ dependencies = [
"arrayvec 0.7.2", "arrayvec 0.7.2",
"bitvec 0.20.4", "bitvec 0.20.1",
"byte-slice-cast", "byte-slice-cast",
"impl-trait-for-tuples", "impl-trait-for-tuples",
"parity-scale-codec-derive", "parity-scale-codec-derive",
...@@ -5896,7 +5896,7 @@ name = "polkadot-availability-bitfield-distribution" ...@@ -5896,7 +5896,7 @@ name = "polkadot-availability-bitfield-distribution"
version = "0.9.13" version = "0.9.13"
dependencies = [ dependencies = [
"assert_matches", "assert_matches",
"bitvec 0.20.4", "bitvec 0.20.1",
"env_logger 0.9.0", "env_logger 0.9.0",
"futures 0.3.17", "futures 0.3.17",
"log", "log",
...@@ -6170,7 +6170,7 @@ name = "polkadot-node-core-approval-voting" ...@@ -6170,7 +6170,7 @@ name = "polkadot-node-core-approval-voting"
version = "0.9.13" version = "0.9.13"
dependencies = [ dependencies = [
"assert_matches", "assert_matches",
"bitvec 0.20.4", "bitvec 0.20.1",
"derive_more", "derive_more",
"futures 0.3.17", "futures 0.3.17",
"futures-timer 3.0.2", "futures-timer 3.0.2",
...@@ -6206,7 +6206,7 @@ name = "polkadot-node-core-av-store" ...@@ -6206,7 +6206,7 @@ name = "polkadot-node-core-av-store"
version = "0.9.13" version = "0.9.13"
dependencies = [ dependencies = [
"assert_matches", "assert_matches",
"bitvec 0.20.4", "bitvec 0.20.1",
"env_logger 0.9.0", "env_logger 0.9.0",
"futures 0.3.17", "futures 0.3.17",
"futures-timer 3.0.2", "futures-timer 3.0.2",
...@@ -6233,7 +6233,7 @@ name = "polkadot-node-core-backing" ...@@ -6233,7 +6233,7 @@ name = "polkadot-node-core-backing"
version = "0.9.13" version = "0.9.13"
dependencies = [ dependencies = [
"assert_matches", "assert_matches",
"bitvec 0.20.4", "bitvec 0.20.1",
"futures 0.3.17", "futures 0.3.17",
"polkadot-erasure-coding", "polkadot-erasure-coding",
"polkadot-node-primitives", "polkadot-node-primitives",
...@@ -6333,7 +6333,7 @@ name = "polkadot-node-core-dispute-coordinator" ...@@ -6333,7 +6333,7 @@ name = "polkadot-node-core-dispute-coordinator"
version = "0.9.13" version = "0.9.13"
dependencies = [ dependencies = [
"assert_matches", "assert_matches",
"bitvec 0.20.4", "bitvec 0.20.1",
"derive_more", "derive_more",
"futures 0.3.17", "futures 0.3.17",
"kvdb", "kvdb",
...@@ -6372,13 +6372,15 @@ dependencies = [ ...@@ -6372,13 +6372,15 @@ dependencies = [
name = "polkadot-node-core-provisioner" name = "polkadot-node-core-provisioner"
version = "0.9.13" version = "0.9.13"
dependencies = [ dependencies = [
"bitvec 0.20.4", "bitvec 0.20.1",
"futures 0.3.17", "futures 0.3.17",
"futures-timer 3.0.2", "futures-timer 3.0.2",
"polkadot-node-subsystem", "polkadot-node-subsystem",
"polkadot-node-subsystem-test-helpers", "polkadot-node-subsystem-test-helpers",
"polkadot-node-subsystem-util", "polkadot-node-subsystem-util",
"polkadot-primitives", "polkadot-primitives",
"sp-application-crypto",
"sp-keystore",
"thiserror", "thiserror",
"tracing", "tracing",
] ]
...@@ -6651,7 +6653,7 @@ dependencies = [ ...@@ -6651,7 +6653,7 @@ dependencies = [
name = "polkadot-primitives" name = "polkadot-primitives"
version = "0.9.13" version = "0.9.13"
dependencies = [ dependencies = [
"bitvec 0.20.4", "bitvec 0.20.1",
"frame-system", "frame-system",
"hex-literal", "hex-literal",
"parity-scale-codec", "parity-scale-codec",
...@@ -6711,7 +6713,7 @@ name = "polkadot-runtime" ...@@ -6711,7 +6713,7 @@ name = "polkadot-runtime"
version = "0.9.13" version = "0.9.13"
dependencies = [ dependencies = [
"beefy-primitives", "beefy-primitives",
"bitvec 0.20.4", "bitvec 0.20.1",
"frame-benchmarking", "frame-benchmarking",
"frame-election-provider-support", "frame-election-provider-support",
"frame-executive", "frame-executive",
...@@ -6798,7 +6800,7 @@ name = "polkadot-runtime-common" ...@@ -6798,7 +6800,7 @@ name = "polkadot-runtime-common"
version = "0.9.13" version = "0.9.13"
dependencies = [ dependencies = [
"beefy-primitives", "beefy-primitives",
"bitvec 0.20.4", "bitvec 0.20.1",
"frame-benchmarking", "frame-benchmarking",
"frame-election-provider-support", "frame-election-provider-support",
"frame-support", "frame-support",
...@@ -6848,7 +6850,7 @@ name = "polkadot-runtime-parachains" ...@@ -6848,7 +6850,7 @@ name = "polkadot-runtime-parachains"
version = "0.9.13" version = "0.9.13"
dependencies = [ dependencies = [
"bitflags", "bitflags",
"bitvec 0.20.4", "bitvec 0.20.1",
"derive_more", "derive_more",
"frame-benchmarking", "frame-benchmarking",
"frame-support", "frame-support",
...@@ -7138,7 +7140,7 @@ name = "polkadot-test-runtime" ...@@ -7138,7 +7140,7 @@ name = "polkadot-test-runtime"
version = "0.9.13" version = "0.9.13"
dependencies = [ dependencies = [
"beefy-primitives", "beefy-primitives",
"bitvec 0.20.4", "bitvec 0.20.1",
"frame-election-provider-support", "frame-election-provider-support",
"frame-executive", "frame-executive",
"frame-support", "frame-support",
...@@ -9049,7 +9051,7 @@ version = "1.0.0" ...@@ -9049,7 +9051,7 @@ version = "1.0.0"
source = "registry+https://github.com/rust-lang/crates.io-index" source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "5c55b744399c25532d63a0d2789b109df8d46fc93752d46b0782991a931a782f" checksum = "5c55b744399c25532d63a0d2789b109df8d46fc93752d46b0782991a931a782f"
dependencies = [ dependencies = [
"bitvec 0.20.4", "bitvec 0.20.1",
"cfg-if 1.0.0", "cfg-if 1.0.0",
"derive_more", "derive_more",
"parity-scale-codec", "parity-scale-codec",
...@@ -11594,7 +11596,7 @@ name = "westend-runtime" ...@@ -11594,7 +11596,7 @@ name = "westend-runtime"
version = "0.9.13" version = "0.9.13"
dependencies = [ dependencies = [
"beefy-primitives", "beefy-primitives",
"bitvec 0.20.4", "bitvec 0.20.1",
"frame-benchmarking", "frame-benchmarking",
"frame-election-provider-support", "frame-election-provider-support",
"frame-executive", "frame-executive",
......
...@@ -5,6 +5,7 @@ authors = ["Parity Technologies <admin@parity.io>"] ...@@ -5,6 +5,7 @@ authors = ["Parity Technologies <admin@parity.io>"]
edition = "2018" edition = "2018"
[dependencies] [dependencies]
bitvec = { version = "0.20.1", default-features = false, features = ["alloc"] }
futures = "0.3.17" futures = "0.3.17"
tracing = "0.1.29" tracing = "0.1.29"
thiserror = "1.0.30" thiserror = "1.0.30"
...@@ -14,5 +15,6 @@ polkadot-node-subsystem-util = { path = "../../subsystem-util" } ...@@ -14,5 +15,6 @@ polkadot-node-subsystem-util = { path = "../../subsystem-util" }
futures-timer = "3.0.2" futures-timer = "3.0.2"
[dev-dependencies] [dev-dependencies]
sp-application-crypto = { git = "https://github.com/paritytech/substrate", branch = "master" }
sp-keystore = { git = "https://github.com/paritytech/substrate", branch = "master" }
polkadot-node-subsystem-test-helpers = { path = "../../subsystem-test-helpers" } polkadot-node-subsystem-test-helpers = { path = "../../subsystem-test-helpers" }
bitvec = { version = "0.20.1", default-features = false, features = [] }
...@@ -14,11 +14,12 @@ ...@@ -14,11 +14,12 @@
// You should have received a copy of the GNU General Public License // You should have received a copy of the GNU General Public License
// along with Polkadot. If not, see <http://www.gnu.org/licenses/>. // along with Polkadot. If not, see <http://www.gnu.org/licenses/>.
//! The provisioner is responsible for assembling a set of items, from which the //! The provisioner is responsible for assembling a relay chain block
//! runtime will pick a subset and create a relay chain block. //! from a set of available parachain candidates of its choice.
#![deny(missing_docs, unused_crate_dependencies)] #![deny(missing_docs, unused_crate_dependencies)]
use bitvec::vec::BitVec;
use futures::{ use futures::{
channel::{mpsc, oneshot}, channel::{mpsc, oneshot},
prelude::*, prelude::*,
...@@ -28,18 +29,21 @@ use polkadot_node_subsystem::{ ...@@ -28,18 +29,21 @@ use polkadot_node_subsystem::{
errors::{ChainApiError, RuntimeApiError}, errors::{ChainApiError, RuntimeApiError},
jaeger, jaeger,
messages::{ messages::{
CandidateBackingMessage, DisputeCoordinatorMessage, ProvisionableData, CandidateBackingMessage, ChainApiMessage, DisputeCoordinatorMessage, ProvisionableData,
ProvisionerInherentData, ProvisionerMessage, ProvisionerInherentData, ProvisionerMessage,
}, },
PerLeafSpan, SubsystemSender, PerLeafSpan, SubsystemSender,
}; };
use polkadot_node_subsystem_util::{self as util, JobSender, JobSubsystem, JobTrait}; use polkadot_node_subsystem_util::{
self as util, request_availability_cores, request_persisted_validation_data, JobSender,
JobSubsystem, JobTrait,
};
use polkadot_primitives::v1::{ use polkadot_primitives::v1::{
BackedCandidate, CandidateHash, CandidateReceipt, DisputeStatement, DisputeStatementSet, Hash, BackedCandidate, BlockNumber, CandidateReceipt, CoreState, DisputeStatement,
Id as ParaId, MultiDisputeStatementSet, SignedAvailabilityBitfield, DisputeStatementSet, Hash, MultiDisputeStatementSet, OccupiedCoreAssumption,
SignedAvailabilityBitfields, SignedAvailabilityBitfield, ValidatorIndex,
}; };
use std::{collections::HashSet, pin::Pin, sync::Arc}; use std::{collections::BTreeMap, pin::Pin, sync::Arc};
use thiserror::Error; use thiserror::Error;
mod metrics; mod metrics;
...@@ -104,17 +108,40 @@ pub enum Error { ...@@ -104,17 +108,40 @@ pub enum Error {
#[error(transparent)] #[error(transparent)]
Util(#[from] util::Error), Util(#[from] util::Error),
#[error("failed to get availability cores")]
CanceledAvailabilityCores(#[source] oneshot::Canceled),
#[error("failed to get persisted validation data")]
CanceledPersistedValidationData(#[source] oneshot::Canceled),
#[error("failed to get block number")]
CanceledBlockNumber(#[source] oneshot::Canceled),
#[error("failed to get backed candidates")] #[error("failed to get backed candidates")]
CanceledBackedCandidates(#[source] oneshot::Canceled), CanceledBackedCandidates(#[source] oneshot::Canceled),
#[error("failed to get votes on dispute")]
CanceledCandidateVotes(#[source] oneshot::Canceled),
#[error(transparent)] #[error(transparent)]
ChainApi(#[from] ChainApiError), ChainApi(#[from] ChainApiError),
#[error(transparent)] #[error(transparent)]
Runtime(#[from] RuntimeApiError), Runtime(#[from] RuntimeApiError),
#[error("failed to send message to ChainAPI")]
ChainApiMessageSend(#[source] mpsc::SendError),
#[error("failed to send message to CandidateBacking to get backed candidates")]
GetBackedCandidatesSend(#[source] mpsc::SendError),
#[error("failed to send return message with Inherents")] #[error("failed to send return message with Inherents")]
InherentDataReturnChannel, InherentDataReturnChannel,
#[error(
"backed candidate does not correspond to selected candidate; check logic in provisioner"
)]
BackedCandidateOrderingProblem,
} }
impl JobTrait for ProvisioningJob { impl JobTrait for ProvisioningJob {
...@@ -168,10 +195,11 @@ impl ProvisioningJob { ...@@ -168,10 +195,11 @@ impl ProvisioningJob {
sender: &mut impl SubsystemSender, sender: &mut impl SubsystemSender,
span: PerLeafSpan, span: PerLeafSpan,
) -> Result<(), Error> { ) -> Result<(), Error> {
use ProvisionerMessage::{ProvisionableData, RequestInherentData};
loop { loop {
futures::select! { futures::select! {
msg = self.receiver.next() => match msg { msg = self.receiver.next() => match msg {
Some(ProvisionerMessage::RequestInherentData(_, return_sender)) => { Some(RequestInherentData(_, return_sender)) => {
let _span = span.child("req-inherent-data"); let _span = span.child("req-inherent-data");
let _timer = self.metrics.time_request_inherent_data(); let _timer = self.metrics.time_request_inherent_data();
...@@ -181,7 +209,7 @@ impl ProvisioningJob { ...@@ -181,7 +209,7 @@ impl ProvisioningJob {
self.awaiting_inherent.push(return_sender); self.awaiting_inherent.push(return_sender);
} }
} }
Some(ProvisionerMessage::ProvisionableData(_, data)) => { Some(ProvisionableData(_, data)) => {
let span = span.child("provisionable-data"); let span = span.child("provisionable-data");
let _timer = self.metrics.time_provisionable_data(); let _timer = self.metrics.time_provisionable_data();
...@@ -209,8 +237,8 @@ impl ProvisioningJob { ...@@ -209,8 +237,8 @@ impl ProvisioningJob {
) { ) {
if let Err(err) = send_inherent_data( if let Err(err) = send_inherent_data(
self.relay_parent, self.relay_parent,
self.signed_bitfields.clone(), &self.signed_bitfields,
self.backed_candidates.clone(), &self.backed_candidates,
return_senders, return_senders,
sender, sender,
&self.metrics, &self.metrics,
...@@ -243,26 +271,46 @@ impl ProvisioningJob { ...@@ -243,26 +271,46 @@ impl ProvisioningJob {
} }
} }
/// The provisioner is the subsystem best suited on the node side, type CoreAvailability = BitVec<bitvec::order::Lsb0, u8>;
/// yet it lacks sufficient information to do weight based inherents limiting.
/// This does the minimalistic checks and forwards a most likely /// The provisioner is the subsystem best suited to choosing which specific
/// too large set of bitfields, candidates, and dispute votes to /// backed candidates and availability bitfields should be assembled into the
/// the runtime. The `fn create_inherent` in the runtime is responsible /// block. To engage this functionality, a
/// to use a subset of these. /// `ProvisionerMessage::RequestInherentData` is sent; the response is a set of
/// non-conflicting candidates and the appropriate bitfields. Non-conflicting
/// means that there are never two distinct parachain candidates included for
/// the same parachain and that new parachain candidates cannot be included
/// until the previous one either gets declared available or expired.
///
/// The main complication here is going to be around handling
/// occupied-core-assumptions. We might have candidates that are only
/// includable when some bitfields are included. And we might have candidates
/// that are not includable when certain bitfields are included.
///
/// When we're choosing bitfields to include, the rule should be simple:
/// maximize availability. So basically, include all bitfields. And then
/// choose a coherent set of candidates along with that.
async fn send_inherent_data( async fn send_inherent_data(
relay_parent: Hash, relay_parent: Hash,
bitfields: SignedAvailabilityBitfields, bitfields: &[SignedAvailabilityBitfield],
candidate_receipts: Vec<CandidateReceipt>, candidates: &[CandidateReceipt],
return_senders: Vec<oneshot::Sender<ProvisionerInherentData>>, return_senders: Vec<oneshot::Sender<ProvisionerInherentData>>,
from_job: &mut impl SubsystemSender, from_job: &mut impl SubsystemSender,
metrics: &Metrics, metrics: &Metrics,
) -> Result<(), Error> { ) -> Result<(), Error> {
let backed_candidates = let availability_cores = request_availability_cores(relay_parent, from_job)
collect_backed_candidates(candidate_receipts, relay_parent, from_job).await?; .await
.await
.map_err(|err| Error::CanceledAvailabilityCores(err))??;
let disputes = collect_disputes(from_job, metrics).await?; let disputes = select_disputes(from_job, metrics).await?;
let bitfields = select_availability_bitfields(&availability_cores, bitfields);
let candidates =
select_candidates(&availability_cores, &bitfields, candidates, relay_parent, from_job)
.await?;
let inherent_data = ProvisionerInherentData { bitfields, backed_candidates, disputes }; let inherent_data =
ProvisionerInherentData { bitfields, backed_candidates: candidates, disputes };
for return_sender in return_senders { for return_sender in return_senders {
return_sender return_sender
...@@ -273,33 +321,120 @@ async fn send_inherent_data( ...@@ -273,33 +321,120 @@ async fn send_inherent_data(
Ok(()) Ok(())
} }
/// Collect backed candidates with a matching `relay_parent`. /// In general, we want to pick all the bitfields. However, we have the following constraints:
async fn collect_backed_candidates( ///
candidate_receipts: Vec<CandidateReceipt>, /// - not more than one per validator
/// - each 1 bit must correspond to an occupied core
///
/// If we have too many, an arbitrary selection policy is fine. For purposes of maximizing availability,
/// we pick the one with the greatest number of 1 bits.
///
/// Note: This does not enforce any sorting precondition on the output; the ordering there will be unrelated
/// to the sorting of the input.
fn select_availability_bitfields(
cores: &[CoreState],
bitfields: &[SignedAvailabilityBitfield],
) -> Vec<SignedAvailabilityBitfield> {
let mut selected: BTreeMap<ValidatorIndex, SignedAvailabilityBitfield> = BTreeMap::new();
'a: for bitfield in bitfields.iter().cloned() {
if bitfield.payload().0.len() != cores.len() {
continue
}
let is_better = selected
.get(&bitfield.validator_index())
.map_or(true, |b| b.payload().0.count_ones() < bitfield.payload().0.count_ones());
if !is_better {
continue
}
for (idx, _) in cores.iter().enumerate().filter(|v| !v.1.is_occupied()) {
// Bit is set for an unoccupied core - invalid
if *bitfield.payload().0.get(idx).as_deref().unwrap_or(&false) {
continue 'a
}
}
let _ = selected.insert(bitfield.validator_index(), bitfield);
}
selected.into_iter().map(|(_, b)| b).collect()
}
/// Determine which cores are free, and then to the degree possible, pick a candidate appropriate to each free core.
async fn select_candidates(
availability_cores: &[CoreState],
bitfields: &[SignedAvailabilityBitfield],
candidates: &[CandidateReceipt],
relay_parent: Hash, relay_parent: Hash,
sender: &mut impl SubsystemSender, sender: &mut impl SubsystemSender,
) -> Result<Vec<BackedCandidate>, Error> { ) -> Result<Vec<BackedCandidate>, Error> {
let max_one_candidate_per_para = HashSet::<ParaId>::with_capacity(candidate_receipts.len()); let block_number = get_block_number_under_construction(relay_parent, sender).await?;
let selected_candidates = candidate_receipts
.into_iter() let mut selected_candidates =
.filter(|candidate_receipt| { Vec::with_capacity(candidates.len().min(availability_cores.len()));
// assure the follow up query `GetBackedCandidate` succeeds
candidate_receipt.descriptor().relay_parent == relay_parent for (core_idx, core) in availability_cores.iter().enumerate() {
}) let (scheduled_core, assumption) = match core {
.scan(max_one_candidate_per_para, |unique, candidate_receipt| { CoreState::Scheduled(scheduled_core) => (scheduled_core, OccupiedCoreAssumption::Free),
let para_id = candidate_receipt.descriptor().para_id; CoreState::Occupied(occupied_core) => {
if unique.insert(para_id) { if bitfields_indicate_availability(core_idx, bitfields, &occupied_core.availability)
Some(candidate_receipt.hash()) {
if let Some(ref scheduled_core) = occupied_core.next_up_on_available {
(scheduled_core, OccupiedCoreAssumption::Included)
} else { } else {
tracing::debug!( continue
}
} else {
if occupied_core.time_out_at != block_number {
continue
}
if let Some(ref scheduled_core) = occupied_core.next_up_on_time_out {
(scheduled_core, OccupiedCoreAssumption::TimedOut)
} else {
continue
}
}
},
CoreState::Free => continue,
};
let validation_data = match request_persisted_validation_data(
relay_parent,
scheduled_core.para_id,
assumption,
sender,
)
.await
.await
.map_err(|err| Error::CanceledPersistedValidationData(err))??
{
Some(v) => v,
None => continue,
};
let computed_validation_data_hash = validation_data.hash();
// we arbitrarily pick the first of the backed candidates which match the appropriate selection criteria
if let Some(candidate) = candidates.iter().find(|backed_candidate| {
let descriptor = &backed_candidate.descriptor;
descriptor.para_id == scheduled_core.para_id &&
descriptor.persisted_validation_data_hash == computed_validation_data_hash
}) {
let candidate_hash = candidate.hash();
tracing::trace!(
target: LOG_TARGET, target: LOG_TARGET,
?para_id, "Selecting candidate {}. para_id={} core={}",