fix: Correct AIL initialization in runtime

km-nowak · Compute-Runtime-Automation · commit 5c2329e359a6 · 2023-12-04T15:49:37.000+01:00
- Initialize AIL helper in runtime (linux/windows/AUB path). - Return false if AIL configuration initialization is called with empty AIL helper (is nullptr). - Skip mentioned condition if AIL is disabled via EnableAIL debug key. Related-To: NEO-9240 Signed-off-by: Kacper Nowak <kacper.nowak@intel.com> Source: 4a00640
diff --git a/opencl/test/unit_test/linux/main_linux_dll.cpp b/opencl/test/unit_test/linux/main_linux_dll.cpp
diff --git a/shared/source/execution_environment/root_device_environment.cpp b/shared/source/execution_environment/root_device_environment.cpp
@@ -102,7 +102,7 @@ void RootDeviceEnvironment::prepareForCleanup() const {
 
 bool RootDeviceEnvironment::initAilConfiguration() {
     if (ailConfiguration == nullptr) {
-        return true;
+        return (false == DebugManager.flags.EnableAIL.get());
     }
 
     auto result = ailConfiguration->initProcessExecutableName();
diff --git a/shared/source/os_interface/device_factory.cpp b/shared/source/os_interface/device_factory.cpp
@@ -63,6 +63,10 @@ bool DeviceFactory::prepareDeviceEnvironmentsForProductFamilyOverride(ExecutionE
         rootDeviceEnvironment.initGfxCoreHelper();
         rootDeviceEnvironment.initApiGfxCoreHelper();
         rootDeviceEnvironment.initCompilerProductHelper();
+        rootDeviceEnvironment.initAilConfigurationHelper();
+        if (false == rootDeviceEnvironment.initAilConfiguration()) {
+            return false;
+        }
 
         auto hardwareInfo = rootDeviceEnvironment.getMutableHardwareInfo();
 
diff --git a/shared/source/os_interface/linux/drm_neo.cpp b/shared/source/os_interface/linux/drm_neo.cpp
@@ -436,6 +436,12 @@ int Drm::setupHardwareInfo(const DeviceDescriptor *device, bool setupFeatureTabl
     rootDeviceEnvironment.initGfxCoreHelper();
     rootDeviceEnvironment.initApiGfxCoreHelper();
     rootDeviceEnvironment.initCompilerProductHelper();
+    rootDeviceEnvironment.initAilConfigurationHelper();
+    auto result = rootDeviceEnvironment.initAilConfiguration();
+    if (false == result) {
+        PRINT_DEBUG_STRING(DebugManager.flags.PrintDebugMessages.get(), stderr, "%s", "FATAL: AIL creation failed!\n");
+        return -1;
+    }
 
     hwInfo->platform.usDeviceID = deviceId;
     hwInfo->platform.usRevId = revisionId;
diff --git a/shared/source/os_interface/linux/os_interface_linux.cpp b/shared/source/os_interface/linux/os_interface_linux.cpp
@@ -52,9 +52,6 @@ bool initDrmOsInterface(std::unique_ptr<HwDeviceId> &&hwDeviceId, uint32_t rootD
     }
     rootDeviceEnv->memoryOperationsInterface = DrmMemoryOperationsHandler::create(*drm, rootDeviceIndex);
 
-    [[maybe_unused]] bool result = rootDeviceEnv->initAilConfiguration();
-    DEBUG_BREAK_IF(!result);
-
     return true;
 }
 
diff --git a/shared/source/os_interface/windows/wddm/wddm.cpp b/shared/source/os_interface/windows/wddm/wddm.cpp
@@ -114,6 +114,10 @@ bool Wddm::init() {
     productHelper.adjustPlatformForProductFamily(hardwareInfo);
     rootDeviceEnvironment.initApiGfxCoreHelper();
     rootDeviceEnvironment.initGfxCoreHelper();
+    rootDeviceEnvironment.initAilConfigurationHelper();
+    if (false == rootDeviceEnvironment.initAilConfiguration()) {
+        return false;
+    }
 
     populateIpVersion(*hardwareInfo);
     rootDeviceEnvironment.initReleaseHelper();
@@ -129,9 +133,6 @@ bool Wddm::init() {
     rootDeviceEnvironment.initGmm();
     this->rootDeviceEnvironment.getGmmClientContext()->setHandleAllocator(this->hwDeviceId->getUmKmDataTranslator()->createGmmHandleAllocator());
 
-    [[maybe_unused]] bool result = rootDeviceEnvironment.initAilConfiguration();
-    DEBUG_BREAK_IF(!result);
-
     if (WddmVersion::WDDM_2_3 == getWddmVersion()) {
         wddmInterface = std::make_unique<WddmInterface23>(*this);
     } else {
diff --git a/shared/test/common/mocks/mock_ail_configuration.h b/shared/test/common/mocks/mock_ail_configuration.h
@@ -12,8 +12,9 @@
 namespace NEO {
 class MockAILConfiguration : public AILConfiguration {
   public:
+    bool initProcessExecutableNameResult = true;
     bool initProcessExecutableName() override {
-        return true;
+        return initProcessExecutableNameResult;
     }
     void modifyKernelIfRequired(std::string &kernel) override {}
 
diff --git a/shared/test/common/mocks/mock_execution_environment.cpp b/shared/test/common/mocks/mock_execution_environment.cpp
@@ -37,6 +37,12 @@ bool MockRootDeviceEnvironment::initOsInterface(std::unique_ptr<HwDeviceId> &&hw
     }
     return RootDeviceEnvironment::initOsInterface(std::move(hwDeviceId), rootDeviceIndex);
 }
+bool MockRootDeviceEnvironment::initAilConfiguration() {
+    if (ailInitializationResult.has_value()) {
+        return *ailInitializationResult;
+    } else
+        return RootDeviceEnvironment::initAilConfiguration();
+}
 
 MockRootDeviceEnvironment::~MockRootDeviceEnvironment() {
     if (initOsInterfaceExpectedCallCount) {
diff --git a/shared/test/common/mocks/mock_execution_environment.h b/shared/test/common/mocks/mock_execution_environment.h
@@ -24,6 +24,7 @@ struct MockRootDeviceEnvironment : public RootDeviceEnvironment {
 
     void initAubCenter(bool localMemoryEnabled, const std::string &aubFileName, CommandStreamReceiverType csrType) override;
     bool initOsInterface(std::unique_ptr<HwDeviceId> &&hwDeviceId, uint32_t rootDeviceIndex) override;
+    bool initAilConfiguration() override;
 
     std::vector<bool> initOsInterfaceResults;
     uint32_t initOsInterfaceCalled = 0u;
@@ -32,6 +33,7 @@ struct MockRootDeviceEnvironment : public RootDeviceEnvironment {
     bool localMemoryEnabledReceived = false;
     std::string aubFileNameReceived = "";
     bool useMockAubCenter = true;
+    std::optional<bool> ailInitializationResult{true};
 };
 
 struct MockExecutionEnvironment : ExecutionEnvironment {
diff --git a/shared/test/unit_test/ail/ail_tests.cpp b/shared/test/unit_test/ail/ail_tests.cpp
@@ -138,21 +138,6 @@ HWTEST2_F(AILTests, givenPreGen12AndAndProcessNameIsNotResolveWhenApplyWithDavin
     EXPECT_TRUE(rtTable.hostPtrTrackingEnabled);
 }
 
-HWTEST_F(AILTests, GivenPlatformHasNoAilAvailableWhenAilIsEnabledThenAilInitializationReturnsTrue) {
-    DebugManagerStateRestore restore;
-    NEO::DebugManager.flags.EnableAIL.set(true);
-
-    HardwareInfo hwInfo{};
-    hwInfo.platform.eProductFamily = productFamily;
-    hwInfo.platform.eRenderCoreFamily = renderCoreFamily;
-
-    NEO::MockExecutionEnvironment executionEnvironment{&hwInfo, true, 1};
-    auto rootDeviceEnvironment = executionEnvironment.rootDeviceEnvironments[0].get();
-    rootDeviceEnvironment->ailConfiguration.reset(nullptr);
-
-    EXPECT_TRUE(rootDeviceEnvironment->initAilConfiguration());
-}
-
 HWTEST2_F(AILTests, GivenAilWhenCheckingContextSyncFlagRequiredThenExpectFalse, IsAtLeastGen9) {
     AILWhitebox<productFamily> ail;
     ail.processName = "other";
diff --git a/shared/test/unit_test/execution_environment/execution_environment_tests.cpp b/shared/test/unit_test/execution_environment/execution_environment_tests.cpp
@@ -24,6 +24,7 @@
 #include "shared/source/os_interface/os_time.h"
 #include "shared/source/release_helper/release_helper.h"
 #include "shared/test/common/helpers/debug_manager_state_restore.h"
+#include "shared/test/common/mocks/mock_ail_configuration.h"
 #include "shared/test/common/mocks/mock_device.h"
 #include "shared/test/common/mocks/mock_driver_model.h"
 #include "shared/test/common/mocks/mock_execution_environment.h"
@@ -487,6 +488,43 @@ TEST(ExecutionEnvironment, givenExecutionEnvironmentWhenSettingFP64EmulationEnab
     EXPECT_TRUE(executionEnvironment.isFP64EmulationEnabled());
 }
 
+TEST(ExecutionEnvironmentWithAILTests, whenAILConfigurationIsNullptrAndEnableAILFlagIsTrueWhenInitializingAILThenReturnFalse) {
+    DebugManagerStateRestore restore;
+    DebugManager.flags.EnableAIL.set(true);
+
+    MockExecutionEnvironment executionEnvironment{};
+    auto rootDeviceEnvironment = static_cast<MockRootDeviceEnvironment *>(executionEnvironment.rootDeviceEnvironments[0].get());
+    rootDeviceEnvironment->ailInitializationResult = {};
+    rootDeviceEnvironment->ailConfiguration.reset(nullptr);
+
+    EXPECT_FALSE(rootDeviceEnvironment->initAilConfiguration());
+}
+
+TEST(ExecutionEnvironmentWithAILTests, whenPlatformHasNoAILHelperAvailableAndEnableAILFlagIsFalseWhenInitializingAILThenReturnTrue) {
+    DebugManagerStateRestore restore;
+    DebugManager.flags.EnableAIL.set(false);
+
+    MockExecutionEnvironment executionEnvironment{};
+    auto rootDeviceEnvironment = static_cast<MockRootDeviceEnvironment *>(executionEnvironment.rootDeviceEnvironments[0].get());
+    rootDeviceEnvironment->ailInitializationResult = {};
+    rootDeviceEnvironment->ailConfiguration.reset(nullptr);
+
+    EXPECT_TRUE(rootDeviceEnvironment->initAilConfiguration());
+}
+
+TEST(ExecutionEnvironmentWithAILTests, whenAILConfigurationFailsOnInitProcessExecutableNameThenAILInitializationReturnFalse) {
+    MockExecutionEnvironment executionEnvironment{};
+    auto rootDeviceEnvironment = static_cast<MockRootDeviceEnvironment *>(executionEnvironment.rootDeviceEnvironments[0].get());
+    rootDeviceEnvironment->ailInitializationResult = {};
+
+    rootDeviceEnvironment->ailConfiguration.reset(new MockAILConfiguration());
+    auto mockAILConfiguration = static_cast<MockAILConfiguration *>(rootDeviceEnvironment->ailConfiguration.get());
+    mockAILConfiguration->initProcessExecutableNameResult = false;
+    ASSERT_NE(nullptr, rootDeviceEnvironment->ailConfiguration);
+
+    EXPECT_FALSE(rootDeviceEnvironment->initAilConfiguration());
+}
+
 TEST(ExecutionEnvironmentDeviceHierarchy, givenExecutionEnvironmentWithDefaultDeviceHierarchyThenExecutionEnvironmentIsInitializedCorrectly) {
     VariableBackup<uint32_t> mockGetenvCalledBackup(&IoFunctions::mockGetenvCalled, 0);
     MockExecutionEnvironment executionEnvironment;
diff --git a/shared/test/unit_test/gen12lp/dg1/execution_environment_tests_dg1.cpp b/shared/test/unit_test/gen12lp/dg1/execution_environment_tests_dg1.cpp
@@ -17,14 +17,8 @@ using RootDeviceEnvironmentTests = ::testing::Test;
 HWTEST2_F(RootDeviceEnvironmentTests, givenRootDeviceEnvironmentWhenAILInitProcessExecutableNameReturnsFailedThenInitAilConfigurationReturnsFail, IsDG1) {
     MockExecutionEnvironment executionEnvironment{};
     auto rootDeviceEnvironment = static_cast<MockRootDeviceEnvironment *>(executionEnvironment.rootDeviceEnvironments[0].get());
+    rootDeviceEnvironment->ailInitializationResult = false;
 
-    class AILDG1 : public AILConfigurationHw<productFamily> {
-      public:
-        bool initProcessExecutableName() override {
-            return false;
-        }
-    };
-    rootDeviceEnvironment->ailConfiguration.reset(new AILDG1());
     EXPECT_EQ(false, rootDeviceEnvironment->initAilConfiguration());
 }
 } // namespace NEO
diff --git a/shared/test/unit_test/os_interface/device_factory_tests.cpp b/shared/test/unit_test/os_interface/device_factory_tests.cpp
@@ -174,3 +174,12 @@ TEST_F(DeviceFactoryTests, givenMultipleDevicesWhenInitializeResourcesFailsForAl
 
     EXPECT_EQ(0u, executionEnvironment.rootDeviceEnvironments.size());
 }
+
+TEST_F(DeviceFactoryTests, givenFailedAilInitializationResultWhenPrepareDeviceEnvironmentsIsCalledThenReturnFalse) {
+    MockExecutionEnvironment executionEnvironment(defaultHwInfo.get());
+    auto mockRootDeviceEnvironment = static_cast<MockRootDeviceEnvironment *>(executionEnvironment.rootDeviceEnvironments[0].get());
+    mockRootDeviceEnvironment->ailInitializationResult = false;
+
+    bool res = DeviceFactory::prepareDeviceEnvironmentsForProductFamilyOverride(executionEnvironment);
+    EXPECT_FALSE(res);
+}
diff --git a/shared/test/unit_test/os_interface/windows/wddm_tests.cpp b/shared/test/unit_test/os_interface/windows/wddm_tests.cpp
@@ -120,6 +120,16 @@ TEST_F(WddmTests, WhenCallingReInitializeContextWithContextCreateDisabledFlagEna
     EXPECT_EQ(0u, newContext->getWddmContextHandle());
 }
 
+TEST_F(WddmTests, givenFailedAilInitializationResultWhenInitializingWddmThenReturnFalse) {
+    MockExecutionEnvironment executionEnvironment;
+    MockRootDeviceEnvironment mockRootDeviceEnvironment(executionEnvironment);
+    mockRootDeviceEnvironment.ailInitializationResult = false;
+
+    auto wddm = Wddm::createWddm(nullptr, mockRootDeviceEnvironment);
+    auto res = wddm->init();
+    EXPECT_FALSE(res);
+}
+
 TEST(WddmNewRsourceTest, whenSetNewResourcesBoundToPageTableThenSetInContextFromProperRootDeviceEnvironment) {
     MockExecutionEnvironment executionEnvironment;
     executionEnvironment.prepareRootDeviceEnvironments(2);

Original file line number	Diff line number	Diff line change
`@@ -102,7 +102,7 @@ void RootDeviceEnvironment::prepareForCleanup() const {`
`102`	`102`
`103`	`103`	`bool RootDeviceEnvironment::initAilConfiguration() {`
`104`	`104`	`if (ailConfiguration == nullptr) {`
`105`		`- return true;`
	`105`	`+ return (false == DebugManager.flags.EnableAIL.get());`
`106`	`106`	`}`
`107`	`107`
`108`	`108`	`auto result = ailConfiguration->initProcessExecutableName();`
Original file line number	Diff line number	Diff line change
`@@ -52,9 +52,6 @@ bool initDrmOsInterface(std::unique_ptr<HwDeviceId> &&hwDeviceId, uint32_t rootD`
`52`	`52`	`}`
`53`	`53`	`rootDeviceEnv->memoryOperationsInterface = DrmMemoryOperationsHandler::create(*drm, rootDeviceIndex);`
`54`	`54`
`55`		`- [[maybe_unused]] bool result = rootDeviceEnv->initAilConfiguration();`
`56`		`- DEBUG_BREAK_IF(!result);`
`57`		`-`
`58`	`55`	`return true;`
`59`	`56`	`}`
`60`	`57`
Original file line number	Diff line number	Diff line change
`@@ -37,6 +37,12 @@ bool MockRootDeviceEnvironment::initOsInterface(std::unique_ptr<HwDeviceId> &&hw`
`37`	`37`	`}`
`38`	`38`	`return RootDeviceEnvironment::initOsInterface(std::move(hwDeviceId), rootDeviceIndex);`
`39`	`39`	`}`
	`40`	`+bool MockRootDeviceEnvironment::initAilConfiguration() {`
	`41`	`+ if (ailInitializationResult.has_value()) {`
	`42`	`+ return *ailInitializationResult;`
	`43`	`+ } else`
	`44`	`+ return RootDeviceEnvironment::initAilConfiguration();`
	`45`	`+}`
`40`	`46`
`41`	`47`	`MockRootDeviceEnvironment::~MockRootDeviceEnvironment() {`
`42`	`48`	`if (initOsInterfaceExpectedCallCount) {`