Add new arguments to aub dumping interface

Change-Id: I226ec04a919f4ca6ae5c237cf189e043f8286d5e

Author: zzdanowicz

runtime/aub_mem_dump/CMakeLists.txt

@@ -20,6 +20,7 @@
 
 set(RUNTIME_SRCS_AUB_MEM_DUMP
   ${CMAKE_CURRENT_SOURCE_DIR}/CMakeLists.txt
+  ${CMAKE_CURRENT_SOURCE_DIR}/aub_data.h
   ${CMAKE_CURRENT_SOURCE_DIR}/aub_header.h
   ${CMAKE_CURRENT_SOURCE_DIR}/aub_mem_dump.cpp
   ${CMAKE_CURRENT_SOURCE_DIR}/aub_mem_dump.h

runtime/aub_mem_dump/aub_data.h

@@ -0,0 +1,30 @@
+/*
+ * 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.
+ */
+#pragma once
+
+#include <cstdint>
+
+struct AubGTTData {
+    bool present;
+    bool writable;
+    bool userSupervisor;
+};

runtime/aub_mem_dump/aub_mem_dump.h

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2017, Intel Corporation
+ * Copyright (c) 2017 - 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"),
@@ -29,6 +29,8 @@
 #define BIT(x) (((uint64_t)1) << (x))
 #endif
 
+#include "runtime/aub_mem_dump/aub_data.h"
+
 namespace AubMemDump {
 #include "aub_services.h"
 
@@ -65,7 +67,9 @@ union IAPageTableEntry {
         uint64_t Dirty : 1;            //[6]
         uint64_t PAT : 1;              //[7]
         uint64_t Global : 1;           //[8]
-        uint64_t Reserved_11_9 : 3;    //[11:9]
+        uint64_t Reserved_9 : 1;       //[9]
+        uint64_t Reserved_10 : 1;      //[10]
+        uint64_t Reserved_11 : 1;      //[11]
         uint64_t PhysicalAddress : 27; //[38:12]
         uint64_t Reserved_51_39 : 13;  //[51:39]
         uint64_t Ignored : 11;         //[62:52]
@@ -77,14 +81,6 @@ union IAPageTableEntry {
 
 typedef IAPageTableEntry MiGttEntry;
 
-static inline void setGttEntry(IAPageTableEntry &entry, uint64_t address) {
-    entry.uiData = 0;
-    entry.pageConfig.PhysicalAddress = address / 4096;
-    entry.pageConfig.Present = true;
-    entry.pageConfig.Writable = true;
-    entry.pageConfig.UserSupervisor = true;
-}
-
 // Use the latest DeviceValues enumerations available
 typedef CmdServicesMemTraceVersion::DeviceValues DeviceValues;
 typedef CmdServicesMemTraceVersion::SteppingValues SteppingValues;
@@ -236,7 +232,7 @@ struct AubPageTableHelper32 : public AubPageTableHelper<Traits>, PageTableTraits
     typedef AubPageTableHelper<Traits> BaseClass;
 
     static void createContext(typename Traits::Stream &stream, uint32_t context);
-    static uint64_t reserveAddressPPGTT(typename Traits::Stream &stream, uintptr_t gfxAddress, size_t blockSize, uint64_t physAddress);
+    static uint64_t reserveAddressPPGTT(typename Traits::Stream &stream, uintptr_t gfxAddress, size_t blockSize, uint64_t physAddress, uint64_t additionalBits);
 
     static void fixupLRC(uint8_t *pLrc);
 };
@@ -250,7 +246,7 @@ struct AubPageTableHelper64 : public AubPageTableHelper<Traits>, PageTableTraits
     }
 
     static void createContext(typename Traits::Stream &stream, uint32_t context);
-    static uint64_t reserveAddressPPGTT(typename Traits::Stream &stream, uintptr_t gfxAddress, size_t blockSize, uint64_t physAddress);
+    static uint64_t reserveAddressPPGTT(typename Traits::Stream &stream, uintptr_t gfxAddress, size_t blockSize, uint64_t physAddress, uint64_t additionalBits);
 
     static void fixupLRC(uint8_t *pLrc);
 };
@@ -282,12 +278,13 @@ struct AubDump : public TypeSelector<AubPageTableHelper32<TraitsIn>, AubPageTabl
 
     // Write a block of memory to a given address space using an optional hint
     static void addMemoryWrite(Stream &stream, uint64_t addr, const void *memory, size_t blockSize, int addressSpace, int hint = DataTypeHintValues::TraceNotype);
-    static uint64_t reserveAddressGGTT(Stream &stream, uint32_t addr, size_t size, uint64_t physStart);
-    static uint64_t reserveAddressGGTT(Stream &stream, const void *memory, size_t size, uint64_t physStart);
-    static void reserveAddressGGTTAndWriteMmeory(Stream &stream, uintptr_t gfxAddress, const void *memory, uint64_t physAddress, size_t size, size_t offset);
+    static uint64_t reserveAddressGGTT(Stream &stream, uint32_t addr, size_t size, uint64_t physStart, AubGTTData data);
+    static uint64_t reserveAddressGGTT(Stream &stream, const void *memory, size_t size, uint64_t physStart, AubGTTData data);
+    static void reserveAddressGGTTAndWriteMmeory(Stream &stream, uintptr_t gfxAddress, const void *memory, uint64_t physAddress, size_t size, size_t offset, uint64_t additionalBits);
+    static void setGttEntry(IAPageTableEntry &entry, uint64_t address, AubGTTData data);
 
   private:
-    static uint64_t reserveAddress(Stream &stream, uint32_t addr, size_t size, unsigned int addressSpace /* = AddressSpaceValues::TraceGttEntry*/, uint64_t physStart);
+    static uint64_t reserveAddress(Stream &stream, uint32_t addr, size_t size, unsigned int addressSpace /* = AddressSpaceValues::TraceGttEntry*/, uint64_t physStart, AubGTTData data);
 };
 
 struct LrcaHelper {
@@ -381,4 +378,4 @@ struct LrcaHelperVecs : public LrcaHelper {
 
 extern const uint64_t g_pageMask;
 extern const size_t g_dwordCountMax;
-}
+} // namespace AubMemDump

