l2tp 0.4.0

High-level L2TP interface for Linux kernel
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
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
// SPDX-License-Identifier: MIT

use std::{
    collections::VecDeque,
    future::Future,
    num::NonZeroI32,
    os::fd::RawFd,
    pin::Pin,
    sync::Mutex,
    task::{Context, Poll},
};

use bytes::BufMut;
use netlink_packet_core::{ErrorMessage, NetlinkSerializable};
use netlink_packet_generic::ctrl::{
    GenlCtrl, GenlCtrlCmd,
    nlas::{GenlCtrlAttrs, McastGrpAttrs},
};
use netlink_packet_l2tp::{L2tpCmd, L2tpPwType};
use netlink_sys::{AsyncSocket, Socket, SocketAddr};

use super::{tests::TEST_FAMILY_ID, *};
use crate::{Encapsulation, UdpEndpoint};

type Message = NetlinkMessage<GenlMessage<L2tpMessage>>;
type FamilyQuery = NetlinkMessage<GenlMessage<GenlCtrl>>;
type Creation = Pin<Box<dyn Future<Output = crate::Result<()>> + Send>>;

// Exercise the real generic-netlink request queue and response decoder without
// requiring kernel L2TP support. Only the socket transport is replaced. Tests
// poll the connection explicitly, so transmission and ACK delivery are ordered
// independently of the caller and the creation task.
#[derive(Default)]
struct Wire {
    /// Requests as sent, so each test decodes them as the family it expects.
    requests: VecDeque<Vec<u8>>,
    replies: VecDeque<Vec<u8>>,
}

#[derive(Default)]
struct TestSocket(Arc<Mutex<Wire>>);

impl AsyncSocket for TestSocket {
    fn socket_ref(&self) -> &Socket {
        panic!("the mock transport has no kernel socket")
    }

    fn socket_mut(&mut self) -> &mut Socket {
        panic!("the mock transport has no kernel socket")
    }

    fn new(_protocol: isize) -> io::Result<Self> {
        Ok(Self::default())
    }

    fn poll_send(
        &self,
        _cx: &mut Context<'_>,
        buf: &[u8],
    ) -> Poll<io::Result<usize>> {
        self.0.lock().unwrap().requests.push_back(buf.to_vec());
        Poll::Ready(Ok(buf.len()))
    }

    fn poll_send_to(
        &self,
        cx: &mut Context<'_>,
        buf: &[u8],
        _addr: &SocketAddr,
    ) -> Poll<io::Result<usize>> {
        self.poll_send(cx, buf)
    }

    fn poll_recv<B: BufMut>(
        &self,
        _cx: &mut Context<'_>,
        buf: &mut B,
    ) -> Poll<io::Result<()>> {
        match self.0.lock().unwrap().replies.pop_front() {
            Some(reply) => {
                buf.put_slice(&reply);
                Poll::Ready(Ok(()))
            }
            None => Poll::Pending,
        }
    }

    fn poll_recv_from<B: BufMut>(
        &self,
        cx: &mut Context<'_>,
        buf: &mut B,
    ) -> Poll<io::Result<SocketAddr>> {
        self.poll_recv(cx, buf).map_ok(|()| SocketAddr::new(0, 0))
    }

    fn poll_recv_from_full(
        &self,
        cx: &mut Context<'_>,
    ) -> Poll<io::Result<(Vec<u8>, SocketAddr)>> {
        let mut buf = Vec::new();
        self.poll_recv_from(cx, &mut buf).map_ok(|addr| (buf, addr))
    }
}

struct Harness {
    handle: L2tpHandle,
    connection: Pin<Box<dyn Future<Output = ()>>>,
    wire: Arc<Mutex<Wire>>,
}

impl Harness {
    fn new() -> Self {
        let (mut connection, genl, _unsolicited) =
            genetlink::new_connection_with_socket::<TestSocket>().unwrap();
        connection.set_forward_ack(true);
        connection.set_forward_done(true);
        let wire = connection.socket_mut().0.clone();
        Self {
            handle: super::tests::test_handle(genl),
            connection: Box::pin(connection),
            wire,
        }
    }

    async fn step(&mut self) {
        assert!(futures::poll!(self.connection.as_mut()).is_pending());
        tokio::task::yield_now().await;
    }

