quilkin 0.10.0

Quilkin is a non-transparent UDP proxy specifically designed for use with large scale multiplayer dedicated game server deployments, to ensure security, access control, telemetry data, metrics and more.
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
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
use crate::{
    filters::{self, Filter as _},
    metrics::{self, AsnInfo},
    net::{
        EndpointAddress,
        error::PipelineError,
        maxmind_db::{self, IpNetEntry},
        sessions::inner_metrics as session_metrics,
    },
    time::UtcTimestamp,
};
pub use quilkin_xdp::xdp;
use quilkin_xdp::xdp::{
    Umem,
    packet::{
        Packet, PacketError, csum,
        net_types::{IpAddresses, NetworkU16, UdpHdr, UdpHeaders},
    },
    slab::{Slab, StackSlab},
};
use std::{
    collections::hash_map::Entry,
    net::{IpAddr, SocketAddr},
    sync::{
        Arc,
        atomic::{AtomicU16, Ordering},
    },
    time::Instant,
};

/// Wrapper around the actual packet buffer and the UDP metadata it parsed to
/// so that we can satisify the filter traits
struct PacketWrapper {
    buffer: Packet,
    headers: UdpHeaders,
}

impl filters::Packet for PacketWrapper {
    #[inline]
    fn as_slice(&self) -> &[u8] {
        &self.buffer[self.headers.data.start..self.headers.data.end]
    }

    #[inline]
    fn len(&self) -> usize {
        self.headers.data_length()
    }
}

impl filters::PacketMut for PacketWrapper {
    type FrozenPacket = PacketWrapper;

    #[inline]
    fn extend_head(&mut self, bytes: &[u8]) {
        self.buffer
            .insert(self.headers.data.start, bytes)
            .expect("failed to extend head");
        self.headers.data.end += bytes.len();
    }

    #[inline]
    fn extend_tail(&mut self, bytes: &[u8]) {
        self.buffer.append(bytes).expect("failed to extend head");
        self.headers.data.end += bytes.len();
    }

    #[inline]
    fn remove_head(&mut self, length: usize) {
        let mut data = [0u8; 2048];

        if length > self.headers.data_length() || length == 0 {
            return;
        }

        let Some(slice) = self
            .buffer
            .get(self.headers.data.start + length..self.headers.data.end)
        else {
            if self.buffer.adjust_tail(-(length as i32)).is_ok() {
                self.headers.data.end -= length;
            }
            return;
        };
        let remainder = slice.len();
        data[..remainder].copy_from_slice(slice);

        let Some(slice) = self
            .buffer
            .get_mut(self.headers.data.start..self.headers.data.start + remainder)
        else {
            return;
        };
        slice.copy_from_slice(&data[..remainder]);

        if self.buffer.adjust_tail(-(length as i32)).is_ok() {
            self.headers.data.end -= length;
        }
    }

    #[inline]
    fn remove_tail(&mut self, length: usize) {
        if self.buffer.adjust_tail(-(length as i32)).is_ok() {
            self.headers.data.end -= length;
        }
    }

    // Only used in the io-uring implementation
    fn freeze(self) -> Self::FrozenPacket {
        unreachable!();
    }
}

use crate::config;

#[derive(Clone)]
pub struct ConfigState {
    pub filters: config::filter::CachedFilterChain,
    pub clusters: config::Watch<crate::net::ClusterMap>,
}

pub struct State {
    /// The external port is how we determine if packets come from clients (downstream)
    /// or servers (upstream)
    pub external_port: NetworkU16,
    pub qcmp_port: NetworkU16,
    pub destinations: Vec<EndpointAddress>,
    pub addr_to_asn: std::collections::HashMap<IpAddr, Option<(IpNetEntry, maxmind_db::Asn)>>,
    pub sessions: Arc<SessionState>,
    pub local_ipv4: std::net::Ipv4Addr,
    pub local_ipv6: std::net::Ipv6Addr,
    pub last_receive: UtcTimestamp,
}

