Make Event Tracing for Windows optional

[AnastaZIuk]

The Microsoft Message Compiler dependency in the build system makes it impossible to build the project on Windows Nano Server, due to COM not being available in that distribution.

This PR resolves the issue by patching the build system to make ETW optional. It disables the tracing when DXC_ENABLE_ETW is turned off, using the same logic already applied when building for non-Windows platforms. When disabled, the code falls back to empty stubs.

This PR is a work in progress - currently, only the dxcompiler target has been built with MSVC 14.42.34433 and WinSDK 22621. A few links in case:

• Github Actions with the dxcompiler build log (Nano Server LTSC2022 container)
• System environment Dockerfile setup
• CMake toolchain file
• CMake configuration options

The ETW manifest (dxcetw.man) is the only input for mc.exe. Its output includes a header and some .bin files (e.g., MSG00001.bin, dxcetwTEMP.bin after some copies in the custom command) but only the header (dxcetw.h) seems to be functionally required for building and please correct me if I'm wrong. The .bin files are generated and marked in CMake as GENERATED but

• they are not referenced in any resource .rc or included in any target
• their presence appears to be unused: search 1, 2, 3

so, would it make sense to commit the generated header directly into version control instead? It seems to be fully deterministic

[github-actions]

⚠️ C/C++ code formatter, clang-format found issues in your code. ⚠️

You can test this locally with the following command:

git-clang-format --diff 206b77577d15fc5798eb7ad52290388539b7146d 62b74063e55ea1f53aa46396556d7d7214daa77c -- include/dxc/WinEtwAdapter.h include/dxc/WinAdapter.h projects/dxilconv/tools/dxilconv/dxilconv.cpp tools/clang/tools/dxcompiler/DXCompiler.cpp tools/clang/tools/dxcompiler/dxcapi.cpp tools/clang/tools/dxcompiler/dxcompilerobj.cpp tools/clang/tools/dxcvalidator/dxcvalidator.cpp tools/clang/tools/dxildll/dxildll.cpp tools/clang/tools/dxrfallbackcompiler/DXCompiler.cpp tools/clang/tools/dxrfallbackcompiler/dxcapi.cpp

View the diff from clang-format here.

diff --git a/include/dxc/WinAdapter.h b/include/dxc/WinAdapter.h
index 6c7fa254..45d23c6c 100644
--- a/include/dxc/WinAdapter.h
+++ b/include/dxc/WinAdapter.h
@@ -197,7 +197,8 @@
 #define OutputDebugStringA(msg) fputs(msg, stderr)
 #define OutputDebugFormatA(...) fprintf(stderr, __VA_ARGS__)
 
-// I have no idea if I don't break something like INSTALL targets, requires CI tests
+// I have no idea if I don't break something like INSTALL targets, requires CI
+// tests
 #include "WinEtwAdapter.h"
 
 #define UInt32Add UIntAdd

• Check this box to apply formatting changes to this branch.

[AnastaZIuk]

@microsoft-github-policy-service agree company="Devsh Graphics Programming Sp. z O.O."

[llvm-beanz]

Cascading this across the codebase is undesirable. By design, the WinAdapter header can (and usually is) included whether or not you're on Windows. On Windows it just includes system headers.

It is probably a better approach to just update the WinAdapter to include the ETW adapters if ETW is not available (even on Windows). That avoids the need for a new header and simplifies this change significantly.