Merge pull request #40 from parca-dev/go24

Go 1.24 support for custom labels

Author: gnurizen

.github/workflows/env/action.yml

@@ -29,10 +29,3 @@ runs:
 
         sudo apt-get install -y llvm clang dwz curl unzip gcc-aarch64-linux-gnu \
           libc6-arm64-cross qemu-user-binfmt libc6:arm64
-    - name: Set up Go
-      uses: actions/setup-go@v5
-      with:
-        go-version: "1.23"
-        check-latest: true
-        cache-dependency-path: go.sum
-      id: go

.github/workflows/unit-test-on-pull-request.yml

@@ -15,6 +15,13 @@ jobs:
         uses: actions/checkout@v4
       - name: Set up environment
         uses: ./.github/workflows/env
+      - name: Set up Go
+        uses: actions/setup-go@v5
+        with:
+          go-version: "1.23"
+          check-latest: true
+          cache-dependency-path: go.sum
+        id: go
       - name: Check for changes in licenses of dependencies
         run: |
           make legal
@@ -55,6 +62,13 @@ jobs:
         uses: actions/checkout@v4
       - name: Set up environment
         uses: ./.github/workflows/env
+      - name: Set up Go
+        uses: actions/setup-go@v5
+        with:
+          go-version: "1.23"
+          check-latest: true
+          cache-dependency-path: go.sum
+        id: go
       - name: Get linter version
         id: linter-version
         run: (echo -n "version="; make linter-version) >> "$GITHUB_OUTPUT"
@@ -95,7 +109,15 @@ jobs:
     strategy:
       matrix:
         target_arch: [amd64, arm64]
+        go_version: [1.23, 1.24]
     steps:
+      - name: Set up Go
+        uses: actions/setup-go@v5
+        with:
+          go-version: ${{ matrix.go_version }}
+          check-latest: true
+          cache-dependency-path: go.sum
+        id: go
       - name: Clone code
         uses: actions/checkout@v4
       - name: Set up environment
@@ -105,7 +127,7 @@ jobs:
       - name: Upload integration test binaries
         uses: actions/upload-artifact@v4
         with:
-          name: integration-test-binaries-${{ matrix.target_arch }}
+          name: integration-test-binaries-${{ matrix.target_arch }}-${{ matrix.go_version}}
           path: support/*.test
 
   integration-tests:
@@ -115,11 +137,13 @@ jobs:
     timeout-minutes: 10
     strategy:
       matrix:
+        go_version: [1.23, 1.24]
         include:
           # List of available kernels here:
           # https://github.com/cilium/ci-kernels/pkgs/container/ci-kernels/versions?filters%5Bversion_type%5D=tagged
 
           # AMD64
+          - { target_arch: amd64, kernel: 4.19.314 }
           - { target_arch: amd64, kernel: 5.4.276 }
           - { target_arch: amd64, kernel: 5.10.217 }
           - { target_arch: amd64, kernel: 5.15.159 }
@@ -148,7 +172,7 @@ jobs:
           sudo mv ~/go/bin/bluebox /usr/local/bin/.
       - name: Fetch integration test binaries
         uses: actions/download-artifact@v4
-        with: { name: "integration-test-binaries-${{ matrix.target_arch }}" }
+        with: { name: "integration-test-binaries-${{ matrix.target_arch }}-${{ matrix.go_version}}" }
       - name: Fetch precompiled kernel
         run: |
           install -d ci-kernels

Makefile

@@ -45,7 +45,7 @@ LDFLAGS := -X go.opentelemetry.io/ebpf-profiler/vc.version=$(VERSION) \
 	-extldflags=-static
 
 GO_TAGS := osusergo,netgo
-EBPF_FLAGS := 
+EBPF_FLAGS :=
 
 GO_FLAGS := -buildvcs=false -ldflags="$(LDFLAGS)"
 
@@ -105,9 +105,11 @@ test-deps:
 		($(MAKE) -C "$(testdata_dir)") || exit ; \
 	)
 
-TEST_INTEGRATION_BINARY_DIRS := tracer processmanager/ebpf support
+TEST_INTEGRATION_BINARY_DIRS := tracer processmanager/ebpf support go_labels
 
 integration-test-binaries: generate ebpf
+# Call it a ".test" even though it isn't to get included into bluebox initramfs
+	go build -o ./support/go_labels_canary.test ./go_labels
 	$(foreach test_name, $(TEST_INTEGRATION_BINARY_DIRS), \
 		(go test -ldflags='-extldflags=-static' -trimpath -c \
 			-tags $(GO_TAGS),static_build,integration \

go.mod

@@ -3,8 +3,8 @@ module go.opentelemetry.io/ebpf-profiler
 go 1.22.2
 
 require (
+	github.com/aws/aws-sdk-go-v2 v1.30.5
 	github.com/aws/aws-sdk-go-v2/config v1.27.35
-	github.com/aws/aws-sdk-go-v2/feature/s3/manager v1.17.21
 	github.com/aws/aws-sdk-go-v2/service/s3 v1.62.0
 	github.com/cespare/xxhash/v2 v2.3.0
 	github.com/cilium/ebpf v0.16.0
@@ -34,7 +34,6 @@ require (
 	dario.cat/mergo v1.0.0 // indirect
 	github.com/Azure/go-ansiterm v0.0.0-20210617225240-d185dfc1b5a1 // indirect
 	github.com/Microsoft/go-winio v0.6.2 // indirect
-	github.com/aws/aws-sdk-go-v2 v1.30.5 // indirect
 	github.com/aws/aws-sdk-go-v2/aws/protocol/eventstream v1.6.4 // indirect
 	github.com/aws/aws-sdk-go-v2/credentials v1.17.33 // indirect
 	github.com/aws/aws-sdk-go-v2/feature/ec2/imds v1.16.13 // indirect

go.sum

@@ -16,8 +16,6 @@ github.com/aws/aws-sdk-go-v2/credentials v1.17.33 h1:lBHAQQznENv0gLHAZ73ONiTSkCt
 github.com/aws/aws-sdk-go-v2/credentials v1.17.33/go.mod h1:MBuqCUOT3ChfLuxNDGyra67eskx7ge9e3YKYBce7wpI=
 github.com/aws/aws-sdk-go-v2/feature/ec2/imds v1.16.13 h1:pfQ2sqNpMVK6xz2RbqLEL0GH87JOwSxPV2rzm8Zsb74=
 github.com/aws/aws-sdk-go-v2/feature/ec2/imds v1.16.13/go.mod h1:NG7RXPUlqfsCLLFfi0+IpKN4sCB9D9fw/qTaSB+xRoU=
-github.com/aws/aws-sdk-go-v2/feature/s3/manager v1.17.21 h1:sV0doPPsRT7gMP0BnDPwSsysVTV/nKpB/nFmMnz8goE=
-github.com/aws/aws-sdk-go-v2/feature/s3/manager v1.17.21/go.mod h1:ictvfJWqE2gkUFDRJVp5VU/TrytuzK88DYcpan7UYuA=
 github.com/aws/aws-sdk-go-v2/internal/configsources v1.3.17 h1:pI7Bzt0BJtYA0N/JEC6B8fJ4RBrEMi1LBrkMdFYNSnQ=
 github.com/aws/aws-sdk-go-v2/internal/configsources v1.3.17/go.mod h1:Dh5zzJYMtxfIjYW+/evjQ8uj2OyR/ve2KROHGHlSFqE=
 github.com/aws/aws-sdk-go-v2/internal/endpoints/v2 v2.6.17 h1:Mqr/V5gvrhA2gvgnF42Zh5iMiQNcOYthFYwCyrnuWlc=
@@ -71,8 +69,6 @@ github.com/docker/go-connections v0.5.0 h1:USnMq7hx7gwdVZq1L49hLXaFtUdTADjXGp+uj
 github.com/docker/go-connections v0.5.0/go.mod h1:ov60Kzw0kKElRwhNs9UlUHAE/F9Fe6GLaXnqyDdmEXc=
 github.com/docker/go-units v0.5.0 h1:69rxXcBk27SvSaaxTtLh/8llcHD8vYHT7WSdRZ/jvr4=
 github.com/docker/go-units v0.5.0/go.mod h1:fgPhTUdO+D/Jk86RDLlptpiXQzgHJF7gydDDbaIK4Dk=
-github.com/elastic/go-freelru v0.13.0 h1:TKKY6yCfNNNky7Pj9xZAOEpBcdNgZJfihEftOb55omg=
-github.com/elastic/go-freelru v0.13.0/go.mod h1:bSdWT4M0lW79K8QbX6XY2heQYSCqD7THoYf82pT/H3I=
 github.com/elastic/go-freelru v0.15.0 h1:Jo1aY8JAvpyxbTDJEudrsBfjFDaALpfVv8mxuh9sfvI=
 github.com/elastic/go-freelru v0.15.0/go.mod h1:bSdWT4M0lW79K8QbX6XY2heQYSCqD7THoYf82pT/H3I=
 github.com/elastic/go-perf v0.0.0-20241016160959-1342461adb4a h1:ymmtaN4bVCmKKeu4XEf6JEWNZKRXPMng1zjpKd+8rCU=

go_labels/main.go

@@ -0,0 +1,37 @@
+// Copyright The OpenTelemetry Authors
+// SPDX-License-Identifier: Apache-2.0
+
+package main
+
+import (
+	"context"
+	"fmt"
+	"math/rand"
+	"runtime/pprof"
+	"time"
+)
+
+//nolint:gosec
+func randomString(n int) string {
+	letters := []rune("abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789")
+	s := make([]rune, n)
+	for i := range s {
+		s[i] = letters[rand.Intn(len(letters))]
+	}
+	return string(s)
+}
+
+// This is a normal main program that when go build will be statically linked, this is required
+// to work with qemu/bluebox testing harness. A statically linked go test built binary doesn't
+// work with the go labels extractor ebpf program, not sure yet if this is a bug.
+func main() {
+	labels := pprof.Labels("l1", randomString(16), "l2", randomString(16), "l3", randomString(16))
+	lastUpdate := time.Now()
+	pprof.Do(context.TODO(), labels, func(context.Context) {
+		//nolint:revive
+		for time.Since(lastUpdate) < 10*time.Second {
+			// CPU go burr on purpose.
+		}
+	})
+	fmt.Println("PASS")
+}

go_labels/main_test.go

@@ -0,0 +1,48 @@
+// Copyright The OpenTelemetry Authors
+// SPDX-License-Identifier: Apache-2.0
+package main
+
+import (
+	"context"
+	"os"
+	"os/exec"
+	"testing"
+
+	"github.com/stretchr/testify/require"
+	"go.opentelemetry.io/ebpf-profiler/testutils"
+	tracertypes "go.opentelemetry.io/ebpf-profiler/tracer/types"
+)
+
+func TestGoCustomLabels(t *testing.T) {
+	if !testutils.IsRoot() {
+		t.Skip("root privileges required")
+	}
+
+	ctx, cancel := context.WithCancel(context.Background())
+
+	r := &testutils.MockReporter{}
+	enabledTracers, _ := tracertypes.Parse("")
+	enabledTracers.Enable(tracertypes.GoLabels)
+	traceCh, _ := testutils.StartTracer(ctx, t, enabledTracers, r)
+
+	// Use a separate exe for getting labels as the bpf code doesn't seem to work with
+	// go test static binaries at the moment, not clear if that's a problem with the bpf
+	// code or a bug/fact of life for static go binaries and getting g from TLS.
+	cmd := exec.Command("./go_labels_canary.test")
+	err := cmd.Start()
+	require.NoError(t, err)
+
+	// Wait 1 second for traces to arrive.
+	for trace := range traceCh {
+		t.Logf("got a trace %s", trace.Comm)
+		if len(trace.CustomLabels) > 0 {
+			for k, v := range trace.CustomLabels {
+				t.Logf("Custom label: %s=%s", k, v)
+			}
+			break
+		}
+	}
+	cancel()
+	_ = cmd.Process.Signal(os.Kill)
+	_ = cmd.Wait()
+}

interpreter/golang/runtime_data.go

@@ -113,4 +113,9 @@ var allOffsets = map[string]C.GoCustomLabelsOffsets{
 		hmap_log2_bucket_count: 9,
 		hmap_buckets:           16,
 	},
+	"go1.24": {
+		m_offset: 48,
+		curg:     192,
+		labels:   352,
+	},
 }

interpreter/luajit/luajit_test.go

@@ -16,15 +16,12 @@ import (
 	"io"
 	"net"
 	"net/http"
-	"os"
 	"runtime"
 	"strconv"
 	"sync"
 	"testing"
 	"time"
 
-	log "github.com/sirupsen/logrus"
-
 	"github.com/docker/go-connections/nat"
 	"github.com/stretchr/testify/require"
 	testcontainers "github.com/testcontainers/testcontainers-go"
@@ -33,13 +30,14 @@ import (
 	"go.opentelemetry.io/ebpf-profiler/interpreter/luajit"
 	"go.opentelemetry.io/ebpf-profiler/libpf"
 	"go.opentelemetry.io/ebpf-profiler/reporter"
+	"go.opentelemetry.io/ebpf-profiler/testutils"
 	"go.opentelemetry.io/ebpf-profiler/tracer"
 	tracertypes "go.opentelemetry.io/ebpf-profiler/tracer/types"
 )
 
 // Run
 func TestIntegration(t *testing.T) {
-	if !isRoot() {
+	if !testutils.IsRoot() {
 		t.Skip("root privileges required")
 	}
 	// TODO:
@@ -118,8 +116,10 @@ func TestIntegration(t *testing.T) {
 					port, err := cont.MappedPort(ctx, "8080")
 					require.NoError(t, err)
 
+					enabledTracers, _ := tracertypes.Parse("luajit")
+					enabledTracers.Enable(tracertypes.LuaJITTracer)
 					r := &mockReporter{symbols: make(symbolMap)}
-					traceCh, trc := startTracer(ctx, t, r)
+					traceCh, trc := testutils.StartTracer(ctx, t, enabledTracers, r)
 
 					var waitGroup sync.WaitGroup
 					defer waitGroup.Wait()
@@ -203,44 +203,6 @@ outer:
 	return true
 }
 
-// FIXME: refactor this to copy less code.
-func startTracer(ctx context.Context, t *testing.T, r *mockReporter) (chan *host.Trace,
-	*tracer.Tracer) {
-	enabledTracers, _ := tracertypes.Parse("luajit")
-	enabledTracers.Enable(tracertypes.LuaJITTracer)
-	trc, err := tracer.NewTracer(ctx, &tracer.Config{
-		DebugTracer:            true,
-		Reporter:               r,
-		Intervals:              &mockIntervals{},
-		IncludeTracers:         enabledTracers,
-		SamplesPerSecond:       1000,
-		ProbabilisticInterval:  100,
-		ProbabilisticThreshold: 100,
-	})
-	require.NoError(t, err)
-
-	trc.StartPIDEventProcessor(ctx)
-
-	err = trc.AttachTracer()
-	require.NoError(t, err)
-
-	log.Info("Attached tracer program")
-
-	err = trc.EnableProfiling()
-	require.NoError(t, err)
-
-	err = trc.AttachSchedMonitor()
-	require.NoError(t, err)
-
-	traceCh := make(chan *host.Trace)
-
-	// Spawn monitors for the various result maps
-	err = trc.StartMapMonitors(ctx, traceCh)
-	require.NoError(t, err)
-
-	return traceCh, trc
-}
-
 func startContainer(ctx context.Context, t *testing.T, image string) testcontainers.Container {
 	t.Log("starting", image)
 	// The offset tests load both platform images so docker gets confused if we don't specify
@@ -316,12 +278,6 @@ func makeRequests(ctx context.Context, t *testing.T, wg *sync.WaitGroup,
 	}()
 }
 
-type mockIntervals struct{}
-
-func (f mockIntervals) MonitorInterval() time.Duration    { return 1 * time.Second }
-func (f mockIntervals) TracePollInterval() time.Duration  { return 250 * time.Millisecond }
-func (f mockIntervals) PIDCleanupInterval() time.Duration { return 1 * time.Second }
-
 type symbolMap map[libpf.FrameID]string
 
 type mockReporter struct {
@@ -349,10 +305,6 @@ func (m *mockReporter) getFunctionName(frameID libpf.FrameID) string {
 	return m.symbols[frameID]
 }
 
-func isRoot() bool {
-	return os.Geteuid() == 0
-}
-
 func removeSentinel(frames []host.Frame) []host.Frame {
 	for i, f := range frames {
 		if f.File == 0 {

support/ebpf/Makefile

@@ -1,7 +1,7 @@
 SHELL ?= bash
-BPF_CLANG ?= clang-16
-BPF_LINK ?= llvm-link-16
-LLC ?= llc-16
+BPF_CLANG ?= clang-17
+BPF_LINK ?= llvm-link-17
+LLC ?= llc-17
 
 DEBUG_FLAGS = -DOPTI_DEBUG -g