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