diff options
author | Daniel Baumann <daniel.baumann@progress-linux.org> | 2024-04-27 10:05:51 +0000 |
---|---|---|
committer | Daniel Baumann <daniel.baumann@progress-linux.org> | 2024-04-27 10:05:51 +0000 |
commit | 5d1646d90e1f2cceb9f0828f4b28318cd0ec7744 (patch) | |
tree | a94efe259b9009378be6d90eb30d2b019d95c194 /Documentation/bpf/index.rst | |
parent | Initial commit. (diff) | |
download | linux-upstream/5.10.209.tar.xz linux-upstream/5.10.209.zip |
Adding upstream version 5.10.209.upstream/5.10.209upstream
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to '')
-rw-r--r-- | Documentation/bpf/index.rst | 90 |
1 files changed, 90 insertions, 0 deletions
diff --git a/Documentation/bpf/index.rst b/Documentation/bpf/index.rst new file mode 100644 index 000000000..4f2874b72 --- /dev/null +++ b/Documentation/bpf/index.rst @@ -0,0 +1,90 @@ +================= +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 main +textual documentation is (for historical reasons) described in +:ref:`networking-filter`, which describe both classical and extended +BPF instruction-set. +The Cilium project also maintains a `BPF and XDP Reference Guide`_ +that goes into great technical depth about the BPF Architecture. + +The primary info for the bpf syscall is available in the `man-pages`_ +for `bpf(2)`_. + +BPF Type Format (BTF) +===================== + +.. toctree:: + :maxdepth: 1 + + btf + + +Frequently asked questions (FAQ) +================================ + +Two sets of Questions and Answers (Q&A) are maintained. + +.. toctree:: + :maxdepth: 1 + + bpf_design_QA + bpf_devel_QA + + +Helper functions +================ + +* `bpf-helpers(7)`_ maintains a list of helpers available to eBPF programs. + + +Program types +============= + +.. toctree:: + :maxdepth: 1 + + prog_cgroup_sockopt + prog_cgroup_sysctl + prog_flow_dissector + bpf_lsm + prog_sk_lookup + + +Map types +========= + +.. toctree:: + :maxdepth: 1 + + map_cgroup_storage + + +Testing and debugging BPF +========================= + +.. toctree:: + :maxdepth: 1 + + drgn + s390 + + +Other +===== + +.. toctree:: + :maxdepth: 1 + + ringbuf + +.. Links: +.. _networking-filter: ../networking/filter.rst +.. _man-pages: https://www.kernel.org/doc/man-pages/ +.. _bpf(2): https://man7.org/linux/man-pages/man2/bpf.2.html +.. _bpf-helpers(7): https://man7.org/linux/man-pages/man7/bpf-helpers.7.html +.. _BPF and XDP Reference Guide: https://docs.cilium.io/en/latest/bpf/ |