Initial commit

Author: yunwei37

.devcontainer/devcontainer.json

@@ -0,0 +1,6 @@
+{
+	"build": {
+		"context": "..",
+		"dockerfile": "../dev.dockerfile"
+	}
+}

.envrc

@@ -0,0 +1 @@
+use flake

.github/workflows/docker.yml

@@ -0,0 +1,53 @@
+name: Build and public docker image
+
+on:
+  push:
+    branches: "master"
+
+jobs:
+  build-and-push-image:
+    runs-on: ubuntu-latest
+    # run only when code is compiling and tests are passing
+    if: "!contains(github.event.head_commit.message, '[skip ci]') && !contains(github.event.head_commit.message, '[ci skip]')"
+    # steps to perform in job
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v3
+        with:
+          submodules: 'recursive'
+
+      - name: install deps
+        run: |
+          sudo apt-get install -y --no-install-recommends \
+          libelf1 libelf-dev zlib1g-dev libclang-dev \
+          make git clang llvm pkg-config build-essential
+
+      - name: build package
+        run:  make build
+
+      # setup Docker buld action
+      - name: Set up Docker Buildx
+        id: buildx
+        uses: docker/setup-buildx-action@v2
+
+      - name: Login to Github Packages
+        uses: docker/login-action@v2
+        with:
+          registry: ghcr.io
+          username: ${{ github.repository_owner }}
+          password: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: Build image and push to GitHub Container Registry
+        uses: docker/build-push-action@v2
+        with:
+          # relative path to the place where source code with Dockerfile is located
+          context: ./
+          file: dockerfile
+          platforms: linux/amd64
+          # Note: tags has to be all lower-case
+          tags: |
+            ghcr.io/${{ github.repository }}
+          push: true
+
+      - name: Image digest
+        run: echo ${{ steps.docker_build.outputs.digest }}

.github/workflows/publish.yml

@@ -0,0 +1,71 @@
+name: Build and publish
+
+on:
+  push:
+    branches: "master"
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    if: "!contains(github.event.head_commit.message, '[skip ci]') && !contains(github.event.head_commit.message, '[ci skip]')"
+    strategy:
+      matrix:
+        target: [ x86_64-unknown-linux-gnu ]
+
+    steps:
+    - uses: actions/checkout@v3
+      with:
+        submodules: 'recursive'
+
+    - name: Set latest release version
+      if:   github.event_name == 'push' && github.ref == 'refs/heads/master'
+      id: set_version
+      uses: actions/github-script@v6
+      with:
+        result-encoding: string
+        script: |
+          const { data: releases } = await github.rest.repos.listReleases({
+            owner: context.repo.owner,
+            repo: context.repo.repo,
+          });
+          
+          const { data: tags } = await github.rest.repos.listTags({
+            owner: context.repo.owner,
+            repo: context.repo.repo
+          });
+          
+          if (releases.length === 0) { return "v0.0.1"; }
+         
+          function increase_v(version) {
+            const parts = version.split(".");
+            const last = parseInt(parts[2]) + 1;
+            const next_version = `${parts[0]}.${parts[1]}.${last.toString()}`;
+            return next_version;
+          }
+          
+          const latest_release_tag = releases[0].tag_name;
+          
+          const tag = tags.find(tag => tag.commit.sha === context.sha);
+          
+          return tag ? tag.name : increase_v(latest_release_tag)
+
+    - name: install deps
+      run: |
+        sudo apt-get install -y --no-install-recommends \
+        libelf1 libelf-dev zlib1g-dev libclang-dev \
+        make git clang llvm pkg-config build-essential
+
+    - name: build package
+      run:  make build
+
+    - name: Publish
+      if:   github.event_name == 'push' && github.ref == 'refs/heads/master'
+      uses: softprops/action-gh-release@v1
+      with:
+          files: |
+            src/bootstrap
+          prerelease: false
+          tag_name: ${{ steps.set_version.outputs.result }}
+          generate_release_notes: true
+      env:
+        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

.gitignore

@@ -0,0 +1,2 @@
+.direnv
+/build

.gitmodules

