Skip to content

bytedance/netatop-bpf

Repository files navigation

netatop-bpf

Introduction

The Linux kernel does not maintain counters for the number of network accesses issued per process. As a consequence, it is not possible to analyze which process causes most load in case that atop shows a high utilization on one of your network interfaces.(For performance reasons, threads are not counted.)

The optional netatop-bpf can be loaded to gather statistics about the TCP and UDP packets that have been transmitted/received per process. As soon as atop discovers that netatop-bpf is active, it shows the columns SNET and RNET in the generic screen for the number of transmitted and received packets per process. When the 'n' key is pressed, it shows detailed counters about the number packets transmitted/received via TCP and UDP, the average sizes of these packets, and the total bandwidth consumed for input and output per process/thread.

The bpf program hooks the transport layer of the network Protocol Stack to count information in the map when sending and receiving data packets. The hook function is the tracepoint merged in kernel 6.3. When a network event occurs and it is TCP/UDP protocol, it will reach the function processing of the transport layer, and the function registered on the hook point will be triggered. The main function is to maintain statistics on the network traffic of per process in the map.

  • Kernel (>= 6.3) merged tracepoint:
    • tracepoint/sock/sock_sendmsg_length
    • tracepoint/sock/sock_recvmsg_length

Netatop runs normally and it has two functions. One is responsible for loading the bpf program to the kernel and communicating with the bpf program through the bpf map; the other is to communicate with atop through the Unix Domain Socket.

Atop send to netatop every interval(default 10s), netatop recv from atop and then traverses the bpf map sending all process information to atop, atop uses the hash table to store the information of all processes, and then traverses the /proc file (exits the process) to obtain the pid of the process and find the hashmap.

Building

netatop supports kernel version >= 6.3

Install Dependencies

You will need clang (at least v11 or later), libelf and zlib to build the examples, package names may vary across distros.

On Debian/Ubuntu, you need:

$ apt install clang libelf1 libelf-dev zlib1g-dev

Getting the source code

Download the git repository and check out submodules:

git clone --recurse-submodules git@code.byted.org:bytelinux/netatop-bpf.git
git clone git@code.byted.org:bytelinux/atop.git -b netatop-bpf

C Examples Makefile build:

$ cd netatop-bpf
$ git submodule update --init --recursive       # check out libbpf
$ make
$ make install
$ cd atop
$ make
$ make install
$ atop -n

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages