bpf/docs: Document struct cgroup * kfuncs
authorDavid Vernet <void@manifault.com>
Wed, 7 Dec 2022 20:49:11 +0000 (14:49 -0600)
committerAlexei Starovoitov <ast@kernel.org>
Thu, 8 Dec 2022 01:11:24 +0000 (17:11 -0800)
commit36aa10ffd6480b93e32611411be4a8fc49804aba
tree0aff864f87bd286b0da3d0424e6156f56b03719c
parent25c5e92d197bd721e706444c5910fd386c330456
bpf/docs: Document struct cgroup * kfuncs

bpf_cgroup_acquire(), bpf_cgroup_release(), bpf_cgroup_kptr_get(), and
bpf_cgroup_ancestor(), are kfuncs that were recently added to
kernel/bpf/helpers.c. These are "core" kfuncs in that they're available
for use in any tracepoint or struct_ops BPF program. Though they have no
ABI stability guarantees, we should still document them. This patch adds
a struct cgroup * subsection to the Core kfuncs section which describes
each of these kfuncs.

Signed-off-by: David Vernet <void@manifault.com>
Link: https://lore.kernel.org/r/20221207204911.873646-3-void@manifault.com
Signed-off-by: Alexei Starovoitov <ast@kernel.org>
Documentation/bpf/kfuncs.rst
kernel/bpf/helpers.c