nlink 0.15.1

Async netlink library for Linux network configuration
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
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360

//! Integration tests for the rate limiting DSL.
//!
//! These tests require root privileges and network namespace support.

use std::time::Duration;

use nlink::{
    Bytes, Rate,
    netlink::ratelimit::{PerHostLimiter, RateLimit, RateLimiter},
};

use crate::common::TestNamespace;

// ============================================================================
// Unit tests (no root required)
// ============================================================================

#[test]
fn test_rate_limit_new() {
    let limit = RateLimit::new(Rate::bytes_per_sec(1_000_000));
    assert_eq!(limit.rate, Rate::bytes_per_sec(1_000_000));
    assert!(limit.ceil.is_none());
    assert!(limit.burst.is_none());
    assert!(limit.latency.is_none());
}

#[test]
fn test_rate_limit_typed_units() {
    // 100 Mbps -> 12.5 MB/s, 1 Gbps -> 125 MB/s.
    let limit = RateLimit::new(Rate::mbit(100));
    assert_eq!(limit.rate.as_bytes_per_sec(), 12_500_000);

    let limit = RateLimit::new(Rate::gbit(1));
    assert_eq!(limit.rate.as_bytes_per_sec(), 125_000_000);

    let limit = RateLimit::new(Rate::mbit(10));
    assert_eq!(limit.rate.as_bytes_per_sec(), 1_250_000);
}

#[test]
fn test_rate_limit_with_options() {
    let limit = RateLimit::new(Rate::bytes_per_sec(1_000_000))
        .ceil(Rate::bytes_per_sec(2_000_000))
        .burst(Bytes::new(32000))
        .latency(Duration::from_millis(20));

    assert_eq!(limit.rate, Rate::bytes_per_sec(1_000_000));
    assert_eq!(limit.ceil, Some(Rate::bytes_per_sec(2_000_000)));
    assert_eq!(limit.burst, Some(Bytes::new(32000)));
    assert_eq!(limit.latency, Some(Duration::from_millis(20)));
}

#[test]
fn test_rate_limiter_builder() {
    // Just verify builder pattern works without errors
    let _limiter = RateLimiter::new("eth0")
        .egress(Rate::bytes_per_sec(1_000_000))
        .ingress(Rate::bytes_per_sec(2_000_000))
        .burst_to(Rate::bytes_per_sec(3_000_000))
        .latency(Duration::from_millis(20));
}

#[test]
fn test_rate_limiter_with_typed_rates() {
    let _limiter = RateLimiter::new("eth0")
        .egress(Rate::mbit(100))
        .ingress(Rate::gbit(1))
        .burst_to(Rate::mbit(150));
}

#[test]
fn test_per_host_limiter_builder() {
    let _limiter = PerHostLimiter::new("eth0", Rate::mbit(10));
}

#[test]
fn test_per_host_limiter_with_rules() {
    let _limiter = PerHostLimiter::new("eth0", Rate::mbit(10))
        .limit_ip("192.168.1.100".parse().unwrap(), Rate::mbit(100))
        .limit_subnet("10.0.0.0/8", Rate::mbit(50))
        .unwrap()
        .limit_port(80, Rate::mbit(500))
        .latency(Duration::from_millis(5));
}

// ============================================================================
// Integration tests (require root)
// ============================================================================

#[tokio::test]
async fn test_egress_rate_limiting() -> nlink::Result<()> {
    require_root!();

    let ns = TestNamespace::new("rl_egress")?;
    let conn = ns.connection()?;

    conn.add_link(nlink::netlink::link::DummyLink::new("test0"))
        .await?;
    conn.set_link_up("test0").await?;

    RateLimiter::new("test0")
        .egress(Rate::bytes_per_sec(1_000_000))
        .latency(Duration::from_millis(20))
        .apply(&conn)
        .await?;

    let qdiscs = conn.get_qdiscs_by_name("test0").await?;
    let htb_qdisc = qdiscs.iter().find(|q| q.kind() == Some("htb"));
    assert!(htb_qdisc.is_some(), "HTB qdisc should exist");

    let fq_codel = qdiscs.iter().find(|q| q.kind() == Some("fq_codel"));
    assert!(fq_codel.is_some(), "fq_codel leaf qdisc should exist");

    RateLimiter::new("test0").remove(&conn).await?;

    let qdiscs = conn.get_qdiscs_by_name("test0").await?;
    let htb_qdisc = qdiscs.iter().find(|q| q.kind() == Some("htb"));
    assert!(htb_qdisc.is_none(), "HTB qdisc should be removed");

    Ok(())
}