impl State {
    /// Maps a remote server (upstream) endpoint back to the client endpoint
    /// that initiated the session
    #[inline]
    fn lookup_client(
        &self,
        server_addr: SocketAddr,
        port: NetworkU16,
    ) -> Option<(SocketAddr, AsnInfo<'_>)> {
        let addr = self.sessions.lookup_client(server_addr, port)?;
        let entry = self
            .addr_to_asn
            .get(&addr.ip())
            .and_then(|ipe| {
                ipe.as_ref().map(|(ipe, asn)| AsnInfo {
                    prefix: &ipe.prefix,
                    asn: asn.as_str(),
                })
            })
            .unwrap_or(metrics::EMPTY);

        Some((addr, entry))
    }

    /// Retrieves or creates a session, ie a mapping of a server endpoint + port
    /// to a client endpoint
    #[inline]
    fn session(
        &mut self,
        client_addr: SocketAddr,
        server_addr: SocketAddr,
    ) -> (NetworkU16, AsnInfo<'_>, IpAddresses) {
        let ips = self.ips(server_addr.ip());
        let asn = self.addr_to_asn.entry(client_addr.ip()).or_insert_with(|| {
            let ipe = maxmind_db::MaxmindDb::lookup(client_addr.ip());
            ipe.map(|ipe| {
                let asn = maxmind_db::Asn::new(ipe.id);
                (ipe, asn)
            })
        });

        let port =
            self.sessions
                .get_or_create(client_addr, server_addr, asn.as_ref().map(|(ipe, _)| ipe));

        (
            port,
            asn.as_ref().map_or(metrics::EMPTY, |(ipe, asn)| AsnInfo {
                prefix: &ipe.prefix,
                asn: asn.as_str(),
            }),
            ips,
        )
    }

    #[inline]
    fn ips(&self, destination: IpAddr) -> IpAddresses {
        match destination {
            IpAddr::V4(destination) => IpAddresses::V4 {
                source: self.local_ipv4,
                destination,
            },
            IpAddr::V6(destination) => IpAddresses::V6 {
                source: self.local_ipv6,
                destination,
            },
        }
    }
}

/// Linux by default only allocates ephemeral ports between 32768..=60999
/// (see `/proc/sys/net/ipv4/ip_local_port_range`), so we take advantage and only
/// allocate ports above that range. Note that we check that this range hasn't
/// been modified during XDP initialization, if that changes the port mapping
/// code could cause issues
const EPHEMERAL_RANGE_END: u16 = 61000;
/// With 18 bytes per address, this lets each bucket fit in < 2k
const BUCKET_SIZE: usize = 112;

#[repr(C)]
struct Item {
    octets: [u8; 16],
    port: u16,
}

impl Item {
    #[inline]
    fn set(&mut self, addr: SocketAddr) {
        match addr {
            SocketAddr::V4(v4) => {
                // We'll never be sending to multicast addresses, so use that
                // fact to encode that this is an ipv4 address
                self.octets[0] = 0xff;
                self.octets[12..].copy_from_slice(&v4.ip().octets());
            }
            SocketAddr::V6(v6) => {
                self.octets = v6.ip().octets();
            }
        }

        self.port = addr.port();
    }

    #[inline]
    fn get(&self) -> SocketAddr {
        if self.octets[0] == 0xff {
            (
                std::net::Ipv4Addr::new(
                    self.octets[12],
                    self.octets[13],
                    self.octets[14],
                    self.octets[15],
                ),
                self.port,
            )
                .into()
        } else {
            (std::net::Ipv6Addr::from(self.octets), self.port).into()
        }
    }
}

struct PortMap {
    buckets: Vec<[Item; BUCKET_SIZE]>,
}

impl PortMap {
    #[inline]
    fn new() -> Self {
        Self {
            // SAFETY: Item is POD
            buckets: vec![unsafe { std::mem::zeroed() }],
        }
    }

    #[inline]
    fn get(&self, port: NetworkU16) -> Option<SocketAddr> {
        let i = (port.host() - EPHEMERAL_RANGE_END) as usize;
        let bucket = i / BUCKET_SIZE;

        let bucket = self.buckets.get(bucket)?;

        // SAFETY: We know the index is valid
        unsafe {
            let item = bucket.get_unchecked(i % BUCKET_SIZE);

            // A zero port means this item was never initialized
            if item.port == 0 {
                return None;
            }

            Some(item.get())
        }
    }

    #[inline]
    fn insert(&mut self, client_addr: SocketAddr, port: u16) {
        let i = (port - EPHEMERAL_RANGE_END) as usize;
        let bucket = i / BUCKET_SIZE;
        if self.buckets.len() == bucket {
            // SAFETY: POD
            self.buckets.push(unsafe { std::mem::zeroed() });
        }

        // SAFETY: We've guaranteed we have a bucket at the index, and the
        // bucket has a fixed size of initialized bytes ready
        unsafe {
            self.buckets
                .get_unchecked_mut(bucket)
                .get_unchecked_mut(i % BUCKET_SIZE)
                .set(client_addr);
        }
    }
}

struct ClientInfo {
    asn_info: Option<IpNetEntry>,
    created_at: Instant,
    /// The port used to identify this unique session to the IP owning this map
    port: NetworkU16,
}

struct PortMapper {
    /// Maps a client endpoint to the port used as the source port for sending
    /// to the server endpoint `Self` is associated with
    client_to_port: Arc<parking_lot::Mutex<std::collections::HashMap<SocketAddr, ClientInfo>>>,
    port_to_client: Arc<parking_lot::RwLock<PortMap>>,
    port: AtomicU16,
}

impl PortMapper {
    #[inline]
    fn new() -> Self {
        Self {
            client_to_port: Arc::new(Default::default()),
            port_to_client: Arc::new(parking_lot::RwLock::new(PortMap::new())),
            port: AtomicU16::new(EPHEMERAL_RANGE_END),
        }
    }

    #[inline]
    fn get_or_alloc(
        &self,
        client_addr: SocketAddr,
        asn: Option<&IpNetEntry>,
    ) -> Option<NetworkU16> {
        match self.client_to_port.lock().entry(client_addr) {
            Entry::Occupied(entry) => Some(entry.get().port),
            Entry::Vacant(entry) => {
                let port = self.port.fetch_add(1, Ordering::Relaxed);

                if port < EPHEMERAL_RANGE_END {
                    // This means we've overflowed
                    return None;
                }

                session_metrics::total_sessions().inc();
                session_metrics::active_sessions(asn).inc();

                self.port_to_client.write().insert(client_addr, port);

                let port = port.into();
                entry.insert(ClientInfo {
                    asn_info: asn.cloned(),
                    created_at: Instant::now(),
                    port,
                });
                Some(port)
            }
        }
    }

    #[inline]
    fn get_client(&self, port: NetworkU16) -> Option<SocketAddr> {
        self.port_to_client.read().get(port)
    }
}

impl Drop for PortMapper {
    fn drop(&mut self) {
        let lock = self.client_to_port.lock();

        let now = Instant::now();

        for client_info in lock.values() {
            session_metrics::active_sessions(client_info.asn_info.as_ref()).dec();
            session_metrics::duration_secs()
                .observe(now.duration_since(client_info.created_at).as_secs_f64());
        }
    }
}

pub struct SessionState {
    sessions: crate::collections::ttl::TtlMap<SocketAddr, PortMapper>,
}

#[allow(clippy::derivable_impls)]
impl Default for SessionState {
    fn default() -> Self {
        Self {
            sessions: Default::default(),
        }
    }
}

impl SessionState {
    /// Attempts to lookup a client endpoint based on the server endpoint that sent
    /// the packet to the specified port
    #[inline]
    fn lookup_client(&self, server_addr: SocketAddr, port: NetworkU16) -> Option<SocketAddr> {
        self.sessions
            .get(&server_addr)
            .and_then(|pm| pm.get_client(port))
    }

