LargeMemoryData.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#include "Containers/LockFreeList.h"
#include "CoreTypes.h"
 
#include <atomic>
 
template <class T, int TPaddingForCacheContention> class TLockFreePointerListUnordered;
 
class FLargeMemoryData
{
public:
 
    CORE_API explicit FLargeMemoryData(const int64 PreAllocateBytes = 0);
    CORE_API ~FLargeMemoryData();
 
    CORE_API bool Write(void* InData, int64 InOffset, int64 InNum);
 
    UE_FORCEINLINE_HINT void Append(void* InData, int64 InNum)
    {
        Write(InData, NumBytes, InNum);
    }
 
    CORE_API bool Read(void* OutData, int64 InOffset, int64 InNum) const;
 
    UE_FORCEINLINE_HINT int64 GetSize() const
    {
        return NumBytes;
    }
 
    UE_FORCEINLINE_HINT uint8* GetData()
    {
        return Data;
    }
 
    UE_FORCEINLINE_HINT const uint8* GetData() const
    {
        return Data;
    }
 
    CORE_API uint8* ReleaseOwnership();
 
    bool HasData() const 
    {
        return Data != nullptr;
    }
 
    CORE_API void Reserve(int64 Size);
 
private:
 
    FLargeMemoryData(const FLargeMemoryData&) = delete;
    FLargeMemoryData& operator=(const FLargeMemoryData&) = delete;
 
    uint8* Data;
 
    int64 NumBytes;
 
    int64 MaxBytes;
 
    CORE_API void GrowBuffer();
};
 
class FPooledLargeMemoryData
{
public:
    CORE_API FPooledLargeMemoryData();
    CORE_API ~FPooledLargeMemoryData();
    FLargeMemoryData& Get() { return *Data; }
private:
    static void Free(FLargeMemoryData* Data);
    FLargeMemoryData* Data;
    static CORE_API TLockFreePointerListUnordered<FLargeMemoryData, 0> FreeList;
    static CORE_API std::atomic<int32> FreeListLength;
};