Rust Aya 編寫 eBPF 程式

来源:https://www.cnblogs.com/davad/archive/2022/11/12/16883527.html
-Advertisement-
Play Games

Test 作業 提交學習筆記 編寫一個業務介面(登錄，查找學生等) 打包成jar包 在本機上面執行相應的命令，通過瀏覽器訪問介面獲得數據。 (可選)將該jar包放在伺服器上面運行，通過公網IP能夠訪問 我選擇實現一個登錄的介面 這是我的項目結構 以下是我的代碼實現 項目中的pojo的實現 即mode ...


本文地址：https://www.ebpf.top/post/ebpf_rust_aya

1. 前言

Linux 內核 6.1 版本中有一個非常引人註意的變化：引入了對 Rust 編程語言的支持。Rust 是一種系統編程語言，Rust 通過提供非常強大的編譯時保證和對記憶體生命周期的明確控制。在內核開發中引入 Rust 語言，將會為內核開發的早期帶來更多的安全保障。eBPF 是在內核中基於事件運行用戶自定義程式的技術，其驗證器機制可以保障運行在內核中 eBPF 程式的安全性。

Rust 與 eBPF 有著一個共同的目標：保證內核安全，只是兩者側重的維度有所不同。

儘管使用 Rust 編寫 eBPF 程式多數情況下都需要通過不安全的方式在內核進行記憶體讀寫，但是基於 Rust 和 Aya ，的確能夠給我們帶來一個快速和高效的開發體驗，這包括自動生成整個程式框架（eBPF 程式及對應的用戶空間代碼）、參數檢查確認、錯誤處理、統一的相關構建和管理方式等等 。

Aya 是一個以可操作性和開發者體驗為重點的 eBPF 庫，完全是在 Rust 基礎上建立的，只使用 libc 包來執行系統調用。Aya 官方倉庫地址為 https://github.com/aya-rs/aya/，當前版本為 v0.1.11，項目還處於偏早期。基於 Aya 庫開發 eBPF 程式可以給我們帶來以下的便利：

  • 基於 Rust 的 Cargo 工具來管理、構建和測試項目；
  • 支持 CO-RE 直接生成與 Rust 與內核文件的綁定；
  • 用戶工具代碼（Rust）與運行在的內核中的 eBPF 代碼輕鬆共用代碼；
  • 對於 LLVM、libbpf、bcc 等完全沒有任何依賴；

本文僅是基於 Aya 編寫 eBPF 程式及用戶空間程式的生成和測試的過程記錄，不涉及到對於生成 Rust 代碼的詳細解讀。

2. Rust 開發環境搭建

2.1 創建 VM 虛擬機

為了使用 Rust 進行 eBPF 程式編寫，那麼我們首先需要在本地搭建一個 Rust 開發環境。這裡我仍然採用 multipass 工具快速搭建一個 Ubuntu 22.04 LTS 的環境。

$ multipass launch --name rust-aya -d 20G

預設磁碟為 5G，比較容易造成磁碟空間滿，因此這裡將磁碟空間大小設置為 20G，你可以根據自己的情況調整。

對於已經創建的 mulipass 實例可以在創建後進行調整，則需要 multipass 版本大於 1.10，而且需要調整的實例處於停止狀態，詳細可參見調整實例配置，例如 multipass set local.rust-aya.cpus=4 或 multipass set local.rust-aya.memory=8G 分別用於調整實例的 CPU 和 MEM 大小。

2.2 安裝 Rust 開發環境

通常情況下，Rust 開發環境推薦通過 rustup 工具管理，我們可以通過以下命令快速安裝該工具：

$ curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh

一般情況下我們選擇預設選項安裝。整個安裝過程會下載一個腳本完成 rustup 工具安裝，同時也會安裝最新的 Rust 穩定版本。如果安裝順利，我們可以在最後看到如下的信息：

...
	stable-x86_64-unknown-linux-gnu installed - rustc 1.65.0 (897e37553 2022-11-02)

Rust is installed now. Great!

To get started you may need to restart your current shell.
This would reload your PATH environment variable to include
Cargo's bin directory ($HOME/.cargo/bin).

To configure your current shell, run:
source "$HOME/.cargo/env"

在 rustup 工具安裝完成後，我們可以使用其安裝 Rust 穩定版（實際上預設已經安裝）和 nightly ，其中 nightly 為開發者體驗新功能的發佈通道，Rust 2021 年開始支持編譯 eBPF，當前使用 Aya 需要基於 Rust Nightly 版本。

Rust 有 3 個發佈通道：

  • Nightly
  • Beta
  • Stable（穩定版）

