//! The `validator` module hosts all the validator microservices. use crate::{ broadcast_stage::BroadcastStageType, cluster_info::{ClusterInfo, Node}, commitment::BlockCommitmentCache, contact_info::ContactInfo, gossip_service::{discover_cluster, GossipService}, poh_recorder::PohRecorder, poh_service::PohService, rewards_recorder_service::RewardsRecorderService, rpc::JsonRpcConfig, rpc_pubsub_service::PubSubService, rpc_service::JsonRpcService, rpc_subscriptions::RpcSubscriptions, serve_repair::ServeRepair, serve_repair_service::ServeRepairService, sigverify, storage_stage::StorageState, tpu::Tpu, transaction_status_service::TransactionStatusService, tvu::{Sockets, Tvu}, }; use crossbeam_channel::unbounded; use solana_ledger::{ bank_forks::{BankForks, SnapshotConfig}, bank_forks_utils, blockstore::{Blockstore, CompletedSlotsReceiver}, blockstore_processor::{self, BankForksInfo}, create_new_tmp_ledger, leader_schedule::FixedSchedule, leader_schedule_cache::LeaderScheduleCache, shred_version::compute_shred_version, }; use solana_metrics::datapoint_info; use solana_runtime::bank::Bank; use solana_sdk::{ clock::{Slot, DEFAULT_SLOTS_PER_TURN}, genesis_config::GenesisConfig, hash::Hash, poh_config::PohConfig, pubkey::Pubkey, signature::{Keypair, KeypairUtil}, timing::timestamp, }; use std::{ net::{IpAddr, Ipv4Addr, SocketAddr}, path::{Path, PathBuf}, process, sync::atomic::{AtomicBool, Ordering}, sync::mpsc::Receiver, sync::{Arc, Mutex, RwLock}, thread::{sleep, Result}, time::Duration, }; #[derive(Clone, Debug)] pub struct ValidatorConfig { pub dev_sigverify_disabled: bool, pub dev_halt_at_slot: Option, pub expected_genesis_hash: Option, pub expected_shred_version: Option, pub voting_disabled: bool, pub blockstream_unix_socket: Option, pub storage_slots_per_turn: u64, pub account_paths: Vec, pub rpc_config: JsonRpcConfig, pub rpc_ports: Option<(u16, u16)>, // (API, PubSub) pub snapshot_config: Option, pub max_ledger_slots: Option, pub broadcast_stage_type: BroadcastStageType, pub enable_partition: Option>, pub fixed_leader_schedule: Option, pub wait_for_supermajority: bool, pub new_hard_forks: Option>, } impl Default for ValidatorConfig { fn default() -> Self { Self { dev_sigverify_disabled: false, dev_halt_at_slot: None, expected_genesis_hash: None, expected_shred_version: None, voting_disabled: false, blockstream_unix_socket: None, storage_slots_per_turn: DEFAULT_SLOTS_PER_TURN, max_ledger_slots: None, account_paths: Vec::new(), rpc_config: JsonRpcConfig::default(), rpc_ports: None, snapshot_config: None, broadcast_stage_type: BroadcastStageType::Standard, enable_partition: None, fixed_leader_schedule: None, wait_for_supermajority: false, new_hard_forks: None, } } } #[derive(Default)] pub struct ValidatorExit { exits: Vec>, } impl ValidatorExit { pub fn register_exit(&mut self, exit: Box () + Send + Sync>) { self.exits.push(exit); } pub fn exit(self) { for exit in self.exits { exit(); } } } pub struct Validator { pub id: Pubkey, validator_exit: Arc>>, rpc_service: Option<(JsonRpcService, PubSubService)>, transaction_status_service: Option, rewards_recorder_service: Option, gossip_service: GossipService, serve_repair_service: ServeRepairService, poh_recorder: Arc>, poh_service: PohService, tpu: Tpu, tvu: Tvu, ip_echo_server: solana_net_utils::IpEchoServer, } impl Validator { #[allow(clippy::cognitive_complexity)] pub fn new( mut node: Node, keypair: &Arc, ledger_path: &Path, vote_account: &Pubkey, voting_keypair: &Arc, storage_keypair: &Arc, entrypoint_info_option: Option<&ContactInfo>, poh_verify: bool, config: &ValidatorConfig, ) -> Self { let id = keypair.pubkey(); assert_eq!(id, node.info.id); warn!("identity pubkey: {:?}", id); warn!("vote pubkey: {:?}", vote_account); report_target_features(); info!("entrypoint: {:?}", entrypoint_info_option); info!("Initializing sigverify, this could take a while..."); sigverify::init(); info!("Done."); info!("creating bank..."); let ( genesis_hash, bank_forks, bank_forks_info, blockstore, ledger_signal_receiver, completed_slots_receiver, leader_schedule_cache, poh_config, ) = new_banks_from_blockstore( config.expected_genesis_hash, ledger_path, poh_verify, config, ); let leader_schedule_cache = Arc::new(leader_schedule_cache); let exit = Arc::new(AtomicBool::new(false)); let bank_info = &bank_forks_info[0]; let bank = bank_forks[bank_info.bank_slot].clone(); info!("Starting validator from slot {}", bank.slot()); { let hard_forks: Vec<_> = bank.hard_forks().read().unwrap().iter().copied().collect(); if !hard_forks.is_empty() { info!("Hard forks: {:?}", hard_forks); } } let bank_forks = Arc::new(RwLock::new(bank_forks)); let block_commitment_cache = Arc::new(RwLock::new(BlockCommitmentCache::default())); let mut validator_exit = ValidatorExit::default(); let exit_ = exit.clone(); validator_exit.register_exit(Box::new(move || exit_.store(true, Ordering::Relaxed))); let validator_exit = Arc::new(RwLock::new(Some(validator_exit))); node.info.wallclock = timestamp(); node.info.shred_version = compute_shred_version(&genesis_hash, Some(&bank.hard_forks().read().unwrap())); Self::print_node_info(&node); if let Some(expected_shred_version) = config.expected_shred_version { if expected_shred_version != node.info.shred_version { error!( "shred version mismatch: expected {}", expected_shred_version ); process::exit(1); } } let cluster_info = Arc::new(RwLock::new(ClusterInfo::new( node.info.clone(), keypair.clone(), ))); let storage_state = StorageState::new( &bank.last_blockhash(), config.storage_slots_per_turn, bank.slots_per_segment(), ); let blockstore = Arc::new(blockstore); let subscriptions = Arc::new(RpcSubscriptions::new(&exit)); let rpc_service = config.rpc_ports.map(|(rpc_port, rpc_pubsub_port)| { if ContactInfo::is_valid_address(&node.info.rpc) { assert!(ContactInfo::is_valid_address(&node.info.rpc_pubsub)); assert_eq!(rpc_port, node.info.rpc.port()); assert_eq!(rpc_pubsub_port, node.info.rpc_pubsub.port()); } else { assert!(!ContactInfo::is_valid_address(&node.info.rpc_pubsub)); } ( JsonRpcService::new( SocketAddr::new(IpAddr::V4(Ipv4Addr::new(0, 0, 0, 0)), rpc_port), config.rpc_config.clone(), bank_forks.clone(), block_commitment_cache.clone(), blockstore.clone(), cluster_info.clone(), genesis_hash, ledger_path, storage_state.clone(), validator_exit.clone(), ), PubSubService::new( &subscriptions, SocketAddr::new(IpAddr::V4(Ipv4Addr::new(0, 0, 0, 0)), rpc_pubsub_port), &exit, ), ) }); let (transaction_status_sender, transaction_status_service) = if rpc_service.is_some() && config.rpc_config.enable_get_confirmed_block { let (transaction_status_sender, transaction_status_receiver) = unbounded(); ( Some(transaction_status_sender), Some(TransactionStatusService::new( transaction_status_receiver, blockstore.clone(), &exit, )), ) } else { (None, None) }; let (rewards_recorder_sender, rewards_recorder_service) = if rpc_service.is_some() && config.rpc_config.enable_get_confirmed_block { let (rewards_recorder_sender, rewards_receiver) = unbounded(); ( Some(rewards_recorder_sender), Some(RewardsRecorderService::new( rewards_receiver, blockstore.clone(), &exit, )), ) } else { (None, None) }; info!( "Starting PoH: epoch={} slot={} tick_height={} blockhash={} leader={:?}", bank.epoch(), bank.slot(), bank.tick_height(), bank.last_blockhash(), leader_schedule_cache.slot_leader_at(bank.slot(), Some(&bank)) ); if config.dev_halt_at_slot.is_some() { // Park with the RPC service running, ready for inspection! warn!("Validator halted"); std::thread::park(); } let poh_config = Arc::new(poh_config); let (mut poh_recorder, entry_receiver) = PohRecorder::new_with_clear_signal( bank.tick_height(), bank.last_blockhash(), bank.slot(), leader_schedule_cache.next_leader_slot(&id, bank.slot(), &bank, Some(&blockstore)), bank.ticks_per_slot(), &id, &blockstore, blockstore.new_shreds_signals.first().cloned(), &leader_schedule_cache, &poh_config, ); if config.snapshot_config.is_some() { poh_recorder.set_bank(&bank); } let poh_recorder = Arc::new(Mutex::new(poh_recorder)); let ip_echo_server = solana_net_utils::ip_echo_server(node.sockets.ip_echo.unwrap()); let gossip_service = GossipService::new( &cluster_info, Some(bank_forks.clone()), node.sockets.gossip, &exit, ); let serve_repair = Arc::new(RwLock::new(ServeRepair::new(cluster_info.clone()))); let serve_repair_service = ServeRepairService::new( &serve_repair, Some(blockstore.clone()), node.sockets.serve_repair, &exit, ); // Insert the entrypoint info, should only be None if this node // is the bootstrap validator if let Some(entrypoint_info) = entrypoint_info_option { cluster_info .write() .unwrap() .set_entrypoint(entrypoint_info.clone()); } wait_for_supermajority(config, &bank, &cluster_info); let voting_keypair = if config.voting_disabled { None } else { Some(voting_keypair.clone()) }; let poh_service = PohService::new(poh_recorder.clone(), &poh_config, &exit); assert_eq!( blockstore.new_shreds_signals.len(), 1, "New shred signal for the TVU should be the same as the clear bank signal." ); let tvu = Tvu::new( vote_account, voting_keypair, storage_keypair, &bank_forks, &cluster_info, Sockets { repair: node .sockets .repair .try_clone() .expect("Failed to clone repair socket"), retransmit: node .sockets .retransmit_sockets .iter() .map(|s| s.try_clone().expect("Failed to clone retransmit socket")) .collect(), fetch: node .sockets .tvu .iter() .map(|s| s.try_clone().expect("Failed to clone TVU Sockets")) .collect(), forwards: node .sockets .tvu_forwards .iter() .map(|s| s.try_clone().expect("Failed to clone TVU forwards Sockets")) .collect(), }, blockstore.clone(), &storage_state, config.blockstream_unix_socket.as_ref(), config.max_ledger_slots, ledger_signal_receiver, &subscriptions, &poh_recorder, &leader_schedule_cache, &exit, completed_slots_receiver, block_commitment_cache, config.dev_sigverify_disabled, config.enable_partition.clone(), node.info.shred_version, transaction_status_sender.clone(), rewards_recorder_sender, ); if config.dev_sigverify_disabled { warn!("signature verification disabled"); } let tpu = Tpu::new( &cluster_info, &poh_recorder, entry_receiver, node.sockets.tpu, node.sockets.tpu_forwards, node.sockets.broadcast, config.dev_sigverify_disabled, transaction_status_sender, &blockstore, &config.broadcast_stage_type, &exit, node.info.shred_version, ); datapoint_info!("validator-new", ("id", id.to_string(), String)); Self { id, gossip_service, serve_repair_service, rpc_service, transaction_status_service, rewards_recorder_service, tpu, tvu, poh_service, poh_recorder, ip_echo_server, validator_exit, } } // Used for notifying many nodes in parallel to exit pub fn exit(&mut self) { if let Some(x) = self.validator_exit.write().unwrap().take() { x.exit() } } pub fn close(mut self) -> Result<()> { self.exit(); self.join() } fn print_node_info(node: &Node) { info!("{:?}", node.info); info!( "local gossip address: {}", node.sockets.gossip.local_addr().unwrap() ); info!( "local broadcast address: {}", node.sockets .broadcast .first() .unwrap() .local_addr() .unwrap() ); info!( "local repair address: {}", node.sockets.repair.local_addr().unwrap() ); info!( "local retransmit address: {}", node.sockets.retransmit_sockets[0].local_addr().unwrap() ); } pub fn join(self) -> Result<()> { self.poh_service.join()?; drop(self.poh_recorder); if let Some((rpc_service, rpc_pubsub_service)) = self.rpc_service { rpc_service.join()?; rpc_pubsub_service.join()?; } if let Some(transaction_status_service) = self.transaction_status_service { transaction_status_service.join()?; } if let Some(rewards_recorder_service) = self.rewards_recorder_service { rewards_recorder_service.join()?; } self.gossip_service.join()?; self.serve_repair_service.join()?; self.tpu.join()?; self.tvu.join()?; self.ip_echo_server.shutdown_now(); Ok(()) } } fn new_banks_from_blockstore( expected_genesis_hash: Option, blockstore_path: &Path, poh_verify: bool, config: &ValidatorConfig, ) -> ( Hash, BankForks, Vec, Blockstore, Receiver, CompletedSlotsReceiver, LeaderScheduleCache, PohConfig, ) { let genesis_config = GenesisConfig::load(blockstore_path).unwrap_or_else(|err| { error!("Failed to load genesis from {:?}: {}", blockstore_path, err); process::exit(1); }); let genesis_hash = genesis_config.hash(); info!("genesis hash: {}", genesis_hash); if let Some(expected_genesis_hash) = expected_genesis_hash { if genesis_hash != expected_genesis_hash { error!("genesis hash mismatch: expected {}", expected_genesis_hash); error!( "Delete the ledger directory to continue: {:?}", blockstore_path ); process::exit(1); } } let (blockstore, ledger_signal_receiver, completed_slots_receiver) = Blockstore::open_with_signal(blockstore_path).expect("Failed to open ledger database"); let process_options = blockstore_processor::ProcessOptions { poh_verify, dev_halt_at_slot: config.dev_halt_at_slot, new_hard_forks: config.new_hard_forks.clone(), ..blockstore_processor::ProcessOptions::default() }; let (mut bank_forks, bank_forks_info, mut leader_schedule_cache) = bank_forks_utils::load( &genesis_config, &blockstore, config.account_paths.clone(), config.snapshot_config.as_ref(), process_options, ) .unwrap_or_else(|err| { error!("Failed to load ledger: {:?}", err); std::process::exit(1); }); leader_schedule_cache.set_fixed_leader_schedule(config.fixed_leader_schedule.clone()); bank_forks.set_snapshot_config(config.snapshot_config.clone()); ( genesis_hash, bank_forks, bank_forks_info, blockstore, ledger_signal_receiver, completed_slots_receiver, leader_schedule_cache, genesis_config.poh_config, ) } fn wait_for_supermajority( config: &ValidatorConfig, bank: &Arc, cluster_info: &Arc>, ) { if !config.wait_for_supermajority { return; } info!( "Waiting for more than 75% of activated stake at slot {} to be in gossip...", bank.slot() ); loop { let gossip_stake_percent = get_stake_percent_in_gossip(&bank, &cluster_info); info!("{}% of activated stake in gossip", gossip_stake_percent,); if gossip_stake_percent > 75 { break; } sleep(Duration::new(1, 0)); } } pub fn new_validator_for_tests() -> (Validator, ContactInfo, Keypair, PathBuf) { let (node, contact_info, mint_keypair, ledger_path, _vote_pubkey) = new_validator_for_tests_with_vote_pubkey(); (node, contact_info, mint_keypair, ledger_path) } pub fn new_validator_for_tests_with_vote_pubkey( ) -> (Validator, ContactInfo, Keypair, PathBuf, Pubkey) { use crate::genesis_utils::BOOTSTRAP_VALIDATOR_LAMPORTS; new_validator_for_tests_ex(0, BOOTSTRAP_VALIDATOR_LAMPORTS) } pub fn new_validator_for_tests_ex( fees: u64, bootstrap_validator_lamports: u64, ) -> (Validator, ContactInfo, Keypair, PathBuf, Pubkey) { use crate::genesis_utils::{create_genesis_config_with_leader_ex, GenesisConfigInfo}; use solana_sdk::fee_calculator::FeeCalculator; let node_keypair = Arc::new(Keypair::new()); let node = Node::new_localhost_with_pubkey(&node_keypair.pubkey()); let contact_info = node.info.clone(); let GenesisConfigInfo { mut genesis_config, mint_keypair, voting_keypair, } = create_genesis_config_with_leader_ex( 1_000_000, &contact_info.id, 42, bootstrap_validator_lamports, ); genesis_config .native_instruction_processors .push(solana_budget_program!()); genesis_config.rent.lamports_per_byte_year = 1; genesis_config.rent.exemption_threshold = 1.0; genesis_config.fee_calculator = FeeCalculator::new(fees, 0); let (ledger_path, _blockhash) = create_new_tmp_ledger!(&genesis_config); let leader_voting_keypair = Arc::new(voting_keypair); let storage_keypair = Arc::new(Keypair::new()); let config = ValidatorConfig { rpc_ports: Some((node.info.rpc.port(), node.info.rpc_pubsub.port())), ..ValidatorConfig::default() }; let node = Validator::new( node, &node_keypair, &ledger_path, &leader_voting_keypair.pubkey(), &leader_voting_keypair, &storage_keypair, None, true, &config, ); discover_cluster(&contact_info.gossip, 1).expect("Node startup failed"); ( node, contact_info, mint_keypair, ledger_path, leader_voting_keypair.pubkey(), ) } fn report_target_features() { warn!( "CUDA is {}abled", if solana_perf::perf_libs::api().is_some() { "en" } else { "dis" } ); // Validator binaries built on a machine with AVX support will generate invalid opcodes // when run on machines without AVX causing a non-obvious process abort. Instead detect // the mismatch and error cleanly. #[target_feature(enable = "avx")] { if is_x86_feature_detected!("avx") { info!("AVX detected"); } else { error!("Your machine does not have AVX support, please rebuild from source on your machine"); process::exit(1); } } } // Get the activated stake percentage (based on the provided bank) that is visible in gossip fn get_stake_percent_in_gossip(bank: &Arc, cluster_info: &Arc>) -> u64 { let mut gossip_stake = 0; let mut total_activated_stake = 0; let tvu_peers = cluster_info.read().unwrap().tvu_peers(); let me = cluster_info.read().unwrap().my_data(); for (activated_stake, vote_account) in bank.vote_accounts().values() { let vote_state = solana_vote_program::vote_state::VoteState::from(&vote_account).unwrap_or_default(); total_activated_stake += activated_stake; if tvu_peers .iter() .filter(|peer| peer.shred_version == me.shred_version) .any(|peer| peer.id == vote_state.node_pubkey) { trace!( "observed {} in gossip, (activated_stake={})", vote_state.node_pubkey, activated_stake ); gossip_stake += activated_stake; } else if vote_state.node_pubkey == cluster_info.read().unwrap().id() { gossip_stake += activated_stake; } } gossip_stake * 100 / total_activated_stake } #[cfg(test)] mod tests { use super::*; use crate::genesis_utils::create_genesis_config_with_leader; use std::fs::remove_dir_all; #[test] fn validator_exit() { solana_logger::setup(); let leader_keypair = Keypair::new(); let leader_node = Node::new_localhost_with_pubkey(&leader_keypair.pubkey()); let validator_keypair = Keypair::new(); let validator_node = Node::new_localhost_with_pubkey(&validator_keypair.pubkey()); let genesis_config = create_genesis_config_with_leader(10_000, &leader_keypair.pubkey(), 1000) .genesis_config; let (validator_ledger_path, _blockhash) = create_new_tmp_ledger!(&genesis_config); let voting_keypair = Arc::new(Keypair::new()); let storage_keypair = Arc::new(Keypair::new()); let config = ValidatorConfig { rpc_ports: Some(( validator_node.info.rpc.port(), validator_node.info.rpc_pubsub.port(), )), ..ValidatorConfig::default() }; let validator = Validator::new( validator_node, &Arc::new(validator_keypair), &validator_ledger_path, &voting_keypair.pubkey(), &voting_keypair, &storage_keypair, Some(&leader_node.info), true, &config, ); validator.close().unwrap(); remove_dir_all(validator_ledger_path).unwrap(); } #[test] fn validator_parallel_exit() { let leader_keypair = Keypair::new(); let leader_node = Node::new_localhost_with_pubkey(&leader_keypair.pubkey()); let mut ledger_paths = vec![]; let mut validators: Vec = (0..2) .map(|_| { let validator_keypair = Keypair::new(); let validator_node = Node::new_localhost_with_pubkey(&validator_keypair.pubkey()); let genesis_config = create_genesis_config_with_leader(10_000, &leader_keypair.pubkey(), 1000) .genesis_config; let (validator_ledger_path, _blockhash) = create_new_tmp_ledger!(&genesis_config); ledger_paths.push(validator_ledger_path.clone()); let voting_keypair = Arc::new(Keypair::new()); let storage_keypair = Arc::new(Keypair::new()); let config = ValidatorConfig { rpc_ports: Some(( validator_node.info.rpc.port(), validator_node.info.rpc_pubsub.port(), )), ..ValidatorConfig::default() }; Validator::new( validator_node, &Arc::new(validator_keypair), &validator_ledger_path, &voting_keypair.pubkey(), &voting_keypair, &storage_keypair, Some(&leader_node.info), true, &config, ) }) .collect(); // Each validator can exit in parallel to speed many sequential calls to `join` validators.iter_mut().for_each(|v| v.exit()); // While join is called sequentially, the above exit call notified all the // validators to exit from all their threads validators.into_iter().for_each(|validator| { validator.join().unwrap(); }); for path in ledger_paths { remove_dir_all(path).unwrap(); } } }