xref: /dpdk/doc/guides/prog_guide/bpf_lib.rst (revision 6861c01001ac3b1869f5cf1f492809875f753e67)
114b8f0bbSKonstantin Ananyev..  SPDX-License-Identifier: BSD-3-Clause
214b8f0bbSKonstantin Ananyev    Copyright(c) 2018 Intel Corporation.
314b8f0bbSKonstantin Ananyev
414b8f0bbSKonstantin AnanyevBerkeley Packet Filter Library
514b8f0bbSKonstantin Ananyev==============================
614b8f0bbSKonstantin Ananyev
714b8f0bbSKonstantin AnanyevThe DPDK provides an BPF library that gives the ability
814b8f0bbSKonstantin Ananyevto load and execute Enhanced Berkeley Packet Filter (eBPF) bytecode within
914b8f0bbSKonstantin Ananyevuser-space dpdk application.
1014b8f0bbSKonstantin Ananyev
1114b8f0bbSKonstantin AnanyevIt supports basic set of features from eBPF spec.
1214b8f0bbSKonstantin AnanyevPlease refer to the
1314b8f0bbSKonstantin Ananyev`eBPF spec <https://www.kernel.org/doc/Documentation/networking/filter.txt>`
1414b8f0bbSKonstantin Ananyevfor more information.
1514b8f0bbSKonstantin AnanyevAlso it introduces basic framework to load/unload BPF-based filters
1614b8f0bbSKonstantin Ananyevon eth devices (right now only via SW RX/TX callbacks).
1714b8f0bbSKonstantin Ananyev
1814b8f0bbSKonstantin AnanyevThe library API provides the following basic operations:
1914b8f0bbSKonstantin Ananyev
2014b8f0bbSKonstantin Ananyev*  Create a new BPF execution context and load user provided eBPF code into it.
2114b8f0bbSKonstantin Ananyev
2214b8f0bbSKonstantin Ananyev*   Destroy an BPF execution context and its runtime structures and free the associated memory.
2314b8f0bbSKonstantin Ananyev
2414b8f0bbSKonstantin Ananyev*   Execute eBPF bytecode associated with provided input parameter.
2514b8f0bbSKonstantin Ananyev
2614b8f0bbSKonstantin Ananyev*   Provide information about natively compiled code for given BPF context.
2714b8f0bbSKonstantin Ananyev
2814b8f0bbSKonstantin Ananyev*   Load BPF program from the ELF file and install callback to execute it on given ethdev port/queue.
2914b8f0bbSKonstantin Ananyev
3014b8f0bbSKonstantin AnanyevNot currently supported eBPF features
3114b8f0bbSKonstantin Ananyev-------------------------------------
3214b8f0bbSKonstantin Ananyev
33*6861c010SJerin Jacob - JIT support only available for X86_64 and arm64 platforms
3414b8f0bbSKonstantin Ananyev - cBPF
3514b8f0bbSKonstantin Ananyev - tail-pointer call
3614b8f0bbSKonstantin Ananyev - eBPF MAP
3714b8f0bbSKonstantin Ananyev - skb
3814b8f0bbSKonstantin Ananyev - external function calls for 32-bit platforms
39