blob: fe2cb05fe227cb41405fe35f2f12be3b95670863 [file] [log] [blame]
Benjamin Kramer0b8b7712011-09-19 17:56:04 +00001//
2// The LLVM Compiler Infrastructure
3//
4// This file is distributed under the University of Illinois Open Source
5// License. See LICENSE.TXT for details.
6//
7//===----------------------------------------------------------------------===//
8
Benjamin Kramer00e08fc2014-08-13 16:26:38 +00009#ifndef LLVM_TOOLS_LLVM_OBJDUMP_LLVM_OBJDUMP_H
10#define LLVM_TOOLS_LLVM_OBJDUMP_LLVM_OBJDUMP_H
Benjamin Kramer0b8b7712011-09-19 17:56:04 +000011
Igor Laevsky25574802016-01-26 15:09:42 +000012#include "llvm/DebugInfo/DIContext.h"
Benjamin Kramer0b8b7712011-09-19 17:56:04 +000013#include "llvm/Support/CommandLine.h"
Davide Italianoec0fb282015-12-29 13:41:02 +000014#include "llvm/Support/Compiler.h"
Benjamin Kramer0b8b7712011-09-19 17:56:04 +000015#include "llvm/Support/DataTypes.h"
Kevin Enderby77be0942016-05-17 17:10:12 +000016#include "llvm/Object/Archive.h"
Benjamin Kramer0b8b7712011-09-19 17:56:04 +000017
18namespace llvm {
Mehdi Aminif6071e12016-04-18 09:17:29 +000019class StringRef;
20
Michael J. Spencereef7b622012-12-05 20:12:35 +000021namespace object {
22 class COFFObjectFile;
Saleem Abdulrasool8a836022016-08-18 16:39:19 +000023 class COFFImportFile;
Tim Northoverf28a36e2014-08-01 13:07:19 +000024 class MachOObjectFile;
Dave Lee58b1de42018-08-03 00:06:38 +000025 class MachOUniversalBinary;
Michael J. Spencerb2c064c2013-01-06 03:56:49 +000026 class ObjectFile;
Kevin Enderby77be0942016-05-17 17:10:12 +000027 class Archive;
Michael J. Spencereef7b622012-12-05 20:12:35 +000028 class RelocationRef;
29}
Michael J. Spencereef7b622012-12-05 20:12:35 +000030
Benjamin Kramer0b8b7712011-09-19 17:56:04 +000031extern cl::opt<std::string> TripleName;
32extern cl::opt<std::string> ArchName;
Kevin Enderby75d423f2014-08-06 23:24:41 +000033extern cl::opt<std::string> MCPU;
34extern cl::list<std::string> MAttrs;
Colin LeMahieu154b3f02015-07-29 19:08:10 +000035extern cl::list<std::string> FilterSections;
Fangrui Song84e5dbf2018-06-27 20:45:11 +000036extern cl::opt<bool> AllHeaders;
Zachary Turnerc04ae042018-08-20 22:18:21 +000037extern cl::opt<bool> Demangle;
Colin LeMahieuedbf9d72015-07-29 15:45:39 +000038extern cl::opt<bool> Disassemble;
Colin LeMahieuea805022015-07-23 20:58:49 +000039extern cl::opt<bool> DisassembleAll;
Kevin Enderbye7938622014-09-24 23:08:22 +000040extern cl::opt<bool> NoShowRawInsn;
Saleem Abdulrasool5bbd1892017-02-08 18:11:31 +000041extern cl::opt<bool> NoLeadingAddr;
Kevin Enderby60e9ca42015-01-07 21:02:18 +000042extern cl::opt<bool> PrivateHeaders;
Paul Semeld069a212018-07-04 15:25:03 +000043extern cl::opt<bool> FileHeaders;
Kevin Enderbyf3e60262016-01-13 00:25:36 +000044extern cl::opt<bool> FirstPrivateHeader;
Kevin Enderby60e9ca42015-01-07 21:02:18 +000045extern cl::opt<bool> ExportsTrie;
46extern cl::opt<bool> Rebase;
47extern cl::opt<bool> Bind;
48extern cl::opt<bool> LazyBind;
49extern cl::opt<bool> WeakBind;
Adrian Prantl54a27682015-07-08 02:04:15 +000050extern cl::opt<bool> RawClangAST;
Kevin Enderby6248d1b2015-01-09 19:22:37 +000051extern cl::opt<bool> UniversalHeaders;
Kevin Enderbycdfe54f2015-01-15 23:19:11 +000052extern cl::opt<bool> ArchiveHeaders;
Kevin Enderbybcbb8692015-01-22 18:55:27 +000053extern cl::opt<bool> IndirectSymbols;
Kevin Enderby66e2ddc2015-01-23 18:52:17 +000054extern cl::opt<bool> DataInCode;
Kevin Enderbya167fe12015-01-27 21:28:24 +000055extern cl::opt<bool> LinkOptHints;
Kevin Enderby8284f0f2015-03-11 22:06:32 +000056extern cl::opt<bool> InfoPlist;
Kevin Enderby62507242015-03-16 20:08:09 +000057extern cl::opt<bool> DylibsUsed;
58extern cl::opt<bool> DylibId;
Kevin Enderby95d81552015-04-01 20:57:01 +000059extern cl::opt<bool> ObjcMetaData;
Kevin Enderby73cd697d2015-03-17 17:10:57 +000060extern cl::opt<std::string> DisSymName;
Kevin Enderby300c79d2015-03-13 17:56:32 +000061extern cl::opt<bool> NonVerbose;
Kevin Enderbyc97fb732015-01-20 21:47:46 +000062extern cl::opt<bool> Relocations;
Paul Semel3fc706582018-06-07 13:30:55 +000063extern cl::opt<bool> DynamicRelocations;
Kevin Enderbyc97fb732015-01-20 21:47:46 +000064extern cl::opt<bool> SectionHeaders;
65extern cl::opt<bool> SectionContents;
66extern cl::opt<bool> SymbolTable;
67extern cl::opt<bool> UnwindInfo;
Colin LeMahieu8cc8dbc2015-06-07 21:07:17 +000068extern cl::opt<bool> PrintImmHex;
Igor Laevsky25574802016-01-26 15:09:42 +000069extern cl::opt<DIDumpType> DwarfDumpType;
Benjamin Kramer0b8b7712011-09-19 17:56:04 +000070
71// Various helper functions.
Davide Italiano281c1b02015-08-05 07:18:31 +000072void error(std::error_code ec);
George Rimar45d116d2019-01-15 09:19:18 +000073bool isRelocAddressLess(object::RelocationRef A, object::RelocationRef B);
74void parseInputMachO(StringRef Filename);
75void parseInputMachO(object::MachOUniversalBinary *UB);
76void printCOFFUnwindInfo(const object::COFFObjectFile *O);
77void printMachOUnwindInfo(const object::MachOObjectFile *O);
78void printMachOExportsTrie(const object::MachOObjectFile *O);
79void printMachORebaseTable(object::MachOObjectFile *O);
80void printMachOBindTable(object::MachOObjectFile *O);
81void printMachOLazyBindTable(object::MachOObjectFile *O);
82void printMachOWeakBindTable(object::MachOObjectFile *O);
83void printELFFileHeader(const object::ObjectFile *O);
Paul Semel05d358b2018-07-25 11:09:20 +000084void printELFDynamicSection(const object::ObjectFile *Obj);
George Rimar45d116d2019-01-15 09:19:18 +000085void printCOFFFileHeader(const object::ObjectFile *O);
86void printCOFFSymbolTable(const object::COFFImportFile *I);
87void printCOFFSymbolTable(const object::COFFObjectFile *O);
88void printMachOFileHeader(const object::ObjectFile *O);
89void printMachOLoadCommands(const object::ObjectFile *O);
90void printWasmFileHeader(const object::ObjectFile *O);
91void printExportsTrie(const object::ObjectFile *O);
92void printRebaseTable(object::ObjectFile *O);
93void printBindTable(object::ObjectFile *O);
94void printLazyBindTable(object::ObjectFile *O);
95void printWeakBindTable(object::ObjectFile *O);
96void printRawClangAST(const object::ObjectFile *O);
97void printRelocations(const object::ObjectFile *O);
98void printDynamicRelocations(const object::ObjectFile *O);
99void printSectionHeaders(const object::ObjectFile *O);
100void printSectionContents(const object::ObjectFile *O);
101void printSymbolTable(const object::ObjectFile *O, StringRef ArchiveName,
Kevin Enderbye9ddf3a2016-05-31 20:35:34 +0000102 StringRef ArchitectureName = StringRef());
Paul Semelbaea3f02018-07-18 16:39:21 +0000103void warn(StringRef Message);
Kevin Enderbyc827f2c2016-06-28 23:16:13 +0000104LLVM_ATTRIBUTE_NORETURN void error(Twine Message);
Kevin Enderbyfbd189d2016-11-16 22:17:38 +0000105LLVM_ATTRIBUTE_NORETURN void report_error(StringRef File, Twine Message);
Davide Italianoec0fb282015-12-29 13:41:02 +0000106LLVM_ATTRIBUTE_NORETURN void report_error(StringRef File, std::error_code EC);
Kevin Enderbyc6bf9be2016-04-06 22:14:09 +0000107LLVM_ATTRIBUTE_NORETURN void report_error(StringRef File, llvm::Error E);
Kevin Enderby77be0942016-05-17 17:10:12 +0000108LLVM_ATTRIBUTE_NORETURN void report_error(StringRef FileName,
109 StringRef ArchiveName,
Kevin Enderbye9ddf3a2016-05-31 20:35:34 +0000110 llvm::Error E,
111 StringRef ArchitectureName
112 = StringRef());
Kevin Enderby77be0942016-05-17 17:10:12 +0000113LLVM_ATTRIBUTE_NORETURN void report_error(StringRef ArchiveName,
114 const object::Archive::Child &C,
Kevin Enderbye9ddf3a2016-05-31 20:35:34 +0000115 llvm::Error E,
116 StringRef ArchitectureName
117 = StringRef());
Benjamin Kramer0b8b7712011-09-19 17:56:04 +0000118
Rui Ueyamaa6610ee2013-09-27 21:04:00 +0000119} // end namespace llvm
Benjamin Kramer0b8b7712011-09-19 17:56:04 +0000120
121#endif