    /// Retrieves the port used to forward packets from the specified client
    /// endpoint to the specified server endpoint, pairing the port to the client
    /// for forwarding packets back from the server to the client
    #[inline]
    fn get_or_create(
        &self,
        client_addr: SocketAddr,
        server_addr: SocketAddr,
        asn: Option<&IpNetEntry>,
    ) -> NetworkU16 {
        let port = match self.sessions.entry(server_addr) {
            crate::collections::ttl::Entry::Occupied(entry) => {
                entry.get().get_or_alloc(client_addr, asn)
            }
            crate::collections::ttl::Entry::Vacant(entry) => {
                let pm = PortMapper::new();
                let port = pm.get_or_alloc(client_addr, asn);
                entry.insert(pm);
                port
            }
        };

        if let Some(port) = port {
            return port;
        }

        // This means that this server has allocated over 4535 ports, which...could?
        // happen in some scenarios, but for now we just emit a warning, nuke the current
        // mapping. This means that if the server is still active and sends packets
        // in the future, they will either be dropped since we don't know what
        // the client endpoint is any longer, or, slightly worse, a packet gets
        // redirected to a different client.
        self.sessions.remove(server_addr);
        self.get_or_create(client_addr, server_addr, asn)
    }
}

#[inline]
pub fn process_packets<const RXN: usize, const TXN: usize>(
    rx_slab: &mut StackSlab<RXN>,
    umem: &mut Umem,
    tx_slab: &mut StackSlab<TXN>,
    config_state: &mut ConfigState,
    state: &mut State,
) {
    let filters = config_state.filters.load();
    let cm = config_state.clusters.clone_value();

    let now = UtcTimestamp::now();
    let jitter = (now - state.last_receive).nanos();
    state.last_receive = now;
    let mut had_read = false;

    while let Some(buffer) = rx_slab.pop_back() {
        let Ok(Some(headers)) = UdpHeaders::parse_packet(&buffer) else {
            unreachable!(
                "we somehow got a non-UDP packet, this should be impossible with the eBPF program we use to route packets"
            );
        };

        if headers.udp.destination == state.qcmp_port {
            process_qcmp_packet(buffer, headers, umem, tx_slab);
            continue;
        }

        let is_client = headers.udp.destination == state.external_port;
        let direction = if is_client {
            had_read = true;
            metrics::READ
        } else {
            metrics::WRITE
        };

        // This indicates a packet that is split, which we don't handle _at all_ right now
        if buffer.is_continued() {
            metrics::packets_dropped_total(direction, "split packet", &metrics::EMPTY).inc();
            umem.free_packet(buffer);
            continue;
        }

        let packet = PacketWrapper { buffer, headers };

        let res = {
            let _timer = metrics::processing_time(direction).start_timer();

            if is_client {
                process_client_packet(packet, umem, filters, &cm, state, tx_slab)
            } else {
                process_server_packet(packet, umem, filters, state, tx_slab, jitter)
            }
        };

        match res {
            Ok(None) => {}
            Ok(Some(packet)) => {
                umem.free_packet(packet);
            }
            Err((error, packet)) => {
                let discriminant = error.discriminant();
                error.inc_system_errors_total(direction, &metrics::EMPTY);
                metrics::packets_dropped_total(direction, discriminant, &metrics::EMPTY).inc();

                umem.free_packet(packet);
            }
        }
    }

    if had_read {
        metrics::packet_jitter(metrics::READ, &metrics::EMPTY).set(jitter);
    }
}

