Files
UnrealEngineUWP/Engine/Source/Developer/Profiler/Private/ProfilerRawStatsForMemory.cpp
Ben Marsh 111ec7adc5 Copying //UE4/Dev-Core to //UE4/Dev-Main (Source: //UE4/Dev-Core @ 3314870)
#lockdown Nick.Penwarden

==========================
MAJOR FEATURES + CHANGES
==========================

Change 3284872 on 2017/02/03 by Graeme.Thornton

	Seperate pak cache granularity from pak signing chunk size

Change 3285765 on 2017/02/03 by Graeme.Thornton

	Fix stats warnings because each slate new loading screen thread has the same stat name, but is assigned to a different thread

	#jira UE-41478

Change 3286913 on 2017/02/04 by Ben.Marsh

	IncludeTool: Merging fixes.

	* Don't remove existing forward declarations unless explicitly instructed to do so. Files are optimized with these declarations in place, so removing them can cause output files to fail to build. It can be a useful separate step though, so expose it as a command-line option instead.
	* Add a specific option for which files should be output by the tool. Any files which are excluded from this list are treated specially when generating output files, so as to prevent them from causing files to be omitted from other files that include them. Also add an option to force this mode for all headers, for use when testing formatting/include path generation.

Change 3287100 on 2017/02/05 by Ben.Marsh

	UBT: Move platform settings into platform-specific TargetRules objects.

Change 3287106 on 2017/02/05 by Ben.Marsh

	Merge UEBuildPlatformContext into UEBuildPlatform. Now that targets can have platform-specific settings, there is no need to separate a platform class which contains target-specific information.

Change 3287398 on 2017/02/06 by Steve.Robb

	Fix for UHT failing when -WarningsAsErrors and -Verbose are specified together.

Change 3287399 on 2017/02/06 by Steve.Robb

	Log verbosities made more readable in the debugger.

Change 3287410 on 2017/02/06 by Steve.Robb

	Fix for TStructOpsTypeTraits where WithCopy gives a different result between specializing the traits and not providing WithCopy and not specializing the traits at all.

	#fyi marc.audy

Change 3288020 on 2017/02/06 by Ben.Marsh

	Prevent forward declaration of the ITextData class. We need to include the header for the debugger visualizers to work correctly.

Change 3291817 on 2017/02/08 by Steve.Robb

	New EBlueprintCompileReinstancerFlags used to construct FBlueprintCompileReinstancer, instead of lots of bools.

Change 3292090 on 2017/02/08 by Graeme.Thornton

	Crash fix - don't update font engine services if it was never created

	#jira UE-33953

Change 3292993 on 2017/02/08 by Ben.Marsh

	Add an option to disable force-including PCHs for files in the non-unity working set. (bAdaptiveUnityDisablesPCH)

Change 3293231 on 2017/02/08 by Ben.Marsh

	BuildGraph: Allow overriding the changelist that a badge should be displayed for (with the Change="" attribute on the Badge declaration in XML), so the code changelist can be used if necessary. Also link to the failed step if only one has failed.

Change 3294213 on 2017/02/09 by Ben.Marsh

	EC: Allow setting a property on frequent CI jobs that allows us to exclude it from job searches for generating the dashboard. Filtering on the client side is causing dashboard pages to be almost empty.

Change 3294753 on 2017/02/09 by Ben.Zeigler

	#jira UE-41151 Fix UObjectLibrary::RemoveObject to remove from the correct array, and add comment mentioning that the dynamic use of Object Library is semi-deprecated

Change 3296070 on 2017/02/09 by Ben.Zeigler

	Explicitly turn off Copy for a struct that has a linked list internally. I think turning Copy on by default for all non POD Types is pretty risky and is likely to crash for other games. In this case it was being copied for network replication, and it didn't have one defined so the default C++ one copied the linked list and crashed on destruction.

Change 3296420 on 2017/02/10 by Graeme.Thornton

	Remove remaining references to AES_KEY, instead using the encryption key delegates to access the key where needed
	Refactored encryption and signing key access in unrealpak to make it easier to use

Change 3296609 on 2017/02/10 by Ben.Marsh

	BuildGraph: Fix error running the <Copy> task with an empty "From" argument.

	* FileSystemReference.IsUnderDirectory() was not correctly handling cases where the directory was a root directory (and has to end in a path separator)
	* FilePattern.AsDirectoryReference() with an empty token would append a path separator to an empty string, resulting in it referencing the root directory rather than the given base directory.

Change 3297440 on 2017/02/10 by Ben.Marsh

	UBT: Move the FileFilter class into UnrealBuildTool.

Change 3297725 on 2017/02/10 by Ben.Zeigler

	#jira UE-39199 Fix issue with enum value redirects using the wrong short or long name, it now fully supports both.
	Clean up a lot of confusingly named and broken functions on UEnum:
	#jira UE-41348 Deprecate FindEnumIndex, GetEnum, GetEnumName, replace with GetIndexByName, GetNameByIndex, and GetNameStringByIndex and clean up warnings
	#jira UE-38187 Deprecate GetDisplayNameText and GetEnumText, replaced both with GetDisplayNameTextAtIndex which is now callable outside the editor and has a better comment
	Deprecate FindEnumRedirects and replace with GetIndexByNameString. Fix code to not check the redirects array 5 times per enum lookup
	Fix GetValueAsString to actually act on a value, not an index. This matches common usage and the function's name
	While fixing deprecation warnings on internal games, fixed dozens of cases where it was using Index functions when it should have been using Value functions
	Delete some now redundant enum editor code and pipe everything through UEnum

Change 3297979 on 2017/02/10 by Ben.Zeigler

	Fix issues parsing Enums that are literally the string "None", which is allowed but leads to some odd behavior

Change 3298299 on 2017/02/10 by Steve.Robb

	TTuple improvements:
	- equality comparable
	- serializable
	- in the correct folder

	2-tuples are specialized to be syntactically compatible with both TPair and TTuple.
	TPair is now an alias for a 2-tuple and is no longer bound to TPairInitializer.

	#fyi robert.manuszewski,ben.marsh

Change 3298460 on 2017/02/11 by Ben.Marsh

	UGS: Set the correct result from running custom tasks.

Change 3298462 on 2017/02/11 by Ben.Marsh

	UBT: Fix some deprecated messages that have the wrong release version, and add a better message for how ModuleRules constructors need to be updated.

