Skip to content

New logger and remove code bloat#443

Open
rwmcguir wants to merge 19 commits into
oneapi-src:masterfrom
rwmcguir:new_logger
Open

New logger and remove code bloat#443
rwmcguir wants to merge 19 commits into
oneapi-src:masterfrom
rwmcguir:new_logger

Conversation

@rwmcguir
Copy link
Copy Markdown
Contributor

@rwmcguir rwmcguir commented Apr 21, 2026

This removes all dependencies on external code for logging purposes.
Removes all static globals resulting in gnu unique symbols

Retains external interface behaivor

@rwmcguir rwmcguir requested review from Jemale, Copilot and nrspruit April 21, 2026 06:01
Copilot AI reviewed Apr 21, 2026
View reviewed changes
Copy link
Copy Markdown

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

This PR replaces the loader’s spdlog-based logging with a built-in logger implementation, removes the vendored spdlog headers and build wiring, and updates loader/layer integration to share a single logger instance.

Changes:

  • Remove vendored spdlog headers (and related CMake configuration) to eliminate external logging dependencies.
  • Introduce ZeLogger (source/utils/ze_logger.*) and migrate loader + validation layer to use it (including logger sharing between loader and validation layer).
  • Update documentation and version metadata to reflect the new logging behavior/configuration.

Reviewed changes

Copilot reviewed 64 out of 66 changed files in this pull request and generated 7 comments.

