netlink_packet_route/rtnl/tc/
message.rs

1// SPDX-License-Identifier: MIT
2
3use anyhow::Context;
4
5use crate::{
6    constants::*,
7    nlas::{
8        tc::{Nla, Stats, Stats2, StatsBuffer, TcOpt},
9        DefaultNla,
10        NlasIterator,
11    },
12    parsers::{parse_string, parse_u8},
13    traits::{Emitable, Parseable, ParseableParametrized},
14    DecodeError,
15    TcMessageBuffer,
16    TC_HEADER_LEN,
17};
18
19#[derive(Debug, PartialEq, Eq, Clone, Default)]
20pub struct TcMessage {
21    pub header: TcHeader,
22    pub nlas: Vec<Nla>,
23}
24
25impl TcMessage {
26    pub fn into_parts(self) -> (TcHeader, Vec<Nla>) {
27        (self.header, self.nlas)
28    }
29
30    pub fn from_parts(header: TcHeader, nlas: Vec<Nla>) -> Self {
31        TcMessage { header, nlas }
32    }
33
34    /// Create a new `TcMessage` with the given index
35    pub fn with_index(index: i32) -> Self {
36        Self {
37            header: TcHeader {
38                index,
39                ..Default::default()
40            },
41            nlas: Vec::new(),
42        }
43    }
44}
45
46#[derive(Debug, PartialEq, Eq, Clone, Default)]
47pub struct TcHeader {
48    pub family: u8,
49    // Interface index
50    pub index: i32,
51    // Qdisc handle
52    pub handle: u32,
53    // Parent Qdisc
54    pub parent: u32,
55    pub info: u32,
56}
57
58impl Emitable for TcHeader {
59    fn buffer_len(&self) -> usize {
60        TC_HEADER_LEN
61    }
62
63    fn emit(&self, buffer: &mut [u8]) {
64        let mut packet = TcMessageBuffer::new(buffer);
65        packet.set_family(self.family);
66        packet.set_index(self.index);
67        packet.set_handle(self.handle);
68        packet.set_parent(self.parent);
69        packet.set_info(self.info);
70    }
71}
72
73impl Emitable for TcMessage {
74    fn buffer_len(&self) -> usize {
75        self.header.buffer_len() + self.nlas.as_slice().buffer_len()
76    }
77
78    fn emit(&self, buffer: &mut [u8]) {
79        self.header.emit(buffer);
80        self.nlas
81            .as_slice()
82            .emit(&mut buffer[self.header.buffer_len()..]);
83    }
84}
85
86impl<T: AsRef<[u8]>> Parseable<TcMessageBuffer<T>> for TcHeader {
87    fn parse(buf: &TcMessageBuffer<T>) -> Result<Self, DecodeError> {
88        Ok(Self {
89            family: buf.family(),
90            index: buf.index(),
91            handle: buf.handle(),
92            parent: buf.parent(),
93            info: buf.info(),
94        })
95    }
96}
97
98impl<'a, T: AsRef<[u8]> + 'a> Parseable<TcMessageBuffer<&'a T>> for TcMessage {
99    fn parse(buf: &TcMessageBuffer<&'a T>) -> Result<Self, DecodeError> {
100        Ok(Self {
101            header: TcHeader::parse(buf).context("failed to parse tc message header")?,
102            nlas: Vec::<Nla>::parse(buf).context("failed to parse tc message NLAs")?,
103        })
104    }
105}
106
107impl<'a, T: AsRef<[u8]> + 'a> Parseable<TcMessageBuffer<&'a T>> for Vec<Nla> {
108    fn parse(buf: &TcMessageBuffer<&'a T>) -> Result<Self, DecodeError> {
109        let mut nlas = vec![];
110        let mut kind = String::new();
111
112        for nla_buf in buf.nlas() {
113            let buf = nla_buf.context("invalid tc nla")?;
114            let payload = buf.value();
115            let nla = match buf.kind() {
116                TCA_UNSPEC => Nla::Unspec(payload.to_vec()),
117                TCA_KIND => {
118                    kind = parse_string(payload).context("invalid TCA_KIND")?;
119                    Nla::Kind(kind.clone())
120                }
121                TCA_OPTIONS => {
122                    let mut nlas = vec![];
123                    for nla in NlasIterator::new(payload) {
124                        let nla = nla.context("invalid TCA_OPTIONS")?;
125                        nlas.push(
126                            TcOpt::parse_with_param(&nla, &kind)
127                                .context("failed to parse TCA_OPTIONS")?,
128                        )
129                    }
130                    Nla::Options(nlas)
131                }
132                TCA_STATS => Nla::Stats(
133                    Stats::parse(&StatsBuffer::new_checked(payload).context("invalid TCA_STATS")?)
134                        .context("failed to parse TCA_STATS")?,
135                ),
136                TCA_XSTATS => Nla::XStats(payload.to_vec()),
137                TCA_RATE => Nla::Rate(payload.to_vec()),
138                TCA_FCNT => Nla::Fcnt(payload.to_vec()),
139                TCA_STATS2 => {
140                    let mut nlas = vec![];
141                    for nla in NlasIterator::new(payload) {
142                        let nla = nla.context("invalid TCA_STATS2")?;
143                        nlas.push(Stats2::parse(&nla).context("failed to parse TCA_STATS2")?);
144                    }
145                    Nla::Stats2(nlas)
146                }
147                TCA_STAB => Nla::Stab(payload.to_vec()),
148                TCA_CHAIN => Nla::Chain(payload.to_vec()),
149                TCA_HW_OFFLOAD => {
150                    Nla::HwOffload(parse_u8(payload).context("failed to parse TCA_HW_OFFLOAD")?)
151                }
152                _ => Nla::Other(DefaultNla::parse(&buf).context("failed to parse tc nla")?),
153            };
154
155            nlas.push(nla);
156        }
157        Ok(nlas)
158    }
159}