gnosis/lighthouse
1
0
Fork 0
mirror of https://github.com/sigp/lighthouse.git synced 2026-05-08 09:16:00 +00:00
Code Issues Packages Projects Releases Wiki Activity

Move peer db writes to eth2 libp2p (#2724)

Browse Source 
## Issue Addressed
Part of a bigger effort to make the network globals read only. This moves all writes to the `PeerDB` to the `eth2_libp2p` crate. Limiting writes to the peer manager is a slightly more complicated issue for a next PR, to keep things reviewable.

## Proposed Changes
- Make the peers field in the globals a private field.
- Allow mutable access to the peers field to `eth2_libp2p` for now.
- Add a new network message to update the sync state.

Co-authored-by: Age Manning <Age@AgeManning.com>
This commit is contained in:
Divma
2021-11-19 04:42:31 +00:00
parent 31386277c3
commit 53562010ec
16 changed files with 139 additions and 154 deletions
Download Patch File Download Diff File Expand all files Collapse all files

42
beacon_node/lighthouse_network/src/behaviour/mod.rs
View File

@@ -14,7 +14,9 @@ use crate::types::{
SubnetDiscovery,
};
use crate::Eth2Enr;
use crate::{error, metrics, Enr, NetworkConfig, NetworkGlobals, PubsubMessage, TopicHash};
use crate::{
error, metrics, Enr, NetworkConfig, NetworkGlobals, PubsubMessage, SyncStatus, TopicHash,
};
use libp2p::{
core::{
connection::ConnectionId, identity::Keypair, multiaddr::Protocol as MProtocol, Multiaddr,
@@ -32,7 +34,7 @@ use libp2p::{
},
NetworkBehaviour, PeerId,
};
use slog::{crit, debug, o, trace, warn};
use slog::{crit, debug, error, o, trace, warn};
use ssz::Encode;
use std::collections::HashSet;
use std::fs::File;
@@ -455,8 +457,7 @@ impl<TSpec: EthSpec> Behaviour<TSpec> {
} {
if let Some(client) = self
.network_globals
.peers
.read()
.peers()
.peer_info(propagation_source)
.map(|info| info.client().kind.as_ref())
{
@@ -568,6 +569,25 @@ impl<TSpec: EthSpec> Behaviour<TSpec> {
self.discovery.add_enr(enr);
}
pub fn update_peers_sync_status(&mut self, peer_id: &PeerId, sync_status: SyncStatus) {
let status_repr = sync_status.as_str();
match self
.network_globals
.peers_mut()
.update_sync_status(peer_id, sync_status)
{
Some(true) => {
trace!(self.log, "Peer sync status updated"; "peer_id" => %peer_id, "sync_status" => status_repr);
}
Some(false) => {
// Sync status is the same for known peer
}
None => {
error!(self.log, "Sync status update notification for unknown peer"; "peer_id" => %peer_id, "sync_status" => status_repr);
}
}
}
/// Updates a subnet value to the ENR attnets/syncnets bitfield.
///
/// The `value` is `true` if a subnet is being added and false otherwise.
@@ -593,8 +613,7 @@ impl<TSpec: EthSpec> Behaviour<TSpec> {
// Extend min_ttl of connected peers on required subnets
if let Some(min_ttl) = s.min_ttl {
self.network_globals
.peers
.write()
.peers_mut()
.extend_peers_on_subnet(&s.subnet, min_ttl);
if let Subnet::SyncCommittee(sync_subnet) = s.subnet {
self.peer_manager_mut()
@@ -604,8 +623,7 @@ impl<TSpec: EthSpec> Behaviour<TSpec> {
// Already have target number of peers, no need for subnet discovery
let peers_on_subnet = self
.network_globals
.peers
.read()
.peers()
.good_peers_on_subnet(s.subnet)
.count();
if peers_on_subnet >= TARGET_SUBNET_PEERS {
@@ -755,7 +773,7 @@ impl<TSpec: EthSpec> Behaviour<TSpec> {
.discovery
.cached_enrs()
.filter_map(|(peer_id, enr)| {
let peers = self.network_globals.peers.read();
let peers = self.network_globals.peers();
if predicate(enr) && peers.should_dial(peer_id) {
Some(*peer_id)
} else {
@@ -848,16 +866,14 @@ impl<TSpec: EthSpec> NetworkBehaviourEventProcess<GossipsubEvent> for Behaviour<
GossipsubEvent::Subscribed { peer_id, topic } => {
if let Some(subnet_id) = subnet_from_topic_hash(&topic) {
self.network_globals
.peers
.write()
.peers_mut()
.add_subscription(&peer_id, subnet_id);
}
}
GossipsubEvent::Unsubscribed { peer_id, topic } => {
if let Some(subnet_id) = subnet_from_topic_hash(&topic) {
self.network_globals
.peers
.write()
.peers_mut()
.remove_subscription(&peer_id, &subnet_id);
}
}

3
beacon_node/lighthouse_network/src/discovery/mod.rs
View File

@@ -679,8 +679,7 @@ impl<TSpec: EthSpec> Discovery<TSpec> {
// Determine if we have sufficient peers, which may make this discovery unnecessary.
let peers_on_subnet = self
.network_globals
.peers
.read()
.peers()
.good_peers_on_subnet(subnet_query.subnet)
.count();

82
beacon_node/lighthouse_network/src/peer_manager/mod.rs
View File

@@ -143,7 +143,7 @@ impl<TSpec: EthSpec> PeerManager<TSpec> {
/// This will send a goodbye and disconnect the peer if it is connected or dialing.
pub fn goodbye_peer(&mut self, peer_id: &PeerId, reason: GoodbyeReason, source: ReportSource) {
// Update the sync status if required
if let Some(info) = self.network_globals.peers.write().peer_info_mut(peer_id) {
if let Some(info) = self.network_globals.peers_mut().peer_info_mut(peer_id) {
debug!(self.log, "Sending goodbye to peer"; "peer_id" => %peer_id, "reason" => %reason, "score" => %info.score());
if matches!(reason, GoodbyeReason::IrrelevantNetwork) {
info.update_sync_status(SyncStatus::IrrelevantPeer);
@@ -165,8 +165,7 @@ impl<TSpec: EthSpec> PeerManager<TSpec> {
) {
let action = self
.network_globals
.peers
.write()
.peers_mut()
.report_peer(peer_id, action, source);
self.handle_score_action(peer_id, action, reason);
}
@@ -264,14 +263,13 @@ impl<TSpec: EthSpec> PeerManager<TSpec> {
if (min_ttl.is_some()
&& connected_or_dialing + to_dial_peers.len() < self.max_priority_peers()
|| connected_or_dialing + to_dial_peers.len() < self.max_peers())
&& self.network_globals.peers.read().should_dial(&peer_id)
&& self.network_globals.peers().should_dial(&peer_id)
{
// This should be updated with the peer dialing. In fact created once the peer is
// dialed
if let Some(min_ttl) = min_ttl {
self.network_globals
.peers
.write()
.peers_mut()
.update_min_ttl(&peer_id, min_ttl);
}
to_dial_peers.push(peer_id);
@@ -341,11 +339,11 @@ impl<TSpec: EthSpec> PeerManager<TSpec> {
///
/// This is used to determine if we should accept incoming connections.
pub fn ban_status(&self, peer_id: &PeerId) -> BanResult {
self.network_globals.peers.read().ban_status(peer_id)
self.network_globals.peers().ban_status(peer_id)
}
pub fn is_connected(&self, peer_id: &PeerId) -> bool {
self.network_globals.peers.read().is_connected(peer_id)
self.network_globals.peers().is_connected(peer_id)
}
/// Reports whether the peer limit is reached in which case we stop allowing new incoming
@@ -356,7 +354,7 @@ impl<TSpec: EthSpec> PeerManager<TSpec> {
/// Updates `PeerInfo` with `identify` information.
pub fn identify(&mut self, peer_id: &PeerId, info: &IdentifyInfo) {
if let Some(peer_info) = self.network_globals.peers.write().peer_info_mut(peer_id) {
if let Some(peer_info) = self.network_globals.peers_mut().peer_info_mut(peer_id) {
let previous_kind = peer_info.client().kind.clone();
let previous_listening_addresses =
peer_info.set_listening_addresses(info.listen_addrs.clone());
@@ -403,7 +401,7 @@ impl<TSpec: EthSpec> PeerManager<TSpec> {
direction: ConnectionDirection,
) {
let client = self.network_globals.client(peer_id);
let score = self.network_globals.peers.read().score(peer_id);
let score = self.network_globals.peers().score(peer_id);
debug!(self.log, "RPC Error"; "protocol" => %protocol, "err" => %err, "client" => %client,
"peer_id" => %peer_id, "score" => %score, "direction" => ?direction);
metrics::inc_counter_vec(
@@ -505,7 +503,7 @@ impl<TSpec: EthSpec> PeerManager<TSpec> {
/// A ping request has been received.
// NOTE: The behaviour responds with a PONG automatically
pub fn ping_request(&mut self, peer_id: &PeerId, seq: u64) {
if let Some(peer_info) = self.network_globals.peers.read().peer_info(peer_id) {
if let Some(peer_info) = self.network_globals.peers().peer_info(peer_id) {
// received a ping
// reset the to-ping timer for this peer
debug!(self.log, "Received a ping request"; "peer_id" => %peer_id, "seq_no" => seq);
@@ -542,7 +540,7 @@ impl<TSpec: EthSpec> PeerManager<TSpec> {
/// A PONG has been returned from a peer.
pub fn pong_response(&mut self, peer_id: &PeerId, seq: u64) {
if let Some(peer_info) = self.network_globals.peers.read().peer_info(peer_id) {
if let Some(peer_info) = self.network_globals.peers().peer_info(peer_id) {
// received a pong
// if the sequence number is unknown send update the meta data of the peer.
@@ -565,7 +563,7 @@ impl<TSpec: EthSpec> PeerManager<TSpec> {
/// Received a metadata response from a peer.
pub fn meta_data_response(&mut self, peer_id: &PeerId, meta_data: MetaData<TSpec>) {
if let Some(peer_info) = self.network_globals.peers.write().peer_info_mut(peer_id) {
if let Some(peer_info) = self.network_globals.peers_mut().peer_info_mut(peer_id) {
if let Some(known_meta_data) = &peer_info.meta_data() {
if *known_meta_data.seq_number() < *meta_data.seq_number() {
debug!(self.log, "Updating peer's metadata";
@@ -592,8 +590,7 @@ impl<TSpec: EthSpec> PeerManager<TSpec> {
pub(crate) fn update_gossipsub_scores(&mut self, gossipsub: &Gossipsub) {
let actions = self
.network_globals
.peers
.write()
.peers_mut()
.update_gossipsub_scores(self.target_peers, gossipsub);
for (peer_id, score_action) in actions {
@@ -633,11 +630,7 @@ impl<TSpec: EthSpec> PeerManager<TSpec> {
///
/// This is also called when dialing a peer fails.
fn inject_disconnect(&mut self, peer_id: &PeerId) {
let ban_operation = self
.network_globals
.peers
.write()
.inject_disconnect(peer_id);
let ban_operation = self.network_globals.peers_mut().inject_disconnect(peer_id);
if let Some(ban_operation) = ban_operation {
// The peer was awaiting a ban, continue to ban the peer.
@@ -663,7 +656,7 @@ impl<TSpec: EthSpec> PeerManager<TSpec> {
enr: Option<Enr>,
) -> bool {
{
let mut peerdb = self.network_globals.peers.write();
let mut peerdb = self.network_globals.peers_mut();
if !matches!(peerdb.ban_status(peer_id), BanResult::NotBanned) {
// don't connect if the peer is banned
error!(self.log, "Connection has been allowed to a banned peer"; "peer_id" => %peer_id);
@@ -700,8 +693,7 @@ impl<TSpec: EthSpec> PeerManager<TSpec> {
// Increment the PEERS_PER_CLIENT metric
if let Some(kind) = self
.network_globals
.peers
.read()
.peers()
.peer_info(peer_id)
.map(|peer_info| peer_info.client().kind.clone())
{
@@ -720,8 +712,7 @@ impl<TSpec: EthSpec> PeerManager<TSpec> {
self.events
.push(PeerManagerEvent::DisconnectPeer(peer_id, reason));
self.network_globals
.peers
.write()
.peers_mut()
.notify_disconnecting(&peer_id, false);
}
@@ -737,8 +728,7 @@ impl<TSpec: EthSpec> PeerManager<TSpec> {
.filter_map(|(k, v)| {
if self
.network_globals
.peers
.read()
.peers()
.good_peers_on_subnet(Subnet::SyncCommittee(*k))
.count()
< TARGET_SUBNET_PEERS
@@ -787,7 +777,7 @@ impl<TSpec: EthSpec> PeerManager<TSpec> {
}
// Updates peer's scores and unban any peers if required.
let actions = self.network_globals.peers.write().update_scores();
let actions = self.network_globals.peers_mut().update_scores();
for (peer_id, action) in actions {
self.handle_score_action(&peer_id, action, None);
}
@@ -806,8 +796,7 @@ impl<TSpec: EthSpec> PeerManager<TSpec> {
let mut n_outbound_removed = 0;
for (peer_id, info) in self
.network_globals
.peers
.read()
.peers()
.worst_connected_peers()
.iter()
.filter(|(_, info)| !info.has_future_duty())
@@ -926,16 +915,14 @@ mod tests {
// Set the outbound-only peers to have the lowest score.
peer_manager
.network_globals
.peers
.write()
.peers_mut()
.peer_info_mut(&outbound_only_peer1)
.unwrap()
.add_to_score(-1.0);
peer_manager
.network_globals
.peers
.write()
.peers_mut()
.peer_info_mut(&outbound_only_peer2)
.unwrap()
.add_to_score(-2.0);
@@ -951,13 +938,11 @@ mod tests {
assert_eq!(peer_manager.network_globals.connected_or_dialing_peers(), 3);
assert!(peer_manager
.network_globals
.peers
.read()
.peers()
.is_connected(&outbound_only_peer1));
assert!(!peer_manager
.network_globals
.peers
.read()
.peers()
.is_connected(&outbound_only_peer2));
peer_manager.heartbeat();
@@ -986,8 +971,7 @@ mod tests {
);
peer_manager
.network_globals
.peers
.write()
.peers_mut()
.peer_info_mut(&(outbound_only_peer))
.unwrap()
.add_to_score(-1.0);
@@ -1027,29 +1011,25 @@ mod tests {
);
peer_manager
.network_globals
.peers
.write()
.peers_mut()
.peer_info_mut(&(inbound_only_peer1))
.unwrap()
.add_to_score(-19.8);
peer_manager
.network_globals
.peers
.write()
.peers_mut()
.peer_info_mut(&(outbound_only_peer1))
.unwrap()
.add_to_score(-19.8);
peer_manager
.network_globals
.peers
.write()
.peers_mut()
.peer_info_mut(&(inbound_only_peer1))
.unwrap()
.set_gossipsub_score(-85.0);
peer_manager
.network_globals
.peers
.write()
.peers_mut()
.peer_info_mut(&(outbound_only_peer1))
.unwrap()
.set_gossipsub_score(-85.0);
@@ -1087,15 +1067,13 @@ mod tests {
);
peer_manager
.network_globals
.peers
.write()
.peers_mut()
.peer_info_mut(&(inbound_only_peer1))
.unwrap()
.add_to_score(-19.9);
peer_manager
.network_globals
.peers
.write()
.peers_mut()
.peer_info_mut(&(inbound_only_peer1))
.unwrap()
.set_gossipsub_score(-85.0);

11
beacon_node/lighthouse_network/src/peer_manager/network_behaviour.rs
View File

@@ -146,8 +146,7 @@ impl<TSpec: EthSpec> NetworkBehaviour for PeerManager<TSpec> {
if self.peer_limit_reached()
&& self
.network_globals
.peers
.read()
.peers()
.peer_info(peer_id)
.map_or(true, |peer| !peer.has_future_duty())
{
@@ -185,8 +184,7 @@ impl<TSpec: EthSpec> NetworkBehaviour for PeerManager<TSpec> {
// There are no more connections
if self
.network_globals
.peers
.read()
.peers()
.is_connected_or_disconnecting(peer_id)
{
// We are disconnecting the peer or the peer has already been connected.
@@ -200,8 +198,7 @@ impl<TSpec: EthSpec> NetworkBehaviour for PeerManager<TSpec> {
// Decrement the PEERS_PER_CLIENT metric
if let Some(kind) = self
.network_globals
.peers
.read()
.peers()
.peer_info(peer_id)
.map(|info| info.client().kind.clone())
{
@@ -262,7 +259,7 @@ impl<TSpec: EthSpec> NetworkBehaviour for PeerManager<TSpec> {
_error: &DialError,
) {
if let Some(peer_id) = peer_id {
if !self.network_globals.peers.read().is_connected(&peer_id) {
if !self.network_globals.peers().is_connected(&peer_id) {
self.inject_disconnect(&peer_id);
}
}

2
beacon_node/lighthouse_network/src/peer_manager/peerdb.rs
View File

@@ -314,7 +314,7 @@ impl<TSpec: EthSpec> PeerDB<TSpec> {
.map(|(id, _)| id)
}
/// Returns the peer's connection status. Returns unknown if the peer is not in the DB.
/// Returns the peer's connection status. Returns None if the peer is not in the DB.
pub fn connection_status(&self, peer_id: &PeerId) -> Option<PeerConnectionStatus> {
self.peer_info(peer_id)
.map(|info| info.connection_status().clone())

1
beacon_node/lighthouse_network/src/peer_manager/peerdb/peer_info.rs
View File

@@ -236,7 +236,6 @@ impl<T: EthSpec> PeerInfo<T> {
/* Mutable Functions */
/// Updates the sync status. Returns true if the status was changed.
// VISIBILITY: Both the peer manager the network sync is able to update the sync state of a peer
pub fn update_sync_status(&mut self, sync_status: SyncStatus) -> bool {
self.sync_status.update(sync_status)
}

26
beacon_node/lighthouse_network/src/peer_manager/peerdb/sync_status.rs
View File

@@ -27,19 +27,6 @@ pub struct SyncInfo {
pub finalized_root: Hash256,
}
impl std::cmp::PartialEq for SyncStatus {
fn eq(&self, other: &Self) -> bool {
matches!(
(self, other),
(SyncStatus::Synced { .. }, SyncStatus::Synced { .. })
| (SyncStatus::Advanced { .. }, SyncStatus::Advanced { .. })
| (SyncStatus::Behind { .. }, SyncStatus::Behind { .. })
| (SyncStatus::IrrelevantPeer, SyncStatus::IrrelevantPeer)
| (SyncStatus::Unknown, SyncStatus::Unknown)
)
}
}
impl SyncStatus {
/// Returns true if the peer has advanced knowledge of the chain.
pub fn is_advanced(&self) -> bool {
@@ -61,7 +48,7 @@ impl SyncStatus {
/// E.g. returns `true` if the state changed from `Synced` to `Advanced`, but not if
/// the status remained `Synced` with different `SyncInfo` within.
pub fn update(&mut self, new_state: SyncStatus) -> bool {
let changed_status = *self != new_state;
let changed_status = !(self.is_same_kind(&new_state));
*self = new_state;
changed_status
}
@@ -75,6 +62,17 @@ impl SyncStatus {
SyncStatus::IrrelevantPeer => "Irrelevant",
}
}
pub fn is_same_kind(&self, other: &Self) -> bool {
matches!(
(self, other),
(SyncStatus::Synced { .. }, SyncStatus::Synced { .. })
| (SyncStatus::Advanced { .. }, SyncStatus::Advanced { .. })
| (SyncStatus::Behind { .. }, SyncStatus::Behind { .. })
| (SyncStatus::IrrelevantPeer, SyncStatus::IrrelevantPeer)
| (SyncStatus::Unknown, SyncStatus::Unknown)
)
}
}
impl std::fmt::Display for SyncStatus {

3
beacon_node/lighthouse_network/src/service.rs
View File

@@ -215,8 +215,7 @@ impl<TSpec: EthSpec> Service<TSpec> {
}
if !network_globals
.peers
.read()
.peers()
.is_connected_or_dialing(&bootnode_enr.peer_id())
{
dial(multiaddr.clone());

10
beacon_node/lighthouse_network/src/types/globals.rs
View File

@@ -22,7 +22,7 @@ pub struct NetworkGlobals<TSpec: EthSpec> {
/// The UDP port that the discovery service is listening on
pub listen_port_udp: AtomicU16,
/// The collection of known peers.
pub peers: RwLock<PeerDB<TSpec>>,
peers: RwLock<PeerDB<TSpec>>,
// The local meta data of our node.
pub local_metadata: RwLock<MetaData<TSpec>>,
/// The current gossipsub topic subscriptions.
@@ -121,6 +121,14 @@ impl<TSpec: EthSpec> NetworkGlobals<TSpec> {
.unwrap_or_default()
}
pub fn peers(&self) -> impl std::ops::Deref<Target = PeerDB<TSpec>> + '_ {
self.peers.read()
}
pub(crate) fn peers_mut(&self) -> impl std::ops::DerefMut<Target = PeerDB<TSpec>> + '_ {
self.peers.write()
}
/// Updates the syncing state of the node.
///
/// The old state is returned