Resources

What is eBPF? | An Introduction and Practical Tips

October 14, 2021

This article introduces developers to eBPF and explains how it can be used to add security, networking, and other capabilities in the Linux kernel space.

Nate Matherson
Co-founder & CEO

In Linux architecture, memory is separated into kernel space and user space. The kernel space is used to run the core kernel code and the device drivers. Processes running in kernel space have unrestricted access to all hardware, including CPU, memory, and disks. All other processes run in the user space, which relies on the kernel to access the hardware. Processes running in the user space use system calls to communicate with the kernel for privileged operations like disk or network I/O.

This separation creates a secure distinction between various processes, but in some cases the syscall interface is not sufficient and developers need more flexibility to run custom code directly in the kernel without changing the kernel’s source code. For this purpose, Linux provides Linux Kernel Modules, which can be loaded directly in the kernel on demand during runtime.

The kernel modules, however, create security risks since they can run arbitrary code directly in the kernel space. A buggy code in a kernel module can easily crash the kernel. This is why Linux provides a way to run secure, verified sandboxed code in the kernel space through eBPF.

What Is eBPF?

BPF, or the Berkeley Packet Filter, was developed from a need to filter network packets in order to minimize unnecessary packet copies from the kernel space to the user space. User space applications like <terminal inline>tcpdump<terminal inline> are only interested in a small subset of network packets (for example, TCP/IP packets). If the filtering logic is in the user space application, unnecessary packets are copied from the kernel space to the user space. Placing the filtering logic in the kernel prevents those extra copies.

BPF provided a register-based virtual machine with its own instruction set where programs could be safely loaded into the kernel and executed in a secure, sandboxed environment. Since version 3.18, the Linux kernel provides extended BPF, or eBPF, which uses 64-bit registers and increases the number of registers from two to ten. eBPF offers an improved instruction set, which significantly boosts performance.

How eBPF Works

eBPF programs are event-driven, which means they can be hooked to certain events and will be run by the kernel when that particular event occurs. The program can store information in maps, print to ring buffers, or call a subset of kernel functions defined by a special API. The map and ring buffer structures are managed by the kernel, and the same map can be accessed by multiple eBPF programs in order to share data.

eBPF programs follow these steps:

  1. The bytecode of the eBPF program is sent to the kernel along with a program type that determines where the program needs to be attached, which in-kernel helper functions the verifier will allow to be called, whether network packet data can be accessed directly, and what type of object will pass as the first argument to the program.
  2. The kernel runs a verifier on the bytecode. The verifier runs several security checks on the bytecode, which make sure that the program terminates and does not contain any loop that could potentially lock up the kernel. It also simulates the execution of the eBPF program and checks the state of the virtual machine at every step to ensure the register and stack states are valid. Finally, it uses the program type to restrict the allowed kernel function calls from the program.
  3. The bytecode is JIT-compiled into native code and attached to the specified location.
  4. When the specified event occurs, the program is executed and writes data to the ring buffer or the map.
  5. The map or ring buffer can be read by the user space to get the program result.

Diagram explaining how eBPF works
Diagram explaining how eBPF works

Advantages of eBPF

eBPF is most commonly used to trace and profile user space processes. It provides some clear advantages over other methods:

  • eBPF moves the task of packet filtering from the user space to the kernel space, thus preventing unnecessary packet copies, which results in a significant performance increase. Because the program is JIT-compiled, it operates quickly.
  • eBPF programs are sandboxed and verified, which ensures the kernel doesn’t crash or hang up in a loop. This provides greater security over kernel modules.
  • Using eBPF doesn’t require you to modify kernel source code or write full-fledged kernel modules. It is easy to write and execute an eBPF program.

When to Use eBPF

eBPF offers the greatest benefits in some specific use cases:

  • eBPF is superior to other methods of profiling and tracing user space processes. eBPF programs can be attached to any kernel function and access the context and arguments of the function, as well as modify them. eBPF provides advanced statistical data structures that easily and efficiently extract meaningful data.
  • eBPF can implement traffic control, so that packets are directly sent to their destination. This is especially useful in Kubernetes and other container environments in which you have multiple networks, because traffic is usually routed to a container stack. Using eBPF, the complex path between the host and the container stack can be bypassed.
  • eBPF can implement security policies in container environments such as Docker or Kubernetes. eBPF is used in XDP (eXpress Data Path) to provide a high-performance, programmable network data path.

When Not to Use eBPF