大部分 Rust 開發者主要採用穩定版通道，不過希望實驗新功能的開發者可能會使用 nightly 或 beta 版。詳情參見附錄 G：Rust 是如何開發的與 “Nightly Rust”

$ source "$HOME/.cargo/env"
$ rustup install stable  # rustup 命令已經預設安裝
info: syncing channel updates for 'stable-x86_64-unknown-linux-gnu'

  stable-x86_64-unknown-linux-gnu unchanged - rustc 1.65.0 (897e37553 2022-11-02)

info: checking for self-updates
$ rustup toolchain install nightly --component rust-src
...
info: installing component 'rustfmt'

  nightly-x86_64-unknown-linux-gnu installed - rustc 1.67.0-nightly (09508489e 2022-11-04)

info: checking for self-updates

$ rustup toolchain list
stable-x86_64-unknown-linux-gnu (default)
nightly-x86_64-unknown-linux-gnu

安裝 nightly 以後我們可以使用 rustup toolchain list 查看本地開發環境的開發工具鏈。

2.3 安裝 bpf-linker 依賴 和 bpftool 工具

為了使用 Aya，我們還需要安裝依賴包 bpf-linker，但其依賴與 LLVM/Clang 等工具，因此我們也需要提前安裝：

$ sudo apt-get update
$ sudo apt-get install llvm clang -y
$ cargo install bpf-linker

最後，為了生成內核數據結構的綁定，我們還必須安裝 bpftool，可以從發行版中安裝或從源代碼中構建，這裡我選用發行版安裝方式（基於 Ubuntu 22.04），源碼安裝可參考 bpftool 倉庫說明文檔：

$ sudo apt install linux-tools-common linux-tools-5.15.0-52-generic linux-cloud-tools-5.15.0-52-generic -y

支持我們完成了基於 Aya 開發的整個環境及依賴的安裝。

3. Aya 嚮導創建 eBPF 程式

3.1 使用嚮導創建項目

Aya 提供了一套模版嚮導用於創建 eBPF 對應的程式類型，嚮導創建依賴於 cargo-generate，因此我們需要在運行程式嚮導前提前安裝：

$ cargo install cargo-generate

我在安裝 cargo-generate 過程中遇到瞭如下的錯誤，主要是由於依賴 openssl 庫問題導致，如果你也遇到類似問題可參考 cargo-generate 安裝指南 和 Rust OpenSSL 文檔，如果一切順利，則可忽略此處的提示。

...
warning: build failed, waiting for other jobs to finish...
error: failed to compile `cargo-generate v0.16.0`, intermediate artifacts can be found at `/tmp/cargo-install8NrREg
...

$ sudo apt install openssl pkg-config libssl-dev gcc m4 ca-certificates make perl -y
# 重新安裝即可

在完成依賴後，我們就可以使用嚮導來創建 eBPF 項目，這裡以 XDP 類型程式為例：

$ cargo generate https://github.com/aya-rs/aya-template

image-20221106221704771

這裡我們輸入項目名稱 myapp，eBPF 程式類型選擇 xdp，完成相關設定後，嚮導會自動幫我們創建一個名為 myapp 的 Rust 項目，項目包括了一個最簡單的 XDP 類型的 eBPF 程式及相對應的用戶空間程式。 myapp 目錄的整體夾頭如下所示：

├── Cargo.lock
├── Cargo.toml
├── README.md
├── myapp  # 用戶空間程式
│   ├── Cargo.toml
│   └── src
│       └── main.rs
├── myapp-common  # eBPF 程式與用戶空間程式復用的代碼庫
│   ├── Cargo.toml
│   └── src
│       └── lib.rs
├── myapp-ebpf  # eBPF 程式
│   ├── Cargo.lock
│   ├── Cargo.toml
│   ├── rust-toolchain.toml
│   └── src
│       └── main.rs
└── xtask  # build 相關的代碼
    ├── Cargo.toml
    └── src
        ├── build_ebpf.rs
        ├── main.rs
        └── run.rs

8 directories, 15 files

生成的 eBPF 程式位於 myapp-ebpf/src 目錄下，文件名為 main.rs，完整內容如下所示：

$ cat myapp-ebpf/src/main.rs
#![no_std]
#![no_main]

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

#[xdp(name="myapp")]
pub fn myapp(ctx: XdpContext) -> u32 {
    match try_myapp(ctx) {
        Ok(ret) => ret,
        Err(_) => xdp_action::XDP_ABORTED,
    }
}

fn try_myapp(ctx: XdpContext) -> Result<u32, u32> {
    info!(&ctx, "received a packet"); // 每接受到一個數據包則列印一個日誌
    Ok(xdp_action::XDP_PASS)
}

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

3.2 編譯 eBPF 程式

首先，我們使用 cargo 工具編譯 eBPF 對應的程式：

$ cd myapp
$ cargo xtask build-ebpf
...
   Compiling myapp-ebpf v0.1.0 (/home/ubuntu/myapp/myapp-ebpf)
     Running `rustc --crate-name myapp --edition=2021 src/main.rs --error-format=json \
     --json=diagnostic-rendered-ansi,artifacts,future-incompat --crate-type bin \
     --emit=dep-info,link -C opt-level=3 -C panic=abort -C lto -C codegen-units=1 
     -C metadata=dd6140d48c387b43 -C extra-filename=-dd6140d48c387b43 \
     --out-dir \
		...
     -Z unstable-options \
    Finished dev [optimized] target(s) in 11.76s