Change 3299447 on 2017/02/13 by Graeme.Thornton

	Fix AES and pak signing key embedding for content only projects
	 - Force temp target when any keys are specified by project config

Change 3299649 on 2017/02/13 by Steve.Robb

	PLATFORM_HAS_DEFAULTED_OPERATORS fixed.
	Other obsolete compiler switches removed.

Change 3299787 on 2017/02/13 by Steve.Robb

	IsAbstract() for testing if a reflected native type contains pure virtual functions.  Needed for BP nativization.

	#fyi robert.manuszewski

Change 3300576 on 2017/02/13 by Ben.Marsh

	EC: Add support for starting builds on any agent type. Mapping from agent types to resource pools is stored in an EC property sheet (/Generated/<Stream>/AgentTypes), allowing EC procedures to map it to a resource pool from a parameter.

Change 3300600 on 2017/02/13 by Ben.Marsh

	EC: Add the -ClearHistory argument to UAT run to export BuildGraph settings, to allow running on incremental workspaces.

Change 3300624 on 2017/02/13 by Ben.Marsh

	Switch incremental builds for all streams to start up on the incremental agent.

Change 3302134 on 2017/02/14 by Steve.Robb

	UnrealCodeAnalyzer removed.

	#fyi ben.marsh,robert.manuszewski

Change 3302639 on 2017/02/14 by Ben.Zeigler

	Fix crash cooking odin with default command line
	#jira UE-41952 Delete StealthTeleport map that crashes on load, and update default cook list that gets used if nothing specified

Change 3303002 on 2017/02/14 by Ben.Zeigler

	#jira UE-41061 Fix it so editor only filtering on savepackage is uniformly applied regardless of if it's at package or object level
	#jira UE-41880 Rewrite editor/client/server only filtering logic in SavePackage to fix various bugs. It now does all of the filtering up front, and won't process any filtered objects for imports or exports
	Rename NotForEditorGame to NotAlwaysLoadedForEditorGame and improve comments, this flag says that the asset should be loaded EVEN IF it is editor only, it does not affect loading for normal objects
	Change the non-map cook flags to RF_Public instead of RF_Standalone. Blueprint classes aren't RF_Standalone so were only being cooked before due to an accident of the dependency checker
	Change it so anything with a Transient outer is marked transient at save time. These objects would not save out properly anyway
	Fix it so -cooksinglepackage works properly again and excludes localization and startup packages
	Tested with Fortnite and Odin, Odin works but with lots of warnings with nativization on which I need to investigate

Change 3303084 on 2017/02/14 by Ben.Zeigler

	Attempt to get Nativization and EDL working without warnings

	Change 3305153 on 2017/02/15 by Ben.Zeigler

	Fix Fortnite and Orion cook, I don't understand why this passed my local testing
	Fix the CDO subobject finder to actually return things instead of doing nothing, and fix a shadow variable warning

Change 3305959 on 2017/02/16 by Gil.Gribb

	UE4 - Tweaked out the EDL loader for the switch with benefits to all platforms.

Change 3306159 on 2017/02/16 by Ben.Marsh

	Fix path to target binaries when building non-monolithic in a unique build environment.

Change 3306584 on 2017/02/16 by Steve.Robb

	UEnum internal functions renamed from Index to Value.
	GetValueAsString_Internal() parameter now takes an int64, as is expected for enum values.

	#fyi ben.zeigler

Change 3307836 on 2017/02/16 by Ben.Zeigler

	#jira UE-42055 Load very old redirects in cooked builds. Matinee has no way of resaving redirects, so as long as matinee exists we need to keep them around forever, or fix matinee manually
	Fixes lighting in Infiltrator demo

Change 3307929 on 2017/02/16 by Ben.Zeigler

	#jira UE-42055 Second half of matinee redirector fix

Change 3308840 on 2017/02/17 by Matthew.Griffin

	Reimplementing CL#3305808 from 4.15

		Changed QA label build process so that it only allows version with 3 components (we always add the .0 for initial releases)

Change 3309115 on 2017/02/17 by Ben.Marsh

	Windows: Fix the GetModulesDirectory() function always returning the engine binaries directory. It's possible to build non-monolithic targets which output all engine binaries to the game binaries directory - a requirement to being able to set game-specific defines or build settings, because we don't want shared engine binaries to be tainted with them. The module manager needs to be able to operate early on,  before many of the game settings have been initialized, so just return the directory containing the Core module instead.

Change 3309120 on 2017/02/17 by Ben.Marsh

	Fix support for creating modular builds which don't use the shared build environment.

Change 3309125 on 2017/02/17 by Ben.Marsh

	Require that -CookDir arguments are specified separately on the command line. '+' is a valid path character (and common in build versions), so we shouldn't treat it as an argument separator.

Change 3309128 on 2017/02/17 by Ben.Marsh

	Fix UnrealPak failures when enumerating all files from a source directory, if that directory happens to contain spaces.

Change 3309131 on 2017/02/17 by Ben.Marsh

	Fix list of discovered assets being cleared by second call to FindFilesRecursive() when building DDC. Disable the -cookdir parameter again.

Change 3309140 on 2017/02/17 by Ben.Marsh

	UAT: Fix exception moving a file from one location to another if the target directory does not exist.

Change 3309212 on 2017/02/17 by Ben.Marsh

	Fixes/improvements for mod editor and code mods:

	* A separate top-level project is generated for each code mod in the Visual Studio solution.
	* Plugin descriptors now have a flag to identify themselves as mod as opposed to a regular game plugin, which prevents project plugins from getting their own VS project. New mods created with the mod editor will have this set by default, as do the three existing sample mods.
	* Cleaning and building code mods will never modify engine binaries. Presence of the Engine/Build/InstalledProjectBuild.txt file is used to indicate running in this environment. This flag also disables options to edit metadata for non-mod plugins in installed builds.
	* Plugin browser now includes a separate category for mods.
	* Mod editor now behaves as an "installed" program by default, and will use the user's home folder for storing settings.

Change 3309231 on 2017/02/17 by Steve.Robb

	Fix for Ar << bSomeBool where Ar is a derived class which overrides an operator<<.

	#jira UE-42052

Change 3309248 on 2017/02/17 by Ben.Marsh

	Add support for hot-reloading game plugin modules from Visual Studio, as long as their module returns IsGameModule() = true.

