Awesome eBPF

A curated list of awesome projects related to eBPF.

BPF, as in Berkeley Packet Filter, is an in-kernel virtual machine running programs passed from user space. Initially implemented on BSD, then Linux, the (now legacy) "classic BPF" or cBPF machine would be used with tools like tcpdump for filtering packets in the kernel to avoid useless copies to user space. More recently, the BPF infrastructure in Linux has been completely reworked and gave life to the "extended BPF", or eBPF, which gained new features (safety and termination checks, JIT-compiling for programs, persistent maps, a standard library, hardware offload support, etc.) and is now used for many tasks. Processing packets at a very low level (XDP), tracing and monitoring events on the system, or enforcing access control over cgroups are but a few examples to which eBPF brings performance, programmability and flexibility.

Note: eBPF is an exciting piece of technology, and its ecosystem is constantly evolving. We'd love help from you to keep this awesome list up to date, and improve its signal-to-noise ratio in anyway we can. Please feel free to leave any feedback.

Contents

• Reference Documentation
• Articles and Presentations
• Tutorials
• Examples
• eBPF Workflow: Tools and Utilities
• Projects Related to eBPF
• The Code
• Development and Community
• Other Lists of Resources on eBPF
• Acknowledgement

Reference Documentation

Cilium Guide

• Cilum's BPF and XDP Reference Guide - Generic documentation about most features of eBPF.

Kernel Documentation

• BPF Documentation - Index for BPF-related documentation coming with the Linux kernel.
• linux/Documentation/networking/filter.txt - eBPF specification (somewhat outdated; information should still be valid, but not exhaustive).
• BPF Design Q&A - Frequently Asked Questions on the decisions behind the BPF infrastructure.
• HOWTO interact with BPF subsystem - Frequently Asked Questions about contributing to eBPF development.

Manual Pages

• bpf(2) - Manual page about the bpf() system call, used to manage BPF programs and maps from userspace.
• tc-bpf(8) - Manual page about using BPF with tc, including example commands and samples of code.
• bpf-helpers(7) man page - Description of the in-kernel helper functions forming the BPF standard library.

Other

• IO Visor's Unofficial eBPF spec - Summary of eBPF syntax and operation codes.

• Jesper Dangaard Brouer's documentation - Work in progress, contributions welcome.

• Emails from David Miller to the xdp-newbies mailing list:

  • bpf.h and you...
  • Contextually speaking...
  • BPF Verifier Overview

• List of BPF features per kernel version

Articles and Presentations

Generic eBPF presentations

If you are new to eBPF, you may want to try the links described as "introductions" in this section.

• A brief introduction to XDP and eBPF - An accessible introduction providing context, history, and details about the functioning of eBPF.

• An eBPF Overview - Blog series by Adrian Ratiu, covering many aspects of the eBPF infrastructure:

  • Part 1: Introduction
  • Part 2: Machine & Bytecode

• Ferris Ellis's blog posts about eBPF - They have a few posts about eBPF:

  • Part 1: Past, Present, and Future
  • Part 2: Syscall and Map Types

• A BPF reference guide - About BPF C and bcc Python helpers, from bcc repository.

• Making the Kernel's Networking Data Path Programmable with BPF and XDP - A set of slides covering all the basics about eBPF and XDP (mostly for network processing).

• The BSD Packet Filter - An introduction mostly covering the tracing aspects.

• BPF: tracing and more - An introduction mostly covering the tracing aspects.

• Linux BPF Superpowers - An introduction mostly covering the tracing aspects, first part with flame graphs.

• IO Visor - Also introduces IO Visor project.

• BPF -- in-kernel virtual machine - Presentation by the author of eBPF.

• Extending extended BPF - A blog post from 2014 on the development of BPF and demonstrating what can be done with it, using an example of stateful socket filtering by attaching an eBPF program to a socket.

