tools/llvm-ar/llvm-ar.cpp

   1 //===-- llvm-ar.cpp - LLVM archive librarian utility ----------------------===//
   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 // Builds up (relatively) standard unix archive files (.a) containing LLVM
  11 // bitcode or other files.
  12 //
  13 //===----------------------------------------------------------------------===//
  14
  15 #include "llvm/ADT/StringSwitch.h"
  16 #include "llvm/IR/LLVMContext.h"
  17 #include "llvm/IR/Module.h"
  18 #include "llvm/Object/Archive.h"
  19 #include "llvm/Object/ObjectFile.h"
  20 #include "llvm/Support/CommandLine.h"
  21 #include "llvm/Support/Errc.h"
  22 #include "llvm/Support/FileSystem.h"
  23 #include "llvm/Support/Format.h"
  24 #include "llvm/Support/LineIterator.h"
  25 #include "llvm/Support/ManagedStatic.h"
  26 #include "llvm/Support/MemoryBuffer.h"
  27 #include "llvm/Support/PrettyStackTrace.h"
  28 #include "llvm/Support/Signals.h"
  29 #include "llvm/Support/TargetSelect.h"
  30 #include "llvm/Support/ToolOutputFile.h"
  31 #include "llvm/Support/raw_ostream.h"
  32 #include <algorithm>
  33 #include <cstdlib>
  34 #include <memory>
  35
  36 #if !defined(_MSC_VER) && !defined(__MINGW32__)
  37 #include <unistd.h>
  38 #else
  39 #include <io.h>
  40 #endif
  41
  42 using namespace llvm;
  43
  44 // The name this program was invoked as.
  45 static StringRef ToolName;
  46
  47 static const char *TemporaryOutput;
  48 static int TmpArchiveFD = -1;
  49
  50 // Show the error message and exit.
  51 LLVM_ATTRIBUTE_NORETURN static void fail(Twine Error) {
  52   outs() << ToolName << ": " << Error << ".\n";
  53   if (TmpArchiveFD != -1)
  54     close(TmpArchiveFD);
  55   if (TemporaryOutput)
  56     sys::fs::remove(TemporaryOutput);
  57   exit(1);
  58 }
  59
  60 static void failIfError(std::error_code EC, Twine Context = "") {
  61   if (!EC)
  62     return;
  63
  64   std::string ContextStr = Context.str();
  65   if (ContextStr == "")
  66     fail(EC.message());
  67   fail(Context + ": " + EC.message());
  68 }
  69
  70 // llvm-ar/llvm-ranlib remaining positional arguments.
  71 static cl::list<std::string>
  72     RestOfArgs(cl::Positional, cl::ZeroOrMore,
  73                cl::desc("[relpos] [count] <archive-file> [members]..."));
  74
  75 static cl::opt<bool> MRI("M", cl::desc(""));
  76
  77 std::string Options;
  78
  79 // Provide additional help output explaining the operations and modifiers of
  80 // llvm-ar. This object instructs the CommandLine library to print the text of
  81 // the constructor when the --help option is given.
  82 static cl::extrahelp MoreHelp(
  83   "\nOPERATIONS:\n"
  84   "  d[NsS]       - delete file(s) from the archive\n"
  85   "  m[abiSs]     - move file(s) in the archive\n"
  86   "  p[kN]        - print file(s) found in the archive\n"
  87   "  q[ufsS]      - quick append file(s) to the archive\n"
  88   "  r[abfiuRsS]  - replace or insert file(s) into the archive\n"
  89   "  t            - display contents of archive\n"
  90   "  x[No]        - extract file(s) from the archive\n"
  91   "\nMODIFIERS (operation specific):\n"
  92   "  [a] - put file(s) after [relpos]\n"
  93   "  [b] - put file(s) before [relpos] (same as [i])\n"
  94   "  [i] - put file(s) before [relpos] (same as [b])\n"
  95   "  [o] - preserve original dates\n"
  96   "  [s] - create an archive index (cf. ranlib)\n"
  97   "  [S] - do not build a symbol table\n"
  98   "  [u] - update only files newer than archive contents\n"
  99   "\nMODIFIERS (generic):\n"
 100   "  [c] - do not warn if the library had to be created\n"
 101   "  [v] - be verbose about actions taken\n"
 102 );
 103
 104 // This enumeration delineates the kinds of operations on an archive
 105 // that are permitted.
 106 enum ArchiveOperation {
 107   Print,            ///< Print the contents of the archive
 108   Delete,           ///< Delete the specified members
 109   Move,             ///< Move members to end or as given by {a,b,i} modifiers
 110   QuickAppend,      ///< Quickly append to end of archive
 111   ReplaceOrInsert,  ///< Replace or Insert members
 112   DisplayTable,     ///< Display the table of contents
 113   Extract,          ///< Extract files back to file system
 114   CreateSymTab      ///< Create a symbol table in an existing archive
 115 };
 116
 117 // Modifiers to follow operation to vary behavior
 118 static bool AddAfter = false;      ///< 'a' modifier
 119 static bool AddBefore = false;     ///< 'b' modifier
 120 static bool Create = false;        ///< 'c' modifier
 121 static bool OriginalDates = false; ///< 'o' modifier
 122 static bool OnlyUpdate = false;    ///< 'u' modifier
 123 static bool Verbose = false;       ///< 'v' modifier
 124 static bool Symtab = true;         ///< 's' modifier
 125
 126 // Relative Positional Argument (for insert/move). This variable holds
 127 // the name of the archive member to which the 'a', 'b' or 'i' modifier
 128 // refers. Only one of 'a', 'b' or 'i' can be specified so we only need
 129 // one variable.
 130 static std::string RelPos;
 131
 132 // This variable holds the name of the archive file as given on the
 133 // command line.
 134 static std::string ArchiveName;
 135
 136 // This variable holds the list of member files to proecess, as given
 137 // on the command line.
 138 static std::vector<StringRef> Members;
 139
 140 // Show the error message, the help message and exit.
 141 LLVM_ATTRIBUTE_NORETURN static void
 142 show_help(const std::string &msg) {
 143   errs() << ToolName << ": " << msg << "\n\n";
 144   cl::PrintHelpMessage();
 145   std::exit(1);
 146 }
 147
 148 // Extract the member filename from the command line for the [relpos] argument
 149 // associated with a, b, and i modifiers
 150 static void getRelPos() {
 151   if(RestOfArgs.size() == 0)
 152     show_help("Expected [relpos] for a, b, or i modifier");
 153   RelPos = RestOfArgs[0];
 154   RestOfArgs.erase(RestOfArgs.begin());
 155 }
 156
 157 static void getOptions() {
 158   if(RestOfArgs.size() == 0)
 159     show_help("Expected options");
 160   Options = RestOfArgs[0];
 161   RestOfArgs.erase(RestOfArgs.begin());
 162 }
 163
 164 // Get the archive file name from the command line
 165 static void getArchive() {
 166   if(RestOfArgs.size() == 0)
 167     show_help("An archive name must be specified");
 168   ArchiveName = RestOfArgs[0];
 169   RestOfArgs.erase(RestOfArgs.begin());
 170 }
 171
 172 // Copy over remaining items in RestOfArgs to our Members vector
 173 static void getMembers() {
 174   for (auto &Arg : RestOfArgs)
 175     Members.push_back(Arg);
 176 }
 177
 178 static void runMRIScript();
 179
 180 // Parse the command line options as presented and return the operation
 181 // specified. Process all modifiers and check to make sure that constraints on
 182 // modifier/operation pairs have not been violated.
 183 static ArchiveOperation parseCommandLine() {
 184   if (MRI) {
 185     if (!RestOfArgs.empty())
 186       fail("Cannot mix -M and other options");
 187     runMRIScript();
 188   }
 189
 190   getOptions();
 191
 192   // Keep track of number of operations. We can only specify one
 193   // per execution.
 194   unsigned NumOperations = 0;
 195
 196   // Keep track of the number of positional modifiers (a,b,i). Only
 197   // one can be specified.
 198   unsigned NumPositional = 0;
 199
 200   // Keep track of which operation was requested
 201   ArchiveOperation Operation;
 202
 203   bool MaybeJustCreateSymTab = false;
 204
 205   for(unsigned i=0; i<Options.size(); ++i) {
 206     switch(Options[i]) {
 207     case 'd': ++NumOperations; Operation = Delete; break;
 208     case 'm': ++NumOperations; Operation = Move ; break;
 209     case 'p': ++NumOperations; Operation = Print; break;
 210     case 'q': ++NumOperations; Operation = QuickAppend; break;
 211     case 'r': ++NumOperations; Operation = ReplaceOrInsert; break;
 212     case 't': ++NumOperations; Operation = DisplayTable; break;
 213     case 'x': ++NumOperations; Operation = Extract; break;
 214     case 'c': Create = true; break;
 215     case 'l': /* accepted but unused */ break;
 216     case 'o': OriginalDates = true; break;
 217     case 's':
 218       Symtab = true;
 219       MaybeJustCreateSymTab = true;
 220       break;
 221     case 'S':
 222       Symtab = false;
 223       break;
 224     case 'u': OnlyUpdate = true; break;
 225     case 'v': Verbose = true; break;
 226     case 'a':
 227       getRelPos();
 228       AddAfter = true;
 229       NumPositional++;
 230       break;
 231     case 'b':
 232       getRelPos();
 233       AddBefore = true;
 234       NumPositional++;
 235       break;
 236     case 'i':
 237       getRelPos();
 238       AddBefore = true;
 239       NumPositional++;
 240       break;
 241     default:
 242       cl::PrintHelpMessage();
 243     }
 244   }
 245
 246   // At this point, the next thing on the command line must be
 247   // the archive name.
 248   getArchive();
 249
 250   // Everything on the command line at this point is a member.
 251   getMembers();
 252
 253  if (NumOperations == 0 && MaybeJustCreateSymTab) {
 254     NumOperations = 1;
 255     Operation = CreateSymTab;
 256     if (!Members.empty())
 257       show_help("The s operation takes only an archive as argument");
 258   }
 259
 260   // Perform various checks on the operation/modifier specification
 261   // to make sure we are dealing with a legal request.
 262   if (NumOperations == 0)
 263     show_help("You must specify at least one of the operations");
 264   if (NumOperations > 1)
 265     show_help("Only one operation may be specified");
 266   if (NumPositional > 1)
 267     show_help("You may only specify one of a, b, and i modifiers");
 268   if (AddAfter || AddBefore) {
 269     if (Operation != Move && Operation != ReplaceOrInsert)
 270       show_help("The 'a', 'b' and 'i' modifiers can only be specified with "
 271             "the 'm' or 'r' operations");
 272   }
 273   if (OriginalDates && Operation != Extract)
 274     show_help("The 'o' modifier is only applicable to the 'x' operation");
 275   if (OnlyUpdate && Operation != ReplaceOrInsert)
 276     show_help("The 'u' modifier is only applicable to the 'r' operation");
 277
 278   // Return the parsed operation to the caller
 279   return Operation;
 280 }
 281
 282 // Implements the 'p' operation. This function traverses the archive
 283 // looking for members that match the path list.
 284 static void doPrint(StringRef Name, object::Archive::child_iterator I) {
 285   if (Verbose)
 286     outs() << "Printing " << Name << "\n";
 287
 288   StringRef Data = I->getBuffer();
 289   outs().write(Data.data(), Data.size());
 290 }
 291
 292 // Utility function for printing out the file mode when the 't' operation is in
 293 // verbose mode.
 294 static void printMode(unsigned mode) {
 295   if (mode & 004)
 296     outs() << "r";
 297   else
 298     outs() << "-";
 299   if (mode & 002)
 300     outs() << "w";
 301   else
 302     outs() << "-";
 303   if (mode & 001)
 304     outs() << "x";
 305   else
 306     outs() << "-";
 307 }
 308
 309 // Implement the 't' operation. This function prints out just
 310 // the file names of each of the members. However, if verbose mode is requested
 311 // ('v' modifier) then the file type, permission mode, user, group, size, and
 312 // modification time are also printed.
 313 static void doDisplayTable(StringRef Name, object::Archive::child_iterator I) {
 314   if (Verbose) {
 315     sys::fs::perms Mode = I->getAccessMode();
 316     printMode((Mode >> 6) & 007);
 317     printMode((Mode >> 3) & 007);
 318     printMode(Mode & 007);
 319     outs() << ' ' << I->getUID();
 320     outs() << '/' << I->getGID();
 321     outs() << ' ' << format("%6llu", I->getSize());
 322     outs() << ' ' << I->getLastModified().str();
 323     outs() << ' ';
 324   }
 325   outs() << Name << "\n";
 326 }
 327
 328 // Implement the 'x' operation. This function extracts files back to the file
 329 // system.
 330 static void doExtract(StringRef Name, object::Archive::child_iterator I) {
 331   // Retain the original mode.
 332   sys::fs::perms Mode = I->getAccessMode();
 333   SmallString<128> Storage = Name;
 334
 335   int FD;
 336   failIfError(
 337       sys::fs::openFileForWrite(Storage.c_str(), FD, sys::fs::F_None, Mode),
 338       Storage.c_str());
 339
 340   {
 341     raw_fd_ostream file(FD, false);
 342
 343     // Get the data and its length
 344     StringRef Data = I->getBuffer();
 345
 346     // Write the data.
 347     file.write(Data.data(), Data.size());
 348   }
 349
 350   // If we're supposed to retain the original modification times, etc. do so
 351   // now.
 352   if (OriginalDates)
 353     failIfError(
 354         sys::fs::setLastModificationAndAccessTime(FD, I->getLastModified()));
 355
 356   if (close(FD))
 357     fail("Could not close the file");
 358 }
 359
 360 static bool shouldCreateArchive(ArchiveOperation Op) {
 361   switch (Op) {
 362   case Print:
 363   case Delete:
 364   case Move:
 365   case DisplayTable:
 366   case Extract:
 367   case CreateSymTab:
 368     return false;
 369
 370   case QuickAppend:
 371   case ReplaceOrInsert:
 372     return true;
 373   }
 374
 375   llvm_unreachable("Missing entry in covered switch.");
 376 }
 377
 378 static void performReadOperation(ArchiveOperation Operation,
 379                                  object::Archive *OldArchive) {
 380   for (object::Archive::child_iterator I = OldArchive->child_begin(),
 381                                        E = OldArchive->child_end();
 382        I != E; ++I) {
 383     ErrorOr<StringRef> NameOrErr = I->getName();
 384     failIfError(NameOrErr.getError());
 385     StringRef Name = NameOrErr.get();
 386
 387     if (!Members.empty() &&
 388         std::find(Members.begin(), Members.end(), Name) == Members.end())
 389       continue;
 390
 391     switch (Operation) {
 392     default:
 393       llvm_unreachable("Not a read operation");
 394     case Print:
 395       doPrint(Name, I);
 396       break;
 397     case DisplayTable:
 398       doDisplayTable(Name, I);
 399       break;
 400     case Extract:
 401       doExtract(Name, I);
 402       break;
 403     }
 404   }
 405 }
 406
 407 namespace {
 408 class NewArchiveIterator {
 409   bool IsNewMember;
 410   StringRef Name;
 411
 412   object::Archive::child_iterator OldI;
 413
 414   StringRef NewFilename;
 415
 416 public:
 417   NewArchiveIterator(object::Archive::child_iterator I, StringRef Name);
 418   NewArchiveIterator(StringRef I, StringRef Name);
 419   NewArchiveIterator();
 420   bool isNewMember() const;
 421   StringRef getName() const;
 422
 423   object::Archive::child_iterator getOld() const;
 424
 425   StringRef getNew() const;
 426   int getFD(sys::fs::file_status &NewStatus) const;
 427   const sys::fs::file_status &getStatus() const;
 428 };
 429 }
 430
 431 NewArchiveIterator::NewArchiveIterator() {}
 432
 433 NewArchiveIterator::NewArchiveIterator(object::Archive::child_iterator I,
 434                                        StringRef Name)
 435     : IsNewMember(false), Name(Name), OldI(I) {}
 436
 437 NewArchiveIterator::NewArchiveIterator(StringRef NewFilename, StringRef Name)
 438     : IsNewMember(true), Name(Name), NewFilename(NewFilename) {}
 439
 440 StringRef NewArchiveIterator::getName() const { return Name; }
 441
 442 bool NewArchiveIterator::isNewMember() const { return IsNewMember; }
 443
 444 object::Archive::child_iterator NewArchiveIterator::getOld() const {
 445   assert(!IsNewMember);
 446   return OldI;
 447 }
 448
 449 StringRef NewArchiveIterator::getNew() const {
 450   assert(IsNewMember);
 451   return NewFilename;
 452 }
 453
 454 int NewArchiveIterator::getFD(sys::fs::file_status &NewStatus) const {
 455   assert(IsNewMember);
 456   int NewFD;
 457   failIfError(sys::fs::openFileForRead(NewFilename, NewFD), NewFilename);
 458   assert(NewFD != -1);
 459
 460   failIfError(sys::fs::status(NewFD, NewStatus), NewFilename);
 461
 462   // Opening a directory doesn't make sense. Let it fail.
 463   // Linux cannot open directories with open(2), although
 464   // cygwin and *bsd can.
 465   if (NewStatus.type() == sys::fs::file_type::directory_file)
 466     failIfError(make_error_code(errc::is_a_directory), NewFilename);
 467
 468   return NewFD;
 469 }
 470
 471 template <typename T>
 472 void addMember(std::vector<NewArchiveIterator> &Members, T I, StringRef Name,
 473                int Pos = -1) {
 474   NewArchiveIterator NI(I, Name);
 475   if (Pos == -1)
 476     Members.push_back(NI);
 477   else
 478     Members[Pos] = NI;
 479 }
 480
 481 enum InsertAction {
 482   IA_AddOldMember,
 483   IA_AddNewMeber,
 484   IA_Delete,
 485   IA_MoveOldMember,
 486   IA_MoveNewMember
 487 };
 488
 489 static InsertAction computeInsertAction(ArchiveOperation Operation,
 490                                         object::Archive::child_iterator I,
 491                                         StringRef Name,
 492                                         std::vector<StringRef>::iterator &Pos) {
 493   if (Operation == QuickAppend || Members.empty())
 494     return IA_AddOldMember;
 495
 496   auto MI =
 497       std::find_if(Members.begin(), Members.end(), [Name](StringRef Path) {
 498         return Name == sys::path::filename(Path);
 499       });
 500
 501   if (MI == Members.end())
 502     return IA_AddOldMember;
 503
 504   Pos = MI;
 505
 506   if (Operation == Delete)
 507     return IA_Delete;
 508
 509   if (Operation == Move)
 510     return IA_MoveOldMember;
 511
 512   if (Operation == ReplaceOrInsert) {
 513     StringRef PosName = sys::path::filename(RelPos);
 514     if (!OnlyUpdate) {
 515       if (PosName.empty())
 516         return IA_AddNewMeber;
 517       return IA_MoveNewMember;
 518     }
 519
 520     // We could try to optimize this to a fstat, but it is not a common
 521     // operation.
 522     sys::fs::file_status Status;
 523     failIfError(sys::fs::status(*MI, Status), *MI);
 524     if (Status.getLastModificationTime() < I->getLastModified()) {
 525       if (PosName.empty())
 526         return IA_AddOldMember;
 527       return IA_MoveOldMember;
 528     }
 529
 530     if (PosName.empty())
 531       return IA_AddNewMeber;
 532     return IA_MoveNewMember;
 533   }
 534   llvm_unreachable("No such operation");
 535 }
 536
 537 // We have to walk this twice and computing it is not trivial, so creating an
 538 // explicit std::vector is actually fairly efficient.
 539 static std::vector<NewArchiveIterator>
 540 computeNewArchiveMembers(ArchiveOperation Operation,
 541                          object::Archive *OldArchive) {
 542   std::vector<NewArchiveIterator> Ret;
 543   std::vector<NewArchiveIterator> Moved;
 544   int InsertPos = -1;
 545   StringRef PosName = sys::path::filename(RelPos);
 546   if (OldArchive) {
 547     for (auto &Child : OldArchive->children()) {
 548       int Pos = Ret.size();
 549       ErrorOr<StringRef> NameOrErr = Child.getName();
 550       failIfError(NameOrErr.getError());
 551       StringRef Name = NameOrErr.get();
 552       if (Name == PosName) {
 553         assert(AddAfter || AddBefore);
 554         if (AddBefore)
 555           InsertPos = Pos;
 556         else
 557           InsertPos = Pos + 1;
 558       }
 559
 560       std::vector<StringRef>::iterator MemberI = Members.end();
 561       InsertAction Action =
 562           computeInsertAction(Operation, Child, Name, MemberI);
 563       switch (Action) {
 564       case IA_AddOldMember:
 565         addMember(Ret, Child, Name);
 566         break;
 567       case IA_AddNewMeber:
 568         addMember(Ret, *MemberI, Name);
 569         break;
 570       case IA_Delete:
 571         break;
 572       case IA_MoveOldMember:
 573         addMember(Moved, Child, Name);
 574         break;
 575       case IA_MoveNewMember:
 576         addMember(Moved, *MemberI, Name);
 577         break;
 578       }
 579       if (MemberI != Members.end())
 580         Members.erase(MemberI);
 581     }
 582   }
 583
 584   if (Operation == Delete)
 585     return Ret;
 586
 587   if (!RelPos.empty() && InsertPos == -1)
 588     fail("Insertion point not found");
 589
 590   if (RelPos.empty())
 591     InsertPos = Ret.size();
 592
 593   assert(unsigned(InsertPos) <= Ret.size());
 594   Ret.insert(Ret.begin() + InsertPos, Moved.begin(), Moved.end());
 595
 596   Ret.insert(Ret.begin() + InsertPos, Members.size(), NewArchiveIterator());
 597   int Pos = InsertPos;
 598   for (auto &Member : Members) {
 599     StringRef Name = sys::path::filename(Member);
 600     addMember(Ret, Member, Name, Pos);
 601     ++Pos;
 602   }
 603
 604   return Ret;
 605 }
 606
 607 template <typename T>
 608 static void printWithSpacePadding(raw_fd_ostream &OS, T Data, unsigned Size,
 609                                   bool MayTruncate = false) {
 610   uint64_t OldPos = OS.tell();
 611   OS << Data;
 612   unsigned SizeSoFar = OS.tell() - OldPos;
 613   if (Size > SizeSoFar) {
 614     unsigned Remaining = Size - SizeSoFar;
 615     for (unsigned I = 0; I < Remaining; ++I)
 616       OS << ' ';
 617   } else if (Size < SizeSoFar) {
 618     assert(MayTruncate && "Data doesn't fit in Size");
 619     // Some of the data this is used for (like UID) can be larger than the
 620     // space available in the archive format. Truncate in that case.
 621     OS.seek(OldPos + Size);
 622   }
 623 }
 624
 625 static void print32BE(raw_fd_ostream &Out, unsigned Val) {
 626   for (int I = 3; I >= 0; --I) {
 627     char V = (Val >> (8 * I)) & 0xff;
 628     Out << V;
 629   }
 630 }
 631
 632 static void printRestOfMemberHeader(raw_fd_ostream &Out,
 633                                     const sys::TimeValue &ModTime, unsigned UID,
 634                                     unsigned GID, unsigned Perms,
 635                                     unsigned Size) {
 636   printWithSpacePadding(Out, ModTime.toEpochTime(), 12);
 637   printWithSpacePadding(Out, UID, 6, true);
 638   printWithSpacePadding(Out, GID, 6, true);
 639   printWithSpacePadding(Out, format("%o", Perms), 8);
 640   printWithSpacePadding(Out, Size, 10);
 641   Out << "`\n";
 642 }
 643
 644 static void printMemberHeader(raw_fd_ostream &Out, StringRef Name,
 645                               const sys::TimeValue &ModTime, unsigned UID,
 646                               unsigned GID, unsigned Perms, unsigned Size) {
 647   printWithSpacePadding(Out, Twine(Name) + "/", 16);
 648   printRestOfMemberHeader(Out, ModTime, UID, GID, Perms, Size);
 649 }
 650
 651 static void printMemberHeader(raw_fd_ostream &Out, unsigned NameOffset,
 652                               const sys::TimeValue &ModTime, unsigned UID,
 653                               unsigned GID, unsigned Perms, unsigned Size) {
 654   Out << '/';
 655   printWithSpacePadding(Out, NameOffset, 15);
 656   printRestOfMemberHeader(Out, ModTime, UID, GID, Perms, Size);
 657 }
 658
 659 static void writeStringTable(raw_fd_ostream &Out,
 660                              ArrayRef<NewArchiveIterator> Members,
 661                              std::vector<unsigned> &StringMapIndexes) {
 662   unsigned StartOffset = 0;
 663   for (ArrayRef<NewArchiveIterator>::iterator I = Members.begin(),
 664                                               E = Members.end();
 665        I != E; ++I) {
 666     StringRef Name = I->getName();
 667     if (Name.size() < 16)
 668       continue;
 669     if (StartOffset == 0) {
 670       printWithSpacePadding(Out, "//", 58);
 671       Out << "`\n";
 672       StartOffset = Out.tell();
 673     }
 674     StringMapIndexes.push_back(Out.tell() - StartOffset);
 675     Out << Name << "/\n";
 676   }
 677   if (StartOffset == 0)
 678     return;
 679   if (Out.tell() % 2)
 680     Out << '\n';
 681   int Pos = Out.tell();
 682   Out.seek(StartOffset - 12);
 683   printWithSpacePadding(Out, Pos - StartOffset, 10);
 684   Out.seek(Pos);
 685 }
 686
 687 // Returns the offset of the first reference to a member offset.
 688 static unsigned writeSymbolTable(raw_fd_ostream &Out,
 689                                  ArrayRef<NewArchiveIterator> Members,
 690                                  ArrayRef<MemoryBufferRef> Buffers,
 691                                  std::vector<unsigned> &MemberOffsetRefs) {
 692   unsigned StartOffset = 0;
 693   unsigned MemberNum = 0;
 694   std::string NameBuf;
 695   raw_string_ostream NameOS(NameBuf);
 696   unsigned NumSyms = 0;
 697   LLVMContext &Context = getGlobalContext();
 698   for (ArrayRef<NewArchiveIterator>::iterator I = Members.begin(),
 699                                               E = Members.end();
 700        I != E; ++I, ++MemberNum) {
 701     MemoryBufferRef MemberBuffer = Buffers[MemberNum];
 702     ErrorOr<std::unique_ptr<object::SymbolicFile>> ObjOrErr =
 703         object::SymbolicFile::createSymbolicFile(
 704             MemberBuffer, sys::fs::file_magic::unknown, &Context);
 705     if (!ObjOrErr)
 706       continue;  // FIXME: check only for "not an object file" errors.
 707     object::SymbolicFile &Obj = *ObjOrErr.get();
 708
 709     if (!StartOffset) {
 710       printMemberHeader(Out, "", sys::TimeValue::now(), 0, 0, 0, 0);
 711       StartOffset = Out.tell();
 712       print32BE(Out, 0);
 713     }
 714
 715     for (const object::BasicSymbolRef &S : Obj.symbols()) {
 716       uint32_t Symflags = S.getFlags();
 717       if (Symflags & object::SymbolRef::SF_FormatSpecific)
 718         continue;
 719       if (!(Symflags & object::SymbolRef::SF_Global))
 720         continue;
 721       if (Symflags & object::SymbolRef::SF_Undefined)
 722         continue;
 723       failIfError(S.printName(NameOS));
 724       NameOS << '\0';
 725       ++NumSyms;
 726       MemberOffsetRefs.push_back(MemberNum);
 727       print32BE(Out, 0);
 728     }
 729   }
 730   Out << NameOS.str();
 731
 732   if (StartOffset == 0)
 733     return 0;
 734
 735   if (Out.tell() % 2)
 736     Out << '\0';
 737
 738   unsigned Pos = Out.tell();
 739   Out.seek(StartOffset - 12);
 740   printWithSpacePadding(Out, Pos - StartOffset, 10);
 741   Out.seek(StartOffset);
 742   print32BE(Out, NumSyms);
 743   Out.seek(Pos);
 744   return StartOffset + 4;
 745 }
 746
 747 static void
 748 performWriteOperation(ArchiveOperation Operation, object::Archive *OldArchive,
 749                       std::vector<NewArchiveIterator> &NewMembers) {
 750   SmallString<128> TmpArchive;
 751   failIfError(sys::fs::createUniqueFile(ArchiveName + ".temp-archive-%%%%%%%.a",
 752                                         TmpArchiveFD, TmpArchive));
 753
 754   TemporaryOutput = TmpArchive.c_str();
 755   tool_output_file Output(TemporaryOutput, TmpArchiveFD);
 756   raw_fd_ostream &Out = Output.os();
 757   Out << "!<arch>\n";
 758
 759   std::vector<unsigned> MemberOffsetRefs;
 760
 761   std::vector<std::unique_ptr<MemoryBuffer>> Buffers;
 762   std::vector<MemoryBufferRef> Members;
 763   std::vector<sys::fs::file_status> NewMemberStatus;
 764
 765   for (unsigned I = 0, N = NewMembers.size(); I < N; ++I) {
 766     NewArchiveIterator &Member = NewMembers[I];
 767     MemoryBufferRef MemberRef;
 768
 769     if (Member.isNewMember()) {
 770       StringRef Filename = Member.getNew();
 771       NewMemberStatus.resize(NewMemberStatus.size() + 1);
 772       sys::fs::file_status &Status = NewMemberStatus.back();
 773       int FD = Member.getFD(Status);
 774       ErrorOr<std::unique_ptr<MemoryBuffer>> MemberBufferOrErr =
 775           MemoryBuffer::getOpenFile(FD, Filename, Status.getSize(), false);
 776       failIfError(MemberBufferOrErr.getError(), Filename);
 777       if (close(FD) != 0)
 778         fail("Could not close file");
 779       Buffers.push_back(std::move(MemberBufferOrErr.get()));
 780       MemberRef = Buffers.back()->getMemBufferRef();
 781     } else {
 782       object::Archive::child_iterator OldMember = Member.getOld();
 783       ErrorOr<MemoryBufferRef> MemberBufferOrErr =
 784           OldMember->getMemoryBufferRef();
 785       failIfError(MemberBufferOrErr.getError());
 786       MemberRef = MemberBufferOrErr.get();
 787     }
 788     Members.push_back(MemberRef);
 789   }
 790
 791   unsigned MemberReferenceOffset = 0;
 792   if (Symtab) {
 793     MemberReferenceOffset =
 794         writeSymbolTable(Out, NewMembers, Members, MemberOffsetRefs);
 795   }
 796
 797   std::vector<unsigned> StringMapIndexes;
 798   writeStringTable(Out, NewMembers, StringMapIndexes);
 799
 800   unsigned MemberNum = 0;
 801   unsigned LongNameMemberNum = 0;
 802   unsigned NewMemberNum = 0;
 803   std::vector<unsigned> MemberOffset;
 804   for (std::vector<NewArchiveIterator>::iterator I = NewMembers.begin(),
 805                                                  E = NewMembers.end();
 806        I != E; ++I, ++MemberNum) {
 807
 808     unsigned Pos = Out.tell();
 809     MemberOffset.push_back(Pos);
 810
 811     MemoryBufferRef File = Members[MemberNum];
 812     if (I->isNewMember()) {
 813       StringRef FileName = I->getNew();
 814       const sys::fs::file_status &Status = NewMemberStatus[NewMemberNum];
 815       NewMemberNum++;
 816
 817       StringRef Name = sys::path::filename(FileName);
 818       if (Name.size() < 16)
 819         printMemberHeader(Out, Name, Status.getLastModificationTime(),
 820                           Status.getUser(), Status.getGroup(),
 821                           Status.permissions(), Status.getSize());
 822       else
 823         printMemberHeader(Out, StringMapIndexes[LongNameMemberNum++],
 824                           Status.getLastModificationTime(), Status.getUser(),
 825                           Status.getGroup(), Status.permissions(),
 826                           Status.getSize());
 827     } else {
 828       object::Archive::child_iterator OldMember = I->getOld();
 829       StringRef Name = I->getName();
 830
 831       if (Name.size() < 16)
 832         printMemberHeader(Out, Name, OldMember->getLastModified(),
 833                           OldMember->getUID(), OldMember->getGID(),
 834                           OldMember->getAccessMode(), OldMember->getSize());
 835       else
 836         printMemberHeader(Out, StringMapIndexes[LongNameMemberNum++],
 837                           OldMember->getLastModified(), OldMember->getUID(),
 838                           OldMember->getGID(), OldMember->getAccessMode(),
 839                           OldMember->getSize());
 840     }
 841
 842     Out << File.getBuffer();
 843
 844     if (Out.tell() % 2)
 845       Out << '\n';
 846   }
 847
 848   if (MemberReferenceOffset) {
 849     Out.seek(MemberReferenceOffset);
 850     for (unsigned MemberNum : MemberOffsetRefs)
 851       print32BE(Out, MemberOffset[MemberNum]);
 852   }
 853
 854   Output.keep();
 855   Out.close();
 856   sys::fs::rename(TemporaryOutput, ArchiveName);
 857   TemporaryOutput = nullptr;
 858 }
 859
 860 static void
 861 performWriteOperation(ArchiveOperation Operation, object::Archive *OldArchive,
 862                       std::vector<NewArchiveIterator> *NewMembersP) {
 863   if (NewMembersP) {
 864     performWriteOperation(Operation, OldArchive, *NewMembersP);
 865     return;
 866   }
 867   std::vector<NewArchiveIterator> NewMembers =
 868       computeNewArchiveMembers(Operation, OldArchive);
 869   performWriteOperation(Operation, OldArchive, NewMembers);
 870 }
 871
 872 static void createSymbolTable(object::Archive *OldArchive) {
 873   // When an archive is created or modified, if the s option is given, the
 874   // resulting archive will have a current symbol table. If the S option
 875   // is given, it will have no symbol table.
 876   // In summary, we only need to update the symbol table if we have none.
 877   // This is actually very common because of broken build systems that think
 878   // they have to run ranlib.
 879   if (OldArchive->hasSymbolTable())
 880     return;
 881
 882   performWriteOperation(CreateSymTab, OldArchive, nullptr);
 883 }
 884
 885 static void performOperation(ArchiveOperation Operation,
 886                              object::Archive *OldArchive,
 887                              std::vector<NewArchiveIterator> *NewMembers) {
 888   switch (Operation) {
 889   case Print:
 890   case DisplayTable:
 891   case Extract:
 892     performReadOperation(Operation, OldArchive);
 893     return;
 894
 895   case Delete:
 896   case Move:
 897   case QuickAppend:
 898   case ReplaceOrInsert:
 899     performWriteOperation(Operation, OldArchive, NewMembers);
 900     return;
 901   case CreateSymTab:
 902     createSymbolTable(OldArchive);
 903     return;
 904   }
 905   llvm_unreachable("Unknown operation.");
 906 }
 907
 908 static int performOperation(ArchiveOperation Operation,
 909                             std::vector<NewArchiveIterator> *NewMembers) {
 910   // Create or open the archive object.
 911   ErrorOr<std::unique_ptr<MemoryBuffer>> Buf =
 912       MemoryBuffer::getFile(ArchiveName, -1, false);
 913   std::error_code EC = Buf.getError();
 914   if (EC && EC != errc::no_such_file_or_directory) {
 915     errs() << ToolName << ": error opening '" << ArchiveName
 916            << "': " << EC.message() << "!\n";
 917     return 1;
 918   }
 919
 920   if (!EC) {
 921     object::Archive Archive(Buf.get()->getMemBufferRef(), EC);
 922
 923     if (EC) {
 924       errs() << ToolName << ": error loading '" << ArchiveName
 925              << "': " << EC.message() << "!\n";
 926       return 1;
 927     }
 928     performOperation(Operation, &Archive, NewMembers);
 929     return 0;
 930   }
 931
 932   assert(EC == errc::no_such_file_or_directory);
 933
 934   if (!shouldCreateArchive(Operation)) {
 935     failIfError(EC, Twine("error loading '") + ArchiveName + "'");
 936   } else {
 937     if (!Create) {
 938       // Produce a warning if we should and we're creating the archive
 939       errs() << ToolName << ": creating " << ArchiveName << "\n";
 940     }
 941   }
 942
 943   performOperation(Operation, nullptr, NewMembers);
 944   return 0;
 945 }
 946
 947 static void runMRIScript() {
 948   enum class MRICommand { AddLib, AddMod, Create, Save, End, Invalid };
 949
 950   ErrorOr<std::unique_ptr<MemoryBuffer>> Buf = MemoryBuffer::getSTDIN();
 951   failIfError(Buf.getError());
 952   const MemoryBuffer &Ref = *Buf.get();
 953   bool Saved = false;
 954   std::vector<NewArchiveIterator> NewMembers;
 955   std::vector<std::unique_ptr<MemoryBuffer>> ArchiveBuffers;
 956   std::vector<std::unique_ptr<object::Archive>> Archives;
 957
 958   for (line_iterator I(Ref, /*SkipBlanks*/ true, ';'), E; I != E; ++I) {
 959     StringRef Line = *I;
 960     StringRef CommandStr, Rest;
 961     std::tie(CommandStr, Rest) = Line.split(' ');
 962     Rest = Rest.trim();
 963     if (!Rest.empty() && Rest.front() == '"' && Rest.back() == '"')
 964       Rest = Rest.drop_front().drop_back();
 965     auto Command = StringSwitch<MRICommand>(CommandStr.lower())
 966                        .Case("addlib", MRICommand::AddLib)
 967                        .Case("addmod", MRICommand::AddMod)
 968                        .Case("create", MRICommand::Create)
 969                        .Case("save", MRICommand::Save)
 970                        .Case("end", MRICommand::End)
 971                        .Default(MRICommand::Invalid);
 972
 973     switch (Command) {
 974     case MRICommand::AddLib: {
 975       auto BufOrErr = MemoryBuffer::getFile(Rest, -1, false);
 976       failIfError(BufOrErr.getError(), "Could not open library");
 977       ArchiveBuffers.push_back(std::move(*BufOrErr));
 978       auto LibOrErr =
 979           object::Archive::create(ArchiveBuffers.back()->getMemBufferRef());
 980       failIfError(LibOrErr.getError(), "Could not parse library");
 981       Archives.push_back(std::move(*LibOrErr));
 982       object::Archive &Lib = *Archives.back();
 983       for (auto &Member : Lib.children()) {
 984         ErrorOr<StringRef> NameOrErr = Member.getName();
 985         failIfError(NameOrErr.getError());
 986         addMember(NewMembers, Member, *NameOrErr);
 987       }
 988       break;
 989     }
 990     case MRICommand::AddMod:
 991       addMember(NewMembers, Rest, sys::path::filename(Rest));
 992       break;
 993     case MRICommand::Create:
 994       Create = true;
 995       if (!ArchiveName.empty())
 996         fail("Editing multiple archives not supported");
 997       if (Saved)
 998         fail("File already saved");
 999       ArchiveName = Rest;
1000       break;
1001     case MRICommand::Save:
1002       Saved = true;
1003       break;
1004     case MRICommand::End:
1005       break;
1006     case MRICommand::Invalid:
1007       fail("Unknown command: " + CommandStr);
1008     }
1009   }
1010
1011   // Nothing to do if not saved.
1012   if (Saved)
1013     performOperation(ReplaceOrInsert, &NewMembers);
1014   exit(0);
1015 }
1016
1017 static int ar_main() {
1018   // Do our own parsing of the command line because the CommandLine utility
1019   // can't handle the grouped positional parameters without a dash.
1020   ArchiveOperation Operation = parseCommandLine();
1021   return performOperation(Operation, nullptr);
1022 }
1023
1024 static int ranlib_main() {
1025   if (RestOfArgs.size() != 1)
1026     fail(ToolName + "takes just one archive as argument");
1027   ArchiveName = RestOfArgs[0];
1028   return performOperation(CreateSymTab, nullptr);
1029 }
1030
1031 int main(int argc, char **argv) {
1032   ToolName = argv[0];
1033   // Print a stack trace if we signal out.
1034   sys::PrintStackTraceOnErrorSignal();
1035   PrettyStackTraceProgram X(argc, argv);
1036   llvm_shutdown_obj Y;  // Call llvm_shutdown() on exit.
1037
1038   // Have the command line options parsed and handle things
1039   // like --help and --version.
1040   cl::ParseCommandLineOptions(argc, argv,
1041     "LLVM Archiver (llvm-ar)\n\n"
1042     "  This program archives bitcode files into single libraries\n"
1043   );
1044
1045   llvm::InitializeAllTargetInfos();
1046   llvm::InitializeAllTargetMCs();
1047   llvm::InitializeAllAsmParsers();
1048
1049   StringRef Stem = sys::path::stem(ToolName);
1050   if (Stem.find("ar") != StringRef::npos)
1051     return ar_main();
1052   if (Stem.find("ranlib") != StringRef::npos)
1053     return ranlib_main();
1054   fail("Not ranlib or ar!");
1055 }