Add backtraces to examples (#5973)

* examples: Log stack trace on exceptions For now, this is only implemented on Windows. This helps to address #5520. * examples: Print log file if there is any * format code --------- Co-authored-by: slangbot <[email protected]> Co-authored-by: Yong He <[email protected]>
shader-slang · Jan 8, 2025 · 5b99314 · 5b99314
1 parent c43f6fa
commit 5b99314
Show file tree

Hide file tree

Showing 22 changed files with 324 additions and 33 deletions.
diff --git a/.github/workflows/ci-examples.sh b/.github/workflows/ci-examples.sh
@@ -170,6 +170,9 @@ function run_sample {
   pushd "$bin_dir" 1>/dev/null 2>&1
   if [[ ! "$dry_run" = true ]]; then
     ./"$sample" "${args[@]}" || result=$?
+    if [[ -f ./"log-$sample.txt" ]]; then
+      cat ./"log-$sample.txt"
+    fi
   fi
   if [[ $result -eq 0 ]]; then
     summary=("${summary[@]}" "  success")

diff --git a/examples/CMakeLists.txt b/examples/CMakeLists.txt
@@ -1,4 +1,6 @@
 function(example dir)
+    cmake_parse_arguments(ARG "WIN32_EXECUTABLE" "" "" ${ARGN})
+
     set(debug_dir ${CMAKE_CURRENT_BINARY_DIR}/${dir})
 
     file(
@@ -30,6 +32,22 @@ function(example dir)
         )
     endif()
 
+    # Libraries providing a main function that prints stack traces on exceptions
+    if(CMAKE_SYSTEM_NAME MATCHES "Windows")
+        # On Windows we have two different versions: main for "console applications" and
+        # WinMain for normal Windows applications.
+        if(${ARG_WIN32_EXECUTABLE})
+            set(main_wrapper_libraries example-winmain)
+        else()
+            set(main_wrapper_libraries example-main)
+        endif()
+        # Add stack printing support
+        set(main_wrapper_libraries ${main_wrapper_libraries} stacktrace-windows)
+        set(main_wrapper_libraries ${main_wrapper_libraries} dbghelp.lib)
+    else()
+        set(main_wrapper_libraries example-main)
+    endif()
+
     slang_add_target(
         ${dir}
         EXECUTABLE
@@ -42,7 +60,9 @@ function(example dir)
             gfx-util
             platform
             $<$<BOOL:${SLANG_ENABLE_CUDA}>:CUDA::cuda_driver>
+            ${main_wrapper_libraries}
         EXTRA_COMPILE_DEFINITIONS_PRIVATE
+            SLANG_EXAMPLE_NAME=${dir}
             $<$<BOOL:${SLANG_ENABLE_XLIB}>:SLANG_ENABLE_XLIB>
         REQUIRED_BY all-examples
         OPTIONAL_REQUIRES ${copy_assets_target} copy-prebuilt-binaries
@@ -68,6 +88,9 @@ if(SLANG_ENABLE_EXAMPLES)
             $<$<BOOL:${SLANG_ENABLE_CUDA}>:CUDA::cuda_driver>
         FOLDER examples
     )
+    slang_add_target(example-main STATIC FOLDER examples)
+    slang_add_target(example-winmain STATIC FOLDER examples EXCLUDE_FROM_ALL)
+    slang_add_target(stacktrace-windows STATIC FOLDER examples EXCLUDE_FROM_ALL)
 
     add_custom_target(
         all-examples

diff --git a/examples/autodiff-texture/main.cpp b/examples/autodiff-texture/main.cpp
@@ -823,4 +823,4 @@ struct AutoDiffTexture : public WindowedAppBase
     }
 };
 
-PLATFORM_UI_MAIN(innerMain<AutoDiffTexture>)
+EXAMPLE_MAIN(innerMain<AutoDiffTexture>);
diff --git a/examples/cpu-com-example/main.cpp b/examples/cpu-com-example/main.cpp
@@ -175,7 +175,7 @@ static SlangResult _innerMain(int argc, char** argv)
     return SLANG_OK;
 }
 
