1bb684c34Spatrick //===- Writer.cpp ---------------------------------------------------------===//
2bb684c34Spatrick //
3bb684c34Spatrick // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4bb684c34Spatrick // See https://llvm.org/LICENSE.txt for license information.
5bb684c34Spatrick // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
6bb684c34Spatrick //
7bb684c34Spatrick //===----------------------------------------------------------------------===//
8bb684c34Spatrick
9bb684c34Spatrick #include "Writer.h"
101cf9926bSpatrick #include "ConcatOutputSection.h"
11bb684c34Spatrick #include "Config.h"
12bb684c34Spatrick #include "InputFiles.h"
13bb684c34Spatrick #include "InputSection.h"
141cf9926bSpatrick #include "MapFile.h"
15bb684c34Spatrick #include "OutputSection.h"
16bb684c34Spatrick #include "OutputSegment.h"
17*dfe94b16Srobert #include "SectionPriorities.h"
18bb684c34Spatrick #include "SymbolTable.h"
19bb684c34Spatrick #include "Symbols.h"
20bb684c34Spatrick #include "SyntheticSections.h"
21bb684c34Spatrick #include "Target.h"
221cf9926bSpatrick #include "UnwindInfoSection.h"
23bb684c34Spatrick
241cf9926bSpatrick #include "lld/Common/Arrays.h"
25*dfe94b16Srobert #include "lld/Common/CommonLinkerContext.h"
26bb684c34Spatrick #include "llvm/BinaryFormat/MachO.h"
271cf9926bSpatrick #include "llvm/Config/llvm-config.h"
28bb684c34Spatrick #include "llvm/Support/LEB128.h"
291cf9926bSpatrick #include "llvm/Support/Parallel.h"
30bb684c34Spatrick #include "llvm/Support/Path.h"
31*dfe94b16Srobert #include "llvm/Support/ThreadPool.h"
321cf9926bSpatrick #include "llvm/Support/TimeProfiler.h"
331cf9926bSpatrick #include "llvm/Support/xxhash.h"
341cf9926bSpatrick
351cf9926bSpatrick #include <algorithm>
36bb684c34Spatrick
37bb684c34Spatrick using namespace llvm;
38bb684c34Spatrick using namespace llvm::MachO;
391cf9926bSpatrick using namespace llvm::sys;
40bb684c34Spatrick using namespace lld;
41bb684c34Spatrick using namespace lld::macho;
42bb684c34Spatrick
43bb684c34Spatrick namespace {
441cf9926bSpatrick class LCUuid;
45bb684c34Spatrick
46bb684c34Spatrick class Writer {
47bb684c34Spatrick public:
Writer()48bb684c34Spatrick Writer() : buffer(errorHandler().outputBuffer) {}
49bb684c34Spatrick
501cf9926bSpatrick void treatSpecialUndefineds();
51bb684c34Spatrick void scanRelocations();
521cf9926bSpatrick void scanSymbols();
531cf9926bSpatrick template <class LP> void createOutputSections();
541cf9926bSpatrick template <class LP> void createLoadCommands();
551cf9926bSpatrick void finalizeAddresses();
561cf9926bSpatrick void finalizeLinkEditSegment();
57bb684c34Spatrick void assignAddresses(OutputSegment *);
58bb684c34Spatrick
59bb684c34Spatrick void openFile();
60bb684c34Spatrick void writeSections();
61*dfe94b16Srobert void applyOptimizationHints();
62*dfe94b16Srobert void buildFixupChains();
631cf9926bSpatrick void writeUuid();
641cf9926bSpatrick void writeCodeSignature();
651cf9926bSpatrick void writeOutputFile();
66bb684c34Spatrick
671cf9926bSpatrick template <class LP> void run();
68bb684c34Spatrick
69*dfe94b16Srobert ThreadPool threadPool;
70bb684c34Spatrick std::unique_ptr<FileOutputBuffer> &buffer;
71bb684c34Spatrick uint64_t addr = 0;
72bb684c34Spatrick uint64_t fileOff = 0;
731cf9926bSpatrick MachHeaderSection *header = nullptr;
74bb684c34Spatrick StringTableSection *stringTableSection = nullptr;
75bb684c34Spatrick SymtabSection *symtabSection = nullptr;
761cf9926bSpatrick IndirectSymtabSection *indirectSymtabSection = nullptr;
771cf9926bSpatrick CodeSignatureSection *codeSignatureSection = nullptr;
781cf9926bSpatrick DataInCodeSection *dataInCodeSection = nullptr;
791cf9926bSpatrick FunctionStartsSection *functionStartsSection = nullptr;
801cf9926bSpatrick
811cf9926bSpatrick LCUuid *uuidCommand = nullptr;
821cf9926bSpatrick OutputSegment *linkEditSegment = nullptr;
83bb684c34Spatrick };
84bb684c34Spatrick
85bb684c34Spatrick // LC_DYLD_INFO_ONLY stores the offsets of symbol import/export information.
861cf9926bSpatrick class LCDyldInfo final : public LoadCommand {
87bb684c34Spatrick public:
LCDyldInfo(RebaseSection * rebaseSection,BindingSection * bindingSection,WeakBindingSection * weakBindingSection,LazyBindingSection * lazyBindingSection,ExportSection * exportSection)881cf9926bSpatrick LCDyldInfo(RebaseSection *rebaseSection, BindingSection *bindingSection,
891cf9926bSpatrick WeakBindingSection *weakBindingSection,
90bb684c34Spatrick LazyBindingSection *lazyBindingSection,
91bb684c34Spatrick ExportSection *exportSection)
921cf9926bSpatrick : rebaseSection(rebaseSection), bindingSection(bindingSection),
931cf9926bSpatrick weakBindingSection(weakBindingSection),
941cf9926bSpatrick lazyBindingSection(lazyBindingSection), exportSection(exportSection) {}
95bb684c34Spatrick
getSize() const96bb684c34Spatrick uint32_t getSize() const override { return sizeof(dyld_info_command); }
97bb684c34Spatrick
writeTo(uint8_t * buf) const98bb684c34Spatrick void writeTo(uint8_t *buf) const override {
99bb684c34Spatrick auto *c = reinterpret_cast<dyld_info_command *>(buf);
100bb684c34Spatrick c->cmd = LC_DYLD_INFO_ONLY;
101bb684c34Spatrick c->cmdsize = getSize();
1021cf9926bSpatrick if (rebaseSection->isNeeded()) {
1031cf9926bSpatrick c->rebase_off = rebaseSection->fileOff;
1041cf9926bSpatrick c->rebase_size = rebaseSection->getFileSize();
1051cf9926bSpatrick }
106bb684c34Spatrick if (bindingSection->isNeeded()) {
107bb684c34Spatrick c->bind_off = bindingSection->fileOff;
108bb684c34Spatrick c->bind_size = bindingSection->getFileSize();
109bb684c34Spatrick }
1101cf9926bSpatrick if (weakBindingSection->isNeeded()) {
1111cf9926bSpatrick c->weak_bind_off = weakBindingSection->fileOff;
1121cf9926bSpatrick c->weak_bind_size = weakBindingSection->getFileSize();
1131cf9926bSpatrick }
114bb684c34Spatrick if (lazyBindingSection->isNeeded()) {
115bb684c34Spatrick c->lazy_bind_off = lazyBindingSection->fileOff;
116bb684c34Spatrick c->lazy_bind_size = lazyBindingSection->getFileSize();
117bb684c34Spatrick }
118bb684c34Spatrick if (exportSection->isNeeded()) {
119bb684c34Spatrick c->export_off = exportSection->fileOff;
120bb684c34Spatrick c->export_size = exportSection->getFileSize();
121bb684c34Spatrick }
122bb684c34Spatrick }
123bb684c34Spatrick
1241cf9926bSpatrick RebaseSection *rebaseSection;
125bb684c34Spatrick BindingSection *bindingSection;
1261cf9926bSpatrick WeakBindingSection *weakBindingSection;
127bb684c34Spatrick LazyBindingSection *lazyBindingSection;
128bb684c34Spatrick ExportSection *exportSection;
129bb684c34Spatrick };
130bb684c34Spatrick
1311cf9926bSpatrick class LCSubFramework final : public LoadCommand {
132bb684c34Spatrick public:
LCSubFramework(StringRef umbrella)1331cf9926bSpatrick LCSubFramework(StringRef umbrella) : umbrella(umbrella) {}
1341cf9926bSpatrick
getSize() const1351cf9926bSpatrick uint32_t getSize() const override {
136*dfe94b16Srobert return alignToPowerOf2(sizeof(sub_framework_command) + umbrella.size() + 1,
1371cf9926bSpatrick target->wordSize);
1381cf9926bSpatrick }
1391cf9926bSpatrick
writeTo(uint8_t * buf) const1401cf9926bSpatrick void writeTo(uint8_t *buf) const override {
1411cf9926bSpatrick auto *c = reinterpret_cast<sub_framework_command *>(buf);
1421cf9926bSpatrick buf += sizeof(sub_framework_command);
1431cf9926bSpatrick
1441cf9926bSpatrick c->cmd = LC_SUB_FRAMEWORK;
1451cf9926bSpatrick c->cmdsize = getSize();
1461cf9926bSpatrick c->umbrella = sizeof(sub_framework_command);
1471cf9926bSpatrick
1481cf9926bSpatrick memcpy(buf, umbrella.data(), umbrella.size());
1491cf9926bSpatrick buf[umbrella.size()] = '\0';
1501cf9926bSpatrick }
1511cf9926bSpatrick
1521cf9926bSpatrick private:
1531cf9926bSpatrick const StringRef umbrella;
1541cf9926bSpatrick };
1551cf9926bSpatrick
1561cf9926bSpatrick class LCFunctionStarts final : public LoadCommand {
1571cf9926bSpatrick public:
LCFunctionStarts(FunctionStartsSection * functionStartsSection)1581cf9926bSpatrick explicit LCFunctionStarts(FunctionStartsSection *functionStartsSection)
1591cf9926bSpatrick : functionStartsSection(functionStartsSection) {}
1601cf9926bSpatrick
getSize() const1611cf9926bSpatrick uint32_t getSize() const override { return sizeof(linkedit_data_command); }
1621cf9926bSpatrick
writeTo(uint8_t * buf) const1631cf9926bSpatrick void writeTo(uint8_t *buf) const override {
1641cf9926bSpatrick auto *c = reinterpret_cast<linkedit_data_command *>(buf);
1651cf9926bSpatrick c->cmd = LC_FUNCTION_STARTS;
1661cf9926bSpatrick c->cmdsize = getSize();
1671cf9926bSpatrick c->dataoff = functionStartsSection->fileOff;
1681cf9926bSpatrick c->datasize = functionStartsSection->getFileSize();
1691cf9926bSpatrick }
1701cf9926bSpatrick
1711cf9926bSpatrick private:
1721cf9926bSpatrick FunctionStartsSection *functionStartsSection;
1731cf9926bSpatrick };
1741cf9926bSpatrick
1751cf9926bSpatrick class LCDataInCode final : public LoadCommand {
1761cf9926bSpatrick public:
LCDataInCode(DataInCodeSection * dataInCodeSection)1771cf9926bSpatrick explicit LCDataInCode(DataInCodeSection *dataInCodeSection)
1781cf9926bSpatrick : dataInCodeSection(dataInCodeSection) {}
1791cf9926bSpatrick
getSize() const1801cf9926bSpatrick uint32_t getSize() const override { return sizeof(linkedit_data_command); }
1811cf9926bSpatrick
writeTo(uint8_t * buf) const1821cf9926bSpatrick void writeTo(uint8_t *buf) const override {
1831cf9926bSpatrick auto *c = reinterpret_cast<linkedit_data_command *>(buf);
1841cf9926bSpatrick c->cmd = LC_DATA_IN_CODE;
1851cf9926bSpatrick c->cmdsize = getSize();
1861cf9926bSpatrick c->dataoff = dataInCodeSection->fileOff;
1871cf9926bSpatrick c->datasize = dataInCodeSection->getFileSize();
1881cf9926bSpatrick }
1891cf9926bSpatrick
1901cf9926bSpatrick private:
1911cf9926bSpatrick DataInCodeSection *dataInCodeSection;
1921cf9926bSpatrick };
1931cf9926bSpatrick
1941cf9926bSpatrick class LCDysymtab final : public LoadCommand {
1951cf9926bSpatrick public:
LCDysymtab(SymtabSection * symtabSection,IndirectSymtabSection * indirectSymtabSection)1961cf9926bSpatrick LCDysymtab(SymtabSection *symtabSection,
1971cf9926bSpatrick IndirectSymtabSection *indirectSymtabSection)
1981cf9926bSpatrick : symtabSection(symtabSection),
1991cf9926bSpatrick indirectSymtabSection(indirectSymtabSection) {}
2001cf9926bSpatrick
getSize() const201bb684c34Spatrick uint32_t getSize() const override { return sizeof(dysymtab_command); }
202bb684c34Spatrick
writeTo(uint8_t * buf) const203bb684c34Spatrick void writeTo(uint8_t *buf) const override {
204bb684c34Spatrick auto *c = reinterpret_cast<dysymtab_command *>(buf);
205bb684c34Spatrick c->cmd = LC_DYSYMTAB;
206bb684c34Spatrick c->cmdsize = getSize();
2071cf9926bSpatrick
2081cf9926bSpatrick c->ilocalsym = 0;
2091cf9926bSpatrick c->iextdefsym = c->nlocalsym = symtabSection->getNumLocalSymbols();
2101cf9926bSpatrick c->nextdefsym = symtabSection->getNumExternalSymbols();
2111cf9926bSpatrick c->iundefsym = c->iextdefsym + c->nextdefsym;
2121cf9926bSpatrick c->nundefsym = symtabSection->getNumUndefinedSymbols();
2131cf9926bSpatrick
2141cf9926bSpatrick c->indirectsymoff = indirectSymtabSection->fileOff;
2151cf9926bSpatrick c->nindirectsyms = indirectSymtabSection->getNumSymbols();
216bb684c34Spatrick }
2171cf9926bSpatrick
2181cf9926bSpatrick SymtabSection *symtabSection;
2191cf9926bSpatrick IndirectSymtabSection *indirectSymtabSection;
220bb684c34Spatrick };
221bb684c34Spatrick
2221cf9926bSpatrick template <class LP> class LCSegment final : public LoadCommand {
223bb684c34Spatrick public:
LCSegment(StringRef name,OutputSegment * seg)224bb684c34Spatrick LCSegment(StringRef name, OutputSegment *seg) : name(name), seg(seg) {}
225bb684c34Spatrick
getSize() const226bb684c34Spatrick uint32_t getSize() const override {
2271cf9926bSpatrick return sizeof(typename LP::segment_command) +
2281cf9926bSpatrick seg->numNonHiddenSections() * sizeof(typename LP::section);
229bb684c34Spatrick }
230bb684c34Spatrick
writeTo(uint8_t * buf) const231bb684c34Spatrick void writeTo(uint8_t *buf) const override {
2321cf9926bSpatrick using SegmentCommand = typename LP::segment_command;
233*dfe94b16Srobert using SectionHeader = typename LP::section;
234bb684c34Spatrick
2351cf9926bSpatrick auto *c = reinterpret_cast<SegmentCommand *>(buf);
2361cf9926bSpatrick buf += sizeof(SegmentCommand);
2371cf9926bSpatrick
2381cf9926bSpatrick c->cmd = LP::segmentLCType;
239bb684c34Spatrick c->cmdsize = getSize();
240bb684c34Spatrick memcpy(c->segname, name.data(), name.size());
241bb684c34Spatrick c->fileoff = seg->fileOff;
242bb684c34Spatrick c->maxprot = seg->maxProt;
243bb684c34Spatrick c->initprot = seg->initProt;
244bb684c34Spatrick
2451cf9926bSpatrick c->vmaddr = seg->addr;
2461cf9926bSpatrick c->vmsize = seg->vmSize;
2471cf9926bSpatrick c->filesize = seg->fileSize;
248bb684c34Spatrick c->nsects = seg->numNonHiddenSections();
249*dfe94b16Srobert c->flags = seg->flags;
250bb684c34Spatrick
2511cf9926bSpatrick for (const OutputSection *osec : seg->getSections()) {
252bb684c34Spatrick if (osec->isHidden())
253bb684c34Spatrick continue;
254bb684c34Spatrick
255*dfe94b16Srobert auto *sectHdr = reinterpret_cast<SectionHeader *>(buf);
256*dfe94b16Srobert buf += sizeof(SectionHeader);
257bb684c34Spatrick
258bb684c34Spatrick memcpy(sectHdr->sectname, osec->name.data(), osec->name.size());
259bb684c34Spatrick memcpy(sectHdr->segname, name.data(), name.size());
260bb684c34Spatrick
261bb684c34Spatrick sectHdr->addr = osec->addr;
262bb684c34Spatrick sectHdr->offset = osec->fileOff;
263bb684c34Spatrick sectHdr->align = Log2_32(osec->align);
264bb684c34Spatrick sectHdr->flags = osec->flags;
265bb684c34Spatrick sectHdr->size = osec->getSize();
2661cf9926bSpatrick sectHdr->reserved1 = osec->reserved1;
2671cf9926bSpatrick sectHdr->reserved2 = osec->reserved2;
268bb684c34Spatrick }
269bb684c34Spatrick }
270bb684c34Spatrick
271bb684c34Spatrick private:
272bb684c34Spatrick StringRef name;
273bb684c34Spatrick OutputSegment *seg;
274bb684c34Spatrick };
275bb684c34Spatrick
2761cf9926bSpatrick class LCMain final : public LoadCommand {
getSize() const2771cf9926bSpatrick uint32_t getSize() const override {
2781cf9926bSpatrick return sizeof(structs::entry_point_command);
2791cf9926bSpatrick }
280bb684c34Spatrick
writeTo(uint8_t * buf) const281bb684c34Spatrick void writeTo(uint8_t *buf) const override {
2821cf9926bSpatrick auto *c = reinterpret_cast<structs::entry_point_command *>(buf);
283bb684c34Spatrick c->cmd = LC_MAIN;
284bb684c34Spatrick c->cmdsize = getSize();
2851cf9926bSpatrick
2861cf9926bSpatrick if (config->entry->isInStubs())
2871cf9926bSpatrick c->entryoff =
2881cf9926bSpatrick in.stubs->fileOff + config->entry->stubsIndex * target->stubSize;
2891cf9926bSpatrick else
2901cf9926bSpatrick c->entryoff = config->entry->getVA() - in.header->addr;
2911cf9926bSpatrick
292bb684c34Spatrick c->stacksize = 0;
293bb684c34Spatrick }
294bb684c34Spatrick };
295bb684c34Spatrick
2961cf9926bSpatrick class LCSymtab final : public LoadCommand {
297bb684c34Spatrick public:
LCSymtab(SymtabSection * symtabSection,StringTableSection * stringTableSection)298bb684c34Spatrick LCSymtab(SymtabSection *symtabSection, StringTableSection *stringTableSection)
299bb684c34Spatrick : symtabSection(symtabSection), stringTableSection(stringTableSection) {}
300bb684c34Spatrick
getSize() const301bb684c34Spatrick uint32_t getSize() const override { return sizeof(symtab_command); }
302bb684c34Spatrick
writeTo(uint8_t * buf) const303bb684c34Spatrick void writeTo(uint8_t *buf) const override {
304bb684c34Spatrick auto *c = reinterpret_cast<symtab_command *>(buf);
305bb684c34Spatrick c->cmd = LC_SYMTAB;
306bb684c34Spatrick c->cmdsize = getSize();
307bb684c34Spatrick c->symoff = symtabSection->fileOff;
308bb684c34Spatrick c->nsyms = symtabSection->getNumSymbols();
309bb684c34Spatrick c->stroff = stringTableSection->fileOff;
310bb684c34Spatrick c->strsize = stringTableSection->getFileSize();
311bb684c34Spatrick }
312bb684c34Spatrick
313bb684c34Spatrick SymtabSection *symtabSection = nullptr;
314bb684c34Spatrick StringTableSection *stringTableSection = nullptr;
315bb684c34Spatrick };
316bb684c34Spatrick
317bb684c34Spatrick // There are several dylib load commands that share the same structure:
318bb684c34Spatrick // * LC_LOAD_DYLIB
319bb684c34Spatrick // * LC_ID_DYLIB
320bb684c34Spatrick // * LC_REEXPORT_DYLIB
3211cf9926bSpatrick class LCDylib final : public LoadCommand {
322bb684c34Spatrick public:
LCDylib(LoadCommandType type,StringRef path,uint32_t compatibilityVersion=0,uint32_t currentVersion=0)3231cf9926bSpatrick LCDylib(LoadCommandType type, StringRef path,
3241cf9926bSpatrick uint32_t compatibilityVersion = 0, uint32_t currentVersion = 0)
3251cf9926bSpatrick : type(type), path(path), compatibilityVersion(compatibilityVersion),
3261cf9926bSpatrick currentVersion(currentVersion) {
3271cf9926bSpatrick instanceCount++;
3281cf9926bSpatrick }
329bb684c34Spatrick
getSize() const330bb684c34Spatrick uint32_t getSize() const override {
331*dfe94b16Srobert return alignToPowerOf2(sizeof(dylib_command) + path.size() + 1,
332*dfe94b16Srobert target->wordSize);
333bb684c34Spatrick }
334bb684c34Spatrick
writeTo(uint8_t * buf) const335bb684c34Spatrick void writeTo(uint8_t *buf) const override {
336bb684c34Spatrick auto *c = reinterpret_cast<dylib_command *>(buf);
337bb684c34Spatrick buf += sizeof(dylib_command);
338bb684c34Spatrick
339bb684c34Spatrick c->cmd = type;
340bb684c34Spatrick c->cmdsize = getSize();
341bb684c34Spatrick c->dylib.name = sizeof(dylib_command);
3421cf9926bSpatrick c->dylib.timestamp = 0;
3431cf9926bSpatrick c->dylib.compatibility_version = compatibilityVersion;
3441cf9926bSpatrick c->dylib.current_version = currentVersion;
345bb684c34Spatrick
346bb684c34Spatrick memcpy(buf, path.data(), path.size());
347bb684c34Spatrick buf[path.size()] = '\0';
348bb684c34Spatrick }
349bb684c34Spatrick
getInstanceCount()3501cf9926bSpatrick static uint32_t getInstanceCount() { return instanceCount; }
resetInstanceCount()351*dfe94b16Srobert static void resetInstanceCount() { instanceCount = 0; }
3521cf9926bSpatrick
353bb684c34Spatrick private:
354bb684c34Spatrick LoadCommandType type;
355bb684c34Spatrick StringRef path;
3561cf9926bSpatrick uint32_t compatibilityVersion;
3571cf9926bSpatrick uint32_t currentVersion;
3581cf9926bSpatrick static uint32_t instanceCount;
359bb684c34Spatrick };
360bb684c34Spatrick
3611cf9926bSpatrick uint32_t LCDylib::instanceCount = 0;
3621cf9926bSpatrick
3631cf9926bSpatrick class LCLoadDylinker final : public LoadCommand {
364bb684c34Spatrick public:
getSize() const365bb684c34Spatrick uint32_t getSize() const override {
366*dfe94b16Srobert return alignToPowerOf2(sizeof(dylinker_command) + path.size() + 1,
367*dfe94b16Srobert target->wordSize);
368bb684c34Spatrick }
369bb684c34Spatrick
writeTo(uint8_t * buf) const370bb684c34Spatrick void writeTo(uint8_t *buf) const override {
371bb684c34Spatrick auto *c = reinterpret_cast<dylinker_command *>(buf);
372bb684c34Spatrick buf += sizeof(dylinker_command);
373bb684c34Spatrick
374bb684c34Spatrick c->cmd = LC_LOAD_DYLINKER;
375bb684c34Spatrick c->cmdsize = getSize();
376bb684c34Spatrick c->name = sizeof(dylinker_command);
377bb684c34Spatrick
378bb684c34Spatrick memcpy(buf, path.data(), path.size());
379bb684c34Spatrick buf[path.size()] = '\0';
380bb684c34Spatrick }
381bb684c34Spatrick
382bb684c34Spatrick private:
383bb684c34Spatrick // Recent versions of Darwin won't run any binary that has dyld at a
384bb684c34Spatrick // different location.
385bb684c34Spatrick const StringRef path = "/usr/lib/dyld";
386bb684c34Spatrick };
3871cf9926bSpatrick
3881cf9926bSpatrick class LCRPath final : public LoadCommand {
3891cf9926bSpatrick public:
LCRPath(StringRef path)3901cf9926bSpatrick explicit LCRPath(StringRef path) : path(path) {}
3911cf9926bSpatrick
getSize() const3921cf9926bSpatrick uint32_t getSize() const override {
393*dfe94b16Srobert return alignToPowerOf2(sizeof(rpath_command) + path.size() + 1,
394*dfe94b16Srobert target->wordSize);
3951cf9926bSpatrick }
3961cf9926bSpatrick
writeTo(uint8_t * buf) const3971cf9926bSpatrick void writeTo(uint8_t *buf) const override {
3981cf9926bSpatrick auto *c = reinterpret_cast<rpath_command *>(buf);
3991cf9926bSpatrick buf += sizeof(rpath_command);
4001cf9926bSpatrick
4011cf9926bSpatrick c->cmd = LC_RPATH;
4021cf9926bSpatrick c->cmdsize = getSize();
4031cf9926bSpatrick c->path = sizeof(rpath_command);
4041cf9926bSpatrick
4051cf9926bSpatrick memcpy(buf, path.data(), path.size());
4061cf9926bSpatrick buf[path.size()] = '\0';
4071cf9926bSpatrick }
4081cf9926bSpatrick
4091cf9926bSpatrick private:
4101cf9926bSpatrick StringRef path;
4111cf9926bSpatrick };
4121cf9926bSpatrick
413*dfe94b16Srobert class LCDyldEnv final : public LoadCommand {
414*dfe94b16Srobert public:
LCDyldEnv(StringRef name)415*dfe94b16Srobert explicit LCDyldEnv(StringRef name) : name(name) {}
416*dfe94b16Srobert
getSize() const417*dfe94b16Srobert uint32_t getSize() const override {
418*dfe94b16Srobert return alignToPowerOf2(sizeof(dyld_env_command) + name.size() + 1,
419*dfe94b16Srobert target->wordSize);
420*dfe94b16Srobert }
421*dfe94b16Srobert
writeTo(uint8_t * buf) const422*dfe94b16Srobert void writeTo(uint8_t *buf) const override {
423*dfe94b16Srobert auto *c = reinterpret_cast<dyld_env_command *>(buf);
424*dfe94b16Srobert buf += sizeof(dyld_env_command);
425*dfe94b16Srobert
426*dfe94b16Srobert c->cmd = LC_DYLD_ENVIRONMENT;
427*dfe94b16Srobert c->cmdsize = getSize();
428*dfe94b16Srobert c->name = sizeof(dyld_env_command);
429*dfe94b16Srobert
430*dfe94b16Srobert memcpy(buf, name.data(), name.size());
431*dfe94b16Srobert buf[name.size()] = '\0';
432*dfe94b16Srobert }
433*dfe94b16Srobert
434*dfe94b16Srobert private:
435*dfe94b16Srobert StringRef name;
436*dfe94b16Srobert };
437*dfe94b16Srobert
4381cf9926bSpatrick class LCMinVersion final : public LoadCommand {
4391cf9926bSpatrick public:
LCMinVersion(const PlatformInfo & platformInfo)4401cf9926bSpatrick explicit LCMinVersion(const PlatformInfo &platformInfo)
4411cf9926bSpatrick : platformInfo(platformInfo) {}
4421cf9926bSpatrick
getSize() const4431cf9926bSpatrick uint32_t getSize() const override { return sizeof(version_min_command); }
4441cf9926bSpatrick
writeTo(uint8_t * buf) const4451cf9926bSpatrick void writeTo(uint8_t *buf) const override {
4461cf9926bSpatrick auto *c = reinterpret_cast<version_min_command *>(buf);
4471cf9926bSpatrick switch (platformInfo.target.Platform) {
448*dfe94b16Srobert case PLATFORM_MACOS:
4491cf9926bSpatrick c->cmd = LC_VERSION_MIN_MACOSX;
4501cf9926bSpatrick break;
451*dfe94b16Srobert case PLATFORM_IOS:
452*dfe94b16Srobert case PLATFORM_IOSSIMULATOR:
4531cf9926bSpatrick c->cmd = LC_VERSION_MIN_IPHONEOS;
4541cf9926bSpatrick break;
455*dfe94b16Srobert case PLATFORM_TVOS:
456*dfe94b16Srobert case PLATFORM_TVOSSIMULATOR:
4571cf9926bSpatrick c->cmd = LC_VERSION_MIN_TVOS;
4581cf9926bSpatrick break;
459*dfe94b16Srobert case PLATFORM_WATCHOS:
460*dfe94b16Srobert case PLATFORM_WATCHOSSIMULATOR:
4611cf9926bSpatrick c->cmd = LC_VERSION_MIN_WATCHOS;
4621cf9926bSpatrick break;
4631cf9926bSpatrick default:
4641cf9926bSpatrick llvm_unreachable("invalid platform");
4651cf9926bSpatrick break;
4661cf9926bSpatrick }
4671cf9926bSpatrick c->cmdsize = getSize();
4681cf9926bSpatrick c->version = encodeVersion(platformInfo.minimum);
4691cf9926bSpatrick c->sdk = encodeVersion(platformInfo.sdk);
4701cf9926bSpatrick }
4711cf9926bSpatrick
4721cf9926bSpatrick private:
4731cf9926bSpatrick const PlatformInfo &platformInfo;
4741cf9926bSpatrick };
4751cf9926bSpatrick
4761cf9926bSpatrick class LCBuildVersion final : public LoadCommand {
4771cf9926bSpatrick public:
LCBuildVersion(const PlatformInfo & platformInfo)4781cf9926bSpatrick explicit LCBuildVersion(const PlatformInfo &platformInfo)
4791cf9926bSpatrick : platformInfo(platformInfo) {}
4801cf9926bSpatrick
4811cf9926bSpatrick const int ntools = 1;
4821cf9926bSpatrick
getSize() const4831cf9926bSpatrick uint32_t getSize() const override {
4841cf9926bSpatrick return sizeof(build_version_command) + ntools * sizeof(build_tool_version);
4851cf9926bSpatrick }
4861cf9926bSpatrick
writeTo(uint8_t * buf) const4871cf9926bSpatrick void writeTo(uint8_t *buf) const override {
4881cf9926bSpatrick auto *c = reinterpret_cast<build_version_command *>(buf);
4891cf9926bSpatrick c->cmd = LC_BUILD_VERSION;
4901cf9926bSpatrick c->cmdsize = getSize();
491*dfe94b16Srobert
4921cf9926bSpatrick c->platform = static_cast<uint32_t>(platformInfo.target.Platform);
4931cf9926bSpatrick c->minos = encodeVersion(platformInfo.minimum);
4941cf9926bSpatrick c->sdk = encodeVersion(platformInfo.sdk);
495*dfe94b16Srobert
4961cf9926bSpatrick c->ntools = ntools;
4971cf9926bSpatrick auto *t = reinterpret_cast<build_tool_version *>(&c[1]);
4981cf9926bSpatrick t->tool = TOOL_LD;
4991cf9926bSpatrick t->version = encodeVersion(VersionTuple(
5001cf9926bSpatrick LLVM_VERSION_MAJOR, LLVM_VERSION_MINOR, LLVM_VERSION_PATCH));
5011cf9926bSpatrick }
5021cf9926bSpatrick
5031cf9926bSpatrick private:
5041cf9926bSpatrick const PlatformInfo &platformInfo;
5051cf9926bSpatrick };
5061cf9926bSpatrick
5071cf9926bSpatrick // Stores a unique identifier for the output file based on an MD5 hash of its
5081cf9926bSpatrick // contents. In order to hash the contents, we must first write them, but
5091cf9926bSpatrick // LC_UUID itself must be part of the written contents in order for all the
5101cf9926bSpatrick // offsets to be calculated correctly. We resolve this circular paradox by
5111cf9926bSpatrick // first writing an LC_UUID with an all-zero UUID, then updating the UUID with
5121cf9926bSpatrick // its real value later.
5131cf9926bSpatrick class LCUuid final : public LoadCommand {
5141cf9926bSpatrick public:
getSize() const5151cf9926bSpatrick uint32_t getSize() const override { return sizeof(uuid_command); }
5161cf9926bSpatrick
writeTo(uint8_t * buf) const5171cf9926bSpatrick void writeTo(uint8_t *buf) const override {
5181cf9926bSpatrick auto *c = reinterpret_cast<uuid_command *>(buf);
5191cf9926bSpatrick c->cmd = LC_UUID;
5201cf9926bSpatrick c->cmdsize = getSize();
5211cf9926bSpatrick uuidBuf = c->uuid;
5221cf9926bSpatrick }
5231cf9926bSpatrick
writeUuid(uint64_t digest) const5241cf9926bSpatrick void writeUuid(uint64_t digest) const {
5251cf9926bSpatrick // xxhash only gives us 8 bytes, so put some fixed data in the other half.
5261cf9926bSpatrick static_assert(sizeof(uuid_command::uuid) == 16, "unexpected uuid size");
5271cf9926bSpatrick memcpy(uuidBuf, "LLD\xa1UU1D", 8);
5281cf9926bSpatrick memcpy(uuidBuf + 8, &digest, 8);
5291cf9926bSpatrick
5301cf9926bSpatrick // RFC 4122 conformance. We need to fix 4 bits in byte 6 and 2 bits in
5311cf9926bSpatrick // byte 8. Byte 6 is already fine due to the fixed data we put in. We don't
5321cf9926bSpatrick // want to lose bits of the digest in byte 8, so swap that with a byte of
5331cf9926bSpatrick // fixed data that happens to have the right bits set.
5341cf9926bSpatrick std::swap(uuidBuf[3], uuidBuf[8]);
5351cf9926bSpatrick
5361cf9926bSpatrick // Claim that this is an MD5-based hash. It isn't, but this signals that
5371cf9926bSpatrick // this is not a time-based and not a random hash. MD5 seems like the least
5381cf9926bSpatrick // bad lie we can put here.
5391cf9926bSpatrick assert((uuidBuf[6] & 0xf0) == 0x30 && "See RFC 4122 Sections 4.2.2, 4.1.3");
5401cf9926bSpatrick assert((uuidBuf[8] & 0xc0) == 0x80 && "See RFC 4122 Section 4.2.2");
5411cf9926bSpatrick }
5421cf9926bSpatrick
5431cf9926bSpatrick mutable uint8_t *uuidBuf;
5441cf9926bSpatrick };
5451cf9926bSpatrick
5461cf9926bSpatrick template <class LP> class LCEncryptionInfo final : public LoadCommand {
5471cf9926bSpatrick public:
getSize() const5481cf9926bSpatrick uint32_t getSize() const override {
5491cf9926bSpatrick return sizeof(typename LP::encryption_info_command);
5501cf9926bSpatrick }
5511cf9926bSpatrick
writeTo(uint8_t * buf) const5521cf9926bSpatrick void writeTo(uint8_t *buf) const override {
5531cf9926bSpatrick using EncryptionInfo = typename LP::encryption_info_command;
5541cf9926bSpatrick auto *c = reinterpret_cast<EncryptionInfo *>(buf);
5551cf9926bSpatrick buf += sizeof(EncryptionInfo);
5561cf9926bSpatrick c->cmd = LP::encryptionInfoLCType;
5571cf9926bSpatrick c->cmdsize = getSize();
5581cf9926bSpatrick c->cryptoff = in.header->getSize();
5591cf9926bSpatrick auto it = find_if(outputSegments, [](const OutputSegment *seg) {
5601cf9926bSpatrick return seg->name == segment_names::text;
5611cf9926bSpatrick });
5621cf9926bSpatrick assert(it != outputSegments.end());
5631cf9926bSpatrick c->cryptsize = (*it)->fileSize - c->cryptoff;
5641cf9926bSpatrick }
5651cf9926bSpatrick };
5661cf9926bSpatrick
5671cf9926bSpatrick class LCCodeSignature final : public LoadCommand {
5681cf9926bSpatrick public:
LCCodeSignature(CodeSignatureSection * section)5691cf9926bSpatrick LCCodeSignature(CodeSignatureSection *section) : section(section) {}
5701cf9926bSpatrick
getSize() const5711cf9926bSpatrick uint32_t getSize() const override { return sizeof(linkedit_data_command); }
5721cf9926bSpatrick
writeTo(uint8_t * buf) const5731cf9926bSpatrick void writeTo(uint8_t *buf) const override {
5741cf9926bSpatrick auto *c = reinterpret_cast<linkedit_data_command *>(buf);
5751cf9926bSpatrick c->cmd = LC_CODE_SIGNATURE;
5761cf9926bSpatrick c->cmdsize = getSize();
5771cf9926bSpatrick c->dataoff = static_cast<uint32_t>(section->fileOff);
5781cf9926bSpatrick c->datasize = section->getSize();
5791cf9926bSpatrick }
5801cf9926bSpatrick
5811cf9926bSpatrick CodeSignatureSection *section;
5821cf9926bSpatrick };
5831cf9926bSpatrick
584*dfe94b16Srobert class LCExportsTrie final : public LoadCommand {
585*dfe94b16Srobert public:
LCExportsTrie(ExportSection * section)586*dfe94b16Srobert LCExportsTrie(ExportSection *section) : section(section) {}
587*dfe94b16Srobert
getSize() const588*dfe94b16Srobert uint32_t getSize() const override { return sizeof(linkedit_data_command); }
589*dfe94b16Srobert
writeTo(uint8_t * buf) const590*dfe94b16Srobert void writeTo(uint8_t *buf) const override {
591*dfe94b16Srobert auto *c = reinterpret_cast<linkedit_data_command *>(buf);
592*dfe94b16Srobert c->cmd = LC_DYLD_EXPORTS_TRIE;
593*dfe94b16Srobert c->cmdsize = getSize();
594*dfe94b16Srobert c->dataoff = section->fileOff;
595*dfe94b16Srobert c->datasize = section->getSize();
596*dfe94b16Srobert }
597*dfe94b16Srobert
598*dfe94b16Srobert ExportSection *section;
599*dfe94b16Srobert };
600*dfe94b16Srobert
601*dfe94b16Srobert class LCChainedFixups final : public LoadCommand {
602*dfe94b16Srobert public:
LCChainedFixups(ChainedFixupsSection * section)603*dfe94b16Srobert LCChainedFixups(ChainedFixupsSection *section) : section(section) {}
604*dfe94b16Srobert
getSize() const605*dfe94b16Srobert uint32_t getSize() const override { return sizeof(linkedit_data_command); }
606*dfe94b16Srobert
writeTo(uint8_t * buf) const607*dfe94b16Srobert void writeTo(uint8_t *buf) const override {
608*dfe94b16Srobert auto *c = reinterpret_cast<linkedit_data_command *>(buf);
609*dfe94b16Srobert c->cmd = LC_DYLD_CHAINED_FIXUPS;
610*dfe94b16Srobert c->cmdsize = getSize();
611*dfe94b16Srobert c->dataoff = section->fileOff;
612*dfe94b16Srobert c->datasize = section->getSize();
613*dfe94b16Srobert }
614*dfe94b16Srobert
615*dfe94b16Srobert ChainedFixupsSection *section;
616*dfe94b16Srobert };
617*dfe94b16Srobert
618bb684c34Spatrick } // namespace
619bb684c34Spatrick
treatSpecialUndefineds()6201cf9926bSpatrick void Writer::treatSpecialUndefineds() {
6211cf9926bSpatrick if (config->entry)
6221cf9926bSpatrick if (auto *undefined = dyn_cast<Undefined>(config->entry))
6231cf9926bSpatrick treatUndefinedSymbol(*undefined, "the entry point");
6241cf9926bSpatrick
6251cf9926bSpatrick // FIXME: This prints symbols that are undefined both in input files and
6261cf9926bSpatrick // via -u flag twice.
6271cf9926bSpatrick for (const Symbol *sym : config->explicitUndefineds) {
6281cf9926bSpatrick if (const auto *undefined = dyn_cast<Undefined>(sym))
6291cf9926bSpatrick treatUndefinedSymbol(*undefined, "-u");
630bb684c34Spatrick }
6311cf9926bSpatrick // Literal exported-symbol names must be defined, but glob
6321cf9926bSpatrick // patterns need not match.
6331cf9926bSpatrick for (const CachedHashStringRef &cachedName :
6341cf9926bSpatrick config->exportedSymbols.literals) {
6351cf9926bSpatrick if (const Symbol *sym = symtab->find(cachedName))
6361cf9926bSpatrick if (const auto *undefined = dyn_cast<Undefined>(sym))
6371cf9926bSpatrick treatUndefinedSymbol(*undefined, "-exported_symbol(s_list)");
6381cf9926bSpatrick }
6391cf9926bSpatrick }
6401cf9926bSpatrick
prepareSymbolRelocation(Symbol * sym,const InputSection * isec,const lld::macho::Reloc & r)6411cf9926bSpatrick static void prepareSymbolRelocation(Symbol *sym, const InputSection *isec,
642*dfe94b16Srobert const lld::macho::Reloc &r) {
6431cf9926bSpatrick assert(sym->isLive());
6441cf9926bSpatrick const RelocAttrs &relocAttrs = target->getRelocAttrs(r.type);
6451cf9926bSpatrick
6461cf9926bSpatrick if (relocAttrs.hasAttr(RelocAttrBits::BRANCH)) {
647*dfe94b16Srobert if (needsBinding(sym))
648*dfe94b16Srobert in.stubs->addEntry(sym);
6491cf9926bSpatrick } else if (relocAttrs.hasAttr(RelocAttrBits::GOT)) {
6501cf9926bSpatrick if (relocAttrs.hasAttr(RelocAttrBits::POINTER) || needsBinding(sym))
6511cf9926bSpatrick in.got->addEntry(sym);
6521cf9926bSpatrick } else if (relocAttrs.hasAttr(RelocAttrBits::TLV)) {
6531cf9926bSpatrick if (needsBinding(sym))
6541cf9926bSpatrick in.tlvPointers->addEntry(sym);
6551cf9926bSpatrick } else if (relocAttrs.hasAttr(RelocAttrBits::UNSIGNED)) {
6561cf9926bSpatrick // References from thread-local variable sections are treated as offsets
6571cf9926bSpatrick // relative to the start of the referent section, and therefore have no
6581cf9926bSpatrick // need of rebase opcodes.
6591cf9926bSpatrick if (!(isThreadLocalVariables(isec->getFlags()) && isa<Defined>(sym)))
6601cf9926bSpatrick addNonLazyBindingEntries(sym, isec, r.offset, r.addend);
6611cf9926bSpatrick }
6621cf9926bSpatrick }
6631cf9926bSpatrick
scanRelocations()6641cf9926bSpatrick void Writer::scanRelocations() {
6651cf9926bSpatrick TimeTraceScope timeScope("Scan relocations");
6661cf9926bSpatrick
6671cf9926bSpatrick // This can't use a for-each loop: It calls treatUndefinedSymbol(), which can
6681cf9926bSpatrick // add to inputSections, which invalidates inputSections's iterators.
6691cf9926bSpatrick for (size_t i = 0; i < inputSections.size(); ++i) {
6701cf9926bSpatrick ConcatInputSection *isec = inputSections[i];
6711cf9926bSpatrick
6721cf9926bSpatrick if (isec->shouldOmitFromOutput())
6731cf9926bSpatrick continue;
6741cf9926bSpatrick
6751cf9926bSpatrick for (auto it = isec->relocs.begin(); it != isec->relocs.end(); ++it) {
676*dfe94b16Srobert lld::macho::Reloc &r = *it;
6771cf9926bSpatrick if (target->hasAttr(r.type, RelocAttrBits::SUBTRAHEND)) {
6781cf9926bSpatrick // Skip over the following UNSIGNED relocation -- it's just there as the
6791cf9926bSpatrick // minuend, and doesn't have the usual UNSIGNED semantics. We don't want
6801cf9926bSpatrick // to emit rebase opcodes for it.
6811cf9926bSpatrick it++;
6821cf9926bSpatrick continue;
6831cf9926bSpatrick }
6841cf9926bSpatrick if (auto *sym = r.referent.dyn_cast<Symbol *>()) {
6851cf9926bSpatrick if (auto *undefined = dyn_cast<Undefined>(sym))
686*dfe94b16Srobert treatUndefinedSymbol(*undefined, isec, r.offset);
6871cf9926bSpatrick // treatUndefinedSymbol() can replace sym with a DylibSymbol; re-check.
6881cf9926bSpatrick if (!isa<Undefined>(sym) && validateSymbolRelocation(sym, isec, r))
6891cf9926bSpatrick prepareSymbolRelocation(sym, isec, r);
6901cf9926bSpatrick } else {
6911cf9926bSpatrick // Canonicalize the referent so that later accesses in Writer won't
6921cf9926bSpatrick // have to worry about it. Perhaps we should do this for Defined::isec
6931cf9926bSpatrick // too...
6941cf9926bSpatrick auto *referentIsec = r.referent.get<InputSection *>();
6951cf9926bSpatrick r.referent = referentIsec->canonical();
696*dfe94b16Srobert if (!r.pcrel) {
697*dfe94b16Srobert if (config->emitChainedFixups)
698*dfe94b16Srobert in.chainedFixups->addRebase(isec, r.offset);
699*dfe94b16Srobert else
7001cf9926bSpatrick in.rebase->addEntry(isec, r.offset);
701bb684c34Spatrick }
702bb684c34Spatrick }
703bb684c34Spatrick }
704*dfe94b16Srobert }
705bb684c34Spatrick
706*dfe94b16Srobert in.unwindInfo->prepare();
707*dfe94b16Srobert }
708*dfe94b16Srobert
addNonWeakDefinition(const Defined * defined)709*dfe94b16Srobert static void addNonWeakDefinition(const Defined *defined) {
710*dfe94b16Srobert if (config->emitChainedFixups)
711*dfe94b16Srobert in.chainedFixups->setHasNonWeakDefinition();
712*dfe94b16Srobert else
713*dfe94b16Srobert in.weakBinding->addNonWeakDefinition(defined);
7141cf9926bSpatrick }
7151cf9926bSpatrick
scanSymbols()7161cf9926bSpatrick void Writer::scanSymbols() {
7171cf9926bSpatrick TimeTraceScope timeScope("Scan symbols");
718*dfe94b16Srobert for (Symbol *sym : symtab->getSymbols()) {
719*dfe94b16Srobert if (auto *defined = dyn_cast<Defined>(sym)) {
720*dfe94b16Srobert if (!defined->isLive())
721*dfe94b16Srobert continue;
722*dfe94b16Srobert defined->canonicalize();
723*dfe94b16Srobert if (defined->overridesWeakDef)
724*dfe94b16Srobert addNonWeakDefinition(defined);
725*dfe94b16Srobert if (!defined->isAbsolute() && isCodeSection(defined->isec))
726*dfe94b16Srobert in.unwindInfo->addSymbol(defined);
7271cf9926bSpatrick } else if (const auto *dysym = dyn_cast<DylibSymbol>(sym)) {
7281cf9926bSpatrick // This branch intentionally doesn't check isLive().
7291cf9926bSpatrick if (dysym->isDynamicLookup())
7301cf9926bSpatrick continue;
7311cf9926bSpatrick dysym->getFile()->refState =
7321cf9926bSpatrick std::max(dysym->getFile()->refState, dysym->getRefState());
733*dfe94b16Srobert } else if (isa<Undefined>(sym)) {
734*dfe94b16Srobert if (sym->getName().startswith(ObjCStubsSection::symbolPrefix))
735*dfe94b16Srobert in.objcStubs->addEntry(sym);
736*dfe94b16Srobert }
737*dfe94b16Srobert }
738*dfe94b16Srobert
739*dfe94b16Srobert for (const InputFile *file : inputFiles) {
740*dfe94b16Srobert if (auto *objFile = dyn_cast<ObjFile>(file))
741*dfe94b16Srobert for (Symbol *sym : objFile->symbols) {
742*dfe94b16Srobert if (auto *defined = dyn_cast_or_null<Defined>(sym)) {
743*dfe94b16Srobert if (!defined->isLive())
744*dfe94b16Srobert continue;
745*dfe94b16Srobert defined->canonicalize();
746*dfe94b16Srobert if (!defined->isExternal() && !defined->isAbsolute() &&
747*dfe94b16Srobert isCodeSection(defined->isec))
748*dfe94b16Srobert in.unwindInfo->addSymbol(defined);
749*dfe94b16Srobert }
7501cf9926bSpatrick }
7511cf9926bSpatrick }
7521cf9926bSpatrick }
7531cf9926bSpatrick
7541cf9926bSpatrick // TODO: ld64 enforces the old load commands in a few other cases.
useLCBuildVersion(const PlatformInfo & platformInfo)7551cf9926bSpatrick static bool useLCBuildVersion(const PlatformInfo &platformInfo) {
756*dfe94b16Srobert static const std::array<std::pair<PlatformType, VersionTuple>, 7> minVersion =
757*dfe94b16Srobert {{{PLATFORM_MACOS, VersionTuple(10, 14)},
758*dfe94b16Srobert {PLATFORM_IOS, VersionTuple(12, 0)},
759*dfe94b16Srobert {PLATFORM_IOSSIMULATOR, VersionTuple(13, 0)},
760*dfe94b16Srobert {PLATFORM_TVOS, VersionTuple(12, 0)},
761*dfe94b16Srobert {PLATFORM_TVOSSIMULATOR, VersionTuple(13, 0)},
762*dfe94b16Srobert {PLATFORM_WATCHOS, VersionTuple(5, 0)},
763*dfe94b16Srobert {PLATFORM_WATCHOSSIMULATOR, VersionTuple(6, 0)}}};
7641cf9926bSpatrick auto it = llvm::find_if(minVersion, [&](const auto &p) {
7651cf9926bSpatrick return p.first == platformInfo.target.Platform;
7661cf9926bSpatrick });
7671cf9926bSpatrick return it == minVersion.end() ? true : platformInfo.minimum >= it->second;
7681cf9926bSpatrick }
7691cf9926bSpatrick
createLoadCommands()7701cf9926bSpatrick template <class LP> void Writer::createLoadCommands() {
7711cf9926bSpatrick uint8_t segIndex = 0;
7721cf9926bSpatrick for (OutputSegment *seg : outputSegments) {
7731cf9926bSpatrick in.header->addLoadCommand(make<LCSegment<LP>>(seg->name, seg));
7741cf9926bSpatrick seg->index = segIndex++;
7751cf9926bSpatrick }
7761cf9926bSpatrick
777*dfe94b16Srobert if (config->emitChainedFixups) {
778*dfe94b16Srobert in.header->addLoadCommand(make<LCChainedFixups>(in.chainedFixups));
779*dfe94b16Srobert in.header->addLoadCommand(make<LCExportsTrie>(in.exports));
780*dfe94b16Srobert } else {
7811cf9926bSpatrick in.header->addLoadCommand(make<LCDyldInfo>(
7821cf9926bSpatrick in.rebase, in.binding, in.weakBinding, in.lazyBinding, in.exports));
783*dfe94b16Srobert }
7841cf9926bSpatrick in.header->addLoadCommand(make<LCSymtab>(symtabSection, stringTableSection));
7851cf9926bSpatrick in.header->addLoadCommand(
7861cf9926bSpatrick make<LCDysymtab>(symtabSection, indirectSymtabSection));
7871cf9926bSpatrick if (!config->umbrella.empty())
7881cf9926bSpatrick in.header->addLoadCommand(make<LCSubFramework>(config->umbrella));
7891cf9926bSpatrick if (config->emitEncryptionInfo)
7901cf9926bSpatrick in.header->addLoadCommand(make<LCEncryptionInfo<LP>>());
7911cf9926bSpatrick for (StringRef path : config->runtimePaths)
7921cf9926bSpatrick in.header->addLoadCommand(make<LCRPath>(path));
793bb684c34Spatrick
794bb684c34Spatrick switch (config->outputType) {
795bb684c34Spatrick case MH_EXECUTE:
7961cf9926bSpatrick in.header->addLoadCommand(make<LCLoadDylinker>());
797bb684c34Spatrick break;
798bb684c34Spatrick case MH_DYLIB:
7991cf9926bSpatrick in.header->addLoadCommand(make<LCDylib>(LC_ID_DYLIB, config->installName,
8001cf9926bSpatrick config->dylibCompatibilityVersion,
8011cf9926bSpatrick config->dylibCurrentVersion));
8021cf9926bSpatrick break;
8031cf9926bSpatrick case MH_BUNDLE:
804bb684c34Spatrick break;
805bb684c34Spatrick default:
806bb684c34Spatrick llvm_unreachable("unhandled output file type");
807bb684c34Spatrick }
808bb684c34Spatrick
8091cf9926bSpatrick uuidCommand = make<LCUuid>();
8101cf9926bSpatrick in.header->addLoadCommand(uuidCommand);
811bb684c34Spatrick
8121cf9926bSpatrick if (useLCBuildVersion(config->platformInfo))
8131cf9926bSpatrick in.header->addLoadCommand(make<LCBuildVersion>(config->platformInfo));
8141cf9926bSpatrick else
8151cf9926bSpatrick in.header->addLoadCommand(make<LCMinVersion>(config->platformInfo));
8161cf9926bSpatrick
817*dfe94b16Srobert if (config->secondaryPlatformInfo) {
818*dfe94b16Srobert in.header->addLoadCommand(
819*dfe94b16Srobert make<LCBuildVersion>(*config->secondaryPlatformInfo));
820*dfe94b16Srobert }
821*dfe94b16Srobert
8221cf9926bSpatrick // This is down here to match ld64's load command order.
8231cf9926bSpatrick if (config->outputType == MH_EXECUTE)
8241cf9926bSpatrick in.header->addLoadCommand(make<LCMain>());
8251cf9926bSpatrick
826*dfe94b16Srobert // See ld64's OutputFile::buildDylibOrdinalMapping for the corresponding
827*dfe94b16Srobert // library ordinal computation code in ld64.
8281cf9926bSpatrick int64_t dylibOrdinal = 1;
8291cf9926bSpatrick DenseMap<StringRef, int64_t> ordinalForInstallName;
830*dfe94b16Srobert
831*dfe94b16Srobert std::vector<DylibFile *> dylibFiles;
832bb684c34Spatrick for (InputFile *file : inputFiles) {
833*dfe94b16Srobert if (auto *dylibFile = dyn_cast<DylibFile>(file))
834*dfe94b16Srobert dylibFiles.push_back(dylibFile);
835*dfe94b16Srobert }
836*dfe94b16Srobert for (size_t i = 0; i < dylibFiles.size(); ++i)
837*dfe94b16Srobert dylibFiles.insert(dylibFiles.end(), dylibFiles[i]->extraDylibs.begin(),
838*dfe94b16Srobert dylibFiles[i]->extraDylibs.end());
839*dfe94b16Srobert
840*dfe94b16Srobert for (DylibFile *dylibFile : dylibFiles) {
8411cf9926bSpatrick if (dylibFile->isBundleLoader) {
8421cf9926bSpatrick dylibFile->ordinal = BIND_SPECIAL_DYLIB_MAIN_EXECUTABLE;
8431cf9926bSpatrick // Shortcut since bundle-loader does not re-export the symbols.
8441cf9926bSpatrick
8451cf9926bSpatrick dylibFile->reexport = false;
8461cf9926bSpatrick continue;
8471cf9926bSpatrick }
8481cf9926bSpatrick
8491cf9926bSpatrick // Don't emit load commands for a dylib that is not referenced if:
8501cf9926bSpatrick // - it was added implicitly (via a reexport, an LC_LOAD_DYLINKER --
8511cf9926bSpatrick // if it's on the linker command line, it's explicit)
8521cf9926bSpatrick // - or it's marked MH_DEAD_STRIPPABLE_DYLIB
8531cf9926bSpatrick // - or the flag -dead_strip_dylibs is used
8541cf9926bSpatrick // FIXME: `isReferenced()` is currently computed before dead code
8551cf9926bSpatrick // stripping, so references from dead code keep a dylib alive. This
8561cf9926bSpatrick // matches ld64, but it's something we should do better.
8571cf9926bSpatrick if (!dylibFile->isReferenced() && !dylibFile->forceNeeded &&
858*dfe94b16Srobert (!dylibFile->isExplicitlyLinked() || dylibFile->deadStrippable ||
8591cf9926bSpatrick config->deadStripDylibs))
8601cf9926bSpatrick continue;
8611cf9926bSpatrick
8621cf9926bSpatrick // Several DylibFiles can have the same installName. Only emit a single
8631cf9926bSpatrick // load command for that installName and give all these DylibFiles the
8641cf9926bSpatrick // same ordinal.
8651cf9926bSpatrick // This can happen in several cases:
8661cf9926bSpatrick // - a new framework could change its installName to an older
8671cf9926bSpatrick // framework name via an $ld$ symbol depending on platform_version
8681cf9926bSpatrick // - symlinks (for example, libpthread.tbd is a symlink to libSystem.tbd;
8691cf9926bSpatrick // Foo.framework/Foo.tbd is usually a symlink to
8701cf9926bSpatrick // Foo.framework/Versions/Current/Foo.tbd, where
8711cf9926bSpatrick // Foo.framework/Versions/Current is usually a symlink to
8721cf9926bSpatrick // Foo.framework/Versions/A)
8731cf9926bSpatrick // - a framework can be linked both explicitly on the linker
8741cf9926bSpatrick // command line and implicitly as a reexport from a different
8751cf9926bSpatrick // framework. The re-export will usually point to the tbd file
8761cf9926bSpatrick // in Foo.framework/Versions/A/Foo.tbd, while the explicit link will
8771cf9926bSpatrick // usually find Foo.framework/Foo.tbd. These are usually symlinks,
8781cf9926bSpatrick // but in a --reproduce archive they will be identical but distinct
8791cf9926bSpatrick // files.
8801cf9926bSpatrick // In the first case, *semantically distinct* DylibFiles will have the
8811cf9926bSpatrick // same installName.
8821cf9926bSpatrick int64_t &ordinal = ordinalForInstallName[dylibFile->installName];
8831cf9926bSpatrick if (ordinal) {
8841cf9926bSpatrick dylibFile->ordinal = ordinal;
8851cf9926bSpatrick continue;
8861cf9926bSpatrick }
8871cf9926bSpatrick
8881cf9926bSpatrick ordinal = dylibFile->ordinal = dylibOrdinal++;
8891cf9926bSpatrick LoadCommandType lcType =
8901cf9926bSpatrick dylibFile->forceWeakImport || dylibFile->refState == RefState::Weak
8911cf9926bSpatrick ? LC_LOAD_WEAK_DYLIB
8921cf9926bSpatrick : LC_LOAD_DYLIB;
8931cf9926bSpatrick in.header->addLoadCommand(make<LCDylib>(lcType, dylibFile->installName,
8941cf9926bSpatrick dylibFile->compatibilityVersion,
8951cf9926bSpatrick dylibFile->currentVersion));
896bb684c34Spatrick
897bb684c34Spatrick if (dylibFile->reexport)
8981cf9926bSpatrick in.header->addLoadCommand(
8991cf9926bSpatrick make<LCDylib>(LC_REEXPORT_DYLIB, dylibFile->installName));
900bb684c34Spatrick }
901*dfe94b16Srobert
902*dfe94b16Srobert for (const auto &dyldEnv : config->dyldEnvs)
903*dfe94b16Srobert in.header->addLoadCommand(make<LCDyldEnv>(dyldEnv));
9041cf9926bSpatrick
9051cf9926bSpatrick if (functionStartsSection)
9061cf9926bSpatrick in.header->addLoadCommand(make<LCFunctionStarts>(functionStartsSection));
9071cf9926bSpatrick if (dataInCodeSection)
9081cf9926bSpatrick in.header->addLoadCommand(make<LCDataInCode>(dataInCodeSection));
9091cf9926bSpatrick if (codeSignatureSection)
9101cf9926bSpatrick in.header->addLoadCommand(make<LCCodeSignature>(codeSignatureSection));
9111cf9926bSpatrick
9121cf9926bSpatrick const uint32_t MACOS_MAXPATHLEN = 1024;
9131cf9926bSpatrick config->headerPad = std::max(
9141cf9926bSpatrick config->headerPad, (config->headerPadMaxInstallNames
9151cf9926bSpatrick ? LCDylib::getInstanceCount() * MACOS_MAXPATHLEN
9161cf9926bSpatrick : 0));
917bb684c34Spatrick }
918bb684c34Spatrick
919bb684c34Spatrick // Sorting only can happen once all outputs have been collected. Here we sort
920bb684c34Spatrick // segments, output sections within each segment, and input sections within each
921bb684c34Spatrick // output segment.
sortSegmentsAndSections()922bb684c34Spatrick static void sortSegmentsAndSections() {
9231cf9926bSpatrick TimeTraceScope timeScope("Sort segments and sections");
9241cf9926bSpatrick sortOutputSegments();
925bb684c34Spatrick
926bb684c34Spatrick DenseMap<const InputSection *, size_t> isecPriorities =
927*dfe94b16Srobert priorityBuilder.buildInputSectionPriorities();
928bb684c34Spatrick
929bb684c34Spatrick uint32_t sectionIndex = 0;
930bb684c34Spatrick for (OutputSegment *seg : outputSegments) {
9311cf9926bSpatrick seg->sortOutputSections();
932*dfe94b16Srobert // References from thread-local variable sections are treated as offsets
933*dfe94b16Srobert // relative to the start of the thread-local data memory area, which
934*dfe94b16Srobert // is initialized via copying all the TLV data sections (which are all
935*dfe94b16Srobert // contiguous). If later data sections require a greater alignment than
936*dfe94b16Srobert // earlier ones, the offsets of data within those sections won't be
937*dfe94b16Srobert // guaranteed to aligned unless we normalize alignments. We therefore use
938*dfe94b16Srobert // the largest alignment for all TLV data sections.
939*dfe94b16Srobert uint32_t tlvAlign = 0;
940*dfe94b16Srobert for (const OutputSection *osec : seg->getSections())
941*dfe94b16Srobert if (isThreadLocalData(osec->flags) && osec->align > tlvAlign)
942*dfe94b16Srobert tlvAlign = osec->align;
943*dfe94b16Srobert
9441cf9926bSpatrick for (OutputSection *osec : seg->getSections()) {
945bb684c34Spatrick // Now that the output sections are sorted, assign the final
946bb684c34Spatrick // output section indices.
947bb684c34Spatrick if (!osec->isHidden())
948bb684c34Spatrick osec->index = ++sectionIndex;
949*dfe94b16Srobert if (isThreadLocalData(osec->flags)) {
950*dfe94b16Srobert if (!firstTLVDataSection)
9511cf9926bSpatrick firstTLVDataSection = osec;
952*dfe94b16Srobert osec->align = tlvAlign;
953*dfe94b16Srobert }
954bb684c34Spatrick
955bb684c34Spatrick if (!isecPriorities.empty()) {
9561cf9926bSpatrick if (auto *merged = dyn_cast<ConcatOutputSection>(osec)) {
957*dfe94b16Srobert llvm::stable_sort(
958*dfe94b16Srobert merged->inputs, [&](InputSection *a, InputSection *b) {
959*dfe94b16Srobert return isecPriorities.lookup(a) > isecPriorities.lookup(b);
960bb684c34Spatrick });
961bb684c34Spatrick }
962bb684c34Spatrick }
963bb684c34Spatrick }
964bb684c34Spatrick }
965bb684c34Spatrick }
966bb684c34Spatrick
createOutputSections()9671cf9926bSpatrick template <class LP> void Writer::createOutputSections() {
9681cf9926bSpatrick TimeTraceScope timeScope("Create output sections");
969bb684c34Spatrick // First, create hidden sections
970bb684c34Spatrick stringTableSection = make<StringTableSection>();
9711cf9926bSpatrick symtabSection = makeSymtabSection<LP>(*stringTableSection);
9721cf9926bSpatrick indirectSymtabSection = make<IndirectSymtabSection>();
9731cf9926bSpatrick if (config->adhocCodesign)
9741cf9926bSpatrick codeSignatureSection = make<CodeSignatureSection>();
9751cf9926bSpatrick if (config->emitDataInCodeInfo)
9761cf9926bSpatrick dataInCodeSection = make<DataInCodeSection>();
9771cf9926bSpatrick if (config->emitFunctionStarts)
9781cf9926bSpatrick functionStartsSection = make<FunctionStartsSection>();
9791cf9926bSpatrick if (config->emitBitcodeBundle)
9801cf9926bSpatrick make<BitcodeBundleSection>();
981bb684c34Spatrick
982bb684c34Spatrick switch (config->outputType) {
983bb684c34Spatrick case MH_EXECUTE:
984bb684c34Spatrick make<PageZeroSection>();
985bb684c34Spatrick break;
986bb684c34Spatrick case MH_DYLIB:
9871cf9926bSpatrick case MH_BUNDLE:
988bb684c34Spatrick break;
989bb684c34Spatrick default:
990bb684c34Spatrick llvm_unreachable("unhandled output file type");
991bb684c34Spatrick }
992bb684c34Spatrick
9931cf9926bSpatrick // Then add input sections to output sections.
9941cf9926bSpatrick for (ConcatInputSection *isec : inputSections) {
9951cf9926bSpatrick if (isec->shouldOmitFromOutput())
9961cf9926bSpatrick continue;
9971cf9926bSpatrick ConcatOutputSection *osec = cast<ConcatOutputSection>(isec->parent);
9981cf9926bSpatrick osec->addInput(isec);
9991cf9926bSpatrick osec->inputOrder =
10001cf9926bSpatrick std::min(osec->inputOrder, static_cast<int>(isec->outSecOff));
1001bb684c34Spatrick }
1002bb684c34Spatrick
10031cf9926bSpatrick // Once all the inputs are added, we can finalize the output section
10041cf9926bSpatrick // properties and create the corresponding output segments.
10051cf9926bSpatrick for (const auto &it : concatOutputSections) {
1006bb684c34Spatrick StringRef segname = it.first.first;
10071cf9926bSpatrick ConcatOutputSection *osec = it.second;
10081cf9926bSpatrick assert(segname != segment_names::ld);
1009*dfe94b16Srobert if (osec->isNeeded()) {
1010*dfe94b16Srobert // See comment in ObjFile::splitEhFrames()
1011*dfe94b16Srobert if (osec->name == section_names::ehFrame &&
1012*dfe94b16Srobert segname == segment_names::text)
1013*dfe94b16Srobert osec->align = target->wordSize;
1014*dfe94b16Srobert
1015*dfe94b16Srobert // MC keeps the default 1-byte alignment for __thread_vars, even though it
1016*dfe94b16Srobert // contains pointers that are fixed up by dyld, which requires proper
1017*dfe94b16Srobert // alignment.
1018*dfe94b16Srobert if (isThreadLocalVariables(osec->flags))
1019*dfe94b16Srobert osec->align = std::max<uint32_t>(osec->align, target->wordSize);
1020*dfe94b16Srobert
1021bb684c34Spatrick getOrCreateOutputSegment(segname)->addOutputSection(osec);
1022bb684c34Spatrick }
1023*dfe94b16Srobert }
1024bb684c34Spatrick
1025bb684c34Spatrick for (SyntheticSection *ssec : syntheticSections) {
10261cf9926bSpatrick auto it = concatOutputSections.find({ssec->segname, ssec->name});
1027*dfe94b16Srobert // We add all LinkEdit sections here because we don't know if they are
1028*dfe94b16Srobert // needed until their finalizeContents() methods get called later. While
1029*dfe94b16Srobert // this means that we add some redundant sections to __LINKEDIT, there is
1030*dfe94b16Srobert // is no redundancy in the output, as we do not emit section headers for
1031*dfe94b16Srobert // any LinkEdit sections.
1032*dfe94b16Srobert if (ssec->isNeeded() || ssec->segname == segment_names::linkEdit) {
10331cf9926bSpatrick if (it == concatOutputSections.end()) {
1034bb684c34Spatrick getOrCreateOutputSegment(ssec->segname)->addOutputSection(ssec);
1035bb684c34Spatrick } else {
10361cf9926bSpatrick fatal("section from " +
10371cf9926bSpatrick toString(it->second->firstSection()->getFile()) +
1038bb684c34Spatrick " conflicts with synthetic section " + ssec->segname + "," +
1039bb684c34Spatrick ssec->name);
1040bb684c34Spatrick }
1041bb684c34Spatrick }
1042bb684c34Spatrick }
1043bb684c34Spatrick
10441cf9926bSpatrick // dyld requires __LINKEDIT segment to always exist (even if empty).
10451cf9926bSpatrick linkEditSegment = getOrCreateOutputSegment(segment_names::linkEdit);
10461cf9926bSpatrick }
10471cf9926bSpatrick
finalizeAddresses()10481cf9926bSpatrick void Writer::finalizeAddresses() {
10491cf9926bSpatrick TimeTraceScope timeScope("Finalize addresses");
10501cf9926bSpatrick uint64_t pageSize = target->getPageSize();
1051*dfe94b16Srobert
1052*dfe94b16Srobert // We could parallelize this loop, but local benchmarking indicates it is
1053*dfe94b16Srobert // faster to do it all in the main thread.
1054*dfe94b16Srobert for (OutputSegment *seg : outputSegments) {
1055*dfe94b16Srobert if (seg == linkEditSegment)
1056*dfe94b16Srobert continue;
1057*dfe94b16Srobert for (OutputSection *osec : seg->getSections()) {
1058*dfe94b16Srobert if (!osec->isNeeded())
1059*dfe94b16Srobert continue;
1060*dfe94b16Srobert // Other kinds of OutputSections have already been finalized.
1061*dfe94b16Srobert if (auto concatOsec = dyn_cast<ConcatOutputSection>(osec))
1062*dfe94b16Srobert concatOsec->finalizeContents();
1063*dfe94b16Srobert }
1064*dfe94b16Srobert }
1065*dfe94b16Srobert
10661cf9926bSpatrick // Ensure that segments (and the sections they contain) are allocated
10671cf9926bSpatrick // addresses in ascending order, which dyld requires.
10681cf9926bSpatrick //
10691cf9926bSpatrick // Note that at this point, __LINKEDIT sections are empty, but we need to
10701cf9926bSpatrick // determine addresses of other segments/sections before generating its
10711cf9926bSpatrick // contents.
10721cf9926bSpatrick for (OutputSegment *seg : outputSegments) {
10731cf9926bSpatrick if (seg == linkEditSegment)
10741cf9926bSpatrick continue;
10751cf9926bSpatrick seg->addr = addr;
10761cf9926bSpatrick assignAddresses(seg);
10771cf9926bSpatrick // codesign / libstuff checks for segment ordering by verifying that
10781cf9926bSpatrick // `fileOff + fileSize == next segment fileOff`. So we call alignTo() before
10791cf9926bSpatrick // (instead of after) computing fileSize to ensure that the segments are
10801cf9926bSpatrick // contiguous. We handle addr / vmSize similarly for the same reason.
1081*dfe94b16Srobert fileOff = alignToPowerOf2(fileOff, pageSize);
1082*dfe94b16Srobert addr = alignToPowerOf2(addr, pageSize);
10831cf9926bSpatrick seg->vmSize = addr - seg->addr;
10841cf9926bSpatrick seg->fileSize = fileOff - seg->fileOff;
10851cf9926bSpatrick seg->assignAddressesToStartEndSymbols();
10861cf9926bSpatrick }
10871cf9926bSpatrick }
10881cf9926bSpatrick
finalizeLinkEditSegment()10891cf9926bSpatrick void Writer::finalizeLinkEditSegment() {
10901cf9926bSpatrick TimeTraceScope timeScope("Finalize __LINKEDIT segment");
10911cf9926bSpatrick // Fill __LINKEDIT contents.
1092*dfe94b16Srobert std::array<LinkEditSection *, 10> linkEditSections{
1093*dfe94b16Srobert in.rebase, in.binding,
1094*dfe94b16Srobert in.weakBinding, in.lazyBinding,
1095*dfe94b16Srobert in.exports, in.chainedFixups,
1096*dfe94b16Srobert symtabSection, indirectSymtabSection,
1097*dfe94b16Srobert dataInCodeSection, functionStartsSection,
10981cf9926bSpatrick };
1099*dfe94b16Srobert SmallVector<std::shared_future<void>> threadFutures;
1100*dfe94b16Srobert threadFutures.reserve(linkEditSections.size());
1101*dfe94b16Srobert for (LinkEditSection *osec : linkEditSections)
11021cf9926bSpatrick if (osec)
1103*dfe94b16Srobert threadFutures.emplace_back(threadPool.async(
1104*dfe94b16Srobert [](LinkEditSection *osec) { osec->finalizeContents(); }, osec));
1105*dfe94b16Srobert for (std::shared_future<void> &future : threadFutures)
1106*dfe94b16Srobert future.wait();
11071cf9926bSpatrick
11081cf9926bSpatrick // Now that __LINKEDIT is filled out, do a proper calculation of its
11091cf9926bSpatrick // addresses and offsets.
11101cf9926bSpatrick linkEditSegment->addr = addr;
11111cf9926bSpatrick assignAddresses(linkEditSegment);
11121cf9926bSpatrick // No need to page-align fileOff / addr here since this is the last segment.
11131cf9926bSpatrick linkEditSegment->vmSize = addr - linkEditSegment->addr;
11141cf9926bSpatrick linkEditSegment->fileSize = fileOff - linkEditSegment->fileOff;
11151cf9926bSpatrick }
11161cf9926bSpatrick
assignAddresses(OutputSegment * seg)1117bb684c34Spatrick void Writer::assignAddresses(OutputSegment *seg) {
1118bb684c34Spatrick seg->fileOff = fileOff;
1119bb684c34Spatrick
11201cf9926bSpatrick for (OutputSection *osec : seg->getSections()) {
11211cf9926bSpatrick if (!osec->isNeeded())
11221cf9926bSpatrick continue;
1123bb684c34Spatrick addr = alignTo(addr, osec->align);
1124bb684c34Spatrick fileOff = alignTo(fileOff, osec->align);
1125bb684c34Spatrick osec->addr = addr;
1126bb684c34Spatrick osec->fileOff = isZeroFill(osec->flags) ? 0 : fileOff;
1127bb684c34Spatrick osec->finalize();
11281cf9926bSpatrick osec->assignAddressesToStartEndSymbols();
1129bb684c34Spatrick
1130bb684c34Spatrick addr += osec->getSize();
1131bb684c34Spatrick fileOff += osec->getFileSize();
1132bb684c34Spatrick }
1133bb684c34Spatrick }
1134bb684c34Spatrick
openFile()1135bb684c34Spatrick void Writer::openFile() {
1136bb684c34Spatrick Expected<std::unique_ptr<FileOutputBuffer>> bufferOrErr =
1137bb684c34Spatrick FileOutputBuffer::create(config->outputFile, fileOff,
1138bb684c34Spatrick FileOutputBuffer::F_executable);
1139bb684c34Spatrick
1140bb684c34Spatrick if (!bufferOrErr)
1141*dfe94b16Srobert fatal("failed to open " + config->outputFile + ": " +
1142bb684c34Spatrick llvm::toString(bufferOrErr.takeError()));
1143bb684c34Spatrick buffer = std::move(*bufferOrErr);
1144*dfe94b16Srobert in.bufferStart = buffer->getBufferStart();
1145bb684c34Spatrick }
1146bb684c34Spatrick
writeSections()1147bb684c34Spatrick void Writer::writeSections() {
1148bb684c34Spatrick uint8_t *buf = buffer->getBufferStart();
1149*dfe94b16Srobert std::vector<const OutputSection *> osecs;
11501cf9926bSpatrick for (const OutputSegment *seg : outputSegments)
1151*dfe94b16Srobert append_range(osecs, seg->getSections());
1152*dfe94b16Srobert
1153*dfe94b16Srobert parallelForEach(osecs.begin(), osecs.end(), [&](const OutputSection *osec) {
1154bb684c34Spatrick osec->writeTo(buf + osec->fileOff);
1155*dfe94b16Srobert });
1156*dfe94b16Srobert }
1157*dfe94b16Srobert
applyOptimizationHints()1158*dfe94b16Srobert void Writer::applyOptimizationHints() {
1159*dfe94b16Srobert if (config->arch() != AK_arm64 || config->ignoreOptimizationHints)
1160*dfe94b16Srobert return;
1161*dfe94b16Srobert
1162*dfe94b16Srobert uint8_t *buf = buffer->getBufferStart();
1163*dfe94b16Srobert TimeTraceScope timeScope("Apply linker optimization hints");
1164*dfe94b16Srobert parallelForEach(inputFiles, [buf](const InputFile *file) {
1165*dfe94b16Srobert if (const auto *objFile = dyn_cast<ObjFile>(file))
1166*dfe94b16Srobert target->applyOptimizationHints(buf, *objFile);
1167*dfe94b16Srobert });
1168bb684c34Spatrick }
1169bb684c34Spatrick
11701cf9926bSpatrick // In order to utilize multiple cores, we first split the buffer into chunks,
11711cf9926bSpatrick // compute a hash for each chunk, and then compute a hash value of the hash
11721cf9926bSpatrick // values.
writeUuid()11731cf9926bSpatrick void Writer::writeUuid() {
11741cf9926bSpatrick TimeTraceScope timeScope("Computing UUID");
1175*dfe94b16Srobert
11761cf9926bSpatrick ArrayRef<uint8_t> data{buffer->getBufferStart(), buffer->getBufferEnd()};
11771cf9926bSpatrick unsigned chunkCount = parallel::strategy.compute_thread_count() * 10;
11781cf9926bSpatrick // Round-up integer division
11791cf9926bSpatrick size_t chunkSize = (data.size() + chunkCount - 1) / chunkCount;
11801cf9926bSpatrick std::vector<ArrayRef<uint8_t>> chunks = split(data, chunkSize);
1181*dfe94b16Srobert // Leave one slot for filename
1182*dfe94b16Srobert std::vector<uint64_t> hashes(chunks.size() + 1);
1183*dfe94b16Srobert SmallVector<std::shared_future<void>> threadFutures;
1184*dfe94b16Srobert threadFutures.reserve(chunks.size());
1185*dfe94b16Srobert for (size_t i = 0; i < chunks.size(); ++i)
1186*dfe94b16Srobert threadFutures.emplace_back(threadPool.async(
1187*dfe94b16Srobert [&](size_t j) { hashes[j] = xxHash64(chunks[j]); }, i));
1188*dfe94b16Srobert for (std::shared_future<void> &future : threadFutures)
1189*dfe94b16Srobert future.wait();
1190*dfe94b16Srobert // Append the output filename so that identical binaries with different names
1191*dfe94b16Srobert // don't get the same UUID.
1192*dfe94b16Srobert hashes[chunks.size()] = xxHash64(sys::path::filename(config->finalOutput));
11931cf9926bSpatrick uint64_t digest = xxHash64({reinterpret_cast<uint8_t *>(hashes.data()),
11941cf9926bSpatrick hashes.size() * sizeof(uint64_t)});
11951cf9926bSpatrick uuidCommand->writeUuid(digest);
11961cf9926bSpatrick }
1197bb684c34Spatrick
1198*dfe94b16Srobert // This is step 5 of the algorithm described in the class comment of
1199*dfe94b16Srobert // ChainedFixupsSection.
buildFixupChains()1200*dfe94b16Srobert void Writer::buildFixupChains() {
1201*dfe94b16Srobert if (!config->emitChainedFixups)
1202*dfe94b16Srobert return;
1203*dfe94b16Srobert
1204*dfe94b16Srobert const std::vector<Location> &loc = in.chainedFixups->getLocations();
1205*dfe94b16Srobert if (loc.empty())
1206*dfe94b16Srobert return;
1207*dfe94b16Srobert
1208*dfe94b16Srobert TimeTraceScope timeScope("Build fixup chains");
1209*dfe94b16Srobert
1210*dfe94b16Srobert const uint64_t pageSize = target->getPageSize();
1211*dfe94b16Srobert constexpr uint32_t stride = 4; // for DYLD_CHAINED_PTR_64
1212*dfe94b16Srobert
1213*dfe94b16Srobert for (size_t i = 0, count = loc.size(); i < count;) {
1214*dfe94b16Srobert const OutputSegment *oseg = loc[i].isec->parent->parent;
1215*dfe94b16Srobert uint8_t *buf = buffer->getBufferStart() + oseg->fileOff;
1216*dfe94b16Srobert uint64_t pageIdx = loc[i].offset / pageSize;
1217*dfe94b16Srobert ++i;
1218*dfe94b16Srobert
1219*dfe94b16Srobert while (i < count && loc[i].isec->parent->parent == oseg &&
1220*dfe94b16Srobert (loc[i].offset / pageSize) == pageIdx) {
1221*dfe94b16Srobert uint64_t offset = loc[i].offset - loc[i - 1].offset;
1222*dfe94b16Srobert
1223*dfe94b16Srobert auto fail = [&](Twine message) {
1224*dfe94b16Srobert error(loc[i].isec->getSegName() + "," + loc[i].isec->getName() +
1225*dfe94b16Srobert ", offset " +
1226*dfe94b16Srobert Twine(loc[i].offset - loc[i].isec->parent->getSegmentOffset()) +
1227*dfe94b16Srobert ": " + message);
1228*dfe94b16Srobert };
1229*dfe94b16Srobert
1230*dfe94b16Srobert if (offset < target->wordSize)
1231*dfe94b16Srobert return fail("fixups overlap");
1232*dfe94b16Srobert if (offset % stride != 0)
1233*dfe94b16Srobert return fail(
1234*dfe94b16Srobert "fixups are unaligned (offset " + Twine(offset) +
1235*dfe94b16Srobert " is not a multiple of the stride). Re-link with -no_fixup_chains");
1236*dfe94b16Srobert
1237*dfe94b16Srobert // The "next" field is in the same location for bind and rebase entries.
1238*dfe94b16Srobert reinterpret_cast<dyld_chained_ptr_64_bind *>(buf + loc[i - 1].offset)
1239*dfe94b16Srobert ->next = offset / stride;
1240*dfe94b16Srobert ++i;
1241*dfe94b16Srobert }
1242*dfe94b16Srobert }
1243*dfe94b16Srobert }
1244*dfe94b16Srobert
writeCodeSignature()12451cf9926bSpatrick void Writer::writeCodeSignature() {
1246*dfe94b16Srobert if (codeSignatureSection) {
1247*dfe94b16Srobert TimeTraceScope timeScope("Write code signature");
12481cf9926bSpatrick codeSignatureSection->writeHashes(buffer->getBufferStart());
12491cf9926bSpatrick }
1250*dfe94b16Srobert }
1251bb684c34Spatrick
writeOutputFile()12521cf9926bSpatrick void Writer::writeOutputFile() {
12531cf9926bSpatrick TimeTraceScope timeScope("Write output file");
1254bb684c34Spatrick openFile();
1255*dfe94b16Srobert reportPendingUndefinedSymbols();
1256bb684c34Spatrick if (errorCount())
1257bb684c34Spatrick return;
1258bb684c34Spatrick writeSections();
1259*dfe94b16Srobert applyOptimizationHints();
1260*dfe94b16Srobert buildFixupChains();
12611cf9926bSpatrick writeUuid();
12621cf9926bSpatrick writeCodeSignature();
1263bb684c34Spatrick
1264bb684c34Spatrick if (auto e = buffer->commit())
1265*dfe94b16Srobert fatal("failed to write output '" + buffer->getPath() +
1266*dfe94b16Srobert "': " + toString(std::move(e)));
1267bb684c34Spatrick }
1268bb684c34Spatrick
run()12691cf9926bSpatrick template <class LP> void Writer::run() {
12701cf9926bSpatrick treatSpecialUndefineds();
1271*dfe94b16Srobert if (config->entry && needsBinding(config->entry))
1272*dfe94b16Srobert in.stubs->addEntry(config->entry);
1273*dfe94b16Srobert
1274*dfe94b16Srobert // Canonicalization of all pointers to InputSections should be handled by
1275*dfe94b16Srobert // these two scan* methods. I.e. from this point onward, for all live
1276*dfe94b16Srobert // InputSections, we should have `isec->canonical() == isec`.
12771cf9926bSpatrick scanSymbols();
1278*dfe94b16Srobert if (in.objcStubs->isNeeded())
1279*dfe94b16Srobert in.objcStubs->setUp();
1280*dfe94b16Srobert scanRelocations();
1281*dfe94b16Srobert if (in.initOffsets->isNeeded())
1282*dfe94b16Srobert in.initOffsets->setUp();
1283*dfe94b16Srobert
1284*dfe94b16Srobert // Do not proceed if there were undefined or duplicate symbols.
1285*dfe94b16Srobert reportPendingUndefinedSymbols();
1286*dfe94b16Srobert reportPendingDuplicateSymbols();
1287*dfe94b16Srobert if (errorCount())
1288*dfe94b16Srobert return;
1289*dfe94b16Srobert
1290*dfe94b16Srobert if (in.stubHelper && in.stubHelper->isNeeded())
1291*dfe94b16Srobert in.stubHelper->setUp();
1292*dfe94b16Srobert
1293*dfe94b16Srobert if (in.objCImageInfo->isNeeded())
1294*dfe94b16Srobert in.objCImageInfo->finalizeContents();
1295*dfe94b16Srobert
1296*dfe94b16Srobert // At this point, we should know exactly which output sections are needed,
1297*dfe94b16Srobert // courtesy of scanSymbols() and scanRelocations().
12981cf9926bSpatrick createOutputSections<LP>();
1299*dfe94b16Srobert
13001cf9926bSpatrick // After this point, we create no new segments; HOWEVER, we might
13011cf9926bSpatrick // yet create branch-range extension thunks for architectures whose
13021cf9926bSpatrick // hardware call instructions have limited range, e.g., ARM(64).
13031cf9926bSpatrick // The thunks are created as InputSections interspersed among
13041cf9926bSpatrick // the ordinary __TEXT,_text InputSections.
13051cf9926bSpatrick sortSegmentsAndSections();
13061cf9926bSpatrick createLoadCommands<LP>();
13071cf9926bSpatrick finalizeAddresses();
1308*dfe94b16Srobert threadPool.async([&] {
1309*dfe94b16Srobert if (LLVM_ENABLE_THREADS && config->timeTraceEnabled)
1310*dfe94b16Srobert timeTraceProfilerInitialize(config->timeTraceGranularity, "writeMapFile");
13111cf9926bSpatrick writeMapFile();
1312*dfe94b16Srobert if (LLVM_ENABLE_THREADS && config->timeTraceEnabled)
1313*dfe94b16Srobert timeTraceProfilerFinishThread();
1314*dfe94b16Srobert });
1315*dfe94b16Srobert finalizeLinkEditSegment();
13161cf9926bSpatrick writeOutputFile();
13171cf9926bSpatrick }
13181cf9926bSpatrick
writeResult()13191cf9926bSpatrick template <class LP> void macho::writeResult() { Writer().run<LP>(); }
1320bb684c34Spatrick
resetWriter()1321*dfe94b16Srobert void macho::resetWriter() { LCDylib::resetInstanceCount(); }
1322*dfe94b16Srobert
createSyntheticSections()1323bb684c34Spatrick void macho::createSyntheticSections() {
13241cf9926bSpatrick in.header = make<MachHeaderSection>();
1325*dfe94b16Srobert if (config->dedupStrings)
1326*dfe94b16Srobert in.cStringSection =
1327*dfe94b16Srobert make<DeduplicatedCStringSection>(section_names::cString);
1328*dfe94b16Srobert else
1329*dfe94b16Srobert in.cStringSection = make<CStringSection>(section_names::cString);
1330*dfe94b16Srobert in.objcMethnameSection =
1331*dfe94b16Srobert make<DeduplicatedCStringSection>(section_names::objcMethname);
1332*dfe94b16Srobert in.wordLiteralSection = make<WordLiteralSection>();
1333*dfe94b16Srobert if (config->emitChainedFixups) {
1334*dfe94b16Srobert in.chainedFixups = make<ChainedFixupsSection>();
13351cf9926bSpatrick } else {
13361cf9926bSpatrick in.rebase = make<RebaseSection>();
1337bb684c34Spatrick in.binding = make<BindingSection>();
13381cf9926bSpatrick in.weakBinding = make<WeakBindingSection>();
13391cf9926bSpatrick in.lazyBinding = make<LazyBindingSection>();
1340*dfe94b16Srobert in.lazyPointers = make<LazyPointerSection>();
1341*dfe94b16Srobert in.stubHelper = make<StubHelperSection>();
1342*dfe94b16Srobert }
13431cf9926bSpatrick in.exports = make<ExportSection>();
1344bb684c34Spatrick in.got = make<GotSection>();
13451cf9926bSpatrick in.tlvPointers = make<TlvPointerSection>();
1346bb684c34Spatrick in.stubs = make<StubsSection>();
1347*dfe94b16Srobert in.objcStubs = make<ObjCStubsSection>();
13481cf9926bSpatrick in.unwindInfo = makeUnwindInfoSection();
1349*dfe94b16Srobert in.objCImageInfo = make<ObjCImageInfoSection>();
1350*dfe94b16Srobert in.initOffsets = make<InitOffsetsSection>();
13511cf9926bSpatrick
13521cf9926bSpatrick // This section contains space for just a single word, and will be used by
13531cf9926bSpatrick // dyld to cache an address to the image loader it uses.
1354*dfe94b16Srobert uint8_t *arr = bAlloc().Allocate<uint8_t>(target->wordSize);
13551cf9926bSpatrick memset(arr, 0, target->wordSize);
1356*dfe94b16Srobert in.imageLoaderCache = makeSyntheticInputSection(
1357*dfe94b16Srobert segment_names::data, section_names::data, S_REGULAR,
13581cf9926bSpatrick ArrayRef<uint8_t>{arr, target->wordSize},
1359*dfe94b16Srobert /*align=*/target->wordSize);
13601cf9926bSpatrick // References from dyld are not visible to us, so ensure this section is
13611cf9926bSpatrick // always treated as live.
13621cf9926bSpatrick in.imageLoaderCache->live = true;
1363bb684c34Spatrick }
13641cf9926bSpatrick
13651cf9926bSpatrick OutputSection *macho::firstTLVDataSection = nullptr;
13661cf9926bSpatrick
13671cf9926bSpatrick template void macho::writeResult<LP64>();
13681cf9926bSpatrick template void macho::writeResult<ILP32>();
1369