Functional layer_gpu_timeline implementation (#13)

Adds the first implementation of the layer_gpu_timeline
tool that can emit metadata about Arm GPU workloads
that can be combined with Perfetto workload timing
information.

generator/vk_codegen/device_defs.txt

@@ -1,6 +1,4 @@
-#include <memory>
 #include <mutex>
-#include <thread>
 
 // Include from per-layer code
 #include "utils.hpp"

generator/vk_codegen/instance_defs.txt

@@ -1,6 +1,4 @@
-#include <memory>
 #include <mutex>
-#include <thread>
 
 // Include from per-layer code
 #include "device.hpp"

generator/vk_layer/source/device.cpp

@@ -34,6 +34,9 @@
 #include "device.hpp"
 #include "instance.hpp"
 
+/**
+ * @brief The dispatch lookup for all of the created Vulkan instances.
+ */
 static std::unordered_map<void*, std::unique_ptr<Device>> g_devices;
 
 /* See header for documentation. */
@@ -47,26 +50,26 @@ void Device::store(
 
 /* See header for documentation. */
 Device* Device::retrieve(
-    VkDevice handle)
-{
+    VkDevice handle
+) {
     void* key = getDispatchKey(handle);
     assert(isInMap(key, g_devices));
     return g_devices.at(key).get();
 }
 
 /* See header for documentation. */
 Device* Device::retrieve(
-    VkQueue handle)
-{
+    VkQueue handle
+) {
     void* key = getDispatchKey(handle);
     assert(isInMap(key, g_devices));
     return g_devices.at(key).get();
 }
 
 /* See header for documentation. */
 Device* Device::retrieve(
-    VkCommandBuffer handle)
-{
+    VkCommandBuffer handle
+) {
     void* key = getDispatchKey(handle);
     assert(isInMap(key, g_devices));
     return g_devices.at(key).get();
@@ -85,15 +88,10 @@ Device::Device(
     VkPhysicalDevice _physicalDevice,
     VkDevice _device,
     PFN_vkGetDeviceProcAddr nlayerGetProcAddress
-):  instance(_instance),
+):
+    instance(_instance),
     physicalDevice(_physicalDevice),
     device(_device)
 {
     initDriverDeviceDispatchTable(device, nlayerGetProcAddress, driver);
 }
-
-/* See header for documentation. */
-Device::~Device()
-{
-
-}

generator/vk_layer/source/device.hpp

@@ -24,8 +24,7 @@
  */
 
 /**
- * @file
- * Declares the root class for layer management of VkDevice objects.
+ * @file Declares the root class for layer management of VkDevice objects.
  *
  * Role summary
  * ============
@@ -41,10 +40,9 @@
  * Key properties
  * ==============
  *
- * Unlike EGL contexts, Vulkan devices are designed to be used concurrently by
- * multiple application threads. An application can have multiple concurrent
- * devices (although this is less common than with OpenGL ES applications), and
- * use each device from multiple threads.
+ * Vulkan devices are designed to be used concurrently by multiple application
+ * threads. An application can have multiple concurrent devices, and use each
+ * device from multiple threads.
  *
  * Access to the layer driver structures must therefore be kept thread-safe.
  * For sake of simplicity, we generally implement this by:
@@ -80,6 +78,8 @@ class Device
      * @brief Fetch a device from the global store of dispatchable devices.
      *
      * @param handle   The dispatchable device handle to use as an indirect lookup.
+     *
+     * @return The layer device context.
      */
     static Device* retrieve(
         VkDevice handle);
@@ -88,6 +88,8 @@ class Device
      * @brief Fetch a device from the global store of dispatchable devices.
      *
      * @param handle   The dispatchable queue handle to use as an indirect lookup.
+     *
+     * @return The layer device context.
      */
     static Device* retrieve(
         VkQueue handle);
@@ -96,6 +98,8 @@ class Device
      * @brief Fetch a device from the global store of dispatchable devices.
      *
      * @param handle   The dispatchable command buffer handle to use as an indirect lookup.
+     *
+     * @return The layer device context.
      */
     static Device* retrieve(
         VkCommandBuffer handle);
@@ -125,7 +129,7 @@ class Device
     /**
      * @brief Destroy this layer device object.
      */
-    ~Device();
+    ~Device() = default;
 
 public:
     /**

generator/vk_layer/source/instance.cpp

@@ -29,6 +29,9 @@
 
 #include "instance.hpp"
 
+/**
+ * @brief The dispatch lookup for all of the created Vulkan instances.
+ */
 static std::unordered_map<void*, std::unique_ptr<Instance>> g_instances;
 
 /* See header for documentation. */
@@ -42,17 +45,17 @@ void Instance::store(
 
 /* See header for documentation. */
 Instance* Instance::retrieve(
-    VkInstance handle)
-{
+    VkInstance handle
+) {
     void* key = getDispatchKey(handle);
     assert(isInMap(key, g_instances));
     return g_instances.at(key).get();
 }
 
 /* See header for documentation. */
 Instance* Instance::retrieve(
-    VkPhysicalDevice handle)
-{
+    VkPhysicalDevice handle
+) {
     void* key = getDispatchKey(handle);
     assert(isInMap(key, g_instances));
     return g_instances.at(key).get();
@@ -68,7 +71,8 @@ void Instance::destroy(
 /* See header for documentation. */
 Instance::Instance(
     VkInstance _instance,
-    PFN_vkGetInstanceProcAddr _nlayerGetProcAddress) :
+    PFN_vkGetInstanceProcAddr _nlayerGetProcAddress
+) :
     instance(_instance),
     nlayerGetProcAddress(_nlayerGetProcAddress)
 {

generator/vk_layer/source/instance.hpp

@@ -42,9 +42,8 @@
  * Key properties
  * ==============
  *
- * Unlike EGL contexts, Vulkan instances are designed to be used concurrently
- * by multiple application threads. An application can have multiple concurrent
- * instances (although this is less common than with OpenGL ES applications),
+ * Vulkan instances are designed to be used concurrently by multiple
+ * application threads. An application can have multiple concurrent instances,
  * and use each instance from multiple threads.
  *
  * Access to the layer driver structures must therefore be kept thread-safe.
@@ -65,10 +64,6 @@
 
 /**
  * @brief This class implements the layer state tracker for a single instance.
- *
- * These objects are relatively light-weight, as they are rarely used once a VkDevice has been
- * created, but we need to track the chain-of-ownership as the instance is the root object that
- * the application creates when initializing a rendering context.
  */
 class Instance
 {
@@ -87,6 +82,8 @@ class Instance
      * @brief Fetch an instance from the global store of dispatchable instances.
      *
      * @param handle   The dispatchable instance handle to use as an indirect lookup.
+     *
+     * @return The layer instance context.
      */
     static Instance* retrieve(
         VkInstance handle);
@@ -95,6 +92,8 @@ class Instance
      * @brief Fetch an instance from the global store of dispatchable instances.
      *
      * @param handle   The dispatchable physical device handle to use as an indirect lookup.
+     *
+     * @return The layer instance context.
      */
     static Instance* retrieve(
         VkPhysicalDevice handle);

generator/vk_layer/source/version.hpp.in

@@ -24,9 +24,7 @@
  */
 
 /**
- * @file
- * This header implements placeholder templates that are populated by CMake
- * during configure.
+ * @file Placeholder templates that are populated by CMake during configure.
  */
 
 #pragma once

layer_example/source/device.cpp

@@ -34,6 +34,9 @@
 #include "device.hpp"
 #include "instance.hpp"
 
+/**
+ * @brief The dispatch lookup for all of the created Vulkan instances.
+ */
 static std::unordered_map<void*, std::unique_ptr<Device>> g_devices;
 
 /* See header for documentation. */
@@ -47,26 +50,26 @@ void Device::store(
 
 /* See header for documentation. */
 Device* Device::retrieve(
-    VkDevice handle)
-{
+    VkDevice handle
+) {
     void* key = getDispatchKey(handle);
     assert(isInMap(key, g_devices));
     return g_devices.at(key).get();
 }
 
 /* See header for documentation. */
 Device* Device::retrieve(
-    VkQueue handle)
-{
+    VkQueue handle
+) {
     void* key = getDispatchKey(handle);
     assert(isInMap(key, g_devices));
     return g_devices.at(key).get();
 }
 
 /* See header for documentation. */
 Device* Device::retrieve(
-    VkCommandBuffer handle)
-{
+    VkCommandBuffer handle
+) {
     void* key = getDispatchKey(handle);
     assert(isInMap(key, g_devices));
     return g_devices.at(key).get();
@@ -85,15 +88,10 @@ Device::Device(
     VkPhysicalDevice _physicalDevice,
     VkDevice _device,
     PFN_vkGetDeviceProcAddr nlayerGetProcAddress
-):  instance(_instance),
+):
+    instance(_instance),
     physicalDevice(_physicalDevice),
     device(_device)
 {
     initDriverDeviceDispatchTable(device, nlayerGetProcAddress, driver);
 }
-
-/* See header for documentation. */
-Device::~Device()
-{
-
-}

layer_example/source/device.hpp

@@ -24,8 +24,7 @@
  */
 
 /**
- * @file
- * Declares the root class for layer management of VkDevice objects.
+ * @file Declares the root class for layer management of VkDevice objects.
  *
  * Role summary
  * ============
@@ -41,10 +40,9 @@
  * Key properties
  * ==============
  *
- * Unlike EGL contexts, Vulkan devices are designed to be used concurrently by
- * multiple application threads. An application can have multiple concurrent
- * devices (although this is less common than with OpenGL ES applications), and
- * use each device from multiple threads.
+ * Vulkan devices are designed to be used concurrently by multiple application
+ * threads. An application can have multiple concurrent devices, and use each
+ * device from multiple threads.
  *
  * Access to the layer driver structures must therefore be kept thread-safe.
  * For sake of simplicity, we generally implement this by:
@@ -80,6 +78,8 @@ class Device
      * @brief Fetch a device from the global store of dispatchable devices.
      *
      * @param handle   The dispatchable device handle to use as an indirect lookup.
+     *
+     * @return The layer device context.
      */
     static Device* retrieve(
         VkDevice handle);
@@ -88,6 +88,8 @@ class Device
      * @brief Fetch a device from the global store of dispatchable devices.
      *
      * @param handle   The dispatchable queue handle to use as an indirect lookup.
+     *
+     * @return The layer device context.
      */
     static Device* retrieve(
         VkQueue handle);
@@ -96,6 +98,8 @@ class Device
      * @brief Fetch a device from the global store of dispatchable devices.
      *
      * @param handle   The dispatchable command buffer handle to use as an indirect lookup.
+     *
+     * @return The layer device context.
      */
     static Device* retrieve(
         VkCommandBuffer handle);
@@ -125,7 +129,7 @@ class Device
     /**
      * @brief Destroy this layer device object.
      */
-    ~Device();
+    ~Device() = default;
 
 public:
     /**

layer_example/source/instance.cpp

@@ -29,6 +29,9 @@
 
 #include "instance.hpp"
 
+/**
+ * @brief The dispatch lookup for all of the created Vulkan instances.
+ */
 static std::unordered_map<void*, std::unique_ptr<Instance>> g_instances;
 
 /* See header for documentation. */
@@ -42,17 +45,17 @@ void Instance::store(
 
 /* See header for documentation. */
 Instance* Instance::retrieve(
-    VkInstance handle)
-{
+    VkInstance handle
+) {
     void* key = getDispatchKey(handle);
     assert(isInMap(key, g_instances));
     return g_instances.at(key).get();
 }
 
 /* See header for documentation. */
 Instance* Instance::retrieve(
-    VkPhysicalDevice handle)
-{
+    VkPhysicalDevice handle
+) {
     void* key = getDispatchKey(handle);
     assert(isInMap(key, g_instances));
     return g_instances.at(key).get();
@@ -68,7 +71,8 @@ void Instance::destroy(
 /* See header for documentation. */
 Instance::Instance(
     VkInstance _instance,
-    PFN_vkGetInstanceProcAddr _nlayerGetProcAddress) :
+    PFN_vkGetInstanceProcAddr _nlayerGetProcAddress
+) :
     instance(_instance),
     nlayerGetProcAddress(_nlayerGetProcAddress)
 {