Source Level Debugger: SIP programming in preamble

- program SIP_STATE when either MidThread preemption is enabled
or kernel debugging is active
- device creates correct sip based on preemption mode and
active kernel debugging

Change-Id: I3e43b66ad00d24c2389fa4fc766dd47044b6af80

unit_tests/source_level_debugger/device_tests.cpp

@@ -0,0 +1,87 @@
+/*
+ * Copyright (c) 2018, Intel Corporation
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a
+ * copy of this software and associated documentation files (the "Software"),
+ * to deal in the Software without restriction, including without limitation
+ * the rights to use, copy, modify, merge, publish, distribute, sublicense,
+ * and/or sell copies of the Software, and to permit persons to whom the
+ * Software is furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included
+ * in all copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
+ * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
+ * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR
+ * OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
+ * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
+ * OTHER DEALINGS IN THE SOFTWARE.
+ */
+
+#include "unit_tests/fixtures/device_fixture.h"
+#include "unit_tests/helpers/debug_manager_state_restore.h"
+#include "unit_tests/mocks/mock_builtins.h"
+#include "unit_tests/mocks/mock_device.h"
+
+#include "test.h"
+
+using PreambleTest = ::testing::Test;
+using namespace OCLRT;
+
+class MockDeviceWithActiveDebugger : public MockDevice {
+  public:
+    MockDeviceWithActiveDebugger(const HardwareInfo &hwInfo, bool isRootDevice = true) : MockDevice(hwInfo, isRootDevice) {}
+
+    void initializeCaps() override {
+        MockDevice::initializeCaps();
+        this->setSourceLevelDebuggerActive(true);
+    }
+};
+
+TEST(DeviceCreation, givenDeviceWithMidThreadPreemptionAndDebuggingActiveWhenDeviceIsCreatedThenCorrectSipKernelIsCreated) {
+
+    DebugManagerStateRestore dbgRestorer;
+    {
+        BuiltIns::shutDown();
+
+        std::unique_ptr<MockBuiltins> mockBuiltins(new MockBuiltins);
+        EXPECT_EQ(nullptr, mockBuiltins->peekCurrentInstance());
+        mockBuiltins->overrideGlobalBuiltins();
+        EXPECT_EQ(mockBuiltins.get(), mockBuiltins->peekCurrentInstance());
+        EXPECT_FALSE(mockBuiltins->getSipKernelCalled);
+
+        DebugManager.flags.ForcePreemptionMode.set((int32_t)PreemptionMode::MidThread);
+        auto device = std::unique_ptr<MockDeviceWithActiveDebugger>(Device::create<MockDeviceWithActiveDebugger>(nullptr));
+
+        EXPECT_TRUE(mockBuiltins->getSipKernelCalled);
+        EXPECT_LE(SipKernelType::DbgCsr, mockBuiltins->getSipKernelType);
+        mockBuiltins->restoreGlobalBuiltins();
+        //make sure to release builtins prior to device as they use device
+        mockBuiltins.reset();
+    }
+}
+
+TEST(DeviceCreation, givenDeviceWithDisabledPreemptionAndDebuggingActiveWhenDeviceIsCreatedThenCorrectSipKernelIsCreated) {
+
+    DebugManagerStateRestore dbgRestorer;
+    {
+        BuiltIns::shutDown();
+
+        std::unique_ptr<MockBuiltins> mockBuiltins(new MockBuiltins);
+        EXPECT_EQ(nullptr, mockBuiltins->peekCurrentInstance());
+        mockBuiltins->overrideGlobalBuiltins();
+        EXPECT_EQ(mockBuiltins.get(), mockBuiltins->peekCurrentInstance());
+        EXPECT_FALSE(mockBuiltins->getSipKernelCalled);
+
+        DebugManager.flags.ForcePreemptionMode.set((int32_t)PreemptionMode::Disabled);
+        auto device = std::unique_ptr<MockDeviceWithActiveDebugger>(Device::create<MockDeviceWithActiveDebugger>(nullptr));
+
+        EXPECT_TRUE(mockBuiltins->getSipKernelCalled);
+        EXPECT_LE(SipKernelType::DbgCsr, mockBuiltins->getSipKernelType);
+        mockBuiltins->restoreGlobalBuiltins();
+        //make sure to release builtins prior to device as they use device
+        mockBuiltins.reset();
+    }
+}