Enable Queue, Device labels to be set.

Queue labels can be set by the defaultQueue.label member of the device
descriptor or the setQueue method.

Device labels can be set label member of the device
descriptor or the setQueue method.

D3D12 and VK backend label support included.

Change-Id: Id12dd6e1fc8f1519c55e4efb35e1ead67c085e46
Bug: dawn:1323
Reviewed-on: https://dawn-review.googlesource.com/c/dawn/+/85540
Reviewed-by: Kai Ninomiya <kainino@chromium.org>
Commit-Queue: Brandon Jones <bajones@chromium.org>

dawn.json

@@ -153,7 +153,7 @@
             {"name": "required features count", "type": "uint32_t", "default": 0},
             {"name": "required features", "type": "feature name", "annotation": "const*", "length": "required features count", "default": "nullptr"},
             {"name": "required limits", "type": "required limits", "annotation": "const*", "optional": true},
-            {"name": "default queue", "type": "queue descriptor", "tags": ["upstream"]}
+            {"name": "default queue", "type": "queue descriptor"}
         ]
     },
     "dawn toggles device descriptor": {
@@ -1152,6 +1152,15 @@
                     {"name": "callback", "type": "error callback"},
                     {"name": "userdata", "type": "void", "annotation": "*"}
                 ]
+            },
+            {
+                "name": "set label",
+                "returns": "void",
+                "tags": ["dawn"],
+                "_TODO": "needs an upstream equivalent",
+                "args": [
+                    {"name": "label", "type": "char", "annotation": "const*", "length": "strlen"}
+                ]
             }
         ]
     },
@@ -1663,13 +1672,21 @@
                     {"name": "copy size", "type": "extent 3D", "annotation": "const*"},
                     {"name": "options", "type": "copy texture for browser options", "annotation": "const*"}
                 ]
