Merge pull request #16 from rjpdasilva/feature/build_allow_overriding_call_stack_limit_via_cmake

build: Allow changing call stack limit using `HU_MAX_CALL_STACK` in CMake

Author: d99kris

CMakeLists.txt

@@ -2,6 +2,9 @@
 cmake_minimum_required(VERSION 3.0...3.22 FATAL_ERROR)
 project(heapusage VERSION 1.0 LANGUAGES C CXX)
 
+set(HU_MAX_CALL_STACK "20" CACHE STRING
+    "Maximum call stack captured by heapusage, in number of entries (20 by default).")
+
 set(COMMON_FLAGS "-funwind-tables -g -Wall -Wextra -Wpedantic -Wshadow \
                   -Wpointer-arith -Wcast-qual -Wno-missing-braces \
                   -Wswitch-default -Wcast-align -Wunreachable-code \
@@ -28,6 +31,11 @@ set_target_properties(heapusage PROPERTIES PUBLIC_HEADER "src/heapusage.h")
 target_compile_features(heapusage PRIVATE cxx_variadic_templates)
 install(TARGETS heapusage LIBRARY DESTINATION lib PUBLIC_HEADER DESTINATION include)
 target_link_libraries(heapusage pthread dl)
+# Pre-processor defines that can be overriden with CMake variables:
+# - HU_MAX_CALL_STACK for overriding MAX_CALL_STACK.
+if (DEFINED HU_MAX_CALL_STACK)
+  target_compile_definitions(heapusage PRIVATE MAX_CALL_STACK=${HU_MAX_CALL_STACK})
+endif()
 
 # Dependency backward-cpp providing more detailed stacktraces on Linux, when
 # either of the following is present (only ONE needed):

README.md

@@ -185,6 +185,10 @@ Note that on-demand reporting will reflect the state when they are used, and
 will thus report memory currently in use that might still be released before
 the program exits, and therefore not necessarily constitute a memory leak.
 
+Heapusage uses a default call stack limit of 20 frames per call stack. It is
+possible to change this value at build time by using the `HU_MAX_CALL_STACK`
+CMake variable.
+
 Technical Details
 =================
 Heapusage intercepts calls to malloc/free/calloc/realloc and logs each memory

src/hulog.cpp

@@ -37,7 +37,10 @@
 
 
 /* ----------- Defines ------------------------------------------- */
+/* Can be externally overridden. */
+#if !defined(MAX_CALL_STACK)
 #define MAX_CALL_STACK 20   /* Limits the callstack depth to store */
+#endif
 
 
 /* ----------- Types --------------------------------------------- */