blob: 1b12311e851042a1ce03c85a91b62ff7478a85cd [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 Ashburn9464e772015-07-02 16:10:32 -060052 VK_LAYER_TYPE_DEVICE_EXPLICIT = 0x1,
53 VK_LAYER_TYPE_INSTANCE_EXPLICIT = 0x2,
Jon Ashburnd1eb3322016-02-10 20:59:26 -070054 VK_LAYER_TYPE_GLOBAL_EXPLICIT = 0x3, // instance and device layer, bitwise
Jon Ashburn9464e772015-07-02 16:10:32 -060055 VK_LAYER_TYPE_DEVICE_IMPLICIT = 0x4,
56 VK_LAYER_TYPE_INSTANCE_IMPLICIT = 0x8,
Jon Ashburnd1eb3322016-02-10 20:59:26 -070057 VK_LAYER_TYPE_GLOBAL_IMPLICIT = 0xc, // instance and device layer, bitwise
58 VK_LAYER_TYPE_META_EXPLICT = 0x10,
Jon Ashburn399c9162015-07-02 09:40:15 -060059};
60
Mark Lobodzinski8d325802016-02-02 18:53:34 -070061typedef enum VkStringErrorFlagBits {
Jon Ashburnb1cdf2e2016-02-10 20:50:19 -070062 VK_STRING_ERROR_NONE = 0x00000000,
63 VK_STRING_ERROR_LENGTH = 0x00000001,
64 VK_STRING_ERROR_BAD_DATA = 0x00000002,
Mark Lobodzinski8d325802016-02-02 18:53:34 -070065} VkStringErrorFlagBits;
66typedef VkFlags VkStringErrorFlags;
67
Jon Ashburnb1cdf2e2016-02-10 20:50:19 -070068static const int MaxLoaderStringLength = 256;
69static const char UTF8_ONE_BYTE_CODE = 0xC0;
70static const char UTF8_ONE_BYTE_MASK = 0xE0;
71static const char UTF8_TWO_BYTE_CODE = 0xE0;
72static const char UTF8_TWO_BYTE_MASK = 0xF0;
73static const char UTF8_THREE_BYTE_CODE = 0xF0;
74static const char UTF8_THREE_BYTE_MASK = 0xF8;
75static const char UTF8_DATA_BYTE_CODE = 0x80;
76static const char UTF8_DATA_BYTE_MASK = 0xC0;
Mark Lobodzinski8d325802016-02-02 18:53:34 -070077
Mark Lobodzinskib0123ea2016-03-15 17:23:12 -060078static const char std_validation_names[8][VK_MAX_EXTENSION_NAME_SIZE] = {
Jon Ashburnc466da52016-04-15 09:25:03 -060079 "VK_LAYER_GOOGLE_threading", "VK_LAYER_LUNARG_parameter_validation",
Jon Ashburnd1eb3322016-02-10 20:59:26 -070080 "VK_LAYER_LUNARG_device_limits", "VK_LAYER_LUNARG_object_tracker",
Jon Ashburnc466da52016-04-15 09:25:03 -060081 "VK_LAYER_LUNARG_image", "VK_LAYER_LUNARG_core_validation",
82 "VK_LAYER_LUNARG_swapchain", "VK_LAYER_GOOGLE_unique_objects"};
Jon Ashburnd1eb3322016-02-10 20:59:26 -070083
Jon Ashburn6b00b472015-12-10 08:51:10 -070084// form of all dynamic lists/arrays
85// only the list element should be changed
86struct loader_generic_list {
87 size_t capacity;
88 uint32_t count;
89 void *list;
90};
91
Courtney Goeltzenleuchter67146d02015-06-10 17:39:03 -060092struct loader_extension_list {
93 size_t capacity;
94 uint32_t count;
Jon Ashburnb7d327c2015-08-04 11:14:18 -060095 VkExtensionProperties *list;
Courtney Goeltzenleuchter67146d02015-06-10 17:39:03 -060096};
97
Jon Ashburn92cdb012015-12-10 18:17:34 -070098struct loader_dev_ext_props {
99 VkExtensionProperties props;
100 uint32_t entrypoint_count;
101 char **entrypoints;
102};
103
104struct loader_device_extension_list {
105 size_t capacity;
106 uint32_t count;
107 struct loader_dev_ext_props *list;
108};
109
Jon Ashburn399c9162015-07-02 09:40:15 -0600110struct loader_name_value {
Jon Ashburnb2379c52015-08-04 10:22:33 -0600111 char name[MAX_STRING_SIZE];
112 char value[MAX_STRING_SIZE];
Jon Ashburn399c9162015-07-02 09:40:15 -0600113};
114
Jon Ashburn399c9162015-07-02 09:40:15 -0600115struct loader_layer_functions {
Jon Ashburnb2379c52015-08-04 10:22:33 -0600116 char str_gipa[MAX_STRING_SIZE];
117 char str_gdpa[MAX_STRING_SIZE];
Jon Ashburn399c9162015-07-02 09:40:15 -0600118 PFN_vkGetInstanceProcAddr get_instance_proc_addr;
119 PFN_vkGetDeviceProcAddr get_device_proc_addr;
120};
Courtney Goeltzenleuchter67146d02015-06-10 17:39:03 -0600121
Jon Ashburn399c9162015-07-02 09:40:15 -0600122struct loader_layer_properties {
Courtney Goeltzenleuchter44667cc2015-06-29 15:39:26 -0600123 VkLayerProperties info;
Jon Ashburn399c9162015-07-02 09:40:15 -0600124 enum layer_type type;
Jon Ashburnb4c24232015-08-20 16:35:30 -0600125 char lib_name[MAX_STRING_SIZE];
Jon Ashburnd3cf9552016-04-20 13:21:17 -0600126 loader_platform_dl_handle lib_handle;
Jon Ashburn399c9162015-07-02 09:40:15 -0600127 struct loader_layer_functions functions;
128 struct loader_extension_list instance_extension_list;
Jon Ashburn92cdb012015-12-10 18:17:34 -0700129 struct loader_device_extension_list device_extension_list;
Jon Ashburn399c9162015-07-02 09:40:15 -0600130 struct loader_name_value disable_env_var;
131 struct loader_name_value enable_env_var;
132};
133
134struct loader_layer_list {
135 size_t capacity;
136 uint32_t count;
137 struct loader_layer_properties *list;
Jon Ashburn13482452015-05-12 17:26:48 -0600138};
139
Jon Ashburn6cb69f42015-11-17 15:31:02 -0700140struct loader_dispatch_hash_list {
141 size_t capacity;
142 uint32_t count;
Jon Ashburn1c75aec2016-02-02 17:47:28 -0700143 uint32_t *index; // index into the dev_ext dispatch table
Jon Ashburn6cb69f42015-11-17 15:31:02 -0700144};
145
146#define MAX_NUM_DEV_EXTS 250
Jon Ashburn1c75aec2016-02-02 17:47:28 -0700147// loader_dispatch_hash_entry and loader_dev_ext_dispatch_table.DevExt have one
148// to one
Jon Ashburn6cb69f42015-11-17 15:31:02 -0700149// correspondence; one loader_dispatch_hash_entry for one DevExt dispatch entry.
150// Also have a one to one correspondence with functions in dev_ext_trampoline.c
151struct loader_dispatch_hash_entry {
152 char *func_name;
Jon Ashburn1c75aec2016-02-02 17:47:28 -0700153 struct loader_dispatch_hash_list list; // to handle hashing collisions
Jon Ashburn6cb69f42015-11-17 15:31:02 -0700154};
155
Jon Ashburn1c75aec2016-02-02 17:47:28 -0700156typedef void(VKAPI_PTR *PFN_vkDevExt)(VkDevice device);
Jon Ashburn6cb69f42015-11-17 15:31:02 -0700157struct loader_dev_ext_dispatch_table {
158 PFN_vkDevExt DevExt[MAX_NUM_DEV_EXTS];
159};
160
161struct loader_dev_dispatch_table {
162 VkLayerDispatchTable core_dispatch;
163 struct loader_dev_ext_dispatch_table ext_dispatch;
164};
165
Jon Ashburn10f4e822015-06-10 10:06:06 -0600166/* per CreateDevice structure */
167struct loader_device {
Jon Ashburn6cb69f42015-11-17 15:31:02 -0700168 struct loader_dev_dispatch_table loader_dispatch;
Jon Ashburn1c75aec2016-02-02 17:47:28 -0700169 VkDevice device; // device object from the icd
Jon Ashburn10f4e822015-06-10 10:06:06 -0600170
Jon Ashburn1c75aec2016-02-02 17:47:28 -0700171 uint32_t app_extension_count;
Jon Ashburn10f4e822015-06-10 10:06:06 -0600172 VkExtensionProperties *app_extension_props;
173
Courtney Goeltzenleuchter44667cc2015-06-29 15:39:26 -0600174 struct loader_layer_list activated_layer_list;
Jon Ashburn10f4e822015-06-10 10:06:06 -0600175
176 struct loader_device *next;
177};
178
Jon Ashburn392c5622015-06-10 16:11:42 -0600179/* per ICD structure */
Jon Ashburnebfa25e2015-05-15 15:09:35 -0600180struct loader_icd {
Jon Ashburnb4c24232015-08-20 16:35:30 -0600181 // pointers to find other structs
182 const struct loader_scanned_icds *this_icd_lib;
183 const struct loader_instance *this_instance;
Jon Ashburn10f4e822015-06-10 10:06:06 -0600184 struct loader_device *logical_device_list;
Jon Ashburn1c75aec2016-02-02 17:47:28 -0700185 VkInstance instance; // instance object from the icd
Jon Ashburnc89dd4a2015-05-18 13:20:15 -0600186 PFN_vkGetDeviceProcAddr GetDeviceProcAddr;
Jon Ashburnebfa25e2015-05-15 15:09:35 -0600187 PFN_vkDestroyInstance DestroyInstance;
188 PFN_vkEnumeratePhysicalDevices EnumeratePhysicalDevices;
Chris Forbes1c946ec2015-06-21 22:55:02 +1200189 PFN_vkGetPhysicalDeviceFeatures GetPhysicalDeviceFeatures;
Courtney Goeltzenleuchter2b6559e2015-07-12 12:52:09 -0600190 PFN_vkGetPhysicalDeviceFormatProperties GetPhysicalDeviceFormatProperties;
Jon Ashburn1c75aec2016-02-02 17:47:28 -0700191 PFN_vkGetPhysicalDeviceImageFormatProperties
192 GetPhysicalDeviceImageFormatProperties;
Jon Ashburnebfa25e2015-05-15 15:09:35 -0600193 PFN_vkCreateDevice CreateDevice;
Tony Barbour4e657ba2015-06-24 16:06:58 -0600194 PFN_vkGetPhysicalDeviceProperties GetPhysicalDeviceProperties;
Jon Ashburn1c75aec2016-02-02 17:47:28 -0700195 PFN_vkGetPhysicalDeviceQueueFamilyProperties
196 GetPhysicalDeviceQueueFamilyProperties;
Tony Barbour4e657ba2015-06-24 16:06:58 -0600197 PFN_vkGetPhysicalDeviceMemoryProperties GetPhysicalDeviceMemoryProperties;
Courtney Goeltzenleuchtere25064c2015-09-14 17:22:16 -0600198 PFN_vkEnumerateDeviceExtensionProperties EnumerateDeviceExtensionProperties;
Jon Ashburn1c75aec2016-02-02 17:47:28 -0700199 PFN_vkGetPhysicalDeviceSparseImageFormatProperties
200 GetPhysicalDeviceSparseImageFormatProperties;
Courtney Goeltzenleuchter725db942015-12-09 15:48:16 -0700201 PFN_vkCreateDebugReportCallbackEXT CreateDebugReportCallbackEXT;
202 PFN_vkDestroyDebugReportCallbackEXT DestroyDebugReportCallbackEXT;
203 PFN_vkDebugReportMessageEXT DebugReportMessageEXT;
Ian Elliottec736342015-08-21 15:09:33 -0600204 PFN_vkGetPhysicalDeviceSurfaceSupportKHR GetPhysicalDeviceSurfaceSupportKHR;
Jon Ashburn1c75aec2016-02-02 17:47:28 -0700205 PFN_vkGetPhysicalDeviceSurfaceCapabilitiesKHR
206 GetPhysicalDeviceSurfaceCapabilitiesKHR;
Ian Elliottea666b22015-11-19 16:05:09 -0700207 PFN_vkGetPhysicalDeviceSurfaceFormatsKHR GetPhysicalDeviceSurfaceFormatsKHR;
Jon Ashburn1c75aec2016-02-02 17:47:28 -0700208 PFN_vkGetPhysicalDeviceSurfacePresentModesKHR
209 GetPhysicalDeviceSurfacePresentModesKHR;
Ian Elliotte851dd62015-11-24 15:39:10 -0700210#ifdef VK_USE_PLATFORM_WIN32_KHR
Jon Ashburn1c75aec2016-02-02 17:47:28 -0700211 PFN_vkGetPhysicalDeviceWin32PresentationSupportKHR
212 GetPhysicalDeviceWin32PresentationSupportKHR;
Ian Elliotte851dd62015-11-24 15:39:10 -0700213#endif
214#ifdef VK_USE_PLATFORM_MIR_KHR
Jon Ashburn1c75aec2016-02-02 17:47:28 -0700215 PFN_vkGetPhysicalDeviceMirPresentationSupportKHR
216 GetPhysicalDeviceMirPresentvationSupportKHR;
Ian Elliotte851dd62015-11-24 15:39:10 -0700217#endif
218#ifdef VK_USE_PLATFORM_WAYLAND_KHR
Jon Ashburn1c75aec2016-02-02 17:47:28 -0700219 PFN_vkGetPhysicalDeviceWaylandPresentationSupportKHR
220 GetPhysicalDeviceWaylandPresentationSupportKHR;
Ian Elliotte851dd62015-11-24 15:39:10 -0700221#endif
222#ifdef VK_USE_PLATFORM_XCB_KHR
Jon Ashburn1c75aec2016-02-02 17:47:28 -0700223 PFN_vkGetPhysicalDeviceXcbPresentationSupportKHR
224 GetPhysicalDeviceXcbPresentationSupportKHR;
Ian Elliotte851dd62015-11-24 15:39:10 -0700225#endif
226#ifdef VK_USE_PLATFORM_XLIB_KHR
Jon Ashburn1c75aec2016-02-02 17:47:28 -0700227 PFN_vkGetPhysicalDeviceXlibPresentationSupportKHR
228 GetPhysicalDeviceXlibPresentationSupportKHR;
Ian Elliotte851dd62015-11-24 15:39:10 -0700229#endif
Jon Ashburncc370d02016-03-08 09:30:30 -0700230 PFN_vkGetPhysicalDeviceDisplayPropertiesKHR
231 GetPhysicalDeviceDisplayPropertiesKHR;
232 PFN_vkGetPhysicalDeviceDisplayPlanePropertiesKHR
233 GetPhysicalDeviceDisplayPlanePropertiesKHR;
234 PFN_vkGetDisplayPlaneSupportedDisplaysKHR
235 GetDisplayPlaneSupportedDisplaysKHR;
Jon Ashburnc466da52016-04-15 09:25:03 -0600236 PFN_vkGetDisplayModePropertiesKHR GetDisplayModePropertiesKHR;
237 PFN_vkCreateDisplayModeKHR CreateDisplayModeKHR;
238 PFN_vkGetDisplayPlaneCapabilitiesKHR GetDisplayPlaneCapabilitiesKHR;
239 PFN_vkCreateDisplayPlaneSurfaceKHR CreateDisplayPlaneSurfaceKHR;
240 PFN_vkDestroySurfaceKHR DestroySurfaceKHR;
Jon Ashburn10f4e822015-06-10 10:06:06 -0600241 struct loader_icd *next;
Jon Ashburnebfa25e2015-05-15 15:09:35 -0600242};
243
Jon Ashburne0367472015-08-18 18:04:47 -0600244/* per ICD library structure */
245struct loader_icd_libs {
246 size_t capacity;
247 uint32_t count;
248 struct loader_scanned_icds *list;
249};
250
Jon Ashburn392c5622015-06-10 16:11:42 -0600251/* per instance structure */
Jon Ashburn13482452015-05-12 17:26:48 -0600252struct loader_instance {
Jon Ashburnebfa25e2015-05-15 15:09:35 -0600253 VkLayerInstanceDispatchTable *disp; // must be first entry in structure
254
Jon Ashburnfd02a0f2016-03-01 19:51:07 -0700255 uint32_t total_gpu_count; // count of the next two arrays
256 struct loader_physical_device *phys_devs_term;
Jon Ashburnc466da52016-04-15 09:25:03 -0600257 struct loader_physical_device_tramp *
258 phys_devs; // tramp wrapped physDev obj list
Courtney Goeltzenleuchter67146d02015-06-10 17:39:03 -0600259 uint32_t total_icd_count;
Jon Ashburn13482452015-05-12 17:26:48 -0600260 struct loader_icd *icds;
261 struct loader_instance *next;
Jon Ashburn1c75aec2016-02-02 17:47:28 -0700262 struct loader_extension_list ext_list; // icds and loaders extensions
Jon Ashburne0367472015-08-18 18:04:47 -0600263 struct loader_icd_libs icd_libs;
Jon Ashburnb4c24232015-08-20 16:35:30 -0600264 struct loader_layer_list instance_layer_list;
265 struct loader_layer_list device_layer_list;
Jon Ashburn6cb69f42015-11-17 15:31:02 -0700266 struct loader_dispatch_hash_entry disp_hash[MAX_NUM_DEV_EXTS];
Jon Ashburnb4c24232015-08-20 16:35:30 -0600267
Courtney Goeltzenleuchter67146d02015-06-10 17:39:03 -0600268 struct loader_msg_callback_map_entry *icd_msg_callback_map;
269
Courtney Goeltzenleuchter44667cc2015-06-29 15:39:26 -0600270 struct loader_layer_list activated_layer_list;
Courtney Goeltzenleuchter67146d02015-06-10 17:39:03 -0600271
Jon Ashburnc466da52016-04-15 09:25:03 -0600272 VkInstance instance; // layers/ICD instance returned to trampoline
Courtney Goeltzenleuchter0bd705c2016-01-08 12:18:43 -0700273
Courtney Goeltzenleuchter67146d02015-06-10 17:39:03 -0600274 bool debug_report_enabled;
Courtney Goeltzenleuchter67146d02015-06-10 17:39:03 -0600275 VkLayerDbgFunctionNode *DbgFunctionHead;
Ian Elliottdefd6da2016-03-31 10:48:19 -0600276 uint32_t num_tmp_callbacks;
277 VkDebugReportCallbackCreateInfoEXT *tmp_dbg_create_infos;
278 VkDebugReportCallbackEXT *tmp_callbacks;
Courtney Goeltzenleuchter71b454b2015-07-05 11:28:29 -0600279
Chia-I Wu227c8b32015-10-27 18:04:07 +0800280 VkAllocationCallbacks alloc_callbacks;
Ian Elliotted33eb72015-07-06 14:36:13 -0600281
Ian Elliott54cea232015-10-30 15:28:23 -0600282 bool wsi_surface_enabled;
Mark Lobodzinski1ad14b42015-12-10 16:25:21 -0700283#ifdef VK_USE_PLATFORM_WIN32_KHR
Ian Elliott54cea232015-10-30 15:28:23 -0600284 bool wsi_win32_surface_enabled;
Mark Lobodzinski1ad14b42015-12-10 16:25:21 -0700285#endif
286#ifdef VK_USE_PLATFORM_MIR_KHR
Ian Elliott54cea232015-10-30 15:28:23 -0600287 bool wsi_mir_surface_enabled;
Mark Lobodzinski1ad14b42015-12-10 16:25:21 -0700288#endif
289#ifdef VK_USE_PLATFORM_WAYLAND_KHR
Ian Elliott54cea232015-10-30 15:28:23 -0600290 bool wsi_wayland_surface_enabled;
Mark Lobodzinski1ad14b42015-12-10 16:25:21 -0700291#endif
292#ifdef VK_USE_PLATFORM_XCB_KHR
Ian Elliott54cea232015-10-30 15:28:23 -0600293 bool wsi_xcb_surface_enabled;
Mark Lobodzinski1ad14b42015-12-10 16:25:21 -0700294#endif
295#ifdef VK_USE_PLATFORM_XLIB_KHR
Ian Elliott54cea232015-10-30 15:28:23 -0600296 bool wsi_xlib_surface_enabled;
Mark Lobodzinski1ad14b42015-12-10 16:25:21 -0700297#endif
298#ifdef VK_USE_PLATFORM_ANDROID_KHR
299 bool wsi_android_surface_enabled;
300#endif
Jon Ashburncc370d02016-03-08 09:30:30 -0700301 bool wsi_display_enabled;
Courtney Goeltzenleuchter67146d02015-06-10 17:39:03 -0600302};
303
Jon Ashburnfd02a0f2016-03-01 19:51:07 -0700304/* VkPhysicalDevice requires special treatment by loader. Firstly, terminator
305 * code must be able to get the struct loader_icd to call into the proper
306 * driver (multiple ICD/gpu case). This can be accomplished by wrapping the
307 * created VkPhysicalDevice in loader terminate_EnumeratePhysicalDevices().
Piers Daniell82107a62016-03-29 11:51:11 -0600308 * Secondly, the loader must be able to handle wrapped by layer VkPhysicalDevice
Jon Ashburnfd02a0f2016-03-01 19:51:07 -0700309 * in trampoline code. This implies, that the loader trampoline code must also
310 * wrap the VkPhysicalDevice object in trampoline code. Thus, loader has to
311 * wrap the VkPhysicalDevice created object twice. In trampoline code it can't
312 * rely on the terminator object wrapping since a layer may also wrap. Since
313 * trampoline code wraps the VkPhysicalDevice this means all loader trampoline
314 * code that passes a VkPhysicalDevice should unwrap it. */
315
316/* per enumerated PhysicalDevice structure, used to wrap in trampoline code and
317 also same structure used to wrap in terminator code */
Jon Ashburnc3519e42016-03-24 15:49:57 -0600318struct loader_physical_device_tramp {
319 VkLayerInstanceDispatchTable *disp; // must be first entry in structure
Piers Daniell82107a62016-03-29 11:51:11 -0600320 struct loader_instance *this_instance;
Jon Ashburnc466da52016-04-15 09:25:03 -0600321 VkPhysicalDevice phys_dev; // object from layers/loader terminator
Jon Ashburnc3519e42016-03-24 15:49:57 -0600322};
323
324/* per enumerated PhysicalDevice 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 Ashburnc3519e42016-03-24 15:49:57 -0600328 VkPhysicalDevice phys_dev; // object from ICD
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
335struct loader_scanned_icds {
336 char *lib_name;
337 loader_platform_dl_handle handle;
Jon Ashburn27109e82015-11-17 17:35:40 -0700338 uint32_t api_version;
Jon Ashburn68b06d62016-04-25 11:09:37 -0600339 uint32_t interface_version;
Jon Ashburnc7ca48d2015-07-16 10:17:29 -0600340 PFN_vkGetInstanceProcAddr GetInstanceProcAddr;
Courtney Goeltzenleuchter67146d02015-06-10 17:39:03 -0600341 PFN_vkCreateInstance CreateInstance;
Jon Ashburn1c75aec2016-02-02 17:47:28 -0700342 PFN_vkEnumerateInstanceExtensionProperties
343 EnumerateInstanceExtensionProperties;
Jon Ashburn13482452015-05-12 17:26:48 -0600344};
345
Jon Ashburn399c9162015-07-02 09:40:15 -0600346static inline struct loader_instance *loader_instance(VkInstance instance) {
Jon Ashburn1c75aec2016-02-02 17:47:28 -0700347 return (struct loader_instance *)instance;
Jon Ashburn399c9162015-07-02 09:40:15 -0600348}
349
Jon Ashburnfd02a0f2016-03-01 19:51:07 -0700350static inline VkPhysicalDevice
351loader_unwrap_physical_device(VkPhysicalDevice physicalDevice) {
Piers Daniella9ccaed2016-03-31 14:47:57 -0600352 struct loader_physical_device_tramp *phys_dev =
353 (struct loader_physical_device_tramp *)physicalDevice;
Jon Ashburnfd02a0f2016-03-01 19:51:07 -0700354 return phys_dev->phys_dev;
355}
356
Jon Ashburn1c75aec2016-02-02 17:47:28 -0700357static inline void loader_set_dispatch(void *obj, const void *data) {
358 *((const void **)obj) = data;
Chia-I Wufe333ed2015-04-11 15:34:07 +0800359}
360
Jon Ashburn1c75aec2016-02-02 17:47:28 -0700361static inline VkLayerDispatchTable *loader_get_dispatch(const void *obj) {
362 return *((VkLayerDispatchTable **)obj);
Chia-I Wufe333ed2015-04-11 15:34:07 +0800363}
364
Jon Ashburn1c75aec2016-02-02 17:47:28 -0700365static inline struct loader_dev_dispatch_table *
366loader_get_dev_dispatch(const void *obj) {
367 return *((struct loader_dev_dispatch_table **)obj);
Jon Ashburn6cb69f42015-11-17 15:31:02 -0700368}
369
Jon Ashburn1c75aec2016-02-02 17:47:28 -0700370static inline VkLayerInstanceDispatchTable *
371loader_get_instance_dispatch(const void *obj) {
372 return *((VkLayerInstanceDispatchTable **)obj);
Jon Ashburn13482452015-05-12 17:26:48 -0600373}
374
Jon Ashburn1c75aec2016-02-02 17:47:28 -0700375static inline void loader_init_dispatch(void *obj, const void *data) {
Jon Ashburn167b2b12015-04-15 13:34:33 -0600376#ifdef DEBUG
Chia-I Wufe333ed2015-04-11 15:34:07 +0800377 assert(valid_loader_magic_value(obj) &&
Jon Ashburn1c75aec2016-02-02 17:47:28 -0700378 "Incompatible ICD, first dword must be initialized to "
379 "ICD_LOADER_MAGIC. See loader/README.md for details.");
Jon Ashburn167b2b12015-04-15 13:34:33 -0600380#endif
Chia-I Wufe333ed2015-04-11 15:34:07 +0800381
Jon Ashburn62a54d12015-05-01 18:00:33 -0600382 loader_set_dispatch(obj, data);
Chia-I Wufe333ed2015-04-11 15:34:07 +0800383}
384
Jon Ashburn13482452015-05-12 17:26:48 -0600385/* global variables used across files */
386extern struct loader_struct loader;
Jon Ashburnb4dee9c2015-08-28 15:19:27 -0600387extern THREAD_LOCAL_DECL struct loader_instance *tls_instance;
Jon Ashburne0367472015-08-18 18:04:47 -0600388extern LOADER_PLATFORM_THREAD_ONCE_DEFINITION(once_init);
Jon Ashburn7e8d8b42015-05-29 13:15:39 -0600389extern loader_platform_thread_mutex loader_lock;
Jon Ashburn7d4d51c2015-09-22 13:11:00 -0600390extern loader_platform_thread_mutex loader_json_lock;
Jon Ashburn7e8d8b42015-05-29 13:15:39 -0600391extern const VkLayerInstanceDispatchTable instance_disp;
Jon Ashburnd1eb3322016-02-10 20:59:26 -0700392extern const char *std_validation_str;
Jon Ashburn37e7f972015-04-06 10:58:22 -0600393
Courtney Goeltzenleuchter67146d02015-06-10 17:39:03 -0600394struct loader_msg_callback_map_entry {
Courtney Goeltzenleuchter725db942015-12-09 15:48:16 -0700395 VkDebugReportCallbackEXT icd_obj;
396 VkDebugReportCallbackEXT loader_obj;
Courtney Goeltzenleuchter67146d02015-06-10 17:39:03 -0600397};
398
Jon Ashburnc4e9ae62016-02-26 13:14:27 -0700399/* helper function definitions */
400void *loader_heap_alloc(const struct loader_instance *instance, size_t size,
401 VkSystemAllocationScope allocationScope);
402
403void loader_heap_free(const struct loader_instance *instance, void *pMemory);
404
405void *loader_tls_heap_alloc(size_t size);
406
407void loader_tls_heap_free(void *pMemory);
408
Jon Ashburn663f8312016-02-12 08:20:06 -0700409void loader_log(const struct loader_instance *inst, VkFlags msg_type,
Jon Ashburnc4e9ae62016-02-26 13:14:27 -0700410 int32_t msg_code, const char *format, ...);
Jon Ashburn663f8312016-02-12 08:20:06 -0700411
Jon Ashburn1c75aec2016-02-02 17:47:28 -0700412bool compare_vk_extension_properties(const VkExtensionProperties *op1,
413 const VkExtensionProperties *op2);
Courtney Goeltzenleuchter67146d02015-06-10 17:39:03 -0600414
Mark Lobodzinski8d325802016-02-02 18:53:34 -0700415VkResult loader_validate_layers(const struct loader_instance *inst,
416 const uint32_t layer_count,
Jon Ashburn1c75aec2016-02-02 17:47:28 -0700417 const char *const *ppEnabledLayerNames,
418 const struct loader_layer_list *list);
Courtney Goeltzenleuchter76ece702015-07-06 17:45:08 -0600419
420VkResult loader_validate_instance_extensions(
Mark Lobodzinski8d325802016-02-02 18:53:34 -0700421 const struct loader_instance *inst,
Jon Ashburn1c75aec2016-02-02 17:47:28 -0700422 const struct loader_extension_list *icd_exts,
423 const struct loader_layer_list *instance_layer,
424 const VkInstanceCreateInfo *pCreateInfo);
Courtney Goeltzenleuchter76ece702015-07-06 17:45:08 -0600425
Jon Ashburne0367472015-08-18 18:04:47 -0600426void loader_initialize(void);
Jon Ashburn1c75aec2016-02-02 17:47:28 -0700427bool has_vk_extension_property_array(const VkExtensionProperties *vk_ext_prop,
428 const uint32_t count,
429 const VkExtensionProperties *ext_array);
430bool has_vk_extension_property(const VkExtensionProperties *vk_ext_prop,
431 const struct loader_extension_list *ext_list);
Jon Ashburn13482452015-05-12 17:26:48 -0600432
Jon Ashburn1c75aec2016-02-02 17:47:28 -0700433VkResult loader_add_to_ext_list(const struct loader_instance *inst,
434 struct loader_extension_list *ext_list,
435 uint32_t prop_list_count,
436 const VkExtensionProperties *props);
Jon Ashburnc466da52016-04-15 09:25:03 -0600437VkResult
438loader_add_to_dev_ext_list(const struct loader_instance *inst,
439 struct loader_device_extension_list *ext_list,
440 const VkExtensionProperties *props,
441 uint32_t entry_count, char **entrys);
Jon Ashburnc4e9ae62016-02-26 13:14:27 -0700442VkResult loader_add_device_extensions(const struct loader_instance *inst,
Jon Ashburnc466da52016-04-15 09:25:03 -0600443 PFN_vkEnumerateDeviceExtensionProperties
444 fpEnumerateDeviceExtensionProperties,
Jon Ashburnc4e9ae62016-02-26 13:14:27 -0700445 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],
Jon Ashburnc466da52016-04-15 09:25:03 -0600461 uint32_t *layer_count, char const *const **ppp_layer_names);
Chris Forbes7333fdd2016-04-06 20:49:02 +1200462void loader_delete_shadow_dev_layer_names(const struct loader_instance *inst,
463 const VkDeviceCreateInfo *orig,
464 VkDeviceCreateInfo *ours);
465void loader_delete_shadow_inst_layer_names(const struct loader_instance *inst,
466 const VkInstanceCreateInfo *orig,
467 VkInstanceCreateInfo *ours);
Jon Ashburn1c75aec2016-02-02 17:47:28 -0700468void loader_add_to_layer_list(const struct loader_instance *inst,
469 struct loader_layer_list *list,
470 uint32_t prop_list_count,
471 const struct loader_layer_properties *props);
Jon Ashburnc466da52016-04-15 09:25:03 -0600472void loader_find_layer_name_add_list(
473 const struct loader_instance *inst, const char *name,
474 const enum layer_type type, const struct loader_layer_list *search_list,
475 struct loader_layer_list *found_list);
Jon Ashburn1c75aec2016-02-02 17:47:28 -0700476void loader_scanned_icd_clear(const struct loader_instance *inst,
477 struct loader_icd_libs *icd_libs);
478void loader_icd_scan(const struct loader_instance *inst,
479 struct loader_icd_libs *icds);
480void loader_layer_scan(const struct loader_instance *inst,
481 struct loader_layer_list *instance_layers,
482 struct loader_layer_list *device_layers);
Jeremy Hayes10d78f12016-04-01 11:40:26 -0600483void loader_implicit_layer_scan(const struct loader_instance *inst,
Jon Ashburnc466da52016-04-15 09:25:03 -0600484 struct loader_layer_list *instance_layers,
485 struct loader_layer_list *device_layers);
Jon Ashburne0367472015-08-18 18:04:47 -0600486void loader_get_icd_loader_instance_extensions(
Jon Ashburn1c75aec2016-02-02 17:47:28 -0700487 const struct loader_instance *inst, struct loader_icd_libs *icd_libs,
488 struct loader_extension_list *inst_exts);
489struct loader_icd *loader_get_icd_and_device(const VkDevice device,
490 struct loader_device **found_dev);
Jon Ashburnc4e9ae62016-02-26 13:14:27 -0700491void loader_init_dispatch_dev_ext(struct loader_instance *inst,
492 struct loader_device *dev);
Jon Ashburn1c75aec2016-02-02 17:47:28 -0700493void *loader_dev_ext_gpa(struct loader_instance *inst, const char *funcName);
494void *loader_get_dev_ext_trampoline(uint32_t index);
495struct loader_instance *loader_get_instance(const VkInstance instance);
Jon Ashburnd3cf9552016-04-20 13:21:17 -0600496void loader_deactivate_layers(const struct loader_instance *instance,
497 struct loader_layer_list *list);
Jon Ashburnc4e9ae62016-02-26 13:14:27 -0700498struct loader_device *
Piers Daniell82107a62016-03-29 11:51:11 -0600499loader_create_logical_device(const struct loader_instance *inst);
500void loader_add_logical_device(const struct loader_instance *inst,
501 struct loader_icd *icd,
502 struct loader_device *found_dev);
Jon Ashburn1c75aec2016-02-02 17:47:28 -0700503void loader_remove_logical_device(const struct loader_instance *inst,
504 struct loader_icd *icd,
505 struct loader_device *found_dev);
506VkResult
507loader_enable_instance_layers(struct loader_instance *inst,
508 const VkInstanceCreateInfo *pCreateInfo,
509 const struct loader_layer_list *instance_layers);
Jon Ashburn10f4e822015-06-10 10:06:06 -0600510void loader_deactivate_instance_layers(struct loader_instance *instance);
Courtney Goeltzenleuchter0bd705c2016-01-08 12:18:43 -0700511
Jon Ashburn1c75aec2016-02-02 17:47:28 -0700512VkResult loader_create_instance_chain(const VkInstanceCreateInfo *pCreateInfo,
513 const VkAllocationCallbacks *pAllocator,
514 struct loader_instance *inst,
Jon Ashburnd1205a92016-02-03 12:37:30 -0700515 VkInstance *created_instance);
Courtney Goeltzenleuchter0bd705c2016-01-08 12:18:43 -0700516
Jon Ashburn1c75aec2016-02-02 17:47:28 -0700517void loader_activate_instance_layer_extensions(struct loader_instance *inst,
518 VkInstance created_inst);
Jon Ashburnc4e9ae62016-02-26 13:14:27 -0700519VkResult
520loader_enable_device_layers(const struct loader_instance *inst,
Jon Ashburnc4e9ae62016-02-26 13:14:27 -0700521 struct loader_layer_list *activated_layer_list,
522 const VkDeviceCreateInfo *pCreateInfo,
523 const struct loader_layer_list *device_layers);
Courtney Goeltzenleuchter71b454b2015-07-05 11:28:29 -0600524
Jon Ashburnc466da52016-04-15 09:25:03 -0600525VkResult
526loader_create_device_chain(const struct loader_physical_device_tramp *pd,
527 const VkDeviceCreateInfo *pCreateInfo,
528 const VkAllocationCallbacks *pAllocator,
529 const struct loader_instance *inst,
530 struct loader_device *dev);
Jon Ashburnc4e9ae62016-02-26 13:14:27 -0700531VkResult loader_validate_device_extensions(
Jon Ashburnc3519e42016-03-24 15:49:57 -0600532 struct loader_physical_device_tramp *phys_dev,
Jon Ashburnc4e9ae62016-02-26 13:14:27 -0700533 const struct loader_layer_list *activated_device_layers,
Jon Ashburnfd02a0f2016-03-01 19:51:07 -0700534 const struct loader_extension_list *icd_exts,
Jon Ashburnc4e9ae62016-02-26 13:14:27 -0700535 const VkDeviceCreateInfo *pCreateInfo);
Courtney Goeltzenleuchter71b454b2015-07-05 11:28:29 -0600536
Jon Ashburnc4e9ae62016-02-26 13:14:27 -0700537/* instance layer chain termination entrypoint definitions */
538VKAPI_ATTR VkResult VKAPI_CALL
539terminator_CreateInstance(const VkInstanceCreateInfo *pCreateInfo,
540 const VkAllocationCallbacks *pAllocator,
541 VkInstance *pInstance);
Jon Ashburnb4dee9c2015-08-28 15:19:27 -0600542
Jon Ashburnc4e9ae62016-02-26 13:14:27 -0700543VKAPI_ATTR void VKAPI_CALL
544terminator_DestroyInstance(VkInstance instance,
545 const VkAllocationCallbacks *pAllocator);
Jon Ashburnb4dee9c2015-08-28 15:19:27 -0600546
Jon Ashburnc4e9ae62016-02-26 13:14:27 -0700547VKAPI_ATTR VkResult VKAPI_CALL
548terminator_EnumeratePhysicalDevices(VkInstance instance,
549 uint32_t *pPhysicalDeviceCount,
550 VkPhysicalDevice *pPhysicalDevices);
551
552VKAPI_ATTR void VKAPI_CALL
553terminator_GetPhysicalDeviceFeatures(VkPhysicalDevice physicalDevice,
554 VkPhysicalDeviceFeatures *pFeatures);
555
556VKAPI_ATTR void VKAPI_CALL
557terminator_GetPhysicalDeviceFormatProperties(VkPhysicalDevice physicalDevice,
558 VkFormat format,
559 VkFormatProperties *pFormatInfo);
560
561VKAPI_ATTR VkResult VKAPI_CALL
562terminator_GetPhysicalDeviceImageFormatProperties(
563 VkPhysicalDevice physicalDevice, VkFormat format, VkImageType type,
564 VkImageTiling tiling, VkImageUsageFlags usage, VkImageCreateFlags flags,
565 VkImageFormatProperties *pImageFormatProperties);
566
567VKAPI_ATTR void VKAPI_CALL
568terminator_GetPhysicalDeviceSparseImageFormatProperties(
569 VkPhysicalDevice physicalDevice, VkFormat format, VkImageType type,
570 VkSampleCountFlagBits samples, VkImageUsageFlags usage,
571 VkImageTiling tiling, uint32_t *pNumProperties,
572 VkSparseImageFormatProperties *pProperties);
573
574VKAPI_ATTR void VKAPI_CALL
575terminator_GetPhysicalDeviceProperties(VkPhysicalDevice physicalDevice,
576 VkPhysicalDeviceProperties *pProperties);
577
578VKAPI_ATTR VkResult VKAPI_CALL terminator_EnumerateDeviceExtensionProperties(
579 VkPhysicalDevice physicalDevice, const char *pLayerName, uint32_t *pCount,
580 VkExtensionProperties *pProperties);
581
582VKAPI_ATTR VkResult VKAPI_CALL
583terminator_EnumerateDeviceLayerProperties(VkPhysicalDevice physicalDevice,
584 uint32_t *pCount,
585 VkLayerProperties *pProperties);
586
587VKAPI_ATTR void VKAPI_CALL terminator_GetPhysicalDeviceQueueFamilyProperties(
588 VkPhysicalDevice physicalDevice, uint32_t *pCount,
589 VkQueueFamilyProperties *pProperties);
590
591VKAPI_ATTR void VKAPI_CALL terminator_GetPhysicalDeviceMemoryProperties(
592 VkPhysicalDevice physicalDevice,
593 VkPhysicalDeviceMemoryProperties *pProperties);
594
595VKAPI_ATTR VkResult VKAPI_CALL
596terminator_CreateDevice(VkPhysicalDevice gpu,
597 const VkDeviceCreateInfo *pCreateInfo,
598 const VkAllocationCallbacks *pAllocator,
599 VkDevice *pDevice);
Mark Lobodzinski8d325802016-02-02 18:53:34 -0700600
Jon Ashburnb1cdf2e2016-02-10 20:50:19 -0700601VkStringErrorFlags vk_string_validate(const int max_length,
602 const char *char_array);
Mark Lobodzinski8d325802016-02-02 18:53:34 -0700603
Chia-I Wuc1e0f962014-08-04 08:03:57 +0800604#endif /* LOADER_H */