refactor: Simplify the include of StateSaveAreaHeader

Related-To: NEO-17009 Signed-off-by: Neil R. Spruit <neil.r.spruit@intel.com>
2025-12-18 13:54:58 +08:00 · 2025-12-11 20:48:00 +00:00
parent 366ef91c23
commit 934b24cbe1
18 changed files with 23 additions and 38 deletions
--- a/CMakeLists.txt
+++ b/CMakeLists.txt
@@ -921,6 +921,7 @@ include_directories(${NEO_SOURCE_DIR})
 include_directories(${NEO_SHARED_DIRECTORY}/command_container/definitions${BRANCH_DIR_SUFFIX})
 include_directories(${NEO_SHARED_DIRECTORY}/command_stream/definitions${BRANCH_DIR_SUFFIX})
 include_directories(${NEO_SHARED_DIRECTORY}/debug_settings/definitions${BRANCH_DIR_SUFFIX})
+include_directories(${NEO_SHARED_DIRECTORY}/debugger/definitions${BRANCH_DIR_SUFFIX})
 include_directories(${NEO_SHARED_DIRECTORY}/dll/devices${BRANCH_DIR_SUFFIX})
 include_directories(${NEO_SHARED_DIRECTORY}/kernel/definitions${BRANCH_DIR_SUFFIX})
 include_directories(${NEO_SHARED_DIRECTORY}/gmm_helper/${DRIVER_MODEL})
--- a/level_zero/core/test/unit_tests/sources/device/test_l0_device.cpp
+++ b/level_zero/core/test/unit_tests/sources/device/test_l0_device.cpp
@@ -7,7 +7,6 @@

 #include "shared/source/command_container/implicit_scaling.h"
 #include "shared/source/command_stream/wait_status.h"
-#include "shared/source/debugger/DebuggerStateSaveHeader.h"
 #include "shared/source/helpers/api_specific_config.h"
 #include "shared/source/helpers/bit_helpers.h"
 #include "shared/source/helpers/compiler_product_helper.h"
@@ -62,6 +61,7 @@
 #include "level_zero/core/test/unit_tests/mocks/mock_memory_manager.h"
 #include "level_zero/driver_experimental/zex_common.h"

+#include "StateSaveAreaHeaderWrapper.h"
 #include "gtest/gtest.h"

 #include <memory>
--- a/level_zero/tools/source/debug/debug_session_imp.h
+++ b/level_zero/tools/source/debug/debug_session_imp.h
@@ -8,12 +8,13 @@
 #pragma once

 #include "shared/source/built_ins/sip.h"
-#include "shared/source/debugger/DebuggerStateSaveHeader.h"
 #include "shared/source/helpers/string.h"

 #include "level_zero/tools/source/debug/debug_session.h"
 #include "level_zero/zet_intel_gpu_debug.h"

+#include "StateSaveAreaHeaderWrapper.h"
+
 #include <atomic>
 #include <chrono>
 #include <cmath>
--- a/level_zero/tools/source/debug/windows/debug_session.cpp
+++ b/level_zero/tools/source/debug/windows/debug_session.cpp
@@ -7,7 +7,6 @@

 #include "level_zero/tools/source/debug/windows/debug_session.h"

-#include "shared/source/debugger/DebuggerStateSaveHeader.h"
 #include "shared/source/device/device.h"
 #include "shared/source/execution_environment/root_device_environment.h"
 #include "shared/source/gmm_helper/gmm_helper.h"
@@ -18,6 +17,8 @@

 #include "level_zero/core/source/gfx_core_helpers/l0_gfx_core_helper.h"

