rtnetlink: add replace option to Add*Request

This option sets the NLM_F_REPLACE instead of the NLM_F_EXCL flag, allowing "create or update" patterns.
little-dude · Nov 25, 2021 · e4b41a6 · e4b41a6
1 parent d3be2ce
commit e4b41a6
Show file tree

Hide file tree

Showing 5 changed files with 79 additions and 7 deletions.
diff --git a/rtnetlink/src/addr/add.rs b/rtnetlink/src/addr/add.rs
@@ -13,6 +13,7 @@ use netlink_packet_route::{
     NLM_F_ACK,
     NLM_F_CREATE,
     NLM_F_EXCL,
+    NLM_F_REPLACE,
     NLM_F_REQUEST,
 };
 
@@ -22,6 +23,7 @@ use crate::{try_nl, Error, Handle};
 pub struct AddressAddRequest {
     handle: Handle,
     message: AddressMessage,
+    replace: bool,
 }
 
 impl AddressAddRequest {
@@ -68,17 +70,31 @@ impl AddressAddRequest {
                 message.nlas.push(Nla::Broadcast(brd.octets().to_vec()));
             };
         }
-        AddressAddRequest { handle, message }
+        AddressAddRequest {
+            handle,
+            message,
+            replace: false,
+        }
+    }
+
+    /// Replace existing matching address.
+    pub fn replace(self) -> Self {
+        Self {
+            replace: true,
+            ..self
+        }
     }
 
     /// Execute the request.
     pub async fn execute(self) -> Result<(), Error> {
         let AddressAddRequest {
             mut handle,
             message,
+            replace,
         } = self;
         let mut req = NetlinkMessage::from(RtnlMessage::NewAddress(message));
-        req.header.flags = NLM_F_REQUEST | NLM_F_ACK | NLM_F_EXCL | NLM_F_CREATE;
+        let replace = if replace { NLM_F_REPLACE } else { NLM_F_EXCL };
+        req.header.flags = NLM_F_REQUEST | NLM_F_ACK | replace | NLM_F_CREATE;
 
         let mut response = handle.request(req)?;
         while let Some(message) = response.next().await {

diff --git a/rtnetlink/src/link/add.rs b/rtnetlink/src/link/add.rs
@@ -12,6 +12,7 @@ use crate::{
         NLM_F_ACK,
         NLM_F_CREATE,
         NLM_F_EXCL,
+        NLM_F_REPLACE,
         NLM_F_REQUEST,
     },
     try_nl,
@@ -246,13 +247,15 @@ impl VxlanAddRequest {
 pub struct LinkAddRequest {
     handle: Handle,
     message: LinkMessage,
+    replace: bool,
 }
 
 impl LinkAddRequest {
     pub(crate) fn new(handle: Handle) -> Self {
         LinkAddRequest {
             handle,
             message: LinkMessage::default(),
+            replace: false,
         }
     }
 
@@ -261,9 +264,11 @@ impl LinkAddRequest {
         let LinkAddRequest {
             mut handle,
             message,
+            replace,
         } = self;
         let mut req = NetlinkMessage::from(RtnlMessage::NewLink(message));
-        req.header.flags = NLM_F_REQUEST | NLM_F_ACK | NLM_F_EXCL | NLM_F_CREATE;
+        let replace = if replace { NLM_F_REPLACE } else { NLM_F_EXCL };
+        req.header.flags = NLM_F_REQUEST | NLM_F_ACK | replace | NLM_F_CREATE;
 
         let mut response = handle.request(req)?;
         while let Some(message) = response.next().await {
@@ -369,6 +374,14 @@ impl LinkAddRequest {
             .append_nla(Nla::IfName(name))
     }
 
+    /// Replace existing matching link.
+    pub fn replace(self) -> Self {
+        Self {
+            replace: true,
+            ..self
+        }
+    }
+
     fn up(mut self) -> Self {
         self.message.header.flags = IFF_UP;
         self.message.header.change_mask = IFF_UP;

diff --git a/rtnetlink/src/neighbour/add.rs b/rtnetlink/src/neighbour/add.rs
@@ -17,6 +17,7 @@ use std::net::IpAddr;
 pub struct NeighbourAddRequest {
     handle: Handle,
     message: NeighbourMessage,
+    replace: bool,
 }
 
 impl NeighbourAddRequest {
@@ -37,7 +38,11 @@ impl NeighbourAddRequest {
             IpAddr::V6(v6) => v6.octets().to_vec(),
         }));
 
-        NeighbourAddRequest { handle, message }
+        NeighbourAddRequest {
+            handle,
+            message,
+            replace: false,
+        }
     }
 
     /// Set a bitmask of states for the neighbor cache entry.
@@ -67,15 +72,25 @@ impl NeighbourAddRequest {
         self
     }
 
+    /// Replace existing matching neighbor.
+    pub fn replace(self) -> Self {
+        Self {
+            replace: true,
+            ..self
+        }
+    }
+
     /// Execute the request.
     pub async fn execute(self) -> Result<(), Error> {
         let NeighbourAddRequest {
             mut handle,
             message,
+            replace,
         } = self;
 
         let mut req = NetlinkMessage::from(RtnlMessage::NewNeighbour(message));
-        req.header.flags = NLM_F_REQUEST | NLM_F_ACK | NLM_F_EXCL | NLM_F_CREATE;
+        let replace = if replace { NLM_F_REPLACE } else { NLM_F_EXCL };
+        req.header.flags = NLM_F_REQUEST | NLM_F_ACK | replace | NLM_F_CREATE;
 
         let mut response = handle.request(req)?;
         while let Some(message) = response.next().await {

diff --git a/rtnetlink/src/route/add.rs b/rtnetlink/src/route/add.rs
@@ -20,6 +20,7 @@ use crate::{try_nl, Error, Handle};
 pub struct RouteAddRequest<T = ()> {
     handle: Handle,
     message: RouteMessage,
+    replace: bool,
     _phantom: PhantomData<T>,
 }
 
@@ -35,6 +36,7 @@ impl<T> RouteAddRequest<T> {
         RouteAddRequest {
             handle,
             message,
+            replace: false,
             _phantom: Default::default(),
         }
     }
@@ -89,6 +91,7 @@ impl<T> RouteAddRequest<T> {
         RouteAddRequest {
             handle: self.handle,
             message: self.message,
+            replace: false,
             _phantom: Default::default(),
         }
     }
@@ -99,19 +102,30 @@ impl<T> RouteAddRequest<T> {
         RouteAddRequest {
             handle: self.handle,
             message: self.message,
+            replace: false,
             _phantom: Default::default(),
         }
     }
 
+    /// Replace existing matching route.
+    pub fn replace(self) -> Self {
+        Self {
+            replace: true,
+            ..self
+        }
+    }
+
     /// Execute the request.
     pub async fn execute(self) -> Result<(), Error> {
         let RouteAddRequest {
             mut handle,
             message,
+            replace,
             ..
         } = self;
         let mut req = NetlinkMessage::from(RtnlMessage::NewRoute(message));
-        req.header.flags = NLM_F_REQUEST | NLM_F_ACK | NLM_F_EXCL | NLM_F_CREATE;
+        let replace = if replace { NLM_F_REPLACE } else { NLM_F_EXCL };
+        req.header.flags = NLM_F_REQUEST | NLM_F_ACK | replace | NLM_F_CREATE;
 
         let mut response = handle.request(req)?;
         while let Some(message) = response.next().await {

diff --git a/rtnetlink/src/rule/add.rs b/rtnetlink/src/rule/add.rs
@@ -20,6 +20,7 @@ use crate::{try_nl, Error, Handle};
 pub struct RuleAddRequest<T = ()> {
     handle: Handle,
     message: RuleMessage,
+    replace: bool,
     _phantom: PhantomData<T>,
 }
 
@@ -33,6 +34,7 @@ impl<T> RuleAddRequest<T> {
         RuleAddRequest {
             handle,
             message,
+            replace: false,
             _phantom: Default::default(),
         }
     }
@@ -75,6 +77,7 @@ impl<T> RuleAddRequest<T> {
         RuleAddRequest {
             handle: self.handle,
             message: self.message,
+            replace: false,
             _phantom: Default::default(),
         }
     }
@@ -85,19 +88,30 @@ impl<T> RuleAddRequest<T> {
         RuleAddRequest {
             handle: self.handle,
             message: self.message,
+            replace: false,
             _phantom: Default::default(),
         }
     }
 
+    /// Replace existing matching rule.
+    pub fn replace(self) -> Self {
+        Self {
+            replace: true,
+            ..self
+        }
+    }
+
     /// Execute the request.
     pub async fn execute(self) -> Result<(), Error> {
         let RuleAddRequest {
             mut handle,
             message,
+            replace,
             ..
         } = self;
         let mut req = NetlinkMessage::from(RtnlMessage::NewRule(message));
-        req.header.flags = NLM_F_REQUEST | NLM_F_ACK | NLM_F_EXCL | NLM_F_CREATE;
+        let replace = if replace { NLM_F_REPLACE } else { NLM_F_EXCL };
+        req.header.flags = NLM_F_REQUEST | NLM_F_ACK | replace | NLM_F_CREATE;
 
         let mut response = handle.request(req)?;
         while let Some(message) = response.next().await {