Hello XDP!

源代码

本章示例的完整代码可在此处找到。

示例项目

虽然有许多跟踪点可以附加和编写程序类型，但我们应该从简单的地方开始。

XDP（eXpress Data Path）程序允许我们的eBPF程序对接收到的数据包做出决策，以决定是否允许数据包通过接口。为了保持简单，我们将构建一个非常简单的防火墙来允许或拒绝流量。

eBPF组件

允许所有流量

我们必须首先编写我们程序的eBPF组件。这是一个允许所有流量的最小化生成的XDP程序。该程序的逻辑位于xdp-hello-ebpf/src/main.rs中，目前看起来是这样的：

xdp-hello-ebpf/src/main.rs
#![no_std] // (1)
#![no_main] // (2)

use aya_ebpf::{bindings::xdp_action, macros::xdp, programs::XdpContext};
use aya_log_ebpf::info;

#[xdp] // (4)
pub fn xdp_hello(ctx: XdpContext) -> u32 {
    // (5)
    match unsafe { try_xdp_hello(ctx) } {
        Ok(ret) => ret,
        Err(_) => xdp_action::XDP_ABORTED,
    }
}

unsafe fn try_xdp_hello(ctx: XdpContext) -> Result<u32, u32> {
    // (6)
    info!(&ctx, "received a packet");
    // (7)
    Ok(xdp_action::XDP_PASS)
}

#[panic_handler] // (3)
fn panic(_info: &core::panic::PanicInfo) -> ! {
    unsafe { core::hint::unreachable_unchecked() }
}

使用#![no_std] 是因为我们不能使用标准库。
使用#![no_main] 是因为我们没有主函数。
#[panic_handler] 是为了让编译器满意，尽管它从未使用过，因为我们不能panic。
这表明这个函数是一个XDP程序。
我们的主入口点委托给另一个函数并执行错误处理，返回XDP_ABORTED，这将丢弃数据包。
每次接收到数据包时写入日志条目。
这个函数返回一个允许所有流量的Result。

现在我们可以使用cargo xtask build-ebpf来编译它。

验证程序

让我们看看编译后的eBPF程序：

$ llvm-objdump -S target/bpfel-unknown-none/debug/xdp-hello

target/bpfel-unknown-none/debug/xdp-hello:  file format elf64-bpf

Disassembly of section .text:

0000000000000000 <memset>:
       0:   15 03 06 00 00 00 00 00 if r3 == 0 goto +6 <LBB1_3>
       1:   b7 04 00 00 00 00 00 00 r4 = 0

0000000000000010 <LBB1_2>:
       2:   bf 15 00 00 00 00 00 00 r5 = r1
       3:   0f 45 00 00 00 00 00 00 r5 += r4
       4:   73 25 00 00 00 00 00 00 *(u8 *)(r5 + 0) = r2
       5:   07 04 00 00 01 00 00 00 r4 += 1
       6:   2d 43 fb ff 00 00 00 00 if r3 > r4 goto -5 <LBB1_2>

0000000000000038 <LBB1_3>:
       7:   95 00 00 00 00 00 00 00 exit

0000000000000040 <memcpy>:
       8:   15 03 09 00 00 00 00 00 if r3 == 0 goto +9 <LBB2_3>
       9:   b7 04 00 00 00 00 00 00 r4 = 0

0000000000000050 <LBB2_2>:
      10:   bf 15 00 00 00 00 00 00 r5 = r1
      11:   0f 45 00 00 00 00 00 00 r5 += r4
      12:   bf 20 00 00 00 00 00 00 r0 = r2
      13:   0f 40 00 00 00 00 00 00 r0 += r4
      14:   71 00 00 00 00 00 00 00 r0 = *(u8 *)(r0 + 0)
      15:   73 05 00 00 00 00 00 00 *(u8 *)(r5 + 0) = r0
      16:   07 04 00 00 01 00 00 00 r4 += 1
      17:   2d 43 f8 ff 00 00 00 00 if r3 > r4 goto -8 <LBB2_2>

0000000000000090 <LBB2_3>:
      18:   95 00 00 00 00 00 00 00 exit

Disassembly of section xdp/xdp_hello:

0000000000000000 <xdp_hello>:
       0:   bf 16 00 00 00 00 00 00 r6 = r1
       1:   b7 07 00 00 00 00 00 00 r7 = 0
       2:   63 7a fc ff 00 00 00 00 *(u32 *)(r10 - 4) = r7
       3:   bf a2 00 00 00 00 00 00 r2 = r10
:
     245:   18 03 00 00 ff ff ff ff 00 00 00 00 00 00 00 00 r3 = 4294967295 ll
     247:   bf 04 00 00 00 00 00 00 r4 = r0
     248:   b7 05 00 00 aa 00 00 00 r5 = 170
     249:   85 00 00 00 19 00 00 00 call 25

00000000000007d0 <LBB0_2>:
     250:   b7 00 00 00 02 00 00 00 r0 = 2
     251:   95 00 00 00 00 00 00 00 exit