@@ -0,0 +1,6 @@
+[submodule "libbpf"]
+	path = libbpf
+	url = https://github.com/libbpf/libbpf.git
+[submodule "bpftool"]
+	path = bpftool
+	url = https://github.com/libbpf/bpftool.git

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022 eunomia-bpf org.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

Makefile

@@ -0,0 +1,11 @@
+build:
+	make -C src
+
+clean:
+	make -C src clean
+
+install:
+	sudo apt update
+	sudo apt-get install -y --no-install-recommends \
+        libelf1 libelf-dev zlib1g-dev \
+        make clang llvm

README.md

@@ -0,0 +1,147 @@
+# **libbpf-starter-template**
+
+![License: MIT](https://img.shields.io/badge/License-MIT-green.svg)
+[![Build and publish](https://github.com/eunomia-bpf/libbpf-starter-template/actions/workflows/publish.yml/badge.svg)](https://github.com/eunomia-bpf/libbpf-starter-template/actions/workflows/publish.yml)
+![GitHub stars](https://img.shields.io/github/stars/eunomia-bpf/libbpf-starter-template?style=social)
+
+Welcome to the **`libbpf-starter-template`**! This project template is designed to help you quickly start
+developing eBPF projects using libbpf in C. The template provides a solid starting point with a Makefile, 
+Dockerfile, and GitHub action, along with all necessary dependencies to simplify your development process.
+
+借助于 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:
+
+```console
+$ sudo docker run --rm -it --privileged ghcr.io/eunomia-bpf/libbpf-template:latest
+TIME     EVENT COMM             PID     PPID    FILENAME/EXIT CODE
+09:25:14 EXEC  sh               28142   1788    /bin/sh
+09:25:14 EXEC  playerctl        28142   1788    /nix/store/vf3rsb7j3p7zzyjpb0a3axl8yq4z1sq5-playerctl-2.4.1/bin/playerctl
+09:25:14 EXIT  playerctl        28142   1788    [1] (6ms)
+09:25:15 EXEC  sh               28145   1788    /bin/sh
+09:25:15 EXEC  playerctl        28145   1788    /nix/store/vf3rsb7j3p7zzyjpb0a3axl8yq4z1sq5-playerctl-2.4.1/bin/playerctl
+09:25:15 EXIT  playerctl        28145   1788    [1] (6ms)
+```
+
+### Use Nix
+
+Using [direnv](https://github.com/direnv/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
+```
+
+Then use the following command to enable direnv support in this directory.
+
+```sh
+direnv allow
+```
+
+If you want use nix flake without direnv, simply run:
+
+```sh
+nix develop
+```
+
+## **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
+- A **`flake.nix`** to enter a dev shell with needed dependencies
+- A GitHub action to automate your build and publish process
+  and docker image
+- All necessary dependencies for C development with libbpf
+
+## **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.
+
+### **2. Clone your new repository**
+
+Clone your newly created repository to your local machine:
+
+```sh
+git clone https://github.com/your_username/your_new_repository.git --recursive
+```
+
+Or after clone the repo, you can update the git submodule with following commands:
+
+```sh
+git submodule update --init --recursive
+```
+
+### **3. Install dependencies**
+
+For dependencies, it varies from distribution to distribution. You can refer to shell.nix and dockerfile for installation.
+
+On Ubuntu, you may run `make install` or
+
+```sh
+sudo apt-get install -y --no-install-recommends \
+        libelf1 libelf-dev zlib1g-dev \
+        make clang llvm
+```
+
+to install dependencies.
+
+### **4. Build the project**
+
+To build the project, run the following command:
+
+```sh
+make build
+```
+
+This will compile your code and create the necessary binaries. You can you the `Github Code space` or `Github Action` to build the project as well.
+
+### ***Run the Project***
+
+You can run the binary with:
+
+```console
+sudo src/bootstrap
+```
+
+Or with Github Packages locally:
+
+```console
+docker run --rm -it --privileged -v $(pwd):/examples ghcr.io/eunomia-bpf/libbpf-template:latest
+```
+
+### **7. GitHub Actions**
+
+This template also includes a GitHub action that will automatically build and publish your project when you push to the repository.
+To customize this action, edit the **`.github/workflows/publish.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](LICENSE)** file for more information.