bpf, docs: Clarify call local offset
authorDave Thaler <dthaler1968@googlemail.com>
Sat, 25 May 2024 15:33:32 +0000 (08:33 -0700)
committerAlexei Starovoitov <ast@kernel.org>
Sat, 25 May 2024 17:41:57 +0000 (10:41 -0700)
In the Jump instructions section it explains that the offset is
"relative to the instruction following the jump instruction".
But the program-local section confusingly said "referenced by
offset from the call instruction, similar to JA".

This patch updates that sentence with consistent wording, saying
it's relative to the instruction following the call instruction.

Signed-off-by: Dave Thaler <dthaler1968@gmail.com>
Acked-by: Yonghong Song <yonghong.song@linux.dev>
Link: https://lore.kernel.org/r/20240525153332.21355-1-dthaler1968@gmail.com
Signed-off-by: Alexei Starovoitov <ast@kernel.org>
Documentation/bpf/standardization/instruction-set.rst

index 1602454fe7cfc4f1042ceddad95bef717d3775f5..08f614b10a56b371f3e3f3df56a21ced7b8b8132 100644 (file)
@@ -552,9 +552,10 @@ is outside the scope of this document and is left for future work.
 Program-local functions
 ~~~~~~~~~~~~~~~~~~~~~~~
 Program-local functions are functions exposed by the same BPF program as the
-caller, and are referenced by offset from the call instruction, similar to
-``JA``.  The offset is encoded in the 'imm' field of the call instruction.
-An ``EXIT`` within the program-local function will return to the caller.
+caller, and are referenced by offset from the instruction following the call
+instruction, similar to ``JA``.  The offset is encoded in the 'imm' field of
+the call instruction. An ``EXIT`` within the program-local function will
+return to the caller.
 
 Load and store instructions
 ===========================