Move load_symbols_for_file out of experimental:: and add a test program to simulate the scenario

Author: jeremy-rifkin

README.md

@@ -1207,19 +1207,24 @@ This section only applies to the dbghelp backend (`CPPTRACE_GET_SYMBOLS_WITH_DBG
 
 When loading a DLL at runtime with `LoadLibrary` after a stacktrace has already been generated,
 symbols from that library may not be resolved correctly for subsequent stacktraces. To fix this,
-call `cpptrace::experimental::load_symbols_for_file` with the same filename that was passed to
-`LoadLibrary`.
+call `cpptrace::load_symbols_for_file` with the same path that was passed to `LoadLibrary`.
 
 ```cpp
 HMODULE hModule = LoadLibrary("mydll.dll");
 if (hModule) {
-    cpptrace::experimental::load_symbols_for_file("mydll.dll");
+    cpptrace::load_symbols_for_file("mydll.dll");
 }
 ```
 
 For backends other than dbghelp, `load_symbols_for_file` does nothing. For platforms other than
 Windows, it is not declared.
 
+```cpp
+namespace cpptrace {
+    void load_symbols_for_file(const std::string& filename);
+}
+```
+
 # ABI Versioning
 
 Since cpptrace vX, the library uses an inline ABI versioning namespace and all symbols part of the public interface are

include/cpptrace/utils.hpp

@@ -65,9 +65,9 @@ CPPTRACE_BEGIN_NAMESPACE
     }
 
     // dbghelp
-    namespace experimental {
-        CPPTRACE_EXPORT void load_symbols_for_file(const std::string& filename);
-    }
+    #ifdef _MSC_VER
+     CPPTRACE_EXPORT void load_symbols_for_file(const std::string& filename);
+    #endif
 CPPTRACE_END_NAMESPACE
 
 #endif

src/cpptrace.cppm

@@ -101,6 +101,7 @@ CPPTRACE_BEGIN_NAMESPACE
         export using cpptrace::experimental::set_cache_mode;
         export using cpptrace::experimental::set_dwarf_resolver_line_table_cache_size;
         export using cpptrace::experimental::set_dwarf_resolver_disable_aranges;
-        export using cpptrace::experimental::load_symbols_for_file;
     }
+
+    export using cpptrace::load_symbols_for_file;
 CPPTRACE_END_NAMESPACE

src/symbols/symbols_core.cpp

@@ -154,17 +154,3 @@ namespace detail {
     }
 }
 CPPTRACE_END_NAMESPACE
-
-/*
-Fallback definition for cpptrace::experimental::load_symbols_for_file. If
-CPPTRACE_GET_SYMBOLS_WITH_DBGHELP is defined, this function is defined in symbols_with_dbghelp.cpp.
-*/
-#ifndef CPPTRACE_GET_SYMBOLS_WITH_DBGHELP
-CPPTRACE_BEGIN_NAMESPACE
-namespace experimental {
-    void load_symbols_for_file(const std::string& filename) {
-        (void)filename;
-    }
-}
-CPPTRACE_END_NAMESPACE
-#endif

src/symbols/symbols_with_dbghelp.cpp

@@ -451,7 +451,6 @@ namespace dbghelp {
 CPPTRACE_END_NAMESPACE
 
 CPPTRACE_BEGIN_NAMESPACE
-namespace experimental {
     /*
     When a module was loaded at runtime with LoadLibrary after SymInitialize was already called,
     it is necessary to manually load the symbols from that module with SymLoadModuleEx.
@@ -508,7 +507,6 @@ namespace experimental {
             );
         }
     }
-}
 CPPTRACE_END_NAMESPACE
 
 #endif

src/utils.cpp

@@ -89,4 +89,10 @@ CPPTRACE_BEGIN_NAMESPACE
     void register_terminate_handler() {
         std::set_terminate(terminate_handler);
     }
+
+    #if defined(_MSC_VER) && !defined(CPPTRACE_GET_SYMBOLS_WITH_DBGHELP)
+     void load_symbols_for_file(const std::string&) {
+         // nop
+     }
+    #endif
 CPPTRACE_END_NAMESPACE

test/load-library/CMakeLists.txt

@@ -0,0 +1,13 @@
+cmake_minimum_required(VERSION 3.8)
+
+project(module_load_test VERSION 0.0.1 LANGUAGES CXX)
+
+add_subdirectory(${CMAKE_CURRENT_SOURCE_DIR}/../.. ${CMAKE_CURRENT_BINARY_DIR}/cpptrace)
+
+set(CMAKE_WINDOWS_EXPORT_ALL_SYMBOLS ON)
+
+add_library(mydll SHARED mydll.cpp)
+target_include_directories(mydll PUBLIC ${CMAKE_CURRENT_SOURCE_DIR})
+
+add_executable(main main.cpp)
+target_link_libraries(main PUBLIC cpptrace::cpptrace)

test/load-library/main.cpp

@@ -0,0 +1,36 @@
+#include "cpptrace/basic.hpp"
+#include "cpptrace/utils.hpp"
+#include "mydll.hpp"
+
+#include <windows.h>
+
+#include <iostream>
+
+#include <cpptrace/from_current.hpp>
+
+int main() {
+    // generate a trace before LoadLibraryA to initialize dbghelp
+    cpptrace::generate_trace().print();
+
+    HMODULE lib = LoadLibraryA("mydll.dll");
+    if (!lib) {
+        std::cerr << "Failed to load DLL\n";
+        return 1;
+    }
+
+    auto foo = reinterpret_cast<decltype(::foo)*>(GetProcAddress(lib, "foo"));
+    if (!foo) {
+        std::cerr << "Failed to get symbol\n";
+        return 1;
+    }
+
+    cpptrace::load_symbols_for_file("mydll.dll");
+
+    CPPTRACE_TRY {
+        foo();
+    } CPPTRACE_CATCH(...) {
+        cpptrace::from_current_exception().print();
+    }
+
+    FreeLibrary(lib);
+}

test/load-library/mydll.cpp

@@ -0,0 +1,5 @@
+#include "mydll.hpp"
+
+void foo() {
+    throw 0;
+}

test/load-library/mydll.hpp

@@ -0,0 +1,3 @@
+#pragma once
+
+extern "C" void foo();