GarbageCollectionHistory.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
/*=============================================================================
    GarbageCollectionHistory.h: Unreal realtime garbage collection history
=============================================================================*/
 
#pragma once
 
#include "Containers/Array.h"
#include "Containers/Map.h"
#include "HAL/Platform.h"
#include "UObject/FastReferenceCollector.h"
#include "UObject/GCObjectInfo.h"
#include "UObject/GarbageCollection.h"
#include "UObject/NameTypes.h"
#include "UObject/ReferenceToken.h"
 
class FGCObjectInfo;
class UObject;
 
#if ENABLE_GC_HISTORY
 
struct FGCSnapshot
{
    TMap<const UObject*, FGCObjectInfo*> ObjectToInfoMap;
#if WITH_VERSE_VM || defined(__INTELLISENSE__)
    TMap<const Verse::VCell*, FGCVerseCellInfo*> VerseCellToInfoMap;
#endif
    TMap<FReferenceToken, TArray<FGCDirectReference>*> DirectReferences;
 
    int64 GetAllocatedSize() const;
};
 
class FGCHistory
{
    TArray<FGCSnapshot> Snapshots;
    int32 MostRecentSnapshotIndex = -1;
    UObject* GCBarrier = nullptr;
 
    COREUOBJECT_API ~FGCHistory();
 
    COREUOBJECT_API void Cleanup(FGCSnapshot& InShapshot);  
    COREUOBJECT_API void MergeArrayStructHistory(TMap<FReferenceToken, TArray<FGCDirectReference>*>& History, FGCSnapshot& Snapshot);
    FReferenceToken GetInfoReferenceToken(FReferenceToken InToken, FGCSnapshot& Snapshot);
 
public:
 
    static COREUOBJECT_API FGCHistory& Get();
 
    COREUOBJECT_API void Update(TConstArrayView<TUniquePtr<UE::GC::FWorkerContext>> Contexts);
 
    COREUOBJECT_API void Cleanup();
 
    COREUOBJECT_API void SetHistorySize(int32 HistorySize);
 
    UE_FORCEINLINE_HINT int32 GetHistorySize() const
    {
        return Snapshots.Num();
    }
 
    UE_FORCEINLINE_HINT bool IsActive() const
    {
        return GetHistorySize() > 0;
    }
 
    COREUOBJECT_API FGCSnapshot* GetSnapshot(int32 HistoryLevel);
 
    FGCSnapshot* GetLastSnapshot()
    {
        return GetSnapshot(0);
    }
 
    COREUOBJECT_API int64 GetAllocatedSize() const;
 
    UE_FORCEINLINE_HINT UObject* GetBarrierObject() const
    {
        return GCBarrier;
    }
};
 
#endif // ENABLE_GC_HISTORY