libbpf-rs-starter-template

Welcome to the libbpf-rs-starter-template! This project template is designed to help you quickly start developing eBPF projects using libbpf-rs in rust and go. The template provides a solid starting point with a Makefile, Dockerfile, and GitHub action, along with all necessary dependencies to simplify your development process.

Also, this is a minimal libbpf-rs project, you can read the code to understand how to write ebpf programs using libbpf-rs.

借助于 GitHub 模板和 Github Codespace，可以轻松构建 eBPF 项目和开发环境，一键在线编译运行 eBPF 程序。关于中文的文档和详细的 eBPF 开发教程，可以参考：https://github.com/eunomia-bpf/bpf-developer-tutorial

There are other templates for other languages:

https://github.com/eunomia-bpf/libbpf-starter-template: eBPF project template based on the C language and the libbpf framework.
https://github.com/eunomia-bpf/cilium-ebpf-starter-template: eBPF project template based on the Go language and the cilium/ebpf framework.
https://github.com/eunomia-bpf/libbpf-rs-starter-template: eBPF project template based on the Rust language and the libbpf-rs framework.
https://github.com/eunomia-bpf/eunomia-template: eBPF project template based on the C language and the eunomia-bpf framework.

Getting Started

To get started, simply click the "Use this template" button on the GitHub repository page. This will create a new repository in your account with the same files and structure as this template.

Use docker

Run the following code to run the eBPF code from the cloud to your local machine in one line:

$ sudo docker run --rm -it --privileged ghcr.io/eunomia-bpf/libbpf-rs-template:latest
[sudo] password for xxx: 
Tracing run queue latency higher than 10000 us
TIME     COMM             TID     LAT(us)       
12:09:19 systemd-udevd    30786   18300         
12:09:19 systemd-udevd    30796   21941         
12:09:19 systemd-udevd    30793   10323         
12:09:19 systemd-udevd    30795   14827         
12:09:19 systemd-udevd    30790   17973         
12:09:19 systemd-udevd    30793   12328         
12:09:19 systemd-udevd    30796   28721

Use Nix

Using direnv and nix, you can quickly access a dev shell with a complete development environment.

With direnv, you can automatically load the required dependencies when you enter the directory. This way you don't have to worry about installing dependencies to break your other project development environment.

See how to install direnv and Nix:

direnv: https://github.com/direnv/direnv/blob/master/docs/installation.md
Nix: run

sh <(curl -L https://nixos.org/nix/install) --daemon

Build and run runqslower with nix:

# run runqslower
nix run .#
# build runqslower
nix build .#

If you want use nix flake without direnv, simply run:

nix develop
# Of course, the previous command can also be used
nix run .#
nix build .#

Features

This starter template includes the following features:

A Makefile that allows you to build the project in one command
A Dockerfile to create a containerized environment for your project
GitHub actions to automate your build and publish process
All necessary dependencies for Go development with ebpf

How to use

1. Create a new repository using this template

Click the "Use this template" button on the GitHub repository page to create a new repository based on this template.

If you don't want to see generate from in your repository, relax, just clone and rerun git init.

2. Clone your new repository

Clone your newly created repository to your local machine:

git clone https://github.com/your_username/your_new_repository.git

3. Install dependencies

For dependencies, it varies from distribution to distribution. You can refer to dockerfile for installation.

On Ubuntu, you may run make install or

sudo apt update
sudo apt-get install -y --no-install-recommends \
        libelf1 libelf-dev zlib1g-dev \
        make clang llvm

to install dependencies.

Use wget -nv -O - https://sh.rustup.rs | sh -s -- -y to install rust toolchain.

4. Build the project

To build the project, run the following command:

make build

This will compile your code and create the necessary binaries.

5. Run the project

the following command will run the sample ebpf application.

./target/release/runqslower
# or use cargo directly
cargo run

7. GitHub Actions

This template includes two GitHub actions:

When you push to the repository, it automatically builds and publishes your project and publishes the docker image.

To customize this action, edit the .github/workflows/publish.yml and .github/workflows/docker.yml file.

Contributing

We welcome contributions to improve this template! If you have any ideas or suggestions, feel free to create an issue or submit a pull request.

License

This project is licensed under the MIT License. See the LICENSE file for more information.

eunomia-bpf/libbpf-rs-starter-template