D3D12: clean up logging

Make QSG_RENDERER_DEBUG more fine-grained, the maximum set is now
loop;build;change;render;descheap;buffer;texture;shader meaning "render" is
broken up into 5 categories.

Fix also a comment on the root signature to avoid future headache with
trying to optimize the descriptor table for textures away (in vain).

Change-Id: I06a2a624ed39aaf5de42b8e984a192c7966360ab
Reviewed-by: Andy Nichols <andy.nichols@qt.io>

2 files changed, 38 insertions, 35 deletions

diff --git a/src/plugins/scenegraph/d3d12/qsgd3d12engine.cpp b/src/plugins/scenegraph/d3d12/qsgd3d12engine.cpp
index eab762f7c1..34ab4d11b0 100644
--- a/src/plugins/scenegraph/d3d12/qsgd3d12engine.cpp
+++ b/src/plugins/scenegraph/d3d12/qsgd3d12engine.cpp
@@ -70,6 +70,9 @@ QT_BEGIN_NAMESPACE
     { static bool value = qgetenv("QSG_RENDERER_DEBUG").contains(QT_STRINGIFY(variable)); return value; }
 
 DECLARE_DEBUG_VAR(render)
+DECLARE_DEBUG_VAR(descheap)
+DECLARE_DEBUG_VAR(buffer)
+DECLARE_DEBUG_VAR(texture)
 
 // Except for system info on startup.
 Q_LOGGING_CATEGORY(QSG_LOG_INFO, "qt.scenegraph.general")
