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 STI.reset(Tgt->createMCSubtargetInfo(tripleString, "", ""));
186 Disassembler.reset(Tgt->createMCDisassembler(*STI));
191 InstInfos = Disassembler->getEDInfo();
193 InstString.reset(new std::string);
194 InstStream.reset(new raw_string_ostream(*InstString));
195 InstPrinter.reset(Tgt->createMCInstPrinter(LLVMSyntaxVariant, *AsmInfo, *STI));
200 GenericAsmLexer.reset(new AsmLexer(*AsmInfo));
201 SpecificAsmLexer.reset(Tgt->createMCAsmLexer(*MRI, *AsmInfo));
202 SpecificAsmLexer->InstallLexer(*GenericAsmLexer);
209 EDDisassembler::~EDDisassembler() {
215 /// EDMemoryObject - a subclass of MemoryObject that allows use of a callback
216 /// as provided by the sd interface. See MemoryObject.
217 class EDMemoryObject : public llvm::MemoryObject {
219 EDByteReaderCallback Callback;
222 EDMemoryObject(EDByteReaderCallback callback,
223 void *arg) : Callback(callback), Arg(arg) { }
224 ~EDMemoryObject() { }
225 uint64_t getBase() const { return 0x0; }
226 uint64_t getExtent() const { return (uint64_t)-1; }
227 int readByte(uint64_t address, uint8_t *ptr) const {
231 if (Callback(ptr, address, Arg))
239 EDInst *EDDisassembler::createInst(EDByteReaderCallback byteReader,
242 EDMemoryObject memoryObject(byteReader, arg);
244 MCInst* inst = new MCInst;
247 MCDisassembler::DecodeStatus S;
248 S = Disassembler->getInstruction(*inst, byteSize, memoryObject, address,
251 case MCDisassembler::Fail:
252 case MCDisassembler::SoftFail:
253 // FIXME: Do something different on soft failure mode?
257 case MCDisassembler::Success: {
258 const llvm::EDInstInfo *thisInstInfo = NULL;
261 thisInstInfo = &InstInfos[inst->getOpcode()];
264 EDInst* sdInst = new EDInst(inst, byteSize, *this, thisInstInfo);
271 void EDDisassembler::initMaps(const MCRegisterInfo ®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;
287 stackPointers.insert(registerIDWithName("SP"));
288 stackPointers.insert(registerIDWithName("ESP"));
289 stackPointers.insert(registerIDWithName("RSP"));
291 programCounters.insert(registerIDWithName("IP"));
292 programCounters.insert(registerIDWithName("EIP"));
293 programCounters.insert(registerIDWithName("RIP"));
297 stackPointers.insert(registerIDWithName("SP"));
299 programCounters.insert(registerIDWithName("PC"));
304 const char *EDDisassembler::nameWithRegisterID(unsigned registerID) const {
305 if (registerID >= RegVec.size())
308 return RegVec[registerID].c_str();
311 unsigned EDDisassembler::registerIDWithName(const char *name) const {
312 regrmap_t::const_iterator iter = RegRMap.find(std::string(name));
313 if (iter == RegRMap.end())
316 return (*iter).second;
319 bool EDDisassembler::registerIsStackPointer(unsigned registerID) {
320 return (stackPointers.find(registerID) != stackPointers.end());
323 bool EDDisassembler::registerIsProgramCounter(unsigned registerID) {
324 return (programCounters.find(registerID) != programCounters.end());
327 int EDDisassembler::printInst(std::string &str, MCInst &inst) {
328 PrinterMutex.acquire();
330 InstPrinter->printInst(&inst, *InstStream);
335 PrinterMutex.release();
340 static void diag_handler(const SMDiagnostic &diag,
344 EDDisassembler *disassembler = static_cast<EDDisassembler*>(context);
345 diag.Print("", disassembler->ErrorStream);
349 int EDDisassembler::parseInst(SmallVectorImpl<MCParsedAsmOperand*> &operands,
350 SmallVectorImpl<AsmToken> &tokens,
351 const std::string &str) {
364 const char *cStr = str.c_str();
365 MemoryBuffer *buf = MemoryBuffer::getMemBuffer(cStr, cStr + strlen(cStr));
371 sourceMgr.setDiagHandler(diag_handler, static_cast<void*>(this));
372 sourceMgr.AddNewSourceBuffer(buf, SMLoc()); // ownership of buf handed over
373 MCContext context(*AsmInfo, *MRI, NULL);
374 OwningPtr<MCStreamer> streamer(createNullStreamer(context));
375 OwningPtr<MCAsmParser> genericParser(createMCAsmParser(sourceMgr,
379 StringRef triple = tripleFromArch(Key.Arch);
380 OwningPtr<MCSubtargetInfo> STI(Tgt->createMCSubtargetInfo(triple, "", ""));
381 OwningPtr<MCTargetAsmParser>
382 TargetParser(Tgt->createMCAsmParser(*STI, *genericParser));
384 AsmToken OpcodeToken = genericParser->Lex();
385 AsmToken NextToken = genericParser->Lex(); // consume next token, because specificParser expects us to
387 if (OpcodeToken.is(AsmToken::Identifier)) {
388 instName = OpcodeToken.getString();
389 instLoc = OpcodeToken.getLoc();
391 if (NextToken.isNot(AsmToken::Eof) &&
392 TargetParser->ParseInstruction(instName, instLoc, operands))
398 ParserMutex.acquire();
401 GenericAsmLexer->setBuffer(buf);
403 while (SpecificAsmLexer->Lex(),
404 SpecificAsmLexer->isNot(AsmToken::Eof) &&
405 SpecificAsmLexer->isNot(AsmToken::EndOfStatement)) {
406 if (SpecificAsmLexer->is(AsmToken::Error)) {
410 tokens.push_back(SpecificAsmLexer->getTok());
414 ParserMutex.release();
419 int EDDisassembler::llvmSyntaxVariant() const {
420 return LLVMSyntaxVariant;