#[tokio::test]
async fn test_ingress_rate_limiting() -> nlink::Result<()> {
    require_root!();

    let ns = TestNamespace::new("rl_ingress")?;
    let conn = ns.connection()?;

    conn.add_link(nlink::netlink::link::DummyLink::new("test0"))
        .await?;
    conn.set_link_up("test0").await?;

    RateLimiter::new("test0")
        .ingress(Rate::bytes_per_sec(2_000_000))
        .latency(Duration::from_millis(10))
        .apply(&conn)
        .await?;

    let ifb_link = conn.get_link_by_name("ifb_test0").await?;
    assert!(ifb_link.is_some(), "IFB device should be created");

    let qdiscs = conn.get_qdiscs_by_name("test0").await?;
    let ingress = qdiscs.iter().find(|q| q.is_ingress());
    assert!(
        ingress.is_some(),
        "Ingress qdisc should exist on main interface"
    );

    let ifb_qdiscs = conn.get_qdiscs_by_name("ifb_test0").await?;
    let htb = ifb_qdiscs.iter().find(|q| q.kind() == Some("htb"));
    assert!(htb.is_some(), "HTB qdisc should exist on IFB device");

    RateLimiter::new("test0").remove(&conn).await?;

    let ifb_link = conn.get_link_by_name("ifb_test0").await?;
    assert!(ifb_link.is_none(), "IFB device should be removed");

    Ok(())
}

#[tokio::test]
async fn test_bidirectional_rate_limiting() -> nlink::Result<()> {
    require_root!();

    let ns = TestNamespace::new("rl_bidir")?;
    let conn = ns.connection()?;

    conn.add_link(nlink::netlink::link::DummyLink::new("test0"))
        .await?;
    conn.set_link_up("test0").await?;

    RateLimiter::new("test0")
        .egress(Rate::mbit(100))
        .ingress(Rate::gbit(1))
        .burst_to(Rate::mbit(150))
        .latency(Duration::from_millis(20))
        .apply(&conn)
        .await?;

    let qdiscs = conn.get_qdiscs_by_name("test0").await?;
    let htb = qdiscs.iter().find(|q| q.kind() == Some("htb"));
    assert!(htb.is_some(), "Egress HTB should exist");

    let ingress = qdiscs.iter().find(|q| q.is_ingress());
    assert!(ingress.is_some(), "Ingress qdisc should exist");

    let ifb_qdiscs = conn.get_qdiscs_by_name("ifb_test0").await?;
    let ifb_htb = ifb_qdiscs.iter().find(|q| q.kind() == Some("htb"));
    assert!(ifb_htb.is_some(), "HTB on IFB should exist");

    RateLimiter::new("test0").remove(&conn).await?;

    Ok(())
}

#[tokio::test]
async fn test_per_host_rate_limiting() -> nlink::Result<()> {
    require_root!();

    let ns = TestNamespace::new("rl_perhost")?;
    let conn = ns.connection()?;

    conn.add_link(nlink::netlink::link::DummyLink::new("test0"))
        .await?;
    conn.set_link_up("test0").await?;

    PerHostLimiter::new("test0", Rate::mbit(10))
        .limit_ip("192.168.1.100".parse().unwrap(), Rate::mbit(100))
        .limit_subnet("10.0.0.0/8", Rate::mbit(50))?
        .latency(Duration::from_millis(5))
        .apply(&conn)
        .await?;

    let qdiscs = conn.get_qdiscs_by_name("test0").await?;
    let htb = qdiscs.iter().find(|q| q.kind() == Some("htb"));
    assert!(htb.is_some(), "HTB qdisc should exist");

    let fq_codel_count = qdiscs
        .iter()
        .filter(|q| q.kind() == Some("fq_codel"))
        .count();
    assert!(
        fq_codel_count >= 3,
        "Should have at least 3 fq_codel qdiscs (2 rules + default)"
    );

    let filters = conn.get_filters_by_name("test0").await?;
    assert!(!filters.is_empty(), "Flower filters should exist");

    PerHostLimiter::new("test0", Rate::mbit(10))
        .remove(&conn)
        .await?;

    Ok(())
}

