1 //===- llvm-objcopy.cpp ---------------------------------------------------===//
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
7 //===----------------------------------------------------------------------===//
9 #include "llvm-objcopy.h"
11 #include "CopyConfig.h"
12 #include "ELF/ELFObjcopy.h"
13 #include "COFF/COFFObjcopy.h"
14 #include "MachO/MachOObjcopy.h"
16 #include "llvm/ADT/STLExtras.h"
17 #include "llvm/ADT/SmallVector.h"
18 #include "llvm/ADT/StringRef.h"
19 #include "llvm/ADT/Twine.h"
20 #include "llvm/Object/Archive.h"
21 #include "llvm/Object/ArchiveWriter.h"
22 #include "llvm/Object/Binary.h"
23 #include "llvm/Object/COFF.h"
24 #include "llvm/Object/ELFObjectFile.h"
25 #include "llvm/Object/ELFTypes.h"
26 #include "llvm/Object/Error.h"
27 #include "llvm/Object/MachO.h"
28 #include "llvm/Option/Arg.h"
29 #include "llvm/Option/ArgList.h"
30 #include "llvm/Option/Option.h"
31 #include "llvm/Support/Casting.h"
32 #include "llvm/Support/Error.h"
33 #include "llvm/Support/ErrorHandling.h"
34 #include "llvm/Support/ErrorOr.h"
35 #include "llvm/Support/InitLLVM.h"
36 #include "llvm/Support/Memory.h"
37 #include "llvm/Support/Path.h"
38 #include "llvm/Support/Process.h"
39 #include "llvm/Support/WithColor.h"
40 #include "llvm/Support/raw_ostream.h"
46 #include <system_error>
52 // The name this program was invoked as.
55 LLVM_ATTRIBUTE_NORETURN void error(Twine Message) {
56 WithColor::error(errs(), ToolName) << Message << "\n";
60 LLVM_ATTRIBUTE_NORETURN void error(Error E) {
63 raw_string_ostream OS(Buf);
64 logAllUnhandledErrors(std::move(E), OS);
66 WithColor::error(errs(), ToolName) << Buf;
70 LLVM_ATTRIBUTE_NORETURN void reportError(StringRef File, std::error_code EC) {
72 error(createFileError(File, EC));
75 LLVM_ATTRIBUTE_NORETURN void reportError(StringRef File, Error E) {
78 raw_string_ostream OS(Buf);
79 logAllUnhandledErrors(std::move(E), OS);
81 WithColor::error(errs(), ToolName) << "'" << File << "': " << Buf;
85 ErrorSuccess reportWarning(Error E) {
87 WithColor::warning(errs(), ToolName) << toString(std::move(E));
88 return Error::success();
91 } // end namespace objcopy
92 } // end namespace llvm
95 using namespace llvm::object;
96 using namespace llvm::objcopy;
98 // For regular archives this function simply calls llvm::writeArchive,
99 // For thin archives it writes the archive file itself as well as its members.
100 static Error deepWriteArchive(StringRef ArcName,
101 ArrayRef<NewArchiveMember> NewMembers,
102 bool WriteSymtab, object::Archive::Kind Kind,
103 bool Deterministic, bool Thin) {
104 if (Error E = writeArchive(ArcName, NewMembers, WriteSymtab, Kind,
105 Deterministic, Thin))
106 return createFileError(ArcName, std::move(E));
109 return Error::success();
111 for (const NewArchiveMember &Member : NewMembers) {
112 // Internally, FileBuffer will use the buffer created by
113 // FileOutputBuffer::create, for regular files (that is the case for
114 // deepWriteArchive) FileOutputBuffer::create will return OnDiskBuffer.
115 // OnDiskBuffer uses a temporary file and then renames it. So in reality
116 // there is no inefficiency / duplicated in-memory buffers in this case. For
117 // now in-memory buffers can not be completely avoided since
118 // NewArchiveMember still requires them even though writeArchive does not
119 // write them on disk.
120 FileBuffer FB(Member.MemberName);
121 if (Error E = FB.allocate(Member.Buf->getBufferSize()))
123 std::copy(Member.Buf->getBufferStart(), Member.Buf->getBufferEnd(),
124 FB.getBufferStart());
125 if (Error E = FB.commit())
128 return Error::success();
131 /// The function executeObjcopyOnIHex does the dispatch based on the format
132 /// of the output specified by the command line options.
133 static Error executeObjcopyOnIHex(const CopyConfig &Config, MemoryBuffer &In,
135 // TODO: support output formats other than ELF.
136 return elf::executeObjcopyOnIHex(Config, In, Out);
139 /// The function executeObjcopyOnRawBinary does the dispatch based on the format
140 /// of the output specified by the command line options.
141 static Error executeObjcopyOnRawBinary(const CopyConfig &Config,
142 MemoryBuffer &In, Buffer &Out) {
143 switch (Config.OutputFormat) {
144 case FileFormat::ELF:
145 // FIXME: Currently, we call elf::executeObjcopyOnRawBinary even if the
146 // output format is binary/ihex or it's not given. This behavior differs from
147 // GNU objcopy. See https://bugs.llvm.org/show_bug.cgi?id=42171 for details.
148 case FileFormat::Binary:
149 case FileFormat::IHex:
150 case FileFormat::Unspecified:
151 return elf::executeObjcopyOnRawBinary(Config, In, Out);
155 /// The function executeObjcopyOnBinary does the dispatch based on the format
156 /// of the input binary (ELF, MachO or COFF).
157 static Error executeObjcopyOnBinary(const CopyConfig &Config,
158 object::Binary &In, Buffer &Out) {
159 if (auto *ELFBinary = dyn_cast<object::ELFObjectFileBase>(&In))
160 return elf::executeObjcopyOnBinary(Config, *ELFBinary, Out);
161 else if (auto *COFFBinary = dyn_cast<object::COFFObjectFile>(&In))
162 return coff::executeObjcopyOnBinary(Config, *COFFBinary, Out);
163 else if (auto *MachOBinary = dyn_cast<object::MachOObjectFile>(&In))
164 return macho::executeObjcopyOnBinary(Config, *MachOBinary, Out);
166 return createStringError(object_error::invalid_file_type,
167 "unsupported object file format");
170 static Error executeObjcopyOnArchive(const CopyConfig &Config,
172 std::vector<NewArchiveMember> NewArchiveMembers;
173 Error Err = Error::success();
174 for (const Archive::Child &Child : Ar.children(Err)) {
175 Expected<StringRef> ChildNameOrErr = Child.getName();
177 return createFileError(Ar.getFileName(), ChildNameOrErr.takeError());
179 Expected<std::unique_ptr<Binary>> ChildOrErr = Child.getAsBinary();
181 return createFileError(Ar.getFileName() + "(" + *ChildNameOrErr + ")",
182 ChildOrErr.takeError());
184 MemBuffer MB(ChildNameOrErr.get());
185 if (Error E = executeObjcopyOnBinary(Config, *ChildOrErr->get(), MB))
188 Expected<NewArchiveMember> Member =
189 NewArchiveMember::getOldMember(Child, Config.DeterministicArchives);
191 return createFileError(Ar.getFileName(), Member.takeError());
192 Member->Buf = MB.releaseMemoryBuffer();
193 Member->MemberName = Member->Buf->getBufferIdentifier();
194 NewArchiveMembers.push_back(std::move(*Member));
197 return createFileError(Config.InputFilename, std::move(Err));
199 return deepWriteArchive(Config.OutputFilename, NewArchiveMembers,
200 Ar.hasSymbolTable(), Ar.kind(),
201 Config.DeterministicArchives, Ar.isThin());
204 static Error restoreDateOnFile(StringRef Filename,
205 const sys::fs::file_status &Stat) {
209 sys::fs::openFileForWrite(Filename, FD, sys::fs::CD_OpenExisting))
210 return createFileError(Filename, EC);
212 if (auto EC = sys::fs::setLastAccessAndModificationTime(
213 FD, Stat.getLastAccessedTime(), Stat.getLastModificationTime()))
214 return createFileError(Filename, EC);
216 if (auto EC = sys::Process::SafelyCloseFileDescriptor(FD))
217 return createFileError(Filename, EC);
219 return Error::success();
222 /// The function executeObjcopy does the higher level dispatch based on the type
223 /// of input (raw binary, archive or single object file) and takes care of the
224 /// format-agnostic modifications, i.e. preserving dates.
225 static Error executeObjcopy(const CopyConfig &Config) {
226 sys::fs::file_status Stat;
227 if (Config.PreserveDates)
228 if (auto EC = sys::fs::status(Config.InputFilename, Stat))
229 return createFileError(Config.InputFilename, EC);
231 typedef Error (*ProcessRawFn)(const CopyConfig &, MemoryBuffer &, Buffer &);
232 ProcessRawFn ProcessRaw;
233 switch (Config.InputFormat) {
234 case FileFormat::Binary:
235 ProcessRaw = executeObjcopyOnRawBinary;
237 case FileFormat::IHex:
238 ProcessRaw = executeObjcopyOnIHex;
241 ProcessRaw = nullptr;
245 auto BufOrErr = MemoryBuffer::getFileOrSTDIN(Config.InputFilename);
247 return createFileError(Config.InputFilename, BufOrErr.getError());
248 FileBuffer FB(Config.OutputFilename);
249 if (Error E = ProcessRaw(Config, *BufOrErr->get(), FB))
252 Expected<OwningBinary<llvm::object::Binary>> BinaryOrErr =
253 createBinary(Config.InputFilename);
255 return createFileError(Config.InputFilename, BinaryOrErr.takeError());
257 if (Archive *Ar = dyn_cast<Archive>(BinaryOrErr.get().getBinary())) {
258 if (Error E = executeObjcopyOnArchive(Config, *Ar))
261 FileBuffer FB(Config.OutputFilename);
262 if (Error E = executeObjcopyOnBinary(Config,
263 *BinaryOrErr.get().getBinary(), FB))
268 if (Config.PreserveDates) {
269 if (Error E = restoreDateOnFile(Config.OutputFilename, Stat))
271 if (!Config.SplitDWO.empty())
272 if (Error E = restoreDateOnFile(Config.SplitDWO, Stat))
276 return Error::success();
279 int main(int argc, char **argv) {
280 InitLLVM X(argc, argv);
282 bool IsStrip = sys::path::stem(ToolName).contains("strip");
283 Expected<DriverConfig> DriverConfig =
284 IsStrip ? parseStripOptions(makeArrayRef(argv + 1, argc), reportWarning)
285 : parseObjcopyOptions(makeArrayRef(argv + 1, argc));
287 logAllUnhandledErrors(DriverConfig.takeError(),
288 WithColor::error(errs(), ToolName));
291 for (const CopyConfig &CopyConfig : DriverConfig->CopyConfigs) {
292 if (Error E = executeObjcopy(CopyConfig)) {
293 logAllUnhandledErrors(std::move(E), WithColor::error(errs(), ToolName));