Change 3309257 on 2017/02/17 by Ben.Marsh

	Prevent game binaries from being renamed for hot reload when working with installed projects.

Change 3309355 on 2017/02/17 by Steven.Hutton

	Changes to make the website compatible with the new database changes.

Change 3309371 on 2017/02/17 by Ben.Marsh

	Fix exception on shutdown when running asset registry with threads disabled.

	#jira UE-41951

Change 3309389 on 2017/02/17 by Ben.Zeigler

	#jira UE-42051 Fix ensure and crash when loading a null asset ID via the LoadAsset BP node

Change 3309570 on 2017/02/17 by Gil.Gribb

	UE4 - Switch load time performace tweaks, plus abstracted the IO tracker and handle manager for other platforms and applied it to the PS4.

Change 3310039 on 2017/02/17 by Ben.Marsh

	BuildGraph: Prevent exception when trying to delete a file that does not exist.

Change 3311484 on 2017/02/20 by Chris.Wood

	CrashReportProcess crash add retry logic improvements (CRP v1.2.16)

Change 3311600 on 2017/02/20 by Matthew.Griffin

	Updated StripSymbols functions so that all platforms can deal with the source and target file being the same

Change 3311675 on 2017/02/20 by Steve.Robb

	FNativeClassHeaderGenerator::CurrentSourceFile stack replaced with C++ stack.

Change 3311893 on 2017/02/20 by Ben.Marsh

	UGS: Add support for notifying users if CIS steps fail for content changes. Badges which test content should be listed in the [Notifications] section of the project-specific INI file, through +ContentBadges= lines.

Change 3313966 on 2017/02/21 by Ben.Marsh

	Fix EC parsing of error messages output by the editor in the form "LogXYZ:Error:". Greedy optional subexpression in regex was matching everything until a space, so terminate a colon too.

Change 3314398 on 2017/02/21 by Ben.Zeigler

	#jira UE-42212 Fix shutdown of AnimGraph module to be safer

[CL 3315211 by Ben Marsh in Main branch]
2017-02-21 15:51:42 -05:00

886 lines
28 KiB
C++

