ApplePlatformSymbolication.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
/*=============================================================================================
    ApplePlatformSymbolication.h: Apple platform implementation of symbolication
==============================================================================================*/
 
#pragma once
 
#include "GenericPlatform/GenericPlatformSymbolication.h"
#include "Apple/ApplePlatformStackWalk.h"
#include "Serialization/Archive.h"
#include "Templates/SharedPointer.h"
 
struct FApplePlatformSymbolCache
{
    void* Buffer0;
    void* Buffer1;
};
 
struct FApplePlatformSymbolDatabase
{
    CORE_API FApplePlatformSymbolDatabase();
    CORE_API FApplePlatformSymbolDatabase(FApplePlatformSymbolDatabase const& Other);
    CORE_API ~FApplePlatformSymbolDatabase();
    CORE_API FApplePlatformSymbolDatabase& operator=(FApplePlatformSymbolDatabase const& Other);
    
    TSharedPtr<FGenericPlatformSymbolDatabase> GenericDB;
    FApplePlatformSymbolCache AppleDB;
};
 
struct FApplePlatformSymbolDatabaseKeyFuncs
{
    enum { bAllowDuplicateKeys = 0 };
    typedef typename TCallTraits<FString>::ParamType KeyInitType;
    typedef typename TCallTraits<FApplePlatformSymbolDatabase>::ParamType ElementInitType;
 
    static UE_FORCEINLINE_HINT KeyInitType GetSetKey(ElementInitType Element)
    {
        return Element.GenericDB->Signature;
    }
 
    static UE_FORCEINLINE_HINT bool Matches(KeyInitType A,KeyInitType B)
    {
        return A == B;
    }
 
    static UE_FORCEINLINE_HINT uint32 GetKeyHash(KeyInitType Key)
    {
        return GetTypeHash(Key);
    }
};
 
typedef TSet<FApplePlatformSymbolDatabase, FApplePlatformSymbolDatabaseKeyFuncs> FApplePlatformSymbolDatabaseSet;
 
struct CORE_API FApplePlatformSymbolication
{
    static void EnableCoreSymbolication(bool const bEnable);
    
    static bool LoadSymbolDatabaseForBinary(FString SourceFolder, FString Binary, FString BinarySignature, TOptional<FString> Architecture, FApplePlatformSymbolDatabase& OutDatabase);
    static bool SaveSymbolDatabaseForBinary(FString TargetFolder, FString Name, FString BinarySignature, FApplePlatformSymbolDatabase& Database);
    
    static bool SymbolInfoForStrippedSymbol(FApplePlatformSymbolDatabase const& Database, uint64 ProgramCounter, uint64 ModuleOffset, FString ModuleSignature, FProgramCounterSymbolInfo& Info);
    
    static bool SymbolInfoForAddress(uint64 ProgramCounter, FProgramCounterSymbolInfo& Info);
};
 
typedef FApplePlatformSymbolDatabase FPlatformSymbolDatabase;
typedef FApplePlatformSymbolication FPlatformSymbolication;
typedef TSet<FApplePlatformSymbolDatabase, FApplePlatformSymbolDatabaseKeyFuncs> FPlatformSymbolDatabaseSet;