Show a summary per file
File Description
third_party/spdlog_headers/spdlog/version.h Remove vendored spdlog header
third_party/spdlog_headers/spdlog/tweakme.h Remove vendored spdlog header
third_party/spdlog_headers/spdlog/spdlog.h Remove vendored spdlog header
third_party/spdlog_headers/spdlog/spdlog-inl.h Remove vendored spdlog header
third_party/spdlog_headers/spdlog/sinks/wincolor_sink.h Remove vendored spdlog header
third_party/spdlog_headers/spdlog/sinks/wincolor_sink-inl.h Remove vendored spdlog header
third_party/spdlog_headers/spdlog/sinks/sink.h Remove vendored spdlog header
third_party/spdlog_headers/spdlog/sinks/sink-inl.h Remove vendored spdlog header
third_party/spdlog_headers/spdlog/sinks/basic_file_sink.h Remove vendored spdlog header
third_party/spdlog_headers/spdlog/sinks/basic_file_sink-inl.h Remove vendored spdlog header
third_party/spdlog_headers/spdlog/sinks/base_sink.h Remove vendored spdlog header
third_party/spdlog_headers/spdlog/sinks/base_sink-inl.h Remove vendored spdlog header
third_party/spdlog_headers/spdlog/sinks/ansicolor_sink.h Remove vendored spdlog header
third_party/spdlog_headers/spdlog/sinks/ansicolor_sink-inl.h Remove vendored spdlog header
third_party/spdlog_headers/spdlog/pattern_formatter.h Remove vendored spdlog header
third_party/spdlog_headers/spdlog/pattern_formatter-inl.h Remove vendored spdlog header
third_party/spdlog_headers/spdlog/mdc.h Remove vendored spdlog header
third_party/spdlog_headers/spdlog/logger.h Remove vendored spdlog header
third_party/spdlog_headers/spdlog/logger-inl.h Remove vendored spdlog header
third_party/spdlog_headers/spdlog/formatter.h Remove vendored spdlog header
third_party/spdlog_headers/spdlog/fmt/fmt.h Remove vendored spdlog header
third_party/spdlog_headers/spdlog/details/windows_include.h Remove vendored spdlog header
third_party/spdlog_headers/spdlog/details/synchronous_factory.h Remove vendored spdlog header
third_party/spdlog_headers/spdlog/details/registry.h Remove vendored spdlog header
third_party/spdlog_headers/spdlog/details/registry-inl.h Remove vendored spdlog header
third_party/spdlog_headers/spdlog/details/periodic_worker.h Remove vendored spdlog header
third_party/spdlog_headers/spdlog/details/periodic_worker-inl.h Remove vendored spdlog header
third_party/spdlog_headers/spdlog/details/os.h Remove vendored spdlog header
third_party/spdlog_headers/spdlog/details/os-inl.h Remove vendored spdlog header
third_party/spdlog_headers/spdlog/details/null_mutex.h Remove vendored spdlog header
third_party/spdlog_headers/spdlog/details/log_msg_buffer.h Remove vendored spdlog header
third_party/spdlog_headers/spdlog/details/log_msg_buffer-inl.h Remove vendored spdlog header
third_party/spdlog_headers/spdlog/details/log_msg.h Remove vendored spdlog header
third_party/spdlog_headers/spdlog/details/log_msg-inl.h Remove vendored spdlog header
third_party/spdlog_headers/spdlog/details/fmt_helper.h Remove vendored spdlog header
third_party/spdlog_headers/spdlog/details/file_helper.h Remove vendored spdlog header
third_party/spdlog_headers/spdlog/details/file_helper-inl.h Remove vendored spdlog header
third_party/spdlog_headers/spdlog/details/console_globals.h Remove vendored spdlog header
third_party/spdlog_headers/spdlog/details/circular_q.h Remove vendored spdlog header
third_party/spdlog_headers/spdlog/details/backtracer.h Remove vendored spdlog header
third_party/spdlog_headers/spdlog/details/backtracer-inl.h Remove vendored spdlog header
third_party/spdlog_headers/spdlog/common.h Remove vendored spdlog header
third_party/spdlog_headers/spdlog/common-inl.h Remove vendored spdlog header
third_party/spdlog_headers/README.md Remove spdlog vendoring note
third_party/spdlog_headers/LICENSE Remove spdlog license file (dependency removed)
third_party/spdlog_headers/.version Remove spdlog version pin file
source/utils/ze_logger.h Add new logger public interface
source/utils/ze_logger.cpp Add new logger implementation + env-driven factory
source/utils/logging.h Remove old spdlog-based Logger wrapper
source/utils/logging.cpp Remove old spdlog-based to_string implementation file
source/utils/CMakeLists.txt Build utils with ZeLogger sources (remove spdlog wiring)
source/loader/ze_loader_internal.h Switch loader context to ZeLogger
source/loader/ze_loader_api.h Add exported accessor for shared logger
source/loader/ze_loader_api.cpp Implement exported accessor for shared logger
source/loader/ze_loader.cpp Use new createLogger, improve debug trace path reporting, update version logging
source/lib/ze_lib.h Switch includes to ZeLogger (add missing STL include)
source/lib/ze_lib.cpp Improve debug trace message when loader path not set
source/layers/validation/ze_validation_layer.h Switch validation layer to ZeLogger
source/layers/validation/ze_validation_layer.cpp Add loader-provided logger injection API + no-op sentinel logger
scripts/templates/ze_loader_internal.h.mako Remove spdlog include from template (but still references logging.h)
README.md Update user documentation for new built-in logging behavior
PRODUCT_GUID.txt Bump product version/GUID
CMakeLists.txt Remove global spdlog discovery/include configuration

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread source/utils/ze_logger.cpp Outdated
Comment thread source/utils/ze_logger.cpp
Comment thread source/utils/ze_logger.cpp Outdated
Comment thread source/utils/ze_logger.cpp Outdated
Comment thread scripts/templates/ze_loader_internal.h.mako Outdated
Comment thread source/loader/ze_loader_api.h Outdated
Comment thread source/loader/ze_loader_api.cpp Outdated
@rwmcguir rwmcguir force-pushed the new_logger branch 2 times, most recently from 64de0c9 to 2233385 Compare April 21, 2026 20:27
@Jemale
Copy link
Copy Markdown
Contributor

Jemale commented Apr 21, 2026

Took a look at the removed code and some of the additions, looks good. Will continue reviewing tomorrow probably

Jemale
Jemale reviewed Apr 27, 2026
View reviewed changes
Copy link
Copy Markdown
Contributor

@Jemale Jemale left a comment

Choose a reason for hiding this comment

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

looks good to me

Comment thread source/utils/ze_logger.h Outdated
Comment thread source/utils/ze_logger.cpp Outdated
nrspruit
nrspruit reviewed Apr 28, 2026
View reviewed changes
Comment thread PRODUCT_GUID.txt Outdated
@rwmcguir rwmcguir requested a review from Copilot April 28, 2026 22:36
Copilot AI reviewed Apr 28, 2026
View reviewed changes
Copy link
Copy Markdown

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

