Added playback utility for DirectStorage traces with enchaned capture…

… capability (it works properly now). Many fixes and improvements.

README.md

@@ -284,6 +284,11 @@ ID3D12CommandList* pCommandLists[] = { commandLists.m_beforeDrawCommands, m_comm
 
 ## Log
 
+- 2022-10-24: Added DirectStorage trace playback utility to measure performance of file upload independent of rendering. For example, to capture and playback the DirectStorage requests and submits for 500 "stressful" frames with a staging buffer size of 128MB, cd to the build directory and:
+```
+stress.bat -timingstart 200 -timingstop 700 -capturetrace
+traceplayer.exe -file uploadTraceFile_1.json -mediadir media -staging 128
+```
 - 2022-06-10: File format (.xet) change. DdsToXet can upgrade old Xet files to the new format. Assets in the DDS directory are exported at build time into media directory. Upgrade to DirectStorage v1.0.2. Many misc. improvements.
 - 2022-05-05: Workaround for rare race condition. Many tweaks and improvements.
 - 2022-03-14: DirectStorage 1.0.0 integrated into mainline

SamplerFeedbackStreaming.sln

@@ -3,10 +3,12 @@ Microsoft Visual Studio Solution File, Format Version 12.00
 # Visual Studio Version 16
 VisualStudioVersion = 16.0.29920.165
 MinimumVisualStudioVersion = 10.0.40219.1
-Project("{8BC9CEB8-8B4A-11D0-8D11-00A0C91BC942}") = "Expanse", "src\Expanse.vcxproj", "{E9BCC846-C1E9-402F-AC99-0E72195202AC}"
+Project("{8BC9CEB8-8B4A-11D0-8D11-00A0C91BC942}") = "Expanse", "src\Expanse.vcxproj", "{A92A871F-FFF6-4A14-A3A2-EA583C0EA015}"
 	ProjectSection(ProjectDependencies) = postProject
+		{273A5112-7D55-4A16-829A-E4F73E4BACE7} = {273A5112-7D55-4A16-829A-E4F73E4BACE7}
 		{45087328-C272-4BB6-BB09-95D899D2276A} = {45087328-C272-4BB6-BB09-95D899D2276A}
 		{12A36A45-4A15-48E3-B886-257E81FD57C6} = {12A36A45-4A15-48E3-B886-257E81FD57C6}
+		{369039E2-4C18-40D9-A7FE-E3D87BA23149} = {369039E2-4C18-40D9-A7FE-E3D87BA23149}
 	EndProjectSection
 EndProject
 Project("{8BC9CEB8-8B4A-11D0-8D11-00A0C91BC942}") = "imgui", "imgui\imgui.vcxproj", "{45087328-C272-4BB6-BB09-95D899D2276A}"
@@ -17,17 +19,19 @@ Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "Tools", "Tools", "{EB9EA81E
 EndProject
 Project("{8BC9CEB8-8B4A-11D0-8D11-00A0C91BC942}") = "DdsToXet", "DdsToXet\DdsToXet.vcxproj", "{369039E2-4C18-40D9-A7FE-E3D87BA23149}"
 EndProject
+Project("{8BC9CEB8-8B4A-11D0-8D11-00A0C91BC942}") = "tracePlayer_2019", "tracePlayer\tracePlayer_2019.vcxproj", "{273A5112-7D55-4A16-829A-E4F73E4BACE7}"
+EndProject
 Global
 	GlobalSection(SolutionConfigurationPlatforms) = preSolution
 		Debug|x64 = Debug|x64
 		Release|x64 = Release|x64
 	EndGlobalSection
 	GlobalSection(ProjectConfigurationPlatforms) = postSolution
-		{E9BCC846-C1E9-402F-AC99-0E72195202AC}.Debug|x64.ActiveCfg = Debug|x64
-		{E9BCC846-C1E9-402F-AC99-0E72195202AC}.Debug|x64.Build.0 = Debug|x64
-		{E9BCC846-C1E9-402F-AC99-0E72195202AC}.Debug|x64.Deploy.0 = Debug|x64
-		{E9BCC846-C1E9-402F-AC99-0E72195202AC}.Release|x64.ActiveCfg = Release|x64
-		{E9BCC846-C1E9-402F-AC99-0E72195202AC}.Release|x64.Build.0 = Release|x64
+		{A92A871F-FFF6-4A14-A3A2-EA583C0EA015}.Debug|x64.ActiveCfg = Debug|x64
+		{A92A871F-FFF6-4A14-A3A2-EA583C0EA015}.Debug|x64.Build.0 = Debug|x64
+		{A92A871F-FFF6-4A14-A3A2-EA583C0EA015}.Debug|x64.Deploy.0 = Debug|x64
+		{A92A871F-FFF6-4A14-A3A2-EA583C0EA015}.Release|x64.ActiveCfg = Release|x64
+		{A92A871F-FFF6-4A14-A3A2-EA583C0EA015}.Release|x64.Build.0 = Release|x64
 		{45087328-C272-4BB6-BB09-95D899D2276A}.Debug|x64.ActiveCfg = Debug|x64
 		{45087328-C272-4BB6-BB09-95D899D2276A}.Debug|x64.Build.0 = Debug|x64
 		{45087328-C272-4BB6-BB09-95D899D2276A}.Release|x64.ActiveCfg = Release|x64
@@ -40,12 +44,17 @@ Global
 		{369039E2-4C18-40D9-A7FE-E3D87BA23149}.Debug|x64.Build.0 = Debug|x64
 		{369039E2-4C18-40D9-A7FE-E3D87BA23149}.Release|x64.ActiveCfg = Release|x64
 		{369039E2-4C18-40D9-A7FE-E3D87BA23149}.Release|x64.Build.0 = Release|x64
+		{273A5112-7D55-4A16-829A-E4F73E4BACE7}.Debug|x64.ActiveCfg = Debug|x64
+		{273A5112-7D55-4A16-829A-E4F73E4BACE7}.Debug|x64.Build.0 = Debug|x64
+		{273A5112-7D55-4A16-829A-E4F73E4BACE7}.Release|x64.ActiveCfg = Release|x64
+		{273A5112-7D55-4A16-829A-E4F73E4BACE7}.Release|x64.Build.0 = Release|x64
 	EndGlobalSection
 	GlobalSection(SolutionProperties) = preSolution
 		HideSolutionNode = FALSE
 	EndGlobalSection
 	GlobalSection(NestedProjects) = preSolution
 		{369039E2-4C18-40D9-A7FE-E3D87BA23149} = {EB9EA81E-AD7B-4F2F-B8A9-AFC9282303C9}
+		{273A5112-7D55-4A16-829A-E4F73E4BACE7} = {EB9EA81E-AD7B-4F2F-B8A9-AFC9282303C9}
 	EndGlobalSection
 	GlobalSection(ExtensibilityGlobals) = postSolution
 		SolutionGuid = {CECC8215-A95C-44A3-94DC-6A6AEE5A841B}

SamplerFeedbackStreaming_vs2022.sln

@@ -14,10 +14,13 @@ EndProject
 Project("{8BC9CEB8-8B4A-11D0-8D11-00A0C91BC942}") = "Expanse", "src\Expanse_vs2022.vcxproj", "{E9BCC846-C1E9-402F-AC99-0E72195202AC}"
 	ProjectSection(ProjectDependencies) = postProject
 		{12A36A45-4A15-48E3-B886-257E81FD57C6} = {12A36A45-4A15-48E3-B886-257E81FD57C6}
+		{273A5112-7D55-4A16-829A-E4F73E4BACE7} = {273A5112-7D55-4A16-829A-E4F73E4BACE7}
 		{369039E2-4C18-40D9-A7FE-E3D87BA23149} = {369039E2-4C18-40D9-A7FE-E3D87BA23149}
 		{45087328-C272-4BB6-BB09-95D899D2276A} = {45087328-C272-4BB6-BB09-95D899D2276A}
 	EndProjectSection
 EndProject
+Project("{8BC9CEB8-8B4A-11D0-8D11-00A0C91BC942}") = "tracePlayer", "tracePlayer\tracePlayer.vcxproj", "{273A5112-7D55-4A16-829A-E4F73E4BACE7}"
+EndProject
 Global
 	GlobalSection(SolutionConfigurationPlatforms) = preSolution
 		Debug|x64 = Debug|x64
@@ -40,12 +43,17 @@ Global
 		{E9BCC846-C1E9-402F-AC99-0E72195202AC}.Debug|x64.Build.0 = Debug|x64
 		{E9BCC846-C1E9-402F-AC99-0E72195202AC}.Release|x64.ActiveCfg = Release|x64
 		{E9BCC846-C1E9-402F-AC99-0E72195202AC}.Release|x64.Build.0 = Release|x64
+		{273A5112-7D55-4A16-829A-E4F73E4BACE7}.Debug|x64.ActiveCfg = Debug|x64
+		{273A5112-7D55-4A16-829A-E4F73E4BACE7}.Debug|x64.Build.0 = Debug|x64
+		{273A5112-7D55-4A16-829A-E4F73E4BACE7}.Release|x64.ActiveCfg = Release|x64
+		{273A5112-7D55-4A16-829A-E4F73E4BACE7}.Release|x64.Build.0 = Release|x64
 	EndGlobalSection
 	GlobalSection(SolutionProperties) = preSolution
 		HideSolutionNode = FALSE
 	EndGlobalSection
 	GlobalSection(NestedProjects) = preSolution
 		{369039E2-4C18-40D9-A7FE-E3D87BA23149} = {EB9EA81E-AD7B-4F2F-B8A9-AFC9282303C9}
+		{273A5112-7D55-4A16-829A-E4F73E4BACE7} = {EB9EA81E-AD7B-4F2F-B8A9-AFC9282303C9}
 	EndGlobalSection
 	GlobalSection(ExtensibilityGlobals) = postSolution
 		SolutionGuid = {CECC8215-A95C-44A3-94DC-6A6AEE5A841B}

TileUpdateManager/FileStreamer.cpp

@@ -101,6 +101,18 @@ Streaming::FileStreamer::~FileStreamer()
     // write trace file
     if (m_captureTrace)
     {
+        UINT resourceIndex = 0;
+        for (const auto& d : m_tracingResources)
+        {
+            auto& r = m_trace.GetRoot()["resources"][resourceIndex];
+            r["rsrc"] = (UINT64)d.first;
+            r["fmt"] = (UINT32)d.second.Format;
+            r["dim"][0] = (UINT32)d.second.Width;
+            r["dim"][1] = (UINT32)d.second.Height;
+            r["dim"][2] = (UINT32)d.second.MipLevels;
+            resourceIndex++;
+        }
+
         int index = 0;
         while (1)
         {
@@ -117,16 +129,31 @@ Streaming::FileStreamer::~FileStreamer()
 //-----------------------------------------------------------------------------
 // append an upload request to the trace file
 //-----------------------------------------------------------------------------
-void Streaming::FileStreamer::TraceRequest(const D3D12_TILED_RESOURCE_COORDINATE& in_coord,
-    UINT64 in_offset, UINT64 in_fileHandle, UINT32 in_numBytes)
+void Streaming::FileStreamer::TraceRequest(
+    ID3D12Resource* in_pDstResource, const D3D12_TILED_RESOURCE_COORDINATE& in_dstCoord,
+    const std::wstring& in_srcFilename, UINT64 in_srcOffset, UINT32 in_srcNumBytes, UINT32 in_compressionFormat)
 {
     auto& r = m_trace.GetRoot()["submits"][m_traceSubmitIndex][m_traceRequestIndex++];
-    r["coord"][0] = in_coord.X;
-    r["coord"][1] = in_coord.Y;
-    r["coord"][2] = in_coord.Subresource;
-    r["off"] = in_offset;
-    r["file"] = in_fileHandle;
-    r["size"] = in_numBytes;
+    r["rsrc"] = (UINT64)in_pDstResource;
+    r["coord"][0] = in_dstCoord.X;
+    r["coord"][1] = in_dstCoord.Y;
+    r["coord"][2] = in_dstCoord.Subresource;
+
+    std::string filename;
+    int buf_len = ::WideCharToMultiByte(CP_UTF8, 0, in_srcFilename.c_str(), -1, NULL, 0, NULL, NULL);
+    filename.resize(buf_len);
+    ::WideCharToMultiByte(CP_UTF8, 0, in_srcFilename.c_str(), -1, filename.data(), buf_len, NULL, NULL);
+    r["file"] = filename;
+
+    r["off"] = in_srcOffset;
+    r["size"] = in_srcNumBytes;
+    if (in_compressionFormat) { r["comp"] = in_compressionFormat; }
+
+    auto desc = m_tracingResources.find(in_pDstResource);
+    if (m_tracingResources.end() == desc)
+    {
+        m_tracingResources[in_pDstResource] = in_pDstResource->GetDesc();
+    }
 }
 
 //-----------------------------------------------------------------------------

TileUpdateManager/FileStreamer.h

@@ -28,6 +28,7 @@
 
 #include "Streaming.h"
 #include "ConfigurationParser.h"
+#include <unordered_map>
 
 namespace Streaming
 {
@@ -86,13 +87,15 @@ namespace Streaming
         // trace file
         bool m_captureTrace{ false };
 
-        void TraceRequest(const D3D12_TILED_RESOURCE_COORDINATE& in_coord,
-            UINT64 in_offset, UINT64 in_fileHandle, UINT32 in_numBytes);
+        void TraceRequest(
+            ID3D12Resource* in_pDstResource, const D3D12_TILED_RESOURCE_COORDINATE& in_dstCoord,
+            const std::wstring& in_srcFilename, UINT64 in_srcOffset, UINT32 in_srcNumBytes, UINT32 in_compressionFormat);
         void TraceSubmit();
     private:
         bool m_firstSubmit{ true };
         ConfigurationParser m_trace; // array of submits, each submit is an array of requests
         UINT m_traceSubmitIndex{ 0 };
         UINT m_traceRequestIndex{ 0 };
+        std::unordered_map<ID3D12Resource*, D3D12_RESOURCE_DESC> m_tracingResources;
     };
 }

TileUpdateManager/FileStreamerDS.cpp

@@ -1,4 +1,28 @@
-#pragma once
+//*********************************************************
+//
+// Copyright 2020 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 "pch.h"
 
@@ -88,7 +112,11 @@ void Streaming::FileStreamerDS::StreamTexture(Streaming::UpdateList& in_updateLi
 
             if (m_captureTrace)
             {
-                TraceRequest(coord, request.Source.File.Offset, (UINT64)request.Source.File.Source, (UINT32)request.Source.File.Size);
+                std::wstring fileName = std::filesystem::path(in_updateList.m_pStreamingResource->GetFileName()).filename();
+                TraceRequest(pAtlas, coord, fileName,
+                    request.Source.File.Offset,
+                    (UINT32)request.Source.File.Size,
+                    (UINT32)request.Options.CompressionFormat);
             }
         }
     }

TileUpdateManager/FileStreamerDS.h

@@ -1,3 +1,28 @@
+//*********************************************************
+//
+// Copyright 2020 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 <dstorage.h>
 

TileUpdateManager/FileStreamerReference.cpp

@@ -32,6 +32,8 @@
 #include "StreamingResourceDU.h"
 #include "StreamingHeap.h"
 
+static const  D3D12_COMMAND_LIST_TYPE g_commandListType = D3D12_COMMAND_LIST_TYPE_COPY;
+
 //-----------------------------------------------------------------------------
 // Constructor
 //-----------------------------------------------------------------------------
@@ -47,7 +49,7 @@ Streaming::FileStreamerReference::FileStreamerReference(ID3D12Device* in_pDevice
 
     D3D12_COMMAND_QUEUE_DESC queueDesc = {};
     queueDesc.Flags = D3D12_COMMAND_QUEUE_FLAG_NONE;
-    queueDesc.Type = D3D12_COMMAND_LIST_TYPE_COPY;
+    queueDesc.Type = g_commandListType;
     ThrowIfFailed(in_pDevice->CreateCommandQueue(&queueDesc, IID_PPV_ARGS(&m_copyCommandQueue)));
     m_copyCommandQueue->SetName(L"FileStreamerReference::m_copyCommandQueue");
 
@@ -66,7 +68,7 @@ Streaming::FileStreamerReference::FileStreamerReference(ID3D12Device* in_pDevice
         copyBatchIndex++;
     }
 
-    ThrowIfFailed(in_pDevice->CreateCommandList(0, D3D12_COMMAND_LIST_TYPE_COPY, m_copyBatches[0].GetCommandAllocator(), nullptr, IID_PPV_ARGS(&m_copyCommandList)));
+    ThrowIfFailed(in_pDevice->CreateCommandList(0, queueDesc.Type, m_copyBatches[0].GetCommandAllocator(), nullptr, IID_PPV_ARGS(&m_copyCommandList)));
     m_copyCommandList->SetName(L"FileStreamerReference::m_copyCommandList");
     m_copyCommandList->Close();
 
@@ -98,7 +100,7 @@ Streaming::FileStreamerReference::~FileStreamerReference()
 //=============================================================================
 void Streaming::FileStreamerReference::CopyBatch::Init(ID3D12Device* in_pDevice)
 {
-    ThrowIfFailed(in_pDevice->CreateCommandAllocator(D3D12_COMMAND_LIST_TYPE_COPY, IID_PPV_ARGS(&m_commandAllocator)));
+    ThrowIfFailed(in_pDevice->CreateCommandAllocator(g_commandListType, IID_PPV_ARGS(&m_commandAllocator)));
 }
 
 

TileUpdateManager/StreamingHeap.cpp

@@ -101,7 +101,7 @@ UINT Streaming::Atlas::CreateAtlas(
     // Layout must be D3D12_TEXTURE_LAYOUT_64KB_UNDEFINED_SWIZZLE when creating reserved resources
     rd.Layout = D3D12_TEXTURE_LAYOUT_64KB_UNDEFINED_SWIZZLE;
 
-    // this will only every be a copy dest
+    // this will only ever be a copy dest
     ThrowIfFailed(device->CreateReservedResource(&rd, D3D12_RESOURCE_STATE_COPY_DEST, nullptr, IID_PPV_ARGS(&out_pDst)));
     out_pDst->SetName(L"DataUploader::m_atlas");
 

TileUpdateManager/StreamingResourceBase.h

@@ -155,6 +155,8 @@ namespace Streaming
         UINT GetNumTilesHeight() const { return m_tileReferencesHeight; }
 
     protected:
+        const std::wstring m_filename;
+
         // object that streams data from a file
         std::unique_ptr<Streaming::XeTexture> m_pTextureFileInfo;
         std::unique_ptr<Streaming::InternalResources> m_resources;
@@ -256,9 +258,6 @@ namespace Streaming
         std::atomic<bool> m_setZeroRefCounts{ false };
 
     private:
-
-        const std::wstring m_filename;
-
         // do not immediately decmap:
         // need to withhold until in-flight command buffers have completed
         class EvictionDelay

TileUpdateManager/StreamingResourceDU.h

@@ -50,6 +50,7 @@ namespace Streaming
         ID3D12Resource* GetTiledResource() const { return m_resources->GetTiledResource(); }
 
         const FileHandle* GetFileHandle() const { return m_pFileHandle.get(); }
+        const std::wstring& GetFileName() const { return m_filename; }
 
         std::vector<BYTE>& GetPaddedPackedMips(UINT& out_uncompressedSize) { out_uncompressedSize = m_packedMipsUncompressedSize; return m_packedMips; }
 

TileUpdateManager/TileUpdateManagerBase.cpp

@@ -213,9 +213,11 @@ void Streaming::TileUpdateManagerBase::ProcessFeedbackThread()
         {
             UINT newStaleSize = 0; // track number of stale resources, then resize the array to the updated number
             UINT staleIndex = 0;
+
+            // loop over stale resources
             for (; staleIndex < staleResources.size(); staleIndex++)
             {
-                if (m_pDataUploader->GetNumUpdateListsAvailable())
+                if (m_pDataUploader->GetNumUpdateListsAvailable() && m_threadsRunning)
                 {
                     UINT resourceIndex = staleResources[staleIndex];
                     uploadsRequested += m_streamingResources[resourceIndex]->QueueTiles();
@@ -231,10 +233,8 @@ void Streaming::TileUpdateManagerBase::ProcessFeedbackThread()
                         pending[resourceIndex] = 0; // clear the flag that prevents duplicates
                     }
                 }
-                else
+                else // compact the stale array with a memcpy and do no further processing.
                 {
-                    // if no UpdateLists, then compact the stale array with a memcpy and do no further processing.
-
                     UINT numNotUpdated = UINT(staleResources.size() - staleIndex);
                     if (0 != staleIndex) // no need to move contents if no changes made
                     {

config/config.json

@@ -25,7 +25,7 @@
   "mediaDir": "media", // media directory
   "texture": "", // setting this overrides all textures, invalidates mediadir
   "skyTexture": "", // add a sky sphere. path relative to mediadir
-  "earthTexture": "", // when this texture is encountered, treat it as spherically projected (no uv mirror)
+  "earthTexture": "earth", // when a texture containing this string is encountered, treat it as a mercator projection (no uv mirror)
   "terrainTexture": "4kTiles.xet", // use this texture only for the terrain, no planets
   "maxNumObjects": 985, // maximum total number of objects in the scene
   "numSpheres": 0, // number of objects besides the terrain

include/ArgParser.h

@@ -198,7 +198,7 @@ inline void ArgParser::Parse()
 template<typename T> inline void ArgParser::AddArg(std::wstring s, ArgFunction f, T default_value, std::wstring d)
 {
     std::wstringstream w;
-    w << ": " << d << " (default: " << default_value << ") ";
+    w << d << " (default: " << default_value << ") ";
     AddArg(s, f, w.str());
 }