@@ -104,8 +107,8 @@ D3D12_CPU_DESCRIPTOR_HANDLE QSGD3D12CPUDescriptorHeapManager::allocate(D3D12_DES
                 if (heap.freeMap[bucket]) {
                     uint freePos = qCountTrailingZeroBits(heap.freeMap[bucket]);
                     heap.freeMap[bucket] &= ~(1UL << freePos);
-                    if (Q_UNLIKELY(debug_render()))
-                        qDebug("descriptor handle type %x reserve in bucket %d index %d", type, bucket, freePos);
+                    if (Q_UNLIKELY(debug_descheap()))
+                        qDebug("descriptor handle heap %p type %x reserve in bucket %d index %d", &heap, type, bucket, freePos);
                     freePos += bucket * DESCRIPTORS_PER_BUCKET;
                     h = heap.start;
                     h.ptr += freePos * heap.handleSize;
@@ -131,7 +134,7 @@ D3D12_CPU_DESCRIPTOR_HANDLE QSGD3D12CPUDescriptorHeapManager::allocate(D3D12_DES
 
     heap.start = heap.heap->GetCPUDescriptorHandleForHeapStart();
 
-    if (Q_UNLIKELY(debug_render()))
+    if (Q_UNLIKELY(debug_descheap()))
         qDebug("new descriptor heap, type %x, start %llu", type, heap.start.ptr);
 
     heap.freeMap[0] = 0xFFFFFFFE;
@@ -155,8 +158,8 @@ void QSGD3D12CPUDescriptorHeapManager::release(D3D12_CPU_DESCRIPTOR_HANDLE handl
             const int bucket = pos / DESCRIPTORS_PER_BUCKET;
             const int indexInBucket = pos - bucket * DESCRIPTORS_PER_BUCKET;
             heap.freeMap[bucket] |= 1UL << indexInBucket;
-            if (Q_UNLIKELY(debug_render()))
-                qDebug("free descriptor handle type %x bucket %d index %d", type, bucket, indexInBucket);
+            if (Q_UNLIKELY(debug_descheap()))
+                qDebug("free descriptor handle heap %p type %x bucket %d index %d", &heap, type, bucket, indexInBucket);
             return;
         }
     }
@@ -1285,7 +1288,7 @@ void QSGD3D12EnginePrivate::ensureBuffer(Buffer *buf)
         // buffer contents rebuild with a slightly larger total size does
         // not lead to creating a new buffer.
         const quint32 sz = alignedSize(buf->cpuDataRef.size, 4096);
-        if (Q_UNLIKELY(debug_render()))
+        if (Q_UNLIKELY(debug_buffer()))
             qDebug("new buffer[pf=%d] of size %d (actual data size %d)", currentPFrameIndex, sz, buf->cpuDataRef.size);
         bfd.buffer.Attach(createBuffer(sz));
         bfd.resourceSize = sz;
@@ -1307,7 +1310,7 @@ void QSGD3D12EnginePrivate::updateBuffer(Buffer *buf)
         return;
     }
     for (const auto &r : qAsConst(buf->cpuDataRef.dirty)) {
-        if (Q_UNLIKELY(debug_render()))
+        if (Q_UNLIKELY(debug_buffer()))
             qDebug("%p o %d s %d", buf, r.first, r.second);
         memcpy(p + r.first, buf->cpuDataRef.p + r.first, r.second);
     }
@@ -1388,13 +1391,13 @@ void QSGD3D12EnginePrivate::beginFrame()
             for (uint id : qAsConst(prevFrameData.buffersUsedInFrame)) {
                 Buffer &b(buffers[id - 1]);
                 if (b.d[currentPFrameIndex].buffer && b.d[currentPFrameIndex].dataSize == b.cpuDataRef.size) {
-                    if (Q_UNLIKELY(debug_render()))
+                    if (Q_UNLIKELY(debug_buffer()))
                         qDebug() << "frame" << frameIndex << "takes dirty" << b.d[prevPFrameIndex].dirty
                                  << "from frame" << frameIndex - delta << "for buffer" << id;
                     for (const auto &range : qAsConst(b.d[prevPFrameIndex].dirty))
                         addDirtyRange(&b.cpuDataRef.dirty, range.first, range.second, b.cpuDataRef.size);
                 } else {
-                    if (Q_UNLIKELY(debug_render()))
+                    if (Q_UNLIKELY(debug_buffer()))
                         qDebug() << "frame" << frameIndex << "makes all dirty from frame" << frameIndex - delta
                                  << "for buffer" << id;
                     addDirtyRange(&b.cpuDataRef.dirty, 0, b.cpuDataRef.size, b.cpuDataRef.size);
@@ -1408,7 +1411,7 @@ void QSGD3D12EnginePrivate::beginFrame()
         const quint64 finishedFrameIndex = frameIndex - frameInFlightCount; // we know since we just blocked for this
         // pfd conveniently refers to the same slot that was used by that frame
         if (!pfd.pendingTextureUploads.isEmpty()) {
-            if (Q_UNLIKELY(debug_render()))
+            if (Q_UNLIKELY(debug_texture()))
                 qDebug("Removing texture upload data for frame %d", finishedFrameIndex);
             for (uint id : qAsConst(pfd.pendingTextureUploads)) {
                 const int idx = id - 1;
@@ -1422,13 +1425,13 @@ void QSGD3D12EnginePrivate::beginFrame()
                     t.lastWaitFenceValue = 0;
                     t.stagingBuffers.clear();
                     t.stagingHeaps.clear();
-                    if (Q_UNLIKELY(debug_render()))
+                    if (Q_UNLIKELY(debug_texture()))
                         qDebug("Cleaned staging data for texture %u", id);
                 }
             }
             pfd.pendingTextureUploads.clear();
             if (!pfd.pendingTextureMipMap.isEmpty()) {
-                if (Q_UNLIKELY(debug_render()))
+                if (Q_UNLIKELY(debug_texture()))
                     qDebug() << "cleaning mipmap generation data for " << pfd.pendingTextureMipMap;
                 // no special cleanup is needed as mipmap generation uses the frame's resources
                 pfd.pendingTextureMipMap.clear();
@@ -1442,7 +1445,7 @@ void QSGD3D12EnginePrivate::beginFrame()
                 }
             }
             if (!hasPending) {
-                if (Q_UNLIKELY(debug_render()))
+                if (Q_UNLIKELY(debug_texture()))
                     qDebug("no more pending textures");
                 copyCommandAllocator->Reset();
             }
@@ -1563,7 +1566,7 @@ void QSGD3D12EnginePrivate::endDrawCalls(bool lastInFrame)
     PersistentFrameData &pfd(pframeData[currentPFrameIndex]);
 
     // Now is the time to sync all the changed areas in the buffers.
-    if (Q_UNLIKELY(debug_render()))
+    if (Q_UNLIKELY(debug_buffer()))
         qDebug() << "buffers used in drawcall set" << pfd.buffersUsedInDrawCallSet;
     for (uint id : qAsConst(pfd.buffersUsedInDrawCallSet))
         updateBuffer(&buffers[id - 1]);
@@ -1588,12 +1591,12 @@ void QSGD3D12EnginePrivate::endDrawCalls(bool lastInFrame)
                 pfd.pendingTextureMipMap.insert(id);
         }
         if (topFenceValue) {
-            if (Q_UNLIKELY(debug_render()))
+            if (Q_UNLIKELY(debug_texture()))
                 qDebug("added wait for texture fence %llu", topFenceValue);
             commandQueue->Wait(textureUploadFence.Get(), topFenceValue);
             // Generate mipmaps after the wait, when necessary.
             if (!pfd.pendingTextureMipMap.isEmpty()) {
-                if (Q_UNLIKELY(debug_render()))
+                if (Q_UNLIKELY(debug_texture()))
                     qDebug() << "starting mipmap generation for" << pfd.pendingTextureMipMap;
                 for (uint id : qAsConst(pfd.pendingTextureMipMap))
                     mipmapper.queueGenerate(textures[id - 1]);
@@ -1672,8 +1675,8 @@ void QSGD3D12EnginePrivate::endLayer()
 
 // Root signature:
 // [0] CBV - always present
-// [1] table with 1 SRV per texture (optional)
-// one static sampler per texture (optional)
+// [1] table with one SRV per texture (must be a table since root descriptor SRVs cannot be textures) - optional
+// one static sampler per texture - optional
 //
 // SRVs can be created freely via QSGD3D12CPUDescriptorHeapManager and stored
 // in QSGD3D12TextureView. The engine will copy them onto a dedicated,
@@ -2139,7 +2142,7 @@ void QSGD3D12EnginePrivate::ensureGPUDescriptorHeap(int cbvSrvUavDescriptorCount
     while (pfd.cbvSrvUavNextFreeDescriptorIndex + cbvSrvUavDescriptorCount > newSize)
         newSize *= 2;
     if (newSize != pfd.gpuCbvSrvUavHeapSize) {
-        if (Q_UNLIKELY(debug_render()))
+        if (Q_UNLIKELY(debug_descheap()))
             qDebug("Out of space for SRVs, creating new CBV-SRV-UAV descriptor heap with descriptor count %d", newSize);
         deferredDelete(pfd.gpuCbvSrvUavHeap);
         createCbvSrvUavHeap(currentPFrameIndex, newSize);
@@ -2230,7 +2233,7 @@ void QSGD3D12EnginePrivate::releaseBuffer(uint id)
     const int idx = id - 1;
     Q_ASSERT(idx < buffers.count());
 
-    if (Q_UNLIKELY(debug_render()))
+    if (Q_UNLIKELY(debug_buffer()))
         qDebug("releasing buffer %u", id);
 
     Buffer &b(buffers[idx]);
@@ -2264,7 +2267,7 @@ void QSGD3D12EnginePrivate::resetBuffer(uint id, const quint8 *data, int size)
     Q_ASSERT(idx < buffers.count() && buffers[idx].entryInUse());
     Buffer &b(buffers[idx]);
 
-    if (Q_UNLIKELY(debug_render()))
+    if (Q_UNLIKELY(debug_buffer()))
         qDebug("reset buffer %u, size %d", id, size);
 
     b.cpuDataRef.p = data;
@@ -2442,7 +2445,7 @@ void QSGD3D12EnginePrivate::createTexture(uint id, const QSize &size, QImage::Fo
         }
     }
 
-    if (Q_UNLIKELY(debug_render()))
+    if (Q_UNLIKELY(debug_texture()))
         qDebug("created texture %u, size %dx%d, miplevels %d", id, adjustedSize.width(), adjustedSize.height(), textureDesc.MipLevels);
 }
 
@@ -2463,7 +2466,7 @@ void QSGD3D12EnginePrivate::queueTextureResize(uint id, const QSize &size)
         return;
     }
 
-    if (Q_UNLIKELY(debug_render()))
+    if (Q_UNLIKELY(debug_texture()))
         qDebug("resizing texture %u, size %dx%d", id, size.width(), size.height());
 
     D3D12_RESOURCE_DESC textureDesc = t.texture->GetDesc();
@@ -2515,7 +2518,7 @@ void QSGD3D12EnginePrivate::queueTextureResize(uint id, const QSize &size)
     t.fenceValue = nextTextureUploadFenceValue.fetchAndAddAcquire(1) + 1;
     copyCommandQueue->Signal(textureUploadFence.Get(), t.fenceValue);
 
-    if (Q_UNLIKELY(debug_render()))
+    if (Q_UNLIKELY(debug_texture()))
         qDebug("submitted old content copy for texture %u on the copy queue, fence %llu", id, t.fenceValue);
 }
 
@@ -2547,7 +2550,7 @@ void QSGD3D12EnginePrivate::queueTextureUpload(uint id, const QVector<QImage> &i
 
     t.fenceValue = nextTextureUploadFenceValue.fetchAndAddAcquire(1) + 1;
 
-    if (Q_UNLIKELY(debug_render()))
+    if (Q_UNLIKELY(debug_texture()))
         qDebug("adding upload for texture %u on the copy queue, fence %llu", id, t.fenceValue);
 
     D3D12_RESOURCE_DESC textureDesc = t.texture->GetDesc();
@@ -2563,7 +2566,7 @@ void QSGD3D12EnginePrivate::queueTextureUpload(uint id, const QVector<QImage> &i
         totalSize += alignedSize(h * stride, D3D12_DEFAULT_RESOURCE_PLACEMENT_ALIGNMENT);
     }
 
-    if (Q_UNLIKELY(debug_render()))
+    if (Q_UNLIKELY(debug_texture()))
         qDebug("%d sub-uploads, heap size %d bytes", images.count(), totalSize);
 
     // Instead of individual committed resources for each upload buffer,
@@ -2589,7 +2592,7 @@ void QSGD3D12EnginePrivate::queueTextureUpload(uint id, const QVector<QImage> &i
         QImage::Format convFormat;
         int bytesPerPixel;
         textureFormat(images[i].format(), t.alpha(), t.mipmap(), &convFormat, &bytesPerPixel);
-        if (Q_UNLIKELY(debug_render() && i == 0))
+        if (Q_UNLIKELY(debug_texture() && i == 0))
             qDebug("source image format %d, target format %d, bpp %d", images[i].format(), convFormat, bytesPerPixel);
 
         QImage convImage = images[i].format() == convFormat ? images[i] : images[i].convertToFormat(convFormat);
@@ -2664,7 +2667,7 @@ void QSGD3D12EnginePrivate::releaseTexture(uint id)
     const int idx = id - 1;
     Q_ASSERT(idx < textures.count());
 
-    if (Q_UNLIKELY(debug_render()))
+    if (Q_UNLIKELY(debug_texture()))
         qDebug("releasing texture %d", id);
 
     Texture &t(textures[idx]);
diff --git a/src/plugins/scenegraph/d3d12/qsgd3d12shadereffectnode.cpp b/src/plugins/scenegraph/d3d12/qsgd3d12shadereffectnode.cpp
index c423206377..62771eb8f9 100644
--- a/src/plugins/scenegraph/d3d12/qsgd3d12shadereffectnode.cpp
+++ b/src/plugins/scenegraph/d3d12/qsgd3d12shadereffectnode.cpp
@@ -61,7 +61,7 @@ QT_BEGIN_NAMESPACE
     static bool debug_ ## variable() \
     { static bool value = qgetenv("QSG_RENDERER_DEBUG").contains(QT_STRINGIFY(variable)); return value; }
 
-DECLARE_DEBUG_VAR(render)
+DECLARE_DEBUG_VAR(shader)
 
 void QSGD3D12ShaderLinker::reset(const QByteArray &vertBlob, const QByteArray &fragBlob)
 {
@@ -598,7 +598,7 @@ QRectF QSGD3D12ShaderEffectNode::updateNormalizedTextureSubRect(bool supportsAtl
 
 void QSGD3D12ShaderEffectNode::syncMaterial(SyncData *syncData)
 {
-    if (Q_UNLIKELY(debug_render()))
+    if (Q_UNLIKELY(debug_shader()))
         qDebug() << "shadereffect node sync" << syncData->dirty;
 
     if (bool(m_material.flags() & QSGMaterial::Blending) != syncData->blending) {
@@ -715,7 +715,7 @@ void QSGD3D12ShaderEffectNode::syncMaterial(SyncData *syncData)
 
         markDirty(QSGNode::DirtyMaterial);
 
-        if (Q_UNLIKELY(debug_render()))
+        if (Q_UNLIKELY(debug_shader()))
             m_material.linker.dump();
     } else  {
         if (syncData->dirty & QSGShaderEffectNode::DirtyShaderConstant) {
@@ -724,7 +724,7 @@ void QSGD3D12ShaderEffectNode::syncMaterial(SyncData *syncData)
             if (!syncData->fragment.dirtyConstants->isEmpty())
                 m_material.linker.feedConstants(*syncData->fragment.shader, syncData->fragment.dirtyConstants);
             markDirty(QSGNode::DirtyMaterial);
-            if (Q_UNLIKELY(debug_render()))
+            if (Q_UNLIKELY(debug_shader()))
                 m_material.linker.dump();
         }
 
@@ -736,7 +736,7 @@ void QSGD3D12ShaderEffectNode::syncMaterial(SyncData *syncData)
             m_material.linker.linkTextureSubRects();
             m_material.updateTextureProviders(false);
             markDirty(QSGNode::DirtyMaterial);
-            if (Q_UNLIKELY(debug_render()))
+            if (Q_UNLIKELY(debug_shader()))
                 m_material.linker.dump();
         }
     }
@@ -939,7 +939,7 @@ bool QSGD3D12GuiThreadShaderEffectManager::reflect(ShaderInfo *result)
         return false;
     }
 
-    if (Q_UNLIKELY(debug_render()))
+    if (Q_UNLIKELY(debug_shader()))
         qDebug("Shader reflection size %d type %d v%u.%u input elems %d cbuffers %d boundres %d",
                result->blob.size(), result->type, major, minor, ieCount, cbufferCount, boundResCount);
 
@@ -1036,7 +1036,7 @@ bool QSGD3D12GuiThreadShaderEffectManager::reflect(ShaderInfo *result)
         }
     }
 
-    if (Q_UNLIKELY(debug_render())) {
+    if (Q_UNLIKELY(debug_shader())) {
         qDebug() << "Input:" << result->inputParameters;
         qDebug() << "Variables:" << result->variables << "cbuffer size" << result->constantDataSize;
     }