blob: 415dfc7610660f5d181b0cd0b4b616cf9b35e51a [file] [log] [blame]
Chia-I Wu468e3c32014-08-04 08:03:57 +08001/*
Chia-I Wu468e3c32014-08-04 08:03:57 +08002 *
Jon Ashburn44aed662016-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 Goeltzenleuchterebbb96d2015-12-02 14:53:22 -07006 * Copyright (C) 2015 Google Inc.
Chia-I Wu468e3c32014-08-04 08:03:57 +08007 *
Jon Ashburn44aed662016-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 Wu468e3c32014-08-04 08:03:57 +080014 *
Jon Ashburn44aed662016-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 Wu468e3c32014-08-04 08:03:57 +080017 *
Jon Ashburn44aed662016-02-02 17:47:28 -070018 * THE MATERIALS ARE PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
Chia-I Wu468e3c32014-08-04 08:03:57 +080019 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
Jon Ashburn44aed662016-02-02 17:47:28 -070020 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
Chia-I Wu44e42362014-09-02 08:32:09 +080021 *
Jon Ashburn44aed662016-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 Goeltzenleuchter96cd7952015-10-30 11:14:30 -060029 * Author: Chia-I Wu <olvaffe@gmail.com>
30 * Author: Chia-I Wu <olv@lunarg.com>
Jon Ashburn44aed662016-02-02 17:47:28 -070031 * Author: Mark Lobodzinski <mark@LunarG.com>
Courtney Goeltzenleuchter96cd7952015-10-30 11:14:30 -060032 *
Chia-I Wu468e3c32014-08-04 08:03:57 +080033 */
34
35#ifndef LOADER_H
36#define LOADER_H
37
David Pinedo329ca9e2015-11-06 12:54:48 -070038#include <vulkan/vulkan.h>
Aaron Karp074e0d52016-03-13 16:41:59 -040039#include "vk_loader_platform.h"
Ian Elliott64070a82015-11-17 17:29:40 -070040
David Pinedo329ca9e2015-11-06 12:54:48 -070041#include <vulkan/vk_layer.h>
42#include <vulkan/vk_icd.h>
Chia-I Wu1d6731b2015-04-11 15:34:07 +080043#include <assert.h>
44
Chia-I Wu468e3c32014-08-04 08:03:57 +080045#if defined(__GNUC__) && __GNUC__ >= 4
Jon Ashburn44aed662016-02-02 17:47:28 -070046#define LOADER_EXPORT __attribute__((visibility("default")))
Chia-I Wu468e3c32014-08-04 08:03:57 +080047#elif defined(__SUNPRO_C) && (__SUNPRO_C >= 0x590)
Jon Ashburn44aed662016-02-02 17:47:28 -070048#define LOADER_EXPORT __attribute__((visibility("default")))
Chia-I Wu468e3c32014-08-04 08:03:57 +080049#else
Jon Ashburn44aed662016-02-02 17:47:28 -070050#define LOADER_EXPORT
Chia-I Wu468e3c32014-08-04 08:03:57 +080051#endif
52
Jon Ashburn0b728052015-08-04 10:22:33 -060053#define MAX_STRING_SIZE 1024
Courtney Goeltzenleuchter18061cd2015-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 Ashburnfce93d92015-05-12 17:26:48 -060057
Jon Ashburn68a63922015-07-02 09:40:15 -060058enum layer_type {
Jon Ashburn535bd002015-07-02 16:10:32 -060059 VK_LAYER_TYPE_DEVICE_EXPLICIT = 0x1,
60 VK_LAYER_TYPE_INSTANCE_EXPLICIT = 0x2,
Jon Ashburn715de582016-02-10 20:59:26 -070061 VK_LAYER_TYPE_GLOBAL_EXPLICIT = 0x3, // instance and device layer, bitwise
Jon Ashburn535bd002015-07-02 16:10:32 -060062 VK_LAYER_TYPE_DEVICE_IMPLICIT = 0x4,
63 VK_LAYER_TYPE_INSTANCE_IMPLICIT = 0x8,
Jon Ashburn715de582016-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 Ashburn68a63922015-07-02 09:40:15 -060066};
67
Mark Lobodzinskic882eee2016-02-02 18:53:34 -070068typedef enum VkStringErrorFlagBits {
Jon Ashburn7ec85cd2016-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 Lobodzinskic882eee2016-02-02 18:53:34 -070072} VkStringErrorFlagBits;
73typedef VkFlags VkStringErrorFlags;
74
Jon Ashburn7ec85cd2016-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 Lobodzinskic882eee2016-02-02 18:53:34 -070084
Mark Lobodzinski0411f592016-03-15 17:23:12 -060085static const char std_validation_names[8][VK_MAX_EXTENSION_NAME_SIZE] = {
Jon Ashburn9b2a8c92016-04-15 09:25:03 -060086 "VK_LAYER_GOOGLE_threading", "VK_LAYER_LUNARG_parameter_validation",
Jon Ashburn715de582016-02-10 20:59:26 -070087 "VK_LAYER_LUNARG_device_limits", "VK_LAYER_LUNARG_object_tracker",
Jon Ashburn9b2a8c92016-04-15 09:25:03 -060088 "VK_LAYER_LUNARG_image", "VK_LAYER_LUNARG_core_validation",
89 "VK_LAYER_LUNARG_swapchain", "VK_LAYER_GOOGLE_unique_objects"};
Jon Ashburn715de582016-02-10 20:59:26 -070090
Jon Ashburn8f6be302015-12-10 08:51:10 -070091// form of all dynamic lists/arrays
92// only the list element should be changed
93struct loader_generic_list {
94 size_t capacity;
95 uint32_t count;
96 void *list;
97};
98
Courtney Goeltzenleuchter1c7c65d2015-06-10 17:39:03 -060099struct loader_extension_list {
100 size_t capacity;
101 uint32_t count;
Jon Ashburnc4748dc2015-08-04 11:14:18 -0600102 VkExtensionProperties *list;
Courtney Goeltzenleuchter1c7c65d2015-06-10 17:39:03 -0600103};
104
Jon Ashburn738136f2015-12-10 18:17:34 -0700105struct loader_dev_ext_props {
106 VkExtensionProperties props;
107 uint32_t entrypoint_count;
108 char **entrypoints;
109};
110
111struct loader_device_extension_list {
112 size_t capacity;
113 uint32_t count;
114 struct loader_dev_ext_props *list;
115};
116
Jon Ashburn68a63922015-07-02 09:40:15 -0600117struct loader_name_value {
Jon Ashburn0b728052015-08-04 10:22:33 -0600118 char name[MAX_STRING_SIZE];
119 char value[MAX_STRING_SIZE];
Jon Ashburn68a63922015-07-02 09:40:15 -0600120};
121
122struct loader_lib_info {
Jon Ashburne9ca8fa2015-08-20 16:35:30 -0600123 char lib_name[MAX_STRING_SIZE];
Jon Ashburn68a63922015-07-02 09:40:15 -0600124 uint32_t ref_count;
125 loader_platform_dl_handle lib_handle;
126};
Courtney Goeltzenleuchter1c7c65d2015-06-10 17:39:03 -0600127
Jon Ashburn68a63922015-07-02 09:40:15 -0600128struct loader_layer_functions {
Jon Ashburn0b728052015-08-04 10:22:33 -0600129 char str_gipa[MAX_STRING_SIZE];
130 char str_gdpa[MAX_STRING_SIZE];
Jon Ashburn68a63922015-07-02 09:40:15 -0600131 PFN_vkGetInstanceProcAddr get_instance_proc_addr;
132 PFN_vkGetDeviceProcAddr get_device_proc_addr;
133};
Courtney Goeltzenleuchter1c7c65d2015-06-10 17:39:03 -0600134
Jon Ashburn68a63922015-07-02 09:40:15 -0600135struct loader_layer_properties {
Courtney Goeltzenleuchter18061cd2015-06-29 15:39:26 -0600136 VkLayerProperties info;
Jon Ashburn68a63922015-07-02 09:40:15 -0600137 enum layer_type type;
Jon Ashburne9ca8fa2015-08-20 16:35:30 -0600138 char lib_name[MAX_STRING_SIZE];
Jon Ashburn68a63922015-07-02 09:40:15 -0600139 struct loader_layer_functions functions;
140 struct loader_extension_list instance_extension_list;
Jon Ashburn738136f2015-12-10 18:17:34 -0700141 struct loader_device_extension_list device_extension_list;
Jon Ashburn68a63922015-07-02 09:40:15 -0600142 struct loader_name_value disable_env_var;
143 struct loader_name_value enable_env_var;
144};
145
146struct loader_layer_list {
147 size_t capacity;
148 uint32_t count;
149 struct loader_layer_properties *list;
Jon Ashburnfce93d92015-05-12 17:26:48 -0600150};
151
Courtney Goeltzenleuchterc5cf7d72015-07-05 12:53:31 -0600152struct loader_layer_library_list {
153 size_t capacity;
154 uint32_t count;
155 struct loader_lib_info *list;
156};
157
Jon Ashburn429e19f2015-11-17 15:31:02 -0700158struct loader_dispatch_hash_list {
159 size_t capacity;
160 uint32_t count;
Jon Ashburn44aed662016-02-02 17:47:28 -0700161 uint32_t *index; // index into the dev_ext dispatch table
Jon Ashburn429e19f2015-11-17 15:31:02 -0700162};
163
164#define MAX_NUM_DEV_EXTS 250
Jon Ashburn44aed662016-02-02 17:47:28 -0700165// loader_dispatch_hash_entry and loader_dev_ext_dispatch_table.DevExt have one
166// to one
Jon Ashburn429e19f2015-11-17 15:31:02 -0700167// correspondence; one loader_dispatch_hash_entry for one DevExt dispatch entry.
168// Also have a one to one correspondence with functions in dev_ext_trampoline.c
169struct loader_dispatch_hash_entry {
170 char *func_name;
Jon Ashburn44aed662016-02-02 17:47:28 -0700171 struct loader_dispatch_hash_list list; // to handle hashing collisions
Jon Ashburn429e19f2015-11-17 15:31:02 -0700172};
173
Jon Ashburn44aed662016-02-02 17:47:28 -0700174typedef void(VKAPI_PTR *PFN_vkDevExt)(VkDevice device);
Jon Ashburn429e19f2015-11-17 15:31:02 -0700175struct loader_dev_ext_dispatch_table {
176 PFN_vkDevExt DevExt[MAX_NUM_DEV_EXTS];
177};
178
179struct loader_dev_dispatch_table {
180 VkLayerDispatchTable core_dispatch;
181 struct loader_dev_ext_dispatch_table ext_dispatch;
182};
183
Jon Ashburncb5a5ac2015-06-10 10:06:06 -0600184/* per CreateDevice structure */
185struct loader_device {
Jon Ashburn429e19f2015-11-17 15:31:02 -0700186 struct loader_dev_dispatch_table loader_dispatch;
Jon Ashburn44aed662016-02-02 17:47:28 -0700187 VkDevice device; // device object from the icd
Jon Ashburncb5a5ac2015-06-10 10:06:06 -0600188
Jon Ashburn44aed662016-02-02 17:47:28 -0700189 uint32_t app_extension_count;
Jon Ashburncb5a5ac2015-06-10 10:06:06 -0600190 VkExtensionProperties *app_extension_props;
191
Courtney Goeltzenleuchter18061cd2015-06-29 15:39:26 -0600192 struct loader_layer_list activated_layer_list;
Jon Ashburncb5a5ac2015-06-10 10:06:06 -0600193
194 struct loader_device *next;
195};
196
Jon Ashburn60699262015-06-10 16:11:42 -0600197/* per ICD structure */
Jon Ashburn2666e2f2015-05-15 15:09:35 -0600198struct loader_icd {
Jon Ashburne9ca8fa2015-08-20 16:35:30 -0600199 // pointers to find other structs
200 const struct loader_scanned_icds *this_icd_lib;
201 const struct loader_instance *this_instance;
Jon Ashburncb5a5ac2015-06-10 10:06:06 -0600202 struct loader_device *logical_device_list;
Jon Ashburn44aed662016-02-02 17:47:28 -0700203 VkInstance instance; // instance object from the icd
Jon Ashburn1245cec2015-05-18 13:20:15 -0600204 PFN_vkGetDeviceProcAddr GetDeviceProcAddr;
Jon Ashburn2666e2f2015-05-15 15:09:35 -0600205 PFN_vkDestroyInstance DestroyInstance;
206 PFN_vkEnumeratePhysicalDevices EnumeratePhysicalDevices;
Chris Forbesd7576302015-06-21 22:55:02 +1200207 PFN_vkGetPhysicalDeviceFeatures GetPhysicalDeviceFeatures;
Courtney Goeltzenleuchter4da96aa2015-07-12 12:52:09 -0600208 PFN_vkGetPhysicalDeviceFormatProperties GetPhysicalDeviceFormatProperties;
Jon Ashburn44aed662016-02-02 17:47:28 -0700209 PFN_vkGetPhysicalDeviceImageFormatProperties
210 GetPhysicalDeviceImageFormatProperties;
Jon Ashburn2666e2f2015-05-15 15:09:35 -0600211 PFN_vkCreateDevice CreateDevice;
Tony Barbour426b9052015-06-24 16:06:58 -0600212 PFN_vkGetPhysicalDeviceProperties GetPhysicalDeviceProperties;
Jon Ashburn44aed662016-02-02 17:47:28 -0700213 PFN_vkGetPhysicalDeviceQueueFamilyProperties
214 GetPhysicalDeviceQueueFamilyProperties;
Tony Barbour426b9052015-06-24 16:06:58 -0600215 PFN_vkGetPhysicalDeviceMemoryProperties GetPhysicalDeviceMemoryProperties;
Courtney Goeltzenleuchter74c4ce92015-09-14 17:22:16 -0600216 PFN_vkEnumerateDeviceExtensionProperties EnumerateDeviceExtensionProperties;
Jon Ashburn44aed662016-02-02 17:47:28 -0700217 PFN_vkGetPhysicalDeviceSparseImageFormatProperties
218 GetPhysicalDeviceSparseImageFormatProperties;
Courtney Goeltzenleuchteracb13592015-12-09 15:48:16 -0700219 PFN_vkCreateDebugReportCallbackEXT CreateDebugReportCallbackEXT;
220 PFN_vkDestroyDebugReportCallbackEXT DestroyDebugReportCallbackEXT;
221 PFN_vkDebugReportMessageEXT DebugReportMessageEXT;
Ian Elliott338dedb2015-08-21 15:09:33 -0600222 PFN_vkGetPhysicalDeviceSurfaceSupportKHR GetPhysicalDeviceSurfaceSupportKHR;
Jon Ashburn44aed662016-02-02 17:47:28 -0700223 PFN_vkGetPhysicalDeviceSurfaceCapabilitiesKHR
224 GetPhysicalDeviceSurfaceCapabilitiesKHR;
Ian Elliott8cda1802015-11-19 16:05:09 -0700225 PFN_vkGetPhysicalDeviceSurfaceFormatsKHR GetPhysicalDeviceSurfaceFormatsKHR;
Jon Ashburn44aed662016-02-02 17:47:28 -0700226 PFN_vkGetPhysicalDeviceSurfacePresentModesKHR
227 GetPhysicalDeviceSurfacePresentModesKHR;
Ian Elliott4e309e92015-11-24 15:39:10 -0700228#ifdef VK_USE_PLATFORM_WIN32_KHR
Jon Ashburn44aed662016-02-02 17:47:28 -0700229 PFN_vkGetPhysicalDeviceWin32PresentationSupportKHR
230 GetPhysicalDeviceWin32PresentationSupportKHR;
Ian Elliott4e309e92015-11-24 15:39:10 -0700231#endif
232#ifdef VK_USE_PLATFORM_MIR_KHR
Jon Ashburn44aed662016-02-02 17:47:28 -0700233 PFN_vkGetPhysicalDeviceMirPresentationSupportKHR
234 GetPhysicalDeviceMirPresentvationSupportKHR;
Ian Elliott4e309e92015-11-24 15:39:10 -0700235#endif
236#ifdef VK_USE_PLATFORM_WAYLAND_KHR
Jon Ashburn44aed662016-02-02 17:47:28 -0700237 PFN_vkGetPhysicalDeviceWaylandPresentationSupportKHR
238 GetPhysicalDeviceWaylandPresentationSupportKHR;
Ian Elliott4e309e92015-11-24 15:39:10 -0700239#endif
240#ifdef VK_USE_PLATFORM_XCB_KHR
Jon Ashburn44aed662016-02-02 17:47:28 -0700241 PFN_vkGetPhysicalDeviceXcbPresentationSupportKHR
242 GetPhysicalDeviceXcbPresentationSupportKHR;
Ian Elliott4e309e92015-11-24 15:39:10 -0700243#endif
244#ifdef VK_USE_PLATFORM_XLIB_KHR
Jon Ashburn44aed662016-02-02 17:47:28 -0700245 PFN_vkGetPhysicalDeviceXlibPresentationSupportKHR
246 GetPhysicalDeviceXlibPresentationSupportKHR;
Ian Elliott4e309e92015-11-24 15:39:10 -0700247#endif
Jon Ashburn00df0452016-03-08 09:30:30 -0700248 PFN_vkGetPhysicalDeviceDisplayPropertiesKHR
249 GetPhysicalDeviceDisplayPropertiesKHR;
250 PFN_vkGetPhysicalDeviceDisplayPlanePropertiesKHR
251 GetPhysicalDeviceDisplayPlanePropertiesKHR;
252 PFN_vkGetDisplayPlaneSupportedDisplaysKHR
253 GetDisplayPlaneSupportedDisplaysKHR;
Jon Ashburn9b2a8c92016-04-15 09:25:03 -0600254 PFN_vkGetDisplayModePropertiesKHR GetDisplayModePropertiesKHR;
255 PFN_vkCreateDisplayModeKHR CreateDisplayModeKHR;
256 PFN_vkGetDisplayPlaneCapabilitiesKHR GetDisplayPlaneCapabilitiesKHR;
257 PFN_vkCreateDisplayPlaneSurfaceKHR CreateDisplayPlaneSurfaceKHR;
258 PFN_vkDestroySurfaceKHR DestroySurfaceKHR;
Jon Ashburncb5a5ac2015-06-10 10:06:06 -0600259 struct loader_icd *next;
Jon Ashburn2666e2f2015-05-15 15:09:35 -0600260};
261
Jon Ashburn754f1992015-08-18 18:04:47 -0600262/* per ICD library structure */
263struct loader_icd_libs {
264 size_t capacity;
265 uint32_t count;
266 struct loader_scanned_icds *list;
267};
268
Jon Ashburn60699262015-06-10 16:11:42 -0600269/* per instance structure */
Jon Ashburnfce93d92015-05-12 17:26:48 -0600270struct loader_instance {
Jon Ashburn2666e2f2015-05-15 15:09:35 -0600271 VkLayerInstanceDispatchTable *disp; // must be first entry in structure
272
Jon Ashburn87660432016-03-01 19:51:07 -0700273 uint32_t total_gpu_count; // count of the next two arrays
274 struct loader_physical_device *phys_devs_term;
Jon Ashburn9b2a8c92016-04-15 09:25:03 -0600275 struct loader_physical_device_tramp *
276 phys_devs; // tramp wrapped physDev obj list
Courtney Goeltzenleuchter1c7c65d2015-06-10 17:39:03 -0600277 uint32_t total_icd_count;
Jon Ashburnfce93d92015-05-12 17:26:48 -0600278 struct loader_icd *icds;
279 struct loader_instance *next;
Jon Ashburn44aed662016-02-02 17:47:28 -0700280 struct loader_extension_list ext_list; // icds and loaders extensions
Jon Ashburn754f1992015-08-18 18:04:47 -0600281 struct loader_icd_libs icd_libs;
Jon Ashburne9ca8fa2015-08-20 16:35:30 -0600282 struct loader_layer_list instance_layer_list;
283 struct loader_layer_list device_layer_list;
Jon Ashburn429e19f2015-11-17 15:31:02 -0700284 struct loader_dispatch_hash_entry disp_hash[MAX_NUM_DEV_EXTS];
Jon Ashburne9ca8fa2015-08-20 16:35:30 -0600285
Courtney Goeltzenleuchter1c7c65d2015-06-10 17:39:03 -0600286 struct loader_msg_callback_map_entry *icd_msg_callback_map;
287
Courtney Goeltzenleuchter18061cd2015-06-29 15:39:26 -0600288 struct loader_layer_list activated_layer_list;
Courtney Goeltzenleuchter1c7c65d2015-06-10 17:39:03 -0600289
Jon Ashburn9b2a8c92016-04-15 09:25:03 -0600290 VkInstance instance; // layers/ICD instance returned to trampoline
Courtney Goeltzenleuchter2bdf6da2016-01-08 12:18:43 -0700291
Courtney Goeltzenleuchter1c7c65d2015-06-10 17:39:03 -0600292 bool debug_report_enabled;
Courtney Goeltzenleuchter1c7c65d2015-06-10 17:39:03 -0600293 VkLayerDbgFunctionNode *DbgFunctionHead;
Ian Elliott01b78322016-03-31 10:48:19 -0600294 uint32_t num_tmp_callbacks;
295 VkDebugReportCallbackCreateInfoEXT *tmp_dbg_create_infos;
296 VkDebugReportCallbackEXT *tmp_callbacks;
Courtney Goeltzenleuchterb620ace2015-07-05 11:28:29 -0600297
Chia-I Wu1f851912015-10-27 18:04:07 +0800298 VkAllocationCallbacks alloc_callbacks;
Ian Elliott1d73e662015-07-06 14:36:13 -0600299
Ian Elliotta81e8ac2015-10-30 15:28:23 -0600300 bool wsi_surface_enabled;
Mark Lobodzinskib3e934d2015-12-10 16:25:21 -0700301#ifdef VK_USE_PLATFORM_WIN32_KHR
Ian Elliotta81e8ac2015-10-30 15:28:23 -0600302 bool wsi_win32_surface_enabled;
Mark Lobodzinskib3e934d2015-12-10 16:25:21 -0700303#endif
304#ifdef VK_USE_PLATFORM_MIR_KHR
Ian Elliotta81e8ac2015-10-30 15:28:23 -0600305 bool wsi_mir_surface_enabled;
Mark Lobodzinskib3e934d2015-12-10 16:25:21 -0700306#endif
307#ifdef VK_USE_PLATFORM_WAYLAND_KHR
Ian Elliotta81e8ac2015-10-30 15:28:23 -0600308 bool wsi_wayland_surface_enabled;
Mark Lobodzinskib3e934d2015-12-10 16:25:21 -0700309#endif
310#ifdef VK_USE_PLATFORM_XCB_KHR
Ian Elliotta81e8ac2015-10-30 15:28:23 -0600311 bool wsi_xcb_surface_enabled;
Mark Lobodzinskib3e934d2015-12-10 16:25:21 -0700312#endif
313#ifdef VK_USE_PLATFORM_XLIB_KHR
Ian Elliotta81e8ac2015-10-30 15:28:23 -0600314 bool wsi_xlib_surface_enabled;
Mark Lobodzinskib3e934d2015-12-10 16:25:21 -0700315#endif
316#ifdef VK_USE_PLATFORM_ANDROID_KHR
317 bool wsi_android_surface_enabled;
318#endif
Jon Ashburn00df0452016-03-08 09:30:30 -0700319 bool wsi_display_enabled;
Courtney Goeltzenleuchter1c7c65d2015-06-10 17:39:03 -0600320};
321
Jon Ashburn87660432016-03-01 19:51:07 -0700322/* VkPhysicalDevice requires special treatment by loader. Firstly, terminator
323 * code must be able to get the struct loader_icd to call into the proper
324 * driver (multiple ICD/gpu case). This can be accomplished by wrapping the
325 * created VkPhysicalDevice in loader terminate_EnumeratePhysicalDevices().
Piers Daniellfc500412016-03-29 11:51:11 -0600326 * Secondly, the loader must be able to handle wrapped by layer VkPhysicalDevice
Jon Ashburn87660432016-03-01 19:51:07 -0700327 * in trampoline code. This implies, that the loader trampoline code must also
328 * wrap the VkPhysicalDevice object in trampoline code. Thus, loader has to
329 * wrap the VkPhysicalDevice created object twice. In trampoline code it can't
330 * rely on the terminator object wrapping since a layer may also wrap. Since
331 * trampoline code wraps the VkPhysicalDevice this means all loader trampoline
332 * code that passes a VkPhysicalDevice should unwrap it. */
333
334/* per enumerated PhysicalDevice structure, used to wrap in trampoline code and
335 also same structure used to wrap in terminator code */
Jon Ashburn3c4a1142016-03-24 15:49:57 -0600336struct loader_physical_device_tramp {
337 VkLayerInstanceDispatchTable *disp; // must be first entry in structure
Piers Daniellfc500412016-03-29 11:51:11 -0600338 struct loader_instance *this_instance;
Jon Ashburn9b2a8c92016-04-15 09:25:03 -0600339 VkPhysicalDevice phys_dev; // object from layers/loader terminator
Jon Ashburn3c4a1142016-03-24 15:49:57 -0600340};
341
342/* per enumerated PhysicalDevice structure, used to wrap in terminator code */
Jon Ashburn251258f2015-11-01 14:04:06 -0700343struct loader_physical_device {
344 VkLayerInstanceDispatchTable *disp; // must be first entry in structure
Jon Ashburn251258f2015-11-01 14:04:06 -0700345 struct loader_icd *this_icd;
Jon Ashburn3c4a1142016-03-24 15:49:57 -0600346 VkPhysicalDevice phys_dev; // object from ICD
Jon Ashburn251258f2015-11-01 14:04:06 -0700347};
348
Jon Ashburnfce93d92015-05-12 17:26:48 -0600349struct loader_struct {
350 struct loader_instance *instances;
Courtney Goeltzenleuchter1c7c65d2015-06-10 17:39:03 -0600351
352 unsigned int loaded_layer_lib_count;
Courtney Goeltzenleuchtera2f21d02015-10-07 09:00:34 -0600353 size_t loaded_layer_lib_capacity;
Courtney Goeltzenleuchter1c7c65d2015-06-10 17:39:03 -0600354 struct loader_lib_info *loaded_layer_lib_list;
Jon Ashburn754f1992015-08-18 18:04:47 -0600355 // TODO add ref counting of ICD libraries
Jon Ashburn1b111de2015-07-06 15:40:35 -0600356 // TODO use this struct loader_layer_library_list scanned_layer_libraries;
Jon Ashburn754f1992015-08-18 18:04:47 -0600357 // TODO add list of icd libraries for ref counting them for closure
Courtney Goeltzenleuchter1c7c65d2015-06-10 17:39:03 -0600358};
359
360struct loader_scanned_icds {
361 char *lib_name;
362 loader_platform_dl_handle handle;
Jon Ashburn0083b222015-11-17 17:35:40 -0700363 uint32_t api_version;
Jon Ashburnce7e3d92015-07-16 10:17:29 -0600364 PFN_vkGetInstanceProcAddr GetInstanceProcAddr;
Courtney Goeltzenleuchter1c7c65d2015-06-10 17:39:03 -0600365 PFN_vkCreateInstance CreateInstance;
Jon Ashburn44aed662016-02-02 17:47:28 -0700366 PFN_vkEnumerateInstanceExtensionProperties
367 EnumerateInstanceExtensionProperties;
Jon Ashburnfce93d92015-05-12 17:26:48 -0600368};
369
Jon Ashburn68a63922015-07-02 09:40:15 -0600370static inline struct loader_instance *loader_instance(VkInstance instance) {
Jon Ashburn44aed662016-02-02 17:47:28 -0700371 return (struct loader_instance *)instance;
Jon Ashburn68a63922015-07-02 09:40:15 -0600372}
373
Jon Ashburn87660432016-03-01 19:51:07 -0700374static inline VkPhysicalDevice
375loader_unwrap_physical_device(VkPhysicalDevice physicalDevice) {
Piers Daniell9c28c382016-03-31 14:47:57 -0600376 struct loader_physical_device_tramp *phys_dev =
377 (struct loader_physical_device_tramp *)physicalDevice;
Jon Ashburn87660432016-03-01 19:51:07 -0700378 return phys_dev->phys_dev;
379}
380
Jon Ashburn44aed662016-02-02 17:47:28 -0700381static inline void loader_set_dispatch(void *obj, const void *data) {
382 *((const void **)obj) = data;
Chia-I Wu1d6731b2015-04-11 15:34:07 +0800383}
384
Jon Ashburn44aed662016-02-02 17:47:28 -0700385static inline VkLayerDispatchTable *loader_get_dispatch(const void *obj) {
386 return *((VkLayerDispatchTable **)obj);
Chia-I Wu1d6731b2015-04-11 15:34:07 +0800387}
388
Jon Ashburn44aed662016-02-02 17:47:28 -0700389static inline struct loader_dev_dispatch_table *
390loader_get_dev_dispatch(const void *obj) {
391 return *((struct loader_dev_dispatch_table **)obj);
Jon Ashburn429e19f2015-11-17 15:31:02 -0700392}
393
Jon Ashburn44aed662016-02-02 17:47:28 -0700394static inline VkLayerInstanceDispatchTable *
395loader_get_instance_dispatch(const void *obj) {
396 return *((VkLayerInstanceDispatchTable **)obj);
Jon Ashburnfce93d92015-05-12 17:26:48 -0600397}
398
Jon Ashburn44aed662016-02-02 17:47:28 -0700399static inline void loader_init_dispatch(void *obj, const void *data) {
Jon Ashburn166641e2015-04-15 13:34:33 -0600400#ifdef DEBUG
Chia-I Wu1d6731b2015-04-11 15:34:07 +0800401 assert(valid_loader_magic_value(obj) &&
Jon Ashburn44aed662016-02-02 17:47:28 -0700402 "Incompatible ICD, first dword must be initialized to "
403 "ICD_LOADER_MAGIC. See loader/README.md for details.");
Jon Ashburn166641e2015-04-15 13:34:33 -0600404#endif
Chia-I Wu1d6731b2015-04-11 15:34:07 +0800405
Jon Ashburnda7c20d2015-05-01 18:00:33 -0600406 loader_set_dispatch(obj, data);
Chia-I Wu1d6731b2015-04-11 15:34:07 +0800407}
408
Jon Ashburnfce93d92015-05-12 17:26:48 -0600409/* global variables used across files */
410extern struct loader_struct loader;
Jon Ashburn413d6582015-08-28 15:19:27 -0600411extern THREAD_LOCAL_DECL struct loader_instance *tls_instance;
Jon Ashburn754f1992015-08-18 18:04:47 -0600412extern LOADER_PLATFORM_THREAD_ONCE_DEFINITION(once_init);
Jon Ashburnb40f2562015-05-29 13:15:39 -0600413extern loader_platform_thread_mutex loader_lock;
Jon Ashburnd02fc2c2015-09-22 13:11:00 -0600414extern loader_platform_thread_mutex loader_json_lock;
Jon Ashburnb40f2562015-05-29 13:15:39 -0600415extern const VkLayerInstanceDispatchTable instance_disp;
Jon Ashburn715de582016-02-10 20:59:26 -0700416extern const char *std_validation_str;
Jon Ashburn301c5f02015-04-06 10:58:22 -0600417
Courtney Goeltzenleuchter1c7c65d2015-06-10 17:39:03 -0600418struct loader_msg_callback_map_entry {
Courtney Goeltzenleuchteracb13592015-12-09 15:48:16 -0700419 VkDebugReportCallbackEXT icd_obj;
420 VkDebugReportCallbackEXT loader_obj;
Courtney Goeltzenleuchter1c7c65d2015-06-10 17:39:03 -0600421};
422
Jon Ashburna9c4a572016-02-26 13:14:27 -0700423/* helper function definitions */
424void *loader_heap_alloc(const struct loader_instance *instance, size_t size,
425 VkSystemAllocationScope allocationScope);
426
427void loader_heap_free(const struct loader_instance *instance, void *pMemory);
428
429void *loader_tls_heap_alloc(size_t size);
430
431void loader_tls_heap_free(void *pMemory);
432
Jon Ashburn7d1a53d2016-02-12 08:20:06 -0700433void loader_log(const struct loader_instance *inst, VkFlags msg_type,
Jon Ashburna9c4a572016-02-26 13:14:27 -0700434 int32_t msg_code, const char *format, ...);
Jon Ashburn7d1a53d2016-02-12 08:20:06 -0700435
Jon Ashburn44aed662016-02-02 17:47:28 -0700436bool compare_vk_extension_properties(const VkExtensionProperties *op1,
437 const VkExtensionProperties *op2);
Courtney Goeltzenleuchter1c7c65d2015-06-10 17:39:03 -0600438
Mark Lobodzinskic882eee2016-02-02 18:53:34 -0700439VkResult loader_validate_layers(const struct loader_instance *inst,
440 const uint32_t layer_count,
Jon Ashburn44aed662016-02-02 17:47:28 -0700441 const char *const *ppEnabledLayerNames,
442 const struct loader_layer_list *list);
Courtney Goeltzenleuchter5d9f29b2015-07-06 17:45:08 -0600443
444VkResult loader_validate_instance_extensions(
Mark Lobodzinskic882eee2016-02-02 18:53:34 -0700445 const struct loader_instance *inst,
Jon Ashburn44aed662016-02-02 17:47:28 -0700446 const struct loader_extension_list *icd_exts,
447 const struct loader_layer_list *instance_layer,
448 const VkInstanceCreateInfo *pCreateInfo);
Courtney Goeltzenleuchter5d9f29b2015-07-06 17:45:08 -0600449
Jon Ashburn754f1992015-08-18 18:04:47 -0600450void loader_initialize(void);
Jon Ashburn44aed662016-02-02 17:47:28 -0700451bool has_vk_extension_property_array(const VkExtensionProperties *vk_ext_prop,
452 const uint32_t count,
453 const VkExtensionProperties *ext_array);
454bool has_vk_extension_property(const VkExtensionProperties *vk_ext_prop,
455 const struct loader_extension_list *ext_list);
Jon Ashburnfce93d92015-05-12 17:26:48 -0600456
Jon Ashburn44aed662016-02-02 17:47:28 -0700457VkResult loader_add_to_ext_list(const struct loader_instance *inst,
458 struct loader_extension_list *ext_list,
459 uint32_t prop_list_count,
460 const VkExtensionProperties *props);
Jon Ashburn9b2a8c92016-04-15 09:25:03 -0600461VkResult
462loader_add_to_dev_ext_list(const struct loader_instance *inst,
463 struct loader_device_extension_list *ext_list,
464 const VkExtensionProperties *props,
465 uint32_t entry_count, char **entrys);
Jon Ashburna9c4a572016-02-26 13:14:27 -0700466VkResult loader_add_device_extensions(const struct loader_instance *inst,
Jon Ashburn9b2a8c92016-04-15 09:25:03 -0600467 PFN_vkEnumerateDeviceExtensionProperties
468 fpEnumerateDeviceExtensionProperties,
Jon Ashburna9c4a572016-02-26 13:14:27 -0700469 VkPhysicalDevice physical_device,
470 const char *lib_name,
471 struct loader_extension_list *ext_list);
472bool loader_init_generic_list(const struct loader_instance *inst,
473 struct loader_generic_list *list_info,
474 size_t element_size);
Jon Ashburn44aed662016-02-02 17:47:28 -0700475void loader_destroy_generic_list(const struct loader_instance *inst,
476 struct loader_generic_list *list);
Jon Ashburna9c4a572016-02-26 13:14:27 -0700477void loader_destroy_layer_list(const struct loader_instance *inst,
478 struct loader_layer_list *layer_list);
Jon Ashburn44aed662016-02-02 17:47:28 -0700479void loader_delete_layer_properties(const struct loader_instance *inst,
480 struct loader_layer_list *layer_list);
Jon Ashburn715de582016-02-10 20:59:26 -0700481void loader_expand_layer_names(
482 const struct loader_instance *inst, const char *key_name,
483 uint32_t expand_count,
484 const char expand_names[][VK_MAX_EXTENSION_NAME_SIZE],
Jon Ashburn9b2a8c92016-04-15 09:25:03 -0600485 uint32_t *layer_count, char const *const **ppp_layer_names);
Chris Forbeseef20d02016-04-06 20:49:02 +1200486void loader_delete_shadow_dev_layer_names(const struct loader_instance *inst,
487 const VkDeviceCreateInfo *orig,
488 VkDeviceCreateInfo *ours);
489void loader_delete_shadow_inst_layer_names(const struct loader_instance *inst,
490 const VkInstanceCreateInfo *orig,
491 VkInstanceCreateInfo *ours);
Jon Ashburn44aed662016-02-02 17:47:28 -0700492void loader_add_to_layer_list(const struct loader_instance *inst,
493 struct loader_layer_list *list,
494 uint32_t prop_list_count,
495 const struct loader_layer_properties *props);
Jon Ashburn9b2a8c92016-04-15 09:25:03 -0600496void loader_find_layer_name_add_list(
497 const struct loader_instance *inst, const char *name,
498 const enum layer_type type, const struct loader_layer_list *search_list,
499 struct loader_layer_list *found_list);
Jon Ashburn44aed662016-02-02 17:47:28 -0700500void loader_scanned_icd_clear(const struct loader_instance *inst,
501 struct loader_icd_libs *icd_libs);
502void loader_icd_scan(const struct loader_instance *inst,
503 struct loader_icd_libs *icds);
504void loader_layer_scan(const struct loader_instance *inst,
505 struct loader_layer_list *instance_layers,
506 struct loader_layer_list *device_layers);
Jeremy Hayes0005c0c2016-04-01 11:40:26 -0600507void loader_implicit_layer_scan(const struct loader_instance *inst,
Jon Ashburn9b2a8c92016-04-15 09:25:03 -0600508 struct loader_layer_list *instance_layers,
509 struct loader_layer_list *device_layers);
Jon Ashburn754f1992015-08-18 18:04:47 -0600510void loader_get_icd_loader_instance_extensions(
Jon Ashburn44aed662016-02-02 17:47:28 -0700511 const struct loader_instance *inst, struct loader_icd_libs *icd_libs,
512 struct loader_extension_list *inst_exts);
513struct loader_icd *loader_get_icd_and_device(const VkDevice device,
514 struct loader_device **found_dev);
Jon Ashburna9c4a572016-02-26 13:14:27 -0700515void loader_init_dispatch_dev_ext(struct loader_instance *inst,
516 struct loader_device *dev);
Jon Ashburn44aed662016-02-02 17:47:28 -0700517void *loader_dev_ext_gpa(struct loader_instance *inst, const char *funcName);
518void *loader_get_dev_ext_trampoline(uint32_t index);
519struct loader_instance *loader_get_instance(const VkInstance instance);
Jon Ashburna9c4a572016-02-26 13:14:27 -0700520struct loader_device *
Piers Daniellfc500412016-03-29 11:51:11 -0600521loader_create_logical_device(const struct loader_instance *inst);
522void loader_add_logical_device(const struct loader_instance *inst,
523 struct loader_icd *icd,
524 struct loader_device *found_dev);
Jon Ashburn44aed662016-02-02 17:47:28 -0700525void loader_remove_logical_device(const struct loader_instance *inst,
526 struct loader_icd *icd,
527 struct loader_device *found_dev);
528VkResult
529loader_enable_instance_layers(struct loader_instance *inst,
530 const VkInstanceCreateInfo *pCreateInfo,
531 const struct loader_layer_list *instance_layers);
Jon Ashburncb5a5ac2015-06-10 10:06:06 -0600532void loader_deactivate_instance_layers(struct loader_instance *instance);
Courtney Goeltzenleuchter2bdf6da2016-01-08 12:18:43 -0700533
Jon Ashburn44aed662016-02-02 17:47:28 -0700534VkResult loader_create_instance_chain(const VkInstanceCreateInfo *pCreateInfo,
535 const VkAllocationCallbacks *pAllocator,
536 struct loader_instance *inst,
Jon Ashburna4b34942016-02-03 12:37:30 -0700537 VkInstance *created_instance);
Courtney Goeltzenleuchter2bdf6da2016-01-08 12:18:43 -0700538
Jon Ashburn44aed662016-02-02 17:47:28 -0700539void loader_activate_instance_layer_extensions(struct loader_instance *inst,
540 VkInstance created_inst);
Jon Ashburna9c4a572016-02-26 13:14:27 -0700541VkResult
542loader_enable_device_layers(const struct loader_instance *inst,
Jon Ashburna9c4a572016-02-26 13:14:27 -0700543 struct loader_layer_list *activated_layer_list,
544 const VkDeviceCreateInfo *pCreateInfo,
545 const struct loader_layer_list *device_layers);
Courtney Goeltzenleuchterb620ace2015-07-05 11:28:29 -0600546
Jon Ashburn9b2a8c92016-04-15 09:25:03 -0600547VkResult
548loader_create_device_chain(const struct loader_physical_device_tramp *pd,
549 const VkDeviceCreateInfo *pCreateInfo,
550 const VkAllocationCallbacks *pAllocator,
551 const struct loader_instance *inst,
552 struct loader_device *dev);
Jon Ashburna9c4a572016-02-26 13:14:27 -0700553VkResult loader_validate_device_extensions(
Jon Ashburn3c4a1142016-03-24 15:49:57 -0600554 struct loader_physical_device_tramp *phys_dev,
Jon Ashburna9c4a572016-02-26 13:14:27 -0700555 const struct loader_layer_list *activated_device_layers,
Jon Ashburn87660432016-03-01 19:51:07 -0700556 const struct loader_extension_list *icd_exts,
Jon Ashburna9c4a572016-02-26 13:14:27 -0700557 const VkDeviceCreateInfo *pCreateInfo);
Courtney Goeltzenleuchterb620ace2015-07-05 11:28:29 -0600558
Jon Ashburna9c4a572016-02-26 13:14:27 -0700559/* instance layer chain termination entrypoint definitions */
560VKAPI_ATTR VkResult VKAPI_CALL
561terminator_CreateInstance(const VkInstanceCreateInfo *pCreateInfo,
562 const VkAllocationCallbacks *pAllocator,
563 VkInstance *pInstance);
Jon Ashburn413d6582015-08-28 15:19:27 -0600564
Jon Ashburna9c4a572016-02-26 13:14:27 -0700565VKAPI_ATTR void VKAPI_CALL
566terminator_DestroyInstance(VkInstance instance,
567 const VkAllocationCallbacks *pAllocator);
Jon Ashburn413d6582015-08-28 15:19:27 -0600568
Jon Ashburna9c4a572016-02-26 13:14:27 -0700569VKAPI_ATTR VkResult VKAPI_CALL
570terminator_EnumeratePhysicalDevices(VkInstance instance,
571 uint32_t *pPhysicalDeviceCount,
572 VkPhysicalDevice *pPhysicalDevices);
573
574VKAPI_ATTR void VKAPI_CALL
575terminator_GetPhysicalDeviceFeatures(VkPhysicalDevice physicalDevice,
576 VkPhysicalDeviceFeatures *pFeatures);
577
578VKAPI_ATTR void VKAPI_CALL
579terminator_GetPhysicalDeviceFormatProperties(VkPhysicalDevice physicalDevice,
580 VkFormat format,
581 VkFormatProperties *pFormatInfo);
582
583VKAPI_ATTR VkResult VKAPI_CALL
584terminator_GetPhysicalDeviceImageFormatProperties(
585 VkPhysicalDevice physicalDevice, VkFormat format, VkImageType type,
586 VkImageTiling tiling, VkImageUsageFlags usage, VkImageCreateFlags flags,
587 VkImageFormatProperties *pImageFormatProperties);
588
589VKAPI_ATTR void VKAPI_CALL
590terminator_GetPhysicalDeviceSparseImageFormatProperties(
591 VkPhysicalDevice physicalDevice, VkFormat format, VkImageType type,
592 VkSampleCountFlagBits samples, VkImageUsageFlags usage,
593 VkImageTiling tiling, uint32_t *pNumProperties,
594 VkSparseImageFormatProperties *pProperties);
595
596VKAPI_ATTR void VKAPI_CALL
597terminator_GetPhysicalDeviceProperties(VkPhysicalDevice physicalDevice,
598 VkPhysicalDeviceProperties *pProperties);
599
600VKAPI_ATTR VkResult VKAPI_CALL terminator_EnumerateDeviceExtensionProperties(
601 VkPhysicalDevice physicalDevice, const char *pLayerName, uint32_t *pCount,
602 VkExtensionProperties *pProperties);
603
604VKAPI_ATTR VkResult VKAPI_CALL
605terminator_EnumerateDeviceLayerProperties(VkPhysicalDevice physicalDevice,
606 uint32_t *pCount,
607 VkLayerProperties *pProperties);
608
609VKAPI_ATTR void VKAPI_CALL terminator_GetPhysicalDeviceQueueFamilyProperties(
610 VkPhysicalDevice physicalDevice, uint32_t *pCount,
611 VkQueueFamilyProperties *pProperties);
612
613VKAPI_ATTR void VKAPI_CALL terminator_GetPhysicalDeviceMemoryProperties(
614 VkPhysicalDevice physicalDevice,
615 VkPhysicalDeviceMemoryProperties *pProperties);
616
617VKAPI_ATTR VkResult VKAPI_CALL
618terminator_CreateDevice(VkPhysicalDevice gpu,
619 const VkDeviceCreateInfo *pCreateInfo,
620 const VkAllocationCallbacks *pAllocator,
621 VkDevice *pDevice);
Mark Lobodzinskic882eee2016-02-02 18:53:34 -0700622
Jon Ashburn7ec85cd2016-02-10 20:50:19 -0700623VkStringErrorFlags vk_string_validate(const int max_length,
624 const char *char_array);
Mark Lobodzinskic882eee2016-02-02 18:53:34 -0700625
Chia-I Wu468e3c32014-08-04 08:03:57 +0800626#endif /* LOADER_H */