summaryrefslogtreecommitdiffstats
path: root/Graphics/GraphicsEngineVulkan/include/BufferVkImpl.hpp
blob: e9a16e54a67e7d2047632f75c3f7175c777b8c90 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
/*
 *  Copyright 2019-2021 Diligent Graphics LLC
 *  Copyright 2015-2019 Egor Yusov
 *  
 *  Licensed under the Apache License, Version 2.0 (the "License");
 *  you may not use this file except in compliance with the License.
 *  You may obtain a copy of the License at
 *  
 *      http://www.apache.org/licenses/LICENSE-2.0
 *  
 *  Unless required by applicable law or agreed to in writing, software
 *  distributed under the License is distributed on an "AS IS" BASIS,
 *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 *  See the License for the specific language governing permissions and
 *  limitations under the License.
 *
 *  In no event and under no legal theory, whether in tort (including negligence), 
 *  contract, or otherwise, unless required by applicable law (such as deliberate 
 *  and grossly negligent acts) or agreed to in writing, shall any Contributor be
 *  liable for any damages, including any direct, indirect, special, incidental, 
 *  or consequential damages of any character arising as a result of this License or 
 *  out of the use or inability to use the software (including but not limited to damages 
 *  for loss of goodwill, work stoppage, computer failure or malfunction, or any and 
 *  all other commercial damages or losses), even if such Contributor has been advised 
 *  of the possibility of such damages.
 */

#pragma once

/// \file
/// Declaration of Diligent::BufferVkImpl class

#include "EngineVkImplTraits.hpp"
#include "BufferBase.hpp"
#include "BufferViewVkImpl.hpp" // Required by BufferBase

#include "VulkanDynamicHeap.hpp"
#include "VulkanUtilities/VulkanObjectWrappers.hpp"
#include "VulkanUtilities/VulkanMemoryManager.hpp"
#include "STDAllocator.hpp"

namespace Diligent
{

/// Buffer object implementation in Vulkan backend.
class BufferVkImpl final : public BufferBase<EngineVkImplTraits>
{
public:
    using TBufferBase = BufferBase<EngineVkImplTraits>;

    BufferVkImpl(IReferenceCounters*        pRefCounters,
                 FixedBlockMemoryAllocator& BuffViewObjMemAllocator,
                 RenderDeviceVkImpl*        pDeviceVk,
                 const BufferDesc&          BuffDesc,
                 const BufferData*          pBuffData = nullptr);

    BufferVkImpl(IReferenceCounters*        pRefCounters,
                 FixedBlockMemoryAllocator& BuffViewObjMemAllocator,
                 class RenderDeviceVkImpl*  pDeviceVk,
                 const BufferDesc&          BuffDesc,
                 RESOURCE_STATE             InitialState,
                 VkBuffer                   vkBuffer);
    ~BufferVkImpl();

    IMPLEMENT_QUERY_INTERFACE_IN_PLACE(IID_BufferVk, TBufferBase)

#ifdef DILIGENT_DEVELOPMENT
    void DvpVerifyDynamicAllocation(DeviceContextVkImpl* pCtx) const;
#endif

    Uint32 GetDynamicOffset(Uint32 CtxId, DeviceContextVkImpl* pCtx) const
    {
        if (m_VulkanBuffer != VK_NULL_HANDLE)
        {
            return 0;
        }
        else
        {
            VERIFY(m_Desc.Usage == USAGE_DYNAMIC, "Dynamic buffer is expected");
            VERIFY_EXPR(!m_DynamicData.empty());
#ifdef DILIGENT_DEVELOPMENT
            DvpVerifyDynamicAllocation(pCtx);
#endif
            auto& DynAlloc = m_DynamicData[CtxId];
            return static_cast<Uint32>(DynAlloc.AlignedOffset);
        }
    }

    /// Implementation of IBufferVk::GetVkBuffer().
    virtual VkBuffer DILIGENT_CALL_TYPE GetVkBuffer() const override final;

    /// Implementation of IBuffer::GetNativeHandle() in Vulkan backend.
    virtual void* DILIGENT_CALL_TYPE GetNativeHandle() override final
    {
        auto vkBuffer = GetVkBuffer();
        return reinterpret_cast<void*>(vkBuffer);
    }

    /// Implementation of IBufferVk::SetAccessFlags().
    virtual void DILIGENT_CALL_TYPE SetAccessFlags(VkAccessFlags AccessFlags) override final;

    /// Implementation of IBufferVk::GetAccessFlags().
    virtual VkAccessFlags DILIGENT_CALL_TYPE GetAccessFlags() const override final;

    /// Implementation of IBufferVk::GetVkDeviceAddress().
    virtual VkDeviceAddress DILIGENT_CALL_TYPE GetVkDeviceAddress() const override final;

    bool CheckAccessFlags(VkAccessFlags AccessFlags) const
    {
        return (GetAccessFlags() & AccessFlags) == AccessFlags;
    }

    void* GetCPUAddress()
    {
        VERIFY_EXPR(m_Desc.Usage == USAGE_STAGING || m_Desc.Usage == USAGE_UNIFIED);
        return reinterpret_cast<Uint8*>(m_MemoryAllocation.Page->GetCPUMemory()) + m_BufferMemoryAlignedOffset;
    }

private:
    friend class DeviceContextVkImpl;

    virtual void CreateViewInternal(const struct BufferViewDesc& ViewDesc, IBufferView** ppView, bool bIsDefaultView) override;

    VulkanUtilities::BufferViewWrapper CreateView(struct BufferViewDesc& ViewDesc);

    Uint32       m_DynamicOffsetAlignment    = 0;
    VkDeviceSize m_BufferMemoryAlignedOffset = 0;

    // TODO (assiduous): move dynamic allocations to device context.
    static constexpr size_t CacheLineSize = 64;
    struct alignas(CacheLineSize) CtxDynamicData : VulkanDynamicAllocation
    {
        CtxDynamicData() noexcept {}
        CtxDynamicData(CtxDynamicData&&) = default;

        CtxDynamicData& operator=(VulkanDynamicAllocation&& Allocation)
        {
            *static_cast<VulkanDynamicAllocation*>(this) = std::move(Allocation);
            return *this;
        }

        Uint8 Padding[CacheLineSize - sizeof(VulkanDynamicAllocation)];
    };
    static_assert(sizeof(CtxDynamicData) == CacheLineSize, "Unexpected sizeof(CtxDynamicData)");
    std::vector<CtxDynamicData, STDAllocatorRawMem<CtxDynamicData>> m_DynamicData;

    VulkanUtilities::BufferWrapper          m_VulkanBuffer;
    VulkanUtilities::VulkanMemoryAllocation m_MemoryAllocation;
};

} // namespace Diligent