EM_Task/CoreUObject/Private/Serialization/LoadTimeTrace.cpp

// Copyright Epic Games, Inc. All Rights Reserved.

#include "Serialization/LoadTimeTrace.h"

#if LOADTIMEPROFILERTRACE_ENABLED

#include "LoadTimeTracePrivate.h"
#include "Trace/Trace.inl"
#include "Misc/CString.h"
#include "HAL/PlatformTime.h"
#include "HAL/PlatformTLS.h"
#include "UObject/NameTypes.h"
#include "UObject/Object.h"
#include "UObject/UObjectGlobals.h"
#include "Misc/CommandLine.h"

UE_TRACE_EVENT_BEGIN(LoadTime, StartAsyncLoading, Important)
UE_TRACE_EVENT_FIELD(uint64, Cycle)
UE_TRACE_EVENT_END()

UE_TRACE_EVENT_BEGIN(LoadTime, SuspendAsyncLoading)
UE_TRACE_EVENT_FIELD(uint64, Cycle)
UE_TRACE_EVENT_END()

UE_TRACE_EVENT_BEGIN(LoadTime, ResumeAsyncLoading)
UE_TRACE_EVENT_FIELD(uint64, Cycle)
UE_TRACE_EVENT_END()

UE_TRACE_EVENT_BEGIN(LoadTime, PackageSummary)
UE_TRACE_EVENT_FIELD(const void*, AsyncPackage)
UE_TRACE_EVENT_FIELD(uint32, TotalHeaderSize)
UE_TRACE_EVENT_FIELD(uint32, ImportCount)
UE_TRACE_EVENT_FIELD(uint32, ExportCount)
UE_TRACE_EVENT_END()

UE_TRACE_EVENT_BEGIN(LoadTime, BeginCreateExport)
UE_TRACE_EVENT_FIELD(uint64, Cycle)
UE_TRACE_EVENT_FIELD(const void*, AsyncPackage)
UE_TRACE_EVENT_END()

UE_TRACE_EVENT_BEGIN(LoadTime, EndCreateExport)
UE_TRACE_EVENT_FIELD(uint64, Cycle)
UE_TRACE_EVENT_FIELD(const UObject*, Object)
UE_TRACE_EVENT_FIELD(const UClass*, Class)
UE_TRACE_EVENT_END()

UE_TRACE_EVENT_BEGIN(LoadTime, BeginSerializeExport)
UE_TRACE_EVENT_FIELD(uint64, Cycle)
UE_TRACE_EVENT_FIELD(const UObject*, Object)
UE_TRACE_EVENT_FIELD(uint64, SerialSize)
UE_TRACE_EVENT_END()

UE_TRACE_EVENT_BEGIN(LoadTime, EndSerializeExport)
UE_TRACE_EVENT_FIELD(uint64, Cycle)
UE_TRACE_EVENT_END()

UE_TRACE_EVENT_BEGIN(LoadTime, BeginPostLoadExport)
UE_TRACE_EVENT_FIELD(uint64, Cycle)
UE_TRACE_EVENT_FIELD(const UObject*, Object)
UE_TRACE_EVENT_END()

UE_TRACE_EVENT_BEGIN(LoadTime, EndPostLoadExport)
UE_TRACE_EVENT_FIELD(uint64, Cycle)
UE_TRACE_EVENT_END()

UE_TRACE_EVENT_BEGIN(LoadTime, BeginRequest)
UE_TRACE_EVENT_FIELD(uint64, Cycle)
UE_TRACE_EVENT_FIELD(uint64, RequestId)
UE_TRACE_EVENT_END()

UE_TRACE_EVENT_BEGIN(LoadTime, EndRequest)
UE_TRACE_EVENT_FIELD(uint64, Cycle)
UE_TRACE_EVENT_FIELD(uint64, RequestId)
UE_TRACE_EVENT_END()

UE_TRACE_EVENT_BEGIN(LoadTime, NewAsyncPackage)
UE_TRACE_EVENT_FIELD(const void*, AsyncPackage)
UE_TRACE_EVENT_END()

UE_TRACE_EVENT_BEGIN(LoadTime, BeginLoadAsyncPackage)
UE_TRACE_EVENT_FIELD(uint64, Cycle)
UE_TRACE_EVENT_FIELD(const void*, AsyncPackage)
UE_TRACE_EVENT_END()

UE_TRACE_EVENT_BEGIN(LoadTime, EndLoadAsyncPackage)
UE_TRACE_EVENT_FIELD(uint64, Cycle)
UE_TRACE_EVENT_FIELD(const void*, AsyncPackage)
UE_TRACE_EVENT_END()

