GenericPlatformSymbolication.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#include "Containers/Array.h"
#include "Containers/Set.h"
#include "Containers/UnrealString.h"
#include "CoreTypes.h"
#include "GenericPlatform/GenericPlatformStackWalk.h"
#include "Serialization/Archive.h"
#include "Templates/UnrealTypeTraits.h"
 
struct FProgramCounterSymbolInfo;
template< typename InElementType, typename KeyFuncs , typename Allocator > class TSet;
template <typename T> struct TCallTraits;
 
/**
 * File & line info for a debug symbol region
 */
struct FGenericPlatformSymbolInfo
{
    uint32 Line;
    uint64 Start;
    uint64 Length;
    int32 PathIdx;
 
    /**
     * Serializes a symbol info from or into an archive.
     *
     * @param Ar The archive to serialize from or into.
     * @param Info The info to serialize.
     */
    friend FArchive& operator<<( FArchive& Ar, FGenericPlatformSymbolInfo& Info )
    {
        return Ar << Info.Line << Info.Start << Info.Length << Info.PathIdx;
    }
};
 
 
/**
 * Debug symbol information
 */
struct FGenericPlatformSymbolData
{
    uint64 Start;
    uint64 Length;
    int32 NameIdx;
    TArray<FGenericPlatformSymbolInfo> SymbolInfo;
 
    /**
     * Serializes a symbol from or into an archive.
     *
     * @param Ar The archive to serialize from or into.
     * @param Info The info to serialize.
     */
    friend FArchive& operator<<( FArchive& Ar, FGenericPlatformSymbolData& Info )
    {
        return Ar << Info.Start << Info.Length << Info.NameIdx << Info.SymbolInfo;
    }
};
 
 
/**
 * Container for debug symbols corresponding to a single binary file
 */
struct FGenericPlatformSymbolDatabase
{
    FString Signature;
    FString Name;
    TArray<FGenericPlatformSymbolData> Symbols;
    TArray<FString> StringTable;
 
    /**
     * Serializes a symbol container from or into an archive.
     *
     * @param Ar The archive to serialize from or into.
     * @param Info The info to serialize.
     */
    friend FArchive& operator<<( FArchive& Ar, FGenericPlatformSymbolDatabase& Info )
    {
        return Ar << Info.Signature << Info.Name << Info.Symbols << Info.StringTable;
    }
};
 
 
struct FGenericPlatformSymbolDatabaseKeyFuncs
{
    enum { bAllowDuplicateKeys = 0 };
    typedef TCallTraits<FString>::ParamType KeyInitType;
    typedef TCallTraits<FGenericPlatformSymbolDatabase>::ParamType ElementInitType;
 
    /**
     * @return The key used to index the given element.
     */
    static FORCEINLINE KeyInitType GetSetKey(ElementInitType Element)
    {
        return Element.Signature;
    }
 
    /**
     * @return True if the keys match.
     */
    static FORCEINLINE bool Matches(KeyInitType A,KeyInitType B)
    {
        return A == B;
    }
 
    /** Calculates a hash index for a key. */
    static FORCEINLINE uint32 GetKeyHash(KeyInitType Key)
    {
        return GetTypeHash(Key);
    }
};
 
 
typedef TSet<FGenericPlatformSymbolDatabase, FGenericPlatformSymbolDatabaseKeyFuncs> FGenericPlatformSymbolDatabaseSet;
 
 
struct FGenericPlatformSymbolication
{
    static bool LoadSymbolDatabaseForBinary(FString SourceFolder, FString BinaryPath, FString BinarySignature, FGenericPlatformSymbolDatabase& OutDatabase);
    static bool SaveSymbolDatabaseForBinary(FString TargetFolder, FString Name, FGenericPlatformSymbolDatabase& Database);
 
    static bool SymbolInfoForStrippedSymbol(FGenericPlatformSymbolDatabase const& Database, uint64 ProgramCounter, uint64 ModuleOffset, FString ModuleSignature, FProgramCounterSymbolInfo& Info);
 
    static bool SymbolInfoForAddress(uint64 ProgramCounter, FProgramCounterSymbolInfo& Info) { return false; }
};