linux-stable/Documentation/bpf
Kumar Kartikeya Dwivedi 63e564ebd1 bpf: Add documentation for kfuncs
As the usage of kfuncs grows, we are starting to form consensus on the
kinds of attributes and annotations that kfuncs can have. To better help
developers make sense of the various options available at their disposal
to present an unstable API to the BPF users, document the various kfunc
flags and annotations, their expected usage, and explain the process of
defining and registering a kfunc set.

Cc: KP Singh <kpsingh@kernel.org>
Cc: Jonathan Corbet <corbet@lwn.net>
Signed-off-by: Kumar Kartikeya Dwivedi <memxor@gmail.com>
Link: https://lore.kernel.org/r/20220721134245.2450-6-memxor@gmail.com
Signed-off-by: Alexei Starovoitov <ast@kernel.org>
2022-07-21 21:03:16 -07:00
..
libbpf bpf, docs: Remove deprecated xsk libbpf APIs description 2022-07-08 14:18:50 +02:00
bpf_design_QA.rst bpf: Update bpf_design_QA.rst to clarify the kfunc call is not ABI 2021-03-30 07:31:01 -07:00
bpf_devel_QA.rst docs: netdev: move the netdev-FAQ to the process pages 2022-03-31 10:49:39 +02:00
bpf_licensing.rst bpf: Document BPF licensing. 2021-09-22 23:13:13 +02:00
bpf_prog_run.rst Documentation/bpf: Add documentation for BPF_PROG_RUN 2022-03-09 14:19:22 -08:00
btf.rst docs/bpf: Update documentation for BTF_KIND_FUNC 2022-07-19 09:42:09 -07:00
classic_vs_extended.rst bpf, docs: Split the comparism to classic BPF from instruction-set.rst 2021-12-30 16:31:44 -08:00
drgn.rst bpf: Document bpf_inspect drgn tool 2020-03-26 00:08:36 +01:00
faq.rst bpf, docs: Fix ordering of bpf documentation 2021-11-17 23:24:01 +01:00
helpers.rst bpf, docs: Fix ordering of bpf documentation 2021-11-17 23:24:01 +01:00
index.rst bpf: Add documentation for kfuncs 2022-07-21 21:03:16 -07:00
instruction-set.rst bpf, docs: Fix the code formatting in instruction-set 2022-06-24 13:58:32 -07:00
kfuncs.rst bpf: Add documentation for kfuncs 2022-07-21 21:03:16 -07:00
llvm_reloc.rst bpf, docs: Add llvm_reloc.rst to explain llvm bpf relocations 2021-05-28 22:12:04 +02:00
map_cgroup_storage.rst Documentation/bpf: Document CGROUP_STORAGE map type 2020-07-25 20:16:36 -07:00
map_hash.rst bpf, docs: document BPF_MAP_TYPE_HASH and variants 2022-07-19 10:38:03 -07:00
maps.rst bpf, docs: Move handling of maps to Documentation/bpf/maps.rst 2021-11-30 10:52:11 -08:00
other.rst bpf, docs: Fix ordering of bpf documentation 2021-11-17 23:24:01 +01:00
prog_cgroup_sockopt.rst bpf: Document optval > PAGE_SIZE behavior for sockopt hooks 2020-06-17 10:54:05 -07:00
prog_cgroup_sysctl.rst bpf: Document BPF_PROG_TYPE_CGROUP_SYSCTL 2019-04-18 16:05:36 -07:00
prog_flow_dissector.rst bpf/flow_dissector: add mode to enforce global BPF flow dissector 2019-10-07 20:16:33 -07:00
prog_lsm.rst bpf, docs: Rename bpf_lsm.rst to prog_lsm.rst 2021-11-17 23:23:58 +01:00
prog_sk_lookup.rst bpf: sk_lookup: Add user documentation 2020-08-24 14:46:50 -07:00
programs.rst bpf, docs: Fix ordering of bpf documentation 2021-11-17 23:24:01 +01:00
ringbuf.rst docs/bpf: Remove source code links 2020-09-14 18:46:54 -07:00
s390.rst bpf: Add s390 testing documentation 2019-10-30 16:25:31 +01:00
syscall_api.rst bpf, docs: Fix ordering of bpf documentation 2021-11-17 23:24:01 +01:00
test_debug.rst bpf, docs: Fix ordering of bpf documentation 2021-11-17 23:24:01 +01:00
verifier.rst bpf, docs: Add a missing colon in verifier.rst 2022-02-28 18:20:35 +01:00