track ddm state durations

Author: rcgoodfellow

Cargo.lock

@@ -14,7 +14,8 @@ progenitor::generate_api!(
     }),
     post_hook = (|log: &slog::Logger, result: &Result<_, _>| {
         slog::trace!(log, "client response"; "result" => ?result);
-    })
+    }),
+    replace = { Duration = std::time::Duration }
 );
 
 impl Copy for types::Ipv4Prefix {}

ddm-admin-client/src/lib.rs

@@ -2,7 +2,7 @@
 // License, v. 2.0. If a copy of the MPL was not distributed with this
 // file, You can obtain one at https://mozilla.org/MPL/2.0/.
 
-use crate::db::{Db, PeerInfo, TunnelRoute};
+use crate::db::{Db, RouterKind, TunnelRoute};
 use crate::exchange::PathVector;
 use crate::sm::{AdminEvent, Event, PrefixSet, SmContext};
 use dropshot::endpoint;
@@ -27,6 +27,7 @@ use std::sync::atomic::{AtomicU64, Ordering};
 use std::sync::mpsc::Sender;
 use std::sync::Arc;
 use std::sync::Mutex;
+use std::time::{Duration, Instant};
 use tokio::spawn;
 use tokio::task::JoinHandle;
 use uuid::Uuid;
@@ -103,12 +104,130 @@ pub fn handler(
     Ok(())
 }
 
+/// Status of a DDM peer with state expressed as durations.
+#[derive(
+    Debug, Copy, Clone, PartialEq, Eq, Deserialize, Serialize, JsonSchema,
+)]
+#[serde(tag = "type", content = "value")]
+pub enum PeerStatusV2 {
+    NoContact,
+    Init(Duration),
+    Solicit(Duration),
+    Exchange(Duration),
+    Expired(Duration),
+}
+
+// Translate internal peer status which is based on instants, to API
+// representation which is based on durations.
+impl From<crate::db::PeerStatus> for PeerStatusV2 {
+    fn from(value: crate::db::PeerStatus) -> Self {
+        match value {
+            crate::db::PeerStatus::NoContact => Self::NoContact,
+            crate::db::PeerStatus::Init(t) => {
+                Self::Init(Instant::now().duration_since(t))
+            }
+            crate::db::PeerStatus::Solicit(t) => {
+                Self::Solicit(Instant::now().duration_since(t))
+            }
+            crate::db::PeerStatus::Exchange(t) => {
+                Self::Exchange(Instant::now().duration_since(t))
+            }
+            crate::db::PeerStatus::Expired(t) => {
+                Self::Expired(Instant::now().duration_since(t))
+            }
+        }
+    }
+}
+
+/// Information about a DDM peer.
+#[derive(Debug, Clone, PartialEq, Eq, Deserialize, Serialize, JsonSchema)]
+pub struct PeerInfoV2 {
+    pub status: PeerStatusV2,
+    pub addr: Ipv6Addr,
+    pub host: String,
+    pub kind: RouterKind,
+}
+
+#[derive(
+    Debug, Copy, Clone, PartialEq, Eq, Serialize, Deserialize, JsonSchema,
+)]
+pub enum PeerStatus {
+    NoContact,
+    Active,
+    Expired,
+}
+
+// Translate internal peer status which is based on instants, to API
+// representation which is based on durations.
+impl From<crate::db::PeerStatus> for PeerStatus {
+    fn from(value: crate::db::PeerStatus) -> Self {
+        match value {
+            crate::db::PeerStatus::NoContact => Self::NoContact,
+            crate::db::PeerStatus::Init(_)
+            | crate::db::PeerStatus::Solicit(_)
+            | crate::db::PeerStatus::Exchange(_) => Self::Active,
+            crate::db::PeerStatus::Expired(_) => Self::Expired,
+        }
+    }
+}
+
+impl From<crate::db::PeerInfo> for PeerInfo {
+    fn from(value: crate::db::PeerInfo) -> Self {
+        Self {
+            status: value.status.into(),
+            addr: value.addr,
+            host: value.host,
+            kind: value.kind,
+        }
+    }
+}
+
+/// Information about a DDM peer.
+#[derive(Debug, Clone, PartialEq, Eq, Deserialize, Serialize, JsonSchema)]
+pub struct PeerInfo {
+    pub status: PeerStatus,
+    pub addr: Ipv6Addr,
+    pub host: String,
+    pub kind: RouterKind,
+}
+
+impl From<crate::db::PeerInfo> for PeerInfoV2 {
+    fn from(value: crate::db::PeerInfo) -> Self {
+        Self {
+            status: value.status.into(),
+            addr: value.addr,
+            host: value.host,
+            kind: value.kind,
+        }
+    }
+}
+
 #[endpoint { method = GET, path = "/peers" }]
 async fn get_peers(
     ctx: RequestContext<Arc<Mutex<HandlerContext>>>,
 ) -> Result<HttpResponseOk<HashMap<u32, PeerInfo>>, HttpError> {
     let ctx = ctx.context().lock().unwrap();
-    Ok(HttpResponseOk(ctx.db.peers()))
+    let peers = ctx
+        .db
+        .peers()
+        .into_iter()
+        .map(|(k, v)| (k, v.into()))
+        .collect();
+    Ok(HttpResponseOk(peers))
+}
+
+#[endpoint { method = GET, path = "/peers_v2" }]
+async fn get_peers_v2(
+    ctx: RequestContext<Arc<Mutex<HandlerContext>>>,
+) -> Result<HttpResponseOk<HashMap<u32, PeerInfoV2>>, HttpError> {
+    let ctx = ctx.context().lock().unwrap();
+    let peers = ctx
+        .db
+        .peers()
+        .into_iter()
+        .map(|(k, v)| (k, v.into()))
+        .collect();
+    Ok(HttpResponseOk(peers))
 }
 
 #[derive(Debug, Clone, Deserialize, Serialize, JsonSchema)]
