mirror of
https://github.com/sigp/lighthouse.git
synced 2026-03-04 17:21:44 +00:00
1168 lines
50 KiB
Rust
1168 lines
50 KiB
Rust
//! This module contains the logic for Lighthouse's backfill sync.
|
|
//!
|
|
//! This kind of sync occurs when a trusted state is provided to the client. The client
|
|
//! will perform a [`RangeSync`] to the latest head from the trusted state, such that the
|
|
//! client can perform its duties right away. Once completed, a backfill sync occurs, where all old
|
|
//! blocks (from genesis) are downloaded in order to keep a consistent history.
|
|
//!
|
|
//! If a batch fails, the backfill sync cannot progress. In this scenario, we mark the backfill
|
|
//! sync as failed, log an error and attempt to retry once a new peer joins the node.
|
|
|
|
use crate::network_beacon_processor::ChainSegmentProcessId;
|
|
use crate::sync::manager::{BatchProcessResult, Id};
|
|
use crate::sync::network_context::RangeRequestId;
|
|
use crate::sync::network_context::SyncNetworkContext;
|
|
use crate::sync::range_sync::{
|
|
BatchConfig, BatchId, BatchInfo, BatchOperationOutcome, BatchProcessingResult, BatchState,
|
|
};
|
|
use beacon_chain::block_verification_types::RpcBlock;
|
|
use beacon_chain::{BeaconChain, BeaconChainTypes};
|
|
use lighthouse_network::types::{BackFillState, NetworkGlobals};
|
|
use lighthouse_network::{PeerAction, PeerId};
|
|
use rand::seq::SliceRandom;
|
|
use slog::{crit, debug, error, info, warn};
|
|
use std::collections::{
|
|
btree_map::{BTreeMap, Entry},
|
|
HashMap, HashSet,
|
|
};
|
|
use std::sync::Arc;
|
|
use types::{Epoch, EthSpec};
|
|
|
|
/// Blocks are downloaded in batches from peers. This constant specifies how many epochs worth of
|
|
/// blocks per batch are requested _at most_. A batch may request less blocks to account for
|
|
/// already requested slots. There is a timeout for each batch request. If this value is too high,
|
|
/// we will negatively report peers with poor bandwidth. This can be set arbitrarily high, in which
|
|
/// case the responder will fill the response up to the max request size, assuming they have the
|
|
/// bandwidth to do so.
|
|
pub const BACKFILL_EPOCHS_PER_BATCH: u64 = 1;
|
|
|
|
/// The maximum number of batches to queue before requesting more.
|
|
const BACKFILL_BATCH_BUFFER_SIZE: u8 = 20;
|
|
|
|
/// The number of times to retry a batch before it is considered failed.
|
|
const MAX_BATCH_DOWNLOAD_ATTEMPTS: u8 = 10;
|
|
|
|
/// Invalid batches are attempted to be re-downloaded from other peers. If a batch cannot be processed
|
|
/// after `MAX_BATCH_PROCESSING_ATTEMPTS` times, it is considered faulty.
|
|
const MAX_BATCH_PROCESSING_ATTEMPTS: u8 = 10;
|
|
|
|
/// Custom configuration for the batch object.
|
|
struct BackFillBatchConfig {}
|
|
|
|
impl BatchConfig for BackFillBatchConfig {
|
|
fn max_batch_download_attempts() -> u8 {
|
|
MAX_BATCH_DOWNLOAD_ATTEMPTS
|
|
}
|
|
fn max_batch_processing_attempts() -> u8 {
|
|
MAX_BATCH_PROCESSING_ATTEMPTS
|
|
}
|
|
fn batch_attempt_hash<E: EthSpec>(blocks: &[RpcBlock<E>]) -> u64 {
|
|
use std::collections::hash_map::DefaultHasher;
|
|
use std::hash::{Hash, Hasher};
|
|
let mut hasher = DefaultHasher::new();
|
|
blocks.hash(&mut hasher);
|
|
hasher.finish()
|
|
}
|
|
}
|
|
|
|
/// Return type when attempting to start the backfill sync process.
|
|
pub enum SyncStart {
|
|
/// The chain started syncing or is already syncing.
|
|
Syncing {
|
|
/// The number of slots that have been processed so far.
|
|
completed: usize,
|
|
/// The number of slots still to be processed.
|
|
remaining: usize,
|
|
},
|
|
/// The chain didn't start syncing.
|
|
NotSyncing,
|
|
}
|
|
|
|
/// A standard result from calling public functions on [`BackFillSync`].
|
|
pub enum ProcessResult {
|
|
/// The call was successful.
|
|
Successful,
|
|
/// The call resulted in completing the backfill sync.
|
|
SyncCompleted,
|
|
}
|
|
|
|
/// The ways a backfill sync can fail.
|
|
// The info in the enum variants is displayed in logging, clippy thinks it's dead code.
|
|
#[derive(Debug)]
|
|
pub enum BackFillError {
|
|
/// A batch failed to be downloaded.
|
|
BatchDownloadFailed(#[allow(dead_code)] BatchId),
|
|
/// A batch could not be processed.
|
|
BatchProcessingFailed(#[allow(dead_code)] BatchId),
|
|
/// A batch entered an invalid state.
|
|
BatchInvalidState(#[allow(dead_code)] BatchId, #[allow(dead_code)] String),
|
|
/// The sync algorithm entered an invalid state.
|
|
InvalidSyncState(#[allow(dead_code)] String),
|
|
/// The chain became paused.
|
|
Paused,
|
|
}
|
|
|
|
pub struct BackFillSync<T: BeaconChainTypes> {
|
|
/// Keeps track of the current progress of the backfill.
|
|
/// This only gets refreshed from the beacon chain if we enter a failed state.
|
|
current_start: BatchId,
|
|
|
|
/// Starting epoch of the batch that needs to be processed next.
|
|
/// This is incremented as the chain advances.
|
|
processing_target: BatchId,
|
|
|
|
/// Starting epoch of the next batch that needs to be downloaded.
|
|
to_be_downloaded: BatchId,
|
|
|
|
/// Keeps track if we have requested the final batch.
|
|
last_batch_downloaded: bool,
|
|
|
|
/// Sorted map of batches undergoing some kind of processing.
|
|
batches: BTreeMap<BatchId, BatchInfo<T::EthSpec, BackFillBatchConfig>>,
|
|
|
|
/// List of peers we are currently awaiting a response for.
|
|
active_requests: HashMap<PeerId, HashSet<BatchId>>,
|
|
|
|
/// The current processing batch, if any.
|
|
current_processing_batch: Option<BatchId>,
|
|
|
|
/// Batches validated by this chain.
|
|
validated_batches: u64,
|
|
|
|
/// We keep track of peers that are participating in the backfill sync. Unlike RangeSync,
|
|
/// BackFillSync uses all synced peers to download the chain from. If BackFillSync fails, we don't
|
|
/// want to penalize all our synced peers, so we use this variable to keep track of peers that
|
|
/// have participated and only penalize these peers if backfill sync fails.
|
|
participating_peers: HashSet<PeerId>,
|
|
|
|
/// When a backfill sync fails, we keep track of whether a new fully synced peer has joined.
|
|
/// This signifies that we are able to attempt to restart a failed chain.
|
|
restart_failed_sync: bool,
|
|
|
|
/// Reference to the beacon chain to obtain initial starting points for the backfill sync.
|
|
beacon_chain: Arc<BeaconChain<T>>,
|
|
|
|
/// Reference to the network globals in order to obtain valid peers to backfill blocks from
|
|
/// (i.e synced peers).
|
|
network_globals: Arc<NetworkGlobals<T::EthSpec>>,
|
|
|
|
/// A logger for backfill sync.
|
|
log: slog::Logger,
|
|
}
|
|
|
|
impl<T: BeaconChainTypes> BackFillSync<T> {
|
|
pub fn new(
|
|
beacon_chain: Arc<BeaconChain<T>>,
|
|
network_globals: Arc<NetworkGlobals<T::EthSpec>>,
|
|
log: slog::Logger,
|
|
) -> Self {
|
|
// Determine if backfill is enabled or not.
|
|
// Get the anchor info, if this returns None, then backfill is not required for this
|
|
// running instance.
|
|
// If, for some reason a backfill has already been completed (or we've used a trusted
|
|
// genesis root) then backfill has been completed.
|
|
|
|
let (state, current_start) = match beacon_chain.store.get_anchor_info() {
|
|
Some(anchor_info) => {
|
|
if anchor_info.block_backfill_complete(beacon_chain.genesis_backfill_slot) {
|
|
(BackFillState::Completed, Epoch::new(0))
|
|
} else {
|
|
(
|
|
BackFillState::Paused,
|
|
anchor_info
|
|
.oldest_block_slot
|
|
.epoch(T::EthSpec::slots_per_epoch()),
|
|
)
|
|
}
|
|
}
|
|
None => (BackFillState::NotRequired, Epoch::new(0)),
|
|
};
|
|
|
|
let bfs = BackFillSync {
|
|
batches: BTreeMap::new(),
|
|
active_requests: HashMap::new(),
|
|
processing_target: current_start,
|
|
current_start,
|
|
last_batch_downloaded: false,
|
|
to_be_downloaded: current_start,
|
|
network_globals,
|
|
current_processing_batch: None,
|
|
validated_batches: 0,
|
|
participating_peers: HashSet::new(),
|
|
restart_failed_sync: false,
|
|
beacon_chain,
|
|
log,
|
|
};
|
|
|
|
// Update the global network state with the current backfill state.
|
|
bfs.set_state(state);
|
|
bfs
|
|
}
|
|
|
|
/// Pauses the backfill sync if it's currently syncing.
|
|
pub fn pause(&mut self) {
|
|
if let BackFillState::Syncing = self.state() {
|
|
debug!(self.log, "Backfill sync paused"; "processed_epochs" => self.validated_batches, "to_be_processed" => self.current_start);
|
|
self.set_state(BackFillState::Paused);
|
|
}
|
|
}
|
|
|
|
/// Starts or resumes syncing.
|
|
///
|
|
/// If resuming is successful, reports back the current syncing metrics.
|
|
#[must_use = "A failure here indicates the backfill sync has failed and the global sync state should be updated"]
|
|
pub fn start(
|
|
&mut self,
|
|
network: &mut SyncNetworkContext<T>,
|
|
) -> Result<SyncStart, BackFillError> {
|
|
match self.state() {
|
|
BackFillState::Syncing => {} // already syncing ignore.
|
|
BackFillState::Paused => {
|
|
if self
|
|
.network_globals
|
|
.peers
|
|
.read()
|
|
.synced_peers()
|
|
.next()
|
|
.is_some()
|
|
{
|
|
// If there are peers to resume with, begin the resume.
|
|
debug!(self.log, "Resuming backfill sync"; "start_epoch" => self.current_start, "awaiting_batches" => self.batches.len(), "processing_target" => self.processing_target);
|
|
self.set_state(BackFillState::Syncing);
|
|
// Resume any previously failed batches.
|
|
self.resume_batches(network)?;
|
|
// begin requesting blocks from the peer pool, until all peers are exhausted.
|
|
self.request_batches(network)?;
|
|
|
|
// start processing batches if needed
|
|
self.process_completed_batches(network)?;
|
|
} else {
|
|
return Ok(SyncStart::NotSyncing);
|
|
}
|
|
}
|
|
BackFillState::Failed => {
|
|
// Attempt to recover from a failed sync. All local variables should be reset and
|
|
// cleared already for a fresh start.
|
|
// We only attempt to restart a failed backfill sync if a new synced peer has been
|
|
// added.
|
|
if !self.restart_failed_sync {
|
|
return Ok(SyncStart::NotSyncing);
|
|
}
|
|
|
|
self.set_state(BackFillState::Syncing);
|
|
|
|
// Obtain a new start slot, from the beacon chain and handle possible errors.
|
|
match self.reset_start_epoch() {
|
|
Err(ResetEpochError::SyncCompleted) => {
|
|
error!(self.log, "Backfill sync completed whilst in failed status");
|
|
self.set_state(BackFillState::Completed);
|
|
return Err(BackFillError::InvalidSyncState(String::from(
|
|
"chain completed",
|
|
)));
|
|
}
|
|
Err(ResetEpochError::NotRequired) => {
|
|
error!(
|
|
self.log,
|
|
"Backfill sync not required whilst in failed status"
|
|
);
|
|
self.set_state(BackFillState::NotRequired);
|
|
return Err(BackFillError::InvalidSyncState(String::from(
|
|
"backfill not required",
|
|
)));
|
|
}
|
|
Ok(_) => {}
|
|
}
|
|
|
|
debug!(self.log, "Resuming a failed backfill sync"; "start_epoch" => self.current_start);
|
|
|
|
// begin requesting blocks from the peer pool, until all peers are exhausted.
|
|
self.request_batches(network)?;
|
|
}
|
|
BackFillState::Completed | BackFillState::NotRequired => {
|
|
return Ok(SyncStart::NotSyncing)
|
|
}
|
|
}
|
|
|
|
Ok(SyncStart::Syncing {
|
|
completed: (self.validated_batches
|
|
* BACKFILL_EPOCHS_PER_BATCH
|
|
* T::EthSpec::slots_per_epoch()) as usize,
|
|
remaining: self
|
|
.current_start
|
|
.start_slot(T::EthSpec::slots_per_epoch())
|
|
.saturating_sub(self.beacon_chain.genesis_backfill_slot)
|
|
.as_usize(),
|
|
})
|
|
}
|
|
|
|
/// A fully synced peer has joined us.
|
|
/// If we are in a failed state, update a local variable to indicate we are able to restart
|
|
/// the failed sync on the next attempt.
|
|
pub fn fully_synced_peer_joined(&mut self) {
|
|
if matches!(self.state(), BackFillState::Failed) {
|
|
self.restart_failed_sync = true;
|
|
}
|
|
}
|
|
|
|
/// A peer has disconnected.
|
|
/// If the peer has active batches, those are considered failed and re-requested.
|
|
#[must_use = "A failure here indicates the backfill sync has failed and the global sync state should be updated"]
|
|
pub fn peer_disconnected(&mut self, peer_id: &PeerId) -> Result<(), BackFillError> {
|
|
if matches!(
|
|
self.state(),
|
|
BackFillState::Failed | BackFillState::NotRequired
|
|
) {
|
|
return Ok(());
|
|
}
|
|
|
|
self.active_requests.remove(peer_id);
|
|
|
|
// Remove the peer from the participation list
|
|
self.participating_peers.remove(peer_id);
|
|
Ok(())
|
|
}
|
|
|
|
/// An RPC error has occurred.
|
|
///
|
|
/// If the batch exists it is re-requested.
|
|
#[must_use = "A failure here indicates the backfill sync has failed and the global sync state should be updated"]
|
|
pub fn inject_error(
|
|
&mut self,
|
|
network: &mut SyncNetworkContext<T>,
|
|
batch_id: BatchId,
|
|
peer_id: &PeerId,
|
|
request_id: Id,
|
|
) -> Result<(), BackFillError> {
|
|
if let Some(batch) = self.batches.get_mut(&batch_id) {
|
|
// A batch could be retried without the peer failing the request (disconnecting/
|
|
// sending an error /timeout) if the peer is removed from the chain for other
|
|
// reasons. Check that this block belongs to the expected peer
|
|
if !batch.is_expecting_block(peer_id, &request_id) {
|
|
return Ok(());
|
|
}
|
|
debug!(self.log, "Batch failed"; "batch_epoch" => batch_id, "error" => "rpc_error");
|
|
if let Some(active_requests) = self.active_requests.get_mut(peer_id) {
|
|
active_requests.remove(&batch_id);
|
|
}
|
|
match batch.download_failed(true) {
|
|
Err(e) => self.fail_sync(BackFillError::BatchInvalidState(batch_id, e.0)),
|
|
Ok(BatchOperationOutcome::Failed { blacklist: _ }) => {
|
|
self.fail_sync(BackFillError::BatchDownloadFailed(batch_id))
|
|
}
|
|
Ok(BatchOperationOutcome::Continue) => self.retry_batch_download(network, batch_id),
|
|
}
|
|
} else {
|
|
// this could be an error for an old batch, removed when the chain advances
|
|
Ok(())
|
|
}
|
|
}
|
|
|
|
/// A block has been received for a batch relating to this backfilling chain.
|
|
/// If the block correctly completes the batch it will be processed if possible.
|
|
/// If this returns an error, the backfill sync has failed and will be restarted once new peers
|
|
/// join the system.
|
|
/// The sync manager should update the global sync state on failure.
|
|
#[must_use = "A failure here indicates the backfill sync has failed and the global sync state should be updated"]
|
|
pub fn on_block_response(
|
|
&mut self,
|
|
network: &mut SyncNetworkContext<T>,
|
|
batch_id: BatchId,
|
|
peer_id: &PeerId,
|
|
request_id: Id,
|
|
beacon_block: Option<RpcBlock<T::EthSpec>>,
|
|
) -> Result<ProcessResult, BackFillError> {
|
|
// check if we have this batch
|
|
let batch = match self.batches.get_mut(&batch_id) {
|
|
None => {
|
|
if !matches!(self.state(), BackFillState::Failed) {
|
|
// A batch might get removed when the chain advances, so this is non fatal.
|
|
debug!(self.log, "Received a block for unknown batch"; "epoch" => batch_id);
|
|
}
|
|
return Ok(ProcessResult::Successful);
|
|
}
|
|
Some(batch) => {
|
|
// A batch could be retried without the peer failing the request (disconnecting/
|
|
// sending an error /timeout) if the peer is removed from the chain for other
|
|
// reasons. Check that this block belongs to the expected peer, and that the
|
|
// request_id matches
|
|
if !batch.is_expecting_block(peer_id, &request_id) {
|
|
return Ok(ProcessResult::Successful);
|
|
}
|
|
batch
|
|
}
|
|
};
|
|
|
|
if let Some(block) = beacon_block {
|
|
// This is not a stream termination, simply add the block to the request
|
|
if let Err(e) = batch.add_block(block) {
|
|
self.fail_sync(BackFillError::BatchInvalidState(batch_id, e.0))?;
|
|
}
|
|
Ok(ProcessResult::Successful)
|
|
} else {
|
|
// A stream termination has been sent. This batch has ended. Process a completed batch.
|
|
// Remove the request from the peer's active batches
|
|
self.active_requests
|
|
.get_mut(peer_id)
|
|
.map(|active_requests| active_requests.remove(&batch_id));
|
|
|
|
match batch.download_completed() {
|
|
Ok(received) => {
|
|
let awaiting_batches =
|
|
self.processing_target.saturating_sub(batch_id) / BACKFILL_EPOCHS_PER_BATCH;
|
|
debug!(self.log, "Completed batch received"; "epoch" => batch_id, "blocks" => received, "awaiting_batches" => awaiting_batches);
|
|
|
|
// pre-emptively request more blocks from peers whilst we process current blocks,
|
|
self.request_batches(network)?;
|
|
self.process_completed_batches(network)
|
|
}
|
|
Err(result) => {
|
|
let (expected_boundary, received_boundary, outcome) = match result {
|
|
Err(e) => {
|
|
return self
|
|
.fail_sync(BackFillError::BatchInvalidState(batch_id, e.0))
|
|
.map(|_| ProcessResult::Successful);
|
|
}
|
|
Ok(v) => v,
|
|
};
|
|
warn!(self.log, "Batch received out of range blocks"; "expected_boundary" => expected_boundary, "received_boundary" => received_boundary,
|
|
"peer_id" => %peer_id, batch);
|
|
|
|
if let BatchOperationOutcome::Failed { blacklist: _ } = outcome {
|
|
error!(self.log, "Backfill failed"; "epoch" => batch_id, "received_boundary" => received_boundary, "expected_boundary" => expected_boundary);
|
|
return self
|
|
.fail_sync(BackFillError::BatchDownloadFailed(batch_id))
|
|
.map(|_| ProcessResult::Successful);
|
|
}
|
|
// this batch can't be used, so we need to request it again.
|
|
self.retry_batch_download(network, batch_id)
|
|
.map(|_| ProcessResult::Successful)
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
/// The syncing process has failed.
|
|
///
|
|
/// This resets past variables, to allow for a fresh start when resuming.
|
|
fn fail_sync(&mut self, error: BackFillError) -> Result<(), BackFillError> {
|
|
// Some errors shouldn't fail the chain.
|
|
if matches!(error, BackFillError::Paused) {
|
|
return Ok(());
|
|
}
|
|
|
|
// Set the state
|
|
self.set_state(BackFillState::Failed);
|
|
// Remove all batches and active requests and participating peers.
|
|
self.batches.clear();
|
|
self.active_requests.clear();
|
|
self.participating_peers.clear();
|
|
self.restart_failed_sync = false;
|
|
|
|
// Reset all downloading and processing targets
|
|
self.processing_target = self.current_start;
|
|
self.to_be_downloaded = self.current_start;
|
|
self.last_batch_downloaded = false;
|
|
self.current_processing_batch = None;
|
|
|
|
// NOTE: Lets keep validated_batches for posterity
|
|
|
|
// Emit the log here
|
|
error!(self.log, "Backfill sync failed"; "error" => ?error);
|
|
|
|
// Return the error, kinda weird pattern, but I want to use
|
|
// `self.fail_chain(_)?` in other parts of the code.
|
|
Err(error)
|
|
}
|
|
|
|
/// Processes the batch with the given id.
|
|
/// The batch must exist and be ready for processing
|
|
fn process_batch(
|
|
&mut self,
|
|
network: &mut SyncNetworkContext<T>,
|
|
batch_id: BatchId,
|
|
) -> Result<ProcessResult, BackFillError> {
|
|
// Only process batches if this chain is Syncing, and only one at a time
|
|
if self.state() != BackFillState::Syncing || self.current_processing_batch.is_some() {
|
|
return Ok(ProcessResult::Successful);
|
|
}
|
|
|
|
let Some(batch) = self.batches.get_mut(&batch_id) else {
|
|
return self
|
|
.fail_sync(BackFillError::InvalidSyncState(format!(
|
|
"Trying to process a batch that does not exist: {}",
|
|
batch_id
|
|
)))
|
|
.map(|_| ProcessResult::Successful);
|
|
};
|
|
|
|
// NOTE: We send empty batches to the processor in order to trigger the block processor
|
|
// result callback. This is done, because an empty batch could end a chain and the logic
|
|
// for removing chains and checking completion is in the callback.
|
|
|
|
let blocks = match batch.start_processing() {
|
|
Err(e) => {
|
|
return self
|
|
.fail_sync(BackFillError::BatchInvalidState(batch_id, e.0))
|
|
.map(|_| ProcessResult::Successful)
|
|
}
|
|
Ok(v) => v,
|
|
};
|
|
|
|
let process_id = ChainSegmentProcessId::BackSyncBatchId(batch_id);
|
|
self.current_processing_batch = Some(batch_id);
|
|
|
|
if let Err(e) = network
|
|
.beacon_processor()
|
|
.send_chain_segment(process_id, blocks)
|
|
{
|
|
crit!(self.log, "Failed to send backfill segment to processor."; "msg" => "process_batch",
|
|
"error" => %e, "batch" => self.processing_target);
|
|
// This is unlikely to happen but it would stall syncing since the batch now has no
|
|
// blocks to continue, and the chain is expecting a processing result that won't
|
|
// arrive. To mitigate this, (fake) fail this processing so that the batch is
|
|
// re-downloaded.
|
|
self.on_batch_process_result(network, batch_id, &BatchProcessResult::NonFaultyFailure)
|
|
} else {
|
|
Ok(ProcessResult::Successful)
|
|
}
|
|
}
|
|
|
|
/// The block processor has completed processing a batch. This function handles the result
|
|
/// of the batch processor.
|
|
/// If an error is returned the BackFill sync has failed.
|
|
#[must_use = "A failure here indicates the backfill sync has failed and the global sync state should be updated"]
|
|
pub fn on_batch_process_result(
|
|
&mut self,
|
|
network: &mut SyncNetworkContext<T>,
|
|
batch_id: BatchId,
|
|
result: &BatchProcessResult,
|
|
) -> Result<ProcessResult, BackFillError> {
|
|
// The first two cases are possible in regular sync, should not occur in backfill, but we
|
|
// keep this logic for handling potential processing race conditions.
|
|
// result
|
|
let batch = match &self.current_processing_batch {
|
|
Some(processing_id) if *processing_id != batch_id => {
|
|
debug!(self.log, "Unexpected batch result";
|
|
"batch_epoch" => batch_id, "expected_batch_epoch" => processing_id);
|
|
return Ok(ProcessResult::Successful);
|
|
}
|
|
None => {
|
|
debug!(self.log, "Chain was not expecting a batch result";
|
|
"batch_epoch" => batch_id);
|
|
return Ok(ProcessResult::Successful);
|
|
}
|
|
_ => {
|
|
// batch_id matches, continue
|
|
self.current_processing_batch = None;
|
|
|
|
match self.batches.get_mut(&batch_id) {
|
|
Some(batch) => batch,
|
|
None => {
|
|
// This is an error. Fail the sync algorithm.
|
|
return self
|
|
.fail_sync(BackFillError::InvalidSyncState(format!(
|
|
"Current processing batch not found: {}",
|
|
batch_id
|
|
)))
|
|
.map(|_| ProcessResult::Successful);
|
|
}
|
|
}
|
|
}
|
|
};
|
|
|
|
let peer = match batch.current_peer() {
|
|
Some(v) => *v,
|
|
None => {
|
|
return self
|
|
.fail_sync(BackFillError::BatchInvalidState(
|
|
batch_id,
|
|
String::from("Peer does not exist"),
|
|
))
|
|
.map(|_| ProcessResult::Successful)
|
|
}
|
|
};
|
|
|
|
debug!(self.log, "Backfill batch processed"; "result" => ?result, &batch,
|
|
"batch_epoch" => batch_id, "peer" => %peer, "client" => %network.client_type(&peer));
|
|
|
|
match result {
|
|
BatchProcessResult::Success { was_non_empty } => {
|
|
if let Err(e) = batch.processing_completed(BatchProcessingResult::Success) {
|
|
self.fail_sync(BackFillError::BatchInvalidState(batch_id, e.0))?;
|
|
}
|
|
// If the processed batch was not empty, we can validate previous unvalidated
|
|
// blocks.
|
|
if *was_non_empty {
|
|
self.advance_chain(network, batch_id);
|
|
}
|
|
|
|
if batch_id == self.processing_target {
|
|
self.processing_target = self
|
|
.processing_target
|
|
.saturating_sub(BACKFILL_EPOCHS_PER_BATCH);
|
|
}
|
|
|
|
// check if the chain has completed syncing
|
|
if self.check_completed() {
|
|
// chain is completed
|
|
info!(self.log, "Backfill sync completed"; "blocks_processed" => self.validated_batches * T::EthSpec::slots_per_epoch());
|
|
self.set_state(BackFillState::Completed);
|
|
Ok(ProcessResult::SyncCompleted)
|
|
} else {
|
|
// chain is not completed
|
|
// attempt to request more batches
|
|
self.request_batches(network)?;
|
|
// attempt to process more batches
|
|
self.process_completed_batches(network)
|
|
}
|
|
}
|
|
BatchProcessResult::FaultyFailure {
|
|
imported_blocks,
|
|
penalty,
|
|
} => {
|
|
match batch.processing_completed(BatchProcessingResult::FaultyFailure) {
|
|
Err(e) => {
|
|
// Batch was in the wrong state
|
|
self.fail_sync(BackFillError::BatchInvalidState(batch_id, e.0))
|
|
.map(|_| ProcessResult::Successful)
|
|
}
|
|
Ok(BatchOperationOutcome::Failed { blacklist: _ }) => {
|
|
// check that we have not exceeded the re-process retry counter
|
|
// If a batch has exceeded the invalid batch lookup attempts limit, it means
|
|
// that it is likely all peers are sending invalid batches
|
|
// repeatedly and are either malicious or faulty. We stop the backfill sync and
|
|
// report all synced peers that have participated.
|
|
warn!(
|
|
self.log,
|
|
"Backfill batch failed to download. Penalizing peers";
|
|
"score_adjustment" => %penalty,
|
|
"batch_epoch"=> batch_id
|
|
);
|
|
|
|
for peer in self.participating_peers.drain() {
|
|
network.report_peer(peer, *penalty, "backfill_batch_failed");
|
|
}
|
|
self.fail_sync(BackFillError::BatchProcessingFailed(batch_id))
|
|
.map(|_| ProcessResult::Successful)
|
|
}
|
|
|
|
Ok(BatchOperationOutcome::Continue) => {
|
|
// chain can continue. Check if it can be progressed
|
|
if *imported_blocks {
|
|
// At least one block was successfully verified and imported, then we can be sure all
|
|
// previous batches are valid and we only need to download the current failed
|
|
// batch.
|
|
self.advance_chain(network, batch_id);
|
|
}
|
|
// Handle this invalid batch, that is within the re-process retries limit.
|
|
self.handle_invalid_batch(network, batch_id)
|
|
.map(|_| ProcessResult::Successful)
|
|
}
|
|
}
|
|
}
|
|
BatchProcessResult::NonFaultyFailure => {
|
|
if let Err(e) = batch.processing_completed(BatchProcessingResult::NonFaultyFailure)
|
|
{
|
|
self.fail_sync(BackFillError::BatchInvalidState(batch_id, e.0))?;
|
|
}
|
|
self.retry_batch_download(network, batch_id)
|
|
.map(|_| ProcessResult::Successful)
|
|
}
|
|
}
|
|
}
|
|
|
|
/// Processes the next ready batch.
|
|
fn process_completed_batches(
|
|
&mut self,
|
|
network: &mut SyncNetworkContext<T>,
|
|
) -> Result<ProcessResult, BackFillError> {
|
|
// Only process batches if backfill is syncing and only process one batch at a time
|
|
if self.state() != BackFillState::Syncing || self.current_processing_batch.is_some() {
|
|
return Ok(ProcessResult::Successful);
|
|
}
|
|
|
|
// Find the id of the batch we are going to process.
|
|
if let Some(batch) = self.batches.get(&self.processing_target) {
|
|
let state = batch.state();
|
|
match state {
|
|
BatchState::AwaitingProcessing(..) => {
|
|
return self.process_batch(network, self.processing_target);
|
|
}
|
|
BatchState::Downloading(..) => {
|
|
// Batch is not ready, nothing to process
|
|
}
|
|
BatchState::Poisoned => unreachable!("Poisoned batch"),
|
|
BatchState::Failed | BatchState::AwaitingDownload | BatchState::Processing(_) => {
|
|
// these are all inconsistent states:
|
|
// - Failed -> non recoverable batch. Chain should have been removed
|
|
// - AwaitingDownload -> A recoverable failed batch should have been
|
|
// re-requested.
|
|
// - Processing -> `self.current_processing_batch` is None
|
|
return self
|
|
.fail_sync(BackFillError::InvalidSyncState(String::from(
|
|
"Invalid expected batch state",
|
|
)))
|
|
.map(|_| ProcessResult::Successful);
|
|
}
|
|
BatchState::AwaitingValidation(_) => {
|
|
// TODO: I don't think this state is possible, log a CRIT just in case.
|
|
// If this is not observed, add it to the failed state branch above.
|
|
crit!(self.log, "Chain encountered a robust batch awaiting validation"; "batch" => self.processing_target);
|
|
|
|
self.processing_target -= BACKFILL_EPOCHS_PER_BATCH;
|
|
if self.to_be_downloaded >= self.processing_target {
|
|
self.to_be_downloaded = self.processing_target - BACKFILL_EPOCHS_PER_BATCH;
|
|
}
|
|
self.request_batches(network)?;
|
|
}
|
|
}
|
|
} else {
|
|
return self
|
|
.fail_sync(BackFillError::InvalidSyncState(format!(
|
|
"Batch not found for current processing target {}",
|
|
self.processing_target
|
|
)))
|
|
.map(|_| ProcessResult::Successful);
|
|
}
|
|
Ok(ProcessResult::Successful)
|
|
}
|
|
|
|
/// Removes any batches previous to the given `validating_epoch` and updates the current
|
|
/// boundaries of the chain.
|
|
///
|
|
/// The `validating_epoch` must align with batch boundaries.
|
|
///
|
|
/// If a previous batch has been validated and it had been re-processed, penalize the original
|
|
/// peer.
|
|
fn advance_chain(&mut self, network: &mut SyncNetworkContext<T>, validating_epoch: Epoch) {
|
|
// make sure this epoch produces an advancement
|
|
if validating_epoch >= self.current_start {
|
|
return;
|
|
}
|
|
|
|
// We can now validate higher batches that the current batch. Here we remove all
|
|
// batches that are higher than the current batch. We add on an extra
|
|
// `BACKFILL_EPOCHS_PER_BATCH` as `split_off` is inclusive.
|
|
let removed_batches = self
|
|
.batches
|
|
.split_off(&(validating_epoch + BACKFILL_EPOCHS_PER_BATCH));
|
|
|
|
for (id, batch) in removed_batches.into_iter() {
|
|
self.validated_batches = self.validated_batches.saturating_add(1);
|
|
// only for batches awaiting validation can we be sure the last attempt is
|
|
// right, and thus, that any different attempt is wrong
|
|
match batch.state() {
|
|
BatchState::AwaitingValidation(ref processed_attempt) => {
|
|
for attempt in batch.attempts() {
|
|
// The validated batch has been re-processed
|
|
if attempt.hash != processed_attempt.hash {
|
|
// The re-downloaded version was different.
|
|
if processed_attempt.peer_id != attempt.peer_id {
|
|
// A different peer sent the correct batch, the previous peer did not
|
|
// We negatively score the original peer.
|
|
let action = PeerAction::LowToleranceError;
|
|
debug!(self.log, "Re-processed batch validated. Scoring original peer";
|
|
"batch_epoch" => id, "score_adjustment" => %action,
|
|
"original_peer" => %attempt.peer_id, "new_peer" => %processed_attempt.peer_id
|
|
);
|
|
network.report_peer(
|
|
attempt.peer_id,
|
|
action,
|
|
"backfill_reprocessed_original_peer",
|
|
);
|
|
} else {
|
|
// The same peer corrected it's previous mistake. There was an error, so we
|
|
// negative score the original peer.
|
|
let action = PeerAction::MidToleranceError;
|
|
debug!(self.log, "Re-processed batch validated by the same peer";
|
|
"batch_epoch" => id, "score_adjustment" => %action,
|
|
"original_peer" => %attempt.peer_id, "new_peer" => %processed_attempt.peer_id
|
|
);
|
|
network.report_peer(
|
|
attempt.peer_id,
|
|
action,
|
|
"backfill_reprocessed_same_peer",
|
|
);
|
|
}
|
|
}
|
|
}
|
|
}
|
|
BatchState::Downloading(peer, ..) => {
|
|
// remove this batch from the peer's active requests
|
|
if let Some(active_requests) = self.active_requests.get_mut(peer) {
|
|
active_requests.remove(&id);
|
|
}
|
|
}
|
|
BatchState::Failed | BatchState::Poisoned | BatchState::AwaitingDownload => {
|
|
crit!(
|
|
self.log,
|
|
"batch indicates inconsistent chain state while advancing chain"
|
|
)
|
|
}
|
|
BatchState::AwaitingProcessing(..) => {}
|
|
BatchState::Processing(_) => {
|
|
debug!(self.log, "Advancing chain while processing a batch"; "batch" => id, batch);
|
|
if let Some(processing_id) = self.current_processing_batch {
|
|
if id >= processing_id {
|
|
self.current_processing_batch = None;
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
self.processing_target = self.processing_target.min(validating_epoch);
|
|
self.current_start = validating_epoch;
|
|
self.to_be_downloaded = self.to_be_downloaded.min(validating_epoch);
|
|
if self.batches.contains_key(&self.to_be_downloaded) {
|
|
// if a chain is advanced by Range beyond the previous `self.to_be_downloaded`, we
|
|
// won't have this batch, so we need to request it.
|
|
self.to_be_downloaded -= BACKFILL_EPOCHS_PER_BATCH;
|
|
}
|
|
debug!(self.log, "Backfill advanced"; "validated_epoch" => validating_epoch, "processing_target" => self.processing_target);
|
|
}
|
|
|
|
/// An invalid batch has been received that could not be processed, but that can be retried.
|
|
///
|
|
/// These events occur when a peer has successfully responded with blocks, but the blocks we
|
|
/// have received are incorrect or invalid. This indicates the peer has not performed as
|
|
/// intended and can result in downvoting a peer.
|
|
fn handle_invalid_batch(
|
|
&mut self,
|
|
network: &mut SyncNetworkContext<T>,
|
|
batch_id: BatchId,
|
|
) -> Result<(), BackFillError> {
|
|
// The current batch could not be processed, indicating either the current or previous
|
|
// batches are invalid.
|
|
|
|
// The previous batch could be incomplete due to the block sizes being too large to fit in
|
|
// a single RPC request or there could be consecutive empty batches which are not supposed
|
|
// to be there
|
|
|
|
// The current (sub-optimal) strategy is to simply re-request all batches that could
|
|
// potentially be faulty. If a batch returns a different result than the original and
|
|
// results in successful processing, we downvote the original peer that sent us the batch.
|
|
|
|
// this is our robust `processing_target`. All previous batches must be awaiting
|
|
// validation
|
|
let mut redownload_queue = Vec::new();
|
|
|
|
for (id, batch) in self
|
|
.batches
|
|
.iter_mut()
|
|
.filter(|(&id, _batch)| id > batch_id)
|
|
{
|
|
match batch
|
|
.validation_failed()
|
|
.map_err(|e| BackFillError::BatchInvalidState(batch_id, e.0))?
|
|
{
|
|
BatchOperationOutcome::Failed { blacklist: _ } => {
|
|
// Batch has failed and cannot be redownloaded.
|
|
return self.fail_sync(BackFillError::BatchProcessingFailed(batch_id));
|
|
}
|
|
BatchOperationOutcome::Continue => {
|
|
redownload_queue.push(*id);
|
|
}
|
|
}
|
|
}
|
|
|
|
// no batch maxed out it process attempts, so now the chain's volatile progress must be
|
|
// reset
|
|
self.processing_target = self.current_start;
|
|
|
|
for id in redownload_queue {
|
|
self.retry_batch_download(network, id)?;
|
|
}
|
|
// finally, re-request the failed batch.
|
|
self.retry_batch_download(network, batch_id)
|
|
}
|
|
|
|
/// Sends and registers the request of a batch awaiting download.
|
|
fn retry_batch_download(
|
|
&mut self,
|
|
network: &mut SyncNetworkContext<T>,
|
|
batch_id: BatchId,
|
|
) -> Result<(), BackFillError> {
|
|
let Some(batch) = self.batches.get_mut(&batch_id) else {
|
|
return Ok(());
|
|
};
|
|
|
|
// Find a peer to request the batch
|
|
let failed_peers = batch.failed_peers();
|
|
|
|
let new_peer = {
|
|
let mut priorized_peers = self
|
|
.network_globals
|
|
.peers
|
|
.read()
|
|
.synced_peers()
|
|
.map(|peer| {
|
|
(
|
|
failed_peers.contains(peer),
|
|
self.active_requests.get(peer).map(|v| v.len()).unwrap_or(0),
|
|
*peer,
|
|
)
|
|
})
|
|
.collect::<Vec<_>>();
|
|
// Sort peers prioritizing unrelated peers with less active requests.
|
|
priorized_peers.sort_unstable();
|
|
priorized_peers.first().map(|&(_, _, peer)| peer)
|
|
};
|
|
|
|
if let Some(peer) = new_peer {
|
|
self.participating_peers.insert(peer);
|
|
self.send_batch(network, batch_id, peer)
|
|
} else {
|
|
// If we are here the chain has no more synced peers
|
|
info!(self.log, "Backfill sync paused"; "reason" => "insufficient_synced_peers");
|
|
self.set_state(BackFillState::Paused);
|
|
Err(BackFillError::Paused)
|
|
}
|
|
}
|
|
|
|
/// Requests the batch assigned to the given id from a given peer.
|
|
fn send_batch(
|
|
&mut self,
|
|
network: &mut SyncNetworkContext<T>,
|
|
batch_id: BatchId,
|
|
peer: PeerId,
|
|
) -> Result<(), BackFillError> {
|
|
if let Some(batch) = self.batches.get_mut(&batch_id) {
|
|
let (request, is_blob_batch) = batch.to_blocks_by_range_request();
|
|
match network.blocks_and_blobs_by_range_request(
|
|
peer,
|
|
is_blob_batch,
|
|
request,
|
|
RangeRequestId::BackfillSync { batch_id },
|
|
) {
|
|
Ok(request_id) => {
|
|
// inform the batch about the new request
|
|
if let Err(e) = batch.start_downloading_from_peer(peer, request_id) {
|
|
return self.fail_sync(BackFillError::BatchInvalidState(batch_id, e.0));
|
|
}
|
|
debug!(self.log, "Requesting batch"; "epoch" => batch_id, &batch);
|
|
|
|
// register the batch for this peer
|
|
self.active_requests
|
|
.entry(peer)
|
|
.or_default()
|
|
.insert(batch_id);
|
|
return Ok(());
|
|
}
|
|
Err(e) => {
|
|
// NOTE: under normal conditions this shouldn't happen but we handle it anyway
|
|
warn!(self.log, "Could not send batch request";
|
|
"batch_id" => batch_id, "error" => ?e, &batch);
|
|
// register the failed download and check if the batch can be retried
|
|
if let Err(e) = batch.start_downloading_from_peer(peer, 1) {
|
|
return self.fail_sync(BackFillError::BatchInvalidState(batch_id, e.0));
|
|
}
|
|
self.active_requests
|
|
.get_mut(&peer)
|
|
.map(|request| request.remove(&batch_id));
|
|
|
|
match batch.download_failed(true) {
|
|
Err(e) => {
|
|
self.fail_sync(BackFillError::BatchInvalidState(batch_id, e.0))?
|
|
}
|
|
Ok(BatchOperationOutcome::Failed { blacklist: _ }) => {
|
|
self.fail_sync(BackFillError::BatchDownloadFailed(batch_id))?
|
|
}
|
|
Ok(BatchOperationOutcome::Continue) => {
|
|
return self.retry_batch_download(network, batch_id)
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
Ok(())
|
|
}
|
|
|
|
/// When resuming a chain, this function searches for batches that need to be re-downloaded and
|
|
/// transitions their state to redownload the batch.
|
|
fn resume_batches(&mut self, network: &mut SyncNetworkContext<T>) -> Result<(), BackFillError> {
|
|
let batch_ids_to_retry = self
|
|
.batches
|
|
.iter()
|
|
.filter_map(|(batch_id, batch)| {
|
|
// In principle there should only ever be on of these, and we could terminate the
|
|
// loop early, however the processing is negligible and we continue the search
|
|
// for robustness to handle potential future modification
|
|
if matches!(batch.state(), BatchState::AwaitingDownload) {
|
|
Some(*batch_id)
|
|
} else {
|
|
None
|
|
}
|
|
})
|
|
.collect::<Vec<_>>();
|
|
|
|
for batch_id in batch_ids_to_retry {
|
|
self.retry_batch_download(network, batch_id)?;
|
|
}
|
|
Ok(())
|
|
}
|
|
|
|
/// Attempts to request the next required batches from the peer pool if the chain is syncing. It will exhaust the peer
|
|
/// pool and left over batches until the batch buffer is reached or all peers are exhausted.
|
|
fn request_batches(
|
|
&mut self,
|
|
network: &mut SyncNetworkContext<T>,
|
|
) -> Result<(), BackFillError> {
|
|
if !matches!(self.state(), BackFillState::Syncing) {
|
|
return Ok(());
|
|
}
|
|
|
|
// find the next pending batch and request it from the peer
|
|
|
|
// randomize the peers for load balancing
|
|
let mut rng = rand::thread_rng();
|
|
let mut idle_peers = self
|
|
.network_globals
|
|
.peers
|
|
.read()
|
|
.synced_peers()
|
|
.filter(|peer_id| {
|
|
self.active_requests
|
|
.get(peer_id)
|
|
.map(|requests| requests.is_empty())
|
|
.unwrap_or(true)
|
|
})
|
|
.cloned()
|
|
.collect::<Vec<_>>();
|
|
|
|
idle_peers.shuffle(&mut rng);
|
|
|
|
while let Some(peer) = idle_peers.pop() {
|
|
if let Some(batch_id) = self.include_next_batch(network) {
|
|
// send the batch
|
|
self.send_batch(network, batch_id, peer)?;
|
|
} else {
|
|
// No more batches, simply stop
|
|
return Ok(());
|
|
}
|
|
}
|
|
Ok(())
|
|
}
|
|
|
|
/// Creates the next required batch from the chain. If there are no more batches required,
|
|
/// `false` is returned.
|
|
fn include_next_batch(&mut self, network: &mut SyncNetworkContext<T>) -> Option<BatchId> {
|
|
// don't request batches beyond genesis;
|
|
if self.last_batch_downloaded {
|
|
return None;
|
|
}
|
|
|
|
// only request batches up to the buffer size limit
|
|
// NOTE: we don't count batches in the AwaitingValidation state, to prevent stalling sync
|
|
// if the current processing window is contained in a long range of skip slots.
|
|
let in_buffer = |batch: &BatchInfo<T::EthSpec, BackFillBatchConfig>| {
|
|
matches!(
|
|
batch.state(),
|
|
BatchState::Downloading(..) | BatchState::AwaitingProcessing(..)
|
|
)
|
|
};
|
|
if self
|
|
.batches
|
|
.iter()
|
|
.filter(|&(_epoch, batch)| in_buffer(batch))
|
|
.count()
|
|
> BACKFILL_BATCH_BUFFER_SIZE as usize
|
|
{
|
|
return None;
|
|
}
|
|
|
|
let batch_id = self.to_be_downloaded;
|
|
// this batch could have been included already being an optimistic batch
|
|
match self.batches.entry(batch_id) {
|
|
Entry::Occupied(_) => {
|
|
// this batch doesn't need downloading, let this same function decide the next batch
|
|
if self.would_complete(batch_id) {
|
|
self.last_batch_downloaded = true;
|
|
}
|
|
|
|
self.to_be_downloaded = self
|
|
.to_be_downloaded
|
|
.saturating_sub(BACKFILL_EPOCHS_PER_BATCH);
|
|
self.include_next_batch(network)
|
|
}
|
|
Entry::Vacant(entry) => {
|
|
let batch_type = network.batch_type(batch_id);
|
|
entry.insert(BatchInfo::new(
|
|
&batch_id,
|
|
BACKFILL_EPOCHS_PER_BATCH,
|
|
batch_type,
|
|
));
|
|
if self.would_complete(batch_id) {
|
|
self.last_batch_downloaded = true;
|
|
}
|
|
self.to_be_downloaded = self
|
|
.to_be_downloaded
|
|
.saturating_sub(BACKFILL_EPOCHS_PER_BATCH);
|
|
Some(batch_id)
|
|
}
|
|
}
|
|
}
|
|
|
|
/// Resets the start epoch based on the beacon chain.
|
|
///
|
|
/// This errors if the beacon chain indicates that backfill sync has already completed or is
|
|
/// not required.
|
|
fn reset_start_epoch(&mut self) -> Result<(), ResetEpochError> {
|
|
if let Some(anchor_info) = self.beacon_chain.store.get_anchor_info() {
|
|
if anchor_info.block_backfill_complete(self.beacon_chain.genesis_backfill_slot) {
|
|
Err(ResetEpochError::SyncCompleted)
|
|
} else {
|
|
self.current_start = anchor_info
|
|
.oldest_block_slot
|
|
.epoch(T::EthSpec::slots_per_epoch());
|
|
Ok(())
|
|
}
|
|
} else {
|
|
Err(ResetEpochError::NotRequired)
|
|
}
|
|
}
|
|
|
|
/// Checks with the beacon chain if backfill sync has completed.
|
|
fn check_completed(&mut self) -> bool {
|
|
if self.would_complete(self.current_start) {
|
|
// Check that the beacon chain agrees
|
|
if let Some(anchor_info) = self.beacon_chain.store.get_anchor_info() {
|
|
// Conditions that we have completed a backfill sync
|
|
if anchor_info.block_backfill_complete(self.beacon_chain.genesis_backfill_slot) {
|
|
return true;
|
|
} else {
|
|
error!(self.log, "Backfill out of sync with beacon chain");
|
|
}
|
|
}
|
|
}
|
|
false
|
|
}
|
|
|
|
/// Checks if backfill would complete by syncing to `start_epoch`.
|
|
fn would_complete(&self, start_epoch: Epoch) -> bool {
|
|
start_epoch
|
|
<= self
|
|
.beacon_chain
|
|
.genesis_backfill_slot
|
|
.epoch(T::EthSpec::slots_per_epoch())
|
|
}
|
|
|
|
/// Updates the global network state indicating the current state of a backfill sync.
|
|
fn set_state(&self, state: BackFillState) {
|
|
*self.network_globals.backfill_state.write() = state;
|
|
}
|
|
|
|
fn state(&self) -> BackFillState {
|
|
self.network_globals.backfill_state.read().clone()
|
|
}
|
|
}
|
|
|
|
/// Error kind for attempting to restart the sync from beacon chain parameters.
|
|
enum ResetEpochError {
|
|
/// The chain has already completed.
|
|
SyncCompleted,
|
|
/// Backfill is not required.
|
|
NotRequired,
|
|
}
|