• Greg Marsden made some documentation about eBPF:

  • A Tour of Program Types - A description of all existing hooks for BPF program types, and of their interest.
  • BPF helper functions - A review of the kernel functions that can be called from within eBPF programs.
  • Communicating with Userspace - How BPF communicates with userspace - BPF maps, perf events, bpf_trace_printk.
  • Building BPF Programs - Setting up your environment to build BPF programs.
  • The BPF Bytecode and the BPF Verifier - How does BPF ensure that programs are safe?
  • Using BPF to do Packet Transformation - One eBPF usage about packet transformation.

• Linux Kernel Observability through eBPF - A blog post covering the basics of eBPF as well as code samples in Go on how to build and load a minimal eBPF program into the kernel.

BPF Internals

• Daniel Borkmann has made several presentations and papers covering the internals of eBPF, in particular about its use with tc.

  • eBPF and XDP walkthrough and recent (2017) updates
  • Advanced programmability and recent updates with tc's cls_bpf - Details on eBPF, its use for tunneling and encapsulation, direct packet access, and more.
  • cls_bpf/eBPF updates since netdev 1.1 - Part of this tc workshop.
  • On getting tc classifier fully programmable with cls_bpf - Introduction to eBPF, including several features (map management, tail calls, verifier). The full paper is also available here.
  • Linux tc and eBPF

• IO Visor blog

• Linux Networking Explained - Linux networking internals, with a part about eBPF.

Kernel Tracing

• Full-system dynamic tracing on Linux using eBPF and bpftrace - A detailed introduction to tracing with eBPF, from listing the available trace points to running bpftrace programs.
• Meet-cute between eBPF and Kernel Tracing - Kprobes, uprobes, ftrace.
• Linux Kernel Tracing - Systemtap, Kernelshark, trace-cmd, LTTng, perf-tool, ftrace, hist-trigger, perf, function tracer, tracepoint, kprobe/uprobe, and more.
• Brendan Gregg's blog, and in particular Linux BPF Superpowers article.

XDP

• The eXpress Data Path - A very accessible introduction to XDP, providing sample code to show how to process packets.

• All XDP details in a technical paper: The eXpress Data Path: Fast Programmable Packet Processing in the Operating System Kernel, by Toke Høiland-Jørgensen, Jesper Dangaard Brouer, Daniel Borkmann, John Fastabend, Tom Herbert, David Ahern and David Miller, all being essential eBPF and XDP contributors.

• Work-in-progress documentation for XDP

• BPF and XDP Reference Guide - Guide from the Cilium project.

• XDP Project overview

• eXpress Data Path (XDP) - The first presentation about XDP.

• BoF - What Can BPF Do For You?

• eXpress Data Path - Contains some benchmark results obtained with the mlx4 driver.

• Jesper Dangaard Brouer has several sets of slides describing the internals of XDP:

  • XDP − eXpress Data Path, Intro and future use-cases - Linux Kernel's fight against DPDK. Future plans (as of this writing) for XDP and comparison with DPDK.
  • Network Performance Workshop - Additional hints about XDP internals and expected evolution.
  • XDP – eXpress Data Path, Used for DDoS protection - Details and use cases about XDP, with benchmark results, and code snippets for benchmarking as well as for basic DDoS protection with eBPF/XDP (based on an IP blacklisting scheme).
  • Memory vs. Networking, Provoking and fixing memory bottlenecks - Advanced details about current memory issues faced by XDP developers.
  • XDP for the Rest of Us - How to get started with eBPF and XDP for normal humans. Also summarized by Julia Evans on her blog.
  • XDP now with REDIRECT - Update on XDP, and in particular on the redirect actions.

• XDP workshop -- Introduction, experience, and future development (Video)

• High Speed Packet Filtering on Linux - About packet filtering on Linux, DDoS protection, packet processing in the kernel, kernel bypass, XDP and eBPF.

AF_XDP

• AF_XDP - Kernel documentation on the AF_XDP address family.
• Fast Packet Processing in Linux with AF_XDP

bpfilter

• Why is the kernel community replacing iptables with BPF? - A blog post by Cilium on the the motivations behind eBPF and bpfilter, with a couple examples and links to other projects using eBPF and bpfilter.
• bpfilter: Linux firewall with eBPF sauce - Slides from a talk by Quentin Monnet with a background on eBPF and comparing bpfilter to iptables.

