WindowsPlatformStackWalk.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#include "CoreTypes.h"
#include "Microsoft/MicrosoftPlatformStackWalk.h"
 
struct FWindowsPlatformStackWalk
    : public FMicrosoftPlatformStackWalk
{
    static CORE_API bool InitStackWalking();
    static CORE_API bool InitStackWalkingForProcess(const FProcHandle& Process);
    
    static CORE_API TArray<FProgramCounterSymbolInfo> GetStack(int32 IgnoreCount, int32 MaxDepth = 100, void* Context = nullptr);
 
    static CORE_API void EnumerateSymbolInfosForProgramCounter(uint64 ProgramCounter, bool bIncludeInlineFrames, TFunctionRef<void(FProgramCounterSymbolInfo& OutSymbolInfo)> Callback);
 
    static CORE_API void ProgramCounterToSymbolInfo( uint64 ProgramCounter, FProgramCounterSymbolInfo& out_SymbolInfo );
    static CORE_API void ProgramCounterToSymbolInfoEx( uint64 ProgramCounter, FProgramCounterSymbolInfoEx& out_SymbolInfo );
    CORE_API FORCENOINLINE static uint32 CaptureStackBackTrace( uint64* BackTrace, uint32 MaxDepth, void* Context = nullptr );  // FORCENOINLINE so it can be counted during StackTrace
    static CORE_API uint32 CaptureThreadStackBackTrace( uint64 ThreadId, uint64* BackTrace, uint32 MaxDepth, void* Context = nullptr);
    CORE_API FORCENOINLINE static void StackWalkAndDump( ANSICHAR* HumanReadableString, SIZE_T HumanReadableStringSize, int32 IgnoreCount, void* Context = nullptr );  // FORCENOINLINE so it can be counted during StackTrace
    static CORE_API void StackWalkAndDump( ANSICHAR* HumanReadableString, SIZE_T HumanReadableStringSize, void* ProgramCounter, void* Context = nullptr );
    static CORE_API void ThreadStackWalkAndDump(ANSICHAR* HumanReadableString, SIZE_T HumanReadableStringSize, int32 IgnoreCount, uint32 ThreadId);
 
    static CORE_API int32 GetProcessModuleCount();
    static CORE_API int32 GetProcessModuleSignatures(FStackWalkModuleInfo *ModuleSignatures, const int32 ModuleSignaturesSize);
 
    static CORE_API void RegisterOnModulesChanged();
 
    static CORE_API bool UploadLocalSymbols();
 
    static CORE_API FString GetDownstreamStorage();
 
    static CORE_API void* MakeThreadContextWrapper(void* Context, void* ThreadHandle);
    static CORE_API void ReleaseThreadContextWrapper(void* ThreadContext);
 
    static CORE_API bool GetFunctionDefinitionLocation(const FString& FunctionSymbolName, const FString& FunctionModuleName, FString& OutPathname, uint32& OutLineNumber, uint32& OutColumnNumber);
 
protected:
    static CORE_API void CaptureStackTraceByProcess(uint64* OutBacktrace, uint32 MaxDepth, void* InContext, void* InThreadHandle, uint32* OutDepth, bool bExternalProcess);
private:
    static bool InitStackWalkingInternal(void* Process, bool bForceReinitOnProcessMismatch);
};
 
 
typedef FWindowsPlatformStackWalk FPlatformStackWalk;