1 /*
2 *
3 * Copyright (c) 2014-2023 The Khronos Group Inc.
4 * Copyright (c) 2014-2023 Valve Corporation
5 * Copyright (c) 2014-2023 LunarG, Inc.
6 * Copyright (C) 2015 Google Inc.
7 *
8 * 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
11 *
12 * http://www.apache.org/licenses/LICENSE-2.0
13 *
14 * 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.
19 *
20 * Author: Jon Ashburn <jon@lunarg.com>
21 * Author: Courtney Goeltzenleuchter <courtney@LunarG.com>
22 * Author: Chia-I Wu <olvaffe@gmail.com>
23 * Author: Chia-I Wu <olv@lunarg.com>
24 * Author: Mark Lobodzinski <mark@LunarG.com>
25 * Author: Lenny Komow <lenny@lunarg.com>
26 * Author: Charles Giessen <charles@lunarg.com>
27 *
28 */
29
30 #pragma once
31
32 #include "loader_common.h"
33 #include "cJSON.h"
34
35 // Declare the once_init variable
LOADER_PLATFORM_THREAD_ONCE_EXTERN_DEFINITION(once_init)36 LOADER_PLATFORM_THREAD_ONCE_EXTERN_DEFINITION(once_init)
37
38 static inline VkPhysicalDevice loader_unwrap_physical_device(VkPhysicalDevice physicalDevice) {
39 struct loader_physical_device_tramp *phys_dev = (struct loader_physical_device_tramp *)physicalDevice;
40 if (PHYS_TRAMP_MAGIC_NUMBER != phys_dev->magic) {
41 return VK_NULL_HANDLE;
42 }
43 return phys_dev->phys_dev;
44 }
45
loader_set_dispatch(void * obj,const void * data)46 static inline void loader_set_dispatch(void *obj, const void *data) { *((const void **)obj) = data; }
47
loader_get_dispatch(const void * obj)48 static inline VkLayerDispatchTable *loader_get_dispatch(const void *obj) {
49 if (VK_NULL_HANDLE == obj) {
50 return NULL;
51 }
52 VkLayerDispatchTable *disp = *((VkLayerDispatchTable **)obj);
53 if (VK_NULL_HANDLE == disp || DEVICE_DISP_TABLE_MAGIC_NUMBER != disp->magic) {
54 return NULL;
55 }
56 return disp;
57 }
58
loader_get_dev_dispatch(const void * obj)59 static inline struct loader_dev_dispatch_table *loader_get_dev_dispatch(const void *obj) {
60 return *((struct loader_dev_dispatch_table **)obj);
61 }
62
loader_get_instance_layer_dispatch(const void * obj)63 static inline VkLayerInstanceDispatchTable *loader_get_instance_layer_dispatch(const void *obj) {
64 return *((VkLayerInstanceDispatchTable **)obj);
65 }
66
loader_get_instance_dispatch(const void * obj)67 static inline struct loader_instance_dispatch_table *loader_get_instance_dispatch(const void *obj) {
68 return *((struct loader_instance_dispatch_table **)obj);
69 }
70
loader_init_dispatch(void * obj,const void * data)71 static inline void loader_init_dispatch(void *obj, const void *data) {
72 #if defined(DEBUG)
73 assert(valid_loader_magic_value(obj) &&
74 "Incompatible ICD, first dword must be initialized to "
75 "ICD_LOADER_MAGIC. See loader/README.md for details.");
76 #endif
77
78 loader_set_dispatch(obj, data);
79 }
80
81 // Global variables used across files
82 extern struct loader_struct loader;
83 extern loader_platform_thread_mutex loader_lock;
84 extern loader_platform_thread_mutex loader_preload_icd_lock;
85 extern loader_platform_thread_mutex loader_global_instance_list_lock;
86
87 bool compare_vk_extension_properties(const VkExtensionProperties *op1, const VkExtensionProperties *op2);
88
89 VkResult loader_validate_layers(const struct loader_instance *inst, const uint32_t layer_count,
90 const char *const *ppEnabledLayerNames, const struct loader_layer_list *list);
91
92 VkResult loader_validate_instance_extensions(struct loader_instance *inst, const struct loader_extension_list *icd_exts,
93 const struct loader_layer_list *instance_layer,
94 const struct loader_envvar_all_filters *layer_filters,
95 const VkInstanceCreateInfo *pCreateInfo);
96
97 void loader_initialize(void);
98 void loader_release(void);
99 void loader_preload_icds(void);
100 void loader_unload_preloaded_icds(void);
101 VkResult loader_init_library_list(struct loader_layer_list *instance_layers, loader_platform_dl_handle **libs);
102
103 // Allocate a new string able to hold source_str and place it in dest_str
104 VkResult loader_copy_to_new_str(const struct loader_instance *inst, const char *source_str, char **dest_str);
105
106 // Allocate a loader_string_list with enough space for allocated_count strings inside of it
107 VkResult create_string_list(const struct loader_instance *inst, uint32_t allocated_count, struct loader_string_list *string_list);
108 // Resize if there isn't enough space, then add the string str to the end of the loader_string_list
109 // This function takes ownership of the str passed in - but only when it succeeds
110 VkResult append_str_to_string_list(const struct loader_instance *inst, struct loader_string_list *string_list, char *str);
111 // Resize if there isn't enough space, then copy the string str to a new string the end of the loader_string_list
112 // This function does not take ownership of the string, it merely copies it.
113 // This function appends a null terminator to the string automatically
114 // The str_len parameter does not include the null terminator
115 VkResult copy_str_to_string_list(const struct loader_instance *inst, struct loader_string_list *string_list, const char *str,
116 size_t str_len);
117
118 // Free any string inside of loader_string_list and then free the list itself
119 void free_string_list(const struct loader_instance *inst, struct loader_string_list *string_list);
120
121 VkResult loader_init_generic_list(const struct loader_instance *inst, struct loader_generic_list *list_info, size_t element_size);
122 bool has_vk_extension_property_array(const VkExtensionProperties *vk_ext_prop, const uint32_t count,
123 const VkExtensionProperties *ext_array);
124 bool has_vk_extension_property(const VkExtensionProperties *vk_ext_prop, const struct loader_extension_list *ext_list);
125 // This function takes ownership of layer_property in the case that allocation fails
126 VkResult loader_append_layer_property(const struct loader_instance *inst, struct loader_layer_list *layer_list,
127 struct loader_layer_properties *layer_property);
128 VkResult loader_add_layer_properties(const struct loader_instance *inst, struct loader_layer_list *layer_instance_list, cJSON *json,
129 bool is_implicit, char *filename);
130 bool loader_find_layer_name_in_list(const char *name, const struct loader_pointer_layer_list *layer_list);
131 VkResult loader_add_layer_properties_to_list(const struct loader_instance *inst, struct loader_pointer_layer_list *list,
132 struct loader_layer_properties *props);
133 void loader_free_layer_properties(const struct loader_instance *inst, struct loader_layer_properties *layer_properties);
134 bool loader_implicit_layer_is_enabled(const struct loader_instance *inst, const struct loader_envvar_all_filters *filters,
135 const struct loader_layer_properties *prop);
136 VkResult loader_add_meta_layer(const struct loader_instance *inst, const struct loader_envvar_all_filters *filters,
137 struct loader_layer_properties *prop, struct loader_pointer_layer_list *target_list,
138 struct loader_pointer_layer_list *expanded_target_list, const struct loader_layer_list *source_list,
139 bool *out_found_all_component_layers);
140 VkResult loader_add_to_ext_list(const struct loader_instance *inst, struct loader_extension_list *ext_list,
141 uint32_t prop_list_count, const VkExtensionProperties *props);
142 VkResult loader_add_device_extensions(const struct loader_instance *inst,
143 PFN_vkEnumerateDeviceExtensionProperties fpEnumerateDeviceExtensionProperties,
144 VkPhysicalDevice physical_device, const char *lib_name,
145 struct loader_extension_list *ext_list);
146 VkResult loader_init_generic_list(const struct loader_instance *inst, struct loader_generic_list *list_info, size_t element_size);
147 void loader_destroy_generic_list(const struct loader_instance *inst, struct loader_generic_list *list);
148 void loader_destroy_pointer_layer_list(const struct loader_instance *inst, struct loader_pointer_layer_list *layer_list);
149 void loader_delete_layer_list_and_properties(const struct loader_instance *inst, struct loader_layer_list *layer_list);
150 void loader_remove_layer_in_list(const struct loader_instance *inst, struct loader_layer_list *layer_list,
151 uint32_t layer_to_remove);
152 VkResult loader_scanned_icd_init(const struct loader_instance *inst, struct loader_icd_tramp_list *icd_tramp_list);
153 void loader_scanned_icd_clear(const struct loader_instance *inst, struct loader_icd_tramp_list *icd_tramp_list);
154 VkResult loader_icd_scan(const struct loader_instance *inst, struct loader_icd_tramp_list *icd_tramp_list,
155 const VkInstanceCreateInfo *pCreateInfo, bool *skipped_portability_drivers);
156 void loader_icd_destroy(struct loader_instance *ptr_inst, struct loader_icd_term *icd_term,
157 const VkAllocationCallbacks *pAllocator);
158 VkResult loader_scan_for_layers(struct loader_instance *inst, struct loader_layer_list *instance_layers,
159 const struct loader_envvar_all_filters *layer_filters);
160 VkResult loader_scan_for_implicit_layers(struct loader_instance *inst, struct loader_layer_list *instance_layers,
161 const struct loader_envvar_all_filters *layer_filters);
162 VkResult loader_get_icd_loader_instance_extensions(const struct loader_instance *inst, struct loader_icd_tramp_list *icd_tramp_list,
163 struct loader_extension_list *inst_exts);
164 struct loader_icd_term *loader_get_icd_and_device(const void *device, struct loader_device **found_dev, uint32_t *icd_index);
165 struct loader_instance *loader_get_instance(const VkInstance instance);
166 struct loader_device *loader_create_logical_device(const struct loader_instance *inst, const VkAllocationCallbacks *pAllocator);
167 void loader_add_logical_device(struct loader_icd_term *icd_term, struct loader_device *found_dev);
168 void loader_remove_logical_device(struct loader_icd_term *icd_term, struct loader_device *found_dev,
169 const VkAllocationCallbacks *pAllocator);
170 // NOTE: Outside of loader, this entry-point is only provided for error
171 // cleanup.
172 void loader_destroy_logical_device(struct loader_device *dev, const VkAllocationCallbacks *pAllocator);
173
174 VkResult loader_enable_instance_layers(struct loader_instance *inst, const VkInstanceCreateInfo *pCreateInfo,
175 const struct loader_layer_list *instance_layers,
176 const struct loader_envvar_all_filters *layer_filters);
177
178 VkResult loader_create_instance_chain(const VkInstanceCreateInfo *pCreateInfo, const VkAllocationCallbacks *pAllocator,
179 struct loader_instance *inst, VkInstance *created_instance);
180
181 void loader_activate_instance_layer_extensions(struct loader_instance *inst, VkInstance created_inst);
182
183 VKAPI_ATTR VkResult VKAPI_CALL loader_layer_create_device(VkInstance instance, VkPhysicalDevice physicalDevice,
184 const VkDeviceCreateInfo *pCreateInfo,
185 const VkAllocationCallbacks *pAllocator, VkDevice *pDevice,
186 PFN_vkGetInstanceProcAddr layerGIPA, PFN_vkGetDeviceProcAddr *nextGDPA);
187 VKAPI_ATTR void VKAPI_CALL loader_layer_destroy_device(VkDevice device, const VkAllocationCallbacks *pAllocator,
188 PFN_vkDestroyDevice destroyFunction);
189
190 VkResult loader_create_device_chain(const VkPhysicalDevice pd, const VkDeviceCreateInfo *pCreateInfo,
191 const VkAllocationCallbacks *pAllocator, const struct loader_instance *inst,
192 struct loader_device *dev, PFN_vkGetInstanceProcAddr callingLayer,
193 PFN_vkGetDeviceProcAddr *layerNextGDPA);
194
195 VkResult loader_validate_device_extensions(struct loader_instance *this_instance,
196 const struct loader_pointer_layer_list *activated_device_layers,
197 const struct loader_extension_list *icd_exts, const VkDeviceCreateInfo *pCreateInfo);
198
199 VkResult setup_loader_tramp_phys_devs(struct loader_instance *inst, uint32_t phys_dev_count, VkPhysicalDevice *phys_devs);
200 VkResult setup_loader_tramp_phys_dev_groups(struct loader_instance *inst, uint32_t group_count,
201 VkPhysicalDeviceGroupProperties *groups);
202
203 VkStringErrorFlags vk_string_validate(const int max_length, const char *char_array);
204 char *loader_get_next_path(char *path);
205 VkResult add_data_files(const struct loader_instance *inst, char *search_path, struct loader_string_list *out_files,
206 bool use_first_found_manifest);
207
208 loader_api_version loader_make_version(uint32_t version);
209 loader_api_version loader_combine_version(uint32_t major, uint32_t minor, uint32_t patch);
210
211 // Helper macros for determining if a version is valid or not
212 bool loader_check_version_meets_required(loader_api_version required, loader_api_version version);
213
214 // Convenience macros for common versions
215 #if !defined(LOADER_VERSION_1_0_0)
216 #define LOADER_VERSION_1_0_0 loader_combine_version(1, 0, 0)
217 #endif
218
219 #if !defined(LOADER_VERSION_1_1_0)
220 #define LOADER_VERSION_1_1_0 loader_combine_version(1, 1, 0)
221 #endif
222