@@ -422,6 +541,7 @@ pub fn api_description(
 ) -> Result<ApiDescription<Arc<Mutex<HandlerContext>>>, String> {
     let mut api = ApiDescription::new();
     api.register(get_peers)?;
+    api.register(get_peers_v2)?;
     api.register(expire_peer)?;
     api.register(advertise_prefixes)?;
     api.register(advertise_tunnel_endpoints)?;

ddm/src/admin.rs

@@ -6,10 +6,11 @@ use mg_common::net::{IpPrefix, Ipv6Prefix, TunnelOrigin};
 use schemars::{JsonSchema, JsonSchema_repr};
 use serde::{Deserialize, Serialize};
 use serde_repr::{Deserialize_repr, Serialize_repr};
-use slog::{error, Logger};
+use slog::{debug, error, Logger};
 use std::collections::{HashMap, HashSet};
 use std::net::Ipv6Addr;
 use std::sync::{Arc, Mutex};
+use std::time::Instant;
 
 /// The handle used to open a persistent key-value tree for originated
 /// prefixes.
@@ -227,10 +228,34 @@ impl Db {
 
     /// Set peer info at the given index. Returns true if peer information was
     /// changed.
-    pub fn set_peer(&self, index: u32, info: PeerInfo) -> bool {
-        match self.data.lock().unwrap().peers.insert(index, info.clone()) {
-            Some(previous) => previous == info,
-            None => true,
+    pub fn set_peer_info(
+        &self,
+        index: u32,
+        addr: Ipv6Addr,
+        host: String,
+        kind: RouterKind,
+    ) -> bool {
+        let mut data = self.data.lock().unwrap();
+        if let Some(peer) = data.peers.get_mut(&index) {
+            if peer.addr == addr && peer.host == host && peer.kind == kind {
+                false
+            } else {
+                peer.addr = addr;
+                peer.host = host;
+                peer.kind = kind;
+                true
+            }
+        } else {
+            data.peers.insert(
+                index,
+                PeerInfo {
+                    addr,
+                    host,
+                    kind,
+                    status: PeerStatus::Init(Instant::now()),
+                },
+            );
+            true
         }
     }
 
@@ -267,6 +292,19 @@ impl Db {
         self.data.lock().unwrap().peers.remove(&index);
     }
 
+    pub fn peer_status_transition(&self, index: u32, status: PeerStatus) {
+        if let Some(info) = self.data.lock().unwrap().peers.get_mut(&index) {
+            info.status = status;
+        } else {
+            // This is expected to happen during initialization as we don't
+            // add a peer to the db until an advertisement is received.
+            debug!(
+                self.log,
+                "status update: peer with index {} does not exist", index
+            );
+        }
+    }
+
     pub fn routes_by_vector(
         &self,
         dst: Ipv6Prefix,
@@ -283,16 +321,16 @@ impl Db {
     }
 }
 
-#[derive(
-    Debug, Copy, Clone, PartialEq, Eq, Deserialize, Serialize, JsonSchema,
-)]
+#[derive(Debug, Copy, Clone, PartialEq, Eq)]
 pub enum PeerStatus {
     NoContact,
-    Active,
-    Expired,
+    Init(Instant),
+    Solicit(Instant),
+    Exchange(Instant),
+    Expired(Instant),
 }
 
-#[derive(Clone, Debug, Serialize, Deserialize, JsonSchema, PartialEq)]
+#[derive(Clone, Debug, PartialEq)]
 pub struct PeerInfo {
     pub status: PeerStatus,
     pub addr: Ipv6Addr,

ddm/src/db.rs

@@ -85,7 +85,7 @@
 //! and 1 for a transit routers. The fourth byte is a hostname length followed
 //! directly by a hostname of up to 255 bytes in length.
 
-use crate::db::{Db, PeerInfo, PeerStatus, RouterKind};
+use crate::db::{Db, RouterKind};
 use crate::sm::{Config, Event, NeighborEvent, SessionStats};
 use crate::util::u8_slice_assume_init_ref;
 use crate::{dbg, err, inf, trc, wrn};
@@ -504,15 +504,9 @@ fn handle_advertisement(
         }
     };
     drop(guard);
-    let updated = ctx.db.set_peer(
-        ctx.config.if_index,
-        PeerInfo {
-            status: PeerStatus::Active,
-            addr: *sender,
-            host: hostname,
-            kind,
-        },
-    );
+    let updated =
+        ctx.db
+            .set_peer_info(ctx.config.if_index, *sender, hostname, kind);
     if updated {
         stats.peer_address.lock().unwrap().replace(*sender);
         emit_nbr_update(ctx, sender, version);

ddm/src/discovery.rs

@@ -2,7 +2,7 @@
 // License, v. 2.0. If a copy of the MPL was not distributed with this
 // file, You can obtain one at https://mozilla.org/MPL/2.0/.
 
-use crate::db::{Db, RouterKind};
+use crate::db::{Db, PeerStatus, RouterKind};
 use crate::discovery::Version;
 use crate::exchange::{PathVector, TunnelUpdate, UnderlayUpdate, Update};
 use crate::{dbg, discovery, err, exchange, inf, wrn};
@@ -16,7 +16,7 @@ use std::sync::mpsc::{Receiver, Sender};
 use std::sync::{Arc, Mutex};
 use std::thread::sleep;
 use std::thread::spawn;
-use std::time::Duration;
+use std::time::{Duration, Instant};
 use thiserror::Error;
 
 #[derive(Debug)]
@@ -228,6 +228,10 @@ impl State for Init {
         &mut self,
         event: Receiver<Event>,
     ) -> (Box<dyn State>, Receiver<Event>) {
+        self.ctx.db.peer_status_transition(
+            self.ctx.config.if_index,
+            PeerStatus::Init(Instant::now()),
+        );
         loop {
             let info = match get_ipaddr_info(&self.ctx.config.aobj_name) {
                 Ok(info) => info,
@@ -303,6 +307,10 @@ impl State for Solicit {
         &mut self,
         event: Receiver<Event>,
     ) -> (Box<dyn State>, Receiver<Event>) {
+        self.ctx.db.peer_status_transition(
+            self.ctx.config.if_index,
+            PeerStatus::Solicit(Instant::now()),
+        );
         loop {
             let e = match event.recv() {
                 Ok(e) => e,
@@ -529,6 +537,10 @@ impl State for Exchange {
         &mut self,
         event: Receiver<Event>,
     ) -> (Box<dyn State>, Receiver<Event>) {
+        self.ctx.db.peer_status_transition(
+            self.ctx.config.if_index,
+            PeerStatus::Exchange(Instant::now()),
+        );
         let exchange_thread = loop {
             match exchange::handler(
                 self.ctx.clone(),
@@ -759,7 +771,6 @@ impl State for Exchange {
                         );
                     }
                 }
-                // TODO tunnel
                 Event::Peer(PeerEvent::Push(update)) => {
                     inf!(
                         self.log,

ddm/src/sm.rs

@@ -17,3 +17,4 @@ tabwriter.workspace = true
 colored.workspace = true
 anyhow.workspace = true
 anstyle.workspace = true
+humantime.workspace = true