UnixPlatformCrashContext.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#include "Containers/Array.h"
#include "Containers/UnrealString.h"
#include "CoreTypes.h"
#include "GenericPlatform/GenericPlatformCrashContext.h"
#include "Unix/UnixSystemIncludes.h" // IWYU pragma: export
#include "Templates/Atomic.h"
 
#include <ucontext.h> // IWYU pragma: export
 
struct ThreadStackUserData
{
    // If we want a backtrace or a callstack
    // Backtrace is just a list of program counters and callstack is a symbolicated backtrace
    bool bCaptureCallStack;
    union 
    {
        ANSICHAR* CallStack;
        uint64* BackTrace;
    };
 
    int32 BackTraceCount;
    SIZE_T CallStackSize;
    TAtomic<bool> bDone;
};
 
struct FUnixCrashContext : public FGenericCrashContext
{
    int32 Signal;
    
    siginfo_t* Info;
    
    ucontext_t* Context;
 
    bool bCapturedBacktrace;
 
    char ** BacktraceSymbols;
 
    TCHAR SignalDescription[256];
 
    char MinidumpCallstackInfo[16384];
 
    static CORE_API __thread siginfo_t  FakeSiginfoForDiagnostics;
 
    uint64* FirstCrashHandlerFrame = nullptr;
 
    void* ErrorFrame = nullptr;
 
    FUnixCrashContext(ECrashContextType InType, const TCHAR* InErrorMessage)
        :   FGenericCrashContext(InType, InErrorMessage)
        ,   Signal(0)
        ,   Info(nullptr)
        ,   Context(nullptr)
        ,   bCapturedBacktrace(false)
        ,   BacktraceSymbols(nullptr)
    {
        SignalDescription[ 0 ] = 0;
        MinidumpCallstackInfo[ 0 ] = 0;
    }
 
    CORE_API ~FUnixCrashContext();
 
    CORE_API void InitFromSignal(int32 InSignal, siginfo_t* InInfo, void* InContext);
 
    CORE_API void InitFromDiagnostics(const void* InAddress = nullptr);
 
    CORE_API void CaptureStackTrace(void* ErrorProgramCounter);
 
    CORE_API void CaptureThreadStackTrace(uint32_t ThreadId);
 
    CORE_API void GenerateCrashInfoAndLaunchReporter() const;
 
    void SetType(ECrashContextType InType) { Type = InType; }
 
    CORE_API void SetFirstCrashHandlerFrame(uint64* ProgramCounter);
 
    CORE_API virtual void GetPortableCallStack(const uint64* StackFrames, int32 NumStackFrames, TArray<FCrashStackFrame>& OutCallStack) const override;
 
    CORE_API void AddPlatformSpecificProperties() const;
 
protected:
    CORE_API void GenerateReport(const FString & DiagnosticsPath) const;
};
 
typedef FUnixCrashContext FPlatformCrashContext;
 
namespace UnixCrashReporterTracker
{
    void PreInit();
 
    void RemoveValidCrashReportTickerForChildProcess();
}