Only return pre-instance functions when instance is NULL

vkGetInstanceProcAddr should only return the pre-instance, aka global
functions, when the VkInstance handle is NULL. This brings the desktop
vulkan loader into alignment on the spec and with the android loader.
https://github.com/KhronosGroup/Vulkan-Docs/issues/1605

The repo previously did follow this rule, but was changes in the
1.0.42 header version timeframe for unknown reasons.
This commit is contained in:
Charles Giessen 2021-09-21 16:22:06 -06:00 committed by Charles Giessen
parent 6d9e5b07d6
commit b9d0a4ffd7
3 changed files with 93 additions and 7 deletions

View File

@ -46,11 +46,11 @@
// If instance is valid returns a trampoline entry point for all dispatchable Vulkan
// functions both core and extensions.
LOADER_EXPORT VKAPI_ATTR PFN_vkVoidFunction VKAPI_CALL vkGetInstanceProcAddr(VkInstance instance, const char *pName) {
void *addr;
addr = globalGetProcAddr(pName);
if (instance == VK_NULL_HANDLE || addr != NULL) {
return addr;
// Get entrypoint addresses that are global (no dispatchable object)
void *addr = globalGetProcAddr(pName);
if (addr != VK_NULL_HANDLE) {
// Make sure to only allow getting global functions if the instance handle is null
return (instance == VK_NULL_HANDLE) ? addr : NULL;
}
struct loader_instance *ptr_instance = loader_get_instance(instance);

View File

@ -24,8 +24,12 @@ option(TEST_USE_THREAD_SANITIZER "Linux only: Advanced thread checking" OFF)
include(GoogleTest)
add_subdirectory(framework)
add_executable(test_regression loader_testing_main.cpp loader_regression_tests.cpp loader_layer_tests.cpp
loader_version_tests.cpp loader_alloc_callback_tests.cpp)
add_executable(test_regression loader_testing_main.cpp
loader_alloc_callback_tests.cpp
loader_get_proc_addr_tests.cpp
loader_layer_tests.cpp
loader_regression_tests.cpp
loader_version_tests.cpp)
target_link_libraries(test_regression PRIVATE testing_dependencies)
add_executable(test_wsi loader_testing_main.cpp loader_wsi_tests.cpp)

View File

@ -0,0 +1,82 @@
/*
* Copyright (c) 2021 The Khronos Group Inc.
* Copyright (c) 2021 Valve Corporation
* Copyright (c) 2021 LunarG, 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: Charles Giessen <charles@lunarg.com>
*/
#include "test_environment.h"
// Load the global function pointers with and without a NULL vkInstance handle.
// Call the function to make sure it is callable, don't care about what is returned.
TEST(GetProcAddr, GlobalFunctions) {
SingleICDShim env(TestICDDetails(TEST_ICD_PATH_VERSION_6));
env.get_test_icd().physical_devices.emplace_back("physical_device_0");
auto& gipa = env.vulkan_functions.vkGetInstanceProcAddr;
auto EnumerateInstanceExtensionProperties =
reinterpret_cast<PFN_vkEnumerateInstanceExtensionProperties>(gipa(NULL, "vkEnumerateInstanceExtensionProperties"));
handle_assert_has_value(EnumerateInstanceExtensionProperties);
uint32_t ext_count = 0;
ASSERT_EQ(VK_SUCCESS, EnumerateInstanceExtensionProperties("", &ext_count, nullptr));
auto EnumerateInstanceLayerProperties =
reinterpret_cast<PFN_vkEnumerateInstanceLayerProperties>(gipa(NULL, "vkEnumerateInstanceLayerProperties"));
handle_assert_has_value(EnumerateInstanceLayerProperties);
uint32_t layer_count = 0;
ASSERT_EQ(VK_SUCCESS, EnumerateInstanceLayerProperties(&layer_count, nullptr));
auto EnumerateInstanceVersion = reinterpret_cast<PFN_vkEnumerateInstanceVersion>(gipa(NULL, "vkEnumerateInstanceVersion"));
handle_assert_has_value(EnumerateInstanceVersion);
uint32_t api_version = 0;
EnumerateInstanceVersion(&api_version);
auto GetInstanceProcAddr = reinterpret_cast<PFN_vkGetInstanceProcAddr>(gipa(NULL, "vkGetInstanceProcAddr"));
handle_assert_has_value(GetInstanceProcAddr);
GetInstanceProcAddr(NULL, "vkGetInstanceProcAddr");
auto CreateInstance = reinterpret_cast<PFN_vkCreateInstance>(gipa(NULL, "vkCreateInstance"));
handle_assert_has_value(CreateInstance);
// Now create an instance and query the functions again but with a valid instance, should be NULL
InstWrapper inst{env.vulkan_functions};
inst.CheckCreate();
EnumerateInstanceExtensionProperties =
reinterpret_cast<PFN_vkEnumerateInstanceExtensionProperties>(gipa(inst, "vkEnumerateInstanceExtensionProperties"));
handle_assert_null(EnumerateInstanceExtensionProperties);
EnumerateInstanceLayerProperties =
reinterpret_cast<PFN_vkEnumerateInstanceLayerProperties>(gipa(inst, "vkEnumerateInstanceLayerProperties"));
handle_assert_null(EnumerateInstanceLayerProperties);
EnumerateInstanceVersion = reinterpret_cast<PFN_vkEnumerateInstanceVersion>(gipa(inst, "vkEnumerateInstanceVersion"));
handle_assert_null(EnumerateInstanceVersion);
CreateInstance = reinterpret_cast<PFN_vkCreateInstance>(gipa(inst, "vkCreateInstance"));
handle_assert_null(CreateInstance);
GetInstanceProcAddr = reinterpret_cast<PFN_vkGetInstanceProcAddr>(gipa(inst, "vkGetInstanceProcAddr"));
handle_assert_null(GetInstanceProcAddr);
}