feat: go-ebpf, including tests

.github/workflows/test.yaml

@@ -15,6 +15,7 @@ jobs:
       matrix:
         features:
           - docsify
+          - go-ebpf
           - go-mod-upgrade
           - gocover
           - goreportcard

.vscode/c_cpp_properties.json

@@ -0,0 +1,16 @@
+{
+    "configurations": [
+        {
+            "name": "Linux",
+            "includePath": [
+                "${workspaceFolder}/test/go-ebpf/headers"
+            ],
+            "defines": [],
+            "compilerPath": "/usr/bin/clang-19",
+            "cStandard": "c17",
+            "cppStandard": "c++17",
+            "intelliSenseMode": "linux-clang-x64"
+        }
+    ],
+    "version": 4
+}

src/go-ebpf/NOTES.md

@@ -0,0 +1,28 @@
+## PID Namespace
+
+Depending on what your eBPF is doing inside the devcontainer (or inside a
+container inside your devcontainer), consider deploying your devcontainer in the
+root PID namespace, as follows:
+
+```json
+"runArgs": [
+    "--pid=host"
+]
+```
+
+Otherwise, your eBPF programs see root PID namespace PIDs and TIDs, but your
+user space code sees child PID namespace PIDs and TIDs, ensuring an endless
+supply of surprise.
+
+## OS Support
+
+Tested with:
+- [ghcr.io/almalinux/almalinux](https://ghcr.io/almalinux/almalinux),
+- [mcr.microsoft.com/devcontainers/base:debian](https://mcr.microsoft.com/en-us/artifact/mar/devcontainers/base/about#about:_debian),
+- [fedora](https://hub.docker.com/_/fedora),
+- [mcr.microsoft.com/devcontainers/base:ubuntu](https://mcr.microsoft.com/en-us/artifact/mar/devcontainers/base/about#about:_ubuntu).
+
+## Acknowledgement
+
+[@cilium](https://github.com/cilium) for their incredibly useful
+[ebpf](https://github.com/cilium/ebpf) Go module.

src/go-ebpf/README.md

@@ -0,0 +1,58 @@
+
+# Go ebpf development (go-ebpf)
+
+Installs clang and llvm, and on top Cilium's bpf2go.
+
+## Example Usage
+
+```json
+"features": {
+    "ghcr.io/thediveo/devcontainer-features/go-ebpf:0": {}
+}
+```
+
+## Options
+
+| Options Id | Description | Type | Default Value |
+|-----|-----|-----|-----|
+| bfp2go-version | version of bpf2go to install | string | latest |
+
+## Customizations
+
+### VS Code Extensions
+
+- `ms-vscode.cpptools-extension-pack`
+
+## PID Namespace
+
+Depending on what your eBPF is doing inside the devcontainer (or inside a
+container inside your devcontainer), consider deploying your devcontainer in the
+root PID namespace, as follows:
+
+```json
+"runArgs": [
+    "--pid=host"
+]
+```
+
+Otherwise, your eBPF programs see root PID namespace PIDs and TIDs, but your
+user space code sees child PID namespace PIDs and TIDs, ensuring an endless
+supply of surprise.
+
+## OS Support
+
+Tested with:
+- [ghcr.io/almalinux/almalinux](https://ghcr.io/almalinux/almalinux),
+- [mcr.microsoft.com/devcontainers/base:debian](https://mcr.microsoft.com/en-us/artifact/mar/devcontainers/base/about#about:_debian),
+- [fedora](https://hub.docker.com/_/fedora),
+- [mcr.microsoft.com/devcontainers/base:ubuntu](https://mcr.microsoft.com/en-us/artifact/mar/devcontainers/base/about#about:_ubuntu).
+
+## Acknowledgement
+
+[@cilium](https://github.com/cilium) for their incredibly useful
+[ebpf](https://github.com/cilium/ebpf) Go module.
+
+
+---
+
+_Note: This file was auto-generated from the [devcontainer-feature.json](https://github.com/thediveo/devcontainer-features/blob/main/src/go-ebpf/devcontainer-feature.json).  Add additional notes to a `NOTES.md`._

src/go-ebpf/devcontainer-feature.json

@@ -0,0 +1,26 @@
+{
+    "name": "Go ebpf development",
+    "id": "go-ebpf",
+    "version": "0.0.1",
+    "description": "Installs clang and llvm, and on top Cilium's bpf2go.",
+    "options": {
+        "bfp2go-version": {
+            "type": "string",
+            "default": "latest",
+            "description": "version of bpf2go to install"
+        }
+    },
+    "dependsOn": {
+        "ghcr.io/devcontainers/features/go:1": {
+            "version": "latest",
+            "golangciLintVersion": "latest"
+        }
+    },
+    "customizations": {
+        "vscode": {
+            "extensions": [
+                "ms-vscode.cpptools-extension-pack"
+            ]
+        }
+    }
+}

src/go-ebpf/install.sh

@@ -0,0 +1,134 @@
+#!/usr/bin/env bash
+
+# Distribution and package manager detection are licensed by Microsoft
+# Corporation under the MIT License, please refer to:
+# https://github.com/devcontainers/features/blob/main/src/go/install.sh:
+#
+# Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the
+# MIT License. See https://go.microsoft.com/fwlink/?linkid=2090316 for license
+# information
+
+set -e
+
+BPF2GO_VERSION="${BPF2GO_VERSION:-"latest"}"
+
+echo "installing feature go-ebpf..."
+
+if [ "$(id -u)" -ne 0 ]; then
+    echo -e 'Script must be run as root. Use sudo, su, or add "USER root" to your Dockerfile before running this script.'
+    exit 1
+fi
+
+# Bring in ID, ID_LIKE, VERSION_ID, VERSION_CODENAME
+. /etc/os-release
+# Get an adjusted ID independent of distro variants
+MAJOR_VERSION_ID=$(echo ${VERSION_ID} | cut -d . -f 1)
+if [ "${ID}" = "debian" ] || [ "${ID_LIKE}" = "debian" ]; then
+    ADJUSTED_ID="debian"
+elif [[ "${ID}" = "rhel" || "${ID}" = "fedora" || "${ID}" = "mariner" || "${ID_LIKE}" = *"rhel"* || "${ID_LIKE}" = *"fedora"* || "${ID_LIKE}" = *"mariner"* ]]; then
+    ADJUSTED_ID="rhel"
+    if [[ "${ID}" = "rhel" ]] || [[ "${ID}" = *"alma"* ]] || [[ "${ID}" = *"rocky"* ]]; then
+        VERSION_CODENAME="rhel${MAJOR_VERSION_ID}"
+    else
+        VERSION_CODENAME="${ID}${MAJOR_VERSION_ID}"
+    fi
+else
+    echo "Linux distro ${ID} not supported."
+    exit 1
+fi
+
+if [ "${ADJUSTED_ID}" = "rhel" ] && [ "${VERSION_CODENAME-}" = "centos7" ]; then
+    # As of 1 July 2024, mirrorlist.centos.org no longer exists.
+    # Update the repo files to reference vault.centos.org.
+    sed -i s/mirror.centos.org/vault.centos.org/g /etc/yum.repos.d/*.repo
+    sed -i s/^#.*baseurl=http/baseurl=http/g /etc/yum.repos.d/*.repo
+    sed -i s/^mirrorlist=http/#mirrorlist=http/g /etc/yum.repos.d/*.repo
+fi
+
+# Setup INSTALL_CMD & PKG_MGR_CMD
+if type apt-get > /dev/null 2>&1; then
+    PKG_MGR_CMD=apt-get
+    INSTALL_CMD="${PKG_MGR_CMD} -y install --no-install-recommends"
+elif type microdnf > /dev/null 2>&1; then
+    PKG_MGR_CMD=microdnf
+    INSTALL_CMD="${PKG_MGR_CMD} ${INSTALL_CMD_ADDL_REPOS} -y install --refresh --best --nodocs --noplugins --setopt=install_weak_deps=0"
+elif type dnf > /dev/null 2>&1; then
+    PKG_MGR_CMD=dnf
+    INSTALL_CMD="${PKG_MGR_CMD} ${INSTALL_CMD_ADDL_REPOS} -y install --refresh --best --nodocs --noplugins --setopt=install_weak_deps=0"
+else
+    PKG_MGR_CMD=yum
+    INSTALL_CMD="${PKG_MGR_CMD} ${INSTALL_CMD_ADDL_REPOS} -y install --noplugins --setopt=install_weak_deps=0"
+fi
+
+# Clean up
+clean_up() {
+    case ${ADJUSTED_ID} in
+        debian)
+            rm -rf /var/lib/apt/lists/*
+            ;;
+        rhel)
+            rm -rf /var/cache/dnf/* /var/cache/yum/*
+            rm -rf /tmp/yum.log
+            rm -rf ${GPG_INSTALL_PATH}
+            ;;
+    esac
+}
+clean_up
+
+pkg_mgr_update() {
+    case $ADJUSTED_ID in
+        debian)
+            if [ "$(find /var/lib/apt/lists/* | wc -l)" = "0" ]; then
+                echo "Running apt-get update..."
+                ${PKG_MGR_CMD} update -y
+            fi
+            ;;
+        rhel)
+            if [ ${PKG_MGR_CMD} = "microdnf" ]; then
+                if [ "$(ls /var/cache/yum/* 2>/dev/null | wc -l)" = 0 ]; then
+                    echo "Running ${PKG_MGR_CMD} makecache ..."
+                    ${PKG_MGR_CMD} makecache
+                fi
+            else
+                if [ "$(ls /var/cache/${PKG_MGR_CMD}/* 2>/dev/null | wc -l)" = 0 ]; then
+                    echo "Running ${PKG_MGR_CMD} check-update ..."
+                    set +e
+                    ${PKG_MGR_CMD} check-update
+                    rc=$?
+                    if [ $rc != 0 ] && [ $rc != 100 ]; then
+                        exit 1
+                    fi
+                    set -e
+                fi
+            fi
+            ;;
+    esac
+}
+
+# Checks if packages are installed and installs them if not
+check_packages() {
+    case ${ADJUSTED_ID} in
+        debian)
+            if ! dpkg -s "$@" > /dev/null 2>&1; then
+                pkg_mgr_update
+                ${INSTALL_CMD} "$@"
+            fi
+            ;;
+        rhel)
+            if ! rpm -q "$@" > /dev/null 2>&1; then
+                pkg_mgr_update
+                ${INSTALL_CMD} "$@"
+            fi
+            ;;
+    esac
+}
+
+export DEBIAN_FRONTEND=noninteractive
+
+check_packages clang llvm
+
+go install github.com/cilium/ebpf/cmd/bpf2go@${BPF2GO_VERSION}
+
+clean_up
+
+echo "Done!"

test/go-ebpf/.gitignore

@@ -0,0 +1,3 @@
+*.o
+*bpfeb.go
+*bpfel.go

test/go-ebpf/almalinux.sh

@@ -0,0 +1,4 @@
+#!/usr/bin/env bash
+set -e
+
+. ./test.sh

test/go-ebpf/debian.sh

@@ -0,0 +1,4 @@
+#!/usr/bin/env bash
+set -e
+
+. ./test.sh

test/go-ebpf/fedora.sh

@@ -0,0 +1,4 @@
+#!/usr/bin/env bash
+set -e
+
+. ./test.sh

test/go-ebpf/generate.go

@@ -0,0 +1,3 @@
+//go:generate bpf2go goebpf test.bpf.c -- -I./headers
+
+package goebpf

test/go-ebpf/go.mod

@@ -0,0 +1,7 @@
+module example.org/goebpf
+
+go 1.23.7
+
+require github.com/cilium/ebpf v0.17.3
+
+require golang.org/x/sys v0.30.0 // indirect

test/go-ebpf/go.sum

@@ -0,0 +1,14 @@
+github.com/cilium/ebpf v0.17.3 h1:FnP4r16PWYSE4ux6zN+//jMcW4nMVRvuTLVTvCjyyjg=
+github.com/cilium/ebpf v0.17.3/go.mod h1:G5EDHij8yiLzaqn0WjyfJHvRa+3aDlReIaLVRMvOyJk=
+github.com/go-quicktest/qt v1.101.0 h1:O1K29Txy5P2OK0dGo59b7b0LR6wKfIhttaAhHUyn7eI=
+github.com/go-quicktest/qt v1.101.0/go.mod h1:14Bz/f7NwaXPtdYEgzsx46kqSxVwTbzVZsDC26tQJow=
+github.com/google/go-cmp v0.6.0 h1:ofyhxvXcZhMsU5ulbFiLKl/XBFqE1GSq7atu8tAmTRI=
+github.com/google/go-cmp v0.6.0/go.mod h1:17dUlkBOakJ0+DkrSSNjCkIjxS6bF9zb3elmeNGIjoY=
+github.com/kr/pretty v0.3.1 h1:flRD4NNwYAUpkphVc1HcthR4KEIFJ65n8Mw5qdRn3LE=
+github.com/kr/pretty v0.3.1/go.mod h1:hoEshYVHaxMs3cyo3Yncou5ZscifuDolrwPKZanG3xk=
+github.com/kr/text v0.2.0 h1:5Nx0Ya0ZqY2ygV366QzturHI13Jq95ApcVaJBhpS+AY=
+github.com/kr/text v0.2.0/go.mod h1:eLer722TekiGuMkidMxC/pM04lWEeraHUUmBw8l2grE=
+github.com/rogpeppe/go-internal v1.11.0 h1:cWPaGQEPrBb5/AsnsZesgZZ9yb1OQ+GOISoDNXVBh4M=
+github.com/rogpeppe/go-internal v1.11.0/go.mod h1:ddIwULY96R17DhadqLgMfk9H9tvdUzkipdSkR5nkCZA=
+golang.org/x/sys v0.30.0 h1:QjkSwP/36a20jFYWkSue1YwXzLmsV5Gfq7Eiy72C1uc=
+golang.org/x/sys v0.30.0/go.mod h1:/VUhepiaJMQUp4+oa/7Zr1D23ma6VTLIYjOOTFZPUcA=

test/go-ebpf/headers/LICENSE.BSD-2-Clause

@@ -0,0 +1,32 @@
+Valid-License-Identifier: BSD-2-Clause
+SPDX-URL: https://spdx.org/licenses/BSD-2-Clause.html
+Usage-Guide:
+  To use the BSD 2-clause "Simplified" License put the following SPDX
+  tag/value pair into a comment according to the placement guidelines in
+  the licensing rules documentation:
+    SPDX-License-Identifier: BSD-2-Clause
+License-Text:
+
+Copyright (c) 2015 The Libbpf Authors. All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice,
+   this list of conditions and the following disclaimer.
+
+2. Redistributions in binary form must reproduce the above copyright
+   notice, this list of conditions and the following disclaimer in the
+   documentation and/or other materials provided with the distribution.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
+LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+POSSIBILITY OF SUCH DAMAGE.

test/go-ebpf/headers/README.md

@@ -0,0 +1,3 @@
+Files in this directory are from:
+https://github.com/cilium/ebpf/tree/main/examples/headers. The
+libbpf-originating files have been updated to 1.5.0.