    async fn next_raw_request(&mut self, what: &str) -> Vec<u8> {
        for _ in 0..16 {
            self.step().await;
            if let Some(raw) = self.wire.lock().unwrap().requests.pop_front() {
                return raw;
            }
        }
        panic!("no {what} request after driving all ready tasks");
    }

    async fn next_request(&mut self, expected: L2tpCmd) -> Message {
        let raw = self.next_raw_request(&format!("{expected:?}")).await;
        let message = Message::deserialize(&raw).unwrap();
        assert_eq!(payload(&message).cmd, expected);
        assert!(
            payload(&message)
                .attributes
                .contains(&L2tpAttribute::ConnId(101))
        );
        message
    }

    /// The `nlctrl` query that resolves the `l2tp` family.
    async fn next_family_query(&mut self) -> FamilyQuery {
        let raw = self.next_raw_request("CTRL_CMD_GETFAMILY").await;
        let message = FamilyQuery::deserialize(&raw).unwrap();
        let NetlinkPayload::InnerMessage(query) = &message.payload else {
            panic!("expected a family query");
        };
        assert_eq!(query.payload.cmd, GenlCtrlCmd::GetFamily);
        assert!(
            query
                .payload
                .nlas
                .contains(&GenlCtrlAttrs::FamilyName("l2tp".to_string()))
        );
        message
    }

    fn family_reply(&mut self, query: &FamilyQuery, family_id: u16) {
        let reply = GenlMessage::from_payload(GenlCtrl {
            cmd: GenlCtrlCmd::GetFamily,
            nlas: vec![
                GenlCtrlAttrs::FamilyName("l2tp".to_string()),
                GenlCtrlAttrs::FamilyId(family_id),
                GenlCtrlAttrs::McastGroups(vec![vec![
                    McastGrpAttrs::Name("l2tp".to_string()),
                    McastGrpAttrs::Id(7),
                ]]),
            ],
        });
        self.reply_with_sequence(
            query.header.sequence_number,
            NetlinkMessage::from(reply),
        );
    }

    fn reply(&mut self, request: &Message, reply: Message) {
        self.reply_with_sequence(request.header.sequence_number, reply);
    }

    fn reply_with_sequence<T: NetlinkSerializable + std::fmt::Debug>(
        &mut self,
        sequence_number: u32,
        mut reply: NetlinkMessage<T>,
    ) {
        reply.header.sequence_number = sequence_number;
        reply.finalize();
        let mut bytes = vec![0; reply.buffer_len()];
        reply.serialize(&mut bytes);
        self.wire.lock().unwrap().replies.push_back(bytes);
    }

    fn ack(&mut self, request: &Message, code: i32) {
        let mut error = ErrorMessage::default();
        error.code = NonZeroI32::new(-code);
        self.reply(
            request,
            Message::new(Default::default(), NetlinkPayload::Error(error)),
        );
    }

    fn tunnel_reply(&mut self, request: &Message, version: L2tpVersion) {
        self.tunnel_reply_from(request, version, TEST_FAMILY_ID);
    }

    fn tunnel_reply_from(
        &mut self,
        request: &Message,
        version: L2tpVersion,
        family_id: u16,
    ) {
        let mut message = L2tpMessage::new(L2tpCmd::TunnelGet);
        message.attributes = vec![
            L2tpAttribute::ConnId(101),
            L2tpAttribute::PeerConnId(102),
            L2tpAttribute::ProtoVersion(version.number()),
            L2tpAttribute::EncapType(netlink_packet_l2tp::L2tpEncapType::Udp),
            L2tpAttribute::IpSaddr(std::net::Ipv4Addr::LOCALHOST),
            L2tpAttribute::IpDaddr(std::net::Ipv4Addr::LOCALHOST),
            L2tpAttribute::UdpSport(1701),
            L2tpAttribute::UdpDport(1702),
        ];
        let mut genl = GenlMessage::from_payload(message);
        genl.set_resolved_family_id(family_id);
        self.reply(request, Message::from(genl));
    }

    async fn session_lookup(&mut self, fail: bool) {
        let get = self.next_request(L2tpCmd::SessionGet).await;
        if fail {
            self.ack(&get, libc::EIO);
        } else {
            let mut message = L2tpMessage::new(L2tpCmd::SessionGet);
            message.attributes = vec![
                L2tpAttribute::ConnId(101),
                L2tpAttribute::PeerConnId(102),
                L2tpAttribute::SessionId(201),
                L2tpAttribute::PeerSessionId(202),
                L2tpAttribute::PwType(L2tpPwType::Eth),
            ];
            let mut genl = GenlMessage::from_payload(message);
            genl.set_resolved_family_id(1234);
            self.reply(&get, Message::from(genl));
        }
    }