-int main(int argc, char** argv)
+int exampleMain(int argc, char** argv)
 {
     return SLANG_SUCCEEDED(_innerMain(argc, argv)) ? 0 : -1;
 }
diff --git a/examples/cpu-hello-world/main.cpp b/examples/cpu-hello-world/main.cpp
@@ -217,7 +217,7 @@ static SlangResult _innerMain(int argc, char** argv)
     return SLANG_OK;
 }
 
-int main(int argc, char** argv)
+int exampleMain(int argc, char** argv)
 {
     return SLANG_SUCCEEDED(_innerMain(argc, argv)) ? 0 : -1;
 }
diff --git a/examples/example-base/example-base.h b/examples/example-base/example-base.h
@@ -10,6 +10,19 @@
 void _Win32OutputDebugString(const char* str);
 #endif
 
+#define SLANG_STRINGIFY(x) #x
+#define SLANG_EXPAND_STRINGIFY(x) SLANG_STRINGIFY(x)
+
+#ifdef _WIN32
+#define EXAMPLE_MAIN(innerMain)                                   \
+    extern const char* const g_logFileName =                      \
+        "log-" SLANG_EXPAND_STRINGIFY(SLANG_EXAMPLE_NAME) ".txt"; \
+    PLATFORM_UI_MAIN(innerMain);
+
+#else
+#define EXAMPLE_MAIN(innerMain) PLATFORM_UI_MAIN(innerMain)
+#endif // _WIN32
+
 struct WindowedAppBase : public TestBase
 {
 protected:

diff --git a/examples/example-main/main.cpp b/examples/example-main/main.cpp
@@ -0,0 +1,32 @@
+#include "../stacktrace-windows/common.h"
+
+#include <stdio.h>
+#include <stdlib.h>
+
+extern int exampleMain(int argc, char** argv);
+
+#if defined(_WIN32)
+
+#include <windows.h>
+
+int main(int argc, char** argv)
+{
+    __try
+    {
+        return exampleMain(argc, argv);
+    }
+    __except (exceptionFilter(stdout, GetExceptionInformation()))
+    {
+        ::exit(1);
+    }
+}
+
+#else // defined(_WIN32)
+
+int main(int argc, char** argv)
+{
+    // TODO: Catch exception and print stack trace also on non-Windows platforms.
+    return exampleMain(argc, argv);
+}
+
+#endif
diff --git a/examples/example-winmain/main.cpp b/examples/example-winmain/main.cpp
@@ -0,0 +1,28 @@
+#include "../stacktrace-windows/common.h"
+
+#include <stdio.h>
+#include <stdlib.h>
+#include <windows.h>
+
+extern int exampleMain(int argc, char** argv);
+extern const char* const g_logFileName;
+
+int WinMain(
+    HINSTANCE /* instance */,
+    HINSTANCE /* prevInstance */,
+    LPSTR /* commandLine */,
+    int /*showCommand*/)
+
+{
+    FILE* logFile = fopen(g_logFileName, "w");
+    __try
+    {
+        int argc = 0;
+        char** argv = nullptr;
+        return exampleMain(argc, argv);
+    }
+    __except (exceptionFilter(logFile, GetExceptionInformation()))
+    {
+        ::exit(1);
+    }
+}
diff --git a/examples/gpu-printing/main.cpp b/examples/gpu-printing/main.cpp
@@ -152,7 +152,7 @@ struct ExampleProgram : public TestBase
     }
 };
 
-int main(int argc, char* argv[])
+int exampleMain(int argc, char** argv)
 {
     ExampleProgram app;
     if (SLANG_FAILED(app.execute(argc, argv)))

diff --git a/examples/hello-world/main.cpp b/examples/hello-world/main.cpp
@@ -66,7 +66,8 @@ struct HelloWorldExample : public TestBase
     ~HelloWorldExample();
 };
 
