solana_net_utils/
ip_echo_server.rs

1use {
2    crate::{bind_to_unspecified, HEADER_LENGTH, IP_ECHO_SERVER_RESPONSE_LENGTH},
3    log::*,
4    serde_derive::{Deserialize, Serialize},
5    solana_serde::default_on_eof,
6    std::{
7        io,
8        net::{IpAddr, SocketAddr},
9        num::NonZeroUsize,
10        time::Duration,
11    },
12    tokio::{
13        io::{AsyncReadExt, AsyncWriteExt},
14        net::{TcpListener, TcpStream},
15        runtime::{self, Runtime},
16        time::timeout,
17    },
18};
19
20pub type IpEchoServer = Runtime;
21
22// Enforce a minimum of two threads:
23// - One thread to monitor the TcpListener and spawn async tasks
24// - One thread to service the spawned tasks
25pub const MINIMUM_IP_ECHO_SERVER_THREADS: NonZeroUsize = NonZeroUsize::new(2).unwrap();
26// IP echo requests require little computation and come in fairly infrequently,
27// so keep the number of server workers small to avoid overhead
28pub const DEFAULT_IP_ECHO_SERVER_THREADS: NonZeroUsize = MINIMUM_IP_ECHO_SERVER_THREADS;
29pub const MAX_PORT_COUNT_PER_MESSAGE: usize = 4;
30
31const IO_TIMEOUT: Duration = Duration::from_secs(5);
32
33#[derive(Serialize, Deserialize, Default, Debug)]
34pub(crate) struct IpEchoServerMessage {
35    tcp_ports: [u16; MAX_PORT_COUNT_PER_MESSAGE], // Fixed size list of ports to avoid vec serde
36    udp_ports: [u16; MAX_PORT_COUNT_PER_MESSAGE], // Fixed size list of ports to avoid vec serde
37}
38
39#[derive(Debug, PartialEq, Eq, Serialize, Deserialize)]
40pub struct IpEchoServerResponse {
41    // Public IP address of request echoed back to the node.
42    pub(crate) address: IpAddr,
43    // Cluster shred-version of the node running the server.
44    #[serde(deserialize_with = "default_on_eof")]
45    pub(crate) shred_version: Option<u16>,
46}
47
48impl IpEchoServerMessage {
49    pub fn new(tcp_ports: &[u16], udp_ports: &[u16]) -> Self {
50        let mut msg = Self::default();
51        assert!(tcp_ports.len() <= msg.tcp_ports.len());
52        assert!(udp_ports.len() <= msg.udp_ports.len());
53
54        msg.tcp_ports[..tcp_ports.len()].copy_from_slice(tcp_ports);
55        msg.udp_ports[..udp_ports.len()].copy_from_slice(udp_ports);
56        msg
57    }
58}
59
60pub(crate) fn ip_echo_server_request_length() -> usize {
61    const REQUEST_TERMINUS_LENGTH: usize = 1;
62    (HEADER_LENGTH + REQUEST_TERMINUS_LENGTH)
63        .wrapping_add(bincode::serialized_size(&IpEchoServerMessage::default()).unwrap() as usize)
64}
65
66async fn process_connection(
67    mut socket: TcpStream,
68    peer_addr: SocketAddr,
69    shred_version: Option<u16>,
70) -> io::Result<()> {
71    info!("connection from {:?}", peer_addr);
72
73    let mut data = vec![0u8; ip_echo_server_request_length()];
74
75    let mut writer = {
76        let (mut reader, writer) = socket.split();
77        let _ = timeout(IO_TIMEOUT, reader.read_exact(&mut data)).await??;
78        writer
79    };
80
81    let request_header: String = data[0..HEADER_LENGTH].iter().map(|b| *b as char).collect();
82    if request_header != "\0\0\0\0" {
83        // Explicitly check for HTTP GET/POST requests to more gracefully handle
84        // the case where a user accidentally tried to use a gossip entrypoint in
85        // place of a JSON RPC URL:
86        if request_header == "GET " || request_header == "POST" {
87            // Send HTTP error response
88            timeout(
89                IO_TIMEOUT,
90                writer.write_all(b"HTTP/1.1 400 Bad Request\nContent-length: 0\n\n"),
91            )
92            .await??;
93            return Ok(());
94        }
95        return Err(io::Error::new(
96            io::ErrorKind::Other,
97            format!("Bad request header: {request_header}"),
98        ));
99    }
100
101    let msg =
102        bincode::deserialize::<IpEchoServerMessage>(&data[HEADER_LENGTH..]).map_err(|err| {
103            io::Error::new(
104                io::ErrorKind::Other,
105                format!("Failed to deserialize IpEchoServerMessage: {err:?}"),
106            )
107        })?;
108
109    trace!("request: {:?}", msg);
110
111    // Fire a datagram at each non-zero UDP port
112    match bind_to_unspecified() {
113        Ok(udp_socket) => {
114            for udp_port in &msg.udp_ports {
115                if *udp_port != 0 {
116                    match udp_socket.send_to(&[0], SocketAddr::from((peer_addr.ip(), *udp_port))) {
117                        Ok(_) => debug!("Successful send_to udp/{}", udp_port),
118                        Err(err) => info!("Failed to send_to udp/{}: {}", udp_port, err),
119                    }
120                }
121            }
122        }
123        Err(err) => {
124            warn!("Failed to bind local udp socket: {}", err);
125        }
126    }
127
128    // Try to connect to each non-zero TCP port
129    for tcp_port in &msg.tcp_ports {
130        if *tcp_port != 0 {
131            debug!("Connecting to tcp/{}", tcp_port);
132
133            let mut tcp_stream = timeout(
134                IO_TIMEOUT,
135                TcpStream::connect(&SocketAddr::new(peer_addr.ip(), *tcp_port)),
136            )
137            .await??;
138
139            debug!("Connection established to tcp/{}", *tcp_port);
140            tcp_stream.shutdown().await?;
141        }
142    }
143    let response = IpEchoServerResponse {
144        address: peer_addr.ip(),
145        shred_version,
146    };
147    // "\0\0\0\0" header is added to ensure a valid response will never
148    // conflict with the first four bytes of a valid HTTP response.
149    let mut bytes = vec![0u8; IP_ECHO_SERVER_RESPONSE_LENGTH];
150    bincode::serialize_into(&mut bytes[HEADER_LENGTH..], &response).unwrap();
151    trace!("response: {:?}", bytes);
152    writer.write_all(&bytes).await
153}
154
155async fn run_echo_server(tcp_listener: std::net::TcpListener, shred_version: Option<u16>) {
156    info!("bound to {:?}", tcp_listener.local_addr().unwrap());
157    let tcp_listener =
158        TcpListener::from_std(tcp_listener).expect("Failed to convert std::TcpListener");
159
160    loop {
161        match tcp_listener.accept().await {
162            Ok((socket, peer_addr)) => {
163                runtime::Handle::current().spawn(async move {
164                    if let Err(err) = process_connection(socket, peer_addr, shred_version).await {
165                        info!("session failed: {:?}", err);
166                    }
167                });
168            }
169            Err(err) => warn!("listener accept failed: {:?}", err),
170        }
171    }
172}
173
174/// Starts a simple TCP server that echos the IP address of any peer that connects
175/// Used by functions like |get_public_ip_addr| and |get_cluster_shred_version|
176pub fn ip_echo_server(
177    tcp_listener: std::net::TcpListener,
178    num_server_threads: NonZeroUsize,
179    // Cluster shred-version of the node running the server.
180    shred_version: Option<u16>,
181) -> IpEchoServer {
182    tcp_listener.set_nonblocking(true).unwrap();
183
184    let runtime = tokio::runtime::Builder::new_multi_thread()
185        .thread_name("solIpEchoSrvrRt")
186        .worker_threads(num_server_threads.get())
187        .enable_all()
188        .build()
189        .expect("new tokio runtime");
190    runtime.spawn(run_echo_server(tcp_listener, shred_version));
191    runtime
192}
solana_net_utils/ip_echo_server.rs

solana_net_utils/
ip_echo_server.rs
