fix: adjust root device indices when filtering root device environments

Related-To: NEO-8166
Signed-off-by: Mateusz Jablonski <[email protected]>
Source: 4e464e9

Author: JablonskiMateusz

shared/source/execution_environment/drm/CMakeLists.txt

@@ -253,6 +253,10 @@ void ExecutionEnvironment::parseAffinityMask() {
     rootDeviceEnvironments.swap(filteredEnvironments);
 }
 
+void ExecutionEnvironment::sortNeoDevices() {
+    std::sort(rootDeviceEnvironments.begin(), rootDeviceEnvironments.end(), comparePciIdBusNumber);
+}
+
 void ExecutionEnvironment::adjustCcsCountImpl(RootDeviceEnvironment *rootDeviceEnvironment) const {
     auto hwInfo = rootDeviceEnvironment->getMutableHardwareInfo();
     auto &productHelper = rootDeviceEnvironment->getHelper<ProductHelper>();

shared/source/execution_environment/drm/sort_devices_drm.cpp

@@ -32,8 +32,7 @@ class ExecutionEnvironment : public ReferenceTrackedObject<ExecutionEnvironment>
     void adjustCcsCount();
     void adjustCcsCount(const uint32_t rootDeviceIndex) const;
     void sortNeoDevices();
-    void sortNeoDevicesDRM();
-    void sortNeoDevicesWDDM();
+    void adjustRootDeviceEnvironments();
     void prepareForCleanup() const;
     void setDebuggingMode(DebuggingMode debuggingMode) {
         debuggingEnabledMode = debuggingMode;

shared/source/execution_environment/execution_environment.cpp

@@ -1,16 +1,20 @@
 /*
- * Copyright (C) 2022 Intel Corporation
+ * Copyright (C) 2022-2023 Intel Corporation
  *
  * SPDX-License-Identifier: MIT
  *
  */
 
 #include "shared/source/execution_environment/execution_environment.h"
+#include "shared/source/execution_environment/root_device_environment.h"
+#include "shared/source/os_interface/linux/drm_memory_operations_handler.h"
 
 namespace NEO {
 
-void ExecutionEnvironment::sortNeoDevices() {
-    return ExecutionEnvironment::sortNeoDevicesDRM();
+void ExecutionEnvironment::adjustRootDeviceEnvironments() {
+    for (auto rootDeviceIndex = 0u; rootDeviceIndex < rootDeviceEnvironments.size(); rootDeviceIndex++) {
+        auto drmMemoryOperationsHandler = static_cast<DrmMemoryOperationsHandler *>(rootDeviceEnvironments[rootDeviceIndex]->memoryOperationsInterface.get());
+        drmMemoryOperationsHandler->setRootDeviceIndex(rootDeviceIndex);
+    }
 }
-
 } // namespace NEO

shared/source/execution_environment/execution_environment.h

@@ -8,17 +8,18 @@
 #include "shared/source/execution_environment/execution_environment.h"
 #include "shared/source/execution_environment/root_device_environment.h"
 #include "shared/source/helpers/driver_model_type.h"
+#include "shared/source/os_interface/linux/drm_memory_operations_handler.h"
 #include "shared/source/os_interface/os_interface.h"
 
 namespace NEO {
 
-void ExecutionEnvironment::sortNeoDevices() {
-
+void ExecutionEnvironment::adjustRootDeviceEnvironments() {
     if (rootDeviceEnvironments[0]->osInterface->getDriverModel()->getDriverModelType() == DriverModelType::DRM) {
-        return ExecutionEnvironment::sortNeoDevicesDRM();
-    } else {
-        return ExecutionEnvironment::sortNeoDevicesWDDM();
+        for (auto rootDeviceIndex = 0u; rootDeviceIndex < rootDeviceEnvironments.size(); rootDeviceIndex++) {
+            auto drmMemoryOperationsHandler = static_cast<DrmMemoryOperationsHandler *>(rootDeviceEnvironments[rootDeviceIndex]->memoryOperationsInterface.get());
+            drmMemoryOperationsHandler->setRootDeviceIndex(rootDeviceIndex);
+        }
     }
 }
 
-} // namespace NEO
+} // namespace NEO

shared/source/execution_environment/execution_environment_drm.cpp

@@ -1,5 +1,5 @@
 /*
- * Copyright (C) 2022 Intel Corporation
+ * Copyright (C) 2022-2023 Intel Corporation
  *
  * SPDX-License-Identifier: MIT
  *
@@ -9,8 +9,7 @@
 
 namespace NEO {
 
-void ExecutionEnvironment::sortNeoDevices() {
-    return ExecutionEnvironment::sortNeoDevicesWDDM();
+void ExecutionEnvironment::adjustRootDeviceEnvironments() {
 }
 
-} // namespace NEO
+} // namespace NEO

shared/source/execution_environment/execution_environment_drm_or_wddm.cpp

@@ -179,6 +179,7 @@ bool DeviceFactory::prepareDeviceEnvironments(ExecutionEnvironment &executionEnv
 
     executionEnvironment.sortNeoDevices();
     executionEnvironment.parseAffinityMask();
+    executionEnvironment.adjustRootDeviceEnvironments();
     executionEnvironment.adjustCcsCount();
     executionEnvironment.calculateMaxOsContextCount();
 

shared/source/execution_environment/execution_environment_wddm.cpp

@@ -1,5 +1,5 @@
 /*
- * Copyright (C) 2021-2022 Intel Corporation
+ * Copyright (C) 2021-2023 Intel Corporation
  *
  * SPDX-License-Identifier: MIT
  *
@@ -26,6 +26,11 @@ std::vector<std::string> Directory::getFiles(const std::string &path) {
         return files;
     }
 
+    auto it = directoryFilesMap.find(path);
+    if (it != directoryFilesMap.end()) {
+        return directoryFilesMap[path];
+    }
+
     if (path == byPathPattern) {
         files.push_back(byPathPattern + "/pci-0000:00:02.0-card");
         files.push_back(byPathPattern + "/pci-0000:00:02.0-render");
@@ -58,11 +63,6 @@ std::vector<std::string> Directory::getFiles(const std::string &path) {
         };
     }
 
-    auto it = directoryFilesMap.find(path);
-    if (it != directoryFilesMap.end()) {
-        return directoryFilesMap[path];
-    }
-
     return files;
 }
 }; // namespace NEO

shared/source/execution_environment/wddm/CMakeLists.txt

@@ -11,9 +11,16 @@
 #include "shared/source/os_interface/device_factory.h"
 #include "shared/source/os_interface/driver_info.h"
 #include "shared/source/os_interface/linux/drm_memory_operations_handler_bind.h"
+#include "shared/source/os_interface/linux/os_inc.h"
 #include "shared/source/os_interface/os_interface.h"
+#include "shared/test/common/helpers/debug_manager_state_restore.h"
 #include "shared/test/common/helpers/default_hw_info.h"
 #include "shared/test/common/mocks/mock_driver_model.h"
+#include "shared/test/common/os_interface/linux/sys_calls_linux_ult.h"
+
+namespace NEO {
+extern std::map<std::string, std::vector<std::string>> directoryFilesMap;
+};
 
 TEST_F(DeviceFactoryLinuxTest, WhenPreparingDeviceEnvironmentsThenInitializedCorrectly) {
     const HardwareInfo *refHwinfo = defaultHwInfo.get();
@@ -68,26 +75,38 @@ TEST_F(DeviceFactoryLinuxTest, whenDrmIsNotCretedThenPrepareDeviceEnvironmentsFa
     EXPECT_FALSE(success);
 }
 
-TEST(SortDevicesDrmTest, whenSortingDevicesThenMemoryOperationHandlersHaveProperIndices) {
-    ExecutionEnvironment executionEnvironment{};
+TEST(SortAndFilterDevicesDrmTest, whenSortingAndFilteringDevicesThenMemoryOperationHandlersHaveProperIndices) {
     static const auto numRootDevices = 6;
-    NEO::PhysicalDevicePciBusInfo inputBusInfos[numRootDevices] = {{3, 1, 2, 1}, {0, 0, 2, 0}, {0, 1, 3, 0}, {0, 1, 2, 1}, {0, 0, 2, 1}, {3, 1, 2, 0}};
-    NEO::PhysicalDevicePciBusInfo expectedBusInfos[numRootDevices] = {{0, 0, 2, 0}, {0, 0, 2, 1}, {0, 1, 2, 1}, {0, 1, 3, 0}, {3, 1, 2, 0}, {3, 1, 2, 1}};
-
-    executionEnvironment.prepareRootDeviceEnvironments(numRootDevices);
-    for (uint32_t rootDeviceIndex = 0; rootDeviceIndex < numRootDevices; rootDeviceIndex++) {
-        auto &rootDeviceEnvironment = *executionEnvironment.rootDeviceEnvironments[rootDeviceIndex];
-        auto osInterface = std::make_unique<OSInterface>();
-        auto driverModel = std::make_unique<MockDriverModel>(DriverModelType::DRM);
-        driverModel->pciBusInfo = inputBusInfos[rootDeviceIndex];
-        osInterface->setDriverModel(std::move(driverModel));
-        rootDeviceEnvironment.osInterface = std::move(osInterface);
-        rootDeviceEnvironment.memoryOperationsInterface = std::make_unique<DrmMemoryOperationsHandlerBind>(rootDeviceEnvironment, rootDeviceIndex);
-    }
+    DebugManagerStateRestore dbgRestorer;
+    DebugManager.flags.CreateMultipleRootDevices.set(numRootDevices);
+    DebugManager.flags.ZE_AFFINITY_MASK.set("1,2,3,4,5");
+
+    VariableBackup<std::map<std::string, std::vector<std::string>>> directoryFilesMapBackup(&directoryFilesMap);
+    VariableBackup<const char *> pciDevicesDirectoryBackup(&Os::pciDevicesDirectory);
+    VariableBackup<decltype(SysCalls::sysCallsOpen)> mockOpen(&SysCalls::sysCallsOpen, [](const char *pathname, int flags) -> int {
+        return SysCalls::fakeFileDescriptor;
+    });
+
+    Os::pciDevicesDirectory = "/";
+    directoryFilesMap.clear();
+    directoryFilesMap[Os::pciDevicesDirectory] = {};
+    directoryFilesMap[Os::pciDevicesDirectory].push_back("/pci-0003:01:02.1-render");
+    directoryFilesMap[Os::pciDevicesDirectory].push_back("/pci-0000:00:02.0-render");
+    directoryFilesMap[Os::pciDevicesDirectory].push_back("/pci-0000:01:03.0-render");
+    directoryFilesMap[Os::pciDevicesDirectory].push_back("/pci-0000:01:02.1-render");
+    directoryFilesMap[Os::pciDevicesDirectory].push_back("/pci-0000:00:02.1-render");
+    directoryFilesMap[Os::pciDevicesDirectory].push_back("/pci-0003:01:02.0-render");
+
+    ExecutionEnvironment executionEnvironment{};
+    bool success = DeviceFactory::prepareDeviceEnvironments(executionEnvironment);
+    EXPECT_TRUE(success);
+
+    static const auto newNumRootDevices = 5u;
+    EXPECT_EQ(newNumRootDevices, executionEnvironment.rootDeviceEnvironments.size());
 
-    executionEnvironment.sortNeoDevices();
+    NEO::PhysicalDevicePciBusInfo expectedBusInfos[newNumRootDevices] = {{0, 0, 2, 1}, {0, 1, 2, 1}, {0, 1, 3, 0}, {3, 1, 2, 0}, {3, 1, 2, 1}};
 
-    for (uint32_t rootDeviceIndex = 0; rootDeviceIndex < numRootDevices; rootDeviceIndex++) {
+    for (uint32_t rootDeviceIndex = 0; rootDeviceIndex < newNumRootDevices; rootDeviceIndex++) {
         auto pciBusInfo = executionEnvironment.rootDeviceEnvironments[rootDeviceIndex]->osInterface->getDriverModel()->getPciBusInfo();
         EXPECT_EQ(expectedBusInfos[rootDeviceIndex].pciDomain, pciBusInfo.pciDomain);
         EXPECT_EQ(expectedBusInfos[rootDeviceIndex].pciBus, pciBusInfo.pciBus);