| commit | 406e44b96ec8a78c3705dbe26ec1eb5cba8f025b | [log] [tgz] |
|---|---|---|
| author | Akilesh Kailash <akailash@google.com> | Thu Aug 17 17:28:31 2023 -0700 |
| committer | Akilesh Kailash <akailash@google.com> | Thu Aug 17 23:36:35 2023 -0700 |
| tree | a6c908319de66d73c14fc890e1894e9ff27010be | |
| parent | 7fbdcd6896e5467d222644b005ced5efd2a756b8 [diff] |
libbpf-tools: Build bio tools for debugging
$:/data/bcc # ./biolatency -Q
disk = sda flags = Background-NoMerge-Write
usecs : count distribution
0 -> 1 : 0 | |
2 -> 3 : 0 | |
4 -> 7 : 0 | |
8 -> 15 : 0 | |
16 -> 31 : 0 | |
32 -> 63 : 0 | |
64 -> 127 : 0 | |
128 -> 255 : 0 | |
256 -> 511 : 19 |**** |
512 -> 1023 : 6 |* |
1024 -> 2047 : 38 |********* |
2048 -> 4095 : 51 |************ |
4096 -> 8191 : 65 |*************** |
8192 -> 16383 : 28 |****** |
16384 -> 32767 : 31 |******* |
32768 -> 65535 : 168 |****************************************|
65536 -> 131071 : 55 |************* |
$:/data/bcc # ./biosnoop
TIME(s) COMM PID DISK T SECTOR BYTES LAT(ms)
0.000000 kworker 26615 sda R 13168680 4096 0.297
0.000362 sh 26531 sda RA 9433568 4096 0.628
0.000693 sh 26531 sda RA 9433464 20480 1.136
0.000936 sh 26531 sda RA 9433608 12288 1.159
$:/data/bcc # ./biostack 5
dd 26696 sda
blk_account_io_start
submit_bio_noacct
submit_bio
submit_bh_wbc
ext4_read_bh_nowait
ext4_read_bh_lock
ext4_bread_batch
__ext4_find_entry
ext4_lookup
__lookup_slow
lookup_slow
walk_component
link_path_walk
path_openat
do_filp_open
do_sys_openat2
__arm64_sys_openat
el0_svc_common
el0_svc
el0_sync_handler
usecs : count distribution
0 -> 1 : 0 | |
2 -> 3 : 0 | |
4 -> 7 : 0 | |
8 -> 15 : 0 | |
16 -> 31 : 0 | |
32 -> 63 : 0 | |
64 -> 127 : 0 | |
128 -> 255 : 0 | |
256 -> 511 : 0 | |
512 -> 1023 : 0 | |
1024 -> 2047 : 0 | |
2048 -> 4095 : 1 |****************************************|
Test: On Pixel running 5.10 kernel
Bug: 296512575
Change-Id: Id57e9483b2d2d6b612aa39a00a26602fdb844fad
Signed-off-by: Akilesh Kailash <akailash@google.com>
BCC is a toolkit for creating efficient kernel tracing and manipulation programs, and includes several useful tools and examples. It makes use of extended BPF (Berkeley Packet Filters), formally known as eBPF, a new feature that was first added to Linux 3.15. Much of what BCC uses requires Linux 4.1 and above.
eBPF was described by Ingo Molnár as:
One of the more interesting features in this cycle is the ability to attach eBPF programs (user-defined, sandboxed bytecode executed by the kernel) to kprobes. This allows user-defined instrumentation on a live kernel image that can never crash, hang or interfere with the kernel negatively.
BCC makes BPF programs easier to write, with kernel instrumentation in C (and includes a C wrapper around LLVM), and front-ends in Python and lua. It is suited for many tasks, including performance analysis and network traffic control.
This example traces a disk I/O kernel function, and populates an in-kernel power-of-2 histogram of the I/O size. For efficiency, only the histogram summary is returned to user-level.
# ./bitehist.py Tracing... Hit Ctrl-C to end. ^C kbytes : count distribution 0 -> 1 : 3 | | 2 -> 3 : 0 | | 4 -> 7 : 211 |********** | 8 -> 15 : 0 | | 16 -> 31 : 0 | | 32 -> 63 : 0 | | 64 -> 127 : 1 | | 128 -> 255 : 800 |**************************************|
The above output shows a bimodal distribution, where the largest mode of 800 I/O was between 128 and 255 Kbytes in size.
See the source: bitehist.py. What this traces, what this stores, and how the data is presented, can be entirely customized. This shows only some of many possible capabilities.
See INSTALL.md for installation steps on your platform.
See FAQ.txt for the most common troubleshoot questions.
See docs/reference_guide.md for the reference guide to the bcc and bcc/BPF APIs.
Some of these are single files that contain both C and Python, others have a pair of .c and .py files, and some are directories of files.
Examples:
Tools that help to introspect BPF programs.
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.
Furthermore, current integrations with BPF have a kludgy workflow, sometimes involving compiling directly in a linux kernel source tree. This toolchain aims to minimize the time that a developer spends getting BPF compiled, and instead focus on the applications that can be written and the problems that can be solved with BPF.
The features of this toolkit include:
In the future, more bindings besides python will likely be supported. Feel free to add support for the language of your choice and send a pull request!
At Red Hat Summit 2015, BCC was presented as part of a session on BPF. A multi-host vxlan environment is simulated and a BPF program used to monitor one of the physical interfaces. The BPF program keeps statistics on the inner and outer IP addresses traversing the interface, and the userspace component turns those statistics into a graph showing the traffic distribution at multiple granularities. See the code here.
Already pumped up to commit some code? Here are some resources to join the discussions in the IOVisor community and see what you want to work on.
Looking for more information on BCC and how it's being used? You can find links to other BCC content on the web in LINKS.md.