Files
UnrealEngineUWP/Engine/Source/Programs/CrashReporter/CrashReportClient/Private/CrashDescription.cpp
Ben Marsh 4ba423868f Copying //UE4/Dev-Build to //UE4/Dev-Main (Source: //UE4/Dev-Build @ 3209340)
#lockdown Nick.Penwarden
#rb none

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

Change 3209340 on 2016/11/23 by Ben.Marsh

	Convert UE4 codebase to an "include what you use" model - where every header just includes the dependencies it needs, rather than every source file including large monolithic headers like Engine.h and UnrealEd.h.

	Measured full rebuild times around 2x faster using XGE on Windows, and improvements of 25% or more for incremental builds and full rebuilds on most other platforms.

	  * Every header now includes everything it needs to compile.
	        * There's a CoreMinimal.h header that gets you a set of ubiquitous types from Core (eg. FString, FName, TArray, FVector, etc...). Most headers now include this first.
	        * There's a CoreTypes.h header that sets up primitive UE4 types and build macros (int32, PLATFORM_WIN64, etc...). All headers in Core include this first, as does CoreMinimal.h.
	  * Every .cpp file includes its matching .h file first.
	        * This helps validate that each header is including everything it needs to compile.
	  * No engine code includes a monolithic header such as Engine.h or UnrealEd.h any more.
	        * You will get a warning if you try to include one of these from the engine. They still exist for compatibility with game projects and do not produce warnings when included there.
	        * There have only been minor changes to our internal games down to accommodate these changes. The intent is for this to be as seamless as possible.
	  * No engine code explicitly includes a precompiled header any more.
	        * We still use PCHs, but they're force-included on the compiler command line by UnrealBuildTool instead. This lets us tune what they contain without breaking any existing include dependencies.
	        * PCHs are generated by a tool to get a statistical amount of coverage for the source files using it, and I've seeded the new shared PCHs to contain any header included by > 15% of source files.

	Tool used to generate this transform is at Engine\Source\Programs\IncludeTool.

[CL 3209342 by Ben Marsh in Main branch]
2016-11-23 15:48:37 -05:00

497 lines
17 KiB
C++

