1//===------ utils/obj2yaml.cpp - obj2yaml conversion tool -----------------===//
2//
3// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4// See https://llvm.org/LICENSE.txt for license information.
5// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
6//
7//===----------------------------------------------------------------------===//
8
9#include "obj2yaml.h"
10#include "llvm/BinaryFormat/Magic.h"
11#include "llvm/Object/Archive.h"
12#include "llvm/Object/COFF.h"
13#include "llvm/Object/Minidump.h"
14#include "llvm/Option/ArgList.h"
15#include "llvm/Option/OptTable.h"
16#include "llvm/Option/Option.h"
17#include "llvm/Support/CommandLine.h"
18#include "llvm/Support/InitLLVM.h"
19#include "llvm/Support/StringSaver.h"
20#include "llvm/Support/ToolOutputFile.h"
21#include "llvm/Support/WithColor.h"
22
23using namespace llvm;
24using namespace llvm::object;
25
26namespace {
27enum ID {
28 OPT_INVALID = 0, // This is not an option ID.
29#define OPTION(...) LLVM_MAKE_OPT_ID(__VA_ARGS__),
30#include "Opts.inc"
31#undef OPTION
32};
33
34using namespace llvm::opt;
35#define OPTTABLE_CODE
36#include "Opts.inc"
37
38class Obj2YamlOptTable : public opt::OptTable {
39public:
40 Obj2YamlOptTable() : OptTable(optionTables()) { setDashDashParsing(true); }
41};
42} // namespace
43
44static Error dumpObject(const ObjectFile &Obj, raw_ostream &OS) {
45 if (Obj.isCOFF())
46 return errorCodeToError(EC: coff2yaml(Out&: OS, Obj: cast<COFFObjectFile>(Val: Obj)));
47
48 if (Obj.isXCOFF())
49 return xcoff2yaml(Out&: OS, Obj: cast<XCOFFObjectFile>(Val: Obj));
50
51 if (Obj.isELF())
52 return elf2yaml(Out&: OS, Obj);
53
54 if (Obj.isGOFF())
55 return goff2yaml(Out&: OS, Obj: cast<GOFFObjectFile>(Val: Obj));
56
57 if (Obj.isWasm())
58 return errorCodeToError(EC: wasm2yaml(Out&: OS, Obj: cast<WasmObjectFile>(Val: Obj)));
59
60 llvm_unreachable("unexpected object file format");
61}
62
63static Error dumpInput(StringRef File, unsigned RawSegment, raw_ostream &OS) {
64 ErrorOr<std::unique_ptr<MemoryBuffer>> FileOrErr =
65 MemoryBuffer::getFileOrSTDIN(Filename: File, /*IsText=*/false,
66 /*RequiresNullTerminator=*/false);
67 if (std::error_code EC = FileOrErr.getError())
68 return errorCodeToError(EC);
69 std::unique_ptr<MemoryBuffer> &Buffer = FileOrErr.get();
70 MemoryBufferRef MemBuf = Buffer->getMemBufferRef();
71 switch (identify_magic(magic: MemBuf.getBuffer())) {
72 case file_magic::archive:
73 return archive2yaml(Out&: OS, Source: MemBuf);
74 case file_magic::dxcontainer_object:
75 return dxcontainer2yaml(Out&: OS, Source: MemBuf);
76 case file_magic::offload_binary:
77 return offload2yaml(Out&: OS, Source: MemBuf);
78 default:
79 break;
80 }
81
82 Expected<std::unique_ptr<Binary>> BinOrErr =
83 createBinary(Source: MemBuf, /*Context=*/nullptr);
84 if (!BinOrErr)
85 return BinOrErr.takeError();
86
87 Binary &Binary = *BinOrErr->get();
88 // Universal MachO is not a subclass of ObjectFile, so it needs to be handled
89 // here with the other binary types.
90 if (Binary.isMachO() || Binary.isMachOUniversalBinary())
91 return macho2yaml(Out&: OS, Obj: Binary, RawSegments: RawSegment);
92 if (ObjectFile *Obj = dyn_cast<ObjectFile>(Val: &Binary))
93 return dumpObject(Obj: *Obj, OS);
94 if (MinidumpFile *Minidump = dyn_cast<MinidumpFile>(Val: &Binary))
95 return minidump2yaml(Out&: OS, Obj: *Minidump);
96
97 return Error::success();
98}
99
100static void reportError(StringRef Input, Error Err) {
101 if (Input == "-")
102 Input = "<stdin>";
103 std::string ErrMsg;
104 raw_string_ostream OS(ErrMsg);
105 logAllUnhandledErrors(E: std::move(Err), OS);
106 errs() << "Error reading file: " << Input << ": " << ErrMsg;
107 errs().flush();
108}
109
110int main(int argc, char *argv[]) {
111 InitLLVM X(argc, argv);
112 bool HasError = false;
113 auto ErrorFn = [&](const Twine &Msg) {
114 WithColor::error(OS&: errs(), Prefix: "obj2yaml") << Msg << '\n';
115 HasError = true;
116 };
117 BumpPtrAllocator A;
118 StringSaver Saver(A);
119 Obj2YamlOptTable Tbl;
120 opt::InputArgList Args =
121 Tbl.parseArgs(Argc: argc, Argv: argv, Unknown: OPT_UNKNOWN, Saver, ErrorFn);
122 if (HasError)
123 return 1;
124 if (Args.hasArg(Ids: OPT_help)) {
125 Tbl.printHelp(OS&: outs(), Usage: "obj2yaml [options] <input file>",
126 Title: "Dump a YAML description from an object file");
127 return 0;
128 }
129 if (Args.hasArg(Ids: OPT_version)) {
130 cl::PrintVersionMessage();
131 return 0;
132 }
133
134 std::vector<std::string> Inputs = Args.getAllArgValues(Id: OPT_INPUT);
135 if (Inputs.size() > 1)
136 ErrorFn("too many input files");
137 StringRef InputFilename =
138 Inputs.empty() ? StringRef("-") : StringRef(Inputs[0]);
139 StringRef OutputFilename = Args.getLastArgValue(Id: OPT_o, Default: "-");
140 unsigned RawSegment = RawSegments::none;
141 for (StringRef S : Args.getAllArgValues(Id: OPT_raw_segment_EQ)) {
142 if (S == "data")
143 RawSegment |= RawSegments::data;
144 else if (S == "linkedit")
145 RawSegment |= RawSegments::linkedit;
146 else
147 ErrorFn("unknown segment '" + S + "' for --raw-segment");
148 }
149 if (HasError)
150 return 1;
151
152 std::error_code EC;
153 ToolOutputFile Out(OutputFilename, EC, sys::fs::OF_Text);
154 if (EC) {
155 ErrorFn("failed to open '" + OutputFilename + "': " + EC.message());
156 return 1;
157 }
158 if (Error Err = dumpInput(File: InputFilename, RawSegment, OS&: Out.os())) {
159 reportError(Input: InputFilename, Err: std::move(Err));
160 return 1;
161 }
162 Out.keep();
163
164 return 0;
165}
166