Code style cleanup

Author: solidpixel

layer_gpu_timeline/source/layer_device_functions_debug.cpp

@@ -1,7 +1,7 @@
 /*
  * SPDX-License-Identifier: MIT
  * ----------------------------------------------------------------------------
- * Copyright (c) 2024 Arm Limited
+ * Copyright (c) 2024-2025 Arm Limited
  *
  * Permission is hereby granted, free of charge, to any person obtaining a copy
  * of this software and associated documentation files (the "Software"), to
@@ -44,7 +44,7 @@ VKAPI_ATTR void VKAPI_CALL layer_vkCmdDebugMarkerBeginEXT<user_tag>(VkCommandBuf
     auto& tracker = layer->getStateTracker();
     auto& cb = tracker.getCommandBuffer(commandBuffer);
 
-    // Increment the render pass counter in the tracker
+    // Push the label scope to the tracker
     cb.debugMarkerBegin(pMarkerInfo->pMarkerName);
 
     // Note that we do not call the driver for user labels - they are
@@ -65,7 +65,7 @@ VKAPI_ATTR void VKAPI_CALL layer_vkCmdDebugMarkerEndEXT<user_tag>(VkCommandBuffe
     auto& tracker = layer->getStateTracker();
     auto& cb = tracker.getCommandBuffer(commandBuffer);
 
-    // Increment the render pass counter in the tracker
+    // Pop the label scope in the tracker
     cb.debugMarkerEnd();
 
     // Note that we do not call the driver for user labels - they are
@@ -87,7 +87,7 @@ VKAPI_ATTR void VKAPI_CALL layer_vkCmdBeginDebugUtilsLabelEXT<user_tag>(VkComman
     auto& tracker = layer->getStateTracker();
     auto& cb = tracker.getCommandBuffer(commandBuffer);
 
-    // Increment the render pass counter in the tracker
+    // Push the label scope to the tracker
     cb.debugMarkerBegin(pLabelInfo->pLabelName);
 
     // Note that we do not call the driver for user labels - they are
@@ -108,7 +108,7 @@ VKAPI_ATTR void VKAPI_CALL layer_vkCmdEndDebugUtilsLabelEXT<user_tag>(VkCommandB
     auto& tracker = layer->getStateTracker();
     auto& cb = tracker.getCommandBuffer(commandBuffer);
 
-    // Increment the render pass counter in the tracker
+    // Pop the label scope in the tracker
     cb.debugMarkerEnd();
 
     // Note that we do not call the driver for user labels - they are

layer_gpu_timeline/source/timeline_protobuf_encoder.cpp

@@ -87,7 +87,7 @@ using Submit = pp::message<
     /* The VkQueue the frame belongs to */
     pp::uint64_field<"queue", 3>>;
 
-/* Enumerates the possible attachment types a renderpass can have */
+/* Enumerates the possible attachment types a render pass can have */
 enum class RenderpassAttachmentType
 {
     undefined = 0,
@@ -96,7 +96,7 @@ enum class RenderpassAttachmentType
     stencil = 3,
 };
 
-/* Describe an attachment to a renderpass */
+/* Describe an attachment to a render pass */
 using RenderpassAttachment = pp::message<
     /* The attachment type */
     pp::enum_field<"type", 1, RenderpassAttachmentType>,
@@ -112,29 +112,29 @@ using RenderpassAttachment = pp::message<
        things are not resolved, so this saves a field in the data) */
     pp::bool_field<"resolved", 5>>;
 
-/* Start a new renderpass */
+/* Start a new render pass */
 using BeginRenderpass = pp::message<
-    /* The unique identifier for this new renderpass */
+    /* The unique identifier for this new render pass */
     pp::uint64_field<"tag_id", 1>,
-    /* The dimensions of the renderpass' attachments */
+    /* The dimensions of the render pass' attachments */
     pp::uint32_field<"width", 2>,
     pp::uint32_field<"height", 3>,
