configure.sh and start.sh scripts now included in profiling image build

Author: marc-casavant

scripts/docker/build/ubuntu24/Dockerfile.prof

@@ -6,6 +6,9 @@
 ARG from=freeradius40x-build/ubuntu24
 FROM ${from}
 
+# Copy profiling profile scripts into the container
+COPY scripts/docker/profiling/profiles/default-profiling /profile
+
 #
 #  Install profiling tools
 #
@@ -51,7 +54,6 @@ RUN apt-get update && \
         libtalloc2-dbgsym \
         libpcre2-8-0-dbgsym \
         libpcap0.8t64-dbgsym \
-        libcurl4t64-dbgsym \
         libunbound8-dbgsym \
         libsqlite3-0-dbgsym \
         libpq5-dbgsym \
@@ -62,6 +64,7 @@ RUN apt-get update && \
         libhiredis1.1.0-dbgsym \
         librdkafka1-dbgsym \
         libwbclient0-dbgsym && \
+    (apt-get install -y $APT_OPTS libcurl4t64-dbgsym || true) && \
     apt-get clean && \
     rm -r /var/lib/apt/lists/*
 

scripts/docker/m4/profiling.deb.m4

@@ -1,6 +1,9 @@
 ARG from=CB_IMAGE
 FROM ${from}
 
+# Copy profiling profile scripts into the container
+COPY scripts/docker/profiling/profiles/PROFILE_NAME /profile
+
 #
 #  Install profiling tools
 #
@@ -46,7 +49,6 @@ RUN apt-get update && \
         libtalloc2-dbgsym \
         libpcre2-8-0-dbgsym \
         libpcap0.8t64-dbgsym \
-        libcurl4t64-dbgsym \
         libunbound8-dbgsym \
         libsqlite3-0-dbgsym \
         libpq5-dbgsym \
@@ -57,6 +59,7 @@ RUN apt-get update && \
         libhiredis1.1.0-dbgsym \
         librdkafka1-dbgsym \
         libwbclient0-dbgsym && \
+    (apt-get install -y $APT_OPTS libcurl4t64-dbgsym || true) && \
     apt-get clean && \
     rm -r /var/lib/apt/lists/*
 

scripts/docker/profiling/profiles/default-profiling/README

@@ -0,0 +1,43 @@
+# Default Profiling Profile
+
+Default profiling profile for FreeRADIUS, using Valgrind. The scripts in this directory are copied into the profiling Docker image at build time.
+
+## Scripts
+
+| Script         | Description                                                    |
+|----------------|----------------------------------------------------------------|
+| `configure.sh` | Configures the FreeRADIUS build with profiling options enabled |
+| `start.sh`     | Starts the profiling session                                   |
+
+## Building the image
+
+The profiling image is built on top of a crossbuild image using the make targets defined in
+[scripts/docker/crossbuild.mk](../../../../../crossbuild.mk). The `Dockerfile.prof` is generated
+from the m4 template at [scripts/docker/m4/profiling.deb.m4](../../../../m4/profiling.deb.m4).
+
+```sh
+# Regenerate Dockerfile.prof (if the m4 template changed)
+make crossbuild.IMAGE.profile.regen
+
+# Build the profiling image
+make crossbuild.IMAGE.profile.build
+```
+
+Replace `IMAGE` with the target OS, e.g. `ubuntu24`. This profile is used by default
+(`PROFILE=default-profiling`). To use a different profile:
+
+```sh
+make crossbuild.IMAGE.profile.build PROFILE=<name>
+```
+
+## Usage
+
+Once inside the container:
+
+```sh
+# Configure the FreeRADIUS build
+./configure.sh
+
+# Start profiling
+./start.sh
+```

scripts/docker/profiling/profiles/default-profiling/README.md

@@ -0,0 +1,20 @@
+#!/bin/bash
+set -e
+
+# CFLAGS used for profiling build:
+#   -g3                          Maximum debug info for callgrind symbol resolution
+#   -O1                          Basic optimisation for realistic hotspot costs; inlining/vectorisation/
+#                                unrolling disabled below so the call graph matches the source.
+#   -fno-omit-frame-pointer      Keep frame pointers for callgrind stack walking
+#   -fno-inline                  Preserve call edges (suppresses CC_HINT(flatten) too)
+#   -Dalways_inline=             Strip always_inline, which -fno-inline does not suppress
+#   -fno-plt                     Resolve cross-library calls via GOT rather than PLT stubs;
+#                                PLT stubs have no DWARF info and show as ??? in callgrind.
+#   -fno-builtin                 Keep stdlib calls (memcpy, strlen, etc.) visible in the graph
+#   -fno-optimize-sibling-calls  Suppress tail-call elimination (-O1 can still apply it)
+./configure \
+  --enable-developer \
+  --disable-verify-ptr \
+  --with-raddbdir=/etc/freeradius \
+  CFLAGS="-g3 -O1 -fno-omit-frame-pointer -fno-inline -Dalways_inline= -fno-plt -fno-builtin -fno-optimize-sibling-calls" \
+  LDFLAGS="-fno-omit-frame-pointer"

scripts/docker/profiling/profiles/default-profiling/configure.sh

@@ -0,0 +1,15 @@
+#!/bin/bash
+set -e
+
+valgrind \
+  --tool=callgrind \
+  --callgrind-out-file=/profile/results/callgrind.out.%p \
+  --trace-children=yes \
+  --separate-threads=yes \
+  --dump-instr=yes \
+  --collect-jumps=yes \
+  --cache-sim=yes \
+  --branch-sim=yes \
+  --keep-debuginfo=yes \
+  --instr-atstart=yes \
+  freeradius -f -l stdout -S resources.talloc_skip_cleanup=yes