    async fn finish_cleanup(&mut self, resource: Resource) {
        let delete = self.next_request(resource.delete_cmd()).await;
        if matches!(resource, Resource::Session) {
            assert!(
                payload(&delete)
                    .attributes
                    .contains(&L2tpAttribute::SessionId(201))
            );
        }
        self.ack(&delete, 0);
        if !matches!(resource, Resource::Session) {
            // Tunnel deletion then polls until the tunnel is gone.
            let get = self.next_request(L2tpCmd::TunnelGet).await;
            self.ack(&get, libc::ENODEV);
        }
        self.assert_idle().await;
    }

    /// Drives the transport until `task` has finished, then returns its
    /// output; the caller's `await` alone would never poll the connection.
    async fn settle<T>(&mut self, task: tokio::task::JoinHandle<T>) -> T {
        for _ in 0..64 {
            if task.is_finished() {
                return task.await.unwrap();
            }
            self.step().await;
        }
        panic!("the task did not finish after driving the transport");
    }

    async fn assert_idle(&mut self) {
        for _ in 0..16 {
            self.step().await;
        }
        assert!(self.wire.lock().unwrap().requests.is_empty());
        assert_eq!(Arc::strong_count(&self.handle.inner), 1);
    }

    fn create(&self, resource: Resource) -> (Creation, Option<SocketIdentity>) {
        let handle = self.handle.clone();
        let local = UdpEndpoint::V4("127.0.0.1:0".parse().unwrap());
        let remote = UdpEndpoint::V4("127.0.0.1:1701".parse().unwrap());
        let config = TunnelConfig::new(
            TunnelId(101),
            TunnelId(102),
            Encapsulation::Udp {
                local: local.clone(),
                remote: remote.clone(),
                udp_csum: true,
                udp_zero_csum6_tx: false,
                udp_zero_csum6_rx: false,
            },
        )
        .unwrap();
        match resource {
            Resource::Managed => {
                let socket = TunnelSocket::udp(&local, &remote, None).unwrap();
                let identity = SocketIdentity::new(socket.as_raw_fd());
                (
                    Box::pin(async move {
                        handle.create_tunnel(config, socket).await?;
                        Ok(())
                    }),
                    Some(identity),
                )
            }
            Resource::Unmanaged => (
                Box::pin(async move {
                    handle.create_unmanaged_tunnel(config).await?;
                    Ok(())
                }),
                None,
            ),
            Resource::Session => (
                Box::pin(async move {
                    handle
                        .create_session(SessionConfig::eth(
                            TunnelId(101),
                            SessionId(201),
                            SessionId(202),
                        ))
                        .await?;
                    Ok(())
                }),
                None,
            ),
        }
    }
}

fn payload(message: &Message) -> &L2tpMessage {
    let NetlinkPayload::InnerMessage(message) = &message.payload else {
        panic!("expected an L2TP request");
    };
    &message.payload
}

#[derive(Clone, Copy)]
enum Resource {
    Managed,
    Unmanaged,
    Session,
}

impl Resource {
    fn create_cmd(self) -> L2tpCmd {
        match self {
            Self::Managed | Self::Unmanaged => L2tpCmd::TunnelCreate,
            Self::Session => L2tpCmd::SessionCreate,
        }
    }

    fn delete_cmd(self) -> L2tpCmd {
        match self {
            Self::Managed | Self::Unmanaged => L2tpCmd::TunnelDelete,
            Self::Session => L2tpCmd::SessionDelete,
        }
    }
}

struct SocketIdentity {
    fd: RawFd,
    device: libc::dev_t,
    inode: libc::ino_t,
}

impl SocketIdentity {
    fn new(fd: RawFd) -> Self {
        let mut stat = std::mem::MaybeUninit::<libc::stat>::uninit();
        // SAFETY: fstat initializes the provided stat buffer on success.
        assert_eq!(unsafe { libc::fstat(fd, stat.as_mut_ptr()) }, 0);
        // SAFETY: fstat succeeded above.
        let stat = unsafe { stat.assume_init() };
        Self {
            fd,
            device: stat.st_dev,
            inode: stat.st_ino,
        }
    }

