1. Epic GamesDeveloper
  3. FGenericCrashContext

FGenericCrashContext

Contains a runtime crash's properties that are common for all platforms.

API > API/Runtime > API/Runtime/Core > API/Runtime/Core/GenericPlatform

Inheritance Hierarchy

References

   
Module Core
Header /Engine/Source/Runtime/Core/Public/GenericPlatform/GenericPlatformCrashContext.h
Include #include "GenericPlatform/GenericPlatformCrashContext.h"

Syntax

struct FGenericCrashContext

Remarks

Contains a runtime crash's properties that are common for all platforms. This may change in the future.

Variables

  Type Name Description
Protected variable TArray< FCrashStackFrame > CallStack  
Protected variable uint32 CrashedThreadId  
Protected variable const TCHAR * ErrorMessage  
Protected variable TArray< FStackWalkModuleInfo > ModulesInfo  
Protected variable int NumMinidumpFramesToIgnore  
Protected variable FProcHandle ProcessHandle  
Protected variable TArray< FThreadStackFrames > ThreadCallStacks  
Protected variable ECrashContextType Type  

Constructors

  Type Name Description
Public function  

FGenericCrashContext ( ECrashContextType InType,
const TCHAR* ErrorMessage
)

 Default constructor.

Destructors

  Type Name Description
Public function Virtual    

Functions

  Type Name Description
Public function Static void

AddCrashProperty ( FString& Buffer,
const TCHAR* PropertyName,
const Type& Value
)

  
Public function Const void

AddCrashProperty ( const TCHAR* PropertyName,
const Type& Value
)

  
Public function Static void

AddFooter ( FString& Buffer
)

 Writes footer to the buffer.
Public function Static void

AddHeader ( FString& Buffer
)

 Writes header information to the buffer.
Public function Static void

AddPlugin ( const FString& PluginDesc
)

 Adds a plugin descriptor string to the enabled plugins list in the crash context
Public function Virtual void

AddPortableThreadCallStack ( uint32 ThreadId,
const TCHAR* ThreadName,
const uint64* StackFrames,
int32 NumStackFrames
)

  
Public function Virtual void

AddPortableThreadCallStacks ( TConstArrayView< FThreadCallStack > Threads
)

 Adds a portable callstack for a thread
Public function Static void

AddSection ( FString& Buffer,
const TCHAR* SectionName,
const FString& SectionContent
)

  
Public function Static void  
Public function Static void Escapes and appends specified text to XML string
Public function Static void

AppendPortableCallstack ( FString& OutBuffer,
TConstArrayView< FCrashStackFrame > StackFrames
)

  
Public function Static void

BeginSection ( FString& Buffer,
const TCHAR* SectionName
)

  
Public function Virtual void Store info about loaded modules
Public function void

CapturePortableCallStack ( int32 NumStackFramesToIgnore,
void* Context
)

  
Public function void

CapturePortableCallStack ( void* ErrorProgramCounter,
void* Context
)

 Generate raw call stack for crash report (image base + offset) for the calling thread
Public function void

CaptureThreadPortableCallStack ( const uint64 ThreadId,
void* Context
)

 Generate raw call stack for crash report (image base + offset) for a different thread
Public function Static void Cleanup platform specific files - called on startup, implemented per platform
Public function Static void

CleanupTempSessionContextFiles ( const FTimespan& ExpirationAge
)

 Clean up expired context files that were left-over on the user disks (because the consumer crashed and/or failed to delete it).
Public function Virtual void

CopyPlatformSpecificFiles ( const TCHAR* OutputDirectory,
void* Context
)

 Allows platform implementations to copy files to report directory.
Public function Static void Initializes a shared crash context from current state. Will not set all fields in Dst.
Public function Static bool

CreateCrashReportDirectory ( const TCHAR* CrashGUIDRoot,
int32 CrashIndex,
FString& OutCrashDirectoryAbsolute
)

 Attempts to create the output report directory.
Public function Static void

