1 //===-- llvm-objdump.cpp - Object file dumping utility for llvm -----------===//
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 program is a utility that works like binutils "objdump", that is, it
11 // dumps out a plethora of information about an object file depending on the
14 //===----------------------------------------------------------------------===//
16 #include "llvm/Object/ObjectFile.h"
17 // This config must be included before llvm-config.h.
18 #include "llvm/Config/config.h"
19 #include "../../lib/MC/MCDisassembler/EDDisassembler.h"
20 #include "../../lib/MC/MCDisassembler/EDInst.h"
21 #include "../../lib/MC/MCDisassembler/EDOperand.h"
22 #include "../../lib/MC/MCDisassembler/EDToken.h"
23 #include "llvm/ADT/OwningPtr.h"
24 #include "llvm/ADT/Triple.h"
25 #include "llvm/MC/MCAsmInfo.h"
26 #include "llvm/MC/MCDisassembler.h"
27 #include "llvm/MC/MCInst.h"
28 #include "llvm/MC/MCInstPrinter.h"
29 #include "llvm/Support/CommandLine.h"
30 #include "llvm/Support/Debug.h"
31 #include "llvm/Support/Format.h"
32 #include "llvm/Support/Host.h"
33 #include "llvm/Support/ManagedStatic.h"
34 #include "llvm/Support/MemoryBuffer.h"
35 #include "llvm/Support/MemoryBuffer.h"
36 #include "llvm/Support/MemoryObject.h"
37 #include "llvm/Support/PrettyStackTrace.h"
38 #include "llvm/Support/Signals.h"
39 #include "llvm/Support/SourceMgr.h"
40 #include "llvm/Support/raw_ostream.h"
41 #include "llvm/Support/raw_ostream.h"
42 #include "llvm/Support/system_error.h"
43 #include "llvm/Target/TargetRegistry.h"
44 #include "llvm/Target/TargetSelect.h"
51 using namespace object;
55 InputFilenames(cl::Positional, cl::desc("<input object files>"),
59 Disassemble("disassemble",
60 cl::desc("Display assembler mnemonics for the machine instructions"));
62 Disassembled("d", cl::desc("Alias for --disassemble"),
63 cl::aliasopt(Disassemble));
66 TripleName("triple", cl::desc("Target triple to disassemble for, "
67 "see -version for available targets"));
70 ArchName("arch", cl::desc("Target arch to disassemble for, "
71 "see -version for available targets"));
76 static const Target *GetTarget(const ObjectFile *Obj = NULL) {
77 // Figure out the target triple.
78 llvm::Triple TT("unknown-unknown-unknown");
79 if (TripleName.empty()) {
81 TT.setArch(Triple::ArchType(Obj->getArch()));
83 TT.setTriple(Triple::normalize(TripleName));
85 if (!ArchName.empty())
86 TT.setArchName(ArchName);
88 TripleName = TT.str();
90 // Get the target specific parser.
92 const Target *TheTarget = TargetRegistry::lookupTarget(TripleName, Error);
96 errs() << ToolName << ": error: unable to get target for '" << TripleName
97 << "', see --version and --triple.\n";
102 class StringRefMemoryObject : public MemoryObject {
106 StringRefMemoryObject(StringRef bytes) : Bytes(bytes) {}
108 uint64_t getBase() const { return 0; }
109 uint64_t getExtent() const { return Bytes.size(); }
111 int readByte(uint64_t Addr, uint8_t *Byte) const {
112 if (Addr > getExtent())
120 static void DumpBytes(StringRef bytes) {
121 static char hex_rep[] = "0123456789abcdef";
122 // FIXME: The real way to do this is to figure out the longest instruction
123 // and align to that size before printing. I'll fix this when I get
124 // around to outputting relocations.
125 // 15 is the longest x86 instruction
126 // 3 is for the hex rep of a byte + a space.
127 // 1 is for the null terminator.
128 enum { OutputSize = (15 * 3) + 1 };
129 char output[OutputSize];
131 assert(bytes.size() <= 15
132 && "DumpBytes only supports instructions of up to 15 bytes");
133 memset(output, ' ', sizeof(output));
135 for (StringRef::iterator i = bytes.begin(),
136 e = bytes.end(); i != e; ++i) {
137 output[index] = hex_rep[(*i & 0xF0) >> 4];
138 output[index + 1] = hex_rep[*i & 0xF];
142 output[sizeof(output) - 1] = 0;
146 static void DisassembleInput(const StringRef &Filename) {
147 OwningPtr<MemoryBuffer> Buff;
149 if (error_code ec = MemoryBuffer::getFileOrSTDIN(Filename, Buff)) {
150 errs() << ToolName << ": " << Filename << ": " << ec.message() << "\n";
154 OwningPtr<ObjectFile> Obj(ObjectFile::createObjectFile(Buff.take()));
156 const Target *TheTarget = GetTarget(Obj.get());
158 // GetTarget prints out stuff.
164 << ":\tfile format " << Obj->getFileFormatName() << "\n\n\n";
166 for (ObjectFile::section_iterator i = Obj->begin_sections(),
167 e = Obj->end_sections();
171 outs() << "Disassembly of section " << i->getName() << ":\n\n";
173 // Set up disassembler.
174 OwningPtr<const MCAsmInfo> AsmInfo(TheTarget->createAsmInfo(TripleName));
177 errs() << "error: no assembly info for target " << TripleName << "\n";
181 OwningPtr<const MCDisassembler> DisAsm(TheTarget->createMCDisassembler());
183 errs() << "error: no disassembler for target " << TripleName << "\n";
187 int AsmPrinterVariant = AsmInfo->getAssemblerDialect();
188 OwningPtr<MCInstPrinter> IP(TheTarget->createMCInstPrinter(
189 AsmPrinterVariant, *AsmInfo));
191 errs() << "error: no instruction printer for target " << TripleName << '\n';
195 StringRef Bytes = i->getContents();
196 StringRefMemoryObject memoryObject(Bytes);
200 for (Index = 0; Index < Bytes.size(); Index += Size) {
204 raw_ostream &DebugOut = DebugFlag ? dbgs() : nulls();
206 raw_ostream &DebugOut = nulls();
209 if (DisAsm->getInstruction(Inst, Size, memoryObject, Index, DebugOut)) {
210 outs() << format("%8x:\t", i->getAddress() + Index);
211 DumpBytes(StringRef(Bytes.data() + Index, Size));
212 IP->printInst(&Inst, outs());
215 errs() << ToolName << ": warning: invalid instruction encoding\n";
217 Size = 1; // skip illegible bytes
223 int main(int argc, char **argv) {
224 // Print a stack trace if we signal out.
225 sys::PrintStackTraceOnErrorSignal();
226 PrettyStackTraceProgram X(argc, argv);
227 llvm_shutdown_obj Y; // Call llvm_shutdown() on exit.
229 // Initialize targets and assembly printers/parsers.
230 llvm::InitializeAllTargetInfos();
231 // FIXME: We shouldn't need to initialize the Target(Machine)s.
232 llvm::InitializeAllTargets();
233 llvm::InitializeAllAsmPrinters();
234 llvm::InitializeAllAsmParsers();
235 llvm::InitializeAllDisassemblers();
237 cl::ParseCommandLineOptions(argc, argv, "llvm object file dumper\n");
238 TripleName = Triple::normalize(TripleName);
242 // Defaults to a.out if no filenames specified.
243 if (InputFilenames.size() == 0)
244 InputFilenames.push_back("a.out");
246 // -d is the only flag that is currently implemented, so just print help if
249 cl::PrintHelpMessage();
253 std::for_each(InputFilenames.begin(), InputFilenames.end(),