編譯完成後，對應的程式保存在 target 目錄下：

~/myapp$ ls -hl target/bpfel-unknown-none/debug/
...
-rw-rw-r-- 2 ubuntu ubuntu 3.5K Nov  6 22:24 myapp

~/myapp$ file target/bpfel-unknown-none/debug/myapp
target/bpfel-unknown-none/debug/myapp: ELF 64-bit LSB relocatable, eBPF, version 1 (SYSV), not stripped

/myapp$ llvm-objdump -S target/bpfel-unknown-none/debug/myapp

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

Disassembly of section xdp/myapp:

0000000000000000 <myapp>:
...
     242:	bf 61 00 00 00 00 00 00	r1 = r6
     243:	18 02 00 00 00 00 00 00 00 00 00 00 00 00 00 00	r2 = 0 ll
     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

至此，已經完成了 eBPF 程式的編譯工作，接著我們需要繼續編譯用戶空間代碼。

3.3 運行用戶空間程式

我們可以直接使用 cargo 命令來運行用戶空間程式：

$ RUST_LOG=info cargo xtask run
...
    Finished dev [unoptimized + debuginfo] target(s) in 8.38s
Error: failed to attach the XDP program with default flags - try changing XdpFlags::default() to XdpFlags::SKB_MODE

Caused by:
    unknown network interface eth0

RUST_LOG=info 為設置日誌級別的環境變數，預設為 warn，但嚮導生成的代碼列印的日誌級別預設為 info，因此需要運行時制定，否則可能會出現程式運行查看不到日誌的情況。

cargo xtask run 命令會直接編譯用戶空間代碼並運行，但是運行過程中我們發現出現錯誤 unknown network interface eth0，這是因為預設生成的程式指定將 XDP 程式載入到 eth0 網卡，而我們的 VM 預設網卡不為 eth0 導致，這裡我們明確制定網卡使用 lo 測試，再次運行結果如下：

$ RUST_LOG=info cargo xtask run -- --iface lo
...
    Finished dev [optimized] target(s) in 0.19s
    Finished dev [unoptimized + debuginfo] target(s) in 0.12s
[2022-11-05T16:25:27Z INFO  myapp] Waiting for Ctrl-C...

這次可以發現用戶空間程式已經正常運行，並且將對應的 eBPF 程式載入至內核中。

$ sudo bpftool prog list
42: xdp  name myapp  tag 2929f83b3be0f64b  gpl
	loaded_at 2022-11-06T22:42:54+0800  uid 0
	xlated 2016B  jited 1151B  memlock 4096B  map_ids 14,13,15
	
$ ip link show
1: lo: <LOOPBACK,UP,LOWER_UP> mtu 65536 xdpgeneric qdisc noqueue state UNKNOWN mode DEFAULT group default qlen 1000
    link/loopback 00:00:00:00:00:00 brd 00:00:00:00:00:00
    prog/xdp id 42 # <=== 載入的 eBPF 程式 id 42

我們啟動網卡在 lo 網卡的 ping 包驗證：

image-20221106224917574

我們可以看到當我們在另外一個視窗在本地埠運行 ping -c 1 127.0.0.1 命令的同時，在運行用戶空間 myapp 的程式日誌中列印了對應的日誌 received a packet。

至此，我們就完成了整個基於 Aya 最簡單 XDP 程式的驗證，如果你打算進階一步列印報文日誌或者對特定包進行對齊，則可以參考 Aya Book 中對應的章節。

4. 總結

