Compute code coverage

Signed-off-by: Lukasz Dorau <[email protected]>

Author: ldorau

.github/workflows/coverage.yml

@@ -0,0 +1,49 @@
+# Coverage build
+name: Coverage
+
+on: workflow_call
+
+permissions:
+  contents: read
+
+env:
+  COVERAGE_DIR : "${{github.workspace}}/coverage"
+
+jobs:
+  Coverage:
+    name: Coverage build
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4.1.1
+        with:
+          fetch-depth: 0
+
+      - name: Install dependencies (ubuntu-latest)
+        run: |
+          sudo apt-get update
+          sudo apt-get install -y lcov
+
+      - name: Download all coverage artifacts
+        uses: actions/download-artifact@fa0a91b85d4f404e444e00e005971372dc801d16 # v4.1.8
+        with:
+          pattern: exports-coverage-*
+          path: coverage
+          merge-multiple: true
+
+      - name: Compute coverage
+        working-directory: ${{env.COVERAGE_DIR}}
+        run: |
+          echo "DIR: $(pwd)" && ls -al
+          ../scripts/coverage/merge_coverage_files.sh exports-coverage total_coverage
+          genhtml --no-function-coverage -o html_report total_coverage 2>&1 | tee output.txt
+          mkdir coverage_report
+          mv html_report ./coverage_report/
+          tail -n2 output.txt >> $GITHUB_STEP_SUMMARY
+
+      - name: Upload coverage report
+        uses: actions/upload-artifact@65462800fd760344b1a7b4382951275a0abb4808 # v4.3.3
+        with:
+          name: coverage_html_report
+          path: coverage/coverage_report

cmake/helpers.cmake

@@ -255,6 +255,13 @@ function(add_umf_target_compile_options name)
                 )
             endif()
             target_compile_options(${name} PRIVATE --coverage)
+            if(${CMAKE_C_COMPILER} MATCHES "gcc")
+                # Fix for the following error: geninfo: ERROR: Unexpected
+                # negative count '-1' for provider_os_memory.c:1037. Perhaps you
+                # need to compile with '-fprofile-update=atomic
+                target_compile_options(${name} PRIVATE -fprofile-update=atomic
+                                                       -g -O0)
+            endif()
         endif()
     elseif(MSVC)
         target_compile_options(

scripts/coverage/coverage_capture.sh

@@ -0,0 +1,49 @@
+#!/bin/bash
+# Copyright (C) 2024 Intel Corporation
+# Under the Apache License v2.0 with LLVM Exceptions. See LICENSE.TXT.
+# SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
+
+# This script calculates coverage for a single build
+
+set -e
+
+[ "$1" != "" ] && OUTPUT_NAME="$1" || OUTPUT_NAME="output_coverage"
+
+set -x
+
+lcov --capture  --directory . \
+--exclude "/usr/*" \
+--exclude "*/build/*" \
+--exclude "*/benchmark/*" \
+--exclude "*/examples/*" \
+--exclude "*/test/*" \
+--exclude "*/src/critnib/*" \
+--exclude "*/src/ravl/*" \
+--exclude "*proxy_lib_new_delete.h" \
+--output-file $OUTPUT_NAME || \
+	( echo "RETRY after ERROR !!!:" && \
+	lcov --capture --directory . \
+	--exclude "/usr/*" \
+	--exclude "*/build/*" \
+	--exclude "*/benchmark/*" \
+	--exclude "*/examples/*" \
+	--exclude "*/test/*" \
+	--exclude "*/src/critnib/*" \
+	--exclude "*/src/ravl/*" \
+	--exclude "*proxy_lib_new_delete.h" \
+	--ignore-errors mismatch,unused,negative,corrupt \
+	--output-file $OUTPUT_NAME )
+
+# Most common UMF source code directory on most GH CI runners
+COMMON_UMF_DIR=/home/runner/work/unified-memory-framework/unified-memory-framework
+
+# Get the current UMF source code directory
+# This is ${CURRENT_UMF_DIR}/scripts/coverage/coverage_capture.sh file, so
+CURRENT_UMF_DIR=$(realpath $(dirname $0)/../..)
+
+# Coverage (lcov) has to be run in the same directory on all runners:
+# /home/runner/work/unified-memory-framework/unified-memory-framework/build
+# to be able to merge all results, so we have to replace the paths if they are different:
+if [ "$CURRENT_UMF_DIR" != "$COMMON_UMF_DIR" ]; then
+	sed -i "s|$CURRENT_UMF_DIR|$COMMON_UMF_DIR|g" $OUTPUT_NAME
+fi

scripts/coverage/merge_coverage_files.sh

@@ -0,0 +1,27 @@
+#!/bin/bash
+# Copyright (C) 2024 Intel Corporation
+# Under the Apache License v2.0 with LLVM Exceptions. See LICENSE.TXT.
+# SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
+
+#
+# Arguments: <PREFIX> <OUTPUT_NAME>
+#
+# This script looks for "${PREFIX}-*" lcov output files in the current directory,
+# merges them and saves the merged output in the $OUTPUT_NAME file.
+#
+
+[ "$1" != "" ] && PREFIX="$1" || PREFIX="exports-coverage"
+[ "$2" != "" ] && OUTPUT_NAME="$2" || OUTPUT_NAME="total_coverage"
+
+OPTS=""
+for file in $(ls -1 ${PREFIX}-*); do
+	OPTS="$OPTS -a $file"
+done
+
+set -x
+
+lcov $OPTS -o $OUTPUT_NAME  || \
+	( echo "RETRY after ERROR !!!:" && \
+	lcov $OPTS \
+	--ignore-errors mismatch,unused,negative,corrupt \
+	--output-file $OUTPUT_NAME )

test/CMakeLists.txt

@@ -498,7 +498,8 @@ if(LINUX
        (UMF_USE_ASAN
         OR UMF_USE_UBSAN
         OR UMF_USE_TSAN
-        OR UMF_USE_MSAN))
+        OR UMF_USE_MSAN
+        OR UMF_USE_COVERAGE))
 
     set(EXAMPLES "")