Improve compilation times on Windows (#172)

Thank you for the very useful library! Few improvements: - Better header hygiene - Isolate `windows.h` to `.cpp` whenever possible - Use `WIN32_LEAN_AND_MEAN` - Remove unused headers Tested on Windows with ``` cmake .. -DCMAKE_BUILD_TYPE=Debug -GNinja -DCMAKE_EXPORT_COMPILE_COMMANDS=1 -DCMAKE_CXX_COMPILER=clang++ -DCMAKE_CXX_FLAGS="-ftime-trace -Wall -Wextra -Wpedantic -Wno-ignored-attributes" -DCMAKE_COLOR_DIAGNOSTICS=1 -DCPPTRACE_BUILD_TESTING=1 -DCPPTRACE_BUILD_BENCHMARKING=0 ``` There's a lot more that can be improved if you are interested. --------- Co-authored-by: Jeremy Rifkin <51220084+jeremy-rifkin@users.noreply.github.com>
jeremy-rifkin · Oct 2, 2024 · 0ddbbf4 · 0ddbbf4
1 parent 4ed90c1
commit 0ddbbf4
Show file tree

Hide file tree

Showing 44 changed files with 220 additions and 156 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,6 +1,7 @@
 # Changelog
 
 - [Changelog](#changelog)
+- [v0.7.1](#v071)
 - [v0.7.0](#v070)
 - [v0.6.3](#v063)
 - [v0.6.2](#v062)
@@ -20,6 +21,24 @@
 - [v0.1.1](#v011)
 - [v0.1](#v01)
 
+# v0.7.1
+
+Added
+- Better support for finding libunwind on macos https://github.com/jeremy-rifkin/cpptrace/pull/162
+- Support for libbacktrace under mingw https://github.com/jeremy-rifkin/cpptrace/pull/166
+
+Fixed
+- Computation of object address for safe object frames https://github.com/jeremy-rifkin/cpptrace/issues/169
+- Nested microfmt in cpptrace's namespace due to an ODR problem with libassert https://github.com/jeremy-rifkin/libassert/issues/103
+- Compilation on iOS https://github.com/jeremy-rifkin/cpptrace/pull/167
+- Compilation on old MSVC https://github.com/jeremy-rifkin/cpptrace/pull/165
+- Dbghelp use on 32 bit https://github.com/jeremy-rifkin/cpptrace/issues/170
+- Warning in brand new cmake due to `FetchContent_Populate` being deprecated https://github.com/jeremy-rifkin/cpptrace/issues/171
+
+Other changes
+- Bumped the buffer size for execinfo and CaptureStackBackTrace to 400 frames
+- Switched to execinfo.h for unwinding on clang/apple clang on macos due to `_Unwind` not working with `-fno-exceptions` https://github.com/jeremy-rifkin/cpptrace/issues/161
+
 # v0.7.0
 
 Added

diff --git a/CMakeLists.txt b/CMakeLists.txt
@@ -9,7 +9,7 @@ set(package_name "cpptrace")
 
 project(
   cpptrace
-  VERSION 0.7.0
+  VERSION 0.7.1
   DESCRIPTION "Simple, portable, and self-contained stacktrace library for C++11 and newer "
   HOMEPAGE_URL "https://github.com/jeremy-rifkin/cpptrace"
   LANGUAGES C CXX
@@ -246,6 +246,9 @@ target_sources(
     src/unwind/unwind_with_nothing.cpp
     src/unwind/unwind_with_unwind.cpp
     src/unwind/unwind_with_winapi.cpp
+    src/utils/microfmt.cpp
+    src/utils/utils.cpp
+    src/platform/dbghelp_syminit_manager.cpp
 )
 
 target_include_directories(

diff --git a/README.md b/README.md
@@ -134,7 +134,7 @@ include(FetchContent)
 FetchContent_Declare(
   cpptrace
   GIT_REPOSITORY https://github.com/jeremy-rifkin/cpptrace.git
-  GIT_TAG        v0.7.0 # <HASH or TAG>
+  GIT_TAG        v0.7.1 # <HASH or TAG>
 )
 FetchContent_MakeAvailable(cpptrace)
 target_link_libraries(your_target cpptrace::cpptrace)
@@ -793,7 +793,7 @@ include(FetchContent)
 FetchContent_Declare(
   cpptrace
   GIT_REPOSITORY https://github.com/jeremy-rifkin/cpptrace.git
-  GIT_TAG        v0.7.0 # <HASH or TAG>
+  GIT_TAG        v0.7.1 # <HASH or TAG>
 )
 FetchContent_MakeAvailable(cpptrace)
 target_link_libraries(your_target cpptrace::cpptrace)
@@ -809,7 +809,7 @@ information.
 
 ```sh
 git clone https://github.com/jeremy-rifkin/cpptrace.git
-git checkout v0.7.0
+git checkout v0.7.1
 mkdir cpptrace/build
 cd cpptrace/build
 cmake .. -DCMAKE_BUILD_TYPE=Release
@@ -852,7 +852,7 @@ you when installing new libraries.
 
 ```ps1
 git clone https://github.com/jeremy-rifkin/cpptrace.git
-git checkout v0.7.0
+git checkout v0.7.1
 mkdir cpptrace/build
 cd cpptrace/build
 cmake .. -DCMAKE_BUILD_TYPE=Release
@@ -870,7 +870,7 @@ To install just for the local user (or any custom prefix):
 
 ```sh
 git clone https://github.com/jeremy-rifkin/cpptrace.git
-git checkout v0.7.0
+git checkout v0.7.1
 mkdir cpptrace/build
 cd cpptrace/build
 cmake .. -DCMAKE_BUILD_TYPE=Release -DCMAKE_INSTALL_PREFIX=$HOME/wherever
@@ -953,7 +953,7 @@ make install
 cd ~/scratch/cpptrace-test
 git clone https://github.com/jeremy-rifkin/cpptrace.git
 cd cpptrace
-git checkout v0.7.0
+git checkout v0.7.1
 mkdir build
 cd build
 cmake .. -DCMAKE_BUILD_TYPE=Release -DBUILD_SHARED_LIBS=On -DCPPTRACE_USE_EXTERNAL_LIBDWARF=On -DCMAKE_PREFIX_PATH=~/scratch/cpptrace-test/resources -DCMAKE_INSTALL_PREFIX=~/scratch/cpptrace-test/resources
@@ -973,7 +973,7 @@ cpptrace and its dependencies.
 Cpptrace is available through conan at https://conan.io/center/recipes/cpptrace.
 ```
 [requires]
-cpptrace/0.7.0
+cpptrace/0.7.1
 [generators]
 CMakeDeps
 CMakeToolchain

diff --git a/cmake/has_stackwalk.cpp b/cmake/has_stackwalk.cpp
@@ -1,3 +1,4 @@
+#define WIN32_LEAN_AND_MEAN
 #include <windows.h>
 #include <dbghelp.h>
 

diff --git a/src/binary/module_base.cpp b/src/binary/module_base.cpp
@@ -1,10 +1,9 @@
 #include "binary/module_base.hpp"
 
-#include "utils/common.hpp"
+#include "platform/platform.hpp"
 #include "utils/utils.hpp"
 
 #include <string>
-#include <vector>
 #include <mutex>
 #include <unordered_map>
 
@@ -17,7 +16,6 @@
   #include "binary/elf.hpp"
  #endif
 #elif IS_WINDOWS
- #include <windows.h>
  #include "binary/pe.hpp"
 #endif
 

diff --git a/src/binary/module_base.hpp b/src/binary/module_base.hpp
@@ -1,7 +1,6 @@
 #ifndef IMAGE_MODULE_BASE_HPP
 #define IMAGE_MODULE_BASE_HPP
 
-#include "utils/common.hpp"
 #include "utils/utils.hpp"
 
 #include <cstdint>

diff --git a/src/binary/object.cpp b/src/binary/object.cpp
@@ -1,6 +1,6 @@
 #include "binary/object.hpp"
 
-#include "utils/common.hpp"
+#include "platform/platform.hpp"
 #include "utils/utils.hpp"
 #include "binary/module_base.hpp"
 
@@ -16,6 +16,7 @@
   #include <link.h> // needed for dladdr1's link_map info
  #endif
 #elif IS_WINDOWS
+ #define WIN32_LEAN_AND_MEAN
  #include <windows.h>
 #endif
 

diff --git a/src/binary/object.hpp b/src/binary/object.hpp
@@ -1,14 +1,16 @@
 #ifndef OBJECT_HPP
 #define OBJECT_HPP
 
-#include "utils/common.hpp"
-#include "utils/utils.hpp"
-#include "binary/module_base.hpp"
-
-#include <string>
 #include <vector>
+#include <cstdint>
 
 namespace cpptrace {
+
+struct object_frame;
+struct safe_object_frame;
+
+using frame_ptr = std::uintptr_t;
+
 namespace detail {
     object_frame get_frame_object_info(frame_ptr address);
 

diff --git a/src/binary/pe.cpp b/src/binary/pe.cpp
@@ -1,16 +1,16 @@
 #include "binary/pe.hpp"
 
-#include "utils/common.hpp"
+#include "platform/platform.hpp"
 #include "utils/error.hpp"
 #include "utils/utils.hpp"
 
 #if IS_WINDOWS
 #include <array>
-#include <cstddef>
 #include <cstdio>
 #include <cstring>
 #include <string>
 
+#define WIN32_LEAN_AND_MEAN
 #include <windows.h>
 
 namespace cpptrace {

diff --git a/src/binary/pe.hpp b/src/binary/pe.hpp
@@ -1,7 +1,7 @@
 #ifndef PE_HPP
 #define PE_HPP
 
-#include "utils/common.hpp"
+#include "platform/platform.hpp"
 #include "utils/utils.hpp"
 
 #if IS_WINDOWS

diff --git a/src/cpptrace.cpp b/src/cpptrace.cpp
@@ -5,6 +5,7 @@
 #include <cstdint>
 #include <cstdio>
 #include <cstring>
+#include <iostream>
 #include <new>
 #include <sstream>
 #include <stdexcept>
@@ -16,6 +17,7 @@
 #include "demangle/demangle.hpp"
 #include "platform/exception_type.hpp"
 #include "utils/common.hpp"
+#include "utils/microfmt.hpp"
 #include "utils/utils.hpp"
 #include "binary/object.hpp"
 #include "binary/safe_dl.hpp"

diff --git a/src/demangle/demangle_with_winapi.cpp b/src/demangle/demangle_with_winapi.cpp
@@ -4,6 +4,7 @@
 
 #include <string>
 
+#define WIN32_LEAN_AND_MEAN
 #include <windows.h>
 #include <dbghelp.h>
 

diff --git a/src/from_current.cpp b/src/from_current.cpp
@@ -6,14 +6,12 @@
 #include <typeinfo>
 
 #include "platform/platform.hpp"
-#include "utils/common.hpp"
 #include "utils/microfmt.hpp"
-#include "utils/utils.hpp"
 
 #ifndef _MSC_VER
- #include <array>
  #include <string.h>
  #if IS_WINDOWS
+  #define WIN32_LEAN_AND_MEAN
   #include <windows.h>
  #else
   #include <sys/mman.h>
@@ -25,7 +23,7 @@
    #endif
   #else
    #include <fstream>
-   #include <iomanip>
+   #include <ios>
   #endif
  #endif
 #endif

diff --git a/src/platform/dbghelp_syminit_manager.cpp b/src/platform/dbghelp_syminit_manager.cpp
@@ -0,0 +1,45 @@
+#include "platform/platform.hpp"
+
+#if IS_WINDOWS
+
+#include "platform/dbghelp_syminit_manager.hpp"
+
+#include "utils/error.hpp"
+#include "utils/microfmt.hpp"
+
+#include <unordered_set>
+
+#define WIN32_LEAN_AND_MEAN
+#include <windows.h>
+#include <dbghelp.h>
+
+namespace cpptrace {
+namespace detail {
+
+    dbghelp_syminit_manager::~dbghelp_syminit_manager() {
+        for(auto handle : set) {
+            if(!SymCleanup(handle)) {
+                ASSERT(false, microfmt::format("Cpptrace SymCleanup failed with code {}\n", GetLastError()).c_str());
+            }
+        }
+    }
+
+    void dbghelp_syminit_manager::init(HANDLE proc) {
+        if(set.count(proc) == 0) {
+            if(!SymInitialize(proc, NULL, TRUE)) {
+                throw internal_error("SymInitialize failed {}", GetLastError());
+            }
+            set.insert(proc);
+        }
+    }
+
+    // Thread-safety: Must only be called from symbols_with_dbghelp while the dbghelp_lock lock is held
+    dbghelp_syminit_manager& get_syminit_manager() {
+        static dbghelp_syminit_manager syminit_manager;
+        return syminit_manager;
+    }
+
+}
+}
+
+#endif
diff --git a/src/platform/dbghelp_syminit_manager.hpp b/src/platform/dbghelp_syminit_manager.hpp
@@ -1,42 +1,21 @@
 #ifndef DBGHELP_SYMINIT_MANAGER_HPP
 #define DBGHELP_SYMINIT_MANAGER_HPP
 
-#include "utils/common.hpp"
-#include "utils/utils.hpp"
-
 #include <unordered_set>
 
-#include <windows.h>
-#include <dbghelp.h>
-
 namespace cpptrace {
 namespace detail {
     struct dbghelp_syminit_manager {
-        std::unordered_set<HANDLE> set;
-
-        ~dbghelp_syminit_manager() {
-            for(auto handle : set) {
-                if(!SymCleanup(handle)) {
-                    ASSERT(false, microfmt::format("Cpptrace SymCleanup failed with code {}\n", GetLastError()).c_str());
-                }
-            }
-        }
+        // The set below contains Windows `HANDLE` objects, `void*` is used to avoid 
+        // including the (expensive) Windows header here
+        std::unordered_set<void*> set;
 
-        void init(HANDLE proc) {
-            if(set.count(proc) == 0) {
-                if(!SymInitialize(proc, NULL, TRUE)) {
-                    throw internal_error("SymInitialize failed {}", GetLastError());
-                }
-                set.insert(proc);
-            }
-        }
+        ~dbghelp_syminit_manager();
+        void init(void* proc);
     };
 
     // Thread-safety: Must only be called from symbols_with_dbghelp while the dbghelp_lock lock is held
-    inline dbghelp_syminit_manager& get_syminit_manager() {
-        static dbghelp_syminit_manager syminit_manager;
-        return syminit_manager;
-    }
+    dbghelp_syminit_manager& get_syminit_manager();
 }
 }
 

diff --git a/src/platform/path.hpp b/src/platform/path.hpp
@@ -1,10 +1,13 @@
 #ifndef PATH_HPP
 #define PATH_HPP
 
-#include "utils/common.hpp"
 #include "platform/platform.hpp"
 
+#include <string>
+#include <cctype>
+
 #if IS_WINDOWS
+#define WIN32_LEAN_AND_MEAN
 #include <windows.h>
 #endif
 

diff --git a/src/platform/program_name.hpp b/src/platform/program_name.hpp
@@ -7,6 +7,7 @@
 #include "platform/platform.hpp"
 
 #if IS_WINDOWS
+#define WIN32_LEAN_AND_MEAN
 #include <windows.h>
 
 #define CPPTRACE_MAX_PATH MAX_PATH

diff --git a/src/snippets/snippet.cpp b/src/snippets/snippet.cpp
@@ -9,6 +9,7 @@
 #include <iostream>
 
 #include "utils/common.hpp"
+#include "utils/microfmt.hpp"
 #include "utils/utils.hpp"
 
 namespace cpptrace {