xref: /freebsd/contrib/llvm-project/lld/ELF/ScriptParser.cpp (revision 85868e8a1daeaae7a0e48effb2ea2310ae3b02c6)
10b57cec5SDimitry Andric //===- ScriptParser.cpp ---------------------------------------------------===//
20b57cec5SDimitry Andric //
30b57cec5SDimitry Andric // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
40b57cec5SDimitry Andric // See https://llvm.org/LICENSE.txt for license information.
50b57cec5SDimitry Andric // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
60b57cec5SDimitry Andric //
70b57cec5SDimitry Andric //===----------------------------------------------------------------------===//
80b57cec5SDimitry Andric //
90b57cec5SDimitry Andric // This file contains a recursive-descendent parser for linker scripts.
100b57cec5SDimitry Andric // Parsed results are stored to Config and Script global objects.
110b57cec5SDimitry Andric //
120b57cec5SDimitry Andric //===----------------------------------------------------------------------===//
130b57cec5SDimitry Andric 
140b57cec5SDimitry Andric #include "ScriptParser.h"
150b57cec5SDimitry Andric #include "Config.h"
160b57cec5SDimitry Andric #include "Driver.h"
170b57cec5SDimitry Andric #include "InputSection.h"
180b57cec5SDimitry Andric #include "LinkerScript.h"
190b57cec5SDimitry Andric #include "OutputSections.h"
200b57cec5SDimitry Andric #include "ScriptLexer.h"
210b57cec5SDimitry Andric #include "Symbols.h"
220b57cec5SDimitry Andric #include "Target.h"
230b57cec5SDimitry Andric #include "lld/Common/Memory.h"
240b57cec5SDimitry Andric #include "llvm/ADT/SmallString.h"
250b57cec5SDimitry Andric #include "llvm/ADT/StringRef.h"
260b57cec5SDimitry Andric #include "llvm/ADT/StringSet.h"
270b57cec5SDimitry Andric #include "llvm/ADT/StringSwitch.h"
280b57cec5SDimitry Andric #include "llvm/BinaryFormat/ELF.h"
290b57cec5SDimitry Andric #include "llvm/Support/Casting.h"
300b57cec5SDimitry Andric #include "llvm/Support/ErrorHandling.h"
310b57cec5SDimitry Andric #include "llvm/Support/FileSystem.h"
320b57cec5SDimitry Andric #include "llvm/Support/Path.h"
330b57cec5SDimitry Andric #include <cassert>
340b57cec5SDimitry Andric #include <limits>
350b57cec5SDimitry Andric #include <vector>
360b57cec5SDimitry Andric 
370b57cec5SDimitry Andric using namespace llvm;
380b57cec5SDimitry Andric using namespace llvm::ELF;
390b57cec5SDimitry Andric using namespace llvm::support::endian;
400b57cec5SDimitry Andric 
41*85868e8aSDimitry Andric namespace lld {
42*85868e8aSDimitry Andric namespace elf {
430b57cec5SDimitry Andric namespace {
440b57cec5SDimitry Andric class ScriptParser final : ScriptLexer {
450b57cec5SDimitry Andric public:
460b57cec5SDimitry Andric   ScriptParser(MemoryBufferRef mb) : ScriptLexer(mb) {
470b57cec5SDimitry Andric     // Initialize IsUnderSysroot
480b57cec5SDimitry Andric     if (config->sysroot == "")
490b57cec5SDimitry Andric       return;
500b57cec5SDimitry Andric     StringRef path = mb.getBufferIdentifier();
510b57cec5SDimitry Andric     for (; !path.empty(); path = sys::path::parent_path(path)) {
520b57cec5SDimitry Andric       if (!sys::fs::equivalent(config->sysroot, path))
530b57cec5SDimitry Andric         continue;
540b57cec5SDimitry Andric       isUnderSysroot = true;
550b57cec5SDimitry Andric       return;
560b57cec5SDimitry Andric     }
570b57cec5SDimitry Andric   }
580b57cec5SDimitry Andric 
590b57cec5SDimitry Andric   void readLinkerScript();
600b57cec5SDimitry Andric   void readVersionScript();
610b57cec5SDimitry Andric   void readDynamicList();
620b57cec5SDimitry Andric   void readDefsym(StringRef name);
630b57cec5SDimitry Andric 
640b57cec5SDimitry Andric private:
650b57cec5SDimitry Andric   void addFile(StringRef path);
660b57cec5SDimitry Andric 
670b57cec5SDimitry Andric   void readAsNeeded();
680b57cec5SDimitry Andric   void readEntry();
690b57cec5SDimitry Andric   void readExtern();
700b57cec5SDimitry Andric   void readGroup();
710b57cec5SDimitry Andric   void readInclude();
720b57cec5SDimitry Andric   void readInput();
730b57cec5SDimitry Andric   void readMemory();
740b57cec5SDimitry Andric   void readOutput();
750b57cec5SDimitry Andric   void readOutputArch();
760b57cec5SDimitry Andric   void readOutputFormat();
770b57cec5SDimitry Andric   void readPhdrs();
780b57cec5SDimitry Andric   void readRegionAlias();
790b57cec5SDimitry Andric   void readSearchDir();
800b57cec5SDimitry Andric   void readSections();
810b57cec5SDimitry Andric   void readTarget();
820b57cec5SDimitry Andric   void readVersion();
830b57cec5SDimitry Andric   void readVersionScriptCommand();
840b57cec5SDimitry Andric 
850b57cec5SDimitry Andric   SymbolAssignment *readSymbolAssignment(StringRef name);
860b57cec5SDimitry Andric   ByteCommand *readByteCommand(StringRef tok);
870b57cec5SDimitry Andric   std::array<uint8_t, 4> readFill();
880b57cec5SDimitry Andric   bool readSectionDirective(OutputSection *cmd, StringRef tok1, StringRef tok2);
890b57cec5SDimitry Andric   void readSectionAddressType(OutputSection *cmd);
900b57cec5SDimitry Andric   OutputSection *readOverlaySectionDescription();
910b57cec5SDimitry Andric   OutputSection *readOutputSectionDescription(StringRef outSec);
920b57cec5SDimitry Andric   std::vector<BaseCommand *> readOverlay();
930b57cec5SDimitry Andric   std::vector<StringRef> readOutputSectionPhdrs();
940b57cec5SDimitry Andric   InputSectionDescription *readInputSectionDescription(StringRef tok);
950b57cec5SDimitry Andric   StringMatcher readFilePatterns();
960b57cec5SDimitry Andric   std::vector<SectionPattern> readInputSectionsList();
970b57cec5SDimitry Andric   InputSectionDescription *readInputSectionRules(StringRef filePattern);
980b57cec5SDimitry Andric   unsigned readPhdrType();
990b57cec5SDimitry Andric   SortSectionPolicy readSortKind();
1000b57cec5SDimitry Andric   SymbolAssignment *readProvideHidden(bool provide, bool hidden);
1010b57cec5SDimitry Andric   SymbolAssignment *readAssignment(StringRef tok);
1020b57cec5SDimitry Andric   void readSort();
1030b57cec5SDimitry Andric   Expr readAssert();
1040b57cec5SDimitry Andric   Expr readConstant();
1050b57cec5SDimitry Andric   Expr getPageSize();
1060b57cec5SDimitry Andric 
1070b57cec5SDimitry Andric   uint64_t readMemoryAssignment(StringRef, StringRef, StringRef);
1080b57cec5SDimitry Andric   std::pair<uint32_t, uint32_t> readMemoryAttributes();
1090b57cec5SDimitry Andric 
1100b57cec5SDimitry Andric   Expr combine(StringRef op, Expr l, Expr r);
1110b57cec5SDimitry Andric   Expr readExpr();
1120b57cec5SDimitry Andric   Expr readExpr1(Expr lhs, int minPrec);
1130b57cec5SDimitry Andric   StringRef readParenLiteral();
1140b57cec5SDimitry Andric   Expr readPrimary();
1150b57cec5SDimitry Andric   Expr readTernary(Expr cond);
1160b57cec5SDimitry Andric   Expr readParenExpr();
1170b57cec5SDimitry Andric 
1180b57cec5SDimitry Andric   // For parsing version script.
1190b57cec5SDimitry Andric   std::vector<SymbolVersion> readVersionExtern();
1200b57cec5SDimitry Andric   void readAnonymousDeclaration();
1210b57cec5SDimitry Andric   void readVersionDeclaration(StringRef verStr);
1220b57cec5SDimitry Andric 
1230b57cec5SDimitry Andric   std::pair<std::vector<SymbolVersion>, std::vector<SymbolVersion>>
1240b57cec5SDimitry Andric   readSymbols();
1250b57cec5SDimitry Andric 
1260b57cec5SDimitry Andric   // True if a script being read is in a subdirectory specified by -sysroot.
1270b57cec5SDimitry Andric   bool isUnderSysroot = false;
1280b57cec5SDimitry Andric 
1290b57cec5SDimitry Andric   // A set to detect an INCLUDE() cycle.
1300b57cec5SDimitry Andric   StringSet<> seen;
1310b57cec5SDimitry Andric };
1320b57cec5SDimitry Andric } // namespace
1330b57cec5SDimitry Andric 
1340b57cec5SDimitry Andric static StringRef unquote(StringRef s) {
1350b57cec5SDimitry Andric   if (s.startswith("\""))
1360b57cec5SDimitry Andric     return s.substr(1, s.size() - 2);
1370b57cec5SDimitry Andric   return s;
1380b57cec5SDimitry Andric }
1390b57cec5SDimitry Andric 
1400b57cec5SDimitry Andric // Some operations only support one non absolute value. Move the
1410b57cec5SDimitry Andric // absolute one to the right hand side for convenience.
1420b57cec5SDimitry Andric static void moveAbsRight(ExprValue &a, ExprValue &b) {
1430b57cec5SDimitry Andric   if (a.sec == nullptr || (a.forceAbsolute && !b.isAbsolute()))
1440b57cec5SDimitry Andric     std::swap(a, b);
1450b57cec5SDimitry Andric   if (!b.isAbsolute())
1460b57cec5SDimitry Andric     error(a.loc + ": at least one side of the expression must be absolute");
1470b57cec5SDimitry Andric }
1480b57cec5SDimitry Andric 
1490b57cec5SDimitry Andric static ExprValue add(ExprValue a, ExprValue b) {
1500b57cec5SDimitry Andric   moveAbsRight(a, b);
1510b57cec5SDimitry Andric   return {a.sec, a.forceAbsolute, a.getSectionOffset() + b.getValue(), a.loc};
1520b57cec5SDimitry Andric }
1530b57cec5SDimitry Andric 
1540b57cec5SDimitry Andric static ExprValue sub(ExprValue a, ExprValue b) {
1550b57cec5SDimitry Andric   // The distance between two symbols in sections is absolute.
1560b57cec5SDimitry Andric   if (!a.isAbsolute() && !b.isAbsolute())
1570b57cec5SDimitry Andric     return a.getValue() - b.getValue();
1580b57cec5SDimitry Andric   return {a.sec, false, a.getSectionOffset() - b.getValue(), a.loc};
1590b57cec5SDimitry Andric }
1600b57cec5SDimitry Andric 
1610b57cec5SDimitry Andric static ExprValue bitAnd(ExprValue a, ExprValue b) {
1620b57cec5SDimitry Andric   moveAbsRight(a, b);
1630b57cec5SDimitry Andric   return {a.sec, a.forceAbsolute,
1640b57cec5SDimitry Andric           (a.getValue() & b.getValue()) - a.getSecAddr(), a.loc};
1650b57cec5SDimitry Andric }
1660b57cec5SDimitry Andric 
1670b57cec5SDimitry Andric static ExprValue bitOr(ExprValue a, ExprValue b) {
1680b57cec5SDimitry Andric   moveAbsRight(a, b);
1690b57cec5SDimitry Andric   return {a.sec, a.forceAbsolute,
1700b57cec5SDimitry Andric           (a.getValue() | b.getValue()) - a.getSecAddr(), a.loc};
1710b57cec5SDimitry Andric }
1720b57cec5SDimitry Andric 
1730b57cec5SDimitry Andric void ScriptParser::readDynamicList() {
1740b57cec5SDimitry Andric   config->hasDynamicList = true;
1750b57cec5SDimitry Andric   expect("{");
1760b57cec5SDimitry Andric   std::vector<SymbolVersion> locals;
1770b57cec5SDimitry Andric   std::vector<SymbolVersion> globals;
1780b57cec5SDimitry Andric   std::tie(locals, globals) = readSymbols();
1790b57cec5SDimitry Andric   expect(";");
1800b57cec5SDimitry Andric 
1810b57cec5SDimitry Andric   if (!atEOF()) {
1820b57cec5SDimitry Andric     setError("EOF expected, but got " + next());
1830b57cec5SDimitry Andric     return;
1840b57cec5SDimitry Andric   }
1850b57cec5SDimitry Andric   if (!locals.empty()) {
1860b57cec5SDimitry Andric     setError("\"local:\" scope not supported in --dynamic-list");
1870b57cec5SDimitry Andric     return;
1880b57cec5SDimitry Andric   }
1890b57cec5SDimitry Andric 
1900b57cec5SDimitry Andric   for (SymbolVersion v : globals)
1910b57cec5SDimitry Andric     config->dynamicList.push_back(v);
1920b57cec5SDimitry Andric }
1930b57cec5SDimitry Andric 
1940b57cec5SDimitry Andric void ScriptParser::readVersionScript() {
1950b57cec5SDimitry Andric   readVersionScriptCommand();
1960b57cec5SDimitry Andric   if (!atEOF())
1970b57cec5SDimitry Andric     setError("EOF expected, but got " + next());
1980b57cec5SDimitry Andric }
1990b57cec5SDimitry Andric 
2000b57cec5SDimitry Andric void ScriptParser::readVersionScriptCommand() {
2010b57cec5SDimitry Andric   if (consume("{")) {
2020b57cec5SDimitry Andric     readAnonymousDeclaration();
2030b57cec5SDimitry Andric     return;
2040b57cec5SDimitry Andric   }
2050b57cec5SDimitry Andric 
2060b57cec5SDimitry Andric   while (!atEOF() && !errorCount() && peek() != "}") {
2070b57cec5SDimitry Andric     StringRef verStr = next();
2080b57cec5SDimitry Andric     if (verStr == "{") {
2090b57cec5SDimitry Andric       setError("anonymous version definition is used in "
2100b57cec5SDimitry Andric                "combination with other version definitions");
2110b57cec5SDimitry Andric       return;
2120b57cec5SDimitry Andric     }
2130b57cec5SDimitry Andric     expect("{");
2140b57cec5SDimitry Andric     readVersionDeclaration(verStr);
2150b57cec5SDimitry Andric   }
2160b57cec5SDimitry Andric }
2170b57cec5SDimitry Andric 
2180b57cec5SDimitry Andric void ScriptParser::readVersion() {
2190b57cec5SDimitry Andric   expect("{");
2200b57cec5SDimitry Andric   readVersionScriptCommand();
2210b57cec5SDimitry Andric   expect("}");
2220b57cec5SDimitry Andric }
2230b57cec5SDimitry Andric 
2240b57cec5SDimitry Andric void ScriptParser::readLinkerScript() {
2250b57cec5SDimitry Andric   while (!atEOF()) {
2260b57cec5SDimitry Andric     StringRef tok = next();
2270b57cec5SDimitry Andric     if (tok == ";")
2280b57cec5SDimitry Andric       continue;
2290b57cec5SDimitry Andric 
2300b57cec5SDimitry Andric     if (tok == "ENTRY") {
2310b57cec5SDimitry Andric       readEntry();
2320b57cec5SDimitry Andric     } else if (tok == "EXTERN") {
2330b57cec5SDimitry Andric       readExtern();
2340b57cec5SDimitry Andric     } else if (tok == "GROUP") {
2350b57cec5SDimitry Andric       readGroup();
2360b57cec5SDimitry Andric     } else if (tok == "INCLUDE") {
2370b57cec5SDimitry Andric       readInclude();
2380b57cec5SDimitry Andric     } else if (tok == "INPUT") {
2390b57cec5SDimitry Andric       readInput();
2400b57cec5SDimitry Andric     } else if (tok == "MEMORY") {
2410b57cec5SDimitry Andric       readMemory();
2420b57cec5SDimitry Andric     } else if (tok == "OUTPUT") {
2430b57cec5SDimitry Andric       readOutput();
2440b57cec5SDimitry Andric     } else if (tok == "OUTPUT_ARCH") {
2450b57cec5SDimitry Andric       readOutputArch();
2460b57cec5SDimitry Andric     } else if (tok == "OUTPUT_FORMAT") {
2470b57cec5SDimitry Andric       readOutputFormat();
2480b57cec5SDimitry Andric     } else if (tok == "PHDRS") {
2490b57cec5SDimitry Andric       readPhdrs();
2500b57cec5SDimitry Andric     } else if (tok == "REGION_ALIAS") {
2510b57cec5SDimitry Andric       readRegionAlias();
2520b57cec5SDimitry Andric     } else if (tok == "SEARCH_DIR") {
2530b57cec5SDimitry Andric       readSearchDir();
2540b57cec5SDimitry Andric     } else if (tok == "SECTIONS") {
2550b57cec5SDimitry Andric       readSections();
2560b57cec5SDimitry Andric     } else if (tok == "TARGET") {
2570b57cec5SDimitry Andric       readTarget();
2580b57cec5SDimitry Andric     } else if (tok == "VERSION") {
2590b57cec5SDimitry Andric       readVersion();
2600b57cec5SDimitry Andric     } else if (SymbolAssignment *cmd = readAssignment(tok)) {
2610b57cec5SDimitry Andric       script->sectionCommands.push_back(cmd);
2620b57cec5SDimitry Andric     } else {
2630b57cec5SDimitry Andric       setError("unknown directive: " + tok);
2640b57cec5SDimitry Andric     }
2650b57cec5SDimitry Andric   }
2660b57cec5SDimitry Andric }
2670b57cec5SDimitry Andric 
2680b57cec5SDimitry Andric void ScriptParser::readDefsym(StringRef name) {
2690b57cec5SDimitry Andric   if (errorCount())
2700b57cec5SDimitry Andric     return;
2710b57cec5SDimitry Andric   Expr e = readExpr();
2720b57cec5SDimitry Andric   if (!atEOF())
2730b57cec5SDimitry Andric     setError("EOF expected, but got " + next());
2740b57cec5SDimitry Andric   SymbolAssignment *cmd = make<SymbolAssignment>(name, e, getCurrentLocation());
2750b57cec5SDimitry Andric   script->sectionCommands.push_back(cmd);
2760b57cec5SDimitry Andric }
2770b57cec5SDimitry Andric 
2780b57cec5SDimitry Andric void ScriptParser::addFile(StringRef s) {
2790b57cec5SDimitry Andric   if (isUnderSysroot && s.startswith("/")) {
2800b57cec5SDimitry Andric     SmallString<128> pathData;
2810b57cec5SDimitry Andric     StringRef path = (config->sysroot + s).toStringRef(pathData);
2820b57cec5SDimitry Andric     if (sys::fs::exists(path)) {
2830b57cec5SDimitry Andric       driver->addFile(saver.save(path), /*withLOption=*/false);
2840b57cec5SDimitry Andric       return;
2850b57cec5SDimitry Andric     }
2860b57cec5SDimitry Andric   }
2870b57cec5SDimitry Andric 
2880b57cec5SDimitry Andric   if (s.startswith("/")) {
2890b57cec5SDimitry Andric     driver->addFile(s, /*withLOption=*/false);
2900b57cec5SDimitry Andric   } else if (s.startswith("=")) {
2910b57cec5SDimitry Andric     if (config->sysroot.empty())
2920b57cec5SDimitry Andric       driver->addFile(s.substr(1), /*withLOption=*/false);
2930b57cec5SDimitry Andric     else
2940b57cec5SDimitry Andric       driver->addFile(saver.save(config->sysroot + "/" + s.substr(1)),
2950b57cec5SDimitry Andric                       /*withLOption=*/false);
2960b57cec5SDimitry Andric   } else if (s.startswith("-l")) {
2970b57cec5SDimitry Andric     driver->addLibrary(s.substr(2));
2980b57cec5SDimitry Andric   } else if (sys::fs::exists(s)) {
2990b57cec5SDimitry Andric     driver->addFile(s, /*withLOption=*/false);
3000b57cec5SDimitry Andric   } else {
3010b57cec5SDimitry Andric     if (Optional<std::string> path = findFromSearchPaths(s))
3020b57cec5SDimitry Andric       driver->addFile(saver.save(*path), /*withLOption=*/true);
3030b57cec5SDimitry Andric     else
3040b57cec5SDimitry Andric       setError("unable to find " + s);
3050b57cec5SDimitry Andric   }
3060b57cec5SDimitry Andric }
3070b57cec5SDimitry Andric 
3080b57cec5SDimitry Andric void ScriptParser::readAsNeeded() {
3090b57cec5SDimitry Andric   expect("(");
3100b57cec5SDimitry Andric   bool orig = config->asNeeded;
3110b57cec5SDimitry Andric   config->asNeeded = true;
3120b57cec5SDimitry Andric   while (!errorCount() && !consume(")"))
3130b57cec5SDimitry Andric     addFile(unquote(next()));
3140b57cec5SDimitry Andric   config->asNeeded = orig;
3150b57cec5SDimitry Andric }
3160b57cec5SDimitry Andric 
3170b57cec5SDimitry Andric void ScriptParser::readEntry() {
3180b57cec5SDimitry Andric   // -e <symbol> takes predecence over ENTRY(<symbol>).
3190b57cec5SDimitry Andric   expect("(");
3200b57cec5SDimitry Andric   StringRef tok = next();
3210b57cec5SDimitry Andric   if (config->entry.empty())
3220b57cec5SDimitry Andric     config->entry = tok;
3230b57cec5SDimitry Andric   expect(")");
3240b57cec5SDimitry Andric }
3250b57cec5SDimitry Andric 
3260b57cec5SDimitry Andric void ScriptParser::readExtern() {
3270b57cec5SDimitry Andric   expect("(");
3280b57cec5SDimitry Andric   while (!errorCount() && !consume(")"))
3290b57cec5SDimitry Andric     config->undefined.push_back(unquote(next()));
3300b57cec5SDimitry Andric }
3310b57cec5SDimitry Andric 
3320b57cec5SDimitry Andric void ScriptParser::readGroup() {
3330b57cec5SDimitry Andric   bool orig = InputFile::isInGroup;
3340b57cec5SDimitry Andric   InputFile::isInGroup = true;
3350b57cec5SDimitry Andric   readInput();
3360b57cec5SDimitry Andric   InputFile::isInGroup = orig;
3370b57cec5SDimitry Andric   if (!orig)
3380b57cec5SDimitry Andric     ++InputFile::nextGroupId;
3390b57cec5SDimitry Andric }
3400b57cec5SDimitry Andric 
3410b57cec5SDimitry Andric void ScriptParser::readInclude() {
3420b57cec5SDimitry Andric   StringRef tok = unquote(next());
3430b57cec5SDimitry Andric 
3440b57cec5SDimitry Andric   if (!seen.insert(tok).second) {
3450b57cec5SDimitry Andric     setError("there is a cycle in linker script INCLUDEs");
3460b57cec5SDimitry Andric     return;
3470b57cec5SDimitry Andric   }
3480b57cec5SDimitry Andric 
3490b57cec5SDimitry Andric   if (Optional<std::string> path = searchScript(tok)) {
3500b57cec5SDimitry Andric     if (Optional<MemoryBufferRef> mb = readFile(*path))
3510b57cec5SDimitry Andric       tokenize(*mb);
3520b57cec5SDimitry Andric     return;
3530b57cec5SDimitry Andric   }
3540b57cec5SDimitry Andric   setError("cannot find linker script " + tok);
3550b57cec5SDimitry Andric }
3560b57cec5SDimitry Andric 
3570b57cec5SDimitry Andric void ScriptParser::readInput() {
3580b57cec5SDimitry Andric   expect("(");
3590b57cec5SDimitry Andric   while (!errorCount() && !consume(")")) {
3600b57cec5SDimitry Andric     if (consume("AS_NEEDED"))
3610b57cec5SDimitry Andric       readAsNeeded();
3620b57cec5SDimitry Andric     else
3630b57cec5SDimitry Andric       addFile(unquote(next()));
3640b57cec5SDimitry Andric   }
3650b57cec5SDimitry Andric }
3660b57cec5SDimitry Andric 
3670b57cec5SDimitry Andric void ScriptParser::readOutput() {
3680b57cec5SDimitry Andric   // -o <file> takes predecence over OUTPUT(<file>).
3690b57cec5SDimitry Andric   expect("(");
3700b57cec5SDimitry Andric   StringRef tok = next();
3710b57cec5SDimitry Andric   if (config->outputFile.empty())
3720b57cec5SDimitry Andric     config->outputFile = unquote(tok);
3730b57cec5SDimitry Andric   expect(")");
3740b57cec5SDimitry Andric }
3750b57cec5SDimitry Andric 
3760b57cec5SDimitry Andric void ScriptParser::readOutputArch() {
3770b57cec5SDimitry Andric   // OUTPUT_ARCH is ignored for now.
3780b57cec5SDimitry Andric   expect("(");
3790b57cec5SDimitry Andric   while (!errorCount() && !consume(")"))
3800b57cec5SDimitry Andric     skip();
3810b57cec5SDimitry Andric }
3820b57cec5SDimitry Andric 
3830b57cec5SDimitry Andric static std::pair<ELFKind, uint16_t> parseBfdName(StringRef s) {
3840b57cec5SDimitry Andric   return StringSwitch<std::pair<ELFKind, uint16_t>>(s)
3850b57cec5SDimitry Andric       .Case("elf32-i386", {ELF32LEKind, EM_386})
3860b57cec5SDimitry Andric       .Case("elf32-iamcu", {ELF32LEKind, EM_IAMCU})
3870b57cec5SDimitry Andric       .Case("elf32-littlearm", {ELF32LEKind, EM_ARM})
3880b57cec5SDimitry Andric       .Case("elf32-x86-64", {ELF32LEKind, EM_X86_64})
3890b57cec5SDimitry Andric       .Case("elf64-aarch64", {ELF64LEKind, EM_AARCH64})
3900b57cec5SDimitry Andric       .Case("elf64-littleaarch64", {ELF64LEKind, EM_AARCH64})
3910b57cec5SDimitry Andric       .Case("elf32-powerpc", {ELF32BEKind, EM_PPC})
3920b57cec5SDimitry Andric       .Case("elf64-powerpc", {ELF64BEKind, EM_PPC64})
3930b57cec5SDimitry Andric       .Case("elf64-powerpcle", {ELF64LEKind, EM_PPC64})
3940b57cec5SDimitry Andric       .Case("elf64-x86-64", {ELF64LEKind, EM_X86_64})
3950b57cec5SDimitry Andric       .Cases("elf32-tradbigmips", "elf32-bigmips", {ELF32BEKind, EM_MIPS})
3960b57cec5SDimitry Andric       .Case("elf32-ntradbigmips", {ELF32BEKind, EM_MIPS})
3970b57cec5SDimitry Andric       .Case("elf32-tradlittlemips", {ELF32LEKind, EM_MIPS})
3980b57cec5SDimitry Andric       .Case("elf32-ntradlittlemips", {ELF32LEKind, EM_MIPS})
3990b57cec5SDimitry Andric       .Case("elf64-tradbigmips", {ELF64BEKind, EM_MIPS})
4000b57cec5SDimitry Andric       .Case("elf64-tradlittlemips", {ELF64LEKind, EM_MIPS})
4010b57cec5SDimitry Andric       .Case("elf32-littleriscv", {ELF32LEKind, EM_RISCV})
4020b57cec5SDimitry Andric       .Case("elf64-littleriscv", {ELF64LEKind, EM_RISCV})
4030b57cec5SDimitry Andric       .Default({ELFNoneKind, EM_NONE});
4040b57cec5SDimitry Andric }
4050b57cec5SDimitry Andric 
4060b57cec5SDimitry Andric // Parse OUTPUT_FORMAT(bfdname) or OUTPUT_FORMAT(bfdname, big, little).
4070b57cec5SDimitry Andric // Currently we ignore big and little parameters.
4080b57cec5SDimitry Andric void ScriptParser::readOutputFormat() {
4090b57cec5SDimitry Andric   expect("(");
4100b57cec5SDimitry Andric 
4110b57cec5SDimitry Andric   StringRef name = unquote(next());
4120b57cec5SDimitry Andric   StringRef s = name;
4130b57cec5SDimitry Andric   if (s.consume_back("-freebsd"))
4140b57cec5SDimitry Andric     config->osabi = ELFOSABI_FREEBSD;
4150b57cec5SDimitry Andric 
4160b57cec5SDimitry Andric   std::tie(config->ekind, config->emachine) = parseBfdName(s);
4170b57cec5SDimitry Andric   if (config->emachine == EM_NONE)
4180b57cec5SDimitry Andric     setError("unknown output format name: " + name);
4190b57cec5SDimitry Andric   if (s == "elf32-ntradlittlemips" || s == "elf32-ntradbigmips")
4200b57cec5SDimitry Andric     config->mipsN32Abi = true;
4210b57cec5SDimitry Andric 
4220b57cec5SDimitry Andric   if (consume(")"))
4230b57cec5SDimitry Andric     return;
4240b57cec5SDimitry Andric   expect(",");
4250b57cec5SDimitry Andric   skip();
4260b57cec5SDimitry Andric   expect(",");
4270b57cec5SDimitry Andric   skip();
4280b57cec5SDimitry Andric   expect(")");
4290b57cec5SDimitry Andric }
4300b57cec5SDimitry Andric 
4310b57cec5SDimitry Andric void ScriptParser::readPhdrs() {
4320b57cec5SDimitry Andric   expect("{");
4330b57cec5SDimitry Andric 
4340b57cec5SDimitry Andric   while (!errorCount() && !consume("}")) {
4350b57cec5SDimitry Andric     PhdrsCommand cmd;
4360b57cec5SDimitry Andric     cmd.name = next();
4370b57cec5SDimitry Andric     cmd.type = readPhdrType();
4380b57cec5SDimitry Andric 
4390b57cec5SDimitry Andric     while (!errorCount() && !consume(";")) {
4400b57cec5SDimitry Andric       if (consume("FILEHDR"))
4410b57cec5SDimitry Andric         cmd.hasFilehdr = true;
4420b57cec5SDimitry Andric       else if (consume("PHDRS"))
4430b57cec5SDimitry Andric         cmd.hasPhdrs = true;
4440b57cec5SDimitry Andric       else if (consume("AT"))
4450b57cec5SDimitry Andric         cmd.lmaExpr = readParenExpr();
4460b57cec5SDimitry Andric       else if (consume("FLAGS"))
4470b57cec5SDimitry Andric         cmd.flags = readParenExpr()().getValue();
4480b57cec5SDimitry Andric       else
4490b57cec5SDimitry Andric         setError("unexpected header attribute: " + next());
4500b57cec5SDimitry Andric     }
4510b57cec5SDimitry Andric 
4520b57cec5SDimitry Andric     script->phdrsCommands.push_back(cmd);
4530b57cec5SDimitry Andric   }
4540b57cec5SDimitry Andric }
4550b57cec5SDimitry Andric 
4560b57cec5SDimitry Andric void ScriptParser::readRegionAlias() {
4570b57cec5SDimitry Andric   expect("(");
4580b57cec5SDimitry Andric   StringRef alias = unquote(next());
4590b57cec5SDimitry Andric   expect(",");
4600b57cec5SDimitry Andric   StringRef name = next();
4610b57cec5SDimitry Andric   expect(")");
4620b57cec5SDimitry Andric 
4630b57cec5SDimitry Andric   if (script->memoryRegions.count(alias))
4640b57cec5SDimitry Andric     setError("redefinition of memory region '" + alias + "'");
4650b57cec5SDimitry Andric   if (!script->memoryRegions.count(name))
4660b57cec5SDimitry Andric     setError("memory region '" + name + "' is not defined");
4670b57cec5SDimitry Andric   script->memoryRegions.insert({alias, script->memoryRegions[name]});
4680b57cec5SDimitry Andric }
4690b57cec5SDimitry Andric 
4700b57cec5SDimitry Andric void ScriptParser::readSearchDir() {
4710b57cec5SDimitry Andric   expect("(");
4720b57cec5SDimitry Andric   StringRef tok = next();
4730b57cec5SDimitry Andric   if (!config->nostdlib)
4740b57cec5SDimitry Andric     config->searchPaths.push_back(unquote(tok));
4750b57cec5SDimitry Andric   expect(")");
4760b57cec5SDimitry Andric }
4770b57cec5SDimitry Andric 
4780b57cec5SDimitry Andric // This reads an overlay description. Overlays are used to describe output
4790b57cec5SDimitry Andric // sections that use the same virtual memory range and normally would trigger
4800b57cec5SDimitry Andric // linker's sections sanity check failures.
4810b57cec5SDimitry Andric // https://sourceware.org/binutils/docs/ld/Overlay-Description.html#Overlay-Description
4820b57cec5SDimitry Andric std::vector<BaseCommand *> ScriptParser::readOverlay() {
4830b57cec5SDimitry Andric   // VA and LMA expressions are optional, though for simplicity of
4840b57cec5SDimitry Andric   // implementation we assume they are not. That is what OVERLAY was designed
4850b57cec5SDimitry Andric   // for first of all: to allow sections with overlapping VAs at different LMAs.
4860b57cec5SDimitry Andric   Expr addrExpr = readExpr();
4870b57cec5SDimitry Andric   expect(":");
4880b57cec5SDimitry Andric   expect("AT");
4890b57cec5SDimitry Andric   Expr lmaExpr = readParenExpr();
4900b57cec5SDimitry Andric   expect("{");
4910b57cec5SDimitry Andric 
4920b57cec5SDimitry Andric   std::vector<BaseCommand *> v;
4930b57cec5SDimitry Andric   OutputSection *prev = nullptr;
4940b57cec5SDimitry Andric   while (!errorCount() && !consume("}")) {
4950b57cec5SDimitry Andric     // VA is the same for all sections. The LMAs are consecutive in memory
4960b57cec5SDimitry Andric     // starting from the base load address specified.
4970b57cec5SDimitry Andric     OutputSection *os = readOverlaySectionDescription();
4980b57cec5SDimitry Andric     os->addrExpr = addrExpr;
4990b57cec5SDimitry Andric     if (prev)
5000b57cec5SDimitry Andric       os->lmaExpr = [=] { return prev->getLMA() + prev->size; };
5010b57cec5SDimitry Andric     else
5020b57cec5SDimitry Andric       os->lmaExpr = lmaExpr;
5030b57cec5SDimitry Andric     v.push_back(os);
5040b57cec5SDimitry Andric     prev = os;
5050b57cec5SDimitry Andric   }
5060b57cec5SDimitry Andric 
5070b57cec5SDimitry Andric   // According to the specification, at the end of the overlay, the location
5080b57cec5SDimitry Andric   // counter should be equal to the overlay base address plus size of the
5090b57cec5SDimitry Andric   // largest section seen in the overlay.
5100b57cec5SDimitry Andric   // Here we want to create the Dot assignment command to achieve that.
5110b57cec5SDimitry Andric   Expr moveDot = [=] {
5120b57cec5SDimitry Andric     uint64_t max = 0;
5130b57cec5SDimitry Andric     for (BaseCommand *cmd : v)
5140b57cec5SDimitry Andric       max = std::max(max, cast<OutputSection>(cmd)->size);
5150b57cec5SDimitry Andric     return addrExpr().getValue() + max;
5160b57cec5SDimitry Andric   };
5170b57cec5SDimitry Andric   v.push_back(make<SymbolAssignment>(".", moveDot, getCurrentLocation()));
5180b57cec5SDimitry Andric   return v;
5190b57cec5SDimitry Andric }
5200b57cec5SDimitry Andric 
5210b57cec5SDimitry Andric void ScriptParser::readSections() {
5220b57cec5SDimitry Andric   script->hasSectionsCommand = true;
5230b57cec5SDimitry Andric 
5240b57cec5SDimitry Andric   // -no-rosegment is used to avoid placing read only non-executable sections in
5250b57cec5SDimitry Andric   // their own segment. We do the same if SECTIONS command is present in linker
5260b57cec5SDimitry Andric   // script. See comment for computeFlags().
5270b57cec5SDimitry Andric   config->singleRoRx = true;
5280b57cec5SDimitry Andric 
5290b57cec5SDimitry Andric   expect("{");
5300b57cec5SDimitry Andric   std::vector<BaseCommand *> v;
5310b57cec5SDimitry Andric   while (!errorCount() && !consume("}")) {
5320b57cec5SDimitry Andric     StringRef tok = next();
5330b57cec5SDimitry Andric     if (tok == "OVERLAY") {
5340b57cec5SDimitry Andric       for (BaseCommand *cmd : readOverlay())
5350b57cec5SDimitry Andric         v.push_back(cmd);
5360b57cec5SDimitry Andric       continue;
5370b57cec5SDimitry Andric     } else if (tok == "INCLUDE") {
5380b57cec5SDimitry Andric       readInclude();
5390b57cec5SDimitry Andric       continue;
5400b57cec5SDimitry Andric     }
5410b57cec5SDimitry Andric 
5420b57cec5SDimitry Andric     if (BaseCommand *cmd = readAssignment(tok))
5430b57cec5SDimitry Andric       v.push_back(cmd);
5440b57cec5SDimitry Andric     else
5450b57cec5SDimitry Andric       v.push_back(readOutputSectionDescription(tok));
5460b57cec5SDimitry Andric   }
5470b57cec5SDimitry Andric 
5480b57cec5SDimitry Andric   if (!atEOF() && consume("INSERT")) {
5490b57cec5SDimitry Andric     std::vector<BaseCommand *> *dest = nullptr;
5500b57cec5SDimitry Andric     if (consume("AFTER"))
5510b57cec5SDimitry Andric       dest = &script->insertAfterCommands[next()];
5520b57cec5SDimitry Andric     else if (consume("BEFORE"))
5530b57cec5SDimitry Andric       dest = &script->insertBeforeCommands[next()];
5540b57cec5SDimitry Andric     else
5550b57cec5SDimitry Andric       setError("expected AFTER/BEFORE, but got '" + next() + "'");
5560b57cec5SDimitry Andric     if (dest)
5570b57cec5SDimitry Andric       dest->insert(dest->end(), v.begin(), v.end());
5580b57cec5SDimitry Andric     return;
5590b57cec5SDimitry Andric   }
5600b57cec5SDimitry Andric 
5610b57cec5SDimitry Andric   script->sectionCommands.insert(script->sectionCommands.end(), v.begin(),
5620b57cec5SDimitry Andric                                  v.end());
5630b57cec5SDimitry Andric }
5640b57cec5SDimitry Andric 
5650b57cec5SDimitry Andric void ScriptParser::readTarget() {
5660b57cec5SDimitry Andric   // TARGET(foo) is an alias for "--format foo". Unlike GNU linkers,
5670b57cec5SDimitry Andric   // we accept only a limited set of BFD names (i.e. "elf" or "binary")
5680b57cec5SDimitry Andric   // for --format. We recognize only /^elf/ and "binary" in the linker
5690b57cec5SDimitry Andric   // script as well.
5700b57cec5SDimitry Andric   expect("(");
5710b57cec5SDimitry Andric   StringRef tok = next();
5720b57cec5SDimitry Andric   expect(")");
5730b57cec5SDimitry Andric 
5740b57cec5SDimitry Andric   if (tok.startswith("elf"))
5750b57cec5SDimitry Andric     config->formatBinary = false;
5760b57cec5SDimitry Andric   else if (tok == "binary")
5770b57cec5SDimitry Andric     config->formatBinary = true;
5780b57cec5SDimitry Andric   else
5790b57cec5SDimitry Andric     setError("unknown target: " + tok);
5800b57cec5SDimitry Andric }
5810b57cec5SDimitry Andric 
5820b57cec5SDimitry Andric static int precedence(StringRef op) {
5830b57cec5SDimitry Andric   return StringSwitch<int>(op)
5840b57cec5SDimitry Andric       .Cases("*", "/", "%", 8)
5850b57cec5SDimitry Andric       .Cases("+", "-", 7)
5860b57cec5SDimitry Andric       .Cases("<<", ">>", 6)
5870b57cec5SDimitry Andric       .Cases("<", "<=", ">", ">=", "==", "!=", 5)
5880b57cec5SDimitry Andric       .Case("&", 4)
5890b57cec5SDimitry Andric       .Case("|", 3)
5900b57cec5SDimitry Andric       .Case("&&", 2)
5910b57cec5SDimitry Andric       .Case("||", 1)
5920b57cec5SDimitry Andric       .Default(-1);
5930b57cec5SDimitry Andric }
5940b57cec5SDimitry Andric 
5950b57cec5SDimitry Andric StringMatcher ScriptParser::readFilePatterns() {
5960b57cec5SDimitry Andric   std::vector<StringRef> v;
5970b57cec5SDimitry Andric   while (!errorCount() && !consume(")"))
5980b57cec5SDimitry Andric     v.push_back(next());
5990b57cec5SDimitry Andric   return StringMatcher(v);
6000b57cec5SDimitry Andric }
6010b57cec5SDimitry Andric 
6020b57cec5SDimitry Andric SortSectionPolicy ScriptParser::readSortKind() {
6030b57cec5SDimitry Andric   if (consume("SORT") || consume("SORT_BY_NAME"))
6040b57cec5SDimitry Andric     return SortSectionPolicy::Name;
6050b57cec5SDimitry Andric   if (consume("SORT_BY_ALIGNMENT"))
6060b57cec5SDimitry Andric     return SortSectionPolicy::Alignment;
6070b57cec5SDimitry Andric   if (consume("SORT_BY_INIT_PRIORITY"))
6080b57cec5SDimitry Andric     return SortSectionPolicy::Priority;
6090b57cec5SDimitry Andric   if (consume("SORT_NONE"))
6100b57cec5SDimitry Andric     return SortSectionPolicy::None;
6110b57cec5SDimitry Andric   return SortSectionPolicy::Default;
6120b57cec5SDimitry Andric }
6130b57cec5SDimitry Andric 
6140b57cec5SDimitry Andric // Reads SECTIONS command contents in the following form:
6150b57cec5SDimitry Andric //
6160b57cec5SDimitry Andric // <contents> ::= <elem>*
6170b57cec5SDimitry Andric // <elem>     ::= <exclude>? <glob-pattern>
6180b57cec5SDimitry Andric // <exclude>  ::= "EXCLUDE_FILE" "(" <glob-pattern>+ ")"
6190b57cec5SDimitry Andric //
6200b57cec5SDimitry Andric // For example,
6210b57cec5SDimitry Andric //
6220b57cec5SDimitry Andric // *(.foo EXCLUDE_FILE (a.o) .bar EXCLUDE_FILE (b.o) .baz)
6230b57cec5SDimitry Andric //
6240b57cec5SDimitry Andric // is parsed as ".foo", ".bar" with "a.o", and ".baz" with "b.o".
6250b57cec5SDimitry Andric // The semantics of that is section .foo in any file, section .bar in
6260b57cec5SDimitry Andric // any file but a.o, and section .baz in any file but b.o.
6270b57cec5SDimitry Andric std::vector<SectionPattern> ScriptParser::readInputSectionsList() {
6280b57cec5SDimitry Andric   std::vector<SectionPattern> ret;
6290b57cec5SDimitry Andric   while (!errorCount() && peek() != ")") {
6300b57cec5SDimitry Andric     StringMatcher excludeFilePat;
6310b57cec5SDimitry Andric     if (consume("EXCLUDE_FILE")) {
6320b57cec5SDimitry Andric       expect("(");
6330b57cec5SDimitry Andric       excludeFilePat = readFilePatterns();
6340b57cec5SDimitry Andric     }
6350b57cec5SDimitry Andric 
6360b57cec5SDimitry Andric     std::vector<StringRef> v;
6370b57cec5SDimitry Andric     while (!errorCount() && peek() != ")" && peek() != "EXCLUDE_FILE")
6380b57cec5SDimitry Andric       v.push_back(unquote(next()));
6390b57cec5SDimitry Andric 
6400b57cec5SDimitry Andric     if (!v.empty())
6410b57cec5SDimitry Andric       ret.push_back({std::move(excludeFilePat), StringMatcher(v)});
6420b57cec5SDimitry Andric     else
6430b57cec5SDimitry Andric       setError("section pattern is expected");
6440b57cec5SDimitry Andric   }
6450b57cec5SDimitry Andric   return ret;
6460b57cec5SDimitry Andric }
6470b57cec5SDimitry Andric 
6480b57cec5SDimitry Andric // Reads contents of "SECTIONS" directive. That directive contains a
6490b57cec5SDimitry Andric // list of glob patterns for input sections. The grammar is as follows.
6500b57cec5SDimitry Andric //
6510b57cec5SDimitry Andric // <patterns> ::= <section-list>
6520b57cec5SDimitry Andric //              | <sort> "(" <section-list> ")"
6530b57cec5SDimitry Andric //              | <sort> "(" <sort> "(" <section-list> ")" ")"
6540b57cec5SDimitry Andric //
6550b57cec5SDimitry Andric // <sort>     ::= "SORT" | "SORT_BY_NAME" | "SORT_BY_ALIGNMENT"
6560b57cec5SDimitry Andric //              | "SORT_BY_INIT_PRIORITY" | "SORT_NONE"
6570b57cec5SDimitry Andric //
6580b57cec5SDimitry Andric // <section-list> is parsed by readInputSectionsList().
6590b57cec5SDimitry Andric InputSectionDescription *
6600b57cec5SDimitry Andric ScriptParser::readInputSectionRules(StringRef filePattern) {
6610b57cec5SDimitry Andric   auto *cmd = make<InputSectionDescription>(filePattern);
6620b57cec5SDimitry Andric   expect("(");
6630b57cec5SDimitry Andric 
6640b57cec5SDimitry Andric   while (!errorCount() && !consume(")")) {
6650b57cec5SDimitry Andric     SortSectionPolicy outer = readSortKind();
6660b57cec5SDimitry Andric     SortSectionPolicy inner = SortSectionPolicy::Default;
6670b57cec5SDimitry Andric     std::vector<SectionPattern> v;
6680b57cec5SDimitry Andric     if (outer != SortSectionPolicy::Default) {
6690b57cec5SDimitry Andric       expect("(");
6700b57cec5SDimitry Andric       inner = readSortKind();
6710b57cec5SDimitry Andric       if (inner != SortSectionPolicy::Default) {
6720b57cec5SDimitry Andric         expect("(");
6730b57cec5SDimitry Andric         v = readInputSectionsList();
6740b57cec5SDimitry Andric         expect(")");
6750b57cec5SDimitry Andric       } else {
6760b57cec5SDimitry Andric         v = readInputSectionsList();
6770b57cec5SDimitry Andric       }
6780b57cec5SDimitry Andric       expect(")");
6790b57cec5SDimitry Andric     } else {
6800b57cec5SDimitry Andric       v = readInputSectionsList();
6810b57cec5SDimitry Andric     }
6820b57cec5SDimitry Andric 
6830b57cec5SDimitry Andric     for (SectionPattern &pat : v) {
6840b57cec5SDimitry Andric       pat.sortInner = inner;
6850b57cec5SDimitry Andric       pat.sortOuter = outer;
6860b57cec5SDimitry Andric     }
6870b57cec5SDimitry Andric 
6880b57cec5SDimitry Andric     std::move(v.begin(), v.end(), std::back_inserter(cmd->sectionPatterns));
6890b57cec5SDimitry Andric   }
6900b57cec5SDimitry Andric   return cmd;
6910b57cec5SDimitry Andric }
6920b57cec5SDimitry Andric 
6930b57cec5SDimitry Andric InputSectionDescription *
6940b57cec5SDimitry Andric ScriptParser::readInputSectionDescription(StringRef tok) {
6950b57cec5SDimitry Andric   // Input section wildcard can be surrounded by KEEP.
6960b57cec5SDimitry Andric   // https://sourceware.org/binutils/docs/ld/Input-Section-Keep.html#Input-Section-Keep
6970b57cec5SDimitry Andric   if (tok == "KEEP") {
6980b57cec5SDimitry Andric     expect("(");
6990b57cec5SDimitry Andric     StringRef filePattern = next();
7000b57cec5SDimitry Andric     InputSectionDescription *cmd = readInputSectionRules(filePattern);
7010b57cec5SDimitry Andric     expect(")");
7020b57cec5SDimitry Andric     script->keptSections.push_back(cmd);
7030b57cec5SDimitry Andric     return cmd;
7040b57cec5SDimitry Andric   }
7050b57cec5SDimitry Andric   return readInputSectionRules(tok);
7060b57cec5SDimitry Andric }
7070b57cec5SDimitry Andric 
7080b57cec5SDimitry Andric void ScriptParser::readSort() {
7090b57cec5SDimitry Andric   expect("(");
7100b57cec5SDimitry Andric   expect("CONSTRUCTORS");
7110b57cec5SDimitry Andric   expect(")");
7120b57cec5SDimitry Andric }
7130b57cec5SDimitry Andric 
7140b57cec5SDimitry Andric Expr ScriptParser::readAssert() {
7150b57cec5SDimitry Andric   expect("(");
7160b57cec5SDimitry Andric   Expr e = readExpr();
7170b57cec5SDimitry Andric   expect(",");
7180b57cec5SDimitry Andric   StringRef msg = unquote(next());
7190b57cec5SDimitry Andric   expect(")");
7200b57cec5SDimitry Andric 
7210b57cec5SDimitry Andric   return [=] {
7220b57cec5SDimitry Andric     if (!e().getValue())
723*85868e8aSDimitry Andric       errorOrWarn(msg);
7240b57cec5SDimitry Andric     return script->getDot();
7250b57cec5SDimitry Andric   };
7260b57cec5SDimitry Andric }
7270b57cec5SDimitry Andric 
7280b57cec5SDimitry Andric // Tries to read the special directive for an output section definition which
7290b57cec5SDimitry Andric // can be one of following: "(NOLOAD)", "(COPY)", "(INFO)" or "(OVERLAY)".
7300b57cec5SDimitry Andric // Tok1 and Tok2 are next 2 tokens peeked. See comment for readSectionAddressType below.
7310b57cec5SDimitry Andric bool ScriptParser::readSectionDirective(OutputSection *cmd, StringRef tok1, StringRef tok2) {
7320b57cec5SDimitry Andric   if (tok1 != "(")
7330b57cec5SDimitry Andric     return false;
7340b57cec5SDimitry Andric   if (tok2 != "NOLOAD" && tok2 != "COPY" && tok2 != "INFO" && tok2 != "OVERLAY")
7350b57cec5SDimitry Andric     return false;
7360b57cec5SDimitry Andric 
7370b57cec5SDimitry Andric   expect("(");
7380b57cec5SDimitry Andric   if (consume("NOLOAD")) {
7390b57cec5SDimitry Andric     cmd->noload = true;
7400b57cec5SDimitry Andric   } else {
7410b57cec5SDimitry Andric     skip(); // This is "COPY", "INFO" or "OVERLAY".
7420b57cec5SDimitry Andric     cmd->nonAlloc = true;
7430b57cec5SDimitry Andric   }
7440b57cec5SDimitry Andric   expect(")");
7450b57cec5SDimitry Andric   return true;
7460b57cec5SDimitry Andric }
7470b57cec5SDimitry Andric 
7480b57cec5SDimitry Andric // Reads an expression and/or the special directive for an output
7490b57cec5SDimitry Andric // section definition. Directive is one of following: "(NOLOAD)",
7500b57cec5SDimitry Andric // "(COPY)", "(INFO)" or "(OVERLAY)".
7510b57cec5SDimitry Andric //
7520b57cec5SDimitry Andric // An output section name can be followed by an address expression
7530b57cec5SDimitry Andric // and/or directive. This grammar is not LL(1) because "(" can be
7540b57cec5SDimitry Andric // interpreted as either the beginning of some expression or beginning
7550b57cec5SDimitry Andric // of directive.
7560b57cec5SDimitry Andric //
7570b57cec5SDimitry Andric // https://sourceware.org/binutils/docs/ld/Output-Section-Address.html
7580b57cec5SDimitry Andric // https://sourceware.org/binutils/docs/ld/Output-Section-Type.html
7590b57cec5SDimitry Andric void ScriptParser::readSectionAddressType(OutputSection *cmd) {
7600b57cec5SDimitry Andric   if (readSectionDirective(cmd, peek(), peek2()))
7610b57cec5SDimitry Andric     return;
7620b57cec5SDimitry Andric 
7630b57cec5SDimitry Andric   cmd->addrExpr = readExpr();
7640b57cec5SDimitry Andric   if (peek() == "(" && !readSectionDirective(cmd, "(", peek2()))
7650b57cec5SDimitry Andric     setError("unknown section directive: " + peek2());
7660b57cec5SDimitry Andric }
7670b57cec5SDimitry Andric 
7680b57cec5SDimitry Andric static Expr checkAlignment(Expr e, std::string &loc) {
7690b57cec5SDimitry Andric   return [=] {
7700b57cec5SDimitry Andric     uint64_t alignment = std::max((uint64_t)1, e().getValue());
7710b57cec5SDimitry Andric     if (!isPowerOf2_64(alignment)) {
7720b57cec5SDimitry Andric       error(loc + ": alignment must be power of 2");
7730b57cec5SDimitry Andric       return (uint64_t)1; // Return a dummy value.
7740b57cec5SDimitry Andric     }
7750b57cec5SDimitry Andric     return alignment;
7760b57cec5SDimitry Andric   };
7770b57cec5SDimitry Andric }
7780b57cec5SDimitry Andric 
7790b57cec5SDimitry Andric OutputSection *ScriptParser::readOverlaySectionDescription() {
7800b57cec5SDimitry Andric   OutputSection *cmd =
7810b57cec5SDimitry Andric       script->createOutputSection(next(), getCurrentLocation());
7820b57cec5SDimitry Andric   cmd->inOverlay = true;
7830b57cec5SDimitry Andric   expect("{");
7840b57cec5SDimitry Andric   while (!errorCount() && !consume("}"))
7850b57cec5SDimitry Andric     cmd->sectionCommands.push_back(readInputSectionRules(next()));
7860b57cec5SDimitry Andric   cmd->phdrs = readOutputSectionPhdrs();
7870b57cec5SDimitry Andric   return cmd;
7880b57cec5SDimitry Andric }
7890b57cec5SDimitry Andric 
7900b57cec5SDimitry Andric OutputSection *ScriptParser::readOutputSectionDescription(StringRef outSec) {
7910b57cec5SDimitry Andric   OutputSection *cmd =
7920b57cec5SDimitry Andric       script->createOutputSection(outSec, getCurrentLocation());
7930b57cec5SDimitry Andric 
7940b57cec5SDimitry Andric   size_t symbolsReferenced = script->referencedSymbols.size();
7950b57cec5SDimitry Andric 
7960b57cec5SDimitry Andric   if (peek() != ":")
7970b57cec5SDimitry Andric     readSectionAddressType(cmd);
7980b57cec5SDimitry Andric   expect(":");
7990b57cec5SDimitry Andric 
8000b57cec5SDimitry Andric   std::string location = getCurrentLocation();
8010b57cec5SDimitry Andric   if (consume("AT"))
8020b57cec5SDimitry Andric     cmd->lmaExpr = readParenExpr();
8030b57cec5SDimitry Andric   if (consume("ALIGN"))
8040b57cec5SDimitry Andric     cmd->alignExpr = checkAlignment(readParenExpr(), location);
8050b57cec5SDimitry Andric   if (consume("SUBALIGN"))
8060b57cec5SDimitry Andric     cmd->subalignExpr = checkAlignment(readParenExpr(), location);
8070b57cec5SDimitry Andric 
8080b57cec5SDimitry Andric   // Parse constraints.
8090b57cec5SDimitry Andric   if (consume("ONLY_IF_RO"))
8100b57cec5SDimitry Andric     cmd->constraint = ConstraintKind::ReadOnly;
8110b57cec5SDimitry Andric   if (consume("ONLY_IF_RW"))
8120b57cec5SDimitry Andric     cmd->constraint = ConstraintKind::ReadWrite;
8130b57cec5SDimitry Andric   expect("{");
8140b57cec5SDimitry Andric 
8150b57cec5SDimitry Andric   while (!errorCount() && !consume("}")) {
8160b57cec5SDimitry Andric     StringRef tok = next();
8170b57cec5SDimitry Andric     if (tok == ";") {
8180b57cec5SDimitry Andric       // Empty commands are allowed. Do nothing here.
8190b57cec5SDimitry Andric     } else if (SymbolAssignment *assign = readAssignment(tok)) {
8200b57cec5SDimitry Andric       cmd->sectionCommands.push_back(assign);
8210b57cec5SDimitry Andric     } else if (ByteCommand *data = readByteCommand(tok)) {
8220b57cec5SDimitry Andric       cmd->sectionCommands.push_back(data);
8230b57cec5SDimitry Andric     } else if (tok == "CONSTRUCTORS") {
8240b57cec5SDimitry Andric       // CONSTRUCTORS is a keyword to make the linker recognize C++ ctors/dtors
8250b57cec5SDimitry Andric       // by name. This is for very old file formats such as ECOFF/XCOFF.
8260b57cec5SDimitry Andric       // For ELF, we should ignore.
8270b57cec5SDimitry Andric     } else if (tok == "FILL") {
8280b57cec5SDimitry Andric       // We handle the FILL command as an alias for =fillexp section attribute,
8290b57cec5SDimitry Andric       // which is different from what GNU linkers do.
8300b57cec5SDimitry Andric       // https://sourceware.org/binutils/docs/ld/Output-Section-Data.html
8310b57cec5SDimitry Andric       expect("(");
8320b57cec5SDimitry Andric       cmd->filler = readFill();
8330b57cec5SDimitry Andric       expect(")");
8340b57cec5SDimitry Andric     } else if (tok == "SORT") {
8350b57cec5SDimitry Andric       readSort();
8360b57cec5SDimitry Andric     } else if (tok == "INCLUDE") {
8370b57cec5SDimitry Andric       readInclude();
8380b57cec5SDimitry Andric     } else if (peek() == "(") {
8390b57cec5SDimitry Andric       cmd->sectionCommands.push_back(readInputSectionDescription(tok));
8400b57cec5SDimitry Andric     } else {
8410b57cec5SDimitry Andric       // We have a file name and no input sections description. It is not a
8420b57cec5SDimitry Andric       // commonly used syntax, but still acceptable. In that case, all sections
8430b57cec5SDimitry Andric       // from the file will be included.
8440b57cec5SDimitry Andric       auto *isd = make<InputSectionDescription>(tok);
8450b57cec5SDimitry Andric       isd->sectionPatterns.push_back({{}, StringMatcher({"*"})});
8460b57cec5SDimitry Andric       cmd->sectionCommands.push_back(isd);
8470b57cec5SDimitry Andric     }
8480b57cec5SDimitry Andric   }
8490b57cec5SDimitry Andric 
8500b57cec5SDimitry Andric   if (consume(">"))
8510b57cec5SDimitry Andric     cmd->memoryRegionName = next();
8520b57cec5SDimitry Andric 
8530b57cec5SDimitry Andric   if (consume("AT")) {
8540b57cec5SDimitry Andric     expect(">");
8550b57cec5SDimitry Andric     cmd->lmaRegionName = next();
8560b57cec5SDimitry Andric   }
8570b57cec5SDimitry Andric 
8580b57cec5SDimitry Andric   if (cmd->lmaExpr && !cmd->lmaRegionName.empty())
8590b57cec5SDimitry Andric     error("section can't have both LMA and a load region");
8600b57cec5SDimitry Andric 
8610b57cec5SDimitry Andric   cmd->phdrs = readOutputSectionPhdrs();
8620b57cec5SDimitry Andric 
8630b57cec5SDimitry Andric   if (peek() == "=" || peek().startswith("=")) {
8640b57cec5SDimitry Andric     inExpr = true;
8650b57cec5SDimitry Andric     consume("=");
8660b57cec5SDimitry Andric     cmd->filler = readFill();
8670b57cec5SDimitry Andric     inExpr = false;
8680b57cec5SDimitry Andric   }
8690b57cec5SDimitry Andric 
8700b57cec5SDimitry Andric   // Consume optional comma following output section command.
8710b57cec5SDimitry Andric   consume(",");
8720b57cec5SDimitry Andric 
8730b57cec5SDimitry Andric   if (script->referencedSymbols.size() > symbolsReferenced)
8740b57cec5SDimitry Andric     cmd->expressionsUseSymbols = true;
8750b57cec5SDimitry Andric   return cmd;
8760b57cec5SDimitry Andric }
8770b57cec5SDimitry Andric 
8780b57cec5SDimitry Andric // Reads a `=<fillexp>` expression and returns its value as a big-endian number.
8790b57cec5SDimitry Andric // https://sourceware.org/binutils/docs/ld/Output-Section-Fill.html
8800b57cec5SDimitry Andric // We do not support using symbols in such expressions.
8810b57cec5SDimitry Andric //
8820b57cec5SDimitry Andric // When reading a hexstring, ld.bfd handles it as a blob of arbitrary
8830b57cec5SDimitry Andric // size, while ld.gold always handles it as a 32-bit big-endian number.
8840b57cec5SDimitry Andric // We are compatible with ld.gold because it's easier to implement.
8850b57cec5SDimitry Andric std::array<uint8_t, 4> ScriptParser::readFill() {
8860b57cec5SDimitry Andric   uint64_t value = readExpr()().val;
8870b57cec5SDimitry Andric   if (value > UINT32_MAX)
8880b57cec5SDimitry Andric     setError("filler expression result does not fit 32-bit: 0x" +
8890b57cec5SDimitry Andric              Twine::utohexstr(value));
8900b57cec5SDimitry Andric 
8910b57cec5SDimitry Andric   std::array<uint8_t, 4> buf;
8920b57cec5SDimitry Andric   write32be(buf.data(), (uint32_t)value);
8930b57cec5SDimitry Andric   return buf;
8940b57cec5SDimitry Andric }
8950b57cec5SDimitry Andric 
8960b57cec5SDimitry Andric SymbolAssignment *ScriptParser::readProvideHidden(bool provide, bool hidden) {
8970b57cec5SDimitry Andric   expect("(");
8980b57cec5SDimitry Andric   SymbolAssignment *cmd = readSymbolAssignment(next());
8990b57cec5SDimitry Andric   cmd->provide = provide;
9000b57cec5SDimitry Andric   cmd->hidden = hidden;
9010b57cec5SDimitry Andric   expect(")");
9020b57cec5SDimitry Andric   return cmd;
9030b57cec5SDimitry Andric }
9040b57cec5SDimitry Andric 
9050b57cec5SDimitry Andric SymbolAssignment *ScriptParser::readAssignment(StringRef tok) {
9060b57cec5SDimitry Andric   // Assert expression returns Dot, so this is equal to ".=."
9070b57cec5SDimitry Andric   if (tok == "ASSERT")
9080b57cec5SDimitry Andric     return make<SymbolAssignment>(".", readAssert(), getCurrentLocation());
9090b57cec5SDimitry Andric 
9100b57cec5SDimitry Andric   size_t oldPos = pos;
9110b57cec5SDimitry Andric   SymbolAssignment *cmd = nullptr;
9120b57cec5SDimitry Andric   if (peek() == "=" || peek() == "+=")
9130b57cec5SDimitry Andric     cmd = readSymbolAssignment(tok);
9140b57cec5SDimitry Andric   else if (tok == "PROVIDE")
9150b57cec5SDimitry Andric     cmd = readProvideHidden(true, false);
9160b57cec5SDimitry Andric   else if (tok == "HIDDEN")
9170b57cec5SDimitry Andric     cmd = readProvideHidden(false, true);
9180b57cec5SDimitry Andric   else if (tok == "PROVIDE_HIDDEN")
9190b57cec5SDimitry Andric     cmd = readProvideHidden(true, true);
9200b57cec5SDimitry Andric 
9210b57cec5SDimitry Andric   if (cmd) {
9220b57cec5SDimitry Andric     cmd->commandString =
9230b57cec5SDimitry Andric         tok.str() + " " +
9240b57cec5SDimitry Andric         llvm::join(tokens.begin() + oldPos, tokens.begin() + pos, " ");
9250b57cec5SDimitry Andric     expect(";");
9260b57cec5SDimitry Andric   }
9270b57cec5SDimitry Andric   return cmd;
9280b57cec5SDimitry Andric }
9290b57cec5SDimitry Andric 
9300b57cec5SDimitry Andric SymbolAssignment *ScriptParser::readSymbolAssignment(StringRef name) {
9310b57cec5SDimitry Andric   StringRef op = next();
9320b57cec5SDimitry Andric   assert(op == "=" || op == "+=");
9330b57cec5SDimitry Andric   Expr e = readExpr();
9340b57cec5SDimitry Andric   if (op == "+=") {
9350b57cec5SDimitry Andric     std::string loc = getCurrentLocation();
9360b57cec5SDimitry Andric     e = [=] { return add(script->getSymbolValue(name, loc), e()); };
9370b57cec5SDimitry Andric   }
9380b57cec5SDimitry Andric   return make<SymbolAssignment>(name, e, getCurrentLocation());
9390b57cec5SDimitry Andric }
9400b57cec5SDimitry Andric 
9410b57cec5SDimitry Andric // This is an operator-precedence parser to parse a linker
9420b57cec5SDimitry Andric // script expression.
9430b57cec5SDimitry Andric Expr ScriptParser::readExpr() {
9440b57cec5SDimitry Andric   // Our lexer is context-aware. Set the in-expression bit so that
9450b57cec5SDimitry Andric   // they apply different tokenization rules.
9460b57cec5SDimitry Andric   bool orig = inExpr;
9470b57cec5SDimitry Andric   inExpr = true;
9480b57cec5SDimitry Andric   Expr e = readExpr1(readPrimary(), 0);
9490b57cec5SDimitry Andric   inExpr = orig;
9500b57cec5SDimitry Andric   return e;
9510b57cec5SDimitry Andric }
9520b57cec5SDimitry Andric 
9530b57cec5SDimitry Andric Expr ScriptParser::combine(StringRef op, Expr l, Expr r) {
9540b57cec5SDimitry Andric   if (op == "+")
9550b57cec5SDimitry Andric     return [=] { return add(l(), r()); };
9560b57cec5SDimitry Andric   if (op == "-")
9570b57cec5SDimitry Andric     return [=] { return sub(l(), r()); };
9580b57cec5SDimitry Andric   if (op == "*")
9590b57cec5SDimitry Andric     return [=] { return l().getValue() * r().getValue(); };
9600b57cec5SDimitry Andric   if (op == "/") {
9610b57cec5SDimitry Andric     std::string loc = getCurrentLocation();
9620b57cec5SDimitry Andric     return [=]() -> uint64_t {
9630b57cec5SDimitry Andric       if (uint64_t rv = r().getValue())
9640b57cec5SDimitry Andric         return l().getValue() / rv;
9650b57cec5SDimitry Andric       error(loc + ": division by zero");
9660b57cec5SDimitry Andric       return 0;
9670b57cec5SDimitry Andric     };
9680b57cec5SDimitry Andric   }
9690b57cec5SDimitry Andric   if (op == "%") {
9700b57cec5SDimitry Andric     std::string loc = getCurrentLocation();
9710b57cec5SDimitry Andric     return [=]() -> uint64_t {
9720b57cec5SDimitry Andric       if (uint64_t rv = r().getValue())
9730b57cec5SDimitry Andric         return l().getValue() % rv;
9740b57cec5SDimitry Andric       error(loc + ": modulo by zero");
9750b57cec5SDimitry Andric       return 0;
9760b57cec5SDimitry Andric     };
9770b57cec5SDimitry Andric   }
9780b57cec5SDimitry Andric   if (op == "<<")
9790b57cec5SDimitry Andric     return [=] { return l().getValue() << r().getValue(); };
9800b57cec5SDimitry Andric   if (op == ">>")
9810b57cec5SDimitry Andric     return [=] { return l().getValue() >> r().getValue(); };
9820b57cec5SDimitry Andric   if (op == "<")
9830b57cec5SDimitry Andric     return [=] { return l().getValue() < r().getValue(); };
9840b57cec5SDimitry Andric   if (op == ">")
9850b57cec5SDimitry Andric     return [=] { return l().getValue() > r().getValue(); };
9860b57cec5SDimitry Andric   if (op == ">=")
9870b57cec5SDimitry Andric     return [=] { return l().getValue() >= r().getValue(); };
9880b57cec5SDimitry Andric   if (op == "<=")
9890b57cec5SDimitry Andric     return [=] { return l().getValue() <= r().getValue(); };
9900b57cec5SDimitry Andric   if (op == "==")
9910b57cec5SDimitry Andric     return [=] { return l().getValue() == r().getValue(); };
9920b57cec5SDimitry Andric   if (op == "!=")
9930b57cec5SDimitry Andric     return [=] { return l().getValue() != r().getValue(); };
9940b57cec5SDimitry Andric   if (op == "||")
9950b57cec5SDimitry Andric     return [=] { return l().getValue() || r().getValue(); };
9960b57cec5SDimitry Andric   if (op == "&&")
9970b57cec5SDimitry Andric     return [=] { return l().getValue() && r().getValue(); };
9980b57cec5SDimitry Andric   if (op == "&")
9990b57cec5SDimitry Andric     return [=] { return bitAnd(l(), r()); };
10000b57cec5SDimitry Andric   if (op == "|")
10010b57cec5SDimitry Andric     return [=] { return bitOr(l(), r()); };
10020b57cec5SDimitry Andric   llvm_unreachable("invalid operator");
10030b57cec5SDimitry Andric }
10040b57cec5SDimitry Andric 
10050b57cec5SDimitry Andric // This is a part of the operator-precedence parser. This function
10060b57cec5SDimitry Andric // assumes that the remaining token stream starts with an operator.
10070b57cec5SDimitry Andric Expr ScriptParser::readExpr1(Expr lhs, int minPrec) {
10080b57cec5SDimitry Andric   while (!atEOF() && !errorCount()) {
10090b57cec5SDimitry Andric     // Read an operator and an expression.
10100b57cec5SDimitry Andric     if (consume("?"))
10110b57cec5SDimitry Andric       return readTernary(lhs);
10120b57cec5SDimitry Andric     StringRef op1 = peek();
10130b57cec5SDimitry Andric     if (precedence(op1) < minPrec)
10140b57cec5SDimitry Andric       break;
10150b57cec5SDimitry Andric     skip();
10160b57cec5SDimitry Andric     Expr rhs = readPrimary();
10170b57cec5SDimitry Andric 
10180b57cec5SDimitry Andric     // Evaluate the remaining part of the expression first if the
10190b57cec5SDimitry Andric     // next operator has greater precedence than the previous one.
10200b57cec5SDimitry Andric     // For example, if we have read "+" and "3", and if the next
10210b57cec5SDimitry Andric     // operator is "*", then we'll evaluate 3 * ... part first.
10220b57cec5SDimitry Andric     while (!atEOF()) {
10230b57cec5SDimitry Andric       StringRef op2 = peek();
10240b57cec5SDimitry Andric       if (precedence(op2) <= precedence(op1))
10250b57cec5SDimitry Andric         break;
10260b57cec5SDimitry Andric       rhs = readExpr1(rhs, precedence(op2));
10270b57cec5SDimitry Andric     }
10280b57cec5SDimitry Andric 
10290b57cec5SDimitry Andric     lhs = combine(op1, lhs, rhs);
10300b57cec5SDimitry Andric   }
10310b57cec5SDimitry Andric   return lhs;
10320b57cec5SDimitry Andric }
10330b57cec5SDimitry Andric 
10340b57cec5SDimitry Andric Expr ScriptParser::getPageSize() {
10350b57cec5SDimitry Andric   std::string location = getCurrentLocation();
10360b57cec5SDimitry Andric   return [=]() -> uint64_t {
10370b57cec5SDimitry Andric     if (target)
10380b57cec5SDimitry Andric       return config->commonPageSize;
10390b57cec5SDimitry Andric     error(location + ": unable to calculate page size");
10400b57cec5SDimitry Andric     return 4096; // Return a dummy value.
10410b57cec5SDimitry Andric   };
10420b57cec5SDimitry Andric }
10430b57cec5SDimitry Andric 
10440b57cec5SDimitry Andric Expr ScriptParser::readConstant() {
10450b57cec5SDimitry Andric   StringRef s = readParenLiteral();
10460b57cec5SDimitry Andric   if (s == "COMMONPAGESIZE")
10470b57cec5SDimitry Andric     return getPageSize();
10480b57cec5SDimitry Andric   if (s == "MAXPAGESIZE")
10490b57cec5SDimitry Andric     return [] { return config->maxPageSize; };
10500b57cec5SDimitry Andric   setError("unknown constant: " + s);
10510b57cec5SDimitry Andric   return [] { return 0; };
10520b57cec5SDimitry Andric }
10530b57cec5SDimitry Andric 
10540b57cec5SDimitry Andric // Parses Tok as an integer. It recognizes hexadecimal (prefixed with
10550b57cec5SDimitry Andric // "0x" or suffixed with "H") and decimal numbers. Decimal numbers may
10560b57cec5SDimitry Andric // have "K" (Ki) or "M" (Mi) suffixes.
10570b57cec5SDimitry Andric static Optional<uint64_t> parseInt(StringRef tok) {
10580b57cec5SDimitry Andric   // Hexadecimal
10590b57cec5SDimitry Andric   uint64_t val;
10600b57cec5SDimitry Andric   if (tok.startswith_lower("0x")) {
10610b57cec5SDimitry Andric     if (!to_integer(tok.substr(2), val, 16))
10620b57cec5SDimitry Andric       return None;
10630b57cec5SDimitry Andric     return val;
10640b57cec5SDimitry Andric   }
10650b57cec5SDimitry Andric   if (tok.endswith_lower("H")) {
10660b57cec5SDimitry Andric     if (!to_integer(tok.drop_back(), val, 16))
10670b57cec5SDimitry Andric       return None;
10680b57cec5SDimitry Andric     return val;
10690b57cec5SDimitry Andric   }
10700b57cec5SDimitry Andric 
10710b57cec5SDimitry Andric   // Decimal
10720b57cec5SDimitry Andric   if (tok.endswith_lower("K")) {
10730b57cec5SDimitry Andric     if (!to_integer(tok.drop_back(), val, 10))
10740b57cec5SDimitry Andric       return None;
10750b57cec5SDimitry Andric     return val * 1024;
10760b57cec5SDimitry Andric   }
10770b57cec5SDimitry Andric   if (tok.endswith_lower("M")) {
10780b57cec5SDimitry Andric     if (!to_integer(tok.drop_back(), val, 10))
10790b57cec5SDimitry Andric       return None;
10800b57cec5SDimitry Andric     return val * 1024 * 1024;
10810b57cec5SDimitry Andric   }
10820b57cec5SDimitry Andric   if (!to_integer(tok, val, 10))
10830b57cec5SDimitry Andric     return None;
10840b57cec5SDimitry Andric   return val;
10850b57cec5SDimitry Andric }
10860b57cec5SDimitry Andric 
10870b57cec5SDimitry Andric ByteCommand *ScriptParser::readByteCommand(StringRef tok) {
10880b57cec5SDimitry Andric   int size = StringSwitch<int>(tok)
10890b57cec5SDimitry Andric                  .Case("BYTE", 1)
10900b57cec5SDimitry Andric                  .Case("SHORT", 2)
10910b57cec5SDimitry Andric                  .Case("LONG", 4)
10920b57cec5SDimitry Andric                  .Case("QUAD", 8)
10930b57cec5SDimitry Andric                  .Default(-1);
10940b57cec5SDimitry Andric   if (size == -1)
10950b57cec5SDimitry Andric     return nullptr;
10960b57cec5SDimitry Andric 
10970b57cec5SDimitry Andric   size_t oldPos = pos;
10980b57cec5SDimitry Andric   Expr e = readParenExpr();
10990b57cec5SDimitry Andric   std::string commandString =
11000b57cec5SDimitry Andric       tok.str() + " " +
11010b57cec5SDimitry Andric       llvm::join(tokens.begin() + oldPos, tokens.begin() + pos, " ");
11020b57cec5SDimitry Andric   return make<ByteCommand>(e, size, commandString);
11030b57cec5SDimitry Andric }
11040b57cec5SDimitry Andric 
11050b57cec5SDimitry Andric StringRef ScriptParser::readParenLiteral() {
11060b57cec5SDimitry Andric   expect("(");
11070b57cec5SDimitry Andric   bool orig = inExpr;
11080b57cec5SDimitry Andric   inExpr = false;
11090b57cec5SDimitry Andric   StringRef tok = next();
11100b57cec5SDimitry Andric   inExpr = orig;
11110b57cec5SDimitry Andric   expect(")");
11120b57cec5SDimitry Andric   return tok;
11130b57cec5SDimitry Andric }
11140b57cec5SDimitry Andric 
11150b57cec5SDimitry Andric static void checkIfExists(OutputSection *cmd, StringRef location) {
11160b57cec5SDimitry Andric   if (cmd->location.empty() && script->errorOnMissingSection)
11170b57cec5SDimitry Andric     error(location + ": undefined section " + cmd->name);
11180b57cec5SDimitry Andric }
11190b57cec5SDimitry Andric 
11200b57cec5SDimitry Andric Expr ScriptParser::readPrimary() {
11210b57cec5SDimitry Andric   if (peek() == "(")
11220b57cec5SDimitry Andric     return readParenExpr();
11230b57cec5SDimitry Andric 
11240b57cec5SDimitry Andric   if (consume("~")) {
11250b57cec5SDimitry Andric     Expr e = readPrimary();
11260b57cec5SDimitry Andric     return [=] { return ~e().getValue(); };
11270b57cec5SDimitry Andric   }
11280b57cec5SDimitry Andric   if (consume("!")) {
11290b57cec5SDimitry Andric     Expr e = readPrimary();
11300b57cec5SDimitry Andric     return [=] { return !e().getValue(); };
11310b57cec5SDimitry Andric   }
11320b57cec5SDimitry Andric   if (consume("-")) {
11330b57cec5SDimitry Andric     Expr e = readPrimary();
11340b57cec5SDimitry Andric     return [=] { return -e().getValue(); };
11350b57cec5SDimitry Andric   }
11360b57cec5SDimitry Andric 
11370b57cec5SDimitry Andric   StringRef tok = next();
11380b57cec5SDimitry Andric   std::string location = getCurrentLocation();
11390b57cec5SDimitry Andric 
11400b57cec5SDimitry Andric   // Built-in functions are parsed here.
11410b57cec5SDimitry Andric   // https://sourceware.org/binutils/docs/ld/Builtin-Functions.html.
11420b57cec5SDimitry Andric   if (tok == "ABSOLUTE") {
11430b57cec5SDimitry Andric     Expr inner = readParenExpr();
11440b57cec5SDimitry Andric     return [=] {
11450b57cec5SDimitry Andric       ExprValue i = inner();
11460b57cec5SDimitry Andric       i.forceAbsolute = true;
11470b57cec5SDimitry Andric       return i;
11480b57cec5SDimitry Andric     };
11490b57cec5SDimitry Andric   }
11500b57cec5SDimitry Andric   if (tok == "ADDR") {
11510b57cec5SDimitry Andric     StringRef name = readParenLiteral();
11520b57cec5SDimitry Andric     OutputSection *sec = script->getOrCreateOutputSection(name);
11530b57cec5SDimitry Andric     sec->usedInExpression = true;
11540b57cec5SDimitry Andric     return [=]() -> ExprValue {
11550b57cec5SDimitry Andric       checkIfExists(sec, location);
11560b57cec5SDimitry Andric       return {sec, false, 0, location};
11570b57cec5SDimitry Andric     };
11580b57cec5SDimitry Andric   }
11590b57cec5SDimitry Andric   if (tok == "ALIGN") {
11600b57cec5SDimitry Andric     expect("(");
11610b57cec5SDimitry Andric     Expr e = readExpr();
11620b57cec5SDimitry Andric     if (consume(")")) {
11630b57cec5SDimitry Andric       e = checkAlignment(e, location);
11640b57cec5SDimitry Andric       return [=] { return alignTo(script->getDot(), e().getValue()); };
11650b57cec5SDimitry Andric     }
11660b57cec5SDimitry Andric     expect(",");
11670b57cec5SDimitry Andric     Expr e2 = checkAlignment(readExpr(), location);
11680b57cec5SDimitry Andric     expect(")");
11690b57cec5SDimitry Andric     return [=] {
11700b57cec5SDimitry Andric       ExprValue v = e();
11710b57cec5SDimitry Andric       v.alignment = e2().getValue();
11720b57cec5SDimitry Andric       return v;
11730b57cec5SDimitry Andric     };
11740b57cec5SDimitry Andric   }
11750b57cec5SDimitry Andric   if (tok == "ALIGNOF") {
11760b57cec5SDimitry Andric     StringRef name = readParenLiteral();
11770b57cec5SDimitry Andric     OutputSection *cmd = script->getOrCreateOutputSection(name);
11780b57cec5SDimitry Andric     return [=] {
11790b57cec5SDimitry Andric       checkIfExists(cmd, location);
11800b57cec5SDimitry Andric       return cmd->alignment;
11810b57cec5SDimitry Andric     };
11820b57cec5SDimitry Andric   }
11830b57cec5SDimitry Andric   if (tok == "ASSERT")
11840b57cec5SDimitry Andric     return readAssert();
11850b57cec5SDimitry Andric   if (tok == "CONSTANT")
11860b57cec5SDimitry Andric     return readConstant();
11870b57cec5SDimitry Andric   if (tok == "DATA_SEGMENT_ALIGN") {
11880b57cec5SDimitry Andric     expect("(");
11890b57cec5SDimitry Andric     Expr e = readExpr();
11900b57cec5SDimitry Andric     expect(",");
11910b57cec5SDimitry Andric     readExpr();
11920b57cec5SDimitry Andric     expect(")");
11930b57cec5SDimitry Andric     return [=] {
11940b57cec5SDimitry Andric       return alignTo(script->getDot(), std::max((uint64_t)1, e().getValue()));
11950b57cec5SDimitry Andric     };
11960b57cec5SDimitry Andric   }
11970b57cec5SDimitry Andric   if (tok == "DATA_SEGMENT_END") {
11980b57cec5SDimitry Andric     expect("(");
11990b57cec5SDimitry Andric     expect(".");
12000b57cec5SDimitry Andric     expect(")");
12010b57cec5SDimitry Andric     return [] { return script->getDot(); };
12020b57cec5SDimitry Andric   }
12030b57cec5SDimitry Andric   if (tok == "DATA_SEGMENT_RELRO_END") {
12040b57cec5SDimitry Andric     // GNU linkers implements more complicated logic to handle
12050b57cec5SDimitry Andric     // DATA_SEGMENT_RELRO_END. We instead ignore the arguments and
12060b57cec5SDimitry Andric     // just align to the next page boundary for simplicity.
12070b57cec5SDimitry Andric     expect("(");
12080b57cec5SDimitry Andric     readExpr();
12090b57cec5SDimitry Andric     expect(",");
12100b57cec5SDimitry Andric     readExpr();
12110b57cec5SDimitry Andric     expect(")");
12120b57cec5SDimitry Andric     Expr e = getPageSize();
12130b57cec5SDimitry Andric     return [=] { return alignTo(script->getDot(), e().getValue()); };
12140b57cec5SDimitry Andric   }
12150b57cec5SDimitry Andric   if (tok == "DEFINED") {
12160b57cec5SDimitry Andric     StringRef name = readParenLiteral();
12170b57cec5SDimitry Andric     return [=] { return symtab->find(name) ? 1 : 0; };
12180b57cec5SDimitry Andric   }
12190b57cec5SDimitry Andric   if (tok == "LENGTH") {
12200b57cec5SDimitry Andric     StringRef name = readParenLiteral();
12210b57cec5SDimitry Andric     if (script->memoryRegions.count(name) == 0) {
12220b57cec5SDimitry Andric       setError("memory region not defined: " + name);
12230b57cec5SDimitry Andric       return [] { return 0; };
12240b57cec5SDimitry Andric     }
12250b57cec5SDimitry Andric     return [=] { return script->memoryRegions[name]->length; };
12260b57cec5SDimitry Andric   }
12270b57cec5SDimitry Andric   if (tok == "LOADADDR") {
12280b57cec5SDimitry Andric     StringRef name = readParenLiteral();
12290b57cec5SDimitry Andric     OutputSection *cmd = script->getOrCreateOutputSection(name);
12300b57cec5SDimitry Andric     cmd->usedInExpression = true;
12310b57cec5SDimitry Andric     return [=] {
12320b57cec5SDimitry Andric       checkIfExists(cmd, location);
12330b57cec5SDimitry Andric       return cmd->getLMA();
12340b57cec5SDimitry Andric     };
12350b57cec5SDimitry Andric   }
12360b57cec5SDimitry Andric   if (tok == "MAX" || tok == "MIN") {
12370b57cec5SDimitry Andric     expect("(");
12380b57cec5SDimitry Andric     Expr a = readExpr();
12390b57cec5SDimitry Andric     expect(",");
12400b57cec5SDimitry Andric     Expr b = readExpr();
12410b57cec5SDimitry Andric     expect(")");
12420b57cec5SDimitry Andric     if (tok == "MIN")
12430b57cec5SDimitry Andric       return [=] { return std::min(a().getValue(), b().getValue()); };
12440b57cec5SDimitry Andric     return [=] { return std::max(a().getValue(), b().getValue()); };
12450b57cec5SDimitry Andric   }
12460b57cec5SDimitry Andric   if (tok == "ORIGIN") {
12470b57cec5SDimitry Andric     StringRef name = readParenLiteral();
12480b57cec5SDimitry Andric     if (script->memoryRegions.count(name) == 0) {
12490b57cec5SDimitry Andric       setError("memory region not defined: " + name);
12500b57cec5SDimitry Andric       return [] { return 0; };
12510b57cec5SDimitry Andric     }
12520b57cec5SDimitry Andric     return [=] { return script->memoryRegions[name]->origin; };
12530b57cec5SDimitry Andric   }
12540b57cec5SDimitry Andric   if (tok == "SEGMENT_START") {
12550b57cec5SDimitry Andric     expect("(");
12560b57cec5SDimitry Andric     skip();
12570b57cec5SDimitry Andric     expect(",");
12580b57cec5SDimitry Andric     Expr e = readExpr();
12590b57cec5SDimitry Andric     expect(")");
12600b57cec5SDimitry Andric     return [=] { return e(); };
12610b57cec5SDimitry Andric   }
12620b57cec5SDimitry Andric   if (tok == "SIZEOF") {
12630b57cec5SDimitry Andric     StringRef name = readParenLiteral();
12640b57cec5SDimitry Andric     OutputSection *cmd = script->getOrCreateOutputSection(name);
12650b57cec5SDimitry Andric     // Linker script does not create an output section if its content is empty.
12660b57cec5SDimitry Andric     // We want to allow SIZEOF(.foo) where .foo is a section which happened to
12670b57cec5SDimitry Andric     // be empty.
12680b57cec5SDimitry Andric     return [=] { return cmd->size; };
12690b57cec5SDimitry Andric   }
12700b57cec5SDimitry Andric   if (tok == "SIZEOF_HEADERS")
1271*85868e8aSDimitry Andric     return [=] { return getHeaderSize(); };
12720b57cec5SDimitry Andric 
12730b57cec5SDimitry Andric   // Tok is the dot.
12740b57cec5SDimitry Andric   if (tok == ".")
12750b57cec5SDimitry Andric     return [=] { return script->getSymbolValue(tok, location); };
12760b57cec5SDimitry Andric 
12770b57cec5SDimitry Andric   // Tok is a literal number.
12780b57cec5SDimitry Andric   if (Optional<uint64_t> val = parseInt(tok))
12790b57cec5SDimitry Andric     return [=] { return *val; };
12800b57cec5SDimitry Andric 
12810b57cec5SDimitry Andric   // Tok is a symbol name.
12820b57cec5SDimitry Andric   if (!isValidCIdentifier(tok))
12830b57cec5SDimitry Andric     setError("malformed number: " + tok);
12840b57cec5SDimitry Andric   script->referencedSymbols.push_back(tok);
12850b57cec5SDimitry Andric   return [=] { return script->getSymbolValue(tok, location); };
12860b57cec5SDimitry Andric }
12870b57cec5SDimitry Andric 
12880b57cec5SDimitry Andric Expr ScriptParser::readTernary(Expr cond) {
12890b57cec5SDimitry Andric   Expr l = readExpr();
12900b57cec5SDimitry Andric   expect(":");
12910b57cec5SDimitry Andric   Expr r = readExpr();
12920b57cec5SDimitry Andric   return [=] { return cond().getValue() ? l() : r(); };
12930b57cec5SDimitry Andric }
12940b57cec5SDimitry Andric 
12950b57cec5SDimitry Andric Expr ScriptParser::readParenExpr() {
12960b57cec5SDimitry Andric   expect("(");
12970b57cec5SDimitry Andric   Expr e = readExpr();
12980b57cec5SDimitry Andric   expect(")");
12990b57cec5SDimitry Andric   return e;
13000b57cec5SDimitry Andric }
13010b57cec5SDimitry Andric 
13020b57cec5SDimitry Andric std::vector<StringRef> ScriptParser::readOutputSectionPhdrs() {
13030b57cec5SDimitry Andric   std::vector<StringRef> phdrs;
13040b57cec5SDimitry Andric   while (!errorCount() && peek().startswith(":")) {
13050b57cec5SDimitry Andric     StringRef tok = next();
13060b57cec5SDimitry Andric     phdrs.push_back((tok.size() == 1) ? next() : tok.substr(1));
13070b57cec5SDimitry Andric   }
13080b57cec5SDimitry Andric   return phdrs;
13090b57cec5SDimitry Andric }
13100b57cec5SDimitry Andric 
13110b57cec5SDimitry Andric // Read a program header type name. The next token must be a
13120b57cec5SDimitry Andric // name of a program header type or a constant (e.g. "0x3").
13130b57cec5SDimitry Andric unsigned ScriptParser::readPhdrType() {
13140b57cec5SDimitry Andric   StringRef tok = next();
13150b57cec5SDimitry Andric   if (Optional<uint64_t> val = parseInt(tok))
13160b57cec5SDimitry Andric     return *val;
13170b57cec5SDimitry Andric 
13180b57cec5SDimitry Andric   unsigned ret = StringSwitch<unsigned>(tok)
13190b57cec5SDimitry Andric                      .Case("PT_NULL", PT_NULL)
13200b57cec5SDimitry Andric                      .Case("PT_LOAD", PT_LOAD)
13210b57cec5SDimitry Andric                      .Case("PT_DYNAMIC", PT_DYNAMIC)
13220b57cec5SDimitry Andric                      .Case("PT_INTERP", PT_INTERP)
13230b57cec5SDimitry Andric                      .Case("PT_NOTE", PT_NOTE)
13240b57cec5SDimitry Andric                      .Case("PT_SHLIB", PT_SHLIB)
13250b57cec5SDimitry Andric                      .Case("PT_PHDR", PT_PHDR)
13260b57cec5SDimitry Andric                      .Case("PT_TLS", PT_TLS)
13270b57cec5SDimitry Andric                      .Case("PT_GNU_EH_FRAME", PT_GNU_EH_FRAME)
13280b57cec5SDimitry Andric                      .Case("PT_GNU_STACK", PT_GNU_STACK)
13290b57cec5SDimitry Andric                      .Case("PT_GNU_RELRO", PT_GNU_RELRO)
13300b57cec5SDimitry Andric                      .Case("PT_OPENBSD_RANDOMIZE", PT_OPENBSD_RANDOMIZE)
13310b57cec5SDimitry Andric                      .Case("PT_OPENBSD_WXNEEDED", PT_OPENBSD_WXNEEDED)
13320b57cec5SDimitry Andric                      .Case("PT_OPENBSD_BOOTDATA", PT_OPENBSD_BOOTDATA)
13330b57cec5SDimitry Andric                      .Default(-1);
13340b57cec5SDimitry Andric 
13350b57cec5SDimitry Andric   if (ret == (unsigned)-1) {
13360b57cec5SDimitry Andric     setError("invalid program header type: " + tok);
13370b57cec5SDimitry Andric     return PT_NULL;
13380b57cec5SDimitry Andric   }
13390b57cec5SDimitry Andric   return ret;
13400b57cec5SDimitry Andric }
13410b57cec5SDimitry Andric 
13420b57cec5SDimitry Andric // Reads an anonymous version declaration.
13430b57cec5SDimitry Andric void ScriptParser::readAnonymousDeclaration() {
13440b57cec5SDimitry Andric   std::vector<SymbolVersion> locals;
13450b57cec5SDimitry Andric   std::vector<SymbolVersion> globals;
13460b57cec5SDimitry Andric   std::tie(locals, globals) = readSymbols();
1347*85868e8aSDimitry Andric   for (const SymbolVersion &pat : locals)
1348*85868e8aSDimitry Andric     config->versionDefinitions[VER_NDX_LOCAL].patterns.push_back(pat);
1349*85868e8aSDimitry Andric   for (const SymbolVersion &pat : globals)
1350*85868e8aSDimitry Andric     config->versionDefinitions[VER_NDX_GLOBAL].patterns.push_back(pat);
13510b57cec5SDimitry Andric 
13520b57cec5SDimitry Andric   expect(";");
13530b57cec5SDimitry Andric }
13540b57cec5SDimitry Andric 
13550b57cec5SDimitry Andric // Reads a non-anonymous version definition,
13560b57cec5SDimitry Andric // e.g. "VerStr { global: foo; bar; local: *; };".
13570b57cec5SDimitry Andric void ScriptParser::readVersionDeclaration(StringRef verStr) {
13580b57cec5SDimitry Andric   // Read a symbol list.
13590b57cec5SDimitry Andric   std::vector<SymbolVersion> locals;
13600b57cec5SDimitry Andric   std::vector<SymbolVersion> globals;
13610b57cec5SDimitry Andric   std::tie(locals, globals) = readSymbols();
1362*85868e8aSDimitry Andric   for (const SymbolVersion &pat : locals)
1363*85868e8aSDimitry Andric     config->versionDefinitions[VER_NDX_LOCAL].patterns.push_back(pat);
13640b57cec5SDimitry Andric 
13650b57cec5SDimitry Andric   // Create a new version definition and add that to the global symbols.
13660b57cec5SDimitry Andric   VersionDefinition ver;
13670b57cec5SDimitry Andric   ver.name = verStr;
1368*85868e8aSDimitry Andric   ver.patterns = globals;
1369*85868e8aSDimitry Andric   ver.id = config->versionDefinitions.size();
13700b57cec5SDimitry Andric   config->versionDefinitions.push_back(ver);
13710b57cec5SDimitry Andric 
13720b57cec5SDimitry Andric   // Each version may have a parent version. For example, "Ver2"
13730b57cec5SDimitry Andric   // defined as "Ver2 { global: foo; local: *; } Ver1;" has "Ver1"
13740b57cec5SDimitry Andric   // as a parent. This version hierarchy is, probably against your
13750b57cec5SDimitry Andric   // instinct, purely for hint; the runtime doesn't care about it
13760b57cec5SDimitry Andric   // at all. In LLD, we simply ignore it.
13770b57cec5SDimitry Andric   if (peek() != ";")
13780b57cec5SDimitry Andric     skip();
13790b57cec5SDimitry Andric   expect(";");
13800b57cec5SDimitry Andric }
13810b57cec5SDimitry Andric 
13820b57cec5SDimitry Andric static bool hasWildcard(StringRef s) {
13830b57cec5SDimitry Andric   return s.find_first_of("?*[") != StringRef::npos;
13840b57cec5SDimitry Andric }
13850b57cec5SDimitry Andric 
13860b57cec5SDimitry Andric // Reads a list of symbols, e.g. "{ global: foo; bar; local: *; };".
13870b57cec5SDimitry Andric std::pair<std::vector<SymbolVersion>, std::vector<SymbolVersion>>
13880b57cec5SDimitry Andric ScriptParser::readSymbols() {
13890b57cec5SDimitry Andric   std::vector<SymbolVersion> locals;
13900b57cec5SDimitry Andric   std::vector<SymbolVersion> globals;
13910b57cec5SDimitry Andric   std::vector<SymbolVersion> *v = &globals;
13920b57cec5SDimitry Andric 
13930b57cec5SDimitry Andric   while (!errorCount()) {
13940b57cec5SDimitry Andric     if (consume("}"))
13950b57cec5SDimitry Andric       break;
13960b57cec5SDimitry Andric     if (consumeLabel("local")) {
13970b57cec5SDimitry Andric       v = &locals;
13980b57cec5SDimitry Andric       continue;
13990b57cec5SDimitry Andric     }
14000b57cec5SDimitry Andric     if (consumeLabel("global")) {
14010b57cec5SDimitry Andric       v = &globals;
14020b57cec5SDimitry Andric       continue;
14030b57cec5SDimitry Andric     }
14040b57cec5SDimitry Andric 
14050b57cec5SDimitry Andric     if (consume("extern")) {
14060b57cec5SDimitry Andric       std::vector<SymbolVersion> ext = readVersionExtern();
14070b57cec5SDimitry Andric       v->insert(v->end(), ext.begin(), ext.end());
14080b57cec5SDimitry Andric     } else {
14090b57cec5SDimitry Andric       StringRef tok = next();
14100b57cec5SDimitry Andric       v->push_back({unquote(tok), false, hasWildcard(tok)});
14110b57cec5SDimitry Andric     }
14120b57cec5SDimitry Andric     expect(";");
14130b57cec5SDimitry Andric   }
14140b57cec5SDimitry Andric   return {locals, globals};
14150b57cec5SDimitry Andric }
14160b57cec5SDimitry Andric 
14170b57cec5SDimitry Andric // Reads an "extern C++" directive, e.g.,
14180b57cec5SDimitry Andric // "extern "C++" { ns::*; "f(int, double)"; };"
14190b57cec5SDimitry Andric //
14200b57cec5SDimitry Andric // The last semicolon is optional. E.g. this is OK:
14210b57cec5SDimitry Andric // "extern "C++" { ns::*; "f(int, double)" };"
14220b57cec5SDimitry Andric std::vector<SymbolVersion> ScriptParser::readVersionExtern() {
14230b57cec5SDimitry Andric   StringRef tok = next();
14240b57cec5SDimitry Andric   bool isCXX = tok == "\"C++\"";
14250b57cec5SDimitry Andric   if (!isCXX && tok != "\"C\"")
14260b57cec5SDimitry Andric     setError("Unknown language");
14270b57cec5SDimitry Andric   expect("{");
14280b57cec5SDimitry Andric 
14290b57cec5SDimitry Andric   std::vector<SymbolVersion> ret;
14300b57cec5SDimitry Andric   while (!errorCount() && peek() != "}") {
14310b57cec5SDimitry Andric     StringRef tok = next();
14320b57cec5SDimitry Andric     ret.push_back(
14330b57cec5SDimitry Andric         {unquote(tok), isCXX, !tok.startswith("\"") && hasWildcard(tok)});
14340b57cec5SDimitry Andric     if (consume("}"))
14350b57cec5SDimitry Andric       return ret;
14360b57cec5SDimitry Andric     expect(";");
14370b57cec5SDimitry Andric   }
14380b57cec5SDimitry Andric 
14390b57cec5SDimitry Andric   expect("}");
14400b57cec5SDimitry Andric   return ret;
14410b57cec5SDimitry Andric }
14420b57cec5SDimitry Andric 
14430b57cec5SDimitry Andric uint64_t ScriptParser::readMemoryAssignment(StringRef s1, StringRef s2,
14440b57cec5SDimitry Andric                                             StringRef s3) {
14450b57cec5SDimitry Andric   if (!consume(s1) && !consume(s2) && !consume(s3)) {
14460b57cec5SDimitry Andric     setError("expected one of: " + s1 + ", " + s2 + ", or " + s3);
14470b57cec5SDimitry Andric     return 0;
14480b57cec5SDimitry Andric   }
14490b57cec5SDimitry Andric   expect("=");
14500b57cec5SDimitry Andric   return readExpr()().getValue();
14510b57cec5SDimitry Andric }
14520b57cec5SDimitry Andric 
14530b57cec5SDimitry Andric // Parse the MEMORY command as specified in:
14540b57cec5SDimitry Andric // https://sourceware.org/binutils/docs/ld/MEMORY.html
14550b57cec5SDimitry Andric //
14560b57cec5SDimitry Andric // MEMORY { name [(attr)] : ORIGIN = origin, LENGTH = len ... }
14570b57cec5SDimitry Andric void ScriptParser::readMemory() {
14580b57cec5SDimitry Andric   expect("{");
14590b57cec5SDimitry Andric   while (!errorCount() && !consume("}")) {
14600b57cec5SDimitry Andric     StringRef tok = next();
14610b57cec5SDimitry Andric     if (tok == "INCLUDE") {
14620b57cec5SDimitry Andric       readInclude();
14630b57cec5SDimitry Andric       continue;
14640b57cec5SDimitry Andric     }
14650b57cec5SDimitry Andric 
14660b57cec5SDimitry Andric     uint32_t flags = 0;
14670b57cec5SDimitry Andric     uint32_t negFlags = 0;
14680b57cec5SDimitry Andric     if (consume("(")) {
14690b57cec5SDimitry Andric       std::tie(flags, negFlags) = readMemoryAttributes();
14700b57cec5SDimitry Andric       expect(")");
14710b57cec5SDimitry Andric     }
14720b57cec5SDimitry Andric     expect(":");
14730b57cec5SDimitry Andric 
14740b57cec5SDimitry Andric     uint64_t origin = readMemoryAssignment("ORIGIN", "org", "o");
14750b57cec5SDimitry Andric     expect(",");
14760b57cec5SDimitry Andric     uint64_t length = readMemoryAssignment("LENGTH", "len", "l");
14770b57cec5SDimitry Andric 
14780b57cec5SDimitry Andric     // Add the memory region to the region map.
14790b57cec5SDimitry Andric     MemoryRegion *mr = make<MemoryRegion>(tok, origin, length, flags, negFlags);
14800b57cec5SDimitry Andric     if (!script->memoryRegions.insert({tok, mr}).second)
14810b57cec5SDimitry Andric       setError("region '" + tok + "' already defined");
14820b57cec5SDimitry Andric   }
14830b57cec5SDimitry Andric }
14840b57cec5SDimitry Andric 
14850b57cec5SDimitry Andric // This function parses the attributes used to match against section
14860b57cec5SDimitry Andric // flags when placing output sections in a memory region. These flags
14870b57cec5SDimitry Andric // are only used when an explicit memory region name is not used.
14880b57cec5SDimitry Andric std::pair<uint32_t, uint32_t> ScriptParser::readMemoryAttributes() {
14890b57cec5SDimitry Andric   uint32_t flags = 0;
14900b57cec5SDimitry Andric   uint32_t negFlags = 0;
14910b57cec5SDimitry Andric   bool invert = false;
14920b57cec5SDimitry Andric 
14930b57cec5SDimitry Andric   for (char c : next().lower()) {
14940b57cec5SDimitry Andric     uint32_t flag = 0;
14950b57cec5SDimitry Andric     if (c == '!')
14960b57cec5SDimitry Andric       invert = !invert;
14970b57cec5SDimitry Andric     else if (c == 'w')
14980b57cec5SDimitry Andric       flag = SHF_WRITE;
14990b57cec5SDimitry Andric     else if (c == 'x')
15000b57cec5SDimitry Andric       flag = SHF_EXECINSTR;
15010b57cec5SDimitry Andric     else if (c == 'a')
15020b57cec5SDimitry Andric       flag = SHF_ALLOC;
15030b57cec5SDimitry Andric     else if (c != 'r')
15040b57cec5SDimitry Andric       setError("invalid memory region attribute");
15050b57cec5SDimitry Andric 
15060b57cec5SDimitry Andric     if (invert)
15070b57cec5SDimitry Andric       negFlags |= flag;
15080b57cec5SDimitry Andric     else
15090b57cec5SDimitry Andric       flags |= flag;
15100b57cec5SDimitry Andric   }
15110b57cec5SDimitry Andric   return {flags, negFlags};
15120b57cec5SDimitry Andric }
15130b57cec5SDimitry Andric 
1514*85868e8aSDimitry Andric void readLinkerScript(MemoryBufferRef mb) {
15150b57cec5SDimitry Andric   ScriptParser(mb).readLinkerScript();
15160b57cec5SDimitry Andric }
15170b57cec5SDimitry Andric 
1518*85868e8aSDimitry Andric void readVersionScript(MemoryBufferRef mb) {
15190b57cec5SDimitry Andric   ScriptParser(mb).readVersionScript();
15200b57cec5SDimitry Andric }
15210b57cec5SDimitry Andric 
1522*85868e8aSDimitry Andric void readDynamicList(MemoryBufferRef mb) { ScriptParser(mb).readDynamicList(); }
15230b57cec5SDimitry Andric 
1524*85868e8aSDimitry Andric void readDefsym(StringRef name, MemoryBufferRef mb) {
15250b57cec5SDimitry Andric   ScriptParser(mb).readDefsym(name);
15260b57cec5SDimitry Andric }
1527*85868e8aSDimitry Andric 
1528*85868e8aSDimitry Andric } // namespace elf
1529*85868e8aSDimitry Andric } // namespace lld
1530