In general, to use these features, a Linux kernel version 4.1 or newer is required. In addition, the kernel should have been compiled with the following flags set:
CONFIG_BPF=y CONFIG_BPF_SYSCALL=y # [optional, for tc filters] CONFIG_NET_CLS_BPF=m # [optional, for tc actions] CONFIG_NET_ACT_BPF=m CONFIG_BPF_JIT=y # [for Linux kernel versions 4.1 through 4.6] CONFIG_HAVE_BPF_JIT=y # [for Linux kernel versions 4.7 and later] CONFIG_HAVE_EBPF_JIT=y # [optional, for kprobes] CONFIG_BPF_EVENTS=y # Need kernel headers through /sys/kernel/kheaders.tar.xz CONFIG_IKHEADERS=y
There are a few optional kernel flags needed for running bcc networking examples on vanilla kernel:
CONFIG_NET_SCH_SFQ=m CONFIG_NET_ACT_POLICE=m CONFIG_NET_ACT_GACT=m CONFIG_DUMMY=m CONFIG_VXLAN=m
Kernel compile flags can usually be checked by looking at /proc/config.gz or /boot/config-<kernel-version>.
bcc and its tools are available in the standard Debian main repository, from the source package bpfcc under the names bpfcc-tools, python3-bpfcc, libbpfcc and libbpfcc-dev.
To install:
echo deb http://cloudfront.debian.net/debian sid main >> /etc/apt/sources.list sudo apt-get install -y bpfcc-tools libbpfcc libbpfcc-dev linux-headers-$(uname -r)
Versions of bcc are available in the standard Ubuntu Universe repository, as well in iovisor's PPA. The Ubuntu packages have slightly different names: where iovisor packages use bcc in the name (e.g. bcc-tools), Ubuntu packages use bpfcc (e.g. bpfcc-tools).
Currently, BCC packages for both the Ubuntu Universe, and the iovisor builds are outdated. This is a known and tracked in:
Ubuntu Packages Source packages and the binary packages produced from them can be found at packages.ubuntu.com.
sudo apt-get install bpfcc-tools linux-headers-$(uname -r)
The tools are installed in /sbin (/usr/sbin in Ubuntu 18.04) with a -bpfcc extension. Try running sudo opensnoop-bpfcc.
Note: the Ubuntu packages have different names but the package contents, in most cases, conflict and as such cannot be installed alongside upstream packages. Should one choose to use Ubuntu's packages instead of the upstream iovisor packages (or vice-versa), the conflicting packages will need to be removed.
The iovisor packages do declare they provide the Ubuntu packages and as such may be used to satisfy dependencies. For example, should one attempt to install package foo which declares a dependency on libbpfcc while the upstream libbcc package is installed, foo should install without trouble as libbcc declares that it provides libbpfcc. That said, one should always test such a configuration in case of version incompatibilities.
iovisor packages (Upstream Stable and Signed Packages)
sudo apt-key adv --keyserver keyserver.ubuntu.com --recv-keys 4052245BD4284CDD echo "deb https://repo.iovisor.org/apt/$(lsb_release -cs) $(lsb_release -cs) main" | sudo tee /etc/apt/sources.list.d/iovisor.list sudo apt-get update sudo apt-get install bcc-tools libbcc-examples linux-headers-$(uname -r)
(replace xenial with artful or bionic as appropriate). Tools will be installed under /usr/share/bcc/tools.
Upstream Nightly Packages
echo "deb [trusted=yes] https://repo.iovisor.org/apt/xenial xenial-nightly main" | sudo tee /etc/apt/sources.list.d/iovisor.list sudo apt-get update sudo apt-get install bcc-tools libbcc-examples linux-headers-$(uname -r)
(replace xenial with artful or bionic as appropriate)
As of Fedora 30, bcc binaries are available in the standard repository. You can install them via
sudo dnf install bcc
Note: if you keep getting Failed to load program: Operation not permitted when trying to run the hello_world.py example as root then you might need to lift the so-called kernel lockdown (cf. FAQ, background article).
Ensure that you are running a 4.2+ kernel with uname -r. If not, install a 4.2+ kernel from http://alt.fedoraproject.org/pub/alt/rawhide-kernel-nodebug, for example:
sudo dnf config-manager --add-repo=http://alt.fedoraproject.org/pub/alt/rawhide-kernel-nodebug/fedora-rawhide-kernel-nodebug.repo sudo dnf update # reboot
Nightly Packages
Nightly bcc binary packages for Fedora 25, 26, 27, and 28 are hosted at https://repo.iovisor.org/yum/nightly/f{25,26,27}.
To install:
echo -e '[iovisor]\nbaseurl=https://repo.iovisor.org/yum/nightly/f27/$basearch\nenabled=1\ngpgcheck=0' | sudo tee /etc/yum.repos.d/iovisor.repo sudo dnf install bcc-tools kernel-headers kernel-devel
Stable and Signed Packages
Stable bcc binary packages for Fedora 25, 26, 27, and 28 are hosted at https://repo.iovisor.org/yum/main/f{25,26,27}.
echo -e '[iovisor]\nbaseurl=https://repo.iovisor.org/yum/main/f27/$basearch\nenabled=1' | sudo tee /etc/yum.repos.d/iovisor.repo sudo dnf install bcc-tools kernel-devel-$(uname -r) kernel-headers-$(uname -r)
bcc is available in the standard Arch repos, so it can be installed with the pacman command:
# pacman -S bcc bcc-tools python-bcc
First of all, upgrade the kernel of your choice to a recent version. For example:
emerge sys-kernel/gentoo-sources
Then, configure the kernel enabling the features you need. Please consider the following as a starting point:
CONFIG_BPF=y CONFIG_BPF_SYSCALL=y CONFIG_NET_CLS_BPF=m CONFIG_NET_ACT_BPF=m CONFIG_BPF_JIT=y CONFIG_BPF_EVENTS=y
Finally, you can install bcc with:
emerge dev-util/bcc
The appropriate dependencies (e.g., clang, llvm with BPF backend) will be pulled automatically.
For openSUSE Leap 42.2 (and later) and Tumbleweed, bcc is already included in the official repo. Just install the packages with zypper.
sudo zypper ref sudo zypper in bcc-tools bcc-examples
For RHEL 7.6, bcc is already included in the official yum repository as bcc-tools. As part of the install, the following dependencies are installed: bcc.x86_64 0:0.6.1-2.el7 ,llvm-private.x86_64 0:6.0.1-2.el7 ,python-bcc.x86_64 0:0.6.1-2.el7,python-netaddr.noarch 0:0.7.5-9.el7
yum install bcc-tools
Use case 1. Install BCC for latest kernel available in repo: Tested on Amazon Linux AMI release 2018.03 (kernel 4.14.88-72.73.amzn1.x86_64)
sudo yum update kernel sudo yum install bcc sudo reboot
Use case 2. Install BCC for your AMI's default kernel (no reboot required): Tested on Amazon Linux AMI release 2018.03 (kernel 4.14.77-70.59.amzn1.x86_64)
sudo yum install kernel-headers-$(uname -r | cut -d'.' -f1-5) sudo yum install kernel-devel-$(uname -r | cut -d'.' -f1-5) sudo yum install bcc
Use case 1. Install BCC for your AMI's default kernel (no reboot required): Tested on Amazon Linux AMI release 2021.11 (kernel 5.10.75-79.358.amzn2.x86_64)
sudo amazon-linux-extras install BCC
As of Alpine 3.11, bcc binaries are available in the community repository:
sudo apk add bcc-tools bcc-doc
The tools are installed in /usr/share/bcc/tools.
Python Compatibility
The binary packages include bindings for Python 3 only. The Python-based tools assume that a python binary is available at /usr/bin/python, but that may not be true on recent versions of Alpine. If you encounter errors like <tool-name>: not found, you can try creating a symlink to the Python 3.x binary like so:
sudo ln -s $(which python3) /usr/bin/python
Containers
Alpine Linux is often used as a base system for containers. bcc can be used in such an environment by launching the container in privileged mode with kernel modules available through bind mounts:
sudo docker run --rm -it --privileged \ -v /lib/modules:/lib/modules:ro \ -v /sys:/sys:ro \ -v /usr/src:/usr/src:ro \ alpine:3.12
The compiling depends on the headers and lib of linux kernel module which was not found in wsl distribution packages repo. We have to compile the kernel module manually.
apt-get install flex bison libssl-dev libelf-dev dwarves
First, you will need to checkout the WSL2 Linux kernel git repository:
KERNEL_VERSION=$(uname -r | cut -d '-' -f 1) git clone --depth 1 https://github.com/microsoft/WSL2-Linux-Kernel.git -b linux-msft-wsl-$KERNEL_VERSION cd WSL2-Linux-Kernel
Then compile and install:
cp Microsoft/config-wsl .config make oldconfig && make prepare make scripts make modules sudo make modules_install
After install the module you will need to change the name of the directory to remove the ‘+’ at the end
mv /lib/modules/$KERNEL_VERSION-microsoft-standard-WSL2+/ /lib/modules/$KERNEL_VERSION-microsoft-standard-WSL2
Then you can install bcc tools package according your distribution.
If you met some problems, try to
sudo mount -t debugfs debugfs /sys/kernel/debug
Since release v0.10.0, bcc starts to leverage libbpf repo (https://github.com/libbpf/libbpf) to provide wrapper functions to the kernel for bpf syscalls, uapi headers bpf.h/btf.h etc. Unfortunately, the default github release source code does not contain libbpf submodule source code and this will cause build issues.
To alleviate this problem, starting at release v0.11.0, source code with corresponding libbpf submodule codes will be released as well. See https://github.com/iovisor/bcc/releases.
/etc/apt/sources.list should include the non-free repository and look something like this:
deb http://deb.debian.org/debian sid main contrib non-free deb-src http://deb.debian.org/debian sid main contrib non-free
# Before you begin apt-get update # According to https://packages.debian.org/source/sid/bpfcc, # BCC build dependencies: sudo apt-get install arping bison clang-format cmake dh-python \ dpkg-dev pkg-kde-tools ethtool flex inetutils-ping iperf \ libbpf-dev libclang-dev libclang-cpp-dev libedit-dev libelf-dev \ libfl-dev libzip-dev linux-libc-dev llvm-dev libluajit-5.1-dev \ luajit python3-netaddr python3-pyroute2 python3-setuptools python3
git clone https://github.com/iovisor/bcc.git mkdir bcc/build; cd bcc/build cmake .. make sudo make install
To build the toolchain from source, one needs:
# For Focal (20.04.1 LTS) sudo apt install -y zip bison build-essential cmake flex git libedit-dev \ libllvm12 llvm-12-dev libclang-12-dev python zlib1g-dev libelf-dev libfl-dev python3-setuptools \ liblzma-dev arping netperf iperf # For Hirsute (21.04) or Impish (21.10) sudo apt install -y zip bison build-essential cmake flex git libedit-dev \ libllvm12 llvm-12-dev libclang-12-dev python3 zlib1g-dev libelf-dev libfl-dev python3-setuptools \ liblzma-dev arping netperf iperf # For Jammy (22.04) sudo apt install -y zip bison build-essential cmake flex git libedit-dev \ libllvm14 llvm-14-dev libclang-14-dev python3 zlib1g-dev libelf-dev libfl-dev python3-setuptools \ liblzma-dev libdebuginfod-dev arping netperf iperf # For Lunar Lobster (23.04) sudo apt install -y zip bison build-essential cmake flex git libedit-dev \ libllvm15 llvm-15-dev libclang-15-dev python3 zlib1g-dev libelf-dev libfl-dev python3-setuptools \ liblzma-dev libdebuginfod-dev arping netperf iperf libpolly-15-dev # For Mantic Minotaur (23.10) sudo apt install -y zip bison build-essential cmake flex git libedit-dev \ libllvm16 llvm-16-dev libclang-16-dev python3 zlib1g-dev libelf-dev libfl-dev python3-setuptools \ liblzma-dev libdebuginfod-dev arping netperf iperf libpolly-16-dev # For other versions sudo apt-get -y install zip bison build-essential cmake flex git libedit-dev \ libllvm3.7 llvm-3.7-dev libclang-3.7-dev python zlib1g-dev libelf-dev python3-setuptools \ liblzma-dev arping netperf iperf # For Lua support sudo apt-get -y install luajit luajit-5.1-dev
git clone https://github.com/iovisor/bcc.git mkdir bcc/build; cd bcc/build cmake .. make sudo make install cmake -DPYTHON_CMD=python3 .. # build python3 binding pushd src/python/ make sudo make install popd
suppose you're running with root or add sudo first
dnf install -y bison cmake ethtool flex git iperf3 libstdc++-devel python3-netaddr python3-pip gcc gcc-c++ make zlib-devel elfutils-libelf-devel # dnf install -y luajit luajit-devel ## if use luajit, will report some lua function(which in lua5.3) undefined problem dnf install -y clang clang-devel llvm llvm-devel llvm-static ncurses-devel dnf -y install netperf pip3 install pyroute2 ln -s /usr/bin/python3 /usr/bin/python
git clone https://github.com/iovisor/bcc.git mkdir bcc-build cd bcc-build/ ## here llvm should always link shared library cmake ../bcc -DCMAKE_INSTALL_PREFIX=/usr -DENABLE_LLVM_SHARED=1 make -j10 make install
after install, you may add bcc directory to your $PATH, which you can add to ~/.bashrc
bcctools=/usr/share/bcc/tools bccexamples=/usr/share/bcc/examples export PATH=$bcctools:$bccexamples:$PATH
source ~/.bashrc
then run
hello_world.py
Or
cd /usr/share/bcc/examples ./hello_world.py ./tracing/bitehist.py cd /usr/share/bcc/tools ./bitesize
sudo dnf install -y bison cmake ethtool flex git iperf libstdc++-static \ python-netaddr python-pip gcc gcc-c++ make zlib-devel \ elfutils-libelf-devel python-cachetools sudo dnf install -y luajit luajit-devel # for Lua support sudo dnf install -y \ http://repo.iovisor.org/yum/extra/mageia/cauldron/x86_64/netperf-2.7.0-1.mga6.x86_64.rpm sudo pip install pyroute2
# FC22 wget http://llvm.org/releases/3.7.1/clang+llvm-3.7.1-x86_64-fedora22.tar.xz sudo tar xf clang+llvm-3.7.1-x86_64-fedora22.tar.xz -C /usr/local --strip 1 # FC23 wget http://llvm.org/releases/3.9.0/clang+llvm-3.9.0-x86_64-fedora23.tar.xz sudo tar xf clang+llvm-3.9.0-x86_64-fedora23.tar.xz -C /usr/local --strip 1 # FC24 and FC25 sudo dnf install -y clang clang-devel llvm llvm-devel llvm-static ncurses-devel
git clone https://github.com/iovisor/bcc.git mkdir bcc/build; cd bcc/build cmake .. make sudo make install
sudo zypper in bison cmake flex gcc gcc-c++ git libelf-devel libstdc++-devel \ llvm-devel clang-devel pkg-config python-devel python-setuptools python3-devel \ python3-setuptools sudo zypper in luajit-devel # for lua support in openSUSE Leap 42.2 or later sudo zypper in lua51-luajit-devel # for lua support in openSUSE Tumbleweed
git clone https://github.com/iovisor/bcc.git
mkdir bcc/build; cd bcc/build
cmake -DLUAJIT_INCLUDE_DIR=`pkg-config --variable=includedir luajit` \ # for lua support
..
make
sudo make install
cmake -DPYTHON_CMD=python3 .. # build python3 binding
pushd src/python/
make
sudo make install
popd
For Centos 7.6 only
sudo yum install -y epel-release sudo yum update -y sudo yum groupinstall -y "Development tools" sudo yum install -y elfutils-libelf-devel cmake3 git bison flex ncurses-devel sudo yum install -y luajit luajit-devel # for Lua support
You could compile LLVM from source code
curl -LO https://github.com/llvm/llvm-project/releases/download/llvmorg-10.0.1/llvm-10.0.1.src.tar.xz curl -LO https://github.com/llvm/llvm-project/releases/download/llvmorg-10.0.1/clang-10.0.1.src.tar.xz tar -xf clang-10.0.1.src.tar.xz tar -xf llvm-10.0.1.src.tar.xz mkdir clang-build mkdir llvm-build cd llvm-build cmake3 -G "Unix Makefiles" -DLLVM_TARGETS_TO_BUILD="BPF;X86" \ -DCMAKE_BUILD_TYPE=Release ../llvm-10.0.1.src make sudo make install cd ../clang-build cmake3 -G "Unix Makefiles" -DLLVM_TARGETS_TO_BUILD="BPF;X86" \ -DCMAKE_BUILD_TYPE=Release ../clang-10.0.1.src make sudo make install cd ..
or install from centos-release-scl
yum install -y centos-release-scl yum-config-manager --enable rhel-server-rhscl-7-rpms yum install -y devtoolset-7 llvm-toolset-10 llvm-toolset-10-llvm-devel llvm-toolset-10-llvm-static llvm-toolset-10-clang-devel source scl_source enable devtoolset-7 llvm-toolset-10
For permanently enable scl environment, please check https://access.redhat.com/solutions/527703.
git clone https://github.com/iovisor/bcc.git mkdir bcc/build; cd bcc/build cmake3 .. make sudo make install
Tested on Amazon Linux AMI release 2018.03 (kernel 4.14.47-56.37.amzn1.x86_64)
# enable epel to get iperf, luajit, luajit-devel, cmake3 (cmake3 is required to support c++11) sudo yum-config-manager --enable epel sudo yum install -y bison cmake3 ethtool flex git iperf libstdc++-static python-netaddr python-cachetools gcc gcc-c++ make zlib-devel elfutils-libelf-devel sudo yum install -y luajit luajit-devel sudo yum install -y http://repo.iovisor.org/yum/extra/mageia/cauldron/x86_64/netperf-2.7.0-1.mga6.x86_64.rpm sudo pip install pyroute2 sudo yum install -y ncurses-devel
wget http://releases.llvm.org/3.7.1/clang+llvm-3.7.1-x86_64-fedora22.tar.xz tar xf clang* (cd clang* && sudo cp -R * /usr/local/)
git clone https://github.com/iovisor/bcc.git pushd . mkdir bcc/build; cd bcc/build cmake3 .. time make sudo make install popd
sudo yum -y install kernel-devel-$(uname -r) sudo mount -t debugfs debugfs /sys/kernel/debug
sudo /usr/share/bcc/tools/execsnoop
# enable epel to get iperf, luajit, luajit-devel, cmake3 (cmake3 is required to support c++11) sudo yum-config-manager --enable epel sudo yum install -y bison cmake3 ethtool flex git iperf libstdc++-static python-netaddr python-cachetools gcc gcc-c++ make zlib-devel elfutils-libelf-devel sudo yum install -y luajit luajit-devel sudo yum install -y http://repo.iovisor.org/yum/extra/mageia/cauldron/x86_64/netperf-2.7.0-1.mga6.x86_64.rpm sudo pip install pyroute2 sudo yum install -y ncurses-devel
yum install -y clang llvm llvm-devel llvm-static clang-devel clang-libs
git clone https://github.com/iovisor/bcc.git pushd . mkdir bcc/build; cd bcc/build cmake3 .. time make sudo make install popd
sudo yum -y install kernel-devel-$(uname -r) sudo mount -t debugfs debugfs /sys/kernel/debug
sudo /usr/share/bcc/tools/execsnoop
sudo apk add tar git build-base iperf linux-headers llvm10-dev llvm10-static \ clang-dev clang-static cmake python3 flex-dev bison luajit-dev elfutils-dev \ zlib-dev
git clone https://github.com/iovisor/bcc.git mkdir bcc/build; cd bcc/build # python2 can be substituted here, depending on your environment cmake -DPYTHON_CMD=python3 .. make && sudo make install # Optional, but needed if you don't have /usr/bin/python on your system ln -s $(which python3) /usr/bin/python
sudo /usr/share/bcc/tools/execsnoop
pacman -S cmake clang llvm flex bison python
git clone https://github.com/iovisor/bcc.git pushd . mkdir bcc/build cd bcc/build cmake -DENABLE_LLVM_SHARED=on .. -DPYTHON_CMD=python3 # for python3 support make -j$(nproc) sudo make install cd src/python make -j$(nproc) sudo make install popd
git clone https://github.com/llvm/llvm-project.git mkdir -p llvm-project/llvm/build/install cd llvm-project/llvm/build cmake -G "Ninja" -DLLVM_TARGETS_TO_BUILD="BPF;X86" \ -DLLVM_ENABLE_PROJECTS="clang" \ -DCMAKE_BUILD_TYPE=Release -DCMAKE_INSTALL_PREFIX=$PWD/install .. ninja && ninja install export PATH=$PWD/install/bin:$PATH