通過對於 Aya 整個過程中的使用，我們可以發現使用 Aya 開發 eBPF 程式的確給我們帶來了諸多的便利，通過嚮導搭建了整個項目的基本框架，並且實現了編譯、載入等相關的管理工作，特別是對於新手入門更加友好。預設生成的用戶空間代碼與 eBPF 代碼實現了一定程度的代碼復用，特別是日誌相關的列印更加便捷。同時，該項目當前的文檔還不是特別完整，諸如 Probe/Tracepoint/XDP 等程式類型的文檔還在完善中，如果你有興趣也歡迎投入到相關的建設中。更多介紹可參考 Aya: Rust 風格的 eBPF 伙伴。

同時，也期待 libbpf-bootstrap 項目能夠早日實現 Aya 嚮導式的 eBPF 程式代碼創建，這對於編寫 eBPF 相關的程式的確提供了快速上手的體驗。

參考

  1. 一篇 Rust 的 30 分鐘介紹

  2. https://aya-rs.dev/

  3. LWN: Aya: writing BPF in Rust 2021-6-15

  4. Aya: your tRusty eBPF companion 2022-6-22 【翻譯】Aya: Rust 風格的 eBPF 伙伴

  5. Adding BPF target support to the Rust compiler

  6. Rust and Tell - Berlin - Aya: Extending the Linux Kernel with eBPF and Rust by Michal Rostecki 2022-10-24

  7. Writing an eBPF/XDP load-balancer in Rust

  8. Wanting to use BPF with Rust (Part 1)


您的分享是我們最大的動力!

