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