eBPF指令集规范v1.0

金庆辉，系统工程师，对系统性能分析领域有强烈的兴趣。

版权说明：本文档翻译自官方文档，额外加入了自己的一些理解。

目的：编译成功的eBPF程序，加载时偶尔会过不了内核BPF verifier，冒出一堆汇编语句。理解eBPF指令集，可以帮助我们调试这类问题。

1. eBPF指令集规范v1.0

本文档是eBPF指令集规范，版本 1.0

1.1 寄存器和使用规范

eBPF有10个通用寄存器和一个只读的栈帧寄存器，他们都是64-bit宽度。

eBPF的寄存器使用规范为：

• R0: 保存函数返回值和eBPF程序退出值。

• R1 - R5: 用于函数调用参数。

• R6 - R9: callee函数负责进入时保存这几个寄存器到栈中，函数退出前再恢复寄存器原有值。(callee saved registers that function calls will preserve)

• R10: 只读的栈帧寄存器，用于访问栈。

R0 - R5是临时寄存器，eBPF程序如果希望在函数调用后寄存器值不变，需要自己保存和恢复寄存器。(R0 - R5 are scratch registers and eBPF programs needs to spill/fill them if necessary across calls.)

译者注:

• Scratch register / temporary register：顾名思义，用于保存临时值或者中间值。

• Caller 和 Callee: A函数中调用B函数，那么 A是Caller，B是Callee。

• Caller saved registers 和 Callee saved registers

更多资料

1.2 指令编码

eBPF有两种编码模式：

• 基础编码，64bit固定长度编码。

• 宽指令编码，在基础编码后增加了一个64bit的立即数(imm64)。这样指令为128bit。

基础编码格式，每一列约定为field：

注意：绝大多数指令不会使用所有的field，不使用的field被置0。

宽指令编码目前只有64-bit立即数指令使用。

1.2.1 指令类型(class)

基础编码中的field的opcode，一共8bit，其中最低位3bit用来保存指令类型：

1.3 算术和跳转指令

(BPF_ALU, BPF_ALU64, BPF_JMP和BPF_JMP32)称为算术和跳转指令。8bit的opcode被分为3个部分：

第4个bit(source)含义：

4个bit的operation code用来存储具体指令操作码。

1.3.1 算术指令(BPF_ALU, BPF_ALU64)

BPF_ALU操作数为32bit，BPF_ALU64操作数为64bit。4个bit的operation code编码了如下操作：

译者注：

• 上表中dst一定是指目的寄存器，不支持内存地址。

• 上表中src可能是源寄存器，也可能是imm32，根据source位(BPF_K或者BPF_X)来区分。

• eBPF寄存器都是64bit，根据操作数类型，可以使用全部64bit，也可以只使用其中32bit。

一些例子：

BPF_ADD | BPF_X | BPF_ALU ：

dst_reg = (u32) dst_reg + (u32) src_reg;

BPF_XOR | BPF_K | BPF_ALU64 :

dst_reg = dst_reg + src_reg

BPF_XOR | BPF_K | BPF_ALU :

dst_reg = (u32) dst_reg ^ (u32) imm32

BPF_XOR | BPF_K | BPF_ALU64 :

dst_reg = dst_reg ^ imm32

1.3.1.1 字节swap指令

字节swap指令，属于BPF_ALU分类，操作码为BPF_END。
字节swap指令操作数只有dst_reg，不操作src_reg和imm32。

opcode中的source位含义现在更改为：

基础编码格式中的imm32，此时编码了swap操作的位宽。支持：16,32和64bit。
例子：

BPF_ALU | BPF_TO_LE | BPF_END，并且imm32 = 16:

dst_reg = htole16(dst_reg)

BPF_ALU | BPF_TO_LE | BPF_END，并且imm32 = 64:

dst_reg = htole64(dst_reg)

1.3.2 跳转指令(BPF_JMP32, BPF_JMP)

操作数为寄存器，BPF_JMP32使用32bit，BPF_JMP使用64bit，其它行为都一样。operation code含义如下：

eBPF程序在调用BPF_EXIT前，需要把返回值保存在R0寄存器中。

译者注: 上表中的术语：

• PC：程序计数器。

• off: 基础编码格式中的off16。

• src,dst: 都是指的寄存器的值。

1.4 Load 和 Store指令

BPF_LD, BPF_LDX, BPF_ST和BPF_STX指令类型中，8bit的opcode含义为：

mode含义是：

size含义：

1.4.1 标准load和store指令

BPF_MEM代表了标准load和store指令，这些指令用于寄存器和内存之间传递数据。

BPF_MEM | | BPF_STX：

*(size *) (dst_reg + off16) = src_reg

BPF_MEM | | BPF_ST:

*(size *) (dst_reg + off16) = imm32

BPF_MEM | | BPF_LDX：

dst_reg = *(size *) (src_reg + off16)

size 可选值：BPF_B, BPF_H, BPF_W, or BPF_DW

1.4.2 原子操作

原子操作，指的的是对内存的操作，不会被其他eBPF程序中途扰乱。

eBPF所有的原子操作由BPF_ATOMIC指定，例如：

• BPF_ATOMIC | BPF_W | BPF_STX :32-bit原子操作。

• BPF_ATOMIC | BPF_DW | BPF_STX :64-bit原子操作。

• 8-bit和16-bit原子操作不支持。

基本编码格式的imm32用来编码真正的原子操作, 以下是简单原子指令：

BPF_ATOMIC | BPF_W | BPF_STX, imm32 = BPF_ADD，含义：

*(u32 *)(dst_reg + off16) += src_reg

BPF_ATOMIC | BPF_DW | BPF_STX, imm32 = BPF_ADD, 含义：

*(u64 *)(dst_reg + off16) += src_reg

除了以上比较简单的原子操作，还有2个复杂原子指令：

BPF_FETCH:

• 对于简单原子指令是可选的，如果设置了，src_reg将保存(dst_reg + off16)指向的内存中被修改前的原始值。

• 对于复杂原子指令是必选的。

1.4.3 64bit立即数指令

mode为BPF_IMM的指令，用于eBPF宽指令，有额外的一个imm64值。
目前只有一条指令：
BPF_LD | BPF_DW | BPF_IMM,含义为：
dst_reg = imm64

1.4.4 经典BPF数据包访问指令

eBPF之前为了兼容经典BPF，引入了一些访问数据包的指令。现在已经废弃不再使用。