0ad/source/renderer/backend/vulkan/Buffer.cpp

/* Copyright (C) 2024 Wildfire Games.
 * This file is part of 0 A.D.
 *
 * 0 A.D. is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 2 of the License, or
 * (at your option) any later version.
 *
 * 0 A.D. is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with 0 A.D.  If not, see <http://www.gnu.org/licenses/>.
 */

#include "precompiled.h"

#include "Buffer.h"

#include "renderer/backend/vulkan/Device.h"
#include "renderer/backend/vulkan/Utilities.h"

#include <tuple>

namespace Renderer
{

namespace Backend
{

namespace Vulkan
{

VkBufferUsageFlags ToVkBufferUsageFlags(const uint32_t usage)
{
	VkBufferUsageFlags usageFlags = 0;
	if (usage & IBuffer::Usage::TRANSFER_SRC)
		usageFlags |= VK_BUFFER_USAGE_TRANSFER_SRC_BIT;
	if (usage & IBuffer::Usage::TRANSFER_DST)
		usageFlags |= VK_BUFFER_USAGE_TRANSFER_DST_BIT;
	if (usage & IBuffer::Usage::STORAGE)
		usageFlags |= VK_BUFFER_USAGE_STORAGE_BUFFER_BIT;
	return usageFlags;
}

std::tuple<VkBufferUsageFlags, VkMemoryPropertyFlags, VmaMemoryUsage> MakeCreationFlags(
	const IBuffer::Type type, const uint32_t usage)
{
	const VkBufferUsageFlags commonFlags = ToVkBufferUsageFlags(usage);

	switch (type)
	{
	case IBuffer::Type::VERTEX:
		ENSURE(usage & (IBuffer::Usage::TRANSFER_DST | IBuffer::Usage::STORAGE));
		return {
			commonFlags | VK_BUFFER_USAGE_VERTEX_BUFFER_BIT,
			VK_MEMORY_PROPERTY_DEVICE_LOCAL_BIT,
			VMA_MEMORY_USAGE_AUTO_PREFER_DEVICE};
	case IBuffer::Type::INDEX:
		ENSURE(usage & (IBuffer::Usage::TRANSFER_DST | IBuffer::Usage::STORAGE));
		return {
			commonFlags | VK_BUFFER_USAGE_INDEX_BUFFER_BIT,
			VK_MEMORY_PROPERTY_DEVICE_LOCAL_BIT,
			VMA_MEMORY_USAGE_AUTO_PREFER_DEVICE};
	case IBuffer::Type::UPLOAD:
		ENSURE(usage & IBuffer::Usage::TRANSFER_SRC);
		ENSURE(!(usage & IBuffer::Usage::STORAGE));
		return {
			commonFlags,
			VK_MEMORY_PROPERTY_HOST_VISIBLE_BIT | VK_MEMORY_PROPERTY_HOST_COHERENT_BIT,
			VMA_MEMORY_USAGE_AUTO};
	case IBuffer::Type::UNIFORM:
		ENSURE(usage & IBuffer::Usage::TRANSFER_DST);
		return {
			commonFlags | VK_BUFFER_USAGE_UNIFORM_BUFFER_BIT,
			VK_MEMORY_PROPERTY_DEVICE_LOCAL_BIT,
			VMA_MEMORY_USAGE_AUTO_PREFER_DEVICE};
	}

	return {0, 0, VMA_MEMORY_USAGE_AUTO};
}

// static
std::unique_ptr<CBuffer> CBuffer::Create(
	CDevice* device, const char* name, const Type type, const uint32_t size,
	const uint32_t usage)
{
	std::unique_ptr<CBuffer> buffer(new CBuffer());
	buffer->m_Device = device;
	buffer->m_UID = device->GenerateNextDeviceObjectUID();
	buffer->m_Type = type;
	buffer->m_Size = size;
	buffer->m_Usage = usage;

	const auto [usageFlags, memoryProperties, memoryUsage] = MakeCreationFlags(type, usage);
	// According to the Vulkan spec usage must not be 0.
	ENSURE(usageFlags != 0);

	VkBufferCreateInfo bufferCreateInfo{};
	bufferCreateInfo.sType = VK_STRUCTURE_TYPE_BUFFER_CREATE_INFO;
	bufferCreateInfo.size = size;
	bufferCreateInfo.usage = usageFlags;
	bufferCreateInfo.sharingMode = VK_SHARING_MODE_EXCLUSIVE;

	VmaAllocationCreateInfo allocationCreateInfo{};
	if (type == Type::UPLOAD)
		allocationCreateInfo.flags = VMA_ALLOCATION_CREATE_MAPPED_BIT | VMA_ALLOCATION_CREATE_HOST_ACCESS_SEQUENTIAL_WRITE_BIT;
#ifndef NDEBUG
	allocationCreateInfo.flags |= VMA_ALLOCATION_CREATE_USER_DATA_COPY_STRING_BIT;
	allocationCreateInfo.pUserData = const_cast<char*>(name);
#endif
	allocationCreateInfo.requiredFlags = memoryProperties;
	allocationCreateInfo.usage = memoryUsage;
	const VkResult createBufferResult = vmaCreateBuffer(
		device->GetVMAAllocator(), &bufferCreateInfo, &allocationCreateInfo,
		&buffer->m_Buffer, &buffer->m_Allocation, &buffer->m_AllocationInfo);
	if (createBufferResult != VK_SUCCESS)
	{
		LOGERROR("Failed to create VkBuffer: %d (%s)", static_cast<int>(createBufferResult), Utilities::GetVkResultName(createBufferResult));
		return nullptr;
	}

	device->SetObjectName(VK_OBJECT_TYPE_BUFFER, buffer->m_Buffer, name);

	return buffer;
}

CBuffer::CBuffer() = default;

CBuffer::~CBuffer()
{
	if (m_Allocation != VK_NULL_HANDLE)
		m_Device->ScheduleObjectToDestroy(
			VK_OBJECT_TYPE_BUFFER, m_Buffer, m_Allocation);

	m_Device->ScheduleBufferToDestroy(m_UID);
}

IDevice* CBuffer::GetDevice()
{
	return m_Device;
}

} // namespace Vulkan

} // namespace Backend

} // namespace Renderer