Loading...
Searching...
No Matches
vulkan_context.h
Go to the documentation of this file.
#ifndef HALIDE_RUNTIME_VULKAN_CONTEXT_H
#define HALIDE_RUNTIME_VULKAN_CONTEXT_H
#include "printer.h"
#include "runtime_internal.h"
#include "scoped_spin_lock.h"
#include "vulkan_extensions.h"
#include "vulkan_internal.h"
#include "vulkan_memory.h"
// --------------------------------------------------------------------------
namespace Halide {
namespace Runtime {
namespace Internal {
namespace Vulkan {
// --------------------------------------------------------------------------
// Vulkan Memory allocator for host-device allocations
halide_vulkan_memory_allocator *WEAK cached_allocator = nullptr;
// Cached instance related handles for device resources
VkInstance WEAK cached_instance = VK_NULL_HANDLE;
VkDevice WEAK cached_device = VK_NULL_HANDLE;
VkQueue WEAK cached_queue = VK_NULL_HANDLE;
VkPhysicalDevice WEAK cached_physical_device = VK_NULL_HANDLE;
uint32_t WEAK cached_queue_family_index = 0;
VkDebugUtilsMessengerEXT WEAK cached_messenger = VK_NULL_HANDLE;
// A Vulkan context/queue/synchronization lock defined in this module with weak linkage
WEAK halide_mutex thread_lock;
// --------------------------------------------------------------------------
// Helper object to acquire and release the Vulkan context.
class VulkanContext {
void *user_context;
public:
VulkanMemoryAllocator *allocator = nullptr;
VkInstance instance = VK_NULL_HANDLE;
VkDevice device = VK_NULL_HANDLE;
VkPhysicalDevice physical_device = VK_NULL_HANDLE;
VkQueue queue = VK_NULL_HANDLE;
uint32_t queue_family_index = 0; // used for operations requiring queue family
VkDebugUtilsMessengerEXT messenger = VK_NULL_HANDLE;
halide_error_code_t error = halide_error_code_success;
HALIDE_ALWAYS_INLINE explicit VulkanContext(void *user_context)
: user_context(user_context) {
int result = halide_vulkan_acquire_context(user_context,
reinterpret_cast<halide_vulkan_memory_allocator **>(&allocator),
&instance, &device, &physical_device, &queue, &queue_family_index, &messenger);
if (result != halide_error_code_success) {
error = halide_error_code_device_interface_no_device;
halide_error_no_device_interface(user_context);
}
halide_debug_assert(user_context, allocator != nullptr);
halide_debug_assert(user_context, instance != VK_NULL_HANDLE);
halide_debug_assert(user_context, device != VK_NULL_HANDLE);
halide_debug_assert(user_context, queue != VK_NULL_HANDLE);
halide_debug_assert(user_context, physical_device != VK_NULL_HANDLE);
}
HALIDE_ALWAYS_INLINE ~VulkanContext() {
halide_vulkan_release_context(user_context, instance, device, queue, messenger);
}
// For now, this is always nullptr
HALIDE_ALWAYS_INLINE const VkAllocationCallbacks *allocation_callbacks() {
return nullptr;
}
};
// --------------------------------------------------------------------------
namespace {
int vk_find_compute_capability(void *user_context, int *major, int *minor) {
debug(user_context) << " vk_find_compute_capability (user_context: " << user_context << ")\n";
VkInstance instance = VK_NULL_HANDLE;
VkDevice device = VK_NULL_HANDLE;
VkPhysicalDevice physical_device = VK_NULL_HANDLE;
uint32_t queue_family_index = 0;
if (!lib_vulkan) {
// If the Vulkan loader can't be found, we want to return compute
// capability of (0, 0) ... this is not considered an error. So we
// should be very careful about looking for Vulkan without tripping
// any errors in the rest of this runtime.
void *sym = halide_vulkan_get_symbol(user_context, "vkCreateInstance");
if (!sym) {
*major = *minor = 0;
return halide_error_code_success;
}
}
if (vkCreateInstance == nullptr) {
vk_load_vulkan_loader_functions(user_context);
if (vkCreateInstance == nullptr) {
debug(user_context) << " no valid vulkan loader library was found ...\n";
*major = *minor = 0;
return halide_error_code_success;
}
}
StringTable requested_layers;
vk_get_requested_layers(user_context, requested_layers);
// Attempt to find a suitable instance that can support the requested layers
const VkAllocationCallbacks *alloc_callbacks = halide_vulkan_get_allocation_callbacks(user_context);
int status = vk_create_instance(user_context, requested_layers, &instance, alloc_callbacks);
if (status != halide_error_code_success) {
debug(user_context) << " no valid vulkan runtime was found ...\n";
*major = *minor = 0;
return 0;
}
status = vk_select_device_for_context(user_context, &instance, &device, &physical_device, &queue_family_index);
if (status != halide_error_code_success) {
debug(user_context) << " no valid vulkan device was found ...\n";
*major = *minor = 0;
return 0;
}
VkPhysicalDeviceProperties device_properties = {0};
debug(user_context) << " querying for device properties ...\n";
vkGetPhysicalDeviceProperties(physical_device, &device_properties);
*major = VK_API_VERSION_MAJOR(device_properties.apiVersion);
*minor = VK_API_VERSION_MINOR(device_properties.apiVersion);
debug(user_context) << " found device compute capability v" << *major << "." << *minor << " ...\n";
vk_destroy_instance(user_context, instance, alloc_callbacks);
return 0;
}
// Initializes the instance (used by the default vk_create_context)
int vk_create_instance(void *user_context, const StringTable &requested_layers, VkInstance *instance, const VkAllocationCallbacks *alloc_callbacks) {
debug(user_context) << " vk_create_instance (user_context: " << user_context << ")\n";
StringTable required_instance_extensions;
vk_get_required_instance_extensions(user_context, required_instance_extensions);
StringTable optional_instance_extensions;
vk_get_optional_instance_extensions(user_context, optional_instance_extensions);
StringTable supported_instance_extensions;
vk_get_supported_instance_extensions(user_context, supported_instance_extensions);
bool valid_instance = vk_validate_required_extension_support(user_context, required_instance_extensions, supported_instance_extensions);
halide_abort_if_false(user_context, valid_instance);
debug(user_context) << " found " << (uint32_t)required_instance_extensions.size() << " required extensions for instance!\n";
for (int n = 0; n < (int)required_instance_extensions.size(); ++n) {
debug(user_context) << " extension: " << required_instance_extensions[n] << "\n";
}
// enable all available optional extensions
debug(user_context) << " checking for " << (uint32_t)optional_instance_extensions.size() << " optional extensions for instance ...\n";
for (uint32_t n = 0; n < optional_instance_extensions.size(); ++n) {
if (supported_instance_extensions.contains(optional_instance_extensions[n])) {
debug(user_context) << " optional extension: " << optional_instance_extensions[n] << "\n";
required_instance_extensions.append(user_context, optional_instance_extensions[n]);
}
}
// If we're running under Molten VK, we must enable the portability extension and create flags
// to allow non-physical devices that are emulated to appear in the device list.
uint32_t create_flags = 0;
if (supported_instance_extensions.contains("VK_KHR_portability_enumeration") &&
supported_instance_extensions.contains("VK_MVK_macos_surface")) {
create_flags = VK_INSTANCE_CREATE_ENUMERATE_PORTABILITY_BIT_KHR;
required_instance_extensions.append(user_context, "VK_KHR_portability_enumeration");
}
VkApplicationInfo app_info = {
VK_STRUCTURE_TYPE_APPLICATION_INFO, // struct type
nullptr, // Next
"Runtime", // application name
VK_MAKE_API_VERSION(0, 1, 0, 0), // app version
"Halide", // engine name
VK_MAKE_API_VERSION(0, HALIDE_VERSION_MAJOR, HALIDE_VERSION_MINOR, HALIDE_VERSION_PATCH), // engine version
VK_API_VERSION_1_3}; // FIXME: only use the minimum capability necessary
VkInstanceCreateInfo create_info = {
VK_STRUCTURE_TYPE_INSTANCE_CREATE_INFO,
nullptr, // Next
create_flags, // Flags
&app_info, // ApplicationInfo
(uint32_t)requested_layers.size(), requested_layers.data(), // Layers
(uint32_t)required_instance_extensions.size(), required_instance_extensions.data() // Extensions
};
VkResult result = vkCreateInstance(&create_info, alloc_callbacks, instance);
if (result != VK_SUCCESS) {
debug(user_context) << "Vulkan: vkCreateInstance failed with return code: " << vk_get_error_name(result) << "\n";
return halide_error_code_device_interface_no_device;
}
vk_load_vulkan_instance_functions(user_context, *instance);
if (vkCreateDevice == nullptr) {
error(user_context) << "Vulkan: Failed to resolve instance API methods to create device!\n";
return halide_error_code_symbol_not_found;
}
return halide_error_code_success;
}
int vk_destroy_instance(void *user_context, VkInstance instance, const VkAllocationCallbacks *alloc_callbacks) {
debug(user_context) << " vk_destroy_instance (user_context: " << user_context << ", device: " << (void *)instance << ", alloc_callbacks: " << (void *)alloc_callbacks << ")\n";
vkDestroyInstance(instance, alloc_callbacks);
vk_unload_vulkan_instance_functions(user_context);
return halide_error_code_success;
}
int vk_select_device_for_context(void *user_context,
VkInstance *instance, VkDevice *device,
VkPhysicalDevice *physical_device,
uint32_t *queue_family_index) {
// query for the number of physical devices available in this instance
uint32_t device_count = 0;
VkResult result = vkEnumeratePhysicalDevices(*instance, &device_count, nullptr);
if ((result != VK_SUCCESS) && (result != VK_INCOMPLETE)) {
debug(user_context) << "Vulkan: vkEnumeratePhysicalDevices failed with return code: " << vk_get_error_name(result) << "\n";
return halide_error_code_device_interface_no_device;
}
if (device_count == 0) {
debug(user_context) << "Vulkan: No devices found.\n";
return halide_error_code_device_interface_no_device;
}
// allocate enough storage for the physical device query results
BlockStorage::Config device_query_storage_config;
device_query_storage_config.entry_size = sizeof(VkPhysicalDevice);
BlockStorage device_query_storage(user_context, device_query_storage_config);
device_query_storage.resize(user_context, device_count);
VkPhysicalDevice chosen_device = VK_NULL_HANDLE;
VkPhysicalDevice *avail_devices = (VkPhysicalDevice *)(device_query_storage.data());
if (avail_devices == nullptr) {
debug(user_context) << "Vulkan: Out of system memory!\n";
return halide_error_code_out_of_memory;
}
result = vkEnumeratePhysicalDevices(*instance, &device_count, avail_devices);
if ((result != VK_SUCCESS) && (result != VK_INCOMPLETE)) {
debug(user_context) << "Vulkan: vkEnumeratePhysicalDevices failed with return code: " << vk_get_error_name(result) << "\n";
return halide_error_code_device_interface_no_device;
}
// get the configurable device type to search for (e.g. 'cpu', 'gpu', 'integrated-gpu', 'discrete-gpu', ...)
const char *dev_type = halide_vulkan_get_device_type(user_context);
// try to find a matching device that supports compute.
uint32_t queue_family = 0;
for (uint32_t i = 0; (chosen_device == VK_NULL_HANDLE) && (i < device_count); i++) {
VkPhysicalDeviceProperties properties;
vkGetPhysicalDeviceProperties(avail_devices[i], &properties);
debug(user_context) << "Vulkan: Checking device #" << i << "='" << properties.deviceName << "'\n";
int matching_device = 0;
if ((dev_type != nullptr) && (*dev_type != '\0')) {
if (strstr(dev_type, "cpu") && (properties.deviceType == VK_PHYSICAL_DEVICE_TYPE_CPU)) {
matching_device = 1;
} else if (strstr(dev_type, "integrated-gpu") && ((properties.deviceType == VK_PHYSICAL_DEVICE_TYPE_INTEGRATED_GPU))) {
matching_device = 1;
} else if (strstr(dev_type, "discrete-gpu") && ((properties.deviceType == VK_PHYSICAL_DEVICE_TYPE_DISCRETE_GPU))) {
matching_device = 1;
} else if (strstr(dev_type, "virtual-gpu") && (properties.deviceType == VK_PHYSICAL_DEVICE_TYPE_VIRTUAL_GPU)) {
matching_device = 1;
} else if (strstr(dev_type, "gpu") && ((properties.deviceType == VK_PHYSICAL_DEVICE_TYPE_INTEGRATED_GPU) || (properties.deviceType == VK_PHYSICAL_DEVICE_TYPE_DISCRETE_GPU))) {
matching_device = 1;
}
} else {
// use a non-virtual gpu device by default
if ((properties.deviceType == VK_PHYSICAL_DEVICE_TYPE_INTEGRATED_GPU) ||
(properties.deviceType == VK_PHYSICAL_DEVICE_TYPE_DISCRETE_GPU)) {
matching_device = 1;
}
}
if (matching_device) {
// get the number of supported queues for this physical device
uint32_t queue_properties_count = 0;
vkGetPhysicalDeviceQueueFamilyProperties(avail_devices[i], &queue_properties_count, nullptr);
if (queue_properties_count < 1) {
continue;
}
// allocate enough storage for the queue properties query results
BlockStorage::Config queue_properties_storage_config;
queue_properties_storage_config.entry_size = sizeof(VkPhysicalDevice);
BlockStorage queue_properties_storage(user_context, queue_properties_storage_config);
queue_properties_storage.resize(user_context, queue_properties_count);
VkQueueFamilyProperties *queue_properties = (VkQueueFamilyProperties *)(queue_properties_storage.data());
vkGetPhysicalDeviceQueueFamilyProperties(avail_devices[i], &queue_properties_count, queue_properties);
for (uint32_t j = 0; (chosen_device == nullptr) && (j < queue_properties_count); j++) {
if (queue_properties[j].queueCount > 0 &&
queue_properties[j].queueFlags & VK_QUEUE_COMPUTE_BIT) {
chosen_device = avail_devices[i];
queue_family = j;
debug(user_context) << "Vulkan: Found matching compute device '" << properties.deviceName << "'\n";
}
}
}
}
// If nothing, just try the first one for now.
if (chosen_device == nullptr) {
queue_family = 0;
chosen_device = avail_devices[0];
VkPhysicalDeviceProperties properties;
vkGetPhysicalDeviceProperties(chosen_device, &properties);
debug(user_context) << "Vulkan: Defaulting to first compute device '" << properties.deviceName << "'\n";
}
*queue_family_index = queue_family;
*physical_device = chosen_device;
return halide_error_code_success;
}
int vk_create_device(void *user_context, const StringTable &requested_layers, VkInstance *instance, VkDevice *device, VkQueue *queue,
VkPhysicalDevice *physical_device, uint32_t *queue_family_index, const VkAllocationCallbacks *alloc_callbacks) {
debug(user_context) << " vk_create_device (user_context=" << user_context << ")\n";
debug(user_context) << " checking for required device extensions ...\n";
StringTable required_device_extensions;
vk_get_required_device_extensions(user_context, required_device_extensions);
debug(user_context) << " checking for optional device extensions ...\n";
StringTable optional_device_extensions;
vk_get_optional_device_extensions(user_context, optional_device_extensions);
debug(user_context) << " validating supported device extensions ...\n";
StringTable supported_device_extensions;
vk_get_supported_device_extensions(user_context, *physical_device, supported_device_extensions);
bool valid_device = vk_validate_required_extension_support(user_context, required_device_extensions, supported_device_extensions);
if (!valid_device) {
debug(user_context) << "Vulkan: Unable to validate required extension support!\n";
return halide_error_code_device_interface_no_device;
}
debug(user_context) << " found " << (uint32_t)required_device_extensions.size() << " required extensions for device!\n";
for (uint32_t n = 0; n < required_device_extensions.size(); ++n) {
debug(user_context) << " required extension: " << required_device_extensions[n] << "\n";
}
// enable all available optional extensions
debug(user_context) << " checking for " << (uint32_t)optional_device_extensions.size() << " optional extensions for device ...\n";
for (uint32_t n = 0; n < optional_device_extensions.size(); ++n) {
if (supported_device_extensions.contains(optional_device_extensions[n])) {
debug(user_context) << " optional extension: " << optional_device_extensions[n] << "\n";
required_device_extensions.append(user_context, optional_device_extensions[n]);
}
}
float queue_priority = 1.0f;
VkDeviceQueueCreateInfo device_queue_create_info = {
VK_STRUCTURE_TYPE_DEVICE_QUEUE_CREATE_INFO,
nullptr, // Next
0, // Flags
*queue_family_index,
1,
&queue_priority,
};
// Get the API version to determine what device features are valid to search for
VkPhysicalDeviceProperties device_properties = {0};
debug(user_context) << " querying for device properties ...\n";
vkGetPhysicalDeviceProperties(*physical_device, &device_properties);
uint32_t major_version = VK_API_VERSION_MAJOR(device_properties.apiVersion);
uint32_t minor_version = VK_API_VERSION_MINOR(device_properties.apiVersion);
bool has_capability_v11 = (major_version >= 1) && (minor_version >= 1); // supports >= v1.1
bool has_capability_v12 = (major_version >= 1) && (minor_version >= 2); // supports >= v1.2
debug(user_context) << " found device compute capability v" << major_version << "." << minor_version << " ...\n";
// Get the device features so that all supported features are enabled when device is created
VkPhysicalDeviceFeatures device_features = {};
void *extended_features_ptr = nullptr;
void *standard_features_ptr = nullptr;
debug(user_context) << " querying for device features...\n";
vkGetPhysicalDeviceFeatures(*physical_device, &device_features);
debug(user_context) << " shader float64 support: " << (device_features.shaderFloat64 ? "true" : "false") << "...\n";
debug(user_context) << " shader int64 support: " << (device_features.shaderInt64 ? "true" : "false") << "...\n";
debug(user_context) << " shader int16 support: " << (device_features.shaderInt16 ? "true" : "false") << "...\n";
// assemble the chain of features to query, but only add the ones that exist in the API version
// note: requires v1.2+
VkPhysicalDeviceShaderFloat16Int8FeaturesKHR shader_f16_i8_ext = {VK_STRUCTURE_TYPE_PHYSICAL_DEVICE_SHADER_FLOAT16_INT8_FEATURES_KHR,
nullptr, VK_FALSE, VK_FALSE};
// note: requires v1.2+
VkPhysicalDevice8BitStorageFeaturesKHR storage_8bit_ext = {VK_STRUCTURE_TYPE_PHYSICAL_DEVICE_8BIT_STORAGE_FEATURES_KHR,
&shader_f16_i8_ext, VK_FALSE, VK_FALSE, VK_FALSE};
// note: requires v1.1+
VkPhysicalDevice16BitStorageFeaturesKHR storage_16bit_ext = {VK_STRUCTURE_TYPE_PHYSICAL_DEVICE_16BIT_STORAGE_FEATURES_KHR,
(has_capability_v12 ? &storage_8bit_ext : nullptr),
VK_FALSE, VK_FALSE, VK_FALSE, VK_FALSE};
VkPhysicalDeviceFeatures2KHR device_features_ext = {
VK_STRUCTURE_TYPE_PHYSICAL_DEVICE_FEATURES_2_KHR,
&storage_16bit_ext, device_features};
// Look for extended device feature query method (KHR was removed when it was adopted into v1.1+)
PFN_vkGetPhysicalDeviceFeatures2KHR vkGetPhysicalDeviceFeatures2KHR = (PFN_vkGetPhysicalDeviceFeatures2KHR)vkGetInstanceProcAddr(*instance, "vkGetPhysicalDeviceFeatures2KHR"); // v1.0+
if (!vkGetPhysicalDeviceFeatures2KHR) {
vkGetPhysicalDeviceFeatures2KHR = (PFN_vkGetPhysicalDeviceFeatures2KHR)vkGetInstanceProcAddr(*instance, "vkGetPhysicalDeviceFeatures2");
}
// If the instance runtime supports querying extended device features, request them
if (vkGetPhysicalDeviceFeatures2KHR && has_capability_v11) {
debug(user_context) << " querying for extended device features...\n";
vkGetPhysicalDeviceFeatures2KHR(*physical_device, &device_features_ext);
debug(user_context) << " shader int8 support: " << (shader_f16_i8_ext.shaderInt8 ? "true" : "false") << "...\n";
debug(user_context) << " shader float16 support: " << (shader_f16_i8_ext.shaderFloat16 ? "true" : "false") << "...\n";
if (has_capability_v12) {
debug(user_context) << " storage buffer 8bit access support: " << (storage_8bit_ext.storageBuffer8BitAccess ? "true" : "false") << "...\n";
debug(user_context) << " storage buffer 16bit access support: " << (storage_16bit_ext.storageBuffer16BitAccess ? "true" : "false") << "...\n";
}
extended_features_ptr = (void *)(&device_features_ext); // pass extended features (which also contains the standard features)
} else {
standard_features_ptr = &device_features; // pass v1.0 standard features
}
VkDeviceCreateInfo device_create_info = {
VK_STRUCTURE_TYPE_DEVICE_CREATE_INFO,
extended_features_ptr, // Extended struct ptr (used here for requesting chain of extended features)
0, // Flags
1, // Count of queues to create
&device_queue_create_info,
(uint32_t)requested_layers.size(), requested_layers.data(), // Layers
(uint32_t)required_device_extensions.size(), required_device_extensions.data(), // Enabled extensions
(VkPhysicalDeviceFeatures *)standard_features_ptr, // Requested device features
};
VkResult result = vkCreateDevice(*physical_device, &device_create_info, alloc_callbacks, device);
if (result != VK_SUCCESS) {
debug(user_context) << "Vulkan: vkCreateDevice failed with return code: " << vk_get_error_name(result) << "\n";
return halide_error_code_device_interface_no_device;
}
vk_load_vulkan_device_functions(user_context, *device);
if (vkAllocateMemory == nullptr) {
error(user_context) << "Vulkan: Failed to resolve device API methods for driver!\n";
return halide_error_code_symbol_not_found;
}
vkGetDeviceQueue(*device, *queue_family_index, 0, queue);
return halide_error_code_success;
}
int vk_destroy_device(void *user_context, VkDevice device, const VkAllocationCallbacks *alloc_callbacks) {
debug(user_context) << " vk_destroy_device (user_context: " << user_context << ", device: " << (void *)device << ", alloc_callbacks: " << (void *)alloc_callbacks << ")\n";
vkDestroyDevice(device, alloc_callbacks);
vk_unload_vulkan_device_functions(user_context);
return halide_error_code_success;
}
// Initializes the context (used by the default implementation of halide_acquire_context)
int vk_create_context(void *user_context, VulkanMemoryAllocator **allocator,
VkInstance *instance, VkDevice *device, VkPhysicalDevice *physical_device,
VkQueue *queue, uint32_t *queue_family_index, VkDebugUtilsMessengerEXT *messenger) {
debug(user_context) << " vk_create_context (user_context: " << user_context << ")\n";
if (vkCreateInstance == nullptr) {
vk_load_vulkan_loader_functions(user_context);
if (vkCreateInstance == nullptr) {
error(user_context) << "Vulkan: Failed to resolve loader library methods to create instance!\n";
return halide_error_code_symbol_not_found;
}
}
StringTable requested_layers;
uint32_t requested_layer_count = vk_get_requested_layers(user_context, requested_layers);
debug(user_context) << " requested " << requested_layer_count << " layers for instance!\n";
for (int n = 0; n < (int)requested_layer_count; ++n) {
debug(user_context) << " layer: " << requested_layers[n] << "\n";
}
const VkAllocationCallbacks *alloc_callbacks = halide_vulkan_get_allocation_callbacks(user_context);
int error_code = vk_create_instance(user_context, requested_layers, instance, alloc_callbacks);
if (error_code != halide_error_code_success) {
error(user_context) << "Vulkan: Failed to create instance for context!\n";
return error_code;
}
error_code = vk_select_device_for_context(user_context, instance, device, physical_device, queue_family_index);
if (error_code != halide_error_code_success) {
error(user_context) << "Vulkan: Failed to select device for context!\n";
return error_code;
}
error_code = vk_create_device(user_context, requested_layers, instance, device, queue, physical_device, queue_family_index, alloc_callbacks);
if (error_code != halide_error_code_success) {
error(user_context) << "Vulkan: Failed to create device for context!\n";
return error_code;
}
*allocator = vk_create_memory_allocator(user_context, *device, *physical_device, alloc_callbacks);
if (*allocator == nullptr) {
error(user_context) << "Vulkan: Failed to create memory allocator for device!\n";
return halide_error_code_generic_error;
}
vk_create_debug_utils_messenger(user_context, *instance, *allocator, messenger);
return halide_error_code_success;
}
// Destroys the context and all associated resources (used by halide_vulkan_device_release)
// NOTE: This should be called inside an acquire_context/release_context scope
int vk_destroy_context(void *user_context, VulkanMemoryAllocator *allocator,
VkInstance instance, VkDevice device, VkPhysicalDevice physical_device,
VkQueue queue, VkDebugUtilsMessengerEXT messenger) {
debug(user_context)
<< "vk_destroy_context (user_context: " << user_context << ")\n";
if (vkCreateInstance == nullptr) {
return halide_error_code_success;
}
if (queue != VK_NULL_HANDLE) {
VkResult result = vkQueueWaitIdle(queue);
if (result != VK_SUCCESS) {
error(user_context) << "Vulkan: vkQueueWaitIdle returned " << vk_get_error_name(result) << "\n";
return halide_error_code_generic_error;
}
}
if (device != VK_NULL_HANDLE) {
VkResult result = vkDeviceWaitIdle(device);
if (result != VK_SUCCESS) {
error(user_context) << "Vulkan: vkDeviceWaitIdle returned " << vk_get_error_name(result) << "\n";
return halide_error_code_generic_error;
}
}
if (allocator != nullptr) {
vk_destroy_shader_modules(user_context, allocator);
vk_destroy_memory_allocator(user_context, allocator);
vk_destroy_debug_utils_messenger(user_context, instance, allocator, messenger);
}
const VkAllocationCallbacks *alloc_callbacks = halide_vulkan_get_allocation_callbacks(user_context);
if (device != VK_NULL_HANDLE) {
vk_destroy_device(user_context, device, alloc_callbacks);
}
if (instance != VK_NULL_HANDLE) {
vk_destroy_instance(user_context, instance, alloc_callbacks);
}
return halide_error_code_success;
}
// --------------------------------------------------------------------------
VKAPI_ATTR VkBool32 VKAPI_CALL vk_debug_utils_messenger_callback(
VkDebugUtilsMessageSeverityFlagBitsEXT message_severity,
VkDebugUtilsMessageTypeFlagsEXT message_type,
const VkDebugUtilsMessengerCallbackDataEXT *callback_data,
void *user_data) {
if (message_severity & VK_DEBUG_UTILS_MESSAGE_SEVERITY_WARNING_BIT_EXT) {
print(user_data) << "Vulkan [WARNING]: (user_context=" << user_data << ", "
<< "id=" << callback_data->messageIdNumber << ", "
<< "name:" << callback_data->pMessageIdName << ") "
<< callback_data->pMessage << "\n";
} else if (message_severity & VK_DEBUG_UTILS_MESSAGE_SEVERITY_ERROR_BIT_EXT) {
print(user_data) << "Vulkan [ERROR]: (user_context=" << user_data << ", "
<< "id=" << callback_data->messageIdNumber << ", "
<< "name:" << callback_data->pMessageIdName << ") "
<< callback_data->pMessage << "\n";
} else {
debug(user_data) << "Vulkan [DEBUG]: (user_context=" << user_data << ", "
<< "id=" << callback_data->messageIdNumber << ", "
<< "name:" << callback_data->pMessageIdName << ") "
<< callback_data->pMessage << "\n";
}
return VK_FALSE;
}
VkResult vk_create_debug_utils_messenger(void *user_context, VkInstance instance, VulkanMemoryAllocator *allocator, VkDebugUtilsMessengerEXT *messenger) {
PFN_vkCreateDebugUtilsMessengerEXT func = (PFN_vkCreateDebugUtilsMessengerEXT)vkGetInstanceProcAddr(instance, "vkCreateDebugUtilsMessengerEXT");
if (func != nullptr) {
debug(user_context) << "Vulkan: Registering Debug Utils Messenger ... \n";
VkDebugUtilsMessengerCreateInfoEXT create_info{};
create_info.flags = 0;
create_info.sType = VK_STRUCTURE_TYPE_DEBUG_UTILS_MESSENGER_CREATE_INFO_EXT;
create_info.messageSeverity = VK_DEBUG_UTILS_MESSAGE_SEVERITY_VERBOSE_BIT_EXT | VK_DEBUG_UTILS_MESSAGE_SEVERITY_WARNING_BIT_EXT | VK_DEBUG_UTILS_MESSAGE_SEVERITY_ERROR_BIT_EXT;
create_info.messageType = VK_DEBUG_UTILS_MESSAGE_TYPE_GENERAL_BIT_EXT | VK_DEBUG_UTILS_MESSAGE_TYPE_VALIDATION_BIT_EXT | VK_DEBUG_UTILS_MESSAGE_TYPE_PERFORMANCE_BIT_EXT;
create_info.pfnUserCallback = vk_debug_utils_messenger_callback;
create_info.pUserData = user_context;
return func(instance, &create_info, allocator->callbacks(), messenger);
} else {
debug(user_context) << "Vulkan: Debug Utils Messenger extension unavailable!\n";
return VK_ERROR_EXTENSION_NOT_PRESENT;
}
}
void vk_destroy_debug_utils_messenger(void *user_context, VkInstance instance, VulkanMemoryAllocator *allocator, VkDebugUtilsMessengerEXT messenger) {
PFN_vkDestroyDebugUtilsMessengerEXT func = (PFN_vkDestroyDebugUtilsMessengerEXT)vkGetInstanceProcAddr(instance, "vkDestroyDebugUtilsMessengerEXT");
if (func != nullptr) {
debug(user_context) << "Vulkan: Destroying Debug Utils Messenger ...\n";
func(instance, messenger, allocator->callbacks());
}
}
// --------------------------------------------------------------------------
} // namespace
} // namespace Vulkan
} // namespace Internal
} // namespace Runtime
} // namespace Halide
#endif /// HALIDE_RUNTIME_VULKAN_CONTEXT_H
debug
#define debug(n)
For optional debugging during codegen, use the debug macro as follows:
Definition Debug.h:52
HALIDE_VERSION_MINOR
#define HALIDE_VERSION_MINOR
Definition HalideRuntime.h:27
HALIDE_VERSION_PATCH
#define HALIDE_VERSION_PATCH
Definition HalideRuntime.h:28
HALIDE_VERSION_MAJOR
#define HALIDE_VERSION_MAJOR
Definition HalideRuntime.h:26
halide_error_no_device_interface
int halide_error_no_device_interface(void *user_context)
halide_error_code_t
halide_error_code_t
The error codes that may be returned by a Halide pipeline.
Definition HalideRuntime.h:1074
halide_error_code_symbol_not_found
@ halide_error_code_symbol_not_found
A runtime symbol could not be loaded.
Definition HalideRuntime.h:1161
halide_error_code_device_interface_no_device
@ halide_error_code_device_interface_no_device
Buffer has a non-null device_interface but device is 0, which violates a Halide invariant.
Definition HalideRuntime.h:1222
halide_error_code_generic_error
@ halide_error_code_generic_error
An uncategorized error occurred.
Definition HalideRuntime.h:1079
halide_error_code_success
@ halide_error_code_success
There was no error.
Definition HalideRuntime.h:1076
halide_error_code_out_of_memory
@ halide_error_code_out_of_memory
A call to halide_malloc returned NULL.
Definition HalideRuntime.h:1119
HALIDE_ALWAYS_INLINE
#define HALIDE_ALWAYS_INLINE
Definition HalideRuntime.h:49
halide_vulkan_acquire_context
int halide_vulkan_acquire_context(void *user_context, struct halide_vulkan_memory_allocator **allocator, VkInstance *instance, VkDevice *device, VkPhysicalDevice *physical_device, VkQueue *queue, uint32_t *queue_family_index, VkDebugUtilsMessengerEXT *messenger, bool create=true)
halide_vulkan_get_allocation_callbacks
const struct VkAllocationCallbacks * halide_vulkan_get_allocation_callbacks(void *user_context)
Definition vulkan_memory.h:1501
halide_vulkan_release_context
int halide_vulkan_release_context(void *user_context, VkInstance instance, VkDevice device, VkQueue queue, VkDebugUtilsMessengerEXT messenger)
halide_vulkan_get_device_type
const char * halide_vulkan_get_device_type(void *user_context)
Definition vulkan_extensions.h:311
Halide::Runtime::Internal::StringTable::append
void append(void *user_context, const char *str, size_t length=0)
Definition string_table.h:145
Halide::Runtime::Internal::StringTable::data
const char ** data() const
Definition string_table.h:205
Halide::Runtime::Internal::StringTable::size
size_t size() const
Definition string_table.h:54
Halide::Runtime::Internal::StringTable::contains
bool contains(const char *str) const
Definition string_table.h:191
Halide::Runtime::Internal::Vulkan::VulkanContext::device
VkDevice device
Definition vulkan_context.h:44
Halide::Runtime::Internal::Vulkan::VulkanContext::allocator
VulkanMemoryAllocator * allocator
Definition vulkan_context.h:42
Halide::Runtime::Internal::Vulkan::VulkanContext::queue_family_index
uint32_t queue_family_index
Definition vulkan_context.h:47
Halide::Runtime::Internal::Vulkan::VulkanContext::VulkanContext
HALIDE_ALWAYS_INLINE VulkanContext(void *user_context)
Definition vulkan_context.h:51
Halide::Runtime::Internal::Vulkan::VulkanContext::allocation_callbacks
HALIDE_ALWAYS_INLINE const VkAllocationCallbacks * allocation_callbacks()
Definition vulkan_context.h:73
Halide::Runtime::Internal::Vulkan::VulkanContext::queue
VkQueue queue
Definition vulkan_context.h:46
Halide::Runtime::Internal::Vulkan::VulkanContext::instance
VkInstance instance
Definition vulkan_context.h:43
Halide::Runtime::Internal::Vulkan::VulkanContext::messenger
VkDebugUtilsMessengerEXT messenger
Definition vulkan_context.h:48
Halide::Runtime::Internal::Vulkan::VulkanContext::physical_device
VkPhysicalDevice physical_device
Definition vulkan_context.h:45
Halide::Runtime::Internal::Vulkan::VulkanContext::~VulkanContext
HALIDE_ALWAYS_INLINE ~VulkanContext()
Definition vulkan_context.h:68
Halide::Runtime::Internal::Vulkan::VulkanContext::error
halide_error_code_t error
Definition vulkan_context.h:49
Halide::Runtime::Internal::Vulkan::VulkanMemoryAllocator
Vulkan Memory Allocator class interface for managing large memory requests stored as contiguous block...
Definition vulkan_memory.h:42
Halide::Runtime::Internal::Vulkan::VulkanMemoryAllocator::callbacks
const VkAllocationCallbacks * callbacks() const
Definition vulkan_memory.h:85
Halide::Runtime::Internal::Vulkan
Definition vulkan_context.h:17
Halide::Runtime::Internal::Vulkan::halide_vulkan_get_symbol
WEAK void * halide_vulkan_get_symbol(void *user_context, const char *name)
Definition vulkan_interface.h:42
Halide::Runtime::Internal::Vulkan::vk_unload_vulkan_device_functions
void WEAK vk_unload_vulkan_device_functions(void *user_context)
Definition vulkan_interface.h:124
Halide::Runtime::Internal::Vulkan::vk_unload_vulkan_instance_functions
void WEAK vk_unload_vulkan_instance_functions(void *user_context)
Definition vulkan_interface.h:105
Halide::Runtime::Internal::Vulkan::thread_lock
WEAK halide_mutex thread_lock
Definition vulkan_context.h:33
Halide::Runtime::Internal::Vulkan::cached_queue
VkQueue WEAK cached_queue
Definition vulkan_context.h:27
Halide::Runtime::Internal::Vulkan::vk_load_vulkan_loader_functions
void WEAK vk_load_vulkan_loader_functions(void *user_context)
Definition vulkan_interface.h:85
Halide::Runtime::Internal::Vulkan::cached_messenger
VkDebugUtilsMessengerEXT WEAK cached_messenger
Definition vulkan_context.h:30
Halide::Runtime::Internal::Vulkan::vk_load_vulkan_device_functions
void WEAK vk_load_vulkan_device_functions(void *user_context, VkDevice device)
Definition vulkan_interface.h:114
Halide::Runtime::Internal::Vulkan::cached_instance
VkInstance WEAK cached_instance
Definition vulkan_context.h:25
Halide::Runtime::Internal::Vulkan::cached_queue_family_index
uint32_t WEAK cached_queue_family_index
Definition vulkan_context.h:29
Halide::Runtime::Internal::Vulkan::cached_physical_device
VkPhysicalDevice WEAK cached_physical_device
Definition vulkan_context.h:28
Halide::Runtime::Internal::Vulkan::vk_load_vulkan_instance_functions
void WEAK vk_load_vulkan_instance_functions(void *user_context, VkInstance instance)
Definition vulkan_interface.h:95
Halide::Runtime::Internal::Vulkan::cached_allocator
halide_vulkan_memory_allocator *WEAK cached_allocator
Definition vulkan_context.h:22
Halide::Runtime::Internal::Vulkan::lib_vulkan
WEAK void * lib_vulkan
Definition vulkan_interface.h:40
Halide::Runtime::Internal::Vulkan::cached_device
VkDevice WEAK cached_device
Definition vulkan_context.h:26
Halide::Runtime::Internal
Definition constants.h:13
Halide::Runtime
Definition constants.h:12
Halide
This file defines the class FunctionDAG, which is our representation of a Halide pipeline,...
Definition AbstractGenerator.h:19
Halide::print
Expr print(const std::vector< Expr > &values)
Create an Expr that prints out its value whenever it is evaluated.
printer.h
runtime_internal.h
halide_debug_assert
#define halide_debug_assert(user_context, cond)
halide_debug_assert() is like halide_assert(), but only expands into a check when DEBUG_RUNTIME is de...
Definition runtime_internal.h:290
uint32_t
unsigned __INT32_TYPE__ uint32_t
Definition runtime_internal.h:25
halide_abort_if_false
#define halide_abort_if_false(user_context, cond)
Definition runtime_internal.h:271
strstr
const char * strstr(const char *, const char *)
WEAK
#define WEAK
Definition runtime_internal.h:52
scoped_spin_lock.h
Halide::Runtime::Internal::BlockStorage::Config::entry_size
uint32_t entry_size
Definition block_storage.h:24
halide_mutex
Cross-platform mutex.
Definition HalideRuntime.h:191
vulkan_extensions.h
vulkan_internal.h
vulkan_memory.h