Commit c6458e72 authored by Brendan Jackman's avatar Brendan Jackman Committed by Daniel Borkmann

bpf: Clarify return value of probe str helpers

When the buffer is too small to contain the input string, these helpers
return the length of the buffer, not the length of the original string.
This tries to make the docs totally clear about that, since "the length
of the [copied ]string" could also refer to the length of the input.
Signed-off-by: default avatarBrendan Jackman <jackmanb@google.com>
Signed-off-by: default avatarDaniel Borkmann <daniel@iogearbox.net>
Acked-by: default avatarKP Singh <kpsingh@kernel.org>
Acked-by: default avatarYonghong Song <yhs@fb.com>
Link: https://lore.kernel.org/bpf/20210112123422.2011234-1-jackmanb@google.com
parent e22d7f05
...@@ -2993,10 +2993,10 @@ union bpf_attr { ...@@ -2993,10 +2993,10 @@ union bpf_attr {
* string length is larger than *size*, just *size*-1 bytes are * string length is larger than *size*, just *size*-1 bytes are
* copied and the last byte is set to NUL. * copied and the last byte is set to NUL.
* *
* On success, the length of the copied string is returned. This * On success, returns the number of bytes that were written,
* makes this helper useful in tracing programs for reading * including the terminal NUL. This makes this helper useful in
* strings, and more importantly to get its length at runtime. See * tracing programs for reading strings, and more importantly to
* the following snippet: * get its length at runtime. See the following snippet:
* *
* :: * ::
* *
...@@ -3024,7 +3024,7 @@ union bpf_attr { ...@@ -3024,7 +3024,7 @@ union bpf_attr {
* **->mm->env_start**: using this helper and the return value, * **->mm->env_start**: using this helper and the return value,
* one can quickly iterate at the right offset of the memory area. * one can quickly iterate at the right offset of the memory area.
* Return * Return
* On success, the strictly positive length of the string, * On success, the strictly positive length of the output string,
* including the trailing NUL character. On error, a negative * including the trailing NUL character. On error, a negative
* value. * value.
* *
......
...@@ -2993,10 +2993,10 @@ union bpf_attr { ...@@ -2993,10 +2993,10 @@ union bpf_attr {
* string length is larger than *size*, just *size*-1 bytes are * string length is larger than *size*, just *size*-1 bytes are
* copied and the last byte is set to NUL. * copied and the last byte is set to NUL.
* *
* On success, the length of the copied string is returned. This * On success, returns the number of bytes that were written,
* makes this helper useful in tracing programs for reading * including the terminal NUL. This makes this helper useful in
* strings, and more importantly to get its length at runtime. See * tracing programs for reading strings, and more importantly to
* the following snippet: * get its length at runtime. See the following snippet:
* *
* :: * ::
* *
...@@ -3024,7 +3024,7 @@ union bpf_attr { ...@@ -3024,7 +3024,7 @@ union bpf_attr {
* **->mm->env_start**: using this helper and the return value, * **->mm->env_start**: using this helper and the return value,
* one can quickly iterate at the right offset of the memory area. * one can quickly iterate at the right offset of the memory area.
* Return * Return
* On success, the strictly positive length of the string, * On success, the strictly positive length of the output string,
* including the trailing NUL character. On error, a negative * including the trailing NUL character. On error, a negative
* value. * value.
* *
......
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