magnum/src/Magnum/Vk/Memory.cpp

/*
    This file is part of Magnum.

    Copyright © 2010, 2011, 2012, 2013, 2014, 2015, 2016, 2017, 2018, 2019,
                2020, 2021 Vladimír Vondruš <mosra@centrum.cz>

    Permission is hereby granted, free of charge, to any person obtaining a
    copy of this software and associated documentation files (the "Software"),
    to deal in the Software without restriction, including without limitation
    the rights to use, copy, modify, merge, publish, distribute, sublicense,
    and/or sell copies of the Software, and to permit persons to whom the
    Software is furnished to do so, subject to the following conditions:

    The above copyright notice and this permission notice shall be included
    in all copies or substantial portions of the Software.

    THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
    IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
    FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
    THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
    LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
    FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
    DEALINGS IN THE SOFTWARE.
*/

#include "Memory.h"
#include "MemoryAllocateInfo.h"

#include <Corrade/Containers/Array.h>
#include <Corrade/Containers/EnumSet.hpp>
#include <Corrade/Utility/Debug.h>

#include "Magnum/Vk/Assert.h"
#include "Magnum/Vk/Device.h"
#include "Magnum/Vk/Handle.h"

namespace Magnum { namespace Vk {

MemoryRequirements::MemoryRequirements(): _requirements{} {
    _requirements.sType = VK_STRUCTURE_TYPE_MEMORY_REQUIREMENTS_2;
}

MemoryRequirements::MemoryRequirements(NoInitT) noexcept {}

MemoryRequirements::MemoryRequirements(const VkMemoryRequirements2& requirements):
    /* Can't use {} with GCC 4.8 here because it tries to initialize the first
       member instead of doing a copy */
    _requirements(requirements) {}

UnsignedLong MemoryRequirements::alignedSize(const UnsignedLong alignment) const {
    CORRADE_ASSERT(alignment, "Vk::MemoryRequirements::alignedSize(): alignment can't be zero", {});
    return ((_requirements.memoryRequirements.size + alignment - 1)/alignment)*alignment;
}

MemoryAllocateInfo::MemoryAllocateInfo(UnsignedLong size, UnsignedInt memory): _info{} {
    _info.sType = VK_STRUCTURE_TYPE_MEMORY_ALLOCATE_INFO;
    _info.allocationSize = size;
    _info.memoryTypeIndex = memory;
}

MemoryAllocateInfo::MemoryAllocateInfo(NoInitT) noexcept {}

MemoryAllocateInfo::MemoryAllocateInfo(const VkMemoryAllocateInfo& info):
    /* Can't use {} with GCC 4.8 here because it tries to initialize the first
       member instead of doing a copy */
    _info(info) {}

Memory Memory::wrap(Device& device, const VkDeviceMemory handle, const UnsignedLong size, const HandleFlags flags) {
    Memory out{NoCreate};
    out._device = &device;
    out._handle = handle;
    out._flags = flags;
    out._size = size;
    return out;
}

Memory::Memory(Device& device, const MemoryAllocateInfo& info): _device{&device}, _flags{HandleFlag::DestroyOnDestruction}, _size{info->allocationSize} {
    MAGNUM_VK_INTERNAL_ASSERT_SUCCESS(device->AllocateMemory(device, info, nullptr, &_handle));
}

Memory::Memory(NoCreateT): _device{}, _handle{} {}

Memory::Memory(Memory&& other) noexcept: _device{other._device}, _handle{other._handle}, _flags{other._flags}, _size{other._size} {
    other._handle = {};
    other._size = {};
}

Memory::~Memory() {
    if(_handle && (_flags & HandleFlag::DestroyOnDestruction))
        (**_device).FreeMemory(*_device, _handle, nullptr);
}

Memory& Memory::operator=(Memory&& other) noexcept {
    using std::swap;
    swap(other._device, _device);
    swap(other._handle, _handle);
    swap(other._flags, _flags);
    swap(other._size, _size);
    return *this;
}

Containers::Array<char, MemoryMapDeleter> Memory::map(const UnsignedLong offset, const UnsignedLong size) {
    void* data;
    MAGNUM_VK_INTERNAL_ASSERT_SUCCESS((**_device).MapMemory(*_device, _handle, offset, size, {}, &data));
    return Containers::Array<char, MemoryMapDeleter>{static_cast<char*>(data), std::size_t(size), MemoryMapDeleter{(**_device).UnmapMemory, *_device, _handle}};
}

Containers::Array<char, MemoryMapDeleter> Memory::map() {
    CORRADE_ASSERT(_size, "Vk::Memory::map(): the memory has unknown size, you have to specify it explicitly", {});
    return map(0, _size);
}

Containers::Array<const char, MemoryMapDeleter> Memory::mapRead(const UnsignedLong offset, const UnsignedLong size) {
    Containers::Array<char, MemoryMapDeleter> out = map(offset, size);

    /* Simply "cast" to a const array. Extracting the deleter before because
       the order of operations is unspecified and the deleter could be queried
       after release() got called */
    const MemoryMapDeleter deleter = out.deleter();
    return Containers::Array<const char, MemoryMapDeleter>{out.release(), std::size_t(size), deleter};
}

Containers::Array<const char, MemoryMapDeleter> Memory::mapRead() {
    CORRADE_ASSERT(_size, "Vk::Memory::mapRead(): the memory has unknown size, you have to specify it explicitly", {});
    return mapRead(0, _size);
}

VkDeviceMemory Memory::release() {
    const VkDeviceMemory handle = _handle;
    _handle = {};
    _size = {};
    return handle;
}

Debug& operator<<(Debug& debug, const MemoryFlag value) {
    debug << "Vk::MemoryFlag" << Debug::nospace;

    switch(value) {
        /* LCOV_EXCL_START */
        #define _c(value) case Vk::MemoryFlag::value: return debug << "::" << Debug::nospace << #value;
        _c(DeviceLocal)
        _c(HostVisible)
        _c(HostCoherent)
        _c(HostCached)
        _c(LazilyAllocated)
        #undef _c
        /* LCOV_EXCL_STOP */
    }

    /* Flag bits should be in hex, unlike plain values */
    return debug << "(" << Debug::nospace << reinterpret_cast<void*>(UnsignedInt(value)) << Debug::nospace << ")";
}

Debug& operator<<(Debug& debug, const MemoryFlags value) {
    return Containers::enumSetDebugOutput(debug, value, "Vk::MemoryFlags{}", {
        Vk::MemoryFlag::DeviceLocal,
        Vk::MemoryFlag::HostVisible,
        Vk::MemoryFlag::HostCoherent,
        Vk::MemoryFlag::HostCached,
        Vk::MemoryFlag::LazilyAllocated});
}

}}