tools/llvm-objcopy/CopyConfig.cpp

   1 //===- CopyConfig.cpp -----------------------------------------------------===//
   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 "CopyConfig.h"
  10
  11 #include "llvm/ADT/Optional.h"
  12 #include "llvm/ADT/SmallVector.h"
  13 #include "llvm/ADT/StringRef.h"
  14 #include "llvm/ADT/StringSet.h"
  15 #include "llvm/Option/Arg.h"
  16 #include "llvm/Option/ArgList.h"
  17 #include "llvm/Support/CommandLine.h"
  18 #include "llvm/Support/Compression.h"
  19 #include "llvm/Support/Errc.h"
  20 #include "llvm/Support/JamCRC.h"
  21 #include "llvm/Support/MemoryBuffer.h"
  22 #include "llvm/Support/StringSaver.h"
  23 #include <memory>
  24
  25 namespace llvm {
  26 namespace objcopy {
  27
  28 namespace {
  29 enum ObjcopyID {
  30   OBJCOPY_INVALID = 0, // This is not an option ID.
  31 #define OPTION(PREFIX, NAME, ID, KIND, GROUP, ALIAS, ALIASARGS, FLAGS, PARAM,  \
  32                HELPTEXT, METAVAR, VALUES)                                      \
  33   OBJCOPY_##ID,
  34 #include "ObjcopyOpts.inc"
  35 #undef OPTION
  36 };
  37
  38 #define PREFIX(NAME, VALUE) const char *const OBJCOPY_##NAME[] = VALUE;
  39 #include "ObjcopyOpts.inc"
  40 #undef PREFIX
  41
  42 static const opt::OptTable::Info ObjcopyInfoTable[] = {
  43 #define OPTION(PREFIX, NAME, ID, KIND, GROUP, ALIAS, ALIASARGS, FLAGS, PARAM,  \
  44                HELPTEXT, METAVAR, VALUES)                                      \
  45   {OBJCOPY_##PREFIX,                                                           \
  46    NAME,                                                                       \
  47    HELPTEXT,                                                                   \
  48    METAVAR,                                                                    \
  49    OBJCOPY_##ID,                                                               \
  50    opt::Option::KIND##Class,                                                   \
  51    PARAM,                                                                      \
  52    FLAGS,                                                                      \
  53    OBJCOPY_##GROUP,                                                            \
  54    OBJCOPY_##ALIAS,                                                            \
  55    ALIASARGS,                                                                  \
  56    VALUES},
  57 #include "ObjcopyOpts.inc"
  58 #undef OPTION
  59 };
  60
  61 class ObjcopyOptTable : public opt::OptTable {
  62 public:
  63   ObjcopyOptTable() : OptTable(ObjcopyInfoTable) {}
  64 };
  65
  66 enum StripID {
  67   STRIP_INVALID = 0, // This is not an option ID.
  68 #define OPTION(PREFIX, NAME, ID, KIND, GROUP, ALIAS, ALIASARGS, FLAGS, PARAM,  \
  69                HELPTEXT, METAVAR, VALUES)                                      \
  70   STRIP_##ID,
  71 #include "StripOpts.inc"
  72 #undef OPTION
  73 };
  74
  75 #define PREFIX(NAME, VALUE) const char *const STRIP_##NAME[] = VALUE;
  76 #include "StripOpts.inc"
  77 #undef PREFIX
  78
  79 static const opt::OptTable::Info StripInfoTable[] = {
  80 #define OPTION(PREFIX, NAME, ID, KIND, GROUP, ALIAS, ALIASARGS, FLAGS, PARAM,  \
  81                HELPTEXT, METAVAR, VALUES)                                      \
  82   {STRIP_##PREFIX, NAME,       HELPTEXT,                                       \
  83    METAVAR,        STRIP_##ID, opt::Option::KIND##Class,                       \
  84    PARAM,          FLAGS,      STRIP_##GROUP,                                  \
  85    STRIP_##ALIAS,  ALIASARGS,  VALUES},
  86 #include "StripOpts.inc"
  87 #undef OPTION
  88 };
  89
  90 class StripOptTable : public opt::OptTable {
  91 public:
  92   StripOptTable() : OptTable(StripInfoTable) {}
  93 };
  94
  95 } // namespace
  96
  97 static SectionFlag parseSectionRenameFlag(StringRef SectionName) {
  98   return llvm::StringSwitch<SectionFlag>(SectionName)
  99       .CaseLower("alloc", SectionFlag::SecAlloc)
 100       .CaseLower("load", SectionFlag::SecLoad)
 101       .CaseLower("noload", SectionFlag::SecNoload)
 102       .CaseLower("readonly", SectionFlag::SecReadonly)
 103       .CaseLower("debug", SectionFlag::SecDebug)
 104       .CaseLower("code", SectionFlag::SecCode)
 105       .CaseLower("data", SectionFlag::SecData)
 106       .CaseLower("rom", SectionFlag::SecRom)
 107       .CaseLower("merge", SectionFlag::SecMerge)
 108       .CaseLower("strings", SectionFlag::SecStrings)
 109       .CaseLower("contents", SectionFlag::SecContents)
 110       .CaseLower("share", SectionFlag::SecShare)
 111       .Default(SectionFlag::SecNone);
 112 }
 113
 114 static Expected<SectionFlag>
 115 parseSectionFlagSet(ArrayRef<StringRef> SectionFlags) {
 116   SectionFlag ParsedFlags = SectionFlag::SecNone;
 117   for (StringRef Flag : SectionFlags) {
 118     SectionFlag ParsedFlag = parseSectionRenameFlag(Flag);
 119     if (ParsedFlag == SectionFlag::SecNone)
 120       return createStringError(
 121           errc::invalid_argument,
 122           "unrecognized section flag '%s'. Flags supported for GNU "
 123           "compatibility: alloc, load, noload, readonly, debug, code, data, "
 124           "rom, share, contents, merge, strings",
 125           Flag.str().c_str());
 126     ParsedFlags |= ParsedFlag;
 127   }
 128
 129   return ParsedFlags;
 130 }
 131
 132 static Expected<SectionRename> parseRenameSectionValue(StringRef FlagValue) {
 133   if (!FlagValue.contains('='))
 134     return createStringError(errc::invalid_argument,
 135                              "bad format for --rename-section: missing '='");
 136
 137   // Initial split: ".foo" = ".bar,f1,f2,..."
 138   auto Old2New = FlagValue.split('=');
 139   SectionRename SR;
 140   SR.OriginalName = Old2New.first;
 141
 142   // Flags split: ".bar" "f1" "f2" ...
 143   SmallVector<StringRef, 6> NameAndFlags;
 144   Old2New.second.split(NameAndFlags, ',');
 145   SR.NewName = NameAndFlags[0];
 146
 147   if (NameAndFlags.size() > 1) {
 148     Expected<SectionFlag> ParsedFlagSet =
 149         parseSectionFlagSet(makeArrayRef(NameAndFlags).drop_front());
 150     if (!ParsedFlagSet)
 151       return ParsedFlagSet.takeError();
 152     SR.NewFlags = *ParsedFlagSet;
 153   }
 154
 155   return SR;
 156 }
 157
 158 static Expected<SectionFlagsUpdate>
 159 parseSetSectionFlagValue(StringRef FlagValue) {
 160   if (!StringRef(FlagValue).contains('='))
 161     return createStringError(errc::invalid_argument,
 162                              "bad format for --set-section-flags: missing '='");
 163
 164   // Initial split: ".foo" = "f1,f2,..."
 165   auto Section2Flags = StringRef(FlagValue).split('=');
 166   SectionFlagsUpdate SFU;
 167   SFU.Name = Section2Flags.first;
 168
 169   // Flags split: "f1" "f2" ...
 170   SmallVector<StringRef, 6> SectionFlags;
 171   Section2Flags.second.split(SectionFlags, ',');
 172   Expected<SectionFlag> ParsedFlagSet = parseSectionFlagSet(SectionFlags);
 173   if (!ParsedFlagSet)
 174     return ParsedFlagSet.takeError();
 175   SFU.NewFlags = *ParsedFlagSet;
 176
 177   return SFU;
 178 }
 179
 180 struct TargetInfo {
 181   FileFormat Format;
 182   MachineInfo Machine;
 183 };
 184
 185 // FIXME: consolidate with the bfd parsing used by lld.
 186 static const StringMap<MachineInfo> TargetMap{
 187     // Name, {EMachine, 64bit, LittleEndian}
 188     // x86
 189     {"elf32-i386", {ELF::EM_386, false, true}},
 190     {"elf32-x86-64", {ELF::EM_X86_64, false, true}},
 191     {"elf64-x86-64", {ELF::EM_X86_64, true, true}},
 192     // Intel MCU
 193     {"elf32-iamcu", {ELF::EM_IAMCU, false, true}},
 194     // ARM
 195     {"elf32-littlearm", {ELF::EM_ARM, false, true}},
 196     // ARM AArch64
 197     {"elf64-aarch64", {ELF::EM_AARCH64, true, true}},
 198     {"elf64-littleaarch64", {ELF::EM_AARCH64, true, true}},
 199     // RISC-V
 200     {"elf32-littleriscv", {ELF::EM_RISCV, false, true}},
 201     {"elf64-littleriscv", {ELF::EM_RISCV, true, true}},
 202     // PowerPC
 203     {"elf32-powerpc", {ELF::EM_PPC, false, false}},
 204     {"elf32-powerpcle", {ELF::EM_PPC, false, true}},
 205     {"elf64-powerpc", {ELF::EM_PPC64, true, false}},
 206     {"elf64-powerpcle", {ELF::EM_PPC64, true, true}},
 207     // MIPS
 208     {"elf32-bigmips", {ELF::EM_MIPS, false, false}},
 209     {"elf32-ntradbigmips", {ELF::EM_MIPS, false, false}},
 210     {"elf32-ntradlittlemips", {ELF::EM_MIPS, false, true}},
 211     {"elf32-tradbigmips", {ELF::EM_MIPS, false, false}},
 212     {"elf32-tradlittlemips", {ELF::EM_MIPS, false, true}},
 213     {"elf64-tradbigmips", {ELF::EM_MIPS, true, false}},
 214     {"elf64-tradlittlemips", {ELF::EM_MIPS, true, true}},
 215     // SPARC
 216     {"elf32-sparc", {ELF::EM_SPARC, false, false}},
 217     {"elf32-sparcel", {ELF::EM_SPARC, false, true}},
 218 };
 219
 220 static Expected<TargetInfo>
 221 getOutputTargetInfoByTargetName(StringRef TargetName) {
 222   StringRef OriginalTargetName = TargetName;
 223   bool IsFreeBSD = TargetName.consume_back("-freebsd");
 224   auto Iter = TargetMap.find(TargetName);
 225   if (Iter == std::end(TargetMap))
 226     return createStringError(errc::invalid_argument,
 227                              "invalid output format: '%s'",
 228                              OriginalTargetName.str().c_str());
 229   MachineInfo MI = Iter->getValue();
 230   if (IsFreeBSD)
 231     MI.OSABI = ELF::ELFOSABI_FREEBSD;
 232
 233   FileFormat Format;
 234   if (TargetName.startswith("elf"))
 235     Format = FileFormat::ELF;
 236   else
 237     // This should never happen because `TargetName` is valid (it certainly
 238     // exists in the TargetMap).
 239     llvm_unreachable("unknown target prefix");
 240
 241   return {TargetInfo{Format, MI}};
 242 }
 243
 244 static Error addSymbolsFromFile(NameMatcher &Symbols, BumpPtrAllocator &Alloc,
 245                                 StringRef Filename, bool UseRegex) {
 246   StringSaver Saver(Alloc);
 247   SmallVector<StringRef, 16> Lines;
 248   auto BufOrErr = MemoryBuffer::getFile(Filename);
 249   if (!BufOrErr)
 250     return createFileError(Filename, BufOrErr.getError());
 251
 252   BufOrErr.get()->getBuffer().split(Lines, '\n');
 253   for (StringRef Line : Lines) {
 254     // Ignore everything after '#', trim whitespace, and only add the symbol if
 255     // it's not empty.
 256     auto TrimmedLine = Line.split('#').first.trim();
 257     if (!TrimmedLine.empty())
 258       Symbols.addMatcher({Saver.save(TrimmedLine), UseRegex});
 259   }
 260
 261   return Error::success();
 262 }
 263
 264 NameOrRegex::NameOrRegex(StringRef Pattern, bool IsRegex) {
 265   if (!IsRegex) {
 266     Name = Pattern;
 267     return;
 268   }
 269
 270   SmallVector<char, 32> Data;
 271   R = std::make_shared<Regex>(
 272       ("^" + Pattern.ltrim('^').rtrim('$') + "$").toStringRef(Data));
 273 }
 274
 275 static Error addSymbolsToRenameFromFile(StringMap<StringRef> &SymbolsToRename,
 276                                         BumpPtrAllocator &Alloc,
 277                                         StringRef Filename) {
 278   StringSaver Saver(Alloc);
 279   SmallVector<StringRef, 16> Lines;
 280   auto BufOrErr = MemoryBuffer::getFile(Filename);
 281   if (!BufOrErr)
 282     return createFileError(Filename, BufOrErr.getError());
 283
 284   BufOrErr.get()->getBuffer().split(Lines, '\n');
 285   size_t NumLines = Lines.size();
 286   for (size_t LineNo = 0; LineNo < NumLines; ++LineNo) {
 287     StringRef TrimmedLine = Lines[LineNo].split('#').first.trim();
 288     if (TrimmedLine.empty())
 289       continue;
 290
 291     std::pair<StringRef, StringRef> Pair = Saver.save(TrimmedLine).split(' ');
 292     StringRef NewName = Pair.second.trim();
 293     if (NewName.empty())
 294       return createStringError(errc::invalid_argument,
 295                                "%s:%zu: missing new symbol name",
 296                                Filename.str().c_str(), LineNo + 1);
 297     SymbolsToRename.insert({Pair.first, NewName});
 298   }
 299   return Error::success();
 300 }
 301
 302 template <class T> static ErrorOr<T> getAsInteger(StringRef Val) {
 303   T Result;
 304   if (Val.getAsInteger(0, Result))
 305     return errc::invalid_argument;
 306   return Result;
 307 }
 308
 309 static void printHelp(const opt::OptTable &OptTable, raw_ostream &OS,
 310                       StringRef ToolName) {
 311   OptTable.PrintHelp(OS, (ToolName + " input [output]").str().c_str(),
 312                      (ToolName + " tool").str().c_str());
 313   // TODO: Replace this with libOption call once it adds extrahelp support.
 314   // The CommandLine library has a cl::extrahelp class to support this,
 315   // but libOption does not have that yet.
 316   OS << "\nPass @FILE as argument to read options from FILE.\n";
 317 }
 318
 319 // ParseObjcopyOptions returns the config and sets the input arguments. If a
 320 // help flag is set then ParseObjcopyOptions will print the help messege and
 321 // exit.
 322 Expected<DriverConfig> parseObjcopyOptions(ArrayRef<const char *> ArgsArr) {
 323   DriverConfig DC;
 324   ObjcopyOptTable T;
 325   unsigned MissingArgumentIndex, MissingArgumentCount;
 326   llvm::opt::InputArgList InputArgs =
 327       T.ParseArgs(ArgsArr, MissingArgumentIndex, MissingArgumentCount);
 328
 329   if (InputArgs.size() == 0) {
 330     printHelp(T, errs(), "llvm-objcopy");
 331     exit(1);
 332   }
 333
 334   if (InputArgs.hasArg(OBJCOPY_help)) {
 335     printHelp(T, outs(), "llvm-objcopy");
 336     exit(0);
 337   }
 338
 339   if (InputArgs.hasArg(OBJCOPY_version)) {
 340     outs() << "llvm-objcopy, compatible with GNU objcopy\n";
 341     cl::PrintVersionMessage();
 342     exit(0);
 343   }
 344
 345   SmallVector<const char *, 2> Positional;
 346
 347   for (auto Arg : InputArgs.filtered(OBJCOPY_UNKNOWN))
 348     return createStringError(errc::invalid_argument, "unknown argument '%s'",
 349                              Arg->getAsString(InputArgs).c_str());
 350
 351   for (auto Arg : InputArgs.filtered(OBJCOPY_INPUT))
 352     Positional.push_back(Arg->getValue());
 353
 354   if (Positional.empty())
 355     return createStringError(errc::invalid_argument, "no input file specified");
 356
 357   if (Positional.size() > 2)
 358     return createStringError(errc::invalid_argument,
 359                              "too many positional arguments");
 360
 361   CopyConfig Config;
 362   Config.InputFilename = Positional[0];
 363   Config.OutputFilename = Positional[Positional.size() == 1 ? 0 : 1];
 364   if (InputArgs.hasArg(OBJCOPY_target) &&
 365       (InputArgs.hasArg(OBJCOPY_input_target) ||
 366        InputArgs.hasArg(OBJCOPY_output_target)))
 367     return createStringError(
 368         errc::invalid_argument,
 369         "--target cannot be used with --input-target or --output-target");
 370
 371   bool UseRegex = InputArgs.hasArg(OBJCOPY_regex);
 372   StringRef InputFormat, OutputFormat;
 373   if (InputArgs.hasArg(OBJCOPY_target)) {
 374     InputFormat = InputArgs.getLastArgValue(OBJCOPY_target);
 375     OutputFormat = InputArgs.getLastArgValue(OBJCOPY_target);
 376   } else {
 377     InputFormat = InputArgs.getLastArgValue(OBJCOPY_input_target);
 378     OutputFormat = InputArgs.getLastArgValue(OBJCOPY_output_target);
 379   }
 380
 381   // FIXME:  Currently, we ignore the target for non-binary/ihex formats
 382   // explicitly specified by -I option (e.g. -Ielf32-x86-64) and guess the
 383   // format by llvm::object::createBinary regardless of the option value.
 384   Config.InputFormat = StringSwitch<FileFormat>(InputFormat)
 385                            .Case("binary", FileFormat::Binary)
 386                            .Case("ihex", FileFormat::IHex)
 387                            .Default(FileFormat::Unspecified);
 388
 389   if (InputArgs.hasArg(OBJCOPY_new_symbol_visibility))
 390     Config.NewSymbolVisibility =
 391         InputArgs.getLastArgValue(OBJCOPY_new_symbol_visibility);
 392
 393   Config.OutputFormat = StringSwitch<FileFormat>(OutputFormat)
 394                             .Case("binary", FileFormat::Binary)
 395                             .Case("ihex", FileFormat::IHex)
 396                             .Default(FileFormat::Unspecified);
 397   if (Config.OutputFormat == FileFormat::Unspecified) {
 398     if (OutputFormat.empty()) {
 399       Config.OutputFormat = Config.InputFormat;
 400     } else {
 401       Expected<TargetInfo> Target =
 402           getOutputTargetInfoByTargetName(OutputFormat);
 403       if (!Target)
 404         return Target.takeError();
 405       Config.OutputFormat = Target->Format;
 406       Config.OutputArch = Target->Machine;
 407     }
 408   }
 409
 410   if (auto Arg = InputArgs.getLastArg(OBJCOPY_compress_debug_sections,
 411                                       OBJCOPY_compress_debug_sections_eq)) {
 412     Config.CompressionType = DebugCompressionType::Z;
 413
 414     if (Arg->getOption().getID() == OBJCOPY_compress_debug_sections_eq) {
 415       Config.CompressionType =
 416           StringSwitch<DebugCompressionType>(
 417               InputArgs.getLastArgValue(OBJCOPY_compress_debug_sections_eq))
 418               .Case("zlib-gnu", DebugCompressionType::GNU)
 419               .Case("zlib", DebugCompressionType::Z)
 420               .Default(DebugCompressionType::None);
 421       if (Config.CompressionType == DebugCompressionType::None)
 422         return createStringError(
 423             errc::invalid_argument,
 424             "invalid or unsupported --compress-debug-sections format: %s",
 425             InputArgs.getLastArgValue(OBJCOPY_compress_debug_sections_eq)
 426                 .str()
 427                 .c_str());
 428     }
 429     if (!zlib::isAvailable())
 430       return createStringError(
 431           errc::invalid_argument,
 432           "LLVM was not compiled with LLVM_ENABLE_ZLIB: can not compress");
 433   }
 434
 435   Config.AddGnuDebugLink = InputArgs.getLastArgValue(OBJCOPY_add_gnu_debuglink);
 436   // The gnu_debuglink's target is expected to not change or else its CRC would
 437   // become invalidated and get rejected. We can avoid recalculating the
 438   // checksum for every target file inside an archive by precomputing the CRC
 439   // here. This prevents a significant amount of I/O.
 440   if (!Config.AddGnuDebugLink.empty()) {
 441     auto DebugOrErr = MemoryBuffer::getFile(Config.AddGnuDebugLink);
 442     if (!DebugOrErr)
 443       return createFileError(Config.AddGnuDebugLink, DebugOrErr.getError());
 444     auto Debug = std::move(*DebugOrErr);
 445     JamCRC CRC;
 446     CRC.update(
 447         ArrayRef<char>(Debug->getBuffer().data(), Debug->getBuffer().size()));
 448     // The CRC32 value needs to be complemented because the JamCRC doesn't
 449     // finalize the CRC32 value.
 450     Config.GnuDebugLinkCRC32 = ~CRC.getCRC();
 451   }
 452   Config.BuildIdLinkDir = InputArgs.getLastArgValue(OBJCOPY_build_id_link_dir);
 453   if (InputArgs.hasArg(OBJCOPY_build_id_link_input))
 454     Config.BuildIdLinkInput =
 455         InputArgs.getLastArgValue(OBJCOPY_build_id_link_input);
 456   if (InputArgs.hasArg(OBJCOPY_build_id_link_output))
 457     Config.BuildIdLinkOutput =
 458         InputArgs.getLastArgValue(OBJCOPY_build_id_link_output);
 459   Config.SplitDWO = InputArgs.getLastArgValue(OBJCOPY_split_dwo);
 460   Config.SymbolsPrefix = InputArgs.getLastArgValue(OBJCOPY_prefix_symbols);
 461   Config.AllocSectionsPrefix =
 462       InputArgs.getLastArgValue(OBJCOPY_prefix_alloc_sections);
 463   if (auto Arg = InputArgs.getLastArg(OBJCOPY_extract_partition))
 464     Config.ExtractPartition = Arg->getValue();
 465
 466   for (auto Arg : InputArgs.filtered(OBJCOPY_redefine_symbol)) {
 467     if (!StringRef(Arg->getValue()).contains('='))
 468       return createStringError(errc::invalid_argument,
 469                                "bad format for --redefine-sym");
 470     auto Old2New = StringRef(Arg->getValue()).split('=');
 471     if (!Config.SymbolsToRename.insert(Old2New).second)
 472       return createStringError(errc::invalid_argument,
 473                                "multiple redefinition of symbol '%s'",
 474                                Old2New.first.str().c_str());
 475   }
 476
 477   for (auto Arg : InputArgs.filtered(OBJCOPY_redefine_symbols))
 478     if (Error E = addSymbolsToRenameFromFile(Config.SymbolsToRename, DC.Alloc,
 479                                              Arg->getValue()))
 480       return std::move(E);
 481
 482   for (auto Arg : InputArgs.filtered(OBJCOPY_rename_section)) {
 483     Expected<SectionRename> SR =
 484         parseRenameSectionValue(StringRef(Arg->getValue()));
 485     if (!SR)
 486       return SR.takeError();
 487     if (!Config.SectionsToRename.try_emplace(SR->OriginalName, *SR).second)
 488       return createStringError(errc::invalid_argument,
 489                                "multiple renames of section '%s'",
 490                                SR->OriginalName.str().c_str());
 491   }
 492   for (auto Arg : InputArgs.filtered(OBJCOPY_set_section_flags)) {
 493     Expected<SectionFlagsUpdate> SFU =
 494         parseSetSectionFlagValue(Arg->getValue());
 495     if (!SFU)
 496       return SFU.takeError();
 497     if (!Config.SetSectionFlags.try_emplace(SFU->Name, *SFU).second)
 498       return createStringError(
 499           errc::invalid_argument,
 500           "--set-section-flags set multiple times for section '%s'",
 501           SFU->Name.str().c_str());
 502   }
 503   // Prohibit combinations of --set-section-flags when the section name is used
 504   // by --rename-section, either as a source or a destination.
 505   for (const auto &E : Config.SectionsToRename) {
 506     const SectionRename &SR = E.second;
 507     if (Config.SetSectionFlags.count(SR.OriginalName))
 508       return createStringError(
 509           errc::invalid_argument,
 510           "--set-section-flags=%s conflicts with --rename-section=%s=%s",
 511           SR.OriginalName.str().c_str(), SR.OriginalName.str().c_str(),
 512           SR.NewName.str().c_str());
 513     if (Config.SetSectionFlags.count(SR.NewName))
 514       return createStringError(
 515           errc::invalid_argument,
 516           "--set-section-flags=%s conflicts with --rename-section=%s=%s",
 517           SR.NewName.str().c_str(), SR.OriginalName.str().c_str(),
 518           SR.NewName.str().c_str());
 519   }
 520
 521   for (auto Arg : InputArgs.filtered(OBJCOPY_remove_section))
 522     Config.ToRemove.addMatcher({Arg->getValue(), UseRegex});
 523   for (auto Arg : InputArgs.filtered(OBJCOPY_keep_section))
 524     Config.KeepSection.addMatcher({Arg->getValue(), UseRegex});
 525   for (auto Arg : InputArgs.filtered(OBJCOPY_only_section))
 526     Config.OnlySection.addMatcher({Arg->getValue(), UseRegex});
 527   for (auto Arg : InputArgs.filtered(OBJCOPY_add_section)) {
 528     StringRef ArgValue(Arg->getValue());
 529     if (!ArgValue.contains('='))
 530       return createStringError(errc::invalid_argument,
 531                                "bad format for --add-section: missing '='");
 532     if (ArgValue.split("=").second.empty())
 533       return createStringError(
 534           errc::invalid_argument,
 535           "bad format for --add-section: missing file name");
 536     Config.AddSection.push_back(ArgValue);
 537   }
 538   for (auto Arg : InputArgs.filtered(OBJCOPY_dump_section))
 539     Config.DumpSection.push_back(Arg->getValue());
 540   Config.StripAll = InputArgs.hasArg(OBJCOPY_strip_all);
 541   Config.StripAllGNU = InputArgs.hasArg(OBJCOPY_strip_all_gnu);
 542   Config.StripDebug = InputArgs.hasArg(OBJCOPY_strip_debug);
 543   Config.StripDWO = InputArgs.hasArg(OBJCOPY_strip_dwo);
 544   Config.StripSections = InputArgs.hasArg(OBJCOPY_strip_sections);
 545   Config.StripNonAlloc = InputArgs.hasArg(OBJCOPY_strip_non_alloc);
 546   Config.StripUnneeded = InputArgs.hasArg(OBJCOPY_strip_unneeded);
 547   Config.ExtractDWO = InputArgs.hasArg(OBJCOPY_extract_dwo);
 548   Config.ExtractMainPartition =
 549       InputArgs.hasArg(OBJCOPY_extract_main_partition);
 550   Config.LocalizeHidden = InputArgs.hasArg(OBJCOPY_localize_hidden);
 551   Config.Weaken = InputArgs.hasArg(OBJCOPY_weaken);
 552   if (InputArgs.hasArg(OBJCOPY_discard_all, OBJCOPY_discard_locals))
 553     Config.DiscardMode =
 554         InputArgs.hasFlag(OBJCOPY_discard_all, OBJCOPY_discard_locals)
 555             ? DiscardType::All
 556             : DiscardType::Locals;
 557   Config.OnlyKeepDebug = InputArgs.hasArg(OBJCOPY_only_keep_debug);
 558   Config.KeepFileSymbols = InputArgs.hasArg(OBJCOPY_keep_file_symbols);
 559   Config.DecompressDebugSections =
 560       InputArgs.hasArg(OBJCOPY_decompress_debug_sections);
 561   if (Config.DiscardMode == DiscardType::All)
 562     Config.StripDebug = true;
 563   for (auto Arg : InputArgs.filtered(OBJCOPY_localize_symbol))
 564     Config.SymbolsToLocalize.addMatcher({Arg->getValue(), UseRegex});
 565   for (auto Arg : InputArgs.filtered(OBJCOPY_localize_symbols))
 566     if (Error E = addSymbolsFromFile(Config.SymbolsToLocalize, DC.Alloc,
 567                                      Arg->getValue(), UseRegex))
 568       return std::move(E);
 569   for (auto Arg : InputArgs.filtered(OBJCOPY_keep_global_symbol))
 570     Config.SymbolsToKeepGlobal.addMatcher({Arg->getValue(), UseRegex});
 571   for (auto Arg : InputArgs.filtered(OBJCOPY_keep_global_symbols))
 572     if (Error E = addSymbolsFromFile(Config.SymbolsToKeepGlobal, DC.Alloc,
 573                                      Arg->getValue(), UseRegex))
 574       return std::move(E);
 575   for (auto Arg : InputArgs.filtered(OBJCOPY_globalize_symbol))
 576     Config.SymbolsToGlobalize.addMatcher({Arg->getValue(), UseRegex});
 577   for (auto Arg : InputArgs.filtered(OBJCOPY_globalize_symbols))
 578     if (Error E = addSymbolsFromFile(Config.SymbolsToGlobalize, DC.Alloc,
 579                                      Arg->getValue(), UseRegex))
 580       return std::move(E);
 581   for (auto Arg : InputArgs.filtered(OBJCOPY_weaken_symbol))
 582     Config.SymbolsToWeaken.addMatcher({Arg->getValue(), UseRegex});
 583   for (auto Arg : InputArgs.filtered(OBJCOPY_weaken_symbols))
 584     if (Error E = addSymbolsFromFile(Config.SymbolsToWeaken, DC.Alloc,
 585                                      Arg->getValue(), UseRegex))
 586       return std::move(E);
 587   for (auto Arg : InputArgs.filtered(OBJCOPY_strip_symbol))
 588     Config.SymbolsToRemove.addMatcher({Arg->getValue(), UseRegex});
 589   for (auto Arg : InputArgs.filtered(OBJCOPY_strip_symbols))
 590     if (Error E = addSymbolsFromFile(Config.SymbolsToRemove, DC.Alloc,
 591                                      Arg->getValue(), UseRegex))
 592       return std::move(E);
 593   for (auto Arg : InputArgs.filtered(OBJCOPY_strip_unneeded_symbol))
 594     Config.UnneededSymbolsToRemove.addMatcher({Arg->getValue(), UseRegex});
 595   for (auto Arg : InputArgs.filtered(OBJCOPY_strip_unneeded_symbols))
 596     if (Error E = addSymbolsFromFile(Config.UnneededSymbolsToRemove, DC.Alloc,
 597                                      Arg->getValue(), UseRegex))
 598       return std::move(E);
 599   for (auto Arg : InputArgs.filtered(OBJCOPY_keep_symbol))
 600     Config.SymbolsToKeep.addMatcher({Arg->getValue(), UseRegex});
 601   for (auto Arg : InputArgs.filtered(OBJCOPY_keep_symbols))
 602     if (Error E = addSymbolsFromFile(Config.SymbolsToKeep, DC.Alloc,
 603                                      Arg->getValue(), UseRegex))
 604       return std::move(E);
 605   for (auto Arg : InputArgs.filtered(OBJCOPY_add_symbol))
 606     Config.SymbolsToAdd.push_back(Arg->getValue());
 607
 608   Config.AllowBrokenLinks = InputArgs.hasArg(OBJCOPY_allow_broken_links);
 609
 610   Config.DeterministicArchives = InputArgs.hasFlag(
 611       OBJCOPY_enable_deterministic_archives,
 612       OBJCOPY_disable_deterministic_archives, /*default=*/true);
 613
 614   Config.PreserveDates = InputArgs.hasArg(OBJCOPY_preserve_dates);
 615
 616   if (Config.PreserveDates &&
 617       (Config.OutputFilename == "-" || Config.InputFilename == "-"))
 618     return createStringError(errc::invalid_argument,
 619                              "--preserve-dates requires a file");
 620
 621   for (auto Arg : InputArgs)
 622     if (Arg->getOption().matches(OBJCOPY_set_start)) {
 623       auto EAddr = getAsInteger<uint64_t>(Arg->getValue());
 624       if (!EAddr)
 625         return createStringError(
 626             EAddr.getError(), "bad entry point address: '%s'", Arg->getValue());
 627
 628       Config.EntryExpr = [EAddr](uint64_t) { return *EAddr; };
 629     } else if (Arg->getOption().matches(OBJCOPY_change_start)) {
 630       auto EIncr = getAsInteger<int64_t>(Arg->getValue());
 631       if (!EIncr)
 632         return createStringError(EIncr.getError(),
 633                                  "bad entry point increment: '%s'",
 634                                  Arg->getValue());
 635       auto Expr = Config.EntryExpr ? std::move(Config.EntryExpr)
 636                                    : [](uint64_t A) { return A; };
 637       Config.EntryExpr = [Expr, EIncr](uint64_t EAddr) {
 638         return Expr(EAddr) + *EIncr;
 639       };
 640     }
 641
 642   if (Config.DecompressDebugSections &&
 643       Config.CompressionType != DebugCompressionType::None) {
 644     return createStringError(
 645         errc::invalid_argument,
 646         "cannot specify both --compress-debug-sections and "
 647         "--decompress-debug-sections");
 648   }
 649
 650   if (Config.DecompressDebugSections && !zlib::isAvailable())
 651     return createStringError(
 652         errc::invalid_argument,
 653         "LLVM was not compiled with LLVM_ENABLE_ZLIB: cannot decompress");
 654
 655   if (Config.ExtractPartition && Config.ExtractMainPartition)
 656     return createStringError(errc::invalid_argument,
 657                              "cannot specify --extract-partition together with "
 658                              "--extract-main-partition");
 659
 660   DC.CopyConfigs.push_back(std::move(Config));
 661   return std::move(DC);
 662 }
 663
 664 // ParseStripOptions returns the config and sets the input arguments. If a
 665 // help flag is set then ParseStripOptions will print the help messege and
 666 // exit.
 667 Expected<DriverConfig>
 668 parseStripOptions(ArrayRef<const char *> ArgsArr,
 669                   std::function<Error(Error)> ErrorCallback) {
 670   StripOptTable T;
 671   unsigned MissingArgumentIndex, MissingArgumentCount;
 672   llvm::opt::InputArgList InputArgs =
 673       T.ParseArgs(ArgsArr, MissingArgumentIndex, MissingArgumentCount);
 674
 675   if (InputArgs.size() == 0) {
 676     printHelp(T, errs(), "llvm-strip");
 677     exit(1);
 678   }
 679
 680   if (InputArgs.hasArg(STRIP_help)) {
 681     printHelp(T, outs(), "llvm-strip");
 682     exit(0);
 683   }
 684
 685   if (InputArgs.hasArg(STRIP_version)) {
 686     outs() << "llvm-strip, compatible with GNU strip\n";
 687     cl::PrintVersionMessage();
 688     exit(0);
 689   }
 690
 691   SmallVector<StringRef, 2> Positional;
 692   for (auto Arg : InputArgs.filtered(STRIP_UNKNOWN))
 693     return createStringError(errc::invalid_argument, "unknown argument '%s'",
 694                              Arg->getAsString(InputArgs).c_str());
 695   for (auto Arg : InputArgs.filtered(STRIP_INPUT))
 696     Positional.push_back(Arg->getValue());
 697
 698   if (Positional.empty())
 699     return createStringError(errc::invalid_argument, "no input file specified");
 700
 701   if (Positional.size() > 1 && InputArgs.hasArg(STRIP_output))
 702     return createStringError(
 703         errc::invalid_argument,
 704         "multiple input files cannot be used in combination with -o");
 705
 706   CopyConfig Config;
 707   bool UseRegexp = InputArgs.hasArg(STRIP_regex);
 708   Config.AllowBrokenLinks = InputArgs.hasArg(STRIP_allow_broken_links);
 709   Config.StripDebug = InputArgs.hasArg(STRIP_strip_debug);
 710
 711   if (InputArgs.hasArg(STRIP_discard_all, STRIP_discard_locals))
 712     Config.DiscardMode =
 713         InputArgs.hasFlag(STRIP_discard_all, STRIP_discard_locals)
 714             ? DiscardType::All
 715             : DiscardType::Locals;
 716   Config.StripSections = InputArgs.hasArg(STRIP_strip_sections);
 717   Config.StripUnneeded = InputArgs.hasArg(STRIP_strip_unneeded);
 718   if (auto Arg = InputArgs.getLastArg(STRIP_strip_all, STRIP_no_strip_all))
 719     Config.StripAll = Arg->getOption().getID() == STRIP_strip_all;
 720   Config.StripAllGNU = InputArgs.hasArg(STRIP_strip_all_gnu);
 721   Config.OnlyKeepDebug = InputArgs.hasArg(STRIP_only_keep_debug);
 722   Config.KeepFileSymbols = InputArgs.hasArg(STRIP_keep_file_symbols);
 723
 724   for (auto Arg : InputArgs.filtered(STRIP_keep_section))
 725     Config.KeepSection.addMatcher({Arg->getValue(), UseRegexp});
 726
 727   for (auto Arg : InputArgs.filtered(STRIP_remove_section))
 728     Config.ToRemove.addMatcher({Arg->getValue(), UseRegexp});
 729
 730   for (auto Arg : InputArgs.filtered(STRIP_strip_symbol))
 731     Config.SymbolsToRemove.addMatcher({Arg->getValue(), UseRegexp});
 732
 733   for (auto Arg : InputArgs.filtered(STRIP_keep_symbol))
 734     Config.SymbolsToKeep.addMatcher({Arg->getValue(), UseRegexp});
 735
 736   if (!InputArgs.hasArg(STRIP_no_strip_all) && !Config.StripDebug &&
 737       !Config.StripUnneeded && Config.DiscardMode == DiscardType::None &&
 738       !Config.StripAllGNU && Config.SymbolsToRemove.empty())
 739     Config.StripAll = true;
 740
 741   if (Config.DiscardMode == DiscardType::All)
 742     Config.StripDebug = true;
 743
 744   Config.DeterministicArchives =
 745       InputArgs.hasFlag(STRIP_enable_deterministic_archives,
 746                         STRIP_disable_deterministic_archives, /*default=*/true);
 747
 748   Config.PreserveDates = InputArgs.hasArg(STRIP_preserve_dates);
 749   Config.InputFormat = FileFormat::Unspecified;
 750   Config.OutputFormat = FileFormat::Unspecified;
 751
 752   DriverConfig DC;
 753   if (Positional.size() == 1) {
 754     Config.InputFilename = Positional[0];
 755     Config.OutputFilename =
 756         InputArgs.getLastArgValue(STRIP_output, Positional[0]);
 757     DC.CopyConfigs.push_back(std::move(Config));
 758   } else {
 759     StringMap<unsigned> InputFiles;
 760     for (StringRef Filename : Positional) {
 761       if (InputFiles[Filename]++ == 1) {
 762         if (Filename == "-")
 763           return createStringError(
 764               errc::invalid_argument,
 765               "cannot specify '-' as an input file more than once");
 766         if (Error E = ErrorCallback(createStringError(
 767                 errc::invalid_argument, "'%s' was already specified",
 768                 Filename.str().c_str())))
 769           return std::move(E);
 770       }
 771       Config.InputFilename = Filename;
 772       Config.OutputFilename = Filename;
 773       DC.CopyConfigs.push_back(Config);
 774     }
 775   }
 776
 777   if (Config.PreserveDates && (is_contained(Positional, "-") ||
 778                                InputArgs.getLastArgValue(STRIP_output) == "-"))
 779     return createStringError(errc::invalid_argument,
 780                              "--preserve-dates requires a file");
 781
 782   return std::move(DC);
 783 }
 784
 785 } // namespace objcopy
 786 } // namespace llvm