fix: FPE monitoring boost discovery, addr2line fallback (acts-project…

…#3747) This PR - Changes the way FPE monitoring configures `boost::stacktrace`: the fallback to `addr2line` is dropped as that doesn't work anyway - Change explicit `-Werror` in the CI to `CMAKE_COMPILE_WARNING_AS_ERROR=ON` - This is not applied in `try_compile`, which would otherwise cause false negatives because there are warnings we don't control. - Add a static method in `FpeMonitor` that returns if `backtrace` / symbolization support is on or not. - Make the sequencer fail early if it's configured to run the FPE monitor, has masks configured and symbolization is not supported.
benjaminhuth · Oct 17, 2024 · f935e25 · f935e25
1 parent 7436f40
commit f935e25
Show file tree

Hide file tree

Showing 5 changed files with 31 additions and 20 deletions.
diff --git a/CMakePresets.json b/CMakePresets.json
@@ -46,7 +46,7 @@
             "inherits": "common",
             "cacheVariables": {
                 "CMAKE_BUILD_TYPE": "Release",
-                "CMAKE_CXX_FLAGS": "-Werror",
+                "CMAKE_COMPILE_WARNING_AS_ERROR": "ON",
                 "ACTS_FORCE_ASSERTIONS": "ON",
                 "ACTS_ENABLE_LOG_FAILURE_THRESHOLD": "ON",
                 "ACTS_BUILD_BENCHMARKS": "ON",

diff --git a/Examples/Framework/src/Framework/Sequencer.cpp b/Examples/Framework/src/Framework/Sequencer.cpp
@@ -126,6 +126,13 @@ Sequencer::Sequencer(const Sequencer::Config& cfg)
         "ACTS_SEQUENCER_DISABLE_FPEMON");
     m_cfg.trackFpes = false;
   }
+
+  if (m_cfg.trackFpes && !m_cfg.fpeMasks.empty() &&
+      !Acts::FpeMonitor::canSymbolize()) {
+    ACTS_ERROR("FPE monitoring is enabled but symbolization is not available");
+    throw std::runtime_error(
+        "FPE monitoring is enabled but symbolization is not available");
+  }
 }
 
 void Sequencer::addContextDecorator(

diff --git a/Plugins/FpeMonitoring/CMakeLists.txt b/Plugins/FpeMonitoring/CMakeLists.txt
@@ -24,6 +24,11 @@ else()
 
         set(_backtrace_setup_complete FALSE)
 
+        find_path(
+            boost_stacktrace_include
+            NAMES "boost/stacktrace.hpp"
+            REQUIRED
+        )
         if(Backtrace_FOUND)
             # check if we need to link against bracktrace or not
             set(backtrace_include "")
@@ -44,6 +49,7 @@ else()
                 "${CMAKE_BINARY_DIR}"
                 "${CMAKE_BINARY_DIR}${CMAKE_FILES_DIRECTORY}/CMakeTmp/backtrace.cpp"
                 LINK_LIBRARIES ${dl_LIBRARY}
+                CMAKE_FLAGS "-DINCLUDE_DIRECTORIES=${boost_stacktrace_include}"
                 COMPILE_DEFINITIONS -DBOOST_STACKTRACE_USE_BACKTRACE
                 OUTPUT_VARIABLE __OUTPUT
             )
@@ -54,9 +60,9 @@ else()
                 message(CHECK_FAIL "no")
 
                 file(GLOB hints "/usr/lib/gcc/*/*/include")
-                find_file(backtrace_header "backtrace.h" HINTS ${hints})
+                find_file(backtrace_header NAMES "backtrace.h" HINTS ${hints})
 
-                if(${backtrace_header} STREQUAL "backtrcae_header-NOTFOUND")
+                if(${backtrace_header} STREQUAL "backtrace_header-NOTFOUND")
                     message(STATUS "Could not find backtrace header file")
                 else()
                     set(backtrace_include
@@ -82,6 +88,8 @@ else()
                         "${CMAKE_BINARY_DIR}"
                         "${CMAKE_BINARY_DIR}${CMAKE_FILES_DIRECTORY}/CMakeTmp/backtrace.cpp"
                         LINK_LIBRARIES ${dl_LIBRARY}
+                        CMAKE_FLAGS
+                            "-DINCLUDE_DIRECTORIES=${boost_stacktrace_include}"
                         COMPILE_DEFINITIONS
                             -DBOOST_STACKTRACE_USE_BACKTRACE
                             ${backtrace_include}
@@ -111,6 +119,7 @@ else()
                 "${CMAKE_BINARY_DIR}"
                 "${CMAKE_BINARY_DIR}${CMAKE_FILES_DIRECTORY}/CMakeTmp/backtrace.cpp"
                 LINK_LIBRARIES ${dl_LIBRARY}
+                CMAKE_FLAGS "-DINCLUDE_DIRECTORIES=${boost_stacktrace_include}"
                 COMPILE_DEFINITIONS
                     -DBOOST_STACKTRACE_USE_BACKTRACE
                     ${backtrace_include}
@@ -137,6 +146,8 @@ else()
                     "${CMAKE_BINARY_DIR}"
                     "${CMAKE_BINARY_DIR}${CMAKE_FILES_DIRECTORY}/CMakeTmp/backtrace.cpp"
                     LINK_LIBRARIES backtrace ${dl_LIBRARY}
+                    CMAKE_FLAGS
+                        "-DINCLUDE_DIRECTORIES=${boost_stacktrace_include}"
                     COMPILE_DEFINITIONS
                         -DBOOST_STACKTRACE_USE_BACKTRACE
                         ${backtrace_include}
@@ -158,23 +169,6 @@ else()
             endif()
         endif()
 
-        if(NOT _backtrace_setup_complete)
-            message(CHECK_START "Is addr2line available")
-            if(addr2line_EXECUTABLE)
-                list(APPEND _fpe_options -DBOOST_STACKTRACE_USE_ADDR2LINE)
-                list(
-                    APPEND
-                    _fpe_options
-                    -DBOOST_STACKTRACE_ADDR2LINE_LOCATION=${addr2line_EXECUTABLE}
-                )
-                message(CHECK_PASS "yes")
-
-                set(_backtrace_setup_complete TRUE)
-            else()
-                message(CHECK_FAIL "no")
-            endif()
-        endif()
-
         if(NOT _backtrace_setup_complete)
             message(STATUS "Unable to set up stacktrace setup: use noop")
             list(APPEND _fpe_options -BOOST_STACKTRACE_USE_NOOP)

diff --git a/Plugins/FpeMonitoring/include/Acts/Plugins/FpeMonitoring/FpeMonitor.hpp b/Plugins/FpeMonitoring/include/Acts/Plugins/FpeMonitoring/FpeMonitor.hpp
@@ -131,6 +131,8 @@ class FpeMonitor {
                                         std::size_t depth);
   static std::string getSourceLocation(const boost::stacktrace::frame &frame);
 
+  static bool canSymbolize();
+
  private:
   void enable();
   void disable();

diff --git a/Plugins/FpeMonitoring/src/FpeMonitor.cpp b/Plugins/FpeMonitoring/src/FpeMonitor.cpp
@@ -332,4 +332,12 @@ std::string FpeMonitor::getSourceLocation(
   return frame.source_file() + ":" + std::to_string(frame.source_line());
 }
 
+bool FpeMonitor::canSymbolize() {
+#if defined(BOOST_STACKTRACE_USE_NOOP)
+  return false;
+#else
+  return true;
+#endif
+}
+
 }  // namespace Acts