Skip to content

Make Event Tracing for Windows optional #7274

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Make Event Tracing for Windows optional #7274

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions CMakeLists.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -107,6 +107,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)
Expand Down
15 changes: 2 additions & 13 deletions include/dxc/WinAdapter.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
33 changes: 33 additions & 0 deletions include/dxc/WinEtwAdapter.h
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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
4 changes: 4 additions & 0 deletions projects/dxilconv/tools/dxilconv/dxilconv.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,11 @@
#include "dxc/config.h"
#include "dxc/dxcisense.h"
#include "dxc/dxctools.h"
#ifdef DXC_ENABLE_ETW
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

#include "dxcetw.h"
#else
#include "dxc/WinEtwAdapter.h"
#endif // DXC_ENABLE_ETW

#include "DxbcConverter.h"

Expand Down
3 changes: 2 additions & 1 deletion tools/clang/tools/dxcompiler/CMakeLists.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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()
Expand Down
4 changes: 4 additions & 0 deletions tools/clang/tools/dxcompiler/DXCompiler.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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"

Expand Down
2 changes: 2 additions & 0 deletions tools/clang/tools/dxcompiler/DXCompiler.rc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,4 +11,6 @@
#define VER_ORIGINALFILENAME_STR "DXCompiler.dll"

// #include <common.ver>
#ifdef DXC_ENABLE_ETW
#include "dxcetw.rc"
#endif
4 changes: 4 additions & 0 deletions tools/clang/tools/dxcompiler/dxcapi.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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"
Expand Down
4 changes: 4 additions & 0 deletions tools/clang/tools/dxcompiler/dxcompilerobj.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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"
Expand Down
4 changes: 4 additions & 0 deletions tools/clang/tools/dxcvalidator/dxcvalidator.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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;
Expand Down
4 changes: 4 additions & 0 deletions tools/clang/tools/dxildll/dxildll.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,8 +23,12 @@
#include "llvm/Support/ManagedStatic.h"
#include <algorithm>
#ifdef _WIN32
#ifdef DXC_ENABLE_ETW
#include "Tracing/DxcRuntimeEtw.h"
#include "dxc/Tracing/dxcetw.h"
#else
#include "dxc/WinEtwAdapter.h"
#endif // DXC_ENABLE_ETW
#endif

#include "dxc/dxcisense.h"
Expand Down
4 changes: 4 additions & 0 deletions tools/clang/tools/dxrfallbackcompiler/DXCompiler.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,11 @@
#include "dxc/Support/Global.h"
#include "dxc/Support/HLSLOptions.h"
#include "dxc/config.h"
#ifdef DXC_ENABLE_ETW
#include "dxcetw.h"
#else
#include "dxc/WinEtwAdapter.h"
#endif // DXC_ENABLE_ETW
#include "dxillib.h"
#include "llvm/Support/FileSystem.h"
#include "llvm/Support/ManagedStatic.h"
Expand Down
2 changes: 2 additions & 0 deletions tools/clang/tools/dxrfallbackcompiler/DXCompiler.rc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,4 +11,6 @@
#define VER_ORIGINALFILENAME_STR "DxrFallbackCompiler.dll"

// #include <common.ver>
#ifdef DXC_ENABLE_ETW
#include "dxcetw.rc"
#endif
4 changes: 4 additions & 0 deletions tools/clang/tools/dxrfallbackcompiler/dxcapi.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,11 @@
#include "dxc/Support/Global.h"
#include "dxc/dxcdxrfallbackcompiler.h"
#include "dxc/dxctools.h"
#ifdef DXC_ENABLE_ETW
#include "dxcetw.h"
#else
#include "dxc/WinEtwAdapter.h"
#endif // DXC_ENABLE_ETW
#include <memory>

HRESULT CreateDxcDxrFallbackCompiler(REFIID riid, LPVOID *ppv);
Expand Down
Loading