netlink_packet_route/neighbour/
header.rs

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
// SPDX-License-Identifier: MIT

use netlink_packet_utils::nla::{NlaBuffer, NlaError, NlasIterator};
use netlink_packet_utils::traits::{Emitable, Parseable};
use netlink_packet_utils::DecodeError;

use super::flags::NeighbourFlags;
use super::NeighbourState;
use crate::route::RouteType;
use crate::AddressFamily;

const NEIGHBOUR_HEADER_LEN: usize = 12;

buffer!(NeighbourMessageBuffer(NEIGHBOUR_HEADER_LEN) {
    family: (u8, 0),
    ifindex: (u32, 4..8),
    state: (u16, 8..10),
    flags: (u8, 10),
    kind: (u8, 11),
    payload:(slice, NEIGHBOUR_HEADER_LEN..),
});

impl<'a, T: AsRef<[u8]> + ?Sized> NeighbourMessageBuffer<&'a T> {
    pub fn attributes(&self) -> impl Iterator<Item = Result<NlaBuffer<&'a [u8]>, NlaError>> {
        NlasIterator::new(self.payload())
    }
}

/// Neighbour headers have the following structure:
///
/// ```no_rust
/// 0                8                16              24               32
/// +----------------+----------------+----------------+----------------+
/// |     family     |                     padding                      |
/// +----------------+----------------+----------------+----------------+
/// |                             link index                            |
/// +----------------+----------------+----------------+----------------+
/// |              state              |     flags      |     ntype      |
/// +----------------+----------------+----------------+----------------+
/// ```
///
/// `NeighbourHeader` exposes all these fields.
// Linux kernel struct `struct ndmsg`
#[derive(Debug, PartialEq, Eq, Clone, Default)]
pub struct NeighbourHeader {
    pub family: AddressFamily,
    pub ifindex: u32,
    /// Neighbour cache entry state.
    pub state: NeighbourState,
    /// Neighbour cache entry flags. It should be set to a combination
    /// of the `NTF_*` constants
    pub flags: NeighbourFlags,
    /// Neighbour cache entry type. It should be set to one of the
    /// `NDA_*` constants.
    pub kind: RouteType,
}

impl<T: AsRef<[u8]>> Parseable<NeighbourMessageBuffer<T>> for NeighbourHeader {
    type Error = ();
    fn parse(buf: &NeighbourMessageBuffer<T>) -> Result<Self, ()> {
        Ok(Self {
            family: buf.family().into(),
            ifindex: buf.ifindex(),
            state: buf.state().into(),
            flags: NeighbourFlags::from_bits_retain(buf.flags()),
            kind: buf.kind().into(),
        })
    }
}

impl Emitable for NeighbourHeader {
    fn buffer_len(&self) -> usize {
        NEIGHBOUR_HEADER_LEN
    }

    fn emit(&self, buffer: &mut [u8]) {
        let mut packet = NeighbourMessageBuffer::new(buffer);
        packet.set_family(self.family.into());
        packet.set_ifindex(self.ifindex);
        packet.set_state(self.state.into());
        packet.set_flags(self.flags.bits());
        packet.set_kind(self.kind.into());
    }
}