bpftool - Man Page

tool for inspection and simple manipulation of eBPF programs and maps

Examples (TL;DR)

List information about loaded eBPF programs: bpftool prog list
List eBPF program attachments in the kernel networking subsystem: bpftool net list
List all active links: bpftool link list
List all raw_tracepoint, tracepoint, kprobe attachments in the system: bpftool perf list
List BPF Type Format (BTF) data: bpftool btf list
List information about loaded maps: bpftool map list
Probe a network device "eth0" for supported eBPF features: bpftool feature probe dev eth0
Run commands in batch mode from a file: bpftool batch file myfile

bpftool [Options] OBJECT { COMMAND | help }

bpftool batch file FILE

bpftool version

OBJECT := { map | prog | link | cgroup | perf | net | feature | btf | gen | struct_ops | iter }

Options := { { -V | --version } | { -j | --json } [{ -p | --pretty }] | { -d | --debug } }

MAP-COMMANDS := { show | list | create | dump | update | lookup | getnext | delete | pin | event_pipe | help }

PROG-COMMANDS := { show | list | dump jited | dump xlated | pin | load | attach | detach | help }

LINK-COMMANDS := { show | list | pin | detach | help }

CGROUP-COMMANDS := { show | list | attach | detach | help }

PERF-COMMANDS := { show | list | help }

NET-COMMANDS := { show | list | help }

FEATURE-COMMANDS := { probe | help }

BTF-COMMANDS := { show | list | dump | help }

GEN-COMMANDS := { object | skeleton | min_core_btf | help }

STRUCT-OPS-COMMANDS := { show | list | dump | register | unregister | help }

ITER-COMMANDS := { pin | help }

bpftool allows for inspection and simple modification of BPF objects on the system.

Note that format of the output of all tools is not guaranteed to be stable and should not be depended upon.

-h, --help: Print short help message (similar to bpftool help).
-V, --version: Print bpftool's version number (similar to bpftool version), the number of the libbpf version in use, and optional features that were included when bpftool was compiled. Optional features include linking against LLVM or libbfd to provide the disassembler for JIT-ted programs (bpftool prog dump jited) and usage of BPF skeletons (some features like bpftool prog profile or showing pids associated to BPF objects may rely on it).
-j, --json: Generate JSON output. For commands that cannot produce JSON, this option has no effect.
-p, --pretty: Generate human-readable JSON output. Implies -j.
-d, --debug: Print all logs available, even debug-level information. This includes logs from libbpf as well as from the verifier, when attempting to load programs.
-m, --mapcompat: Allow loading maps with unknown map definitions.
-n, --nomount: Do not automatically attempt to mount any virtual file system (such as tracefs or BPF virtual file system) when necessary.