-Advertisement-
Play Games
更多相關文章
  • 萬萬沒想到，除了香農計劃，Python3.11竟還有這麼多性能提升！
    一款好用的插件（Maven-Helper） 前言 博主在整合log4j日誌的時候，發現啟動不了項目，報錯信息，大致是這樣的： 意思是在 logback-classic-1.2.3.jar 和 log4j-slf4j-impl-2.13.3.jar 中發現有同路徑及同類名的文件，spring不知道掃哪 ...
  • Docker安裝Redis
    提高Docker的下載速度 修改 /etc/docker/daemon.json 文件 vi /etc/docker/daemon.json 配置加速器 { "registry-mirrors": ["https://registry.docker-cn.com", "http://hub-mirr ...
  • [C++] - GCC和LLVM對方法 warning: non-void function does not return a value [-Wreturn-type] 的處理差異
    列表中元素位置的索引用的是L.index 本文實例講述了Python去除列表中重覆元素的方法。分享給大家供大家參考。具體如下： 比較容易記憶的是用內置的set l1 = ['b','c','d','b','c','a','a'] l2 = list(set(l1)) print (l2) 還有一種據 ...
  • SpringBoot（二）：創建SpringBoot項目的方式
    一、通過官網進行創建 官網創建鏈接：https://start.spring.io/ 1.官網頁面配置： Project：我們需要選擇項目類型，我使用的是Maven項目； Language：使用的是Java語言，選擇Java； SpringBoot：選擇版本； Project Metadata：元數 ...
  • 用Python把附近的足浴店都給採集了一遍，好兄弟：針不戳~
    前言 嗨嘍，大家好呀~這裡是愛看美女的茜茜吶 又到了學Python時刻~ 我又來了！今天整個好玩的，你們肯定喜歡~ 咱們上班累了，不得好好犒勞一下自己，是吧 ！ 於是我整了一手採集附近洗jio的店子，浴皇大帝們，沖鴨~ 話不多說，沖！兄弟們，都是正規的 正規的！ 使用環境 python 3.8 解釋 ...
  • 電腦等級考試二級C語言模擬試卷（十）
    一、SpringBoot是什麼 在瞭解SpringBoot之前，我們需要先來回顧一下Spring。 Spring是一個輕量級的WEB應用開發的框架，它的初衷是為了簡化企業級應用開發的複雜性，說白了就是為了簡化開發。但是隨著Spring的不斷發展，它擴展的東西越來越多，導致其配置方面也越來越複雜，在每 ...
  • 重溫python基礎：列表相加的方法（兩個list [] 加法）
    哈嘍兄弟麽，今天咱們來複習一下列表相加的兩個方法。 利用操作符+ +操作符 對象是list a = [1,2,3] b = [4,5,6] c = a+b print(c) #c的結果：[1,2,3,4,5,6] 利用extend extend 操作對象是list a = [1,2,3] b = [ ...
  • Java8中那些方便又實用的Map函數
    原創：扣釘日記（微信公眾號ID：codelogs），歡迎分享，轉載請保留出處。 簡介 java8之後，常用的Map介面中添加了一些非常實用的函數，可以大大簡化一些特定場景的代碼編寫，提升代碼可讀性，一起來看看吧。 computeIfAbsent函數 比如，很多時候我們需要對數據進行分組，變成Map< ...
一周排行
    -Advertisement-
    Play Games
  • 移動開發（一）：使用.NET MAUI開發第一個安卓APP
    移動開發（一）：使用.NET MAUI開發第一個安卓APP 對於工作多年的C#程式員來說，近來想嘗試開發一款安卓APP，考慮了很久最終選擇使用.NET MAUI這個微軟官方的框架來嘗試體驗開發安卓APP，畢竟是使用Visual Studio開發工具，使用起來也比較的順手，結合微軟官方的教程進行了安卓 ...
  • wpf ToggleButton選中效果和一個登錄界面
    前言 QuestPDF 是一個開源 .NET 庫，用於生成 PDF 文檔。使用了C# Fluent API方式可簡化開發、減少錯誤並提高工作效率。利用它可以輕鬆生成 PDF 報告、發票、導出文件等。 項目介紹 QuestPDF 是一個革命性的開源 .NET 庫，它徹底改變了我們生成 PDF 文檔的方 ...
  • 彈幕樹洞項目功能新增篇
    項目地址 項目後端地址： https://github.com/ZyPLJ/ZYTteeHole 項目前端頁面地址： ZyPLJ/TreeHoleVue (github.com) https://github.com/ZyPLJ/TreeHoleVue 目前項目測試訪問地址： http://tree ...
  • 第27篇 sqlserver2022詳細安裝步驟
    話不多說，直接開乾 一.下載 1.官方鏈接下載： https://www.microsoft.com/zh-cn/sql-server/sql-server-downloads 2.在下載目錄中找到下麵這個小的安裝包 SQL2022-SSEI-Dev.exe，運行開始下載SQL server； 二. ...
  • .NET 開源高性能 MQTT 類庫
    前言 隨著物聯網（IoT）技術的迅猛發展，MQTT（消息隊列遙測傳輸）協議憑藉其輕量級和高效性，已成為眾多物聯網應用的首選通信標準。 MQTTnet 作為一個高性能的 .NET 開源庫，為 .NET 平臺上的 MQTT 客戶端與伺服器開發提供了強大的支持。 本文將全面介紹 MQTTnet 的核心功能 ...
  • Serilog文檔翻譯系列（六） - 可用的接收器、增強器、格式化輸出
    Serilog支持多種接收器用於日誌存儲，增強器用於添加屬性，LogContext管理動態屬性，支持多種輸出格式包括純文本、JSON及ExpressionTemplate。還提供了自定義格式化選項，適用於不同需求。 ...
  • 警惕 Visual Studio 屬性求值副作用導致邏輯不符合預期
    目錄簡介獲取 HTML 文檔解析 HTML 文檔測試參考文章 簡介 動態內容網站使用 JavaScript 腳本動態檢索和渲染數據，爬取信息時需要模擬瀏覽器行為，否則獲取到的源碼基本是空的。 本文使用的爬取步驟如下： 使用 Selenium 獲取渲染後的 HTML 文檔 使用 HtmlAgility ...
  • [使用目前最新版]HybridCLR6.9.0+YooAsset2.2.4實現純C# Unity熱更新方案 (一)
    1.前言 什麼是熱更新 游戲或者軟體更新時，無需重新下載客戶端進行安裝，而是在應用程式啟動的情況下，在內部進行資源或者代碼更新 Unity目前常用熱更新解決方案 HybridCLR，Xlua，ILRuntime等 Unity目前常用資源管理解決方案 AssetBundles，Addressable， ...
  • 在 ASP.NET Core Web API 中使用操作篩選器統一處理通用操作
    本文章主要是在C# ASP.NET Core Web API框架實現向手機發送驗證碼簡訊功能。這裡我選擇是一個互億無線簡訊驗證碼平臺，其實像阿裡雲，騰訊雲上面也可以。 首先我們先去 互億無線 https://www.ihuyi.com/api/sms.html 去註冊一個賬號 註冊完成賬號後，它會送 ...
  • 第28篇 如何.net中實現高效可靠數據同步api
    通過以下方式可以高效，並保證數據同步的可靠性 1.API設計 使用RESTful設計，確保API端點明確，並使用適當的HTTP方法（如POST用於創建，PUT用於更新）。 設計清晰的請求和響應模型，以確保客戶端能夠理解預期格式。 2.數據驗證 在伺服器端進行嚴格的數據驗證，確保接收到的數據符合預期格 ...
所有分類