Convert the debug markers from string to char*

Summary: ^ Differential Revision: D50457950 fbshipit-source-id: c75ded79894e733292e7af3f9fb804f64d091cbb
facebook · Oct 25, 2023 · 1a1f1ce · 1a1f1ce
1 parent abedd0f
commit 1a1f1ce
Show file tree

Hide file tree

Showing 23 changed files with 74 additions and 75 deletions.
diff --git a/IGLU/sentinel/CommandBuffer.cpp b/IGLU/sentinel/CommandBuffer.cpp
@@ -40,8 +40,7 @@ void CommandBuffer::waitUntilCompleted() {
   IGLU_SENTINEL_ASSERT_IF_NOT(shouldAssert_);
 }
 
-void CommandBuffer::pushDebugGroupLabel(const std::string& /*label*/,
-                                        const igl::Color& /*color*/) const {
+void CommandBuffer::pushDebugGroupLabel(const char* /*label*/, const igl::Color& /*color*/) const {
   IGLU_SENTINEL_ASSERT_IF_NOT(shouldAssert_);
 }
 

diff --git a/IGLU/sentinel/CommandBuffer.h b/IGLU/sentinel/CommandBuffer.h
@@ -31,7 +31,7 @@ class CommandBuffer final : public igl::ICommandBuffer {
   void present(std::shared_ptr<igl::ITexture> /*surface*/) const final;
   void waitUntilScheduled() final;
   void waitUntilCompleted() final;
-  void pushDebugGroupLabel(const std::string& /*label*/,
+  void pushDebugGroupLabel(const char* /*label*/,
                            const igl::Color& /*color*/ = igl::Color(1, 1, 1, 1)) const final;
   void popDebugGroupLabel() const final;
 

diff --git a/src/igl/CommandBuffer.h b/src/igl/CommandBuffer.h
@@ -116,7 +116,7 @@ class ICommandBuffer {
    * When all commands for this label have been sent to the encoder, call popDebugGroupLabel()
    * to pop the label off the stack.
    */
-  virtual void pushDebugGroupLabel(const std::string& label,
+  virtual void pushDebugGroupLabel(const char* IGL_NONNULL label,
                                    const igl::Color& color = igl::Color(1, 1, 1, 1)) const = 0;
 
   /**

diff --git a/src/igl/CommandEncoder.h b/src/igl/CommandEncoder.h
@@ -37,7 +37,7 @@ class ICommandEncoder {
    * When all commands for this label have been sent to the encoder, call popDebugGroupLabel()
    * to pop the label off the stack.
    */
-  virtual void pushDebugGroupLabel(const std::string& label,
+  virtual void pushDebugGroupLabel(const char* IGL_NONNULL label,
                                    const igl::Color& color = igl::Color(1, 1, 1, 1)) const = 0;
 
   /**
@@ -46,7 +46,7 @@ class ICommandEncoder {
    * If supported by the backend GPU driver, this allows you to easily insert a label into the
    * call stack of the captured frame data.
    */
-  virtual void insertDebugEventLabel(const std::string& label,
+  virtual void insertDebugEventLabel(const char* IGL_NONNULL label,
                                      const igl::Color& color = igl::Color(1, 1, 1, 1)) const = 0;
 
   /**

diff --git a/src/igl/metal/CommandBuffer.h b/src/igl/metal/CommandBuffer.h
@@ -29,7 +29,7 @@ class CommandBuffer final : public ICommandBuffer,
 
   void present(std::shared_ptr<ITexture> surface) const override;
 
-  void pushDebugGroupLabel(const std::string& label, const igl::Color& color) const override;
+  void pushDebugGroupLabel(const char* label, const igl::Color& color) const override;
 
   void popDebugGroupLabel() const override;
 

diff --git a/src/igl/metal/CommandBuffer.mm b/src/igl/metal/CommandBuffer.mm
@@ -42,10 +42,9 @@
   }
 }
 
-void CommandBuffer::pushDebugGroupLabel(const std::string& label,
-                                        const igl::Color& /*color*/) const {
-  IGL_ASSERT(!label.empty());
-  [value_ pushDebugGroup:[NSString stringWithUTF8String:label.c_str()] ?: @""];
+void CommandBuffer::pushDebugGroupLabel(const char* label, const igl::Color& /*color*/) const {
+  IGL_ASSERT(label != nullptr);
+  [value_ pushDebugGroup:[NSString stringWithUTF8String:label] ?: @""];
 }
 
 void CommandBuffer::popDebugGroupLabel() const {

diff --git a/src/igl/metal/ComputeCommandEncoder.h b/src/igl/metal/ComputeCommandEncoder.h
@@ -28,8 +28,8 @@ class ComputeCommandEncoder final : public IComputeCommandEncoder {
   // total number of threads per grid is threadgroupCount * threadgroupSize
   void dispatchThreadGroups(const Dimensions& threadgroupCount,
                             const Dimensions& threadgroupSize) override;
-  void pushDebugGroupLabel(const std::string& label, const igl::Color& color) const override;
-  void insertDebugEventLabel(const std::string& label, const igl::Color& color) const override;
+  void pushDebugGroupLabel(const char* label, const igl::Color& color) const override;
+  void insertDebugEventLabel(const char* label, const igl::Color& color) const override;
   void popDebugGroupLabel() const override;
   void bindUniform(const UniformDesc& uniformDesc, const void* data) override;
   void bindTexture(size_t index, ITexture* texture) override;

diff --git a/src/igl/metal/ComputeCommandEncoder.mm b/src/igl/metal/ComputeCommandEncoder.mm
@@ -30,18 +30,18 @@
   encoder_ = nil;
 }
 
-void ComputeCommandEncoder::pushDebugGroupLabel(const std::string& label,
+void ComputeCommandEncoder::pushDebugGroupLabel(const char* label,
                                                 const igl::Color& /*color*/) const {
   IGL_ASSERT(encoder_);
-  IGL_ASSERT(!label.empty());
-  [encoder_ pushDebugGroup:[NSString stringWithUTF8String:label.c_str()] ?: @""];
+  IGL_ASSERT(label != nullptr);
+  [encoder_ pushDebugGroup:[NSString stringWithUTF8String:label] ?: @""];
 }
 
-void ComputeCommandEncoder::insertDebugEventLabel(const std::string& label,
+void ComputeCommandEncoder::insertDebugEventLabel(const char* label,
                                                   const igl::Color& /*color*/) const {
   IGL_ASSERT(encoder_);
-  IGL_ASSERT(!label.empty());
-  [encoder_ insertDebugSignpost:[NSString stringWithUTF8String:label.c_str()] ?: @""];
+  IGL_ASSERT(label != nullptr);
+  [encoder_ insertDebugSignpost:[NSString stringWithUTF8String:label] ?: @""];
 }
 
 void ComputeCommandEncoder::popDebugGroupLabel() const {

diff --git a/src/igl/metal/RenderCommandEncoder.h b/src/igl/metal/RenderCommandEncoder.h
@@ -30,8 +30,8 @@ class RenderCommandEncoder final : public IRenderCommandEncoder {
 
   void endEncoding() override;
 
-  void pushDebugGroupLabel(const std::string& label, const igl::Color& color) const override;
-  void insertDebugEventLabel(const std::string& label, const igl::Color& color) const override;
+  void pushDebugGroupLabel(const char* label, const igl::Color& color) const override;
+  void insertDebugEventLabel(const char* label, const igl::Color& color) const override;
   void popDebugGroupLabel() const override;
 
   void bindViewport(const Viewport& viewport) override;

diff --git a/src/igl/metal/RenderCommandEncoder.mm b/src/igl/metal/RenderCommandEncoder.mm
@@ -130,18 +130,18 @@
   encoder_ = nil;
 }
 
-void RenderCommandEncoder::pushDebugGroupLabel(const std::string& label,
+void RenderCommandEncoder::pushDebugGroupLabel(const char* label,
                                                const igl::Color& /*color*/) const {
   IGL_ASSERT(encoder_);
-  IGL_ASSERT(!label.empty());
-  [encoder_ pushDebugGroup:[NSString stringWithUTF8String:label.c_str()] ?: @""];
+  IGL_ASSERT(label != nullptr);
+  [encoder_ pushDebugGroup:[NSString stringWithUTF8String:label] ?: @""];
 }
 
-void RenderCommandEncoder::insertDebugEventLabel(const std::string& label,
+void RenderCommandEncoder::insertDebugEventLabel(const char* label,
                                                  const igl::Color& /*color*/) const {
   IGL_ASSERT(encoder_);
-  IGL_ASSERT(!label.empty());
-  [encoder_ insertDebugSignpost:[NSString stringWithUTF8String:label.c_str()] ?: @""];
+  IGL_ASSERT(label != nullptr);
+  [encoder_ insertDebugSignpost:[NSString stringWithUTF8String:label] ?: @""];
 }
 
 void RenderCommandEncoder::popDebugGroupLabel() const {

diff --git a/src/igl/opengl/CommandBuffer.cpp b/src/igl/opengl/CommandBuffer.cpp
@@ -44,11 +44,11 @@ void CommandBuffer::waitUntilCompleted() {
   context_->finish();
 }
 
-void CommandBuffer::pushDebugGroupLabel(const std::string& label,
-                                        const igl::Color& /*color*/) const {
-  IGL_ASSERT(!label.empty());
+void CommandBuffer::pushDebugGroupLabel(const char* label, const igl::Color& /*color*/) const {
+  IGL_ASSERT(label != nullptr);
   if (getContext().deviceFeatures().hasInternalFeature(InternalFeatures::DebugMessage)) {
-    getContext().pushDebugGroup(GL_DEBUG_SOURCE_APPLICATION, 0, label.length(), label.c_str());
+    std::string_view labelSV(label);
+    getContext().pushDebugGroup(GL_DEBUG_SOURCE_APPLICATION, 0, labelSV.length(), labelSV.data());
   } else {
     IGL_LOG_ERROR_ONCE("CommandBuffer::pushDebugGroupLabel not supported in this context!\n");
   }

diff --git a/src/igl/opengl/CommandBuffer.h b/src/igl/opengl/CommandBuffer.h
@@ -37,7 +37,7 @@ class CommandBuffer final : public ICommandBuffer,
 
   void waitUntilCompleted() override;
 
-  void pushDebugGroupLabel(const std::string& label, const igl::Color& color) const override;
+  void pushDebugGroupLabel(const char* label, const igl::Color& color) const override;
 
   void popDebugGroupLabel() const override;
 

diff --git a/src/igl/opengl/ComputeCommandEncoder.cpp b/src/igl/opengl/ComputeCommandEncoder.cpp
@@ -60,27 +60,29 @@ void ComputeCommandEncoder::dispatchThreadGroups(const Dimensions& threadgroupCo
   }
 }
 
-void ComputeCommandEncoder::pushDebugGroupLabel(const std::string& label,
+void ComputeCommandEncoder::pushDebugGroupLabel(const char* label,
                                                 const igl::Color& /*color*/) const {
-  IGL_ASSERT(!label.empty());
+  IGL_ASSERT(label != nullptr);
   if (getContext().deviceFeatures().hasInternalFeature(InternalFeatures::DebugMessage)) {
-    getContext().pushDebugGroup(GL_DEBUG_SOURCE_APPLICATION, 0, label.length(), label.c_str());
+    std::string_view labelSV(label);
+    getContext().pushDebugGroup(GL_DEBUG_SOURCE_APPLICATION, 0, labelSV.length(), labelSV.data());
   } else {
     IGL_LOG_ERROR_ONCE(
         "ComputeCommandEncoder::pushDebugGroupLabel not supported in this context!\n");
   }
 }
 
-void ComputeCommandEncoder::insertDebugEventLabel(const std::string& label,
+void ComputeCommandEncoder::insertDebugEventLabel(const char* label,
                                                   const igl::Color& /*color*/) const {
-  IGL_ASSERT(!label.empty());
+  IGL_ASSERT(label != nullptr);
   if (getContext().deviceFeatures().hasInternalFeature(InternalFeatures::DebugMessage)) {
+    std::string_view labelSV(label);
     getContext().debugMessageInsert(GL_DEBUG_SOURCE_APPLICATION,
                                     GL_DEBUG_TYPE_MARKER,
                                     0,
                                     GL_DEBUG_SEVERITY_LOW,
-                                    label.length(),
-                                    label.c_str());
+                                    labelSV.length(),
+                                    labelSV.data());
   } else {
     IGL_LOG_ERROR_ONCE(
         "ComputeCommandEncoder::insertDebugEventLabel not supported in this context!\n");

diff --git a/src/igl/opengl/ComputeCommandEncoder.h b/src/igl/opengl/ComputeCommandEncoder.h
@@ -38,8 +38,8 @@ class ComputeCommandEncoder final : public IComputeCommandEncoder, public WithCo
                             const Dimensions& threadgroupSize) override;
   void endEncoding() override;
 
-  void pushDebugGroupLabel(const std::string& label, const igl::Color& color) const override;
-  void insertDebugEventLabel(const std::string& label, const igl::Color& color) const override;
+  void pushDebugGroupLabel(const char* label, const igl::Color& color) const override;
+  void insertDebugEventLabel(const char* label, const igl::Color& color) const override;
   void popDebugGroupLabel() const override;
   void bindUniform(const UniformDesc& uniformDesc, const void* data) override;
   void bindTexture(size_t index, ITexture* texture) override;

diff --git a/src/igl/opengl/RenderCommandEncoder.cpp b/src/igl/opengl/RenderCommandEncoder.cpp
@@ -154,30 +154,31 @@ void RenderCommandEncoder::endEncoding() {
   }
 }
 
-void RenderCommandEncoder::pushDebugGroupLabel(const std::string& label,
+void RenderCommandEncoder::pushDebugGroupLabel(const char* label,
                                                const igl::Color& /*color*/) const {
   IGL_ASSERT(adapter_);
-  IGL_ASSERT(!label.empty());
-
+  IGL_ASSERT(label != nullptr);
   if (getContext().deviceFeatures().hasInternalFeature(InternalFeatures::DebugMessage)) {
-    getContext().pushDebugGroup(GL_DEBUG_SOURCE_APPLICATION, 0, label.length(), label.c_str());
+    std::string_view labelSV(label);
+    getContext().pushDebugGroup(GL_DEBUG_SOURCE_APPLICATION, 0, labelSV.length(), labelSV.data());
   } else {
     IGL_LOG_ERROR_ONCE(
         "RenderCommandEncoder::pushDebugGroupLabel not supported in this context!\n");
   }
 }
 
-void RenderCommandEncoder::insertDebugEventLabel(const std::string& label,
+void RenderCommandEncoder::insertDebugEventLabel(const char* label,
                                                  const igl::Color& /*color*/) const {
   IGL_ASSERT(adapter_);
-  IGL_ASSERT(!label.empty());
+  IGL_ASSERT(label != nullptr);
   if (getContext().deviceFeatures().hasInternalFeature(InternalFeatures::DebugMessage)) {
+    std::string_view labelSV(label);
     getContext().debugMessageInsert(GL_DEBUG_SOURCE_APPLICATION,
                                     GL_DEBUG_TYPE_MARKER,
                                     0,
                                     GL_DEBUG_SEVERITY_LOW,
-                                    label.length(),
-                                    label.c_str());
+                                    labelSV.length(),
+                                    labelSV.data());
   } else {
     IGL_LOG_ERROR_ONCE(
         "RenderCommandEncoder::insertDebugEventLabel not supported in this context!\n");

diff --git a/src/igl/opengl/RenderCommandEncoder.h b/src/igl/opengl/RenderCommandEncoder.h
@@ -45,8 +45,8 @@ class RenderCommandEncoder final : public IRenderCommandEncoder, public WithCont
  public:
   void endEncoding() override;
 
-  void pushDebugGroupLabel(const std::string& label, const igl::Color& color) const override;
-  void insertDebugEventLabel(const std::string& label, const igl::Color& color) const override;
+  void pushDebugGroupLabel(const char* label, const igl::Color& color) const override;
+  void insertDebugEventLabel(const char* label, const igl::Color& color) const override;
   void popDebugGroupLabel() const override;
 
   void bindViewport(const Viewport& viewport) override;

diff --git a/src/igl/tests/metal/RenderCommandEncoder.mm b/src/igl/tests/metal/RenderCommandEncoder.mm
@@ -82,9 +82,9 @@ void TearDown() override {}
   auto encoder = commandBuffer_->createRenderCommandEncoder(rpDesc, framebuffer);
   ASSERT_TRUE(encoder != nullptr);
 
-  encoder->pushDebugGroupLabel(label_);
+  encoder->pushDebugGroupLabel(label_.c_str());
 
-  encoder->insertDebugEventLabel(label_);
+  encoder->insertDebugEventLabel(label_.c_str());
 
   encoder->popDebugGroupLabel();
 

diff --git a/src/igl/vulkan/CommandBuffer.cpp b/src/igl/vulkan/CommandBuffer.cpp
@@ -132,8 +132,9 @@ void CommandBuffer::present(std::shared_ptr<ITexture> surface) const {
   }
 }
 
-void CommandBuffer::pushDebugGroupLabel(const std::string& label, const igl::Color& color) const {
-  ivkCmdBeginDebugUtilsLabel(&ctx_.vf_, wrapper_.cmdBuf_, label.c_str(), color.toFloatPtr());
+void CommandBuffer::pushDebugGroupLabel(const char* label, const igl::Color& color) const {
+  IGL_ASSERT(label != nullptr);
+  ivkCmdBeginDebugUtilsLabel(&ctx_.vf_, wrapper_.cmdBuf_, label, color.toFloatPtr());
 }
 
 void CommandBuffer::popDebugGroupLabel() const {

diff --git a/src/igl/vulkan/CommandBuffer.h b/src/igl/vulkan/CommandBuffer.h
@@ -32,7 +32,7 @@ class CommandBuffer final : public ICommandBuffer,
 
   void present(std::shared_ptr<ITexture> surface) const override;
 
-  void pushDebugGroupLabel(const std::string& label, const igl::Color& color) const override;
+  void pushDebugGroupLabel(const char* label, const igl::Color& color) const override;
 
   void popDebugGroupLabel() const override;
 

diff --git a/src/igl/vulkan/ComputeCommandEncoder.cpp b/src/igl/vulkan/ComputeCommandEncoder.cpp
@@ -80,18 +80,15 @@ void ComputeCommandEncoder::dispatchThreadGroups(const Dimensions& threadgroupCo
       cmdBuffer_, threadgroupCount.width, threadgroupCount.height, threadgroupCount.depth);
 }
 
-void ComputeCommandEncoder::pushDebugGroupLabel(const std::string& label,
-                                                const igl::Color& color) const {
-  IGL_ASSERT(!label.empty());
-
-  ivkCmdBeginDebugUtilsLabel(&ctx_.vf_, cmdBuffer_, label.c_str(), color.toFloatPtr());
+void ComputeCommandEncoder::pushDebugGroupLabel(const char* label, const igl::Color& color) const {
+  IGL_ASSERT(label != nullptr);
+  ivkCmdBeginDebugUtilsLabel(&ctx_.vf_, cmdBuffer_, label, color.toFloatPtr());
 }
 
-void ComputeCommandEncoder::insertDebugEventLabel(const std::string& label,
+void ComputeCommandEncoder::insertDebugEventLabel(const char* label,
                                                   const igl::Color& color) const {
-  IGL_ASSERT(!label.empty());
-
-  ivkCmdInsertDebugUtilsLabel(&ctx_.vf_, cmdBuffer_, label.c_str(), color.toFloatPtr());
+  IGL_ASSERT(label != nullptr);
+  ivkCmdInsertDebugUtilsLabel(&ctx_.vf_, cmdBuffer_, label, color.toFloatPtr());
 }
 
 void ComputeCommandEncoder::popDebugGroupLabel() const {

diff --git a/src/igl/vulkan/ComputeCommandEncoder.h b/src/igl/vulkan/ComputeCommandEncoder.h
@@ -37,8 +37,8 @@ class ComputeCommandEncoder : public IComputeCommandEncoder {
                             const Dimensions& threadgroupSize) override;
   void endEncoding() override;
 
-  void pushDebugGroupLabel(const std::string& label, const igl::Color& color) const override;
-  void insertDebugEventLabel(const std::string& label, const igl::Color& color) const override;
+  void pushDebugGroupLabel(const char* label, const igl::Color& color) const override;
+  void insertDebugEventLabel(const char* label, const igl::Color& color) const override;
   void popDebugGroupLabel() const override;
   void bindUniform(const UniformDesc& uniformDesc, const void* data) override;
   void bindTexture(size_t index, ITexture* texture) override;

diff --git a/src/igl/vulkan/RenderCommandEncoder.cpp b/src/igl/vulkan/RenderCommandEncoder.cpp
@@ -333,14 +333,14 @@ void RenderCommandEncoder::endEncoding() {
                       VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL);
 }
 
-void RenderCommandEncoder::pushDebugGroupLabel(const std::string& label,
-                                               const igl::Color& color) const {
-  ivkCmdBeginDebugUtilsLabel(&ctx_.vf_, cmdBuffer_, label.c_str(), color.toFloatPtr());
+void RenderCommandEncoder::pushDebugGroupLabel(const char* label, const igl::Color& color) const {
+  IGL_ASSERT(label != nullptr);
+  ivkCmdBeginDebugUtilsLabel(&ctx_.vf_, cmdBuffer_, label, color.toFloatPtr());
 }
 
-void RenderCommandEncoder::insertDebugEventLabel(const std::string& label,
-                                                 const igl::Color& color) const {
-  ivkCmdInsertDebugUtilsLabel(&ctx_.vf_, cmdBuffer_, label.c_str(), color.toFloatPtr());
+void RenderCommandEncoder::insertDebugEventLabel(const char* label, const igl::Color& color) const {
+  IGL_ASSERT(label != nullptr);
+  ivkCmdInsertDebugUtilsLabel(&ctx_.vf_, cmdBuffer_, label, color.toFloatPtr());
 }
 
 void RenderCommandEncoder::popDebugGroupLabel() const {

diff --git a/src/igl/vulkan/RenderCommandEncoder.h b/src/igl/vulkan/RenderCommandEncoder.h
@@ -37,8 +37,8 @@ class RenderCommandEncoder : public IRenderCommandEncoder {
 
   void endEncoding() override;
 
-  void pushDebugGroupLabel(const std::string& label, const igl::Color& color) const override;
-  void insertDebugEventLabel(const std::string& label, const igl::Color& color) const override;
+  void pushDebugGroupLabel(const char* label, const igl::Color& color) const override;
+  void insertDebugEventLabel(const char* label, const igl::Color& color) const override;
   void popDebugGroupLabel() const override;
 
   void bindViewport(const Viewport& viewport) override;