BTF

• BPF Type Format (BTF) - Kernel documentation about BTF, explaining how to use it.
• Enhancing the Linux kernel with BTF type information - A description of the work done with BTF to provide debugging information for BPF programs.

cBPF

• The BSD Packet Filter: A New Architecture for User-level Packet Capture - The original paper about (classic) BPF.
• The FreeBSD manual page about BPF
• Linux' packet mmap(2), BPF, and Netsniff-NG
• tc and cls bpf: lightweight packet classifying with BPF
• Introducing Cloudflare's BPF Tools - Usage of BPF bytecode with the xt_bpf module for iptables.
• Libpcap filters syntax

Hardware Offload

• eBPF/XDP hardware offload to SmartNICs - Hardware offload for eBPF with TC or XDP (Linux kernel 4.9+), introduced by Netronome.
• Comprehensive XDP offload---Handling the edge cases - An update on the topic above.

Tutorials

• bcc Reference Guide - Many incremental steps to start using bcc and eBPF, mostly centered on tracing and monitoring.
• bcc Python Developer Tutorial - Comes with bcc, but targets the Python bits across seventeen "lessons".
• Linux Tracing Workshops Materials - Involves the use of several BPF tools for tracing.
• Tracing a packet journey using Linux tracepoints, perf and eBPF - Troubleshooting ping requests and replies with perf and bcc programs.
• Open NFP platform - Operated by Netronome: some tutorials for network-related eBPF use cases, including an eBPF Offload Starting Guide.
• XDP for the Rest of Us - First edition of a workshop to get started with XDP.
• XDP for the Rest of Us - Second edition, with new contents.
• Load XDP programs using the ip (iproute2) command
• XDP Hands-On Tutorial - A progressive (three levels of difficulty) tutorial to learn how to process packets with XDP.

Examples

• linux/samples/bpf/ - In the kernel tree: some sample eBPF programs.
• linux/tools/testing/selftests/bpf - In the kernel tree: Linux BPF selftests, with many eBPF programs.
• prototype-kernel/kernel/samples/bpf - Jesper Dangaard Brouer's prototype-kernel repository contains some additional examples that can be compiled outside of kernel infrastructure.
• iproute2/examples/bpf/ - Some networking programs to attach to the TC interface.
• Netronome sample network applications - Provides basic but complete examples of eBPF applications also compatible with hardware offload.
• bcc/examples - Examples coming along with the bcc tools, mostly about tracing.
• bcc/tools - These tools themselves can be seen as example use cases for BPF programs, mostly for tracing and monitoring. bcc tools have been packaged for some Linux distributions.
• MPLSinIP sample - A heavily commented sample demonstrating how to encapsulate & decapsulate MPLS within IP. The code is commented for those new to BPF development.
• ebpf-samples - A collection of compiled (as ELF object files) samples gathered from several projects, primarily intended to serve as test cases for user space verifiers.

eBPF Workflow: Tools and Utilities

bcc

• bcc - Framework and set of tools - One way to handle BPF programs, in particular for tracing and monitoring. Also includes some utilities that may help inspect maps or programs on the system.
• P4 compiler for BPF targets for bcc - An alternative to the restricted C.
• Lua front-end for BCC - Another alternative to C, and even to most of the Python code used in bcc.

iproute2

• iproute2 - Package containing tools for network management on Linux. In particular, it contains tc, used to manage eBPF filters and actions, and ip, used to manage XDP programs. Most of the code related to BPF is in lib/bpf.c.
• iproute2-next - The development tree, synchronised with net-next.

LLVM

• LLVM - Contains several tools used in eBPF workflows. Snapshots of the latest versions for Ubuntu/Debian can be retrieved from here.

  • clang is used to compile C to eBPF object file under the ELF format (clang v3.7.1+). The BPF backend was added with this commit.
  • llvm-objdump is used to dump the content of an object file in human-readable format, possibly with the initial C source code (llvm-objdump v4.0+).
  • llvm-mc is used to compile from LLVM intermediate representation to eBPF object file, so that one can compile from C to eBPF assembly, tinker with assembly, then compile to ELF file.

