lib/MC/MCDisassembler/EDDisassembler.cpp

   1 //===-EDDisassembler.cpp - LLVM Enhanced Disassembler ---------------------===//
   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 // This file implements the Enhanced Disassembly library's  disassembler class.
  11 // The disassembler is responsible for vending individual instructions according
  12 // to a given architecture and disassembly syntax.
  13 //
  14 //===----------------------------------------------------------------------===//
  15
  16 #include "EDDisassembler.h"
  17 #include "EDInst.h"
  18 #include "llvm/MC/EDInstInfo.h"
  19 #include "llvm/MC/MCAsmInfo.h"
  20 #include "llvm/MC/MCContext.h"
  21 #include "llvm/MC/MCDisassembler.h"
  22 #include "llvm/MC/MCExpr.h"
  23 #include "llvm/MC/MCInst.h"
  24 #include "llvm/MC/MCInstPrinter.h"
  25 #include "llvm/MC/MCRegisterInfo.h"
  26 #include "llvm/MC/MCStreamer.h"
  27 #include "llvm/MC/MCSubtargetInfo.h"
  28 #include "llvm/MC/MCParser/AsmLexer.h"
  29 #include "llvm/MC/MCParser/MCAsmParser.h"
  30 #include "llvm/MC/MCParser/MCParsedAsmOperand.h"
  31 #include "llvm/MC/MCTargetAsmLexer.h"
  32 #include "llvm/MC/MCTargetAsmParser.h"
  33 #include "llvm/Support/MemoryBuffer.h"
  34 #include "llvm/Support/MemoryObject.h"
  35 #include "llvm/Support/SourceMgr.h"
  36 #include "llvm/Support/TargetRegistry.h"
  37 using namespace llvm;
  38
  39 EDDisassembler::DisassemblerMap_t EDDisassembler::sDisassemblers;
  40
  41 struct TripleMap {
  42   Triple::ArchType Arch;
  43   const char *String;
  44 };
  45
  46 static struct TripleMap triplemap[] = {
  47   { Triple::x86,          "i386-unknown-unknown"    },
  48   { Triple::x86_64,       "x86_64-unknown-unknown"  },
  49   { Triple::arm,          "arm-unknown-unknown"     },
  50   { Triple::thumb,        "thumb-unknown-unknown"   },
  51   { Triple::InvalidArch,  NULL,                     }
  52 };
  53
  54 /// infoFromArch - Returns the TripleMap corresponding to a given architecture,
  55 ///   or NULL if there is an error
  56 ///
  57 /// @arg arch - The Triple::ArchType for the desired architecture
  58 static const char *tripleFromArch(Triple::ArchType arch) {
  59   unsigned int infoIndex;
  60
  61   for (infoIndex = 0; triplemap[infoIndex].String != NULL; ++infoIndex) {
  62     if (arch == triplemap[infoIndex].Arch)
  63       return triplemap[infoIndex].String;
  64   }
  65
  66   return NULL;
  67 }
  68
  69 /// getLLVMSyntaxVariant - gets the constant to use to get an assembly printer
  70 ///   for the desired assembly syntax, suitable for passing to
  71 ///   Target::createMCInstPrinter()
  72 ///
  73 /// @arg arch   - The target architecture
  74 /// @arg syntax - The assembly syntax in sd form
  75 static int getLLVMSyntaxVariant(Triple::ArchType arch,
  76                                 EDDisassembler::AssemblySyntax syntax) {
  77   switch (syntax) {
  78   // Mappings below from X86AsmPrinter.cpp
  79   case EDDisassembler::kEDAssemblySyntaxX86ATT:
  80     if (arch == Triple::x86 || arch == Triple::x86_64)
  81       return 0;
  82     else
  83       return -1;
  84   case EDDisassembler::kEDAssemblySyntaxX86Intel:
  85     if (arch == Triple::x86 || arch == Triple::x86_64)
  86       return 1;
  87     else
  88       return -1;
  89   case EDDisassembler::kEDAssemblySyntaxARMUAL:
  90     if (arch == Triple::arm || arch == Triple::thumb)
  91       return 0;
  92     else
  93       return -1;
  94   }
  95 }
  96
  97 EDDisassembler *EDDisassembler::getDisassembler(Triple::ArchType arch,
  98                                                 AssemblySyntax syntax) {
  99   CPUKey key;
 100   key.Arch = arch;
 101   key.Syntax = syntax;
 102
 103   EDDisassembler::DisassemblerMap_t::iterator i = sDisassemblers.find(key);
 104
 105   if (i != sDisassemblers.end()) {
 106     return i->second;
 107   } else {
 108     EDDisassembler* sdd = new EDDisassembler(key);
 109     if (!sdd->valid()) {
 110       delete sdd;
 111       return NULL;
 112     }
 113
 114     sDisassemblers[key] = sdd;
 115
 116     return sdd;
 117   }
 118
 119   return NULL;
 120 }
 121
 122 EDDisassembler *EDDisassembler::getDisassembler(StringRef str,
 123                                                 AssemblySyntax syntax) {
 124   return getDisassembler(Triple(str).getArch(), syntax);
 125 }
 126
 127 EDDisassembler::EDDisassembler(CPUKey &key) :
 128   Valid(false),
 129   HasSemantics(false),
 130   ErrorStream(nulls()),
 131   Key(key) {
 132   const char *triple = tripleFromArch(key.Arch);
 133
 134   if (!triple)
 135     return;
 136
 137   LLVMSyntaxVariant = getLLVMSyntaxVariant(key.Arch, key.Syntax);
 138
 139   if (LLVMSyntaxVariant < 0)
 140     return;
 141
 142   std::string tripleString(triple);
 143   std::string errorString;
 144
 145   Tgt = TargetRegistry::lookupTarget(tripleString,
 146                                      errorString);
 147
 148   if (!Tgt)
 149     return;
 150
 151   MRI.reset(Tgt->createMCRegInfo(tripleString));
 152
 153   if (!MRI)
 154     return;
 155
 156   initMaps(*MRI);
 157
 158   AsmInfo.reset(Tgt->createMCAsmInfo(tripleString));
 159
 160   if (!AsmInfo)
 161     return;
 162
 163   STI.reset(Tgt->createMCSubtargetInfo(tripleString, "", ""));
 164
 165   if (!STI)
 166     return;
 167
 168   Disassembler.reset(Tgt->createMCDisassembler(*STI));
 169
 170   if (!Disassembler)
 171     return;
 172
 173   InstInfos = Disassembler->getEDInfo();
 174
 175   InstString.reset(new std::string);
 176   InstStream.reset(new raw_string_ostream(*InstString));
 177   InstPrinter.reset(Tgt->createMCInstPrinter(LLVMSyntaxVariant, *AsmInfo, *STI));
 178
 179   if (!InstPrinter)
 180     return;
 181
 182   GenericAsmLexer.reset(new AsmLexer(*AsmInfo));
 183   SpecificAsmLexer.reset(Tgt->createMCAsmLexer(*MRI, *AsmInfo));
 184   SpecificAsmLexer->InstallLexer(*GenericAsmLexer);
 185
 186   initMaps(*MRI);
 187
 188   Valid = true;
 189 }
 190
 191 EDDisassembler::~EDDisassembler() {
 192   if (!valid())
 193     return;
 194 }
 195
 196 namespace {
 197   /// EDMemoryObject - a subclass of MemoryObject that allows use of a callback
 198   ///   as provided by the sd interface.  See MemoryObject.
 199   class EDMemoryObject : public llvm::MemoryObject {
 200   private:
 201     EDByteReaderCallback Callback;
 202     void *Arg;
 203   public:
 204     EDMemoryObject(EDByteReaderCallback callback,
 205                    void *arg) : Callback(callback), Arg(arg) { }
 206     ~EDMemoryObject() { }
 207     uint64_t getBase() const { return 0x0; }
 208     uint64_t getExtent() const { return (uint64_t)-1; }
 209     int readByte(uint64_t address, uint8_t *ptr) const {
 210       if (!Callback)
 211         return -1;
 212
 213       if (Callback(ptr, address, Arg))
 214         return -1;
 215
 216       return 0;
 217     }
 218   };
 219 }
 220
 221 EDInst *EDDisassembler::createInst(EDByteReaderCallback byteReader,
 222                                    uint64_t address,
 223                                    void *arg) {
 224   EDMemoryObject memoryObject(byteReader, arg);
 225
 226   MCInst* inst = new MCInst;
 227   uint64_t byteSize;
 228
 229   MCDisassembler::DecodeStatus S;
 230   S = Disassembler->getInstruction(*inst, byteSize, memoryObject, address,
 231                                    ErrorStream, nulls());
 232   switch (S) {
 233   case MCDisassembler::Fail:
 234   case MCDisassembler::SoftFail:
 235     // FIXME: Do something different on soft failure mode?
 236     delete inst;
 237     return NULL;
 238
 239   case MCDisassembler::Success: {
 240     const llvm::EDInstInfo *thisInstInfo = NULL;
 241
 242     if (InstInfos) {
 243       thisInstInfo = &InstInfos[inst->getOpcode()];
 244     }
 245
 246     EDInst* sdInst = new EDInst(inst, byteSize, *this, thisInstInfo);
 247     return sdInst;
 248   }
 249   }
 250   return NULL;
 251 }
 252
 253 void EDDisassembler::initMaps(const MCRegisterInfo &registerInfo) {
 254   unsigned numRegisters = registerInfo.getNumRegs();
 255   unsigned registerIndex;
 256
 257   for (registerIndex = 0; registerIndex < numRegisters; ++registerIndex) {
 258     const char* registerName = registerInfo.get(registerIndex).Name;
 259
 260     RegVec.push_back(registerName);
 261     RegRMap[registerName] = registerIndex;
 262   }
 263
 264   switch (Key.Arch) {
 265   default:
 266     break;
 267   case Triple::x86:
 268   case Triple::x86_64:
 269     stackPointers.insert(registerIDWithName("SP"));
 270     stackPointers.insert(registerIDWithName("ESP"));
 271     stackPointers.insert(registerIDWithName("RSP"));
 272
 273     programCounters.insert(registerIDWithName("IP"));
 274     programCounters.insert(registerIDWithName("EIP"));
 275     programCounters.insert(registerIDWithName("RIP"));
 276     break;
 277   case Triple::arm:
 278   case Triple::thumb:
 279     stackPointers.insert(registerIDWithName("SP"));
 280
 281     programCounters.insert(registerIDWithName("PC"));
 282     break;
 283   }
 284 }
 285
 286 const char *EDDisassembler::nameWithRegisterID(unsigned registerID) const {
 287   if (registerID >= RegVec.size())
 288     return NULL;
 289   else
 290     return RegVec[registerID].c_str();
 291 }
 292
 293 unsigned EDDisassembler::registerIDWithName(const char *name) const {
 294   regrmap_t::const_iterator iter = RegRMap.find(std::string(name));
 295   if (iter == RegRMap.end())
 296     return 0;
 297   else
 298     return (*iter).second;
 299 }
 300
 301 bool EDDisassembler::registerIsStackPointer(unsigned registerID) {
 302   return (stackPointers.find(registerID) != stackPointers.end());
 303 }
 304
 305 bool EDDisassembler::registerIsProgramCounter(unsigned registerID) {
 306   return (programCounters.find(registerID) != programCounters.end());
 307 }
 308
 309 int EDDisassembler::printInst(std::string &str, MCInst &inst) {
 310   PrinterMutex.acquire();
 311
 312   InstPrinter->printInst(&inst, *InstStream, "");
 313   InstStream->flush();
 314   str = *InstString;
 315   InstString->clear();
 316
 317   PrinterMutex.release();
 318
 319   return 0;
 320 }
 321
 322 static void diag_handler(const SMDiagnostic &diag, void *context) {
 323   if (context)
 324     diag.print("", static_cast<EDDisassembler*>(context)->ErrorStream);
 325 }
 326
 327 int EDDisassembler::parseInst(SmallVectorImpl<MCParsedAsmOperand*> &operands,
 328                               SmallVectorImpl<AsmToken> &tokens,
 329                               const std::string &str) {
 330   int ret = 0;
 331
 332   switch (Key.Arch) {
 333   default:
 334     return -1;
 335   case Triple::x86:
 336   case Triple::x86_64:
 337   case Triple::arm:
 338   case Triple::thumb:
 339     break;
 340   }
 341
 342   const char *cStr = str.c_str();
 343   MemoryBuffer *buf = MemoryBuffer::getMemBuffer(cStr, cStr + strlen(cStr));
 344
 345   StringRef instName;
 346   SMLoc instLoc;
 347
 348   SourceMgr sourceMgr;
 349   sourceMgr.setDiagHandler(diag_handler, static_cast<void*>(this));
 350   sourceMgr.AddNewSourceBuffer(buf, SMLoc()); // ownership of buf handed over
 351   MCContext context(*AsmInfo, *MRI, NULL);
 352   OwningPtr<MCStreamer> streamer(createNullStreamer(context));
 353   OwningPtr<MCAsmParser> genericParser(createMCAsmParser(sourceMgr,
 354                                                          context, *streamer,
 355                                                          *AsmInfo));
 356
 357   StringRef triple = tripleFromArch(Key.Arch);
 358   OwningPtr<MCSubtargetInfo> STI(Tgt->createMCSubtargetInfo(triple, "", ""));
 359   OwningPtr<MCTargetAsmParser>
 360     TargetParser(Tgt->createMCAsmParser(*STI, *genericParser));
 361
 362   AsmToken OpcodeToken = genericParser->Lex();
 363   AsmToken NextToken = genericParser->Lex();  // consume next token, because specificParser expects us to
 364
 365   if (OpcodeToken.is(AsmToken::Identifier)) {
 366     instName = OpcodeToken.getString();
 367     instLoc = OpcodeToken.getLoc();
 368
 369     if (NextToken.isNot(AsmToken::Eof) &&
 370         TargetParser->ParseInstruction(instName, instLoc, operands))
 371       ret = -1;
 372   } else {
 373     ret = -1;
 374   }
 375
 376   ParserMutex.acquire();
 377
 378   if (!ret) {
 379     GenericAsmLexer->setBuffer(buf);
 380
 381     while (SpecificAsmLexer->Lex(),
 382            SpecificAsmLexer->isNot(AsmToken::Eof) &&
 383            SpecificAsmLexer->isNot(AsmToken::EndOfStatement)) {
 384       if (SpecificAsmLexer->is(AsmToken::Error)) {
 385         ret = -1;
 386         break;
 387       }
 388       tokens.push_back(SpecificAsmLexer->getTok());
 389     }
 390   }
 391
 392   ParserMutex.release();
 393
 394   return ret;
 395 }
 396
 397 int EDDisassembler::llvmSyntaxVariant() const {
 398   return LLVMSyntaxVariant;
 399 }