CallstackTrace.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
#pragma once
#include "HAL/Platform.h"
#include "HAL/PlatformTLS.h"
#include "Math/NumericLimits.h"
#include "Misc/Build.h"
#include "Trace/Config.h"
#include "Containers/StringFwd.h"
 
#if !defined(UE_CALLSTACK_TRACE_ENABLED)
    #if UE_TRACE_ENABLED && !UE_BUILD_SHIPPING
        #if PLATFORM_WINDOWS && !PLATFORM_CPU_ARM_FAMILY
            #define UE_CALLSTACK_TRACE_ENABLED 1
        #endif
    #endif
#endif
 
#if !defined(UE_CALLSTACK_TRACE_ENABLED)
    #define UE_CALLSTACK_TRACE_ENABLED 0
#endif
 
#if !defined(UE_CALLSTACK_TRACE_MAX_FRAMES)
    #define UE_CALLSTACK_TRACE_MAX_FRAMES 255
#endif
 
#if UE_CALLSTACK_TRACE_ENABLED
 
void CallstackTrace_Create(class FMalloc* Malloc);
 
void CallstackTrace_Initialize();
 
bool CallstackTrace_FilterModule(FStringView ModuleName);
 
CORE_API uint32 CallstackTrace_GetCurrentId();
 
#define CALLSTACK_TRACE_LIMIT_CALLSTACKRESOLVE_SCOPE()                      FCallStackTraceLimitResolveScope PREPROCESSOR_JOIN(FCTLMScope,__LINE__)
 
extern CORE_API uint32 GCallStackTracingTlsSlotIndex;
 
inline void* CallstackTrace_GetFallbackPlatformReturnAddressData()
{
    if (FPlatformTLS::IsValidTlsSlot(GCallStackTracingTlsSlotIndex))
        return FPlatformTLS::GetTlsValue(GCallStackTracingTlsSlotIndex);
    else
        return nullptr;
}
 
inline bool  CallstackTrace_ResolveFullCallStack()
{
    return CallstackTrace_GetFallbackPlatformReturnAddressData() == nullptr;
}
 
/*
 * Callstack Trace scope for override CallStack
 */
class FCallStackTraceLimitResolveScope
{
public:
    FORCENOINLINE FCallStackTraceLimitResolveScope()
    {
        if (FPlatformTLS::IsValidTlsSlot(GCallStackTracingTlsSlotIndex))
        {
            FPlatformTLS::SetTlsValue(GCallStackTracingTlsSlotIndex, PLATFORM_RETURN_ADDRESS_FOR_CALLSTACKTRACING());
        }
    }
 
    FORCENOINLINE ~FCallStackTraceLimitResolveScope()
    {
        if (FPlatformTLS::IsValidTlsSlot(GCallStackTracingTlsSlotIndex))
        {
            FPlatformTLS::SetTlsValue(GCallStackTracingTlsSlotIndex, nullptr);
        }
    }
};
 
#else // UE_CALLSTACK_TRACE_ENABLED
 
inline void CallstackTrace_Create(class FMalloc* Malloc) {}
inline void CallstackTrace_Initialize() {}
inline uint32 CallstackTrace_GetCurrentId() { return 0; }
inline void* CallstackTrace_GetCurrentReturnAddressData() { return nullptr; }
inline void* CallstackTrace_GetFallbackPlatformReturnAddressData() { return nullptr; }
inline bool  CallstackTrace_ResolveFullCallStack() { return true; }
 
#define CALLSTACK_TRACE_LIMIT_CALLSTACKRESOLVE_SCOPE()
 
#endif // UE_CALLSTACK_TRACE_ENABLED