openthread/ot/types/
nat64.rs

1// Copyright 2022 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::prelude_internal::*;
6
7use core::fmt::{Debug, Formatter};
8use num_derive::FromPrimitive;
9
10/// Represents a NAT64 Translator State.
11///
12/// Functional equivalent of [`otsys::otNat64State`](crate::otsys::otNat64State).
13#[derive(Debug, Copy, Clone, Eq, Ord, PartialOrd, PartialEq, FromPrimitive)]
14pub enum Nat64State {
15    /// Functional equivalent of [`otsys::OT_NAT64_STATE_DISABLED`](crate::otsys::OT_NAT64_STATE_DISABLED).
16    Disabled = OT_NAT64_STATE_DISABLED as isize,
17
18    /// Functional equivalent of [`otsys::OT_NAT64_STATE_NOT_RUNNING`](crate::otsys::OT_NAT64_STATE_NOT_RUNNING).
19    NotRunning = OT_NAT64_STATE_NOT_RUNNING as isize,
20
21    /// Functional equivalent of [`otsys::OT_NAT64_STATE_IDLE`](crate::otsys::OT_NAT64_STATE_IDLE).
22    Idle = OT_NAT64_STATE_IDLE as isize,
23
24    /// Functional equivalent of [`otsys::OT_NAT64_STATE_ACTIVE`](crate::otsys::OT_NAT64_STATE_ACTIVE).
25    Active = OT_NAT64_STATE_ACTIVE as isize,
26}
27
28impl From<otNat64State> for Nat64State {
29    fn from(x: otNat64State) -> Self {
30        use num::FromPrimitive;
31        Self::from_u32(x).unwrap_or_else(|| panic!("Unknown otNat64State value: {x}"))
32    }
33}
34
35impl From<Nat64State> for otNat64State {
36    fn from(x: Nat64State) -> Self {
37        x as otNat64State
38    }
39}
40
41/// Data type representing an IPv4 CIDR.
42///
43/// Functional equivalent of [`otsys::otIp4Cidr`](crate::otsys::otIp4Cidr).
44#[derive(Default, Clone, Copy)]
45#[repr(transparent)]
46pub struct Ip4Cidr(pub otIp4Cidr);
47
48impl_ot_castable!(Ip4Cidr, otIp4Cidr);
49
50impl Debug for Ip4Cidr {
51    fn fmt(&self, f: &mut Formatter<'_>) -> std::fmt::Result {
52        write!(
53            f,
54            "IpAddr:{}, PrefixLength:{}",
55            std::net::Ipv4Addr::from(self.get_address_bytes()),
56            self.get_length()
57        )
58    }
59}
60
61impl PartialEq for Ip4Cidr {
62    fn eq(&self, other: &Ip4Cidr) -> bool {
63        if (self.get_length() != other.get_length())
64            || (self.get_address_bytes() != other.get_address_bytes())
65        {
66            return false;
67        }
68        true
69    }
70}
71
72impl Eq for Ip4Cidr {}
73
74/// IPv4 address type
75pub type Ip4Address = std::net::Ipv4Addr;
76
77impl Ip4Cidr {
78    /// create a new Ip4Cidr
79    pub fn new(addr: [u8; 4], len: u8) -> Ip4Cidr {
80        Ip4Cidr(otIp4Cidr {
81            mAddress: otIp4Address { mFields: otIp4Address__bindgen_ty_1 { m8: addr } },
82            mLength: len,
83        })
84    }
85
86    /// Get the address of IPv4 CIDR
87    pub fn get_address_bytes(&self) -> [u8; 4] {
88        unsafe { self.0.mAddress.mFields.m8 }
89    }
90
91    /// Get the length of IPv4 CIDR
92    pub fn get_length(&self) -> u8 {
93        self.0.mLength
94    }
95}
96
97#[derive(Default, Clone, Copy)]
98#[repr(transparent)]
99/// NAT64 Address Mapping, which is part of NAT64 telemetry
100pub struct Nat64AddressMapping(pub otNat64AddressMapping);
101
102impl_ot_castable!(Nat64AddressMapping, otNat64AddressMapping);
103
104impl Nat64AddressMapping {
105    /// Get NAT64 mapping ID
106    pub fn get_mapping_id(&self) -> u64 {
107        self.0.mId
108    }
109
110    /// Get IPv4 address
111    pub fn get_ipv4_addr(&self) -> std::net::Ipv4Addr {
112        unsafe { self.0.mIp4.mFields.m8.into() }
113    }
114
115    /// Get IPv6 address
116    pub fn get_ipv6_addr(&self) -> std::net::Ipv6Addr {
117        unsafe { self.0.mIp6.mFields.m8.into() }
118    }
119
120    /// Get the remaining time in ms
121    pub fn get_remaining_time_ms(&self) -> u32 {
122        self.0.mRemainingTimeMs
123    }
124
125    /// Get the protocol counters for this mapping
126    pub fn get_protocol_counters(&self) -> Nat64ProtocolCounters {
127        self.0.mCounters.into()
128    }
129}
130
131impl Debug for Nat64AddressMapping {
132    fn fmt(&self, f: &mut Formatter<'_>) -> std::fmt::Result {
133        write!(
134            f,
135            "mapping_id:{:?},ip4_addr:{:?},ip6_addr:{:?},remaining_time:{:?}",
136            self.get_mapping_id(),
137            self.get_ipv4_addr(),
138            self.get_ipv6_addr(),
139            self.get_remaining_time_ms()
140        )
141    }
142}
143
144#[derive(Default, Clone, Copy, Debug)]
145#[repr(transparent)]
146/// Counters for sum of all protocols for NAT64
147pub struct Nat64ProtocolCounters(pub otNat64ProtocolCounters);
148
149impl_ot_castable!(Nat64ProtocolCounters, otNat64ProtocolCounters);
150
151impl Nat64ProtocolCounters {
152    /// Get total counters
153    pub fn get_total_counters(&self) -> Nat64Counters {
154        self.0.mTotal.into()
155    }
156
157    /// Get ICMP counters
158    pub fn get_icmp_counters(&self) -> Nat64Counters {
159        self.0.mIcmp.into()
160    }
161
162    /// Get UDP counters
163    pub fn get_udp_counters(&self) -> Nat64Counters {
164        self.0.mUdp.into()
165    }
166
167    /// Get TCP counters
168    pub fn get_tcp_counters(&self) -> Nat64Counters {
169        self.0.mTcp.into()
170    }
171}
172
173#[derive(Default, Clone, Copy, Debug)]
174#[repr(transparent)]
175/// Represents the counters for NAT64
176pub struct Nat64Counters(pub otNat64Counters);
177
178impl_ot_castable!(Nat64Counters, otNat64Counters);
179
180impl Nat64Counters {
181    /// Get IPv4 to IPv6 packets
182    pub fn get_4_to_6_packets(&self) -> u64 {
183        self.0.m4To6Packets
184    }
185
186    /// Get IPv4 to IPv6 bytes
187    pub fn get_4_to_6_bytes(&self) -> u64 {
188        self.0.m4To6Bytes
189    }
190
191    /// Get IPv6 to IPv4 packets
192    pub fn get_6_to_4_packets(&self) -> u64 {
193        self.0.m6To4Packets
194    }
195
196    /// Get IPv6 to IPv4 bytes
197    pub fn get_6_to_4_bytes(&self) -> u64 {
198        self.0.m6To4Bytes
199    }
200}
201
202#[derive(Default, Clone, Copy, Debug)]
203#[repr(transparent)]
204/// Represents the error counters for NAT64
205pub struct Nat64ErrorCounters(pub otNat64ErrorCounters);
206
207impl_ot_castable!(Nat64ErrorCounters, otNat64ErrorCounters);
208
209impl Nat64ErrorCounters {
210    /// Get IPv4 to IPv6 counters
211    pub fn get_counter_4_to_6(&self) -> [u64; 4usize] {
212        self.0.mCount4To6
213    }
214
215    /// Get IPv6 to IPv4 counters
216    pub fn get_counter_6_to_4(&self) -> [u64; 4usize] {
217        self.0.mCount6To4
218    }
219}
openthread/ot/types/nat64.rs

openthread/ot/types/
nat64.rs
