1 //===- llvm-objcopy.cpp ---------------------------------------------------===// 2 // 3 // The LLVM Compiler Infrastructure 4 // 5 // This file is distributed under the University of Illinois Open Source 6 // License. See LICENSE.TXT for details. 7 // 8 //===----------------------------------------------------------------------===// 9 10 #include "llvm-objcopy.h" 11 #include "Object.h" 12 #include "llvm/ADT/STLExtras.h" 13 #include "llvm/ADT/StringRef.h" 14 #include "llvm/ADT/Twine.h" 15 #include "llvm/BinaryFormat/ELF.h" 16 #include "llvm/Object/Binary.h" 17 #include "llvm/Object/ELFObjectFile.h" 18 #include "llvm/Object/ELFTypes.h" 19 #include "llvm/Object/Error.h" 20 #include "llvm/Option/Arg.h" 21 #include "llvm/Option/ArgList.h" 22 #include "llvm/Option/Option.h" 23 #include "llvm/Support/Casting.h" 24 #include "llvm/Support/CommandLine.h" 25 #include "llvm/Support/Compiler.h" 26 #include "llvm/Support/Error.h" 27 #include "llvm/Support/ErrorHandling.h" 28 #include "llvm/Support/ErrorOr.h" 29 #include "llvm/Support/FileOutputBuffer.h" 30 #include "llvm/Support/InitLLVM.h" 31 #include "llvm/Support/Path.h" 32 #include "llvm/Support/raw_ostream.h" 33 #include <algorithm> 34 #include <cassert> 35 #include <cstdlib> 36 #include <functional> 37 #include <iterator> 38 #include <memory> 39 #include <string> 40 #include <system_error> 41 #include <utility> 42 43 using namespace llvm; 44 using namespace object; 45 using namespace ELF; 46 47 namespace { 48 49 enum ObjcopyID { 50 OBJCOPY_INVALID = 0, // This is not an option ID. 51 #define OPTION(PREFIX, NAME, ID, KIND, GROUP, ALIAS, ALIASARGS, FLAGS, PARAM, \ 52 HELPTEXT, METAVAR, VALUES) \ 53 OBJCOPY_##ID, 54 #include "ObjcopyOpts.inc" 55 #undef OPTION 56 }; 57 58 #define PREFIX(NAME, VALUE) const char *const NAME[] = VALUE; 59 #include "ObjcopyOpts.inc" 60 #undef PREFIX 61 62 static const opt::OptTable::Info ObjcopyInfoTable[] = { 63 #define OPTION(PREFIX, NAME, ID, KIND, GROUP, ALIAS, ALIASARGS, FLAGS, PARAM, \ 64 HELPTEXT, METAVAR, VALUES) \ 65 {PREFIX, NAME, HELPTEXT, \ 66 METAVAR, OBJCOPY_##ID, opt::Option::KIND##Class, \ 67 PARAM, FLAGS, OBJCOPY_##GROUP, \ 68 OBJCOPY_##ALIAS, ALIASARGS, VALUES}, 69 #include "ObjcopyOpts.inc" 70 #undef OPTION 71 }; 72 73 class ObjcopyOptTable : public opt::OptTable { 74 public: 75 ObjcopyOptTable() : OptTable(ObjcopyInfoTable, true) {} 76 }; 77 78 enum StripID { 79 STRIP_INVALID = 0, // This is not an option ID. 80 #define OPTION(PREFIX, NAME, ID, KIND, GROUP, ALIAS, ALIASARGS, FLAGS, PARAM, \ 81 HELPTEXT, METAVAR, VALUES) \ 82 STRIP_##ID, 83 #include "StripOpts.inc" 84 #undef OPTION 85 }; 86 87 static const opt::OptTable::Info StripInfoTable[] = { 88 #define OPTION(PREFIX, NAME, ID, KIND, GROUP, ALIAS, ALIASARGS, FLAGS, PARAM, \ 89 HELPTEXT, METAVAR, VALUES) \ 90 {PREFIX, NAME, HELPTEXT, \ 91 METAVAR, STRIP_##ID, opt::Option::KIND##Class, \ 92 PARAM, FLAGS, STRIP_##GROUP, \ 93 STRIP_##ALIAS, ALIASARGS, VALUES}, 94 #include "StripOpts.inc" 95 #undef OPTION 96 }; 97 98 class StripOptTable : public opt::OptTable { 99 public: 100 StripOptTable() : OptTable(StripInfoTable, true) {} 101 }; 102 103 } // namespace 104 105 // The name this program was invoked as. 106 static StringRef ToolName; 107 108 namespace llvm { 109 110 LLVM_ATTRIBUTE_NORETURN void error(Twine Message) { 111 errs() << ToolName << ": " << Message << ".\n"; 112 errs().flush(); 113 exit(1); 114 } 115 116 LLVM_ATTRIBUTE_NORETURN void reportError(StringRef File, std::error_code EC) { 117 assert(EC); 118 errs() << ToolName << ": '" << File << "': " << EC.message() << ".\n"; 119 exit(1); 120 } 121 122 LLVM_ATTRIBUTE_NORETURN void reportError(StringRef File, Error E) { 123 assert(E); 124 std::string Buf; 125 raw_string_ostream OS(Buf); 126 logAllUnhandledErrors(std::move(E), OS, ""); 127 OS.flush(); 128 errs() << ToolName << ": '" << File << "': " << Buf; 129 exit(1); 130 } 131 132 } // end namespace llvm 133 134 struct CopyConfig { 135 StringRef OutputFilename; 136 StringRef InputFilename; 137 StringRef OutputFormat; 138 StringRef InputFormat; 139 StringRef BinaryArch; 140 141 StringRef SplitDWO; 142 StringRef AddGnuDebugLink; 143 std::vector<StringRef> ToRemove; 144 std::vector<StringRef> Keep; 145 std::vector<StringRef> OnlyKeep; 146 std::vector<StringRef> AddSection; 147 std::vector<StringRef> SymbolsToLocalize; 148 std::vector<StringRef> SymbolsToGlobalize; 149 std::vector<StringRef> SymbolsToWeaken; 150 std::vector<StringRef> SymbolsToRemove; 151 std::vector<StringRef> SymbolsToKeep; 152 StringMap<StringRef> SymbolsToRename; 153 bool StripAll = false; 154 bool StripAllGNU = false; 155 bool StripDebug = false; 156 bool StripSections = false; 157 bool StripNonAlloc = false; 158 bool StripDWO = false; 159 bool ExtractDWO = false; 160 bool LocalizeHidden = false; 161 bool Weaken = false; 162 bool DiscardAll = false; 163 bool OnlyKeepDebug = false; 164 }; 165 166 using SectionPred = std::function<bool(const SectionBase &Sec)>; 167 168 bool IsDWOSection(const SectionBase &Sec) { return Sec.Name.endswith(".dwo"); } 169 170 bool OnlyKeepDWOPred(const Object &Obj, const SectionBase &Sec) { 171 // We can't remove the section header string table. 172 if (&Sec == Obj.SectionNames) 173 return false; 174 // Short of keeping the string table we want to keep everything that is a DWO 175 // section and remove everything else. 176 return !IsDWOSection(Sec); 177 } 178 179 std::unique_ptr<Writer> CreateWriter(const CopyConfig &Config, Object &Obj, 180 StringRef File, ElfType OutputElfType) { 181 if (Config.OutputFormat == "binary") { 182 return llvm::make_unique<BinaryWriter>(File, Obj); 183 } 184 // Depending on the initial ELFT and OutputFormat we need a different Writer. 185 switch (OutputElfType) { 186 case ELFT_ELF32LE: 187 return llvm::make_unique<ELFWriter<ELF32LE>>(File, Obj, 188 !Config.StripSections); 189 case ELFT_ELF64LE: 190 return llvm::make_unique<ELFWriter<ELF64LE>>(File, Obj, 191 !Config.StripSections); 192 case ELFT_ELF32BE: 193 return llvm::make_unique<ELFWriter<ELF32BE>>(File, Obj, 194 !Config.StripSections); 195 case ELFT_ELF64BE: 196 return llvm::make_unique<ELFWriter<ELF64BE>>(File, Obj, 197 !Config.StripSections); 198 } 199 llvm_unreachable("Invalid output format"); 200 } 201 202 void SplitDWOToFile(const CopyConfig &Config, const Reader &Reader, 203 StringRef File, ElfType OutputElfType) { 204 auto DWOFile = Reader.create(); 205 DWOFile->removeSections( 206 [&](const SectionBase &Sec) { return OnlyKeepDWOPred(*DWOFile, Sec); }); 207 auto Writer = CreateWriter(Config, *DWOFile, File, OutputElfType); 208 Writer->finalize(); 209 Writer->write(); 210 } 211 212 // This function handles the high level operations of GNU objcopy including 213 // handling command line options. It's important to outline certain properties 214 // we expect to hold of the command line operations. Any operation that "keeps" 215 // should keep regardless of a remove. Additionally any removal should respect 216 // any previous removals. Lastly whether or not something is removed shouldn't 217 // depend a) on the order the options occur in or b) on some opaque priority 218 // system. The only priority is that keeps/copies overrule removes. 219 void HandleArgs(const CopyConfig &Config, Object &Obj, const Reader &Reader, 220 ElfType OutputElfType) { 221 222 if (!Config.SplitDWO.empty()) { 223 SplitDWOToFile(Config, Reader, Config.SplitDWO, OutputElfType); 224 } 225 226 // TODO: update or remove symbols only if there is an option that affects them. 227 if (Obj.SymbolTable) { 228 Obj.SymbolTable->updateSymbols([&](Symbol &Sym) { 229 if ((Config.LocalizeHidden && 230 (Sym.Visibility == STV_HIDDEN || Sym.Visibility == STV_INTERNAL)) || 231 (!Config.SymbolsToLocalize.empty() && 232 is_contained(Config.SymbolsToLocalize, Sym.Name))) 233 Sym.Binding = STB_LOCAL; 234 235 if (!Config.SymbolsToGlobalize.empty() && 236 is_contained(Config.SymbolsToGlobalize, Sym.Name)) 237 Sym.Binding = STB_GLOBAL; 238 239 if (!Config.SymbolsToWeaken.empty() && 240 is_contained(Config.SymbolsToWeaken, Sym.Name) && 241 Sym.Binding == STB_GLOBAL) 242 Sym.Binding = STB_WEAK; 243 244 if (Config.Weaken && Sym.Binding == STB_GLOBAL && 245 Sym.getShndx() != SHN_UNDEF) 246 Sym.Binding = STB_WEAK; 247 248 const auto I = Config.SymbolsToRename.find(Sym.Name); 249 if (I != Config.SymbolsToRename.end()) 250 Sym.Name = I->getValue(); 251 }); 252 253 Obj.removeSymbols([&](const Symbol &Sym) { 254 if (!Config.SymbolsToKeep.empty() && 255 is_contained(Config.SymbolsToKeep, Sym.Name)) 256 return false; 257 258 if (Config.DiscardAll && Sym.Binding == STB_LOCAL && 259 Sym.getShndx() != SHN_UNDEF && Sym.Type != STT_FILE && 260 Sym.Type != STT_SECTION) 261 return true; 262 263 if (Config.StripAll || Config.StripAllGNU) 264 return true; 265 266 if (!Config.SymbolsToRemove.empty() && 267 is_contained(Config.SymbolsToRemove, Sym.Name)) { 268 return true; 269 } 270 271 return false; 272 }); 273 } 274 275 SectionPred RemovePred = [](const SectionBase &) { return false; }; 276 277 // Removes: 278 if (!Config.ToRemove.empty()) { 279 RemovePred = [&Config](const SectionBase &Sec) { 280 return std::find(std::begin(Config.ToRemove), std::end(Config.ToRemove), 281 Sec.Name) != std::end(Config.ToRemove); 282 }; 283 } 284 285 if (Config.StripDWO || !Config.SplitDWO.empty()) 286 RemovePred = [RemovePred](const SectionBase &Sec) { 287 return IsDWOSection(Sec) || RemovePred(Sec); 288 }; 289 290 if (Config.ExtractDWO) 291 RemovePred = [RemovePred, &Obj](const SectionBase &Sec) { 292 return OnlyKeepDWOPred(Obj, Sec) || RemovePred(Sec); 293 }; 294 295 if (Config.StripAllGNU) 296 RemovePred = [RemovePred, &Obj](const SectionBase &Sec) { 297 if (RemovePred(Sec)) 298 return true; 299 if ((Sec.Flags & SHF_ALLOC) != 0) 300 return false; 301 if (&Sec == Obj.SectionNames) 302 return false; 303 switch (Sec.Type) { 304 case SHT_SYMTAB: 305 case SHT_REL: 306 case SHT_RELA: 307 case SHT_STRTAB: 308 return true; 309 } 310 return Sec.Name.startswith(".debug"); 311 }; 312 313 if (Config.StripSections) { 314 RemovePred = [RemovePred](const SectionBase &Sec) { 315 return RemovePred(Sec) || (Sec.Flags & SHF_ALLOC) == 0; 316 }; 317 } 318 319 if (Config.StripDebug) { 320 RemovePred = [RemovePred](const SectionBase &Sec) { 321 return RemovePred(Sec) || Sec.Name.startswith(".debug"); 322 }; 323 } 324 325 if (Config.StripNonAlloc) 326 RemovePred = [RemovePred, &Obj](const SectionBase &Sec) { 327 if (RemovePred(Sec)) 328 return true; 329 if (&Sec == Obj.SectionNames) 330 return false; 331 return (Sec.Flags & SHF_ALLOC) == 0; 332 }; 333 334 if (Config.StripAll) 335 RemovePred = [RemovePred, &Obj](const SectionBase &Sec) { 336 if (RemovePred(Sec)) 337 return true; 338 if (&Sec == Obj.SectionNames) 339 return false; 340 if (Sec.Name.startswith(".gnu.warning")) 341 return false; 342 return (Sec.Flags & SHF_ALLOC) == 0; 343 }; 344 345 // Explicit copies: 346 if (!Config.OnlyKeep.empty()) { 347 RemovePred = [&Config, RemovePred, &Obj](const SectionBase &Sec) { 348 // Explicitly keep these sections regardless of previous removes. 349 if (std::find(std::begin(Config.OnlyKeep), std::end(Config.OnlyKeep), 350 Sec.Name) != std::end(Config.OnlyKeep)) 351 return false; 352 353 // Allow all implicit removes. 354 if (RemovePred(Sec)) 355 return true; 356 357 // Keep special sections. 358 if (Obj.SectionNames == &Sec) 359 return false; 360 if (Obj.SymbolTable == &Sec || Obj.SymbolTable->getStrTab() == &Sec) 361 return false; 362 363 // Remove everything else. 364 return true; 365 }; 366 } 367 368 if (!Config.Keep.empty()) { 369 RemovePred = [Config, RemovePred](const SectionBase &Sec) { 370 // Explicitly keep these sections regardless of previous removes. 371 if (std::find(std::begin(Config.Keep), std::end(Config.Keep), Sec.Name) != 372 std::end(Config.Keep)) 373 return false; 374 // Otherwise defer to RemovePred. 375 return RemovePred(Sec); 376 }; 377 } 378 379 // This has to be the last predicate assignment. 380 // If the option --keep-symbol has been specified 381 // and at least one of those symbols is present 382 // (equivalently, the updated symbol table is not empty) 383 // the symbol table and the string table should not be removed. 384 if (!Config.SymbolsToKeep.empty() && !Obj.SymbolTable->empty()) { 385 RemovePred = [&Obj, RemovePred](const SectionBase &Sec) { 386 if (&Sec == Obj.SymbolTable || &Sec == Obj.SymbolTable->getStrTab()) 387 return false; 388 return RemovePred(Sec); 389 }; 390 } 391 392 Obj.removeSections(RemovePred); 393 394 if (!Config.AddSection.empty()) { 395 for (const auto &Flag : Config.AddSection) { 396 auto SecPair = Flag.split("="); 397 auto SecName = SecPair.first; 398 auto File = SecPair.second; 399 auto BufOrErr = MemoryBuffer::getFile(File); 400 if (!BufOrErr) 401 reportError(File, BufOrErr.getError()); 402 auto Buf = std::move(*BufOrErr); 403 auto BufPtr = reinterpret_cast<const uint8_t *>(Buf->getBufferStart()); 404 auto BufSize = Buf->getBufferSize(); 405 Obj.addSection<OwnedDataSection>(SecName, 406 ArrayRef<uint8_t>(BufPtr, BufSize)); 407 } 408 } 409 410 if (!Config.AddGnuDebugLink.empty()) 411 Obj.addSection<GnuDebugLinkSection>(Config.AddGnuDebugLink); 412 } 413 414 std::unique_ptr<Reader> CreateReader(StringRef InputFilename, 415 ElfType &OutputElfType) { 416 // Right now we can only read ELF files so there's only one reader; 417 auto Out = llvm::make_unique<ELFReader>(InputFilename); 418 // We need to set the default ElfType for output. 419 OutputElfType = Out->getElfType(); 420 return std::move(Out); 421 } 422 423 void ExecuteElfObjcopy(const CopyConfig &Config) { 424 ElfType OutputElfType; 425 auto Reader = CreateReader(Config.InputFilename, OutputElfType); 426 auto Obj = Reader->create(); 427 auto Writer = 428 CreateWriter(Config, *Obj, Config.OutputFilename, OutputElfType); 429 HandleArgs(Config, *Obj, *Reader, OutputElfType); 430 Writer->finalize(); 431 Writer->write(); 432 } 433 434 // ParseObjcopyOptions returns the config and sets the input arguments. If a 435 // help flag is set then ParseObjcopyOptions will print the help messege and 436 // exit. 437 CopyConfig ParseObjcopyOptions(ArrayRef<const char *> ArgsArr) { 438 ObjcopyOptTable T; 439 unsigned MissingArgumentIndex, MissingArgumentCount; 440 llvm::opt::InputArgList InputArgs = 441 T.ParseArgs(ArgsArr, MissingArgumentIndex, MissingArgumentCount); 442 443 if (InputArgs.size() == 0) { 444 T.PrintHelp(errs(), "llvm-objcopy <input> [ <output> ]", "objcopy tool"); 445 exit(1); 446 } 447 448 if (InputArgs.hasArg(OBJCOPY_help)) { 449 T.PrintHelp(outs(), "llvm-objcopy <input> [ <output> ]", "objcopy tool"); 450 exit(0); 451 } 452 453 SmallVector<const char *, 2> Positional; 454 455 for (auto Arg : InputArgs.filtered(OBJCOPY_UNKNOWN)) 456 error("unknown argument '" + Arg->getAsString(InputArgs) + "'"); 457 458 for (auto Arg : InputArgs.filtered(OBJCOPY_INPUT)) 459 Positional.push_back(Arg->getValue()); 460 461 if (Positional.empty()) 462 error("No input file specified"); 463 464 if (Positional.size() > 2) 465 error("Too many positional arguments"); 466 467 CopyConfig Config; 468 Config.InputFilename = Positional[0]; 469 Config.OutputFilename = Positional[Positional.size() == 1 ? 0 : 1]; 470 Config.InputFormat = InputArgs.getLastArgValue(OBJCOPY_input_target); 471 Config.OutputFormat = InputArgs.getLastArgValue(OBJCOPY_output_target); 472 Config.BinaryArch = InputArgs.getLastArgValue(OBJCOPY_binary_architecture); 473 474 Config.SplitDWO = InputArgs.getLastArgValue(OBJCOPY_split_dwo); 475 Config.AddGnuDebugLink = InputArgs.getLastArgValue(OBJCOPY_add_gnu_debuglink); 476 477 for (auto Arg : InputArgs.filtered(OBJCOPY_redefine_symbol)) { 478 if (!StringRef(Arg->getValue()).contains('=')) 479 error("Bad format for --redefine-sym"); 480 auto Old2New = StringRef(Arg->getValue()).split('='); 481 if (!Config.SymbolsToRename.insert(Old2New).second) 482 error("Multiple redefinition of symbol " + Old2New.first); 483 } 484 485 for (auto Arg : InputArgs.filtered(OBJCOPY_remove_section)) 486 Config.ToRemove.push_back(Arg->getValue()); 487 for (auto Arg : InputArgs.filtered(OBJCOPY_keep)) 488 Config.Keep.push_back(Arg->getValue()); 489 for (auto Arg : InputArgs.filtered(OBJCOPY_only_keep)) 490 Config.OnlyKeep.push_back(Arg->getValue()); 491 for (auto Arg : InputArgs.filtered(OBJCOPY_add_section)) 492 Config.AddSection.push_back(Arg->getValue()); 493 Config.StripAll = InputArgs.hasArg(OBJCOPY_strip_all); 494 Config.StripAllGNU = InputArgs.hasArg(OBJCOPY_strip_all_gnu); 495 Config.StripDebug = InputArgs.hasArg(OBJCOPY_strip_debug); 496 Config.StripDWO = InputArgs.hasArg(OBJCOPY_strip_dwo); 497 Config.StripSections = InputArgs.hasArg(OBJCOPY_strip_sections); 498 Config.StripNonAlloc = InputArgs.hasArg(OBJCOPY_strip_non_alloc); 499 Config.ExtractDWO = InputArgs.hasArg(OBJCOPY_extract_dwo); 500 Config.LocalizeHidden = InputArgs.hasArg(OBJCOPY_localize_hidden); 501 Config.Weaken = InputArgs.hasArg(OBJCOPY_weaken); 502 Config.DiscardAll = InputArgs.hasArg(OBJCOPY_discard_all); 503 Config.OnlyKeepDebug = InputArgs.hasArg(OBJCOPY_only_keep_debug); 504 for (auto Arg : InputArgs.filtered(OBJCOPY_localize_symbol)) 505 Config.SymbolsToLocalize.push_back(Arg->getValue()); 506 for (auto Arg : InputArgs.filtered(OBJCOPY_globalize_symbol)) 507 Config.SymbolsToGlobalize.push_back(Arg->getValue()); 508 for (auto Arg : InputArgs.filtered(OBJCOPY_weaken_symbol)) 509 Config.SymbolsToWeaken.push_back(Arg->getValue()); 510 for (auto Arg : InputArgs.filtered(OBJCOPY_strip_symbol)) 511 Config.SymbolsToRemove.push_back(Arg->getValue()); 512 for (auto Arg : InputArgs.filtered(OBJCOPY_keep_symbol)) 513 Config.SymbolsToKeep.push_back(Arg->getValue()); 514 515 return Config; 516 } 517 518 // ParseStripOptions returns the config and sets the input arguments. If a 519 // help flag is set then ParseStripOptions will print the help messege and 520 // exit. 521 CopyConfig ParseStripOptions(ArrayRef<const char *> ArgsArr) { 522 StripOptTable T; 523 unsigned MissingArgumentIndex, MissingArgumentCount; 524 llvm::opt::InputArgList InputArgs = 525 T.ParseArgs(ArgsArr, MissingArgumentIndex, MissingArgumentCount); 526 527 if (InputArgs.size() == 0) { 528 T.PrintHelp(errs(), "llvm-strip <input> [ <output> ]", "strip tool"); 529 exit(1); 530 } 531 532 if (InputArgs.hasArg(STRIP_help)) { 533 T.PrintHelp(outs(), "llvm-strip <input> [ <output> ]", "strip tool"); 534 exit(0); 535 } 536 537 SmallVector<const char *, 2> Positional; 538 for (auto Arg : InputArgs.filtered(STRIP_UNKNOWN)) 539 error("unknown argument '" + Arg->getAsString(InputArgs) + "'"); 540 for (auto Arg : InputArgs.filtered(STRIP_INPUT)) 541 Positional.push_back(Arg->getValue()); 542 543 if (Positional.empty()) 544 error("No input file specified"); 545 546 if (Positional.size() > 2) 547 error("Support for multiple input files is not implemented yet"); 548 549 CopyConfig Config; 550 Config.InputFilename = Positional[0]; 551 Config.OutputFilename = Positional[0]; 552 553 // Strip debug info only. 554 Config.StripDebug = InputArgs.hasArg(STRIP_strip_debug); 555 if (!Config.StripDebug) 556 Config.StripAll = true; 557 558 for (auto Arg : InputArgs.filtered(STRIP_remove_section)) 559 Config.ToRemove.push_back(Arg->getValue()); 560 561 for (auto Arg : InputArgs.filtered(STRIP_keep_symbol)) 562 Config.SymbolsToKeep.push_back(Arg->getValue()); 563 564 return Config; 565 } 566 567 int main(int argc, char **argv) { 568 InitLLVM X(argc, argv); 569 ToolName = argv[0]; 570 CopyConfig Config; 571 if (sys::path::stem(ToolName).endswith_lower("strip")) 572 Config = ParseStripOptions(makeArrayRef(argv + 1, argc)); 573 else 574 Config = ParseObjcopyOptions(makeArrayRef(argv + 1, argc)); 575 ExecuteElfObjcopy(Config); 576 } 577