.. | .. |
---|
5 | 5 | This directory contains documentation for the BPF (Berkeley Packet |
---|
6 | 6 | Filter) facility, with a focus on the extended BPF version (eBPF). |
---|
7 | 7 | |
---|
8 | | -This kernel side documentation is still work in progress. The main |
---|
| 8 | +This kernel side documentation is still work in progress. The main |
---|
9 | 9 | textual documentation is (for historical reasons) described in |
---|
10 | | -`Documentation/networking/filter.txt`_, which describe both classical |
---|
11 | | -and extended BPF instruction-set. |
---|
| 10 | +:ref:`networking-filter`, which describe both classical and extended |
---|
| 11 | +BPF instruction-set. |
---|
12 | 12 | The Cilium project also maintains a `BPF and XDP Reference Guide`_ |
---|
13 | 13 | that goes into great technical depth about the BPF Architecture. |
---|
14 | 14 | |
---|
15 | 15 | The primary info for the bpf syscall is available in the `man-pages`_ |
---|
16 | 16 | for `bpf(2)`_. |
---|
17 | 17 | |
---|
| 18 | +BPF Type Format (BTF) |
---|
| 19 | +===================== |
---|
| 20 | + |
---|
| 21 | +.. toctree:: |
---|
| 22 | + :maxdepth: 1 |
---|
| 23 | + |
---|
| 24 | + btf |
---|
18 | 25 | |
---|
19 | 26 | |
---|
20 | 27 | Frequently asked questions (FAQ) |
---|
.. | .. |
---|
29 | 36 | bpf_devel_QA |
---|
30 | 37 | |
---|
31 | 38 | |
---|
| 39 | +Helper functions |
---|
| 40 | +================ |
---|
| 41 | + |
---|
| 42 | +* `bpf-helpers(7)`_ maintains a list of helpers available to eBPF programs. |
---|
| 43 | + |
---|
| 44 | + |
---|
| 45 | +Program types |
---|
| 46 | +============= |
---|
| 47 | + |
---|
| 48 | +.. toctree:: |
---|
| 49 | + :maxdepth: 1 |
---|
| 50 | + |
---|
| 51 | + prog_cgroup_sockopt |
---|
| 52 | + prog_cgroup_sysctl |
---|
| 53 | + prog_flow_dissector |
---|
| 54 | + bpf_lsm |
---|
| 55 | + prog_sk_lookup |
---|
| 56 | + |
---|
| 57 | + |
---|
| 58 | +Map types |
---|
| 59 | +========= |
---|
| 60 | + |
---|
| 61 | +.. toctree:: |
---|
| 62 | + :maxdepth: 1 |
---|
| 63 | + |
---|
| 64 | + map_cgroup_storage |
---|
| 65 | + |
---|
| 66 | + |
---|
| 67 | +Testing and debugging BPF |
---|
| 68 | +========================= |
---|
| 69 | + |
---|
| 70 | +.. toctree:: |
---|
| 71 | + :maxdepth: 1 |
---|
| 72 | + |
---|
| 73 | + drgn |
---|
| 74 | + s390 |
---|
| 75 | + |
---|
| 76 | + |
---|
| 77 | +Other |
---|
| 78 | +===== |
---|
| 79 | + |
---|
| 80 | +.. toctree:: |
---|
| 81 | + :maxdepth: 1 |
---|
| 82 | + |
---|
| 83 | + ringbuf |
---|
| 84 | + |
---|
32 | 85 | .. Links: |
---|
33 | | -.. _Documentation/networking/filter.txt: ../networking/filter.txt |
---|
| 86 | +.. _networking-filter: ../networking/filter.rst |
---|
34 | 87 | .. _man-pages: https://www.kernel.org/doc/man-pages/ |
---|
35 | | -.. _bpf(2): http://man7.org/linux/man-pages/man2/bpf.2.html |
---|
36 | | -.. _BPF and XDP Reference Guide: http://cilium.readthedocs.io/en/latest/bpf/ |
---|
| 88 | +.. _bpf(2): https://man7.org/linux/man-pages/man2/bpf.2.html |
---|
| 89 | +.. _bpf-helpers(7): https://man7.org/linux/man-pages/man7/bpf-helpers.7.html |
---|
| 90 | +.. _BPF and XDP Reference Guide: https://docs.cilium.io/en/latest/bpf/ |
---|