Control enabling of local memory based on OS and HW Capabilities

Change-Id: Ia26c856aeef27fe638b7a6e895cc289859f3c579

Author: JakubKowalczuk94

runtime/device/device.cpp

@@ -113,7 +113,7 @@ bool Device::createDeviceImpl(const HardwareInfo *pHwInfo, Device &outDevice) {
     if (!executionEnvironment->initializeCommandStreamReceiver(pHwInfo, outDevice.getDeviceIndex())) {
         return false;
     }
-    executionEnvironment->initializeMemoryManager(outDevice.getEnabled64kbPages(), outDevice.getHardwareCapabilities().localMemorySupported, outDevice.getDeviceIndex());
+    executionEnvironment->initializeMemoryManager(outDevice.getEnabled64kbPages(), outDevice.getEnableLocalMemory(), outDevice.getDeviceIndex());
 
     outDevice.osContext = new OsContext(executionEnvironment->osInterface.get(), outDevice.getDeviceIndex());
     executionEnvironment->memoryManager->registerOsContext(outDevice.osContext);

runtime/device/device.h

@@ -113,6 +113,7 @@ class Device : public BaseObject<_cl_device_id> {
     std::string deviceExtensions;
     std::string name;
     bool getEnabled64kbPages();
+    bool getEnableLocalMemory();
     bool isSourceLevelDebuggerActive() const;
     SourceLevelDebugger *getSourceLevelDebugger() { return executionEnvironment->sourceLevelDebugger.get(); }
     ExecutionEnvironment *getExecutionEnvironment() const { return executionEnvironment; }

runtime/device/device_caps.cpp

@@ -52,6 +52,10 @@ bool Device::getEnabled64kbPages() {
     }
 };
 
+bool Device::getEnableLocalMemory() {
+    return OSInterface::osEnableLocalMemory && getHardwareCapabilities().localMemorySupported;
+};
+
 void Device::setupFp64Flags() {
     if (DebugManager.flags.OverrideDefaultFP64Settings.get() == -1) {
         if (hwInfo.capabilityTable.ftrSupportsFP64) {

runtime/memory_manager/memory_manager.cpp

@@ -234,6 +234,10 @@ bool MemoryManager::isAsyncDeleterEnabled() const {
     return asyncDeleterEnabled;
 }
 
+bool MemoryManager::isLocalMemorySupported() const {
+    return localMemorySupported;
+}
+
 bool MemoryManager::isMemoryBudgetExhausted() const {
     return false;
 }

runtime/memory_manager/memory_manager.h

@@ -234,6 +234,7 @@ class MemoryManager {
     void waitForDeletions();
 
     bool isAsyncDeleterEnabled() const;
+    bool isLocalMemorySupported() const;
     virtual bool isMemoryBudgetExhausted() const;
 
     virtual AlignedMallocRestrictions *getAlignedMallocRestrictions() {

runtime/os_interface/linux/os_interface.cpp

@@ -10,6 +10,7 @@
 namespace OCLRT {
 
 bool OSInterface::osEnabled64kbPages = false;
+bool OSInterface::osEnableLocalMemory = false;
 
 OSInterface::OSInterface() {
     osInterfaceImpl = new OSInterfaceImpl();

runtime/os_interface/os_interface.h

@@ -23,6 +23,7 @@ class OSInterface {
     };
     unsigned int getHwContextId() const;
     static bool osEnabled64kbPages;
+    static bool osEnableLocalMemory;
     static bool are64kbPagesEnabled();
     unsigned int getDeviceHandle() const;
 

runtime/os_interface/windows/os_interface.cpp

@@ -13,6 +13,7 @@
 namespace OCLRT {
 
 bool OSInterface::osEnabled64kbPages = true;
+bool OSInterface::osEnableLocalMemory = false;
 
 OSInterface::OSInterface() {
     osInterfaceImpl = new OSInterfaceImpl();

unit_tests/device/device_caps_tests.cpp

@@ -19,6 +19,7 @@
 #include "unit_tests/fixtures/device_fixture.h"
 #include "unit_tests/helpers/debug_manager_state_restore.h"
 #include "unit_tests/helpers/hw_helper_tests.h"
+#include "unit_tests/helpers/variable_backup.h"
 #include "unit_tests/mocks/mock_builtins.h"
 #include "unit_tests/mocks/mock_device.h"
 
@@ -767,6 +768,30 @@ TEST(Device_GetCaps, givenDeviceWithNullSourceLevelDebuggerWhenCapsAreInitialize
 
 typedef HwHelperTest DeviceCapsWithModifiedHwInfoTest;
 
+TEST_F(DeviceCapsWithModifiedHwInfoTest, GivenLocalMemorySupportedAndOsEnableLocalMemoryWhenSetThenGetEnableLocalMemoryReturnCorrectValue) {
+    VariableBackup<bool> orgOsEnableLocalMemory(&OSInterface::osEnableLocalMemory);
+    std::unique_ptr<MockDevice> device(MockDevice::createWithNewExecutionEnvironment<MockDevice>(&hwInfo));
+    bool orgHwCapsLocalMemorySupported = device->getHardwareCapabilities().localMemorySupported;
+
+    device->setHWCapsLocalMemorySupported(false);
+    OSInterface::osEnableLocalMemory = false;
+    EXPECT_FALSE(device->getEnableLocalMemory());
+
+    device->setHWCapsLocalMemorySupported(false);
+    OSInterface::osEnableLocalMemory = true;
+    EXPECT_FALSE(device->getEnableLocalMemory());
+
+    device->setHWCapsLocalMemorySupported(true);
+    OSInterface::osEnableLocalMemory = false;
+    EXPECT_FALSE(device->getEnableLocalMemory());
+
+    device->setHWCapsLocalMemorySupported(true);
+    OSInterface::osEnableLocalMemory = true;
+    EXPECT_TRUE(device->getEnableLocalMemory());
+
+    device->setHWCapsLocalMemorySupported(orgHwCapsLocalMemorySupported);
+}
+
 TEST_F(DeviceCapsWithModifiedHwInfoTest, givenPlatformWithSourceLevelDebuggerNotSupportedWhenDeviceIsCreatedThenSourceLevelDebuggerActiveIsSetToFalse) {
 
     hwInfo.capabilityTable.sourceLevelDebuggerSupported = false;

unit_tests/execution_environment/execution_environment_tests.cpp

@@ -19,6 +19,7 @@
 
 #include "test.h"
 #include "unit_tests/mocks/mock_csr.h"
+#include "unit_tests/mocks/mock_device.h"
 #include "unit_tests/mocks/mock_memory_manager.h"
 #include "unit_tests/utilities/destructor_counted.h"
 #include "unit_tests/helpers/unit_test_helper.h"
@@ -137,6 +138,14 @@ TEST(ExecutionEnvironment, givenExecutionEnvironmentWhenInitializeAubCenterIsCal
     EXPECT_EQ(currentAubFileStream, executionEnvironment.aubCenter->getStreamProvider()->getStream());
 }
 
+TEST(ExecutionEnvironment, givenExecutionEnvironmentWhenInitializeMemoryManagerIsCalledThenLocalMemorySupportedInMemoryManagerHasCorrectValue) {
+    auto device = std::unique_ptr<Device>(MockDevice::createWithNewExecutionEnvironment<MockDevice>(platformDevices[0]));
+    auto executionEnvironment = device->getExecutionEnvironment();
+    executionEnvironment->initializeCommandStreamReceiver(platformDevices[0], 0u);
+    executionEnvironment->initializeMemoryManager(false, device->getEnableLocalMemory(), 0u);
+    EXPECT_EQ(device->getEnableLocalMemory(), executionEnvironment->memoryManager->isLocalMemorySupported());
+}
+
 TEST(ExecutionEnvironment, givenExecutionEnvironmentWhenInitializeMemoryManagerIsCalledThenItIsInitalized) {
     auto executionEnvironment = std::make_unique<ExecutionEnvironment>();
     executionEnvironment->initializeCommandStreamReceiver(platformDevices[0], 0u);