docs/bpf: Improve documentation of 64-bit immediate instructions
authorYonghong Song <yonghong.song@linux.dev>
Sat, 27 Jan 2024 19:46:29 +0000 (11:46 -0800)
committerDaniel Borkmann <daniel@iogearbox.net>
Mon, 29 Jan 2024 15:54:33 +0000 (16:54 +0100)
commitced33f2cfa21a14a292a00e31dc9f85c1bfbda1c
treec1ff1a7054587716b2ad4cd071023314b4cca538
parentefaa47db92451608499ab7edf108bf30141c33db
docs/bpf: Improve documentation of 64-bit immediate instructions

For 64-bit immediate instruction, 'BPF_IMM | BPF_DW | BPF_LD' and
src_reg=[0-6], the current documentation describes the 64-bit
immediate is constructed by:

  imm64 = (next_imm << 32) | imm

But actually imm64 is only used when src_reg=0. For all other
variants (src_reg != 0), 'imm' and 'next_imm' have separate special
encoding requirement and imm64 cannot be easily used to describe
instruction semantics.

This patch clarifies that 64-bit immediate instructions use
two 32-bit immediate values instead of a 64-bit immediate value,
so later describing individual 64-bit immediate instructions
becomes less confusing.

Signed-off-by: Yonghong Song <yonghong.song@linux.dev>
Signed-off-by: Daniel Borkmann <daniel@iogearbox.net>
Acked-by: Dave Thaler <dthaler1968@gmail.com>
Link: https://lore.kernel.org/bpf/20240127194629.737589-1-yonghong.song@linux.dev
Documentation/bpf/standardization/instruction-set.rst