libbpf

• libbpf - A C library used for handling BPF objects (programs and maps), and manipulating ELF object files containing them. It is shipped with the kernel and mirrored on GitHub.

bpftool and Other Tools from the Kernel Tree

• bpftool - Also some other tools in the kernel tree, under linux/tools/net/ for versions earlier than 4.15, or linux/tools/bpf/ after that:

  • bpftool - A generic utility that can be used to interact with eBPF programs and maps from userspace, for example to show, dump, load, disassemble, pin programs, or to show, create, pin, update, delete maps, or to attach and detach programs to cgroups.
  • bpf_asm - A minimal cBPF assembler.
  • bpf_dbg - A small debugger for cBPF programs.
  • bpf_jit_disasm - A disassembler for both BPF flavors and could be highly useful for JIT debugging.

User Space eBPF

• uBPF - Written in C. Contains an interpreter, a JIT compiler for x86_64 architecture, an assembler and a disassembler.
• A generic implementation - With support for FreeBSD kernel, FreeBSD user space, Linux kernel, Linux user space and macOS user space. Used for the VALE software switch's BPF extension module.
• rbpf - Written in Rust. Interpreter for Linux, macOS and Windows, and JIT-compiler for x86_64 under Linux.
• PREVAIL - A user space verifier for eBPF using an abstract interpretation layer, with support for loops.

Testing in Virtual Environments

• A Vagrant setup - To easily test XDP. Less useful now that generic XDP (driver-independant, mostly for testing) exists.
• bcc in a Docker container

Projects Related to eBPF

