Fix clang-cl build and test clang-cl in CI

Author: jeremy-rifkin

.github/workflows/ci.yml

@@ -677,3 +677,25 @@ jobs:
              -DCPPTRACE_BUILD_TESTING=On
            ninja
            ./unittest_module
+
+  unittest-windows-clangcl:
+    runs-on: windows-2022
+    needs: unittest-windows
+    strategy:
+      fail-fast: false
+      matrix:
+        build_type: [Debug]
+    steps:
+    - uses: actions/checkout@v4
+    - name: Enable Developer Command Prompt
+      uses: ilammy/msvc-dev-cmd@v1.13.0
+    - name: build and test
+      run: |
+           mkdir build
+           cd build
+           cmake .. `
+            -T ClangCL `
+            -DCPPTRACE_WERROR_BUILD=On `
+            -DCPPTRACE_BUILD_TESTING=On
+           cmake --build . --config ${{matrix.build_type}}
+           ./${{matrix.build_type}}/unittest

include/cpptrace/from_current_macros.hpp

@@ -18,7 +18,7 @@
 
 #ifdef _MSC_VER
  #define CPPTRACE_TYPE_FOR(param) \
-     ::cpptrace::detail::argument<void(param)>::type
+     typename ::cpptrace::detail::argument<void(param)>::type
  // this awful double-IILE is due to C2713 "You can't use structured exception handling (__try/__except) and C++
  // exception handling (try/catch) in the same function."
  #define CPPTRACE_TRY \

src/from_current.cpp

@@ -12,9 +12,7 @@
 #include "utils/utils.hpp"
 #include "logging.hpp"
 
-#ifdef _MSC_VER
- #include <ehdata.h>
-#else
+#ifndef _MSC_VER
  #include <string.h>
  #if IS_WINDOWS
   #ifndef WIN32_LEAN_AND_MEAN
@@ -62,15 +60,53 @@ namespace detail {
     // https://github.com/ecatmur/stacktrace-from-exception/blob/main/stacktrace-from-exception.cpp
     // https://github.com/wine-mirror/wine/blob/7f833db11ffea4f3f4fa07be31d30559aff9c5fb/dlls/msvcrt/except.c#L371
     // https://github.com/facebook/folly/blob/d17bf897cb5bbf8f07b122a614e8cffdc38edcde/folly/lang/Exception.cpp
+
+    // ClangCL doesn't define ThrowInfo so we use our own
+    // sources:
+    // - https://github.com/ecatmur/stacktrace-from-exception/blob/main/stacktrace-from-exception.cpp
+    // - https://github.com/catboost/catboost/blob/master/contrib/libs/cxxsupp/libcxx/src/support/runtime/exception_pointer_msvc.ipp
+    // - https://www.geoffchappell.com/studies/msvc/language/predefined/index.htm
+    #if defined _WIN64
+     #pragma pack(push, 4)
+     struct CatchableType {
+         std::uint32_t properties;
+         std::int32_t pType;
+         std::uint32_t non_virtual_adjustment; // these next three are from _PMD
+         std::uint32_t offset_to_virtual_base_ptr;
+         std::uint32_t virtual_base_table_index;
+         std::uint32_t sizeOrOffset;
+         std::int32_t copyFunction;
+     };
+     struct ThrowInfo {
+         std::uint32_t attributes;
+         std::int32_t pmfnUnwind;
+         std::int32_t pForwardCompat;
+         std::int32_t pCatchableTypeArray;
+     };
+     #pragma warning(disable:4200)
+     struct CatchableTypeArray {
+         uint32_t nCatchableTypes;
+         int32_t arrayOfCatchableTypes[];
+     };
+     #pragma warning (pop)
+     #pragma pack(pop)
+    #else
+     using CatchableType = ::_CatchableType;
+     using ThrowInfo = ::_ThrowInfo;
+    #endif
+
+    static constexpr unsigned EH_MAGIC_NUMBER1 = 0x19930520; // '?msc' version magic, see ehdata.h
+    static constexpr unsigned EH_EXCEPTION_NUMBER = 0xE06D7363;  // '?msc', 'msc' | 0xE0000000
+
     using catchable_type_array_t = decltype(ThrowInfo::pCatchableTypeArray);
 
     class catchable_type_info {
         HMODULE module_pointer = nullptr;
-        const _CatchableTypeArray* catchable_types = nullptr;
+        const CatchableTypeArray* catchable_types = nullptr;
     public:
         catchable_type_info(const HMODULE module_pointer, catchable_type_array_t catchable_type_array)
             : module_pointer(module_pointer) {
-            catchable_types = rtti_rva<const _CatchableTypeArray*>(catchable_type_array);
+            catchable_types = rtti_rva<const CatchableTypeArray*>(catchable_type_array);
         }
 
         class iterator {

test/unit/tracing/rethrow.cpp

@@ -153,19 +153,21 @@ TEST(Rethrow, RethrowTraceCorrect) {
         EXPECT_TRUE(cpptrace::current_exception_was_rethrown());
         EXPECT_EQ(e.what(), "foobar"sv);
         auto rethrow_trace = cpptrace::from_current_exception_rethrow();
+        rethrow_trace.print();
         ASSERT_GE(rethrow_trace.frames.size(), 4);
-        auto it = std::find_if(
-            rethrow_trace.frames.begin(),
-            rethrow_trace.frames.end(),
+        // reverse to get the last one matching instead of "`stacktrace_from_current_rethrow_2'::`1'::catch$4()" on msvc
+        auto rit = std::find_if(
+            rethrow_trace.frames.rbegin(),
+            rethrow_trace.frames.rend(),
             [](const cpptrace::stacktrace_frame& frame) {
-                // catch check is to ignore "`stacktrace_from_current_rethrow_2'::`1'::catch$4()" on msvc
                 return frame.symbol.find("stacktrace_from_current_rethrow_2") != std::string::npos
                     && frame.symbol.find("::catch") == std::string::npos;
             }
         );
-        ASSERT_NE(it, rethrow_trace.frames.end()) << rethrow_trace;
+        ASSERT_NE(rit, rethrow_trace.frames.rend()) << rethrow_trace;
+        size_t i = static_cast<size_t>(&*rit - &*rethrow_trace.frames.begin());
+        auto it = rethrow_trace.frames.begin() + i;
         clean_trace(rethrow_trace, it);
-        size_t i = static_cast<size_t>(it - rethrow_trace.frames.begin());
         int j = 0;
         ASSERT_LT(i, rethrow_trace.frames.size());
         ASSERT_LT(j, rethrow_line_numbers.size());