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