1 //===-- Symbolize.h --------------------------------------------- C++ -----===//
3 // The LLVM Compiler Infrastructure
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
10 // Header for LLVM symbolization library.
12 //===----------------------------------------------------------------------===//
13 #ifndef LLVM_DEBUGINFO_SYMBOLIZE_SYMBOLIZE_H
14 #define LLVM_DEBUGINFO_SYMBOLIZE_SYMBOLIZE_H
16 #include "llvm/ADT/SmallVector.h"
17 #include "llvm/DebugInfo/DIContext.h"
18 #include "llvm/DebugInfo/Symbolize/SymbolizableModule.h"
19 #include "llvm/Object/MachOUniversal.h"
20 #include "llvm/Object/ObjectFile.h"
21 #include "llvm/Support/MemoryBuffer.h"
29 using namespace object;
30 using FunctionNameKind = DILineInfoSpecifier::FunctionNameKind;
32 class LLVMSymbolizer {
35 FunctionNameKind PrintFunctions;
36 bool UseSymbolTable : 1;
37 bool PrintInlining : 1;
39 bool RelativeAddresses : 1;
40 std::string DefaultArch;
41 std::vector<std::string> DsymHints;
42 Options(FunctionNameKind PrintFunctions = FunctionNameKind::LinkageName,
43 bool UseSymbolTable = true, bool PrintInlining = true,
44 bool Demangle = true, bool RelativeAddresses = false,
45 std::string DefaultArch = "")
46 : PrintFunctions(PrintFunctions), UseSymbolTable(UseSymbolTable),
47 PrintInlining(PrintInlining), Demangle(Demangle),
48 RelativeAddresses(RelativeAddresses), DefaultArch(DefaultArch) {}
51 LLVMSymbolizer(const Options &Opts = Options()) : Opts(Opts) {}
56 // Returns the result of symbolization for module name/offset as
57 // a string (possibly containing newlines).
59 symbolizeCode(const std::string &ModuleName, uint64_t ModuleOffset);
61 symbolizeData(const std::string &ModuleName, uint64_t ModuleOffset);
63 static std::string DemangleName(const std::string &Name,
64 const SymbolizableModule *ModInfo);
67 typedef std::pair<ObjectFile*, ObjectFile*> ObjectPair;
69 SymbolizableModule *getOrCreateModuleInfo(const std::string &ModuleName);
70 ObjectFile *lookUpDsymFile(const std::string &Path,
71 const MachOObjectFile *ExeObj,
72 const std::string &ArchName);
74 /// \brief Returns pair of pointers to object and debug object.
75 ObjectPair getOrCreateObjects(const std::string &Path,
76 const std::string &ArchName);
77 /// \brief Returns a parsed object file for a given architecture in a
78 /// universal binary (or the binary itself if it is an object file).
79 ObjectFile *getObjectFileFromBinary(Binary *Bin, const std::string &ArchName);
81 std::string printDILineInfo(DILineInfo LineInfo,
82 const SymbolizableModule *ModInfo) const;
83 std::string printDIGlobal(DIGlobal Global,
84 const SymbolizableModule *ModInfo) const;
86 // Owns all the parsed binaries and object files.
87 SmallVector<std::unique_ptr<Binary>, 4> ParsedBinariesAndObjects;
88 SmallVector<std::unique_ptr<MemoryBuffer>, 4> MemoryBuffers;
89 void addOwningBinary(OwningBinary<Binary> OwningBin) {
90 std::unique_ptr<Binary> Bin;
91 std::unique_ptr<MemoryBuffer> MemBuf;
92 std::tie(Bin, MemBuf) = OwningBin.takeBinary();
93 ParsedBinariesAndObjects.push_back(std::move(Bin));
94 MemoryBuffers.push_back(std::move(MemBuf));
97 std::map<std::string, std::unique_ptr<SymbolizableModule>> Modules;
98 std::map<std::pair<MachOUniversalBinary *, std::string>, ObjectFile *>
100 std::map<std::pair<std::string, std::string>, ObjectPair>
101 ObjectPairForPathArch;
104 static const char kBadString[];
107 } // namespace symbolize