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/MCStreamer.h"
26 #include "llvm/MC/MCSubtargetInfo.h"
27 #include "llvm/MC/MCParser/AsmLexer.h"
28 #include "llvm/MC/MCParser/MCAsmParser.h"
29 #include "llvm/MC/MCParser/MCParsedAsmOperand.h"
30 #include "llvm/Support/MemoryBuffer.h"
31 #include "llvm/Support/MemoryObject.h"
32 #include "llvm/Support/SourceMgr.h"
33 #include "llvm/Target/TargetAsmLexer.h"
34 #include "llvm/Target/TargetAsmParser.h"
35 #include "llvm/Target/TargetRegistry.h"
36 #include "llvm/Target/TargetMachine.h"
37 #include "llvm/Target/TargetRegisterInfo.h"
38 #include "llvm/Target/TargetSelect.h"
41 bool EDDisassembler::sInitialized = false;
42 EDDisassembler::DisassemblerMap_t EDDisassembler::sDisassemblers;
45 Triple::ArchType Arch;
49 static struct TripleMap triplemap[] = {
50 { Triple::x86, "i386-unknown-unknown" },
51 { Triple::x86_64, "x86_64-unknown-unknown" },
52 { Triple::arm, "arm-unknown-unknown" },
53 { Triple::thumb, "thumb-unknown-unknown" },
54 { Triple::InvalidArch, NULL, }
57 /// infoFromArch - Returns the TripleMap corresponding to a given architecture,
58 /// or NULL if there is an error
60 /// @arg arch - The Triple::ArchType for the desired architecture
61 static const char *tripleFromArch(Triple::ArchType arch) {
62 unsigned int infoIndex;
64 for (infoIndex = 0; triplemap[infoIndex].String != NULL; ++infoIndex) {
65 if (arch == triplemap[infoIndex].Arch)
66 return triplemap[infoIndex].String;
72 /// getLLVMSyntaxVariant - gets the constant to use to get an assembly printer
73 /// for the desired assembly syntax, suitable for passing to
74 /// Target::createMCInstPrinter()
76 /// @arg arch - The target architecture
77 /// @arg syntax - The assembly syntax in sd form
78 static int getLLVMSyntaxVariant(Triple::ArchType arch,
79 EDDisassembler::AssemblySyntax syntax) {
83 // Mappings below from X86AsmPrinter.cpp
84 case EDDisassembler::kEDAssemblySyntaxX86ATT:
85 if (arch == Triple::x86 || arch == Triple::x86_64)
89 case EDDisassembler::kEDAssemblySyntaxX86Intel:
90 if (arch == Triple::x86 || arch == Triple::x86_64)
94 case EDDisassembler::kEDAssemblySyntaxARMUAL:
95 if (arch == Triple::arm || arch == Triple::thumb)
102 void EDDisassembler::initialize() {
108 InitializeAllTargetInfos();
109 InitializeAllTargets();
110 InitializeAllMCAsmInfos();
111 InitializeAllAsmPrinters();
112 InitializeAllAsmParsers();
113 InitializeAllDisassemblers();
116 #undef BRINGUP_TARGET
118 EDDisassembler *EDDisassembler::getDisassembler(Triple::ArchType arch,
119 AssemblySyntax syntax) {
124 EDDisassembler::DisassemblerMap_t::iterator i = sDisassemblers.find(key);
126 if (i != sDisassemblers.end()) {
129 EDDisassembler* sdd = new EDDisassembler(key);
135 sDisassemblers[key] = sdd;
143 EDDisassembler *EDDisassembler::getDisassembler(StringRef str,
144 AssemblySyntax syntax) {
145 return getDisassembler(Triple(str).getArch(), syntax);
148 EDDisassembler::EDDisassembler(CPUKey &key) :
151 ErrorStream(nulls()),
153 const char *triple = tripleFromArch(key.Arch);
158 LLVMSyntaxVariant = getLLVMSyntaxVariant(key.Arch, key.Syntax);
160 if (LLVMSyntaxVariant < 0)
163 std::string tripleString(triple);
164 std::string errorString;
166 Tgt = TargetRegistry::lookupTarget(tripleString,
173 std::string featureString;
174 TargetMachine.reset(Tgt->createTargetMachine(tripleString, CPU,
177 const TargetRegisterInfo *registerInfo = TargetMachine->getRegisterInfo();
182 initMaps(*registerInfo);
184 AsmInfo.reset(Tgt->createMCAsmInfo(tripleString));
189 Disassembler.reset(Tgt->createMCDisassembler());
194 InstInfos = Disassembler->getEDInfo();
196 InstString.reset(new std::string);
197 InstStream.reset(new raw_string_ostream(*InstString));
198 InstPrinter.reset(Tgt->createMCInstPrinter(LLVMSyntaxVariant, *AsmInfo));
203 GenericAsmLexer.reset(new AsmLexer(*AsmInfo));
204 SpecificAsmLexer.reset(Tgt->createAsmLexer(*AsmInfo));
205 SpecificAsmLexer->InstallLexer(*GenericAsmLexer);
207 initMaps(*TargetMachine->getRegisterInfo());
212 EDDisassembler::~EDDisassembler() {
218 /// EDMemoryObject - a subclass of MemoryObject that allows use of a callback
219 /// as provided by the sd interface. See MemoryObject.
220 class EDMemoryObject : public llvm::MemoryObject {
222 EDByteReaderCallback Callback;
225 EDMemoryObject(EDByteReaderCallback callback,
226 void *arg) : Callback(callback), Arg(arg) { }
227 ~EDMemoryObject() { }
228 uint64_t getBase() const { return 0x0; }
229 uint64_t getExtent() const { return (uint64_t)-1; }
230 int readByte(uint64_t address, uint8_t *ptr) const {
234 if (Callback(ptr, address, Arg))
242 EDInst *EDDisassembler::createInst(EDByteReaderCallback byteReader,
245 EDMemoryObject memoryObject(byteReader, arg);
247 MCInst* inst = new MCInst;
250 if (!Disassembler->getInstruction(*inst,
258 const llvm::EDInstInfo *thisInstInfo = NULL;
261 thisInstInfo = &InstInfos[inst->getOpcode()];
264 EDInst* sdInst = new EDInst(inst, byteSize, *this, thisInstInfo);
269 void EDDisassembler::initMaps(const TargetRegisterInfo ®isterInfo) {
270 unsigned numRegisters = registerInfo.getNumRegs();
271 unsigned registerIndex;
273 for (registerIndex = 0; registerIndex < numRegisters; ++registerIndex) {
274 const char* registerName = registerInfo.get(registerIndex).Name;
276 RegVec.push_back(registerName);
277 RegRMap[registerName] = registerIndex;
285 stackPointers.insert(registerIDWithName("SP"));
286 stackPointers.insert(registerIDWithName("ESP"));
287 stackPointers.insert(registerIDWithName("RSP"));
289 programCounters.insert(registerIDWithName("IP"));
290 programCounters.insert(registerIDWithName("EIP"));
291 programCounters.insert(registerIDWithName("RIP"));
295 stackPointers.insert(registerIDWithName("SP"));
297 programCounters.insert(registerIDWithName("PC"));
302 const char *EDDisassembler::nameWithRegisterID(unsigned registerID) const {
303 if (registerID >= RegVec.size())
306 return RegVec[registerID].c_str();
309 unsigned EDDisassembler::registerIDWithName(const char *name) const {
310 regrmap_t::const_iterator iter = RegRMap.find(std::string(name));
311 if (iter == RegRMap.end())
314 return (*iter).second;
317 bool EDDisassembler::registerIsStackPointer(unsigned registerID) {
318 return (stackPointers.find(registerID) != stackPointers.end());
321 bool EDDisassembler::registerIsProgramCounter(unsigned registerID) {
322 return (programCounters.find(registerID) != programCounters.end());
325 int EDDisassembler::printInst(std::string &str, MCInst &inst) {
326 PrinterMutex.acquire();
328 InstPrinter->printInst(&inst, *InstStream);
333 PrinterMutex.release();
338 static void diag_handler(const SMDiagnostic &diag,
342 EDDisassembler *disassembler = static_cast<EDDisassembler*>(context);
343 diag.Print("", disassembler->ErrorStream);
347 int EDDisassembler::parseInst(SmallVectorImpl<MCParsedAsmOperand*> &operands,
348 SmallVectorImpl<AsmToken> &tokens,
349 const std::string &str) {
362 const char *cStr = str.c_str();
363 MemoryBuffer *buf = MemoryBuffer::getMemBuffer(cStr, cStr + strlen(cStr));
369 sourceMgr.setDiagHandler(diag_handler, static_cast<void*>(this));
370 sourceMgr.AddNewSourceBuffer(buf, SMLoc()); // ownership of buf handed over
371 MCContext context(*AsmInfo, NULL);
372 OwningPtr<MCStreamer> streamer(createNullStreamer(context));
373 OwningPtr<MCAsmParser> genericParser(createMCAsmParser(*Tgt, sourceMgr,
377 StringRef triple = tripleFromArch(Key.Arch);
378 OwningPtr<MCSubtargetInfo> STI(Tgt->createMCSubtargetInfo(triple, "", ""));
379 OwningPtr<TargetAsmParser> TargetParser(Tgt->createAsmParser(*STI,
382 AsmToken OpcodeToken = genericParser->Lex();
383 AsmToken NextToken = genericParser->Lex(); // consume next token, because specificParser expects us to
385 if (OpcodeToken.is(AsmToken::Identifier)) {
386 instName = OpcodeToken.getString();
387 instLoc = OpcodeToken.getLoc();
389 if (NextToken.isNot(AsmToken::Eof) &&
390 TargetParser->ParseInstruction(instName, instLoc, operands))
396 ParserMutex.acquire();
399 GenericAsmLexer->setBuffer(buf);
401 while (SpecificAsmLexer->Lex(),
402 SpecificAsmLexer->isNot(AsmToken::Eof) &&
403 SpecificAsmLexer->isNot(AsmToken::EndOfStatement)) {
404 if (SpecificAsmLexer->is(AsmToken::Error)) {
408 tokens.push_back(SpecificAsmLexer->getTok());
412 ParserMutex.release();
417 int EDDisassembler::llvmSyntaxVariant() const {
418 return LLVMSyntaxVariant;