first commit

1 files changed, 289 insertions, 0 deletions

diff --git a/karyons_p2p/src/discovery/refresh.rs b/karyons_p2p/src/discovery/refresh.rs
new file mode 100644
index 0000000..7582c84
--- /dev/null
+++ b/karyons_p2p/src/discovery/refresh.rs
@@ -0,0 +1,289 @@
+use std::{sync::Arc, time::Duration};
+
+use bincode::{Decode, Encode};
+use log::{error, info, trace};
+use rand::{rngs::OsRng, RngCore};
+use smol::{
+    lock::{Mutex, RwLock},
+    stream::StreamExt,
+    Timer,
+};
+
+use karyons_core::{
+    async_utils::{timeout, Backoff, TaskGroup, TaskResult},
+    utils::{decode, encode},
+    Executor,
+};
+
+use karyons_net::{dial_udp, listen_udp, Addr, Connection, Endpoint, NetError, Port, UdpConn};
+
+/// Maximum failures for an entry before removing it from the routing table.
+pub const MAX_FAILURES: u32 = 3;
+
+/// Ping message size
+const PINGMSG_SIZE: usize = 32;
+
+use crate::{
+    monitor::{ConnEvent, DiscoveryEvent, Monitor},
+    routing_table::{BucketEntry, Entry, RoutingTable, PENDING_ENTRY, UNREACHABLE_ENTRY},
+    Config, Error, Result,
+};
+
+#[derive(Decode, Encode, Debug, Clone)]
+pub struct PingMsg(pub [u8; 32]);
+
+#[derive(Decode, Encode, Debug)]
+pub struct PongMsg(pub [u8; 32]);
+
+pub struct RefreshService {
+    /// Routing table
+    table: Arc<Mutex<RoutingTable>>,
+
+    /// Resolved listen endpoint
+    listen_endpoint: Option<RwLock<Endpoint>>,
+
+    /// Managing spawned tasks.
+    task_group: TaskGroup,
+
+    /// Holds the configuration for the P2P network.
+    config: Arc<Config>,
+
+    /// Responsible for network and system monitoring.
+    monitor: Arc<Monitor>,
+}
+
+impl RefreshService {
+    /// Creates a new refresh service
+    pub fn new(
+        config: Arc<Config>,
+        table: Arc<Mutex<RoutingTable>>,
+        monitor: Arc<Monitor>,
+    ) -> Self {
+        let listen_endpoint = config
+            .listen_endpoint
+            .as_ref()
+            .map(|endpoint| RwLock::new(endpoint.clone()));
+
+        Self {
+            table,
+            listen_endpoint,
+            task_group: TaskGroup::new(),
+            config,
+            monitor,
+        }
+    }
+
+    /// Start the refresh service
+    pub async fn start(self: &Arc<Self>, ex: Executor<'_>) -> Result<()> {
+        if let Some(endpoint) = &self.listen_endpoint {
+            let endpoint = endpoint.read().await;
+            let addr = endpoint.addr()?;
+            let port = self.config.discovery_port;
+
+            let selfc = self.clone();
+            self.task_group.spawn(
+                ex.clone(),
+                selfc.listen_loop(addr.clone(), port),
+                |res| async move {
+                    if let TaskResult::Completed(Err(err)) = res {
+                        error!("Listen loop stopped: {err}");
+                    }
+                },
+            );
+        }
+
+        let selfc = self.clone();
+        self.task_group.spawn(
+            ex.clone(),
+            selfc.refresh_loop(ex.clone()),
+            |res| async move {
+                if let TaskResult::Completed(Err(err)) = res {
+                    error!("Refresh loop stopped: {err}");
+                }
+            },
+        );
+
+        Ok(())
+    }
+
+    /// Set the resolved listen endpoint.
+    pub async fn set_listen_endpoint(&self, resolved_endpoint: &Endpoint) {
+        if let Some(endpoint) = &self.listen_endpoint {
+            *endpoint.write().await = resolved_endpoint.clone();
+        }
+    }
+
+    /// Shuts down the refresh service
+    pub async fn shutdown(&self) {
+        self.task_group.cancel().await;
+    }
+
+    /// Initiates periodic refreshing of the routing table. This function will
+    /// select 8 random entries from each bucket in the routing table and start
+    /// sending Ping messages to the entries.
+    async fn refresh_loop(self: Arc<Self>, ex: Executor<'_>) -> Result<()> {
+        let mut timer = Timer::interval(Duration::from_secs(self.config.refresh_interval));
+        loop {
+            timer.next().await;
+            trace!("Start refreshing the routing table...");
+
+            self.monitor
+                .notify(&DiscoveryEvent::RefreshStarted.into())
+                .await;
+
+            let table = self.table.lock().await;
+            let mut entries: Vec<BucketEntry> = vec![];
+            for bucket in table.iter() {
+                for entry in bucket.random_iter(8) {
+                    entries.push(entry.clone())
+                }
+            }
+            drop(table);
+
+            self.clone().do_refresh(&entries, ex.clone()).await;
+        }
+    }
+
+    /// Iterates over the entries and spawns a new task for each entry to
+    /// initiate a connection attempt to that entry.
+    async fn do_refresh(self: Arc<Self>, entries: &[BucketEntry], ex: Executor<'_>) {
+        for chunk in entries.chunks(16) {
+            let mut tasks = Vec::new();
+            for bucket_entry in chunk {
+                if bucket_entry.is_connected() {
+                    continue;
+                }
+
+                if bucket_entry.failures >= MAX_FAILURES {
+                    self.table
+                        .lock()
+                        .await
+                        .remove_entry(&bucket_entry.entry.key);
+                    return;
+                }
+
+                tasks.push(ex.spawn(self.clone().refresh_entry(bucket_entry.clone())))
+            }
+
+            for task in tasks {
+                task.await;
+            }
+        }
+    }
+
+    /// Initiates refresh for a specific entry within the routing table. It
+    /// updates the routing table according to the result.
+    async fn refresh_entry(self: Arc<Self>, bucket_entry: BucketEntry) {
+        let key = &bucket_entry.entry.key;
+        match self.connect(&bucket_entry.entry).await {
+            Ok(_) => {
+                self.table.lock().await.update_entry(key, PENDING_ENTRY);
+            }
+            Err(err) => {
+                trace!("Failed to refresh entry {:?}: {err}", key);
+                let table = &mut self.table.lock().await;
+                if bucket_entry.failures >= MAX_FAILURES {
+                    table.remove_entry(key);
+                    return;
+                }
+                table.update_entry(key, UNREACHABLE_ENTRY);
+            }
+        }
+    }
+
+    /// Initiates a UDP connection with the entry and attempts to send a Ping
+    /// message. If it fails, it retries according to the allowed retries
+    /// specified in the Config, with backoff between each retry.
+    async fn connect(&self, entry: &Entry) -> Result<()> {
+        let mut retry = 0;
+        let conn = dial_udp(&entry.addr, &entry.discovery_port).await?;
+        let backoff = Backoff::new(100, 5000);
+        while retry < self.config.refresh_connect_retries {
+            match self.send_ping_msg(&conn).await {
+                Ok(()) => return Ok(()),
+                Err(Error::KaryonsNet(NetError::Timeout)) => {
+                    retry += 1;
+                    backoff.sleep().await;
+                }
+                Err(err) => {
+                    return Err(err);
+                }
+            }
+        }
+
+        Err(NetError::Timeout.into())
+    }
+
+    /// Set up a UDP listener and start listening for Ping messages from other
+    /// peers.
+    async fn listen_loop(self: Arc<Self>, addr: Addr, port: Port) -> Result<()> {
+        let endpoint = Endpoint::Udp(addr.clone(), port);
+        let conn = match listen_udp(&addr, &port).await {
+            Ok(c) => {
+                self.monitor
+                    .notify(&ConnEvent::Listening(endpoint.clone()).into())
+                    .await;
+                c
+            }
+            Err(err) => {
+                self.monitor
+                    .notify(&ConnEvent::ListenFailed(endpoint.clone()).into())
+                    .await;
+                return Err(err.into());
+            }
+        };
+        info!("Start listening on {endpoint}");
+
+        loop {
+            let res = self.listen_to_ping_msg(&conn).await;
+            if let Err(err) = res {
+                trace!("Failed to handle ping msg {err}");
+                self.monitor.notify(&ConnEvent::AcceptFailed.into()).await;
+            }
+        }
+    }
+
+    /// Listen to receive a Ping message and respond with a Pong message.
+    async fn listen_to_ping_msg(&self, conn: &UdpConn) -> Result<()> {
+        let mut buf = [0; PINGMSG_SIZE];
+        let (_, endpoint) = conn.recv_from(&mut buf).await?;
+
+        self.monitor
+            .notify(&ConnEvent::Accepted(endpoint.clone()).into())
+            .await;
+
+        let (ping_msg, _) = decode::<PingMsg>(&buf)?;
+
+        let pong_msg = PongMsg(ping_msg.0);
+        let buffer = encode(&pong_msg)?;
+
+        conn.send_to(&buffer, &endpoint).await?;
+
+        self.monitor
+            .notify(&ConnEvent::Disconnected(endpoint.clone()).into())
+            .await;
+        Ok(())
+    }
+
+    /// Sends a Ping msg and wait to receive the Pong message.
+    async fn send_ping_msg(&self, conn: &UdpConn) -> Result<()> {
+        let mut nonce: [u8; 32] = [0; 32];
+        RngCore::fill_bytes(&mut OsRng, &mut nonce);
+
+        let ping_msg = PingMsg(nonce);
+        let buffer = encode(&ping_msg)?;
+        conn.send(&buffer).await?;
+
+        let buf = &mut [0; PINGMSG_SIZE];
+        let t = Duration::from_secs(self.config.refresh_response_timeout);
+        timeout(t, conn.recv(buf)).await??;
+
+        let (pong_msg, _) = decode::<PongMsg>(buf)?;
+
+        if ping_msg.0 != pong_msg.0 {
+            return Err(Error::InvalidPongMsg);
+        }
+
+        Ok(())
+    }
+}