[linux-2.6-block.git] / Documentation / bpf / index.rst

=================
BPF Documentation
=================

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)`_.

BPF Type Format (BTF)
=====================

.. toctree::
   :maxdepth: 1

   btf


Frequently asked questions (FAQ)
================================

Two sets of Questions and Answers (Q&A) are maintained.

.. toctree::
   :maxdepth: 1

   bpf_design_QA
   bpf_devel_QA


Program types
=============

.. toctree::
   :maxdepth: 1

   prog_cgroup_sockopt
   prog_cgroup_sysctl
   prog_flow_dissector


.. 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/
Commit	Line	Data
4712c1b2	1	=================
6919bcc8	2	BPF Documentation
4712c1b2 JDB	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
ffcf7ce9 YS	18	BPF Type Format (BTF)
	19	=====================
	20
	21	.. toctree::
	22	:maxdepth: 1
	23
	24	btf
4712c1b2 JDB	25
	26
	27	Frequently asked questions (FAQ)
	28	================================
	29
	30	Two sets of Questions and Answers (Q&A) are maintained.
	31
b3d40f63 TH	32	.. toctree::
b3d40f63 TH	33	:maxdepth: 1
4712c1b2	34
b3d40f63 TH	35	bpf_design_QA
b3d40f63 TH	36	bpf_devel_QA
4712c1b2 JDB	37
4712c1b2 JDB	38
da703149 AI	39	Program types
	40	=============
	41
	42	.. toctree::
	43	:maxdepth: 1
	44
0c51b369	45	prog_cgroup_sockopt
da703149	46	prog_cgroup_sysctl
80695946	47	prog_flow_dissector
da703149 AI	48
da703149 AI	49
4712c1b2	50	.. Links:
4712c1b2 JDB	51	.. _Documentation/networking/filter.txt: ../networking/filter.txt
	52	.. _man-pages: https://www.kernel.org/doc/man-pages/
	53	.. _bpf(2): http://man7.org/linux/man-pages/man2/bpf.2.html
	54	.. _BPF and XDP Reference Guide: http://cilium.readthedocs.io/en/latest/bpf/