netlink-packet-route 0.30.0

netlink packet types
Documentation 
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
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218

// SPDX-License-Identifier: MIT

use netlink_packet_core::{Emitable, ParseableParametrized};

use crate::{
    link::{
        link_flag::LinkFlags, LinkAttribute, LinkHeader, LinkLayerType,
        LinkMessage, LinkMessageBuffer, LinkMode, State,
    },
    AddressFamily,
};

static LINK_MSG: [u8; 96] = [
    0x00, // interface family AF_UNSPEC
    0x00, // reserved
    0x04, 0x03, // link layer type 772 = loopback
    0x01, 0x00, 0x00, 0x00, // interface index = 1
    0x49, 0x00, 0x01, 0x00, // flags: UP|LOOPBACK|RUNNING|LOWERUP
    0x00, 0x00, 0x00, 0x00, // reserved 2 (aka device change flag)
    // attributes
    0x07, 0x00, 0x03, 0x00, 0x6c, 0x6f, 0x00, // device name L=7,T=3,V=lo
    0x00, // padding
    0x08, 0x00, 0x0d, 0x00, 0xe8, 0x03, 0x00,
    0x00, // TxQueue length L=8,T=13,V=1000
    0x05, 0x00, 0x10, 0x00, 0x00, // OperState L=5,T=16,V=0 (unknown)
    0x00, 0x00, 0x00, // padding
    0x05, 0x00, 0x11, 0x00, 0x00, // Link mode L=5,T=17,V=0
    0x00, 0x00, 0x00, // padding
    0x08, 0x00, 0x04, 0x00, 0x00, 0x00, 0x01, 0x00, // MTU L=8,T=4,V=65536
    0x08, 0x00, 0x1b, 0x00, 0x00, 0x00, 0x00, 0x00, // Group L=8,T=27,V=9
    0x08, 0x00, 0x1e, 0x00, 0x00, 0x00, 0x00,
    0x00, // Promiscuity L=8,T=30,V=0
    0x08, 0x00, 0x1f, 0x00, 0x01, 0x00, 0x00,
    0x00, // Number of Tx Queues L=8,T=31,V=1
    0x08, 0x00, 0x28, 0x00, 0xff, 0xff, 0x00,
    0x00, // Maximum GSO segment count L=8,T=40,V=65536
    0x08, 0x00, 0x29, 0x00, 0x00, 0x00, 0x01,
    0x00, // Maximum GSO size L=8,T=41,V=65536
];

#[test]
fn link_message_packet_header_read() {
    let packet = LinkMessageBuffer::new(&LINK_MSG[0..16]);
    assert_eq!(packet.interface_family(), AddressFamily::Unspec.into());
    assert_eq!(packet.reserved_1(), 0);
    assert_eq!(packet.link_layer_type(), LinkLayerType::Loopback.into());
    assert_eq!(packet.link_index(), 1);
    assert_eq!(
        packet.flags(),
        (LinkFlags::Loopback
            | LinkFlags::LowerUp
            | LinkFlags::Running
            | LinkFlags::Up)
            .bits()
    );
    assert_eq!(packet.change_mask(), 0);
}

#[test]
fn link_message_packet_header_build() {
    let mut buf = vec![0xff; 16];
    {
        let mut packet = LinkMessageBuffer::new(&mut buf);
        packet.set_interface_family(AddressFamily::Unspec.into());
        packet.set_reserved_1(0);
        packet.set_link_layer_type(LinkLayerType::Loopback.into());
        packet.set_link_index(1);
        packet.set_flags(
            (LinkFlags::Loopback
                | LinkFlags::LowerUp
                | LinkFlags::Running
                | LinkFlags::Up)
                .bits(),
        );
        packet.set_change_mask(0);
    }
    assert_eq!(&buf[..], &LINK_MSG[0..16]);
}

