blob: 426b1a102c38584e94597885d187587bba30c665 [file] [log] [blame]
/*
*
* Copyright (c) 2014-2016 The Khronos Group Inc.
* Copyright (c) 2014-2016 Valve Corporation
* Copyright (c) 2014-2016 LunarG, Inc.
* Copyright (C) 2015 Google Inc.
*
* Permission is hereby granted, free of charge, to any person obtaining a copy
* of this software and/or associated documentation files (the "Materials"), to
* deal in the Materials without restriction, including without limitation the
* rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
* sell copies of the Materials, and to permit persons to whom the Materials are
* furnished to do so, subject to the following conditions:
*
* The above copyright notice(s) and this permission notice shall be included in
* all copies or substantial portions of the Materials.
*
* THE MATERIALS ARE PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
*
* IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
* DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
* OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE MATERIALS OR THE
* USE OR OTHER DEALINGS IN THE MATERIALS.
*
* Author: Jon Ashburn <jon@lunarg.com>
* Author: Courtney Goeltzenleuchter <courtney@LunarG.com>
*
*/
#define _GNU_SOURCE
#include <stdio.h>
#include <stdlib.h>
#include <stdarg.h>
#include <stdbool.h>
#include <string.h>
#include <sys/types.h>
#if defined(_WIN32)
#include "dirent_on_windows.h"
#else // _WIN32
#include <dirent.h>
#endif // _WIN32
#include "vk_loader_platform.h"
#include "loader.h"
#include "gpa_helper.h"
#include "table_ops.h"
#include "debug_report.h"
#include "wsi.h"
#include "vulkan/vk_icd.h"
#include "cJSON.h"
#include "murmurhash.h"
static loader_platform_dl_handle
loader_add_layer_lib(const struct loader_instance *inst, const char *chain_type,
struct loader_layer_properties *layer_prop);
static void loader_remove_layer_lib(struct loader_instance *inst,
struct loader_layer_properties *layer_prop);
struct loader_struct loader = {0};
// TLS for instance for alloc/free callbacks
THREAD_LOCAL_DECL struct loader_instance *tls_instance;
static size_t loader_platform_combine_path(char *dest, size_t len, ...);
struct loader_phys_dev_per_icd {
uint32_t count;
VkPhysicalDevice *phys_devs;
struct loader_icd *this_icd;
};
enum loader_debug {
LOADER_INFO_BIT = 0x01,
LOADER_WARN_BIT = 0x02,
LOADER_PERF_BIT = 0x04,
LOADER_ERROR_BIT = 0x08,
LOADER_DEBUG_BIT = 0x10,
};
uint32_t g_loader_debug = 0;
uint32_t g_loader_log_msgs = 0;
// thread safety lock for accessing global data structures such as "loader"
// all entrypoints on the instance chain need to be locked except GPA
// additionally CreateDevice and DestroyDevice needs to be locked
loader_platform_thread_mutex loader_lock;
loader_platform_thread_mutex loader_json_lock;
const char *std_validation_str = "VK_LAYER_LUNARG_standard_validation";
// This table contains the loader's instance dispatch table, which contains
// default functions if no instance layers are activated. This contains
// pointers to "terminator functions".
const VkLayerInstanceDispatchTable instance_disp = {
.GetInstanceProcAddr = vkGetInstanceProcAddr,
.DestroyInstance = terminator_DestroyInstance,
.EnumeratePhysicalDevices = terminator_EnumeratePhysicalDevices,
.GetPhysicalDeviceFeatures = terminator_GetPhysicalDeviceFeatures,
.GetPhysicalDeviceFormatProperties =
terminator_GetPhysicalDeviceFormatProperties,
.GetPhysicalDeviceImageFormatProperties =
terminator_GetPhysicalDeviceImageFormatProperties,
.GetPhysicalDeviceProperties = terminator_GetPhysicalDeviceProperties,
.GetPhysicalDeviceQueueFamilyProperties =
terminator_GetPhysicalDeviceQueueFamilyProperties,
.GetPhysicalDeviceMemoryProperties =
terminator_GetPhysicalDeviceMemoryProperties,
.EnumerateDeviceExtensionProperties =
terminator_EnumerateDeviceExtensionProperties,
.EnumerateDeviceLayerProperties = terminator_EnumerateDeviceLayerProperties,
.GetPhysicalDeviceSparseImageFormatProperties =
terminator_GetPhysicalDeviceSparseImageFormatProperties,
.DestroySurfaceKHR = terminator_DestroySurfaceKHR,
.GetPhysicalDeviceSurfaceSupportKHR =
terminator_GetPhysicalDeviceSurfaceSupportKHR,
.GetPhysicalDeviceSurfaceCapabilitiesKHR =
terminator_GetPhysicalDeviceSurfaceCapabilitiesKHR,
.GetPhysicalDeviceSurfaceFormatsKHR =
terminator_GetPhysicalDeviceSurfaceFormatsKHR,
.GetPhysicalDeviceSurfacePresentModesKHR =
terminator_GetPhysicalDeviceSurfacePresentModesKHR,
.CreateDebugReportCallbackEXT = terminator_CreateDebugReportCallback,
.DestroyDebugReportCallbackEXT = terminator_DestroyDebugReportCallback,
.DebugReportMessageEXT = terminator_DebugReportMessage,
#ifdef VK_USE_PLATFORM_MIR_KHR
.CreateMirSurfaceKHR = terminator_CreateMirSurfaceKHR,
.GetPhysicalDeviceMirPresentationSupportKHR =
terminator_GetPhysicalDeviceMirPresentationSupportKHR,
#endif
#ifdef VK_USE_PLATFORM_WAYLAND_KHR
.CreateWaylandSurfaceKHR = terminator_CreateWaylandSurfaceKHR,
.GetPhysicalDeviceWaylandPresentationSupportKHR =
terminator_GetPhysicalDeviceWaylandPresentationSupportKHR,
#endif
#ifdef VK_USE_PLATFORM_WIN32_KHR
.CreateWin32SurfaceKHR = terminator_CreateWin32SurfaceKHR,
.GetPhysicalDeviceWin32PresentationSupportKHR =
terminator_GetPhysicalDeviceWin32PresentationSupportKHR,
#endif
#ifdef VK_USE_PLATFORM_XCB_KHR
.CreateXcbSurfaceKHR = terminator_CreateXcbSurfaceKHR,
.GetPhysicalDeviceXcbPresentationSupportKHR =
terminator_GetPhysicalDeviceXcbPresentationSupportKHR,
#endif
#ifdef VK_USE_PLATFORM_XLIB_KHR
.CreateXlibSurfaceKHR = terminator_CreateXlibSurfaceKHR,
.GetPhysicalDeviceXlibPresentationSupportKHR =
terminator_GetPhysicalDeviceXlibPresentationSupportKHR,
#endif
#ifdef VK_USE_PLATFORM_ANDROID_KHR
.CreateAndroidSurfaceKHR = terminator_CreateAndroidSurfaceKHR,
#endif
.GetPhysicalDeviceDisplayPropertiesKHR =
terminator_GetPhysicalDeviceDisplayPropertiesKHR,
.GetPhysicalDeviceDisplayPlanePropertiesKHR =
terminator_GetPhysicalDeviceDisplayPlanePropertiesKHR,
.GetDisplayPlaneSupportedDisplaysKHR =
terminator_GetDisplayPlaneSupportedDisplaysKHR,
.GetDisplayModePropertiesKHR =
terminator_GetDisplayModePropertiesKHR,
.CreateDisplayModeKHR =
terminator_CreateDisplayModeKHR,
.GetDisplayPlaneCapabilitiesKHR =
terminator_GetDisplayPlaneCapabilitiesKHR,
.CreateDisplayPlaneSurfaceKHR =
terminator_CreateDisplayPlaneSurfaceKHR,
};
LOADER_PLATFORM_THREAD_ONCE_DECLARATION(once_init);
void *loader_heap_alloc(const struct loader_instance *instance, size_t size,
VkSystemAllocationScope alloc_scope) {
if (instance && instance->alloc_callbacks.pfnAllocation) {
/* TODO: What should default alignment be? 1, 4, 8, other? */
return instance->alloc_callbacks.pfnAllocation(
instance->alloc_callbacks.pUserData, size, sizeof(int),
alloc_scope);
}
return malloc(size);
}
void loader_heap_free(const struct loader_instance *instance, void *pMemory) {
if (pMemory == NULL)
return;
if (instance && instance->alloc_callbacks.pfnFree) {
instance->alloc_callbacks.pfnFree(instance->alloc_callbacks.pUserData,
pMemory);
return;
}
free(pMemory);
}
void *loader_heap_realloc(const struct loader_instance *instance, void *pMemory,
size_t orig_size, size_t size,
VkSystemAllocationScope alloc_scope) {
if (pMemory == NULL || orig_size == 0)
return loader_heap_alloc(instance, size, alloc_scope);
if (size == 0) {
loader_heap_free(instance, pMemory);
return NULL;
}
// TODO use the callback realloc function
if (instance && instance->alloc_callbacks.pfnAllocation) {
if (size <= orig_size) {
memset(((uint8_t *)pMemory) + size, 0, orig_size - size);
return pMemory;
}
/* TODO: What should default alignment be? 1, 4, 8, other? */
void *new_ptr = instance->alloc_callbacks.pfnAllocation(
instance->alloc_callbacks.pUserData, size, sizeof(int),
alloc_scope);
if (!new_ptr)
return NULL;
memcpy(new_ptr, pMemory, orig_size);
instance->alloc_callbacks.pfnFree(instance->alloc_callbacks.pUserData,
pMemory);
return new_ptr;
}
return realloc(pMemory, size);
}
void *loader_tls_heap_alloc(size_t size) {
return loader_heap_alloc(tls_instance, size,
VK_SYSTEM_ALLOCATION_SCOPE_COMMAND);
}
void loader_tls_heap_free(void *pMemory) {
loader_heap_free(tls_instance, pMemory);
}
void loader_log(const struct loader_instance *inst, VkFlags msg_type,
int32_t msg_code, const char *format, ...) {
char msg[512];
va_list ap;
int ret;
va_start(ap, format);
ret = vsnprintf(msg, sizeof(msg), format, ap);
if ((ret >= (int)sizeof(msg)) || ret < 0) {
msg[sizeof(msg) - 1] = '\0';
}
va_end(ap);
if (inst) {
util_DebugReportMessage(inst, msg_type,
VK_DEBUG_REPORT_OBJECT_TYPE_INSTANCE_EXT,
(uint64_t)inst, 0, msg_code, "loader", msg);
}
if (!(msg_type & g_loader_log_msgs)) {
return;
}
#if defined(WIN32)
OutputDebugString(msg);
OutputDebugString("\n");
#endif
fputs(msg, stderr);
fputc('\n', stderr);
}
#if defined(WIN32)
static char *loader_get_next_path(char *path);
/**
* Find the list of registry files (names within a key) in key "location".
*
* This function looks in the registry (hive = DEFAULT_VK_REGISTRY_HIVE) key as
*given in "location"
* for a list or name/values which are added to a returned list (function return
*value).
* The DWORD values within the key must be 0 or they are skipped.
* Function return is a string with a ';' separated list of filenames.
* Function return is NULL if no valid name/value pairs are found in the key,
* or the key is not found.
*
* \returns
* A string list of filenames as pointer.
* When done using the returned string list, pointer should be freed.
*/
static char *loader_get_registry_files(const struct loader_instance *inst,
char *location) {
LONG rtn_value;
HKEY hive, key;
DWORD access_flags;
char name[2048];
char *out = NULL;
char *loc = location;
char *next;
DWORD idx = 0;
DWORD name_size = sizeof(name);
DWORD value;
DWORD total_size = 4096;
DWORD value_size = sizeof(value);
while (*loc) {
next = loader_get_next_path(loc);
hive = DEFAULT_VK_REGISTRY_HIVE;
access_flags = KEY_QUERY_VALUE;
rtn_value = RegOpenKeyEx(hive, loc, 0, access_flags, &key);
if (rtn_value != ERROR_SUCCESS) {
// We still couldn't find the key, so give up:
loc = next;
continue;
}
while ((rtn_value = RegEnumValue(key, idx++, name, &name_size, NULL,
NULL, (LPBYTE)&value, &value_size)) ==
ERROR_SUCCESS) {
if (value_size == sizeof(value) && value == 0) {
if (out == NULL) {
out = loader_heap_alloc(
inst, total_size, VK_SYSTEM_ALLOCATION_SCOPE_INSTANCE);
out[0] = '\0';
} else if (strlen(out) + name_size + 1 > total_size) {
out = loader_heap_realloc(
inst, out, total_size, total_size * 2,
VK_SYSTEM_ALLOCATION_SCOPE_INSTANCE);
total_size *= 2;
}
if (out == NULL) {
loader_log(
inst, VK_DEBUG_REPORT_ERROR_BIT_EXT, 0,
"Out of memory, failed loader_get_registry_files");
return NULL;
}
if (strlen(out) == 0)
snprintf(out, name_size + 1, "%s", name);
else
snprintf(out + strlen(out), name_size + 2, "%c%s",
PATH_SEPERATOR, name);
}
name_size = 2048;
}
loc = next;
}
return out;
}
#endif // WIN32
/**
* Combine path elements, separating each element with the platform-specific
* directory separator, and save the combined string to a destination buffer,
* not exceeding the given length. Path elements are given as variadic args,
* with a NULL element terminating the list.
*
* \returns the total length of the combined string, not including an ASCII
* NUL termination character. This length may exceed the available storage:
* in this case, the written string will be truncated to avoid a buffer
* overrun, and the return value will greater than or equal to the storage
* size. A NULL argument may be provided as the destination buffer in order
* to determine the required string length without actually writing a string.
*/
static size_t loader_platform_combine_path(char *dest, size_t len, ...) {
size_t required_len = 0;
va_list ap;
const char *component;
va_start(ap, len);
while ((component = va_arg(ap, const char *))) {
if (required_len > 0) {
// This path element is not the first non-empty element; prepend
// a directory separator if space allows
if (dest && required_len + 1 < len) {
snprintf(dest + required_len, len - required_len, "%c",
DIRECTORY_SYMBOL);
}
required_len++;
}
if (dest && required_len < len) {
strncpy(dest + required_len, component, len - required_len);
}
required_len += strlen(component);
}
va_end(ap);
// strncpy(3) won't add a NUL terminating byte in the event of truncation.
if (dest && required_len >= len) {
dest[len - 1] = '\0';
}
return required_len;
}
/**
* Given string of three part form "maj.min.pat" convert to a vulkan version
* number.
*/
static uint32_t loader_make_version(const char *vers_str) {
uint32_t vers = 0, major = 0, minor = 0, patch = 0;
char *minor_str = NULL;
char *patch_str = NULL;
char *cstr;
char *str;
if (!vers_str)
return vers;
cstr = loader_stack_alloc(strlen(vers_str) + 1);
strcpy(cstr, vers_str);
while ((str = strchr(cstr, '.')) != NULL) {
if (minor_str == NULL) {
minor_str = str + 1;
*str = '\0';
major = atoi(cstr);
} else if (patch_str == NULL) {
patch_str = str + 1;
*str = '\0';
minor = atoi(minor_str);
} else {
return vers;
}
cstr = str + 1;
}
patch = atoi(patch_str);
return VK_MAKE_VERSION(major, minor, patch);
}
bool compare_vk_extension_properties(const VkExtensionProperties *op1,
const VkExtensionProperties *op2) {
return strcmp(op1->extensionName, op2->extensionName) == 0 ? true : false;
}
/**
* Search the given ext_array for an extension
* matching the given vk_ext_prop
*/
bool has_vk_extension_property_array(const VkExtensionProperties *vk_ext_prop,
const uint32_t count,
const VkExtensionProperties *ext_array) {
for (uint32_t i = 0; i < count; i++) {
if (compare_vk_extension_properties(vk_ext_prop, &ext_array[i]))
return true;
}
return false;
}
/**
* Search the given ext_list for an extension
* matching the given vk_ext_prop
*/
bool has_vk_extension_property(const VkExtensionProperties *vk_ext_prop,
const struct loader_extension_list *ext_list) {
for (uint32_t i = 0; i < ext_list->count; i++) {
if (compare_vk_extension_properties(&ext_list->list[i], vk_ext_prop))
return true;
}
return false;
}
static inline bool loader_is_layer_type_device(const enum layer_type type) {
if ((type & VK_LAYER_TYPE_DEVICE_EXPLICIT) ||
(type & VK_LAYER_TYPE_DEVICE_IMPLICIT))
return true;
return false;
}
/*
* Search the given layer list for a layer matching the given layer name
*/
static struct loader_layer_properties *
loader_get_layer_property(const char *name,
const struct loader_layer_list *layer_list) {
for (uint32_t i = 0; i < layer_list->count; i++) {
const VkLayerProperties *item = &layer_list->list[i].info;
if (strcmp(name, item->layerName) == 0)
return &layer_list->list[i];
}
return NULL;
}
/**
* Get the next unused layer property in the list. Init the property to zero.
*/
static struct loader_layer_properties *
loader_get_next_layer_property(const struct loader_instance *inst,
struct loader_layer_list *layer_list) {
if (layer_list->capacity == 0) {
layer_list->list =
loader_heap_alloc(inst, sizeof(struct loader_layer_properties) * 64,
VK_SYSTEM_ALLOCATION_SCOPE_INSTANCE);
if (layer_list->list == NULL) {
loader_log(inst, VK_DEBUG_REPORT_ERROR_BIT_EXT, 0,
"Out of memory can't add any layer properties to list");
return NULL;
}
memset(layer_list->list, 0,
sizeof(struct loader_layer_properties) * 64);
layer_list->capacity = sizeof(struct loader_layer_properties) * 64;
}
// ensure enough room to add an entry
if ((layer_list->count + 1) * sizeof(struct loader_layer_properties) >
layer_list->capacity) {
layer_list->list = loader_heap_realloc(
inst, layer_list->list, layer_list->capacity,
layer_list->capacity * 2, VK_SYSTEM_ALLOCATION_SCOPE_INSTANCE);
if (layer_list->list == NULL) {
loader_log(inst, VK_DEBUG_REPORT_ERROR_BIT_EXT, 0,
"realloc failed for layer list");
}
layer_list->capacity *= 2;
}
layer_list->count++;
return &(layer_list->list[layer_list->count - 1]);
}
/**
* Remove all layer properties entrys from the list
*/
void loader_delete_layer_properties(const struct loader_instance *inst,
struct loader_layer_list *layer_list) {
uint32_t i, j;
struct loader_device_extension_list *dev_ext_list;
if (!layer_list)
return;
for (i = 0; i < layer_list->count; i++) {
loader_destroy_generic_list(
inst, (struct loader_generic_list *)&layer_list->list[i]
.instance_extension_list);
dev_ext_list = &layer_list->list[i].device_extension_list;
if (dev_ext_list->capacity > 0 &&
dev_ext_list->list->entrypoint_count > 0) {
for (j = 0; j < dev_ext_list->list->entrypoint_count; j++) {
loader_heap_free(inst, dev_ext_list->list->entrypoints[j]);
}
loader_heap_free(inst, dev_ext_list->list->entrypoints);
}
loader_destroy_generic_list(inst,
(struct loader_generic_list *)dev_ext_list);
}
layer_list->count = 0;
if (layer_list->capacity > 0) {
layer_list->capacity = 0;
loader_heap_free(inst, layer_list->list);
}
}
static void loader_add_instance_extensions(
const struct loader_instance *inst,
const PFN_vkEnumerateInstanceExtensionProperties fp_get_props,
const char *lib_name, struct loader_extension_list *ext_list) {
uint32_t i, count = 0;
VkExtensionProperties *ext_props;
VkResult res;
if (!fp_get_props) {
/* No EnumerateInstanceExtensionProperties defined */
return;
}
res = fp_get_props(NULL, &count, NULL);
if (res != VK_SUCCESS) {
loader_log(inst, VK_DEBUG_REPORT_WARNING_BIT_EXT, 0,
"Error getting Instance extension count from %s", lib_name);
return;
}
if (count == 0) {
/* No ExtensionProperties to report */
return;
}
ext_props = loader_stack_alloc(count * sizeof(VkExtensionProperties));
res = fp_get_props(NULL, &count, ext_props);
if (res != VK_SUCCESS) {
loader_log(inst, VK_DEBUG_REPORT_WARNING_BIT_EXT, 0,
"Error getting Instance extensions from %s", lib_name);
return;
}
for (i = 0; i < count; i++) {
char spec_version[64];
snprintf(spec_version, sizeof(spec_version), "%d.%d.%d",
VK_MAJOR(ext_props[i].specVersion),
VK_MINOR(ext_props[i].specVersion),
VK_PATCH(ext_props[i].specVersion));
loader_log(inst, VK_DEBUG_REPORT_DEBUG_BIT_EXT, 0,
"Instance Extension: %s (%s) version %s",
ext_props[i].extensionName, lib_name, spec_version);
loader_add_to_ext_list(inst, ext_list, 1, &ext_props[i]);
}
return;
}
/*
* Initialize ext_list with the physical device extensions.
* The extension properties are passed as inputs in count and ext_props.
*/
static VkResult
loader_init_device_extensions(const struct loader_instance *inst,
struct loader_physical_device *phys_dev,
uint32_t count, VkExtensionProperties *ext_props,
struct loader_extension_list *ext_list) {
VkResult res;
uint32_t i;
if (!loader_init_generic_list(inst, (struct loader_generic_list *)ext_list,
sizeof(VkExtensionProperties))) {
return VK_ERROR_OUT_OF_HOST_MEMORY;
}
for (i = 0; i < count; i++) {
char spec_version[64];
snprintf(spec_version, sizeof(spec_version), "%d.%d.%d",
VK_MAJOR(ext_props[i].specVersion),
VK_MINOR(ext_props[i].specVersion),
VK_PATCH(ext_props[i].specVersion));
loader_log(inst, VK_DEBUG_REPORT_DEBUG_BIT_EXT, 0,
"Device Extension: %s (%s) version %s",
ext_props[i].extensionName,
phys_dev->this_icd->this_icd_lib->lib_name, spec_version);
res = loader_add_to_ext_list(inst, ext_list, 1, &ext_props[i]);
if (res != VK_SUCCESS)
return res;
}
return VK_SUCCESS;
}
VkResult loader_add_device_extensions(const struct loader_instance *inst,
struct loader_icd *icd,
VkPhysicalDevice physical_device,
const char *lib_name,
struct loader_extension_list *ext_list) {
uint32_t i, count;
VkResult res;
VkExtensionProperties *ext_props;
res = icd->EnumerateDeviceExtensionProperties(physical_device, NULL, &count,
NULL);
if (res == VK_SUCCESS && count > 0) {
ext_props = loader_stack_alloc(count * sizeof(VkExtensionProperties));
if (!ext_props)
return VK_ERROR_OUT_OF_HOST_MEMORY;
res = icd->EnumerateDeviceExtensionProperties(physical_device, NULL,
&count, ext_props);
if (res != VK_SUCCESS)
return res;
for (i = 0; i < count; i++) {
char spec_version[64];
snprintf(spec_version, sizeof(spec_version), "%d.%d.%d",
VK_MAJOR(ext_props[i].specVersion),
VK_MINOR(ext_props[i].specVersion),
VK_PATCH(ext_props[i].specVersion));
loader_log(inst, VK_DEBUG_REPORT_DEBUG_BIT_EXT, 0,
"Device Extension: %s (%s) version %s",
ext_props[i].extensionName, lib_name, spec_version);
res = loader_add_to_ext_list(inst, ext_list, 1, &ext_props[i]);
if (res != VK_SUCCESS)
return res;
}
} else {
loader_log(inst, VK_DEBUG_REPORT_ERROR_BIT_EXT, 0,
"Error getting physical device extension info count from "
"library %s",
lib_name);
return res;
}
return VK_SUCCESS;
}
bool loader_init_generic_list(const struct loader_instance *inst,
struct loader_generic_list *list_info,
size_t element_size) {
list_info->capacity = 32 * element_size;
list_info->list = loader_heap_alloc(inst, list_info->capacity,
VK_SYSTEM_ALLOCATION_SCOPE_INSTANCE);
if (list_info->list == NULL) {
return false;
}
memset(list_info->list, 0, list_info->capacity);
list_info->count = 0;
return true;
}
void loader_destroy_generic_list(const struct loader_instance *inst,
struct loader_generic_list *list) {
loader_heap_free(inst, list->list);
list->count = 0;
list->capacity = 0;
}
/*
* Append non-duplicate extension properties defined in props
* to the given ext_list.
* Return
* Vk_SUCCESS on success
*/
VkResult loader_add_to_ext_list(const struct loader_instance *inst,
struct loader_extension_list *ext_list,
uint32_t prop_list_count,
const VkExtensionProperties *props) {
uint32_t i;
const VkExtensionProperties *cur_ext;
if (ext_list->list == NULL || ext_list->capacity == 0) {
loader_init_generic_list(inst, (struct loader_generic_list *)ext_list,
sizeof(VkExtensionProperties));
}
if (ext_list->list == NULL)
return VK_ERROR_OUT_OF_HOST_MEMORY;
for (i = 0; i < prop_list_count; i++) {
cur_ext = &props[i];
// look for duplicates
if (has_vk_extension_property(cur_ext, ext_list)) {
continue;
}
// add to list at end
// check for enough capacity
if (ext_list->count * sizeof(VkExtensionProperties) >=
ext_list->capacity) {
ext_list->list = loader_heap_realloc(
inst, ext_list->list, ext_list->capacity,
ext_list->capacity * 2, VK_SYSTEM_ALLOCATION_SCOPE_INSTANCE);
if (ext_list->list == NULL)
return VK_ERROR_OUT_OF_HOST_MEMORY;
// double capacity
ext_list->capacity *= 2;
}
memcpy(&ext_list->list[ext_list->count], cur_ext,
sizeof(VkExtensionProperties));
ext_list->count++;
}
return VK_SUCCESS;
}
/*
* Append one extension property defined in props with entrypoints
* defined in entrys to the given ext_list.
* Return
* Vk_SUCCESS on success
*/
VkResult
loader_add_to_dev_ext_list(const struct loader_instance *inst,
struct loader_device_extension_list *ext_list,
const VkExtensionProperties *props,
uint32_t entry_count, char **entrys) {
uint32_t idx;
if (ext_list->list == NULL || ext_list->capacity == 0) {
loader_init_generic_list(inst, (struct loader_generic_list *)ext_list,
sizeof(struct loader_dev_ext_props));
}
if (ext_list->list == NULL)
return VK_ERROR_OUT_OF_HOST_MEMORY;
idx = ext_list->count;
// add to list at end
// check for enough capacity
if (idx * sizeof(struct loader_dev_ext_props) >= ext_list->capacity) {
ext_list->list = loader_heap_realloc(
inst, ext_list->list, ext_list->capacity, ext_list->capacity * 2,
VK_SYSTEM_ALLOCATION_SCOPE_INSTANCE);
if (ext_list->list == NULL)
return VK_ERROR_OUT_OF_HOST_MEMORY;
// double capacity
ext_list->capacity *= 2;
}
memcpy(&ext_list->list[idx].props, props,
sizeof(struct loader_dev_ext_props));
ext_list->list[idx].entrypoint_count = entry_count;
ext_list->list[idx].entrypoints =
loader_heap_alloc(inst, sizeof(char *) * entry_count,
VK_SYSTEM_ALLOCATION_SCOPE_INSTANCE);
if (ext_list->list[idx].entrypoints == NULL)
return VK_ERROR_OUT_OF_HOST_MEMORY;
for (uint32_t i = 0; i < entry_count; i++) {
ext_list->list[idx].entrypoints[i] = loader_heap_alloc(
inst, strlen(entrys[i]) + 1, VK_SYSTEM_ALLOCATION_SCOPE_INSTANCE);
if (ext_list->list[idx].entrypoints[i] == NULL)
return VK_ERROR_OUT_OF_HOST_MEMORY;
strcpy(ext_list->list[idx].entrypoints[i], entrys[i]);
}
ext_list->count++;
return VK_SUCCESS;
}
/**
* Search the given search_list for any layers in the props list.
* Add these to the output layer_list. Don't add duplicates to the output
* layer_list.
*/
static VkResult
loader_add_layer_names_to_list(const struct loader_instance *inst,
struct loader_layer_list *output_list,
uint32_t name_count, const char *const *names,
const struct loader_layer_list *search_list) {
struct loader_layer_properties *layer_prop;
VkResult err = VK_SUCCESS;
for (uint32_t i = 0; i < name_count; i++) {
const char *search_target = names[i];
layer_prop = loader_get_layer_property(search_target, search_list);
if (!layer_prop) {
loader_log(inst, VK_DEBUG_REPORT_ERROR_BIT_EXT, 0,
"Unable to find layer %s", search_target);
err = VK_ERROR_LAYER_NOT_PRESENT;
continue;
}
loader_add_to_layer_list(inst, output_list, 1, layer_prop);
}
return err;
}
/*
* Manage lists of VkLayerProperties
*/
static bool loader_init_layer_list(const struct loader_instance *inst,
struct loader_layer_list *list) {
list->capacity = 32 * sizeof(struct loader_layer_properties);
list->list = loader_heap_alloc(inst, list->capacity,
VK_SYSTEM_ALLOCATION_SCOPE_INSTANCE);
if (list->list == NULL) {
return false;
}
memset(list->list, 0, list->capacity);
list->count = 0;
return true;
}
void loader_destroy_layer_list(const struct loader_instance *inst,
struct loader_layer_list *layer_list) {
loader_heap_free(inst, layer_list->list);
layer_list->count = 0;
layer_list->capacity = 0;
}
/*
* Manage list of layer libraries (loader_lib_info)
*/
static bool
loader_init_layer_library_list(const struct loader_instance *inst,
struct loader_layer_library_list *list) {
list->capacity = 32 * sizeof(struct loader_lib_info);
list->list = loader_heap_alloc(inst, list->capacity,
VK_SYSTEM_ALLOCATION_SCOPE_INSTANCE);
if (list->list == NULL) {
return false;
}
memset(list->list, 0, list->capacity);
list->count = 0;
return true;
}
void loader_destroy_layer_library_list(const struct loader_instance *inst,
struct loader_layer_library_list *list) {
for (uint32_t i = 0; i < list->count; i++) {
loader_heap_free(inst, list->list[i].lib_name);
}
loader_heap_free(inst, list->list);
list->count = 0;
list->capacity = 0;
}
void loader_add_to_layer_library_list(const struct loader_instance *inst,
struct loader_layer_library_list *list,
uint32_t item_count,
const struct loader_lib_info *new_items) {
uint32_t i;
struct loader_lib_info *item;
if (list->list == NULL || list->capacity == 0) {
loader_init_layer_library_list(inst, list);
}
if (list->list == NULL)
return;
for (i = 0; i < item_count; i++) {
item = (struct loader_lib_info *)&new_items[i];
// look for duplicates
for (uint32_t j = 0; j < list->count; j++) {
if (strcmp(list->list[i].lib_name, new_items->lib_name) == 0) {
continue;
}
}
// add to list at end
// check for enough capacity
if (list->count * sizeof(struct loader_lib_info) >= list->capacity) {
list->list = loader_heap_realloc(
inst, list->list, list->capacity, list->capacity * 2,
VK_SYSTEM_ALLOCATION_SCOPE_INSTANCE);
// double capacity
list->capacity *= 2;
}
memcpy(&list->list[list->count], item, sizeof(struct loader_lib_info));
list->count++;
}
}
/*
* Search the given layer list for a list
* matching the given VkLayerProperties
*/
bool has_vk_layer_property(const VkLayerProperties *vk_layer_prop,
const struct loader_layer_list *list) {
for (uint32_t i = 0; i < list->count; i++) {
if (strcmp(vk_layer_prop->layerName, list->list[i].info.layerName) == 0)
return true;
}
return false;
}
/*
* Search the given layer list for a layer
* matching the given name
*/
bool has_layer_name(const char *name, const struct loader_layer_list *list) {
for (uint32_t i = 0; i < list->count; i++) {
if (strcmp(name, list->list[i].info.layerName) == 0)
return true;
}
return false;
}
/*
* Append non-duplicate layer properties defined in prop_list
* to the given layer_info list
*/
void loader_add_to_layer_list(const struct loader_instance *inst,
struct loader_layer_list *list,
uint32_t prop_list_count,
const struct loader_layer_properties *props) {
uint32_t i;
struct loader_layer_properties *layer;
if (list->list == NULL || list->capacity == 0) {
loader_init_layer_list(inst, list);
}
if (list->list == NULL)
return;
for (i = 0; i < prop_list_count; i++) {
layer = (struct loader_layer_properties *)&props[i];
// look for duplicates
if (has_vk_layer_property(&layer->info, list)) {
continue;
}
// add to list at end
// check for enough capacity
if (list->count * sizeof(struct loader_layer_properties) >=
list->capacity) {
list->list = loader_heap_realloc(
inst, list->list, list->capacity, list->capacity * 2,
VK_SYSTEM_ALLOCATION_SCOPE_INSTANCE);
// double capacity
list->capacity *= 2;
}
memcpy(&list->list[list->count], layer,
sizeof(struct loader_layer_properties));
list->count++;
}
}
/**
* Search the search_list for any layer with a name
* that matches the given name and a type that matches the given type
* Add all matching layers to the found_list
* Do not add if found loader_layer_properties is already
* on the found_list.
*/
static void
loader_find_layer_name_add_list(const struct loader_instance *inst,
const char *name, const enum layer_type type,
const struct loader_layer_list *search_list,
struct loader_layer_list *found_list) {
bool found = false;
for (uint32_t i = 0; i < search_list->count; i++) {
struct loader_layer_properties *layer_prop = &search_list->list[i];
if (0 == strcmp(layer_prop->info.layerName, name) &&
(layer_prop->type & type)) {
/* Found a layer with the same name, add to found_list */
loader_add_to_layer_list(inst, found_list, 1, layer_prop);
found = true;
}
}
if (!found) {
loader_log(inst, VK_DEBUG_REPORT_WARNING_BIT_EXT, 0,
"Warning, couldn't find layer name %s to activate", name);
}
}
static VkExtensionProperties *
get_extension_property(const char *name,
const struct loader_extension_list *list) {
for (uint32_t i = 0; i < list->count; i++) {
if (strcmp(name, list->list[i].extensionName) == 0)
return &list->list[i];
}
return NULL;
}
static VkExtensionProperties *
get_dev_extension_property(const char *name,
const struct loader_device_extension_list *list) {
for (uint32_t i = 0; i < list->count; i++) {
if (strcmp(name, list->list[i].props.extensionName) == 0)
return &list->list[i].props;
}
return NULL;
}
/*
* This function will return the pNext pointer of any
* CreateInfo extensions that are not loader extensions.
* This is used to skip past the loader extensions prepended
* to the list during CreateInstance and CreateDevice.
*/
void *loader_strip_create_extensions(const void *pNext) {
VkLayerInstanceCreateInfo *create_info = (VkLayerInstanceCreateInfo *)pNext;
while (
create_info &&
(create_info->sType == VK_STRUCTURE_TYPE_LOADER_INSTANCE_CREATE_INFO ||
create_info->sType == VK_STRUCTURE_TYPE_LOADER_DEVICE_CREATE_INFO)) {
create_info = (VkLayerInstanceCreateInfo *)create_info->pNext;
}
return create_info;
}
/*
* For Instance extensions implemented within the loader (i.e. DEBUG_REPORT
* the extension must provide two entry points for the loader to use:
* - "trampoline" entry point - this is the address returned by GetProcAddr
* and will always do what's necessary to support a global call.
* - "terminator" function - this function will be put at the end of the
* instance chain and will contain the necessary logic to call / process
* the extension for the appropriate ICDs that are available.
* There is no generic mechanism for including these functions, the references
* must be placed into the appropriate loader entry points.
* GetInstanceProcAddr: call extension GetInstanceProcAddr to check for
* GetProcAddr requests
* loader_coalesce_extensions(void) - add extension records to the list of
* global
* extension available to the app.
* instance_disp - add function pointer for terminator function to this array.
* The extension itself should be in a separate file that will be
* linked directly with the loader.
*/
void loader_get_icd_loader_instance_extensions(
const struct loader_instance *inst, struct loader_icd_libs *icd_libs,
struct loader_extension_list *inst_exts) {
struct loader_extension_list icd_exts;
loader_log(inst, VK_DEBUG_REPORT_DEBUG_BIT_EXT, 0,
"Build ICD instance extension list");
// traverse scanned icd list adding non-duplicate extensions to the list
for (uint32_t i = 0; i < icd_libs->count; i++) {
loader_init_generic_list(inst, (struct loader_generic_list *)&icd_exts,
sizeof(VkExtensionProperties));
loader_add_instance_extensions(
inst, icd_libs->list[i].EnumerateInstanceExtensionProperties,
icd_libs->list[i].lib_name, &icd_exts);
loader_add_to_ext_list(inst, inst_exts, icd_exts.count, icd_exts.list);
loader_destroy_generic_list(inst,
(struct loader_generic_list *)&icd_exts);
};
// Traverse loader's extensions, adding non-duplicate extensions to the list
wsi_add_instance_extensions(inst, inst_exts);
debug_report_add_instance_extensions(inst, inst_exts);
}
struct loader_icd *loader_get_icd_and_device(const VkDevice device,
struct loader_device **found_dev) {
*found_dev = NULL;
for (struct loader_instance *inst = loader.instances; inst;
inst = inst->next) {
for (struct loader_icd *icd = inst->icds; icd; icd = icd->next) {
for (struct loader_device *dev = icd->logical_device_list; dev;
dev = dev->next)
/* Value comparison of device prevents object wrapping by layers
*/
if (loader_get_dispatch(dev->device) ==
loader_get_dispatch(device)) {
*found_dev = dev;
return icd;
}
}
}
return NULL;
}
static void loader_destroy_logical_device(const struct loader_instance *inst,
struct loader_device *dev) {
loader_heap_free(inst, dev->app_extension_props);
loader_destroy_layer_list(inst, &dev->activated_layer_list);
loader_heap_free(inst, dev);
}
struct loader_device *
loader_add_logical_device(const struct loader_instance *inst,
struct loader_device **device_list) {
struct loader_device *new_dev;
new_dev = loader_heap_alloc(inst, sizeof(struct loader_device),
VK_SYSTEM_ALLOCATION_SCOPE_DEVICE);
if (!new_dev) {
loader_log(inst, VK_DEBUG_REPORT_ERROR_BIT_EXT, 0,
"Failed to alloc struct loader-device");
return NULL;
}
memset(new_dev, 0, sizeof(struct loader_device));
new_dev->next = *device_list;
*device_list = new_dev;
return new_dev;
}
void loader_remove_logical_device(const struct loader_instance *inst,
struct loader_icd *icd,
struct loader_device *found_dev) {
struct loader_device *dev, *prev_dev;
if (!icd || !found_dev)
return;
prev_dev = NULL;
dev = icd->logical_device_list;
while (dev && dev != found_dev) {
prev_dev = dev;
dev = dev->next;
}
if (prev_dev)
prev_dev->next = found_dev->next;
else
icd->logical_device_list = found_dev->next;
loader_destroy_logical_device(inst, found_dev);
}
static void loader_icd_destroy(struct loader_instance *ptr_inst,
struct loader_icd *icd) {
ptr_inst->total_icd_count--;
for (struct loader_device *dev = icd->logical_device_list; dev;) {
struct loader_device *next_dev = dev->next;
loader_destroy_logical_device(ptr_inst, dev);
dev = next_dev;
}
if (icd->phys_devs != NULL)
loader_heap_free(ptr_inst, icd->phys_devs);
loader_heap_free(ptr_inst, icd);
}
static struct loader_icd *
loader_icd_create(const struct loader_instance *inst) {
struct loader_icd *icd;
icd = loader_heap_alloc(inst, sizeof(*icd),
VK_SYSTEM_ALLOCATION_SCOPE_INSTANCE);
if (!icd)
return NULL;
memset(icd, 0, sizeof(*icd));
return icd;
}
static struct loader_icd *
loader_icd_add(struct loader_instance *ptr_inst,
const struct loader_scanned_icds *icd_lib) {
struct loader_icd *icd;
icd = loader_icd_create(ptr_inst);
if (!icd)
return NULL;
icd->this_icd_lib = icd_lib;
icd->this_instance = ptr_inst;
/* prepend to the list */
icd->next = ptr_inst->icds;
ptr_inst->icds = icd;
ptr_inst->total_icd_count++;
return icd;
}
void loader_scanned_icd_clear(const struct loader_instance *inst,
struct loader_icd_libs *icd_libs) {
if (icd_libs->capacity == 0)
return;
for (uint32_t i = 0; i < icd_libs->count; i++) {
loader_platform_close_library(icd_libs->list[i].handle);
loader_heap_free(inst, icd_libs->list[i].lib_name);
}
loader_heap_free(inst, icd_libs->list);
icd_libs->capacity = 0;
icd_libs->count = 0;
icd_libs->list = NULL;
}
static void loader_scanned_icd_init(const struct loader_instance *inst,
struct loader_icd_libs *icd_libs) {
loader_scanned_icd_clear(inst, icd_libs);
icd_libs->capacity = 8 * sizeof(struct loader_scanned_icds);
icd_libs->list = loader_heap_alloc(inst, icd_libs->capacity,
VK_SYSTEM_ALLOCATION_SCOPE_INSTANCE);
}
static void loader_scanned_icd_add(const struct loader_instance *inst,
struct loader_icd_libs *icd_libs,
const char *filename, uint32_t api_version) {
loader_platform_dl_handle handle;
PFN_vkCreateInstance fp_create_inst;
PFN_vkEnumerateInstanceExtensionProperties fp_get_inst_ext_props;
PFN_vkGetInstanceProcAddr fp_get_proc_addr;
struct loader_scanned_icds *new_node;
/* TODO implement ref counting of libraries, for now this function leaves
libraries open and the scanned_icd_clear closes them */
// Used to call: dlopen(filename, RTLD_LAZY);
handle = loader_platform_open_library(filename);
if (!handle) {
loader_log(inst, VK_DEBUG_REPORT_WARNING_BIT_EXT, 0,
loader_platform_open_library_error(filename));
return;
}
fp_get_proc_addr =
loader_platform_get_proc_address(handle, "vk_icdGetInstanceProcAddr");
if (!fp_get_proc_addr) {
// Use deprecated interface
fp_get_proc_addr =
loader_platform_get_proc_address(handle, "vkGetInstanceProcAddr");
if (!fp_get_proc_addr) {
loader_log(inst, VK_DEBUG_REPORT_ERROR_BIT_EXT, 0,
loader_platform_get_proc_address_error(
"vk_icdGetInstanceProcAddr"));
return;
} else {
loader_log(inst, VK_DEBUG_REPORT_WARNING_BIT_EXT, 0,
"Using deprecated ICD interface of "
"vkGetInstanceProcAddr instead of "
"vk_icdGetInstanceProcAddr");
}
fp_create_inst =
loader_platform_get_proc_address(handle, "vkCreateInstance");
if (!fp_create_inst) {
loader_log(
inst, VK_DEBUG_REPORT_ERROR_BIT_EXT, 0,
"Couldn't get vkCreateInstance via dlsym/loadlibrary from ICD");
return;
}
fp_get_inst_ext_props = loader_platform_get_proc_address(
handle, "vkEnumerateInstanceExtensionProperties");
if (!fp_get_inst_ext_props) {
loader_log(inst, VK_DEBUG_REPORT_ERROR_BIT_EXT, 0,
"Couldn't get vkEnumerateInstanceExtensionProperties "
"via dlsym/loadlibrary from ICD");
return;
}
} else {
// Use newer interface
fp_create_inst =
(PFN_vkCreateInstance)fp_get_proc_addr(NULL, "vkCreateInstance");
if (!fp_create_inst) {
loader_log(inst, VK_DEBUG_REPORT_ERROR_BIT_EXT, 0,
"Couldn't get vkCreateInstance via "
"vk_icdGetInstanceProcAddr from ICD");
return;
}
fp_get_inst_ext_props =
(PFN_vkEnumerateInstanceExtensionProperties)fp_get_proc_addr(
NULL, "vkEnumerateInstanceExtensionProperties");
if (!fp_get_inst_ext_props) {
loader_log(inst, VK_DEBUG_REPORT_ERROR_BIT_EXT, 0,
"Couldn't get vkEnumerateInstanceExtensionProperties "
"via vk_icdGetInstanceProcAddr from ICD");
return;
}
}
// check for enough capacity
if ((icd_libs->count * sizeof(struct loader_scanned_icds)) >=
icd_libs->capacity) {
icd_libs->list = loader_heap_realloc(
inst, icd_libs->list, icd_libs->capacity, icd_libs->capacity * 2,
VK_SYSTEM_ALLOCATION_SCOPE_INSTANCE);
// double capacity
icd_libs->capacity *= 2;
}
new_node = &(icd_libs->list[icd_libs->count]);
new_node->handle = handle;
new_node->api_version = api_version;
new_node->GetInstanceProcAddr = fp_get_proc_addr;
new_node->EnumerateInstanceExtensionProperties = fp_get_inst_ext_props;
new_node->CreateInstance = fp_create_inst;
new_node->lib_name = (char *)loader_heap_alloc(
inst, strlen(filename) + 1, VK_SYSTEM_ALLOCATION_SCOPE_INSTANCE);
if (!new_node->lib_name) {
loader_log(inst, VK_DEBUG_REPORT_WARNING_BIT_EXT, 0,
"Out of memory can't add icd");
return;
}
strcpy(new_node->lib_name, filename);
icd_libs->count++;
}
static bool loader_icd_init_entrys(struct loader_icd *icd, VkInstance inst,
const PFN_vkGetInstanceProcAddr fp_gipa) {
/* initialize entrypoint function pointers */
#define LOOKUP_GIPA(func, required) \
do { \
icd->func = (PFN_vk##func)fp_gipa(inst, "vk" #func); \
if (!icd->func && required) { \
loader_log((struct loader_instance *)inst, \
VK_DEBUG_REPORT_WARNING_BIT_EXT, 0, \
loader_platform_get_proc_address_error("vk" #func)); \
return false; \
} \
} while (0)
LOOKUP_GIPA(GetDeviceProcAddr, true);
LOOKUP_GIPA(DestroyInstance, true);
LOOKUP_GIPA(EnumeratePhysicalDevices, true);
LOOKUP_GIPA(GetPhysicalDeviceFeatures, true);
LOOKUP_GIPA(GetPhysicalDeviceFormatProperties, true);
LOOKUP_GIPA(GetPhysicalDeviceImageFormatProperties, true);
LOOKUP_GIPA(CreateDevice, true);
LOOKUP_GIPA(GetPhysicalDeviceProperties, true);
LOOKUP_GIPA(GetPhysicalDeviceMemoryProperties, true);
LOOKUP_GIPA(GetPhysicalDeviceQueueFamilyProperties, true);
LOOKUP_GIPA(EnumerateDeviceExtensionProperties, true);
LOOKUP_GIPA(GetPhysicalDeviceSparseImageFormatProperties, true);
LOOKUP_GIPA(CreateDebugReportCallbackEXT, false);
LOOKUP_GIPA(DestroyDebugReportCallbackEXT, false);
LOOKUP_GIPA(GetPhysicalDeviceSurfaceSupportKHR, false);
LOOKUP_GIPA(GetPhysicalDeviceSurfaceCapabilitiesKHR, false);
LOOKUP_GIPA(GetPhysicalDeviceSurfaceFormatsKHR, false);
LOOKUP_GIPA(GetPhysicalDeviceSurfacePresentModesKHR, false);
#ifdef VK_USE_PLATFORM_WIN32_KHR
LOOKUP_GIPA(GetPhysicalDeviceWin32PresentationSupportKHR, false);
#endif
#ifdef VK_USE_PLATFORM_XCB_KHR
LOOKUP_GIPA(GetPhysicalDeviceXcbPresentationSupportKHR, false);
#endif
#ifdef VK_USE_PLATFORM_XLIB_KHR
LOOKUP_GIPA(GetPhysicalDeviceXlibPresentationSupportKHR, false);
#endif
#ifdef VK_USE_PLATFORM_WAYLAND_KHR
LOOKUP_GIPA(GetPhysicalDeviceWaylandPresentationSupportKHR, false);
#endif
#undef LOOKUP_GIPA
return true;
}
static void loader_debug_init(void) {
const char *env, *orig;
if (g_loader_debug > 0)
return;
g_loader_debug = 0;
/* parse comma-separated debug options */
orig = env = loader_getenv("VK_LOADER_DEBUG");
while (env) {
const char *p = strchr(env, ',');
size_t len;
if (p)
len = p - env;
else
len = strlen(env);
if (len > 0) {
if (strncmp(env, "all", len) == 0) {
g_loader_debug = ~0u;
g_loader_log_msgs = ~0u;
} else if (strncmp(env, "warn", len) == 0) {
g_loader_debug |= LOADER_WARN_BIT;
g_loader_log_msgs |= VK_DEBUG_REPORT_WARNING_BIT_EXT;
} else if (strncmp(env, "info", len) == 0) {
g_loader_debug |= LOADER_INFO_BIT;
g_loader_log_msgs |= VK_DEBUG_REPORT_INFORMATION_BIT_EXT;
} else if (strncmp(env, "perf", len) == 0) {
g_loader_debug |= LOADER_PERF_BIT;
g_loader_log_msgs |=
VK_DEBUG_REPORT_PERFORMANCE_WARNING_BIT_EXT;
} else if (strncmp(env, "error", len) == 0) {
g_loader_debug |= LOADER_ERROR_BIT;
g_loader_log_msgs |= VK_DEBUG_REPORT_ERROR_BIT_EXT;
} else if (strncmp(env, "debug", len) == 0) {
g_loader_debug |= LOADER_DEBUG_BIT;
g_loader_log_msgs |= VK_DEBUG_REPORT_DEBUG_BIT_EXT;
}
}
if (!p)
break;
env = p + 1;
}
loader_free_getenv(orig);
}
void loader_initialize(void) {
// initialize mutexs
loader_platform_thread_create_mutex(&loader_lock);
loader_platform_thread_create_mutex(&loader_json_lock);
// initialize logging
loader_debug_init();
// initial cJSON to use alloc callbacks
cJSON_Hooks alloc_fns = {
.malloc_fn = loader_tls_heap_alloc, .free_fn = loader_tls_heap_free,
};
cJSON_InitHooks(&alloc_fns);
}
struct loader_manifest_files {
uint32_t count;
char **filename_list;
};
/**
* Get next file or dirname given a string list or registry key path
*
* \returns
* A pointer to first char in the next path.
* The next path (or NULL) in the list is returned in next_path.
* Note: input string is modified in some cases. PASS IN A COPY!
*/
static char *loader_get_next_path(char *path) {
uint32_t len;
char *next;
if (path == NULL)
return NULL;
next = strchr(path, PATH_SEPERATOR);
if (next == NULL) {
len = (uint32_t)strlen(path);
next = path + len;
} else {
*next = '\0';
next++;
}
return next;
}
/**
* Given a path which is absolute or relative, expand the path if relative or
* leave the path unmodified if absolute. The base path to prepend to relative
* paths is given in rel_base.
*
* \returns
* A string in out_fullpath of the full absolute path
*/
static void loader_expand_path(const char *path, const char *rel_base,
size_t out_size, char *out_fullpath) {
if (loader_platform_is_path_absolute(path)) {
// do not prepend a base to an absolute path
rel_base = "";
}
loader_platform_combine_path(out_fullpath, out_size, rel_base, path, NULL);
}
/**
* Given a filename (file) and a list of paths (dir), try to find an existing
* file in the paths. If filename already is a path then no
* searching in the given paths.
*
* \returns
* A string in out_fullpath of either the full path or file.
*/
static void loader_get_fullpath(const char *file, const char *dirs,
size_t out_size, char *out_fullpath) {
if (!loader_platform_is_path(file) && *dirs) {
char *dirs_copy, *dir, *next_dir;
dirs_copy = loader_stack_alloc(strlen(dirs) + 1);
strcpy(dirs_copy, dirs);
// find if file exists after prepending paths in given list
for (dir = dirs_copy; *dir && (next_dir = loader_get_next_path(dir));
dir = next_dir) {
loader_platform_combine_path(out_fullpath, out_size, dir, file,
NULL);
if (loader_platform_file_exists(out_fullpath)) {
return;
}
}
}
snprintf(out_fullpath, out_size, "%s", file);
}
/**
* Read a JSON file into a buffer.
*
* \returns
* A pointer to a cJSON object representing the JSON parse tree.
* This returned buffer should be freed by caller.
*/
static cJSON *loader_get_json(const struct loader_instance *inst,
const char *filename) {
FILE *file;
char *json_buf;
cJSON *json;
size_t len;
file = fopen(filename, "rb");
if (!file) {
loader_log(inst, VK_DEBUG_REPORT_ERROR_BIT_EXT, 0,
"Couldn't open JSON file %s", filename);
return NULL;
}
fseek(file, 0, SEEK_END);
len = ftell(file);
fseek(file, 0, SEEK_SET);
json_buf = (char *)loader_stack_alloc(len + 1);
if (json_buf == NULL) {
loader_log(inst, VK_DEBUG_REPORT_ERROR_BIT_EXT, 0,
"Out of memory can't get JSON file");
fclose(file);
return NULL;
}
if (fread(json_buf, sizeof(char), len, file) != len) {
loader_log(inst, VK_DEBUG_REPORT_ERROR_BIT_EXT, 0,
"fread failed can't get JSON file");
fclose(file);
return NULL;
}
fclose(file);
json_buf[len] = '\0';
// parse text from file
json = cJSON_Parse(json_buf);
if (json == NULL)
loader_log(inst, VK_DEBUG_REPORT_ERROR_BIT_EXT, 0,
"Can't parse JSON file %s", filename);
return json;
}
/**
* Do a deep copy of the loader_layer_properties structure.
*/
static void loader_copy_layer_properties(const struct loader_instance *inst,
struct loader_layer_properties *dst,
struct loader_layer_properties *src) {
uint32_t cnt, i;
memcpy(dst, src, sizeof(*src));
dst->instance_extension_list.list =
loader_heap_alloc(inst, sizeof(VkExtensionProperties) *
src->instance_extension_list.count,
VK_SYSTEM_ALLOCATION_SCOPE_INSTANCE);
dst->instance_extension_list.capacity =
sizeof(VkExtensionProperties) * src->instance_extension_list.count;
memcpy(dst->instance_extension_list.list, src->instance_extension_list.list,
dst->instance_extension_list.capacity);
dst->device_extension_list.list =
loader_heap_alloc(inst, sizeof(struct loader_dev_ext_props) *
src->device_extension_list.count,
VK_SYSTEM_ALLOCATION_SCOPE_INSTANCE);
dst->device_extension_list.capacity =
sizeof(struct loader_dev_ext_props) * src->device_extension_list.count;
memcpy(dst->device_extension_list.list, src->device_extension_list.list,
dst->device_extension_list.capacity);
if (src->device_extension_list.count > 0 &&
src->device_extension_list.list->entrypoint_count > 0) {
cnt = src->device_extension_list.list->entrypoint_count;
dst->device_extension_list.list->entrypoints = loader_heap_alloc(
inst, sizeof(char *) * cnt, VK_SYSTEM_ALLOCATION_SCOPE_INSTANCE);
for (i = 0; i < cnt; i++) {
dst->device_extension_list.list->entrypoints[i] = loader_heap_alloc(
inst,
strlen(src->device_extension_list.list->entrypoints[i]) + 1,
VK_SYSTEM_ALLOCATION_SCOPE_INSTANCE);
strcpy(dst->device_extension_list.list->entrypoints[i],
src->device_extension_list.list->entrypoints[i]);
}
}
}
static bool
loader_find_layer_name_list(const char *name,
const struct loader_layer_list *layer_list) {
if (!layer_list)
return false;
for (uint32_t j = 0; j < layer_list->count; j++)
if (!strcmp(name, layer_list->list[j].info.layerName))
return true;
return false;
}
static bool loader_find_layer_name(const char *name, uint32_t layer_count,
const char **layer_list) {
if (!layer_list)
return false;
for (uint32_t j = 0; j < layer_count; j++)
if (!strcmp(name, layer_list[j]))
return true;
return false;
}
static bool loader_find_layer_name_array(
const char *name, uint32_t layer_count,
const char layer_list[][VK_MAX_EXTENSION_NAME_SIZE]) {
if (!layer_list)
return false;
for (uint32_t j = 0; j < layer_count; j++)
if (!strcmp(name, layer_list[j]))
return true;
return false;
}
/**
* Searches through an array of layer names (ppp_layer_names) looking for a
* layer key_name.
* If not found then simply returns updating nothing.
* Otherwise, it uses expand_count, expand_names adding them to layer names.
* Any duplicate (pre-existing) exapand_names in layer names are removed.
* Expand names are added to the back/end of the list of layer names.
* @param inst
* @param layer_count
* @param ppp_layer_names
*/
void loader_expand_layer_names(
const struct loader_instance *inst, const char *key_name,
uint32_t expand_count,
const char expand_names[][VK_MAX_EXTENSION_NAME_SIZE],
uint32_t *layer_count, char ***ppp_layer_names) {
char **pp_layer_names, **pp_src_layers = *ppp_layer_names;
if (!loader_find_layer_name(key_name, *layer_count,
(const char **)pp_src_layers))
return; // didn't find the key_name in the list
// since the total number of layers may expand, allocate new memory for the
// array of pointers
pp_layer_names =
loader_heap_alloc(inst, (expand_count + *layer_count) * sizeof(char *),
VK_SYSTEM_ALLOCATION_SCOPE_COMMAND);
loader_log(inst, VK_DEBUG_REPORT_INFORMATION_BIT_EXT, 0,
"Found meta layer %s, replacing with actual layer group",
key_name);
// In place removal of any expand_names found in layer_name (remove
// duplicates)
// Also remove the key_name
uint32_t src_idx, dst_idx, cnt = *layer_count;
for (src_idx = 0; src_idx < *layer_count; src_idx++) {
if (loader_find_layer_name_array(pp_src_layers[src_idx], expand_count,
expand_names)) {
pp_src_layers[src_idx] = NULL;
cnt--;
} else if (!strcmp(pp_src_layers[src_idx], key_name)) {
pp_src_layers[src_idx] = NULL;
cnt--;
}
pp_layer_names[src_idx] = pp_src_layers[src_idx];
}
for (dst_idx = 0; dst_idx < cnt; dst_idx++) {
if (pp_layer_names[dst_idx] == NULL) {
src_idx = dst_idx + 1;
while (src_idx < *layer_count && pp_src_layers[src_idx] == NULL)
src_idx++;
if (src_idx < *layer_count && pp_src_layers[src_idx] != NULL)
pp_layer_names[dst_idx] = pp_src_layers[src_idx];
}
}
// Add the expand_names to layer_names
src_idx = 0;
for (dst_idx = cnt; dst_idx < cnt + expand_count; dst_idx++) {
pp_layer_names[dst_idx] = (char *)&expand_names[src_idx++][0];
}
*layer_count = expand_count + cnt;
*ppp_layer_names = pp_layer_names;
return;
}
/**
* Restores the layer name list and count into the pCreatInfo structure.
* If is_device == tru then pCreateInfo is a device structure else an instance
* structure.
* @param layer_count
* @param layer_names
* @param pCreateInfo
*/
void loader_unexpand_dev_layer_names(const struct loader_instance *inst,
uint32_t layer_count, char **layer_names,
char **layer_ptr,
const VkDeviceCreateInfo *pCreateInfo) {
uint32_t *p_cnt = (uint32_t *)&pCreateInfo->enabledLayerCount;
*p_cnt = layer_count;
char ***p_ptr = (char ***)&pCreateInfo->ppEnabledLayerNames;
if ((char **)pCreateInfo->ppEnabledLayerNames != layer_ptr)
loader_heap_free(inst, (void *)pCreateInfo->ppEnabledLayerNames);
*p_ptr = layer_ptr;
for (uint32_t i = 0; i < layer_count; i++) {
char **pp_str = (char **)&pCreateInfo->ppEnabledLayerNames[i];
*pp_str = layer_names[i];
}
}
void loader_unexpand_inst_layer_names(const struct loader_instance *inst,
uint32_t layer_count, char **layer_names,
char **layer_ptr,
const VkInstanceCreateInfo *pCreateInfo) {
uint32_t *p_cnt = (uint32_t *)&pCreateInfo->enabledLayerCount;
*p_cnt = layer_count;
char ***p_ptr = (char ***)&pCreateInfo->ppEnabledLayerNames;
if ((char **)pCreateInfo->ppEnabledLayerNames != layer_ptr)
loader_heap_free(inst, (void *)pCreateInfo->ppEnabledLayerNames);
*p_ptr = layer_ptr;
for (uint32_t i = 0; i < layer_count; i++) {
char **pp_str = (char **)&pCreateInfo->ppEnabledLayerNames[i];
*pp_str = layer_names[i];
}
}
/**
* Searches through the existing instance and device layer lists looking for
* the set of required layer names. If found then it adds a meta property to the
* layer list.
* Assumes the required layers are the same for both instance and device lists.
* @param inst
* @param layer_count number of layers in layer_names
* @param layer_names array of required layer names
* @param layer_instance_list
* @param layer_device_list
*/
static void loader_add_layer_property_meta(
const struct loader_instance *inst, uint32_t layer_count,
const char layer_names[][VK_MAX_EXTENSION_NAME_SIZE],
struct loader_layer_list *layer_instance_list,
struct loader_layer_list *layer_device_list) {
uint32_t i, j;
bool found;
struct loader_layer_list *layer_list;
if (0 == layer_count || (!layer_instance_list && !layer_device_list))
return;
if ((layer_instance_list && (layer_count > layer_instance_list->count)) &&
(layer_device_list && (layer_count > layer_device_list->count)))
return;
for (j = 0; j < 2; j++) {
if (j == 0)
layer_list = layer_instance_list;
else
layer_list = layer_device_list;
found = true;
if (layer_list == NULL)
continue;
for (i = 0; i < layer_count; i++) {
if (loader_find_layer_name_list(layer_names[i], layer_list))
continue;
found = false;
break;
}
struct loader_layer_properties *props;
if (found) {
props = loader_get_next_layer_property(inst, layer_list);
props->type = VK_LAYER_TYPE_META_EXPLICT;
strncpy(props->info.description, "LunarG Standard Validation Layer",
sizeof(props->info.description));
props->info.implementationVersion = 1;
strncpy(props->info.layerName, std_validation_str,
sizeof(props->info.layerName));
// TODO what about specVersion? for now insert loader's built
// version
props->info.specVersion = VK_API_VERSION_1_0;
}
}
}
/**
* Given a cJSON struct (json) of the top level JSON object from layer manifest
* file, add entry to the layer_list.
* Fill out the layer_properties in this list entry from the input cJSON object.
*
* \returns
* void
* layer_list has a new entry and initialized accordingly.
* If the json input object does not have all the required fields no entry
* is added to the list.
*/
static void
loader_add_layer_properties(const struct loader_instance *inst,
struct loader_layer_list *layer_instance_list,
struct loader_layer_list *layer_device_list,
cJSON *json, bool is_implicit, char *filename) {
/* Fields in layer manifest file that are required:
* (required) “file_format_version”
* following are required in the "layer" object:
* (required) "name"
* (required) "type"
* (required) “library_path”
* (required) “api_version”
* (required) “implementation_version”
* (required) “description”
* (required for implicit layers) “disable_environment”
*
* First get all required items and if any missing abort
*/
cJSON *item, *layer_node, *ext_item;
char *temp;
char *name, *type, *library_path, *api_version;
char *implementation_version, *description;
cJSON *disable_environment = NULL;
int i, j;
VkExtensionProperties ext_prop;
item = cJSON_GetObjectItem(json, "file_format_version");
if (item == NULL) {
return;
}
char *file_vers = cJSON_PrintUnformatted(item);
loader_log(inst, VK_DEBUG_REPORT_INFORMATION_BIT_EXT, 0,
"Found manifest file %s, version %s", filename, file_vers);
if (strcmp(file_vers, "\"1.0.0\"") != 0)
loader_log(inst, VK_DEBUG_REPORT_WARNING_BIT_EXT, 0,
"Unexpected manifest file version (expected 1.0.0), may "
"cause errors");
loader_tls_heap_free(file_vers);
layer_node = cJSON_GetObjectItem(json, "layer");
if (layer_node == NULL) {
loader_log(inst, VK_DEBUG_REPORT_WARNING_BIT_EXT, 0,
"Can't find \"layer\" object in manifest JSON file, "
"skipping this file");
return;
}
// loop through all "layer" objects in the file
do {
#define GET_JSON_OBJECT(node, var) \
{ \
var = cJSON_GetObjectItem(node, #var); \
if (var == NULL) { \
layer_node = layer_node->next; \
loader_log(inst, VK_DEBUG_REPORT_WARNING_BIT_EXT, 0, \
"Didn't find required layer object %s in manifest " \
"JSON file, skipping this layer", \
#var); \
continue; \
} \
}
#define GET_JSON_ITEM(node, var) \
{ \
item = cJSON_GetObjectItem(node, #var); \
if (item == NULL) { \
layer_node = layer_node->next; \
loader_log(inst, VK_DEBUG_REPORT_WARNING_BIT_EXT, 0, \
"Didn't find required layer value %s in manifest JSON " \
"file, skipping this layer", \
#var); \
continue; \
} \
temp = cJSON_Print(item); \
temp[strlen(temp) - 1] = '\0'; \
var = loader_stack_alloc(strlen(temp) + 1); \
strcpy(var, &temp[1]); \
loader_tls_heap_free(temp); \
}
GET_JSON_ITEM(layer_node, name)
GET_JSON_ITEM(layer_node, type)
GET_JSON_ITEM(layer_node, library_path)
GET_JSON_ITEM(layer_node, api_version)
GET_JSON_ITEM(layer_node, implementation_version)
GET_JSON_ITEM(layer_node, description)
if (is_implicit) {
GET_JSON_OBJECT(layer_node, disable_environment)
}
#undef GET_JSON_ITEM
#undef GET_JSON_OBJECT
// add list entry
struct loader_layer_properties *props = NULL;
if (!strcmp(type, "DEVICE")) {
if (layer_device_list == NULL) {
layer_node = layer_node->next;
continue;
}
props = loader_get_next_layer_property(inst, layer_device_list);
props->type = (is_implicit) ? VK_LAYER_TYPE_DEVICE_IMPLICIT
: VK_LAYER_TYPE_DEVICE_EXPLICIT;
}
if (!strcmp(type, "INSTANCE")) {
if (layer_instance_list == NULL) {
layer_node = layer_node->next;
continue;
}
props = loader_get_next_layer_property(inst, layer_instance_list);
props->type = (is_implicit) ? VK_LAYER_TYPE_INSTANCE_IMPLICIT
: VK_LAYER_TYPE_INSTANCE_EXPLICIT;
}
if (!strcmp(type, "GLOBAL")) {
if (layer_instance_list != NULL)
props =
loader_get_next_layer_property(inst, layer_instance_list);
else if (layer_device_list != NULL)
props = loader_get_next_layer_property(inst, layer_device_list);
else {
layer_node = layer_node->next;
continue;
}
props->type = (is_implicit) ? VK_LAYER_TYPE_GLOBAL_IMPLICIT
: VK_LAYER_TYPE_GLOBAL_EXPLICIT;
}
if (props == NULL) {
layer_node = layer_node->next;
continue;
}
strncpy(props->info.layerName, name, sizeof(props->info.layerName));
props->info.layerName[sizeof(props->info.layerName) - 1] = '\0';
char *fullpath = props->lib_name;
char *rel_base;
if (loader_platform_is_path(library_path)) {
// a relative or absolute path
char *name_copy = loader_stack_alloc(strlen(filename) + 1);
strcpy(name_copy, filename);
rel_base = loader_platform_dirname(name_copy);
loader_expand_path(library_path, rel_base, MAX_STRING_SIZE,
fullpath);
} else {
// a filename which is assumed in a system directory
loader_get_fullpath(library_path, DEFAULT_VK_LAYERS_PATH,
MAX_STRING_SIZE, fullpath);
}
props->info.specVersion = loader_make_version(api_version);
props->info.implementationVersion = atoi(implementation_version);
strncpy((char *)props->info.description, description,
sizeof(props->info.description));
props->info.description[sizeof(props->info.description) - 1] = '\0';
if (is_implicit) {
if (!disable_environment || !disable_environment->child) {
loader_log(
inst, VK_DEBUG_REPORT_WARNING_BIT_EXT, 0,
"Didn't find required layer child value disable_environment"
"in manifest JSON file, skipping this layer");
layer_node = layer_node->next;
continue;
}
strncpy(props->disable_env_var.name,
disable_environment->child->string,
sizeof(props->disable_env_var.name));
props->disable_env_var
.name[sizeof(props->disable_env_var.name) - 1] = '\0';
strncpy(props->disable_env_var.value,
disable_environment->child->valuestring,
sizeof(props->disable_env_var.value));
props->disable_env_var
.value[sizeof(props->disable_env_var.value) - 1] = '\0';
}
/**
* Now get all optional items and objects and put in list:
* functions
* instance_extensions
* device_extensions
* enable_environment (implicit layers only)
*/
#define GET_JSON_OBJECT(node, var) \
{ var = cJSON_GetObjectItem(node, #var); }
#define GET_JSON_ITEM(node, var) \
{ \
item = cJSON_GetObjectItem(node, #var); \
if (item != NULL) { \
temp = cJSON_Print(item); \
temp[strlen(temp) - 1] = '\0'; \
var = loader_stack_alloc(strlen(temp) + 1); \
strcpy(var, &temp[1]); \
loader_tls_heap_free(temp); \
} \
}
cJSON *instance_extensions, *device_extensions, *functions,
*enable_environment;
cJSON *entrypoints;
char *vkGetInstanceProcAddr, *vkGetDeviceProcAddr, *spec_version;
char **entry_array;
vkGetInstanceProcAddr = NULL;
vkGetDeviceProcAddr = NULL;
spec_version = NULL;
entrypoints = NULL;
entry_array = NULL;
/**
* functions
* vkGetInstanceProcAddr
* vkGetDeviceProcAddr
*/
GET_JSON_OBJECT(layer_node, functions)
if (functions != NULL) {
GET_JSON_ITEM(functions, vkGetInstanceProcAddr)
GET_JSON_ITEM(functions, vkGetDeviceProcAddr)
if (vkGetInstanceProcAddr != NULL)
strncpy(props->functions.str_gipa, vkGetInstanceProcAddr,
sizeof(props->functions.str_gipa));
props->functions.str_gipa[sizeof(props->functions.str_gipa) - 1] =
'\0';
if (vkGetDeviceProcAddr != NULL)
strncpy(props->functions.str_gdpa, vkGetDeviceProcAddr,
sizeof(props->functions.str_gdpa));
props->functions.str_gdpa[sizeof(props->functions.str_gdpa) - 1] =
'\0';
}
/**
* instance_extensions
* array of
* name
* spec_version
*/
GET_JSON_OBJECT(layer_node, instance_extensions)
if (instance_extensions != NULL) {
int count = cJSON_GetArraySize(instance_extensions);
for (i = 0; i < count; i++) {
ext_item = cJSON_GetArrayItem(instance_extensions, i);
GET_JSON_ITEM(ext_item, name)
GET_JSON_ITEM(ext_item, spec_version)
if (name != NULL) {
strncpy(ext_prop.extensionName, name,
sizeof(ext_prop.extensionName));
ext_prop.extensionName[sizeof(ext_prop.extensionName) - 1] =
'\0';
}
ext_prop.specVersion = atoi(spec_version);
loader_add_to_ext_list(inst, &props->instance_extension_list, 1,
&ext_prop);
}
}
/**
* device_extensions
* array of
* name
* spec_version
* entrypoints
*/
GET_JSON_OBJECT(layer_node, device_extensions)
if (device_extensions != NULL) {
int count = cJSON_GetArraySize(device_extensions);
for (i = 0; i < count; i++) {
ext_item = cJSON_GetArrayItem(device_extensions, i);
GET_JSON_ITEM(ext_item, name)
GET_JSON_ITEM(ext_item, spec_version)
if (name != NULL) {
strncpy(ext_prop.extensionName, name,
sizeof(ext_prop.extensionName));
ext_prop.extensionName[sizeof(ext_prop.extensionName) - 1] =
'\0';
}
ext_prop.specVersion = atoi(spec_version);
// entrypoints = cJSON_GetObjectItem(ext_item, "entrypoints");
GET_JSON_OBJECT(ext_item, entrypoints)
int entry_count;
if (entrypoints == NULL) {
loader_add_to_dev_ext_list(inst,
&props->device_extension_list,
&ext_prop, 0, NULL);
continue;
}
entry_count = cJSON_GetArraySize(entrypoints);
if (entry_count)
entry_array = (char **)loader_stack_alloc(sizeof(char *) *
entry_count);
for (j = 0; j < entry_count; j++) {
ext_item = cJSON_GetArrayItem(entrypoints, j);
if (ext_item != NULL) {
temp = cJSON_Print(ext_item);
temp[strlen(temp) - 1] = '\0';
entry_array[j] = loader_stack_alloc(strlen(temp) + 1);
strcpy(entry_array[j], &temp[1]);
loader_tls_heap_free(temp);
}
}
loader_add_to_dev_ext_list(inst, &props->device_extension_list,
&ext_prop, entry_count, entry_array);
}
}
if (is_implicit) {
GET_JSON_OBJECT(layer_node, enable_environment)
// enable_environment is optional
if (enable_environment) {
strncpy(props->enable_env_var.name,
enable_environment->child->string,
sizeof(props->enable_env_var.name));
props->enable_env_var
.name[sizeof(props->enable_env_var.name) - 1] = '\0';
strncpy(props->enable_env_var.value,
enable_environment->child->valuestring,
sizeof(props->enable_env_var.value));
props->enable_env_var
.value[sizeof(props->enable_env_var.value) - 1] = '\0';
}
}
#undef GET_JSON_ITEM
#undef GET_JSON_OBJECT
// for global layers need to add them to both device and instance list
if (!strcmp(type, "GLOBAL")) {
struct loader_layer_properties *dev_props;
if (layer_instance_list == NULL || layer_device_list == NULL) {
layer_node = layer_node->next;
continue;
}
dev_props = loader_get_next_layer_property(inst, layer_device_list);
// copy into device layer list
loader_copy_layer_properties(inst, dev_props, props);
}
layer_node = layer_node->next;
} while (layer_node != NULL);
return;
}
/**
* Find the Vulkan library manifest files.
*
* This function scans the "location" or "env_override" directories/files
* for a list of JSON manifest files. If env_override is non-NULL
* and has a valid value. Then the location is ignored. Otherwise
* location is used to look for manifest files. The location
* is interpreted as Registry path on Windows and a directory path(s)
* on Linux. "home_location" is an additional directory in the users home
* directory to look at. It is exapanded into the dir path $HOME/home_location.
* This "home_location" is only used on Linux.
*
* \returns
* A string list of manifest files to be opened in out_files param.
* List has a pointer to string for each manifest filename.
* When done using the list in out_files, pointers should be freed.
* Location or override string lists can be either files or directories as
*follows:
* | location | override
* --------------------------------
* Win ICD | files | files
* Win Layer | files | dirs
* Linux ICD | dirs | files
* Linux Layer| dirs | dirs
*/
static void loader_get_manifest_files(const struct loader_instance *inst,
const char *env_override, bool is_layer,
const char *location,
const char *home_location,
struct loader_manifest_files *out_files) {
char *override = NULL;
char *loc;
char *file, *next_file, *name;
size_t alloced_count = 64;
char full_path[2048];
DIR *sysdir = NULL;
bool list_is_dirs = false;
struct dirent *dent;
out_files->count = 0;
out_files->filename_list = NULL;
if (env_override != NULL && (override = loader_getenv(env_override))) {
#if !defined(_WIN32)
if (geteuid() != getuid()) {
/* Don't allow setuid apps to use the env var: */
loader_free_getenv(override);
override = NULL;
}
#endif
}
#if !defined(_WIN32)
if (location == NULL && home_location == NULL) {
#else
home_location = NULL;
if (location == NULL) {
#endif
loader_log(
inst, VK_DEBUG_REPORT_ERROR_BIT_EXT, 0,
"Can't get manifest files with NULL location, env_override=%s",
env_override);
return;
}
#if defined(_WIN32)
list_is_dirs = (is_layer && override != NULL) ? true : false;
#else
list_is_dirs = (override == NULL || is_layer) ? true : false;
#endif
// Make a copy of the input we are using so it is not modified
// Also handle getting the location(s) from registry on Windows
if (override == NULL) {
loc = loader_stack_alloc(strlen(location) + 1);
if (loc == NULL) {
loader_log(inst, VK_DEBUG_REPORT_ERROR_BIT_EXT, 0,
"Out of memory can't get manifest files");
return;
}
strcpy(loc, location);
#if defined(_WIN32)
loc = loader_get_registry_files(inst, loc);
if (loc == NULL) {
if (!is_layer) {
loader_log(inst, VK_DEBUG_REPORT_ERROR_BIT_EXT, 0,
"Registry lookup failed can't get ICD manifest "
"files, do you have a Vulkan driver installed");
} else {
// warning only for layers
loader_log(
inst, VK_DEBUG_REPORT_WARNING_BIT_EXT, 0,
"Registry lookup failed can't get layer manifest files");
}
return;
}
#endif
} else {
loc = loader_stack_alloc(strlen(override) + 1);
if (loc == NULL) {
loader_log(inst, VK_DEBUG_REPORT_ERROR_BIT_EXT, 0,
"Out of memory can't get manifest files");
return;
}
strcpy(loc, override);
loader_free_getenv(override);
}
// Print out the paths being searched if debugging is enabled
loader_log(inst, VK_DEBUG_REPORT_DEBUG_BIT_EXT, 0,
"Searching the following paths for manifest files: %s\n", loc);
file = loc;
while (*file) {
next_file = loader_get_next_path(file);
if (list_is_dirs) {
sysdir = opendir(file);
name = NULL;
if (sysdir) {
dent = readdir(sysdir);
if (dent == NULL)
break;
name = &(dent->d_name[0]);
loader_get_fullpath(name, file, sizeof(full_path), full_path);
name = full_path;
}
} else {
#if defined(_WIN32)
name = file;
#else
// only Linux has relative paths
char *dir;
// make a copy of location so it isn't modified
dir = loader_stack_alloc(strlen(loc) + 1);
if (dir == NULL) {
loader_log(inst, VK_DEBUG_REPORT_ERROR_BIT_EXT, 0,
"Out of memory can't get manifest files");
return;
}
strcpy(dir, loc);
loader_get_fullpath(file, dir, sizeof(full_path), full_path);
name = full_path;
#endif
}
while (name) {
/* Look for files ending with ".json" suffix */
uint32_t nlen = (uint32_t)strlen(name);
const char *suf = name + nlen - 5;
if ((nlen > 5) && !strncmp(suf, ".json", 5)) {
if (out_files->count == 0) {
out_files->filename_list =
loader_heap_alloc(inst, alloced_count * sizeof(char *),
VK_SYSTEM_ALLOCATION_SCOPE_COMMAND);
} else if (out_files->count == alloced_count) {
out_files->filename_list =
loader_heap_realloc(inst, out_files->filename_list,
alloced_count * sizeof(char *),
alloced_count * sizeof(char *) * 2,
VK_SYSTEM_ALLOCATION_SCOPE_COMMAND);
alloced_count *= 2;
}
if (out_files->filename_list == NULL) {
loader_log(inst, VK_DEBUG_REPORT_ERROR_BIT_EXT, 0,
"Out of memory can't alloc manifest file list");
return;
}
out_files->filename_list[out_files->count] = loader_heap_alloc(
inst, strlen(name) + 1, VK_SYSTEM_ALLOCATION_SCOPE_COMMAND);
if (out_files->filename_list[out_files->count] == NULL) {
loader_log(inst, VK_DEBUG_REPORT_ERROR_BIT_EXT, 0,
"Out of memory can't get manifest files");
return;
}
strcpy(out_files->filename_list[out_files->count], name);
out_files->count++;
} else if (!list_is_dirs) {
loader_log(
inst, VK_DEBUG_REPORT_WARNING_BIT_EXT, 0,
"Skipping manifest file %s, file name must end in .json",
name);
}
if (list_is_dirs) {
dent = readdir(sysdir);
if (dent == NULL)
break;
name = &(dent->d_name[0]);
loader_get_fullpath(name, file, sizeof(full_path), full_path);
name = full_path;
} else {
break;
}
}
if (sysdir)
closedir(sysdir);
file = next_file;
#if !defined(_WIN32)
if (home_location != NULL &&
(next_file == NULL || *next_file == '\0') && override == NULL) {
char *home = secure_getenv("HOME");
if (home != NULL) {
size_t len;
char *home_loc = loader_stack_alloc(strlen(home) + 2 +
strlen(home_location));
if (home_loc == NULL) {
loader_log(inst, VK_DEBUG_REPORT_ERROR_BIT_EXT, 0,
"Out of memory can't get manifest files");
return;
}
strcpy(home_loc, home);
// Add directory separator if needed
if (home_location[0] != DIRECTORY_SYMBOL) {
len = strlen(home_loc);
home_loc[len] = DIRECTORY_SYMBOL;
home_loc[len + 1] = '\0';
}
strcat(home_loc, home_location);
file = home_loc;
next_file = loader_get_next_path(file);
home_location = NULL;
loader_log(
inst, VK_DEBUG_REPORT_DEBUG_BIT_EXT, 0,
"Searching the following paths for manifest files: %s\n",
home_loc);
list_is_dirs = true;
}
}
#endif
}
return;
}
void loader_init_icd_lib_list() {}
void loader_destroy_icd_lib_list() {}
/**
* Try to find the Vulkan ICD driver(s).
*
* This function scans the default system loader path(s) or path
* specified by the \c VK_ICD_FILENAMES environment variable in
* order to find loadable VK ICDs manifest files. From these
* manifest files it finds the ICD libraries.
*
* \returns
* a list of icds that were discovered
*/
void loader_icd_scan(const struct loader_instance *inst,
struct loader_icd_libs *icds) {
char *file_str;
struct loader_manifest_files manifest_files;
loader_scanned_icd_init(inst, icds);
// Get a list of manifest files for ICDs
loader_get_manifest_files(inst, "VK_ICD_FILENAMES", false,
DEFAULT_VK_DRIVERS_INFO, HOME_VK_DRIVERS_INFO,
&manifest_files);
if (manifest_files.count == 0)
return;
loader_platform_thread_lock_mutex(&loader_json_lock);
for (uint32_t i = 0; i < manifest_files.count; i++) {
file_str = manifest_files.filename_list[i];
if (file_str == NULL)
continue;
cJSON *json;
json = loader_get_json(inst, file_str);
if (!json)
continue;
cJSON *item, *itemICD;
item = cJSON_GetObjectItem(json, "file_format_version");
if (item == NULL) {
loader_platform_thread_unlock_mutex(&loader_json_lock);
return;
}
char *file_vers = cJSON_Print(item);
loader_log(inst, VK_DEBUG_REPORT_INFORMATION_BIT_EXT, 0,
"Found manifest file %s, version %s", file_str, file_vers);
if (strcmp(file_vers, "\"1.0.0\"") != 0)
loader_log(inst, VK_DEBUG_REPORT_WARNING_BIT_EXT, 0,
"Unexpected manifest file version (expected 1.0.0), may "
"cause errors");
loader_tls_heap_free(file_vers);
itemICD = cJSON_GetObjectItem(json, "ICD");
if (itemICD != NULL) {
item = cJSON_GetObjectItem(itemICD, "library_path");
if (item != NULL) {
char *temp = cJSON_Print(item);
if (!temp || strlen(temp) == 0) {
loader_log(inst, VK_DEBUG_REPORT_WARNING_BIT_EXT, 0,
"Can't find \"library_path\" in ICD JSON file "
"%s, skipping",
file_str);
loader_tls_heap_free(temp);
loader_heap_free(inst, file_str);
cJSON_Delete(json);
continue;
}
// strip out extra quotes
temp[strlen(temp) - 1] = '\0';
char *library_path = loader_stack_alloc(strlen(temp) + 1);
strcpy(library_path, &temp[1]);
loader_tls_heap_free(temp);
if (!library_path || strlen(library_path) == 0) {
loader_log(inst, VK_DEBUG_REPORT_WARNING_BIT_EXT, 0,
"Can't find \"library_path\" in ICD JSON file "
"%s, skipping",
file_str);
loader_heap_free(inst, file_str);
cJSON_Delete(json);
continue;
}
char fullpath[MAX_STRING_SIZE];
// Print out the paths being searched if debugging is enabled
loader_log(
inst, VK_DEBUG_REPORT_DEBUG_BIT_EXT, 0,
"Searching for ICD drivers named %s default dir %s\n",
library_path, DEFAULT_VK_DRIVERS_PATH);
if (loader_platform_is_path(library_path)) {
// a relative or absolute path
char *name_copy = loader_stack_alloc(strlen(file_str) + 1);
char *rel_base;
strcpy(name_copy, file_str);
rel_base = loader_platform_dirname(name_copy);
loader_expand_path(library_path, rel_base, sizeof(fullpath),
fullpath);
} else {
// a filename which is assumed in a system directory
loader_get_fullpath(library_path, DEFAULT_VK_DRIVERS_PATH,
sizeof(fullpath), fullpath);
}
uint32_t vers = 0;
item = cJSON_GetObjectItem(itemICD, "api_version");
if (item != NULL) {
temp = cJSON_Print(item);
vers = loader_make_version(temp);
loader_tls_heap_free(temp);
}
loader_scanned_icd_add(inst, icds, fullpath, vers);
} else
loader_log(inst, VK_DEBUG_REPORT_WARNING_BIT_EXT, 0,
"Can't find \"library_path\" object in ICD JSON "
"file %s, skipping",
file_str);
} else
loader_log(
inst, VK_DEBUG_REPORT_WARNING_BIT_EXT, 0,
"Can't find \"ICD\" object in ICD JSON file %s, skipping",
file_str);
loader_heap_free(inst, file_str);
cJSON_Delete(json);
}
loader_heap_free(inst, manifest_files.filename_list);
loader_platform_thread_unlock_mutex(&loader_json_lock);
}
void loader_layer_scan(const struct loader_instance *inst,
struct loader_layer_list *instance_layers,
struct loader_layer_list *device_layers) {
char *file_str;
struct loader_manifest_files
manifest_files[2]; // [0] = explicit, [1] = implicit
cJSON *json;
uint32_t i;
uint32_t implicit;
// Get a list of manifest files for explicit layers
loader_get_manifest_files(inst, LAYERS_PATH_ENV, true,
DEFAULT_VK_ELAYERS_INFO, HOME_VK_ELAYERS_INFO,
&manifest_files[0]);
// Pass NULL for environment variable override - implicit layers are not
// overridden by LAYERS_PATH_ENV
loader_get_manifest_files(inst, NULL, true, DEFAULT_VK_ILAYERS_INFO,
HOME_VK_ILAYERS_INFO, &manifest_files[1]);
if (manifest_files[0].count == 0 && manifest_files[1].count == 0)
return;
#if 0 // TODO
/**
* We need a list of the layer libraries, not just a list of
* the layer properties (a layer library could expose more than
* one layer property). This list of scanned layers would be
* used to check for global and physicaldevice layer properties.
*/
if (!loader_init_layer_library_list(&loader.scanned_layer_libraries)) {
loader_log(inst, VK_DEBUG_REPORT_ERROR_BIT_EXT, 0,
"Alloc for layer list failed: %s line: %d", __FILE__, __LINE__);
return;
}
#endif
/* cleanup any previously scanned libraries */
loader_delete_layer_properties(inst, instance_layers);
loader_delete_layer_properties(inst, device_layers);
loader_platform_thread_lock_mutex(&loader_json_lock);
for (implicit = 0; implicit < 2; implicit++) {
for (i = 0; i < manifest_files[implicit].count; i++) {
file_str = manifest_files[implicit].filename_list[i];
if (file_str == NULL)
continue;
// parse file into JSON struct
json = loader_get_json(inst, file_str);
if (!json) {
continue;
}
// TODO error if device layers expose instance_extensions
// TODO error if instance layers expose device extensions
loader_add_layer_properties(inst, instance_layers, device_layers,
json, (implicit == 1), file_str);
loader_heap_free(inst, file_str);
cJSON_Delete(json);
}
}
if (manifest_files[0].count != 0)
loader_heap_free(inst, manifest_files[0].filename_list);
if (manifest_files[1].count != 0)
loader_heap_free(inst, manifest_files[1].filename_list);
// add a meta layer for validation if the validation layers are all present
loader_add_layer_property_meta(
inst, sizeof(std_validation_names) / sizeof(std_validation_names[0]),