输出经过了简化以保持简洁。我们可以在这里看到一个xdp/xdp_hello段。在<LBB0_2>中，r0 = 2将寄存器0设置为2，这是XDP_PASS动作的值。 exit结束程序。

简单吧！

用户空间组件

现在我们的eBPF程序已经完成并编译，我们需要一个用户空间程序来加载它并将其附加到一个跟踪点。幸运的是，我们在xdp-hello/src/main.rs中有一个生成的程序可以为我们完成这项工作。

开始

让我们看看生成的用户空间应用程序的细节：

xdp-hello/src/main.rs
use anyhow::Context;
use aya::{
    include_bytes_aligned,
    programs::{Xdp, XdpFlags},
    Bpf,
};
use aya_log::BpfLogger;
use clap::Parser;
use log::info;
use tokio::signal; // (1)

#[derive(Debug, Parser)]
struct Opt {
    #[clap(short, long, default_value = "eth0")]
    iface: String, // (2)
}

#[tokio::main] // (3)
async fn main() -> Result<(), anyhow::Error> {
    let opt = Opt::parse();

    env_logger::init();

    // This will include your eBPF object file as raw bytes at compile-time and load it at
    // runtime. This approach is recommended for most real-world use cases. If you would
    // like to specify the eBPF program at runtime rather than at compile-time, you can
    // reach for `Bpf::load_file` instead.
    // (4)
    // (5)
    #[cfg(debug_assertions)]
    let mut bpf = Bpf::load(include_bytes_aligned!(
        "../../target/bpfel-unknown-none/debug/xdp-hello"
    ))?;
    #[cfg(not(debug_assertions))]
    let mut bpf = Bpf::load(include_bytes_aligned!(
        "../../target/bpfel-unknown-none/release/xdp-hello"
    ))?;
    BpfLogger::init(&mut bpf)?;
    // (6)
    let program: &mut Xdp = bpf.program_mut("xdp_hello").unwrap().try_into()?;
    program.load()?; // (7)
                     // (8)
    program.attach(&opt.iface, XdpFlags::default())
        .context("failed to attach the XDP program with default flags - try changing XdpFlags::default() to XdpFlags::SKB_MODE")?;

    info!("Waiting for Ctrl-C...");
    signal::ctrl_c().await?;
    info!("Exiting...");

    Ok(())
}

tokio是我们使用的异步库，它提供了一个Ctrl-C处理程序。在我们扩展初始程序的功能时，它将派上用场。
在这里我们声明了CLI标志。现在只有--iface用于传递接口名称。
这是我们的主入口点。
include_bytes_aligned!()在编译时复制BPF ELF对象文件的内容。
Bpf::load()从上一个命令的输出中读取BPF ELF对象文件的内容，创建任何映射，执行BTF重定位。
我们提取XDP程序。
然后将其加载到内核中。
最后，我们可以将其附加到接口。

让我们试试看！

$ cargo xtask run -- -h
    Finished dev [unoptimized + debuginfo] target(s) in 0.05s
     Running `target/debug/xtask run -- -h`
:
    Finished dev [optimized] target(s) in 0.90s
    Finished dev [unoptimized + debuginfo] target(s) in 0.60s
xdp-hello

USAGE:
    xdp-hello [OPTIONS]

OPTIONS:
    -h, --help             打印帮助信息
    -i, --iface <IFACE>    [默认: eth0]

接口名称

此命令假定接口默认是eth0。如果您希望附加到其他名称的接口，请使用RUST_LOG=info cargo xtask run -- --iface wlp2s0，其中wlp2s0是您的接口。

$ RUST_LOG=info cargo xtask run
[2022-12-21T18:03:09Z INFO  xdp_hello] Waiting for Ctrl-C...
[2022-12-21T18:03:11Z INFO  xdp_hello] received a packet
[2022-12-21T18:03:11Z INFO  xdp_hello] received a packet
[2022-12-21T18:03:11Z INFO  xdp_hello] received a packet
[2022-12-21T18:03:11Z INFO  xdp_hello] received a packet
^C[2022-12-21T18:03:11Z INFO  xdp_hello] Exiting...

因此，每次在接口上接收到数据包时，都会打印一个日志！

加载程序时出错？

如果加载程序时出错，请尝试将XdpFlags::default()更改为XdpFlags::SKB_MODE。

eBPF程序的生命周期

程序运行直到按下CTRL+C然后退出。退出时，Aya会帮助我们卸载程序。

如果在xdp_hello运行时发出sudo bpftool prog list命令，您可以验证它是否已加载：

958: xdp  name xdp_hello  tag 0137ce4fce70b467  gpl
    loaded_at 2022-06-23T13:55:28-0400  uid 0
    xlated 2016B  jited 1138B  memlock 4096B  map_ids 275,274,273
    pids xdp-hello(131677)

再次运行命令，一旦xdp_hello退出，将显示程序不再运行。