GPUUploadManager: add bucket info to stats

Author: TheMostDiligent

Graphics/GraphicsTools/include/GPUUploadManagerImpl.hpp

@@ -218,6 +218,7 @@ class GPUUploadManagerImpl final : public ObjectBase<IGPUUploadManager>
     Page* AcquireFreePage(IDeviceContext* pContext, Uint32 RequiredSize = 0);
     Page* CreatePage(IDeviceContext* pContext, Uint32 RequiredSize = 0);
     void  ProcessPagesToRelease(IDeviceContext* pContext);
+    void  UpdateBucketInfo();
 
 private:
     const Uint32 m_PageSize;
@@ -257,6 +258,7 @@ class GPUUploadManagerImpl final : public ObjectBase<IGPUUploadManager>
 
     std::unordered_map<Page*, std::unique_ptr<Page>> m_Pages;
     std::map<Uint32, Uint32>                         m_PageSizeToCount;
+    std::vector<GPUUploadManagerBucketInfo>          m_BucketInfo;
 
     // The number of running ScheduleBufferUpdate operations.
     std::atomic<Uint32> m_NumRunningUpdates{0};

Graphics/GraphicsTools/interface/GPUUploadManager.h

@@ -65,6 +65,18 @@ typedef void (*GPUUploadEnqueuedCallbackType)(IBuffer* pDstBuffer,
                                               void*    pUserData);
 
 
+/// GPU upload manager page bucket information.
+struct GPUUploadManagerBucketInfo
+{
+    /// Page size in bytes.
+    Uint32 PageSize DEFAULT_INITIALIZER(0);
+
+    /// Number of pages currently in the manager.
+    Uint32 NumPages DEFAULT_INITIALIZER(0);
+};
+typedef struct GPUUploadManagerBucketInfo GPUUploadManagerBucketInfo;
+
+
 /// GPU upload manager statistics.
 struct GPUUploadManagerStats
 {
@@ -87,6 +99,13 @@ struct GPUUploadManagerStats
 
     /// Peak size of a single update in bytes.
     Uint32 PeakUpdateSize DEFAULT_INITIALIZER(0);
+
+    /// The number of buckets in the manager. Each bucket corresponds to a specific page size.
+    Uint32 NumBuckets DEFAULT_INITIALIZER(0);
+
+    /// Information about each bucket. The array contains NumBuckets valid entries.
+    /// The pointer is valid only until the next call to GetStats() method and only while the manager is alive.
+    const GPUUploadManagerBucketInfo* pBucketInfo DEFAULT_INITIALIZER(nullptr);
 };
 typedef struct GPUUploadManagerStats GPUUploadManagerStats;
 

Graphics/GraphicsTools/src/GPUUploadManagerImpl.cpp

@@ -591,6 +591,7 @@ GPUUploadManagerImpl::Page* GPUUploadManagerImpl::CreatePage(IDeviceContext* pCo
     }
     m_Pages.emplace(P, std::move(NewPage));
     m_PageSizeToCount[PageSize]++;
+    UpdateBucketInfo();
     m_PeakPageCount = std::max(m_PeakPageCount, static_cast<Uint32>(m_Pages.size()));
 
     return P;
@@ -760,6 +761,7 @@ void GPUUploadManagerImpl::ProcessPagesToRelease(IDeviceContext* pContext)
                 UNEXPECTED("Page size not found in the map");
             }
             m_Pages.erase(pPage);
