blob: e3f30518bb36ebcc8b6a9f4c40f31ac69a7be65e [file] [log] [blame]
Rui Ueyamaf7c5fbb2015-09-30 17:23:26 +00001//===- LinkerScript.cpp ---------------------------------------------------===//
2//
3// The LLVM Linker
4//
5// This file is distributed under the University of Illinois Open Source
6// License. See LICENSE.TXT for details.
7//
8//===----------------------------------------------------------------------===//
9//
10// This file contains the parser/evaluator of the linker script.
Rui Ueyama629e0aa52016-07-21 19:45:22 +000011// It parses a linker script and write the result to Config or ScriptConfig
12// objects.
13//
14// If SECTIONS command is used, a ScriptConfig contains an AST
15// of the command which will later be consumed by createSections() and
16// assignAddresses().
Rui Ueyamaf7c5fbb2015-09-30 17:23:26 +000017//
18//===----------------------------------------------------------------------===//
19
Rui Ueyama717677a2016-02-11 21:17:59 +000020#include "LinkerScript.h"
Rui Ueyamaf7c5fbb2015-09-30 17:23:26 +000021#include "Config.h"
22#include "Driver.h"
Rui Ueyama1ebc8ed2016-02-12 21:47:28 +000023#include "InputSection.h"
George Rimar652852c2016-04-16 10:10:32 +000024#include "OutputSections.h"
Adhemerval Zanellae77b5bf2016-04-06 20:59:11 +000025#include "ScriptParser.h"
Rui Ueyama93c9af42016-06-29 08:01:32 +000026#include "Strings.h"
Eugene Levianteda81a12016-07-12 06:39:48 +000027#include "Symbols.h"
Rui Ueyamaf7c5fbb2015-09-30 17:23:26 +000028#include "SymbolTable.h"
Eugene Leviant467c4d52016-07-01 10:27:36 +000029#include "Target.h"
Eugene Leviantbbe38602016-07-19 09:25:43 +000030#include "Writer.h"
Rui Ueyama960504b2016-04-19 18:58:11 +000031#include "llvm/ADT/StringSwitch.h"
George Rimar652852c2016-04-16 10:10:32 +000032#include "llvm/Support/ELF.h"
Rui Ueyamaf7c5fbb2015-09-30 17:23:26 +000033#include "llvm/Support/FileSystem.h"
34#include "llvm/Support/MemoryBuffer.h"
Rui Ueyamaf03f3cc2015-10-13 00:09:21 +000035#include "llvm/Support/Path.h"
Rui Ueyamaa47ee682015-10-11 01:53:04 +000036#include "llvm/Support/StringSaver.h"
Rui Ueyamaf7c5fbb2015-09-30 17:23:26 +000037
38using namespace llvm;
George Rimar652852c2016-04-16 10:10:32 +000039using namespace llvm::ELF;
Rui Ueyama1ebc8ed2016-02-12 21:47:28 +000040using namespace llvm::object;
Rui Ueyamaf7c5fbb2015-09-30 17:23:26 +000041using namespace lld;
Rafael Espindolae0df00b2016-02-28 00:25:54 +000042using namespace lld::elf;
Rui Ueyamaf7c5fbb2015-09-30 17:23:26 +000043
George Rimar884e7862016-09-08 08:19:13 +000044LinkerScriptBase *elf::ScriptBase;
Rui Ueyama07320e42016-04-20 20:13:41 +000045ScriptConfiguration *elf::ScriptConfig;
Rui Ueyama717677a2016-02-11 21:17:59 +000046
George Rimar6c55f0e2016-09-08 08:20:30 +000047template <class ELFT> static void addRegular(SymbolAssignment *Cmd) {
Rui Ueyama16024212016-08-11 23:22:52 +000048 Symbol *Sym = Symtab<ELFT>::X->addRegular(Cmd->Name, STB_GLOBAL, STV_DEFAULT);
49 Sym->Visibility = Cmd->Hidden ? STV_HIDDEN : STV_DEFAULT;
50 Cmd->Sym = Sym->body();
Eugene Leviantceabe802016-08-11 07:56:43 +000051}
52
Rui Ueyama0c70d3c2016-08-12 03:31:09 +000053template <class ELFT> static void addSynthetic(SymbolAssignment *Cmd) {
George Rimare1937bb2016-08-19 15:36:32 +000054 Symbol *Sym = Symtab<ELFT>::X->addSynthetic(
55 Cmd->Name, nullptr, 0, Cmd->Hidden ? STV_HIDDEN : STV_DEFAULT);
Rui Ueyama16024212016-08-11 23:22:52 +000056 Cmd->Sym = Sym->body();
Eugene Leviantceabe802016-08-11 07:56:43 +000057}
58
Eugene Leviantdb741e72016-09-07 07:08:43 +000059template <class ELFT> static void addSymbol(SymbolAssignment *Cmd) {
60 if (Cmd->IsAbsolute)
61 addRegular<ELFT>(Cmd);
62 else
63 addSynthetic<ELFT>(Cmd);
64}
Rui Ueyama16024212016-08-11 23:22:52 +000065// If a symbol was in PROVIDE(), we need to define it only when
66// it is an undefined symbol.
67template <class ELFT> static bool shouldDefine(SymbolAssignment *Cmd) {
68 if (Cmd->Name == ".")
Eugene Leviantceabe802016-08-11 07:56:43 +000069 return false;
Rui Ueyama16024212016-08-11 23:22:52 +000070 if (!Cmd->Provide)
71 return true;
72 SymbolBody *B = Symtab<ELFT>::X->find(Cmd->Name);
73 return B && B->isUndefined();
Eugene Leviantceabe802016-08-11 07:56:43 +000074}
75
George Rimar076fe152016-07-21 06:43:01 +000076bool SymbolAssignment::classof(const BaseCommand *C) {
77 return C->Kind == AssignmentKind;
78}
79
80bool OutputSectionCommand::classof(const BaseCommand *C) {
81 return C->Kind == OutputSectionKind;
82}
83
George Rimareea31142016-07-21 14:26:59 +000084bool InputSectionDescription::classof(const BaseCommand *C) {
85 return C->Kind == InputSectionKind;
86}
87
George Rimareefa7582016-08-04 09:29:31 +000088bool AssertCommand::classof(const BaseCommand *C) {
89 return C->Kind == AssertKind;
90}
91
Rui Ueyama36a153c2016-07-23 14:09:58 +000092template <class ELFT> static bool isDiscarded(InputSectionBase<ELFT> *S) {
George Rimareea31142016-07-21 14:26:59 +000093 return !S || !S->Live;
Rui Ueyama717677a2016-02-11 21:17:59 +000094}
95
Rui Ueyamaf34d0e02016-08-12 01:24:53 +000096template <class ELFT> LinkerScript<ELFT>::LinkerScript() {}
97template <class ELFT> LinkerScript<ELFT>::~LinkerScript() {}
98
Rui Ueyama07320e42016-04-20 20:13:41 +000099template <class ELFT>
100bool LinkerScript<ELFT>::shouldKeep(InputSectionBase<ELFT> *S) {
George Rimarc91930a2016-09-02 21:17:20 +0000101 for (Regex *Re : Opt.KeptSections)
Rafael Espindola042a3f22016-09-08 14:06:08 +0000102 if (Re->match(S->Name))
George Rimareea31142016-07-21 14:26:59 +0000103 return true;
104 return false;
105}
106
George Rimar06598002016-07-28 21:51:30 +0000107static bool fileMatches(const InputSectionDescription *Desc,
108 StringRef Filename) {
George Rimarc91930a2016-09-02 21:17:20 +0000109 return const_cast<Regex &>(Desc->FileRe).match(Filename) &&
110 !const_cast<Regex &>(Desc->ExcludedFileRe).match(Filename);
George Rimar06598002016-07-28 21:51:30 +0000111}
112
Rui Ueyama6b274812016-07-25 22:51:07 +0000113// Returns input sections filtered by given glob patterns.
114template <class ELFT>
115std::vector<InputSectionBase<ELFT> *>
Rui Ueyamaad10c3d2016-07-28 21:05:04 +0000116LinkerScript<ELFT>::getInputSections(const InputSectionDescription *I) {
George Rimarc91930a2016-09-02 21:17:20 +0000117 const Regex &Re = I->SectionRe;
Rui Ueyama6b274812016-07-25 22:51:07 +0000118 std::vector<InputSectionBase<ELFT> *> Ret;
119 for (const std::unique_ptr<ObjectFile<ELFT>> &F :
George Rimar06598002016-07-28 21:51:30 +0000120 Symtab<ELFT>::X->getObjectFiles()) {
121 if (fileMatches(I, sys::path::filename(F->getName())))
122 for (InputSectionBase<ELFT> *S : F->getSections())
123 if (!isDiscarded(S) && !S->OutSec &&
Rafael Espindola042a3f22016-09-08 14:06:08 +0000124 const_cast<Regex &>(Re).match(S->Name))
Davide Italianoe7282792016-07-27 01:44:01 +0000125 Ret.push_back(S);
George Rimar06598002016-07-28 21:51:30 +0000126 }
Eugene Leviant3e6b0272016-07-28 19:24:13 +0000127
George Rimarc91930a2016-09-02 21:17:20 +0000128 if (const_cast<Regex &>(Re).match("COMMON"))
Rui Ueyamaad10c3d2016-07-28 21:05:04 +0000129 Ret.push_back(CommonInputSection<ELFT>::X);
Rui Ueyama6b274812016-07-25 22:51:07 +0000130 return Ret;
131}
132
Rafael Espindolac0028d32016-09-08 20:47:52 +0000133static bool compareName(InputSectionData *A, InputSectionData *B) {
Rafael Espindola042a3f22016-09-08 14:06:08 +0000134 return A->Name < B->Name;
Rui Ueyama742c3832016-08-04 22:27:00 +0000135}
George Rimar350ece42016-08-03 08:35:59 +0000136
Rafael Espindolac0028d32016-09-08 20:47:52 +0000137static bool compareAlignment(InputSectionData *A, InputSectionData *B) {
Rui Ueyama742c3832016-08-04 22:27:00 +0000138 // ">" is not a mistake. Larger alignments are placed before smaller
139 // alignments in order to reduce the amount of padding necessary.
140 // This is compatible with GNU.
141 return A->Alignment > B->Alignment;
142}
George Rimar350ece42016-08-03 08:35:59 +0000143
Rafael Espindolac0028d32016-09-08 20:47:52 +0000144static std::function<bool(InputSectionData *, InputSectionData *)>
Rui Ueyama742c3832016-08-04 22:27:00 +0000145getComparator(SortKind K) {
146 if (K == SortByName)
Rafael Espindolac0028d32016-09-08 20:47:52 +0000147 return compareName;
148 return compareAlignment;
Rui Ueyama742c3832016-08-04 22:27:00 +0000149}
George Rimar0702c4e2016-07-29 15:32:46 +0000150
151template <class ELFT>
Rafael Espindola7bd37872016-09-12 16:05:16 +0000152void LinkerScript<ELFT>::discard(ArrayRef<InputSectionBase<ELFT> *> V) {
153 for (InputSectionBase<ELFT> *S : V) {
154 S->Live = false;
155 reportDiscarded(S);
Rui Ueyama48c3f1c2016-08-12 00:27:23 +0000156 }
157}
158
George Rimar8f66df92016-08-12 20:38:20 +0000159static bool checkConstraint(uint64_t Flags, ConstraintKind Kind) {
160 bool RO = (Kind == ConstraintKind::ReadOnly);
161 bool RW = (Kind == ConstraintKind::ReadWrite);
162 bool Writable = Flags & SHF_WRITE;
Rui Ueyamaadcdb662016-09-06 22:50:48 +0000163 return !(RO && Writable) && !(RW && !Writable);
George Rimar8f66df92016-08-12 20:38:20 +0000164}
165
Rui Ueyama48c3f1c2016-08-12 00:27:23 +0000166template <class ELFT>
George Rimar06ae6832016-08-12 09:07:57 +0000167static bool matchConstraints(ArrayRef<InputSectionBase<ELFT> *> Sections,
168 ConstraintKind Kind) {
George Rimar8f66df92016-08-12 20:38:20 +0000169 if (Kind == ConstraintKind::NoConstraint)
170 return true;
171 return llvm::all_of(Sections, [=](InputSectionBase<ELFT> *Sec) {
172 return checkConstraint(Sec->getSectionHdr()->sh_flags, Kind);
George Rimar06ae6832016-08-12 09:07:57 +0000173 });
174}
175
176template <class ELFT>
Rui Ueyama0b9ce6a2016-08-12 03:16:56 +0000177std::vector<InputSectionBase<ELFT> *>
George Rimar06ae6832016-08-12 09:07:57 +0000178LinkerScript<ELFT>::createInputSectionList(OutputSectionCommand &OutCmd) {
Rui Ueyama0b9ce6a2016-08-12 03:16:56 +0000179 std::vector<InputSectionBase<ELFT> *> Ret;
Eugene Leviant97403d12016-09-01 09:55:57 +0000180 DenseSet<InputSectionBase<ELFT> *> SectionIndex;
Rui Ueyamae7f912c2016-08-03 21:12:09 +0000181
George Rimar06ae6832016-08-12 09:07:57 +0000182 for (const std::unique_ptr<BaseCommand> &Base : OutCmd.Commands) {
183 if (auto *OutCmd = dyn_cast<SymbolAssignment>(Base.get())) {
184 if (shouldDefine<ELFT>(OutCmd))
Eugene Leviantdb741e72016-09-07 07:08:43 +0000185 addSymbol<ELFT>(OutCmd);
Eugene Leviant97403d12016-09-01 09:55:57 +0000186 OutCmd->GoesAfter = Ret.empty() ? nullptr : Ret.back();
Rui Ueyama0b9ce6a2016-08-12 03:16:56 +0000187 continue;
188 }
189
190 auto *Cmd = cast<InputSectionDescription>(Base.get());
191 std::vector<InputSectionBase<ELFT> *> V = getInputSections(Cmd);
George Rimar06ae6832016-08-12 09:07:57 +0000192 if (!matchConstraints<ELFT>(V, OutCmd.Constraint))
193 continue;
Rui Ueyama0b9ce6a2016-08-12 03:16:56 +0000194 if (Cmd->SortInner)
Rafael Espindolac0028d32016-09-08 20:47:52 +0000195 std::stable_sort(V.begin(), V.end(), getComparator(Cmd->SortInner));
Rui Ueyama0b9ce6a2016-08-12 03:16:56 +0000196 if (Cmd->SortOuter)
Rafael Espindolac0028d32016-09-08 20:47:52 +0000197 std::stable_sort(V.begin(), V.end(), getComparator(Cmd->SortOuter));
Eugene Leviant97403d12016-09-01 09:55:57 +0000198
199 // Add all input sections corresponding to rule 'Cmd' to
200 // resulting vector. We do not add duplicate input sections.
201 for (InputSectionBase<ELFT> *S : V)
202 if (SectionIndex.insert(S).second)
203 Ret.push_back(S);
Rui Ueyama0b9ce6a2016-08-12 03:16:56 +0000204 }
205 return Ret;
206}
207
George Rimar6c55f0e2016-09-08 08:20:30 +0000208template <class ELFT> void LinkerScript<ELFT>::createAssignments() {
Petr Hoseke5d3ca52016-08-31 15:31:17 +0000209 for (const std::unique_ptr<SymbolAssignment> &Cmd : Opt.Assignments) {
210 if (shouldDefine<ELFT>(Cmd.get()))
211 addRegular<ELFT>(Cmd.get());
212 if (Cmd->Sym)
213 cast<DefinedRegular<ELFT>>(Cmd->Sym)->Value = Cmd->Expression(0);
214 }
215}
216
217template <class ELFT>
Rui Ueyama0b9ce6a2016-08-12 03:16:56 +0000218void LinkerScript<ELFT>::createSections(OutputSectionFactory<ELFT> &Factory) {
Rui Ueyama48c3f1c2016-08-12 00:27:23 +0000219 for (const std::unique_ptr<BaseCommand> &Base1 : Opt.Commands) {
Rui Ueyama2ab5f732016-08-12 03:33:04 +0000220 if (auto *Cmd = dyn_cast<SymbolAssignment>(Base1.get())) {
221 if (shouldDefine<ELFT>(Cmd))
222 addRegular<ELFT>(Cmd);
223 continue;
224 }
225
Eugene Leviantceabe802016-08-11 07:56:43 +0000226 if (auto *Cmd = dyn_cast<OutputSectionCommand>(Base1.get())) {
Rafael Espindola7bd37872016-09-12 16:05:16 +0000227 std::vector<InputSectionBase<ELFT> *> V = createInputSectionList(*Cmd);
228
Rui Ueyama48c3f1c2016-08-12 00:27:23 +0000229 if (Cmd->Name == "/DISCARD/") {
Rafael Espindola7bd37872016-09-12 16:05:16 +0000230 discard(V);
Rui Ueyama48c3f1c2016-08-12 00:27:23 +0000231 continue;
232 }
Eugene Leviantceabe802016-08-11 07:56:43 +0000233
Eugene Leviant97403d12016-09-01 09:55:57 +0000234 if (V.empty())
Rui Ueyama0b9ce6a2016-08-12 03:16:56 +0000235 continue;
236
George Rimardb24d9c2016-08-19 15:18:23 +0000237 for (InputSectionBase<ELFT> *Sec : V) {
George Rimara14b13d2016-09-07 10:46:07 +0000238 OutputSectionBase<ELFT> *OutSec;
239 bool IsNew;
240 std::tie(OutSec, IsNew) = Factory.create(Sec, Cmd->Name);
241 if (IsNew)
242 OutputSections->push_back(OutSec);
243
244 uint32_t Subalign = Cmd->SubalignExpr ? Cmd->SubalignExpr(0) : 0;
245
George Rimardb24d9c2016-08-19 15:18:23 +0000246 if (Subalign)
247 Sec->Alignment = Subalign;
Eugene Leviant97403d12016-09-01 09:55:57 +0000248 OutSec->addSection(Sec);
George Rimardb24d9c2016-08-19 15:18:23 +0000249 }
Eugene Leviantceabe802016-08-11 07:56:43 +0000250 }
Rui Ueyama48c3f1c2016-08-12 00:27:23 +0000251 }
Eugene Leviante63d81b2016-07-20 14:43:20 +0000252
Rui Ueyama0b9ce6a2016-08-12 03:16:56 +0000253 // Add orphan sections.
Rui Ueyama6b274812016-07-25 22:51:07 +0000254 for (const std::unique_ptr<ObjectFile<ELFT>> &F :
Rui Ueyama0b9ce6a2016-08-12 03:16:56 +0000255 Symtab<ELFT>::X->getObjectFiles()) {
256 for (InputSectionBase<ELFT> *S : F->getSections()) {
Rui Ueyama2ab5f732016-08-12 03:33:04 +0000257 if (isDiscarded(S) || S->OutSec)
258 continue;
259 OutputSectionBase<ELFT> *OutSec;
260 bool IsNew;
261 std::tie(OutSec, IsNew) = Factory.create(S, getOutputSectionName(S));
262 if (IsNew)
263 OutputSections->push_back(OutSec);
264 OutSec->addSection(S);
Rui Ueyama0b9ce6a2016-08-12 03:16:56 +0000265 }
266 }
Eugene Leviante63d81b2016-07-20 14:43:20 +0000267}
268
Eugene Leviantdb741e72016-09-07 07:08:43 +0000269// Sets value of a section-defined symbol. Two kinds of
270// symbols are processed: synthetic symbols, whose value
271// is an offset from beginning of section and regular
272// symbols whose value is absolute.
273template <class ELFT>
274static void assignSectionSymbol(SymbolAssignment *Cmd,
275 OutputSectionBase<ELFT> *Sec,
276 typename ELFT::uint Off) {
277 if (!Cmd->Sym)
278 return;
279
280 if (auto *Body = dyn_cast<DefinedSynthetic<ELFT>>(Cmd->Sym)) {
281 Body->Section = Sec;
282 Body->Value = Cmd->Expression(Sec->getVA() + Off) - Sec->getVA();
283 return;
284 }
285 auto *Body = cast<DefinedRegular<ELFT>>(Cmd->Sym);
286 Body->Value = Cmd->Expression(Sec->getVA() + Off);
287}
288
Eugene Leviant20889c52016-08-31 08:13:33 +0000289// Linker script may define start and end symbols for special section types,
290// like .got, .eh_frame_hdr, .eh_frame and others. Those sections are not a list
291// of regular input input sections, therefore our way of defining symbols for
292// regular sections will not work. The approach we use for special section types
293// is not perfect - it handles only start and end symbols.
294template <class ELFT>
295void addStartEndSymbols(OutputSectionCommand *Cmd,
296 OutputSectionBase<ELFT> *Sec) {
297 bool Start = true;
298 BaseCommand *PrevCmd = nullptr;
299
300 for (std::unique_ptr<BaseCommand> &Base : Cmd->Commands) {
301 if (auto *AssignCmd = dyn_cast<SymbolAssignment>(Base.get())) {
Eugene Leviantdb741e72016-09-07 07:08:43 +0000302 assignSectionSymbol<ELFT>(AssignCmd, Sec, Start ? 0 : Sec->getSize());
Eugene Leviant20889c52016-08-31 08:13:33 +0000303 } else {
304 if (!Start && isa<SymbolAssignment>(PrevCmd))
305 error("section '" + Sec->getName() +
306 "' supports only start and end symbols");
307 Start = false;
308 }
309 PrevCmd = Base.get();
310 }
311}
312
313template <class ELFT>
314void assignOffsets(OutputSectionCommand *Cmd, OutputSectionBase<ELFT> *Sec) {
Eugene Leviantceabe802016-08-11 07:56:43 +0000315 auto *OutSec = dyn_cast<OutputSection<ELFT>>(Sec);
Rui Ueyama2de509c2016-08-12 00:55:08 +0000316 if (!OutSec) {
317 Sec->assignOffsets();
Eugene Leviant20889c52016-08-31 08:13:33 +0000318 // This section is not regular output section. However linker script may
319 // have defined start/end symbols for it. This case is handled below.
320 addStartEndSymbols(Cmd, Sec);
Eugene Leviantceabe802016-08-11 07:56:43 +0000321 return;
Rui Ueyama2de509c2016-08-12 00:55:08 +0000322 }
Eugene Leviantceabe802016-08-11 07:56:43 +0000323 typedef typename ELFT::uint uintX_t;
324 uintX_t Off = 0;
Eugene Leviant97403d12016-09-01 09:55:57 +0000325 auto ItCmd = Cmd->Commands.begin();
Eugene Leviantceabe802016-08-11 07:56:43 +0000326
Eugene Leviant97403d12016-09-01 09:55:57 +0000327 // Assigns values to all symbols following the given
328 // input section 'D' in output section 'Sec'. When symbols
329 // are in the beginning of output section the value of 'D'
330 // is nullptr.
331 auto AssignSuccessors = [&](InputSectionData *D) {
332 for (; ItCmd != Cmd->Commands.end(); ++ItCmd) {
333 auto *AssignCmd = dyn_cast<SymbolAssignment>(ItCmd->get());
334 if (!AssignCmd)
335 continue;
336 if (D != AssignCmd->GoesAfter)
337 break;
338
Eugene Leviant97403d12016-09-01 09:55:57 +0000339 if (AssignCmd->Name == ".") {
340 // Update to location counter means update to section size.
Eugene Leviantdb741e72016-09-07 07:08:43 +0000341 Off = AssignCmd->Expression(Sec->getVA() + Off) - Sec->getVA();
Eugene Leviant97403d12016-09-01 09:55:57 +0000342 Sec->setSize(Off);
343 continue;
344 }
Eugene Leviantdb741e72016-09-07 07:08:43 +0000345 assignSectionSymbol<ELFT>(AssignCmd, Sec, Off);
Eugene Leviantceabe802016-08-11 07:56:43 +0000346 }
Eugene Leviant97403d12016-09-01 09:55:57 +0000347 };
348
349 AssignSuccessors(nullptr);
350 for (InputSection<ELFT> *I : OutSec->Sections) {
351 Off = alignTo(Off, I->Alignment);
352 I->OutSecOff = Off;
353 Off += I->getSize();
Rui Ueyamaf4a30a52016-08-11 21:30:42 +0000354 // Update section size inside for-loop, so that SIZEOF
Eugene Leviantceabe802016-08-11 07:56:43 +0000355 // works correctly in the case below:
356 // .foo { *(.aaa) a = SIZEOF(.foo); *(.bbb) }
357 Sec->setSize(Off);
Eugene Leviant97403d12016-09-01 09:55:57 +0000358 // Add symbols following current input section.
359 AssignSuccessors(I);
Eugene Leviantceabe802016-08-11 07:56:43 +0000360 }
361}
362
George Rimar8f66df92016-08-12 20:38:20 +0000363template <class ELFT>
George Rimara14b13d2016-09-07 10:46:07 +0000364static std::vector<OutputSectionBase<ELFT> *>
365findSections(OutputSectionCommand &Cmd,
366 ArrayRef<OutputSectionBase<ELFT> *> Sections) {
367 std::vector<OutputSectionBase<ELFT> *> Ret;
368 for (OutputSectionBase<ELFT> *Sec : Sections)
369 if (Sec->getName() == Cmd.Name &&
370 checkConstraint(Sec->getFlags(), Cmd.Constraint))
371 Ret.push_back(Sec);
372 return Ret;
George Rimar8f66df92016-08-12 20:38:20 +0000373}
374
Rafael Espindolaa4b41dc2016-08-04 12:13:05 +0000375template <class ELFT> void LinkerScript<ELFT>::assignAddresses() {
George Rimar652852c2016-04-16 10:10:32 +0000376 // Orphan sections are sections present in the input files which
Rui Ueyama7c18c282016-04-18 21:00:40 +0000377 // are not explicitly placed into the output file by the linker script.
378 // We place orphan sections at end of file.
379 // Other linkers places them using some heuristics as described in
George Rimar652852c2016-04-16 10:10:32 +0000380 // https://sourceware.org/binutils/docs/ld/Orphan-Sections.html#Orphan-Sections.
Rui Ueyamae5cc6682016-08-12 00:36:56 +0000381 for (OutputSectionBase<ELFT> *Sec : *OutputSections) {
George Rimar652852c2016-04-16 10:10:32 +0000382 StringRef Name = Sec->getName();
Rui Ueyamac3e2a4b2016-04-21 20:30:00 +0000383 if (getSectionIndex(Name) == INT_MAX)
George Rimar076fe152016-07-21 06:43:01 +0000384 Opt.Commands.push_back(llvm::make_unique<OutputSectionCommand>(Name));
George Rimar652852c2016-04-16 10:10:32 +0000385 }
George Rimar652852c2016-04-16 10:10:32 +0000386
Rui Ueyama7c18c282016-04-18 21:00:40 +0000387 // Assign addresses as instructed by linker script SECTIONS sub-commands.
Rui Ueyama4f7500b2016-08-12 04:00:22 +0000388 Dot = getHeaderSize();
Eugene Leviant467c4d52016-07-01 10:27:36 +0000389 uintX_t MinVA = std::numeric_limits<uintX_t>::max();
George Rimar652852c2016-04-16 10:10:32 +0000390 uintX_t ThreadBssOffset = 0;
George Rimar652852c2016-04-16 10:10:32 +0000391
George Rimar076fe152016-07-21 06:43:01 +0000392 for (const std::unique_ptr<BaseCommand> &Base : Opt.Commands) {
393 if (auto *Cmd = dyn_cast<SymbolAssignment>(Base.get())) {
Rui Ueyama8d083e62016-07-29 05:48:39 +0000394 if (Cmd->Name == ".") {
395 Dot = Cmd->Expression(Dot);
396 } else if (Cmd->Sym) {
397 cast<DefinedRegular<ELFT>>(Cmd->Sym)->Value = Cmd->Expression(Dot);
398 }
George Rimar652852c2016-04-16 10:10:32 +0000399 continue;
400 }
401
George Rimareefa7582016-08-04 09:29:31 +0000402 if (auto *Cmd = dyn_cast<AssertCommand>(Base.get())) {
403 Cmd->Expression(Dot);
404 continue;
405 }
406
George Rimar076fe152016-07-21 06:43:01 +0000407 auto *Cmd = cast<OutputSectionCommand>(Base.get());
George Rimara14b13d2016-09-07 10:46:07 +0000408 for (OutputSectionBase<ELFT> *Sec :
409 findSections<ELFT>(*Cmd, *OutputSections)) {
George Rimar652852c2016-04-16 10:10:32 +0000410
George Rimara14b13d2016-09-07 10:46:07 +0000411 if (Cmd->AddrExpr)
412 Dot = Cmd->AddrExpr(Dot);
George Rimar58e5c4d2016-07-25 08:29:46 +0000413
George Rimara14b13d2016-09-07 10:46:07 +0000414 if (Cmd->AlignExpr)
415 Sec->updateAlignment(Cmd->AlignExpr(Dot));
George Rimar630c6172016-07-26 18:06:29 +0000416
George Rimara14b13d2016-09-07 10:46:07 +0000417 if ((Sec->getFlags() & SHF_TLS) && Sec->getType() == SHT_NOBITS) {
418 uintX_t TVA = Dot + ThreadBssOffset;
419 TVA = alignTo(TVA, Sec->getAlignment());
420 Sec->setVA(TVA);
421 assignOffsets(Cmd, Sec);
422 ThreadBssOffset = TVA - Dot + Sec->getSize();
423 continue;
424 }
425
426 if (!(Sec->getFlags() & SHF_ALLOC)) {
427 assignOffsets(Cmd, Sec);
428 continue;
429 }
430
431 Dot = alignTo(Dot, Sec->getAlignment());
432 Sec->setVA(Dot);
Eugene Leviant20889c52016-08-31 08:13:33 +0000433 assignOffsets(Cmd, Sec);
George Rimara14b13d2016-09-07 10:46:07 +0000434 MinVA = std::min(MinVA, Dot);
435 Dot += Sec->getSize();
George Rimar652852c2016-04-16 10:10:32 +0000436 }
437 }
Rui Ueyama52c4e172016-07-01 10:42:25 +0000438
Rafael Espindola64c32d62016-07-07 14:28:47 +0000439 // ELF and Program headers need to be right before the first section in
George Rimarb91e7112016-07-19 07:42:07 +0000440 // memory. Set their addresses accordingly.
Eugene Leviant467c4d52016-07-01 10:27:36 +0000441 MinVA = alignDown(MinVA - Out<ELFT>::ElfHeader->getSize() -
442 Out<ELFT>::ProgramHeaders->getSize(),
443 Target->PageSize);
444 Out<ELFT>::ElfHeader->setVA(MinVA);
445 Out<ELFT>::ProgramHeaders->setVA(Out<ELFT>::ElfHeader->getSize() + MinVA);
George Rimar652852c2016-04-16 10:10:32 +0000446}
447
Rui Ueyama464daad2016-08-22 04:55:20 +0000448// Creates program headers as instructed by PHDRS linker script command.
Rui Ueyama07320e42016-04-20 20:13:41 +0000449template <class ELFT>
Rafael Espindolaa4b41dc2016-08-04 12:13:05 +0000450std::vector<PhdrEntry<ELFT>> LinkerScript<ELFT>::createPhdrs() {
Rui Ueyamaedebbdf2016-07-24 23:47:31 +0000451 std::vector<PhdrEntry<ELFT>> Ret;
Eugene Leviantbbe38602016-07-19 09:25:43 +0000452
Rui Ueyama464daad2016-08-22 04:55:20 +0000453 // Process PHDRS and FILEHDR keywords because they are not
454 // real output sections and cannot be added in the following loop.
Eugene Leviantbbe38602016-07-19 09:25:43 +0000455 for (const PhdrsCommand &Cmd : Opt.PhdrsCommands) {
Rui Ueyamaedebbdf2016-07-24 23:47:31 +0000456 Ret.emplace_back(Cmd.Type, Cmd.Flags == UINT_MAX ? PF_R : Cmd.Flags);
457 PhdrEntry<ELFT> &Phdr = Ret.back();
Eugene Leviantbbe38602016-07-19 09:25:43 +0000458
459 if (Cmd.HasFilehdr)
Rui Ueyamaadca2452016-07-23 14:18:48 +0000460 Phdr.add(Out<ELFT>::ElfHeader);
Eugene Leviantbbe38602016-07-19 09:25:43 +0000461 if (Cmd.HasPhdrs)
Rui Ueyamaadca2452016-07-23 14:18:48 +0000462 Phdr.add(Out<ELFT>::ProgramHeaders);
Eugene Leviant56b21c82016-09-09 09:46:16 +0000463
464 if (Cmd.LMAExpr) {
465 Phdr.H.p_paddr = Cmd.LMAExpr(0);
466 Phdr.HasLMA = true;
467 }
Eugene Leviantbbe38602016-07-19 09:25:43 +0000468 }
469
Rui Ueyama464daad2016-08-22 04:55:20 +0000470 // Add output sections to program headers.
Rui Ueyamaedebbdf2016-07-24 23:47:31 +0000471 PhdrEntry<ELFT> *Load = nullptr;
472 uintX_t Flags = PF_R;
Rui Ueyama464daad2016-08-22 04:55:20 +0000473 for (OutputSectionBase<ELFT> *Sec : *OutputSections) {
Eugene Leviantbbe38602016-07-19 09:25:43 +0000474 if (!(Sec->getFlags() & SHF_ALLOC))
475 break;
476
Rui Ueyamaedebbdf2016-07-24 23:47:31 +0000477 std::vector<size_t> PhdrIds = getPhdrIndices(Sec->getName());
Eugene Leviantbbe38602016-07-19 09:25:43 +0000478 if (!PhdrIds.empty()) {
479 // Assign headers specified by linker script
480 for (size_t Id : PhdrIds) {
Rui Ueyamaedebbdf2016-07-24 23:47:31 +0000481 Ret[Id].add(Sec);
Eugene Leviant865bf862016-07-21 10:43:25 +0000482 if (Opt.PhdrsCommands[Id].Flags == UINT_MAX)
Rafael Espindola0b113672016-07-27 14:10:56 +0000483 Ret[Id].H.p_flags |= Sec->getPhdrFlags();
Eugene Leviantbbe38602016-07-19 09:25:43 +0000484 }
485 } else {
486 // If we have no load segment or flags've changed then we want new load
487 // segment.
Rafael Espindola0b113672016-07-27 14:10:56 +0000488 uintX_t NewFlags = Sec->getPhdrFlags();
Eugene Leviantbbe38602016-07-19 09:25:43 +0000489 if (Load == nullptr || Flags != NewFlags) {
Rui Ueyamaedebbdf2016-07-24 23:47:31 +0000490 Load = &*Ret.emplace(Ret.end(), PT_LOAD, NewFlags);
Eugene Leviantbbe38602016-07-19 09:25:43 +0000491 Flags = NewFlags;
492 }
Rui Ueyama18f084f2016-07-20 19:36:41 +0000493 Load->add(Sec);
Eugene Leviantbbe38602016-07-19 09:25:43 +0000494 }
Eugene Leviantbbe38602016-07-19 09:25:43 +0000495 }
Rui Ueyamaedebbdf2016-07-24 23:47:31 +0000496 return Ret;
Eugene Leviantbbe38602016-07-19 09:25:43 +0000497}
498
Eugene Leviantf9bc3bd2016-08-16 06:40:58 +0000499template <class ELFT> bool LinkerScript<ELFT>::ignoreInterpSection() {
500 // Ignore .interp section in case we have PHDRS specification
501 // and PT_INTERP isn't listed.
502 return !Opt.PhdrsCommands.empty() &&
503 llvm::find_if(Opt.PhdrsCommands, [](const PhdrsCommand &Cmd) {
504 return Cmd.Type == PT_INTERP;
505 }) == Opt.PhdrsCommands.end();
506}
507
Eugene Leviantbbe38602016-07-19 09:25:43 +0000508template <class ELFT>
Rui Ueyama07320e42016-04-20 20:13:41 +0000509ArrayRef<uint8_t> LinkerScript<ELFT>::getFiller(StringRef Name) {
George Rimarf6c3cce2016-07-21 07:48:54 +0000510 for (const std::unique_ptr<BaseCommand> &Base : Opt.Commands)
511 if (auto *Cmd = dyn_cast<OutputSectionCommand>(Base.get()))
512 if (Cmd->Name == Name)
513 return Cmd->Filler;
514 return {};
George Rimare2ee72b2016-02-26 14:48:31 +0000515}
516
George Rimar206fffa2016-08-17 08:16:57 +0000517template <class ELFT> Expr LinkerScript<ELFT>::getLma(StringRef Name) {
George Rimar8ceadb32016-08-17 07:44:19 +0000518 for (const std::unique_ptr<BaseCommand> &Base : Opt.Commands)
519 if (auto *Cmd = dyn_cast<OutputSectionCommand>(Base.get()))
520 if (Cmd->LmaExpr && Cmd->Name == Name)
521 return Cmd->LmaExpr;
522 return {};
523}
524
Rui Ueyamac3e2a4b2016-04-21 20:30:00 +0000525// Returns the index of the given section name in linker script
526// SECTIONS commands. Sections are laid out as the same order as they
527// were in the script. If a given name did not appear in the script,
528// it returns INT_MAX, so that it will be laid out at end of file.
George Rimar076fe152016-07-21 06:43:01 +0000529template <class ELFT> int LinkerScript<ELFT>::getSectionIndex(StringRef Name) {
Rui Ueyamaf510fa62016-07-26 00:21:15 +0000530 int I = 0;
531 for (std::unique_ptr<BaseCommand> &Base : Opt.Commands) {
532 if (auto *Cmd = dyn_cast<OutputSectionCommand>(Base.get()))
533 if (Cmd->Name == Name)
534 return I;
535 ++I;
536 }
537 return INT_MAX;
George Rimar71b26e92016-04-21 10:22:02 +0000538}
539
540// A compartor to sort output sections. Returns -1 or 1 if
541// A or B are mentioned in linker script. Otherwise, returns 0.
Rui Ueyama07320e42016-04-20 20:13:41 +0000542template <class ELFT>
543int LinkerScript<ELFT>::compareSections(StringRef A, StringRef B) {
Rui Ueyamac3e2a4b2016-04-21 20:30:00 +0000544 int I = getSectionIndex(A);
545 int J = getSectionIndex(B);
546 if (I == INT_MAX && J == INT_MAX)
Rui Ueyama717677a2016-02-11 21:17:59 +0000547 return 0;
548 return I < J ? -1 : 1;
549}
550
Eugene Leviantbbe38602016-07-19 09:25:43 +0000551template <class ELFT> bool LinkerScript<ELFT>::hasPhdrsCommands() {
552 return !Opt.PhdrsCommands.empty();
553}
554
George Rimar9e694502016-07-29 16:18:47 +0000555template <class ELFT>
George Rimar884e7862016-09-08 08:19:13 +0000556uint64_t LinkerScript<ELFT>::getOutputSectionAddress(StringRef Name) {
George Rimar96659df2016-08-30 09:54:01 +0000557 for (OutputSectionBase<ELFT> *Sec : *OutputSections)
558 if (Sec->getName() == Name)
559 return Sec->getVA();
560 error("undefined section " + Name);
561 return 0;
562}
563
564template <class ELFT>
George Rimar884e7862016-09-08 08:19:13 +0000565uint64_t LinkerScript<ELFT>::getOutputSectionSize(StringRef Name) {
George Rimar9e694502016-07-29 16:18:47 +0000566 for (OutputSectionBase<ELFT> *Sec : *OutputSections)
567 if (Sec->getName() == Name)
568 return Sec->getSize();
569 error("undefined section " + Name);
570 return 0;
571}
572
Eugene Leviant36fac7f2016-09-08 09:08:30 +0000573template <class ELFT>
574uint64_t LinkerScript<ELFT>::getOutputSectionAlign(StringRef Name) {
575 for (OutputSectionBase<ELFT> *Sec : *OutputSections)
576 if (Sec->getName() == Name)
577 return Sec->getAlignment();
578 error("undefined section " + Name);
579 return 0;
580}
581
George Rimar884e7862016-09-08 08:19:13 +0000582template <class ELFT> uint64_t LinkerScript<ELFT>::getHeaderSize() {
George Rimare32a3592016-08-10 07:59:34 +0000583 return Out<ELFT>::ElfHeader->getSize() + Out<ELFT>::ProgramHeaders->getSize();
584}
585
George Rimar884e7862016-09-08 08:19:13 +0000586template <class ELFT> uint64_t LinkerScript<ELFT>::getSymbolValue(StringRef S) {
587 if (SymbolBody *B = Symtab<ELFT>::X->find(S))
588 return B->getVA<ELFT>();
589 error("symbol not found: " + S);
590 return 0;
591}
592
Eugene Leviantbbe38602016-07-19 09:25:43 +0000593// Returns indices of ELF headers containing specific section, identified
594// by Name. Each index is a zero based number of ELF header listed within
595// PHDRS {} script block.
596template <class ELFT>
Rui Ueyamaedebbdf2016-07-24 23:47:31 +0000597std::vector<size_t> LinkerScript<ELFT>::getPhdrIndices(StringRef SectionName) {
George Rimar076fe152016-07-21 06:43:01 +0000598 for (const std::unique_ptr<BaseCommand> &Base : Opt.Commands) {
599 auto *Cmd = dyn_cast<OutputSectionCommand>(Base.get());
Rui Ueyamaedebbdf2016-07-24 23:47:31 +0000600 if (!Cmd || Cmd->Name != SectionName)
George Rimar31d842f2016-07-20 16:43:03 +0000601 continue;
602
Rui Ueyama29c5a2a2016-07-26 00:27:36 +0000603 std::vector<size_t> Ret;
604 for (StringRef PhdrName : Cmd->Phdrs)
605 Ret.push_back(getPhdrIndex(PhdrName));
606 return Ret;
Eugene Leviantbbe38602016-07-19 09:25:43 +0000607 }
George Rimar31d842f2016-07-20 16:43:03 +0000608 return {};
Eugene Leviantbbe38602016-07-19 09:25:43 +0000609}
610
Rui Ueyama29c5a2a2016-07-26 00:27:36 +0000611template <class ELFT>
612size_t LinkerScript<ELFT>::getPhdrIndex(StringRef PhdrName) {
613 size_t I = 0;
614 for (PhdrsCommand &Cmd : Opt.PhdrsCommands) {
615 if (Cmd.Name == PhdrName)
616 return I;
617 ++I;
618 }
619 error("section header '" + PhdrName + "' is not listed in PHDRS");
620 return 0;
621}
622
Rui Ueyama07320e42016-04-20 20:13:41 +0000623class elf::ScriptParser : public ScriptParserBase {
George Rimarc3794e52016-02-24 09:21:47 +0000624 typedef void (ScriptParser::*Handler)();
625
Rui Ueyamaf7c5fbb2015-09-30 17:23:26 +0000626public:
Rui Ueyama07320e42016-04-20 20:13:41 +0000627 ScriptParser(StringRef S, bool B) : ScriptParserBase(S), IsUnderSysroot(B) {}
George Rimarf23b2322016-02-19 10:45:45 +0000628
George Rimar20b65982016-08-31 09:08:26 +0000629 void readLinkerScript();
630 void readVersionScript();
Rui Ueyamaf7c5fbb2015-09-30 17:23:26 +0000631
632private:
Rui Ueyama52a15092015-10-11 03:28:42 +0000633 void addFile(StringRef Path);
634
Rui Ueyamaf7c5fbb2015-09-30 17:23:26 +0000635 void readAsNeeded();
Denis Protivensky90c50992015-10-08 06:48:38 +0000636 void readEntry();
George Rimar83f406c2015-10-19 17:35:12 +0000637 void readExtern();
Rui Ueyamaf7c5fbb2015-09-30 17:23:26 +0000638 void readGroup();
Rui Ueyama31aa1f82015-10-11 01:31:55 +0000639 void readInclude();
Rui Ueyamaee592822015-10-07 00:25:09 +0000640 void readOutput();
Davide Italiano9159ce92015-10-12 21:50:08 +0000641 void readOutputArch();
Rui Ueyamaf7c5fbb2015-09-30 17:23:26 +0000642 void readOutputFormat();
Eugene Leviantbbe38602016-07-19 09:25:43 +0000643 void readPhdrs();
Davide Italiano68a39a62015-10-08 17:51:41 +0000644 void readSearchDir();
Denis Protivensky8e3b38a2015-11-12 09:52:08 +0000645 void readSections();
Rui Ueyama95769b42016-08-31 20:03:54 +0000646 void readVersion();
647 void readVersionScriptCommand();
Denis Protivensky8e3b38a2015-11-12 09:52:08 +0000648
Rui Ueyama113cdec2016-07-24 23:05:57 +0000649 SymbolAssignment *readAssignment(StringRef Name);
George Rimarff1f29e2016-09-06 13:51:57 +0000650 std::vector<uint8_t> readFill();
Rui Ueyama10416562016-08-04 02:03:27 +0000651 OutputSectionCommand *readOutputSectionDescription(StringRef OutSec);
George Rimarff1f29e2016-09-06 13:51:57 +0000652 std::vector<uint8_t> readOutputSectionFiller(StringRef Tok);
Eugene Leviantbbe38602016-07-19 09:25:43 +0000653 std::vector<StringRef> readOutputSectionPhdrs();
George Rimara2496cb2016-08-30 09:46:59 +0000654 InputSectionDescription *readInputSectionDescription(StringRef Tok);
George Rimarc91930a2016-09-02 21:17:20 +0000655 Regex readFilePatterns();
George Rimara2496cb2016-08-30 09:46:59 +0000656 InputSectionDescription *readInputSectionRules(StringRef FilePattern);
Eugene Leviantbbe38602016-07-19 09:25:43 +0000657 unsigned readPhdrType();
Rui Ueyama742c3832016-08-04 22:27:00 +0000658 SortKind readSortKind();
Petr Hoseka35e39c2016-08-16 01:11:16 +0000659 SymbolAssignment *readProvideHidden(bool Provide, bool Hidden);
Eugene Leviantdb741e72016-09-07 07:08:43 +0000660 SymbolAssignment *readProvideOrAssignment(StringRef Tok, bool MakeAbsolute);
George Rimar03fc0102016-07-28 07:18:23 +0000661 void readSort();
George Rimareefa7582016-08-04 09:29:31 +0000662 Expr readAssert();
Rui Ueyama708019c2016-07-24 18:19:40 +0000663
664 Expr readExpr();
665 Expr readExpr1(Expr Lhs, int MinPrec);
666 Expr readPrimary();
667 Expr readTernary(Expr Cond);
Rui Ueyama6ad7dfc2016-08-17 18:59:16 +0000668 Expr readParenExpr();
Rui Ueyamaf7c5fbb2015-09-30 17:23:26 +0000669
George Rimar20b65982016-08-31 09:08:26 +0000670 // For parsing version script.
671 void readExtern(std::vector<SymbolVersion> *Globals);
Rui Ueyama95769b42016-08-31 20:03:54 +0000672 void readVersionDeclaration(StringRef VerStr);
George Rimar20b65982016-08-31 09:08:26 +0000673 void readGlobal(StringRef VerStr);
674 void readLocal();
675
Rui Ueyama07320e42016-04-20 20:13:41 +0000676 ScriptConfiguration &Opt = *ScriptConfig;
677 StringSaver Saver = {ScriptConfig->Alloc};
Simon Atanasyan16b0cc92015-11-26 05:53:00 +0000678 bool IsUnderSysroot;
Rui Ueyamaf7c5fbb2015-09-30 17:23:26 +0000679};
Rui Ueyamaf7c5fbb2015-09-30 17:23:26 +0000680
George Rimar20b65982016-08-31 09:08:26 +0000681void ScriptParser::readVersionScript() {
Rui Ueyama95769b42016-08-31 20:03:54 +0000682 readVersionScriptCommand();
683 if (!atEOF())
684 setError("EOF expected, but got " + next());
685}
686
687void ScriptParser::readVersionScriptCommand() {
George Rimar20b65982016-08-31 09:08:26 +0000688 if (skip("{")) {
Rui Ueyama95769b42016-08-31 20:03:54 +0000689 readVersionDeclaration("");
George Rimar20b65982016-08-31 09:08:26 +0000690 return;
691 }
692
Rui Ueyama95769b42016-08-31 20:03:54 +0000693 while (!atEOF() && !Error && peek() != "}") {
George Rimar20b65982016-08-31 09:08:26 +0000694 StringRef VerStr = next();
695 if (VerStr == "{") {
Rui Ueyama95769b42016-08-31 20:03:54 +0000696 setError("anonymous version definition is used in "
697 "combination with other version definitions");
George Rimar20b65982016-08-31 09:08:26 +0000698 return;
699 }
700 expect("{");
Rui Ueyama95769b42016-08-31 20:03:54 +0000701 readVersionDeclaration(VerStr);
George Rimar20b65982016-08-31 09:08:26 +0000702 }
703}
704
Rui Ueyama95769b42016-08-31 20:03:54 +0000705void ScriptParser::readVersion() {
706 expect("{");
707 readVersionScriptCommand();
708 expect("}");
709}
710
George Rimar20b65982016-08-31 09:08:26 +0000711void ScriptParser::readLinkerScript() {
Rui Ueyamaf7c5fbb2015-09-30 17:23:26 +0000712 while (!atEOF()) {
713 StringRef Tok = next();
Rui Ueyamaa27eecc2016-09-02 18:52:41 +0000714 if (Tok == ";")
715 continue;
716
717 if (Tok == "ENTRY") {
718 readEntry();
719 } else if (Tok == "EXTERN") {
720 readExtern();
721 } else if (Tok == "GROUP" || Tok == "INPUT") {
722 readGroup();
723 } else if (Tok == "INCLUDE") {
724 readInclude();
725 } else if (Tok == "OUTPUT") {
726 readOutput();
727 } else if (Tok == "OUTPUT_ARCH") {
728 readOutputArch();
729 } else if (Tok == "OUTPUT_FORMAT") {
730 readOutputFormat();
731 } else if (Tok == "PHDRS") {
732 readPhdrs();
733 } else if (Tok == "SEARCH_DIR") {
734 readSearchDir();
735 } else if (Tok == "SECTIONS") {
736 readSections();
737 } else if (Tok == "VERSION") {
738 readVersion();
Eugene Leviantdb741e72016-09-07 07:08:43 +0000739 } else if (SymbolAssignment *Cmd = readProvideOrAssignment(Tok, true)) {
Petr Hoseke5d3ca52016-08-31 15:31:17 +0000740 if (Opt.HasContents)
741 Opt.Commands.emplace_back(Cmd);
742 else
743 Opt.Assignments.emplace_back(Cmd);
744 } else {
George Rimar57610422016-03-11 14:43:02 +0000745 setError("unknown directive: " + Tok);
Petr Hoseke5d3ca52016-08-31 15:31:17 +0000746 }
Rui Ueyamaf7c5fbb2015-09-30 17:23:26 +0000747 }
748}
749
Rui Ueyama717677a2016-02-11 21:17:59 +0000750void ScriptParser::addFile(StringRef S) {
Simon Atanasyan16b0cc92015-11-26 05:53:00 +0000751 if (IsUnderSysroot && S.startswith("/")) {
752 SmallString<128> Path;
753 (Config->Sysroot + S).toStringRef(Path);
754 if (sys::fs::exists(Path)) {
755 Driver->addFile(Saver.save(Path.str()));
756 return;
757 }
758 }
759
Rui Ueyamaf03f3cc2015-10-13 00:09:21 +0000760 if (sys::path::is_absolute(S)) {
Rui Ueyama52a15092015-10-11 03:28:42 +0000761 Driver->addFile(S);
762 } else if (S.startswith("=")) {
763 if (Config->Sysroot.empty())
764 Driver->addFile(S.substr(1));
765 else
766 Driver->addFile(Saver.save(Config->Sysroot + "/" + S.substr(1)));
767 } else if (S.startswith("-l")) {
Rui Ueyama21eecb42016-02-02 21:13:09 +0000768 Driver->addLibrary(S.substr(2));
Simon Atanasyana1b8fc32015-11-26 20:23:46 +0000769 } else if (sys::fs::exists(S)) {
770 Driver->addFile(S);
Rui Ueyama52a15092015-10-11 03:28:42 +0000771 } else {
772 std::string Path = findFromSearchPaths(S);
773 if (Path.empty())
George Rimar777f9632016-03-12 08:31:34 +0000774 setError("unable to find " + S);
Rui Ueyama025d59b2016-02-02 20:27:59 +0000775 else
776 Driver->addFile(Saver.save(Path));
Rui Ueyama52a15092015-10-11 03:28:42 +0000777 }
778}
779
Rui Ueyama717677a2016-02-11 21:17:59 +0000780void ScriptParser::readAsNeeded() {
Rui Ueyamaf7c5fbb2015-09-30 17:23:26 +0000781 expect("(");
Rui Ueyama35da9b62015-10-11 20:59:12 +0000782 bool Orig = Config->AsNeeded;
783 Config->AsNeeded = true;
Rui Ueyamaa2acc932016-08-05 01:25:45 +0000784 while (!Error && !skip(")"))
George Rimarcd574a52016-09-09 14:35:36 +0000785 addFile(unquote(next()));
Rui Ueyama35da9b62015-10-11 20:59:12 +0000786 Config->AsNeeded = Orig;
Rui Ueyamaf7c5fbb2015-09-30 17:23:26 +0000787}
788
Rui Ueyama717677a2016-02-11 21:17:59 +0000789void ScriptParser::readEntry() {
Denis Protivensky90c50992015-10-08 06:48:38 +0000790 // -e <symbol> takes predecence over ENTRY(<symbol>).
791 expect("(");
792 StringRef Tok = next();
793 if (Config->Entry.empty())
794 Config->Entry = Tok;
795 expect(")");
796}
797
Rui Ueyama717677a2016-02-11 21:17:59 +0000798void ScriptParser::readExtern() {
George Rimar83f406c2015-10-19 17:35:12 +0000799 expect("(");
Rui Ueyamaa2acc932016-08-05 01:25:45 +0000800 while (!Error && !skip(")"))
801 Config->Undefined.push_back(next());
George Rimar83f406c2015-10-19 17:35:12 +0000802}
803
Rui Ueyama717677a2016-02-11 21:17:59 +0000804void ScriptParser::readGroup() {
Rui Ueyamaf7c5fbb2015-09-30 17:23:26 +0000805 expect("(");
Rui Ueyamaa2acc932016-08-05 01:25:45 +0000806 while (!Error && !skip(")")) {
Rui Ueyamaf7c5fbb2015-09-30 17:23:26 +0000807 StringRef Tok = next();
Rui Ueyamaa2acc932016-08-05 01:25:45 +0000808 if (Tok == "AS_NEEDED")
Rui Ueyamaf7c5fbb2015-09-30 17:23:26 +0000809 readAsNeeded();
Rui Ueyamaa2acc932016-08-05 01:25:45 +0000810 else
George Rimarcd574a52016-09-09 14:35:36 +0000811 addFile(unquote(Tok));
Rui Ueyamaf7c5fbb2015-09-30 17:23:26 +0000812 }
813}
814
Rui Ueyama717677a2016-02-11 21:17:59 +0000815void ScriptParser::readInclude() {
Rui Ueyama31aa1f82015-10-11 01:31:55 +0000816 StringRef Tok = next();
George Rimarcd574a52016-09-09 14:35:36 +0000817 auto MBOrErr = MemoryBuffer::getFile(unquote(Tok));
Rui Ueyama025d59b2016-02-02 20:27:59 +0000818 if (!MBOrErr) {
George Rimar57610422016-03-11 14:43:02 +0000819 setError("cannot open " + Tok);
Rui Ueyama025d59b2016-02-02 20:27:59 +0000820 return;
821 }
Rui Ueyama31aa1f82015-10-11 01:31:55 +0000822 std::unique_ptr<MemoryBuffer> &MB = *MBOrErr;
Rui Ueyamaa47ee682015-10-11 01:53:04 +0000823 StringRef S = Saver.save(MB->getMemBufferRef().getBuffer());
824 std::vector<StringRef> V = tokenize(S);
Rui Ueyama31aa1f82015-10-11 01:31:55 +0000825 Tokens.insert(Tokens.begin() + Pos, V.begin(), V.end());
Rui Ueyama31aa1f82015-10-11 01:31:55 +0000826}
827
Rui Ueyama717677a2016-02-11 21:17:59 +0000828void ScriptParser::readOutput() {
Rui Ueyamaee592822015-10-07 00:25:09 +0000829 // -o <file> takes predecence over OUTPUT(<file>).
830 expect("(");
831 StringRef Tok = next();
832 if (Config->OutputFile.empty())
George Rimarcd574a52016-09-09 14:35:36 +0000833 Config->OutputFile = unquote(Tok);
Rui Ueyamaee592822015-10-07 00:25:09 +0000834 expect(")");
835}
836
Rui Ueyama717677a2016-02-11 21:17:59 +0000837void ScriptParser::readOutputArch() {
Davide Italiano9159ce92015-10-12 21:50:08 +0000838 // Error checking only for now.
839 expect("(");
840 next();
841 expect(")");
842}
843
Rui Ueyama717677a2016-02-11 21:17:59 +0000844void ScriptParser::readOutputFormat() {
Rui Ueyamaf7c5fbb2015-09-30 17:23:26 +0000845 // Error checking only for now.
846 expect("(");
847 next();
Davide Italiano6836c612015-10-12 21:08:41 +0000848 StringRef Tok = next();
849 if (Tok == ")")
George Rimar6c55f0e2016-09-08 08:20:30 +0000850 return;
Rui Ueyama025d59b2016-02-02 20:27:59 +0000851 if (Tok != ",") {
George Rimar57610422016-03-11 14:43:02 +0000852 setError("unexpected token: " + Tok);
Rui Ueyama025d59b2016-02-02 20:27:59 +0000853 return;
854 }
Davide Italiano6836c612015-10-12 21:08:41 +0000855 next();
856 expect(",");
857 next();
Rui Ueyamaf7c5fbb2015-09-30 17:23:26 +0000858 expect(")");
859}
860
Eugene Leviantbbe38602016-07-19 09:25:43 +0000861void ScriptParser::readPhdrs() {
862 expect("{");
863 while (!Error && !skip("}")) {
864 StringRef Tok = next();
Eugene Leviant56b21c82016-09-09 09:46:16 +0000865 Opt.PhdrsCommands.push_back(
866 {Tok, PT_NULL, false, false, UINT_MAX, nullptr});
Eugene Leviantbbe38602016-07-19 09:25:43 +0000867 PhdrsCommand &PhdrCmd = Opt.PhdrsCommands.back();
868
869 PhdrCmd.Type = readPhdrType();
870 do {
871 Tok = next();
872 if (Tok == ";")
873 break;
874 if (Tok == "FILEHDR")
875 PhdrCmd.HasFilehdr = true;
876 else if (Tok == "PHDRS")
877 PhdrCmd.HasPhdrs = true;
Eugene Leviant56b21c82016-09-09 09:46:16 +0000878 else if (Tok == "AT")
879 PhdrCmd.LMAExpr = readParenExpr();
Eugene Leviant865bf862016-07-21 10:43:25 +0000880 else if (Tok == "FLAGS") {
881 expect("(");
Rafael Espindolaeb685cd2016-08-02 22:14:57 +0000882 // Passing 0 for the value of dot is a bit of a hack. It means that
883 // we accept expressions like ".|1".
884 PhdrCmd.Flags = readExpr()(0);
Eugene Leviant865bf862016-07-21 10:43:25 +0000885 expect(")");
886 } else
Eugene Leviantbbe38602016-07-19 09:25:43 +0000887 setError("unexpected header attribute: " + Tok);
888 } while (!Error);
889 }
890}
891
Rui Ueyama717677a2016-02-11 21:17:59 +0000892void ScriptParser::readSearchDir() {
Davide Italiano68a39a62015-10-08 17:51:41 +0000893 expect("(");
Rui Ueyama86c5fb82016-09-08 23:26:54 +0000894 StringRef Tok = next();
Rui Ueyama6c7ad132016-09-02 19:20:33 +0000895 if (!Config->Nostdlib)
George Rimarcd574a52016-09-09 14:35:36 +0000896 Config->SearchPaths.push_back(unquote(Tok));
Davide Italiano68a39a62015-10-08 17:51:41 +0000897 expect(")");
898}
899
Rui Ueyama717677a2016-02-11 21:17:59 +0000900void ScriptParser::readSections() {
Rui Ueyama3de0a332016-07-29 03:31:09 +0000901 Opt.HasContents = true;
Denis Protivensky8e3b38a2015-11-12 09:52:08 +0000902 expect("{");
George Rimar652852c2016-04-16 10:10:32 +0000903 while (!Error && !skip("}")) {
Rui Ueyama113cdec2016-07-24 23:05:57 +0000904 StringRef Tok = next();
Eugene Leviantdb741e72016-09-07 07:08:43 +0000905 BaseCommand *Cmd = readProvideOrAssignment(Tok, true);
Eugene Leviantceabe802016-08-11 07:56:43 +0000906 if (!Cmd) {
907 if (Tok == "ASSERT")
908 Cmd = new AssertCommand(readAssert());
909 else
910 Cmd = readOutputSectionDescription(Tok);
Rui Ueyama708019c2016-07-24 18:19:40 +0000911 }
Rui Ueyama10416562016-08-04 02:03:27 +0000912 Opt.Commands.emplace_back(Cmd);
George Rimar652852c2016-04-16 10:10:32 +0000913 }
Denis Protivensky8e3b38a2015-11-12 09:52:08 +0000914}
915
Rui Ueyama708019c2016-07-24 18:19:40 +0000916static int precedence(StringRef Op) {
917 return StringSwitch<int>(Op)
918 .Case("*", 4)
919 .Case("/", 4)
920 .Case("+", 3)
921 .Case("-", 3)
922 .Case("<", 2)
923 .Case(">", 2)
924 .Case(">=", 2)
925 .Case("<=", 2)
926 .Case("==", 2)
927 .Case("!=", 2)
928 .Case("&", 1)
Rafael Espindolacc3dd622016-08-22 21:33:35 +0000929 .Case("|", 1)
Rui Ueyama708019c2016-07-24 18:19:40 +0000930 .Default(-1);
931}
932
George Rimarc91930a2016-09-02 21:17:20 +0000933Regex ScriptParser::readFilePatterns() {
Rui Ueyama10416562016-08-04 02:03:27 +0000934 std::vector<StringRef> V;
935 while (!Error && !skip(")"))
936 V.push_back(next());
George Rimarc91930a2016-09-02 21:17:20 +0000937 return compileGlobPatterns(V);
George Rimar0702c4e2016-07-29 15:32:46 +0000938}
939
Rui Ueyama742c3832016-08-04 22:27:00 +0000940SortKind ScriptParser::readSortKind() {
941 if (skip("SORT") || skip("SORT_BY_NAME"))
942 return SortByName;
943 if (skip("SORT_BY_ALIGNMENT"))
944 return SortByAlignment;
945 return SortNone;
946}
947
George Rimara2496cb2016-08-30 09:46:59 +0000948InputSectionDescription *
949ScriptParser::readInputSectionRules(StringRef FilePattern) {
George Rimarc91930a2016-09-02 21:17:20 +0000950 auto *Cmd = new InputSectionDescription(FilePattern);
Davide Italiano0ed42b02016-07-25 21:47:13 +0000951 expect("(");
Davide Italianoe7282792016-07-27 01:44:01 +0000952
Rui Ueyama742c3832016-08-04 22:27:00 +0000953 // Read EXCLUDE_FILE().
Davide Italianoe7282792016-07-27 01:44:01 +0000954 if (skip("EXCLUDE_FILE")) {
955 expect("(");
George Rimarc91930a2016-09-02 21:17:20 +0000956 Cmd->ExcludedFileRe = readFilePatterns();
Davide Italiano0ed42b02016-07-25 21:47:13 +0000957 }
George Rimar06598002016-07-28 21:51:30 +0000958
Rui Ueyama742c3832016-08-04 22:27:00 +0000959 // Read SORT().
960 if (SortKind K1 = readSortKind()) {
961 Cmd->SortOuter = K1;
George Rimar0702c4e2016-07-29 15:32:46 +0000962 expect("(");
Rui Ueyama742c3832016-08-04 22:27:00 +0000963 if (SortKind K2 = readSortKind()) {
964 Cmd->SortInner = K2;
George Rimar350ece42016-08-03 08:35:59 +0000965 expect("(");
George Rimarc91930a2016-09-02 21:17:20 +0000966 Cmd->SectionRe = readFilePatterns();
George Rimar350ece42016-08-03 08:35:59 +0000967 expect(")");
968 } else {
George Rimarc91930a2016-09-02 21:17:20 +0000969 Cmd->SectionRe = readFilePatterns();
George Rimar350ece42016-08-03 08:35:59 +0000970 }
George Rimar0702c4e2016-07-29 15:32:46 +0000971 expect(")");
Rui Ueyama10416562016-08-04 02:03:27 +0000972 return Cmd;
George Rimar06598002016-07-28 21:51:30 +0000973 }
George Rimar0702c4e2016-07-29 15:32:46 +0000974
George Rimarc91930a2016-09-02 21:17:20 +0000975 Cmd->SectionRe = readFilePatterns();
Rui Ueyama10416562016-08-04 02:03:27 +0000976 return Cmd;
Davide Italianoe7282792016-07-27 01:44:01 +0000977}
978
George Rimara2496cb2016-08-30 09:46:59 +0000979InputSectionDescription *
980ScriptParser::readInputSectionDescription(StringRef Tok) {
George Rimar06598002016-07-28 21:51:30 +0000981 // Input section wildcard can be surrounded by KEEP.
982 // https://sourceware.org/binutils/docs/ld/Input-Section-Keep.html#Input-Section-Keep
George Rimara2496cb2016-08-30 09:46:59 +0000983 if (Tok == "KEEP") {
George Rimar06598002016-07-28 21:51:30 +0000984 expect("(");
George Rimara2496cb2016-08-30 09:46:59 +0000985 StringRef FilePattern = next();
986 InputSectionDescription *Cmd = readInputSectionRules(FilePattern);
George Rimar06598002016-07-28 21:51:30 +0000987 expect(")");
George Rimarc91930a2016-09-02 21:17:20 +0000988 Opt.KeptSections.push_back(&Cmd->SectionRe);
Rui Ueyama10416562016-08-04 02:03:27 +0000989 return Cmd;
George Rimar06598002016-07-28 21:51:30 +0000990 }
George Rimara2496cb2016-08-30 09:46:59 +0000991 return readInputSectionRules(Tok);
Davide Italiano0ed42b02016-07-25 21:47:13 +0000992}
993
George Rimar03fc0102016-07-28 07:18:23 +0000994void ScriptParser::readSort() {
995 expect("(");
996 expect("CONSTRUCTORS");
997 expect(")");
998}
999
George Rimareefa7582016-08-04 09:29:31 +00001000Expr ScriptParser::readAssert() {
1001 expect("(");
1002 Expr E = readExpr();
1003 expect(",");
George Rimarcd574a52016-09-09 14:35:36 +00001004 StringRef Msg = unquote(next());
George Rimareefa7582016-08-04 09:29:31 +00001005 expect(")");
1006 return [=](uint64_t Dot) {
1007 uint64_t V = E(Dot);
1008 if (!V)
1009 error(Msg);
1010 return V;
1011 };
1012}
1013
Rui Ueyama25150e82016-09-06 17:46:43 +00001014// Reads a FILL(expr) command. We handle the FILL command as an
1015// alias for =fillexp section attribute, which is different from
1016// what GNU linkers do.
1017// https://sourceware.org/binutils/docs/ld/Output-Section-Data.html
George Rimarff1f29e2016-09-06 13:51:57 +00001018std::vector<uint8_t> ScriptParser::readFill() {
1019 expect("(");
1020 std::vector<uint8_t> V = readOutputSectionFiller(next());
1021 expect(")");
1022 expect(";");
1023 return V;
1024}
1025
Rui Ueyama10416562016-08-04 02:03:27 +00001026OutputSectionCommand *
1027ScriptParser::readOutputSectionDescription(StringRef OutSec) {
George Rimar076fe152016-07-21 06:43:01 +00001028 OutputSectionCommand *Cmd = new OutputSectionCommand(OutSec);
George Rimar58e5c4d2016-07-25 08:29:46 +00001029
1030 // Read an address expression.
1031 // https://sourceware.org/binutils/docs/ld/Output-Section-Address.html#Output-Section-Address
1032 if (peek() != ":")
1033 Cmd->AddrExpr = readExpr();
1034
Denis Protivensky8e3b38a2015-11-12 09:52:08 +00001035 expect(":");
Davide Italiano246f6812016-07-22 03:36:24 +00001036
George Rimar8ceadb32016-08-17 07:44:19 +00001037 if (skip("AT"))
Rui Ueyama6ad7dfc2016-08-17 18:59:16 +00001038 Cmd->LmaExpr = readParenExpr();
George Rimar630c6172016-07-26 18:06:29 +00001039 if (skip("ALIGN"))
Rui Ueyama6ad7dfc2016-08-17 18:59:16 +00001040 Cmd->AlignExpr = readParenExpr();
George Rimardb24d9c2016-08-19 15:18:23 +00001041 if (skip("SUBALIGN"))
1042 Cmd->SubalignExpr = readParenExpr();
George Rimar630c6172016-07-26 18:06:29 +00001043
Davide Italiano246f6812016-07-22 03:36:24 +00001044 // Parse constraints.
1045 if (skip("ONLY_IF_RO"))
Rui Ueyamaefc40662016-07-25 22:00:10 +00001046 Cmd->Constraint = ConstraintKind::ReadOnly;
Davide Italiano246f6812016-07-22 03:36:24 +00001047 if (skip("ONLY_IF_RW"))
Rui Ueyamaefc40662016-07-25 22:00:10 +00001048 Cmd->Constraint = ConstraintKind::ReadWrite;
Denis Protivensky8e3b38a2015-11-12 09:52:08 +00001049 expect("{");
Rui Ueyama8ec77e62016-04-21 22:00:51 +00001050
Rui Ueyama025d59b2016-02-02 20:27:59 +00001051 while (!Error && !skip("}")) {
Eugene Leviantceabe802016-08-11 07:56:43 +00001052 StringRef Tok = next();
Eugene Leviantdb741e72016-09-07 07:08:43 +00001053 if (SymbolAssignment *Assignment = readProvideOrAssignment(Tok, false))
Eugene Leviantceabe802016-08-11 07:56:43 +00001054 Cmd->Commands.emplace_back(Assignment);
George Rimarff1f29e2016-09-06 13:51:57 +00001055 else if (Tok == "FILL")
1056 Cmd->Filler = readFill();
Eugene Leviantceabe802016-08-11 07:56:43 +00001057 else if (Tok == "SORT")
George Rimar03fc0102016-07-28 07:18:23 +00001058 readSort();
George Rimara2496cb2016-08-30 09:46:59 +00001059 else if (peek() == "(")
1060 Cmd->Commands.emplace_back(readInputSectionDescription(Tok));
Eugene Leviantceabe802016-08-11 07:56:43 +00001061 else
1062 setError("unknown command " + Tok);
Denis Protivensky8e3b38a2015-11-12 09:52:08 +00001063 }
George Rimar076fe152016-07-21 06:43:01 +00001064 Cmd->Phdrs = readOutputSectionPhdrs();
George Rimarff1f29e2016-09-06 13:51:57 +00001065 if (peek().startswith("="))
1066 Cmd->Filler = readOutputSectionFiller(next().drop_front());
Rui Ueyama10416562016-08-04 02:03:27 +00001067 return Cmd;
Rui Ueyamaf71caa22016-07-29 06:14:07 +00001068}
Rui Ueyama8ec77e62016-04-21 22:00:51 +00001069
Rui Ueyama2c8f1f02016-08-29 22:01:21 +00001070// Read "=<number>" where <number> is an octal/decimal/hexadecimal number.
1071// https://sourceware.org/binutils/docs/ld/Output-Section-Fill.html
1072//
1073// ld.gold is not fully compatible with ld.bfd. ld.bfd handles
1074// hexstrings as blobs of arbitrary sizes, while ld.gold handles them
1075// as 32-bit big-endian values. We will do the same as ld.gold does
1076// because it's simpler than what ld.bfd does.
George Rimarff1f29e2016-09-06 13:51:57 +00001077std::vector<uint8_t> ScriptParser::readOutputSectionFiller(StringRef Tok) {
Rui Ueyama965827d2016-08-03 23:25:15 +00001078 uint32_t V;
George Rimarff1f29e2016-09-06 13:51:57 +00001079 if (Tok.getAsInteger(0, V)) {
Rui Ueyama965827d2016-08-03 23:25:15 +00001080 setError("invalid filler expression: " + Tok);
Rui Ueyamaf71caa22016-07-29 06:14:07 +00001081 return {};
George Rimare2ee72b2016-02-26 14:48:31 +00001082 }
Rui Ueyama2c8f1f02016-08-29 22:01:21 +00001083 return {uint8_t(V >> 24), uint8_t(V >> 16), uint8_t(V >> 8), uint8_t(V)};
Denis Protivensky8e3b38a2015-11-12 09:52:08 +00001084}
1085
Petr Hoseka35e39c2016-08-16 01:11:16 +00001086SymbolAssignment *ScriptParser::readProvideHidden(bool Provide, bool Hidden) {
Eugene Levianta31c91b2016-07-22 07:38:40 +00001087 expect("(");
Rui Ueyama174e0a12016-07-29 00:29:25 +00001088 SymbolAssignment *Cmd = readAssignment(next());
Petr Hoseka35e39c2016-08-16 01:11:16 +00001089 Cmd->Provide = Provide;
Rui Ueyama174e0a12016-07-29 00:29:25 +00001090 Cmd->Hidden = Hidden;
Eugene Levianta31c91b2016-07-22 07:38:40 +00001091 expect(")");
1092 expect(";");
Rui Ueyama10416562016-08-04 02:03:27 +00001093 return Cmd;
Eugene Levianteda81a12016-07-12 06:39:48 +00001094}
1095
Eugene Leviantdb741e72016-09-07 07:08:43 +00001096SymbolAssignment *ScriptParser::readProvideOrAssignment(StringRef Tok,
1097 bool MakeAbsolute) {
Eugene Leviantceabe802016-08-11 07:56:43 +00001098 SymbolAssignment *Cmd = nullptr;
1099 if (peek() == "=" || peek() == "+=") {
1100 Cmd = readAssignment(Tok);
1101 expect(";");
1102 } else if (Tok == "PROVIDE") {
Petr Hoseka35e39c2016-08-16 01:11:16 +00001103 Cmd = readProvideHidden(true, false);
1104 } else if (Tok == "HIDDEN") {
1105 Cmd = readProvideHidden(false, true);
Eugene Leviantceabe802016-08-11 07:56:43 +00001106 } else if (Tok == "PROVIDE_HIDDEN") {
Petr Hoseka35e39c2016-08-16 01:11:16 +00001107 Cmd = readProvideHidden(true, true);
Eugene Leviantceabe802016-08-11 07:56:43 +00001108 }
Eugene Leviantdb741e72016-09-07 07:08:43 +00001109 if (Cmd && MakeAbsolute)
1110 Cmd->IsAbsolute = true;
Eugene Leviantceabe802016-08-11 07:56:43 +00001111 return Cmd;
1112}
1113
George Rimar30835ea2016-07-28 21:08:56 +00001114static uint64_t getSymbolValue(StringRef S, uint64_t Dot) {
1115 if (S == ".")
1116 return Dot;
George Rimar884e7862016-09-08 08:19:13 +00001117 return ScriptBase->getSymbolValue(S);
George Rimare32a3592016-08-10 07:59:34 +00001118}
1119
George Rimar30835ea2016-07-28 21:08:56 +00001120SymbolAssignment *ScriptParser::readAssignment(StringRef Name) {
1121 StringRef Op = next();
Eugene Leviantdb741e72016-09-07 07:08:43 +00001122 bool IsAbsolute = false;
1123 Expr E;
George Rimar30835ea2016-07-28 21:08:56 +00001124 assert(Op == "=" || Op == "+=");
Eugene Leviantdb741e72016-09-07 07:08:43 +00001125 if (skip("ABSOLUTE")) {
1126 E = readParenExpr();
1127 IsAbsolute = true;
1128 } else {
1129 E = readExpr();
1130 }
George Rimar30835ea2016-07-28 21:08:56 +00001131 if (Op == "+=")
1132 E = [=](uint64_t Dot) { return getSymbolValue(Name, Dot) + E(Dot); };
Eugene Leviantdb741e72016-09-07 07:08:43 +00001133 return new SymbolAssignment(Name, E, IsAbsolute);
George Rimar30835ea2016-07-28 21:08:56 +00001134}
1135
1136// This is an operator-precedence parser to parse a linker
1137// script expression.
1138Expr ScriptParser::readExpr() { return readExpr1(readPrimary(), 0); }
1139
Rui Ueyama36c1cd22016-08-05 01:04:59 +00001140static Expr combine(StringRef Op, Expr L, Expr R) {
1141 if (Op == "*")
1142 return [=](uint64_t Dot) { return L(Dot) * R(Dot); };
1143 if (Op == "/") {
1144 return [=](uint64_t Dot) -> uint64_t {
1145 uint64_t RHS = R(Dot);
1146 if (RHS == 0) {
1147 error("division by zero");
1148 return 0;
1149 }
1150 return L(Dot) / RHS;
1151 };
1152 }
1153 if (Op == "+")
1154 return [=](uint64_t Dot) { return L(Dot) + R(Dot); };
1155 if (Op == "-")
1156 return [=](uint64_t Dot) { return L(Dot) - R(Dot); };
1157 if (Op == "<")
1158 return [=](uint64_t Dot) { return L(Dot) < R(Dot); };
1159 if (Op == ">")
1160 return [=](uint64_t Dot) { return L(Dot) > R(Dot); };
1161 if (Op == ">=")
1162 return [=](uint64_t Dot) { return L(Dot) >= R(Dot); };
1163 if (Op == "<=")
1164 return [=](uint64_t Dot) { return L(Dot) <= R(Dot); };
1165 if (Op == "==")
1166 return [=](uint64_t Dot) { return L(Dot) == R(Dot); };
1167 if (Op == "!=")
1168 return [=](uint64_t Dot) { return L(Dot) != R(Dot); };
1169 if (Op == "&")
1170 return [=](uint64_t Dot) { return L(Dot) & R(Dot); };
Rafael Espindolacc3dd622016-08-22 21:33:35 +00001171 if (Op == "|")
1172 return [=](uint64_t Dot) { return L(Dot) | R(Dot); };
Rui Ueyama36c1cd22016-08-05 01:04:59 +00001173 llvm_unreachable("invalid operator");
1174}
1175
Rui Ueyama708019c2016-07-24 18:19:40 +00001176// This is a part of the operator-precedence parser. This function
1177// assumes that the remaining token stream starts with an operator.
1178Expr ScriptParser::readExpr1(Expr Lhs, int MinPrec) {
1179 while (!atEOF() && !Error) {
1180 // Read an operator and an expression.
1181 StringRef Op1 = peek();
1182 if (Op1 == "?")
1183 return readTernary(Lhs);
1184 if (precedence(Op1) < MinPrec)
Eugene Levianteda81a12016-07-12 06:39:48 +00001185 break;
Rui Ueyama708019c2016-07-24 18:19:40 +00001186 next();
1187 Expr Rhs = readPrimary();
1188
1189 // Evaluate the remaining part of the expression first if the
1190 // next operator has greater precedence than the previous one.
1191 // For example, if we have read "+" and "3", and if the next
1192 // operator is "*", then we'll evaluate 3 * ... part first.
1193 while (!atEOF()) {
1194 StringRef Op2 = peek();
1195 if (precedence(Op2) <= precedence(Op1))
1196 break;
1197 Rhs = readExpr1(Rhs, precedence(Op2));
1198 }
1199
1200 Lhs = combine(Op1, Lhs, Rhs);
Eugene Levianteda81a12016-07-12 06:39:48 +00001201 }
Rui Ueyama708019c2016-07-24 18:19:40 +00001202 return Lhs;
1203}
1204
1205uint64_t static getConstant(StringRef S) {
Michael J. Spencere2cc07b2016-08-17 02:10:51 +00001206 if (S == "COMMONPAGESIZE")
Rui Ueyama708019c2016-07-24 18:19:40 +00001207 return Target->PageSize;
Michael J. Spencere2cc07b2016-08-17 02:10:51 +00001208 if (S == "MAXPAGESIZE")
1209 return Target->MaxPageSize;
Rui Ueyama708019c2016-07-24 18:19:40 +00001210 error("unknown constant: " + S);
1211 return 0;
1212}
1213
Rui Ueyama626e0b02016-09-02 18:19:00 +00001214// Parses Tok as an integer. Returns true if successful.
1215// It recognizes hexadecimal (prefixed with "0x" or suffixed with "H")
1216// and decimal numbers. Decimal numbers may have "K" (kilo) or
1217// "M" (mega) prefixes.
George Rimar9f2f7ad2016-09-02 16:01:42 +00001218static bool readInteger(StringRef Tok, uint64_t &Result) {
Simon Atanasyaneaeafb22016-09-02 21:54:35 +00001219 if (Tok.startswith("-")) {
1220 if (!readInteger(Tok.substr(1), Result))
1221 return false;
1222 Result = -Result;
1223 return true;
1224 }
George Rimar9f2f7ad2016-09-02 16:01:42 +00001225 if (Tok.startswith_lower("0x"))
1226 return !Tok.substr(2).getAsInteger(16, Result);
1227 if (Tok.endswith_lower("H"))
1228 return !Tok.drop_back().getAsInteger(16, Result);
1229
1230 int Suffix = 1;
1231 if (Tok.endswith_lower("K")) {
1232 Suffix = 1024;
1233 Tok = Tok.drop_back();
1234 } else if (Tok.endswith_lower("M")) {
1235 Suffix = 1024 * 1024;
1236 Tok = Tok.drop_back();
1237 }
1238 if (Tok.getAsInteger(10, Result))
1239 return false;
1240 Result *= Suffix;
1241 return true;
1242}
1243
Rui Ueyama708019c2016-07-24 18:19:40 +00001244Expr ScriptParser::readPrimary() {
Rui Ueyama6ad7dfc2016-08-17 18:59:16 +00001245 if (peek() == "(")
1246 return readParenExpr();
Rui Ueyama708019c2016-07-24 18:19:40 +00001247
Rui Ueyama6ad7dfc2016-08-17 18:59:16 +00001248 StringRef Tok = next();
Rui Ueyama708019c2016-07-24 18:19:40 +00001249
Simon Atanasyaneaeafb22016-09-02 21:54:35 +00001250 if (Tok == "~") {
1251 Expr E = readPrimary();
1252 return [=](uint64_t Dot) { return ~E(Dot); };
1253 }
1254 if (Tok == "-") {
1255 Expr E = readPrimary();
1256 return [=](uint64_t Dot) { return -E(Dot); };
1257 }
1258
Rui Ueyama708019c2016-07-24 18:19:40 +00001259 // Built-in functions are parsed here.
1260 // https://sourceware.org/binutils/docs/ld/Builtin-Functions.html.
George Rimar96659df2016-08-30 09:54:01 +00001261 if (Tok == "ADDR") {
1262 expect("(");
1263 StringRef Name = next();
1264 expect(")");
George Rimar884e7862016-09-08 08:19:13 +00001265 return
1266 [=](uint64_t Dot) { return ScriptBase->getOutputSectionAddress(Name); };
George Rimar96659df2016-08-30 09:54:01 +00001267 }
George Rimareefa7582016-08-04 09:29:31 +00001268 if (Tok == "ASSERT")
1269 return readAssert();
Rui Ueyama708019c2016-07-24 18:19:40 +00001270 if (Tok == "ALIGN") {
Rui Ueyama6ad7dfc2016-08-17 18:59:16 +00001271 Expr E = readParenExpr();
Rui Ueyama708019c2016-07-24 18:19:40 +00001272 return [=](uint64_t Dot) { return alignTo(Dot, E(Dot)); };
1273 }
1274 if (Tok == "CONSTANT") {
1275 expect("(");
1276 StringRef Tok = next();
1277 expect(")");
1278 return [=](uint64_t Dot) { return getConstant(Tok); };
1279 }
Rafael Espindola54c145c2016-07-28 18:16:24 +00001280 if (Tok == "SEGMENT_START") {
1281 expect("(");
1282 next();
1283 expect(",");
1284 uint64_t Val;
1285 next().getAsInteger(0, Val);
1286 expect(")");
1287 return [=](uint64_t Dot) { return Val; };
1288 }
Rui Ueyama708019c2016-07-24 18:19:40 +00001289 if (Tok == "DATA_SEGMENT_ALIGN") {
1290 expect("(");
1291 Expr E = readExpr();
1292 expect(",");
1293 readExpr();
1294 expect(")");
Rui Ueyamaf7791bb2016-07-26 19:34:10 +00001295 return [=](uint64_t Dot) { return alignTo(Dot, E(Dot)); };
Rui Ueyama708019c2016-07-24 18:19:40 +00001296 }
1297 if (Tok == "DATA_SEGMENT_END") {
1298 expect("(");
1299 expect(".");
1300 expect(")");
1301 return [](uint64_t Dot) { return Dot; };
1302 }
George Rimar276b4e62016-07-26 17:58:44 +00001303 // GNU linkers implements more complicated logic to handle
1304 // DATA_SEGMENT_RELRO_END. We instead ignore the arguments and just align to
1305 // the next page boundary for simplicity.
1306 if (Tok == "DATA_SEGMENT_RELRO_END") {
1307 expect("(");
1308 next();
1309 expect(",");
1310 readExpr();
1311 expect(")");
1312 return [](uint64_t Dot) { return alignTo(Dot, Target->PageSize); };
1313 }
George Rimar9e694502016-07-29 16:18:47 +00001314 if (Tok == "SIZEOF") {
1315 expect("(");
1316 StringRef Name = next();
1317 expect(")");
George Rimar884e7862016-09-08 08:19:13 +00001318 return [=](uint64_t Dot) { return ScriptBase->getOutputSectionSize(Name); };
George Rimar9e694502016-07-29 16:18:47 +00001319 }
Eugene Leviant36fac7f2016-09-08 09:08:30 +00001320 if (Tok == "ALIGNOF") {
1321 expect("(");
1322 StringRef Name = next();
1323 expect(")");
1324 return
1325 [=](uint64_t Dot) { return ScriptBase->getOutputSectionAlign(Name); };
1326 }
George Rimare32a3592016-08-10 07:59:34 +00001327 if (Tok == "SIZEOF_HEADERS")
George Rimar884e7862016-09-08 08:19:13 +00001328 return [=](uint64_t Dot) { return ScriptBase->getHeaderSize(); };
Rui Ueyama708019c2016-07-24 18:19:40 +00001329
George Rimar9f2f7ad2016-09-02 16:01:42 +00001330 // Tok is a literal number.
1331 uint64_t V;
1332 if (readInteger(Tok, V))
1333 return [=](uint64_t Dot) { return V; };
1334
1335 // Tok is a symbol name.
1336 if (Tok != "." && !isValidCIdentifier(Tok))
1337 setError("malformed number: " + Tok);
1338 return [=](uint64_t Dot) { return getSymbolValue(Tok, Dot); };
Rui Ueyama708019c2016-07-24 18:19:40 +00001339}
1340
1341Expr ScriptParser::readTernary(Expr Cond) {
1342 next();
1343 Expr L = readExpr();
1344 expect(":");
1345 Expr R = readExpr();
1346 return [=](uint64_t Dot) { return Cond(Dot) ? L(Dot) : R(Dot); };
1347}
1348
Rui Ueyama6ad7dfc2016-08-17 18:59:16 +00001349Expr ScriptParser::readParenExpr() {
1350 expect("(");
1351 Expr E = readExpr();
1352 expect(")");
1353 return E;
1354}
1355
Eugene Leviantbbe38602016-07-19 09:25:43 +00001356std::vector<StringRef> ScriptParser::readOutputSectionPhdrs() {
1357 std::vector<StringRef> Phdrs;
1358 while (!Error && peek().startswith(":")) {
1359 StringRef Tok = next();
1360 Tok = (Tok.size() == 1) ? next() : Tok.substr(1);
1361 if (Tok.empty()) {
1362 setError("section header name is empty");
1363 break;
1364 }
Rui Ueyama047404f2016-07-20 19:36:36 +00001365 Phdrs.push_back(Tok);
Eugene Leviantbbe38602016-07-19 09:25:43 +00001366 }
1367 return Phdrs;
1368}
1369
1370unsigned ScriptParser::readPhdrType() {
Eugene Leviantbbe38602016-07-19 09:25:43 +00001371 StringRef Tok = next();
Rui Ueyamab0f6c592016-07-20 19:36:38 +00001372 unsigned Ret = StringSwitch<unsigned>(Tok)
George Rimar6c55f0e2016-09-08 08:20:30 +00001373 .Case("PT_NULL", PT_NULL)
1374 .Case("PT_LOAD", PT_LOAD)
1375 .Case("PT_DYNAMIC", PT_DYNAMIC)
1376 .Case("PT_INTERP", PT_INTERP)
1377 .Case("PT_NOTE", PT_NOTE)
1378 .Case("PT_SHLIB", PT_SHLIB)
1379 .Case("PT_PHDR", PT_PHDR)
1380 .Case("PT_TLS", PT_TLS)
1381 .Case("PT_GNU_EH_FRAME", PT_GNU_EH_FRAME)
1382 .Case("PT_GNU_STACK", PT_GNU_STACK)
1383 .Case("PT_GNU_RELRO", PT_GNU_RELRO)
1384 .Default(-1);
Eugene Leviantbbe38602016-07-19 09:25:43 +00001385
Rui Ueyamab0f6c592016-07-20 19:36:38 +00001386 if (Ret == (unsigned)-1) {
1387 setError("invalid program header type: " + Tok);
1388 return PT_NULL;
1389 }
1390 return Ret;
Eugene Leviantbbe38602016-07-19 09:25:43 +00001391}
1392
Rui Ueyama95769b42016-08-31 20:03:54 +00001393void ScriptParser::readVersionDeclaration(StringRef VerStr) {
George Rimar20b65982016-08-31 09:08:26 +00001394 // Identifiers start at 2 because 0 and 1 are reserved
1395 // for VER_NDX_LOCAL and VER_NDX_GLOBAL constants.
1396 size_t VersionId = Config->VersionDefinitions.size() + 2;
1397 Config->VersionDefinitions.push_back({VerStr, VersionId});
1398
1399 if (skip("global:") || peek() != "local:")
1400 readGlobal(VerStr);
1401 if (skip("local:"))
1402 readLocal();
1403 expect("}");
1404
1405 // Each version may have a parent version. For example, "Ver2" defined as
1406 // "Ver2 { global: foo; local: *; } Ver1;" has "Ver1" as a parent. This
1407 // version hierarchy is, probably against your instinct, purely for human; the
1408 // runtime doesn't care about them at all. In LLD, we simply skip the token.
1409 if (!VerStr.empty() && peek() != ";")
1410 next();
1411 expect(";");
1412}
1413
1414void ScriptParser::readLocal() {
1415 Config->DefaultSymbolVersion = VER_NDX_LOCAL;
1416 expect("*");
1417 expect(";");
1418}
1419
1420void ScriptParser::readExtern(std::vector<SymbolVersion> *Globals) {
George Rimarcd574a52016-09-09 14:35:36 +00001421 expect("\"C++\"");
George Rimar20b65982016-08-31 09:08:26 +00001422 expect("{");
1423
1424 for (;;) {
1425 if (peek() == "}" || Error)
1426 break;
George Rimarcd574a52016-09-09 14:35:36 +00001427 bool HasWildcard = !peek().startswith("\"") && hasWildcard(peek());
1428 Globals->push_back({unquote(next()), true, HasWildcard});
George Rimar20b65982016-08-31 09:08:26 +00001429 expect(";");
1430 }
1431
1432 expect("}");
1433 expect(";");
1434}
1435
1436void ScriptParser::readGlobal(StringRef VerStr) {
1437 std::vector<SymbolVersion> *Globals;
1438 if (VerStr.empty())
1439 Globals = &Config->VersionScriptGlobals;
1440 else
1441 Globals = &Config->VersionDefinitions.back().Globals;
1442
1443 for (;;) {
1444 if (skip("extern"))
1445 readExtern(Globals);
1446
1447 StringRef Cur = peek();
1448 if (Cur == "}" || Cur == "local:" || Error)
1449 return;
1450 next();
George Rimarcd574a52016-09-09 14:35:36 +00001451 Globals->push_back({unquote(Cur), false, hasWildcard(Cur)});
George Rimar20b65982016-08-31 09:08:26 +00001452 expect(";");
1453 }
1454}
1455
Simon Atanasyan16b0cc92015-11-26 05:53:00 +00001456static bool isUnderSysroot(StringRef Path) {
1457 if (Config->Sysroot == "")
1458 return false;
1459 for (; !Path.empty(); Path = sys::path::parent_path(Path))
1460 if (sys::fs::equivalent(Config->Sysroot, Path))
1461 return true;
1462 return false;
1463}
1464
Rui Ueyama07320e42016-04-20 20:13:41 +00001465void elf::readLinkerScript(MemoryBufferRef MB) {
Simon Atanasyan16b0cc92015-11-26 05:53:00 +00001466 StringRef Path = MB.getBufferIdentifier();
George Rimar20b65982016-08-31 09:08:26 +00001467 ScriptParser(MB.getBuffer(), isUnderSysroot(Path)).readLinkerScript();
1468}
1469
1470void elf::readVersionScript(MemoryBufferRef MB) {
1471 ScriptParser(MB.getBuffer(), false).readVersionScript();
Rui Ueyamaf7c5fbb2015-09-30 17:23:26 +00001472}
Rui Ueyama1ebc8ed2016-02-12 21:47:28 +00001473
Rui Ueyama07320e42016-04-20 20:13:41 +00001474template class elf::LinkerScript<ELF32LE>;
1475template class elf::LinkerScript<ELF32BE>;
1476template class elf::LinkerScript<ELF64LE>;
1477template class elf::LinkerScript<ELF64BE>;