mirror of
https://github.com/fluencelabs/rust-libp2p
synced 2025-05-31 03:31:21 +00:00
135942d319
The `unreachable_pub` lint makes us aware of uses of `pub` that are not actually reachable from the crate root. This is considered good because it means reading a `pub` somewhere means it is actually public API. Some of our crates are quite large and keeping their entire API surface in your head is difficult. We should strive for most items being `pub(crate)`. This lint helps us enforce that. Pull-Request: #3735.
102 lines
4.2 KiB
Rust
102 lines
4.2 KiB
Rust
// Copyright 2020 Sigma Prime Pty Ltd.
|
|
//
|
|
// Permission is hereby granted, free of charge, to any person obtaining a
|
|
// copy of this software and associated documentation files (the "Software"),
|
|
// to deal in the Software without restriction, including without limitation
|
|
// the rights to use, copy, modify, merge, publish, distribute, sublicense,
|
|
// and/or sell copies of the Software, and to permit persons to whom the
|
|
// Software is furnished to do so, subject to the following conditions:
|
|
//
|
|
// The above copyright notice and this permission notice shall be included in
|
|
// all copies or substantial portions of the Software.
|
|
//
|
|
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
|
|
// OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
|
|
// FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
|
|
// DEALINGS IN THE SOFTWARE.
|
|
|
|
use crate::peer_score::RejectReason;
|
|
use crate::MessageId;
|
|
use crate::ValidationError;
|
|
use libp2p_identity::PeerId;
|
|
use log::debug;
|
|
use std::collections::HashMap;
|
|
use wasm_timer::Instant;
|
|
|
|
/// Tracks recently sent `IWANT` messages and checks if peers respond to them.
|
|
#[derive(Default)]
|
|
pub(crate) struct GossipPromises {
|
|
/// Stores for each tracked message id and peer the instant when this promise expires.
|
|
///
|
|
/// If the peer didn't respond until then we consider the promise as broken and penalize the
|
|
/// peer.
|
|
promises: HashMap<MessageId, HashMap<PeerId, Instant>>,
|
|
}
|
|
|
|
impl GossipPromises {
|
|
/// Returns true if the message id exists in the promises.
|
|
pub(crate) fn contains(&self, message: &MessageId) -> bool {
|
|
self.promises.contains_key(message)
|
|
}
|
|
|
|
/// Track a promise to deliver a message from a list of [`MessageId`]s we are requesting.
|
|
pub(crate) fn add_promise(&mut self, peer: PeerId, messages: &[MessageId], expires: Instant) {
|
|
for message_id in messages {
|
|
// If a promise for this message id and peer already exists we don't update the expiry!
|
|
self.promises
|
|
.entry(message_id.clone())
|
|
.or_insert_with(HashMap::new)
|
|
.entry(peer)
|
|
.or_insert(expires);
|
|
}
|
|
}
|
|
|
|
pub(crate) fn message_delivered(&mut self, message_id: &MessageId) {
|
|
// Someone delivered a message, we can stop tracking all promises for it.
|
|
self.promises.remove(message_id);
|
|
}
|
|
|
|
pub(crate) fn reject_message(&mut self, message_id: &MessageId, reason: &RejectReason) {
|
|
// A message got rejected, so we can stop tracking promises and let the score penalty apply
|
|
// from invalid message delivery.
|
|
// We do take exception and apply promise penalty regardless in the following cases, where
|
|
// the peer delivered an obviously invalid message.
|
|
match reason {
|
|
RejectReason::ValidationError(ValidationError::InvalidSignature) => (),
|
|
RejectReason::SelfOrigin => (),
|
|
_ => {
|
|
self.promises.remove(message_id);
|
|
}
|
|
};
|
|
}
|
|
|
|
/// Returns the number of broken promises for each peer who didn't follow up on an IWANT
|
|
/// request.
|
|
/// This should be called not too often relative to the expire times, since it iterates over
|
|
/// the whole stored data.
|
|
pub(crate) fn get_broken_promises(&mut self) -> HashMap<PeerId, usize> {
|
|
let now = Instant::now();
|
|
let mut result = HashMap::new();
|
|
self.promises.retain(|msg, peers| {
|
|
peers.retain(|peer_id, expires| {
|
|
if *expires < now {
|
|
let count = result.entry(*peer_id).or_insert(0);
|
|
*count += 1;
|
|
debug!(
|
|
"[Penalty] The peer {} broke the promise to deliver message {} in time!",
|
|
peer_id, msg
|
|
);
|
|
false
|
|
} else {
|
|
true
|
|
}
|
|
});
|
|
!peers.is_empty()
|
|
});
|
|
result
|
|
}
|
|
}
|