2018-05-14 13:42:12 +00:00
|
|
|
=================
|
2018-07-26 05:03:05 +00:00
|
|
|
BPF Documentation
|
2018-05-14 13:42:12 +00:00
|
|
|
=================
|
|
|
|
|
|
|
|
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
|
|
|
|
`Documentation/networking/filter.txt`_, 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)`_.
|
|
|
|
|
2019-01-18 21:56:49 +00:00
|
|
|
BPF Type Format (BTF)
|
|
|
|
=====================
|
|
|
|
|
|
|
|
.. toctree::
|
|
|
|
:maxdepth: 1
|
|
|
|
|
|
|
|
btf
|
2018-05-14 13:42:12 +00:00
|
|
|
|
|
|
|
|
|
|
|
Frequently asked questions (FAQ)
|
|
|
|
================================
|
|
|
|
|
|
|
|
Two sets of Questions and Answers (Q&A) are maintained.
|
|
|
|
|
2018-07-26 05:03:03 +00:00
|
|
|
.. toctree::
|
|
|
|
:maxdepth: 1
|
2018-05-14 13:42:12 +00:00
|
|
|
|
2018-07-26 05:03:03 +00:00
|
|
|
bpf_design_QA
|
|
|
|
bpf_devel_QA
|
2018-05-14 13:42:12 +00:00
|
|
|
|
|
|
|
|
2019-04-18 05:28:57 +00:00
|
|
|
Program types
|
|
|
|
=============
|
|
|
|
|
|
|
|
.. toctree::
|
|
|
|
:maxdepth: 1
|
|
|
|
|
2019-06-27 20:38:54 +00:00
|
|
|
prog_cgroup_sockopt
|
2019-04-18 05:28:57 +00:00
|
|
|
prog_cgroup_sysctl
|
2019-04-18 23:47:52 +00:00
|
|
|
prog_flow_dissector
|
2020-03-29 00:43:56 +00:00
|
|
|
bpf_lsm
|
2019-04-18 05:28:57 +00:00
|
|
|
|
|
|
|
|
2020-03-24 18:51:35 +00:00
|
|
|
Testing and debugging BPF
|
|
|
|
=========================
|
2019-10-29 17:29:16 +00:00
|
|
|
|
|
|
|
.. toctree::
|
|
|
|
:maxdepth: 1
|
|
|
|
|
2020-03-24 18:51:35 +00:00
|
|
|
drgn
|
2019-10-29 17:29:16 +00:00
|
|
|
s390
|
|
|
|
|
|
|
|
|
2018-05-14 13:42:12 +00:00
|
|
|
.. Links:
|
|
|
|
.. _Documentation/networking/filter.txt: ../networking/filter.txt
|
|
|
|
.. _man-pages: https://www.kernel.org/doc/man-pages/
|
|
|
|
.. _bpf(2): http://man7.org/linux/man-pages/man2/bpf.2.html
|
|
|
|
.. _BPF and XDP Reference Guide: http://cilium.readthedocs.io/en/latest/bpf/
|