// Copyright 1998-2016 Epic Games, Inc. All Rights Reserved.
#include "CrashDescription.h"
#include "Misc/DateTime.h"
#include "HAL/PlatformProcess.h"
#include "Misc/Paths.h"
#include "Misc/Guid.h"
#include "CrashReportClientConfig.h"
#include "CrashReportAnalytics.h"
#include "AnalyticsEventAttribute.h"
#include "IAnalyticsProviderET.h"
#include "Misc/EngineBuildSettings.h"
#include "QoSReporter.h"
// #CrashReport: 2015-07-23 Move crashes from C:\Users\[USER]\AppData\Local\Microsoft\Windows\WER\ReportQueue to C:\Users\[USER]\AppData\Local\CrashReportClient\Saved
/*-----------------------------------------------------------------------------
FCrashProperty
-----------------------------------------------------------------------------*/
FCrashProperty::FCrashProperty( const FString& InMainCategory, const FString& InSecondCategory, FPrimaryCrashProperties* InOwner )
: Owner( InOwner )
, CachedValue( TEXT("") )
, MainCategory( InMainCategory )
, SecondCategory( InSecondCategory )
, bSet( false )
{
}
FCrashProperty& FCrashProperty::operator=(const FString& NewValue)
{
bSet = true;
CachedValue = NewValue;
Owner->SetCrashProperty( MainCategory, SecondCategory, CachedValue );
return *this;
}
FCrashProperty& FCrashProperty::operator=(const TCHAR* NewValue)
{
bSet = true;
CachedValue = NewValue;
Owner->SetCrashProperty( MainCategory, SecondCategory, CachedValue );
return *this;
}
FCrashProperty& FCrashProperty::operator=(const TArray<FString>& NewValue)
{
bSet = true;
CachedValue = Owner->EncodeArrayStringAsXMLString( NewValue );
Owner->SetCrashProperty( MainCategory, SecondCategory, CachedValue );
return *this;
}
FCrashProperty& FCrashProperty::operator=(const bool NewValue)
{
bSet = true;
CachedValue = NewValue ? TEXT( "1" ) : TEXT( "0" );
Owner->SetCrashProperty( MainCategory, SecondCategory, CachedValue );
return *this;
}
FCrashProperty& FCrashProperty::operator=(const int64 NewValue)
{
bSet = true;
CachedValue = LexicalConversion::ToString( NewValue );
Owner->SetCrashProperty( MainCategory, SecondCategory, CachedValue );
return *this;
}
const FString& FCrashProperty::AsString() const
{
if (!bSet)
{
Owner->GetCrashProperty( CachedValue, MainCategory, SecondCategory );
bSet = true;
}
return CachedValue;
}
bool FCrashProperty::AsBool() const
{
return AsString().ToBool();
}
int64 FCrashProperty::AsInt64() const
{
int64 Value = 0;
TTypeFromString<int64>::FromString( Value, *AsString() );
return Value;
}
/*-----------------------------------------------------------------------------
FPrimaryCrashProperties
-----------------------------------------------------------------------------*/
FPrimaryCrashProperties* FPrimaryCrashProperties::Singleton = nullptr;
FPrimaryCrashProperties::FPrimaryCrashProperties()
// At this moment only these properties can be changed by the crash report client.
: EngineModeEx( FGenericCrashContext::RuntimePropertiesTag, TEXT("EngineModeEx"), this )
, PlatformFullName( FGenericCrashContext::RuntimePropertiesTag, TEXT( "PlatformFullName" ), this )
, CommandLine( FGenericCrashContext::RuntimePropertiesTag, TEXT( "CommandLine" ), this )
, UserName( FGenericCrashContext::RuntimePropertiesTag, TEXT("UserName"), this )
, LoginId( FGenericCrashContext::RuntimePropertiesTag, TEXT( "LoginId" ), this )
, EpicAccountId( FGenericCrashContext::RuntimePropertiesTag, TEXT( "EpicAccountId" ), this )
, GameSessionID( FGenericCrashContext::RuntimePropertiesTag, TEXT( "GameSessionID" ), this )
// Multiline properties
, CallStack( FGenericCrashContext::RuntimePropertiesTag, TEXT( "CallStack" ), this )
, SourceContext( FGenericCrashContext::RuntimePropertiesTag, TEXT( "SourceContext" ), this )
, Modules( FGenericCrashContext::RuntimePropertiesTag, TEXT( "Modules" ), this )
, UserDescription( FGenericCrashContext::RuntimePropertiesTag, TEXT( "UserDescription" ), this )
, UserActivityHint( FGenericCrashContext::RuntimePropertiesTag, TEXT( "UserActivityHint" ), this )
, ErrorMessage( FGenericCrashContext::RuntimePropertiesTag, TEXT( "ErrorMessage" ), this )
, FullCrashDumpLocation( FGenericCrashContext::RuntimePropertiesTag, TEXT( "FullCrashDumpLocation" ), this )
, TimeOfCrash( FGenericCrashContext::RuntimePropertiesTag, TEXT( "TimeOfCrash" ), this )
, bAllowToBeContacted( FGenericCrashContext::RuntimePropertiesTag, TEXT( "bAllowToBeContacted" ), this )
, CrashReporterMessage( FGenericCrashContext::RuntimePropertiesTag, TEXT( "CrashReporterMessage" ), this )
, PlatformCallbackResult(FGenericCrashContext::PlatformPropertiesTag, TEXT("PlatformCallbackResult"), this)
, CrashReportClientVersion(FGenericCrashContext::RuntimePropertiesTag, TEXT("CrashReportClientVersion"), this)
, XmlFile( nullptr )
{
CrashVersion = ECrashDescVersions::VER_1_NewCrashFormat;
CrashDumpMode = ECrashDumpMode::Default;
bHasMiniDumpFile = false;
bHasLogFile = false;
bHasPrimaryData = false;
}
void FPrimaryCrashProperties::Shutdown()
{
delete Get();
}
void FPrimaryCrashProperties::UpdateIDs()
{
const bool bAddPersonalData = FCrashReportClientConfig::Get().GetAllowToBeContacted() || FEngineBuildSettings::IsInternalBuild();
bAllowToBeContacted = bAddPersonalData;
if (bAddPersonalData)
{
// The Epic ID can be looked up from this ID.
EpicAccountId = FPlatformMisc::GetEpicAccountId();
}
else
{
EpicAccountId = FString();
}
// Add real user name only if log files were allowed since the user name is in the log file and the user consented to sending this information.
const bool bSendUserName = FCrashReportClientConfig::Get().GetSendLogFile() || FEngineBuildSettings::IsInternalBuild();
if (bSendUserName)
{
// Remove periods from user names to match AutoReporter user names
// The name prefix is read by CrashRepository.AddNewCrash in the website code
UserName = FString( FPlatformProcess::UserName() ).Replace( TEXT( "." ), TEXT( "" ) );
}
else
{
UserName = FString();
}
LoginId = FPlatformMisc::GetLoginId();
}
void FPrimaryCrashProperties::ReadXML( const FString& CrashContextFilepath )
{
XmlFilepath = CrashContextFilepath;
XmlFile = new FXmlFile( XmlFilepath );
TimeOfCrash = FDateTime::UtcNow().GetTicks();
UpdateIDs();
}
void FPrimaryCrashProperties::SetCrashGUID( const FString& Filepath )
{
FString CrashDirectory = FPaths::GetPath( Filepath );
FPaths::NormalizeDirectoryName( CrashDirectory );
// Grab the last component...
CrashGUID = FPaths::GetCleanFilename( CrashDirectory );
}
FString FPrimaryCrashProperties::EncodeArrayStringAsXMLString( const TArray<FString>& ArrayString ) const
{
const FString Encoded = FString::Join( ArrayString, TEXT("\n") );
return Encoded;
}
void FPrimaryCrashProperties::SendPreUploadAnalytics()
{
TArray<FAnalyticsEventAttribute> CrashAttributes;
MakeCrashEventAttributes(CrashAttributes);
if (FCrashReportAnalytics::IsAvailable())
{
if (bIsEnsure)
{
FCrashReportAnalytics::GetProvider().RecordEvent(TEXT("CrashReportClient.ReportEnsure"), CrashAttributes);
}
else
{
FCrashReportAnalytics::GetProvider().RecordEvent(TEXT("CrashReportClient.ReportCrash"), CrashAttributes);
}
}
// duplicate the event to QoS Reporter
if (FQoSReporter::IsAvailable())
{
if (bIsEnsure)
{
FQoSReporter::GetProvider().RecordEvent(TEXT("CrashReportClient.ReportEnsure"), CrashAttributes);
}
else
{
FQoSReporter::GetProvider().RecordEvent(TEXT("CrashReportClient.ReportCrash"), CrashAttributes);
}
}
}
void FPrimaryCrashProperties::SendPostUploadAnalytics()
{
TArray<FAnalyticsEventAttribute> CrashAttributes;
MakeCrashEventAttributes(CrashAttributes);
if (FCrashReportAnalytics::IsAvailable())
{
// Connect the crash report client analytics provider.
IAnalyticsProvider& Analytics = FCrashReportAnalytics::GetProvider();
if (bIsEnsure)
{
Analytics.RecordEvent(TEXT("CrashReportClient.ReportEnsureUploaded"), CrashAttributes);
}
else
{
Analytics.RecordEvent(TEXT("CrashReportClient.ReportCrashUploaded"), CrashAttributes);
}
}
// duplicate the event to QoS Reporter
if (FQoSReporter::IsAvailable())
{
if (bIsEnsure)
{
FQoSReporter::GetProvider().RecordEvent(TEXT("CrashReportClient.ReportEnsureUploaded"), CrashAttributes);
}
else
{
FQoSReporter::GetProvider().RecordEvent(TEXT("CrashReportClient.ReportCrashUploaded"), CrashAttributes);
}
}
}
void FPrimaryCrashProperties::MakeCrashEventAttributes(TArray<FAnalyticsEventAttribute>& OutCrashAttributes)
{
OutCrashAttributes.Add(FAnalyticsEventAttribute(TEXT("bHasPrimaryData"), bHasPrimaryData));
OutCrashAttributes.Add(FAnalyticsEventAttribute(TEXT("CrashVersion"), (int32)CrashVersion));
OutCrashAttributes.Add(FAnalyticsEventAttribute(TEXT("CrashGUID"), CrashGUID));
OutCrashAttributes.Add(FAnalyticsEventAttribute(TEXT("PlatformCallbackResult"), PlatformCallbackResult.AsString()));
// AppID = GameName
OutCrashAttributes.Add(FAnalyticsEventAttribute(TEXT("GameName"), GameName));
// AppVersion = EngineVersion
OutCrashAttributes.Add(FAnalyticsEventAttribute(TEXT("EngineVersion"), EngineVersion.ToString()));
OutCrashAttributes.Add(FAnalyticsEventAttribute(TEXT("CrashReportClientVersion"), CrashReportClientVersion.AsString()));
// @see UpdateIDs()
OutCrashAttributes.Add(FAnalyticsEventAttribute(TEXT("LoginID"), LoginId.AsString()));
OutCrashAttributes.Add(FAnalyticsEventAttribute(TEXT("UserName"), UserName.AsString()));
OutCrashAttributes.Add(FAnalyticsEventAttribute(TEXT("EpicAccountId"), EpicAccountId.AsString()));
OutCrashAttributes.Add(FAnalyticsEventAttribute(TEXT("Platform"), PlatformFullName.AsString()));
OutCrashAttributes.Add(FAnalyticsEventAttribute(TEXT("TimeOfCrash"), TimeOfCrash.AsString()));
OutCrashAttributes.Add(FAnalyticsEventAttribute(TEXT("EngineMode"), EngineMode));
OutCrashAttributes.Add(FAnalyticsEventAttribute(TEXT("EngineModeEx"), EngineModeEx.AsString()));
OutCrashAttributes.Add(FAnalyticsEventAttribute(TEXT("AppDefaultLocale"), AppDefaultLocale));
OutCrashAttributes.Add(FAnalyticsEventAttribute(TEXT("UserActivityHint"), UserActivityHint.AsString()));
OutCrashAttributes.Add(FAnalyticsEventAttribute(TEXT("GameSessionID"), GameSessionID.AsString()));
OutCrashAttributes.Add(FAnalyticsEventAttribute(TEXT("DeploymentName"), DeploymentName));
}
void FPrimaryCrashProperties::Save()
{
XmlFile->Save( XmlFilepath );
}
/*-----------------------------------------------------------------------------
FCrashContextReader
-----------------------------------------------------------------------------*/
FCrashContext::FCrashContext( const FString& CrashContextFilepath )
{
ReadXML( CrashContextFilepath );
const bool bIsValid = XmlFile->IsValid();
if (bIsValid)
{
RestartCommandLine = CommandLine.AsString();
// Setup properties required for the analytics.
GetCrashProperty(CrashVersion, FGenericCrashContext::RuntimePropertiesTag, TEXT("CrashVersion"));
GetCrashProperty(CrashGUID, FGenericCrashContext::RuntimePropertiesTag, TEXT("CrashGUID"));
GetCrashProperty(CrashDumpMode, FGenericCrashContext::RuntimePropertiesTag, TEXT("CrashDumpMode"));
GetCrashProperty(GameName, FGenericCrashContext::RuntimePropertiesTag, TEXT("GameName"));
GetCrashProperty(ExecutableName, FGenericCrashContext::RuntimePropertiesTag, TEXT("ExecutableName"));
GetCrashProperty(EngineVersion, FGenericCrashContext::RuntimePropertiesTag, TEXT("EngineVersion"));
GetCrashProperty( BaseDir, FGenericCrashContext::RuntimePropertiesTag, TEXT( "BaseDir" ) );
FString Misc_OSVersionMajor;
GetCrashProperty( Misc_OSVersionMajor, FGenericCrashContext::RuntimePropertiesTag, TEXT( "Misc.OSVersionMajor" ) );
FString Misc_OSVersionMinor;
GetCrashProperty( Misc_OSVersionMinor, FGenericCrashContext::RuntimePropertiesTag, TEXT( "Misc.OSVersionMinor" ) );
bool Misc_Is64bitOperatingSystem = false;
GetCrashProperty( Misc_Is64bitOperatingSystem, FGenericCrashContext::RuntimePropertiesTag, TEXT( "Misc.Is64bitOperatingSystem" ) );
// Extract the Platform component.
TArray<FString> SubDirs;
BaseDir.ParseIntoArray( SubDirs, TEXT( "/" ), true );
const int SubDirsNum = SubDirs.Num();
const FString PlatformName = SubDirsNum > 0 ? SubDirs[SubDirsNum - 1] : TEXT( "" );
if (Misc_OSVersionMajor.Len() > 0)
{
PlatformFullName = FString::Printf( TEXT( "%s [%s %s %s]" ), *PlatformName, *Misc_OSVersionMajor, *Misc_OSVersionMinor, Misc_Is64bitOperatingSystem ? TEXT( "64b" ) : TEXT( "32b" ) );
}
else
{
PlatformFullName = PlatformName;
}
GetCrashProperty( EngineMode, FGenericCrashContext::RuntimePropertiesTag, TEXT( "EngineMode" ) );
GetCrashProperty( DeploymentName, FGenericCrashContext::RuntimePropertiesTag, TEXT( "DeploymentName" ) );
GetCrashProperty( AppDefaultLocale, FGenericCrashContext::RuntimePropertiesTag, TEXT( "AppDefaultLocale" ) );
GetCrashProperty( bIsEnsure, FGenericCrashContext::RuntimePropertiesTag, TEXT("IsEnsure"));
if (CrashDumpMode == ECrashDumpMode::FullDump)
{
// Set the full dump crash location when we have a full dump.
const FString LocationForBranch = FCrashReportClientConfig::Get().GetFullCrashDumpLocationForBranch( EngineVersion.GetBranch() );
if (!LocationForBranch.IsEmpty())
{
FullCrashDumpLocation = LocationForBranch / CrashGUID + TEXT("_") + EngineVersion.ToString();
}
}
bHasPrimaryData = true;
}
}
/*-----------------------------------------------------------------------------
FCrashDescription
-----------------------------------------------------------------------------*/
FCrashWERContext::FCrashWERContext( const FString& WERXMLFilepath )
: FPrimaryCrashProperties()
{
ReadXML( WERXMLFilepath );
CrashGUID = FPaths::GetCleanFilename( FPaths::GetPath( WERXMLFilepath ) );
const bool bIsValid = XmlFile->IsValid();
if (bIsValid)
{
FString BuildVersion;
FString BranchName;
uint32 BuiltFromCL = 0;
int EngineVersionComponents = 0;
GetCrashProperty( GameName, TEXT( "ProblemSignatures" ), TEXT( "Parameter0" ) );
GetCrashProperty( BuildVersion, TEXT( "ProblemSignatures" ), TEXT( "Parameter1" ) );
if (!BuildVersion.IsEmpty())
{
EngineVersionComponents++;
}
FString Parameter8Value;
GetCrashProperty( Parameter8Value, TEXT( "ProblemSignatures" ), TEXT( "Parameter8" ) );
if (!Parameter8Value.IsEmpty())
{
TArray<FString> ParsedParameters8;
Parameter8Value.ParseIntoArray( ParsedParameters8, TEXT( "!" ), false );
if (ParsedParameters8.Num() > 1)
{
CommandLine = FGenericCrashContext::UnescapeXMLString( ParsedParameters8[1] );
CrashDumpMode = CommandLine.AsString().Contains( TEXT( "-fullcrashdump" ) ) ? ECrashDumpMode::FullDump : ECrashDumpMode::Default;
}
if (ParsedParameters8.Num() > 2)
{
ErrorMessage = ParsedParameters8[2];
}
}
RestartCommandLine = CommandLine.AsString();
FString Parameter9Value;
GetCrashProperty( Parameter9Value, TEXT( "ProblemSignatures" ), TEXT( "Parameter9" ) );
if (!Parameter9Value.IsEmpty())
{
TArray<FString> ParsedParameters9;
Parameter9Value.ParseIntoArray( ParsedParameters9, TEXT( "!" ), false );
if (ParsedParameters9.Num() > 0)
{
BranchName = ParsedParameters9[0].Replace( TEXT( "+" ), TEXT( "/" ) );
const FString DepotRoot = TEXT( "//depot/" );
if (BranchName.StartsWith( DepotRoot ))
{
BranchName = BranchName.Mid( DepotRoot.Len() );
}
EngineVersionComponents++;
}
if (ParsedParameters9.Num() > 1)
{
const FString BaseDirectory = ParsedParameters9[1];
TArray<FString> SubDirs;
BaseDirectory.ParseIntoArray( SubDirs, TEXT( "/" ), true );
const int SubDirsNum = SubDirs.Num();
const FString PlatformName = SubDirsNum > 0 ? SubDirs[SubDirsNum - 1] : TEXT( "" );
FString Product;
GetCrashProperty( Product, TEXT( "OSVersionInformation" ), TEXT( "Product" ) );
if (Product.Len() > 0)
{
PlatformFullName = FString::Printf( TEXT( "%s [%s]" ), *PlatformName, *Product );
}
else
{
PlatformFullName = PlatformName;
}
}
if (ParsedParameters9.Num() > 2)
{
EngineMode = ParsedParameters9[2];
}
if (ParsedParameters9.Num() > 3)
{
TTypeFromString<uint32>::FromString( BuiltFromCL, *ParsedParameters9[3] );
EngineVersionComponents++;
}
}
// We have all three components of the engine version, so initialize it.
if (EngineVersionComponents == 3)
{
InitializeEngineVersion( BuildVersion, BranchName, BuiltFromCL );
}
GetCrashProperty(DeploymentName, TEXT("DynamicSignatures"), TEXT("DeploymentName"));
GetCrashProperty(bIsEnsure, TEXT("DynamicSignatures"), TEXT("IsEnsure"));
FString EngineModeExString;
GetCrashProperty(EngineModeExString, TEXT("DynamicSignatures"), TEXT("EngineModeEx"));
EngineModeEx = EngineModeExString;
bHasPrimaryData = true;
}
}
void FCrashWERContext::InitializeEngineVersion( const FString& BuildVersion, const FString& BranchName, uint32 BuiltFromCL )
{
uint16 Major = 0;
uint16 Minor = 0;
uint16 Patch = 0;
TArray<FString> ParsedBuildVersion;
BuildVersion.ParseIntoArray( ParsedBuildVersion, TEXT( "." ), false );
if (ParsedBuildVersion.Num() >= 3)
{
TTypeFromString<uint16>::FromString( Patch, *ParsedBuildVersion[2] );
}
if (ParsedBuildVersion.Num() >= 2)
{
TTypeFromString<uint16>::FromString( Minor, *ParsedBuildVersion[1] );
}
if (ParsedBuildVersion.Num() >= 1)
{
TTypeFromString<uint16>::FromString( Major, *ParsedBuildVersion[0] );
}
EngineVersion = FEngineVersion( Major, Minor, Patch, BuiltFromCL, BranchName );
}