Vulkan:Add debug labels for OpenGL calls

src/common/debug.cpp

@@ -81,7 +81,7 @@ std::ostream *gSwallowStream;
 
 bool DebugAnnotationsActive()
 {
-#if defined(ANGLE_ENABLE_DEBUG_ANNOTATIONS)
+#if defined(ANGLE_ENABLE_DEBUG_ANNOTATIONS) || defined(ANGLE_ENABLE_DEBUG_TRACE)
     return g_debugAnnotator != nullptr && g_debugAnnotator->getStatus();
 #else
     return false;

src/libANGLE/renderer/vulkan/BUILD.gn

@@ -27,6 +27,8 @@ _vulkan_backend_sources = [
   "CompilerVk.h",
   "ContextVk.cpp",
   "ContextVk.h",
+  "DebugAnnotatorVk.cpp",
+  "DebugAnnotatorVk.h",
   "DeviceVk.cpp",
   "DeviceVk.h",
   "DisplayVk.cpp",

src/libANGLE/renderer/vulkan/ContextVk.h

@@ -261,6 +261,9 @@ class ContextVk : public ContextImpl, public vk::Context
                                  const std::string &message) override;
     angle::Result popDebugGroup(const gl::Context *context) override;
 
+    // Record GL API calls for debuggers
+    void logEvent(const char *eventString) { mEventLog.push_back(eventString); }
+
     bool isViewportFlipEnabledForDrawFBO() const;
     bool isViewportFlipEnabledForReadFBO() const;
     // When the device/surface is rotated such that the surface's aspect ratio is different than
@@ -952,6 +955,9 @@ class ContextVk : public ContextImpl, public vk::Context
     bool shouldSwitchToReadOnlyDepthFeedbackLoopMode(const gl::Context *context,
                                                      gl::Texture *texture) const;
 
+    // Record GL API calls for debuggers
+    void writeEventLog(const gl::Context *context, vk::CommandBuffer *commandBuffer);
+
     std::array<DirtyBitHandler, DIRTY_BIT_MAX> mGraphicsDirtyBitHandlers;
     std::array<DirtyBitHandler, DIRTY_BIT_MAX> mComputeDirtyBitHandlers;
 
@@ -1149,6 +1155,9 @@ class ContextVk : public ContextImpl, public vk::Context
     vk::DynamicBuffer mStagingBuffer;
 
     std::vector<std::string> mCommandBufferDiagnostics;
+
+    // Record GL API calls for debuggers
+    std::vector<std::string> mEventLog;
 };
 
 ANGLE_INLINE angle::Result ContextVk::endRenderPassIfTransformFeedbackBuffer(

src/libANGLE/renderer/vulkan/DebugAnnotatorVk.cpp

+//
+// Copyright 2020 The ANGLE Project Authors. All rights reserved.
+// Use of this source code is governed by a BSD-style license that can be
+// found in the LICENSE file.
+//
+// DebugAnnotatorVk.cpp: Vulkan helpers for adding trace annotations.
+//
+
+#include "libANGLE/renderer/vulkan/DebugAnnotatorVk.h"
+#include "libANGLE/Context.h"
+#include "libANGLE/renderer/vulkan/ContextVk.h"
+
+namespace rx
+{
+
+DebugAnnotatorVk::DebugAnnotatorVk() {}
+
+DebugAnnotatorVk::~DebugAnnotatorVk() {}
+
+void DebugAnnotatorVk::beginEvent(gl::Context *context,
+                                  const char *eventName,
+                                  const char *eventMessage)
+{
+    angle::LoggingAnnotator::beginEvent(context, eventName, eventMessage);
+    if (context)
+    {
+        ContextVk *contextVk = vk::GetImpl(static_cast<gl::Context *>(context));
+        contextVk->logEvent(eventMessage);
+    }
+}
+
+void DebugAnnotatorVk::endEvent(const char *eventName)
+{
+    angle::LoggingAnnotator::endEvent(eventName);
+}
+
+bool DebugAnnotatorVk::getStatus()
+{
+    return true;
+}
+
+}  // namespace rx

src/libANGLE/renderer/vulkan/DebugAnnotatorVk.h

+//
+// Copyright 2020 The ANGLE Project Authors. All rights reserved.
+// Use of this source code is governed by a BSD-style license that can be
+// found in the LICENSE file.
+//
+// DebugAnnotatorVk.h: Vulkan helpers for adding trace annotations.
+//
+
+#ifndef LIBANGLE_RENDERER_VULKAN_DEBUGANNOTATORVK_H_
+#define LIBANGLE_RENDERER_VULKAN_DEBUGANNOTATORVK_H_
+
+#include "libANGLE/LoggingAnnotator.h"
+
+namespace rx
+{
+
+class DebugAnnotatorVk : public angle::LoggingAnnotator
+{
+  public:
+    DebugAnnotatorVk();
+    ~DebugAnnotatorVk() override;
+    void beginEvent(gl::Context *context, const char *eventName, const char *eventMessage) override;
+    void endEvent(const char *eventName) override;
+    bool getStatus() override;
+
+    // Note: To avoid any race conditions between threads, this class has no private data; all
+    // events are stored in ContextVk.
+};
+
+}  // namespace rx
+
+#endif  // LIBANGLE_RENDERER_VULKAN_DEBUGANNOTATORVK_H_

src/libANGLE/renderer/vulkan/RendererVk.cpp

@@ -902,11 +902,14 @@ angle::Result RendererVk::initialize(DisplayVk *displayVk,
     // Initialize the format table.
     mFormatTable.initialize(this, &mNativeTextureCaps, &mNativeCaps.compressedTextureFormats);
 
+    gl::InitializeDebugAnnotations(&mAnnotator);
+
     if (getFeatures().enableCommandProcessingThread.enabled)
     {
         mCommandProcessorThread =
             std::thread(&CommandProcessor::processCommandProcessorTasks, &mCommandProcessor);
     }
+
     return angle::Result::Continue;
 }
 

src/libANGLE/renderer/vulkan/RendererVk.h

@@ -27,6 +27,7 @@
 #include "libANGLE/BlobCache.h"
 #include "libANGLE/Caps.h"
 #include "libANGLE/renderer/vulkan/CommandProcessor.h"
+#include "libANGLE/renderer/vulkan/DebugAnnotatorVk.h"
 #include "libANGLE/renderer/vulkan/QueryVk.h"
 #include "libANGLE/renderer/vulkan/ResourceVk.h"
 #include "libANGLE/renderer/vulkan/UtilsVk.h"
@@ -369,6 +370,8 @@ class RendererVk : angle::NonCopyable
     std::string mLastValidationMessage;
     uint32_t mValidationMessageCount;
 
+    DebugAnnotatorVk mAnnotator;
+
     // How close to VkPhysicalDeviceLimits::maxMemoryAllocationCount we allow ourselves to get
     static constexpr double kPercentMaxMemoryAllocationCount = 0.3;
     // How many objects to garbage collect before issuing a flush()