1 //===-- macho-dump.cpp - Mach Object Dumping Tool -------------------------===//
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 is a testing tool for use with the MC/Mach-O LLVM components.
12 //===----------------------------------------------------------------------===//
14 #include "llvm/Object/MachOObject.h"
15 #include "llvm/ADT/Twine.h"
16 #include "llvm/Support/CommandLine.h"
17 #include "llvm/Support/ManagedStatic.h"
18 #include "llvm/Support/MemoryBuffer.h"
19 #include "llvm/Support/raw_ostream.h"
21 using namespace llvm::object;
23 static cl::opt<std::string>
24 InputFile(cl::Positional, cl::desc("<input file>"), cl::init("-"));
27 DumpSectionData("dump-section-data", cl::desc("Dump the contents of sections"),
32 static const char *ProgramName;
34 static void Message(const char *Type, const Twine &Msg) {
35 errs() << ProgramName << ": " << Type << ": " << Msg << "\n";
38 static int Error(const Twine &Msg) {
39 Message("error", Msg);
43 static void Warning(const Twine &Msg) {
44 Message("warning", Msg);
49 static int DumpHeader(MachOObject &Obj) {
51 const macho::Header &Hdr = Obj.getHeader();
52 outs() << "('cputype', " << Hdr.CPUType << ")\n";
53 outs() << "('cpusubtype', " << Hdr.CPUSubtype << ")\n";
54 outs() << "('filetype', " << Hdr.FileType << ")\n";
55 outs() << "('num_load_commands', " << Hdr.NumLoadCommands << ")\n";
56 outs() << "('load_commands_size', " << Hdr.SizeOfLoadCommands << ")\n";
57 outs() << "('flag', " << Hdr.Flags << ")\n";
59 // Print extended header if 64-bit.
61 const macho::Header64Ext &Hdr64 = Obj.getHeader64Ext();
62 outs() << "('reserved', " << Hdr64.Reserved << ")\n";
68 static void DumpSegmentCommandData(StringRef Name,
69 uint64_t VMAddr, uint64_t VMSize,
70 uint64_t FileOffset, uint64_t FileSize,
71 uint32_t MaxProt, uint32_t InitProt,
72 uint32_t NumSections, uint32_t Flags) {
73 outs() << " ('segment_name', '";
74 outs().write_escaped(Name, /*UseHexEscapes=*/true) << "')\n";
75 outs() << " ('vm_addr', " << VMAddr << ")\n";
76 outs() << " ('vm_size', " << VMSize << ")\n";
77 outs() << " ('file_offset', " << FileOffset << ")\n";
78 outs() << " ('file_size', " << FileSize << ")\n";
79 outs() << " ('maxprot', " << MaxProt << ")\n";
80 outs() << " ('initprot', " << InitProt << ")\n";
81 outs() << " ('num_sections', " << NumSections << ")\n";
82 outs() << " ('flags', " << Flags << ")\n";
85 static int DumpSegmentCommand(MachOObject &Obj,
86 const MachOObject::LoadCommandInfo &LCI) {
87 InMemoryStruct<macho::SegmentLoadCommand> SLC;
88 Obj.ReadSegmentLoadCommand(LCI, SLC);
90 return Error("unable to read segment load command");
92 DumpSegmentCommandData(StringRef(SLC->Name, 16), SLC->VMAddress, SLC->VMSize,
93 SLC->FileOffset, SLC->FileSize,
94 SLC->MaxVMProtection, SLC->InitialVMProtection,
95 SLC->NumSections, SLC->Flags);
99 static int DumpSegment64Command(MachOObject &Obj,
100 const MachOObject::LoadCommandInfo &LCI) {
101 InMemoryStruct<macho::Segment64LoadCommand> SLC;
102 Obj.ReadSegment64LoadCommand(LCI, SLC);
104 return Error("unable to read segment load command");
106 DumpSegmentCommandData(StringRef(SLC->Name, 16), SLC->VMAddress, SLC->VMSize,
107 SLC->FileOffset, SLC->FileSize,
108 SLC->MaxVMProtection, SLC->InitialVMProtection,
109 SLC->NumSections, SLC->Flags);
114 static int DumpSymtabCommand(MachOObject &Obj,
115 const MachOObject::LoadCommandInfo &LCI) {
116 InMemoryStruct<macho::SymtabLoadCommand> SLC;
117 Obj.ReadSymtabLoadCommand(LCI, SLC);
119 return Error("unable to read segment load command");
121 outs() << " ('symoff', " << SLC->SymbolTableOffset << ")\n";
122 outs() << " ('nsyms', " << SLC->NumSymbolTableEntries << ")\n";
123 outs() << " ('stroff', " << SLC->StringTableOffset << ")\n";
124 outs() << " ('strsize', " << SLC->StringTableSize << ")\n";
129 static int DumpDysymtabCommand(MachOObject &Obj,
130 const MachOObject::LoadCommandInfo &LCI) {
131 InMemoryStruct<macho::DysymtabLoadCommand> DLC;
132 Obj.ReadDysymtabLoadCommand(LCI, DLC);
134 return Error("unable to read segment load command");
136 outs() << " ('ilocalsym', " << DLC->LocalSymbolIndex << ")\n";
137 outs() << " ('nlocalsym', " << DLC->NumLocalSymbols << ")\n";
138 outs() << " ('iextdefsym', " << DLC->ExternalSymbolsIndex << ")\n";
139 outs() << " ('nextdefsym', " << DLC->NumExternalSymbols << ")\n";
140 outs() << " ('iundefsym', " << DLC->UndefinedSymbolsIndex << ")\n";
141 outs() << " ('nundefsym', " << DLC->NumUndefinedSymbols << ")\n";
142 outs() << " ('tocoff', " << DLC->TOCOffset << ")\n";
143 outs() << " ('ntoc', " << DLC->NumTOCEntries << ")\n";
144 outs() << " ('modtaboff', " << DLC->ModuleTableOffset << ")\n";
145 outs() << " ('nmodtab', " << DLC->NumModuleTableEntries << ")\n";
146 outs() << " ('extrefsymoff', " << DLC->ReferenceSymbolTableOffset << ")\n";
147 outs() << " ('nextrefsyms', "
148 << DLC->NumReferencedSymbolTableEntries << ")\n";
149 outs() << " ('indirectsymoff', " << DLC->IndirectSymbolTableOffset << ")\n";
150 outs() << " ('nindirectsyms', "
151 << DLC->NumIndirectSymbolTableEntries << ")\n";
152 outs() << " ('extreloff', " << DLC->ExternalRelocationTableOffset << ")\n";
153 outs() << " ('nextrel', " << DLC->NumExternalRelocationTableEntries << ")\n";
154 outs() << " ('locreloff', " << DLC->LocalRelocationTableOffset << ")\n";
155 outs() << " ('nlocrel', " << DLC->NumLocalRelocationTableEntries << ")\n";
160 static int DumpLoadCommand(MachOObject &Obj, unsigned Index) {
161 const MachOObject::LoadCommandInfo &LCI = Obj.getLoadCommandInfo(Index);
164 outs() << " # Load Command " << Index << "\n"
165 << " (('command', " << LCI.Command.Type << ")\n"
166 << " ('size', " << LCI.Command.Size << ")\n";
167 switch (LCI.Command.Type) {
168 case macho::LCT_Segment:
169 Res = DumpSegmentCommand(Obj, LCI);
171 case macho::LCT_Segment64:
172 Res = DumpSegment64Command(Obj, LCI);
174 case macho::LCT_Symtab:
175 Res = DumpSymtabCommand(Obj, LCI);
177 case macho::LCT_Dysymtab:
178 Res = DumpDysymtabCommand(Obj, LCI);
181 Warning("unknown load command: " + Twine(LCI.Command.Type));
189 int main(int argc, char **argv) {
190 ProgramName = argv[0];
191 llvm_shutdown_obj Y; // Call llvm_shutdown() on exit.
193 cl::ParseCommandLineOptions(argc, argv, "llvm Mach-O dumping tool\n");
195 // Load the input file.
196 std::string ErrorStr;
197 OwningPtr<MemoryBuffer> InputBuffer(
198 MemoryBuffer::getFileOrSTDIN(InputFile, &ErrorStr));
200 return Error("unable to read input: '" + ErrorStr + "'");
202 // Construct the Mach-O wrapper object.
203 OwningPtr<MachOObject> InputObject(
204 MachOObject::LoadFromBuffer(InputBuffer.take(), &ErrorStr));
206 return Error("unable to load object: '" + ErrorStr + "'");
208 if (int Res = DumpHeader(*InputObject))
211 // Print the load commands.
213 outs() << "('load_commands', [\n";
214 for (unsigned i = 0; i != InputObject->getHeader().NumLoadCommands; ++i)
215 if ((Res = DumpLoadCommand(*InputObject, i)))