lib/DebugInfo/PDB/PDBContext.cpp

   1 //===-- PDBContext.cpp ------------------------------------------*- 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 #include "llvm/DebugInfo/PDB/PDBContext.h"
  11 #include "llvm/DebugInfo/PDB/IPDBEnumChildren.h"
  12 #include "llvm/DebugInfo/PDB/IPDBLineNumber.h"
  13 #include "llvm/DebugInfo/PDB/IPDBSourceFile.h"
  14 #include "llvm/DebugInfo/PDB/PDBSymbol.h"
  15 #include "llvm/DebugInfo/PDB/PDBSymbolFunc.h"
  16 #include "llvm/DebugInfo/PDB/PDBSymbolData.h"
  17 #include "llvm/DebugInfo/PDB/PDBSymbolPublicSymbol.h"
  18 #include "llvm/Object/COFF.h"
  19
  20 using namespace llvm;
  21 using namespace llvm::object;
  22
  23 PDBContext::PDBContext(const COFFObjectFile &Object,
  24                        std::unique_ptr<IPDBSession> PDBSession)
  25     : DIContext(CK_PDB), Session(std::move(PDBSession)) {
  26   ErrorOr<uint64_t> ImageBase = Object.getImageBase();
  27   if (ImageBase)
  28     Session->setLoadAddress(ImageBase.get());
  29 }
  30
  31 void PDBContext::dump(raw_ostream &OS, DIDumpType DumpType,
  32                       bool DumpEH) {}
  33
  34 DILineInfo PDBContext::getLineInfoForAddress(uint64_t Address,
  35                                              DILineInfoSpecifier Specifier) {
  36   DILineInfo Result;
  37   Result.FunctionName = getFunctionName(Address, Specifier.FNKind);
  38
  39   uint32_t Length = 1;
  40   std::unique_ptr<PDBSymbol> Symbol =
  41       Session->findSymbolByAddress(Address, PDB_SymType::None);
  42   if (auto Func = dyn_cast_or_null<PDBSymbolFunc>(Symbol.get())) {
  43     Length = Func->getLength();
  44   } else if (auto Data = dyn_cast_or_null<PDBSymbolData>(Symbol.get())) {
  45     Length = Data->getLength();
  46   }
  47
  48   // If we couldn't find a symbol, then just assume 1 byte, so that we get
  49   // only the line number of the first instruction.
  50   auto LineNumbers = Session->findLineNumbersByAddress(Address, Length);
  51   if (!LineNumbers || LineNumbers->getChildCount() == 0)
  52     return Result;
  53
  54   auto LineInfo = LineNumbers->getNext();
  55   assert(LineInfo);
  56   auto SourceFile = Session->getSourceFileById(LineInfo->getSourceFileId());
  57
  58   if (SourceFile &&
  59       Specifier.FLIKind != DILineInfoSpecifier::FileLineInfoKind::None)
  60     Result.FileName = SourceFile->getFileName();
  61   Result.Column = LineInfo->getColumnNumber();
  62   Result.Line = LineInfo->getLineNumber();
  63   return Result;
  64 }
  65
  66 DILineInfoTable
  67 PDBContext::getLineInfoForAddressRange(uint64_t Address, uint64_t Size,
  68                                        DILineInfoSpecifier Specifier) {
  69   if (Size == 0)
  70     return DILineInfoTable();
  71
  72   DILineInfoTable Table;
  73   auto LineNumbers = Session->findLineNumbersByAddress(Address, Size);
  74   if (!LineNumbers || LineNumbers->getChildCount() == 0)
  75     return Table;
  76
  77   while (auto LineInfo = LineNumbers->getNext()) {
  78     DILineInfo LineEntry =
  79         getLineInfoForAddress(LineInfo->getVirtualAddress(), Specifier);
  80     Table.push_back(std::make_pair(LineInfo->getVirtualAddress(), LineEntry));
  81   }
  82   return Table;
  83 }
  84
  85 DIInliningInfo
  86 PDBContext::getInliningInfoForAddress(uint64_t Address,
  87                                       DILineInfoSpecifier Specifier) {
  88   DIInliningInfo InlineInfo;
  89   DILineInfo Frame = getLineInfoForAddress(Address, Specifier);
  90   InlineInfo.addFrame(Frame);
  91   return InlineInfo;
  92 }
  93
  94 std::string PDBContext::getFunctionName(uint64_t Address,
  95                                         DINameKind NameKind) const {
  96   if (NameKind == DINameKind::None)
  97     return std::string();
  98
  99   if (NameKind == DINameKind::LinkageName) {
 100     // It is not possible to get the mangled linkage name through a
 101     // PDBSymbolFunc.  For that we have to specifically request a
 102     // PDBSymbolPublicSymbol.
 103     auto PublicSym =
 104         Session->findSymbolByAddress(Address, PDB_SymType::PublicSymbol);
 105     if (auto PS = dyn_cast_or_null<PDBSymbolPublicSymbol>(PublicSym.get()))
 106       return PS->getName();
 107   }
 108
 109   auto FuncSymbol =
 110       Session->findSymbolByAddress(Address, PDB_SymType::Function);
 111
 112   // This could happen either if there was no public symbol (e.g. not
 113   // external) or the user requested the short name.  In the former case,
 114   // although they technically requested the linkage name, if the linkage
 115   // name is not available we fallback to at least returning a non-empty
 116   // string.
 117   if (auto Func = dyn_cast_or_null<PDBSymbolFunc>(FuncSymbol.get()))
 118       return Func->getName();
 119
 120   return std::string();
 121 }