• P4 has some interactions with eBPF:

  • P4 on the Edge - P4 with eBPF to create high-performance programmable switches.
  • OvS Orbit episode (#11), called P4 on the Edge - Related to the former item. Audio interview of John Fastabend by Ben Pfaff, one of the core maintainers of Open vSwitch.
  • P4, EBPF and Linux TC Offload - P4 with some elements related to eBPF hardware offload on Netronome's NFP (Network Flow Processor) architecture.
  • Old documentation for P4 usage with eBPF - From bcc repository; deprecated by the P4_16 backend linked below.
  • P4_16 backend for eBPF

• Cilium project (GitHub repository) is a technology relying on BPF and XDP to provide "fast in-kernel networking and security policy enforcement for containers based on eBPF programs generated on the fly". Many presentations available (with overlap):

  • Cilium: Networking & Security for Containers with BPF & XDP - Also featuring a load balancer use case
  • Cilium: Networking & Security for Containers with BPF & XDP - video
  • Cilium: Fast IPv6 container Networking with BPF and XDP
  • Cilium: BPF & XDP for containers
  • OvS Orbit episode (#4) - Interview of Thomas Graf by Ben Pfaff.
  • A generic introduction to Cilium
  • A podcast interviewing Thomas Graf - Ivan Pepelnjak interviewing Thomas, October 2016, on eBPF, P4, XDP and Cilium.

• Open vSwitch (OvS), and its related project Open Virtual Network (OVN, an open source network virtualization solution) are considering using eBPF at various level:

  • Offloading OVS Flow Processing using eBPF
  • Coupling the Flexibility of OVN with the Efficiency of IOVisor

• Katran - A layer 4 load-balancer based on XDP, open-sourced by Facebook.

• XDP in practice: integrating XDP in our DDoS mitigation pipeline - Protection against DDoS with XDP at Cloudflare.

• Droplet: DDoS countermeasures powered by BPF + XDP - Protection against DDoS with XDP at Facebook.

• DPDK has a poll-mode driver (PMD) based on AF_XDP

• CETH for XDP - Common Ethernet Driver Framework for faster network I/O, a technology initiated by Mellanox.

• Suricata, an open source intrusion detection system, relies on eBPF components for its "capture bypass" features:

  • "eBPF and XDP" section of Suricata documentation
  • SEPTun-Mark-II - Extreme Performance Tuning guide - Mark II.
  • A blog post introducing the feature
  • The adventures of a Suricate in eBPF land
  • eBPF and XDP seen from the eyes of a meerkat

• Sysdig - A tool for "universal system visibility with native support for containers", now supports eBPF.

• InKeV: In-Kernel Distributed Network Virtualization for DCN

• gobpf - utilizing eBPF from Go - A library to create, load and use eBPF programs from Go.

• ply - A small but flexible open source dynamic tracer for Linux, with features similar to the bcc tools, but with a simpler language inspired by awk and DTrace.

• bpftrace - A tool for tracing, again with its own DSL. It is flexible enough to be envisioned as a Linux replacement for DTrace and SystemTap.

• kubectl trace - A kubectl plug-in for executing bpftrace programs in a Kubernetes cluster.

• bpfd - Framework for running BPF programs with rules on Linux as a daemon. Container aware.

• BPFd - A distinct BPF daemon, trying to leverage the flexibility of the bcc tools to trace and debug remote targets, and in particular devices running with Android.

• adeb - A Linux shell environment for using tracing tools on Android with BPFd.

• FUSE - Considers using eBPF.

• DEEP-mon - Helps with measuring power consumption for servers and uses eBPF programs for in-kernel aggregation of data.

The Code

• linux/include/linux/bpf.h - with linux/include/uapi/bpf.h: definitions related to eBPF, to be used respectively in the kernel and to interface with userspace programs.

• linux/include/linux/filter.h - with linux/include/uapi/filter.h: information used to run the BPF programs themselves.

• linux/kernel/bpf/ - This directory contains most of BPF-related code. In particular, those files are worth of interest:

  • syscall.c - Different operations permitted by the system call, such as program loading or map management.
  • core.c - BPF interpreter.
  • verifier.c - BPF verifier.

• linux/net/core/filter.c - Functions and eBPF helpers related to networking (TC, XDP etc.); also contains the code to migrate cBPF bytecode to eBPF (all cBPF programs are translated to eBPF in recent kernels).

• linux/kernel/trace/bpf_trace.c - Functions and eBPF helpers related to tracing and monitoring (kprobes, tracepoints, etc.).

• The JIT compilers are under the directory of their respective architectures, such as file linux/arch/x86/net/bpf_jit_comp.c for x86. Exception is made for JIT compilers used for hardware offload, sitting in their drivers, such as linux/drivers/net/ethernet/netronome/nfp/bpf/jit.c for Netronome NFP.

• linux/net/sched/ - and in particular in files act_bpf.c (action) and cls_bpf.c (filter): code related to BPF actions and filters with TC.

• linux/kernel/seccomp.c

• linux/net/core/dev.c - contains the function dev_change_xdp_fd() that is called through a Netlink command to hook a XDP program to a device, after is has been loaded into the kernel from user space. This function in turns uses a callback from the relevant driver.

Development and Community

• The bpf-next tree - BPF patches land in this tree. It is regularly merged into net-next, which is itself merged for each release to Linus' tree.
• Kernel documentation - About contributions to BPF.
• The netdev mailing list - Mailing list for Linux kernel networking stack development. All patches are sent there for review and inclusion.
• XDP-newbies - A mailing list specially dedicated to XDP programming (both for architecture or for asking for help).
• IO Visor mailing list - BPF is at the heart of the project, and is regularly discussed on the mailing list.
• @IOVisor Twitter account
• The XDP Collaboration Project - A GitHub repository with notes and ideas regarding the future evolutions of XDP.

Other Lists of Resources on eBPF

• IO Visor's bcc documentation
• IO Visor's bpf-docs repository
• Dive into BPF: A List of Reading Material

Acknowledgement

Thank you to Quentin Monnet and Daniel Borkmann for their original work on Dive into BPF: A List of Reading Material which became the basis for this list.

Contributing

Contributions welcome! Read the contribution guidelines first.

License

To the extent possible under law, zoidbergwill has waived all copyright and related or neighboring rights to this work.