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"
30 #if !defined(_MSC_VER) && !defined(__MINGW32__)
38 // Option for compatibility with AIX, not used but must allow it to be present.
40 X32Option ("X32_64", cl::Hidden,
41 cl::desc("Ignored option for compatibility with AIX"));
43 // llvm-ar operation code and modifier flags. This must come first.
44 static cl::opt<std::string>
45 Options(cl::Positional, cl::Required, cl::desc("{operation}[modifiers]..."));
47 // llvm-ar remaining positional arguments.
48 static cl::list<std::string>
49 RestOfArgs(cl::Positional, cl::OneOrMore,
50 cl::desc("[relpos] [count] <archive-file> [members]..."));
52 // MoreHelp - Provide additional help output explaining the operations and
53 // modifiers of llvm-ar. This object instructs the CommandLine library
54 // to print the text of the constructor when the --help option is given.
55 static cl::extrahelp MoreHelp(
57 " d[NsS] - delete file(s) from the archive\n"
58 " m[abiSs] - move file(s) in the archive\n"
59 " p[kN] - print file(s) found in the archive\n"
60 " q[ufsS] - quick append file(s) to the archive\n"
61 " r[abfiuRsS] - replace or insert file(s) into the archive\n"
62 " t - display contents of archive\n"
63 " x[No] - extract file(s) from the archive\n"
64 "\nMODIFIERS (operation specific):\n"
65 " [a] - put file(s) after [relpos]\n"
66 " [b] - put file(s) before [relpos] (same as [i])\n"
67 " [i] - put file(s) before [relpos] (same as [b])\n"
68 " [N] - use instance [count] of name\n"
69 " [o] - preserve original dates\n"
70 " [s] - create an archive index (cf. ranlib)\n"
71 " [S] - do not build a symbol table\n"
72 " [u] - update only files newer than archive contents\n"
73 "\nMODIFIERS (generic):\n"
74 " [c] - do not warn if the library had to be created\n"
75 " [v] - be verbose about actions taken\n"
78 // This enumeration delineates the kinds of operations on an archive
79 // that are permitted.
80 enum ArchiveOperation {
81 Print, ///< Print the contents of the archive
82 Delete, ///< Delete the specified members
83 Move, ///< Move members to end or as given by {a,b,i} modifiers
84 QuickAppend, ///< Quickly append to end of archive
85 ReplaceOrInsert, ///< Replace or Insert members
86 DisplayTable, ///< Display the table of contents
87 Extract ///< Extract files back to file system
90 // Modifiers to follow operation to vary behavior
91 bool AddAfter = false; ///< 'a' modifier
92 bool AddBefore = false; ///< 'b' modifier
93 bool Create = false; ///< 'c' modifier
94 bool OriginalDates = false; ///< 'o' modifier
95 bool SymTable = true; ///< 's' & 'S' modifiers
96 bool OnlyUpdate = false; ///< 'u' modifier
97 bool Verbose = false; ///< 'v' modifier
99 // Relative Positional Argument (for insert/move). This variable holds
100 // the name of the archive member to which the 'a', 'b' or 'i' modifier
101 // refers. Only one of 'a', 'b' or 'i' can be specified so we only need
105 // This variable holds the name of the archive file as given on the
107 std::string ArchiveName;
109 // This variable holds the list of member files to proecess, as given
110 // on the command line.
111 std::vector<std::string> Members;
113 // This variable holds the (possibly expanded) list of path objects that
114 // correspond to files we will
115 std::set<std::string> Paths;
117 // The Archive object to which all the editing operations will be sent.
118 Archive* TheArchive = 0;
120 // The name this program was invoked as.
121 static const char *program_name;
123 // show_help - Show the error message, the help message and exit.
124 LLVM_ATTRIBUTE_NORETURN static void
125 show_help(const std::string &msg) {
126 errs() << program_name << ": " << msg << "\n\n";
127 cl::PrintHelpMessage();
133 // fail - Show the error message and exit.
134 LLVM_ATTRIBUTE_NORETURN static void
135 fail(const std::string &msg) {
136 errs() << program_name << ": " << msg << "\n\n";
142 // getRelPos - Extract the member filename from the command line for
143 // the [relpos] argument associated with a, b, and i modifiers
145 if(RestOfArgs.size() == 0)
146 show_help("Expected [relpos] for a, b, or i modifier");
147 RelPos = RestOfArgs[0];
148 RestOfArgs.erase(RestOfArgs.begin());
151 // getArchive - Get the archive file name from the command line
153 if(RestOfArgs.size() == 0)
154 show_help("An archive name must be specified");
155 ArchiveName = RestOfArgs[0];
156 RestOfArgs.erase(RestOfArgs.begin());
159 // getMembers - Copy over remaining items in RestOfArgs to our Members vector
160 // This is just for clarity.
162 if(RestOfArgs.size() > 0)
163 Members = std::vector<std::string>(RestOfArgs);
166 // parseCommandLine - Parse the command line options as presented and return the
167 // operation specified. Process all modifiers and check to make sure that
168 // constraints on modifier/operation pairs have not been violated.
169 ArchiveOperation parseCommandLine() {
171 // Keep track of number of operations. We can only specify one
173 unsigned NumOperations = 0;
175 // Keep track of the number of positional modifiers (a,b,i). Only
176 // one can be specified.
177 unsigned NumPositional = 0;
179 // Keep track of which operation was requested
180 ArchiveOperation Operation;
182 for(unsigned i=0; i<Options.size(); ++i) {
184 case 'd': ++NumOperations; Operation = Delete; break;
185 case 'm': ++NumOperations; Operation = Move ; break;
186 case 'p': ++NumOperations; Operation = Print; break;
187 case 'q': ++NumOperations; Operation = QuickAppend; break;
188 case 'r': ++NumOperations; Operation = ReplaceOrInsert; break;
189 case 't': ++NumOperations; Operation = DisplayTable; break;
190 case 'x': ++NumOperations; Operation = Extract; break;
191 case 'c': Create = true; break;
192 case 'l': /* accepted but unused */ break;
193 case 'o': OriginalDates = true; break;
194 case 's': break; // Ignore for now.
195 case 'S': break; // Ignore for now.
196 case 'u': OnlyUpdate = true; break;
197 case 'v': Verbose = true; break;
214 cl::PrintHelpMessage();
218 // At this point, the next thing on the command line must be
222 // Everything on the command line at this point is a member.
225 // Perform various checks on the operation/modifier specification
226 // to make sure we are dealing with a legal request.
227 if (NumOperations == 0)
228 show_help("You must specify at least one of the operations");
229 if (NumOperations > 1)
230 show_help("Only one operation may be specified");
231 if (NumPositional > 1)
232 show_help("You may only specify one of a, b, and i modifiers");
233 if (AddAfter || AddBefore) {
234 if (Operation != Move && Operation != ReplaceOrInsert)
235 show_help("The 'a', 'b' and 'i' modifiers can only be specified with "
236 "the 'm' or 'r' operations");
238 if (OriginalDates && Operation != Extract)
239 show_help("The 'o' modifier is only applicable to the 'x' operation");
240 if (OnlyUpdate && Operation != ReplaceOrInsert)
241 show_help("The 'u' modifier is only applicable to the 'r' operation");
243 // Return the parsed operation to the caller
247 // buildPaths - Convert the strings in the Members vector to sys::Path objects
248 // and make sure they are valid and exist exist. This check is only needed for
249 // the operations that add/replace files to the archive ('q' and 'r')
250 bool buildPaths(bool checkExistence, std::string* ErrMsg) {
251 for (unsigned i = 0; i < Members.size(); i++) {
252 std::string aPath = Members[i];
253 if (checkExistence) {
255 error_code EC = sys::fs::is_directory(aPath, IsDirectory);
257 fail(aPath + ": " + EC.message());
259 fail(aPath + " Is a directory");
269 // doPrint - Implements the 'p' operation. This function traverses the archive
270 // looking for members that match the path list. It is careful to uncompress
271 // things that should be and to skip bitcode files unless the 'k' modifier was
273 bool doPrint(std::string* ErrMsg) {
274 if (buildPaths(false, ErrMsg))
276 for (Archive::iterator I = TheArchive->begin(), E = TheArchive->end();
279 (std::find(Paths.begin(), Paths.end(), I->getPath()) != Paths.end())) {
280 const char *data = reinterpret_cast<const char *>(I->getData());
282 // Skip things that don't make sense to print
283 if (I->isSVR4SymbolTable() || I->isBSD4SymbolTable())
287 outs() << "Printing " << I->getPath().str() << "\n";
289 unsigned len = I->getSize();
290 outs().write(data, len);
296 // putMode - utility function for printing out the file mode when the 't'
297 // operation is in verbose mode.
299 printMode(unsigned mode) {
314 // doDisplayTable - Implement the 't' operation. This function prints out just
315 // the file names of each of the members. However, if verbose mode is requested
316 // ('v' modifier) then the file type, permission mode, user, group, size, and
317 // modification time are also printed.
319 doDisplayTable(std::string* ErrMsg) {
320 if (buildPaths(false, ErrMsg))
322 for (Archive::iterator I = TheArchive->begin(), E = TheArchive->end();
325 (std::find(Paths.begin(), Paths.end(), I->getPath()) != Paths.end())) {
327 unsigned mode = I->getMode();
328 printMode((mode >> 6) & 007);
329 printMode((mode >> 3) & 007);
330 printMode(mode & 007);
331 outs() << ' ' << I->getUser();
332 outs() << "/" << I->getGroup();
333 outs() << ' ' << format("%6u", I->getSize());
334 sys::TimeValue ModTime = I->getModTime();
335 outs() << " " << ModTime.str();
336 outs() << " " << I->getPath().str() << "\n";
338 outs() << I->getPath().str() << "\n";
345 // doExtract - Implement the 'x' operation. This function extracts files back to
348 doExtract(std::string* ErrMsg) {
349 if (buildPaths(false, ErrMsg))
351 for (Archive::iterator I = TheArchive->begin(), E = TheArchive->end();
354 (std::find(Paths.begin(), Paths.end(), I->getPath()) != Paths.end())) {
356 // Open up a file stream for writing
357 int OpenFlags = O_TRUNC | O_WRONLY | O_CREAT;
359 OpenFlags |= O_BINARY;
362 // Retain the original mode.
363 sys::fs::perms Mode = sys::fs::perms(I->getMode());
365 int FD = open(I->getPath().str().c_str(), OpenFlags, Mode);
370 raw_fd_ostream file(FD, false);
372 // Get the data and its length
373 const char* data = reinterpret_cast<const char*>(I->getData());
374 unsigned len = I->getSize();
377 file.write(data, len);
380 // If we're supposed to retain the original modification times, etc. do so
384 sys::fs::setLastModificationAndAccessTime(FD, I->getModTime());
395 // doDelete - Implement the delete operation. This function deletes zero or more
396 // members from the archive. Note that if the count is specified, there should
397 // be no more than one path in the Paths list or else this algorithm breaks.
398 // That check is enforced in parseCommandLine (above).
400 doDelete(std::string* ErrMsg) {
401 if (buildPaths(false, ErrMsg))
405 for (Archive::iterator I = TheArchive->begin(), E = TheArchive->end();
407 if (std::find(Paths.begin(), Paths.end(), I->getPath()) != Paths.end()) {
408 Archive::iterator J = I;
410 TheArchive->erase(J);
416 // We're done editting, reconstruct the archive.
417 if (TheArchive->writeToDisk(ErrMsg))
422 // doMore - Implement the move operation. This function re-arranges just the
423 // order of the archive members so that when the archive is written the move
424 // of the members is accomplished. Note the use of the RelPos variable to
425 // determine where the items should be moved to.
427 doMove(std::string* ErrMsg) {
428 if (buildPaths(false, ErrMsg))
431 // By default and convention the place to move members to is the end of the
433 Archive::iterator moveto_spot = TheArchive->end();
435 // However, if the relative positioning modifiers were used, we need to scan
436 // the archive to find the member in question. If we don't find it, its no
437 // crime, we just move to the end.
438 if (AddBefore || AddAfter) {
439 for (Archive::iterator I = TheArchive->begin(), E= TheArchive->end();
441 if (RelPos == I->getPath().str()) {
453 // Keep a list of the paths remaining to be moved
454 std::set<std::string> remaining(Paths);
456 // Scan the archive again, this time looking for the members to move to the
458 for (Archive::iterator I = TheArchive->begin(), E= TheArchive->end();
459 I != E && !remaining.empty(); ++I ) {
460 std::set<std::string>::iterator found =
461 std::find(remaining.begin(),remaining.end(), I->getPath());
462 if (found != remaining.end()) {
463 if (I != moveto_spot)
464 TheArchive->splice(moveto_spot,*TheArchive,I);
465 remaining.erase(found);
469 // We're done editting, reconstruct the archive.
470 if (TheArchive->writeToDisk(ErrMsg))
475 // doQuickAppend - Implements the 'q' operation. This function just
476 // indiscriminantly adds the members to the archive and rebuilds it.
478 doQuickAppend(std::string* ErrMsg) {
479 // Get the list of paths to append.
480 if (buildPaths(true, ErrMsg))
485 // Append them quickly.
486 for (std::set<std::string>::iterator PI = Paths.begin(), PE = Paths.end();
488 if (TheArchive->addFileBefore(*PI, TheArchive->end(), ErrMsg))
492 // We're done editting, reconstruct the archive.
493 if (TheArchive->writeToDisk(ErrMsg))
498 // doReplaceOrInsert - Implements the 'r' operation. This function will replace
499 // any existing files or insert new ones into the archive.
501 doReplaceOrInsert(std::string* ErrMsg) {
503 // Build the list of files to be added/replaced.
504 if (buildPaths(true, ErrMsg))
509 // Keep track of the paths that remain to be inserted.
510 std::set<std::string> remaining(Paths);
512 // Default the insertion spot to the end of the archive
513 Archive::iterator insert_spot = TheArchive->end();
515 // Iterate over the archive contents
516 for (Archive::iterator I = TheArchive->begin(), E = TheArchive->end();
517 I != E && !remaining.empty(); ++I ) {
519 // Determine if this archive member matches one of the paths we're trying
522 std::set<std::string>::iterator found = remaining.end();
523 for (std::set<std::string>::iterator RI = remaining.begin(),
524 RE = remaining.end(); RI != RE; ++RI ) {
525 std::string compare(sys::path::filename(*RI));
526 if (compare == I->getPath().str()) {
532 if (found != remaining.end()) {
533 sys::fs::file_status Status;
534 error_code EC = sys::fs::status(*found, Status);
537 if (!sys::fs::is_directory(Status)) {
539 // Replace the item only if it is newer.
540 if (Status.getLastModificationTime() > I->getModTime())
541 if (I->replaceWith(*found, ErrMsg))
544 // Replace the item regardless of time stamp
545 if (I->replaceWith(*found, ErrMsg))
549 // We purposefully ignore directories.
552 // Remove it from our "to do" list
553 remaining.erase(found);
556 // Determine if this is the place where we should insert
557 if (AddBefore && RelPos == I->getPath().str())
559 else if (AddAfter && RelPos == I->getPath().str()) {
565 // If we didn't replace all the members, some will remain and need to be
566 // inserted at the previously computed insert-spot.
567 if (!remaining.empty()) {
568 for (std::set<std::string>::iterator PI = remaining.begin(),
569 PE = remaining.end(); PI != PE; ++PI) {
570 if (TheArchive->addFileBefore(*PI, insert_spot, ErrMsg))
575 // We're done editting, reconstruct the archive.
576 if (TheArchive->writeToDisk(ErrMsg))
581 bool shouldCreateArchive(ArchiveOperation Op) {
591 case ReplaceOrInsert:
595 llvm_unreachable("Missing entry in covered switch.");
598 // main - main program for llvm-ar .. see comments in the code
599 int main(int argc, char **argv) {
600 program_name = argv[0];
601 // Print a stack trace if we signal out.
602 sys::PrintStackTraceOnErrorSignal();
603 PrettyStackTraceProgram X(argc, argv);
604 LLVMContext &Context = getGlobalContext();
605 llvm_shutdown_obj Y; // Call llvm_shutdown() on exit.
607 // Have the command line options parsed and handle things
608 // like --help and --version.
609 cl::ParseCommandLineOptions(argc, argv,
610 "LLVM Archiver (llvm-ar)\n\n"
611 " This program archives bitcode files into single libraries\n"
616 // Do our own parsing of the command line because the CommandLine utility
617 // can't handle the grouped positional parameters without a dash.
618 ArchiveOperation Operation = parseCommandLine();
620 // Create or open the archive object.
621 if (shouldCreateArchive(Operation) && !llvm::sys::fs::exists(ArchiveName)) {
622 // Produce a warning if we should and we're creating the archive
624 errs() << argv[0] << ": creating " << ArchiveName << "\n";
625 TheArchive = Archive::CreateEmpty(ArchiveName, Context);
626 TheArchive->writeToDisk();
631 TheArchive = Archive::OpenAndLoad(ArchiveName, Context, &Error);
632 if (TheArchive == 0) {
633 errs() << argv[0] << ": error loading '" << ArchiveName << "': "
639 // Make sure we're not fooling ourselves.
640 assert(TheArchive && "Unable to instantiate the archive");
642 // Perform the operation
644 bool haveError = false;
646 case Print: haveError = doPrint(&ErrMsg); break;
647 case Delete: haveError = doDelete(&ErrMsg); break;
648 case Move: haveError = doMove(&ErrMsg); break;
649 case QuickAppend: haveError = doQuickAppend(&ErrMsg); break;
650 case ReplaceOrInsert: haveError = doReplaceOrInsert(&ErrMsg); break;
651 case DisplayTable: haveError = doDisplayTable(&ErrMsg); break;
652 case Extract: haveError = doExtract(&ErrMsg); break;
655 errs() << argv[0] << ": " << ErrMsg << "\n";
662 // Return result code back to operating system.