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 "EDDisassembler.h"
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"
45 bool EDDisassembler::sInitialized = false;
46 EDDisassembler::DisassemblerMap_t EDDisassembler::sDisassemblers;
49 Triple::ArchType Arch;
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, }
61 /// infoFromArch - Returns the TripleMap 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 char *tripleFromArch(Triple::ArchType arch) {
66 unsigned int infoIndex;
68 for (infoIndex = 0; triplemap[infoIndex].String != NULL; ++infoIndex) {
69 if (arch == triplemap[infoIndex].Arch)
70 return triplemap[infoIndex].String;
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)
98 case kEDAssemblySyntaxARMUAL:
99 if (arch == Triple::arm || arch == Triple::thumb)
106 void EDDisassembler::initialize() {
112 InitializeAllTargetInfos();
113 InitializeAllTargets();
114 InitializeAllAsmPrinters();
115 InitializeAllAsmParsers();
116 InitializeAllDisassemblers();
119 #undef BRINGUP_TARGET
121 EDDisassembler *EDDisassembler::getDisassembler(Triple::ArchType arch,
122 EDAssemblySyntax_t syntax) {
127 EDDisassembler::DisassemblerMap_t::iterator i = sDisassemblers.find(key);
129 if (i != sDisassemblers.end()) {
132 EDDisassembler* sdd = new EDDisassembler(key);
138 sDisassemblers[key] = sdd;
146 EDDisassembler *EDDisassembler::getDisassembler(StringRef str,
147 EDAssemblySyntax_t syntax) {
150 return getDisassembler(triple.getArch(), syntax);
153 EDDisassembler::EDDisassembler(CPUKey &key) :
156 ErrorStream(nulls()),
158 const char *triple = tripleFromArch(key.Arch);
163 LLVMSyntaxVariant = getLLVMSyntaxVariant(key.Arch, key.Syntax);
165 if (LLVMSyntaxVariant < 0)
168 std::string tripleString(triple);
169 std::string errorString;
171 Tgt = TargetRegistry::lookupTarget(tripleString,
177 std::string featureString;
179 OwningPtr<const TargetMachine>
180 targetMachine(Tgt->createTargetMachine(tripleString,
183 const TargetRegisterInfo *registerInfo = targetMachine->getRegisterInfo();
188 initMaps(*registerInfo);
190 AsmInfo.reset(Tgt->createAsmInfo(tripleString));
195 Disassembler.reset(Tgt->createMCDisassembler());
200 InstInfos = Disassembler->getEDInfo();
202 InstString.reset(new std::string);
203 InstStream.reset(new raw_string_ostream(*InstString));
204 InstPrinter.reset(Tgt->createMCInstPrinter(LLVMSyntaxVariant, *AsmInfo));
209 GenericAsmLexer.reset(new AsmLexer(*AsmInfo));
210 SpecificAsmLexer.reset(Tgt->createAsmLexer(*AsmInfo));
211 SpecificAsmLexer->InstallLexer(*GenericAsmLexer);
213 initMaps(*targetMachine->getRegisterInfo());
218 EDDisassembler::~EDDisassembler() {
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 {
228 EDByteReaderCallback Callback;
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 {
240 if (Callback(ptr, address, Arg))
248 EDInst *EDDisassembler::createInst(EDByteReaderCallback byteReader,
251 EDMemoryObject memoryObject(byteReader, arg);
253 MCInst* inst = new MCInst;
256 if (!Disassembler->getInstruction(*inst,
264 const llvm::EDInstInfo *thisInstInfo;
266 thisInstInfo = &InstInfos[inst->getOpcode()];
268 EDInst* sdInst = new EDInst(inst, byteSize, *this, thisInstInfo);
273 void EDDisassembler::initMaps(const TargetRegisterInfo ®isterInfo) {
274 unsigned numRegisters = registerInfo.getNumRegs();
275 unsigned registerIndex;
277 for (registerIndex = 0; registerIndex < numRegisters; ++registerIndex) {
278 const char* registerName = registerInfo.get(registerIndex).Name;
280 RegVec.push_back(registerName);
281 RegRMap[registerName] = registerIndex;
289 stackPointers.insert(registerIDWithName("SP"));
290 stackPointers.insert(registerIDWithName("ESP"));
291 stackPointers.insert(registerIDWithName("RSP"));
293 programCounters.insert(registerIDWithName("IP"));
294 programCounters.insert(registerIDWithName("EIP"));
295 programCounters.insert(registerIDWithName("RIP"));
299 stackPointers.insert(registerIDWithName("SP"));
301 programCounters.insert(registerIDWithName("PC"));
306 const char *EDDisassembler::nameWithRegisterID(unsigned registerID) const {
307 if (registerID >= RegVec.size())
310 return RegVec[registerID].c_str();
313 unsigned EDDisassembler::registerIDWithName(const char *name) const {
314 regrmap_t::const_iterator iter = RegRMap.find(std::string(name));
315 if (iter == RegRMap.end())
318 return (*iter).second;
321 bool EDDisassembler::registerIsStackPointer(unsigned registerID) {
322 return (stackPointers.find(registerID) != stackPointers.end());
325 bool EDDisassembler::registerIsProgramCounter(unsigned registerID) {
326 return (programCounters.find(registerID) != programCounters.end());
329 int EDDisassembler::printInst(std::string &str, MCInst &inst) {
330 PrinterMutex.acquire();
332 InstPrinter->printInst(&inst, *InstStream);
337 PrinterMutex.release();
342 int EDDisassembler::parseInst(SmallVectorImpl<MCParsedAsmOperand*> &operands,
343 SmallVectorImpl<AsmToken> &tokens,
344 const std::string &str) {
357 const char *cStr = str.c_str();
358 MemoryBuffer *buf = MemoryBuffer::getMemBuffer(cStr, cStr + strlen(cStr));
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));
370 AsmToken OpcodeToken = genericParser.Lex();
371 AsmToken NextToken = genericParser.Lex(); // consume next token, because specificParser expects us to
373 if (OpcodeToken.is(AsmToken::Identifier)) {
374 instName = OpcodeToken.getString();
375 instLoc = OpcodeToken.getLoc();
377 if (NextToken.isNot(AsmToken::Eof) &&
378 TargetParser->ParseInstruction(instName, instLoc, operands))
384 ParserMutex.acquire();
387 GenericAsmLexer->setBuffer(buf);
389 while (SpecificAsmLexer->Lex(),
390 SpecificAsmLexer->isNot(AsmToken::Eof) &&
391 SpecificAsmLexer->isNot(AsmToken::EndOfStatement)) {
392 if (SpecificAsmLexer->is(AsmToken::Error)) {
396 tokens.push_back(SpecificAsmLexer->getTok());
400 ParserMutex.release();
405 int EDDisassembler::llvmSyntaxVariant() const {
406 return LLVMSyntaxVariant;