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"
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 #include "llvm/Support/TargetSelect.h"
40 bool EDDisassembler::sInitialized = false;
41 EDDisassembler::DisassemblerMap_t EDDisassembler::sDisassemblers;
44 Triple::ArchType Arch;
48 static struct TripleMap triplemap[] = {
49 { Triple::x86, "i386-unknown-unknown" },
50 { Triple::x86_64, "x86_64-unknown-unknown" },
51 { Triple::arm, "arm-unknown-unknown" },
52 { Triple::thumb, "thumb-unknown-unknown" },
53 { Triple::InvalidArch, NULL, }
56 /// infoFromArch - Returns the TripleMap corresponding to a given architecture,
57 /// or NULL if there is an error
59 /// @arg arch - The Triple::ArchType for the desired architecture
60 static const char *tripleFromArch(Triple::ArchType arch) {
61 unsigned int infoIndex;
63 for (infoIndex = 0; triplemap[infoIndex].String != NULL; ++infoIndex) {
64 if (arch == triplemap[infoIndex].Arch)
65 return triplemap[infoIndex].String;
71 /// getLLVMSyntaxVariant - gets the constant to use to get an assembly printer
72 /// for the desired assembly syntax, suitable for passing to
73 /// Target::createMCInstPrinter()
75 /// @arg arch - The target architecture
76 /// @arg syntax - The assembly syntax in sd form
77 static int getLLVMSyntaxVariant(Triple::ArchType arch,
78 EDDisassembler::AssemblySyntax syntax) {
82 // Mappings below from X86AsmPrinter.cpp
83 case EDDisassembler::kEDAssemblySyntaxX86ATT:
84 if (arch == Triple::x86 || arch == Triple::x86_64)
88 case EDDisassembler::kEDAssemblySyntaxX86Intel:
89 if (arch == Triple::x86 || arch == Triple::x86_64)
93 case EDDisassembler::kEDAssemblySyntaxARMUAL:
94 if (arch == Triple::arm || arch == Triple::thumb)
101 void EDDisassembler::initialize() {
107 InitializeAllTargetInfos();
108 InitializeAllTargetMCs();
109 InitializeAllAsmParsers();
110 InitializeAllDisassemblers();
113 #undef BRINGUP_TARGET
115 EDDisassembler *EDDisassembler::getDisassembler(Triple::ArchType arch,
116 AssemblySyntax syntax) {
121 EDDisassembler::DisassemblerMap_t::iterator i = sDisassemblers.find(key);
123 if (i != sDisassemblers.end()) {
126 EDDisassembler* sdd = new EDDisassembler(key);
132 sDisassemblers[key] = sdd;
140 EDDisassembler *EDDisassembler::getDisassembler(StringRef str,
141 AssemblySyntax syntax) {
142 return getDisassembler(Triple(str).getArch(), syntax);
145 EDDisassembler::EDDisassembler(CPUKey &key) :
148 ErrorStream(nulls()),
150 const char *triple = tripleFromArch(key.Arch);
155 LLVMSyntaxVariant = getLLVMSyntaxVariant(key.Arch, key.Syntax);
157 if (LLVMSyntaxVariant < 0)
160 std::string tripleString(triple);
161 std::string errorString;
163 Tgt = TargetRegistry::lookupTarget(tripleString,
169 MRI.reset(Tgt->createMCRegInfo(tripleString));
176 AsmInfo.reset(Tgt->createMCAsmInfo(tripleString));
181 Disassembler.reset(Tgt->createMCDisassembler());
186 InstInfos = Disassembler->getEDInfo();
188 InstString.reset(new std::string);
189 InstStream.reset(new raw_string_ostream(*InstString));
190 InstPrinter.reset(Tgt->createMCInstPrinter(LLVMSyntaxVariant, *AsmInfo));
195 GenericAsmLexer.reset(new AsmLexer(*AsmInfo));
196 SpecificAsmLexer.reset(Tgt->createMCAsmLexer(*MRI, *AsmInfo));
197 SpecificAsmLexer->InstallLexer(*GenericAsmLexer);
204 EDDisassembler::~EDDisassembler() {
210 /// EDMemoryObject - a subclass of MemoryObject that allows use of a callback
211 /// as provided by the sd interface. See MemoryObject.
212 class EDMemoryObject : public llvm::MemoryObject {
214 EDByteReaderCallback Callback;
217 EDMemoryObject(EDByteReaderCallback callback,
218 void *arg) : Callback(callback), Arg(arg) { }
219 ~EDMemoryObject() { }
220 uint64_t getBase() const { return 0x0; }
221 uint64_t getExtent() const { return (uint64_t)-1; }
222 int readByte(uint64_t address, uint8_t *ptr) const {
226 if (Callback(ptr, address, Arg))
234 EDInst *EDDisassembler::createInst(EDByteReaderCallback byteReader,
237 EDMemoryObject memoryObject(byteReader, arg);
239 MCInst* inst = new MCInst;
242 if (!Disassembler->getInstruction(*inst,
250 const llvm::EDInstInfo *thisInstInfo = NULL;
253 thisInstInfo = &InstInfos[inst->getOpcode()];
256 EDInst* sdInst = new EDInst(inst, byteSize, *this, thisInstInfo);
261 void EDDisassembler::initMaps(const MCRegisterInfo ®isterInfo) {
262 unsigned numRegisters = registerInfo.getNumRegs();
263 unsigned registerIndex;
265 for (registerIndex = 0; registerIndex < numRegisters; ++registerIndex) {
266 const char* registerName = registerInfo.get(registerIndex).Name;
268 RegVec.push_back(registerName);
269 RegRMap[registerName] = registerIndex;
277 stackPointers.insert(registerIDWithName("SP"));
278 stackPointers.insert(registerIDWithName("ESP"));
279 stackPointers.insert(registerIDWithName("RSP"));
281 programCounters.insert(registerIDWithName("IP"));
282 programCounters.insert(registerIDWithName("EIP"));
283 programCounters.insert(registerIDWithName("RIP"));
287 stackPointers.insert(registerIDWithName("SP"));
289 programCounters.insert(registerIDWithName("PC"));
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, MCInst &inst) {
318 PrinterMutex.acquire();
320 InstPrinter->printInst(&inst, *InstStream);
325 PrinterMutex.release();
330 static void diag_handler(const SMDiagnostic &diag,
334 EDDisassembler *disassembler = static_cast<EDDisassembler*>(context);
335 diag.Print("", disassembler->ErrorStream);
339 int EDDisassembler::parseInst(SmallVectorImpl<MCParsedAsmOperand*> &operands,
340 SmallVectorImpl<AsmToken> &tokens,
341 const std::string &str) {
354 const char *cStr = str.c_str();
355 MemoryBuffer *buf = MemoryBuffer::getMemBuffer(cStr, cStr + strlen(cStr));
361 sourceMgr.setDiagHandler(diag_handler, static_cast<void*>(this));
362 sourceMgr.AddNewSourceBuffer(buf, SMLoc()); // ownership of buf handed over
363 MCContext context(*AsmInfo, *MRI, NULL);
364 OwningPtr<MCStreamer> streamer(createNullStreamer(context));
365 OwningPtr<MCAsmParser> genericParser(createMCAsmParser(sourceMgr,
369 StringRef triple = tripleFromArch(Key.Arch);
370 OwningPtr<MCSubtargetInfo> STI(Tgt->createMCSubtargetInfo(triple, "", ""));
371 OwningPtr<MCTargetAsmParser>
372 TargetParser(Tgt->createMCAsmParser(*STI, *genericParser));
374 AsmToken OpcodeToken = genericParser->Lex();
375 AsmToken NextToken = genericParser->Lex(); // consume next token, because specificParser expects us to
377 if (OpcodeToken.is(AsmToken::Identifier)) {
378 instName = OpcodeToken.getString();
379 instLoc = OpcodeToken.getLoc();
381 if (NextToken.isNot(AsmToken::Eof) &&
382 TargetParser->ParseInstruction(instName, instLoc, operands))
388 ParserMutex.acquire();
391 GenericAsmLexer->setBuffer(buf);
393 while (SpecificAsmLexer->Lex(),
394 SpecificAsmLexer->isNot(AsmToken::Eof) &&
395 SpecificAsmLexer->isNot(AsmToken::EndOfStatement)) {
396 if (SpecificAsmLexer->is(AsmToken::Error)) {
400 tokens.push_back(SpecificAsmLexer->getTok());
404 ParserMutex.release();
409 int EDDisassembler::llvmSyntaxVariant() const {
410 return LLVMSyntaxVariant;