Make Event Tracing for Windows optional and allow to build dxcompiler target with ETW disabled

Author: AnastaZIuk

CMakeLists.txt

@@ -109,6 +109,13 @@ mark_as_advanced(DXC_DISABLE_ALLOCATOR_OVERRIDES)
 option(DXC_CODEGEN_EXCEPTIONS_TRAP "An exception in code generation generates a trap, ending the compiler process" OFF)
 mark_as_advanced(DXC_CODEGEN_EXCEPTIONS_TRAP)
 
+option(DXC_ENABLE_ETW "Compile with ETW Tracing" ON)
+mark_as_advanced(DXC_ENABLE_ETW)
+
+if(DXC_ENABLE_ETW)
+  add_compile_definitions(DXC_ENABLE_ETW)
+endif()
+
 # adjust link option to enable debugging from kernel mode; not compatible with incremental linking
 if(NOT CMAKE_VERSION VERSION_LESS "3.13" AND MSVC AND NOT CMAKE_C_COMPILER_ARCHITECTURE_ID STREQUAL "ARM64EC")
   add_link_options(/DEBUGTYPE:CV,FIXUP,PDATA /INCREMENTAL:NO)

include/dxc/WinAdapter.h

@@ -197,19 +197,8 @@
 #define OutputDebugStringA(msg) fputs(msg, stderr)
 #define OutputDebugFormatA(...) fprintf(stderr, __VA_ARGS__)
 
-// Event Tracing for Windows (ETW) provides application programmers the ability
-// to start and stop event tracing sessions, instrument an application to
-// provide trace events, and consume trace events.
-#define DxcEtw_DXCompilerCreateInstance_Start()
-#define DxcEtw_DXCompilerCreateInstance_Stop(hr)
-#define DxcEtw_DXCompilerCompile_Start()
-#define DxcEtw_DXCompilerCompile_Stop(hr)
-#define DxcEtw_DXCompilerDisassemble_Start()
-#define DxcEtw_DXCompilerDisassemble_Stop(hr)
-#define DxcEtw_DXCompilerPreprocess_Start()
-#define DxcEtw_DXCompilerPreprocess_Stop(hr)
-#define DxcEtw_DxcValidation_Start()
-#define DxcEtw_DxcValidation_Stop(hr)
+// I have no idea if I don't break something like INSTALL targets, requires CI tests
+#include "WinEtwAdapter.h"
 
 #define UInt32Add UIntAdd
 #define Int32ToUInt32 IntToUInt

include/dxc/WinEtwAdapter.h

@@ -0,0 +1,33 @@
+//===- WinEtwAdapter.h - Windows ETW Adapter, stub -*- C++ -*-===//
+//
+//                     The LLVM Compiler Infrastructure
+//
+// This file is distributed under the University of Illinois Open Source
+// License. See LICENSE.TXT for details.
+//
+//===----------------------------------------------------------------------===//
+
+#ifndef LLVM_SUPPORT_WIN_ETW_ADAPTER_H
+#define LLVM_SUPPORT_WIN_ETW_ADAPTER_H
+
+// Event Tracing for Windows (ETW) provides application programmers the ability
+// to start and stop event tracing sessions, instrument an application to
+// provide trace events, and consume trace events.
+#define EventRegisterMicrosoft_Windows_DXCompiler_API()
+#define EventUnregisterMicrosoft_Windows_DXCompiler_API()
+#define DxcEtw_DXCompilerCreateInstance_Start()
+#define DxcEtw_DXCompilerCreateInstance_Stop(hr)
+#define DxcEtw_DXCompilerInitialization_Start()
+#define DxcEtw_DXCompilerInitialization_Stop(hr)
+#define DxcEtw_DXCompilerShutdown_Start()
+#define DxcEtw_DXCompilerShutdown_Stop(hr)
+#define DxcEtw_DXCompilerCompile_Start()
+#define DxcEtw_DXCompilerCompile_Stop(hr)
+#define DxcEtw_DXCompilerDisassemble_Start()
+#define DxcEtw_DXCompilerDisassemble_Stop(hr)
+#define DxcEtw_DXCompilerPreprocess_Start()
+#define DxcEtw_DXCompilerPreprocess_Stop(hr)
+#define DxcEtw_DxcValidation_Start()
+#define DxcEtw_DxcValidation_Stop(hr)
+
+#endif // LLVM_SUPPORT_WIN_ETW_ADAPTER_H

projects/dxilconv/tools/dxilconv/dxilconv.cpp

@@ -23,7 +23,11 @@
 #include "dxc/config.h"
 #include "dxc/dxcisense.h"
 #include "dxc/dxctools.h"
+#ifdef DXC_ENABLE_ETW
 #include "dxcetw.h"
+#else
+#include "dxc/WinEtwAdapter.h"
+#endif // DXC_ENABLE_ETW
 
 #include "DxbcConverter.h"
 

tools/clang/tools/dxcompiler/CMakeLists.txt

@@ -128,7 +128,8 @@ endif (MSVC)
 
 add_clang_library(dxcompiler SHARED ${SOURCES})
 add_dependencies(dxcompiler TablegenHLSLOptions) 
-if (MSVC)
+
+if (MSVC AND DXC_ENABLE_ETW)
   # No DxcEtw on non-Windows platforms.
   add_dependencies(dxcompiler DxcEtw)
 endif()

tools/clang/tools/dxcompiler/DXCompiler.cpp

@@ -17,7 +17,11 @@
 #include "llvm/Support/FileSystem.h"
 #include "llvm/Support/ManagedStatic.h"
 #ifdef LLVM_ON_WIN32
+#ifdef DXC_ENABLE_ETW
 #include "dxcetw.h"
+#else
+#include "dxc/WinEtwAdapter.h"
+#endif // DXC_ENABLE_ETW
 #endif
 #include "dxillib.h"
 

tools/clang/tools/dxcompiler/DXCompiler.rc

@@ -11,4 +11,6 @@
 #define VER_ORIGINALFILENAME_STR      "DXCompiler.dll"
 
 // #include <common.ver>
+#ifdef DXC_ENABLE_ETW
 #include "dxcetw.rc"
+#endif

tools/clang/tools/dxcompiler/dxcapi.cpp

@@ -22,7 +22,11 @@
 #include "dxc/dxcisense.h"
 #include "dxc/dxctools.h"
 #ifdef _WIN32
+#ifdef DXC_ENABLE_ETW
 #include "dxcetw.h"
+#else
+#include "dxc/WinEtwAdapter.h"
+#endif // DXC_ENABLE_ETW
 #endif
 #include "dxc/DxilContainer/DxcContainerBuilder.h"
 #include "dxillib.h"

tools/clang/tools/dxcompiler/dxcompilerobj.cpp

@@ -51,7 +51,11 @@
 #include "dxc/Support/microcom.h"
 
 #ifdef _WIN32
+#ifdef DXC_ENABLE_ETW
 #include "dxcetw.h"
+#else
+#include "dxc/WinEtwAdapter.h"
+#endif // DXC_ENABLE_ETW
 #endif
 #include "dxcompileradapter.h"
 #include "dxcshadersourceinfo.h"

tools/clang/tools/dxcvalidator/dxcvalidator.cpp

@@ -27,7 +27,11 @@
 #include "dxc/Support/dxcapi.impl.h"
 
 #ifdef _WIN32
+#ifdef DXC_ENABLE_ETW
 #include "dxcetw.h"
+#else
+#include "dxc/WinEtwAdapter.h"
+#endif // DXC_ENABLE_ETW
 #endif
 
 using namespace llvm;