Merge pull request #1023 from TheBlueMatt/2021-07-par-gossip-processing
[rust-lightning] / lightning-net-tokio / src / lib.rs
index 3cfed870b31f59ae1b36ffbf7a1987eee2b0df00..f7e42b6634147d405e2cfebe1278801940e0a771 100644 (file)
@@ -23,7 +23,7 @@
 //! # Example
 //! ```
 //! use std::net::TcpStream;
-//! use bitcoin::secp256k1::key::PublicKey;
+//! use bitcoin::secp256k1::PublicKey;
 //! use lightning::util::events::{Event, EventHandler, EventsProvider};
 //! use std::net::SocketAddr;
 //! use std::sync::Arc;
@@ -71,7 +71,7 @@
 
 #![cfg_attr(docsrs, feature(doc_auto_cfg))]
 
-use bitcoin::secp256k1::key::PublicKey;
+use bitcoin::secp256k1::PublicKey;
 
 use tokio::net::TcpStream;
 use tokio::{io, time};
@@ -85,7 +85,6 @@ use lightning::ln::msgs::{ChannelMessageHandler, RoutingMessageHandler, NetAddre
 use lightning::util::logger::Logger;
 
 use std::task;
-use std::net::IpAddr;
 use std::net::SocketAddr;
 use std::net::TcpStream as StdTcpStream;
 use std::sync::{Arc, Mutex};
@@ -236,6 +235,20 @@ impl Connection {
        }
 }
 
+fn get_addr_from_stream(stream: &StdTcpStream) -> Option<NetAddress> {
+       match stream.peer_addr() {
+               Ok(SocketAddr::V4(sockaddr)) => Some(NetAddress::IPv4 {
+                       addr: sockaddr.ip().octets(),
+                       port: sockaddr.port(),
+               }),
+               Ok(SocketAddr::V6(sockaddr)) => Some(NetAddress::IPv6 {
+                       addr: sockaddr.ip().octets(),
+                       port: sockaddr.port(),
+               }),
+               Err(_) => None,
+       }
+}
+
 /// Process incoming messages and feed outgoing messages on the provided socket generated by
 /// accepting an incoming connection.
 ///
