VKBuffer.cpp

Go to the documentation of this file.

#include "VKBuffer.hpp"
 
#include "BufferProcessingChain.hpp"
#include "MayaFlux/Buffers/Staging/StagingUtils.hpp"
 
#include "MayaFlux/Registry/BackendRegistry.hpp"
#include "MayaFlux/Registry/Service/BufferService.hpp"
#include "MayaFlux/Registry/Service/ComputeService.hpp"
 
#include "MayaFlux/Journal/Archivist.hpp"
 
namespace MayaFlux::Buffers {
 
VKBuffer::VKBuffer(
    size_t size_bytes,
    Usage usage,
    Kakshya::DataModality modality)
    : m_size_bytes(size_bytes)
    , m_usage(usage)
    , m_modality(modality)
    , m_processing_chain(std::make_shared<Buffers::BufferProcessingChain>())
    , m_processing_token(ProcessingToken::GRAPHICS_BACKEND)
{
    infer_dimensions_from_data(size_bytes);
 
    MF_INFO(Journal::Component::Buffers, Journal::Context::BufferManagement,
        "VKBuffer created (uninitialized): {} bytes, modality: {}",
        size_bytes, Kakshya::modality_to_string(modality));
}
 
VKBuffer::~VKBuffer() = default;
 
void VKBuffer::clear()
{
    if (!is_initialized()) {
        MF_WARN(Journal::Component::Buffers, Journal::Context::BufferManagement,
            "Cannot clear uninitialized VKBuffer");
        return;
    }
 
    if (is_host_visible() && m_resources.mapped_ptr) {
        std::memset(m_resources.mapped_ptr, 0, m_size_bytes);
    } else {
        MF_WARN(Journal::Component::Buffers, Journal::Context::BufferManagement,
            "clear() on device-local buffer requires ClearBufferProcessor");
    }
}
 
uint64_t VKBuffer::get_device_address() const
{
    if (!is_initialized()) {
        MF_WARN(Journal::Component::Buffers, Journal::Context::BufferManagement,
            "Cannot get device address of uninitialized VKBuffer");
        return 0;
    }
 
    if (m_usage != Usage::UNIFORM_BDA && m_usage != Usage::STORAGE_BDA) {
        MF_WARN(Journal::Component::Buffers, Journal::Context::BufferManagement,
            "get_device_address() called on buffer without BDA usage flags");
        return 0;
    }
 
    auto* buffer_service = Registry::BackendRegistry::instance()
                               .get_service<Registry::Service::BufferService>();
 
    if (!buffer_service) {
        error<std::runtime_error>(
            Journal::Component::Buffers,
            Journal::Context::BufferManagement,
            std::source_location::current(),
            "Cannot query buffer device address: BufferService not available");
    }
 
    auto shared_this = std::const_pointer_cast<VKBuffer>(
        std::static_pointer_cast<const VKBuffer>(shared_from_this()));
 
    return buffer_service->get_buffer_device_address(
        std::static_pointer_cast<void>(shared_this));
}
 
void VKBuffer::set_data(const std::vector<Kakshya::DataVariant>& data)
{
    if (!is_initialized()) {
        MF_WARN(Journal::Component::Buffers, Journal::Context::BufferManagement,
            "Cannot set_data on uninitialized VKBuffer. Register with BufferManager first.");
        return;
    }
 
    if (data.empty()) {
        clear();
        return;
    }
 
    if (is_host_visible() && m_resources.mapped_ptr) {
        Kakshya::DataAccess accessor(
            const_cast<Kakshya::DataVariant&>(data[0]),
            {},
            m_modality);
 
        auto [ptr, bytes, format_hint] = accessor.gpu_buffer();
 
        if (bytes > m_size_bytes) {
            error<std::runtime_error>(
                Journal::Component::Buffers,
                Journal::Context::BufferManagement,
                std::source_location::current(),
                "Data size {} exceeds buffer capacity {}",
                bytes, m_size_bytes);
        }
 
        std::memcpy(m_resources.mapped_ptr, ptr, bytes);
        mark_dirty_range(0, m_size_bytes);
 
        infer_dimensions_from_data(bytes);
    } else {
        MF_WARN(Journal::Component::Buffers, Journal::Context::BufferManagement,
            "set_data() on device-local buffer requires BufferUploadProcessor in chain");
    }
}
 
std::vector<Kakshya::DataVariant> VKBuffer::get_data()
{
    if (!is_initialized()) {
        MF_WARN(Journal::Component::Buffers, Journal::Context::BufferManagement,
            "Cannot get_data from uninitialized VKBuffer");
        return {};
    }
 
    if (is_host_visible() && m_resources.mapped_ptr) {
        mark_invalid_range(0, m_size_bytes);
 
        std::vector<uint8_t> raw_bytes(m_size_bytes);
        std::memcpy(raw_bytes.data(), m_resources.mapped_ptr, m_size_bytes);
        return { raw_bytes };
    }
 
    MF_WARN(Journal::Component::Buffers, Journal::Context::BufferManagement,
        "get_data() on device-local buffer requires BufferDownloadProcessor");
    return {};
}
 
void VKBuffer::resize(size_t new_size, bool preserve_data)
{
    if (new_size == m_size_bytes)
        return;
 
    if (!is_initialized()) {
        m_size_bytes = new_size;
        infer_dimensions_from_data(new_size);
 
        MF_RT_ERROR(Journal::Component::Buffers, Journal::Context::BufferManagement,
            "Cannot resize uninitialized VKBuffer");
        return;
    }
 
    auto buffer_service = Registry::BackendRegistry::instance()
                              .get_service<Registry::Service::BufferService>();
 
    if (!buffer_service) {
        error<std::runtime_error>(
            Journal::Component::Buffers,
            Journal::Context::BufferManagement,
            std::source_location::current(),
            "Cannot resize buffer: BufferService not available");
    }
 
    std::vector<uint8_t> old_data;
    if (preserve_data && is_host_visible() && m_resources.mapped_ptr) {
        size_t copy_size = std::min(m_size_bytes, new_size);
        old_data.resize(copy_size);
        std::memcpy(old_data.data(), m_resources.mapped_ptr, copy_size);
 
        MF_DEBUG(Journal::Component::Buffers, Journal::Context::BufferManagement,
            "Preserved {} bytes of old buffer data", copy_size);
    }
 
    buffer_service->destroy_buffer(shared_from_this());
 
    m_resources.buffer = vk::Buffer {};
    m_resources.memory = vk::DeviceMemory {};
    m_resources.mapped_ptr = nullptr;
 
    m_size_bytes = new_size;
    infer_dimensions_from_data(new_size);
 
    buffer_service->initialize_buffer(shared_from_this());
 
    if (!is_initialized()) {
        error<std::runtime_error>(
            Journal::Component::Buffers,
            Journal::Context::BufferManagement,
            std::source_location::current(),
            "Failed to recreate buffer after resize");
    }
 
    if (preserve_data && !old_data.empty() && is_host_visible() && m_resources.mapped_ptr) {
        std::memcpy(m_resources.mapped_ptr, old_data.data(), old_data.size());
        mark_dirty_range(0, old_data.size());
 
        MF_DEBUG(Journal::Component::Buffers, Journal::Context::BufferManagement,
            "Restored {} bytes to resized buffer", old_data.size());
    }
 
    // clear_pipeline_commands();
 
    MF_INFO(Journal::Component::Buffers, Journal::Context::BufferManagement,
        "VKBuffer resize complete: {} bytes", m_size_bytes);
}
 
vk::Format VKBuffer::get_format() const
{
    using namespace Kakshya;
 
    switch (m_modality) {
    case DataModality::VERTEX_POSITIONS_3D:
    case DataModality::VERTEX_NORMALS_3D:
    case DataModality::VERTEX_TANGENTS_3D:
    case DataModality::VERTEX_COLORS_RGB:
        return vk::Format::eR32G32B32Sfloat;
 
    case DataModality::TEXTURE_COORDS_2D:
        return vk::Format::eR32G32Sfloat;
 
    case DataModality::VERTEX_COLORS_RGBA:
        return vk::Format::eR32G32B32A32Sfloat;
 
    case DataModality::AUDIO_1D:
    case DataModality::AUDIO_MULTICHANNEL:
        return vk::Format::eR64Sfloat;
 
    case DataModality::IMAGE_2D:
    case DataModality::IMAGE_COLOR:
    case DataModality::TEXTURE_2D:
        return vk::Format::eR8G8B8A8Unorm;
 
    case DataModality::SPECTRAL_2D:
        return vk::Format::eR32G32Sfloat;
 
    default:
        return vk::Format::eUndefined;
    }
}
 
void VKBuffer::set_modality(Kakshya::DataModality modality)
{
    m_modality = modality;
    infer_dimensions_from_data(m_size_bytes);
}
 
vk::BufferUsageFlags VKBuffer::get_usage_flags() const
{
    vk::BufferUsageFlags flags = vk::BufferUsageFlagBits::eTransferSrc | vk::BufferUsageFlagBits::eTransferDst;
 
    switch (m_usage) {
    case Usage::STAGING:
        break;
    case Usage::DEVICE:
    case Usage::COMPUTE:
        flags |= vk::BufferUsageFlagBits::eStorageBuffer;
        break;
    case Usage::VERTEX:
        flags |= vk::BufferUsageFlagBits::eVertexBuffer | vk::BufferUsageFlagBits::eStorageBuffer;
        break;
    case Usage::INDEX:
        flags |= vk::BufferUsageFlagBits::eIndexBuffer;
        break;
    case Usage::UNIFORM:
        flags |= vk::BufferUsageFlagBits::eUniformBuffer;
        break;
    case Usage::UNIFORM_BDA:
        flags |= vk::BufferUsageFlagBits::eUniformBuffer
            | vk::BufferUsageFlagBits::eShaderDeviceAddress;
        break;
    case Usage::STORAGE_BDA:
        flags |= vk::BufferUsageFlagBits::eStorageBuffer
            | vk::BufferUsageFlagBits::eShaderDeviceAddress;
        break;
    }
 
    return flags;
}
 
vk::MemoryPropertyFlags VKBuffer::get_memory_properties() const
{
    if (is_host_visible()) {
        return vk::MemoryPropertyFlagBits::eHostVisible | vk::MemoryPropertyFlagBits::eHostCoherent;
    }
    return vk::MemoryPropertyFlagBits::eDeviceLocal;
}
 
void VKBuffer::process_default()
{
    if (m_process_default && m_default_processor) {
        m_default_processor->process(shared_from_this());
    }
}
 
void VKBuffer::set_default_processor(const std::shared_ptr<BufferProcessor>& processor)
{
    if (m_default_processor) {
        m_default_processor->on_detach(shared_from_this());
    }
    if (processor) {
        processor->on_attach(shared_from_this());
    }
    m_default_processor = processor;
}
 
std::shared_ptr<Buffers::BufferProcessor> VKBuffer::get_default_processor() const
{
    return m_default_processor;
}
 
std::shared_ptr<Buffers::BufferProcessingChain> VKBuffer::get_processing_chain()
{
    return m_processing_chain;
}
 
void VKBuffer::set_processing_chain(const std::shared_ptr<BufferProcessingChain>& chain, bool force)
{
    if (m_processing_chain && !force) {
        m_processing_chain->merge_chain(chain);
        return;
    }
    m_processing_chain = chain;
}
 
void VKBuffer::infer_dimensions_from_data(size_t byte_count)
{
    using namespace Kakshya;
 
    m_dimensions.clear();
 
    switch (m_modality) {
    case DataModality::VERTEX_POSITIONS_3D: {
        uint64_t count = byte_count / sizeof(glm::vec3);
        m_dimensions.push_back(DataDimension::vertex_positions(count));
        break;
    }
 
    case DataModality::VERTEX_NORMALS_3D: {
        uint64_t count = byte_count / sizeof(glm::vec3);
        m_dimensions.push_back(DataDimension::vertex_normals(count));
        break;
    }
 
    case DataModality::TEXTURE_COORDS_2D: {
        uint64_t count = byte_count / sizeof(glm::vec2);
        m_dimensions.push_back(DataDimension::texture_coords(count));
        break;
    }
 
    case DataModality::VERTEX_COLORS_RGB: {
        uint64_t count = byte_count / sizeof(glm::vec3);
        m_dimensions.push_back(DataDimension::vertex_colors(count, false));
        break;
    }
 
    case DataModality::VERTEX_COLORS_RGBA: {
        uint64_t count = byte_count / sizeof(glm::vec4);
        m_dimensions.push_back(DataDimension::vertex_colors(count, true));
        break;
    }
 
    case DataModality::AUDIO_1D: {
        uint64_t samples = byte_count / sizeof(double);
        m_dimensions.push_back(DataDimension::time(samples));
        break;
    }
 
    default:
        m_dimensions.emplace_back("data", byte_count, 1, DataDimension::Role::CUSTOM);
        break;
    }
}
 
void VKBuffer::mark_dirty_range(size_t offset, size_t size)
{
    if (is_host_visible()) {
        m_dirty_ranges.emplace_back(offset, size);
    }
}
 
void VKBuffer::mark_invalid_range(size_t offset, size_t size)
{
    if (is_host_visible()) {
        m_invalid_ranges.emplace_back(offset, size);
    }
}
 
std::vector<std::pair<size_t, size_t>> VKBuffer::get_and_clear_dirty_ranges()
{
    return std::exchange(m_dirty_ranges, {});
}
 
std::vector<std::pair<size_t, size_t>> VKBuffer::get_and_clear_invalid_ranges()
{
    return std::exchange(m_invalid_ranges, {});
}
 
void VKBuffer::set_vertex_layout(const Kakshya::VertexLayout& layout)
{
    auto computed_layout = layout;
    computed_layout.compute_stride();
    m_vertex_layout = computed_layout;
}
 
std::shared_ptr<Buffers::VKBuffer> VKBuffer::clone_to(Usage usage)
{
    auto buffer = std::make_shared<VKBuffer>(m_size_bytes, usage, m_modality);
 
    if (auto layout = get_vertex_layout(); layout.has_value()) {
        buffer->set_vertex_layout(layout.value());
    }
 
    buffer->set_processing_chain(get_processing_chain());
    buffer->set_default_processor(get_default_processor());
 
    if (is_host_visible()) {
        if (buffer->is_host_visible()) {
            auto src_ptr = static_cast<uint8_t*>(m_resources.mapped_ptr);
            buffer->set_data({ std::vector<uint8_t>(src_ptr, src_ptr + m_size_bytes) });
        } else {
            download_device_local(
                std::dynamic_pointer_cast<VKBuffer>(shared_from_this()),
                buffer,
                nullptr);
        }
    } else {
        if (buffer->is_host_visible()) {
            upload_device_local(
                buffer,
                std::dynamic_pointer_cast<VKBuffer>(shared_from_this()),
                get_data()[0]);
        } else {
            MF_WARN(Journal::Component::Buffers, Journal::Context::BufferManagement,
                "Cloning device-local VKBuffer to another device-local VKBuffer requires external data transfer");
        }
    }
 
    return buffer;
}
 
std::shared_ptr<Buffers::Buffer> VKBuffer::clone_to(uint8_t dest_desc)
{
    auto usage = static_cast<Usage>(dest_desc);
    return std::dynamic_pointer_cast<Buffers::Buffer>(clone_to(usage));
}
 
void VKBufferProcessor::initialize_buffer_service()
{
    m_buffer_service = Registry::BackendRegistry::instance()
                           .get_service<Registry::Service::BufferService>();
}
 
void VKBufferProcessor::initialize_compute_service()
{
    m_compute_service = Registry::BackendRegistry::instance()
                            .get_service<Registry::Service::ComputeService>();
}
 
void VKBufferProcessor::ensure_initialized(const std::shared_ptr<VKBuffer>& buffer)
{
    if (!m_buffer_service) {
        m_buffer_service = Registry::BackendRegistry::instance()
                               .get_service<Registry::Service::BufferService>();
    }
    if (!m_buffer_service) {
        error<std::runtime_error>(
            Journal::Component::Buffers,
            Journal::Context::BufferProcessing,
            std::source_location::current(),
            "VKBufferProcessor requires a valid BufferService");
    }
    if (!buffer->is_initialized()) {
        m_buffer_service->initialize_buffer(buffer);
    }
}
 
} // namespace MayaFlux::Buffers::Vulkan