aya-ebpf 0.2.1

A library for writing eBPF programs
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

use aya_ebpf_bindings::bindings::bpf_cpumap_val;

use super::try_redirect_map;
use crate::{
    bindings::bpf_map_type::BPF_MAP_TYPE_CPUMAP,
    maps::{MapDef, PinningType},
};

/// An array of available CPUs.
///
/// XDP programs can use this map to redirect packets to a target CPU for processing.
///
/// # Minimum kernel version
///
/// The minimum kernel version required to use this feature is 4.15.
///
/// # Examples
///
/// ```rust,no_run
/// use aya_ebpf::{bindings::xdp_action, macros::{map, xdp}, maps::CpuMap, programs::XdpContext};
///
/// #[map]
/// static MAP: CpuMap = CpuMap::with_max_entries(8, 0);
///
/// #[xdp]
/// fn xdp(_ctx: XdpContext) -> u32 {
///     // Redirect to CPU 7 or drop packet if no entry found.
///     MAP.redirect(7, xdp_action::XDP_DROP as u64).unwrap_or(xdp_action::XDP_DROP)
/// }
/// ```
#[repr(transparent)]
pub struct CpuMap {
    def: MapDef,
}

impl super::super::private::Map for CpuMap {
    type Key = u32;
    type Value = bpf_cpumap_val;
}

impl CpuMap {
    map_constructors!(
        u32,
        bpf_cpumap_val,
        BPF_MAP_TYPE_CPUMAP,
        with_docs {
            /// Creates a [`CpuMap`] with a set maximum number of elements.
            ///
            /// In a CPU map, an entry represents a CPU core. Thus there should be as many entries
            /// as there are CPU cores on the system. `max_entries` can be set to zero here, and
            /// updated by userspace at runtime. Refer to the userspace documentation for more
            /// information.
            ///
            /// # Examples
            ///
            /// ```rust,no_run
            /// use aya_ebpf::{macros::map, maps::CpuMap};
            ///
            /// #[map]
            /// static MAP: CpuMap = CpuMap::with_max_entries(8, 0);
            /// ```
        },
        pinned_docs {
            /// Creates a [`CpuMap`] with a set maximum number of elements that can be pinned to
            /// the BPF File System (bpffs).
            ///
            /// See [`CpuMap::with_max_entries`] for more information.
            ///
            /// # Examples
            ///
            /// ```rust,no_run
            /// use aya_ebpf::{macros::map, maps::CpuMap};
            ///
            /// #[map]
            /// static MAP: CpuMap = CpuMap::pinned(8, 0);
            /// ```
        },
    );

    /// Redirects the current packet on the CPU at `index`.
    ///
    /// The lower two bits of `flags` are used for the return code if the map lookup fails, which
    /// can be used as the XDP program's return code if a CPU cannot be found.
    ///
    /// # Examples
    ///
    /// ```rust,no_run
    /// use aya_ebpf::{bindings::xdp_action, macros::{map, xdp}, maps::CpuMap, programs::XdpContext};
    ///
    /// #[map]
    /// static MAP: CpuMap = CpuMap::with_max_entries(8, 0);
    ///
    /// #[xdp]
    /// fn xdp(_ctx: XdpContext) -> u32 {
    ///     // Redirect to CPU 7 or drop packet if no entry found.
    ///     MAP.redirect(7, 0).unwrap_or(xdp_action::XDP_DROP)
    /// }
    /// ```
    #[inline(always)]
    pub fn redirect(&self, index: u32, flags: u64) -> Result<u32, u32> {
        try_redirect_map(self.def.as_ptr(), index, flags)
    }
}