1 //===- Relocations.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 platform-independent functions to process relocations. 10 // I'll describe the overview of this file here. 11 // 12 // Simple relocations are easy to handle for the linker. For example, 13 // for R_X86_64_PC64 relocs, the linker just has to fix up locations 14 // with the relative offsets to the target symbols. It would just be 15 // reading records from relocation sections and applying them to output. 16 // 17 // But not all relocations are that easy to handle. For example, for 18 // R_386_GOTOFF relocs, the linker has to create new GOT entries for 19 // symbols if they don't exist, and fix up locations with GOT entry 20 // offsets from the beginning of GOT section. So there is more than 21 // fixing addresses in relocation processing. 22 // 23 // ELF defines a large number of complex relocations. 24 // 25 // The functions in this file analyze relocations and do whatever needs 26 // to be done. It includes, but not limited to, the following. 27 // 28 // - create GOT/PLT entries 29 // - create new relocations in .dynsym to let the dynamic linker resolve 30 // them at runtime (since ELF supports dynamic linking, not all 31 // relocations can be resolved at link-time) 32 // - create COPY relocs and reserve space in .bss 33 // - replace expensive relocs (in terms of runtime cost) with cheap ones 34 // - error out infeasible combinations such as PIC and non-relative relocs 35 // 36 // Note that the functions in this file don't actually apply relocations 37 // because it doesn't know about the output file nor the output file buffer. 38 // It instead stores Relocation objects to InputSection's Relocations 39 // vector to let it apply later in InputSection::writeTo. 40 // 41 //===----------------------------------------------------------------------===// 42 43 #include "Relocations.h" 44 #include "Config.h" 45 #include "LinkerScript.h" 46 #include "OutputSections.h" 47 #include "SymbolTable.h" 48 #include "Symbols.h" 49 #include "SyntheticSections.h" 50 #include "Target.h" 51 #include "Thunks.h" 52 #include "lld/Common/ErrorHandler.h" 53 #include "lld/Common/Memory.h" 54 #include "lld/Common/Strings.h" 55 #include "llvm/ADT/SmallSet.h" 56 #include "llvm/Support/Endian.h" 57 #include "llvm/Support/raw_ostream.h" 58 #include <algorithm> 59 60 using namespace llvm; 61 using namespace llvm::ELF; 62 using namespace llvm::object; 63 using namespace llvm::support::endian; 64 65 using namespace lld; 66 using namespace lld::elf; 67 68 static Optional<std::string> getLinkerScriptLocation(const Symbol &sym) { 69 for (BaseCommand *base : script->sectionCommands) 70 if (auto *cmd = dyn_cast<SymbolAssignment>(base)) 71 if (cmd->sym == &sym) 72 return cmd->location; 73 return None; 74 } 75 76 // Construct a message in the following format. 77 // 78 // >>> defined in /home/alice/src/foo.o 79 // >>> referenced by bar.c:12 (/home/alice/src/bar.c:12) 80 // >>> /home/alice/src/bar.o:(.text+0x1) 81 static std::string getLocation(InputSectionBase &s, const Symbol &sym, 82 uint64_t off) { 83 std::string msg = "\n>>> defined in "; 84 if (sym.file) 85 msg += toString(sym.file); 86 else if (Optional<std::string> loc = getLinkerScriptLocation(sym)) 87 msg += *loc; 88 89 msg += "\n>>> referenced by "; 90 std::string src = s.getSrcMsg(sym, off); 91 if (!src.empty()) 92 msg += src + "\n>>> "; 93 return msg + s.getObjMsg(off); 94 } 95 96 namespace { 97 // Build a bitmask with one bit set for each RelExpr. 98 // 99 // Constexpr function arguments can't be used in static asserts, so we 100 // use template arguments to build the mask. 101 // But function template partial specializations don't exist (needed 102 // for base case of the recursion), so we need a dummy struct. 103 template <RelExpr... Exprs> struct RelExprMaskBuilder { 104 static inline uint64_t build() { return 0; } 105 }; 106 107 // Specialization for recursive case. 108 template <RelExpr Head, RelExpr... Tail> 109 struct RelExprMaskBuilder<Head, Tail...> { 110 static inline uint64_t build() { 111 static_assert(0 <= Head && Head < 64, 112 "RelExpr is too large for 64-bit mask!"); 113 return (uint64_t(1) << Head) | RelExprMaskBuilder<Tail...>::build(); 114 } 115 }; 116 } // namespace 117 118 // Return true if `Expr` is one of `Exprs`. 119 // There are fewer than 64 RelExpr's, so we can represent any set of 120 // RelExpr's as a constant bit mask and test for membership with a 121 // couple cheap bitwise operations. 122 template <RelExpr... Exprs> bool oneof(RelExpr expr) { 123 assert(0 <= expr && (int)expr < 64 && 124 "RelExpr is too large for 64-bit mask!"); 125 return (uint64_t(1) << expr) & RelExprMaskBuilder<Exprs...>::build(); 126 } 127 128 // This function is similar to the `handleTlsRelocation`. MIPS does not 129 // support any relaxations for TLS relocations so by factoring out MIPS 130 // handling in to the separate function we can simplify the code and do not 131 // pollute other `handleTlsRelocation` by MIPS `ifs` statements. 132 // Mips has a custom MipsGotSection that handles the writing of GOT entries 133 // without dynamic relocations. 134 static unsigned handleMipsTlsRelocation(RelType type, Symbol &sym, 135 InputSectionBase &c, uint64_t offset, 136 int64_t addend, RelExpr expr) { 137 if (expr == R_MIPS_TLSLD) { 138 in.mipsGot->addTlsIndex(*c.file); 139 c.relocations.push_back({expr, type, offset, addend, &sym}); 140 return 1; 141 } 142 if (expr == R_MIPS_TLSGD) { 143 in.mipsGot->addDynTlsEntry(*c.file, sym); 144 c.relocations.push_back({expr, type, offset, addend, &sym}); 145 return 1; 146 } 147 return 0; 148 } 149 150 // Notes about General Dynamic and Local Dynamic TLS models below. They may 151 // require the generation of a pair of GOT entries that have associated dynamic 152 // relocations. The pair of GOT entries created are of the form GOT[e0] Module 153 // Index (Used to find pointer to TLS block at run-time) GOT[e1] Offset of 154 // symbol in TLS block. 155 // 156 // Returns the number of relocations processed. 157 template <class ELFT> 158 static unsigned 159 handleTlsRelocation(RelType type, Symbol &sym, InputSectionBase &c, 160 typename ELFT::uint offset, int64_t addend, RelExpr expr) { 161 if (!sym.isTls()) 162 return 0; 163 164 if (config->emachine == EM_MIPS) 165 return handleMipsTlsRelocation(type, sym, c, offset, addend, expr); 166 167 if (oneof<R_AARCH64_TLSDESC_PAGE, R_TLSDESC, R_TLSDESC_CALL, R_TLSDESC_PC>( 168 expr) && 169 config->shared) { 170 if (in.got->addDynTlsEntry(sym)) { 171 uint64_t off = in.got->getGlobalDynOffset(sym); 172 mainPart->relaDyn->addReloc( 173 {target->tlsDescRel, in.got, off, !sym.isPreemptible, &sym, 0}); 174 } 175 if (expr != R_TLSDESC_CALL) 176 c.relocations.push_back({expr, type, offset, addend, &sym}); 177 return 1; 178 } 179 180 bool canRelax = config->emachine != EM_ARM && config->emachine != EM_RISCV; 181 182 // If we are producing an executable and the symbol is non-preemptable, it 183 // must be defined and the code sequence can be relaxed to use Local-Exec. 184 // 185 // ARM and RISC-V do not support any relaxations for TLS relocations, however, 186 // we can omit the DTPMOD dynamic relocations and resolve them at link time 187 // because them are always 1. This may be necessary for static linking as 188 // DTPMOD may not be expected at load time. 189 bool isLocalInExecutable = !sym.isPreemptible && !config->shared; 190 191 // Local Dynamic is for access to module local TLS variables, while still 192 // being suitable for being dynamically loaded via dlopen. GOT[e0] is the 193 // module index, with a special value of 0 for the current module. GOT[e1] is 194 // unused. There only needs to be one module index entry. 195 if (oneof<R_TLSLD_GOT, R_TLSLD_GOTPLT, R_TLSLD_PC, R_TLSLD_HINT>( 196 expr)) { 197 // Local-Dynamic relocs can be relaxed to Local-Exec. 198 if (canRelax && !config->shared) { 199 c.relocations.push_back( 200 {target->adjustRelaxExpr(type, nullptr, R_RELAX_TLS_LD_TO_LE), type, 201 offset, addend, &sym}); 202 return target->getTlsGdRelaxSkip(type); 203 } 204 if (expr == R_TLSLD_HINT) 205 return 1; 206 if (in.got->addTlsIndex()) { 207 if (isLocalInExecutable) 208 in.got->relocations.push_back( 209 {R_ADDEND, target->symbolicRel, in.got->getTlsIndexOff(), 1, &sym}); 210 else 211 mainPart->relaDyn->addReloc(target->tlsModuleIndexRel, in.got, 212 in.got->getTlsIndexOff(), nullptr); 213 } 214 c.relocations.push_back({expr, type, offset, addend, &sym}); 215 return 1; 216 } 217 218 // Local-Dynamic relocs can be relaxed to Local-Exec. 219 if (expr == R_DTPREL && !config->shared) { 220 c.relocations.push_back( 221 {target->adjustRelaxExpr(type, nullptr, R_RELAX_TLS_LD_TO_LE), type, 222 offset, addend, &sym}); 223 return 1; 224 } 225 226 // Local-Dynamic sequence where offset of tls variable relative to dynamic 227 // thread pointer is stored in the got. This cannot be relaxed to Local-Exec. 228 if (expr == R_TLSLD_GOT_OFF) { 229 if (!sym.isInGot()) { 230 in.got->addEntry(sym); 231 uint64_t off = sym.getGotOffset(); 232 in.got->relocations.push_back( 233 {R_ABS, target->tlsOffsetRel, off, 0, &sym}); 234 } 235 c.relocations.push_back({expr, type, offset, addend, &sym}); 236 return 1; 237 } 238 239 if (oneof<R_AARCH64_TLSDESC_PAGE, R_TLSDESC, R_TLSDESC_CALL, R_TLSDESC_PC, 240 R_TLSGD_GOT, R_TLSGD_GOTPLT, R_TLSGD_PC>(expr)) { 241 if (!canRelax || config->shared) { 242 if (in.got->addDynTlsEntry(sym)) { 243 uint64_t off = in.got->getGlobalDynOffset(sym); 244 245 if (isLocalInExecutable) 246 // Write one to the GOT slot. 247 in.got->relocations.push_back( 248 {R_ADDEND, target->symbolicRel, off, 1, &sym}); 249 else 250 mainPart->relaDyn->addReloc(target->tlsModuleIndexRel, in.got, off, &sym); 251 252 // If the symbol is preemptible we need the dynamic linker to write 253 // the offset too. 254 uint64_t offsetOff = off + config->wordsize; 255 if (sym.isPreemptible) 256 mainPart->relaDyn->addReloc(target->tlsOffsetRel, in.got, offsetOff, 257 &sym); 258 else 259 in.got->relocations.push_back( 260 {R_ABS, target->tlsOffsetRel, offsetOff, 0, &sym}); 261 } 262 c.relocations.push_back({expr, type, offset, addend, &sym}); 263 return 1; 264 } 265 266 // Global-Dynamic relocs can be relaxed to Initial-Exec or Local-Exec 267 // depending on the symbol being locally defined or not. 268 if (sym.isPreemptible) { 269 c.relocations.push_back( 270 {target->adjustRelaxExpr(type, nullptr, R_RELAX_TLS_GD_TO_IE), type, 271 offset, addend, &sym}); 272 if (!sym.isInGot()) { 273 in.got->addEntry(sym); 274 mainPart->relaDyn->addReloc(target->tlsGotRel, in.got, sym.getGotOffset(), 275 &sym); 276 } 277 } else { 278 c.relocations.push_back( 279 {target->adjustRelaxExpr(type, nullptr, R_RELAX_TLS_GD_TO_LE), type, 280 offset, addend, &sym}); 281 } 282 return target->getTlsGdRelaxSkip(type); 283 } 284 285 // Initial-Exec relocs can be relaxed to Local-Exec if the symbol is locally 286 // defined. 287 if (oneof<R_GOT, R_GOTPLT, R_GOT_PC, R_AARCH64_GOT_PAGE_PC, R_GOT_OFF, 288 R_TLSIE_HINT>(expr) && 289 canRelax && isLocalInExecutable) { 290 c.relocations.push_back({R_RELAX_TLS_IE_TO_LE, type, offset, addend, &sym}); 291 return 1; 292 } 293 294 if (expr == R_TLSIE_HINT) 295 return 1; 296 return 0; 297 } 298 299 static RelType getMipsPairType(RelType type, bool isLocal) { 300 switch (type) { 301 case R_MIPS_HI16: 302 return R_MIPS_LO16; 303 case R_MIPS_GOT16: 304 // In case of global symbol, the R_MIPS_GOT16 relocation does not 305 // have a pair. Each global symbol has a unique entry in the GOT 306 // and a corresponding instruction with help of the R_MIPS_GOT16 307 // relocation loads an address of the symbol. In case of local 308 // symbol, the R_MIPS_GOT16 relocation creates a GOT entry to hold 309 // the high 16 bits of the symbol's value. A paired R_MIPS_LO16 310 // relocations handle low 16 bits of the address. That allows 311 // to allocate only one GOT entry for every 64 KBytes of local data. 312 return isLocal ? R_MIPS_LO16 : R_MIPS_NONE; 313 case R_MICROMIPS_GOT16: 314 return isLocal ? R_MICROMIPS_LO16 : R_MIPS_NONE; 315 case R_MIPS_PCHI16: 316 return R_MIPS_PCLO16; 317 case R_MICROMIPS_HI16: 318 return R_MICROMIPS_LO16; 319 default: 320 return R_MIPS_NONE; 321 } 322 } 323 324 // True if non-preemptable symbol always has the same value regardless of where 325 // the DSO is loaded. 326 static bool isAbsolute(const Symbol &sym) { 327 if (sym.isUndefWeak()) 328 return true; 329 if (const auto *dr = dyn_cast<Defined>(&sym)) 330 return dr->section == nullptr; // Absolute symbol. 331 return false; 332 } 333 334 static bool isAbsoluteValue(const Symbol &sym) { 335 return isAbsolute(sym) || sym.isTls(); 336 } 337 338 // Returns true if Expr refers a PLT entry. 339 static bool needsPlt(RelExpr expr) { 340 return oneof<R_PLT_PC, R_PPC32_PLTREL, R_PPC64_CALL_PLT, R_PLT>(expr); 341 } 342 343 // Returns true if Expr refers a GOT entry. Note that this function 344 // returns false for TLS variables even though they need GOT, because 345 // TLS variables uses GOT differently than the regular variables. 346 static bool needsGot(RelExpr expr) { 347 return oneof<R_GOT, R_GOT_OFF, R_MIPS_GOT_LOCAL_PAGE, R_MIPS_GOT_OFF, 348 R_MIPS_GOT_OFF32, R_AARCH64_GOT_PAGE_PC, R_GOT_PC, R_GOTPLT>( 349 expr); 350 } 351 352 // True if this expression is of the form Sym - X, where X is a position in the 353 // file (PC, or GOT for example). 354 static bool isRelExpr(RelExpr expr) { 355 return oneof<R_PC, R_GOTREL, R_GOTPLTREL, R_MIPS_GOTREL, R_PPC64_CALL, 356 R_PPC64_RELAX_TOC, R_AARCH64_PAGE_PC, R_RELAX_GOT_PC, 357 R_RISCV_PC_INDIRECT>(expr); 358 } 359 360 // Returns true if a given relocation can be computed at link-time. 361 // 362 // For instance, we know the offset from a relocation to its target at 363 // link-time if the relocation is PC-relative and refers a 364 // non-interposable function in the same executable. This function 365 // will return true for such relocation. 366 // 367 // If this function returns false, that means we need to emit a 368 // dynamic relocation so that the relocation will be fixed at load-time. 369 static bool isStaticLinkTimeConstant(RelExpr e, RelType type, const Symbol &sym, 370 InputSectionBase &s, uint64_t relOff) { 371 // These expressions always compute a constant 372 if (oneof<R_DTPREL, R_GOTPLT, R_GOT_OFF, R_TLSLD_GOT_OFF, 373 R_MIPS_GOT_LOCAL_PAGE, R_MIPS_GOTREL, R_MIPS_GOT_OFF, 374 R_MIPS_GOT_OFF32, R_MIPS_GOT_GP_PC, R_MIPS_TLSGD, 375 R_AARCH64_GOT_PAGE_PC, R_GOT_PC, R_GOTONLY_PC, R_GOTPLTONLY_PC, 376 R_PLT_PC, R_TLSGD_GOT, R_TLSGD_GOTPLT, R_TLSGD_PC, R_PPC32_PLTREL, 377 R_PPC64_CALL_PLT, R_PPC64_RELAX_TOC, R_RISCV_ADD, R_TLSDESC_CALL, 378 R_TLSDESC_PC, R_AARCH64_TLSDESC_PAGE, R_HINT, R_TLSLD_HINT, 379 R_TLSIE_HINT>(e)) 380 return true; 381 382 // These never do, except if the entire file is position dependent or if 383 // only the low bits are used. 384 if (e == R_GOT || e == R_PLT || e == R_TLSDESC) 385 return target->usesOnlyLowPageBits(type) || !config->isPic; 386 387 if (sym.isPreemptible) 388 return false; 389 if (!config->isPic) 390 return true; 391 392 // The size of a non preemptible symbol is a constant. 393 if (e == R_SIZE) 394 return true; 395 396 // For the target and the relocation, we want to know if they are 397 // absolute or relative. 398 bool absVal = isAbsoluteValue(sym); 399 bool relE = isRelExpr(e); 400 if (absVal && !relE) 401 return true; 402 if (!absVal && relE) 403 return true; 404 if (!absVal && !relE) 405 return target->usesOnlyLowPageBits(type); 406 407 // Relative relocation to an absolute value. This is normally unrepresentable, 408 // but if the relocation refers to a weak undefined symbol, we allow it to 409 // resolve to the image base. This is a little strange, but it allows us to 410 // link function calls to such symbols. Normally such a call will be guarded 411 // with a comparison, which will load a zero from the GOT. 412 // Another special case is MIPS _gp_disp symbol which represents offset 413 // between start of a function and '_gp' value and defined as absolute just 414 // to simplify the code. 415 assert(absVal && relE); 416 if (sym.isUndefWeak()) 417 return true; 418 419 // We set the final symbols values for linker script defined symbols later. 420 // They always can be computed as a link time constant. 421 if (sym.scriptDefined) 422 return true; 423 424 error("relocation " + toString(type) + " cannot refer to absolute symbol: " + 425 toString(sym) + getLocation(s, sym, relOff)); 426 return true; 427 } 428 429 static RelExpr toPlt(RelExpr expr) { 430 switch (expr) { 431 case R_PPC64_CALL: 432 return R_PPC64_CALL_PLT; 433 case R_PC: 434 return R_PLT_PC; 435 case R_ABS: 436 return R_PLT; 437 default: 438 return expr; 439 } 440 } 441 442 static RelExpr fromPlt(RelExpr expr) { 443 // We decided not to use a plt. Optimize a reference to the plt to a 444 // reference to the symbol itself. 445 switch (expr) { 446 case R_PLT_PC: 447 case R_PPC32_PLTREL: 448 return R_PC; 449 case R_PPC64_CALL_PLT: 450 return R_PPC64_CALL; 451 case R_PLT: 452 return R_ABS; 453 default: 454 return expr; 455 } 456 } 457 458 // Returns true if a given shared symbol is in a read-only segment in a DSO. 459 template <class ELFT> static bool isReadOnly(SharedSymbol &ss) { 460 using Elf_Phdr = typename ELFT::Phdr; 461 462 // Determine if the symbol is read-only by scanning the DSO's program headers. 463 const SharedFile &file = ss.getFile(); 464 for (const Elf_Phdr &phdr : 465 check(file.template getObj<ELFT>().program_headers())) 466 if ((phdr.p_type == ELF::PT_LOAD || phdr.p_type == ELF::PT_GNU_RELRO) && 467 !(phdr.p_flags & ELF::PF_W) && ss.value >= phdr.p_vaddr && 468 ss.value < phdr.p_vaddr + phdr.p_memsz) 469 return true; 470 return false; 471 } 472 473 // Returns symbols at the same offset as a given symbol, including SS itself. 474 // 475 // If two or more symbols are at the same offset, and at least one of 476 // them are copied by a copy relocation, all of them need to be copied. 477 // Otherwise, they would refer to different places at runtime. 478 template <class ELFT> 479 static SmallSet<SharedSymbol *, 4> getSymbolsAt(SharedSymbol &ss) { 480 using Elf_Sym = typename ELFT::Sym; 481 482 SharedFile &file = ss.getFile(); 483 484 SmallSet<SharedSymbol *, 4> ret; 485 for (const Elf_Sym &s : file.template getGlobalELFSyms<ELFT>()) { 486 if (s.st_shndx == SHN_UNDEF || s.st_shndx == SHN_ABS || 487 s.getType() == STT_TLS || s.st_value != ss.value) 488 continue; 489 StringRef name = check(s.getName(file.getStringTable())); 490 Symbol *sym = symtab->find(name); 491 if (auto *alias = dyn_cast_or_null<SharedSymbol>(sym)) 492 ret.insert(alias); 493 } 494 return ret; 495 } 496 497 // When a symbol is copy relocated or we create a canonical plt entry, it is 498 // effectively a defined symbol. In the case of copy relocation the symbol is 499 // in .bss and in the case of a canonical plt entry it is in .plt. This function 500 // replaces the existing symbol with a Defined pointing to the appropriate 501 // location. 502 static void replaceWithDefined(Symbol &sym, SectionBase *sec, uint64_t value, 503 uint64_t size) { 504 Symbol old = sym; 505 506 sym.replace(Defined{sym.file, sym.getName(), sym.binding, sym.stOther, 507 sym.type, value, size, sec}); 508 509 sym.pltIndex = old.pltIndex; 510 sym.gotIndex = old.gotIndex; 511 sym.verdefIndex = old.verdefIndex; 512 sym.ppc64BranchltIndex = old.ppc64BranchltIndex; 513 sym.exportDynamic = true; 514 sym.isUsedInRegularObj = true; 515 } 516 517 // Reserve space in .bss or .bss.rel.ro for copy relocation. 518 // 519 // The copy relocation is pretty much a hack. If you use a copy relocation 520 // in your program, not only the symbol name but the symbol's size, RW/RO 521 // bit and alignment become part of the ABI. In addition to that, if the 522 // symbol has aliases, the aliases become part of the ABI. That's subtle, 523 // but if you violate that implicit ABI, that can cause very counter- 524 // intuitive consequences. 525 // 526 // So, what is the copy relocation? It's for linking non-position 527 // independent code to DSOs. In an ideal world, all references to data 528 // exported by DSOs should go indirectly through GOT. But if object files 529 // are compiled as non-PIC, all data references are direct. There is no 530 // way for the linker to transform the code to use GOT, as machine 531 // instructions are already set in stone in object files. This is where 532 // the copy relocation takes a role. 533 // 534 // A copy relocation instructs the dynamic linker to copy data from a DSO 535 // to a specified address (which is usually in .bss) at load-time. If the 536 // static linker (that's us) finds a direct data reference to a DSO 537 // symbol, it creates a copy relocation, so that the symbol can be 538 // resolved as if it were in .bss rather than in a DSO. 539 // 540 // As you can see in this function, we create a copy relocation for the 541 // dynamic linker, and the relocation contains not only symbol name but 542 // various other informtion about the symbol. So, such attributes become a 543 // part of the ABI. 544 // 545 // Note for application developers: I can give you a piece of advice if 546 // you are writing a shared library. You probably should export only 547 // functions from your library. You shouldn't export variables. 548 // 549 // As an example what can happen when you export variables without knowing 550 // the semantics of copy relocations, assume that you have an exported 551 // variable of type T. It is an ABI-breaking change to add new members at 552 // end of T even though doing that doesn't change the layout of the 553 // existing members. That's because the space for the new members are not 554 // reserved in .bss unless you recompile the main program. That means they 555 // are likely to overlap with other data that happens to be laid out next 556 // to the variable in .bss. This kind of issue is sometimes very hard to 557 // debug. What's a solution? Instead of exporting a varaible V from a DSO, 558 // define an accessor getV(). 559 template <class ELFT> static void addCopyRelSymbol(SharedSymbol &ss) { 560 // Copy relocation against zero-sized symbol doesn't make sense. 561 uint64_t symSize = ss.getSize(); 562 if (symSize == 0 || ss.alignment == 0) 563 fatal("cannot create a copy relocation for symbol " + toString(ss)); 564 565 // See if this symbol is in a read-only segment. If so, preserve the symbol's 566 // memory protection by reserving space in the .bss.rel.ro section. 567 bool isRO = isReadOnly<ELFT>(ss); 568 BssSection *sec = 569 make<BssSection>(isRO ? ".bss.rel.ro" : ".bss", symSize, ss.alignment); 570 OutputSection *osec = (isRO ? in.bssRelRo : in.bss)->getParent(); 571 572 // At this point, sectionBases has been migrated to sections. Append sec to 573 // sections. 574 if (osec->sectionCommands.empty() || 575 !isa<InputSectionDescription>(osec->sectionCommands.back())) 576 osec->sectionCommands.push_back(make<InputSectionDescription>("")); 577 auto *isd = cast<InputSectionDescription>(osec->sectionCommands.back()); 578 isd->sections.push_back(sec); 579 osec->commitSection(sec); 580 581 // Look through the DSO's dynamic symbol table for aliases and create a 582 // dynamic symbol for each one. This causes the copy relocation to correctly 583 // interpose any aliases. 584 for (SharedSymbol *sym : getSymbolsAt<ELFT>(ss)) 585 replaceWithDefined(*sym, sec, 0, sym->size); 586 587 mainPart->relaDyn->addReloc(target->copyRel, sec, 0, &ss); 588 } 589 590 // MIPS has an odd notion of "paired" relocations to calculate addends. 591 // For example, if a relocation is of R_MIPS_HI16, there must be a 592 // R_MIPS_LO16 relocation after that, and an addend is calculated using 593 // the two relocations. 594 template <class ELFT, class RelTy> 595 static int64_t computeMipsAddend(const RelTy &rel, const RelTy *end, 596 InputSectionBase &sec, RelExpr expr, 597 bool isLocal) { 598 if (expr == R_MIPS_GOTREL && isLocal) 599 return sec.getFile<ELFT>()->mipsGp0; 600 601 // The ABI says that the paired relocation is used only for REL. 602 // See p. 4-17 at ftp://www.linux-mips.org/pub/linux/mips/doc/ABI/mipsabi.pdf 603 if (RelTy::IsRela) 604 return 0; 605 606 RelType type = rel.getType(config->isMips64EL); 607 uint32_t pairTy = getMipsPairType(type, isLocal); 608 if (pairTy == R_MIPS_NONE) 609 return 0; 610 611 const uint8_t *buf = sec.data().data(); 612 uint32_t symIndex = rel.getSymbol(config->isMips64EL); 613 614 // To make things worse, paired relocations might not be contiguous in 615 // the relocation table, so we need to do linear search. *sigh* 616 for (const RelTy *ri = &rel; ri != end; ++ri) 617 if (ri->getType(config->isMips64EL) == pairTy && 618 ri->getSymbol(config->isMips64EL) == symIndex) 619 return target->getImplicitAddend(buf + ri->r_offset, pairTy); 620 621 warn("can't find matching " + toString(pairTy) + " relocation for " + 622 toString(type)); 623 return 0; 624 } 625 626 // Returns an addend of a given relocation. If it is RELA, an addend 627 // is in a relocation itself. If it is REL, we need to read it from an 628 // input section. 629 template <class ELFT, class RelTy> 630 static int64_t computeAddend(const RelTy &rel, const RelTy *end, 631 InputSectionBase &sec, RelExpr expr, 632 bool isLocal) { 633 int64_t addend; 634 RelType type = rel.getType(config->isMips64EL); 635 636 if (RelTy::IsRela) { 637 addend = getAddend<ELFT>(rel); 638 } else { 639 const uint8_t *buf = sec.data().data(); 640 addend = target->getImplicitAddend(buf + rel.r_offset, type); 641 } 642 643 if (config->emachine == EM_PPC64 && config->isPic && type == R_PPC64_TOC) 644 addend += getPPC64TocBase(); 645 if (config->emachine == EM_MIPS) 646 addend += computeMipsAddend<ELFT>(rel, end, sec, expr, isLocal); 647 648 return addend; 649 } 650 651 // Custom error message if Sym is defined in a discarded section. 652 template <class ELFT> 653 static std::string maybeReportDiscarded(Undefined &sym) { 654 auto *file = dyn_cast_or_null<ObjFile<ELFT>>(sym.file); 655 if (!file || !sym.discardedSecIdx || 656 file->getSections()[sym.discardedSecIdx] != &InputSection::discarded) 657 return ""; 658 ArrayRef<Elf_Shdr_Impl<ELFT>> objSections = 659 CHECK(file->getObj().sections(), file); 660 661 std::string msg; 662 if (sym.type == ELF::STT_SECTION) { 663 msg = "relocation refers to a discarded section: "; 664 msg += CHECK( 665 file->getObj().getSectionName(&objSections[sym.discardedSecIdx]), file); 666 } else { 667 msg = "relocation refers to a symbol in a discarded section: " + 668 toString(sym); 669 } 670 msg += "\n>>> defined in " + toString(file); 671 672 Elf_Shdr_Impl<ELFT> elfSec = objSections[sym.discardedSecIdx - 1]; 673 if (elfSec.sh_type != SHT_GROUP) 674 return msg; 675 676 // If the discarded section is a COMDAT. 677 StringRef signature = file->getShtGroupSignature(objSections, elfSec); 678 if (const InputFile *prevailing = 679 symtab->comdatGroups.lookup(CachedHashStringRef(signature))) 680 msg += "\n>>> section group signature: " + signature.str() + 681 "\n>>> prevailing definition is in " + toString(prevailing); 682 return msg; 683 } 684 685 // Undefined diagnostics are collected in a vector and emitted once all of 686 // them are known, so that some postprocessing on the list of undefined symbols 687 // can happen before lld emits diagnostics. 688 struct UndefinedDiag { 689 Symbol *sym; 690 struct Loc { 691 InputSectionBase *sec; 692 uint64_t offset; 693 }; 694 std::vector<Loc> locs; 695 bool isWarning; 696 }; 697 698 static std::vector<UndefinedDiag> undefs; 699 700 // Suggest an alternative spelling of an "undefined symbol" diagnostic. Returns 701 // the suggested symbol, which is either in the symbol table, or in the same 702 // file of sym. 703 static const Symbol *getAlternativeSpelling(const Undefined &sym) { 704 // Build a map of local defined symbols. 705 DenseMap<StringRef, const Symbol *> map; 706 if (sym.file && !isa<SharedFile>(sym.file)) { 707 for (const Symbol *s : sym.file->getSymbols()) 708 if (s->isLocal() && s->isDefined()) 709 map.try_emplace(s->getName(), s); 710 } 711 712 auto suggest = [&](StringRef newName) -> const Symbol * { 713 // If defined locally. 714 if (const Symbol *s = map.lookup(newName)) 715 return s; 716 717 // If in the symbol table and not undefined. 718 if (const Symbol *s = symtab->find(newName)) 719 if (!s->isUndefined()) 720 return s; 721 722 return nullptr; 723 }; 724 725 // This loop enumerates all strings of Levenshtein distance 1 as typo 726 // correction candidates and suggests the one that exists as a non-undefined 727 // symbol. 728 StringRef name = sym.getName(); 729 for (size_t i = 0, e = name.size(); i != e + 1; ++i) { 730 // Insert a character before name[i]. 731 std::string newName = (name.substr(0, i) + "0" + name.substr(i)).str(); 732 for (char c = '0'; c <= 'z'; ++c) { 733 newName[i] = c; 734 if (const Symbol *s = suggest(newName)) 735 return s; 736 } 737 if (i == e) 738 break; 739 740 // Substitute name[i]. 741 newName = name; 742 for (char c = '0'; c <= 'z'; ++c) { 743 newName[i] = c; 744 if (const Symbol *s = suggest(newName)) 745 return s; 746 } 747 748 // Transpose name[i] and name[i+1]. This is of edit distance 2 but it is 749 // common. 750 if (i + 1 < e) { 751 newName[i] = name[i + 1]; 752 newName[i + 1] = name[i]; 753 if (const Symbol *s = suggest(newName)) 754 return s; 755 } 756 757 // Delete name[i]. 758 newName = (name.substr(0, i) + name.substr(i + 1)).str(); 759 if (const Symbol *s = suggest(newName)) 760 return s; 761 } 762 763 return nullptr; 764 } 765 766 template <class ELFT> 767 static void reportUndefinedSymbol(const UndefinedDiag &undef, 768 bool correctSpelling) { 769 Symbol &sym = *undef.sym; 770 771 auto visibility = [&]() -> std::string { 772 switch (sym.visibility) { 773 case STV_INTERNAL: 774 return "internal "; 775 case STV_HIDDEN: 776 return "hidden "; 777 case STV_PROTECTED: 778 return "protected "; 779 default: 780 return ""; 781 } 782 }; 783 784 std::string msg = maybeReportDiscarded<ELFT>(cast<Undefined>(sym)); 785 if (msg.empty()) 786 msg = "undefined " + visibility() + "symbol: " + toString(sym); 787 788 const size_t maxUndefReferences = 10; 789 size_t i = 0; 790 for (UndefinedDiag::Loc l : undef.locs) { 791 if (i >= maxUndefReferences) 792 break; 793 InputSectionBase &sec = *l.sec; 794 uint64_t offset = l.offset; 795 796 msg += "\n>>> referenced by "; 797 std::string src = sec.getSrcMsg(sym, offset); 798 if (!src.empty()) 799 msg += src + "\n>>> "; 800 msg += sec.getObjMsg(offset); 801 i++; 802 } 803 804 if (i < undef.locs.size()) 805 msg += ("\n>>> referenced " + Twine(undef.locs.size() - i) + " more times") 806 .str(); 807 808 if (correctSpelling) 809 if (const Symbol *corrected = 810 getAlternativeSpelling(cast<Undefined>(sym))) { 811 msg += "\n>>> did you mean: " + toString(*corrected); 812 if (corrected->file) 813 msg += "\n>>> defined in: " + toString(corrected->file); 814 } 815 816 if (sym.getName().startswith("_ZTV")) 817 msg += "\nthe vtable symbol may be undefined because the class is missing " 818 "its key function (see https://lld.llvm.org/missingkeyfunction)"; 819 820 if (undef.isWarning) 821 warn(msg); 822 else 823 error(msg); 824 } 825 826 template <class ELFT> void elf::reportUndefinedSymbols() { 827 // Find the first "undefined symbol" diagnostic for each diagnostic, and 828 // collect all "referenced from" lines at the first diagnostic. 829 DenseMap<Symbol *, UndefinedDiag *> firstRef; 830 for (UndefinedDiag &undef : undefs) { 831 assert(undef.locs.size() == 1); 832 if (UndefinedDiag *canon = firstRef.lookup(undef.sym)) { 833 canon->locs.push_back(undef.locs[0]); 834 undef.locs.clear(); 835 } else 836 firstRef[undef.sym] = &undef; 837 } 838 839 // Enable spell corrector for the first 2 diagnostics. 840 for (auto it : enumerate(undefs)) 841 if (!it.value().locs.empty()) 842 reportUndefinedSymbol<ELFT>(it.value(), it.index() < 2); 843 undefs.clear(); 844 } 845 846 // Report an undefined symbol if necessary. 847 // Returns true if the undefined symbol will produce an error message. 848 static bool maybeReportUndefined(Symbol &sym, InputSectionBase &sec, 849 uint64_t offset) { 850 if (!sym.isUndefined() || sym.isWeak()) 851 return false; 852 853 bool canBeExternal = !sym.isLocal() && sym.visibility == STV_DEFAULT; 854 if (config->unresolvedSymbols == UnresolvedPolicy::Ignore && canBeExternal) 855 return false; 856 857 // clang (as of 2019-06-12) / gcc (as of 8.2.1) PPC64 may emit a .rela.toc 858 // which references a switch table in a discarded .rodata/.text section. The 859 // .toc and the .rela.toc are incorrectly not placed in the comdat. The ELF 860 // spec says references from outside the group to a STB_LOCAL symbol are not 861 // allowed. Work around the bug. 862 if (config->emachine == EM_PPC64 && 863 cast<Undefined>(sym).discardedSecIdx != 0 && sec.name == ".toc") 864 return false; 865 866 bool isWarning = 867 (config->unresolvedSymbols == UnresolvedPolicy::Warn && canBeExternal) || 868 config->noinhibitExec; 869 undefs.push_back({&sym, {{&sec, offset}}, isWarning}); 870 return !isWarning; 871 } 872 873 // MIPS N32 ABI treats series of successive relocations with the same offset 874 // as a single relocation. The similar approach used by N64 ABI, but this ABI 875 // packs all relocations into the single relocation record. Here we emulate 876 // this for the N32 ABI. Iterate over relocation with the same offset and put 877 // theirs types into the single bit-set. 878 template <class RelTy> static RelType getMipsN32RelType(RelTy *&rel, RelTy *end) { 879 RelType type = 0; 880 uint64_t offset = rel->r_offset; 881 882 int n = 0; 883 while (rel != end && rel->r_offset == offset) 884 type |= (rel++)->getType(config->isMips64EL) << (8 * n++); 885 return type; 886 } 887 888 // .eh_frame sections are mergeable input sections, so their input 889 // offsets are not linearly mapped to output section. For each input 890 // offset, we need to find a section piece containing the offset and 891 // add the piece's base address to the input offset to compute the 892 // output offset. That isn't cheap. 893 // 894 // This class is to speed up the offset computation. When we process 895 // relocations, we access offsets in the monotonically increasing 896 // order. So we can optimize for that access pattern. 897 // 898 // For sections other than .eh_frame, this class doesn't do anything. 899 namespace { 900 class OffsetGetter { 901 public: 902 explicit OffsetGetter(InputSectionBase &sec) { 903 if (auto *eh = dyn_cast<EhInputSection>(&sec)) 904 pieces = eh->pieces; 905 } 906 907 // Translates offsets in input sections to offsets in output sections. 908 // Given offset must increase monotonically. We assume that Piece is 909 // sorted by inputOff. 910 uint64_t get(uint64_t off) { 911 if (pieces.empty()) 912 return off; 913 914 while (i != pieces.size() && pieces[i].inputOff + pieces[i].size <= off) 915 ++i; 916 if (i == pieces.size()) 917 fatal(".eh_frame: relocation is not in any piece"); 918 919 // Pieces must be contiguous, so there must be no holes in between. 920 assert(pieces[i].inputOff <= off && "Relocation not in any piece"); 921 922 // Offset -1 means that the piece is dead (i.e. garbage collected). 923 if (pieces[i].outputOff == -1) 924 return -1; 925 return pieces[i].outputOff + off - pieces[i].inputOff; 926 } 927 928 private: 929 ArrayRef<EhSectionPiece> pieces; 930 size_t i = 0; 931 }; 932 } // namespace 933 934 static void addRelativeReloc(InputSectionBase *isec, uint64_t offsetInSec, 935 Symbol *sym, int64_t addend, RelExpr expr, 936 RelType type) { 937 Partition &part = isec->getPartition(); 938 939 // Add a relative relocation. If relrDyn section is enabled, and the 940 // relocation offset is guaranteed to be even, add the relocation to 941 // the relrDyn section, otherwise add it to the relaDyn section. 942 // relrDyn sections don't support odd offsets. Also, relrDyn sections 943 // don't store the addend values, so we must write it to the relocated 944 // address. 945 if (part.relrDyn && isec->alignment >= 2 && offsetInSec % 2 == 0) { 946 isec->relocations.push_back({expr, type, offsetInSec, addend, sym}); 947 part.relrDyn->relocs.push_back({isec, offsetInSec}); 948 return; 949 } 950 part.relaDyn->addReloc(target->relativeRel, isec, offsetInSec, sym, addend, 951 expr, type); 952 } 953 954 template <class ELFT, class GotPltSection> 955 static void addPltEntry(PltSection *plt, GotPltSection *gotPlt, 956 RelocationBaseSection *rel, RelType type, Symbol &sym) { 957 plt->addEntry<ELFT>(sym); 958 gotPlt->addEntry(sym); 959 rel->addReloc( 960 {type, gotPlt, sym.getGotPltOffset(), !sym.isPreemptible, &sym, 0}); 961 } 962 963 static void addGotEntry(Symbol &sym) { 964 in.got->addEntry(sym); 965 966 RelExpr expr = sym.isTls() ? R_TLS : R_ABS; 967 uint64_t off = sym.getGotOffset(); 968 969 // If a GOT slot value can be calculated at link-time, which is now, 970 // we can just fill that out. 971 // 972 // (We don't actually write a value to a GOT slot right now, but we 973 // add a static relocation to a Relocations vector so that 974 // InputSection::relocate will do the work for us. We may be able 975 // to just write a value now, but it is a TODO.) 976 bool isLinkTimeConstant = 977 !sym.isPreemptible && (!config->isPic || isAbsolute(sym)); 978 if (isLinkTimeConstant) { 979 in.got->relocations.push_back({expr, target->symbolicRel, off, 0, &sym}); 980 return; 981 } 982 983 // Otherwise, we emit a dynamic relocation to .rel[a].dyn so that 984 // the GOT slot will be fixed at load-time. 985 if (!sym.isTls() && !sym.isPreemptible && config->isPic && !isAbsolute(sym)) { 986 addRelativeReloc(in.got, off, &sym, 0, R_ABS, target->symbolicRel); 987 return; 988 } 989 mainPart->relaDyn->addReloc( 990 sym.isTls() ? target->tlsGotRel : target->gotRel, in.got, off, &sym, 0, 991 sym.isPreemptible ? R_ADDEND : R_ABS, target->symbolicRel); 992 } 993 994 // Return true if we can define a symbol in the executable that 995 // contains the value/function of a symbol defined in a shared 996 // library. 997 static bool canDefineSymbolInExecutable(Symbol &sym) { 998 // If the symbol has default visibility the symbol defined in the 999 // executable will preempt it. 1000 // Note that we want the visibility of the shared symbol itself, not 1001 // the visibility of the symbol in the output file we are producing. That is 1002 // why we use Sym.stOther. 1003 if ((sym.stOther & 0x3) == STV_DEFAULT) 1004 return true; 1005 1006 // If we are allowed to break address equality of functions, defining 1007 // a plt entry will allow the program to call the function in the 1008 // .so, but the .so and the executable will no agree on the address 1009 // of the function. Similar logic for objects. 1010 return ((sym.isFunc() && config->ignoreFunctionAddressEquality) || 1011 (sym.isObject() && config->ignoreDataAddressEquality)); 1012 } 1013 1014 // The reason we have to do this early scan is as follows 1015 // * To mmap the output file, we need to know the size 1016 // * For that, we need to know how many dynamic relocs we will have. 1017 // It might be possible to avoid this by outputting the file with write: 1018 // * Write the allocated output sections, computing addresses. 1019 // * Apply relocations, recording which ones require a dynamic reloc. 1020 // * Write the dynamic relocations. 1021 // * Write the rest of the file. 1022 // This would have some drawbacks. For example, we would only know if .rela.dyn 1023 // is needed after applying relocations. If it is, it will go after rw and rx 1024 // sections. Given that it is ro, we will need an extra PT_LOAD. This 1025 // complicates things for the dynamic linker and means we would have to reserve 1026 // space for the extra PT_LOAD even if we end up not using it. 1027 template <class ELFT, class RelTy> 1028 static void processRelocAux(InputSectionBase &sec, RelExpr expr, RelType type, 1029 uint64_t offset, Symbol &sym, const RelTy &rel, 1030 int64_t addend) { 1031 // If the relocation is known to be a link-time constant, we know no dynamic 1032 // relocation will be created, pass the control to relocateAlloc() or 1033 // relocateNonAlloc() to resolve it. 1034 // 1035 // The behavior of an undefined weak reference is implementation defined. If 1036 // the relocation is to a weak undef, and we are producing an executable, let 1037 // relocate{,Non}Alloc() resolve it. 1038 if (isStaticLinkTimeConstant(expr, type, sym, sec, offset) || 1039 (!config->shared && sym.isUndefWeak())) { 1040 sec.relocations.push_back({expr, type, offset, addend, &sym}); 1041 return; 1042 } 1043 1044 bool canWrite = (sec.flags & SHF_WRITE) || !config->zText; 1045 if (canWrite) { 1046 RelType rel = target->getDynRel(type); 1047 if (expr == R_GOT || (rel == target->symbolicRel && !sym.isPreemptible)) { 1048 addRelativeReloc(&sec, offset, &sym, addend, expr, type); 1049 return; 1050 } else if (rel != 0) { 1051 if (config->emachine == EM_MIPS && rel == target->symbolicRel) 1052 rel = target->relativeRel; 1053 sec.getPartition().relaDyn->addReloc(rel, &sec, offset, &sym, addend, 1054 R_ADDEND, type); 1055 1056 // MIPS ABI turns using of GOT and dynamic relocations inside out. 1057 // While regular ABI uses dynamic relocations to fill up GOT entries 1058 // MIPS ABI requires dynamic linker to fills up GOT entries using 1059 // specially sorted dynamic symbol table. This affects even dynamic 1060 // relocations against symbols which do not require GOT entries 1061 // creation explicitly, i.e. do not have any GOT-relocations. So if 1062 // a preemptible symbol has a dynamic relocation we anyway have 1063 // to create a GOT entry for it. 1064 // If a non-preemptible symbol has a dynamic relocation against it, 1065 // dynamic linker takes it st_value, adds offset and writes down 1066 // result of the dynamic relocation. In case of preemptible symbol 1067 // dynamic linker performs symbol resolution, writes the symbol value 1068 // to the GOT entry and reads the GOT entry when it needs to perform 1069 // a dynamic relocation. 1070 // ftp://www.linux-mips.org/pub/linux/mips/doc/ABI/mipsabi.pdf p.4-19 1071 if (config->emachine == EM_MIPS) 1072 in.mipsGot->addEntry(*sec.file, sym, addend, expr); 1073 return; 1074 } 1075 } 1076 1077 // When producing an executable, we can perform copy relocations (for 1078 // STT_OBJECT) and canonical PLT (for STT_FUNC). 1079 if (!config->shared) { 1080 if (!canDefineSymbolInExecutable(sym)) { 1081 errorOrWarn("cannot preempt symbol: " + toString(sym) + 1082 getLocation(sec, sym, offset)); 1083 return; 1084 } 1085 1086 if (sym.isObject()) { 1087 // Produce a copy relocation. 1088 if (auto *ss = dyn_cast<SharedSymbol>(&sym)) { 1089 if (!config->zCopyreloc) 1090 error("unresolvable relocation " + toString(type) + 1091 " against symbol '" + toString(*ss) + 1092 "'; recompile with -fPIC or remove '-z nocopyreloc'" + 1093 getLocation(sec, sym, offset)); 1094 addCopyRelSymbol<ELFT>(*ss); 1095 } 1096 sec.relocations.push_back({expr, type, offset, addend, &sym}); 1097 return; 1098 } 1099 1100 // This handles a non PIC program call to function in a shared library. In 1101 // an ideal world, we could just report an error saying the relocation can 1102 // overflow at runtime. In the real world with glibc, crt1.o has a 1103 // R_X86_64_PC32 pointing to libc.so. 1104 // 1105 // The general idea on how to handle such cases is to create a PLT entry and 1106 // use that as the function value. 1107 // 1108 // For the static linking part, we just return a plt expr and everything 1109 // else will use the PLT entry as the address. 1110 // 1111 // The remaining problem is making sure pointer equality still works. We 1112 // need the help of the dynamic linker for that. We let it know that we have 1113 // a direct reference to a so symbol by creating an undefined symbol with a 1114 // non zero st_value. Seeing that, the dynamic linker resolves the symbol to 1115 // the value of the symbol we created. This is true even for got entries, so 1116 // pointer equality is maintained. To avoid an infinite loop, the only entry 1117 // that points to the real function is a dedicated got entry used by the 1118 // plt. That is identified by special relocation types (R_X86_64_JUMP_SLOT, 1119 // R_386_JMP_SLOT, etc). 1120 1121 // For position independent executable on i386, the plt entry requires ebx 1122 // to be set. This causes two problems: 1123 // * If some code has a direct reference to a function, it was probably 1124 // compiled without -fPIE/-fPIC and doesn't maintain ebx. 1125 // * If a library definition gets preempted to the executable, it will have 1126 // the wrong ebx value. 1127 if (sym.isFunc()) { 1128 if (config->pie && config->emachine == EM_386) 1129 errorOrWarn("symbol '" + toString(sym) + 1130 "' cannot be preempted; recompile with -fPIE" + 1131 getLocation(sec, sym, offset)); 1132 if (!sym.isInPlt()) 1133 addPltEntry<ELFT>(in.plt, in.gotPlt, in.relaPlt, target->pltRel, sym); 1134 if (!sym.isDefined()) 1135 replaceWithDefined( 1136 sym, in.plt, 1137 target->pltHeaderSize + target->pltEntrySize * sym.pltIndex, 0); 1138 sym.needsPltAddr = true; 1139 sec.relocations.push_back({expr, type, offset, addend, &sym}); 1140 return; 1141 } 1142 } 1143 1144 if (config->isPic) { 1145 if (!canWrite && !isRelExpr(expr)) 1146 errorOrWarn( 1147 "can't create dynamic relocation " + toString(type) + " against " + 1148 (sym.getName().empty() ? "local symbol" 1149 : "symbol: " + toString(sym)) + 1150 " in readonly segment; recompile object files with -fPIC " 1151 "or pass '-Wl,-z,notext' to allow text relocations in the output" + 1152 getLocation(sec, sym, offset)); 1153 else 1154 errorOrWarn( 1155 "relocation " + toString(type) + " cannot be used against " + 1156 (sym.getName().empty() ? "local symbol" : "symbol " + toString(sym)) + 1157 "; recompile with -fPIC" + getLocation(sec, sym, offset)); 1158 return; 1159 } 1160 1161 errorOrWarn("symbol '" + toString(sym) + "' has no type" + 1162 getLocation(sec, sym, offset)); 1163 } 1164 1165 template <class ELFT, class RelTy> 1166 static void scanReloc(InputSectionBase &sec, OffsetGetter &getOffset, RelTy *&i, 1167 RelTy *end) { 1168 const RelTy &rel = *i; 1169 uint32_t symIndex = rel.getSymbol(config->isMips64EL); 1170 Symbol &sym = sec.getFile<ELFT>()->getSymbol(symIndex); 1171 RelType type; 1172 1173 // Deal with MIPS oddity. 1174 if (config->mipsN32Abi) { 1175 type = getMipsN32RelType(i, end); 1176 } else { 1177 type = rel.getType(config->isMips64EL); 1178 ++i; 1179 } 1180 1181 // Get an offset in an output section this relocation is applied to. 1182 uint64_t offset = getOffset.get(rel.r_offset); 1183 if (offset == uint64_t(-1)) 1184 return; 1185 1186 // Error if the target symbol is undefined. Symbol index 0 may be used by 1187 // marker relocations, e.g. R_*_NONE and R_ARM_V4BX. Don't error on them. 1188 if (symIndex != 0 && maybeReportUndefined(sym, sec, rel.r_offset)) 1189 return; 1190 1191 const uint8_t *relocatedAddr = sec.data().begin() + rel.r_offset; 1192 RelExpr expr = target->getRelExpr(type, sym, relocatedAddr); 1193 1194 // Ignore "hint" relocations because they are only markers for relaxation. 1195 if (oneof<R_HINT, R_NONE>(expr)) 1196 return; 1197 1198 // We can separate the small code model relocations into 2 categories: 1199 // 1) Those that access the compiler generated .toc sections. 1200 // 2) Those that access the linker allocated got entries. 1201 // lld allocates got entries to symbols on demand. Since we don't try to sort 1202 // the got entries in any way, we don't have to track which objects have 1203 // got-based small code model relocs. The .toc sections get placed after the 1204 // end of the linker allocated .got section and we do sort those so sections 1205 // addressed with small code model relocations come first. 1206 if (config->emachine == EM_PPC64 && isPPC64SmallCodeModelTocReloc(type)) 1207 sec.file->ppc64SmallCodeModelTocRelocs = true; 1208 1209 if (sym.isGnuIFunc() && !config->zText && config->warnIfuncTextrel) { 1210 warn("using ifunc symbols when text relocations are allowed may produce " 1211 "a binary that will segfault, if the object file is linked with " 1212 "old version of glibc (glibc 2.28 and earlier). If this applies to " 1213 "you, consider recompiling the object files without -fPIC and " 1214 "without -Wl,-z,notext option. Use -no-warn-ifunc-textrel to " 1215 "turn off this warning." + 1216 getLocation(sec, sym, offset)); 1217 } 1218 1219 // Read an addend. 1220 int64_t addend = computeAddend<ELFT>(rel, end, sec, expr, sym.isLocal()); 1221 1222 // Relax relocations. 1223 // 1224 // If we know that a PLT entry will be resolved within the same ELF module, we 1225 // can skip PLT access and directly jump to the destination function. For 1226 // example, if we are linking a main exectuable, all dynamic symbols that can 1227 // be resolved within the executable will actually be resolved that way at 1228 // runtime, because the main exectuable is always at the beginning of a search 1229 // list. We can leverage that fact. 1230 if (!sym.isPreemptible && (!sym.isGnuIFunc() || config->zIfuncNoplt)) { 1231 if (expr == R_GOT_PC && !isAbsoluteValue(sym)) { 1232 expr = target->adjustRelaxExpr(type, relocatedAddr, expr); 1233 } else { 1234 // Addend of R_PPC_PLTREL24 is used to choose call stub type. It should be 1235 // ignored if optimized to R_PC. 1236 if (config->emachine == EM_PPC && expr == R_PPC32_PLTREL) 1237 addend = 0; 1238 expr = fromPlt(expr); 1239 } 1240 } 1241 1242 // If the relocation does not emit a GOT or GOTPLT entry but its computation 1243 // uses their addresses, we need GOT or GOTPLT to be created. 1244 // 1245 // The 4 types that relative GOTPLT are all x86 and x86-64 specific. 1246 if (oneof<R_GOTPLTONLY_PC, R_GOTPLTREL, R_GOTPLT, R_TLSGD_GOTPLT>(expr)) { 1247 in.gotPlt->hasGotPltOffRel = true; 1248 } else if (oneof<R_GOTONLY_PC, R_GOTREL, R_PPC64_TOCBASE, R_PPC64_RELAX_TOC>( 1249 expr)) { 1250 in.got->hasGotOffRel = true; 1251 } 1252 1253 // Process some TLS relocations, including relaxing TLS relocations. 1254 // Note that this function does not handle all TLS relocations. 1255 if (unsigned processed = 1256 handleTlsRelocation<ELFT>(type, sym, sec, offset, addend, expr)) { 1257 i += (processed - 1); 1258 return; 1259 } 1260 1261 // We were asked not to generate PLT entries for ifuncs. Instead, pass the 1262 // direct relocation on through. 1263 if (sym.isGnuIFunc() && config->zIfuncNoplt) { 1264 sym.exportDynamic = true; 1265 mainPart->relaDyn->addReloc(type, &sec, offset, &sym, addend, R_ADDEND, type); 1266 return; 1267 } 1268 1269 // Non-preemptible ifuncs require special handling. First, handle the usual 1270 // case where the symbol isn't one of these. 1271 if (!sym.isGnuIFunc() || sym.isPreemptible) { 1272 // If a relocation needs PLT, we create PLT and GOTPLT slots for the symbol. 1273 if (needsPlt(expr) && !sym.isInPlt()) 1274 addPltEntry<ELFT>(in.plt, in.gotPlt, in.relaPlt, target->pltRel, sym); 1275 1276 // Create a GOT slot if a relocation needs GOT. 1277 if (needsGot(expr)) { 1278 if (config->emachine == EM_MIPS) { 1279 // MIPS ABI has special rules to process GOT entries and doesn't 1280 // require relocation entries for them. A special case is TLS 1281 // relocations. In that case dynamic loader applies dynamic 1282 // relocations to initialize TLS GOT entries. 1283 // See "Global Offset Table" in Chapter 5 in the following document 1284 // for detailed description: 1285 // ftp://www.linux-mips.org/pub/linux/mips/doc/ABI/mipsabi.pdf 1286 in.mipsGot->addEntry(*sec.file, sym, addend, expr); 1287 } else if (!sym.isInGot()) { 1288 addGotEntry(sym); 1289 } 1290 } 1291 } else { 1292 // Handle a reference to a non-preemptible ifunc. These are special in a 1293 // few ways: 1294 // 1295 // - Unlike most non-preemptible symbols, non-preemptible ifuncs do not have 1296 // a fixed value. But assuming that all references to the ifunc are 1297 // GOT-generating or PLT-generating, the handling of an ifunc is 1298 // relatively straightforward. We create a PLT entry in Iplt, which is 1299 // usually at the end of .plt, which makes an indirect call using a 1300 // matching GOT entry in igotPlt, which is usually at the end of .got.plt. 1301 // The GOT entry is relocated using an IRELATIVE relocation in relaIplt, 1302 // which is usually at the end of .rela.plt. Unlike most relocations in 1303 // .rela.plt, which may be evaluated lazily without -z now, dynamic 1304 // loaders evaluate IRELATIVE relocs eagerly, which means that for 1305 // IRELATIVE relocs only, GOT-generating relocations can point directly to 1306 // .got.plt without requiring a separate GOT entry. 1307 // 1308 // - Despite the fact that an ifunc does not have a fixed value, compilers 1309 // that are not passed -fPIC will assume that they do, and will emit 1310 // direct (non-GOT-generating, non-PLT-generating) relocations to the 1311 // symbol. This means that if a direct relocation to the symbol is 1312 // seen, the linker must set a value for the symbol, and this value must 1313 // be consistent no matter what type of reference is made to the symbol. 1314 // This can be done by creating a PLT entry for the symbol in the way 1315 // described above and making it canonical, that is, making all references 1316 // point to the PLT entry instead of the resolver. In lld we also store 1317 // the address of the PLT entry in the dynamic symbol table, which means 1318 // that the symbol will also have the same value in other modules. 1319 // Because the value loaded from the GOT needs to be consistent with 1320 // the value computed using a direct relocation, a non-preemptible ifunc 1321 // may end up with two GOT entries, one in .got.plt that points to the 1322 // address returned by the resolver and is used only by the PLT entry, 1323 // and another in .got that points to the PLT entry and is used by 1324 // GOT-generating relocations. 1325 // 1326 // - The fact that these symbols do not have a fixed value makes them an 1327 // exception to the general rule that a statically linked executable does 1328 // not require any form of dynamic relocation. To handle these relocations 1329 // correctly, the IRELATIVE relocations are stored in an array which a 1330 // statically linked executable's startup code must enumerate using the 1331 // linker-defined symbols __rela?_iplt_{start,end}. 1332 if (!sym.isInPlt()) { 1333 // Create PLT and GOTPLT slots for the symbol. 1334 sym.isInIplt = true; 1335 1336 // Create a copy of the symbol to use as the target of the IRELATIVE 1337 // relocation in the igotPlt. This is in case we make the PLT canonical 1338 // later, which would overwrite the original symbol. 1339 // 1340 // FIXME: Creating a copy of the symbol here is a bit of a hack. All 1341 // that's really needed to create the IRELATIVE is the section and value, 1342 // so ideally we should just need to copy those. 1343 auto *directSym = make<Defined>(cast<Defined>(sym)); 1344 addPltEntry<ELFT>(in.iplt, in.igotPlt, in.relaIplt, target->iRelativeRel, 1345 *directSym); 1346 sym.pltIndex = directSym->pltIndex; 1347 } 1348 if (needsGot(expr)) { 1349 // Redirect GOT accesses to point to the Igot. 1350 // 1351 // This field is also used to keep track of whether we ever needed a GOT 1352 // entry. If we did and we make the PLT canonical later, we'll need to 1353 // create a GOT entry pointing to the PLT entry for Sym. 1354 sym.gotInIgot = true; 1355 } else if (!needsPlt(expr)) { 1356 // Make the ifunc's PLT entry canonical by changing the value of its 1357 // symbol to redirect all references to point to it. 1358 unsigned entryOffset = sym.pltIndex * target->pltEntrySize; 1359 if (config->zRetpolineplt) 1360 entryOffset += target->pltHeaderSize; 1361 1362 auto &d = cast<Defined>(sym); 1363 d.section = in.iplt; 1364 d.value = entryOffset; 1365 d.size = 0; 1366 // It's important to set the symbol type here so that dynamic loaders 1367 // don't try to call the PLT as if it were an ifunc resolver. 1368 d.type = STT_FUNC; 1369 1370 if (sym.gotInIgot) { 1371 // We previously encountered a GOT generating reference that we 1372 // redirected to the Igot. Now that the PLT entry is canonical we must 1373 // clear the redirection to the Igot and add a GOT entry. As we've 1374 // changed the symbol type to STT_FUNC future GOT generating references 1375 // will naturally use this GOT entry. 1376 // 1377 // We don't need to worry about creating a MIPS GOT here because ifuncs 1378 // aren't a thing on MIPS. 1379 sym.gotInIgot = false; 1380 addGotEntry(sym); 1381 } 1382 } 1383 } 1384 1385 processRelocAux<ELFT>(sec, expr, type, offset, sym, rel, addend); 1386 } 1387 1388 template <class ELFT, class RelTy> 1389 static void scanRelocs(InputSectionBase &sec, ArrayRef<RelTy> rels) { 1390 OffsetGetter getOffset(sec); 1391 1392 // Not all relocations end up in Sec.Relocations, but a lot do. 1393 sec.relocations.reserve(rels.size()); 1394 1395 for (auto i = rels.begin(), end = rels.end(); i != end;) 1396 scanReloc<ELFT>(sec, getOffset, i, end); 1397 1398 // Sort relocations by offset for more efficient searching for 1399 // R_RISCV_PCREL_HI20 and R_PPC64_ADDR64. 1400 if (config->emachine == EM_RISCV || 1401 (config->emachine == EM_PPC64 && sec.name == ".toc")) 1402 llvm::stable_sort(sec.relocations, 1403 [](const Relocation &lhs, const Relocation &rhs) { 1404 return lhs.offset < rhs.offset; 1405 }); 1406 } 1407 1408 template <class ELFT> void elf::scanRelocations(InputSectionBase &s) { 1409 if (s.areRelocsRela) 1410 scanRelocs<ELFT>(s, s.relas<ELFT>()); 1411 else 1412 scanRelocs<ELFT>(s, s.rels<ELFT>()); 1413 } 1414 1415 static bool mergeCmp(const InputSection *a, const InputSection *b) { 1416 // std::merge requires a strict weak ordering. 1417 if (a->outSecOff < b->outSecOff) 1418 return true; 1419 1420 if (a->outSecOff == b->outSecOff) { 1421 auto *ta = dyn_cast<ThunkSection>(a); 1422 auto *tb = dyn_cast<ThunkSection>(b); 1423 1424 // Check if Thunk is immediately before any specific Target 1425 // InputSection for example Mips LA25 Thunks. 1426 if (ta && ta->getTargetInputSection() == b) 1427 return true; 1428 1429 // Place Thunk Sections without specific targets before 1430 // non-Thunk Sections. 1431 if (ta && !tb && !ta->getTargetInputSection()) 1432 return true; 1433 } 1434 1435 return false; 1436 } 1437 1438 // Call Fn on every executable InputSection accessed via the linker script 1439 // InputSectionDescription::Sections. 1440 static void forEachInputSectionDescription( 1441 ArrayRef<OutputSection *> outputSections, 1442 llvm::function_ref<void(OutputSection *, InputSectionDescription *)> fn) { 1443 for (OutputSection *os : outputSections) { 1444 if (!(os->flags & SHF_ALLOC) || !(os->flags & SHF_EXECINSTR)) 1445 continue; 1446 for (BaseCommand *bc : os->sectionCommands) 1447 if (auto *isd = dyn_cast<InputSectionDescription>(bc)) 1448 fn(os, isd); 1449 } 1450 } 1451 1452 // Thunk Implementation 1453 // 1454 // Thunks (sometimes called stubs, veneers or branch islands) are small pieces 1455 // of code that the linker inserts inbetween a caller and a callee. The thunks 1456 // are added at link time rather than compile time as the decision on whether 1457 // a thunk is needed, such as the caller and callee being out of range, can only 1458 // be made at link time. 1459 // 1460 // It is straightforward to tell given the current state of the program when a 1461 // thunk is needed for a particular call. The more difficult part is that 1462 // the thunk needs to be placed in the program such that the caller can reach 1463 // the thunk and the thunk can reach the callee; furthermore, adding thunks to 1464 // the program alters addresses, which can mean more thunks etc. 1465 // 1466 // In lld we have a synthetic ThunkSection that can hold many Thunks. 1467 // The decision to have a ThunkSection act as a container means that we can 1468 // more easily handle the most common case of a single block of contiguous 1469 // Thunks by inserting just a single ThunkSection. 1470 // 1471 // The implementation of Thunks in lld is split across these areas 1472 // Relocations.cpp : Framework for creating and placing thunks 1473 // Thunks.cpp : The code generated for each supported thunk 1474 // Target.cpp : Target specific hooks that the framework uses to decide when 1475 // a thunk is used 1476 // Synthetic.cpp : Implementation of ThunkSection 1477 // Writer.cpp : Iteratively call framework until no more Thunks added 1478 // 1479 // Thunk placement requirements: 1480 // Mips LA25 thunks. These must be placed immediately before the callee section 1481 // We can assume that the caller is in range of the Thunk. These are modelled 1482 // by Thunks that return the section they must precede with 1483 // getTargetInputSection(). 1484 // 1485 // ARM interworking and range extension thunks. These thunks must be placed 1486 // within range of the caller. All implemented ARM thunks can always reach the 1487 // callee as they use an indirect jump via a register that has no range 1488 // restrictions. 1489 // 1490 // Thunk placement algorithm: 1491 // For Mips LA25 ThunkSections; the placement is explicit, it has to be before 1492 // getTargetInputSection(). 1493 // 1494 // For thunks that must be placed within range of the caller there are many 1495 // possible choices given that the maximum range from the caller is usually 1496 // much larger than the average InputSection size. Desirable properties include: 1497 // - Maximize reuse of thunks by multiple callers 1498 // - Minimize number of ThunkSections to simplify insertion 1499 // - Handle impact of already added Thunks on addresses 1500 // - Simple to understand and implement 1501 // 1502 // In lld for the first pass, we pre-create one or more ThunkSections per 1503 // InputSectionDescription at Target specific intervals. A ThunkSection is 1504 // placed so that the estimated end of the ThunkSection is within range of the 1505 // start of the InputSectionDescription or the previous ThunkSection. For 1506 // example: 1507 // InputSectionDescription 1508 // Section 0 1509 // ... 1510 // Section N 1511 // ThunkSection 0 1512 // Section N + 1 1513 // ... 1514 // Section N + K 1515 // Thunk Section 1 1516 // 1517 // The intention is that we can add a Thunk to a ThunkSection that is well 1518 // spaced enough to service a number of callers without having to do a lot 1519 // of work. An important principle is that it is not an error if a Thunk cannot 1520 // be placed in a pre-created ThunkSection; when this happens we create a new 1521 // ThunkSection placed next to the caller. This allows us to handle the vast 1522 // majority of thunks simply, but also handle rare cases where the branch range 1523 // is smaller than the target specific spacing. 1524 // 1525 // The algorithm is expected to create all the thunks that are needed in a 1526 // single pass, with a small number of programs needing a second pass due to 1527 // the insertion of thunks in the first pass increasing the offset between 1528 // callers and callees that were only just in range. 1529 // 1530 // A consequence of allowing new ThunkSections to be created outside of the 1531 // pre-created ThunkSections is that in rare cases calls to Thunks that were in 1532 // range in pass K, are out of range in some pass > K due to the insertion of 1533 // more Thunks in between the caller and callee. When this happens we retarget 1534 // the relocation back to the original target and create another Thunk. 1535 1536 // Remove ThunkSections that are empty, this should only be the initial set 1537 // precreated on pass 0. 1538 1539 // Insert the Thunks for OutputSection OS into their designated place 1540 // in the Sections vector, and recalculate the InputSection output section 1541 // offsets. 1542 // This may invalidate any output section offsets stored outside of InputSection 1543 void ThunkCreator::mergeThunks(ArrayRef<OutputSection *> outputSections) { 1544 forEachInputSectionDescription( 1545 outputSections, [&](OutputSection *os, InputSectionDescription *isd) { 1546 if (isd->thunkSections.empty()) 1547 return; 1548 1549 // Remove any zero sized precreated Thunks. 1550 llvm::erase_if(isd->thunkSections, 1551 [](const std::pair<ThunkSection *, uint32_t> &ts) { 1552 return ts.first->getSize() == 0; 1553 }); 1554 1555 // ISD->ThunkSections contains all created ThunkSections, including 1556 // those inserted in previous passes. Extract the Thunks created this 1557 // pass and order them in ascending outSecOff. 1558 std::vector<ThunkSection *> newThunks; 1559 for (const std::pair<ThunkSection *, uint32_t> ts : isd->thunkSections) 1560 if (ts.second == pass) 1561 newThunks.push_back(ts.first); 1562 llvm::stable_sort(newThunks, 1563 [](const ThunkSection *a, const ThunkSection *b) { 1564 return a->outSecOff < b->outSecOff; 1565 }); 1566 1567 // Merge sorted vectors of Thunks and InputSections by outSecOff 1568 std::vector<InputSection *> tmp; 1569 tmp.reserve(isd->sections.size() + newThunks.size()); 1570 1571 std::merge(isd->sections.begin(), isd->sections.end(), 1572 newThunks.begin(), newThunks.end(), std::back_inserter(tmp), 1573 mergeCmp); 1574 1575 isd->sections = std::move(tmp); 1576 }); 1577 } 1578 1579 // Find or create a ThunkSection within the InputSectionDescription (ISD) that 1580 // is in range of Src. An ISD maps to a range of InputSections described by a 1581 // linker script section pattern such as { .text .text.* }. 1582 ThunkSection *ThunkCreator::getISDThunkSec(OutputSection *os, InputSection *isec, 1583 InputSectionDescription *isd, 1584 uint32_t type, uint64_t src) { 1585 for (std::pair<ThunkSection *, uint32_t> tp : isd->thunkSections) { 1586 ThunkSection *ts = tp.first; 1587 uint64_t tsBase = os->addr + ts->outSecOff; 1588 uint64_t tsLimit = tsBase + ts->getSize(); 1589 if (target->inBranchRange(type, src, (src > tsLimit) ? tsBase : tsLimit)) 1590 return ts; 1591 } 1592 1593 // No suitable ThunkSection exists. This can happen when there is a branch 1594 // with lower range than the ThunkSection spacing or when there are too 1595 // many Thunks. Create a new ThunkSection as close to the InputSection as 1596 // possible. Error if InputSection is so large we cannot place ThunkSection 1597 // anywhere in Range. 1598 uint64_t thunkSecOff = isec->outSecOff; 1599 if (!target->inBranchRange(type, src, os->addr + thunkSecOff)) { 1600 thunkSecOff = isec->outSecOff + isec->getSize(); 1601 if (!target->inBranchRange(type, src, os->addr + thunkSecOff)) 1602 fatal("InputSection too large for range extension thunk " + 1603 isec->getObjMsg(src - (os->addr + isec->outSecOff))); 1604 } 1605 return addThunkSection(os, isd, thunkSecOff); 1606 } 1607 1608 // Add a Thunk that needs to be placed in a ThunkSection that immediately 1609 // precedes its Target. 1610 ThunkSection *ThunkCreator::getISThunkSec(InputSection *isec) { 1611 ThunkSection *ts = thunkedSections.lookup(isec); 1612 if (ts) 1613 return ts; 1614 1615 // Find InputSectionRange within Target Output Section (TOS) that the 1616 // InputSection (IS) that we need to precede is in. 1617 OutputSection *tos = isec->getParent(); 1618 for (BaseCommand *bc : tos->sectionCommands) { 1619 auto *isd = dyn_cast<InputSectionDescription>(bc); 1620 if (!isd || isd->sections.empty()) 1621 continue; 1622 1623 InputSection *first = isd->sections.front(); 1624 InputSection *last = isd->sections.back(); 1625 1626 if (isec->outSecOff < first->outSecOff || last->outSecOff < isec->outSecOff) 1627 continue; 1628 1629 ts = addThunkSection(tos, isd, isec->outSecOff); 1630 thunkedSections[isec] = ts; 1631 return ts; 1632 } 1633 1634 return nullptr; 1635 } 1636 1637 // Create one or more ThunkSections per OS that can be used to place Thunks. 1638 // We attempt to place the ThunkSections using the following desirable 1639 // properties: 1640 // - Within range of the maximum number of callers 1641 // - Minimise the number of ThunkSections 1642 // 1643 // We follow a simple but conservative heuristic to place ThunkSections at 1644 // offsets that are multiples of a Target specific branch range. 1645 // For an InputSectionDescription that is smaller than the range, a single 1646 // ThunkSection at the end of the range will do. 1647 // 1648 // For an InputSectionDescription that is more than twice the size of the range, 1649 // we place the last ThunkSection at range bytes from the end of the 1650 // InputSectionDescription in order to increase the likelihood that the 1651 // distance from a thunk to its target will be sufficiently small to 1652 // allow for the creation of a short thunk. 1653 void ThunkCreator::createInitialThunkSections( 1654 ArrayRef<OutputSection *> outputSections) { 1655 uint32_t thunkSectionSpacing = target->getThunkSectionSpacing(); 1656 1657 forEachInputSectionDescription( 1658 outputSections, [&](OutputSection *os, InputSectionDescription *isd) { 1659 if (isd->sections.empty()) 1660 return; 1661 1662 uint32_t isdBegin = isd->sections.front()->outSecOff; 1663 uint32_t isdEnd = 1664 isd->sections.back()->outSecOff + isd->sections.back()->getSize(); 1665 uint32_t lastThunkLowerBound = -1; 1666 if (isdEnd - isdBegin > thunkSectionSpacing * 2) 1667 lastThunkLowerBound = isdEnd - thunkSectionSpacing; 1668 1669 uint32_t isecLimit; 1670 uint32_t prevIsecLimit = isdBegin; 1671 uint32_t thunkUpperBound = isdBegin + thunkSectionSpacing; 1672 1673 for (const InputSection *isec : isd->sections) { 1674 isecLimit = isec->outSecOff + isec->getSize(); 1675 if (isecLimit > thunkUpperBound) { 1676 addThunkSection(os, isd, prevIsecLimit); 1677 thunkUpperBound = prevIsecLimit + thunkSectionSpacing; 1678 } 1679 if (isecLimit > lastThunkLowerBound) 1680 break; 1681 prevIsecLimit = isecLimit; 1682 } 1683 addThunkSection(os, isd, isecLimit); 1684 }); 1685 } 1686 1687 ThunkSection *ThunkCreator::addThunkSection(OutputSection *os, 1688 InputSectionDescription *isd, 1689 uint64_t off) { 1690 auto *ts = make<ThunkSection>(os, off); 1691 ts->partition = os->partition; 1692 isd->thunkSections.push_back({ts, pass}); 1693 return ts; 1694 } 1695 1696 static bool isThunkSectionCompatible(InputSection *source, 1697 SectionBase *target) { 1698 // We can't reuse thunks in different loadable partitions because they might 1699 // not be loaded. But partition 1 (the main partition) will always be loaded. 1700 if (source->partition != target->partition) 1701 return target->partition == 1; 1702 return true; 1703 } 1704 1705 std::pair<Thunk *, bool> ThunkCreator::getThunk(InputSection *isec, 1706 Relocation &rel, uint64_t src) { 1707 std::vector<Thunk *> *thunkVec = nullptr; 1708 1709 // We use (section, offset) pair to find the thunk position if possible so 1710 // that we create only one thunk for aliased symbols or ICFed sections. 1711 if (auto *d = dyn_cast<Defined>(rel.sym)) 1712 if (!d->isInPlt() && d->section) 1713 thunkVec = &thunkedSymbolsBySection[{d->section->repl, d->value}]; 1714 if (!thunkVec) 1715 thunkVec = &thunkedSymbols[rel.sym]; 1716 1717 // Check existing Thunks for Sym to see if they can be reused 1718 for (Thunk *t : *thunkVec) 1719 if (isThunkSectionCompatible(isec, t->getThunkTargetSym()->section) && 1720 t->isCompatibleWith(*isec, rel) && 1721 target->inBranchRange(rel.type, src, t->getThunkTargetSym()->getVA())) 1722 return std::make_pair(t, false); 1723 1724 // No existing compatible Thunk in range, create a new one 1725 Thunk *t = addThunk(*isec, rel); 1726 thunkVec->push_back(t); 1727 return std::make_pair(t, true); 1728 } 1729 1730 // Return true if the relocation target is an in range Thunk. 1731 // Return false if the relocation is not to a Thunk. If the relocation target 1732 // was originally to a Thunk, but is no longer in range we revert the 1733 // relocation back to its original non-Thunk target. 1734 bool ThunkCreator::normalizeExistingThunk(Relocation &rel, uint64_t src) { 1735 if (Thunk *t = thunks.lookup(rel.sym)) { 1736 if (target->inBranchRange(rel.type, src, rel.sym->getVA())) 1737 return true; 1738 rel.sym = &t->destination; 1739 if (rel.sym->isInPlt()) 1740 rel.expr = toPlt(rel.expr); 1741 } 1742 return false; 1743 } 1744 1745 // Process all relocations from the InputSections that have been assigned 1746 // to InputSectionDescriptions and redirect through Thunks if needed. The 1747 // function should be called iteratively until it returns false. 1748 // 1749 // PreConditions: 1750 // All InputSections that may need a Thunk are reachable from 1751 // OutputSectionCommands. 1752 // 1753 // All OutputSections have an address and all InputSections have an offset 1754 // within the OutputSection. 1755 // 1756 // The offsets between caller (relocation place) and callee 1757 // (relocation target) will not be modified outside of createThunks(). 1758 // 1759 // PostConditions: 1760 // If return value is true then ThunkSections have been inserted into 1761 // OutputSections. All relocations that needed a Thunk based on the information 1762 // available to createThunks() on entry have been redirected to a Thunk. Note 1763 // that adding Thunks changes offsets between caller and callee so more Thunks 1764 // may be required. 1765 // 1766 // If return value is false then no more Thunks are needed, and createThunks has 1767 // made no changes. If the target requires range extension thunks, currently 1768 // ARM, then any future change in offset between caller and callee risks a 1769 // relocation out of range error. 1770 bool ThunkCreator::createThunks(ArrayRef<OutputSection *> outputSections) { 1771 bool addressesChanged = false; 1772 1773 if (pass == 0 && target->getThunkSectionSpacing()) 1774 createInitialThunkSections(outputSections); 1775 1776 // Create all the Thunks and insert them into synthetic ThunkSections. The 1777 // ThunkSections are later inserted back into InputSectionDescriptions. 1778 // We separate the creation of ThunkSections from the insertion of the 1779 // ThunkSections as ThunkSections are not always inserted into the same 1780 // InputSectionDescription as the caller. 1781 forEachInputSectionDescription( 1782 outputSections, [&](OutputSection *os, InputSectionDescription *isd) { 1783 for (InputSection *isec : isd->sections) 1784 for (Relocation &rel : isec->relocations) { 1785 uint64_t src = isec->getVA(rel.offset); 1786 1787 // If we are a relocation to an existing Thunk, check if it is 1788 // still in range. If not then Rel will be altered to point to its 1789 // original target so another Thunk can be generated. 1790 if (pass > 0 && normalizeExistingThunk(rel, src)) 1791 continue; 1792 1793 if (!target->needsThunk(rel.expr, rel.type, isec->file, src, 1794 *rel.sym)) 1795 continue; 1796 1797 Thunk *t; 1798 bool isNew; 1799 std::tie(t, isNew) = getThunk(isec, rel, src); 1800 1801 if (isNew) { 1802 // Find or create a ThunkSection for the new Thunk 1803 ThunkSection *ts; 1804 if (auto *tis = t->getTargetInputSection()) 1805 ts = getISThunkSec(tis); 1806 else 1807 ts = getISDThunkSec(os, isec, isd, rel.type, src); 1808 ts->addThunk(t); 1809 thunks[t->getThunkTargetSym()] = t; 1810 } 1811 1812 // Redirect relocation to Thunk, we never go via the PLT to a Thunk 1813 rel.sym = t->getThunkTargetSym(); 1814 rel.expr = fromPlt(rel.expr); 1815 1816 // The addend of R_PPC_PLTREL24 should be ignored after changing to 1817 // R_PC. 1818 if (config->emachine == EM_PPC && rel.type == R_PPC_PLTREL24) 1819 rel.addend = 0; 1820 } 1821 1822 for (auto &p : isd->thunkSections) 1823 addressesChanged |= p.first->assignOffsets(); 1824 }); 1825 1826 for (auto &p : thunkedSections) 1827 addressesChanged |= p.second->assignOffsets(); 1828 1829 // Merge all created synthetic ThunkSections back into OutputSection 1830 mergeThunks(outputSections); 1831 ++pass; 1832 return addressesChanged; 1833 } 1834 1835 template void elf::scanRelocations<ELF32LE>(InputSectionBase &); 1836 template void elf::scanRelocations<ELF32BE>(InputSectionBase &); 1837 template void elf::scanRelocations<ELF64LE>(InputSectionBase &); 1838 template void elf::scanRelocations<ELF64BE>(InputSectionBase &); 1839 template void elf::reportUndefinedSymbols<ELF32LE>(); 1840 template void elf::reportUndefinedSymbols<ELF32BE>(); 1841 template void elf::reportUndefinedSymbols<ELF64LE>(); 1842 template void elf::reportUndefinedSymbols<ELF64BE>(); 1843