// Copyright 1998-2017 Epic Games, Inc. All Rights Reserved.
#include "ProfilerRawStatsForMemory.h"
#include "Stats/StatsMisc.h"
#include "ProfilingDebugging/DiagnosticTable.h"
/*-----------------------------------------------------------------------------
Sort helpers
-----------------------------------------------------------------------------*/
/** Sorts allocations by size. */
struct FAllocationInfoSequenceTagLess
{
FORCEINLINE bool operator()( const FAllocationInfo& A, const FAllocationInfo& B ) const
{
return A.SequenceTag < B.SequenceTag;
}
};
/** Sorts allocations by size. */
struct FAllocationInfoSizeGreater
{
FORCEINLINE bool operator()( const FAllocationInfo& A, const FAllocationInfo& B ) const
{
return B.Size < A.Size;
}
};
/** Sorts combined allocations by size. */
struct FCombinedAllocationInfoSizeGreater
{
FORCEINLINE bool operator()( const FCombinedAllocationInfo& A, const FCombinedAllocationInfo& B ) const
{
return B.Size < A.Size;
}
};
/** Sorts node allocations by size. */
struct FNodeAllocationInfoSizeGreater
{
FORCEINLINE bool operator()( const FNodeAllocationInfo& A, const FNodeAllocationInfo& B ) const
{
return B.Size < A.Size;
}
};
/*-----------------------------------------------------------------------------
Callstack decoding/encoding
-----------------------------------------------------------------------------*/
/** Helper struct used to manipulate stats based callstacks. */
struct FStatsCallstack
{
/** Separator. */
static const TCHAR* CallstackSeparator;
/** Encodes decoded callstack a string, to be like '45+656+6565'. */
static FString Encode( const TArray<FName>& Callstack )
{
FString Result;
for (const auto& Name : Callstack)
{
Result += TTypeToString<int32>::ToString( (int32)Name.GetComparisonIndex() );
Result += CallstackSeparator;
}
return Result;
}
/** Decodes encoded callstack to an array of FNames. */
static void DecodeToNames( const FName& EncodedCallstack, TArray<FName>& out_DecodedCallstack )
{
TArray<FString> DecodedCallstack;
DecodeToStrings( EncodedCallstack, DecodedCallstack );
// Convert back to FNames
for (const auto& It : DecodedCallstack)
{
NAME_INDEX NameIndex = 0;
TTypeFromString<NAME_INDEX>::FromString( NameIndex, *It );
const FName LongName = FName( NameIndex, NameIndex, 0 );
out_DecodedCallstack.Add( LongName );
}
}
/** Converts the encoded callstack into human readable callstack. */
static FString GetHumanReadable( const FName& EncodedCallstack )
{
TArray<FName> DecodedCallstack;
DecodeToNames( EncodedCallstack, DecodedCallstack );
const FString Result = GetHumanReadable( DecodedCallstack );
return Result;
}
/** Converts the encoded callstack into human readable callstack. */
static FString GetHumanReadable( const TArray<FName>& DecodedCallstack )
{
FString Result;
const int32 NumEntries = DecodedCallstack.Num();
//for (int32 Index = DecodedCallstack.Num() - 1; Index >= 0; --Index)
for (int32 Index = 0; Index < NumEntries; ++Index)
{
const FName LongName = DecodedCallstack[Index];
const FString ShortName = FStatNameAndInfo::GetShortNameFrom( LongName ).ToString();
//const FString Group = FStatNameAndInfo::GetGroupNameFrom( LongName ).ToString();
FString Desc = FStatNameAndInfo::GetDescriptionFrom( LongName );
Desc.Trim();
if (Desc.Len() == 0)
{
Result += ShortName;
}
else
{
Result += Desc;
}
if (Index != NumEntries - 1)
{
Result += TEXT( " -> " );
}
}
Result.ReplaceInline( TEXT( "STAT_" ), TEXT( "" ), ESearchCase::CaseSensitive );
return Result;
}
protected:
/** Decodes encoded callstack to an array of strings. Where each string is the index of the FName. */
static void DecodeToStrings( const FName& EncodedCallstack, TArray<FString>& out_DecodedCallstack )
{
EncodedCallstack.ToString().ParseIntoArray( out_DecodedCallstack, CallstackSeparator, true );
}
};
const TCHAR* FStatsCallstack::CallstackSeparator = TEXT( "+" );
/*-----------------------------------------------------------------------------
Allocation info
-----------------------------------------------------------------------------*/
FAllocationInfo::FAllocationInfo( uint64 InOldPtr, uint64 InPtr, int64 InSize, const TArray<FName>& InCallstack, uint32 InSequenceTag, EMemoryOperation InOp, bool bInHasBrokenCallstack )
: OldPtr( InOldPtr )
, Ptr( InPtr )
, Size( InSize )
, EncodedCallstack( *FStatsCallstack::Encode( InCallstack ) )
, SequenceTag( InSequenceTag )
, Op( InOp )
, bHasBrokenCallstack( bInHasBrokenCallstack )
{
}
FAllocationInfo::FAllocationInfo( const FAllocationInfo& Other )
: OldPtr( Other.OldPtr )
, Ptr( Other.Ptr )
, Size( Other.Size )
, EncodedCallstack( Other.EncodedCallstack )
, SequenceTag( Other.SequenceTag )
, Op( Other.Op )
, bHasBrokenCallstack( Other.bHasBrokenCallstack )
{
}
/*-----------------------------------------------------------------------------
FNodeAllocationInfo
-----------------------------------------------------------------------------*/
void FNodeAllocationInfo::SortBySize()
{
ChildNodes.ValueSort( FNodeAllocationInfoSizeGreater() );
for (auto& It : ChildNodes)
{
It.Value->SortBySize();
}
}
void FNodeAllocationInfo::PrepareCallstackData( const TArray<FName>& InDecodedCallstack )
{
DecodedCallstack = InDecodedCallstack;
EncodedCallstack = *FStatsCallstack::Encode( DecodedCallstack );
HumanReadableCallstack = FStatsCallstack::GetHumanReadable( DecodedCallstack );
}
/*-----------------------------------------------------------------------------
FRawStatsMemoryProfiler
-----------------------------------------------------------------------------*/
FRawStatsMemoryProfiler::FRawStatsMemoryProfiler( const TCHAR* InFilename )
: FStatsReadFile( InFilename, true )
, NumDuplicatedMemoryOperations( 0 )
, NumMemoryOperations( 0 )
, LastSequenceTagForNamedMarker( 0 )
{}
void FRawStatsMemoryProfiler::PreProcessStats()
{
Super::PreProcessStats();
// Begin marker.
Snapshots.Emplace( LastSequenceTagForNamedMarker, TEXT( "BeginSnapshot" ) );
}
void FRawStatsMemoryProfiler::PostProcessStats()
{
Super::PostProcessStats();
const double StartTime = FPlatformTime::Seconds();
if (!IsProcessingStopped())
{
SortSequenceAllocations();
// End marker.
Snapshots.Emplace( TNumericLimits<uint32>::Max(), TEXT( "EndSnapshot" ) );
// Copy snapshots.
SnapshotsToBeProcessed = Snapshots;
UE_LOG( LogStats, Log, TEXT( "NumMemoryOperations: %i" ), NumMemoryOperations );
UE_LOG( LogStats, Log, TEXT( "SequenceAllocationNum: %i" ), SequenceAllocationArray.Num() );
GenerateAllocationMap();
DumpDebugAllocations();
}
if (!IsProcessingStopped())
{
StageProgress.Set( 100 );
const double TotalTime = FPlatformTime::Seconds() - StartTime;
UE_LOG( LogStats, Log, TEXT( "Post-Processing took %.2f sec(s)" ), TotalTime );
}
else
{
UE_LOG( LogStats, Warning, TEXT( "Post-Processing stopped, abandoning" ) );
}
}
void FRawStatsMemoryProfiler::DumpDebugAllocations()
{
#if UE_BUILD_DEBUG
// Dump problematic allocations
DuplicatedAllocMap.ValueSort( FAllocationInfoSizeGreater() );
uint64 TotalDuplicatedMemory = 0;
for (const auto& It : DuplicatedAllocMap)
{
const FAllocationInfo& Alloc = It.Value;
TotalDuplicatedMemory += Alloc.Size;
}
UE_LOG( LogStats, Warning, TEXT( "Dumping duplicated alloc map" ) );
UE_LOG( LogStats, Warning, TEXT( "TotalDuplicatedMemory: %llu bytes (%.2f MB)" ), TotalDuplicatedMemory, TotalDuplicatedMemory / 1024.0f / 1024.0f );
const float MaxPctDisplayed = 0.9f;
uint64 DisplayedSoFar = 0;
for (const auto& It : DuplicatedAllocMap)
{
const FAllocationInfo& Alloc = It.Value;
const FString& AllocCallstack = It.Key;
UE_LOG( LogStats, Log, TEXT( "%lli (%.2f MB) %s" ), Alloc.Size, Alloc.Size / 1024.0f / 1024.0f, *AllocCallstack );
DisplayedSoFar += Alloc.Size;
const float CurrentPct = (float)DisplayedSoFar / (float)TotalDuplicatedMemory;
if (CurrentPct > MaxPctDisplayed)
{
break;
}
}
#endif // UE_BUILD_DEBUG
}
void FRawStatsMemoryProfiler::FreeDebugInformation()
{
DuplicatedAllocMap.Empty();
ZeroAllocMap.Empty();
}
void FRawStatsMemoryProfiler::GenerateAllocationMap()
{
/** Map of currently alive allocations. Ptr to AllocationInfo. */
TMap<uint64, FAllocationInfo> AllocationMap;
// Initialize the begin snapshot.
auto BeginSnapshot = SnapshotsToBeProcessed[0];
SnapshotsToBeProcessed.RemoveAt( 0 );
PrepareSnapshot( BeginSnapshot.Value, AllocationMap );
auto CurrentSnapshot = SnapshotsToBeProcessed[0];
UE_LOG( LogStats, Log, TEXT( "Generating memory operations map" ) );
const int32 NumSequenceAllocations = SequenceAllocationArray.Num();
const int32 OnePercent = FMath::Max( NumSequenceAllocations / 100, 1024 );
for (int32 AllocationIndex = 0; AllocationIndex < NumSequenceAllocations; AllocationIndex++)
{
if (AllocationIndex % OnePercent == 0)
{
UpdateGenerateMemoryMapProgress( AllocationIndex );
if (IsProcessingStopped())
{
break;
}
}
const FAllocationInfo& Alloc = SequenceAllocationArray[AllocationIndex];
// Check named marker/snapshots
if (Alloc.SequenceTag > CurrentSnapshot.Key)
{
SnapshotsToBeProcessed.RemoveAt( 0 );
PrepareSnapshot( CurrentSnapshot.Value, AllocationMap );
CurrentSnapshot = SnapshotsToBeProcessed[0];
}
if (Alloc.Op == EMemoryOperation::Alloc)
{
ProcessAlloc( Alloc, AllocationMap );
}
else if (Alloc.Op == EMemoryOperation::Realloc)
{
// Previous Alloc or Realloc
if (Alloc.OldPtr != 0)
{
ProcessFree( Alloc, AllocationMap, true );
}
#if UE_BUILD_DEBUG
if (Alloc.OldPtr == 0 && Alloc.Size == 0)
{
const FString ReallocCallstack = FStatsCallstack::GetHumanReadable( Alloc.EncodedCallstack );
UE_LOG( LogStats, VeryVerbose, TEXT( "ReallocZero: %s %i %i/%i [%i]" ), *ReallocCallstack, Alloc.Size, Alloc.OldPtr, Alloc.Ptr, Alloc.SequenceTag );
}
#endif // UE_BUILD_DEBUG
if (Alloc.Ptr != 0)
{
ProcessAlloc( Alloc, AllocationMap );
}
}
else if (Alloc.Op == EMemoryOperation::Free)
{
ProcessFree( Alloc, AllocationMap, false );
}
}
auto EndSnapshot = SnapshotsToBeProcessed[0];
SnapshotsToBeProcessed.RemoveAt( 0 );
PrepareSnapshot( EndSnapshot.Value, AllocationMap );
// We don't need the allocation map. Each snapshot has its own copy.
AllocationMap.Empty();
SnapshotNamesArray = SnapshotNamesSet.Array();
UE_LOG( LogStats, Verbose, TEXT( "NumDuplicatedMemoryOperations: %i" ), NumDuplicatedMemoryOperations );
UE_LOG( LogStats, Verbose, TEXT( "NumZeroAllocs: %i" ), NumZeroAllocs );
}
void FRawStatsMemoryProfiler::ProcessAlloc( const FAllocationInfo& AllocInfo, TMap<uint64, FAllocationInfo>& AllocationMap )
{
if( AllocInfo.Size == 0 )
{
NumZeroAllocs++;
ZeroAllocMap.Add( FStatsCallstack::GetHumanReadable( AllocInfo.EncodedCallstack ), AllocInfo );
}
const FAllocationInfo* Found = AllocationMap.Find( AllocInfo.Ptr );
if (!Found)
{
AllocationMap.Add( AllocInfo.Ptr, AllocInfo );
}
else
{
NumDuplicatedMemoryOperations++;
#if UE_BUILD_DEBUG
const FString FoundCallstack = FStatsCallstack::GetHumanReadable( Found->EncodedCallstack );
const FString AllocCallstack = FStatsCallstack::GetHumanReadable( AllocInfo.EncodedCallstack );
UE_LOG( LogStats, VeryVerbose, TEXT( "DuplicatedAlloc" ) );
UE_LOG( LogStats, VeryVerbose, TEXT( "FoundCallstack: %s [%s]" ), *FoundCallstack, Found->Op==EMemoryOperation::Alloc ? TEXT("Alloc") : TEXT("Realloc") );
UE_LOG( LogStats, VeryVerbose, TEXT( "AllocCallstack: %s [%s]" ), *AllocCallstack, AllocInfo.Op==EMemoryOperation::Alloc ? TEXT("Alloc") : TEXT("Realloc") );
UE_LOG( LogStats, VeryVerbose, TEXT( "Size: %i/%i Ptr: %llu/%llu Tag: %i/%i" ), Found->Size, AllocInfo.Size, Found->Ptr, AllocInfo.Ptr, Found->SequenceTag, AllocInfo.SequenceTag );
// Store the old pointer.
DuplicatedAllocMap.Add( FoundCallstack, *Found );
#endif // UE_BUILD_DEBUG
// Replace pointer.
AllocationMap.Add( AllocInfo.Ptr, AllocInfo );
}
}
void FRawStatsMemoryProfiler::ProcessFree( const FAllocationInfo& FreeInfo, TMap<uint64, FAllocationInfo>& AllocationMap, const bool bReallocFree )
{
// bReallocFree is not needed here, but it's easier to read the code.
const uint64 PtrToBeFreed = bReallocFree ? FreeInfo.OldPtr : FreeInfo.Ptr;
const FAllocationInfo* Found = AllocationMap.Find( PtrToBeFreed );
if (Found)
{
const bool bIsValid = FreeInfo.SequenceTag > Found->SequenceTag;
if (!bIsValid)
{
UE_LOG( LogStats, Warning, TEXT( "InvalidFree Ptr: %llu, Seq: %i/%i" ), PtrToBeFreed, FreeInfo.SequenceTag, Found->SequenceTag );
}
AllocationMap.Remove( PtrToBeFreed );
}
else
{
#if UE_BUILD_DEBUG
const FString FWACallstack = FStatsCallstack::GetHumanReadable( FreeInfo.EncodedCallstack );
UE_LOG( LogStats, VeryVerbose, TEXT( "FreeWithoutAlloc: %s, %llu" ), *FWACallstack, PtrToBeFreed );
#endif // UE_BUILD_DEBUG
}
}
void FRawStatsMemoryProfiler::UpdateGenerateMemoryMapProgress( const int32 AllocationIndex )
{
const double CurrentSeconds = FPlatformTime::Seconds();
if (CurrentSeconds > LastUpdateTime + NumSecondsBetweenUpdates)
{
const int32 PercentagePos = int32( 100.0*AllocationIndex / SequenceAllocationArray.Num() );
StageProgress.Set( PercentagePos );
UE_LOG( LogStats, Verbose, TEXT( "Processing allocations %3i%% (%10i/%10i)" ), PercentagePos, AllocationIndex, SequenceAllocationArray.Num() );
LastUpdateTime = CurrentSeconds;
}
// Abandon support.
if (bShouldStopProcessing == true)
{
SetProcessingStage( EStatsProcessingStage::SPS_Stopped );
}
}
void FRawStatsMemoryProfiler::ProcessSpecialMessageMarkerOperation( const FStatMessage& Message, const FStackState& StackState )
{
const FName RawName = Message.NameAndInfo.GetRawName();
if (RawName == FStatConstants::RAW_NamedMarker)
{
const FName NamedMarker = Message.GetValue_FName();
Snapshots.Emplace( LastSequenceTagForNamedMarker, NamedMarker );
}
}
void FRawStatsMemoryProfiler::ProcessMemoryOperation( EMemoryOperation MemOp, uint64 Ptr, uint64 NewPtr, int64 Size, uint32 SequenceTag, const FStackState& StackState )
{
if (MemOp == EMemoryOperation::Alloc)
{
NumMemoryOperations++;
// Add a new allocation.
SequenceAllocationArray.Add(
FAllocationInfo(
0,
Ptr,
Size,
StackState.Stack,
SequenceTag,
EMemoryOperation::Alloc,
StackState.bIsBrokenCallstack
) );
LastSequenceTagForNamedMarker = SequenceTag;
}
else if (MemOp == EMemoryOperation::Realloc)
{
NumMemoryOperations++;
const uint64 OldPtr = Ptr;
// Add a new realloc.
SequenceAllocationArray.Add(
FAllocationInfo(
OldPtr,
NewPtr,
Size,
StackState.Stack,
SequenceTag,
EMemoryOperation::Realloc,
StackState.bIsBrokenCallstack
) );
LastSequenceTagForNamedMarker = SequenceTag;
}
else if (MemOp == EMemoryOperation::Free)
{
NumMemoryOperations++;
// Add a new free.
SequenceAllocationArray.Add(
FAllocationInfo(
0,
Ptr,
0,
StackState.Stack,
SequenceTag,
EMemoryOperation::Free,
StackState.bIsBrokenCallstack
) );
}
}
void FRawStatsMemoryProfiler::SortSequenceAllocations()
{
FScopeLogTime SLT( TEXT( "SortSequenceAllocations" ), nullptr, FScopeLogTime::ScopeLog_Milliseconds );
// Sort all memory operation by the sequence tag, iterate through all operation and generate memory usage.
SequenceAllocationArray.Sort( FAllocationInfoSequenceTagLess() );
// Abandon support.
if (bShouldStopProcessing == true)
{
SetProcessingStage( EStatsProcessingStage::SPS_Stopped );
}
}
void FRawStatsMemoryProfiler::GenerateScopedTreeAllocations( const TMap<FName, FCombinedAllocationInfo>& ScopedAllocations, FNodeAllocationInfo& out_Root )
{
FScopeLogTime SLT( TEXT( "GenerateScopedTreeAllocations" ), nullptr, FScopeLogTime::ScopeLog_Milliseconds );
// Decode all scoped allocations, generate tree for allocations and combine them.
for (const auto& It : ScopedAllocations)
{
const FName& EncodedCallstack = It.Key;
const FCombinedAllocationInfo& CombinedAllocation = It.Value;
// Decode callstack.
TArray<FName> DecodedCallstack;
FStatsCallstack::DecodeToNames( EncodedCallstack, DecodedCallstack );
const int32 AllocationLenght = DecodedCallstack.Num();
check( DecodedCallstack.Num() > 0 );
FNodeAllocationInfo* CurrentNode = &out_Root;
// Accumulate with thread root node.
CurrentNode->Accumulate( CombinedAllocation );
// Iterate through the callstack and prepare all nodes if needed, and accumulate memory.
TArray<FName> CurrentCallstack;
const int32 NumEntries = DecodedCallstack.Num();
for (int32 Idx1 = 0; Idx1 < NumEntries; ++Idx1)
{
const FName NodeName = DecodedCallstack[Idx1];
CurrentCallstack.Add( NodeName );
FNodeAllocationInfo* Node = nullptr;
const bool bContainsNode = CurrentNode->ChildNodes.Contains( NodeName );
if (!bContainsNode)
{
Node = new FNodeAllocationInfo;
Node->Depth = Idx1;
Node->PrepareCallstackData( CurrentCallstack );
CurrentNode->ChildNodes.Add( NodeName, Node );
}
else
{
Node = CurrentNode->ChildNodes.FindChecked( NodeName );
}
// Accumulate memory usage and num allocations for all nodes in the callstack.
Node->Accumulate( CombinedAllocation );
// Move to the next node.
Node->Parent = CurrentNode;
CurrentNode = Node;
}
}
out_Root.SortBySize();
}
void FRawStatsMemoryProfiler::ProcessAndDumpUObjectAllocations( const FName SnapshotName )
{
if (!SnapshotsWithAllocationMap.Contains(SnapshotName))
{
UE_LOG( LogStats, Warning, TEXT( "Snapshot not found: %s" ), *SnapshotName.ToString() );
return;
}
const TMap<uint64, FAllocationInfo>& AllocationMap = SnapshotsWithAllocationMap.FindChecked( SnapshotName );
FScopeLogTime SLT( TEXT( "ProcessingUObjectAllocations" ), nullptr, FScopeLogTime::ScopeLog_Seconds );
UE_LOG( LogStats, Warning, TEXT( "Processing UObject allocations" ) );
const FString ReportName = FString::Printf( TEXT( "%s-Memory-UObject" ), *GetPlatformName() );
FDiagnosticTableViewer MemoryReport( *FDiagnosticTableViewer::GetUniqueTemporaryFilePath( *ReportName ), true );
// Write a row of headings for the table's columns.
MemoryReport.AddColumn( TEXT( "Size (bytes)" ) );
MemoryReport.AddColumn( TEXT( "Size (MB)" ) );
MemoryReport.AddColumn( TEXT( "Count" ) );
MemoryReport.AddColumn( TEXT( "UObject class" ) );
MemoryReport.CycleRow();
TMap<FName, FCombinedAllocationInfo> UObjectAllocations;
// To minimize number of calls to expensive DecodeCallstack.
TMap<FName, FName> UObjectCallstackToClassMapping;
uint64 NumAllocations = 0;
uint64 TotalAllocatedMemory = 0;
for (const auto& It : AllocationMap)
{
const FAllocationInfo& Alloc = It.Value;
FName UObjectClass = UObjectCallstackToClassMapping.FindRef( Alloc.EncodedCallstack );
if (UObjectClass == NAME_None)
{
TArray<FName> DecodedCallstack;
FStatsCallstack::DecodeToNames( Alloc.EncodedCallstack, DecodedCallstack );
for (int32 Index = DecodedCallstack.Num() - 1; Index >= 0; --Index)
{
const FName LongName = DecodedCallstack[Index];
const bool bValid = UObjectRawNames.Contains( LongName );
if (bValid)
{
const FString ObjectName = FStatNameAndInfo::GetShortNameFrom( LongName ).GetPlainNameString();
UObjectClass = *ObjectName.Left( ObjectName.Find( TEXT( "//" ) ) );;
UObjectCallstackToClassMapping.Add( Alloc.EncodedCallstack, UObjectClass );
break;
}
}
}
if (UObjectClass != NAME_None)
{
FCombinedAllocationInfo& CombinedAllocation = UObjectAllocations.FindOrAdd( UObjectClass );
CombinedAllocation += Alloc;
TotalAllocatedMemory += Alloc.Size;
NumAllocations++;
}
}
// Dump memory to the log.
UObjectAllocations.ValueSort( FCombinedAllocationInfoSizeGreater() );
const float MaxPctDisplayed = 0.90f;
int32 CurrentIndex = 0;
uint64 DisplayedSoFar = 0;
UE_LOG( LogStats, VeryVerbose, TEXT( "Index, Size (Size MB), Count, UObject class" ) );
for (const auto& It : UObjectAllocations)
{
const FCombinedAllocationInfo& CombinedAllocation = It.Value;
const FName& UObjectClass = It.Key;
UE_LOG( LogStats, VeryVerbose, TEXT( "%2i, %llu (%.2f MB), %llu, %s" ),
CurrentIndex,
CombinedAllocation.Size,
CombinedAllocation.Size / 1024.0f / 1024.0f,
CombinedAllocation.Count,
*UObjectClass.GetPlainNameString() );
// Dump stats
MemoryReport.AddColumn( TEXT( "%llu" ), CombinedAllocation.Size );
MemoryReport.AddColumn( TEXT( "%.2f MB" ), CombinedAllocation.Size / 1024.0f / 1024.0f );
MemoryReport.AddColumn( TEXT( "%llu" ), CombinedAllocation.Count );
MemoryReport.AddColumn( *UObjectClass.GetPlainNameString() );
MemoryReport.CycleRow();
CurrentIndex++;
DisplayedSoFar += CombinedAllocation.Size;
const float CurrentPct = (float)DisplayedSoFar / (float)TotalAllocatedMemory;
if (CurrentPct > MaxPctDisplayed)
{
break;
}
}
UE_LOG( LogStats, VeryVerbose, TEXT( "Allocated memory: %llu bytes (%.2f MB)" ), TotalAllocatedMemory, TotalAllocatedMemory / 1024.0f / 1024.0f );
// Add a total row.
MemoryReport.CycleRow();
MemoryReport.CycleRow();
MemoryReport.CycleRow();
MemoryReport.AddColumn( TEXT( "%llu" ), TotalAllocatedMemory );
MemoryReport.AddColumn( TEXT( "%.2f MB" ), TotalAllocatedMemory / 1024.0f / 1024.0f );
MemoryReport.AddColumn( TEXT( "%llu" ), NumAllocations );
MemoryReport.AddColumn( TEXT( "TOTAL" ) );
MemoryReport.CycleRow();
}
void FRawStatsMemoryProfiler::DumpScopedAllocations( const TCHAR* Name, const TMap<FString, FCombinedAllocationInfo>& CombinedAllocations )
{
if (CombinedAllocations.Num() == 0)
{
UE_LOG( LogStats, Warning, TEXT( "No scoped allocations: %s" ), Name );
return;
}
FScopeLogTime SLT( TEXT( "ProcessingScopedAllocations" ), nullptr, FScopeLogTime::ScopeLog_Seconds );
UE_LOG( LogStats, Warning, TEXT( "Dumping scoped allocations: %s" ), Name );
const FString ReportName = FString::Printf( TEXT( "%s-Memory-Scoped-%s" ), *GetPlatformName(), Name );
FDiagnosticTableViewer MemoryReport( *FDiagnosticTableViewer::GetUniqueTemporaryFilePath( *ReportName ), true );
// Write a row of headings for the table's columns.
MemoryReport.AddColumn( TEXT( "Size (bytes)" ) );
MemoryReport.AddColumn( TEXT( "Size (MB)" ) );
MemoryReport.AddColumn( TEXT( "Count" ) );
MemoryReport.AddColumn( TEXT( "Callstack" ) );
MemoryReport.CycleRow();
FCombinedAllocationInfo Total;
const float MaxPctDisplayed = 0.90f;
int32 CurrentIndex = 0;
UE_LOG( LogStats, VeryVerbose, TEXT( "Index, Size (Size MB), Count, Stat desc" ) );
for (const auto& It : CombinedAllocations)
{
const FCombinedAllocationInfo& CombinedAllocation = It.Value;
//const FName& EncodedCallstack = It.Key;
const FString AllocCallstack = It.Key;// GetCallstack( EncodedCallstack );
UE_LOG( LogStats, VeryVerbose, TEXT( "%2i, %llu (%.2f MB), %llu, %s" ),
CurrentIndex,
CombinedAllocation.Size,
CombinedAllocation.Size / 1024.0f / 1024.0f,
CombinedAllocation.Count,
*AllocCallstack );
// Dump stats
MemoryReport.AddColumn( TEXT( "%llu" ), CombinedAllocation.Size );
MemoryReport.AddColumn( TEXT( "%.2f MB" ), CombinedAllocation.Size / 1024.0f / 1024.0f );
MemoryReport.AddColumn( TEXT( "%llu" ), CombinedAllocation.Count );
MemoryReport.AddColumn( *AllocCallstack );
MemoryReport.CycleRow();
CurrentIndex++;
Total += CombinedAllocation;
}
UE_LOG( LogStats, VeryVerbose, TEXT( "Allocated memory: %llu bytes (%.2f MB)" ), Total.Size, Total.SizeMB );
// Add a total row.
MemoryReport.CycleRow();
MemoryReport.CycleRow();
MemoryReport.CycleRow();
MemoryReport.AddColumn( TEXT( "%llu" ), Total.Size );
MemoryReport.AddColumn( TEXT( "%.2f MB" ), Total.SizeMB );
MemoryReport.AddColumn( TEXT( "%llu" ), Total.Count );
MemoryReport.AddColumn( TEXT( "TOTAL" ) );
MemoryReport.CycleRow();
}
void FRawStatsMemoryProfiler::GenerateScopedAllocations( const TMap<uint64, FAllocationInfo>& InAllocationMap, TMap<FName, FCombinedAllocationInfo>& out_CombinedAllocations, uint64& TotalAllocatedMemory, uint64& NumAllocations )
{
FScopeLogTime SLT( TEXT( "GenerateScopedAllocations" ), nullptr, FScopeLogTime::ScopeLog_Milliseconds );
for (const auto& It : InAllocationMap)
{
const FAllocationInfo& Alloc = It.Value;
FCombinedAllocationInfo& CombinedAllocation = out_CombinedAllocations.FindOrAdd( Alloc.EncodedCallstack );
CombinedAllocation += Alloc;
TotalAllocatedMemory += Alloc.Size;
NumAllocations++;
}
// Sort by size.
out_CombinedAllocations.ValueSort( FCombinedAllocationInfoSizeGreater() );
}
void FRawStatsMemoryProfiler::PrepareSnapshot( const FName SnapshotName, const TMap<uint64, FAllocationInfo>& InAllocationMap )
{
FScopeLogTime SLT( TEXT( "PrepareSnapshot" ), nullptr, FScopeLogTime::ScopeLog_Milliseconds );
// Make sure the snapshot name is unique.
FName UniqueSnapshotName = SnapshotName;
while (SnapshotNamesSet.Contains( UniqueSnapshotName ))
{
UniqueSnapshotName = FName( UniqueSnapshotName, UniqueSnapshotName.GetNumber() + 1 );
}
SnapshotNamesSet.Add( UniqueSnapshotName );
SnapshotsWithAllocationMap.Add( UniqueSnapshotName, InAllocationMap );
TMap<FName, FCombinedAllocationInfo> SnapshotCombinedAllocations;
uint64 TotalAllocatedMemory = 0;
uint64 NumAllocations = 0;
GenerateScopedAllocations( InAllocationMap, SnapshotCombinedAllocations, TotalAllocatedMemory, NumAllocations );
SnapshotsWithScopedAllocations.Add( UniqueSnapshotName, SnapshotCombinedAllocations );
// Decode callstacks.
// Replace encoded callstacks with human readable name. For easier debugging.
TMap<FString, FCombinedAllocationInfo> SnapshotDecodedCombinedAllocations;
for (auto& It : SnapshotCombinedAllocations)
{
const FString HumanReadableCallstack = FStatsCallstack::GetHumanReadable( It.Key );
SnapshotDecodedCombinedAllocations.Add( HumanReadableCallstack, It.Value );
}
SnapshotsWithDecodedScopedAllocations.Add( UniqueSnapshotName, SnapshotDecodedCombinedAllocations );
UE_LOG( LogStats, Warning, TEXT( "PrepareSnapshot: %s Alloc: %i Scoped: %i Total: %.2f MB" ), *UniqueSnapshotName.ToString(), InAllocationMap.Num(), SnapshotCombinedAllocations.Num(), TotalAllocatedMemory / 1024.0f / 1024.0f );
}
void FRawStatsMemoryProfiler::CompareSnapshots( const FName BeginSnaphotName, const FName EndSnaphotName, TMap<FName, FCombinedAllocationInfo>& out_Result )
{
FScopeLogTime SLT( TEXT( "CompareSnapshots" ), nullptr, FScopeLogTime::ScopeLog_Milliseconds );
const auto BeginSnaphotPtr = SnapshotsWithScopedAllocations.Find( BeginSnaphotName );
const auto EndSnapshotPtr = SnapshotsWithScopedAllocations.Find( EndSnaphotName );
if (BeginSnaphotPtr && EndSnapshotPtr)
{
// Process data.
TMap<FName, FCombinedAllocationInfo> BeginSnaphot = *BeginSnaphotPtr;
TMap<FName, FCombinedAllocationInfo> EndSnaphot = *EndSnapshotPtr;
TMap<FName, FCombinedAllocationInfo> Result;
for (const auto& It : EndSnaphot)
{
const FName Callstack = It.Key;
const FCombinedAllocationInfo EndCombinedAlloc = It.Value;
const FCombinedAllocationInfo* BeginCombinedAllocPtr = BeginSnaphot.Find( Callstack );
if (BeginCombinedAllocPtr)
{
FCombinedAllocationInfo CombinedAllocation;
CombinedAllocation += EndCombinedAlloc;
CombinedAllocation -= *BeginCombinedAllocPtr;
if (CombinedAllocation.IsAlive())
{
out_Result.Add( Callstack, CombinedAllocation );
}
}
else
{
out_Result.Add( Callstack, EndCombinedAlloc );
}
}
// Sort by size.
out_Result.ValueSort( FCombinedAllocationInfoSizeGreater() );
}
}
void FRawStatsMemoryProfiler::CompareSnapshotsHumanReadable( const FName BeginSnaphotName, const FName EndSnaphotName, TMap<FString, FCombinedAllocationInfo>& out_Result )
{
FScopeLogTime SLT( TEXT( "CompareSnapshotsHumanReadable" ), nullptr, FScopeLogTime::ScopeLog_Milliseconds );
const auto BeginSnaphotPtr = SnapshotsWithDecodedScopedAllocations.Find( BeginSnaphotName );
const auto EndSnapshotPtr = SnapshotsWithDecodedScopedAllocations.Find( EndSnaphotName );
if (BeginSnaphotPtr && EndSnapshotPtr)
{
// Process data.
TMap<FString, FCombinedAllocationInfo> BeginSnaphot = *BeginSnaphotPtr;
TMap<FString, FCombinedAllocationInfo> EndSnaphot = *EndSnapshotPtr;
for (const auto& It : EndSnaphot)
{
const FString& Callstack = It.Key;
const FCombinedAllocationInfo EndCombinedAlloc = It.Value;
const FCombinedAllocationInfo* BeginCombinedAllocPtr = BeginSnaphot.Find( Callstack );
if (BeginCombinedAllocPtr)
{
FCombinedAllocationInfo CombinedAllocation;
CombinedAllocation += EndCombinedAlloc;
CombinedAllocation -= *BeginCombinedAllocPtr;
if (CombinedAllocation.IsAlive())
{
out_Result.Add( Callstack, CombinedAllocation );
}
}
else
{
out_Result.Add( Callstack, EndCombinedAlloc );
}
}
// Sort by size.
out_Result.ValueSort( FCombinedAllocationInfoSizeGreater() );
}
}