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 InsertBefore = false; ///< 'i' modifier
95 bool OriginalDates = false; ///< 'o' modifier
96 bool SymTable = true; ///< 's' & 'S' modifiers
97 bool OnlyUpdate = false; ///< 'u' modifier
98 bool Verbose = false; ///< 'v' modifier
100 // Relative Positional Argument (for insert/move). This variable holds
101 // the name of the archive member to which the 'a', 'b' or 'i' modifier
102 // refers. Only one of 'a', 'b' or 'i' can be specified so we only need
106 // This variable holds the name of the archive file as given on the
108 std::string ArchiveName;
110 // This variable holds the list of member files to proecess, as given
111 // on the command line.
112 std::vector<std::string> Members;
114 // This variable holds the (possibly expanded) list of path objects that
115 // correspond to files we will
116 std::set<std::string> Paths;
118 // The Archive object to which all the editing operations will be sent.
119 Archive* TheArchive = 0;
121 // The name this program was invoked as.
122 static const char *program_name;
124 // show_help - Show the error message, the help message and exit.
125 LLVM_ATTRIBUTE_NORETURN static void
126 show_help(const std::string &msg) {
127 errs() << program_name << ": " << msg << "\n\n";
128 cl::PrintHelpMessage();
134 // fail - Show the error message and exit.
135 LLVM_ATTRIBUTE_NORETURN static void
136 fail(const std::string &msg) {
137 errs() << program_name << ": " << msg << "\n\n";
143 // getRelPos - Extract the member filename from the command line for
144 // the [relpos] argument associated with a, b, and i modifiers
146 if(RestOfArgs.size() == 0)
147 show_help("Expected [relpos] for a, b, or i modifier");
148 RelPos = RestOfArgs[0];
149 RestOfArgs.erase(RestOfArgs.begin());
152 // getArchive - Get the archive file name from the command line
154 if(RestOfArgs.size() == 0)
155 show_help("An archive name must be specified");
156 ArchiveName = RestOfArgs[0];
157 RestOfArgs.erase(RestOfArgs.begin());
160 // getMembers - Copy over remaining items in RestOfArgs to our Members vector
161 // This is just for clarity.
163 if(RestOfArgs.size() > 0)
164 Members = std::vector<std::string>(RestOfArgs);
167 // parseCommandLine - Parse the command line options as presented and return the
168 // operation specified. Process all modifiers and check to make sure that
169 // constraints on modifier/operation pairs have not been violated.
170 ArchiveOperation parseCommandLine() {
172 // Keep track of number of operations. We can only specify one
174 unsigned NumOperations = 0;
176 // Keep track of the number of positional modifiers (a,b,i). Only
177 // one can be specified.
178 unsigned NumPositional = 0;
180 // Keep track of which operation was requested
181 ArchiveOperation Operation;
183 for(unsigned i=0; i<Options.size(); ++i) {
185 case 'd': ++NumOperations; Operation = Delete; break;
186 case 'm': ++NumOperations; Operation = Move ; break;
187 case 'p': ++NumOperations; Operation = Print; break;
188 case 'q': ++NumOperations; Operation = QuickAppend; break;
189 case 'r': ++NumOperations; Operation = ReplaceOrInsert; break;
190 case 't': ++NumOperations; Operation = DisplayTable; break;
191 case 'x': ++NumOperations; Operation = Extract; break;
192 case 'c': Create = true; break;
193 case 'l': /* accepted but unused */ break;
194 case 'o': OriginalDates = true; break;
195 case 's': break; // Ignore for now.
196 case 'S': break; // Ignore for now.
197 case 'u': OnlyUpdate = true; break;
198 case 'v': Verbose = true; break;
215 cl::PrintHelpMessage();
219 // At this point, the next thing on the command line must be
223 // Everything on the command line at this point is a member.
226 // Perform various checks on the operation/modifier specification
227 // to make sure we are dealing with a legal request.
228 if (NumOperations == 0)
229 show_help("You must specify at least one of the operations");
230 if (NumOperations > 1)
231 show_help("Only one operation may be specified");
232 if (NumPositional > 1)
233 show_help("You may only specify one of a, b, and i modifiers");
234 if (AddAfter || AddBefore || InsertBefore) {
235 if (Operation != Move && Operation != ReplaceOrInsert)
236 show_help("The 'a', 'b' and 'i' modifiers can only be specified with "
237 "the 'm' or 'r' operations");
239 if (OriginalDates && Operation != Extract)
240 show_help("The 'o' modifier is only applicable to the 'x' operation");
241 if (OnlyUpdate && Operation != ReplaceOrInsert)
242 show_help("The 'u' modifier is only applicable to the 'r' operation");
244 // Return the parsed operation to the caller
248 // buildPaths - Convert the strings in the Members vector to sys::Path objects
249 // and make sure they are valid and exist exist. This check is only needed for
250 // the operations that add/replace files to the archive ('q' and 'r')
251 bool buildPaths(bool checkExistence, std::string* ErrMsg) {
252 for (unsigned i = 0; i < Members.size(); i++) {
253 std::string aPath = Members[i];
254 if (checkExistence) {
256 error_code EC = sys::fs::is_directory(aPath, IsDirectory);
258 fail(aPath + ": " + EC.message());
260 fail(aPath + " Is a directory");
270 // doPrint - Implements the 'p' operation. This function traverses the archive
271 // looking for members that match the path list. It is careful to uncompress
272 // things that should be and to skip bitcode files unless the 'k' modifier was
274 bool doPrint(std::string* ErrMsg) {
275 if (buildPaths(false, ErrMsg))
277 for (Archive::iterator I = TheArchive->begin(), E = TheArchive->end();
280 (std::find(Paths.begin(), Paths.end(), I->getPath()) != Paths.end())) {
281 const char *data = reinterpret_cast<const char *>(I->getData());
283 // Skip things that don't make sense to print
284 if (I->isSVR4SymbolTable() || I->isBSD4SymbolTable())
288 outs() << "Printing " << I->getPath().str() << "\n";
290 unsigned len = I->getSize();
291 outs().write(data, len);
297 // putMode - utility function for printing out the file mode when the 't'
298 // operation is in verbose mode.
300 printMode(unsigned mode) {
315 // doDisplayTable - Implement the 't' operation. This function prints out just
316 // the file names of each of the members. However, if verbose mode is requested
317 // ('v' modifier) then the file type, permission mode, user, group, size, and
318 // modification time are also printed.
320 doDisplayTable(std::string* ErrMsg) {
321 if (buildPaths(false, ErrMsg))
323 for (Archive::iterator I = TheArchive->begin(), E = TheArchive->end();
326 (std::find(Paths.begin(), Paths.end(), I->getPath()) != Paths.end())) {
328 unsigned mode = I->getMode();
329 printMode((mode >> 6) & 007);
330 printMode((mode >> 3) & 007);
331 printMode(mode & 007);
332 outs() << ' ' << I->getUser();
333 outs() << "/" << I->getGroup();
334 outs() << ' ' << format("%6u", I->getSize());
335 sys::TimeValue ModTime = I->getModTime();
336 outs() << " " << ModTime.str();
337 outs() << " " << I->getPath().str() << "\n";
339 outs() << I->getPath().str() << "\n";
346 // doExtract - Implement the 'x' operation. This function extracts files back to
349 doExtract(std::string* ErrMsg) {
350 if (buildPaths(false, ErrMsg))
352 for (Archive::iterator I = TheArchive->begin(), E = TheArchive->end();
355 (std::find(Paths.begin(), Paths.end(), I->getPath()) != Paths.end())) {
357 // Open up a file stream for writing
358 int OpenFlags = O_TRUNC | O_WRONLY | O_CREAT;
360 OpenFlags |= O_BINARY;
363 // Retain the original mode.
364 sys::fs::perms Mode = sys::fs::perms(I->getMode());
366 int FD = open(I->getPath().str().c_str(), OpenFlags, Mode);
371 raw_fd_ostream file(FD, false);
373 // Get the data and its length
374 const char* data = reinterpret_cast<const char*>(I->getData());
375 unsigned len = I->getSize();
378 file.write(data, len);
381 // If we're supposed to retain the original modification times, etc. do so
385 sys::fs::setLastModificationAndAccessTime(FD, I->getModTime());
396 // doDelete - Implement the delete operation. This function deletes zero or more
397 // members from the archive. Note that if the count is specified, there should
398 // be no more than one path in the Paths list or else this algorithm breaks.
399 // That check is enforced in parseCommandLine (above).
401 doDelete(std::string* ErrMsg) {
402 if (buildPaths(false, ErrMsg))
406 for (Archive::iterator I = TheArchive->begin(), E = TheArchive->end();
408 if (std::find(Paths.begin(), Paths.end(), I->getPath()) != Paths.end()) {
409 Archive::iterator J = I;
411 TheArchive->erase(J);
417 // We're done editting, reconstruct the archive.
418 if (TheArchive->writeToDisk(ErrMsg))
423 // doMore - Implement the move operation. This function re-arranges just the
424 // order of the archive members so that when the archive is written the move
425 // of the members is accomplished. Note the use of the RelPos variable to
426 // determine where the items should be moved to.
428 doMove(std::string* ErrMsg) {
429 if (buildPaths(false, ErrMsg))
432 // By default and convention the place to move members to is the end of the
434 Archive::iterator moveto_spot = TheArchive->end();
436 // However, if the relative positioning modifiers were used, we need to scan
437 // the archive to find the member in question. If we don't find it, its no
438 // crime, we just move to the end.
439 if (AddBefore || InsertBefore || AddAfter) {
440 for (Archive::iterator I = TheArchive->begin(), E= TheArchive->end();
442 if (RelPos == I->getPath().str()) {
454 // Keep a list of the paths remaining to be moved
455 std::set<std::string> remaining(Paths);
457 // Scan the archive again, this time looking for the members to move to the
459 for (Archive::iterator I = TheArchive->begin(), E= TheArchive->end();
460 I != E && !remaining.empty(); ++I ) {
461 std::set<std::string>::iterator found =
462 std::find(remaining.begin(),remaining.end(), I->getPath());
463 if (found != remaining.end()) {
464 if (I != moveto_spot)
465 TheArchive->splice(moveto_spot,*TheArchive,I);
466 remaining.erase(found);
470 // We're done editting, reconstruct the archive.
471 if (TheArchive->writeToDisk(ErrMsg))
476 // doQuickAppend - Implements the 'q' operation. This function just
477 // indiscriminantly adds the members to the archive and rebuilds it.
479 doQuickAppend(std::string* ErrMsg) {
480 // Get the list of paths to append.
481 if (buildPaths(true, ErrMsg))
486 // Append them quickly.
487 for (std::set<std::string>::iterator PI = Paths.begin(), PE = Paths.end();
489 if (TheArchive->addFileBefore(*PI, TheArchive->end(), ErrMsg))
493 // We're done editting, reconstruct the archive.
494 if (TheArchive->writeToDisk(ErrMsg))
499 // doReplaceOrInsert - Implements the 'r' operation. This function will replace
500 // any existing files or insert new ones into the archive.
502 doReplaceOrInsert(std::string* ErrMsg) {
504 // Build the list of files to be added/replaced.
505 if (buildPaths(true, ErrMsg))
510 // Keep track of the paths that remain to be inserted.
511 std::set<std::string> remaining(Paths);
513 // Default the insertion spot to the end of the archive
514 Archive::iterator insert_spot = TheArchive->end();
516 // Iterate over the archive contents
517 for (Archive::iterator I = TheArchive->begin(), E = TheArchive->end();
518 I != E && !remaining.empty(); ++I ) {
520 // Determine if this archive member matches one of the paths we're trying
523 std::set<std::string>::iterator found = remaining.end();
524 for (std::set<std::string>::iterator RI = remaining.begin(),
525 RE = remaining.end(); RI != RE; ++RI ) {
526 std::string compare(sys::path::filename(*RI));
527 if (compare == I->getPath().str()) {
533 if (found != remaining.end()) {
534 sys::fs::file_status Status;
535 error_code EC = sys::fs::status(*found, Status);
538 if (!sys::fs::is_directory(Status)) {
540 // Replace the item only if it is newer.
541 if (Status.getLastModificationTime() > I->getModTime())
542 if (I->replaceWith(*found, ErrMsg))
545 // Replace the item regardless of time stamp
546 if (I->replaceWith(*found, ErrMsg))
550 // We purposefully ignore directories.
553 // Remove it from our "to do" list
554 remaining.erase(found);
557 // Determine if this is the place where we should insert
558 if ((AddBefore || InsertBefore) && RelPos == I->getPath().str())
560 else if (AddAfter && RelPos == I->getPath().str()) {
566 // If we didn't replace all the members, some will remain and need to be
567 // inserted at the previously computed insert-spot.
568 if (!remaining.empty()) {
569 for (std::set<std::string>::iterator PI = remaining.begin(),
570 PE = remaining.end(); PI != PE; ++PI) {
571 if (TheArchive->addFileBefore(*PI, insert_spot, ErrMsg))
576 // We're done editting, reconstruct the archive.
577 if (TheArchive->writeToDisk(ErrMsg))
582 bool shouldCreateArchive(ArchiveOperation Op) {
592 case ReplaceOrInsert:
596 llvm_unreachable("Missing entry in covered switch.");
599 // main - main program for llvm-ar .. see comments in the code
600 int main(int argc, char **argv) {
601 program_name = argv[0];
602 // Print a stack trace if we signal out.
603 sys::PrintStackTraceOnErrorSignal();
604 PrettyStackTraceProgram X(argc, argv);
605 LLVMContext &Context = getGlobalContext();
606 llvm_shutdown_obj Y; // Call llvm_shutdown() on exit.
608 // Have the command line options parsed and handle things
609 // like --help and --version.
610 cl::ParseCommandLineOptions(argc, argv,
611 "LLVM Archiver (llvm-ar)\n\n"
612 " This program archives bitcode files into single libraries\n"
617 // Do our own parsing of the command line because the CommandLine utility
618 // can't handle the grouped positional parameters without a dash.
619 ArchiveOperation Operation = parseCommandLine();
621 // Create or open the archive object.
622 if (shouldCreateArchive(Operation) && !llvm::sys::fs::exists(ArchiveName)) {
623 // Produce a warning if we should and we're creating the archive
625 errs() << argv[0] << ": creating " << ArchiveName << "\n";
626 TheArchive = Archive::CreateEmpty(ArchiveName, Context);
627 TheArchive->writeToDisk();
632 TheArchive = Archive::OpenAndLoad(ArchiveName, Context, &Error);
633 if (TheArchive == 0) {
634 errs() << argv[0] << ": error loading '" << ArchiveName << "': "
640 // Make sure we're not fooling ourselves.
641 assert(TheArchive && "Unable to instantiate the archive");
643 // Perform the operation
645 bool haveError = false;
647 case Print: haveError = doPrint(&ErrMsg); break;
648 case Delete: haveError = doDelete(&ErrMsg); break;
649 case Move: haveError = doMove(&ErrMsg); break;
650 case QuickAppend: haveError = doQuickAppend(&ErrMsg); break;
651 case ReplaceOrInsert: haveError = doReplaceOrInsert(&ErrMsg); break;
652 case DisplayTable: haveError = doDisplayTable(&ErrMsg); break;
653 case Extract: haveError = doExtract(&ErrMsg); break;
656 errs() << argv[0] << ": " << ErrMsg << "\n";
663 // Return result code back to operating system.