@@ -247,21 +260,12 @@ pub fn setup_inbound<CMH, RMH, L, UMH>(peer_manager: Arc<peer_handler::PeerManag
                RMH: RoutingMessageHandler + 'static + Send + Sync,
                L: Logger + 'static + ?Sized + Send + Sync,
                UMH: CustomMessageHandler + 'static + Send + Sync {
-       let ip_addr = stream.peer_addr().unwrap();
+       let remote_addr = get_addr_from_stream(&stream);
        let (reader, write_receiver, read_receiver, us) = Connection::new(stream);
        #[cfg(debug_assertions)]
        let last_us = Arc::clone(&us);
 
-       let handle_opt = if let Ok(_) = peer_manager.new_inbound_connection(SocketDescriptor::new(us.clone()), match ip_addr.ip() {
-               IpAddr::V4(ip) => Some(NetAddress::IPv4 {
-                       addr: ip.octets(),
-                       port: ip_addr.port(),
-               }),
-               IpAddr::V6(ip) => Some(NetAddress::IPv6 {
-                       addr: ip.octets(),
-                       port: ip_addr.port(),
-               }),
-       }) {
+       let handle_opt = if let Ok(_) = peer_manager.new_inbound_connection(SocketDescriptor::new(us.clone()), remote_addr) {
                Some(tokio::spawn(Connection::schedule_read(peer_manager, us, reader, read_receiver, write_receiver)))
        } else {
                // Note that we will skip socket_disconnected here, in accordance with the PeerManager
@@ -298,20 +302,11 @@ pub fn setup_outbound<CMH, RMH, L, UMH>(peer_manager: Arc<peer_handler::PeerMana
                RMH: RoutingMessageHandler + 'static + Send + Sync,
                L: Logger + 'static + ?Sized + Send + Sync,
                UMH: CustomMessageHandler + 'static + Send + Sync {
-       let ip_addr = stream.peer_addr().unwrap();
+       let remote_addr = get_addr_from_stream(&stream);
        let (reader, mut write_receiver, read_receiver, us) = Connection::new(stream);
        #[cfg(debug_assertions)]
        let last_us = Arc::clone(&us);
-       let handle_opt = if let Ok(initial_send) = peer_manager.new_outbound_connection(their_node_id, SocketDescriptor::new(us.clone()), match ip_addr.ip() {
-               IpAddr::V4(ip) => Some(NetAddress::IPv4 {
-                       addr: ip.octets(),
-                       port: ip_addr.port(),
-               }),
-               IpAddr::V6(ip) => Some(NetAddress::IPv6 {
-                       addr: ip.octets(),
-                       port: ip_addr.port(),
-               }),
-       }) {
+       let handle_opt = if let Ok(initial_send) = peer_manager.new_outbound_connection(their_node_id, SocketDescriptor::new(us.clone()), remote_addr) {
                Some(tokio::spawn(async move {
                        // We should essentially always have enough room in a TCP socket buffer to send the
                        // initial 10s of bytes. However, tokio running in single-threaded mode will always
@@ -588,6 +583,22 @@ mod tests {
                }
        }
 
+       fn make_tcp_connection() -> (std::net::TcpStream, std::net::TcpStream) {
+               if let Ok(listener) = std::net::TcpListener::bind("127.0.0.1:9735") {
+                       (std::net::TcpStream::connect("127.0.0.1:9735").unwrap(), listener.accept().unwrap().0)
+               } else if let Ok(listener) = std::net::TcpListener::bind("127.0.0.1:19735") {
+                       (std::net::TcpStream::connect("127.0.0.1:19735").unwrap(), listener.accept().unwrap().0)
+               } else if let Ok(listener) = std::net::TcpListener::bind("127.0.0.1:9997") {
+                       (std::net::TcpStream::connect("127.0.0.1:9997").unwrap(), listener.accept().unwrap().0)
+               } else if let Ok(listener) = std::net::TcpListener::bind("127.0.0.1:9998") {
+                       (std::net::TcpStream::connect("127.0.0.1:9998").unwrap(), listener.accept().unwrap().0)
+               } else if let Ok(listener) = std::net::TcpListener::bind("127.0.0.1:9999") {
+                       (std::net::TcpStream::connect("127.0.0.1:9999").unwrap(), listener.accept().unwrap().0)
+               } else if let Ok(listener) = std::net::TcpListener::bind("127.0.0.1:46926") {
+                       (std::net::TcpStream::connect("127.0.0.1:46926").unwrap(), listener.accept().unwrap().0)
+               } else { panic!("Failed to bind to v4 localhost on common ports"); }
+       }
+
        async fn do_basic_connection_test() {
                let secp_ctx = Secp256k1::new();
                let a_key = SecretKey::from_slice(&[1; 32]).unwrap();
@@ -627,13 +638,7 @@ mod tests {
                // address. This may not always be the case in containers and the like, so if this test is
                // failing for you check that you have a loopback interface and it is configured with
                // 127.0.0.1.
-               let (conn_a, conn_b) = if let Ok(listener) = std::net::TcpListener::bind("127.0.0.1:9735") {
-                       (std::net::TcpStream::connect("127.0.0.1:9735").unwrap(), listener.accept().unwrap().0)
-               } else if let Ok(listener) = std::net::TcpListener::bind("127.0.0.1:9999") {
-                       (std::net::TcpStream::connect("127.0.0.1:9999").unwrap(), listener.accept().unwrap().0)
-               } else if let Ok(listener) = std::net::TcpListener::bind("127.0.0.1:46926") {
-                       (std::net::TcpStream::connect("127.0.0.1:46926").unwrap(), listener.accept().unwrap().0)
-               } else { panic!("Failed to bind to v4 localhost on common ports"); };
+               let (conn_a, conn_b) = make_tcp_connection();
 
                let fut_a = super::setup_outbound(Arc::clone(&a_manager), b_pub, conn_a);
                let fut_b = super::setup_inbound(b_manager, conn_b);
@@ -661,8 +666,53 @@ mod tests {
        async fn basic_threaded_connection_test() {
                do_basic_connection_test().await;
        }
+
        #[tokio::test]
        async fn basic_unthreaded_connection_test() {
                do_basic_connection_test().await;
        }
+
+       async fn race_disconnect_accept() {
+               // Previously, if we handed an already-disconnected socket to `setup_inbound` we'd panic.
+               // This attempts to find other similar races by opening connections and shutting them down
+               // while connecting. Sadly in testing this did *not* reproduce the previous issue.
+               let secp_ctx = Secp256k1::new();
+               let a_key = SecretKey::from_slice(&[1; 32]).unwrap();
+               let b_key = SecretKey::from_slice(&[2; 32]).unwrap();
+               let b_pub = PublicKey::from_secret_key(&secp_ctx, &b_key);
+
+               let a_manager = Arc::new(PeerManager::new(MessageHandler {
+                       chan_handler: Arc::new(lightning::ln::peer_handler::ErroringMessageHandler::new()),
+                       route_handler: Arc::new(lightning::ln::peer_handler::IgnoringMessageHandler{}),
+               }, a_key, &[1; 32], Arc::new(TestLogger()), Arc::new(lightning::ln::peer_handler::IgnoringMessageHandler{})));
+
+               // Make two connections, one for an inbound and one for an outbound connection
+               let conn_a = {
+                       let (conn_a, _) = make_tcp_connection();
+                       conn_a
+               };
+               let conn_b = {
+                       let (_, conn_b) = make_tcp_connection();
+                       conn_b
+               };
+
+               // Call connection setup inside new tokio tasks.
+               let manager_reference = Arc::clone(&a_manager);
+               tokio::spawn(async move {
+                       super::setup_inbound(manager_reference, conn_a).await
+               });
+               tokio::spawn(async move {
+                       super::setup_outbound(a_manager, b_pub, conn_b).await
+               });
+       }
+
+       #[tokio::test(flavor = "multi_thread")]
+       async fn threaded_race_disconnect_accept() {
+               race_disconnect_accept().await;
+       }
+
+       #[tokio::test]
+       async fn unthreaded_race_disconnect_accept() {
+               race_disconnect_accept().await;
+       }
 }