解構(gòu)內(nèi)核源碼eBPF樣例編譯過程

1?

他山之石

了解和掌握純c語言的ebpf編譯和使用，有助于我們加深對于eBPF技術(shù)原理的進一步掌握，也有助于開發(fā)符合自己業(yè)務(wù)需求的高性能的ebpf程序。 目前常見和主流的純c語言的ebpf編譯使用方法，主要是兩種。一種是內(nèi)核源碼中原生提供的編譯方式。另外一種是libbpf-bootstrap項目中提供的skeleton編譯方式。libbpf-bootstrap方式和社區(qū)5.x以上內(nèi)核結(jié)合的比較好，以后再做介紹，今天我們選擇基于4.18內(nèi)核的基于內(nèi)核源碼的原生編譯方式做介紹。

我們今天將參考這篇文章內(nèi)容，對基于內(nèi)核源碼方式的純c語言的ebpf編譯方式做進一步分析。

2?

獲取內(nèi)核源碼

目前主流的服務(wù)器的操作系統(tǒng)環(huán)境還是以8u + 4.18內(nèi)核為主。因此，本文以4.18版本內(nèi)核為主要分析對象。我們提供如下操作系統(tǒng)環(huán)境的獲取建議：

2.1 獲取操作系統(tǒng)環(huán)境

如果你自己有centos8u兼容環(huán)境操作系統(tǒng)，則可以使用已有的環(huán)境。如果沒有，可以通過阿里云官網(wǎng)購買阿里云主機，選擇選擇centos8或者anolis8操作系統(tǒng)環(huán)境。

$  cat /etc/centos-release
CentOS Linux release 8.5.2111
$  uname -r
4.18.0-348.7.1.el8_5.x86_64

2.2 獲取開源的內(nèi)核源碼

可以使用wget，從aliyun官網(wǎng)鏡像，獲取開源的4.18內(nèi)核源碼。

$  cd /tmp/
$  wget https://mirrors.aliyun.com/linux-kernel/v4.x/linux-4.18.tar.gz
$  tar -zxvf linux-4.18.tar.gz
$  cd linux-4.18

下載內(nèi)核源碼一定要確保內(nèi)核版本與操作系統(tǒng)的一致。原因是ebpf會用到VERSION、PATCHLEVEL和SUBLEVEL這3個宏的值與內(nèi)核做內(nèi)核版本校驗。如果版本傳的不對，ebpf校驗會失敗。

$  cat Makefile  | grep -P '^VERSION|^PATCHLEVEL|^SUBLEVEL'   
VERSION = 4
PATCHLEVEL = 18
SUBLEVEL = 0

3?

初始化基礎(chǔ)環(huán)境

需要安裝ebpf編譯時依賴的llvm和clang等rpm包。此外內(nèi)核編譯還需要依賴openssl-devel等rpm包。

$  sudo yum install bison flex openssl-devel
$  sudo yum install clang llvm elfutils-libelf-devel

具體每個實驗機器的環(huán)境可能略有差別，需要根據(jù)自己的情況做細節(jié)調(diào)整。

4?

編譯內(nèi)核源碼中ebpf程序樣例

4.1 編譯環(huán)境初始化

狄老師的文章中這里執(zhí)行的是make scripts，在內(nèi)核源碼編譯時此步驟前通常還需要執(zhí)行make prepare。而make init正好包含這兩步make prepare && make scripts。因此，我們將命令按照如下方式優(yōu)化，基本能夠一遍跑過：

$  cd /tmp/linux-4.18
$  make oldconfig && make init  # make oldconfig && make prepare && make scripts
$  make headers_install

4.2 編譯內(nèi)核源碼樣例

終于執(zhí)行到了內(nèi)核源碼中提供的ebpf程序樣例的編譯。

$  make M=samples/bpf

4.3 執(zhí)行樣例程序

