Merge pull request #175 from TheBlueMatt/2018-09-173-whitespace-err
[rust-lightning] / src / ln / peer_handler.rs
index 9d5f58d7fb861b5898a08b331ccf2b1680acef21..4e710117bb805037a80457086a434de70a0bb29b 100644 (file)
@@ -1,13 +1,13 @@
 use secp256k1::key::{SecretKey,PublicKey};
 
 use ln::msgs;
-use ln::msgs::{MsgEncodable,MsgDecodable};
+use util::ser::{Writer, Reader, Writeable, Readable};
 use ln::peer_channel_encryptor::{PeerChannelEncryptor,NextNoiseStep};
 use util::byte_utils;
 use util::events::{EventsProvider,Event};
 use util::logger::Logger;
 
-use std::collections::{HashMap,LinkedList};
+use std::collections::{HashMap,hash_map,LinkedList};
 use std::sync::{Arc, Mutex};
 use std::sync::atomic::{AtomicUsize, Ordering};
 use std::{cmp,error,mem,hash,fmt};
@@ -90,6 +90,18 @@ struct PeerHolder<Descriptor: SocketDescriptor> {
        /// Only add to this set when noise completes:
        node_id_to_descriptor: HashMap<PublicKey, Descriptor>,
 }
+struct MutPeerHolder<'a, Descriptor: SocketDescriptor + 'a> {
+       peers: &'a mut HashMap<Descriptor, Peer>,
+       node_id_to_descriptor: &'a mut HashMap<PublicKey, Descriptor>,
+}
+impl<Descriptor: SocketDescriptor> PeerHolder<Descriptor> {
+       fn borrow_parts(&mut self) -> MutPeerHolder<Descriptor> {
+               MutPeerHolder {
+                       peers: &mut self.peers,
+                       node_id_to_descriptor: &mut self.node_id_to_descriptor,
+               }
+       }
+}
 
 pub struct PeerManager<Descriptor: SocketDescriptor> {
        message_handler: MessageHandler,
@@ -100,17 +112,16 @@ pub struct PeerManager<Descriptor: SocketDescriptor> {
        logger: Arc<Logger>,
 }
 
-
 macro_rules! encode_msg {
-       ($msg: expr, $msg_code: expr) => {
-               {
-                       let just_msg = $msg.encode();
-                       let mut encoded_msg = Vec::with_capacity(just_msg.len() + 2);
-                       encoded_msg.extend_from_slice(&byte_utils::be16_to_array($msg_code));
-                       encoded_msg.extend_from_slice(&just_msg[..]);
-                       encoded_msg
-               }
-       }
+       ($msg: expr, $msg_code: expr) => {{
+               let mut w = Writer::new(::std::io::Cursor::new(vec![]));
+               0u16.write(&mut w).unwrap();
+               $msg.write(&mut w).unwrap();
+               let mut msg = w.into_inner().into_inner();
+               let len = msg.len();
+               msg[..2].copy_from_slice(&byte_utils::be16_to_array(len as u16 - 2));
+               msg
+       }}
 }
 
 //TODO: Really should do something smarter for this
@@ -136,7 +147,12 @@ impl<Descriptor: SocketDescriptor> PeerManager<Descriptor> {
        /// completed and we are sure the remote peer has the private key for the given node_id.
        pub fn get_peer_node_ids(&self) -> Vec<PublicKey> {
                let peers = self.peers.lock().unwrap();
-               peers.peers.values().filter_map(|p| p.their_node_id).collect()
+               peers.peers.values().filter_map(|p| {
+                       if !p.channel_encryptor.is_ready_for_encryption() || p.their_global_features.is_none() {
+                               return None;
+                       }
+                       p.their_node_id
+               }).collect()
        }
 
        /// Indicates a new outbound connection has been established to a node with the given node_id.
@@ -267,14 +283,14 @@ impl<Descriptor: SocketDescriptor> PeerManager<Descriptor> {
 
        fn do_read_event(&self, peer_descriptor: &mut Descriptor, data: Vec<u8>) -> Result<bool, PeerHandleError> {
                let pause_read = {
-                       let mut peers = self.peers.lock().unwrap();
-                       let (should_insert_node_id, pause_read) = match peers.peers.get_mut(peer_descriptor) {
+                       let mut peers_lock = self.peers.lock().unwrap();
+                       let peers = peers_lock.borrow_parts();
+                       let pause_read = match peers.peers.get_mut(peer_descriptor) {
                                None => panic!("Descriptor for read_event is not already known to PeerManager"),
                                Some(peer) => {
                                        assert!(peer.pending_read_buffer.len() > 0);
                                        assert!(peer.pending_read_buffer.len() > peer.pending_read_buffer_pos);
 
-                                       let mut insert_node_id = None;
                                        let mut read_pos = 0;
                                        while read_pos < data.len() {
                                                {
@@ -347,12 +363,26 @@ impl<Descriptor: SocketDescriptor> PeerManager<Descriptor> {
                                                                                                        continue;
                                                                                                },
                                                                                                msgs::DecodeError::BadLengthDescriptor => return Err(PeerHandleError{ no_connection_possible: false }),
+                                                                                               msgs::DecodeError::Io(_) => return Err(PeerHandleError{ no_connection_possible: false }),
+                                                                                               msgs::DecodeError::InvalidValue => panic!("should not happen with message decoding"),
                                                                                        }
                                                                                }
                                                                        };
                                                                }
                                                        }
 
+                                                       macro_rules! insert_node_id {
+                                                               () => {
+                                                                       match peers.node_id_to_descriptor.entry(peer.their_node_id.unwrap()) {
+                                                                               hash_map::Entry::Occupied(_) => {
+                                                                                       peer.their_node_id = None; // Unset so that we don't generate a peer_disconnected event
+                                                                                       return Err(PeerHandleError{ no_connection_possible: false })
+                                                                               },
+                                                                               hash_map::Entry::Vacant(entry) => entry.insert(peer_descriptor.clone()),
+                                                                       };
+                                                               }
+                                                       }
+
                                                        let next_step = peer.channel_encryptor.get_noise_step();
                                                        match next_step {
                                                                NextNoiseStep::ActOne => {
@@ -366,7 +396,7 @@ impl<Descriptor: SocketDescriptor> PeerManager<Descriptor> {
                                                                        peer.pending_read_buffer = [0; 18].to_vec(); // Message length header is 18 bytes
                                                                        peer.pending_read_is_header = true;
 
-                                                                       insert_node_id = Some(peer.their_node_id.unwrap());
+                                                                       insert_node_id!();
                                                                        let mut local_features = msgs::LocalFeatures::new();
                                                                        if self.initial_syncs_sent.load(Ordering::Acquire) < INITIAL_SYNCS_TO_SEND {
                                                                                self.initial_syncs_sent.fetch_add(1, Ordering::AcqRel);
@@ -382,7 +412,7 @@ impl<Descriptor: SocketDescriptor> PeerManager<Descriptor> {
                                                                        peer.pending_read_buffer = [0; 18].to_vec(); // Message length header is 18 bytes
                                                                        peer.pending_read_is_header = true;
                                                                        peer.their_node_id = Some(their_node_id);
-                                                                       insert_node_id = Some(peer.their_node_id.unwrap());
+                                                                       insert_node_id!();
                                                                },
                                                                NextNoiseStep::NoiseComplete => {
                                                                        if peer.pending_read_is_header {
@@ -407,16 +437,20 @@ impl<Descriptor: SocketDescriptor> PeerManager<Descriptor> {
                                                                                        // Need an init message as first message
                                                                                        return Err(PeerHandleError{ no_connection_possible: false });
                                                                                }
+                                                                               let mut reader = Reader::new(::std::io::Cursor::new(&msg_data[2..]));
                                                                                match msg_type {
                                                                                        // Connection control:
                                                                                        16 => {
-                                                                                               let msg = try_potential_decodeerror!(msgs::Init::decode(&msg_data[2..]));
+                                                                                               let msg = try_potential_decodeerror!(msgs::Init::read(&mut reader));
                                                                                                if msg.global_features.requires_unknown_bits() {
                                                                                                        return Err(PeerHandleError{ no_connection_possible: true });
                                                                                                }
                                                                                                if msg.local_features.requires_unknown_bits() {
                                                                                                        return Err(PeerHandleError{ no_connection_possible: true });
                                                                                                }
+                                                                                               if peer.their_global_features.is_some() {
+                                                                                                       return Err(PeerHandleError{ no_connection_possible: false });
+                                                                                               }
                                                                                                peer.their_global_features = Some(msg.global_features);
                                                                                                peer.their_local_features = Some(msg.local_features);
 
@@ -433,7 +467,7 @@ impl<Descriptor: SocketDescriptor> PeerManager<Descriptor> {
                                                                                                }
                                                                                        },
                                                                                        17 => {
-                                                                                               let msg = try_potential_decodeerror!(msgs::ErrorMessage::decode(&msg_data[2..]));
+                                                                                               let msg = try_potential_decodeerror!(msgs::ErrorMessage::read(&mut reader));
                                                                                                let mut data_is_printable = true;
                                                                                                for b in msg.data.bytes() {
                                                                                                        if b < 32 || b > 126 {
@@ -454,38 +488,38 @@ impl<Descriptor: SocketDescriptor> PeerManager<Descriptor> {
                                                                                        },
 
                                                                                        18 => {
-                                                                                               let msg = try_potential_decodeerror!(msgs::Ping::decode(&msg_data[2..]));
+                                                                                               let msg = try_potential_decodeerror!(msgs::Ping::read(&mut reader));
                                                                                                if msg.ponglen < 65532 {
                                                                                                        let resp = msgs::Pong { byteslen: msg.ponglen };
                                                                                                        encode_and_send_msg!(resp, 19);
                                                                                                }
                                                                                        },
                                                                                        19 => {
-                                                                                               try_potential_decodeerror!(msgs::Pong::decode(&msg_data[2..]));
+                                                                                               try_potential_decodeerror!(msgs::Pong::read(&mut reader));
                                                                                        },
 
                                                                                        // Channel control:
                                                                                        32 => {
-                                                                                               let msg = try_potential_decodeerror!(msgs::OpenChannel::decode(&msg_data[2..]));
+                                                                                               let msg = try_potential_decodeerror!(msgs::OpenChannel::read(&mut reader));
                                                                                                let resp = try_potential_handleerror!(self.message_handler.chan_handler.handle_open_channel(&peer.their_node_id.unwrap(), &msg));
                                                                                                encode_and_send_msg!(resp, 33);
                                                                                        },
                                                                                        33 => {
-                                                                                               let msg = try_potential_decodeerror!(msgs::AcceptChannel::decode(&msg_data[2..]));
+                                                                                               let msg = try_potential_decodeerror!(msgs::AcceptChannel::read(&mut reader));
                                                                                                try_potential_handleerror!(self.message_handler.chan_handler.handle_accept_channel(&peer.their_node_id.unwrap(), &msg));
                                                                                        },
 
                                                                                        34 => {
-                                                                                               let msg = try_potential_decodeerror!(msgs::FundingCreated::decode(&msg_data[2..]));
+                                                                                               let msg = try_potential_decodeerror!(msgs::FundingCreated::read(&mut reader));
                                                                                                let resp = try_potential_handleerror!(self.message_handler.chan_handler.handle_funding_created(&peer.their_node_id.unwrap(), &msg));
                                                                                                encode_and_send_msg!(resp, 35);
                                                                                        },
                                                                                        35 => {
-                                                                                               let msg = try_potential_decodeerror!(msgs::FundingSigned::decode(&msg_data[2..]));
+                                                                                               let msg = try_potential_decodeerror!(msgs::FundingSigned::read(&mut reader));
                                                                                                try_potential_handleerror!(self.message_handler.chan_handler.handle_funding_signed(&peer.their_node_id.unwrap(), &msg));
                                                                                        },
                                                                                        36 => {
-                                                                                               let msg = try_potential_decodeerror!(msgs::FundingLocked::decode(&msg_data[2..]));
+                                                                                               let msg = try_potential_decodeerror!(msgs::FundingLocked::read(&mut reader));
                                                                                                let resp_option = try_potential_handleerror!(self.message_handler.chan_handler.handle_funding_locked(&peer.their_node_id.unwrap(), &msg));
                                                                                                match resp_option {
                                                                                                        Some(resp) => encode_and_send_msg!(resp, 259),
@@ -494,7 +528,7 @@ impl<Descriptor: SocketDescriptor> PeerManager<Descriptor> {
                                                                                        },
 
                                                                                        38 => {
-                                                                                               let msg = try_potential_decodeerror!(msgs::Shutdown::decode(&msg_data[2..]));
+                                                                                               let msg = try_potential_decodeerror!(msgs::Shutdown::read(&mut reader));
                                                                                                let resp_options = try_potential_handleerror!(self.message_handler.chan_handler.handle_shutdown(&peer.their_node_id.unwrap(), &msg));
                                                                                                if let Some(resp) = resp_options.0 {
                                                                                                        encode_and_send_msg!(resp, 38);
@@ -504,7 +538,7 @@ impl<Descriptor: SocketDescriptor> PeerManager<Descriptor> {
                                                                                                }
                                                                                        },
                                                                                        39 => {
-                                                                                               let msg = try_potential_decodeerror!(msgs::ClosingSigned::decode(&msg_data[2..]));
+                                                                                               let msg = try_potential_decodeerror!(msgs::ClosingSigned::read(&mut reader));
                                                                                                let resp_option = try_potential_handleerror!(self.message_handler.chan_handler.handle_closing_signed(&peer.their_node_id.unwrap(), &msg));
                                                                                                if let Some(resp) = resp_option {
                                                                                                        encode_and_send_msg!(resp, 39);
@@ -512,27 +546,27 @@ impl<Descriptor: SocketDescriptor> PeerManager<Descriptor> {
                                                                                        },
 
                                                                                        128 => {
-                                                                                               let msg = try_potential_decodeerror!(msgs::UpdateAddHTLC::decode(&msg_data[2..]));
+                                                                                               let msg = try_potential_decodeerror!(msgs::UpdateAddHTLC::read(&mut reader));
                                                                                                try_potential_handleerror!(self.message_handler.chan_handler.handle_update_add_htlc(&peer.their_node_id.unwrap(), &msg));
                                                                                        },
                                                                                        130 => {
-                                                                                               let msg = try_potential_decodeerror!(msgs::UpdateFulfillHTLC::decode(&msg_data[2..]));
+                                                                                               let msg = try_potential_decodeerror!(msgs::UpdateFulfillHTLC::read(&mut reader));
                                                                                                try_potential_handleerror!(self.message_handler.chan_handler.handle_update_fulfill_htlc(&peer.their_node_id.unwrap(), &msg));
                                                                                        },
                                                                                        131 => {
-                                                                                               let msg = try_potential_decodeerror!(msgs::UpdateFailHTLC::decode(&msg_data[2..]));
+                                                                                               let msg = try_potential_decodeerror!(msgs::UpdateFailHTLC::read(&mut reader));
                                                                                                let chan_update = try_potential_handleerror!(self.message_handler.chan_handler.handle_update_fail_htlc(&peer.their_node_id.unwrap(), &msg));
                                                                                                if let Some(update) = chan_update {
                                                                                                        self.message_handler.route_handler.handle_htlc_fail_channel_update(&update);
                                                                                                }
                                                                                        },
                                                                                        135 => {
-                                                                                               let msg = try_potential_decodeerror!(msgs::UpdateFailMalformedHTLC::decode(&msg_data[2..]));
+                                                                                               let msg = try_potential_decodeerror!(msgs::UpdateFailMalformedHTLC::read(&mut reader));
                                                                                                try_potential_handleerror!(self.message_handler.chan_handler.handle_update_fail_malformed_htlc(&peer.their_node_id.unwrap(), &msg));
                                                                                        },
 
                                                                                        132 => {
-                                                                                               let msg = try_potential_decodeerror!(msgs::CommitmentSigned::decode(&msg_data[2..]));
+                                                                                               let msg = try_potential_decodeerror!(msgs::CommitmentSigned::read(&mut reader));
                                                                                                let resps = try_potential_handleerror!(self.message_handler.chan_handler.handle_commitment_signed(&peer.their_node_id.unwrap(), &msg));
                                                                                                encode_and_send_msg!(resps.0, 133);
                                                                                                if let Some(resp) = resps.1 {
@@ -540,7 +574,7 @@ impl<Descriptor: SocketDescriptor> PeerManager<Descriptor> {
                                                                                                }
                                                                                        },
                                                                                        133 => {
-                                                                                               let msg = try_potential_decodeerror!(msgs::RevokeAndACK::decode(&msg_data[2..]));
+                                                                                               let msg = try_potential_decodeerror!(msgs::RevokeAndACK::read(&mut reader));
                                                                                                let resp_option = try_potential_handleerror!(self.message_handler.chan_handler.handle_revoke_and_ack(&peer.their_node_id.unwrap(), &msg));
                                                                                                match resp_option {
                                                                                                        Some(resps) => {
@@ -559,18 +593,18 @@ impl<Descriptor: SocketDescriptor> PeerManager<Descriptor> {
                                                                                                }
                                                                                        },
                                                                                        134 => {
-                                                                                               let msg = try_potential_decodeerror!(msgs::UpdateFee::decode(&msg_data[2..]));
+                                                                                               let msg = try_potential_decodeerror!(msgs::UpdateFee::read(&mut reader));
                                                                                                try_potential_handleerror!(self.message_handler.chan_handler.handle_update_fee(&peer.their_node_id.unwrap(), &msg));
                                                                                        },
                                                                                        136 => { }, // TODO: channel_reestablish
 
                                                                                        // Routing control:
                                                                                        259 => {
-                                                                                               let msg = try_potential_decodeerror!(msgs::AnnouncementSignatures::decode(&msg_data[2..]));
+                                                                                               let msg = try_potential_decodeerror!(msgs::AnnouncementSignatures::read(&mut reader));
                                                                                                try_potential_handleerror!(self.message_handler.chan_handler.handle_announcement_signatures(&peer.their_node_id.unwrap(), &msg));
                                                                                        },
                                                                                        256 => {
-                                                                                               let msg = try_potential_decodeerror!(msgs::ChannelAnnouncement::decode(&msg_data[2..]));
+                                                                                               let msg = try_potential_decodeerror!(msgs::ChannelAnnouncement::read(&mut reader));
                                                                                                let should_forward = try_potential_handleerror!(self.message_handler.route_handler.handle_channel_announcement(&msg));
 
                                                                                                if should_forward {
@@ -578,12 +612,20 @@ impl<Descriptor: SocketDescriptor> PeerManager<Descriptor> {
                                                                                                }
                                                                                        },
                                                                                        257 => {
-                                                                                               let msg = try_potential_decodeerror!(msgs::NodeAnnouncement::decode(&msg_data[2..]));
-                                                                                               try_potential_handleerror!(self.message_handler.route_handler.handle_node_announcement(&msg));
+                                                                                               let msg = try_potential_decodeerror!(msgs::NodeAnnouncement::read(&mut reader));
+                                                                                               let should_forward = try_potential_handleerror!(self.message_handler.route_handler.handle_node_announcement(&msg));
+
+                                                                                               if should_forward {
+                                                                                                       // TODO: forward msg along to all our other peers!
+                                                                                               }
                                                                                        },
                                                                                        258 => {
-                                                                                               let msg = try_potential_decodeerror!(msgs::ChannelUpdate::decode(&msg_data[2..]));
-                                                                                               try_potential_handleerror!(self.message_handler.route_handler.handle_channel_update(&msg));
+                                                                                               let msg = try_potential_decodeerror!(msgs::ChannelUpdate::read(&mut reader));
+                                                                                               let should_forward = try_potential_handleerror!(self.message_handler.route_handler.handle_channel_update(&msg));
+
+                                                                                               if should_forward {
+                                                                                                       // TODO: forward msg along to all our other peers!
+                                                                                               }
                                                                                        },
                                                                                        _ => {
                                                                                                if (msg_type & 1) == 0 {
@@ -599,15 +641,10 @@ impl<Descriptor: SocketDescriptor> PeerManager<Descriptor> {
 
                                        Self::do_attempt_write_data(peer_descriptor, peer);
 
-                                       (insert_node_id /* should_insert_node_id */, peer.pending_outbound_buffer.len() > 10) // pause_read
+                                       peer.pending_outbound_buffer.len() > 10 // pause_read
                                }
                        };
 
-                       match should_insert_node_id {
-                               Some(node_id) => { peers.node_id_to_descriptor.insert(node_id, peer_descriptor.clone()); },
-                               None => {}
-                       };
-
                        pause_read
                };