xref: /llvm-project/llvm/lib/Object/ArchiveWriter.cpp (revision bf0534e8702a10c9085720711fde0cbbc532ac87)
1 //===- ArchiveWriter.cpp - ar File Format implementation --------*- C++ -*-===//
2 //
3 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4 // See https://llvm.org/LICENSE.txt for license information.
5 // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
6 //
7 //===----------------------------------------------------------------------===//
8 //
9 // This file defines the writeArchive function.
10 //
11 //===----------------------------------------------------------------------===//
12 
13 #include "llvm/Object/ArchiveWriter.h"
14 #include "llvm/ADT/ArrayRef.h"
15 #include "llvm/ADT/StringMap.h"
16 #include "llvm/ADT/StringRef.h"
17 #include "llvm/BinaryFormat/Magic.h"
18 #include "llvm/IR/LLVMContext.h"
19 #include "llvm/Object/Archive.h"
20 #include "llvm/Object/COFF.h"
21 #include "llvm/Object/COFFImportFile.h"
22 #include "llvm/Object/Error.h"
23 #include "llvm/Object/IRObjectFile.h"
24 #include "llvm/Object/MachO.h"
25 #include "llvm/Object/ObjectFile.h"
26 #include "llvm/Object/SymbolicFile.h"
27 #include "llvm/Object/XCOFFObjectFile.h"
28 #include "llvm/Support/Alignment.h"
29 #include "llvm/Support/EndianStream.h"
30 #include "llvm/Support/Errc.h"
31 #include "llvm/Support/ErrorHandling.h"
32 #include "llvm/Support/Format.h"
33 #include "llvm/Support/MathExtras.h"
34 #include "llvm/Support/Path.h"
35 #include "llvm/Support/SmallVectorMemoryBuffer.h"
36 #include "llvm/Support/raw_ostream.h"
37 
38 #include <cerrno>
39 #include <map>
40 
41 #if !defined(_MSC_VER) && !defined(__MINGW32__)
42 #include <unistd.h>
43 #else
44 #include <io.h>
45 #endif
46 
47 using namespace llvm;
48 using namespace llvm::object;
49 
50 struct SymMap {
51   bool UseECMap;
52   std::map<std::string, uint16_t> Map;
53   std::map<std::string, uint16_t> ECMap;
54 };
55 
56 NewArchiveMember::NewArchiveMember(MemoryBufferRef BufRef)
57     : Buf(MemoryBuffer::getMemBuffer(BufRef, false)),
58       MemberName(BufRef.getBufferIdentifier()) {}
59 
60 object::Archive::Kind NewArchiveMember::detectKindFromObject() const {
61   auto MemBufferRef = this->Buf->getMemBufferRef();
62   Expected<std::unique_ptr<object::ObjectFile>> OptionalObject =
63       object::ObjectFile::createObjectFile(MemBufferRef);
64 
65   if (OptionalObject)
66     return isa<object::MachOObjectFile>(**OptionalObject)
67                ? object::Archive::K_DARWIN
68                : (isa<object::XCOFFObjectFile>(**OptionalObject)
69                       ? object::Archive::K_AIXBIG
70                       : object::Archive::K_GNU);
71 
72   // Squelch the error in case we had a non-object file.
73   consumeError(OptionalObject.takeError());
74 
75   // If we're adding a bitcode file to the archive, detect the Archive kind
76   // based on the target triple.
77   LLVMContext Context;
78   if (identify_magic(MemBufferRef.getBuffer()) == file_magic::bitcode) {
79     if (auto ObjOrErr = object::SymbolicFile::createSymbolicFile(
80             MemBufferRef, file_magic::bitcode, &Context)) {
81       auto &IRObject = cast<object::IRObjectFile>(**ObjOrErr);
82       auto TargetTriple = Triple(IRObject.getTargetTriple());
83       return TargetTriple.isOSDarwin()
84                  ? object::Archive::K_DARWIN
85                  : (TargetTriple.isOSAIX() ? object::Archive::K_AIXBIG
86                                            : object::Archive::K_GNU);
87     } else {
88       // Squelch the error in case this was not a SymbolicFile.
89       consumeError(ObjOrErr.takeError());
90     }
91   }
92 
93   return object::Archive::getDefaultKindForHost();
94 }
95 
96 Expected<NewArchiveMember>
97 NewArchiveMember::getOldMember(const object::Archive::Child &OldMember,
98                                bool Deterministic) {
99   Expected<llvm::MemoryBufferRef> BufOrErr = OldMember.getMemoryBufferRef();
100   if (!BufOrErr)
101     return BufOrErr.takeError();
102 
103   NewArchiveMember M;
104   M.Buf = MemoryBuffer::getMemBuffer(*BufOrErr, false);
105   M.MemberName = M.Buf->getBufferIdentifier();
106   if (!Deterministic) {
107     auto ModTimeOrErr = OldMember.getLastModified();
108     if (!ModTimeOrErr)
109       return ModTimeOrErr.takeError();
110     M.ModTime = ModTimeOrErr.get();
111     Expected<unsigned> UIDOrErr = OldMember.getUID();
112     if (!UIDOrErr)
113       return UIDOrErr.takeError();
114     M.UID = UIDOrErr.get();
115     Expected<unsigned> GIDOrErr = OldMember.getGID();
116     if (!GIDOrErr)
117       return GIDOrErr.takeError();
118     M.GID = GIDOrErr.get();
119     Expected<sys::fs::perms> AccessModeOrErr = OldMember.getAccessMode();
120     if (!AccessModeOrErr)
121       return AccessModeOrErr.takeError();
122     M.Perms = AccessModeOrErr.get();
123   }
124   return std::move(M);
125 }
126 
127 Expected<NewArchiveMember> NewArchiveMember::getFile(StringRef FileName,
128                                                      bool Deterministic) {
129   sys::fs::file_status Status;
130   auto FDOrErr = sys::fs::openNativeFileForRead(FileName);
131   if (!FDOrErr)
132     return FDOrErr.takeError();
133   sys::fs::file_t FD = *FDOrErr;
134   assert(FD != sys::fs::kInvalidFile);
135 
136   if (auto EC = sys::fs::status(FD, Status))
137     return errorCodeToError(EC);
138 
139   // Opening a directory doesn't make sense. Let it fail.
140   // Linux cannot open directories with open(2), although
141   // cygwin and *bsd can.
142   if (Status.type() == sys::fs::file_type::directory_file)
143     return errorCodeToError(make_error_code(errc::is_a_directory));
144 
145   ErrorOr<std::unique_ptr<MemoryBuffer>> MemberBufferOrErr =
146       MemoryBuffer::getOpenFile(FD, FileName, Status.getSize(), false);
147   if (!MemberBufferOrErr)
148     return errorCodeToError(MemberBufferOrErr.getError());
149 
150   if (auto EC = sys::fs::closeFile(FD))
151     return errorCodeToError(EC);
152 
153   NewArchiveMember M;
154   M.Buf = std::move(*MemberBufferOrErr);
155   M.MemberName = M.Buf->getBufferIdentifier();
156   if (!Deterministic) {
157     M.ModTime = std::chrono::time_point_cast<std::chrono::seconds>(
158         Status.getLastModificationTime());
159     M.UID = Status.getUser();
160     M.GID = Status.getGroup();
161     M.Perms = Status.permissions();
162   }
163   return std::move(M);
164 }
165 
166 template <typename T>
167 static void printWithSpacePadding(raw_ostream &OS, T Data, unsigned Size) {
168   uint64_t OldPos = OS.tell();
169   OS << Data;
170   unsigned SizeSoFar = OS.tell() - OldPos;
171   assert(SizeSoFar <= Size && "Data doesn't fit in Size");
172   OS.indent(Size - SizeSoFar);
173 }
174 
175 static bool isDarwin(object::Archive::Kind Kind) {
176   return Kind == object::Archive::K_DARWIN ||
177          Kind == object::Archive::K_DARWIN64;
178 }
179 
180 static bool isAIXBigArchive(object::Archive::Kind Kind) {
181   return Kind == object::Archive::K_AIXBIG;
182 }
183 
184 static bool isCOFFArchive(object::Archive::Kind Kind) {
185   return Kind == object::Archive::K_COFF;
186 }
187 
188 static bool isBSDLike(object::Archive::Kind Kind) {
189   switch (Kind) {
190   case object::Archive::K_GNU:
191   case object::Archive::K_GNU64:
192   case object::Archive::K_AIXBIG:
193   case object::Archive::K_COFF:
194     return false;
195   case object::Archive::K_BSD:
196   case object::Archive::K_DARWIN:
197   case object::Archive::K_DARWIN64:
198     return true;
199   }
200   llvm_unreachable("not supported for writting");
201 }
202 
203 template <class T>
204 static void print(raw_ostream &Out, object::Archive::Kind Kind, T Val) {
205   support::endian::write(Out, Val,
206                          isBSDLike(Kind) ? support::little : support::big);
207 }
208 
209 template <class T> static void printLE(raw_ostream &Out, T Val) {
210   support::endian::write(Out, Val, support::little);
211 }
212 
213 static void printRestOfMemberHeader(
214     raw_ostream &Out, const sys::TimePoint<std::chrono::seconds> &ModTime,
215     unsigned UID, unsigned GID, unsigned Perms, uint64_t Size) {
216   printWithSpacePadding(Out, sys::toTimeT(ModTime), 12);
217 
218   // The format has only 6 chars for uid and gid. Truncate if the provided
219   // values don't fit.
220   printWithSpacePadding(Out, UID % 1000000, 6);
221   printWithSpacePadding(Out, GID % 1000000, 6);
222 
223   printWithSpacePadding(Out, format("%o", Perms), 8);
224   printWithSpacePadding(Out, Size, 10);
225   Out << "`\n";
226 }
227 
228 static void
229 printGNUSmallMemberHeader(raw_ostream &Out, StringRef Name,
230                           const sys::TimePoint<std::chrono::seconds> &ModTime,
231                           unsigned UID, unsigned GID, unsigned Perms,
232                           uint64_t Size) {
233   printWithSpacePadding(Out, Twine(Name) + "/", 16);
234   printRestOfMemberHeader(Out, ModTime, UID, GID, Perms, Size);
235 }
236 
237 static void
238 printBSDMemberHeader(raw_ostream &Out, uint64_t Pos, StringRef Name,
239                      const sys::TimePoint<std::chrono::seconds> &ModTime,
240                      unsigned UID, unsigned GID, unsigned Perms, uint64_t Size) {
241   uint64_t PosAfterHeader = Pos + 60 + Name.size();
242   // Pad so that even 64 bit object files are aligned.
243   unsigned Pad = offsetToAlignment(PosAfterHeader, Align(8));
244   unsigned NameWithPadding = Name.size() + Pad;
245   printWithSpacePadding(Out, Twine("#1/") + Twine(NameWithPadding), 16);
246   printRestOfMemberHeader(Out, ModTime, UID, GID, Perms,
247                           NameWithPadding + Size);
248   Out << Name;
249   while (Pad--)
250     Out.write(uint8_t(0));
251 }
252 
253 static void
254 printBigArchiveMemberHeader(raw_ostream &Out, StringRef Name,
255                             const sys::TimePoint<std::chrono::seconds> &ModTime,
256                             unsigned UID, unsigned GID, unsigned Perms,
257                             uint64_t Size, uint64_t PrevOffset,
258                             uint64_t NextOffset) {
259   unsigned NameLen = Name.size();
260 
261   printWithSpacePadding(Out, Size, 20);           // File member size
262   printWithSpacePadding(Out, NextOffset, 20);     // Next member header offset
263   printWithSpacePadding(Out, PrevOffset, 20); // Previous member header offset
264   printWithSpacePadding(Out, sys::toTimeT(ModTime), 12); // File member date
265   // The big archive format has 12 chars for uid and gid.
266   printWithSpacePadding(Out, UID % 1000000000000, 12);   // UID
267   printWithSpacePadding(Out, GID % 1000000000000, 12);   // GID
268   printWithSpacePadding(Out, format("%o", Perms), 12);   // Permission
269   printWithSpacePadding(Out, NameLen, 4);                // Name length
270   if (NameLen) {
271     printWithSpacePadding(Out, Name, NameLen); // Name
272     if (NameLen % 2)
273       Out.write(uint8_t(0)); // Null byte padding
274   }
275   Out << "`\n"; // Terminator
276 }
277 
278 static bool useStringTable(bool Thin, StringRef Name) {
279   return Thin || Name.size() >= 16 || Name.contains('/');
280 }
281 
282 static bool is64BitKind(object::Archive::Kind Kind) {
283   switch (Kind) {
284   case object::Archive::K_GNU:
285   case object::Archive::K_BSD:
286   case object::Archive::K_DARWIN:
287   case object::Archive::K_COFF:
288     return false;
289   case object::Archive::K_AIXBIG:
290   case object::Archive::K_DARWIN64:
291   case object::Archive::K_GNU64:
292     return true;
293   }
294   llvm_unreachable("not supported for writting");
295 }
296 
297 static void
298 printMemberHeader(raw_ostream &Out, uint64_t Pos, raw_ostream &StringTable,
299                   StringMap<uint64_t> &MemberNames, object::Archive::Kind Kind,
300                   bool Thin, const NewArchiveMember &M,
301                   sys::TimePoint<std::chrono::seconds> ModTime, uint64_t Size) {
302   if (isBSDLike(Kind))
303     return printBSDMemberHeader(Out, Pos, M.MemberName, ModTime, M.UID, M.GID,
304                                 M.Perms, Size);
305   if (!useStringTable(Thin, M.MemberName))
306     return printGNUSmallMemberHeader(Out, M.MemberName, ModTime, M.UID, M.GID,
307                                      M.Perms, Size);
308   Out << '/';
309   uint64_t NamePos;
310   if (Thin) {
311     NamePos = StringTable.tell();
312     StringTable << M.MemberName << "/\n";
313   } else {
314     auto Insertion = MemberNames.insert({M.MemberName, uint64_t(0)});
315     if (Insertion.second) {
316       Insertion.first->second = StringTable.tell();
317       StringTable << M.MemberName;
318       if (isCOFFArchive(Kind))
319         StringTable << '\0';
320       else
321         StringTable << "/\n";
322     }
323     NamePos = Insertion.first->second;
324   }
325   printWithSpacePadding(Out, NamePos, 15);
326   printRestOfMemberHeader(Out, ModTime, M.UID, M.GID, M.Perms, Size);
327 }
328 
329 namespace {
330 struct MemberData {
331   std::vector<unsigned> Symbols;
332   std::string Header;
333   StringRef Data;
334   StringRef Padding;
335   uint64_t PreHeadPadSize = 0;
336   std::unique_ptr<SymbolicFile> SymFile = nullptr;
337 };
338 } // namespace
339 
340 static MemberData computeStringTable(StringRef Names) {
341   unsigned Size = Names.size();
342   unsigned Pad = offsetToAlignment(Size, Align(2));
343   std::string Header;
344   raw_string_ostream Out(Header);
345   printWithSpacePadding(Out, "//", 48);
346   printWithSpacePadding(Out, Size + Pad, 10);
347   Out << "`\n";
348   Out.flush();
349   return {{}, std::move(Header), Names, Pad ? "\n" : ""};
350 }
351 
352 static sys::TimePoint<std::chrono::seconds> now(bool Deterministic) {
353   using namespace std::chrono;
354 
355   if (!Deterministic)
356     return time_point_cast<seconds>(system_clock::now());
357   return sys::TimePoint<seconds>();
358 }
359 
360 static bool isArchiveSymbol(const object::BasicSymbolRef &S) {
361   Expected<uint32_t> SymFlagsOrErr = S.getFlags();
362   if (!SymFlagsOrErr)
363     // TODO: Actually report errors helpfully.
364     report_fatal_error(SymFlagsOrErr.takeError());
365   if (*SymFlagsOrErr & object::SymbolRef::SF_FormatSpecific)
366     return false;
367   if (!(*SymFlagsOrErr & object::SymbolRef::SF_Global))
368     return false;
369   if (*SymFlagsOrErr & object::SymbolRef::SF_Undefined)
370     return false;
371   return true;
372 }
373 
374 static void printNBits(raw_ostream &Out, object::Archive::Kind Kind,
375                        uint64_t Val) {
376   if (is64BitKind(Kind))
377     print<uint64_t>(Out, Kind, Val);
378   else
379     print<uint32_t>(Out, Kind, Val);
380 }
381 
382 static uint64_t computeSymbolTableSize(object::Archive::Kind Kind,
383                                        uint64_t NumSyms, uint64_t OffsetSize,
384                                        uint64_t StringTableSize,
385                                        uint32_t *Padding = nullptr) {
386   assert((OffsetSize == 4 || OffsetSize == 8) && "Unsupported OffsetSize");
387   uint64_t Size = OffsetSize; // Number of entries
388   if (isBSDLike(Kind))
389     Size += NumSyms * OffsetSize * 2; // Table
390   else
391     Size += NumSyms * OffsetSize; // Table
392   if (isBSDLike(Kind))
393     Size += OffsetSize; // byte count
394   Size += StringTableSize;
395   // ld64 expects the members to be 8-byte aligned for 64-bit content and at
396   // least 4-byte aligned for 32-bit content.  Opt for the larger encoding
397   // uniformly.
398   // We do this for all bsd formats because it simplifies aligning members.
399   // For the big archive format, the symbol table is the last member, so there
400   // is no need to align.
401   uint32_t Pad = isAIXBigArchive(Kind)
402                      ? 0
403                      : offsetToAlignment(Size, Align(isBSDLike(Kind) ? 8 : 2));
404 
405   Size += Pad;
406   if (Padding)
407     *Padding = Pad;
408   return Size;
409 }
410 
411 static uint64_t computeSymbolMapSize(uint64_t NumObj, SymMap &SymMap,
412                                      uint32_t *Padding = nullptr) {
413   uint64_t Size = sizeof(uint32_t) * 2; // Number of symbols and objects entries
414   Size += NumObj * sizeof(uint32_t);    // Offset table
415 
416   for (auto S : SymMap.Map)
417     Size += sizeof(uint16_t) + S.first.length() + 1;
418 
419   uint32_t Pad = offsetToAlignment(Size, Align(2));
420   Size += Pad;
421   if (Padding)
422     *Padding = Pad;
423   return Size;
424 }
425 
426 static uint64_t computeECSymbolsSize(SymMap &SymMap,
427                                      uint32_t *Padding = nullptr) {
428   uint64_t Size = sizeof(uint32_t); // Number of symbols
429 
430   for (auto S : SymMap.ECMap)
431     Size += sizeof(uint16_t) + S.first.length() + 1;
432 
433   uint32_t Pad = offsetToAlignment(Size, Align(2));
434   Size += Pad;
435   if (Padding)
436     *Padding = Pad;
437   return Size;
438 }
439 
440 static void writeSymbolTableHeader(raw_ostream &Out, object::Archive::Kind Kind,
441                                    bool Deterministic, uint64_t Size,
442                                    uint64_t PrevMemberOffset = 0,
443                                    uint64_t NextMemberOffset = 0) {
444   if (isBSDLike(Kind)) {
445     const char *Name = is64BitKind(Kind) ? "__.SYMDEF_64" : "__.SYMDEF";
446     printBSDMemberHeader(Out, Out.tell(), Name, now(Deterministic), 0, 0, 0,
447                          Size);
448   } else if (isAIXBigArchive(Kind)) {
449     printBigArchiveMemberHeader(Out, "", now(Deterministic), 0, 0, 0, Size,
450                                 PrevMemberOffset, NextMemberOffset);
451   } else {
452     const char *Name = is64BitKind(Kind) ? "/SYM64" : "";
453     printGNUSmallMemberHeader(Out, Name, now(Deterministic), 0, 0, 0, Size);
454   }
455 }
456 
457 static uint64_t computeHeadersSize(object::Archive::Kind Kind,
458                                    uint64_t NumMembers,
459                                    uint64_t StringMemberSize, uint64_t NumSyms,
460                                    uint64_t SymNamesSize, SymMap *SymMap) {
461   uint32_t OffsetSize = is64BitKind(Kind) ? 8 : 4;
462   uint64_t SymtabSize =
463       computeSymbolTableSize(Kind, NumSyms, OffsetSize, SymNamesSize);
464   auto computeSymbolTableHeaderSize = [=] {
465     SmallString<0> TmpBuf;
466     raw_svector_ostream Tmp(TmpBuf);
467     writeSymbolTableHeader(Tmp, Kind, true, SymtabSize);
468     return TmpBuf.size();
469   };
470   uint32_t HeaderSize = computeSymbolTableHeaderSize();
471   uint64_t Size = strlen("!<arch>\n") + HeaderSize + SymtabSize;
472 
473   if (SymMap) {
474     Size += HeaderSize + computeSymbolMapSize(NumMembers, *SymMap);
475     if (SymMap->ECMap.size())
476       Size += HeaderSize + computeECSymbolsSize(*SymMap);
477   }
478 
479   return Size + StringMemberSize;
480 }
481 
482 static Expected<std::unique_ptr<SymbolicFile>>
483 getSymbolicFile(MemoryBufferRef Buf, LLVMContext &Context) {
484   const file_magic Type = identify_magic(Buf.getBuffer());
485   // Don't attempt to read non-symbolic file types.
486   if (!object::SymbolicFile::isSymbolicFile(Type, &Context))
487     return nullptr;
488   if (Type == file_magic::bitcode) {
489     auto ObjOrErr = object::SymbolicFile::createSymbolicFile(
490         Buf, file_magic::bitcode, &Context);
491     if (!ObjOrErr)
492       return ObjOrErr.takeError();
493     return std::move(*ObjOrErr);
494   } else {
495     auto ObjOrErr = object::SymbolicFile::createSymbolicFile(Buf);
496     if (!ObjOrErr)
497       return ObjOrErr.takeError();
498     return std::move(*ObjOrErr);
499   }
500 }
501 
502 static bool is64BitSymbolicFile(const SymbolicFile *SymObj) {
503   return SymObj != nullptr ? SymObj->is64Bit() : false;
504 }
505 
506 // Log2 of PAGESIZE(4096) on an AIX system.
507 static const uint32_t Log2OfAIXPageSize = 12;
508 
509 // In the AIX big archive format, since the data content follows the member file
510 // name, if the name ends on an odd byte, an extra byte will be added for
511 // padding. This ensures that the data within the member file starts at an even
512 // byte.
513 static const uint32_t MinBigArchiveMemDataAlign = 2;
514 
515 template <typename AuxiliaryHeader>
516 uint16_t getAuxMaxAlignment(uint16_t AuxHeaderSize, AuxiliaryHeader *AuxHeader,
517                             uint16_t Log2OfMaxAlign) {
518   // If the member doesn't have an auxiliary header, it isn't a loadable object
519   // and so it just needs aligning at the minimum value.
520   if (AuxHeader == nullptr)
521     return MinBigArchiveMemDataAlign;
522 
523   // If the auxiliary header does not have both MaxAlignOfData and
524   // MaxAlignOfText field, it is not a loadable shared object file, so align at
525   // the minimum value. The 'ModuleType' member is located right after
526   // 'MaxAlignOfData' in the AuxiliaryHeader.
527   if (AuxHeaderSize < offsetof(AuxiliaryHeader, ModuleType))
528     return MinBigArchiveMemDataAlign;
529 
530   // If the XCOFF object file does not have a loader section, it is not
531   // loadable, so align at the minimum value.
532   if (AuxHeader->SecNumOfLoader == 0)
533     return MinBigArchiveMemDataAlign;
534 
535   // The content of the loadable member file needs to be aligned at MAX(maximum
536   // alignment of .text, maximum alignment of .data) if there are both fields.
537   // If the desired alignment is > PAGESIZE, 32-bit members are aligned on a
538   // word boundary, while 64-bit members are aligned on a PAGESIZE(2^12=4096)
539   // boundary.
540   uint16_t Log2OfAlign =
541       std::max(AuxHeader->MaxAlignOfText, AuxHeader->MaxAlignOfData);
542   return 1 << (Log2OfAlign > Log2OfAIXPageSize ? Log2OfMaxAlign : Log2OfAlign);
543 }
544 
545 // AIX big archives may contain shared object members. The AIX OS requires these
546 // members to be aligned if they are 64-bit and recommends it for 32-bit
547 // members. This ensures that when these members are loaded they are aligned in
548 // memory.
549 static uint32_t getMemberAlignment(SymbolicFile *SymObj) {
550   XCOFFObjectFile *XCOFFObj = dyn_cast_or_null<XCOFFObjectFile>(SymObj);
551   if (!XCOFFObj)
552     return MinBigArchiveMemDataAlign;
553 
554   // If the desired alignment is > PAGESIZE, 32-bit members are aligned on a
555   // word boundary, while 64-bit members are aligned on a PAGESIZE boundary.
556   return XCOFFObj->is64Bit()
557              ? getAuxMaxAlignment(XCOFFObj->fileHeader64()->AuxHeaderSize,
558                                   XCOFFObj->auxiliaryHeader64(),
559                                   Log2OfAIXPageSize)
560              : getAuxMaxAlignment(XCOFFObj->fileHeader32()->AuxHeaderSize,
561                                   XCOFFObj->auxiliaryHeader32(), 2);
562 }
563 
564 static void writeSymbolTable(raw_ostream &Out, object::Archive::Kind Kind,
565                              bool Deterministic, ArrayRef<MemberData> Members,
566                              StringRef StringTable, uint64_t MembersOffset,
567                              unsigned NumSyms, uint64_t PrevMemberOffset = 0,
568                              uint64_t NextMemberOffset = 0,
569                              bool Is64Bit = false) {
570   // We don't write a symbol table on an archive with no members -- except on
571   // Darwin, where the linker will abort unless the archive has a symbol table.
572   if (StringTable.empty() && !isDarwin(Kind) && !isCOFFArchive(Kind))
573     return;
574 
575   uint64_t OffsetSize = is64BitKind(Kind) ? 8 : 4;
576   uint32_t Pad;
577   uint64_t Size = computeSymbolTableSize(Kind, NumSyms, OffsetSize,
578                                          StringTable.size(), &Pad);
579   writeSymbolTableHeader(Out, Kind, Deterministic, Size, PrevMemberOffset,
580                          NextMemberOffset);
581 
582   if (isBSDLike(Kind))
583     printNBits(Out, Kind, NumSyms * 2 * OffsetSize);
584   else
585     printNBits(Out, Kind, NumSyms);
586 
587   uint64_t Pos = MembersOffset;
588   for (const MemberData &M : Members) {
589     if (isAIXBigArchive(Kind)) {
590       Pos += M.PreHeadPadSize;
591       if (is64BitSymbolicFile(M.SymFile.get()) != Is64Bit) {
592         Pos += M.Header.size() + M.Data.size() + M.Padding.size();
593         continue;
594       }
595     }
596 
597     for (unsigned StringOffset : M.Symbols) {
598       if (isBSDLike(Kind))
599         printNBits(Out, Kind, StringOffset);
600       printNBits(Out, Kind, Pos); // member offset
601     }
602     Pos += M.Header.size() + M.Data.size() + M.Padding.size();
603   }
604 
605   if (isBSDLike(Kind))
606     // byte count of the string table
607     printNBits(Out, Kind, StringTable.size());
608   Out << StringTable;
609 
610   while (Pad--)
611     Out.write(uint8_t(0));
612 }
613 
614 static void writeSymbolMap(raw_ostream &Out, object::Archive::Kind Kind,
615                            bool Deterministic, ArrayRef<MemberData> Members,
616                            SymMap &SymMap, uint64_t MembersOffset) {
617   uint32_t Pad;
618   uint64_t Size = computeSymbolMapSize(Members.size(), SymMap, &Pad);
619   writeSymbolTableHeader(Out, Kind, Deterministic, Size, 0);
620 
621   uint32_t Pos = MembersOffset;
622 
623   printLE<uint32_t>(Out, Members.size());
624   for (const MemberData &M : Members) {
625     printLE(Out, Pos); // member offset
626     Pos += M.Header.size() + M.Data.size() + M.Padding.size();
627   }
628 
629   printLE<uint32_t>(Out, SymMap.Map.size());
630 
631   for (auto S : SymMap.Map)
632     printLE(Out, S.second);
633   for (auto S : SymMap.Map)
634     Out << S.first << '\0';
635 
636   while (Pad--)
637     Out.write(uint8_t(0));
638 }
639 
640 static void writeECSymbols(raw_ostream &Out, object::Archive::Kind Kind,
641                            bool Deterministic, ArrayRef<MemberData> Members,
642                            SymMap &SymMap) {
643   uint32_t Pad;
644   uint64_t Size = computeECSymbolsSize(SymMap, &Pad);
645   printGNUSmallMemberHeader(Out, "/<ECSYMBOLS>", now(Deterministic), 0, 0, 0,
646                             Size);
647 
648   printLE<uint32_t>(Out, SymMap.ECMap.size());
649 
650   for (auto S : SymMap.ECMap)
651     printLE(Out, S.second);
652   for (auto S : SymMap.ECMap)
653     Out << S.first << '\0';
654   while (Pad--)
655     Out.write(uint8_t(0));
656 }
657 
658 static bool isECObject(object::SymbolicFile &Obj) {
659   if (Obj.isCOFF())
660     return cast<llvm::object::COFFObjectFile>(&Obj)->getMachine() !=
661            COFF::IMAGE_FILE_MACHINE_ARM64;
662 
663   if (Obj.isCOFFImportFile())
664     return cast<llvm::object::COFFImportFile>(&Obj)->getMachine() !=
665            COFF::IMAGE_FILE_MACHINE_ARM64;
666 
667   if (Obj.isIR()) {
668     Expected<std::string> TripleStr =
669         getBitcodeTargetTriple(Obj.getMemoryBufferRef());
670     if (!TripleStr)
671       return false;
672     Triple T(*TripleStr);
673     return T.isWindowsArm64EC() || T.getArch() == Triple::x86_64;
674   }
675 
676   return false;
677 }
678 
679 static Expected<std::vector<unsigned>> getSymbols(SymbolicFile *Obj,
680                                                   uint16_t Index,
681                                                   raw_ostream &SymNames,
682                                                   SymMap *SymMap) {
683   std::vector<unsigned> Ret;
684 
685   if (Obj == nullptr)
686     return Ret;
687 
688   std::map<std::string, uint16_t> *Map = nullptr;
689   if (SymMap)
690     Map = SymMap->UseECMap && isECObject(*Obj) ? &SymMap->ECMap : &SymMap->Map;
691 
692   for (const object::BasicSymbolRef &S : Obj->symbols()) {
693     if (!isArchiveSymbol(S))
694       continue;
695     if (Map) {
696       std::string Name;
697       raw_string_ostream NameStream(Name);
698       if (Error E = S.printName(NameStream))
699         return std::move(E);
700       if (Map->find(Name) != Map->end())
701         continue; // ignore duplicated symbol
702       (*Map)[Name] = Index;
703       if (Map == &SymMap->Map) {
704         Ret.push_back(SymNames.tell());
705         SymNames << Name << '\0';
706       }
707     } else {
708       Ret.push_back(SymNames.tell());
709       if (Error E = S.printName(SymNames))
710         return std::move(E);
711       SymNames << '\0';
712     }
713   }
714   return Ret;
715 }
716 
717 static Expected<std::vector<MemberData>>
718 computeMemberData(raw_ostream &StringTable, raw_ostream &SymNames,
719                   object::Archive::Kind Kind, bool Thin, bool Deterministic,
720                   SymtabWritingMode NeedSymbols, SymMap *SymMap,
721                   LLVMContext &Context, ArrayRef<NewArchiveMember> NewMembers) {
722   static char PaddingData[8] = {'\n', '\n', '\n', '\n', '\n', '\n', '\n', '\n'};
723   uint64_t MemHeadPadSize = 0;
724   uint64_t Pos =
725       isAIXBigArchive(Kind) ? sizeof(object::BigArchive::FixLenHdr) : 0;
726 
727   std::vector<MemberData> Ret;
728   bool HasObject = false;
729 
730   // Deduplicate long member names in the string table and reuse earlier name
731   // offsets. This especially saves space for COFF Import libraries where all
732   // members have the same name.
733   StringMap<uint64_t> MemberNames;
734 
735   // UniqueTimestamps is a special case to improve debugging on Darwin:
736   //
737   // The Darwin linker does not link debug info into the final
738   // binary. Instead, it emits entries of type N_OSO in the output
739   // binary's symbol table, containing references to the linked-in
740   // object files. Using that reference, the debugger can read the
741   // debug data directly from the object files. Alternatively, an
742   // invocation of 'dsymutil' will link the debug data from the object
743   // files into a dSYM bundle, which can be loaded by the debugger,
744   // instead of the object files.
745   //
746   // For an object file, the N_OSO entries contain the absolute path
747   // path to the file, and the file's timestamp. For an object
748   // included in an archive, the path is formatted like
749   // "/absolute/path/to/archive.a(member.o)", and the timestamp is the
750   // archive member's timestamp, rather than the archive's timestamp.
751   //
752   // However, this doesn't always uniquely identify an object within
753   // an archive -- an archive file can have multiple entries with the
754   // same filename. (This will happen commonly if the original object
755   // files started in different directories.) The only way they get
756   // distinguished, then, is via the timestamp. But this process is
757   // unable to find the correct object file in the archive when there
758   // are two files of the same name and timestamp.
759   //
760   // Additionally, timestamp==0 is treated specially, and causes the
761   // timestamp to be ignored as a match criteria.
762   //
763   // That will "usually" work out okay when creating an archive not in
764   // deterministic timestamp mode, because the objects will probably
765   // have been created at different timestamps.
766   //
767   // To ameliorate this problem, in deterministic archive mode (which
768   // is the default), on Darwin we will emit a unique non-zero
769   // timestamp for each entry with a duplicated name. This is still
770   // deterministic: the only thing affecting that timestamp is the
771   // order of the files in the resultant archive.
772   //
773   // See also the functions that handle the lookup:
774   // in lldb: ObjectContainerBSDArchive::Archive::FindObject()
775   // in llvm/tools/dsymutil: BinaryHolder::GetArchiveMemberBuffers().
776   bool UniqueTimestamps = Deterministic && isDarwin(Kind);
777   std::map<StringRef, unsigned> FilenameCount;
778   if (UniqueTimestamps) {
779     for (const NewArchiveMember &M : NewMembers)
780       FilenameCount[M.MemberName]++;
781     for (auto &Entry : FilenameCount)
782       Entry.second = Entry.second > 1 ? 1 : 0;
783   }
784 
785   // The big archive format needs to know the offset of the previous member
786   // header.
787   uint64_t PrevOffset = 0;
788   uint64_t NextMemHeadPadSize = 0;
789   std::unique_ptr<SymbolicFile> CurSymFile;
790   std::unique_ptr<SymbolicFile> NextSymFile;
791   uint16_t Index = 0;
792 
793   for (auto M = NewMembers.begin(); M < NewMembers.end(); ++M) {
794     std::string Header;
795     raw_string_ostream Out(Header);
796 
797     MemoryBufferRef Buf = M->Buf->getMemBufferRef();
798     StringRef Data = Thin ? "" : Buf.getBuffer();
799 
800     Index++;
801 
802     // ld64 expects the members to be 8-byte aligned for 64-bit content and at
803     // least 4-byte aligned for 32-bit content.  Opt for the larger encoding
804     // uniformly.  This matches the behaviour with cctools and ensures that ld64
805     // is happy with archives that we generate.
806     unsigned MemberPadding =
807         isDarwin(Kind) ? offsetToAlignment(Data.size(), Align(8)) : 0;
808     unsigned TailPadding =
809         offsetToAlignment(Data.size() + MemberPadding, Align(2));
810     StringRef Padding = StringRef(PaddingData, MemberPadding + TailPadding);
811 
812     sys::TimePoint<std::chrono::seconds> ModTime;
813     if (UniqueTimestamps)
814       // Increment timestamp for each file of a given name.
815       ModTime = sys::toTimePoint(FilenameCount[M->MemberName]++);
816     else
817       ModTime = M->ModTime;
818 
819     uint64_t Size = Buf.getBufferSize() + MemberPadding;
820     if (Size > object::Archive::MaxMemberSize) {
821       std::string StringMsg =
822           "File " + M->MemberName.str() + " exceeds size limit";
823       return make_error<object::GenericBinaryError>(
824           std::move(StringMsg), object::object_error::parse_failed);
825     }
826 
827     if (NeedSymbols != SymtabWritingMode::NoSymtab || isAIXBigArchive(Kind)) {
828       auto SetNextSymFile = [&NextSymFile,
829                              &Context](MemoryBufferRef Buf,
830                                        StringRef MemberName) -> Error {
831         Expected<std::unique_ptr<SymbolicFile>> SymFileOrErr =
832             getSymbolicFile(Buf, Context);
833         if (!SymFileOrErr)
834           return createFileError(MemberName, SymFileOrErr.takeError());
835         NextSymFile = std::move(*SymFileOrErr);
836         return Error::success();
837       };
838 
839       if (M == NewMembers.begin())
840         if (Error Err = SetNextSymFile(Buf, M->MemberName))
841           return std::move(Err);
842 
843       CurSymFile = std::move(NextSymFile);
844 
845       if ((M + 1) != NewMembers.end())
846         if (Error Err = SetNextSymFile((M + 1)->Buf->getMemBufferRef(),
847                                        (M + 1)->MemberName))
848           return std::move(Err);
849     }
850 
851     // In the big archive file format, we need to calculate and include the next
852     // member offset and previous member offset in the file member header.
853     if (isAIXBigArchive(Kind)) {
854       uint64_t OffsetToMemData = Pos + sizeof(object::BigArMemHdrType) +
855                                  alignTo(M->MemberName.size(), 2);
856 
857       if (M == NewMembers.begin())
858         NextMemHeadPadSize =
859             alignToPowerOf2(OffsetToMemData,
860                             getMemberAlignment(CurSymFile.get())) -
861             OffsetToMemData;
862 
863       MemHeadPadSize = NextMemHeadPadSize;
864       Pos += MemHeadPadSize;
865       uint64_t NextOffset = Pos + sizeof(object::BigArMemHdrType) +
866                             alignTo(M->MemberName.size(), 2) + alignTo(Size, 2);
867 
868       // If there is another member file after this, we need to calculate the
869       // padding before the header.
870       if ((M + 1) != NewMembers.end()) {
871         uint64_t OffsetToNextMemData = NextOffset +
872                                        sizeof(object::BigArMemHdrType) +
873                                        alignTo((M + 1)->MemberName.size(), 2);
874         NextMemHeadPadSize =
875             alignToPowerOf2(OffsetToNextMemData,
876                             getMemberAlignment(NextSymFile.get())) -
877             OffsetToNextMemData;
878         NextOffset += NextMemHeadPadSize;
879       }
880       printBigArchiveMemberHeader(Out, M->MemberName, ModTime, M->UID, M->GID,
881                                   M->Perms, Size, PrevOffset, NextOffset);
882       PrevOffset = Pos;
883     } else {
884       printMemberHeader(Out, Pos, StringTable, MemberNames, Kind, Thin, *M,
885                         ModTime, Size);
886     }
887     Out.flush();
888 
889     std::vector<unsigned> Symbols;
890     if (NeedSymbols != SymtabWritingMode::NoSymtab) {
891       Expected<std::vector<unsigned>> SymbolsOrErr =
892           getSymbols(CurSymFile.get(), Index, SymNames, SymMap);
893       if (!SymbolsOrErr)
894         return createFileError(M->MemberName, SymbolsOrErr.takeError());
895       Symbols = std::move(*SymbolsOrErr);
896       if (CurSymFile)
897         HasObject = true;
898     }
899 
900     Pos += Header.size() + Data.size() + Padding.size();
901     Ret.push_back({std::move(Symbols), std::move(Header), Data, Padding,
902                    MemHeadPadSize, std::move(CurSymFile)});
903   }
904   // If there are no symbols, emit an empty symbol table, to satisfy Solaris
905   // tools, older versions of which expect a symbol table in a non-empty
906   // archive, regardless of whether there are any symbols in it.
907   if (HasObject && SymNames.tell() == 0 && !isCOFFArchive(Kind))
908     SymNames << '\0' << '\0' << '\0';
909   return std::move(Ret);
910 }
911 
912 namespace llvm {
913 
914 static ErrorOr<SmallString<128>> canonicalizePath(StringRef P) {
915   SmallString<128> Ret = P;
916   std::error_code Err = sys::fs::make_absolute(Ret);
917   if (Err)
918     return Err;
919   sys::path::remove_dots(Ret, /*removedotdot*/ true);
920   return Ret;
921 }
922 
923 // Compute the relative path from From to To.
924 Expected<std::string> computeArchiveRelativePath(StringRef From, StringRef To) {
925   ErrorOr<SmallString<128>> PathToOrErr = canonicalizePath(To);
926   ErrorOr<SmallString<128>> DirFromOrErr = canonicalizePath(From);
927   if (!PathToOrErr || !DirFromOrErr)
928     return errorCodeToError(std::error_code(errno, std::generic_category()));
929 
930   const SmallString<128> &PathTo = *PathToOrErr;
931   const SmallString<128> &DirFrom = sys::path::parent_path(*DirFromOrErr);
932 
933   // Can't construct a relative path between different roots
934   if (sys::path::root_name(PathTo) != sys::path::root_name(DirFrom))
935     return sys::path::convert_to_slash(PathTo);
936 
937   // Skip common prefixes
938   auto FromTo =
939       std::mismatch(sys::path::begin(DirFrom), sys::path::end(DirFrom),
940                     sys::path::begin(PathTo));
941   auto FromI = FromTo.first;
942   auto ToI = FromTo.second;
943 
944   // Construct relative path
945   SmallString<128> Relative;
946   for (auto FromE = sys::path::end(DirFrom); FromI != FromE; ++FromI)
947     sys::path::append(Relative, sys::path::Style::posix, "..");
948 
949   for (auto ToE = sys::path::end(PathTo); ToI != ToE; ++ToI)
950     sys::path::append(Relative, sys::path::Style::posix, *ToI);
951 
952   return std::string(Relative.str());
953 }
954 
955 static Error writeArchiveToStream(raw_ostream &Out,
956                                   ArrayRef<NewArchiveMember> NewMembers,
957                                   SymtabWritingMode WriteSymtab,
958                                   object::Archive::Kind Kind,
959                                   bool Deterministic, bool Thin, bool IsEC) {
960   assert((!Thin || !isBSDLike(Kind)) && "Only the gnu format has a thin mode");
961 
962   SmallString<0> SymNamesBuf;
963   raw_svector_ostream SymNames(SymNamesBuf);
964   SmallString<0> StringTableBuf;
965   raw_svector_ostream StringTable(StringTableBuf);
966   SymMap SymMap;
967 
968   // COFF symbol map uses 16-bit indexes, so we can't use it if there are too
969   // many members.
970   if (isCOFFArchive(Kind) && NewMembers.size() > 0xfffe)
971     Kind = object::Archive::K_GNU;
972 
973   // In the scenario when LLVMContext is populated SymbolicFile will contain a
974   // reference to it, thus SymbolicFile should be destroyed first.
975   LLVMContext Context;
976 
977   SymMap.UseECMap = IsEC;
978   Expected<std::vector<MemberData>> DataOrErr = computeMemberData(
979       StringTable, SymNames, Kind, Thin, Deterministic, WriteSymtab,
980       isCOFFArchive(Kind) ? &SymMap : nullptr, Context, NewMembers);
981   if (Error E = DataOrErr.takeError())
982     return E;
983   std::vector<MemberData> &Data = *DataOrErr;
984 
985   uint64_t StringTableSize = 0;
986   MemberData StringTableMember;
987   if (!StringTableBuf.empty() && !isAIXBigArchive(Kind)) {
988     StringTableMember = computeStringTable(StringTableBuf);
989     StringTableSize = StringTableMember.Header.size() +
990                       StringTableMember.Data.size() +
991                       StringTableMember.Padding.size();
992   }
993 
994   // We would like to detect if we need to switch to a 64-bit symbol table.
995   uint64_t LastMemberEndOffset = 0;
996   uint64_t LastMemberHeaderOffset = 0;
997   uint64_t NumSyms = 0;
998   uint64_t NumSyms32 = 0; // Store symbol number of 32-bit member files.
999   bool ShouldWriteSymtab = WriteSymtab != SymtabWritingMode::NoSymtab;
1000 
1001   for (const auto &M : Data) {
1002     // Record the start of the member's offset
1003     LastMemberEndOffset += M.PreHeadPadSize;
1004     LastMemberHeaderOffset = LastMemberEndOffset;
1005     // Account for the size of each part associated with the member.
1006     LastMemberEndOffset += M.Header.size() + M.Data.size() + M.Padding.size();
1007     NumSyms += M.Symbols.size();
1008 
1009     // AIX big archive files may contain two global symbol tables. The
1010     // first global symbol table locates 32-bit file members that define global
1011     // symbols; the second global symbol table does the same for 64-bit file
1012     // members. As a big archive can have both 32-bit and 64-bit file members,
1013     // we need to know the number of symbols in each symbol table individually.
1014     if (isAIXBigArchive(Kind) && ShouldWriteSymtab) {
1015         if (!is64BitSymbolicFile(M.SymFile.get()))
1016           NumSyms32 += M.Symbols.size();
1017       }
1018   }
1019 
1020   std::optional<uint64_t> HeadersSize;
1021 
1022   // The symbol table is put at the end of the big archive file. The symbol
1023   // table is at the start of the archive file for other archive formats.
1024   if (ShouldWriteSymtab && !is64BitKind(Kind)) {
1025     // We assume 32-bit offsets to see if 32-bit symbols are possible or not.
1026     HeadersSize = computeHeadersSize(Kind, Data.size(), StringTableSize,
1027                                      NumSyms, SymNamesBuf.size(),
1028                                      isCOFFArchive(Kind) ? &SymMap : nullptr);
1029 
1030     // The SYM64 format is used when an archive's member offsets are larger than
1031     // 32-bits can hold. The need for this shift in format is detected by
1032     // writeArchive. To test this we need to generate a file with a member that
1033     // has an offset larger than 32-bits but this demands a very slow test. To
1034     // speed the test up we use this environment variable to pretend like the
1035     // cutoff happens before 32-bits and instead happens at some much smaller
1036     // value.
1037     uint64_t Sym64Threshold = 1ULL << 32;
1038     const char *Sym64Env = std::getenv("SYM64_THRESHOLD");
1039     if (Sym64Env)
1040       StringRef(Sym64Env).getAsInteger(10, Sym64Threshold);
1041 
1042     // If LastMemberHeaderOffset isn't going to fit in a 32-bit varible we need
1043     // to switch to 64-bit. Note that the file can be larger than 4GB as long as
1044     // the last member starts before the 4GB offset.
1045     if (*HeadersSize + LastMemberHeaderOffset >= Sym64Threshold) {
1046       if (Kind == object::Archive::K_DARWIN)
1047         Kind = object::Archive::K_DARWIN64;
1048       else
1049         Kind = object::Archive::K_GNU64;
1050       HeadersSize.reset();
1051     }
1052   }
1053 
1054   if (Thin)
1055     Out << "!<thin>\n";
1056   else if (isAIXBigArchive(Kind))
1057     Out << "<bigaf>\n";
1058   else
1059     Out << "!<arch>\n";
1060 
1061   if (!isAIXBigArchive(Kind)) {
1062     if (ShouldWriteSymtab) {
1063       if (!HeadersSize)
1064         HeadersSize = computeHeadersSize(
1065             Kind, Data.size(), StringTableSize, NumSyms, SymNamesBuf.size(),
1066             isCOFFArchive(Kind) ? &SymMap : nullptr);
1067       writeSymbolTable(Out, Kind, Deterministic, Data, SymNamesBuf,
1068                        *HeadersSize, NumSyms);
1069 
1070       if (isCOFFArchive(Kind))
1071         writeSymbolMap(Out, Kind, Deterministic, Data, SymMap, *HeadersSize);
1072     }
1073 
1074     if (StringTableSize)
1075       Out << StringTableMember.Header << StringTableMember.Data
1076           << StringTableMember.Padding;
1077 
1078     if (ShouldWriteSymtab && SymMap.ECMap.size())
1079       writeECSymbols(Out, Kind, Deterministic, Data, SymMap);
1080 
1081     for (const MemberData &M : Data)
1082       Out << M.Header << M.Data << M.Padding;
1083   } else {
1084     HeadersSize = sizeof(object::BigArchive::FixLenHdr);
1085     LastMemberEndOffset += *HeadersSize;
1086     LastMemberHeaderOffset += *HeadersSize;
1087 
1088     // For the big archive (AIX) format, compute a table of member names and
1089     // offsets, used in the member table.
1090     uint64_t MemberTableNameStrTblSize = 0;
1091     std::vector<size_t> MemberOffsets;
1092     std::vector<StringRef> MemberNames;
1093     // Loop across object to find offset and names.
1094     uint64_t MemberEndOffset = sizeof(object::BigArchive::FixLenHdr);
1095     for (size_t I = 0, Size = NewMembers.size(); I != Size; ++I) {
1096       const NewArchiveMember &Member = NewMembers[I];
1097       MemberTableNameStrTblSize += Member.MemberName.size() + 1;
1098       MemberEndOffset += Data[I].PreHeadPadSize;
1099       MemberOffsets.push_back(MemberEndOffset);
1100       MemberNames.push_back(Member.MemberName);
1101       // File member name ended with "`\n". The length is included in
1102       // BigArMemHdrType.
1103       MemberEndOffset += sizeof(object::BigArMemHdrType) +
1104                          alignTo(Data[I].Data.size(), 2) +
1105                          alignTo(Member.MemberName.size(), 2);
1106     }
1107 
1108     // AIX member table size.
1109     uint64_t MemberTableSize = 20 + // Number of members field
1110                                20 * MemberOffsets.size() +
1111                                MemberTableNameStrTblSize;
1112 
1113     SmallString<0> SymNamesBuf32;
1114     SmallString<0> SymNamesBuf64;
1115     raw_svector_ostream SymNames32(SymNamesBuf32);
1116     raw_svector_ostream SymNames64(SymNamesBuf64);
1117 
1118     if (ShouldWriteSymtab && NumSyms)
1119       // Generate the symbol names for the members.
1120       for (const auto &M : Data) {
1121         Expected<std::vector<unsigned>> SymbolsOrErr = getSymbols(
1122             M.SymFile.get(), 0,
1123             is64BitSymbolicFile(M.SymFile.get()) ? SymNames64 : SymNames32,
1124             nullptr);
1125         if (!SymbolsOrErr)
1126           return SymbolsOrErr.takeError();
1127       }
1128 
1129     uint64_t MemberTableEndOffset =
1130         LastMemberEndOffset +
1131         alignTo(sizeof(object::BigArMemHdrType) + MemberTableSize, 2);
1132 
1133     // In AIX OS, The 'GlobSymOffset' field in the fixed-length header contains
1134     // the offset to the 32-bit global symbol table, and the 'GlobSym64Offset'
1135     // contains the offset to the 64-bit global symbol table.
1136     uint64_t GlobalSymbolOffset =
1137         (ShouldWriteSymtab &&
1138          (WriteSymtab != SymtabWritingMode::BigArchive64) && NumSyms32 > 0)
1139             ? MemberTableEndOffset
1140             : 0;
1141 
1142     uint64_t GlobalSymbolOffset64 = 0;
1143     uint64_t NumSyms64 = NumSyms - NumSyms32;
1144     if (ShouldWriteSymtab && (WriteSymtab != SymtabWritingMode::BigArchive32) &&
1145         NumSyms64 > 0) {
1146       if (GlobalSymbolOffset == 0)
1147         GlobalSymbolOffset64 = MemberTableEndOffset;
1148       else
1149         // If there is a global symbol table for 32-bit members,
1150         // the 64-bit global symbol table is after the 32-bit one.
1151         GlobalSymbolOffset64 =
1152             GlobalSymbolOffset + sizeof(object::BigArMemHdrType) +
1153             (NumSyms32 + 1) * 8 + alignTo(SymNamesBuf32.size(), 2);
1154     }
1155 
1156     // Fixed Sized Header.
1157     printWithSpacePadding(Out, NewMembers.size() ? LastMemberEndOffset : 0,
1158                           20); // Offset to member table
1159     // If there are no file members in the archive, there will be no global
1160     // symbol table.
1161     printWithSpacePadding(Out, GlobalSymbolOffset, 20);
1162     printWithSpacePadding(Out, GlobalSymbolOffset64, 20);
1163     printWithSpacePadding(Out,
1164                           NewMembers.size()
1165                               ? sizeof(object::BigArchive::FixLenHdr) +
1166                                     Data[0].PreHeadPadSize
1167                               : 0,
1168                           20); // Offset to first archive member
1169     printWithSpacePadding(Out, NewMembers.size() ? LastMemberHeaderOffset : 0,
1170                           20); // Offset to last archive member
1171     printWithSpacePadding(
1172         Out, 0,
1173         20); // Offset to first member of free list - Not supported yet
1174 
1175     for (const MemberData &M : Data) {
1176       Out << std::string(M.PreHeadPadSize, '\0');
1177       Out << M.Header << M.Data;
1178       if (M.Data.size() % 2)
1179         Out << '\0';
1180     }
1181 
1182     if (NewMembers.size()) {
1183       // Member table.
1184       printBigArchiveMemberHeader(Out, "", sys::toTimePoint(0), 0, 0, 0,
1185                                   MemberTableSize, LastMemberHeaderOffset,
1186                                   GlobalSymbolOffset ? GlobalSymbolOffset
1187                                                      : GlobalSymbolOffset64);
1188       printWithSpacePadding(Out, MemberOffsets.size(), 20); // Number of members
1189       for (uint64_t MemberOffset : MemberOffsets)
1190         printWithSpacePadding(Out, MemberOffset,
1191                               20); // Offset to member file header.
1192       for (StringRef MemberName : MemberNames)
1193         Out << MemberName << '\0'; // Member file name, null byte padding.
1194 
1195       if (MemberTableNameStrTblSize % 2)
1196         Out << '\0'; // Name table must be tail padded to an even number of
1197                      // bytes.
1198 
1199       if (ShouldWriteSymtab) {
1200         // Write global symbol table for 32-bit file members.
1201         if (GlobalSymbolOffset) {
1202           writeSymbolTable(Out, Kind, Deterministic, Data, SymNamesBuf32,
1203                            *HeadersSize, NumSyms32, LastMemberEndOffset,
1204                            GlobalSymbolOffset64);
1205           // Add padding between the symbol tables, if needed.
1206           if (GlobalSymbolOffset64 && (SymNamesBuf32.size() % 2))
1207             Out << '\0';
1208         }
1209 
1210         // Write global symbol table for 64-bit file members.
1211         if (GlobalSymbolOffset64)
1212           writeSymbolTable(Out, Kind, Deterministic, Data, SymNamesBuf64,
1213                            *HeadersSize, NumSyms64,
1214                            GlobalSymbolOffset ? GlobalSymbolOffset
1215                                               : LastMemberEndOffset,
1216                            0, true);
1217       }
1218     }
1219   }
1220   Out.flush();
1221   return Error::success();
1222 }
1223 
1224 Error writeArchive(StringRef ArcName, ArrayRef<NewArchiveMember> NewMembers,
1225                    SymtabWritingMode WriteSymtab, object::Archive::Kind Kind,
1226                    bool Deterministic, bool Thin,
1227                    std::unique_ptr<MemoryBuffer> OldArchiveBuf, bool IsEC) {
1228   Expected<sys::fs::TempFile> Temp =
1229       sys::fs::TempFile::create(ArcName + ".temp-archive-%%%%%%%.a");
1230   if (!Temp)
1231     return Temp.takeError();
1232   raw_fd_ostream Out(Temp->FD, false);
1233 
1234   if (Error E = writeArchiveToStream(Out, NewMembers, WriteSymtab, Kind,
1235                                      Deterministic, Thin, IsEC)) {
1236     if (Error DiscardError = Temp->discard())
1237       return joinErrors(std::move(E), std::move(DiscardError));
1238     return E;
1239   }
1240 
1241   // At this point, we no longer need whatever backing memory
1242   // was used to generate the NewMembers. On Windows, this buffer
1243   // could be a mapped view of the file we want to replace (if
1244   // we're updating an existing archive, say). In that case, the
1245   // rename would still succeed, but it would leave behind a
1246   // temporary file (actually the original file renamed) because
1247   // a file cannot be deleted while there's a handle open on it,
1248   // only renamed. So by freeing this buffer, this ensures that
1249   // the last open handle on the destination file, if any, is
1250   // closed before we attempt to rename.
1251   OldArchiveBuf.reset();
1252 
1253   return Temp->keep(ArcName);
1254 }
1255 
1256 Expected<std::unique_ptr<MemoryBuffer>>
1257 writeArchiveToBuffer(ArrayRef<NewArchiveMember> NewMembers,
1258                      SymtabWritingMode WriteSymtab, object::Archive::Kind Kind,
1259                      bool Deterministic, bool Thin) {
1260   SmallVector<char, 0> ArchiveBufferVector;
1261   raw_svector_ostream ArchiveStream(ArchiveBufferVector);
1262 
1263   if (Error E = writeArchiveToStream(ArchiveStream, NewMembers, WriteSymtab,
1264                                      Kind, Deterministic, Thin, false))
1265     return std::move(E);
1266 
1267   return std::make_unique<SmallVectorMemoryBuffer>(
1268       std::move(ArchiveBufferVector), /*RequiresNullTerminator=*/false);
1269 }
1270 
1271 } // namespace llvm
1272