Skip to content

Control lifetime of owned VulkanLibrary objects #442

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
th3or14 wants to merge 1 commit into
base: remove_globals
Choose a base branch
from
Open

Control lifetime of owned VulkanLibrary objects #442

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
54 changes: 28 additions & 26 deletions src/VkBootstrap.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -182,28 +182,31 @@ struct VulkanLibrary {
#endif
library = nullptr;
}
~VulkanLibrary() {
unload_vulkan_library();
}
};

GlobalVulkanFunctions::GlobalVulkanFunctions(PFN_vkGetInstanceProcAddr fp_vkGetInstanceProcAddr)
: fp_vkGetInstanceProcAddr(fp_vkGetInstanceProcAddr) {
GlobalVulkanFunctions::GlobalVulkanFunctions(PFN_vkGetInstanceProcAddr fp_vkGetInstanceProcAddr, std::shared_ptr<VulkanLibrary> vk_library)
: vk_library(vk_library), fp_vkGetInstanceProcAddr(fp_vkGetInstanceProcAddr) {

get_proc_addr(fp_vkEnumerateInstanceExtensionProperties, "vkEnumerateInstanceExtensionProperties");
get_proc_addr(fp_vkEnumerateInstanceLayerProperties, "vkEnumerateInstanceLayerProperties");
get_proc_addr(fp_vkEnumerateInstanceVersion, "vkEnumerateInstanceVersion");
get_proc_addr(fp_vkCreateInstance, "vkCreateInstance");
}

InstanceFunctions::InstanceFunctions(VkInstance instance, PFN_vkGetInstanceProcAddr fp_vkGetInstanceProcAddr)
: instance(instance), fp_vkGetInstanceProcAddr(fp_vkGetInstanceProcAddr) {
InstanceFunctions::InstanceFunctions(VkInstance instance, PFN_vkGetInstanceProcAddr fp_vkGetInstanceProcAddr, std::shared_ptr<VulkanLibrary> vk_library)
: vk_library(vk_library), instance(instance), fp_vkGetInstanceProcAddr(fp_vkGetInstanceProcAddr) {

get_inst_proc_addr(fp_vkDestroyDebugUtilsMessengerEXT, "vkDestroyDebugUtilsMessengerEXT");
get_inst_proc_addr(fp_vkDestroySurfaceKHR, "vkDestroySurfaceKHR");
get_inst_proc_addr(fp_vkDestroyInstance, "vkDestroyInstance");
}


PhysicalDeviceSelectorFunctions::PhysicalDeviceSelectorFunctions(VkInstance instance, PFN_vkGetInstanceProcAddr fp_vkGetInstanceProcAddr)
: instance(instance), fp_vkGetInstanceProcAddr(fp_vkGetInstanceProcAddr) {
PhysicalDeviceSelectorFunctions::PhysicalDeviceSelectorFunctions(VkInstance instance, PFN_vkGetInstanceProcAddr fp_vkGetInstanceProcAddr, std::shared_ptr<VulkanLibrary> vk_library)
: vk_library(vk_library), instance(instance), fp_vkGetInstanceProcAddr(fp_vkGetInstanceProcAddr) {
get_inst_proc_addr(fp_vkEnumeratePhysicalDevices, "vkEnumeratePhysicalDevices");
get_inst_proc_addr(fp_vkGetPhysicalDeviceFeatures, "vkGetPhysicalDeviceFeatures");
get_inst_proc_addr(fp_vkGetPhysicalDeviceFeatures2, "vkGetPhysicalDeviceFeatures2");
Expand All @@ -219,7 +222,7 @@ PhysicalDeviceSelectorFunctions::PhysicalDeviceSelectorFunctions(VkInstance inst
}

PhysicalDeviceFunctions::PhysicalDeviceFunctions(PhysicalDeviceSelectorFunctions const& physical_device_selector_functions)
: instance(physical_device_selector_functions.instance),
: vk_library(physical_device_selector_functions.vk_library), instance(physical_device_selector_functions.instance),
fp_vkGetInstanceProcAddr(physical_device_selector_functions.fp_vkGetInstanceProcAddr),

fp_vkGetPhysicalDeviceFeatures(physical_device_selector_functions.fp_vkGetPhysicalDeviceFeatures),
Expand All @@ -239,7 +242,7 @@ DeviceBuilderFunctions::DeviceBuilderFunctions(PhysicalDeviceFunctions const& ph
}

DeviceFunctions::DeviceFunctions(DeviceBuilderFunctions const& device_builder_functions, VkDevice device)
: instance(device_builder_functions.instance),
: vk_library(device_builder_functions.vk_library), instance(device_builder_functions.instance),
fp_vkGetInstanceProcAddr(device_builder_functions.fp_vkGetInstanceProcAddr),
device(device),
fp_vkGetDeviceProcAddr(device_builder_functions.fp_vkGetDeviceProcAddr),
Expand All @@ -251,7 +254,7 @@ DeviceFunctions::DeviceFunctions(DeviceBuilderFunctions const& device_builder_fu
}

SwapchainBuilderFunctions::SwapchainBuilderFunctions(DeviceFunctions const& device_functions)
: instance(device_functions.instance),
: vk_library(device_functions.vk_library), instance(device_functions.instance),
fp_vkGetInstanceProcAddr(device_functions.fp_vkGetInstanceProcAddr),
device(device_functions.device),
fp_vkGetDeviceProcAddr(device_functions.fp_vkGetDeviceProcAddr) {
Expand All @@ -264,11 +267,10 @@ SwapchainBuilderFunctions::SwapchainBuilderFunctions(DeviceFunctions const& devi
get_device_proc_addr(fp_vkCreateSwapchainKHR, "vkCreateSwapchainKHR");
}
SwapchainBuilderFunctions::SwapchainBuilderFunctions(VkInstance const instance, VkDevice const device)
: instance(instance), device(device) {
VulkanLibrary vk_library;
fp_vkGetInstanceProcAddr = vk_library.fp_vkGetInstanceProcAddr;
: vk_library(std::make_shared<VulkanLibrary>()), instance(instance), device(device) {
fp_vkGetInstanceProcAddr = vk_library->fp_vkGetInstanceProcAddr;
fp_vkGetDeviceProcAddr =
reinterpret_cast<PFN_vkGetDeviceProcAddr>(vk_library.fp_vkGetInstanceProcAddr(instance, "vkGetDeviceProcAddr"));
reinterpret_cast<PFN_vkGetDeviceProcAddr>(vk_library->fp_vkGetInstanceProcAddr(instance, "vkGetDeviceProcAddr"));
get_inst_proc_addr(fp_vkGetPhysicalDeviceSurfaceSupportKHR, "vkGetPhysicalDeviceSurfaceSupportKHR");
get_inst_proc_addr(fp_vkGetPhysicalDeviceSurfaceFormatsKHR, "vkGetPhysicalDeviceSurfaceFormatsKHR");
get_inst_proc_addr(fp_vkGetPhysicalDeviceSurfacePresentModesKHR, "vkGetPhysicalDeviceSurfacePresentModesKHR");
Expand Down Expand Up @@ -551,20 +553,20 @@ const char* to_string(SwapchainError err) {
}

Result<SystemInfo> SystemInfo::get_system_info() {
detail::VulkanLibrary vk_library;
auto fp_vkGetInstanceProcAddr = vk_library.fp_vkGetInstanceProcAddr;
std::shared_ptr<detail::VulkanLibrary> vk_library = std::make_shared<detail::VulkanLibrary>();
auto fp_vkGetInstanceProcAddr = vk_library->fp_vkGetInstanceProcAddr;
if (nullptr == fp_vkGetInstanceProcAddr) {
return make_error_code(InstanceError::vulkan_unavailable);
}
return SystemInfo(fp_vkGetInstanceProcAddr);
return SystemInfo(fp_vkGetInstanceProcAddr, vk_library);
}

Result<SystemInfo> SystemInfo::get_system_info(PFN_vkGetInstanceProcAddr fp_vkGetInstanceProcAddr) {
Result<SystemInfo> SystemInfo::get_system_info(PFN_vkGetInstanceProcAddr fp_vkGetInstanceProcAddr, std::shared_ptr<detail::VulkanLibrary> vk_library) {
// Using externally provided function pointers, assume the loader is available
return SystemInfo(fp_vkGetInstanceProcAddr);
return SystemInfo(fp_vkGetInstanceProcAddr, vk_library);
}

SystemInfo::SystemInfo(PFN_vkGetInstanceProcAddr fp_vkGetInstanceProcAddr) : functions(fp_vkGetInstanceProcAddr) {
SystemInfo::SystemInfo(PFN_vkGetInstanceProcAddr fp_vkGetInstanceProcAddr, std::shared_ptr<detail::VulkanLibrary> vk_library) : functions(fp_vkGetInstanceProcAddr, vk_library) {
auto available_layers_ret =
detail::get_vector<VkLayerProperties>(this->available_layers, functions.fp_vkEnumerateInstanceLayerProperties);
if (available_layers_ret != VK_SUCCESS) {
Expand Down Expand Up @@ -624,9 +626,9 @@ bool SystemInfo::is_instance_version_available(uint32_t api_version) { return in
void destroy_surface(Instance const& instance, VkSurfaceKHR surface) { instance.destroy_surface(surface); }
void destroy_surface(VkInstance instance, VkSurfaceKHR surface, VkAllocationCallbacks* callbacks) {
if (instance != VK_NULL_HANDLE && surface != VK_NULL_HANDLE) {
detail::VulkanLibrary vk_library;
std::shared_ptr<detail::VulkanLibrary> vk_library = std::make_shared<detail::VulkanLibrary>();
PFN_vkDestroySurfaceKHR fp_vkDestroySurfaceKHR =
reinterpret_cast<PFN_vkDestroySurfaceKHR>(vk_library.fp_vkGetInstanceProcAddr(instance, "vkDestroySurfaceKHR"));
reinterpret_cast<PFN_vkDestroySurfaceKHR>(vk_library->fp_vkGetInstanceProcAddr(instance, "vkDestroySurfaceKHR"));
fp_vkDestroySurfaceKHR(instance, surface, callbacks);
}
}
Expand Down Expand Up @@ -659,12 +661,12 @@ InstanceBuilder::InstanceBuilder(PFN_vkGetInstanceProcAddr fp_vkGetInstanceProcA

Result<Instance> InstanceBuilder::build() const {
auto fp_vkGetInstanceProcAddr = info.fp_vkGetInstanceProcAddr;
std::shared_ptr<detail::VulkanLibrary> vk_library = std::make_shared<detail::VulkanLibrary>();
if (fp_vkGetInstanceProcAddr == nullptr) {
detail::VulkanLibrary library;
fp_vkGetInstanceProcAddr = library.fp_vkGetInstanceProcAddr;
fp_vkGetInstanceProcAddr = vk_library->fp_vkGetInstanceProcAddr;
}

auto sys_info_ret = SystemInfo::get_system_info(fp_vkGetInstanceProcAddr);
auto sys_info_ret = SystemInfo::get_system_info(fp_vkGetInstanceProcAddr, vk_library);
if (!sys_info_ret) return sys_info_ret.error();
auto system = sys_info_ret.value();

Expand Down Expand Up @@ -856,7 +858,7 @@ Result<Instance> InstanceBuilder::build() const {
instance.allocation_callbacks = info.allocation_callbacks;
instance.instance_version = instance_version;
instance.api_version = api_version;
instance.functions = detail::InstanceFunctions(instance.instance, fp_vkGetInstanceProcAddr);
instance.functions = detail::InstanceFunctions(instance.instance, fp_vkGetInstanceProcAddr, vk_library);
instance.fp_vkGetInstanceProcAddr = instance.functions.fp_vkGetInstanceProcAddr;
instance.functions.get_inst_proc_addr(instance.fp_vkGetDeviceProcAddr, "vkGetDeviceProcAddr");
return instance;
Expand Down Expand Up @@ -1224,7 +1226,7 @@ PhysicalDeviceSelector::PhysicalDeviceSelector(Instance const& instance)
: PhysicalDeviceSelector(instance, VK_NULL_HANDLE) {}

PhysicalDeviceSelector::PhysicalDeviceSelector(Instance const& instance, VkSurfaceKHR surface)
: functions(instance.instance, instance.functions.fp_vkGetInstanceProcAddr) {
: functions(instance.instance, instance.functions.fp_vkGetInstanceProcAddr, instance.functions.vk_library) {
instance_info.instance = instance.instance;
instance_info.version = instance.instance_version;
instance_info.properties2_ext_enabled = instance.properties2_ext_enabled;
Expand Down
22 changes: 17 additions & 5 deletions src/VkBootstrap.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,7 @@
#include <string>
#include <system_error>
#include <variant>
#include <memory>

#include <vulkan/vulkan_core.h>

Expand Down Expand Up @@ -71,6 +72,10 @@

namespace vkb {

namespace detail {
struct VulkanLibrary;
}

// Currently GCC's maybe-uninitialized warning gets tripped when std::variant<> contains a std::vector<>, silence it for the meantime
#if (defined(__GNUC__) || defined(__GNUG__)) && !defined(__clang__)
#pragma GCC diagnostic push
Expand Down Expand Up @@ -182,13 +187,14 @@ class FeaturesChain {
};

struct GlobalVulkanFunctions {
std::shared_ptr<VulkanLibrary> vk_library;
PFN_vkGetInstanceProcAddr fp_vkGetInstanceProcAddr = nullptr;
PFN_vkEnumerateInstanceExtensionProperties fp_vkEnumerateInstanceExtensionProperties = nullptr;
PFN_vkEnumerateInstanceLayerProperties fp_vkEnumerateInstanceLayerProperties = nullptr;
PFN_vkEnumerateInstanceVersion fp_vkEnumerateInstanceVersion = nullptr;
PFN_vkCreateInstance fp_vkCreateInstance = nullptr;

explicit GlobalVulkanFunctions(PFN_vkGetInstanceProcAddr fp_vkGetInstanceProcAddr);
explicit GlobalVulkanFunctions(PFN_vkGetInstanceProcAddr fp_vkGetInstanceProcAddr, std::shared_ptr<VulkanLibrary> vk_library);

template <typename T> void get_proc_addr(T& out_ptr, const char* func_name) {
out_ptr = reinterpret_cast<T>(fp_vkGetInstanceProcAddr(VK_NULL_HANDLE, func_name));
Expand All @@ -197,11 +203,12 @@ struct GlobalVulkanFunctions {

struct InstanceFunctions {
InstanceFunctions() = default;
explicit InstanceFunctions(VkInstance instance, PFN_vkGetInstanceProcAddr fp_vkGetInstanceProcAddr);
explicit InstanceFunctions(VkInstance instance, PFN_vkGetInstanceProcAddr fp_vkGetInstanceProcAddr, std::shared_ptr<VulkanLibrary> vk_library);

template <typename T> void get_inst_proc_addr(T& out_ptr, const char* func_name) {
out_ptr = reinterpret_cast<T>(fp_vkGetInstanceProcAddr(instance, func_name));
}
std::shared_ptr<VulkanLibrary> vk_library;
VkInstance instance = nullptr;
PFN_vkGetInstanceProcAddr fp_vkGetInstanceProcAddr = nullptr;
PFN_vkDestroyDebugUtilsMessengerEXT fp_vkDestroyDebugUtilsMessengerEXT = nullptr;
Expand All @@ -212,12 +219,13 @@ struct InstanceFunctions {

struct PhysicalDeviceSelectorFunctions {
PhysicalDeviceSelectorFunctions() = default;
explicit PhysicalDeviceSelectorFunctions(VkInstance instance, PFN_vkGetInstanceProcAddr fp_vkGetInstanceProcAddr);
explicit PhysicalDeviceSelectorFunctions(VkInstance instance, PFN_vkGetInstanceProcAddr fp_vkGetInstanceProcAddr, std::shared_ptr<VulkanLibrary> vk_library);

template <typename T> void get_inst_proc_addr(T& out_ptr, const char* func_name) {
out_ptr = reinterpret_cast<T>(fp_vkGetInstanceProcAddr(instance, func_name));
}

std::shared_ptr<VulkanLibrary> vk_library;
VkInstance instance = nullptr;
PFN_vkGetInstanceProcAddr fp_vkGetInstanceProcAddr = nullptr;

Expand All @@ -244,6 +252,7 @@ struct PhysicalDeviceFunctions {
out_ptr = reinterpret_cast<T>(fp_vkGetInstanceProcAddr(instance, func_name));
}

std::shared_ptr<VulkanLibrary> vk_library;
VkInstance instance = nullptr;
PFN_vkGetInstanceProcAddr fp_vkGetInstanceProcAddr = nullptr;

Expand All @@ -264,6 +273,7 @@ struct DeviceBuilderFunctions {
out_ptr = reinterpret_cast<T>(fp_vkGetInstanceProcAddr(instance, func_name));
}

std::shared_ptr<VulkanLibrary> vk_library;
VkInstance instance = nullptr;
PFN_vkGetInstanceProcAddr fp_vkGetInstanceProcAddr = nullptr;
PFN_vkGetDeviceProcAddr fp_vkGetDeviceProcAddr = nullptr;
Expand All @@ -285,6 +295,7 @@ struct DeviceFunctions {
out_ptr = reinterpret_cast<T>(fp_vkGetDeviceProcAddr(device, func_name));
}

std::shared_ptr<VulkanLibrary> vk_library;
VkInstance instance = nullptr;
PFN_vkGetInstanceProcAddr fp_vkGetInstanceProcAddr = nullptr;
VkDevice device = nullptr;
Expand All @@ -306,6 +317,7 @@ struct SwapchainBuilderFunctions {
out_ptr = reinterpret_cast<T>(fp_vkGetDeviceProcAddr(device, func_name));
}

std::shared_ptr<VulkanLibrary> vk_library;
VkInstance instance = nullptr;
PFN_vkGetInstanceProcAddr fp_vkGetInstanceProcAddr = nullptr;
VkDevice device = nullptr;
Expand Down Expand Up @@ -398,12 +410,12 @@ class InstanceBuilder;
// can use a fallback if it isn't supported but need to know if support is available first.
struct SystemInfo {
private:
SystemInfo(PFN_vkGetInstanceProcAddr fp_vkGetInstanceProcAddr);
SystemInfo(PFN_vkGetInstanceProcAddr fp_vkGetInstanceProcAddr, std::shared_ptr<detail::VulkanLibrary> vk_library);

public:
// Use get_system_info to create a SystemInfo struct. This is because loading vulkan could fail.
static Result<SystemInfo> get_system_info();
static Result<SystemInfo> get_system_info(PFN_vkGetInstanceProcAddr fp_vkGetInstanceProcAddr);
static Result<SystemInfo> get_system_info(PFN_vkGetInstanceProcAddr fp_vkGetInstanceProcAddr, std::shared_ptr<detail::VulkanLibrary> vk_library = nullptr);

// Returns true if a layer is available
bool is_layer_available(const char* layer_name) const;
Expand Down