blob: ef5c996547ecb60562fae4e41aa397fc74c6387d [file] [log] [blame]
Jesper Dangaard Brouer4712c1b2018-05-14 15:42:12 +02001=================
Tobin C. Harding6919bcc2018-07-26 15:03:05 +10002BPF Documentation
Jesper Dangaard Brouer4712c1b2018-05-14 15:42:12 +02003=================
4
5This directory contains documentation for the BPF (Berkeley Packet
6Filter) facility, with a focus on the extended BPF version (eBPF).
7
Christoph Hellwig88691e92021-11-19 17:32:15 +01008This kernel side documentation is still work in progress.
Jesper Dangaard Brouer4712c1b2018-05-14 15:42:12 +02009The Cilium project also maintains a `BPF and XDP Reference Guide`_
10that goes into great technical depth about the BPF Architecture.
11
Yonghong Songffcf7ce2019-01-18 13:56:49 -080012.. toctree::
13 :maxdepth: 1
14
Christoph Hellwig88691e92021-11-19 17:32:15 +010015 instruction-set
16 verifier
Dave Tucker5931d9a2021-11-12 21:17:24 +000017 libbpf/index
Yonghong Songffcf7ce2019-01-18 13:56:49 -080018 btf
Dave Tucker5931d9a2021-11-12 21:17:24 +000019 faq
20 syscall_api
21 helpers
22 programs
23 maps
Christoph Hellwig41db5112021-12-23 11:19:04 +010024 classic_vs_extended.rst
Alexei Starovoitovc86216b2021-09-17 16:00:34 -070025 bpf_licensing
Dave Tucker5931d9a2021-11-12 21:17:24 +000026 test_debug
27 other
Alexei Starovoitovc86216b2021-09-17 16:00:34 -070028
Dave Tucker5931d9a2021-11-12 21:17:24 +000029.. only:: subproject and html
Alexei Starovoitovc86216b2021-09-17 16:00:34 -070030
Dave Tucker5931d9a2021-11-12 21:17:24 +000031 Indices
32 =======
Daniel W. S. Almeida5fe52b32020-07-18 13:51:04 -030033
Dave Tucker5931d9a2021-11-12 21:17:24 +000034 * :ref:`genindex`
Daniel W. S. Almeida5fe52b32020-07-18 13:51:04 -030035
Jesper Dangaard Brouer4712c1b2018-05-14 15:42:12 +020036.. Links:
Christoph Hellwig88691e92021-11-19 17:32:15 +010037.. _BPF and XDP Reference Guide: https://docs.cilium.io/en/latest/bpf/