DumpAdditionalContext ( const TCHAR* CrashFolderAbsolute
)

 Collects additional crash context providers. See FAdditionalCrashContextStack.
Public function Static FString

DumpLog ( const FString& CrashFolderAbsolute
)

 Flushes the logs.
Public function Static void

EndSection ( FString& Buffer,
const TCHAR* SectionName
)

  
Public function Const const FString &  
Public function Static const FSessionContext & Get the current cached session context
Protected function Virtual Const const TCHAR * Allow platform implementations to provide a callstack property.
Public function Static const TCHAR * Helper to get the crash report client config filepath saved by this instance and copied to each crash report folder.
Public function Static const TCHAR * Helper to get the crash report client config folder used by GetCrashConfigFilePath().
Public function Static FString Get the Game Name of the crash
Public function Static const TCHAR * Helper to get the standard string for the crash type based on crash event bool values.
Public function Static const TCHAR * Get the current deployment name (ie. EpicApp)
Protected function Static const FString *

GetEngineData ( const FString& Key
)

 Get arbitrary engine data from the crash context
Public function Static const TMap< FString, FString > & Get the engine data dictionary
Public function Static const TMap< FString, FString > & Get the game data dictionary
Protected function Static const FString *

GetGameData ( const FString& Key
)

 Get arbitrary game data from the crash context
Public function Static FString Gets the current standardized game name for use in a Crash Reporter report.
Public function Virtual Const void Gets info about loaded modules and stores it in the given array
Public function Static TOptional< int32 > Return the out-of-process crash reporter exit code if available.
Public function Static uint32  
Protected function Virtual Const bool @OutStr - a stream of Thread XML elements containing info (e.g. callstack) specific to an active thread
Public function Virtual Const void

GetPortableCallStack ( const uint64* StackFrames,
int32 NumStackFrames,
TArray< FCrashStackFrame >& OutCallStack
)

 Gets the portable callstack to a specified stack and puts it into OutCallStack
Public function Static FString Get the file path to the temporary session context file that we create for the given process.
Public function Const ECrashContextType

GetType ()

  
Public function Const void

GetUniqueCrashName ( TCHAR* GUIDBuffer,
int32 BufferSize
)

  
Public function Static void Initializes crash context related platform specific data that can be impossible to obtain after a crash.
Public function Static void

InitializeFromContext ( const FSessionContext& Context,
const TCHAR* EnabledPlugins,
const TCHAR* EngineData,
const TCHAR* GameData,
const FGPUBreadcrumbsSharedContext* GPUBreadcrumbs
)

 Initialized crash context, using a crash context (e.g. shared from another process).
Public function Const const bool  
Public function Static bool  
Public function Static bool The reporting itself (showing the crash UI and sending the report is always done out of process)
Public function Static bool  
Public function Static FEngineDataResetDelegate & Accessor for engine data reset callback delegate
Public function Static FEngineDataSetDelegate & Accessor for engine data change callback delegate
Public function Static FGameDataResetDelegate & Accessor for game data reset callback delegate
Public function Static FGameDataSetDelegate & Accessor for game data change callback delegate
Public function Static void

OnThreadStuck ( uint32 ThreadId
)

 Sets a flag that one of the threads is stuck.
Public function Static void

OnThreadUnstuck ( uint32 ThreadId
)

 Clears the stuck flag.
Public function Static void Helper to clean out old files in the crash report client config folder.
Public function Static void Clears the engine data dictionary
Public function Static void Clears the game data dictionary
Public function Virtual Const void

SerializeAsXML ( const TCHAR* Filename
)

 Serializes crash's informations to the specified filename.
Public function Const void Serializes all data to the buffer.
Public function Static void Serializes session context to the given buffer.
Public function Static void

SetAnticheatProvider ( const FString& AnticheatProvider
)

 Sets the Anticheat client provider.
Public function void

SetCrashedProcess ( const FProcHandle& Process
)

 Sets the process id to that has crashed.
