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