    fn is_open(&self) -> bool {
        let mut stat = std::mem::MaybeUninit::<libc::stat>::uninit();
        // SAFETY: fstat initializes the provided stat buffer on success.
        if unsafe { libc::fstat(self.fd, stat.as_mut_ptr()) } != 0 {
            return false;
        }
        // SAFETY: fstat succeeded above.
        let stat = unsafe { stat.assume_init() };
        // Comparing identity also catches another test reusing the closed FD.
        (stat.st_dev, stat.st_ino) == (self.device, self.inode)
    }
}

async fn cancelled_create(
    resource: Resource,
    cancel_before_send: bool,
    code: i32,
) {
    let mut harness = Harness::new();
    let (mut creation, socket) = harness.create(resource);
    assert!(futures::poll!(creation.as_mut()).is_pending());
    // The creation task can enqueue its request, but the connection has not
    // been polled and therefore cannot transmit it yet.
    tokio::task::yield_now().await;
    let request = if cancel_before_send {
        drop(creation);
        if let Some(socket) = &socket {
            assert!(socket.is_open(), "cancellation closed the queued FD");
        }
        harness.next_request(resource.create_cmd()).await
    } else {
        let request = harness.next_request(resource.create_cmd()).await;
        drop(creation);
        request
    };
    if let Some(socket) = &socket {
        assert!(socket.is_open(), "socket closed before CREATE ACK");
        assert!(
            payload(&request)
                .attributes
                .contains(&L2tpAttribute::Fd(socket.fd))
        );
    }
    harness.ack(&request, code);
    if code == 0 {
        if matches!(resource, Resource::Session) {
            harness.session_lookup(false).await;
        }
        harness.finish_cleanup(resource).await;
    } else {
        // EEXIST means this task never acquired ownership. No DELETE may be
        // sent, since it could remove an existing resource owned by a caller.
        harness.assert_idle().await;
    }
    if let Some(socket) = &socket {
        assert!(!socket.is_open(), "unclaimed socket was not released");
    }
}

#[tokio::test]
async fn cancelled_managed_create_keeps_the_queued_socket_until_ack() {
    for before_send in [true, false] {
        cancelled_create(Resource::Managed, before_send, 0).await;
    }
}

#[tokio::test]
async fn cancelled_unmanaged_create_deletes_after_ack() {
    for before_send in [true, false] {
        cancelled_create(Resource::Unmanaged, before_send, 0).await;
    }
}

#[tokio::test]
async fn cancelled_session_create_deletes_after_ack_and_lookup() {
    for before_send in [true, false] {
        cancelled_create(Resource::Session, before_send, 0).await;
    }
}

#[tokio::test]
async fn failed_cancelled_creates_do_not_delete_existing_resources() {
    for resource in [Resource::Managed, Resource::Unmanaged, Resource::Session]
    {
        for before_send in [true, false] {
            cancelled_create(resource, before_send, libc::EEXIST).await;
        }
    }
}

#[tokio::test]
async fn v2_session_creation_rejects_oversized_ids_before_create() {
    for (local, peer, invalid) in [
        (0x1_0000, 202, 0x1_0000),
        (201, 0x1_0000, 0x1_0000),
        (u32::MAX, u32::MAX, u32::MAX),
    ] {
        let mut harness = Harness::new();
        let handle = harness.handle.clone();
        let creation = tokio::spawn(async move {
            handle
                .create_session(SessionConfig::ppp(
                    TunnelId(101),
                    SessionId(local),
                    SessionId(peer),
                ))
                .await
        });
        let get = harness.next_request(L2tpCmd::TunnelGet).await;
        harness.tunnel_reply(&get, L2tpVersion::V2);
        // No CREATE or DELETE may be sent for an invalid V2 configuration.
        harness.assert_idle().await;
        assert!(matches!(
            creation.await.unwrap(),
            Err(crate::Error::V2IdTooLarge(id)) if id == invalid
        ));
    }
}

