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 //===----------------------------------------------------------------------===//
16 #include "llvm/IR/LLVMContext.h"
17 #include "llvm/IR/Module.h"
18 #include "llvm/Support/CommandLine.h"
19 #include "llvm/Support/FileSystem.h"
20 #include "llvm/Support/Format.h"
21 #include "llvm/Support/ManagedStatic.h"
22 #include "llvm/Support/PrettyStackTrace.h"
23 #include "llvm/Support/Signals.h"
24 #include "llvm/Support/raw_ostream.h"
31 // Option for compatibility with AIX, not used but must allow it to be present.
33 X32Option ("X32_64", cl::Hidden,
34 cl::desc("Ignored option for compatibility with AIX"));
36 // llvm-ar operation code and modifier flags. This must come first.
37 static cl::opt<std::string>
38 Options(cl::Positional, cl::Required, cl::desc("{operation}[modifiers]..."));
40 // llvm-ar remaining positional arguments.
41 static cl::list<std::string>
42 RestOfArgs(cl::Positional, cl::OneOrMore,
43 cl::desc("[relpos] [count] <archive-file> [members]..."));
45 // MoreHelp - Provide additional help output explaining the operations and
46 // modifiers of llvm-ar. This object instructs the CommandLine library
47 // to print the text of the constructor when the --help option is given.
48 static cl::extrahelp MoreHelp(
50 " d[NsS] - delete file(s) from the archive\n"
51 " m[abiSs] - move file(s) in the archive\n"
52 " p[kN] - print file(s) found in the archive\n"
53 " q[ufsS] - quick append file(s) to the archive\n"
54 " r[abfiuRsS] - replace or insert file(s) into the archive\n"
55 " t - display contents of archive\n"
56 " x[No] - extract file(s) from the archive\n"
57 "\nMODIFIERS (operation specific):\n"
58 " [a] - put file(s) after [relpos]\n"
59 " [b] - put file(s) before [relpos] (same as [i])\n"
60 " [f] - truncate inserted file names\n"
61 " [i] - put file(s) before [relpos] (same as [b])\n"
62 " [k] - always print bitcode files (default is to skip them)\n"
63 " [N] - use instance [count] of name\n"
64 " [o] - preserve original dates\n"
65 " [P] - use full path names when matching\n"
66 " [R] - recurse through directories when inserting\n"
67 " [s] - create an archive index (cf. ranlib)\n"
68 " [S] - do not build a symbol table\n"
69 " [u] - update only files newer than archive contents\n"
70 "\nMODIFIERS (generic):\n"
71 " [c] - do not warn if the library had to be created\n"
72 " [v] - be verbose about actions taken\n"
73 " [V] - be *really* verbose about actions taken\n"
76 // This enumeration delineates the kinds of operations on an archive
77 // that are permitted.
78 enum ArchiveOperation {
79 NoOperation, ///< An operation hasn't been specified
80 Print, ///< Print the contents of the archive
81 Delete, ///< Delete the specified members
82 Move, ///< Move members to end or as given by {a,b,i} modifiers
83 QuickAppend, ///< Quickly append to end of archive
84 ReplaceOrInsert, ///< Replace or Insert members
85 DisplayTable, ///< Display the table of contents
86 Extract ///< Extract files back to file system
89 // Modifiers to follow operation to vary behavior
90 bool AddAfter = false; ///< 'a' modifier
91 bool AddBefore = false; ///< 'b' modifier
92 bool Create = false; ///< 'c' modifier
93 bool TruncateNames = false; ///< 'f' modifier
94 bool InsertBefore = false; ///< 'i' modifier
95 bool DontSkipBitcode = false; ///< 'k' modifier
96 bool UseCount = false; ///< 'N' modifier
97 bool OriginalDates = false; ///< 'o' modifier
98 bool FullPath = false; ///< 'P' modifier
99 bool SymTable = true; ///< 's' & 'S' modifiers
100 bool OnlyUpdate = false; ///< 'u' modifier
101 bool Verbose = false; ///< 'v' modifier
102 bool ReallyVerbose = false; ///< 'V' modifier
104 // Relative Positional Argument (for insert/move). This variable holds
105 // the name of the archive member to which the 'a', 'b' or 'i' modifier
106 // refers. Only one of 'a', 'b' or 'i' can be specified so we only need
110 // Select which of multiple entries in the archive with the same name should be
111 // used (specified with -N) for the delete and extract operations.
114 // This variable holds the name of the archive file as given on the
116 std::string ArchiveName;
118 // This variable holds the list of member files to proecess, as given
119 // on the command line.
120 std::vector<std::string> Members;
122 // This variable holds the (possibly expanded) list of path objects that
123 // correspond to files we will
124 std::set<std::string> Paths;
126 // The Archive object to which all the editing operations will be sent.
127 Archive* TheArchive = 0;
129 // The name this program was invoked as.
130 static const char *program_name;
132 // show_help - Show the error message, the help message and exit.
133 LLVM_ATTRIBUTE_NORETURN static void
134 show_help(const std::string &msg) {
135 errs() << program_name << ": " << msg << "\n\n";
136 cl::PrintHelpMessage();
142 // fail - Show the error message and exit.
143 LLVM_ATTRIBUTE_NORETURN static void
144 fail(const std::string &msg) {
145 errs() << program_name << ": " << msg << "\n\n";
151 // getRelPos - Extract the member filename from the command line for
152 // the [relpos] argument associated with a, b, and i modifiers
154 if(RestOfArgs.size() == 0)
155 show_help("Expected [relpos] for a, b, or i modifier");
156 RelPos = RestOfArgs[0];
157 RestOfArgs.erase(RestOfArgs.begin());
160 // getCount - Extract the [count] argument associated with the N modifier
161 // from the command line and check its value.
163 if(RestOfArgs.size() == 0)
164 show_help("Expected [count] value with N modifier");
166 Count = atoi(RestOfArgs[0].c_str());
167 RestOfArgs.erase(RestOfArgs.begin());
169 // Non-positive counts are not allowed
171 show_help("Invalid [count] value (not a positive integer)");
174 // getArchive - Get the archive file name from the command line
176 if(RestOfArgs.size() == 0)
177 show_help("An archive name must be specified");
178 ArchiveName = RestOfArgs[0];
179 RestOfArgs.erase(RestOfArgs.begin());
182 // getMembers - Copy over remaining items in RestOfArgs to our Members vector
183 // This is just for clarity.
185 if(RestOfArgs.size() > 0)
186 Members = std::vector<std::string>(RestOfArgs);
189 // parseCommandLine - Parse the command line options as presented and return the
190 // operation specified. Process all modifiers and check to make sure that
191 // constraints on modifier/operation pairs have not been violated.
192 ArchiveOperation parseCommandLine() {
194 // Keep track of number of operations. We can only specify one
196 unsigned NumOperations = 0;
198 // Keep track of the number of positional modifiers (a,b,i). Only
199 // one can be specified.
200 unsigned NumPositional = 0;
202 // Keep track of which operation was requested
203 ArchiveOperation Operation = NoOperation;
205 for(unsigned i=0; i<Options.size(); ++i) {
207 case 'd': ++NumOperations; Operation = Delete; break;
208 case 'm': ++NumOperations; Operation = Move ; break;
209 case 'p': ++NumOperations; Operation = Print; break;
210 case 'q': ++NumOperations; Operation = QuickAppend; break;
211 case 'r': ++NumOperations; Operation = ReplaceOrInsert; break;
212 case 't': ++NumOperations; Operation = DisplayTable; break;
213 case 'x': ++NumOperations; Operation = Extract; break;
214 case 'c': Create = true; break;
215 case 'f': TruncateNames = true; break;
216 case 'k': DontSkipBitcode = true; break;
217 case 'l': /* accepted but unused */ break;
218 case 'o': OriginalDates = true; break;
219 case 'P': FullPath = true; break;
220 case 's': SymTable = true; break;
221 case 'S': SymTable = false; break;
222 case 'u': OnlyUpdate = true; break;
223 case 'v': Verbose = true; break;
224 case 'V': Verbose = ReallyVerbose = true; break;
245 cl::PrintHelpMessage();
249 // At this point, the next thing on the command line must be
253 // Everything on the command line at this point is a member.
256 // Perform various checks on the operation/modifier specification
257 // to make sure we are dealing with a legal request.
258 if (NumOperations == 0)
259 show_help("You must specify at least one of the operations");
260 if (NumOperations > 1)
261 show_help("Only one operation may be specified");
262 if (NumPositional > 1)
263 show_help("You may only specify one of a, b, and i modifiers");
264 if (AddAfter || AddBefore || InsertBefore) {
265 if (Operation != Move && Operation != ReplaceOrInsert)
266 show_help("The 'a', 'b' and 'i' modifiers can only be specified with "
267 "the 'm' or 'r' operations");
269 if (OriginalDates && Operation != Extract)
270 show_help("The 'o' modifier is only applicable to the 'x' operation");
271 if (TruncateNames && Operation!=QuickAppend && Operation!=ReplaceOrInsert)
272 show_help("The 'f' modifier is only applicable to the 'q' and 'r' "
274 if (OnlyUpdate && Operation != ReplaceOrInsert)
275 show_help("The 'u' modifier is only applicable to the 'r' operation");
276 if (Count > 1 && Members.size() > 1)
277 show_help("Only one member name may be specified with the 'N' modifier");
279 // Return the parsed operation to the caller
283 // buildPaths - Convert the strings in the Members vector to sys::Path objects
284 // and make sure they are valid and exist exist. This check is only needed for
285 // the operations that add/replace files to the archive ('q' and 'r')
286 bool buildPaths(bool checkExistence, std::string* ErrMsg) {
287 for (unsigned i = 0; i < Members.size(); i++) {
289 if (!aPath.set(Members[i]))
290 fail(std::string("File member name invalid: ") + Members[i]);
291 if (checkExistence) {
293 if (sys::fs::exists(aPath.str(), Exists) || !Exists)
294 fail(std::string("File does not exist: ") + Members[i]);
296 sys::PathWithStatus PwS(aPath);
297 const sys::FileStatus *si = PwS.getFileStatus(false, &Err);
301 fail(aPath.str() + " Is a directory");
303 Paths.insert(aPath.str());
305 Paths.insert(aPath.str());
311 // printSymbolTable - print out the archive's symbol table.
312 void printSymbolTable() {
313 outs() << "\nArchive Symbol Table:\n";
314 const Archive::SymTabType& symtab = TheArchive->getSymbolTable();
315 for (Archive::SymTabType::const_iterator I=symtab.begin(), E=symtab.end();
317 unsigned offset = TheArchive->getFirstFileOffset() + I->second;
318 outs() << " " << format("%9u", offset) << "\t" << I->first <<"\n";
322 // doPrint - Implements the 'p' operation. This function traverses the archive
323 // looking for members that match the path list. It is careful to uncompress
324 // things that should be and to skip bitcode files unless the 'k' modifier was
326 bool doPrint(std::string* ErrMsg) {
327 if (buildPaths(false, ErrMsg))
329 unsigned countDown = Count;
330 for (Archive::iterator I = TheArchive->begin(), E = TheArchive->end();
333 (std::find(Paths.begin(), Paths.end(), I->getPath()) != Paths.end())) {
334 if (countDown == 1) {
335 const char* data = reinterpret_cast<const char*>(I->getData());
337 // Skip things that don't make sense to print
338 if (I->isSVR4SymbolTable() ||
339 I->isBSD4SymbolTable() || (!DontSkipBitcode && I->isBitcode()))
343 outs() << "Printing " << I->getPath().str() << "\n";
345 unsigned len = I->getSize();
346 outs().write(data, len);
355 // putMode - utility function for printing out the file mode when the 't'
356 // operation is in verbose mode.
358 printMode(unsigned mode) {
373 // doDisplayTable - Implement the 't' operation. This function prints out just
374 // the file names of each of the members. However, if verbose mode is requested
375 // ('v' modifier) then the file type, permission mode, user, group, size, and
376 // modification time are also printed.
378 doDisplayTable(std::string* ErrMsg) {
379 if (buildPaths(false, ErrMsg))
381 for (Archive::iterator I = TheArchive->begin(), E = TheArchive->end();
384 (std::find(Paths.begin(), Paths.end(), I->getPath()) != Paths.end())) {
386 // FIXME: Output should be this format:
387 // Zrw-r--r-- 500/ 500 525 Nov 8 17:42 2004 Makefile
392 unsigned mode = I->getMode();
393 printMode((mode >> 6) & 007);
394 printMode((mode >> 3) & 007);
395 printMode(mode & 007);
396 outs() << " " << format("%4u", I->getUser());
397 outs() << "/" << format("%4u", I->getGroup());
398 outs() << " " << format("%8u", I->getSize());
399 outs() << " " << format("%20s", I->getModTime().str().substr(4).c_str());
400 outs() << " " << I->getPath().str() << "\n";
402 outs() << I->getPath().str() << "\n";
411 // doExtract - Implement the 'x' operation. This function extracts files back to
414 doExtract(std::string* ErrMsg) {
415 if (buildPaths(false, ErrMsg))
417 for (Archive::iterator I = TheArchive->begin(), E = TheArchive->end();
420 (std::find(Paths.begin(), Paths.end(), I->getPath()) != Paths.end())) {
422 // Make sure the intervening directories are created
424 sys::Path dirs(I->getPath());
425 dirs.eraseComponent();
426 if (dirs.createDirectoryOnDisk(/*create_parents=*/true, ErrMsg))
430 // Open up a file stream for writing
431 std::ios::openmode io_mode = std::ios::out | std::ios::trunc |
433 std::ofstream file(I->getPath().str().c_str(), io_mode);
435 // Get the data and its length
436 const char* data = reinterpret_cast<const char*>(I->getData());
437 unsigned len = I->getSize();
440 file.write(data,len);
443 // If we're supposed to retain the original modification times, etc. do so
446 sys::PathWithStatus PWS(I->getPath());
447 PWS.setStatusInfoOnDisk(I->getFileStatus());
454 // doDelete - Implement the delete operation. This function deletes zero or more
455 // members from the archive. Note that if the count is specified, there should
456 // be no more than one path in the Paths list or else this algorithm breaks.
457 // That check is enforced in parseCommandLine (above).
459 doDelete(std::string* ErrMsg) {
460 if (buildPaths(false, ErrMsg))
464 unsigned countDown = Count;
465 for (Archive::iterator I = TheArchive->begin(), E = TheArchive->end();
467 if (std::find(Paths.begin(), Paths.end(), I->getPath()) != Paths.end()) {
468 if (countDown == 1) {
469 Archive::iterator J = I;
471 TheArchive->erase(J);
479 // We're done editting, reconstruct the archive.
480 if (TheArchive->writeToDisk(SymTable,TruncateNames,ErrMsg))
487 // doMore - Implement the move operation. This function re-arranges just the
488 // order of the archive members so that when the archive is written the move
489 // of the members is accomplished. Note the use of the RelPos variable to
490 // determine where the items should be moved to.
492 doMove(std::string* ErrMsg) {
493 if (buildPaths(false, ErrMsg))
496 // By default and convention the place to move members to is the end of the
498 Archive::iterator moveto_spot = TheArchive->end();
500 // However, if the relative positioning modifiers were used, we need to scan
501 // the archive to find the member in question. If we don't find it, its no
502 // crime, we just move to the end.
503 if (AddBefore || InsertBefore || AddAfter) {
504 for (Archive::iterator I = TheArchive->begin(), E= TheArchive->end();
506 if (RelPos == I->getPath().str()) {
518 // Keep a list of the paths remaining to be moved
519 std::set<std::string> remaining(Paths);
521 // Scan the archive again, this time looking for the members to move to the
523 for (Archive::iterator I = TheArchive->begin(), E= TheArchive->end();
524 I != E && !remaining.empty(); ++I ) {
525 std::set<std::string>::iterator found =
526 std::find(remaining.begin(),remaining.end(), I->getPath());
527 if (found != remaining.end()) {
528 if (I != moveto_spot)
529 TheArchive->splice(moveto_spot,*TheArchive,I);
530 remaining.erase(found);
534 // We're done editting, reconstruct the archive.
535 if (TheArchive->writeToDisk(SymTable,TruncateNames,ErrMsg))
542 // doQuickAppend - Implements the 'q' operation. This function just
543 // indiscriminantly adds the members to the archive and rebuilds it.
545 doQuickAppend(std::string* ErrMsg) {
546 // Get the list of paths to append.
547 if (buildPaths(true, ErrMsg))
552 // Append them quickly.
553 for (std::set<std::string>::iterator PI = Paths.begin(), PE = Paths.end();
555 if (TheArchive->addFileBefore(sys::Path(*PI),TheArchive->end(),ErrMsg))
559 // We're done editting, reconstruct the archive.
560 if (TheArchive->writeToDisk(SymTable,TruncateNames,ErrMsg))
567 // doReplaceOrInsert - Implements the 'r' operation. This function will replace
568 // any existing files or insert new ones into the archive.
570 doReplaceOrInsert(std::string* ErrMsg) {
572 // Build the list of files to be added/replaced.
573 if (buildPaths(true, ErrMsg))
578 // Keep track of the paths that remain to be inserted.
579 std::set<std::string> remaining(Paths);
581 // Default the insertion spot to the end of the archive
582 Archive::iterator insert_spot = TheArchive->end();
584 // Iterate over the archive contents
585 for (Archive::iterator I = TheArchive->begin(), E = TheArchive->end();
586 I != E && !remaining.empty(); ++I ) {
588 // Determine if this archive member matches one of the paths we're trying
591 std::set<std::string>::iterator found = remaining.end();
592 for (std::set<std::string>::iterator RI = remaining.begin(),
593 RE = remaining.end(); RI != RE; ++RI ) {
594 std::string compare(*RI);
595 if (TruncateNames && compare.length() > 15) {
596 const char* nm = compare.c_str();
597 unsigned len = compare.length();
598 size_t slashpos = compare.rfind('/');
599 if (slashpos != std::string::npos) {
605 compare.assign(nm,len);
607 if (compare == I->getPath().str()) {
613 if (found != remaining.end()) {
615 sys::PathWithStatus PwS(*found);
616 const sys::FileStatus *si = PwS.getFileStatus(false, &Err);
621 // Replace the item only if it is newer.
622 if (si->modTime > I->getModTime())
623 if (I->replaceWith(sys::Path(*found), ErrMsg))
626 // Replace the item regardless of time stamp
627 if (I->replaceWith(sys::Path(*found), ErrMsg))
631 // We purposefully ignore directories.
634 // Remove it from our "to do" list
635 remaining.erase(found);
638 // Determine if this is the place where we should insert
639 if ((AddBefore || InsertBefore) && RelPos == I->getPath().str())
641 else if (AddAfter && RelPos == I->getPath().str()) {
647 // If we didn't replace all the members, some will remain and need to be
648 // inserted at the previously computed insert-spot.
649 if (!remaining.empty()) {
650 for (std::set<std::string>::iterator PI = remaining.begin(),
651 PE = remaining.end(); PI != PE; ++PI) {
652 if (TheArchive->addFileBefore(sys::Path(*PI),insert_spot, ErrMsg))
657 // We're done editting, reconstruct the archive.
658 if (TheArchive->writeToDisk(SymTable,TruncateNames,ErrMsg))
665 // main - main program for llvm-ar .. see comments in the code
666 int main(int argc, char **argv) {
667 program_name = argv[0];
668 // Print a stack trace if we signal out.
669 sys::PrintStackTraceOnErrorSignal();
670 PrettyStackTraceProgram X(argc, argv);
671 LLVMContext &Context = getGlobalContext();
672 llvm_shutdown_obj Y; // Call llvm_shutdown() on exit.
674 // Have the command line options parsed and handle things
675 // like --help and --version.
676 cl::ParseCommandLineOptions(argc, argv,
677 "LLVM Archiver (llvm-ar)\n\n"
678 " This program archives bitcode files into single libraries\n"
683 // Do our own parsing of the command line because the CommandLine utility
684 // can't handle the grouped positional parameters without a dash.
685 ArchiveOperation Operation = parseCommandLine();
687 // Check the path name of the archive
688 sys::Path ArchivePath;
689 if (!ArchivePath.set(ArchiveName)) {
690 errs() << argv[0] << ": Archive name invalid: " << ArchiveName << "\n";
694 // Create or open the archive object.
696 if (llvm::sys::fs::exists(ArchivePath.str(), Exists) || !Exists) {
697 // Produce a warning if we should and we're creating the archive
699 errs() << argv[0] << ": creating " << ArchivePath.str() << "\n";
700 TheArchive = Archive::CreateEmpty(ArchivePath, Context);
701 TheArchive->writeToDisk();
704 TheArchive = Archive::OpenAndLoad(ArchivePath, Context, &Error);
705 if (TheArchive == 0) {
706 errs() << argv[0] << ": error loading '" << ArchivePath.str() << "': "
712 // Make sure we're not fooling ourselves.
713 assert(TheArchive && "Unable to instantiate the archive");
715 // Perform the operation
717 bool haveError = false;
719 case Print: haveError = doPrint(&ErrMsg); break;
720 case Delete: haveError = doDelete(&ErrMsg); break;
721 case Move: haveError = doMove(&ErrMsg); break;
722 case QuickAppend: haveError = doQuickAppend(&ErrMsg); break;
723 case ReplaceOrInsert: haveError = doReplaceOrInsert(&ErrMsg); break;
724 case DisplayTable: haveError = doDisplayTable(&ErrMsg); break;
725 case Extract: haveError = doExtract(&ErrMsg); break;
727 errs() << argv[0] << ": No operation was selected.\n";
731 errs() << argv[0] << ": " << ErrMsg << "\n";
738 // Return result code back to operating system.