1 //===-EDDisassembler.cpp - LLVM Enhanced Disassembler ---------------------===//
3 // The LLVM Compiler Infrastructure
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
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.
14 //===----------------------------------------------------------------------===//
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"
39 #include "EDDisassembler.h"
42 #include "../../lib/Target/X86/X86GenEDInfo.inc"
46 bool EDDisassembler::sInitialized = false;
47 EDDisassembler::DisassemblerMap_t EDDisassembler::sDisassemblers;
50 Triple::ArchType Arch;
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 }
61 /// infoFromArch - Returns the InfoMap corresponding to a given architecture,
62 /// or NULL if there is an error
64 /// @arg arch - The Triple::ArchType for the desired architecture
65 static const InfoMap *infoFromArch(Triple::ArchType arch) {
66 unsigned int infoIndex;
68 for (infoIndex = 0; infomap[infoIndex].String != NULL; ++infoIndex) {
69 if(arch == infomap[infoIndex].Arch)
70 return &infomap[infoIndex];
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()
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) {
87 // Mappings below from X86AsmPrinter.cpp
88 case kEDAssemblySyntaxX86ATT:
89 if (arch == Triple::x86 || arch == Triple::x86_64)
93 case kEDAssemblySyntaxX86Intel:
94 if (arch == Triple::x86 || arch == Triple::x86_64)
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();
108 void EDDisassembler::initialize() {
117 #undef BRINGUP_TARGET
119 EDDisassembler *EDDisassembler::getDisassembler(Triple::ArchType arch,
120 EDAssemblySyntax_t syntax) {
125 EDDisassembler::DisassemblerMap_t::iterator i = sDisassemblers.find(key);
127 if (i != sDisassemblers.end()) {
131 EDDisassembler* sdd = new EDDisassembler(key);
137 sDisassemblers[key] = sdd;
145 EDDisassembler *EDDisassembler::getDisassembler(StringRef str,
146 EDAssemblySyntax_t syntax) {
149 return getDisassembler(triple.getArch(), syntax);
152 EDDisassembler::EDDisassembler(CPUKey &key) :
153 Valid(false), ErrorString(), ErrorStream(ErrorString), Key(key) {
154 const InfoMap *infoMap = infoFromArch(key.Arch);
159 const char *triple = infoMap->String;
161 int syntaxVariant = getLLVMSyntaxVariant(key.Arch, key.Syntax);
163 if (syntaxVariant < 0)
166 std::string tripleString(triple);
167 std::string errorString;
169 Tgt = TargetRegistry::lookupTarget(tripleString,
175 std::string featureString;
177 OwningPtr<const TargetMachine>
178 targetMachine(Tgt->createTargetMachine(tripleString,
181 const TargetRegisterInfo *registerInfo = targetMachine->getRegisterInfo();
186 AsmInfo.reset(Tgt->createAsmInfo(tripleString));
191 Disassembler.reset(Tgt->createMCDisassembler());
196 InstString.reset(new std::string);
197 InstStream.reset(new raw_string_ostream(*InstString));
199 InstPrinter.reset(Tgt->createMCInstPrinter(syntaxVariant,
206 GenericAsmLexer.reset(new AsmLexer(*AsmInfo));
207 SpecificAsmLexer.reset(Tgt->createAsmLexer(*AsmInfo));
208 SpecificAsmLexer->InstallLexer(*GenericAsmLexer);
210 InstInfos = infoMap->Info;
212 initMaps(*targetMachine->getRegisterInfo());
217 EDDisassembler::~EDDisassembler() {
223 /// EDMemoryObject - a subclass of MemoryObject that allows use of a callback
224 /// as provided by the sd interface. See MemoryObject.
225 class EDMemoryObject : public llvm::MemoryObject {
227 EDByteReaderCallback Callback;
230 EDMemoryObject(EDByteReaderCallback callback,
231 void *arg) : Callback(callback), Arg(arg) { }
232 ~EDMemoryObject() { }
233 uint64_t getBase() const { return 0x0; }
234 uint64_t getExtent() const { return (uint64_t)-1; }
235 int readByte(uint64_t address, uint8_t *ptr) const {
239 if(Callback(ptr, address, Arg))
247 EDInst *EDDisassembler::createInst(EDByteReaderCallback byteReader,
250 EDMemoryObject memoryObject(byteReader, arg);
252 MCInst* inst = new MCInst;
255 if (!Disassembler->getInstruction(*inst,
264 const InstInfo *thisInstInfo = &InstInfos[inst->getOpcode()];
266 EDInst* sdInst = new EDInst(inst, byteSize, *this, thisInstInfo);
271 void EDDisassembler::initMaps(const TargetRegisterInfo ®isterInfo) {
272 unsigned numRegisters = registerInfo.getNumRegs();
273 unsigned registerIndex;
275 for (registerIndex = 0; registerIndex < numRegisters; ++registerIndex) {
276 const char* registerName = registerInfo.get(registerIndex).Name;
278 RegVec.push_back(registerName);
279 RegRMap[registerName] = registerIndex;
282 if (Key.Arch == Triple::x86 ||
283 Key.Arch == Triple::x86_64) {
284 stackPointers.insert(registerIDWithName("SP"));
285 stackPointers.insert(registerIDWithName("ESP"));
286 stackPointers.insert(registerIDWithName("RSP"));
288 programCounters.insert(registerIDWithName("IP"));
289 programCounters.insert(registerIDWithName("EIP"));
290 programCounters.insert(registerIDWithName("RIP"));
294 const char *EDDisassembler::nameWithRegisterID(unsigned registerID) const {
295 if (registerID >= RegVec.size())
298 return RegVec[registerID].c_str();
301 unsigned EDDisassembler::registerIDWithName(const char *name) const {
302 regrmap_t::const_iterator iter = RegRMap.find(std::string(name));
303 if (iter == RegRMap.end())
306 return (*iter).second;
309 bool EDDisassembler::registerIsStackPointer(unsigned registerID) {
310 return (stackPointers.find(registerID) != stackPointers.end());
313 bool EDDisassembler::registerIsProgramCounter(unsigned registerID) {
314 return (programCounters.find(registerID) != programCounters.end());
317 int EDDisassembler::printInst(std::string& str,
319 PrinterMutex.acquire();
321 InstPrinter->printInst(&inst);
326 PrinterMutex.release();
331 int EDDisassembler::parseInst(SmallVectorImpl<MCParsedAsmOperand*> &operands,
332 SmallVectorImpl<AsmToken> &tokens,
333 const std::string &str) {
336 const char *cStr = str.c_str();
337 MemoryBuffer *buf = MemoryBuffer::getMemBuffer(cStr, cStr + strlen(cStr));
343 sourceMgr.AddNewSourceBuffer(buf, SMLoc()); // ownership of buf handed over
345 OwningPtr<MCStreamer> streamer
346 (createNullStreamer(context));
347 AsmParser genericParser(sourceMgr, context, *streamer, *AsmInfo);
348 OwningPtr<TargetAsmParser> specificParser
349 (Tgt->createAsmParser(genericParser));
351 AsmToken OpcodeToken = genericParser.Lex();
353 if(OpcodeToken.is(AsmToken::Identifier)) {
354 instName = OpcodeToken.getString();
355 instLoc = OpcodeToken.getLoc();
356 if (specificParser->ParseInstruction(instName, instLoc, operands))
363 ParserMutex.acquire();
366 GenericAsmLexer->setBuffer(buf);
368 while (SpecificAsmLexer->Lex(),
369 SpecificAsmLexer->isNot(AsmToken::Eof) &&
370 SpecificAsmLexer->isNot(AsmToken::EndOfStatement)) {
371 if (SpecificAsmLexer->is(AsmToken::Error)) {
375 tokens.push_back(SpecificAsmLexer->getTok());
379 ParserMutex.release();
384 int EDDisassembler::llvmSyntaxVariant() const {
385 return LLVMSyntaxVariant;