1//===- Chunks.cpp ---------------------------------------------------------===//
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#include "Chunks.h"
10#include "COFFLinkerContext.h"
11#include "InputFiles.h"
12#include "SymbolTable.h"
13#include "Symbols.h"
14#include "Writer.h"
15#include "llvm/ADT/STLExtras.h"
16#include "llvm/ADT/StringExtras.h"
17#include "llvm/ADT/Twine.h"
18#include "llvm/BinaryFormat/COFF.h"
19#include "llvm/Object/COFF.h"
20#include "llvm/Support/Debug.h"
21#include "llvm/Support/Endian.h"
22#include "llvm/Support/raw_ostream.h"
23#include <algorithm>
24#include <iterator>
25
26using namespace llvm;
27using namespace llvm::object;
28using namespace llvm::support;
29using namespace llvm::support::endian;
30using namespace llvm::COFF;
31using llvm::support::ulittle32_t;
32
33namespace lld::coff {
34
35SectionChunk::SectionChunk(ObjFile *f, const coff_section *h, Kind k)
36 : Chunk(k), file(f), header(h), repl(this) {
37 // Initialize relocs.
38 if (file)
39 setRelocs(file->getCOFFObj()->getRelocations(Sec: header));
40
41 // Initialize sectionName.
42 StringRef sectionName;
43 if (file) {
44 if (Expected<StringRef> e = file->getCOFFObj()->getSectionName(Sec: header))
45 sectionName = *e;
46 }
47 sectionNameData = sectionName.data();
48 sectionNameSize = sectionName.size();
49
50 setAlignment(header->getAlignment());
51
52 hasData = !(header->Characteristics & IMAGE_SCN_CNT_UNINITIALIZED_DATA);
53
54 // If linker GC is disabled, every chunk starts out alive. If linker GC is
55 // enabled, treat non-comdat sections as roots. Generally optimized object
56 // files will be built with -ffunction-sections or /Gy, so most things worth
57 // stripping will be in a comdat.
58 if (file)
59 live = !file->symtab.ctx.config.doGC || !isCOMDAT();
60 else
61 live = true;
62}
63
64MachineTypes SectionChunk::getMachine() const {
65 MachineTypes machine = file->getMachineType();
66 // On ARM64EC, the IMAGE_SCN_GPREL flag is repurposed to indicate that section
67 // code is x86_64. This enables embedding x86_64 code within ARM64EC object
68 // files. MSVC uses this for export thunks in .exp files.
69 if (isArm64EC(Machine: machine) && (header->Characteristics & IMAGE_SCN_GPREL))
70 machine = AMD64;
71 return machine;
72}
73
74// SectionChunk is one of the most frequently allocated classes, so it is
75// important to keep it as compact as possible. As of this writing, the number
76// below is the size of this class on x64 platforms.
77static_assert(sizeof(SectionChunk) <= 88, "SectionChunk grew unexpectedly");
78
79static void add16(uint8_t *p, int16_t v) { write16le(P: p, V: read16le(P: p) + v); }
80static void add32(uint8_t *p, int32_t v) { write32le(P: p, V: read32le(P: p) + v); }
81static void add64(uint8_t *p, int64_t v) { write64le(P: p, V: read64le(P: p) + v); }
82static void or16(uint8_t *p, uint16_t v) { write16le(P: p, V: read16le(P: p) | v); }
83static void or32(uint8_t *p, uint32_t v) { write32le(P: p, V: read32le(P: p) | v); }
84
85// Verify that given sections are appropriate targets for SECREL
86// relocations. This check is relaxed because unfortunately debug
87// sections have section-relative relocations against absolute symbols.
88static bool checkSecRel(const SectionChunk *sec, OutputSection *os) {
89 if (os)
90 return true;
91 if (sec->isCodeView())
92 return false;
93 error(msg: "SECREL relocation cannot be applied to absolute symbols");
94 return false;
95}
96
97static void applySecRel(const SectionChunk *sec, uint8_t *off,
98 OutputSection *os, uint64_t s) {
99 if (!checkSecRel(sec, os))
100 return;
101 uint64_t secRel = s - os->getRVA();
102 if (secRel > UINT32_MAX) {
103 error(msg: "overflow in SECREL relocation in section: " + sec->getSectionName());
104 return;
105 }
106 add32(p: off, v: secRel);
107}
108
109static void applySecIdx(uint8_t *off, OutputSection *os,
110 unsigned numOutputSections) {
111 // numOutputSections is the largest valid section index. Make sure that
112 // it fits in 16 bits.
113 assert(numOutputSections <= 0xffff && "size of outputSections is too big");
114
115 // Absolute symbol doesn't have section index, but section index relocation
116 // against absolute symbol should be resolved to one plus the last output
117 // section index. This is required for compatibility with MSVC.
118 if (os)
119 add16(p: off, v: os->sectionIndex);
120 else
121 add16(p: off, v: numOutputSections + 1);
122}
123
124void SectionChunk::applyRelX64(uint8_t *off, uint16_t type, OutputSection *os,
125 uint64_t s, uint64_t p,
126 uint64_t imageBase) const {
127 switch (type) {
128 case IMAGE_REL_AMD64_ADDR32:
129 add32(p: off, v: s + imageBase);
130 break;
131 case IMAGE_REL_AMD64_ADDR64:
132 add64(p: off, v: s + imageBase);
133 break;
134 case IMAGE_REL_AMD64_ADDR32NB: add32(p: off, v: s); break;
135 case IMAGE_REL_AMD64_REL32: add32(p: off, v: s - p - 4); break;
136 case IMAGE_REL_AMD64_REL32_1: add32(p: off, v: s - p - 5); break;
137 case IMAGE_REL_AMD64_REL32_2: add32(p: off, v: s - p - 6); break;
138 case IMAGE_REL_AMD64_REL32_3: add32(p: off, v: s - p - 7); break;
139 case IMAGE_REL_AMD64_REL32_4: add32(p: off, v: s - p - 8); break;
140 case IMAGE_REL_AMD64_REL32_5: add32(p: off, v: s - p - 9); break;
141 case IMAGE_REL_AMD64_SECTION:
142 applySecIdx(off, os, numOutputSections: file->symtab.ctx.outputSections.size());
143 break;
144 case IMAGE_REL_AMD64_SECREL: applySecRel(sec: this, off, os, s); break;
145 default:
146 error(msg: "unsupported relocation type 0x" + Twine::utohexstr(Val: type) + " in " +
147 toString(file));
148 }
149}
150
151void SectionChunk::applyRelX86(uint8_t *off, uint16_t type, OutputSection *os,
152 uint64_t s, uint64_t p,
153 uint64_t imageBase) const {
154 switch (type) {
155 case IMAGE_REL_I386_ABSOLUTE: break;
156 case IMAGE_REL_I386_DIR32:
157 add32(p: off, v: s + imageBase);
158 break;
159 case IMAGE_REL_I386_DIR32NB: add32(p: off, v: s); break;
160 case IMAGE_REL_I386_REL32: add32(p: off, v: s - p - 4); break;
161 case IMAGE_REL_I386_SECTION:
162 applySecIdx(off, os, numOutputSections: file->symtab.ctx.outputSections.size());
163 break;
164 case IMAGE_REL_I386_SECREL: applySecRel(sec: this, off, os, s); break;
165 default:
166 error(msg: "unsupported relocation type 0x" + Twine::utohexstr(Val: type) + " in " +
167 toString(file));
168 }
169}
170
171static void applyMOV(uint8_t *off, uint16_t v) {
172 write16le(P: off, V: (read16le(P: off) & 0xfbf0) | ((v & 0x800) >> 1) | ((v >> 12) & 0xf));
173 write16le(P: off + 2, V: (read16le(P: off + 2) & 0x8f00) | ((v & 0x700) << 4) | (v & 0xff));
174}
175
176static uint16_t readMOV(uint8_t *off, bool movt) {
177 uint16_t op1 = read16le(P: off);
178 if ((op1 & 0xfbf0) != (movt ? 0xf2c0 : 0xf240))
179 error(msg: "unexpected instruction in " + Twine(movt ? "MOVT" : "MOVW") +
180 " instruction in MOV32T relocation");
181 uint16_t op2 = read16le(P: off + 2);
182 if ((op2 & 0x8000) != 0)
183 error(msg: "unexpected instruction in " + Twine(movt ? "MOVT" : "MOVW") +
184 " instruction in MOV32T relocation");
185 return (op2 & 0x00ff) | ((op2 >> 4) & 0x0700) | ((op1 << 1) & 0x0800) |
186 ((op1 & 0x000f) << 12);
187}
188
189void applyMOV32T(uint8_t *off, uint32_t v) {
190 uint16_t immW = readMOV(off, movt: false); // read MOVW operand
191 uint16_t immT = readMOV(off: off + 4, movt: true); // read MOVT operand
192 uint32_t imm = immW | (immT << 16);
193 v += imm; // add the immediate offset
194 applyMOV(off, v); // set MOVW operand
195 applyMOV(off: off + 4, v: v >> 16); // set MOVT operand
196}
197
198static void applyBranch20T(uint8_t *off, int32_t v) {
199 if (!isInt<21>(x: v))
200 error(msg: "relocation out of range");
201 uint32_t s = v < 0 ? 1 : 0;
202 uint32_t j1 = (v >> 19) & 1;
203 uint32_t j2 = (v >> 18) & 1;
204 or16(p: off, v: (s << 10) | ((v >> 12) & 0x3f));
205 or16(p: off + 2, v: (j1 << 13) | (j2 << 11) | ((v >> 1) & 0x7ff));
206}
207
208void applyBranch24T(uint8_t *off, int32_t v) {
209 if (!isInt<25>(x: v))
210 error(msg: "relocation out of range");
211 uint32_t s = v < 0 ? 1 : 0;
212 uint32_t j1 = ((~v >> 23) & 1) ^ s;
213 uint32_t j2 = ((~v >> 22) & 1) ^ s;
214 or16(p: off, v: (s << 10) | ((v >> 12) & 0x3ff));
215 // Clear out the J1 and J2 bits which may be set.
216 write16le(P: off + 2, V: (read16le(P: off + 2) & 0xd000) | (j1 << 13) | (j2 << 11) | ((v >> 1) & 0x7ff));
217}
218
219void SectionChunk::applyRelARM(uint8_t *off, uint16_t type, OutputSection *os,
220 uint64_t s, uint64_t p,
221 uint64_t imageBase) const {
222 // Pointer to thumb code must have the LSB set.
223 uint64_t sx = s;
224 if (os && (os->header.Characteristics & IMAGE_SCN_MEM_EXECUTE))
225 sx |= 1;
226 switch (type) {
227 case IMAGE_REL_ARM_ADDR32:
228 add32(p: off, v: sx + imageBase);
229 break;
230 case IMAGE_REL_ARM_ADDR32NB: add32(p: off, v: sx); break;
231 case IMAGE_REL_ARM_MOV32T:
232 applyMOV32T(off, v: sx + imageBase);
233 break;
234 case IMAGE_REL_ARM_BRANCH20T: applyBranch20T(off, v: sx - p - 4); break;
235 case IMAGE_REL_ARM_BRANCH24T: applyBranch24T(off, v: sx - p - 4); break;
236 case IMAGE_REL_ARM_BLX23T: applyBranch24T(off, v: sx - p - 4); break;
237 case IMAGE_REL_ARM_SECTION:
238 applySecIdx(off, os, numOutputSections: file->symtab.ctx.outputSections.size());
239 break;
240 case IMAGE_REL_ARM_SECREL: applySecRel(sec: this, off, os, s); break;
241 case IMAGE_REL_ARM_REL32: add32(p: off, v: sx - p - 4); break;
242 default:
243 error(msg: "unsupported relocation type 0x" + Twine::utohexstr(Val: type) + " in " +
244 toString(file));
245 }
246}
247
248// Interpret the existing immediate value as a byte offset to the
249// target symbol, then update the instruction with the immediate as
250// the page offset from the current instruction to the target.
251void applyArm64Addr(uint8_t *off, uint64_t s, uint64_t p, int shift) {
252 uint32_t orig = read32le(P: off);
253 int64_t imm =
254 SignExtend64<21>(x: ((orig >> 29) & 0x3) | ((orig >> 3) & 0x1FFFFC));
255 s += imm;
256 imm = (s >> shift) - (p >> shift);
257 uint32_t immLo = (imm & 0x3) << 29;
258 uint32_t immHi = (imm & 0x1FFFFC) << 3;
259 uint64_t mask = (0x3 << 29) | (0x1FFFFC << 3);
260 write32le(P: off, V: (orig & ~mask) | immLo | immHi);
261}
262
263// Update the immediate field in a AARCH64 ldr, str, and add instruction.
264// Optionally limit the range of the written immediate by one or more bits
265// (rangeLimit).
266void applyArm64Imm(uint8_t *off, uint64_t imm, uint32_t rangeLimit) {
267 uint32_t orig = read32le(P: off);
268 imm += (orig >> 10) & 0xFFF;
269 orig &= ~(0xFFF << 10);
270 write32le(P: off, V: orig | ((imm & (0xFFF >> rangeLimit)) << 10));
271}
272
273// Add the 12 bit page offset to the existing immediate.
274// Ldr/str instructions store the opcode immediate scaled
275// by the load/store size (giving a larger range for larger
276// loads/stores). The immediate is always (both before and after
277// fixing up the relocation) stored scaled similarly.
278// Even if larger loads/stores have a larger range, limit the
279// effective offset to 12 bit, since it is intended to be a
280// page offset.
281static void applyArm64Ldr(uint8_t *off, uint64_t imm) {
282 uint32_t orig = read32le(P: off);
283 uint32_t size = orig >> 30;
284 // 0x04000000 indicates SIMD/FP registers
285 // 0x00800000 indicates 128 bit
286 if ((orig & 0x4800000) == 0x4800000)
287 size += 4;
288 if ((imm & ((1 << size) - 1)) != 0)
289 error(msg: "misaligned ldr/str offset");
290 applyArm64Imm(off, imm: imm >> size, rangeLimit: size);
291}
292
293static void applySecRelLow12A(const SectionChunk *sec, uint8_t *off,
294 OutputSection *os, uint64_t s) {
295 if (checkSecRel(sec, os))
296 applyArm64Imm(off, imm: (s - os->getRVA()) & 0xfff, rangeLimit: 0);
297}
298
299static void applySecRelHigh12A(const SectionChunk *sec, uint8_t *off,
300 OutputSection *os, uint64_t s) {
301 if (!checkSecRel(sec, os))
302 return;
303 uint32_t orig = read32le(P: off);
304 uint64_t imm = (orig >> 10) & 0xFFF;
305 orig &= ~(0xFFF << 10);
306 imm = (s + imm - os->getRVA()) >> 12;
307 if (0xfff < imm) {
308 error(msg: "overflow in SECREL_HIGH12A relocation in section: " +
309 sec->getSectionName());
310 return;
311 }
312 write32le(P: off, V: orig | (imm << 10));
313}
314
315static void applySecRelLdr(const SectionChunk *sec, uint8_t *off,
316 OutputSection *os, uint64_t s) {
317 if (checkSecRel(sec, os))
318 applyArm64Ldr(off, imm: (s - os->getRVA()) & 0xfff);
319}
320
321void applyArm64Branch26(uint8_t *off, int64_t v) {
322 if (!isInt<28>(x: v))
323 error(msg: "relocation out of range");
324 or32(p: off, v: (v & 0x0FFFFFFC) >> 2);
325}
326
327static void applyArm64Branch19(uint8_t *off, int64_t v) {
328 if (!isInt<21>(x: v))
329 error(msg: "relocation out of range");
330 or32(p: off, v: (v & 0x001FFFFC) << 3);
331}
332
333static void applyArm64Branch14(uint8_t *off, int64_t v) {
334 if (!isInt<16>(x: v))
335 error(msg: "relocation out of range");
336 or32(p: off, v: (v & 0x0000FFFC) << 3);
337}
338
339void SectionChunk::applyRelARM64(uint8_t *off, uint16_t type, OutputSection *os,
340 uint64_t s, uint64_t p,
341 uint64_t imageBase) const {
342 switch (type) {
343 case IMAGE_REL_ARM64_PAGEBASE_REL21: applyArm64Addr(off, s, p, shift: 12); break;
344 case IMAGE_REL_ARM64_REL21: applyArm64Addr(off, s, p, shift: 0); break;
345 case IMAGE_REL_ARM64_PAGEOFFSET_12A: applyArm64Imm(off, imm: s & 0xfff, rangeLimit: 0); break;
346 case IMAGE_REL_ARM64_PAGEOFFSET_12L: applyArm64Ldr(off, imm: s & 0xfff); break;
347 case IMAGE_REL_ARM64_BRANCH26: applyArm64Branch26(off, v: s - p); break;
348 case IMAGE_REL_ARM64_BRANCH19: applyArm64Branch19(off, v: s - p); break;
349 case IMAGE_REL_ARM64_BRANCH14: applyArm64Branch14(off, v: s - p); break;
350 case IMAGE_REL_ARM64_ADDR32:
351 add32(p: off, v: s + imageBase);
352 break;
353 case IMAGE_REL_ARM64_ADDR32NB: add32(p: off, v: s); break;
354 case IMAGE_REL_ARM64_ADDR64:
355 add64(p: off, v: s + imageBase);
356 break;
357 case IMAGE_REL_ARM64_SECREL: applySecRel(sec: this, off, os, s); break;
358 case IMAGE_REL_ARM64_SECREL_LOW12A: applySecRelLow12A(sec: this, off, os, s); break;
359 case IMAGE_REL_ARM64_SECREL_HIGH12A: applySecRelHigh12A(sec: this, off, os, s); break;
360 case IMAGE_REL_ARM64_SECREL_LOW12L: applySecRelLdr(sec: this, off, os, s); break;
361 case IMAGE_REL_ARM64_SECTION:
362 applySecIdx(off, os, numOutputSections: file->symtab.ctx.outputSections.size());
363 break;
364 case IMAGE_REL_ARM64_REL32: add32(p: off, v: s - p - 4); break;
365 default:
366 error(msg: "unsupported relocation type 0x" + Twine::utohexstr(Val: type) + " in " +
367 toString(file));
368 }
369}
370
371static void maybeReportRelocationToDiscarded(const SectionChunk *fromChunk,
372 Defined *sym,
373 const coff_relocation &rel,
374 bool isMinGW) {
375 // Don't report these errors when the relocation comes from a debug info
376 // section or in mingw mode. MinGW mode object files (built by GCC) can
377 // have leftover sections with relocations against discarded comdat
378 // sections. Such sections are left as is, with relocations untouched.
379 if (fromChunk->isCodeView() || fromChunk->isDWARF() || isMinGW)
380 return;
381
382 // Get the name of the symbol. If it's null, it was discarded early, so we
383 // have to go back to the object file.
384 ObjFile *file = fromChunk->file;
385 std::string name;
386 if (sym) {
387 name = toString(ctx: file->symtab.ctx, b&: *sym);
388 } else {
389 COFFSymbolRef coffSym =
390 check(e: file->getCOFFObj()->getSymbol(index: rel.SymbolTableIndex));
391 name = maybeDemangleSymbol(
392 ctx: file->symtab.ctx, symName: check(e: file->getCOFFObj()->getSymbolName(Symbol: coffSym)));
393 }
394
395 std::vector<std::string> symbolLocations =
396 getSymbolLocations(file, symIndex: rel.SymbolTableIndex);
397
398 std::string out;
399 llvm::raw_string_ostream os(out);
400 os << "relocation against symbol in discarded section: " + name;
401 for (const std::string &s : symbolLocations)
402 os << s;
403 error(msg: out);
404}
405
406void SectionChunk::writeTo(uint8_t *buf) const {
407 if (!hasData)
408 return;
409 // Copy section contents from source object file to output file.
410 ArrayRef<uint8_t> a = getContents();
411 if (!a.empty())
412 memcpy(dest: buf, src: a.data(), n: a.size());
413
414 // Apply relocations.
415 size_t inputSize = getSize();
416 for (const coff_relocation &rel : getRelocs()) {
417 // Check for an invalid relocation offset. This check isn't perfect, because
418 // we don't have the relocation size, which is only known after checking the
419 // machine and relocation type. As a result, a relocation may overwrite the
420 // beginning of the following input section.
421 if (rel.VirtualAddress >= inputSize) {
422 error(msg: "relocation points beyond the end of its parent section");
423 continue;
424 }
425
426 applyRelocation(off: buf + rel.VirtualAddress, rel);
427 }
428}
429
430void SectionChunk::applyRelocation(uint8_t *off,
431 const coff_relocation &rel) const {
432 auto *sym = dyn_cast_or_null<Defined>(Val: file->getSymbol(symbolIndex: rel.SymbolTableIndex));
433
434 // Get the output section of the symbol for this relocation. The output
435 // section is needed to compute SECREL and SECTION relocations used in debug
436 // info.
437 Chunk *c = sym ? sym->getChunk() : nullptr;
438 COFFLinkerContext &ctx = file->symtab.ctx;
439 OutputSection *os = c ? ctx.getOutputSection(c) : nullptr;
440
441 // Skip the relocation if it refers to a discarded section, and diagnose it
442 // as an error if appropriate. If a symbol was discarded early, it may be
443 // null. If it was discarded late, the output section will be null, unless
444 // it was an absolute or synthetic symbol.
445 if (!sym ||
446 (!os && !isa<DefinedAbsolute>(Val: sym) && !isa<DefinedSynthetic>(Val: sym))) {
447 maybeReportRelocationToDiscarded(fromChunk: this, sym, rel, isMinGW: ctx.config.mingw);
448 return;
449 }
450
451 uint64_t s = sym->getRVA();
452
453 // Compute the RVA of the relocation for relative relocations.
454 uint64_t p = rva + rel.VirtualAddress;
455 uint64_t imageBase = ctx.config.imageBase;
456 switch (getArch()) {
457 case Triple::x86_64:
458 applyRelX64(off, type: rel.Type, os, s, p, imageBase);
459 break;
460 case Triple::x86:
461 applyRelX86(off, type: rel.Type, os, s, p, imageBase);
462 break;
463 case Triple::thumb:
464 applyRelARM(off, type: rel.Type, os, s, p, imageBase);
465 break;
466 case Triple::aarch64:
467 applyRelARM64(off, type: rel.Type, os, s, p, imageBase);
468 break;
469 default:
470 llvm_unreachable("unknown machine type");
471 }
472}
473
474// Defend against unsorted relocations. This may be overly conservative.
475void SectionChunk::sortRelocations() {
476 auto cmpByVa = [](const coff_relocation &l, const coff_relocation &r) {
477 return l.VirtualAddress < r.VirtualAddress;
478 };
479 if (llvm::is_sorted(Range: getRelocs(), C: cmpByVa))
480 return;
481 warn(msg: "some relocations in " + file->getName() + " are not sorted");
482 MutableArrayRef<coff_relocation> newRelocs(
483 bAlloc().Allocate<coff_relocation>(Num: relocsSize), relocsSize);
484 memcpy(dest: newRelocs.data(), src: relocsData, n: relocsSize * sizeof(coff_relocation));
485 llvm::sort(C&: newRelocs, Comp: cmpByVa);
486 setRelocs(newRelocs);
487}
488
489// Similar to writeTo, but suitable for relocating a subsection of the overall
490// section.
491void SectionChunk::writeAndRelocateSubsection(ArrayRef<uint8_t> sec,
492 ArrayRef<uint8_t> subsec,
493 uint32_t &nextRelocIndex,
494 uint8_t *buf) const {
495 assert(!subsec.empty() && !sec.empty());
496 assert(sec.begin() <= subsec.begin() && subsec.end() <= sec.end() &&
497 "subsection is not part of this section");
498 size_t vaBegin = std::distance(first: sec.begin(), last: subsec.begin());
499 size_t vaEnd = std::distance(first: sec.begin(), last: subsec.end());
500 memcpy(dest: buf, src: subsec.data(), n: subsec.size());
501 for (; nextRelocIndex < relocsSize; ++nextRelocIndex) {
502 const coff_relocation &rel = relocsData[nextRelocIndex];
503 // Only apply relocations that apply to this subsection. These checks
504 // assume that all subsections completely contain their relocations.
505 // Relocations must not straddle the beginning or end of a subsection.
506 if (rel.VirtualAddress < vaBegin)
507 continue;
508 if (rel.VirtualAddress + 1 >= vaEnd)
509 break;
510 applyRelocation(off: &buf[rel.VirtualAddress - vaBegin], rel);
511 }
512}
513
514void SectionChunk::addAssociative(SectionChunk *child) {
515 // Insert the child section into the list of associated children. Keep the
516 // list ordered by section name so that ICF does not depend on section order.
517 assert(child->assocChildren == nullptr &&
518 "associated sections cannot have their own associated children");
519 SectionChunk *prev = this;
520 SectionChunk *next = assocChildren;
521 for (; next != nullptr; prev = next, next = next->assocChildren) {
522 if (next->getSectionName() <= child->getSectionName())
523 break;
524 }
525
526 // Insert child between prev and next.
527 assert(prev->assocChildren == next);
528 prev->assocChildren = child;
529 child->assocChildren = next;
530}
531
532static uint8_t getBaserelType(const coff_relocation &rel,
533 Triple::ArchType arch) {
534 switch (arch) {
535 case Triple::x86_64:
536 if (rel.Type == IMAGE_REL_AMD64_ADDR64)
537 return IMAGE_REL_BASED_DIR64;
538 if (rel.Type == IMAGE_REL_AMD64_ADDR32)
539 return IMAGE_REL_BASED_HIGHLOW;
540 return IMAGE_REL_BASED_ABSOLUTE;
541 case Triple::x86:
542 if (rel.Type == IMAGE_REL_I386_DIR32)
543 return IMAGE_REL_BASED_HIGHLOW;
544 return IMAGE_REL_BASED_ABSOLUTE;
545 case Triple::thumb:
546 if (rel.Type == IMAGE_REL_ARM_ADDR32)
547 return IMAGE_REL_BASED_HIGHLOW;
548 if (rel.Type == IMAGE_REL_ARM_MOV32T)
549 return IMAGE_REL_BASED_ARM_MOV32T;
550 return IMAGE_REL_BASED_ABSOLUTE;
551 case Triple::aarch64:
552 if (rel.Type == IMAGE_REL_ARM64_ADDR64)
553 return IMAGE_REL_BASED_DIR64;
554 return IMAGE_REL_BASED_ABSOLUTE;
555 default:
556 llvm_unreachable("unknown machine type");
557 }
558}
559
560// Windows-specific.
561// Collect all locations that contain absolute addresses, which need to be
562// fixed by the loader if load-time relocation is needed.
563// Only called when base relocation is enabled.
564void SectionChunk::getBaserels(std::vector<Baserel> *res) {
565 for (const coff_relocation &rel : getRelocs()) {
566 uint8_t ty = getBaserelType(rel, arch: getArch());
567 if (ty == IMAGE_REL_BASED_ABSOLUTE)
568 continue;
569 Symbol *target = file->getSymbol(symbolIndex: rel.SymbolTableIndex);
570 if (!isa_and_nonnull<Defined>(Val: target) || isa<DefinedAbsolute>(Val: target))
571 continue;
572 res->emplace_back(args: rva + rel.VirtualAddress, args&: ty);
573 }
574
575 // Insert a 64-bit relocation for CHPEMetadataPointer in the native load
576 // config of a hybrid ARM64X image. Its value will be set in prepareLoadConfig
577 // to match the value in the EC load config, which is expected to be
578 // a relocatable pointer to the __chpe_metadata symbol.
579 COFFLinkerContext &ctx = file->symtab.ctx;
580 if (ctx.config.machine == ARM64X && ctx.hybridSymtab->loadConfigSym &&
581 ctx.hybridSymtab->loadConfigSym->getChunk() == this &&
582 ctx.symtab.loadConfigSym &&
583 ctx.hybridSymtab->loadConfigSize >=
584 offsetof(coff_load_configuration64, CHPEMetadataPointer) +
585 sizeof(coff_load_configuration64::CHPEMetadataPointer))
586 res->emplace_back(
587 args: ctx.hybridSymtab->loadConfigSym->getRVA() +
588 offsetof(coff_load_configuration64, CHPEMetadataPointer),
589 args: IMAGE_REL_BASED_DIR64);
590}
591
592// MinGW specific.
593// Check whether a static relocation of type Type can be deferred and
594// handled at runtime as a pseudo relocation (for references to a module
595// local variable, which turned out to actually need to be imported from
596// another DLL) This returns the size the relocation is supposed to update,
597// in bits, or 0 if the relocation cannot be handled as a runtime pseudo
598// relocation.
599static int getRuntimePseudoRelocSize(uint16_t type, Triple::ArchType arch) {
600 // Relocations that either contain an absolute address, or a plain
601 // relative offset, since the runtime pseudo reloc implementation
602 // adds 8/16/32/64 bit values to a memory address.
603 //
604 // Given a pseudo relocation entry,
605 //
606 // typedef struct {
607 // DWORD sym;
608 // DWORD target;
609 // DWORD flags;
610 // } runtime_pseudo_reloc_item_v2;
611 //
612 // the runtime relocation performs this adjustment:
613 // *(base + .target) += *(base + .sym) - (base + .sym)
614 //
615 // This works for both absolute addresses (IMAGE_REL_*_ADDR32/64,
616 // IMAGE_REL_I386_DIR32, where the memory location initially contains
617 // the address of the IAT slot, and for relative addresses (IMAGE_REL*_REL32),
618 // where the memory location originally contains the relative offset to the
619 // IAT slot.
620 //
621 // This requires the target address to be writable, either directly out of
622 // the image, or temporarily changed at runtime with VirtualProtect.
623 // Since this only operates on direct address values, it doesn't work for
624 // ARM/ARM64 relocations, other than the plain ADDR32/ADDR64 relocations.
625 switch (arch) {
626 case Triple::x86_64:
627 switch (type) {
628 case IMAGE_REL_AMD64_ADDR64:
629 return 64;
630 case IMAGE_REL_AMD64_ADDR32:
631 case IMAGE_REL_AMD64_REL32:
632 case IMAGE_REL_AMD64_REL32_1:
633 case IMAGE_REL_AMD64_REL32_2:
634 case IMAGE_REL_AMD64_REL32_3:
635 case IMAGE_REL_AMD64_REL32_4:
636 case IMAGE_REL_AMD64_REL32_5:
637 return 32;
638 default:
639 return 0;
640 }
641 case Triple::x86:
642 switch (type) {
643 case IMAGE_REL_I386_DIR32:
644 case IMAGE_REL_I386_REL32:
645 return 32;
646 default:
647 return 0;
648 }
649 case Triple::thumb:
650 switch (type) {
651 case IMAGE_REL_ARM_ADDR32:
652 return 32;
653 default:
654 return 0;
655 }
656 case Triple::aarch64:
657 switch (type) {
658 case IMAGE_REL_ARM64_ADDR64:
659 return 64;
660 case IMAGE_REL_ARM64_ADDR32:
661 return 32;
662 default:
663 return 0;
664 }
665 default:
666 llvm_unreachable("unknown machine type");
667 }
668}
669
670// MinGW specific.
671// Append information to the provided vector about all relocations that
672// need to be handled at runtime as runtime pseudo relocations (references
673// to a module local variable, which turned out to actually need to be
674// imported from another DLL).
675void SectionChunk::getRuntimePseudoRelocs(
676 std::vector<RuntimePseudoReloc> &res) {
677 for (const coff_relocation &rel : getRelocs()) {
678 auto *target =
679 dyn_cast_or_null<Defined>(Val: file->getSymbol(symbolIndex: rel.SymbolTableIndex));
680 if (!target || !target->isRuntimePseudoReloc)
681 continue;
682 // If the target doesn't have a chunk allocated, it may be a
683 // DefinedImportData symbol which ended up unnecessary after GC.
684 // Normally we wouldn't eliminate section chunks that are referenced, but
685 // references within DWARF sections don't count for keeping section chunks
686 // alive. Thus such dangling references in DWARF sections are expected.
687 if (!target->getChunk())
688 continue;
689 int sizeInBits = getRuntimePseudoRelocSize(type: rel.Type, arch: getArch());
690 if (sizeInBits == 0) {
691 error(msg: "unable to automatically import from " + target->getName() +
692 " with relocation type " +
693 file->getCOFFObj()->getRelocationTypeName(Type: rel.Type) + " in " +
694 toString(file));
695 continue;
696 }
697 int addressSizeInBits = file->symtab.ctx.config.is64() ? 64 : 32;
698 if (sizeInBits < addressSizeInBits) {
699 warn(msg: "runtime pseudo relocation in " + toString(file) + " against " +
700 "symbol " + target->getName() + " is too narrow (only " +
701 Twine(sizeInBits) + " bits wide); this can fail at runtime " +
702 "depending on memory layout");
703 }
704 // sizeInBits is used to initialize the Flags field; currently no
705 // other flags are defined.
706 res.emplace_back(args&: target, args: this, args: rel.VirtualAddress, args&: sizeInBits);
707 }
708}
709
710bool SectionChunk::isCOMDAT() const {
711 return header->Characteristics & IMAGE_SCN_LNK_COMDAT;
712}
713
714void SectionChunk::printDiscardedMessage() const {
715 // Removed by dead-stripping. If it's removed by ICF, ICF already
716 // printed out the name, so don't repeat that here.
717 if (sym && this == repl)
718 log(msg: "Discarded " + sym->getName());
719}
720
721StringRef SectionChunk::getDebugName() const {
722 if (sym)
723 return sym->getName();
724 return "";
725}
726
727ArrayRef<uint8_t> SectionChunk::getContents() const {
728 ArrayRef<uint8_t> a;
729 cantFail(Err: file->getCOFFObj()->getSectionContents(Sec: header, Res&: a));
730 return a;
731}
732
733ArrayRef<uint8_t> SectionChunk::consumeDebugMagic() {
734 assert(isCodeView());
735 return consumeDebugMagic(data: getContents(), sectionName: getSectionName());
736}
737
738ArrayRef<uint8_t> SectionChunk::consumeDebugMagic(ArrayRef<uint8_t> data,
739 StringRef sectionName) {
740 if (data.empty())
741 return {};
742
743 // First 4 bytes are section magic.
744 if (data.size() < 4)
745 fatal(msg: "the section is too short: " + sectionName);
746
747 if (!sectionName.starts_with(Prefix: ".debug$"))
748 fatal(msg: "invalid section: " + sectionName);
749
750 uint32_t magic = support::endian::read32le(P: data.data());
751 uint32_t expectedMagic = sectionName == ".debug$H"
752 ? DEBUG_HASHES_SECTION_MAGIC
753 : DEBUG_SECTION_MAGIC;
754 if (magic != expectedMagic) {
755 warn(msg: "ignoring section " + sectionName + " with unrecognized magic 0x" +
756 utohexstr(X: magic));
757 return {};
758 }
759 return data.slice(N: 4);
760}
761
762SectionChunk *SectionChunk::findByName(ArrayRef<SectionChunk *> sections,
763 StringRef name) {
764 for (SectionChunk *c : sections)
765 if (c->getSectionName() == name)
766 return c;
767 return nullptr;
768}
769
770void SectionChunk::replace(SectionChunk *other) {
771 p2Align = std::max(a: p2Align, b: other->p2Align);
772 other->repl = repl;
773 other->live = false;
774}
775
776uint32_t SectionChunk::getSectionNumber() const {
777 DataRefImpl r;
778 r.p = reinterpret_cast<uintptr_t>(header);
779 SectionRef s(r, file->getCOFFObj());
780 return s.getIndex() + 1;
781}
782
783CommonChunk::CommonChunk(const COFFSymbolRef s) : live(false), sym(s) {
784 // The value of a common symbol is its size. Align all common symbols smaller
785 // than 32 bytes naturally, i.e. round the size up to the next power of two.
786 // This is what MSVC link.exe does.
787 setAlignment(std::min(a: 32U, b: uint32_t(PowerOf2Ceil(A: sym.getValue()))));
788 hasData = false;
789}
790
791uint32_t CommonChunk::getOutputCharacteristics() const {
792 return IMAGE_SCN_CNT_UNINITIALIZED_DATA | IMAGE_SCN_MEM_READ |
793 IMAGE_SCN_MEM_WRITE;
794}
795
796void StringChunk::writeTo(uint8_t *buf) const {
797 memcpy(dest: buf, src: str.data(), n: str.size());
798 buf[str.size()] = '\0';
799}
800
801ImportThunkChunk::ImportThunkChunk(COFFLinkerContext &ctx, Defined *s)
802 : NonSectionCodeChunk(ImportThunkKind), live(!ctx.config.doGC),
803 impSymbol(s), ctx(ctx) {}
804
805ImportThunkChunkX64::ImportThunkChunkX64(COFFLinkerContext &ctx, Defined *s)
806 : ImportThunkChunk(ctx, s) {
807 // Intel Optimization Manual says that all branch targets
808 // should be 16-byte aligned. MSVC linker does this too.
809 setAlignment(16);
810}
811
812void ImportThunkChunkX64::writeTo(uint8_t *buf) const {
813 memcpy(dest: buf, src: importThunkX86, n: sizeof(importThunkX86));
814 // The first two bytes is a JMP instruction. Fill its operand.
815 write32le(P: buf + 2, V: impSymbol->getRVA() - rva - getSize());
816}
817
818void ImportThunkChunkX86::getBaserels(std::vector<Baserel> *res) {
819 res->emplace_back(args: getRVA() + 2, args&: ctx.config.machine);
820}
821
822void ImportThunkChunkX86::writeTo(uint8_t *buf) const {
823 memcpy(dest: buf, src: importThunkX86, n: sizeof(importThunkX86));
824 // The first two bytes is a JMP instruction. Fill its operand.
825 write32le(P: buf + 2, V: impSymbol->getRVA() + ctx.config.imageBase);
826}
827
828void ImportThunkChunkARM::getBaserels(std::vector<Baserel> *res) {
829 res->emplace_back(args: getRVA(), args: IMAGE_REL_BASED_ARM_MOV32T);
830}
831
832void ImportThunkChunkARM::writeTo(uint8_t *buf) const {
833 memcpy(dest: buf, src: importThunkARM, n: sizeof(importThunkARM));
834 // Fix mov.w and mov.t operands.
835 applyMOV32T(off: buf, v: impSymbol->getRVA() + ctx.config.imageBase);
836}
837
838void ImportThunkChunkARM64::writeTo(uint8_t *buf) const {
839 int64_t off = impSymbol->getRVA() & 0xfff;
840 memcpy(dest: buf, src: importThunkARM64, n: sizeof(importThunkARM64));
841 applyArm64Addr(off: buf, s: impSymbol->getRVA(), p: rva, shift: 12);
842 applyArm64Ldr(off: buf + 4, imm: off);
843}
844
845// A Thumb2, PIC, non-interworking range extension thunk.
846const uint8_t armThunk[] = {
847 0x40, 0xf2, 0x00, 0x0c, // P: movw ip,:lower16:S - (P + (L1-P) + 4)
848 0xc0, 0xf2, 0x00, 0x0c, // movt ip,:upper16:S - (P + (L1-P) + 4)
849 0xe7, 0x44, // L1: add pc, ip
850};
851
852size_t RangeExtensionThunkARM::getSize() const {
853 assert(ctx.config.machine == ARMNT);
854 (void)&ctx;
855 return sizeof(armThunk);
856}
857
858void RangeExtensionThunkARM::writeTo(uint8_t *buf) const {
859 assert(ctx.config.machine == ARMNT);
860 uint64_t offset = target->getRVA() - rva - 12;
861 memcpy(dest: buf, src: armThunk, n: sizeof(armThunk));
862 applyMOV32T(off: buf, v: uint32_t(offset));
863}
864
865// A position independent ARM64 adrp+add thunk, with a maximum range of
866// +/- 4 GB, which is enough for any PE-COFF.
867const uint8_t arm64Thunk[] = {
868 0x10, 0x00, 0x00, 0x90, // adrp x16, Dest
869 0x10, 0x02, 0x00, 0x91, // add x16, x16, :lo12:Dest
870 0x00, 0x02, 0x1f, 0xd6, // br x16
871};
872
873size_t RangeExtensionThunkARM64::getSize() const { return sizeof(arm64Thunk); }
874
875void RangeExtensionThunkARM64::writeTo(uint8_t *buf) const {
876 memcpy(dest: buf, src: arm64Thunk, n: sizeof(arm64Thunk));
877 applyArm64Addr(off: buf + 0, s: target->getRVA(), p: rva, shift: 12);
878 applyArm64Imm(off: buf + 4, imm: target->getRVA() & 0xfff, rangeLimit: 0);
879}
880
881void SameAddressThunkARM64EC::setDynamicRelocs(COFFLinkerContext &ctx) const {
882 // Add ARM64X relocations replacing adrp/add instructions with a version using
883 // the hybrid target.
884 RangeExtensionThunkARM64 hybridView(ARM64EC, hybridTarget);
885 uint8_t buf[sizeof(arm64Thunk)];
886 hybridView.setRVA(rva);
887 hybridView.writeTo(buf);
888 uint32_t addrp = *reinterpret_cast<ulittle32_t *>(buf);
889 uint32_t add = *reinterpret_cast<ulittle32_t *>(buf + sizeof(uint32_t));
890 ctx.dynamicRelocs->set(offset: this, value: addrp);
891 ctx.dynamicRelocs->set(offset: Arm64XRelocVal(this, sizeof(uint32_t)), value: add);
892}
893
894LocalImportChunk::LocalImportChunk(COFFLinkerContext &c, Defined *s)
895 : sym(s), ctx(c) {
896 setAlignment(ctx.config.wordsize);
897}
898
899void LocalImportChunk::getBaserels(std::vector<Baserel> *res) {
900 res->emplace_back(args: getRVA(), args&: ctx.config.machine);
901}
902
903size_t LocalImportChunk::getSize() const { return ctx.config.wordsize; }
904
905void LocalImportChunk::writeTo(uint8_t *buf) const {
906 if (ctx.config.is64()) {
907 write64le(P: buf, V: sym->getRVA() + ctx.config.imageBase);
908 } else {
909 write32le(P: buf, V: sym->getRVA() + ctx.config.imageBase);
910 }
911}
912
913void RVATableChunk::writeTo(uint8_t *buf) const {
914 ulittle32_t *begin = reinterpret_cast<ulittle32_t *>(buf);
915 size_t cnt = 0;
916 for (const ChunkAndOffset &co : syms)
917 begin[cnt++] = co.inputChunk->getRVA() + co.offset;
918 llvm::sort(Start: begin, End: begin + cnt);
919 assert(std::unique(begin, begin + cnt) == begin + cnt &&
920 "RVA tables should be de-duplicated");
921}
922
923void RVAFlagTableChunk::writeTo(uint8_t *buf) const {
924 struct RVAFlag {
925 ulittle32_t rva;
926 uint8_t flag;
927 };
928 auto flags =
929 MutableArrayRef(reinterpret_cast<RVAFlag *>(buf), syms.size());
930 for (auto t : zip(t: syms, u&: flags)) {
931 const auto &sym = std::get<0>(t&: t);
932 auto &flag = std::get<1>(t&: t);
933 flag.rva = sym.inputChunk->getRVA() + sym.offset;
934 flag.flag = 0;
935 }
936 llvm::sort(C&: flags,
937 Comp: [](const RVAFlag &a, const RVAFlag &b) { return a.rva < b.rva; });
938 assert(llvm::unique(flags, [](const RVAFlag &a,
939 const RVAFlag &b) { return a.rva == b.rva; }) ==
940 flags.end() &&
941 "RVA tables should be de-duplicated");
942}
943
944size_t ECCodeMapChunk::getSize() const {
945 return map.size() * sizeof(chpe_range_entry);
946}
947
948void ECCodeMapChunk::writeTo(uint8_t *buf) const {
949 auto table = reinterpret_cast<chpe_range_entry *>(buf);
950 for (uint32_t i = 0; i < map.size(); i++) {
951 const ECCodeMapEntry &entry = map[i];
952 uint32_t start = entry.first->getRVA() & ~0xfff;
953 table[i].StartOffset = start | entry.type;
954 table[i].Length = entry.last->getRVA() + entry.last->getSize() - start;
955 }
956}
957
958// MinGW specific, for the "automatic import of variables from DLLs" feature.
959size_t PseudoRelocTableChunk::getSize() const {
960 if (relocs.empty())
961 return 0;
962 return 12 + 12 * relocs.size();
963}
964
965// MinGW specific.
966void PseudoRelocTableChunk::writeTo(uint8_t *buf) const {
967 if (relocs.empty())
968 return;
969
970 ulittle32_t *table = reinterpret_cast<ulittle32_t *>(buf);
971 // This is the list header, to signal the runtime pseudo relocation v2
972 // format.
973 table[0] = 0;
974 table[1] = 0;
975 table[2] = 1;
976
977 size_t idx = 3;
978 for (const RuntimePseudoReloc &rpr : relocs) {
979 table[idx + 0] = rpr.sym->getRVA();
980 table[idx + 1] = rpr.target->getRVA() + rpr.targetOffset;
981 table[idx + 2] = rpr.flags;
982 idx += 3;
983 }
984}
985
986// Windows-specific. This class represents a block in .reloc section.
987// The format is described here.
988//
989// On Windows, each DLL is linked against a fixed base address and
990// usually loaded to that address. However, if there's already another
991// DLL that overlaps, the loader has to relocate it. To do that, DLLs
992// contain .reloc sections which contain offsets that need to be fixed
993// up at runtime. If the loader finds that a DLL cannot be loaded to its
994// desired base address, it loads it to somewhere else, and add <actual
995// base address> - <desired base address> to each offset that is
996// specified by the .reloc section. In ELF terms, .reloc sections
997// contain relative relocations in REL format (as opposed to RELA.)
998//
999// This already significantly reduces the size of relocations compared
1000// to ELF .rel.dyn, but Windows does more to reduce it (probably because
1001// it was invented for PCs in the late '80s or early '90s.) Offsets in
1002// .reloc are grouped by page where the page size is 12 bits, and
1003// offsets sharing the same page address are stored consecutively to
1004// represent them with less space. This is very similar to the page
1005// table which is grouped by (multiple stages of) pages.
1006//
1007// For example, let's say we have 0x00030, 0x00500, 0x00700, 0x00A00,
1008// 0x20004, and 0x20008 in a .reloc section for x64. The uppermost 4
1009// bits have a type IMAGE_REL_BASED_DIR64 or 0xA. In the section, they
1010// are represented like this:
1011//
1012// 0x00000 -- page address (4 bytes)
1013// 16 -- size of this block (4 bytes)
1014// 0xA030 -- entries (2 bytes each)
1015// 0xA500
1016// 0xA700
1017// 0xAA00
1018// 0x20000 -- page address (4 bytes)
1019// 12 -- size of this block (4 bytes)
1020// 0xA004 -- entries (2 bytes each)
1021// 0xA008
1022//
1023// Usually we have a lot of relocations for each page, so the number of
1024// bytes for one .reloc entry is close to 2 bytes on average.
1025BaserelChunk::BaserelChunk(uint32_t page, Baserel *begin, Baserel *end) {
1026 // Block header consists of 4 byte page RVA and 4 byte block size.
1027 // Each entry is 2 byte. Last entry may be padding.
1028 data.resize(new_size: alignTo(Value: (end - begin) * 2 + 8, Align: 4));
1029 uint8_t *p = data.data();
1030 write32le(P: p, V: page);
1031 write32le(P: p + 4, V: data.size());
1032 p += 8;
1033 for (Baserel *i = begin; i != end; ++i) {
1034 write16le(P: p, V: (i->type << 12) | (i->rva - page));
1035 p += 2;
1036 }
1037}
1038
1039void BaserelChunk::writeTo(uint8_t *buf) const {
1040 memcpy(dest: buf, src: data.data(), n: data.size());
1041}
1042
1043uint8_t Baserel::getDefaultType(llvm::COFF::MachineTypes machine) {
1044 return is64Bit(Machine: machine) ? IMAGE_REL_BASED_DIR64 : IMAGE_REL_BASED_HIGHLOW;
1045}
1046
1047MergeChunk::MergeChunk(uint32_t alignment)
1048 : builder(StringTableBuilder::RAW, llvm::Align(alignment)) {
1049 setAlignment(alignment);
1050}
1051
1052void MergeChunk::addSection(COFFLinkerContext &ctx, SectionChunk *c) {
1053 assert(isPowerOf2_32(c->getAlignment()));
1054 uint8_t p2Align = llvm::Log2_32(Value: c->getAlignment());
1055 assert(p2Align < std::size(ctx.mergeChunkInstances));
1056 auto *&mc = ctx.mergeChunkInstances[p2Align];
1057 if (!mc)
1058 mc = make<MergeChunk>(args: c->getAlignment());
1059 mc->sections.push_back(x: c);
1060}
1061
1062void MergeChunk::finalizeContents() {
1063 assert(!finalized && "should only finalize once");
1064 for (SectionChunk *c : sections)
1065 if (c->live)
1066 builder.add(S: toStringRef(Input: c->getContents()));
1067 builder.finalize();
1068 finalized = true;
1069}
1070
1071void MergeChunk::assignSubsectionRVAs() {
1072 for (SectionChunk *c : sections) {
1073 if (!c->live)
1074 continue;
1075 size_t off = builder.getOffset(S: toStringRef(Input: c->getContents()));
1076 c->setRVA(rva + off);
1077 }
1078}
1079
1080uint32_t MergeChunk::getOutputCharacteristics() const {
1081 return IMAGE_SCN_MEM_READ | IMAGE_SCN_CNT_INITIALIZED_DATA;
1082}
1083
1084size_t MergeChunk::getSize() const {
1085 return builder.getSize();
1086}
1087
1088void MergeChunk::writeTo(uint8_t *buf) const {
1089 builder.write(Buf: buf);
1090}
1091
1092// MinGW specific.
1093size_t AbsolutePointerChunk::getSize() const {
1094 return symtab.ctx.config.wordsize;
1095}
1096
1097void AbsolutePointerChunk::writeTo(uint8_t *buf) const {
1098 if (symtab.ctx.config.is64()) {
1099 write64le(P: buf, V: value);
1100 } else {
1101 write32le(P: buf, V: value);
1102 }
1103}
1104
1105MachineTypes AbsolutePointerChunk::getMachine() const { return symtab.machine; }
1106
1107void ECExportThunkChunk::writeTo(uint8_t *buf) const {
1108 memcpy(dest: buf, src: ECExportThunkCode, n: sizeof(ECExportThunkCode));
1109 write32le(P: buf + 10, V: target->getRVA() - rva - 14);
1110}
1111
1112size_t CHPECodeRangesChunk::getSize() const {
1113 return exportThunks.size() * sizeof(chpe_code_range_entry);
1114}
1115
1116void CHPECodeRangesChunk::writeTo(uint8_t *buf) const {
1117 auto ranges = reinterpret_cast<chpe_code_range_entry *>(buf);
1118
1119 for (uint32_t i = 0; i < exportThunks.size(); i++) {
1120 Chunk *thunk = exportThunks[i].first;
1121 uint32_t start = thunk->getRVA();
1122 ranges[i].StartRva = start;
1123 ranges[i].EndRva = start + thunk->getSize();
1124 ranges[i].EntryPoint = start;
1125 }
1126}
1127
1128size_t CHPERedirectionChunk::getSize() const {
1129 // Add an extra +1 for a terminator entry.
1130 return (exportThunks.size() + 1) * sizeof(chpe_redirection_entry);
1131}
1132
1133void CHPERedirectionChunk::writeTo(uint8_t *buf) const {
1134 auto entries = reinterpret_cast<chpe_redirection_entry *>(buf);
1135
1136 for (uint32_t i = 0; i < exportThunks.size(); i++) {
1137 entries[i].Source = exportThunks[i].first->getRVA();
1138 entries[i].Destination = exportThunks[i].second->getRVA();
1139 }
1140}
1141
1142ImportThunkChunkARM64EC::ImportThunkChunkARM64EC(ImportFile *file)
1143 : ImportThunkChunk(file->symtab.ctx, file->impSym), file(file) {}
1144
1145size_t ImportThunkChunkARM64EC::getSize() const {
1146 if (!extended)
1147 return sizeof(importThunkARM64EC);
1148 // The last instruction is replaced with an inline range extension thunk.
1149 return sizeof(importThunkARM64EC) + sizeof(arm64Thunk) - sizeof(uint32_t);
1150}
1151
1152void ImportThunkChunkARM64EC::writeTo(uint8_t *buf) const {
1153 memcpy(dest: buf, src: importThunkARM64EC, n: sizeof(importThunkARM64EC));
1154 applyArm64Addr(off: buf, s: file->impSym->getRVA(), p: rva, shift: 12);
1155 applyArm64Ldr(off: buf + 4, imm: file->impSym->getRVA() & 0xfff);
1156
1157 // The exit thunk may be missing. This can happen if the application only
1158 // references a function by its address (in which case the thunk is never
1159 // actually used, but is still required to fill the auxiliary IAT), or in
1160 // cases of hand-written assembly calling an imported ARM64EC function (where
1161 // the exit thunk is ignored by __icall_helper_arm64ec). In such cases, MSVC
1162 // link.exe uses 0 as the RVA.
1163 uint32_t exitThunkRVA = exitThunk ? exitThunk->getRVA() : 0;
1164 applyArm64Addr(off: buf + 8, s: exitThunkRVA, p: rva + 8, shift: 12);
1165 applyArm64Imm(off: buf + 12, imm: exitThunkRVA & 0xfff, rangeLimit: 0);
1166
1167 Defined *helper = cast<Defined>(Val: file->symtab.ctx.config.arm64ECIcallHelper);
1168 if (extended) {
1169 // Replace last instruction with an inline range extension thunk.
1170 memcpy(dest: buf + 16, src: arm64Thunk, n: sizeof(arm64Thunk));
1171 applyArm64Addr(off: buf + 16, s: helper->getRVA(), p: rva + 16, shift: 12);
1172 applyArm64Imm(off: buf + 20, imm: helper->getRVA() & 0xfff, rangeLimit: 0);
1173 } else {
1174 applyArm64Branch26(off: buf + 16, v: helper->getRVA() - rva - 16);
1175 }
1176}
1177
1178bool ImportThunkChunkARM64EC::verifyRanges() {
1179 if (extended)
1180 return true;
1181 auto helper = cast<Defined>(Val: file->symtab.ctx.config.arm64ECIcallHelper);
1182 return isInt<28>(x: helper->getRVA() - rva - 16);
1183}
1184
1185uint32_t ImportThunkChunkARM64EC::extendRanges() {
1186 if (extended || verifyRanges())
1187 return 0;
1188 extended = true;
1189 // The last instruction is replaced with an inline range extension thunk.
1190 return sizeof(arm64Thunk) - sizeof(uint32_t);
1191}
1192
1193uint64_t Arm64XRelocVal::get() const {
1194 return (sym ? sym->getRVA() : 0) + (chunk ? chunk->getRVA() : 0) + value;
1195}
1196
1197size_t Arm64XDynamicRelocEntry::getSize() const {
1198 switch (type) {
1199 case IMAGE_DVRT_ARM64X_FIXUP_TYPE_ZEROFILL:
1200 return sizeof(uint16_t); // Just a header.
1201 case IMAGE_DVRT_ARM64X_FIXUP_TYPE_VALUE:
1202 return sizeof(uint16_t) + size; // A header and a payload.
1203 case IMAGE_DVRT_ARM64X_FIXUP_TYPE_DELTA:
1204 return 2 * sizeof(uint16_t); // A header and a delta.
1205 }
1206 llvm_unreachable("invalid type");
1207}
1208
1209void Arm64XDynamicRelocEntry::writeTo(uint8_t *buf) const {
1210 auto out = reinterpret_cast<ulittle16_t *>(buf);
1211 *out = (offset.get() & 0xfff) | (type << 12);
1212
1213 switch (type) {
1214 case IMAGE_DVRT_ARM64X_FIXUP_TYPE_ZEROFILL:
1215 *out |= ((bit_width(Value: size) - 1) << 14); // Encode the size.
1216 break;
1217 case IMAGE_DVRT_ARM64X_FIXUP_TYPE_VALUE:
1218 *out |= ((bit_width(Value: size) - 1) << 14); // Encode the size.
1219 switch (size) {
1220 case 2:
1221 out[1] = value.get();
1222 break;
1223 case 4:
1224 *reinterpret_cast<ulittle32_t *>(out + 1) = value.get();
1225 break;
1226 case 8:
1227 *reinterpret_cast<ulittle64_t *>(out + 1) = value.get();
1228 break;
1229 default:
1230 llvm_unreachable("invalid size");
1231 }
1232 break;
1233 case IMAGE_DVRT_ARM64X_FIXUP_TYPE_DELTA:
1234 int delta = value.get();
1235 // Negative offsets use a sign bit in the header.
1236 if (delta < 0) {
1237 *out |= 1 << 14;
1238 delta = -delta;
1239 }
1240 // Depending on the value, the delta is encoded with a shift of 2 or 3 bits.
1241 if (delta & 7) {
1242 assert(!(delta & 3));
1243 delta >>= 2;
1244 } else {
1245 *out |= (1 << 15);
1246 delta >>= 3;
1247 }
1248 out[1] = delta;
1249 assert(!(delta & ~0xffff));
1250 break;
1251 }
1252}
1253
1254void DynamicRelocsChunk::finalize() {
1255 llvm::stable_sort(Range&: arm64xRelocs, C: [=](const Arm64XDynamicRelocEntry &a,
1256 const Arm64XDynamicRelocEntry &b) {
1257 return a.offset.get() < b.offset.get();
1258 });
1259
1260 size = sizeof(coff_dynamic_reloc_table) + sizeof(coff_dynamic_relocation64);
1261 uint32_t prevPage = 0xfff;
1262
1263 for (const Arm64XDynamicRelocEntry &entry : arm64xRelocs) {
1264 uint32_t page = entry.offset.get() & ~0xfff;
1265 if (page != prevPage) {
1266 size = alignTo(Value: size, Align: sizeof(uint32_t)) +
1267 sizeof(coff_base_reloc_block_header);
1268 prevPage = page;
1269 }
1270 size += entry.getSize();
1271 }
1272
1273 size = alignTo(Value: size, Align: sizeof(uint32_t));
1274}
1275
1276// Set the reloc value. The reloc entry must be allocated beforehand.
1277void DynamicRelocsChunk::set(Arm64XRelocVal offset, Arm64XRelocVal value) {
1278 uint32_t rva = offset.get();
1279 auto entry =
1280 llvm::find_if(Range&: arm64xRelocs, P: [rva](const Arm64XDynamicRelocEntry &e) {
1281 return e.offset.get() == rva;
1282 });
1283 assert(entry != arm64xRelocs.end());
1284 assert(!entry->value.get());
1285 entry->value = value;
1286}
1287
1288void DynamicRelocsChunk::writeTo(uint8_t *buf) const {
1289 auto table = reinterpret_cast<coff_dynamic_reloc_table *>(buf);
1290 table->Version = 1;
1291 table->Size = sizeof(coff_dynamic_relocation64);
1292 buf += sizeof(*table);
1293
1294 auto header = reinterpret_cast<coff_dynamic_relocation64 *>(buf);
1295 header->Symbol = IMAGE_DYNAMIC_RELOCATION_ARM64X;
1296 buf += sizeof(*header);
1297
1298 coff_base_reloc_block_header *pageHeader = nullptr;
1299 size_t relocSize = 0;
1300 for (const Arm64XDynamicRelocEntry &entry : arm64xRelocs) {
1301 uint32_t page = entry.offset.get() & ~0xfff;
1302 if (!pageHeader || page != pageHeader->PageRVA) {
1303 relocSize = alignTo(Value: relocSize, Align: sizeof(uint32_t));
1304 if (pageHeader)
1305 pageHeader->BlockSize =
1306 buf + relocSize - reinterpret_cast<uint8_t *>(pageHeader);
1307 pageHeader =
1308 reinterpret_cast<coff_base_reloc_block_header *>(buf + relocSize);
1309 pageHeader->PageRVA = page;
1310 relocSize += sizeof(*pageHeader);
1311 }
1312
1313 entry.writeTo(buf: buf + relocSize);
1314 relocSize += entry.getSize();
1315 }
1316 relocSize = alignTo(Value: relocSize, Align: sizeof(uint32_t));
1317 pageHeader->BlockSize =
1318 buf + relocSize - reinterpret_cast<uint8_t *>(pageHeader);
1319
1320 header->BaseRelocSize = relocSize;
1321 table->Size += relocSize;
1322 assert(size == sizeof(*table) + sizeof(*header) + relocSize);
1323}
1324
1325} // namespace lld::coff
1326