ScriptStackTracker.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
/*=============================================================================
ScriptStackTracker.h: Script Stack Tracking within Unreal Engine.
=============================================================================*/
#pragma once
 
#include "Containers/Array.h"
#include "Containers/Map.h"
#include "Containers/UnrealString.h"
#include "CoreMinimal.h"
#include "HAL/Platform.h"
 
class FOutputDevice;
struct FFrame;
 
struct FScriptStackTracker
{
private:
    static const int32 MAX_BACKTRACE_DEPTH = 50;
 
    struct FCallStack
    {
        int64 StackCount;
        FString StackTrace;
    };
 
    TArray<FCallStack> CallStacks;
    TMap<uint32,int32> CRCToCallStackIndexMap;
    bool bAvoidCapturing;
    bool bIsEnabled;
    uint64 StartFrameCounter;
    uint64 StopFrameCounter;
 
public:
    FScriptStackTracker( bool bInIsEnabled = false )
        :   bAvoidCapturing(false)
        ,   bIsEnabled(bInIsEnabled)
        ,   StartFrameCounter(0)
        ,   StopFrameCounter(0)
    {}
 
    COREUOBJECT_API void CaptureStackTrace(const FFrame* StackFrame, int32 EntriesToIgnore = 0);
 
    COREUOBJECT_API void DumpStackTraces( int32 StackThreshold, FOutputDevice& Ar );
 
    COREUOBJECT_API void ResetTracking();
 
    COREUOBJECT_API void ToggleTracking();
};