README.rst 1.2 KB

123456789101112131415161718192021222324252627282930313233343536
  1. =================
  2. BPF documentation
  3. =================
  4. This directory contains documentation for the BPF (Berkeley Packet
  5. Filter) facility, with a focus on the extended BPF version (eBPF).
  6. This kernel side documentation is still work in progress. The main
  7. textual documentation is (for historical reasons) described in
  8. `Documentation/networking/filter.txt`_, which describe both classical
  9. and extended BPF instruction-set.
  10. The Cilium project also maintains a `BPF and XDP Reference Guide`_
  11. that goes into great technical depth about the BPF Architecture.
  12. The primary info for the bpf syscall is available in the `man-pages`_
  13. for `bpf(2)`_.
  14. Frequently asked questions (FAQ)
  15. ================================
  16. Two sets of Questions and Answers (Q&A) are maintained.
  17. * QA for common questions about BPF see: bpf_design_QA_
  18. * QA for developers interacting with BPF subsystem: bpf_devel_QA_
  19. .. Links:
  20. .. _bpf_design_QA: bpf_design_QA.rst
  21. .. _bpf_devel_QA: bpf_devel_QA.rst
  22. .. _Documentation/networking/filter.txt: ../networking/filter.txt
  23. .. _man-pages: https://www.kernel.org/doc/man-pages/
  24. .. _bpf(2): http://man7.org/linux/man-pages/man2/bpf.2.html
  25. .. _BPF and XDP Reference Guide: http://cilium.readthedocs.io/en/latest/bpf/