AndroidPlatformCrashContext.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#include "GenericPlatform/GenericPlatformCrashContext.h"
#include "Containers/Map.h"
 
struct FAndroidCrashContext : public FGenericCrashContext
{
    int32 Signal;
 
    uint32 CrashingThreadId;
    
    siginfo* Info;
    
    void* Context;
 
    CORE_API FAndroidCrashContext(ECrashContextType InType, const TCHAR* InErrorMessage);
 
    ~FAndroidCrashContext()
    {
    }
 
    void InitFromSignal(int32 InSignal, siginfo* InInfo, void* InContext, uint32 InCrashingThreadId)
    {
        Signal = InSignal;
        CrashingThreadId = InCrashingThreadId;
        Info = InInfo;
        Context = InContext;
    }
 
    CORE_API virtual void GetPortableCallStack(const uint64* StackFrames, int32 NumStackFrames, TArray<FCrashStackFrame>& OutCallStack) const override;
    CORE_API virtual void AddPlatformSpecificProperties() const override;
 
    CORE_API void CaptureCrashInfo();
    CORE_API void StoreCrashInfo(bool bWriteLog) const;
 
    static const int32 CrashReportMaxPathSize = 512;
 
    static CORE_API void Initialize();
    // Returns the report directory used for this crash context.
    FString GetCurrentReportDirectoryPath() const { return FString(ReportDirectory); }
 
    // Returns the main crash directory for this session. This will not be correct for non-fatal reports.
    static CORE_API const FString GetGlobalCrashDirectoryPath();
    // Fills DirectoryNameOUT with the global crash directory for a fatal crash this session. This will not be correct for non-fatal reports.
    static CORE_API void GetGlobalCrashDirectoryPath(char(&DirectoryNameOUT)[CrashReportMaxPathSize]);
 
    CORE_API void AddAndroidCrashProperty(const FString& Key, const FString& Value);
 
    CORE_API void SetOverrideCallstack(const FString& OverrideCallstackIN);
 
    // generate an absolute path to a crash report folder.
    static CORE_API void GenerateReportDirectoryName(char(&DirectoryNameOUT)[CrashReportMaxPathSize]);
 
    // expects externally allocated memory for all threads found in FThreadManager + main thread
    CORE_API void DumpAllThreadCallstacks(FAsyncThreadBackTrace* BackTrace, int NumThreads) const;
 
    static CORE_API const ANSICHAR* ItoANSI(uint64 Val, uint64 Base, uint32 Len = 0);
 
    // temporary accessor to allow overriding of the portable callstack.
    TArray<FCrashStackFrame>& GetPortableCallstack_TEMP() { return CallStack; }
 
protected:
 
    CORE_API virtual const TCHAR* GetCallstackProperty() const;
 
private:
    FString OverrideCallstack;
 
    TMap<FString, FString> AdditionalProperties;
 
    // The path used by this instance to store the report.
    char ReportDirectory[CrashReportMaxPathSize];
};
 
struct FAndroidMemoryWarningContext : public FGenericMemoryWarningContext
{
    FAndroidMemoryWarningContext() : LastTrimMemoryState(FAndroidPlatformMemory::ETrimValues::Unknown) {}
 
    // value last recorded from java side's OnTrimMemory.
    FAndroidPlatformMemory::ETrimValues LastTrimMemoryState;
};
 
typedef FAndroidCrashContext FPlatformCrashContext;