commit | 1f1d98b2683bbce07de54d7f7e717575ff04749c | [log] [tgz] |
---|---|---|
author | Marco Leogrande <dark.knight.ita@gmail.com> | Thu Jun 11 14:26:30 2015 -0700 |
committer | Marco Leogrande <dark.knight.ita@gmail.com> | Thu Jun 11 14:26:30 2015 -0700 |
tree | 8c1c82ce71f8fa09f0aa8b79cc13d8d42db688c4 | |
parent | 2e657fe83d3c493649a9ebaf09d766b695aa9a66 [diff] |
Update README with kernel headers information Include kernel headers >=4.1 as a prerequisite.
This directory contains source code for BCC, a toolkit for creating small programs that can be dynamically loaded into a Linux kernel.
The compiler relies upon eBPF (Extended Berkeley Packet Filters), which is a feature in Linux kernels starting from 3.19. Currently, this compiler leverages features which are mostly available in Linux 4.1 and above.
BPF guarantees that the programs loaded into the kernel cannot crash, and cannot run forever, but yet BPF is general purpose enough to perform many arbitrary types of computation. Currently, it is possible to write a program in C that will compile into a valid BPF program, yet it is vastly easier to write a C program that will compile into invalid BPF (C is like that). The user won't know until trying to run the program whether it was valid or not.
With a BPF-specific frontend, one should be able to write in a language and receive feedback from the compiler on the validity as it pertains to a BPF backend. This toolkit aims to provide a frontend that can only create valid BPF programs while still harnessing its full flexibility.
The features of this toolkit include:
To get started using this toolchain, one needs:
CONFIG_BPF=y
CONFIG_BPF_SYSCALL=y
CONFIG_NET_CLS_BPF=m
[optional, for tc filters]CONFIG_NET_ACT_BPF=m
[optional, for tc actions]CONFIG_BPF_JIT=y
CONFIG_HAVE_BPF_JIT=y
CONFIG_BPF_EVENTS=y
[optional, for kprobes]See https://github.com/iovisor/bcc/scripts/README.md for a script that can be used to set up a libvirt VM with the required dependencies.
If the LLVM and Linux kernel requirements are satisfied, testing out this package should be as simple as:
git clone https://github.com/iovisor/bcc.git cd bcc; mkdir build; cd build cmake .. -DCMAKE_INSTALL_PREFIX=/usr -DCMAKE_PREFIX_PATH=/opt/local/llvm make -j$(grep -c ^processor /proc/cpuinfo) sudo make install cd ../../ sudo python examples/hello_world.py <ctrl-C>
Change CMAKE_PREFIX_PATH
if llvm is installed elsewhere.
Since packaging is currently not available, one can cleanup the collateral of bcc by doing:
sudo rm -rf /usr/{lib/libbpf.prog.so,include/bcc,share/bcc} sudo pip uninstall bpf
See http://llvm.org/docs/GettingStarted.html for the full guide.
The short version:
git clone https://github.com/llvm-mirror/llvm.git llvm git clone https://github.com/llvm-mirror/clang.git llvm/tools/clang mkdir llvm/build/ cd llvm/build/ cmake .. -DCMAKE_INSTALL_PREFIX=/opt/local/llvm make -j$(grep -c ^processor /proc/cpuinfo) sudo make install