bpf, docs: Add explanation of endianness
Subsystems (2)
PATCH 1/1 bpf, docs: Add explanation of endianness
From: Dave Thaler <[email protected]>
Document the discussion from the email thread on the IETF bpf list, where it was explained that the raw format varies by endianness of the processor.
Signed-off-by Dave Thaler <[email protected]>
--- Documentation/bpf/instruction-set.rst | 13 ++++++++++++- 1 file changed, 12 insertions(+), 1 deletion(-)
Documentation/bpf/instruction-set.rst +12 -1
@@ -33,7 +33,7 @@ eBPF has two instruction encodings: * the wide instruction encoding, which appends a second 64-bit immediate value (imm64) after the basic instruction for a total of 128 bits. -The basic instruction encoding looks as follows: +The basic instruction encoding looks as follows for a little-endian processor: ============= ======= =============== ==================== ============ 32 bits (MSB) 16 bits 4 bits 4 bits 8 bits (LSB)
@@ -41,6 +41,17 @@ The basic instruction encoding looks as follows: immediate offset source register destination register opcode ============= ======= =============== ==================== ============ +and as follows for a big-endian processor: + +============= ======= ==================== =============== ============ +32 bits (MSB) 16 bits 4 bits 4 bits 8 bits (LSB) +============= ======= ==================== =============== ============ +immediate offset destination register source register opcode +============= ======= ==================== =============== ============ + +Multi-byte fields ('immediate' and 'offset') are similarly stored in +the byte order of the processor. + Note that most instructions do not use all of the fields. Unused fields shall be cleared to zero.
Signature · 1 line
2.33.4
Quoted 7 lines · Dave Thaler
From: Dave Thaler <[email protected]>
Document the discussion from the email thread on the IETF bpf list, where it was explained that the raw format varies by endianness of the processor.
Signed-off-by Dave Thaler <[email protected]>
Thanks for documenting this as well. This LGTM, but you're going to have to rebase onto [0] and submit a v2 in order for it to be merged.
[0]: https://lore.kernel.org/all/[email protected]/
You can include my Ack on that revision:
Acked-by David Vernet <[email protected]>
Quoted 38 lines
--- Documentation/bpf/instruction-set.rst | 13 ++++++++++++- 1 file changed, 12 insertions(+), 1 deletion(-)Documentation/bpf/instruction-set.rst +12
-1@@ -33,7 +33,7 @@ eBPF has two instruction encodings: * the wide instruction encoding, which appends a second 64-bit immediate value (imm64) after the basic instruction for a total of 128 bits. -The basic instruction encoding looks as follows: +The basic instruction encoding looks as follows for a little-endian processor: ============= ======= =============== ==================== ============ 32 bits (MSB) 16 bits 4 bits 4 bits 8 bits (LSB)@@ -41,6 +41,17 @@ The basic instruction encoding looks as follows: immediate offset source register destination register opcode ============= ======= =============== ==================== ============ +and as follows for a big-endian processor: + +============= ======= ==================== =============== ============ +32 bits (MSB) 16 bits 4 bits 4 bits 8 bits (LSB) +============= ======= ==================== =============== ============ +immediate offset destination register source register opcode +============= ======= ==================== =============== ============ + +Multi-byte fields ('immediate' and 'offset') are similarly stored in +the byte order of the processor. + Note that most instructions do not use all of the fields. Unused fields shall be cleared to zero.Signature · 1 line
2.33.4