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