UE_TRACE_EVENT_BEGIN(LoadTime, DestroyAsyncPackage)
UE_TRACE_EVENT_FIELD(const void*, AsyncPackage)
UE_TRACE_EVENT_END()

UE_TRACE_EVENT_BEGIN(LoadTime, AsyncPackageRequestAssociation)
UE_TRACE_EVENT_FIELD(const void*, AsyncPackage)
UE_TRACE_EVENT_FIELD(uint64, RequestId)
UE_TRACE_EVENT_END()

UE_TRACE_EVENT_BEGIN(LoadTime, AsyncPackageImportDependency)
UE_TRACE_EVENT_FIELD(const void*, AsyncPackage)
UE_TRACE_EVENT_FIELD(const void*, ImportedAsyncPackage)
UE_TRACE_EVENT_END()

UE_TRACE_EVENT_BEGIN(LoadTime, ClassInfo, Important)
UE_TRACE_EVENT_FIELD(const UClass*, Class)
UE_TRACE_EVENT_END()

void FLoadTimeProfilerTracePrivate::Init()
{
}

void FLoadTimeProfilerTracePrivate::OutputStartAsyncLoading()
{
    UE_TRACE_LOG(LoadTime, StartAsyncLoading, LoadTimeChannel)
        << StartAsyncLoading.Cycle(FPlatformTime::Cycles64());
}

PRAGMA_DISABLE_SHADOW_VARIABLE_WARNINGS
void FLoadTimeProfilerTracePrivate::OutputSuspendAsyncLoading()
{
    UE_TRACE_LOG(LoadTime, SuspendAsyncLoading, LoadTimeChannel)
        << SuspendAsyncLoading.Cycle(FPlatformTime::Cycles64());
}

void FLoadTimeProfilerTracePrivate::OutputResumeAsyncLoading()
{
    UE_TRACE_LOG(LoadTime, ResumeAsyncLoading, LoadTimeChannel)
        << ResumeAsyncLoading.Cycle(FPlatformTime::Cycles64());
}
PRAGMA_ENABLE_SHADOW_VARIABLE_WARNINGS

void FLoadTimeProfilerTracePrivate::OutputBeginRequest(uint64 RequestId)
{
    UE_TRACE_LOG(LoadTime, BeginRequest, LoadTimeChannel)
        << BeginRequest.Cycle(FPlatformTime::Cycles64())
        << BeginRequest.RequestId(RequestId);
}

void FLoadTimeProfilerTracePrivate::OutputEndRequest(uint64 RequestId)
{
    UE_TRACE_LOG(LoadTime, EndRequest, LoadTimeChannel)
        << EndRequest.Cycle(FPlatformTime::Cycles64())
        << EndRequest.RequestId(RequestId);
}

void FLoadTimeProfilerTracePrivate::OutputNewAsyncPackage(const void* AsyncPackage, const FName& PackageName)
{
    TCHAR Buffer[FName::StringBufferSize];
    uint16 NameSize = (PackageName.ToString(Buffer) + 1) * sizeof(TCHAR);
    UE_TRACE_LOG(LoadTime, NewAsyncPackage, LoadTimeChannel, NameSize)
        << NewAsyncPackage.AsyncPackage(AsyncPackage)
        << NewAsyncPackage.Attachment(Buffer, NameSize);
}

void FLoadTimeProfilerTracePrivate::OutputBeginLoadAsyncPackage(const void* AsyncPackage)
{
    UE_TRACE_LOG(LoadTime, BeginLoadAsyncPackage, LoadTimeChannel)
        << BeginLoadAsyncPackage.Cycle(FPlatformTime::Cycles64())
        << BeginLoadAsyncPackage.AsyncPackage(AsyncPackage);
}

void FLoadTimeProfilerTracePrivate::OutputEndLoadAsyncPackage(const void* AsyncPackage)
{
    UE_TRACE_LOG(LoadTime, EndLoadAsyncPackage, LoadTimeChannel)
        << EndLoadAsyncPackage.Cycle(FPlatformTime::Cycles64())
        << EndLoadAsyncPackage.AsyncPackage(AsyncPackage);
}

void FLoadTimeProfilerTracePrivate::OutputDestroyAsyncPackage(const void* AsyncPackage)
{
    UE_TRACE_LOG(LoadTime, DestroyAsyncPackage, LoadTimeChannel)
        << DestroyAsyncPackage.AsyncPackage(AsyncPackage);
}