runtime/aub_mem_dump/aub_mem_dump.inl

@@ -87,7 +87,7 @@ void AubDump<Traits>::addMemoryWrite(typename Traits::Stream &stream, uint64_t a
 
 // Reserve memory in the GGTT.
 template <typename Traits>
-uint64_t AubDump<Traits>::reserveAddress(typename Traits::Stream &stream, uint32_t addr, size_t size, unsigned int addressSpace, uint64_t physStart) {
+uint64_t AubDump<Traits>::reserveAddress(typename Traits::Stream &stream, uint32_t addr, size_t size, unsigned int addressSpace, uint64_t physStart, AubGTTData data) {
     auto startPage = addr & g_pageMask;
     auto endPage = (addr + size - 1) & g_pageMask;
     auto numPages = (uint32_t)(((endPage - startPage) / 4096) + 1);
@@ -105,7 +105,7 @@ uint64_t AubDump<Traits>::reserveAddress(typename Traits::Stream &stream, uint32
     uint64_t physAddress = physStart;
     while (startPage <= endPage) {
         MiGttEntry entry;
-        setGttEntry(entry, physAddress);
+        setGttEntry(entry, physAddress, data);
 
         stream.writeGTT(gttTableOffset, entry.uiData);
         gttTableOffset += sizeof(entry);
@@ -118,30 +118,39 @@ uint64_t AubDump<Traits>::reserveAddress(typename Traits::Stream &stream, uint32
 }
 
 template <typename Traits>
-uint64_t AubDump<Traits>::reserveAddressGGTT(typename Traits::Stream &stream, uint32_t addr, size_t size, uint64_t physStart) {
-    return AubDump<Traits>::reserveAddress(stream, addr, size, AddressSpaceValues::TraceGttEntry, physStart);
+uint64_t AubDump<Traits>::reserveAddressGGTT(typename Traits::Stream &stream, uint32_t addr, size_t size, uint64_t physStart, AubGTTData data) {
+    return AubDump<Traits>::reserveAddress(stream, addr, size, AddressSpaceValues::TraceGttEntry, physStart, data);
 }
 
 template <typename Traits>
-uint64_t AubDump<Traits>::reserveAddressGGTT(typename Traits::Stream &stream, const void *memory, size_t size, uint64_t physStart) {
+uint64_t AubDump<Traits>::reserveAddressGGTT(typename Traits::Stream &stream, const void *memory, size_t size, uint64_t physStart, AubGTTData data) {
     auto gfxAddress = BaseHelper::ptrToGGTT(memory);
-    return AubDump<Traits>::reserveAddress(stream, gfxAddress, size, AddressSpaceValues::TraceGttEntry, physStart);
+    return AubDump<Traits>::reserveAddress(stream, gfxAddress, size, AddressSpaceValues::TraceGttEntry, physStart, data);
 }
 
 template <typename Traits>
-void AubDump<Traits>::reserveAddressGGTTAndWriteMmeory(typename Traits::Stream &stream, uintptr_t gfxAddress, const void *memory, uint64_t physAddress, size_t size, size_t offset) {
+void AubDump<Traits>::reserveAddressGGTTAndWriteMmeory(typename Traits::Stream &stream, uintptr_t gfxAddress, const void *memory, uint64_t physAddress, size_t size, size_t offset, uint64_t additionalBits) {
     auto vmAddr = (gfxAddress + offset) & ~(MemoryConstants::pageSize - 1);
     auto pAddr = physAddress & ~(MemoryConstants::pageSize - 1);
 
-    AubDump<Traits>::reserveAddressPPGTT(stream, vmAddr, MemoryConstants::pageSize, pAddr);
+    AubDump<Traits>::reserveAddressPPGTT(stream, vmAddr, MemoryConstants::pageSize, pAddr, additionalBits);
 
     AubDump<Traits>::addMemoryWrite(stream, physAddress,
                                     reinterpret_cast<void *>(reinterpret_cast<uintptr_t>(memory) + offset),
                                     size, AubMemDump::AddressSpaceValues::TraceNonlocal);
 }
 
 template <typename Traits>
-uint64_t AubPageTableHelper32<Traits>::reserveAddressPPGTT(typename Traits::Stream &stream, uintptr_t gfxAddress, size_t blockSize, uint64_t physAddress) {
+void AubDump<Traits>::setGttEntry(IAPageTableEntry &entry, uint64_t address, AubGTTData data) {
+    entry.uiData = 0;
+    entry.pageConfig.PhysicalAddress = address / 4096;
+    entry.pageConfig.Present = data.present;
+    entry.pageConfig.Writable = data.writable;
+    entry.pageConfig.UserSupervisor = data.userSupervisor;
+}
+
+template <typename Traits>
+uint64_t AubPageTableHelper32<Traits>::reserveAddressPPGTT(typename Traits::Stream &stream, uintptr_t gfxAddress, size_t blockSize, uint64_t physAddress, uint64_t additionalBits) {
     auto startAddress = gfxAddress;
     auto endAddress = gfxAddress + blockSize - 1;
 
@@ -163,7 +172,7 @@ uint64_t AubPageTableHelper32<Traits>::reserveAddressPPGTT(typename Traits::Stre
         auto currPDE = startPDE;
         auto physPage = BaseClass::getPTEAddress(startPTE) & g_pageMask;
         while (currPDE <= endPDE) {
-            auto pde = physPage | 7;
+            auto pde = physPage | additionalBits;
 
             stream.writePTE(start_address, pde);
             start_address += sizeof(pde);
@@ -183,7 +192,7 @@ uint64_t AubPageTableHelper32<Traits>::reserveAddressPPGTT(typename Traits::Stre
         auto currPTE = startPTE;
         auto physPage = physAddress & g_pageMask;
         while (currPTE <= endPTE) {
-            auto pte = physPage | 7;
+            auto pte = physPage | additionalBits;
 
             stream.writePTE(start_address, pte);
             start_address += sizeof(pte);
@@ -197,7 +206,7 @@ uint64_t AubPageTableHelper32<Traits>::reserveAddressPPGTT(typename Traits::Stre
 }
 
 template <typename Traits>
-uint64_t AubPageTableHelper64<Traits>::reserveAddressPPGTT(typename Traits::Stream &stream, uintptr_t gfxAddress, size_t blockSize, uint64_t physAddress) {
+uint64_t AubPageTableHelper64<Traits>::reserveAddressPPGTT(typename Traits::Stream &stream, uintptr_t gfxAddress, size_t blockSize, uint64_t physAddress, uint64_t additionalBits) {
     auto startAddress = gfxAddress;
     auto endAddress = gfxAddress + blockSize - 1;
 
@@ -227,7 +236,7 @@ uint64_t AubPageTableHelper64<Traits>::reserveAddressPPGTT(typename Traits::Stre
         auto currPML4 = startPML4;
         auto physPage = BaseClass::getPDPAddress(startPDP) & g_pageMask;
         while (currPML4 <= endPML4) {
-            auto pml4 = physPage | 7;
+            auto pml4 = physPage | additionalBits;
 
             stream.writePTE(start_address, pml4);
             start_address += sizeof(pml4);
@@ -247,7 +256,7 @@ uint64_t AubPageTableHelper64<Traits>::reserveAddressPPGTT(typename Traits::Stre
         auto currPDP = startPDP;
         auto physPage = BaseClass::getPDEAddress(startPDE) & g_pageMask;
         while (currPDP <= endPDP) {
-            auto pdp = physPage | 7;
+            auto pdp = physPage | additionalBits;
 
             stream.writePTE(start_address, pdp);
             start_address += sizeof(pdp);
@@ -267,7 +276,7 @@ uint64_t AubPageTableHelper64<Traits>::reserveAddressPPGTT(typename Traits::Stre
         auto currPDE = startPDE;
         auto physPage = BaseClass::getPTEAddress(startPTE) & g_pageMask;
         while (currPDE <= endPDE) {
-            auto pde = physPage | 7;
+            auto pde = physPage | additionalBits;
 
             stream.writePTE(start_address, pde);
             start_address += sizeof(pde);
@@ -287,7 +296,7 @@ uint64_t AubPageTableHelper64<Traits>::reserveAddressPPGTT(typename Traits::Stre
         auto currPTE = startPTE;
         auto physPage = physAddress & g_pageMask;
         while (currPTE <= endPTE) {
-            auto pte = physPage | 7;
+            auto pte = physPage | additionalBits;
 
             stream.writePTE(start_address, pte);
             start_address += sizeof(pte);
@@ -337,4 +346,4 @@ void AubPageTableHelper64<Traits>::createContext(typename Traits::Stream &stream
     stream.createContext(cmd);
 }
 
-}
+} // namespace AubMemDump

runtime/command_stream/aub_command_stream_receiver_hw.h

@@ -91,5 +91,7 @@ class AUBCommandStreamReceiverHw : public CommandStreamReceiverHw<GfxFamily> {
     MOCKABLE_VIRTUAL bool addPatchInfoComments();
     void addGUCStartMessage(uint64_t batchBufferAddress, EngineType engineType);
     uint32_t getGUCWorkQueueItemHeader(EngineType engineType);
+    uint64_t getPPGTTAdditionalBits(GraphicsAllocation *gfxAllocation);
+    void getGTTData(void *memory, AubGTTData &data);
 };
 } // namespace OCLRT

runtime/command_stream/aub_command_stream_receiver_hw.inl

@@ -117,7 +117,9 @@ void AUBCommandStreamReceiverHw<GfxFamily>::initializeEngine(EngineType engineTy
             stream->addComment(str.str().c_str());
         }
 
-        AUB::reserveAddressGGTT(*stream, engineInfo.ggttHWSP, sizeHWSP, physHWSP);
+        AubGTTData data = {0};
+        getGTTData(reinterpret_cast<void *>(physHWSP), data);
+        AUB::reserveAddressGGTT(*stream, engineInfo.ggttHWSP, sizeHWSP, physHWSP, data);
         stream->writeMMIO(mmioBase + 0x2080, engineInfo.ggttHWSP);
     }
 
@@ -145,7 +147,9 @@ void AUBCommandStreamReceiverHw<GfxFamily>::initializeEngine(EngineType engineTy
             stream->addComment(str.str().c_str());
         }
 
-        AUB::reserveAddressGGTT(*stream, engineInfo.ggttRingBuffer, engineInfo.sizeRingBuffer, physRingBuffer);
+        AubGTTData data = {0};
+        getGTTData(reinterpret_cast<void *>(physRingBuffer), data);
+        AUB::reserveAddressGGTT(*stream, engineInfo.ggttRingBuffer, engineInfo.sizeRingBuffer, physRingBuffer, data);
     }
 
     // Initialize the ring MMIO registers
@@ -171,7 +175,9 @@ void AUBCommandStreamReceiverHw<GfxFamily>::initializeEngine(EngineType engineTy
             stream->addComment(str.str().c_str());
         }
 
-        AUB::reserveAddressGGTT(*stream, engineInfo.ggttLRCA, sizeLRCA, lrcAddressPhys);
+        AubGTTData data = {0};
+        getGTTData(reinterpret_cast<void *>(lrcAddressPhys), data);
+        AUB::reserveAddressGGTT(*stream, engineInfo.ggttLRCA, sizeLRCA, lrcAddressPhys, data);
         AUB::addMemoryWrite(
             *stream,
             lrcAddressPhys,
@@ -236,7 +242,7 @@ FlushStamp AUBCommandStreamReceiverHw<GfxFamily>::flush(BatchBuffer &batchBuffer
         }
 
         auto physBatchBuffer = ppgtt.map(reinterpret_cast<uintptr_t>(pBatchBuffer), sizeBatchBuffer);
-        AUB::reserveAddressPPGTT(*stream, reinterpret_cast<uintptr_t>(pBatchBuffer), sizeBatchBuffer, physBatchBuffer);
+        AUB::reserveAddressPPGTT(*stream, reinterpret_cast<uintptr_t>(pBatchBuffer), sizeBatchBuffer, physBatchBuffer, getPPGTTAdditionalBits(batchBuffer.commandBufferAllocation));
 
         AUB::addMemoryWrite(
             *stream,
@@ -486,7 +492,7 @@ bool AUBCommandStreamReceiverHw<GfxFamily>::writeMemory(GraphicsAllocation &gfxA
     }
 
     PageWalker walker = [&](uint64_t physAddress, size_t size, size_t offset) {
-        AUB::reserveAddressGGTTAndWriteMmeory(*stream, static_cast<uintptr_t>(gpuAddress), cpuAddress, physAddress, size, offset);
+        AUB::reserveAddressGGTTAndWriteMmeory(*stream, static_cast<uintptr_t>(gpuAddress), cpuAddress, physAddress, size, offset, getPPGTTAdditionalBits(&gfxAllocation));
     };
     ppgtt.pageWalk(static_cast<uintptr_t>(gpuAddress), size, 0, walker);
 
@@ -547,7 +553,7 @@ void AUBCommandStreamReceiverHw<GfxFamily>::addGUCStartMessage(uint64_t batchBuf
     miBatchBufferStart->setAddressSpaceIndicator(MI_BATCH_BUFFER_START::ADDRESS_SPACE_INDICATOR_PPGTT);
 
     auto physBufferAddres = ppgtt.map(reinterpret_cast<uintptr_t>(buffer.get()), bufferSize);
-    AUB::reserveAddressPPGTT(*stream, reinterpret_cast<uintptr_t>(buffer.get()), bufferSize, physBufferAddres);
+    AUB::reserveAddressPPGTT(*stream, reinterpret_cast<uintptr_t>(buffer.get()), bufferSize, physBufferAddres, getPPGTTAdditionalBits(linearStream.getGraphicsAllocation()));
 
     AUB::addMemoryWrite(
         *stream,
@@ -566,4 +572,16 @@ uint32_t AUBCommandStreamReceiverHw<GfxFamily>::getGUCWorkQueueItemHeader(Engine
     return GUCWorkQueueItemHeader;
 }
 
+template <typename GfxFamily>
+uint64_t AUBCommandStreamReceiverHw<GfxFamily>::getPPGTTAdditionalBits(GraphicsAllocation *gfxAllocation) {
+    return 7;
+}
+
+template <typename GfxFamily>
+void AUBCommandStreamReceiverHw<GfxFamily>::getGTTData(void *memory, AubGTTData &data) {
+    data.present = true;
+    data.writable = true;
+    data.userSupervisor = true;
+}
+
 } // namespace OCLRT

runtime/command_stream/tbx_command_stream_receiver_hw.h

@@ -84,6 +84,8 @@ class TbxCommandStreamReceiverHw : public CommandStreamReceiverHw<GfxFamily> {
     TbxMemoryManager *getMemoryManager() {
         return (TbxMemoryManager *)CommandStreamReceiver::getMemoryManager();
     }
+    uint64_t getPPGTTAdditionalBits(GraphicsAllocation *gfxAllocation);
+    void getGTTData(void *memory, AubGTTData &data);
 
     TbxCommandStreamReceiver::TbxStream stream;