1 //===- ArchiveWriter.cpp - ar File Format implementation --------*- C++ -*-===//
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 // This file defines the writeArchive function.
12 //===----------------------------------------------------------------------===//
14 #include "llvm/Object/ArchiveWriter.h"
15 #include "llvm/ADT/ArrayRef.h"
16 #include "llvm/ADT/StringRef.h"
17 #include "llvm/IR/LLVMContext.h"
18 #include "llvm/Object/Archive.h"
19 #include "llvm/Object/ObjectFile.h"
20 #include "llvm/Object/SymbolicFile.h"
21 #include "llvm/Support/EndianStream.h"
22 #include "llvm/Support/Errc.h"
23 #include "llvm/Support/ErrorHandling.h"
24 #include "llvm/Support/Format.h"
25 #include "llvm/Support/Path.h"
26 #include "llvm/Support/ToolOutputFile.h"
27 #include "llvm/Support/raw_ostream.h"
29 #if !defined(_MSC_VER) && !defined(__MINGW32__)
37 NewArchiveIterator::NewArchiveIterator(object::Archive::child_iterator I,
39 : IsNewMember(false), Name(Name), OldI(I) {}
41 NewArchiveIterator::NewArchiveIterator(StringRef FileName)
42 : IsNewMember(true), Name(FileName) {}
44 StringRef NewArchiveIterator::getName() const { return Name; }
46 bool NewArchiveIterator::isNewMember() const { return IsNewMember; }
48 object::Archive::child_iterator NewArchiveIterator::getOld() const {
53 StringRef NewArchiveIterator::getNew() const {
59 NewArchiveIterator::getFD(sys::fs::file_status &NewStatus) const {
62 if (auto EC = sys::fs::openFileForRead(Name, NewFD))
66 if (auto EC = sys::fs::status(NewFD, NewStatus))
69 // Opening a directory doesn't make sense. Let it fail.
70 // Linux cannot open directories with open(2), although
71 // cygwin and *bsd can.
72 if (NewStatus.type() == sys::fs::file_type::directory_file)
73 return make_error_code(errc::is_a_directory);
79 static void printWithSpacePadding(raw_fd_ostream &OS, T Data, unsigned Size,
80 bool MayTruncate = false) {
81 uint64_t OldPos = OS.tell();
83 unsigned SizeSoFar = OS.tell() - OldPos;
84 if (Size > SizeSoFar) {
85 OS.indent(Size - SizeSoFar);
86 } else if (Size < SizeSoFar) {
87 assert(MayTruncate && "Data doesn't fit in Size");
88 // Some of the data this is used for (like UID) can be larger than the
89 // space available in the archive format. Truncate in that case.
90 OS.seek(OldPos + Size);
94 static void print32(raw_ostream &Out, object::Archive::Kind Kind,
96 if (Kind == object::Archive::K_GNU)
97 support::endian::Writer<support::big>(Out).write(Val);
99 support::endian::Writer<support::little>(Out).write(Val);
102 static void printRestOfMemberHeader(raw_fd_ostream &Out,
103 const sys::TimeValue &ModTime, unsigned UID,
104 unsigned GID, unsigned Perms,
106 printWithSpacePadding(Out, ModTime.toEpochTime(), 12);
107 printWithSpacePadding(Out, UID, 6, true);
108 printWithSpacePadding(Out, GID, 6, true);
109 printWithSpacePadding(Out, format("%o", Perms), 8);
110 printWithSpacePadding(Out, Size, 10);
114 static void printGNUSmallMemberHeader(raw_fd_ostream &Out, StringRef Name,
115 const sys::TimeValue &ModTime,
116 unsigned UID, unsigned GID,
117 unsigned Perms, unsigned Size) {
118 printWithSpacePadding(Out, Twine(Name) + "/", 16);
119 printRestOfMemberHeader(Out, ModTime, UID, GID, Perms, Size);
122 static void printBSDMemberHeader(raw_fd_ostream &Out, StringRef Name,
123 const sys::TimeValue &ModTime, unsigned UID,
124 unsigned GID, unsigned Perms, unsigned Size) {
125 uint64_t PosAfterHeader = Out.tell() + 60 + Name.size();
126 // Pad so that even 64 bit object files are aligned.
127 unsigned Pad = OffsetToAlignment(PosAfterHeader, 8);
128 unsigned NameWithPadding = Name.size() + Pad;
129 printWithSpacePadding(Out, Twine("#1/") + Twine(NameWithPadding), 16);
130 printRestOfMemberHeader(Out, ModTime, UID, GID, Perms,
131 NameWithPadding + Size);
133 assert(PosAfterHeader == Out.tell());
135 Out.write(uint8_t(0));
138 static bool useStringTable(bool Thin, StringRef Name) {
139 return Thin || Name.size() >= 16;
143 printMemberHeader(raw_fd_ostream &Out, object::Archive::Kind Kind, bool Thin,
145 std::vector<unsigned>::iterator &StringMapIndexIter,
146 const sys::TimeValue &ModTime, unsigned UID, unsigned GID,
147 unsigned Perms, unsigned Size) {
148 if (Kind == object::Archive::K_BSD)
149 return printBSDMemberHeader(Out, Name, ModTime, UID, GID, Perms, Size);
150 if (!useStringTable(Thin, Name))
151 return printGNUSmallMemberHeader(Out, Name, ModTime, UID, GID, Perms, Size);
153 printWithSpacePadding(Out, *StringMapIndexIter++, 15);
154 printRestOfMemberHeader(Out, ModTime, UID, GID, Perms, Size);
157 static void writeStringTable(raw_fd_ostream &Out,
158 ArrayRef<NewArchiveIterator> Members,
159 std::vector<unsigned> &StringMapIndexes,
161 unsigned StartOffset = 0;
162 for (const NewArchiveIterator &I : Members) {
163 StringRef Name = I.getName();
164 if (!useStringTable(Thin, Name))
166 if (StartOffset == 0) {
167 printWithSpacePadding(Out, "//", 58);
169 StartOffset = Out.tell();
171 StringMapIndexes.push_back(Out.tell() - StartOffset);
172 Out << Name << "/\n";
174 if (StartOffset == 0)
178 int Pos = Out.tell();
179 Out.seek(StartOffset - 12);
180 printWithSpacePadding(Out, Pos - StartOffset, 10);
184 static sys::TimeValue now(bool Deterministic) {
186 return sys::TimeValue::now();
192 // Returns the offset of the first reference to a member offset.
193 static ErrorOr<unsigned>
194 writeSymbolTable(raw_fd_ostream &Out, object::Archive::Kind Kind,
195 ArrayRef<NewArchiveIterator> Members,
196 ArrayRef<MemoryBufferRef> Buffers,
197 std::vector<unsigned> &MemberOffsetRefs, bool Deterministic) {
198 unsigned HeaderStartOffset = 0;
199 unsigned BodyStartOffset = 0;
200 SmallString<128> NameBuf;
201 raw_svector_ostream NameOS(NameBuf);
203 for (unsigned MemberNum = 0, N = Members.size(); MemberNum < N; ++MemberNum) {
204 MemoryBufferRef MemberBuffer = Buffers[MemberNum];
205 ErrorOr<std::unique_ptr<object::SymbolicFile>> ObjOrErr =
206 object::SymbolicFile::createSymbolicFile(
207 MemberBuffer, sys::fs::file_magic::unknown, &Context);
209 continue; // FIXME: check only for "not an object file" errors.
210 object::SymbolicFile &Obj = *ObjOrErr.get();
212 if (!HeaderStartOffset) {
213 HeaderStartOffset = Out.tell();
214 if (Kind == object::Archive::K_GNU)
215 printGNUSmallMemberHeader(Out, "", now(Deterministic), 0, 0, 0, 0);
217 printBSDMemberHeader(Out, "__.SYMDEF", now(Deterministic), 0, 0, 0, 0);
218 BodyStartOffset = Out.tell();
219 print32(Out, Kind, 0); // number of entries or bytes
222 for (const object::BasicSymbolRef &S : Obj.symbols()) {
223 uint32_t Symflags = S.getFlags();
224 if (Symflags & object::SymbolRef::SF_FormatSpecific)
226 if (!(Symflags & object::SymbolRef::SF_Global))
228 if (Symflags & object::SymbolRef::SF_Undefined)
231 unsigned NameOffset = NameOS.tell();
232 if (auto EC = S.printName(NameOS))
235 MemberOffsetRefs.push_back(MemberNum);
236 if (Kind == object::Archive::K_BSD)
237 print32(Out, Kind, NameOffset);
238 print32(Out, Kind, 0); // member offset
242 if (HeaderStartOffset == 0)
245 StringRef StringTable = NameOS.str();
246 if (Kind == object::Archive::K_BSD)
247 print32(Out, Kind, StringTable.size()); // byte count of the string table
250 // ld64 requires the next member header to start at an offset that is
252 unsigned Pad = OffsetToAlignment(Out.tell(), 4);
254 Out.write(uint8_t(0));
256 // Patch up the size of the symbol table now that we know how big it is.
257 unsigned Pos = Out.tell();
258 const unsigned MemberHeaderSize = 60;
259 Out.seek(HeaderStartOffset + 48); // offset of the size field.
260 printWithSpacePadding(Out, Pos - MemberHeaderSize - HeaderStartOffset, 10);
262 // Patch up the number of symbols.
263 Out.seek(BodyStartOffset);
264 unsigned NumSyms = MemberOffsetRefs.size();
265 if (Kind == object::Archive::K_GNU)
266 print32(Out, Kind, NumSyms);
268 print32(Out, Kind, NumSyms * 8);
271 return BodyStartOffset + 4;
274 std::pair<StringRef, std::error_code>
275 llvm::writeArchive(StringRef ArcName,
276 std::vector<NewArchiveIterator> &NewMembers,
277 bool WriteSymtab, object::Archive::Kind Kind,
278 bool Deterministic, bool Thin) {
279 SmallString<128> TmpArchive;
281 if (auto EC = sys::fs::createUniqueFile(ArcName + ".temp-archive-%%%%%%%.a",
282 TmpArchiveFD, TmpArchive))
283 return std::make_pair(ArcName, EC);
285 tool_output_file Output(TmpArchive, TmpArchiveFD);
286 raw_fd_ostream &Out = Output.os();
292 std::vector<unsigned> MemberOffsetRefs;
294 std::vector<std::unique_ptr<MemoryBuffer>> Buffers;
295 std::vector<MemoryBufferRef> Members;
296 std::vector<sys::fs::file_status> NewMemberStatus;
298 for (unsigned I = 0, N = NewMembers.size(); I < N; ++I) {
299 NewArchiveIterator &Member = NewMembers[I];
300 MemoryBufferRef MemberRef;
302 if (Member.isNewMember()) {
303 StringRef Filename = Member.getNew();
304 NewMemberStatus.resize(NewMemberStatus.size() + 1);
305 sys::fs::file_status &Status = NewMemberStatus.back();
306 ErrorOr<int> FD = Member.getFD(Status);
307 if (auto EC = FD.getError())
308 return std::make_pair(Filename, EC);
309 ErrorOr<std::unique_ptr<MemoryBuffer>> MemberBufferOrErr =
310 MemoryBuffer::getOpenFile(FD.get(), Filename, Status.getSize(),
312 if (auto EC = MemberBufferOrErr.getError())
313 return std::make_pair(Filename, EC);
314 if (close(FD.get()) != 0)
315 return std::make_pair(Filename,
316 std::error_code(errno, std::generic_category()));
317 Buffers.push_back(std::move(MemberBufferOrErr.get()));
318 MemberRef = Buffers.back()->getMemBufferRef();
320 object::Archive::child_iterator OldMember = Member.getOld();
322 OldMember->getParent()->isThin() &&
323 "Thin archives cannot refers to member of other archives");
324 ErrorOr<MemoryBufferRef> MemberBufferOrErr =
325 OldMember->getMemoryBufferRef();
326 if (auto EC = MemberBufferOrErr.getError())
327 return std::make_pair("", EC);
328 MemberRef = MemberBufferOrErr.get();
330 Members.push_back(MemberRef);
333 unsigned MemberReferenceOffset = 0;
335 ErrorOr<unsigned> MemberReferenceOffsetOrErr = writeSymbolTable(
336 Out, Kind, NewMembers, Members, MemberOffsetRefs, Deterministic);
337 if (auto EC = MemberReferenceOffsetOrErr.getError())
338 return std::make_pair(ArcName, EC);
339 MemberReferenceOffset = MemberReferenceOffsetOrErr.get();
342 std::vector<unsigned> StringMapIndexes;
343 if (Kind != object::Archive::K_BSD)
344 writeStringTable(Out, NewMembers, StringMapIndexes, Thin);
346 unsigned MemberNum = 0;
347 unsigned NewMemberNum = 0;
348 std::vector<unsigned>::iterator StringMapIndexIter = StringMapIndexes.begin();
349 std::vector<unsigned> MemberOffset;
350 for (const NewArchiveIterator &I : NewMembers) {
351 MemoryBufferRef File = Members[MemberNum++];
353 unsigned Pos = Out.tell();
354 MemberOffset.push_back(Pos);
356 sys::TimeValue ModTime;
361 ModTime.fromEpochTime(0);
365 } else if (I.isNewMember()) {
366 const sys::fs::file_status &Status = NewMemberStatus[NewMemberNum];
367 ModTime = Status.getLastModificationTime();
368 UID = Status.getUser();
369 GID = Status.getGroup();
370 Perms = Status.permissions();
372 object::Archive::child_iterator OldMember = I.getOld();
373 ModTime = OldMember->getLastModified();
374 UID = OldMember->getUID();
375 GID = OldMember->getGID();
376 Perms = OldMember->getAccessMode();
379 if (I.isNewMember()) {
380 StringRef FileName = I.getNew();
381 const sys::fs::file_status &Status = NewMemberStatus[NewMemberNum++];
382 printMemberHeader(Out, Kind, Thin, sys::path::filename(FileName),
383 StringMapIndexIter, ModTime, UID, GID, Perms,
386 object::Archive::child_iterator OldMember = I.getOld();
387 printMemberHeader(Out, Kind, Thin, I.getName(), StringMapIndexIter,
388 ModTime, UID, GID, Perms, OldMember->getSize());
392 Out << File.getBuffer();
398 if (MemberReferenceOffset) {
399 Out.seek(MemberReferenceOffset);
400 for (unsigned MemberNum : MemberOffsetRefs) {
401 if (Kind == object::Archive::K_BSD)
402 Out.seek(Out.tell() + 4); // skip over the string offset
403 print32(Out, Kind, MemberOffset[MemberNum]);
409 sys::fs::rename(TmpArchive, ArcName);
410 return std::make_pair("", std::error_code());