vulkan: use instance allocator for `object_name` in some objects

The allocator passed to VkDevice won't be available once it is destroyed
and thefore it cannot be used to allocate `object_name` for instance
level objects such as `VkInstance` or `VkPhysicalDevice` or else there
would be no way of deallocating it when those objects are destroyed.

Cc: mesa-stable
Reviewed-by: Lionel Landwerlin <lionel.g.landwerlin@intel.com>
Reviewed-by: Mark Collins <mark@igalia.com>
Part-of: <https://gitlab.freedesktop.org/mesa/mesa/-/merge_requests/26085>
(cherry picked from commit 2d49f834b20d705d901414f6fc2b1fec019689c4)

diff --git a/.pick_status.json b/.pick_status.json
index 12d874cc5b19645ca9b3434669721cc522a8bdbc..b8443fb1346daf474bcb1d23445bb55fb5183ad6 100644 (file)
--- a/.pick_status.json
+++ b/.pick_status.json
@@ -434,7 +434,7 @@
         "description": "vulkan: use instance allocator for `object_name` in some objects",
         "nominated": true,
         "nomination_type": 0,
-        "resolution": 0,
+        "resolution": 1,
         "main_sha": null,
         "because_sha": null,
         "notes": null

diff --git a/src/vulkan/runtime/vk_debug_report.c b/src/vulkan/runtime/vk_debug_report.c
index ea9aebf59305c1a6bca064fd050b7a9805741394..6712ba6d1c846f183df06a71c4db70e5425782ec 100644 (file)
--- a/src/vulkan/runtime/vk_debug_report.c
+++ b/src/vulkan/runtime/vk_debug_report.c
@@ -58,8 +58,8 @@ vk_common_CreateDebugReportCallbackEXT(VkInstance _instance,
    if (!cb)
       return VK_ERROR_OUT_OF_HOST_MEMORY;
 
-   vk_object_base_init(NULL, &cb->base,
-                       VK_OBJECT_TYPE_DEBUG_REPORT_CALLBACK_EXT);
+   vk_object_base_instance_init(instance, &cb->base,
+                                VK_OBJECT_TYPE_DEBUG_REPORT_CALLBACK_EXT);
 
    cb->flags = pCreateInfo->flags;
    cb->callback = pCreateInfo->pfnCallback;

diff --git a/src/vulkan/runtime/vk_debug_utils.c b/src/vulkan/runtime/vk_debug_utils.c
index 70bcf103dbfc06433c681c0dde248d2e41fa6a20..3865fd66802e993556e6d8bcae53b21cfd41db34 100644 (file)
--- a/src/vulkan/runtime/vk_debug_utils.c
+++ b/src/vulkan/runtime/vk_debug_utils.c
@@ -213,11 +213,14 @@ vk_common_SetDebugUtilsObjectNameEXT(
       vk_object_base_from_u64_handle(pNameInfo->objectHandle,
                                      pNameInfo->objectType);
 
+   assert(object->device != NULL || object->instance != NULL);
+   VkAllocationCallbacks *alloc = object->device != NULL ?
+      &object->device->alloc : &object->instance->alloc;
    if (object->object_name) {
-      vk_free(&device->alloc, object->object_name);
+      vk_free(alloc, object->object_name);
       object->object_name = NULL;
    }
-   object->object_name = vk_strdup(&device->alloc, pNameInfo->pObjectName,
+   object->object_name = vk_strdup(alloc, pNameInfo->pObjectName,
                                    VK_SYSTEM_ALLOCATION_SCOPE_OBJECT);
    if (!object->object_name)
       return VK_ERROR_OUT_OF_HOST_MEMORY;

diff --git a/src/vulkan/runtime/vk_instance.c b/src/vulkan/runtime/vk_instance.c
index d14b196b27bd8bd8e914a4c951fe92c22939b2be..2224caf58411b7097bef2d9deb65672fdf9decfb 100644 (file)
--- a/src/vulkan/runtime/vk_instance.c
+++ b/src/vulkan/runtime/vk_instance.c
@@ -52,7 +52,7 @@ vk_instance_init(struct vk_instance *instance,
                  const VkAllocationCallbacks *alloc)
 {
    memset(instance, 0, sizeof(*instance));
-   vk_object_base_init(NULL, &instance->base, VK_OBJECT_TYPE_INSTANCE);
+   vk_object_base_instance_init(instance, &instance->base, VK_OBJECT_TYPE_INSTANCE);
    instance->alloc = *alloc;
 
    util_cpu_trace_init();
@@ -75,8 +75,8 @@ vk_instance_init(struct vk_instance *instance,
          if (!messenger)
             return vk_error(instance, VK_ERROR_OUT_OF_HOST_MEMORY);
 
-         vk_object_base_init(NULL, &messenger->base,
-                             VK_OBJECT_TYPE_DEBUG_UTILS_MESSENGER_EXT);
+         vk_object_base_instance_init(instance, &messenger->base,
+                                      VK_OBJECT_TYPE_DEBUG_UTILS_MESSENGER_EXT);
 
          messenger->alloc = *alloc;
          messenger->severity = debugMessengerCreateInfo->messageSeverity;

diff --git a/src/vulkan/runtime/vk_object.c b/src/vulkan/runtime/vk_object.c
index b46a0f775549e562d835da522fc958b6f578179c..753640b77b8ee40db7bea655af1cef3e6a6f3037 100644 (file)
--- a/src/vulkan/runtime/vk_object.c
+++ b/src/vulkan/runtime/vk_object.c
@@ -25,6 +25,7 @@
 
 #include "vk_alloc.h"
 #include "vk_common_entrypoints.h"
+#include "vk_instance.h"
 #include "vk_device.h"
 #include "util/hash_table.h"
 #include "util/ralloc.h"
@@ -38,6 +39,20 @@ vk_object_base_init(struct vk_device *device,
    base->_loader_data.loaderMagic = ICD_LOADER_MAGIC;
    base->type = obj_type;
    base->device = device;
+   base->instance = NULL;
+   base->client_visible = false;
+   base->object_name = NULL;
+   util_sparse_array_init(&base->private_data, sizeof(uint64_t), 8);
+}
+
+void vk_object_base_instance_init(struct vk_instance *instance,
+                                  struct vk_object_base *base,
+                                  VkObjectType obj_type)
+{
+   base->_loader_data.loaderMagic = ICD_LOADER_MAGIC;
+   base->type = obj_type;
+   base->device = NULL;
+   base->instance = instance;
    base->client_visible = false;
    base->object_name = NULL;
    util_sparse_array_init(&base->private_data, sizeof(uint64_t), 8);
@@ -48,8 +63,14 @@ vk_object_base_finish(struct vk_object_base *base)
 {
    util_sparse_array_finish(&base->private_data);
 
-   if (base->object_name != NULL)
+   if (base->object_name == NULL)
+      return;
+
+   assert(base->device != NULL || base->instance != NULL);
+   if (base->device)
       vk_free(&base->device->alloc, base->object_name);
+   else
+      vk_free(&base->instance->alloc, base->object_name);
 }
 
 void

diff --git a/src/vulkan/runtime/vk_object.h b/src/vulkan/runtime/vk_object.h
index ad87121e15c010804d07501f7e61b1478707354b..0728e894b587980045824e2081c1780bae125a3f 100644 (file)
--- a/src/vulkan/runtime/vk_object.h
+++ b/src/vulkan/runtime/vk_object.h
@@ -57,6 +57,14 @@ struct vk_object_base {
     */
    struct vk_device *device;
 
+   /** Pointer to the instance in which this object exists
+    *
+    * This is NULL for device level objects as it's main purpose is to make
+    * the instance allocator reachable for freeing data owned by instance
+    * level objects.
+    */
+   struct vk_instance *instance;
+
    /* True if this object is fully constructed and visible to the client */
    bool client_visible;
 
@@ -77,6 +85,16 @@ void vk_object_base_init(struct vk_device *device,
                          struct vk_object_base *base,
                          VkObjectType obj_type);
 
+/** Initialize a vk_base_object for an instance level object
+ *
+ * :param instance:     |in|  The vk_instance this object was created from
+ * :param base:         |out| The vk_object_base to initialize
+ * :param obj_type:     |in|  The VkObjectType of the object being initialized
+ */
+void vk_object_base_instance_init(struct vk_instance *instance,
+                                  struct vk_object_base *base,
+                                  VkObjectType obj_type);
+
 /** Tear down a vk_object_base
  *
  * @param[out] base     The vk_object_base being torn down

diff --git a/src/vulkan/runtime/vk_physical_device.c b/src/vulkan/runtime/vk_physical_device.c
index ea277516be226bc002b06b5a60495b3ed557c818..188449f8c50bcaf0f65ec7690b9b281f6958b26d 100644 (file)
--- a/src/vulkan/runtime/vk_physical_device.c
+++ b/src/vulkan/runtime/vk_physical_device.c
@@ -35,7 +35,7 @@ vk_physical_device_init(struct vk_physical_device *pdevice,
                         const struct vk_physical_device_dispatch_table *dispatch_table)
 {
    memset(pdevice, 0, sizeof(*pdevice));
-   vk_object_base_init(NULL, &pdevice->base, VK_OBJECT_TYPE_PHYSICAL_DEVICE);
+   vk_object_base_instance_init(instance, &pdevice->base, VK_OBJECT_TYPE_PHYSICAL_DEVICE);
    pdevice->instance = instance;
 
    if (supported_extensions != NULL)