mirror of
https://github.com/torvalds/linux
synced 2024-09-20 11:07:02 +00:00
63e564ebd1
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>
40 lines
770 B
ReStructuredText
40 lines
770 B
ReStructuredText
=================
|
|
BPF Documentation
|
|
=================
|
|
|
|
This directory contains documentation for the BPF (Berkeley Packet
|
|
Filter) facility, with a focus on the extended BPF version (eBPF).
|
|
|
|
This kernel side documentation is still work in progress.
|
|
The Cilium project also maintains a `BPF and XDP Reference Guide`_
|
|
that goes into great technical depth about the BPF Architecture.
|
|
|
|
.. toctree::
|
|
:maxdepth: 1
|
|
|
|
instruction-set
|
|
verifier
|
|
libbpf/index
|
|
btf
|
|
faq
|
|
syscall_api
|
|
helpers
|
|
kfuncs
|
|
programs
|
|
maps
|
|
bpf_prog_run
|
|
classic_vs_extended.rst
|
|
bpf_licensing
|
|
test_debug
|
|
other
|
|
|
|
.. only:: subproject and html
|
|
|
|
Indices
|
|
=======
|
|
|
|
* :ref:`genindex`
|
|
|
|
.. Links:
|
|
.. _BPF and XDP Reference Guide: https://docs.cilium.io/en/latest/bpf/
|