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"
17 #include "llvm/ADT/OwningPtr.h"
18 #include "llvm/ADT/Triple.h"
19 #include "llvm/MC/MCAsmInfo.h"
20 #include "llvm/MC/MCDisassembler.h"
21 #include "llvm/MC/MCInst.h"
22 #include "llvm/MC/MCInstPrinter.h"
23 #include "llvm/Target/TargetRegistry.h"
24 #include "llvm/Support/MemoryBuffer.h"
25 #include "llvm/Support/MemoryObject.h"
26 #include "llvm/Support/raw_ostream.h"
27 #include "llvm/Support/SourceMgr.h"
29 #include "llvm-c/EnhancedDisassembly.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
,
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
, outs());
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
) {
131 // Set up disassembler.
132 OwningPtr
<const MCAsmInfo
> AsmInfo(T
.createAsmInfo(Triple
));
135 errs() << "error: no assembly info for target " << Triple
<< "\n";
139 OwningPtr
<const MCDisassembler
> DisAsm(T
.createMCDisassembler());
141 errs() << "error: no disassembler for target " << Triple
<< "\n";
145 int AsmPrinterVariant
= AsmInfo
->getAssemblerDialect();
146 OwningPtr
<MCInstPrinter
> IP(T
.createMCInstPrinter(AsmPrinterVariant
,
149 errs() << "error: no instruction printer for target " << Triple
<< '\n';
153 bool ErrorOccurred
= false;
156 SM
.AddNewSourceBuffer(&Buffer
, SMLoc());
158 // Convert the input to a vector for disassembly.
159 ByteArrayTy ByteArray
;
160 StringRef Str
= Buffer
.getBuffer();
162 ErrorOccurred
|= ByteArrayFromString(ByteArray
, Str
, SM
);
164 if (!ByteArray
.empty())
165 ErrorOccurred
|= PrintInsts(*DisAsm
, *IP
, ByteArray
, SM
);
167 return ErrorOccurred
;
170 static int byteArrayReader(uint8_t *B
, uint64_t A
, void *Arg
) {
171 ByteArrayTy
&ByteArray
= *((ByteArrayTy
*)Arg
);
173 if (A
>= ByteArray
.size())
176 *B
= ByteArray
[A
].first
;
181 static int verboseEvaluator(uint64_t *V
, unsigned R
, void *Arg
) {
182 EDDisassemblerRef
&disassembler
= *((EDDisassemblerRef
*)Arg
);
186 if (!EDGetRegisterName(®Name
,
189 outs() << "[" << regName
<< "/" << R
<< "]";
190 if (EDRegisterIsStackPointer(disassembler
, R
))
192 if (EDRegisterIsProgramCounter(disassembler
, R
))
200 int Disassembler::disassembleEnhanced(const std::string
&TS
,
201 MemoryBuffer
&Buffer
) {
202 ByteArrayTy ByteArray
;
203 StringRef Str
= Buffer
.getBuffer();
206 SM
.AddNewSourceBuffer(&Buffer
, SMLoc());
208 if (ByteArrayFromString(ByteArray
, Str
, SM
)) {
212 EDDisassemblerRef disassembler
;
215 EDAssemblySyntax_t AS
;
217 switch (T
.getArch()) {
219 errs() << "error: no default assembly syntax for " << TS
.c_str() << "\n";
223 AS
= kEDAssemblySyntaxARMUAL
;
227 AS
= kEDAssemblySyntaxX86ATT
;
231 if (EDGetDisassembler(&disassembler
,
234 errs() << "error: couldn't get disassembler for " << TS
.c_str() << "\n";
240 if (EDCreateInsts(&inst
, 1, disassembler
, byteArrayReader
, 0,&ByteArray
)
242 errs() << "error: Didn't get an instruction\n";
246 int numTokens
= EDNumTokens(inst
);
249 errs() << "error: Couldn't count the instruction's tokens\n";
255 for (tokenIndex
= 0; tokenIndex
< numTokens
; ++tokenIndex
) {
258 if (EDGetToken(&token
, inst
, tokenIndex
)) {
259 errs() << "error: Couldn't get token\n";
265 if (EDGetTokenString(&buf
, token
)) {
266 errs() << "error: Couldn't get string for token\n";
272 int operandIndex
= EDOperandIndexForToken(token
);
274 if (operandIndex
>= 0)
275 outs() << operandIndex
<< "-";
277 if (EDTokenIsWhitespace(token
)) {
279 } else if (EDTokenIsPunctuation(token
)) {
281 } else if (EDTokenIsOpcode(token
)) {
283 } else if (EDTokenIsLiteral(token
)) {
285 } else if (EDTokenIsRegister(token
)) {
291 outs() << ":" << buf
;
293 if (EDTokenIsLiteral(token
)) {
295 if (EDTokenIsNegativeLiteral(token
))
297 uint64_t absoluteValue
;
298 if (EDLiteralTokenAbsoluteValue(&absoluteValue
, token
)) {
299 errs() << "error: Couldn't get the value of a literal token\n";
302 outs() << absoluteValue
;
303 } else if (EDTokenIsRegister(token
)) {
306 if (EDRegisterTokenValue(®ID
, token
)) {
307 errs() << "error: Couldn't get the ID of a register token\n";
310 outs() << "r" << regID
;
318 if (EDInstIsBranch(inst
))
320 if (EDInstIsMove(inst
))
323 int numOperands
= EDNumOperands(inst
);
325 if (numOperands
< 0) {
326 errs() << "error: Couldn't count operands\n";
332 for (operandIndex
= 0; operandIndex
< numOperands
; ++operandIndex
) {
333 outs() << operandIndex
<< ":";
335 EDOperandRef operand
;
337 if (EDGetOperand(&operand
,
340 errs() << "error: Couldn't get operand\n";
344 uint64_t evaluatedResult
;
346 EDEvaluateOperand(&evaluatedResult
,
351 outs() << "=" << evaluatedResult
;