#[test]
fn link_mssage_packet_attributes_read() {
    let packet = LinkMessageBuffer::new(&LINK_MSG[..]);
    assert_eq!(packet.attributes().count(), 10);
    let mut attributes = packet.attributes();

    // device name L=7,T=3,V=lo
    let nla = attributes.next().unwrap().unwrap();
    nla.check_buffer_length().unwrap();
    assert_eq!(nla.length(), 7);
    assert_eq!(nla.kind(), 3);
    assert_eq!(nla.value(), &[0x6c, 0x6f, 0x00]);
    let parsed =
        LinkAttribute::parse_with_param(&nla, AddressFamily::Inet).unwrap();
    assert_eq!(parsed, LinkAttribute::IfName(String::from("lo")));

    // TxQueue length L=8,T=13,V=1000
    let nla = attributes.next().unwrap().unwrap();
    nla.check_buffer_length().unwrap();
    assert_eq!(nla.length(), 8);
    assert_eq!(nla.kind(), 13);
    assert_eq!(nla.value(), &[0xe8, 0x03, 0x00, 0x00]);
    let parsed =
        LinkAttribute::parse_with_param(&nla, AddressFamily::Inet).unwrap();
    assert_eq!(parsed, LinkAttribute::TxQueueLen(1000));

    // OperState L=5,T=16,V=0 (unknown)
    let nla = attributes.next().unwrap().unwrap();
    nla.check_buffer_length().unwrap();
    assert_eq!(nla.length(), 5);
    assert_eq!(nla.kind(), 16);
    assert_eq!(nla.value(), &[0x00]);
    let parsed =
        LinkAttribute::parse_with_param(&nla, AddressFamily::Inet).unwrap();
    assert_eq!(parsed, LinkAttribute::OperState(State::Unknown));

    // Link mode L=5,T=17,V=0
    let nla = attributes.next().unwrap().unwrap();
    nla.check_buffer_length().unwrap();
    assert_eq!(nla.length(), 5);
    assert_eq!(nla.kind(), 17);
    assert_eq!(nla.value(), &[0x00]);
    let parsed =
        LinkAttribute::parse_with_param(&nla, AddressFamily::Inet).unwrap();
    assert_eq!(parsed, LinkAttribute::Mode(LinkMode::Default));

    // MTU L=8,T=4,V=65536
    let nla = attributes.next().unwrap().unwrap();
    nla.check_buffer_length().unwrap();
    assert_eq!(nla.length(), 8);
    assert_eq!(nla.kind(), 4);
    assert_eq!(nla.value(), &[0x00, 0x00, 0x01, 0x00]);
    let parsed =
        LinkAttribute::parse_with_param(&nla, AddressFamily::Inet).unwrap();
    assert_eq!(parsed, LinkAttribute::Mtu(65_536));

    // 0x00, 0x00, 0x00, 0x00,
    // Group L=8,T=27,V=9
    let nla = attributes.next().unwrap().unwrap();
    nla.check_buffer_length().unwrap();
    assert_eq!(nla.length(), 8);
    assert_eq!(nla.kind(), 27);
    assert_eq!(nla.value(), &[0x00, 0x00, 0x00, 0x00]);
    let parsed =
        LinkAttribute::parse_with_param(&nla, AddressFamily::Inet).unwrap();
    assert_eq!(parsed, LinkAttribute::Group(0));

    // Promiscuity L=8,T=30,V=0
    let nla = attributes.next().unwrap().unwrap();
    nla.check_buffer_length().unwrap();
    assert_eq!(nla.length(), 8);
    assert_eq!(nla.kind(), 30);
    assert_eq!(nla.value(), &[0x00, 0x00, 0x00, 0x00]);
    let parsed =
        LinkAttribute::parse_with_param(&nla, AddressFamily::Inet).unwrap();
    assert_eq!(parsed, LinkAttribute::Promiscuity(0));

    // Number of Tx Queues L=8,T=31,V=1
    // 0x01, 0x00, 0x00, 0x00
    let nla = attributes.next().unwrap().unwrap();
    nla.check_buffer_length().unwrap();
    assert_eq!(nla.length(), 8);
    assert_eq!(nla.kind(), 31);
    assert_eq!(nla.value(), &[0x01, 0x00, 0x00, 0x00]);
    let parsed =
        LinkAttribute::parse_with_param(&nla, AddressFamily::Inet).unwrap();
    assert_eq!(parsed, LinkAttribute::NumTxQueues(1));
}

#[test]
fn link_message_emit() {
    let header = LinkHeader {
        link_layer_type: LinkLayerType::Loopback,
        index: 1,
        flags: LinkFlags::Loopback
            | LinkFlags::LowerUp
            | LinkFlags::Running
            | LinkFlags::Up,
        interface_family: AddressFamily::Unspec,
        ..Default::default()
    };

    let attributes = vec![
        LinkAttribute::IfName("lo".into()),
        LinkAttribute::TxQueueLen(1000),
        LinkAttribute::OperState(State::Unknown),
        LinkAttribute::Mode(LinkMode::Default),
        LinkAttribute::Mtu(0x1_0000),
        LinkAttribute::Group(0),
        LinkAttribute::Promiscuity(0),
        LinkAttribute::NumTxQueues(1),
        LinkAttribute::GsoMaxSegs(0xffff),
        LinkAttribute::GsoMaxSize(0x1_0000),
    ];

    let packet = LinkMessage { header, attributes };

    let mut buf = [0; 96];

    assert_eq!(packet.buffer_len(), 96);
    packet.emit(&mut buf[..]);

    assert_eq!(buf, &LINK_MSG[..96]);
}

#[test]
fn link_type_mctp() {
    const LINK_MSG_MCTP: [u8; 16] = [
        0x00, // interface family AF_UNSPEC
        0x00, // reserved 1
        0x22, 0x01, // link layer type 290 = ARPHDR_MCTP
        0x01, 0x00, 0x00, 0x00, // interface index = 1
        0x41, 0x00, 0x01, 0x00, // flags: UP|RUNNING|LOWERUP
        0x00, 0x00, 0x00, 0x00, // reserved 2
    ];
    let packet = LinkMessageBuffer::new(&LINK_MSG_MCTP);
    assert_eq!(packet.interface_family(), AddressFamily::Unspec.into());
    assert_eq!(packet.link_layer_type(), LinkLayerType::Mctp.into());
}