bpf: Document BPF_PROG_TEST_RUN syscall command

Based on a brief read of the corresponding source code.

Signed-off-by: Joe Stringer <joe@cilium.io>
Signed-off-by: Alexei Starovoitov <ast@kernel.org>
Reviewed-by: Quentin Monnet <quentin@isovalent.com>
Acked-by: Toke Høiland-Jørgensen <toke@redhat.com>
Acked-by: Yonghong Song <yhs@fb.com>
Link: https://lore.kernel.org/bpf/20210302171947.2268128-7-joe@cilium.io

diff --git a/include/uapi/linux/bpf.h b/include/uapi/linux/bpf.h
index a8f2964..a6cd665 100644 (file)
--- a/include/uapi/linux/bpf.h
+++ b/include/uapi/linux/bpf.h
@@ -306,14 +306,22 @@ union bpf_iter_link_info {
  *
  * BPF_PROG_TEST_RUN
  *     Description
- *             Run an eBPF program a number of times against a provided
- *             program context and return the modified program context and
- *             duration of the test run.
+ *             Run the eBPF program associated with the *prog_fd* a *repeat*
+ *             number of times against a provided program context *ctx_in* and
+ *             data *data_in*, and return the modified program context
+ *             *ctx_out*, *data_out* (for example, packet data), result of the
+ *             execution *retval*, and *duration* of the test run.
  *
  *     Return
  *             Returns zero on success. On error, -1 is returned and *errno*
  *             is set appropriately.
  *
+ *             **ENOSPC**
+ *                     Either *data_size_out* or *ctx_size_out* is too small.
+ *             **ENOTSUPP**
+ *                     This command is not supported by the program type of
+ *                     the program referred to by *prog_fd*.
+ *
  * BPF_PROG_GET_NEXT_ID
  *     Description
  *             Fetch the next eBPF program currently loaded into the kernel.