include/llvm/DebugInfo/Symbolize/Symbolize.h

   1 //===-- Symbolize.h --------------------------------------------- C++ -----===//
   2 //
   3 //                     The LLVM Compiler Infrastructure
   4 //
   5 // This file is distributed under the University of Illinois Open Source
   6 // License. See LICENSE.TXT for details.
   7 //
   8 //===----------------------------------------------------------------------===//
   9 //
  10 // Header for LLVM symbolization library.
  11 //
  12 //===----------------------------------------------------------------------===//
  13 #ifndef LLVM_DEBUGINFO_SYMBOLIZE_SYMBOLIZE_H
  14 #define LLVM_DEBUGINFO_SYMBOLIZE_SYMBOLIZE_H
  15
  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"
  22 #include <map>
  23 #include <memory>
  24 #include <string>
  25
  26 namespace llvm {
  27 namespace symbolize {
  28
  29 using namespace object;
  30 using FunctionNameKind = DILineInfoSpecifier::FunctionNameKind;
  31
  32 class LLVMSymbolizer {
  33 public:
  34   struct Options {
  35     FunctionNameKind PrintFunctions;
  36     bool UseSymbolTable : 1;
  37     bool Demangle : 1;
  38     bool RelativeAddresses : 1;
  39     std::string DefaultArch;
  40     std::vector<std::string> DsymHints;
  41     Options(FunctionNameKind PrintFunctions = FunctionNameKind::LinkageName,
  42             bool UseSymbolTable = true, bool Demangle = true,
  43             bool RelativeAddresses = false, std::string DefaultArch = "")
  44         : PrintFunctions(PrintFunctions), UseSymbolTable(UseSymbolTable),
  45           Demangle(Demangle), RelativeAddresses(RelativeAddresses),
  46           DefaultArch(DefaultArch) {}
  47   };
  48
  49   LLVMSymbolizer(const Options &Opts = Options()) : Opts(Opts) {}
  50   ~LLVMSymbolizer() {
  51     flush();
  52   }
  53
  54   // Returns the result of symbolization for module name/offset as
  55   // a string (possibly containing newlines).
  56   std::string
  57   symbolizeCode(const std::string &ModuleName, uint64_t ModuleOffset);
  58   std::string symbolizeInlinedCode(const std::string &ModuleName,
  59                                    uint64_t ModuleOffset);
  60   std::string
  61   symbolizeData(const std::string &ModuleName, uint64_t ModuleOffset);
  62   void flush();
  63   static std::string DemangleName(const std::string &Name,
  64                                   const SymbolizableModule *ModInfo);
  65
  66 private:
  67   typedef std::pair<ObjectFile*, ObjectFile*> ObjectPair;
  68
  69   SymbolizableModule *getOrCreateModuleInfo(const std::string &ModuleName);
  70   ObjectFile *lookUpDsymFile(const std::string &Path,
  71                              const MachOObjectFile *ExeObj,
  72                              const std::string &ArchName);
  73
  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);
  80
  81   std::string printDILineInfo(DILineInfo LineInfo,
  82                               const SymbolizableModule *ModInfo) const;
  83   std::string printDIInliningInfo(DIInliningInfo InlinedContext,
  84                                   const SymbolizableModule *ModInfo) const;
  85   std::string printDIGlobal(DIGlobal Global,
  86                             const SymbolizableModule *ModInfo) const;
  87
  88   // Owns all the parsed binaries and object files.
  89   SmallVector<std::unique_ptr<Binary>, 4> ParsedBinariesAndObjects;
  90   SmallVector<std::unique_ptr<MemoryBuffer>, 4> MemoryBuffers;
  91   void addOwningBinary(OwningBinary<Binary> OwningBin) {
  92     std::unique_ptr<Binary> Bin;
  93     std::unique_ptr<MemoryBuffer> MemBuf;
  94     std::tie(Bin, MemBuf) = OwningBin.takeBinary();
  95     ParsedBinariesAndObjects.push_back(std::move(Bin));
  96     MemoryBuffers.push_back(std::move(MemBuf));
  97   }
  98
  99   std::map<std::string, std::unique_ptr<SymbolizableModule>> Modules;
 100   std::map<std::pair<MachOUniversalBinary *, std::string>, ObjectFile *>
 101       ObjectFileForArch;
 102   std::map<std::pair<std::string, std::string>, ObjectPair>
 103       ObjectPairForPathArch;
 104
 105   Options Opts;
 106   static const char kBadString[];
 107 };
 108
 109 } // namespace symbolize
 110 } // namespace llvm
 111
 112 #endif