Commit 7d35eb1a authored by David Vernet's avatar David Vernet Committed by Daniel Borkmann

bpf, docs: s/eBPF/BPF in standards documents

There isn't really anything other than just "BPF" at this point,
so referring to it as "eBPF" in our standards document just causes
unnecessary confusion. Let's just be consistent and use "BPF".
Suggested-by: default avatarWill Hawkins <hawkinsw@obs.cr>
Signed-off-by: default avatarDavid Vernet <void@manifault.com>
Signed-off-by: default avatarDaniel Borkmann <daniel@iogearbox.net>
Link: https://lore.kernel.org/bpf/20230828155948.123405-4-void@manifault.com
parent deb88407
.. contents:: .. contents::
.. sectnum:: .. sectnum::
======================================== =======================================
eBPF Instruction Set Specification, v1.0 BPF Instruction Set Specification, v1.0
======================================== =======================================
This document specifies version 1.0 of the eBPF instruction set. This document specifies version 1.0 of the BPF instruction set.
Documentation conventions Documentation conventions
========================= =========================
...@@ -100,7 +100,7 @@ Definitions ...@@ -100,7 +100,7 @@ Definitions
Instruction encoding Instruction encoding
==================== ====================
eBPF has two instruction encodings: BPF has two instruction encodings:
* the basic instruction encoding, which uses 64 bits to encode an instruction * the basic instruction encoding, which uses 64 bits to encode an instruction
* the wide instruction encoding, which appends a second 64-bit immediate (i.e., * the wide instruction encoding, which appends a second 64-bit immediate (i.e.,
...@@ -244,7 +244,7 @@ BPF_END 0xd0 0 byte swap operations (see `Byte swap instructions`_ b ...@@ -244,7 +244,7 @@ BPF_END 0xd0 0 byte swap operations (see `Byte swap instructions`_ b
========= ===== ======= ========================================================== ========= ===== ======= ==========================================================
Underflow and overflow are allowed during arithmetic operations, meaning Underflow and overflow are allowed during arithmetic operations, meaning
the 64-bit or 32-bit value will wrap. If eBPF program execution would the 64-bit or 32-bit value will wrap. If BPF program execution would
result in division by zero, the destination register is instead set to zero. result in division by zero, the destination register is instead set to zero.
If execution would result in modulo by zero, for ``BPF_ALU64`` the value of If execution would result in modulo by zero, for ``BPF_ALU64`` the value of
the destination register is unchanged whereas for ``BPF_ALU`` the upper the destination register is unchanged whereas for ``BPF_ALU`` the upper
...@@ -366,7 +366,7 @@ BPF_JSLT 0xc any PC += offset if dst < src signed ...@@ -366,7 +366,7 @@ BPF_JSLT 0xc any PC += offset if dst < src signed
BPF_JSLE 0xd any PC += offset if dst <= src signed BPF_JSLE 0xd any PC += offset if dst <= src signed
======== ===== === =========================================== ========================================= ======== ===== === =========================================== =========================================
The eBPF program needs to store the return value into register R0 before doing a The BPF program needs to store the return value into register R0 before doing a
``BPF_EXIT``. ``BPF_EXIT``.
Example: Example:
...@@ -486,9 +486,9 @@ Atomic operations ...@@ -486,9 +486,9 @@ Atomic operations
Atomic operations are operations that operate on memory and can not be Atomic operations are operations that operate on memory and can not be
interrupted or corrupted by other access to the same memory region interrupted or corrupted by other access to the same memory region
by other eBPF programs or means outside of this specification. by other BPF programs or means outside of this specification.
All atomic operations supported by eBPF are encoded as store operations All atomic operations supported by BPF are encoded as store operations
that use the ``BPF_ATOMIC`` mode modifier as follows: that use the ``BPF_ATOMIC`` mode modifier as follows:
* ``BPF_ATOMIC | BPF_W | BPF_STX`` for 32-bit operations * ``BPF_ATOMIC | BPF_W | BPF_STX`` for 32-bit operations
...@@ -578,7 +578,7 @@ where ...@@ -578,7 +578,7 @@ where
Maps Maps
~~~~ ~~~~
Maps are shared memory regions accessible by eBPF programs on some platforms. Maps are shared memory regions accessible by BPF programs on some platforms.
A map can have various semantics as defined in a separate document, and may or A map can have various semantics as defined in a separate document, and may or
may not have a single contiguous memory region, but the 'map_val(map)' is may not have a single contiguous memory region, but the 'map_val(map)' is
currently only defined for maps that do have a single contiguous memory region. currently only defined for maps that do have a single contiguous memory region.
...@@ -600,6 +600,6 @@ identified by the given id. ...@@ -600,6 +600,6 @@ identified by the given id.
Legacy BPF Packet access instructions Legacy BPF Packet access instructions
------------------------------------- -------------------------------------
eBPF previously introduced special instructions for access to packet data that were BPF previously introduced special instructions for access to packet data that were
carried over from classic BPF. However, these instructions are carried over from classic BPF. However, these instructions are
deprecated and should no longer be used. deprecated and should no longer be used.
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment