asdf-overlay-vulkan-layer 1.2.2

pub mod physical_device;
pub mod surface;

use core::{
    ffi::{CStr, c_char, c_void},
    mem,
    ptr::NonNull,
};

use crate::{device, instance::physical_device::PHYSICAL_DEVICE_MAP, map::IntDashMap};

use super::{proc_table, resolve_proc};
use ash::{
    Instance,
    vk::{self, BaseInStructure, Handle, PhysicalDeviceIDProperties, PhysicalDeviceProperties2},
};
use once_cell::sync::Lazy;
use tracing::{debug, trace};

/// Map of [`vk::Instance`] to its dispatch table.
static DISPATCH_TABLE: Lazy<IntDashMap<u64, DispatchTable>> = Lazy::new(IntDashMap::default);

/// Instance dispatch table.
struct DispatchTable {
    /// Function pointer to next `vkGetInstanceProcAddr`.
    get_proc_addr: vk::PFN_vkGetInstanceProcAddr,

    /// Physical devices enumerated at instance creation time.
    physical_devices: Vec<vk::PhysicalDevice>,

    /// Vulkan instance handle.
    instance: Instance,

    /// Function pointer to actual `vkCreateWin32SurfaceKHR`.
    create_win32_surface: Option<vk::PFN_vkCreateWin32SurfaceKHR>,

    /// Function pointer to actual `vkDestroySurfaceKHR`.
    destroy_surface: Option<vk::PFN_vkDestroySurfaceKHR>,
}

impl DispatchTable {
    /// Create a new [`DispatchTable`].
    fn new(get_proc_addr: vk::PFN_vkGetInstanceProcAddr, raw_instance: vk::Instance) -> Self {
        macro_rules! proc {
            ($name:literal : $ty:ty) => {
                unsafe { resolve_proc!(get_proc_addr => raw_instance, $name : $ty) }
            };
        }

        let instance = unsafe {
            Instance::load_with(
                |name| {
                    mem::transmute::<vk::PFN_vkVoidFunction, *const c_void>(get_proc_addr(
                        raw_instance,
                        name.as_ptr(),
                    ))
                },
                raw_instance,
            )
        };
        let physical_devices = unsafe { instance.enumerate_physical_devices() }
            .expect("failed to enumerate physical devices");
        Self {
            physical_devices,

            instance,
            create_win32_surface: proc!(c"vkCreateWin32SurfaceKHR": vk::PFN_vkCreateWin32SurfaceKHR),
            destroy_surface: proc!(c"vkDestroySurfaceKHR": vk::PFN_vkDestroySurfaceKHR),

            get_proc_addr,
        }
    }
}

/// Implementation of layer's `vkGetInstanceProcAddr`.
#[tracing::instrument(skip(name))]
pub(super) extern "system" fn get_proc_addr(
    instance: vk::Instance,
    name: *const c_char,
) -> vk::PFN_vkVoidFunction {
    let a = unsafe { &*CStr::from_ptr(name).to_string_lossy() };
    trace!("vkGetInstanceProcAddr called name: {}", a);

    unsafe {
        proc_table!(&*CStr::from_ptr(name).to_string_lossy() => {
            "vkGetInstanceProcAddr" => get_proc_addr: vk::PFN_vkGetInstanceProcAddr,
            "vkCreateInstance" => create_instance: vk::PFN_vkCreateInstance,
            "vkDestroyInstance" => destroy_instance: vk::PFN_vkDestroyInstance,
            "vkCreateDevice" => device::create_device: vk::PFN_vkCreateDevice,
            "vkCreateWin32SurfaceKHR" => surface::create_win32_surface: vk::PFN_vkCreateWin32SurfaceKHR,
            "vkDestroySurfaceKHR" => surface::destroy_surface: vk::PFN_vkDestroySurfaceKHR,
        });
    }

    unsafe { (DISPATCH_TABLE.get(&instance.as_raw())?.get_proc_addr)(instance, name) }
}

/// Implementation of layer's `vkCreateInstance`.
#[tracing::instrument]
extern "system" fn create_instance(
    info: *const vk::InstanceCreateInfo,
    callback: *const vk::AllocationCallbacks,
    instance: *mut vk::Instance,
) -> vk::Result {
    trace!("vkCreateInstance called");

    let Some(layer_create_info) =
        (unsafe { get_layer_link_info(info).map(|mut info| info.as_mut()) })
    else {
        return vk::Result::ERROR_INITIALIZATION_FAILED;
    };
    let link = unsafe { &*{ layer_create_info.u.p_layer_info } };
    // Move chain info for next layer
    layer_create_info.u.p_layer_info = unsafe { (*layer_create_info.u.p_layer_info).p_next };

    let Some(next_get_instance_proc_addr) = link.pfn_next_get_instance_proc_addr else {
        return vk::Result::ERROR_INITIALIZATION_FAILED;
    };

    let Some(create_instance) = (unsafe {
        resolve_proc!(next_get_instance_proc_addr =>
            vk::Instance::null(),
            c"vkCreateInstance": vk::PFN_vkCreateInstance
        )
    }) else {
        return vk::Result::ERROR_INITIALIZATION_FAILED;
    };

    let res = unsafe { create_instance(info, callback, instance) };
    if res != vk::Result::SUCCESS {
        return res;
    }

    debug!("initializing instance dispatch table");
    let instance = unsafe { *instance };
    let table = DispatchTable::new(next_get_instance_proc_addr, instance);
    for &physical_device in &table.physical_devices {
        let mem_props = unsafe {
            table
                .instance
                .get_physical_device_memory_properties(physical_device)
        };

        let mut id_prop = PhysicalDeviceIDProperties::default();
        let mut prop = PhysicalDeviceProperties2::default().push_next(&mut id_prop);
        unsafe {
            table
                .instance
                .get_physical_device_properties2(physical_device, &mut prop)
        };

        PHYSICAL_DEVICE_MAP.insert(physical_device.as_raw(), (mem_props, id_prop.device_luid));
    }

    DISPATCH_TABLE.insert(instance.as_raw(), table);

    vk::Result::SUCCESS
}

/// Implementation of layer's `vkDestroyInstance`.
#[tracing::instrument]
extern "system" fn destroy_instance(
    instance: vk::Instance,
    allocator: *const vk::AllocationCallbacks<'_>,
) {
    trace!("vkDestroyInstance called");

    debug!("instance dispatch table cleanup");
    let (_, table) = DISPATCH_TABLE.remove(&instance.as_raw()).unwrap();
    unsafe {
        (table.instance.fp_v1_0().destroy_instance)(instance, allocator);
    }

    for physical_device in table.physical_devices {
        PHYSICAL_DEVICE_MAP.remove(&physical_device.as_raw());
    }
}

/// Structure matching `VkLayerInstanceLink`.
#[repr(C)]
#[derive(Copy, Clone)]
struct LayerInstanceLink {
    /// Pointer to next layer's `VkLayerInstanceLink`.
    pub p_next: *mut LayerInstanceLink,

    /// Function pointer to next layer's `vkGetInstanceProcAddr`.
    pub pfn_next_get_instance_proc_addr: Option<vk::PFN_vkGetInstanceProcAddr>,

    /// Function pointer to next layer's `vkGetPhysicalDeviceProcAddr`.
    pub pfn_next_get_physical_device_proc_addr: vk::PFN_vkVoidFunction,
}

/// Union matching the `u` field of `VkLayerInstanceCreateInfo`.
#[repr(C)]
#[derive(Copy, Clone)]
union LayerInstanceCreateInfoUnion {
    /// Pointer to next layer's `VkLayerInstanceLink`.
    pub p_layer_info: *mut LayerInstanceLink,
}

/// Structure matching `VkLayerInstanceCreateInfo`.
#[repr(C)]
#[derive(Copy, Clone)]
struct LayerInstanceCreateInfo {
    /// Structure type, which is `VK_STRUCTURE_TYPE_LOADER_INSTANCE_CREATE_INFO`.
    pub s_type: vk::StructureType,

    /// Pointer to next structure in `pNext` chain.
    pub p_next: *mut c_void,

    /// Function indicator for this structure.
    pub function: i32,

    /// Union containing pointer to next layer's `VkLayerInstanceLink`.
    pub u: LayerInstanceCreateInfoUnion,
}

/// Helper to extract [`LayerInstanceCreateInfo`] from the
/// `pNext` chain of [`vk::InstanceCreateInfo`].
unsafe fn get_layer_link_info(
    instance_create_info: *const vk::InstanceCreateInfo,
) -> Option<NonNull<LayerInstanceCreateInfo>> {
    const VK_LAYER_LINK_INFO: i32 = 0;

    let mut layer_create_info: NonNull<BaseInStructure> =
        NonNull::new(instance_create_info.cast::<BaseInStructure>().cast_mut())?;
    loop {
        layer_create_info = NonNull::new(
            unsafe { layer_create_info.as_ref() }
                .p_next
                .cast::<BaseInStructure>()
                .cast_mut(),
        )?;

        if unsafe { layer_create_info.as_ref() }.s_type
            == vk::StructureType::LOADER_INSTANCE_CREATE_INFO
        {
            let layer_create_info = layer_create_info.cast::<LayerInstanceCreateInfo>();
            if unsafe { layer_create_info.as_ref() }.function == VK_LAYER_LINK_INFO {
                return Some(layer_create_info);
            }
        }
    }
}