我們可以通過對樣例程序的執(zhí)行，對編譯效果進行驗證。結(jié)果顯示執(zhí)行成功，狄老師文章中的步驟驗證通過，有點小激動。

$  sudo ./samples/bpf/trace_output
recv 1766352 events per sec

5?

內(nèi)核源碼的ebpf編譯關(guān)鍵過程提取

接下去就是本文最重點的部分，對ebpf編譯過程的分析。我們主要分分析headers_install和對samples/bpf目錄的make這2個步驟。

5.1 頭文件安裝 make headers_install

重新獲取一個干凈的內(nèi)核源碼，再次執(zhí)行上面的編譯步驟。這次我們對編譯過程增加一些觀察步驟。

$  cd  /tmp/
$  rm -fr /tmp/linux-4.18
$  tar -zxvf linux-4.18.tar.gz 
$  cd /tmp/linux-4.18
$  make oldconfig && make init
$  ls usr/include/
ls: cannot access usr/include/: No such file or directory      # 此時include目錄不存在
$  make headers_install
$  ls usr/include/ -R  | grep -v -P ':$' | grep -v -P '^$' | wc -l
931                                                      #  此時include目錄下有931個文件
$  diff -rs usr/include/ /usr/include/|grep -P '^Files .+ and .+ are identical$'|wc -l
677

這說明內(nèi)核源碼目錄下，headers_install步驟生成的usr/include/目錄下功能900多個文件，其中大多數(shù)（677個）文件都能在操作系統(tǒng)環(huán)境的/usr/include/下找到完全一摸一樣的同名文件，并且內(nèi)容也完全相同。

$  rpm -ql kernel-headers | wc -l
964  
$  rpm -ql kernel-headers | head 
/usr/include/asm
/usr/include/asm-generic
/usr/include/asm-generic/bpf_perf_event.h

而操作系統(tǒng)環(huán)境的/usr/include/目錄正好是kernel-headers包的安裝目錄。所以編譯過程中headers_install步驟就是在內(nèi)核源碼目錄生成了kernel-headers包作用一樣的內(nèi)容。

5.2 eBPF樣例編譯 make M=samples/bpf

ebpf樣例的編譯過程，我們做一下改進，通過SHELL選項打開shell的調(diào)試選項。具體命令如下：

$  make M=samples/bpf --debug=v,m SHELL="bash -x" > make.log 2>&1

通過分析make.log，再結(jié)合其他一些黑科技，可以大概找出內(nèi)核源碼樣例中trace_output命令的編譯脈絡(luò)。其中用戶態(tài)編譯脈絡(luò)如下。為了表述上更加突出主題，此處只顯示編譯命令的關(guān)鍵信息，下一節(jié)會給出完整編譯命令。

$  gcc -g -fPIC -c -o libbpf.o libbpf.c
$  gcc -g -fPIC -c -o bpf.o bpf.c
$  gcc -g -fPIC -c -o btf.o btf.c
$  gcc -g -fPIC -c -o nlattr.o nlattr.c
$  ld -r -o libbpf-in.o libbpf.o bpf.o nlattr.o btf.o
$  ar rcs libbpf.a libbpf-in.o
$  gcc -O2 -std=gnu89 -c -o bpf_load.o bpf_load.c
$  gcc -O2 -std=gnu89 -c -o trace_output_user.o trace_output_user.c
$  gcc -O2 -std=gnu89 -c -o trace_helpers.o trace_helpers.c
$  gcc -o trace_output bpf_load.o trace_output_user.o trace_helpers.o libbpf.a -lelf -lrt

其中內(nèi)核態(tài)編譯脈絡(luò)如下：

$  clang -O2 -emit-llvm -c trace_output_kern.c -o - 
$  llc -march=bpf -filetype=obj -o trace_output_kern.o

其中前一行最后的橫線 - 表示 這里是輸出給shell管道，所以這兩行實際是可以通過shell管道拼接成一個命令來執(zhí)行的。

6?

手工編譯內(nèi)核源碼中的eBPF樣例分析

