ReachabilityAnalysis.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
/*=============================================================================
    ReachabilityAnalysis.h: Utility functions for configuring and running
    Incremental reachability analysis
=============================================================================*/
 
#pragma once
 
#include "CoreMinimal.h"
 
struct FUObjectItem;
 
COREUOBJECT_API void SetIncrementalReachabilityAnalysisEnabled(bool bEnabled);
 
COREUOBJECT_API bool GetIncrementalReachabilityAnalysisEnabled();
 
COREUOBJECT_API void SetReachabilityAnalysisTimeLimit(float TimeLimitSeconds);
 
COREUOBJECT_API float GetReachabilityAnalysisTimeLimit();
 
 
namespace UE::GC
{
 
union FUnreachableObject
{
    FUObjectItem* ObjectItem;
    UObject* Object;
};
 
}
 
namespace UE::GC::Private
{
 
struct FIterationTimerStat
{
    double Total = 0.0;
    double Max = 0.0;
    int32 NumIterations = 0;
    int32 SlowestIteration = 0;
 
    double operator += (double ElapsedTime)
    {
        int32 IterationIndex = NumIterations++;
        Total += ElapsedTime;
        if (ElapsedTime > Max)
        {
            Max = ElapsedTime;
            SlowestIteration = IterationIndex;
        }
        return Total;
    }
 
    FString ToString() const;
};
 
struct FStats
{
    double TotalTime = 0.0;
 
    double ReachabilityTimeLimit = 0.0;
    double UnhashingTimeLimit = 0.0;
    double DestroyGarbageTimeLimit = 0.0;
 
    double VerifyTime = 0.0;
    double VerifyNoUnreachableTime = 0.0;
    double GarbageTrackingTime = 0.0;
 
    double InitialReferenceCollectionTime = 0.0;
    double MarkObjectsAsUnreachableTime = 0.0;
    double TraceExternalRootsTime = 0.0;
    double NotifyUnreachableTime = 0.0;
    double DissolveUnreachableClustersTime = 0.0;
 
    FIterationTimerStat ReachabilityTime;
    FIterationTimerStat ReferenceCollectionTime;
    FIterationTimerStat GatherUnreachableTime;
    FIterationTimerStat UnhashingTime;
    FIterationTimerStat DestroyGarbageTime;
 
    int32 NumObjects = 0;
    int32 NumRoots = 0;
    int32 NumClusters = 0;
    int32 NumClusteredObjects = 0;
    int32 NumUnreachableObjects = 0;
    int32 NumDissolvedClusters = 0;
    int32 NumUnreachableClusteredObjects = 0;
    int32 NumBarrierObjects = 0;
    int32 NumWeakReferencesForClearing = 0;
    int32 NumObjectsThatNeedWeakReferenceClearing = 0;
 
    bool bStartedAsFullPurge = false;
    bool bFinishedAsFullPurge = false;
    bool bFlushedAsyncLoading = false;
    bool bPurgedPreviousGCObjects = false;
    bool bInProgress = false;
 
    void DumpToLog();
};
 
} // namespace UE::GC::Private