TagTrace.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
#pragma once
 
#include "CoreTypes.h"
#include "ProfilingDebugging/MemoryTrace.h"
#include "Trace/Config.h"
#include "Trace/Detail/LogScope.h"
 
class FName;
 
// Fwd declare ELLMTag
enum class ELLMTag : uint8;
// Fwd declare LLM private tag data
namespace UE {
    namespace LLMPrivate {
        class FTagData;
    }
}
 
CORE_API int32  MemoryTrace_AnnounceCustomTag(int32 Tag, int32 ParentTag, const TCHAR* Display);
CORE_API int32  MemoryTrace_AnnounceFNameTag(const class FName& TagName);
CORE_API int32  MemoryTrace_GetActiveTag();
 
inline constexpr int32 TRACE_TAG = 257;
 
#if !defined(UE_MEMORY_TAGS_TRACE_ENABLED)
    #define UE_MEMORY_TAGS_TRACE_ENABLED 0
#endif
 
#if UE_MEMORY_TAGS_TRACE_ENABLED && UE_TRACE_ENABLED
 
 
class FMemScope
{
public:
    CORE_API FMemScope(); // Used with SetTagAndActivate
    CORE_API FMemScope(int32 InTag, bool bShouldActivate = true);
    CORE_API FMemScope(ELLMTag InTag, bool bShouldActivate = true);
    CORE_API FMemScope(const class FName& InName, bool bShouldActivate = true);
    CORE_API FMemScope(const UE::LLMPrivate::FTagData* TagData, bool bShouldActivate = true);
    CORE_API ~FMemScope();
 
    CORE_API void SetTagAndActivate(const class FName& InName, bool bShouldActivate = true);
 
private:
    void ActivateScope(int32 InTag);
    UE::Trace::Private::FScopedLogScope Inner;
    int32 PrevTag;
};
 
 
template<typename TagType>
class FDefaultMemScope : public FMemScope
{
public:
    FDefaultMemScope(TagType InTag)
        : FMemScope(InTag, MemoryTrace_GetActiveTag() == 0)
    {
    }
};
 
class FMemScopePtr
{
public:
    CORE_API FMemScopePtr(uint64 InPtr, HeapId InRootHeap = EMemoryTraceRootHeap::SystemMemory);
    CORE_API ~FMemScopePtr();
private:
    UE::Trace::Private::FScopedLogScope Inner;
};
 
#define UE_MEMSCOPE(InTag)                  FMemScope PREPROCESSOR_JOIN(MemScope,__LINE__)(InTag);
// UE_MEMSCOPE_PTR(InPtr) or UE_MEMSCOPE_PTR(InPtr, InRootHeap)
#define UE_MEMSCOPE_PTR(InPtr, ...)         FMemScopePtr PREPROCESSOR_JOIN(MemPtrScope,__LINE__)((uint64)InPtr, ##__VA_ARGS__);
#define UE_MEMSCOPE_DEFAULT(InTag)          FDefaultMemScope PREPROCESSOR_JOIN(MemScope,__LINE__)(InTag);
#define UE_MEMSCOPE_UNINITIALIZED(Line)     FMemScope PREPROCESSOR_JOIN(MemScope,Line);
#define UE_MEMSCOPE_ACTIVATE(Line, InTag)   PREPROCESSOR_JOIN(MemScope,Line).SetTagAndActivate(InTag);
 
#else // UE_MEMORY_TAGS_TRACE_ENABLED
 
#define UE_MEMSCOPE(...)
#define UE_MEMSCOPE_PTR(...)
#define UE_MEMSCOPE_DEFAULT(...)
#define UE_MEMSCOPE_UNINITIALIZED(...)
#define UE_MEMSCOPE_ACTIVATE(...)
 
#endif // UE_MEMORY_TAGS_TRACE_ENABLED