LLVM 23.0.0git
ArchiveWriter.cpp
Go to the documentation of this file.
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
14#include "llvm/ADT/ArrayRef.h"
15#include "llvm/ADT/StringMap.h"
16#include "llvm/ADT/StringRef.h"
18#include "llvm/IR/LLVMContext.h"
19#include "llvm/Object/Archive.h"
20#include "llvm/Object/COFF.h"
22#include "llvm/Object/Error.h"
24#include "llvm/Object/MachO.h"
30#include "llvm/Support/Errc.h"
32#include "llvm/Support/Format.h"
34#include "llvm/Support/Path.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
47using namespace llvm;
48using namespace llvm::object;
49
50struct SymMap {
51 bool UseECMap = false;
52 std::map<std::string, uint16_t> Map;
53 std::map<std::string, uint16_t> ECMap;
54};
55
57 : Buf(MemoryBuffer::getMemBuffer(BufRef, false)),
58 MemberName(BufRef.getBufferIdentifier()) {}
59
61 auto MemBufferRef = this->Buf->getMemBufferRef();
64
65 if (OptionalObject) {
66 if (isa<object::MachOObjectFile>(**OptionalObject))
68 if (isa<object::XCOFFObjectFile>(**OptionalObject))
70 if (isa<object::COFFObjectFile>(**OptionalObject) ||
71 isa<object::COFFImportFile>(**OptionalObject))
74 }
75
76 // Squelch the error in case we had a non-object file.
77 consumeError(OptionalObject.takeError());
78
79 // If we're adding a bitcode file to the archive, detect the Archive kind
80 // based on the target triple.
81 LLVMContext Context;
82 if (identify_magic(MemBufferRef.getBuffer()) == file_magic::bitcode) {
84 MemBufferRef, file_magic::bitcode, &Context)) {
85 auto &IRObject = cast<object::IRObjectFile>(**ObjOrErr);
86 auto TargetTriple = Triple(IRObject.getTargetTriple());
88 } else {
89 // Squelch the error in case this was not a SymbolicFile.
90 consumeError(ObjOrErr.takeError());
91 }
92 }
93
95}
96
99 bool Deterministic) {
101 if (!BufOrErr)
102 return BufOrErr.takeError();
103
105 M.Buf = MemoryBuffer::getMemBuffer(*BufOrErr, false);
106 M.MemberName = M.Buf->getBufferIdentifier();
107 if (!Deterministic) {
108 auto ModTimeOrErr = OldMember.getLastModified();
109 if (!ModTimeOrErr)
110 return ModTimeOrErr.takeError();
111 M.ModTime = ModTimeOrErr.get();
112 Expected<unsigned> UIDOrErr = OldMember.getUID();
113 if (!UIDOrErr)
114 return UIDOrErr.takeError();
115 M.UID = UIDOrErr.get();
116 Expected<unsigned> GIDOrErr = OldMember.getGID();
117 if (!GIDOrErr)
118 return GIDOrErr.takeError();
119 M.GID = GIDOrErr.get();
120 Expected<sys::fs::perms> AccessModeOrErr = OldMember.getAccessMode();
121 if (!AccessModeOrErr)
122 return AccessModeOrErr.takeError();
123 M.Perms = AccessModeOrErr.get();
124 }
125 return std::move(M);
126}
127
129 bool Deterministic) {
131 auto FDOrErr = sys::fs::openNativeFileForRead(FileName);
132 if (!FDOrErr)
133 return FDOrErr.takeError();
134 sys::fs::file_t FD = *FDOrErr;
136
137 if (auto EC = sys::fs::status(FD, Status))
138 return errorCodeToError(EC);
139
140 // Opening a directory doesn't make sense. Let it fail.
141 // Linux cannot open directories with open(2), although
142 // cygwin and *bsd can.
145
146 ErrorOr<std::unique_ptr<MemoryBuffer>> MemberBufferOrErr =
147 MemoryBuffer::getOpenFile(FD, FileName, Status.getSize(), false);
148 if (!MemberBufferOrErr)
149 return errorCodeToError(MemberBufferOrErr.getError());
150
151 if (auto EC = sys::fs::closeFile(FD))
152 return errorCodeToError(EC);
153
155 M.Buf = std::move(*MemberBufferOrErr);
156 M.MemberName = M.Buf->getBufferIdentifier();
157 if (!Deterministic) {
158 M.ModTime = std::chrono::time_point_cast<std::chrono::seconds>(
159 Status.getLastModificationTime());
160 M.UID = Status.getUser();
161 M.GID = Status.getGroup();
162 M.Perms = Status.permissions();
163 }
164 return std::move(M);
165}
166
167template <typename T>
168static void printWithSpacePadding(raw_ostream &OS, T Data, unsigned Size) {
169 uint64_t OldPos = OS.tell();
170 OS << Data;
171 unsigned SizeSoFar = OS.tell() - OldPos;
172 assert(SizeSoFar <= Size && "Data doesn't fit in Size");
173 OS.indent(Size - SizeSoFar);
174}
175
180
184
188
190 switch (Kind) {
196 return false;
200 return true;
201 }
202 llvm_unreachable("not supported for writting");
203}
204
205template <class T>
211
212template <class T> static void printLE(raw_ostream &Out, T Val) {
214}
215
218 unsigned UID, unsigned GID, unsigned Perms, uint64_t Size) {
219 printWithSpacePadding(Out, sys::toTimeT(ModTime), 12);
220
221 // The format has only 6 chars for uid and gid. Truncate if the provided
222 // values don't fit.
223 printWithSpacePadding(Out, UID % 1000000, 6);
224 printWithSpacePadding(Out, GID % 1000000, 6);
225
226 printWithSpacePadding(Out, format("%o", Perms), 8);
227 printWithSpacePadding(Out, Size, 10);
228 Out << "`\n";
229}
230
231static void
234 unsigned UID, unsigned GID, unsigned Perms,
235 uint64_t Size) {
236 printWithSpacePadding(Out, Twine(Name) + "/", 16);
237 printRestOfMemberHeader(Out, ModTime, UID, GID, Perms, Size);
238}
239
240static void
243 unsigned UID, unsigned GID, unsigned Perms, uint64_t Size) {
244 uint64_t PosAfterHeader = Pos + 60 + Name.size();
245 // Pad so that even 64 bit object files are aligned.
246 unsigned Pad = offsetToAlignment(PosAfterHeader, Align(8));
247 unsigned NameWithPadding = Name.size() + Pad;
248 printWithSpacePadding(Out, Twine("#1/") + Twine(NameWithPadding), 16);
249 printRestOfMemberHeader(Out, ModTime, UID, GID, Perms,
250 NameWithPadding + Size);
251 Out << Name;
252 while (Pad--)
253 Out.write(uint8_t(0));
254}
255
256static void
259 unsigned UID, unsigned GID, unsigned Perms,
260 uint64_t Size, uint64_t PrevOffset,
261 uint64_t NextOffset) {
262 unsigned NameLen = Name.size();
263
264 printWithSpacePadding(Out, Size, 20); // File member size
265 printWithSpacePadding(Out, NextOffset, 20); // Next member header offset
266 printWithSpacePadding(Out, PrevOffset, 20); // Previous member header offset
267 printWithSpacePadding(Out, sys::toTimeT(ModTime), 12); // File member date
268 // The big archive format has 12 chars for uid and gid.
269 printWithSpacePadding(Out, UID % 1000000000000, 12); // UID
270 printWithSpacePadding(Out, GID % 1000000000000, 12); // GID
271 printWithSpacePadding(Out, format("%o", Perms), 12); // Permission
272 printWithSpacePadding(Out, NameLen, 4); // Name length
273 if (NameLen) {
274 printWithSpacePadding(Out, Name, NameLen); // Name
275 if (NameLen % 2)
276 Out.write(uint8_t(0)); // Null byte padding
277 }
278 Out << "`\n"; // Terminator
279}
280
281static bool useStringTable(bool Thin, StringRef Name) {
282 return Thin || Name.size() >= 16 || Name.contains('/');
283}
284
286 switch (Kind) {
292 return false;
296 return true;
297 }
298 llvm_unreachable("not supported for writting");
299}
300
301static void
304 bool Thin, const NewArchiveMember &M,
306 if (isBSDLike(Kind))
307 return printBSDMemberHeader(Out, Pos, M.MemberName, ModTime, M.UID, M.GID,
308 M.Perms, Size);
309 if (!useStringTable(Thin, M.MemberName))
310 return printGNUSmallMemberHeader(Out, M.MemberName, ModTime, M.UID, M.GID,
311 M.Perms, Size);
312 Out << '/';
313 uint64_t NamePos;
314 if (Thin) {
315 NamePos = StringTable.tell();
316 StringTable << M.MemberName << "/\n";
317 } else {
318 auto Insertion = MemberNames.insert({M.MemberName, uint64_t(0)});
319 if (Insertion.second) {
320 Insertion.first->second = StringTable.tell();
321 StringTable << M.MemberName;
322 if (isCOFFArchive(Kind))
323 StringTable << '\0';
324 else
325 StringTable << "/\n";
326 }
327 NamePos = Insertion.first->second;
328 }
329 printWithSpacePadding(Out, NamePos, 15);
330 printRestOfMemberHeader(Out, ModTime, M.UID, M.GID, M.Perms, Size);
331}
332
333namespace {
334struct MemberData {
335 std::vector<unsigned> Symbols;
336 std::string Header;
337 StringRef Data;
338 StringRef Padding;
339 uint64_t PreHeadPadSize = 0;
340 std::unique_ptr<SymbolicFile> SymFile = nullptr;
341};
342} // namespace
343
344static MemberData computeStringTable(StringRef Names) {
345 unsigned Size = Names.size();
346 unsigned Pad = offsetToAlignment(Size, Align(2));
347 std::string Header;
348 raw_string_ostream Out(Header);
349 printWithSpacePadding(Out, "//", 48);
350 printWithSpacePadding(Out, Size + Pad, 10);
351 Out << "`\n";
352 return {{}, std::move(Header), Names, Pad ? "\n" : ""};
353}
354
355static sys::TimePoint<std::chrono::seconds> now(bool Deterministic) {
356 using namespace std::chrono;
357
358 if (!Deterministic)
359 return time_point_cast<seconds>(system_clock::now());
361}
362
364 Expected<uint32_t> SymFlagsOrErr = S.getFlags();
365 if (!SymFlagsOrErr)
366 // TODO: Actually report errors helpfully.
367 report_fatal_error(SymFlagsOrErr.takeError());
368 if (*SymFlagsOrErr & object::SymbolRef::SF_FormatSpecific)
369 return false;
370 if (!(*SymFlagsOrErr & object::SymbolRef::SF_Global))
371 return false;
372 if (*SymFlagsOrErr & object::SymbolRef::SF_Undefined)
373 return false;
374 return true;
375}
376
378 uint64_t Val) {
379 if (is64BitKind(Kind))
380 print<uint64_t>(Out, Kind, Val);
381 else
382 print<uint32_t>(Out, Kind, Val);
383}
384
386 uint64_t NumSyms, uint64_t OffsetSize,
387 uint64_t StringTableSize,
388 uint32_t *Padding = nullptr) {
389 assert((OffsetSize == 4 || OffsetSize == 8) && "Unsupported OffsetSize");
390 uint64_t Size = OffsetSize; // Number of entries
391 if (isBSDLike(Kind))
392 Size += NumSyms * OffsetSize * 2; // Table
393 else
394 Size += NumSyms * OffsetSize; // Table
395 if (isBSDLike(Kind))
396 Size += OffsetSize; // byte count
397 Size += StringTableSize;
398 // ld64 expects the members to be 8-byte aligned for 64-bit content and at
399 // least 4-byte aligned for 32-bit content. Opt for the larger encoding
400 // uniformly.
401 // We do this for all bsd formats because it simplifies aligning members.
402 // For the big archive format, the symbol table is the last member, so there
403 // is no need to align.
405 ? 0
407
408 Size += Pad;
409 if (Padding)
410 *Padding = Pad;
411 return Size;
412}
413
415 uint32_t *Padding = nullptr) {
416 uint64_t Size = sizeof(uint32_t) * 2; // Number of symbols and objects entries
417 Size += NumObj * sizeof(uint32_t); // Offset table
418
419 for (auto S : SymMap.Map)
420 Size += sizeof(uint16_t) + S.first.length() + 1;
421
423 Size += Pad;
424 if (Padding)
425 *Padding = Pad;
426 return Size;
427}
428
430 uint32_t *Padding = nullptr) {
431 uint64_t Size = sizeof(uint32_t); // Number of symbols
432
433 for (auto S : SymMap.ECMap)
434 Size += sizeof(uint16_t) + S.first.length() + 1;
435
437 Size += Pad;
438 if (Padding)
439 *Padding = Pad;
440 return Size;
441}
442
444 bool Deterministic, uint64_t Size,
445 uint64_t PrevMemberOffset = 0,
446 uint64_t NextMemberOffset = 0) {
447 if (isBSDLike(Kind)) {
448 const char *Name = is64BitKind(Kind) ? "__.SYMDEF_64" : "__.SYMDEF";
449 printBSDMemberHeader(Out, Out.tell(), Name, now(Deterministic), 0, 0, 0,
450 Size);
451 } else if (isAIXBigArchive(Kind)) {
452 printBigArchiveMemberHeader(Out, "", now(Deterministic), 0, 0, 0, Size,
453 PrevMemberOffset, NextMemberOffset);
454 } else {
455 const char *Name = is64BitKind(Kind) ? "/SYM64" : "";
456 printGNUSmallMemberHeader(Out, Name, now(Deterministic), 0, 0, 0, Size);
457 }
458}
459
461 uint64_t NumMembers,
462 uint64_t StringMemberSize, uint64_t NumSyms,
463 uint64_t SymNamesSize, SymMap *SymMap) {
464 uint32_t OffsetSize = is64BitKind(Kind) ? 8 : 4;
465 uint64_t SymtabSize =
466 computeSymbolTableSize(Kind, NumSyms, OffsetSize, SymNamesSize);
467 auto computeSymbolTableHeaderSize = [=] {
468 SmallString<0> TmpBuf;
469 raw_svector_ostream Tmp(TmpBuf);
470 writeSymbolTableHeader(Tmp, Kind, true, SymtabSize);
471 return TmpBuf.size();
472 };
473 uint32_t HeaderSize = computeSymbolTableHeaderSize();
474 uint64_t Size = strlen("!<arch>\n") + HeaderSize + SymtabSize;
475
476 if (SymMap) {
477 Size += HeaderSize + computeSymbolMapSize(NumMembers, *SymMap);
478 if (SymMap->ECMap.size())
479 Size += HeaderSize + computeECSymbolsSize(*SymMap);
480 }
481
482 return Size + StringMemberSize;
483}
484
489 // Don't attempt to read non-symbolic file types.
491 return nullptr;
492 if (Type == file_magic::bitcode) {
494 Buf, file_magic::bitcode, &Context);
495 // An error reading a bitcode file most likely indicates that the file
496 // was created by a compiler from the future. Normally we don't try to
497 // implement forwards compatibility for bitcode files, but when creating an
498 // archive we can implement best-effort forwards compatibility by treating
499 // the file as a blob and not creating symbol index entries for it. lld and
500 // mold ignore the archive symbol index, so provided that you use one of
501 // these linkers, LTO will work as long as lld or the gold plugin is newer
502 // than the compiler. We only ignore errors if the archive format is one
503 // that is supported by a linker that is known to ignore the index,
504 // otherwise there's no chance of this working so we may as well error out.
505 // We print a warning on read failure so that users of linkers that rely on
506 // the symbol index can diagnose the issue.
507 //
508 // This is the same behavior as GNU ar when the linker plugin returns an
509 // error when reading the input file. If the bitcode file is actually
510 // malformed, it will be diagnosed at link time.
511 if (!ObjOrErr) {
512 switch (Kind) {
516 Warn(ObjOrErr.takeError());
517 return nullptr;
523 return ObjOrErr.takeError();
524 }
525 }
526 return std::move(*ObjOrErr);
527 } else {
528 auto ObjOrErr = object::SymbolicFile::createSymbolicFile(Buf);
529 if (!ObjOrErr)
530 return ObjOrErr.takeError();
531 return std::move(*ObjOrErr);
532 }
533}
534
535static bool is64BitSymbolicFile(const SymbolicFile *SymObj) {
536 return SymObj != nullptr ? SymObj->is64Bit() : false;
537}
538
539// Log2 of PAGESIZE(4096) on an AIX system.
540static const uint32_t Log2OfAIXPageSize = 12;
541
542// In the AIX big archive format, since the data content follows the member file
543// name, if the name ends on an odd byte, an extra byte will be added for
544// padding. This ensures that the data within the member file starts at an even
545// byte.
547
548template <typename AuxiliaryHeader>
549uint16_t getAuxMaxAlignment(uint16_t AuxHeaderSize, AuxiliaryHeader *AuxHeader,
550 uint16_t Log2OfMaxAlign) {
551 // If the member doesn't have an auxiliary header, it isn't a loadable object
552 // and so it just needs aligning at the minimum value.
553 if (AuxHeader == nullptr)
555
556 // If the auxiliary header does not have both MaxAlignOfData and
557 // MaxAlignOfText field, it is not a loadable shared object file, so align at
558 // the minimum value. The 'ModuleType' member is located right after
559 // 'MaxAlignOfData' in the AuxiliaryHeader.
560 if (AuxHeaderSize < offsetof(AuxiliaryHeader, ModuleType))
562
563 // If the XCOFF object file does not have a loader section, it is not
564 // loadable, so align at the minimum value.
565 if (AuxHeader->SecNumOfLoader == 0)
567
568 // The content of the loadable member file needs to be aligned at MAX(maximum
569 // alignment of .text, maximum alignment of .data) if there are both fields.
570 // If the desired alignment is > PAGESIZE, 32-bit members are aligned on a
571 // word boundary, while 64-bit members are aligned on a PAGESIZE(2^12=4096)
572 // boundary.
573 uint16_t Log2OfAlign =
574 std::max(AuxHeader->MaxAlignOfText, AuxHeader->MaxAlignOfData);
575 return 1 << (Log2OfAlign > Log2OfAIXPageSize ? Log2OfMaxAlign : Log2OfAlign);
576}
577
578// AIX big archives may contain shared object members. The AIX OS requires these
579// members to be aligned if they are 64-bit and recommends it for 32-bit
580// members. This ensures that when these members are loaded they are aligned in
581// memory.
584 if (!XCOFFObj)
586
587 // If the desired alignment is > PAGESIZE, 32-bit members are aligned on a
588 // word boundary, while 64-bit members are aligned on a PAGESIZE boundary.
589 return XCOFFObj->is64Bit()
591 XCOFFObj->auxiliaryHeader64(),
594 XCOFFObj->auxiliaryHeader32(), 2);
595}
596
598 bool Deterministic, ArrayRef<MemberData> Members,
599 StringRef StringTable, uint64_t MembersOffset,
600 unsigned NumSyms, uint64_t PrevMemberOffset = 0,
601 uint64_t NextMemberOffset = 0,
602 bool Is64Bit = false) {
603 // We don't write a symbol table on an archive with no members -- except on
604 // Darwin, where the linker will abort unless the archive has a symbol table.
605 if (StringTable.empty() && !isDarwin(Kind) && !isCOFFArchive(Kind))
606 return;
607
608 uint64_t OffsetSize = is64BitKind(Kind) ? 8 : 4;
609 uint32_t Pad;
610 uint64_t Size = computeSymbolTableSize(Kind, NumSyms, OffsetSize,
611 StringTable.size(), &Pad);
612 writeSymbolTableHeader(Out, Kind, Deterministic, Size, PrevMemberOffset,
613 NextMemberOffset);
614
615 if (isBSDLike(Kind))
616 printNBits(Out, Kind, NumSyms * 2 * OffsetSize);
617 else
618 printNBits(Out, Kind, NumSyms);
619
620 uint64_t Pos = MembersOffset;
621 for (const MemberData &M : Members) {
622 if (isAIXBigArchive(Kind)) {
623 Pos += M.PreHeadPadSize;
624 if (is64BitSymbolicFile(M.SymFile.get()) != Is64Bit) {
625 Pos += M.Header.size() + M.Data.size() + M.Padding.size();
626 continue;
627 }
628 }
629
630 for (unsigned StringOffset : M.Symbols) {
631 if (isBSDLike(Kind))
632 printNBits(Out, Kind, StringOffset);
633 printNBits(Out, Kind, Pos); // member offset
634 }
635 Pos += M.Header.size() + M.Data.size() + M.Padding.size();
636 }
637
638 if (isBSDLike(Kind))
639 // byte count of the string table
641 Out << StringTable;
642
643 while (Pad--)
644 Out.write(uint8_t(0));
645}
646
648 bool Deterministic, ArrayRef<MemberData> Members,
649 SymMap &SymMap, uint64_t MembersOffset) {
650 uint32_t Pad;
651 uint64_t Size = computeSymbolMapSize(Members.size(), SymMap, &Pad);
652 writeSymbolTableHeader(Out, Kind, Deterministic, Size, 0);
653
654 uint32_t Pos = MembersOffset;
655
656 printLE<uint32_t>(Out, Members.size());
657 for (const MemberData &M : Members) {
658 printLE(Out, Pos); // member offset
659 Pos += M.Header.size() + M.Data.size() + M.Padding.size();
660 }
661
662 printLE<uint32_t>(Out, SymMap.Map.size());
663
664 for (auto S : SymMap.Map)
665 printLE(Out, S.second);
666 for (auto S : SymMap.Map)
667 Out << S.first << '\0';
668
669 while (Pad--)
670 Out.write(uint8_t(0));
671}
672
674 bool Deterministic, ArrayRef<MemberData> Members,
675 SymMap &SymMap) {
676 uint32_t Pad;
678 printGNUSmallMemberHeader(Out, "/<ECSYMBOLS>", now(Deterministic), 0, 0, 0,
679 Size);
680
681 printLE<uint32_t>(Out, SymMap.ECMap.size());
682
683 for (auto S : SymMap.ECMap)
684 printLE(Out, S.second);
685 for (auto S : SymMap.ECMap)
686 Out << S.first << '\0';
687 while (Pad--)
688 Out.write(uint8_t(0));
689}
690
692 if (Obj.isCOFF())
693 return cast<llvm::object::COFFObjectFile>(&Obj)->getMachine() !=
695
696 if (Obj.isCOFFImportFile())
697 return cast<llvm::object::COFFImportFile>(&Obj)->getMachine() !=
699
700 if (Obj.isIR()) {
701 Expected<std::string> TripleStr =
702 getBitcodeTargetTriple(Obj.getMemoryBufferRef());
703 if (!TripleStr)
704 return false;
705 Triple T(std::move(*TripleStr));
706 return T.isWindowsArm64EC() || T.getArch() == Triple::x86_64;
707 }
708
709 return false;
710}
711
713 if (Obj.isCOFF())
714 return COFF::isAnyArm64(cast<COFFObjectFile>(&Obj)->getMachine());
715
716 if (Obj.isCOFFImportFile())
717 return COFF::isAnyArm64(cast<COFFImportFile>(&Obj)->getMachine());
718
719 if (Obj.isIR()) {
720 Expected<std::string> TripleStr =
721 getBitcodeTargetTriple(Obj.getMemoryBufferRef());
722 if (!TripleStr)
723 return false;
724 Triple T(std::move(*TripleStr));
725 return T.isOSWindows() && T.getArch() == Triple::aarch64;
726 }
727
728 return false;
729}
730
732 return Name.starts_with(ImportDescriptorPrefix) ||
734 (Name.starts_with(NullThunkDataPrefix) &&
735 Name.ends_with(NullThunkDataSuffix));
736}
737
739 uint16_t Index,
740 raw_ostream &SymNames,
741 SymMap *SymMap) {
742 std::vector<unsigned> Ret;
743
744 if (Obj == nullptr)
745 return Ret;
746
747 std::map<std::string, uint16_t> *Map = nullptr;
748 if (SymMap)
749 Map = SymMap->UseECMap && isECObject(*Obj) ? &SymMap->ECMap : &SymMap->Map;
750
751 for (const object::BasicSymbolRef &S : Obj->symbols()) {
752 if (!isArchiveSymbol(S))
753 continue;
754 if (Map) {
755 std::string Name;
756 raw_string_ostream NameStream(Name);
757 if (Error E = S.printName(NameStream))
758 return std::move(E);
759 if (!Map->try_emplace(Name, Index).second)
760 continue; // ignore duplicated symbol
761 if (Map == &SymMap->Map) {
762 Ret.push_back(SymNames.tell());
763 SymNames << Name << '\0';
764 // If EC is enabled, then the import descriptors are NOT put into EC
765 // objects so we need to copy them to the EC map manually.
766 if (SymMap->UseECMap && isImportDescriptor(Name))
767 SymMap->ECMap[Name] = Index;
768 }
769 } else {
770 Ret.push_back(SymNames.tell());
771 if (Error E = S.printName(SymNames))
772 return std::move(E);
773 SymNames << '\0';
774 }
775 }
776 return Ret;
777}
778
781 object::Archive::Kind Kind, bool Thin, bool Deterministic,
782 SymtabWritingMode NeedSymbols, SymMap *SymMap,
783 LLVMContext &Context, ArrayRef<NewArchiveMember> NewMembers,
784 std::optional<bool> IsEC, function_ref<void(Error)> Warn) {
785 static char PaddingData[8] = {'\n', '\n', '\n', '\n', '\n', '\n', '\n', '\n'};
786 uint64_t Pos =
788
789 std::vector<MemberData> Ret;
790 bool HasObject = false;
791
792 // Deduplicate long member names in the string table and reuse earlier name
793 // offsets. This especially saves space for COFF Import libraries where all
794 // members have the same name.
795 StringMap<uint64_t> MemberNames;
796
797 // UniqueTimestamps is a special case to improve debugging on Darwin:
798 //
799 // The Darwin linker does not link debug info into the final
800 // binary. Instead, it emits entries of type N_OSO in the output
801 // binary's symbol table, containing references to the linked-in
802 // object files. Using that reference, the debugger can read the
803 // debug data directly from the object files. Alternatively, an
804 // invocation of 'dsymutil' will link the debug data from the object
805 // files into a dSYM bundle, which can be loaded by the debugger,
806 // instead of the object files.
807 //
808 // For an object file, the N_OSO entries contain the absolute path
809 // path to the file, and the file's timestamp. For an object
810 // included in an archive, the path is formatted like
811 // "/absolute/path/to/archive.a(member.o)", and the timestamp is the
812 // archive member's timestamp, rather than the archive's timestamp.
813 //
814 // However, this doesn't always uniquely identify an object within
815 // an archive -- an archive file can have multiple entries with the
816 // same filename. (This will happen commonly if the original object
817 // files started in different directories.) The only way they get
818 // distinguished, then, is via the timestamp. But this process is
819 // unable to find the correct object file in the archive when there
820 // are two files of the same name and timestamp.
821 //
822 // Additionally, timestamp==0 is treated specially, and causes the
823 // timestamp to be ignored as a match criteria.
824 //
825 // That will "usually" work out okay when creating an archive not in
826 // deterministic timestamp mode, because the objects will probably
827 // have been created at different timestamps.
828 //
829 // To ameliorate this problem, in deterministic archive mode (which
830 // is the default), on Darwin we will emit a unique non-zero
831 // timestamp for each entry with a duplicated name. This is still
832 // deterministic: the only thing affecting that timestamp is the
833 // order of the files in the resultant archive.
834 //
835 // See also the functions that handle the lookup:
836 // in lldb: ObjectContainerBSDArchive::Archive::FindObject()
837 // in llvm/tools/dsymutil: BinaryHolder::GetArchiveMemberBuffers().
838 bool UniqueTimestamps = Deterministic && isDarwin(Kind);
839 std::map<StringRef, unsigned> FilenameCount;
840 if (UniqueTimestamps) {
841 for (const NewArchiveMember &M : NewMembers)
842 FilenameCount[M.MemberName]++;
843 for (auto &Entry : FilenameCount)
844 Entry.second = Entry.second > 1 ? 1 : 0;
845 }
846
847 for (const NewArchiveMember &M : NewMembers) {
848 MemberData &D = Ret.emplace_back();
849
850 if (NeedSymbols != SymtabWritingMode::NoSymtab || isAIXBigArchive(Kind)) {
852 M.Buf->getMemBufferRef(), Context, Kind, [&](Error Err) {
853 Warn(createFileError(M.MemberName, std::move(Err)));
854 });
855 if (!SymFileOrErr)
856 return createFileError(M.MemberName, SymFileOrErr.takeError());
857 D.SymFile = std::move(*SymFileOrErr);
858 }
859 }
860
861 if (SymMap) {
862 if (IsEC) {
863 SymMap->UseECMap = *IsEC;
864 } else {
865 // When IsEC is not specified by the caller, use it when we have both
866 // any ARM64 object (ARM64 or ARM64EC) and any EC object (ARM64EC or
867 // AMD64). This may be a single ARM64EC object, but may also be separate
868 // ARM64 and AMD64 objects.
869 bool HaveArm64 = false, HaveEC = false;
870 for (const MemberData &D : Ret) {
871 if (!D.SymFile)
872 continue;
873 if (!HaveArm64)
874 HaveArm64 = isAnyArm64COFF(*D.SymFile);
875 if (!HaveEC)
876 HaveEC = isECObject(*D.SymFile);
877 if (HaveArm64 && HaveEC) {
878 SymMap->UseECMap = true;
879 break;
880 }
881 }
882 }
883 }
884
885 // The big archive format needs to know the offset of the previous member
886 // header.
887 uint64_t PrevOffset = 0;
888 uint64_t NextMemHeadPadSize = 0;
889
890 for (uint32_t Index = 0; Index < Ret.size(); ++Index) {
891 MemberData &D = Ret[Index];
892 const NewArchiveMember *M = &NewMembers[Index];
893 raw_string_ostream Out(D.Header);
894
895 MemoryBufferRef Buf = M->Buf->getMemBufferRef();
896 D.Data = Thin ? "" : Buf.getBuffer();
897
898 // ld64 expects the members to be 8-byte aligned for 64-bit content and at
899 // least 4-byte aligned for 32-bit content. Opt for the larger encoding
900 // uniformly. This matches the behaviour with cctools and ensures that ld64
901 // is happy with archives that we generate.
902 unsigned MemberPadding =
903 isDarwin(Kind) ? offsetToAlignment(D.Data.size(), Align(8)) : 0;
904 unsigned TailPadding =
905 offsetToAlignment(D.Data.size() + MemberPadding, Align(2));
906 D.Padding = StringRef(PaddingData, MemberPadding + TailPadding);
907
909 if (UniqueTimestamps)
910 // Increment timestamp for each file of a given name.
911 ModTime = sys::toTimePoint(FilenameCount[M->MemberName]++);
912 else
913 ModTime = M->ModTime;
914
915 uint64_t Size = Buf.getBufferSize() + MemberPadding;
917 std::string StringMsg =
918 "File " + M->MemberName.str() + " exceeds size limit";
920 std::move(StringMsg), object::object_error::parse_failed);
921 }
922
923 // In the big archive file format, we need to calculate and include the next
924 // member offset and previous member offset in the file member header.
925 if (isAIXBigArchive(Kind)) {
926 uint64_t OffsetToMemData = Pos + sizeof(object::BigArMemHdrType) +
927 alignTo(M->MemberName.size(), 2);
928
929 if (Index == 0)
930 NextMemHeadPadSize =
931 alignToPowerOf2(OffsetToMemData,
932 getMemberAlignment(D.SymFile.get())) -
933 OffsetToMemData;
934
935 D.PreHeadPadSize = NextMemHeadPadSize;
936 Pos += D.PreHeadPadSize;
937 uint64_t NextOffset = Pos + sizeof(object::BigArMemHdrType) +
938 alignTo(M->MemberName.size(), 2) + alignTo(Size, 2);
939
940 // If there is another member file after this, we need to calculate the
941 // padding before the header.
942 if (Index + 1 != Ret.size()) {
943 uint64_t OffsetToNextMemData =
944 NextOffset + sizeof(object::BigArMemHdrType) +
945 alignTo(NewMembers[Index + 1].MemberName.size(), 2);
946 NextMemHeadPadSize =
947 alignToPowerOf2(OffsetToNextMemData,
948 getMemberAlignment(Ret[Index + 1].SymFile.get())) -
949 OffsetToNextMemData;
950 NextOffset += NextMemHeadPadSize;
951 }
952 printBigArchiveMemberHeader(Out, M->MemberName, ModTime, M->UID, M->GID,
953 M->Perms, Size, PrevOffset, NextOffset);
954 PrevOffset = Pos;
955 } else {
956 printMemberHeader(Out, Pos, StringTable, MemberNames, Kind, Thin, *M,
957 ModTime, Size);
958 }
959
960 if (NeedSymbols != SymtabWritingMode::NoSymtab) {
961 Expected<std::vector<unsigned>> SymbolsOrErr =
962 getSymbols(D.SymFile.get(), Index + 1, SymNames, SymMap);
963 if (!SymbolsOrErr)
964 return createFileError(M->MemberName, SymbolsOrErr.takeError());
965 D.Symbols = std::move(*SymbolsOrErr);
966 if (D.SymFile)
967 HasObject = true;
968 }
969
970 Pos += D.Header.size() + D.Data.size() + D.Padding.size();
971 }
972 // If there are no symbols, emit an empty symbol table, to satisfy Solaris
973 // tools, older versions of which expect a symbol table in a non-empty
974 // archive, regardless of whether there are any symbols in it.
975 if (HasObject && SymNames.tell() == 0 && !isCOFFArchive(Kind))
976 SymNames << '\0' << '\0' << '\0';
977 return std::move(Ret);
978}
979
980namespace llvm {
981
983 SmallString<128> Ret = P;
984 std::error_code Err = sys::fs::make_absolute(Ret);
985 if (Err)
986 return Err;
987 sys::path::remove_dots(Ret, /*removedotdot*/ true);
988 return Ret;
989}
990
991// Compute the relative path from From to To.
994 ErrorOr<SmallString<128>> DirFromOrErr = canonicalizePath(From);
995 if (!PathToOrErr || !DirFromOrErr)
997
998 const SmallString<128> &PathTo = *PathToOrErr;
999 const SmallString<128> &DirFrom = sys::path::parent_path(*DirFromOrErr);
1000
1001 // Can't construct a relative path between different roots
1002 if (sys::path::root_name(PathTo) != sys::path::root_name(DirFrom))
1003 return sys::path::convert_to_slash(PathTo);
1004
1005 // Skip common prefixes
1006 auto FromTo =
1007 std::mismatch(sys::path::begin(DirFrom), sys::path::end(DirFrom),
1008 sys::path::begin(PathTo));
1009 auto FromI = FromTo.first;
1010 auto ToI = FromTo.second;
1011
1012 // Construct relative path
1013 SmallString<128> Relative;
1014 for (auto FromE = sys::path::end(DirFrom); FromI != FromE; ++FromI)
1016
1017 for (auto ToE = sys::path::end(PathTo); ToI != ToE; ++ToI)
1019
1020 return std::string(Relative);
1021}
1022
1024 ArrayRef<NewArchiveMember> NewMembers,
1025 SymtabWritingMode WriteSymtab,
1026 object::Archive::Kind Kind, bool Deterministic,
1027 bool Thin, std::optional<bool> IsEC,
1028 function_ref<void(Error)> Warn) {
1029 assert((!Thin || !isBSDLike(Kind)) && "Only the gnu format has a thin mode");
1030
1031 SmallString<0> SymNamesBuf;
1032 raw_svector_ostream SymNames(SymNamesBuf);
1033 SmallString<0> StringTableBuf;
1034 raw_svector_ostream StringTable(StringTableBuf);
1035 SymMap SymMap;
1036 bool ShouldWriteSymtab = WriteSymtab != SymtabWritingMode::NoSymtab;
1037
1038 // COFF symbol map uses 16-bit indexes, so we can't use it if there are too
1039 // many members. COFF format also requires symbol table presence, so use
1040 // GNU format when NoSymtab is requested.
1041 if (isCOFFArchive(Kind) && (NewMembers.size() > 0xfffe || !ShouldWriteSymtab))
1043
1044 // In the scenario when LLVMContext is populated SymbolicFile will contain a
1045 // reference to it, thus SymbolicFile should be destroyed first.
1046 LLVMContext Context;
1047
1049 StringTable, SymNames, Kind, Thin, Deterministic, WriteSymtab,
1050 isCOFFArchive(Kind) ? &SymMap : nullptr, Context, NewMembers, IsEC, Warn);
1051 if (Error E = DataOrErr.takeError())
1052 return E;
1053 std::vector<MemberData> &Data = *DataOrErr;
1054
1055 uint64_t StringTableSize = 0;
1056 MemberData StringTableMember;
1057 if (!StringTableBuf.empty() && !isAIXBigArchive(Kind)) {
1058 StringTableMember = computeStringTable(StringTableBuf);
1059 StringTableSize = StringTableMember.Header.size() +
1060 StringTableMember.Data.size() +
1061 StringTableMember.Padding.size();
1062 }
1063
1064 // We would like to detect if we need to switch to a 64-bit symbol table.
1065 uint64_t LastMemberEndOffset = 0;
1066 uint64_t LastMemberHeaderOffset = 0;
1067 uint64_t NumSyms = 0;
1068 uint64_t NumSyms32 = 0; // Store symbol number of 32-bit member files.
1069
1070 for (const auto &M : Data) {
1071 // Record the start of the member's offset
1072 LastMemberEndOffset += M.PreHeadPadSize;
1073 LastMemberHeaderOffset = LastMemberEndOffset;
1074 // Account for the size of each part associated with the member.
1075 LastMemberEndOffset += M.Header.size() + M.Data.size() + M.Padding.size();
1076 NumSyms += M.Symbols.size();
1077
1078 // AIX big archive files may contain two global symbol tables. The
1079 // first global symbol table locates 32-bit file members that define global
1080 // symbols; the second global symbol table does the same for 64-bit file
1081 // members. As a big archive can have both 32-bit and 64-bit file members,
1082 // we need to know the number of symbols in each symbol table individually.
1083 if (isAIXBigArchive(Kind) && ShouldWriteSymtab) {
1084 if (!is64BitSymbolicFile(M.SymFile.get()))
1085 NumSyms32 += M.Symbols.size();
1086 }
1087 }
1088
1089 std::optional<uint64_t> HeadersSize;
1090
1091 // The symbol table is put at the end of the big archive file. The symbol
1092 // table is at the start of the archive file for other archive formats.
1093 if (ShouldWriteSymtab && !is64BitKind(Kind)) {
1094 // We assume 32-bit offsets to see if 32-bit symbols are possible or not.
1095 HeadersSize = computeHeadersSize(Kind, Data.size(), StringTableSize,
1096 NumSyms, SymNamesBuf.size(),
1097 isCOFFArchive(Kind) ? &SymMap : nullptr);
1098
1099 // The SYM64 format is used when an archive's member offsets are larger than
1100 // 32-bits can hold. The need for this shift in format is detected by
1101 // writeArchive. To test this we need to generate a file with a member that
1102 // has an offset larger than 32-bits but this demands a very slow test. To
1103 // speed the test up we use this environment variable to pretend like the
1104 // cutoff happens before 32-bits and instead happens at some much smaller
1105 // value.
1106 uint64_t Sym64Threshold = 1ULL << 32;
1107 const char *Sym64Env = std::getenv("SYM64_THRESHOLD");
1108 if (Sym64Env)
1109 StringRef(Sym64Env).getAsInteger(10, Sym64Threshold);
1110
1111 // If LastMemberHeaderOffset isn't going to fit in a 32-bit varible we need
1112 // to switch to 64-bit. Note that the file can be larger than 4GB as long as
1113 // the last member starts before the 4GB offset.
1114 if (*HeadersSize + LastMemberHeaderOffset >= Sym64Threshold) {
1115 switch (Kind) {
1117 // COFF format has no 64-bit version, so we use GNU64 instead.
1118 if (!SymMap.Map.empty() && !SymMap.ECMap.empty())
1119 // Only the COFF format supports the ECSYMBOLS section, so don’t use
1120 // GNU64 when two symbol maps are required.
1122 "Archive is too large: ARM64X does not support archives larger "
1123 "than 4GB");
1124 // Since this changes the headers, we need to recalculate everything.
1125 return writeArchiveToStream(Out, NewMembers, WriteSymtab,
1126 object::Archive::K_GNU64, Deterministic,
1127 Thin, IsEC, Warn);
1130 break;
1131 default:
1133 break;
1134 }
1135 HeadersSize.reset();
1136 }
1137 }
1138
1139 if (Thin)
1140 Out << "!<thin>\n";
1141 else if (isAIXBigArchive(Kind))
1142 Out << "<bigaf>\n";
1143 else
1144 Out << "!<arch>\n";
1145
1146 if (!isAIXBigArchive(Kind)) {
1147 if (ShouldWriteSymtab) {
1148 if (!HeadersSize)
1149 HeadersSize = computeHeadersSize(
1150 Kind, Data.size(), StringTableSize, NumSyms, SymNamesBuf.size(),
1151 isCOFFArchive(Kind) ? &SymMap : nullptr);
1152 writeSymbolTable(Out, Kind, Deterministic, Data, SymNamesBuf,
1153 *HeadersSize, NumSyms);
1154
1155 if (isCOFFArchive(Kind))
1156 writeSymbolMap(Out, Kind, Deterministic, Data, SymMap, *HeadersSize);
1157 }
1158
1159 if (StringTableSize)
1160 Out << StringTableMember.Header << StringTableMember.Data
1161 << StringTableMember.Padding;
1162
1163 if (ShouldWriteSymtab && SymMap.ECMap.size())
1164 writeECSymbols(Out, Kind, Deterministic, Data, SymMap);
1165
1166 for (const MemberData &M : Data)
1167 Out << M.Header << M.Data << M.Padding;
1168 } else {
1169 HeadersSize = sizeof(object::BigArchive::FixLenHdr);
1170 LastMemberEndOffset += *HeadersSize;
1171 LastMemberHeaderOffset += *HeadersSize;
1172
1173 // For the big archive (AIX) format, compute a table of member names and
1174 // offsets, used in the member table.
1175 uint64_t MemberTableNameStrTblSize = 0;
1176 std::vector<size_t> MemberOffsets;
1177 std::vector<StringRef> MemberNames;
1178 // Loop across object to find offset and names.
1179 uint64_t MemberEndOffset = sizeof(object::BigArchive::FixLenHdr);
1180 for (size_t I = 0, Size = NewMembers.size(); I != Size; ++I) {
1181 const NewArchiveMember &Member = NewMembers[I];
1182 MemberTableNameStrTblSize += Member.MemberName.size() + 1;
1183 MemberEndOffset += Data[I].PreHeadPadSize;
1184 MemberOffsets.push_back(MemberEndOffset);
1185 MemberNames.push_back(Member.MemberName);
1186 // File member name ended with "`\n". The length is included in
1187 // BigArMemHdrType.
1188 MemberEndOffset += sizeof(object::BigArMemHdrType) +
1189 alignTo(Data[I].Data.size(), 2) +
1190 alignTo(Member.MemberName.size(), 2);
1191 }
1192
1193 // AIX member table size.
1194 uint64_t MemberTableSize = 20 + // Number of members field
1195 20 * MemberOffsets.size() +
1196 MemberTableNameStrTblSize;
1197
1198 SmallString<0> SymNamesBuf32;
1199 SmallString<0> SymNamesBuf64;
1200 raw_svector_ostream SymNames32(SymNamesBuf32);
1201 raw_svector_ostream SymNames64(SymNamesBuf64);
1202
1203 if (ShouldWriteSymtab && NumSyms)
1204 // Generate the symbol names for the members.
1205 for (const auto &M : Data) {
1207 M.SymFile.get(), 0,
1208 is64BitSymbolicFile(M.SymFile.get()) ? SymNames64 : SymNames32,
1209 nullptr);
1210 if (!SymbolsOrErr)
1211 return SymbolsOrErr.takeError();
1212 }
1213
1214 uint64_t MemberTableEndOffset =
1215 LastMemberEndOffset +
1216 alignTo(sizeof(object::BigArMemHdrType) + MemberTableSize, 2);
1217
1218 // In AIX OS, The 'GlobSymOffset' field in the fixed-length header contains
1219 // the offset to the 32-bit global symbol table, and the 'GlobSym64Offset'
1220 // contains the offset to the 64-bit global symbol table.
1221 uint64_t GlobalSymbolOffset =
1222 (ShouldWriteSymtab &&
1223 (WriteSymtab != SymtabWritingMode::BigArchive64) && NumSyms32 > 0)
1224 ? MemberTableEndOffset
1225 : 0;
1226
1227 uint64_t GlobalSymbolOffset64 = 0;
1228 uint64_t NumSyms64 = NumSyms - NumSyms32;
1229 if (ShouldWriteSymtab && (WriteSymtab != SymtabWritingMode::BigArchive32) &&
1230 NumSyms64 > 0) {
1231 if (GlobalSymbolOffset == 0)
1232 GlobalSymbolOffset64 = MemberTableEndOffset;
1233 else
1234 // If there is a global symbol table for 32-bit members,
1235 // the 64-bit global symbol table is after the 32-bit one.
1236 GlobalSymbolOffset64 =
1237 GlobalSymbolOffset + sizeof(object::BigArMemHdrType) +
1238 (NumSyms32 + 1) * 8 + alignTo(SymNamesBuf32.size(), 2);
1239 }
1240
1241 // Fixed Sized Header.
1242 printWithSpacePadding(Out, NewMembers.size() ? LastMemberEndOffset : 0,
1243 20); // Offset to member table
1244 // If there are no file members in the archive, there will be no global
1245 // symbol table.
1246 printWithSpacePadding(Out, GlobalSymbolOffset, 20);
1247 printWithSpacePadding(Out, GlobalSymbolOffset64, 20);
1249 NewMembers.size()
1251 Data[0].PreHeadPadSize
1252 : 0,
1253 20); // Offset to first archive member
1254 printWithSpacePadding(Out, NewMembers.size() ? LastMemberHeaderOffset : 0,
1255 20); // Offset to last archive member
1257 Out, 0,
1258 20); // Offset to first member of free list - Not supported yet
1259
1260 for (const MemberData &M : Data) {
1261 Out << std::string(M.PreHeadPadSize, '\0');
1262 Out << M.Header << M.Data;
1263 if (M.Data.size() % 2)
1264 Out << '\0';
1265 }
1266
1267 if (NewMembers.size()) {
1268 // Member table.
1269 printBigArchiveMemberHeader(Out, "", sys::toTimePoint(0), 0, 0, 0,
1270 MemberTableSize, LastMemberHeaderOffset,
1271 GlobalSymbolOffset ? GlobalSymbolOffset
1272 : GlobalSymbolOffset64);
1273 printWithSpacePadding(Out, MemberOffsets.size(), 20); // Number of members
1274 for (uint64_t MemberOffset : MemberOffsets)
1275 printWithSpacePadding(Out, MemberOffset,
1276 20); // Offset to member file header.
1277 for (StringRef MemberName : MemberNames)
1278 Out << MemberName << '\0'; // Member file name, null byte padding.
1279
1280 if (MemberTableNameStrTblSize % 2)
1281 Out << '\0'; // Name table must be tail padded to an even number of
1282 // bytes.
1283
1284 if (ShouldWriteSymtab) {
1285 // Write global symbol table for 32-bit file members.
1286 if (GlobalSymbolOffset) {
1287 writeSymbolTable(Out, Kind, Deterministic, Data, SymNamesBuf32,
1288 *HeadersSize, NumSyms32, LastMemberEndOffset,
1289 GlobalSymbolOffset64);
1290 // Add padding between the symbol tables, if needed.
1291 if (GlobalSymbolOffset64 && (SymNamesBuf32.size() % 2))
1292 Out << '\0';
1293 }
1294
1295 // Write global symbol table for 64-bit file members.
1296 if (GlobalSymbolOffset64)
1297 writeSymbolTable(Out, Kind, Deterministic, Data, SymNamesBuf64,
1298 *HeadersSize, NumSyms64,
1299 GlobalSymbolOffset ? GlobalSymbolOffset
1300 : LastMemberEndOffset,
1301 0, true);
1302 }
1303 }
1304 }
1305 Out.flush();
1306 return Error::success();
1307}
1308
1310 llvm::logAllUnhandledErrors(std::move(Err), llvm::errs(), "warning: ");
1311}
1312
1315 bool Deterministic, bool Thin,
1316 std::unique_ptr<MemoryBuffer> OldArchiveBuf,
1317 std::optional<bool> IsEC, function_ref<void(Error)> Warn) {
1319 sys::fs::TempFile::create(ArcName + ".temp-archive-%%%%%%%.a");
1320 if (!Temp)
1321 return Temp.takeError();
1322 raw_fd_ostream Out(Temp->FD, false);
1323
1324 if (Error E = writeArchiveToStream(Out, NewMembers, WriteSymtab, Kind,
1325 Deterministic, Thin, IsEC, Warn)) {
1326 if (Error DiscardError = Temp->discard())
1327 return joinErrors(std::move(E), std::move(DiscardError));
1328 return E;
1329 }
1330
1331 // At this point, we no longer need whatever backing memory
1332 // was used to generate the NewMembers. On Windows, this buffer
1333 // could be a mapped view of the file we want to replace (if
1334 // we're updating an existing archive, say). In that case, the
1335 // rename would still succeed, but it would leave behind a
1336 // temporary file (actually the original file renamed) because
1337 // a file cannot be deleted while there's a handle open on it,
1338 // only renamed. So by freeing this buffer, this ensures that
1339 // the last open handle on the destination file, if any, is
1340 // closed before we attempt to rename.
1341 OldArchiveBuf.reset();
1342
1343 return Temp->keep(ArcName);
1344}
1345
1349 bool Deterministic, bool Thin,
1350 function_ref<void(Error)> Warn) {
1351 SmallVector<char, 0> ArchiveBufferVector;
1352 raw_svector_ostream ArchiveStream(ArchiveBufferVector);
1353
1354 if (Error E =
1355 writeArchiveToStream(ArchiveStream, NewMembers, WriteSymtab, Kind,
1356 Deterministic, Thin, std::nullopt, Warn))
1357 return std::move(E);
1358
1359 return std::make_unique<SmallVectorMemoryBuffer>(
1360 std::move(ArchiveBufferVector), /*RequiresNullTerminator=*/false);
1361}
1362
1363} // namespace llvm
assert(UImm &&(UImm !=~static_cast< T >(0)) &&"Invalid immediate!")
This file defines the StringMap class.
static void printNBits(raw_ostream &Out, object::Archive::Kind Kind, uint64_t Val)
bool isImportDescriptor(StringRef Name)
static sys::TimePoint< std::chrono::seconds > now(bool Deterministic)
static bool isDarwin(object::Archive::Kind Kind)
static uint64_t computeECSymbolsSize(SymMap &SymMap, uint32_t *Padding=nullptr)
static Expected< std::vector< unsigned > > getSymbols(SymbolicFile *Obj, uint16_t Index, raw_ostream &SymNames, SymMap *SymMap)
static bool is64BitSymbolicFile(const SymbolicFile *SymObj)
static uint64_t computeHeadersSize(object::Archive::Kind Kind, uint64_t NumMembers, uint64_t StringMemberSize, uint64_t NumSyms, uint64_t SymNamesSize, SymMap *SymMap)
static bool isBSDLike(object::Archive::Kind Kind)
static void printBSDMemberHeader(raw_ostream &Out, uint64_t Pos, StringRef Name, const sys::TimePoint< std::chrono::seconds > &ModTime, unsigned UID, unsigned GID, unsigned Perms, uint64_t Size)
static void writeSymbolTable(raw_ostream &Out, object::Archive::Kind Kind, bool Deterministic, ArrayRef< MemberData > Members, StringRef StringTable, uint64_t MembersOffset, unsigned NumSyms, uint64_t PrevMemberOffset=0, uint64_t NextMemberOffset=0, bool Is64Bit=false)
static const uint32_t MinBigArchiveMemDataAlign
static void writeSymbolMap(raw_ostream &Out, object::Archive::Kind Kind, bool Deterministic, ArrayRef< MemberData > Members, SymMap &SymMap, uint64_t MembersOffset)
static MemberData computeStringTable(StringRef Names)
uint16_t getAuxMaxAlignment(uint16_t AuxHeaderSize, AuxiliaryHeader *AuxHeader, uint16_t Log2OfMaxAlign)
static const uint32_t Log2OfAIXPageSize
static bool isECObject(object::SymbolicFile &Obj)
static Expected< std::unique_ptr< SymbolicFile > > getSymbolicFile(MemoryBufferRef Buf, LLVMContext &Context, object::Archive::Kind Kind, function_ref< void(Error)> Warn)
static bool isAIXBigArchive(object::Archive::Kind Kind)
static void writeSymbolTableHeader(raw_ostream &Out, object::Archive::Kind Kind, bool Deterministic, uint64_t Size, uint64_t PrevMemberOffset=0, uint64_t NextMemberOffset=0)
static void printRestOfMemberHeader(raw_ostream &Out, const sys::TimePoint< std::chrono::seconds > &ModTime, unsigned UID, unsigned GID, unsigned Perms, uint64_t Size)
static uint64_t computeSymbolTableSize(object::Archive::Kind Kind, uint64_t NumSyms, uint64_t OffsetSize, uint64_t StringTableSize, uint32_t *Padding=nullptr)
static bool isArchiveSymbol(const object::BasicSymbolRef &S)
static bool isCOFFArchive(object::Archive::Kind Kind)
static Expected< std::vector< MemberData > > computeMemberData(raw_ostream &StringTable, raw_ostream &SymNames, object::Archive::Kind Kind, bool Thin, bool Deterministic, SymtabWritingMode NeedSymbols, SymMap *SymMap, LLVMContext &Context, ArrayRef< NewArchiveMember > NewMembers, std::optional< bool > IsEC, function_ref< void(Error)> Warn)
static void printMemberHeader(raw_ostream &Out, uint64_t Pos, raw_ostream &StringTable, StringMap< uint64_t > &MemberNames, object::Archive::Kind Kind, bool Thin, const NewArchiveMember &M, sys::TimePoint< std::chrono::seconds > ModTime, uint64_t Size)
static void writeECSymbols(raw_ostream &Out, object::Archive::Kind Kind, bool Deterministic, ArrayRef< MemberData > Members, SymMap &SymMap)
static uint64_t computeSymbolMapSize(uint64_t NumObj, SymMap &SymMap, uint32_t *Padding=nullptr)
static void printLE(raw_ostream &Out, T Val)
static void printGNUSmallMemberHeader(raw_ostream &Out, StringRef Name, const sys::TimePoint< std::chrono::seconds > &ModTime, unsigned UID, unsigned GID, unsigned Perms, uint64_t Size)
static bool useStringTable(bool Thin, StringRef Name)
static bool is64BitKind(object::Archive::Kind Kind)
static uint32_t getMemberAlignment(SymbolicFile *SymObj)
static void printBigArchiveMemberHeader(raw_ostream &Out, StringRef Name, const sys::TimePoint< std::chrono::seconds > &ModTime, unsigned UID, unsigned GID, unsigned Perms, uint64_t Size, uint64_t PrevOffset, uint64_t NextOffset)
static void printWithSpacePadding(raw_ostream &OS, T Data, unsigned Size)
static bool isAnyArm64COFF(object::SymbolicFile &Obj)
static GCRegistry::Add< StatepointGC > D("statepoint-example", "an example strategy for statepoint")
static GCRegistry::Add< CoreCLRGC > E("coreclr", "CoreCLR-compatible GC")
#define offsetof(TYPE, MEMBER)
#define I(x, y, z)
Definition MD5.cpp:57
#define T
#define P(N)
Represent a constant reference to an array (0 or more elements consecutively in memory),...
Definition ArrayRef.h:40
size_t size() const
Get the array size.
Definition ArrayRef.h:141
Represents either an error or a value T.
Definition ErrorOr.h:56
std::error_code getError() const
Definition ErrorOr.h:152
Lightweight error class with error context and mandatory checking.
Definition Error.h:159
static ErrorSuccess success()
Create a success value.
Definition Error.h:336
Tagged union holding either a T or a Error.
Definition Error.h:485
Error takeError()
Take ownership of the stored error.
Definition Error.h:612
reference get()
Returns a reference to the stored T value.
Definition Error.h:582
This is an important class for using LLVM in a threaded context.
Definition LLVMContext.h:68
size_t getBufferSize() const
StringRef getBuffer() const
This interface provides simple read-only access to a block of memory, and provides simple methods for...
static ErrorOr< std::unique_ptr< MemoryBuffer > > getOpenFile(sys::fs::file_t FD, const Twine &Filename, uint64_t FileSize, bool RequiresNullTerminator=true, bool IsVolatile=false, std::optional< Align > Alignment=std::nullopt)
Given an already-open file descriptor, read the file and return a MemoryBuffer.
static std::unique_ptr< MemoryBuffer > getMemBuffer(StringRef InputData, StringRef BufferName="", bool RequiresNullTerminator=true)
Open the specified memory range as a MemoryBuffer.
SmallString - A SmallString is just a SmallVector with methods and accessors that make it work better...
Definition SmallString.h:26
This is a 'vector' (really, a variable-sized array), optimized for the case when the array is small.
StringMap - This is an unconventional map that is specialized for handling keys that are "strings",...
Definition StringMap.h:128
bool insert(MapEntryTy *KeyValue)
insert - Insert the specified key/value pair into the map.
Definition StringMap.h:310
Represent a constant reference to a string, i.e.
Definition StringRef.h:56
bool getAsInteger(unsigned Radix, T &Result) const
Parse the current string as an integer of the specified radix.
Definition StringRef.h:490
constexpr size_t size() const
Get the string size.
Definition StringRef.h:144
A table of densely packed, null-terminated strings indexed by offset.
Definition StringTable.h:34
constexpr size_t size() const
Returns the byte size of the table.
Triple - Helper class for working with autoconf configuration names.
Definition Triple.h:47
Twine - A lightweight data structure for efficiently representing the concatenation of temporary valu...
Definition Twine.h:82
The instances of the Type class are immutable: once they are created, they are never changed.
Definition Type.h:46
An efficient, type-erasing, non-owning reference to a callable.
Expected< unsigned > getGID() const
Definition Archive.h:281
LLVM_ABI Expected< MemoryBufferRef > getMemoryBufferRef() const
Definition Archive.cpp:762
Expected< unsigned > getUID() const
Definition Archive.h:280
Expected< sys::fs::perms > getAccessMode() const
Definition Archive.h:283
Expected< sys::TimePoint< std::chrono::seconds > > getLastModified() const
Definition Archive.h:272
static object::Archive::Kind getDefaultKind()
Definition Archive.cpp:1110
static object::Archive::Kind getDefaultKindForTriple(const Triple &T)
Definition Archive.cpp:1098
static const uint64_t MaxMemberSize
Size field is 10 decimal digits long.
Definition Archive.h:384
This is a value type class that represents a single symbol in the list of symbols in the object file.
Expected< uint32_t > getFlags() const
Get symbol flags (bitwise OR of SymbolRef::Flags)
static Expected< OwningBinary< ObjectFile > > createObjectFile(StringRef ObjectPath)
static Expected< std::unique_ptr< SymbolicFile > > createSymbolicFile(MemoryBufferRef Object, llvm::file_magic Type, LLVMContext *Context, bool InitContent=true)
virtual bool is64Bit() const =0
static bool isSymbolicFile(file_magic Type, const LLVMContext *Context)
const XCOFFAuxiliaryHeader32 * auxiliaryHeader32() const
const XCOFFFileHeader64 * fileHeader64() const
const XCOFFFileHeader32 * fileHeader32() const
const XCOFFAuxiliaryHeader64 * auxiliaryHeader64() const
A raw_ostream that writes to a file descriptor.
This class implements an extremely fast bulk output stream that can only output to a stream.
Definition raw_ostream.h:53
uint64_t tell() const
tell - Return the current offset with the file.
raw_ostream & write(unsigned char C)
raw_ostream & indent(unsigned NumSpaces)
indent - Insert 'NumSpaces' spaces.
A raw_ostream that writes to an std::string.
A raw_ostream that writes to an SmallVector or SmallString.
static LLVM_ABI Expected< TempFile > create(const Twine &Model, unsigned Mode=all_read|all_write, OpenFlags ExtraFlags=OF_None)
This creates a temporary file with createUniqueFile and schedules it for deletion with sys::RemoveFil...
Represents the result of a call to sys::fs::status().
Definition FileSystem.h:222
#define llvm_unreachable(msg)
Marks that the current location is not supposed to be reachable.
@ IMAGE_FILE_MACHINE_ARM64
Definition COFF.h:101
bool isAnyArm64(T Machine)
Definition COFF.h:130
constexpr std::string_view NullImportDescriptorSymbolName
constexpr std::string_view NullThunkDataPrefix
constexpr std::string_view NullThunkDataSuffix
constexpr std::string_view ImportDescriptorPrefix
void write(void *memory, value_type value, endianness endian)
Write a value to memory with a particular endianness.
Definition Endian.h:96
LLVM_ABI std::error_code closeFile(file_t &F)
Close the file object.
LLVM_ABI const file_t kInvalidFile
LLVM_ABI Expected< file_t > openNativeFileForRead(const Twine &Name, OpenFlags Flags=OF_None, SmallVectorImpl< char > *RealPath=nullptr)
Opens the file with the given name in a read-only mode, returning its open file descriptor.
LLVM_ABI std::error_code make_absolute(SmallVectorImpl< char > &path)
Make path an absolute path.
Definition Path.cpp:979
LLVM_ABI std::error_code status(const Twine &path, file_status &result, bool follow=true)
Get file status as if by POSIX stat().
LLVM_ABI const_iterator begin(StringRef path LLVM_LIFETIME_BOUND, Style style=Style::native)
Get begin iterator over path.
Definition Path.cpp:237
LLVM_ABI bool remove_dots(SmallVectorImpl< char > &path, bool remove_dot_dot=false, Style style=Style::native)
Remove '.
Definition Path.cpp:779
LLVM_ABI StringRef parent_path(StringRef path LLVM_LIFETIME_BOUND, Style style=Style::native)
Get parent path.
Definition Path.cpp:478
LLVM_ABI std::string convert_to_slash(StringRef path, Style style=Style::native)
Replaces backslashes with slashes if Windows.
Definition Path.cpp:585
LLVM_ABI StringRef root_name(StringRef path LLVM_LIFETIME_BOUND, Style style=Style::native)
Get root name.
Definition Path.cpp:384
LLVM_ABI void append(SmallVectorImpl< char > &path, const Twine &a, const Twine &b="", const Twine &c="", const Twine &d="")
Append to path.
Definition Path.cpp:467
LLVM_ABI const_iterator end(StringRef path LLVM_LIFETIME_BOUND)
Get end iterator over path.
Definition Path.cpp:246
std::chrono::time_point< std::chrono::system_clock, D > TimePoint
A time point on the system clock.
Definition Chrono.h:34
TimePoint< std::chrono::seconds > toTimePoint(std::time_t T)
Convert a std::time_t to a TimePoint.
Definition Chrono.h:65
std::time_t toTimeT(TimePoint<> TP)
Convert a TimePoint to std::time_t.
Definition Chrono.h:50
This is an optimization pass for GlobalISel generic memory operations.
LLVM_ABI file_magic identify_magic(StringRef magic)
Identify the type of a binary file based on how magical it is.
Definition Magic.cpp:33
LLVM_ABI void logAllUnhandledErrors(Error E, raw_ostream &OS, Twine ErrorBanner={})
Log all errors (if any) in E to OS.
Definition Error.cpp:61
LLVM_ABI Expected< std::unique_ptr< MemoryBuffer > > writeArchiveToBuffer(ArrayRef< NewArchiveMember > NewMembers, SymtabWritingMode WriteSymtab, object::Archive::Kind Kind, bool Deterministic, bool Thin, function_ref< void(Error)> Warn=warnToStderr)
Error createFileError(const Twine &F, Error E)
Concatenate a source file path and/or name with an Error.
Definition Error.h:1415
Printable print(const GCNRegPressure &RP, const GCNSubtarget *ST=nullptr, unsigned DynamicVGPRBlockSize=0)
LLVM_ABI Error writeArchive(StringRef ArcName, ArrayRef< NewArchiveMember > NewMembers, SymtabWritingMode WriteSymtab, object::Archive::Kind Kind, bool Deterministic, bool Thin, std::unique_ptr< MemoryBuffer > OldArchiveBuf=nullptr, std::optional< bool > IsEC=std::nullopt, function_ref< void(Error)> Warn=warnToStderr)
std::error_code make_error_code(BitcodeError E)
LLVM_ABI Expected< std::string > getBitcodeTargetTriple(MemoryBufferRef Buffer)
Read the header of the specified bitcode buffer and extract just the triple information.
@ is_a_directory
Definition Errc.h:59
auto dyn_cast_or_null(const Y &Val)
Definition Casting.h:753
Error joinErrors(Error E1, Error E2)
Concatenate errors.
Definition Error.h:442
constexpr T alignToPowerOf2(U Value, V Align)
Will overflow only if result is not representable in T.
Definition MathExtras.h:493
LLVM_ABI void report_fatal_error(Error Err, bool gen_crash_diag=true)
Definition Error.cpp:163
constexpr uint64_t alignTo(uint64_t Size, Align A)
Returns a multiple of A needed to store Size bytes.
Definition Alignment.h:144
bool isa(const From &Val)
isa<X> - Return true if the parameter to the template is an instance of one of the template type argu...
Definition Casting.h:547
format_object< Ts... > format(const char *Fmt, const Ts &... Vals)
These are helper functions used to produce formatted output.
Definition Format.h:94
Error make_error(ArgTs &&... Args)
Make a Error instance representing failure using the given error info type.
Definition Error.h:340
uint64_t offsetToAlignment(uint64_t Value, Align Alignment)
Returns the offset to the next integer (mod 2**64) that is greater than or equal to Value and is a mu...
Definition Alignment.h:186
LLVM_ABI raw_fd_ostream & errs()
This returns a reference to a raw_ostream for standard error.
LLVM_ABI void warnToStderr(Error Err)
decltype(auto) cast(const From &Val)
cast<X> - Return the argument parameter cast to the specified type.
Definition Casting.h:559
LLVM_ABI Expected< std::string > computeArchiveRelativePath(StringRef From, StringRef To)
LLVM_ABI Error errorCodeToError(std::error_code EC)
Helper for converting an std::error_code to a Error.
Definition Error.cpp:107
static ErrorOr< SmallString< 128 > > canonicalizePath(StringRef P)
std::error_code errnoAsErrorCode()
Helper to get errno as an std::error_code.
Definition Error.h:1256
LLVM_ABI Error writeArchiveToStream(raw_ostream &Out, ArrayRef< NewArchiveMember > NewMembers, SymtabWritingMode WriteSymtab, object::Archive::Kind Kind, bool Deterministic, bool Thin, std::optional< bool > IsEC=std::nullopt, function_ref< void(Error)> Warn=warnToStderr)
SymtabWritingMode
void consumeError(Error Err)
Consume a Error without doing anything.
Definition Error.h:1106
std::map< std::string, uint16_t > ECMap
bool UseECMap
std::map< std::string, uint16_t > Map
This struct is a compact representation of a valid (non-zero power of two) alignment.
Definition Alignment.h:39
LLVM_ABI object::Archive::Kind detectKindFromObject() const
static LLVM_ABI Expected< NewArchiveMember > getFile(StringRef FileName, bool Deterministic)
static LLVM_ABI Expected< NewArchiveMember > getOldMember(const object::Archive::Child &OldMember, bool Deterministic)
std::unique_ptr< MemoryBuffer > Buf
file_magic - An "enum class" enumeration of file types based on magic (the first N bytes of the file)...
Definition Magic.h:21
@ bitcode
Bitcode file.
Definition Magic.h:24