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