9d60bc746c9603b6b5ff9d0526a4acdda172dbcd
[lldb.git] / lld / COFF / Chunks.cpp
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 "InputFiles.h"
11 #include "Symbols.h"
12 #include "Writer.h"
13 #include "SymbolTable.h"
14 #include "lld/Common/ErrorHandler.h"
15 #include "llvm/ADT/Twine.h"
16 #include "llvm/BinaryFormat/COFF.h"
17 #include "llvm/Object/COFF.h"
18 #include "llvm/Support/Debug.h"
19 #include "llvm/Support/Endian.h"
20 #include "llvm/Support/raw_ostream.h"
21 #include <algorithm>
22
23 using namespace llvm;
24 using namespace llvm::object;
25 using namespace llvm::support::endian;
26 using namespace llvm::COFF;
27 using llvm::support::ulittle32_t;
28
29 namespace lld {
30 namespace coff {
31
32 SectionChunk::SectionChunk(ObjFile *f, const coff_section *h)
33     : Chunk(SectionKind), file(f), header(h), repl(this) {
34   // Initialize relocs.
35   setRelocs(file->getCOFFObj()->getRelocations(header));
36
37   // Initialize sectionName.
38   StringRef sectionName;
39   if (Expected<StringRef> e = file->getCOFFObj()->getSectionName(header))
40     sectionName = *e;
41   sectionNameData = sectionName.data();
42   sectionNameSize = sectionName.size();
43
44   setAlignment(header->getAlignment());
45
46   hasData = !(header->Characteristics & IMAGE_SCN_CNT_UNINITIALIZED_DATA);
47
48   // If linker GC is disabled, every chunk starts out alive.  If linker GC is
49   // enabled, treat non-comdat sections as roots. Generally optimized object
50   // files will be built with -ffunction-sections or /Gy, so most things worth
51   // stripping will be in a comdat.
52   live = !config->doGC || !isCOMDAT();
53 }
54
55 // SectionChunk is one of the most frequently allocated classes, so it is
56 // important to keep it as compact as possible. As of this writing, the number
57 // below is the size of this class on x64 platforms.
58 static_assert(sizeof(SectionChunk) <= 88, "SectionChunk grew unexpectedly");
59
60 static void add16(uint8_t *p, int16_t v) { write16le(p, read16le(p) + v); }
61 static void add32(uint8_t *p, int32_t v) { write32le(p, read32le(p) + v); }
62 static void add64(uint8_t *p, int64_t v) { write64le(p, read64le(p) + v); }
63 static void or16(uint8_t *p, uint16_t v) { write16le(p, read16le(p) | v); }
64 static void or32(uint8_t *p, uint32_t v) { write32le(p, read32le(p) | v); }
65
66 // Verify that given sections are appropriate targets for SECREL
67 // relocations. This check is relaxed because unfortunately debug
68 // sections have section-relative relocations against absolute symbols.
69 static bool checkSecRel(const SectionChunk *sec, OutputSection *os) {
70   if (os)
71     return true;
72   if (sec->isCodeView())
73     return false;
74   error("SECREL relocation cannot be applied to absolute symbols");
75   return false;
76 }
77
78 static void applySecRel(const SectionChunk *sec, uint8_t *off,
79                         OutputSection *os, uint64_t s) {
80   if (!checkSecRel(sec, os))
81     return;
82   uint64_t secRel = s - os->getRVA();
83   if (secRel > UINT32_MAX) {
84     error("overflow in SECREL relocation in section: " + sec->getSectionName());
85     return;
86   }
87   add32(off, secRel);
88 }
89
90 static void applySecIdx(uint8_t *off, OutputSection *os) {
91   // Absolute symbol doesn't have section index, but section index relocation
92   // against absolute symbol should be resolved to one plus the last output
93   // section index. This is required for compatibility with MSVC.
94   if (os)
95     add16(off, os->sectionIndex);
96   else
97     add16(off, DefinedAbsolute::numOutputSections + 1);
98 }
99
100 void SectionChunk::applyRelX64(uint8_t *off, uint16_t type, OutputSection *os,
101                                uint64_t s, uint64_t p) const {
102   switch (type) {
103   case IMAGE_REL_AMD64_ADDR32:   add32(off, s + config->imageBase); break;
104   case IMAGE_REL_AMD64_ADDR64:   add64(off, s + config->imageBase); break;
105   case IMAGE_REL_AMD64_ADDR32NB: add32(off, s); break;
106   case IMAGE_REL_AMD64_REL32:    add32(off, s - p - 4); break;
107   case IMAGE_REL_AMD64_REL32_1:  add32(off, s - p - 5); break;
108   case IMAGE_REL_AMD64_REL32_2:  add32(off, s - p - 6); break;
109   case IMAGE_REL_AMD64_REL32_3:  add32(off, s - p - 7); break;
110   case IMAGE_REL_AMD64_REL32_4:  add32(off, s - p - 8); break;
111   case IMAGE_REL_AMD64_REL32_5:  add32(off, s - p - 9); break;
112   case IMAGE_REL_AMD64_SECTION:  applySecIdx(off, os); break;
113   case IMAGE_REL_AMD64_SECREL:   applySecRel(this, off, os, s); break;
114   default:
115     error("unsupported relocation type 0x" + Twine::utohexstr(type) + " in " +
116           toString(file));
117   }
118 }
119
120 void SectionChunk::applyRelX86(uint8_t *off, uint16_t type, OutputSection *os,
121                                uint64_t s, uint64_t p) const {
122   switch (type) {
123   case IMAGE_REL_I386_ABSOLUTE: break;
124   case IMAGE_REL_I386_DIR32:    add32(off, s + config->imageBase); break;
125   case IMAGE_REL_I386_DIR32NB:  add32(off, s); break;
126   case IMAGE_REL_I386_REL32:    add32(off, s - p - 4); break;
127   case IMAGE_REL_I386_SECTION:  applySecIdx(off, os); break;
128   case IMAGE_REL_I386_SECREL:   applySecRel(this, off, os, s); break;
129   default:
130     error("unsupported relocation type 0x" + Twine::utohexstr(type) + " in " +
131           toString(file));
132   }
133 }
134
135 static void applyMOV(uint8_t *off, uint16_t v) {
136   write16le(off, (read16le(off) & 0xfbf0) | ((v & 0x800) >> 1) | ((v >> 12) & 0xf));
137   write16le(off + 2, (read16le(off + 2) & 0x8f00) | ((v & 0x700) << 4) | (v & 0xff));
138 }
139
140 static uint16_t readMOV(uint8_t *off, bool movt) {
141   uint16_t op1 = read16le(off);
142   if ((op1 & 0xfbf0) != (movt ? 0xf2c0 : 0xf240))
143     error("unexpected instruction in " + Twine(movt ? "MOVT" : "MOVW") +
144           " instruction in MOV32T relocation");
145   uint16_t op2 = read16le(off + 2);
146   if ((op2 & 0x8000) != 0)
147     error("unexpected instruction in " + Twine(movt ? "MOVT" : "MOVW") +
148           " instruction in MOV32T relocation");
149   return (op2 & 0x00ff) | ((op2 >> 4) & 0x0700) | ((op1 << 1) & 0x0800) |
150          ((op1 & 0x000f) << 12);
151 }
152
153 void applyMOV32T(uint8_t *off, uint32_t v) {
154   uint16_t immW = readMOV(off, false);    // read MOVW operand
155   uint16_t immT = readMOV(off + 4, true); // read MOVT operand
156   uint32_t imm = immW | (immT << 16);
157   v += imm;                         // add the immediate offset
158   applyMOV(off, v);           // set MOVW operand
159   applyMOV(off + 4, v >> 16); // set MOVT operand
160 }
161
162 static void applyBranch20T(uint8_t *off, int32_t v) {
163   if (!isInt<21>(v))
164     error("relocation out of range");
165   uint32_t s = v < 0 ? 1 : 0;
166   uint32_t j1 = (v >> 19) & 1;
167   uint32_t j2 = (v >> 18) & 1;
168   or16(off, (s << 10) | ((v >> 12) & 0x3f));
169   or16(off + 2, (j1 << 13) | (j2 << 11) | ((v >> 1) & 0x7ff));
170 }
171
172 void applyBranch24T(uint8_t *off, int32_t v) {
173   if (!isInt<25>(v))
174     error("relocation out of range");
175   uint32_t s = v < 0 ? 1 : 0;
176   uint32_t j1 = ((~v >> 23) & 1) ^ s;
177   uint32_t j2 = ((~v >> 22) & 1) ^ s;
178   or16(off, (s << 10) | ((v >> 12) & 0x3ff));
179   // Clear out the J1 and J2 bits which may be set.
180   write16le(off + 2, (read16le(off + 2) & 0xd000) | (j1 << 13) | (j2 << 11) | ((v >> 1) & 0x7ff));
181 }
182
183 void SectionChunk::applyRelARM(uint8_t *off, uint16_t type, OutputSection *os,
184                                uint64_t s, uint64_t p) const {
185   // Pointer to thumb code must have the LSB set.
186   uint64_t sx = s;
187   if (os && (os->header.Characteristics & IMAGE_SCN_MEM_EXECUTE))
188     sx |= 1;
189   switch (type) {
190   case IMAGE_REL_ARM_ADDR32:    add32(off, sx + config->imageBase); break;
191   case IMAGE_REL_ARM_ADDR32NB:  add32(off, sx); break;
192   case IMAGE_REL_ARM_MOV32T:    applyMOV32T(off, sx + config->imageBase); break;
193   case IMAGE_REL_ARM_BRANCH20T: applyBranch20T(off, sx - p - 4); break;
194   case IMAGE_REL_ARM_BRANCH24T: applyBranch24T(off, sx - p - 4); break;
195   case IMAGE_REL_ARM_BLX23T:    applyBranch24T(off, sx - p - 4); break;
196   case IMAGE_REL_ARM_SECTION:   applySecIdx(off, os); break;
197   case IMAGE_REL_ARM_SECREL:    applySecRel(this, off, os, s); break;
198   case IMAGE_REL_ARM_REL32:     add32(off, sx - p - 4); break;
199   default:
200     error("unsupported relocation type 0x" + Twine::utohexstr(type) + " in " +
201           toString(file));
202   }
203 }
204
205 // Interpret the existing immediate value as a byte offset to the
206 // target symbol, then update the instruction with the immediate as
207 // the page offset from the current instruction to the target.
208 void applyArm64Addr(uint8_t *off, uint64_t s, uint64_t p, int shift) {
209   uint32_t orig = read32le(off);
210   uint64_t imm = ((orig >> 29) & 0x3) | ((orig >> 3) & 0x1FFFFC);
211   s += imm;
212   imm = (s >> shift) - (p >> shift);
213   uint32_t immLo = (imm & 0x3) << 29;
214   uint32_t immHi = (imm & 0x1FFFFC) << 3;
215   uint64_t mask = (0x3 << 29) | (0x1FFFFC << 3);
216   write32le(off, (orig & ~mask) | immLo | immHi);
217 }
218
219 // Update the immediate field in a AARCH64 ldr, str, and add instruction.
220 // Optionally limit the range of the written immediate by one or more bits
221 // (rangeLimit).
222 void applyArm64Imm(uint8_t *off, uint64_t imm, uint32_t rangeLimit) {
223   uint32_t orig = read32le(off);
224   imm += (orig >> 10) & 0xFFF;
225   orig &= ~(0xFFF << 10);
226   write32le(off, orig | ((imm & (0xFFF >> rangeLimit)) << 10));
227 }
228
229 // Add the 12 bit page offset to the existing immediate.
230 // Ldr/str instructions store the opcode immediate scaled
231 // by the load/store size (giving a larger range for larger
232 // loads/stores). The immediate is always (both before and after
233 // fixing up the relocation) stored scaled similarly.
234 // Even if larger loads/stores have a larger range, limit the
235 // effective offset to 12 bit, since it is intended to be a
236 // page offset.
237 static void applyArm64Ldr(uint8_t *off, uint64_t imm) {
238   uint32_t orig = read32le(off);
239   uint32_t size = orig >> 30;
240   // 0x04000000 indicates SIMD/FP registers
241   // 0x00800000 indicates 128 bit
242   if ((orig & 0x4800000) == 0x4800000)
243     size += 4;
244   if ((imm & ((1 << size) - 1)) != 0)
245     error("misaligned ldr/str offset");
246   applyArm64Imm(off, imm >> size, size);
247 }
248
249 static void applySecRelLow12A(const SectionChunk *sec, uint8_t *off,
250                               OutputSection *os, uint64_t s) {
251   if (checkSecRel(sec, os))
252     applyArm64Imm(off, (s - os->getRVA()) & 0xfff, 0);
253 }
254
255 static void applySecRelHigh12A(const SectionChunk *sec, uint8_t *off,
256                                OutputSection *os, uint64_t s) {
257   if (!checkSecRel(sec, os))
258     return;
259   uint64_t secRel = (s - os->getRVA()) >> 12;
260   if (0xfff < secRel) {
261     error("overflow in SECREL_HIGH12A relocation in section: " +
262           sec->getSectionName());
263     return;
264   }
265   applyArm64Imm(off, secRel & 0xfff, 0);
266 }
267
268 static void applySecRelLdr(const SectionChunk *sec, uint8_t *off,
269                            OutputSection *os, uint64_t s) {
270   if (checkSecRel(sec, os))
271     applyArm64Ldr(off, (s - os->getRVA()) & 0xfff);
272 }
273
274 void applyArm64Branch26(uint8_t *off, int64_t v) {
275   if (!isInt<28>(v))
276     error("relocation out of range");
277   or32(off, (v & 0x0FFFFFFC) >> 2);
278 }
279
280 static void applyArm64Branch19(uint8_t *off, int64_t v) {
281   if (!isInt<21>(v))
282     error("relocation out of range");
283   or32(off, (v & 0x001FFFFC) << 3);
284 }
285
286 static void applyArm64Branch14(uint8_t *off, int64_t v) {
287   if (!isInt<16>(v))
288     error("relocation out of range");
289   or32(off, (v & 0x0000FFFC) << 3);
290 }
291
292 void SectionChunk::applyRelARM64(uint8_t *off, uint16_t type, OutputSection *os,
293                                  uint64_t s, uint64_t p) const {
294   switch (type) {
295   case IMAGE_REL_ARM64_PAGEBASE_REL21: applyArm64Addr(off, s, p, 12); break;
296   case IMAGE_REL_ARM64_REL21:          applyArm64Addr(off, s, p, 0); break;
297   case IMAGE_REL_ARM64_PAGEOFFSET_12A: applyArm64Imm(off, s & 0xfff, 0); break;
298   case IMAGE_REL_ARM64_PAGEOFFSET_12L: applyArm64Ldr(off, s & 0xfff); break;
299   case IMAGE_REL_ARM64_BRANCH26:       applyArm64Branch26(off, s - p); break;
300   case IMAGE_REL_ARM64_BRANCH19:       applyArm64Branch19(off, s - p); break;
301   case IMAGE_REL_ARM64_BRANCH14:       applyArm64Branch14(off, s - p); break;
302   case IMAGE_REL_ARM64_ADDR32:         add32(off, s + config->imageBase); break;
303   case IMAGE_REL_ARM64_ADDR32NB:       add32(off, s); break;
304   case IMAGE_REL_ARM64_ADDR64:         add64(off, s + config->imageBase); break;
305   case IMAGE_REL_ARM64_SECREL:         applySecRel(this, off, os, s); break;
306   case IMAGE_REL_ARM64_SECREL_LOW12A:  applySecRelLow12A(this, off, os, s); break;
307   case IMAGE_REL_ARM64_SECREL_HIGH12A: applySecRelHigh12A(this, off, os, s); break;
308   case IMAGE_REL_ARM64_SECREL_LOW12L:  applySecRelLdr(this, off, os, s); break;
309   case IMAGE_REL_ARM64_SECTION:        applySecIdx(off, os); break;
310   case IMAGE_REL_ARM64_REL32:          add32(off, s - p - 4); break;
311   default:
312     error("unsupported relocation type 0x" + Twine::utohexstr(type) + " in " +
313           toString(file));
314   }
315 }
316
317 static void maybeReportRelocationToDiscarded(const SectionChunk *fromChunk,
318                                              Defined *sym,
319                                              const coff_relocation &rel) {
320   // Don't report these errors when the relocation comes from a debug info
321   // section or in mingw mode. MinGW mode object files (built by GCC) can
322   // have leftover sections with relocations against discarded comdat
323   // sections. Such sections are left as is, with relocations untouched.
324   if (fromChunk->isCodeView() || fromChunk->isDWARF() || config->mingw)
325     return;
326
327   // Get the name of the symbol. If it's null, it was discarded early, so we
328   // have to go back to the object file.
329   ObjFile *file = fromChunk->file;
330   StringRef name;
331   if (sym) {
332     name = sym->getName();
333   } else {
334     COFFSymbolRef coffSym =
335         check(file->getCOFFObj()->getSymbol(rel.SymbolTableIndex));
336     name = check(file->getCOFFObj()->getSymbolName(coffSym));
337   }
338
339   std::vector<std::string> symbolLocations =
340       getSymbolLocations(file, rel.SymbolTableIndex);
341
342   std::string out;
343   llvm::raw_string_ostream os(out);
344   os << "relocation against symbol in discarded section: " + name;
345   for (const std::string &s : symbolLocations)
346     os << s;
347   error(os.str());
348 }
349
350 void SectionChunk::writeTo(uint8_t *buf) const {
351   if (!hasData)
352     return;
353   // Copy section contents from source object file to output file.
354   ArrayRef<uint8_t> a = getContents();
355   if (!a.empty())
356     memcpy(buf, a.data(), a.size());
357
358   // Apply relocations.
359   size_t inputSize = getSize();
360   for (const coff_relocation &rel : getRelocs()) {
361     // Check for an invalid relocation offset. This check isn't perfect, because
362     // we don't have the relocation size, which is only known after checking the
363     // machine and relocation type. As a result, a relocation may overwrite the
364     // beginning of the following input section.
365     if (rel.VirtualAddress >= inputSize) {
366       error("relocation points beyond the end of its parent section");
367       continue;
368     }
369
370     uint8_t *off = buf + rel.VirtualAddress;
371
372     auto *sym =
373         dyn_cast_or_null<Defined>(file->getSymbol(rel.SymbolTableIndex));
374
375     // Get the output section of the symbol for this relocation.  The output
376     // section is needed to compute SECREL and SECTION relocations used in debug
377     // info.
378     Chunk *c = sym ? sym->getChunk() : nullptr;
379     OutputSection *os = c ? c->getOutputSection() : nullptr;
380
381     // Skip the relocation if it refers to a discarded section, and diagnose it
382     // as an error if appropriate. If a symbol was discarded early, it may be
383     // null. If it was discarded late, the output section will be null, unless
384     // it was an absolute or synthetic symbol.
385     if (!sym ||
386         (!os && !isa<DefinedAbsolute>(sym) && !isa<DefinedSynthetic>(sym))) {
387       maybeReportRelocationToDiscarded(this, sym, rel);
388       continue;
389     }
390
391     uint64_t s = sym->getRVA();
392
393     // Compute the RVA of the relocation for relative relocations.
394     uint64_t p = rva + rel.VirtualAddress;
395     switch (config->machine) {
396     case AMD64:
397       applyRelX64(off, rel.Type, os, s, p);
398       break;
399     case I386:
400       applyRelX86(off, rel.Type, os, s, p);
401       break;
402     case ARMNT:
403       applyRelARM(off, rel.Type, os, s, p);
404       break;
405     case ARM64:
406       applyRelARM64(off, rel.Type, os, s, p);
407       break;
408     default:
409       llvm_unreachable("unknown machine type");
410     }
411   }
412 }
413
414 void SectionChunk::addAssociative(SectionChunk *child) {
415   // Insert this child at the head of the list.
416   assert(child->assocChildren == nullptr &&
417          "associated sections cannot have their own associated children");
418   child->assocChildren = assocChildren;
419   assocChildren = child;
420 }
421
422 static uint8_t getBaserelType(const coff_relocation &rel) {
423   switch (config->machine) {
424   case AMD64:
425     if (rel.Type == IMAGE_REL_AMD64_ADDR64)
426       return IMAGE_REL_BASED_DIR64;
427     return IMAGE_REL_BASED_ABSOLUTE;
428   case I386:
429     if (rel.Type == IMAGE_REL_I386_DIR32)
430       return IMAGE_REL_BASED_HIGHLOW;
431     return IMAGE_REL_BASED_ABSOLUTE;
432   case ARMNT:
433     if (rel.Type == IMAGE_REL_ARM_ADDR32)
434       return IMAGE_REL_BASED_HIGHLOW;
435     if (rel.Type == IMAGE_REL_ARM_MOV32T)
436       return IMAGE_REL_BASED_ARM_MOV32T;
437     return IMAGE_REL_BASED_ABSOLUTE;
438   case ARM64:
439     if (rel.Type == IMAGE_REL_ARM64_ADDR64)
440       return IMAGE_REL_BASED_DIR64;
441     return IMAGE_REL_BASED_ABSOLUTE;
442   default:
443     llvm_unreachable("unknown machine type");
444   }
445 }
446
447 // Windows-specific.
448 // Collect all locations that contain absolute addresses, which need to be
449 // fixed by the loader if load-time relocation is needed.
450 // Only called when base relocation is enabled.
451 void SectionChunk::getBaserels(std::vector<Baserel> *res) {
452   for (const coff_relocation &rel : getRelocs()) {
453     uint8_t ty = getBaserelType(rel);
454     if (ty == IMAGE_REL_BASED_ABSOLUTE)
455       continue;
456     Symbol *target = file->getSymbol(rel.SymbolTableIndex);
457     if (!target || isa<DefinedAbsolute>(target))
458       continue;
459     res->emplace_back(rva + rel.VirtualAddress, ty);
460   }
461 }
462
463 // MinGW specific.
464 // Check whether a static relocation of type Type can be deferred and
465 // handled at runtime as a pseudo relocation (for references to a module
466 // local variable, which turned out to actually need to be imported from
467 // another DLL) This returns the size the relocation is supposed to update,
468 // in bits, or 0 if the relocation cannot be handled as a runtime pseudo
469 // relocation.
470 static int getRuntimePseudoRelocSize(uint16_t type) {
471   // Relocations that either contain an absolute address, or a plain
472   // relative offset, since the runtime pseudo reloc implementation
473   // adds 8/16/32/64 bit values to a memory address.
474   //
475   // Given a pseudo relocation entry,
476   //
477   // typedef struct {
478   //   DWORD sym;
479   //   DWORD target;
480   //   DWORD flags;
481   // } runtime_pseudo_reloc_item_v2;
482   //
483   // the runtime relocation performs this adjustment:
484   //     *(base + .target) += *(base + .sym) - (base + .sym)
485   //
486   // This works for both absolute addresses (IMAGE_REL_*_ADDR32/64,
487   // IMAGE_REL_I386_DIR32, where the memory location initially contains
488   // the address of the IAT slot, and for relative addresses (IMAGE_REL*_REL32),
489   // where the memory location originally contains the relative offset to the
490   // IAT slot.
491   //
492   // This requires the target address to be writable, either directly out of
493   // the image, or temporarily changed at runtime with VirtualProtect.
494   // Since this only operates on direct address values, it doesn't work for
495   // ARM/ARM64 relocations, other than the plain ADDR32/ADDR64 relocations.
496   switch (config->machine) {
497   case AMD64:
498     switch (type) {
499     case IMAGE_REL_AMD64_ADDR64:
500       return 64;
501     case IMAGE_REL_AMD64_ADDR32:
502     case IMAGE_REL_AMD64_REL32:
503     case IMAGE_REL_AMD64_REL32_1:
504     case IMAGE_REL_AMD64_REL32_2:
505     case IMAGE_REL_AMD64_REL32_3:
506     case IMAGE_REL_AMD64_REL32_4:
507     case IMAGE_REL_AMD64_REL32_5:
508       return 32;
509     default:
510       return 0;
511     }
512   case I386:
513     switch (type) {
514     case IMAGE_REL_I386_DIR32:
515     case IMAGE_REL_I386_REL32:
516       return 32;
517     default:
518       return 0;
519     }
520   case ARMNT:
521     switch (type) {
522     case IMAGE_REL_ARM_ADDR32:
523       return 32;
524     default:
525       return 0;
526     }
527   case ARM64:
528     switch (type) {
529     case IMAGE_REL_ARM64_ADDR64:
530       return 64;
531     case IMAGE_REL_ARM64_ADDR32:
532       return 32;
533     default:
534       return 0;
535     }
536   default:
537     llvm_unreachable("unknown machine type");
538   }
539 }
540
541 // MinGW specific.
542 // Append information to the provided vector about all relocations that
543 // need to be handled at runtime as runtime pseudo relocations (references
544 // to a module local variable, which turned out to actually need to be
545 // imported from another DLL).
546 void SectionChunk::getRuntimePseudoRelocs(
547     std::vector<RuntimePseudoReloc> &res) {
548   for (const coff_relocation &rel : getRelocs()) {
549     auto *target =
550         dyn_cast_or_null<Defined>(file->getSymbol(rel.SymbolTableIndex));
551     if (!target || !target->isRuntimePseudoReloc)
552       continue;
553     int sizeInBits = getRuntimePseudoRelocSize(rel.Type);
554     if (sizeInBits == 0) {
555       error("unable to automatically import from " + target->getName() +
556             " with relocation type " +
557             file->getCOFFObj()->getRelocationTypeName(rel.Type) + " in " +
558             toString(file));
559       continue;
560     }
561     // sizeInBits is used to initialize the Flags field; currently no
562     // other flags are defined.
563     res.emplace_back(
564         RuntimePseudoReloc(target, this, rel.VirtualAddress, sizeInBits));
565   }
566 }
567
568 bool SectionChunk::isCOMDAT() const {
569   return header->Characteristics & IMAGE_SCN_LNK_COMDAT;
570 }
571
572 void SectionChunk::printDiscardedMessage() const {
573   // Removed by dead-stripping. If it's removed by ICF, ICF already
574   // printed out the name, so don't repeat that here.
575   if (sym && this == repl)
576     message("Discarded " + sym->getName());
577 }
578
579 StringRef SectionChunk::getDebugName() const {
580   if (sym)
581     return sym->getName();
582   return "";
583 }
584
585 ArrayRef<uint8_t> SectionChunk::getContents() const {
586   ArrayRef<uint8_t> a;
587   cantFail(file->getCOFFObj()->getSectionContents(header, a));
588   return a;
589 }
590
591 ArrayRef<uint8_t> SectionChunk::consumeDebugMagic() {
592   assert(isCodeView());
593   return consumeDebugMagic(getContents(), getSectionName());
594 }
595
596 ArrayRef<uint8_t> SectionChunk::consumeDebugMagic(ArrayRef<uint8_t> data,
597                                                   StringRef sectionName) {
598   if (data.empty())
599     return {};
600
601   // First 4 bytes are section magic.
602   if (data.size() < 4)
603     fatal("the section is too short: " + sectionName);
604
605   if (!sectionName.startswith(".debug$"))
606     fatal("invalid section: " + sectionName);
607
608   uint32_t magic = support::endian::read32le(data.data());
609   uint32_t expectedMagic = sectionName == ".debug$H"
610                                ? DEBUG_HASHES_SECTION_MAGIC
611                                : DEBUG_SECTION_MAGIC;
612   if (magic != expectedMagic) {
613     warn("ignoring section " + sectionName + " with unrecognized magic 0x" +
614          utohexstr(magic));
615     return {};
616   }
617   return data.slice(4);
618 }
619
620 SectionChunk *SectionChunk::findByName(ArrayRef<SectionChunk *> sections,
621                                        StringRef name) {
622   for (SectionChunk *c : sections)
623     if (c->getSectionName() == name)
624       return c;
625   return nullptr;
626 }
627
628 void SectionChunk::replace(SectionChunk *other) {
629   p2Align = std::max(p2Align, other->p2Align);
630   other->repl = repl;
631   other->live = false;
632 }
633
634 uint32_t SectionChunk::getSectionNumber() const {
635   DataRefImpl r;
636   r.p = reinterpret_cast<uintptr_t>(header);
637   SectionRef s(r, file->getCOFFObj());
638   return s.getIndex() + 1;
639 }
640
641 CommonChunk::CommonChunk(const COFFSymbolRef s) : sym(s) {
642   // The value of a common symbol is its size. Align all common symbols smaller
643   // than 32 bytes naturally, i.e. round the size up to the next power of two.
644   // This is what MSVC link.exe does.
645   setAlignment(std::min(32U, uint32_t(PowerOf2Ceil(sym.getValue()))));
646   hasData = false;
647 }
648
649 uint32_t CommonChunk::getOutputCharacteristics() const {
650   return IMAGE_SCN_CNT_UNINITIALIZED_DATA | IMAGE_SCN_MEM_READ |
651          IMAGE_SCN_MEM_WRITE;
652 }
653
654 void StringChunk::writeTo(uint8_t *buf) const {
655   memcpy(buf, str.data(), str.size());
656   buf[str.size()] = '\0';
657 }
658
659 ImportThunkChunkX64::ImportThunkChunkX64(Defined *s) : ImportThunkChunk(s) {
660   // Intel Optimization Manual says that all branch targets
661   // should be 16-byte aligned. MSVC linker does this too.
662   setAlignment(16);
663 }
664
665 void ImportThunkChunkX64::writeTo(uint8_t *buf) const {
666   memcpy(buf, importThunkX86, sizeof(importThunkX86));
667   // The first two bytes is a JMP instruction. Fill its operand.
668   write32le(buf + 2, impSymbol->getRVA() - rva - getSize());
669 }
670
671 void ImportThunkChunkX86::getBaserels(std::vector<Baserel> *res) {
672   res->emplace_back(getRVA() + 2);
673 }
674
675 void ImportThunkChunkX86::writeTo(uint8_t *buf) const {
676   memcpy(buf, importThunkX86, sizeof(importThunkX86));
677   // The first two bytes is a JMP instruction. Fill its operand.
678   write32le(buf + 2,
679             impSymbol->getRVA() + config->imageBase);
680 }
681
682 void ImportThunkChunkARM::getBaserels(std::vector<Baserel> *res) {
683   res->emplace_back(getRVA(), IMAGE_REL_BASED_ARM_MOV32T);
684 }
685
686 void ImportThunkChunkARM::writeTo(uint8_t *buf) const {
687   memcpy(buf, importThunkARM, sizeof(importThunkARM));
688   // Fix mov.w and mov.t operands.
689   applyMOV32T(buf, impSymbol->getRVA() + config->imageBase);
690 }
691
692 void ImportThunkChunkARM64::writeTo(uint8_t *buf) const {
693   int64_t off = impSymbol->getRVA() & 0xfff;
694   memcpy(buf, importThunkARM64, sizeof(importThunkARM64));
695   applyArm64Addr(buf, impSymbol->getRVA(), rva, 12);
696   applyArm64Ldr(buf + 4, off);
697 }
698
699 // A Thumb2, PIC, non-interworking range extension thunk.
700 const uint8_t armThunk[] = {
701     0x40, 0xf2, 0x00, 0x0c, // P:  movw ip,:lower16:S - (P + (L1-P) + 4)
702     0xc0, 0xf2, 0x00, 0x0c, //     movt ip,:upper16:S - (P + (L1-P) + 4)
703     0xe7, 0x44,             // L1: add  pc, ip
704 };
705
706 size_t RangeExtensionThunkARM::getSize() const {
707   assert(config->machine == ARMNT);
708   return sizeof(armThunk);
709 }
710
711 void RangeExtensionThunkARM::writeTo(uint8_t *buf) const {
712   assert(config->machine == ARMNT);
713   uint64_t offset = target->getRVA() - rva - 12;
714   memcpy(buf, armThunk, sizeof(armThunk));
715   applyMOV32T(buf, uint32_t(offset));
716 }
717
718 // A position independent ARM64 adrp+add thunk, with a maximum range of
719 // +/- 4 GB, which is enough for any PE-COFF.
720 const uint8_t arm64Thunk[] = {
721     0x10, 0x00, 0x00, 0x90, // adrp x16, Dest
722     0x10, 0x02, 0x00, 0x91, // add  x16, x16, :lo12:Dest
723     0x00, 0x02, 0x1f, 0xd6, // br   x16
724 };
725
726 size_t RangeExtensionThunkARM64::getSize() const {
727   assert(config->machine == ARM64);
728   return sizeof(arm64Thunk);
729 }
730
731 void RangeExtensionThunkARM64::writeTo(uint8_t *buf) const {
732   assert(config->machine == ARM64);
733   memcpy(buf, arm64Thunk, sizeof(arm64Thunk));
734   applyArm64Addr(buf + 0, target->getRVA(), rva, 12);
735   applyArm64Imm(buf + 4, target->getRVA() & 0xfff, 0);
736 }
737
738 void LocalImportChunk::getBaserels(std::vector<Baserel> *res) {
739   res->emplace_back(getRVA());
740 }
741
742 size_t LocalImportChunk::getSize() const { return config->wordsize; }
743
744 void LocalImportChunk::writeTo(uint8_t *buf) const {
745   if (config->is64()) {
746     write64le(buf, sym->getRVA() + config->imageBase);
747   } else {
748     write32le(buf, sym->getRVA() + config->imageBase);
749   }
750 }
751
752 void RVATableChunk::writeTo(uint8_t *buf) const {
753   ulittle32_t *begin = reinterpret_cast<ulittle32_t *>(buf);
754   size_t cnt = 0;
755   for (const ChunkAndOffset &co : syms)
756     begin[cnt++] = co.inputChunk->getRVA() + co.offset;
757   std::sort(begin, begin + cnt);
758   assert(std::unique(begin, begin + cnt) == begin + cnt &&
759          "RVA tables should be de-duplicated");
760 }
761
762 // MinGW specific, for the "automatic import of variables from DLLs" feature.
763 size_t PseudoRelocTableChunk::getSize() const {
764   if (relocs.empty())
765     return 0;
766   return 12 + 12 * relocs.size();
767 }
768
769 // MinGW specific.
770 void PseudoRelocTableChunk::writeTo(uint8_t *buf) const {
771   if (relocs.empty())
772     return;
773
774   ulittle32_t *table = reinterpret_cast<ulittle32_t *>(buf);
775   // This is the list header, to signal the runtime pseudo relocation v2
776   // format.
777   table[0] = 0;
778   table[1] = 0;
779   table[2] = 1;
780
781   size_t idx = 3;
782   for (const RuntimePseudoReloc &rpr : relocs) {
783     table[idx + 0] = rpr.sym->getRVA();
784     table[idx + 1] = rpr.target->getRVA() + rpr.targetOffset;
785     table[idx + 2] = rpr.flags;
786     idx += 3;
787   }
788 }
789
790 // Windows-specific. This class represents a block in .reloc section.
791 // The format is described here.
792 //
793 // On Windows, each DLL is linked against a fixed base address and
794 // usually loaded to that address. However, if there's already another
795 // DLL that overlaps, the loader has to relocate it. To do that, DLLs
796 // contain .reloc sections which contain offsets that need to be fixed
797 // up at runtime. If the loader finds that a DLL cannot be loaded to its
798 // desired base address, it loads it to somewhere else, and add <actual
799 // base address> - <desired base address> to each offset that is
800 // specified by the .reloc section. In ELF terms, .reloc sections
801 // contain relative relocations in REL format (as opposed to RELA.)
802 //
803 // This already significantly reduces the size of relocations compared
804 // to ELF .rel.dyn, but Windows does more to reduce it (probably because
805 // it was invented for PCs in the late '80s or early '90s.)  Offsets in
806 // .reloc are grouped by page where the page size is 12 bits, and
807 // offsets sharing the same page address are stored consecutively to
808 // represent them with less space. This is very similar to the page
809 // table which is grouped by (multiple stages of) pages.
810 //
811 // For example, let's say we have 0x00030, 0x00500, 0x00700, 0x00A00,
812 // 0x20004, and 0x20008 in a .reloc section for x64. The uppermost 4
813 // bits have a type IMAGE_REL_BASED_DIR64 or 0xA. In the section, they
814 // are represented like this:
815 //
816 //   0x00000  -- page address (4 bytes)
817 //   16       -- size of this block (4 bytes)
818 //     0xA030 -- entries (2 bytes each)
819 //     0xA500
820 //     0xA700
821 //     0xAA00
822 //   0x20000  -- page address (4 bytes)
823 //   12       -- size of this block (4 bytes)
824 //     0xA004 -- entries (2 bytes each)
825 //     0xA008
826 //
827 // Usually we have a lot of relocations for each page, so the number of
828 // bytes for one .reloc entry is close to 2 bytes on average.
829 BaserelChunk::BaserelChunk(uint32_t page, Baserel *begin, Baserel *end) {
830   // Block header consists of 4 byte page RVA and 4 byte block size.
831   // Each entry is 2 byte. Last entry may be padding.
832   data.resize(alignTo((end - begin) * 2 + 8, 4));
833   uint8_t *p = data.data();
834   write32le(p, page);
835   write32le(p + 4, data.size());
836   p += 8;
837   for (Baserel *i = begin; i != end; ++i) {
838     write16le(p, (i->type << 12) | (i->rva - page));
839     p += 2;
840   }
841 }
842
843 void BaserelChunk::writeTo(uint8_t *buf) const {
844   memcpy(buf, data.data(), data.size());
845 }
846
847 uint8_t Baserel::getDefaultType() {
848   switch (config->machine) {
849   case AMD64:
850   case ARM64:
851     return IMAGE_REL_BASED_DIR64;
852   case I386:
853   case ARMNT:
854     return IMAGE_REL_BASED_HIGHLOW;
855   default:
856     llvm_unreachable("unknown machine type");
857   }
858 }
859
860 MergeChunk *MergeChunk::instances[Log2MaxSectionAlignment + 1] = {};
861
862 MergeChunk::MergeChunk(uint32_t alignment)
863     : builder(StringTableBuilder::RAW, alignment) {
864   setAlignment(alignment);
865 }
866
867 void MergeChunk::addSection(SectionChunk *c) {
868   assert(isPowerOf2_32(c->getAlignment()));
869   uint8_t p2Align = llvm::Log2_32(c->getAlignment());
870   assert(p2Align < array_lengthof(instances));
871   auto *&mc = instances[p2Align];
872   if (!mc)
873     mc = make<MergeChunk>(c->getAlignment());
874   mc->sections.push_back(c);
875 }
876
877 void MergeChunk::finalizeContents() {
878   assert(!finalized && "should only finalize once");
879   for (SectionChunk *c : sections)
880     if (c->live)
881       builder.add(toStringRef(c->getContents()));
882   builder.finalize();
883   finalized = true;
884 }
885
886 void MergeChunk::assignSubsectionRVAs() {
887   for (SectionChunk *c : sections) {
888     if (!c->live)
889       continue;
890     size_t off = builder.getOffset(toStringRef(c->getContents()));
891     c->setRVA(rva + off);
892   }
893 }
894
895 uint32_t MergeChunk::getOutputCharacteristics() const {
896   return IMAGE_SCN_MEM_READ | IMAGE_SCN_CNT_INITIALIZED_DATA;
897 }
898
899 size_t MergeChunk::getSize() const {
900   return builder.getSize();
901 }
902
903 void MergeChunk::writeTo(uint8_t *buf) const {
904   builder.write(buf);
905 }
906
907 // MinGW specific.
908 size_t AbsolutePointerChunk::getSize() const { return config->wordsize; }
909
910 void AbsolutePointerChunk::writeTo(uint8_t *buf) const {
911   if (config->is64()) {
912     write64le(buf, value);
913   } else {
914     write32le(buf, value);
915   }
916 }
917
918 } // namespace coff
919 } // namespace lld