blob: 6f21db9db60437a37091ad2ece9af4454d4b4b3b [file] [log] [blame]
Alexander Shaposhnikovf4e75a52018-10-29 21:22:58 +00001//===- ELFObjcopy.cpp -----------------------------------------------------===//
2//
Chandler Carruth2946cd72019-01-19 08:50:56 +00003// 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
Alexander Shaposhnikovf4e75a52018-10-29 21:22:58 +00006//
7//===----------------------------------------------------------------------===//
8
9#include "ELFObjcopy.h"
10#include "Buffer.h"
11#include "CopyConfig.h"
Alexander Shaposhnikovf4e75a52018-10-29 21:22:58 +000012#include "Object.h"
Jake Ehrlich8ad77792018-12-03 19:49:23 +000013#include "llvm-objcopy.h"
Alexander Shaposhnikovf4e75a52018-10-29 21:22:58 +000014
15#include "llvm/ADT/BitmaskEnum.h"
16#include "llvm/ADT/Optional.h"
17#include "llvm/ADT/STLExtras.h"
18#include "llvm/ADT/SmallVector.h"
19#include "llvm/ADT/StringRef.h"
20#include "llvm/ADT/Twine.h"
21#include "llvm/BinaryFormat/ELF.h"
22#include "llvm/MC/MCTargetOptions.h"
23#include "llvm/Object/Binary.h"
24#include "llvm/Object/ELFObjectFile.h"
25#include "llvm/Object/ELFTypes.h"
26#include "llvm/Object/Error.h"
27#include "llvm/Option/Option.h"
28#include "llvm/Support/Casting.h"
29#include "llvm/Support/Compression.h"
Jake Ehrlich8ad77792018-12-03 19:49:23 +000030#include "llvm/Support/Errc.h"
Alexander Shaposhnikovf4e75a52018-10-29 21:22:58 +000031#include "llvm/Support/Error.h"
32#include "llvm/Support/ErrorHandling.h"
33#include "llvm/Support/ErrorOr.h"
34#include "llvm/Support/Memory.h"
35#include "llvm/Support/Path.h"
36#include "llvm/Support/raw_ostream.h"
37#include <algorithm>
38#include <cassert>
39#include <cstdlib>
40#include <functional>
41#include <iterator>
42#include <memory>
43#include <string>
44#include <system_error>
45#include <utility>
46
47namespace llvm {
48namespace objcopy {
49namespace elf {
50
51using namespace object;
52using namespace ELF;
53using SectionPred = std::function<bool(const SectionBase &Sec)>;
54
55static bool isDebugSection(const SectionBase &Sec) {
56 return StringRef(Sec.Name).startswith(".debug") ||
57 StringRef(Sec.Name).startswith(".zdebug") || Sec.Name == ".gdb_index";
58}
59
60static bool isDWOSection(const SectionBase &Sec) {
61 return StringRef(Sec.Name).endswith(".dwo");
62}
63
64static bool onlyKeepDWOPred(const Object &Obj, const SectionBase &Sec) {
65 // We can't remove the section header string table.
66 if (&Sec == Obj.SectionNames)
67 return false;
68 // Short of keeping the string table we want to keep everything that is a DWO
69 // section and remove everything else.
70 return !isDWOSection(Sec);
71}
72
Jordan Rupprechtc8927412019-01-29 15:05:38 +000073static uint64_t setSectionFlagsPreserveMask(uint64_t OldFlags,
74 uint64_t NewFlags) {
75 // Preserve some flags which should not be dropped when setting flags.
76 // Also, preserve anything OS/processor dependant.
77 const uint64_t PreserveMask = ELF::SHF_COMPRESSED | ELF::SHF_EXCLUDE |
78 ELF::SHF_GROUP | ELF::SHF_LINK_ORDER |
79 ELF::SHF_MASKOS | ELF::SHF_MASKPROC |
80 ELF::SHF_TLS | ELF::SHF_INFO_LINK;
81 return (OldFlags & PreserveMask) | (NewFlags & ~PreserveMask);
82}
83
Alexander Shaposhnikovf4e75a52018-10-29 21:22:58 +000084static ElfType getOutputElfType(const Binary &Bin) {
85 // Infer output ELF type from the input ELF object
86 if (isa<ELFObjectFile<ELF32LE>>(Bin))
87 return ELFT_ELF32LE;
88 if (isa<ELFObjectFile<ELF64LE>>(Bin))
89 return ELFT_ELF64LE;
90 if (isa<ELFObjectFile<ELF32BE>>(Bin))
91 return ELFT_ELF32BE;
92 if (isa<ELFObjectFile<ELF64BE>>(Bin))
93 return ELFT_ELF64BE;
94 llvm_unreachable("Invalid ELFType");
95}
96
97static ElfType getOutputElfType(const MachineInfo &MI) {
98 // Infer output ELF type from the binary arch specified
99 if (MI.Is64Bit)
100 return MI.IsLittleEndian ? ELFT_ELF64LE : ELFT_ELF64BE;
101 else
102 return MI.IsLittleEndian ? ELFT_ELF32LE : ELFT_ELF32BE;
103}
104
105static std::unique_ptr<Writer> createWriter(const CopyConfig &Config,
106 Object &Obj, Buffer &Buf,
107 ElfType OutputElfType) {
108 if (Config.OutputFormat == "binary") {
109 return llvm::make_unique<BinaryWriter>(Obj, Buf);
110 }
111 // Depending on the initial ELFT and OutputFormat we need a different Writer.
112 switch (OutputElfType) {
113 case ELFT_ELF32LE:
114 return llvm::make_unique<ELFWriter<ELF32LE>>(Obj, Buf,
115 !Config.StripSections);
116 case ELFT_ELF64LE:
117 return llvm::make_unique<ELFWriter<ELF64LE>>(Obj, Buf,
118 !Config.StripSections);
119 case ELFT_ELF32BE:
120 return llvm::make_unique<ELFWriter<ELF32BE>>(Obj, Buf,
121 !Config.StripSections);
122 case ELFT_ELF64BE:
123 return llvm::make_unique<ELFWriter<ELF64BE>>(Obj, Buf,
124 !Config.StripSections);
125 }
126 llvm_unreachable("Invalid output format");
127}
128
Jake Ehrlich8ad77792018-12-03 19:49:23 +0000129template <class ELFT>
130static Expected<ArrayRef<uint8_t>>
131findBuildID(const object::ELFFile<ELFT> &In) {
132 for (const auto &Phdr : unwrapOrError(In.program_headers())) {
133 if (Phdr.p_type != PT_NOTE)
134 continue;
135 Error Err = Error::success();
David Blaikieba005aa2018-12-11 00:09:06 +0000136 for (const auto &Note : In.notes(Phdr, Err))
Jake Ehrlich8ad77792018-12-03 19:49:23 +0000137 if (Note.getType() == NT_GNU_BUILD_ID && Note.getName() == ELF_NOTE_GNU)
138 return Note.getDesc();
Jake Ehrlich8ad77792018-12-03 19:49:23 +0000139 if (Err)
140 return std::move(Err);
141 }
142 return createStringError(llvm::errc::invalid_argument,
143 "Could not find build ID.");
144}
145
146static Expected<ArrayRef<uint8_t>>
147findBuildID(const object::ELFObjectFileBase &In) {
148 if (auto *O = dyn_cast<ELFObjectFile<ELF32LE>>(&In))
149 return findBuildID(*O->getELFFile());
150 else if (auto *O = dyn_cast<ELFObjectFile<ELF64LE>>(&In))
151 return findBuildID(*O->getELFFile());
152 else if (auto *O = dyn_cast<ELFObjectFile<ELF32BE>>(&In))
153 return findBuildID(*O->getELFFile());
154 else if (auto *O = dyn_cast<ELFObjectFile<ELF64BE>>(&In))
155 return findBuildID(*O->getELFFile());
156
157 llvm_unreachable("Bad file format");
158}
159
Jordan Rupprechtfc832e92019-01-30 18:13:30 +0000160static Error linkToBuildIdDir(const CopyConfig &Config, StringRef ToLink,
161 StringRef Suffix,
162 ArrayRef<uint8_t> BuildIdBytes) {
Jake Ehrlich8ad77792018-12-03 19:49:23 +0000163 SmallString<128> Path = Config.BuildIdLinkDir;
164 sys::path::append(Path, llvm::toHex(BuildIdBytes[0], /*LowerCase*/ true));
165 if (auto EC = sys::fs::create_directories(Path))
Jordan Rupprechtfc832e92019-01-30 18:13:30 +0000166 return createFileError(
167 Path.str(),
168 createStringError(EC, "cannot create build ID link directory"));
Jake Ehrlich8ad77792018-12-03 19:49:23 +0000169
170 sys::path::append(Path,
171 llvm::toHex(BuildIdBytes.slice(1), /*LowerCase*/ true));
172 Path += Suffix;
173 if (auto EC = sys::fs::create_hard_link(ToLink, Path)) {
174 // Hard linking failed, try to remove the file first if it exists.
175 if (sys::fs::exists(Path))
176 sys::fs::remove(Path);
177 EC = sys::fs::create_hard_link(ToLink, Path);
178 if (EC)
Jordan Rupprechtfc832e92019-01-30 18:13:30 +0000179 return createStringError(EC, "cannot link %s to %s", ToLink.data(),
180 Path.data());
Jake Ehrlich8ad77792018-12-03 19:49:23 +0000181 }
Jordan Rupprechtfc832e92019-01-30 18:13:30 +0000182 return Error::success();
Jake Ehrlich8ad77792018-12-03 19:49:23 +0000183}
184
Jordan Rupprecht307deab2019-01-30 14:36:53 +0000185static Error splitDWOToFile(const CopyConfig &Config, const Reader &Reader,
186 StringRef File, ElfType OutputElfType) {
Alexander Shaposhnikovf4e75a52018-10-29 21:22:58 +0000187 auto DWOFile = Reader.create();
Jordan Rupprecht971d47622019-02-01 15:20:36 +0000188 auto OnlyKeepDWOPred = [&DWOFile](const SectionBase &Sec) {
189 return onlyKeepDWOPred(*DWOFile, Sec);
190 };
191 if (Error E = DWOFile->removeSections(OnlyKeepDWOPred))
192 return E;
Jordan Rupprecht70038e02019-01-07 16:59:12 +0000193 if (Config.OutputArch)
194 DWOFile->Machine = Config.OutputArch.getValue().EMachine;
Alexander Shaposhnikovf4e75a52018-10-29 21:22:58 +0000195 FileBuffer FB(File);
196 auto Writer = createWriter(Config, *DWOFile, FB, OutputElfType);
Jordan Rupprecht881cae72019-01-22 23:49:16 +0000197 if (Error E = Writer->finalize())
Jordan Rupprecht307deab2019-01-30 14:36:53 +0000198 return E;
199 return Writer->write();
Alexander Shaposhnikovf4e75a52018-10-29 21:22:58 +0000200}
201
202static Error dumpSectionToFile(StringRef SecName, StringRef Filename,
203 Object &Obj) {
204 for (auto &Sec : Obj.sections()) {
205 if (Sec.Name == SecName) {
Jordan Rupprecht16a0de22018-12-20 00:57:06 +0000206 if (Sec.OriginalData.empty())
Martin Storsjo8010c6be2019-01-22 10:57:59 +0000207 return createStringError(
208 object_error::parse_failed,
209 "Can't dump section \"%s\": it has no contents",
210 SecName.str().c_str());
Alexander Shaposhnikovf4e75a52018-10-29 21:22:58 +0000211 Expected<std::unique_ptr<FileOutputBuffer>> BufferOrErr =
212 FileOutputBuffer::create(Filename, Sec.OriginalData.size());
213 if (!BufferOrErr)
214 return BufferOrErr.takeError();
215 std::unique_ptr<FileOutputBuffer> Buf = std::move(*BufferOrErr);
216 std::copy(Sec.OriginalData.begin(), Sec.OriginalData.end(),
217 Buf->getBufferStart());
218 if (Error E = Buf->commit())
219 return E;
220 return Error::success();
221 }
222 }
Martin Storsjo8010c6be2019-01-22 10:57:59 +0000223 return createStringError(object_error::parse_failed, "Section not found");
Alexander Shaposhnikovf4e75a52018-10-29 21:22:58 +0000224}
225
Alexander Shaposhnikovf4e75a52018-10-29 21:22:58 +0000226static bool isCompressable(const SectionBase &Section) {
George Rimarade3c702019-03-05 13:07:43 +0000227 return !(Section.Flags & ELF::SHF_COMPRESSED) &&
228 StringRef(Section.Name).startswith(".debug");
Alexander Shaposhnikovf4e75a52018-10-29 21:22:58 +0000229}
230
231static void replaceDebugSections(
232 const CopyConfig &Config, Object &Obj, SectionPred &RemovePred,
233 function_ref<bool(const SectionBase &)> shouldReplace,
234 function_ref<SectionBase *(const SectionBase *)> addSection) {
235 SmallVector<SectionBase *, 13> ToReplace;
236 SmallVector<RelocationSection *, 13> RelocationSections;
237 for (auto &Sec : Obj.sections()) {
238 if (RelocationSection *R = dyn_cast<RelocationSection>(&Sec)) {
239 if (shouldReplace(*R->getSection()))
240 RelocationSections.push_back(R);
241 continue;
242 }
243
244 if (shouldReplace(Sec))
245 ToReplace.push_back(&Sec);
246 }
247
248 for (SectionBase *S : ToReplace) {
249 SectionBase *NewSection = addSection(S);
250
251 for (RelocationSection *RS : RelocationSections) {
252 if (RS->getSection() == S)
253 RS->setSection(NewSection);
254 }
255 }
256
257 RemovePred = [shouldReplace, RemovePred](const SectionBase &Sec) {
258 return shouldReplace(Sec) || RemovePred(Sec);
259 };
260}
261
Eugene Leviant2db10622019-02-13 07:34:54 +0000262static bool isUnneededSymbol(const Symbol &Sym) {
263 return !Sym.Referenced &&
264 (Sym.Binding == STB_LOCAL || Sym.getShndx() == SHN_UNDEF) &&
265 Sym.Type != STT_FILE && Sym.Type != STT_SECTION;
266}
267
Alexander Shaposhnikovf4e75a52018-10-29 21:22:58 +0000268// This function handles the high level operations of GNU objcopy including
269// handling command line options. It's important to outline certain properties
270// we expect to hold of the command line operations. Any operation that "keeps"
271// should keep regardless of a remove. Additionally any removal should respect
272// any previous removals. Lastly whether or not something is removed shouldn't
273// depend a) on the order the options occur in or b) on some opaque priority
274// system. The only priority is that keeps/copies overrule removes.
Jordan Rupprecht307deab2019-01-30 14:36:53 +0000275static Error handleArgs(const CopyConfig &Config, Object &Obj,
276 const Reader &Reader, ElfType OutputElfType) {
Alexander Shaposhnikovf4e75a52018-10-29 21:22:58 +0000277
Jordan Rupprecht307deab2019-01-30 14:36:53 +0000278 if (!Config.SplitDWO.empty())
279 if (Error E =
280 splitDWOToFile(Config, Reader, Config.SplitDWO, OutputElfType))
281 return E;
282
Jordan Rupprecht70038e02019-01-07 16:59:12 +0000283 if (Config.OutputArch)
284 Obj.Machine = Config.OutputArch.getValue().EMachine;
Alexander Shaposhnikovf4e75a52018-10-29 21:22:58 +0000285
286 // TODO: update or remove symbols only if there is an option that affects
287 // them.
288 if (Obj.SymbolTable) {
289 Obj.SymbolTable->updateSymbols([&](Symbol &Sym) {
Jordan Rupprechtbd7735f2019-01-31 16:45:16 +0000290 // Common and undefined symbols don't make sense as local symbols, and can
291 // even cause crashes if we localize those, so skip them.
292 if (!Sym.isCommon() && Sym.getShndx() != SHN_UNDEF &&
Jordan Rupprechtb47475c2018-11-01 17:26:36 +0000293 ((Config.LocalizeHidden &&
294 (Sym.Visibility == STV_HIDDEN || Sym.Visibility == STV_INTERNAL)) ||
Fangrui Songe4ee0662018-11-29 17:32:51 +0000295 is_contained(Config.SymbolsToLocalize, Sym.Name)))
Alexander Shaposhnikovf4e75a52018-10-29 21:22:58 +0000296 Sym.Binding = STB_LOCAL;
297
298 // Note: these two globalize flags have very similar names but different
299 // meanings:
300 //
301 // --globalize-symbol: promote a symbol to global
302 // --keep-global-symbol: all symbols except for these should be made local
303 //
304 // If --globalize-symbol is specified for a given symbol, it will be
305 // global in the output file even if it is not included via
306 // --keep-global-symbol. Because of that, make sure to check
307 // --globalize-symbol second.
308 if (!Config.SymbolsToKeepGlobal.empty() &&
Jordan Rupprecht634820d2018-10-30 16:23:38 +0000309 !is_contained(Config.SymbolsToKeepGlobal, Sym.Name) &&
310 Sym.getShndx() != SHN_UNDEF)
Alexander Shaposhnikovf4e75a52018-10-29 21:22:58 +0000311 Sym.Binding = STB_LOCAL;
312
Fangrui Songe4ee0662018-11-29 17:32:51 +0000313 if (is_contained(Config.SymbolsToGlobalize, Sym.Name) &&
Jordan Rupprecht634820d2018-10-30 16:23:38 +0000314 Sym.getShndx() != SHN_UNDEF)
Alexander Shaposhnikovf4e75a52018-10-29 21:22:58 +0000315 Sym.Binding = STB_GLOBAL;
316
Fangrui Songe4ee0662018-11-29 17:32:51 +0000317 if (is_contained(Config.SymbolsToWeaken, Sym.Name) &&
Alexander Shaposhnikovf4e75a52018-10-29 21:22:58 +0000318 Sym.Binding == STB_GLOBAL)
319 Sym.Binding = STB_WEAK;
320
321 if (Config.Weaken && Sym.Binding == STB_GLOBAL &&
322 Sym.getShndx() != SHN_UNDEF)
323 Sym.Binding = STB_WEAK;
324
325 const auto I = Config.SymbolsToRename.find(Sym.Name);
326 if (I != Config.SymbolsToRename.end())
327 Sym.Name = I->getValue();
328
329 if (!Config.SymbolsPrefix.empty() && Sym.Type != STT_SECTION)
330 Sym.Name = (Config.SymbolsPrefix + Sym.Name).str();
331 });
332
333 // The purpose of this loop is to mark symbols referenced by sections
334 // (like GroupSection or RelocationSection). This way, we know which
335 // symbols are still 'needed' and which are not.
Eugene Leviant2db10622019-02-13 07:34:54 +0000336 if (Config.StripUnneeded || !Config.UnneededSymbolsToRemove.empty()) {
Alexander Shaposhnikovf4e75a52018-10-29 21:22:58 +0000337 for (auto &Section : Obj.sections())
338 Section.markSymbols();
339 }
340
Jordan Rupprecht971d47622019-02-01 15:20:36 +0000341 auto RemoveSymbolsPred = [&](const Symbol &Sym) {
Fangrui Songe4ee0662018-11-29 17:32:51 +0000342 if (is_contained(Config.SymbolsToKeep, Sym.Name) ||
Alexander Shaposhnikovf4e75a52018-10-29 21:22:58 +0000343 (Config.KeepFileSymbols && Sym.Type == STT_FILE))
344 return false;
345
Jordan Rupprechtd0f7bcf2019-01-30 14:58:13 +0000346 if ((Config.DiscardMode == DiscardType::All ||
347 (Config.DiscardMode == DiscardType::Locals &&
348 StringRef(Sym.Name).startswith(".L"))) &&
349 Sym.Binding == STB_LOCAL && Sym.getShndx() != SHN_UNDEF &&
350 Sym.Type != STT_FILE && Sym.Type != STT_SECTION)
Alexander Shaposhnikovf4e75a52018-10-29 21:22:58 +0000351 return true;
352
353 if (Config.StripAll || Config.StripAllGNU)
354 return true;
355
Fangrui Songe4ee0662018-11-29 17:32:51 +0000356 if (is_contained(Config.SymbolsToRemove, Sym.Name))
Alexander Shaposhnikovf4e75a52018-10-29 21:22:58 +0000357 return true;
Alexander Shaposhnikovf4e75a52018-10-29 21:22:58 +0000358
Eugene Leviant2db10622019-02-13 07:34:54 +0000359 if ((Config.StripUnneeded ||
360 is_contained(Config.UnneededSymbolsToRemove, Sym.Name)) &&
361 isUnneededSymbol(Sym))
Alexander Shaposhnikovf4e75a52018-10-29 21:22:58 +0000362 return true;
363
364 return false;
Jordan Rupprecht971d47622019-02-01 15:20:36 +0000365 };
366 if (Error E = Obj.removeSymbols(RemoveSymbolsPred))
367 return E;
Alexander Shaposhnikovf4e75a52018-10-29 21:22:58 +0000368 }
369
370 SectionPred RemovePred = [](const SectionBase &) { return false; };
371
372 // Removes:
373 if (!Config.ToRemove.empty()) {
374 RemovePred = [&Config](const SectionBase &Sec) {
375 return is_contained(Config.ToRemove, Sec.Name);
376 };
377 }
378
379 if (Config.StripDWO || !Config.SplitDWO.empty())
380 RemovePred = [RemovePred](const SectionBase &Sec) {
381 return isDWOSection(Sec) || RemovePred(Sec);
382 };
383
384 if (Config.ExtractDWO)
385 RemovePred = [RemovePred, &Obj](const SectionBase &Sec) {
386 return onlyKeepDWOPred(Obj, Sec) || RemovePred(Sec);
387 };
388
389 if (Config.StripAllGNU)
390 RemovePred = [RemovePred, &Obj](const SectionBase &Sec) {
391 if (RemovePred(Sec))
392 return true;
393 if ((Sec.Flags & SHF_ALLOC) != 0)
394 return false;
395 if (&Sec == Obj.SectionNames)
396 return false;
397 switch (Sec.Type) {
398 case SHT_SYMTAB:
399 case SHT_REL:
400 case SHT_RELA:
401 case SHT_STRTAB:
402 return true;
403 }
404 return isDebugSection(Sec);
405 };
406
407 if (Config.StripSections) {
408 RemovePred = [RemovePred](const SectionBase &Sec) {
409 return RemovePred(Sec) || (Sec.Flags & SHF_ALLOC) == 0;
410 };
411 }
412
413 if (Config.StripDebug) {
414 RemovePred = [RemovePred](const SectionBase &Sec) {
415 return RemovePred(Sec) || isDebugSection(Sec);
416 };
417 }
418
419 if (Config.StripNonAlloc)
420 RemovePred = [RemovePred, &Obj](const SectionBase &Sec) {
421 if (RemovePred(Sec))
422 return true;
423 if (&Sec == Obj.SectionNames)
424 return false;
425 return (Sec.Flags & SHF_ALLOC) == 0;
426 };
427
428 if (Config.StripAll)
429 RemovePred = [RemovePred, &Obj](const SectionBase &Sec) {
430 if (RemovePred(Sec))
431 return true;
432 if (&Sec == Obj.SectionNames)
433 return false;
434 if (StringRef(Sec.Name).startswith(".gnu.warning"))
435 return false;
436 return (Sec.Flags & SHF_ALLOC) == 0;
437 };
438
439 // Explicit copies:
Jake Ehrlich85985ed2018-12-06 02:03:53 +0000440 if (!Config.OnlySection.empty()) {
Alexander Shaposhnikovf4e75a52018-10-29 21:22:58 +0000441 RemovePred = [&Config, RemovePred, &Obj](const SectionBase &Sec) {
442 // Explicitly keep these sections regardless of previous removes.
Jake Ehrlich85985ed2018-12-06 02:03:53 +0000443 if (is_contained(Config.OnlySection, Sec.Name))
Alexander Shaposhnikovf4e75a52018-10-29 21:22:58 +0000444 return false;
445
446 // Allow all implicit removes.
447 if (RemovePred(Sec))
448 return true;
449
450 // Keep special sections.
451 if (Obj.SectionNames == &Sec)
452 return false;
453 if (Obj.SymbolTable == &Sec ||
454 (Obj.SymbolTable && Obj.SymbolTable->getStrTab() == &Sec))
455 return false;
456
457 // Remove everything else.
458 return true;
459 };
460 }
461
Jordan Rupprechtc5bae782018-11-13 19:32:27 +0000462 if (!Config.KeepSection.empty()) {
Fangrui Songe9f34b02018-11-12 23:46:22 +0000463 RemovePred = [&Config, RemovePred](const SectionBase &Sec) {
Alexander Shaposhnikovf4e75a52018-10-29 21:22:58 +0000464 // Explicitly keep these sections regardless of previous removes.
Jordan Rupprechtc5bae782018-11-13 19:32:27 +0000465 if (is_contained(Config.KeepSection, Sec.Name))
Alexander Shaposhnikovf4e75a52018-10-29 21:22:58 +0000466 return false;
467 // Otherwise defer to RemovePred.
468 return RemovePred(Sec);
469 };
470 }
471
472 // This has to be the last predicate assignment.
473 // If the option --keep-symbol has been specified
474 // and at least one of those symbols is present
475 // (equivalently, the updated symbol table is not empty)
476 // the symbol table and the string table should not be removed.
477 if ((!Config.SymbolsToKeep.empty() || Config.KeepFileSymbols) &&
478 Obj.SymbolTable && !Obj.SymbolTable->empty()) {
479 RemovePred = [&Obj, RemovePred](const SectionBase &Sec) {
480 if (&Sec == Obj.SymbolTable || &Sec == Obj.SymbolTable->getStrTab())
481 return false;
482 return RemovePred(Sec);
483 };
484 }
485
486 if (Config.CompressionType != DebugCompressionType::None)
487 replaceDebugSections(Config, Obj, RemovePred, isCompressable,
488 [&Config, &Obj](const SectionBase *S) {
489 return &Obj.addSection<CompressedSection>(
490 *S, Config.CompressionType);
491 });
492 else if (Config.DecompressDebugSections)
493 replaceDebugSections(
494 Config, Obj, RemovePred,
495 [](const SectionBase &S) { return isa<CompressedSection>(&S); },
496 [&Obj](const SectionBase *S) {
497 auto CS = cast<CompressedSection>(S);
498 return &Obj.addSection<DecompressedSection>(*CS);
499 });
500
Jordan Rupprecht971d47622019-02-01 15:20:36 +0000501 if (Error E = Obj.removeSections(RemovePred))
502 return E;
Alexander Shaposhnikovf4e75a52018-10-29 21:22:58 +0000503
504 if (!Config.SectionsToRename.empty()) {
505 for (auto &Sec : Obj.sections()) {
506 const auto Iter = Config.SectionsToRename.find(Sec.Name);
507 if (Iter != Config.SectionsToRename.end()) {
508 const SectionRename &SR = Iter->second;
509 Sec.Name = SR.NewName;
Jordan Rupprechtc8927412019-01-29 15:05:38 +0000510 if (SR.NewFlags.hasValue())
511 Sec.Flags =
512 setSectionFlagsPreserveMask(Sec.Flags, SR.NewFlags.getValue());
513 }
514 }
515 }
516
517 if (!Config.SetSectionFlags.empty()) {
518 for (auto &Sec : Obj.sections()) {
519 const auto Iter = Config.SetSectionFlags.find(Sec.Name);
520 if (Iter != Config.SetSectionFlags.end()) {
521 const SectionFlagsUpdate &SFU = Iter->second;
522 Sec.Flags = setSectionFlagsPreserveMask(Sec.Flags, SFU.NewFlags);
Alexander Shaposhnikovf4e75a52018-10-29 21:22:58 +0000523 }
524 }
525 }
526
527 if (!Config.AddSection.empty()) {
528 for (const auto &Flag : Config.AddSection) {
Jordan Rupprecht17dd4a22019-01-15 16:57:23 +0000529 std::pair<StringRef, StringRef> SecPair = Flag.split("=");
530 StringRef SecName = SecPair.first;
531 StringRef File = SecPair.second;
532 ErrorOr<std::unique_ptr<MemoryBuffer>> BufOrErr =
533 MemoryBuffer::getFile(File);
Alexander Shaposhnikovf4e75a52018-10-29 21:22:58 +0000534 if (!BufOrErr)
Jordan Rupprecht307deab2019-01-30 14:36:53 +0000535 return createFileError(File, errorCodeToError(BufOrErr.getError()));
Jordan Rupprecht17dd4a22019-01-15 16:57:23 +0000536 std::unique_ptr<MemoryBuffer> Buf = std::move(*BufOrErr);
537 ArrayRef<uint8_t> Data(
538 reinterpret_cast<const uint8_t *>(Buf->getBufferStart()),
539 Buf->getBufferSize());
540 OwnedDataSection &NewSection =
541 Obj.addSection<OwnedDataSection>(SecName, Data);
542 if (SecName.startswith(".note") && SecName != ".note.GNU-stack")
543 NewSection.Type = SHT_NOTE;
Alexander Shaposhnikovf4e75a52018-10-29 21:22:58 +0000544 }
545 }
546
547 if (!Config.DumpSection.empty()) {
548 for (const auto &Flag : Config.DumpSection) {
549 std::pair<StringRef, StringRef> SecPair = Flag.split("=");
550 StringRef SecName = SecPair.first;
551 StringRef File = SecPair.second;
552 if (Error E = dumpSectionToFile(SecName, File, Obj))
Jordan Rupprecht307deab2019-01-30 14:36:53 +0000553 return createFileError(Config.InputFilename, std::move(E));
Alexander Shaposhnikovf4e75a52018-10-29 21:22:58 +0000554 }
555 }
556
557 if (!Config.AddGnuDebugLink.empty())
558 Obj.addSection<GnuDebugLinkSection>(Config.AddGnuDebugLink);
Jordan Rupprecht307deab2019-01-30 14:36:53 +0000559
Eugene Leviant51c1f642019-02-25 14:12:41 +0000560 for (const NewSymbolInfo &SI : Config.SymbolsToAdd) {
561 SectionBase *Sec = Obj.findSection(SI.SectionName);
562 uint64_t Value = Sec ? Sec->Addr + SI.Value : SI.Value;
Simon Pilgrim65706cf2019-02-27 10:19:53 +0000563 Obj.SymbolTable->addSymbol(
564 SI.SymbolName, SI.Bind, SI.Type, Sec, Value, SI.Visibility,
565 Sec ? (uint16_t)SYMBOL_SIMPLE_INDEX : (uint16_t)SHN_ABS, 0);
Eugene Leviant51c1f642019-02-25 14:12:41 +0000566 }
567
Eugene Leviant53350d02019-02-26 09:24:22 +0000568 if (Config.EntryExpr)
569 Obj.Entry = Config.EntryExpr(Obj.Entry);
Jordan Rupprecht307deab2019-01-30 14:36:53 +0000570 return Error::success();
Alexander Shaposhnikovf4e75a52018-10-29 21:22:58 +0000571}
572
Jordan Rupprecht307deab2019-01-30 14:36:53 +0000573Error executeObjcopyOnRawBinary(const CopyConfig &Config, MemoryBuffer &In,
574 Buffer &Out) {
Alexander Shaposhnikovf4e75a52018-10-29 21:22:58 +0000575 BinaryReader Reader(Config.BinaryArch, &In);
576 std::unique_ptr<Object> Obj = Reader.create();
577
Jordan Rupprecht70038e02019-01-07 16:59:12 +0000578 // Prefer OutputArch (-O<format>) if set, otherwise fallback to BinaryArch
579 // (-B<arch>).
580 const ElfType OutputElfType = getOutputElfType(
581 Config.OutputArch ? Config.OutputArch.getValue() : Config.BinaryArch);
Jordan Rupprecht307deab2019-01-30 14:36:53 +0000582 if (Error E = handleArgs(Config, *Obj, Reader, OutputElfType))
583 return E;
Alexander Shaposhnikovf4e75a52018-10-29 21:22:58 +0000584 std::unique_ptr<Writer> Writer =
585 createWriter(Config, *Obj, Out, OutputElfType);
Jordan Rupprecht881cae72019-01-22 23:49:16 +0000586 if (Error E = Writer->finalize())
Jordan Rupprecht307deab2019-01-30 14:36:53 +0000587 return E;
588 return Writer->write();
Alexander Shaposhnikovf4e75a52018-10-29 21:22:58 +0000589}
590
Jordan Rupprecht307deab2019-01-30 14:36:53 +0000591Error executeObjcopyOnBinary(const CopyConfig &Config,
592 object::ELFObjectFileBase &In, Buffer &Out) {
Alexander Shaposhnikovf4e75a52018-10-29 21:22:58 +0000593 ELFReader Reader(&In);
594 std::unique_ptr<Object> Obj = Reader.create();
Jordan Rupprecht70038e02019-01-07 16:59:12 +0000595 // Prefer OutputArch (-O<format>) if set, otherwise infer it from the input.
596 const ElfType OutputElfType =
597 Config.OutputArch ? getOutputElfType(Config.OutputArch.getValue())
598 : getOutputElfType(In);
Jake Ehrlich8ad77792018-12-03 19:49:23 +0000599 ArrayRef<uint8_t> BuildIdBytes;
600
601 if (!Config.BuildIdLinkDir.empty()) {
602 BuildIdBytes = unwrapOrError(findBuildID(In));
603 if (BuildIdBytes.size() < 2)
Jordan Rupprecht307deab2019-01-30 14:36:53 +0000604 return createFileError(
605 Config.InputFilename,
606 createStringError(object_error::parse_failed,
607 "build ID is smaller than two bytes."));
Jake Ehrlich8ad77792018-12-03 19:49:23 +0000608 }
609
Jordan Rupprechtfc832e92019-01-30 18:13:30 +0000610 if (!Config.BuildIdLinkDir.empty() && Config.BuildIdLinkInput)
611 if (Error E =
612 linkToBuildIdDir(Config, Config.InputFilename,
613 Config.BuildIdLinkInput.getValue(), BuildIdBytes))
614 return E;
615
Jordan Rupprecht307deab2019-01-30 14:36:53 +0000616 if (Error E = handleArgs(Config, *Obj, Reader, OutputElfType))
617 return E;
Alexander Shaposhnikovf4e75a52018-10-29 21:22:58 +0000618 std::unique_ptr<Writer> Writer =
619 createWriter(Config, *Obj, Out, OutputElfType);
Jordan Rupprecht881cae72019-01-22 23:49:16 +0000620 if (Error E = Writer->finalize())
Jordan Rupprecht307deab2019-01-30 14:36:53 +0000621 return E;
Jordan Rupprecht881cae72019-01-22 23:49:16 +0000622 if (Error E = Writer->write())
Jordan Rupprecht307deab2019-01-30 14:36:53 +0000623 return E;
Jordan Rupprechtfc832e92019-01-30 18:13:30 +0000624 if (!Config.BuildIdLinkDir.empty() && Config.BuildIdLinkOutput)
625 if (Error E =
626 linkToBuildIdDir(Config, Config.OutputFilename,
627 Config.BuildIdLinkOutput.getValue(), BuildIdBytes))
628 return E;
629
Jordan Rupprecht307deab2019-01-30 14:36:53 +0000630 return Error::success();
Alexander Shaposhnikovf4e75a52018-10-29 21:22:58 +0000631}
632
633} // end namespace elf
634} // end namespace objcopy
635} // end namespace llvm