lib/MC/MCObjectSymbolizer.cpp

   1 //===-- lib/MC/MCObjectSymbolizer.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 #include "llvm/MC/MCObjectSymbolizer.h"
  11 #include "llvm/ADT/SmallString.h"
  12 #include "llvm/MC/MCContext.h"
  13 #include "llvm/MC/MCExpr.h"
  14 #include "llvm/MC/MCInst.h"
  15 #include "llvm/MC/MCRelocationInfo.h"
  16 #include "llvm/MC/MCSymbol.h"
  17 #include "llvm/Object/ELFObjectFile.h"
  18 #include "llvm/Object/MachO.h"
  19 #include "llvm/Support/raw_ostream.h"
  20 #include <algorithm>
  21
  22 using namespace llvm;
  23 using namespace object;
  24
  25 //===- MCMachObjectSymbolizer ---------------------------------------------===//
  26
  27 namespace {
  28 class MCMachObjectSymbolizer : public MCObjectSymbolizer {
  29   const MachOObjectFile *MOOF;
  30   // __TEXT;__stubs support.
  31   uint64_t StubsStart;
  32   uint64_t StubsCount;
  33   uint64_t StubSize;
  34   uint64_t StubsIndSymIndex;
  35
  36 public:
  37   MCMachObjectSymbolizer(MCContext &Ctx,
  38                          std::unique_ptr<MCRelocationInfo> &RelInfo,
  39                          const MachOObjectFile *MOOF);
  40
  41   StringRef findExternalFunctionAt(uint64_t Addr) override;
  42
  43   void tryAddingPcLoadReferenceComment(raw_ostream &cStream, int64_t Value,
  44                                        uint64_t Address) override;
  45 };
  46 } // End unnamed namespace
  47
  48 MCMachObjectSymbolizer::MCMachObjectSymbolizer(
  49     MCContext &Ctx, std::unique_ptr<MCRelocationInfo> &RelInfo,
  50     const MachOObjectFile *MOOF)
  51     : MCObjectSymbolizer(Ctx, RelInfo, MOOF), MOOF(MOOF), StubsStart(0),
  52       StubsCount(0), StubSize(0), StubsIndSymIndex(0) {
  53
  54   for (const SectionRef &Section : MOOF->sections()) {
  55     StringRef Name;
  56     Section.getName(Name);
  57     if (Name == "__stubs") {
  58       SectionRef StubsSec = Section;
  59       if (MOOF->is64Bit()) {
  60         MachO::section_64 S = MOOF->getSection64(StubsSec.getRawDataRefImpl());
  61         StubsIndSymIndex = S.reserved1;
  62         StubSize = S.reserved2;
  63       } else {
  64         MachO::section S = MOOF->getSection(StubsSec.getRawDataRefImpl());
  65         StubsIndSymIndex = S.reserved1;
  66         StubSize = S.reserved2;
  67       }
  68       assert(StubSize && "Mach-O stub entry size can't be zero!");
  69       StubsSec.getAddress(StubsStart);
  70       StubsSec.getSize(StubsCount);
  71       StubsCount /= StubSize;
  72     }
  73   }
  74 }
  75
  76 StringRef MCMachObjectSymbolizer::findExternalFunctionAt(uint64_t Addr) {
  77   // FIXME: also, this can all be done at the very beginning, by iterating over
  78   // all stubs and creating the calls to outside functions. Is it worth it
  79   // though?
  80   if (!StubSize)
  81     return StringRef();
  82   uint64_t StubIdx = (Addr - StubsStart) / StubSize;
  83   if (StubIdx >= StubsCount)
  84     return StringRef();
  85
  86   uint32_t SymtabIdx =
  87     MOOF->getIndirectSymbolTableEntry(MOOF->getDysymtabLoadCommand(), StubIdx);
  88
  89   StringRef SymName;
  90   symbol_iterator SI = MOOF->symbol_begin();
  91   for (uint32_t i = 0; i != SymtabIdx; ++i)
  92     ++SI;
  93   SI->getName(SymName);
  94   assert(SI != MOOF->symbol_end() && "Stub wasn't found in the symbol table!");
  95   assert(SymName.front() == '_' && "Mach-O symbol doesn't start with '_'!");
  96   return SymName.substr(1);
  97 }
  98
  99 void MCMachObjectSymbolizer::
 100 tryAddingPcLoadReferenceComment(raw_ostream &cStream, int64_t Value,
 101                                 uint64_t Address) {
 102   if (const RelocationRef *R = findRelocationAt(Address)) {
 103     const MCExpr *RelExpr = RelInfo->createExprForRelocation(*R);
 104     if (!RelExpr || RelExpr->EvaluateAsAbsolute(Value) == false)
 105       return;
 106   }
 107   uint64_t Addr = Value;
 108   if (const SectionRef *S = findSectionContaining(Addr)) {
 109     StringRef Name; S->getName(Name);
 110     uint64_t SAddr; S->getAddress(SAddr);
 111     if (Name == "__cstring") {
 112       StringRef Contents;
 113       S->getContents(Contents);
 114       Contents = Contents.substr(Addr - SAddr);
 115       cStream << " ## literal pool for: "
 116               << Contents.substr(0, Contents.find_first_of(0));
 117     }
 118   }
 119 }
 120
 121 //===- MCObjectSymbolizer -------------------------------------------------===//
 122
 123 MCObjectSymbolizer::MCObjectSymbolizer(
 124     MCContext &Ctx, std::unique_ptr<MCRelocationInfo> &RelInfo,
 125     const ObjectFile *Obj)
 126     : MCSymbolizer(Ctx, RelInfo), Obj(Obj), SortedSections(), AddrToReloc() {}
 127
 128 bool MCObjectSymbolizer::
 129 tryAddingSymbolicOperand(MCInst &MI, raw_ostream &cStream,
 130                          int64_t Value, uint64_t Address, bool IsBranch,
 131                          uint64_t Offset, uint64_t InstSize) {
 132   if (IsBranch) {
 133     StringRef ExtFnName = findExternalFunctionAt((uint64_t)Value);
 134     if (!ExtFnName.empty()) {
 135       MCSymbol *Sym = Ctx.GetOrCreateSymbol(ExtFnName);
 136       const MCExpr *Expr = MCSymbolRefExpr::Create(Sym, Ctx);
 137       MI.addOperand(MCOperand::CreateExpr(Expr));
 138       return true;
 139     }
 140   }
 141
 142   if (const RelocationRef *R = findRelocationAt(Address + Offset)) {
 143     if (const MCExpr *RelExpr = RelInfo->createExprForRelocation(*R)) {
 144       MI.addOperand(MCOperand::CreateExpr(RelExpr));
 145       return true;
 146     }
 147     // Only try to create a symbol+offset expression if there is no relocation.
 148     return false;
 149   }
 150
 151   // Interpret Value as a branch target.
 152   if (IsBranch == false)
 153     return false;
 154   uint64_t UValue = Value;
 155   // FIXME: map instead of looping each time?
 156   for (const SymbolRef &Symbol : Obj->symbols()) {
 157     uint64_t SymAddr;
 158     Symbol.getAddress(SymAddr);
 159     uint64_t SymSize;
 160     Symbol.getSize(SymSize);
 161     StringRef SymName;
 162     Symbol.getName(SymName);
 163     SymbolRef::Type SymType;
 164     Symbol.getType(SymType);
 165     if (SymAddr == UnknownAddressOrSize || SymSize == UnknownAddressOrSize ||
 166         SymName.empty() || SymType != SymbolRef::ST_Function)
 167       continue;
 168
 169     if ( SymAddr == UValue ||
 170         (SymAddr <= UValue && SymAddr + SymSize > UValue)) {
 171       MCSymbol *Sym = Ctx.GetOrCreateSymbol(SymName);
 172       const MCExpr *Expr = MCSymbolRefExpr::Create(Sym, Ctx);
 173       if (SymAddr != UValue) {
 174         const MCExpr *Off = MCConstantExpr::Create(UValue - SymAddr, Ctx);
 175         Expr = MCBinaryExpr::CreateAdd(Expr, Off, Ctx);
 176       }
 177       MI.addOperand(MCOperand::CreateExpr(Expr));
 178       return true;
 179     }
 180   }
 181   return false;
 182 }
 183
 184 void MCObjectSymbolizer::
 185 tryAddingPcLoadReferenceComment(raw_ostream &cStream,
 186                                 int64_t Value, uint64_t Address) {
 187 }
 188
 189 StringRef MCObjectSymbolizer::findExternalFunctionAt(uint64_t Addr) {
 190   return StringRef();
 191 }
 192
 193 MCObjectSymbolizer *MCObjectSymbolizer::createObjectSymbolizer(
 194     MCContext &Ctx, std::unique_ptr<MCRelocationInfo> &RelInfo,
 195     const ObjectFile *Obj) {
 196   if (const MachOObjectFile *MOOF = dyn_cast<MachOObjectFile>(Obj))
 197     return new MCMachObjectSymbolizer(Ctx, RelInfo, MOOF);
 198   return new MCObjectSymbolizer(Ctx, RelInfo, Obj);
 199 }
 200
 201 // SortedSections implementation.
 202
 203 static bool SectionStartsBefore(const SectionRef &S, uint64_t Addr) {
 204   uint64_t SAddr; S.getAddress(SAddr);
 205   return SAddr < Addr;
 206 }
 207
 208 const SectionRef *MCObjectSymbolizer::findSectionContaining(uint64_t Addr) {
 209   if (SortedSections.empty())
 210     buildSectionList();
 211
 212   SortedSectionList::iterator
 213     EndIt = SortedSections.end(),
 214     It = std::lower_bound(SortedSections.begin(), EndIt,
 215                           Addr, SectionStartsBefore);
 216   if (It == EndIt)
 217     return 0;
 218   uint64_t SAddr; It->getAddress(SAddr);
 219   uint64_t SSize; It->getSize(SSize);
 220   if (Addr >= SAddr + SSize)
 221     return 0;
 222   return &*It;
 223 }
 224
 225 const RelocationRef *MCObjectSymbolizer::findRelocationAt(uint64_t Addr) {
 226   if (AddrToReloc.empty())
 227     buildRelocationByAddrMap();
 228
 229   AddrToRelocMap::const_iterator RI = AddrToReloc.find(Addr);
 230   if (RI == AddrToReloc.end())
 231     return 0;
 232   return &RI->second;
 233 }
 234
 235 void MCObjectSymbolizer::buildSectionList() {
 236   for (const SectionRef &Section : Obj->sections()) {
 237     bool RequiredForExec;
 238     Section.isRequiredForExecution(RequiredForExec);
 239     if (RequiredForExec == false)
 240       continue;
 241     uint64_t SAddr;
 242     Section.getAddress(SAddr);
 243     uint64_t SSize;
 244     Section.getSize(SSize);
 245     SortedSectionList::iterator It =
 246         std::lower_bound(SortedSections.begin(), SortedSections.end(), SAddr,
 247                          SectionStartsBefore);
 248     if (It != SortedSections.end()) {
 249       uint64_t FoundSAddr; It->getAddress(FoundSAddr);
 250       if (FoundSAddr < SAddr + SSize)
 251         llvm_unreachable("Inserting overlapping sections");
 252     }
 253     SortedSections.insert(It, Section);
 254   }
 255 }
 256
 257 void MCObjectSymbolizer::buildRelocationByAddrMap() {
 258   for (const SectionRef &Section : Obj->sections()) {
 259     section_iterator RelSecI = Section.getRelocatedSection();
 260     if (RelSecI == Obj->section_end())
 261       continue;
 262
 263     uint64_t StartAddr; RelSecI->getAddress(StartAddr);
 264     uint64_t Size; RelSecI->getSize(Size);
 265     bool RequiredForExec;
 266     RelSecI->isRequiredForExecution(RequiredForExec);
 267     if (RequiredForExec == false || Size == 0)
 268       continue;
 269     for (const RelocationRef &Reloc : Section.relocations()) {
 270       // FIXME: libObject is inconsistent regarding error handling. The
 271       // overwhelming majority of methods always return object_error::success,
 272       // and assert for simple errors.. Here, ELFObjectFile::getRelocationOffset
 273       // asserts when the file type isn't ET_REL.
 274       // This workaround handles x86-64 elf, the only one that has a relocinfo.
 275       uint64_t Offset;
 276       if (Obj->isELF()) {
 277         const ELF64LEObjectFile *ELFObj = dyn_cast<ELF64LEObjectFile>(Obj);
 278         if (ELFObj == 0)
 279           break;
 280         if (ELFObj->getELFFile()->getHeader()->e_type == ELF::ET_REL) {
 281           Reloc.getOffset(Offset);
 282           Offset += StartAddr;
 283         } else {
 284           Reloc.getAddress(Offset);
 285         }
 286       } else {
 287         Reloc.getOffset(Offset);
 288         Offset += StartAddr;
 289       }
 290       // At a specific address, only keep the first relocation.
 291       if (AddrToReloc.find(Offset) == AddrToReloc.end())
 292         AddrToReloc[Offset] = Reloc;
 293     }
 294   }
 295 }