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: Brendan Jackman <jackmanb@google.com>
Signed-off-by: Daniel Borkmann <daniel@iogearbox.net>
Acked-by: KP Singh <kpsingh@kernel.org>
Acked-by: Yonghong Song <yhs@fb.com>
Link: https://lore.kernel.org/bpf/20210112123422.2011234-1-jackmanb@google.com

diff --git a/include/uapi/linux/bpf.h b/include/uapi/linux/bpf.h
index 77d7c1bb29233a55e52bbbf38b02fa00b1959e64..a1ad32456f89aa90c50a16b660ab62831f0dc00c 100644 (file)
--- a/include/uapi/linux/bpf.h
+++ b/include/uapi/linux/bpf.h
@@ -2993,10 +2993,10 @@ union bpf_attr {
  *             string length is larger than *size*, just *size*-1 bytes are
  *             copied and the last byte is set to NUL.
  *
- *             On success, the length of the copied string is returned. This
- *             makes this helper useful in tracing programs for reading
- *             strings, and more importantly to get its length at runtime. See
- *             the following snippet:
+ *             On success, returns the number of bytes that were written,
+ *             including the terminal NUL. This makes this helper useful in
+ *             tracing programs for reading strings, and more importantly to
+ *             get its length at runtime. See the following snippet:
  *
  *             ::
  *
@@ -3024,7 +3024,7 @@ union bpf_attr {
  *             **->mm->env_start**: using this helper and the return value,
  *             one can quickly iterate at the right offset of the memory area.
  *     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
  *             value.
  *

diff --git a/tools/include/uapi/linux/bpf.h b/tools/include/uapi/linux/bpf.h
index 77d7c1bb29233a55e52bbbf38b02fa00b1959e64..a1ad32456f89aa90c50a16b660ab62831f0dc00c 100644 (file)
--- a/tools/include/uapi/linux/bpf.h
+++ b/tools/include/uapi/linux/bpf.h
@@ -2993,10 +2993,10 @@ union bpf_attr {
  *             string length is larger than *size*, just *size*-1 bytes are
  *             copied and the last byte is set to NUL.
  *
- *             On success, the length of the copied string is returned. This
- *             makes this helper useful in tracing programs for reading
- *             strings, and more importantly to get its length at runtime. See
- *             the following snippet:
+ *             On success, returns the number of bytes that were written,
+ *             including the terminal NUL. This makes this helper useful in
+ *             tracing programs for reading strings, and more importantly to
+ *             get its length at runtime. See the following snippet:
  *
  *             ::
  *
@@ -3024,7 +3024,7 @@ union bpf_attr {
  *             **->mm->env_start**: using this helper and the return value,
  *             one can quickly iterate at the right offset of the memory area.
  *     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
  *             value.
  *