#[tokio::test]
async fn session_creation_preserves_ids_valid_for_the_parent_version() {
    for (local, peer) in [
        (u16::MAX as u32, u16::MAX as u32),
        (u32::MAX, 202),
        (201, u32::MAX),
    ] {
        let mut harness = Harness::new();
        let handle = harness.handle.clone();
        let creation = tokio::spawn(async move {
            handle
                .create_session(SessionConfig::ppp(
                    TunnelId(101),
                    SessionId(local),
                    SessionId(peer),
                ))
                .await
        });
        // IDs that fit V2 need no extra lookup. Larger IDs require V3.
        if local > u16::MAX as u32 || peer > u16::MAX as u32 {
            let get = harness.next_request(L2tpCmd::TunnelGet).await;
            harness.tunnel_reply(&get, L2tpVersion::V3);
        }
        let create = harness.next_request(L2tpCmd::SessionCreate).await;
        assert!(
            payload(&create)
                .attributes
                .contains(&L2tpAttribute::SessionId(local))
        );
        assert!(
            payload(&create)
                .attributes
                .contains(&L2tpAttribute::PeerSessionId(peer))
        );
        harness.ack(&create, 0);
        let get = harness.next_request(L2tpCmd::SessionGet).await;
        let mut message = L2tpMessage::new(L2tpCmd::SessionGet);
        message.attributes = vec![
            L2tpAttribute::ConnId(101),
            L2tpAttribute::PeerConnId(102),
            L2tpAttribute::SessionId(local),
            L2tpAttribute::PeerSessionId(peer),
            L2tpAttribute::PwType(L2tpPwType::Ppp),
        ];
        let mut genl = GenlMessage::from_payload(message);
        genl.set_resolved_family_id(1234);
        harness.reply(&get, Message::from(genl));
        for _ in 0..8 {
            harness.step().await;
        }
        let mut session = creation.await.unwrap().unwrap();
        assert_eq!(session.session_id(), SessionId(local));
        session.set_auto_delete(false);
        drop(session);
        harness.assert_idle().await;
    }
}

#[tokio::test]
async fn session_creation_stops_when_parent_version_lookup_fails() {
    let mut harness = Harness::new();
    let handle = harness.handle.clone();
    let creation = tokio::spawn(async move {
        handle
            .create_session(SessionConfig::ppp(
                TunnelId(101),
                SessionId(0x1_0000),
                SessionId(202),
            ))
            .await
    });
    let get = harness.next_request(L2tpCmd::TunnelGet).await;
    harness.ack(&get, libc::ENODEV);
    harness.assert_idle().await;
    assert_eq!(
        creation.await.unwrap().unwrap_err().raw_os_error(),
        Some(libc::ENODEV)
    );
}

#[tokio::test]
async fn cancellation_during_session_lookup_still_deletes_the_session() {
    for lookup_fails in [false, true] {
        let mut harness = Harness::new();
        let (mut creation, _) = harness.create(Resource::Session);
        assert!(futures::poll!(creation.as_mut()).is_pending());
        let create = harness.next_request(L2tpCmd::SessionCreate).await;
        harness.ack(&create, 0);
        // Drive through the ACK while leaving GET and its reply pending.
        for _ in 0..4 {
            harness.step().await;
        }
        drop(creation);
        harness.session_lookup(lookup_fails).await;
        harness.finish_cleanup(Resource::Session).await;
    }
}

#[tokio::test]
async fn completed_but_unclaimed_creation_results_are_deleted() {
    for resource in [Resource::Managed, Resource::Unmanaged, Resource::Session]
    {
        let mut harness = Harness::new();
        let (mut creation, socket) = harness.create(resource);
        assert!(futures::poll!(creation.as_mut()).is_pending());
        let create = harness.next_request(resource.create_cmd()).await;
        harness.ack(&create, 0);
        if matches!(resource, Resource::Session) {
            harness.session_lookup(false).await;
        }
        for _ in 0..8 {
            harness.step().await;
        }
        // The task has finished, but its caller has not polled the JoinHandle
        // to claim the result. Cancelling must drop that completed result too.
        assert!(harness.wire.lock().unwrap().requests.is_empty());
        if let Some(socket) = &socket {
            assert!(socket.is_open());
        }
        // Drop on a thread with no Tokio context: cleanup must still use the
        // runtime that owns the creation task.
        std::thread::spawn(move || drop(creation)).join().unwrap();
        harness.finish_cleanup(resource).await;
        if let Some(socket) = &socket {
            assert!(!socket.is_open());
        }
    }
}

