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