lib/DebugInfo/Symbolize/Symbolize.cpp

   1 //===-- LLVMSymbolize.cpp -------------------------------------------------===//
   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 // Implementation for LLVM symbolization library.
  11 //
  12 //===----------------------------------------------------------------------===//
  13
  14 #include "llvm/DebugInfo/Symbolize/Symbolize.h"
  15
  16 #include "llvm/ADT/STLExtras.h"
  17 #include "llvm/Config/config.h"
  18 #include "llvm/DebugInfo/DWARF/DWARFContext.h"
  19 #include "llvm/DebugInfo/PDB/PDB.h"
  20 #include "llvm/DebugInfo/PDB/PDBContext.h"
  21 #include "llvm/Object/ELFObjectFile.h"
  22 #include "llvm/Object/MachO.h"
  23 #include "llvm/Object/SymbolSize.h"
  24 #include "llvm/Support/COFF.h"
  25 #include "llvm/Support/Casting.h"
  26 #include "llvm/Support/Compression.h"
  27 #include "llvm/Support/DataExtractor.h"
  28 #include "llvm/Support/Errc.h"
  29 #include "llvm/Support/FileSystem.h"
  30 #include "llvm/Support/MemoryBuffer.h"
  31 #include "llvm/Support/Path.h"
  32 #include <sstream>
  33 #include <stdlib.h>
  34
  35 #if defined(_MSC_VER)
  36 #include <Windows.h>
  37 #include <DbgHelp.h>
  38 #pragma comment(lib, "dbghelp.lib")
  39
  40 // Windows.h conflicts with our COFF header definitions.
  41 #ifdef IMAGE_FILE_MACHINE_I386
  42 #undef IMAGE_FILE_MACHINE_I386
  43 #endif
  44 #endif
  45
  46 namespace llvm {
  47 namespace symbolize {
  48
  49 // FIXME: Move this to llvm-symbolizer tool.
  50 static bool error(std::error_code ec) {
  51   if (!ec)
  52     return false;
  53   errs() << "LLVMSymbolizer: error reading file: " << ec.message() << ".\n";
  54   return true;
  55 }
  56
  57 static DILineInfoSpecifier
  58 getDILineInfoSpecifier(const LLVMSymbolizer::Options &Opts) {
  59   return DILineInfoSpecifier(
  60       DILineInfoSpecifier::FileLineInfoKind::AbsoluteFilePath,
  61       Opts.PrintFunctions);
  62 }
  63
  64 ModuleInfo::ModuleInfo(ObjectFile *Obj, DIContext *DICtx)
  65     : Module(Obj), DebugInfoContext(DICtx) {
  66   std::unique_ptr<DataExtractor> OpdExtractor;
  67   uint64_t OpdAddress = 0;
  68   // Find the .opd (function descriptor) section if any, for big-endian
  69   // PowerPC64 ELF.
  70   if (Module->getArch() == Triple::ppc64) {
  71     for (section_iterator Section : Module->sections()) {
  72       StringRef Name;
  73       if (!error(Section->getName(Name)) && Name == ".opd") {
  74         StringRef Data;
  75         if (!error(Section->getContents(Data))) {
  76           OpdExtractor.reset(new DataExtractor(Data, Module->isLittleEndian(),
  77                                                Module->getBytesInAddress()));
  78           OpdAddress = Section->getAddress();
  79         }
  80         break;
  81       }
  82     }
  83   }
  84   std::vector<std::pair<SymbolRef, uint64_t>> Symbols =
  85       computeSymbolSizes(*Module);
  86   for (auto &P : Symbols)
  87     addSymbol(P.first, P.second, OpdExtractor.get(), OpdAddress);
  88
  89   // If this is a COFF object and we didn't find any symbols, try the export
  90   // table.
  91   if (Symbols.empty()) {
  92     if (auto *CoffObj = dyn_cast<COFFObjectFile>(Obj))
  93       addCoffExportSymbols(CoffObj);
  94   }
  95 }
  96
  97 namespace {
  98 struct OffsetNamePair {
  99   uint32_t Offset;
 100   StringRef Name;
 101   bool operator<(const OffsetNamePair &R) const {
 102     return Offset < R.Offset;
 103   }
 104 };
 105 }
 106
 107 void ModuleInfo::addCoffExportSymbols(const COFFObjectFile *CoffObj) {
 108   // Get all export names and offsets.
 109   std::vector<OffsetNamePair> ExportSyms;
 110   for (const ExportDirectoryEntryRef &Ref : CoffObj->export_directories()) {
 111     StringRef Name;
 112     uint32_t Offset;
 113     if (error(Ref.getSymbolName(Name)) || error(Ref.getExportRVA(Offset)))
 114       return;
 115     ExportSyms.push_back(OffsetNamePair{Offset, Name});
 116   }
 117   if (ExportSyms.empty())
 118     return;
 119
 120   // Sort by ascending offset.
 121   array_pod_sort(ExportSyms.begin(), ExportSyms.end());
 122
 123   // Approximate the symbol sizes by assuming they run to the next symbol.
 124   // FIXME: This assumes all exports are functions.
 125   uint64_t ImageBase = CoffObj->getImageBase();
 126   for (auto I = ExportSyms.begin(), E = ExportSyms.end(); I != E; ++I) {
 127     OffsetNamePair &Export = *I;
 128     // FIXME: The last export has a one byte size now.
 129     uint32_t NextOffset = I != E ? I->Offset : Export.Offset + 1;
 130     uint64_t SymbolStart = ImageBase + Export.Offset;
 131     uint64_t SymbolSize = NextOffset - Export.Offset;
 132     SymbolDesc SD = {SymbolStart, SymbolSize};
 133     Functions.insert(std::make_pair(SD, Export.Name));
 134   }
 135 }
 136
 137 void ModuleInfo::addSymbol(const SymbolRef &Symbol, uint64_t SymbolSize,
 138                            DataExtractor *OpdExtractor, uint64_t OpdAddress) {
 139   SymbolRef::Type SymbolType = Symbol.getType();
 140   if (SymbolType != SymbolRef::ST_Function && SymbolType != SymbolRef::ST_Data)
 141     return;
 142   ErrorOr<uint64_t> SymbolAddressOrErr = Symbol.getAddress();
 143   if (error(SymbolAddressOrErr.getError()))
 144     return;
 145   uint64_t SymbolAddress = *SymbolAddressOrErr;
 146   if (OpdExtractor) {
 147     // For big-endian PowerPC64 ELF, symbols in the .opd section refer to
 148     // function descriptors. The first word of the descriptor is a pointer to
 149     // the function's code.
 150     // For the purposes of symbolization, pretend the symbol's address is that
 151     // of the function's code, not the descriptor.
 152     uint64_t OpdOffset = SymbolAddress - OpdAddress;
 153     uint32_t OpdOffset32 = OpdOffset;
 154     if (OpdOffset == OpdOffset32 &&
 155         OpdExtractor->isValidOffsetForAddress(OpdOffset32))
 156       SymbolAddress = OpdExtractor->getAddress(&OpdOffset32);
 157   }
 158   ErrorOr<StringRef> SymbolNameOrErr = Symbol.getName();
 159   if (error(SymbolNameOrErr.getError()))
 160     return;
 161   StringRef SymbolName = *SymbolNameOrErr;
 162   // Mach-O symbol table names have leading underscore, skip it.
 163   if (Module->isMachO() && SymbolName.size() > 0 && SymbolName[0] == '_')
 164     SymbolName = SymbolName.drop_front();
 165   // FIXME: If a function has alias, there are two entries in symbol table
 166   // with same address size. Make sure we choose the correct one.
 167   auto &M = SymbolType == SymbolRef::ST_Function ? Functions : Objects;
 168   SymbolDesc SD = { SymbolAddress, SymbolSize };
 169   M.insert(std::make_pair(SD, SymbolName));
 170 }
 171
 172 // Return true if this is a 32-bit x86 PE COFF module.
 173 bool ModuleInfo::isWin32Module() const {
 174   auto *CoffObject = dyn_cast<COFFObjectFile>(Module);
 175   return CoffObject && CoffObject->getMachine() == COFF::IMAGE_FILE_MACHINE_I386;
 176 }
 177
 178 uint64_t ModuleInfo::getModulePreferredBase() const {
 179   if (auto *CoffObject = dyn_cast<COFFObjectFile>(Module))
 180     return CoffObject->getImageBase();
 181   return 0;
 182 }
 183
 184 bool ModuleInfo::getNameFromSymbolTable(SymbolRef::Type Type, uint64_t Address,
 185                                         std::string &Name, uint64_t &Addr,
 186                                         uint64_t &Size) const {
 187   const auto &SymbolMap = Type == SymbolRef::ST_Function ? Functions : Objects;
 188   if (SymbolMap.empty())
 189     return false;
 190   SymbolDesc SD = { Address, Address };
 191   auto SymbolIterator = SymbolMap.upper_bound(SD);
 192   if (SymbolIterator == SymbolMap.begin())
 193     return false;
 194   --SymbolIterator;
 195   if (SymbolIterator->first.Size != 0 &&
 196       SymbolIterator->first.Addr + SymbolIterator->first.Size <= Address)
 197     return false;
 198   Name = SymbolIterator->second.str();
 199   Addr = SymbolIterator->first.Addr;
 200   Size = SymbolIterator->first.Size;
 201   return true;
 202 }
 203
 204 DILineInfo ModuleInfo::symbolizeCode(
 205     uint64_t ModuleOffset, const LLVMSymbolizer::Options &Opts) const {
 206   DILineInfo LineInfo;
 207   if (DebugInfoContext) {
 208     LineInfo = DebugInfoContext->getLineInfoForAddress(
 209         ModuleOffset, getDILineInfoSpecifier(Opts));
 210   }
 211   // Override function name from symbol table if necessary.
 212   if (Opts.PrintFunctions != FunctionNameKind::None && Opts.UseSymbolTable) {
 213     std::string FunctionName;
 214     uint64_t Start, Size;
 215     if (getNameFromSymbolTable(SymbolRef::ST_Function, ModuleOffset,
 216                                FunctionName, Start, Size)) {
 217       LineInfo.FunctionName = FunctionName;
 218     }
 219   }
 220   return LineInfo;
 221 }
 222
 223 DIInliningInfo ModuleInfo::symbolizeInlinedCode(
 224     uint64_t ModuleOffset, const LLVMSymbolizer::Options &Opts) const {
 225   DIInliningInfo InlinedContext;
 226
 227   if (DebugInfoContext) {
 228     InlinedContext = DebugInfoContext->getInliningInfoForAddress(
 229         ModuleOffset, getDILineInfoSpecifier(Opts));
 230   }
 231   // Make sure there is at least one frame in context.
 232   if (InlinedContext.getNumberOfFrames() == 0) {
 233     InlinedContext.addFrame(DILineInfo());
 234   }
 235   // Override the function name in lower frame with name from symbol table.
 236   if (Opts.PrintFunctions != FunctionNameKind::None && Opts.UseSymbolTable) {
 237     DIInliningInfo PatchedInlinedContext;
 238     for (uint32_t i = 0, n = InlinedContext.getNumberOfFrames(); i < n; i++) {
 239       DILineInfo LineInfo = InlinedContext.getFrame(i);
 240       if (i == n - 1) {
 241         std::string FunctionName;
 242         uint64_t Start, Size;
 243         if (getNameFromSymbolTable(SymbolRef::ST_Function, ModuleOffset,
 244                                    FunctionName, Start, Size)) {
 245           LineInfo.FunctionName = FunctionName;
 246         }
 247       }
 248       PatchedInlinedContext.addFrame(LineInfo);
 249     }
 250     InlinedContext = PatchedInlinedContext;
 251   }
 252   return InlinedContext;
 253 }
 254
 255 bool ModuleInfo::symbolizeData(uint64_t ModuleOffset, std::string &Name,
 256                                uint64_t &Start, uint64_t &Size) const {
 257   return getNameFromSymbolTable(SymbolRef::ST_Data, ModuleOffset, Name, Start,
 258                                 Size);
 259 }
 260
 261 const char LLVMSymbolizer::kBadString[] = "??";
 262
 263 std::string LLVMSymbolizer::symbolizeCode(const std::string &ModuleName,
 264                                           uint64_t ModuleOffset) {
 265   ModuleInfo *Info = getOrCreateModuleInfo(ModuleName);
 266   if (!Info)
 267     return printDILineInfo(DILineInfo(), Info);
 268
 269   // If the user is giving us relative addresses, add the preferred base of the
 270   // object to the offset before we do the query. It's what DIContext expects.
 271   if (Opts.RelativeAddresses)
 272     ModuleOffset += Info->getModulePreferredBase();
 273
 274   if (Opts.PrintInlining) {
 275     DIInliningInfo InlinedContext =
 276         Info->symbolizeInlinedCode(ModuleOffset, Opts);
 277     uint32_t FramesNum = InlinedContext.getNumberOfFrames();
 278     assert(FramesNum > 0);
 279     std::string Result;
 280     for (uint32_t i = 0; i < FramesNum; i++) {
 281       DILineInfo LineInfo = InlinedContext.getFrame(i);
 282       Result += printDILineInfo(LineInfo, Info);
 283     }
 284     return Result;
 285   }
 286   DILineInfo LineInfo = Info->symbolizeCode(ModuleOffset, Opts);
 287   return printDILineInfo(LineInfo, Info);
 288 }
 289
 290 std::string LLVMSymbolizer::symbolizeData(const std::string &ModuleName,
 291                                           uint64_t ModuleOffset) {
 292   std::string Name = kBadString;
 293   uint64_t Start = 0;
 294   uint64_t Size = 0;
 295   if (Opts.UseSymbolTable) {
 296     if (ModuleInfo *Info = getOrCreateModuleInfo(ModuleName)) {
 297       // If the user is giving us relative addresses, add the preferred base of the
 298       // object to the offset before we do the query. It's what DIContext expects.
 299       if (Opts.RelativeAddresses)
 300         ModuleOffset += Info->getModulePreferredBase();
 301       if (Info->symbolizeData(ModuleOffset, Name, Start, Size) && Opts.Demangle)
 302         Name = DemangleName(Name, Info);
 303     }
 304   }
 305   std::stringstream ss;
 306   ss << Name << "\n" << Start << " " << Size << "\n";
 307   return ss.str();
 308 }
 309
 310 void LLVMSymbolizer::flush() {
 311   DeleteContainerSeconds(Modules);
 312   ObjectPairForPathArch.clear();
 313   ObjectFileForArch.clear();
 314 }
 315
 316 // For Path="/path/to/foo" and Basename="foo" assume that debug info is in
 317 // /path/to/foo.dSYM/Contents/Resources/DWARF/foo.
 318 // For Path="/path/to/bar.dSYM" and Basename="foo" assume that debug info is in
 319 // /path/to/bar.dSYM/Contents/Resources/DWARF/foo.
 320 static
 321 std::string getDarwinDWARFResourceForPath(
 322     const std::string &Path, const std::string &Basename) {
 323   SmallString<16> ResourceName = StringRef(Path);
 324   if (sys::path::extension(Path) != ".dSYM") {
 325     ResourceName += ".dSYM";
 326   }
 327   sys::path::append(ResourceName, "Contents", "Resources", "DWARF");
 328   sys::path::append(ResourceName, Basename);
 329   return ResourceName.str();
 330 }
 331
 332 static bool checkFileCRC(StringRef Path, uint32_t CRCHash) {
 333   ErrorOr<std::unique_ptr<MemoryBuffer>> MB =
 334       MemoryBuffer::getFileOrSTDIN(Path);
 335   if (!MB)
 336     return false;
 337   return !zlib::isAvailable() || CRCHash == zlib::crc32(MB.get()->getBuffer());
 338 }
 339
 340 static bool findDebugBinary(const std::string &OrigPath,
 341                             const std::string &DebuglinkName, uint32_t CRCHash,
 342                             std::string &Result) {
 343   std::string OrigRealPath = OrigPath;
 344 #if defined(HAVE_REALPATH)
 345   if (char *RP = realpath(OrigPath.c_str(), nullptr)) {
 346     OrigRealPath = RP;
 347     free(RP);
 348   }
 349 #endif
 350   SmallString<16> OrigDir(OrigRealPath);
 351   llvm::sys::path::remove_filename(OrigDir);
 352   SmallString<16> DebugPath = OrigDir;
 353   // Try /path/to/original_binary/debuglink_name
 354   llvm::sys::path::append(DebugPath, DebuglinkName);
 355   if (checkFileCRC(DebugPath, CRCHash)) {
 356     Result = DebugPath.str();
 357     return true;
 358   }
 359   // Try /path/to/original_binary/.debug/debuglink_name
 360   DebugPath = OrigRealPath;
 361   llvm::sys::path::append(DebugPath, ".debug", DebuglinkName);
 362   if (checkFileCRC(DebugPath, CRCHash)) {
 363     Result = DebugPath.str();
 364     return true;
 365   }
 366   // Try /usr/lib/debug/path/to/original_binary/debuglink_name
 367   DebugPath = "/usr/lib/debug";
 368   llvm::sys::path::append(DebugPath, llvm::sys::path::relative_path(OrigDir),
 369                           DebuglinkName);
 370   if (checkFileCRC(DebugPath, CRCHash)) {
 371     Result = DebugPath.str();
 372     return true;
 373   }
 374   return false;
 375 }
 376
 377 static bool getGNUDebuglinkContents(const ObjectFile *Obj, std::string &DebugName,
 378                                     uint32_t &CRCHash) {
 379   if (!Obj)
 380     return false;
 381   for (const SectionRef &Section : Obj->sections()) {
 382     StringRef Name;
 383     Section.getName(Name);
 384     Name = Name.substr(Name.find_first_not_of("._"));
 385     if (Name == "gnu_debuglink") {
 386       StringRef Data;
 387       Section.getContents(Data);
 388       DataExtractor DE(Data, Obj->isLittleEndian(), 0);
 389       uint32_t Offset = 0;
 390       if (const char *DebugNameStr = DE.getCStr(&Offset)) {
 391         // 4-byte align the offset.
 392         Offset = (Offset + 3) & ~0x3;
 393         if (DE.isValidOffsetForDataOfSize(Offset, 4)) {
 394           DebugName = DebugNameStr;
 395           CRCHash = DE.getU32(&Offset);
 396           return true;
 397         }
 398       }
 399       break;
 400     }
 401   }
 402   return false;
 403 }
 404
 405 static
 406 bool darwinDsymMatchesBinary(const MachOObjectFile *DbgObj,
 407                              const MachOObjectFile *Obj) {
 408   ArrayRef<uint8_t> dbg_uuid = DbgObj->getUuid();
 409   ArrayRef<uint8_t> bin_uuid = Obj->getUuid();
 410   if (dbg_uuid.empty() || bin_uuid.empty())
 411     return false;
 412   return !memcmp(dbg_uuid.data(), bin_uuid.data(), dbg_uuid.size());
 413 }
 414
 415 ObjectFile *LLVMSymbolizer::lookUpDsymFile(const std::string &ExePath,
 416     const MachOObjectFile *MachExeObj, const std::string &ArchName) {
 417   // On Darwin we may find DWARF in separate object file in
 418   // resource directory.
 419   std::vector<std::string> DsymPaths;
 420   StringRef Filename = sys::path::filename(ExePath);
 421   DsymPaths.push_back(getDarwinDWARFResourceForPath(ExePath, Filename));
 422   for (const auto &Path : Opts.DsymHints) {
 423     DsymPaths.push_back(getDarwinDWARFResourceForPath(Path, Filename));
 424   }
 425   for (const auto &path : DsymPaths) {
 426     ErrorOr<OwningBinary<Binary>> BinaryOrErr = createBinary(path);
 427     std::error_code EC = BinaryOrErr.getError();
 428     if (EC != errc::no_such_file_or_directory && !error(EC)) {
 429       OwningBinary<Binary> B = std::move(BinaryOrErr.get());
 430       ObjectFile *DbgObj =
 431           getObjectFileFromBinary(B.getBinary(), ArchName);
 432       const MachOObjectFile *MachDbgObj =
 433           dyn_cast<const MachOObjectFile>(DbgObj);
 434       if (!MachDbgObj) continue;
 435       if (darwinDsymMatchesBinary(MachDbgObj, MachExeObj)) {
 436         addOwningBinary(std::move(B));
 437         return DbgObj;
 438       }
 439     }
 440   }
 441   return nullptr;
 442 }
 443
 444 LLVMSymbolizer::ObjectPair
 445 LLVMSymbolizer::getOrCreateObjects(const std::string &Path,
 446                                    const std::string &ArchName) {
 447   const auto &I = ObjectPairForPathArch.find(std::make_pair(Path, ArchName));
 448   if (I != ObjectPairForPathArch.end())
 449     return I->second;
 450   ObjectFile *Obj = nullptr;
 451   ObjectFile *DbgObj = nullptr;
 452   ErrorOr<OwningBinary<Binary>> BinaryOrErr = createBinary(Path);
 453   if (!error(BinaryOrErr.getError())) {
 454     OwningBinary<Binary> &B = BinaryOrErr.get();
 455     Obj = getObjectFileFromBinary(B.getBinary(), ArchName);
 456     if (!Obj) {
 457       ObjectPair Res = std::make_pair(nullptr, nullptr);
 458       ObjectPairForPathArch[std::make_pair(Path, ArchName)] = Res;
 459       return Res;
 460     }
 461     addOwningBinary(std::move(B));
 462     if (auto MachObj = dyn_cast<const MachOObjectFile>(Obj))
 463       DbgObj = lookUpDsymFile(Path, MachObj, ArchName);
 464     // Try to locate the debug binary using .gnu_debuglink section.
 465     if (!DbgObj) {
 466       std::string DebuglinkName;
 467       uint32_t CRCHash;
 468       std::string DebugBinaryPath;
 469       if (getGNUDebuglinkContents(Obj, DebuglinkName, CRCHash) &&
 470           findDebugBinary(Path, DebuglinkName, CRCHash, DebugBinaryPath)) {
 471         BinaryOrErr = createBinary(DebugBinaryPath);
 472         if (!error(BinaryOrErr.getError())) {
 473           OwningBinary<Binary> B = std::move(BinaryOrErr.get());
 474           DbgObj = getObjectFileFromBinary(B.getBinary(), ArchName);
 475           addOwningBinary(std::move(B));
 476         }
 477       }
 478     }
 479   }
 480   if (!DbgObj)
 481     DbgObj = Obj;
 482   ObjectPair Res = std::make_pair(Obj, DbgObj);
 483   ObjectPairForPathArch[std::make_pair(Path, ArchName)] = Res;
 484   return Res;
 485 }
 486
 487 ObjectFile *
 488 LLVMSymbolizer::getObjectFileFromBinary(Binary *Bin,
 489                                         const std::string &ArchName) {
 490   if (!Bin)
 491     return nullptr;
 492   ObjectFile *Res = nullptr;
 493   if (MachOUniversalBinary *UB = dyn_cast<MachOUniversalBinary>(Bin)) {
 494     const auto &I = ObjectFileForArch.find(
 495         std::make_pair(UB, ArchName));
 496     if (I != ObjectFileForArch.end())
 497       return I->second;
 498     ErrorOr<std::unique_ptr<ObjectFile>> ParsedObj =
 499         UB->getObjectForArch(ArchName);
 500     if (ParsedObj) {
 501       Res = ParsedObj.get().get();
 502       ParsedBinariesAndObjects.push_back(std::move(ParsedObj.get()));
 503     }
 504     ObjectFileForArch[std::make_pair(UB, ArchName)] = Res;
 505   } else if (Bin->isObject()) {
 506     Res = cast<ObjectFile>(Bin);
 507   }
 508   return Res;
 509 }
 510
 511 ModuleInfo *
 512 LLVMSymbolizer::getOrCreateModuleInfo(const std::string &ModuleName) {
 513   const auto &I = Modules.find(ModuleName);
 514   if (I != Modules.end())
 515     return I->second;
 516   std::string BinaryName = ModuleName;
 517   std::string ArchName = Opts.DefaultArch;
 518   size_t ColonPos = ModuleName.find_last_of(':');
 519   // Verify that substring after colon form a valid arch name.
 520   if (ColonPos != std::string::npos) {
 521     std::string ArchStr = ModuleName.substr(ColonPos + 1);
 522     if (Triple(ArchStr).getArch() != Triple::UnknownArch) {
 523       BinaryName = ModuleName.substr(0, ColonPos);
 524       ArchName = ArchStr;
 525     }
 526   }
 527   ObjectPair Objects = getOrCreateObjects(BinaryName, ArchName);
 528
 529   if (!Objects.first) {
 530     // Failed to find valid object file.
 531     Modules.insert(make_pair(ModuleName, (ModuleInfo *)nullptr));
 532     return nullptr;
 533   }
 534   DIContext *Context = nullptr;
 535   if (auto CoffObject = dyn_cast<COFFObjectFile>(Objects.first)) {
 536     // If this is a COFF object, assume it contains PDB debug information.  If
 537     // we don't find any we will fall back to the DWARF case.
 538     std::unique_ptr<IPDBSession> Session;
 539     PDB_ErrorCode Error = loadDataForEXE(PDB_ReaderType::DIA,
 540                                          Objects.first->getFileName(), Session);
 541     if (Error == PDB_ErrorCode::Success) {
 542       Context = new PDBContext(*CoffObject, std::move(Session));
 543     }
 544   }
 545   if (!Context)
 546     Context = new DWARFContextInMemory(*Objects.second);
 547   assert(Context);
 548   ModuleInfo *Info = new ModuleInfo(Objects.first, Context);
 549   Modules.insert(make_pair(ModuleName, Info));
 550   return Info;
 551 }
 552
 553 std::string LLVMSymbolizer::printDILineInfo(DILineInfo LineInfo,
 554                                             ModuleInfo *ModInfo) const {
 555   // By default, DILineInfo contains "<invalid>" for function/filename it
 556   // cannot fetch. We replace it to "??" to make our output closer to addr2line.
 557   static const std::string kDILineInfoBadString = "<invalid>";
 558   std::stringstream Result;
 559   if (Opts.PrintFunctions != FunctionNameKind::None) {
 560     std::string FunctionName = LineInfo.FunctionName;
 561     if (FunctionName == kDILineInfoBadString)
 562       FunctionName = kBadString;
 563     else if (Opts.Demangle)
 564       FunctionName = DemangleName(FunctionName, ModInfo);
 565     Result << FunctionName << "\n";
 566   }
 567   std::string Filename = LineInfo.FileName;
 568   if (Filename == kDILineInfoBadString)
 569     Filename = kBadString;
 570   Result << Filename << ":" << LineInfo.Line << ":" << LineInfo.Column << "\n";
 571   return Result.str();
 572 }
 573
 574 // Undo these various manglings for Win32 extern "C" functions:
 575 // cdecl       - _foo
 576 // stdcall     - _foo@12
 577 // fastcall    - @foo@12
 578 // vectorcall  - foo@@12
 579 // These are all different linkage names for 'foo'.
 580 static StringRef demanglePE32ExternCFunc(StringRef SymbolName) {
 581   // Remove any '_' or '@' prefix.
 582   char Front = SymbolName.empty() ? '\0' : SymbolName[0];
 583   if (Front == '_' || Front == '@')
 584     SymbolName = SymbolName.drop_front();
 585
 586   // Remove any '@[0-9]+' suffix.
 587   if (Front != '?') {
 588     size_t AtPos = SymbolName.rfind('@');
 589     if (AtPos != StringRef::npos &&
 590         std::all_of(SymbolName.begin() + AtPos + 1, SymbolName.end(),
 591                     [](char C) { return C >= '0' && C <= '9'; })) {
 592       SymbolName = SymbolName.substr(0, AtPos);
 593     }
 594   }
 595
 596   // Remove any ending '@' for vectorcall.
 597   if (SymbolName.endswith("@"))
 598     SymbolName = SymbolName.drop_back();
 599
 600   return SymbolName;
 601 }
 602
 603 #if !defined(_MSC_VER)
 604 // Assume that __cxa_demangle is provided by libcxxabi (except for Windows).
 605 extern "C" char *__cxa_demangle(const char *mangled_name, char *output_buffer,
 606                                 size_t *length, int *status);
 607 #endif
 608
 609 std::string LLVMSymbolizer::DemangleName(const std::string &Name,
 610                                          ModuleInfo *ModInfo) {
 611 #if !defined(_MSC_VER)
 612   // We can spoil names of symbols with C linkage, so use an heuristic
 613   // approach to check if the name should be demangled.
 614   if (Name.substr(0, 2) == "_Z") {
 615     int status = 0;
 616     char *DemangledName = __cxa_demangle(Name.c_str(), nullptr, nullptr, &status);
 617     if (status != 0)
 618       return Name;
 619     std::string Result = DemangledName;
 620     free(DemangledName);
 621     return Result;
 622   }
 623 #else
 624   if (!Name.empty() && Name.front() == '?') {
 625     // Only do MSVC C++ demangling on symbols starting with '?'.
 626     char DemangledName[1024] = {0};
 627     DWORD result = ::UnDecorateSymbolName(
 628         Name.c_str(), DemangledName, 1023,
 629         UNDNAME_NO_ACCESS_SPECIFIERS |       // Strip public, private, protected
 630             UNDNAME_NO_ALLOCATION_LANGUAGE | // Strip __thiscall, __stdcall, etc
 631             UNDNAME_NO_THROW_SIGNATURES |    // Strip throw() specifications
 632             UNDNAME_NO_MEMBER_TYPE | // Strip virtual, static, etc specifiers
 633             UNDNAME_NO_MS_KEYWORDS | // Strip all MS extension keywords
 634             UNDNAME_NO_FUNCTION_RETURNS); // Strip function return types
 635     return (result == 0) ? Name : std::string(DemangledName);
 636   }
 637 #endif
 638   if (ModInfo->isWin32Module())
 639     return std::string(demanglePE32ExternCFunc(Name));
 640   return Name;
 641 }
 642
 643 } // namespace symbolize
 644 } // namespace llvm