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