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