#[inline]
fn push_packet<const TXN: usize>(
    direction: metrics::Direction,
    packet: Packet,
    asn: AsnInfo<'_>,
    data_length: usize,
    res: Result<(), PacketError>,
    tx_slab: &mut StackSlab<TXN>,
    umem: &mut Umem,
) {
    match res {
        Ok(()) => {
            if let Some(packet) = tx_slab.push_front(packet) {
                metrics::packets_dropped_total(direction, "tx slab full", &metrics::EMPTY).inc();
                umem.free_packet(packet);
            } else {
                metrics::packets_total(direction, &asn).inc();
                metrics::bytes_total(direction, &asn).inc_by(data_length as u64);
            }
        }
        Err(err) => {
            let discriminant = err.discriminant();
            metrics::errors_total(direction, discriminant, &metrics::EMPTY).inc();
            metrics::packets_dropped_total(direction, discriminant, &metrics::EMPTY).inc();
            umem.free_packet(packet);
        }
    }
}

#[inline]
fn process_client_packet<const TXN: usize>(
    packet: PacketWrapper,
    umem: &mut Umem,
    filters: &filters::FilterChain,
    cm: &crate::net::ClusterMap,
    state: &mut State,
    tx_slab: &mut StackSlab<TXN>,
) -> Result<Option<Packet>, (PipelineError, Packet)> {
    let mut source_addr = packet.headers.source_address();
    source_addr.set_ip(source_addr.ip().to_canonical());

    let mut ctx =
        filters::ReadContext::new(cm, source_addr.into(), packet, &mut state.destinations);

    let mut packet = match filters.read(&mut ctx) {
        Ok(()) => ctx.contents,
        Err(err) => {
            return Err((PipelineError::Filter(err), ctx.contents.buffer));
        }
    };

    let Some(dest_addr) = state.destinations.pop() else {
        return Ok(Some(packet.buffer));
    };

    let data = &packet.buffer[packet.headers.data];

    // TODO: We _could_ be more clever with this and do a running checksum calculation
    // as the packet data is modified by the filters, but for now we just do the
    // full checksum for the sake of simplicity
    let data_checksum = csum::DataChecksum::calculate_if_needed(data, &packet.buffer);
    let data_length = data.len();

    let eth = packet.headers.eth.swapped();

    // If we have more than 1 destination we need to clone the packet data to
    // a new packet for each destination, only modifying the headers
    if !state.destinations.is_empty() {
        while let Some(daddr) = state.destinations.pop() {
            let Ok(dest_addr) = daddr.to_socket_addr() else {
                continue;
            };
            let (source, asn, ips) = state.session(source_addr, dest_addr);

            let mut headers = UdpHeaders {
                eth,
                ip: ips.with_header(&packet.headers.ip),
                udp: UdpHdr {
                    source,
                    destination: dest_addr.port().into(),
                    check: 0,
                    length: NetworkU16(0),
                },
                data: packet.headers.data,
            };

            // SAFETY: the umem outlives the frame
            let mut new_packet = unsafe {
                let Some(new_packet) = umem.alloc() else {
                    continue;
                };
                new_packet
            };

            let res = fill_packet(&mut headers, data, data_checksum, &mut new_packet);
            push_packet(
                metrics::Direction::Read,
                new_packet,
                asn,
                data_length,
                res,
                tx_slab,
                umem,
            );
        }
    }

    let Ok(dest_addr) = dest_addr.to_socket_addr() else {
        return Ok(Some(packet.buffer));
    };
    let (source, asn, ips) = state.session(source_addr, dest_addr);

    let mut headers = UdpHeaders {
        eth,
        ip: ips.with_header(&packet.headers.ip),
        udp: UdpHdr {
            source,
            destination: dest_addr.port().into(),
            check: 0,
            length: NetworkU16(0),
        },
        data: packet.headers.data,
    };

    headers.calc_checksum(data_checksum);

    let res = modify_packet_headers(&packet.headers, &mut headers, &mut packet.buffer);
    push_packet(
        metrics::Direction::Read,
        packet.buffer,
        asn,
        data_length,
        res,
        tx_slab,
        umem,
    );

    Ok(None)
}

