1 //===- Disassembler.cpp - Disassembler for hex strings --------------------===//
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 class implements the disassembler of strings of bytes written in
11 // hexadecimal, from standard input or from a file.
13 //===----------------------------------------------------------------------===//
15 #include "Disassembler.h"
16 #include "../../lib/MC/MCDisassembler/EDDisassembler.h"
17 #include "../../lib/MC/MCDisassembler/EDInst.h"
18 #include "../../lib/MC/MCDisassembler/EDOperand.h"
19 #include "../../lib/MC/MCDisassembler/EDToken.h"
20 #include "llvm/MC/MCAsmInfo.h"
21 #include "llvm/MC/MCDisassembler.h"
22 #include "llvm/MC/MCInst.h"
23 #include "llvm/MC/MCInstPrinter.h"
24 #include "llvm/Target/TargetRegistry.h"
25 #include "llvm/ADT/OwningPtr.h"
26 #include "llvm/ADT/Triple.h"
27 #include "llvm/Support/MemoryBuffer.h"
28 #include "llvm/Support/MemoryObject.h"
29 #include "llvm/Support/raw_ostream.h"
30 #include "llvm/Support/SourceMgr.h"
33 typedef std::vector<std::pair<unsigned char, const char*> > ByteArrayTy;
36 class VectorMemoryObject : public MemoryObject {
38 const ByteArrayTy &Bytes;
40 VectorMemoryObject(const ByteArrayTy &bytes) : Bytes(bytes) {}
42 uint64_t getBase() const { return 0; }
43 uint64_t getExtent() const { return Bytes.size(); }
45 int readByte(uint64_t Addr, uint8_t *Byte) const {
46 if (Addr > getExtent())
48 *Byte = Bytes[Addr].first;
54 static bool PrintInsts(const MCDisassembler &DisAsm,
55 MCInstPrinter &Printer, const ByteArrayTy &Bytes,
56 SourceMgr &SM, raw_ostream &Out) {
57 // Wrap the vector in a MemoryObject.
58 VectorMemoryObject memoryObject(Bytes);
60 // Disassemble it to strings.
64 for (Index = 0; Index < Bytes.size(); Index += Size) {
67 if (DisAsm.getInstruction(Inst, Size, memoryObject, Index,
68 /*REMOVE*/ nulls())) {
69 Printer.printInst(&Inst, Out);
72 SM.PrintMessage(SMLoc::getFromPointer(Bytes[Index].second),
73 "invalid instruction encoding", "warning");
75 Size = 1; // skip illegible bytes
82 static bool ByteArrayFromString(ByteArrayTy &ByteArray,
85 while (!Str.empty()) {
86 // Strip horizontal whitespace.
87 if (size_t Pos = Str.find_first_not_of(" \t\r")) {
88 Str = Str.substr(Pos);
92 // If this is the end of a line or start of a comment, remove the rest of
94 if (Str[0] == '\n' || Str[0] == '#') {
95 // Strip to the end of line if we already processed any bytes on this
96 // line. This strips the comment and/or the \n.
100 Str = Str.substr(Str.find_first_of('\n'));
107 // Get the current token.
108 size_t Next = Str.find_first_of(" \t\n\r#");
109 StringRef Value = Str.substr(0, Next);
111 // Convert to a byte and add to the byte vector.
113 if (Value.getAsInteger(0, ByteVal) || ByteVal > 255) {
114 // If we have an error, print it and skip to the end of line.
115 SM.PrintMessage(SMLoc::getFromPointer(Value.data()),
116 "invalid input token", "error");
117 Str = Str.substr(Str.find('\n'));
122 ByteArray.push_back(std::make_pair((unsigned char)ByteVal, Value.data()));
123 Str = Str.substr(Next);
129 int Disassembler::disassemble(const Target &T, const std::string &Triple,
130 MemoryBuffer &Buffer,
132 // Set up disassembler.
133 OwningPtr<const MCAsmInfo> AsmInfo(T.createAsmInfo(Triple));
136 errs() << "error: no assembly info for target " << Triple << "\n";
140 OwningPtr<const MCDisassembler> DisAsm(T.createMCDisassembler());
142 errs() << "error: no disassembler for target " << Triple << "\n";
146 int AsmPrinterVariant = AsmInfo->getAssemblerDialect();
147 OwningPtr<MCInstPrinter> IP(T.createMCInstPrinter(AsmPrinterVariant,
150 errs() << "error: no instruction printer for target " << Triple << '\n';
154 bool ErrorOccurred = false;
157 SM.AddNewSourceBuffer(&Buffer, SMLoc());
159 // Convert the input to a vector for disassembly.
160 ByteArrayTy ByteArray;
161 StringRef Str = Buffer.getBuffer();
163 ErrorOccurred |= ByteArrayFromString(ByteArray, Str, SM);
165 if (!ByteArray.empty())
166 ErrorOccurred |= PrintInsts(*DisAsm, *IP, ByteArray, SM, Out);
168 return ErrorOccurred;
171 static int byteArrayReader(uint8_t *B, uint64_t A, void *Arg) {
172 ByteArrayTy &ByteArray = *((ByteArrayTy*)Arg);
174 if (A >= ByteArray.size())
177 *B = ByteArray[A].first;
182 static int verboseEvaluator(uint64_t *V, unsigned R, void *Arg) {
183 EDDisassembler &disassembler = *(EDDisassembler *)((void **)Arg)[0];
184 raw_ostream &Out = *(raw_ostream *)((void **)Arg)[1];
186 if (const char *regName = disassembler.nameWithRegisterID(R))
187 Out << "[" << regName << "/" << R << "]";
189 if (disassembler.registerIsStackPointer(R))
191 if (disassembler.registerIsProgramCounter(R))
198 int Disassembler::disassembleEnhanced(const std::string &TS,
199 MemoryBuffer &Buffer,
201 ByteArrayTy ByteArray;
202 StringRef Str = Buffer.getBuffer();
205 SM.AddNewSourceBuffer(&Buffer, SMLoc());
207 if (ByteArrayFromString(ByteArray, Str, SM)) {
212 EDDisassembler::AssemblySyntax AS;
214 switch (T.getArch()) {
216 errs() << "error: no default assembly syntax for " << TS.c_str() << "\n";
220 AS = EDDisassembler::kEDAssemblySyntaxARMUAL;
224 AS = EDDisassembler::kEDAssemblySyntaxX86ATT;
228 EDDisassembler::initialize();
229 EDDisassembler *disassembler =
230 EDDisassembler::getDisassembler(TS.c_str(), AS);
232 if (disassembler == 0) {
233 errs() << "error: couldn't get disassembler for " << TS << '\n';
238 disassembler->createInst(byteArrayReader, 0, &ByteArray);
241 errs() << "error: Didn't get an instruction\n";
245 unsigned numTokens = inst->numTokens();
246 if ((int)numTokens < 0) {
247 errs() << "error: couldn't count the instruction's tokens\n";
251 for (unsigned tokenIndex = 0; tokenIndex != numTokens; ++tokenIndex) {
254 if (inst->getToken(token, tokenIndex)) {
255 errs() << "error: Couldn't get token\n";
260 if (token->getString(buf)) {
261 errs() << "error: Couldn't get string for token\n";
266 int operandIndex = token->operandID();
268 if (operandIndex >= 0)
269 Out << operandIndex << "-";
271 switch (token->type()) {
272 default: Out << "?"; break;
273 case EDToken::kTokenWhitespace: Out << "w"; break;
274 case EDToken::kTokenPunctuation: Out << "p"; break;
275 case EDToken::kTokenOpcode: Out << "o"; break;
276 case EDToken::kTokenLiteral: Out << "l"; break;
277 case EDToken::kTokenRegister: Out << "r"; break;
282 if (token->type() == EDToken::kTokenLiteral) {
284 if (token->literalSign())
286 uint64_t absoluteValue;
287 if (token->literalAbsoluteValue(absoluteValue)) {
288 errs() << "error: Couldn't get the value of a literal token\n";
291 Out << absoluteValue;
292 } else if (token->type() == EDToken::kTokenRegister) {
295 if (token->registerID(regID)) {
296 errs() << "error: Couldn't get the ID of a register token\n";
307 if (inst->isBranch())
312 unsigned numOperands = inst->numOperands();
314 if ((int)numOperands < 0) {
315 errs() << "error: Couldn't count operands\n";
319 for (unsigned operandIndex = 0; operandIndex != numOperands; ++operandIndex) {
320 Out << operandIndex << ":";
323 if (inst->getOperand(operand, operandIndex)) {
324 errs() << "error: couldn't get operand\n";
328 uint64_t evaluatedResult;
329 void *Arg[] = { disassembler, &Out };
330 evaluatedResult = operand->evaluate(evaluatedResult, verboseEvaluator, Arg);
331 Out << "=" << evaluatedResult << " ";