#[tokio::test]
async fn test_rate_limiter_idempotency() -> nlink::Result<()> {
    require_root!();

    let ns = TestNamespace::new("rl_idemp")?;
    let conn = ns.connection()?;

    conn.add_link(nlink::netlink::link::DummyLink::new("test0"))
        .await?;
    conn.set_link_up("test0").await?;

    let limiter = RateLimiter::new("test0").egress(Rate::bytes_per_sec(1_000_000));

    limiter.apply(&conn).await?;
    limiter.apply(&conn).await?;
    limiter.apply(&conn).await?;

    let qdiscs = conn.get_qdiscs_by_name("test0").await?;
    let htb_count = qdiscs.iter().filter(|q| q.kind() == Some("htb")).count();
    assert_eq!(htb_count, 1, "Should have exactly one HTB qdisc");

    Ok(())
}

#[tokio::test]
async fn test_rate_limiter_remove_nonexistent() -> nlink::Result<()> {
    require_root!();

    let ns = TestNamespace::new("rl_remove")?;
    let conn = ns.connection()?;

    conn.add_link(nlink::netlink::link::DummyLink::new("test0"))
        .await?;
    conn.set_link_up("test0").await?;

    RateLimiter::new("test0").remove(&conn).await?;

    Ok(())
}

// ============================================================================
// Reconcile tests
// ============================================================================

#[tokio::test]
async fn test_per_host_reconcile_first_call_creates_tree() -> nlink::Result<()> {
    require_root!();

    let ns = TestNamespace::new("rl_reconcile_first")?;
    let conn = ns.connection()?;

    conn.add_link(nlink::netlink::link::DummyLink::new("test0"))
        .await?;
    conn.set_link_up("test0").await?;

    let report = PerHostLimiter::new("test0", Rate::mbit(10))
        .limit_ip("10.0.0.1".parse().unwrap(), Rate::mbit(100))
        .limit_ip("10.0.0.2".parse().unwrap(), Rate::mbit(50))
        .reconcile(&conn)
        .await?;

    assert!(report.changes_made > 0);
    assert_eq!(report.rules_added, 2);
    assert!(report.root_modified);

    let qdiscs = conn.get_qdiscs_by_name("test0").await?;
    assert!(
        qdiscs
            .iter()
            .any(|q| q.kind() == Some("htb") && q.is_root())
    );
    Ok(())
}

#[tokio::test]
async fn test_per_host_reconcile_idempotent() -> nlink::Result<()> {
    require_root!();

    let ns = TestNamespace::new("rl_reconcile_idem")?;
    let conn = ns.connection()?;

    conn.add_link(nlink::netlink::link::DummyLink::new("test0"))
        .await?;
    conn.set_link_up("test0").await?;

    let limiter = PerHostLimiter::new("test0", Rate::mbit(10))
        .limit_ip("10.0.0.1".parse().unwrap(), Rate::mbit(100));

    let r1 = limiter.reconcile(&conn).await?;
    assert!(r1.changes_made > 0);
    let r2 = limiter.reconcile(&conn).await?;
    assert!(
        r2.is_noop(),
        "second reconcile should be a no-op (got {} changes)",
        r2.changes_made,
    );
    Ok(())
}

#[tokio::test]
async fn test_per_host_reconcile_dry_run() -> nlink::Result<()> {
    require_root!();

    let ns = TestNamespace::new("rl_reconcile_dry")?;
    let conn = ns.connection()?;

    conn.add_link(nlink::netlink::link::DummyLink::new("test0"))
        .await?;
    conn.set_link_up("test0").await?;

    let report = PerHostLimiter::new("test0", Rate::mbit(10))
        .limit_ip("10.0.0.1".parse().unwrap(), Rate::mbit(100))
        .reconcile_dry_run(&conn)
        .await?;

    assert!(report.dry_run);
    assert!(report.changes_made > 0);

    // Nothing actually installed.
    let qdiscs = conn.get_qdiscs_by_name("test0").await?;
    assert!(qdiscs.iter().all(|q| q.kind() != Some("htb")));
    Ok(())
}