#[inline]
fn process_server_packet<const TXN: usize>(
    packet: PacketWrapper,
    umem: &mut Umem,
    filters: &crate::filters::FilterChain,
    state: &mut State,
    tx_slab: &mut StackSlab<TXN>,
    jitter: i64,
) -> Result<Option<Packet>, (PipelineError, Packet)> {
    let mut server_addr = packet.headers.source_address();
    server_addr.set_ip(server_addr.ip().to_canonical());

    let Some((client_addr, asn)) = state.lookup_client(server_addr, packet.headers.udp.destination)
    else {
        tracing::debug!(address = %server_addr, "received traffic from a server that has no downstream");
        return Ok(Some(packet.buffer));
    };

    metrics::packet_jitter(metrics::Direction::Write, &asn).set(jitter);

    let mut ctx = filters::WriteContext::new(server_addr.into(), client_addr.into(), packet);

    let mut packet = match filters.write(&mut ctx) {
        Ok(()) => ctx.contents,
        Err(err) => {
            return Err((PipelineError::Filter(err), ctx.contents.buffer));
        }
    };

    let mut headers = UdpHeaders {
        eth: packet.headers.eth.swapped(),
        ip: state.ips(client_addr.ip()).with_header(&packet.headers.ip),
        udp: UdpHdr {
            source: state.external_port,
            destination: client_addr.port().into(),
            length: NetworkU16(0),
            check: 0,
        },
        data: packet.headers.data,
    };

    let res = modify_packet_headers(&packet.headers, &mut headers, &mut packet.buffer);
    if res.is_ok() {
        let _ = packet.buffer.calc_udp_checksum();
    }

    push_packet(
        metrics::Direction::Write,
        packet.buffer,
        asn,
        packet.headers.data_length(),
        res,
        tx_slab,
        umem,
    );
    Ok(None)
}

/// Modifies the headers of an existing well formed packet to a new source and destination,
/// resizing the header portion as needed if changing between ipv4 and ipv6
#[inline]
fn modify_packet_headers(
    original: &UdpHeaders,
    new: &mut UdpHeaders,
    packet: &mut Packet,
) -> Result<(), PacketError> {
    match (original.is_ipv4(), new.is_ipv4()) {
        (true, false) => packet.adjust_head(-20)?,
        (false, true) => packet.adjust_head(20)?,
        (_, _) => {}
    }

    new.set_packet_headers(packet)?;
    Ok(())
}

#[inline]
fn fill_packet(
    headers: &mut UdpHeaders,
    data: &[u8],
    data_checksum: csum::DataChecksum,
    frame: &mut Packet,
) -> Result<(), PacketError> {
    let hdr_len = headers.header_length();
    frame.adjust_tail(hdr_len as i32)?;
    headers.calc_checksum(data_checksum);
    headers.set_packet_headers(frame)?;
    frame.insert(hdr_len, data)?;
    Ok(())
}

