openthread/ot/
border_router.rs

1// Copyright 2021 The Fuchsia Authors. All rights reserved.
2// Use of this source code is governed by a BSD-style license that can be
3// found in the LICENSE file.
4
5use crate::ot::WrongSize;
6use crate::prelude_internal::*;
7use core::pin::Pin;
8use core::task::{Context, Poll};
9use fuchsia_sync::Mutex;
10use std::sync::Arc;
11use std::task::Waker;
12
13/// Iterator type for external routes.
14#[allow(missing_debug_implementations)]
15pub struct LocalExternalRouteIterator<'a, T: ?Sized> {
16    ot_instance: &'a T,
17    ot_iter: otNetworkDataIterator,
18}
19
20impl<T: ?Sized + BorderRouter> Iterator for LocalExternalRouteIterator<'_, T> {
21    type Item = ExternalRouteConfig;
22    fn next(&mut self) -> Option<Self::Item> {
23        self.ot_instance.iter_next_local_external_route(&mut self.ot_iter)
24    }
25}
26
27/// Iterator type for on-mesh prefixes.
28#[allow(missing_debug_implementations)]
29pub struct LocalOnMeshPrefixIterator<'a, T: ?Sized> {
30    ot_instance: &'a T,
31    ot_iter: otNetworkDataIterator,
32}
33
34impl<T: ?Sized + BorderRouter> Iterator for LocalOnMeshPrefixIterator<'_, T> {
35    type Item = BorderRouterConfig;
36    fn next(&mut self) -> Option<Self::Item> {
37        self.ot_instance.iter_next_local_on_mesh_prefix(&mut self.ot_iter)
38    }
39}
40
41/// Methods from the [OpenThread "Border Router" Module][1].
42///
43/// [1]: https://openthread.io/reference/group/api-border-router
44pub trait BorderRouter {
45    /// Functional equivalent of
46    /// [`otsys::otBorderRouterAddRoute`](crate::otsys::otBorderRouterAddRoute).
47    fn add_external_route(&self, route: &ExternalRouteConfig) -> Result;
48
49    /// Functional equivalent of
50    /// [`otsys::otBorderRouterAddOnMeshPrefix`](crate::otsys::otBorderRouterAddOnMeshPrefix).
51    fn add_on_mesh_prefix(&self, route: &BorderRouterConfig) -> Result;
52
53    /// Functional equivalent of
54    /// [`otsys::otBorderRouterRemoveRoute`](crate::otsys::otBorderRouterRemoveRoute).
55    fn remove_external_route(&self, prefix: &Ip6Prefix) -> Result;
56
57    /// Functional equivalent of
58    /// [`otsys::otBorderRouterRemoveOnMeshPrefix`](crate::otsys::otBorderRouterRemoveOnMeshPrefix).
59    fn remove_on_mesh_prefix(&self, prefix: &Ip6Prefix) -> Result;
60
61    /// Functional equivalent of
62    /// [`otsys::otBorderRouterRegister`](crate::otsys::otBorderRouterRegister).
63    fn border_router_register(&self) -> Result;
64
65    /// Functional equivalent of
66    /// [`otsys::otBorderRoutingInit`](crate::otsys::otBorderRoutingInit).
67    fn border_routing_init(&self, infra_if: u32, infra_is_running: bool) -> Result;
68
69    /// Functional equivalent of
70    /// [`otsys::otBorderRoutingSetEnabled`](crate::otsys::otBorderRoutingSetEnabled).
71    fn border_routing_set_enabled(&self, enabled: bool) -> Result;
72
73    /// Functional equivalent of
74    /// [`otsys::otBorderRoutingDhcp6PdSetEnabled`](crate::otsys::otBorderRoutingDhcp6PdSetEnabled).
75    fn border_routing_dhcp6_pd_set_enabled(&self, enabled: bool);
76
77    /// Functional equivalent of
78    /// [`otsys::otBorderRoutingDhcp6PdGetState`](crate::otsys::otBorderRoutingDhcp6PdGetState).
79    fn border_routing_dhcp6_pd_get_state(&self) -> BorderRoutingDhcp6PdState;
80
81    /// Functional equivalent of
82    /// [`otsys::otBorderRoutingDhcp6PdSetRequestCallback`](crate::otsys::otBorderRoutingDhcp6PdSetRequestCallback).
83    fn border_routing_dhcp6_pd_set_request_fn<'a, F>(&'a self, f: Option<F>)
84    where
85        F: FnMut(BorderRoutingDhcp6PdState) + 'a;
86
87    /// Get the DHCPv6 PD state change stream
88    fn border_routing_dhcp6_pd_state_change_stream(&self)
89        -> BorderRoutingDhcp6PdStateChangedStream;
90
91    /// Functional equivalent of
92    /// [`otsys::otBorderRoutingGetPdOmrPrefix`](crate::otsys::otBorderRoutingGetPdOmrPrefix).
93    fn border_routing_get_pd_omr_prefix(&self) -> Result<ot::BorderRoutingPrefixTableEntry>;
94
95    /// Functional equivalent of
96    /// [`otsys::otBorderRoutingGetOmrPrefix`](crate::otsys::otBorderRoutingGetOmrPrefix).
97    fn border_routing_get_omr_prefix(&self) -> Result<ot::Ip6Prefix>;
98
99    /// Functional equivalent of
100    /// [`otsys::otBorderRoutingGetOnLinkPrefix`](crate::otsys::otBorderRoutingGetOnLinkPrefix).
101    fn border_routing_get_on_link_prefix(&self) -> Result<ot::Ip6Prefix>;
102
103    /// Functional equivalent of
104    /// [`otsys::otPlatBorderRoutingProcessIcmp6Ra`](crate::otsys::otPlatBorderRoutingProcessIcmp6Ra).
105    fn border_routing_process_icmp6_ra(&self, message: &[u8]) -> Result<(), WrongSize>;
106
107    /// Functional equivalent of
108    /// [`otsys::otBorderRoutingGetPdProcessedRaInfo`](crate::otsys::otBorderRoutingGetPdProcessedRaInfo).
109    fn border_routing_get_pd_processed_ra_info(&self) -> PdProcessedRaInfo;
110
111    /// Functional equivalent of
112    /// [`otsys::otBorderRouterGetNextRoute`](crate::otsys::otBorderRouterGetNextRoute).
113    // TODO: Determine if the underlying implementation of
114    //       this method has undefined behavior when network data
115    //       is being mutated while iterating. If it is undefined,
116    //       we may need to make it unsafe and provide a safe method
117    //       that collects the results.
118    fn iter_next_local_external_route(
119        &self,
120        ot_iter: &mut otNetworkDataIterator,
121    ) -> Option<ExternalRouteConfig>;
122
123    /// Functional equivalent of
124    /// [`otsys::otBorderRouterGetNextOnMeshPrefix`](crate::otsys::otBorderRouterGetNextOnMeshPrefix).
125    // TODO: Determine if the underlying implementation of
126    //       this method has undefined behavior when network data
127    //       is being mutated while iterating. If it is undefined,
128    //       we may need to make it unsafe and provide a safe method
129    //       that collects the results.
130    fn iter_next_local_on_mesh_prefix(
131        &self,
132        ot_iter: &mut otNetworkDataIterator,
133    ) -> Option<BorderRouterConfig>;
134
135    /// Returns an iterator for iterating over external routes.
136    fn iter_local_external_routes(&self) -> LocalExternalRouteIterator<'_, Self> {
137        LocalExternalRouteIterator { ot_instance: self, ot_iter: OT_NETWORK_DATA_ITERATOR_INIT }
138    }
139
140    /// Returns an iterator for iterating over on-mesh prefixes
141    fn iter_local_on_mesh_prefixes(&self) -> LocalOnMeshPrefixIterator<'_, Self> {
142        LocalOnMeshPrefixIterator { ot_instance: self, ot_iter: OT_NETWORK_DATA_ITERATOR_INIT }
143    }
144}
145
146impl<T: BorderRouter + Boxable> BorderRouter for ot::Box<T> {
147    fn add_external_route(&self, route: &ExternalRouteConfig) -> Result {
148        self.as_ref().add_external_route(route)
149    }
150
151    fn add_on_mesh_prefix(&self, route: &BorderRouterConfig) -> Result {
152        self.as_ref().add_on_mesh_prefix(route)
153    }
154
155    fn remove_external_route(&self, prefix: &Ip6Prefix) -> Result {
156        self.as_ref().remove_external_route(prefix)
157    }
158
159    fn remove_on_mesh_prefix(&self, prefix: &Ip6Prefix) -> Result {
160        self.as_ref().remove_on_mesh_prefix(prefix)
161    }
162
163    fn border_router_register(&self) -> Result {
164        self.as_ref().border_router_register()
165    }
166
167    fn border_routing_init(&self, infra_if: u32, infra_is_running: bool) -> Result {
168        self.as_ref().border_routing_init(infra_if, infra_is_running)
169    }
170
171    fn border_routing_set_enabled(&self, enabled: bool) -> Result {
172        self.as_ref().border_routing_set_enabled(enabled)
173    }
174
175    fn border_routing_dhcp6_pd_set_enabled(&self, enabled: bool) {
176        self.as_ref().border_routing_dhcp6_pd_set_enabled(enabled)
177    }
178
179    fn border_routing_dhcp6_pd_get_state(&self) -> BorderRoutingDhcp6PdState {
180        self.as_ref().border_routing_dhcp6_pd_get_state()
181    }
182
183    fn border_routing_dhcp6_pd_set_request_fn<'a, F>(&'a self, f: Option<F>)
184    where
185        F: FnMut(BorderRoutingDhcp6PdState) + 'a,
186    {
187        self.as_ref().border_routing_dhcp6_pd_set_request_fn(f)
188    }
189
190    fn border_routing_dhcp6_pd_state_change_stream(
191        &self,
192    ) -> BorderRoutingDhcp6PdStateChangedStream {
193        self.as_ref().border_routing_dhcp6_pd_state_change_stream()
194    }
195
196    fn border_routing_get_pd_omr_prefix(&self) -> Result<ot::BorderRoutingPrefixTableEntry> {
197        self.as_ref().border_routing_get_pd_omr_prefix()
198    }
199
200    fn border_routing_get_omr_prefix(&self) -> Result<ot::Ip6Prefix> {
201        self.as_ref().border_routing_get_omr_prefix()
202    }
203
204    fn border_routing_get_on_link_prefix(&self) -> Result<ot::Ip6Prefix> {
205        self.as_ref().border_routing_get_on_link_prefix()
206    }
207
208    fn border_routing_process_icmp6_ra(&self, message: &[u8]) -> Result<(), WrongSize> {
209        self.as_ref().border_routing_process_icmp6_ra(message)
210    }
211
212    fn border_routing_get_pd_processed_ra_info(&self) -> PdProcessedRaInfo {
213        self.as_ref().border_routing_get_pd_processed_ra_info()
214    }
215
216    fn iter_next_local_external_route(
217        &self,
218        ot_iter: &mut otNetworkDataIterator,
219    ) -> Option<ExternalRouteConfig> {
220        self.as_ref().iter_next_local_external_route(ot_iter)
221    }
222
223    fn iter_next_local_on_mesh_prefix(
224        &self,
225        ot_iter: &mut otNetworkDataIterator,
226    ) -> Option<BorderRouterConfig> {
227        self.as_ref().iter_next_local_on_mesh_prefix(ot_iter)
228    }
229}
230
231impl BorderRouter for Instance {
232    fn add_external_route(&self, route: &ExternalRouteConfig) -> Result {
233        Error::from(unsafe { otBorderRouterAddRoute(self.as_ot_ptr(), route.as_ot_ptr()) }).into()
234    }
235
236    fn add_on_mesh_prefix(&self, route: &BorderRouterConfig) -> Result {
237        Error::from(unsafe { otBorderRouterAddOnMeshPrefix(self.as_ot_ptr(), route.as_ot_ptr()) })
238            .into()
239    }
240
241    fn remove_external_route(&self, prefix: &Ip6Prefix) -> Result {
242        Error::from(unsafe { otBorderRouterRemoveRoute(self.as_ot_ptr(), prefix.as_ot_ptr()) })
243            .into()
244    }
245
246    fn remove_on_mesh_prefix(&self, prefix: &Ip6Prefix) -> Result {
247        Error::from(unsafe {
248            otBorderRouterRemoveOnMeshPrefix(self.as_ot_ptr(), prefix.as_ot_ptr())
249        })
250        .into()
251    }
252
253    fn border_router_register(&self) -> Result {
254        Error::from(unsafe { otBorderRouterRegister(self.as_ot_ptr()) }).into()
255    }
256
257    fn border_routing_init(&self, infra_if: u32, infra_is_running: bool) -> Result {
258        Error::from(unsafe { otBorderRoutingInit(self.as_ot_ptr(), infra_if, infra_is_running) })
259            .into()
260    }
261
262    fn border_routing_set_enabled(&self, enabled: bool) -> Result {
263        Error::from(unsafe { otBorderRoutingSetEnabled(self.as_ot_ptr(), enabled) }).into()
264    }
265
266    fn border_routing_dhcp6_pd_set_enabled(&self, enabled: bool) {
267        unsafe { otBorderRoutingDhcp6PdSetEnabled(self.as_ot_ptr(), enabled) }
268    }
269
270    fn border_routing_dhcp6_pd_get_state(&self) -> BorderRoutingDhcp6PdState {
271        BorderRoutingDhcp6PdState::from_isize(unsafe {
272            otBorderRoutingDhcp6PdGetState(self.as_ot_ptr())
273        } as isize)
274        .unwrap_or(BorderRoutingDhcp6PdState::Disabled)
275    }
276
277    fn border_routing_dhcp6_pd_set_request_fn<'a, F>(&'a self, f: Option<F>)
278    where
279        F: FnMut(BorderRoutingDhcp6PdState) + 'a,
280    {
281        unsafe extern "C" fn _ot_border_routing_dhcp6_pd_state_change_callback<
282            'a,
283            F: FnMut(BorderRoutingDhcp6PdState) + 'a,
284        >(
285            state: otBorderRoutingDhcp6PdState,
286            context: *mut ::std::os::raw::c_void,
287        ) {
288            trace!("_ot_border_routing_dhcp6_pd_state_change_callback");
289
290            // Convert `otBorderRoutingDhcp6PdState` to `BorderRoutingDhcp6PdState`
291            let state = BorderRoutingDhcp6PdState::from(state);
292
293            // Reconstitute a reference to our closure.
294            let sender = &mut *(context as *mut F);
295
296            sender(state)
297        }
298
299        let (fn_ptr, fn_box, cb): (_, _, otBorderRoutingRequestDhcp6PdCallback) = if let Some(f) = f
300        {
301            let mut x = Box::new(f);
302
303            (
304                x.as_mut() as *mut F as *mut ::std::os::raw::c_void,
305                Some(x as Box<dyn FnMut(BorderRoutingDhcp6PdState) + 'a>),
306                Some(_ot_border_routing_dhcp6_pd_state_change_callback::<F>),
307            )
308        } else {
309            (std::ptr::null_mut() as *mut ::std::os::raw::c_void, None, None)
310        };
311
312        unsafe {
313            otBorderRoutingDhcp6PdSetRequestCallback(self.as_ot_ptr(), cb, fn_ptr);
314
315            // Make sure our object eventually gets cleaned up.
316            // Here we must also transmute our closure to have a 'static lifetime.
317            // We need to do this because the borrow checker cannot infer the
318            // proper lifetime for the singleton instance backing, but
319            // this is guaranteed by the API.
320            self.borrow_backing().dhcp6pd_state_change_callback_fn.set(std::mem::transmute::<
321                Option<Box<dyn FnMut(BorderRoutingDhcp6PdState) + 'a>>,
322                Option<Box<dyn FnMut(BorderRoutingDhcp6PdState) + 'static>>,
323            >(fn_box));
324        }
325    }
326
327    fn border_routing_dhcp6_pd_state_change_stream(
328        &self,
329    ) -> BorderRoutingDhcp6PdStateChangedStream {
330        let state = Arc::new(Mutex::new((None, futures::task::noop_waker())));
331
332        let state_copy = state.clone();
333
334        self.border_routing_dhcp6_pd_set_request_fn(Some(
335            move |pd_state: BorderRoutingDhcp6PdState| {
336                let mut borrowed = state_copy.lock();
337                borrowed.0 = Some(pd_state);
338                borrowed.1.wake_by_ref();
339            },
340        ));
341
342        BorderRoutingDhcp6PdStateChangedStream(state)
343    }
344
345    fn border_routing_get_pd_omr_prefix(&self) -> Result<ot::BorderRoutingPrefixTableEntry> {
346        let mut ret: BorderRoutingPrefixTableEntry = Default::default();
347        Error::from(unsafe {
348            otBorderRoutingGetPdOmrPrefix(self.as_ot_ptr(), ret.as_ot_mut_ptr())
349        })
350        .into_result()?;
351        Ok(ret)
352    }
353
354    fn border_routing_get_omr_prefix(&self) -> Result<ot::Ip6Prefix> {
355        let mut ret: Ip6Prefix = Default::default();
356        Error::from(unsafe { otBorderRoutingGetOmrPrefix(self.as_ot_ptr(), ret.as_ot_mut_ptr()) })
357            .into_result()?;
358        Ok(ret)
359    }
360
361    fn border_routing_get_on_link_prefix(&self) -> Result<ot::Ip6Prefix> {
362        let mut ret: Ip6Prefix = Default::default();
363        Error::from(unsafe {
364            otBorderRoutingGetOnLinkPrefix(self.as_ot_ptr(), ret.as_ot_mut_ptr())
365        })
366        .into_result()?;
367        Ok(ret)
368    }
369
370    fn border_routing_process_icmp6_ra(&self, message: &[u8]) -> Result<(), WrongSize> {
371        unsafe {
372            otPlatBorderRoutingProcessIcmp6Ra(
373                self.as_ot_ptr(),
374                message.as_ptr(),
375                message.len().try_into().map_err(|_| WrongSize)?,
376            )
377        }
378        Ok(())
379    }
380
381    fn border_routing_get_pd_processed_ra_info(&self) -> PdProcessedRaInfo {
382        let mut info = PdProcessedRaInfo::default();
383        unsafe {
384            otBorderRoutingGetPdProcessedRaInfo(self.as_ot_ptr(), info.as_ot_mut_ptr());
385        }
386        info
387    }
388
389    fn iter_next_local_external_route(
390        &self,
391        ot_iter: &mut otNetworkDataIterator,
392    ) -> Option<ExternalRouteConfig> {
393        unsafe {
394            let mut ret = ExternalRouteConfig::default();
395            match Error::from(otBorderRouterGetNextRoute(
396                self.as_ot_ptr(),
397                ot_iter as *mut otNetworkDataIterator,
398                ret.as_ot_mut_ptr(),
399            )) {
400                Error::NotFound => None,
401                Error::None => Some(ret),
402                err => panic!("Unexpected error from otBorderRouterGetNextRoute: {err:?}"),
403            }
404        }
405    }
406
407    fn iter_next_local_on_mesh_prefix(
408        &self,
409        ot_iter: &mut otNetworkDataIterator,
410    ) -> Option<BorderRouterConfig> {
411        unsafe {
412            let mut ret = BorderRouterConfig::default();
413            match Error::from(otBorderRouterGetNextOnMeshPrefix(
414                self.as_ot_ptr(),
415                ot_iter as *mut otNetworkDataIterator,
416                ret.as_ot_mut_ptr(),
417            )) {
418                Error::NotFound => None,
419                Error::None => Some(ret),
420                err => panic!("Unexpected error from otBorderRouterGetNextOnMeshPrefix: {err:?}"),
421            }
422        }
423    }
424}
425
426/// Stream for getting state changed events.
427#[derive(Debug, Clone)]
428pub struct BorderRoutingDhcp6PdStateChangedStream(
429    Arc<Mutex<(Option<BorderRoutingDhcp6PdState>, Waker)>>,
430);
431
432impl Stream for BorderRoutingDhcp6PdStateChangedStream {
433    type Item = BorderRoutingDhcp6PdState;
434
435    fn poll_next(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Option<Self::Item>> {
436        let mut state = self.0.lock();
437
438        state.1 = cx.waker().clone();
439
440        if let Some(pd_state) = state.0.take() {
441            Poll::Ready(Some(pd_state))
442        } else {
443            Poll::Pending
444        }
445    }
446}
openthread/ot/border_router.rs

openthread/ot/
border_router.rs
