blob: e5abea4f904e084f63110da545677d1c7e13cbbb [file] [log] [blame]
Chris Lattner97f752f2003-12-30 07:45:46 +00001//===-- llvm-ar.cpp - LLVM archive librarian utility ----------------------===//
Misha Brukman3da94ae2005-04-22 00:00:37 +00002//
John Criswell7c0e0222003-10-20 17:47:21 +00003// The LLVM Compiler Infrastructure
4//
Tanya Lattnerd6074912004-11-15 19:21:49 +00005// This file was developed by the LLVM research group and is distributed under
6// the University of Illinois Open Source License. See LICENSE.TXT for details.
Misha Brukman3da94ae2005-04-22 00:00:37 +00007//
John Criswell7c0e0222003-10-20 17:47:21 +00008//===----------------------------------------------------------------------===//
Tanya Lattner14baebf2003-08-28 15:22:38 +00009//
Misha Brukman3da94ae2005-04-22 00:00:37 +000010// Builds up (relatively) standard unix archive files (.a) containing LLVM
Reid Spencer3a1582b2004-11-14 22:20:07 +000011// bytecode or other files.
Tanya Lattner14baebf2003-08-28 15:22:38 +000012//
13//===----------------------------------------------------------------------===//
Brian Gaeke4fa9fd32003-10-10 18:47:08 +000014
Tanya Lattner14baebf2003-08-28 15:22:38 +000015#include "llvm/Module.h"
Reid Spencer3a1582b2004-11-14 22:20:07 +000016#include "llvm/Bytecode/Archive.h"
Reid Spencer551ccae2004-09-01 22:55:40 +000017#include "llvm/Support/CommandLine.h"
Reid Spencer3a1582b2004-11-14 22:20:07 +000018#include "llvm/Support/Compressor.h"
Chris Lattnerbed85ff2004-05-27 05:41:36 +000019#include "llvm/System/Signals.h"
Reid Spencer86f42bd2004-07-04 12:20:55 +000020#include <iostream>
Reid Spencer3a1582b2004-11-14 22:20:07 +000021#include <algorithm>
22#include <iomanip>
Duraid Madina6927b062005-12-28 06:56:09 +000023#include <memory>
Reid Spencer3a1582b2004-11-14 22:20:07 +000024
Brian Gaeked0fde302003-11-11 22:41:34 +000025using namespace llvm;
26
Reid Spencer3a1582b2004-11-14 22:20:07 +000027// Option for compatibility with ASIX, not used but must allow it to be present.
Misha Brukman3da94ae2005-04-22 00:00:37 +000028static cl::opt<bool>
29X32Option ("X32_64", cl::Hidden,
Reid Spencerbede5832004-11-16 06:41:09 +000030 cl::desc("Ignored option for compatibility with AIX"));
Tanya Lattner14baebf2003-08-28 15:22:38 +000031
Reid Spencerbede5832004-11-16 06:41:09 +000032// llvm-ar operation code and modifier flags. This must come first.
Misha Brukman3da94ae2005-04-22 00:00:37 +000033static cl::opt<std::string>
Reid Spencer3a1582b2004-11-14 22:20:07 +000034Options(cl::Positional, cl::Required, cl::desc("{operation}[modifiers]..."));
Tanya Lattner14baebf2003-08-28 15:22:38 +000035
Reid Spencerbede5832004-11-16 06:41:09 +000036// llvm-ar remaining positional arguments.
Misha Brukman3da94ae2005-04-22 00:00:37 +000037static cl::list<std::string>
38RestOfArgs(cl::Positional, cl::OneOrMore,
Reid Spencer3a1582b2004-11-14 22:20:07 +000039 cl::desc("[relpos] [count] <archive-file> [members]..."));
Tanya Lattner14baebf2003-08-28 15:22:38 +000040
Reid Spencerbede5832004-11-16 06:41:09 +000041// MoreHelp - Provide additional help output explaining the operations and
42// modifiers of llvm-ar. This object instructs the CommandLine library
43// to print the text of the constructor when the --help option is given.
44static cl::extrahelp MoreHelp(
Misha Brukman3da94ae2005-04-22 00:00:37 +000045 "\nOPERATIONS:\n"
Reid Spencerbede5832004-11-16 06:41:09 +000046 " d[NsS] - delete file(s) from the archive\n"
47 " m[abiSs] - move file(s) in the archive\n"
48 " p[kN] - print file(s) found in the archive\n"
49 " q[ufsS] - quick append file(s) to the archive\n"
50 " r[abfiuzRsS] - replace or insert file(s) into the archive\n"
51 " t - display contents of archive\n"
52 " x[No] - extract file(s) from the archive\n"
53 "\nMODIFIERS (operation specific):\n"
54 " [a] - put file(s) after [relpos]\n"
55 " [b] - put file(s) before [relpos] (same as [i])\n"
56 " [f] - truncate inserted file names\n"
57 " [i] - put file(s) before [relpos] (same as [b])\n"
58 " [k] - always print bytecode files (default is to skip them)\n"
59 " [N] - use instance [count] of name\n"
60 " [o] - preserve original dates\n"
61 " [P] - use full path names when matching\n"
62 " [R] - recurse through directories when inserting\n"
63 " [s] - create an archive index (cf. ranlib)\n"
64 " [S] - do not build a symbol table\n"
65 " [u] - update only files newer than archive contents\n"
66 " [z] - compress files before inserting/extracting\n"
67 "\nMODIFIERS (generic):\n"
68 " [c] - do not warn if the library had to be created\n"
69 " [v] - be verbose about actions taken\n"
70 " [V] - be *really* verbose about actions taken\n"
71);
72
Reid Spencer3a1582b2004-11-14 22:20:07 +000073// This enumeration delineates the kinds of operations on an archive
74// that are permitted.
75enum ArchiveOperation {
76 NoOperation, ///< An operation hasn't been specified
77 Print, ///< Print the contents of the archive
78 Delete, ///< Delete the specified members
79 Move, ///< Move members to end or as given by {a,b,i} modifiers
80 QuickAppend, ///< Quickly append to end of archive
81 ReplaceOrInsert, ///< Replace or Insert members
82 DisplayTable, ///< Display the table of contents
Chris Lattnerd74ea2b2006-05-24 17:04:05 +000083 Extract ///< Extract files back to file system
Tanya Lattner57bd7962003-12-06 23:01:25 +000084};
Tanya Lattner14baebf2003-08-28 15:22:38 +000085
Reid Spencer3a1582b2004-11-14 22:20:07 +000086// Modifiers to follow operation to vary behavior
87bool AddAfter = false; ///< 'a' modifier
88bool AddBefore = false; ///< 'b' modifier
Misha Brukman3da94ae2005-04-22 00:00:37 +000089bool Create = false; ///< 'c' modifier
Reid Spencer3a1582b2004-11-14 22:20:07 +000090bool TruncateNames = false; ///< 'f' modifier
91bool InsertBefore = false; ///< 'i' modifier
92bool DontSkipBytecode = false; ///< 'k' modifier
93bool UseCount = false; ///< 'N' modifier
94bool OriginalDates = false; ///< 'o' modifier
95bool FullPath = false; ///< 'P' modifier
96bool RecurseDirectories = false; ///< 'R' modifier
97bool SymTable = true; ///< 's' & 'S' modifiers
98bool OnlyUpdate = false; ///< 'u' modifier
99bool Verbose = false; ///< 'v' modifier
100bool ReallyVerbose = false; ///< 'V' modifier
101bool Compression = false; ///< 'z' modifier
Tanya Lattner14baebf2003-08-28 15:22:38 +0000102
Reid Spencer3a1582b2004-11-14 22:20:07 +0000103// Relative Positional Argument (for insert/move). This variable holds
104// the name of the archive member to which the 'a', 'b' or 'i' modifier
105// refers. Only one of 'a', 'b' or 'i' can be specified so we only need
106// one variable.
107std::string RelPos;
Tanya Lattner57bd7962003-12-06 23:01:25 +0000108
Reid Spencer3a1582b2004-11-14 22:20:07 +0000109// Select which of multiple entries in the archive with the same name should be
110// used (specified with -N) for the delete and extract operations.
111int Count = 1;
Tanya Lattner57bd7962003-12-06 23:01:25 +0000112
Reid Spencer3a1582b2004-11-14 22:20:07 +0000113// This variable holds the name of the archive file as given on the
114// command line.
115std::string ArchiveName;
Tanya Lattner57bd7962003-12-06 23:01:25 +0000116
Reid Spencer3a1582b2004-11-14 22:20:07 +0000117// This variable holds the list of member files to proecess, as given
118// on the command line.
119std::vector<std::string> Members;
Tanya Lattner57bd7962003-12-06 23:01:25 +0000120
Reid Spencer3a1582b2004-11-14 22:20:07 +0000121// This variable holds the (possibly expanded) list of path objects that
122// correspond to files we will
Reid Spencerbede5832004-11-16 06:41:09 +0000123std::set<sys::Path> Paths;
Tanya Lattner57bd7962003-12-06 23:01:25 +0000124
Reid Spencer3a1582b2004-11-14 22:20:07 +0000125// The Archive object to which all the editing operations will be sent.
126Archive* TheArchive = 0;
Tanya Lattner57bd7962003-12-06 23:01:25 +0000127
Reid Spencer3a1582b2004-11-14 22:20:07 +0000128// getRelPos - Extract the member filename from the command line for
129// the [relpos] argument associated with a, b, and i modifiers
Tanya Lattner57bd7962003-12-06 23:01:25 +0000130void getRelPos() {
Reid Spencer3a1582b2004-11-14 22:20:07 +0000131 if(RestOfArgs.size() > 0) {
132 RelPos = RestOfArgs[0];
133 RestOfArgs.erase(RestOfArgs.begin());
Tanya Lattner57bd7962003-12-06 23:01:25 +0000134 }
Tanya Lattner57bd7962003-12-06 23:01:25 +0000135 else
Reid Spencer3a1582b2004-11-14 22:20:07 +0000136 throw "Expected [relpos] for a, b, or i modifier";
Tanya Lattner57bd7962003-12-06 23:01:25 +0000137}
138
Misha Brukman3da94ae2005-04-22 00:00:37 +0000139// getCount - Extract the [count] argument associated with the N modifier
Reid Spencer3a1582b2004-11-14 22:20:07 +0000140// from the command line and check its value.
Tanya Lattner57bd7962003-12-06 23:01:25 +0000141void getCount() {
Reid Spencer3a1582b2004-11-14 22:20:07 +0000142 if(RestOfArgs.size() > 0) {
143 Count = atoi(RestOfArgs[0].c_str());
144 RestOfArgs.erase(RestOfArgs.begin());
Tanya Lattner57bd7962003-12-06 23:01:25 +0000145 }
Tanya Lattner57bd7962003-12-06 23:01:25 +0000146 else
Reid Spencer3a1582b2004-11-14 22:20:07 +0000147 throw "Expected [count] value with N modifier";
148
149 // Non-positive counts are not allowed
150 if (Count < 1)
151 throw "Invalid [count] value (not a positive integer)";
Tanya Lattner57bd7962003-12-06 23:01:25 +0000152}
153
Reid Spencer3a1582b2004-11-14 22:20:07 +0000154// getArchive - Get the archive file name from the command line
Tanya Lattner57bd7962003-12-06 23:01:25 +0000155void getArchive() {
Reid Spencer3a1582b2004-11-14 22:20:07 +0000156 if(RestOfArgs.size() > 0) {
157 ArchiveName = RestOfArgs[0];
158 RestOfArgs.erase(RestOfArgs.begin());
Tanya Lattner57bd7962003-12-06 23:01:25 +0000159 }
Tanya Lattner57bd7962003-12-06 23:01:25 +0000160 else
Reid Spencer3a1582b2004-11-14 22:20:07 +0000161 throw "An archive name must be specified.";
Tanya Lattner57bd7962003-12-06 23:01:25 +0000162}
163
Reid Spencer3a1582b2004-11-14 22:20:07 +0000164// getMembers - Copy over remaining items in RestOfArgs to our Members vector
165// This is just for clarity.
Tanya Lattner57bd7962003-12-06 23:01:25 +0000166void getMembers() {
Reid Spencer3a1582b2004-11-14 22:20:07 +0000167 if(RestOfArgs.size() > 0)
Misha Brukman3da94ae2005-04-22 00:00:37 +0000168 Members = std::vector<std::string>(RestOfArgs);
Tanya Lattner57bd7962003-12-06 23:01:25 +0000169}
170
Reid Spencer3a1582b2004-11-14 22:20:07 +0000171// parseCommandLine - Parse the command line options as presented and return the
Misha Brukman3da94ae2005-04-22 00:00:37 +0000172// operation specified. Process all modifiers and check to make sure that
Reid Spencer3a1582b2004-11-14 22:20:07 +0000173// constraints on modifier/operation pairs have not been violated.
174ArchiveOperation parseCommandLine() {
Tanya Lattner57bd7962003-12-06 23:01:25 +0000175
Reid Spencer3a1582b2004-11-14 22:20:07 +0000176 // Keep track of number of operations. We can only specify one
177 // per execution.
Tanya Lattner57bd7962003-12-06 23:01:25 +0000178 unsigned NumOperations = 0;
179
Reid Spencer3a1582b2004-11-14 22:20:07 +0000180 // Keep track of the number of positional modifiers (a,b,i). Only
181 // one can be specified.
182 unsigned NumPositional = 0;
183
184 // Keep track of which operation was requested
185 ArchiveOperation Operation = NoOperation;
186
Tanya Lattner57bd7962003-12-06 23:01:25 +0000187 for(unsigned i=0; i<Options.size(); ++i) {
188 switch(Options[i]) {
Reid Spencer3a1582b2004-11-14 22:20:07 +0000189 case 'd': ++NumOperations; Operation = Delete; break;
190 case 'm': ++NumOperations; Operation = Move ; break;
191 case 'p': ++NumOperations; Operation = Print; break;
Misha Brukman3da94ae2005-04-22 00:00:37 +0000192 case 'r': ++NumOperations; Operation = ReplaceOrInsert; break;
Reid Spencer3a1582b2004-11-14 22:20:07 +0000193 case 't': ++NumOperations; Operation = DisplayTable; break;
194 case 'x': ++NumOperations; Operation = Extract; break;
195 case 'c': Create = true; break;
196 case 'f': TruncateNames = true; break;
197 case 'k': DontSkipBytecode = true; break;
198 case 'l': /* accepted but unused */ break;
199 case 'o': OriginalDates = true; break;
200 case 'P': FullPath = true; break;
201 case 'R': RecurseDirectories = true; break;
202 case 's': SymTable = true; break;
203 case 'S': SymTable = false; break;
204 case 'u': OnlyUpdate = true; break;
205 case 'v': Verbose = true; break;
206 case 'V': Verbose = ReallyVerbose = true; break;
207 case 'z': Compression = true; break;
Tanya Lattner57bd7962003-12-06 23:01:25 +0000208 case 'a':
Tanya Lattner57bd7962003-12-06 23:01:25 +0000209 getRelPos();
Reid Spencer3a1582b2004-11-14 22:20:07 +0000210 AddAfter = true;
211 NumPositional++;
Tanya Lattner57bd7962003-12-06 23:01:25 +0000212 break;
213 case 'b':
Tanya Lattner57bd7962003-12-06 23:01:25 +0000214 getRelPos();
Reid Spencer3a1582b2004-11-14 22:20:07 +0000215 AddBefore = true;
216 NumPositional++;
Tanya Lattner57bd7962003-12-06 23:01:25 +0000217 break;
218 case 'i':
Tanya Lattner57bd7962003-12-06 23:01:25 +0000219 getRelPos();
Reid Spencer3a1582b2004-11-14 22:20:07 +0000220 InsertBefore = true;
221 NumPositional++;
Tanya Lattner57bd7962003-12-06 23:01:25 +0000222 break;
223 case 'N':
Misha Brukman3da94ae2005-04-22 00:00:37 +0000224 getCount();
Tanya Lattner57bd7962003-12-06 23:01:25 +0000225 UseCount = true;
Tanya Lattner57bd7962003-12-06 23:01:25 +0000226 break;
227 default:
Reid Spencerbede5832004-11-16 06:41:09 +0000228 cl::PrintHelpMessage();
Tanya Lattner57bd7962003-12-06 23:01:25 +0000229 }
230 }
231
Misha Brukman3da94ae2005-04-22 00:00:37 +0000232 // At this point, the next thing on the command line must be
Reid Spencer3a1582b2004-11-14 22:20:07 +0000233 // the archive name.
Tanya Lattner57bd7962003-12-06 23:01:25 +0000234 getArchive();
Reid Spencer3a1582b2004-11-14 22:20:07 +0000235
236 // Everything on the command line at this point is a member.
Tanya Lattner57bd7962003-12-06 23:01:25 +0000237 getMembers();
238
Reid Spencer3a1582b2004-11-14 22:20:07 +0000239 // Perform various checks on the operation/modifier specification
240 // to make sure we are dealing with a legal request.
241 if (NumOperations == 0)
242 throw "You must specify at least one of the operations";
243 if (NumOperations > 1)
244 throw "Only one operation may be specified";
245 if (NumPositional > 1)
246 throw "You may only specify one of a, b, and i modifiers";
247 if (AddAfter || AddBefore || InsertBefore)
248 if (Operation != Move && Operation != ReplaceOrInsert)
249 throw "The 'a', 'b' and 'i' modifiers can only be specified with "
250 "the 'm' or 'r' operations";
251 if (RecurseDirectories && Operation != ReplaceOrInsert)
252 throw "The 'R' modifiers is only applicabe to the 'r' operation";
253 if (OriginalDates && Operation != Extract)
254 throw "The 'o' modifier is only applicable to the 'x' operation";
255 if (TruncateNames && Operation!=QuickAppend && Operation!=ReplaceOrInsert)
256 throw "The 'f' modifier is only applicable to the 'q' and 'r' operations";
257 if (OnlyUpdate && Operation != ReplaceOrInsert)
258 throw "The 'u' modifier is only applicable to the 'r' operation";
259 if (Compression && Operation!=ReplaceOrInsert && Operation!=Extract)
260 throw "The 'z' modifier is only applicable to the 'r' and 'x' operations";
261 if (Count > 1 && Members.size() > 1)
262 throw "Only one member name may be specified with the 'N' modifier";
263
264 // Return the parsed operation to the caller
265 return Operation;
Tanya Lattner57bd7962003-12-06 23:01:25 +0000266}
Tanya Lattner14baebf2003-08-28 15:22:38 +0000267
Reid Spencer3a1582b2004-11-14 22:20:07 +0000268// recurseDirectories - Implements the "R" modifier. This function scans through
269// the Paths vector (built by buildPaths, below) and replaces any directories it
270// finds with all the files in that directory (recursively). It uses the
271// sys::Path::getDirectoryContent method to perform the actual directory scans.
Reid Spencerbede5832004-11-16 06:41:09 +0000272std::set<sys::Path> recurseDirectories(const sys::Path& path) {
Reid Spencerbede5832004-11-16 06:41:09 +0000273 std::set<sys::Path> result;
Reid Spencer3a1582b2004-11-14 22:20:07 +0000274 if (RecurseDirectories) {
Reid Spencerbede5832004-11-16 06:41:09 +0000275 std::set<sys::Path> content;
Reid Spencer3a1582b2004-11-14 22:20:07 +0000276 path.getDirectoryContents(content);
Misha Brukman3da94ae2005-04-22 00:00:37 +0000277 for (std::set<sys::Path>::iterator I = content.begin(), E = content.end();
Reid Spencer3a1582b2004-11-14 22:20:07 +0000278 I != E; ++I) {
Chris Lattner8bdbb042006-08-01 18:09:46 +0000279 // Make sure it exists and is a directory
280 sys::FileStatus Status;
281 if (!I->getFileStatus(Status)) {
282 if (Status.isDir) {
283 std::set<sys::Path> moreResults = recurseDirectories(*I);
284 result.insert(moreResults.begin(), moreResults.end());
285 } else {
286 result.insert(*I);
287 }
288 }
Reid Spencer3a1582b2004-11-14 22:20:07 +0000289 }
290 }
291 return result;
292}
293
294// buildPaths - Convert the strings in the Members vector to sys::Path objects
Misha Brukman3da94ae2005-04-22 00:00:37 +0000295// and make sure they are valid and exist exist. This check is only needed for
Reid Spencer3a1582b2004-11-14 22:20:07 +0000296// the operations that add/replace files to the archive ('q' and 'r')
297void buildPaths(bool checkExistence = true) {
298 for (unsigned i = 0; i < Members.size(); i++) {
299 sys::Path aPath;
Reid Spencerdd04df02005-07-07 23:21:43 +0000300 if (!aPath.set(Members[i]))
Reid Spencer3a1582b2004-11-14 22:20:07 +0000301 throw std::string("File member name invalid: ") + Members[i];
302 if (checkExistence) {
303 if (!aPath.exists())
304 throw std::string("File does not exist: ") + Members[i];
Chris Lattner252ad032006-07-28 22:03:44 +0000305 sys::FileStatus si;
306 std::string Err;
307 if (aPath.getFileStatus(si, &Err))
308 throw Err;
Reid Spencer3a1582b2004-11-14 22:20:07 +0000309 if (si.isDir) {
Reid Spencerbede5832004-11-16 06:41:09 +0000310 std::set<sys::Path> dirpaths = recurseDirectories(aPath);
311 Paths.insert(dirpaths.begin(),dirpaths.end());
Reid Spencer3a1582b2004-11-14 22:20:07 +0000312 } else {
Reid Spencerbede5832004-11-16 06:41:09 +0000313 Paths.insert(aPath);
Reid Spencer3a1582b2004-11-14 22:20:07 +0000314 }
315 } else {
Reid Spencerbede5832004-11-16 06:41:09 +0000316 Paths.insert(aPath);
Reid Spencer3a1582b2004-11-14 22:20:07 +0000317 }
318 }
319}
320
Reid Spencerbede5832004-11-16 06:41:09 +0000321// printSymbolTable - print out the archive's symbol table.
322void printSymbolTable() {
323 std::cout << "\nArchive Symbol Table:\n";
324 const Archive::SymTabType& symtab = TheArchive->getSymbolTable();
Misha Brukman3da94ae2005-04-22 00:00:37 +0000325 for (Archive::SymTabType::const_iterator I=symtab.begin(), E=symtab.end();
Reid Spencerbede5832004-11-16 06:41:09 +0000326 I != E; ++I ) {
327 unsigned offset = TheArchive->getFirstFileOffset() + I->second;
328 std::cout << " " << std::setw(9) << offset << "\t" << I->first <<"\n";
329 }
330}
331
Reid Spencer3a1582b2004-11-14 22:20:07 +0000332// doPrint - Implements the 'p' operation. This function traverses the archive
333// looking for members that match the path list. It is careful to uncompress
334// things that should be and to skip bytecode files unless the 'k' modifier was
335// given.
336void doPrint() {
337 buildPaths(false);
338 unsigned countDown = Count;
Misha Brukman3da94ae2005-04-22 00:00:37 +0000339 for (Archive::iterator I = TheArchive->begin(), E = TheArchive->end();
Reid Spencer3a1582b2004-11-14 22:20:07 +0000340 I != E; ++I ) {
Misha Brukman3da94ae2005-04-22 00:00:37 +0000341 if (Paths.empty() ||
Reid Spencer3a1582b2004-11-14 22:20:07 +0000342 (std::find(Paths.begin(), Paths.end(), I->getPath()) != Paths.end())) {
343 if (countDown == 1) {
344 const char* data = reinterpret_cast<const char*>(I->getData());
345
346 // Skip things that don't make sense to print
Misha Brukman3da94ae2005-04-22 00:00:37 +0000347 if (I->isLLVMSymbolTable() || I->isSVR4SymbolTable() ||
348 I->isBSD4SymbolTable() || (!DontSkipBytecode &&
Reid Spencer3a1582b2004-11-14 22:20:07 +0000349 (I->isBytecode() || I->isCompressedBytecode())))
350 continue;
351
352 if (Verbose)
Reid Spencer1fce0912004-12-11 00:14:15 +0000353 std::cout << "Printing " << I->getPath().toString() << "\n";
Reid Spencer3a1582b2004-11-14 22:20:07 +0000354
355 if (I->isCompressedBytecode())
Reid Spencerb55bc062004-11-14 23:17:41 +0000356 Compressor::decompressToStream(data+4,I->getSize()-4,std::cout);
Reid Spencer3a1582b2004-11-14 22:20:07 +0000357 else if (I->isCompressed()) {
Reid Spencerb55bc062004-11-14 23:17:41 +0000358 Compressor::decompressToStream(data,I->getSize(),std::cout);
Reid Spencer3a1582b2004-11-14 22:20:07 +0000359 } else {
360 unsigned len = I->getSize();
361 std::cout.write(data, len);
362 }
363 } else {
364 countDown--;
365 }
366 }
367 }
368}
369
370// putMode - utility function for printing out the file mode when the 't'
371// operation is in verbose mode.
Reid Spencerbede5832004-11-16 06:41:09 +0000372void printMode(unsigned mode) {
Misha Brukman3da94ae2005-04-22 00:00:37 +0000373 if (mode & 004)
Reid Spencer3a1582b2004-11-14 22:20:07 +0000374 std::cout << "r";
375 else
376 std::cout << "-";
377 if (mode & 002)
378 std::cout << "w";
379 else
380 std::cout << "-";
381 if (mode & 001)
382 std::cout << "x";
383 else
384 std::cout << "-";
385}
386
387// doDisplayTable - Implement the 't' operation. This function prints out just
388// the file names of each of the members. However, if verbose mode is requested
389// ('v' modifier) then the file type, permission mode, user, group, size, and
390// modification time are also printed.
391void doDisplayTable() {
392 buildPaths(false);
Misha Brukman3da94ae2005-04-22 00:00:37 +0000393 for (Archive::iterator I = TheArchive->begin(), E = TheArchive->end();
Reid Spencer3a1582b2004-11-14 22:20:07 +0000394 I != E; ++I ) {
Misha Brukman3da94ae2005-04-22 00:00:37 +0000395 if (Paths.empty() ||
Reid Spencer3a1582b2004-11-14 22:20:07 +0000396 (std::find(Paths.begin(), Paths.end(), I->getPath()) != Paths.end())) {
397 if (Verbose) {
398 // FIXME: Output should be this format:
399 // Zrw-r--r-- 500/ 500 525 Nov 8 17:42 2004 Makefile
400 if (I->isBytecode())
401 std::cout << "b";
402 else if (I->isCompressedBytecode())
403 std::cout << "B";
Reid Spencer3a1582b2004-11-14 22:20:07 +0000404 else if (I->isCompressed())
405 std::cout << "Z";
406 else
407 std::cout << " ";
408 unsigned mode = I->getMode();
Reid Spencerbede5832004-11-16 06:41:09 +0000409 printMode((mode >> 6) & 007);
410 printMode((mode >> 3) & 007);
411 printMode(mode & 007);
Reid Spencer3a1582b2004-11-14 22:20:07 +0000412 std::cout << " " << std::setw(4) << I->getUser();
413 std::cout << "/" << std::setw(4) << I->getGroup();
414 std::cout << " " << std::setw(8) << I->getSize();
Misha Brukman3da94ae2005-04-22 00:00:37 +0000415 std::cout << " " << std::setw(20) <<
Reid Spencerb55bc062004-11-14 23:17:41 +0000416 I->getModTime().toString().substr(4);
Reid Spencer1fce0912004-12-11 00:14:15 +0000417 std::cout << " " << I->getPath().toString() << "\n";
Reid Spencer3a1582b2004-11-14 22:20:07 +0000418 } else {
Reid Spencer1fce0912004-12-11 00:14:15 +0000419 std::cout << I->getPath().toString() << "\n";
Reid Spencer3a1582b2004-11-14 22:20:07 +0000420 }
421 }
422 }
Reid Spencerbede5832004-11-16 06:41:09 +0000423 if (ReallyVerbose)
424 printSymbolTable();
Reid Spencer3a1582b2004-11-14 22:20:07 +0000425}
426
427// doExtract - Implement the 'x' operation. This function extracts files back to
Reid Spencere5c9cb52006-08-23 00:39:35 +0000428// the file system, making sure to uncompress any that were compressed
429bool doExtract(std::string* ErrMsg) {
Reid Spencer3a1582b2004-11-14 22:20:07 +0000430 buildPaths(false);
431 unsigned countDown = Count;
Misha Brukman3da94ae2005-04-22 00:00:37 +0000432 for (Archive::iterator I = TheArchive->begin(), E = TheArchive->end();
Reid Spencer3a1582b2004-11-14 22:20:07 +0000433 I != E; ++I ) {
434 if (Paths.empty() ||
435 (std::find(Paths.begin(), Paths.end(), I->getPath()) != Paths.end())) {
436
437 // Make sure the intervening directories are created
438 if (I->hasPath()) {
439 sys::Path dirs(I->getPath());
Reid Spencerdd04df02005-07-07 23:21:43 +0000440 dirs.eraseComponent();
Reid Spencere5c9cb52006-08-23 00:39:35 +0000441 if (dirs.createDirectoryOnDisk(/*create_parents=*/true, ErrMsg))
442 return true;
Reid Spencer3a1582b2004-11-14 22:20:07 +0000443 }
444
445 // Open up a file stream for writing
Jeff Cohen5fb6ed42005-01-22 17:36:17 +0000446 std::ios::openmode io_mode = std::ios::out | std::ios::trunc |
447 std::ios::binary;
448 std::ofstream file(I->getPath().c_str(), io_mode);
Reid Spencer3a1582b2004-11-14 22:20:07 +0000449
450 // Get the data and its length
451 const char* data = reinterpret_cast<const char*>(I->getData());
452 unsigned len = I->getSize();
453
454 // Write the data, making sure to uncompress things first
455 if (I->isCompressed()) {
Reid Spencerb55bc062004-11-14 23:17:41 +0000456 Compressor::decompressToStream(data,len,file);
Reid Spencer3a1582b2004-11-14 22:20:07 +0000457 } else {
458 file.write(data,len);
459 }
460 file.close();
461
462 // If we're supposed to retain the original modification times, etc. do so
463 // now.
464 if (OriginalDates)
Chris Lattner252ad032006-07-28 22:03:44 +0000465 I->getPath().setStatusInfoOnDisk(I->getFileStatus());
Reid Spencer3a1582b2004-11-14 22:20:07 +0000466 }
467 }
Reid Spencere5c9cb52006-08-23 00:39:35 +0000468 return false;
Reid Spencer3a1582b2004-11-14 22:20:07 +0000469}
470
471// doDelete - Implement the delete operation. This function deletes zero or more
472// members from the archive. Note that if the count is specified, there should
473// be no more than one path in the Paths list or else this algorithm breaks.
474// That check is enforced in parseCommandLine (above).
475void doDelete() {
476 buildPaths(false);
477 if (Paths.empty()) return;
478 unsigned countDown = Count;
Misha Brukman3da94ae2005-04-22 00:00:37 +0000479 for (Archive::iterator I = TheArchive->begin(), E = TheArchive->end();
Reid Spencer3a1582b2004-11-14 22:20:07 +0000480 I != E; ) {
481 if (std::find(Paths.begin(), Paths.end(), I->getPath()) != Paths.end()) {
482 if (countDown == 1) {
483 Archive::iterator J = I;
484 ++I;
Reid Spencerbede5832004-11-16 06:41:09 +0000485 TheArchive->erase(J);
Reid Spencer3a1582b2004-11-14 22:20:07 +0000486 } else
487 countDown--;
488 } else {
489 ++I;
490 }
491 }
492
493 // We're done editting, reconstruct the archive.
Reid Spencer3039b992006-07-07 19:09:14 +0000494 std::string errmsg;
495 if (!TheArchive->writeToDisk(SymTable,TruncateNames,Compression,&errmsg))
496 throw errmsg;
Reid Spencerbede5832004-11-16 06:41:09 +0000497 if (ReallyVerbose)
498 printSymbolTable();
Reid Spencer3a1582b2004-11-14 22:20:07 +0000499}
500
501// doMore - Implement the move operation. This function re-arranges just the
502// order of the archive members so that when the archive is written the move
503// of the members is accomplished. Note the use of the RelPos variable to
504// determine where the items should be moved to.
505void doMove() {
506
507 buildPaths(false);
508
509 // By default and convention the place to move members to is the end of the
510 // archive.
511 Archive::iterator moveto_spot = TheArchive->end();
512
513 // However, if the relative positioning modifiers were used, we need to scan
514 // the archive to find the member in question. If we don't find it, its no
515 // crime, we just move to the end.
516 if (AddBefore || InsertBefore || AddAfter) {
Misha Brukman3da94ae2005-04-22 00:00:37 +0000517 for (Archive::iterator I = TheArchive->begin(), E= TheArchive->end();
Reid Spencer3a1582b2004-11-14 22:20:07 +0000518 I != E; ++I ) {
Reid Spencer1fce0912004-12-11 00:14:15 +0000519 if (RelPos == I->getPath().toString()) {
Reid Spencer3a1582b2004-11-14 22:20:07 +0000520 if (AddAfter) {
521 moveto_spot = I;
522 moveto_spot++;
523 } else {
524 moveto_spot = I;
525 }
526 break;
527 }
528 }
529 }
530
531 // Keep a list of the paths remaining to be moved
Reid Spencerbede5832004-11-16 06:41:09 +0000532 std::set<sys::Path> remaining(Paths);
Reid Spencer3a1582b2004-11-14 22:20:07 +0000533
534 // Scan the archive again, this time looking for the members to move to the
535 // moveto_spot.
Misha Brukman3da94ae2005-04-22 00:00:37 +0000536 for (Archive::iterator I = TheArchive->begin(), E= TheArchive->end();
Reid Spencer3a1582b2004-11-14 22:20:07 +0000537 I != E && !remaining.empty(); ++I ) {
Misha Brukman3da94ae2005-04-22 00:00:37 +0000538 std::set<sys::Path>::iterator found =
Reid Spencer3a1582b2004-11-14 22:20:07 +0000539 std::find(remaining.begin(),remaining.end(),I->getPath());
540 if (found != remaining.end()) {
Misha Brukman3da94ae2005-04-22 00:00:37 +0000541 if (I != moveto_spot)
Reid Spencerbede5832004-11-16 06:41:09 +0000542 TheArchive->splice(moveto_spot,*TheArchive,I);
Reid Spencer3a1582b2004-11-14 22:20:07 +0000543 remaining.erase(found);
544 }
545 }
546
547 // We're done editting, reconstruct the archive.
Reid Spencer3039b992006-07-07 19:09:14 +0000548 std::string errmsg;
549 if (!TheArchive->writeToDisk(SymTable,TruncateNames,Compression,&errmsg))
550 throw errmsg;
Reid Spencerbede5832004-11-16 06:41:09 +0000551 if (ReallyVerbose)
552 printSymbolTable();
Reid Spencer3a1582b2004-11-14 22:20:07 +0000553}
554
555// doQuickAppend - Implements the 'q' operation. This function just
556// indiscriminantly adds the members to the archive and rebuilds it.
557void doQuickAppend() {
558 // Get the list of paths to append.
559 buildPaths(true);
560 if (Paths.empty()) return;
561
562 // Append them quickly.
Reid Spencerbede5832004-11-16 06:41:09 +0000563 for (std::set<sys::Path>::iterator PI = Paths.begin(), PE = Paths.end();
Reid Spencer3a1582b2004-11-14 22:20:07 +0000564 PI != PE; ++PI) {
565 TheArchive->addFileBefore(*PI,TheArchive->end());
566 }
567
568 // We're done editting, reconstruct the archive.
Reid Spencer3039b992006-07-07 19:09:14 +0000569 std::string errmsg;
570 if (!TheArchive->writeToDisk(SymTable,TruncateNames,Compression,&errmsg))
571 throw errmsg;
Reid Spencerbede5832004-11-16 06:41:09 +0000572 if (ReallyVerbose)
573 printSymbolTable();
Reid Spencer3a1582b2004-11-14 22:20:07 +0000574}
575
576// doReplaceOrInsert - Implements the 'r' operation. This function will replace
Misha Brukman3da94ae2005-04-22 00:00:37 +0000577// any existing files or insert new ones into the archive.
Reid Spencer3a1582b2004-11-14 22:20:07 +0000578void doReplaceOrInsert() {
579
580 // Build the list of files to be added/replaced.
581 buildPaths(true);
582 if (Paths.empty()) return;
583
584 // Keep track of the paths that remain to be inserted.
Reid Spencerbede5832004-11-16 06:41:09 +0000585 std::set<sys::Path> remaining(Paths);
Reid Spencer3a1582b2004-11-14 22:20:07 +0000586
587 // Default the insertion spot to the end of the archive
588 Archive::iterator insert_spot = TheArchive->end();
589
590 // Iterate over the archive contents
591 for (Archive::iterator I = TheArchive->begin(), E = TheArchive->end();
592 I != E && !remaining.empty(); ++I ) {
593
594 // Determine if this archive member matches one of the paths we're trying
595 // to replace.
Reid Spencer0de66b52004-12-02 09:21:55 +0000596
597 std::set<sys::Path>::iterator found = remaining.end();
Misha Brukman3da94ae2005-04-22 00:00:37 +0000598 for (std::set<sys::Path>::iterator RI = remaining.begin(),
Reid Spencer0de66b52004-12-02 09:21:55 +0000599 RE = remaining.end(); RI != RE; ++RI ) {
Reid Spencer1fce0912004-12-11 00:14:15 +0000600 std::string compare(RI->toString());
Reid Spencer0de66b52004-12-02 09:21:55 +0000601 if (TruncateNames && compare.length() > 15) {
602 const char* nm = compare.c_str();
603 unsigned len = compare.length();
604 size_t slashpos = compare.rfind('/');
605 if (slashpos != std::string::npos) {
606 nm += slashpos + 1;
607 len -= slashpos +1;
608 }
Misha Brukman3da94ae2005-04-22 00:00:37 +0000609 if (len > 15)
Reid Spencer0de66b52004-12-02 09:21:55 +0000610 len = 15;
611 compare.assign(nm,len);
612 }
Reid Spencer1fce0912004-12-11 00:14:15 +0000613 if (compare == I->getPath().toString()) {
Reid Spencer0de66b52004-12-02 09:21:55 +0000614 found = RI;
615 break;
616 }
617 }
618
Reid Spencer3a1582b2004-11-14 22:20:07 +0000619 if (found != remaining.end()) {
Chris Lattner252ad032006-07-28 22:03:44 +0000620 sys::FileStatus si;
621 std::string Err;
622 if (found->getFileStatus(si, &Err))
623 throw Err;
Reid Spencerbede5832004-11-16 06:41:09 +0000624 if (si.isDir) {
625 if (OnlyUpdate) {
626 // Replace the item only if it is newer.
627 if (si.modTime > I->getModTime())
628 I->replaceWith(*found);
629 } else {
630 // Replace the item regardless of time stamp
Reid Spencer3a1582b2004-11-14 22:20:07 +0000631 I->replaceWith(*found);
Reid Spencerbede5832004-11-16 06:41:09 +0000632 }
Reid Spencer3a1582b2004-11-14 22:20:07 +0000633 } else {
Reid Spencerbede5832004-11-16 06:41:09 +0000634 // We purposefully ignore directories.
Reid Spencer3a1582b2004-11-14 22:20:07 +0000635 }
636
637 // Remove it from our "to do" list
638 remaining.erase(found);
639 }
640
641 // Determine if this is the place where we should insert
Reid Spencer1fce0912004-12-11 00:14:15 +0000642 if ((AddBefore || InsertBefore) && (RelPos == I->getPath().toString()))
Reid Spencer3a1582b2004-11-14 22:20:07 +0000643 insert_spot = I;
Reid Spencer1fce0912004-12-11 00:14:15 +0000644 else if (AddAfter && (RelPos == I->getPath().toString())) {
Reid Spencer3a1582b2004-11-14 22:20:07 +0000645 insert_spot = I;
646 insert_spot++;
647 }
648 }
649
650 // If we didn't replace all the members, some will remain and need to be
651 // inserted at the previously computed insert-spot.
652 if (!remaining.empty()) {
Misha Brukman3da94ae2005-04-22 00:00:37 +0000653 for (std::set<sys::Path>::iterator PI = remaining.begin(),
Reid Spencer3a1582b2004-11-14 22:20:07 +0000654 PE = remaining.end(); PI != PE; ++PI) {
655 TheArchive->addFileBefore(*PI,insert_spot);
656 }
657 }
658
659 // We're done editting, reconstruct the archive.
Reid Spencer3039b992006-07-07 19:09:14 +0000660 std::string errmsg;
661 if (!TheArchive->writeToDisk(SymTable,TruncateNames,Compression,&errmsg))
662 throw errmsg;
Reid Spencerbede5832004-11-16 06:41:09 +0000663 if (ReallyVerbose)
664 printSymbolTable();
Reid Spencer3a1582b2004-11-14 22:20:07 +0000665}
666
667// main - main program for llvm-ar .. see comments in the code
Tanya Lattner14baebf2003-08-28 15:22:38 +0000668int main(int argc, char **argv) {
Reid Spencer3a1582b2004-11-14 22:20:07 +0000669
Reid Spencer3a1582b2004-11-14 22:20:07 +0000670 // Have the command line options parsed and handle things
671 // like --help and --version.
672 cl::ParseCommandLineOptions(argc, argv,
673 " LLVM Archiver (llvm-ar)\n\n"
674 " This program archives bytecode files into single libraries\n"
675 );
676
677 // Print a stack trace if we signal out.
Reid Spencer9de7b332004-08-29 19:28:55 +0000678 sys::PrintStackTraceOnErrorSignal();
Chris Lattnerf73b4ca2004-02-19 20:32:12 +0000679
Reid Spencer3a1582b2004-11-14 22:20:07 +0000680 int exitCode = 0;
Tanya Lattner14baebf2003-08-28 15:22:38 +0000681
Reid Spencer3a1582b2004-11-14 22:20:07 +0000682 // Make sure we don't exit with "unhandled exception".
683 try {
684 // Do our own parsing of the command line because the CommandLine utility
685 // can't handle the grouped positional parameters without a dash.
686 ArchiveOperation Operation = parseCommandLine();
Tanya Lattner14baebf2003-08-28 15:22:38 +0000687
Reid Spencer3a1582b2004-11-14 22:20:07 +0000688 // Check the path name of the archive
689 sys::Path ArchivePath;
Reid Spencerdd04df02005-07-07 23:21:43 +0000690 if (!ArchivePath.set(ArchiveName))
Reid Spencer3a1582b2004-11-14 22:20:07 +0000691 throw std::string("Archive name invalid: ") + ArchiveName;
692
693 // Create or open the archive object.
694 if (!ArchivePath.exists()) {
695 // Produce a warning if we should and we're creating the archive
696 if (!Create)
Reid Spencer1fce0912004-12-11 00:14:15 +0000697 std::cerr << argv[0] << ": creating " << ArchivePath.toString() << "\n";
Reid Spencer3a1582b2004-11-14 22:20:07 +0000698 TheArchive = Archive::CreateEmpty(ArchivePath);
699 } else {
Chris Lattner67c38212004-12-15 07:44:15 +0000700 std::string Error;
701 TheArchive = Archive::OpenAndLoad(ArchivePath, &Error);
Reid Spencerb4ed7b02004-12-15 21:58:03 +0000702 if (TheArchive == 0) {
Chris Lattner67c38212004-12-15 07:44:15 +0000703 std::cerr << argv[0] << ": error loading '" << ArchivePath << "': "
704 << Error << "!\n";
Reid Spencerb4ed7b02004-12-15 21:58:03 +0000705 return 1;
706 }
Reid Spencer3a1582b2004-11-14 22:20:07 +0000707 }
708
709 // Make sure we're not fooling ourselves.
710 assert(TheArchive && "Unable to instantiate the archive");
711
Reid Spencerbede5832004-11-16 06:41:09 +0000712 // Make sure we clean up the archive even on failure.
713 std::auto_ptr<Archive> AutoArchive(TheArchive);
714
Reid Spencer3a1582b2004-11-14 22:20:07 +0000715 // Perform the operation
Reid Spencere5c9cb52006-08-23 00:39:35 +0000716 std::string ErrMsg;
Reid Spencer3a1582b2004-11-14 22:20:07 +0000717 switch (Operation) {
718 case Print: doPrint(); break;
719 case Delete: doDelete(); break;
720 case Move: doMove(); break;
721 case QuickAppend: /* FALL THROUGH */
722 case ReplaceOrInsert: doReplaceOrInsert(); break;
723 case DisplayTable: doDisplayTable(); break;
Reid Spencere5c9cb52006-08-23 00:39:35 +0000724 case Extract:
725 if (doExtract(&ErrMsg)) {
726 std::cerr << argv[0] << ": " << ErrMsg << "\n";
727 return 1;
728 }
729 break;
Reid Spencer3a1582b2004-11-14 22:20:07 +0000730 case NoOperation:
731 std::cerr << argv[0] << ": No operation was selected.\n";
732 break;
733 }
Reid Spencer3a1582b2004-11-14 22:20:07 +0000734 } catch (const char*msg) {
735 // These errors are usage errors, thrown only by the various checks in the
736 // code above.
737 std::cerr << argv[0] << ": " << msg << "\n\n";
Reid Spencerbede5832004-11-16 06:41:09 +0000738 cl::PrintHelpMessage();
Reid Spencer3a1582b2004-11-14 22:20:07 +0000739 exitCode = 1;
740 } catch (const std::string& msg) {
741 // These errors are thrown by LLVM libraries (e.g. lib System) and represent
742 // a more serious error so we bump the exitCode and don't print the usage.
743 std::cerr << argv[0] << ": " << msg << "\n";
744 exitCode = 2;
745 } catch (...) {
746 // This really shouldn't happen, but just in case ....
Reid Spencerbede5832004-11-16 06:41:09 +0000747 std::cerr << argv[0] << ": An unexpected unknown exception occurred.\n";
Reid Spencer3a1582b2004-11-14 22:20:07 +0000748 exitCode = 3;
749 }
750
751 // Return result code back to operating system.
752 return exitCode;
Tanya Lattner14baebf2003-08-28 15:22:38 +0000753}