Add AUB registry key for additional MMIO registers list

Change-Id: Ib478e91d8df21c48f83bfa97a4ea72c41c2f065d
Signed-off-by: Pawel Wilma <pawel.wilma@intel.com>

Author: pwilma

runtime/command_stream/command_stream_receiver_simulated_common_hw.h

@@ -7,6 +7,7 @@
 
 #pragma once
 #include "runtime/command_stream/command_stream_receiver_hw.h"
+#include "runtime/gen_common/aub_mapper.h"
 #include "runtime/memory_manager/memory_banks.h"
 #include "runtime/memory_manager/physical_address_allocator.h"
 
@@ -30,6 +31,7 @@ class CommandStreamReceiverSimulatedCommonHw : public CommandStreamReceiverHw<Gf
     AubMemDump::AubStream *stream;
 
   protected:
+    MMIOList splitMMIORegisters(const std::string &registers, char delimiter);
     PhysicalAddressAllocator *createPhysicalAddressAllocator();
 };
 } // namespace OCLRT

runtime/command_stream/command_stream_receiver_simulated_common_hw.inl

@@ -18,12 +18,50 @@ void CommandStreamReceiverSimulatedCommonHw<GfxFamily>::initGlobalMMIO() {
     }
 }
 
+template <typename GfxFamily>
+MMIOList CommandStreamReceiverSimulatedCommonHw<GfxFamily>::splitMMIORegisters(const std::string &registers, char delimiter) {
+    MMIOList result;
+    bool firstElementInPair = false;
+    std::string token;
+    uint32_t registerOffset = 0;
+    uint32_t registerValue = 0;
+    std::istringstream stream("");
+
+    for (std::string::const_iterator i = registers.begin();; i++) {
+        if (i == registers.end() || *i == delimiter) {
+            if (token.size() > 0) {
+                stream.str(token);
+                stream.clear();
+                firstElementInPair = !firstElementInPair;
+                stream >> std::hex >> (firstElementInPair ? registerOffset : registerValue);
+                if (stream.fail()) {
+                    result.clear();
+                    break;
+                }
+                token.clear();
+                if (!firstElementInPair) {
+                    result.push_back(std::pair<uint32_t, uint32_t>(registerOffset, registerValue));
+                    registerValue = 0;
+                    registerOffset = 0;
+                }
+            }
+            if (i == registers.end()) {
+                break;
+            }
+        } else {
+            token.push_back(*i);
+        }
+    }
+    return result;
+}
+
 template <typename GfxFamily>
 void CommandStreamReceiverSimulatedCommonHw<GfxFamily>::initAdditionalMMIO() {
-    auto newOffset = static_cast<uint32_t>(DebugManager.flags.AubDumpAddMmioRegister.get());
-    if (newOffset > 0) {
-        auto value = static_cast<uint32_t>(DebugManager.flags.AubDumpAddMmioRegisterValue.get());
-        stream->writeMMIO(newOffset, value);
+    if (DebugManager.flags.AubDumpAddMmioRegistersList.get() != "unk") {
+        auto mmioList = splitMMIORegisters(DebugManager.flags.AubDumpAddMmioRegistersList.get(), ';');
+        for (auto &mmioPair : mmioList) {
+            stream->writeMMIO(mmioPair.first, mmioPair.second);
+        }
     }
 }
 

runtime/os_interface/debug_variables_base.inl

@@ -21,8 +21,7 @@ DECLARE_DEBUG_VARIABLE(int32_t, AUBDumpFilterKernelEndIdx, -1, "End index of ker
 DECLARE_DEBUG_VARIABLE(int32_t, AUBDumpToggleCaptureOnOff, 0, "Toggle AUB capture on/off")
 DECLARE_DEBUG_VARIABLE(int32_t, AubDumpOverrideMmioRegister, 0, "Override mmio offset from list with new value from AubDumpOverrideMmioRegisterValue")
 DECLARE_DEBUG_VARIABLE(int32_t, AubDumpOverrideMmioRegisterValue, 0, "Value to override mmio offset from AubDumpOverrideMmioRegister")
-DECLARE_DEBUG_VARIABLE(int32_t, AubDumpAddMmioRegister, 0, "Program mmio offset that is not on default mmio list wtih value AubDumpAddMmioRegisterValue")
-DECLARE_DEBUG_VARIABLE(int32_t, AubDumpAddMmioRegisterValue, 0, "Value to add new mmio offset from AubDumpAddMmioRegister")
+DECLARE_DEBUG_VARIABLE(std::string, AubDumpAddMmioRegistersList, std::string("unk"), "Semicolon separated sequence of additional MMIO registers offset;values pairs i.e. 0x111;0x123;0x222;0x456")
 DECLARE_DEBUG_VARIABLE(int32_t, SetCommandStreamReceiver, 0, "Set command stream receiver to: 0 - HW, 1 - AUB, 2 - TBX, 3 - HW & AUB, 4 - TBX & AUB")
 DECLARE_DEBUG_VARIABLE(int32_t, TbxPort, 4321, "TCP-IP port of TBX server")
 DECLARE_DEBUG_VARIABLE(bool, FlattenBatchBufferForAUBDump, false, "Dump multi-level batch buffers to AUB as single, flat batch buffer")

unit_tests/command_stream/aub_command_stream_receiver_2_tests.cpp

@@ -714,7 +714,7 @@ HWTEST_F(AubCommandStreamReceiverTests, givenAubCommandStreamReceiverWhenEngineI
 
 HWTEST_F(AubCommandStreamReceiverTests, givenAddMmioKeySetToZeroWhenInitAdditionalMmioCalledThenDoNotWriteMmio) {
     DebugManagerStateRestore stateRestore;
-    DebugManager.flags.AubDumpAddMmioRegister.set(0);
+    DebugManager.flags.AubDumpAddMmioRegistersList.set("");
 
     auto aubCsr = std::make_unique<MockAubCsrToTestDumpContext<FamilyType>>(**platformDevices, "", true, executionEnvironment);
     EXPECT_NE(nullptr, aubCsr);
@@ -726,14 +726,12 @@ HWTEST_F(AubCommandStreamReceiverTests, givenAddMmioKeySetToZeroWhenInitAddition
     EXPECT_EQ(0u, stream->mmioList.size());
 }
 
-HWTEST_F(AubCommandStreamReceiverTests, givenAddMmioKeySetToNonZeroWhenInitAdditionalMmioCalledThenWriteGivenMmio) {
-    uint32_t offset = 0xdead;
-    uint32_t value = 0xbeef;
-    MMIOPair mmioPair(offset, value);
+HWTEST_F(AubCommandStreamReceiverTests, givenAddMmioRegistersListSetWhenInitAdditionalMmioCalledThenWriteGivenMmio) {
+    std::string registers("0xdead;0xbeef");
+    MMIOPair mmioPair(0xdead, 0xbeef);
 
     DebugManagerStateRestore stateRestore;
-    DebugManager.flags.AubDumpAddMmioRegister.set(offset);
-    DebugManager.flags.AubDumpAddMmioRegisterValue.set(value);
+    DebugManager.flags.AubDumpAddMmioRegistersList.set(registers);
 
     auto aubCsr = std::make_unique<MockAubCsrToTestDumpContext<FamilyType>>(**platformDevices, "", true, executionEnvironment);
     EXPECT_NE(nullptr, aubCsr);
@@ -746,6 +744,76 @@ HWTEST_F(AubCommandStreamReceiverTests, givenAddMmioKeySetToNonZeroWhenInitAddit
     EXPECT_TRUE(stream->isOnMmioList(mmioPair));
 };
 
+HWTEST_F(AubCommandStreamReceiverTests, givenLongSequenceOfAddMmioRegistersListSetWhenInitAdditionalMmioCalledThenWriteGivenMmio) {
+    std::string registers("1;1;2;2;3;3");
+
+    DebugManagerStateRestore stateRestore;
+    DebugManager.flags.AubDumpAddMmioRegistersList.set(registers);
+
+    auto aubCsr = std::make_unique<MockAubCsrToTestDumpContext<FamilyType>>(**platformDevices, "", true, executionEnvironment);
+    EXPECT_NE(nullptr, aubCsr);
+
+    auto stream = std::make_unique<MockAubFileStreamMockMmioWrite>();
+    aubCsr->stream = stream.get();
+    EXPECT_EQ(0u, stream->mmioList.size());
+    aubCsr->initAdditionalMMIO();
+    EXPECT_EQ(3u, stream->mmioList.size());
+}
+
+HWTEST_F(AubCommandStreamReceiverTests, givenSequenceWithIncompletePairOfAddMmioRegistersListSetWhenInitAdditionalMmioCalledThenWriteGivenMmio) {
+    std::string registers("0x1;0x1;0x2");
+    MMIOPair mmioPair0(0x1, 0x1);
+    MMIOPair mmioPair1(0x2, 0x2);
+
+    DebugManagerStateRestore stateRestore;
+    DebugManager.flags.AubDumpAddMmioRegistersList.set(registers);
+
+    auto aubCsr = std::make_unique<MockAubCsrToTestDumpContext<FamilyType>>(**platformDevices, "", true, executionEnvironment);
+    EXPECT_NE(nullptr, aubCsr);
+
+    auto stream = std::make_unique<MockAubFileStreamMockMmioWrite>();
+    aubCsr->stream = stream.get();
+    EXPECT_EQ(0u, stream->mmioList.size());
+    aubCsr->initAdditionalMMIO();
+    EXPECT_EQ(1u, stream->mmioList.size());
+    EXPECT_TRUE(stream->isOnMmioList(mmioPair0));
+    EXPECT_FALSE(stream->isOnMmioList(mmioPair1));
+}
+
+HWTEST_F(AubCommandStreamReceiverTests, givenAddMmioRegistersListSetWithSemicolonAtTheEndWhenInitAdditionalMmioCalledThenWriteGivenMmio) {
+    std::string registers("0xdead;0xbeef;");
+    MMIOPair mmioPair(0xdead, 0xbeef);
+
+    DebugManagerStateRestore stateRestore;
+    DebugManager.flags.AubDumpAddMmioRegistersList.set(registers);
+
+    auto aubCsr = std::make_unique<MockAubCsrToTestDumpContext<FamilyType>>(**platformDevices, "", true, executionEnvironment);
+    EXPECT_NE(nullptr, aubCsr);
+
+    auto stream = std::make_unique<MockAubFileStreamMockMmioWrite>();
+    aubCsr->stream = stream.get();
+    EXPECT_EQ(0u, stream->mmioList.size());
+    aubCsr->initAdditionalMMIO();
+    EXPECT_EQ(1u, stream->mmioList.size());
+    EXPECT_TRUE(stream->isOnMmioList(mmioPair));
+}
+
+HWTEST_F(AubCommandStreamReceiverTests, givenAddMmioRegistersListSetWithInvalidValueWhenInitAdditionalMmioCalledThenMmioIsNotWritten) {
+    std::string registers("0xdead;invalid");
+
+    DebugManagerStateRestore stateRestore;
+    DebugManager.flags.AubDumpAddMmioRegistersList.set(registers);
+
+    auto aubCsr = std::make_unique<MockAubCsrToTestDumpContext<FamilyType>>(**platformDevices, "", true, executionEnvironment);
+    EXPECT_NE(nullptr, aubCsr);
+
+    auto stream = std::make_unique<MockAubFileStreamMockMmioWrite>();
+    aubCsr->stream = stream.get();
+    EXPECT_EQ(0u, stream->mmioList.size());
+    aubCsr->initAdditionalMMIO();
+    EXPECT_EQ(0u, stream->mmioList.size());
+}
+
 HWTEST_F(AubCommandStreamReceiverTests, givenAubCsrWhenAskedForMemoryExpectationThenPassValidCompareOperationType) {
     class MyMockAubCsr : public AUBCommandStreamReceiverHw<FamilyType> {
       public:

unit_tests/memory_leak_listener.h

@@ -9,6 +9,7 @@
 #include "gtest/gtest.h"
 
 namespace OCLRT {
+
 // capture allocations call stacks to print them during memory leak in ULTs
 constexpr bool captureCallStacks = false;
 

unit_tests/test_files/igdrcl.config

@@ -94,6 +94,5 @@ EnableLocalMemory = false
 UseAubStream = false
 AubDumpOverrideMmioRegister = 0
 AubDumpOverrideMmioRegisterValue = 0
-AubDumpAddMmioRegister = 0
-AubDumpAddMmioRegisterValue = 0 
-PowerSavingMode = 0
+PowerSavingMode = 0
+AubDumpAddMmioRegistersList = unk