Commit | Line | Data |
---|---|---|
4712c1b2 JDB |
1 | ================= |
2 | BPF documentation | |
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 | ||
8 | This kernel side documentation is still work in progress. The main | |
9 | textual documentation is (for historical reasons) described in | |
10 | `Documentation/networking/filter.txt`_, which describe both classical | |
11 | and extended BPF instruction-set. | |
12 | The Cilium project also maintains a `BPF and XDP Reference Guide`_ | |
13 | that goes into great technical depth about the BPF Architecture. | |
14 | ||
15 | The primary info for the bpf syscall is available in the `man-pages`_ | |
16 | for `bpf(2)`_. | |
17 | ||
18 | ||
19 | ||
20 | Frequently asked questions (FAQ) | |
21 | ================================ | |
22 | ||
23 | Two sets of Questions and Answers (Q&A) are maintained. | |
24 | ||
25 | * QA for common questions about BPF see: bpf_design_QA_ | |
26 | ||
27 | * QA for developers interacting with BPF subsystem: bpf_devel_QA_ | |
28 | ||
29 | ||
30 | .. Links: | |
31 | .. _bpf_design_QA: bpf_design_QA.txt | |
32 | .. _bpf_devel_QA: bpf_devel_QA.txt | |
33 | .. _Documentation/networking/filter.txt: ../networking/filter.txt | |
34 | .. _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/ |