Add LogicalStateHelper class

Signed-off-by: Bartosz Dunajski <bartosz.dunajski@intel.com>

opencl/source/command_queue/command_queue_hw.h

@@ -10,6 +10,7 @@
 #include "shared/source/command_stream/preemption.h"
 #include "shared/source/helpers/engine_control.h"
 #include "shared/source/helpers/hw_helper.h"
+#include "shared/source/helpers/logical_state_helper.h"
 #include "shared/source/memory_manager/graphics_allocation.h"
 
 #include "opencl/source/cl_device/cl_device.h"
@@ -37,6 +38,8 @@ class CommandQueueHw : public CommandQueue {
                    const cl_queue_properties *properties,
                    bool internalUsage) : BaseClass(context, device, properties, internalUsage) {
 
+        logicalStateHelper.reset(LogicalStateHelper::create<GfxFamily>(true));
+
         auto clPriority = getCmdQueueProperties<cl_queue_priority_khr>(properties, CL_QUEUE_PRIORITY_KHR);
 
         if (clPriority & static_cast<cl_queue_priority_khr>(CL_QUEUE_PRIORITY_LOW_KHR)) {
@@ -502,5 +505,7 @@ class CommandQueueHw : public CommandQueue {
     void setupEvent(EventBuilder &eventBuilder, cl_event *outEvent, uint32_t cmdType);
 
     bool isBlitAuxTranslationRequired(const MultiDispatchInfo &multiDispatchInfo);
+
+    std::unique_ptr<LogicalStateHelper> logicalStateHelper;
 };
 } // namespace NEO

opencl/test/unit_test/command_queue/command_queue_tests.cpp

@@ -10,6 +10,7 @@
 #include "shared/source/helpers/array_count.h"
 #include "shared/source/helpers/basic_math.h"
 #include "shared/source/helpers/engine_node_helper.h"
+#include "shared/source/helpers/logical_state_helper.h"
 #include "shared/source/helpers/timestamp_packet.h"
 #include "shared/source/memory_manager/internal_allocation_storage.h"
 #include "shared/source/memory_manager/memory_manager.h"
@@ -414,6 +415,15 @@ HWTEST_F(CommandQueueCommandStreamTest, givenCommandQueueThatWaitsOnAbortedUserE
     EXPECT_EQ(100u, cmdQ.taskLevel);
 }
 
+HWTEST_F(CommandQueueCommandStreamTest, whenCreatingThenDontCreateLogicalStateHelper) {
+    MockContext context;
+    auto mockDevice = std::make_unique<MockClDevice>(MockDevice::createWithNewExecutionEnvironment<MockDevice>(nullptr));
+
+    MockCommandQueueHw<FamilyType> cmdQ(&context, mockDevice.get(), nullptr);
+
+    EXPECT_EQ(nullptr, cmdQ.logicalStateHelper.get());
+}
+
 HWTEST_F(CommandQueueCommandStreamTest, WhenCheckIsTextureCacheFlushNeededThenReturnProperValue) {
     MockContext context;
     auto mockDevice = std::make_unique<MockClDevice>(MockDevice::createWithNewExecutionEnvironment<MockDevice>(nullptr));

opencl/test/unit_test/command_stream/command_stream_receiver_hw_1_tests.cpp

@@ -10,6 +10,7 @@
 #include "shared/source/command_stream/scratch_space_controller_base.h"
 #include "shared/source/command_stream/wait_status.h"
 #include "shared/source/helpers/constants.h"
+#include "shared/source/helpers/logical_state_helper.h"
 #include "shared/source/os_interface/hw_info_config.h"
 #include "shared/test/common/helpers/debug_manager_state_restore.h"
 #include "shared/test/common/helpers/engine_descriptor_helper.h"
@@ -489,6 +490,11 @@ HWTEST_F(UltCommandStreamReceiverTest, givenMultiplePartitionsWhenCallingWaitKmd
     EXPECT_EQ(2u, commandStreamReceiver.waitForCompletionWithTimeoutTaskCountCalled);
 }
 
+HWTEST_F(UltCommandStreamReceiverTest, whenCreatingThenDontCreateLogicalStateHelper) {
+    auto &commandStreamReceiver = pDevice->getUltCommandStreamReceiver<FamilyType>();
+    EXPECT_EQ(nullptr, commandStreamReceiver.logicalStateHelper.get());
+}
+
 typedef UltCommandStreamReceiverTest CommandStreamReceiverFlushTests;
 
 HWTEST_F(CommandStreamReceiverFlushTests, WhenAddingBatchBufferEndThenBatchBufferEndIsAppendedCorrectly) {

opencl/test/unit_test/helpers/hw_helper_tests.cpp

@@ -11,6 +11,7 @@
 #include "shared/source/gmm_helper/gmm_helper.h"
 #include "shared/source/gmm_helper/resource_info.h"
 #include "shared/source/helpers/aligned_memory.h"
+#include "shared/source/helpers/logical_state_helper.h"
 #include "shared/source/helpers/pipe_control_args.h"
 #include "shared/source/helpers/string.h"
 #include "shared/source/memory_manager/graphics_allocation.h"
@@ -1467,3 +1468,10 @@ HWTEST_F(HwHelperTest, givenHwHelperWhenPassingLinkedCopyEngineTypeThenItsCopyOn
 HWTEST_F(HwHelperTest, givenHwHelperWhenPassingComputeEngineTypeThenItsNotCopyOnly) {
     EXPECT_FALSE(EngineHelper::isCopyOnlyEngineType(EngineGroupType::Compute));
 }
+
+using LogicalStateHelperTest = ::testing::Test;
+
+HWTEST_F(LogicalStateHelperTest, whenCreatingLogicalStateHelperThenReturnNullptr) {
+    EXPECT_EQ(nullptr, LogicalStateHelper::create<FamilyType>(true));
+    EXPECT_EQ(nullptr, LogicalStateHelper::create<FamilyType>(false));
+}

opencl/test/unit_test/mocks/mock_command_queue.h

@@ -243,6 +243,7 @@ class MockCommandQueueHw : public CommandQueueHw<GfxFamily> {
     using BaseClass::gpgpuEngine;
     using BaseClass::isBlitAuxTranslationRequired;
     using BaseClass::latestSentEnqueueType;
+    using BaseClass::logicalStateHelper;
     using BaseClass::obtainCommandStream;
     using BaseClass::obtainNewTimestampPacketNodes;
     using BaseClass::requiresCacheFlushAfterWalker;

shared/source/command_stream/command_stream_receiver_hw.h

@@ -24,6 +24,7 @@ namespace NEO {
 template <typename GfxFamily>
 class DeviceCommandStreamReceiver;
 struct PipeControlArgs;
+class LogicalStateHelper;
 
 template <typename GfxFamily>
 class CommandStreamReceiverHw : public CommandStreamReceiver {
@@ -189,6 +190,7 @@ class CommandStreamReceiverHw : public CommandStreamReceiver {
 
     std::unique_ptr<DirectSubmissionHw<GfxFamily, RenderDispatcher<GfxFamily>>> directSubmission;
     std::unique_ptr<DirectSubmissionHw<GfxFamily, BlitterDispatcher<GfxFamily>>> blitterDirectSubmission;
+    std::unique_ptr<LogicalStateHelper> logicalStateHelper;
 
     size_t cmdStreamStart = 0;
 };

shared/source/command_stream/command_stream_receiver_hw_base.inl

@@ -26,6 +26,7 @@
 #include "shared/source/helpers/flat_batch_buffer_helper_hw.h"
 #include "shared/source/helpers/flush_stamp.h"
 #include "shared/source/helpers/hw_helper.h"
+#include "shared/source/helpers/logical_state_helper.h"
 #include "shared/source/helpers/pause_on_gpu_properties.h"
 #include "shared/source/helpers/preamble.h"
 #include "shared/source/helpers/ptr_math.h"
@@ -73,6 +74,9 @@ CommandStreamReceiverHw<GfxFamily>::CommandStreamReceiverHw(ExecutionEnvironment
     if (DebugManager.flags.EnableTimestampPacket.get() != -1) {
         timestampPacketWriteEnabled = !!DebugManager.flags.EnableTimestampPacket.get();
     }
+
+    logicalStateHelper.reset(LogicalStateHelper::create<GfxFamily>(false));
+
     createScratchSpaceController();
     configurePostSyncWriteOffset();
 }

shared/source/gen11/hw_helper_gen11.cpp

@@ -11,6 +11,7 @@
 #include "shared/source/helpers/hw_helper_base.inl"
 #include "shared/source/helpers/hw_helper_bdw_and_later.inl"
 #include "shared/source/helpers/hw_helper_bdw_to_icllp.inl"
+#include "shared/source/helpers/logical_state_helper.inl"
 
 namespace NEO {
 typedef ICLFamily Family;
@@ -39,4 +40,6 @@ template class HwHelperHw<Family>;
 template class FlatBatchBufferHelperHw<Family>;
 template struct MemorySynchronizationCommands<Family>;
 template struct LriHelper<Family>;
+
+template LogicalStateHelper *LogicalStateHelper::create<Family>(bool pipelinedState);
 } // namespace NEO

shared/source/gen12lp/hw_helper_gen12lp.cpp

@@ -14,6 +14,7 @@ using Family = NEO::TGLLPFamily;
 #include "shared/source/helpers/hw_helper_base.inl"
 #include "shared/source/helpers/hw_helper_bdw_and_later.inl"
 #include "shared/source/helpers/hw_helper_tgllp_and_later.inl"
+#include "shared/source/helpers/logical_state_helper.inl"
 #include "shared/source/os_interface/hw_info_config.h"
 
 #include "engine_node.h"
@@ -212,4 +213,6 @@ template class HwHelperHw<Family>;
 template class FlatBatchBufferHelperHw<Family>;
 template struct MemorySynchronizationCommands<Family>;
 template struct LriHelper<Family>;
+
+template LogicalStateHelper *LogicalStateHelper::create<Family>(bool pipelinedState);
 } // namespace NEO

shared/source/gen8/hw_helper_gen8.cpp

@@ -12,6 +12,7 @@
 #include "shared/source/helpers/hw_helper_base.inl"
 #include "shared/source/helpers/hw_helper_bdw_and_later.inl"
 #include "shared/source/helpers/hw_helper_bdw_to_icllp.inl"
+#include "shared/source/helpers/logical_state_helper.inl"
 
 namespace NEO {
 typedef BDWFamily Family;
@@ -80,4 +81,6 @@ template class HwHelperHw<Family>;
 template class FlatBatchBufferHelperHw<Family>;
 template struct MemorySynchronizationCommands<Family>;
 template struct LriHelper<Family>;
+
+template LogicalStateHelper *LogicalStateHelper::create<Family>(bool pipelinedState);
 } // namespace NEO

shared/source/gen9/hw_helper_gen9.cpp

@@ -11,6 +11,7 @@
 #include "shared/source/helpers/hw_helper_base.inl"
 #include "shared/source/helpers/hw_helper_bdw_and_later.inl"
 #include "shared/source/helpers/hw_helper_bdw_to_icllp.inl"
+#include "shared/source/helpers/logical_state_helper.inl"
 
 #include <cstring>
 
@@ -50,4 +51,6 @@ template class HwHelperHw<Family>;
 template class FlatBatchBufferHelperHw<Family>;
 template struct MemorySynchronizationCommands<Family>;
 template struct LriHelper<Family>;
+
+template LogicalStateHelper *LogicalStateHelper::create<Family>(bool pipelinedState);
 } // namespace NEO

shared/source/helpers/CMakeLists.txt

@@ -89,6 +89,8 @@ set(NEO_CORE_HELPERS
     ${CMAKE_CURRENT_SOURCE_DIR}/local_id_gen_sse4.cpp
     ${CMAKE_CURRENT_SOURCE_DIR}/local_work_size.cpp
     ${CMAKE_CURRENT_SOURCE_DIR}/local_work_size.h
+    ${CMAKE_CURRENT_SOURCE_DIR}/logical_state_helper.h
+    ${CMAKE_CURRENT_SOURCE_DIR}/logical_state_helper.inl
     ${CMAKE_CURRENT_SOURCE_DIR}${BRANCH_DIR_SUFFIX}memory_properties_helpers.cpp
     ${CMAKE_CURRENT_SOURCE_DIR}/memory_properties_helpers.h
     ${CMAKE_CURRENT_SOURCE_DIR}/memory_properties_helpers_base.inl

shared/source/helpers/logical_state_helper.h

@@ -0,0 +1,26 @@
+/*
+ * Copyright (C) 2022 Intel Corporation
+ *
+ * SPDX-License-Identifier: MIT
+ *
+ */
+
+#pragma once
+
+namespace NEO {
+class LinearStream;
+
+class LogicalStateHelper {
+  public:
+    template <typename Family>
+    static LogicalStateHelper *create(bool pipelinedState);
+
+    virtual ~LogicalStateHelper() = default;
+
+    virtual void writeStreamInline(LinearStream &linearStream) = 0;
+
+  protected:
+    LogicalStateHelper() = default;
+};
+
+} // namespace NEO

shared/source/helpers/logical_state_helper.inl

@@ -0,0 +1,17 @@
+/*
+ * Copyright (C) 2022 Intel Corporation
+ *
+ * SPDX-License-Identifier: MIT
+ *
+ */
+
+#include "shared/source/helpers/logical_state_helper.h"
+
+namespace NEO {
+
+template <typename GfxFamily>
+LogicalStateHelper *LogicalStateHelper::create(bool pipelinedState) {
+    return nullptr;
+}
+
+} // namespace NEO

shared/source/xe_hp_core/hw_helper_xe_hp_core.cpp

@@ -17,6 +17,7 @@ using Family = NEO::XeHpFamily;
 #include "shared/source/helpers/hw_helper_base.inl"
 #include "shared/source/helpers/hw_helper_tgllp_and_later.inl"
 #include "shared/source/helpers/hw_helper_xehp_and_later.inl"
+#include "shared/source/helpers/logical_state_helper.inl"
 #include "shared/source/os_interface/hw_info_config.h"
 
 namespace NEO {
@@ -155,4 +156,6 @@ template class HwHelperHw<Family>;
 template class FlatBatchBufferHelperHw<Family>;
 template struct MemorySynchronizationCommands<Family>;
 template struct LriHelper<Family>;
+
+template LogicalStateHelper *LogicalStateHelper::create<Family>(bool pipelinedState);
 } // namespace NEO

shared/source/xe_hpc_core/hw_helper_xe_hpc_core.cpp

@@ -17,6 +17,7 @@ using Family = NEO::XE_HPC_COREFamily;
 #include "shared/source/helpers/hw_helper_dg2_and_later.inl"
 #include "shared/source/helpers/hw_helper_tgllp_and_later.inl"
 #include "shared/source/helpers/hw_helper_xehp_and_later.inl"
+#include "shared/source/helpers/logical_state_helper.inl"
 
 namespace NEO {
 
@@ -458,4 +459,6 @@ template class HwHelperHw<Family>;
 template class FlatBatchBufferHelperHw<Family>;
 template struct MemorySynchronizationCommands<Family>;
 template struct LriHelper<Family>;
+
+template LogicalStateHelper *LogicalStateHelper::create<Family>(bool pipelinedState);
 } // namespace NEO

shared/source/xe_hpg_core/hw_helper_xe_hpg_core.cpp

@@ -17,6 +17,7 @@ using Family = NEO::XE_HPG_COREFamily;
 #include "shared/source/helpers/hw_helper_dg2_and_later.inl"
 #include "shared/source/helpers/hw_helper_tgllp_and_later.inl"
 #include "shared/source/helpers/hw_helper_xehp_and_later.inl"
+#include "shared/source/helpers/logical_state_helper.inl"
 
 namespace NEO {
 template <>
@@ -139,4 +140,6 @@ template class HwHelperHw<Family>;
 template class FlatBatchBufferHelperHw<Family>;
 template struct MemorySynchronizationCommands<Family>;
 template struct LriHelper<Family>;
+
+template LogicalStateHelper *LogicalStateHelper::create<Family>(bool pipelinedState);
 } // namespace NEO

shared/test/common/libult/ult_command_stream_receiver.h

@@ -44,6 +44,7 @@ class UltCommandStreamReceiver : public CommandStreamReceiverHw<GfxFamily>, publ
     using BaseClass::isBlitterDirectSubmissionEnabled;
     using BaseClass::isDirectSubmissionEnabled;
     using BaseClass::isPerDssBackedBufferSent;
+    using BaseClass::logicalStateHelper;
     using BaseClass::makeResident;
     using BaseClass::perDssBackedBuffer;
     using BaseClass::postInitFlagsSetup;