Public function void Stores crashing thread id.
Public function Static void Sets the type of crash triggered. Used to distinguish crashes caused for debugging purposes.
Public function Static void

SetDeploymentName ( const FString& EpicApp
)

 Set the current deployment name (ie. EpicApp)
Public function Static void

SetEngineData ( const FString& Key,
const FString& Value
)

 Updates (or adds if not already present) arbitrary engine data to the crash context (will remove the key if passed an empty string)
Public function Static void

SetEngineExit ( bool bIsRequestExit
)

 Notify the crash context exit has been requested.
Public function Static void

SetEpicAccountId ( const FString& EpicAccountId
)

 Set or change the epic account id associated with the crash session.
Public function Static void

SetGameData ( const FString& Key,
const FString& Value
)

 Updates (or adds if not already present) arbitrary game data to the crash context (will remove the key if passed an empty string)
Public function Static void Updates (or adds if not already present) GPU breadcrumb data.
Public function Static void

SetMemoryStats ( const FPlatformMemoryStats& MemoryStats
)

 We can't gather memory stats in crash handling function, so we gather them just before raising exception and use in crash reporting.
Public function void

SetNumMinidumpFramesToIgnore ( int32 InNumMinidumpFramesToIgnore
)

 Sets the number of stack frames to ignore when symbolicating from a minidump
Public function Static void Set the out of process crash reporter exit code if known.
Public function Static void Set whether or not the out-of-process crash reporter is running.
Public function Virtual void

SetPortableCallStack ( const uint64* StackFrames,
int32 NumStackFrames
)

 Sets the portable callstack to a specified stack
Public function Static FString

UnescapeXMLString ( const FString& Text
)

 Unescapes a specified XML string, naive implementation.

Constants

Name Description
AttendedStatusTag  
bIsInitialized Whether the Initialize() has been called
BuildVersionTag  
CallStackTag  
ConfigSectionName  
CrashConfigExtension  
CrashConfigFileNameA  
CrashConfigFileNameW  
CrashConfigPurgeDays  
CrashContextExtension  
CrashContextRuntimeXMLNameA  
CrashContextRuntimeXMLNameW  
CrashGUIDLength  
CrashGUIDRootPrefix  
CrashGuidTag  
CrashReporterMessageTag  
CrashTypeAbnormalShutdown  
CrashTypeAssert  
CrashTypeCrash  
CrashTypeEnsure  
CrashTypeGPU  
CrashTypeHang  
CrashTypeOutOfMemory  
CrashTypeStall  
CrashTypeTag  
CrashTypeVerseRuntimeError  
CrashVersionTag  
DeploymentNameTag  
EnabledPluginsTag  
EngineDataTag  
EngineModeExDirty  
EngineModeExUnknown  
EngineModeExVanilla  
ErrorMessageTag  
ExecutionGuid A guid that identifies this particular execution. Allows multiple crash reports from the same run of the project to be tied together.
ExecutionGuidTag  
GameDataTag  
GameNameTag  
IsAssertTag  
IsEnsureTag  
IsInternalBuildTag  
IsPerforceBuildTag  
IsRequestingExitTag  
IsSourceDistributionTag  
IsStallTag  
IsWithDebugInfoTag  
LogFilePathTag  
NewLineTag  
OnEngineDataReset Engine and game data set / reset delegates
OnEngineDataSet  
OnGameDataReset  
OnGameDataSet  
OutOfProcessCrashReporterExitCode The out of process crash reporter exit code, if available.
OutOfProcessCrashReporterPid The ID of the external process reporting crashes if the platform supports it and was configured to use it, zero otherwise (0 is a reserved system process ID, invalid for the out of process reporter).
PlatformPropertiesTag  
PortableCallStackHashTag  
PortableCallStackTag  
ProcessIdTag  
RuntimePropertiesTag  
SecondsSinceStartTag  
StaticCrashContextIndex Static counter records how many crash contexts have been constructed
UEMinidumpName  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page