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