blob: 95803c0137c2f901cc81c37cb64b25f01d7de397 [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 Ashburn4f80d672016-04-19 11:30:31 -06008 * Licensed under the Apache License, Version 2.0 (the "License");
9 * you may not use this file except in compliance with the License.
10 * You may obtain a copy of the License at
Chia-I Wuc1e0f962014-08-04 08:03:57 +080011 *
Jon Ashburn4f80d672016-04-19 11:30:31 -060012 * http://www.apache.org/licenses/LICENSE-2.0
Chia-I Wuc1e0f962014-08-04 08:03:57 +080013 *
Jon Ashburn4f80d672016-04-19 11:30:31 -060014 * Unless required by applicable law or agreed to in writing, software
15 * distributed under the License is distributed on an "AS IS" BASIS,
16 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
17 * See the License for the specific language governing permissions and
18 * limitations under the License.
Jon Ashburn1c75aec2016-02-02 17:47:28 -070019 *
20 * Author: Jon Ashburn <jon@lunarg.com>
21 * Author: Courtney Goeltzenleuchter <courtney@LunarG.com>
Courtney Goeltzenleuchterb9ce3952015-10-30 11:14:30 -060022 * Author: Chia-I Wu <olvaffe@gmail.com>
23 * Author: Chia-I Wu <olv@lunarg.com>
Jon Ashburn1c75aec2016-02-02 17:47:28 -070024 * Author: Mark Lobodzinski <mark@LunarG.com>
Courtney Goeltzenleuchterb9ce3952015-10-30 11:14:30 -060025 *
Chia-I Wuc1e0f962014-08-04 08:03:57 +080026 */
27
28#ifndef LOADER_H
29#define LOADER_H
30
David Pinedoa5036622015-11-06 12:54:48 -070031#include <vulkan/vulkan.h>
Aaron Karp95c5f952016-03-13 16:41:59 -040032#include "vk_loader_platform.h"
Ian Elliottafaf1852015-11-17 17:29:40 -070033
David Pinedoa5036622015-11-06 12:54:48 -070034#include <vulkan/vk_layer.h>
35#include <vulkan/vk_icd.h>
Chia-I Wufe333ed2015-04-11 15:34:07 +080036#include <assert.h>
37
Chia-I Wuc1e0f962014-08-04 08:03:57 +080038#if defined(__GNUC__) && __GNUC__ >= 4
Jon Ashburn1c75aec2016-02-02 17:47:28 -070039#define LOADER_EXPORT __attribute__((visibility("default")))
Chia-I Wuc1e0f962014-08-04 08:03:57 +080040#elif defined(__SUNPRO_C) && (__SUNPRO_C >= 0x590)
Jon Ashburn1c75aec2016-02-02 17:47:28 -070041#define LOADER_EXPORT __attribute__((visibility("default")))
Chia-I Wuc1e0f962014-08-04 08:03:57 +080042#else
Jon Ashburn1c75aec2016-02-02 17:47:28 -070043#define LOADER_EXPORT
Chia-I Wuc1e0f962014-08-04 08:03:57 +080044#endif
45
Jon Ashburnb2379c52015-08-04 10:22:33 -060046#define MAX_STRING_SIZE 1024
Courtney Goeltzenleuchter44667cc2015-06-29 15:39:26 -060047#define VK_MAJOR(version) (version >> 22)
48#define VK_MINOR(version) ((version >> 12) & 0x3ff)
49#define VK_PATCH(version) (version & 0xfff)
Jon Ashburn13482452015-05-12 17:26:48 -060050
Jon Ashburn399c9162015-07-02 09:40:15 -060051enum layer_type {
Jon Ashburnc325bc02016-05-16 14:01:18 -060052 VK_LAYER_TYPE_INSTANCE_EXPLICIT = 0x1,
53 VK_LAYER_TYPE_INSTANCE_IMPLICIT = 0x2,
54 VK_LAYER_TYPE_META_EXPLICT = 0x4,
Jon Ashburn399c9162015-07-02 09:40:15 -060055};
56
Mark Lobodzinski8d325802016-02-02 18:53:34 -070057typedef enum VkStringErrorFlagBits {
Jon Ashburnb1cdf2e2016-02-10 20:50:19 -070058 VK_STRING_ERROR_NONE = 0x00000000,
59 VK_STRING_ERROR_LENGTH = 0x00000001,
60 VK_STRING_ERROR_BAD_DATA = 0x00000002,
Mark Lobodzinski8d325802016-02-02 18:53:34 -070061} VkStringErrorFlagBits;
62typedef VkFlags VkStringErrorFlags;
63
Jon Ashburnb1cdf2e2016-02-10 20:50:19 -070064static const int MaxLoaderStringLength = 256;
65static const char UTF8_ONE_BYTE_CODE = 0xC0;
66static const char UTF8_ONE_BYTE_MASK = 0xE0;
67static const char UTF8_TWO_BYTE_CODE = 0xE0;
68static const char UTF8_TWO_BYTE_MASK = 0xF0;
69static const char UTF8_THREE_BYTE_CODE = 0xF0;
70static const char UTF8_THREE_BYTE_MASK = 0xF8;
71static const char UTF8_DATA_BYTE_CODE = 0x80;
72static const char UTF8_DATA_BYTE_MASK = 0xC0;
Mark Lobodzinski8d325802016-02-02 18:53:34 -070073
Mark Lobodzinskib0123ea2016-03-15 17:23:12 -060074static const char std_validation_names[8][VK_MAX_EXTENSION_NAME_SIZE] = {
Jon Ashburnc466da52016-04-15 09:25:03 -060075 "VK_LAYER_GOOGLE_threading", "VK_LAYER_LUNARG_parameter_validation",
Jon Ashburnd1eb3322016-02-10 20:59:26 -070076 "VK_LAYER_LUNARG_device_limits", "VK_LAYER_LUNARG_object_tracker",
Jon Ashburnc466da52016-04-15 09:25:03 -060077 "VK_LAYER_LUNARG_image", "VK_LAYER_LUNARG_core_validation",
78 "VK_LAYER_LUNARG_swapchain", "VK_LAYER_GOOGLE_unique_objects"};
Jon Ashburnd1eb3322016-02-10 20:59:26 -070079
Jon Ashburn6b00b472015-12-10 08:51:10 -070080// form of all dynamic lists/arrays
81// only the list element should be changed
82struct loader_generic_list {
83 size_t capacity;
84 uint32_t count;
85 void *list;
86};
87
Courtney Goeltzenleuchter67146d02015-06-10 17:39:03 -060088struct loader_extension_list {
89 size_t capacity;
90 uint32_t count;
Jon Ashburnb7d327c2015-08-04 11:14:18 -060091 VkExtensionProperties *list;
Courtney Goeltzenleuchter67146d02015-06-10 17:39:03 -060092};
93
Jon Ashburn92cdb012015-12-10 18:17:34 -070094struct loader_dev_ext_props {
95 VkExtensionProperties props;
96 uint32_t entrypoint_count;
97 char **entrypoints;
98};
99
100struct loader_device_extension_list {
101 size_t capacity;
102 uint32_t count;
103 struct loader_dev_ext_props *list;
104};
105
Jon Ashburn399c9162015-07-02 09:40:15 -0600106struct loader_name_value {
Jon Ashburnb2379c52015-08-04 10:22:33 -0600107 char name[MAX_STRING_SIZE];
108 char value[MAX_STRING_SIZE];
Jon Ashburn399c9162015-07-02 09:40:15 -0600109};
110
Jon Ashburn399c9162015-07-02 09:40:15 -0600111struct loader_layer_functions {
Jon Ashburnb2379c52015-08-04 10:22:33 -0600112 char str_gipa[MAX_STRING_SIZE];
113 char str_gdpa[MAX_STRING_SIZE];
Jon Ashburn399c9162015-07-02 09:40:15 -0600114 PFN_vkGetInstanceProcAddr get_instance_proc_addr;
115 PFN_vkGetDeviceProcAddr get_device_proc_addr;
116};
Courtney Goeltzenleuchter67146d02015-06-10 17:39:03 -0600117
Jon Ashburn399c9162015-07-02 09:40:15 -0600118struct loader_layer_properties {
Courtney Goeltzenleuchter44667cc2015-06-29 15:39:26 -0600119 VkLayerProperties info;
Jon Ashburn399c9162015-07-02 09:40:15 -0600120 enum layer_type type;
Jon Ashburnb4c24232015-08-20 16:35:30 -0600121 char lib_name[MAX_STRING_SIZE];
Jon Ashburnd3cf9552016-04-20 13:21:17 -0600122 loader_platform_dl_handle lib_handle;
Jon Ashburn399c9162015-07-02 09:40:15 -0600123 struct loader_layer_functions functions;
124 struct loader_extension_list instance_extension_list;
Jon Ashburn92cdb012015-12-10 18:17:34 -0700125 struct loader_device_extension_list device_extension_list;
Jon Ashburn399c9162015-07-02 09:40:15 -0600126 struct loader_name_value disable_env_var;
127 struct loader_name_value enable_env_var;
128};
129
130struct loader_layer_list {
131 size_t capacity;
132 uint32_t count;
133 struct loader_layer_properties *list;
Jon Ashburn13482452015-05-12 17:26:48 -0600134};
135
Jon Ashburn6cb69f42015-11-17 15:31:02 -0700136struct loader_dispatch_hash_list {
137 size_t capacity;
138 uint32_t count;
Jon Ashburn1c75aec2016-02-02 17:47:28 -0700139 uint32_t *index; // index into the dev_ext dispatch table
Jon Ashburn6cb69f42015-11-17 15:31:02 -0700140};
141
142#define MAX_NUM_DEV_EXTS 250
Jon Ashburn1c75aec2016-02-02 17:47:28 -0700143// loader_dispatch_hash_entry and loader_dev_ext_dispatch_table.DevExt have one
144// to one
Jon Ashburn6cb69f42015-11-17 15:31:02 -0700145// correspondence; one loader_dispatch_hash_entry for one DevExt dispatch entry.
146// Also have a one to one correspondence with functions in dev_ext_trampoline.c
147struct loader_dispatch_hash_entry {
148 char *func_name;
Jon Ashburn1c75aec2016-02-02 17:47:28 -0700149 struct loader_dispatch_hash_list list; // to handle hashing collisions
Jon Ashburn6cb69f42015-11-17 15:31:02 -0700150};
151
Jon Ashburn1c75aec2016-02-02 17:47:28 -0700152typedef void(VKAPI_PTR *PFN_vkDevExt)(VkDevice device);
Jon Ashburn6cb69f42015-11-17 15:31:02 -0700153struct loader_dev_ext_dispatch_table {
154 PFN_vkDevExt DevExt[MAX_NUM_DEV_EXTS];
155};
156
157struct loader_dev_dispatch_table {
158 VkLayerDispatchTable core_dispatch;
159 struct loader_dev_ext_dispatch_table ext_dispatch;
160};
161
Jon Ashburn10f4e822015-06-10 10:06:06 -0600162/* per CreateDevice structure */
163struct loader_device {
Jon Ashburn6cb69f42015-11-17 15:31:02 -0700164 struct loader_dev_dispatch_table loader_dispatch;
Jon Ashburn1c75aec2016-02-02 17:47:28 -0700165 VkDevice device; // device object from the icd
Jon Ashburn10f4e822015-06-10 10:06:06 -0600166
Jon Ashburn1c75aec2016-02-02 17:47:28 -0700167 uint32_t app_extension_count;
Jon Ashburn10f4e822015-06-10 10:06:06 -0600168 VkExtensionProperties *app_extension_props;
169
Courtney Goeltzenleuchter44667cc2015-06-29 15:39:26 -0600170 struct loader_layer_list activated_layer_list;
Jon Ashburn10f4e822015-06-10 10:06:06 -0600171
172 struct loader_device *next;
173};
174
Jon Ashburn392c5622015-06-10 16:11:42 -0600175/* per ICD structure */
Jon Ashburnebfa25e2015-05-15 15:09:35 -0600176struct loader_icd {
Jon Ashburnb4c24232015-08-20 16:35:30 -0600177 // pointers to find other structs
178 const struct loader_scanned_icds *this_icd_lib;
179 const struct loader_instance *this_instance;
Jon Ashburn10f4e822015-06-10 10:06:06 -0600180 struct loader_device *logical_device_list;
Jon Ashburn1c75aec2016-02-02 17:47:28 -0700181 VkInstance instance; // instance object from the icd
Jon Ashburnc89dd4a2015-05-18 13:20:15 -0600182 PFN_vkGetDeviceProcAddr GetDeviceProcAddr;
Jon Ashburnebfa25e2015-05-15 15:09:35 -0600183 PFN_vkDestroyInstance DestroyInstance;
184 PFN_vkEnumeratePhysicalDevices EnumeratePhysicalDevices;
Chris Forbes1c946ec2015-06-21 22:55:02 +1200185 PFN_vkGetPhysicalDeviceFeatures GetPhysicalDeviceFeatures;
Courtney Goeltzenleuchter2b6559e2015-07-12 12:52:09 -0600186 PFN_vkGetPhysicalDeviceFormatProperties GetPhysicalDeviceFormatProperties;
Jon Ashburn1c75aec2016-02-02 17:47:28 -0700187 PFN_vkGetPhysicalDeviceImageFormatProperties
188 GetPhysicalDeviceImageFormatProperties;
Jon Ashburnebfa25e2015-05-15 15:09:35 -0600189 PFN_vkCreateDevice CreateDevice;
Tony Barbour4e657ba2015-06-24 16:06:58 -0600190 PFN_vkGetPhysicalDeviceProperties GetPhysicalDeviceProperties;
Jon Ashburn1c75aec2016-02-02 17:47:28 -0700191 PFN_vkGetPhysicalDeviceQueueFamilyProperties
192 GetPhysicalDeviceQueueFamilyProperties;
Tony Barbour4e657ba2015-06-24 16:06:58 -0600193 PFN_vkGetPhysicalDeviceMemoryProperties GetPhysicalDeviceMemoryProperties;
Courtney Goeltzenleuchtere25064c2015-09-14 17:22:16 -0600194 PFN_vkEnumerateDeviceExtensionProperties EnumerateDeviceExtensionProperties;
Jon Ashburn1c75aec2016-02-02 17:47:28 -0700195 PFN_vkGetPhysicalDeviceSparseImageFormatProperties
196 GetPhysicalDeviceSparseImageFormatProperties;
Courtney Goeltzenleuchter725db942015-12-09 15:48:16 -0700197 PFN_vkCreateDebugReportCallbackEXT CreateDebugReportCallbackEXT;
198 PFN_vkDestroyDebugReportCallbackEXT DestroyDebugReportCallbackEXT;
199 PFN_vkDebugReportMessageEXT DebugReportMessageEXT;
Ian Elliottec736342015-08-21 15:09:33 -0600200 PFN_vkGetPhysicalDeviceSurfaceSupportKHR GetPhysicalDeviceSurfaceSupportKHR;
Jon Ashburn1c75aec2016-02-02 17:47:28 -0700201 PFN_vkGetPhysicalDeviceSurfaceCapabilitiesKHR
202 GetPhysicalDeviceSurfaceCapabilitiesKHR;
Ian Elliottea666b22015-11-19 16:05:09 -0700203 PFN_vkGetPhysicalDeviceSurfaceFormatsKHR GetPhysicalDeviceSurfaceFormatsKHR;
Jon Ashburn1c75aec2016-02-02 17:47:28 -0700204 PFN_vkGetPhysicalDeviceSurfacePresentModesKHR
205 GetPhysicalDeviceSurfacePresentModesKHR;
Ian Elliotte851dd62015-11-24 15:39:10 -0700206#ifdef VK_USE_PLATFORM_WIN32_KHR
Jon Ashburn1c75aec2016-02-02 17:47:28 -0700207 PFN_vkGetPhysicalDeviceWin32PresentationSupportKHR
208 GetPhysicalDeviceWin32PresentationSupportKHR;
Ian Elliotte851dd62015-11-24 15:39:10 -0700209#endif
210#ifdef VK_USE_PLATFORM_MIR_KHR
Jon Ashburn1c75aec2016-02-02 17:47:28 -0700211 PFN_vkGetPhysicalDeviceMirPresentationSupportKHR
212 GetPhysicalDeviceMirPresentvationSupportKHR;
Ian Elliotte851dd62015-11-24 15:39:10 -0700213#endif
214#ifdef VK_USE_PLATFORM_WAYLAND_KHR
Jon Ashburn1c75aec2016-02-02 17:47:28 -0700215 PFN_vkGetPhysicalDeviceWaylandPresentationSupportKHR
216 GetPhysicalDeviceWaylandPresentationSupportKHR;
Ian Elliotte851dd62015-11-24 15:39:10 -0700217#endif
218#ifdef VK_USE_PLATFORM_XCB_KHR
Jon Ashburn1c75aec2016-02-02 17:47:28 -0700219 PFN_vkGetPhysicalDeviceXcbPresentationSupportKHR
220 GetPhysicalDeviceXcbPresentationSupportKHR;
Ian Elliotte851dd62015-11-24 15:39:10 -0700221#endif
222#ifdef VK_USE_PLATFORM_XLIB_KHR
Jon Ashburn1c75aec2016-02-02 17:47:28 -0700223 PFN_vkGetPhysicalDeviceXlibPresentationSupportKHR
224 GetPhysicalDeviceXlibPresentationSupportKHR;
Ian Elliotte851dd62015-11-24 15:39:10 -0700225#endif
Jon Ashburncc370d02016-03-08 09:30:30 -0700226 PFN_vkGetPhysicalDeviceDisplayPropertiesKHR
227 GetPhysicalDeviceDisplayPropertiesKHR;
228 PFN_vkGetPhysicalDeviceDisplayPlanePropertiesKHR
229 GetPhysicalDeviceDisplayPlanePropertiesKHR;
230 PFN_vkGetDisplayPlaneSupportedDisplaysKHR
231 GetDisplayPlaneSupportedDisplaysKHR;
Jon Ashburnc466da52016-04-15 09:25:03 -0600232 PFN_vkGetDisplayModePropertiesKHR GetDisplayModePropertiesKHR;
233 PFN_vkCreateDisplayModeKHR CreateDisplayModeKHR;
234 PFN_vkGetDisplayPlaneCapabilitiesKHR GetDisplayPlaneCapabilitiesKHR;
235 PFN_vkCreateDisplayPlaneSurfaceKHR CreateDisplayPlaneSurfaceKHR;
236 PFN_vkDestroySurfaceKHR DestroySurfaceKHR;
Jon Ashburn10f4e822015-06-10 10:06:06 -0600237 struct loader_icd *next;
Jon Ashburnebfa25e2015-05-15 15:09:35 -0600238};
239
Jon Ashburne0367472015-08-18 18:04:47 -0600240/* per ICD library structure */
241struct loader_icd_libs {
242 size_t capacity;
243 uint32_t count;
244 struct loader_scanned_icds *list;
245};
246
Jon Ashburn392c5622015-06-10 16:11:42 -0600247/* per instance structure */
Jon Ashburn13482452015-05-12 17:26:48 -0600248struct loader_instance {
Jon Ashburnebfa25e2015-05-15 15:09:35 -0600249 VkLayerInstanceDispatchTable *disp; // must be first entry in structure
250
Jon Ashburnfd02a0f2016-03-01 19:51:07 -0700251 uint32_t total_gpu_count; // count of the next two arrays
252 struct loader_physical_device *phys_devs_term;
Jon Ashburnc466da52016-04-15 09:25:03 -0600253 struct loader_physical_device_tramp *
254 phys_devs; // tramp wrapped physDev obj list
Courtney Goeltzenleuchter67146d02015-06-10 17:39:03 -0600255 uint32_t total_icd_count;
Jon Ashburn13482452015-05-12 17:26:48 -0600256 struct loader_icd *icds;
257 struct loader_instance *next;
Jon Ashburn1c75aec2016-02-02 17:47:28 -0700258 struct loader_extension_list ext_list; // icds and loaders extensions
Jon Ashburne0367472015-08-18 18:04:47 -0600259 struct loader_icd_libs icd_libs;
Jon Ashburnb4c24232015-08-20 16:35:30 -0600260 struct loader_layer_list instance_layer_list;
Jon Ashburn6cb69f42015-11-17 15:31:02 -0700261 struct loader_dispatch_hash_entry disp_hash[MAX_NUM_DEV_EXTS];
Jon Ashburnb4c24232015-08-20 16:35:30 -0600262
Courtney Goeltzenleuchter67146d02015-06-10 17:39:03 -0600263 struct loader_msg_callback_map_entry *icd_msg_callback_map;
264
Courtney Goeltzenleuchter44667cc2015-06-29 15:39:26 -0600265 struct loader_layer_list activated_layer_list;
Jon Ashburnc325bc02016-05-16 14:01:18 -0600266 bool activated_layers_are_std_val;
Jon Ashburnc466da52016-04-15 09:25:03 -0600267 VkInstance instance; // layers/ICD instance returned to trampoline
Courtney Goeltzenleuchter0bd705c2016-01-08 12:18:43 -0700268
Courtney Goeltzenleuchter67146d02015-06-10 17:39:03 -0600269 bool debug_report_enabled;
Courtney Goeltzenleuchter67146d02015-06-10 17:39:03 -0600270 VkLayerDbgFunctionNode *DbgFunctionHead;
Ian Elliottdefd6da2016-03-31 10:48:19 -0600271 uint32_t num_tmp_callbacks;
272 VkDebugReportCallbackCreateInfoEXT *tmp_dbg_create_infos;
273 VkDebugReportCallbackEXT *tmp_callbacks;
Courtney Goeltzenleuchter71b454b2015-07-05 11:28:29 -0600274
Chia-I Wu227c8b32015-10-27 18:04:07 +0800275 VkAllocationCallbacks alloc_callbacks;
Ian Elliotted33eb72015-07-06 14:36:13 -0600276
Ian Elliott54cea232015-10-30 15:28:23 -0600277 bool wsi_surface_enabled;
Mark Lobodzinski1ad14b42015-12-10 16:25:21 -0700278#ifdef VK_USE_PLATFORM_WIN32_KHR
Ian Elliott54cea232015-10-30 15:28:23 -0600279 bool wsi_win32_surface_enabled;
Mark Lobodzinski1ad14b42015-12-10 16:25:21 -0700280#endif
281#ifdef VK_USE_PLATFORM_MIR_KHR
Ian Elliott54cea232015-10-30 15:28:23 -0600282 bool wsi_mir_surface_enabled;
Mark Lobodzinski1ad14b42015-12-10 16:25:21 -0700283#endif
284#ifdef VK_USE_PLATFORM_WAYLAND_KHR
Ian Elliott54cea232015-10-30 15:28:23 -0600285 bool wsi_wayland_surface_enabled;
Mark Lobodzinski1ad14b42015-12-10 16:25:21 -0700286#endif
287#ifdef VK_USE_PLATFORM_XCB_KHR
Ian Elliott54cea232015-10-30 15:28:23 -0600288 bool wsi_xcb_surface_enabled;
Mark Lobodzinski1ad14b42015-12-10 16:25:21 -0700289#endif
290#ifdef VK_USE_PLATFORM_XLIB_KHR
Ian Elliott54cea232015-10-30 15:28:23 -0600291 bool wsi_xlib_surface_enabled;
Mark Lobodzinski1ad14b42015-12-10 16:25:21 -0700292#endif
293#ifdef VK_USE_PLATFORM_ANDROID_KHR
294 bool wsi_android_surface_enabled;
295#endif
Jon Ashburncc370d02016-03-08 09:30:30 -0700296 bool wsi_display_enabled;
Courtney Goeltzenleuchter67146d02015-06-10 17:39:03 -0600297};
298
Jon Ashburnfd02a0f2016-03-01 19:51:07 -0700299/* VkPhysicalDevice requires special treatment by loader. Firstly, terminator
300 * code must be able to get the struct loader_icd to call into the proper
301 * driver (multiple ICD/gpu case). This can be accomplished by wrapping the
302 * created VkPhysicalDevice in loader terminate_EnumeratePhysicalDevices().
Piers Daniell82107a62016-03-29 11:51:11 -0600303 * Secondly, the loader must be able to handle wrapped by layer VkPhysicalDevice
Jon Ashburnfd02a0f2016-03-01 19:51:07 -0700304 * in trampoline code. This implies, that the loader trampoline code must also
305 * wrap the VkPhysicalDevice object in trampoline code. Thus, loader has to
306 * wrap the VkPhysicalDevice created object twice. In trampoline code it can't
307 * rely on the terminator object wrapping since a layer may also wrap. Since
308 * trampoline code wraps the VkPhysicalDevice this means all loader trampoline
309 * code that passes a VkPhysicalDevice should unwrap it. */
310
311/* per enumerated PhysicalDevice structure, used to wrap in trampoline code and
312 also same structure used to wrap in terminator code */
Jon Ashburnc3519e42016-03-24 15:49:57 -0600313struct loader_physical_device_tramp {
314 VkLayerInstanceDispatchTable *disp; // must be first entry in structure
Piers Daniell82107a62016-03-29 11:51:11 -0600315 struct loader_instance *this_instance;
Jon Ashburnc466da52016-04-15 09:25:03 -0600316 VkPhysicalDevice phys_dev; // object from layers/loader terminator
Jon Ashburnc3519e42016-03-24 15:49:57 -0600317};
318
319/* per enumerated PhysicalDevice structure, used to wrap in terminator code */
Jon Ashburn969caa42015-11-01 14:04:06 -0700320struct loader_physical_device {
321 VkLayerInstanceDispatchTable *disp; // must be first entry in structure
Jon Ashburn969caa42015-11-01 14:04:06 -0700322 struct loader_icd *this_icd;
Jon Ashburnc3519e42016-03-24 15:49:57 -0600323 VkPhysicalDevice phys_dev; // object from ICD
Jon Ashburn969caa42015-11-01 14:04:06 -0700324};
325
Jon Ashburn13482452015-05-12 17:26:48 -0600326struct loader_struct {
327 struct loader_instance *instances;
Courtney Goeltzenleuchter67146d02015-06-10 17:39:03 -0600328};
329
330struct loader_scanned_icds {
331 char *lib_name;
332 loader_platform_dl_handle handle;
Jon Ashburn27109e82015-11-17 17:35:40 -0700333 uint32_t api_version;
Jon Ashburn68b06d62016-04-25 11:09:37 -0600334 uint32_t interface_version;
Jon Ashburnc7ca48d2015-07-16 10:17:29 -0600335 PFN_vkGetInstanceProcAddr GetInstanceProcAddr;
Courtney Goeltzenleuchter67146d02015-06-10 17:39:03 -0600336 PFN_vkCreateInstance CreateInstance;
Jon Ashburn1c75aec2016-02-02 17:47:28 -0700337 PFN_vkEnumerateInstanceExtensionProperties
338 EnumerateInstanceExtensionProperties;
Jon Ashburn13482452015-05-12 17:26:48 -0600339};
340
Jon Ashburn399c9162015-07-02 09:40:15 -0600341static inline struct loader_instance *loader_instance(VkInstance instance) {
Jon Ashburn1c75aec2016-02-02 17:47:28 -0700342 return (struct loader_instance *)instance;
Jon Ashburn399c9162015-07-02 09:40:15 -0600343}
344
Jon Ashburnfd02a0f2016-03-01 19:51:07 -0700345static inline VkPhysicalDevice
346loader_unwrap_physical_device(VkPhysicalDevice physicalDevice) {
Piers Daniella9ccaed2016-03-31 14:47:57 -0600347 struct loader_physical_device_tramp *phys_dev =
348 (struct loader_physical_device_tramp *)physicalDevice;
Jon Ashburnfd02a0f2016-03-01 19:51:07 -0700349 return phys_dev->phys_dev;
350}
351
Jon Ashburn1c75aec2016-02-02 17:47:28 -0700352static inline void loader_set_dispatch(void *obj, const void *data) {
353 *((const void **)obj) = data;
Chia-I Wufe333ed2015-04-11 15:34:07 +0800354}
355
Jon Ashburn1c75aec2016-02-02 17:47:28 -0700356static inline VkLayerDispatchTable *loader_get_dispatch(const void *obj) {
357 return *((VkLayerDispatchTable **)obj);
Chia-I Wufe333ed2015-04-11 15:34:07 +0800358}
359
Jon Ashburn1c75aec2016-02-02 17:47:28 -0700360static inline struct loader_dev_dispatch_table *
361loader_get_dev_dispatch(const void *obj) {
362 return *((struct loader_dev_dispatch_table **)obj);
Jon Ashburn6cb69f42015-11-17 15:31:02 -0700363}
364
Jon Ashburn1c75aec2016-02-02 17:47:28 -0700365static inline VkLayerInstanceDispatchTable *
366loader_get_instance_dispatch(const void *obj) {
367 return *((VkLayerInstanceDispatchTable **)obj);
Jon Ashburn13482452015-05-12 17:26:48 -0600368}
369
Jon Ashburn1c75aec2016-02-02 17:47:28 -0700370static inline void loader_init_dispatch(void *obj, const void *data) {
Jon Ashburn167b2b12015-04-15 13:34:33 -0600371#ifdef DEBUG
Chia-I Wufe333ed2015-04-11 15:34:07 +0800372 assert(valid_loader_magic_value(obj) &&
Jon Ashburn1c75aec2016-02-02 17:47:28 -0700373 "Incompatible ICD, first dword must be initialized to "
374 "ICD_LOADER_MAGIC. See loader/README.md for details.");
Jon Ashburn167b2b12015-04-15 13:34:33 -0600375#endif
Chia-I Wufe333ed2015-04-11 15:34:07 +0800376
Jon Ashburn62a54d12015-05-01 18:00:33 -0600377 loader_set_dispatch(obj, data);
Chia-I Wufe333ed2015-04-11 15:34:07 +0800378}
379
Jon Ashburn13482452015-05-12 17:26:48 -0600380/* global variables used across files */
381extern struct loader_struct loader;
Jon Ashburnb4dee9c2015-08-28 15:19:27 -0600382extern THREAD_LOCAL_DECL struct loader_instance *tls_instance;
Jon Ashburne0367472015-08-18 18:04:47 -0600383extern LOADER_PLATFORM_THREAD_ONCE_DEFINITION(once_init);
Jon Ashburn7e8d8b42015-05-29 13:15:39 -0600384extern loader_platform_thread_mutex loader_lock;
Jon Ashburn7d4d51c2015-09-22 13:11:00 -0600385extern loader_platform_thread_mutex loader_json_lock;
Jon Ashburn7e8d8b42015-05-29 13:15:39 -0600386extern const VkLayerInstanceDispatchTable instance_disp;
Jon Ashburnd1eb3322016-02-10 20:59:26 -0700387extern const char *std_validation_str;
Jon Ashburn37e7f972015-04-06 10:58:22 -0600388
Courtney Goeltzenleuchter67146d02015-06-10 17:39:03 -0600389struct loader_msg_callback_map_entry {
Courtney Goeltzenleuchter725db942015-12-09 15:48:16 -0700390 VkDebugReportCallbackEXT icd_obj;
391 VkDebugReportCallbackEXT loader_obj;
Courtney Goeltzenleuchter67146d02015-06-10 17:39:03 -0600392};
393
Jon Ashburnc4e9ae62016-02-26 13:14:27 -0700394/* helper function definitions */
395void *loader_heap_alloc(const struct loader_instance *instance, size_t size,
396 VkSystemAllocationScope allocationScope);
397
398void loader_heap_free(const struct loader_instance *instance, void *pMemory);
399
400void *loader_tls_heap_alloc(size_t size);
401
402void loader_tls_heap_free(void *pMemory);
403
Jon Ashburn663f8312016-02-12 08:20:06 -0700404void loader_log(const struct loader_instance *inst, VkFlags msg_type,
Jon Ashburnc4e9ae62016-02-26 13:14:27 -0700405 int32_t msg_code, const char *format, ...);
Jon Ashburn663f8312016-02-12 08:20:06 -0700406
Jon Ashburn1c75aec2016-02-02 17:47:28 -0700407bool compare_vk_extension_properties(const VkExtensionProperties *op1,
408 const VkExtensionProperties *op2);
Courtney Goeltzenleuchter67146d02015-06-10 17:39:03 -0600409
Mark Lobodzinski8d325802016-02-02 18:53:34 -0700410VkResult loader_validate_layers(const struct loader_instance *inst,
411 const uint32_t layer_count,
Jon Ashburn1c75aec2016-02-02 17:47:28 -0700412 const char *const *ppEnabledLayerNames,
413 const struct loader_layer_list *list);
Courtney Goeltzenleuchter76ece702015-07-06 17:45:08 -0600414
415VkResult loader_validate_instance_extensions(
Mark Lobodzinski8d325802016-02-02 18:53:34 -0700416 const struct loader_instance *inst,
Jon Ashburn1c75aec2016-02-02 17:47:28 -0700417 const struct loader_extension_list *icd_exts,
418 const struct loader_layer_list *instance_layer,
419 const VkInstanceCreateInfo *pCreateInfo);
Courtney Goeltzenleuchter76ece702015-07-06 17:45:08 -0600420
Jon Ashburne0367472015-08-18 18:04:47 -0600421void loader_initialize(void);
Jon Ashburnc325bc02016-05-16 14:01:18 -0600422void loader_copy_layer_properties(const struct loader_instance *inst,
423 struct loader_layer_properties *dst,
424 struct loader_layer_properties *src);
Jon Ashburn1c75aec2016-02-02 17:47:28 -0700425bool has_vk_extension_property_array(const VkExtensionProperties *vk_ext_prop,
426 const uint32_t count,
427 const VkExtensionProperties *ext_array);
428bool has_vk_extension_property(const VkExtensionProperties *vk_ext_prop,
429 const struct loader_extension_list *ext_list);
Jon Ashburn13482452015-05-12 17:26:48 -0600430
Jon Ashburn1c75aec2016-02-02 17:47:28 -0700431VkResult loader_add_to_ext_list(const struct loader_instance *inst,
432 struct loader_extension_list *ext_list,
433 uint32_t prop_list_count,
434 const VkExtensionProperties *props);
Jon Ashburnc466da52016-04-15 09:25:03 -0600435VkResult
436loader_add_to_dev_ext_list(const struct loader_instance *inst,
437 struct loader_device_extension_list *ext_list,
438 const VkExtensionProperties *props,
439 uint32_t entry_count, char **entrys);
Jon Ashburnc4e9ae62016-02-26 13:14:27 -0700440VkResult loader_add_device_extensions(const struct loader_instance *inst,
Jon Ashburnc466da52016-04-15 09:25:03 -0600441 PFN_vkEnumerateDeviceExtensionProperties
442 fpEnumerateDeviceExtensionProperties,
Jon Ashburnc4e9ae62016-02-26 13:14:27 -0700443 VkPhysicalDevice physical_device,
444 const char *lib_name,
445 struct loader_extension_list *ext_list);
446bool loader_init_generic_list(const struct loader_instance *inst,
447 struct loader_generic_list *list_info,
448 size_t element_size);
Jon Ashburn1c75aec2016-02-02 17:47:28 -0700449void loader_destroy_generic_list(const struct loader_instance *inst,
450 struct loader_generic_list *list);
Jon Ashburnc4e9ae62016-02-26 13:14:27 -0700451void loader_destroy_layer_list(const struct loader_instance *inst,
452 struct loader_layer_list *layer_list);
Jon Ashburn1c75aec2016-02-02 17:47:28 -0700453void loader_delete_layer_properties(const struct loader_instance *inst,
454 struct loader_layer_list *layer_list);
Jon Ashburnc325bc02016-05-16 14:01:18 -0600455bool loader_find_layer_name_array(const char *name, uint32_t layer_count,
456 const char layer_list[][VK_MAX_EXTENSION_NAME_SIZE]);
Jon Ashburnd1eb3322016-02-10 20:59:26 -0700457void loader_expand_layer_names(
Jon Ashburnc325bc02016-05-16 14:01:18 -0600458 struct loader_instance *inst, const char *key_name,
Jon Ashburnd1eb3322016-02-10 20:59:26 -0700459 uint32_t expand_count,
460 const char expand_names[][VK_MAX_EXTENSION_NAME_SIZE],
Jon Ashburnc466da52016-04-15 09:25:03 -0600461 uint32_t *layer_count, char const *const **ppp_layer_names);
Jon Ashburnc325bc02016-05-16 14:01:18 -0600462void loader_init_std_validation_props(struct loader_layer_properties *props);
Chris Forbes7333fdd2016-04-06 20:49:02 +1200463void loader_delete_shadow_dev_layer_names(const struct loader_instance *inst,
464 const VkDeviceCreateInfo *orig,
465 VkDeviceCreateInfo *ours);
466void loader_delete_shadow_inst_layer_names(const struct loader_instance *inst,
467 const VkInstanceCreateInfo *orig,
468 VkInstanceCreateInfo *ours);
Jon Ashburn1c75aec2016-02-02 17:47:28 -0700469void loader_add_to_layer_list(const struct loader_instance *inst,
470 struct loader_layer_list *list,
471 uint32_t prop_list_count,
472 const struct loader_layer_properties *props);
Jon Ashburnc466da52016-04-15 09:25:03 -0600473void loader_find_layer_name_add_list(
474 const struct loader_instance *inst, const char *name,
475 const enum layer_type type, const struct loader_layer_list *search_list,
476 struct loader_layer_list *found_list);
Jon Ashburn1c75aec2016-02-02 17:47:28 -0700477void loader_scanned_icd_clear(const struct loader_instance *inst,
478 struct loader_icd_libs *icd_libs);
479void loader_icd_scan(const struct loader_instance *inst,
480 struct loader_icd_libs *icds);
481void loader_layer_scan(const struct loader_instance *inst,
Jon Ashburnc325bc02016-05-16 14:01:18 -0600482 struct loader_layer_list *instance_layers);
Jeremy Hayes10d78f12016-04-01 11:40:26 -0600483void loader_implicit_layer_scan(const struct loader_instance *inst,
Jon Ashburnc325bc02016-05-16 14:01:18 -0600484 struct loader_layer_list *instance_layers);
Jon Ashburne0367472015-08-18 18:04:47 -0600485void loader_get_icd_loader_instance_extensions(
Jon Ashburn1c75aec2016-02-02 17:47:28 -0700486 const struct loader_instance *inst, struct loader_icd_libs *icd_libs,
487 struct loader_extension_list *inst_exts);
488struct loader_icd *loader_get_icd_and_device(const VkDevice device,
489 struct loader_device **found_dev);
Jon Ashburnc4e9ae62016-02-26 13:14:27 -0700490void loader_init_dispatch_dev_ext(struct loader_instance *inst,
491 struct loader_device *dev);
Jon Ashburn1c75aec2016-02-02 17:47:28 -0700492void *loader_dev_ext_gpa(struct loader_instance *inst, const char *funcName);
493void *loader_get_dev_ext_trampoline(uint32_t index);
494struct loader_instance *loader_get_instance(const VkInstance instance);
Jon Ashburnd3cf9552016-04-20 13:21:17 -0600495void loader_deactivate_layers(const struct loader_instance *instance,
496 struct loader_layer_list *list);
Jon Ashburnc4e9ae62016-02-26 13:14:27 -0700497struct loader_device *
Piers Daniell82107a62016-03-29 11:51:11 -0600498loader_create_logical_device(const struct loader_instance *inst);
499void loader_add_logical_device(const struct loader_instance *inst,
500 struct loader_icd *icd,
501 struct loader_device *found_dev);
Jon Ashburn1c75aec2016-02-02 17:47:28 -0700502void loader_remove_logical_device(const struct loader_instance *inst,
503 struct loader_icd *icd,
504 struct loader_device *found_dev);
505VkResult
506loader_enable_instance_layers(struct loader_instance *inst,
507 const VkInstanceCreateInfo *pCreateInfo,
508 const struct loader_layer_list *instance_layers);
Jon Ashburn10f4e822015-06-10 10:06:06 -0600509void loader_deactivate_instance_layers(struct loader_instance *instance);
Courtney Goeltzenleuchter0bd705c2016-01-08 12:18:43 -0700510
Jon Ashburn1c75aec2016-02-02 17:47:28 -0700511VkResult loader_create_instance_chain(const VkInstanceCreateInfo *pCreateInfo,
512 const VkAllocationCallbacks *pAllocator,
513 struct loader_instance *inst,
Jon Ashburnd1205a92016-02-03 12:37:30 -0700514 VkInstance *created_instance);
Courtney Goeltzenleuchter0bd705c2016-01-08 12:18:43 -0700515
Jon Ashburn1c75aec2016-02-02 17:47:28 -0700516void loader_activate_instance_layer_extensions(struct loader_instance *inst,
517 VkInstance created_inst);
Jon Ashburnc4e9ae62016-02-26 13:14:27 -0700518VkResult
519loader_enable_device_layers(const struct loader_instance *inst,
Jon Ashburnc4e9ae62016-02-26 13:14:27 -0700520 struct loader_layer_list *activated_layer_list,
521 const VkDeviceCreateInfo *pCreateInfo,
522 const struct loader_layer_list *device_layers);
Courtney Goeltzenleuchter71b454b2015-07-05 11:28:29 -0600523
Jon Ashburnc466da52016-04-15 09:25:03 -0600524VkResult
525loader_create_device_chain(const struct loader_physical_device_tramp *pd,
526 const VkDeviceCreateInfo *pCreateInfo,
527 const VkAllocationCallbacks *pAllocator,
528 const struct loader_instance *inst,
529 struct loader_device *dev);
Jon Ashburnc4e9ae62016-02-26 13:14:27 -0700530VkResult loader_validate_device_extensions(
Jon Ashburnc3519e42016-03-24 15:49:57 -0600531 struct loader_physical_device_tramp *phys_dev,
Jon Ashburnc4e9ae62016-02-26 13:14:27 -0700532 const struct loader_layer_list *activated_device_layers,
Jon Ashburnfd02a0f2016-03-01 19:51:07 -0700533 const struct loader_extension_list *icd_exts,
Jon Ashburnc4e9ae62016-02-26 13:14:27 -0700534 const VkDeviceCreateInfo *pCreateInfo);
Courtney Goeltzenleuchter71b454b2015-07-05 11:28:29 -0600535
Jon Ashburnc4e9ae62016-02-26 13:14:27 -0700536/* instance layer chain termination entrypoint definitions */
537VKAPI_ATTR VkResult VKAPI_CALL
538terminator_CreateInstance(const VkInstanceCreateInfo *pCreateInfo,
539 const VkAllocationCallbacks *pAllocator,
540 VkInstance *pInstance);
Jon Ashburnb4dee9c2015-08-28 15:19:27 -0600541
Jon Ashburnc4e9ae62016-02-26 13:14:27 -0700542VKAPI_ATTR void VKAPI_CALL
543terminator_DestroyInstance(VkInstance instance,
544 const VkAllocationCallbacks *pAllocator);
Jon Ashburnb4dee9c2015-08-28 15:19:27 -0600545
Jon Ashburnc4e9ae62016-02-26 13:14:27 -0700546VKAPI_ATTR VkResult VKAPI_CALL
547terminator_EnumeratePhysicalDevices(VkInstance instance,
548 uint32_t *pPhysicalDeviceCount,
549 VkPhysicalDevice *pPhysicalDevices);
550
551VKAPI_ATTR void VKAPI_CALL
552terminator_GetPhysicalDeviceFeatures(VkPhysicalDevice physicalDevice,
553 VkPhysicalDeviceFeatures *pFeatures);
554
555VKAPI_ATTR void VKAPI_CALL
556terminator_GetPhysicalDeviceFormatProperties(VkPhysicalDevice physicalDevice,
557 VkFormat format,
558 VkFormatProperties *pFormatInfo);
559
560VKAPI_ATTR VkResult VKAPI_CALL
561terminator_GetPhysicalDeviceImageFormatProperties(
562 VkPhysicalDevice physicalDevice, VkFormat format, VkImageType type,
563 VkImageTiling tiling, VkImageUsageFlags usage, VkImageCreateFlags flags,
564 VkImageFormatProperties *pImageFormatProperties);
565
566VKAPI_ATTR void VKAPI_CALL
567terminator_GetPhysicalDeviceSparseImageFormatProperties(
568 VkPhysicalDevice physicalDevice, VkFormat format, VkImageType type,
569 VkSampleCountFlagBits samples, VkImageUsageFlags usage,
570 VkImageTiling tiling, uint32_t *pNumProperties,
571 VkSparseImageFormatProperties *pProperties);
572
573VKAPI_ATTR void VKAPI_CALL
574terminator_GetPhysicalDeviceProperties(VkPhysicalDevice physicalDevice,
575 VkPhysicalDeviceProperties *pProperties);
576
577VKAPI_ATTR VkResult VKAPI_CALL terminator_EnumerateDeviceExtensionProperties(
578 VkPhysicalDevice physicalDevice, const char *pLayerName, uint32_t *pCount,
579 VkExtensionProperties *pProperties);
580
581VKAPI_ATTR VkResult VKAPI_CALL
582terminator_EnumerateDeviceLayerProperties(VkPhysicalDevice physicalDevice,
583 uint32_t *pCount,
584 VkLayerProperties *pProperties);
585
586VKAPI_ATTR void VKAPI_CALL terminator_GetPhysicalDeviceQueueFamilyProperties(
587 VkPhysicalDevice physicalDevice, uint32_t *pCount,
588 VkQueueFamilyProperties *pProperties);
589
590VKAPI_ATTR void VKAPI_CALL terminator_GetPhysicalDeviceMemoryProperties(
591 VkPhysicalDevice physicalDevice,
592 VkPhysicalDeviceMemoryProperties *pProperties);
593
594VKAPI_ATTR VkResult VKAPI_CALL
595terminator_CreateDevice(VkPhysicalDevice gpu,
596 const VkDeviceCreateInfo *pCreateInfo,
597 const VkAllocationCallbacks *pAllocator,
598 VkDevice *pDevice);
Mark Lobodzinski8d325802016-02-02 18:53:34 -0700599
Jon Ashburnb1cdf2e2016-02-10 20:50:19 -0700600VkStringErrorFlags vk_string_validate(const int max_length,
601 const char *char_array);
Mark Lobodzinski8d325802016-02-02 18:53:34 -0700602
Chia-I Wuc1e0f962014-08-04 08:03:57 +0800603#endif /* LOADER_H */