+#include "StateSaveAreaHeaderWrapper.h"
+
 namespace L0 {

 DebugSession *createDebugSessionHelper(const zet_debug_config_t &config, Device *device, int debugFd, void *params);
--- a/level_zero/tools/test/unit_tests/sources/debug/debug_session_common.h
+++ b/level_zero/tools/test/unit_tests/sources/debug/debug_session_common.h
@@ -7,7 +7,6 @@

 #pragma once

-#include "shared/source/debugger/DebuggerStateSaveHeader.h"
 #include "shared/source/debugger/debugger_l0.h"
 #include "shared/source/os_interface/os_interface.h"
 #include "shared/test/common/mocks/mock_device.h"
--- a/level_zero/tools/test/unit_tests/sources/debug/debug_session_tests.cpp
+++ b/level_zero/tools/test/unit_tests/sources/debug/debug_session_tests.cpp
@@ -5,7 +5,6 @@
 *
 */

-#include "shared/source/debugger/DebuggerStateSaveHeader.h"
 #include "shared/source/helpers/gfx_core_helper.h"
 #include "shared/source/sip_external_lib/sip_external_lib.h"
 #include "shared/test/common/libult/global_environment.h"
@@ -27,6 +26,7 @@
 #include "level_zero/tools/test/unit_tests/sources/debug/mock_debug_session.h"
 #include "level_zero/zet_intel_gpu_debug.h"

+#include "StateSaveAreaHeaderWrapper.h"
 #include "encode_surface_state_args.h"

 #include <list>
--- a/level_zero/tools/test/unit_tests/sources/debug/linux/prelim/debug_session_fixtures_linux.h
+++ b/level_zero/tools/test/unit_tests/sources/debug/linux/prelim/debug_session_fixtures_linux.h
@@ -6,7 +6,6 @@
 */

 #pragma once
-#include "shared/source/debugger/DebuggerStateSaveHeader.h"
 #include "shared/source/device/device.h"
 #include "shared/source/os_interface/linux/drm_debug.h"
 #include "shared/source/os_interface/linux/i915_prelim.h"
@@ -26,6 +25,8 @@
 #include "level_zero/tools/test/unit_tests/sources/debug/debug_session_common.h"
 #include "level_zero/tools/test/unit_tests/sources/debug/linux/debug_session_fixtures_linux.h"

+#include "StateSaveAreaHeaderWrapper.h"
+
 #include <atomic>
 #include <queue>
 #include <type_traits>
--- a/level_zero/tools/test/unit_tests/sources/debug/linux/prelim/test_debug_api_linux.cpp
+++ b/level_zero/tools/test/unit_tests/sources/debug/linux/prelim/test_debug_api_linux.cpp
@@ -10,7 +10,6 @@
 // prevent including any other headers to avoid redefinition errors
 #define _I915_DRM_H_

-#include "shared/source/debugger/DebuggerStateSaveHeader.h"
 #include "shared/source/gmm_helper/gmm_helper.h"
 #include "shared/source/helpers/aligned_memory.h"
 #include "shared/source/helpers/basic_math.h"
@@ -42,6 +41,8 @@
 #include "level_zero/tools/test/unit_tests/sources/debug/mock_debug_session.h"
 #include "level_zero/zet_intel_gpu_debug.h"

+#include "StateSaveAreaHeaderWrapper.h"
+
 #include <fcntl.h>

 namespace NEO {
--- a/level_zero/tools/test/unit_tests/sources/debug/linux/xe/debug_session_fixtures_linux_xe.h
+++ b/level_zero/tools/test/unit_tests/sources/debug/linux/xe/debug_session_fixtures_linux_xe.h
@@ -6,7 +6,6 @@
 */

 #pragma once
-#include "shared/source/debugger/DebuggerStateSaveHeader.h"
 #include "shared/source/os_interface/linux/drm_debug.h"
 #include "shared/source/os_interface/linux/xe/eudebug/eudebug_interface_upstream.h"
 #include "shared/source/os_interface/os_interface.h"
@@ -26,6 +25,8 @@
 #include "level_zero/tools/test/unit_tests/sources/debug/debug_session_common.h"
 #include "level_zero/tools/test/unit_tests/sources/debug/linux/debug_session_fixtures_linux.h"

+#include "StateSaveAreaHeaderWrapper.h"
+
 #include <atomic>
 #include <queue>
 #include <type_traits>
--- a/level_zero/tools/test/unit_tests/sources/debug/linux/xe/test_debug_api_linux_xe.cpp
+++ b/level_zero/tools/test/unit_tests/sources/debug/linux/xe/test_debug_api_linux_xe.cpp
@@ -5,7 +5,6 @@
 *
 */

-#include "shared/source/debugger/DebuggerStateSaveHeader.h"
 #include "shared/source/gmm_helper/gmm_helper.h"
 #include "shared/source/helpers/aligned_memory.h"
 #include "shared/source/helpers/basic_math.h"
@@ -42,6 +41,8 @@
 #include "level_zero/tools/test/unit_tests/sources/debug/mock_debug_session.h"
 #include "level_zero/zet_intel_gpu_debug.h"

+#include "StateSaveAreaHeaderWrapper.h"
+
 #include <fcntl.h>
 #include <fstream>
 #include <type_traits>
--- a/level_zero/tools/test/unit_tests/sources/debug/windows/test_debug_api_windows.cpp
+++ b/level_zero/tools/test/unit_tests/sources/debug/windows/test_debug_api_windows.cpp
@@ -6,7 +6,6 @@
 */

 #include "shared/source/built_ins/sip.h"
-#include "shared/source/debugger/DebuggerStateSaveHeader.h"
 #include "shared/source/os_interface/windows/wddm_allocation.h"
 #include "shared/source/os_interface/windows/wddm_debug.h"
 #include "shared/test/common/helpers/stream_capture.h"
@@ -23,6 +22,8 @@
 #include "level_zero/tools/test/unit_tests/sources/debug/debug_session_common.h"
 #include "level_zero/tools/test/unit_tests/sources/debug/mock_debug_session.h"

+#include "StateSaveAreaHeaderWrapper.h"
+
 namespace L0 {
 namespace ult {

--- a/shared/source/built_ins/sip.cpp
+++ b/shared/source/built_ins/sip.cpp
@@ -9,7 +9,6 @@

 #include "shared/source/built_ins/built_ins.h"
 #include "shared/source/debug_settings/debug_settings_manager.h"
-#include "shared/source/debugger/DebuggerStateSaveHeader.h"
 #include "shared/source/debugger/debugger.h"
 #include "shared/source/debugger/debugger_l0.h"
 #include "shared/source/device/device.h"
--- a/shared/source/debugger/DebuggerStateSaveHeader.h
+++ b/shared/source/debugger/DebuggerStateSaveHeader.h
@@ -1,23 +0,0 @@
-/*
- * Copyright (C) 2025 Intel Corporation
- *
- * SPDX-License-Identifier: MIT
- *
- */
-
-#pragma once
-
-#include "config.h"
-
-#include <cstdint>
-
-#ifdef BRANCH_TYPE
-#define STRINGIFY_HELPER(x) #x
-#define STRINGIFY(x) STRINGIFY_HELPER(x)
-// clang-format off
-#define BRANCH_HEADER_PATH STRINGIFY(BRANCH_TYPE/StateSaveAreaHeaderWrapper.h)
-// clang-format on
-#include BRANCH_HEADER_PATH
-#else
-#include "StateSaveAreaHeaderWrapper.h"
-#endif
--- a/shared/source/debugger/debugger_l0.h
+++ b/shared/source/debugger/debugger_l0.h
@@ -11,7 +11,7 @@
 #include "shared/source/memory_manager/address_range.h"
 #include "shared/source/utilities/stackvec.h"

-#include "DebuggerStateSaveHeader.h"
+#include "StateSaveAreaHeaderWrapper.h"

 #include <cstdint>
 #include <memory>
--- a/shared/source/debugger/definitions/StateSaveAreaHeaderWrapper.h
+++ b/shared/source/debugger/definitions/StateSaveAreaHeaderWrapper.h
--- a/shared/test/common/helpers/sip_init.cpp
+++ b/shared/test/common/helpers/sip_init.cpp
@@ -5,7 +5,6 @@
 *
 */

-#include "shared/source/debugger/DebuggerStateSaveHeader.h"
 #include "shared/source/debugger/debugger.h"
 #include "shared/source/device/device.h"
 #include "shared/source/helpers/gfx_core_helper.h"
@@ -13,6 +12,8 @@
 #include "shared/source/memory_manager/memory_manager.h"
 #include "shared/test/common/mocks/mock_sip.h"

+#include "StateSaveAreaHeaderWrapper.h"
+
 namespace NEO {

 namespace MockSipData {
--- a/shared/test/common/mocks/mock_compilers.cpp
+++ b/shared/test/common/mocks/mock_compilers.cpp
@@ -8,7 +8,6 @@
 #include "shared/test/common/mocks/mock_compilers.h"

 #include "shared/source/compiler_interface/compiler_options.h"
-#include "shared/source/debugger/DebuggerStateSaveHeader.h"
 #include "shared/source/helpers/hw_info.h"
 #include "shared/source/os_interface/os_inc_base.h"
 #include "shared/test/common/helpers/mock_file_io.h"
@@ -16,6 +15,7 @@
 #include "shared/test/common/mocks/mock_compiler_interface.h"
 #include "shared/test/common/mocks/mock_sip.h"

+#include "StateSaveAreaHeaderWrapper.h"
 #include "cif/macros/enable.h"
 #include "ocl_igc_interface/fcl_ocl_device_ctx.h"
 #include "ocl_igc_interface/igc_ocl_device_ctx.h"
--- a/shared/test/common/mocks/mock_sip.cpp
+++ b/shared/test/common/mocks/mock_sip.cpp
@@ -7,10 +7,11 @@

 #include "shared/test/common/mocks/mock_sip.h"

-#include "shared/source/debugger/DebuggerStateSaveHeader.h"
 #include "shared/source/helpers/string.h"
 #include "shared/source/memory_manager/memory_allocation.h"

+#include "StateSaveAreaHeaderWrapper.h"
+
 namespace NEO {

 static constexpr SIP::StateSaveAreaHeaderV3 mockSipStateSaveAreaHeaderV3 = {