Added perf & flame-graph

Author: kerero

base.Dockerfile

@@ -6,13 +6,13 @@ FROM ${OS}:${TAG} as base
 # Install required packages
 ARG CLANG_VER=12
 ARG GCC_VER=11
-RUN apt update 
 RUN export DEBIAN_FRONTEND=noninteractive \
-    && apt install -y git htop sudo curl wget net-tools jq \
+    && apt update && apt install -y git htop sudo curl wget net-tools jq locales\
     build-essential cmake ninja-build valgrind gdb rr doxygen \
     clang-${CLANG_VER} clang-tidy-${CLANG_VER} clang-format-${CLANG_VER} clang-tools-${CLANG_VER} \
     gcc-${GCC_VER} g++-${GCC_VER} \
-    python3 python3-pip
+    python3 python3-pip \
+    libbabeltrace-ctf-dev systemtap-sdt-dev libslang2-dev libelf-dev libunwind-dev libdw-dev libiberty-dev
 
 # Set selected clang version as default
 RUN ln -s /usr/bin/clang-${CLANG_VER} /usr/bin/clang \
@@ -31,6 +31,15 @@ COPY scripts/setup.sh /tmp
 RUN /tmp/setup.sh "${INSTALL_ZSH}" "${USERNAME}" "${USER_UID}" "${USER_GID}" "true" \
     && rm -f /tmp/setup.sh
 #################################################################################################
+FROM base as perf-builder
+
+RUN export DEBIAN_FRONTEND=noninteractive \
+    && apt install -y --no-install-recommends gcc-8 g++-8 flex bison
+RUN export CC=gcc-8 && export CXX=g++-8 \
+    && git clone --branch linux-msft-wsl-5.10.y --depth=1 https://github.com/microsoft/WSL2-Linux-Kernel.git /tmp/wsl2-kernel \
+    && cd /tmp/wsl2-kernel/tools/perf && make
+
+#################################################################################################
 FROM base as codechecker-builder
 
 RUN export DEBIAN_FRONTEND=noninteractive \
@@ -46,15 +55,24 @@ RUN cd /codechecker \
 
 #################################################################################################
 FROM base
+# Setup perf
+COPY --from=perf-builder /tmp/wsl2-kernel/tools/perf/perf /usr/local/bin
 
 # Setup CodeChecker
 COPY --from=codechecker-builder /codechecker/build/CodeChecker /opt/codechecker
 COPY --from=codechecker-builder /codechecker/analyzer/requirements.txt /opt/codechecker
 RUN pip3 install -r /opt/codechecker/requirements.txt \
     && ln -s /opt/codechecker/bin/CodeChecker /usr/bin/CodeChecker
 
+# Setup flame-graph
+RUN git clone --depth=1 https://github.com/brendangregg/FlameGraph /opt/flame-graph
+
 # Setup cmake utils
 COPY scripts/.CodeCheckerIgnore scripts/utils.cmake /opt/cmake-utils/
 
+#Setup profiling script
+COPY scripts/cpu-profile.sh /opt
+RUN ln -s /opt/cpu-profile.sh /usr/bin/cpu-profile
+
 # Cleanup
 RUN export DEBIAN_FRONTEND=noninteractive && apt autoremove -y

devcontainer.json

@@ -4,7 +4,7 @@
 		"dockerfile": "Dockerfile"
 	},
 	// The extra security opthion is for advanced debugging and analysis an should be used only in development
-	"runArgs": [ "--cap-add=SYS_PTRACE", "--security-opt", "seccomp=unconfined", "--rm"],
+	"runArgs": [ "--cap-add=SYS_ADMIN", "--cap-add=SYS_PTRACE", "--security-opt", "seccomp=unconfined", "--rm"],
 
 	// Set *default* container specific settings.json values on container create.
 	"settings": {},

scripts/cpu-profile.sh

@@ -0,0 +1,14 @@
+#!/usr/bin/env bash
+
+set -e
+
+# TODO: There is a room for improvant and validation
+if [ "$#" -ne 2 ]; then
+    echo "Usage: cpu-profile <command> <output_path>"
+    exit 1
+fi
+
+
+perf record -g -F max -o /tmp/perf.data $1 
+perf script -i /tmp/perf.data > /tmp/perf.script
+/opt/flame-graph/stackcollapse-perf.pl /tmp/perf.script | /opt/flame-graph/flamegraph.pl > $2/perf.svg

scripts/setup.sh

@@ -71,6 +71,13 @@ if [ "${USERNAME}" != "root" ] && [ "${EXISTING_NON_ROOT_USER}" != "${USERNAME}"
     EXISTING_NON_ROOT_USER="${USERNAME}"
 fi
 
+# Ensure at least the en_US.UTF-8 UTF-8 locale is available.
+# Common need for both applications and things like the agnoster ZSH theme.
+if ! grep -o -E '^\s*en_US.UTF-8\s+UTF-8' /etc/locale.gen > /dev/null; then
+    echo "en_US.UTF-8 UTF-8" >> /etc/locale.gen 
+    locale-gen
+fi
+
 # ** Shell customization section **
 if [ "${USERNAME}" = "root" ]; then 
     USER_RC_PATH="/root"

scripts/utils.cmake

@@ -6,8 +6,7 @@ add_custom_target(
 
 add_custom_target(
     tidy-fix
-    # The double run-clang-tidy is because when -fix is applied the fixed error are still shown
-    COMMAND run-clang-tidy -p build/ -fix -quiet && run-clang-tidy -p build/
+    COMMAND run-clang-tidy -p build/ -fix -quiet
     WORKING_DIRECTORY ..
 )