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 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548
use std::{
collections::{HashMap, VecDeque},
vec,
};
use massa_consensus_exports::{
block_graph_export::BlockGraphExport,
block_status::{BlockStatus, ExportCompiledBlock, HeaderOrBlock, StorageOrBlock},
error::ConsensusError,
ConsensusChannels, ConsensusConfig,
};
use massa_execution_exports::ExecutionBlockMetadata;
use massa_metrics::MassaMetrics;
use massa_models::{
active_block::ActiveBlock,
address::Address,
block::BlockGraphStatus,
block_header::SecuredHeader,
block_id::BlockId,
clique::Clique,
prehash::{CapacityAllocator, PreHashMap, PreHashSet},
slot::Slot,
};
use massa_storage::Storage;
use massa_time::MassaTime;
use tracing::debug;
use self::blocks_state::BlocksState;
pub mod blocks_state;
mod clique_computation;
mod graph;
mod process;
mod process_commands;
mod prune;
mod stats;
mod tick;
mod verifications;
#[allow(dead_code)]
#[derive(Clone)]
pub struct ConsensusState {
/// Configuration
pub config: ConsensusConfig,
/// Channels to communicate with other modules
pub channels: ConsensusChannels,
/// Storage
pub storage: Storage,
/// Block ids of genesis blocks
pub genesis_hashes: Vec<BlockId>,
/// Incompatibility graph: maps a block id to the block ids it is incompatible with
/// One entry per Active Block
pub gi_head: PreHashMap<BlockId, PreHashSet<BlockId>>,
/// All the cliques
pub max_cliques: Vec<Clique>,
/// ids of active blocks without ops
pub active_index_without_ops: PreHashSet<BlockId>,
/// Save of latest periods
pub save_final_periods: Vec<u64>,
/// One (block id, period) per thread
pub latest_final_blocks_periods: Vec<(BlockId, u64)>,
/// All the blocks we know about and their status
pub blocks_state: BlocksState,
/// One `(block id, period)` per thread TODO not sure I understand the difference with `latest_final_blocks_periods`
pub best_parents: Vec<(BlockId, u64)>,
/// Blocks that need to be propagated
pub to_propagate: PreHashMap<BlockId, Storage>,
/// List of block ids we think are attack attempts
pub attack_attempts: Vec<BlockId>,
/// Newly final blocks
pub new_final_blocks: PreHashSet<BlockId>,
/// Newly stale block mapped to creator and slot
pub new_stale_blocks: PreHashMap<BlockId, (Address, Slot)>,
/// time at which the node was launched (used for de-synchronization detection)
pub launch_time: MassaTime,
/// Final block stats `(time, creator, is_from_protocol)`
pub final_block_stats: VecDeque<(MassaTime, Address, bool)>,
/// Blocks that come from protocol used for stats and ids are removed when inserted in `final_block_stats`
pub protocol_blocks: VecDeque<(MassaTime, BlockId)>,
/// Stale block timestamp
pub stale_block_stats: VecDeque<MassaTime>,
/// the time span considered for stats
pub stats_history_timespan: MassaTime,
/// the time span considered for de-synchronization detection
pub stats_desync_detection_timespan: MassaTime,
/// blocks we want
pub wishlist: PreHashMap<BlockId, Option<SecuredHeader>>,
/// previous blockclique notified to Execution
pub prev_blockclique: PreHashMap<BlockId, Slot>,
/// Blocks indexed by slot (used for multi-stake limiting). Blocks
/// should be saved in this map when we receive the header or the full block directly.
pub nonfinal_active_blocks_per_slot: HashMap<Slot, PreHashSet<BlockId>>,
/// massa metrics
pub(crate) massa_metrics: MassaMetrics,
}
impl ConsensusState {
/// Get a full active block
pub fn get_full_active_block(
&self,
block_id: &BlockId,
) -> Option<(&ActiveBlock, &StorageOrBlock)> {
match self.blocks_state.get(block_id) {
Some(BlockStatus::Active {
a_block,
storage_or_block,
}) => Some((a_block.as_ref(), storage_or_block)),
_ => None,
}
}
/// Get a full active block
///
/// Returns an error if it was not found
fn try_get_full_active_block(
&self,
block_id: &BlockId,
) -> Result<(&ActiveBlock, &StorageOrBlock), ConsensusError> {
self.get_full_active_block(block_id).ok_or_else(|| {
ConsensusError::ContainerInconsistency(format!("block {} is missing", block_id))
})
}
pub fn get_clique_count(&self) -> usize {
self.max_cliques.len()
}
/// get the blockclique (or final) block ID at a given slot, if any
pub fn get_blockclique_block_at_slot(&self, slot: &Slot) -> Option<BlockId> {
// List all blocks at this slot.
// The list should be small: make a copy of it to avoid holding the storage lock.
let blocks_at_slot = {
let storage_read = self.storage.read_blocks();
let returned = match storage_read.get_blocks_by_slot(slot) {
Some(v) => v.clone(),
None => return None,
};
returned
};
// search for the block in the blockclique
let search_in_blockclique = blocks_at_slot
.intersection(
&self
.max_cliques
.iter()
.find(|c| c.is_blockclique)
.expect("expected one clique to be the blockclique")
.block_ids,
)
.next();
if let Some(found_id) = search_in_blockclique {
return Some(*found_id);
}
// block not found in the blockclique: search in the final blocks
blocks_at_slot
.into_iter()
.find(|b_id| match self.blocks_state.get(b_id) {
Some(BlockStatus::Active { a_block, .. }) => a_block.is_final,
_ => false,
})
}
/// get the latest blockclique (or final) block ID at a given slot, if any
pub fn get_latest_blockclique_block_at_slot(&self, slot: &Slot) -> BlockId {
let (mut best_block_id, mut best_block_period) = self
.latest_final_blocks_periods
.get(slot.thread as usize)
.unwrap_or_else(|| panic!("unexpected not found latest final block period"));
self.get_blockclique()
.iter()
.for_each(|id| match self.blocks_state.get(id) {
Some(BlockStatus::Active { a_block, .. }) => {
if a_block.is_final {
panic!(
"unexpected final block on getting latest blockclique block at slot"
);
}
if a_block.slot.thread == slot.thread
&& a_block.slot.period < slot.period
&& a_block.slot.period > best_block_period
{
best_block_period = a_block.slot.period;
best_block_id = *id;
}
}
_ => {
panic!("expected to find only active block but found another status")
}
});
best_block_id
}
pub fn get_block_status(&self, block_id: &BlockId) -> BlockGraphStatus {
match self.blocks_state.get(block_id) {
None => BlockGraphStatus::NotFound,
Some(BlockStatus::Active { a_block, .. }) => {
if a_block.is_final {
BlockGraphStatus::Final
} else if self
.max_cliques
.iter()
.find(|clique| clique.is_blockclique)
.expect("blockclique absent")
.block_ids
.contains(block_id)
{
BlockGraphStatus::ActiveInBlockclique
} else {
BlockGraphStatus::ActiveInAlternativeCliques
}
}
Some(BlockStatus::Discarded { .. }) => BlockGraphStatus::Discarded,
Some(BlockStatus::Incoming(_)) => BlockGraphStatus::Incoming,
Some(BlockStatus::WaitingForDependencies { .. }) => {
BlockGraphStatus::WaitingForDependencies
}
Some(BlockStatus::WaitingForSlot(_)) => BlockGraphStatus::WaitingForSlot,
}
}
/// list the latest final blocks at the given slot
///
/// exclusively used by `list_required_active_blocks`
fn list_latest_final_blocks_at(
&self,
slot: Slot,
) -> Result<Vec<(BlockId, u64)>, ConsensusError> {
let mut latest: Vec<Option<(BlockId, u64)>> = vec![None; self.config.thread_count as usize];
for id in self.blocks_state.active_blocks().iter() {
let (block, _storage) = self.try_get_full_active_block(id)?;
if let Some((_, p)) = latest[block.slot.thread as usize] {
if block.slot.period < p {
continue;
}
}
if block.is_final && block.slot <= slot {
latest[block.slot.thread as usize] = Some((*id, block.slot.period));
}
}
latest
.into_iter()
.enumerate()
.map(|(thread, opt)| {
opt.ok_or_else(|| {
ConsensusError::ContainerInconsistency(format!(
"could not find latest block for thread {}",
thread
))
})
})
.collect()
}
/// list the earliest blocks of the given block id list
///
/// exclusively used by `list_required_active_blocks`
fn list_earliest_blocks_of(
&self,
block_ids: &PreHashSet<BlockId>,
end_slot: Option<Slot>,
) -> Result<Vec<(BlockId, u64)>, ConsensusError> {
let mut earliest: Vec<Option<(BlockId, u64)>> =
vec![None; self.config.thread_count as usize];
for id in block_ids {
let (block, _storage) = self.try_get_full_active_block(id)?;
if let Some(slot) = end_slot {
if block.slot > slot {
continue;
}
}
if let Some((_, p)) = earliest[block.slot.thread as usize] {
if block.slot.period > p {
continue;
}
}
earliest[block.slot.thread as usize] = Some((*id, block.slot.period));
}
earliest
.into_iter()
.enumerate()
.map(|(thread, opt)| {
opt.ok_or_else(|| {
ConsensusError::ContainerInconsistency(format!(
"could not find earliest block for thread {}",
thread
))
})
})
.collect()
}
/// adds to the given container every active block coming after the lower bound
///
/// exclusively used by `list_required_active_blocks`
fn add_active_blocks_after(
&self,
kept_blocks: &mut PreHashSet<BlockId>,
lower_bound: &[(BlockId, u64)],
end_slot: Option<Slot>,
) {
for id in self.blocks_state.active_blocks().iter() {
if let Some((block, _storage)) = self.get_full_active_block(id) {
if let Some(slot) = end_slot {
if block.slot > slot {
continue;
}
}
if block.slot.period >= lower_bound[block.slot.thread as usize].1 {
kept_blocks.insert(*id);
}
}
}
}
/// list_required_active_blocks algo:
///
/// if end_slot is None:
/// set effective_latest_finals to be the IDs of the self.latest_final_blocks
/// else
/// set effective_latest_finals to be the IDs of the Active Final blocks that have the highest period in each thread but are before end_slot (included)
///
/// create a kept_blocks list of block IDs to keep
/// initialize it with effective_latest_finals as well as all the active blocks that are after the effective_latest_finals of their thread (included) (but before end_slot (included) if it is Some)
///
/// do the following 2 times:
/// extend kept_blocks with the parents of the current kept_blocks
/// fill holes by adding to kept_blocks all the active block IDs whose slot is after the earliest kept_blocks of their thread (included) (but before end_slot (included) if it is Some)
///
/// return kept_blocks
pub fn list_required_active_blocks(
&self,
end_slot: Option<Slot>,
) -> Result<PreHashSet<BlockId>, ConsensusError> {
// if an end_slot is provided compute the latest final block for that given slot
// if not use the latest_final_blocks_periods
let effective_latest_finals: Vec<(BlockId, u64)> = if let Some(slot) = end_slot {
self.list_latest_final_blocks_at(slot)?
} else {
self.latest_final_blocks_periods.clone()
};
// init kept_blocks using effective_latest_finals
let mut kept_blocks: PreHashSet<BlockId> = effective_latest_finals
.iter()
.map(|(id, _period)| *id)
.collect();
// add all the active blocks that are after the effective_latest_finals of their thread
self.add_active_blocks_after(&mut kept_blocks, &effective_latest_finals, end_slot);
// do the following 2 times
for _ in 0..2 {
// extend kept_blocks with the parents of the current kept_blocks
let mut cumulated_parents: PreHashSet<BlockId> = PreHashSet::default();
for id in kept_blocks.iter() {
let parents = self
.try_get_full_active_block(id)?
.0
.parents
.iter()
.map(|(id, _period)| *id);
cumulated_parents.extend(parents);
}
kept_blocks.extend(cumulated_parents);
// add all the active blocks whose slot is after the earliest kept_blocks of their thread
let earliest_blocks = self.list_earliest_blocks_of(&kept_blocks, end_slot)?;
self.add_active_blocks_after(&mut kept_blocks, &earliest_blocks, end_slot);
}
// check that we have the full blocks for every id we are about to return
for id in kept_blocks.iter() {
self.try_get_full_active_block(id)?;
}
// debug log for an easier diagnostic if needed
debug!("list_required_active_blocks return: {:?}", kept_blocks);
// return kept_blocks
Ok(kept_blocks)
}
pub fn extract_block_graph_part(
&self,
slot_start: Option<Slot>,
slot_end: Option<Slot>,
) -> Result<BlockGraphExport, ConsensusError> {
let mut export = BlockGraphExport {
genesis_blocks: self.genesis_hashes.clone(),
active_blocks: PreHashMap::with_capacity(self.blocks_state.len()),
discarded_blocks: PreHashMap::with_capacity(self.blocks_state.len()),
best_parents: self.best_parents.clone(),
latest_final_blocks_periods: self.latest_final_blocks_periods.clone(),
gi_head: self.gi_head.clone(),
max_cliques: self.max_cliques.clone(),
};
let filter = |&s| {
if let Some(s_start) = slot_start {
if s < s_start {
return false;
}
}
if let Some(s_end) = slot_end {
if s >= s_end {
return false;
}
}
true
};
for (block_id, block) in self.blocks_state.iter() {
match block {
BlockStatus::Discarded {
slot,
creator,
parents,
reason,
..
} => {
if filter(slot) {
export.discarded_blocks.insert(
*block_id,
(reason.clone(), (*slot, *creator, parents.clone())),
);
}
}
BlockStatus::Active {
a_block,
storage_or_block,
} => {
if filter(&a_block.slot) {
export.active_blocks.insert(
*block_id,
ExportCompiledBlock {
header: storage_or_block.clone_block(block_id).content.header,
children: a_block
.children
.iter()
.map(|thread| {
thread.keys().copied().collect::<PreHashSet<BlockId>>()
})
.collect(),
is_final: a_block.is_final,
},
);
}
}
_ => continue,
}
}
Ok(export)
}
/// Gets all stored final blocks, not only the still-useful ones
/// This is used when initializing Execution from Consensus.
/// Since the Execution bootstrap snapshot is older than the Consensus snapshot,
/// we might need to signal older final blocks for Execution to catch up.
pub fn get_all_final_blocks(&self) -> HashMap<BlockId, (Slot, ExecutionBlockMetadata)> {
self.blocks_state
.active_blocks()
.iter()
.filter_map(|b_id| {
if let Some(BlockStatus::Active {
a_block,
storage_or_block,
}) = self.blocks_state.get(b_id)
{
if !a_block.is_final {
return None;
}
let storage = match storage_or_block {
StorageOrBlock::Storage(storage) => Some(storage.clone()),
_ => None,
};
return Some((
*b_id,
(
a_block.slot,
ExecutionBlockMetadata {
same_thread_parent_creator: a_block.same_thread_parent_creator,
storage,
},
),
));
}
None
})
.collect()
}
/// get the current block wish list, including the operations hash.
pub fn get_block_wishlist(
&self,
) -> Result<PreHashMap<BlockId, Option<SecuredHeader>>, ConsensusError> {
let mut wishlist = PreHashMap::<BlockId, Option<SecuredHeader>>::default();
for block_id in self.blocks_state.waiting_for_dependencies_blocks().iter() {
if let Some(BlockStatus::WaitingForDependencies {
unsatisfied_dependencies,
..
}) = self.blocks_state.get(block_id)
{
for unsatisfied_h in unsatisfied_dependencies.iter() {
match self.blocks_state.get(unsatisfied_h) {
Some(BlockStatus::WaitingForDependencies {
header_or_block: HeaderOrBlock::Header(header),
..
}) => {
wishlist.insert(header.id, Some(header.clone()));
}
None => {
wishlist.insert(*unsatisfied_h, None);
}
_ => {}
}
}
}
}
Ok(wishlist)
}
/// Gets a block and all its descendants
///
/// # Argument
/// * hash : hash of the given block
pub fn get_active_block_and_descendants(&self, block_id: &BlockId) -> PreHashSet<BlockId> {
let mut to_visit = vec![*block_id];
let mut result = PreHashSet::<BlockId>::default();
while let Some(visit_h) = to_visit.pop() {
if !result.insert(visit_h) {
continue; // already visited
}
match self.blocks_state.get(&visit_h) {
Some(BlockStatus::Active { a_block, .. }) => {
a_block.as_ref()
.children.iter()
.for_each(|thread_children| to_visit.extend(thread_children.keys()))
},
_ => panic!("inconsistency inside block statuses iterating through descendants of {} - missing {}", block_id, visit_h),
}
}
result
}
}