1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321
use massa_channel::sender::MassaSender;
use massa_consensus_exports::ConsensusBroadcasts;
use massa_consensus_exports::{
block_graph_export::BlockGraphExport, block_status::BlockStatus,
bootstrapable_graph::BootstrapableGraph, error::ConsensusError,
export_active_block::ExportActiveBlock, ConsensusController,
};
use massa_models::{
block::{BlockGraphStatus, FilledBlock},
block_header::BlockHeader,
block_id::BlockId,
clique::Clique,
operation::{Operation, OperationId},
prehash::PreHashSet,
secure_share::SecureShare,
slot::Slot,
stats::ConsensusStats,
streaming_step::StreamingStep,
};
use massa_storage::Storage;
use parking_lot::RwLock;
use std::sync::Arc;
use tracing::{debug, trace, warn};
use crate::{commands::ConsensusCommand, state::ConsensusState};
/// The retrieval of data is made using a shared state and modifications are asked by sending message to a channel.
/// This is done mostly to be able to:
///
/// - send commands through the channel without waiting for them to be processed from the point of view of the sending thread, and channels are very much optimal for that (much faster than locks)
/// - still be able to read the current state of the graph as processed so far (for this we need a shared state)
///
/// Note that sending commands and reading the state is done from different, mutually-asynchronous tasks and they can have data that are not sync yet.
#[derive(Clone)]
pub struct ConsensusControllerImpl {
command_sender: MassaSender<ConsensusCommand>,
broadcasts: ConsensusBroadcasts,
shared_state: Arc<RwLock<ConsensusState>>,
bootstrap_part_size: u64,
broadcast_enabled: bool,
}
impl ConsensusControllerImpl {
pub fn new(
command_sender: MassaSender<ConsensusCommand>,
broadcasts: ConsensusBroadcasts,
shared_state: Arc<RwLock<ConsensusState>>,
bootstrap_part_size: u64,
broadcast_enabled: bool,
) -> Self {
Self {
command_sender,
broadcasts,
shared_state,
bootstrap_part_size,
broadcast_enabled,
}
}
}
impl ConsensusController for ConsensusControllerImpl {
/// Get a block graph export in a given period.
///
/// # Arguments:
/// * `start_slot`: the start slot
/// * `end_slot`: the end slot
///
/// # Returns:
/// An export of the block graph in this period
fn get_block_graph_status(
&self,
start_slot: Option<Slot>,
end_slot: Option<Slot>,
) -> Result<BlockGraphExport, ConsensusError> {
self.shared_state
.read()
.extract_block_graph_part(start_slot, end_slot)
}
/// Get statuses of blocks present in the graph
///
/// # Arguments:
/// * `block_ids`: the block ids to get the status of
///
/// # Returns:
/// A vector of statuses sorted by the order of the block ids
fn get_block_statuses(&self, ids: &[BlockId]) -> Vec<BlockGraphStatus> {
let read_shared_state = self.shared_state.read();
ids.iter()
.map(|id| read_shared_state.get_block_status(id))
.collect()
}
/// Get all the cliques possible in the block graph.
///
/// # Returns:
/// A vector of cliques
fn get_cliques(&self) -> Vec<Clique> {
self.shared_state.read().max_cliques.clone()
}
/// Get a part of the graph to send to a node so that he can setup his graph.
/// Used for bootstrap.
///
/// # Arguments:
/// * `cursor`: streaming cursor containing the current state of bootstrap and what blocks have been to the client already
/// * `execution_cursor`: streaming cursor of the final state to ensure that last slot of the bootstrap info corresponds
///
/// # Returns:
/// * A portion of the graph
/// * The list of outdated block ids
/// * The streaming step value after the current iteration
fn get_bootstrap_part(
&self,
mut cursor: StreamingStep<PreHashSet<BlockId>>,
execution_cursor: StreamingStep<Slot>,
) -> Result<
(
BootstrapableGraph,
PreHashSet<BlockId>,
StreamingStep<PreHashSet<BlockId>>,
),
ConsensusError,
> {
let mut final_blocks: Vec<ExportActiveBlock> = Vec::new();
let mut retrieved_ids: PreHashSet<BlockId> = PreHashSet::default();
let read_shared_state = self.shared_state.read();
let required_blocks: PreHashSet<BlockId> = match execution_cursor {
StreamingStep::Ongoing(slot) | StreamingStep::Finished(Some(slot)) => {
read_shared_state.list_required_active_blocks(Some(slot))?
}
_ => PreHashSet::default(),
};
let (current_ids, previous_ids, outdated_ids) = match cursor {
StreamingStep::Started => (
required_blocks,
PreHashSet::default(),
PreHashSet::default(),
),
StreamingStep::Ongoing(ref cursor_ids) => (
// ids that are contained in required_blocks but not in the download cursor => current_ids
required_blocks.difference(cursor_ids).cloned().collect(),
// ids previously downloaded => previous_ids
cursor_ids.clone(),
// ids previously downloaded but not contained in required_blocks anymore => outdated_ids
cursor_ids.difference(&required_blocks).cloned().collect(),
),
StreamingStep::Finished(_) => {
return Ok((
BootstrapableGraph { final_blocks },
PreHashSet::default(),
cursor,
))
}
};
for b_id in ¤t_ids {
if let Some(BlockStatus::Active {
a_block,
storage_or_block,
}) = read_shared_state.blocks_state.get(b_id)
{
if final_blocks.len() as u64 >= self.bootstrap_part_size {
break;
}
match execution_cursor {
StreamingStep::Ongoing(slot) | StreamingStep::Finished(Some(slot)) => {
if a_block.slot > slot {
continue;
}
}
_ => (),
}
if a_block.is_final {
let export = ExportActiveBlock::from_active_block(a_block, storage_or_block);
final_blocks.push(export);
retrieved_ids.insert(*b_id);
}
}
}
if final_blocks.is_empty() {
cursor = StreamingStep::Finished(None);
} else {
let pruned_previous_ids = previous_ids.difference(&outdated_ids);
retrieved_ids.extend(pruned_previous_ids);
cursor = StreamingStep::Ongoing(retrieved_ids);
}
Ok((BootstrapableGraph { final_blocks }, outdated_ids, cursor))
}
/// Get the stats of the consensus
fn get_stats(&self) -> Result<ConsensusStats, ConsensusError> {
self.shared_state.read().get_stats()
}
/// Get the current best parents for a block creation
///
/// # Returns:
/// A block id and a period for each thread of the graph
fn get_best_parents(&self) -> Vec<(BlockId, u64)> {
self.shared_state.read().best_parents.clone()
}
/// Get the block, that is in the blockclique, at a given slot.
///
/// # Arguments:
/// * `slot`: the slot to get the block at
///
/// # Returns:
/// The block id of the block at the given slot if exists
fn get_blockclique_block_at_slot(&self, slot: Slot) -> Option<BlockId> {
self.shared_state
.read()
.get_blockclique_block_at_slot(&slot)
}
/// Get the latest block, that is in the blockclique, in the thread of the given slot and before this `slot`.
///
/// # Arguments:
/// * `slot`: the slot that will give us the thread and the upper bound
///
/// # Returns:
/// The block id of the latest block in the thread of the given slot and before this slot
fn get_latest_blockclique_block_at_slot(&self, slot: Slot) -> BlockId {
self.shared_state
.read()
.get_latest_blockclique_block_at_slot(&slot)
}
fn register_block(&self, block_id: BlockId, slot: Slot, block_storage: Storage, created: bool) {
if self.broadcast_enabled {
if let Some(verifiable_block) = block_storage.read_blocks().get(&block_id) {
let operations: Vec<(OperationId, Option<SecureShare<Operation, OperationId>>)> =
verifiable_block
.content
.operations
.iter()
.map(|operation_id| {
match block_storage.read_operations().get(operation_id).cloned() {
Some(verifiable_operation) => {
(*operation_id, Some(verifiable_operation))
}
None => (*operation_id, None),
}
})
.collect();
if let Err(err) = self.broadcasts.block_sender.send(verifiable_block.clone()) {
trace!(
"error, failed to broadcast block with id {} due to: {}",
block_id,
err
);
}
if let Err(err) = self.broadcasts.filled_block_sender.send(FilledBlock {
header: verifiable_block.content.header.clone(),
operations,
}) {
trace!(
"error, failed to broadcast filled block with id {} due to: {}",
block_id,
err
);
}
} else {
debug!(
"error, no broadcast event sent, block with id {} not found",
block_id
);
};
}
if let Err(err) = self
.command_sender
.try_send(ConsensusCommand::RegisterBlock(
block_id,
slot,
block_storage,
created,
))
{
warn!("error trying to register a block: {}", err);
}
}
fn register_block_header(&self, block_id: BlockId, header: SecureShare<BlockHeader, BlockId>) {
if self.broadcast_enabled {
if let Err(err) = self.broadcasts.block_header_sender.send(header.clone()) {
trace!(
"error, failed to broadcast block header with block id {}: {}",
block_id,
err
);
}
}
if let Err(err) = self
.command_sender
.try_send(ConsensusCommand::RegisterBlockHeader(block_id, header))
{
warn!("error trying to register a block header: {}", err);
}
}
fn mark_invalid_block(&self, block_id: BlockId, header: SecureShare<BlockHeader, BlockId>) {
if let Err(err) = self
.command_sender
.try_send(ConsensusCommand::MarkInvalidBlock(block_id, header))
{
warn!("error trying to mark block as invalid: {}", err);
}
}
fn clone_box(&self) -> Box<dyn ConsensusController> {
Box::new(self.clone())
}
}