-    /* The number of drawcalls in the renderpass */
+    /* The number of drawcalls in the render pass */
     pp::uint32_field<"draw_call_count", 4>,
     /* The subpass count */
     pp::uint32_field<"subpass_count", 5>,
-    /* Any user defined debug labels associated with the renderpass */
+    /* Any user defined debug labels associated with the render pass */
     pp::string_field<"debug_label", 6, pp::repeated>,
-    /* Any attachments associated with the renderpass */
+    /* Any attachments associated with the render pass */
     pp::message_field<"attachments", 7, RenderpassAttachment, pp::repeated>>;
 
-/* Continue a split renderpass */
+/* Continue a split render pass */
 using ContinueRenderpass = pp::message<
-    /* The unique identifier for the renderpass that is being continued */
+    /* The unique identifier for the render pass that is being continued */
     pp::uint64_field<"tag_id", 1>,
-    /* The number of drawcalls to add to the total in the renderpass */
+    /* The number of drawcalls to add to the total in the render pass */
     pp::uint32_field<"draw_call_count", 2>,
-    /* Any user defined debug labels to add to the renderpass */
+    /* Any user defined debug labels to add to the render pass */
     pp::string_field<"debug_label", 3, pp::repeated>>;
 
 /* A dispatch object submission */
@@ -295,7 +295,7 @@ Comms::MessageData packBuffer(pp::constant<F> c, T&& f)
  * @return A pair, where the first value is the corresponding attachment type, and the second value is
  * the corresponding attachment index (or nullopt in the case the index is not relevant).
  */
