// Copyright 2019 The Dawn & Tint Authors
//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are met:
//
// 1. Redistributions of source code must retain the above copyright notice, this
//    list of conditions and the following disclaimer.
//
// 2. Redistributions in binary form must reproduce the above copyright notice,
//    this list of conditions and the following disclaimer in the documentation
//    and/or other materials provided with the distribution.
//
// 3. Neither the name of the copyright holder nor the names of its
//    contributors may be used to endorse or promote products derived from
//    this software without specific prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
// AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
// IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
// DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
// FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
// DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
// SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
// CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
// OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

#ifndef SRC_DAWN_NATIVE_VULKAN_RESOURCEMEMORYALLOCATORVK_H_
#define SRC_DAWN_NATIVE_VULKAN_RESOURCEMEMORYALLOCATORVK_H_

#include <map>
#include <memory>
#include <vector>

#include "dawn/common/SerialQueue.h"
#include "dawn/common/vulkan_platform.h"
#include "dawn/native/Error.h"
#include "dawn/native/IntegerTypes.h"
#include "dawn/native/PooledResourceMemoryAllocator.h"
#include "dawn/native/ResourceMemoryAllocation.h"
#include "partition_alloc/pointers/raw_ptr.h"

namespace dawn::native::vulkan {

class Device;
class ResourceHeap;
struct VulkanDeviceInfo;

// Each bit of MemoryKind represents a kind of memory that influence the result of the allocation.
// For example, to take into account mappability and Vulkan's bufferImageGranularity.
enum class MemoryKind : uint8_t {
    LazilyAllocated = 1,
    Linear = 2,
    DeviceLocal = 4,
    ReadMappable = 8,
    WriteMappable = 16,
    HostCached = 32,
};

bool SupportsBufferMapExtendedUsages(const VulkanDeviceInfo& deviceInfo);

class ResourceMemoryAllocator {
  public:
    // Returns heap block size as specified by `control` or the default value if not.
    static VkDeviceSize GetHeapBlockSize(const DawnDeviceAllocatorControl* control);

    // `heapBlockSize` must be a power of two.
    ResourceMemoryAllocator(Device* device, VkDeviceSize heapBlockSize);
    ~ResourceMemoryAllocator();

    ResultOrError<ResourceMemoryAllocation> Allocate(const VkMemoryRequirements& requirements,
                                                     MemoryKind kind,
                                                     bool forceDisableSubAllocation = false);
    void Deallocate(ResourceMemoryAllocation* allocation);

    void FreeRecycledMemory();

    // Returns the last serial that an object is pending deletion after or
    // kBeginningOfGPUTime if no objects are pending deletion.
    ExecutionSerial GetLastPendingDeletionSerial();

    void Tick(ExecutionSerial completedSerial);

    int FindBestTypeIndex(VkMemoryRequirements requirements, MemoryKind kind);

    // Reports the total vulkan allocated and vulkan used memories.
    uint64_t GetTotalUsedMemory() const;
    uint64_t GetTotalAllocatedMemory() const;
    // Reports the total lazy allocated and used vulkan memory.
    uint64_t GetTotalLazyAllocatedMemory() const;
    uint64_t GetTotalLazyUsedMemory() const;

  protected:
    void RecordHeapAllocation(VkDeviceSize size, bool isLazyMemoryType);
    void DeallocateResourceHeap(ResourceHeap* heap, bool isLazyMemoryType);

  private:
    // Wrapper for tracking the allocation sizes to be decremented up to a completed ExecutionSerial
    // and reporting total allocation/used sizes.
    class AllocationSizeTracker {
      public:
        // Increment the total size for tracking.
        void Increment(VkDeviceSize incrementSize);
        // Track the size to be decremented on Tick.
        void Decrement(ExecutionSerial currentSerial, VkDeviceSize decrementSize);
        // Update the total size after completed serials.
        void Tick(ExecutionSerial completedSerial);

        VkDeviceSize Size() const { return mTotalSize; }

      private:
        std::map<ExecutionSerial, VkDeviceSize> mMemoryToDecrement;
        VkDeviceSize mTotalSize = 0;
    };

    VkMemoryPropertyFlags GetRequiredMemoryPropertyFlags(MemoryKind memoryKind) const;

    raw_ptr<Device> mDevice;
    const VkDeviceSize mMaxSizeForSuballocation;
    bool mHostCachedForExtendedUsagesAvailable = false;
    bool mHostVisibleCachedAvailable = false;

    class SingleTypeAllocator;
    std::vector<std::unique_ptr<SingleTypeAllocator>> mAllocatorsPerType;

    SerialQueue<ExecutionSerial, ResourceMemoryAllocation> mSubAllocationsToDelete;
    AllocationSizeTracker mAllocatedMemory;
    AllocationSizeTracker mUsedMemory;
    AllocationSizeTracker mLazyAllocatedMemory;
    AllocationSizeTracker mLazyUsedMemory;
};

}  // namespace dawn::native::vulkan

namespace wgpu {
template <>
struct IsWGPUBitmask<dawn::native::vulkan::MemoryKind> {
    static constexpr bool enable = true;
};

}  // namespace wgpu

#endif  // SRC_DAWN_NATIVE_VULKAN_RESOURCEMEMORYALLOCATORVK_H_