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