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