Jesper Dangaard Brouer | 4712c1b | 2018-05-14 15:42:12 +0200 | [diff] [blame] | 1 | ================= |
Tobin C. Harding | 6919bcc | 2018-07-26 15:03:05 +1000 | [diff] [blame] | 2 | BPF Documentation |
Jesper Dangaard Brouer | 4712c1b | 2018-05-14 15:42:12 +0200 | [diff] [blame] | 3 | ================= |
| 4 | |
| 5 | This directory contains documentation for the BPF (Berkeley Packet |
| 6 | Filter) facility, with a focus on the extended BPF version (eBPF). |
| 7 | |
Christoph Hellwig | 88691e9 | 2021-11-19 17:32:15 +0100 | [diff] [blame] | 8 | This kernel side documentation is still work in progress. |
Jesper Dangaard Brouer | 4712c1b | 2018-05-14 15:42:12 +0200 | [diff] [blame] | 9 | The Cilium project also maintains a `BPF and XDP Reference Guide`_ |
| 10 | that goes into great technical depth about the BPF Architecture. |
| 11 | |
Yonghong Song | ffcf7ce | 2019-01-18 13:56:49 -0800 | [diff] [blame] | 12 | .. toctree:: |
| 13 | :maxdepth: 1 |
| 14 | |
Christoph Hellwig | 88691e9 | 2021-11-19 17:32:15 +0100 | [diff] [blame] | 15 | instruction-set |
| 16 | verifier |
Dave Tucker | 5931d9a | 2021-11-12 21:17:24 +0000 | [diff] [blame] | 17 | libbpf/index |
Yonghong Song | ffcf7ce | 2019-01-18 13:56:49 -0800 | [diff] [blame] | 18 | btf |
Dave Tucker | 5931d9a | 2021-11-12 21:17:24 +0000 | [diff] [blame] | 19 | faq |
| 20 | syscall_api |
| 21 | helpers |
| 22 | programs |
| 23 | maps |
Christoph Hellwig | 41db511 | 2021-12-23 11:19:04 +0100 | [diff] [blame] | 24 | classic_vs_extended.rst |
Alexei Starovoitov | c86216b | 2021-09-17 16:00:34 -0700 | [diff] [blame] | 25 | bpf_licensing |
Dave Tucker | 5931d9a | 2021-11-12 21:17:24 +0000 | [diff] [blame] | 26 | test_debug |
| 27 | other |
Alexei Starovoitov | c86216b | 2021-09-17 16:00:34 -0700 | [diff] [blame] | 28 | |
Dave Tucker | 5931d9a | 2021-11-12 21:17:24 +0000 | [diff] [blame] | 29 | .. only:: subproject and html |
Alexei Starovoitov | c86216b | 2021-09-17 16:00:34 -0700 | [diff] [blame] | 30 | |
Dave Tucker | 5931d9a | 2021-11-12 21:17:24 +0000 | [diff] [blame] | 31 | Indices |
| 32 | ======= |
Daniel W. S. Almeida | 5fe52b3 | 2020-07-18 13:51:04 -0300 | [diff] [blame] | 33 | |
Dave Tucker | 5931d9a | 2021-11-12 21:17:24 +0000 | [diff] [blame] | 34 | * :ref:`genindex` |
Daniel W. S. Almeida | 5fe52b3 | 2020-07-18 13:51:04 -0300 | [diff] [blame] | 35 | |
Jesper Dangaard Brouer | 4712c1b | 2018-05-14 15:42:12 +0200 | [diff] [blame] | 36 | .. Links: |
Christoph Hellwig | 88691e9 | 2021-11-19 17:32:15 +0100 | [diff] [blame] | 37 | .. _BPF and XDP Reference Guide: https://docs.cilium.io/en/latest/bpf/ |