void FLoadTimeProfilerTracePrivate::OutputPackageSummary(const void* AsyncPackage, uint32 TotalHeaderSize, uint32 ImportCount, uint32 ExportCount)
{
    UE_TRACE_LOG(LoadTime, PackageSummary, LoadTimeChannel)
        << PackageSummary.AsyncPackage(AsyncPackage)
        << PackageSummary.TotalHeaderSize(TotalHeaderSize)
        << PackageSummary.ImportCount(ImportCount)
        << PackageSummary.ExportCount(ExportCount);
}

void FLoadTimeProfilerTracePrivate::OutputAsyncPackageRequestAssociation(const void* AsyncPackage, uint64 RequestId)
{
    UE_TRACE_LOG(LoadTime, AsyncPackageRequestAssociation, LoadTimeChannel)
        << AsyncPackageRequestAssociation.AsyncPackage(AsyncPackage)
        << AsyncPackageRequestAssociation.RequestId(RequestId);
}

void FLoadTimeProfilerTracePrivate::OutputAsyncPackageImportDependency(const void* Package, const void* ImportedPackage)
{
    UE_TRACE_LOG(LoadTime, AsyncPackageImportDependency, LoadTimeChannel)
        << AsyncPackageImportDependency.AsyncPackage(Package)
        << AsyncPackageImportDependency.ImportedAsyncPackage(ImportedPackage);
}

void FLoadTimeProfilerTracePrivate::OutputClassInfo(const UClass* Class, const FName& Name)
{
    TCHAR Buffer[FName::StringBufferSize];
    uint16 NameSize = (Name.ToString(Buffer) + 1) * sizeof(TCHAR);
    UE_TRACE_LOG(LoadTime, ClassInfo, LoadTimeChannel, NameSize)
        << ClassInfo.Class(Class)
        << ClassInfo.Attachment(Buffer, NameSize);
}

void FLoadTimeProfilerTracePrivate::OutputClassInfo(const UClass* Class, const TCHAR* Name)
{
    uint16 NameSize = (FCString::Strlen(Name) + 1) * sizeof(TCHAR);
    UE_TRACE_LOG(LoadTime, ClassInfo, LoadTimeChannel, NameSize)
        << ClassInfo.Class(Class)
        << ClassInfo.Attachment(Name, NameSize);
}

FLoadTimeProfilerTracePrivate::FCreateExportScope::FCreateExportScope(const void* AsyncPackage, const UObject* const* InObject)
    : Object(InObject)
{
    UE_TRACE_LOG(LoadTime, BeginCreateExport, LoadTimeChannel)
        << BeginCreateExport.Cycle(FPlatformTime::Cycles64())
        << BeginCreateExport.AsyncPackage(AsyncPackage);
}

FLoadTimeProfilerTracePrivate::FCreateExportScope::~FCreateExportScope()
{
    UE_TRACE_LOG(LoadTime, EndCreateExport, LoadTimeChannel)
        << EndCreateExport.Cycle(FPlatformTime::Cycles64())
        << EndCreateExport.Object(*Object)
        << EndCreateExport.Class(*Object ? (*Object)->GetClass() : nullptr);
}

FLoadTimeProfilerTracePrivate::FSerializeExportScope::FSerializeExportScope(const UObject* Object, uint64 SerialSize)
{
    UE_TRACE_LOG(LoadTime, BeginSerializeExport, LoadTimeChannel)
        << BeginSerializeExport.Cycle(FPlatformTime::Cycles64())
        << BeginSerializeExport.Object(Object)
        << BeginSerializeExport.SerialSize(SerialSize);
}

FLoadTimeProfilerTracePrivate::FSerializeExportScope::~FSerializeExportScope()
{
    UE_TRACE_LOG(LoadTime, EndSerializeExport, LoadTimeChannel)
        << EndSerializeExport.Cycle(FPlatformTime::Cycles64());
}

FLoadTimeProfilerTracePrivate::FPostLoadExportScope::FPostLoadExportScope(const UObject* Object)
{
    UE_TRACE_LOG(LoadTime, BeginPostLoadExport, LoadTimeChannel)
        << BeginPostLoadExport.Cycle(FPlatformTime::Cycles64())
        << BeginPostLoadExport.Object(Object);
}

FLoadTimeProfilerTracePrivate::FPostLoadExportScope::~FPostLoadExportScope()
{
    UE_TRACE_LOG(LoadTime, EndPostLoadExport, LoadTimeChannel)
        << EndPostLoadExport.Cycle(FPlatformTime::Cycles64());
}

#endif