tools/dsymutil/MachODebugMapParser.cpp

   1 //===- tools/dsymutil/MachODebugMapParser.cpp - Parse STABS debug maps ----===//
   2 //
   3 //                             The LLVM Linker
   4 //
   5 // This file is distributed under the University of Illinois Open Source
   6 // License. See LICENSE.TXT for details.
   7 //
   8 //===----------------------------------------------------------------------===//
   9
  10 #include "BinaryHolder.h"
  11 #include "DebugMap.h"
  12 #include "dsymutil.h"
  13 #include "llvm/Object/MachO.h"
  14 #include "llvm/Support/Path.h"
  15 #include "llvm/Support/raw_ostream.h"
  16
  17 namespace {
  18 using namespace llvm;
  19 using namespace llvm::dsymutil;
  20 using namespace llvm::object;
  21
  22 class MachODebugMapParser {
  23 public:
  24   MachODebugMapParser(StringRef BinaryPath, StringRef PathPrefix = "",
  25                       bool Verbose = false)
  26       : BinaryPath(BinaryPath), PathPrefix(PathPrefix),
  27         MainBinaryHolder(Verbose), CurrentObjectHolder(Verbose),
  28         CurrentDebugMapObject(nullptr) {}
  29
  30   /// \brief Parses and returns the DebugMap of the input binary.
  31   /// \returns an error in case the provided BinaryPath doesn't exist
  32   /// or isn't of a supported type.
  33   ErrorOr<std::unique_ptr<DebugMap>> parse();
  34
  35 private:
  36   std::string BinaryPath;
  37   std::string PathPrefix;
  38
  39   /// Owns the MemoryBuffer for the main binary.
  40   BinaryHolder MainBinaryHolder;
  41   /// Map of the binary symbol addresses.
  42   StringMap<uint64_t> MainBinarySymbolAddresses;
  43   StringRef MainBinaryStrings;
  44   /// The constructed DebugMap.
  45   std::unique_ptr<DebugMap> Result;
  46
  47   /// Owns the MemoryBuffer for the currently handled object file.
  48   BinaryHolder CurrentObjectHolder;
  49   /// Map of the currently processed object file symbol addresses.
  50   StringMap<uint64_t> CurrentObjectAddresses;
  51   /// Element of the debug map corresponfing to the current object file.
  52   DebugMapObject *CurrentDebugMapObject;
  53
  54   /// Holds function info while function scope processing.
  55   const char *CurrentFunctionName;
  56   uint64_t CurrentFunctionAddress;
  57
  58   void switchToNewDebugMapObject(StringRef Filename);
  59   void resetParserState();
  60   uint64_t getMainBinarySymbolAddress(StringRef Name);
  61   void loadMainBinarySymbols();
  62   void loadCurrentObjectFileSymbols();
  63   void handleStabSymbolTableEntry(uint32_t StringIndex, uint8_t Type,
  64                                   uint8_t SectionIndex, uint16_t Flags,
  65                                   uint64_t Value);
  66
  67   template <typename STEType> void handleStabDebugMapEntry(const STEType &STE) {
  68     handleStabSymbolTableEntry(STE.n_strx, STE.n_type, STE.n_sect, STE.n_desc,
  69                                STE.n_value);
  70   }
  71 };
  72
  73 static void Warning(const Twine &Msg) { errs() << "warning: " + Msg + "\n"; }
  74 }
  75
  76 /// Reset the parser state coresponding to the current object
  77 /// file. This is to be called after an object file is finished
  78 /// processing.
  79 void MachODebugMapParser::resetParserState() {
  80   CurrentObjectAddresses.clear();
  81   CurrentDebugMapObject = nullptr;
  82 }
  83
  84 /// Create a new DebugMapObject. This function resets the state of the
  85 /// parser that was referring to the last object file and sets
  86 /// everything up to add symbols to the new one.
  87 void MachODebugMapParser::switchToNewDebugMapObject(StringRef Filename) {
  88   resetParserState();
  89
  90   SmallString<80> Path(PathPrefix);
  91   sys::path::append(Path, Filename);
  92
  93   auto MachOOrError = CurrentObjectHolder.GetFileAs<MachOObjectFile>(Path);
  94   if (auto Error = MachOOrError.getError()) {
  95     Warning(Twine("cannot open debug object \"") + Path.str() + "\": " +
  96             Error.message() + "\n");
  97     return;
  98   }
  99
 100   loadCurrentObjectFileSymbols();
 101   CurrentDebugMapObject = &Result->addDebugMapObject(Path);
 102 }
 103
 104 static Triple getTriple(const object::MachOObjectFile &Obj) {
 105   Triple TheTriple("unknown-unknown-unknown");
 106   TheTriple.setArch(Triple::ArchType(Obj.getArch()));
 107   TheTriple.setObjectFormat(Triple::MachO);
 108   return TheTriple;
 109 }
 110
 111 /// This main parsing routine tries to open the main binary and if
 112 /// successful iterates over the STAB entries. The real parsing is
 113 /// done in handleStabSymbolTableEntry.
 114 ErrorOr<std::unique_ptr<DebugMap>> MachODebugMapParser::parse() {
 115   auto MainBinOrError = MainBinaryHolder.GetFileAs<MachOObjectFile>(BinaryPath);
 116   if (auto Error = MainBinOrError.getError())
 117     return Error;
 118
 119   const MachOObjectFile &MainBinary = *MainBinOrError;
 120   loadMainBinarySymbols();
 121   Result = make_unique<DebugMap>(getTriple(MainBinary));
 122   MainBinaryStrings = MainBinary.getStringTableData();
 123   for (const SymbolRef &Symbol : MainBinary.symbols()) {
 124     const DataRefImpl &DRI = Symbol.getRawDataRefImpl();
 125     if (MainBinary.is64Bit())
 126       handleStabDebugMapEntry(MainBinary.getSymbol64TableEntry(DRI));
 127     else
 128       handleStabDebugMapEntry(MainBinary.getSymbolTableEntry(DRI));
 129   }
 130
 131   resetParserState();
 132   return std::move(Result);
 133 }
 134
 135 /// Interpret the STAB entries to fill the DebugMap.
 136 void MachODebugMapParser::handleStabSymbolTableEntry(uint32_t StringIndex,
 137                                                      uint8_t Type,
 138                                                      uint8_t SectionIndex,
 139                                                      uint16_t Flags,
 140                                                      uint64_t Value) {
 141   if (!(Type & MachO::N_STAB))
 142     return;
 143
 144   const char *Name = &MainBinaryStrings.data()[StringIndex];
 145
 146   // An N_OSO entry represents the start of a new object file description.
 147   if (Type == MachO::N_OSO)
 148     return switchToNewDebugMapObject(Name);
 149
 150   // If the last N_OSO object file wasn't found,
 151   // CurrentDebugMapObject will be null. Do not update anything
 152   // until we find the next valid N_OSO entry.
 153   if (!CurrentDebugMapObject)
 154     return;
 155
 156   uint32_t Size = 0;
 157   switch (Type) {
 158   case MachO::N_GSYM:
 159     // This is a global variable. We need to query the main binary
 160     // symbol table to find its address as it might not be in the
 161     // debug map (for common symbols).
 162     Value = getMainBinarySymbolAddress(Name);
 163     if (Value == UnknownAddressOrSize)
 164       return;
 165     break;
 166   case MachO::N_FUN:
 167     // Functions are scopes in STABS. They have an end marker that
 168     // contains the function size.
 169     if (Name[0] == '\0') {
 170       Size = Value;
 171       Value = CurrentFunctionAddress;
 172       Name = CurrentFunctionName;
 173       break;
 174     } else {
 175       CurrentFunctionName = Name;
 176       CurrentFunctionAddress = Value;
 177       return;
 178     }
 179   case MachO::N_STSYM:
 180     break;
 181   default:
 182     return;
 183   }
 184
 185   auto ObjectSymIt = CurrentObjectAddresses.find(Name);
 186   if (ObjectSymIt == CurrentObjectAddresses.end())
 187     return Warning("could not find object file symbol for symbol " +
 188                    Twine(Name));
 189   if (!CurrentDebugMapObject->addSymbol(Name, ObjectSymIt->getValue(), Value,
 190                                         Size))
 191     return Warning(Twine("failed to insert symbol '") + Name +
 192                    "' in the debug map.");
 193 }
 194
 195 /// Load the current object file symbols into CurrentObjectAddresses.
 196 void MachODebugMapParser::loadCurrentObjectFileSymbols() {
 197   CurrentObjectAddresses.clear();
 198
 199   for (auto Sym : CurrentObjectHolder.Get().symbols()) {
 200     StringRef Name;
 201     uint64_t Addr;
 202     if (Sym.getAddress(Addr) || Addr == UnknownAddressOrSize ||
 203         Sym.getName(Name))
 204       continue;
 205     CurrentObjectAddresses[Name] = Addr;
 206   }
 207 }
 208
 209 /// Lookup a symbol address in the main binary symbol table. The
 210 /// parser only needs to query common symbols, thus not every symbol's
 211 /// address is available through this function.
 212 uint64_t MachODebugMapParser::getMainBinarySymbolAddress(StringRef Name) {
 213   auto Sym = MainBinarySymbolAddresses.find(Name);
 214   if (Sym == MainBinarySymbolAddresses.end())
 215     return UnknownAddressOrSize;
 216   return Sym->second;
 217 }
 218
 219 /// Load the interesting main binary symbols' addresses into
 220 /// MainBinarySymbolAddresses.
 221 void MachODebugMapParser::loadMainBinarySymbols() {
 222   const MachOObjectFile &MainBinary = MainBinaryHolder.GetAs<MachOObjectFile>();
 223   section_iterator Section = MainBinary.section_end();
 224   for (const auto &Sym : MainBinary.symbols()) {
 225     SymbolRef::Type Type;
 226     // Skip undefined and STAB entries.
 227     if (Sym.getType(Type) || (Type & SymbolRef::ST_Debug) ||
 228         (Type & SymbolRef::ST_Unknown))
 229       continue;
 230     StringRef Name;
 231     uint64_t Addr;
 232     // The only symbols of interest are the global variables. These
 233     // are the only ones that need to be queried because the address
 234     // of common data won't be described in the debug map. All other
 235     // addresses should be fetched for the debug map.
 236     if (Sym.getAddress(Addr) || Addr == UnknownAddressOrSize ||
 237         !(Sym.getFlags() & SymbolRef::SF_Global) || Sym.getSection(Section) ||
 238         Section->isText() || Sym.getName(Name) || Name.size() == 0 ||
 239         Name[0] == '\0')
 240       continue;
 241     MainBinarySymbolAddresses[Name] = Addr;
 242   }
 243 }
 244
 245 ErrorOr<std::unique_ptr<DebugMap>>
 246 parseYAMLDebugMap(StringRef InputFile, bool Verbose) {
 247   auto ErrOrFile = MemoryBuffer::getFileOrSTDIN(InputFile);
 248   if (auto Err =ErrOrFile.getError())
 249     return Err;
 250
 251   std::unique_ptr<DebugMap> Res;
 252   yaml::Input yin((*ErrOrFile)->getBuffer());
 253   yin >> Res;
 254
 255   if (auto EC = yin.error())
 256     return EC;
 257
 258   return std::move(Res);
 259 }
 260
 261 namespace llvm {
 262 namespace dsymutil {
 263 llvm::ErrorOr<std::unique_ptr<DebugMap>>
 264 parseDebugMap(StringRef InputFile, StringRef PrependPath, bool Verbose, bool InputIsYAML) {
 265   if (!InputIsYAML) {
 266     MachODebugMapParser Parser(InputFile, PrependPath, Verbose);
 267     return Parser.parse();
 268   } else {
 269     return parseYAMLDebugMap(InputFile, Verbose);
 270   }
 271 }
 272 }
 273 }