doc/guides/prog_guide/bpf_lib.rst

   1 ..  SPDX-License-Identifier: BSD-3-Clause
   2     Copyright(c) 2018 Intel Corporation.
   3
   4 Berkeley Packet Filter Library
   5 ==============================
   6
   7 The DPDK provides an BPF library that gives the ability
   8 to load and execute Enhanced Berkeley Packet Filter (eBPF) bytecode within
   9 user-space dpdk application.
  10
  11 It supports basic set of features from eBPF spec.
  12 Please refer to the
  13 `eBPF spec <https://www.kernel.org/doc/Documentation/networking/filter.txt>`
  14 for more information.
  15 Also it introduces basic framework to load/unload BPF-based filters
  16 on eth devices (right now only via SW RX/TX callbacks).
  17
  18 The library API provides the following basic operations:
  19
  20 *  Create a new BPF execution context and load user provided eBPF code into it.
  21
  22 *   Destroy an BPF execution context and its runtime structures and free the associated memory.
  23
  24 *   Execute eBPF bytecode associated with provided input parameter.
  25
  26 *   Provide information about natively compiled code for given BPF context.
  27
  28 *   Load BPF program from the ELF file and install callback to execute it on given ethdev port/queue.
  29
  30 Not currently supported eBPF features
  31 -------------------------------------
  32
  33  - JIT for non X86_64 platforms
  34  - cBPF
  35  - tail-pointer call
  36  - eBPF MAP
  37  - skb
  38  - external function calls for 32-bit platforms