xdpilone 1.3.0

Interaction with Linux XDP sockets and rings. No libbpf/libxpd-sys. Lightweight, high-performance.
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

//! Rust idiomatic bindings for the AF_XDP socket interface.
//!
//! This library helps with creating suitable socket(s) from a memory allocation of chunks, sockets
//! for access to all four rings, binding to a specific `(ifname, queue_id)`, and for creating the
//! memory mapping to interact with all these queues directly.
//!
//! It does _not_ interact with the packet filter / forwarding directly, nor any other aspect of
//! `bpf`. You can send packets but you can not receive them. Please use another library for `bpf`
//! and `netlink` interaction to configure the network device to route received frames to the RX
//! ring.
//!
//! The entrypoint to the library is an instance of [`crate::Umem`].
#![no_std]
#![deny(missing_docs)]
extern crate alloc;

/// User-space side of one or multiple XDP sockets.
mod xsk;

pub use xsk::{
    BufIdx, CompletionQueue, DeviceQueue, FillQueue, IfInfo, ReadComplete, ReadRx, RingCons,
    RingProd, RingRx, RingTx, Socket, SocketConfig, Umem, UmemChunk, UmemConfig, User, WriteFill,
    WriteTx,
};

/// Bindings for XDP kernel-interface, including structs.
pub mod xdp;

pub(crate) struct LastErrno;

/// An error that has been read from `errno`.
//
// `Default` is a bit misleading even though there is a constructor without any parameters. In
// hindsight it may have been better to provide a descriptive name.
#[allow(clippy::new_without_default)]
pub struct Errno(libc::c_int);

impl From<LastErrno> for Errno {
    fn from(LastErrno: LastErrno) -> Self {
        Errno::last_os_error()
    }
}

impl Errno {
    /// Create an error from the latest `errno`.
    #[deprecated = "use the more descriptive name `Errno::last_os_error`"]
    #[doc(hidden)]
    pub fn new() -> Self {
        Self::last_os_error()
    }

    /// Create an error from the latest `errno`.
    pub fn last_os_error() -> Self {
        Errno(unsafe { *libc::__errno_location() })
    }

    /// Get the actual `errno` value.
    pub fn get_raw(&self) -> libc::c_int {
        self.0
    }
}

impl core::fmt::Display for Errno {
    fn fmt(&self, f: &mut core::fmt::Formatter<'_>) -> core::fmt::Result {
        let st = unsafe { libc::strerror(self.0) };
        let cstr = unsafe { core::ffi::CStr::from_ptr(st) };
        write!(f, "{}", cstr.to_string_lossy())
    }
}

impl core::fmt::Debug for Errno {
    fn fmt(&self, f: &mut core::fmt::Formatter<'_>) -> core::fmt::Result {
        write!(f, "Errno({}: {})", self.0, self)
    }
}