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/ErrorOr.h"
22 #include "llvm/Support/MemoryBuffer.h"
30 using namespace object;
31 using FunctionNameKind = DILineInfoSpecifier::FunctionNameKind;
33 class LLVMSymbolizer {
36 FunctionNameKind PrintFunctions;
37 bool UseSymbolTable : 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 Demangle = true,
44 bool RelativeAddresses = false, std::string DefaultArch = "")
45 : PrintFunctions(PrintFunctions), UseSymbolTable(UseSymbolTable),
46 Demangle(Demangle), RelativeAddresses(RelativeAddresses),
47 DefaultArch(DefaultArch) {}
50 LLVMSymbolizer(const Options &Opts = Options()) : Opts(Opts) {}
55 ErrorOr<DILineInfo> symbolizeCode(const std::string &ModuleName,
56 uint64_t ModuleOffset);
57 ErrorOr<DIInliningInfo> symbolizeInlinedCode(const std::string &ModuleName,
58 uint64_t ModuleOffset);
59 ErrorOr<DIGlobal> symbolizeData(const std::string &ModuleName,
60 uint64_t ModuleOffset);
62 static std::string DemangleName(const std::string &Name,
63 const SymbolizableModule *ModInfo);
66 typedef std::pair<ObjectFile*, ObjectFile*> ObjectPair;
68 ErrorOr<SymbolizableModule *>
69 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 ErrorOr<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 ErrorOr<ObjectFile *> getObjectFileFromBinary(Binary *Bin,
80 const std::string &ArchName);
82 // Owns all the parsed binaries and object files.
83 SmallVector<std::unique_ptr<Binary>, 4> ParsedBinariesAndObjects;
84 SmallVector<std::unique_ptr<MemoryBuffer>, 4> MemoryBuffers;
85 void addOwningBinary(OwningBinary<Binary> OwningBin) {
86 std::unique_ptr<Binary> Bin;
87 std::unique_ptr<MemoryBuffer> MemBuf;
88 std::tie(Bin, MemBuf) = OwningBin.takeBinary();
89 ParsedBinariesAndObjects.push_back(std::move(Bin));
90 MemoryBuffers.push_back(std::move(MemBuf));
93 std::map<std::string, ErrorOr<std::unique_ptr<SymbolizableModule>>> Modules;
94 std::map<std::pair<MachOUniversalBinary *, std::string>,
95 ErrorOr<ObjectFile *>> ObjectFileForArch;
96 std::map<std::pair<std::string, std::string>, ErrorOr<ObjectPair>>
97 ObjectPairForPathArch;
102 } // namespace symbolize