//===- LinkerScript.cpp ---------------------------------------------------===// // // The LLVM Linker // // This file is distributed under the University of Illinois Open Source // License. See LICENSE.TXT for details. // //===----------------------------------------------------------------------===// // // This file contains the parser/evaluator of the linker script. // It does not construct an AST but consume linker script directives directly. // Results are written to Driver or Config object. // //===----------------------------------------------------------------------===// #include "LinkerScript.h" #include "Config.h" #include "Driver.h" #include "InputSection.h" #include "OutputSections.h" #include "ScriptParser.h" #include "Strings.h" #include "Symbols.h" #include "SymbolTable.h" #include "Target.h" #include "Writer.h" #include "llvm/ADT/StringSwitch.h" #include "llvm/Support/ELF.h" #include "llvm/Support/FileSystem.h" #include "llvm/Support/MemoryBuffer.h" #include "llvm/Support/Path.h" #include "llvm/Support/StringSaver.h" using namespace llvm; using namespace llvm::ELF; using namespace llvm::object; using namespace lld; using namespace lld::elf; ScriptConfiguration *elf::ScriptConfig; bool SymbolAssignment::classof(const BaseCommand *C) { return C->Kind == AssignmentKind; } bool OutputSectionCommand::classof(const BaseCommand *C) { return C->Kind == OutputSectionKind; } // This is an operator-precedence parser to parse and evaluate // a linker script expression. For each linker script arithmetic // expression (e.g. ". = . + 0x1000"), a new instance of ExprParser // is created and ran. namespace { class ExprParser : public ScriptParserBase { public: ExprParser(std::vector &Tokens, uint64_t Dot) : ScriptParserBase(Tokens), Dot(Dot) {} uint64_t run(); private: uint64_t parsePrimary(); uint64_t parseTernary(uint64_t Cond); uint64_t apply(StringRef Op, uint64_t L, uint64_t R); uint64_t parseExpr1(uint64_t Lhs, int MinPrec); uint64_t parseExpr(); uint64_t Dot; }; } static int precedence(StringRef Op) { return StringSwitch(Op) .Case("*", 4) .Case("/", 4) .Case("+", 3) .Case("-", 3) .Case("<", 2) .Case(">", 2) .Case(">=", 2) .Case("<=", 2) .Case("==", 2) .Case("!=", 2) .Case("&", 1) .Default(-1); } static uint64_t evalExpr(std::vector &Tokens, uint64_t Dot) { return ExprParser(Tokens, Dot).run(); } uint64_t ExprParser::run() { uint64_t V = parseExpr(); if (!atEOF() && !Error) setError("stray token: " + peek()); return V; } // This is a part of the operator-precedence parser to evaluate // arithmetic expressions in SECTIONS command. This function evaluates an // integer literal, a parenthesized expression, the ALIGN function, // or the special variable ".". uint64_t ExprParser::parsePrimary() { StringRef Tok = next(); if (Tok == ".") return Dot; if (Tok == "(") { uint64_t V = parseExpr(); expect(")"); return V; } if (Tok == "ALIGN") { expect("("); uint64_t V = parseExpr(); expect(")"); return alignTo(Dot, V); } uint64_t V = 0; if (Tok.getAsInteger(0, V)) setError("malformed number: " + Tok); return V; } uint64_t ExprParser::parseTernary(uint64_t Cond) { next(); uint64_t V = parseExpr(); expect(":"); uint64_t W = parseExpr(); return Cond ? V : W; } uint64_t ExprParser::apply(StringRef Op, uint64_t L, uint64_t R) { if (Op == "*") return L * R; if (Op == "/") { if (R == 0) { error("division by zero"); return 0; } return L / R; } if (Op == "+") return L + R; if (Op == "-") return L - R; if (Op == "<") return L < R; if (Op == ">") return L > R; if (Op == ">=") return L >= R; if (Op == "<=") return L <= R; if (Op == "==") return L == R; if (Op == "!=") return L != R; if (Op == "&") return L & R; llvm_unreachable("invalid operator"); } // This is a part of the operator-precedence parser. // This function assumes that the remaining token stream starts // with an operator. uint64_t ExprParser::parseExpr1(uint64_t Lhs, int MinPrec) { while (!atEOF()) { // Read an operator and an expression. StringRef Op1 = peek(); if (Op1 == "?") return parseTernary(Lhs); if (precedence(Op1) < MinPrec) return Lhs; next(); uint64_t Rhs = parsePrimary(); // Evaluate the remaining part of the expression first if the // next operator has greater precedence than the previous one. // For example, if we have read "+" and "3", and if the next // operator is "*", then we'll evaluate 3 * ... part first. while (!atEOF()) { StringRef Op2 = peek(); if (precedence(Op2) <= precedence(Op1)) break; Rhs = parseExpr1(Rhs, precedence(Op2)); } Lhs = apply(Op1, Lhs, Rhs); } return Lhs; } // Reads and evaluates an arithmetic expression. uint64_t ExprParser::parseExpr() { return parseExpr1(parsePrimary(), 0); } template StringRef LinkerScript::getOutputSection(InputSectionBase *S) { for (SectionRule &R : Opt.Sections) if (globMatch(R.SectionPattern, S->getSectionName())) return R.Dest; return ""; } template bool LinkerScript::isDiscarded(InputSectionBase *S) { return !S || !S->Live || getOutputSection(S) == "/DISCARD/"; } template bool LinkerScript::shouldKeep(InputSectionBase *S) { for (StringRef Pat : Opt.KeptSections) if (globMatch(Pat, S->getSectionName())) return true; return false; } template std::vector *> LinkerScript::createSections(OutputSectionFactory &Factory) { std::vector *> Result; // Add input section to output section. If there is no output section yet, // then create it and add to output section list. auto AddInputSec = [&](InputSectionBase *C, StringRef Name) { OutputSectionBase *Sec; bool IsNew; std::tie(Sec, IsNew) = Factory.create(C, Name); if (IsNew) Result.push_back(Sec); Sec->addSection(C); }; // Select input sections matching rule and add them to corresponding // output section. Section rules are processed in order they're listed // in script, so correct input section order is maintained by design. for (SectionRule &R : Opt.Sections) for (const std::unique_ptr> &F : Symtab::X->getObjectFiles()) for (InputSectionBase *S : F->getSections()) if (!isDiscarded(S) && !S->OutSec && globMatch(R.SectionPattern, S->getSectionName())) // Add single input section to output section. AddInputSec(S, R.Dest); // Add all other input sections, which are not listed in script. for (const std::unique_ptr> &F : Symtab::X->getObjectFiles()) for (InputSectionBase *S : F->getSections()) if (!isDiscarded(S)) { if (!S->OutSec) AddInputSec(S, getOutputSectionName(S)); } else reportDiscarded(S, F); return Result; } template void LinkerScript::assignAddresses( ArrayRef *> Sections) { // Orphan sections are sections present in the input files which // are not explicitly placed into the output file by the linker script. // We place orphan sections at end of file. // Other linkers places them using some heuristics as described in // https://sourceware.org/binutils/docs/ld/Orphan-Sections.html#Orphan-Sections. for (OutputSectionBase *Sec : Sections) { StringRef Name = Sec->getName(); if (getSectionIndex(Name) == INT_MAX) Opt.Commands.push_back(llvm::make_unique(Name)); } // Assign addresses as instructed by linker script SECTIONS sub-commands. Dot = Out::ElfHeader->getSize() + Out::ProgramHeaders->getSize(); uintX_t MinVA = std::numeric_limits::max(); uintX_t ThreadBssOffset = 0; for (const std::unique_ptr &Base : Opt.Commands) { if (auto *Cmd = dyn_cast(Base.get())) { uint64_t Val = evalExpr(Cmd->Expr, Dot); if (Cmd->Name == ".") { Dot = Val; } else { auto *D = cast>(Symtab::X->find(Cmd->Name)); D->Value = Val; } continue; } // Find all the sections with required name. There can be more than // one section with such name, if the alignment, flags or type // attribute differs. auto *Cmd = cast(Base.get()); for (OutputSectionBase *Sec : Sections) { if (Sec->getName() != Cmd->Name) continue; if ((Sec->getFlags() & SHF_TLS) && Sec->getType() == SHT_NOBITS) { uintX_t TVA = Dot + ThreadBssOffset; TVA = alignTo(TVA, Sec->getAlignment()); Sec->setVA(TVA); ThreadBssOffset = TVA - Dot + Sec->getSize(); continue; } if (Sec->getFlags() & SHF_ALLOC) { Dot = alignTo(Dot, Sec->getAlignment()); Sec->setVA(Dot); MinVA = std::min(MinVA, Dot); Dot += Sec->getSize(); continue; } } } // ELF and Program headers need to be right before the first section in // memory. Set their addresses accordingly. MinVA = alignDown(MinVA - Out::ElfHeader->getSize() - Out::ProgramHeaders->getSize(), Target->PageSize); Out::ElfHeader->setVA(MinVA); Out::ProgramHeaders->setVA(Out::ElfHeader->getSize() + MinVA); } template std::vector> LinkerScript::createPhdrs(ArrayRef *> Sections) { int TlsNum = -1; int NoteNum = -1; int RelroNum = -1; Phdr *Load = nullptr; uintX_t Flags = PF_R; std::vector Phdrs; for (const PhdrsCommand &Cmd : Opt.PhdrsCommands) { Phdrs.emplace_back(Cmd.Type, PF_R); Phdr &Added = Phdrs.back(); if (Cmd.HasFilehdr) Added.add(Out::ElfHeader); if (Cmd.HasPhdrs) Added.add(Out::ProgramHeaders); switch (Cmd.Type) { case PT_INTERP: if (needsInterpSection()) Added.add(Out::Interp); break; case PT_DYNAMIC: if (isOutputDynamic()) { Added.H.p_flags = toPhdrFlags(Out::Dynamic->getFlags()); Added.add(Out::Dynamic); } break; case PT_TLS: TlsNum = Phdrs.size() - 1; break; case PT_NOTE: NoteNum = Phdrs.size() - 1; break; case PT_GNU_RELRO: RelroNum = Phdrs.size() - 1; break; case PT_GNU_EH_FRAME: if (!Out::EhFrame->empty() && Out::EhFrameHdr) { Added.H.p_flags = toPhdrFlags(Out::EhFrameHdr->getFlags()); Added.add(Out::EhFrameHdr); } break; } } for (OutputSectionBase *Sec : Sections) { if (!(Sec->getFlags() & SHF_ALLOC)) break; if (TlsNum != -1 && (Sec->getFlags() & SHF_TLS)) Phdrs[TlsNum].add(Sec); if (!needsPtLoad(Sec)) continue; const std::vector &PhdrIds = getPhdrIndicesForSection(Sec->getName()); if (!PhdrIds.empty()) { // Assign headers specified by linker script for (size_t Id : PhdrIds) { Phdrs[Id].add(Sec); Phdrs[Id].H.p_flags |= toPhdrFlags(Sec->getFlags()); } } else { // If we have no load segment or flags've changed then we want new load // segment. uintX_t NewFlags = toPhdrFlags(Sec->getFlags()); if (Load == nullptr || Flags != NewFlags) { Load = &*Phdrs.emplace(Phdrs.end(), PT_LOAD, NewFlags); Flags = NewFlags; } Load->add(Sec); } if (RelroNum != -1 && isRelroSection(Sec)) Phdrs[RelroNum].add(Sec); if (NoteNum != -1 && Sec->getType() == SHT_NOTE) Phdrs[NoteNum].add(Sec); } return Phdrs; } template ArrayRef LinkerScript::getFiller(StringRef Name) { for (const std::unique_ptr &Base : Opt.Commands) if (auto *Cmd = dyn_cast(Base.get())) if (Cmd->Name == Name) return Cmd->Filler; return {}; } // Returns the index of the given section name in linker script // SECTIONS commands. Sections are laid out as the same order as they // were in the script. If a given name did not appear in the script, // it returns INT_MAX, so that it will be laid out at end of file. template int LinkerScript::getSectionIndex(StringRef Name) { auto Begin = Opt.Commands.begin(); auto End = Opt.Commands.end(); auto I = std::find_if(Begin, End, [&](const std::unique_ptr &Base) { if (auto *Cmd = dyn_cast(Base.get())) if (Cmd->Name == Name) return true; return false; }); return I == End ? INT_MAX : (I - Begin); } // A compartor to sort output sections. Returns -1 or 1 if // A or B are mentioned in linker script. Otherwise, returns 0. template int LinkerScript::compareSections(StringRef A, StringRef B) { int I = getSectionIndex(A); int J = getSectionIndex(B); if (I == INT_MAX && J == INT_MAX) return 0; return I < J ? -1 : 1; } template void LinkerScript::addScriptedSymbols() { for (const std::unique_ptr &Base : Opt.Commands) if (auto *Cmd = dyn_cast(Base.get())) if (Cmd->Name != "." && Symtab::X->find(Cmd->Name) == nullptr) Symtab::X->addAbsolute(Cmd->Name, STV_DEFAULT); } template bool LinkerScript::hasPhdrsCommands() { return !Opt.PhdrsCommands.empty(); } // Returns indices of ELF headers containing specific section, identified // by Name. Each index is a zero based number of ELF header listed within // PHDRS {} script block. template std::vector LinkerScript::getPhdrIndicesForSection(StringRef Name) { for (const std::unique_ptr &Base : Opt.Commands) { auto *Cmd = dyn_cast(Base.get()); if (!Cmd || Cmd->Name != Name) continue; std::vector Indices; for (StringRef PhdrName : Cmd->Phdrs) { auto ItPhdr = std::find_if(Opt.PhdrsCommands.rbegin(), Opt.PhdrsCommands.rend(), [&](PhdrsCommand &P) { return P.Name == PhdrName; }); if (ItPhdr == Opt.PhdrsCommands.rend()) error("section header '" + PhdrName + "' is not listed in PHDRS"); else Indices.push_back(std::distance(ItPhdr, Opt.PhdrsCommands.rend()) - 1); } return Indices; } return {}; } class elf::ScriptParser : public ScriptParserBase { typedef void (ScriptParser::*Handler)(); public: ScriptParser(StringRef S, bool B) : ScriptParserBase(S), IsUnderSysroot(B) {} void run(); private: void addFile(StringRef Path); void readAsNeeded(); void readEntry(); void readExtern(); void readGroup(); void readInclude(); void readNothing() {} void readOutput(); void readOutputArch(); void readOutputFormat(); void readPhdrs(); void readSearchDir(); void readSections(); void readLocationCounterValue(); void readOutputSectionDescription(StringRef OutSec); std::vector readOutputSectionPhdrs(); unsigned readPhdrType(); void readSymbolAssignment(StringRef Name); std::vector readSectionsCommandExpr(); const static StringMap Cmd; ScriptConfiguration &Opt = *ScriptConfig; StringSaver Saver = {ScriptConfig->Alloc}; bool IsUnderSysroot; }; const StringMap elf::ScriptParser::Cmd = { {"ENTRY", &ScriptParser::readEntry}, {"EXTERN", &ScriptParser::readExtern}, {"GROUP", &ScriptParser::readGroup}, {"INCLUDE", &ScriptParser::readInclude}, {"INPUT", &ScriptParser::readGroup}, {"OUTPUT", &ScriptParser::readOutput}, {"OUTPUT_ARCH", &ScriptParser::readOutputArch}, {"OUTPUT_FORMAT", &ScriptParser::readOutputFormat}, {"PHDRS", &ScriptParser::readPhdrs}, {"SEARCH_DIR", &ScriptParser::readSearchDir}, {"SECTIONS", &ScriptParser::readSections}, {";", &ScriptParser::readNothing}}; void ScriptParser::run() { while (!atEOF()) { StringRef Tok = next(); if (Handler Fn = Cmd.lookup(Tok)) (this->*Fn)(); else setError("unknown directive: " + Tok); } } void ScriptParser::addFile(StringRef S) { if (IsUnderSysroot && S.startswith("/")) { SmallString<128> Path; (Config->Sysroot + S).toStringRef(Path); if (sys::fs::exists(Path)) { Driver->addFile(Saver.save(Path.str())); return; } } if (sys::path::is_absolute(S)) { Driver->addFile(S); } else if (S.startswith("=")) { if (Config->Sysroot.empty()) Driver->addFile(S.substr(1)); else Driver->addFile(Saver.save(Config->Sysroot + "/" + S.substr(1))); } else if (S.startswith("-l")) { Driver->addLibrary(S.substr(2)); } else if (sys::fs::exists(S)) { Driver->addFile(S); } else { std::string Path = findFromSearchPaths(S); if (Path.empty()) setError("unable to find " + S); else Driver->addFile(Saver.save(Path)); } } void ScriptParser::readAsNeeded() { expect("("); bool Orig = Config->AsNeeded; Config->AsNeeded = true; while (!Error) { StringRef Tok = next(); if (Tok == ")") break; addFile(Tok); } Config->AsNeeded = Orig; } void ScriptParser::readEntry() { // -e takes predecence over ENTRY(). expect("("); StringRef Tok = next(); if (Config->Entry.empty()) Config->Entry = Tok; expect(")"); } void ScriptParser::readExtern() { expect("("); while (!Error) { StringRef Tok = next(); if (Tok == ")") return; Config->Undefined.push_back(Tok); } } void ScriptParser::readGroup() { expect("("); while (!Error) { StringRef Tok = next(); if (Tok == ")") return; if (Tok == "AS_NEEDED") { readAsNeeded(); continue; } addFile(Tok); } } void ScriptParser::readInclude() { StringRef Tok = next(); auto MBOrErr = MemoryBuffer::getFile(Tok); if (!MBOrErr) { setError("cannot open " + Tok); return; } std::unique_ptr &MB = *MBOrErr; StringRef S = Saver.save(MB->getMemBufferRef().getBuffer()); std::vector V = tokenize(S); Tokens.insert(Tokens.begin() + Pos, V.begin(), V.end()); } void ScriptParser::readOutput() { // -o takes predecence over OUTPUT(). expect("("); StringRef Tok = next(); if (Config->OutputFile.empty()) Config->OutputFile = Tok; expect(")"); } void ScriptParser::readOutputArch() { // Error checking only for now. expect("("); next(); expect(")"); } void ScriptParser::readOutputFormat() { // Error checking only for now. expect("("); next(); StringRef Tok = next(); if (Tok == ")") return; if (Tok != ",") { setError("unexpected token: " + Tok); return; } next(); expect(","); next(); expect(")"); } void ScriptParser::readPhdrs() { expect("{"); while (!Error && !skip("}")) { StringRef Tok = next(); Opt.PhdrsCommands.push_back({Tok, PT_NULL, false, false}); PhdrsCommand &PhdrCmd = Opt.PhdrsCommands.back(); PhdrCmd.Type = readPhdrType(); do { Tok = next(); if (Tok == ";") break; if (Tok == "FILEHDR") PhdrCmd.HasFilehdr = true; else if (Tok == "PHDRS") PhdrCmd.HasPhdrs = true; else setError("unexpected header attribute: " + Tok); } while (!Error); } } void ScriptParser::readSearchDir() { expect("("); Config->SearchPaths.push_back(next()); expect(")"); } void ScriptParser::readSections() { Opt.DoLayout = true; expect("{"); while (!Error && !skip("}")) { StringRef Tok = peek(); if (Tok == ".") { readLocationCounterValue(); continue; } next(); if (peek() == "=") readSymbolAssignment(Tok); else readOutputSectionDescription(Tok); } } void ScriptParser::readLocationCounterValue() { expect("."); expect("="); std::vector Expr = readSectionsCommandExpr(); if (Expr.empty()) error("error in location counter expression"); else Opt.Commands.push_back(llvm::make_unique(".", Expr)); } void ScriptParser::readOutputSectionDescription(StringRef OutSec) { OutputSectionCommand *Cmd = new OutputSectionCommand(OutSec); Opt.Commands.emplace_back(Cmd); expect(":"); expect("{"); while (!Error && !skip("}")) { StringRef Tok = next(); if (Tok == "*") { expect("("); while (!Error && !skip(")")) Opt.Sections.emplace_back(OutSec, next()); } else if (Tok == "KEEP") { expect("("); expect("*"); expect("("); while (!Error && !skip(")")) { StringRef Sec = next(); Opt.Sections.emplace_back(OutSec, Sec); Opt.KeptSections.push_back(Sec); } expect(")"); } else { setError("unknown command " + Tok); } } Cmd->Phdrs = readOutputSectionPhdrs(); StringRef Tok = peek(); if (Tok.startswith("=")) { if (!Tok.startswith("=0x")) { setError("filler should be a hexadecimal value"); return; } Tok = Tok.substr(3); Cmd->Filler = parseHex(Tok); next(); } } void ScriptParser::readSymbolAssignment(StringRef Name) { expect("="); std::vector Expr = readSectionsCommandExpr(); if (Expr.empty()) error("error in symbol assignment expression"); else Opt.Commands.push_back(llvm::make_unique(Name, Expr)); } std::vector ScriptParser::readSectionsCommandExpr() { std::vector Expr; while (!Error) { StringRef Tok = next(); if (Tok == ";") break; Expr.push_back(Tok); } return Expr; } std::vector ScriptParser::readOutputSectionPhdrs() { std::vector Phdrs; while (!Error && peek().startswith(":")) { StringRef Tok = next(); Tok = (Tok.size() == 1) ? next() : Tok.substr(1); if (Tok.empty()) { setError("section header name is empty"); break; } Phdrs.push_back(Tok); } return Phdrs; } unsigned ScriptParser::readPhdrType() { StringRef Tok = next(); unsigned Ret = StringSwitch(Tok) .Case("PT_NULL", PT_NULL) .Case("PT_LOAD", PT_LOAD) .Case("PT_DYNAMIC", PT_DYNAMIC) .Case("PT_INTERP", PT_INTERP) .Case("PT_NOTE", PT_NOTE) .Case("PT_SHLIB", PT_SHLIB) .Case("PT_PHDR", PT_PHDR) .Case("PT_TLS", PT_TLS) .Case("PT_GNU_EH_FRAME", PT_GNU_EH_FRAME) .Case("PT_GNU_STACK", PT_GNU_STACK) .Case("PT_GNU_RELRO", PT_GNU_RELRO) .Default(-1); if (Ret == (unsigned)-1) { setError("invalid program header type: " + Tok); return PT_NULL; } return Ret; } static bool isUnderSysroot(StringRef Path) { if (Config->Sysroot == "") return false; for (; !Path.empty(); Path = sys::path::parent_path(Path)) if (sys::fs::equivalent(Config->Sysroot, Path)) return true; return false; } // Entry point. void elf::readLinkerScript(MemoryBufferRef MB) { StringRef Path = MB.getBufferIdentifier(); ScriptParser(MB.getBuffer(), isUnderSysroot(Path)).run(); } template class elf::LinkerScript; template class elf::LinkerScript; template class elf::LinkerScript; template class elf::LinkerScript;