Merge pull request #511 from KFilipek/gcov_enable

Enable gcov

Author: KFilipek

CMakeLists.txt

@@ -49,6 +49,7 @@ option(USE_UBSAN "Enable UndefinedBehaviorSanitizer checks" OFF)
 option(USE_TSAN "Enable ThreadSanitizer checks" OFF)
 option(USE_MSAN "Enable MemorySanitizer checks" OFF)
 option(USE_VALGRIND "Enable Valgrind instrumentation" OFF)
+option(USE_GCOV "Enable gcov support" OFF)
 
 # set UMF_PROXY_LIB_BASED_ON_POOL to one of: SCALABLE or JEMALLOC
 set(KNOWN_PROXY_LIB_POOLS SCALABLE JEMALLOC)

CONTRIBUTING.md

@@ -10,6 +10,7 @@
     - [Extending public API](#extending-public-api)
     - [License](#license)
     - [Adding new dependency](#adding-new-dependency)
+- [Code coverage](#code-coverage)
 
 Below you'll find instructions on how to contribute to UMF, either with code changes
 or issues. All contributions are most welcome!
@@ -202,3 +203,20 @@ New dependency: dependency_name
 license: SPDX license tag
 origin: https://dependency_origin.com
 ```
+
+## Code coverage
+
+After adding a new functionality add tests and check coverage before and after the change.
+To do this, enable coverage instrumentation by turning on the USE_GCOV flag in CMake.
+Coverage instrumentation feature is supported only by GCC and Clang.
+An example flow might look like the following:
+
+```bash
+$ cmake -B build -DUSE_GCOV=1 -DCMAKE_BUILD_TYPE=Debug
+$ cmake --build build -j
+$ cd build
+$ ctest
+$ apt install lcov
+$ lcov --capture --directory . --output-file coverage.info
+$ genhtml -o html_report coverage.info
+```

README.md

@@ -125,6 +125,7 @@ List of options provided by CMake:
 | USE_TSAN | Enable ThreadSanitizer checks | ON/OFF | OFF |
 | USE_MSAN | Enable MemorySanitizer checks | ON/OFF | OFF |
 | USE_VALGRIND | Enable Valgrind instrumentation | ON/OFF | OFF |
+| USE_GCOV | Enable gcov support (Linux only) | ON/OFF | OFF |
 
 ## Architecture: memory pools and providers
 

cmake/helpers.cmake

@@ -104,6 +104,12 @@ function(add_umf_target_compile_options name)
                 ${name} PRIVATE -Werror -fno-omit-frame-pointer
                                 -fstack-protector-strong)
         endif()
+        if(USE_GCOV)
+            if(NOT CMAKE_BUILD_TYPE STREQUAL "Debug")
+                message(FATAL_ERROR "To use gcov, the build type must be Debug")
+            endif()
+            target_compile_options(${name} PRIVATE --coverage)
+        endif()
     elseif(MSVC)
         target_compile_options(
             ${name}
@@ -121,6 +127,13 @@ function(add_umf_target_link_options name)
     if(NOT MSVC)
         if(NOT APPLE)
             target_link_options(${name} PRIVATE "LINKER:-z,relro,-z,now")
+            if(USE_GCOV)
+                if(NOT CMAKE_BUILD_TYPE STREQUAL "Debug")
+                    message(
+                        FATAL_ERROR "To use gcov, the build type must be Debug")
+                endif()
+                target_link_options(${name} PRIVATE --coverage)
+            endif()
         endif()
     elseif(MSVC)
         target_link_options(