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/Support/MemoryBuffer.h"
32 #include "llvm/Support/MemoryObject.h"
33 #include "llvm/Support/SourceMgr.h"
34 #include "llvm/Target/TargetAsmLexer.h"
35 #include "llvm/Target/TargetAsmParser.h"
36 #include "llvm/Target/TargetRegistry.h"
37 #include "llvm/Target/TargetMachine.h"
38 #include "llvm/Target/TargetRegisterInfo.h"
39 #include "llvm/Target/TargetSelect.h"
42 bool EDDisassembler::sInitialized = false;
43 EDDisassembler::DisassemblerMap_t EDDisassembler::sDisassemblers;
46 Triple::ArchType Arch;
50 static struct TripleMap triplemap[] = {
51 { Triple::x86, "i386-unknown-unknown" },
52 { Triple::x86_64, "x86_64-unknown-unknown" },
53 { Triple::arm, "arm-unknown-unknown" },
54 { Triple::thumb, "thumb-unknown-unknown" },
55 { Triple::InvalidArch, NULL, }
58 /// infoFromArch - Returns the TripleMap corresponding to a given architecture,
59 /// or NULL if there is an error
61 /// @arg arch - The Triple::ArchType for the desired architecture
62 static const char *tripleFromArch(Triple::ArchType arch) {
63 unsigned int infoIndex;
65 for (infoIndex = 0; triplemap[infoIndex].String != NULL; ++infoIndex) {
66 if (arch == triplemap[infoIndex].Arch)
67 return triplemap[infoIndex].String;
73 /// getLLVMSyntaxVariant - gets the constant to use to get an assembly printer
74 /// for the desired assembly syntax, suitable for passing to
75 /// Target::createMCInstPrinter()
77 /// @arg arch - The target architecture
78 /// @arg syntax - The assembly syntax in sd form
79 static int getLLVMSyntaxVariant(Triple::ArchType arch,
80 EDDisassembler::AssemblySyntax syntax) {
84 // Mappings below from X86AsmPrinter.cpp
85 case EDDisassembler::kEDAssemblySyntaxX86ATT:
86 if (arch == Triple::x86 || arch == Triple::x86_64)
90 case EDDisassembler::kEDAssemblySyntaxX86Intel:
91 if (arch == Triple::x86 || arch == Triple::x86_64)
95 case EDDisassembler::kEDAssemblySyntaxARMUAL:
96 if (arch == Triple::arm || arch == Triple::thumb)
103 void EDDisassembler::initialize() {
109 InitializeAllTargetInfos();
110 InitializeAllTargets();
111 InitializeAllMCAsmInfos();
112 InitializeAllMCRegisterInfos();
113 InitializeAllAsmPrinters();
114 InitializeAllAsmParsers();
115 InitializeAllDisassemblers();
118 #undef BRINGUP_TARGET
120 EDDisassembler *EDDisassembler::getDisassembler(Triple::ArchType arch,
121 AssemblySyntax syntax) {
126 EDDisassembler::DisassemblerMap_t::iterator i = sDisassemblers.find(key);
128 if (i != sDisassemblers.end()) {
131 EDDisassembler* sdd = new EDDisassembler(key);
137 sDisassemblers[key] = sdd;
145 EDDisassembler *EDDisassembler::getDisassembler(StringRef str,
146 AssemblySyntax syntax) {
147 return getDisassembler(Triple(str).getArch(), syntax);
150 EDDisassembler::EDDisassembler(CPUKey &key) :
153 ErrorStream(nulls()),
155 const char *triple = tripleFromArch(key.Arch);
160 LLVMSyntaxVariant = getLLVMSyntaxVariant(key.Arch, key.Syntax);
162 if (LLVMSyntaxVariant < 0)
165 std::string tripleString(triple);
166 std::string errorString;
168 Tgt = TargetRegistry::lookupTarget(tripleString,
175 std::string featureString;
176 TargetMachine.reset(Tgt->createTargetMachine(tripleString, CPU,
179 const TargetRegisterInfo *registerInfo = TargetMachine->getRegisterInfo();
184 initMaps(*registerInfo);
186 AsmInfo.reset(Tgt->createMCAsmInfo(tripleString));
191 MRI.reset(Tgt->createMCRegInfo(tripleString));
196 Disassembler.reset(Tgt->createMCDisassembler());
201 InstInfos = Disassembler->getEDInfo();
203 InstString.reset(new std::string);
204 InstStream.reset(new raw_string_ostream(*InstString));
205 InstPrinter.reset(Tgt->createMCInstPrinter(LLVMSyntaxVariant, *AsmInfo));
210 GenericAsmLexer.reset(new AsmLexer(*AsmInfo));
211 SpecificAsmLexer.reset(Tgt->createAsmLexer(*AsmInfo));
212 SpecificAsmLexer->InstallLexer(*GenericAsmLexer);
214 initMaps(*TargetMachine->getRegisterInfo());
219 EDDisassembler::~EDDisassembler() {
225 /// EDMemoryObject - a subclass of MemoryObject that allows use of a callback
226 /// as provided by the sd interface. See MemoryObject.
227 class EDMemoryObject : public llvm::MemoryObject {
229 EDByteReaderCallback Callback;
232 EDMemoryObject(EDByteReaderCallback callback,
233 void *arg) : Callback(callback), Arg(arg) { }
234 ~EDMemoryObject() { }
235 uint64_t getBase() const { return 0x0; }
236 uint64_t getExtent() const { return (uint64_t)-1; }
237 int readByte(uint64_t address, uint8_t *ptr) const {
241 if (Callback(ptr, address, Arg))
249 EDInst *EDDisassembler::createInst(EDByteReaderCallback byteReader,
252 EDMemoryObject memoryObject(byteReader, arg);
254 MCInst* inst = new MCInst;
257 if (!Disassembler->getInstruction(*inst,
265 const llvm::EDInstInfo *thisInstInfo = NULL;
268 thisInstInfo = &InstInfos[inst->getOpcode()];
271 EDInst* sdInst = new EDInst(inst, byteSize, *this, thisInstInfo);
276 void EDDisassembler::initMaps(const TargetRegisterInfo ®isterInfo) {
277 unsigned numRegisters = registerInfo.getNumRegs();
278 unsigned registerIndex;
280 for (registerIndex = 0; registerIndex < numRegisters; ++registerIndex) {
281 const char* registerName = registerInfo.get(registerIndex).Name;
283 RegVec.push_back(registerName);
284 RegRMap[registerName] = registerIndex;
292 stackPointers.insert(registerIDWithName("SP"));
293 stackPointers.insert(registerIDWithName("ESP"));
294 stackPointers.insert(registerIDWithName("RSP"));
296 programCounters.insert(registerIDWithName("IP"));
297 programCounters.insert(registerIDWithName("EIP"));
298 programCounters.insert(registerIDWithName("RIP"));
302 stackPointers.insert(registerIDWithName("SP"));
304 programCounters.insert(registerIDWithName("PC"));
309 const char *EDDisassembler::nameWithRegisterID(unsigned registerID) const {
310 if (registerID >= RegVec.size())
313 return RegVec[registerID].c_str();
316 unsigned EDDisassembler::registerIDWithName(const char *name) const {
317 regrmap_t::const_iterator iter = RegRMap.find(std::string(name));
318 if (iter == RegRMap.end())
321 return (*iter).second;
324 bool EDDisassembler::registerIsStackPointer(unsigned registerID) {
325 return (stackPointers.find(registerID) != stackPointers.end());
328 bool EDDisassembler::registerIsProgramCounter(unsigned registerID) {
329 return (programCounters.find(registerID) != programCounters.end());
332 int EDDisassembler::printInst(std::string &str, MCInst &inst) {
333 PrinterMutex.acquire();
335 InstPrinter->printInst(&inst, *InstStream);
340 PrinterMutex.release();
345 static void diag_handler(const SMDiagnostic &diag,
349 EDDisassembler *disassembler = static_cast<EDDisassembler*>(context);
350 diag.Print("", disassembler->ErrorStream);
354 int EDDisassembler::parseInst(SmallVectorImpl<MCParsedAsmOperand*> &operands,
355 SmallVectorImpl<AsmToken> &tokens,
356 const std::string &str) {
369 const char *cStr = str.c_str();
370 MemoryBuffer *buf = MemoryBuffer::getMemBuffer(cStr, cStr + strlen(cStr));
376 sourceMgr.setDiagHandler(diag_handler, static_cast<void*>(this));
377 sourceMgr.AddNewSourceBuffer(buf, SMLoc()); // ownership of buf handed over
378 MCContext context(*AsmInfo, *MRI, NULL);
379 OwningPtr<MCStreamer> streamer(createNullStreamer(context));
380 OwningPtr<MCAsmParser> genericParser(createMCAsmParser(*Tgt, sourceMgr,
384 StringRef triple = tripleFromArch(Key.Arch);
385 OwningPtr<MCSubtargetInfo> STI(Tgt->createMCSubtargetInfo(triple, "", ""));
386 OwningPtr<TargetAsmParser> TargetParser(Tgt->createAsmParser(*STI,
389 AsmToken OpcodeToken = genericParser->Lex();
390 AsmToken NextToken = genericParser->Lex(); // consume next token, because specificParser expects us to
392 if (OpcodeToken.is(AsmToken::Identifier)) {
393 instName = OpcodeToken.getString();
394 instLoc = OpcodeToken.getLoc();
396 if (NextToken.isNot(AsmToken::Eof) &&
397 TargetParser->ParseInstruction(instName, instLoc, operands))
403 ParserMutex.acquire();
406 GenericAsmLexer->setBuffer(buf);
408 while (SpecificAsmLexer->Lex(),
409 SpecificAsmLexer->isNot(AsmToken::Eof) &&
410 SpecificAsmLexer->isNot(AsmToken::EndOfStatement)) {
411 if (SpecificAsmLexer->is(AsmToken::Error)) {
415 tokens.push_back(SpecificAsmLexer->getTok());
419 ParserMutex.release();
424 int EDDisassembler::llvmSyntaxVariant() const {
425 return LLVMSyntaxVariant;