-constexpr std::pair<RenderpassAttachmentType, std::optional<uint32_t>> mapRenderpassAttachmentName(
+constexpr std::pair<RenderpassAttachmentType, std::optional<uint32_t>> mapRenderPassAttachmentName(
     Tracker::RenderPassAttachName name)
 {
     switch (name)
@@ -443,29 +443,29 @@ constexpr AccelerationStructureTransferType mapASTransferType(Tracker::LCSAccele
 /**
  * @brief Serialize the metadata for this render pass workload.
  *
- * @param renderpass   The render pass to serialize
+ * @param renderPass   The render pass to serialize
  * @param debugLabel   The debug label stack of the VkQueue at submit time.
  */
-Comms::MessageData serialize(const Tracker::LCSRenderPass& renderpass, const std::vector<std::string>& debugLabel)
+Comms::MessageData serialize(const Tracker::LCSRenderPass& renderPass, const std::vector<std::string>& debugLabel)
 {
     using namespace pp;
 
     // Draw count for a multi-submit command buffer cannot be reliably
     // associated with a single tagID if restartable across command buffer
     // boundaries because different command buffer submit combinations can
     // result in different draw counts for the same starting tagID.
-    const auto drawCount = (!renderpass.isOneTimeSubmit() && renderpass.isSuspending()
+    const auto drawCount = (!renderPass.isOneTimeSubmit() && renderPass.isSuspending()
                                 ? -1
-                                : static_cast<int64_t>(renderpass.getDrawCallCount()));
+                                : static_cast<int64_t>(renderPass.getDrawCallCount()));
 
     // Make the attachments array
-    const auto& attachments = renderpass.getAttachments();
+    const auto& attachments = renderPass.getAttachments();
     std::vector<RenderpassAttachment> attachmentsMsg {};
     attachmentsMsg.reserve(attachments.size());
 
     for (const auto& attachment : attachments)
     {
-        const auto [type, index] = mapRenderpassAttachmentName(attachment.getAttachmentName());
+        const auto [type, index] = mapRenderPassAttachmentName(attachment.getAttachmentName());
 
         attachmentsMsg.emplace_back(type,
                                     index,
@@ -479,11 +479,11 @@ Comms::MessageData serialize(const Tracker::LCSRenderPass& renderpass, const std
 
     return packBuffer("renderpass"_f,
                       BeginRenderpass {
-                          renderpass.getTagID(),
-                          renderpass.getWidth(),
-                          renderpass.getHeight(),
+                          renderPass.getTagID(),
+                          renderPass.getWidth(),
+                          renderPass.getHeight(),
                           drawCount,
-                          renderpass.getSubpassCount(),
+                          renderPass.getSubpassCount(),
                           debugLabel,
                           std::move(attachmentsMsg),
                       });
@@ -492,7 +492,7 @@ Comms::MessageData serialize(const Tracker::LCSRenderPass& renderpass, const std
 /**
  * @brief Serialize the metadata for this render pass continuation workload.
  *
- * @param continuation        The renderpass continuation to serialize
+ * @param continuation        The render pass continuation to serialize
  * @param tagIDContinuation   The ID of the workload if this is a continuation of it.
  */
 Comms::MessageData serialize(const Tracker::LCSRenderPassContinuation& continuation, uint64_t tagIDContinuation)
@@ -681,19 +681,19 @@ void TimelineProtobufEncoder::emitSubmit(VkQueue queue, uint64_t timestamp)
                                 }));
 }
 
-void TimelineProtobufEncoder::operator()(const Tracker::LCSRenderPass& renderpass,
+void TimelineProtobufEncoder::operator()(const Tracker::LCSRenderPass& renderPass,
                                          const std::vector<std::string>& debugStack)
 {
-    device.txMessage(serialize(renderpass, debugStack));
+    device.txMessage(serialize(renderPass, debugStack));
 }
 
 void TimelineProtobufEncoder::operator()(const Tracker::LCSRenderPassContinuation& continuation,
                                          const std::vector<std::string>& debugStack,
-                                         uint64_t renderpassTagID)
+                                         uint64_t renderPassTagID)
 {
     UNUSED(debugStack);
 
-    device.txMessage(serialize(continuation, renderpassTagID));
+    device.txMessage(serialize(continuation, renderPassTagID));
 }
 
 void TimelineProtobufEncoder::operator()(const Tracker::LCSDispatch& dispatch,

layer_gpu_timeline/source/timeline_protobuf_encoder.hpp

@@ -90,7 +90,7 @@ class TimelineProtobufEncoder : public Tracker::SubmitCommandWorkloadVisitor
     static void emitFrame(Device& device, uint64_t frameNumber, uint64_t timestamp);
 
     /**
-     * Construct a new workload metadata emitter that will output paylaods for the provided device
+     * Construct a new workload metadata emitter that will output payloads for the provided device
      *
      * @param _device The device object that the payloads are produced for, and to which they are passed for
      * transmission
@@ -100,17 +100,17 @@ class TimelineProtobufEncoder : public Tracker::SubmitCommandWorkloadVisitor
     {
     }
 
-    // visitor should not be copied or moved from
+    // Visitor should not be copied or moved from
     TimelineProtobufEncoder(const TimelineProtobufEncoder&) = delete;
     TimelineProtobufEncoder(TimelineProtobufEncoder&&) noexcept = delete;
     TimelineProtobufEncoder& operator=(const TimelineProtobufEncoder&) = delete;
     TimelineProtobufEncoder& operator=(TimelineProtobufEncoder&&) noexcept = delete;
 
-    // methods from the visitor interface
-    void operator()(const Tracker::LCSRenderPass& renderpass, const std::vector<std::string>& debugStack) override;
+    // Methods from the visitor interface
+    void operator()(const Tracker::LCSRenderPass& renderPass, const std::vector<std::string>& debugStack) override;
     void operator()(const Tracker::LCSRenderPassContinuation& continuation,
                     const std::vector<std::string>& debugStack,
-                    uint64_t renderpassTagID) override;
+                    uint64_t renderPassTagID) override;
     void operator()(const Tracker::LCSDispatch& dispatch, const std::vector<std::string>& debugStack) override;
     void operator()(const Tracker::LCSTraceRays& traceRays, const std::vector<std::string>& debugStack) override;
     void operator()(const Tracker::LCSImageTransfer& imageTransfer,

source_common/comms/comms_interface.hpp

@@ -1,7 +1,7 @@
 /*
  * SPDX-License-Identifier: MIT
  * ----------------------------------------------------------------------------
- * Copyright (c) 2024 Arm Limited
+ * Copyright (c) 2024-2025 Arm Limited
  *
  * Permission is hereby granted, free of charge, to any person obtaining a copy
  * of this software and associated documentation files (the "Software"), to
@@ -63,7 +63,7 @@ static const EndpointID NO_ENDPOINT {0};
 class CommsInterface
 {
 public:
-    virtual ~CommsInterface() { }
+    virtual ~CommsInterface() = default;
 
     /**
      * @brief Is this comms module connected to a host server?

source_common/trackers/queue.cpp

@@ -80,7 +80,7 @@ namespace
         }
 
         /**
-         * @brief Visit a renderpass workload instruction
+         * @brief Visit a render pass workload instruction
          *
          * @param instruction The workload instruction
          */
@@ -99,7 +99,7 @@ namespace
         }
 
         /**
-         * @brief Visit a renderpass continuation workload instruction
+         * @brief Visit a render pass continuation workload instruction
          *
          * @param instruction The workload instruction
          */

source_common/trackers/queue.hpp

@@ -62,23 +62,23 @@ class SubmitCommandWorkloadVisitor
     virtual ~SubmitCommandWorkloadVisitor() noexcept = default;
 
     /**
-     * @brief Visit a renderpass workload object
+     * @brief Visit a render pass workload object
      *
-     * @param renderpass The renderpass
-     * @param debugStack The stack of debug labels that are associated with this renderpass
+     * @param renderPass The render pass
+     * @param debugStack The stack of debug labels that are associated with this render pass
      */
-    virtual void operator()(const LCSRenderPass& renderpass, const std::vector<std::string>& debugStack) = 0;
+    virtual void operator()(const LCSRenderPass& renderPass, const std::vector<std::string>& debugStack) = 0;
 
     /**
-     * @brief Visit a renderpass continuation workload object
+     * @brief Visit a render pass continuation workload object
      *
-     * @param continuation The renderpass continuation
-     * @param debugStack The stack of debug labels that are associated with this renderpass
-     * @param renderpassTagID The renderpass tag that the continuation was associated with
+     * @param continuation The render pass continuation
+     * @param debugStack The stack of debug labels that are associated with this render pass
+     * @param renderPassTagID The render pass tag that the continuation was associated with
      */
     virtual void operator()(const LCSRenderPassContinuation& continuation,
                             const std::vector<std::string>& debugStack,
-                            uint64_t renderpassTagID) = 0;
+                            uint64_t renderPassTagID) = 0;
 
     /**
      * @brief Visit a dispatch workload object

source_common/utils/queue.hpp

@@ -1,7 +1,7 @@
 /*
  * SPDX-License-Identifier: MIT
  * ----------------------------------------------------------------------------
- * Copyright (c) 2024 Arm Limited
+ * Copyright (c) 2024-2025 Arm Limited
  *
  * Permission is hereby granted, free of charge, to any person obtaining a copy
  * of this software and associated documentation files (the "Software"), to
@@ -44,20 +44,22 @@ class Task
     /**
      * @brief Destroy the task.
      */
-    virtual ~Task() { }
+    virtual ~Task() = default;
 
     /**
      * @brief Wait for the task to be complete.
      */
-    void wait() {
+    void wait()
+    {
         std::unique_lock<std::mutex> lock(condition_lock);
         complete_condition.wait(lock, [this]{ return complete.load(); });
     }
 
     /**
      * @brief Notify that the task is complete.
      */
-    void notify() {
+    void notify()
+    {
         std::unique_lock<std::mutex> lock(condition_lock);
         complete = true;
         lock.unlock();