* [PATCH] bpf, docs: Add note about type convention
@ 2023-01-25 18:48 dthaler1968
2023-01-25 20:23 ` David Vernet
0 siblings, 1 reply; 5+ messages in thread
From: dthaler1968 @ 2023-01-25 18:48 UTC (permalink / raw)
To: bpf; +Cc: bpf, Dave Thaler
From: Dave Thaler <dthaler@microsoft.com>
Add note about type convention
Signed-off-by: Dave Thaler <dthaler@microsoft.com>
---
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
^ permalink raw reply related [flat|nested] 5+ messages in thread
* Re: [PATCH] bpf, docs: Add note about type convention
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
0 siblings, 1 reply; 5+ messages in thread
From: David Vernet @ 2023-01-25 20:23 UTC (permalink / raw)
To: dthaler1968; +Cc: bpf, bpf, Dave Thaler
On Wed, Jan 25, 2023 at 06:48:27PM +0000, dthaler1968@googlemail.com wrote:
> From: Dave Thaler <dthaler@microsoft.com>
>
> Add note about type convention
Could you please provide a slightly more descriptive commit summary?
>
> Signed-off-by: Dave Thaler <dthaler@microsoft.com>
> ---
> 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.
Can you use single quotes here to match the convention in the rest of
the file?
>
> 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
>
^ permalink raw reply [flat|nested] 5+ messages in thread
* [PATCH] bpf, docs: Add note about type convention
2023-01-25 20:23 ` David Vernet
@ 2023-01-27 1:47 ` dthaler1968
2023-02-08 14:25 ` David Vernet
2023-02-08 17:30 ` patchwork-bot+netdevbpf
0 siblings, 2 replies; 5+ messages in thread
From: dthaler1968 @ 2023-01-27 1:47 UTC (permalink / raw)
To: bpf; +Cc: bpf, Dave Thaler
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
^ permalink raw reply related [flat|nested] 5+ messages in thread
* Re: [PATCH] bpf, docs: Add note about type convention
2023-01-27 1:47 ` dthaler1968
@ 2023-02-08 14:25 ` David Vernet
2023-02-08 17:30 ` patchwork-bot+netdevbpf
1 sibling, 0 replies; 5+ messages in thread
From: David Vernet @ 2023-02-08 14:25 UTC (permalink / raw)
To: dthaler1968; +Cc: bpf, bpf, Dave Thaler
On Fri, Jan 27, 2023 at 01:47:06AM +0000, dthaler1968@googlemail.com wrote:
> 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>
Acked-by: David Vernet <void@manifault.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
>
^ permalink raw reply [flat|nested] 5+ messages in thread
* Re: [PATCH] bpf, docs: Add note about type convention
2023-01-27 1:47 ` dthaler1968
2023-02-08 14:25 ` David Vernet
@ 2023-02-08 17:30 ` patchwork-bot+netdevbpf
1 sibling, 0 replies; 5+ messages in thread
From: patchwork-bot+netdevbpf @ 2023-02-08 17:30 UTC (permalink / raw)
To: Dave Thaler; +Cc: bpf, bpf, dthaler
Hello:
This patch was applied to bpf/bpf-next.git (master)
by Alexei Starovoitov <ast@kernel.org>:
On Fri, 27 Jan 2023 01:47:06 +0000 you wrote:
> 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>
>
> [...]
Here is the summary with links:
- bpf, docs: Add note about type convention
https://git.kernel.org/bpf/bpf-next/c/d00d5b82f073
You are awesome, thank you!
--
Deet-doot-dot, I am a bot.
https://korg.docs.kernel.org/patchwork/pwbot.html
^ permalink raw reply [flat|nested] 5+ messages in thread
end of thread, other threads:[~2023-02-08 17:30 UTC | newest]
Thread overview: 5+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
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
2023-02-08 14:25 ` David Vernet
2023-02-08 17:30 ` patchwork-bot+netdevbpf
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.