Copilot reviewed 69 out of 72 changed files in this pull request and generated 3 comments.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread source/utils/ze_logger.h
Comment thread source/utils/ze_logger.cpp Outdated
Comment thread source/loader/ze_loader.cpp
rwmcguir added 16 commits May 13, 2026 14:39
@rwmcguir
First version of removing spdlog
85073d4 
Signed-off-by: Russell McGuire <russell.w.mcguire@intel.com>
@rwmcguir
Remove spdlog files from repo
4e5bac0 
Signed-off-by: Russell McGuire <russell.w.mcguire@intel.com>
@rwmcguir
Removed all mention of spdlog and added PID %P
6a88f03 
Signed-off-by: Russell McGuire <russell.w.mcguire@intel.com>
@rwmcguir
Minor logging performance enhancements
a286308 
Signed-off-by: Russell McGuire <russell.w.mcguire@intel.com>
@rwmcguir
Remove loggin wrapper, as no longer necessary
aa5eb4d 
+ Also update missing ZE_RESULT codes from older logger

Signed-off-by: Russell McGuire <russell.w.mcguire@intel.com>
@rwmcguir
Updates to log file format printing, showing settings
ccac922 
Signed-off-by: Russell McGuire <russell.w.mcguire@intel.com>
@rwmcguir
Minor clean up in output text for Liibrary Path
9523e84 
Signed-off-by: Russell McGuire <russell.w.mcguire@intel.com>
@rwmcguir
Update docs to reflect default logging behavior
7993f0f 
Signed-off-by: Russell McGuire <russell.w.mcguire@intel.com>
@rwmcguir
Remove log filename deprecation
0a0a124 
Signed-off-by: Russell McGuire <russell.w.mcguire@intel.com>
@rwmcguir
Improve shared library loading path output
b726db5 
Fix logger debug outout showing which actual files are loaded
after path resolution. Without this not useful for debugging
misconfigured systems.

Signed-off-by: Russell McGuire <russell.w.mcguire@intel.com>
@rwmcguir
Enable ze_logger creation caller printing
623ba4e 
Signed-off-by: Russell McGuire <russell.w.mcguire@intel.com>
@rwmcguir
Exported main logger context for use in other layers
923ae3c 
Signed-off-by: Russell McGuire <russell.w.mcguire@intel.com>
@rwmcguir
Remove duplicate logger when used with static+dyanmic
5a7071e 
+ Change from a pull to a push model, to push the logger instance
  from the loader to the validation layer to remove duplication.
+ Remove resource consumption when no logger is used

Signed-off-by: Russell McGuire <russell.w.mcguire@intel.com>
@rwmcguir
Minor cleanup of logging issues
494ab7c 
+ Removed references in mako files to old logger
+ Removed some dead code
+ Fixed recursive log directory creation corner case

Signed-off-by: Russell McGuire <russell.w.mcguire@intel.com>
@rwmcguir
Switch to using shared_ptr to avoid unique symbols
b10e114 
Signed-off-by: Russell McGuire <russell.w.mcguire@intel.com>
@rwmcguir
Fixed teardown race condition w/static loader
ab9f205 
Signed-off-by: Russell McGuire <russell.w.mcguire@intel.com>
rwmcguir added 2 commits May 13, 2026 14:39
@rwmcguir
Update for review comments
2f75d73 
-Remove verbage and boolean for optional stderr mirroring
-Replace fd 2 w/define

Signed-off-by: Russell McGuire <russell.w.mcguire@intel.com>
@rwmcguir
Restore some of ZE_ENABLE_LOADER_DEBUG_TRACE
7e9cff8 
Signed-off-by: Russell McGuire <russell.w.mcguire@intel.com>
@rwmcguir
Re-add Legacy output retention and =2 options
7de6425 
+ Change logging enablement modes to support =2
  ZE_ENABLE_LOADER_DEBUG_TRACE=1 retains behavior
  ZE_ENABLE_LOADER_DEBUG_TRACE=2 enables enhanced output
  The same for ZEL_ENABLE_LOADER_LOGGING=1 and =2

+ This will allow for improved transition while we get LLVM
  corrected.

Signed-off-by: Russell McGuire <russell.w.mcguire@intel.com>
@rwmcguir
Copy link
Copy Markdown
Contributor Author

rwmcguir commented May 15, 2026

