bpf: Document PROG_TEST_RUN limitations
authorJoe Stringer <joe@cilium.io>
Sat, 10 Apr 2021 17:45:48 +0000 (10:45 -0700)
committerDaniel Borkmann <daniel@iogearbox.net>
Mon, 12 Apr 2021 15:18:05 +0000 (17:18 +0200)
commitf3c45326ee71d1d3ec11e9ddb5afc04bca9ae492
tree45beb61d78d5fcd2b74f833a99f3330b11141395
parent92d3bff28aa40a86e1bd8f359a046838493fc913
bpf: Document PROG_TEST_RUN limitations

Per net/bpf/test_run.c, particular prog types have additional
restrictions around the parameters that can be provided, so document
these in the header.

I didn't bother documenting the limitation on duration for raw
tracepoints since that's an output parameter anyway.

Tested with ./tools/testing/selftests/bpf/test_doc_build.sh.

Suggested-by: Yonghong Song <yhs@fb.com>
Signed-off-by: Joe Stringer <joe@cilium.io>
Signed-off-by: Daniel Borkmann <daniel@iogearbox.net>
Acked-by: Yonghong Song <yhs@fb.com>
Acked-by: Lorenz Bauer <lmb@cloudflare.com>
Link: https://lore.kernel.org/bpf/20210410174549.816482-1-joe@cilium.io
include/uapi/linux/bpf.h