#[tokio::test]
async fn requests_retry_once_after_the_family_id_changed() {
    // Generic netlink answers ENOENT for a family it no longer knows, which
    // happens when l2tp_netlink was reloaded under a new identifier.
    let mut harness = Harness::new();
    let handle = harness.handle.clone();
    let lookup =
        tokio::spawn(async move { handle.get_tunnel(TunnelId(101)).await });
    let get = harness.next_request(L2tpCmd::TunnelGet).await;
    assert_eq!(get.header.message_type, TEST_FAMILY_ID);
    harness.ack(&get, libc::ENOENT);

    let query = harness.next_family_query().await;
    harness.family_reply(&query, 4321);
    let get = harness.next_request(L2tpCmd::TunnelGet).await;
    assert_eq!(get.header.message_type, 4321);
    harness.tunnel_reply_from(&get, L2tpVersion::V3, 4321);

    let info = harness.settle(lookup).await.unwrap();
    assert_eq!(info.tunnel_id, TunnelId(101));
    let family = harness.handle.inner.cached_family().unwrap();
    assert_eq!(family.id, 4321);
    assert_eq!(family.events_group, Some(7));
    harness.assert_idle().await;
}

#[tokio::test]
async fn requests_are_not_retried_while_the_family_id_is_unchanged() {
    let mut harness = Harness::new();
    let handle = harness.handle.clone();
    let lookup =
        tokio::spawn(async move { handle.get_tunnel(TunnelId(101)).await });
    let get = harness.next_request(L2tpCmd::TunnelGet).await;
    harness.ack(&get, libc::ENOENT);
    let query = harness.next_family_query().await;
    harness.family_reply(&query, TEST_FAMILY_ID);
    // The identifier is current, so ENOENT is the kernel's real answer.
    assert_eq!(
        harness.settle(lookup).await.unwrap_err().raw_os_error(),
        Some(libc::ENOENT)
    );
    harness.assert_idle().await;
}

#[test]
fn deletion_wait_handles_present_tunnels_without_runtime_drivers() {
    let runtime = tokio::runtime::Builder::new_current_thread()
        .build()
        .unwrap();
    runtime.block_on(async {
        for code in [libc::ENODEV, libc::EIO] {
            let mut harness = Harness::new();
            let handle = harness.handle.clone();
            let mut wait = Box::pin(handle.wait_tunnel_removed(TunnelId(101)));
            assert!(futures::poll!(wait.as_mut()).is_pending());
            let get = harness.next_request(L2tpCmd::TunnelGet).await;
            let mut message = L2tpMessage::new(L2tpCmd::TunnelGet);
            message.attributes = vec![
                L2tpAttribute::ConnId(101),
                L2tpAttribute::PeerConnId(102),
                L2tpAttribute::ProtoVersion(3),
                L2tpAttribute::EncapType(
                    netlink_packet_l2tp::L2tpEncapType::Ip,
                ),
                L2tpAttribute::IpSaddr(std::net::Ipv4Addr::LOCALHOST),
                L2tpAttribute::IpDaddr(std::net::Ipv4Addr::LOCALHOST),
            ];
            let mut genl = GenlMessage::from_payload(message);
            genl.set_resolved_family_id(1234);
            harness.reply(&get, Message::from(genl));

            // The first lookup still finds the tunnel. Drive the transport
            // until the pacing thread wakes the wait for another lookup,
            // without enabling Tokio's timer or I/O drivers.
            let get = futures::future::poll_fn(|cx| {
                assert!(wait.as_mut().poll(cx).is_pending());
                assert!(harness.connection.as_mut().poll(cx).is_pending());
                match harness.wire.lock().unwrap().requests.pop_front() {
                    Some(raw) => Poll::Ready(Message::deserialize(&raw)),
                    None => Poll::Pending,
                }
            })
            .await
            .unwrap();
            assert_eq!(payload(&get).cmd, L2tpCmd::TunnelGet);
            harness.ack(&get, code);
            let result = futures::future::poll_fn(|cx| {
                let result = wait.as_mut().poll(cx);
                assert!(harness.connection.as_mut().poll(cx).is_pending());
                result
            })
            .await;
            if code == libc::ENODEV {
                result.unwrap();
            } else {
                assert_eq!(result.unwrap_err().raw_os_error(), Some(code));
            }
            assert!(harness.wire.lock().unwrap().requests.is_empty());
        }
    });
}