Latest update has extension .diff comparisons between this branch and master. It retains 99% identical output with two exceptions in that "ZEL_LOADER_LOG_FILE will be deprecated in a future release" is no longer being printed as we are NOT deprecating this functionality. Also a single error message was improved, but this should never arise under normal conditions:

-Unable to create log file: Failed opening file /root/static-5_permission_test.log for writing: Permission denied
+ze_logger: Unable to open log file '/root/static-5_permission_test.log': Permission denied

If this occurs, then it should break anyway.

With =2 in either mode enhance prints will occur like this:

OLD =1

[2026-05-14 22:32:12.342] [thread-id: 127544294377344] [info] Loader Version 1.28.6 7e9cff8f125a51f36fbc8a91fe2888f716a2bb52
[2026-05-14 22:32:12.342] [thread-id: 127544294377344] [trace] Using Loader Library Path: 
[2026-05-14 22:32:12.342] [thread-id: 127544294377344] [trace] DDI Driver Extension Path is Enabled
[2026-05-14 22:32:12.342] [thread-id: 127544294377344] [info] Enabling Null Driver
[2026-05-14 22:32:12.342] [thread-id: 127544294377344] [trace] ze_null Driver Init
[2026-05-14 22:32:12.342] [thread-id: 127544294377344] [trace] Tracing Layer Library Path: libze_tracing_layer.so.1
[2026-05-14 22:32:12.342] [thread-id: 127544294377344] [info] zeInit succeeded

NEW =2

[2026-05-14 22:32:12.410] [thread-id: 129362209138560] [info] Dynamic Loader logging enabled:
  ZEL_LOADER_LOG_CONSOLE          : disabled
  ZEL_ENABLE_LOADER_LOGGING        : enabled
  ZEL_LOADER_LOGGING_LEVEL         : trace
  ZEL_LOADER_LOG_DIR               : /home/rwmcguir/src/level-zero/build/log_test
  ZEL_LOADER_LOG_FILE              : dynamic-1_file-ZE_ENABLE_LOADER_DEBUG_TRACE-2.log
  ZEL_LOADER_LOG_PATTERN           : [%Y-%m-%d %H:%M:%S.%e] [thread-id: %t] [%^%l%$] %v
  Output                           : /home/rwmcguir/src/level-zero/build/log_test/dynamic-1_file-ZE_ENABLE_LOADER_DEBUG_TRACE-2.log
[2026-05-14 22:32:12.410] [thread-id: 129362209138560] [info] Loader Version 1.28.6 7e9cff8f125a51f36fbc8a91fe2888f716a2bb52
[2026-05-14 22:32:12.410] [thread-id: 129362209138560] [trace] Using Loader Library Path: Not set
[2026-05-14 22:32:12.410] [thread-id: 129362209138560] [trace] DDI Driver Extension Path is Enabled
[2026-05-14 22:32:12.410] [thread-id: 129362209138560] [info] Enabling Null Driver
[2026-05-14 22:32:12.410] [thread-id: 129362209138560] [trace] Null Driver Library Path (requested): libze_null.so.1
[2026-05-14 22:32:12.410] [thread-id: 129362209138560] [trace] Null Driver Library Path (resolved): /home/rwmcguir/src/level-zero/build/dynamic/lib/libze_null.so.1
[2026-05-14 22:32:12.410] [thread-id: 129362209138560] [trace] Tracing Layer Library Path (requested): libze_tracing_layer.so.1
[2026-05-14 22:32:12.410] [thread-id: 129362209138560] [trace] Tracing Layer Library Path (resolved): /home/rwmcguir/src/level-zero/build/dynamic/lib/libze_tracing_layer.so.1
[2026-05-14 22:32:12.410] [thread-id: 129362209138560] [info] zeInit succeeded

Note the enhanced file path resolution printing, headers being printed with modes enabled, etc...

nrspruit
nrspruit approved these changes May 15, 2026
View reviewed changes
Copy link
Copy Markdown
Contributor

@nrspruit nrspruit left a comment

Choose a reason for hiding this comment

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

LGTM!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@Jemale Jemale Jemale left review comments

Copilot code review Copilot Copilot left review comments

@nrspruit nrspruit nrspruit approved these changes

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

4 participants

@rwmcguir @Jemale @nrspruit