xref: /freebsd/contrib/llvm-project/lld/ELF/ScriptParser.cpp (revision 0b57cec536236d46e3dba9bd041533462f33dbb7)
1*0b57cec5SDimitry Andric //===- ScriptParser.cpp ---------------------------------------------------===//
2*0b57cec5SDimitry Andric //
3*0b57cec5SDimitry Andric // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4*0b57cec5SDimitry Andric // See https://llvm.org/LICENSE.txt for license information.
5*0b57cec5SDimitry Andric // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
6*0b57cec5SDimitry Andric //
7*0b57cec5SDimitry Andric //===----------------------------------------------------------------------===//
8*0b57cec5SDimitry Andric //
9*0b57cec5SDimitry Andric // This file contains a recursive-descendent parser for linker scripts.
10*0b57cec5SDimitry Andric // Parsed results are stored to Config and Script global objects.
11*0b57cec5SDimitry Andric //
12*0b57cec5SDimitry Andric //===----------------------------------------------------------------------===//
13*0b57cec5SDimitry Andric 
14*0b57cec5SDimitry Andric #include "ScriptParser.h"
15*0b57cec5SDimitry Andric #include "Config.h"
16*0b57cec5SDimitry Andric #include "Driver.h"
17*0b57cec5SDimitry Andric #include "InputSection.h"
18*0b57cec5SDimitry Andric #include "LinkerScript.h"
19*0b57cec5SDimitry Andric #include "OutputSections.h"
20*0b57cec5SDimitry Andric #include "ScriptLexer.h"
21*0b57cec5SDimitry Andric #include "Symbols.h"
22*0b57cec5SDimitry Andric #include "Target.h"
23*0b57cec5SDimitry Andric #include "lld/Common/Memory.h"
24*0b57cec5SDimitry Andric #include "llvm/ADT/SmallString.h"
25*0b57cec5SDimitry Andric #include "llvm/ADT/StringRef.h"
26*0b57cec5SDimitry Andric #include "llvm/ADT/StringSet.h"
27*0b57cec5SDimitry Andric #include "llvm/ADT/StringSwitch.h"
28*0b57cec5SDimitry Andric #include "llvm/BinaryFormat/ELF.h"
29*0b57cec5SDimitry Andric #include "llvm/Support/Casting.h"
30*0b57cec5SDimitry Andric #include "llvm/Support/ErrorHandling.h"
31*0b57cec5SDimitry Andric #include "llvm/Support/FileSystem.h"
32*0b57cec5SDimitry Andric #include "llvm/Support/Path.h"
33*0b57cec5SDimitry Andric #include <cassert>
34*0b57cec5SDimitry Andric #include <limits>
35*0b57cec5SDimitry Andric #include <vector>
36*0b57cec5SDimitry Andric 
37*0b57cec5SDimitry Andric using namespace llvm;
38*0b57cec5SDimitry Andric using namespace llvm::ELF;
39*0b57cec5SDimitry Andric using namespace llvm::support::endian;
40*0b57cec5SDimitry Andric using namespace lld;
41*0b57cec5SDimitry Andric using namespace lld::elf;
42*0b57cec5SDimitry Andric 
43*0b57cec5SDimitry Andric namespace {
44*0b57cec5SDimitry Andric class ScriptParser final : ScriptLexer {
45*0b57cec5SDimitry Andric public:
46*0b57cec5SDimitry Andric   ScriptParser(MemoryBufferRef mb) : ScriptLexer(mb) {
47*0b57cec5SDimitry Andric     // Initialize IsUnderSysroot
48*0b57cec5SDimitry Andric     if (config->sysroot == "")
49*0b57cec5SDimitry Andric       return;
50*0b57cec5SDimitry Andric     StringRef path = mb.getBufferIdentifier();
51*0b57cec5SDimitry Andric     for (; !path.empty(); path = sys::path::parent_path(path)) {
52*0b57cec5SDimitry Andric       if (!sys::fs::equivalent(config->sysroot, path))
53*0b57cec5SDimitry Andric         continue;
54*0b57cec5SDimitry Andric       isUnderSysroot = true;
55*0b57cec5SDimitry Andric       return;
56*0b57cec5SDimitry Andric     }
57*0b57cec5SDimitry Andric   }
58*0b57cec5SDimitry Andric 
59*0b57cec5SDimitry Andric   void readLinkerScript();
60*0b57cec5SDimitry Andric   void readVersionScript();
61*0b57cec5SDimitry Andric   void readDynamicList();
62*0b57cec5SDimitry Andric   void readDefsym(StringRef name);
63*0b57cec5SDimitry Andric 
64*0b57cec5SDimitry Andric private:
65*0b57cec5SDimitry Andric   void addFile(StringRef path);
66*0b57cec5SDimitry Andric 
67*0b57cec5SDimitry Andric   void readAsNeeded();
68*0b57cec5SDimitry Andric   void readEntry();
69*0b57cec5SDimitry Andric   void readExtern();
70*0b57cec5SDimitry Andric   void readGroup();
71*0b57cec5SDimitry Andric   void readInclude();
72*0b57cec5SDimitry Andric   void readInput();
73*0b57cec5SDimitry Andric   void readMemory();
74*0b57cec5SDimitry Andric   void readOutput();
75*0b57cec5SDimitry Andric   void readOutputArch();
76*0b57cec5SDimitry Andric   void readOutputFormat();
77*0b57cec5SDimitry Andric   void readPhdrs();
78*0b57cec5SDimitry Andric   void readRegionAlias();
79*0b57cec5SDimitry Andric   void readSearchDir();
80*0b57cec5SDimitry Andric   void readSections();
81*0b57cec5SDimitry Andric   void readTarget();
82*0b57cec5SDimitry Andric   void readVersion();
83*0b57cec5SDimitry Andric   void readVersionScriptCommand();
84*0b57cec5SDimitry Andric 
85*0b57cec5SDimitry Andric   SymbolAssignment *readSymbolAssignment(StringRef name);
86*0b57cec5SDimitry Andric   ByteCommand *readByteCommand(StringRef tok);
87*0b57cec5SDimitry Andric   std::array<uint8_t, 4> readFill();
88*0b57cec5SDimitry Andric   bool readSectionDirective(OutputSection *cmd, StringRef tok1, StringRef tok2);
89*0b57cec5SDimitry Andric   void readSectionAddressType(OutputSection *cmd);
90*0b57cec5SDimitry Andric   OutputSection *readOverlaySectionDescription();
91*0b57cec5SDimitry Andric   OutputSection *readOutputSectionDescription(StringRef outSec);
92*0b57cec5SDimitry Andric   std::vector<BaseCommand *> readOverlay();
93*0b57cec5SDimitry Andric   std::vector<StringRef> readOutputSectionPhdrs();
94*0b57cec5SDimitry Andric   InputSectionDescription *readInputSectionDescription(StringRef tok);
95*0b57cec5SDimitry Andric   StringMatcher readFilePatterns();
96*0b57cec5SDimitry Andric   std::vector<SectionPattern> readInputSectionsList();
97*0b57cec5SDimitry Andric   InputSectionDescription *readInputSectionRules(StringRef filePattern);
98*0b57cec5SDimitry Andric   unsigned readPhdrType();
99*0b57cec5SDimitry Andric   SortSectionPolicy readSortKind();
100*0b57cec5SDimitry Andric   SymbolAssignment *readProvideHidden(bool provide, bool hidden);
101*0b57cec5SDimitry Andric   SymbolAssignment *readAssignment(StringRef tok);
102*0b57cec5SDimitry Andric   void readSort();
103*0b57cec5SDimitry Andric   Expr readAssert();
104*0b57cec5SDimitry Andric   Expr readConstant();
105*0b57cec5SDimitry Andric   Expr getPageSize();
106*0b57cec5SDimitry Andric 
107*0b57cec5SDimitry Andric   uint64_t readMemoryAssignment(StringRef, StringRef, StringRef);
108*0b57cec5SDimitry Andric   std::pair<uint32_t, uint32_t> readMemoryAttributes();
109*0b57cec5SDimitry Andric 
110*0b57cec5SDimitry Andric   Expr combine(StringRef op, Expr l, Expr r);
111*0b57cec5SDimitry Andric   Expr readExpr();
112*0b57cec5SDimitry Andric   Expr readExpr1(Expr lhs, int minPrec);
113*0b57cec5SDimitry Andric   StringRef readParenLiteral();
114*0b57cec5SDimitry Andric   Expr readPrimary();
115*0b57cec5SDimitry Andric   Expr readTernary(Expr cond);
116*0b57cec5SDimitry Andric   Expr readParenExpr();
117*0b57cec5SDimitry Andric 
118*0b57cec5SDimitry Andric   // For parsing version script.
119*0b57cec5SDimitry Andric   std::vector<SymbolVersion> readVersionExtern();
120*0b57cec5SDimitry Andric   void readAnonymousDeclaration();
121*0b57cec5SDimitry Andric   void readVersionDeclaration(StringRef verStr);
122*0b57cec5SDimitry Andric 
123*0b57cec5SDimitry Andric   std::pair<std::vector<SymbolVersion>, std::vector<SymbolVersion>>
124*0b57cec5SDimitry Andric   readSymbols();
125*0b57cec5SDimitry Andric 
126*0b57cec5SDimitry Andric   // True if a script being read is in a subdirectory specified by -sysroot.
127*0b57cec5SDimitry Andric   bool isUnderSysroot = false;
128*0b57cec5SDimitry Andric 
129*0b57cec5SDimitry Andric   // A set to detect an INCLUDE() cycle.
130*0b57cec5SDimitry Andric   StringSet<> seen;
131*0b57cec5SDimitry Andric };
132*0b57cec5SDimitry Andric } // namespace
133*0b57cec5SDimitry Andric 
134*0b57cec5SDimitry Andric static StringRef unquote(StringRef s) {
135*0b57cec5SDimitry Andric   if (s.startswith("\""))
136*0b57cec5SDimitry Andric     return s.substr(1, s.size() - 2);
137*0b57cec5SDimitry Andric   return s;
138*0b57cec5SDimitry Andric }
139*0b57cec5SDimitry Andric 
140*0b57cec5SDimitry Andric // Some operations only support one non absolute value. Move the
141*0b57cec5SDimitry Andric // absolute one to the right hand side for convenience.
142*0b57cec5SDimitry Andric static void moveAbsRight(ExprValue &a, ExprValue &b) {
143*0b57cec5SDimitry Andric   if (a.sec == nullptr || (a.forceAbsolute && !b.isAbsolute()))
144*0b57cec5SDimitry Andric     std::swap(a, b);
145*0b57cec5SDimitry Andric   if (!b.isAbsolute())
146*0b57cec5SDimitry Andric     error(a.loc + ": at least one side of the expression must be absolute");
147*0b57cec5SDimitry Andric }
148*0b57cec5SDimitry Andric 
149*0b57cec5SDimitry Andric static ExprValue add(ExprValue a, ExprValue b) {
150*0b57cec5SDimitry Andric   moveAbsRight(a, b);
151*0b57cec5SDimitry Andric   return {a.sec, a.forceAbsolute, a.getSectionOffset() + b.getValue(), a.loc};
152*0b57cec5SDimitry Andric }
153*0b57cec5SDimitry Andric 
154*0b57cec5SDimitry Andric static ExprValue sub(ExprValue a, ExprValue b) {
155*0b57cec5SDimitry Andric   // The distance between two symbols in sections is absolute.
156*0b57cec5SDimitry Andric   if (!a.isAbsolute() && !b.isAbsolute())
157*0b57cec5SDimitry Andric     return a.getValue() - b.getValue();
158*0b57cec5SDimitry Andric   return {a.sec, false, a.getSectionOffset() - b.getValue(), a.loc};
159*0b57cec5SDimitry Andric }
160*0b57cec5SDimitry Andric 
161*0b57cec5SDimitry Andric static ExprValue bitAnd(ExprValue a, ExprValue b) {
162*0b57cec5SDimitry Andric   moveAbsRight(a, b);
163*0b57cec5SDimitry Andric   return {a.sec, a.forceAbsolute,
164*0b57cec5SDimitry Andric           (a.getValue() & b.getValue()) - a.getSecAddr(), a.loc};
165*0b57cec5SDimitry Andric }
166*0b57cec5SDimitry Andric 
167*0b57cec5SDimitry Andric static ExprValue bitOr(ExprValue a, ExprValue b) {
168*0b57cec5SDimitry Andric   moveAbsRight(a, b);
169*0b57cec5SDimitry Andric   return {a.sec, a.forceAbsolute,
170*0b57cec5SDimitry Andric           (a.getValue() | b.getValue()) - a.getSecAddr(), a.loc};
171*0b57cec5SDimitry Andric }
172*0b57cec5SDimitry Andric 
173*0b57cec5SDimitry Andric void ScriptParser::readDynamicList() {
174*0b57cec5SDimitry Andric   config->hasDynamicList = true;
175*0b57cec5SDimitry Andric   expect("{");
176*0b57cec5SDimitry Andric   std::vector<SymbolVersion> locals;
177*0b57cec5SDimitry Andric   std::vector<SymbolVersion> globals;
178*0b57cec5SDimitry Andric   std::tie(locals, globals) = readSymbols();
179*0b57cec5SDimitry Andric   expect(";");
180*0b57cec5SDimitry Andric 
181*0b57cec5SDimitry Andric   if (!atEOF()) {
182*0b57cec5SDimitry Andric     setError("EOF expected, but got " + next());
183*0b57cec5SDimitry Andric     return;
184*0b57cec5SDimitry Andric   }
185*0b57cec5SDimitry Andric   if (!locals.empty()) {
186*0b57cec5SDimitry Andric     setError("\"local:\" scope not supported in --dynamic-list");
187*0b57cec5SDimitry Andric     return;
188*0b57cec5SDimitry Andric   }
189*0b57cec5SDimitry Andric 
190*0b57cec5SDimitry Andric   for (SymbolVersion v : globals)
191*0b57cec5SDimitry Andric     config->dynamicList.push_back(v);
192*0b57cec5SDimitry Andric }
193*0b57cec5SDimitry Andric 
194*0b57cec5SDimitry Andric void ScriptParser::readVersionScript() {
195*0b57cec5SDimitry Andric   readVersionScriptCommand();
196*0b57cec5SDimitry Andric   if (!atEOF())
197*0b57cec5SDimitry Andric     setError("EOF expected, but got " + next());
198*0b57cec5SDimitry Andric }
199*0b57cec5SDimitry Andric 
200*0b57cec5SDimitry Andric void ScriptParser::readVersionScriptCommand() {
201*0b57cec5SDimitry Andric   if (consume("{")) {
202*0b57cec5SDimitry Andric     readAnonymousDeclaration();
203*0b57cec5SDimitry Andric     return;
204*0b57cec5SDimitry Andric   }
205*0b57cec5SDimitry Andric 
206*0b57cec5SDimitry Andric   while (!atEOF() && !errorCount() && peek() != "}") {
207*0b57cec5SDimitry Andric     StringRef verStr = next();
208*0b57cec5SDimitry Andric     if (verStr == "{") {
209*0b57cec5SDimitry Andric       setError("anonymous version definition is used in "
210*0b57cec5SDimitry Andric                "combination with other version definitions");
211*0b57cec5SDimitry Andric       return;
212*0b57cec5SDimitry Andric     }
213*0b57cec5SDimitry Andric     expect("{");
214*0b57cec5SDimitry Andric     readVersionDeclaration(verStr);
215*0b57cec5SDimitry Andric   }
216*0b57cec5SDimitry Andric }
217*0b57cec5SDimitry Andric 
218*0b57cec5SDimitry Andric void ScriptParser::readVersion() {
219*0b57cec5SDimitry Andric   expect("{");
220*0b57cec5SDimitry Andric   readVersionScriptCommand();
221*0b57cec5SDimitry Andric   expect("}");
222*0b57cec5SDimitry Andric }
223*0b57cec5SDimitry Andric 
224*0b57cec5SDimitry Andric void ScriptParser::readLinkerScript() {
225*0b57cec5SDimitry Andric   while (!atEOF()) {
226*0b57cec5SDimitry Andric     StringRef tok = next();
227*0b57cec5SDimitry Andric     if (tok == ";")
228*0b57cec5SDimitry Andric       continue;
229*0b57cec5SDimitry Andric 
230*0b57cec5SDimitry Andric     if (tok == "ENTRY") {
231*0b57cec5SDimitry Andric       readEntry();
232*0b57cec5SDimitry Andric     } else if (tok == "EXTERN") {
233*0b57cec5SDimitry Andric       readExtern();
234*0b57cec5SDimitry Andric     } else if (tok == "GROUP") {
235*0b57cec5SDimitry Andric       readGroup();
236*0b57cec5SDimitry Andric     } else if (tok == "INCLUDE") {
237*0b57cec5SDimitry Andric       readInclude();
238*0b57cec5SDimitry Andric     } else if (tok == "INPUT") {
239*0b57cec5SDimitry Andric       readInput();
240*0b57cec5SDimitry Andric     } else if (tok == "MEMORY") {
241*0b57cec5SDimitry Andric       readMemory();
242*0b57cec5SDimitry Andric     } else if (tok == "OUTPUT") {
243*0b57cec5SDimitry Andric       readOutput();
244*0b57cec5SDimitry Andric     } else if (tok == "OUTPUT_ARCH") {
245*0b57cec5SDimitry Andric       readOutputArch();
246*0b57cec5SDimitry Andric     } else if (tok == "OUTPUT_FORMAT") {
247*0b57cec5SDimitry Andric       readOutputFormat();
248*0b57cec5SDimitry Andric     } else if (tok == "PHDRS") {
249*0b57cec5SDimitry Andric       readPhdrs();
250*0b57cec5SDimitry Andric     } else if (tok == "REGION_ALIAS") {
251*0b57cec5SDimitry Andric       readRegionAlias();
252*0b57cec5SDimitry Andric     } else if (tok == "SEARCH_DIR") {
253*0b57cec5SDimitry Andric       readSearchDir();
254*0b57cec5SDimitry Andric     } else if (tok == "SECTIONS") {
255*0b57cec5SDimitry Andric       readSections();
256*0b57cec5SDimitry Andric     } else if (tok == "TARGET") {
257*0b57cec5SDimitry Andric       readTarget();
258*0b57cec5SDimitry Andric     } else if (tok == "VERSION") {
259*0b57cec5SDimitry Andric       readVersion();
260*0b57cec5SDimitry Andric     } else if (SymbolAssignment *cmd = readAssignment(tok)) {
261*0b57cec5SDimitry Andric       script->sectionCommands.push_back(cmd);
262*0b57cec5SDimitry Andric     } else {
263*0b57cec5SDimitry Andric       setError("unknown directive: " + tok);
264*0b57cec5SDimitry Andric     }
265*0b57cec5SDimitry Andric   }
266*0b57cec5SDimitry Andric }
267*0b57cec5SDimitry Andric 
268*0b57cec5SDimitry Andric void ScriptParser::readDefsym(StringRef name) {
269*0b57cec5SDimitry Andric   if (errorCount())
270*0b57cec5SDimitry Andric     return;
271*0b57cec5SDimitry Andric   Expr e = readExpr();
272*0b57cec5SDimitry Andric   if (!atEOF())
273*0b57cec5SDimitry Andric     setError("EOF expected, but got " + next());
274*0b57cec5SDimitry Andric   SymbolAssignment *cmd = make<SymbolAssignment>(name, e, getCurrentLocation());
275*0b57cec5SDimitry Andric   script->sectionCommands.push_back(cmd);
276*0b57cec5SDimitry Andric }
277*0b57cec5SDimitry Andric 
278*0b57cec5SDimitry Andric void ScriptParser::addFile(StringRef s) {
279*0b57cec5SDimitry Andric   if (isUnderSysroot && s.startswith("/")) {
280*0b57cec5SDimitry Andric     SmallString<128> pathData;
281*0b57cec5SDimitry Andric     StringRef path = (config->sysroot + s).toStringRef(pathData);
282*0b57cec5SDimitry Andric     if (sys::fs::exists(path)) {
283*0b57cec5SDimitry Andric       driver->addFile(saver.save(path), /*withLOption=*/false);
284*0b57cec5SDimitry Andric       return;
285*0b57cec5SDimitry Andric     }
286*0b57cec5SDimitry Andric   }
287*0b57cec5SDimitry Andric 
288*0b57cec5SDimitry Andric   if (s.startswith("/")) {
289*0b57cec5SDimitry Andric     driver->addFile(s, /*withLOption=*/false);
290*0b57cec5SDimitry Andric   } else if (s.startswith("=")) {
291*0b57cec5SDimitry Andric     if (config->sysroot.empty())
292*0b57cec5SDimitry Andric       driver->addFile(s.substr(1), /*withLOption=*/false);
293*0b57cec5SDimitry Andric     else
294*0b57cec5SDimitry Andric       driver->addFile(saver.save(config->sysroot + "/" + s.substr(1)),
295*0b57cec5SDimitry Andric                       /*withLOption=*/false);
296*0b57cec5SDimitry Andric   } else if (s.startswith("-l")) {
297*0b57cec5SDimitry Andric     driver->addLibrary(s.substr(2));
298*0b57cec5SDimitry Andric   } else if (sys::fs::exists(s)) {
299*0b57cec5SDimitry Andric     driver->addFile(s, /*withLOption=*/false);
300*0b57cec5SDimitry Andric   } else {
301*0b57cec5SDimitry Andric     if (Optional<std::string> path = findFromSearchPaths(s))
302*0b57cec5SDimitry Andric       driver->addFile(saver.save(*path), /*withLOption=*/true);
303*0b57cec5SDimitry Andric     else
304*0b57cec5SDimitry Andric       setError("unable to find " + s);
305*0b57cec5SDimitry Andric   }
306*0b57cec5SDimitry Andric }
307*0b57cec5SDimitry Andric 
308*0b57cec5SDimitry Andric void ScriptParser::readAsNeeded() {
309*0b57cec5SDimitry Andric   expect("(");
310*0b57cec5SDimitry Andric   bool orig = config->asNeeded;
311*0b57cec5SDimitry Andric   config->asNeeded = true;
312*0b57cec5SDimitry Andric   while (!errorCount() && !consume(")"))
313*0b57cec5SDimitry Andric     addFile(unquote(next()));
314*0b57cec5SDimitry Andric   config->asNeeded = orig;
315*0b57cec5SDimitry Andric }
316*0b57cec5SDimitry Andric 
317*0b57cec5SDimitry Andric void ScriptParser::readEntry() {
318*0b57cec5SDimitry Andric   // -e <symbol> takes predecence over ENTRY(<symbol>).
319*0b57cec5SDimitry Andric   expect("(");
320*0b57cec5SDimitry Andric   StringRef tok = next();
321*0b57cec5SDimitry Andric   if (config->entry.empty())
322*0b57cec5SDimitry Andric     config->entry = tok;
323*0b57cec5SDimitry Andric   expect(")");
324*0b57cec5SDimitry Andric }
325*0b57cec5SDimitry Andric 
326*0b57cec5SDimitry Andric void ScriptParser::readExtern() {
327*0b57cec5SDimitry Andric   expect("(");
328*0b57cec5SDimitry Andric   while (!errorCount() && !consume(")"))
329*0b57cec5SDimitry Andric     config->undefined.push_back(unquote(next()));
330*0b57cec5SDimitry Andric }
331*0b57cec5SDimitry Andric 
332*0b57cec5SDimitry Andric void ScriptParser::readGroup() {
333*0b57cec5SDimitry Andric   bool orig = InputFile::isInGroup;
334*0b57cec5SDimitry Andric   InputFile::isInGroup = true;
335*0b57cec5SDimitry Andric   readInput();
336*0b57cec5SDimitry Andric   InputFile::isInGroup = orig;
337*0b57cec5SDimitry Andric   if (!orig)
338*0b57cec5SDimitry Andric     ++InputFile::nextGroupId;
339*0b57cec5SDimitry Andric }
340*0b57cec5SDimitry Andric 
341*0b57cec5SDimitry Andric void ScriptParser::readInclude() {
342*0b57cec5SDimitry Andric   StringRef tok = unquote(next());
343*0b57cec5SDimitry Andric 
344*0b57cec5SDimitry Andric   if (!seen.insert(tok).second) {
345*0b57cec5SDimitry Andric     setError("there is a cycle in linker script INCLUDEs");
346*0b57cec5SDimitry Andric     return;
347*0b57cec5SDimitry Andric   }
348*0b57cec5SDimitry Andric 
349*0b57cec5SDimitry Andric   if (Optional<std::string> path = searchScript(tok)) {
350*0b57cec5SDimitry Andric     if (Optional<MemoryBufferRef> mb = readFile(*path))
351*0b57cec5SDimitry Andric       tokenize(*mb);
352*0b57cec5SDimitry Andric     return;
353*0b57cec5SDimitry Andric   }
354*0b57cec5SDimitry Andric   setError("cannot find linker script " + tok);
355*0b57cec5SDimitry Andric }
356*0b57cec5SDimitry Andric 
357*0b57cec5SDimitry Andric void ScriptParser::readInput() {
358*0b57cec5SDimitry Andric   expect("(");
359*0b57cec5SDimitry Andric   while (!errorCount() && !consume(")")) {
360*0b57cec5SDimitry Andric     if (consume("AS_NEEDED"))
361*0b57cec5SDimitry Andric       readAsNeeded();
362*0b57cec5SDimitry Andric     else
363*0b57cec5SDimitry Andric       addFile(unquote(next()));
364*0b57cec5SDimitry Andric   }
365*0b57cec5SDimitry Andric }
366*0b57cec5SDimitry Andric 
367*0b57cec5SDimitry Andric void ScriptParser::readOutput() {
368*0b57cec5SDimitry Andric   // -o <file> takes predecence over OUTPUT(<file>).
369*0b57cec5SDimitry Andric   expect("(");
370*0b57cec5SDimitry Andric   StringRef tok = next();
371*0b57cec5SDimitry Andric   if (config->outputFile.empty())
372*0b57cec5SDimitry Andric     config->outputFile = unquote(tok);
373*0b57cec5SDimitry Andric   expect(")");
374*0b57cec5SDimitry Andric }
375*0b57cec5SDimitry Andric 
376*0b57cec5SDimitry Andric void ScriptParser::readOutputArch() {
377*0b57cec5SDimitry Andric   // OUTPUT_ARCH is ignored for now.
378*0b57cec5SDimitry Andric   expect("(");
379*0b57cec5SDimitry Andric   while (!errorCount() && !consume(")"))
380*0b57cec5SDimitry Andric     skip();
381*0b57cec5SDimitry Andric }
382*0b57cec5SDimitry Andric 
383*0b57cec5SDimitry Andric static std::pair<ELFKind, uint16_t> parseBfdName(StringRef s) {
384*0b57cec5SDimitry Andric   return StringSwitch<std::pair<ELFKind, uint16_t>>(s)
385*0b57cec5SDimitry Andric       .Case("elf32-i386", {ELF32LEKind, EM_386})
386*0b57cec5SDimitry Andric       .Case("elf32-iamcu", {ELF32LEKind, EM_IAMCU})
387*0b57cec5SDimitry Andric       .Case("elf32-littlearm", {ELF32LEKind, EM_ARM})
388*0b57cec5SDimitry Andric       .Case("elf32-x86-64", {ELF32LEKind, EM_X86_64})
389*0b57cec5SDimitry Andric       .Case("elf64-aarch64", {ELF64LEKind, EM_AARCH64})
390*0b57cec5SDimitry Andric       .Case("elf64-littleaarch64", {ELF64LEKind, EM_AARCH64})
391*0b57cec5SDimitry Andric       .Case("elf32-powerpc", {ELF32BEKind, EM_PPC})
392*0b57cec5SDimitry Andric       .Case("elf64-powerpc", {ELF64BEKind, EM_PPC64})
393*0b57cec5SDimitry Andric       .Case("elf64-powerpcle", {ELF64LEKind, EM_PPC64})
394*0b57cec5SDimitry Andric       .Case("elf64-x86-64", {ELF64LEKind, EM_X86_64})
395*0b57cec5SDimitry Andric       .Cases("elf32-tradbigmips", "elf32-bigmips", {ELF32BEKind, EM_MIPS})
396*0b57cec5SDimitry Andric       .Case("elf32-ntradbigmips", {ELF32BEKind, EM_MIPS})
397*0b57cec5SDimitry Andric       .Case("elf32-tradlittlemips", {ELF32LEKind, EM_MIPS})
398*0b57cec5SDimitry Andric       .Case("elf32-ntradlittlemips", {ELF32LEKind, EM_MIPS})
399*0b57cec5SDimitry Andric       .Case("elf64-tradbigmips", {ELF64BEKind, EM_MIPS})
400*0b57cec5SDimitry Andric       .Case("elf64-tradlittlemips", {ELF64LEKind, EM_MIPS})
401*0b57cec5SDimitry Andric       .Case("elf32-littleriscv", {ELF32LEKind, EM_RISCV})
402*0b57cec5SDimitry Andric       .Case("elf64-littleriscv", {ELF64LEKind, EM_RISCV})
403*0b57cec5SDimitry Andric       .Default({ELFNoneKind, EM_NONE});
404*0b57cec5SDimitry Andric }
405*0b57cec5SDimitry Andric 
406*0b57cec5SDimitry Andric // Parse OUTPUT_FORMAT(bfdname) or OUTPUT_FORMAT(bfdname, big, little).
407*0b57cec5SDimitry Andric // Currently we ignore big and little parameters.
408*0b57cec5SDimitry Andric void ScriptParser::readOutputFormat() {
409*0b57cec5SDimitry Andric   expect("(");
410*0b57cec5SDimitry Andric 
411*0b57cec5SDimitry Andric   StringRef name = unquote(next());
412*0b57cec5SDimitry Andric   StringRef s = name;
413*0b57cec5SDimitry Andric   if (s.consume_back("-freebsd"))
414*0b57cec5SDimitry Andric     config->osabi = ELFOSABI_FREEBSD;
415*0b57cec5SDimitry Andric 
416*0b57cec5SDimitry Andric   std::tie(config->ekind, config->emachine) = parseBfdName(s);
417*0b57cec5SDimitry Andric   if (config->emachine == EM_NONE)
418*0b57cec5SDimitry Andric     setError("unknown output format name: " + name);
419*0b57cec5SDimitry Andric   if (s == "elf32-ntradlittlemips" || s == "elf32-ntradbigmips")
420*0b57cec5SDimitry Andric     config->mipsN32Abi = true;
421*0b57cec5SDimitry Andric 
422*0b57cec5SDimitry Andric   if (consume(")"))
423*0b57cec5SDimitry Andric     return;
424*0b57cec5SDimitry Andric   expect(",");
425*0b57cec5SDimitry Andric   skip();
426*0b57cec5SDimitry Andric   expect(",");
427*0b57cec5SDimitry Andric   skip();
428*0b57cec5SDimitry Andric   expect(")");
429*0b57cec5SDimitry Andric }
430*0b57cec5SDimitry Andric 
431*0b57cec5SDimitry Andric void ScriptParser::readPhdrs() {
432*0b57cec5SDimitry Andric   expect("{");
433*0b57cec5SDimitry Andric 
434*0b57cec5SDimitry Andric   while (!errorCount() && !consume("}")) {
435*0b57cec5SDimitry Andric     PhdrsCommand cmd;
436*0b57cec5SDimitry Andric     cmd.name = next();
437*0b57cec5SDimitry Andric     cmd.type = readPhdrType();
438*0b57cec5SDimitry Andric 
439*0b57cec5SDimitry Andric     while (!errorCount() && !consume(";")) {
440*0b57cec5SDimitry Andric       if (consume("FILEHDR"))
441*0b57cec5SDimitry Andric         cmd.hasFilehdr = true;
442*0b57cec5SDimitry Andric       else if (consume("PHDRS"))
443*0b57cec5SDimitry Andric         cmd.hasPhdrs = true;
444*0b57cec5SDimitry Andric       else if (consume("AT"))
445*0b57cec5SDimitry Andric         cmd.lmaExpr = readParenExpr();
446*0b57cec5SDimitry Andric       else if (consume("FLAGS"))
447*0b57cec5SDimitry Andric         cmd.flags = readParenExpr()().getValue();
448*0b57cec5SDimitry Andric       else
449*0b57cec5SDimitry Andric         setError("unexpected header attribute: " + next());
450*0b57cec5SDimitry Andric     }
451*0b57cec5SDimitry Andric 
452*0b57cec5SDimitry Andric     script->phdrsCommands.push_back(cmd);
453*0b57cec5SDimitry Andric   }
454*0b57cec5SDimitry Andric }
455*0b57cec5SDimitry Andric 
456*0b57cec5SDimitry Andric void ScriptParser::readRegionAlias() {
457*0b57cec5SDimitry Andric   expect("(");
458*0b57cec5SDimitry Andric   StringRef alias = unquote(next());
459*0b57cec5SDimitry Andric   expect(",");
460*0b57cec5SDimitry Andric   StringRef name = next();
461*0b57cec5SDimitry Andric   expect(")");
462*0b57cec5SDimitry Andric 
463*0b57cec5SDimitry Andric   if (script->memoryRegions.count(alias))
464*0b57cec5SDimitry Andric     setError("redefinition of memory region '" + alias + "'");
465*0b57cec5SDimitry Andric   if (!script->memoryRegions.count(name))
466*0b57cec5SDimitry Andric     setError("memory region '" + name + "' is not defined");
467*0b57cec5SDimitry Andric   script->memoryRegions.insert({alias, script->memoryRegions[name]});
468*0b57cec5SDimitry Andric }
469*0b57cec5SDimitry Andric 
470*0b57cec5SDimitry Andric void ScriptParser::readSearchDir() {
471*0b57cec5SDimitry Andric   expect("(");
472*0b57cec5SDimitry Andric   StringRef tok = next();
473*0b57cec5SDimitry Andric   if (!config->nostdlib)
474*0b57cec5SDimitry Andric     config->searchPaths.push_back(unquote(tok));
475*0b57cec5SDimitry Andric   expect(")");
476*0b57cec5SDimitry Andric }
477*0b57cec5SDimitry Andric 
478*0b57cec5SDimitry Andric // This reads an overlay description. Overlays are used to describe output
479*0b57cec5SDimitry Andric // sections that use the same virtual memory range and normally would trigger
480*0b57cec5SDimitry Andric // linker's sections sanity check failures.
481*0b57cec5SDimitry Andric // https://sourceware.org/binutils/docs/ld/Overlay-Description.html#Overlay-Description
482*0b57cec5SDimitry Andric std::vector<BaseCommand *> ScriptParser::readOverlay() {
483*0b57cec5SDimitry Andric   // VA and LMA expressions are optional, though for simplicity of
484*0b57cec5SDimitry Andric   // implementation we assume they are not. That is what OVERLAY was designed
485*0b57cec5SDimitry Andric   // for first of all: to allow sections with overlapping VAs at different LMAs.
486*0b57cec5SDimitry Andric   Expr addrExpr = readExpr();
487*0b57cec5SDimitry Andric   expect(":");
488*0b57cec5SDimitry Andric   expect("AT");
489*0b57cec5SDimitry Andric   Expr lmaExpr = readParenExpr();
490*0b57cec5SDimitry Andric   expect("{");
491*0b57cec5SDimitry Andric 
492*0b57cec5SDimitry Andric   std::vector<BaseCommand *> v;
493*0b57cec5SDimitry Andric   OutputSection *prev = nullptr;
494*0b57cec5SDimitry Andric   while (!errorCount() && !consume("}")) {
495*0b57cec5SDimitry Andric     // VA is the same for all sections. The LMAs are consecutive in memory
496*0b57cec5SDimitry Andric     // starting from the base load address specified.
497*0b57cec5SDimitry Andric     OutputSection *os = readOverlaySectionDescription();
498*0b57cec5SDimitry Andric     os->addrExpr = addrExpr;
499*0b57cec5SDimitry Andric     if (prev)
500*0b57cec5SDimitry Andric       os->lmaExpr = [=] { return prev->getLMA() + prev->size; };
501*0b57cec5SDimitry Andric     else
502*0b57cec5SDimitry Andric       os->lmaExpr = lmaExpr;
503*0b57cec5SDimitry Andric     v.push_back(os);
504*0b57cec5SDimitry Andric     prev = os;
505*0b57cec5SDimitry Andric   }
506*0b57cec5SDimitry Andric 
507*0b57cec5SDimitry Andric   // According to the specification, at the end of the overlay, the location
508*0b57cec5SDimitry Andric   // counter should be equal to the overlay base address plus size of the
509*0b57cec5SDimitry Andric   // largest section seen in the overlay.
510*0b57cec5SDimitry Andric   // Here we want to create the Dot assignment command to achieve that.
511*0b57cec5SDimitry Andric   Expr moveDot = [=] {
512*0b57cec5SDimitry Andric     uint64_t max = 0;
513*0b57cec5SDimitry Andric     for (BaseCommand *cmd : v)
514*0b57cec5SDimitry Andric       max = std::max(max, cast<OutputSection>(cmd)->size);
515*0b57cec5SDimitry Andric     return addrExpr().getValue() + max;
516*0b57cec5SDimitry Andric   };
517*0b57cec5SDimitry Andric   v.push_back(make<SymbolAssignment>(".", moveDot, getCurrentLocation()));
518*0b57cec5SDimitry Andric   return v;
519*0b57cec5SDimitry Andric }
520*0b57cec5SDimitry Andric 
521*0b57cec5SDimitry Andric void ScriptParser::readSections() {
522*0b57cec5SDimitry Andric   script->hasSectionsCommand = true;
523*0b57cec5SDimitry Andric 
524*0b57cec5SDimitry Andric   // -no-rosegment is used to avoid placing read only non-executable sections in
525*0b57cec5SDimitry Andric   // their own segment. We do the same if SECTIONS command is present in linker
526*0b57cec5SDimitry Andric   // script. See comment for computeFlags().
527*0b57cec5SDimitry Andric   config->singleRoRx = true;
528*0b57cec5SDimitry Andric 
529*0b57cec5SDimitry Andric   expect("{");
530*0b57cec5SDimitry Andric   std::vector<BaseCommand *> v;
531*0b57cec5SDimitry Andric   while (!errorCount() && !consume("}")) {
532*0b57cec5SDimitry Andric     StringRef tok = next();
533*0b57cec5SDimitry Andric     if (tok == "OVERLAY") {
534*0b57cec5SDimitry Andric       for (BaseCommand *cmd : readOverlay())
535*0b57cec5SDimitry Andric         v.push_back(cmd);
536*0b57cec5SDimitry Andric       continue;
537*0b57cec5SDimitry Andric     } else if (tok == "INCLUDE") {
538*0b57cec5SDimitry Andric       readInclude();
539*0b57cec5SDimitry Andric       continue;
540*0b57cec5SDimitry Andric     }
541*0b57cec5SDimitry Andric 
542*0b57cec5SDimitry Andric     if (BaseCommand *cmd = readAssignment(tok))
543*0b57cec5SDimitry Andric       v.push_back(cmd);
544*0b57cec5SDimitry Andric     else
545*0b57cec5SDimitry Andric       v.push_back(readOutputSectionDescription(tok));
546*0b57cec5SDimitry Andric   }
547*0b57cec5SDimitry Andric 
548*0b57cec5SDimitry Andric   if (!atEOF() && consume("INSERT")) {
549*0b57cec5SDimitry Andric     std::vector<BaseCommand *> *dest = nullptr;
550*0b57cec5SDimitry Andric     if (consume("AFTER"))
551*0b57cec5SDimitry Andric       dest = &script->insertAfterCommands[next()];
552*0b57cec5SDimitry Andric     else if (consume("BEFORE"))
553*0b57cec5SDimitry Andric       dest = &script->insertBeforeCommands[next()];
554*0b57cec5SDimitry Andric     else
555*0b57cec5SDimitry Andric       setError("expected AFTER/BEFORE, but got '" + next() + "'");
556*0b57cec5SDimitry Andric     if (dest)
557*0b57cec5SDimitry Andric       dest->insert(dest->end(), v.begin(), v.end());
558*0b57cec5SDimitry Andric     return;
559*0b57cec5SDimitry Andric   }
560*0b57cec5SDimitry Andric 
561*0b57cec5SDimitry Andric   script->sectionCommands.insert(script->sectionCommands.end(), v.begin(),
562*0b57cec5SDimitry Andric                                  v.end());
563*0b57cec5SDimitry Andric }
564*0b57cec5SDimitry Andric 
565*0b57cec5SDimitry Andric void ScriptParser::readTarget() {
566*0b57cec5SDimitry Andric   // TARGET(foo) is an alias for "--format foo". Unlike GNU linkers,
567*0b57cec5SDimitry Andric   // we accept only a limited set of BFD names (i.e. "elf" or "binary")
568*0b57cec5SDimitry Andric   // for --format. We recognize only /^elf/ and "binary" in the linker
569*0b57cec5SDimitry Andric   // script as well.
570*0b57cec5SDimitry Andric   expect("(");
571*0b57cec5SDimitry Andric   StringRef tok = next();
572*0b57cec5SDimitry Andric   expect(")");
573*0b57cec5SDimitry Andric 
574*0b57cec5SDimitry Andric   if (tok.startswith("elf"))
575*0b57cec5SDimitry Andric     config->formatBinary = false;
576*0b57cec5SDimitry Andric   else if (tok == "binary")
577*0b57cec5SDimitry Andric     config->formatBinary = true;
578*0b57cec5SDimitry Andric   else
579*0b57cec5SDimitry Andric     setError("unknown target: " + tok);
580*0b57cec5SDimitry Andric }
581*0b57cec5SDimitry Andric 
582*0b57cec5SDimitry Andric static int precedence(StringRef op) {
583*0b57cec5SDimitry Andric   return StringSwitch<int>(op)
584*0b57cec5SDimitry Andric       .Cases("*", "/", "%", 8)
585*0b57cec5SDimitry Andric       .Cases("+", "-", 7)
586*0b57cec5SDimitry Andric       .Cases("<<", ">>", 6)
587*0b57cec5SDimitry Andric       .Cases("<", "<=", ">", ">=", "==", "!=", 5)
588*0b57cec5SDimitry Andric       .Case("&", 4)
589*0b57cec5SDimitry Andric       .Case("|", 3)
590*0b57cec5SDimitry Andric       .Case("&&", 2)
591*0b57cec5SDimitry Andric       .Case("||", 1)
592*0b57cec5SDimitry Andric       .Default(-1);
593*0b57cec5SDimitry Andric }
594*0b57cec5SDimitry Andric 
595*0b57cec5SDimitry Andric StringMatcher ScriptParser::readFilePatterns() {
596*0b57cec5SDimitry Andric   std::vector<StringRef> v;
597*0b57cec5SDimitry Andric   while (!errorCount() && !consume(")"))
598*0b57cec5SDimitry Andric     v.push_back(next());
599*0b57cec5SDimitry Andric   return StringMatcher(v);
600*0b57cec5SDimitry Andric }
601*0b57cec5SDimitry Andric 
602*0b57cec5SDimitry Andric SortSectionPolicy ScriptParser::readSortKind() {
603*0b57cec5SDimitry Andric   if (consume("SORT") || consume("SORT_BY_NAME"))
604*0b57cec5SDimitry Andric     return SortSectionPolicy::Name;
605*0b57cec5SDimitry Andric   if (consume("SORT_BY_ALIGNMENT"))
606*0b57cec5SDimitry Andric     return SortSectionPolicy::Alignment;
607*0b57cec5SDimitry Andric   if (consume("SORT_BY_INIT_PRIORITY"))
608*0b57cec5SDimitry Andric     return SortSectionPolicy::Priority;
609*0b57cec5SDimitry Andric   if (consume("SORT_NONE"))
610*0b57cec5SDimitry Andric     return SortSectionPolicy::None;
611*0b57cec5SDimitry Andric   return SortSectionPolicy::Default;
612*0b57cec5SDimitry Andric }
613*0b57cec5SDimitry Andric 
614*0b57cec5SDimitry Andric // Reads SECTIONS command contents in the following form:
615*0b57cec5SDimitry Andric //
616*0b57cec5SDimitry Andric // <contents> ::= <elem>*
617*0b57cec5SDimitry Andric // <elem>     ::= <exclude>? <glob-pattern>
618*0b57cec5SDimitry Andric // <exclude>  ::= "EXCLUDE_FILE" "(" <glob-pattern>+ ")"
619*0b57cec5SDimitry Andric //
620*0b57cec5SDimitry Andric // For example,
621*0b57cec5SDimitry Andric //
622*0b57cec5SDimitry Andric // *(.foo EXCLUDE_FILE (a.o) .bar EXCLUDE_FILE (b.o) .baz)
623*0b57cec5SDimitry Andric //
624*0b57cec5SDimitry Andric // is parsed as ".foo", ".bar" with "a.o", and ".baz" with "b.o".
625*0b57cec5SDimitry Andric // The semantics of that is section .foo in any file, section .bar in
626*0b57cec5SDimitry Andric // any file but a.o, and section .baz in any file but b.o.
627*0b57cec5SDimitry Andric std::vector<SectionPattern> ScriptParser::readInputSectionsList() {
628*0b57cec5SDimitry Andric   std::vector<SectionPattern> ret;
629*0b57cec5SDimitry Andric   while (!errorCount() && peek() != ")") {
630*0b57cec5SDimitry Andric     StringMatcher excludeFilePat;
631*0b57cec5SDimitry Andric     if (consume("EXCLUDE_FILE")) {
632*0b57cec5SDimitry Andric       expect("(");
633*0b57cec5SDimitry Andric       excludeFilePat = readFilePatterns();
634*0b57cec5SDimitry Andric     }
635*0b57cec5SDimitry Andric 
636*0b57cec5SDimitry Andric     std::vector<StringRef> v;
637*0b57cec5SDimitry Andric     while (!errorCount() && peek() != ")" && peek() != "EXCLUDE_FILE")
638*0b57cec5SDimitry Andric       v.push_back(unquote(next()));
639*0b57cec5SDimitry Andric 
640*0b57cec5SDimitry Andric     if (!v.empty())
641*0b57cec5SDimitry Andric       ret.push_back({std::move(excludeFilePat), StringMatcher(v)});
642*0b57cec5SDimitry Andric     else
643*0b57cec5SDimitry Andric       setError("section pattern is expected");
644*0b57cec5SDimitry Andric   }
645*0b57cec5SDimitry Andric   return ret;
646*0b57cec5SDimitry Andric }
647*0b57cec5SDimitry Andric 
648*0b57cec5SDimitry Andric // Reads contents of "SECTIONS" directive. That directive contains a
649*0b57cec5SDimitry Andric // list of glob patterns for input sections. The grammar is as follows.
650*0b57cec5SDimitry Andric //
651*0b57cec5SDimitry Andric // <patterns> ::= <section-list>
652*0b57cec5SDimitry Andric //              | <sort> "(" <section-list> ")"
653*0b57cec5SDimitry Andric //              | <sort> "(" <sort> "(" <section-list> ")" ")"
654*0b57cec5SDimitry Andric //
655*0b57cec5SDimitry Andric // <sort>     ::= "SORT" | "SORT_BY_NAME" | "SORT_BY_ALIGNMENT"
656*0b57cec5SDimitry Andric //              | "SORT_BY_INIT_PRIORITY" | "SORT_NONE"
657*0b57cec5SDimitry Andric //
658*0b57cec5SDimitry Andric // <section-list> is parsed by readInputSectionsList().
659*0b57cec5SDimitry Andric InputSectionDescription *
660*0b57cec5SDimitry Andric ScriptParser::readInputSectionRules(StringRef filePattern) {
661*0b57cec5SDimitry Andric   auto *cmd = make<InputSectionDescription>(filePattern);
662*0b57cec5SDimitry Andric   expect("(");
663*0b57cec5SDimitry Andric 
664*0b57cec5SDimitry Andric   while (!errorCount() && !consume(")")) {
665*0b57cec5SDimitry Andric     SortSectionPolicy outer = readSortKind();
666*0b57cec5SDimitry Andric     SortSectionPolicy inner = SortSectionPolicy::Default;
667*0b57cec5SDimitry Andric     std::vector<SectionPattern> v;
668*0b57cec5SDimitry Andric     if (outer != SortSectionPolicy::Default) {
669*0b57cec5SDimitry Andric       expect("(");
670*0b57cec5SDimitry Andric       inner = readSortKind();
671*0b57cec5SDimitry Andric       if (inner != SortSectionPolicy::Default) {
672*0b57cec5SDimitry Andric         expect("(");
673*0b57cec5SDimitry Andric         v = readInputSectionsList();
674*0b57cec5SDimitry Andric         expect(")");
675*0b57cec5SDimitry Andric       } else {
676*0b57cec5SDimitry Andric         v = readInputSectionsList();
677*0b57cec5SDimitry Andric       }
678*0b57cec5SDimitry Andric       expect(")");
679*0b57cec5SDimitry Andric     } else {
680*0b57cec5SDimitry Andric       v = readInputSectionsList();
681*0b57cec5SDimitry Andric     }
682*0b57cec5SDimitry Andric 
683*0b57cec5SDimitry Andric     for (SectionPattern &pat : v) {
684*0b57cec5SDimitry Andric       pat.sortInner = inner;
685*0b57cec5SDimitry Andric       pat.sortOuter = outer;
686*0b57cec5SDimitry Andric     }
687*0b57cec5SDimitry Andric 
688*0b57cec5SDimitry Andric     std::move(v.begin(), v.end(), std::back_inserter(cmd->sectionPatterns));
689*0b57cec5SDimitry Andric   }
690*0b57cec5SDimitry Andric   return cmd;
691*0b57cec5SDimitry Andric }
692*0b57cec5SDimitry Andric 
693*0b57cec5SDimitry Andric InputSectionDescription *
694*0b57cec5SDimitry Andric ScriptParser::readInputSectionDescription(StringRef tok) {
695*0b57cec5SDimitry Andric   // Input section wildcard can be surrounded by KEEP.
696*0b57cec5SDimitry Andric   // https://sourceware.org/binutils/docs/ld/Input-Section-Keep.html#Input-Section-Keep
697*0b57cec5SDimitry Andric   if (tok == "KEEP") {
698*0b57cec5SDimitry Andric     expect("(");
699*0b57cec5SDimitry Andric     StringRef filePattern = next();
700*0b57cec5SDimitry Andric     InputSectionDescription *cmd = readInputSectionRules(filePattern);
701*0b57cec5SDimitry Andric     expect(")");
702*0b57cec5SDimitry Andric     script->keptSections.push_back(cmd);
703*0b57cec5SDimitry Andric     return cmd;
704*0b57cec5SDimitry Andric   }
705*0b57cec5SDimitry Andric   return readInputSectionRules(tok);
706*0b57cec5SDimitry Andric }
707*0b57cec5SDimitry Andric 
708*0b57cec5SDimitry Andric void ScriptParser::readSort() {
709*0b57cec5SDimitry Andric   expect("(");
710*0b57cec5SDimitry Andric   expect("CONSTRUCTORS");
711*0b57cec5SDimitry Andric   expect(")");
712*0b57cec5SDimitry Andric }
713*0b57cec5SDimitry Andric 
714*0b57cec5SDimitry Andric Expr ScriptParser::readAssert() {
715*0b57cec5SDimitry Andric   expect("(");
716*0b57cec5SDimitry Andric   Expr e = readExpr();
717*0b57cec5SDimitry Andric   expect(",");
718*0b57cec5SDimitry Andric   StringRef msg = unquote(next());
719*0b57cec5SDimitry Andric   expect(")");
720*0b57cec5SDimitry Andric 
721*0b57cec5SDimitry Andric   return [=] {
722*0b57cec5SDimitry Andric     if (!e().getValue())
723*0b57cec5SDimitry Andric       error(msg);
724*0b57cec5SDimitry Andric     return script->getDot();
725*0b57cec5SDimitry Andric   };
726*0b57cec5SDimitry Andric }
727*0b57cec5SDimitry Andric 
728*0b57cec5SDimitry Andric // Tries to read the special directive for an output section definition which
729*0b57cec5SDimitry Andric // can be one of following: "(NOLOAD)", "(COPY)", "(INFO)" or "(OVERLAY)".
730*0b57cec5SDimitry Andric // Tok1 and Tok2 are next 2 tokens peeked. See comment for readSectionAddressType below.
731*0b57cec5SDimitry Andric bool ScriptParser::readSectionDirective(OutputSection *cmd, StringRef tok1, StringRef tok2) {
732*0b57cec5SDimitry Andric   if (tok1 != "(")
733*0b57cec5SDimitry Andric     return false;
734*0b57cec5SDimitry Andric   if (tok2 != "NOLOAD" && tok2 != "COPY" && tok2 != "INFO" && tok2 != "OVERLAY")
735*0b57cec5SDimitry Andric     return false;
736*0b57cec5SDimitry Andric 
737*0b57cec5SDimitry Andric   expect("(");
738*0b57cec5SDimitry Andric   if (consume("NOLOAD")) {
739*0b57cec5SDimitry Andric     cmd->noload = true;
740*0b57cec5SDimitry Andric   } else {
741*0b57cec5SDimitry Andric     skip(); // This is "COPY", "INFO" or "OVERLAY".
742*0b57cec5SDimitry Andric     cmd->nonAlloc = true;
743*0b57cec5SDimitry Andric   }
744*0b57cec5SDimitry Andric   expect(")");
745*0b57cec5SDimitry Andric   return true;
746*0b57cec5SDimitry Andric }
747*0b57cec5SDimitry Andric 
748*0b57cec5SDimitry Andric // Reads an expression and/or the special directive for an output
749*0b57cec5SDimitry Andric // section definition. Directive is one of following: "(NOLOAD)",
750*0b57cec5SDimitry Andric // "(COPY)", "(INFO)" or "(OVERLAY)".
751*0b57cec5SDimitry Andric //
752*0b57cec5SDimitry Andric // An output section name can be followed by an address expression
753*0b57cec5SDimitry Andric // and/or directive. This grammar is not LL(1) because "(" can be
754*0b57cec5SDimitry Andric // interpreted as either the beginning of some expression or beginning
755*0b57cec5SDimitry Andric // of directive.
756*0b57cec5SDimitry Andric //
757*0b57cec5SDimitry Andric // https://sourceware.org/binutils/docs/ld/Output-Section-Address.html
758*0b57cec5SDimitry Andric // https://sourceware.org/binutils/docs/ld/Output-Section-Type.html
759*0b57cec5SDimitry Andric void ScriptParser::readSectionAddressType(OutputSection *cmd) {
760*0b57cec5SDimitry Andric   if (readSectionDirective(cmd, peek(), peek2()))
761*0b57cec5SDimitry Andric     return;
762*0b57cec5SDimitry Andric 
763*0b57cec5SDimitry Andric   cmd->addrExpr = readExpr();
764*0b57cec5SDimitry Andric   if (peek() == "(" && !readSectionDirective(cmd, "(", peek2()))
765*0b57cec5SDimitry Andric     setError("unknown section directive: " + peek2());
766*0b57cec5SDimitry Andric }
767*0b57cec5SDimitry Andric 
768*0b57cec5SDimitry Andric static Expr checkAlignment(Expr e, std::string &loc) {
769*0b57cec5SDimitry Andric   return [=] {
770*0b57cec5SDimitry Andric     uint64_t alignment = std::max((uint64_t)1, e().getValue());
771*0b57cec5SDimitry Andric     if (!isPowerOf2_64(alignment)) {
772*0b57cec5SDimitry Andric       error(loc + ": alignment must be power of 2");
773*0b57cec5SDimitry Andric       return (uint64_t)1; // Return a dummy value.
774*0b57cec5SDimitry Andric     }
775*0b57cec5SDimitry Andric     return alignment;
776*0b57cec5SDimitry Andric   };
777*0b57cec5SDimitry Andric }
778*0b57cec5SDimitry Andric 
779*0b57cec5SDimitry Andric OutputSection *ScriptParser::readOverlaySectionDescription() {
780*0b57cec5SDimitry Andric   OutputSection *cmd =
781*0b57cec5SDimitry Andric       script->createOutputSection(next(), getCurrentLocation());
782*0b57cec5SDimitry Andric   cmd->inOverlay = true;
783*0b57cec5SDimitry Andric   expect("{");
784*0b57cec5SDimitry Andric   while (!errorCount() && !consume("}"))
785*0b57cec5SDimitry Andric     cmd->sectionCommands.push_back(readInputSectionRules(next()));
786*0b57cec5SDimitry Andric   cmd->phdrs = readOutputSectionPhdrs();
787*0b57cec5SDimitry Andric   return cmd;
788*0b57cec5SDimitry Andric }
789*0b57cec5SDimitry Andric 
790*0b57cec5SDimitry Andric OutputSection *ScriptParser::readOutputSectionDescription(StringRef outSec) {
791*0b57cec5SDimitry Andric   OutputSection *cmd =
792*0b57cec5SDimitry Andric       script->createOutputSection(outSec, getCurrentLocation());
793*0b57cec5SDimitry Andric 
794*0b57cec5SDimitry Andric   size_t symbolsReferenced = script->referencedSymbols.size();
795*0b57cec5SDimitry Andric 
796*0b57cec5SDimitry Andric   if (peek() != ":")
797*0b57cec5SDimitry Andric     readSectionAddressType(cmd);
798*0b57cec5SDimitry Andric   expect(":");
799*0b57cec5SDimitry Andric 
800*0b57cec5SDimitry Andric   std::string location = getCurrentLocation();
801*0b57cec5SDimitry Andric   if (consume("AT"))
802*0b57cec5SDimitry Andric     cmd->lmaExpr = readParenExpr();
803*0b57cec5SDimitry Andric   if (consume("ALIGN"))
804*0b57cec5SDimitry Andric     cmd->alignExpr = checkAlignment(readParenExpr(), location);
805*0b57cec5SDimitry Andric   if (consume("SUBALIGN"))
806*0b57cec5SDimitry Andric     cmd->subalignExpr = checkAlignment(readParenExpr(), location);
807*0b57cec5SDimitry Andric 
808*0b57cec5SDimitry Andric   // Parse constraints.
809*0b57cec5SDimitry Andric   if (consume("ONLY_IF_RO"))
810*0b57cec5SDimitry Andric     cmd->constraint = ConstraintKind::ReadOnly;
811*0b57cec5SDimitry Andric   if (consume("ONLY_IF_RW"))
812*0b57cec5SDimitry Andric     cmd->constraint = ConstraintKind::ReadWrite;
813*0b57cec5SDimitry Andric   expect("{");
814*0b57cec5SDimitry Andric 
815*0b57cec5SDimitry Andric   while (!errorCount() && !consume("}")) {
816*0b57cec5SDimitry Andric     StringRef tok = next();
817*0b57cec5SDimitry Andric     if (tok == ";") {
818*0b57cec5SDimitry Andric       // Empty commands are allowed. Do nothing here.
819*0b57cec5SDimitry Andric     } else if (SymbolAssignment *assign = readAssignment(tok)) {
820*0b57cec5SDimitry Andric       cmd->sectionCommands.push_back(assign);
821*0b57cec5SDimitry Andric     } else if (ByteCommand *data = readByteCommand(tok)) {
822*0b57cec5SDimitry Andric       cmd->sectionCommands.push_back(data);
823*0b57cec5SDimitry Andric     } else if (tok == "CONSTRUCTORS") {
824*0b57cec5SDimitry Andric       // CONSTRUCTORS is a keyword to make the linker recognize C++ ctors/dtors
825*0b57cec5SDimitry Andric       // by name. This is for very old file formats such as ECOFF/XCOFF.
826*0b57cec5SDimitry Andric       // For ELF, we should ignore.
827*0b57cec5SDimitry Andric     } else if (tok == "FILL") {
828*0b57cec5SDimitry Andric       // We handle the FILL command as an alias for =fillexp section attribute,
829*0b57cec5SDimitry Andric       // which is different from what GNU linkers do.
830*0b57cec5SDimitry Andric       // https://sourceware.org/binutils/docs/ld/Output-Section-Data.html
831*0b57cec5SDimitry Andric       expect("(");
832*0b57cec5SDimitry Andric       cmd->filler = readFill();
833*0b57cec5SDimitry Andric       expect(")");
834*0b57cec5SDimitry Andric     } else if (tok == "SORT") {
835*0b57cec5SDimitry Andric       readSort();
836*0b57cec5SDimitry Andric     } else if (tok == "INCLUDE") {
837*0b57cec5SDimitry Andric       readInclude();
838*0b57cec5SDimitry Andric     } else if (peek() == "(") {
839*0b57cec5SDimitry Andric       cmd->sectionCommands.push_back(readInputSectionDescription(tok));
840*0b57cec5SDimitry Andric     } else {
841*0b57cec5SDimitry Andric       // We have a file name and no input sections description. It is not a
842*0b57cec5SDimitry Andric       // commonly used syntax, but still acceptable. In that case, all sections
843*0b57cec5SDimitry Andric       // from the file will be included.
844*0b57cec5SDimitry Andric       auto *isd = make<InputSectionDescription>(tok);
845*0b57cec5SDimitry Andric       isd->sectionPatterns.push_back({{}, StringMatcher({"*"})});
846*0b57cec5SDimitry Andric       cmd->sectionCommands.push_back(isd);
847*0b57cec5SDimitry Andric     }
848*0b57cec5SDimitry Andric   }
849*0b57cec5SDimitry Andric 
850*0b57cec5SDimitry Andric   if (consume(">"))
851*0b57cec5SDimitry Andric     cmd->memoryRegionName = next();
852*0b57cec5SDimitry Andric 
853*0b57cec5SDimitry Andric   if (consume("AT")) {
854*0b57cec5SDimitry Andric     expect(">");
855*0b57cec5SDimitry Andric     cmd->lmaRegionName = next();
856*0b57cec5SDimitry Andric   }
857*0b57cec5SDimitry Andric 
858*0b57cec5SDimitry Andric   if (cmd->lmaExpr && !cmd->lmaRegionName.empty())
859*0b57cec5SDimitry Andric     error("section can't have both LMA and a load region");
860*0b57cec5SDimitry Andric 
861*0b57cec5SDimitry Andric   cmd->phdrs = readOutputSectionPhdrs();
862*0b57cec5SDimitry Andric 
863*0b57cec5SDimitry Andric   if (peek() == "=" || peek().startswith("=")) {
864*0b57cec5SDimitry Andric     inExpr = true;
865*0b57cec5SDimitry Andric     consume("=");
866*0b57cec5SDimitry Andric     cmd->filler = readFill();
867*0b57cec5SDimitry Andric     inExpr = false;
868*0b57cec5SDimitry Andric   }
869*0b57cec5SDimitry Andric 
870*0b57cec5SDimitry Andric   // Consume optional comma following output section command.
871*0b57cec5SDimitry Andric   consume(",");
872*0b57cec5SDimitry Andric 
873*0b57cec5SDimitry Andric   if (script->referencedSymbols.size() > symbolsReferenced)
874*0b57cec5SDimitry Andric     cmd->expressionsUseSymbols = true;
875*0b57cec5SDimitry Andric   return cmd;
876*0b57cec5SDimitry Andric }
877*0b57cec5SDimitry Andric 
878*0b57cec5SDimitry Andric // Reads a `=<fillexp>` expression and returns its value as a big-endian number.
879*0b57cec5SDimitry Andric // https://sourceware.org/binutils/docs/ld/Output-Section-Fill.html
880*0b57cec5SDimitry Andric // We do not support using symbols in such expressions.
881*0b57cec5SDimitry Andric //
882*0b57cec5SDimitry Andric // When reading a hexstring, ld.bfd handles it as a blob of arbitrary
883*0b57cec5SDimitry Andric // size, while ld.gold always handles it as a 32-bit big-endian number.
884*0b57cec5SDimitry Andric // We are compatible with ld.gold because it's easier to implement.
885*0b57cec5SDimitry Andric std::array<uint8_t, 4> ScriptParser::readFill() {
886*0b57cec5SDimitry Andric   uint64_t value = readExpr()().val;
887*0b57cec5SDimitry Andric   if (value > UINT32_MAX)
888*0b57cec5SDimitry Andric     setError("filler expression result does not fit 32-bit: 0x" +
889*0b57cec5SDimitry Andric              Twine::utohexstr(value));
890*0b57cec5SDimitry Andric 
891*0b57cec5SDimitry Andric   std::array<uint8_t, 4> buf;
892*0b57cec5SDimitry Andric   write32be(buf.data(), (uint32_t)value);
893*0b57cec5SDimitry Andric   return buf;
894*0b57cec5SDimitry Andric }
895*0b57cec5SDimitry Andric 
896*0b57cec5SDimitry Andric SymbolAssignment *ScriptParser::readProvideHidden(bool provide, bool hidden) {
897*0b57cec5SDimitry Andric   expect("(");
898*0b57cec5SDimitry Andric   SymbolAssignment *cmd = readSymbolAssignment(next());
899*0b57cec5SDimitry Andric   cmd->provide = provide;
900*0b57cec5SDimitry Andric   cmd->hidden = hidden;
901*0b57cec5SDimitry Andric   expect(")");
902*0b57cec5SDimitry Andric   return cmd;
903*0b57cec5SDimitry Andric }
904*0b57cec5SDimitry Andric 
905*0b57cec5SDimitry Andric SymbolAssignment *ScriptParser::readAssignment(StringRef tok) {
906*0b57cec5SDimitry Andric   // Assert expression returns Dot, so this is equal to ".=."
907*0b57cec5SDimitry Andric   if (tok == "ASSERT")
908*0b57cec5SDimitry Andric     return make<SymbolAssignment>(".", readAssert(), getCurrentLocation());
909*0b57cec5SDimitry Andric 
910*0b57cec5SDimitry Andric   size_t oldPos = pos;
911*0b57cec5SDimitry Andric   SymbolAssignment *cmd = nullptr;
912*0b57cec5SDimitry Andric   if (peek() == "=" || peek() == "+=")
913*0b57cec5SDimitry Andric     cmd = readSymbolAssignment(tok);
914*0b57cec5SDimitry Andric   else if (tok == "PROVIDE")
915*0b57cec5SDimitry Andric     cmd = readProvideHidden(true, false);
916*0b57cec5SDimitry Andric   else if (tok == "HIDDEN")
917*0b57cec5SDimitry Andric     cmd = readProvideHidden(false, true);
918*0b57cec5SDimitry Andric   else if (tok == "PROVIDE_HIDDEN")
919*0b57cec5SDimitry Andric     cmd = readProvideHidden(true, true);
920*0b57cec5SDimitry Andric 
921*0b57cec5SDimitry Andric   if (cmd) {
922*0b57cec5SDimitry Andric     cmd->commandString =
923*0b57cec5SDimitry Andric         tok.str() + " " +
924*0b57cec5SDimitry Andric         llvm::join(tokens.begin() + oldPos, tokens.begin() + pos, " ");
925*0b57cec5SDimitry Andric     expect(";");
926*0b57cec5SDimitry Andric   }
927*0b57cec5SDimitry Andric   return cmd;
928*0b57cec5SDimitry Andric }
929*0b57cec5SDimitry Andric 
930*0b57cec5SDimitry Andric SymbolAssignment *ScriptParser::readSymbolAssignment(StringRef name) {
931*0b57cec5SDimitry Andric   StringRef op = next();
932*0b57cec5SDimitry Andric   assert(op == "=" || op == "+=");
933*0b57cec5SDimitry Andric   Expr e = readExpr();
934*0b57cec5SDimitry Andric   if (op == "+=") {
935*0b57cec5SDimitry Andric     std::string loc = getCurrentLocation();
936*0b57cec5SDimitry Andric     e = [=] { return add(script->getSymbolValue(name, loc), e()); };
937*0b57cec5SDimitry Andric   }
938*0b57cec5SDimitry Andric   return make<SymbolAssignment>(name, e, getCurrentLocation());
939*0b57cec5SDimitry Andric }
940*0b57cec5SDimitry Andric 
941*0b57cec5SDimitry Andric // This is an operator-precedence parser to parse a linker
942*0b57cec5SDimitry Andric // script expression.
943*0b57cec5SDimitry Andric Expr ScriptParser::readExpr() {
944*0b57cec5SDimitry Andric   // Our lexer is context-aware. Set the in-expression bit so that
945*0b57cec5SDimitry Andric   // they apply different tokenization rules.
946*0b57cec5SDimitry Andric   bool orig = inExpr;
947*0b57cec5SDimitry Andric   inExpr = true;
948*0b57cec5SDimitry Andric   Expr e = readExpr1(readPrimary(), 0);
949*0b57cec5SDimitry Andric   inExpr = orig;
950*0b57cec5SDimitry Andric   return e;
951*0b57cec5SDimitry Andric }
952*0b57cec5SDimitry Andric 
953*0b57cec5SDimitry Andric Expr ScriptParser::combine(StringRef op, Expr l, Expr r) {
954*0b57cec5SDimitry Andric   if (op == "+")
955*0b57cec5SDimitry Andric     return [=] { return add(l(), r()); };
956*0b57cec5SDimitry Andric   if (op == "-")
957*0b57cec5SDimitry Andric     return [=] { return sub(l(), r()); };
958*0b57cec5SDimitry Andric   if (op == "*")
959*0b57cec5SDimitry Andric     return [=] { return l().getValue() * r().getValue(); };
960*0b57cec5SDimitry Andric   if (op == "/") {
961*0b57cec5SDimitry Andric     std::string loc = getCurrentLocation();
962*0b57cec5SDimitry Andric     return [=]() -> uint64_t {
963*0b57cec5SDimitry Andric       if (uint64_t rv = r().getValue())
964*0b57cec5SDimitry Andric         return l().getValue() / rv;
965*0b57cec5SDimitry Andric       error(loc + ": division by zero");
966*0b57cec5SDimitry Andric       return 0;
967*0b57cec5SDimitry Andric     };
968*0b57cec5SDimitry Andric   }
969*0b57cec5SDimitry Andric   if (op == "%") {
970*0b57cec5SDimitry Andric     std::string loc = getCurrentLocation();
971*0b57cec5SDimitry Andric     return [=]() -> uint64_t {
972*0b57cec5SDimitry Andric       if (uint64_t rv = r().getValue())
973*0b57cec5SDimitry Andric         return l().getValue() % rv;
974*0b57cec5SDimitry Andric       error(loc + ": modulo by zero");
975*0b57cec5SDimitry Andric       return 0;
976*0b57cec5SDimitry Andric     };
977*0b57cec5SDimitry Andric   }
978*0b57cec5SDimitry Andric   if (op == "<<")
979*0b57cec5SDimitry Andric     return [=] { return l().getValue() << r().getValue(); };
980*0b57cec5SDimitry Andric   if (op == ">>")
981*0b57cec5SDimitry Andric     return [=] { return l().getValue() >> r().getValue(); };
982*0b57cec5SDimitry Andric   if (op == "<")
983*0b57cec5SDimitry Andric     return [=] { return l().getValue() < r().getValue(); };
984*0b57cec5SDimitry Andric   if (op == ">")
985*0b57cec5SDimitry Andric     return [=] { return l().getValue() > r().getValue(); };
986*0b57cec5SDimitry Andric   if (op == ">=")
987*0b57cec5SDimitry Andric     return [=] { return l().getValue() >= r().getValue(); };
988*0b57cec5SDimitry Andric   if (op == "<=")
989*0b57cec5SDimitry Andric     return [=] { return l().getValue() <= r().getValue(); };
990*0b57cec5SDimitry Andric   if (op == "==")
991*0b57cec5SDimitry Andric     return [=] { return l().getValue() == r().getValue(); };
992*0b57cec5SDimitry Andric   if (op == "!=")
993*0b57cec5SDimitry Andric     return [=] { return l().getValue() != r().getValue(); };
994*0b57cec5SDimitry Andric   if (op == "||")
995*0b57cec5SDimitry Andric     return [=] { return l().getValue() || r().getValue(); };
996*0b57cec5SDimitry Andric   if (op == "&&")
997*0b57cec5SDimitry Andric     return [=] { return l().getValue() && r().getValue(); };
998*0b57cec5SDimitry Andric   if (op == "&")
999*0b57cec5SDimitry Andric     return [=] { return bitAnd(l(), r()); };
1000*0b57cec5SDimitry Andric   if (op == "|")
1001*0b57cec5SDimitry Andric     return [=] { return bitOr(l(), r()); };
1002*0b57cec5SDimitry Andric   llvm_unreachable("invalid operator");
1003*0b57cec5SDimitry Andric }
1004*0b57cec5SDimitry Andric 
1005*0b57cec5SDimitry Andric // This is a part of the operator-precedence parser. This function
1006*0b57cec5SDimitry Andric // assumes that the remaining token stream starts with an operator.
1007*0b57cec5SDimitry Andric Expr ScriptParser::readExpr1(Expr lhs, int minPrec) {
1008*0b57cec5SDimitry Andric   while (!atEOF() && !errorCount()) {
1009*0b57cec5SDimitry Andric     // Read an operator and an expression.
1010*0b57cec5SDimitry Andric     if (consume("?"))
1011*0b57cec5SDimitry Andric       return readTernary(lhs);
1012*0b57cec5SDimitry Andric     StringRef op1 = peek();
1013*0b57cec5SDimitry Andric     if (precedence(op1) < minPrec)
1014*0b57cec5SDimitry Andric       break;
1015*0b57cec5SDimitry Andric     skip();
1016*0b57cec5SDimitry Andric     Expr rhs = readPrimary();
1017*0b57cec5SDimitry Andric 
1018*0b57cec5SDimitry Andric     // Evaluate the remaining part of the expression first if the
1019*0b57cec5SDimitry Andric     // next operator has greater precedence than the previous one.
1020*0b57cec5SDimitry Andric     // For example, if we have read "+" and "3", and if the next
1021*0b57cec5SDimitry Andric     // operator is "*", then we'll evaluate 3 * ... part first.
1022*0b57cec5SDimitry Andric     while (!atEOF()) {
1023*0b57cec5SDimitry Andric       StringRef op2 = peek();
1024*0b57cec5SDimitry Andric       if (precedence(op2) <= precedence(op1))
1025*0b57cec5SDimitry Andric         break;
1026*0b57cec5SDimitry Andric       rhs = readExpr1(rhs, precedence(op2));
1027*0b57cec5SDimitry Andric     }
1028*0b57cec5SDimitry Andric 
1029*0b57cec5SDimitry Andric     lhs = combine(op1, lhs, rhs);
1030*0b57cec5SDimitry Andric   }
1031*0b57cec5SDimitry Andric   return lhs;
1032*0b57cec5SDimitry Andric }
1033*0b57cec5SDimitry Andric 
1034*0b57cec5SDimitry Andric Expr ScriptParser::getPageSize() {
1035*0b57cec5SDimitry Andric   std::string location = getCurrentLocation();
1036*0b57cec5SDimitry Andric   return [=]() -> uint64_t {
1037*0b57cec5SDimitry Andric     if (target)
1038*0b57cec5SDimitry Andric       return config->commonPageSize;
1039*0b57cec5SDimitry Andric     error(location + ": unable to calculate page size");
1040*0b57cec5SDimitry Andric     return 4096; // Return a dummy value.
1041*0b57cec5SDimitry Andric   };
1042*0b57cec5SDimitry Andric }
1043*0b57cec5SDimitry Andric 
1044*0b57cec5SDimitry Andric Expr ScriptParser::readConstant() {
1045*0b57cec5SDimitry Andric   StringRef s = readParenLiteral();
1046*0b57cec5SDimitry Andric   if (s == "COMMONPAGESIZE")
1047*0b57cec5SDimitry Andric     return getPageSize();
1048*0b57cec5SDimitry Andric   if (s == "MAXPAGESIZE")
1049*0b57cec5SDimitry Andric     return [] { return config->maxPageSize; };
1050*0b57cec5SDimitry Andric   setError("unknown constant: " + s);
1051*0b57cec5SDimitry Andric   return [] { return 0; };
1052*0b57cec5SDimitry Andric }
1053*0b57cec5SDimitry Andric 
1054*0b57cec5SDimitry Andric // Parses Tok as an integer. It recognizes hexadecimal (prefixed with
1055*0b57cec5SDimitry Andric // "0x" or suffixed with "H") and decimal numbers. Decimal numbers may
1056*0b57cec5SDimitry Andric // have "K" (Ki) or "M" (Mi) suffixes.
1057*0b57cec5SDimitry Andric static Optional<uint64_t> parseInt(StringRef tok) {
1058*0b57cec5SDimitry Andric   // Hexadecimal
1059*0b57cec5SDimitry Andric   uint64_t val;
1060*0b57cec5SDimitry Andric   if (tok.startswith_lower("0x")) {
1061*0b57cec5SDimitry Andric     if (!to_integer(tok.substr(2), val, 16))
1062*0b57cec5SDimitry Andric       return None;
1063*0b57cec5SDimitry Andric     return val;
1064*0b57cec5SDimitry Andric   }
1065*0b57cec5SDimitry Andric   if (tok.endswith_lower("H")) {
1066*0b57cec5SDimitry Andric     if (!to_integer(tok.drop_back(), val, 16))
1067*0b57cec5SDimitry Andric       return None;
1068*0b57cec5SDimitry Andric     return val;
1069*0b57cec5SDimitry Andric   }
1070*0b57cec5SDimitry Andric 
1071*0b57cec5SDimitry Andric   // Decimal
1072*0b57cec5SDimitry Andric   if (tok.endswith_lower("K")) {
1073*0b57cec5SDimitry Andric     if (!to_integer(tok.drop_back(), val, 10))
1074*0b57cec5SDimitry Andric       return None;
1075*0b57cec5SDimitry Andric     return val * 1024;
1076*0b57cec5SDimitry Andric   }
1077*0b57cec5SDimitry Andric   if (tok.endswith_lower("M")) {
1078*0b57cec5SDimitry Andric     if (!to_integer(tok.drop_back(), val, 10))
1079*0b57cec5SDimitry Andric       return None;
1080*0b57cec5SDimitry Andric     return val * 1024 * 1024;
1081*0b57cec5SDimitry Andric   }
1082*0b57cec5SDimitry Andric   if (!to_integer(tok, val, 10))
1083*0b57cec5SDimitry Andric     return None;
1084*0b57cec5SDimitry Andric   return val;
1085*0b57cec5SDimitry Andric }
1086*0b57cec5SDimitry Andric 
1087*0b57cec5SDimitry Andric ByteCommand *ScriptParser::readByteCommand(StringRef tok) {
1088*0b57cec5SDimitry Andric   int size = StringSwitch<int>(tok)
1089*0b57cec5SDimitry Andric                  .Case("BYTE", 1)
1090*0b57cec5SDimitry Andric                  .Case("SHORT", 2)
1091*0b57cec5SDimitry Andric                  .Case("LONG", 4)
1092*0b57cec5SDimitry Andric                  .Case("QUAD", 8)
1093*0b57cec5SDimitry Andric                  .Default(-1);
1094*0b57cec5SDimitry Andric   if (size == -1)
1095*0b57cec5SDimitry Andric     return nullptr;
1096*0b57cec5SDimitry Andric 
1097*0b57cec5SDimitry Andric   size_t oldPos = pos;
1098*0b57cec5SDimitry Andric   Expr e = readParenExpr();
1099*0b57cec5SDimitry Andric   std::string commandString =
1100*0b57cec5SDimitry Andric       tok.str() + " " +
1101*0b57cec5SDimitry Andric       llvm::join(tokens.begin() + oldPos, tokens.begin() + pos, " ");
1102*0b57cec5SDimitry Andric   return make<ByteCommand>(e, size, commandString);
1103*0b57cec5SDimitry Andric }
1104*0b57cec5SDimitry Andric 
1105*0b57cec5SDimitry Andric StringRef ScriptParser::readParenLiteral() {
1106*0b57cec5SDimitry Andric   expect("(");
1107*0b57cec5SDimitry Andric   bool orig = inExpr;
1108*0b57cec5SDimitry Andric   inExpr = false;
1109*0b57cec5SDimitry Andric   StringRef tok = next();
1110*0b57cec5SDimitry Andric   inExpr = orig;
1111*0b57cec5SDimitry Andric   expect(")");
1112*0b57cec5SDimitry Andric   return tok;
1113*0b57cec5SDimitry Andric }
1114*0b57cec5SDimitry Andric 
1115*0b57cec5SDimitry Andric static void checkIfExists(OutputSection *cmd, StringRef location) {
1116*0b57cec5SDimitry Andric   if (cmd->location.empty() && script->errorOnMissingSection)
1117*0b57cec5SDimitry Andric     error(location + ": undefined section " + cmd->name);
1118*0b57cec5SDimitry Andric }
1119*0b57cec5SDimitry Andric 
1120*0b57cec5SDimitry Andric Expr ScriptParser::readPrimary() {
1121*0b57cec5SDimitry Andric   if (peek() == "(")
1122*0b57cec5SDimitry Andric     return readParenExpr();
1123*0b57cec5SDimitry Andric 
1124*0b57cec5SDimitry Andric   if (consume("~")) {
1125*0b57cec5SDimitry Andric     Expr e = readPrimary();
1126*0b57cec5SDimitry Andric     return [=] { return ~e().getValue(); };
1127*0b57cec5SDimitry Andric   }
1128*0b57cec5SDimitry Andric   if (consume("!")) {
1129*0b57cec5SDimitry Andric     Expr e = readPrimary();
1130*0b57cec5SDimitry Andric     return [=] { return !e().getValue(); };
1131*0b57cec5SDimitry Andric   }
1132*0b57cec5SDimitry Andric   if (consume("-")) {
1133*0b57cec5SDimitry Andric     Expr e = readPrimary();
1134*0b57cec5SDimitry Andric     return [=] { return -e().getValue(); };
1135*0b57cec5SDimitry Andric   }
1136*0b57cec5SDimitry Andric 
1137*0b57cec5SDimitry Andric   StringRef tok = next();
1138*0b57cec5SDimitry Andric   std::string location = getCurrentLocation();
1139*0b57cec5SDimitry Andric 
1140*0b57cec5SDimitry Andric   // Built-in functions are parsed here.
1141*0b57cec5SDimitry Andric   // https://sourceware.org/binutils/docs/ld/Builtin-Functions.html.
1142*0b57cec5SDimitry Andric   if (tok == "ABSOLUTE") {
1143*0b57cec5SDimitry Andric     Expr inner = readParenExpr();
1144*0b57cec5SDimitry Andric     return [=] {
1145*0b57cec5SDimitry Andric       ExprValue i = inner();
1146*0b57cec5SDimitry Andric       i.forceAbsolute = true;
1147*0b57cec5SDimitry Andric       return i;
1148*0b57cec5SDimitry Andric     };
1149*0b57cec5SDimitry Andric   }
1150*0b57cec5SDimitry Andric   if (tok == "ADDR") {
1151*0b57cec5SDimitry Andric     StringRef name = readParenLiteral();
1152*0b57cec5SDimitry Andric     OutputSection *sec = script->getOrCreateOutputSection(name);
1153*0b57cec5SDimitry Andric     sec->usedInExpression = true;
1154*0b57cec5SDimitry Andric     return [=]() -> ExprValue {
1155*0b57cec5SDimitry Andric       checkIfExists(sec, location);
1156*0b57cec5SDimitry Andric       return {sec, false, 0, location};
1157*0b57cec5SDimitry Andric     };
1158*0b57cec5SDimitry Andric   }
1159*0b57cec5SDimitry Andric   if (tok == "ALIGN") {
1160*0b57cec5SDimitry Andric     expect("(");
1161*0b57cec5SDimitry Andric     Expr e = readExpr();
1162*0b57cec5SDimitry Andric     if (consume(")")) {
1163*0b57cec5SDimitry Andric       e = checkAlignment(e, location);
1164*0b57cec5SDimitry Andric       return [=] { return alignTo(script->getDot(), e().getValue()); };
1165*0b57cec5SDimitry Andric     }
1166*0b57cec5SDimitry Andric     expect(",");
1167*0b57cec5SDimitry Andric     Expr e2 = checkAlignment(readExpr(), location);
1168*0b57cec5SDimitry Andric     expect(")");
1169*0b57cec5SDimitry Andric     return [=] {
1170*0b57cec5SDimitry Andric       ExprValue v = e();
1171*0b57cec5SDimitry Andric       v.alignment = e2().getValue();
1172*0b57cec5SDimitry Andric       return v;
1173*0b57cec5SDimitry Andric     };
1174*0b57cec5SDimitry Andric   }
1175*0b57cec5SDimitry Andric   if (tok == "ALIGNOF") {
1176*0b57cec5SDimitry Andric     StringRef name = readParenLiteral();
1177*0b57cec5SDimitry Andric     OutputSection *cmd = script->getOrCreateOutputSection(name);
1178*0b57cec5SDimitry Andric     return [=] {
1179*0b57cec5SDimitry Andric       checkIfExists(cmd, location);
1180*0b57cec5SDimitry Andric       return cmd->alignment;
1181*0b57cec5SDimitry Andric     };
1182*0b57cec5SDimitry Andric   }
1183*0b57cec5SDimitry Andric   if (tok == "ASSERT")
1184*0b57cec5SDimitry Andric     return readAssert();
1185*0b57cec5SDimitry Andric   if (tok == "CONSTANT")
1186*0b57cec5SDimitry Andric     return readConstant();
1187*0b57cec5SDimitry Andric   if (tok == "DATA_SEGMENT_ALIGN") {
1188*0b57cec5SDimitry Andric     expect("(");
1189*0b57cec5SDimitry Andric     Expr e = readExpr();
1190*0b57cec5SDimitry Andric     expect(",");
1191*0b57cec5SDimitry Andric     readExpr();
1192*0b57cec5SDimitry Andric     expect(")");
1193*0b57cec5SDimitry Andric     return [=] {
1194*0b57cec5SDimitry Andric       return alignTo(script->getDot(), std::max((uint64_t)1, e().getValue()));
1195*0b57cec5SDimitry Andric     };
1196*0b57cec5SDimitry Andric   }
1197*0b57cec5SDimitry Andric   if (tok == "DATA_SEGMENT_END") {
1198*0b57cec5SDimitry Andric     expect("(");
1199*0b57cec5SDimitry Andric     expect(".");
1200*0b57cec5SDimitry Andric     expect(")");
1201*0b57cec5SDimitry Andric     return [] { return script->getDot(); };
1202*0b57cec5SDimitry Andric   }
1203*0b57cec5SDimitry Andric   if (tok == "DATA_SEGMENT_RELRO_END") {
1204*0b57cec5SDimitry Andric     // GNU linkers implements more complicated logic to handle
1205*0b57cec5SDimitry Andric     // DATA_SEGMENT_RELRO_END. We instead ignore the arguments and
1206*0b57cec5SDimitry Andric     // just align to the next page boundary for simplicity.
1207*0b57cec5SDimitry Andric     expect("(");
1208*0b57cec5SDimitry Andric     readExpr();
1209*0b57cec5SDimitry Andric     expect(",");
1210*0b57cec5SDimitry Andric     readExpr();
1211*0b57cec5SDimitry Andric     expect(")");
1212*0b57cec5SDimitry Andric     Expr e = getPageSize();
1213*0b57cec5SDimitry Andric     return [=] { return alignTo(script->getDot(), e().getValue()); };
1214*0b57cec5SDimitry Andric   }
1215*0b57cec5SDimitry Andric   if (tok == "DEFINED") {
1216*0b57cec5SDimitry Andric     StringRef name = readParenLiteral();
1217*0b57cec5SDimitry Andric     return [=] { return symtab->find(name) ? 1 : 0; };
1218*0b57cec5SDimitry Andric   }
1219*0b57cec5SDimitry Andric   if (tok == "LENGTH") {
1220*0b57cec5SDimitry Andric     StringRef name = readParenLiteral();
1221*0b57cec5SDimitry Andric     if (script->memoryRegions.count(name) == 0) {
1222*0b57cec5SDimitry Andric       setError("memory region not defined: " + name);
1223*0b57cec5SDimitry Andric       return [] { return 0; };
1224*0b57cec5SDimitry Andric     }
1225*0b57cec5SDimitry Andric     return [=] { return script->memoryRegions[name]->length; };
1226*0b57cec5SDimitry Andric   }
1227*0b57cec5SDimitry Andric   if (tok == "LOADADDR") {
1228*0b57cec5SDimitry Andric     StringRef name = readParenLiteral();
1229*0b57cec5SDimitry Andric     OutputSection *cmd = script->getOrCreateOutputSection(name);
1230*0b57cec5SDimitry Andric     cmd->usedInExpression = true;
1231*0b57cec5SDimitry Andric     return [=] {
1232*0b57cec5SDimitry Andric       checkIfExists(cmd, location);
1233*0b57cec5SDimitry Andric       return cmd->getLMA();
1234*0b57cec5SDimitry Andric     };
1235*0b57cec5SDimitry Andric   }
1236*0b57cec5SDimitry Andric   if (tok == "MAX" || tok == "MIN") {
1237*0b57cec5SDimitry Andric     expect("(");
1238*0b57cec5SDimitry Andric     Expr a = readExpr();
1239*0b57cec5SDimitry Andric     expect(",");
1240*0b57cec5SDimitry Andric     Expr b = readExpr();
1241*0b57cec5SDimitry Andric     expect(")");
1242*0b57cec5SDimitry Andric     if (tok == "MIN")
1243*0b57cec5SDimitry Andric       return [=] { return std::min(a().getValue(), b().getValue()); };
1244*0b57cec5SDimitry Andric     return [=] { return std::max(a().getValue(), b().getValue()); };
1245*0b57cec5SDimitry Andric   }
1246*0b57cec5SDimitry Andric   if (tok == "ORIGIN") {
1247*0b57cec5SDimitry Andric     StringRef name = readParenLiteral();
1248*0b57cec5SDimitry Andric     if (script->memoryRegions.count(name) == 0) {
1249*0b57cec5SDimitry Andric       setError("memory region not defined: " + name);
1250*0b57cec5SDimitry Andric       return [] { return 0; };
1251*0b57cec5SDimitry Andric     }
1252*0b57cec5SDimitry Andric     return [=] { return script->memoryRegions[name]->origin; };
1253*0b57cec5SDimitry Andric   }
1254*0b57cec5SDimitry Andric   if (tok == "SEGMENT_START") {
1255*0b57cec5SDimitry Andric     expect("(");
1256*0b57cec5SDimitry Andric     skip();
1257*0b57cec5SDimitry Andric     expect(",");
1258*0b57cec5SDimitry Andric     Expr e = readExpr();
1259*0b57cec5SDimitry Andric     expect(")");
1260*0b57cec5SDimitry Andric     return [=] { return e(); };
1261*0b57cec5SDimitry Andric   }
1262*0b57cec5SDimitry Andric   if (tok == "SIZEOF") {
1263*0b57cec5SDimitry Andric     StringRef name = readParenLiteral();
1264*0b57cec5SDimitry Andric     OutputSection *cmd = script->getOrCreateOutputSection(name);
1265*0b57cec5SDimitry Andric     // Linker script does not create an output section if its content is empty.
1266*0b57cec5SDimitry Andric     // We want to allow SIZEOF(.foo) where .foo is a section which happened to
1267*0b57cec5SDimitry Andric     // be empty.
1268*0b57cec5SDimitry Andric     return [=] { return cmd->size; };
1269*0b57cec5SDimitry Andric   }
1270*0b57cec5SDimitry Andric   if (tok == "SIZEOF_HEADERS")
1271*0b57cec5SDimitry Andric     return [=] { return elf::getHeaderSize(); };
1272*0b57cec5SDimitry Andric 
1273*0b57cec5SDimitry Andric   // Tok is the dot.
1274*0b57cec5SDimitry Andric   if (tok == ".")
1275*0b57cec5SDimitry Andric     return [=] { return script->getSymbolValue(tok, location); };
1276*0b57cec5SDimitry Andric 
1277*0b57cec5SDimitry Andric   // Tok is a literal number.
1278*0b57cec5SDimitry Andric   if (Optional<uint64_t> val = parseInt(tok))
1279*0b57cec5SDimitry Andric     return [=] { return *val; };
1280*0b57cec5SDimitry Andric 
1281*0b57cec5SDimitry Andric   // Tok is a symbol name.
1282*0b57cec5SDimitry Andric   if (!isValidCIdentifier(tok))
1283*0b57cec5SDimitry Andric     setError("malformed number: " + tok);
1284*0b57cec5SDimitry Andric   script->referencedSymbols.push_back(tok);
1285*0b57cec5SDimitry Andric   return [=] { return script->getSymbolValue(tok, location); };
1286*0b57cec5SDimitry Andric }
1287*0b57cec5SDimitry Andric 
1288*0b57cec5SDimitry Andric Expr ScriptParser::readTernary(Expr cond) {
1289*0b57cec5SDimitry Andric   Expr l = readExpr();
1290*0b57cec5SDimitry Andric   expect(":");
1291*0b57cec5SDimitry Andric   Expr r = readExpr();
1292*0b57cec5SDimitry Andric   return [=] { return cond().getValue() ? l() : r(); };
1293*0b57cec5SDimitry Andric }
1294*0b57cec5SDimitry Andric 
1295*0b57cec5SDimitry Andric Expr ScriptParser::readParenExpr() {
1296*0b57cec5SDimitry Andric   expect("(");
1297*0b57cec5SDimitry Andric   Expr e = readExpr();
1298*0b57cec5SDimitry Andric   expect(")");
1299*0b57cec5SDimitry Andric   return e;
1300*0b57cec5SDimitry Andric }
1301*0b57cec5SDimitry Andric 
1302*0b57cec5SDimitry Andric std::vector<StringRef> ScriptParser::readOutputSectionPhdrs() {
1303*0b57cec5SDimitry Andric   std::vector<StringRef> phdrs;
1304*0b57cec5SDimitry Andric   while (!errorCount() && peek().startswith(":")) {
1305*0b57cec5SDimitry Andric     StringRef tok = next();
1306*0b57cec5SDimitry Andric     phdrs.push_back((tok.size() == 1) ? next() : tok.substr(1));
1307*0b57cec5SDimitry Andric   }
1308*0b57cec5SDimitry Andric   return phdrs;
1309*0b57cec5SDimitry Andric }
1310*0b57cec5SDimitry Andric 
1311*0b57cec5SDimitry Andric // Read a program header type name. The next token must be a
1312*0b57cec5SDimitry Andric // name of a program header type or a constant (e.g. "0x3").
1313*0b57cec5SDimitry Andric unsigned ScriptParser::readPhdrType() {
1314*0b57cec5SDimitry Andric   StringRef tok = next();
1315*0b57cec5SDimitry Andric   if (Optional<uint64_t> val = parseInt(tok))
1316*0b57cec5SDimitry Andric     return *val;
1317*0b57cec5SDimitry Andric 
1318*0b57cec5SDimitry Andric   unsigned ret = StringSwitch<unsigned>(tok)
1319*0b57cec5SDimitry Andric                      .Case("PT_NULL", PT_NULL)
1320*0b57cec5SDimitry Andric                      .Case("PT_LOAD", PT_LOAD)
1321*0b57cec5SDimitry Andric                      .Case("PT_DYNAMIC", PT_DYNAMIC)
1322*0b57cec5SDimitry Andric                      .Case("PT_INTERP", PT_INTERP)
1323*0b57cec5SDimitry Andric                      .Case("PT_NOTE", PT_NOTE)
1324*0b57cec5SDimitry Andric                      .Case("PT_SHLIB", PT_SHLIB)
1325*0b57cec5SDimitry Andric                      .Case("PT_PHDR", PT_PHDR)
1326*0b57cec5SDimitry Andric                      .Case("PT_TLS", PT_TLS)
1327*0b57cec5SDimitry Andric                      .Case("PT_GNU_EH_FRAME", PT_GNU_EH_FRAME)
1328*0b57cec5SDimitry Andric                      .Case("PT_GNU_STACK", PT_GNU_STACK)
1329*0b57cec5SDimitry Andric                      .Case("PT_GNU_RELRO", PT_GNU_RELRO)
1330*0b57cec5SDimitry Andric                      .Case("PT_OPENBSD_RANDOMIZE", PT_OPENBSD_RANDOMIZE)
1331*0b57cec5SDimitry Andric                      .Case("PT_OPENBSD_WXNEEDED", PT_OPENBSD_WXNEEDED)
1332*0b57cec5SDimitry Andric                      .Case("PT_OPENBSD_BOOTDATA", PT_OPENBSD_BOOTDATA)
1333*0b57cec5SDimitry Andric                      .Default(-1);
1334*0b57cec5SDimitry Andric 
1335*0b57cec5SDimitry Andric   if (ret == (unsigned)-1) {
1336*0b57cec5SDimitry Andric     setError("invalid program header type: " + tok);
1337*0b57cec5SDimitry Andric     return PT_NULL;
1338*0b57cec5SDimitry Andric   }
1339*0b57cec5SDimitry Andric   return ret;
1340*0b57cec5SDimitry Andric }
1341*0b57cec5SDimitry Andric 
1342*0b57cec5SDimitry Andric // Reads an anonymous version declaration.
1343*0b57cec5SDimitry Andric void ScriptParser::readAnonymousDeclaration() {
1344*0b57cec5SDimitry Andric   std::vector<SymbolVersion> locals;
1345*0b57cec5SDimitry Andric   std::vector<SymbolVersion> globals;
1346*0b57cec5SDimitry Andric   std::tie(locals, globals) = readSymbols();
1347*0b57cec5SDimitry Andric 
1348*0b57cec5SDimitry Andric   for (SymbolVersion v : locals) {
1349*0b57cec5SDimitry Andric     if (v.name == "*")
1350*0b57cec5SDimitry Andric       config->defaultSymbolVersion = VER_NDX_LOCAL;
1351*0b57cec5SDimitry Andric     else
1352*0b57cec5SDimitry Andric       config->versionScriptLocals.push_back(v);
1353*0b57cec5SDimitry Andric   }
1354*0b57cec5SDimitry Andric 
1355*0b57cec5SDimitry Andric   for (SymbolVersion v : globals)
1356*0b57cec5SDimitry Andric     config->versionScriptGlobals.push_back(v);
1357*0b57cec5SDimitry Andric 
1358*0b57cec5SDimitry Andric   expect(";");
1359*0b57cec5SDimitry Andric }
1360*0b57cec5SDimitry Andric 
1361*0b57cec5SDimitry Andric // Reads a non-anonymous version definition,
1362*0b57cec5SDimitry Andric // e.g. "VerStr { global: foo; bar; local: *; };".
1363*0b57cec5SDimitry Andric void ScriptParser::readVersionDeclaration(StringRef verStr) {
1364*0b57cec5SDimitry Andric   // Read a symbol list.
1365*0b57cec5SDimitry Andric   std::vector<SymbolVersion> locals;
1366*0b57cec5SDimitry Andric   std::vector<SymbolVersion> globals;
1367*0b57cec5SDimitry Andric   std::tie(locals, globals) = readSymbols();
1368*0b57cec5SDimitry Andric 
1369*0b57cec5SDimitry Andric   for (SymbolVersion v : locals) {
1370*0b57cec5SDimitry Andric     if (v.name == "*")
1371*0b57cec5SDimitry Andric       config->defaultSymbolVersion = VER_NDX_LOCAL;
1372*0b57cec5SDimitry Andric     else
1373*0b57cec5SDimitry Andric       config->versionScriptLocals.push_back(v);
1374*0b57cec5SDimitry Andric   }
1375*0b57cec5SDimitry Andric 
1376*0b57cec5SDimitry Andric   // Create a new version definition and add that to the global symbols.
1377*0b57cec5SDimitry Andric   VersionDefinition ver;
1378*0b57cec5SDimitry Andric   ver.name = verStr;
1379*0b57cec5SDimitry Andric   ver.globals = globals;
1380*0b57cec5SDimitry Andric 
1381*0b57cec5SDimitry Andric   // User-defined version number starts from 2 because 0 and 1 are
1382*0b57cec5SDimitry Andric   // reserved for VER_NDX_LOCAL and VER_NDX_GLOBAL, respectively.
1383*0b57cec5SDimitry Andric   ver.id = config->versionDefinitions.size() + 2;
1384*0b57cec5SDimitry Andric   config->versionDefinitions.push_back(ver);
1385*0b57cec5SDimitry Andric 
1386*0b57cec5SDimitry Andric   // Each version may have a parent version. For example, "Ver2"
1387*0b57cec5SDimitry Andric   // defined as "Ver2 { global: foo; local: *; } Ver1;" has "Ver1"
1388*0b57cec5SDimitry Andric   // as a parent. This version hierarchy is, probably against your
1389*0b57cec5SDimitry Andric   // instinct, purely for hint; the runtime doesn't care about it
1390*0b57cec5SDimitry Andric   // at all. In LLD, we simply ignore it.
1391*0b57cec5SDimitry Andric   if (peek() != ";")
1392*0b57cec5SDimitry Andric     skip();
1393*0b57cec5SDimitry Andric   expect(";");
1394*0b57cec5SDimitry Andric }
1395*0b57cec5SDimitry Andric 
1396*0b57cec5SDimitry Andric static bool hasWildcard(StringRef s) {
1397*0b57cec5SDimitry Andric   return s.find_first_of("?*[") != StringRef::npos;
1398*0b57cec5SDimitry Andric }
1399*0b57cec5SDimitry Andric 
1400*0b57cec5SDimitry Andric // Reads a list of symbols, e.g. "{ global: foo; bar; local: *; };".
1401*0b57cec5SDimitry Andric std::pair<std::vector<SymbolVersion>, std::vector<SymbolVersion>>
1402*0b57cec5SDimitry Andric ScriptParser::readSymbols() {
1403*0b57cec5SDimitry Andric   std::vector<SymbolVersion> locals;
1404*0b57cec5SDimitry Andric   std::vector<SymbolVersion> globals;
1405*0b57cec5SDimitry Andric   std::vector<SymbolVersion> *v = &globals;
1406*0b57cec5SDimitry Andric 
1407*0b57cec5SDimitry Andric   while (!errorCount()) {
1408*0b57cec5SDimitry Andric     if (consume("}"))
1409*0b57cec5SDimitry Andric       break;
1410*0b57cec5SDimitry Andric     if (consumeLabel("local")) {
1411*0b57cec5SDimitry Andric       v = &locals;
1412*0b57cec5SDimitry Andric       continue;
1413*0b57cec5SDimitry Andric     }
1414*0b57cec5SDimitry Andric     if (consumeLabel("global")) {
1415*0b57cec5SDimitry Andric       v = &globals;
1416*0b57cec5SDimitry Andric       continue;
1417*0b57cec5SDimitry Andric     }
1418*0b57cec5SDimitry Andric 
1419*0b57cec5SDimitry Andric     if (consume("extern")) {
1420*0b57cec5SDimitry Andric       std::vector<SymbolVersion> ext = readVersionExtern();
1421*0b57cec5SDimitry Andric       v->insert(v->end(), ext.begin(), ext.end());
1422*0b57cec5SDimitry Andric     } else {
1423*0b57cec5SDimitry Andric       StringRef tok = next();
1424*0b57cec5SDimitry Andric       v->push_back({unquote(tok), false, hasWildcard(tok)});
1425*0b57cec5SDimitry Andric     }
1426*0b57cec5SDimitry Andric     expect(";");
1427*0b57cec5SDimitry Andric   }
1428*0b57cec5SDimitry Andric   return {locals, globals};
1429*0b57cec5SDimitry Andric }
1430*0b57cec5SDimitry Andric 
1431*0b57cec5SDimitry Andric // Reads an "extern C++" directive, e.g.,
1432*0b57cec5SDimitry Andric // "extern "C++" { ns::*; "f(int, double)"; };"
1433*0b57cec5SDimitry Andric //
1434*0b57cec5SDimitry Andric // The last semicolon is optional. E.g. this is OK:
1435*0b57cec5SDimitry Andric // "extern "C++" { ns::*; "f(int, double)" };"
1436*0b57cec5SDimitry Andric std::vector<SymbolVersion> ScriptParser::readVersionExtern() {
1437*0b57cec5SDimitry Andric   StringRef tok = next();
1438*0b57cec5SDimitry Andric   bool isCXX = tok == "\"C++\"";
1439*0b57cec5SDimitry Andric   if (!isCXX && tok != "\"C\"")
1440*0b57cec5SDimitry Andric     setError("Unknown language");
1441*0b57cec5SDimitry Andric   expect("{");
1442*0b57cec5SDimitry Andric 
1443*0b57cec5SDimitry Andric   std::vector<SymbolVersion> ret;
1444*0b57cec5SDimitry Andric   while (!errorCount() && peek() != "}") {
1445*0b57cec5SDimitry Andric     StringRef tok = next();
1446*0b57cec5SDimitry Andric     ret.push_back(
1447*0b57cec5SDimitry Andric         {unquote(tok), isCXX, !tok.startswith("\"") && hasWildcard(tok)});
1448*0b57cec5SDimitry Andric     if (consume("}"))
1449*0b57cec5SDimitry Andric       return ret;
1450*0b57cec5SDimitry Andric     expect(";");
1451*0b57cec5SDimitry Andric   }
1452*0b57cec5SDimitry Andric 
1453*0b57cec5SDimitry Andric   expect("}");
1454*0b57cec5SDimitry Andric   return ret;
1455*0b57cec5SDimitry Andric }
1456*0b57cec5SDimitry Andric 
1457*0b57cec5SDimitry Andric uint64_t ScriptParser::readMemoryAssignment(StringRef s1, StringRef s2,
1458*0b57cec5SDimitry Andric                                             StringRef s3) {
1459*0b57cec5SDimitry Andric   if (!consume(s1) && !consume(s2) && !consume(s3)) {
1460*0b57cec5SDimitry Andric     setError("expected one of: " + s1 + ", " + s2 + ", or " + s3);
1461*0b57cec5SDimitry Andric     return 0;
1462*0b57cec5SDimitry Andric   }
1463*0b57cec5SDimitry Andric   expect("=");
1464*0b57cec5SDimitry Andric   return readExpr()().getValue();
1465*0b57cec5SDimitry Andric }
1466*0b57cec5SDimitry Andric 
1467*0b57cec5SDimitry Andric // Parse the MEMORY command as specified in:
1468*0b57cec5SDimitry Andric // https://sourceware.org/binutils/docs/ld/MEMORY.html
1469*0b57cec5SDimitry Andric //
1470*0b57cec5SDimitry Andric // MEMORY { name [(attr)] : ORIGIN = origin, LENGTH = len ... }
1471*0b57cec5SDimitry Andric void ScriptParser::readMemory() {
1472*0b57cec5SDimitry Andric   expect("{");
1473*0b57cec5SDimitry Andric   while (!errorCount() && !consume("}")) {
1474*0b57cec5SDimitry Andric     StringRef tok = next();
1475*0b57cec5SDimitry Andric     if (tok == "INCLUDE") {
1476*0b57cec5SDimitry Andric       readInclude();
1477*0b57cec5SDimitry Andric       continue;
1478*0b57cec5SDimitry Andric     }
1479*0b57cec5SDimitry Andric 
1480*0b57cec5SDimitry Andric     uint32_t flags = 0;
1481*0b57cec5SDimitry Andric     uint32_t negFlags = 0;
1482*0b57cec5SDimitry Andric     if (consume("(")) {
1483*0b57cec5SDimitry Andric       std::tie(flags, negFlags) = readMemoryAttributes();
1484*0b57cec5SDimitry Andric       expect(")");
1485*0b57cec5SDimitry Andric     }
1486*0b57cec5SDimitry Andric     expect(":");
1487*0b57cec5SDimitry Andric 
1488*0b57cec5SDimitry Andric     uint64_t origin = readMemoryAssignment("ORIGIN", "org", "o");
1489*0b57cec5SDimitry Andric     expect(",");
1490*0b57cec5SDimitry Andric     uint64_t length = readMemoryAssignment("LENGTH", "len", "l");
1491*0b57cec5SDimitry Andric 
1492*0b57cec5SDimitry Andric     // Add the memory region to the region map.
1493*0b57cec5SDimitry Andric     MemoryRegion *mr = make<MemoryRegion>(tok, origin, length, flags, negFlags);
1494*0b57cec5SDimitry Andric     if (!script->memoryRegions.insert({tok, mr}).second)
1495*0b57cec5SDimitry Andric       setError("region '" + tok + "' already defined");
1496*0b57cec5SDimitry Andric   }
1497*0b57cec5SDimitry Andric }
1498*0b57cec5SDimitry Andric 
1499*0b57cec5SDimitry Andric // This function parses the attributes used to match against section
1500*0b57cec5SDimitry Andric // flags when placing output sections in a memory region. These flags
1501*0b57cec5SDimitry Andric // are only used when an explicit memory region name is not used.
1502*0b57cec5SDimitry Andric std::pair<uint32_t, uint32_t> ScriptParser::readMemoryAttributes() {
1503*0b57cec5SDimitry Andric   uint32_t flags = 0;
1504*0b57cec5SDimitry Andric   uint32_t negFlags = 0;
1505*0b57cec5SDimitry Andric   bool invert = false;
1506*0b57cec5SDimitry Andric 
1507*0b57cec5SDimitry Andric   for (char c : next().lower()) {
1508*0b57cec5SDimitry Andric     uint32_t flag = 0;
1509*0b57cec5SDimitry Andric     if (c == '!')
1510*0b57cec5SDimitry Andric       invert = !invert;
1511*0b57cec5SDimitry Andric     else if (c == 'w')
1512*0b57cec5SDimitry Andric       flag = SHF_WRITE;
1513*0b57cec5SDimitry Andric     else if (c == 'x')
1514*0b57cec5SDimitry Andric       flag = SHF_EXECINSTR;
1515*0b57cec5SDimitry Andric     else if (c == 'a')
1516*0b57cec5SDimitry Andric       flag = SHF_ALLOC;
1517*0b57cec5SDimitry Andric     else if (c != 'r')
1518*0b57cec5SDimitry Andric       setError("invalid memory region attribute");
1519*0b57cec5SDimitry Andric 
1520*0b57cec5SDimitry Andric     if (invert)
1521*0b57cec5SDimitry Andric       negFlags |= flag;
1522*0b57cec5SDimitry Andric     else
1523*0b57cec5SDimitry Andric       flags |= flag;
1524*0b57cec5SDimitry Andric   }
1525*0b57cec5SDimitry Andric   return {flags, negFlags};
1526*0b57cec5SDimitry Andric }
1527*0b57cec5SDimitry Andric 
1528*0b57cec5SDimitry Andric void elf::readLinkerScript(MemoryBufferRef mb) {
1529*0b57cec5SDimitry Andric   ScriptParser(mb).readLinkerScript();
1530*0b57cec5SDimitry Andric }
1531*0b57cec5SDimitry Andric 
1532*0b57cec5SDimitry Andric void elf::readVersionScript(MemoryBufferRef mb) {
1533*0b57cec5SDimitry Andric   ScriptParser(mb).readVersionScript();
1534*0b57cec5SDimitry Andric }
1535*0b57cec5SDimitry Andric 
1536*0b57cec5SDimitry Andric void elf::readDynamicList(MemoryBufferRef mb) {
1537*0b57cec5SDimitry Andric   ScriptParser(mb).readDynamicList();
1538*0b57cec5SDimitry Andric }
1539*0b57cec5SDimitry Andric 
1540*0b57cec5SDimitry Andric void elf::readDefsym(StringRef name, MemoryBufferRef mb) {
1541*0b57cec5SDimitry Andric   ScriptParser(mb).readDefsym(name);
1542*0b57cec5SDimitry Andric }
1543