通過上一節(jié)對關(guān)鍵步驟make M=samples/bpf的實踐，我們已經(jīng)可以編譯出內(nèi)核源碼中提供的ebpf樣例。但這還不夠我們充分地理解這個編譯過程，我們將這編譯過程繼續(xù)拆解一下，拆解成可以一步步執(zhí)行的那種，為了方便大家理解，我將這個過程分解為 A-H 6大手工步驟，里面還會包含一些細分的小步驟：

$  cd  /tmp/
$  rm -fr /tmp/linux-4.18
$  tar -zxvf linux-4.18.tar.gz 
$  cd /tmp/linux-4.18
$  make oldconfig && make init
$  make headers_install
$  cd tools/lib/bpf/

6.1 手工步驟A過程解析

手工步驟A1：

$  # gcc -g -fPIC -c -o libbpf.o libbpf.c
$  gcc -g -DHAVE_LIBELF_MMAP_SUPPORT -DCOMPAT_NEED_REALLOCARRAY -fPIC -I. -I/tmp/linux-4.18/tools/include -I/tmp/linux-4.18/tools/arch/x86/include/uapi -I/tmp/linux-4.18/tools/include/uapi -I/tmp/linux-4.18/tools/perf -D"BUILD_STR(s)=#s" -c -o libbpf.o libbpf.c

手工步驟A2：

$ # gcc -g -fPIC -c -o bpf.o bpf.c
$  gcc -g -DHAVE_LIBELF_MMAP_SUPPORT -DCOMPAT_NEED_REALLOCARRAY -fPIC -I. -I/tmp/linux-4.18/tools/include -I/tmp/linux-4.18/tools/arch/x86/include/uapi -I/tmp/linux-4.18/tools/include/uapi -I/tmp/linux-4.18/tools/perf -D"BUILD_STR(s)=#s" -c -o bpf.o bpf.c

手工步驟A3：

$ # gcc -g -fPIC -c -o btf.o btf.c
$  gcc -g -DHAVE_LIBELF_MMAP_SUPPORT -DCOMPAT_NEED_REALLOCARRAY -fPIC -I. -I/tmp/linux-4.18/tools/include -I/tmp/linux-4.18/tools/arch/x86/include/uapi -I/tmp/linux-4.18/tools/include/uapi -I/tmp/linux-4.18/tools/perf -D"BUILD_STR(s)=#s" -c -o btf.o btf.c

手工步驟A4：

$ # gcc -g -fPIC -c -o nlattr.o nlattr.c
$  gcc -g -DHAVE_LIBELF_MMAP_SUPPORT -DCOMPAT_NEED_REALLOCARRAY -fPIC -I. -I/tmp/linux-4.18/tools/include -I/tmp/linux-4.18/tools/arch/x86/include/uapi -I/tmp/linux-4.18/tools/include/uapi -I/tmp/linux-4.18/tools/perf -D"BUILD_STR(s)=#s" -c -o nlattr.o nlattr.c

針對手工步驟A1到A4的關(guān)鍵編譯選項做一些介紹。

● -fPIC，告訴編譯器輸出位置無關(guān)目標(biāo)，為后面生成共享庫埋下伏筆。

● -I. 表示需要包含當(dāng)前目錄下的頭文件。

● -I/tmp/linux-4.18/tools/include -I/tmp/linux-4.18/tools/arch/x86/include/uapi -I/tmp/linux-4.18/tools/include/uapi -I/tmp/linux-4.18/tools/perf，這4個頭文件，是用戶態(tài)ebpf程序所依賴tool目錄下的頭文件位置。

6.2 手工步驟B過程解析

$  ld -r -o libbpf-in.o  libbpf.o bpf.o nlattr.o btf.o

手工步驟B是將步驟A中產(chǎn)生4個.o文件進行鏈接。

6.3 手工步驟C過程解析

$  ar rcs libbpf.a libbpf-in.o