fn process_qcmp_packet<const TXN: usize>(
    mut packet: Packet,
    headers: UdpHeaders,
    umem: &mut Umem,
    tx_slab: &mut StackSlab<TXN>,
) {
    use crate::{codec::qcmp, time::UtcTimestamp};

    fn inner(packet: &mut Packet, headers: UdpHeaders) -> bool {
        let received_at = UtcTimestamp::now();
        let Some(data) = packet.get(headers.data.start..headers.data.end) else {
            tracing::debug!("corrupt UDP packet, data payload is out of range");
            return false;
        };
        let command = match qcmp::Protocol::parse(data) {
            Ok(Some(command)) => command,
            Ok(None) => {
                tracing::debug!("rejected non-qcmp packet");
                return false;
            }
            Err(error) => {
                tracing::debug!(%error, "rejected malformed packet");
                return false;
            }
        };

        let qcmp::Protocol::Ping {
            client_timestamp,
            nonce,
        } = command
        else {
            tracing::warn!("rejected unsupported QCMP packet");
            return false;
        };

        let mut ob = qcmp::QcmpPacket::default();
        let buf = qcmp::Protocol::ping_reply(nonce, client_timestamp, received_at).encode(&mut ob);

        if let Err(error) = packet.adjust_tail(-(headers.data_length() as i32)) {
            tracing::debug!(%error, "unable to trim QCMP ping data");
            return false;
        }

        if let Err(error) = packet.insert(headers.data.start, buf) {
            tracing::debug!(%error, "unable to write QCMP pong data");
            return false;
        }

        let mut new = UdpHeaders::new(
            headers.eth.swapped(),
            headers.ip.swapped(),
            headers.udp.swapped(),
            headers.data.start..headers.data.start + buf.len(),
        );
        new.decrement_hop();

        if let Err(error) = modify_packet_headers(&headers, &mut new, packet) {
            tracing::debug!(%error, "unable to modify QCMP packet headers");
            return false;
        }

        if let Err(error) = packet.calc_udp_checksum() {
            tracing::debug!(%error, "failed to calculate QCMP packet checksum");
            return false;
        }

        true
    }

    let packet = if inner(&mut packet, headers) {
        tracing::debug!("sending QCMP pong");

        if let Some(packet) = tx_slab.push_front(packet) {
            tracing::debug!("tx slab full, unable to send QCMP pong");
            packet
        } else {
            return;
        }
    } else {
        packet
    };

    umem.free_packet(packet);
}

#[cfg(test)]
mod test {
    use super::*;
    use quilkin_xdp::xdp::packet::Pod;
    use xdp::packet::net_types as nt;

    #[test]
    fn xdp_buffer_manipulation() {
        let payload = [0xfdu8; 21];

        let mut v6 = nt::Ipv6Hdr::zeroed();
        v6.reset(64, nt::IpProto::Udp);
        v6.source = [13; 16];
        v6.destination = [8; 16];
        let mut headers = UdpHeaders::new(
            nt::EthHdr {
                source: nt::MacAddress([1; 6]),
                destination: nt::MacAddress([2; 6]),
                ether_type: nt::EtherType::Ipv6,
            },
            nt::IpHdr::V6(v6),
            UdpHdr {
                source: 22.into(),
                destination: 20021.into(),
                length: NetworkU16(0),
                check: 0,
            },
            nt::EthHdr::LEN + nt::Ipv6Hdr::LEN + nt::UdpHdr::LEN
                ..nt::EthHdr::LEN + nt::Ipv6Hdr::LEN + nt::UdpHdr::LEN + payload.len(),
        );

        let mut data = [0u8; 2048];
        let mut buffer = xdp::Packet::testing_new(&mut data);
        buffer.adjust_tail(headers.data.start as _).unwrap();
        headers.set_packet_headers(&mut buffer).unwrap();
        buffer.insert(headers.data.start, &payload).unwrap();
        buffer.calc_udp_checksum().unwrap();

        let mut wrapper = PacketWrapper { buffer, headers };

        use crate::filters::{Packet, PacketMut};

        assert_eq!(wrapper.as_slice(), payload);

        {
            const HEAD: &[u8] = &[1; 3];
            wrapper.extend_head(HEAD);
            assert_eq!(&wrapper.as_slice()[..HEAD.len()], HEAD);
            assert_eq!(wrapper.as_slice()[HEAD.len()..], payload);
            assert_eq!(wrapper.headers.data_length(), payload.len() + HEAD.len());
            wrapper.remove_head(HEAD.len());
        }

        assert_eq!(wrapper.as_slice(), payload);

        {
            const TAIL: &[u8] = &[8; 20];
            wrapper.extend_tail(TAIL);
            assert_eq!(wrapper.as_slice()[..payload.len()], payload);
            assert_eq!(&wrapper.as_slice()[payload.len()..], TAIL);
            assert_eq!(wrapper.headers.data_length(), payload.len() + TAIL.len());
            wrapper.remove_tail(TAIL.len());
        }

        assert_eq!(wrapper.as_slice(), payload);
    }
}