blob: 23449663867db9d24f075a8038fbdf143cba2350 [file] [log] [blame]
Chia-I Wuc1e0f962014-08-04 08:03:57 +08001/*
Chia-I Wuc1e0f962014-08-04 08:03:57 +08002 *
Jon Ashburn1c75aec2016-02-02 17:47:28 -07003 * Copyright (c) 2014-2016 The Khronos Group Inc.
4 * Copyright (c) 2014-2016 Valve Corporation
5 * Copyright (c) 2014-2016 LunarG, Inc.
Courtney Goeltzenleuchter8e1b8d92015-12-02 14:53:22 -07006 * Copyright (C) 2015 Google Inc.
Chia-I Wuc1e0f962014-08-04 08:03:57 +08007 *
Jon Ashburn1c75aec2016-02-02 17:47:28 -07008 * Permission is hereby granted, free of charge, to any person obtaining a copy
9 * of this software and/or associated documentation files (the "Materials"), to
10 * deal in the Materials without restriction, including without limitation the
11 * rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
12 * sell copies of the Materials, and to permit persons to whom the Materials are
13 * furnished to do so, subject to the following conditions:
Chia-I Wuc1e0f962014-08-04 08:03:57 +080014 *
Jon Ashburn1c75aec2016-02-02 17:47:28 -070015 * The above copyright notice(s) and this permission notice shall be included in
16 * all copies or substantial portions of the Materials.
Chia-I Wuc1e0f962014-08-04 08:03:57 +080017 *
Jon Ashburn1c75aec2016-02-02 17:47:28 -070018 * THE MATERIALS ARE PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
Chia-I Wuc1e0f962014-08-04 08:03:57 +080019 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
Jon Ashburn1c75aec2016-02-02 17:47:28 -070020 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
Chia-I Wud8ab1e62014-09-02 08:32:09 +080021 *
Jon Ashburn1c75aec2016-02-02 17:47:28 -070022 * IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
23 * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
24 * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE MATERIALS OR THE
25 * USE OR OTHER DEALINGS IN THE MATERIALS.
26 *
27 * Author: Jon Ashburn <jon@lunarg.com>
28 * Author: Courtney Goeltzenleuchter <courtney@LunarG.com>
Courtney Goeltzenleuchterb9ce3952015-10-30 11:14:30 -060029 * Author: Chia-I Wu <olvaffe@gmail.com>
30 * Author: Chia-I Wu <olv@lunarg.com>
Jon Ashburn1c75aec2016-02-02 17:47:28 -070031 * Author: Mark Lobodzinski <mark@LunarG.com>
Courtney Goeltzenleuchterb9ce3952015-10-30 11:14:30 -060032 *
Chia-I Wuc1e0f962014-08-04 08:03:57 +080033 */
34
35#ifndef LOADER_H
36#define LOADER_H
37
David Pinedoa5036622015-11-06 12:54:48 -070038#include <vulkan/vulkan.h>
Jon Ashburn3708e792015-11-06 11:02:40 -070039#include <vk_loader_platform.h>
Ian Elliottafaf1852015-11-17 17:29:40 -070040
David Pinedoa5036622015-11-06 12:54:48 -070041#include <vulkan/vk_layer.h>
42#include <vulkan/vk_icd.h>
Chia-I Wufe333ed2015-04-11 15:34:07 +080043#include <assert.h>
44
Chia-I Wuc1e0f962014-08-04 08:03:57 +080045#if defined(__GNUC__) && __GNUC__ >= 4
Jon Ashburn1c75aec2016-02-02 17:47:28 -070046#define LOADER_EXPORT __attribute__((visibility("default")))
Chia-I Wuc1e0f962014-08-04 08:03:57 +080047#elif defined(__SUNPRO_C) && (__SUNPRO_C >= 0x590)
Jon Ashburn1c75aec2016-02-02 17:47:28 -070048#define LOADER_EXPORT __attribute__((visibility("default")))
Chia-I Wuc1e0f962014-08-04 08:03:57 +080049#else
Jon Ashburn1c75aec2016-02-02 17:47:28 -070050#define LOADER_EXPORT
Chia-I Wuc1e0f962014-08-04 08:03:57 +080051#endif
52
Jon Ashburnb2379c52015-08-04 10:22:33 -060053#define MAX_STRING_SIZE 1024
Courtney Goeltzenleuchter44667cc2015-06-29 15:39:26 -060054#define VK_MAJOR(version) (version >> 22)
55#define VK_MINOR(version) ((version >> 12) & 0x3ff)
56#define VK_PATCH(version) (version & 0xfff)
Jon Ashburn13482452015-05-12 17:26:48 -060057
Jon Ashburn399c9162015-07-02 09:40:15 -060058enum layer_type {
Jon Ashburn9464e772015-07-02 16:10:32 -060059 VK_LAYER_TYPE_DEVICE_EXPLICIT = 0x1,
60 VK_LAYER_TYPE_INSTANCE_EXPLICIT = 0x2,
Jon Ashburnd1eb3322016-02-10 20:59:26 -070061 VK_LAYER_TYPE_GLOBAL_EXPLICIT = 0x3, // instance and device layer, bitwise
Jon Ashburn9464e772015-07-02 16:10:32 -060062 VK_LAYER_TYPE_DEVICE_IMPLICIT = 0x4,
63 VK_LAYER_TYPE_INSTANCE_IMPLICIT = 0x8,
Jon Ashburnd1eb3322016-02-10 20:59:26 -070064 VK_LAYER_TYPE_GLOBAL_IMPLICIT = 0xc, // instance and device layer, bitwise
65 VK_LAYER_TYPE_META_EXPLICT = 0x10,
Jon Ashburn399c9162015-07-02 09:40:15 -060066};
67
Mark Lobodzinski8d325802016-02-02 18:53:34 -070068typedef enum VkStringErrorFlagBits {
Jon Ashburnb1cdf2e2016-02-10 20:50:19 -070069 VK_STRING_ERROR_NONE = 0x00000000,
70 VK_STRING_ERROR_LENGTH = 0x00000001,
71 VK_STRING_ERROR_BAD_DATA = 0x00000002,
Mark Lobodzinski8d325802016-02-02 18:53:34 -070072} VkStringErrorFlagBits;
73typedef VkFlags VkStringErrorFlags;
74
Jon Ashburnb1cdf2e2016-02-10 20:50:19 -070075static const int MaxLoaderStringLength = 256;
76static const char UTF8_ONE_BYTE_CODE = 0xC0;
77static const char UTF8_ONE_BYTE_MASK = 0xE0;
78static const char UTF8_TWO_BYTE_CODE = 0xE0;
79static const char UTF8_TWO_BYTE_MASK = 0xF0;
80static const char UTF8_THREE_BYTE_CODE = 0xF0;
81static const char UTF8_THREE_BYTE_MASK = 0xF8;
82static const char UTF8_DATA_BYTE_CODE = 0x80;
83static const char UTF8_DATA_BYTE_MASK = 0xC0;
Mark Lobodzinski8d325802016-02-02 18:53:34 -070084
Jon Ashburnd1eb3322016-02-10 20:59:26 -070085static const char std_validation_names[9][VK_MAX_EXTENSION_NAME_SIZE] = {
Jon Ashburnbcb9e372016-02-18 12:48:24 -070086 "VK_LAYER_GOOGLE_threading", "VK_LAYER_LUNARG_param_checker",
Jon Ashburnd1eb3322016-02-10 20:59:26 -070087 "VK_LAYER_LUNARG_device_limits", "VK_LAYER_LUNARG_object_tracker",
88 "VK_LAYER_LUNARG_image", "VK_LAYER_LUNARG_mem_tracker",
89 "VK_LAYER_LUNARG_draw_state", "VK_LAYER_LUNARG_swapchain",
90 "VK_LAYER_GOOGLE_unique_objects"};
91
Jon Ashburn6b00b472015-12-10 08:51:10 -070092// form of all dynamic lists/arrays
93// only the list element should be changed
94struct loader_generic_list {
95 size_t capacity;
96 uint32_t count;
97 void *list;
98};
99
Courtney Goeltzenleuchter67146d02015-06-10 17:39:03 -0600100struct loader_extension_list {
101 size_t capacity;
102 uint32_t count;
Jon Ashburnb7d327c2015-08-04 11:14:18 -0600103 VkExtensionProperties *list;
Courtney Goeltzenleuchter67146d02015-06-10 17:39:03 -0600104};
105
Jon Ashburn92cdb012015-12-10 18:17:34 -0700106struct loader_dev_ext_props {
107 VkExtensionProperties props;
108 uint32_t entrypoint_count;
109 char **entrypoints;
110};
111
112struct loader_device_extension_list {
113 size_t capacity;
114 uint32_t count;
115 struct loader_dev_ext_props *list;
116};
117
Jon Ashburn399c9162015-07-02 09:40:15 -0600118struct loader_name_value {
Jon Ashburnb2379c52015-08-04 10:22:33 -0600119 char name[MAX_STRING_SIZE];
120 char value[MAX_STRING_SIZE];
Jon Ashburn399c9162015-07-02 09:40:15 -0600121};
122
123struct loader_lib_info {
Jon Ashburnb4c24232015-08-20 16:35:30 -0600124 char lib_name[MAX_STRING_SIZE];
Jon Ashburn399c9162015-07-02 09:40:15 -0600125 uint32_t ref_count;
126 loader_platform_dl_handle lib_handle;
127};
Courtney Goeltzenleuchter67146d02015-06-10 17:39:03 -0600128
Jon Ashburn399c9162015-07-02 09:40:15 -0600129struct loader_layer_functions {
Jon Ashburnb2379c52015-08-04 10:22:33 -0600130 char str_gipa[MAX_STRING_SIZE];
131 char str_gdpa[MAX_STRING_SIZE];
Jon Ashburn399c9162015-07-02 09:40:15 -0600132 PFN_vkGetInstanceProcAddr get_instance_proc_addr;
133 PFN_vkGetDeviceProcAddr get_device_proc_addr;
134};
Courtney Goeltzenleuchter67146d02015-06-10 17:39:03 -0600135
Jon Ashburn399c9162015-07-02 09:40:15 -0600136struct loader_layer_properties {
Courtney Goeltzenleuchter44667cc2015-06-29 15:39:26 -0600137 VkLayerProperties info;
Jon Ashburn399c9162015-07-02 09:40:15 -0600138 enum layer_type type;
Jon Ashburnb4c24232015-08-20 16:35:30 -0600139 char lib_name[MAX_STRING_SIZE];
Jon Ashburn399c9162015-07-02 09:40:15 -0600140 struct loader_layer_functions functions;
141 struct loader_extension_list instance_extension_list;
Jon Ashburn92cdb012015-12-10 18:17:34 -0700142 struct loader_device_extension_list device_extension_list;
Jon Ashburn399c9162015-07-02 09:40:15 -0600143 struct loader_name_value disable_env_var;
144 struct loader_name_value enable_env_var;
145};
146
147struct loader_layer_list {
148 size_t capacity;
149 uint32_t count;
150 struct loader_layer_properties *list;
Jon Ashburn13482452015-05-12 17:26:48 -0600151};
152
Courtney Goeltzenleuchter8aff3862015-07-05 12:53:31 -0600153struct loader_layer_library_list {
154 size_t capacity;
155 uint32_t count;
156 struct loader_lib_info *list;
157};
158
Jon Ashburn6cb69f42015-11-17 15:31:02 -0700159struct loader_dispatch_hash_list {
160 size_t capacity;
161 uint32_t count;
Jon Ashburn1c75aec2016-02-02 17:47:28 -0700162 uint32_t *index; // index into the dev_ext dispatch table
Jon Ashburn6cb69f42015-11-17 15:31:02 -0700163};
164
165#define MAX_NUM_DEV_EXTS 250
Jon Ashburn1c75aec2016-02-02 17:47:28 -0700166// loader_dispatch_hash_entry and loader_dev_ext_dispatch_table.DevExt have one
167// to one
Jon Ashburn6cb69f42015-11-17 15:31:02 -0700168// correspondence; one loader_dispatch_hash_entry for one DevExt dispatch entry.
169// Also have a one to one correspondence with functions in dev_ext_trampoline.c
170struct loader_dispatch_hash_entry {
171 char *func_name;
Jon Ashburn1c75aec2016-02-02 17:47:28 -0700172 struct loader_dispatch_hash_list list; // to handle hashing collisions
Jon Ashburn6cb69f42015-11-17 15:31:02 -0700173};
174
Jon Ashburn1c75aec2016-02-02 17:47:28 -0700175typedef void(VKAPI_PTR *PFN_vkDevExt)(VkDevice device);
Jon Ashburn6cb69f42015-11-17 15:31:02 -0700176struct loader_dev_ext_dispatch_table {
177 PFN_vkDevExt DevExt[MAX_NUM_DEV_EXTS];
178};
179
180struct loader_dev_dispatch_table {
181 VkLayerDispatchTable core_dispatch;
182 struct loader_dev_ext_dispatch_table ext_dispatch;
183};
184
Jon Ashburn10f4e822015-06-10 10:06:06 -0600185/* per CreateDevice structure */
186struct loader_device {
Jon Ashburn6cb69f42015-11-17 15:31:02 -0700187 struct loader_dev_dispatch_table loader_dispatch;
Jon Ashburn1c75aec2016-02-02 17:47:28 -0700188 VkDevice device; // device object from the icd
Jon Ashburn10f4e822015-06-10 10:06:06 -0600189
Jon Ashburn1c75aec2016-02-02 17:47:28 -0700190 uint32_t app_extension_count;
Jon Ashburn10f4e822015-06-10 10:06:06 -0600191 VkExtensionProperties *app_extension_props;
192
Courtney Goeltzenleuchter44667cc2015-06-29 15:39:26 -0600193 struct loader_layer_list activated_layer_list;
Jon Ashburn10f4e822015-06-10 10:06:06 -0600194
195 struct loader_device *next;
196};
197
Jon Ashburn392c5622015-06-10 16:11:42 -0600198/* per ICD structure */
Jon Ashburnebfa25e2015-05-15 15:09:35 -0600199struct loader_icd {
Jon Ashburnb4c24232015-08-20 16:35:30 -0600200 // pointers to find other structs
201 const struct loader_scanned_icds *this_icd_lib;
202 const struct loader_instance *this_instance;
Jon Ashburnebfa25e2015-05-15 15:09:35 -0600203
Jon Ashburn10f4e822015-06-10 10:06:06 -0600204 struct loader_device *logical_device_list;
Jon Ashburn1c75aec2016-02-02 17:47:28 -0700205 VkInstance instance; // instance object from the icd
Jon Ashburnc89dd4a2015-05-18 13:20:15 -0600206 PFN_vkGetDeviceProcAddr GetDeviceProcAddr;
Jon Ashburnebfa25e2015-05-15 15:09:35 -0600207 PFN_vkDestroyInstance DestroyInstance;
208 PFN_vkEnumeratePhysicalDevices EnumeratePhysicalDevices;
Chris Forbes1c946ec2015-06-21 22:55:02 +1200209 PFN_vkGetPhysicalDeviceFeatures GetPhysicalDeviceFeatures;
Courtney Goeltzenleuchter2b6559e2015-07-12 12:52:09 -0600210 PFN_vkGetPhysicalDeviceFormatProperties GetPhysicalDeviceFormatProperties;
Jon Ashburn1c75aec2016-02-02 17:47:28 -0700211 PFN_vkGetPhysicalDeviceImageFormatProperties
212 GetPhysicalDeviceImageFormatProperties;
Jon Ashburnebfa25e2015-05-15 15:09:35 -0600213 PFN_vkCreateDevice CreateDevice;
Tony Barbour4e657ba2015-06-24 16:06:58 -0600214 PFN_vkGetPhysicalDeviceProperties GetPhysicalDeviceProperties;
Jon Ashburn1c75aec2016-02-02 17:47:28 -0700215 PFN_vkGetPhysicalDeviceQueueFamilyProperties
216 GetPhysicalDeviceQueueFamilyProperties;
Tony Barbour4e657ba2015-06-24 16:06:58 -0600217 PFN_vkGetPhysicalDeviceMemoryProperties GetPhysicalDeviceMemoryProperties;
Courtney Goeltzenleuchtere25064c2015-09-14 17:22:16 -0600218 PFN_vkEnumerateDeviceExtensionProperties EnumerateDeviceExtensionProperties;
Jon Ashburn1c75aec2016-02-02 17:47:28 -0700219 PFN_vkGetPhysicalDeviceSparseImageFormatProperties
220 GetPhysicalDeviceSparseImageFormatProperties;
Courtney Goeltzenleuchter725db942015-12-09 15:48:16 -0700221 PFN_vkCreateDebugReportCallbackEXT CreateDebugReportCallbackEXT;
222 PFN_vkDestroyDebugReportCallbackEXT DestroyDebugReportCallbackEXT;
223 PFN_vkDebugReportMessageEXT DebugReportMessageEXT;
Ian Elliottec736342015-08-21 15:09:33 -0600224 PFN_vkGetPhysicalDeviceSurfaceSupportKHR GetPhysicalDeviceSurfaceSupportKHR;
Jon Ashburn1c75aec2016-02-02 17:47:28 -0700225 PFN_vkGetPhysicalDeviceSurfaceCapabilitiesKHR
226 GetPhysicalDeviceSurfaceCapabilitiesKHR;
Ian Elliottea666b22015-11-19 16:05:09 -0700227 PFN_vkGetPhysicalDeviceSurfaceFormatsKHR GetPhysicalDeviceSurfaceFormatsKHR;
Jon Ashburn1c75aec2016-02-02 17:47:28 -0700228 PFN_vkGetPhysicalDeviceSurfacePresentModesKHR
229 GetPhysicalDeviceSurfacePresentModesKHR;
Ian Elliotte851dd62015-11-24 15:39:10 -0700230#ifdef VK_USE_PLATFORM_WIN32_KHR
Jon Ashburn1c75aec2016-02-02 17:47:28 -0700231 PFN_vkGetPhysicalDeviceWin32PresentationSupportKHR
232 GetPhysicalDeviceWin32PresentationSupportKHR;
Ian Elliotte851dd62015-11-24 15:39:10 -0700233#endif
234#ifdef VK_USE_PLATFORM_MIR_KHR
Jon Ashburn1c75aec2016-02-02 17:47:28 -0700235 PFN_vkGetPhysicalDeviceMirPresentationSupportKHR
236 GetPhysicalDeviceMirPresentvationSupportKHR;
Ian Elliotte851dd62015-11-24 15:39:10 -0700237#endif
238#ifdef VK_USE_PLATFORM_WAYLAND_KHR
Jon Ashburn1c75aec2016-02-02 17:47:28 -0700239 PFN_vkGetPhysicalDeviceWaylandPresentationSupportKHR
240 GetPhysicalDeviceWaylandPresentationSupportKHR;
Ian Elliotte851dd62015-11-24 15:39:10 -0700241#endif
242#ifdef VK_USE_PLATFORM_XCB_KHR
Jon Ashburn1c75aec2016-02-02 17:47:28 -0700243 PFN_vkGetPhysicalDeviceXcbPresentationSupportKHR
244 GetPhysicalDeviceXcbPresentationSupportKHR;
Ian Elliotte851dd62015-11-24 15:39:10 -0700245#endif
246#ifdef VK_USE_PLATFORM_XLIB_KHR
Jon Ashburn1c75aec2016-02-02 17:47:28 -0700247 PFN_vkGetPhysicalDeviceXlibPresentationSupportKHR
248 GetPhysicalDeviceXlibPresentationSupportKHR;
Ian Elliotte851dd62015-11-24 15:39:10 -0700249#endif
Courtney Goeltzenleuchter44667cc2015-06-29 15:39:26 -0600250
Jon Ashburn10f4e822015-06-10 10:06:06 -0600251 struct loader_icd *next;
Jon Ashburnebfa25e2015-05-15 15:09:35 -0600252};
253
Jon Ashburne0367472015-08-18 18:04:47 -0600254/* per ICD library structure */
255struct loader_icd_libs {
256 size_t capacity;
257 uint32_t count;
258 struct loader_scanned_icds *list;
259};
260
Jon Ashburn392c5622015-06-10 16:11:42 -0600261/* per instance structure */
Jon Ashburn13482452015-05-12 17:26:48 -0600262struct loader_instance {
Jon Ashburnebfa25e2015-05-15 15:09:35 -0600263 VkLayerInstanceDispatchTable *disp; // must be first entry in structure
264
Jon Ashburnfd02a0f2016-03-01 19:51:07 -0700265 uint32_t total_gpu_count; // count of the next two arrays
266 struct loader_physical_device *phys_devs_term;
267 struct loader_physical_device *phys_devs; // tramp wrapped physDev obj list
Courtney Goeltzenleuchter67146d02015-06-10 17:39:03 -0600268 uint32_t total_icd_count;
Jon Ashburn13482452015-05-12 17:26:48 -0600269 struct loader_icd *icds;
270 struct loader_instance *next;
Jon Ashburn1c75aec2016-02-02 17:47:28 -0700271 struct loader_extension_list ext_list; // icds and loaders extensions
Jon Ashburne0367472015-08-18 18:04:47 -0600272 struct loader_icd_libs icd_libs;
Jon Ashburnb4c24232015-08-20 16:35:30 -0600273 struct loader_layer_list instance_layer_list;
274 struct loader_layer_list device_layer_list;
Jon Ashburn6cb69f42015-11-17 15:31:02 -0700275 struct loader_dispatch_hash_entry disp_hash[MAX_NUM_DEV_EXTS];
Jon Ashburnb4c24232015-08-20 16:35:30 -0600276
Courtney Goeltzenleuchter67146d02015-06-10 17:39:03 -0600277 struct loader_msg_callback_map_entry *icd_msg_callback_map;
278
Courtney Goeltzenleuchter44667cc2015-06-29 15:39:26 -0600279 struct loader_layer_list activated_layer_list;
Courtney Goeltzenleuchter67146d02015-06-10 17:39:03 -0600280
Courtney Goeltzenleuchter0bd705c2016-01-08 12:18:43 -0700281 VkInstance instance;
282
Courtney Goeltzenleuchter67146d02015-06-10 17:39:03 -0600283 bool debug_report_enabled;
Courtney Goeltzenleuchter67146d02015-06-10 17:39:03 -0600284 VkLayerDbgFunctionNode *DbgFunctionHead;
Courtney Goeltzenleuchter71b454b2015-07-05 11:28:29 -0600285
Chia-I Wu227c8b32015-10-27 18:04:07 +0800286 VkAllocationCallbacks alloc_callbacks;
Ian Elliotted33eb72015-07-06 14:36:13 -0600287
Ian Elliott54cea232015-10-30 15:28:23 -0600288 bool wsi_surface_enabled;
Mark Lobodzinski1ad14b42015-12-10 16:25:21 -0700289#ifdef VK_USE_PLATFORM_WIN32_KHR
Ian Elliott54cea232015-10-30 15:28:23 -0600290 bool wsi_win32_surface_enabled;
Mark Lobodzinski1ad14b42015-12-10 16:25:21 -0700291#endif
292#ifdef VK_USE_PLATFORM_MIR_KHR
Ian Elliott54cea232015-10-30 15:28:23 -0600293 bool wsi_mir_surface_enabled;
Mark Lobodzinski1ad14b42015-12-10 16:25:21 -0700294#endif
295#ifdef VK_USE_PLATFORM_WAYLAND_KHR
Ian Elliott54cea232015-10-30 15:28:23 -0600296 bool wsi_wayland_surface_enabled;
Mark Lobodzinski1ad14b42015-12-10 16:25:21 -0700297#endif
298#ifdef VK_USE_PLATFORM_XCB_KHR
Ian Elliott54cea232015-10-30 15:28:23 -0600299 bool wsi_xcb_surface_enabled;
Mark Lobodzinski1ad14b42015-12-10 16:25:21 -0700300#endif
301#ifdef VK_USE_PLATFORM_XLIB_KHR
Ian Elliott54cea232015-10-30 15:28:23 -0600302 bool wsi_xlib_surface_enabled;
Mark Lobodzinski1ad14b42015-12-10 16:25:21 -0700303#endif
304#ifdef VK_USE_PLATFORM_ANDROID_KHR
305 bool wsi_android_surface_enabled;
306#endif
Courtney Goeltzenleuchter67146d02015-06-10 17:39:03 -0600307};
308
Jon Ashburnfd02a0f2016-03-01 19:51:07 -0700309/* VkPhysicalDevice requires special treatment by loader. Firstly, terminator
310 * code must be able to get the struct loader_icd to call into the proper
311 * driver (multiple ICD/gpu case). This can be accomplished by wrapping the
312 * created VkPhysicalDevice in loader terminate_EnumeratePhysicalDevices().
313 * Secondly, loader must be able to find the instance and icd in trampoline
314 * code.
315 * Thirdly, the loader must be able to handle wrapped by layer VkPhysicalDevice
316 * in trampoline code. This implies, that the loader trampoline code must also
317 * wrap the VkPhysicalDevice object in trampoline code. Thus, loader has to
318 * wrap the VkPhysicalDevice created object twice. In trampoline code it can't
319 * rely on the terminator object wrapping since a layer may also wrap. Since
320 * trampoline code wraps the VkPhysicalDevice this means all loader trampoline
321 * code that passes a VkPhysicalDevice should unwrap it. */
322
323/* per enumerated PhysicalDevice structure, used to wrap in trampoline code and
324 also same structure used to wrap in terminator code */
Jon Ashburn969caa42015-11-01 14:04:06 -0700325struct loader_physical_device {
326 VkLayerInstanceDispatchTable *disp; // must be first entry in structure
Jon Ashburn969caa42015-11-01 14:04:06 -0700327 struct loader_icd *this_icd;
Jon Ashburnfd02a0f2016-03-01 19:51:07 -0700328 VkPhysicalDevice phys_dev; // object from ICD/layers/loader terminator
Jon Ashburn969caa42015-11-01 14:04:06 -0700329};
330
Jon Ashburn13482452015-05-12 17:26:48 -0600331struct loader_struct {
332 struct loader_instance *instances;
Courtney Goeltzenleuchter67146d02015-06-10 17:39:03 -0600333
334 unsigned int loaded_layer_lib_count;
Courtney Goeltzenleuchter452303a2015-10-07 09:00:34 -0600335 size_t loaded_layer_lib_capacity;
Courtney Goeltzenleuchter67146d02015-06-10 17:39:03 -0600336 struct loader_lib_info *loaded_layer_lib_list;
Jon Ashburne0367472015-08-18 18:04:47 -0600337 // TODO add ref counting of ICD libraries
Jon Ashburn269b5922015-07-06 15:40:35 -0600338 // TODO use this struct loader_layer_library_list scanned_layer_libraries;
Jon Ashburne0367472015-08-18 18:04:47 -0600339 // TODO add list of icd libraries for ref counting them for closure
Courtney Goeltzenleuchter67146d02015-06-10 17:39:03 -0600340};
341
342struct loader_scanned_icds {
343 char *lib_name;
344 loader_platform_dl_handle handle;
Jon Ashburn27109e82015-11-17 17:35:40 -0700345 uint32_t api_version;
Jon Ashburnc7ca48d2015-07-16 10:17:29 -0600346 PFN_vkGetInstanceProcAddr GetInstanceProcAddr;
Courtney Goeltzenleuchter67146d02015-06-10 17:39:03 -0600347 PFN_vkCreateInstance CreateInstance;
Jon Ashburn1c75aec2016-02-02 17:47:28 -0700348 PFN_vkEnumerateInstanceExtensionProperties
349 EnumerateInstanceExtensionProperties;
Jon Ashburn13482452015-05-12 17:26:48 -0600350};
351
Jon Ashburn399c9162015-07-02 09:40:15 -0600352static inline struct loader_instance *loader_instance(VkInstance instance) {
Jon Ashburn1c75aec2016-02-02 17:47:28 -0700353 return (struct loader_instance *)instance;
Jon Ashburn399c9162015-07-02 09:40:15 -0600354}
355
Jon Ashburnfd02a0f2016-03-01 19:51:07 -0700356static inline VkPhysicalDevice
357loader_unwrap_physical_device(VkPhysicalDevice physicalDevice) {
358 struct loader_physical_device *phys_dev =
359 (struct loader_physical_device *)physicalDevice;
360 return phys_dev->phys_dev;
361}
362
Jon Ashburn1c75aec2016-02-02 17:47:28 -0700363static inline void loader_set_dispatch(void *obj, const void *data) {
364 *((const void **)obj) = data;
Chia-I Wufe333ed2015-04-11 15:34:07 +0800365}
366
Jon Ashburn1c75aec2016-02-02 17:47:28 -0700367static inline VkLayerDispatchTable *loader_get_dispatch(const void *obj) {
368 return *((VkLayerDispatchTable **)obj);
Chia-I Wufe333ed2015-04-11 15:34:07 +0800369}
370
Jon Ashburn1c75aec2016-02-02 17:47:28 -0700371static inline struct loader_dev_dispatch_table *
372loader_get_dev_dispatch(const void *obj) {
373 return *((struct loader_dev_dispatch_table **)obj);
Jon Ashburn6cb69f42015-11-17 15:31:02 -0700374}
375
Jon Ashburn1c75aec2016-02-02 17:47:28 -0700376static inline VkLayerInstanceDispatchTable *
377loader_get_instance_dispatch(const void *obj) {
378 return *((VkLayerInstanceDispatchTable **)obj);
Jon Ashburn13482452015-05-12 17:26:48 -0600379}
380
Jon Ashburn1c75aec2016-02-02 17:47:28 -0700381static inline void loader_init_dispatch(void *obj, const void *data) {
Jon Ashburn167b2b12015-04-15 13:34:33 -0600382#ifdef DEBUG
Chia-I Wufe333ed2015-04-11 15:34:07 +0800383 assert(valid_loader_magic_value(obj) &&
Jon Ashburn1c75aec2016-02-02 17:47:28 -0700384 "Incompatible ICD, first dword must be initialized to "
385 "ICD_LOADER_MAGIC. See loader/README.md for details.");
Jon Ashburn167b2b12015-04-15 13:34:33 -0600386#endif
Chia-I Wufe333ed2015-04-11 15:34:07 +0800387
Jon Ashburn62a54d12015-05-01 18:00:33 -0600388 loader_set_dispatch(obj, data);
Chia-I Wufe333ed2015-04-11 15:34:07 +0800389}
390
Jon Ashburn13482452015-05-12 17:26:48 -0600391/* global variables used across files */
392extern struct loader_struct loader;
Jon Ashburnb4dee9c2015-08-28 15:19:27 -0600393extern THREAD_LOCAL_DECL struct loader_instance *tls_instance;
Jon Ashburne0367472015-08-18 18:04:47 -0600394extern LOADER_PLATFORM_THREAD_ONCE_DEFINITION(once_init);
Jon Ashburn7e8d8b42015-05-29 13:15:39 -0600395extern loader_platform_thread_mutex loader_lock;
Jon Ashburn7d4d51c2015-09-22 13:11:00 -0600396extern loader_platform_thread_mutex loader_json_lock;
Jon Ashburn7e8d8b42015-05-29 13:15:39 -0600397extern const VkLayerInstanceDispatchTable instance_disp;
Jon Ashburnd1eb3322016-02-10 20:59:26 -0700398extern const char *std_validation_str;
Jon Ashburn37e7f972015-04-06 10:58:22 -0600399
Courtney Goeltzenleuchter67146d02015-06-10 17:39:03 -0600400struct loader_msg_callback_map_entry {
Courtney Goeltzenleuchter725db942015-12-09 15:48:16 -0700401 VkDebugReportCallbackEXT icd_obj;
402 VkDebugReportCallbackEXT loader_obj;
Courtney Goeltzenleuchter67146d02015-06-10 17:39:03 -0600403};
404
Jon Ashburnc4e9ae62016-02-26 13:14:27 -0700405/* helper function definitions */
406void *loader_heap_alloc(const struct loader_instance *instance, size_t size,
407 VkSystemAllocationScope allocationScope);
408
409void loader_heap_free(const struct loader_instance *instance, void *pMemory);
410
411void *loader_tls_heap_alloc(size_t size);
412
413void loader_tls_heap_free(void *pMemory);
414
Jon Ashburn663f8312016-02-12 08:20:06 -0700415void loader_log(const struct loader_instance *inst, VkFlags msg_type,
Jon Ashburnc4e9ae62016-02-26 13:14:27 -0700416 int32_t msg_code, const char *format, ...);
Jon Ashburn663f8312016-02-12 08:20:06 -0700417
Jon Ashburn1c75aec2016-02-02 17:47:28 -0700418bool compare_vk_extension_properties(const VkExtensionProperties *op1,
419 const VkExtensionProperties *op2);
Courtney Goeltzenleuchter67146d02015-06-10 17:39:03 -0600420
Mark Lobodzinski8d325802016-02-02 18:53:34 -0700421VkResult loader_validate_layers(const struct loader_instance *inst,
422 const uint32_t layer_count,
Jon Ashburn1c75aec2016-02-02 17:47:28 -0700423 const char *const *ppEnabledLayerNames,
424 const struct loader_layer_list *list);
Courtney Goeltzenleuchter76ece702015-07-06 17:45:08 -0600425
426VkResult loader_validate_instance_extensions(
Mark Lobodzinski8d325802016-02-02 18:53:34 -0700427 const struct loader_instance *inst,
Jon Ashburn1c75aec2016-02-02 17:47:28 -0700428 const struct loader_extension_list *icd_exts,
429 const struct loader_layer_list *instance_layer,
430 const VkInstanceCreateInfo *pCreateInfo);
Courtney Goeltzenleuchter76ece702015-07-06 17:45:08 -0600431
Jon Ashburne0367472015-08-18 18:04:47 -0600432void loader_initialize(void);
Jon Ashburn1c75aec2016-02-02 17:47:28 -0700433bool has_vk_extension_property_array(const VkExtensionProperties *vk_ext_prop,
434 const uint32_t count,
435 const VkExtensionProperties *ext_array);
436bool has_vk_extension_property(const VkExtensionProperties *vk_ext_prop,
437 const struct loader_extension_list *ext_list);
Jon Ashburn13482452015-05-12 17:26:48 -0600438
Jon Ashburn1c75aec2016-02-02 17:47:28 -0700439VkResult loader_add_to_ext_list(const struct loader_instance *inst,
440 struct loader_extension_list *ext_list,
441 uint32_t prop_list_count,
442 const VkExtensionProperties *props);
Jon Ashburnc4e9ae62016-02-26 13:14:27 -0700443VkResult loader_add_device_extensions(const struct loader_instance *inst,
444 struct loader_icd *icd,
445 VkPhysicalDevice physical_device,
446 const char *lib_name,
447 struct loader_extension_list *ext_list);
448bool loader_init_generic_list(const struct loader_instance *inst,
449 struct loader_generic_list *list_info,
450 size_t element_size);
Jon Ashburn1c75aec2016-02-02 17:47:28 -0700451void loader_destroy_generic_list(const struct loader_instance *inst,
452 struct loader_generic_list *list);
Jon Ashburnc4e9ae62016-02-26 13:14:27 -0700453void loader_destroy_layer_list(const struct loader_instance *inst,
454 struct loader_layer_list *layer_list);
Jon Ashburn1c75aec2016-02-02 17:47:28 -0700455void loader_delete_layer_properties(const struct loader_instance *inst,
456 struct loader_layer_list *layer_list);
Jon Ashburnd1eb3322016-02-10 20:59:26 -0700457void loader_expand_layer_names(
458 const struct loader_instance *inst, const char *key_name,
459 uint32_t expand_count,
460 const char expand_names[][VK_MAX_EXTENSION_NAME_SIZE],
461 uint32_t *layer_count, char ***ppp_layer_names);
Jon Ashburn31efe262016-02-11 18:59:43 -0700462void loader_unexpand_dev_layer_names(const struct loader_instance *inst,
463 uint32_t layer_count, char **layer_names,
464 char **layer_ptr,
Jon Ashburnd1eb3322016-02-10 20:59:26 -0700465 const VkDeviceCreateInfo *pCreateInfo);
Jon Ashburn31efe262016-02-11 18:59:43 -0700466void loader_unexpand_inst_layer_names(const struct loader_instance *inst,
467 uint32_t layer_count, char **layer_names,
468 char **layer_ptr,
Jon Ashburnd1eb3322016-02-10 20:59:26 -0700469 const VkInstanceCreateInfo *pCreateInfo);
Jon Ashburn1c75aec2016-02-02 17:47:28 -0700470void loader_add_to_layer_list(const struct loader_instance *inst,
471 struct loader_layer_list *list,
472 uint32_t prop_list_count,
473 const struct loader_layer_properties *props);
474void loader_scanned_icd_clear(const struct loader_instance *inst,
475 struct loader_icd_libs *icd_libs);
476void loader_icd_scan(const struct loader_instance *inst,
477 struct loader_icd_libs *icds);
478void loader_layer_scan(const struct loader_instance *inst,
479 struct loader_layer_list *instance_layers,
480 struct loader_layer_list *device_layers);
Jon Ashburne0367472015-08-18 18:04:47 -0600481void loader_get_icd_loader_instance_extensions(
Jon Ashburn1c75aec2016-02-02 17:47:28 -0700482 const struct loader_instance *inst, struct loader_icd_libs *icd_libs,
483 struct loader_extension_list *inst_exts);
484struct loader_icd *loader_get_icd_and_device(const VkDevice device,
485 struct loader_device **found_dev);
Jon Ashburnc4e9ae62016-02-26 13:14:27 -0700486void loader_init_dispatch_dev_ext(struct loader_instance *inst,
487 struct loader_device *dev);
Jon Ashburn1c75aec2016-02-02 17:47:28 -0700488void *loader_dev_ext_gpa(struct loader_instance *inst, const char *funcName);
489void *loader_get_dev_ext_trampoline(uint32_t index);
490struct loader_instance *loader_get_instance(const VkInstance instance);
Jon Ashburnc4e9ae62016-02-26 13:14:27 -0700491struct loader_device *
492loader_add_logical_device(const struct loader_instance *inst,
493 struct loader_device **device_list);
Jon Ashburn1c75aec2016-02-02 17:47:28 -0700494void loader_remove_logical_device(const struct loader_instance *inst,
495 struct loader_icd *icd,
496 struct loader_device *found_dev);
497VkResult
498loader_enable_instance_layers(struct loader_instance *inst,
499 const VkInstanceCreateInfo *pCreateInfo,
500 const struct loader_layer_list *instance_layers);
Jon Ashburn10f4e822015-06-10 10:06:06 -0600501void loader_deactivate_instance_layers(struct loader_instance *instance);
Courtney Goeltzenleuchter0bd705c2016-01-08 12:18:43 -0700502
Jon Ashburn1c75aec2016-02-02 17:47:28 -0700503VkResult loader_create_instance_chain(const VkInstanceCreateInfo *pCreateInfo,
504 const VkAllocationCallbacks *pAllocator,
505 struct loader_instance *inst,
Jon Ashburnd1205a92016-02-03 12:37:30 -0700506 VkInstance *created_instance);
Courtney Goeltzenleuchter0bd705c2016-01-08 12:18:43 -0700507
Jon Ashburn1c75aec2016-02-02 17:47:28 -0700508void loader_activate_instance_layer_extensions(struct loader_instance *inst,
509 VkInstance created_inst);
Jon Ashburnc4e9ae62016-02-26 13:14:27 -0700510VkResult
511loader_enable_device_layers(const struct loader_instance *inst,
512 struct loader_icd *icd,
513 struct loader_layer_list *activated_layer_list,
514 const VkDeviceCreateInfo *pCreateInfo,
515 const struct loader_layer_list *device_layers);
Courtney Goeltzenleuchter71b454b2015-07-05 11:28:29 -0600516
Jon Ashburnfd02a0f2016-03-01 19:51:07 -0700517VkResult loader_create_device_chain(const struct loader_physical_device *pd,
Jon Ashburnc4e9ae62016-02-26 13:14:27 -0700518 const VkDeviceCreateInfo *pCreateInfo,
519 const VkAllocationCallbacks *pAllocator,
Jon Ashburnfd02a0f2016-03-01 19:51:07 -0700520 const struct loader_instance *inst,
Jon Ashburnc4e9ae62016-02-26 13:14:27 -0700521 struct loader_icd *icd,
522 struct loader_device *dev);
523VkResult loader_validate_device_extensions(
524 struct loader_physical_device *phys_dev,
525 const struct loader_layer_list *activated_device_layers,
Jon Ashburnfd02a0f2016-03-01 19:51:07 -0700526 const struct loader_extension_list *icd_exts,
Jon Ashburnc4e9ae62016-02-26 13:14:27 -0700527 const VkDeviceCreateInfo *pCreateInfo);
Courtney Goeltzenleuchter71b454b2015-07-05 11:28:29 -0600528
Jon Ashburnc4e9ae62016-02-26 13:14:27 -0700529/* instance layer chain termination entrypoint definitions */
530VKAPI_ATTR VkResult VKAPI_CALL
531terminator_CreateInstance(const VkInstanceCreateInfo *pCreateInfo,
532 const VkAllocationCallbacks *pAllocator,
533 VkInstance *pInstance);
Jon Ashburnb4dee9c2015-08-28 15:19:27 -0600534
Jon Ashburnc4e9ae62016-02-26 13:14:27 -0700535VKAPI_ATTR void VKAPI_CALL
536terminator_DestroyInstance(VkInstance instance,
537 const VkAllocationCallbacks *pAllocator);
Jon Ashburnb4dee9c2015-08-28 15:19:27 -0600538
Jon Ashburnc4e9ae62016-02-26 13:14:27 -0700539VKAPI_ATTR VkResult VKAPI_CALL
540terminator_EnumeratePhysicalDevices(VkInstance instance,
541 uint32_t *pPhysicalDeviceCount,
542 VkPhysicalDevice *pPhysicalDevices);
543
544VKAPI_ATTR void VKAPI_CALL
545terminator_GetPhysicalDeviceFeatures(VkPhysicalDevice physicalDevice,
546 VkPhysicalDeviceFeatures *pFeatures);
547
548VKAPI_ATTR void VKAPI_CALL
549terminator_GetPhysicalDeviceFormatProperties(VkPhysicalDevice physicalDevice,
550 VkFormat format,
551 VkFormatProperties *pFormatInfo);
552
553VKAPI_ATTR VkResult VKAPI_CALL
554terminator_GetPhysicalDeviceImageFormatProperties(
555 VkPhysicalDevice physicalDevice, VkFormat format, VkImageType type,
556 VkImageTiling tiling, VkImageUsageFlags usage, VkImageCreateFlags flags,
557 VkImageFormatProperties *pImageFormatProperties);
558
559VKAPI_ATTR void VKAPI_CALL
560terminator_GetPhysicalDeviceSparseImageFormatProperties(
561 VkPhysicalDevice physicalDevice, VkFormat format, VkImageType type,
562 VkSampleCountFlagBits samples, VkImageUsageFlags usage,
563 VkImageTiling tiling, uint32_t *pNumProperties,
564 VkSparseImageFormatProperties *pProperties);
565
566VKAPI_ATTR void VKAPI_CALL
567terminator_GetPhysicalDeviceProperties(VkPhysicalDevice physicalDevice,
568 VkPhysicalDeviceProperties *pProperties);
569
570VKAPI_ATTR VkResult VKAPI_CALL terminator_EnumerateDeviceExtensionProperties(
571 VkPhysicalDevice physicalDevice, const char *pLayerName, uint32_t *pCount,
572 VkExtensionProperties *pProperties);
573
574VKAPI_ATTR VkResult VKAPI_CALL
575terminator_EnumerateDeviceLayerProperties(VkPhysicalDevice physicalDevice,
576 uint32_t *pCount,
577 VkLayerProperties *pProperties);
578
579VKAPI_ATTR void VKAPI_CALL terminator_GetPhysicalDeviceQueueFamilyProperties(
580 VkPhysicalDevice physicalDevice, uint32_t *pCount,
581 VkQueueFamilyProperties *pProperties);
582
583VKAPI_ATTR void VKAPI_CALL terminator_GetPhysicalDeviceMemoryProperties(
584 VkPhysicalDevice physicalDevice,
585 VkPhysicalDeviceMemoryProperties *pProperties);
586
587VKAPI_ATTR VkResult VKAPI_CALL
588terminator_CreateDevice(VkPhysicalDevice gpu,
589 const VkDeviceCreateInfo *pCreateInfo,
590 const VkAllocationCallbacks *pAllocator,
591 VkDevice *pDevice);
Mark Lobodzinski8d325802016-02-02 18:53:34 -0700592
Jon Ashburnb1cdf2e2016-02-10 20:50:19 -0700593VkStringErrorFlags vk_string_validate(const int max_length,
594 const char *char_array);
Mark Lobodzinski8d325802016-02-02 18:53:34 -0700595
Chia-I Wuc1e0f962014-08-04 08:03:57 +0800596#endif /* LOADER_H */