12ec34544SRui Ueyama //===- ScriptParser.cpp ---------------------------------------------------===//
22ec34544SRui Ueyama //
32ec34544SRui Ueyama //                             The LLVM Linker
42ec34544SRui Ueyama //
52ec34544SRui Ueyama // This file is distributed under the University of Illinois Open Source
62ec34544SRui Ueyama // License. See LICENSE.TXT for details.
72ec34544SRui Ueyama //
82ec34544SRui Ueyama //===----------------------------------------------------------------------===//
905f6b852SRui Ueyama //
1005f6b852SRui Ueyama // This file contains a recursive-descendent parser for linker scripts.
1105f6b852SRui Ueyama // Parsed results are stored to Config and Script global objects.
1205f6b852SRui Ueyama //
1305f6b852SRui Ueyama //===----------------------------------------------------------------------===//
142ec34544SRui Ueyama 
152ec34544SRui Ueyama #include "ScriptParser.h"
162ec34544SRui Ueyama #include "Config.h"
172ec34544SRui Ueyama #include "Driver.h"
182ec34544SRui Ueyama #include "InputSection.h"
192ec34544SRui Ueyama #include "LinkerScript.h"
202ec34544SRui Ueyama #include "OutputSections.h"
212ec34544SRui Ueyama #include "ScriptLexer.h"
222ec34544SRui Ueyama #include "Symbols.h"
232ec34544SRui Ueyama #include "Target.h"
242017d52bSRui Ueyama #include "lld/Common/Memory.h"
252ec34544SRui Ueyama #include "llvm/ADT/SmallString.h"
262ec34544SRui Ueyama #include "llvm/ADT/StringRef.h"
270440be4aSRui Ueyama #include "llvm/ADT/StringSet.h"
282ec34544SRui Ueyama #include "llvm/ADT/StringSwitch.h"
29264b5d9eSZachary Turner #include "llvm/BinaryFormat/ELF.h"
302ec34544SRui Ueyama #include "llvm/Support/Casting.h"
312ec34544SRui Ueyama #include "llvm/Support/ErrorHandling.h"
322ec34544SRui Ueyama #include "llvm/Support/FileSystem.h"
332ec34544SRui Ueyama #include "llvm/Support/Path.h"
342ec34544SRui Ueyama #include <cassert>
352ec34544SRui Ueyama #include <limits>
362ec34544SRui Ueyama #include <vector>
372ec34544SRui Ueyama 
382ec34544SRui Ueyama using namespace llvm;
392ec34544SRui Ueyama using namespace llvm::ELF;
40b58079d4SRui Ueyama using namespace llvm::support::endian;
412ec34544SRui Ueyama using namespace lld;
422ec34544SRui Ueyama using namespace lld::elf;
432ec34544SRui Ueyama 
442ec34544SRui Ueyama static bool isUnderSysroot(StringRef Path);
452ec34544SRui Ueyama 
4696b3fe02SRui Ueyama namespace {
4796b3fe02SRui Ueyama class ScriptParser final : ScriptLexer {
482ec34544SRui Ueyama public:
492ec34544SRui Ueyama   ScriptParser(MemoryBufferRef MB)
502ec34544SRui Ueyama       : ScriptLexer(MB),
512ec34544SRui Ueyama         IsUnderSysroot(isUnderSysroot(MB.getBufferIdentifier())) {}
522ec34544SRui Ueyama 
532ec34544SRui Ueyama   void readLinkerScript();
542ec34544SRui Ueyama   void readVersionScript();
552ec34544SRui Ueyama   void readDynamicList();
568c7e8cceSPetr Hosek   void readDefsym(StringRef Name);
572ec34544SRui Ueyama 
582ec34544SRui Ueyama private:
592ec34544SRui Ueyama   void addFile(StringRef Path);
602ec34544SRui Ueyama 
612ec34544SRui Ueyama   void readAsNeeded();
622ec34544SRui Ueyama   void readEntry();
632ec34544SRui Ueyama   void readExtern();
642ec34544SRui Ueyama   void readGroup();
652ec34544SRui Ueyama   void readInclude();
661d92aa73SRui Ueyama   void readInput();
672ec34544SRui Ueyama   void readMemory();
682ec34544SRui Ueyama   void readOutput();
692ec34544SRui Ueyama   void readOutputArch();
702ec34544SRui Ueyama   void readOutputFormat();
712ec34544SRui Ueyama   void readPhdrs();
725f37541cSGeorge Rimar   void readRegionAlias();
732ec34544SRui Ueyama   void readSearchDir();
742ec34544SRui Ueyama   void readSections();
75e262bb1aSRui Ueyama   void readTarget();
762ec34544SRui Ueyama   void readVersion();
772ec34544SRui Ueyama   void readVersionScriptCommand();
782ec34544SRui Ueyama 
79d30a78b3SGeorge Rimar   SymbolAssignment *readSymbolAssignment(StringRef Name);
80f0403c60SRui Ueyama   ByteCommand *readByteCommand(StringRef Tok);
812ec34544SRui Ueyama   uint32_t readFill();
828acbf1ccSRui Ueyama   uint32_t parseFill(StringRef Tok);
83a46d08ebSGeorge Rimar   bool readSectionDirective(OutputSection *Cmd, StringRef Tok1, StringRef Tok2);
848c022ca7SRafael Espindola   void readSectionAddressType(OutputSection *Cmd);
85a582419aSGeorge Rimar   OutputSection *readOverlaySectionDescription();
868c022ca7SRafael Espindola   OutputSection *readOutputSectionDescription(StringRef OutSec);
87a582419aSGeorge Rimar   std::vector<BaseCommand *> readOverlay();
882ec34544SRui Ueyama   std::vector<StringRef> readOutputSectionPhdrs();
892ec34544SRui Ueyama   InputSectionDescription *readInputSectionDescription(StringRef Tok);
902ec34544SRui Ueyama   StringMatcher readFilePatterns();
912ec34544SRui Ueyama   std::vector<SectionPattern> readInputSectionsList();
922ec34544SRui Ueyama   InputSectionDescription *readInputSectionRules(StringRef FilePattern);
932ec34544SRui Ueyama   unsigned readPhdrType();
942ec34544SRui Ueyama   SortSectionPolicy readSortKind();
952ec34544SRui Ueyama   SymbolAssignment *readProvideHidden(bool Provide, bool Hidden);
96d30a78b3SGeorge Rimar   SymbolAssignment *readAssignment(StringRef Tok);
97*ea8cd00aSRui Ueyama   std::pair<ELFKind, uint16_t> readBfdName();
982ec34544SRui Ueyama   void readSort();
99d30a78b3SGeorge Rimar   Expr readAssert();
1005fb17128SGeorge Rimar   Expr readConstant();
1015fb17128SGeorge Rimar   Expr getPageSize();
1022ec34544SRui Ueyama 
1032ec34544SRui Ueyama   uint64_t readMemoryAssignment(StringRef, StringRef, StringRef);
1042ec34544SRui Ueyama   std::pair<uint32_t, uint32_t> readMemoryAttributes();
1052ec34544SRui Ueyama 
1067b91e213SGeorge Rimar   Expr combine(StringRef Op, Expr L, Expr R);
1072ec34544SRui Ueyama   Expr readExpr();
1082ec34544SRui Ueyama   Expr readExpr1(Expr Lhs, int MinPrec);
1092ec34544SRui Ueyama   StringRef readParenLiteral();
1102ec34544SRui Ueyama   Expr readPrimary();
1112ec34544SRui Ueyama   Expr readTernary(Expr Cond);
1122ec34544SRui Ueyama   Expr readParenExpr();
1132ec34544SRui Ueyama 
1142ec34544SRui Ueyama   // For parsing version script.
1152ec34544SRui Ueyama   std::vector<SymbolVersion> readVersionExtern();
1162ec34544SRui Ueyama   void readAnonymousDeclaration();
1172ec34544SRui Ueyama   void readVersionDeclaration(StringRef VerStr);
1182ec34544SRui Ueyama 
1192ec34544SRui Ueyama   std::pair<std::vector<SymbolVersion>, std::vector<SymbolVersion>>
1202ec34544SRui Ueyama   readSymbols();
1212ec34544SRui Ueyama 
122fd06b025SRui Ueyama   // True if a script being read is in a subdirectory specified by -sysroot.
1232ec34544SRui Ueyama   bool IsUnderSysroot;
1240440be4aSRui Ueyama 
1250440be4aSRui Ueyama   // A set to detect an INCLUDE() cycle.
1260440be4aSRui Ueyama   StringSet<> Seen;
1272ec34544SRui Ueyama };
12896b3fe02SRui Ueyama } // namespace
1292ec34544SRui Ueyama 
1301e77ad14SRui Ueyama static StringRef unquote(StringRef S) {
1311e77ad14SRui Ueyama   if (S.startswith("\""))
1321e77ad14SRui Ueyama     return S.substr(1, S.size() - 2);
1331e77ad14SRui Ueyama   return S;
1341e77ad14SRui Ueyama }
1351e77ad14SRui Ueyama 
1362ec34544SRui Ueyama static bool isUnderSysroot(StringRef Path) {
1372ec34544SRui Ueyama   if (Config->Sysroot == "")
1382ec34544SRui Ueyama     return false;
1392ec34544SRui Ueyama   for (; !Path.empty(); Path = sys::path::parent_path(Path))
1402ec34544SRui Ueyama     if (sys::fs::equivalent(Config->Sysroot, Path))
1412ec34544SRui Ueyama       return true;
1422ec34544SRui Ueyama   return false;
1432ec34544SRui Ueyama }
1442ec34544SRui Ueyama 
1452ec34544SRui Ueyama // Some operations only support one non absolute value. Move the
1462ec34544SRui Ueyama // absolute one to the right hand side for convenience.
1472ec34544SRui Ueyama static void moveAbsRight(ExprValue &A, ExprValue &B) {
14823be5e8dSRafael Espindola   if (A.Sec == nullptr || (A.ForceAbsolute && !B.isAbsolute()))
1492ec34544SRui Ueyama     std::swap(A, B);
1502ec34544SRui Ueyama   if (!B.isAbsolute())
15141c7ab4aSGeorge Rimar     error(A.Loc + ": at least one side of the expression must be absolute");
1522ec34544SRui Ueyama }
1532ec34544SRui Ueyama 
1542ec34544SRui Ueyama static ExprValue add(ExprValue A, ExprValue B) {
1552ec34544SRui Ueyama   moveAbsRight(A, B);
156a6acd23cSRafael Espindola   return {A.Sec, A.ForceAbsolute, A.getSectionOffset() + B.getValue(), A.Loc};
1572ec34544SRui Ueyama }
1582ec34544SRui Ueyama 
1592ec34544SRui Ueyama static ExprValue sub(ExprValue A, ExprValue B) {
16063a4a98eSRafael Espindola   // The distance between two symbols in sections is absolute.
1619cbb6dd1SRafael Espindola   if (!A.isAbsolute() && !B.isAbsolute())
1629cbb6dd1SRafael Espindola     return A.getValue() - B.getValue();
1634fbe3518SRui Ueyama   return {A.Sec, false, A.getSectionOffset() - B.getValue(), A.Loc};
1642ec34544SRui Ueyama }
1652ec34544SRui Ueyama 
1662ec34544SRui Ueyama static ExprValue bitAnd(ExprValue A, ExprValue B) {
1672ec34544SRui Ueyama   moveAbsRight(A, B);
1682ec34544SRui Ueyama   return {A.Sec, A.ForceAbsolute,
16941c7ab4aSGeorge Rimar           (A.getValue() & B.getValue()) - A.getSecAddr(), A.Loc};
1702ec34544SRui Ueyama }
1712ec34544SRui Ueyama 
1722ec34544SRui Ueyama static ExprValue bitOr(ExprValue A, ExprValue B) {
1732ec34544SRui Ueyama   moveAbsRight(A, B);
1742ec34544SRui Ueyama   return {A.Sec, A.ForceAbsolute,
17541c7ab4aSGeorge Rimar           (A.getValue() | B.getValue()) - A.getSecAddr(), A.Loc};
1762ec34544SRui Ueyama }
1772ec34544SRui Ueyama 
1782ec34544SRui Ueyama void ScriptParser::readDynamicList() {
1798016bdfdSRafael Espindola   Config->HasDynamicList = true;
1802ec34544SRui Ueyama   expect("{");
181d72d97b3SRafael Espindola   std::vector<SymbolVersion> Locals;
182d72d97b3SRafael Espindola   std::vector<SymbolVersion> Globals;
183d72d97b3SRafael Espindola   std::tie(Locals, Globals) = readSymbols();
184d72d97b3SRafael Espindola   expect(";");
185d72d97b3SRafael Espindola 
186d72d97b3SRafael Espindola   if (!atEOF()) {
1872ec34544SRui Ueyama     setError("EOF expected, but got " + next());
188d72d97b3SRafael Espindola     return;
189d72d97b3SRafael Espindola   }
190d72d97b3SRafael Espindola   if (!Locals.empty()) {
191d72d97b3SRafael Espindola     setError("\"local:\" scope not supported in --dynamic-list");
192d72d97b3SRafael Espindola     return;
193d72d97b3SRafael Espindola   }
194d72d97b3SRafael Espindola 
195d72d97b3SRafael Espindola   for (SymbolVersion V : Globals)
196d72d97b3SRafael Espindola     Config->DynamicList.push_back(V);
1972ec34544SRui Ueyama }
1982ec34544SRui Ueyama 
1992ec34544SRui Ueyama void ScriptParser::readVersionScript() {
2002ec34544SRui Ueyama   readVersionScriptCommand();
2012ec34544SRui Ueyama   if (!atEOF())
2022ec34544SRui Ueyama     setError("EOF expected, but got " + next());
2032ec34544SRui Ueyama }
2042ec34544SRui Ueyama 
2052ec34544SRui Ueyama void ScriptParser::readVersionScriptCommand() {
2062ec34544SRui Ueyama   if (consume("{")) {
2072ec34544SRui Ueyama     readAnonymousDeclaration();
2082ec34544SRui Ueyama     return;
2092ec34544SRui Ueyama   }
2102ec34544SRui Ueyama 
211b8a59c8aSBob Haarman   while (!atEOF() && !errorCount() && peek() != "}") {
2122ec34544SRui Ueyama     StringRef VerStr = next();
2132ec34544SRui Ueyama     if (VerStr == "{") {
2142ec34544SRui Ueyama       setError("anonymous version definition is used in "
2152ec34544SRui Ueyama                "combination with other version definitions");
2162ec34544SRui Ueyama       return;
2172ec34544SRui Ueyama     }
2182ec34544SRui Ueyama     expect("{");
2192ec34544SRui Ueyama     readVersionDeclaration(VerStr);
2202ec34544SRui Ueyama   }
2212ec34544SRui Ueyama }
2222ec34544SRui Ueyama 
2232ec34544SRui Ueyama void ScriptParser::readVersion() {
2242ec34544SRui Ueyama   expect("{");
2252ec34544SRui Ueyama   readVersionScriptCommand();
2262ec34544SRui Ueyama   expect("}");
2272ec34544SRui Ueyama }
2282ec34544SRui Ueyama 
2292ec34544SRui Ueyama void ScriptParser::readLinkerScript() {
2302ec34544SRui Ueyama   while (!atEOF()) {
2312ec34544SRui Ueyama     StringRef Tok = next();
2322ec34544SRui Ueyama     if (Tok == ";")
2332ec34544SRui Ueyama       continue;
2342ec34544SRui Ueyama 
235d30a78b3SGeorge Rimar     if (Tok == "ENTRY") {
2362ec34544SRui Ueyama       readEntry();
2372ec34544SRui Ueyama     } else if (Tok == "EXTERN") {
2382ec34544SRui Ueyama       readExtern();
2391d92aa73SRui Ueyama     } else if (Tok == "GROUP") {
2402ec34544SRui Ueyama       readGroup();
2412ec34544SRui Ueyama     } else if (Tok == "INCLUDE") {
2422ec34544SRui Ueyama       readInclude();
2431d92aa73SRui Ueyama     } else if (Tok == "INPUT") {
2441d92aa73SRui Ueyama       readInput();
2452ec34544SRui Ueyama     } else if (Tok == "MEMORY") {
2462ec34544SRui Ueyama       readMemory();
2472ec34544SRui Ueyama     } else if (Tok == "OUTPUT") {
2482ec34544SRui Ueyama       readOutput();
2492ec34544SRui Ueyama     } else if (Tok == "OUTPUT_ARCH") {
2502ec34544SRui Ueyama       readOutputArch();
2512ec34544SRui Ueyama     } else if (Tok == "OUTPUT_FORMAT") {
2522ec34544SRui Ueyama       readOutputFormat();
2532ec34544SRui Ueyama     } else if (Tok == "PHDRS") {
2542ec34544SRui Ueyama       readPhdrs();
2555f37541cSGeorge Rimar     } else if (Tok == "REGION_ALIAS") {
2565f37541cSGeorge Rimar       readRegionAlias();
2572ec34544SRui Ueyama     } else if (Tok == "SEARCH_DIR") {
2582ec34544SRui Ueyama       readSearchDir();
2592ec34544SRui Ueyama     } else if (Tok == "SECTIONS") {
2602ec34544SRui Ueyama       readSections();
261e262bb1aSRui Ueyama     } else if (Tok == "TARGET") {
262e262bb1aSRui Ueyama       readTarget();
2632ec34544SRui Ueyama     } else if (Tok == "VERSION") {
2642ec34544SRui Ueyama       readVersion();
265d30a78b3SGeorge Rimar     } else if (SymbolAssignment *Cmd = readAssignment(Tok)) {
2666b394caaSRui Ueyama       Script->SectionCommands.push_back(Cmd);
2672ec34544SRui Ueyama     } else {
2682ec34544SRui Ueyama       setError("unknown directive: " + Tok);
2692ec34544SRui Ueyama     }
2702ec34544SRui Ueyama   }
2712ec34544SRui Ueyama }
2722ec34544SRui Ueyama 
2738c7e8cceSPetr Hosek void ScriptParser::readDefsym(StringRef Name) {
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 
386*ea8cd00aSRui Ueyama std::pair<ELFKind, uint16_t> ScriptParser::readBfdName() {
387*ea8cd00aSRui Ueyama   StringRef S = next();
388*ea8cd00aSRui Ueyama   if (S == "elf32-i386")
389*ea8cd00aSRui Ueyama     return {ELF32LEKind, EM_386};
390*ea8cd00aSRui Ueyama   if (S == "elf32-iamcu")
391*ea8cd00aSRui Ueyama     return {ELF32LEKind, EM_IAMCU};
392*ea8cd00aSRui Ueyama   if (S == "elf32-x86-64")
393*ea8cd00aSRui Ueyama     return {ELF32LEKind, EM_X86_64};
394*ea8cd00aSRui Ueyama   if (S == "elf64-littleaarch64")
395*ea8cd00aSRui Ueyama     return {ELF64LEKind, EM_AARCH64};
396*ea8cd00aSRui Ueyama   if (S == "elf64-x86-64")
397*ea8cd00aSRui Ueyama     return {ELF64LEKind, EM_X86_64};
398*ea8cd00aSRui Ueyama 
399*ea8cd00aSRui Ueyama   setError("unknown output format name: " + S);
400*ea8cd00aSRui Ueyama   return {ELFNoneKind, EM_NONE};
401*ea8cd00aSRui Ueyama }
402*ea8cd00aSRui Ueyama 
403*ea8cd00aSRui Ueyama // Parse OUTPUT_FORMAT(bfdname) or OUTPUT_FORMAT(bfdname, big, little).
404*ea8cd00aSRui Ueyama // Currently we ignore big and little parameters.
4052ec34544SRui Ueyama void ScriptParser::readOutputFormat() {
4062ec34544SRui Ueyama   expect("(");
407*ea8cd00aSRui Ueyama 
408*ea8cd00aSRui Ueyama   std::pair<ELFKind, uint16_t> P = readBfdName();
409*ea8cd00aSRui Ueyama   if (Config->EKind == ELFNoneKind) {
410*ea8cd00aSRui Ueyama     Config->EKind = P.first;
411*ea8cd00aSRui Ueyama     Config->EMachine = P.second;
412*ea8cd00aSRui Ueyama   }
413*ea8cd00aSRui Ueyama 
414b579c439SRui Ueyama   if (consume(")"))
4152ec34544SRui Ueyama     return;
416b579c439SRui Ueyama   expect(",");
4172ec34544SRui Ueyama   skip();
4182ec34544SRui Ueyama   expect(",");
4192ec34544SRui Ueyama   skip();
4202ec34544SRui Ueyama   expect(")");
4212ec34544SRui Ueyama }
4222ec34544SRui Ueyama 
4232ec34544SRui Ueyama void ScriptParser::readPhdrs() {
4242ec34544SRui Ueyama   expect("{");
4252ec34544SRui Ueyama 
426b8a59c8aSBob Haarman   while (!errorCount() && !consume("}")) {
4270ae2c24cSRui Ueyama     PhdrsCommand Cmd;
4280ae2c24cSRui Ueyama     Cmd.Name = next();
4290ae2c24cSRui Ueyama     Cmd.Type = readPhdrType();
430b579c439SRui Ueyama 
431b8a59c8aSBob Haarman     while (!errorCount() && !consume(";")) {
432b579c439SRui Ueyama       if (consume("FILEHDR"))
4330ae2c24cSRui Ueyama         Cmd.HasFilehdr = true;
434b579c439SRui Ueyama       else if (consume("PHDRS"))
4350ae2c24cSRui Ueyama         Cmd.HasPhdrs = true;
436b579c439SRui Ueyama       else if (consume("AT"))
4370ae2c24cSRui Ueyama         Cmd.LMAExpr = readParenExpr();
438b579c439SRui Ueyama       else if (consume("FLAGS"))
4390ae2c24cSRui Ueyama         Cmd.Flags = readParenExpr()().getValue();
440b579c439SRui Ueyama       else
441b579c439SRui Ueyama         setError("unexpected header attribute: " + next());
442b579c439SRui Ueyama     }
4430ae2c24cSRui Ueyama 
444ac27de9dSRui Ueyama     Script->PhdrsCommands.push_back(Cmd);
4452ec34544SRui Ueyama   }
4462ec34544SRui Ueyama }
4472ec34544SRui Ueyama 
4485f37541cSGeorge Rimar void ScriptParser::readRegionAlias() {
4495f37541cSGeorge Rimar   expect("(");
4505f37541cSGeorge Rimar   StringRef Alias = unquote(next());
4515f37541cSGeorge Rimar   expect(",");
4525f37541cSGeorge Rimar   StringRef Name = next();
4535f37541cSGeorge Rimar   expect(")");
4545f37541cSGeorge Rimar 
455ac27de9dSRui Ueyama   if (Script->MemoryRegions.count(Alias))
4565f37541cSGeorge Rimar     setError("redefinition of memory region '" + Alias + "'");
457ac27de9dSRui Ueyama   if (!Script->MemoryRegions.count(Name))
4585f37541cSGeorge Rimar     setError("memory region '" + Name + "' is not defined");
4598c825db2SGeorge Rimar   Script->MemoryRegions.insert({Alias, Script->MemoryRegions[Name]});
4605f37541cSGeorge Rimar }
4615f37541cSGeorge Rimar 
4622ec34544SRui Ueyama void ScriptParser::readSearchDir() {
4632ec34544SRui Ueyama   expect("(");
4642ec34544SRui Ueyama   StringRef Tok = next();
4652ec34544SRui Ueyama   if (!Config->Nostdlib)
4662ec34544SRui Ueyama     Config->SearchPaths.push_back(unquote(Tok));
4672ec34544SRui Ueyama   expect(")");
4682ec34544SRui Ueyama }
4692ec34544SRui Ueyama 
470a582419aSGeorge Rimar // This reads an overlay description. Overlays are used to describe output
471a582419aSGeorge Rimar // sections that use the same virtual memory range and normally would trigger
472a582419aSGeorge Rimar // linker's sections sanity check failures.
473a582419aSGeorge Rimar // https://sourceware.org/binutils/docs/ld/Overlay-Description.html#Overlay-Description
474a582419aSGeorge Rimar std::vector<BaseCommand *> ScriptParser::readOverlay() {
475a582419aSGeorge Rimar   // VA and LMA expressions are optional, though for simplicity of
476a582419aSGeorge Rimar   // implementation we assume they are not. That is what OVERLAY was designed
477a582419aSGeorge Rimar   // for first of all: to allow sections with overlapping VAs at different LMAs.
478a582419aSGeorge Rimar   Expr AddrExpr = readExpr();
479a582419aSGeorge Rimar   expect(":");
480a582419aSGeorge Rimar   expect("AT");
481a582419aSGeorge Rimar   Expr LMAExpr = readParenExpr();
482a582419aSGeorge Rimar   expect("{");
483a582419aSGeorge Rimar 
484a582419aSGeorge Rimar   std::vector<BaseCommand *> V;
485a582419aSGeorge Rimar   OutputSection *Prev = nullptr;
486a582419aSGeorge Rimar   while (!errorCount() && !consume("}")) {
487a582419aSGeorge Rimar     // VA is the same for all sections. The LMAs are consecutive in memory
488a582419aSGeorge Rimar     // starting from the base load address specified.
489a582419aSGeorge Rimar     OutputSection *OS = readOverlaySectionDescription();
490a582419aSGeorge Rimar     OS->AddrExpr = AddrExpr;
491a582419aSGeorge Rimar     if (Prev)
492a582419aSGeorge Rimar       OS->LMAExpr = [=] { return Prev->getLMA() + Prev->Size; };
493a582419aSGeorge Rimar     else
494a582419aSGeorge Rimar       OS->LMAExpr = LMAExpr;
495a582419aSGeorge Rimar     V.push_back(OS);
496a582419aSGeorge Rimar     Prev = OS;
497a582419aSGeorge Rimar   }
498a582419aSGeorge Rimar 
499a582419aSGeorge Rimar   // According to the specification, at the end of the overlay, the location
500a582419aSGeorge Rimar   // counter should be equal to the overlay base address plus size of the
501a582419aSGeorge Rimar   // largest section seen in the overlay.
502a582419aSGeorge Rimar   // Here we want to create the Dot assignment command to achieve that.
503a582419aSGeorge Rimar   Expr MoveDot = [=] {
504a582419aSGeorge Rimar     uint64_t Max = 0;
505a582419aSGeorge Rimar     for (BaseCommand *Cmd : V)
506a582419aSGeorge Rimar       Max = std::max(Max, cast<OutputSection>(Cmd)->Size);
507a582419aSGeorge Rimar     return AddrExpr().getValue() + Max;
508a582419aSGeorge Rimar   };
509a582419aSGeorge Rimar   V.push_back(make<SymbolAssignment>(".", MoveDot, getCurrentLocation()));
510a582419aSGeorge Rimar   return V;
511a582419aSGeorge Rimar }
512a582419aSGeorge Rimar 
5132ec34544SRui Ueyama void ScriptParser::readSections() {
514a323e2a7SRui Ueyama   Script->HasSectionsCommand = true;
515b579c439SRui Ueyama 
5162ec34544SRui Ueyama   // -no-rosegment is used to avoid placing read only non-executable sections in
5172ec34544SRui Ueyama   // their own segment. We do the same if SECTIONS command is present in linker
5182ec34544SRui Ueyama   // script. See comment for computeFlags().
5192ec34544SRui Ueyama   Config->SingleRoRx = true;
5202ec34544SRui Ueyama 
5212ec34544SRui Ueyama   expect("{");
5229e2c8a9dSGeorge Rimar   std::vector<BaseCommand *> V;
523b8a59c8aSBob Haarman   while (!errorCount() && !consume("}")) {
5242ec34544SRui Ueyama     StringRef Tok = next();
525a582419aSGeorge Rimar     if (Tok == "OVERLAY") {
526a582419aSGeorge Rimar       for (BaseCommand *Cmd : readOverlay())
527a582419aSGeorge Rimar         V.push_back(Cmd);
528a582419aSGeorge Rimar       continue;
5292e9d40d5SRui Ueyama     } else if (Tok == "INCLUDE") {
5302e9d40d5SRui Ueyama       readInclude();
5312e9d40d5SRui Ueyama       continue;
532a582419aSGeorge Rimar     }
533a582419aSGeorge Rimar 
534d30a78b3SGeorge Rimar     if (BaseCommand *Cmd = readAssignment(Tok))
5359e2c8a9dSGeorge Rimar       V.push_back(Cmd);
536d30a78b3SGeorge Rimar     else
537d30a78b3SGeorge Rimar       V.push_back(readOutputSectionDescription(Tok));
5382ec34544SRui Ueyama   }
5399e2c8a9dSGeorge Rimar 
5409e2c8a9dSGeorge Rimar   if (!atEOF() && consume("INSERT")) {
541796684b4SGeorge Rimar     std::vector<BaseCommand *> *Dest = nullptr;
542796684b4SGeorge Rimar     if (consume("AFTER"))
543796684b4SGeorge Rimar       Dest = &Script->InsertAfterCommands[next()];
544796684b4SGeorge Rimar     else if (consume("BEFORE"))
545796684b4SGeorge Rimar       Dest = &Script->InsertBeforeCommands[next()];
546796684b4SGeorge Rimar     else
547796684b4SGeorge Rimar       setError("expected AFTER/BEFORE, but got '" + next() + "'");
548796684b4SGeorge Rimar     if (Dest)
549796684b4SGeorge Rimar       Dest->insert(Dest->end(), V.begin(), V.end());
5509e2c8a9dSGeorge Rimar     return;
5519e2c8a9dSGeorge Rimar   }
5529e2c8a9dSGeorge Rimar 
5539e2c8a9dSGeorge Rimar   Script->SectionCommands.insert(Script->SectionCommands.end(), V.begin(),
5549e2c8a9dSGeorge Rimar                                  V.end());
5552ec34544SRui Ueyama }
5562ec34544SRui Ueyama 
557e262bb1aSRui Ueyama void ScriptParser::readTarget() {
558e262bb1aSRui Ueyama   // TARGET(foo) is an alias for "--format foo". Unlike GNU linkers,
559e262bb1aSRui Ueyama   // we accept only a limited set of BFD names (i.e. "elf" or "binary")
560e262bb1aSRui Ueyama   // for --format. We recognize only /^elf/ and "binary" in the linker
561e262bb1aSRui Ueyama   // script as well.
562e262bb1aSRui Ueyama   expect("(");
563e262bb1aSRui Ueyama   StringRef Tok = next();
564e262bb1aSRui Ueyama   expect(")");
565e262bb1aSRui Ueyama 
566e262bb1aSRui Ueyama   if (Tok.startswith("elf"))
567e262bb1aSRui Ueyama     Config->FormatBinary = false;
568e262bb1aSRui Ueyama   else if (Tok == "binary")
569e262bb1aSRui Ueyama     Config->FormatBinary = true;
570e262bb1aSRui Ueyama   else
571e262bb1aSRui Ueyama     setError("unknown target: " + Tok);
572e262bb1aSRui Ueyama }
573e262bb1aSRui Ueyama 
5742ec34544SRui Ueyama static int precedence(StringRef Op) {
5752ec34544SRui Ueyama   return StringSwitch<int>(Op)
576a5005482SGeorge Rimar       .Cases("*", "/", "%", 8)
577a5005482SGeorge Rimar       .Cases("+", "-", 7)
578a5005482SGeorge Rimar       .Cases("<<", ">>", 6)
579a5005482SGeorge Rimar       .Cases("<", "<=", ">", ">=", "==", "!=", 5)
580a5005482SGeorge Rimar       .Case("&", 4)
581a5005482SGeorge Rimar       .Case("|", 3)
582a5005482SGeorge Rimar       .Case("&&", 2)
583a5005482SGeorge Rimar       .Case("||", 1)
5842ec34544SRui Ueyama       .Default(-1);
5852ec34544SRui Ueyama }
5862ec34544SRui Ueyama 
5872ec34544SRui Ueyama StringMatcher ScriptParser::readFilePatterns() {
5882ec34544SRui Ueyama   std::vector<StringRef> V;
589b8a59c8aSBob Haarman   while (!errorCount() && !consume(")"))
5902ec34544SRui Ueyama     V.push_back(next());
5912ec34544SRui Ueyama   return StringMatcher(V);
5922ec34544SRui Ueyama }
5932ec34544SRui Ueyama 
5942ec34544SRui Ueyama SortSectionPolicy ScriptParser::readSortKind() {
5952ec34544SRui Ueyama   if (consume("SORT") || consume("SORT_BY_NAME"))
5962ec34544SRui Ueyama     return SortSectionPolicy::Name;
5972ec34544SRui Ueyama   if (consume("SORT_BY_ALIGNMENT"))
5982ec34544SRui Ueyama     return SortSectionPolicy::Alignment;
5992ec34544SRui Ueyama   if (consume("SORT_BY_INIT_PRIORITY"))
6002ec34544SRui Ueyama     return SortSectionPolicy::Priority;
6012ec34544SRui Ueyama   if (consume("SORT_NONE"))
6022ec34544SRui Ueyama     return SortSectionPolicy::None;
6032ec34544SRui Ueyama   return SortSectionPolicy::Default;
6042ec34544SRui Ueyama }
6052ec34544SRui Ueyama 
60603fc8d1eSRui Ueyama // Reads SECTIONS command contents in the following form:
60703fc8d1eSRui Ueyama //
60803fc8d1eSRui Ueyama // <contents> ::= <elem>*
60903fc8d1eSRui Ueyama // <elem>     ::= <exclude>? <glob-pattern>
61003fc8d1eSRui Ueyama // <exclude>  ::= "EXCLUDE_FILE" "(" <glob-pattern>+ ")"
61103fc8d1eSRui Ueyama //
61203fc8d1eSRui Ueyama // For example,
61303fc8d1eSRui Ueyama //
61403fc8d1eSRui Ueyama // *(.foo EXCLUDE_FILE (a.o) .bar EXCLUDE_FILE (b.o) .baz)
61503fc8d1eSRui Ueyama //
61603fc8d1eSRui Ueyama // is parsed as ".foo", ".bar" with "a.o", and ".baz" with "b.o".
61703fc8d1eSRui Ueyama // The semantics of that is section .foo in any file, section .bar in
61803fc8d1eSRui Ueyama // any file but a.o, and section .baz in any file but b.o.
6192ec34544SRui Ueyama std::vector<SectionPattern> ScriptParser::readInputSectionsList() {
6202ec34544SRui Ueyama   std::vector<SectionPattern> Ret;
621b8a59c8aSBob Haarman   while (!errorCount() && peek() != ")") {
6222ec34544SRui Ueyama     StringMatcher ExcludeFilePat;
6232ec34544SRui Ueyama     if (consume("EXCLUDE_FILE")) {
6242ec34544SRui Ueyama       expect("(");
6252ec34544SRui Ueyama       ExcludeFilePat = readFilePatterns();
6262ec34544SRui Ueyama     }
6272ec34544SRui Ueyama 
6282ec34544SRui Ueyama     std::vector<StringRef> V;
629b8a59c8aSBob Haarman     while (!errorCount() && peek() != ")" && peek() != "EXCLUDE_FILE")
6302ec34544SRui Ueyama       V.push_back(next());
6312ec34544SRui Ueyama 
6322ec34544SRui Ueyama     if (!V.empty())
6332ec34544SRui Ueyama       Ret.push_back({std::move(ExcludeFilePat), StringMatcher(V)});
6342ec34544SRui Ueyama     else
6352ec34544SRui Ueyama       setError("section pattern is expected");
6362ec34544SRui Ueyama   }
6372ec34544SRui Ueyama   return Ret;
6382ec34544SRui Ueyama }
6392ec34544SRui Ueyama 
6402ec34544SRui Ueyama // Reads contents of "SECTIONS" directive. That directive contains a
6412ec34544SRui Ueyama // list of glob patterns for input sections. The grammar is as follows.
6422ec34544SRui Ueyama //
6432ec34544SRui Ueyama // <patterns> ::= <section-list>
6442ec34544SRui Ueyama //              | <sort> "(" <section-list> ")"
6452ec34544SRui Ueyama //              | <sort> "(" <sort> "(" <section-list> ")" ")"
6462ec34544SRui Ueyama //
6472ec34544SRui Ueyama // <sort>     ::= "SORT" | "SORT_BY_NAME" | "SORT_BY_ALIGNMENT"
6482ec34544SRui Ueyama //              | "SORT_BY_INIT_PRIORITY" | "SORT_NONE"
6492ec34544SRui Ueyama //
6502ec34544SRui Ueyama // <section-list> is parsed by readInputSectionsList().
6512ec34544SRui Ueyama InputSectionDescription *
6522ec34544SRui Ueyama ScriptParser::readInputSectionRules(StringRef FilePattern) {
6532ec34544SRui Ueyama   auto *Cmd = make<InputSectionDescription>(FilePattern);
6542ec34544SRui Ueyama   expect("(");
6552ec34544SRui Ueyama 
656b8a59c8aSBob Haarman   while (!errorCount() && !consume(")")) {
6572ec34544SRui Ueyama     SortSectionPolicy Outer = readSortKind();
6582ec34544SRui Ueyama     SortSectionPolicy Inner = SortSectionPolicy::Default;
6592ec34544SRui Ueyama     std::vector<SectionPattern> V;
6602ec34544SRui Ueyama     if (Outer != SortSectionPolicy::Default) {
6612ec34544SRui Ueyama       expect("(");
6622ec34544SRui Ueyama       Inner = readSortKind();
6632ec34544SRui Ueyama       if (Inner != SortSectionPolicy::Default) {
6642ec34544SRui Ueyama         expect("(");
6652ec34544SRui Ueyama         V = readInputSectionsList();
6662ec34544SRui Ueyama         expect(")");
6672ec34544SRui Ueyama       } else {
6682ec34544SRui Ueyama         V = readInputSectionsList();
6692ec34544SRui Ueyama       }
6702ec34544SRui Ueyama       expect(")");
6712ec34544SRui Ueyama     } else {
6722ec34544SRui Ueyama       V = readInputSectionsList();
6732ec34544SRui Ueyama     }
6742ec34544SRui Ueyama 
6752ec34544SRui Ueyama     for (SectionPattern &Pat : V) {
6762ec34544SRui Ueyama       Pat.SortInner = Inner;
6772ec34544SRui Ueyama       Pat.SortOuter = Outer;
6782ec34544SRui Ueyama     }
6792ec34544SRui Ueyama 
6802ec34544SRui Ueyama     std::move(V.begin(), V.end(), std::back_inserter(Cmd->SectionPatterns));
6812ec34544SRui Ueyama   }
6822ec34544SRui Ueyama   return Cmd;
6832ec34544SRui Ueyama }
6842ec34544SRui Ueyama 
6852ec34544SRui Ueyama InputSectionDescription *
6862ec34544SRui Ueyama ScriptParser::readInputSectionDescription(StringRef Tok) {
6872ec34544SRui Ueyama   // Input section wildcard can be surrounded by KEEP.
6882ec34544SRui Ueyama   // https://sourceware.org/binutils/docs/ld/Input-Section-Keep.html#Input-Section-Keep
6892ec34544SRui Ueyama   if (Tok == "KEEP") {
6902ec34544SRui Ueyama     expect("(");
6912ec34544SRui Ueyama     StringRef FilePattern = next();
6922ec34544SRui Ueyama     InputSectionDescription *Cmd = readInputSectionRules(FilePattern);
6932ec34544SRui Ueyama     expect(")");
694ac27de9dSRui Ueyama     Script->KeptSections.push_back(Cmd);
6952ec34544SRui Ueyama     return Cmd;
6962ec34544SRui Ueyama   }
6972ec34544SRui Ueyama   return readInputSectionRules(Tok);
6982ec34544SRui Ueyama }
6992ec34544SRui Ueyama 
7002ec34544SRui Ueyama void ScriptParser::readSort() {
7012ec34544SRui Ueyama   expect("(");
7022ec34544SRui Ueyama   expect("CONSTRUCTORS");
7032ec34544SRui Ueyama   expect(")");
7042ec34544SRui Ueyama }
7052ec34544SRui Ueyama 
706d30a78b3SGeorge Rimar Expr ScriptParser::readAssert() {
7072ec34544SRui Ueyama   expect("(");
7082ec34544SRui Ueyama   Expr E = readExpr();
7092ec34544SRui Ueyama   expect(",");
7102ec34544SRui Ueyama   StringRef Msg = unquote(next());
7112ec34544SRui Ueyama   expect(")");
712b579c439SRui Ueyama 
7132ec34544SRui Ueyama   return [=] {
7142ec34544SRui Ueyama     if (!E().getValue())
7152ec34544SRui Ueyama       error(Msg);
7162ec34544SRui Ueyama     return Script->getDot();
7172ec34544SRui Ueyama   };
7182ec34544SRui Ueyama }
7192ec34544SRui Ueyama 
7202ec34544SRui Ueyama // Reads a FILL(expr) command. We handle the FILL command as an
7212ec34544SRui Ueyama // alias for =fillexp section attribute, which is different from
7222ec34544SRui Ueyama // what GNU linkers do.
7232ec34544SRui Ueyama // https://sourceware.org/binutils/docs/ld/Output-Section-Data.html
7242ec34544SRui Ueyama uint32_t ScriptParser::readFill() {
7252ec34544SRui Ueyama   expect("(");
7268acbf1ccSRui Ueyama   uint32_t V = parseFill(next());
7272ec34544SRui Ueyama   expect(")");
7282ec34544SRui Ueyama   return V;
7292ec34544SRui Ueyama }
7302ec34544SRui Ueyama 
731a46d08ebSGeorge Rimar // Tries to read the special directive for an output section definition which
732a46d08ebSGeorge Rimar // can be one of following: "(NOLOAD)", "(COPY)", "(INFO)" or "(OVERLAY)".
733a46d08ebSGeorge Rimar // Tok1 and Tok2 are next 2 tokens peeked. See comment for readSectionAddressType below.
734a46d08ebSGeorge Rimar bool ScriptParser::readSectionDirective(OutputSection *Cmd, StringRef Tok1, StringRef Tok2) {
735a46d08ebSGeorge Rimar   if (Tok1 != "(")
736a46d08ebSGeorge Rimar     return false;
737a46d08ebSGeorge Rimar   if (Tok2 != "NOLOAD" && Tok2 != "COPY" && Tok2 != "INFO" && Tok2 != "OVERLAY")
738a46d08ebSGeorge Rimar     return false;
739a46d08ebSGeorge Rimar 
740a46d08ebSGeorge Rimar   expect("(");
741a46d08ebSGeorge Rimar   if (consume("NOLOAD")) {
742a46d08ebSGeorge Rimar     Cmd->Noload = true;
743a46d08ebSGeorge Rimar   } else {
744a46d08ebSGeorge Rimar     skip(); // This is "COPY", "INFO" or "OVERLAY".
745a46d08ebSGeorge Rimar     Cmd->NonAlloc = true;
746a46d08ebSGeorge Rimar   }
747a46d08ebSGeorge Rimar   expect(")");
748a46d08ebSGeorge Rimar   return true;
749a46d08ebSGeorge Rimar }
750a46d08ebSGeorge Rimar 
7511c08e9f5SGeorge Rimar // Reads an expression and/or the special directive for an output
7521c08e9f5SGeorge Rimar // section definition. Directive is one of following: "(NOLOAD)",
7531c08e9f5SGeorge Rimar // "(COPY)", "(INFO)" or "(OVERLAY)".
7543271d370SRui Ueyama //
7553271d370SRui Ueyama // An output section name can be followed by an address expression
7561c08e9f5SGeorge Rimar // and/or directive. This grammar is not LL(1) because "(" can be
75797f4d158SGeorge Rimar // interpreted as either the beginning of some expression or beginning
7581c08e9f5SGeorge Rimar // of directive.
7593271d370SRui Ueyama //
760b579c439SRui Ueyama // https://sourceware.org/binutils/docs/ld/Output-Section-Address.html
761fbb0463fSGeorge Rimar // https://sourceware.org/binutils/docs/ld/Output-Section-Type.html
7628c022ca7SRafael Espindola void ScriptParser::readSectionAddressType(OutputSection *Cmd) {
763a46d08ebSGeorge Rimar   if (readSectionDirective(Cmd, peek(), peek2()))
7643271d370SRui Ueyama     return;
7653271d370SRui Ueyama 
766a46d08ebSGeorge Rimar   Cmd->AddrExpr = readExpr();
767a46d08ebSGeorge Rimar   if (peek() == "(" && !readSectionDirective(Cmd, "(", peek2()))
768a46d08ebSGeorge Rimar     setError("unknown section directive: " + peek2());
769fbb0463fSGeorge Rimar }
770fbb0463fSGeorge Rimar 
771f22ec9ddSGeorge Rimar static Expr checkAlignment(Expr E, std::string &Loc) {
772f22ec9ddSGeorge Rimar   return [=] {
773f22ec9ddSGeorge Rimar     uint64_t Alignment = std::max((uint64_t)1, E().getValue());
774f22ec9ddSGeorge Rimar     if (!isPowerOf2_64(Alignment)) {
775f22ec9ddSGeorge Rimar       error(Loc + ": alignment must be power of 2");
776f22ec9ddSGeorge Rimar       return (uint64_t)1; // Return a dummy value.
777f22ec9ddSGeorge Rimar     }
778f22ec9ddSGeorge Rimar     return Alignment;
779f22ec9ddSGeorge Rimar   };
780f22ec9ddSGeorge Rimar }
781f22ec9ddSGeorge Rimar 
782a582419aSGeorge Rimar OutputSection *ScriptParser::readOverlaySectionDescription() {
783a582419aSGeorge Rimar   OutputSection *Cmd =
784a582419aSGeorge Rimar       Script->createOutputSection(next(), getCurrentLocation());
785a582419aSGeorge Rimar   Cmd->InOverlay = true;
786a582419aSGeorge Rimar   expect("{");
787a582419aSGeorge Rimar   while (!errorCount() && !consume("}"))
788a582419aSGeorge Rimar     Cmd->SectionCommands.push_back(readInputSectionRules(next()));
789a582419aSGeorge Rimar   Cmd->Phdrs = readOutputSectionPhdrs();
790a582419aSGeorge Rimar   return Cmd;
791a582419aSGeorge Rimar }
792a582419aSGeorge Rimar 
7938c022ca7SRafael Espindola OutputSection *ScriptParser::readOutputSectionDescription(StringRef OutSec) {
7948c022ca7SRafael Espindola   OutputSection *Cmd =
7958c022ca7SRafael Espindola       Script->createOutputSection(OutSec, getCurrentLocation());
7963271d370SRui Ueyama 
797c4df670dSGeorge Rimar   size_t SymbolsReferenced = Script->ReferencedSymbols.size();
798c4df670dSGeorge Rimar 
7993271d370SRui Ueyama   if (peek() != ":")
8003271d370SRui Ueyama     readSectionAddressType(Cmd);
8012ec34544SRui Ueyama   expect(":");
8022ec34544SRui Ueyama 
803f22ec9ddSGeorge Rimar   std::string Location = getCurrentLocation();
8042ec34544SRui Ueyama   if (consume("AT"))
8052ec34544SRui Ueyama     Cmd->LMAExpr = readParenExpr();
8062ec34544SRui Ueyama   if (consume("ALIGN"))
807f22ec9ddSGeorge Rimar     Cmd->AlignExpr = checkAlignment(readParenExpr(), Location);
8082ec34544SRui Ueyama   if (consume("SUBALIGN"))
809f22ec9ddSGeorge Rimar     Cmd->SubalignExpr = checkAlignment(readParenExpr(), Location);
8102ec34544SRui Ueyama 
8112ec34544SRui Ueyama   // Parse constraints.
8122ec34544SRui Ueyama   if (consume("ONLY_IF_RO"))
8132ec34544SRui Ueyama     Cmd->Constraint = ConstraintKind::ReadOnly;
8142ec34544SRui Ueyama   if (consume("ONLY_IF_RW"))
8152ec34544SRui Ueyama     Cmd->Constraint = ConstraintKind::ReadWrite;
8162ec34544SRui Ueyama   expect("{");
8172ec34544SRui Ueyama 
818b8a59c8aSBob Haarman   while (!errorCount() && !consume("}")) {
8192ec34544SRui Ueyama     StringRef Tok = next();
8202ec34544SRui Ueyama     if (Tok == ";") {
8212ec34544SRui Ueyama       // Empty commands are allowed. Do nothing here.
822d30a78b3SGeorge Rimar     } else if (SymbolAssignment *Assign = readAssignment(Tok)) {
8236b394caaSRui Ueyama       Cmd->SectionCommands.push_back(Assign);
824f0403c60SRui Ueyama     } else if (ByteCommand *Data = readByteCommand(Tok)) {
8256b394caaSRui Ueyama       Cmd->SectionCommands.push_back(Data);
8262ec34544SRui Ueyama     } else if (Tok == "CONSTRUCTORS") {
8272ec34544SRui Ueyama       // CONSTRUCTORS is a keyword to make the linker recognize C++ ctors/dtors
8282ec34544SRui Ueyama       // by name. This is for very old file formats such as ECOFF/XCOFF.
8292ec34544SRui Ueyama       // For ELF, we should ignore.
8302ec34544SRui Ueyama     } else if (Tok == "FILL") {
8312ec34544SRui Ueyama       Cmd->Filler = readFill();
8322ec34544SRui Ueyama     } else if (Tok == "SORT") {
8332ec34544SRui Ueyama       readSort();
8342e9d40d5SRui Ueyama     } else if (Tok == "INCLUDE") {
8352e9d40d5SRui Ueyama       readInclude();
8362ec34544SRui Ueyama     } else if (peek() == "(") {
8376b394caaSRui Ueyama       Cmd->SectionCommands.push_back(readInputSectionDescription(Tok));
8382ec34544SRui Ueyama     } else {
8392ec34544SRui Ueyama       setError("unknown command " + Tok);
8402ec34544SRui Ueyama     }
8412ec34544SRui Ueyama   }
8422ec34544SRui Ueyama 
8432ec34544SRui Ueyama   if (consume(">"))
8442ec34544SRui Ueyama     Cmd->MemoryRegionName = next();
8452ec34544SRui Ueyama 
8465d01a8beSGeorge Rimar   if (consume("AT")) {
8475d01a8beSGeorge Rimar     expect(">");
8485d01a8beSGeorge Rimar     Cmd->LMARegionName = next();
8495d01a8beSGeorge Rimar   }
8505d01a8beSGeorge Rimar 
8515d01a8beSGeorge Rimar   if (Cmd->LMAExpr && !Cmd->LMARegionName.empty())
8525d01a8beSGeorge Rimar     error("section can't have both LMA and a load region");
8535d01a8beSGeorge Rimar 
8542ec34544SRui Ueyama   Cmd->Phdrs = readOutputSectionPhdrs();
8552ec34544SRui Ueyama 
8562ec34544SRui Ueyama   if (consume("="))
8578acbf1ccSRui Ueyama     Cmd->Filler = parseFill(next());
8582ec34544SRui Ueyama   else if (peek().startswith("="))
8598acbf1ccSRui Ueyama     Cmd->Filler = parseFill(next().drop_front());
8602ec34544SRui Ueyama 
8612ec34544SRui Ueyama   // Consume optional comma following output section command.
8622ec34544SRui Ueyama   consume(",");
8632ec34544SRui Ueyama 
864c4df670dSGeorge Rimar   if (Script->ReferencedSymbols.size() > SymbolsReferenced)
865c4df670dSGeorge Rimar     Cmd->ExpressionsUseSymbols = true;
8662ec34544SRui Ueyama   return Cmd;
8672ec34544SRui Ueyama }
8682ec34544SRui Ueyama 
8698acbf1ccSRui Ueyama // Parses a given string as a octal/decimal/hexadecimal number and
8708acbf1ccSRui Ueyama // returns it as a big-endian number. Used for `=<fillexp>`.
8712ec34544SRui Ueyama // https://sourceware.org/binutils/docs/ld/Output-Section-Fill.html
8722ec34544SRui Ueyama //
8738acbf1ccSRui Ueyama // When reading a hexstring, ld.bfd handles it as a blob of arbitrary
8748acbf1ccSRui Ueyama // size, while ld.gold always handles it as a 32-bit big-endian number.
8758acbf1ccSRui Ueyama // We are compatible with ld.gold because it's easier to implement.
8768acbf1ccSRui Ueyama uint32_t ScriptParser::parseFill(StringRef Tok) {
877b58079d4SRui Ueyama   uint32_t V = 0;
878ab94768cSGeorge Rimar   if (!to_integer(Tok, V))
8792ec34544SRui Ueyama     setError("invalid filler expression: " + Tok);
880b58079d4SRui Ueyama 
881b58079d4SRui Ueyama   uint32_t Buf;
882b58079d4SRui Ueyama   write32be(&Buf, V);
883b58079d4SRui Ueyama   return Buf;
8842ec34544SRui Ueyama }
8852ec34544SRui Ueyama 
8862ec34544SRui Ueyama SymbolAssignment *ScriptParser::readProvideHidden(bool Provide, bool Hidden) {
8872ec34544SRui Ueyama   expect("(");
888d30a78b3SGeorge Rimar   SymbolAssignment *Cmd = readSymbolAssignment(next());
8892ec34544SRui Ueyama   Cmd->Provide = Provide;
8902ec34544SRui Ueyama   Cmd->Hidden = Hidden;
8912ec34544SRui Ueyama   expect(")");
8922ec34544SRui Ueyama   return Cmd;
8932ec34544SRui Ueyama }
8942ec34544SRui Ueyama 
895d30a78b3SGeorge Rimar SymbolAssignment *ScriptParser::readAssignment(StringRef Tok) {
896d30a78b3SGeorge Rimar   // Assert expression returns Dot, so this is equal to ".=."
897d30a78b3SGeorge Rimar   if (Tok == "ASSERT")
898d30a78b3SGeorge Rimar     return make<SymbolAssignment>(".", readAssert(), getCurrentLocation());
899d30a78b3SGeorge Rimar 
900e88b76a9SGeorge Rimar   size_t OldPos = Pos;
9012ec34544SRui Ueyama   SymbolAssignment *Cmd = nullptr;
902e88b76a9SGeorge Rimar   if (peek() == "=" || peek() == "+=")
903d30a78b3SGeorge Rimar     Cmd = readSymbolAssignment(Tok);
904e88b76a9SGeorge Rimar   else if (Tok == "PROVIDE")
9052ec34544SRui Ueyama     Cmd = readProvideHidden(true, false);
906e88b76a9SGeorge Rimar   else if (Tok == "HIDDEN")
9072ec34544SRui Ueyama     Cmd = readProvideHidden(false, true);
908e88b76a9SGeorge Rimar   else if (Tok == "PROVIDE_HIDDEN")
9092ec34544SRui Ueyama     Cmd = readProvideHidden(true, true);
910e88b76a9SGeorge Rimar 
911e88b76a9SGeorge Rimar   if (Cmd) {
912e88b76a9SGeorge Rimar     Cmd->CommandString =
913e88b76a9SGeorge Rimar         Tok.str() + " " +
914e88b76a9SGeorge Rimar         llvm::join(Tokens.begin() + OldPos, Tokens.begin() + Pos, " ");
915e88b76a9SGeorge Rimar     expect(";");
9162ec34544SRui Ueyama   }
9172ec34544SRui Ueyama   return Cmd;
9182ec34544SRui Ueyama }
9192ec34544SRui Ueyama 
920d30a78b3SGeorge Rimar SymbolAssignment *ScriptParser::readSymbolAssignment(StringRef Name) {
9212ec34544SRui Ueyama   StringRef Op = next();
9222ec34544SRui Ueyama   assert(Op == "=" || Op == "+=");
9232ec34544SRui Ueyama   Expr E = readExpr();
9242ec34544SRui Ueyama   if (Op == "+=") {
9252ec34544SRui Ueyama     std::string Loc = getCurrentLocation();
926722221f5SRui Ueyama     E = [=] { return add(Script->getSymbolValue(Name, Loc), E()); };
9272ec34544SRui Ueyama   }
928e88b76a9SGeorge Rimar   return make<SymbolAssignment>(Name, E, getCurrentLocation());
9292ec34544SRui Ueyama }
9302ec34544SRui Ueyama 
9312ec34544SRui Ueyama // This is an operator-precedence parser to parse a linker
9322ec34544SRui Ueyama // script expression.
9332ec34544SRui Ueyama Expr ScriptParser::readExpr() {
9342ec34544SRui Ueyama   // Our lexer is context-aware. Set the in-expression bit so that
9352ec34544SRui Ueyama   // they apply different tokenization rules.
9362ec34544SRui Ueyama   bool Orig = InExpr;
9372ec34544SRui Ueyama   InExpr = true;
9382ec34544SRui Ueyama   Expr E = readExpr1(readPrimary(), 0);
9392ec34544SRui Ueyama   InExpr = Orig;
9402ec34544SRui Ueyama   return E;
9412ec34544SRui Ueyama }
9422ec34544SRui Ueyama 
9437b91e213SGeorge Rimar Expr ScriptParser::combine(StringRef Op, Expr L, Expr R) {
9442ec34544SRui Ueyama   if (Op == "+")
9452ec34544SRui Ueyama     return [=] { return add(L(), R()); };
9462ec34544SRui Ueyama   if (Op == "-")
9472ec34544SRui Ueyama     return [=] { return sub(L(), R()); };
948b579c439SRui Ueyama   if (Op == "*")
9491d20222aSRui Ueyama     return [=] { return L().getValue() * R().getValue(); };
9507b91e213SGeorge Rimar   if (Op == "/") {
9517b91e213SGeorge Rimar     std::string Loc = getCurrentLocation();
9527b91e213SGeorge Rimar     return [=]() -> uint64_t {
9537b91e213SGeorge Rimar       if (uint64_t RV = R().getValue())
9547b91e213SGeorge Rimar         return L().getValue() / RV;
9557b91e213SGeorge Rimar       error(Loc + ": division by zero");
956067617f9SRui Ueyama       return 0;
9577b91e213SGeorge Rimar     };
9587b91e213SGeorge Rimar   }
9597b91e213SGeorge Rimar   if (Op == "%") {
9607b91e213SGeorge Rimar     std::string Loc = getCurrentLocation();
9617b91e213SGeorge Rimar     return [=]() -> uint64_t {
9627b91e213SGeorge Rimar       if (uint64_t RV = R().getValue())
9637b91e213SGeorge Rimar         return L().getValue() % RV;
9647b91e213SGeorge Rimar       error(Loc + ": modulo by zero");
965067617f9SRui Ueyama       return 0;
9667b91e213SGeorge Rimar     };
9677b91e213SGeorge Rimar   }
9682ec34544SRui Ueyama   if (Op == "<<")
9697e915511SRui Ueyama     return [=] { return L().getValue() << R().getValue(); };
9702ec34544SRui Ueyama   if (Op == ">>")
9717e915511SRui Ueyama     return [=] { return L().getValue() >> R().getValue(); };
9722ec34544SRui Ueyama   if (Op == "<")
9732ec34544SRui Ueyama     return [=] { return L().getValue() < R().getValue(); };
9742ec34544SRui Ueyama   if (Op == ">")
9752ec34544SRui Ueyama     return [=] { return L().getValue() > R().getValue(); };
9762ec34544SRui Ueyama   if (Op == ">=")
9772ec34544SRui Ueyama     return [=] { return L().getValue() >= R().getValue(); };
9782ec34544SRui Ueyama   if (Op == "<=")
9792ec34544SRui Ueyama     return [=] { return L().getValue() <= R().getValue(); };
9802ec34544SRui Ueyama   if (Op == "==")
9812ec34544SRui Ueyama     return [=] { return L().getValue() == R().getValue(); };
9822ec34544SRui Ueyama   if (Op == "!=")
9832ec34544SRui Ueyama     return [=] { return L().getValue() != R().getValue(); };
984a5005482SGeorge Rimar   if (Op == "||")
985a5005482SGeorge Rimar     return [=] { return L().getValue() || R().getValue(); };
986a5005482SGeorge Rimar   if (Op == "&&")
987a5005482SGeorge Rimar     return [=] { return L().getValue() && R().getValue(); };
9882ec34544SRui Ueyama   if (Op == "&")
9892ec34544SRui Ueyama     return [=] { return bitAnd(L(), R()); };
9902ec34544SRui Ueyama   if (Op == "|")
9912ec34544SRui Ueyama     return [=] { return bitOr(L(), R()); };
9922ec34544SRui Ueyama   llvm_unreachable("invalid operator");
9932ec34544SRui Ueyama }
9942ec34544SRui Ueyama 
9952ec34544SRui Ueyama // This is a part of the operator-precedence parser. This function
9962ec34544SRui Ueyama // assumes that the remaining token stream starts with an operator.
9972ec34544SRui Ueyama Expr ScriptParser::readExpr1(Expr Lhs, int MinPrec) {
998b8a59c8aSBob Haarman   while (!atEOF() && !errorCount()) {
9992ec34544SRui Ueyama     // Read an operator and an expression.
10002ec34544SRui Ueyama     if (consume("?"))
10012ec34544SRui Ueyama       return readTernary(Lhs);
10022ec34544SRui Ueyama     StringRef Op1 = peek();
10032ec34544SRui Ueyama     if (precedence(Op1) < MinPrec)
10042ec34544SRui Ueyama       break;
10052ec34544SRui Ueyama     skip();
10062ec34544SRui Ueyama     Expr Rhs = readPrimary();
10072ec34544SRui Ueyama 
10082ec34544SRui Ueyama     // Evaluate the remaining part of the expression first if the
10092ec34544SRui Ueyama     // next operator has greater precedence than the previous one.
10102ec34544SRui Ueyama     // For example, if we have read "+" and "3", and if the next
10112ec34544SRui Ueyama     // operator is "*", then we'll evaluate 3 * ... part first.
10122ec34544SRui Ueyama     while (!atEOF()) {
10132ec34544SRui Ueyama       StringRef Op2 = peek();
10142ec34544SRui Ueyama       if (precedence(Op2) <= precedence(Op1))
10152ec34544SRui Ueyama         break;
10162ec34544SRui Ueyama       Rhs = readExpr1(Rhs, precedence(Op2));
10172ec34544SRui Ueyama     }
10182ec34544SRui Ueyama 
10192ec34544SRui Ueyama     Lhs = combine(Op1, Lhs, Rhs);
10202ec34544SRui Ueyama   }
10212ec34544SRui Ueyama   return Lhs;
10222ec34544SRui Ueyama }
10232ec34544SRui Ueyama 
10245fb17128SGeorge Rimar Expr ScriptParser::getPageSize() {
10255fb17128SGeorge Rimar   std::string Location = getCurrentLocation();
10265fb17128SGeorge Rimar   return [=]() -> uint64_t {
10275fb17128SGeorge Rimar     if (Target)
10282ec34544SRui Ueyama       return Target->PageSize;
10295fb17128SGeorge Rimar     error(Location + ": unable to calculate page size");
10305fb17128SGeorge Rimar     return 4096; // Return a dummy value.
10315fb17128SGeorge Rimar   };
10325fb17128SGeorge Rimar }
10335fb17128SGeorge Rimar 
10345fb17128SGeorge Rimar Expr ScriptParser::readConstant() {
10355fb17128SGeorge Rimar   StringRef S = readParenLiteral();
10365fb17128SGeorge Rimar   if (S == "COMMONPAGESIZE")
10375fb17128SGeorge Rimar     return getPageSize();
10382ec34544SRui Ueyama   if (S == "MAXPAGESIZE")
10395fb17128SGeorge Rimar     return [] { return Config->MaxPageSize; };
10405fb17128SGeorge Rimar   setError("unknown constant: " + S);
1041b068b037SGeorge Rimar   return [] { return 0; };
10422ec34544SRui Ueyama }
10432ec34544SRui Ueyama 
10445c65088fSRui Ueyama // Parses Tok as an integer. It recognizes hexadecimal (prefixed with
10455c65088fSRui Ueyama // "0x" or suffixed with "H") and decimal numbers. Decimal numbers may
10465c65088fSRui Ueyama // have "K" (Ki) or "M" (Mi) suffixes.
10475c65088fSRui Ueyama static Optional<uint64_t> parseInt(StringRef Tok) {
10482ec34544SRui Ueyama   // Hexadecimal
10495c65088fSRui Ueyama   uint64_t Val;
10504092016bSRui Ueyama   if (Tok.startswith_lower("0x")) {
10514092016bSRui Ueyama     if (!to_integer(Tok.substr(2), Val, 16))
10524092016bSRui Ueyama       return None;
10535c65088fSRui Ueyama     return Val;
10544092016bSRui Ueyama   }
10554092016bSRui Ueyama   if (Tok.endswith_lower("H")) {
10564092016bSRui Ueyama     if (!to_integer(Tok.drop_back(), Val, 16))
10574092016bSRui Ueyama       return None;
10585c65088fSRui Ueyama     return Val;
10594092016bSRui Ueyama   }
10602ec34544SRui Ueyama 
10612ec34544SRui Ueyama   // Decimal
10622ec34544SRui Ueyama   if (Tok.endswith_lower("K")) {
1063ab94768cSGeorge Rimar     if (!to_integer(Tok.drop_back(), Val, 10))
10645c65088fSRui Ueyama       return None;
10655c65088fSRui Ueyama     return Val * 1024;
10662ec34544SRui Ueyama   }
10675c65088fSRui Ueyama   if (Tok.endswith_lower("M")) {
1068ab94768cSGeorge Rimar     if (!to_integer(Tok.drop_back(), Val, 10))
10695c65088fSRui Ueyama       return None;
10705c65088fSRui Ueyama     return Val * 1024 * 1024;
10715c65088fSRui Ueyama   }
1072ab94768cSGeorge Rimar   if (!to_integer(Tok, Val, 10))
10735c65088fSRui Ueyama     return None;
10745c65088fSRui Ueyama   return Val;
10752ec34544SRui Ueyama }
10762ec34544SRui Ueyama 
1077f0403c60SRui Ueyama ByteCommand *ScriptParser::readByteCommand(StringRef Tok) {
1078b579c439SRui Ueyama   int Size = StringSwitch<int>(Tok)
10792ec34544SRui Ueyama                  .Case("BYTE", 1)
10802ec34544SRui Ueyama                  .Case("SHORT", 2)
10812ec34544SRui Ueyama                  .Case("LONG", 4)
10822ec34544SRui Ueyama                  .Case("QUAD", 8)
10832ec34544SRui Ueyama                  .Default(-1);
10842ec34544SRui Ueyama   if (Size == -1)
10852ec34544SRui Ueyama     return nullptr;
108684bcabcbSGeorge Rimar 
108784bcabcbSGeorge Rimar   size_t OldPos = Pos;
108884bcabcbSGeorge Rimar   Expr E = readParenExpr();
108984bcabcbSGeorge Rimar   std::string CommandString =
109084bcabcbSGeorge Rimar       Tok.str() + " " +
109184bcabcbSGeorge Rimar       llvm::join(Tokens.begin() + OldPos, Tokens.begin() + Pos, " ");
109284bcabcbSGeorge Rimar   return make<ByteCommand>(E, Size, CommandString);
10932ec34544SRui Ueyama }
10942ec34544SRui Ueyama 
10952ec34544SRui Ueyama StringRef ScriptParser::readParenLiteral() {
10962ec34544SRui Ueyama   expect("(");
10975e9c7762SRafael Espindola   bool Orig = InExpr;
10985e9c7762SRafael Espindola   InExpr = false;
10992ec34544SRui Ueyama   StringRef Tok = next();
11005e9c7762SRafael Espindola   InExpr = Orig;
11012ec34544SRui Ueyama   expect(")");
11022ec34544SRui Ueyama   return Tok;
11032ec34544SRui Ueyama }
11042ec34544SRui Ueyama 
1105617e2f98SRui Ueyama static void checkIfExists(OutputSection *Cmd, StringRef Location) {
110605c4f67cSRafael Espindola   if (Cmd->Location.empty() && Script->ErrorOnMissingSection)
110705c4f67cSRafael Espindola     error(Location + ": undefined section " + Cmd->Name);
110805c4f67cSRafael Espindola }
110905c4f67cSRafael Espindola 
11102ec34544SRui Ueyama Expr ScriptParser::readPrimary() {
11112ec34544SRui Ueyama   if (peek() == "(")
11122ec34544SRui Ueyama     return readParenExpr();
11132ec34544SRui Ueyama 
11145c65088fSRui Ueyama   if (consume("~")) {
11152ec34544SRui Ueyama     Expr E = readPrimary();
1116b2fb84a1SRui Ueyama     return [=] { return ~E().getValue(); };
11172ec34544SRui Ueyama   }
11186f1d954eSHafiz Abid Qadeer   if (consume("!")) {
11196f1d954eSHafiz Abid Qadeer     Expr E = readPrimary();
11206f1d954eSHafiz Abid Qadeer     return [=] { return !E().getValue(); };
11216f1d954eSHafiz Abid Qadeer   }
11225c65088fSRui Ueyama   if (consume("-")) {
11232ec34544SRui Ueyama     Expr E = readPrimary();
1124b2fb84a1SRui Ueyama     return [=] { return -E().getValue(); };
11252ec34544SRui Ueyama   }
11262ec34544SRui Ueyama 
11275c65088fSRui Ueyama   StringRef Tok = next();
11285c65088fSRui Ueyama   std::string Location = getCurrentLocation();
11295c65088fSRui Ueyama 
11302ec34544SRui Ueyama   // Built-in functions are parsed here.
11312ec34544SRui Ueyama   // https://sourceware.org/binutils/docs/ld/Builtin-Functions.html.
11322ec34544SRui Ueyama   if (Tok == "ABSOLUTE") {
11332ec34544SRui Ueyama     Expr Inner = readParenExpr();
11342ec34544SRui Ueyama     return [=] {
11352ec34544SRui Ueyama       ExprValue I = Inner();
11362ec34544SRui Ueyama       I.ForceAbsolute = true;
11372ec34544SRui Ueyama       return I;
11382ec34544SRui Ueyama     };
11392ec34544SRui Ueyama   }
11402ec34544SRui Ueyama   if (Tok == "ADDR") {
11412ec34544SRui Ueyama     StringRef Name = readParenLiteral();
11424fbe3518SRui Ueyama     OutputSection *Sec = Script->getOrCreateOutputSection(Name);
114341c7ab4aSGeorge Rimar     return [=]() -> ExprValue {
11444fbe3518SRui Ueyama       checkIfExists(Sec, Location);
11454fbe3518SRui Ueyama       return {Sec, false, 0, Location};
114641c7ab4aSGeorge Rimar     };
11472ec34544SRui Ueyama   }
11482ec34544SRui Ueyama   if (Tok == "ALIGN") {
11492ec34544SRui Ueyama     expect("(");
11502ec34544SRui Ueyama     Expr E = readExpr();
1151f22ec9ddSGeorge Rimar     if (consume(")")) {
1152f22ec9ddSGeorge Rimar       E = checkAlignment(E, Location);
1153f22ec9ddSGeorge Rimar       return [=] { return alignTo(Script->getDot(), E().getValue()); };
1154f22ec9ddSGeorge Rimar     }
1155b579c439SRui Ueyama     expect(",");
1156f22ec9ddSGeorge Rimar     Expr E2 = checkAlignment(readExpr(), Location);
11572ec34544SRui Ueyama     expect(")");
11583c6de1a6SPetr Hosek     return [=] {
11593c6de1a6SPetr Hosek       ExprValue V = E();
1160f22ec9ddSGeorge Rimar       V.Alignment = E2().getValue();
11613c6de1a6SPetr Hosek       return V;
11623c6de1a6SPetr Hosek     };
11632ec34544SRui Ueyama   }
11642ec34544SRui Ueyama   if (Tok == "ALIGNOF") {
11652ec34544SRui Ueyama     StringRef Name = readParenLiteral();
11668c022ca7SRafael Espindola     OutputSection *Cmd = Script->getOrCreateOutputSection(Name);
1167617e2f98SRui Ueyama     return [=] {
1168617e2f98SRui Ueyama       checkIfExists(Cmd, Location);
1169617e2f98SRui Ueyama       return Cmd->Alignment;
1170617e2f98SRui Ueyama     };
11712ec34544SRui Ueyama   }
11722ec34544SRui Ueyama   if (Tok == "ASSERT")
1173d30a78b3SGeorge Rimar     return readAssert();
11745fb17128SGeorge Rimar   if (Tok == "CONSTANT")
11755fb17128SGeorge Rimar     return readConstant();
11762ec34544SRui Ueyama   if (Tok == "DATA_SEGMENT_ALIGN") {
11772ec34544SRui Ueyama     expect("(");
11782ec34544SRui Ueyama     Expr E = readExpr();
11792ec34544SRui Ueyama     expect(",");
11802ec34544SRui Ueyama     readExpr();
11812ec34544SRui Ueyama     expect(")");
118260833f6eSGeorge Rimar     return [=] {
118360833f6eSGeorge Rimar       return alignTo(Script->getDot(), std::max((uint64_t)1, E().getValue()));
118460833f6eSGeorge Rimar     };
11852ec34544SRui Ueyama   }
11862ec34544SRui Ueyama   if (Tok == "DATA_SEGMENT_END") {
11872ec34544SRui Ueyama     expect("(");
11882ec34544SRui Ueyama     expect(".");
11892ec34544SRui Ueyama     expect(")");
11902ec34544SRui Ueyama     return [] { return Script->getDot(); };
11912ec34544SRui Ueyama   }
11922ec34544SRui Ueyama   if (Tok == "DATA_SEGMENT_RELRO_END") {
11932ec34544SRui Ueyama     // GNU linkers implements more complicated logic to handle
11942ec34544SRui Ueyama     // DATA_SEGMENT_RELRO_END. We instead ignore the arguments and
11952ec34544SRui Ueyama     // just align to the next page boundary for simplicity.
11962ec34544SRui Ueyama     expect("(");
11972ec34544SRui Ueyama     readExpr();
11982ec34544SRui Ueyama     expect(",");
11992ec34544SRui Ueyama     readExpr();
12002ec34544SRui Ueyama     expect(")");
12015fb17128SGeorge Rimar     Expr E = getPageSize();
12025fb17128SGeorge Rimar     return [=] { return alignTo(Script->getDot(), E().getValue()); };
12032ec34544SRui Ueyama   }
12042ec34544SRui Ueyama   if (Tok == "DEFINED") {
12052ec34544SRui Ueyama     StringRef Name = readParenLiteral();
12069b18f50fSRui Ueyama     return [=] { return Symtab->find(Name) ? 1 : 0; };
12072ec34544SRui Ueyama   }
120891b95b61SRui Ueyama   if (Tok == "LENGTH") {
120991b95b61SRui Ueyama     StringRef Name = readParenLiteral();
1210b068b037SGeorge Rimar     if (Script->MemoryRegions.count(Name) == 0) {
121191b95b61SRui Ueyama       setError("memory region not defined: " + Name);
1212b068b037SGeorge Rimar       return [] { return 0; };
1213b068b037SGeorge Rimar     }
1214ac27de9dSRui Ueyama     return [=] { return Script->MemoryRegions[Name]->Length; };
121591b95b61SRui Ueyama   }
12162ec34544SRui Ueyama   if (Tok == "LOADADDR") {
12172ec34544SRui Ueyama     StringRef Name = readParenLiteral();
12188c022ca7SRafael Espindola     OutputSection *Cmd = Script->getOrCreateOutputSection(Name);
1219617e2f98SRui Ueyama     return [=] {
1220617e2f98SRui Ueyama       checkIfExists(Cmd, Location);
1221617e2f98SRui Ueyama       return Cmd->getLMA();
1222617e2f98SRui Ueyama     };
12232ec34544SRui Ueyama   }
1224fd11560fSGeorge Rimar   if (Tok == "MAX" || Tok == "MIN") {
1225fd11560fSGeorge Rimar     expect("(");
1226fd11560fSGeorge Rimar     Expr A = readExpr();
1227fd11560fSGeorge Rimar     expect(",");
1228fd11560fSGeorge Rimar     Expr B = readExpr();
1229fd11560fSGeorge Rimar     expect(")");
1230fd11560fSGeorge Rimar     if (Tok == "MIN")
1231fd11560fSGeorge Rimar       return [=] { return std::min(A().getValue(), B().getValue()); };
1232fd11560fSGeorge Rimar     return [=] { return std::max(A().getValue(), B().getValue()); };
1233fd11560fSGeorge Rimar   }
123491b95b61SRui Ueyama   if (Tok == "ORIGIN") {
123591b95b61SRui Ueyama     StringRef Name = readParenLiteral();
1236b068b037SGeorge Rimar     if (Script->MemoryRegions.count(Name) == 0) {
123791b95b61SRui Ueyama       setError("memory region not defined: " + Name);
1238b068b037SGeorge Rimar       return [] { return 0; };
1239b068b037SGeorge Rimar     }
1240ac27de9dSRui Ueyama     return [=] { return Script->MemoryRegions[Name]->Origin; };
124191b95b61SRui Ueyama   }
12422ec34544SRui Ueyama   if (Tok == "SEGMENT_START") {
12432ec34544SRui Ueyama     expect("(");
12442ec34544SRui Ueyama     skip();
12452ec34544SRui Ueyama     expect(",");
12462ec34544SRui Ueyama     Expr E = readExpr();
12472ec34544SRui Ueyama     expect(")");
12482ec34544SRui Ueyama     return [=] { return E(); };
12492ec34544SRui Ueyama   }
12502ec34544SRui Ueyama   if (Tok == "SIZEOF") {
12512ec34544SRui Ueyama     StringRef Name = readParenLiteral();
12528c022ca7SRafael Espindola     OutputSection *Cmd = Script->getOrCreateOutputSection(Name);
125305c4f67cSRafael Espindola     // Linker script does not create an output section if its content is empty.
125405c4f67cSRafael Espindola     // We want to allow SIZEOF(.foo) where .foo is a section which happened to
125505c4f67cSRafael Espindola     // be empty.
12568c022ca7SRafael Espindola     return [=] { return Cmd->Size; };
12572ec34544SRui Ueyama   }
12582ec34544SRui Ueyama   if (Tok == "SIZEOF_HEADERS")
12592ec34544SRui Ueyama     return [=] { return elf::getHeaderSize(); };
12602ec34544SRui Ueyama 
12614eb2eccbSRui Ueyama   // Tok is the dot.
12624eb2eccbSRui Ueyama   if (Tok == ".")
1263722221f5SRui Ueyama     return [=] { return Script->getSymbolValue(Tok, Location); };
12644eb2eccbSRui Ueyama 
12652ec34544SRui Ueyama   // Tok is a literal number.
12665c65088fSRui Ueyama   if (Optional<uint64_t> Val = parseInt(Tok))
12675c65088fSRui Ueyama     return [=] { return *Val; };
12682ec34544SRui Ueyama 
12692ec34544SRui Ueyama   // Tok is a symbol name.
12702ec34544SRui Ueyama   if (!isValidCIdentifier(Tok))
12712ec34544SRui Ueyama     setError("malformed number: " + Tok);
1272ac27de9dSRui Ueyama   Script->ReferencedSymbols.push_back(Tok);
1273722221f5SRui Ueyama   return [=] { return Script->getSymbolValue(Tok, Location); };
12742ec34544SRui Ueyama }
12752ec34544SRui Ueyama 
12762ec34544SRui Ueyama Expr ScriptParser::readTernary(Expr Cond) {
12772ec34544SRui Ueyama   Expr L = readExpr();
12782ec34544SRui Ueyama   expect(":");
12792ec34544SRui Ueyama   Expr R = readExpr();
12802ec34544SRui Ueyama   return [=] { return Cond().getValue() ? L() : R(); };
12812ec34544SRui Ueyama }
12822ec34544SRui Ueyama 
12832ec34544SRui Ueyama Expr ScriptParser::readParenExpr() {
12842ec34544SRui Ueyama   expect("(");
12852ec34544SRui Ueyama   Expr E = readExpr();
12862ec34544SRui Ueyama   expect(")");
12872ec34544SRui Ueyama   return E;
12882ec34544SRui Ueyama }
12892ec34544SRui Ueyama 
12902ec34544SRui Ueyama std::vector<StringRef> ScriptParser::readOutputSectionPhdrs() {
12912ec34544SRui Ueyama   std::vector<StringRef> Phdrs;
1292b8a59c8aSBob Haarman   while (!errorCount() && peek().startswith(":")) {
12932ec34544SRui Ueyama     StringRef Tok = next();
12942ec34544SRui Ueyama     Phdrs.push_back((Tok.size() == 1) ? next() : Tok.substr(1));
12952ec34544SRui Ueyama   }
12962ec34544SRui Ueyama   return Phdrs;
12972ec34544SRui Ueyama }
12982ec34544SRui Ueyama 
12992ec34544SRui Ueyama // Read a program header type name. The next token must be a
13002ec34544SRui Ueyama // name of a program header type or a constant (e.g. "0x3").
13012ec34544SRui Ueyama unsigned ScriptParser::readPhdrType() {
13022ec34544SRui Ueyama   StringRef Tok = next();
13035c65088fSRui Ueyama   if (Optional<uint64_t> Val = parseInt(Tok))
13045c65088fSRui Ueyama     return *Val;
13052ec34544SRui Ueyama 
13062ec34544SRui Ueyama   unsigned Ret = StringSwitch<unsigned>(Tok)
13072ec34544SRui Ueyama                      .Case("PT_NULL", PT_NULL)
13082ec34544SRui Ueyama                      .Case("PT_LOAD", PT_LOAD)
13092ec34544SRui Ueyama                      .Case("PT_DYNAMIC", PT_DYNAMIC)
13102ec34544SRui Ueyama                      .Case("PT_INTERP", PT_INTERP)
13112ec34544SRui Ueyama                      .Case("PT_NOTE", PT_NOTE)
13122ec34544SRui Ueyama                      .Case("PT_SHLIB", PT_SHLIB)
13132ec34544SRui Ueyama                      .Case("PT_PHDR", PT_PHDR)
13142ec34544SRui Ueyama                      .Case("PT_TLS", PT_TLS)
13152ec34544SRui Ueyama                      .Case("PT_GNU_EH_FRAME", PT_GNU_EH_FRAME)
13162ec34544SRui Ueyama                      .Case("PT_GNU_STACK", PT_GNU_STACK)
13172ec34544SRui Ueyama                      .Case("PT_GNU_RELRO", PT_GNU_RELRO)
13182ec34544SRui Ueyama                      .Case("PT_OPENBSD_RANDOMIZE", PT_OPENBSD_RANDOMIZE)
13192ec34544SRui Ueyama                      .Case("PT_OPENBSD_WXNEEDED", PT_OPENBSD_WXNEEDED)
13202ec34544SRui Ueyama                      .Case("PT_OPENBSD_BOOTDATA", PT_OPENBSD_BOOTDATA)
13212ec34544SRui Ueyama                      .Default(-1);
13222ec34544SRui Ueyama 
13232ec34544SRui Ueyama   if (Ret == (unsigned)-1) {
13242ec34544SRui Ueyama     setError("invalid program header type: " + Tok);
13252ec34544SRui Ueyama     return PT_NULL;
13262ec34544SRui Ueyama   }
13272ec34544SRui Ueyama   return Ret;
13282ec34544SRui Ueyama }
13292ec34544SRui Ueyama 
13302ec34544SRui Ueyama // Reads an anonymous version declaration.
13312ec34544SRui Ueyama void ScriptParser::readAnonymousDeclaration() {
13322ec34544SRui Ueyama   std::vector<SymbolVersion> Locals;
13332ec34544SRui Ueyama   std::vector<SymbolVersion> Globals;
13342ec34544SRui Ueyama   std::tie(Locals, Globals) = readSymbols();
13352ec34544SRui Ueyama 
13362ec34544SRui Ueyama   for (SymbolVersion V : Locals) {
13372ec34544SRui Ueyama     if (V.Name == "*")
13382ec34544SRui Ueyama       Config->DefaultSymbolVersion = VER_NDX_LOCAL;
13392ec34544SRui Ueyama     else
13402ec34544SRui Ueyama       Config->VersionScriptLocals.push_back(V);
13412ec34544SRui Ueyama   }
13422ec34544SRui Ueyama 
13432ec34544SRui Ueyama   for (SymbolVersion V : Globals)
13442ec34544SRui Ueyama     Config->VersionScriptGlobals.push_back(V);
13452ec34544SRui Ueyama 
13462ec34544SRui Ueyama   expect(";");
13472ec34544SRui Ueyama }
13482ec34544SRui Ueyama 
13492ec34544SRui Ueyama // Reads a non-anonymous version definition,
13502ec34544SRui Ueyama // e.g. "VerStr { global: foo; bar; local: *; };".
13512ec34544SRui Ueyama void ScriptParser::readVersionDeclaration(StringRef VerStr) {
13522ec34544SRui Ueyama   // Read a symbol list.
13532ec34544SRui Ueyama   std::vector<SymbolVersion> Locals;
13542ec34544SRui Ueyama   std::vector<SymbolVersion> Globals;
13552ec34544SRui Ueyama   std::tie(Locals, Globals) = readSymbols();
13562ec34544SRui Ueyama 
13572ec34544SRui Ueyama   for (SymbolVersion V : Locals) {
13582ec34544SRui Ueyama     if (V.Name == "*")
13592ec34544SRui Ueyama       Config->DefaultSymbolVersion = VER_NDX_LOCAL;
13602ec34544SRui Ueyama     else
13612ec34544SRui Ueyama       Config->VersionScriptLocals.push_back(V);
13622ec34544SRui Ueyama   }
13632ec34544SRui Ueyama 
13642ec34544SRui Ueyama   // Create a new version definition and add that to the global symbols.
13652ec34544SRui Ueyama   VersionDefinition Ver;
13662ec34544SRui Ueyama   Ver.Name = VerStr;
13672ec34544SRui Ueyama   Ver.Globals = Globals;
13682ec34544SRui Ueyama 
13692ec34544SRui Ueyama   // User-defined version number starts from 2 because 0 and 1 are
13702ec34544SRui Ueyama   // reserved for VER_NDX_LOCAL and VER_NDX_GLOBAL, respectively.
13712ec34544SRui Ueyama   Ver.Id = Config->VersionDefinitions.size() + 2;
13722ec34544SRui Ueyama   Config->VersionDefinitions.push_back(Ver);
13732ec34544SRui Ueyama 
13742ec34544SRui Ueyama   // Each version may have a parent version. For example, "Ver2"
13752ec34544SRui Ueyama   // defined as "Ver2 { global: foo; local: *; } Ver1;" has "Ver1"
13762ec34544SRui Ueyama   // as a parent. This version hierarchy is, probably against your
13772ec34544SRui Ueyama   // instinct, purely for hint; the runtime doesn't care about it
13782ec34544SRui Ueyama   // at all. In LLD, we simply ignore it.
13792ec34544SRui Ueyama   if (peek() != ";")
13802ec34544SRui Ueyama     skip();
13812ec34544SRui Ueyama   expect(";");
13822ec34544SRui Ueyama }
13832ec34544SRui Ueyama 
13841e77ad14SRui Ueyama static bool hasWildcard(StringRef S) {
13851e77ad14SRui Ueyama   return S.find_first_of("?*[") != StringRef::npos;
13861e77ad14SRui Ueyama }
13871e77ad14SRui Ueyama 
13882ec34544SRui Ueyama // Reads a list of symbols, e.g. "{ global: foo; bar; local: *; };".
13892ec34544SRui Ueyama std::pair<std::vector<SymbolVersion>, std::vector<SymbolVersion>>
13902ec34544SRui Ueyama ScriptParser::readSymbols() {
13912ec34544SRui Ueyama   std::vector<SymbolVersion> Locals;
13922ec34544SRui Ueyama   std::vector<SymbolVersion> Globals;
13932ec34544SRui Ueyama   std::vector<SymbolVersion> *V = &Globals;
13942ec34544SRui Ueyama 
1395b8a59c8aSBob Haarman   while (!errorCount()) {
13962ec34544SRui Ueyama     if (consume("}"))
13972ec34544SRui Ueyama       break;
13982ec34544SRui Ueyama     if (consumeLabel("local")) {
13992ec34544SRui Ueyama       V = &Locals;
14002ec34544SRui Ueyama       continue;
14012ec34544SRui Ueyama     }
14022ec34544SRui Ueyama     if (consumeLabel("global")) {
14032ec34544SRui Ueyama       V = &Globals;
14042ec34544SRui Ueyama       continue;
14052ec34544SRui Ueyama     }
14062ec34544SRui Ueyama 
14072ec34544SRui Ueyama     if (consume("extern")) {
14082ec34544SRui Ueyama       std::vector<SymbolVersion> Ext = readVersionExtern();
14092ec34544SRui Ueyama       V->insert(V->end(), Ext.begin(), Ext.end());
14102ec34544SRui Ueyama     } else {
14112ec34544SRui Ueyama       StringRef Tok = next();
14122ec34544SRui Ueyama       V->push_back({unquote(Tok), false, hasWildcard(Tok)});
14132ec34544SRui Ueyama     }
14142ec34544SRui Ueyama     expect(";");
14152ec34544SRui Ueyama   }
14162ec34544SRui Ueyama   return {Locals, Globals};
14172ec34544SRui Ueyama }
14182ec34544SRui Ueyama 
14192ec34544SRui Ueyama // Reads an "extern C++" directive, e.g.,
14202ec34544SRui Ueyama // "extern "C++" { ns::*; "f(int, double)"; };"
142117324d8bSRui Ueyama //
142217324d8bSRui Ueyama // The last semicolon is optional. E.g. this is OK:
142317324d8bSRui Ueyama // "extern "C++" { ns::*; "f(int, double)" };"
14242ec34544SRui Ueyama std::vector<SymbolVersion> ScriptParser::readVersionExtern() {
14252ec34544SRui Ueyama   StringRef Tok = next();
14262ec34544SRui Ueyama   bool IsCXX = Tok == "\"C++\"";
14272ec34544SRui Ueyama   if (!IsCXX && Tok != "\"C\"")
14282ec34544SRui Ueyama     setError("Unknown language");
14292ec34544SRui Ueyama   expect("{");
14302ec34544SRui Ueyama 
14312ec34544SRui Ueyama   std::vector<SymbolVersion> Ret;
1432b8a59c8aSBob Haarman   while (!errorCount() && peek() != "}") {
14332ec34544SRui Ueyama     StringRef Tok = next();
14342ec34544SRui Ueyama     bool HasWildcard = !Tok.startswith("\"") && hasWildcard(Tok);
14352ec34544SRui Ueyama     Ret.push_back({unquote(Tok), IsCXX, HasWildcard});
143617324d8bSRui Ueyama     if (consume("}"))
143717324d8bSRui Ueyama       return Ret;
14382ec34544SRui Ueyama     expect(";");
14392ec34544SRui Ueyama   }
14402ec34544SRui Ueyama 
14412ec34544SRui Ueyama   expect("}");
14422ec34544SRui Ueyama   return Ret;
14432ec34544SRui Ueyama }
14442ec34544SRui Ueyama 
14452ec34544SRui Ueyama uint64_t ScriptParser::readMemoryAssignment(StringRef S1, StringRef S2,
14462ec34544SRui Ueyama                                             StringRef S3) {
1447b579c439SRui Ueyama   if (!consume(S1) && !consume(S2) && !consume(S3)) {
14482ec34544SRui Ueyama     setError("expected one of: " + S1 + ", " + S2 + ", or " + S3);
14492ec34544SRui Ueyama     return 0;
14502ec34544SRui Ueyama   }
14512ec34544SRui Ueyama   expect("=");
1452040af7deSRui Ueyama   return readExpr()().getValue();
14532ec34544SRui Ueyama }
14542ec34544SRui Ueyama 
14552ec34544SRui Ueyama // Parse the MEMORY command as specified in:
14562ec34544SRui Ueyama // https://sourceware.org/binutils/docs/ld/MEMORY.html
14572ec34544SRui Ueyama //
14582ec34544SRui Ueyama // MEMORY { name [(attr)] : ORIGIN = origin, LENGTH = len ... }
14592ec34544SRui Ueyama void ScriptParser::readMemory() {
14602ec34544SRui Ueyama   expect("{");
1461b8a59c8aSBob Haarman   while (!errorCount() && !consume("}")) {
14622e9d40d5SRui Ueyama     StringRef Tok = next();
14632e9d40d5SRui Ueyama     if (Tok == "INCLUDE") {
14642e9d40d5SRui Ueyama       readInclude();
14652e9d40d5SRui Ueyama       continue;
14662e9d40d5SRui Ueyama     }
14672ec34544SRui Ueyama 
14682ec34544SRui Ueyama     uint32_t Flags = 0;
14692ec34544SRui Ueyama     uint32_t NegFlags = 0;
14702ec34544SRui Ueyama     if (consume("(")) {
14712ec34544SRui Ueyama       std::tie(Flags, NegFlags) = readMemoryAttributes();
14722ec34544SRui Ueyama       expect(")");
14732ec34544SRui Ueyama     }
14742ec34544SRui Ueyama     expect(":");
14752ec34544SRui Ueyama 
14762ec34544SRui Ueyama     uint64_t Origin = readMemoryAssignment("ORIGIN", "org", "o");
14772ec34544SRui Ueyama     expect(",");
14782ec34544SRui Ueyama     uint64_t Length = readMemoryAssignment("LENGTH", "len", "l");
14792ec34544SRui Ueyama 
14805f37541cSGeorge Rimar     // Add the memory region to the region map.
14812e9d40d5SRui Ueyama     MemoryRegion *MR = make<MemoryRegion>(Tok, Origin, Length, Flags, NegFlags);
14822e9d40d5SRui Ueyama     if (!Script->MemoryRegions.insert({Tok, MR}).second)
14832e9d40d5SRui Ueyama       setError("region '" + Tok + "' already defined");
14842ec34544SRui Ueyama   }
14852ec34544SRui Ueyama }
14862ec34544SRui Ueyama 
14872ec34544SRui Ueyama // This function parses the attributes used to match against section
14882ec34544SRui Ueyama // flags when placing output sections in a memory region. These flags
14892ec34544SRui Ueyama // are only used when an explicit memory region name is not used.
14902ec34544SRui Ueyama std::pair<uint32_t, uint32_t> ScriptParser::readMemoryAttributes() {
14912ec34544SRui Ueyama   uint32_t Flags = 0;
14922ec34544SRui Ueyama   uint32_t NegFlags = 0;
14932ec34544SRui Ueyama   bool Invert = false;
14942ec34544SRui Ueyama 
14952ec34544SRui Ueyama   for (char C : next().lower()) {
14962ec34544SRui Ueyama     uint32_t Flag = 0;
14972ec34544SRui Ueyama     if (C == '!')
14982ec34544SRui Ueyama       Invert = !Invert;
14992ec34544SRui Ueyama     else if (C == 'w')
15002ec34544SRui Ueyama       Flag = SHF_WRITE;
15012ec34544SRui Ueyama     else if (C == 'x')
15022ec34544SRui Ueyama       Flag = SHF_EXECINSTR;
15032ec34544SRui Ueyama     else if (C == 'a')
15042ec34544SRui Ueyama       Flag = SHF_ALLOC;
15052ec34544SRui Ueyama     else if (C != 'r')
15062ec34544SRui Ueyama       setError("invalid memory region attribute");
15072ec34544SRui Ueyama 
15082ec34544SRui Ueyama     if (Invert)
15092ec34544SRui Ueyama       NegFlags |= Flag;
15102ec34544SRui Ueyama     else
15112ec34544SRui Ueyama       Flags |= Flag;
15122ec34544SRui Ueyama   }
15132ec34544SRui Ueyama   return {Flags, NegFlags};
15142ec34544SRui Ueyama }
15152ec34544SRui Ueyama 
15162ec34544SRui Ueyama void elf::readLinkerScript(MemoryBufferRef MB) {
15172ec34544SRui Ueyama   ScriptParser(MB).readLinkerScript();
15182ec34544SRui Ueyama }
15192ec34544SRui Ueyama 
15202ec34544SRui Ueyama void elf::readVersionScript(MemoryBufferRef MB) {
15212ec34544SRui Ueyama   ScriptParser(MB).readVersionScript();
15222ec34544SRui Ueyama }
15232ec34544SRui Ueyama 
15242ec34544SRui Ueyama void elf::readDynamicList(MemoryBufferRef MB) {
15252ec34544SRui Ueyama   ScriptParser(MB).readDynamicList();
15262ec34544SRui Ueyama }
15278c7e8cceSPetr Hosek 
15288c7e8cceSPetr Hosek void elf::readDefsym(StringRef Name, MemoryBufferRef MB) {
15298c7e8cceSPetr Hosek   ScriptParser(MB).readDefsym(Name);
15308c7e8cceSPetr Hosek }
1531