eBPF offers many advantages, but it does have limitations. Here are a few situations where eBPF should not be used:

  • Since eBPF aims to be secure, it prohibits loops and other high-level constructs, which means the programs are simple and restricted. If you want more control over how the programs are executed, writing a kernel module might be a better choice.
  • Executing eBPF programs consumes CPU cycles, and using eBPF instead of built-in tools like iptables might result in a high CPU usage. This will increase the costs from your cloud provider.
  • eBPF is not suited for a use case in which you need to process every packet, such as in decryption and re-encryption of packets. Per-packet processing will be expensive and relatively slow.

Getting Started with eBPF

Writing an eBPF program directly in the bytecode is extremely hard. Fortunately, you can write the program in other languages and compile it to the eBPF bytecode. You’ll also need to write a user space program that attaches this bytecode to the kernel and interacts with it. The most straightforward way to write an eBPF program is to use BCC (BPF Compiler Collection), which provides frontend for eBPF in C++, Python, and Lua. For this example, you will be using the Python frontend.

To follow along, you need to install BCC and create a file called <terminal inline>bpf.py<terminal inline>.

First, import the required module:


from bcc import BPF

Now using C, write the code for the eBPF program that will be executed in the kernel. You can either write the C program inside Python and store it as a string variable, or write it in a separate file and read that file into the Python program. We will be taking the first approach.


program = """
init kprobe__sys_clone(void *ctx) {
 bpf_trace_printk("Hello, World!\\n");
 return 0;
}
"""

Let’s understand the C program. It defines a simple function named <terminal inline>kprobe__sys_clone<terminal inline>. The name of the function tells BCC where to attach it. Since the name starts with <terminal inline>kprobe__<terminal inline>, it defines a kprobe to trace a kernel function. The rest of the function name defines which kernel function to trace, in this case <terminal inline>sys_clone<terminal inline>. The function takes one argument, <terminal inline>ctx<terminal inline>. This is actually the type <terminal inline>struct pt_regs *<terminal inline>, which holds the registers and the BPF context. Since you will not be using this argument here, it is cast to <terminal inline>void *<terminal inline>. The function can include as many of the probed function arguments as you want, as long as the first argument is <terminal inline>ctx<terminal inline>.

Inside the function, we are using <terminal inline>bpf_trace_printk<terminal inline> to print <terminal inline>hello world<terminal inline> to the kernel’s common trace_pipe. Finally, <terminal inline>return 0<terminal inline>; is a necessary formality.

Compile the program, verify it, and load it into the kernel. All of this is handled by the <terminal inline>BPF<terminal inline> class:


b = BPF(text=program)

Read the kernel’s <terminal inline>trace_pipe<terminal inline> and print the messages:


python
print("%-18x %-16s %-6s %s" % ("TIME(s)", "COMMAND", "PID", "MESSAGE"))

while 1:
 try
  (task, pid, cpu, flags, ts, msg) = b.trace_fields()
 except ValueError:
  continue
 print("%-18.9f %-16s %-6d %s" % (ts, task.decode(), pid, msg.decode()))

This sets up a <terminal inline>trace_fields<terminal inline> loop, which performs a blocking read on the <terminal inline>trace_pipe<terminal inline> and returns a fixed set of information about the execution of the traced function. Finally, print the fields you need. The values <terminal inline>task<terminal inline> and <terminal inline>msg<terminal inline> are bytes, so call <terminal inline>decode<terminal inline> to convert them into strings.

To run this program, you will need superuser permission. Run the program with <terminal inline>sudo<terminal inline>:


sudo python bpf.py

Now open up another shell and run any command like <terminal inline>ls<terminal inline> or <terminal inline>cat<terminal inline> that will trigger the <terminal inline>clone<terminal inline> call. Your eBPF program will be executed and the output will be printed. Here is a sample output:

Sample eBPF output
Sample eBPF output

For more code samples, check the BCC examples directory.

Conclusion

eBPF is an excellent advancement for the Linux kernel. The ability to run code in a secured and sandboxed fashion in the kernel is a valuable tool for observability, network traffic control, and containerization.

If you want to learn more about eBPF and access community resources, conferences, and blogs, visit ebpf.io. The BCC docs are great to get started quickly with code samples. However, you may also want to consider using libbpf as an alternative to BCC. Finally, the Awesome eBPF repo aggregates multiple resources for further research.

Article by

Nate Matherson

Co-founder & CEO

Nate Matherson is the Co-founder & CEO of ContainIQ.

Read More