12ec34544SRui Ueyama //===- ScriptParser.cpp ---------------------------------------------------===//
22ec34544SRui Ueyama //
32946cd70SChandler Carruth // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
42946cd70SChandler Carruth // See https://llvm.org/LICENSE.txt for license information.
52946cd70SChandler Carruth // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
62ec34544SRui Ueyama //
72ec34544SRui Ueyama //===----------------------------------------------------------------------===//
805f6b852SRui Ueyama //
905f6b852SRui Ueyama // This file contains a recursive-descendent parser for linker scripts.
1005f6b852SRui Ueyama // Parsed results are stored to Config and Script global objects.
1105f6b852SRui Ueyama //
1205f6b852SRui Ueyama //===----------------------------------------------------------------------===//
132ec34544SRui Ueyama 
142ec34544SRui Ueyama #include "ScriptParser.h"
152ec34544SRui Ueyama #include "Config.h"
162ec34544SRui Ueyama #include "Driver.h"
172ec34544SRui Ueyama #include "InputSection.h"
182ec34544SRui Ueyama #include "LinkerScript.h"
192ec34544SRui Ueyama #include "OutputSections.h"
202ec34544SRui Ueyama #include "ScriptLexer.h"
212ec34544SRui Ueyama #include "Symbols.h"
222ec34544SRui Ueyama #include "Target.h"
232017d52bSRui Ueyama #include "lld/Common/Memory.h"
242ec34544SRui Ueyama #include "llvm/ADT/SmallString.h"
252ec34544SRui Ueyama #include "llvm/ADT/StringRef.h"
260440be4aSRui Ueyama #include "llvm/ADT/StringSet.h"
272ec34544SRui Ueyama #include "llvm/ADT/StringSwitch.h"
28264b5d9eSZachary Turner #include "llvm/BinaryFormat/ELF.h"
292ec34544SRui Ueyama #include "llvm/Support/Casting.h"
302ec34544SRui Ueyama #include "llvm/Support/ErrorHandling.h"
312ec34544SRui Ueyama #include "llvm/Support/FileSystem.h"
322ec34544SRui Ueyama #include "llvm/Support/Path.h"
332ec34544SRui Ueyama #include <cassert>
342ec34544SRui Ueyama #include <limits>
352ec34544SRui Ueyama #include <vector>
362ec34544SRui Ueyama 
372ec34544SRui Ueyama using namespace llvm;
382ec34544SRui Ueyama using namespace llvm::ELF;
39b58079d4SRui Ueyama using namespace llvm::support::endian;
402ec34544SRui Ueyama using namespace lld;
412ec34544SRui Ueyama using namespace lld::elf;
422ec34544SRui Ueyama 
432ec34544SRui Ueyama static bool isUnderSysroot(StringRef Path);
442ec34544SRui Ueyama 
4596b3fe02SRui Ueyama namespace {
4696b3fe02SRui Ueyama class ScriptParser final : ScriptLexer {
472ec34544SRui Ueyama public:
482ec34544SRui Ueyama   ScriptParser(MemoryBufferRef MB)
492ec34544SRui Ueyama       : ScriptLexer(MB),
502ec34544SRui Ueyama         IsUnderSysroot(isUnderSysroot(MB.getBufferIdentifier())) {}
512ec34544SRui Ueyama 
522ec34544SRui Ueyama   void readLinkerScript();
532ec34544SRui Ueyama   void readVersionScript();
542ec34544SRui Ueyama   void readDynamicList();
558c7e8cceSPetr Hosek   void readDefsym(StringRef Name);
562ec34544SRui Ueyama 
572ec34544SRui Ueyama private:
582ec34544SRui Ueyama   void addFile(StringRef Path);
592ec34544SRui Ueyama 
602ec34544SRui Ueyama   void readAsNeeded();
612ec34544SRui Ueyama   void readEntry();
622ec34544SRui Ueyama   void readExtern();
632ec34544SRui Ueyama   void readGroup();
642ec34544SRui Ueyama   void readInclude();
651d92aa73SRui Ueyama   void readInput();
662ec34544SRui Ueyama   void readMemory();
672ec34544SRui Ueyama   void readOutput();
682ec34544SRui Ueyama   void readOutputArch();
692ec34544SRui Ueyama   void readOutputFormat();
702ec34544SRui Ueyama   void readPhdrs();
715f37541cSGeorge Rimar   void readRegionAlias();
722ec34544SRui Ueyama   void readSearchDir();
732ec34544SRui Ueyama   void readSections();
74e262bb1aSRui Ueyama   void readTarget();
752ec34544SRui Ueyama   void readVersion();
762ec34544SRui Ueyama   void readVersionScriptCommand();
772ec34544SRui Ueyama 
78d30a78b3SGeorge Rimar   SymbolAssignment *readSymbolAssignment(StringRef Name);
79f0403c60SRui Ueyama   ByteCommand *readByteCommand(StringRef Tok);
80b0486051SSimon Atanasyan   std::array<uint8_t, 4> readFill();
81b0486051SSimon Atanasyan   std::array<uint8_t, 4> parseFill(StringRef Tok);
82a46d08ebSGeorge Rimar   bool readSectionDirective(OutputSection *Cmd, StringRef Tok1, StringRef Tok2);
838c022ca7SRafael Espindola   void readSectionAddressType(OutputSection *Cmd);
84a582419aSGeorge Rimar   OutputSection *readOverlaySectionDescription();
858c022ca7SRafael Espindola   OutputSection *readOutputSectionDescription(StringRef OutSec);
86a582419aSGeorge Rimar   std::vector<BaseCommand *> readOverlay();
872ec34544SRui Ueyama   std::vector<StringRef> readOutputSectionPhdrs();
882ec34544SRui Ueyama   InputSectionDescription *readInputSectionDescription(StringRef Tok);
892ec34544SRui Ueyama   StringMatcher readFilePatterns();
902ec34544SRui Ueyama   std::vector<SectionPattern> readInputSectionsList();
912ec34544SRui Ueyama   InputSectionDescription *readInputSectionRules(StringRef FilePattern);
922ec34544SRui Ueyama   unsigned readPhdrType();
932ec34544SRui Ueyama   SortSectionPolicy readSortKind();
942ec34544SRui Ueyama   SymbolAssignment *readProvideHidden(bool Provide, bool Hidden);
95d30a78b3SGeorge Rimar   SymbolAssignment *readAssignment(StringRef Tok);
962ec34544SRui Ueyama   void readSort();
97d30a78b3SGeorge Rimar   Expr readAssert();
985fb17128SGeorge Rimar   Expr readConstant();
995fb17128SGeorge Rimar   Expr getPageSize();
1002ec34544SRui Ueyama 
1012ec34544SRui Ueyama   uint64_t readMemoryAssignment(StringRef, StringRef, StringRef);
1022ec34544SRui Ueyama   std::pair<uint32_t, uint32_t> readMemoryAttributes();
1032ec34544SRui Ueyama 
1047b91e213SGeorge Rimar   Expr combine(StringRef Op, Expr L, Expr R);
1052ec34544SRui Ueyama   Expr readExpr();
1062ec34544SRui Ueyama   Expr readExpr1(Expr Lhs, int MinPrec);
1072ec34544SRui Ueyama   StringRef readParenLiteral();
1082ec34544SRui Ueyama   Expr readPrimary();
1092ec34544SRui Ueyama   Expr readTernary(Expr Cond);
1102ec34544SRui Ueyama   Expr readParenExpr();
1112ec34544SRui Ueyama 
1122ec34544SRui Ueyama   // For parsing version script.
1132ec34544SRui Ueyama   std::vector<SymbolVersion> readVersionExtern();
1142ec34544SRui Ueyama   void readAnonymousDeclaration();
1152ec34544SRui Ueyama   void readVersionDeclaration(StringRef VerStr);
1162ec34544SRui Ueyama 
1172ec34544SRui Ueyama   std::pair<std::vector<SymbolVersion>, std::vector<SymbolVersion>>
1182ec34544SRui Ueyama   readSymbols();
1192ec34544SRui Ueyama 
120fd06b025SRui Ueyama   // True if a script being read is in a subdirectory specified by -sysroot.
1212ec34544SRui Ueyama   bool IsUnderSysroot;
1220440be4aSRui Ueyama 
1230440be4aSRui Ueyama   // A set to detect an INCLUDE() cycle.
1240440be4aSRui Ueyama   StringSet<> Seen;
1252ec34544SRui Ueyama };
12696b3fe02SRui Ueyama } // namespace
1272ec34544SRui Ueyama 
1281e77ad14SRui Ueyama static StringRef unquote(StringRef S) {
1291e77ad14SRui Ueyama   if (S.startswith("\""))
1301e77ad14SRui Ueyama     return S.substr(1, S.size() - 2);
1311e77ad14SRui Ueyama   return S;
1321e77ad14SRui Ueyama }
1331e77ad14SRui Ueyama 
1342ec34544SRui Ueyama static bool isUnderSysroot(StringRef Path) {
1352ec34544SRui Ueyama   if (Config->Sysroot == "")
1362ec34544SRui Ueyama     return false;
1372ec34544SRui Ueyama   for (; !Path.empty(); Path = sys::path::parent_path(Path))
1382ec34544SRui Ueyama     if (sys::fs::equivalent(Config->Sysroot, Path))
1392ec34544SRui Ueyama       return true;
1402ec34544SRui Ueyama   return false;
1412ec34544SRui Ueyama }
1422ec34544SRui Ueyama 
1432ec34544SRui Ueyama // Some operations only support one non absolute value. Move the
1442ec34544SRui Ueyama // absolute one to the right hand side for convenience.
1452ec34544SRui Ueyama static void moveAbsRight(ExprValue &A, ExprValue &B) {
14623be5e8dSRafael Espindola   if (A.Sec == nullptr || (A.ForceAbsolute && !B.isAbsolute()))
1472ec34544SRui Ueyama     std::swap(A, B);
1482ec34544SRui Ueyama   if (!B.isAbsolute())
14941c7ab4aSGeorge Rimar     error(A.Loc + ": at least one side of the expression must be absolute");
1502ec34544SRui Ueyama }
1512ec34544SRui Ueyama 
1522ec34544SRui Ueyama static ExprValue add(ExprValue A, ExprValue B) {
1532ec34544SRui Ueyama   moveAbsRight(A, B);
154a6acd23cSRafael Espindola   return {A.Sec, A.ForceAbsolute, A.getSectionOffset() + B.getValue(), A.Loc};
1552ec34544SRui Ueyama }
1562ec34544SRui Ueyama 
1572ec34544SRui Ueyama static ExprValue sub(ExprValue A, ExprValue B) {
15863a4a98eSRafael Espindola   // The distance between two symbols in sections is absolute.
1599cbb6dd1SRafael Espindola   if (!A.isAbsolute() && !B.isAbsolute())
1609cbb6dd1SRafael Espindola     return A.getValue() - B.getValue();
1614fbe3518SRui Ueyama   return {A.Sec, false, A.getSectionOffset() - B.getValue(), A.Loc};
1622ec34544SRui Ueyama }
1632ec34544SRui Ueyama 
1642ec34544SRui Ueyama static ExprValue bitAnd(ExprValue A, ExprValue B) {
1652ec34544SRui Ueyama   moveAbsRight(A, B);
1662ec34544SRui Ueyama   return {A.Sec, A.ForceAbsolute,
16741c7ab4aSGeorge Rimar           (A.getValue() & B.getValue()) - A.getSecAddr(), A.Loc};
1682ec34544SRui Ueyama }
1692ec34544SRui Ueyama 
1702ec34544SRui Ueyama static ExprValue bitOr(ExprValue A, ExprValue B) {
1712ec34544SRui Ueyama   moveAbsRight(A, B);
1722ec34544SRui Ueyama   return {A.Sec, A.ForceAbsolute,
17341c7ab4aSGeorge Rimar           (A.getValue() | B.getValue()) - A.getSecAddr(), A.Loc};
1742ec34544SRui Ueyama }
1752ec34544SRui Ueyama 
1762ec34544SRui Ueyama void ScriptParser::readDynamicList() {
1778016bdfdSRafael Espindola   Config->HasDynamicList = true;
1782ec34544SRui Ueyama   expect("{");
179d72d97b3SRafael Espindola   std::vector<SymbolVersion> Locals;
180d72d97b3SRafael Espindola   std::vector<SymbolVersion> Globals;
181d72d97b3SRafael Espindola   std::tie(Locals, Globals) = readSymbols();
182d72d97b3SRafael Espindola   expect(";");
183d72d97b3SRafael Espindola 
184d72d97b3SRafael Espindola   if (!atEOF()) {
1852ec34544SRui Ueyama     setError("EOF expected, but got " + next());
186d72d97b3SRafael Espindola     return;
187d72d97b3SRafael Espindola   }
188d72d97b3SRafael Espindola   if (!Locals.empty()) {
189d72d97b3SRafael Espindola     setError("\"local:\" scope not supported in --dynamic-list");
190d72d97b3SRafael Espindola     return;
191d72d97b3SRafael Espindola   }
192d72d97b3SRafael Espindola 
193d72d97b3SRafael Espindola   for (SymbolVersion V : Globals)
194d72d97b3SRafael Espindola     Config->DynamicList.push_back(V);
1952ec34544SRui Ueyama }
1962ec34544SRui Ueyama 
1972ec34544SRui Ueyama void ScriptParser::readVersionScript() {
1982ec34544SRui Ueyama   readVersionScriptCommand();
1992ec34544SRui Ueyama   if (!atEOF())
2002ec34544SRui Ueyama     setError("EOF expected, but got " + next());
2012ec34544SRui Ueyama }
2022ec34544SRui Ueyama 
2032ec34544SRui Ueyama void ScriptParser::readVersionScriptCommand() {
2042ec34544SRui Ueyama   if (consume("{")) {
2052ec34544SRui Ueyama     readAnonymousDeclaration();
2062ec34544SRui Ueyama     return;
2072ec34544SRui Ueyama   }
2082ec34544SRui Ueyama 
209b8a59c8aSBob Haarman   while (!atEOF() && !errorCount() && peek() != "}") {
2102ec34544SRui Ueyama     StringRef VerStr = next();
2112ec34544SRui Ueyama     if (VerStr == "{") {
2122ec34544SRui Ueyama       setError("anonymous version definition is used in "
2132ec34544SRui Ueyama                "combination with other version definitions");
2142ec34544SRui Ueyama       return;
2152ec34544SRui Ueyama     }
2162ec34544SRui Ueyama     expect("{");
2172ec34544SRui Ueyama     readVersionDeclaration(VerStr);
2182ec34544SRui Ueyama   }
2192ec34544SRui Ueyama }
2202ec34544SRui Ueyama 
2212ec34544SRui Ueyama void ScriptParser::readVersion() {
2222ec34544SRui Ueyama   expect("{");
2232ec34544SRui Ueyama   readVersionScriptCommand();
2242ec34544SRui Ueyama   expect("}");
2252ec34544SRui Ueyama }
2262ec34544SRui Ueyama 
2272ec34544SRui Ueyama void ScriptParser::readLinkerScript() {
2282ec34544SRui Ueyama   while (!atEOF()) {
2292ec34544SRui Ueyama     StringRef Tok = next();
2302ec34544SRui Ueyama     if (Tok == ";")
2312ec34544SRui Ueyama       continue;
2322ec34544SRui Ueyama 
233d30a78b3SGeorge Rimar     if (Tok == "ENTRY") {
2342ec34544SRui Ueyama       readEntry();
2352ec34544SRui Ueyama     } else if (Tok == "EXTERN") {
2362ec34544SRui Ueyama       readExtern();
2371d92aa73SRui Ueyama     } else if (Tok == "GROUP") {
2382ec34544SRui Ueyama       readGroup();
2392ec34544SRui Ueyama     } else if (Tok == "INCLUDE") {
2402ec34544SRui Ueyama       readInclude();
2411d92aa73SRui Ueyama     } else if (Tok == "INPUT") {
2421d92aa73SRui Ueyama       readInput();
2432ec34544SRui Ueyama     } else if (Tok == "MEMORY") {
2442ec34544SRui Ueyama       readMemory();
2452ec34544SRui Ueyama     } else if (Tok == "OUTPUT") {
2462ec34544SRui Ueyama       readOutput();
2472ec34544SRui Ueyama     } else if (Tok == "OUTPUT_ARCH") {
2482ec34544SRui Ueyama       readOutputArch();
2492ec34544SRui Ueyama     } else if (Tok == "OUTPUT_FORMAT") {
2502ec34544SRui Ueyama       readOutputFormat();
2512ec34544SRui Ueyama     } else if (Tok == "PHDRS") {
2522ec34544SRui Ueyama       readPhdrs();
2535f37541cSGeorge Rimar     } else if (Tok == "REGION_ALIAS") {
2545f37541cSGeorge Rimar       readRegionAlias();
2552ec34544SRui Ueyama     } else if (Tok == "SEARCH_DIR") {
2562ec34544SRui Ueyama       readSearchDir();
2572ec34544SRui Ueyama     } else if (Tok == "SECTIONS") {
2582ec34544SRui Ueyama       readSections();
259e262bb1aSRui Ueyama     } else if (Tok == "TARGET") {
260e262bb1aSRui Ueyama       readTarget();
2612ec34544SRui Ueyama     } else if (Tok == "VERSION") {
2622ec34544SRui Ueyama       readVersion();
263d30a78b3SGeorge Rimar     } else if (SymbolAssignment *Cmd = readAssignment(Tok)) {
2646b394caaSRui Ueyama       Script->SectionCommands.push_back(Cmd);
2652ec34544SRui Ueyama     } else {
2662ec34544SRui Ueyama       setError("unknown directive: " + Tok);
2672ec34544SRui Ueyama     }
2682ec34544SRui Ueyama   }
2692ec34544SRui Ueyama }
2702ec34544SRui Ueyama 
2718c7e8cceSPetr Hosek void ScriptParser::readDefsym(StringRef Name) {
272c1522816SGeorge Rimar   if (errorCount())
273c1522816SGeorge Rimar     return;
2748c7e8cceSPetr Hosek   Expr E = readExpr();
2758c7e8cceSPetr Hosek   if (!atEOF())
2768c7e8cceSPetr Hosek     setError("EOF expected, but got " + next());
277e88b76a9SGeorge Rimar   SymbolAssignment *Cmd = make<SymbolAssignment>(Name, E, getCurrentLocation());
2788c7e8cceSPetr Hosek   Script->SectionCommands.push_back(Cmd);
2798c7e8cceSPetr Hosek }
2808c7e8cceSPetr Hosek 
2812ec34544SRui Ueyama void ScriptParser::addFile(StringRef S) {
2822ec34544SRui Ueyama   if (IsUnderSysroot && S.startswith("/")) {
2832ec34544SRui Ueyama     SmallString<128> PathData;
2842ec34544SRui Ueyama     StringRef Path = (Config->Sysroot + S).toStringRef(PathData);
2852ec34544SRui Ueyama     if (sys::fs::exists(Path)) {
286a76349bfSEvgeniy Stepanov       Driver->addFile(Saver.save(Path), /*WithLOption=*/false);
2872ec34544SRui Ueyama       return;
2882ec34544SRui Ueyama     }
2892ec34544SRui Ueyama   }
2902ec34544SRui Ueyama 
291875ae82bSRui Ueyama   if (S.startswith("/")) {
292a76349bfSEvgeniy Stepanov     Driver->addFile(S, /*WithLOption=*/false);
2932ec34544SRui Ueyama   } else if (S.startswith("=")) {
2942ec34544SRui Ueyama     if (Config->Sysroot.empty())
295a76349bfSEvgeniy Stepanov       Driver->addFile(S.substr(1), /*WithLOption=*/false);
2962ec34544SRui Ueyama     else
297a76349bfSEvgeniy Stepanov       Driver->addFile(Saver.save(Config->Sysroot + "/" + S.substr(1)),
298a76349bfSEvgeniy Stepanov                       /*WithLOption=*/false);
2992ec34544SRui Ueyama   } else if (S.startswith("-l")) {
3002ec34544SRui Ueyama     Driver->addLibrary(S.substr(2));
3012ec34544SRui Ueyama   } else if (sys::fs::exists(S)) {
302a76349bfSEvgeniy Stepanov     Driver->addFile(S, /*WithLOption=*/false);
3032ec34544SRui Ueyama   } else {
3042ec34544SRui Ueyama     if (Optional<std::string> Path = findFromSearchPaths(S))
305a76349bfSEvgeniy Stepanov       Driver->addFile(Saver.save(*Path), /*WithLOption=*/true);
3062ec34544SRui Ueyama     else
3072ec34544SRui Ueyama       setError("unable to find " + S);
3082ec34544SRui Ueyama   }
3092ec34544SRui Ueyama }
3102ec34544SRui Ueyama 
3112ec34544SRui Ueyama void ScriptParser::readAsNeeded() {
3122ec34544SRui Ueyama   expect("(");
3132ec34544SRui Ueyama   bool Orig = Config->AsNeeded;
3142ec34544SRui Ueyama   Config->AsNeeded = true;
315b8a59c8aSBob Haarman   while (!errorCount() && !consume(")"))
3162ec34544SRui Ueyama     addFile(unquote(next()));
3172ec34544SRui Ueyama   Config->AsNeeded = Orig;
3182ec34544SRui Ueyama }
3192ec34544SRui Ueyama 
3202ec34544SRui Ueyama void ScriptParser::readEntry() {
3212ec34544SRui Ueyama   // -e <symbol> takes predecence over ENTRY(<symbol>).
3222ec34544SRui Ueyama   expect("(");
3232ec34544SRui Ueyama   StringRef Tok = next();
3242ec34544SRui Ueyama   if (Config->Entry.empty())
3252ec34544SRui Ueyama     Config->Entry = Tok;
3262ec34544SRui Ueyama   expect(")");
3272ec34544SRui Ueyama }
3282ec34544SRui Ueyama 
3292ec34544SRui Ueyama void ScriptParser::readExtern() {
3302ec34544SRui Ueyama   expect("(");
331b8a59c8aSBob Haarman   while (!errorCount() && !consume(")"))
3322ec34544SRui Ueyama     Config->Undefined.push_back(next());
3332ec34544SRui Ueyama }
3342ec34544SRui Ueyama 
3352ec34544SRui Ueyama void ScriptParser::readGroup() {
3361d92aa73SRui Ueyama   bool Orig = InputFile::IsInGroup;
3371d92aa73SRui Ueyama   InputFile::IsInGroup = true;
3381d92aa73SRui Ueyama   readInput();
3391d92aa73SRui Ueyama   InputFile::IsInGroup = Orig;
340b72daf00SFangrui Song   if (!Orig)
341b72daf00SFangrui Song     ++InputFile::NextGroupId;
3422ec34544SRui Ueyama }
3432ec34544SRui Ueyama 
3442ec34544SRui Ueyama void ScriptParser::readInclude() {
3452ec34544SRui Ueyama   StringRef Tok = unquote(next());
3462ec34544SRui Ueyama 
3470440be4aSRui Ueyama   if (!Seen.insert(Tok).second) {
3480440be4aSRui Ueyama     setError("there is a cycle in linker script INCLUDEs");
3490440be4aSRui Ueyama     return;
3500440be4aSRui Ueyama   }
3510440be4aSRui Ueyama 
352c60f85d0SFangrui Song   if (Optional<std::string> Path = searchScript(Tok)) {
3532ec34544SRui Ueyama     if (Optional<MemoryBufferRef> MB = readFile(*Path))
3542ec34544SRui Ueyama       tokenize(*MB);
3552ec34544SRui Ueyama     return;
3562ec34544SRui Ueyama   }
3571de78471SAlexander Richardson   setError("cannot find linker script " + Tok);
3582ec34544SRui Ueyama }
3592ec34544SRui Ueyama 
3601d92aa73SRui Ueyama void ScriptParser::readInput() {
3611d92aa73SRui Ueyama   expect("(");
3621d92aa73SRui Ueyama   while (!errorCount() && !consume(")")) {
3631d92aa73SRui Ueyama     if (consume("AS_NEEDED"))
3641d92aa73SRui Ueyama       readAsNeeded();
3651d92aa73SRui Ueyama     else
3661d92aa73SRui Ueyama       addFile(unquote(next()));
3671d92aa73SRui Ueyama   }
3681d92aa73SRui Ueyama }
3691d92aa73SRui Ueyama 
3702ec34544SRui Ueyama void ScriptParser::readOutput() {
3712ec34544SRui Ueyama   // -o <file> takes predecence over OUTPUT(<file>).
3722ec34544SRui Ueyama   expect("(");
3732ec34544SRui Ueyama   StringRef Tok = next();
3742ec34544SRui Ueyama   if (Config->OutputFile.empty())
3752ec34544SRui Ueyama     Config->OutputFile = unquote(Tok);
3762ec34544SRui Ueyama   expect(")");
3772ec34544SRui Ueyama }
3782ec34544SRui Ueyama 
3792ec34544SRui Ueyama void ScriptParser::readOutputArch() {
3802ec34544SRui Ueyama   // OUTPUT_ARCH is ignored for now.
3812ec34544SRui Ueyama   expect("(");
382b8a59c8aSBob Haarman   while (!errorCount() && !consume(")"))
3832ec34544SRui Ueyama     skip();
3842ec34544SRui Ueyama }
3852ec34544SRui Ueyama 
3860068d223SRui Ueyama static std::pair<ELFKind, uint16_t> parseBfdName(StringRef S) {
3870068d223SRui Ueyama   return StringSwitch<std::pair<ELFKind, uint16_t>>(S)
3884f8c8228SRui Ueyama       .Case("elf32-i386", {ELF32LEKind, EM_386})
3894f8c8228SRui Ueyama       .Case("elf32-iamcu", {ELF32LEKind, EM_IAMCU})
3904f8c8228SRui Ueyama       .Case("elf32-littlearm", {ELF32LEKind, EM_ARM})
3914f8c8228SRui Ueyama       .Case("elf32-x86-64", {ELF32LEKind, EM_X86_64})
392*19b134ccSDimitry Andric       .Case("elf64-aarch64", {ELF64LEKind, EM_AARCH64})
3934f8c8228SRui Ueyama       .Case("elf64-littleaarch64", {ELF64LEKind, EM_AARCH64})
3944f8c8228SRui Ueyama       .Case("elf64-powerpc", {ELF64BEKind, EM_PPC64})
3954f8c8228SRui Ueyama       .Case("elf64-powerpcle", {ELF64LEKind, EM_PPC64})
3964f8c8228SRui Ueyama       .Case("elf64-x86-64", {ELF64LEKind, EM_X86_64})
3974f8c8228SRui Ueyama       .Case("elf32-tradbigmips", {ELF32BEKind, EM_MIPS})
3984f8c8228SRui Ueyama       .Case("elf32-ntradbigmips", {ELF32BEKind, EM_MIPS})
3994f8c8228SRui Ueyama       .Case("elf32-tradlittlemips", {ELF32LEKind, EM_MIPS})
4004f8c8228SRui Ueyama       .Case("elf32-ntradlittlemips", {ELF32LEKind, EM_MIPS})
4014f8c8228SRui Ueyama       .Case("elf64-tradbigmips", {ELF64BEKind, EM_MIPS})
4024f8c8228SRui Ueyama       .Case("elf64-tradlittlemips", {ELF64LEKind, EM_MIPS})
4034f8c8228SRui Ueyama       .Default({ELFNoneKind, EM_NONE});
404ea8cd00aSRui Ueyama }
405ea8cd00aSRui Ueyama 
406ea8cd00aSRui Ueyama // Parse OUTPUT_FORMAT(bfdname) or OUTPUT_FORMAT(bfdname, big, little).
407ea8cd00aSRui Ueyama // Currently we ignore big and little parameters.
4082ec34544SRui Ueyama void ScriptParser::readOutputFormat() {
4092ec34544SRui Ueyama   expect("(");
410ea8cd00aSRui Ueyama 
411*19b134ccSDimitry Andric   StringRef Name = unquote(next());
412*19b134ccSDimitry Andric   StringRef S = Name;
413*19b134ccSDimitry Andric   if (S.consume_back("-freebsd"))
414*19b134ccSDimitry Andric     Config->OSABI = ELFOSABI_FREEBSD;
4154f8c8228SRui Ueyama 
4164f8c8228SRui Ueyama   std::tie(Config->EKind, Config->EMachine) = parseBfdName(S);
4174f8c8228SRui Ueyama   if (Config->EMachine == EM_NONE)
418*19b134ccSDimitry Andric     setError("unknown output format name: " + Name);
4194f8c8228SRui Ueyama   if (S == "elf32-ntradlittlemips" || S == "elf32-ntradbigmips")
4204f8c8228SRui Ueyama     Config->MipsN32Abi = true;
421ea8cd00aSRui Ueyama 
422b579c439SRui Ueyama   if (consume(")"))
4232ec34544SRui Ueyama     return;
424b579c439SRui Ueyama   expect(",");
4252ec34544SRui Ueyama   skip();
4262ec34544SRui Ueyama   expect(",");
4272ec34544SRui Ueyama   skip();
4282ec34544SRui Ueyama   expect(")");
4292ec34544SRui Ueyama }
4302ec34544SRui Ueyama 
4312ec34544SRui Ueyama void ScriptParser::readPhdrs() {
4322ec34544SRui Ueyama   expect("{");
4332ec34544SRui Ueyama 
434b8a59c8aSBob Haarman   while (!errorCount() && !consume("}")) {
4350ae2c24cSRui Ueyama     PhdrsCommand Cmd;
4360ae2c24cSRui Ueyama     Cmd.Name = next();
4370ae2c24cSRui Ueyama     Cmd.Type = readPhdrType();
438b579c439SRui Ueyama 
439b8a59c8aSBob Haarman     while (!errorCount() && !consume(";")) {
440b579c439SRui Ueyama       if (consume("FILEHDR"))
4410ae2c24cSRui Ueyama         Cmd.HasFilehdr = true;
442b579c439SRui Ueyama       else if (consume("PHDRS"))
4430ae2c24cSRui Ueyama         Cmd.HasPhdrs = true;
444b579c439SRui Ueyama       else if (consume("AT"))
4450ae2c24cSRui Ueyama         Cmd.LMAExpr = readParenExpr();
446b579c439SRui Ueyama       else if (consume("FLAGS"))
4470ae2c24cSRui Ueyama         Cmd.Flags = readParenExpr()().getValue();
448b579c439SRui Ueyama       else
449b579c439SRui Ueyama         setError("unexpected header attribute: " + next());
450b579c439SRui Ueyama     }
4510ae2c24cSRui Ueyama 
452ac27de9dSRui Ueyama     Script->PhdrsCommands.push_back(Cmd);
4532ec34544SRui Ueyama   }
4542ec34544SRui Ueyama }
4552ec34544SRui Ueyama 
4565f37541cSGeorge Rimar void ScriptParser::readRegionAlias() {
4575f37541cSGeorge Rimar   expect("(");
4585f37541cSGeorge Rimar   StringRef Alias = unquote(next());
4595f37541cSGeorge Rimar   expect(",");
4605f37541cSGeorge Rimar   StringRef Name = next();
4615f37541cSGeorge Rimar   expect(")");
4625f37541cSGeorge Rimar 
463ac27de9dSRui Ueyama   if (Script->MemoryRegions.count(Alias))
4645f37541cSGeorge Rimar     setError("redefinition of memory region '" + Alias + "'");
465ac27de9dSRui Ueyama   if (!Script->MemoryRegions.count(Name))
4665f37541cSGeorge Rimar     setError("memory region '" + Name + "' is not defined");
4678c825db2SGeorge Rimar   Script->MemoryRegions.insert({Alias, Script->MemoryRegions[Name]});
4685f37541cSGeorge Rimar }
4695f37541cSGeorge Rimar 
4702ec34544SRui Ueyama void ScriptParser::readSearchDir() {
4712ec34544SRui Ueyama   expect("(");
4722ec34544SRui Ueyama   StringRef Tok = next();
4732ec34544SRui Ueyama   if (!Config->Nostdlib)
4742ec34544SRui Ueyama     Config->SearchPaths.push_back(unquote(Tok));
4752ec34544SRui Ueyama   expect(")");
4762ec34544SRui Ueyama }
4772ec34544SRui Ueyama 
478a582419aSGeorge Rimar // This reads an overlay description. Overlays are used to describe output
479a582419aSGeorge Rimar // sections that use the same virtual memory range and normally would trigger
480a582419aSGeorge Rimar // linker's sections sanity check failures.
481a582419aSGeorge Rimar // https://sourceware.org/binutils/docs/ld/Overlay-Description.html#Overlay-Description
482a582419aSGeorge Rimar std::vector<BaseCommand *> ScriptParser::readOverlay() {
483a582419aSGeorge Rimar   // VA and LMA expressions are optional, though for simplicity of
484a582419aSGeorge Rimar   // implementation we assume they are not. That is what OVERLAY was designed
485a582419aSGeorge Rimar   // for first of all: to allow sections with overlapping VAs at different LMAs.
486a582419aSGeorge Rimar   Expr AddrExpr = readExpr();
487a582419aSGeorge Rimar   expect(":");
488a582419aSGeorge Rimar   expect("AT");
489a582419aSGeorge Rimar   Expr LMAExpr = readParenExpr();
490a582419aSGeorge Rimar   expect("{");
491a582419aSGeorge Rimar 
492a582419aSGeorge Rimar   std::vector<BaseCommand *> V;
493a582419aSGeorge Rimar   OutputSection *Prev = nullptr;
494a582419aSGeorge Rimar   while (!errorCount() && !consume("}")) {
495a582419aSGeorge Rimar     // VA is the same for all sections. The LMAs are consecutive in memory
496a582419aSGeorge Rimar     // starting from the base load address specified.
497a582419aSGeorge Rimar     OutputSection *OS = readOverlaySectionDescription();
498a582419aSGeorge Rimar     OS->AddrExpr = AddrExpr;
499a582419aSGeorge Rimar     if (Prev)
500a582419aSGeorge Rimar       OS->LMAExpr = [=] { return Prev->getLMA() + Prev->Size; };
501a582419aSGeorge Rimar     else
502a582419aSGeorge Rimar       OS->LMAExpr = LMAExpr;
503a582419aSGeorge Rimar     V.push_back(OS);
504a582419aSGeorge Rimar     Prev = OS;
505a582419aSGeorge Rimar   }
506a582419aSGeorge Rimar 
507a582419aSGeorge Rimar   // According to the specification, at the end of the overlay, the location
508a582419aSGeorge Rimar   // counter should be equal to the overlay base address plus size of the
509a582419aSGeorge Rimar   // largest section seen in the overlay.
510a582419aSGeorge Rimar   // Here we want to create the Dot assignment command to achieve that.
511a582419aSGeorge Rimar   Expr MoveDot = [=] {
512a582419aSGeorge Rimar     uint64_t Max = 0;
513a582419aSGeorge Rimar     for (BaseCommand *Cmd : V)
514a582419aSGeorge Rimar       Max = std::max(Max, cast<OutputSection>(Cmd)->Size);
515a582419aSGeorge Rimar     return AddrExpr().getValue() + Max;
516a582419aSGeorge Rimar   };
517a582419aSGeorge Rimar   V.push_back(make<SymbolAssignment>(".", MoveDot, getCurrentLocation()));
518a582419aSGeorge Rimar   return V;
519a582419aSGeorge Rimar }
520a582419aSGeorge Rimar 
5212ec34544SRui Ueyama void ScriptParser::readSections() {
522a323e2a7SRui Ueyama   Script->HasSectionsCommand = true;
523b579c439SRui Ueyama 
5242ec34544SRui Ueyama   // -no-rosegment is used to avoid placing read only non-executable sections in
5252ec34544SRui Ueyama   // their own segment. We do the same if SECTIONS command is present in linker
5262ec34544SRui Ueyama   // script. See comment for computeFlags().
5272ec34544SRui Ueyama   Config->SingleRoRx = true;
5282ec34544SRui Ueyama 
5292ec34544SRui Ueyama   expect("{");
5309e2c8a9dSGeorge Rimar   std::vector<BaseCommand *> V;
531b8a59c8aSBob Haarman   while (!errorCount() && !consume("}")) {
5322ec34544SRui Ueyama     StringRef Tok = next();
533a582419aSGeorge Rimar     if (Tok == "OVERLAY") {
534a582419aSGeorge Rimar       for (BaseCommand *Cmd : readOverlay())
535a582419aSGeorge Rimar         V.push_back(Cmd);
536a582419aSGeorge Rimar       continue;
5372e9d40d5SRui Ueyama     } else if (Tok == "INCLUDE") {
5382e9d40d5SRui Ueyama       readInclude();
5392e9d40d5SRui Ueyama       continue;
540a582419aSGeorge Rimar     }
541a582419aSGeorge Rimar 
542d30a78b3SGeorge Rimar     if (BaseCommand *Cmd = readAssignment(Tok))
5439e2c8a9dSGeorge Rimar       V.push_back(Cmd);
544d30a78b3SGeorge Rimar     else
545d30a78b3SGeorge Rimar       V.push_back(readOutputSectionDescription(Tok));
5462ec34544SRui Ueyama   }
5479e2c8a9dSGeorge Rimar 
5489e2c8a9dSGeorge Rimar   if (!atEOF() && consume("INSERT")) {
549796684b4SGeorge Rimar     std::vector<BaseCommand *> *Dest = nullptr;
550796684b4SGeorge Rimar     if (consume("AFTER"))
551796684b4SGeorge Rimar       Dest = &Script->InsertAfterCommands[next()];
552796684b4SGeorge Rimar     else if (consume("BEFORE"))
553796684b4SGeorge Rimar       Dest = &Script->InsertBeforeCommands[next()];
554796684b4SGeorge Rimar     else
555796684b4SGeorge Rimar       setError("expected AFTER/BEFORE, but got '" + next() + "'");
556796684b4SGeorge Rimar     if (Dest)
557796684b4SGeorge Rimar       Dest->insert(Dest->end(), V.begin(), V.end());
5589e2c8a9dSGeorge Rimar     return;
5599e2c8a9dSGeorge Rimar   }
5609e2c8a9dSGeorge Rimar 
5619e2c8a9dSGeorge Rimar   Script->SectionCommands.insert(Script->SectionCommands.end(), V.begin(),
5629e2c8a9dSGeorge Rimar                                  V.end());
5632ec34544SRui Ueyama }
5642ec34544SRui Ueyama 
565e262bb1aSRui Ueyama void ScriptParser::readTarget() {
566e262bb1aSRui Ueyama   // TARGET(foo) is an alias for "--format foo". Unlike GNU linkers,
567e262bb1aSRui Ueyama   // we accept only a limited set of BFD names (i.e. "elf" or "binary")
568e262bb1aSRui Ueyama   // for --format. We recognize only /^elf/ and "binary" in the linker
569e262bb1aSRui Ueyama   // script as well.
570e262bb1aSRui Ueyama   expect("(");
571e262bb1aSRui Ueyama   StringRef Tok = next();
572e262bb1aSRui Ueyama   expect(")");
573e262bb1aSRui Ueyama 
574e262bb1aSRui Ueyama   if (Tok.startswith("elf"))
575e262bb1aSRui Ueyama     Config->FormatBinary = false;
576e262bb1aSRui Ueyama   else if (Tok == "binary")
577e262bb1aSRui Ueyama     Config->FormatBinary = true;
578e262bb1aSRui Ueyama   else
579e262bb1aSRui Ueyama     setError("unknown target: " + Tok);
580e262bb1aSRui Ueyama }
581e262bb1aSRui Ueyama 
5822ec34544SRui Ueyama static int precedence(StringRef Op) {
5832ec34544SRui Ueyama   return StringSwitch<int>(Op)
584a5005482SGeorge Rimar       .Cases("*", "/", "%", 8)
585a5005482SGeorge Rimar       .Cases("+", "-", 7)
586a5005482SGeorge Rimar       .Cases("<<", ">>", 6)
587a5005482SGeorge Rimar       .Cases("<", "<=", ">", ">=", "==", "!=", 5)
588a5005482SGeorge Rimar       .Case("&", 4)
589a5005482SGeorge Rimar       .Case("|", 3)
590a5005482SGeorge Rimar       .Case("&&", 2)
591a5005482SGeorge Rimar       .Case("||", 1)
5922ec34544SRui Ueyama       .Default(-1);
5932ec34544SRui Ueyama }
5942ec34544SRui Ueyama 
5952ec34544SRui Ueyama StringMatcher ScriptParser::readFilePatterns() {
5962ec34544SRui Ueyama   std::vector<StringRef> V;
597b8a59c8aSBob Haarman   while (!errorCount() && !consume(")"))
5982ec34544SRui Ueyama     V.push_back(next());
5992ec34544SRui Ueyama   return StringMatcher(V);
6002ec34544SRui Ueyama }
6012ec34544SRui Ueyama 
6022ec34544SRui Ueyama SortSectionPolicy ScriptParser::readSortKind() {
6032ec34544SRui Ueyama   if (consume("SORT") || consume("SORT_BY_NAME"))
6042ec34544SRui Ueyama     return SortSectionPolicy::Name;
6052ec34544SRui Ueyama   if (consume("SORT_BY_ALIGNMENT"))
6062ec34544SRui Ueyama     return SortSectionPolicy::Alignment;
6072ec34544SRui Ueyama   if (consume("SORT_BY_INIT_PRIORITY"))
6082ec34544SRui Ueyama     return SortSectionPolicy::Priority;
6092ec34544SRui Ueyama   if (consume("SORT_NONE"))
6102ec34544SRui Ueyama     return SortSectionPolicy::None;
6112ec34544SRui Ueyama   return SortSectionPolicy::Default;
6122ec34544SRui Ueyama }
6132ec34544SRui Ueyama 
61403fc8d1eSRui Ueyama // Reads SECTIONS command contents in the following form:
61503fc8d1eSRui Ueyama //
61603fc8d1eSRui Ueyama // <contents> ::= <elem>*
61703fc8d1eSRui Ueyama // <elem>     ::= <exclude>? <glob-pattern>
61803fc8d1eSRui Ueyama // <exclude>  ::= "EXCLUDE_FILE" "(" <glob-pattern>+ ")"
61903fc8d1eSRui Ueyama //
62003fc8d1eSRui Ueyama // For example,
62103fc8d1eSRui Ueyama //
62203fc8d1eSRui Ueyama // *(.foo EXCLUDE_FILE (a.o) .bar EXCLUDE_FILE (b.o) .baz)
62303fc8d1eSRui Ueyama //
62403fc8d1eSRui Ueyama // is parsed as ".foo", ".bar" with "a.o", and ".baz" with "b.o".
62503fc8d1eSRui Ueyama // The semantics of that is section .foo in any file, section .bar in
62603fc8d1eSRui Ueyama // any file but a.o, and section .baz in any file but b.o.
6272ec34544SRui Ueyama std::vector<SectionPattern> ScriptParser::readInputSectionsList() {
6282ec34544SRui Ueyama   std::vector<SectionPattern> Ret;
629b8a59c8aSBob Haarman   while (!errorCount() && peek() != ")") {
6302ec34544SRui Ueyama     StringMatcher ExcludeFilePat;
6312ec34544SRui Ueyama     if (consume("EXCLUDE_FILE")) {
6322ec34544SRui Ueyama       expect("(");
6332ec34544SRui Ueyama       ExcludeFilePat = readFilePatterns();
6342ec34544SRui Ueyama     }
6352ec34544SRui Ueyama 
6362ec34544SRui Ueyama     std::vector<StringRef> V;
637b8a59c8aSBob Haarman     while (!errorCount() && peek() != ")" && peek() != "EXCLUDE_FILE")
6382ec34544SRui Ueyama       V.push_back(next());
6392ec34544SRui Ueyama 
6402ec34544SRui Ueyama     if (!V.empty())
6412ec34544SRui Ueyama       Ret.push_back({std::move(ExcludeFilePat), StringMatcher(V)});
6422ec34544SRui Ueyama     else
6432ec34544SRui Ueyama       setError("section pattern is expected");
6442ec34544SRui Ueyama   }
6452ec34544SRui Ueyama   return Ret;
6462ec34544SRui Ueyama }
6472ec34544SRui Ueyama 
6482ec34544SRui Ueyama // Reads contents of "SECTIONS" directive. That directive contains a
6492ec34544SRui Ueyama // list of glob patterns for input sections. The grammar is as follows.
6502ec34544SRui Ueyama //
6512ec34544SRui Ueyama // <patterns> ::= <section-list>
6522ec34544SRui Ueyama //              | <sort> "(" <section-list> ")"
6532ec34544SRui Ueyama //              | <sort> "(" <sort> "(" <section-list> ")" ")"
6542ec34544SRui Ueyama //
6552ec34544SRui Ueyama // <sort>     ::= "SORT" | "SORT_BY_NAME" | "SORT_BY_ALIGNMENT"
6562ec34544SRui Ueyama //              | "SORT_BY_INIT_PRIORITY" | "SORT_NONE"
6572ec34544SRui Ueyama //
6582ec34544SRui Ueyama // <section-list> is parsed by readInputSectionsList().
6592ec34544SRui Ueyama InputSectionDescription *
6602ec34544SRui Ueyama ScriptParser::readInputSectionRules(StringRef FilePattern) {
6612ec34544SRui Ueyama   auto *Cmd = make<InputSectionDescription>(FilePattern);
6622ec34544SRui Ueyama   expect("(");
6632ec34544SRui Ueyama 
664b8a59c8aSBob Haarman   while (!errorCount() && !consume(")")) {
6652ec34544SRui Ueyama     SortSectionPolicy Outer = readSortKind();
6662ec34544SRui Ueyama     SortSectionPolicy Inner = SortSectionPolicy::Default;
6672ec34544SRui Ueyama     std::vector<SectionPattern> V;
6682ec34544SRui Ueyama     if (Outer != SortSectionPolicy::Default) {
6692ec34544SRui Ueyama       expect("(");
6702ec34544SRui Ueyama       Inner = readSortKind();
6712ec34544SRui Ueyama       if (Inner != SortSectionPolicy::Default) {
6722ec34544SRui Ueyama         expect("(");
6732ec34544SRui Ueyama         V = readInputSectionsList();
6742ec34544SRui Ueyama         expect(")");
6752ec34544SRui Ueyama       } else {
6762ec34544SRui Ueyama         V = readInputSectionsList();
6772ec34544SRui Ueyama       }
6782ec34544SRui Ueyama       expect(")");
6792ec34544SRui Ueyama     } else {
6802ec34544SRui Ueyama       V = readInputSectionsList();
6812ec34544SRui Ueyama     }
6822ec34544SRui Ueyama 
6832ec34544SRui Ueyama     for (SectionPattern &Pat : V) {
6842ec34544SRui Ueyama       Pat.SortInner = Inner;
6852ec34544SRui Ueyama       Pat.SortOuter = Outer;
6862ec34544SRui Ueyama     }
6872ec34544SRui Ueyama 
6882ec34544SRui Ueyama     std::move(V.begin(), V.end(), std::back_inserter(Cmd->SectionPatterns));
6892ec34544SRui Ueyama   }
6902ec34544SRui Ueyama   return Cmd;
6912ec34544SRui Ueyama }
6922ec34544SRui Ueyama 
6932ec34544SRui Ueyama InputSectionDescription *
6942ec34544SRui Ueyama ScriptParser::readInputSectionDescription(StringRef Tok) {
6952ec34544SRui Ueyama   // Input section wildcard can be surrounded by KEEP.
6962ec34544SRui Ueyama   // https://sourceware.org/binutils/docs/ld/Input-Section-Keep.html#Input-Section-Keep
6972ec34544SRui Ueyama   if (Tok == "KEEP") {
6982ec34544SRui Ueyama     expect("(");
6992ec34544SRui Ueyama     StringRef FilePattern = next();
7002ec34544SRui Ueyama     InputSectionDescription *Cmd = readInputSectionRules(FilePattern);
7012ec34544SRui Ueyama     expect(")");
702ac27de9dSRui Ueyama     Script->KeptSections.push_back(Cmd);
7032ec34544SRui Ueyama     return Cmd;
7042ec34544SRui Ueyama   }
7052ec34544SRui Ueyama   return readInputSectionRules(Tok);
7062ec34544SRui Ueyama }
7072ec34544SRui Ueyama 
7082ec34544SRui Ueyama void ScriptParser::readSort() {
7092ec34544SRui Ueyama   expect("(");
7102ec34544SRui Ueyama   expect("CONSTRUCTORS");
7112ec34544SRui Ueyama   expect(")");
7122ec34544SRui Ueyama }
7132ec34544SRui Ueyama 
714d30a78b3SGeorge Rimar Expr ScriptParser::readAssert() {
7152ec34544SRui Ueyama   expect("(");
7162ec34544SRui Ueyama   Expr E = readExpr();
7172ec34544SRui Ueyama   expect(",");
7182ec34544SRui Ueyama   StringRef Msg = unquote(next());
7192ec34544SRui Ueyama   expect(")");
720b579c439SRui Ueyama 
7212ec34544SRui Ueyama   return [=] {
7222ec34544SRui Ueyama     if (!E().getValue())
7232ec34544SRui Ueyama       error(Msg);
7242ec34544SRui Ueyama     return Script->getDot();
7252ec34544SRui Ueyama   };
7262ec34544SRui Ueyama }
7272ec34544SRui Ueyama 
7282ec34544SRui Ueyama // Reads a FILL(expr) command. We handle the FILL command as an
7292ec34544SRui Ueyama // alias for =fillexp section attribute, which is different from
7302ec34544SRui Ueyama // what GNU linkers do.
7312ec34544SRui Ueyama // https://sourceware.org/binutils/docs/ld/Output-Section-Data.html
732b0486051SSimon Atanasyan std::array<uint8_t, 4> ScriptParser::readFill() {
7332ec34544SRui Ueyama   expect("(");
734b0486051SSimon Atanasyan   std::array<uint8_t, 4> V = parseFill(next());
7352ec34544SRui Ueyama   expect(")");
7362ec34544SRui Ueyama   return V;
7372ec34544SRui Ueyama }
7382ec34544SRui Ueyama 
739a46d08ebSGeorge Rimar // Tries to read the special directive for an output section definition which
740a46d08ebSGeorge Rimar // can be one of following: "(NOLOAD)", "(COPY)", "(INFO)" or "(OVERLAY)".
741a46d08ebSGeorge Rimar // Tok1 and Tok2 are next 2 tokens peeked. See comment for readSectionAddressType below.
742a46d08ebSGeorge Rimar bool ScriptParser::readSectionDirective(OutputSection *Cmd, StringRef Tok1, StringRef Tok2) {
743a46d08ebSGeorge Rimar   if (Tok1 != "(")
744a46d08ebSGeorge Rimar     return false;
745a46d08ebSGeorge Rimar   if (Tok2 != "NOLOAD" && Tok2 != "COPY" && Tok2 != "INFO" && Tok2 != "OVERLAY")
746a46d08ebSGeorge Rimar     return false;
747a46d08ebSGeorge Rimar 
748a46d08ebSGeorge Rimar   expect("(");
749a46d08ebSGeorge Rimar   if (consume("NOLOAD")) {
750a46d08ebSGeorge Rimar     Cmd->Noload = true;
751a46d08ebSGeorge Rimar   } else {
752a46d08ebSGeorge Rimar     skip(); // This is "COPY", "INFO" or "OVERLAY".
753a46d08ebSGeorge Rimar     Cmd->NonAlloc = true;
754a46d08ebSGeorge Rimar   }
755a46d08ebSGeorge Rimar   expect(")");
756a46d08ebSGeorge Rimar   return true;
757a46d08ebSGeorge Rimar }
758a46d08ebSGeorge Rimar 
7591c08e9f5SGeorge Rimar // Reads an expression and/or the special directive for an output
7601c08e9f5SGeorge Rimar // section definition. Directive is one of following: "(NOLOAD)",
7611c08e9f5SGeorge Rimar // "(COPY)", "(INFO)" or "(OVERLAY)".
7623271d370SRui Ueyama //
7633271d370SRui Ueyama // An output section name can be followed by an address expression
7641c08e9f5SGeorge Rimar // and/or directive. This grammar is not LL(1) because "(" can be
76597f4d158SGeorge Rimar // interpreted as either the beginning of some expression or beginning
7661c08e9f5SGeorge Rimar // of directive.
7673271d370SRui Ueyama //
768b579c439SRui Ueyama // https://sourceware.org/binutils/docs/ld/Output-Section-Address.html
769fbb0463fSGeorge Rimar // https://sourceware.org/binutils/docs/ld/Output-Section-Type.html
7708c022ca7SRafael Espindola void ScriptParser::readSectionAddressType(OutputSection *Cmd) {
771a46d08ebSGeorge Rimar   if (readSectionDirective(Cmd, peek(), peek2()))
7723271d370SRui Ueyama     return;
7733271d370SRui Ueyama 
774a46d08ebSGeorge Rimar   Cmd->AddrExpr = readExpr();
775a46d08ebSGeorge Rimar   if (peek() == "(" && !readSectionDirective(Cmd, "(", peek2()))
776a46d08ebSGeorge Rimar     setError("unknown section directive: " + peek2());
777fbb0463fSGeorge Rimar }
778fbb0463fSGeorge Rimar 
779f22ec9ddSGeorge Rimar static Expr checkAlignment(Expr E, std::string &Loc) {
780f22ec9ddSGeorge Rimar   return [=] {
781f22ec9ddSGeorge Rimar     uint64_t Alignment = std::max((uint64_t)1, E().getValue());
782f22ec9ddSGeorge Rimar     if (!isPowerOf2_64(Alignment)) {
783f22ec9ddSGeorge Rimar       error(Loc + ": alignment must be power of 2");
784f22ec9ddSGeorge Rimar       return (uint64_t)1; // Return a dummy value.
785f22ec9ddSGeorge Rimar     }
786f22ec9ddSGeorge Rimar     return Alignment;
787f22ec9ddSGeorge Rimar   };
788f22ec9ddSGeorge Rimar }
789f22ec9ddSGeorge Rimar 
790a582419aSGeorge Rimar OutputSection *ScriptParser::readOverlaySectionDescription() {
791a582419aSGeorge Rimar   OutputSection *Cmd =
792a582419aSGeorge Rimar       Script->createOutputSection(next(), getCurrentLocation());
793a582419aSGeorge Rimar   Cmd->InOverlay = true;
794a582419aSGeorge Rimar   expect("{");
795a582419aSGeorge Rimar   while (!errorCount() && !consume("}"))
796a582419aSGeorge Rimar     Cmd->SectionCommands.push_back(readInputSectionRules(next()));
797a582419aSGeorge Rimar   Cmd->Phdrs = readOutputSectionPhdrs();
798a582419aSGeorge Rimar   return Cmd;
799a582419aSGeorge Rimar }
800a582419aSGeorge Rimar 
8018c022ca7SRafael Espindola OutputSection *ScriptParser::readOutputSectionDescription(StringRef OutSec) {
8028c022ca7SRafael Espindola   OutputSection *Cmd =
8038c022ca7SRafael Espindola       Script->createOutputSection(OutSec, getCurrentLocation());
8043271d370SRui Ueyama 
805c4df670dSGeorge Rimar   size_t SymbolsReferenced = Script->ReferencedSymbols.size();
806c4df670dSGeorge Rimar 
8073271d370SRui Ueyama   if (peek() != ":")
8083271d370SRui Ueyama     readSectionAddressType(Cmd);
8092ec34544SRui Ueyama   expect(":");
8102ec34544SRui Ueyama 
811f22ec9ddSGeorge Rimar   std::string Location = getCurrentLocation();
8122ec34544SRui Ueyama   if (consume("AT"))
8132ec34544SRui Ueyama     Cmd->LMAExpr = readParenExpr();
8142ec34544SRui Ueyama   if (consume("ALIGN"))
815f22ec9ddSGeorge Rimar     Cmd->AlignExpr = checkAlignment(readParenExpr(), Location);
8162ec34544SRui Ueyama   if (consume("SUBALIGN"))
817f22ec9ddSGeorge Rimar     Cmd->SubalignExpr = checkAlignment(readParenExpr(), Location);
8182ec34544SRui Ueyama 
8192ec34544SRui Ueyama   // Parse constraints.
8202ec34544SRui Ueyama   if (consume("ONLY_IF_RO"))
8212ec34544SRui Ueyama     Cmd->Constraint = ConstraintKind::ReadOnly;
8222ec34544SRui Ueyama   if (consume("ONLY_IF_RW"))
8232ec34544SRui Ueyama     Cmd->Constraint = ConstraintKind::ReadWrite;
8242ec34544SRui Ueyama   expect("{");
8252ec34544SRui Ueyama 
826b8a59c8aSBob Haarman   while (!errorCount() && !consume("}")) {
8272ec34544SRui Ueyama     StringRef Tok = next();
8282ec34544SRui Ueyama     if (Tok == ";") {
8292ec34544SRui Ueyama       // Empty commands are allowed. Do nothing here.
830d30a78b3SGeorge Rimar     } else if (SymbolAssignment *Assign = readAssignment(Tok)) {
8316b394caaSRui Ueyama       Cmd->SectionCommands.push_back(Assign);
832f0403c60SRui Ueyama     } else if (ByteCommand *Data = readByteCommand(Tok)) {
8336b394caaSRui Ueyama       Cmd->SectionCommands.push_back(Data);
8342ec34544SRui Ueyama     } else if (Tok == "CONSTRUCTORS") {
8352ec34544SRui Ueyama       // CONSTRUCTORS is a keyword to make the linker recognize C++ ctors/dtors
8362ec34544SRui Ueyama       // by name. This is for very old file formats such as ECOFF/XCOFF.
8372ec34544SRui Ueyama       // For ELF, we should ignore.
8382ec34544SRui Ueyama     } else if (Tok == "FILL") {
8392ec34544SRui Ueyama       Cmd->Filler = readFill();
8402ec34544SRui Ueyama     } else if (Tok == "SORT") {
8412ec34544SRui Ueyama       readSort();
8422e9d40d5SRui Ueyama     } else if (Tok == "INCLUDE") {
8432e9d40d5SRui Ueyama       readInclude();
8442ec34544SRui Ueyama     } else if (peek() == "(") {
8456b394caaSRui Ueyama       Cmd->SectionCommands.push_back(readInputSectionDescription(Tok));
8462ec34544SRui Ueyama     } else {
847f49fe218SGeorge Rimar       // We have a file name and no input sections description. It is not a
848f49fe218SGeorge Rimar       // commonly used syntax, but still acceptable. In that case, all sections
849f49fe218SGeorge Rimar       // from the file will be included.
850e1fd3f94SGeorge Rimar       auto *ISD = make<InputSectionDescription>(Tok);
851f49fe218SGeorge Rimar       ISD->SectionPatterns.push_back({{}, StringMatcher({"*"})});
852f49fe218SGeorge Rimar       Cmd->SectionCommands.push_back(ISD);
8532ec34544SRui Ueyama     }
8542ec34544SRui Ueyama   }
8552ec34544SRui Ueyama 
8562ec34544SRui Ueyama   if (consume(">"))
8572ec34544SRui Ueyama     Cmd->MemoryRegionName = next();
8582ec34544SRui Ueyama 
8595d01a8beSGeorge Rimar   if (consume("AT")) {
8605d01a8beSGeorge Rimar     expect(">");
8615d01a8beSGeorge Rimar     Cmd->LMARegionName = next();
8625d01a8beSGeorge Rimar   }
8635d01a8beSGeorge Rimar 
8645d01a8beSGeorge Rimar   if (Cmd->LMAExpr && !Cmd->LMARegionName.empty())
8655d01a8beSGeorge Rimar     error("section can't have both LMA and a load region");
8665d01a8beSGeorge Rimar 
8672ec34544SRui Ueyama   Cmd->Phdrs = readOutputSectionPhdrs();
8682ec34544SRui Ueyama 
8692ec34544SRui Ueyama   if (consume("="))
8708acbf1ccSRui Ueyama     Cmd->Filler = parseFill(next());
8712ec34544SRui Ueyama   else if (peek().startswith("="))
8728acbf1ccSRui Ueyama     Cmd->Filler = parseFill(next().drop_front());
8732ec34544SRui Ueyama 
8742ec34544SRui Ueyama   // Consume optional comma following output section command.
8752ec34544SRui Ueyama   consume(",");
8762ec34544SRui Ueyama 
877c4df670dSGeorge Rimar   if (Script->ReferencedSymbols.size() > SymbolsReferenced)
878c4df670dSGeorge Rimar     Cmd->ExpressionsUseSymbols = true;
8792ec34544SRui Ueyama   return Cmd;
8802ec34544SRui Ueyama }
8812ec34544SRui Ueyama 
8828acbf1ccSRui Ueyama // Parses a given string as a octal/decimal/hexadecimal number and
8838acbf1ccSRui Ueyama // returns it as a big-endian number. Used for `=<fillexp>`.
8842ec34544SRui Ueyama // https://sourceware.org/binutils/docs/ld/Output-Section-Fill.html
8852ec34544SRui Ueyama //
8868acbf1ccSRui Ueyama // When reading a hexstring, ld.bfd handles it as a blob of arbitrary
8878acbf1ccSRui Ueyama // size, while ld.gold always handles it as a 32-bit big-endian number.
8888acbf1ccSRui Ueyama // We are compatible with ld.gold because it's easier to implement.
889b0486051SSimon Atanasyan std::array<uint8_t, 4> ScriptParser::parseFill(StringRef Tok) {
890b58079d4SRui Ueyama   uint32_t V = 0;
891ab94768cSGeorge Rimar   if (!to_integer(Tok, V))
8922ec34544SRui Ueyama     setError("invalid filler expression: " + Tok);
893b58079d4SRui Ueyama 
894b0486051SSimon Atanasyan   std::array<uint8_t, 4> Buf;
895b0486051SSimon Atanasyan   write32be(Buf.data(), V);
896b58079d4SRui Ueyama   return Buf;
8972ec34544SRui Ueyama }
8982ec34544SRui Ueyama 
8992ec34544SRui Ueyama SymbolAssignment *ScriptParser::readProvideHidden(bool Provide, bool Hidden) {
9002ec34544SRui Ueyama   expect("(");
901d30a78b3SGeorge Rimar   SymbolAssignment *Cmd = readSymbolAssignment(next());
9022ec34544SRui Ueyama   Cmd->Provide = Provide;
9032ec34544SRui Ueyama   Cmd->Hidden = Hidden;
9042ec34544SRui Ueyama   expect(")");
9052ec34544SRui Ueyama   return Cmd;
9062ec34544SRui Ueyama }
9072ec34544SRui Ueyama 
908d30a78b3SGeorge Rimar SymbolAssignment *ScriptParser::readAssignment(StringRef Tok) {
909d30a78b3SGeorge Rimar   // Assert expression returns Dot, so this is equal to ".=."
910d30a78b3SGeorge Rimar   if (Tok == "ASSERT")
911d30a78b3SGeorge Rimar     return make<SymbolAssignment>(".", readAssert(), getCurrentLocation());
912d30a78b3SGeorge Rimar 
913e88b76a9SGeorge Rimar   size_t OldPos = Pos;
9142ec34544SRui Ueyama   SymbolAssignment *Cmd = nullptr;
915e88b76a9SGeorge Rimar   if (peek() == "=" || peek() == "+=")
916d30a78b3SGeorge Rimar     Cmd = readSymbolAssignment(Tok);
917e88b76a9SGeorge Rimar   else if (Tok == "PROVIDE")
9182ec34544SRui Ueyama     Cmd = readProvideHidden(true, false);
919e88b76a9SGeorge Rimar   else if (Tok == "HIDDEN")
9202ec34544SRui Ueyama     Cmd = readProvideHidden(false, true);
921e88b76a9SGeorge Rimar   else if (Tok == "PROVIDE_HIDDEN")
9222ec34544SRui Ueyama     Cmd = readProvideHidden(true, true);
923e88b76a9SGeorge Rimar 
924e88b76a9SGeorge Rimar   if (Cmd) {
925e88b76a9SGeorge Rimar     Cmd->CommandString =
926e88b76a9SGeorge Rimar         Tok.str() + " " +
927e88b76a9SGeorge Rimar         llvm::join(Tokens.begin() + OldPos, Tokens.begin() + Pos, " ");
928e88b76a9SGeorge Rimar     expect(";");
9292ec34544SRui Ueyama   }
9302ec34544SRui Ueyama   return Cmd;
9312ec34544SRui Ueyama }
9322ec34544SRui Ueyama 
933d30a78b3SGeorge Rimar SymbolAssignment *ScriptParser::readSymbolAssignment(StringRef Name) {
9342ec34544SRui Ueyama   StringRef Op = next();
9352ec34544SRui Ueyama   assert(Op == "=" || Op == "+=");
9362ec34544SRui Ueyama   Expr E = readExpr();
9372ec34544SRui Ueyama   if (Op == "+=") {
9382ec34544SRui Ueyama     std::string Loc = getCurrentLocation();
939722221f5SRui Ueyama     E = [=] { return add(Script->getSymbolValue(Name, Loc), E()); };
9402ec34544SRui Ueyama   }
941e88b76a9SGeorge Rimar   return make<SymbolAssignment>(Name, E, getCurrentLocation());
9422ec34544SRui Ueyama }
9432ec34544SRui Ueyama 
9442ec34544SRui Ueyama // This is an operator-precedence parser to parse a linker
9452ec34544SRui Ueyama // script expression.
9462ec34544SRui Ueyama Expr ScriptParser::readExpr() {
9472ec34544SRui Ueyama   // Our lexer is context-aware. Set the in-expression bit so that
9482ec34544SRui Ueyama   // they apply different tokenization rules.
9492ec34544SRui Ueyama   bool Orig = InExpr;
9502ec34544SRui Ueyama   InExpr = true;
9512ec34544SRui Ueyama   Expr E = readExpr1(readPrimary(), 0);
9522ec34544SRui Ueyama   InExpr = Orig;
9532ec34544SRui Ueyama   return E;
9542ec34544SRui Ueyama }
9552ec34544SRui Ueyama 
9567b91e213SGeorge Rimar Expr ScriptParser::combine(StringRef Op, Expr L, Expr R) {
9572ec34544SRui Ueyama   if (Op == "+")
9582ec34544SRui Ueyama     return [=] { return add(L(), R()); };
9592ec34544SRui Ueyama   if (Op == "-")
9602ec34544SRui Ueyama     return [=] { return sub(L(), R()); };
961b579c439SRui Ueyama   if (Op == "*")
9621d20222aSRui Ueyama     return [=] { return L().getValue() * R().getValue(); };
9637b91e213SGeorge Rimar   if (Op == "/") {
9647b91e213SGeorge Rimar     std::string Loc = getCurrentLocation();
9657b91e213SGeorge Rimar     return [=]() -> uint64_t {
9667b91e213SGeorge Rimar       if (uint64_t RV = R().getValue())
9677b91e213SGeorge Rimar         return L().getValue() / RV;
9687b91e213SGeorge Rimar       error(Loc + ": division by zero");
969067617f9SRui Ueyama       return 0;
9707b91e213SGeorge Rimar     };
9717b91e213SGeorge Rimar   }
9727b91e213SGeorge Rimar   if (Op == "%") {
9737b91e213SGeorge Rimar     std::string Loc = getCurrentLocation();
9747b91e213SGeorge Rimar     return [=]() -> uint64_t {
9757b91e213SGeorge Rimar       if (uint64_t RV = R().getValue())
9767b91e213SGeorge Rimar         return L().getValue() % RV;
9777b91e213SGeorge Rimar       error(Loc + ": modulo by zero");
978067617f9SRui Ueyama       return 0;
9797b91e213SGeorge Rimar     };
9807b91e213SGeorge Rimar   }
9812ec34544SRui Ueyama   if (Op == "<<")
9827e915511SRui Ueyama     return [=] { return L().getValue() << R().getValue(); };
9832ec34544SRui Ueyama   if (Op == ">>")
9847e915511SRui Ueyama     return [=] { return L().getValue() >> R().getValue(); };
9852ec34544SRui Ueyama   if (Op == "<")
9862ec34544SRui Ueyama     return [=] { return L().getValue() < R().getValue(); };
9872ec34544SRui Ueyama   if (Op == ">")
9882ec34544SRui Ueyama     return [=] { return L().getValue() > R().getValue(); };
9892ec34544SRui Ueyama   if (Op == ">=")
9902ec34544SRui Ueyama     return [=] { return L().getValue() >= R().getValue(); };
9912ec34544SRui Ueyama   if (Op == "<=")
9922ec34544SRui Ueyama     return [=] { return L().getValue() <= R().getValue(); };
9932ec34544SRui Ueyama   if (Op == "==")
9942ec34544SRui Ueyama     return [=] { return L().getValue() == R().getValue(); };
9952ec34544SRui Ueyama   if (Op == "!=")
9962ec34544SRui Ueyama     return [=] { return L().getValue() != R().getValue(); };
997a5005482SGeorge Rimar   if (Op == "||")
998a5005482SGeorge Rimar     return [=] { return L().getValue() || R().getValue(); };
999a5005482SGeorge Rimar   if (Op == "&&")
1000a5005482SGeorge Rimar     return [=] { return L().getValue() && R().getValue(); };
10012ec34544SRui Ueyama   if (Op == "&")
10022ec34544SRui Ueyama     return [=] { return bitAnd(L(), R()); };
10032ec34544SRui Ueyama   if (Op == "|")
10042ec34544SRui Ueyama     return [=] { return bitOr(L(), R()); };
10052ec34544SRui Ueyama   llvm_unreachable("invalid operator");
10062ec34544SRui Ueyama }
10072ec34544SRui Ueyama 
10082ec34544SRui Ueyama // This is a part of the operator-precedence parser. This function
10092ec34544SRui Ueyama // assumes that the remaining token stream starts with an operator.
10102ec34544SRui Ueyama Expr ScriptParser::readExpr1(Expr Lhs, int MinPrec) {
1011b8a59c8aSBob Haarman   while (!atEOF() && !errorCount()) {
10122ec34544SRui Ueyama     // Read an operator and an expression.
10132ec34544SRui Ueyama     if (consume("?"))
10142ec34544SRui Ueyama       return readTernary(Lhs);
10152ec34544SRui Ueyama     StringRef Op1 = peek();
10162ec34544SRui Ueyama     if (precedence(Op1) < MinPrec)
10172ec34544SRui Ueyama       break;
10182ec34544SRui Ueyama     skip();
10192ec34544SRui Ueyama     Expr Rhs = readPrimary();
10202ec34544SRui Ueyama 
10212ec34544SRui Ueyama     // Evaluate the remaining part of the expression first if the
10222ec34544SRui Ueyama     // next operator has greater precedence than the previous one.
10232ec34544SRui Ueyama     // For example, if we have read "+" and "3", and if the next
10242ec34544SRui Ueyama     // operator is "*", then we'll evaluate 3 * ... part first.
10252ec34544SRui Ueyama     while (!atEOF()) {
10262ec34544SRui Ueyama       StringRef Op2 = peek();
10272ec34544SRui Ueyama       if (precedence(Op2) <= precedence(Op1))
10282ec34544SRui Ueyama         break;
10292ec34544SRui Ueyama       Rhs = readExpr1(Rhs, precedence(Op2));
10302ec34544SRui Ueyama     }
10312ec34544SRui Ueyama 
10322ec34544SRui Ueyama     Lhs = combine(Op1, Lhs, Rhs);
10332ec34544SRui Ueyama   }
10342ec34544SRui Ueyama   return Lhs;
10352ec34544SRui Ueyama }
10362ec34544SRui Ueyama 
10375fb17128SGeorge Rimar Expr ScriptParser::getPageSize() {
10385fb17128SGeorge Rimar   std::string Location = getCurrentLocation();
10395fb17128SGeorge Rimar   return [=]() -> uint64_t {
10405fb17128SGeorge Rimar     if (Target)
10412ec34544SRui Ueyama       return Target->PageSize;
10425fb17128SGeorge Rimar     error(Location + ": unable to calculate page size");
10435fb17128SGeorge Rimar     return 4096; // Return a dummy value.
10445fb17128SGeorge Rimar   };
10455fb17128SGeorge Rimar }
10465fb17128SGeorge Rimar 
10475fb17128SGeorge Rimar Expr ScriptParser::readConstant() {
10485fb17128SGeorge Rimar   StringRef S = readParenLiteral();
10495fb17128SGeorge Rimar   if (S == "COMMONPAGESIZE")
10505fb17128SGeorge Rimar     return getPageSize();
10512ec34544SRui Ueyama   if (S == "MAXPAGESIZE")
10525fb17128SGeorge Rimar     return [] { return Config->MaxPageSize; };
10535fb17128SGeorge Rimar   setError("unknown constant: " + S);
1054b068b037SGeorge Rimar   return [] { return 0; };
10552ec34544SRui Ueyama }
10562ec34544SRui Ueyama 
10575c65088fSRui Ueyama // Parses Tok as an integer. It recognizes hexadecimal (prefixed with
10585c65088fSRui Ueyama // "0x" or suffixed with "H") and decimal numbers. Decimal numbers may
10595c65088fSRui Ueyama // have "K" (Ki) or "M" (Mi) suffixes.
10605c65088fSRui Ueyama static Optional<uint64_t> parseInt(StringRef Tok) {
10612ec34544SRui Ueyama   // Hexadecimal
10625c65088fSRui Ueyama   uint64_t Val;
10634092016bSRui Ueyama   if (Tok.startswith_lower("0x")) {
10644092016bSRui Ueyama     if (!to_integer(Tok.substr(2), Val, 16))
10654092016bSRui Ueyama       return None;
10665c65088fSRui Ueyama     return Val;
10674092016bSRui Ueyama   }
10684092016bSRui Ueyama   if (Tok.endswith_lower("H")) {
10694092016bSRui Ueyama     if (!to_integer(Tok.drop_back(), Val, 16))
10704092016bSRui Ueyama       return None;
10715c65088fSRui Ueyama     return Val;
10724092016bSRui Ueyama   }
10732ec34544SRui Ueyama 
10742ec34544SRui Ueyama   // Decimal
10752ec34544SRui Ueyama   if (Tok.endswith_lower("K")) {
1076ab94768cSGeorge Rimar     if (!to_integer(Tok.drop_back(), Val, 10))
10775c65088fSRui Ueyama       return None;
10785c65088fSRui Ueyama     return Val * 1024;
10792ec34544SRui Ueyama   }
10805c65088fSRui Ueyama   if (Tok.endswith_lower("M")) {
1081ab94768cSGeorge Rimar     if (!to_integer(Tok.drop_back(), Val, 10))
10825c65088fSRui Ueyama       return None;
10835c65088fSRui Ueyama     return Val * 1024 * 1024;
10845c65088fSRui Ueyama   }
1085ab94768cSGeorge Rimar   if (!to_integer(Tok, Val, 10))
10865c65088fSRui Ueyama     return None;
10875c65088fSRui Ueyama   return Val;
10882ec34544SRui Ueyama }
10892ec34544SRui Ueyama 
1090f0403c60SRui Ueyama ByteCommand *ScriptParser::readByteCommand(StringRef Tok) {
1091b579c439SRui Ueyama   int Size = StringSwitch<int>(Tok)
10922ec34544SRui Ueyama                  .Case("BYTE", 1)
10932ec34544SRui Ueyama                  .Case("SHORT", 2)
10942ec34544SRui Ueyama                  .Case("LONG", 4)
10952ec34544SRui Ueyama                  .Case("QUAD", 8)
10962ec34544SRui Ueyama                  .Default(-1);
10972ec34544SRui Ueyama   if (Size == -1)
10982ec34544SRui Ueyama     return nullptr;
109984bcabcbSGeorge Rimar 
110084bcabcbSGeorge Rimar   size_t OldPos = Pos;
110184bcabcbSGeorge Rimar   Expr E = readParenExpr();
110284bcabcbSGeorge Rimar   std::string CommandString =
110384bcabcbSGeorge Rimar       Tok.str() + " " +
110484bcabcbSGeorge Rimar       llvm::join(Tokens.begin() + OldPos, Tokens.begin() + Pos, " ");
110584bcabcbSGeorge Rimar   return make<ByteCommand>(E, Size, CommandString);
11062ec34544SRui Ueyama }
11072ec34544SRui Ueyama 
11082ec34544SRui Ueyama StringRef ScriptParser::readParenLiteral() {
11092ec34544SRui Ueyama   expect("(");
11105e9c7762SRafael Espindola   bool Orig = InExpr;
11115e9c7762SRafael Espindola   InExpr = false;
11122ec34544SRui Ueyama   StringRef Tok = next();
11135e9c7762SRafael Espindola   InExpr = Orig;
11142ec34544SRui Ueyama   expect(")");
11152ec34544SRui Ueyama   return Tok;
11162ec34544SRui Ueyama }
11172ec34544SRui Ueyama 
1118617e2f98SRui Ueyama static void checkIfExists(OutputSection *Cmd, StringRef Location) {
111905c4f67cSRafael Espindola   if (Cmd->Location.empty() && Script->ErrorOnMissingSection)
112005c4f67cSRafael Espindola     error(Location + ": undefined section " + Cmd->Name);
112105c4f67cSRafael Espindola }
112205c4f67cSRafael Espindola 
11232ec34544SRui Ueyama Expr ScriptParser::readPrimary() {
11242ec34544SRui Ueyama   if (peek() == "(")
11252ec34544SRui Ueyama     return readParenExpr();
11262ec34544SRui Ueyama 
11275c65088fSRui Ueyama   if (consume("~")) {
11282ec34544SRui Ueyama     Expr E = readPrimary();
1129b2fb84a1SRui Ueyama     return [=] { return ~E().getValue(); };
11302ec34544SRui Ueyama   }
11316f1d954eSHafiz Abid Qadeer   if (consume("!")) {
11326f1d954eSHafiz Abid Qadeer     Expr E = readPrimary();
11336f1d954eSHafiz Abid Qadeer     return [=] { return !E().getValue(); };
11346f1d954eSHafiz Abid Qadeer   }
11355c65088fSRui Ueyama   if (consume("-")) {
11362ec34544SRui Ueyama     Expr E = readPrimary();
1137b2fb84a1SRui Ueyama     return [=] { return -E().getValue(); };
11382ec34544SRui Ueyama   }
11392ec34544SRui Ueyama 
11405c65088fSRui Ueyama   StringRef Tok = next();
11415c65088fSRui Ueyama   std::string Location = getCurrentLocation();
11425c65088fSRui Ueyama 
11432ec34544SRui Ueyama   // Built-in functions are parsed here.
11442ec34544SRui Ueyama   // https://sourceware.org/binutils/docs/ld/Builtin-Functions.html.
11452ec34544SRui Ueyama   if (Tok == "ABSOLUTE") {
11462ec34544SRui Ueyama     Expr Inner = readParenExpr();
11472ec34544SRui Ueyama     return [=] {
11482ec34544SRui Ueyama       ExprValue I = Inner();
11492ec34544SRui Ueyama       I.ForceAbsolute = true;
11502ec34544SRui Ueyama       return I;
11512ec34544SRui Ueyama     };
11522ec34544SRui Ueyama   }
11532ec34544SRui Ueyama   if (Tok == "ADDR") {
11542ec34544SRui Ueyama     StringRef Name = readParenLiteral();
11554fbe3518SRui Ueyama     OutputSection *Sec = Script->getOrCreateOutputSection(Name);
115641c7ab4aSGeorge Rimar     return [=]() -> ExprValue {
11574fbe3518SRui Ueyama       checkIfExists(Sec, Location);
11584fbe3518SRui Ueyama       return {Sec, false, 0, Location};
115941c7ab4aSGeorge Rimar     };
11602ec34544SRui Ueyama   }
11612ec34544SRui Ueyama   if (Tok == "ALIGN") {
11622ec34544SRui Ueyama     expect("(");
11632ec34544SRui Ueyama     Expr E = readExpr();
1164f22ec9ddSGeorge Rimar     if (consume(")")) {
1165f22ec9ddSGeorge Rimar       E = checkAlignment(E, Location);
1166f22ec9ddSGeorge Rimar       return [=] { return alignTo(Script->getDot(), E().getValue()); };
1167f22ec9ddSGeorge Rimar     }
1168b579c439SRui Ueyama     expect(",");
1169f22ec9ddSGeorge Rimar     Expr E2 = checkAlignment(readExpr(), Location);
11702ec34544SRui Ueyama     expect(")");
11713c6de1a6SPetr Hosek     return [=] {
11723c6de1a6SPetr Hosek       ExprValue V = E();
1173f22ec9ddSGeorge Rimar       V.Alignment = E2().getValue();
11743c6de1a6SPetr Hosek       return V;
11753c6de1a6SPetr Hosek     };
11762ec34544SRui Ueyama   }
11772ec34544SRui Ueyama   if (Tok == "ALIGNOF") {
11782ec34544SRui Ueyama     StringRef Name = readParenLiteral();
11798c022ca7SRafael Espindola     OutputSection *Cmd = Script->getOrCreateOutputSection(Name);
1180617e2f98SRui Ueyama     return [=] {
1181617e2f98SRui Ueyama       checkIfExists(Cmd, Location);
1182617e2f98SRui Ueyama       return Cmd->Alignment;
1183617e2f98SRui Ueyama     };
11842ec34544SRui Ueyama   }
11852ec34544SRui Ueyama   if (Tok == "ASSERT")
1186d30a78b3SGeorge Rimar     return readAssert();
11875fb17128SGeorge Rimar   if (Tok == "CONSTANT")
11885fb17128SGeorge Rimar     return readConstant();
11892ec34544SRui Ueyama   if (Tok == "DATA_SEGMENT_ALIGN") {
11902ec34544SRui Ueyama     expect("(");
11912ec34544SRui Ueyama     Expr E = readExpr();
11922ec34544SRui Ueyama     expect(",");
11932ec34544SRui Ueyama     readExpr();
11942ec34544SRui Ueyama     expect(")");
119560833f6eSGeorge Rimar     return [=] {
119660833f6eSGeorge Rimar       return alignTo(Script->getDot(), std::max((uint64_t)1, E().getValue()));
119760833f6eSGeorge Rimar     };
11982ec34544SRui Ueyama   }
11992ec34544SRui Ueyama   if (Tok == "DATA_SEGMENT_END") {
12002ec34544SRui Ueyama     expect("(");
12012ec34544SRui Ueyama     expect(".");
12022ec34544SRui Ueyama     expect(")");
12032ec34544SRui Ueyama     return [] { return Script->getDot(); };
12042ec34544SRui Ueyama   }
12052ec34544SRui Ueyama   if (Tok == "DATA_SEGMENT_RELRO_END") {
12062ec34544SRui Ueyama     // GNU linkers implements more complicated logic to handle
12072ec34544SRui Ueyama     // DATA_SEGMENT_RELRO_END. We instead ignore the arguments and
12082ec34544SRui Ueyama     // just align to the next page boundary for simplicity.
12092ec34544SRui Ueyama     expect("(");
12102ec34544SRui Ueyama     readExpr();
12112ec34544SRui Ueyama     expect(",");
12122ec34544SRui Ueyama     readExpr();
12132ec34544SRui Ueyama     expect(")");
12145fb17128SGeorge Rimar     Expr E = getPageSize();
12155fb17128SGeorge Rimar     return [=] { return alignTo(Script->getDot(), E().getValue()); };
12162ec34544SRui Ueyama   }
12172ec34544SRui Ueyama   if (Tok == "DEFINED") {
12182ec34544SRui Ueyama     StringRef Name = readParenLiteral();
12199b18f50fSRui Ueyama     return [=] { return Symtab->find(Name) ? 1 : 0; };
12202ec34544SRui Ueyama   }
122191b95b61SRui Ueyama   if (Tok == "LENGTH") {
122291b95b61SRui Ueyama     StringRef Name = readParenLiteral();
1223b068b037SGeorge Rimar     if (Script->MemoryRegions.count(Name) == 0) {
122491b95b61SRui Ueyama       setError("memory region not defined: " + Name);
1225b068b037SGeorge Rimar       return [] { return 0; };
1226b068b037SGeorge Rimar     }
1227ac27de9dSRui Ueyama     return [=] { return Script->MemoryRegions[Name]->Length; };
122891b95b61SRui Ueyama   }
12292ec34544SRui Ueyama   if (Tok == "LOADADDR") {
12302ec34544SRui Ueyama     StringRef Name = readParenLiteral();
12318c022ca7SRafael Espindola     OutputSection *Cmd = Script->getOrCreateOutputSection(Name);
1232617e2f98SRui Ueyama     return [=] {
1233617e2f98SRui Ueyama       checkIfExists(Cmd, Location);
1234617e2f98SRui Ueyama       return Cmd->getLMA();
1235617e2f98SRui Ueyama     };
12362ec34544SRui Ueyama   }
1237fd11560fSGeorge Rimar   if (Tok == "MAX" || Tok == "MIN") {
1238fd11560fSGeorge Rimar     expect("(");
1239fd11560fSGeorge Rimar     Expr A = readExpr();
1240fd11560fSGeorge Rimar     expect(",");
1241fd11560fSGeorge Rimar     Expr B = readExpr();
1242fd11560fSGeorge Rimar     expect(")");
1243fd11560fSGeorge Rimar     if (Tok == "MIN")
1244fd11560fSGeorge Rimar       return [=] { return std::min(A().getValue(), B().getValue()); };
1245fd11560fSGeorge Rimar     return [=] { return std::max(A().getValue(), B().getValue()); };
1246fd11560fSGeorge Rimar   }
124791b95b61SRui Ueyama   if (Tok == "ORIGIN") {
124891b95b61SRui Ueyama     StringRef Name = readParenLiteral();
1249b068b037SGeorge Rimar     if (Script->MemoryRegions.count(Name) == 0) {
125091b95b61SRui Ueyama       setError("memory region not defined: " + Name);
1251b068b037SGeorge Rimar       return [] { return 0; };
1252b068b037SGeorge Rimar     }
1253ac27de9dSRui Ueyama     return [=] { return Script->MemoryRegions[Name]->Origin; };
125491b95b61SRui Ueyama   }
12552ec34544SRui Ueyama   if (Tok == "SEGMENT_START") {
12562ec34544SRui Ueyama     expect("(");
12572ec34544SRui Ueyama     skip();
12582ec34544SRui Ueyama     expect(",");
12592ec34544SRui Ueyama     Expr E = readExpr();
12602ec34544SRui Ueyama     expect(")");
12612ec34544SRui Ueyama     return [=] { return E(); };
12622ec34544SRui Ueyama   }
12632ec34544SRui Ueyama   if (Tok == "SIZEOF") {
12642ec34544SRui Ueyama     StringRef Name = readParenLiteral();
12658c022ca7SRafael Espindola     OutputSection *Cmd = Script->getOrCreateOutputSection(Name);
126605c4f67cSRafael Espindola     // Linker script does not create an output section if its content is empty.
126705c4f67cSRafael Espindola     // We want to allow SIZEOF(.foo) where .foo is a section which happened to
126805c4f67cSRafael Espindola     // be empty.
12698c022ca7SRafael Espindola     return [=] { return Cmd->Size; };
12702ec34544SRui Ueyama   }
12712ec34544SRui Ueyama   if (Tok == "SIZEOF_HEADERS")
12722ec34544SRui Ueyama     return [=] { return elf::getHeaderSize(); };
12732ec34544SRui Ueyama 
12744eb2eccbSRui Ueyama   // Tok is the dot.
12754eb2eccbSRui Ueyama   if (Tok == ".")
1276722221f5SRui Ueyama     return [=] { return Script->getSymbolValue(Tok, Location); };
12774eb2eccbSRui Ueyama 
12782ec34544SRui Ueyama   // Tok is a literal number.
12795c65088fSRui Ueyama   if (Optional<uint64_t> Val = parseInt(Tok))
12805c65088fSRui Ueyama     return [=] { return *Val; };
12812ec34544SRui Ueyama 
12822ec34544SRui Ueyama   // Tok is a symbol name.
12832ec34544SRui Ueyama   if (!isValidCIdentifier(Tok))
12842ec34544SRui Ueyama     setError("malformed number: " + Tok);
1285ac27de9dSRui Ueyama   Script->ReferencedSymbols.push_back(Tok);
1286722221f5SRui Ueyama   return [=] { return Script->getSymbolValue(Tok, Location); };
12872ec34544SRui Ueyama }
12882ec34544SRui Ueyama 
12892ec34544SRui Ueyama Expr ScriptParser::readTernary(Expr Cond) {
12902ec34544SRui Ueyama   Expr L = readExpr();
12912ec34544SRui Ueyama   expect(":");
12922ec34544SRui Ueyama   Expr R = readExpr();
12932ec34544SRui Ueyama   return [=] { return Cond().getValue() ? L() : R(); };
12942ec34544SRui Ueyama }
12952ec34544SRui Ueyama 
12962ec34544SRui Ueyama Expr ScriptParser::readParenExpr() {
12972ec34544SRui Ueyama   expect("(");
12982ec34544SRui Ueyama   Expr E = readExpr();
12992ec34544SRui Ueyama   expect(")");
13002ec34544SRui Ueyama   return E;
13012ec34544SRui Ueyama }
13022ec34544SRui Ueyama 
13032ec34544SRui Ueyama std::vector<StringRef> ScriptParser::readOutputSectionPhdrs() {
13042ec34544SRui Ueyama   std::vector<StringRef> Phdrs;
1305b8a59c8aSBob Haarman   while (!errorCount() && peek().startswith(":")) {
13062ec34544SRui Ueyama     StringRef Tok = next();
13072ec34544SRui Ueyama     Phdrs.push_back((Tok.size() == 1) ? next() : Tok.substr(1));
13082ec34544SRui Ueyama   }
13092ec34544SRui Ueyama   return Phdrs;
13102ec34544SRui Ueyama }
13112ec34544SRui Ueyama 
13122ec34544SRui Ueyama // Read a program header type name. The next token must be a
13132ec34544SRui Ueyama // name of a program header type or a constant (e.g. "0x3").
13142ec34544SRui Ueyama unsigned ScriptParser::readPhdrType() {
13152ec34544SRui Ueyama   StringRef Tok = next();
13165c65088fSRui Ueyama   if (Optional<uint64_t> Val = parseInt(Tok))
13175c65088fSRui Ueyama     return *Val;
13182ec34544SRui Ueyama 
13192ec34544SRui Ueyama   unsigned Ret = StringSwitch<unsigned>(Tok)
13202ec34544SRui Ueyama                      .Case("PT_NULL", PT_NULL)
13212ec34544SRui Ueyama                      .Case("PT_LOAD", PT_LOAD)
13222ec34544SRui Ueyama                      .Case("PT_DYNAMIC", PT_DYNAMIC)
13232ec34544SRui Ueyama                      .Case("PT_INTERP", PT_INTERP)
13242ec34544SRui Ueyama                      .Case("PT_NOTE", PT_NOTE)
13252ec34544SRui Ueyama                      .Case("PT_SHLIB", PT_SHLIB)
13262ec34544SRui Ueyama                      .Case("PT_PHDR", PT_PHDR)
13272ec34544SRui Ueyama                      .Case("PT_TLS", PT_TLS)
13282ec34544SRui Ueyama                      .Case("PT_GNU_EH_FRAME", PT_GNU_EH_FRAME)
13292ec34544SRui Ueyama                      .Case("PT_GNU_STACK", PT_GNU_STACK)
13302ec34544SRui Ueyama                      .Case("PT_GNU_RELRO", PT_GNU_RELRO)
13312ec34544SRui Ueyama                      .Case("PT_OPENBSD_RANDOMIZE", PT_OPENBSD_RANDOMIZE)
13322ec34544SRui Ueyama                      .Case("PT_OPENBSD_WXNEEDED", PT_OPENBSD_WXNEEDED)
13332ec34544SRui Ueyama                      .Case("PT_OPENBSD_BOOTDATA", PT_OPENBSD_BOOTDATA)
13342ec34544SRui Ueyama                      .Default(-1);
13352ec34544SRui Ueyama 
13362ec34544SRui Ueyama   if (Ret == (unsigned)-1) {
13372ec34544SRui Ueyama     setError("invalid program header type: " + Tok);
13382ec34544SRui Ueyama     return PT_NULL;
13392ec34544SRui Ueyama   }
13402ec34544SRui Ueyama   return Ret;
13412ec34544SRui Ueyama }
13422ec34544SRui Ueyama 
13432ec34544SRui Ueyama // Reads an anonymous version declaration.
13442ec34544SRui Ueyama void ScriptParser::readAnonymousDeclaration() {
13452ec34544SRui Ueyama   std::vector<SymbolVersion> Locals;
13462ec34544SRui Ueyama   std::vector<SymbolVersion> Globals;
13472ec34544SRui Ueyama   std::tie(Locals, Globals) = readSymbols();
13482ec34544SRui Ueyama 
13492ec34544SRui Ueyama   for (SymbolVersion V : Locals) {
13502ec34544SRui Ueyama     if (V.Name == "*")
13512ec34544SRui Ueyama       Config->DefaultSymbolVersion = VER_NDX_LOCAL;
13522ec34544SRui Ueyama     else
13532ec34544SRui Ueyama       Config->VersionScriptLocals.push_back(V);
13542ec34544SRui Ueyama   }
13552ec34544SRui Ueyama 
13562ec34544SRui Ueyama   for (SymbolVersion V : Globals)
13572ec34544SRui Ueyama     Config->VersionScriptGlobals.push_back(V);
13582ec34544SRui Ueyama 
13592ec34544SRui Ueyama   expect(";");
13602ec34544SRui Ueyama }
13612ec34544SRui Ueyama 
13622ec34544SRui Ueyama // Reads a non-anonymous version definition,
13632ec34544SRui Ueyama // e.g. "VerStr { global: foo; bar; local: *; };".
13642ec34544SRui Ueyama void ScriptParser::readVersionDeclaration(StringRef VerStr) {
13652ec34544SRui Ueyama   // Read a symbol list.
13662ec34544SRui Ueyama   std::vector<SymbolVersion> Locals;
13672ec34544SRui Ueyama   std::vector<SymbolVersion> Globals;
13682ec34544SRui Ueyama   std::tie(Locals, Globals) = readSymbols();
13692ec34544SRui Ueyama 
13702ec34544SRui Ueyama   for (SymbolVersion V : Locals) {
13712ec34544SRui Ueyama     if (V.Name == "*")
13722ec34544SRui Ueyama       Config->DefaultSymbolVersion = VER_NDX_LOCAL;
13732ec34544SRui Ueyama     else
13742ec34544SRui Ueyama       Config->VersionScriptLocals.push_back(V);
13752ec34544SRui Ueyama   }
13762ec34544SRui Ueyama 
13772ec34544SRui Ueyama   // Create a new version definition and add that to the global symbols.
13782ec34544SRui Ueyama   VersionDefinition Ver;
13792ec34544SRui Ueyama   Ver.Name = VerStr;
13802ec34544SRui Ueyama   Ver.Globals = Globals;
13812ec34544SRui Ueyama 
13822ec34544SRui Ueyama   // User-defined version number starts from 2 because 0 and 1 are
13832ec34544SRui Ueyama   // reserved for VER_NDX_LOCAL and VER_NDX_GLOBAL, respectively.
13842ec34544SRui Ueyama   Ver.Id = Config->VersionDefinitions.size() + 2;
13852ec34544SRui Ueyama   Config->VersionDefinitions.push_back(Ver);
13862ec34544SRui Ueyama 
13872ec34544SRui Ueyama   // Each version may have a parent version. For example, "Ver2"
13882ec34544SRui Ueyama   // defined as "Ver2 { global: foo; local: *; } Ver1;" has "Ver1"
13892ec34544SRui Ueyama   // as a parent. This version hierarchy is, probably against your
13902ec34544SRui Ueyama   // instinct, purely for hint; the runtime doesn't care about it
13912ec34544SRui Ueyama   // at all. In LLD, we simply ignore it.
13922ec34544SRui Ueyama   if (peek() != ";")
13932ec34544SRui Ueyama     skip();
13942ec34544SRui Ueyama   expect(";");
13952ec34544SRui Ueyama }
13962ec34544SRui Ueyama 
13971e77ad14SRui Ueyama static bool hasWildcard(StringRef S) {
13981e77ad14SRui Ueyama   return S.find_first_of("?*[") != StringRef::npos;
13991e77ad14SRui Ueyama }
14001e77ad14SRui Ueyama 
14012ec34544SRui Ueyama // Reads a list of symbols, e.g. "{ global: foo; bar; local: *; };".
14022ec34544SRui Ueyama std::pair<std::vector<SymbolVersion>, std::vector<SymbolVersion>>
14032ec34544SRui Ueyama ScriptParser::readSymbols() {
14042ec34544SRui Ueyama   std::vector<SymbolVersion> Locals;
14052ec34544SRui Ueyama   std::vector<SymbolVersion> Globals;
14062ec34544SRui Ueyama   std::vector<SymbolVersion> *V = &Globals;
14072ec34544SRui Ueyama 
1408b8a59c8aSBob Haarman   while (!errorCount()) {
14092ec34544SRui Ueyama     if (consume("}"))
14102ec34544SRui Ueyama       break;
14112ec34544SRui Ueyama     if (consumeLabel("local")) {
14122ec34544SRui Ueyama       V = &Locals;
14132ec34544SRui Ueyama       continue;
14142ec34544SRui Ueyama     }
14152ec34544SRui Ueyama     if (consumeLabel("global")) {
14162ec34544SRui Ueyama       V = &Globals;
14172ec34544SRui Ueyama       continue;
14182ec34544SRui Ueyama     }
14192ec34544SRui Ueyama 
14202ec34544SRui Ueyama     if (consume("extern")) {
14212ec34544SRui Ueyama       std::vector<SymbolVersion> Ext = readVersionExtern();
14222ec34544SRui Ueyama       V->insert(V->end(), Ext.begin(), Ext.end());
14232ec34544SRui Ueyama     } else {
14242ec34544SRui Ueyama       StringRef Tok = next();
14252ec34544SRui Ueyama       V->push_back({unquote(Tok), false, hasWildcard(Tok)});
14262ec34544SRui Ueyama     }
14272ec34544SRui Ueyama     expect(";");
14282ec34544SRui Ueyama   }
14292ec34544SRui Ueyama   return {Locals, Globals};
14302ec34544SRui Ueyama }
14312ec34544SRui Ueyama 
14322ec34544SRui Ueyama // Reads an "extern C++" directive, e.g.,
14332ec34544SRui Ueyama // "extern "C++" { ns::*; "f(int, double)"; };"
143417324d8bSRui Ueyama //
143517324d8bSRui Ueyama // The last semicolon is optional. E.g. this is OK:
143617324d8bSRui Ueyama // "extern "C++" { ns::*; "f(int, double)" };"
14372ec34544SRui Ueyama std::vector<SymbolVersion> ScriptParser::readVersionExtern() {
14382ec34544SRui Ueyama   StringRef Tok = next();
14392ec34544SRui Ueyama   bool IsCXX = Tok == "\"C++\"";
14402ec34544SRui Ueyama   if (!IsCXX && Tok != "\"C\"")
14412ec34544SRui Ueyama     setError("Unknown language");
14422ec34544SRui Ueyama   expect("{");
14432ec34544SRui Ueyama 
14442ec34544SRui Ueyama   std::vector<SymbolVersion> Ret;
1445b8a59c8aSBob Haarman   while (!errorCount() && peek() != "}") {
14462ec34544SRui Ueyama     StringRef Tok = next();
14472ec34544SRui Ueyama     bool HasWildcard = !Tok.startswith("\"") && hasWildcard(Tok);
14482ec34544SRui Ueyama     Ret.push_back({unquote(Tok), IsCXX, HasWildcard});
144917324d8bSRui Ueyama     if (consume("}"))
145017324d8bSRui Ueyama       return Ret;
14512ec34544SRui Ueyama     expect(";");
14522ec34544SRui Ueyama   }
14532ec34544SRui Ueyama 
14542ec34544SRui Ueyama   expect("}");
14552ec34544SRui Ueyama   return Ret;
14562ec34544SRui Ueyama }
14572ec34544SRui Ueyama 
14582ec34544SRui Ueyama uint64_t ScriptParser::readMemoryAssignment(StringRef S1, StringRef S2,
14592ec34544SRui Ueyama                                             StringRef S3) {
1460b579c439SRui Ueyama   if (!consume(S1) && !consume(S2) && !consume(S3)) {
14612ec34544SRui Ueyama     setError("expected one of: " + S1 + ", " + S2 + ", or " + S3);
14622ec34544SRui Ueyama     return 0;
14632ec34544SRui Ueyama   }
14642ec34544SRui Ueyama   expect("=");
1465040af7deSRui Ueyama   return readExpr()().getValue();
14662ec34544SRui Ueyama }
14672ec34544SRui Ueyama 
14682ec34544SRui Ueyama // Parse the MEMORY command as specified in:
14692ec34544SRui Ueyama // https://sourceware.org/binutils/docs/ld/MEMORY.html
14702ec34544SRui Ueyama //
14712ec34544SRui Ueyama // MEMORY { name [(attr)] : ORIGIN = origin, LENGTH = len ... }
14722ec34544SRui Ueyama void ScriptParser::readMemory() {
14732ec34544SRui Ueyama   expect("{");
1474b8a59c8aSBob Haarman   while (!errorCount() && !consume("}")) {
14752e9d40d5SRui Ueyama     StringRef Tok = next();
14762e9d40d5SRui Ueyama     if (Tok == "INCLUDE") {
14772e9d40d5SRui Ueyama       readInclude();
14782e9d40d5SRui Ueyama       continue;
14792e9d40d5SRui Ueyama     }
14802ec34544SRui Ueyama 
14812ec34544SRui Ueyama     uint32_t Flags = 0;
14822ec34544SRui Ueyama     uint32_t NegFlags = 0;
14832ec34544SRui Ueyama     if (consume("(")) {
14842ec34544SRui Ueyama       std::tie(Flags, NegFlags) = readMemoryAttributes();
14852ec34544SRui Ueyama       expect(")");
14862ec34544SRui Ueyama     }
14872ec34544SRui Ueyama     expect(":");
14882ec34544SRui Ueyama 
14892ec34544SRui Ueyama     uint64_t Origin = readMemoryAssignment("ORIGIN", "org", "o");
14902ec34544SRui Ueyama     expect(",");
14912ec34544SRui Ueyama     uint64_t Length = readMemoryAssignment("LENGTH", "len", "l");
14922ec34544SRui Ueyama 
14935f37541cSGeorge Rimar     // Add the memory region to the region map.
14942e9d40d5SRui Ueyama     MemoryRegion *MR = make<MemoryRegion>(Tok, Origin, Length, Flags, NegFlags);
14952e9d40d5SRui Ueyama     if (!Script->MemoryRegions.insert({Tok, MR}).second)
14962e9d40d5SRui Ueyama       setError("region '" + Tok + "' already defined");
14972ec34544SRui Ueyama   }
14982ec34544SRui Ueyama }
14992ec34544SRui Ueyama 
15002ec34544SRui Ueyama // This function parses the attributes used to match against section
15012ec34544SRui Ueyama // flags when placing output sections in a memory region. These flags
15022ec34544SRui Ueyama // are only used when an explicit memory region name is not used.
15032ec34544SRui Ueyama std::pair<uint32_t, uint32_t> ScriptParser::readMemoryAttributes() {
15042ec34544SRui Ueyama   uint32_t Flags = 0;
15052ec34544SRui Ueyama   uint32_t NegFlags = 0;
15062ec34544SRui Ueyama   bool Invert = false;
15072ec34544SRui Ueyama 
15082ec34544SRui Ueyama   for (char C : next().lower()) {
15092ec34544SRui Ueyama     uint32_t Flag = 0;
15102ec34544SRui Ueyama     if (C == '!')
15112ec34544SRui Ueyama       Invert = !Invert;
15122ec34544SRui Ueyama     else if (C == 'w')
15132ec34544SRui Ueyama       Flag = SHF_WRITE;
15142ec34544SRui Ueyama     else if (C == 'x')
15152ec34544SRui Ueyama       Flag = SHF_EXECINSTR;
15162ec34544SRui Ueyama     else if (C == 'a')
15172ec34544SRui Ueyama       Flag = SHF_ALLOC;
15182ec34544SRui Ueyama     else if (C != 'r')
15192ec34544SRui Ueyama       setError("invalid memory region attribute");
15202ec34544SRui Ueyama 
15212ec34544SRui Ueyama     if (Invert)
15222ec34544SRui Ueyama       NegFlags |= Flag;
15232ec34544SRui Ueyama     else
15242ec34544SRui Ueyama       Flags |= Flag;
15252ec34544SRui Ueyama   }
15262ec34544SRui Ueyama   return {Flags, NegFlags};
15272ec34544SRui Ueyama }
15282ec34544SRui Ueyama 
15292ec34544SRui Ueyama void elf::readLinkerScript(MemoryBufferRef MB) {
15302ec34544SRui Ueyama   ScriptParser(MB).readLinkerScript();
15312ec34544SRui Ueyama }
15322ec34544SRui Ueyama 
15332ec34544SRui Ueyama void elf::readVersionScript(MemoryBufferRef MB) {
15342ec34544SRui Ueyama   ScriptParser(MB).readVersionScript();
15352ec34544SRui Ueyama }
15362ec34544SRui Ueyama 
15372ec34544SRui Ueyama void elf::readDynamicList(MemoryBufferRef MB) {
15382ec34544SRui Ueyama   ScriptParser(MB).readDynamicList();
15392ec34544SRui Ueyama }
15408c7e8cceSPetr Hosek 
15418c7e8cceSPetr Hosek void elf::readDefsym(StringRef Name, MemoryBufferRef MB) {
15428c7e8cceSPetr Hosek   ScriptParser(MB).readDefsym(Name);
15438c7e8cceSPetr Hosek }
1544