use {
crate::{
cluster_info_metrics::{Counter, GossipStats, ScopedTimer, TimedGuard},
contact_info::{self, ContactInfo, ContactInfoQuery, Error as ContactInfoError},
crds::{Crds, Cursor, GossipRoute},
crds_data::{self, CrdsData, EpochSlotsIndex, LowestSlot, SnapshotHashes, Vote, MAX_VOTES},
crds_filter::{should_retain_crds_value, GossipFilterDirection},
crds_gossip::CrdsGossip,
crds_gossip_error::CrdsGossipError,
crds_gossip_pull::{
get_max_bloom_filter_bytes, CrdsFilter, CrdsTimeouts, ProcessPullStats, PullRequest,
CRDS_GOSSIP_PULL_CRDS_TIMEOUT_MS,
},
crds_value::{CrdsValue, CrdsValueLabel},
epoch_slots::EpochSlots,
epoch_specs::EpochSpecs,
gossip_error::GossipError,
ping_pong::Pong,
protocol::{
split_gossip_messages, Ping, PingCache, Protocol, PruneData,
MAX_INCREMENTAL_SNAPSHOT_HASHES, MAX_PRUNE_DATA_NODES,
PULL_RESPONSE_MAX_PAYLOAD_SIZE, PULL_RESPONSE_MIN_SERIALIZED_SIZE,
PUSH_MESSAGE_MAX_PAYLOAD_SIZE,
},
restart_crds_values::{
RestartHeaviestFork, RestartLastVotedForkSlots, RestartLastVotedForkSlotsError,
},
weighted_shuffle::WeightedShuffle,
},
arc_swap::ArcSwap,
core_affinity::CoreId,
crossbeam_channel::{Receiver, TrySendError},
itertools::{Either, Itertools},
rand::{seq::SliceRandom, CryptoRng, Rng},
rayon::{prelude::*, ThreadPool, ThreadPoolBuilder},
solana_clock::{Slot, DEFAULT_MS_PER_SLOT, DEFAULT_SLOTS_PER_EPOCH},
solana_hash::Hash,
solana_keypair::{signable::Signable, Keypair},
solana_net_utils::{
bind_in_range,
multihomed_sockets::BindIpAddrs,
sockets::{bind_gossip_port_in_range, bind_to_localhost_unique},
PortRange, VALIDATOR_PORT_RANGE,
},
solana_perf::{
data_budget::DataBudget,
packet::{Packet, PacketBatch, PacketBatchRecycler, PacketRef, PinnedPacketBatch},
},
solana_pubkey::Pubkey,
solana_rayon_threadlimit::get_thread_count,
solana_runtime::bank_forks::BankForks,
solana_sanitize::Sanitize,
solana_signature::Signature,
solana_signer::Signer,
solana_streamer::{
packet,
socket::SocketAddrSpace,
streamer::{ChannelSend, PacketBatchReceiver},
},
solana_time_utils::timestamp,
solana_transaction::Transaction,
solana_vote::vote_parser,
std::{
borrow::Borrow,
collections::{HashMap, HashSet},
fmt::Debug,
fs::{self, File},
io::{BufReader, BufWriter, Write},
iter::repeat,
net::{IpAddr, Ipv4Addr, SocketAddr, TcpListener, UdpSocket},
num::NonZeroUsize,
ops::Div,
path::{Path, PathBuf},
rc::Rc,
result::Result,
sync::{
atomic::{AtomicBool, AtomicU64, Ordering},
Arc, Mutex, OnceLock, RwLock, RwLockReadGuard,
},
thread::{sleep, Builder, JoinHandle},
time::{Duration, Instant},
},
thiserror::Error,
};
#[cfg(feature = "duplicate-shred-rocksdb")]
use {
crate::duplicate_shred::DuplicateShred,
crate::protocol::DUPLICATE_SHRED_MAX_PAYLOAD_SIZE,
solana_ledger::shred::Shred,
};
const DEFAULT_EPOCH_DURATION: Duration =
Duration::from_millis(DEFAULT_SLOTS_PER_EPOCH * DEFAULT_MS_PER_SLOT);
pub const GOSSIP_SLEEP_MILLIS: u64 = 100;
const PULL_REQUEST_PERIOD: usize = 5;
const GOSSIP_RUN_LOOP_CORE_OFFSET: usize = 3;
const GOSSIP_RUN_WORK_CORE_OFFSET: usize = 0;
const CHANNEL_CONSUME_CAPACITY: usize = 1024;
const DEFAULT_GOSSIP_SOCKET_CONSUME_PARALLEL_PACKET_THRESHOLD: usize = 1024;
const DEFAULT_GOSSIP_LISTEN_PARALLEL_BATCH_THRESHOLD: usize = 32;
const DEFAULT_GOSSIP_LISTEN_PARALLEL_MESSAGE_THRESHOLD: usize = 256;
pub(crate) const GOSSIP_CHANNEL_CAPACITY: usize = 8192; const GOSSIP_PING_CACHE_CAPACITY: usize = 126976;
const GOSSIP_PING_CACHE_TTL: Duration = Duration::from_secs(1280);
const GOSSIP_PING_CACHE_RATE_LIMIT_DELAY: Duration = Duration::from_secs(1280 / 64);
pub const DEFAULT_CONTACT_DEBUG_INTERVAL_MILLIS: u64 = 0;
pub const DEFAULT_CONTACT_SAVE_INTERVAL_MILLIS: u64 = 60_000;
pub(crate) const CRDS_UNIQUE_PUBKEY_CAPACITY: usize = 8192;
pub const MINIMUM_NUM_TVU_RECEIVE_SOCKETS: NonZeroUsize = NonZeroUsize::new(1).unwrap();
pub const DEFAULT_NUM_TVU_RECEIVE_SOCKETS: NonZeroUsize = MINIMUM_NUM_TVU_RECEIVE_SOCKETS;
pub const MINIMUM_NUM_TVU_RETRANSMIT_SOCKETS: NonZeroUsize = NonZeroUsize::new(1).unwrap();
pub const DEFAULT_NUM_TVU_RETRANSMIT_SOCKETS: NonZeroUsize = NonZeroUsize::new(12).unwrap();
const TRIM_CRDS_TABLE_INTERVAL_MS: u64 = 250;
struct ProcessPacketsScratch {
pings: Vec<(SocketAddr, Ping)>,
pull_requests: Vec<PullRequest>,
pull_responses: Vec<CrdsValue>,
push_messages: Vec<(Pubkey, Vec<CrdsValue>)>,
prune_messages: Vec<PruneData>,
ping_messages: Vec<(SocketAddr, Ping)>,
pong_messages: Vec<(SocketAddr, Pong)>,
}
impl ProcessPacketsScratch {
fn new() -> Self {
Self {
pings: Vec::with_capacity(64),
pull_requests: Vec::with_capacity(64),
pull_responses: Vec::with_capacity(256),
push_messages: Vec::with_capacity(64),
prune_messages: Vec::with_capacity(64),
ping_messages: Vec::with_capacity(64),
pong_messages: Vec::with_capacity(64),
}
}
fn clear(&mut self) {
self.pings.clear();
self.pull_requests.clear();
self.pull_responses.clear();
self.push_messages.clear();
self.prune_messages.clear();
self.ping_messages.clear();
self.pong_messages.clear();
}
}
pub(crate) struct VerifiedPacketBatch {
packets: Vec<(SocketAddr, Protocol)>,
}
fn allowed_gossip_core_ids() -> Vec<CoreId> {
let parsed_allowed_core_ids = std::fs::read_to_string("/proc/self/status")
.ok()
.and_then(|status| parse_allowed_core_ids_from_proc_status(&status));
let allowed_core_ids: Vec<CoreId> = if let Some(allowed_core_ids) = parsed_allowed_core_ids {
allowed_core_ids
.into_iter()
.map(|id| CoreId { id })
.collect()
} else {
core_affinity::get_core_ids().unwrap_or_default()
};
if allowed_core_ids.is_empty() {
return allowed_core_ids;
}
let required_pinned_threads = 1_usize .saturating_add(gossip_socket_consume_threads().saturating_sub(1))
.saturating_add(1) .saturating_add(gossip_listen_threads())
.saturating_add(1) .saturating_add(gossip_run_threads());
if allowed_core_ids.len() < required_pinned_threads {
info!(
"skipping gossip CPU pinning because available cores are insufficient for dedicated placement: allowed_cores={} required_pinned_threads={}",
allowed_core_ids.len(),
required_pinned_threads,
);
return Vec::new();
}
allowed_core_ids
}
fn maybe_pin_gossip_thread(
thread_name: &str,
thread_index: usize,
core_offset: usize,
allowed_core_ids: &[CoreId],
) {
if allowed_core_ids.is_empty() {
return;
}
let selected = allowed_core_ids[(core_offset + thread_index) % allowed_core_ids.len()];
if core_affinity::set_for_current(selected) {
info!(
"pinned gossip thread to CPU core: name={thread_name} index={thread_index} core={}",
selected.id
);
} else {
warn!(
"failed to pin gossip thread to CPU core: name={thread_name} index={thread_index} core={}",
selected.id
);
}
}
fn parse_allowed_core_ids_from_proc_status(status: &str) -> Option<Vec<usize>> {
let cpus_line = status
.lines()
.find(|line| line.starts_with("Cpus_allowed_list:"))?;
let raw = cpus_line.split_once(':')?.1.trim();
if raw.is_empty() {
return None;
}
let mut cores = Vec::new();
for part in raw.split(',') {
let part = part.trim();
if part.is_empty() {
continue;
}
if let Some((start, end)) = part.split_once('-') {
let start = start.trim().parse::<usize>().ok()?;
let end = end.trim().parse::<usize>().ok()?;
if start > end {
return None;
}
cores.extend(start..=end);
} else {
cores.push(part.parse::<usize>().ok()?);
}
}
(!cores.is_empty()).then_some(cores)
}
fn read_usize_env(key: &str) -> Option<usize> {
crate::read_runtime_env_override(key)
.or_else(|| std::env::var(key).ok())
.and_then(|value| value.parse::<usize>().ok())
.filter(|value| *value > 0)
}
pub(crate) fn gossip_receiver_channel_capacity() -> usize {
read_usize_env("SOF_GOSSIP_RECEIVER_CHANNEL_CAPACITY").unwrap_or(GOSSIP_CHANNEL_CAPACITY)
}
pub(crate) fn gossip_socket_consume_channel_capacity() -> usize {
read_usize_env("SOF_GOSSIP_SOCKET_CONSUME_CHANNEL_CAPACITY").unwrap_or(GOSSIP_CHANNEL_CAPACITY)
}
pub(crate) fn gossip_response_channel_capacity() -> usize {
read_usize_env("SOF_GOSSIP_RESPONSE_CHANNEL_CAPACITY").unwrap_or(GOSSIP_CHANNEL_CAPACITY)
}
fn gossip_channel_consume_capacity() -> usize {
read_usize_env("SOF_GOSSIP_CHANNEL_CONSUME_CAPACITY").unwrap_or(CHANNEL_CONSUME_CAPACITY)
}
fn gossip_socket_consume_parallel_packet_threshold() -> usize {
read_usize_env("SOF_GOSSIP_SOCKET_CONSUME_PARALLEL_PACKET_THRESHOLD")
.unwrap_or(DEFAULT_GOSSIP_SOCKET_CONSUME_PARALLEL_PACKET_THRESHOLD)
}
fn gossip_listen_parallel_batch_threshold() -> usize {
static VALUE: OnceLock<usize> = OnceLock::new();
*VALUE.get_or_init(|| {
std::env::var("SOF_GOSSIP_LISTEN_PARALLEL_BATCH_THRESHOLD")
.ok()
.and_then(|value| value.parse().ok())
.filter(|value| *value > 0)
.unwrap_or(DEFAULT_GOSSIP_LISTEN_PARALLEL_BATCH_THRESHOLD)
})
}
fn gossip_listen_parallel_message_threshold() -> usize {
static VALUE: OnceLock<usize> = OnceLock::new();
*VALUE.get_or_init(|| {
std::env::var("SOF_GOSSIP_LISTEN_PARALLEL_MESSAGE_THRESHOLD")
.ok()
.and_then(|value| value.parse().ok())
.filter(|value| *value > 0)
.unwrap_or(DEFAULT_GOSSIP_LISTEN_PARALLEL_MESSAGE_THRESHOLD)
})
}
fn gossip_socket_consume_threads() -> usize {
let default = get_thread_count().min(8);
read_usize_env("SOF_GOSSIP_CONSUME_THREADS").unwrap_or(default)
}
fn gossip_listen_threads() -> usize {
let default = get_thread_count().min(8);
read_usize_env("SOF_GOSSIP_LISTEN_THREADS").unwrap_or(default)
}
fn gossip_run_threads() -> usize {
let default = get_thread_count().min(8);
read_usize_env("SOF_GOSSIP_RUN_THREADS").unwrap_or(default)
}
#[derive(Debug, PartialEq, Eq, Error)]
pub enum ClusterInfoError {
#[error("NoPeers")]
NoPeers,
#[error("NoLeader")]
NoLeader,
#[error("BadContactInfo")]
BadContactInfo,
#[error("BadGossipAddress")]
BadGossipAddress,
#[error("TooManyIncrementalSnapshotHashes")]
TooManyIncrementalSnapshotHashes,
}
pub struct ClusterInfo {
pub gossip: CrdsGossip,
keypair: ArcSwap<Keypair>,
entrypoints: RwLock<Vec<ContactInfo>>,
outbound_budget: DataBudget,
my_contact_info: RwLock<ContactInfo>,
ping_cache: Mutex<PingCache>,
pub(crate) stats: GossipStats,
local_message_pending_push_queue: Mutex<Vec<CrdsValue>>,
last_trim_crds_table_ms: AtomicU64,
contact_debug_interval: u64, contact_save_interval: u64, contact_info_path: PathBuf,
socket_addr_space: SocketAddrSpace,
bind_ip_addrs: Arc<BindIpAddrs>,
}
impl ClusterInfo {
pub fn new(
contact_info: ContactInfo,
keypair: Arc<Keypair>,
socket_addr_space: SocketAddrSpace,
) -> Self {
assert_eq!(contact_info.pubkey(), &keypair.pubkey());
let me = Self {
gossip: CrdsGossip::default(),
keypair: ArcSwap::from(keypair),
entrypoints: RwLock::default(),
outbound_budget: DataBudget::default(),
my_contact_info: RwLock::new(contact_info),
ping_cache: Mutex::new(PingCache::new(
&mut rand::thread_rng(),
Instant::now(),
GOSSIP_PING_CACHE_TTL,
GOSSIP_PING_CACHE_RATE_LIMIT_DELAY,
GOSSIP_PING_CACHE_CAPACITY,
)),
stats: GossipStats::default(),
local_message_pending_push_queue: Mutex::default(),
last_trim_crds_table_ms: AtomicU64::new(0),
contact_debug_interval: DEFAULT_CONTACT_DEBUG_INTERVAL_MILLIS,
contact_info_path: PathBuf::default(),
contact_save_interval: 0, socket_addr_space,
bind_ip_addrs: Arc::new(BindIpAddrs::default()),
};
me.refresh_my_gossip_contact_info();
me
}
pub fn set_contact_debug_interval(&mut self, new: u64) {
self.contact_debug_interval = new;
}
pub fn socket_addr_space(&self) -> &SocketAddrSpace {
&self.socket_addr_space
}
pub fn set_bind_ip_addrs(&mut self, ip_addrs: Arc<BindIpAddrs>) {
self.bind_ip_addrs = ip_addrs;
}
pub fn bind_ip_addrs(&self) -> Arc<BindIpAddrs> {
self.bind_ip_addrs.clone()
}
fn refresh_push_active_set(
&self,
recycler: &PacketBatchRecycler,
stakes: &HashMap<Pubkey, u64>,
gossip_validators: Option<&HashSet<Pubkey>>,
sender: &impl ChannelSend<PacketBatch>,
) {
let shred_version = self.my_contact_info.read().unwrap().shred_version();
let self_keypair = self.keypair();
let mut pings = Vec::new();
self.gossip.refresh_push_active_set(
&self_keypair,
shred_version,
stakes,
gossip_validators,
&self.ping_cache,
&mut pings,
&self.socket_addr_space,
);
let pings = pings
.into_iter()
.map(|(addr, ping)| (addr, Protocol::PingMessage(ping)));
send_gossip_packets(pings, recycler, sender, &self.stats);
}
pub fn insert_info(&self, node: ContactInfo) {
let entry = CrdsValue::new(CrdsData::ContactInfo(node), &self.keypair());
if let Err(err) = {
let mut gossip_crds = self.gossip.crds.write().unwrap();
gossip_crds.insert(entry, timestamp(), GossipRoute::LocalMessage)
} {
error!("ClusterInfo.insert_info: {err:?}");
}
}
pub fn set_entrypoint(&self, entrypoint: ContactInfo) {
self.set_entrypoints(vec![entrypoint]);
}
pub fn set_entrypoints(&self, entrypoints: Vec<ContactInfo>) {
*self.entrypoints.write().unwrap() = entrypoints;
}
pub fn save_contact_info(&self) {
let _st = ScopedTimer::from(&self.stats.save_contact_info_time);
let nodes = {
let entrypoint_gossip_addrs = self
.entrypoints
.read()
.unwrap()
.iter()
.filter_map(ContactInfo::gossip)
.collect::<HashSet<_>>();
let self_pubkey = self.id();
let gossip_crds = self.gossip.crds.read().unwrap();
gossip_crds
.get_nodes()
.filter_map(|v| {
let contact_info = v.value.contact_info().unwrap();
if contact_info.pubkey() != &self_pubkey
&& contact_info
.gossip()
.map(|addr| !entrypoint_gossip_addrs.contains(&addr))
.unwrap_or_default()
{
return Some(v.value.clone());
}
None
})
.collect::<Vec<_>>()
};
if nodes.is_empty() {
return;
}
let filename = self.contact_info_path.join("contact-info.bin");
let tmp_filename = &filename.with_extension("tmp");
match File::create(tmp_filename) {
Ok(file) => {
let mut writer = BufWriter::new(file);
if let Err(err) = bincode::serialize_into(&mut writer, &nodes) {
warn!(
"Failed to serialize contact info info {}: {}",
tmp_filename.display(),
err
);
return;
}
if let Err(err) = writer.flush() {
warn!("Failed to save contact info: {err}");
}
}
Err(err) => {
warn!("Failed to create {}: {}", tmp_filename.display(), err);
return;
}
}
match fs::rename(tmp_filename, &filename) {
Ok(()) => {
info!(
"Saved contact info for {} nodes into {}",
nodes.len(),
filename.display()
);
}
Err(err) => {
warn!(
"Failed to rename {} to {}: {}",
tmp_filename.display(),
filename.display(),
err
);
}
}
}
pub fn restore_contact_info(&mut self, contact_info_path: &Path, contact_save_interval: u64) {
self.contact_info_path = contact_info_path.into();
self.contact_save_interval = contact_save_interval;
let filename = contact_info_path.join("contact-info.bin");
if !filename.exists() {
return;
}
let nodes: Vec<CrdsValue> = match File::open(&filename) {
Ok(file) => {
bincode::deserialize_from(&mut BufReader::new(file)).unwrap_or_else(|err| {
warn!("Failed to deserialize {}: {}", filename.display(), err);
vec![]
})
}
Err(err) => {
warn!("Failed to open {}: {}", filename.display(), err);
vec![]
}
};
info!(
"Loaded contact info for {} nodes from {}",
nodes.len(),
filename.display()
);
let now = timestamp();
let mut gossip_crds = self.gossip.crds.write().unwrap();
for node in nodes {
if let Err(err) = gossip_crds.insert(node, now, GossipRoute::LocalMessage) {
warn!("crds insert failed {err:?}");
}
}
}
pub fn id(&self) -> Pubkey {
self.keypair.load().pubkey()
}
pub fn keypair(&self) -> Arc<Keypair> {
self.keypair.load_full()
}
pub fn set_keypair(&self, new_keypair: Arc<Keypair>) {
let id = new_keypair.pubkey();
self.keypair.store(new_keypair);
self.my_contact_info.write().unwrap().hot_swap_pubkey(id);
self.refresh_my_gossip_contact_info();
}
pub fn set_gossip_socket(&self, gossip_addr: SocketAddr) -> Result<(), ContactInfoError> {
self.my_contact_info
.write()
.unwrap()
.set_gossip(gossip_addr)?;
self.refresh_my_gossip_contact_info();
Ok(())
}
pub fn set_tvu_socket(&self, tvu_addr: SocketAddr) -> Result<(), ContactInfoError> {
self.my_contact_info
.write()
.unwrap()
.set_tvu(contact_info::Protocol::UDP, tvu_addr)?;
self.refresh_my_gossip_contact_info();
Ok(())
}
pub fn set_tpu(&self, tpu_addr: SocketAddr) -> Result<(), ContactInfoError> {
self.my_contact_info
.write()
.unwrap()
.set_tpu(contact_info::Protocol::QUIC, tpu_addr)?;
self.refresh_my_gossip_contact_info();
Ok(())
}
pub fn set_tpu_forwards(&self, tpu_forwards_addr: SocketAddr) -> Result<(), ContactInfoError> {
self.my_contact_info
.write()
.unwrap()
.set_tpu_forwards(contact_info::Protocol::QUIC, tpu_forwards_addr)?;
self.refresh_my_gossip_contact_info();
Ok(())
}
pub fn set_tpu_quic(&self, tpu_addr: SocketAddr) -> Result<(), ContactInfoError> {
self.set_tpu(tpu_addr)
}
pub fn set_tpu_forwards_quic(
&self,
tpu_forwards_addr: SocketAddr,
) -> Result<(), ContactInfoError> {
self.set_tpu_forwards(tpu_forwards_addr)
}
pub fn set_tpu_vote(
&self,
protocol: contact_info::Protocol,
tpu_vote_addr: SocketAddr,
) -> Result<(), ContactInfoError> {
self.my_contact_info
.write()
.unwrap()
.set_tpu_vote(protocol, tpu_vote_addr)?;
self.refresh_my_gossip_contact_info();
Ok(())
}
pub fn lookup_contact_info<R>(
&self,
id: &Pubkey,
query: impl ContactInfoQuery<R>,
) -> Option<R> {
let gossip_crds = self.gossip.crds.read().unwrap();
gossip_crds.get(*id).map(query)
}
pub fn lookup_contact_info_by_gossip_addr(
&self,
gossip_addr: &SocketAddr,
) -> Option<ContactInfo> {
let gossip_crds = self.gossip.crds.read().unwrap();
let mut nodes = gossip_crds.get_nodes_contact_info();
nodes
.find(|node| node.gossip() == Some(*gossip_addr))
.cloned()
}
pub fn my_contact_info(&self) -> ContactInfo {
self.my_contact_info.read().unwrap().clone()
}
pub fn my_shred_version(&self) -> u16 {
self.my_contact_info.read().unwrap().shred_version()
}
fn lookup_epoch_slots(&self, ix: EpochSlotsIndex) -> EpochSlots {
let self_pubkey = self.id();
let label = CrdsValueLabel::EpochSlots(ix, self_pubkey);
let gossip_crds = self.gossip.crds.read().unwrap();
gossip_crds
.get::<&CrdsValue>(&label)
.and_then(|v| v.epoch_slots())
.cloned()
.unwrap_or_else(|| EpochSlots::new(self_pubkey, timestamp()))
}
fn addr_to_string(&self, default_ip: &Option<IpAddr>, addr: &Option<SocketAddr>) -> String {
addr.filter(|addr| self.socket_addr_space.check(addr))
.map(|addr| {
if &Some(addr.ip()) == default_ip {
addr.port().to_string()
} else {
addr.to_string()
}
})
.unwrap_or_else(|| String::from("none"))
}
pub fn rpc_info_trace(&self) -> String {
let now = timestamp();
let my_pubkey = self.id();
let my_shred_version = self.my_shred_version();
let nodes: Vec<_> = self
.all_peers()
.into_iter()
.filter_map(|(node, last_updated)| {
let node_rpc = node
.rpc()
.filter(|addr| self.socket_addr_space.check(addr))?;
let node_version = self.get_node_version(node.pubkey());
if node.shred_version() != my_shred_version {
return None;
}
let rpc_addr = node_rpc.ip();
Some(format!(
"{:15} {:2}| {:5} | {:44} |{:^9}| {:5}| {:5}| {}\n",
rpc_addr.to_string(),
if node.pubkey() == &my_pubkey {
"me"
} else {
""
},
now.saturating_sub(last_updated),
node.pubkey().to_string(),
if let Some(node_version) = node_version {
node_version.to_string()
} else {
"-".to_string()
},
self.addr_to_string(&Some(rpc_addr), &node.rpc()),
self.addr_to_string(&Some(rpc_addr), &node.rpc_pubsub()),
node.shred_version(),
))
})
.collect();
format!(
"RPC Address |Age(ms)| Node identifier \
| Version | RPC |PubSub|ShredVer\n\
------------------+-------+----------------------------------------------\
+---------+------+------+--------\n\
{}\
RPC Enabled Nodes: {}",
nodes.join(""),
nodes.len(),
)
}
pub fn contact_info_trace(&self) -> String {
let now = timestamp();
let mut shred_spy_nodes = 0usize;
let mut total_spy_nodes = 0usize;
let mut different_shred_nodes = 0usize;
let my_pubkey = self.id();
let my_shred_version = self.my_shred_version();
let nodes: Vec<_> = self
.all_peers()
.into_iter()
.filter_map(|(node, last_updated)| {
let is_spy_node = Self::is_spy_node(&node, &self.socket_addr_space);
if is_spy_node {
total_spy_nodes = total_spy_nodes.saturating_add(1);
}
let node_version = self.get_node_version(node.pubkey());
if node.shred_version() != my_shred_version {
different_shred_nodes = different_shred_nodes.saturating_add(1);
None
} else {
if is_spy_node {
shred_spy_nodes = shred_spy_nodes.saturating_add(1);
}
let ip_addr = node.gossip().as_ref().map(SocketAddr::ip);
Some(format!(
"{:15} {:2}| {:5} | {:44} |{:^9}| {:5}| {:5}| {:5}| {:5}| {:5}| {:5}| \
{:5}| {:5}| {}\n",
node.gossip()
.filter(|addr| self.socket_addr_space.check(addr))
.as_ref()
.map(SocketAddr::ip)
.as_ref()
.map(IpAddr::to_string)
.unwrap_or_else(|| String::from("none")),
if node.pubkey() == &my_pubkey {
"me"
} else {
""
},
now.saturating_sub(last_updated),
node.pubkey().to_string(),
if let Some(node_version) = node_version {
node_version.to_string()
} else {
"-".to_string()
},
self.addr_to_string(&ip_addr, &node.gossip()),
self.addr_to_string(&ip_addr, &node.tpu_vote(contact_info::Protocol::UDP)),
self.addr_to_string(&ip_addr, &node.tpu(contact_info::Protocol::UDP)),
self.addr_to_string(
&ip_addr,
&node.tpu_forwards(contact_info::Protocol::UDP)
),
self.addr_to_string(&ip_addr, &node.tvu(contact_info::Protocol::UDP)),
self.addr_to_string(&ip_addr, &node.tvu(contact_info::Protocol::QUIC)),
self.addr_to_string(
&ip_addr,
&node.serve_repair(contact_info::Protocol::UDP)
),
self.addr_to_string(&ip_addr, &node.alpenglow()),
node.shred_version(),
))
}
})
.collect();
format!(
"IP Address |Age(ms)| Node identifier \
| Version |Gossip|TPUvote| TPU |TPUfwd| TVU |TVU Q |ServeR|Alpeng|ShredVer\n\
------------------+-------+----------------------------------------------\
+---------+------+-------+------+------+------+------+------+------+--------\n\
{}\
Nodes: {}{}{}",
nodes.join(""),
nodes.len().saturating_sub(shred_spy_nodes),
if total_spy_nodes > 0 {
format!("\nSpies: {total_spy_nodes}")
} else {
"".to_string()
},
if different_shred_nodes > 0 {
format!("\nNodes with different shred version: {different_shred_nodes}")
} else {
"".to_string()
}
)
}
pub fn push_lowest_slot(&self, min: Slot) {
let self_pubkey = self.id();
let last = {
let gossip_crds = self.gossip.crds.read().unwrap();
gossip_crds
.get::<&LowestSlot>(self_pubkey)
.map(|x| x.lowest)
.unwrap_or_default()
};
if min > last {
let now = timestamp();
let entry = CrdsValue::new(
CrdsData::LowestSlot(0, LowestSlot::new(self_pubkey, min, now)),
&self.keypair(),
);
self.push_message(entry);
}
}
pub fn push_epoch_slots(&self, mut update: &[Slot]) {
let self_pubkey = self.id();
let current_slots: Vec<_> = {
let gossip_crds =
self.time_gossip_read_lock("lookup_epoch_slots", &self.stats.epoch_slots_lookup);
(0..crds_data::MAX_EPOCH_SLOTS)
.filter_map(|ix| {
let label = CrdsValueLabel::EpochSlots(ix, self_pubkey);
let crds_value = gossip_crds.get::<&CrdsValue>(&label)?;
let epoch_slots = crds_value.epoch_slots()?;
let first_slot = epoch_slots.first_slot()?;
Some((epoch_slots.wallclock, first_slot, ix))
})
.collect()
};
let min_slot: Slot = current_slots
.iter()
.map(|(_wallclock, slot, _index)| *slot)
.min()
.unwrap_or_default();
let max_slot: Slot = update.iter().max().cloned().unwrap_or(0);
let total_slots = max_slot as isize - min_slot as isize;
if DEFAULT_SLOTS_PER_EPOCH as isize > total_slots
&& crds_data::MAX_EPOCH_SLOTS as usize <= current_slots.len()
{
self.stats.epoch_slots_filled.add_relaxed(1);
warn!(
"EPOCH_SLOTS are filling up FAST {}/{}",
total_slots,
current_slots.len()
);
}
let mut reset = false;
let mut epoch_slot_index = match current_slots.iter().max() {
Some((_wallclock, _slot, index)) => *index,
None => 0,
};
let mut entries = Vec::default();
let keypair = self.keypair();
while !update.is_empty() {
let now = timestamp();
let mut slots = if !reset {
self.lookup_epoch_slots(epoch_slot_index)
} else {
EpochSlots::new(self_pubkey, now)
};
let n = slots.fill(update, now);
update = &update[n..];
if n > 0 {
let epoch_slots = CrdsData::EpochSlots(epoch_slot_index, slots);
let entry = CrdsValue::new(epoch_slots, &keypair);
entries.push(entry);
}
epoch_slot_index = epoch_slot_index.wrapping_add(1);
reset = true;
}
let mut gossip_crds = self.gossip.crds.write().unwrap();
let now = timestamp();
for entry in entries {
if let Err(err) = gossip_crds.insert(entry, now, GossipRoute::LocalMessage) {
error!("push_epoch_slots failed: {err:?}");
}
}
}
pub fn push_restart_last_voted_fork_slots(
&self,
fork: &[Slot],
last_vote_bankhash: Hash,
) -> Result<(), RestartLastVotedForkSlotsError> {
let now = timestamp();
let last_voted_fork_slots = RestartLastVotedForkSlots::new(
self.id(),
now,
fork,
last_vote_bankhash,
self.my_shred_version(),
)?;
self.push_message(CrdsValue::new(
CrdsData::RestartLastVotedForkSlots(last_voted_fork_slots),
&self.keypair(),
));
Ok(())
}
pub fn push_restart_heaviest_fork(
&self,
last_slot: Slot,
last_slot_hash: Hash,
observed_stake: u64,
) {
let restart_heaviest_fork = RestartHeaviestFork {
from: self.id(),
wallclock: timestamp(),
last_slot,
last_slot_hash,
observed_stake,
shred_version: self.my_shred_version(),
};
self.push_message(CrdsValue::new(
CrdsData::RestartHeaviestFork(restart_heaviest_fork),
&self.keypair(),
));
}
fn time_gossip_read_lock<'a>(
&'a self,
label: &'static str,
counter: &'a Counter,
) -> TimedGuard<'a, RwLockReadGuard<'a, Crds>> {
TimedGuard::new(self.gossip.crds.read().unwrap(), label, counter)
}
fn push_message(&self, message: CrdsValue) {
self.local_message_pending_push_queue
.lock()
.unwrap()
.push(message);
}
pub fn push_snapshot_hashes(
&self,
full: (Slot, Hash),
incremental: Vec<(Slot, Hash)>,
) -> Result<(), ClusterInfoError> {
if incremental.len() > MAX_INCREMENTAL_SNAPSHOT_HASHES {
return Err(ClusterInfoError::TooManyIncrementalSnapshotHashes);
}
let message = CrdsData::SnapshotHashes(SnapshotHashes {
from: self.id(),
full,
incremental,
wallclock: timestamp(),
});
self.push_message(CrdsValue::new(message, &self.keypair()));
Ok(())
}
pub fn push_vote_at_index(&self, vote: Transaction, vote_index: u8) {
assert!(vote_index < MAX_VOTES);
let self_pubkey = self.id();
let now = timestamp();
let vote = Vote::new(self_pubkey, vote, now).unwrap();
let vote = CrdsData::Vote(vote_index, vote);
let vote = CrdsValue::new(vote, &self.keypair());
let mut gossip_crds = self.gossip.crds.write().unwrap();
if let Err(err) = gossip_crds.insert(vote, now, GossipRoute::LocalMessage) {
error!("push_vote failed: {err:?}");
}
}
fn find_vote_index_to_evict(&self, new_vote_slot: Slot) -> Option<u8> {
let self_pubkey = self.id();
let mut num_crds_votes = 0;
let mut exists_newer_vote = false;
let vote_index = {
let gossip_crds =
self.time_gossip_read_lock("gossip_read_push_vote", &self.stats.push_vote_read);
(0..MAX_VOTES)
.filter_map(|ix| {
let vote = CrdsValueLabel::Vote(ix, self_pubkey);
let vote: &CrdsData = gossip_crds.get(&vote)?;
num_crds_votes += 1;
match &vote {
CrdsData::Vote(_, vote) if vote.slot() < Some(new_vote_slot) => {
Some((vote.wallclock, ix))
}
CrdsData::Vote(_, _) => {
exists_newer_vote = true;
None
}
_ => panic!("this should not happen!"),
}
})
.min() .map(|(_ /*wallclock*/, ix)| ix)
};
if exists_newer_vote {
return None;
}
if num_crds_votes < MAX_VOTES {
Some(num_crds_votes)
} else {
vote_index
}
}
pub fn push_vote(&self, tower: &[Slot], vote: Transaction) {
debug_assert!(tower.iter().tuple_windows().all(|(a, b)| a < b));
let Some(vote_index) =
self.find_vote_index_to_evict(tower.last().copied().expect("Cannot push empty vote"))
else {
let (_, vote, hash, _) = vote_parser::parse_vote_transaction(&vote).unwrap();
panic!(
"Submitting old vote, switch: {}, vote slots: {:?}, tower: {:?}",
hash.is_some(),
vote.slots(),
tower
);
};
debug_assert!(vote_index < MAX_VOTES);
self.push_vote_at_index(vote, vote_index);
}
pub fn refresh_vote(&self, refresh_vote: Transaction, refresh_vote_slot: Slot) {
let vote_index = {
let self_pubkey = self.id();
let gossip_crds =
self.time_gossip_read_lock("gossip_read_push_vote", &self.stats.push_vote_read);
(0..MAX_VOTES).find(|ix| {
let vote = CrdsValueLabel::Vote(*ix, self_pubkey);
let Some(vote) = gossip_crds.get::<&CrdsData>(&vote) else {
return false;
};
let CrdsData::Vote(_, prev_vote) = &vote else {
panic!("this should not happen!");
};
match prev_vote.slot() {
Some(prev_vote_slot) => prev_vote_slot == refresh_vote_slot,
None => {
error!("crds vote with no slots!");
false
}
}
})
};
if let Some(vote_index) = vote_index {
self.push_vote_at_index(refresh_vote, vote_index);
} else {
let Some(vote_index) = self.find_vote_index_to_evict(refresh_vote_slot) else {
warn!(
"trying to refresh slot {refresh_vote_slot} but all votes in gossip table are \
for newer slots",
);
return;
};
debug_assert!(vote_index < MAX_VOTES);
self.push_vote_at_index(refresh_vote, vote_index);
}
}
pub fn get_votes(&self, cursor: &mut Cursor) -> Vec<Transaction> {
let txs: Vec<Transaction> = self
.time_gossip_read_lock("get_votes", &self.stats.get_votes)
.get_votes(cursor)
.map(|vote| {
let CrdsData::Vote(_, vote) = vote.value.data() else {
panic!("this should not happen!");
};
vote.transaction().clone()
})
.collect();
self.stats.get_votes_count.add_relaxed(txs.len() as u64);
txs
}
pub fn get_votes_with_labels(
&self,
cursor: &mut Cursor,
) -> (Vec<CrdsValueLabel>, Vec<Transaction>) {
let (labels, txs): (_, Vec<_>) = self
.time_gossip_read_lock("get_votes", &self.stats.get_votes)
.get_votes(cursor)
.map(|vote| {
let label = vote.value.label();
let CrdsData::Vote(_, vote) = vote.value.data() else {
panic!("this should not happen!");
};
(label, vote.transaction().clone())
})
.unzip();
self.stats.get_votes_count.add_relaxed(txs.len() as u64);
(labels, txs)
}
#[cfg(feature = "duplicate-shred-rocksdb")]
pub fn push_duplicate_shred(
&self,
shred: &Shred,
other_payload: &[u8],
) -> Result<(), GossipError> {
self.gossip.push_duplicate_shred(
&self.keypair(),
shred,
other_payload,
None::<fn(Slot) -> Option<Pubkey>>, DUPLICATE_SHRED_MAX_PAYLOAD_SIZE,
self.my_shred_version(),
)?;
Ok(())
}
pub fn get_snapshot_hashes_for_node(&self, pubkey: &Pubkey) -> Option<SnapshotHashes> {
self.gossip
.crds
.read()
.unwrap()
.get::<&SnapshotHashes>(*pubkey)
.cloned()
}
pub fn get_epoch_slots(&self, cursor: &mut Cursor) -> Vec<EpochSlots> {
let self_shred_version = Some(self.my_shred_version());
let gossip_crds = self.gossip.crds.read().unwrap();
gossip_crds
.get_epoch_slots(cursor)
.filter(|entry| {
let origin = entry.value.pubkey();
gossip_crds.get_shred_version(&origin) == self_shred_version
})
.map(|entry| match entry.value.data() {
CrdsData::EpochSlots(_, slots) => slots.clone(),
_ => panic!("this should not happen!"),
})
.collect()
}
pub fn get_restart_last_voted_fork_slots(
&self,
cursor: &mut Cursor,
) -> Vec<RestartLastVotedForkSlots> {
let self_shred_version = self.my_shred_version();
let gossip_crds = self.gossip.crds.read().unwrap();
gossip_crds
.get_entries(cursor)
.filter_map(|entry| {
let CrdsData::RestartLastVotedForkSlots(slots) = entry.value.data() else {
return None;
};
(slots.shred_version == self_shred_version).then_some(slots)
})
.cloned()
.collect()
}
pub fn get_restart_heaviest_fork(&self, cursor: &mut Cursor) -> Vec<RestartHeaviestFork> {
let self_shred_version = self.my_shred_version();
let gossip_crds = self.gossip.crds.read().unwrap();
gossip_crds
.get_entries(cursor)
.filter_map(|entry| {
let CrdsData::RestartHeaviestFork(fork) = entry.value.data() else {
return None;
};
(fork.shred_version == self_shred_version).then_some(fork)
})
.cloned()
.collect()
}
#[cfg(feature = "duplicate-shred-rocksdb")]
pub(crate) fn get_duplicate_shreds(&self, cursor: &mut Cursor) -> Vec<DuplicateShred> {
let gossip_crds = self.gossip.crds.read().unwrap();
gossip_crds
.get_duplicate_shreds(cursor)
.map(|entry| match entry.value.data() {
CrdsData::DuplicateShred(_, dup) => dup.clone(),
_ => panic!("this should not happen!"),
})
.collect()
}
pub fn get_node_version(&self, pubkey: &Pubkey) -> Option<solana_version::Version> {
let gossip_crds = self.gossip.crds.read().unwrap();
gossip_crds
.get::<&ContactInfo>(*pubkey)
.map(ContactInfo::version)
.cloned()
}
fn check_socket_addr_space(&self, addr: &Option<SocketAddr>) -> bool {
addr.as_ref()
.map(|addr| self.socket_addr_space.check(addr))
.unwrap_or_default()
}
pub fn rpc_peers(&self) -> Vec<ContactInfo> {
let self_pubkey = self.id();
let self_shred_version = self.my_shred_version();
let gossip_crds = self.gossip.crds.read().unwrap();
gossip_crds
.get_nodes_contact_info()
.filter(|node| {
node.pubkey() != &self_pubkey
&& self.check_socket_addr_space(&node.rpc())
&& node.shred_version() == self_shred_version
})
.cloned()
.collect()
}
pub fn all_peers(&self) -> Vec<(ContactInfo, u64)> {
let self_shred_version = self.my_shred_version();
let gossip_crds = self.gossip.crds.read().unwrap();
gossip_crds
.get_nodes()
.filter_map(|node| {
let contact_info = node.value.contact_info()?;
(contact_info.shred_version() == self_shred_version)
.then(|| (contact_info.clone(), node.local_timestamp))
})
.collect()
}
pub fn gossip_peers(&self) -> Vec<ContactInfo> {
let me = self.id();
let self_shred_version = self.my_shred_version();
let gossip_crds = self.gossip.crds.read().unwrap();
gossip_crds
.get_nodes_contact_info()
.filter(|node| {
node.pubkey() != &me
&& self.check_socket_addr_space(&node.gossip())
&& node.shred_version() == self_shred_version
})
.cloned()
.collect()
}
pub fn tvu_peers<R>(&self, query: impl ContactInfoQuery<R>) -> Vec<R> {
let self_pubkey = self.id();
let self_shred_version = self.my_shred_version();
self.time_gossip_read_lock("tvu_peers", &self.stats.tvu_peers)
.get_nodes_contact_info()
.filter(|node| {
node.pubkey() != &self_pubkey
&& node.shred_version() == self_shred_version
&& self.check_socket_addr_space(&node.tvu(contact_info::Protocol::UDP))
})
.map(query)
.collect()
}
pub fn repair_peers(&self, slot: Slot) -> Vec<ContactInfo> {
let _st = ScopedTimer::from(&self.stats.repair_peers);
let self_pubkey = self.id();
let self_shred_version = self.my_shred_version();
let gossip_crds = self.gossip.crds.read().unwrap();
gossip_crds
.get_nodes_contact_info()
.filter(|node| {
node.pubkey() != &self_pubkey
&& node.shred_version() == self_shred_version
&& self.check_socket_addr_space(&node.tvu(contact_info::Protocol::UDP))
&& self.check_socket_addr_space(&node.serve_repair(contact_info::Protocol::UDP))
&& match gossip_crds.get::<&LowestSlot>(*node.pubkey()) {
None => true, Some(lowest_slot) => lowest_slot.lowest <= slot,
}
})
.cloned()
.collect()
}
fn is_spy_node(node: &ContactInfo, socket_addr_space: &SocketAddrSpace) -> bool {
![
node.tpu(contact_info::Protocol::UDP),
node.gossip(),
node.tvu(contact_info::Protocol::UDP),
]
.into_iter()
.all(|addr| {
addr.map(|addr| socket_addr_space.check(&addr))
.unwrap_or_default()
})
}
pub fn tpu_peers(&self) -> Vec<ContactInfo> {
let self_pubkey = self.id();
let gossip_crds = self.gossip.crds.read().unwrap();
gossip_crds
.get_nodes_contact_info()
.filter(|node| {
node.pubkey() != &self_pubkey
&& self.check_socket_addr_space(&node.tpu(contact_info::Protocol::UDP))
})
.cloned()
.collect()
}
fn refresh_my_gossip_contact_info(&self) {
let keypair = self.keypair();
let node = {
let mut node = self.my_contact_info.write().unwrap();
node.set_wallclock(timestamp());
node.clone()
};
let node = CrdsValue::new(CrdsData::ContactInfo(node), &keypair);
if let Err(err) = {
let mut gossip_crds = self.gossip.crds.write().unwrap();
gossip_crds.insert(node, timestamp(), GossipRoute::LocalMessage)
} {
error!("refresh_my_gossip_contact_info failed: {err:?}");
}
}
fn append_entrypoint_to_pulls(
&self,
thread_pool: &ThreadPool,
max_bloom_filter_bytes: usize,
pulls: impl Iterator<Item = (SocketAddr, CrdsFilter)> + Clone,
) -> impl Iterator<Item = (SocketAddr, CrdsFilter)> {
const THROTTLE_DELAY: u64 = CRDS_GOSSIP_PULL_CRDS_TIMEOUT_MS / 2;
let mut pulls = pulls.peekable();
let entrypoint = {
let mut entrypoints = self.entrypoints.write().unwrap();
let Some(entrypoint) = entrypoints.choose_mut(&mut rand::thread_rng()) else {
return Either::Left(pulls);
};
if pulls.peek().is_some() {
let now = timestamp();
if now <= entrypoint.wallclock().saturating_add(THROTTLE_DELAY) {
return Either::Left(pulls);
}
entrypoint.set_wallclock(now);
if let Some(entrypoint_gossip) = entrypoint.gossip() {
if self
.time_gossip_read_lock("entrypoint", &self.stats.entrypoint)
.get_nodes_contact_info()
.any(|node| node.gossip() == Some(entrypoint_gossip))
{
return Either::Left(pulls);
}
}
}
let Some(entrypoint) = entrypoint.gossip() else {
return Either::Left(pulls);
};
entrypoint
};
let filters = if pulls.peek().is_none() {
let _st = ScopedTimer::from(&self.stats.entrypoint2);
Either::Left(
self.gossip
.pull
.build_crds_filters(thread_pool, &self.gossip.crds, max_bloom_filter_bytes)
.into_iter(),
)
} else {
Either::Right(pulls.clone().map(|(_, filter)| filter))
};
self.stats.pull_from_entrypoint_count.add_relaxed(1);
Either::Right(pulls.chain(repeat(entrypoint).zip(filters)))
}
fn new_pull_requests(
&self,
thread_pool: &ThreadPool,
gossip_validators: Option<&HashSet<Pubkey>>,
stakes: &HashMap<Pubkey, u64>,
) -> impl Iterator<Item = (SocketAddr, Protocol)> {
let now = timestamp();
let keypair = self.keypair();
let mut contact_info = self.my_contact_info();
contact_info.set_wallclock(now);
let self_info = CrdsValue::new(CrdsData::from(contact_info), &keypair);
let max_bloom_filter_bytes = get_max_bloom_filter_bytes(&self_info);
let mut pings = Vec::new();
let pulls = {
let _st = ScopedTimer::from(&self.stats.new_pull_requests);
self.gossip
.new_pull_request(
thread_pool,
&keypair,
self.my_shred_version(),
now,
gossip_validators,
stakes,
max_bloom_filter_bytes,
&self.ping_cache,
&mut pings,
&self.socket_addr_space,
)
.into_iter()
.flatten()
};
let pings = pings
.into_iter()
.map(|(addr, ping)| (addr, Protocol::PingMessage(ping)));
self.append_entrypoint_to_pulls(thread_pool, max_bloom_filter_bytes, pulls)
.map(move |(gossip_addr, filter)| {
let request = Protocol::PullRequest(filter, self_info.clone());
(gossip_addr, request)
})
.chain(pings)
}
pub fn flush_push_queue(&self) {
let entries: Vec<CrdsValue> =
std::mem::take(&mut *self.local_message_pending_push_queue.lock().unwrap());
if !entries.is_empty() {
let mut gossip_crds = self.gossip.crds.write().unwrap();
let now = timestamp();
for entry in entries {
let _ = gossip_crds.insert(entry, now, GossipRoute::LocalMessage);
}
}
}
fn new_push_requests(
&self,
stakes: &HashMap<Pubkey, u64>,
) -> impl Iterator<Item = (SocketAddr, Protocol)> {
let self_id = self.id();
let (entries, push_messages, num_pushes) = {
let _st = ScopedTimer::from(&self.stats.new_push_requests);
self.flush_push_queue();
self.gossip
.new_push_messages(&self_id, timestamp(), stakes, |value| {
should_retain_crds_value(value, stakes, GossipFilterDirection::EgressPush)
})
};
self.stats
.push_fanout_num_entries
.add_relaxed(entries.len() as u64);
self.stats
.push_fanout_num_nodes
.add_relaxed(num_pushes as u64);
let push_messages: Vec<_> = {
let gossip_crds =
self.time_gossip_read_lock("push_req_lookup", &self.stats.new_push_requests2);
push_messages
.into_iter()
.filter_map(|(pubkey, messages)| {
let addr = get_node_addr(
pubkey,
ContactInfo::gossip,
&gossip_crds,
&self.socket_addr_space,
)?;
Some((addr, messages))
})
.collect()
};
let entries = Rc::new(entries);
push_messages
.into_iter()
.flat_map(move |(peer, msgs): (SocketAddr, Vec<usize>)| {
let entries = Rc::clone(&entries);
let msgs = msgs.into_iter().map(move |k| entries[k].clone());
let msgs = split_gossip_messages(PUSH_MESSAGE_MAX_PAYLOAD_SIZE, msgs)
.map(move |msgs| Protocol::PushMessage(self_id, msgs));
repeat(peer).zip(msgs)
})
}
fn generate_new_gossip_requests(
&self,
thread_pool: &ThreadPool,
gossip_validators: Option<&HashSet<Pubkey>>,
stakes: &HashMap<Pubkey, u64>,
generate_pull_requests: bool,
) -> impl Iterator<Item = (SocketAddr, Protocol)> {
self.trim_crds_table(CRDS_UNIQUE_PUBKEY_CAPACITY, stakes);
let out = self.new_push_requests(stakes);
if generate_pull_requests {
let reqs = self.new_pull_requests(thread_pool, gossip_validators, stakes);
Either::Right(out.chain(reqs))
} else {
Either::Left(out)
}
}
fn run_gossip(
&self,
thread_pool: &ThreadPool,
gossip_validators: Option<&HashSet<Pubkey>>,
recycler: &PacketBatchRecycler,
stakes: &HashMap<Pubkey, u64>,
sender: &impl ChannelSend<PacketBatch>,
generate_pull_requests: bool,
) -> Result<(), GossipError> {
let _st = ScopedTimer::from(&self.stats.gossip_transmit_loop_time);
let mut packet_batch =
PinnedPacketBatch::new_unpinned_with_recycler(recycler, 0, "run_gossip");
self.generate_new_gossip_requests(
thread_pool,
gossip_validators,
stakes,
generate_pull_requests,
)
.filter_map(|(addr, data)| make_gossip_packet(addr, &data, &self.stats))
.for_each(|pkt| packet_batch.push(pkt));
if !packet_batch.is_empty() {
if let Err(TrySendError::Full(packet_batch)) = sender.try_send(packet_batch.into()) {
self.stats
.gossip_transmit_packets_dropped_count
.add_relaxed(packet_batch.len() as u64);
}
}
self.stats
.gossip_transmit_loop_iterations_since_last_report
.add_relaxed(1);
Ok(())
}
fn process_entrypoints(&self) -> bool {
let mut entrypoints = self.entrypoints.write().unwrap();
if entrypoints.is_empty() {
return true;
}
for entrypoint in entrypoints.iter_mut() {
if entrypoint.pubkey() == &Pubkey::default() {
if let Some(entrypoint_from_gossip) = entrypoint
.gossip()
.and_then(|addr| self.lookup_contact_info_by_gossip_addr(&addr))
{
*entrypoint = entrypoint_from_gossip;
}
}
}
entrypoints
.iter()
.all(|entrypoint| entrypoint.pubkey() != &Pubkey::default())
}
fn handle_purge(
&self,
thread_pool: &ThreadPool,
epoch_duration: Duration,
stakes: &HashMap<Pubkey, u64>,
) {
let self_pubkey = self.id();
let timeouts = self
.gossip
.make_timeouts(self_pubkey, stakes, epoch_duration);
let num_purged = {
let _st = ScopedTimer::from(&self.stats.purge);
self.gossip
.purge(&self_pubkey, thread_pool, timestamp(), &timeouts)
};
self.stats.purge_count.add_relaxed(num_purged as u64);
}
fn trim_crds_table(&self, cap: usize, stakes: &HashMap<Pubkey, u64>) {
let now = timestamp();
let last_trim = self.last_trim_crds_table_ms.load(Ordering::Relaxed);
if now.saturating_sub(last_trim) < TRIM_CRDS_TABLE_INTERVAL_MS {
return;
}
if self
.last_trim_crds_table_ms
.compare_exchange(last_trim, now, Ordering::Relaxed, Ordering::Relaxed)
.is_err()
{
return;
}
if !self.gossip.crds.read().unwrap().should_trim(cap) {
return;
}
let keep: Vec<_> = self
.entrypoints
.read()
.unwrap()
.iter()
.map(ContactInfo::pubkey)
.copied()
.chain(std::iter::once(self.id()))
.collect();
self.stats.trim_crds_table.add_relaxed(1);
let mut gossip_crds = self.gossip.crds.write().unwrap();
match gossip_crds.trim(cap, &keep, stakes, now) {
Err(err) => {
self.stats.trim_crds_table_failed.add_relaxed(1);
debug!("crds table trim failed: {err:?}");
}
Ok(num_purged) => {
self.stats
.trim_crds_table_purged_values_count
.add_relaxed(num_purged as u64);
}
}
}
pub fn gossip(
self: Arc<Self>,
bank_forks: Option<Arc<RwLock<BankForks>>>,
sender: impl ChannelSend<PacketBatch>,
gossip_validators: Option<HashSet<Pubkey>>,
exit: Arc<AtomicBool>,
) -> JoinHandle<()> {
let allowed_core_ids = allowed_gossip_core_ids();
let thread_pool = ThreadPoolBuilder::new()
.num_threads(gossip_run_threads())
.thread_name(|i| format!("solGossipRun{i:02}"))
.start_handler({
let allowed_core_ids = allowed_core_ids.clone();
move |index| {
maybe_pin_gossip_thread(
"solGossipRun",
index,
GOSSIP_RUN_WORK_CORE_OFFSET,
&allowed_core_ids,
);
}
})
.build()
.unwrap();
let mut epoch_specs = bank_forks.map(EpochSpecs::from);
Builder::new()
.name("solGossip".to_string())
.spawn(move || {
maybe_pin_gossip_thread(
"solGossip",
0,
GOSSIP_RUN_LOOP_CORE_OFFSET,
&allowed_core_ids,
);
let mut last_push = 0;
let mut last_contact_info_trace = timestamp();
let mut last_contact_info_save = timestamp();
let mut entrypoints_processed = false;
let recycler = PacketBatchRecycler::default();
let empty_stakes = HashMap::new();
for gossip_round in 0usize.. {
if exit.load(Ordering::Relaxed) {
break;
}
let start = timestamp();
if self.contact_debug_interval != 0
&& start - last_contact_info_trace > self.contact_debug_interval
{
info!(
"\n{}\n\n{}",
self.contact_info_trace(),
self.rpc_info_trace()
);
last_contact_info_trace = start;
}
if self.contact_save_interval != 0
&& start - last_contact_info_save > self.contact_save_interval
{
self.save_contact_info();
last_contact_info_save = start;
}
let (stakes, epoch_duration) = if let Some(epoch_specs) = epoch_specs.as_mut() {
let epoch_duration = epoch_specs.epoch_duration();
(
epoch_specs.current_epoch_staked_nodes().as_ref(),
epoch_duration,
)
} else {
(&empty_stakes, DEFAULT_EPOCH_DURATION)
};
let _ = self.run_gossip(
&thread_pool,
gossip_validators.as_ref(),
&recycler,
stakes,
&sender,
gossip_round % PULL_REQUEST_PERIOD == 0,
);
self.handle_purge(&thread_pool, epoch_duration, stakes);
entrypoints_processed = entrypoints_processed || self.process_entrypoints();
if start - last_push > CRDS_GOSSIP_PULL_CRDS_TIMEOUT_MS / 2 {
self.refresh_my_gossip_contact_info();
self.refresh_push_active_set(
&recycler,
stakes,
gossip_validators.as_ref(),
&sender,
);
last_push = timestamp();
}
let elapsed = timestamp() - start;
if GOSSIP_SLEEP_MILLIS > elapsed {
let time_left = GOSSIP_SLEEP_MILLIS - elapsed;
sleep(Duration::from_millis(time_left));
}
}
})
.unwrap()
}
fn handle_batch_prune_messages(
&self,
messages: &mut Vec<PruneData>,
stakes: &HashMap<Pubkey, u64>,
) {
let _st = ScopedTimer::from(&self.stats.handle_batch_prune_messages_time);
if messages.is_empty() {
return;
}
self.stats
.prune_message_len
.add_relaxed(messages.iter().map(|data| data.prunes.len() as u64).sum());
let mut prune_message_timeout = 0;
let mut bad_prune_destination = 0;
let self_pubkey = self.id();
{
let _st = ScopedTimer::from(&self.stats.process_prune);
let now = timestamp();
for data in messages.drain(..) {
match self.gossip.process_prune_msg(
&self_pubkey,
&data.pubkey,
&data.destination,
&data.prunes,
data.wallclock,
now,
stakes,
) {
Err(CrdsGossipError::PruneMessageTimeout) => {
prune_message_timeout += 1;
}
Err(CrdsGossipError::BadPruneDestination) => {
bad_prune_destination += 1;
}
_ => (),
}
}
}
if prune_message_timeout != 0 {
self.stats
.prune_message_timeout
.add_relaxed(prune_message_timeout);
}
if bad_prune_destination != 0 {
self.stats
.bad_prune_destination
.add_relaxed(bad_prune_destination);
}
}
fn handle_batch_pull_requests(
&self,
requests: &mut Vec<PullRequest>,
thread_pool: &ThreadPool,
recycler: &PacketBatchRecycler,
stakes: &HashMap<Pubkey, u64>,
response_sender: &impl ChannelSend<PacketBatch>,
) {
let _st = ScopedTimer::from(&self.stats.handle_batch_pull_requests_time);
if !requests.is_empty() {
let response = self.handle_pull_requests(thread_pool, recycler, requests, stakes);
if !response.is_empty() {
if let Err(TrySendError::Full(response)) = response_sender.try_send(response.into())
{
self.stats
.gossip_packets_dropped_count
.add_relaxed(response.len() as u64);
}
}
}
}
fn update_data_budget(&self, num_staked: usize) -> usize {
const INTERVAL_MS: u64 = 100;
const BYTES_PER_INTERVAL: usize = 1024;
const MAX_BUDGET_MULTIPLE: usize = 5; let num_staked = num_staked.max(2);
self.outbound_budget.update(INTERVAL_MS, |bytes| {
std::cmp::min(
bytes + num_staked * BYTES_PER_INTERVAL,
MAX_BUDGET_MULTIPLE * num_staked * BYTES_PER_INTERVAL,
)
})
}
fn check_pull_request<'a, R>(
&'a self,
now: Instant,
rng: &'a mut R,
packet_batch: &'a mut PinnedPacketBatch,
) -> impl FnMut(&PullRequest) -> bool + 'a
where
R: Rng + CryptoRng,
{
let mut cache = HashMap::<(Pubkey, SocketAddr), bool>::new();
let mut ping_cache = self.ping_cache.lock().unwrap();
let mut hard_check = move |node| {
let (check, ping) = ping_cache.check(rng, &self.keypair(), now, node);
if let Some(ping) = ping {
let ping = Protocol::PingMessage(ping);
if let Some(pkt) = make_gossip_packet(node.1, &ping, &self.stats) {
packet_batch.push(pkt);
}
}
if !check {
self.stats
.pull_request_ping_pong_check_failed_count
.add_relaxed(1)
}
check
};
move |request| {
ContactInfo::is_valid_address(&request.addr, &self.socket_addr_space) && {
let node = (request.pubkey, request.addr);
*cache.entry(node).or_insert_with(|| hard_check(node))
}
}
}
fn handle_pull_requests(
&self,
thread_pool: &ThreadPool,
recycler: &PacketBatchRecycler,
requests: &mut Vec<PullRequest>,
stakes: &HashMap<Pubkey, u64>,
) -> PinnedPacketBatch {
const DEFAULT_EPOCH_DURATION_MS: u64 = DEFAULT_SLOTS_PER_EPOCH * DEFAULT_MS_PER_SLOT;
let output_size_limit =
self.update_data_budget(stakes.len()) / PULL_RESPONSE_MIN_SERIALIZED_SIZE;
let mut packet_batch =
PinnedPacketBatch::new_unpinned_with_recycler(recycler, 64, "handle_pull_requests");
let mut rng = rand::thread_rng();
requests.retain({
let now = Instant::now();
self.check_pull_request(now, &mut rng, &mut packet_batch)
});
let now = timestamp();
let self_id = self.id();
let pull_responses = {
let _st = ScopedTimer::from(&self.stats.generate_pull_responses);
self.gossip.generate_pull_responses(
thread_pool,
requests,
output_size_limit,
now,
|value| {
should_retain_crds_value(
value,
stakes,
GossipFilterDirection::EgressPullResponse,
)
},
self.my_shred_version(),
&self.stats,
)
};
let get_score = |value: &CrdsValue| -> u64 {
let age = now.saturating_sub(value.wallclock());
let score = DEFAULT_EPOCH_DURATION_MS
.saturating_sub(age)
.div(CRDS_GOSSIP_PULL_CRDS_TIMEOUT_MS)
.max(1);
let score = if stakes.contains_key(&value.pubkey()) {
2 * score
} else {
score
};
let score = match value.data() {
CrdsData::ContactInfo(_) => 2 * score,
_ => score,
};
score
};
let mut num_crds_values = 0;
let (scores, mut pull_responses): (Vec<_>, Vec<_>) = requests
.iter()
.zip(pull_responses)
.flat_map(|(PullRequest { addr, .. }, values)| {
num_crds_values += values.len();
split_gossip_messages(PULL_RESPONSE_MAX_PAYLOAD_SIZE, values).map(move |values| {
let score = values.iter().map(get_score).max().unwrap_or_default();
(score, (addr, values))
})
})
.collect();
let (total_bytes, sent_crds_values) = WeightedShuffle::new("handle-pull-requests", scores)
.shuffle(&mut rng)
.filter_map(|k| {
let (addr, values) = &mut pull_responses[k];
let num_values = values.len();
let response = Protocol::PullResponse(self_id, std::mem::take(values));
let packet = make_gossip_packet(*addr, &response, &self.stats)?;
Some((packet, num_values))
})
.take_while(|(packet, _)| {
if self.outbound_budget.take(packet.meta().size) {
true
} else {
self.stats.gossip_pull_request_no_budget.add_relaxed(1);
false
}
})
.map(|(packet, num_values)| {
let num_bytes = packet.meta().size;
packet_batch.push(packet);
(num_bytes, num_values)
})
.fold((0, 0), |a, b| (a.0 + b.0, a.1 + b.1));
let dropped_responses = num_crds_values.saturating_sub(sent_crds_values);
self.stats
.gossip_pull_request_dropped_requests
.add_relaxed(dropped_responses as u64);
self.stats
.gossip_pull_request_sent_bytes
.add_relaxed(total_bytes as u64);
packet_batch
}
fn handle_batch_pull_responses(
&self,
responses: &mut Vec<CrdsValue>,
stakes: &HashMap<Pubkey, u64>,
epoch_duration: Duration,
) {
let _st = ScopedTimer::from(&self.stats.handle_batch_pull_responses_time);
if !responses.is_empty() {
let self_pubkey = self.id();
let timeouts = self
.gossip
.make_timeouts(self_pubkey, stakes, epoch_duration);
self.handle_pull_response(responses, &timeouts);
}
}
fn handle_pull_response(
&self,
crds_values: &mut Vec<CrdsValue>,
timeouts: &CrdsTimeouts,
) -> (usize, usize, usize) {
let len = crds_values.len();
let mut pull_stats = ProcessPullStats::default();
let (filtered_pulls, filtered_pulls_expired_timeout, failed_inserts) = {
let _st = ScopedTimer::from(&self.stats.filter_pull_response);
self.gossip
.filter_pull_responses(
timeouts,
crds_values.drain(..).collect(),
timestamp(),
&mut pull_stats,
)
};
if !filtered_pulls.is_empty()
|| !filtered_pulls_expired_timeout.is_empty()
|| !failed_inserts.is_empty()
{
let _st = ScopedTimer::from(&self.stats.process_pull_response);
self.gossip.process_pull_responses(
filtered_pulls,
filtered_pulls_expired_timeout,
failed_inserts,
timestamp(),
&mut pull_stats,
);
}
self.stats.process_pull_response_count.add_relaxed(1);
self.stats.process_pull_response_len.add_relaxed(len as u64);
self.stats
.process_pull_response_fail_insert
.add_relaxed(pull_stats.failed_insert as u64);
self.stats
.process_pull_response_fail_timeout
.add_relaxed(pull_stats.failed_timeout as u64);
self.stats
.process_pull_response_success
.add_relaxed(pull_stats.success as u64);
(
pull_stats.failed_insert + pull_stats.failed_timeout,
pull_stats.failed_timeout,
pull_stats.success,
)
}
fn handle_batch_ping_messages<S: Borrow<SocketAddr>>(
&self,
pings: impl IntoIterator<Item = (S, Ping), IntoIter: ExactSizeIterator>,
recycler: &PacketBatchRecycler,
response_sender: &impl ChannelSend<PacketBatch>,
) {
let _st = ScopedTimer::from(&self.stats.handle_batch_ping_messages_time);
let keypair = self.keypair();
let pongs = pings.into_iter().map(|(addr, ping)| {
let pong = Pong::new(&ping, &keypair);
(addr, Protocol::PongMessage(pong))
});
send_gossip_packets(pongs, recycler, response_sender, &self.stats);
}
fn handle_batch_pong_messages<I>(&self, pongs: I, now: Instant)
where
I: IntoIterator<Item = (SocketAddr, Pong)>,
{
let _st = ScopedTimer::from(&self.stats.handle_batch_pong_messages_time);
let mut pongs = pongs.into_iter().peekable();
if pongs.peek().is_some() {
let mut ping_cache = self.ping_cache.lock().unwrap();
for (addr, pong) in pongs {
ping_cache.add(&pong, addr, now);
}
}
}
fn handle_batch_push_messages(
&self,
messages: &mut Vec<(Pubkey, Vec<CrdsValue>)>,
thread_pool: &ThreadPool,
recycler: &PacketBatchRecycler,
stakes: &HashMap<Pubkey, u64>,
response_sender: &impl ChannelSend<PacketBatch>,
) {
let _st = ScopedTimer::from(&self.stats.handle_batch_push_messages_time);
if messages.is_empty() {
return;
}
let origins: HashSet<_> = {
let _st = ScopedTimer::from(&self.stats.process_push_message);
let now = timestamp();
self.gossip.process_push_message(messages, now)
};
let prune_messages = self.generate_prune_messages(thread_pool, origins, stakes);
let mut packet_batch = make_gossip_packet_batch(prune_messages, recycler, &self.stats);
self.new_push_requests(stakes)
.filter_map(|(addr, data)| make_gossip_packet(addr, &data, &self.stats))
.for_each(|pkt| packet_batch.push(pkt));
if !packet_batch.is_empty() {
if let Err(TrySendError::Full(packet_batch)) =
response_sender.try_send(packet_batch.into())
{
self.stats
.gossip_packets_dropped_count
.add_relaxed(packet_batch.len() as u64);
}
}
}
fn generate_prune_messages(
&self,
thread_pool: &ThreadPool,
origins: impl IntoIterator<Item = Pubkey>,
stakes: &HashMap<Pubkey, u64>,
) -> Vec<(SocketAddr, Protocol /*::PruneMessage*/)> {
let _st = ScopedTimer::from(&self.stats.generate_prune_messages);
let self_pubkey = self.id();
let prunes: HashMap< Pubkey, Vec<Pubkey>> = {
let _st = ScopedTimer::from(&self.stats.prune_received_cache);
self.gossip
.prune_received_cache(&self_pubkey, origins, stakes)
};
let prunes: Vec<(
Pubkey, // gossip peer to be pruned
SocketAddr, // gossip socket-addr of peer
Vec<Pubkey>, // CRDS value origins
)> = {
let gossip_crds = self.gossip.crds.read().unwrap();
thread_pool.install(|| {
prunes
.into_par_iter()
.filter_map(|(pubkey, prunes)| {
let addr = get_node_addr(
pubkey,
ContactInfo::gossip,
&gossip_crds,
&self.socket_addr_space,
)?;
Some((pubkey, addr, prunes))
})
.collect()
})
};
thread_pool.install(|| {
let wallclock = timestamp();
let keypair = self.keypair();
prunes
.into_par_iter()
.flat_map(|(destination, addr, prunes)| {
let prunes = prunes.into_par_iter().chunks(MAX_PRUNE_DATA_NODES);
rayon::iter::repeat((destination, addr)).zip(prunes)
})
.map(|((destination, addr), prunes)| {
let mut prune_data = PruneData {
pubkey: self_pubkey,
prunes,
signature: Signature::default(),
destination,
wallclock,
};
prune_data.sign(&keypair);
let prune_message = Protocol::PruneMessage(self_pubkey, prune_data);
(addr, prune_message)
})
.collect()
})
}
fn process_packets(
&self,
packets: &mut Vec<VerifiedPacketBatch>,
scratch: &mut ProcessPacketsScratch,
thread_pool: &ThreadPool,
recycler: &PacketBatchRecycler,
response_sender: &impl ChannelSend<PacketBatch>,
stakes: &HashMap<Pubkey, u64>,
epoch_duration: Duration,
should_check_duplicate_instance: bool,
) -> Result<(), GossipError> {
let _st = ScopedTimer::from(&self.stats.process_gossip_packets_time);
scratch.clear();
let self_pubkey = self.id();
let self_shred_version = self.my_shred_version();
{
let gossip_crds = self.gossip.crds.read().unwrap();
let discard_different_shred_version = |msg| {
discard_different_shred_version(msg, self_shred_version, &gossip_crds, &self.stats)
};
let total_messages = packets.iter().map(|batch| batch.packets.len()).sum::<usize>();
if packets.len() < gossip_listen_parallel_batch_threshold()
&& total_messages < gossip_listen_parallel_message_threshold()
{
for (_, msg) in packets
.iter_mut()
.flat_map(|batch| batch.packets.iter_mut())
{
discard_different_shred_version(msg);
}
} else {
thread_pool.install(|| {
packets
.par_iter_mut()
.flat_map_iter(|batch| batch.packets.iter_mut())
.for_each(|(_, msg)| discard_different_shred_version(msg))
})
}
}
let check_duplicate_instance = {
let my_contact_info = self.my_contact_info();
move |values: &[CrdsValue]| {
let mut nodes = values.iter().filter_map(CrdsValue::contact_info);
if nodes.any(|other| my_contact_info.check_duplicate(other)) {
Err(GossipError::DuplicateNodeInstance)
} else {
Ok(())
}
}
};
let mut rng = rand::thread_rng();
let keypair = self.keypair();
let mut verify_gossip_addr = |value: &CrdsValue| {
if verify_gossip_addr(
&mut rng,
&keypair,
value,
&self.socket_addr_space,
&self.ping_cache,
&mut scratch.pings,
) {
true
} else {
self.stats.num_unverifed_gossip_addrs.add_relaxed(1);
false
}
};
for (from_addr, packet) in packets
.iter_mut()
.flat_map(|batch| batch.packets.drain(..))
{
match packet {
Protocol::PullRequest(filter, caller) => {
if !check_pull_request_shred_version(self_shred_version, &caller) {
self.stats.skip_pull_shred_version.add_relaxed(1);
continue;
}
let request = PullRequest {
pubkey: caller.pubkey(),
addr: from_addr,
wallclock: caller.wallclock(),
filter,
};
if request.pubkey == self_pubkey {
self.stats.window_request_loopback.add_relaxed(1);
} else {
scratch.pull_requests.push(request);
}
}
Protocol::PullResponse(_, mut data) => {
if should_check_duplicate_instance {
check_duplicate_instance(&data)?;
}
data.retain(&mut verify_gossip_addr);
if !data.is_empty() {
scratch.pull_responses.append(&mut data);
}
}
Protocol::PushMessage(from, mut data) => {
if should_check_duplicate_instance {
check_duplicate_instance(&data)?;
}
data.retain(&mut verify_gossip_addr);
if !data.is_empty() {
self.stats
.push_message_value_count
.add_relaxed(data.len() as u64);
scratch.push_messages.push((from, data));
}
}
Protocol::PruneMessage(_from, data) => scratch.prune_messages.push(data),
Protocol::PingMessage(ping) => scratch.ping_messages.push((from_addr, ping)),
Protocol::PongMessage(pong) => scratch.pong_messages.push((from_addr, pong)),
}
}
let pings = scratch
.pings
.drain(..)
.map(|(addr, ping)| (addr, Protocol::PingMessage(ping)));
send_gossip_packets(pings, recycler, response_sender, &self.stats);
self.handle_batch_ping_messages(scratch.ping_messages.drain(..), recycler, response_sender);
self.handle_batch_prune_messages(&mut scratch.prune_messages, stakes);
self.handle_batch_push_messages(
&mut scratch.push_messages,
thread_pool,
recycler,
stakes,
response_sender,
);
self.handle_batch_pull_responses(
&mut scratch.pull_responses,
stakes,
epoch_duration,
);
self.trim_crds_table(CRDS_UNIQUE_PUBKEY_CAPACITY, stakes);
self.handle_batch_pong_messages(scratch.pong_messages.drain(..), Instant::now());
self.handle_batch_pull_requests(
&mut scratch.pull_requests,
thread_pool,
recycler,
stakes,
response_sender,
);
Ok(())
}
fn run_socket_consume_legacy(
&self,
thread_pool: &ThreadPool,
mut epoch_specs: Option<&mut EpochSpecs>,
receiver: &PacketBatchReceiver,
sender: &impl ChannelSend<Vec<(/*from:*/ SocketAddr, Protocol)>>,
packet_buf: &mut Vec<PacketBatch>,
) -> Result<(), GossipError> {
let mut num_packets = 0;
for packet_batch in receiver
.recv()
.map(std::iter::once)?
.chain(receiver.try_iter())
{
num_packets += packet_batch.len();
packet_buf.push(packet_batch);
if packet_buf.len() == gossip_channel_consume_capacity() {
break;
}
}
self.stats
.packets_received_count
.add_relaxed(num_packets as u64);
fn verify_packet(
packet: PacketRef,
stakes: &HashMap<Pubkey, u64>,
stats: &GossipStats,
) -> Option<(SocketAddr, Protocol)> {
let mut protocol: Protocol =
stats.record_received_packet(packet.deserialize_slice::<Protocol, _>(..))?;
protocol.sanitize().ok()?;
if let Protocol::PullResponse(_, values) | Protocol::PushMessage(_, values) =
&mut protocol
{
values.retain(|value| {
should_retain_crds_value(value, stakes, GossipFilterDirection::Ingress)
});
if values.is_empty() {
return None;
}
}
protocol.verify().then(|| {
stats.packets_received_verified_count.add_relaxed(1);
(packet.meta().socket_addr(), protocol)
})
}
let empty_stakes = HashMap::new();
let stakes = if let Some(epoch_specs) = epoch_specs.as_deref_mut() {
epoch_specs.current_epoch_staked_nodes().as_ref()
} else {
&empty_stakes
};
let packets_verified: Vec<_> = {
let _st = ScopedTimer::from(&self.stats.verify_gossip_packets_time);
if num_packets < gossip_socket_consume_parallel_packet_threshold() {
packet_buf
.iter()
.flat_map(|packet_batch| packet_batch.iter())
.filter_map(|packet| verify_packet(packet, stakes, &self.stats))
.collect()
} else {
thread_pool.install(|| {
packet_buf
.par_iter()
.flatten()
.filter_map(|packet| verify_packet(packet, stakes, &self.stats))
.collect()
})
}
};
if let Err(TrySendError::Full(_)) = sender.try_send(packets_verified) {
self.stats.gossip_packets_dropped_count.add_relaxed(
packet_buf
.iter()
.fold(0, |acc, packet_batch| acc + packet_batch.len()) as u64,
);
}
packet_buf.clear();
Ok(())
}
fn run_listen_legacy(
&self,
recycler: &PacketBatchRecycler,
mut epoch_specs: Option<&mut EpochSpecs>,
receiver: &Receiver<Vec<(/*from:*/ SocketAddr, Protocol)>>,
response_sender: &impl ChannelSend<PacketBatch>,
thread_pool: &ThreadPool,
should_check_duplicate_instance: bool,
packet_buf: &mut Vec<VerifiedPacketBatch>,
scratch: &mut ProcessPacketsScratch,
) -> Result<(), GossipError> {
let _st = ScopedTimer::from(&self.stats.gossip_listen_loop_time);
for pkts in receiver
.recv()
.map(std::iter::once)?
.chain(receiver.try_iter())
{
packet_buf.push(VerifiedPacketBatch { packets: pkts });
if packet_buf.len() == gossip_channel_consume_capacity() {
break;
}
}
let stakes = epoch_specs
.as_mut()
.map(|epoch_specs| epoch_specs.current_epoch_staked_nodes())
.cloned()
.unwrap_or_default();
let epoch_duration = epoch_specs
.map(EpochSpecs::epoch_duration)
.unwrap_or(DEFAULT_EPOCH_DURATION);
self.process_packets(
packet_buf,
scratch,
thread_pool,
recycler,
response_sender,
&stakes,
epoch_duration,
should_check_duplicate_instance,
)?;
packet_buf.clear();
self.stats
.gossip_listen_loop_iterations_since_last_report
.add_relaxed(1);
Ok(())
}
pub(crate) fn start_socket_consume_thread(
self: Arc<Self>,
bank_forks: Option<Arc<RwLock<BankForks>>>,
receiver: PacketBatchReceiver,
sender: impl ChannelSend<Vec<(/*from:*/ SocketAddr, Protocol)>>,
exit: Arc<AtomicBool>,
) -> JoinHandle<()> {
let thread_pool = ThreadPoolBuilder::new()
.num_threads(get_thread_count().min(8))
.thread_name(|i| format!("solGossipCons{i:02}"))
.build()
.unwrap();
let mut epoch_specs = bank_forks.map(EpochSpecs::from);
let mut packet_buf = Vec::with_capacity(gossip_channel_consume_capacity());
let run_consume = move || {
while !exit.load(Ordering::Relaxed) {
let result = self.run_socket_consume_legacy(
&thread_pool,
epoch_specs.as_mut(),
&receiver,
&sender,
&mut packet_buf,
);
match result {
Err(GossipError::RecvError(_)) => break,
Err(GossipError::SendError) => break,
Err(err) => error!("gossip consume: {err}"),
Ok(()) => (),
}
}
};
let thread_name = String::from("solGossipConsum");
Builder::new().name(thread_name).spawn(run_consume).unwrap()
}
pub(crate) fn listen(
self: Arc<Self>,
bank_forks: Option<Arc<RwLock<BankForks>>>,
requests_receiver: Receiver<Vec<(/*from:*/ SocketAddr, Protocol)>>,
response_sender: impl ChannelSend<PacketBatch>,
should_check_duplicate_instance: bool,
exit: Arc<AtomicBool>,
) -> JoinHandle<()> {
let recycler = PacketBatchRecycler::default();
let thread_pool = ThreadPoolBuilder::new()
.num_threads(get_thread_count().min(8))
.thread_name(|i| format!("solGossipWork{i:02}"))
.build()
.unwrap();
let mut epoch_specs = bank_forks.map(EpochSpecs::from);
let mut packet_buf = Vec::with_capacity(gossip_channel_consume_capacity());
let mut scratch = ProcessPacketsScratch::new();
Builder::new()
.name("solGossipListen".to_string())
.spawn(move || {
while !exit.load(Ordering::Relaxed) {
let result = self.run_listen_legacy(
&recycler,
epoch_specs.as_mut(),
&requests_receiver,
&response_sender,
&thread_pool,
should_check_duplicate_instance,
&mut packet_buf,
&mut scratch,
);
if let Err(err) = result {
match err {
GossipError::RecvError(_) => break,
GossipError::DuplicateNodeInstance => {
error!(
"duplicate running instances of the same validator node: {}",
self.id()
);
exit.store(true, Ordering::Relaxed);
std::process::exit(1);
}
_ => error!("gossip run_listen failed: {err}"),
}
}
}
})
.unwrap()
}
pub fn gossip_contact_info(id: Pubkey, gossip: SocketAddr, shred_version: u16) -> ContactInfo {
let mut node = ContactInfo::new(id, timestamp(), shred_version);
let _ = node.set_gossip(gossip);
node
}
pub fn gossip_node(
id: Pubkey,
gossip_addr: &SocketAddr,
shred_version: u16,
) -> (ContactInfo, UdpSocket, Option<TcpListener>) {
let bind_ip_addr = IpAddr::V4(Ipv4Addr::UNSPECIFIED);
let (port, (gossip_socket, ip_echo)) =
bind_gossip_port_in_range(gossip_addr, VALIDATOR_PORT_RANGE, bind_ip_addr);
let contact_info =
Self::gossip_contact_info(id, SocketAddr::new(gossip_addr.ip(), port), shred_version);
(contact_info, gossip_socket, Some(ip_echo))
}
pub fn spy_node(
id: Pubkey,
shred_version: u16,
) -> (ContactInfo, UdpSocket, Option<TcpListener>) {
let bind_ip_addr = IpAddr::V4(Ipv4Addr::UNSPECIFIED);
let (port, gossip_socket) = bind_in_range(bind_ip_addr, VALIDATOR_PORT_RANGE).unwrap();
let contact_info = Self::gossip_contact_info(
id,
SocketAddr::new(IpAddr::V4(Ipv4Addr::LOCALHOST), port),
shred_version,
);
(contact_info, gossip_socket, None)
}
}
#[derive(Debug)]
pub struct Sockets {
pub gossip: Arc<[UdpSocket]>,
pub ip_echo: Option<TcpListener>,
pub tvu: Vec<UdpSocket>,
pub tvu_quic: UdpSocket,
pub tpu: Vec<UdpSocket>,
pub tpu_forwards: Vec<UdpSocket>,
pub tpu_vote: Vec<UdpSocket>,
pub broadcast: Vec<UdpSocket>,
pub repair: UdpSocket,
pub repair_quic: UdpSocket,
pub retransmit_sockets: Vec<UdpSocket>,
pub serve_repair: UdpSocket,
pub serve_repair_quic: UdpSocket,
pub ancestor_hashes_requests: UdpSocket,
pub ancestor_hashes_requests_quic: UdpSocket,
pub tpu_quic: Vec<UdpSocket>,
pub tpu_forwards_quic: Vec<UdpSocket>,
pub tpu_vote_quic: Vec<UdpSocket>,
pub tpu_vote_forwarding_client: UdpSocket,
pub tpu_transaction_forwarding_clients: Box<[UdpSocket]>,
pub alpenglow: Option<UdpSocket>,
pub quic_vote_client: UdpSocket,
pub quic_alpenglow_client: UdpSocket,
pub rpc_sts_client: UdpSocket,
pub vortexor_receivers: Option<Vec<UdpSocket>>,
}
pub struct NodeConfig {
pub advertised_ip: IpAddr,
pub gossip_port: u16,
pub port_range: PortRange,
pub bind_ip_addrs: BindIpAddrs,
pub public_tpu_addr: Option<SocketAddr>,
pub public_tpu_forwards_addr: Option<SocketAddr>,
pub vortexor_receiver_addr: Option<SocketAddr>,
pub num_tvu_receive_sockets: NonZeroUsize,
pub num_tvu_retransmit_sockets: NonZeroUsize,
pub num_quic_endpoints: NonZeroUsize,
}
pub fn push_messages_to_peer_for_tests(
messages: Vec<CrdsValue>,
self_id: Pubkey,
peer_gossip: SocketAddr,
socket_addr_space: &SocketAddrSpace,
) -> Result<(), GossipError> {
let reqs: Vec<_> = split_gossip_messages(PUSH_MESSAGE_MAX_PAYLOAD_SIZE, messages)
.map(move |payload| (peer_gossip, Protocol::PushMessage(self_id, payload)))
.collect();
let packet_batch = make_gossip_packet_batch(
reqs,
&PacketBatchRecycler::default(),
&GossipStats::default(),
);
let sock = bind_to_localhost_unique().expect("should bind");
packet::send_to(&packet_batch, &sock, socket_addr_space)?;
Ok(())
}
#[inline]
#[must_use]
fn check_pull_request_shred_version(self_shred_version: u16, caller: &CrdsValue) -> bool {
let shred_version = match caller.data() {
CrdsData::ContactInfo(node) => node.shred_version(),
CrdsData::LegacyContactInfo(node) => node.shred_version(),
_ => return false,
};
shred_version == self_shred_version
}
fn discard_different_shred_version(
msg: &mut Protocol,
self_shred_version: u16,
crds: &Crds,
stats: &GossipStats,
) {
let (values, skip_shred_version_counter) = match msg {
Protocol::PullResponse(_, values) => (values, &stats.skip_pull_response_shred_version),
Protocol::PushMessage(_, values) => (values, &stats.skip_push_message_shred_version),
Protocol::PullRequest(..) => return,
Protocol::PruneMessage(_, _) | Protocol::PingMessage(_) | Protocol::PongMessage(_) => {
return
}
};
let num_values = values.len();
values.retain(|value| match value.data() {
CrdsData::ContactInfo(ci) => ci.shred_version() == self_shred_version,
_ => crds.get_shred_version(&value.pubkey()) == Some(self_shred_version),
});
let num_skipped = num_values - values.len();
if num_skipped != 0 {
skip_shred_version_counter.add_relaxed(num_skipped as u64);
}
}
#[inline]
fn get_node_addr(
pubkey: Pubkey,
query: impl Fn(&ContactInfo) -> Option<SocketAddr>,
crds: &Crds,
socket_addr_space: &SocketAddrSpace,
) -> Option<SocketAddr> {
let node = crds.get::<&ContactInfo>(pubkey)?;
query(node).filter(|addr| socket_addr_space.check(addr))
}
#[must_use]
fn verify_gossip_addr<R: Rng + CryptoRng>(
rng: &mut R,
keypair: &Keypair,
value: &CrdsValue,
socket_addr_space: &SocketAddrSpace,
ping_cache: &Mutex<PingCache>,
pings: &mut Vec<(SocketAddr, Ping)>,
) -> bool {
let (pubkey, addr) = match value.data() {
CrdsData::ContactInfo(node) => (node.pubkey(), node.gossip()),
CrdsData::LegacyContactInfo(node) => (node.pubkey(), node.gossip()),
_ => return true, };
let Some(addr) = addr.filter(|addr| socket_addr_space.check(addr)) else {
return false;
};
let (out, ping) = {
let node = (*pubkey, addr);
let mut ping_cache = ping_cache.lock().unwrap();
ping_cache.check(rng, keypair, Instant::now(), node)
};
if let Some(ping) = ping {
pings.push((addr, ping));
}
out
}
fn send_gossip_packets<S: Borrow<SocketAddr>>(
pkts: impl IntoIterator<Item = (S, Protocol), IntoIter: ExactSizeIterator>,
recycler: &PacketBatchRecycler,
sender: &impl ChannelSend<PacketBatch>,
stats: &GossipStats,
) {
let pkts = pkts.into_iter();
if pkts.len() != 0 {
let pkts = make_gossip_packet_batch(pkts, recycler, stats);
if let Err(TrySendError::Full(pkts)) = sender.try_send(pkts.into()) {
stats
.gossip_packets_dropped_count
.add_relaxed(pkts.len() as u64);
}
}
}
fn make_gossip_packet_batch<S: Borrow<SocketAddr>>(
pkts: impl IntoIterator<Item = (S, Protocol), IntoIter: ExactSizeIterator>,
recycler: &PacketBatchRecycler,
stats: &GossipStats,
) -> PinnedPacketBatch {
let record_gossip_packet = |(_, pkt): &(_, Protocol)| stats.record_gossip_packet(pkt);
let pkts = pkts.into_iter().inspect(record_gossip_packet);
PinnedPacketBatch::new_unpinned_with_recycler_data_and_dests(
recycler,
"gossip_packet_batch",
pkts,
)
}
#[inline]
fn make_gossip_packet(
addr: impl Borrow<SocketAddr>,
pkt: &Protocol,
stats: &GossipStats,
) -> Option<Packet> {
match Packet::from_data(Some(addr.borrow()), pkt) {
Err(err) => {
error!("failed to write gossip packet: {err:?}");
None
}
Ok(out) => {
stats.record_gossip_packet(pkt);
Some(out)
}
}
}
#[cfg(test)]
mod tests {
use {
super::*,
crate::{
crds_gossip_pull::tests::MIN_NUM_BLOOM_FILTERS,
crds_value::{CrdsValue, CrdsValueLabel},
node::Node,
protocol::tests::new_rand_remote_node,
socketaddr,
},
bincode::serialize,
itertools::izip,
solana_keypair::Keypair,
solana_net_utils::sockets::localhost_port_range_for_tests,
solana_signer::Signer,
solana_streamer::quic::DEFAULT_QUIC_ENDPOINTS,
solana_vote_program::{
vote_instruction,
vote_state::{Vote, MAX_LOCKOUT_HISTORY},
},
std::{
iter::repeat_with,
net::{IpAddr, Ipv4Addr},
ops::Deref,
panic,
sync::Arc,
},
};
#[cfg(feature = "duplicate-shred-rocksdb")]
use {
crate::duplicate_shred::tests::new_rand_shred,
solana_ledger::shred::Shredder,
};
const DEFAULT_NUM_QUIC_ENDPOINTS: NonZeroUsize =
NonZeroUsize::new(DEFAULT_QUIC_ENDPOINTS).unwrap();
impl ClusterInfo {
#[allow(clippy::type_complexity)]
fn old_pull_requests(
&self,
thread_pool: &ThreadPool,
gossip_validators: Option<&HashSet<Pubkey>>,
stakes: &HashMap<Pubkey, u64>,
) -> (
Vec<(SocketAddr, Ping)>, // Ping packets
Vec<(SocketAddr, Protocol)>, // Pull requests
) {
self.new_pull_requests(thread_pool, gossip_validators, stakes)
.partition_map(|(addr, protocol)| {
if let Protocol::PingMessage(ping) = protocol {
Either::Left((addr, ping))
} else {
Either::Right((addr, protocol))
}
})
}
}
#[test]
fn test_parse_allowed_core_ids_from_proc_status() {
let status = "Name:\tsof-solana-gossip\nCpus_allowed_list:\t0-1,3,5-6\n";
let parsed = parse_allowed_core_ids_from_proc_status(status)
.expect("expected allowed core ids from proc status");
assert_eq!(parsed, vec![0, 1, 3, 5, 6]);
}
#[test]
fn test_gossip_node() {
let (node, _, _) = ClusterInfo::spy_node(solana_pubkey::new_rand(), 0);
assert!(ClusterInfo::is_spy_node(
&node,
&SocketAddrSpace::Unspecified
));
let (node, _, _) =
ClusterInfo::gossip_node(solana_pubkey::new_rand(), &"1.1.1.1:0".parse().unwrap(), 0);
assert!(ClusterInfo::is_spy_node(
&node,
&SocketAddrSpace::Unspecified
));
}
#[test]
fn test_handle_pull() {
agave_logger::setup();
let cluster_info = Arc::new({
let keypair = Arc::new(Keypair::new());
let node = Node::new_localhost_with_pubkey(&keypair.pubkey());
ClusterInfo::new(node.info, keypair, SocketAddrSpace::Unspecified)
});
let entrypoint_pubkey = solana_pubkey::new_rand();
let data = test_crds_values(entrypoint_pubkey);
let stakes = HashMap::from([(Pubkey::new_unique(), 1u64)]);
let timeouts = CrdsTimeouts::new(
cluster_info.id(),
CRDS_GOSSIP_PULL_CRDS_TIMEOUT_MS, Duration::from_secs(48 * 3600), &stakes,
);
let mut data_once = data.clone();
assert_eq!(
(0, 0, 1),
cluster_info.handle_pull_response(&mut data_once, &timeouts)
);
let mut data_twice = data;
assert_eq!(
(1, 0, 0),
cluster_info.handle_pull_response(&mut data_twice, &timeouts)
);
}
#[test]
fn test_handle_pong_messages() {
let now = Instant::now();
let mut rng = rand::thread_rng();
let this_node = Arc::new(Keypair::new());
let cluster_info = ClusterInfo::new(
ContactInfo::new_localhost(&this_node.pubkey(), timestamp()),
this_node.clone(),
SocketAddrSpace::Unspecified,
);
let remote_nodes: Vec<(Keypair, SocketAddr)> =
repeat_with(|| new_rand_remote_node(&mut rng))
.take(128)
.collect();
let pings: Vec<_> = {
let mut ping_cache = cluster_info.ping_cache.lock().unwrap();
remote_nodes
.iter()
.map(|(keypair, socket)| {
let node = (keypair.pubkey(), *socket);
let (check, ping) = ping_cache.check(&mut rng, &this_node, now, node);
assert!(!check);
ping.unwrap()
})
.collect()
};
let pongs: Vec<(SocketAddr, Pong)> = pings
.iter()
.zip(&remote_nodes)
.map(|(ping, (keypair, socket))| (*socket, Pong::new(ping, keypair)))
.collect();
let now = now + Duration::from_millis(1);
cluster_info.handle_batch_pong_messages(pongs, now);
{
let mut ping_cache = cluster_info.ping_cache.lock().unwrap();
for (keypair, socket) in &remote_nodes {
let node = (keypair.pubkey(), *socket);
let (check, _) = ping_cache.check(&mut rng, &this_node, now, node);
assert!(check);
}
}
{
let mut ping_cache = cluster_info.ping_cache.lock().unwrap();
let (keypair, socket) = new_rand_remote_node(&mut rng);
let node = (keypair.pubkey(), socket);
let (check, _) = ping_cache.check(&mut rng, &this_node, now, node);
assert!(!check);
}
}
#[test]
fn test_handle_ping_messages() {
let mut rng = rand::thread_rng();
let this_node = Arc::new(Keypair::new());
let cluster_info = ClusterInfo::new(
ContactInfo::new_localhost(&this_node.pubkey(), timestamp()),
this_node.clone(),
SocketAddrSpace::Unspecified,
);
let remote_nodes: Vec<(Keypair, SocketAddr)> =
repeat_with(|| new_rand_remote_node(&mut rng))
.filter(|(_, socket)| socket.port() != 0)
.take(128)
.collect();
let pings: Vec<_> = remote_nodes
.iter()
.map(|(keypair, _)| Ping::new(rng.gen(), keypair))
.collect();
let pongs: Vec<_> = pings
.iter()
.map(|ping| Pong::new(ping, &this_node))
.collect();
let recycler = PacketBatchRecycler::default();
let packets = {
let (sender, receiver) = crossbeam_channel::unbounded();
cluster_info.handle_batch_ping_messages(
remote_nodes.iter().map(|(_, socket)| socket).zip(pings),
&recycler,
&sender,
);
receiver.recv().unwrap()
};
assert_eq!(remote_nodes.len(), packets.len());
for (packet, (_, socket), pong) in izip!(
packets.into_iter(),
remote_nodes.into_iter(),
pongs.into_iter()
) {
assert_eq!(packet.meta().socket_addr(), socket);
let bytes = serialize(&pong).unwrap();
match packet.deserialize_slice(..).unwrap() {
Protocol::PongMessage(pong) => assert_eq!(serialize(&pong).unwrap(), bytes),
_ => panic!("invalid packet!"),
}
}
}
fn test_crds_values(pubkey: Pubkey) -> Vec<CrdsValue> {
let entrypoint = ContactInfo::new_localhost(&pubkey, timestamp());
let entrypoint_crdsvalue = CrdsValue::new_unsigned(CrdsData::from(entrypoint));
vec![entrypoint_crdsvalue]
}
#[test]
fn test_cluster_spy_gossip() {
let thread_pool = ThreadPoolBuilder::new().build().unwrap();
let (spy, _, _) = ClusterInfo::spy_node(solana_pubkey::new_rand(), 0);
let cluster_info = Arc::new({
let keypair = Arc::new(Keypair::new());
let node = Node::new_localhost_with_pubkey(&keypair.pubkey());
ClusterInfo::new(node.info, keypair, SocketAddrSpace::Unspecified)
});
cluster_info.insert_info(spy);
cluster_info.gossip.refresh_push_active_set(
&cluster_info.keypair(),
cluster_info.my_shred_version(),
&HashMap::new(), None, &cluster_info.ping_cache,
&mut Vec::new(), &SocketAddrSpace::Unspecified,
);
let mut reqs = cluster_info.generate_new_gossip_requests(
&thread_pool,
None, &HashMap::new(), true, );
assert!(reqs.all(|(addr, _)| {
ContactInfo::is_valid_address(&addr, &SocketAddrSpace::Unspecified)
}));
}
#[test]
fn test_cluster_info_new() {
let keypair = Arc::new(Keypair::new());
let d = ContactInfo::new_localhost(&keypair.pubkey(), timestamp());
let cluster_info = ClusterInfo::new(d.clone(), keypair, SocketAddrSpace::Unspecified);
assert_eq!(d.pubkey(), &cluster_info.id());
}
#[test]
fn insert_info_test() {
let keypair = Arc::new(Keypair::new());
let d = ContactInfo::new_localhost(&keypair.pubkey(), timestamp());
let cluster_info = ClusterInfo::new(d, keypair, SocketAddrSpace::Unspecified);
let d = ContactInfo::new_localhost(&solana_pubkey::new_rand(), timestamp());
let label = CrdsValueLabel::ContactInfo(*d.pubkey());
cluster_info.insert_info(d);
let gossip_crds = cluster_info.gossip.crds.read().unwrap();
assert!(gossip_crds.get::<&CrdsValue>(&label).is_some());
}
fn assert_in_range(x: u16, range: (u16, u16)) {
assert!(x >= range.0);
assert!(x < range.1);
}
fn check_sockets<T>(sockets: &[T], ip: IpAddr, range: (u16, u16))
where
T: Borrow<UdpSocket>,
{
assert!(!sockets.is_empty());
let port = sockets[0].borrow().local_addr().unwrap().port();
for s in sockets {
let s = s.borrow();
let local_addr = s.local_addr().unwrap();
assert_eq!(local_addr.ip(), ip);
assert_in_range(local_addr.port(), range);
assert_eq!(local_addr.port(), port);
}
}
fn check_socket<T>(socket: &T, ip: IpAddr, range: (u16, u16))
where
T: Borrow<UdpSocket>,
{
check_sockets(std::slice::from_ref(socket), ip, range);
}
fn check_node_sockets(node: &Node, ip: IpAddr, range: (u16, u16)) {
check_socket(&node.sockets.repair, ip, range);
check_socket(&node.sockets.tvu_quic, ip, range);
if let Some(alpenglow_port) = &node.sockets.alpenglow {
check_socket(alpenglow_port, ip, range);
}
check_sockets(&node.sockets.gossip, ip, range);
check_sockets(&node.sockets.tvu, ip, range);
check_sockets(&node.sockets.tpu, ip, range);
}
#[test]
fn new_with_external_ip_test_random() {
let ip = Ipv4Addr::LOCALHOST;
let port_range = localhost_port_range_for_tests();
let config = NodeConfig {
advertised_ip: IpAddr::V4(ip),
gossip_port: 0,
port_range,
bind_ip_addrs: BindIpAddrs::new(vec![IpAddr::V4(ip)]).unwrap(),
public_tpu_addr: None,
public_tpu_forwards_addr: None,
num_tvu_receive_sockets: MINIMUM_NUM_TVU_RECEIVE_SOCKETS,
num_tvu_retransmit_sockets: MINIMUM_NUM_TVU_RECEIVE_SOCKETS,
num_quic_endpoints: DEFAULT_NUM_QUIC_ENDPOINTS,
vortexor_receiver_addr: None,
};
let node = Node::new_with_external_ip(&solana_pubkey::new_rand(), config);
check_node_sockets(&node, IpAddr::V4(ip), port_range);
}
#[test]
fn new_with_external_ip_test_gossip() {
let port_range = localhost_port_range_for_tests();
let ip = IpAddr::V4(Ipv4Addr::LOCALHOST);
let port = port_range.0;
let config = NodeConfig {
advertised_ip: ip,
gossip_port: port,
port_range,
bind_ip_addrs: BindIpAddrs::new(vec![ip]).unwrap(),
public_tpu_addr: None,
public_tpu_forwards_addr: None,
num_tvu_receive_sockets: MINIMUM_NUM_TVU_RECEIVE_SOCKETS,
num_tvu_retransmit_sockets: MINIMUM_NUM_TVU_RECEIVE_SOCKETS,
num_quic_endpoints: DEFAULT_NUM_QUIC_ENDPOINTS,
vortexor_receiver_addr: None,
};
let node = Node::new_with_external_ip(&solana_pubkey::new_rand(), config);
check_node_sockets(&node, ip, port_range);
check_sockets(&node.sockets.gossip, ip, port_range);
}
#[test]
fn test_gossip_signature_verification() {
let thread_pool = ThreadPoolBuilder::new().build().unwrap();
let keypair = Keypair::new();
let peer_keypair = Keypair::new();
let contact_info = ContactInfo::new_localhost(&keypair.pubkey(), 0);
let peer = ContactInfo::new_localhost(&peer_keypair.pubkey(), 0);
let cluster_info = ClusterInfo::new(
contact_info,
Arc::new(keypair),
SocketAddrSpace::Unspecified,
);
let stakes = HashMap::<Pubkey, u64>::default();
cluster_info.ping_cache.lock().unwrap().mock_pong(
*peer.pubkey(),
peer.gossip().unwrap(),
Instant::now(),
);
cluster_info.insert_info(peer);
cluster_info.gossip.refresh_push_active_set(
&cluster_info.keypair(),
cluster_info.my_shred_version(),
&stakes,
None, &cluster_info.ping_cache,
&mut Vec::new(), &SocketAddrSpace::Unspecified,
);
cluster_info.flush_push_queue();
let (entries, push_messages, _) = cluster_info.gossip.new_push_messages(
&cluster_info.id(),
timestamp(),
&stakes,
|_| true, );
let push_messages = push_messages
.into_iter()
.map(|(pubkey, indices)| {
let values = indices.into_iter().map(|k| entries[k].clone()).collect();
(pubkey, values)
})
.collect::<HashMap<_, Vec<_>>>();
assert!(!push_messages.is_empty());
push_messages
.values()
.for_each(|v| v.par_iter().for_each(|v| assert!(v.verify())));
let mut pings = Vec::new();
let _ = cluster_info
.gossip
.new_pull_request(
&thread_pool,
cluster_info.keypair().deref(),
cluster_info.my_shred_version(),
timestamp(),
None,
&HashMap::new(),
992, &cluster_info.ping_cache,
&mut pings,
&cluster_info.socket_addr_space,
)
.ok()
.unwrap();
}
#[test]
fn test_refresh_vote_eviction() {
let keypair = Arc::new(Keypair::new());
let contact_info = ContactInfo::new_localhost(&keypair.pubkey(), 0);
let cluster_info = ClusterInfo::new(contact_info, keypair, SocketAddrSpace::Unspecified);
let lowest_vote_slot = 1;
let max_vote_slot = lowest_vote_slot + MAX_LOCKOUT_HISTORY as Slot;
let mut first_vote = None;
let mut prev_votes = vec![];
for slot in 1..max_vote_slot {
prev_votes.push(slot);
let unrefresh_vote = Vote::new(vec![slot], Hash::new_unique());
let vote_ix = vote_instruction::vote(
&Pubkey::new_unique(), &Pubkey::new_unique(), unrefresh_vote,
);
let vote_tx = Transaction::new_with_payer(
&[vote_ix], None, );
if first_vote.is_none() {
first_vote = Some(vote_tx.clone());
}
cluster_info.push_vote(&prev_votes, vote_tx);
}
let initial_votes = cluster_info.get_votes(&mut Cursor::default());
assert_eq!(initial_votes.len(), MAX_VOTES as usize);
let refresh_slot = lowest_vote_slot - 1;
let refresh_vote = Vote::new(vec![refresh_slot], Hash::new_unique());
let refresh_ix = vote_instruction::vote(
&Pubkey::new_unique(), &Pubkey::new_unique(), refresh_vote.clone(),
);
let refresh_tx = Transaction::new_with_payer(
&[refresh_ix], None, );
cluster_info.refresh_vote(refresh_tx.clone(), refresh_slot);
let current_votes = cluster_info.get_votes(&mut Cursor::default());
assert_eq!(initial_votes, current_votes);
assert!(!current_votes.contains(&refresh_tx));
let refresh_slot = max_vote_slot + 1;
let refresh_vote = Vote::new(vec![refresh_slot], Hash::new_unique());
let refresh_ix = vote_instruction::vote(
&Pubkey::new_unique(), &Pubkey::new_unique(), refresh_vote.clone(),
);
let refresh_tx = Transaction::new_with_payer(
&[refresh_ix], None, );
cluster_info.refresh_vote(refresh_tx.clone(), refresh_slot);
let votes = cluster_info.get_votes(&mut Cursor::default());
assert_eq!(votes.len(), MAX_VOTES as usize);
assert!(votes.contains(&refresh_tx));
assert!(!votes.contains(&first_vote.unwrap()));
}
#[test]
fn test_refresh_vote() {
let keypair = Arc::new(Keypair::new());
let contact_info = ContactInfo::new_localhost(&keypair.pubkey(), 0);
let cluster_info = ClusterInfo::new(contact_info, keypair, SocketAddrSpace::Unspecified);
let unrefresh_slot = 5;
let unrefresh_tower = vec![1, 3, unrefresh_slot];
let unrefresh_vote = Vote::new(unrefresh_tower.clone(), Hash::new_unique());
let unrefresh_ix = vote_instruction::vote(
&Pubkey::new_unique(), &Pubkey::new_unique(), unrefresh_vote,
);
let unrefresh_tx = Transaction::new_with_payer(
&[unrefresh_ix], None, );
cluster_info.push_vote(&unrefresh_tower, unrefresh_tx.clone());
let mut cursor = Cursor::default();
let votes = cluster_info.get_votes(&mut cursor);
assert_eq!(votes, vec![unrefresh_tx.clone()]);
let refresh_slot = unrefresh_slot + 1;
let refresh_tower = vec![1, 3, unrefresh_slot, refresh_slot];
let refresh_vote = Vote::new(refresh_tower.clone(), Hash::new_unique());
let refresh_ix = vote_instruction::vote(
&Pubkey::new_unique(), &Pubkey::new_unique(), refresh_vote.clone(),
);
let refresh_tx = Transaction::new_with_payer(
&[refresh_ix], None, );
cluster_info.refresh_vote(refresh_tx.clone(), refresh_slot);
cursor = Cursor::default();
let votes = cluster_info.get_votes(&mut cursor);
assert_eq!(votes.len(), 2);
assert!(votes.contains(&unrefresh_tx));
assert!(votes.contains(&refresh_tx));
let mut latest_refresh_tx = refresh_tx;
for _ in 0..10 {
let latest_refreshed_recent_blockhash = Hash::new_unique();
let new_signer = Keypair::new();
let refresh_ix = vote_instruction::vote(
&new_signer.pubkey(), &new_signer.pubkey(), refresh_vote.clone(),
);
latest_refresh_tx = Transaction::new_signed_with_payer(
&[refresh_ix],
None,
&[&new_signer],
latest_refreshed_recent_blockhash,
);
cluster_info.refresh_vote(latest_refresh_tx.clone(), refresh_slot);
std::thread::sleep(Duration::from_millis(1));
}
let votes = cluster_info.get_votes(&mut cursor);
assert_eq!(votes.len(), 1);
assert_eq!(votes[0], latest_refresh_tx);
let votes = cluster_info.get_votes(&mut Cursor::default());
assert_eq!(votes.len(), 2);
assert!(votes.contains(&unrefresh_tx));
assert!(votes.contains(&latest_refresh_tx));
}
#[test]
fn test_push_vote() {
let keypair = Arc::new(Keypair::new());
let contact_info = ContactInfo::new_localhost(&keypair.pubkey(), 0);
let cluster_info =
ClusterInfo::new(contact_info, keypair.clone(), SocketAddrSpace::Unspecified);
let mut cursor = Cursor::default();
let votes = cluster_info.get_votes(&mut cursor);
assert_eq!(votes, vec![]);
let vote = Vote::new(
vec![1, 3, 7], Hash::new_unique(),
);
let ix = vote_instruction::vote(
&Pubkey::new_unique(), &Pubkey::new_unique(), vote,
);
let tx = Transaction::new_with_payer(
&[ix], None, );
let tower = vec![7]; cluster_info.push_vote(&tower, tx.clone());
let (labels, votes) = cluster_info.get_votes_with_labels(&mut cursor);
assert_eq!(votes, vec![tx]);
assert_eq!(labels.len(), 1);
match labels[0] {
CrdsValueLabel::Vote(_, pubkey) => {
assert_eq!(pubkey, keypair.pubkey());
}
_ => panic!("Bad match"),
}
let votes = cluster_info.get_votes(&mut cursor);
assert_eq!(votes, vec![]);
}
fn new_vote_transaction(slots: Vec<Slot>) -> Transaction {
let vote = Vote::new(slots, Hash::new_unique());
let ix = vote_instruction::vote(
&Pubkey::new_unique(), &Pubkey::new_unique(), vote,
);
Transaction::new_with_payer(
&[ix], None, )
}
#[test]
fn test_push_votes_with_tower() {
let get_vote_slots = |cluster_info: &ClusterInfo| -> Vec<Slot> {
let (labels, _) = cluster_info.get_votes_with_labels(&mut Cursor::default());
let gossip_crds = cluster_info.gossip.crds.read().unwrap();
let mut vote_slots = HashSet::new();
for label in labels {
let CrdsData::Vote(_, vote) = &gossip_crds.get::<&CrdsData>(&label).unwrap() else {
panic!("this should not happen!");
};
assert!(vote_slots.insert(vote.slot().unwrap()));
}
vote_slots.into_iter().sorted().collect()
};
let keypair = Arc::new(Keypair::new());
let contact_info = ContactInfo::new_localhost(&keypair.pubkey(), 0);
let cluster_info = ClusterInfo::new(contact_info, keypair, SocketAddrSpace::Unspecified);
let mut tower = Vec::new();
for k in 0..2 * MAX_LOCKOUT_HISTORY {
let slot = k as Slot;
tower.push(slot);
let vote = new_vote_transaction(vec![slot]);
cluster_info.push_vote(&tower, vote);
let vote_slots = get_vote_slots(&cluster_info);
let min_vote = k.saturating_sub(MAX_VOTES as usize - 1) as u64;
assert!(vote_slots.into_iter().eq(min_vote..=(k as u64)));
sleep(Duration::from_millis(1));
}
let slot = 30;
tower.clear();
tower.extend(0..=slot);
let vote = new_vote_transaction(vec![slot]);
assert!(panic::catch_unwind(|| cluster_info.push_vote(&tower, vote))
.err()
.and_then(|a| a
.downcast_ref::<String>()
.map(|s| { s.starts_with("Submitting old vote") }))
.unwrap_or_default());
}
#[test]
fn test_push_epoch_slots() {
let keypair = Arc::new(Keypair::new());
let contact_info = ContactInfo::new_localhost(&keypair.pubkey(), 0);
let cluster_info = ClusterInfo::new(contact_info, keypair, SocketAddrSpace::Unspecified);
let slots = cluster_info.get_epoch_slots(&mut Cursor::default());
assert!(slots.is_empty());
cluster_info.push_epoch_slots(&[0]);
let mut cursor = Cursor::default();
let slots = cluster_info.get_epoch_slots(&mut cursor);
assert_eq!(slots.len(), 1);
let slots = cluster_info.get_epoch_slots(&mut cursor);
assert!(slots.is_empty());
let mut rng = rand::thread_rng();
let node_pubkey = Pubkey::new_unique();
let mut node = ContactInfo::new_rand(&mut rng, Some(node_pubkey));
node.set_shred_version(42);
let epoch_slots = EpochSlots::new_rand(&mut rng, Some(node_pubkey));
let entries = vec![
CrdsValue::new_unsigned(CrdsData::from(node)),
CrdsValue::new_unsigned(CrdsData::EpochSlots(0, epoch_slots)),
];
{
let mut gossip_crds = cluster_info.gossip.crds.write().unwrap();
for entry in entries {
assert!(gossip_crds
.insert(entry, 0, GossipRoute::LocalMessage)
.is_ok());
}
}
let slots = cluster_info.get_epoch_slots(&mut Cursor::default());
assert_eq!(slots.len(), 1);
assert_eq!(slots[0].from, cluster_info.id());
{
let mut node = cluster_info.my_contact_info.write().unwrap();
node.set_shred_version(42);
}
cluster_info.refresh_my_gossip_contact_info();
cluster_info.flush_push_queue();
let slots = cluster_info.get_epoch_slots(&mut Cursor::default());
assert_eq!(slots.len(), 2);
assert_eq!(slots[0].from, cluster_info.id());
assert_eq!(slots[1].from, node_pubkey);
}
#[test]
fn test_append_entrypoint_to_pulls() {
let thread_pool = ThreadPoolBuilder::new().build().unwrap();
let node_keypair = Arc::new(Keypair::new());
let cluster_info = ClusterInfo::new(
ContactInfo::new_localhost(&node_keypair.pubkey(), timestamp()),
node_keypair,
SocketAddrSpace::Unspecified,
);
let entrypoint_pubkey = solana_pubkey::new_rand();
let entrypoint = ContactInfo::new_localhost(&entrypoint_pubkey, timestamp());
cluster_info.set_entrypoint(entrypoint.clone());
let (pings, pulls) = cluster_info.old_pull_requests(&thread_pool, None, &HashMap::new());
assert!(pings.is_empty());
assert_eq!(pulls.len(), MIN_NUM_BLOOM_FILTERS);
for (addr, msg) in pulls {
assert_eq!(addr, entrypoint.gossip().unwrap());
match msg {
Protocol::PullRequest(_, value) => {
assert!(value.verify());
assert_eq!(value.pubkey(), cluster_info.id())
}
_ => panic!("wrong protocol"),
}
}
let entrypoint_crdsvalue = CrdsValue::new_unsigned(CrdsData::from(&entrypoint));
let cluster_info = Arc::new(cluster_info);
let stakes = HashMap::from([(Pubkey::new_unique(), 1u64)]);
let timeouts = cluster_info.gossip.make_timeouts(
cluster_info.id(),
&stakes,
Duration::from_millis(cluster_info.gossip.pull.crds_timeout),
);
let mut entrypoint_pull = vec![entrypoint_crdsvalue];
cluster_info.handle_pull_response(&mut entrypoint_pull, &timeouts);
let (pings, pulls) = cluster_info.old_pull_requests(&thread_pool, None, &HashMap::new());
assert_eq!(pings.len(), 1);
assert_eq!(pulls.len(), MIN_NUM_BLOOM_FILTERS);
assert_eq!(*cluster_info.entrypoints.read().unwrap(), vec![entrypoint]);
}
#[test]
fn test_tvu_peers_and_stakes() {
let keypair = Arc::new(Keypair::new());
let d = ContactInfo::new_localhost(&keypair.pubkey(), timestamp());
let cluster_info = ClusterInfo::new(d.clone(), keypair, SocketAddrSpace::Unspecified);
let mut stakes = HashMap::new();
let id = Pubkey::from([1u8; 32]);
let contact_info = ContactInfo::new_localhost(&id, timestamp());
cluster_info.insert_info(contact_info);
let id2 = Pubkey::from([2u8; 32]);
let mut contact_info = ContactInfo::new_localhost(&id2, timestamp());
cluster_info.insert_info(contact_info.clone());
stakes.insert(id2, 10);
contact_info.set_wallclock(timestamp() + 1);
cluster_info.insert_info(contact_info);
let id3 = Pubkey::from([3u8; 32]);
let mut contact_info = ContactInfo::new_localhost(&id3, timestamp());
contact_info.remove_tvu();
cluster_info.insert_info(contact_info);
stakes.insert(id3, 10);
let id4 = Pubkey::from([4u8; 32]);
let mut contact_info = ContactInfo::new_localhost(&id4, timestamp());
contact_info.set_shred_version(1);
assert_ne!(contact_info.shred_version(), d.shred_version());
cluster_info.insert_info(contact_info);
stakes.insert(id4, 10);
}
#[test]
fn test_pull_from_entrypoint_if_not_present() {
let thread_pool = ThreadPoolBuilder::new().build().unwrap();
let node_keypair = Arc::new(Keypair::new());
let cluster_info = ClusterInfo::new(
ContactInfo::new_localhost(&node_keypair.pubkey(), timestamp()),
node_keypair,
SocketAddrSpace::Unspecified,
);
let entrypoint_pubkey = solana_pubkey::new_rand();
let mut entrypoint = ContactInfo::new_localhost(&entrypoint_pubkey, timestamp());
entrypoint
.set_gossip(socketaddr!("127.0.0.2:1234"))
.unwrap();
cluster_info.set_entrypoint(entrypoint.clone());
let mut stakes = HashMap::new();
let other_node_pubkey = solana_pubkey::new_rand();
let other_node = ContactInfo::new_localhost(&other_node_pubkey, timestamp());
assert_ne!(other_node.gossip().unwrap(), entrypoint.gossip().unwrap());
cluster_info.ping_cache.lock().unwrap().mock_pong(
*other_node.pubkey(),
other_node.gossip().unwrap(),
Instant::now(),
);
cluster_info.insert_info(other_node.clone());
stakes.insert(other_node_pubkey, 10);
let (pings, pulls) = cluster_info.old_pull_requests(&thread_pool, None, &stakes);
assert!(pings.is_empty());
assert_eq!(pulls.len(), MIN_NUM_BLOOM_FILTERS);
assert!(pulls
.into_iter()
.all(|(addr, _)| addr == other_node.gossip().unwrap()));
cluster_info.entrypoints.write().unwrap()[0].set_wallclock(0);
let (pings, pulls) = cluster_info.old_pull_requests(&thread_pool, None, &stakes);
assert!(pings.is_empty());
assert_eq!(pulls.len(), 2 * MIN_NUM_BLOOM_FILTERS);
for node in [&other_node, &entrypoint] {
assert_eq!(
pulls
.iter()
.filter(|(addr, _)| *addr == node.gossip().unwrap())
.count(),
MIN_NUM_BLOOM_FILTERS
);
}
let (pings, pulls) = cluster_info.old_pull_requests(&thread_pool, None, &stakes);
assert!(pings.is_empty());
assert_eq!(pulls.len(), MIN_NUM_BLOOM_FILTERS);
assert!(pulls
.into_iter()
.all(|(addr, _)| addr == other_node.gossip().unwrap()));
}
#[test]
fn test_repair_peers() {
let node_keypair = Arc::new(Keypair::new());
let cluster_info = ClusterInfo::new(
ContactInfo::new_localhost(&node_keypair.pubkey(), timestamp()),
node_keypair,
SocketAddrSpace::Unspecified,
);
for i in 0..10 {
let peer_lowest = if i >= 5 { 10 } else { 0 };
let other_node_pubkey = solana_pubkey::new_rand();
let other_node = ContactInfo::new_localhost(&other_node_pubkey, timestamp());
cluster_info.insert_info(other_node.clone());
let value = CrdsValue::new_unsigned(CrdsData::LowestSlot(
0,
LowestSlot::new(other_node_pubkey, peer_lowest, timestamp()),
));
let mut gossip_crds = cluster_info.gossip.crds.write().unwrap();
let _ = gossip_crds.insert(value, timestamp(), GossipRoute::LocalMessage);
}
assert_eq!(cluster_info.repair_peers(5).len(), 5);
}
#[test]
fn test_push_epoch_slots_large() {
let node_keypair = Arc::new(Keypair::new());
let cluster_info = ClusterInfo::new(
ContactInfo::new_localhost(&node_keypair.pubkey(), timestamp()),
node_keypair,
SocketAddrSpace::Unspecified,
);
let mut rng = rand::thread_rng();
let range: Vec<Slot> = repeat_with(|| rng.gen_range(1..32))
.scan(0, |slot, step| {
*slot += step;
Some(*slot)
})
.take(32000)
.collect();
cluster_info.push_epoch_slots(&range[..16000]);
cluster_info.push_epoch_slots(&range[16000..]);
let slots = cluster_info.get_epoch_slots(&mut Cursor::default());
let slots: Vec<_> = slots.iter().flat_map(|x| x.to_slots(0)).collect();
assert_eq!(slots, range);
}
#[test]
fn test_process_entrypoint_without_adopt_shred_version() {
let node_keypair = Arc::new(Keypair::new());
let cluster_info = Arc::new(ClusterInfo::new(
{
let mut contact_info =
ContactInfo::new_localhost(&node_keypair.pubkey(), timestamp());
contact_info.set_shred_version(2);
contact_info
},
node_keypair,
SocketAddrSpace::Unspecified,
));
assert_eq!(cluster_info.my_shred_version(), 2);
let entrypoint_gossip_addr = socketaddr!("127.0.0.2:1234");
let mut entrypoint = ContactInfo::new_localhost(&Pubkey::default(), timestamp());
entrypoint.set_gossip(entrypoint_gossip_addr).unwrap();
assert_eq!(entrypoint.shred_version(), 0);
cluster_info.set_entrypoint(entrypoint);
let mut gossiped_entrypoint_info =
ContactInfo::new_localhost(&solana_pubkey::new_rand(), timestamp());
gossiped_entrypoint_info
.set_gossip(entrypoint_gossip_addr)
.unwrap();
gossiped_entrypoint_info.set_shred_version(1);
cluster_info.insert_info(gossiped_entrypoint_info.clone());
let entrypoints_processed = ClusterInfo::process_entrypoints(&cluster_info);
assert_eq!(cluster_info.entrypoints.read().unwrap().len(), 1);
assert_eq!(
cluster_info.entrypoints.read().unwrap()[0],
gossiped_entrypoint_info,
);
assert!(entrypoints_processed);
assert_eq!(cluster_info.my_shred_version(), 2); }
#[test]
#[ignore] fn test_pull_request_time_pruning() {
let node = Node::new_localhost();
let cluster_info = Arc::new(ClusterInfo::new(
node.info,
Arc::new(Keypair::new()),
SocketAddrSpace::Unspecified,
));
let entrypoint_pubkey = solana_pubkey::new_rand();
let entrypoint = ContactInfo::new_localhost(&entrypoint_pubkey, timestamp());
cluster_info.set_entrypoint(entrypoint);
let mut rng = rand::thread_rng();
let shred_version = cluster_info.my_shred_version();
let mut peers: Vec<Pubkey> = vec![];
const NO_ENTRIES: usize = CRDS_UNIQUE_PUBKEY_CAPACITY + 128;
let data: Vec<_> = repeat_with(|| {
let keypair = Keypair::new();
peers.push(keypair.pubkey());
let mut rand_ci = ContactInfo::new_rand(&mut rng, Some(keypair.pubkey()));
rand_ci.set_shred_version(shred_version);
rand_ci.set_wallclock(timestamp());
CrdsValue::new(CrdsData::from(rand_ci), &keypair)
})
.take(NO_ENTRIES)
.collect();
let stakes = HashMap::from([(Pubkey::new_unique(), 1u64)]);
let timeouts = CrdsTimeouts::new(
cluster_info.id(),
CRDS_GOSSIP_PULL_CRDS_TIMEOUT_MS * 4, Duration::from_secs(48 * 3600), &stakes,
);
let mut data = data;
assert_eq!(
(0, 0, NO_ENTRIES),
cluster_info.handle_pull_response(&mut data, &timeouts)
);
}
#[test]
#[cfg(feature = "duplicate-shred-rocksdb")]
fn test_get_duplicate_shreds() {
let host1_key = Arc::new(Keypair::new());
let node = Node::new_localhost_with_pubkey(&host1_key.pubkey());
let cluster_info = Arc::new(ClusterInfo::new(
node.info,
host1_key.clone(),
SocketAddrSpace::Unspecified,
));
let mut cursor = Cursor::default();
assert!(cluster_info.get_duplicate_shreds(&mut cursor).is_empty());
let mut rng = rand::thread_rng();
let (slot, parent_slot, reference_tick, version) = (53084024, 53084023, 0, 0);
let shredder = Shredder::new(slot, parent_slot, reference_tick, version).unwrap();
let next_shred_index = 353;
let leader = Arc::new(Keypair::new());
let shred1 = new_rand_shred(&mut rng, next_shred_index, &shredder, &leader);
let shred2 = new_rand_shred(&mut rng, next_shred_index, &shredder, &leader);
assert!(cluster_info
.push_duplicate_shred(&shred1, shred2.payload())
.is_ok());
cluster_info.flush_push_queue();
let entries = cluster_info.get_duplicate_shreds(&mut cursor);
assert_eq!(3, entries.len());
for (i, shred_data) in entries.iter().enumerate() {
assert_eq!(shred_data.from, host1_key.pubkey());
assert_eq!(shred_data.slot, 53084024);
assert_eq!(shred_data.chunk_index() as usize, i);
}
let slot = 53084025;
let shredder = Shredder::new(slot, parent_slot, reference_tick, version).unwrap();
let next_shred_index = 354;
let shred3 = new_rand_shred(&mut rng, next_shred_index, &shredder, &leader);
let shred4 = new_rand_shred(&mut rng, next_shred_index, &shredder, &leader);
assert!(cluster_info
.push_duplicate_shred(&shred3, shred4.payload())
.is_ok());
cluster_info.flush_push_queue();
let entries1 = cluster_info.get_duplicate_shreds(&mut cursor);
assert_eq!(3, entries1.len());
for (i, shred_data) in entries1.iter().enumerate() {
assert_eq!(shred_data.from, host1_key.pubkey());
assert_eq!(shred_data.slot, 53084025);
assert_eq!(shred_data.chunk_index() as usize, i);
}
}
#[test]
fn test_push_restart_last_voted_fork_slots() {
let keypair = Arc::new(Keypair::new());
let contact_info = ContactInfo::new_localhost(&keypair.pubkey(), 0);
let cluster_info = ClusterInfo::new(contact_info, keypair, SocketAddrSpace::Unspecified);
let slots = cluster_info.get_restart_last_voted_fork_slots(&mut Cursor::default());
assert!(slots.is_empty());
let mut update: Vec<Slot> = vec![0];
for i in 0..81 {
for j in 0..1000 {
update.push(i * 1050 + j);
}
}
assert!(cluster_info
.push_restart_last_voted_fork_slots(&update, Hash::default())
.is_ok());
cluster_info.flush_push_queue();
let mut cursor = Cursor::default();
let slots = cluster_info.get_restart_last_voted_fork_slots(&mut cursor);
assert_eq!(slots.len(), 1);
let retrieved_slots = slots[0].to_slots(0);
assert!(retrieved_slots[0] < 69000);
assert_eq!(retrieved_slots.last(), Some(84999).as_ref());
let slots = cluster_info.get_restart_last_voted_fork_slots(&mut cursor);
assert!(slots.is_empty());
let mut rng = rand::thread_rng();
let node_pubkey = Pubkey::new_unique();
let mut node = ContactInfo::new_rand(&mut rng, Some(node_pubkey));
node.set_shred_version(42);
let mut slots = RestartLastVotedForkSlots::new_rand(&mut rng, Some(node_pubkey));
slots.shred_version = 42;
let entries = vec![
CrdsValue::new_unsigned(CrdsData::from(node)),
CrdsValue::new_unsigned(CrdsData::RestartLastVotedForkSlots(slots)),
];
{
let mut gossip_crds = cluster_info.gossip.crds.write().unwrap();
for entry in entries {
assert!(gossip_crds
.insert(entry, 0, GossipRoute::LocalMessage)
.is_ok());
}
}
let slots = cluster_info.get_restart_last_voted_fork_slots(&mut Cursor::default());
assert_eq!(slots.len(), 1);
assert_eq!(slots[0].from, cluster_info.id());
{
let mut node = cluster_info.my_contact_info.write().unwrap();
node.set_shred_version(42);
}
assert!(cluster_info
.push_restart_last_voted_fork_slots(&update, Hash::default())
.is_ok());
cluster_info.flush_push_queue();
let slots = cluster_info.get_restart_last_voted_fork_slots(&mut Cursor::default());
assert_eq!(slots.len(), 2);
assert_eq!(slots[0].from, node_pubkey);
assert_eq!(slots[1].from, cluster_info.id());
}
#[test]
fn test_push_restart_heaviest_fork() {
agave_logger::setup();
let keypair = Arc::new(Keypair::new());
let pubkey = keypair.pubkey();
let contact_info = ContactInfo::new_localhost(&pubkey, 0);
let cluster_info = ClusterInfo::new(contact_info, keypair, SocketAddrSpace::Unspecified);
let mut cursor = Cursor::default();
let heaviest_forks = cluster_info.get_restart_heaviest_fork(&mut cursor);
assert_eq!(heaviest_forks, vec![]);
let slot1 = 53;
let hash1 = Hash::new_unique();
let stake1 = 15_000_000;
cluster_info.push_restart_heaviest_fork(slot1, hash1, stake1);
cluster_info.flush_push_queue();
let heaviest_forks = cluster_info.get_restart_heaviest_fork(&mut cursor);
assert_eq!(heaviest_forks.len(), 1);
let fork = &heaviest_forks[0];
assert_eq!(fork.last_slot, slot1);
assert_eq!(fork.last_slot_hash, hash1);
assert_eq!(fork.observed_stake, stake1);
assert_eq!(fork.from, pubkey);
let mut rng = rand::thread_rng();
let pubkey2 = Pubkey::new_unique();
let mut new_node = ContactInfo::new_rand(&mut rng, Some(pubkey2));
new_node.set_shred_version(42);
let slot2 = 54;
let hash2 = Hash::new_unique();
let stake2 = 23_000_000;
let entries = vec![
CrdsValue::new_unsigned(CrdsData::from(new_node)),
CrdsValue::new_unsigned(CrdsData::RestartHeaviestFork(RestartHeaviestFork {
from: pubkey2,
wallclock: timestamp(),
last_slot: slot2,
last_slot_hash: hash2,
observed_stake: stake2,
shred_version: 42,
})),
];
{
let mut gossip_crds = cluster_info.gossip.crds.write().unwrap();
for entry in entries {
assert!(gossip_crds
.insert(entry, 0, GossipRoute::LocalMessage)
.is_ok());
}
}
let heaviest_forks = cluster_info.get_restart_heaviest_fork(&mut Cursor::default());
assert_eq!(heaviest_forks.len(), 1);
assert_eq!(heaviest_forks[0].from, pubkey);
{
let mut node = cluster_info.my_contact_info.write().unwrap();
node.set_shred_version(42);
}
cluster_info.refresh_my_gossip_contact_info();
cluster_info.flush_push_queue();
let heaviest_forks = cluster_info.get_restart_heaviest_fork(&mut Cursor::default());
assert_eq!(heaviest_forks.len(), 1);
assert_eq!(heaviest_forks[0].from, pubkey2);
}
#[test]
fn test_contact_trace() {
agave_logger::setup();
const CLUSTER_INFO_TRACE_LENGTH: usize = 452;
const RPC_INFO_TRACE_LENGTH: usize = 335;
let keypair43 = Arc::new(
Keypair::try_from(
[
198, 203, 8, 178, 196, 71, 119, 152, 31, 96, 221, 142, 115, 224, 45, 34, 173,
138, 254, 39, 181, 238, 168, 70, 183, 47, 210, 91, 221, 179, 237, 153, 14, 58,
154, 59, 67, 220, 235, 106, 241, 99, 4, 72, 60, 245, 53, 30, 225, 122, 145,
225, 8, 40, 30, 174, 26, 228, 125, 127, 125, 21, 96, 28,
]
.as_ref(),
)
.unwrap(),
);
let keypair44 = Arc::new(
Keypair::try_from(
[
66, 88, 3, 70, 228, 215, 125, 64, 130, 183, 180, 98, 22, 166, 201, 234, 89, 80,
135, 24, 228, 35, 20, 52, 105, 130, 50, 51, 46, 229, 244, 108, 70, 57, 45, 247,
57, 177, 39, 126, 190, 238, 50, 96, 186, 208, 28, 168, 148, 56, 9, 106, 92,
213, 63, 205, 252, 225, 244, 101, 77, 182, 4, 2,
]
.as_ref(),
)
.unwrap(),
);
let cluster_info44 = Arc::new({
let node = Node::new_localhost_with_pubkey(&keypair44.pubkey());
info!("{node:?}");
ClusterInfo::new(node.info, keypair44.clone(), SocketAddrSpace::Unspecified)
});
let cluster_info43 = Arc::new({
let node = Node::new_localhost_with_pubkey(&keypair43.pubkey());
ClusterInfo::new(node.info, keypair43.clone(), SocketAddrSpace::Unspecified)
});
assert_eq!(keypair43.pubkey().to_string().len(), 43);
assert_eq!(keypair44.pubkey().to_string().len(), 44);
let trace = cluster_info44.contact_info_trace();
info!("cluster:\n{trace}");
assert_eq!(trace.len(), CLUSTER_INFO_TRACE_LENGTH);
let trace = cluster_info44.rpc_info_trace();
info!("rpc:\n{trace}");
assert_eq!(trace.len(), RPC_INFO_TRACE_LENGTH);
let trace = cluster_info43.contact_info_trace();
info!("cluster:\n{trace}");
assert_eq!(trace.len(), CLUSTER_INFO_TRACE_LENGTH);
let trace = cluster_info43.rpc_info_trace();
info!("rpc:\n{trace}");
assert_eq!(trace.len(), RPC_INFO_TRACE_LENGTH);
}
#[test]
fn test_discard_different_shred_version_push_message() {
let self_shred_version = 5555;
let mut crds = Crds::default();
let stats = GossipStats::default();
let mut rng = rand::thread_rng();
let keypair = Keypair::new();
let contact_info = ContactInfo::new(
keypair.pubkey(),
1234567890,
self_shred_version,
);
let ci = CrdsValue::new(CrdsData::ContactInfo(contact_info), &keypair);
let mut msg = Protocol::PushMessage(keypair.pubkey(), vec![ci.clone()]);
discard_different_shred_version(&mut msg, self_shred_version, &crds, &stats);
if let Protocol::PushMessage(_, values) = msg {
assert_eq!(values.len(), 1);
}
let contact_info_wrong_shred_version =
ContactInfo::new(keypair.pubkey(), 1234567890, 1);
let ci_wrong_shred_version = CrdsValue::new(
CrdsData::ContactInfo(contact_info_wrong_shred_version),
&keypair,
);
let mut msg = Protocol::PushMessage(keypair.pubkey(), vec![ci_wrong_shred_version]);
discard_different_shred_version(&mut msg, self_shred_version, &crds, &stats);
if let Protocol::PushMessage(_, values) = msg {
assert_eq!(values.len(), 0);
}
let epoch_slots = EpochSlots::new_rand(&mut rng, Some(keypair.pubkey()));
let es = CrdsValue::new_unsigned(CrdsData::EpochSlots(0, epoch_slots));
let mut msg = Protocol::PushMessage(keypair.pubkey(), vec![es]);
discard_different_shred_version(&mut msg, self_shred_version, &crds, &stats);
if let Protocol::PushMessage(_, ref values) = msg {
assert_eq!(values.len(), 0);
}
let keypair2 = Keypair::new();
let ci_wrong_pubkey = CrdsValue::new(
CrdsData::ContactInfo(ContactInfo::new(
keypair2.pubkey(),
1234567890,
self_shred_version,
)),
&keypair2,
);
assert!(crds
.insert(ci_wrong_pubkey, 0, GossipRoute::LocalMessage)
.is_ok());
let epoch_slots = EpochSlots::new_rand(&mut rng, Some(keypair.pubkey()));
let es: CrdsValue = CrdsValue::new_unsigned(CrdsData::EpochSlots(0, epoch_slots));
let mut msg = Protocol::PushMessage(keypair.pubkey(), vec![es.clone()]);
discard_different_shred_version(&mut msg, self_shred_version, &crds, &stats);
if let Protocol::PushMessage(_, ref values) = msg {
assert_eq!(values.len(), 0);
}
assert!(crds
.insert(ci.clone(), 0, GossipRoute::LocalMessage)
.is_ok());
let mut msg = Protocol::PushMessage(keypair.pubkey(), vec![es]);
discard_different_shred_version(&mut msg, self_shred_version, &crds, &stats);
if let Protocol::PushMessage(_, ref values) = msg {
assert_eq!(values.len(), 1);
}
let keypair3 = Keypair::new();
let keypair4 = Keypair::new();
let entries = vec![
CrdsValue::new(
CrdsData::ContactInfo(ContactInfo::new(
keypair2.pubkey(),
1234567890,
self_shred_version,
)),
&keypair2,
),
CrdsValue::new(
CrdsData::ContactInfo(ContactInfo::new(
keypair3.pubkey(),
1234567890,
1,
)),
&keypair3,
),
CrdsValue::new_unsigned(CrdsData::EpochSlots(
0,
EpochSlots::new_rand(&mut rng, Some(keypair.pubkey())),
)),
CrdsValue::new(
CrdsData::ContactInfo(ContactInfo::new(
keypair.pubkey(),
1234567890,
self_shred_version,
)),
&keypair4,
),
];
let mut msg = Protocol::PushMessage(keypair.pubkey(), entries);
discard_different_shred_version(&mut msg, self_shred_version, &crds, &stats);
if let Protocol::PushMessage(_, ref values) = msg {
assert_eq!(values.len(), 3);
}
crds.remove(&ci.label(), 0);
let entries = vec![
CrdsValue::new(
CrdsData::ContactInfo(ContactInfo::new(
keypair2.pubkey(),
1234567890,
self_shred_version,
)),
&keypair2,
),
CrdsValue::new(
CrdsData::ContactInfo(ContactInfo::new(
keypair3.pubkey(),
1234567890,
1,
)),
&keypair3,
),
CrdsValue::new_unsigned(CrdsData::EpochSlots(
0,
EpochSlots::new_rand(&mut rng, Some(keypair.pubkey())),
)),
CrdsValue::new(
CrdsData::ContactInfo(ContactInfo::new(
keypair.pubkey(),
1234567890,
self_shred_version,
)),
&keypair,
),
];
let mut msg = Protocol::PushMessage(keypair.pubkey(), entries);
discard_different_shred_version(&mut msg, self_shred_version, &crds, &stats);
if let Protocol::PushMessage(_, ref values) = msg {
assert_eq!(values.len(), 2);
}
}
}