1 //===-- llvm-ar.cpp - LLVM archive librarian utility ----------------------===//
3 // The LLVM Compiler Infrastructure
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
10 // Builds up (relatively) standard unix archive files (.a) containing LLVM
11 // bitcode or other files.
13 //===----------------------------------------------------------------------===//
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"
36 #if !defined(_MSC_VER) && !defined(__MINGW32__)
44 // The name this program was invoked as.
45 static StringRef ToolName
;
47 static const char *TemporaryOutput
;
48 static int TmpArchiveFD
= -1;
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)
56 sys::fs::remove(TemporaryOutput
);
60 static void failIfError(std::error_code EC
, Twine Context
= "") {
64 std::string ContextStr
= Context
.str();
67 fail(Context
+ ": " + EC
.message());
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]..."));
75 static cl::opt
<bool> MRI("M", cl::desc(""));
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(
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"
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
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
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
131 static std::string RelPos
;
133 // This variable holds the name of the archive file as given on the
135 static std::string ArchiveName
;
137 // This variable holds the list of member files to proecess, as given
138 // on the command line.
139 static std::vector
<StringRef
> Members
;
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();
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());
158 static void getOptions() {
159 if(RestOfArgs
.size() == 0)
160 show_help("Expected options");
161 Options
= RestOfArgs
[0];
162 RestOfArgs
.erase(RestOfArgs
.begin());
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());
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
);
179 static void runMRIScript();
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() {
186 if (!RestOfArgs
.empty())
187 fail("Cannot mix -M and other options");
193 // Keep track of number of operations. We can only specify one
195 unsigned NumOperations
= 0;
197 // Keep track of the number of positional modifiers (a,b,i). Only
198 // one can be specified.
199 unsigned NumPositional
= 0;
201 // Keep track of which operation was requested
202 ArchiveOperation Operation
;
204 bool MaybeJustCreateSymTab
= false;
206 for(unsigned i
=0; i
<Options
.size(); ++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;
220 MaybeJustCreateSymTab
= true;
225 case 'u': OnlyUpdate
= true; break;
226 case 'v': Verbose
= true; break;
243 cl::PrintHelpMessage();
247 // At this point, the next thing on the command line must be
251 // Everything on the command line at this point is a member.
254 if (NumOperations
== 0 && MaybeJustCreateSymTab
) {
256 Operation
= CreateSymTab
;
257 if (!Members
.empty())
258 show_help("The s operation takes only an archive as argument");
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");
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");
279 // Return the parsed operation to the caller
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
) {
287 outs() << "Printing " << Name
<< "\n";
289 StringRef Data
= I
->getBuffer();
290 outs().write(Data
.data(), Data
.size());
293 // Utility function for printing out the file mode when the 't' operation is in
295 static void printMode(unsigned mode
) {
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
) {
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();
326 outs() << Name
<< "\n";
329 // Implement the 'x' operation. This function extracts files back to the file
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
;
338 sys::fs::openFileForWrite(Storage
.c_str(), FD
, sys::fs::F_None
, Mode
),
342 raw_fd_ostream
file(FD
, false);
344 // Get the data and its length
345 StringRef Data
= I
->getBuffer();
348 file
.write(Data
.data(), Data
.size());
351 // If we're supposed to retain the original modification times, etc. do so
355 sys::fs::setLastModificationAndAccessTime(FD
, I
->getLastModified()));
358 fail("Could not close the file");
361 static bool shouldCreateArchive(ArchiveOperation Op
) {
372 case ReplaceOrInsert
:
376 llvm_unreachable("Missing entry in covered switch.");
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();
384 ErrorOr
<StringRef
> NameOrErr
= I
->getName();
385 failIfError(NameOrErr
.getError());
386 StringRef Name
= NameOrErr
.get();
388 if (!Members
.empty() &&
389 std::find(Members
.begin(), Members
.end(), Name
) == Members
.end())
394 llvm_unreachable("Not a read operation");
399 doDisplayTable(Name
, I
);
409 class NewArchiveIterator
{
413 object::Archive::child_iterator OldI
;
415 StringRef NewFilename
;
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;
424 object::Archive::child_iterator
getOld() const;
426 StringRef
getNew() const;
427 int getFD(sys::fs::file_status
&NewStatus
) const;
428 const sys::fs::file_status
&getStatus() const;
432 NewArchiveIterator::NewArchiveIterator() {}
434 NewArchiveIterator::NewArchiveIterator(object::Archive::child_iterator I
,
436 : IsNewMember(false), Name(Name
), OldI(I
) {}
438 NewArchiveIterator::NewArchiveIterator(StringRef NewFilename
, StringRef Name
)
439 : IsNewMember(true), Name(Name
), NewFilename(NewFilename
) {}
441 StringRef
NewArchiveIterator::getName() const { return Name
; }
443 bool NewArchiveIterator::isNewMember() const { return IsNewMember
; }
445 object::Archive::child_iterator
NewArchiveIterator::getOld() const {
446 assert(!IsNewMember
);
450 StringRef
NewArchiveIterator::getNew() const {
455 int NewArchiveIterator::getFD(sys::fs::file_status
&NewStatus
) const {
458 failIfError(sys::fs::openFileForRead(NewFilename
, NewFD
), NewFilename
);
461 failIfError(sys::fs::status(NewFD
, NewStatus
), NewFilename
);
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
);
472 template <typename T
>
473 void addMember(std::vector
<NewArchiveIterator
> &Members
, T I
, StringRef Name
,
475 NewArchiveIterator
NI(I
, Name
);
477 Members
.push_back(NI
);
490 static InsertAction
computeInsertAction(ArchiveOperation Operation
,
491 object::Archive::child_iterator I
,
493 std::vector
<StringRef
>::iterator
&Pos
) {
494 if (Operation
== QuickAppend
|| Members
.empty())
495 return IA_AddOldMember
;
498 std::find_if(Members
.begin(), Members
.end(), [Name
](StringRef Path
) {
499 return Name
== sys::path::filename(Path
);
502 if (MI
== Members
.end())
503 return IA_AddOldMember
;
507 if (Operation
== Delete
)
510 if (Operation
== Move
)
511 return IA_MoveOldMember
;
513 if (Operation
== ReplaceOrInsert
) {
514 StringRef PosName
= sys::path::filename(RelPos
);
517 return IA_AddNewMeber
;
518 return IA_MoveNewMember
;
521 // We could try to optimize this to a fstat, but it is not a common
523 sys::fs::file_status Status
;
524 failIfError(sys::fs::status(*MI
, Status
), *MI
);
525 if (Status
.getLastModificationTime() < I
->getLastModified()) {
527 return IA_AddOldMember
;
528 return IA_MoveOldMember
;
532 return IA_AddNewMeber
;
533 return IA_MoveNewMember
;
535 llvm_unreachable("No such operation");
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
;
546 StringRef PosName
= sys::path::filename(RelPos
);
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
);
561 std::vector
<StringRef
>::iterator MemberI
= Members
.end();
562 InsertAction Action
=
563 computeInsertAction(Operation
, Child
, Name
, MemberI
);
565 case IA_AddOldMember
:
566 addMember(Ret
, Child
, Name
);
569 addMember(Ret
, *MemberI
, Name
);
573 case IA_MoveOldMember
:
574 addMember(Moved
, Child
, Name
);
576 case IA_MoveNewMember
:
577 addMember(Moved
, *MemberI
, Name
);
580 if (MemberI
!= Members
.end())
581 Members
.erase(MemberI
);
585 if (Operation
== Delete
)
588 if (!RelPos
.empty() && InsertPos
== -1)
589 fail("Insertion point not found");
592 InsertPos
= Ret
.size();
594 assert(unsigned(InsertPos
) <= Ret
.size());
595 Ret
.insert(Ret
.begin() + InsertPos
, Moved
.begin(), Moved
.end());
597 Ret
.insert(Ret
.begin() + InsertPos
, Members
.size(), NewArchiveIterator());
599 for (auto &Member
: Members
) {
600 StringRef Name
= sys::path::filename(Member
);
601 addMember(Ret
, Member
, Name
, Pos
);
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();
613 unsigned SizeSoFar
= OS
.tell() - OldPos
;
614 if (Size
> SizeSoFar
) {
615 unsigned Remaining
= Size
- SizeSoFar
;
616 for (unsigned I
= 0; I
< Remaining
; ++I
)
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
);
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;
633 static void printRestOfMemberHeader(raw_fd_ostream
&Out
,
634 const sys::TimeValue
&ModTime
, unsigned UID
,
635 unsigned GID
, unsigned Perms
,
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);
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
);
652 static void printMemberHeader(raw_fd_ostream
&Out
, unsigned NameOffset
,
653 const sys::TimeValue
&ModTime
, unsigned UID
,
654 unsigned GID
, unsigned Perms
, unsigned Size
) {
656 printWithSpacePadding(Out
, NameOffset
, 15);
657 printRestOfMemberHeader(Out
, ModTime
, UID
, GID
, Perms
, Size
);
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(),
667 StringRef Name
= I
->getName();
668 if (Name
.size() < 16)
670 if (StartOffset
== 0) {
671 printWithSpacePadding(Out
, "//", 58);
673 StartOffset
= Out
.tell();
675 StringMapIndexes
.push_back(Out
.tell() - StartOffset
);
676 Out
<< Name
<< "/\n";
678 if (StartOffset
== 0)
682 int Pos
= Out
.tell();
683 Out
.seek(StartOffset
- 12);
684 printWithSpacePadding(Out
, Pos
- StartOffset
, 10);
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;
696 raw_string_ostream
NameOS(NameBuf
);
697 unsigned NumSyms
= 0;
698 LLVMContext
&Context
= getGlobalContext();
699 for (ArrayRef
<NewArchiveIterator
>::iterator I
= Members
.begin(),
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
);
707 continue; // FIXME: check only for "not an object file" errors.
708 object::SymbolicFile
&Obj
= *ObjOrErr
.get();
711 printMemberHeader(Out
, "", sys::TimeValue::now(), 0, 0, 0, 0);
712 StartOffset
= Out
.tell();
716 for (const object::BasicSymbolRef
&S
: Obj
.symbols()) {
717 uint32_t Symflags
= S
.getFlags();
718 if (Symflags
& object::SymbolRef::SF_FormatSpecific
)
720 if (!(Symflags
& object::SymbolRef::SF_Global
))
722 if (Symflags
& object::SymbolRef::SF_Undefined
)
724 failIfError(S
.printName(NameOS
));
727 MemberOffsetRefs
.push_back(MemberNum
);
733 if (StartOffset
== 0)
739 unsigned Pos
= Out
.tell();
740 Out
.seek(StartOffset
- 12);
741 printWithSpacePadding(Out
, Pos
- StartOffset
, 10);
742 Out
.seek(StartOffset
);
743 print32BE(Out
, NumSyms
);
745 return StartOffset
+ 4;
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
));
755 TemporaryOutput
= TmpArchive
.c_str();
756 tool_output_file
Output(TemporaryOutput
, TmpArchiveFD
);
757 raw_fd_ostream
&Out
= Output
.os();
760 std::vector
<unsigned> MemberOffsetRefs
;
762 std::vector
<std::unique_ptr
<MemoryBuffer
>> Buffers
;
763 std::vector
<MemoryBufferRef
> Members
;
764 std::vector
<sys::fs::file_status
> NewMemberStatus
;
766 for (unsigned I
= 0, N
= NewMembers
.size(); I
< N
; ++I
) {
767 NewArchiveIterator
&Member
= NewMembers
[I
];
768 MemoryBufferRef MemberRef
;
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
);
779 fail("Could not close file");
780 Buffers
.push_back(std::move(MemberBufferOrErr
.get()));
781 MemberRef
= Buffers
.back()->getMemBufferRef();
783 object::Archive::child_iterator OldMember
= Member
.getOld();
784 ErrorOr
<MemoryBufferRef
> MemberBufferOrErr
=
785 OldMember
->getMemoryBufferRef();
786 failIfError(MemberBufferOrErr
.getError());
787 MemberRef
= MemberBufferOrErr
.get();
789 Members
.push_back(MemberRef
);
792 unsigned MemberReferenceOffset
= 0;
794 MemberReferenceOffset
=
795 writeSymbolTable(Out
, NewMembers
, Members
, MemberOffsetRefs
);
798 std::vector
<unsigned> StringMapIndexes
;
799 writeStringTable(Out
, NewMembers
, StringMapIndexes
);
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
) {
809 unsigned Pos
= Out
.tell();
810 MemberOffset
.push_back(Pos
);
812 MemoryBufferRef File
= Members
[MemberNum
];
813 if (I
->isNewMember()) {
814 StringRef FileName
= I
->getNew();
815 const sys::fs::file_status
&Status
= NewMemberStatus
[NewMemberNum
];
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());
824 printMemberHeader(Out
, StringMapIndexes
[LongNameMemberNum
++],
825 Status
.getLastModificationTime(), Status
.getUser(),
826 Status
.getGroup(), Status
.permissions(),
829 object::Archive::child_iterator OldMember
= I
->getOld();
830 StringRef Name
= I
->getName();
832 if (Name
.size() < 16)
833 printMemberHeader(Out
, Name
, OldMember
->getLastModified(),
834 OldMember
->getUID(), OldMember
->getGID(),
835 OldMember
->getAccessMode(), OldMember
->getSize());
837 printMemberHeader(Out
, StringMapIndexes
[LongNameMemberNum
++],
838 OldMember
->getLastModified(), OldMember
->getUID(),
839 OldMember
->getGID(), OldMember
->getAccessMode(),
840 OldMember
->getSize());
843 Out
<< File
.getBuffer();
849 if (MemberReferenceOffset
) {
850 Out
.seek(MemberReferenceOffset
);
851 for (unsigned MemberNum
: MemberOffsetRefs
)
852 print32BE(Out
, MemberOffset
[MemberNum
]);
857 sys::fs::rename(TemporaryOutput
, ArchiveName
);
858 TemporaryOutput
= nullptr;
862 performWriteOperation(ArchiveOperation Operation
, object::Archive
*OldArchive
,
863 std::vector
<NewArchiveIterator
> *NewMembersP
) {
865 performWriteOperation(Operation
, OldArchive
, *NewMembersP
);
868 std::vector
<NewArchiveIterator
> NewMembers
=
869 computeNewArchiveMembers(Operation
, OldArchive
);
870 performWriteOperation(Operation
, OldArchive
, NewMembers
);
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())
883 performWriteOperation(CreateSymTab
, OldArchive
, nullptr);
886 static void performOperation(ArchiveOperation Operation
,
887 object::Archive
*OldArchive
,
888 std::vector
<NewArchiveIterator
> *NewMembers
) {
893 performReadOperation(Operation
, OldArchive
);
899 case ReplaceOrInsert
:
900 performWriteOperation(Operation
, OldArchive
, NewMembers
);
903 createSymbolTable(OldArchive
);
906 llvm_unreachable("Unknown operation.");
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";
922 object::Archive
Archive(Buf
.get()->getMemBufferRef(), EC
);
925 errs() << ToolName
<< ": error loading '" << ArchiveName
926 << "': " << EC
.message() << "!\n";
929 performOperation(Operation
, &Archive
, NewMembers
);
933 assert(EC
== errc::no_such_file_or_directory
);
935 if (!shouldCreateArchive(Operation
)) {
936 failIfError(EC
, Twine("error loading '") + ArchiveName
+ "'");
939 // Produce a warning if we should and we're creating the archive
940 errs() << ToolName
<< ": creating " << ArchiveName
<< "\n";
944 performOperation(Operation
, nullptr, NewMembers
);
948 static void runMRIScript() {
949 enum class MRICommand
{ AddLib
, AddMod
, Create
, Save
, End
, Invalid
};
951 ErrorOr
<std::unique_ptr
<MemoryBuffer
>> Buf
= MemoryBuffer::getSTDIN();
952 failIfError(Buf
.getError());
953 const MemoryBuffer
&Ref
= *Buf
.get();
955 std::vector
<NewArchiveIterator
> NewMembers
;
956 std::vector
<std::unique_ptr
<MemoryBuffer
>> ArchiveBuffers
;
957 std::vector
<std::unique_ptr
<object::Archive
>> Archives
;
959 for (line_iterator
I(Ref
, /*SkipBlanks*/ true, ';'), E
; I
!= E
; ++I
) {
961 StringRef CommandStr
, Rest
;
962 std::tie(CommandStr
, Rest
) = Line
.split(' ');
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
);
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
));
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
);
991 case MRICommand::AddMod
:
992 addMember(NewMembers
, Rest
, sys::path::filename(Rest
));
994 case MRICommand::Create
:
996 if (!ArchiveName
.empty())
997 fail("Editing multiple archives not supported");
999 fail("File already saved");
1002 case MRICommand::Save
:
1005 case MRICommand::End
:
1007 case MRICommand::Invalid
:
1008 fail("Unknown command: " + CommandStr
);
1012 // Nothing to do if not saved.
1014 performOperation(ReplaceOrInsert
, &NewMembers
);
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);
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);
1032 int main(int argc
, char **argv
) {
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.
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"
1046 llvm::InitializeAllTargetInfos();
1047 llvm::InitializeAllTargetMCs();
1048 llvm::InitializeAllAsmParsers();
1050 StringRef Stem
= sys::path::stem(ToolName
);
1051 if (Stem
.find("ar") != StringRef::npos
)
1053 if (Stem
.find("ranlib") != StringRef::npos
)
1054 return ranlib_main();
1055 fail("Not ranlib or ar!");