-int main(int argc, char* argv[])
+
+int exampleMain(int argc, char** argv)
 {
     initDebugCallback();
     HelloWorldExample example;

diff --git a/examples/model-viewer/main.cpp b/examples/model-viewer/main.cpp
@@ -969,4 +969,4 @@ struct ModelViewer : WindowedAppBase
 
 // This macro instantiates an appropriate main function to
 // run the application defined above.
-PLATFORM_UI_MAIN(innerMain<ModelViewer>)
+EXAMPLE_MAIN(innerMain<ModelViewer>);
diff --git a/examples/nv-aftermath-example/main.cpp b/examples/nv-aftermath-example/main.cpp
@@ -599,4 +599,4 @@ void AftermathCrashExample::renderFrame(int frameBufferIndex)
 
 // This macro instantiates an appropriate main function to
 // run the application defined above.
-PLATFORM_UI_MAIN(innerMain<AftermathCrashExample>)
+EXAMPLE_MAIN(innerMain<AftermathCrashExample>)
diff --git a/examples/platform-test/main.cpp b/examples/platform-test/main.cpp
@@ -122,4 +122,4 @@ struct PlatformTest : public WindowedAppBase
 
 // This macro instantiates an appropriate main function to
 // run the application defined above.
-PLATFORM_UI_MAIN(innerMain<PlatformTest>)
+EXAMPLE_MAIN(innerMain<PlatformTest>);
diff --git a/examples/ray-tracing-pipeline/main.cpp b/examples/ray-tracing-pipeline/main.cpp
@@ -712,4 +712,4 @@ struct RayTracing : public WindowedAppBase
 
 // This macro instantiates an appropriate main function to
 // run the application defined above.
-PLATFORM_UI_MAIN(innerMain<RayTracing>)
+EXAMPLE_MAIN(innerMain<RayTracing>);
diff --git a/examples/ray-tracing/main.cpp b/examples/ray-tracing/main.cpp
@@ -676,4 +676,4 @@ struct RayTracing : public WindowedAppBase
 
 // This macro instantiates an appropriate main function to
 // run the application defined above.
-PLATFORM_UI_MAIN(innerMain<RayTracing>)
+EXAMPLE_MAIN(innerMain<RayTracing>);
diff --git a/examples/reflection-api/main.cpp b/examples/reflection-api/main.cpp
@@ -1469,7 +1469,7 @@ struct ExampleProgram : public TestBase
     }
 };
 
-int main(int argc, char* argv[])
+int exampleMain(int argc, char** argv)
 {
     ExampleProgram app;
     if (SLANG_FAILED(app.execute(argc, argv)))

diff --git a/examples/shader-object/main.cpp b/examples/shader-object/main.cpp
@@ -131,7 +131,7 @@ Result loadShaderProgram(
 }
 
 // Main body of the example.
-int main(int argc, char* argv[])
+int exampleMain(int argc, char** argv)
 {
     testBase.parseOption(argc, argv);
 

diff --git a/examples/shader-toy/main.cpp b/examples/shader-toy/main.cpp
@@ -408,4 +408,4 @@ struct ShaderToyApp : public WindowedAppBase
 
 // This macro instantiates an appropriate main function to
 // run the application defined above.
-PLATFORM_UI_MAIN(innerMain<ShaderToyApp>)
+EXAMPLE_MAIN(innerMain<ShaderToyApp>);
-Original file line number
+Diff line change
@@ Expand Up / @@ -823,4 +823,4 @@ struct AutoDiffTexture : public WindowedAppBase @@
         }
     };
-    PLATFORM_UI_MAIN(innerMain<AutoDiffTexture>)
+    EXAMPLE_MAIN(innerMain<AutoDiffTexture>);