+            UpdateBucketInfo();
         }
         else
         {
@@ -806,6 +808,15 @@ GPUUploadManagerImpl::Page* GPUUploadManagerImpl::AcquireFreePage(IDeviceContext
     return P;
 }
 
+void GPUUploadManagerImpl::UpdateBucketInfo()
+{
+    m_BucketInfo.clear();
+    for (const auto& it : m_PageSizeToCount)
+    {
+        m_BucketInfo.emplace_back(GPUUploadManagerBucketInfo{it.first, it.second});
+    }
+}
+
 void GPUUploadManagerImpl::GetStats(GPUUploadManagerStats& Stats) const
 {
     Stats.NumPages         = static_cast<Uint32>(m_Pages.size());
@@ -815,6 +826,9 @@ void GPUUploadManagerImpl::GetStats(GPUUploadManagerStats& Stats) const
 
     Stats.PeakTotalPendingUpdateSize = m_PeakTotalPendingUpdateSize;
     Stats.PeakUpdateSize             = m_PeakUpdateSize.load(std::memory_order_relaxed);
+
+    Stats.NumBuckets  = static_cast<Uint32>(m_PageSizeToCount.size());
+    Stats.pBucketInfo = m_BucketInfo.data();
 }
 
 void CreateGPUUploadManager(const GPUUploadManagerCreateInfo& CreateInfo,

Tests/DiligentCoreAPITest/src/GPUUploadManagerTest.cpp

@@ -45,6 +45,25 @@ using namespace std::chrono_literals;
 namespace
 {
 
+std::string PrintBucketInfo(const GPUUploadManagerStats& Stats)
+{
+    std::string Result;
+    for (Uint32 i = 0; i < Stats.NumBuckets; ++i)
+    {
+        if (!Result.empty())
+            Result.push_back('\n');
+        Result += "      ";
+        const GPUUploadManagerBucketInfo& BucketInfo = Stats.pBucketInfo[i];
+        Result += GetMemorySizeString(BucketInfo.PageSize) + ": ";
+        for (Uint32 j = 0; j < BucketInfo.NumPages; ++j)
+        {
+            Result.push_back('#');
+        }
+        Result += " " + std::to_string(BucketInfo.NumPages);
+    }
+    return Result;
+}
+
 TEST(GPUUploadManagerTest, Creation)
 {
     GPUTestingEnvironment* pEnv     = GPUTestingEnvironment::GetInstance();
@@ -233,7 +252,8 @@ TEST(GPUUploadManagerTest, ParallelUpdates)
                      "\n    NumFreePages               ", Stats.NumFreePages,
                      "\n    NumInFlightPages           ", Stats.NumInFlightPages,
                      "\n    PeakTotalPendingUpdateSize ", Stats.PeakTotalPendingUpdateSize,
-                     "\n    PeakUpdateSize             ", Stats.PeakUpdateSize);
+                     "\n    PeakUpdateSize             ", Stats.PeakUpdateSize,
+                     "\n    Buckets:\n", PrintBucketInfo(Stats));
 
     VerifyBufferContents(pBuffer, BufferData);
 }
@@ -373,7 +393,8 @@ TEST(GPUUploadManagerTest, CreateWithNullContext)
                      "\n    NumFreePages               ", Stats.NumFreePages,
                      "\n    NumInFlightPages           ", Stats.NumInFlightPages,
                      "\n    PeakTotalPendingUpdateSize ", Stats.PeakTotalPendingUpdateSize,
-                     "\n    PeakUpdateSize             ", Stats.PeakUpdateSize);
+                     "\n    PeakUpdateSize             ", Stats.PeakUpdateSize,
+                     "\n    Buckets:\n", PrintBucketInfo(Stats));
 }
 
 
@@ -455,7 +476,7 @@ TEST(GPUUploadManagerTest, MaxPageCount)
 
     GPUUploadManagerStats Stats;
     pUploadManager->GetStats(Stats);
-    LOG_INFO_MESSAGE("Peak number of pages: ", Stats.PeakNumPages);
+    LOG_INFO_MESSAGE("Peak number of pages: ", Stats.PeakNumPages, "\nBucket info:\n", PrintBucketInfo(Stats));
     EXPECT_EQ(Stats.NumPages, CreateInfo.MaxPageCount) << "Page count should not exceed the specified maximum";
 }