_ Git - rust-lightning/blob - lightning/src/ln/peer_handler.rs

   1 // This file is Copyright its original authors, visible in version control
   2 // history.
   3 //
   4 // This file is licensed under the Apache License, Version 2.0 <LICENSE-APACHE
   5 // or http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
   6 // <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your option.
   7 // You may not use this file except in accordance with one or both of these
   8 // licenses.
   9
  10 //! Top level peer message handling and socket handling logic lives here.
  11 //!
  12 //! Instead of actually servicing sockets ourselves we require that you implement the
  13 //! SocketDescriptor interface and use that to receive actions which you should perform on the
  14 //! socket, and call into PeerManager with bytes read from the socket. The PeerManager will then
  15 //! call into the provided message handlers (probably a ChannelManager and NetGraphmsgHandler) with messages
  16 //! they should handle, and encoding/sending response messages.
  17
  18 use bitcoin::secp256k1::key::{SecretKey,PublicKey};
  19
  20 use ln::features::InitFeatures;
  21 use ln::msgs;
  22 use ln::msgs::{ChannelMessageHandler, LightningError, NetAddress, RoutingMessageHandler};
  23 use ln::channelmanager::{SimpleArcChannelManager, SimpleRefChannelManager};
  24 use util::ser::{VecWriter, Writeable, Writer};
  25 use ln::peer_channel_encryptor::{PeerChannelEncryptor,NextNoiseStep};
  26 use ln::wire;
  27 use ln::wire::Encode;
  28 use util::atomic_counter::AtomicCounter;
  29 use util::events::{MessageSendEvent, MessageSendEventsProvider};
  30 use util::logger::Logger;
  31 use routing::network_graph::{NetworkGraph, NetGraphMsgHandler};
  32
  33 use prelude::*;
  34 use io;
  35 use alloc::collections::LinkedList;
  36 use sync::{Arc, Mutex, MutexGuard, FairRwLock};
  37 use core::sync::atomic::{AtomicBool, Ordering};
  38 use core::{cmp, hash, fmt, mem};
  39 use core::ops::Deref;
  40 use core::convert::Infallible;
  41 #[cfg(feature = "std")] use std::error;
  42
  43 use bitcoin::hashes::sha256::Hash as Sha256;
  44 use bitcoin::hashes::sha256::HashEngine as Sha256Engine;
  45 use bitcoin::hashes::{HashEngine, Hash};
  46
  47 /// Handler for BOLT1-compliant messages.
  48 pub trait CustomMessageHandler: wire::CustomMessageReader {
  49         /// Called with the message type that was received and the buffer to be read.
  50         /// Can return a `MessageHandlingError` if the message could not be handled.
  51         fn handle_custom_message(&self, msg: Self::CustomMessage, sender_node_id: &PublicKey) -> Result<(), LightningError>;
  52
  53         /// Gets the list of pending messages which were generated by the custom message
  54         /// handler, clearing the list in the process. The first tuple element must
  55         /// correspond to the intended recipients node ids. If no connection to one of the
  56         /// specified node does not exist, the message is simply not sent to it.
  57         fn get_and_clear_pending_msg(&self) -> Vec<(PublicKey, Self::CustomMessage)>;
  58 }
  59
  60 /// A dummy struct which implements `RoutingMessageHandler` without storing any routing information
  61 /// or doing any processing. You can provide one of these as the route_handler in a MessageHandler.
  62 pub struct IgnoringMessageHandler{}
  63 impl MessageSendEventsProvider for IgnoringMessageHandler {
  64         fn get_and_clear_pending_msg_events(&self) -> Vec<MessageSendEvent> { Vec::new() }
  65 }
  66 impl RoutingMessageHandler for IgnoringMessageHandler {
  67         fn handle_node_announcement(&self, _msg: &msgs::NodeAnnouncement) -> Result<bool, LightningError> { Ok(false) }
  68         fn handle_channel_announcement(&self, _msg: &msgs::ChannelAnnouncement) -> Result<bool, LightningError> { Ok(false) }
  69         fn handle_channel_update(&self, _msg: &msgs::ChannelUpdate) -> Result<bool, LightningError> { Ok(false) }
  70         fn get_next_channel_announcements(&self, _starting_point: u64, _batch_amount: u8) ->
  71                 Vec<(msgs::ChannelAnnouncement, Option<msgs::ChannelUpdate>, Option<msgs::ChannelUpdate>)> { Vec::new() }
  72         fn get_next_node_announcements(&self, _starting_point: Option<&PublicKey>, _batch_amount: u8) -> Vec<msgs::NodeAnnouncement> { Vec::new() }
  73         fn peer_connected(&self, _their_node_id: &PublicKey, _init: &msgs::Init) {}
  74         fn handle_reply_channel_range(&self, _their_node_id: &PublicKey, _msg: msgs::ReplyChannelRange) -> Result<(), LightningError> { Ok(()) }
  75         fn handle_reply_short_channel_ids_end(&self, _their_node_id: &PublicKey, _msg: msgs::ReplyShortChannelIdsEnd) -> Result<(), LightningError> { Ok(()) }
  76         fn handle_query_channel_range(&self, _their_node_id: &PublicKey, _msg: msgs::QueryChannelRange) -> Result<(), LightningError> { Ok(()) }
  77         fn handle_query_short_channel_ids(&self, _their_node_id: &PublicKey, _msg: msgs::QueryShortChannelIds) -> Result<(), LightningError> { Ok(()) }
  78 }
  79 impl Deref for IgnoringMessageHandler {
  80         type Target = IgnoringMessageHandler;
  81         fn deref(&self) -> &Self { self }
  82 }
  83
  84 // Implement Type for Infallible, note that it cannot be constructed, and thus you can never call a
  85 // method that takes self for it.
  86 impl wire::Type for Infallible {
  87         fn type_id(&self) -> u16 {
  88                 unreachable!();
  89         }
  90 }
  91 impl Writeable for Infallible {
  92         fn write<W: Writer>(&self, _: &mut W) -> Result<(), io::Error> {
  93                 unreachable!();
  94         }
  95 }
  96
  97 impl wire::CustomMessageReader for IgnoringMessageHandler {
  98         type CustomMessage = Infallible;
  99         fn read<R: io::Read>(&self, _message_type: u16, _buffer: &mut R) -> Result<Option<Self::CustomMessage>, msgs::DecodeError> {
 100                 Ok(None)
 101         }
 102 }
 103
 104 impl CustomMessageHandler for IgnoringMessageHandler {
 105         fn handle_custom_message(&self, _msg: Infallible, _sender_node_id: &PublicKey) -> Result<(), LightningError> {
 106                 // Since we always return `None` in the read the handle method should never be called.
 107                 unreachable!();
 108         }
 109
 110         fn get_and_clear_pending_msg(&self) -> Vec<(PublicKey, Self::CustomMessage)> { Vec::new() }
 111 }
 112
 113 /// A dummy struct which implements `ChannelMessageHandler` without having any channels.
 114 /// You can provide one of these as the route_handler in a MessageHandler.
 115 pub struct ErroringMessageHandler {
 116         message_queue: Mutex<Vec<MessageSendEvent>>
 117 }
 118 impl ErroringMessageHandler {
 119         /// Constructs a new ErroringMessageHandler
 120         pub fn new() -> Self {
 121                 Self { message_queue: Mutex::new(Vec::new()) }
 122         }
 123         fn push_error(&self, node_id: &PublicKey, channel_id: [u8; 32]) {
 124                 self.message_queue.lock().unwrap().push(MessageSendEvent::HandleError {
 125                         action: msgs::ErrorAction::SendErrorMessage {
 126                                 msg: msgs::ErrorMessage { channel_id, data: "We do not support channel messages, sorry.".to_owned() },
 127                         },
 128                         node_id: node_id.clone(),
 129                 });
 130         }
 131 }
 132 impl MessageSendEventsProvider for ErroringMessageHandler {
 133         fn get_and_clear_pending_msg_events(&self) -> Vec<MessageSendEvent> {
 134                 let mut res = Vec::new();
 135                 mem::swap(&mut res, &mut self.message_queue.lock().unwrap());
 136                 res
 137         }
 138 }
 139 impl ChannelMessageHandler for ErroringMessageHandler {
 140         // Any messages which are related to a specific channel generate an error message to let the
 141         // peer know we don't care about channels.
 142         fn handle_open_channel(&self, their_node_id: &PublicKey, _their_features: InitFeatures, msg: &msgs::OpenChannel) {
 143                 ErroringMessageHandler::push_error(self, their_node_id, msg.temporary_channel_id);
 144         }
 145         fn handle_accept_channel(&self, their_node_id: &PublicKey, _their_features: InitFeatures, msg: &msgs::AcceptChannel) {
 146                 ErroringMessageHandler::push_error(self, their_node_id, msg.temporary_channel_id);
 147         }
 148         fn handle_funding_created(&self, their_node_id: &PublicKey, msg: &msgs::FundingCreated) {
 149                 ErroringMessageHandler::push_error(self, their_node_id, msg.temporary_channel_id);
 150         }
 151         fn handle_funding_signed(&self, their_node_id: &PublicKey, msg: &msgs::FundingSigned) {
 152                 ErroringMessageHandler::push_error(self, their_node_id, msg.channel_id);
 153         }
 154         fn handle_funding_locked(&self, their_node_id: &PublicKey, msg: &msgs::FundingLocked) {
 155                 ErroringMessageHandler::push_error(self, their_node_id, msg.channel_id);
 156         }
 157         fn handle_shutdown(&self, their_node_id: &PublicKey, _their_features: &InitFeatures, msg: &msgs::Shutdown) {
 158                 ErroringMessageHandler::push_error(self, their_node_id, msg.channel_id);
 159         }
 160         fn handle_closing_signed(&self, their_node_id: &PublicKey, msg: &msgs::ClosingSigned) {
 161                 ErroringMessageHandler::push_error(self, their_node_id, msg.channel_id);
 162         }
 163         fn handle_update_add_htlc(&self, their_node_id: &PublicKey, msg: &msgs::UpdateAddHTLC) {
 164                 ErroringMessageHandler::push_error(self, their_node_id, msg.channel_id);
 165         }
 166         fn handle_update_fulfill_htlc(&self, their_node_id: &PublicKey, msg: &msgs::UpdateFulfillHTLC) {
 167                 ErroringMessageHandler::push_error(self, their_node_id, msg.channel_id);
 168         }
 169         fn handle_update_fail_htlc(&self, their_node_id: &PublicKey, msg: &msgs::UpdateFailHTLC) {
 170                 ErroringMessageHandler::push_error(self, their_node_id, msg.channel_id);
 171         }
 172         fn handle_update_fail_malformed_htlc(&self, their_node_id: &PublicKey, msg: &msgs::UpdateFailMalformedHTLC) {
 173                 ErroringMessageHandler::push_error(self, their_node_id, msg.channel_id);
 174         }
 175         fn handle_commitment_signed(&self, their_node_id: &PublicKey, msg: &msgs::CommitmentSigned) {
 176                 ErroringMessageHandler::push_error(self, their_node_id, msg.channel_id);
 177         }
 178         fn handle_revoke_and_ack(&self, their_node_id: &PublicKey, msg: &msgs::RevokeAndACK) {
 179                 ErroringMessageHandler::push_error(self, their_node_id, msg.channel_id);
 180         }
 181         fn handle_update_fee(&self, their_node_id: &PublicKey, msg: &msgs::UpdateFee) {
 182                 ErroringMessageHandler::push_error(self, their_node_id, msg.channel_id);
 183         }
 184         fn handle_announcement_signatures(&self, their_node_id: &PublicKey, msg: &msgs::AnnouncementSignatures) {
 185                 ErroringMessageHandler::push_error(self, their_node_id, msg.channel_id);
 186         }
 187         fn handle_channel_reestablish(&self, their_node_id: &PublicKey, msg: &msgs::ChannelReestablish) {
 188                 ErroringMessageHandler::push_error(self, their_node_id, msg.channel_id);
 189         }
 190         // msgs::ChannelUpdate does not contain the channel_id field, so we just drop them.
 191         fn handle_channel_update(&self, _their_node_id: &PublicKey, _msg: &msgs::ChannelUpdate) {}
 192         fn peer_disconnected(&self, _their_node_id: &PublicKey, _no_connection_possible: bool) {}
 193         fn peer_connected(&self, _their_node_id: &PublicKey, _msg: &msgs::Init) {}
 194         fn handle_error(&self, _their_node_id: &PublicKey, _msg: &msgs::ErrorMessage) {}
 195 }
 196 impl Deref for ErroringMessageHandler {
 197         type Target = ErroringMessageHandler;
 198         fn deref(&self) -> &Self { self }
 199 }
 200
 201 /// Provides references to trait impls which handle different types of messages.
 202 pub struct MessageHandler<CM: Deref, RM: Deref> where
 203                 CM::Target: ChannelMessageHandler,
 204                 RM::Target: RoutingMessageHandler {
 205         /// A message handler which handles messages specific to channels. Usually this is just a
 206         /// [`ChannelManager`] object or an [`ErroringMessageHandler`].
 207         ///
 208         /// [`ChannelManager`]: crate::ln::channelmanager::ChannelManager
 209         pub chan_handler: CM,
 210         /// A message handler which handles messages updating our knowledge of the network channel
 211         /// graph. Usually this is just a [`NetGraphMsgHandler`] object or an
 212         /// [`IgnoringMessageHandler`].
 213         ///
 214         /// [`NetGraphMsgHandler`]: crate::routing::network_graph::NetGraphMsgHandler
 215         pub route_handler: RM,
 216 }
 217
 218 /// Provides an object which can be used to send data to and which uniquely identifies a connection
 219 /// to a remote host. You will need to be able to generate multiple of these which meet Eq and
 220 /// implement Hash to meet the PeerManager API.
 221 ///
 222 /// For efficiency, Clone should be relatively cheap for this type.
 223 ///
 224 /// Two descriptors may compare equal (by [`cmp::Eq`] and [`hash::Hash`]) as long as the original
 225 /// has been disconnected, the [`PeerManager`] has been informed of the disconnection (either by it
 226 /// having triggered the disconnection or a call to [`PeerManager::socket_disconnected`]), and no
 227 /// further calls to the [`PeerManager`] related to the original socket occur. This allows you to
 228 /// use a file descriptor for your SocketDescriptor directly, however for simplicity you may wish
 229 /// to simply use another value which is guaranteed to be globally unique instead.
 230 pub trait SocketDescriptor : cmp::Eq + hash::Hash + Clone {
 231         /// Attempts to send some data from the given slice to the peer.
 232         ///
 233         /// Returns the amount of data which was sent, possibly 0 if the socket has since disconnected.
 234         /// Note that in the disconnected case, [`PeerManager::socket_disconnected`] must still be
 235         /// called and further write attempts may occur until that time.
 236         ///
 237         /// If the returned size is smaller than `data.len()`, a
 238         /// [`PeerManager::write_buffer_space_avail`] call must be made the next time more data can be
 239         /// written. Additionally, until a `send_data` event completes fully, no further
 240         /// [`PeerManager::read_event`] calls should be made for the same peer! Because this is to
 241         /// prevent denial-of-service issues, you should not read or buffer any data from the socket
 242         /// until then.
 243         ///
 244         /// If a [`PeerManager::read_event`] call on this descriptor had previously returned true
 245         /// (indicating that read events should be paused to prevent DoS in the send buffer),
 246         /// `resume_read` may be set indicating that read events on this descriptor should resume. A
 247         /// `resume_read` of false carries no meaning, and should not cause any action.
 248         fn send_data(&mut self, data: &[u8], resume_read: bool) -> usize;
 249         /// Disconnect the socket pointed to by this SocketDescriptor.
 250         ///
 251         /// You do *not* need to call [`PeerManager::socket_disconnected`] with this socket after this
 252         /// call (doing so is a noop).
 253         fn disconnect_socket(&mut self);
 254 }
 255
 256 /// Error for PeerManager errors. If you get one of these, you must disconnect the socket and
 257 /// generate no further read_event/write_buffer_space_avail/socket_disconnected calls for the
 258 /// descriptor.
 259 #[derive(Clone)]
 260 pub struct PeerHandleError {
 261         /// Used to indicate that we probably can't make any future connections to this peer, implying
 262         /// we should go ahead and force-close any channels we have with it.
 263         pub no_connection_possible: bool,
 264 }
 265 impl fmt::Debug for PeerHandleError {
 266         fn fmt(&self, formatter: &mut fmt::Formatter) -> Result<(), fmt::Error> {
 267                 formatter.write_str("Peer Sent Invalid Data")
 268         }
 269 }
 270 impl fmt::Display for PeerHandleError {
 271         fn fmt(&self, formatter: &mut fmt::Formatter) -> Result<(), fmt::Error> {
 272                 formatter.write_str("Peer Sent Invalid Data")
 273         }
 274 }
 275
 276 #[cfg(feature = "std")]
 277 impl error::Error for PeerHandleError {
 278         fn description(&self) -> &str {
 279                 "Peer Sent Invalid Data"
 280         }
 281 }
 282
 283 enum InitSyncTracker{
 284         NoSyncRequested,
 285         ChannelsSyncing(u64),
 286         NodesSyncing(PublicKey),
 287 }
 288
 289 /// The ratio between buffer sizes at which we stop sending initial sync messages vs when we stop
 290 /// forwarding gossip messages to peers altogether.
 291 const FORWARD_INIT_SYNC_BUFFER_LIMIT_RATIO: usize = 2;
 292
 293 /// When the outbound buffer has this many messages, we'll stop reading bytes from the peer until
 294 /// we have fewer than this many messages in the outbound buffer again.
 295 /// We also use this as the target number of outbound gossip messages to keep in the write buffer,
 296 /// refilled as we send bytes.
 297 const OUTBOUND_BUFFER_LIMIT_READ_PAUSE: usize = 10;
 298 /// When the outbound buffer has this many messages, we'll simply skip relaying gossip messages to
 299 /// the peer.
 300 const OUTBOUND_BUFFER_LIMIT_DROP_GOSSIP: usize = OUTBOUND_BUFFER_LIMIT_READ_PAUSE * FORWARD_INIT_SYNC_BUFFER_LIMIT_RATIO;
 301
 302 /// If we've sent a ping, and are still awaiting a response, we may need to churn our way through
 303 /// the socket receive buffer before receiving the ping.
 304 ///
 305 /// On a fairly old Arm64 board, with Linux defaults, this can take as long as 20 seconds, not
 306 /// including any network delays, outbound traffic, or the same for messages from other peers.
 307 ///
 308 /// Thus, to avoid needlessly disconnecting a peer, we allow a peer to take this many timer ticks
 309 /// per connected peer to respond to a ping, as long as they send us at least one message during
 310 /// each tick, ensuring we aren't actually just disconnected.
 311 /// With a timer tick interval of ten seconds, this translates to about 40 seconds per connected
 312 /// peer.
 313 ///
 314 /// When we improve parallelism somewhat we should reduce this to e.g. this many timer ticks per
 315 /// two connected peers, assuming most LDK-running systems have at least two cores.
 316 const MAX_BUFFER_DRAIN_TICK_INTERVALS_PER_PEER: i8 = 4;
 317
 318 /// This is the minimum number of messages we expect a peer to be able to handle within one timer
 319 /// tick. Once we have sent this many messages since the last ping, we send a ping right away to
 320 /// ensures we don't just fill up our send buffer and leave the peer with too many messages to
 321 /// process before the next ping.
 322 const BUFFER_DRAIN_MSGS_PER_TICK: usize = 32;
 323
 324 struct Peer {
 325         channel_encryptor: PeerChannelEncryptor,
 326         their_node_id: Option<PublicKey>,
 327         their_features: Option<InitFeatures>,
 328         their_net_address: Option<NetAddress>,
 329
 330         pending_outbound_buffer: LinkedList<Vec<u8>>,
 331         pending_outbound_buffer_first_msg_offset: usize,
 332         awaiting_write_event: bool,
 333
 334         pending_read_buffer: Vec<u8>,
 335         pending_read_buffer_pos: usize,
 336         pending_read_is_header: bool,
 337
 338         sync_status: InitSyncTracker,
 339
 340         msgs_sent_since_pong: usize,
 341         awaiting_pong_timer_tick_intervals: i8,
 342         received_message_since_timer_tick: bool,
 343         sent_gossip_timestamp_filter: bool,
 344 }
 345
 346 impl Peer {
 347         /// Returns true if the channel announcements/updates for the given channel should be
 348         /// forwarded to this peer.
 349         /// If we are sending our routing table to this peer and we have not yet sent channel
 350         /// announcements/updates for the given channel_id then we will send it when we get to that
 351         /// point and we shouldn't send it yet to avoid sending duplicate updates. If we've already
 352         /// sent the old versions, we should send the update, and so return true here.
 353         fn should_forward_channel_announcement(&self, channel_id: u64) -> bool {
 354                 if self.their_features.as_ref().unwrap().supports_gossip_queries() &&
 355                         !self.sent_gossip_timestamp_filter {
 356                                 return false;
 357                         }
 358                 match self.sync_status {
 359                         InitSyncTracker::NoSyncRequested => true,
 360                         InitSyncTracker::ChannelsSyncing(i) => i < channel_id,
 361                         InitSyncTracker::NodesSyncing(_) => true,
 362                 }
 363         }
 364
 365         /// Similar to the above, but for node announcements indexed by node_id.
 366         fn should_forward_node_announcement(&self, node_id: PublicKey) -> bool {
 367                 if self.their_features.as_ref().unwrap().supports_gossip_queries() &&
 368                         !self.sent_gossip_timestamp_filter {
 369                                 return false;
 370                         }
 371                 match self.sync_status {
 372                         InitSyncTracker::NoSyncRequested => true,
 373                         InitSyncTracker::ChannelsSyncing(_) => false,
 374                         InitSyncTracker::NodesSyncing(pk) => pk < node_id,
 375                 }
 376         }
 377 }
 378
 379 /// SimpleArcPeerManager is useful when you need a PeerManager with a static lifetime, e.g.
 380 /// when you're using lightning-net-tokio (since tokio::spawn requires parameters with static
 381 /// lifetimes). Other times you can afford a reference, which is more efficient, in which case
 382 /// SimpleRefPeerManager is the more appropriate type. Defining these type aliases prevents
 383 /// issues such as overly long function definitions.
 384 ///
 385 /// (C-not exported) as Arcs don't make sense in bindings
 386 pub type SimpleArcPeerManager<SD, M, T, F, C, L> = PeerManager<SD, Arc<SimpleArcChannelManager<M, T, F, L>>, Arc<NetGraphMsgHandler<Arc<NetworkGraph>, Arc<C>, Arc<L>>>, Arc<L>, Arc<IgnoringMessageHandler>>;
 387
 388 /// SimpleRefPeerManager is a type alias for a PeerManager reference, and is the reference
 389 /// counterpart to the SimpleArcPeerManager type alias. Use this type by default when you don't
 390 /// need a PeerManager with a static lifetime. You'll need a static lifetime in cases such as
 391 /// usage of lightning-net-tokio (since tokio::spawn requires parameters with static lifetimes).
 392 /// But if this is not necessary, using a reference is more efficient. Defining these type aliases
 393 /// helps with issues such as long function definitions.
 394 ///
 395 /// (C-not exported) as Arcs don't make sense in bindings
 396 pub type SimpleRefPeerManager<'a, 'b, 'c, 'd, 'e, 'f, 'g, 'h, SD, M, T, F, C, L> = PeerManager<SD, SimpleRefChannelManager<'a, 'b, 'c, 'd, 'e, M, T, F, L>, &'e NetGraphMsgHandler<&'g NetworkGraph, &'h C, &'f L>, &'f L, IgnoringMessageHandler>;
 397
 398 /// A PeerManager manages a set of peers, described by their [`SocketDescriptor`] and marshalls
 399 /// socket events into messages which it passes on to its [`MessageHandler`].
 400 ///
 401 /// Locks are taken internally, so you must never assume that reentrancy from a
 402 /// [`SocketDescriptor`] call back into [`PeerManager`] methods will not deadlock.
 403 ///
 404 /// Calls to [`read_event`] will decode relevant messages and pass them to the
 405 /// [`ChannelMessageHandler`], likely doing message processing in-line. Thus, the primary form of
 406 /// parallelism in Rust-Lightning is in calls to [`read_event`]. Note, however, that calls to any
 407 /// [`PeerManager`] functions related to the same connection must occur only in serial, making new
 408 /// calls only after previous ones have returned.
 409 ///
 410 /// Rather than using a plain PeerManager, it is preferable to use either a SimpleArcPeerManager
 411 /// a SimpleRefPeerManager, for conciseness. See their documentation for more details, but
 412 /// essentially you should default to using a SimpleRefPeerManager, and use a
 413 /// SimpleArcPeerManager when you require a PeerManager with a static lifetime, such as when
 414 /// you're using lightning-net-tokio.
 415 ///
 416 /// [`read_event`]: PeerManager::read_event
 417 pub struct PeerManager<Descriptor: SocketDescriptor, CM: Deref, RM: Deref, L: Deref, CMH: Deref> where
 418                 CM::Target: ChannelMessageHandler,
 419                 RM::Target: RoutingMessageHandler,
 420                 L::Target: Logger,
 421                 CMH::Target: CustomMessageHandler {
 422         message_handler: MessageHandler<CM, RM>,
 423         /// Connection state for each connected peer - we have an outer read-write lock which is taken
 424         /// as read while we're doing processing for a peer and taken write when a peer is being added
 425         /// or removed.
 426         ///
 427         /// The inner Peer lock is held for sending and receiving bytes, but note that we do *not* hold
 428         /// it while we're processing a message. This is fine as [`PeerManager::read_event`] requires
 429         /// that there be no parallel calls for a given peer, so mutual exclusion of messages handed to
 430         /// the `MessageHandler`s for a given peer is already guaranteed.
 431         peers: FairRwLock<HashMap<Descriptor, Mutex<Peer>>>,
 432         /// Only add to this set when noise completes.
 433         /// Locked *after* peers. When an item is removed, it must be removed with the `peers` write
 434         /// lock held. Entries may be added with only the `peers` read lock held (though the
 435         /// `Descriptor` value must already exist in `peers`).
 436         node_id_to_descriptor: Mutex<HashMap<PublicKey, Descriptor>>,
 437         /// We can only have one thread processing events at once, but we don't usually need the full
 438         /// `peers` write lock to do so, so instead we block on this empty mutex when entering
 439         /// `process_events`.
 440         event_processing_lock: Mutex<()>,
 441         /// Because event processing is global and always does all available work before returning,
 442         /// there is no reason for us to have many event processors waiting on the lock at once.
 443         /// Instead, we limit the total blocked event processors to always exactly one by setting this
 444         /// when an event process call is waiting.
 445         blocked_event_processors: AtomicBool,
 446         our_node_secret: SecretKey,
 447         ephemeral_key_midstate: Sha256Engine,
 448         custom_message_handler: CMH,
 449
 450         peer_counter: AtomicCounter,
 451
 452         logger: L,
 453 }
 454
 455 enum MessageHandlingError {
 456         PeerHandleError(PeerHandleError),
 457         LightningError(LightningError),
 458 }
 459
 460 impl From<PeerHandleError> for MessageHandlingError {
 461         fn from(error: PeerHandleError) -> Self {
 462                 MessageHandlingError::PeerHandleError(error)
 463         }
 464 }
 465
 466 impl From<LightningError> for MessageHandlingError {
 467         fn from(error: LightningError) -> Self {
 468                 MessageHandlingError::LightningError(error)
 469         }
 470 }
 471
 472 macro_rules! encode_msg {
 473         ($msg: expr) => {{
 474                 let mut buffer = VecWriter(Vec::new());
 475                 wire::write($msg, &mut buffer).unwrap();
 476                 buffer.0
 477         }}
 478 }
 479
 480 impl<Descriptor: SocketDescriptor, CM: Deref, L: Deref> PeerManager<Descriptor, CM, IgnoringMessageHandler, L, IgnoringMessageHandler> where
 481                 CM::Target: ChannelMessageHandler,
 482                 L::Target: Logger {
 483         /// Constructs a new PeerManager with the given ChannelMessageHandler. No routing message
 484         /// handler is used and network graph messages are ignored.
 485         ///
 486         /// ephemeral_random_data is used to derive per-connection ephemeral keys and must be
 487         /// cryptographically secure random bytes.
 488         ///
 489         /// (C-not exported) as we can't export a PeerManager with a dummy route handler
 490         pub fn new_channel_only(channel_message_handler: CM, our_node_secret: SecretKey, ephemeral_random_data: &[u8; 32], logger: L) -> Self {
 491                 Self::new(MessageHandler {
 492                         chan_handler: channel_message_handler,
 493                         route_handler: IgnoringMessageHandler{},
 494                 }, our_node_secret, ephemeral_random_data, logger, IgnoringMessageHandler{})
 495         }
 496 }
 497
 498 impl<Descriptor: SocketDescriptor, RM: Deref, L: Deref> PeerManager<Descriptor, ErroringMessageHandler, RM, L, IgnoringMessageHandler> where
 499                 RM::Target: RoutingMessageHandler,
 500                 L::Target: Logger {
 501         /// Constructs a new PeerManager with the given RoutingMessageHandler. No channel message
 502         /// handler is used and messages related to channels will be ignored (or generate error
 503         /// messages). Note that some other lightning implementations time-out connections after some
 504         /// time if no channel is built with the peer.
 505         ///
 506         /// ephemeral_random_data is used to derive per-connection ephemeral keys and must be
 507         /// cryptographically secure random bytes.
 508         ///
 509         /// (C-not exported) as we can't export a PeerManager with a dummy channel handler
 510         pub fn new_routing_only(routing_message_handler: RM, our_node_secret: SecretKey, ephemeral_random_data: &[u8; 32], logger: L) -> Self {
 511                 Self::new(MessageHandler {
 512                         chan_handler: ErroringMessageHandler::new(),
 513                         route_handler: routing_message_handler,
 514                 }, our_node_secret, ephemeral_random_data, logger, IgnoringMessageHandler{})
 515         }
 516 }
 517
 518 /// A simple wrapper that optionally prints " from <pubkey>" for an optional pubkey.
 519 /// This works around `format!()` taking a reference to each argument, preventing
 520 /// `if let Some(node_id) = peer.their_node_id { format!(.., node_id) } else { .. }` from compiling
 521 /// due to lifetime errors.
 522 struct OptionalFromDebugger<'a>(&'a Option<PublicKey>);
 523 impl core::fmt::Display for OptionalFromDebugger<'_> {
 524         fn fmt(&self, f: &mut core::fmt::Formatter<'_>) -> Result<(), core::fmt::Error> {
 525                 if let Some(node_id) = self.0 { write!(f, " from {}", log_pubkey!(node_id)) } else { Ok(()) }
 526         }
 527 }
 528
 529 /// A function used to filter out local or private addresses
 530 /// https://www.iana.org./assignments/ipv4-address-space/ipv4-address-space.xhtml
 531 /// https://www.iana.org/assignments/ipv6-address-space/ipv6-address-space.xhtml
 532 fn filter_addresses(ip_address: Option<NetAddress>) -> Option<NetAddress> {
 533         match ip_address{
 534                 // For IPv4 range 10.0.0.0 - 10.255.255.255 (10/8)
 535                 Some(NetAddress::IPv4{addr: [10, _, _, _], port: _}) => None,
 536                 // For IPv4 range 0.0.0.0 - 0.255.255.255 (0/8)
 537                 Some(NetAddress::IPv4{addr: [0, _, _, _], port: _}) => None,
 538                 // For IPv4 range 100.64.0.0 - 100.127.255.255 (100.64/10)
 539                 Some(NetAddress::IPv4{addr: [100, 64..=127, _, _], port: _}) => None,
 540                 // For IPv4 range       127.0.0.0 - 127.255.255.255 (127/8)
 541                 Some(NetAddress::IPv4{addr: [127, _, _, _], port: _}) => None,
 542                 // For IPv4 range       169.254.0.0 - 169.254.255.255 (169.254/16)
 543                 Some(NetAddress::IPv4{addr: [169, 254, _, _], port: _}) => None,
 544                 // For IPv4 range 172.16.0.0 - 172.31.255.255 (172.16/12)
 545                 Some(NetAddress::IPv4{addr: [172, 16..=31, _, _], port: _}) => None,
 546                 // For IPv4 range 192.168.0.0 - 192.168.255.255 (192.168/16)
 547                 Some(NetAddress::IPv4{addr: [192, 168, _, _], port: _}) => None,
 548                 // For IPv4 range 192.88.99.0 - 192.88.99.255  (192.88.99/24)
 549                 Some(NetAddress::IPv4{addr: [192, 88, 99, _], port: _}) => None,
 550                 // For IPv6 range 2000:0000:0000:0000:0000:0000:0000:0000 - 3fff:ffff:ffff:ffff:ffff:ffff:ffff:ffff (2000::/3)
 551                 Some(NetAddress::IPv6{addr: [0x20..=0x3F, _, _, _, _, _, _, _, _, _, _, _, _, _, _, _], port: _}) => ip_address,
 552                 // For remaining addresses
 553                 Some(NetAddress::IPv6{addr: _, port: _}) => None,
 554                 Some(..) => ip_address,
 555                 None => None,
 556         }
 557 }
 558
 559 impl<Descriptor: SocketDescriptor, CM: Deref, RM: Deref, L: Deref, CMH: Deref> PeerManager<Descriptor, CM, RM, L, CMH> where
 560                 CM::Target: ChannelMessageHandler,
 561                 RM::Target: RoutingMessageHandler,
 562                 L::Target: Logger,
 563                 CMH::Target: CustomMessageHandler {
 564         /// Constructs a new PeerManager with the given message handlers and node_id secret key
 565         /// ephemeral_random_data is used to derive per-connection ephemeral keys and must be
 566         /// cryptographically secure random bytes.
 567         pub fn new(message_handler: MessageHandler<CM, RM>, our_node_secret: SecretKey, ephemeral_random_data: &[u8; 32], logger: L, custom_message_handler: CMH) -> Self {
 568                 let mut ephemeral_key_midstate = Sha256::engine();
 569                 ephemeral_key_midstate.input(ephemeral_random_data);
 570
 571                 PeerManager {
 572                         message_handler,
 573                         peers: FairRwLock::new(HashMap::new()),
 574                         node_id_to_descriptor: Mutex::new(HashMap::new()),
 575                         event_processing_lock: Mutex::new(()),
 576                         blocked_event_processors: AtomicBool::new(false),
 577                         our_node_secret,
 578                         ephemeral_key_midstate,
 579                         peer_counter: AtomicCounter::new(),
 580                         logger,
 581                         custom_message_handler,
 582                 }
 583         }
 584
 585         /// Get the list of node ids for peers which have completed the initial handshake.
 586         ///
 587         /// For outbound connections, this will be the same as the their_node_id parameter passed in to
 588         /// new_outbound_connection, however entries will only appear once the initial handshake has
 589         /// completed and we are sure the remote peer has the private key for the given node_id.
 590         pub fn get_peer_node_ids(&self) -> Vec<PublicKey> {
 591                 let peers = self.peers.read().unwrap();
 592                 peers.values().filter_map(|peer_mutex| {
 593                         let p = peer_mutex.lock().unwrap();
 594                         if !p.channel_encryptor.is_ready_for_encryption() || p.their_features.is_none() {
 595                                 return None;
 596                         }
 597                         p.their_node_id
 598                 }).collect()
 599         }
 600
 601         fn get_ephemeral_key(&self) -> SecretKey {
 602                 let mut ephemeral_hash = self.ephemeral_key_midstate.clone();
 603                 let counter = self.peer_counter.get_increment();
 604                 ephemeral_hash.input(&counter.to_le_bytes());
 605                 SecretKey::from_slice(&Sha256::from_engine(ephemeral_hash).into_inner()).expect("You broke SHA-256!")
 606         }
 607
 608         /// Indicates a new outbound connection has been established to a node with the given node_id
 609         /// and an optional remote network address.
 610         ///
 611         /// The remote network address adds the option to report a remote IP address back to a connecting
 612         /// peer using the init message.
 613         /// The user should pass the remote network address of the host they are connected to.
 614         ///
 615         /// Note that if an Err is returned here you MUST NOT call socket_disconnected for the new
 616         /// descriptor but must disconnect the connection immediately.
 617         ///
 618         /// Returns a small number of bytes to send to the remote node (currently always 50).
 619         ///
 620         /// Panics if descriptor is duplicative with some other descriptor which has not yet been
 621         /// [`socket_disconnected()`].
 622         ///
 623         /// [`socket_disconnected()`]: PeerManager::socket_disconnected
 624         pub fn new_outbound_connection(&self, their_node_id: PublicKey, descriptor: Descriptor, remote_network_address: Option<NetAddress>) -> Result<Vec<u8>, PeerHandleError> {
 625                 let mut peer_encryptor = PeerChannelEncryptor::new_outbound(their_node_id.clone(), self.get_ephemeral_key());
 626                 let res = peer_encryptor.get_act_one().to_vec();
 627                 let pending_read_buffer = [0; 50].to_vec(); // Noise act two is 50 bytes
 628
 629                 let mut peers = self.peers.write().unwrap();
 630                 if peers.insert(descriptor, Mutex::new(Peer {
 631                         channel_encryptor: peer_encryptor,
 632                         their_node_id: None,
 633                         their_features: None,
 634                         their_net_address: remote_network_address,
 635
 636                         pending_outbound_buffer: LinkedList::new(),
 637                         pending_outbound_buffer_first_msg_offset: 0,
 638                         awaiting_write_event: false,
 639
 640                         pending_read_buffer,
 641                         pending_read_buffer_pos: 0,
 642                         pending_read_is_header: false,
 643
 644                         sync_status: InitSyncTracker::NoSyncRequested,
 645
 646                         msgs_sent_since_pong: 0,
 647                         awaiting_pong_timer_tick_intervals: 0,
 648                         received_message_since_timer_tick: false,
 649                         sent_gossip_timestamp_filter: false,
 650                 })).is_some() {
 651                         panic!("PeerManager driver duplicated descriptors!");
 652                 };
 653                 Ok(res)
 654         }
 655
 656         /// Indicates a new inbound connection has been established to a node with an optional remote
 657         /// network address.
 658         ///
 659         /// The remote network address adds the option to report a remote IP address back to a connecting
 660         /// peer using the init message.
 661         /// The user should pass the remote network address of the host they are connected to.
 662         ///
 663         /// May refuse the connection by returning an Err, but will never write bytes to the remote end
 664         /// (outbound connector always speaks first). Note that if an Err is returned here you MUST NOT
 665         /// call socket_disconnected for the new descriptor but must disconnect the connection
 666         /// immediately.
 667         ///
 668         /// Panics if descriptor is duplicative with some other descriptor which has not yet been
 669         /// [`socket_disconnected()`].
 670         ///
 671         /// [`socket_disconnected()`]: PeerManager::socket_disconnected
 672         pub fn new_inbound_connection(&self, descriptor: Descriptor, remote_network_address: Option<NetAddress>) -> Result<(), PeerHandleError> {
 673                 let peer_encryptor = PeerChannelEncryptor::new_inbound(&self.our_node_secret);
 674                 let pending_read_buffer = [0; 50].to_vec(); // Noise act one is 50 bytes
 675
 676                 let mut peers = self.peers.write().unwrap();
 677                 if peers.insert(descriptor, Mutex::new(Peer {
 678                         channel_encryptor: peer_encryptor,
 679                         their_node_id: None,
 680                         their_features: None,
 681                         their_net_address: remote_network_address,
 682
 683                         pending_outbound_buffer: LinkedList::new(),
 684                         pending_outbound_buffer_first_msg_offset: 0,
 685                         awaiting_write_event: false,
 686
 687                         pending_read_buffer,
 688                         pending_read_buffer_pos: 0,
 689                         pending_read_is_header: false,
 690
 691                         sync_status: InitSyncTracker::NoSyncRequested,
 692
 693                         msgs_sent_since_pong: 0,
 694                         awaiting_pong_timer_tick_intervals: 0,
 695                         received_message_since_timer_tick: false,
 696                         sent_gossip_timestamp_filter: false,
 697                 })).is_some() {
 698                         panic!("PeerManager driver duplicated descriptors!");
 699                 };
 700                 Ok(())
 701         }
 702
 703         fn do_attempt_write_data(&self, descriptor: &mut Descriptor, peer: &mut Peer) {
 704                 while !peer.awaiting_write_event {
 705                         if peer.pending_outbound_buffer.len() < OUTBOUND_BUFFER_LIMIT_READ_PAUSE && peer.msgs_sent_since_pong < BUFFER_DRAIN_MSGS_PER_TICK {
 706                                 match peer.sync_status {
 707                                         InitSyncTracker::NoSyncRequested => {},
 708                                         InitSyncTracker::ChannelsSyncing(c) if c < 0xffff_ffff_ffff_ffff => {
 709                                                 let steps = ((OUTBOUND_BUFFER_LIMIT_READ_PAUSE - peer.pending_outbound_buffer.len() + 2) / 3) as u8;
 710                                                 let all_messages = self.message_handler.route_handler.get_next_channel_announcements(c, steps);
 711                                                 for &(ref announce, ref update_a_option, ref update_b_option) in all_messages.iter() {
 712                                                         self.enqueue_message(peer, announce);
 713                                                         if let &Some(ref update_a) = update_a_option {
 714                                                                 self.enqueue_message(peer, update_a);
 715                                                         }
 716                                                         if let &Some(ref update_b) = update_b_option {
 717                                                                 self.enqueue_message(peer, update_b);
 718                                                         }
 719                                                         peer.sync_status = InitSyncTracker::ChannelsSyncing(announce.contents.short_channel_id + 1);
 720                                                 }
 721                                                 if all_messages.is_empty() || all_messages.len() != steps as usize {
 722                                                         peer.sync_status = InitSyncTracker::ChannelsSyncing(0xffff_ffff_ffff_ffff);
 723                                                 }
 724                                         },
 725                                         InitSyncTracker::ChannelsSyncing(c) if c == 0xffff_ffff_ffff_ffff => {
 726                                                 let steps = (OUTBOUND_BUFFER_LIMIT_READ_PAUSE - peer.pending_outbound_buffer.len()) as u8;
 727                                                 let all_messages = self.message_handler.route_handler.get_next_node_announcements(None, steps);
 728                                                 for msg in all_messages.iter() {
 729                                                         self.enqueue_message(peer, msg);
 730                                                         peer.sync_status = InitSyncTracker::NodesSyncing(msg.contents.node_id);
 731                                                 }
 732                                                 if all_messages.is_empty() || all_messages.len() != steps as usize {
 733                                                         peer.sync_status = InitSyncTracker::NoSyncRequested;
 734                                                 }
 735                                         },
 736                                         InitSyncTracker::ChannelsSyncing(_) => unreachable!(),
 737                                         InitSyncTracker::NodesSyncing(key) => {
 738                                                 let steps = (OUTBOUND_BUFFER_LIMIT_READ_PAUSE - peer.pending_outbound_buffer.len()) as u8;
 739                                                 let all_messages = self.message_handler.route_handler.get_next_node_announcements(Some(&key), steps);
 740                                                 for msg in all_messages.iter() {
 741                                                         self.enqueue_message(peer, msg);
 742                                                         peer.sync_status = InitSyncTracker::NodesSyncing(msg.contents.node_id);
 743                                                 }
 744                                                 if all_messages.is_empty() || all_messages.len() != steps as usize {
 745                                                         peer.sync_status = InitSyncTracker::NoSyncRequested;
 746                                                 }
 747                                         },
 748                                 }
 749                         }
 750                         if peer.msgs_sent_since_pong >= BUFFER_DRAIN_MSGS_PER_TICK {
 751                                 self.maybe_send_extra_ping(peer);
 752                         }
 753
 754                         if {
 755                                 let next_buff = match peer.pending_outbound_buffer.front() {
 756                                         None => return,
 757                                         Some(buff) => buff,
 758                                 };
 759
 760                                 let should_be_reading = peer.pending_outbound_buffer.len() < OUTBOUND_BUFFER_LIMIT_READ_PAUSE;
 761                                 let pending = &next_buff[peer.pending_outbound_buffer_first_msg_offset..];
 762                                 let data_sent = descriptor.send_data(pending, should_be_reading);
 763                                 peer.pending_outbound_buffer_first_msg_offset += data_sent;
 764                                 if peer.pending_outbound_buffer_first_msg_offset == next_buff.len() { true } else { false }
 765                         } {
 766                                 peer.pending_outbound_buffer_first_msg_offset = 0;
 767                                 peer.pending_outbound_buffer.pop_front();
 768                         } else {
 769                                 peer.awaiting_write_event = true;
 770                         }
 771                 }
 772         }
 773
 774         /// Indicates that there is room to write data to the given socket descriptor.
 775         ///
 776         /// May return an Err to indicate that the connection should be closed.
 777         ///
 778         /// May call [`send_data`] on the descriptor passed in (or an equal descriptor) before
 779         /// returning. Thus, be very careful with reentrancy issues! The invariants around calling
 780         /// [`write_buffer_space_avail`] in case a write did not fully complete must still hold - be
 781         /// ready to call `[write_buffer_space_avail`] again if a write call generated here isn't
 782         /// sufficient!
 783         ///
 784         /// [`send_data`]: SocketDescriptor::send_data
 785         /// [`write_buffer_space_avail`]: PeerManager::write_buffer_space_avail
 786         pub fn write_buffer_space_avail(&self, descriptor: &mut Descriptor) -> Result<(), PeerHandleError> {
 787                 let peers = self.peers.read().unwrap();
 788                 match peers.get(descriptor) {
 789                         None => {
 790                                 // This is most likely a simple race condition where the user found that the socket
 791                                 // was writeable, then we told the user to `disconnect_socket()`, then they called
 792                                 // this method. Return an error to make sure we get disconnected.
 793                                 return Err(PeerHandleError { no_connection_possible: false });
 794                         },
 795                         Some(peer_mutex) => {
 796                                 let mut peer = peer_mutex.lock().unwrap();
 797                                 peer.awaiting_write_event = false;
 798                                 self.do_attempt_write_data(descriptor, &mut peer);
 799                         }
 800                 };
 801                 Ok(())
 802         }
 803
 804         /// Indicates that data was read from the given socket descriptor.
 805         ///
 806         /// May return an Err to indicate that the connection should be closed.
 807         ///
 808         /// Will *not* call back into [`send_data`] on any descriptors to avoid reentrancy complexity.
 809         /// Thus, however, you should call [`process_events`] after any `read_event` to generate
 810         /// [`send_data`] calls to handle responses.
 811         ///
 812         /// If `Ok(true)` is returned, further read_events should not be triggered until a
 813         /// [`send_data`] call on this descriptor has `resume_read` set (preventing DoS issues in the
 814         /// send buffer).
 815         ///
 816         /// [`send_data`]: SocketDescriptor::send_data
 817         /// [`process_events`]: PeerManager::process_events
 818         pub fn read_event(&self, peer_descriptor: &mut Descriptor, data: &[u8]) -> Result<bool, PeerHandleError> {
 819                 match self.do_read_event(peer_descriptor, data) {
 820                         Ok(res) => Ok(res),
 821                         Err(e) => {
 822                                 log_trace!(self.logger, "Peer sent invalid data or we decided to disconnect due to a protocol error");
 823                                 self.disconnect_event_internal(peer_descriptor, e.no_connection_possible);
 824                                 Err(e)
 825                         }
 826                 }
 827         }
 828
 829         /// Append a message to a peer's pending outbound/write buffer
 830         fn enqueue_encoded_message(&self, peer: &mut Peer, encoded_message: &Vec<u8>) {
 831                 peer.msgs_sent_since_pong += 1;
 832                 peer.pending_outbound_buffer.push_back(peer.channel_encryptor.encrypt_message(&encoded_message[..]));
 833         }
 834
 835         /// Append a message to a peer's pending outbound/write buffer
 836         fn enqueue_message<M: wire::Type>(&self, peer: &mut Peer, message: &M) {
 837                 let mut buffer = VecWriter(Vec::with_capacity(2048));
 838                 wire::write(message, &mut buffer).unwrap(); // crash if the write failed
 839
 840                 if is_gossip_msg(message.type_id()) {
 841                         log_gossip!(self.logger, "Enqueueing message {:?} to {}", message, log_pubkey!(peer.their_node_id.unwrap()));
 842                 } else {
 843                         log_trace!(self.logger, "Enqueueing message {:?} to {}", message, log_pubkey!(peer.their_node_id.unwrap()))
 844                 }
 845                 self.enqueue_encoded_message(peer, &buffer.0);
 846         }
 847
 848         fn do_read_event(&self, peer_descriptor: &mut Descriptor, data: &[u8]) -> Result<bool, PeerHandleError> {
 849                 let mut pause_read = false;
 850                 let peers = self.peers.read().unwrap();
 851                 let mut msgs_to_forward = Vec::new();
 852                 let mut peer_node_id = None;
 853                 match peers.get(peer_descriptor) {
 854                         None => {
 855                                 // This is most likely a simple race condition where the user read some bytes
 856                                 // from the socket, then we told the user to `disconnect_socket()`, then they
 857                                 // called this method. Return an error to make sure we get disconnected.
 858                                 return Err(PeerHandleError { no_connection_possible: false });
 859                         },
 860                         Some(peer_mutex) => {
 861                                 let mut read_pos = 0;
 862                                 while read_pos < data.len() {
 863                                         macro_rules! try_potential_handleerror {
 864                                                 ($peer: expr, $thing: expr) => {
 865                                                         match $thing {
 866                                                                 Ok(x) => x,
 867                                                                 Err(e) => {
 868                                                                         match e.action {
 869                                                                                 msgs::ErrorAction::DisconnectPeer { msg: _ } => {
 870                                                                                         //TODO: Try to push msg
 871                                                                                         log_debug!(self.logger, "Error handling message{}; disconnecting peer with: {}", OptionalFromDebugger(&peer_node_id), e.err);
 872                                                                                         return Err(PeerHandleError{ no_connection_possible: false });
 873                                                                                 },
 874                                                                                 msgs::ErrorAction::IgnoreAndLog(level) => {
 875                                                                                         log_given_level!(self.logger, level, "Error handling message{}; ignoring: {}", OptionalFromDebugger(&peer_node_id), e.err);
 876                                                                                         continue
 877                                                                                 },
 878                                                                                 msgs::ErrorAction::IgnoreDuplicateGossip => continue, // Don't even bother logging these
 879                                                                                 msgs::ErrorAction::IgnoreError => {
 880                                                                                         log_debug!(self.logger, "Error handling message{}; ignoring: {}", OptionalFromDebugger(&peer_node_id), e.err);
 881                                                                                         continue;
 882                                                                                 },
 883                                                                                 msgs::ErrorAction::SendErrorMessage { msg } => {
 884                                                                                         log_debug!(self.logger, "Error handling message{}; sending error message with: {}", OptionalFromDebugger(&peer_node_id), e.err);
 885                                                                                         self.enqueue_message($peer, &msg);
 886                                                                                         continue;
 887                                                                                 },
 888                                                                                 msgs::ErrorAction::SendWarningMessage { msg, log_level } => {
 889                                                                                         log_given_level!(self.logger, log_level, "Error handling message{}; sending warning message with: {}", OptionalFromDebugger(&peer_node_id), e.err);
 890                                                                                         self.enqueue_message($peer, &msg);
 891                                                                                         continue;
 892                                                                                 },
 893                                                                         }
 894                                                                 }
 895                                                         }
 896                                                 }
 897                                         }
 898
 899                                         let mut peer_lock = peer_mutex.lock().unwrap();
 900                                         let peer = &mut *peer_lock;
 901                                         let mut msg_to_handle = None;
 902                                         if peer_node_id.is_none() {
 903                                                 peer_node_id = peer.their_node_id.clone();
 904                                         }
 905
 906                                         assert!(peer.pending_read_buffer.len() > 0);
 907                                         assert!(peer.pending_read_buffer.len() > peer.pending_read_buffer_pos);
 908
 909                                         {
 910                                                 let data_to_copy = cmp::min(peer.pending_read_buffer.len() - peer.pending_read_buffer_pos, data.len() - read_pos);
 911                                                 peer.pending_read_buffer[peer.pending_read_buffer_pos..peer.pending_read_buffer_pos + data_to_copy].copy_from_slice(&data[read_pos..read_pos + data_to_copy]);
 912                                                 read_pos += data_to_copy;
 913                                                 peer.pending_read_buffer_pos += data_to_copy;
 914                                         }
 915
 916                                         if peer.pending_read_buffer_pos == peer.pending_read_buffer.len() {
 917                                                 peer.pending_read_buffer_pos = 0;
 918
 919                                                 macro_rules! insert_node_id {
 920                                                         () => {
 921                                                                 match self.node_id_to_descriptor.lock().unwrap().entry(peer.their_node_id.unwrap()) {
 922                                                                         hash_map::Entry::Occupied(_) => {
 923                                                                                 log_trace!(self.logger, "Got second connection with {}, closing", log_pubkey!(peer.their_node_id.unwrap()));
 924                                                                                 peer.their_node_id = None; // Unset so that we don't generate a peer_disconnected event
 925                                                                                 return Err(PeerHandleError{ no_connection_possible: false })
 926                                                                         },
 927                                                                         hash_map::Entry::Vacant(entry) => {
 928                                                                                 log_debug!(self.logger, "Finished noise handshake for connection with {}", log_pubkey!(peer.their_node_id.unwrap()));
 929                                                                                 entry.insert(peer_descriptor.clone())
 930                                                                         },
 931                                                                 };
 932                                                         }
 933                                                 }
 934
 935                                                 let next_step = peer.channel_encryptor.get_noise_step();
 936                                                 match next_step {
 937                                                         NextNoiseStep::ActOne => {
 938                                                                 let act_two = try_potential_handleerror!(peer,
 939                                                                         peer.channel_encryptor.process_act_one_with_keys(&peer.pending_read_buffer[..], &self.our_node_secret, self.get_ephemeral_key())).to_vec();
 940                                                                 peer.pending_outbound_buffer.push_back(act_two);
 941                                                                 peer.pending_read_buffer = [0; 66].to_vec(); // act three is 66 bytes long
 942                                                         },
 943                                                         NextNoiseStep::ActTwo => {
 944                                                                 let (act_three, their_node_id) = try_potential_handleerror!(peer,
 945                                                                         peer.channel_encryptor.process_act_two(&peer.pending_read_buffer[..], &self.our_node_secret));
 946                                                                 peer.pending_outbound_buffer.push_back(act_three.to_vec());
 947                                                                 peer.pending_read_buffer = [0; 18].to_vec(); // Message length header is 18 bytes
 948                                                                 peer.pending_read_is_header = true;
 949
 950                                                                 peer.their_node_id = Some(their_node_id);
 951                                                                 insert_node_id!();
 952                                                                 let features = InitFeatures::known();
 953                                                                 let resp = msgs::Init { features, remote_network_address: filter_addresses(peer.their_net_address.clone()) };
 954                                                                 self.enqueue_message(peer, &resp);
 955                                                                 peer.awaiting_pong_timer_tick_intervals = 0;
 956                                                         },
 957                                                         NextNoiseStep::ActThree => {
 958                                                                 let their_node_id = try_potential_handleerror!(peer,
 959                                                                         peer.channel_encryptor.process_act_three(&peer.pending_read_buffer[..]));
 960                                                                 peer.pending_read_buffer = [0; 18].to_vec(); // Message length header is 18 bytes
 961                                                                 peer.pending_read_is_header = true;
 962                                                                 peer.their_node_id = Some(their_node_id);
 963                                                                 insert_node_id!();
 964                                                                 let features = InitFeatures::known();
 965                                                                 let resp = msgs::Init { features, remote_network_address: filter_addresses(peer.their_net_address.clone()) };
 966                                                                 self.enqueue_message(peer, &resp);
 967                                                                 peer.awaiting_pong_timer_tick_intervals = 0;
 968                                                         },
 969                                                         NextNoiseStep::NoiseComplete => {
 970                                                                 if peer.pending_read_is_header {
 971                                                                         let msg_len = try_potential_handleerror!(peer,
 972                                                                                 peer.channel_encryptor.decrypt_length_header(&peer.pending_read_buffer[..]));
 973                                                                         if peer.pending_read_buffer.capacity() > 8192 { peer.pending_read_buffer = Vec::new(); }
 974                                                                         peer.pending_read_buffer.resize(msg_len as usize + 16, 0);
 975                                                                         if msg_len < 2 { // Need at least the message type tag
 976                                                                                 return Err(PeerHandleError{ no_connection_possible: false });
 977                                                                         }
 978                                                                         peer.pending_read_is_header = false;
 979                                                                 } else {
 980                                                                         let msg_data = try_potential_handleerror!(peer,
 981                                                                                 peer.channel_encryptor.decrypt_message(&peer.pending_read_buffer[..]));
 982                                                                         assert!(msg_data.len() >= 2);
 983
 984                                                                         // Reset read buffer
 985                                                                         if peer.pending_read_buffer.capacity() > 8192 { peer.pending_read_buffer = Vec::new(); }
 986                                                                         peer.pending_read_buffer.resize(18, 0);
 987                                                                         peer.pending_read_is_header = true;
 988
 989                                                                         let mut reader = io::Cursor::new(&msg_data[..]);
 990                                                                         let message_result = wire::read(&mut reader, &*self.custom_message_handler);
 991                                                                         let message = match message_result {
 992                                                                                 Ok(x) => x,
 993                                                                                 Err(e) => {
 994                                                                                         match e {
 995                                                                                                 // Note that to avoid recursion we never call
 996                                                                                                 // `do_attempt_write_data` from here, causing
 997                                                                                                 // the messages enqueued here to not actually
 998                                                                                                 // be sent before the peer is disconnected.
 999                                                                                                 (msgs::DecodeError::UnknownRequiredFeature, Some(ty)) if is_gossip_msg(ty) => {
1000                                                                                                         log_gossip!(self.logger, "Got a channel/node announcement with an unknown required feature flag, you may want to update!");
1001                                                                                                         continue;
1002                                                                                                 }
1003                                                                                                 (msgs::DecodeError::UnsupportedCompression, _) => {
1004                                                                                                         log_gossip!(self.logger, "We don't support zlib-compressed message fields, sending a warning and ignoring message");
1005                                                                                                         self.enqueue_message(peer, &msgs::WarningMessage { channel_id: [0; 32], data: "Unsupported message compression: zlib".to_owned() });
1006                                                                                                         continue;
1007                                                                                                 }
1008                                                                                                 (_, Some(ty)) if is_gossip_msg(ty) => {
1009                                                                                                         log_gossip!(self.logger, "Got an invalid value while deserializing a gossip message");
1010                                                                                                         self.enqueue_message(peer, &msgs::WarningMessage { channel_id: [0; 32], data: "Unreadable/bogus gossip message".to_owned() });
1011                                                                                                         continue;
1012                                                                                                 }
1013                                                                                                 (msgs::DecodeError::UnknownRequiredFeature, ty) => {
1014                                                                                                         log_gossip!(self.logger, "Received a message with an unknown required feature flag or TLV, you may want to update!");
1015                                                                                                         self.enqueue_message(peer, &msgs::WarningMessage { channel_id: [0; 32], data: format!("Received an unknown required feature/TLV in message type {:?}", ty) });
1016                                                                                                         return Err(PeerHandleError { no_connection_possible: false });
1017                                                                                                 }
1018                                                                                                 (msgs::DecodeError::UnknownVersion, _) => return Err(PeerHandleError { no_connection_possible: false }),
1019                                                                                                 (msgs::DecodeError::InvalidValue, _) => {
1020                                                                                                         log_debug!(self.logger, "Got an invalid value while deserializing message");
1021                                                                                                         return Err(PeerHandleError { no_connection_possible: false });
1022                                                                                                 }
1023                                                                                                 (msgs::DecodeError::ShortRead, _) => {
1024                                                                                                         log_debug!(self.logger, "Deserialization failed due to shortness of message");
1025                                                                                                         return Err(PeerHandleError { no_connection_possible: false });
1026                                                                                                 }
1027                                                                                                 (msgs::DecodeError::BadLengthDescriptor, _) => return Err(PeerHandleError { no_connection_possible: false }),
1028                                                                                                 (msgs::DecodeError::Io(_), _) => return Err(PeerHandleError { no_connection_possible: false }),
1029                                                                                         }
1030                                                                                 }
1031                                                                         };
1032
1033                                                                         msg_to_handle = Some(message);
1034                                                                 }
1035                                                         }
1036                                                 }
1037                                         }
1038                                         pause_read = peer.pending_outbound_buffer.len() > OUTBOUND_BUFFER_LIMIT_READ_PAUSE;
1039
1040                                         if let Some(message) = msg_to_handle {
1041                                                 match self.handle_message(&peer_mutex, peer_lock, message) {
1042                                                         Err(handling_error) => match handling_error {
1043                                                                 MessageHandlingError::PeerHandleError(e) => { return Err(e) },
1044                                                                 MessageHandlingError::LightningError(e) => {
1045                                                                         try_potential_handleerror!(&mut peer_mutex.lock().unwrap(), Err(e));
1046                                                                 },
1047                                                         },
1048                                                         Ok(Some(msg)) => {
1049                                                                 msgs_to_forward.push(msg);
1050                                                         },
1051                                                         Ok(None) => {},
1052                                                 }
1053                                         }
1054                                 }
1055                         }
1056                 }
1057
1058                 for msg in msgs_to_forward.drain(..) {
1059                         self.forward_broadcast_msg(&*peers, &msg, peer_node_id.as_ref());
1060                 }
1061
1062                 Ok(pause_read)
1063         }
1064
1065         /// Process an incoming message and return a decision (ok, lightning error, peer handling error) regarding the next action with the peer
1066         /// Returns the message back if it needs to be broadcasted to all other peers.
1067         fn handle_message(
1068                 &self,
1069                 peer_mutex: &Mutex<Peer>,
1070                 mut peer_lock: MutexGuard<Peer>,
1071                 message: wire::Message<<<CMH as core::ops::Deref>::Target as wire::CustomMessageReader>::CustomMessage>
1072         ) -> Result<Option<wire::Message<<<CMH as core::ops::Deref>::Target as wire::CustomMessageReader>::CustomMessage>>, MessageHandlingError> {
1073                 let their_node_id = peer_lock.their_node_id.clone().expect("We know the peer's public key by the time we receive messages");
1074                 peer_lock.received_message_since_timer_tick = true;
1075
1076                 // Need an Init as first message
1077                 if let wire::Message::Init(msg) = message {
1078                         if msg.features.requires_unknown_bits() {
1079                                 log_debug!(self.logger, "Peer features required unknown version bits");
1080                                 return Err(PeerHandleError{ no_connection_possible: true }.into());
1081                         }
1082                         if peer_lock.their_features.is_some() {
1083                                 return Err(PeerHandleError{ no_connection_possible: false }.into());
1084                         }
1085
1086                         log_info!(self.logger, "Received peer Init message from {}: {}", log_pubkey!(their_node_id), msg.features);
1087
1088                         // For peers not supporting gossip queries start sync now, otherwise wait until we receive a filter.
1089                         if msg.features.initial_routing_sync() && !msg.features.supports_gossip_queries() {
1090                                 peer_lock.sync_status = InitSyncTracker::ChannelsSyncing(0);
1091                         }
1092
1093                         if !msg.features.supports_static_remote_key() {
1094                                 log_debug!(self.logger, "Peer {} does not support static remote key, disconnecting with no_connection_possible", log_pubkey!(their_node_id));
1095                                 return Err(PeerHandleError{ no_connection_possible: true }.into());
1096                         }
1097
1098                         self.message_handler.route_handler.peer_connected(&their_node_id, &msg);
1099
1100                         self.message_handler.chan_handler.peer_connected(&their_node_id, &msg);
1101                         peer_lock.their_features = Some(msg.features);
1102                         return Ok(None);
1103                 } else if peer_lock.their_features.is_none() {
1104                         log_debug!(self.logger, "Peer {} sent non-Init first message", log_pubkey!(their_node_id));
1105                         return Err(PeerHandleError{ no_connection_possible: false }.into());
1106                 }
1107
1108                 if let wire::Message::GossipTimestampFilter(_msg) = message {
1109                         // When supporting gossip messages, start inital gossip sync only after we receive
1110                         // a GossipTimestampFilter
1111                         if peer_lock.their_features.as_ref().unwrap().supports_gossip_queries() &&
1112                                 !peer_lock.sent_gossip_timestamp_filter {
1113                                 peer_lock.sent_gossip_timestamp_filter = true;
1114                                 peer_lock.sync_status = InitSyncTracker::ChannelsSyncing(0);
1115                         }
1116                         return Ok(None);
1117                 }
1118
1119                 let their_features = peer_lock.their_features.clone();
1120                 mem::drop(peer_lock);
1121
1122                 if is_gossip_msg(message.type_id()) {
1123                         log_gossip!(self.logger, "Received message {:?} from {}", message, log_pubkey!(their_node_id));
1124                 } else {
1125                         log_trace!(self.logger, "Received message {:?} from {}", message, log_pubkey!(their_node_id));
1126                 }
1127
1128                 let mut should_forward = None;
1129
1130                 match message {
1131                         // Setup and Control messages:
1132                         wire::Message::Init(_) => {
1133                                 // Handled above
1134                         },
1135                         wire::Message::GossipTimestampFilter(_) => {
1136                                 // Handled above
1137                         },
1138                         wire::Message::Error(msg) => {
1139                                 let mut data_is_printable = true;
1140                                 for b in msg.data.bytes() {
1141                                         if b < 32 || b > 126 {
1142                                                 data_is_printable = false;
1143                                                 break;
1144                                         }
1145                                 }
1146
1147                                 if data_is_printable {
1148                                         log_debug!(self.logger, "Got Err message from {}: {}", log_pubkey!(their_node_id), msg.data);
1149                                 } else {
1150                                         log_debug!(self.logger, "Got Err message from {} with non-ASCII error message", log_pubkey!(their_node_id));
1151                                 }
1152                                 self.message_handler.chan_handler.handle_error(&their_node_id, &msg);
1153                                 if msg.channel_id == [0; 32] {
1154                                         return Err(PeerHandleError{ no_connection_possible: true }.into());
1155                                 }
1156                         },
1157                         wire::Message::Warning(msg) => {
1158                                 let mut data_is_printable = true;
1159                                 for b in msg.data.bytes() {
1160                                         if b < 32 || b > 126 {
1161                                                 data_is_printable = false;
1162                                                 break;
1163                                         }
1164                                 }
1165
1166                                 if data_is_printable {
1167                                         log_debug!(self.logger, "Got warning message from {}: {}", log_pubkey!(their_node_id), msg.data);
1168                                 } else {
1169                                         log_debug!(self.logger, "Got warning message from {} with non-ASCII error message", log_pubkey!(their_node_id));
1170                                 }
1171                         },
1172
1173                         wire::Message::Ping(msg) => {
1174                                 if msg.ponglen < 65532 {
1175                                         let resp = msgs::Pong { byteslen: msg.ponglen };
1176                                         self.enqueue_message(&mut *peer_mutex.lock().unwrap(), &resp);
1177                                 }
1178                         },
1179                         wire::Message::Pong(_msg) => {
1180                                 let mut peer_lock = peer_mutex.lock().unwrap();
1181                                 peer_lock.awaiting_pong_timer_tick_intervals = 0;
1182                                 peer_lock.msgs_sent_since_pong = 0;
1183                         },
1184
1185                         // Channel messages:
1186                         wire::Message::OpenChannel(msg) => {
1187                                 self.message_handler.chan_handler.handle_open_channel(&their_node_id, their_features.clone().unwrap(), &msg);
1188                         },
1189                         wire::Message::AcceptChannel(msg) => {
1190                                 self.message_handler.chan_handler.handle_accept_channel(&their_node_id, their_features.clone().unwrap(), &msg);
1191                         },
1192
1193                         wire::Message::FundingCreated(msg) => {
1194                                 self.message_handler.chan_handler.handle_funding_created(&their_node_id, &msg);
1195                         },
1196                         wire::Message::FundingSigned(msg) => {
1197                                 self.message_handler.chan_handler.handle_funding_signed(&their_node_id, &msg);
1198                         },
1199                         wire::Message::FundingLocked(msg) => {
1200                                 self.message_handler.chan_handler.handle_funding_locked(&their_node_id, &msg);
1201                         },
1202
1203                         wire::Message::Shutdown(msg) => {
1204                                 self.message_handler.chan_handler.handle_shutdown(&their_node_id, their_features.as_ref().unwrap(), &msg);
1205                         },
1206                         wire::Message::ClosingSigned(msg) => {
1207                                 self.message_handler.chan_handler.handle_closing_signed(&their_node_id, &msg);
1208                         },
1209
1210                         // Commitment messages:
1211                         wire::Message::UpdateAddHTLC(msg) => {
1212                                 self.message_handler.chan_handler.handle_update_add_htlc(&their_node_id, &msg);
1213                         },
1214                         wire::Message::UpdateFulfillHTLC(msg) => {
1215                                 self.message_handler.chan_handler.handle_update_fulfill_htlc(&their_node_id, &msg);
1216                         },
1217                         wire::Message::UpdateFailHTLC(msg) => {
1218                                 self.message_handler.chan_handler.handle_update_fail_htlc(&their_node_id, &msg);
1219                         },
1220                         wire::Message::UpdateFailMalformedHTLC(msg) => {
1221                                 self.message_handler.chan_handler.handle_update_fail_malformed_htlc(&their_node_id, &msg);
1222                         },
1223
1224                         wire::Message::CommitmentSigned(msg) => {
1225                                 self.message_handler.chan_handler.handle_commitment_signed(&their_node_id, &msg);
1226                         },
1227                         wire::Message::RevokeAndACK(msg) => {
1228                                 self.message_handler.chan_handler.handle_revoke_and_ack(&their_node_id, &msg);
1229                         },
1230                         wire::Message::UpdateFee(msg) => {
1231                                 self.message_handler.chan_handler.handle_update_fee(&their_node_id, &msg);
1232                         },
1233                         wire::Message::ChannelReestablish(msg) => {
1234                                 self.message_handler.chan_handler.handle_channel_reestablish(&their_node_id, &msg);
1235                         },
1236
1237                         // Routing messages:
1238                         wire::Message::AnnouncementSignatures(msg) => {
1239                                 self.message_handler.chan_handler.handle_announcement_signatures(&their_node_id, &msg);
1240                         },
1241                         wire::Message::ChannelAnnouncement(msg) => {
1242                                 if self.message_handler.route_handler.handle_channel_announcement(&msg)
1243                                                 .map_err(|e| -> MessageHandlingError { e.into() })? {
1244                                         should_forward = Some(wire::Message::ChannelAnnouncement(msg));
1245                                 }
1246                         },
1247                         wire::Message::NodeAnnouncement(msg) => {
1248                                 if self.message_handler.route_handler.handle_node_announcement(&msg)
1249                                                 .map_err(|e| -> MessageHandlingError { e.into() })? {
1250                                         should_forward = Some(wire::Message::NodeAnnouncement(msg));
1251                                 }
1252                         },
1253                         wire::Message::ChannelUpdate(msg) => {
1254                                 self.message_handler.chan_handler.handle_channel_update(&their_node_id, &msg);
1255                                 if self.message_handler.route_handler.handle_channel_update(&msg)
1256                                                 .map_err(|e| -> MessageHandlingError { e.into() })? {
1257                                         should_forward = Some(wire::Message::ChannelUpdate(msg));
1258                                 }
1259                         },
1260                         wire::Message::QueryShortChannelIds(msg) => {
1261                                 self.message_handler.route_handler.handle_query_short_channel_ids(&their_node_id, msg)?;
1262                         },
1263                         wire::Message::ReplyShortChannelIdsEnd(msg) => {
1264                                 self.message_handler.route_handler.handle_reply_short_channel_ids_end(&their_node_id, msg)?;
1265                         },
1266                         wire::Message::QueryChannelRange(msg) => {
1267                                 self.message_handler.route_handler.handle_query_channel_range(&their_node_id, msg)?;
1268                         },
1269                         wire::Message::ReplyChannelRange(msg) => {
1270                                 self.message_handler.route_handler.handle_reply_channel_range(&their_node_id, msg)?;
1271                         },
1272
1273                         // Unknown messages:
1274                         wire::Message::Unknown(type_id) if message.is_even() => {
1275                                 log_debug!(self.logger, "Received unknown even message of type {}, disconnecting peer!", type_id);
1276                                 // Fail the channel if message is an even, unknown type as per BOLT #1.
1277                                 return Err(PeerHandleError{ no_connection_possible: true }.into());
1278                         },
1279                         wire::Message::Unknown(type_id) => {
1280                                 log_trace!(self.logger, "Received unknown odd message of type {}, ignoring", type_id);
1281                         },
1282                         wire::Message::Custom(custom) => {
1283                                 self.custom_message_handler.handle_custom_message(custom, &their_node_id)?;
1284                         },
1285                 };
1286                 Ok(should_forward)
1287         }
1288
1289         fn forward_broadcast_msg(&self, peers: &HashMap<Descriptor, Mutex<Peer>>, msg: &wire::Message<<<CMH as core::ops::Deref>::Target as wire::CustomMessageReader>::CustomMessage>, except_node: Option<&PublicKey>) {
1290                 match msg {
1291                         wire::Message::ChannelAnnouncement(ref msg) => {
1292                                 log_gossip!(self.logger, "Sending message to all peers except {:?} or the announced channel's counterparties: {:?}", except_node, msg);
1293                                 let encoded_msg = encode_msg!(msg);
1294
1295                                 for (_, peer_mutex) in peers.iter() {
1296                                         let mut peer = peer_mutex.lock().unwrap();
1297                                         if !peer.channel_encryptor.is_ready_for_encryption() || peer.their_features.is_none() ||
1298                                                         !peer.should_forward_channel_announcement(msg.contents.short_channel_id) {
1299                                                 continue
1300                                         }
1301                                         if peer.pending_outbound_buffer.len() > OUTBOUND_BUFFER_LIMIT_DROP_GOSSIP
1302                                                 || peer.msgs_sent_since_pong > BUFFER_DRAIN_MSGS_PER_TICK * FORWARD_INIT_SYNC_BUFFER_LIMIT_RATIO
1303                                         {
1304                                                 log_gossip!(self.logger, "Skipping broadcast message to {:?} as its outbound buffer is full", peer.their_node_id);
1305                                                 continue;
1306                                         }
1307                                         if peer.their_node_id.as_ref() == Some(&msg.contents.node_id_1) ||
1308                                            peer.their_node_id.as_ref() == Some(&msg.contents.node_id_2) {
1309                                                 continue;
1310                                         }
1311                                         if except_node.is_some() && peer.their_node_id.as_ref() == except_node {
1312                                                 continue;
1313                                         }
1314                                         self.enqueue_encoded_message(&mut *peer, &encoded_msg);
1315                                 }
1316                         },
1317                         wire::Message::NodeAnnouncement(ref msg) => {
1318                                 log_gossip!(self.logger, "Sending message to all peers except {:?} or the announced node: {:?}", except_node, msg);
1319                                 let encoded_msg = encode_msg!(msg);
1320
1321                                 for (_, peer_mutex) in peers.iter() {
1322                                         let mut peer = peer_mutex.lock().unwrap();
1323                                         if !peer.channel_encryptor.is_ready_for_encryption() || peer.their_features.is_none() ||
1324                                                         !peer.should_forward_node_announcement(msg.contents.node_id) {
1325                                                 continue
1326                                         }
1327                                         if peer.pending_outbound_buffer.len() > OUTBOUND_BUFFER_LIMIT_DROP_GOSSIP
1328                                                 || peer.msgs_sent_since_pong > BUFFER_DRAIN_MSGS_PER_TICK * FORWARD_INIT_SYNC_BUFFER_LIMIT_RATIO
1329                                         {
1330                                                 log_gossip!(self.logger, "Skipping broadcast message to {:?} as its outbound buffer is full", peer.their_node_id);
1331                                                 continue;
1332                                         }
1333                                         if peer.their_node_id.as_ref() == Some(&msg.contents.node_id) {
1334                                                 continue;
1335                                         }
1336                                         if except_node.is_some() && peer.their_node_id.as_ref() == except_node {
1337                                                 continue;
1338                                         }
1339                                         self.enqueue_encoded_message(&mut *peer, &encoded_msg);
1340                                 }
1341                         },
1342                         wire::Message::ChannelUpdate(ref msg) => {
1343                                 log_gossip!(self.logger, "Sending message to all peers except {:?}: {:?}", except_node, msg);
1344                                 let encoded_msg = encode_msg!(msg);
1345
1346                                 for (_, peer_mutex) in peers.iter() {
1347                                         let mut peer = peer_mutex.lock().unwrap();
1348                                         if !peer.channel_encryptor.is_ready_for_encryption() || peer.their_features.is_none() ||
1349                                                         !peer.should_forward_channel_announcement(msg.contents.short_channel_id)  {
1350                                                 continue
1351                                         }
1352                                         if peer.pending_outbound_buffer.len() > OUTBOUND_BUFFER_LIMIT_DROP_GOSSIP
1353                                                 || peer.msgs_sent_since_pong > BUFFER_DRAIN_MSGS_PER_TICK * FORWARD_INIT_SYNC_BUFFER_LIMIT_RATIO
1354                                         {
1355                                                 log_gossip!(self.logger, "Skipping broadcast message to {:?} as its outbound buffer is full", peer.their_node_id);
1356                                                 continue;
1357                                         }
1358                                         if except_node.is_some() && peer.their_node_id.as_ref() == except_node {
1359                                                 continue;
1360                                         }
1361                                         self.enqueue_encoded_message(&mut *peer, &encoded_msg);
1362                                 }
1363                         },
1364                         _ => debug_assert!(false, "We shouldn't attempt to forward anything but gossip messages"),
1365                 }
1366         }
1367
1368         /// Checks for any events generated by our handlers and processes them. Includes sending most
1369         /// response messages as well as messages generated by calls to handler functions directly (eg
1370         /// functions like [`ChannelManager::process_pending_htlc_forwards`] or [`send_payment`]).
1371         ///
1372         /// May call [`send_data`] on [`SocketDescriptor`]s. Thus, be very careful with reentrancy
1373         /// issues!
1374         ///
1375         /// You don't have to call this function explicitly if you are using [`lightning-net-tokio`]
1376         /// or one of the other clients provided in our language bindings.
1377         ///
1378         /// Note that if there are any other calls to this function waiting on lock(s) this may return
1379         /// without doing any work. All available events that need handling will be handled before the
1380         /// other calls return.
1381         ///
1382         /// [`send_payment`]: crate::ln::channelmanager::ChannelManager::send_payment
1383         /// [`ChannelManager::process_pending_htlc_forwards`]: crate::ln::channelmanager::ChannelManager::process_pending_htlc_forwards
1384         /// [`send_data`]: SocketDescriptor::send_data
1385         pub fn process_events(&self) {
1386                 let mut _single_processor_lock = self.event_processing_lock.try_lock();
1387                 if _single_processor_lock.is_err() {
1388                         // While we could wake the older sleeper here with a CV and make more even waiting
1389                         // times, that would be a lot of overengineering for a simple "reduce total waiter
1390                         // count" goal.
1391                         match self.blocked_event_processors.compare_exchange(false, true, Ordering::AcqRel, Ordering::Acquire) {
1392                                 Err(val) => {
1393                                         debug_assert!(val, "compare_exchange failed spuriously?");
1394                                         return;
1395                                 },
1396                                 Ok(val) => {
1397                                         debug_assert!(!val, "compare_exchange succeeded spuriously?");
1398                                         // We're the only waiter, as the running process_events may have emptied the
1399                                         // pending events "long" ago and there are new events for us to process, wait until
1400                                         // its done and process any leftover events before returning.
1401                                         _single_processor_lock = Ok(self.event_processing_lock.lock().unwrap());
1402                                         self.blocked_event_processors.store(false, Ordering::Release);
1403                                 }
1404                         }
1405                 }
1406
1407                 let mut peers_to_disconnect = HashMap::new();
1408                 let mut events_generated = self.message_handler.chan_handler.get_and_clear_pending_msg_events();
1409                 events_generated.append(&mut self.message_handler.route_handler.get_and_clear_pending_msg_events());
1410
1411                 {
1412                         // TODO: There are some DoS attacks here where you can flood someone's outbound send
1413                         // buffer by doing things like announcing channels on another node. We should be willing to
1414                         // drop optional-ish messages when send buffers get full!
1415
1416                         let peers_lock = self.peers.read().unwrap();
1417                         let peers = &*peers_lock;
1418                         macro_rules! get_peer_for_forwarding {
1419                                 ($node_id: expr) => {
1420                                         {
1421                                                 if peers_to_disconnect.get($node_id).is_some() {
1422                                                         // If we've "disconnected" this peer, do not send to it.
1423                                                         continue;
1424                                                 }
1425                                                 let descriptor_opt = self.node_id_to_descriptor.lock().unwrap().get($node_id).cloned();
1426                                                 match descriptor_opt {
1427                                                         Some(descriptor) => match peers.get(&descriptor) {
1428                                                                 Some(peer_mutex) => {
1429                                                                         let peer_lock = peer_mutex.lock().unwrap();
1430                                                                         if peer_lock.their_features.is_none() {
1431                                                                                 continue;
1432                                                                         }
1433                                                                         peer_lock
1434                                                                 },
1435                                                                 None => {
1436                                                                         debug_assert!(false, "Inconsistent peers set state!");
1437                                                                         continue;
1438                                                                 }
1439                                                         },
1440                                                         None => {
1441                                                                 continue;
1442                                                         },
1443                                                 }
1444                                         }
1445                                 }
1446                         }
1447                         for event in events_generated.drain(..) {
1448                                 match event {
1449                                         MessageSendEvent::SendAcceptChannel { ref node_id, ref msg } => {
1450                                                 log_debug!(self.logger, "Handling SendAcceptChannel event in peer_handler for node {} for channel {}",
1451                                                                 log_pubkey!(node_id),
1452                                                                 log_bytes!(msg.temporary_channel_id));
1453                                                 self.enqueue_message(&mut *get_peer_for_forwarding!(node_id), msg);
1454                                         },
1455                                         MessageSendEvent::SendOpenChannel { ref node_id, ref msg } => {
1456                                                 log_debug!(self.logger, "Handling SendOpenChannel event in peer_handler for node {} for channel {}",
1457                                                                 log_pubkey!(node_id),
1458                                                                 log_bytes!(msg.temporary_channel_id));
1459                                                 self.enqueue_message(&mut *get_peer_for_forwarding!(node_id), msg);
1460                                         },
1461                                         MessageSendEvent::SendFundingCreated { ref node_id, ref msg } => {
1462                                                 log_debug!(self.logger, "Handling SendFundingCreated event in peer_handler for node {} for channel {} (which becomes {})",
1463                                                                 log_pubkey!(node_id),
1464                                                                 log_bytes!(msg.temporary_channel_id),
1465                                                                 log_funding_channel_id!(msg.funding_txid, msg.funding_output_index));
1466                                                 // TODO: If the peer is gone we should generate a DiscardFunding event
1467                                                 // indicating to the wallet that they should just throw away this funding transaction
1468                                                 self.enqueue_message(&mut *get_peer_for_forwarding!(node_id), msg);
1469                                         },
1470                                         MessageSendEvent::SendFundingSigned { ref node_id, ref msg } => {
1471                                                 log_debug!(self.logger, "Handling SendFundingSigned event in peer_handler for node {} for channel {}",
1472                                                                 log_pubkey!(node_id),
1473                                                                 log_bytes!(msg.channel_id));
1474                                                 self.enqueue_message(&mut *get_peer_for_forwarding!(node_id), msg);
1475                                         },
1476                                         MessageSendEvent::SendFundingLocked { ref node_id, ref msg } => {
1477                                                 log_debug!(self.logger, "Handling SendFundingLocked event in peer_handler for node {} for channel {}",
1478                                                                 log_pubkey!(node_id),
1479                                                                 log_bytes!(msg.channel_id));
1480                                                 self.enqueue_message(&mut *get_peer_for_forwarding!(node_id), msg);
1481                                         },
1482                                         MessageSendEvent::SendAnnouncementSignatures { ref node_id, ref msg } => {
1483                                                 log_debug!(self.logger, "Handling SendAnnouncementSignatures event in peer_handler for node {} for channel {})",
1484                                                                 log_pubkey!(node_id),
1485                                                                 log_bytes!(msg.channel_id));
1486                                                 self.enqueue_message(&mut *get_peer_for_forwarding!(node_id), msg);
1487                                         },
1488                                         MessageSendEvent::UpdateHTLCs { ref node_id, updates: msgs::CommitmentUpdate { ref update_add_htlcs, ref update_fulfill_htlcs, ref update_fail_htlcs, ref update_fail_malformed_htlcs, ref update_fee, ref commitment_signed } } => {
1489                                                 log_debug!(self.logger, "Handling UpdateHTLCs event in peer_handler for node {} with {} adds, {} fulfills, {} fails for channel {}",
1490                                                                 log_pubkey!(node_id),
1491                                                                 update_add_htlcs.len(),
1492                                                                 update_fulfill_htlcs.len(),
1493                                                                 update_fail_htlcs.len(),
1494                                                                 log_bytes!(commitment_signed.channel_id));
1495                                                 let mut peer = get_peer_for_forwarding!(node_id);
1496                                                 for msg in update_add_htlcs {
1497                                                         self.enqueue_message(&mut *peer, msg);
1498                                                 }
1499                                                 for msg in update_fulfill_htlcs {
1500                                                         self.enqueue_message(&mut *peer, msg);
1501                                                 }
1502                                                 for msg in update_fail_htlcs {
1503                                                         self.enqueue_message(&mut *peer, msg);
1504                                                 }
1505                                                 for msg in update_fail_malformed_htlcs {
1506                                                         self.enqueue_message(&mut *peer, msg);
1507                                                 }
1508                                                 if let &Some(ref msg) = update_fee {
1509                                                         self.enqueue_message(&mut *peer, msg);
1510                                                 }
1511                                                 self.enqueue_message(&mut *peer, commitment_signed);
1512                                         },
1513                                         MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
1514                                                 log_debug!(self.logger, "Handling SendRevokeAndACK event in peer_handler for node {} for channel {}",
1515                                                                 log_pubkey!(node_id),
1516                                                                 log_bytes!(msg.channel_id));
1517                                                 self.enqueue_message(&mut *get_peer_for_forwarding!(node_id), msg);
1518                                         },
1519                                         MessageSendEvent::SendClosingSigned { ref node_id, ref msg } => {
1520                                                 log_debug!(self.logger, "Handling SendClosingSigned event in peer_handler for node {} for channel {}",
1521                                                                 log_pubkey!(node_id),
1522                                                                 log_bytes!(msg.channel_id));
1523                                                 self.enqueue_message(&mut *get_peer_for_forwarding!(node_id), msg);
1524                                         },
1525                                         MessageSendEvent::SendShutdown { ref node_id, ref msg } => {
1526                                                 log_debug!(self.logger, "Handling Shutdown event in peer_handler for node {} for channel {}",
1527                                                                 log_pubkey!(node_id),
1528                                                                 log_bytes!(msg.channel_id));
1529                                                 self.enqueue_message(&mut *get_peer_for_forwarding!(node_id), msg);
1530                                         },
1531                                         MessageSendEvent::SendChannelReestablish { ref node_id, ref msg } => {
1532                                                 log_debug!(self.logger, "Handling SendChannelReestablish event in peer_handler for node {} for channel {}",
1533                                                                 log_pubkey!(node_id),
1534                                                                 log_bytes!(msg.channel_id));
1535                                                 self.enqueue_message(&mut *get_peer_for_forwarding!(node_id), msg);
1536                                         },
1537                                         MessageSendEvent::BroadcastChannelAnnouncement { msg, update_msg } => {
1538                                                 log_debug!(self.logger, "Handling BroadcastChannelAnnouncement event in peer_handler for short channel id {}", msg.contents.short_channel_id);
1539                                                 match self.message_handler.route_handler.handle_channel_announcement(&msg) {
1540                                                         Ok(_) | Err(LightningError { action: msgs::ErrorAction::IgnoreDuplicateGossip, .. }) =>
1541                                                                 self.forward_broadcast_msg(peers, &wire::Message::ChannelAnnouncement(msg), None),
1542                                                         _ => {},
1543                                                 }
1544                                                 match self.message_handler.route_handler.handle_channel_update(&update_msg) {
1545                                                         Ok(_) | Err(LightningError { action: msgs::ErrorAction::IgnoreDuplicateGossip, .. }) =>
1546                                                                 self.forward_broadcast_msg(peers, &wire::Message::ChannelUpdate(update_msg), None),
1547                                                         _ => {},
1548                                                 }
1549                                         },
1550                                         MessageSendEvent::BroadcastNodeAnnouncement { msg } => {
1551                                                 log_debug!(self.logger, "Handling BroadcastNodeAnnouncement event in peer_handler");
1552                                                 match self.message_handler.route_handler.handle_node_announcement(&msg) {
1553                                                         Ok(_) | Err(LightningError { action: msgs::ErrorAction::IgnoreDuplicateGossip, .. }) =>
1554                                                                 self.forward_broadcast_msg(peers, &wire::Message::NodeAnnouncement(msg), None),
1555                                                         _ => {},
1556                                                 }
1557                                         },
1558                                         MessageSendEvent::BroadcastChannelUpdate { msg } => {
1559                                                 log_debug!(self.logger, "Handling BroadcastChannelUpdate event in peer_handler for short channel id {}", msg.contents.short_channel_id);
1560                                                 match self.message_handler.route_handler.handle_channel_update(&msg) {
1561                                                         Ok(_) | Err(LightningError { action: msgs::ErrorAction::IgnoreDuplicateGossip, .. }) =>
1562                                                                 self.forward_broadcast_msg(peers, &wire::Message::ChannelUpdate(msg), None),
1563                                                         _ => {},
1564                                                 }
1565                                         },
1566                                         MessageSendEvent::SendChannelUpdate { ref node_id, ref msg } => {
1567                                                 log_trace!(self.logger, "Handling SendChannelUpdate event in peer_handler for node {} for channel {}",
1568                                                                 log_pubkey!(node_id), msg.contents.short_channel_id);
1569                                                 self.enqueue_message(&mut *get_peer_for_forwarding!(node_id), msg);
1570                                         },
1571                                         MessageSendEvent::HandleError { ref node_id, ref action } => {
1572                                                 match *action {
1573                                                         msgs::ErrorAction::DisconnectPeer { ref msg } => {
1574                                                                 // We do not have the peers write lock, so we just store that we're
1575                                                                 // about to disconenct the peer and do it after we finish
1576                                                                 // processing most messages.
1577                                                                 peers_to_disconnect.insert(*node_id, msg.clone());
1578                                                         },
1579                                                         msgs::ErrorAction::IgnoreAndLog(level) => {
1580                                                                 log_given_level!(self.logger, level, "Received a HandleError event to be ignored for node {}", log_pubkey!(node_id));
1581                                                         },
1582                                                         msgs::ErrorAction::IgnoreDuplicateGossip => {},
1583                                                         msgs::ErrorAction::IgnoreError => {
1584                                                                 log_debug!(self.logger, "Received a HandleError event to be ignored for node {}", log_pubkey!(node_id));
1585                                                         },
1586                                                         msgs::ErrorAction::SendErrorMessage { ref msg } => {
1587                                                                 log_trace!(self.logger, "Handling SendErrorMessage HandleError event in peer_handler for node {} with message {}",
1588                                                                                 log_pubkey!(node_id),
1589                                                                                 msg.data);
1590                                                                 self.enqueue_message(&mut *get_peer_for_forwarding!(node_id), msg);
1591                                                         },
1592                                                         msgs::ErrorAction::SendWarningMessage { ref msg, ref log_level } => {
1593                                                                 log_given_level!(self.logger, *log_level, "Handling SendWarningMessage HandleError event in peer_handler for node {} with message {}",
1594                                                                                 log_pubkey!(node_id),
1595                                                                                 msg.data);
1596                                                                 self.enqueue_message(&mut *get_peer_for_forwarding!(node_id), msg);
1597                                                         },
1598                                                 }
1599                                         },
1600                                         MessageSendEvent::SendChannelRangeQuery { ref node_id, ref msg } => {
1601                                                 self.enqueue_message(&mut *get_peer_for_forwarding!(node_id), msg);
1602                                         },
1603                                         MessageSendEvent::SendShortIdsQuery { ref node_id, ref msg } => {
1604                                                 self.enqueue_message(&mut *get_peer_for_forwarding!(node_id), msg);
1605                                         }
1606                                         MessageSendEvent::SendReplyChannelRange { ref node_id, ref msg } => {
1607                                                 log_gossip!(self.logger, "Handling SendReplyChannelRange event in peer_handler for node {} with num_scids={} first_blocknum={} number_of_blocks={}, sync_complete={}",
1608                                                         log_pubkey!(node_id),
1609                                                         msg.short_channel_ids.len(),
1610                                                         msg.first_blocknum,
1611                                                         msg.number_of_blocks,
1612                                                         msg.sync_complete);
1613                                                 self.enqueue_message(&mut *get_peer_for_forwarding!(node_id), msg);
1614                                         }
1615                                         MessageSendEvent::SendGossipTimestampFilter { ref node_id, ref msg } => {
1616                                                 self.enqueue_message(&mut *get_peer_for_forwarding!(node_id), msg);
1617                                         }
1618                                 }
1619                         }
1620
1621                         for (node_id, msg) in self.custom_message_handler.get_and_clear_pending_msg() {
1622                                 if peers_to_disconnect.get(&node_id).is_some() { continue; }
1623                                 self.enqueue_message(&mut *get_peer_for_forwarding!(&node_id), &msg);
1624                         }
1625
1626                         for (descriptor, peer_mutex) in peers.iter() {
1627                                 self.do_attempt_write_data(&mut (*descriptor).clone(), &mut *peer_mutex.lock().unwrap());
1628                         }
1629                 }
1630                 if !peers_to_disconnect.is_empty() {
1631                         let mut peers_lock = self.peers.write().unwrap();
1632                         let peers = &mut *peers_lock;
1633                         for (node_id, msg) in peers_to_disconnect.drain() {
1634                                 // Note that since we are holding the peers *write* lock we can
1635                                 // remove from node_id_to_descriptor immediately (as no other
1636                                 // thread can be holding the peer lock if we have the global write
1637                                 // lock).
1638
1639                                 if let Some(mut descriptor) = self.node_id_to_descriptor.lock().unwrap().remove(&node_id) {
1640                                         if let Some(peer_mutex) = peers.remove(&descriptor) {
1641                                                 if let Some(msg) = msg {
1642                                                         log_trace!(self.logger, "Handling DisconnectPeer HandleError event in peer_handler for node {} with message {}",
1643                                                                         log_pubkey!(node_id),
1644                                                                         msg.data);
1645                                                         let mut peer = peer_mutex.lock().unwrap();
1646                                                         self.enqueue_message(&mut *peer, &msg);
1647                                                         // This isn't guaranteed to work, but if there is enough free
1648                                                         // room in the send buffer, put the error message there...
1649                                                         self.do_attempt_write_data(&mut descriptor, &mut *peer);
1650                                                 } else {
1651                                                         log_trace!(self.logger, "Handling DisconnectPeer HandleError event in peer_handler for node {} with no message", log_pubkey!(node_id));
1652                                                 }
1653                                         }
1654                                         descriptor.disconnect_socket();
1655                                         self.message_handler.chan_handler.peer_disconnected(&node_id, false);
1656                                 }
1657                         }
1658                 }
1659         }
1660
1661         /// Indicates that the given socket descriptor's connection is now closed.
1662         pub fn socket_disconnected(&self, descriptor: &Descriptor) {
1663                 self.disconnect_event_internal(descriptor, false);
1664         }
1665
1666         fn disconnect_event_internal(&self, descriptor: &Descriptor, no_connection_possible: bool) {
1667                 let mut peers = self.peers.write().unwrap();
1668                 let peer_option = peers.remove(descriptor);
1669                 match peer_option {
1670                         None => {
1671                                 // This is most likely a simple race condition where the user found that the socket
1672                                 // was disconnected, then we told the user to `disconnect_socket()`, then they
1673                                 // called this method. Either way we're disconnected, return.
1674                         },
1675                         Some(peer_lock) => {
1676                                 let peer = peer_lock.lock().unwrap();
1677                                 if let Some(node_id) = peer.their_node_id {
1678                                         log_trace!(self.logger,
1679                                                 "Handling disconnection of peer {}, with {}future connection to the peer possible.",
1680                                                 log_pubkey!(node_id), if no_connection_possible { "no " } else { "" });
1681                                         self.node_id_to_descriptor.lock().unwrap().remove(&node_id);
1682                                         self.message_handler.chan_handler.peer_disconnected(&node_id, no_connection_possible);
1683                                 }
1684                         }
1685                 };
1686         }
1687
1688         /// Disconnect a peer given its node id.
1689         ///
1690         /// Set `no_connection_possible` to true to prevent any further connection with this peer,
1691         /// force-closing any channels we have with it.
1692         ///
1693         /// If a peer is connected, this will call [`disconnect_socket`] on the descriptor for the
1694         /// peer. Thus, be very careful about reentrancy issues.
1695         ///
1696         /// [`disconnect_socket`]: SocketDescriptor::disconnect_socket
1697         pub fn disconnect_by_node_id(&self, node_id: PublicKey, no_connection_possible: bool) {
1698                 let mut peers_lock = self.peers.write().unwrap();
1699                 if let Some(mut descriptor) = self.node_id_to_descriptor.lock().unwrap().remove(&node_id) {
1700                         log_trace!(self.logger, "Disconnecting peer with id {} due to client request", node_id);
1701                         peers_lock.remove(&descriptor);
1702                         self.message_handler.chan_handler.peer_disconnected(&node_id, no_connection_possible);
1703                         descriptor.disconnect_socket();
1704                 }
1705         }
1706
1707         /// Disconnects all currently-connected peers. This is useful on platforms where there may be
1708         /// an indication that TCP sockets have stalled even if we weren't around to time them out
1709         /// using regular ping/pongs.
1710         pub fn disconnect_all_peers(&self) {
1711                 let mut peers_lock = self.peers.write().unwrap();
1712                 self.node_id_to_descriptor.lock().unwrap().clear();
1713                 let peers = &mut *peers_lock;
1714                 for (mut descriptor, peer) in peers.drain() {
1715                         if let Some(node_id) = peer.lock().unwrap().their_node_id {
1716                                 log_trace!(self.logger, "Disconnecting peer with id {} due to client request to disconnect all peers", node_id);
1717                                 self.message_handler.chan_handler.peer_disconnected(&node_id, false);
1718                         }
1719                         descriptor.disconnect_socket();
1720                 }
1721         }
1722
1723         /// This is called when we're blocked on sending additional gossip messages until we receive a
1724         /// pong. If we aren't waiting on a pong, we take this opportunity to send a ping (setting
1725         /// `awaiting_pong_timer_tick_intervals` to a special flag value to indicate this).
1726         fn maybe_send_extra_ping(&self, peer: &mut Peer) {
1727                 if peer.awaiting_pong_timer_tick_intervals == 0 {
1728                         peer.awaiting_pong_timer_tick_intervals = -1;
1729                         let ping = msgs::Ping {
1730                                 ponglen: 0,
1731                                 byteslen: 64,
1732                         };
1733                         self.enqueue_message(peer, &ping);
1734                 }
1735         }
1736
1737         /// Send pings to each peer and disconnect those which did not respond to the last round of
1738         /// pings.
1739         ///
1740         /// This may be called on any timescale you want, however, roughly once every ten seconds is
1741         /// preferred. The call rate determines both how often we send a ping to our peers and how much
1742         /// time they have to respond before we disconnect them.
1743         ///
1744         /// May call [`send_data`] on all [`SocketDescriptor`]s. Thus, be very careful with reentrancy
1745         /// issues!
1746         ///
1747         /// [`send_data`]: SocketDescriptor::send_data
1748         pub fn timer_tick_occurred(&self) {
1749                 let mut descriptors_needing_disconnect = Vec::new();
1750                 {
1751                         let peers_lock = self.peers.read().unwrap();
1752
1753                         for (descriptor, peer_mutex) in peers_lock.iter() {
1754                                 let mut peer = peer_mutex.lock().unwrap();
1755                                 if !peer.channel_encryptor.is_ready_for_encryption() || peer.their_node_id.is_none() {
1756                                         // The peer needs to complete its handshake before we can exchange messages. We
1757                                         // give peers one timer tick to complete handshake, reusing
1758                                         // `awaiting_pong_timer_tick_intervals` to track number of timer ticks taken
1759                                         // for handshake completion.
1760                                         if peer.awaiting_pong_timer_tick_intervals != 0 {
1761                                                 descriptors_needing_disconnect.push(descriptor.clone());
1762                                         } else {
1763                                                 peer.awaiting_pong_timer_tick_intervals = 1;
1764                                         }
1765                                         continue;
1766                                 }
1767
1768                                 if peer.awaiting_pong_timer_tick_intervals == -1 {
1769                                         // Magic value set in `maybe_send_extra_ping`.
1770                                         peer.awaiting_pong_timer_tick_intervals = 1;
1771                                         peer.received_message_since_timer_tick = false;
1772                                         continue;
1773                                 }
1774
1775                                 if (peer.awaiting_pong_timer_tick_intervals > 0 && !peer.received_message_since_timer_tick)
1776                                         || peer.awaiting_pong_timer_tick_intervals as u64 >
1777                                                 MAX_BUFFER_DRAIN_TICK_INTERVALS_PER_PEER as u64 * peers_lock.len() as u64
1778                                 {
1779                                         descriptors_needing_disconnect.push(descriptor.clone());
1780                                         continue;
1781                                 }
1782                                 peer.received_message_since_timer_tick = false;
1783
1784                                 if peer.awaiting_pong_timer_tick_intervals > 0 {
1785                                         peer.awaiting_pong_timer_tick_intervals += 1;
1786                                         continue;
1787                                 }
1788
1789                                 peer.awaiting_pong_timer_tick_intervals = 1;
1790                                 let ping = msgs::Ping {
1791                                         ponglen: 0,
1792                                         byteslen: 64,
1793                                 };
1794                                 self.enqueue_message(&mut *peer, &ping);
1795                                 self.do_attempt_write_data(&mut (descriptor.clone()), &mut *peer);
1796                         }
1797                 }
1798
1799                 if !descriptors_needing_disconnect.is_empty() {
1800                         {
1801                                 let mut peers_lock = self.peers.write().unwrap();
1802                                 for descriptor in descriptors_needing_disconnect.iter() {
1803                                         if let Some(peer) = peers_lock.remove(descriptor) {
1804                                                 if let Some(node_id) = peer.lock().unwrap().their_node_id {
1805                                                         log_trace!(self.logger, "Disconnecting peer with id {} due to ping timeout", node_id);
1806                                                         self.node_id_to_descriptor.lock().unwrap().remove(&node_id);
1807                                                         self.message_handler.chan_handler.peer_disconnected(&node_id, false);
1808                                                 }
1809                                         }
1810                                 }
1811                         }
1812
1813                         for mut descriptor in descriptors_needing_disconnect.drain(..) {
1814                                 descriptor.disconnect_socket();
1815                         }
1816                 }
1817         }
1818 }
1819
1820 fn is_gossip_msg(type_id: u16) -> bool {
1821         match type_id {
1822                 msgs::ChannelAnnouncement::TYPE |
1823                 msgs::ChannelUpdate::TYPE |
1824                 msgs::NodeAnnouncement::TYPE |
1825                 msgs::QueryChannelRange::TYPE |
1826                 msgs::ReplyChannelRange::TYPE |
1827                 msgs::QueryShortChannelIds::TYPE |
1828                 msgs::ReplyShortChannelIdsEnd::TYPE => true,
1829                 _ => false
1830         }
1831 }
1832
1833 #[cfg(test)]
1834 mod tests {
1835         use ln::peer_handler::{PeerManager, MessageHandler, SocketDescriptor, IgnoringMessageHandler, filter_addresses};
1836         use ln::msgs;
1837         use ln::msgs::NetAddress;
1838         use util::events;
1839         use util::test_utils;
1840
1841         use bitcoin::secp256k1::Secp256k1;
1842         use bitcoin::secp256k1::key::{SecretKey, PublicKey};
1843
1844         use prelude::*;
1845         use sync::{Arc, Mutex};
1846         use core::sync::atomic::Ordering;
1847
1848         #[derive(Clone)]
1849         struct FileDescriptor {
1850                 fd: u16,
1851                 outbound_data: Arc<Mutex<Vec<u8>>>,
1852         }
1853         impl PartialEq for FileDescriptor {
1854                 fn eq(&self, other: &Self) -> bool {
1855                         self.fd == other.fd
1856                 }
1857         }
1858         impl Eq for FileDescriptor { }
1859         impl core::hash::Hash for FileDescriptor {
1860                 fn hash<H: core::hash::Hasher>(&self, hasher: &mut H) {
1861                         self.fd.hash(hasher)
1862                 }
1863         }
1864
1865         impl SocketDescriptor for FileDescriptor {
1866                 fn send_data(&mut self, data: &[u8], _resume_read: bool) -> usize {
1867                         self.outbound_data.lock().unwrap().extend_from_slice(data);
1868                         data.len()
1869                 }
1870
1871                 fn disconnect_socket(&mut self) {}
1872         }
1873
1874         struct PeerManagerCfg {
1875                 chan_handler: test_utils::TestChannelMessageHandler,
1876                 routing_handler: test_utils::TestRoutingMessageHandler,
1877                 logger: test_utils::TestLogger,
1878         }
1879
1880         fn create_peermgr_cfgs(peer_count: usize) -> Vec<PeerManagerCfg> {
1881                 let mut cfgs = Vec::new();
1882                 for _ in 0..peer_count {
1883                         cfgs.push(
1884                                 PeerManagerCfg{
1885                                         chan_handler: test_utils::TestChannelMessageHandler::new(),
1886                                         logger: test_utils::TestLogger::new(),
1887                                         routing_handler: test_utils::TestRoutingMessageHandler::new(),
1888                                 }
1889                         );
1890                 }
1891
1892                 cfgs
1893         }
1894
1895         fn create_network<'a>(peer_count: usize, cfgs: &'a Vec<PeerManagerCfg>) -> Vec<PeerManager<FileDescriptor, &'a test_utils::TestChannelMessageHandler, &'a test_utils::TestRoutingMessageHandler, &'a test_utils::TestLogger, IgnoringMessageHandler>> {
1896                 let mut peers = Vec::new();
1897                 for i in 0..peer_count {
1898                         let node_secret = SecretKey::from_slice(&[42 + i as u8; 32]).unwrap();
1899                         let ephemeral_bytes = [i as u8; 32];
1900                         let msg_handler = MessageHandler { chan_handler: &cfgs[i].chan_handler, route_handler: &cfgs[i].routing_handler };
1901                         let peer = PeerManager::new(msg_handler, node_secret, &ephemeral_bytes, &cfgs[i].logger, IgnoringMessageHandler {});
1902                         peers.push(peer);
1903                 }
1904
1905                 peers
1906         }
1907
1908         fn establish_connection<'a>(peer_a: &PeerManager<FileDescriptor, &'a test_utils::TestChannelMessageHandler, &'a test_utils::TestRoutingMessageHandler, &'a test_utils::TestLogger, IgnoringMessageHandler>, peer_b: &PeerManager<FileDescriptor, &'a test_utils::TestChannelMessageHandler, &'a test_utils::TestRoutingMessageHandler, &'a test_utils::TestLogger, IgnoringMessageHandler>) -> (FileDescriptor, FileDescriptor) {
1909                 let secp_ctx = Secp256k1::new();
1910                 let a_id = PublicKey::from_secret_key(&secp_ctx, &peer_a.our_node_secret);
1911                 let mut fd_a = FileDescriptor { fd: 1, outbound_data: Arc::new(Mutex::new(Vec::new())) };
1912                 let mut fd_b = FileDescriptor { fd: 1, outbound_data: Arc::new(Mutex::new(Vec::new())) };
1913                 let initial_data = peer_b.new_outbound_connection(a_id, fd_b.clone(), None).unwrap();
1914                 peer_a.new_inbound_connection(fd_a.clone(), None).unwrap();
1915                 assert_eq!(peer_a.read_event(&mut fd_a, &initial_data).unwrap(), false);
1916                 peer_a.process_events();
1917                 assert_eq!(peer_b.read_event(&mut fd_b, &fd_a.outbound_data.lock().unwrap().split_off(0)).unwrap(), false);
1918                 peer_b.process_events();
1919                 assert_eq!(peer_a.read_event(&mut fd_a, &fd_b.outbound_data.lock().unwrap().split_off(0)).unwrap(), false);
1920                 peer_a.process_events();
1921                 assert_eq!(peer_b.read_event(&mut fd_b, &fd_a.outbound_data.lock().unwrap().split_off(0)).unwrap(), false);
1922                 (fd_a.clone(), fd_b.clone())
1923         }
1924
1925         #[test]
1926         fn test_disconnect_peer() {
1927                 // Simple test which builds a network of PeerManager, connects and brings them to NoiseState::Finished and
1928                 // push a DisconnectPeer event to remove the node flagged by id
1929                 let cfgs = create_peermgr_cfgs(2);
1930                 let chan_handler = test_utils::TestChannelMessageHandler::new();
1931                 let mut peers = create_network(2, &cfgs);
1932                 establish_connection(&peers[0], &peers[1]);
1933                 assert_eq!(peers[0].peers.read().unwrap().len(), 1);
1934
1935                 let secp_ctx = Secp256k1::new();
1936                 let their_id = PublicKey::from_secret_key(&secp_ctx, &peers[1].our_node_secret);
1937
1938                 chan_handler.pending_events.lock().unwrap().push(events::MessageSendEvent::HandleError {
1939                         node_id: their_id,
1940                         action: msgs::ErrorAction::DisconnectPeer { msg: None },
1941                 });
1942                 assert_eq!(chan_handler.pending_events.lock().unwrap().len(), 1);
1943                 peers[0].message_handler.chan_handler = &chan_handler;
1944
1945                 peers[0].process_events();
1946                 assert_eq!(peers[0].peers.read().unwrap().len(), 0);
1947         }
1948
1949         #[test]
1950         fn test_timer_tick_occurred() {
1951                 // Create peers, a vector of two peer managers, perform initial set up and check that peers[0] has one Peer.
1952                 let cfgs = create_peermgr_cfgs(2);
1953                 let peers = create_network(2, &cfgs);
1954                 establish_connection(&peers[0], &peers[1]);
1955                 assert_eq!(peers[0].peers.read().unwrap().len(), 1);
1956
1957                 // peers[0] awaiting_pong is set to true, but the Peer is still connected
1958                 peers[0].timer_tick_occurred();
1959                 peers[0].process_events();
1960                 assert_eq!(peers[0].peers.read().unwrap().len(), 1);
1961
1962                 // Since timer_tick_occurred() is called again when awaiting_pong is true, all Peers are disconnected
1963                 peers[0].timer_tick_occurred();
1964                 peers[0].process_events();
1965                 assert_eq!(peers[0].peers.read().unwrap().len(), 0);
1966         }
1967
1968         #[test]
1969         fn test_do_attempt_write_data() {
1970                 // Create 2 peers with custom TestRoutingMessageHandlers and connect them.
1971                 let cfgs = create_peermgr_cfgs(2);
1972                 cfgs[0].routing_handler.request_full_sync.store(true, Ordering::Release);
1973                 cfgs[1].routing_handler.request_full_sync.store(true, Ordering::Release);
1974                 let peers = create_network(2, &cfgs);
1975
1976                 // By calling establish_connect, we trigger do_attempt_write_data between
1977                 // the peers. Previously this function would mistakenly enter an infinite loop
1978                 // when there were more channel messages available than could fit into a peer's
1979                 // buffer. This issue would now be detected by this test (because we use custom
1980                 // RoutingMessageHandlers that intentionally return more channel messages
1981                 // than can fit into a peer's buffer).
1982                 let (mut fd_a, mut fd_b) = establish_connection(&peers[0], &peers[1]);
1983
1984                 // Make each peer to read the messages that the other peer just wrote to them. Note that
1985                 // due to the max-message-before-ping limits this may take a few iterations to complete.
1986                 for _ in 0..150/super::BUFFER_DRAIN_MSGS_PER_TICK + 1 {
1987                         peers[1].process_events();
1988                         let a_read_data = fd_b.outbound_data.lock().unwrap().split_off(0);
1989                         assert!(!a_read_data.is_empty());
1990
1991                         peers[0].read_event(&mut fd_a, &a_read_data).unwrap();
1992                         peers[0].process_events();
1993
1994                         let b_read_data = fd_a.outbound_data.lock().unwrap().split_off(0);
1995                         assert!(!b_read_data.is_empty());
1996                         peers[1].read_event(&mut fd_b, &b_read_data).unwrap();
1997
1998                         peers[0].process_events();
1999                         assert_eq!(fd_a.outbound_data.lock().unwrap().len(), 0, "Until A receives data, it shouldn't send more messages");
2000                 }
2001
2002                 // Check that each peer has received the expected number of channel updates and channel
2003                 // announcements.
2004                 assert_eq!(cfgs[0].routing_handler.chan_upds_recvd.load(Ordering::Acquire), 100);
2005                 assert_eq!(cfgs[0].routing_handler.chan_anns_recvd.load(Ordering::Acquire), 50);
2006                 assert_eq!(cfgs[1].routing_handler.chan_upds_recvd.load(Ordering::Acquire), 100);
2007                 assert_eq!(cfgs[1].routing_handler.chan_anns_recvd.load(Ordering::Acquire), 50);
2008         }
2009
2010         #[test]
2011         fn test_handshake_timeout() {
2012                 // Tests that we time out a peer still waiting on handshake completion after a full timer
2013                 // tick.
2014                 let cfgs = create_peermgr_cfgs(2);
2015                 cfgs[0].routing_handler.request_full_sync.store(true, Ordering::Release);
2016                 cfgs[1].routing_handler.request_full_sync.store(true, Ordering::Release);
2017                 let peers = create_network(2, &cfgs);
2018
2019                 let secp_ctx = Secp256k1::new();
2020                 let a_id = PublicKey::from_secret_key(&secp_ctx, &peers[0].our_node_secret);
2021                 let mut fd_a = FileDescriptor { fd: 1, outbound_data: Arc::new(Mutex::new(Vec::new())) };
2022                 let mut fd_b = FileDescriptor { fd: 1, outbound_data: Arc::new(Mutex::new(Vec::new())) };
2023                 let initial_data = peers[1].new_outbound_connection(a_id, fd_b.clone(), None).unwrap();
2024                 peers[0].new_inbound_connection(fd_a.clone(), None).unwrap();
2025
2026                 // If we get a single timer tick before completion, that's fine
2027                 assert_eq!(peers[0].peers.read().unwrap().len(), 1);
2028                 peers[0].timer_tick_occurred();
2029                 assert_eq!(peers[0].peers.read().unwrap().len(), 1);
2030
2031                 assert_eq!(peers[0].read_event(&mut fd_a, &initial_data).unwrap(), false);
2032                 peers[0].process_events();
2033                 assert_eq!(peers[1].read_event(&mut fd_b, &fd_a.outbound_data.lock().unwrap().split_off(0)).unwrap(), false);
2034                 peers[1].process_events();
2035
2036                 // ...but if we get a second timer tick, we should disconnect the peer
2037                 peers[0].timer_tick_occurred();
2038                 assert_eq!(peers[0].peers.read().unwrap().len(), 0);
2039
2040                 assert!(peers[0].read_event(&mut fd_a, &fd_b.outbound_data.lock().unwrap().split_off(0)).is_err());
2041         }
2042
2043         #[test]
2044         fn test_filter_addresses(){
2045                 // Tests the filter_addresses function.
2046
2047                 // For (10/8)
2048                 let ip_address = NetAddress::IPv4{addr: [10, 0, 0, 0], port: 1000};
2049                 assert_eq!(filter_addresses(Some(ip_address.clone())), None);
2050                 let ip_address = NetAddress::IPv4{addr: [10, 0, 255, 201], port: 1000};
2051                 assert_eq!(filter_addresses(Some(ip_address.clone())), None);
2052                 let ip_address = NetAddress::IPv4{addr: [10, 255, 255, 255], port: 1000};
2053                 assert_eq!(filter_addresses(Some(ip_address.clone())), None);
2054
2055                 // For (0/8)
2056                 let ip_address = NetAddress::IPv4{addr: [0, 0, 0, 0], port: 1000};
2057                 assert_eq!(filter_addresses(Some(ip_address.clone())), None);
2058                 let ip_address = NetAddress::IPv4{addr: [0, 0, 255, 187], port: 1000};
2059                 assert_eq!(filter_addresses(Some(ip_address.clone())), None);
2060                 let ip_address = NetAddress::IPv4{addr: [0, 255, 255, 255], port: 1000};
2061                 assert_eq!(filter_addresses(Some(ip_address.clone())), None);
2062
2063                 // For (100.64/10)
2064                 let ip_address = NetAddress::IPv4{addr: [100, 64, 0, 0], port: 1000};
2065                 assert_eq!(filter_addresses(Some(ip_address.clone())), None);
2066                 let ip_address = NetAddress::IPv4{addr: [100, 78, 255, 0], port: 1000};
2067                 assert_eq!(filter_addresses(Some(ip_address.clone())), None);
2068                 let ip_address = NetAddress::IPv4{addr: [100, 127, 255, 255], port: 1000};
2069                 assert_eq!(filter_addresses(Some(ip_address.clone())), None);
2070
2071                 // For (127/8)
2072                 let ip_address = NetAddress::IPv4{addr: [127, 0, 0, 0], port: 1000};
2073                 assert_eq!(filter_addresses(Some(ip_address.clone())), None);
2074                 let ip_address = NetAddress::IPv4{addr: [127, 65, 73, 0], port: 1000};
2075                 assert_eq!(filter_addresses(Some(ip_address.clone())), None);
2076                 let ip_address = NetAddress::IPv4{addr: [127, 255, 255, 255], port: 1000};
2077                 assert_eq!(filter_addresses(Some(ip_address.clone())), None);
2078
2079                 // For (169.254/16)
2080                 let ip_address = NetAddress::IPv4{addr: [169, 254, 0, 0], port: 1000};
2081                 assert_eq!(filter_addresses(Some(ip_address.clone())), None);
2082                 let ip_address = NetAddress::IPv4{addr: [169, 254, 221, 101], port: 1000};
2083                 assert_eq!(filter_addresses(Some(ip_address.clone())), None);
2084                 let ip_address = NetAddress::IPv4{addr: [169, 254, 255, 255], port: 1000};
2085                 assert_eq!(filter_addresses(Some(ip_address.clone())), None);
2086
2087                 // For (172.16/12)
2088                 let ip_address = NetAddress::IPv4{addr: [172, 16, 0, 0], port: 1000};
2089                 assert_eq!(filter_addresses(Some(ip_address.clone())), None);
2090                 let ip_address = NetAddress::IPv4{addr: [172, 27, 101, 23], port: 1000};
2091                 assert_eq!(filter_addresses(Some(ip_address.clone())), None);
2092                 let ip_address = NetAddress::IPv4{addr: [172, 31, 255, 255], port: 1000};
2093                 assert_eq!(filter_addresses(Some(ip_address.clone())), None);
2094
2095                 // For (192.168/16)
2096                 let ip_address = NetAddress::IPv4{addr: [192, 168, 0, 0], port: 1000};
2097                 assert_eq!(filter_addresses(Some(ip_address.clone())), None);
2098                 let ip_address = NetAddress::IPv4{addr: [192, 168, 205, 159], port: 1000};
2099                 assert_eq!(filter_addresses(Some(ip_address.clone())), None);
2100                 let ip_address = NetAddress::IPv4{addr: [192, 168, 255, 255], port: 1000};
2101                 assert_eq!(filter_addresses(Some(ip_address.clone())), None);
2102
2103                 // For (192.88.99/24)
2104                 let ip_address = NetAddress::IPv4{addr: [192, 88, 99, 0], port: 1000};
2105                 assert_eq!(filter_addresses(Some(ip_address.clone())), None);
2106                 let ip_address = NetAddress::IPv4{addr: [192, 88, 99, 140], port: 1000};
2107                 assert_eq!(filter_addresses(Some(ip_address.clone())), None);
2108                 let ip_address = NetAddress::IPv4{addr: [192, 88, 99, 255], port: 1000};
2109                 assert_eq!(filter_addresses(Some(ip_address.clone())), None);
2110
2111                 // For other IPv4 addresses
2112                 let ip_address = NetAddress::IPv4{addr: [188, 255, 99, 0], port: 1000};
2113                 assert_eq!(filter_addresses(Some(ip_address.clone())), Some(ip_address.clone()));
2114                 let ip_address = NetAddress::IPv4{addr: [123, 8, 129, 14], port: 1000};
2115                 assert_eq!(filter_addresses(Some(ip_address.clone())), Some(ip_address.clone()));
2116                 let ip_address = NetAddress::IPv4{addr: [2, 88, 9, 255], port: 1000};
2117                 assert_eq!(filter_addresses(Some(ip_address.clone())), Some(ip_address.clone()));
2118
2119                 // For (2000::/3)
2120                 let ip_address = NetAddress::IPv6{addr: [32, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0], port: 1000};
2121                 assert_eq!(filter_addresses(Some(ip_address.clone())), Some(ip_address.clone()));
2122                 let ip_address = NetAddress::IPv6{addr: [45, 34, 209, 190, 0, 123, 55, 34, 0, 0, 3, 27, 201, 0, 0, 0], port: 1000};
2123                 assert_eq!(filter_addresses(Some(ip_address.clone())), Some(ip_address.clone()));
2124                 let ip_address = NetAddress::IPv6{addr: [63, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255], port: 1000};
2125                 assert_eq!(filter_addresses(Some(ip_address.clone())), Some(ip_address.clone()));
2126
2127                 // For other IPv6 addresses
2128                 let ip_address = NetAddress::IPv6{addr: [24, 240, 12, 32, 0, 0, 0, 0, 20, 97, 0, 32, 121, 254, 0, 0], port: 1000};
2129                 assert_eq!(filter_addresses(Some(ip_address.clone())), None);
2130                 let ip_address = NetAddress::IPv6{addr: [68, 23, 56, 63, 0, 0, 2, 7, 75, 109, 0, 39, 0, 0, 0, 0], port: 1000};
2131                 assert_eq!(filter_addresses(Some(ip_address.clone())), None);
2132                 let ip_address = NetAddress::IPv6{addr: [101, 38, 140, 230, 100, 0, 30, 98, 0, 26, 0, 0, 57, 96, 0, 0], port: 1000};
2133                 assert_eq!(filter_addresses(Some(ip_address.clone())), None);
2134
2135                 // For (None)
2136                 assert_eq!(filter_addresses(None), None);
2137         }
2138 }