1 //===- LinkerScript.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 // This file contains the parser/evaluator of the linker script.
10 //
11 //===----------------------------------------------------------------------===//
12 
13 #include "LinkerScript.h"
14 #include "Config.h"
15 #include "InputSection.h"
16 #include "OutputSections.h"
17 #include "SymbolTable.h"
18 #include "Symbols.h"
19 #include "SyntheticSections.h"
20 #include "Target.h"
21 #include "Writer.h"
22 #include "lld/Common/Memory.h"
23 #include "lld/Common/Strings.h"
24 #include "llvm/ADT/STLExtras.h"
25 #include "llvm/ADT/StringRef.h"
26 #include "llvm/BinaryFormat/ELF.h"
27 #include "llvm/Support/Casting.h"
28 #include "llvm/Support/Endian.h"
29 #include "llvm/Support/ErrorHandling.h"
30 #include "llvm/Support/FileSystem.h"
31 #include "llvm/Support/Parallel.h"
32 #include "llvm/Support/Path.h"
33 #include "llvm/Support/TimeProfiler.h"
34 #include <algorithm>
35 #include <cassert>
36 #include <cstddef>
37 #include <cstdint>
38 #include <iterator>
39 #include <limits>
40 #include <string>
41 #include <vector>
42 
43 using namespace llvm;
44 using namespace llvm::ELF;
45 using namespace llvm::object;
46 using namespace llvm::support::endian;
47 using namespace lld;
48 using namespace lld::elf;
49 
50 LinkerScript *elf::script;
51 
52 static bool isSectionPrefix(StringRef prefix, StringRef name) {
53   return name.startswith(prefix) || name == prefix.drop_back();
54 }
55 
56 static StringRef getOutputSectionName(const InputSectionBase *s) {
57   if (config->relocatable)
58     return s->name;
59 
60   // This is for --emit-relocs. If .text.foo is emitted as .text.bar, we want
61   // to emit .rela.text.foo as .rela.text.bar for consistency (this is not
62   // technically required, but not doing it is odd). This code guarantees that.
63   if (auto *isec = dyn_cast<InputSection>(s)) {
64     if (InputSectionBase *rel = isec->getRelocatedSection()) {
65       OutputSection *out = rel->getOutputSection();
66       if (s->type == SHT_RELA)
67         return saver.save(".rela" + out->name);
68       return saver.save(".rel" + out->name);
69     }
70   }
71 
72   // A BssSection created for a common symbol is identified as "COMMON" in
73   // linker scripts. It should go to .bss section.
74   if (s->name == "COMMON")
75     return ".bss";
76 
77   if (script->hasSectionsCommand)
78     return s->name;
79 
80   // When no SECTIONS is specified, emulate GNU ld's internal linker scripts
81   // by grouping sections with certain prefixes.
82 
83   // GNU ld places text sections with prefix ".text.hot.", ".text.unknown.",
84   // ".text.unlikely.", ".text.startup." or ".text.exit." before others.
85   // We provide an option -z keep-text-section-prefix to group such sections
86   // into separate output sections. This is more flexible. See also
87   // sortISDBySectionOrder().
88   // ".text.unknown" means the hotness of the section is unknown. When
89   // SampleFDO is used, if a function doesn't have sample, it could be very
90   // cold or it could be a new function never being sampled. Those functions
91   // will be kept in the ".text.unknown" section.
92   // ".text.split." holds symbols which are split out from functions in other
93   // input sections. For example, with -fsplit-machine-functions, placing the
94   // cold parts in .text.split instead of .text.unlikely mitigates against poor
95   // profile inaccuracy. Techniques such as hugepage remapping can make
96   // conservative decisions at the section granularity.
97   if (config->zKeepTextSectionPrefix)
98     for (StringRef v : {".text.hot.", ".text.unknown.", ".text.unlikely.",
99                         ".text.startup.", ".text.exit.", ".text.split."})
100       if (isSectionPrefix(v, s->name))
101         return v.drop_back();
102 
103   for (StringRef v :
104        {".text.", ".rodata.", ".data.rel.ro.", ".data.", ".bss.rel.ro.",
105         ".bss.", ".init_array.", ".fini_array.", ".ctors.", ".dtors.", ".tbss.",
106         ".gcc_except_table.", ".tdata.", ".ARM.exidx.", ".ARM.extab."})
107     if (isSectionPrefix(v, s->name))
108       return v.drop_back();
109 
110   return s->name;
111 }
112 
113 uint64_t ExprValue::getValue() const {
114   if (sec)
115     return alignTo(sec->getOutputSection()->addr + sec->getOffset(val),
116                    alignment);
117   return alignTo(val, alignment);
118 }
119 
120 uint64_t ExprValue::getSecAddr() const {
121   return sec ? sec->getOutputSection()->addr + sec->getOffset(0) : 0;
122 }
123 
124 uint64_t ExprValue::getSectionOffset() const {
125   // If the alignment is trivial, we don't have to compute the full
126   // value to know the offset. This allows this function to succeed in
127   // cases where the output section is not yet known.
128   if (alignment == 1 && !sec)
129     return val;
130   return getValue() - getSecAddr();
131 }
132 
133 OutputSection *LinkerScript::createOutputSection(StringRef name,
134                                                  StringRef location) {
135   OutputSection *&secRef = nameToOutputSection[name];
136   OutputSection *sec;
137   if (secRef && secRef->location.empty()) {
138     // There was a forward reference.
139     sec = secRef;
140   } else {
141     sec = make<OutputSection>(name, SHT_PROGBITS, 0);
142     if (!secRef)
143       secRef = sec;
144   }
145   sec->location = std::string(location);
146   return sec;
147 }
148 
149 OutputSection *LinkerScript::getOrCreateOutputSection(StringRef name) {
150   OutputSection *&cmdRef = nameToOutputSection[name];
151   if (!cmdRef)
152     cmdRef = make<OutputSection>(name, SHT_PROGBITS, 0);
153   return cmdRef;
154 }
155 
156 // Expands the memory region by the specified size.
157 static void expandMemoryRegion(MemoryRegion *memRegion, uint64_t size,
158                                StringRef secName) {
159   memRegion->curPos += size;
160   uint64_t newSize = memRegion->curPos - (memRegion->origin)().getValue();
161   uint64_t length = (memRegion->length)().getValue();
162   if (newSize > length)
163     error("section '" + secName + "' will not fit in region '" +
164           memRegion->name + "': overflowed by " + Twine(newSize - length) +
165           " bytes");
166 }
167 
168 void LinkerScript::expandMemoryRegions(uint64_t size) {
169   if (ctx->memRegion)
170     expandMemoryRegion(ctx->memRegion, size, ctx->outSec->name);
171   // Only expand the LMARegion if it is different from memRegion.
172   if (ctx->lmaRegion && ctx->memRegion != ctx->lmaRegion)
173     expandMemoryRegion(ctx->lmaRegion, size, ctx->outSec->name);
174 }
175 
176 void LinkerScript::expandOutputSection(uint64_t size) {
177   ctx->outSec->size += size;
178   expandMemoryRegions(size);
179 }
180 
181 void LinkerScript::setDot(Expr e, const Twine &loc, bool inSec) {
182   uint64_t val = e().getValue();
183   if (val < dot && inSec)
184     error(loc + ": unable to move location counter backward for: " +
185           ctx->outSec->name);
186 
187   // Update to location counter means update to section size.
188   if (inSec)
189     expandOutputSection(val - dot);
190 
191   dot = val;
192 }
193 
194 // Used for handling linker symbol assignments, for both finalizing
195 // their values and doing early declarations. Returns true if symbol
196 // should be defined from linker script.
197 static bool shouldDefineSym(SymbolAssignment *cmd) {
198   if (cmd->name == ".")
199     return false;
200 
201   if (!cmd->provide)
202     return true;
203 
204   // If a symbol was in PROVIDE(), we need to define it only
205   // when it is a referenced undefined symbol.
206   Symbol *b = symtab->find(cmd->name);
207   if (b && !b->isDefined())
208     return true;
209   return false;
210 }
211 
212 // Called by processSymbolAssignments() to assign definitions to
213 // linker-script-defined symbols.
214 void LinkerScript::addSymbol(SymbolAssignment *cmd) {
215   if (!shouldDefineSym(cmd))
216     return;
217 
218   // Define a symbol.
219   ExprValue value = cmd->expression();
220   SectionBase *sec = value.isAbsolute() ? nullptr : value.sec;
221   uint8_t visibility = cmd->hidden ? STV_HIDDEN : STV_DEFAULT;
222 
223   // When this function is called, section addresses have not been
224   // fixed yet. So, we may or may not know the value of the RHS
225   // expression.
226   //
227   // For example, if an expression is `x = 42`, we know x is always 42.
228   // However, if an expression is `x = .`, there's no way to know its
229   // value at the moment.
230   //
231   // We want to set symbol values early if we can. This allows us to
232   // use symbols as variables in linker scripts. Doing so allows us to
233   // write expressions like this: `alignment = 16; . = ALIGN(., alignment)`.
234   uint64_t symValue = value.sec ? 0 : value.getValue();
235 
236   Defined newSym(nullptr, cmd->name, STB_GLOBAL, visibility, value.type,
237                  symValue, 0, sec);
238 
239   Symbol *sym = symtab->insert(cmd->name);
240   sym->mergeProperties(newSym);
241   sym->replace(newSym);
242   cmd->sym = cast<Defined>(sym);
243 }
244 
245 // This function is called from LinkerScript::declareSymbols.
246 // It creates a placeholder symbol if needed.
247 static void declareSymbol(SymbolAssignment *cmd) {
248   if (!shouldDefineSym(cmd))
249     return;
250 
251   uint8_t visibility = cmd->hidden ? STV_HIDDEN : STV_DEFAULT;
252   Defined newSym(nullptr, cmd->name, STB_GLOBAL, visibility, STT_NOTYPE, 0, 0,
253                  nullptr);
254 
255   // We can't calculate final value right now.
256   Symbol *sym = symtab->insert(cmd->name);
257   sym->mergeProperties(newSym);
258   sym->replace(newSym);
259 
260   cmd->sym = cast<Defined>(sym);
261   cmd->provide = false;
262   sym->scriptDefined = true;
263 }
264 
265 using SymbolAssignmentMap =
266     DenseMap<const Defined *, std::pair<SectionBase *, uint64_t>>;
267 
268 // Collect section/value pairs of linker-script-defined symbols. This is used to
269 // check whether symbol values converge.
270 static SymbolAssignmentMap getSymbolAssignmentValues(
271     const std::vector<SectionCommand *> &sectionCommands) {
272   SymbolAssignmentMap ret;
273   for (SectionCommand *cmd : sectionCommands) {
274     if (auto *assign = dyn_cast<SymbolAssignment>(cmd)) {
275       if (assign->sym) // sym is nullptr for dot.
276         ret.try_emplace(assign->sym, std::make_pair(assign->sym->section,
277                                                     assign->sym->value));
278       continue;
279     }
280     for (SectionCommand *subCmd : cast<OutputSection>(cmd)->commands)
281       if (auto *assign = dyn_cast<SymbolAssignment>(subCmd))
282         if (assign->sym)
283           ret.try_emplace(assign->sym, std::make_pair(assign->sym->section,
284                                                       assign->sym->value));
285   }
286   return ret;
287 }
288 
289 // Returns the lexicographical smallest (for determinism) Defined whose
290 // section/value has changed.
291 static const Defined *
292 getChangedSymbolAssignment(const SymbolAssignmentMap &oldValues) {
293   const Defined *changed = nullptr;
294   for (auto &it : oldValues) {
295     const Defined *sym = it.first;
296     if (std::make_pair(sym->section, sym->value) != it.second &&
297         (!changed || sym->getName() < changed->getName()))
298       changed = sym;
299   }
300   return changed;
301 }
302 
303 // Process INSERT [AFTER|BEFORE] commands. For each command, we move the
304 // specified output section to the designated place.
305 void LinkerScript::processInsertCommands() {
306   std::vector<OutputSection *> moves;
307   for (const InsertCommand &cmd : insertCommands) {
308     for (StringRef name : cmd.names) {
309       // If base is empty, it may have been discarded by
310       // adjustSectionsBeforeSorting(). We do not handle such output sections.
311       auto from = llvm::find_if(sectionCommands, [&](SectionCommand *subCmd) {
312         return isa<OutputSection>(subCmd) &&
313                cast<OutputSection>(subCmd)->name == name;
314       });
315       if (from == sectionCommands.end())
316         continue;
317       moves.push_back(cast<OutputSection>(*from));
318       sectionCommands.erase(from);
319     }
320 
321     auto insertPos =
322         llvm::find_if(sectionCommands, [&cmd](SectionCommand *subCmd) {
323           auto *to = dyn_cast<OutputSection>(subCmd);
324           return to != nullptr && to->name == cmd.where;
325         });
326     if (insertPos == sectionCommands.end()) {
327       error("unable to insert " + cmd.names[0] +
328             (cmd.isAfter ? " after " : " before ") + cmd.where);
329     } else {
330       if (cmd.isAfter)
331         ++insertPos;
332       sectionCommands.insert(insertPos, moves.begin(), moves.end());
333     }
334     moves.clear();
335   }
336 }
337 
338 // Symbols defined in script should not be inlined by LTO. At the same time
339 // we don't know their final values until late stages of link. Here we scan
340 // over symbol assignment commands and create placeholder symbols if needed.
341 void LinkerScript::declareSymbols() {
342   assert(!ctx);
343   for (SectionCommand *cmd : sectionCommands) {
344     if (auto *assign = dyn_cast<SymbolAssignment>(cmd)) {
345       declareSymbol(assign);
346       continue;
347     }
348 
349     // If the output section directive has constraints,
350     // we can't say for sure if it is going to be included or not.
351     // Skip such sections for now. Improve the checks if we ever
352     // need symbols from that sections to be declared early.
353     auto *sec = cast<OutputSection>(cmd);
354     if (sec->constraint != ConstraintKind::NoConstraint)
355       continue;
356     for (SectionCommand *cmd : sec->commands)
357       if (auto *assign = dyn_cast<SymbolAssignment>(cmd))
358         declareSymbol(assign);
359   }
360 }
361 
362 // This function is called from assignAddresses, while we are
363 // fixing the output section addresses. This function is supposed
364 // to set the final value for a given symbol assignment.
365 void LinkerScript::assignSymbol(SymbolAssignment *cmd, bool inSec) {
366   if (cmd->name == ".") {
367     setDot(cmd->expression, cmd->location, inSec);
368     return;
369   }
370 
371   if (!cmd->sym)
372     return;
373 
374   ExprValue v = cmd->expression();
375   if (v.isAbsolute()) {
376     cmd->sym->section = nullptr;
377     cmd->sym->value = v.getValue();
378   } else {
379     cmd->sym->section = v.sec;
380     cmd->sym->value = v.getSectionOffset();
381   }
382   cmd->sym->type = v.type;
383 }
384 
385 static inline StringRef getFilename(const InputFile *file) {
386   return file ? file->getNameForScript() : StringRef();
387 }
388 
389 bool InputSectionDescription::matchesFile(const InputFile *file) const {
390   if (filePat.isTrivialMatchAll())
391     return true;
392 
393   if (!matchesFileCache || matchesFileCache->first != file)
394     matchesFileCache.emplace(file, filePat.match(getFilename(file)));
395 
396   return matchesFileCache->second;
397 }
398 
399 bool SectionPattern::excludesFile(const InputFile *file) const {
400   if (excludedFilePat.empty())
401     return false;
402 
403   if (!excludesFileCache || excludesFileCache->first != file)
404     excludesFileCache.emplace(file, excludedFilePat.match(getFilename(file)));
405 
406   return excludesFileCache->second;
407 }
408 
409 bool LinkerScript::shouldKeep(InputSectionBase *s) {
410   for (InputSectionDescription *id : keptSections)
411     if (id->matchesFile(s->file))
412       for (SectionPattern &p : id->sectionPatterns)
413         if (p.sectionPat.match(s->name) &&
414             (s->flags & id->withFlags) == id->withFlags &&
415             (s->flags & id->withoutFlags) == 0)
416           return true;
417   return false;
418 }
419 
420 // A helper function for the SORT() command.
421 static bool matchConstraints(ArrayRef<InputSectionBase *> sections,
422                              ConstraintKind kind) {
423   if (kind == ConstraintKind::NoConstraint)
424     return true;
425 
426   bool isRW = llvm::any_of(
427       sections, [](InputSectionBase *sec) { return sec->flags & SHF_WRITE; });
428 
429   return (isRW && kind == ConstraintKind::ReadWrite) ||
430          (!isRW && kind == ConstraintKind::ReadOnly);
431 }
432 
433 static void sortSections(MutableArrayRef<InputSectionBase *> vec,
434                          SortSectionPolicy k) {
435   auto alignmentComparator = [](InputSectionBase *a, InputSectionBase *b) {
436     // ">" is not a mistake. Sections with larger alignments are placed
437     // before sections with smaller alignments in order to reduce the
438     // amount of padding necessary. This is compatible with GNU.
439     return a->alignment > b->alignment;
440   };
441   auto nameComparator = [](InputSectionBase *a, InputSectionBase *b) {
442     return a->name < b->name;
443   };
444   auto priorityComparator = [](InputSectionBase *a, InputSectionBase *b) {
445     return getPriority(a->name) < getPriority(b->name);
446   };
447 
448   switch (k) {
449   case SortSectionPolicy::Default:
450   case SortSectionPolicy::None:
451     return;
452   case SortSectionPolicy::Alignment:
453     return llvm::stable_sort(vec, alignmentComparator);
454   case SortSectionPolicy::Name:
455     return llvm::stable_sort(vec, nameComparator);
456   case SortSectionPolicy::Priority:
457     return llvm::stable_sort(vec, priorityComparator);
458   }
459 }
460 
461 // Sort sections as instructed by SORT-family commands and --sort-section
462 // option. Because SORT-family commands can be nested at most two depth
463 // (e.g. SORT_BY_NAME(SORT_BY_ALIGNMENT(.text.*))) and because the command
464 // line option is respected even if a SORT command is given, the exact
465 // behavior we have here is a bit complicated. Here are the rules.
466 //
467 // 1. If two SORT commands are given, --sort-section is ignored.
468 // 2. If one SORT command is given, and if it is not SORT_NONE,
469 //    --sort-section is handled as an inner SORT command.
470 // 3. If one SORT command is given, and if it is SORT_NONE, don't sort.
471 // 4. If no SORT command is given, sort according to --sort-section.
472 static void sortInputSections(MutableArrayRef<InputSectionBase *> vec,
473                               SortSectionPolicy outer,
474                               SortSectionPolicy inner) {
475   if (outer == SortSectionPolicy::None)
476     return;
477 
478   if (inner == SortSectionPolicy::Default)
479     sortSections(vec, config->sortSection);
480   else
481     sortSections(vec, inner);
482   sortSections(vec, outer);
483 }
484 
485 // Compute and remember which sections the InputSectionDescription matches.
486 std::vector<InputSectionBase *>
487 LinkerScript::computeInputSections(const InputSectionDescription *cmd,
488                                    ArrayRef<InputSectionBase *> sections) {
489   std::vector<InputSectionBase *> ret;
490   std::vector<size_t> indexes;
491   DenseSet<size_t> seen;
492   auto sortByPositionThenCommandLine = [&](size_t begin, size_t end) {
493     llvm::sort(MutableArrayRef<size_t>(indexes).slice(begin, end - begin));
494     for (size_t i = begin; i != end; ++i)
495       ret[i] = sections[indexes[i]];
496     sortInputSections(
497         MutableArrayRef<InputSectionBase *>(ret).slice(begin, end - begin),
498         config->sortSection, SortSectionPolicy::None);
499   };
500 
501   // Collects all sections that satisfy constraints of Cmd.
502   size_t sizeAfterPrevSort = 0;
503   for (const SectionPattern &pat : cmd->sectionPatterns) {
504     size_t sizeBeforeCurrPat = ret.size();
505 
506     for (size_t i = 0, e = sections.size(); i != e; ++i) {
507       // Skip if the section is dead or has been matched by a previous input
508       // section description or a previous pattern.
509       InputSectionBase *sec = sections[i];
510       if (!sec->isLive() || sec->parent || seen.contains(i))
511         continue;
512 
513       // For --emit-relocs we have to ignore entries like
514       //   .rela.dyn : { *(.rela.data) }
515       // which are common because they are in the default bfd script.
516       // We do not ignore SHT_REL[A] linker-synthesized sections here because
517       // want to support scripts that do custom layout for them.
518       if (isa<InputSection>(sec) &&
519           cast<InputSection>(sec)->getRelocatedSection())
520         continue;
521 
522       // Check the name early to improve performance in the common case.
523       if (!pat.sectionPat.match(sec->name))
524         continue;
525 
526       if (!cmd->matchesFile(sec->file) || pat.excludesFile(sec->file) ||
527           (sec->flags & cmd->withFlags) != cmd->withFlags ||
528           (sec->flags & cmd->withoutFlags) != 0)
529         continue;
530 
531       ret.push_back(sec);
532       indexes.push_back(i);
533       seen.insert(i);
534     }
535 
536     if (pat.sortOuter == SortSectionPolicy::Default)
537       continue;
538 
539     // Matched sections are ordered by radix sort with the keys being (SORT*,
540     // --sort-section, input order), where SORT* (if present) is most
541     // significant.
542     //
543     // Matched sections between the previous SORT* and this SORT* are sorted by
544     // (--sort-alignment, input order).
545     sortByPositionThenCommandLine(sizeAfterPrevSort, sizeBeforeCurrPat);
546     // Matched sections by this SORT* pattern are sorted using all 3 keys.
547     // ret[sizeBeforeCurrPat,ret.size()) are already in the input order, so we
548     // just sort by sortOuter and sortInner.
549     sortInputSections(
550         MutableArrayRef<InputSectionBase *>(ret).slice(sizeBeforeCurrPat),
551         pat.sortOuter, pat.sortInner);
552     sizeAfterPrevSort = ret.size();
553   }
554   // Matched sections after the last SORT* are sorted by (--sort-alignment,
555   // input order).
556   sortByPositionThenCommandLine(sizeAfterPrevSort, ret.size());
557   return ret;
558 }
559 
560 void LinkerScript::discard(InputSectionBase *s) {
561   if (s == in.shStrTab || s == mainPart->relrDyn)
562     error("discarding " + s->name + " section is not allowed");
563 
564   // You can discard .hash and .gnu.hash sections by linker scripts. Since
565   // they are synthesized sections, we need to handle them differently than
566   // other regular sections.
567   if (s == mainPart->gnuHashTab)
568     mainPart->gnuHashTab = nullptr;
569   if (s == mainPart->hashTab)
570     mainPart->hashTab = nullptr;
571 
572   s->markDead();
573   s->parent = nullptr;
574   for (InputSection *ds : s->dependentSections)
575     discard(ds);
576 }
577 
578 void LinkerScript::discardSynthetic(OutputSection &outCmd) {
579   for (Partition &part : partitions) {
580     if (!part.armExidx || !part.armExidx->isLive())
581       continue;
582     std::vector<InputSectionBase *> secs(part.armExidx->exidxSections.begin(),
583                                          part.armExidx->exidxSections.end());
584     for (SectionCommand *cmd : outCmd.commands)
585       if (auto *isd = dyn_cast<InputSectionDescription>(cmd)) {
586         std::vector<InputSectionBase *> matches =
587             computeInputSections(isd, secs);
588         for (InputSectionBase *s : matches)
589           discard(s);
590       }
591   }
592 }
593 
594 std::vector<InputSectionBase *>
595 LinkerScript::createInputSectionList(OutputSection &outCmd) {
596   std::vector<InputSectionBase *> ret;
597 
598   for (SectionCommand *cmd : outCmd.commands) {
599     if (auto *isd = dyn_cast<InputSectionDescription>(cmd)) {
600       isd->sectionBases = computeInputSections(isd, inputSections);
601       for (InputSectionBase *s : isd->sectionBases)
602         s->parent = &outCmd;
603       ret.insert(ret.end(), isd->sectionBases.begin(), isd->sectionBases.end());
604     }
605   }
606   return ret;
607 }
608 
609 // Create output sections described by SECTIONS commands.
610 void LinkerScript::processSectionCommands() {
611   auto process = [this](OutputSection *osec) {
612     std::vector<InputSectionBase *> v = createInputSectionList(*osec);
613 
614     // The output section name `/DISCARD/' is special.
615     // Any input section assigned to it is discarded.
616     if (osec->name == "/DISCARD/") {
617       for (InputSectionBase *s : v)
618         discard(s);
619       discardSynthetic(*osec);
620       osec->commands.clear();
621       return false;
622     }
623 
624     // This is for ONLY_IF_RO and ONLY_IF_RW. An output section directive
625     // ".foo : ONLY_IF_R[OW] { ... }" is handled only if all member input
626     // sections satisfy a given constraint. If not, a directive is handled
627     // as if it wasn't present from the beginning.
628     //
629     // Because we'll iterate over SectionCommands many more times, the easy
630     // way to "make it as if it wasn't present" is to make it empty.
631     if (!matchConstraints(v, osec->constraint)) {
632       for (InputSectionBase *s : v)
633         s->parent = nullptr;
634       osec->commands.clear();
635       return false;
636     }
637 
638     // Handle subalign (e.g. ".foo : SUBALIGN(32) { ... }"). If subalign
639     // is given, input sections are aligned to that value, whether the
640     // given value is larger or smaller than the original section alignment.
641     if (osec->subalignExpr) {
642       uint32_t subalign = osec->subalignExpr().getValue();
643       for (InputSectionBase *s : v)
644         s->alignment = subalign;
645     }
646 
647     // Set the partition field the same way OutputSection::recordSection()
648     // does. Partitions cannot be used with the SECTIONS command, so this is
649     // always 1.
650     osec->partition = 1;
651     return true;
652   };
653 
654   // Process OVERWRITE_SECTIONS first so that it can overwrite the main script
655   // or orphans.
656   DenseMap<StringRef, OutputSection *> map;
657   size_t i = 0;
658   for (OutputSection *osec : overwriteSections)
659     if (process(osec) && !map.try_emplace(osec->name, osec).second)
660       warn("OVERWRITE_SECTIONS specifies duplicate " + osec->name);
661   for (SectionCommand *&base : sectionCommands)
662     if (auto *osec = dyn_cast<OutputSection>(base)) {
663       if (OutputSection *overwrite = map.lookup(osec->name)) {
664         log(overwrite->location + " overwrites " + osec->name);
665         overwrite->sectionIndex = i++;
666         base = overwrite;
667       } else if (process(osec)) {
668         osec->sectionIndex = i++;
669       }
670     }
671 
672   // If an OVERWRITE_SECTIONS specified output section is not in
673   // sectionCommands, append it to the end. The section will be inserted by
674   // orphan placement.
675   for (OutputSection *osec : overwriteSections)
676     if (osec->partition == 1 && osec->sectionIndex == UINT32_MAX)
677       sectionCommands.push_back(osec);
678 }
679 
680 void LinkerScript::processSymbolAssignments() {
681   // Dot outside an output section still represents a relative address, whose
682   // sh_shndx should not be SHN_UNDEF or SHN_ABS. Create a dummy aether section
683   // that fills the void outside a section. It has an index of one, which is
684   // indistinguishable from any other regular section index.
685   aether = make<OutputSection>("", 0, SHF_ALLOC);
686   aether->sectionIndex = 1;
687 
688   // ctx captures the local AddressState and makes it accessible deliberately.
689   // This is needed as there are some cases where we cannot just thread the
690   // current state through to a lambda function created by the script parser.
691   AddressState state;
692   ctx = &state;
693   ctx->outSec = aether;
694 
695   for (SectionCommand *cmd : sectionCommands) {
696     if (auto *assign = dyn_cast<SymbolAssignment>(cmd))
697       addSymbol(assign);
698     else
699       for (SectionCommand *subCmd : cast<OutputSection>(cmd)->commands)
700         if (auto *assign = dyn_cast<SymbolAssignment>(subCmd))
701           addSymbol(assign);
702   }
703 
704   ctx = nullptr;
705 }
706 
707 static OutputSection *findByName(ArrayRef<SectionCommand *> vec,
708                                  StringRef name) {
709   for (SectionCommand *cmd : vec)
710     if (auto *sec = dyn_cast<OutputSection>(cmd))
711       if (sec->name == name)
712         return sec;
713   return nullptr;
714 }
715 
716 static OutputSection *createSection(InputSectionBase *isec,
717                                     StringRef outsecName) {
718   OutputSection *sec = script->createOutputSection(outsecName, "<internal>");
719   sec->recordSection(isec);
720   return sec;
721 }
722 
723 static OutputSection *
724 addInputSec(StringMap<TinyPtrVector<OutputSection *>> &map,
725             InputSectionBase *isec, StringRef outsecName) {
726   // Sections with SHT_GROUP or SHF_GROUP attributes reach here only when the -r
727   // option is given. A section with SHT_GROUP defines a "section group", and
728   // its members have SHF_GROUP attribute. Usually these flags have already been
729   // stripped by InputFiles.cpp as section groups are processed and uniquified.
730   // However, for the -r option, we want to pass through all section groups
731   // as-is because adding/removing members or merging them with other groups
732   // change their semantics.
733   if (isec->type == SHT_GROUP || (isec->flags & SHF_GROUP))
734     return createSection(isec, outsecName);
735 
736   // Imagine .zed : { *(.foo) *(.bar) } script. Both foo and bar may have
737   // relocation sections .rela.foo and .rela.bar for example. Most tools do
738   // not allow multiple REL[A] sections for output section. Hence we
739   // should combine these relocation sections into single output.
740   // We skip synthetic sections because it can be .rela.dyn/.rela.plt or any
741   // other REL[A] sections created by linker itself.
742   if (!isa<SyntheticSection>(isec) &&
743       (isec->type == SHT_REL || isec->type == SHT_RELA)) {
744     auto *sec = cast<InputSection>(isec);
745     OutputSection *out = sec->getRelocatedSection()->getOutputSection();
746 
747     if (out->relocationSection) {
748       out->relocationSection->recordSection(sec);
749       return nullptr;
750     }
751 
752     out->relocationSection = createSection(isec, outsecName);
753     return out->relocationSection;
754   }
755 
756   //  The ELF spec just says
757   // ----------------------------------------------------------------
758   // In the first phase, input sections that match in name, type and
759   // attribute flags should be concatenated into single sections.
760   // ----------------------------------------------------------------
761   //
762   // However, it is clear that at least some flags have to be ignored for
763   // section merging. At the very least SHF_GROUP and SHF_COMPRESSED have to be
764   // ignored. We should not have two output .text sections just because one was
765   // in a group and another was not for example.
766   //
767   // It also seems that wording was a late addition and didn't get the
768   // necessary scrutiny.
769   //
770   // Merging sections with different flags is expected by some users. One
771   // reason is that if one file has
772   //
773   // int *const bar __attribute__((section(".foo"))) = (int *)0;
774   //
775   // gcc with -fPIC will produce a read only .foo section. But if another
776   // file has
777   //
778   // int zed;
779   // int *const bar __attribute__((section(".foo"))) = (int *)&zed;
780   //
781   // gcc with -fPIC will produce a read write section.
782   //
783   // Last but not least, when using linker script the merge rules are forced by
784   // the script. Unfortunately, linker scripts are name based. This means that
785   // expressions like *(.foo*) can refer to multiple input sections with
786   // different flags. We cannot put them in different output sections or we
787   // would produce wrong results for
788   //
789   // start = .; *(.foo.*) end = .; *(.bar)
790   //
791   // and a mapping of .foo1 and .bar1 to one section and .foo2 and .bar2 to
792   // another. The problem is that there is no way to layout those output
793   // sections such that the .foo sections are the only thing between the start
794   // and end symbols.
795   //
796   // Given the above issues, we instead merge sections by name and error on
797   // incompatible types and flags.
798   TinyPtrVector<OutputSection *> &v = map[outsecName];
799   for (OutputSection *sec : v) {
800     if (sec->partition != isec->partition)
801       continue;
802 
803     if (config->relocatable && (isec->flags & SHF_LINK_ORDER)) {
804       // Merging two SHF_LINK_ORDER sections with different sh_link fields will
805       // change their semantics, so we only merge them in -r links if they will
806       // end up being linked to the same output section. The casts are fine
807       // because everything in the map was created by the orphan placement code.
808       auto *firstIsec = cast<InputSectionBase>(
809           cast<InputSectionDescription>(sec->commands[0])->sectionBases[0]);
810       OutputSection *firstIsecOut =
811           firstIsec->flags & SHF_LINK_ORDER
812               ? firstIsec->getLinkOrderDep()->getOutputSection()
813               : nullptr;
814       if (firstIsecOut != isec->getLinkOrderDep()->getOutputSection())
815         continue;
816     }
817 
818     sec->recordSection(isec);
819     return nullptr;
820   }
821 
822   OutputSection *sec = createSection(isec, outsecName);
823   v.push_back(sec);
824   return sec;
825 }
826 
827 // Add sections that didn't match any sections command.
828 void LinkerScript::addOrphanSections() {
829   StringMap<TinyPtrVector<OutputSection *>> map;
830   std::vector<OutputSection *> v;
831 
832   std::function<void(InputSectionBase *)> add;
833   add = [&](InputSectionBase *s) {
834     if (s->isLive() && !s->parent) {
835       orphanSections.push_back(s);
836 
837       StringRef name = getOutputSectionName(s);
838       if (config->unique) {
839         v.push_back(createSection(s, name));
840       } else if (OutputSection *sec = findByName(sectionCommands, name)) {
841         sec->recordSection(s);
842       } else {
843         if (OutputSection *os = addInputSec(map, s, name))
844           v.push_back(os);
845         assert(isa<MergeInputSection>(s) ||
846                s->getOutputSection()->sectionIndex == UINT32_MAX);
847       }
848     }
849 
850     if (config->relocatable)
851       for (InputSectionBase *depSec : s->dependentSections)
852         if (depSec->flags & SHF_LINK_ORDER)
853           add(depSec);
854   };
855 
856   // For further --emit-reloc handling code we need target output section
857   // to be created before we create relocation output section, so we want
858   // to create target sections first. We do not want priority handling
859   // for synthetic sections because them are special.
860   for (InputSectionBase *isec : inputSections) {
861     // In -r links, SHF_LINK_ORDER sections are added while adding their parent
862     // sections because we need to know the parent's output section before we
863     // can select an output section for the SHF_LINK_ORDER section.
864     if (config->relocatable && (isec->flags & SHF_LINK_ORDER))
865       continue;
866 
867     if (auto *sec = dyn_cast<InputSection>(isec))
868       if (InputSectionBase *rel = sec->getRelocatedSection())
869         if (auto *relIS = dyn_cast_or_null<InputSectionBase>(rel->parent))
870           add(relIS);
871     add(isec);
872   }
873 
874   // If no SECTIONS command was given, we should insert sections commands
875   // before others, so that we can handle scripts which refers them,
876   // for example: "foo = ABSOLUTE(ADDR(.text)));".
877   // When SECTIONS command is present we just add all orphans to the end.
878   if (hasSectionsCommand)
879     sectionCommands.insert(sectionCommands.end(), v.begin(), v.end());
880   else
881     sectionCommands.insert(sectionCommands.begin(), v.begin(), v.end());
882 }
883 
884 void LinkerScript::diagnoseOrphanHandling() const {
885   llvm::TimeTraceScope timeScope("Diagnose orphan sections");
886   if (config->orphanHandling == OrphanHandlingPolicy::Place)
887     return;
888   for (const InputSectionBase *sec : orphanSections) {
889     // Input SHT_REL[A] retained by --emit-relocs are ignored by
890     // computeInputSections(). Don't warn/error.
891     if (isa<InputSection>(sec) &&
892         cast<InputSection>(sec)->getRelocatedSection())
893       continue;
894 
895     StringRef name = getOutputSectionName(sec);
896     if (config->orphanHandling == OrphanHandlingPolicy::Error)
897       error(toString(sec) + " is being placed in '" + name + "'");
898     else
899       warn(toString(sec) + " is being placed in '" + name + "'");
900   }
901 }
902 
903 void LinkerScript::switchTo(OutputSection *sec) {
904   ctx->outSec = sec;
905 
906   const uint64_t pos = dot;
907   if (sec->addrExpr && script->hasSectionsCommand) {
908     // The alignment is ignored.
909     ctx->outSec->addr = pos;
910   } else {
911     // ctx->outSec->alignment is the max of ALIGN and the maximum of input
912     // section alignments.
913     dot = alignTo(dot, ctx->outSec->alignment);
914     ctx->outSec->addr = dot;
915     expandMemoryRegions(dot - pos);
916   }
917 }
918 
919 // This function searches for a memory region to place the given output
920 // section in. If found, a pointer to the appropriate memory region is
921 // returned in the first member of the pair. Otherwise, a nullptr is returned.
922 // The second member of the pair is a hint that should be passed to the
923 // subsequent call of this method.
924 std::pair<MemoryRegion *, MemoryRegion *>
925 LinkerScript::findMemoryRegion(OutputSection *sec, MemoryRegion *hint) {
926   // Non-allocatable sections are not part of the process image.
927   if (!(sec->flags & SHF_ALLOC)) {
928     if (!sec->memoryRegionName.empty())
929       warn("ignoring memory region assignment for non-allocatable section '" +
930            sec->name + "'");
931     return {nullptr, nullptr};
932   }
933 
934   // If a memory region name was specified in the output section command,
935   // then try to find that region first.
936   if (!sec->memoryRegionName.empty()) {
937     if (MemoryRegion *m = memoryRegions.lookup(sec->memoryRegionName))
938       return {m, m};
939     error("memory region '" + sec->memoryRegionName + "' not declared");
940     return {nullptr, nullptr};
941   }
942 
943   // If at least one memory region is defined, all sections must
944   // belong to some memory region. Otherwise, we don't need to do
945   // anything for memory regions.
946   if (memoryRegions.empty())
947     return {nullptr, nullptr};
948 
949   // An orphan section should continue the previous memory region.
950   if (sec->sectionIndex == UINT32_MAX && hint)
951     return {hint, hint};
952 
953   // See if a region can be found by matching section flags.
954   for (auto &pair : memoryRegions) {
955     MemoryRegion *m = pair.second;
956     if (m->compatibleWith(sec->flags))
957       return {m, nullptr};
958   }
959 
960   // Otherwise, no suitable region was found.
961   error("no memory region specified for section '" + sec->name + "'");
962   return {nullptr, nullptr};
963 }
964 
965 static OutputSection *findFirstSection(PhdrEntry *load) {
966   for (OutputSection *sec : outputSections)
967     if (sec->ptLoad == load)
968       return sec;
969   return nullptr;
970 }
971 
972 // This function assigns offsets to input sections and an output section
973 // for a single sections command (e.g. ".text { *(.text); }").
974 void LinkerScript::assignOffsets(OutputSection *sec) {
975   const bool isTbss = (sec->flags & SHF_TLS) && sec->type == SHT_NOBITS;
976   const bool sameMemRegion = ctx->memRegion == sec->memRegion;
977   const bool prevLMARegionIsDefault = ctx->lmaRegion == nullptr;
978   const uint64_t savedDot = dot;
979   ctx->memRegion = sec->memRegion;
980   ctx->lmaRegion = sec->lmaRegion;
981 
982   if (!(sec->flags & SHF_ALLOC)) {
983     // Non-SHF_ALLOC sections have zero addresses.
984     dot = 0;
985   } else if (isTbss) {
986     // Allow consecutive SHF_TLS SHT_NOBITS output sections. The address range
987     // starts from the end address of the previous tbss section.
988     if (ctx->tbssAddr == 0)
989       ctx->tbssAddr = dot;
990     else
991       dot = ctx->tbssAddr;
992   } else {
993     if (ctx->memRegion)
994       dot = ctx->memRegion->curPos;
995     if (sec->addrExpr)
996       setDot(sec->addrExpr, sec->location, false);
997 
998     // If the address of the section has been moved forward by an explicit
999     // expression so that it now starts past the current curPos of the enclosing
1000     // region, we need to expand the current region to account for the space
1001     // between the previous section, if any, and the start of this section.
1002     if (ctx->memRegion && ctx->memRegion->curPos < dot)
1003       expandMemoryRegion(ctx->memRegion, dot - ctx->memRegion->curPos,
1004                          sec->name);
1005   }
1006 
1007   switchTo(sec);
1008 
1009   // ctx->lmaOffset is LMA minus VMA. If LMA is explicitly specified via AT() or
1010   // AT>, recompute ctx->lmaOffset; otherwise, if both previous/current LMA
1011   // region is the default, and the two sections are in the same memory region,
1012   // reuse previous lmaOffset; otherwise, reset lmaOffset to 0. This emulates
1013   // heuristics described in
1014   // https://sourceware.org/binutils/docs/ld/Output-Section-LMA.html
1015   if (sec->lmaExpr) {
1016     ctx->lmaOffset = sec->lmaExpr().getValue() - dot;
1017   } else if (MemoryRegion *mr = sec->lmaRegion) {
1018     uint64_t lmaStart = alignTo(mr->curPos, sec->alignment);
1019     if (mr->curPos < lmaStart)
1020       expandMemoryRegion(mr, lmaStart - mr->curPos, sec->name);
1021     ctx->lmaOffset = lmaStart - dot;
1022   } else if (!sameMemRegion || !prevLMARegionIsDefault) {
1023     ctx->lmaOffset = 0;
1024   }
1025 
1026   // Propagate ctx->lmaOffset to the first "non-header" section.
1027   if (PhdrEntry *l = ctx->outSec->ptLoad)
1028     if (sec == findFirstSection(l))
1029       l->lmaOffset = ctx->lmaOffset;
1030 
1031   // We can call this method multiple times during the creation of
1032   // thunks and want to start over calculation each time.
1033   sec->size = 0;
1034 
1035   // We visited SectionsCommands from processSectionCommands to
1036   // layout sections. Now, we visit SectionsCommands again to fix
1037   // section offsets.
1038   for (SectionCommand *cmd : sec->commands) {
1039     // This handles the assignments to symbol or to the dot.
1040     if (auto *assign = dyn_cast<SymbolAssignment>(cmd)) {
1041       assign->addr = dot;
1042       assignSymbol(assign, true);
1043       assign->size = dot - assign->addr;
1044       continue;
1045     }
1046 
1047     // Handle BYTE(), SHORT(), LONG(), or QUAD().
1048     if (auto *data = dyn_cast<ByteCommand>(cmd)) {
1049       data->offset = dot - ctx->outSec->addr;
1050       dot += data->size;
1051       expandOutputSection(data->size);
1052       continue;
1053     }
1054 
1055     // Handle a single input section description command.
1056     // It calculates and assigns the offsets for each section and also
1057     // updates the output section size.
1058     for (InputSection *isec : cast<InputSectionDescription>(cmd)->sections) {
1059       assert(ctx->outSec == isec->getParent());
1060       const uint64_t pos = dot;
1061       dot = alignTo(dot, isec->alignment);
1062       isec->outSecOff = dot - ctx->outSec->addr;
1063       dot += isec->getSize();
1064 
1065       // Update output section size after adding each section. This is so that
1066       // SIZEOF works correctly in the case below:
1067       // .foo { *(.aaa) a = SIZEOF(.foo); *(.bbb) }
1068       expandOutputSection(dot - pos);
1069     }
1070   }
1071 
1072   // Non-SHF_ALLOC sections do not affect the addresses of other OutputSections
1073   // as they are not part of the process image.
1074   if (!(sec->flags & SHF_ALLOC)) {
1075     dot = savedDot;
1076   } else if (isTbss) {
1077     // NOBITS TLS sections are similar. Additionally save the end address.
1078     ctx->tbssAddr = dot;
1079     dot = savedDot;
1080   }
1081 }
1082 
1083 static bool isDiscardable(const OutputSection &sec) {
1084   if (sec.name == "/DISCARD/")
1085     return true;
1086 
1087   // We do not want to remove OutputSections with expressions that reference
1088   // symbols even if the OutputSection is empty. We want to ensure that the
1089   // expressions can be evaluated and report an error if they cannot.
1090   if (sec.expressionsUseSymbols)
1091     return false;
1092 
1093   // OutputSections may be referenced by name in ADDR and LOADADDR expressions,
1094   // as an empty Section can has a valid VMA and LMA we keep the OutputSection
1095   // to maintain the integrity of the other Expression.
1096   if (sec.usedInExpression)
1097     return false;
1098 
1099   for (SectionCommand *cmd : sec.commands) {
1100     if (auto assign = dyn_cast<SymbolAssignment>(cmd))
1101       // Don't create empty output sections just for unreferenced PROVIDE
1102       // symbols.
1103       if (assign->name != "." && !assign->sym)
1104         continue;
1105 
1106     if (!isa<InputSectionDescription>(*cmd))
1107       return false;
1108   }
1109   return true;
1110 }
1111 
1112 bool LinkerScript::isDiscarded(const OutputSection *sec) const {
1113   return hasSectionsCommand && (getFirstInputSection(sec) == nullptr) &&
1114          isDiscardable(*sec);
1115 }
1116 
1117 static void maybePropagatePhdrs(OutputSection &sec,
1118                                 std::vector<StringRef> &phdrs) {
1119   if (sec.phdrs.empty()) {
1120     // To match the bfd linker script behaviour, only propagate program
1121     // headers to sections that are allocated.
1122     if (sec.flags & SHF_ALLOC)
1123       sec.phdrs = phdrs;
1124   } else {
1125     phdrs = sec.phdrs;
1126   }
1127 }
1128 
1129 void LinkerScript::adjustSectionsBeforeSorting() {
1130   // If the output section contains only symbol assignments, create a
1131   // corresponding output section. The issue is what to do with linker script
1132   // like ".foo : { symbol = 42; }". One option would be to convert it to
1133   // "symbol = 42;". That is, move the symbol out of the empty section
1134   // description. That seems to be what bfd does for this simple case. The
1135   // problem is that this is not completely general. bfd will give up and
1136   // create a dummy section too if there is a ". = . + 1" inside the section
1137   // for example.
1138   // Given that we want to create the section, we have to worry what impact
1139   // it will have on the link. For example, if we just create a section with
1140   // 0 for flags, it would change which PT_LOADs are created.
1141   // We could remember that particular section is dummy and ignore it in
1142   // other parts of the linker, but unfortunately there are quite a few places
1143   // that would need to change:
1144   //   * The program header creation.
1145   //   * The orphan section placement.
1146   //   * The address assignment.
1147   // The other option is to pick flags that minimize the impact the section
1148   // will have on the rest of the linker. That is why we copy the flags from
1149   // the previous sections. Only a few flags are needed to keep the impact low.
1150   uint64_t flags = SHF_ALLOC;
1151 
1152   std::vector<StringRef> defPhdrs;
1153   for (SectionCommand *&cmd : sectionCommands) {
1154     auto *sec = dyn_cast<OutputSection>(cmd);
1155     if (!sec)
1156       continue;
1157 
1158     // Handle align (e.g. ".foo : ALIGN(16) { ... }").
1159     if (sec->alignExpr)
1160       sec->alignment =
1161           std::max<uint32_t>(sec->alignment, sec->alignExpr().getValue());
1162 
1163     // The input section might have been removed (if it was an empty synthetic
1164     // section), but we at least know the flags.
1165     if (sec->hasInputSections)
1166       flags = sec->flags;
1167 
1168     // We do not want to keep any special flags for output section
1169     // in case it is empty.
1170     bool isEmpty = (getFirstInputSection(sec) == nullptr);
1171     if (isEmpty)
1172       sec->flags = flags & ((sec->nonAlloc ? 0 : (uint64_t)SHF_ALLOC) |
1173                             SHF_WRITE | SHF_EXECINSTR);
1174 
1175     // The code below may remove empty output sections. We should save the
1176     // specified program headers (if exist) and propagate them to subsequent
1177     // sections which do not specify program headers.
1178     // An example of such a linker script is:
1179     // SECTIONS { .empty : { *(.empty) } :rw
1180     //            .foo : { *(.foo) } }
1181     // Note: at this point the order of output sections has not been finalized,
1182     // because orphans have not been inserted into their expected positions. We
1183     // will handle them in adjustSectionsAfterSorting().
1184     if (sec->sectionIndex != UINT32_MAX)
1185       maybePropagatePhdrs(*sec, defPhdrs);
1186 
1187     if (isEmpty && isDiscardable(*sec)) {
1188       sec->markDead();
1189       cmd = nullptr;
1190     }
1191   }
1192 
1193   // It is common practice to use very generic linker scripts. So for any
1194   // given run some of the output sections in the script will be empty.
1195   // We could create corresponding empty output sections, but that would
1196   // clutter the output.
1197   // We instead remove trivially empty sections. The bfd linker seems even
1198   // more aggressive at removing them.
1199   llvm::erase_if(sectionCommands, [&](SectionCommand *cmd) { return !cmd; });
1200 }
1201 
1202 void LinkerScript::adjustSectionsAfterSorting() {
1203   // Try and find an appropriate memory region to assign offsets in.
1204   MemoryRegion *hint = nullptr;
1205   for (SectionCommand *cmd : sectionCommands) {
1206     if (auto *sec = dyn_cast<OutputSection>(cmd)) {
1207       if (!sec->lmaRegionName.empty()) {
1208         if (MemoryRegion *m = memoryRegions.lookup(sec->lmaRegionName))
1209           sec->lmaRegion = m;
1210         else
1211           error("memory region '" + sec->lmaRegionName + "' not declared");
1212       }
1213       std::tie(sec->memRegion, hint) = findMemoryRegion(sec, hint);
1214     }
1215   }
1216 
1217   // If output section command doesn't specify any segments,
1218   // and we haven't previously assigned any section to segment,
1219   // then we simply assign section to the very first load segment.
1220   // Below is an example of such linker script:
1221   // PHDRS { seg PT_LOAD; }
1222   // SECTIONS { .aaa : { *(.aaa) } }
1223   std::vector<StringRef> defPhdrs;
1224   auto firstPtLoad = llvm::find_if(phdrsCommands, [](const PhdrsCommand &cmd) {
1225     return cmd.type == PT_LOAD;
1226   });
1227   if (firstPtLoad != phdrsCommands.end())
1228     defPhdrs.push_back(firstPtLoad->name);
1229 
1230   // Walk the commands and propagate the program headers to commands that don't
1231   // explicitly specify them.
1232   for (SectionCommand *cmd : sectionCommands)
1233     if (auto *sec = dyn_cast<OutputSection>(cmd))
1234       maybePropagatePhdrs(*sec, defPhdrs);
1235 }
1236 
1237 static uint64_t computeBase(uint64_t min, bool allocateHeaders) {
1238   // If there is no SECTIONS or if the linkerscript is explicit about program
1239   // headers, do our best to allocate them.
1240   if (!script->hasSectionsCommand || allocateHeaders)
1241     return 0;
1242   // Otherwise only allocate program headers if that would not add a page.
1243   return alignDown(min, config->maxPageSize);
1244 }
1245 
1246 // When the SECTIONS command is used, try to find an address for the file and
1247 // program headers output sections, which can be added to the first PT_LOAD
1248 // segment when program headers are created.
1249 //
1250 // We check if the headers fit below the first allocated section. If there isn't
1251 // enough space for these sections, we'll remove them from the PT_LOAD segment,
1252 // and we'll also remove the PT_PHDR segment.
1253 void LinkerScript::allocateHeaders(std::vector<PhdrEntry *> &phdrs) {
1254   uint64_t min = std::numeric_limits<uint64_t>::max();
1255   for (OutputSection *sec : outputSections)
1256     if (sec->flags & SHF_ALLOC)
1257       min = std::min<uint64_t>(min, sec->addr);
1258 
1259   auto it = llvm::find_if(
1260       phdrs, [](const PhdrEntry *e) { return e->p_type == PT_LOAD; });
1261   if (it == phdrs.end())
1262     return;
1263   PhdrEntry *firstPTLoad = *it;
1264 
1265   bool hasExplicitHeaders =
1266       llvm::any_of(phdrsCommands, [](const PhdrsCommand &cmd) {
1267         return cmd.hasPhdrs || cmd.hasFilehdr;
1268       });
1269   bool paged = !config->omagic && !config->nmagic;
1270   uint64_t headerSize = getHeaderSize();
1271   if ((paged || hasExplicitHeaders) &&
1272       headerSize <= min - computeBase(min, hasExplicitHeaders)) {
1273     min = alignDown(min - headerSize, config->maxPageSize);
1274     Out::elfHeader->addr = min;
1275     Out::programHeaders->addr = min + Out::elfHeader->size;
1276     return;
1277   }
1278 
1279   // Error if we were explicitly asked to allocate headers.
1280   if (hasExplicitHeaders)
1281     error("could not allocate headers");
1282 
1283   Out::elfHeader->ptLoad = nullptr;
1284   Out::programHeaders->ptLoad = nullptr;
1285   firstPTLoad->firstSec = findFirstSection(firstPTLoad);
1286 
1287   llvm::erase_if(phdrs,
1288                  [](const PhdrEntry *e) { return e->p_type == PT_PHDR; });
1289 }
1290 
1291 LinkerScript::AddressState::AddressState() {
1292   for (auto &mri : script->memoryRegions) {
1293     MemoryRegion *mr = mri.second;
1294     mr->curPos = (mr->origin)().getValue();
1295   }
1296 }
1297 
1298 // Here we assign addresses as instructed by linker script SECTIONS
1299 // sub-commands. Doing that allows us to use final VA values, so here
1300 // we also handle rest commands like symbol assignments and ASSERTs.
1301 // Returns a symbol that has changed its section or value, or nullptr if no
1302 // symbol has changed.
1303 const Defined *LinkerScript::assignAddresses() {
1304   if (script->hasSectionsCommand) {
1305     // With a linker script, assignment of addresses to headers is covered by
1306     // allocateHeaders().
1307     dot = config->imageBase.getValueOr(0);
1308   } else {
1309     // Assign addresses to headers right now.
1310     dot = target->getImageBase();
1311     Out::elfHeader->addr = dot;
1312     Out::programHeaders->addr = dot + Out::elfHeader->size;
1313     dot += getHeaderSize();
1314   }
1315 
1316   AddressState state;
1317   ctx = &state;
1318   errorOnMissingSection = true;
1319   switchTo(aether);
1320 
1321   SymbolAssignmentMap oldValues = getSymbolAssignmentValues(sectionCommands);
1322   for (SectionCommand *cmd : sectionCommands) {
1323     if (auto *assign = dyn_cast<SymbolAssignment>(cmd)) {
1324       assign->addr = dot;
1325       assignSymbol(assign, false);
1326       assign->size = dot - assign->addr;
1327       continue;
1328     }
1329     assignOffsets(cast<OutputSection>(cmd));
1330   }
1331 
1332   ctx = nullptr;
1333   return getChangedSymbolAssignment(oldValues);
1334 }
1335 
1336 // Creates program headers as instructed by PHDRS linker script command.
1337 std::vector<PhdrEntry *> LinkerScript::createPhdrs() {
1338   std::vector<PhdrEntry *> ret;
1339 
1340   // Process PHDRS and FILEHDR keywords because they are not
1341   // real output sections and cannot be added in the following loop.
1342   for (const PhdrsCommand &cmd : phdrsCommands) {
1343     PhdrEntry *phdr = make<PhdrEntry>(cmd.type, cmd.flags ? *cmd.flags : PF_R);
1344 
1345     if (cmd.hasFilehdr)
1346       phdr->add(Out::elfHeader);
1347     if (cmd.hasPhdrs)
1348       phdr->add(Out::programHeaders);
1349 
1350     if (cmd.lmaExpr) {
1351       phdr->p_paddr = cmd.lmaExpr().getValue();
1352       phdr->hasLMA = true;
1353     }
1354     ret.push_back(phdr);
1355   }
1356 
1357   // Add output sections to program headers.
1358   for (OutputSection *sec : outputSections) {
1359     // Assign headers specified by linker script
1360     for (size_t id : getPhdrIndices(sec)) {
1361       ret[id]->add(sec);
1362       if (!phdrsCommands[id].flags.hasValue())
1363         ret[id]->p_flags |= sec->getPhdrFlags();
1364     }
1365   }
1366   return ret;
1367 }
1368 
1369 // Returns true if we should emit an .interp section.
1370 //
1371 // We usually do. But if PHDRS commands are given, and
1372 // no PT_INTERP is there, there's no place to emit an
1373 // .interp, so we don't do that in that case.
1374 bool LinkerScript::needsInterpSection() {
1375   if (phdrsCommands.empty())
1376     return true;
1377   for (PhdrsCommand &cmd : phdrsCommands)
1378     if (cmd.type == PT_INTERP)
1379       return true;
1380   return false;
1381 }
1382 
1383 ExprValue LinkerScript::getSymbolValue(StringRef name, const Twine &loc) {
1384   if (name == ".") {
1385     if (ctx)
1386       return {ctx->outSec, false, dot - ctx->outSec->addr, loc};
1387     error(loc + ": unable to get location counter value");
1388     return 0;
1389   }
1390 
1391   if (Symbol *sym = symtab->find(name)) {
1392     if (auto *ds = dyn_cast<Defined>(sym)) {
1393       ExprValue v{ds->section, false, ds->value, loc};
1394       // Retain the original st_type, so that the alias will get the same
1395       // behavior in relocation processing. Any operation will reset st_type to
1396       // STT_NOTYPE.
1397       v.type = ds->type;
1398       return v;
1399     }
1400     if (isa<SharedSymbol>(sym))
1401       if (!errorOnMissingSection)
1402         return {nullptr, false, 0, loc};
1403   }
1404 
1405   error(loc + ": symbol not found: " + name);
1406   return 0;
1407 }
1408 
1409 // Returns the index of the segment named Name.
1410 static Optional<size_t> getPhdrIndex(ArrayRef<PhdrsCommand> vec,
1411                                      StringRef name) {
1412   for (size_t i = 0; i < vec.size(); ++i)
1413     if (vec[i].name == name)
1414       return i;
1415   return None;
1416 }
1417 
1418 // Returns indices of ELF headers containing specific section. Each index is a
1419 // zero based number of ELF header listed within PHDRS {} script block.
1420 std::vector<size_t> LinkerScript::getPhdrIndices(OutputSection *cmd) {
1421   std::vector<size_t> ret;
1422 
1423   for (StringRef s : cmd->phdrs) {
1424     if (Optional<size_t> idx = getPhdrIndex(phdrsCommands, s))
1425       ret.push_back(*idx);
1426     else if (s != "NONE")
1427       error(cmd->location + ": program header '" + s +
1428             "' is not listed in PHDRS");
1429   }
1430   return ret;
1431 }
1432