//===-- llvm-ar.cpp - LLVM archive librarian utility ----------------------===// // // The LLVM Compiler Infrastructure // // This file is distributed under the University of Illinois Open Source // License. See LICENSE.TXT for details. // //===----------------------------------------------------------------------===// // // Builds up (relatively) standard unix archive files (.a) containing LLVM // bitcode or other files. // //===----------------------------------------------------------------------===// #include "llvm/IR/LLVMContext.h" #include "llvm/IR/Module.h" #include "llvm/Object/Archive.h" #include "llvm/Object/ObjectFile.h" #include "llvm/Support/CommandLine.h" #include "llvm/Support/FileSystem.h" #include "llvm/Support/Format.h" #include "llvm/Support/ManagedStatic.h" #include "llvm/Support/MemoryBuffer.h" #include "llvm/Support/PrettyStackTrace.h" #include "llvm/Support/Signals.h" #include "llvm/Support/ToolOutputFile.h" #include "llvm/Support/raw_ostream.h" #include #include #include #if !defined(_MSC_VER) && !defined(__MINGW32__) #include #else #include #endif using namespace llvm; // The name this program was invoked as. static StringRef ToolName; static const char *TemporaryOutput; static int TmpArchiveFD = -1; // fail - Show the error message and exit. LLVM_ATTRIBUTE_NORETURN static void fail(Twine Error) { outs() << ToolName << ": " << Error << ".\n"; if (TmpArchiveFD != -1) close(TmpArchiveFD); if (TemporaryOutput) sys::fs::remove(TemporaryOutput); exit(1); } static void failIfError(error_code EC, Twine Context = "") { if (!EC) return; std::string ContextStr = Context.str(); if (ContextStr == "") fail(EC.message()); fail(Context + ": " + EC.message()); } // llvm-ar/llvm-ranlib remaining positional arguments. static cl::list RestOfArgs(cl::Positional, cl::OneOrMore, cl::desc("[relpos] [count] [members]...")); std::string Options; // MoreHelp - Provide additional help output explaining the operations and // modifiers of llvm-ar. This object instructs the CommandLine library // to print the text of the constructor when the --help option is given. static cl::extrahelp MoreHelp( "\nOPERATIONS:\n" " d[NsS] - delete file(s) from the archive\n" " m[abiSs] - move file(s) in the archive\n" " p[kN] - print file(s) found in the archive\n" " q[ufsS] - quick append file(s) to the archive\n" " r[abfiuRsS] - replace or insert file(s) into the archive\n" " t - display contents of archive\n" " x[No] - extract file(s) from the archive\n" "\nMODIFIERS (operation specific):\n" " [a] - put file(s) after [relpos]\n" " [b] - put file(s) before [relpos] (same as [i])\n" " [i] - put file(s) before [relpos] (same as [b])\n" " [N] - use instance [count] of name\n" " [o] - preserve original dates\n" " [s] - create an archive index (cf. ranlib)\n" " [S] - do not build a symbol table\n" " [u] - update only files newer than archive contents\n" "\nMODIFIERS (generic):\n" " [c] - do not warn if the library had to be created\n" " [v] - be verbose about actions taken\n" ); // This enumeration delineates the kinds of operations on an archive // that are permitted. enum ArchiveOperation { Print, ///< Print the contents of the archive Delete, ///< Delete the specified members Move, ///< Move members to end or as given by {a,b,i} modifiers QuickAppend, ///< Quickly append to end of archive ReplaceOrInsert, ///< Replace or Insert members DisplayTable, ///< Display the table of contents Extract, ///< Extract files back to file system CreateSymTab ///< Create a symbol table in an existing archive }; // Modifiers to follow operation to vary behavior static bool AddAfter = false; ///< 'a' modifier static bool AddBefore = false; ///< 'b' modifier static bool Create = false; ///< 'c' modifier static bool OriginalDates = false; ///< 'o' modifier static bool OnlyUpdate = false; ///< 'u' modifier static bool Verbose = false; ///< 'v' modifier static bool Symtab = true; ///< 's' modifier // Relative Positional Argument (for insert/move). This variable holds // the name of the archive member to which the 'a', 'b' or 'i' modifier // refers. Only one of 'a', 'b' or 'i' can be specified so we only need // one variable. static std::string RelPos; // This variable holds the name of the archive file as given on the // command line. static std::string ArchiveName; // This variable holds the list of member files to proecess, as given // on the command line. static std::vector Members; // show_help - Show the error message, the help message and exit. LLVM_ATTRIBUTE_NORETURN static void show_help(const std::string &msg) { errs() << ToolName << ": " << msg << "\n\n"; cl::PrintHelpMessage(); std::exit(1); } // getRelPos - Extract the member filename from the command line for // the [relpos] argument associated with a, b, and i modifiers static void getRelPos() { if(RestOfArgs.size() == 0) show_help("Expected [relpos] for a, b, or i modifier"); RelPos = RestOfArgs[0]; RestOfArgs.erase(RestOfArgs.begin()); } static void getOptions() { if(RestOfArgs.size() == 0) show_help("Expected options"); Options = RestOfArgs[0]; RestOfArgs.erase(RestOfArgs.begin()); } // getArchive - Get the archive file name from the command line static void getArchive() { if(RestOfArgs.size() == 0) show_help("An archive name must be specified"); ArchiveName = RestOfArgs[0]; RestOfArgs.erase(RestOfArgs.begin()); } // getMembers - Copy over remaining items in RestOfArgs to our Members vector // This is just for clarity. static void getMembers() { if(RestOfArgs.size() > 0) Members = std::vector(RestOfArgs); } // parseCommandLine - Parse the command line options as presented and return the // operation specified. Process all modifiers and check to make sure that // constraints on modifier/operation pairs have not been violated. static ArchiveOperation parseCommandLine() { getOptions(); // Keep track of number of operations. We can only specify one // per execution. unsigned NumOperations = 0; // Keep track of the number of positional modifiers (a,b,i). Only // one can be specified. unsigned NumPositional = 0; // Keep track of which operation was requested ArchiveOperation Operation; bool MaybeJustCreateSymTab = false; for(unsigned i=0; i 1) show_help("Only one operation may be specified"); if (NumPositional > 1) show_help("You may only specify one of a, b, and i modifiers"); if (AddAfter || AddBefore) { if (Operation != Move && Operation != ReplaceOrInsert) show_help("The 'a', 'b' and 'i' modifiers can only be specified with " "the 'm' or 'r' operations"); } if (OriginalDates && Operation != Extract) show_help("The 'o' modifier is only applicable to the 'x' operation"); if (OnlyUpdate && Operation != ReplaceOrInsert) show_help("The 'u' modifier is only applicable to the 'r' operation"); // Return the parsed operation to the caller return Operation; } // Implements the 'p' operation. This function traverses the archive // looking for members that match the path list. static void doPrint(StringRef Name, object::Archive::child_iterator I) { if (Verbose) outs() << "Printing " << Name << "\n"; StringRef Data = I->getBuffer(); outs().write(Data.data(), Data.size()); } // putMode - utility function for printing out the file mode when the 't' // operation is in verbose mode. static void printMode(unsigned mode) { if (mode & 004) outs() << "r"; else outs() << "-"; if (mode & 002) outs() << "w"; else outs() << "-"; if (mode & 001) outs() << "x"; else outs() << "-"; } // Implement the 't' operation. This function prints out just // the file names of each of the members. However, if verbose mode is requested // ('v' modifier) then the file type, permission mode, user, group, size, and // modification time are also printed. static void doDisplayTable(StringRef Name, object::Archive::child_iterator I) { if (Verbose) { sys::fs::perms Mode = I->getAccessMode(); printMode((Mode >> 6) & 007); printMode((Mode >> 3) & 007); printMode(Mode & 007); outs() << ' ' << I->getUID(); outs() << '/' << I->getGID(); outs() << ' ' << format("%6llu", I->getSize()); outs() << ' ' << I->getLastModified().str(); outs() << ' '; } outs() << Name << "\n"; } // Implement the 'x' operation. This function extracts files back to the file // system. static void doExtract(StringRef Name, object::Archive::child_iterator I) { // Retain the original mode. sys::fs::perms Mode = I->getAccessMode(); SmallString<128> Storage = Name; int FD; failIfError( sys::fs::openFileForWrite(Storage.c_str(), FD, sys::fs::F_Binary, Mode), Storage.c_str()); { raw_fd_ostream file(FD, false); // Get the data and its length StringRef Data = I->getBuffer(); // Write the data. file.write(Data.data(), Data.size()); } // If we're supposed to retain the original modification times, etc. do so // now. if (OriginalDates) failIfError( sys::fs::setLastModificationAndAccessTime(FD, I->getLastModified())); if (close(FD)) fail("Could not close the file"); } static bool shouldCreateArchive(ArchiveOperation Op) { switch (Op) { case Print: case Delete: case Move: case DisplayTable: case Extract: case CreateSymTab: return false; case QuickAppend: case ReplaceOrInsert: return true; } llvm_unreachable("Missing entry in covered switch."); } static void performReadOperation(ArchiveOperation Operation, object::Archive *OldArchive) { for (object::Archive::child_iterator I = OldArchive->begin_children(), E = OldArchive->end_children(); I != E; ++I) { StringRef Name; failIfError(I->getName(Name)); if (!Members.empty() && std::find(Members.begin(), Members.end(), Name) == Members.end()) continue; switch (Operation) { default: llvm_unreachable("Not a read operation"); case Print: doPrint(Name, I); break; case DisplayTable: doDisplayTable(Name, I); break; case Extract: doExtract(Name, I); break; } } } namespace { class NewArchiveIterator { bool IsNewMember; StringRef Name; object::Archive::child_iterator OldI; std::string NewFilename; public: NewArchiveIterator(object::Archive::child_iterator I, StringRef Name); NewArchiveIterator(std::string *I, StringRef Name); NewArchiveIterator(); bool isNewMember() const; object::Archive::child_iterator getOld() const; const char *getNew() const; StringRef getName() const; }; } NewArchiveIterator::NewArchiveIterator() {} NewArchiveIterator::NewArchiveIterator(object::Archive::child_iterator I, StringRef Name) : IsNewMember(false), Name(Name), OldI(I) {} NewArchiveIterator::NewArchiveIterator(std::string *NewFilename, StringRef Name) : IsNewMember(true), Name(Name), NewFilename(*NewFilename) {} StringRef NewArchiveIterator::getName() const { return Name; } bool NewArchiveIterator::isNewMember() const { return IsNewMember; } object::Archive::child_iterator NewArchiveIterator::getOld() const { assert(!IsNewMember); return OldI; } const char *NewArchiveIterator::getNew() const { assert(IsNewMember); return NewFilename.c_str(); } template void addMember(std::vector &Members, T I, StringRef Name, int Pos = -1) { NewArchiveIterator NI(I, Name); if (Pos == -1) Members.push_back(NI); else Members[Pos] = NI; } namespace { class HasName { StringRef Name; public: HasName(StringRef Name) : Name(Name) {} bool operator()(StringRef Path) { return Name == sys::path::filename(Path); } }; } enum InsertAction { IA_AddOldMember, IA_AddNewMeber, IA_Delete, IA_MoveOldMember, IA_MoveNewMember }; static InsertAction computeInsertAction(ArchiveOperation Operation, object::Archive::child_iterator I, StringRef Name, std::vector::iterator &Pos) { if (Operation == QuickAppend || Members.empty()) return IA_AddOldMember; std::vector::iterator MI = std::find_if(Members.begin(), Members.end(), HasName(Name)); if (MI == Members.end()) return IA_AddOldMember; Pos = MI; if (Operation == Delete) return IA_Delete; if (Operation == Move) return IA_MoveOldMember; if (Operation == ReplaceOrInsert) { StringRef PosName = sys::path::filename(RelPos); if (!OnlyUpdate) { if (PosName.empty()) return IA_AddNewMeber; return IA_MoveNewMember; } // We could try to optimize this to a fstat, but it is not a common // operation. sys::fs::file_status Status; failIfError(sys::fs::status(*MI, Status)); if (Status.getLastModificationTime() < I->getLastModified()) { if (PosName.empty()) return IA_AddOldMember; return IA_MoveOldMember; } if (PosName.empty()) return IA_AddNewMeber; return IA_MoveNewMember; } llvm_unreachable("No such operation"); } // We have to walk this twice and computing it is not trivial, so creating an // explicit std::vector is actually fairly efficient. static std::vector computeNewArchiveMembers(ArchiveOperation Operation, object::Archive *OldArchive) { std::vector Ret; std::vector Moved; int InsertPos = -1; StringRef PosName = sys::path::filename(RelPos); if (OldArchive) { for (object::Archive::child_iterator I = OldArchive->begin_children(), E = OldArchive->end_children(); I != E; ++I) { int Pos = Ret.size(); StringRef Name; failIfError(I->getName(Name)); if (Name == PosName) { assert(AddAfter || AddBefore); if (AddBefore) InsertPos = Pos; else InsertPos = Pos + 1; } std::vector::iterator MemberI = Members.end(); InsertAction Action = computeInsertAction(Operation, I, Name, MemberI); switch (Action) { case IA_AddOldMember: addMember(Ret, I, Name); break; case IA_AddNewMeber: addMember(Ret, &*MemberI, Name); break; case IA_Delete: break; case IA_MoveOldMember: addMember(Moved, I, Name); break; case IA_MoveNewMember: addMember(Moved, &*MemberI, Name); break; } if (MemberI != Members.end()) Members.erase(MemberI); } } if (Operation == Delete) return Ret; if (!RelPos.empty() && InsertPos == -1) fail("Insertion point not found"); if (RelPos.empty()) InsertPos = Ret.size(); assert(unsigned(InsertPos) <= Ret.size()); Ret.insert(Ret.begin() + InsertPos, Moved.begin(), Moved.end()); Ret.insert(Ret.begin() + InsertPos, Members.size(), NewArchiveIterator()); int Pos = InsertPos; for (std::vector::iterator I = Members.begin(), E = Members.end(); I != E; ++I, ++Pos) { StringRef Name = sys::path::filename(*I); addMember(Ret, &*I, Name, Pos); } return Ret; } template static void printWithSpacePadding(raw_ostream &OS, T Data, unsigned Size) { uint64_t OldPos = OS.tell(); OS << Data; unsigned SizeSoFar = OS.tell() - OldPos; assert(Size >= SizeSoFar && "Data doesn't fit in Size"); unsigned Remaining = Size - SizeSoFar; for (unsigned I = 0; I < Remaining; ++I) OS << ' '; } static void print32BE(raw_fd_ostream &Out, unsigned Val) { for (int I = 3; I >= 0; --I) { char V = (Val >> (8 * I)) & 0xff; Out << V; } } static void printRestOfMemberHeader(raw_fd_ostream &Out, const sys::TimeValue &ModTime, unsigned UID, unsigned GID, unsigned Perms, unsigned Size) { printWithSpacePadding(Out, ModTime.toEpochTime(), 12); printWithSpacePadding(Out, UID, 6); printWithSpacePadding(Out, GID, 6); printWithSpacePadding(Out, format("%o", Perms), 8); printWithSpacePadding(Out, Size, 10); Out << "`\n"; } static void printMemberHeader(raw_fd_ostream &Out, StringRef Name, const sys::TimeValue &ModTime, unsigned UID, unsigned GID, unsigned Perms, unsigned Size) { printWithSpacePadding(Out, Twine(Name) + "/", 16); printRestOfMemberHeader(Out, ModTime, UID, GID, Perms, Size); } static void printMemberHeader(raw_fd_ostream &Out, unsigned NameOffset, const sys::TimeValue &ModTime, unsigned UID, unsigned GID, unsigned Perms, unsigned Size) { Out << '/'; printWithSpacePadding(Out, NameOffset, 15); printRestOfMemberHeader(Out, ModTime, UID, GID, Perms, Size); } static void writeStringTable(raw_fd_ostream &Out, ArrayRef Members, std::vector &StringMapIndexes) { unsigned StartOffset = 0; for (ArrayRef::iterator I = Members.begin(), E = Members.end(); I != E; ++I) { StringRef Name = I->getName(); if (Name.size() < 16) continue; if (StartOffset == 0) { printWithSpacePadding(Out, "//", 58); Out << "`\n"; StartOffset = Out.tell(); } StringMapIndexes.push_back(Out.tell() - StartOffset); Out << Name << "/\n"; } if (StartOffset == 0) return; if (Out.tell() % 2) Out << '\n'; int Pos = Out.tell(); Out.seek(StartOffset - 12); printWithSpacePadding(Out, Pos - StartOffset, 10); Out.seek(Pos); } static void writeSymbolTable( raw_fd_ostream &Out, ArrayRef Members, std::vector > &MemberOffsetRefs) { unsigned StartOffset = 0; unsigned MemberNum = 0; std::vector SymNames; std::vector DeleteIt; for (ArrayRef::iterator I = Members.begin(), E = Members.end(); I != E; ++I, ++MemberNum) { object::ObjectFile *Obj; if (I->isNewMember()) { const char *Filename = I->getNew(); Obj = object::ObjectFile::createObjectFile(Filename); } else { object::Archive::child_iterator OldMember = I->getOld(); OwningPtr Binary; error_code EC = OldMember->getAsBinary(Binary); if (EC) { // FIXME: check only for "not an object file" errors. Obj = NULL; } else { Obj = dyn_cast(Binary.get()); if (Obj) Binary.take(); } } if (!Obj) continue; DeleteIt.push_back(Obj); if (!StartOffset) { printMemberHeader(Out, "", sys::TimeValue::now(), 0, 0, 0, 0); StartOffset = Out.tell(); print32BE(Out, 0); } error_code Err; for (object::symbol_iterator I = Obj->begin_symbols(), E = Obj->end_symbols(); I != E; I.increment(Err), failIfError(Err)) { uint32_t Symflags; failIfError(I->getFlags(Symflags)); if (Symflags & object::SymbolRef::SF_FormatSpecific) continue; if (!(Symflags & object::SymbolRef::SF_Global)) continue; if (Symflags & object::SymbolRef::SF_Undefined) continue; StringRef Name; failIfError(I->getName(Name)); SymNames.push_back(Name); MemberOffsetRefs.push_back(std::make_pair(Out.tell(), MemberNum)); print32BE(Out, 0); } } for (std::vector::iterator I = SymNames.begin(), E = SymNames.end(); I != E; ++I) { Out << *I; Out << '\0'; } for (std::vector::iterator I = DeleteIt.begin(), E = DeleteIt.end(); I != E; ++I) { object::ObjectFile *O = *I; delete O; } if (StartOffset == 0) return; if (Out.tell() % 2) Out << '\0'; unsigned Pos = Out.tell(); Out.seek(StartOffset - 12); printWithSpacePadding(Out, Pos - StartOffset, 10); Out.seek(StartOffset); print32BE(Out, SymNames.size()); Out.seek(Pos); } static void performWriteOperation(ArchiveOperation Operation, object::Archive *OldArchive) { SmallString<128> TmpArchive; failIfError(sys::fs::createUniqueFile(ArchiveName + ".temp-archive-%%%%%%%.a", TmpArchiveFD, TmpArchive)); TemporaryOutput = TmpArchive.c_str(); tool_output_file Output(TemporaryOutput, TmpArchiveFD); raw_fd_ostream &Out = Output.os(); Out << "!\n"; std::vector NewMembers = computeNewArchiveMembers(Operation, OldArchive); std::vector > MemberOffsetRefs; if (Symtab) { writeSymbolTable(Out, NewMembers, MemberOffsetRefs); } std::vector StringMapIndexes; writeStringTable(Out, NewMembers, StringMapIndexes); std::vector >::iterator MemberRefsI = MemberOffsetRefs.begin(); unsigned MemberNum = 0; unsigned LongNameMemberNum = 0; for (std::vector::iterator I = NewMembers.begin(), E = NewMembers.end(); I != E; ++I, ++MemberNum) { unsigned Pos = Out.tell(); while (MemberRefsI != MemberOffsetRefs.end() && MemberRefsI->second == MemberNum) { Out.seek(MemberRefsI->first); print32BE(Out, Pos); ++MemberRefsI; } Out.seek(Pos); if (I->isNewMember()) { const char *FileName = I->getNew(); int FD; failIfError(sys::fs::openFileForRead(FileName, FD), FileName); sys::fs::file_status Status; failIfError(sys::fs::status(FD, Status), FileName); // Opening a directory doesn't make sense. Let it failed. // Linux cannot open directories with open(2), although // cygwin and *bsd can. if (Status.type() == sys::fs::file_type::directory_file) failIfError(error_code(errc::is_a_directory, posix_category()), FileName); OwningPtr File; failIfError(MemoryBuffer::getOpenFile(FD, FileName, File, Status.getSize(), false), FileName); StringRef Name = sys::path::filename(FileName); if (Name.size() < 16) printMemberHeader(Out, Name, Status.getLastModificationTime(), Status.getUser(), Status.getGroup(), Status.permissions(), Status.getSize()); else printMemberHeader(Out, StringMapIndexes[LongNameMemberNum++], Status.getLastModificationTime(), Status.getUser(), Status.getGroup(), Status.permissions(), Status.getSize()); Out << File->getBuffer(); } else { object::Archive::child_iterator OldMember = I->getOld(); StringRef Name = I->getName(); if (Name.size() < 16) printMemberHeader(Out, Name, OldMember->getLastModified(), OldMember->getUID(), OldMember->getGID(), OldMember->getAccessMode(), OldMember->getSize()); else printMemberHeader(Out, StringMapIndexes[LongNameMemberNum++], OldMember->getLastModified(), OldMember->getUID(), OldMember->getGID(), OldMember->getAccessMode(), OldMember->getSize()); Out << OldMember->getBuffer(); } if (Out.tell() % 2) Out << '\n'; } Output.keep(); Out.close(); sys::fs::rename(TemporaryOutput, ArchiveName); TemporaryOutput = NULL; } static void createSymbolTable(object::Archive *OldArchive) { // When an archive is created or modified, if the s option is given, the // resulting archive will have a current symbol table. If the S option // is given, it will have no symbol table. // In summary, we only need to update the symbol table if we have none. // This is actually very common because of broken build systems that think // they have to run ranlib. if (OldArchive->hasSymbolTable()) return; performWriteOperation(CreateSymTab, OldArchive); } static void performOperation(ArchiveOperation Operation, object::Archive *OldArchive) { switch (Operation) { case Print: case DisplayTable: case Extract: performReadOperation(Operation, OldArchive); return; case Delete: case Move: case QuickAppend: case ReplaceOrInsert: performWriteOperation(Operation, OldArchive); return; case CreateSymTab: createSymbolTable(OldArchive); return; } llvm_unreachable("Unknown operation."); } static int ar_main(char **argv); static int ranlib_main(); // main - main program for llvm-ar .. see comments in the code int main(int argc, char **argv) { ToolName = argv[0]; // Print a stack trace if we signal out. sys::PrintStackTraceOnErrorSignal(); PrettyStackTraceProgram X(argc, argv); llvm_shutdown_obj Y; // Call llvm_shutdown() on exit. // Have the command line options parsed and handle things // like --help and --version. cl::ParseCommandLineOptions(argc, argv, "LLVM Archiver (llvm-ar)\n\n" " This program archives bitcode files into single libraries\n" ); StringRef Stem = sys::path::stem(ToolName); if (Stem.find("ar") != StringRef::npos) return ar_main(argv); if (Stem.find("ranlib") != StringRef::npos) return ranlib_main(); fail("Not ranlib or ar!"); } static int performOperation(ArchiveOperation Operation); int ranlib_main() { if (RestOfArgs.size() != 1) fail(ToolName + "takes just one archive as argument"); ArchiveName = RestOfArgs[0]; return performOperation(CreateSymTab); } int ar_main(char **argv) { // Do our own parsing of the command line because the CommandLine utility // can't handle the grouped positional parameters without a dash. ArchiveOperation Operation = parseCommandLine(); return performOperation(Operation); } static int performOperation(ArchiveOperation Operation) { // Create or open the archive object. OwningPtr Buf; error_code EC = MemoryBuffer::getFile(ArchiveName, Buf, -1, false); if (EC && EC != llvm::errc::no_such_file_or_directory) { errs() << ToolName << ": error opening '" << ArchiveName << "': " << EC.message() << "!\n"; return 1; } if (!EC) { object::Archive Archive(Buf.take(), EC); if (EC) { errs() << ToolName << ": error loading '" << ArchiveName << "': " << EC.message() << "!\n"; return 1; } performOperation(Operation, &Archive); return 0; } assert(EC == llvm::errc::no_such_file_or_directory); if (!shouldCreateArchive(Operation)) { failIfError(EC, Twine("error loading '") + ArchiveName + "'"); } else { if (!Create) { // Produce a warning if we should and we're creating the archive errs() << ToolName << ": creating " << ArchiveName << "\n"; } } performOperation(Operation, NULL); return 0; }