+            },
+            {
+                "name": "set label",
+                "returns": "void",
+                "tags": ["dawn"],
+                "_TODO": "needs an upstream equivalent",
+                "args": [
+                    {"name": "label", "type": "char", "annotation": "const*", "length": "strlen"}
+                ]
             }
         ]
     },
     "queue descriptor": {
         "category": "structure",
         "extensible": "in",
-        "tags": ["upstream"],
         "members": [
             {"name": "label", "type": "char", "annotation": "const*", "length": "strlen", "optional": true}
         ]

src/dawn/native/Device.cpp

@@ -198,6 +198,10 @@ namespace dawn::native {
 
         mFormatTable = BuildFormatTable(this);
         SetDefaultToggles();
+
+        if (descriptor->label != nullptr && strlen(descriptor->label) != 0) {
+            mLabel = descriptor->label;
+        }
     }
 
     DeviceBase::DeviceBase() : mState(State::Alive) {
@@ -210,9 +214,15 @@ namespace dawn::native {
         mQueue = nullptr;
     }
 
-    MaybeError DeviceBase::Initialize(QueueBase* defaultQueue) {
+    MaybeError DeviceBase::Initialize(QueueBase* defaultQueue, const DeviceDescriptor* descriptor) {
         mQueue = AcquireRef(defaultQueue);
 
+        // If an label was specified for the default queue in the device descriptor, set it now.
+        if (descriptor->defaultQueue.label != nullptr &&
+            strlen(descriptor->defaultQueue.label) != 0) {
+            mQueue->APISetLabel(descriptor->defaultQueue.label);
+        }
+
 #if defined(DAWN_ENABLE_ASSERTS)
         mUncapturedErrorCallback = [](WGPUErrorType, char const*, void*) {
             static bool calledOnce = false;

src/dawn/native/Device.h

@@ -382,7 +382,7 @@ namespace dawn::native {
         void SetToggle(Toggle toggle, bool isEnabled);
         void ForceSetToggle(Toggle toggle, bool isEnabled);
 
-        MaybeError Initialize(QueueBase* defaultQueue);
+        MaybeError Initialize(QueueBase* defaultQueue, const DeviceDescriptor* descriptor);
         void DestroyObjects();
         void Destroy();
 

src/dawn/native/d3d12/DeviceD3D12.cpp

@@ -59,11 +59,11 @@ namespace dawn::native::d3d12 {
     ResultOrError<Ref<Device>> Device::Create(Adapter* adapter,
                                               const DeviceDescriptor* descriptor) {
         Ref<Device> device = AcquireRef(new Device(adapter, descriptor));
-        DAWN_TRY(device->Initialize());
+        DAWN_TRY(device->Initialize(descriptor));
         return device;
     }
 
-    MaybeError Device::Initialize() {
+    MaybeError Device::Initialize(const DeviceDescriptor* descriptor) {
         InitTogglesFromDriver();
 
         mD3d12Device = ToBackend(GetAdapter())->GetDevice();
@@ -163,7 +163,7 @@ namespace dawn::native::d3d12 {
         GetD3D12Device()->CreateCommandSignature(&programDesc, NULL,
                                                  IID_PPV_ARGS(&mDrawIndexedIndirectSignature));
 
-        DAWN_TRY(DeviceBase::Initialize(new Queue(this)));
+        DAWN_TRY(DeviceBase::Initialize(new Queue(this), descriptor));
         // Device shouldn't be used until after DeviceBase::Initialize so we must wait until after
         // device initialization to call NextSerial
         DAWN_TRY(NextSerial());
@@ -174,6 +174,8 @@ namespace dawn::native::d3d12 {
 
         DAWN_TRY(CreateZeroBuffer());
 
+        SetLabelImpl();
+
         return {};
     }
 
@@ -741,4 +743,8 @@ namespace dawn::native::d3d12 {
         return ToBackend(computePipeline)->UsesNumWorkgroups();
     }
 
+    void Device::SetLabelImpl() {
+        SetDebugName(this, mD3d12Device.Get(), "Dawn_Device", GetLabel());
+    }
+
 }  // namespace dawn::native::d3d12

src/dawn/native/d3d12/DeviceD3D12.h

@@ -45,7 +45,7 @@ namespace dawn::native::d3d12 {
                                                  const DeviceDescriptor* descriptor);
         ~Device() override;
 
-        MaybeError Initialize();
+        MaybeError Initialize(const DeviceDescriptor* descriptor);
 
         ResultOrError<Ref<CommandBufferBase>> CreateCommandBuffer(
             CommandEncoder* encoder,
@@ -147,6 +147,9 @@ namespace dawn::native::d3d12 {
         bool ShouldDuplicateNumWorkgroupsForDispatchIndirect(
             ComputePipelineBase* computePipeline) const override;
 
+        // Dawn API
+        void SetLabelImpl() override;
+
       private:
         using DeviceBase::DeviceBase;
 

src/dawn/native/d3d12/QueueD3D12.cpp

@@ -21,12 +21,14 @@
 #include "dawn/native/d3d12/CommandBufferD3D12.h"
 #include "dawn/native/d3d12/D3D12Error.h"
 #include "dawn/native/d3d12/DeviceD3D12.h"
+#include "dawn/native/d3d12/UtilsD3D12.h"
 #include "dawn/platform/DawnPlatform.h"
 #include "dawn/platform/tracing/TraceEvent.h"
 
 namespace dawn::native::d3d12 {
 
     Queue::Queue(Device* device) : QueueBase(device) {
+        SetLabelImpl();
     }
 
     MaybeError Queue::SubmitImpl(uint32_t commandCount, CommandBufferBase* const* commands) {
@@ -51,4 +53,11 @@ namespace dawn::native::d3d12 {
         return {};
     }
 
+    void Queue::SetLabelImpl() {
+        Device* device = ToBackend(GetDevice());
+        // TODO(crbug.com/dawn/1344): When we start using multiple queues this needs to be adjusted
+        // so it doesn't always change the default queue's label.
+        SetDebugName(device, device->GetCommandQueue().Get(), "Dawn_Queue", GetLabel());
+    }
+
 }  // namespace dawn::native::d3d12

src/dawn/native/d3d12/QueueD3D12.h

@@ -30,6 +30,9 @@ namespace dawn::native::d3d12 {
 
       private:
         MaybeError SubmitImpl(uint32_t commandCount, CommandBufferBase* const* commands) override;
+
+        // Dawn API
+        void SetLabelImpl() override;
     };
 
 }  // namespace dawn::native::d3d12

src/dawn/native/metal/DeviceMTL.h

@@ -43,7 +43,7 @@ namespace dawn::native::metal {
                                                  const DeviceDescriptor* descriptor);
         ~Device() override;
 
-        MaybeError Initialize();
+        MaybeError Initialize(const DeviceDescriptor* descriptor);
 
         MaybeError TickImpl() override;
 

src/dawn/native/metal/DeviceMTL.mm

@@ -110,7 +110,7 @@ namespace dawn::native::metal {
                                               NSPRef<id<MTLDevice>> mtlDevice,
                                               const DeviceDescriptor* descriptor) {
         Ref<Device> device = AcquireRef(new Device(adapter, std::move(mtlDevice), descriptor));
-        DAWN_TRY(device->Initialize());
+        DAWN_TRY(device->Initialize(descriptor));
         return device;
     }
 
@@ -124,7 +124,7 @@ namespace dawn::native::metal {
         Destroy();
     }
 
-    MaybeError Device::Initialize() {
+    MaybeError Device::Initialize(const DeviceDescriptor* descriptor) {
         InitTogglesFromDriver();
 
         mCommandQueue.Acquire([*mMtlDevice newCommandQueue]);
@@ -155,7 +155,7 @@ namespace dawn::native::metal {
             }
         }
 
-        return DeviceBase::Initialize(new Queue(this));
+        return DeviceBase::Initialize(new Queue(this), descriptor);
     }
 
     void Device::InitTogglesFromDriver() {

src/dawn/native/null/DeviceNull.cpp

@@ -103,7 +103,7 @@ namespace dawn::native::null {
     ResultOrError<Ref<Device>> Device::Create(Adapter* adapter,
                                               const DeviceDescriptor* descriptor) {
         Ref<Device> device = AcquireRef(new Device(adapter, descriptor));
-        DAWN_TRY(device->Initialize());
+        DAWN_TRY(device->Initialize(descriptor));
         return device;
     }
 
@@ -111,8 +111,8 @@ namespace dawn::native::null {
         Destroy();
     }
 
-    MaybeError Device::Initialize() {
-        return DeviceBase::Initialize(new Queue(this));
+    MaybeError Device::Initialize(const DeviceDescriptor* descriptor) {
+        return DeviceBase::Initialize(new Queue(this), descriptor);
     }
 
     ResultOrError<Ref<BindGroupBase>> Device::CreateBindGroupImpl(

src/dawn/native/null/DeviceNull.h

@@ -90,7 +90,7 @@ namespace dawn::native::null {
                                                  const DeviceDescriptor* descriptor);
         ~Device() override;
 
-        MaybeError Initialize();
+        MaybeError Initialize(const DeviceDescriptor* descriptor);
 
         ResultOrError<Ref<CommandBufferBase>> CreateCommandBuffer(
             CommandEncoder* encoder,

src/dawn/native/opengl/DeviceGL.cpp

@@ -39,7 +39,7 @@ namespace dawn::native::opengl {
                                               const DeviceDescriptor* descriptor,
                                               const OpenGLFunctions& functions) {
         Ref<Device> device = AcquireRef(new Device(adapter, descriptor, functions));
-        DAWN_TRY(device->Initialize());
+        DAWN_TRY(device->Initialize(descriptor));
         return device;
     }
 
@@ -53,11 +53,11 @@ namespace dawn::native::opengl {
         Destroy();
     }
 
-    MaybeError Device::Initialize() {
+    MaybeError Device::Initialize(const DeviceDescriptor* descriptor) {
         InitTogglesFromDriver();
         mFormatTable = BuildGLFormatTable();
 
-        return DeviceBase::Initialize(new Queue(this));
+        return DeviceBase::Initialize(new Queue(this), descriptor);
     }
 
     void Device::InitTogglesFromDriver() {

src/dawn/native/opengl/DeviceGL.h

@@ -42,7 +42,7 @@ namespace dawn::native::opengl {
                                                  const OpenGLFunctions& functions);
         ~Device() override;
 
-        MaybeError Initialize();
+        MaybeError Initialize(const DeviceDescriptor* descriptor);
 
         // Contains all the OpenGL entry points, glDoFoo is called via device->gl.DoFoo.
         const OpenGLFunctions gl;

src/dawn/native/vulkan/DeviceVk.cpp

@@ -48,7 +48,7 @@ namespace dawn::native::vulkan {
     ResultOrError<Ref<Device>> Device::Create(Adapter* adapter,
                                               const DeviceDescriptor* descriptor) {
         Ref<Device> device = AcquireRef(new Device(adapter, descriptor));
-        DAWN_TRY(device->Initialize());
+        DAWN_TRY(device->Initialize(descriptor));
         return device;
     }
 
@@ -57,7 +57,7 @@ namespace dawn::native::vulkan {
         InitTogglesFromDriver();
     }
 
-    MaybeError Device::Initialize() {
+    MaybeError Device::Initialize(const DeviceDescriptor* descriptor) {
         // Copy the adapter's device info to the device so that we can change the "knobs"
         mDeviceInfo = ToBackend(GetAdapter())->GetDeviceInfo();
 
@@ -101,7 +101,9 @@ namespace dawn::native::vulkan {
         // extension is available. Override the decision if it is no applicable.
         ApplyUseZeroInitializeWorkgroupMemoryExtensionToggle();
 
-        return DeviceBase::Initialize(Queue::Create(this));
+        SetLabelImpl();
+
+        return DeviceBase::Initialize(Queue::Create(this), descriptor);
     }
 
     Device::~Device() {
@@ -1050,4 +1052,9 @@ namespace dawn::native::vulkan {
         return mDeviceInfo.properties.limits.timestampPeriod;
     }
 
+    void Device::SetLabelImpl() {
+        SetDebugName(this, VK_OBJECT_TYPE_DEVICE, reinterpret_cast<uint64_t&>(mVkDevice),
+                     "Dawn_Device", GetLabel());
+    }
+
 }  // namespace dawn::native::vulkan

src/dawn/native/vulkan/DeviceVk.h

@@ -47,7 +47,7 @@ namespace dawn::native::vulkan {
                                                  const DeviceDescriptor* descriptor);
         ~Device() override;
 
-        MaybeError Initialize();
+        MaybeError Initialize(const DeviceDescriptor* descriptor);
 
         // Contains all the Vulkan entry points, vkDoFoo is called via device->fn.DoFoo.
         const VulkanFunctions fn;
@@ -105,6 +105,8 @@ namespace dawn::native::vulkan {
 
         float GetTimestampPeriodInNS() const override;
 
+        void SetLabelImpl() override;
+
       private:
         Device(Adapter* adapter, const DeviceDescriptor* descriptor);
 

src/dawn/native/vulkan/QueueVk.cpp

@@ -22,6 +22,7 @@
 #include "dawn/native/vulkan/CommandBufferVk.h"
 #include "dawn/native/vulkan/CommandRecordingContext.h"
 #include "dawn/native/vulkan/DeviceVk.h"
+#include "dawn/native/vulkan/UtilsVulkan.h"
 #include "dawn/platform/DawnPlatform.h"
 #include "dawn/platform/tracing/TraceEvent.h"
 
@@ -33,6 +34,7 @@ namespace dawn::native::vulkan {
     }
 
     Queue::Queue(Device* device) : QueueBase(device) {
+        SetLabelImpl();
     }
 
     Queue::~Queue() {
@@ -56,4 +58,13 @@ namespace dawn::native::vulkan {
         return {};
     }
 
+    void Queue::SetLabelImpl() {
+        Device* device = ToBackend(GetDevice());
+        VkQueue handle = device->GetQueue();
+        // TODO(crbug.com/dawn/1344): When we start using multiple queues this needs to be adjusted
+        // so it doesn't always change the default queue's label.
+        SetDebugName(device, VK_OBJECT_TYPE_QUEUE, reinterpret_cast<uint64_t&>(handle),
+                     "Dawn_Queue", GetLabel());
+    }
+
 }  // namespace dawn::native::vulkan

src/dawn/native/vulkan/QueueVk.h

@@ -25,6 +25,9 @@ namespace dawn::native::vulkan {
       public:
         static Queue* Create(Device* device);
 
+        // Dawn API
+        void SetLabelImpl() override;
+
       private:
         Queue(Device* device);
         ~Queue() override;