From: dthaler1968@googlemail.com
To: bpf@vger.kernel.org
Cc: bpf@ietf.org, Dave Thaler <dthaler@microsoft.com>
Subject: [PATCH] bpf, docs: Add note about type convention
Date: Fri, 27 Jan 2023 01:47:06 +0000 [thread overview]
Message-ID: <20230127014706.1005-1-dthaler1968@googlemail.com> (raw)
In-Reply-To: <Y9GPssH+6Yo5/MY9@maniforge>
From: Dave Thaler <dthaler@microsoft.com>
Add explanation about use of "u64", "u32", etc. as
the type convention used in BPF documentation.
Signed-off-by: Dave Thaler <dthaler@microsoft.com>
---
V2 -> V3: updated commit message to respond to David Vernet
V1 -> V2: addressed comments from Alexei and Stanislav
by using u64 instead of uint64_t
---
Documentation/bpf/instruction-set.rst | 7 +++++++
1 file changed, 7 insertions(+)
diff --git a/Documentation/bpf/instruction-set.rst b/Documentation/bpf/instruction-set.rst
index 2d3fe59bd26..77990c97b5e 100644
--- a/Documentation/bpf/instruction-set.rst
+++ b/Documentation/bpf/instruction-set.rst
@@ -7,6 +7,11 @@ eBPF Instruction Set Specification, v1.0
This document specifies version 1.0 of the eBPF instruction set.
+Documentation conventions
+=========================
+
+For brevity, this document uses the type notion "u64", "u32", etc.
+to mean an unsigned integer whose width is the specified number of bits.
Registers and calling convention
================================
@@ -123,6 +128,8 @@ the destination register is unchanged whereas for ``BPF_ALU`` the upper
dst_reg = (u32) dst_reg + (u32) src_reg;
+where '(u32)' indicates that the upper 32 bits are zeroed.
+
``BPF_ADD | BPF_X | BPF_ALU64`` means::
dst_reg = dst_reg + src_reg
--
2.33.4
next prev parent reply other threads:[~2023-01-27 1:47 UTC|newest]
Thread overview: 5+ messages / expand[flat|nested] mbox.gz Atom feed top
2023-01-25 18:48 [PATCH] bpf, docs: Add note about type convention dthaler1968
2023-01-25 20:23 ` David Vernet
2023-01-27 1:47 ` dthaler1968 [this message]
2023-02-08 14:25 ` David Vernet
2023-02-08 17:30 ` patchwork-bot+netdevbpf
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20230127014706.1005-1-dthaler1968@googlemail.com \
--to=dthaler1968@googlemail.com \
--cc=bpf@ietf.org \
--cc=bpf@vger.kernel.org \
--cc=dthaler@microsoft.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.