手工步驟C是從鏈接后的文件中提取靜態(tài)庫文件。

6.4 手工步驟D/E/F過程解析

手工步驟D：

$  # gcc -O2 -std=gnu89 -c -o bpf_load.o bpf_load.c
$  gcc -O2 -fomit-frame-pointer -std=gnu89 -I./usr/include -I./tools/lib/ -I./tools/testing/selftests/bpf/ -I./tools/lib/ -I./tools/include -I./tools/perf -I./usr/include -Wno-unused-variable -c -o samples/bpf/bpf_load.o samples/bpf/bpf_load.c

手工步驟E：

$  # gcc -O2 -std=gnu89 -c -o trace_output_user.o trace_output_user.c
$  gcc -O2 -fomit-frame-pointer -std=gnu89 -I./usr/include -I./tools/lib/ -I./tools/testing/selftests/bpf/ -I./tools/lib/ -I./tools/include -I./tools/perf -I./tools/lib/bpf/ -c -o samples/bpf/trace_output_user.o samples/bpf/trace_output_user.c

手工步驟F：

$  # gcc -O2 -std=gnu89 -c -o trace_helpers.o trace_helpers.c
$  gcc -O2 -fomit-frame-pointer -std=gnu89 -I./usr/include -I./tools/lib/ -I./tools/testing/selftests/bpf/ -I./tools/lib/ -I./tools/include -I./tools/perf -I./tools/lib/bpf/ -c -o samples/bpf/../../tools/testing/selftests/bpf/trace_helpers.o samples/bpf/../../tools/testing/selftests/bpf/trace_helpers.c

針對手工步驟E的關(guān)鍵編譯選項做一些介紹。手工步驟D和手工步驟F與此類似。

● -O2 和 -std=gnu89 是兩個核心選項。

● include選項，一共有6個，我們將其分為3組。第一組是-I./usr/include ，這表示包含等同于kernel-headers的內(nèi)容。

● 第二組是-I./tools/lib/， -I./tools/include，-I./tools/perf，-I./tools/lib/bpf/

● 第三組是-I./tools/testing/selftests/bpf/。之所以把這一組單獨獨立出來，是因為它和樣例代碼處于同樣的路徑。

6.5 手工步驟G過程解析

$  # gcc -o trace_output bpf_load.o trace_output_user.o trace_helpers.o libbpf.a -lelf -lrt
$  gcc -o samples/bpf/trace_output samples/bpf/bpf_load.o samples/bpf/trace_output_user.o samples/bpf/../../tools/testing/selftests/bpf/trace_helpers.o /tmp/linux-4.18/samples/bpf/../../tools/lib/bpf/libbpf.a -lelf -lrt

針對手工步驟G的關(guān)鍵編譯選項做一些介紹。

● -lelf -lrt鏈接兩個類庫

● libbpf.a表示以靜態(tài)鏈接庫的方式鏈接libbpf的類庫。 ● 最關(guān)鍵的是，沒有添加-static選項，沒有添加-static選項，沒有添加-static選項，重要的事情說三遍。

6.6 手工步驟H過程解析

$  clang -nostdinc -isystem /usr/lib/gcc/x86_64-redhat-linux/8/include -I./arch/x86/include -I./arch/x86/include/generated -I./include -I./arch/x86/include/uapi -I./arch/x86/include/generated/uapi -I./include/uapi -I./include/generated/uapi -include ./include/linux/kconfig.h -Isamples/bpf -I./tools/testing/selftests/bpf/ -D__KERNEL__ -D__BPF_TRACING__ -D__TARGET_ARCH_x86 -O2 -emit-llvm -c samples/bpf/trace_output_kern.c -o - | llc -march=bpf -filetype=obj -o samples/bpf/trace_output_kern.o

針對手工步驟H的關(guān)鍵編譯選項做一些介紹。

● -nostdinc -isystem /usr/lib/gcc/x86_64-redhat-linux/8/include，這2個選項是一組。nostdinc表示屏蔽掉系統(tǒng)默認(rèn)的include環(huán)境，替換成當(dāng)前gcc編譯器自帶的include頭文件環(huán)境。

●-I./arch/x86/include，-I./arch/x86/include/generated，-I./include，-I./arch/x86/include/uapi，-I./arch/x86/include/generated/uapi，-I./include/uapi，-I./include/generated/uapi。這7個頭文件很關(guān)鍵，是內(nèi)核態(tài)ebpf程序所依賴的絕大多數(shù)頭文件的位置。

● -include ./include/linux/kconfig.h，這個頭文件也很關(guān)鍵，是讓上面7個頭文件生效的前提條件。

● -I samples/bpf 和 -I ./tools/testing/selftests/bpf/，這2個頭文件是和ebpf樣例所處位置相同，單獨獨立出來看。

● llc是llvm的連接器。內(nèi)核是將clang的編譯和llc的鏈接獨立成兩步完成，在llc步驟才指定-march=bpf。 對編譯結(jié)果進行驗證，完美驗證通過，第二次有點小激動。

$  sudo ./samples/bpf/trace_output
recv 1760674 events per sec

關(guān)鍵步驟抽取不是最終目的，根本目的是能讓我們實現(xiàn)脫離內(nèi)核源碼進行獨立的純C語言編譯。我們將在后續(xù)的文章中進一步闡述。

7?

關(guān)于4.9版本內(nèi)核

按照內(nèi)核的原生步驟，對4.9內(nèi)核進行一次編譯，我們會發(fā)現(xiàn)對應(yīng)手工步驟E的這一步，編譯代碼有點不一樣，具體代碼如下。

$ gcc -o samples/bpf/trace_output samples/bpf/bpf_load.o samples/bpf/libbpf.o samples/bpf/trace_output_user.o -lelf -lrt 其中沒有了對libbpf.a靜態(tài)庫的鏈接，但卻多了一個libbpf.o文件的鏈接。

$  cd /tmp/linux-4.9/
$  find . -name libbpf.c
./samples/bpf/libbpf.c
./tools/lib/bpf/libbpf.c

查詢內(nèi)核源碼，可以發(fā)現(xiàn)，在4.9內(nèi)核下，有2個libbpf.c文件，分別處于./tools/lib/bpf/目錄和./samples/bpf/目錄。而內(nèi)核ebpf樣例暫時使用的還是老的./samples/bpf/libbpf.c文件。

8?

進一步探索

本文為eBPF動手實踐系列的第一篇，我們實現(xiàn)了基于內(nèi)核源碼框架的一步一步的純C語言編譯

附錄: eBPF手工純C編譯完整命令清單

cd  /tmp/
rm -fr /tmp/linux-4.18
tar -zxvf linux-4.18.tar.gz 
cd /tmp/linux-4.18
make oldconfig && make init
make headers_install
cd tools/lib/bpf/


# 步驟A1
# gcc -g -fPIC -c -o libbpf.o libbpf.c
gcc -g -DHAVE_LIBELF_MMAP_SUPPORT -DCOMPAT_NEED_REALLOCARRAY -fPIC -I. -I/tmp/linux-4.18/tools/include -I/tmp/linux-4.18/tools/arch/x86/include/uapi -I/tmp/linux-4.18/tools/include/uapi -I/tmp/linux-4.18/tools/perf -D"BUILD_STR(s)=#s" -c -o libbpf.o libbpf.c


# 步驟A2
# gcc -g -fPIC -c -o bpf.o bpf.c
gcc -g -DHAVE_LIBELF_MMAP_SUPPORT -DCOMPAT_NEED_REALLOCARRAY -fPIC -I. -I/tmp/linux-4.18/tools/include -I/tmp/linux-4.18/tools/arch/x86/include/uapi -I/tmp/linux-4.18/tools/include/uapi -I/tmp/linux-4.18/tools/perf -D"BUILD_STR(s)=#s" -c -o bpf.o bpf.c


