Vulkan: create the device through the frontend (negotiation v2)

Where the frontend supports Vulkan context negotiation v2, the core
offers create_device2 and makes its device with the frontend's
vkCreateDevice wrapper, which adds the extensions and features the
frontend wants - in RetroArch, VK_NV_low_latency2 or VK_AMD_anti_lag for
Driver Pacing, which a device the core makes itself never has. A
frontend without v2 is offered a version 1 interface: one that predates
v2 rejects any other version, which until now left it making a default
device of its own.

The vulkan suite runs the negotiation both ways: as RetroArch, where the
device must be made through the wrapper, and as a frontend without v2.
This commit is contained in:
libretroadmin 2026-10-19 21:10:06 +02:00
commit cc94ebcd38
4 changed files with 98 additions and 27 deletions

View file

@ -86,7 +86,9 @@ bool Context::CreateFromExistingInstance(VkInstance instance, VkPhysicalDevice g
uint32_t num_required_device_extensions /* = 0 */,
const char** required_device_layers /* = nullptr */,
uint32_t num_required_device_layers /* = 0 */,
const VkPhysicalDeviceFeatures* required_features /* = nullptr */)
const VkPhysicalDeviceFeatures* required_features /* = nullptr */,
CreateDeviceWrapper create_device_wrapper /* = nullptr */,
void* create_device_wrapper_opaque /* = nullptr */)
{
g_vulkan_context.reset(new Context(instance, gpu, take_ownership));
@ -97,7 +99,8 @@ bool Context::CreateFromExistingInstance(VkInstance instance, VkPhysicalDevice g
// Attempt to create the device.
if (!g_vulkan_context->CreateDevice(surface, enable_validation_layer, required_device_extensions,
num_required_device_extensions, required_device_layers,
num_required_device_layers, required_features) ||
num_required_device_layers, required_features, create_device_wrapper,
create_device_wrapper_opaque) ||
!g_vulkan_context->CreateGlobalDescriptorPool() || !g_vulkan_context->CreateCommandBuffers())
{
g_vulkan_context.reset();
@ -179,7 +182,8 @@ bool Context::SelectDeviceFeatures(const VkPhysicalDeviceFeatures* required_feat
bool Context::CreateDevice(VkSurfaceKHR surface, bool enable_validation_layer, const char** required_device_extensions,
uint32_t num_required_device_extensions, const char** required_device_layers,
uint32_t num_required_device_layers, const VkPhysicalDeviceFeatures* required_features)
uint32_t num_required_device_layers, const VkPhysicalDeviceFeatures* required_features,
CreateDeviceWrapper create_device_wrapper, void* create_device_wrapper_opaque)
{
uint32_t queue_family_count;
vkGetPhysicalDeviceQueueFamilyProperties(m_physical_device, &queue_family_count, nullptr);
@ -304,11 +308,23 @@ bool Context::CreateDevice(VkSurfaceKHR surface, bool enable_validation_layer, c
device_info.ppEnabledLayerNames = layer_names;
}
VkResult res = vkCreateDevice(m_physical_device, &device_info, nullptr, &m_device);
if (res != VK_SUCCESS)
if (create_device_wrapper)
{
LOG_VULKAN_ERROR(res, "vkCreateDevice failed: ");
return false;
m_device = create_device_wrapper(m_physical_device, create_device_wrapper_opaque, &device_info);
if (m_device == VK_NULL_HANDLE)
{
Log_ErrorPrintf("Vulkan: the frontend did not create the device.");
return false;
}
}
else
{
VkResult res = vkCreateDevice(m_physical_device, &device_info, nullptr, &m_device);
if (res != VK_SUCCESS)
{
LOG_VULKAN_ERROR(res, "vkCreateDevice failed: ");
return false;
}
}
// With the device created, we can fill the remaining entry points.

View file

@ -21,6 +21,10 @@ class Context
public:
static constexpr uint32_t NUM_COMMAND_BUFFERS = 2;
// Creates the device in place of vkCreateDevice, e.g. a libretro
// frontend's, which adds what it needs to the create info.
using CreateDeviceWrapper = VkDevice (*)(VkPhysicalDevice gpu, void* opaque, const VkDeviceCreateInfo* info);
~Context();
// Returns a list of Vulkan-compatible GPUs.
@ -34,7 +38,9 @@ public:
uint32_t num_required_device_extensions = 0,
const char** required_device_layers = nullptr,
uint32_t num_required_device_layers = 0,
const VkPhysicalDeviceFeatures* required_features = nullptr);
const VkPhysicalDeviceFeatures* required_features = nullptr,
CreateDeviceWrapper create_device_wrapper = nullptr,
void* create_device_wrapper_opaque = nullptr);
// Destroys context.
static void Destroy();
@ -141,7 +147,8 @@ private:
bool SelectDeviceFeatures(const VkPhysicalDeviceFeatures* required_features);
bool CreateDevice(VkSurfaceKHR surface, bool enable_validation_layer, const char** required_device_extensions,
uint32_t num_required_device_extensions, const char** required_device_layers,
uint32_t num_required_device_layers, const VkPhysicalDeviceFeatures* required_features);
uint32_t num_required_device_layers, const VkPhysicalDeviceFeatures* required_features,
CreateDeviceWrapper create_device_wrapper, void* create_device_wrapper_opaque);
bool CreateCommandBuffers();
void DestroyCommandBuffers();

View file

@ -162,11 +162,14 @@ void LibretroVulkanHostDisplay::EndSetDisplayPixels()
static_cast<uint32_t>(m_display_texture_view_height));
}
static bool RetroCreateVulkanDevice(struct retro_vulkan_context* context, VkInstance instance, VkPhysicalDevice gpu,
VkSurfaceKHR surface, PFN_vkGetInstanceProcAddr get_instance_proc_addr,
const char** required_device_extensions, unsigned num_required_device_extensions,
const char** required_device_layers, unsigned num_required_device_layers,
const VkPhysicalDeviceFeatures* required_features)
static bool RetroCreateVulkanDeviceCommon(struct retro_vulkan_context* context, VkInstance instance,
VkPhysicalDevice gpu, VkSurfaceKHR surface,
PFN_vkGetInstanceProcAddr get_instance_proc_addr,
const char** required_device_extensions,
unsigned num_required_device_extensions,
const char** required_device_layers, unsigned num_required_device_layers,
const VkPhysicalDeviceFeatures* required_features,
retro_vulkan_create_device_wrapper_t create_device_wrapper, void* opaque)
{
// We need some module functions.
vkGetInstanceProcAddr = get_instance_proc_addr;
@ -193,7 +196,7 @@ static bool RetroCreateVulkanDevice(struct retro_vulkan_context* context, VkInst
if (!Vulkan::Context::CreateFromExistingInstance(
instance, gpu, surface, false, false, false, required_device_extensions, num_required_device_extensions,
required_device_layers, num_required_device_layers, required_features))
required_device_layers, num_required_device_layers, required_features, create_device_wrapper, opaque))
{
Vulkan::ResetVulkanLibraryFunctionPointers();
return false;
@ -208,6 +211,27 @@ static bool RetroCreateVulkanDevice(struct retro_vulkan_context* context, VkInst
return true;
}
static bool RetroCreateVulkanDevice(struct retro_vulkan_context* context, VkInstance instance, VkPhysicalDevice gpu,
VkSurfaceKHR surface, PFN_vkGetInstanceProcAddr get_instance_proc_addr,
const char** required_device_extensions, unsigned num_required_device_extensions,
const char** required_device_layers, unsigned num_required_device_layers,
const VkPhysicalDeviceFeatures* required_features)
{
return RetroCreateVulkanDeviceCommon(context, instance, gpu, surface, get_instance_proc_addr,
required_device_extensions, num_required_device_extensions,
required_device_layers, num_required_device_layers, required_features, nullptr,
nullptr);
}
// The same device, made through the frontend's wrapper, which brings its own extensions and features.
static bool RetroCreateVulkanDevice2(struct retro_vulkan_context* context, VkInstance instance, VkPhysicalDevice gpu,
VkSurfaceKHR surface, PFN_vkGetInstanceProcAddr get_instance_proc_addr,
retro_vulkan_create_device_wrapper_t create_device_wrapper, void* opaque)
{
return RetroCreateVulkanDeviceCommon(context, instance, gpu, surface, get_instance_proc_addr, nullptr, 0, nullptr,
0, nullptr, create_device_wrapper, opaque);
}
static const VkApplicationInfo *get_application_info_vulkan(void)
{
static VkApplicationInfo app_info{ VK_STRUCTURE_TYPE_APPLICATION_INFO };
@ -219,12 +243,22 @@ static const VkApplicationInfo *get_application_info_vulkan(void)
return &app_info;
}
static retro_hw_render_context_negotiation_interface_vulkan s_vulkan_context_negotiation_interface = {
RETRO_HW_RENDER_CONTEXT_NEGOTIATION_INTERFACE_VULKAN, // interface_type
RETRO_HW_RENDER_CONTEXT_NEGOTIATION_INTERFACE_VULKAN_VERSION, // interface_version
get_application_info_vulkan, // get_application_info
RetroCreateVulkanDevice, // create_device
nullptr // destroy_device
static const retro_hw_render_context_negotiation_interface_vulkan s_vulkan_context_negotiation_interface_v1 = {
RETRO_HW_RENDER_CONTEXT_NEGOTIATION_INTERFACE_VULKAN, // interface_type
1, // interface_version
get_application_info_vulkan, // get_application_info
RetroCreateVulkanDevice, // create_device
nullptr // destroy_device
};
static const retro_hw_render_context_negotiation_interface_vulkan s_vulkan_context_negotiation_interface_v2 = {
RETRO_HW_RENDER_CONTEXT_NEGOTIATION_INTERFACE_VULKAN, // interface_type
2, // interface_version
get_application_info_vulkan, // get_application_info
RetroCreateVulkanDevice, // create_device
nullptr, // destroy_device
nullptr, // create_instance
RetroCreateVulkanDevice2 // create_device2
};
bool LibretroVulkanHostDisplay::RequestHardwareRendererContext(retro_hw_render_callback* cb)
@ -232,9 +266,18 @@ bool LibretroVulkanHostDisplay::RequestHardwareRendererContext(retro_hw_render_c
cb->cache_context = false;
cb->bottom_left_origin = false;
cb->context_type = RETRO_HW_CONTEXT_VULKAN;
// v2 where the frontend has it, so it makes the device and can add what it needs (e.g. for its
// low-latency modes); a frontend that predates v2 rejects a v2 interface.
retro_hw_render_context_negotiation_interface support = {RETRO_HW_RENDER_CONTEXT_NEGOTIATION_INTERFACE_VULKAN, 0};
if (!g_retro_environment_callback(RETRO_ENVIRONMENT_GET_HW_RENDER_CONTEXT_NEGOTIATION_INTERFACE_SUPPORT, &support))
support.interface_version = 0;
return g_retro_environment_callback(RETRO_ENVIRONMENT_SET_HW_RENDER, cb) &&
g_retro_environment_callback(RETRO_ENVIRONMENT_SET_HW_RENDER_CONTEXT_NEGOTIATION_INTERFACE,
&s_vulkan_context_negotiation_interface);
const_cast<retro_hw_render_context_negotiation_interface_vulkan*>(
support.interface_version >= 2 ? &s_vulkan_context_negotiation_interface_v2 :
&s_vulkan_context_negotiation_interface_v1));
}
bool LibretroVulkanHostDisplay::CreateRenderDevice(const WindowInfo& wi, std::string_view adapter_name,

View file

@ -19,8 +19,10 @@
# path/label queries with missing, empty and short buffers
# reload the core re-initialized under a new environment, with a
# second logger and then none; no call reaches a replaced logger
# vulkan the Vulkan renderer's device negotiated with the core, under the
# validation layer; needs a Vulkan driver, e.g. lavapipe
# vulkan the Vulkan renderer's device negotiated as RetroArch does (v2,
# made through the frontend's wrapper) and as a frontend without
# v2 does (v1), under the validation layer; needs a Vulkan
# driver, e.g. lavapipe
#
# UPDATE_EXPECTED=1 rewrites an expected file from the core under test.
# Needs clang, ld.lld and llvm-objcopy for the MIPS test ROMs, python3, and a
@ -201,13 +203,16 @@ case "$SUITE" in
python3 "$TESTS/make_disc.py" "$WORK"
"$CC" -O1 -g ${FRONTEND_CFLAGS:-} -I"$TESTS/../dep/libretro-common/include" -I"$TESTS/../dep/vulkan-loader/include" \
"$TESTS/harness/vk_negotiate.c" -o "$WORK/vk_negotiate" -ldl
# Each frontend: RetroArch's (negotiation v2).
for offer in 2; do
# Each frontend: RetroArch's (negotiation v2: the device must be made through
# its wrapper), and one that predates v2.
for offer in 2 1; do
dir="$WORK/bios-vk"
rm -rf "$dir"
mkdir -p "$dir"
python3 "$TESTS/guest/mkrom.py" "$WORK/gpu_polyline.rom" "$dir/bios.bin" 1 0
if ! VKN_OFFER=$offer VKN_DIR="$dir" timeout "$TIMEOUT" "$WORK/vk_negotiate" "$CORE" "$WORK/disc.cue" \
expect=0
[ "$offer" -ge 2 ] && expect=1
if ! VKN_OFFER=$offer VKN_EXPECT_WRAPPER=$expect VKN_DIR="$dir" timeout "$TIMEOUT" "$WORK/vk_negotiate" "$CORE" "$WORK/disc.cue" \
swanstation_GPU_Renderer=Vulkan swanstation_CPU_ExecutionMode="$FE_CPU" \
swanstation_CPU_FastmemMode="$FE_FASTMEM" > "$WORK/run.log" 2>&1; then
cat "$WORK/run.log"