src/vulkan/util/vk_object.h

   1 /*
   2  * Copyright © 2020 Intel Corporation
   3  *
   4  * Permission is hereby granted, free of charge, to any person obtaining a
   5  * copy of this software and associated documentation files (the "Software"),
   6  * to deal in the Software without restriction, including without limitation
   7  * the rights to use, copy, modify, merge, publish, distribute, sublicense,
   8  * and/or sell copies of the Software, and to permit persons to whom the
   9  * Software is furnished to do so, subject to the following conditions:
  10  *
  11  * The above copyright notice and this permission notice (including the next
  12  * paragraph) shall be included in all copies or substantial portions of the
  13  * Software.
  14  *
  15  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  16  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  17  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
  18  * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  19  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
  20  * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
  21  * IN THE SOFTWARE.
  22  */
  23 #ifndef VK_OBJECT_H
  24 #define VK_OBJECT_H
  25
  26 #include <vulkan/vulkan.h>
  27 #include <vulkan/vk_icd.h>
  28
  29 #include "util/macros.h"
  30
  31 #ifdef __cplusplus
  32 extern "C" {
  33 #endif
  34
  35 struct vk_device;
  36
  37 struct vk_object_base {
  38    VK_LOADER_DATA _loader_data;
  39 #ifndef NDEBUG
  40    VkObjectType type;
  41 #endif
  42 };
  43
  44 void vk_object_base_init(UNUSED struct vk_device *device,
  45                          struct vk_object_base *base,
  46                          UNUSED VkObjectType obj_type);
  47 void vk_object_base_finish(UNUSED struct vk_object_base *base);
  48
  49 static inline void
  50 vk_object_base_assert_valid(ASSERTED struct vk_object_base *base,
  51                             ASSERTED VkObjectType obj_type)
  52 {
  53    assert(base == NULL || base->type == obj_type);
  54 }
  55
  56
  57 struct vk_device {
  58    struct vk_object_base base;
  59    VkAllocationCallbacks alloc;
  60 };
  61
  62 void vk_device_init(struct vk_device *device,
  63                     const VkDeviceCreateInfo *pCreateInfo,
  64                     const VkAllocationCallbacks *instance_alloc,
  65                     const VkAllocationCallbacks *device_alloc);
  66 void vk_device_finish(struct vk_device *device);
  67
  68 #define VK_DEFINE_HANDLE_CASTS(__driver_type, __base, __VkType, __VK_TYPE) \
  69    static inline struct __driver_type *                                    \
  70    __driver_type ## _from_handle(__VkType _handle)                         \
  71    {                                                                       \
  72       struct vk_object_base *base = (struct vk_object_base *)_handle;      \
  73       vk_object_base_assert_valid(base, __VK_TYPE);                        \
  74       STATIC_ASSERT(offsetof(struct __driver_type, __base) == 0);          \
  75       return (struct __driver_type *) base;                                \
  76    }                                                                       \
  77                                                                            \
  78    static inline __VkType                                                  \
  79    __driver_type ## _to_handle(struct __driver_type *_obj)                 \
  80    {                                                                       \
  81       vk_object_base_assert_valid(&_obj->__base, __VK_TYPE);               \
  82       return (__VkType) _obj;                                              \
  83    }
  84
  85 #define VK_DEFINE_NONDISP_HANDLE_CASTS(__driver_type, __base, __VkType, __VK_TYPE) \
  86    static inline struct __driver_type *                                    \
  87    __driver_type ## _from_handle(__VkType _handle)                         \
  88    {                                                                       \
  89       struct vk_object_base *base =                                        \
  90          (struct vk_object_base *)(uintptr_t)_handle;                      \
  91       vk_object_base_assert_valid(base, __VK_TYPE);                        \
  92       STATIC_ASSERT(offsetof(struct __driver_type, __base) == 0);          \
  93       return (struct __driver_type *)base;                                 \
  94    }                                                                       \
  95                                                                            \
  96    static inline __VkType                                                  \
  97    __driver_type ## _to_handle(struct __driver_type *_obj)                 \
  98    {                                                                       \
  99       vk_object_base_assert_valid(&_obj->__base, __VK_TYPE);               \
 100       return (__VkType)(uintptr_t) _obj;                                   \
 101    }
 102
 103 #define VK_FROM_HANDLE(__driver_type, __name, __handle) \
 104    struct __driver_type *__name = __driver_type ## _from_handle(__handle)
 105
 106 #ifdef __cplusplus
 107 }
 108 #endif
 109
 110 #endif /* VK_OBJECT_H */