# 步驟A3
# gcc -g -fPIC -c -o btf.o btf.c
gcc -g -DHAVE_LIBELF_MMAP_SUPPORT -DCOMPAT_NEED_REALLOCARRAY -fPIC -I. -I/tmp/linux-4.18/tools/include -I/tmp/linux-4.18/tools/arch/x86/include/uapi -I/tmp/linux-4.18/tools/include/uapi -I/tmp/linux-4.18/tools/perf -D"BUILD_STR(s)=#s" -c -o btf.o btf.c


# 步驟A4
# gcc -g -fPIC -c -o nlattr.o nlattr.c
gcc -g -DHAVE_LIBELF_MMAP_SUPPORT -DCOMPAT_NEED_REALLOCARRAY -fPIC -I. -I/tmp/linux-4.18/tools/include -I/tmp/linux-4.18/tools/arch/x86/include/uapi -I/tmp/linux-4.18/tools/include/uapi -I/tmp/linux-4.18/tools/perf -D"BUILD_STR(s)=#s" -c -o nlattr.o nlattr.c


# 步驟B
ld -r -o libbpf-in.o  libbpf.o bpf.o nlattr.o btf.o


# 步驟C
ar rcs libbpf.a libbpf-in.o 


cd /tmp/linux-4.18/


# 步驟D
# gcc -O2 -std=gnu89 -c -o bpf_load.o bpf_load.c
gcc -O2 -fomit-frame-pointer -std=gnu89 -I./usr/include -I./tools/lib/ -I./tools/testing/selftests/bpf/ -I./tools/lib/ -I./tools/include -I./tools/perf -I./usr/include -Wno-unused-variable -c -o samples/bpf/bpf_load.o samples/bpf/bpf_load.c


# 步驟E
# gcc -O2 -std=gnu89 -c -o trace_output_user.o trace_output_user.c
gcc -O2 -fomit-frame-pointer -std=gnu89 -I./usr/include -I./tools/lib/ -I./tools/testing/selftests/bpf/ -I./tools/lib/ -I./tools/include -I./tools/perf -I./tools/lib/bpf/ -c -o samples/bpf/trace_output_user.o samples/bpf/trace_output_user.c


# 步驟F
# gcc -O2 -std=gnu89 -c -o trace_helpers.o trace_helpers.c
gcc -O2 -fomit-frame-pointer -std=gnu89 -I./usr/include -I./tools/lib/ -I./tools/testing/selftests/bpf/ -I./tools/lib/ -I./tools/include -I./tools/perf -I./tools/lib/bpf/ -c -o samples/bpf/../../tools/testing/selftests/bpf/trace_helpers.o samples/bpf/../../tools/testing/selftests/bpf/trace_helpers.c


# 步驟G
# gcc -o trace_output bpf_load.o trace_output_user.o trace_helpers.o libbpf.a -lelf -lrt
gcc -o samples/bpf/trace_output samples/bpf/bpf_load.o samples/bpf/trace_output_user.o samples/bpf/../../tools/testing/selftests/bpf/trace_helpers.o /tmp/linux-4.18/samples/bpf/../../tools/lib/bpf/libbpf.a -lelf -lrt


# 步驟H
clang -nostdinc -isystem /usr/lib/gcc/x86_64-redhat-linux/8/include -I./arch/x86/include -I./arch/x86/include/generated -I./include -I./arch/x86/include/uapi -I./arch/x86/include/generated/uapi -I./include/uapi -I./include/generated/uapi -include ./include/linux/kconfig.h -Isamples/bpf -I./tools/testing/selftests/bpf/ -D__KERNEL__ -D__BPF_TRACING__ -D__TARGET_ARCH_x86 -O2 -emit-llvm -c samples/bpf/trace_output_kern.c -o - | llc -march=bpf -filetype=obj -o samples/bpf/trace_output_kern.o

/ END /

審核編輯：劉清