blob: 3a9dc9fde331316b3b16cd59c3344528a82bfd12 [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 Ueyamaf7c5fbb2015-09-30 17:23:26 +000011//
12//===----------------------------------------------------------------------===//
13
Rui Ueyama717677a2016-02-11 21:17:59 +000014#include "LinkerScript.h"
Rui Ueyamaf7c5fbb2015-09-30 17:23:26 +000015#include "Config.h"
16#include "Driver.h"
Rui Ueyama1ebc8ed2016-02-12 21:47:28 +000017#include "InputSection.h"
Rui Ueyama9381eb12016-12-18 14:06:06 +000018#include "Memory.h"
George Rimar652852c2016-04-16 10:10:32 +000019#include "OutputSections.h"
Adhemerval Zanellae77b5bf2016-04-06 20:59:11 +000020#include "ScriptParser.h"
Rui Ueyama93c9af42016-06-29 08:01:32 +000021#include "Strings.h"
Rui Ueyamaf7c5fbb2015-09-30 17:23:26 +000022#include "SymbolTable.h"
Rui Ueyama55518e72016-10-28 20:57:25 +000023#include "Symbols.h"
George Rimar3fb5a6d2016-11-29 16:05:27 +000024#include "SyntheticSections.h"
Eugene Leviant467c4d52016-07-01 10:27:36 +000025#include "Target.h"
Eugene Leviantbbe38602016-07-19 09:25:43 +000026#include "Writer.h"
Eugene Zelenko22886a22016-11-05 01:00:56 +000027#include "llvm/ADT/STLExtras.h"
Rui Ueyama8c6a5aa2016-11-05 22:37:59 +000028#include "llvm/ADT/SmallString.h"
Eugene Zelenko22886a22016-11-05 01:00:56 +000029#include "llvm/ADT/StringRef.h"
Rui Ueyama960504b2016-04-19 18:58:11 +000030#include "llvm/ADT/StringSwitch.h"
Eugene Zelenko22886a22016-11-05 01:00:56 +000031#include "llvm/Support/Casting.h"
George Rimar652852c2016-04-16 10:10:32 +000032#include "llvm/Support/ELF.h"
Eugene Zelenko22886a22016-11-05 01:00:56 +000033#include "llvm/Support/Endian.h"
34#include "llvm/Support/ErrorHandling.h"
Rui Ueyamaf7c5fbb2015-09-30 17:23:26 +000035#include "llvm/Support/FileSystem.h"
Eugene Zelenko22886a22016-11-05 01:00:56 +000036#include "llvm/Support/MathExtras.h"
Rui Ueyamaf03f3cc2015-10-13 00:09:21 +000037#include "llvm/Support/Path.h"
Eugene Zelenko22886a22016-11-05 01:00:56 +000038#include <algorithm>
39#include <cassert>
40#include <cstddef>
41#include <cstdint>
42#include <iterator>
43#include <limits>
44#include <memory>
45#include <string>
46#include <tuple>
47#include <vector>
Rui Ueyamaf7c5fbb2015-09-30 17:23:26 +000048
49using namespace llvm;
George Rimar652852c2016-04-16 10:10:32 +000050using namespace llvm::ELF;
Rui Ueyama1ebc8ed2016-02-12 21:47:28 +000051using namespace llvm::object;
George Rimare38cbab2016-09-26 19:22:50 +000052using namespace llvm::support::endian;
Rui Ueyamaf7c5fbb2015-09-30 17:23:26 +000053using namespace lld;
Rafael Espindolae0df00b2016-02-28 00:25:54 +000054using namespace lld::elf;
Rui Ueyamaf7c5fbb2015-09-30 17:23:26 +000055
George Rimar884e7862016-09-08 08:19:13 +000056LinkerScriptBase *elf::ScriptBase;
Rui Ueyama07320e42016-04-20 20:13:41 +000057ScriptConfiguration *elf::ScriptConfig;
Rui Ueyama717677a2016-02-11 21:17:59 +000058
Meador Inge8f1f3c42017-01-09 18:36:57 +000059template <class ELFT> static SymbolBody *addRegular(SymbolAssignment *Cmd) {
Rafael Espindola3dabfc62016-10-31 13:14:53 +000060 uint8_t Visibility = Cmd->Hidden ? STV_HIDDEN : STV_DEFAULT;
Meador Inge8f1f3c42017-01-09 18:36:57 +000061 Symbol *Sym = Symtab<ELFT>::X->addUndefined(
62 Cmd->Name, /*IsLocal=*/false, STB_GLOBAL, Visibility,
63 /*Type*/ 0,
64 /*CanOmitFromDynSym*/ false, /*File*/ nullptr);
Eugene Leviant20d03192016-09-16 15:30:47 +000065
Meador Inge8f1f3c42017-01-09 18:36:57 +000066 replaceBody<DefinedRegular<ELFT>>(Sym, Cmd->Name, /*IsLocal=*/false,
67 Visibility, STT_NOTYPE, 0, 0, nullptr,
68 nullptr);
69 return Sym->body();
Eugene Leviantceabe802016-08-11 07:56:43 +000070}
71
Meador Inge8f1f3c42017-01-09 18:36:57 +000072template <class ELFT> static SymbolBody *addSynthetic(SymbolAssignment *Cmd) {
73 uint8_t Visibility = Cmd->Hidden ? STV_HIDDEN : STV_DEFAULT;
Eugene Leviantafaa9342016-11-16 09:49:39 +000074 const OutputSectionBase *Sec =
75 ScriptConfig->HasSections ? nullptr : Cmd->Expression.Section();
Meador Inge8f1f3c42017-01-09 18:36:57 +000076 Symbol *Sym = Symtab<ELFT>::X->addUndefined(
77 Cmd->Name, /*IsLocal=*/false, STB_GLOBAL, Visibility,
78 /*Type*/ 0,
79 /*CanOmitFromDynSym*/ false, /*File*/ nullptr);
Eugene Leviantafaa9342016-11-16 09:49:39 +000080
Meador Inge8f1f3c42017-01-09 18:36:57 +000081 replaceBody<DefinedSynthetic>(Sym, Cmd->Name, 0, Sec);
82 return Sym->body();
Eugene Leviantceabe802016-08-11 07:56:43 +000083}
84
Rui Ueyama22375f22016-11-25 18:51:54 +000085static bool isUnderSysroot(StringRef Path) {
86 if (Config->Sysroot == "")
87 return false;
88 for (; !Path.empty(); Path = sys::path::parent_path(Path))
89 if (sys::fs::equivalent(Config->Sysroot, Path))
90 return true;
91 return false;
92}
93
Meador Inge8f1f3c42017-01-09 18:36:57 +000094template <class ELFT> static void assignSymbol(SymbolAssignment *Cmd) {
95 // If there are sections, then let the value be assigned later in
96 // `assignAddresses`.
97 if (ScriptConfig->HasSections)
98 return;
99
100 uint64_t Value = Cmd->Expression(0);
101 if (Cmd->Expression.IsAbsolute()) {
102 cast<DefinedRegular<ELFT>>(Cmd->Sym)->Value = Value;
103 } else {
104 const OutputSectionBase *Sec = Cmd->Expression.Section();
105 if (Sec)
106 cast<DefinedSynthetic>(Cmd->Sym)->Value = Value - Sec->Addr;
107 }
Eugene Leviantdb741e72016-09-07 07:08:43 +0000108}
Meador Inge8f1f3c42017-01-09 18:36:57 +0000109
110template <class ELFT> static void addSymbol(SymbolAssignment *Cmd) {
Rui Ueyama16024212016-08-11 23:22:52 +0000111 if (Cmd->Name == ".")
Meador Inge8f1f3c42017-01-09 18:36:57 +0000112 return;
113
114 // If a symbol was in PROVIDE(), we need to define it only when
115 // it is a referenced undefined symbol.
Rui Ueyama16024212016-08-11 23:22:52 +0000116 SymbolBody *B = Symtab<ELFT>::X->find(Cmd->Name);
Meador Inge8f1f3c42017-01-09 18:36:57 +0000117 if (Cmd->Provide && (!B || B->isDefined()))
118 return;
119
120 // Otherwise, create a new symbol if one does not exist or an
121 // undefined one does exist.
122 if (Cmd->Expression.IsAbsolute())
123 Cmd->Sym = addRegular<ELFT>(Cmd);
124 else
125 Cmd->Sym = addSynthetic<ELFT>(Cmd);
126 assignSymbol<ELFT>(Cmd);
Eugene Leviantceabe802016-08-11 07:56:43 +0000127}
128
George Rimar076fe152016-07-21 06:43:01 +0000129bool SymbolAssignment::classof(const BaseCommand *C) {
130 return C->Kind == AssignmentKind;
131}
132
133bool OutputSectionCommand::classof(const BaseCommand *C) {
134 return C->Kind == OutputSectionKind;
135}
136
George Rimareea31142016-07-21 14:26:59 +0000137bool InputSectionDescription::classof(const BaseCommand *C) {
138 return C->Kind == InputSectionKind;
139}
140
George Rimareefa7582016-08-04 09:29:31 +0000141bool AssertCommand::classof(const BaseCommand *C) {
142 return C->Kind == AssertKind;
143}
144
George Rimare38cbab2016-09-26 19:22:50 +0000145bool BytesDataCommand::classof(const BaseCommand *C) {
146 return C->Kind == BytesDataKind;
147}
148
Eugene Zelenko22886a22016-11-05 01:00:56 +0000149template <class ELFT> LinkerScript<ELFT>::LinkerScript() = default;
150template <class ELFT> LinkerScript<ELFT>::~LinkerScript() = default;
Rui Ueyamaf34d0e02016-08-12 01:24:53 +0000151
Rui Ueyamae0be2902016-11-21 02:10:12 +0000152template <class ELFT> static StringRef basename(InputSectionBase<ELFT> *S) {
153 if (S->getFile())
154 return sys::path::filename(S->getFile()->getName());
155 return "";
156}
157
Rui Ueyama07320e42016-04-20 20:13:41 +0000158template <class ELFT>
159bool LinkerScript<ELFT>::shouldKeep(InputSectionBase<ELFT> *S) {
Rui Ueyamae0be2902016-11-21 02:10:12 +0000160 for (InputSectionDescription *ID : Opt.KeptSections)
161 if (ID->FilePat.match(basename(S)))
162 for (SectionPattern &P : ID->SectionPatterns)
163 if (P.SectionPat.match(S->Name))
164 return true;
George Rimareea31142016-07-21 14:26:59 +0000165 return false;
166}
167
George Rimar575208c2016-09-15 19:15:12 +0000168static bool comparePriority(InputSectionData *A, InputSectionData *B) {
169 return getPriority(A->Name) < getPriority(B->Name);
170}
171
Rafael Espindolac0028d32016-09-08 20:47:52 +0000172static bool compareName(InputSectionData *A, InputSectionData *B) {
Rafael Espindola042a3f22016-09-08 14:06:08 +0000173 return A->Name < B->Name;
Rui Ueyama742c3832016-08-04 22:27:00 +0000174}
George Rimar350ece42016-08-03 08:35:59 +0000175
Rafael Espindolac0028d32016-09-08 20:47:52 +0000176static bool compareAlignment(InputSectionData *A, InputSectionData *B) {
Rui Ueyama742c3832016-08-04 22:27:00 +0000177 // ">" is not a mistake. Larger alignments are placed before smaller
178 // alignments in order to reduce the amount of padding necessary.
179 // This is compatible with GNU.
180 return A->Alignment > B->Alignment;
181}
George Rimar350ece42016-08-03 08:35:59 +0000182
Rafael Espindolac0028d32016-09-08 20:47:52 +0000183static std::function<bool(InputSectionData *, InputSectionData *)>
George Rimarbe394db2016-09-16 20:21:55 +0000184getComparator(SortSectionPolicy K) {
185 switch (K) {
186 case SortSectionPolicy::Alignment:
187 return compareAlignment;
188 case SortSectionPolicy::Name:
Rafael Espindolac0028d32016-09-08 20:47:52 +0000189 return compareName;
George Rimarbe394db2016-09-16 20:21:55 +0000190 case SortSectionPolicy::Priority:
191 return comparePriority;
192 default:
193 llvm_unreachable("unknown sort policy");
194 }
Rui Ueyama742c3832016-08-04 22:27:00 +0000195}
George Rimar0702c4e2016-07-29 15:32:46 +0000196
Rui Ueyama48c3f1c2016-08-12 00:27:23 +0000197template <class ELFT>
Rafael Espindolae71a3f8a2016-09-16 20:34:02 +0000198static bool matchConstraints(ArrayRef<InputSectionBase<ELFT> *> Sections,
George Rimar06ae6832016-08-12 09:07:57 +0000199 ConstraintKind Kind) {
George Rimar8f66df92016-08-12 20:38:20 +0000200 if (Kind == ConstraintKind::NoConstraint)
201 return true;
Rafael Espindolae746e522016-09-21 18:33:44 +0000202 bool IsRW = llvm::any_of(Sections, [=](InputSectionData *Sec2) {
Rafael Espindolad3190792016-09-16 15:10:23 +0000203 auto *Sec = static_cast<InputSectionBase<ELFT> *>(Sec2);
Rafael Espindola1854a8e2016-10-26 12:36:56 +0000204 return Sec->Flags & SHF_WRITE;
George Rimar06ae6832016-08-12 09:07:57 +0000205 });
Rafael Espindolae746e522016-09-21 18:33:44 +0000206 return (IsRW && Kind == ConstraintKind::ReadWrite) ||
207 (!IsRW && Kind == ConstraintKind::ReadOnly);
George Rimar06ae6832016-08-12 09:07:57 +0000208}
209
George Rimar07171f22016-09-21 15:56:44 +0000210static void sortSections(InputSectionData **Begin, InputSectionData **End,
Rui Ueyamaee924702016-09-20 19:42:41 +0000211 SortSectionPolicy K) {
212 if (K != SortSectionPolicy::Default && K != SortSectionPolicy::None)
George Rimar07171f22016-09-21 15:56:44 +0000213 std::stable_sort(Begin, End, getComparator(K));
Rui Ueyamaee924702016-09-20 19:42:41 +0000214}
215
Rafael Espindolad3190792016-09-16 15:10:23 +0000216// Compute and remember which sections the InputSectionDescription matches.
Rafael Espindolabe94e1b2016-09-14 14:32:08 +0000217template <class ELFT>
Rafael Espindolae71a3f8a2016-09-16 20:34:02 +0000218void LinkerScript<ELFT>::computeInputSections(InputSectionDescription *I) {
Rui Ueyama4dc07be2016-09-17 02:23:40 +0000219 // Collects all sections that satisfy constraints of I
220 // and attach them to I.
221 for (SectionPattern &Pat : I->SectionPatterns) {
George Rimar07171f22016-09-21 15:56:44 +0000222 size_t SizeBefore = I->Sections.size();
Rui Ueyama8c6a5aa2016-11-05 22:37:59 +0000223
224 for (InputSectionBase<ELFT> *S : Symtab<ELFT>::X->Sections) {
Rui Ueyamaf94efdd2016-11-20 23:15:52 +0000225 if (!S->Live || S->Assigned)
Rui Ueyama8c6a5aa2016-11-05 22:37:59 +0000226 continue;
227
Rui Ueyamae0be2902016-11-21 02:10:12 +0000228 StringRef Filename = basename(S);
229 if (!I->FilePat.match(Filename) || Pat.ExcludedFilePat.match(Filename))
230 continue;
231 if (!Pat.SectionPat.match(S->Name))
232 continue;
233 I->Sections.push_back(S);
234 S->Assigned = true;
George Rimar395281c2016-09-16 17:42:10 +0000235 }
Rafael Espindolad3190792016-09-16 15:10:23 +0000236
George Rimar07171f22016-09-21 15:56:44 +0000237 // Sort sections as instructed by SORT-family commands and --sort-section
238 // option. Because SORT-family commands can be nested at most two depth
239 // (e.g. SORT_BY_NAME(SORT_BY_ALIGNMENT(.text.*))) and because the command
240 // line option is respected even if a SORT command is given, the exact
241 // behavior we have here is a bit complicated. Here are the rules.
242 //
243 // 1. If two SORT commands are given, --sort-section is ignored.
244 // 2. If one SORT command is given, and if it is not SORT_NONE,
245 // --sort-section is handled as an inner SORT command.
246 // 3. If one SORT command is given, and if it is SORT_NONE, don't sort.
247 // 4. If no SORT command is given, sort according to --sort-section.
248 InputSectionData **Begin = I->Sections.data() + SizeBefore;
249 InputSectionData **End = I->Sections.data() + I->Sections.size();
250 if (Pat.SortOuter != SortSectionPolicy::None) {
251 if (Pat.SortInner == SortSectionPolicy::Default)
252 sortSections(Begin, End, Config->SortSection);
253 else
254 sortSections(Begin, End, Pat.SortInner);
255 sortSections(Begin, End, Pat.SortOuter);
256 }
Rui Ueyamaee924702016-09-20 19:42:41 +0000257 }
Rafael Espindolabe94e1b2016-09-14 14:32:08 +0000258}
259
260template <class ELFT>
261void LinkerScript<ELFT>::discard(ArrayRef<InputSectionBase<ELFT> *> V) {
262 for (InputSectionBase<ELFT> *S : V) {
263 S->Live = false;
264 reportDiscarded(S);
265 }
266}
267
George Rimar06ae6832016-08-12 09:07:57 +0000268template <class ELFT>
Rui Ueyama0b9ce6a2016-08-12 03:16:56 +0000269std::vector<InputSectionBase<ELFT> *>
George Rimar06ae6832016-08-12 09:07:57 +0000270LinkerScript<ELFT>::createInputSectionList(OutputSectionCommand &OutCmd) {
Rui Ueyama0b9ce6a2016-08-12 03:16:56 +0000271 std::vector<InputSectionBase<ELFT> *> Ret;
Rui Ueyamae7f912c2016-08-03 21:12:09 +0000272
George Rimar06ae6832016-08-12 09:07:57 +0000273 for (const std::unique_ptr<BaseCommand> &Base : OutCmd.Commands) {
Rafael Espindola7c3ff2e2016-09-16 21:05:36 +0000274 auto *Cmd = dyn_cast<InputSectionDescription>(Base.get());
275 if (!Cmd)
Rui Ueyama0b9ce6a2016-08-12 03:16:56 +0000276 continue;
Rafael Espindolae71a3f8a2016-09-16 20:34:02 +0000277 computeInputSections(Cmd);
Rafael Espindolad3190792016-09-16 15:10:23 +0000278 for (InputSectionData *S : Cmd->Sections)
279 Ret.push_back(static_cast<InputSectionBase<ELFT> *>(S));
Rui Ueyama0b9ce6a2016-08-12 03:16:56 +0000280 }
Rafael Espindolae71a3f8a2016-09-16 20:34:02 +0000281
Rui Ueyama0b9ce6a2016-08-12 03:16:56 +0000282 return Ret;
283}
284
Petr Hoseke5d3ca52016-08-31 15:31:17 +0000285template <class ELFT>
Eugene Leviant20d03192016-09-16 15:30:47 +0000286void LinkerScript<ELFT>::addSection(OutputSectionFactory<ELFT> &Factory,
287 InputSectionBase<ELFT> *Sec,
288 StringRef Name) {
Rafael Espindolae08e78d2016-11-09 23:23:45 +0000289 OutputSectionBase *OutSec;
Eugene Leviant20d03192016-09-16 15:30:47 +0000290 bool IsNew;
Rafael Espindolafe124502017-01-27 18:39:30 +0000291 std::tie(OutSec, IsNew) = Factory.create(Sec, Name);
Eugene Leviant20d03192016-09-16 15:30:47 +0000292 if (IsNew)
293 OutputSections->push_back(OutSec);
294 OutSec->addSection(Sec);
295}
296
297template <class ELFT>
298void LinkerScript<ELFT>::processCommands(OutputSectionFactory<ELFT> &Factory) {
Rafael Espindola7c3ff2e2016-09-16 21:05:36 +0000299 for (unsigned I = 0; I < Opt.Commands.size(); ++I) {
300 auto Iter = Opt.Commands.begin() + I;
301 const std::unique_ptr<BaseCommand> &Base1 = *Iter;
Rui Ueyama0b1b6952016-11-21 02:11:05 +0000302
303 // Handle symbol assignments outside of any output section.
Rui Ueyama2ab5f732016-08-12 03:33:04 +0000304 if (auto *Cmd = dyn_cast<SymbolAssignment>(Base1.get())) {
Meador Inge8f1f3c42017-01-09 18:36:57 +0000305 addSymbol<ELFT>(Cmd);
Rui Ueyama2ab5f732016-08-12 03:33:04 +0000306 continue;
307 }
Rui Ueyama0b1b6952016-11-21 02:11:05 +0000308
Eugene Leviant20d03192016-09-16 15:30:47 +0000309 if (auto *Cmd = dyn_cast<AssertCommand>(Base1.get())) {
310 // If we don't have SECTIONS then output sections have already been
George Rimar194470cd2016-09-17 19:21:05 +0000311 // created by Writer<ELFT>. The LinkerScript<ELFT>::assignAddresses
Eugene Leviant20d03192016-09-16 15:30:47 +0000312 // will not be called, so ASSERT should be evaluated now.
313 if (!Opt.HasSections)
314 Cmd->Expression(0);
315 continue;
316 }
Rui Ueyama2ab5f732016-08-12 03:33:04 +0000317
Eugene Leviantceabe802016-08-11 07:56:43 +0000318 if (auto *Cmd = dyn_cast<OutputSectionCommand>(Base1.get())) {
Rafael Espindola7bd37872016-09-12 16:05:16 +0000319 std::vector<InputSectionBase<ELFT> *> V = createInputSectionList(*Cmd);
320
Rui Ueyama0b1b6952016-11-21 02:11:05 +0000321 // The output section name `/DISCARD/' is special.
322 // Any input section assigned to it is discarded.
Rui Ueyama48c3f1c2016-08-12 00:27:23 +0000323 if (Cmd->Name == "/DISCARD/") {
Rafael Espindola7bd37872016-09-12 16:05:16 +0000324 discard(V);
Rui Ueyama48c3f1c2016-08-12 00:27:23 +0000325 continue;
326 }
Eugene Leviantceabe802016-08-11 07:56:43 +0000327
Rui Ueyama0b1b6952016-11-21 02:11:05 +0000328 // This is for ONLY_IF_RO and ONLY_IF_RW. An output section directive
329 // ".foo : ONLY_IF_R[OW] { ... }" is handled only if all member input
330 // sections satisfy a given constraint. If not, a directive is handled
331 // as if it wasn't present from the beginning.
332 //
333 // Because we'll iterate over Commands many more times, the easiest
334 // way to "make it as if it wasn't present" is to just remove it.
Rafael Espindola7c3ff2e2016-09-16 21:05:36 +0000335 if (!matchConstraints<ELFT>(V, Cmd->Constraint)) {
336 for (InputSectionBase<ELFT> *S : V)
Rui Ueyamaf94efdd2016-11-20 23:15:52 +0000337 S->Assigned = false;
Rafael Espindola7c3ff2e2016-09-16 21:05:36 +0000338 Opt.Commands.erase(Iter);
George Rimardfbbbc82016-09-17 09:50:10 +0000339 --I;
Rafael Espindola7c3ff2e2016-09-16 21:05:36 +0000340 continue;
341 }
342
Rui Ueyama0b1b6952016-11-21 02:11:05 +0000343 // A directive may contain symbol definitions like this:
344 // ".foo : { ...; bar = .; }". Handle them.
Rafael Espindola7c3ff2e2016-09-16 21:05:36 +0000345 for (const std::unique_ptr<BaseCommand> &Base : Cmd->Commands)
346 if (auto *OutCmd = dyn_cast<SymbolAssignment>(Base.get()))
Meador Inge8f1f3c42017-01-09 18:36:57 +0000347 addSymbol<ELFT>(OutCmd);
Rafael Espindola7c3ff2e2016-09-16 21:05:36 +0000348
Rui Ueyama0b1b6952016-11-21 02:11:05 +0000349 // Handle subalign (e.g. ".foo : SUBALIGN(32) { ... }"). If subalign
350 // is given, input sections are aligned to that value, whether the
351 // given value is larger or smaller than the original section alignment.
352 if (Cmd->SubalignExpr) {
353 uint32_t Subalign = Cmd->SubalignExpr(0);
354 for (InputSectionBase<ELFT> *S : V)
355 S->Alignment = Subalign;
George Rimardb24d9c2016-08-19 15:18:23 +0000356 }
Rui Ueyama0b1b6952016-11-21 02:11:05 +0000357
358 // Add input sections to an output section.
359 for (InputSectionBase<ELFT> *S : V)
360 addSection(Factory, S, Cmd->Name);
Eugene Leviantceabe802016-08-11 07:56:43 +0000361 }
Rui Ueyama48c3f1c2016-08-12 00:27:23 +0000362 }
Eugene Leviant20d03192016-09-16 15:30:47 +0000363}
Eugene Leviante63d81b2016-07-20 14:43:20 +0000364
Rui Ueyama0b1b6952016-11-21 02:11:05 +0000365// Add sections that didn't match any sections command.
Eugene Leviant20d03192016-09-16 15:30:47 +0000366template <class ELFT>
George Rimar93c64022016-12-15 15:38:09 +0000367void LinkerScript<ELFT>::addOrphanSections(
368 OutputSectionFactory<ELFT> &Factory) {
Rui Ueyama8c6a5aa2016-11-05 22:37:59 +0000369 for (InputSectionBase<ELFT> *S : Symtab<ELFT>::X->Sections)
Rafael Espindola8f9026b2016-11-08 18:23:02 +0000370 if (S->Live && !S->OutSec)
Rui Ueyama8c6a5aa2016-11-05 22:37:59 +0000371 addSection(Factory, S, getOutputSectionName(S->Name));
Eugene Leviante63d81b2016-07-20 14:43:20 +0000372}
373
Eugene Leviantdb741e72016-09-07 07:08:43 +0000374// Sets value of a section-defined symbol. Two kinds of
375// symbols are processed: synthetic symbols, whose value
376// is an offset from beginning of section and regular
377// symbols whose value is absolute.
378template <class ELFT>
Eugene Leviantafaa9342016-11-16 09:49:39 +0000379static void assignSectionSymbol(SymbolAssignment *Cmd,
Rafael Espindola498ed712016-10-31 14:44:41 +0000380 typename ELFT::uint Value) {
Eugene Leviantdb741e72016-09-07 07:08:43 +0000381 if (!Cmd->Sym)
382 return;
383
Rui Ueyama4f2f50d2016-12-21 08:40:09 +0000384 if (auto *Body = dyn_cast<DefinedSynthetic>(Cmd->Sym)) {
Eugene Leviantafaa9342016-11-16 09:49:39 +0000385 Body->Section = Cmd->Expression.Section();
386 Body->Value = Cmd->Expression(Value) - Body->Section->Addr;
Eugene Leviantdb741e72016-09-07 07:08:43 +0000387 return;
388 }
389 auto *Body = cast<DefinedRegular<ELFT>>(Cmd->Sym);
Rafael Espindola498ed712016-10-31 14:44:41 +0000390 Body->Value = Cmd->Expression(Value);
Eugene Leviantdb741e72016-09-07 07:08:43 +0000391}
392
Rafael Espindolae08e78d2016-11-09 23:23:45 +0000393template <class ELFT> static bool isTbss(OutputSectionBase *Sec) {
Rafael Espindola04a2e342016-11-09 01:42:41 +0000394 return (Sec->Flags & SHF_TLS) && Sec->Type == SHT_NOBITS;
Rafael Espindolaa940e532016-09-22 12:35:44 +0000395}
396
Rafael Espindolad3190792016-09-16 15:10:23 +0000397template <class ELFT> void LinkerScript<ELFT>::output(InputSection<ELFT> *S) {
398 if (!AlreadyOutputIS.insert(S).second)
399 return;
Rafael Espindolae08e78d2016-11-09 23:23:45 +0000400 bool IsTbss = isTbss<ELFT>(CurOutSec);
Eugene Leviant20889c52016-08-31 08:13:33 +0000401
Rafael Espindolad3190792016-09-16 15:10:23 +0000402 uintX_t Pos = IsTbss ? Dot + ThreadBssOffset : Dot;
403 Pos = alignTo(Pos, S->Alignment);
Rafael Espindola04a2e342016-11-09 01:42:41 +0000404 S->OutSecOff = Pos - CurOutSec->Addr;
Rafael Espindolad3190792016-09-16 15:10:23 +0000405 Pos += S->getSize();
406
407 // Update output section size after adding each section. This is so that
408 // SIZEOF works correctly in the case below:
409 // .foo { *(.aaa) a = SIZEOF(.foo); *(.bbb) }
Rafael Espindola04a2e342016-11-09 01:42:41 +0000410 CurOutSec->Size = Pos - CurOutSec->Addr;
Rafael Espindolad3190792016-09-16 15:10:23 +0000411
Meador Ingeb8897442017-01-24 02:34:00 +0000412 // If there is a memory region associated with this input section, then
413 // place the section in that region and update the region index.
414 if (CurMemRegion) {
415 CurMemRegion->Offset += CurOutSec->Size;
416 uint64_t CurSize = CurMemRegion->Offset - CurMemRegion->Origin;
417 if (CurSize > CurMemRegion->Length) {
418 uint64_t OverflowAmt = CurSize - CurMemRegion->Length;
419 error("section '" + CurOutSec->Name + "' will not fit in region '" +
420 CurMemRegion->Name + "': overflowed by " + Twine(OverflowAmt) +
421 " bytes");
422 }
423 }
424
Rafael Espindola7252ae52016-09-22 12:00:08 +0000425 if (IsTbss)
426 ThreadBssOffset = Pos - Dot;
427 else
Rafael Espindolad3190792016-09-16 15:10:23 +0000428 Dot = Pos;
429}
430
431template <class ELFT> void LinkerScript<ELFT>::flush() {
Rafael Espindola65499b92016-09-23 20:10:47 +0000432 if (!CurOutSec || !AlreadyOutputOS.insert(CurOutSec).second)
433 return;
434 if (auto *OutSec = dyn_cast<OutputSection<ELFT>>(CurOutSec)) {
Rafael Espindolad3190792016-09-16 15:10:23 +0000435 for (InputSection<ELFT> *I : OutSec->Sections)
436 output(I);
Rafael Espindola65499b92016-09-23 20:10:47 +0000437 } else {
Rafael Espindola04a2e342016-11-09 01:42:41 +0000438 Dot += CurOutSec->Size;
Eugene Leviant20889c52016-08-31 08:13:33 +0000439 }
440}
441
442template <class ELFT>
Rafael Espindolae08e78d2016-11-09 23:23:45 +0000443void LinkerScript<ELFT>::switchTo(OutputSectionBase *Sec) {
Rafael Espindolad3190792016-09-16 15:10:23 +0000444 if (CurOutSec == Sec)
445 return;
446 if (AlreadyOutputOS.count(Sec))
447 return;
448
449 flush();
450 CurOutSec = Sec;
451
Rafael Espindola04a2e342016-11-09 01:42:41 +0000452 Dot = alignTo(Dot, CurOutSec->Addralign);
Rafael Espindolae08e78d2016-11-09 23:23:45 +0000453 CurOutSec->Addr = isTbss<ELFT>(CurOutSec) ? Dot + ThreadBssOffset : Dot;
Eugene Leviantb71d6f72016-10-06 09:39:28 +0000454
455 // If neither AT nor AT> is specified for an allocatable section, the linker
456 // will set the LMA such that the difference between VMA and LMA for the
457 // section is the same as the preceding output section in the same region
458 // https://sourceware.org/binutils/docs-2.20/ld/Output-Section-LMA.html
459 CurOutSec->setLMAOffset(LMAOffset);
Rafael Espindolad3190792016-09-16 15:10:23 +0000460}
461
462template <class ELFT> void LinkerScript<ELFT>::process(BaseCommand &Base) {
George Rimare38cbab2016-09-26 19:22:50 +0000463 // This handles the assignments to symbol or to a location counter (.)
Rafael Espindolad3190792016-09-16 15:10:23 +0000464 if (auto *AssignCmd = dyn_cast<SymbolAssignment>(&Base)) {
465 if (AssignCmd->Name == ".") {
466 // Update to location counter means update to section size.
George Rimar14460e02016-12-15 07:27:28 +0000467 uintX_t Val = AssignCmd->Expression(Dot);
468 if (Val < Dot)
469 error("unable to move location counter backward for: " +
470 CurOutSec->Name);
471 Dot = Val;
Rafael Espindola04a2e342016-11-09 01:42:41 +0000472 CurOutSec->Size = Dot - CurOutSec->Addr;
Rafael Espindolad3190792016-09-16 15:10:23 +0000473 return;
474 }
Eugene Leviantafaa9342016-11-16 09:49:39 +0000475 assignSectionSymbol<ELFT>(AssignCmd, Dot);
Eugene Leviantceabe802016-08-11 07:56:43 +0000476 return;
Rui Ueyama2de509c2016-08-12 00:55:08 +0000477 }
George Rimare38cbab2016-09-26 19:22:50 +0000478
479 // Handle BYTE(), SHORT(), LONG(), or QUAD().
480 if (auto *DataCmd = dyn_cast<BytesDataCommand>(&Base)) {
Rafael Espindola04a2e342016-11-09 01:42:41 +0000481 DataCmd->Offset = Dot - CurOutSec->Addr;
George Rimare38cbab2016-09-26 19:22:50 +0000482 Dot += DataCmd->Size;
Rafael Espindola04a2e342016-11-09 01:42:41 +0000483 CurOutSec->Size = Dot - CurOutSec->Addr;
George Rimare38cbab2016-09-26 19:22:50 +0000484 return;
485 }
486
Meador Ingeb2d99d62016-11-22 18:01:50 +0000487 if (auto *AssertCmd = dyn_cast<AssertCommand>(&Base)) {
488 AssertCmd->Expression(Dot);
489 return;
490 }
491
George Rimare38cbab2016-09-26 19:22:50 +0000492 // It handles single input section description command,
493 // calculates and assigns the offsets for each section and also
494 // updates the output section size.
Rafael Espindolad3190792016-09-16 15:10:23 +0000495 auto &ICmd = cast<InputSectionDescription>(Base);
496 for (InputSectionData *ID : ICmd.Sections) {
George Rimar3fb5a6d2016-11-29 16:05:27 +0000497 // We tentatively added all synthetic sections at the beginning and removed
498 // empty ones afterwards (because there is no way to know whether they were
499 // going be empty or not other than actually running linker scripts.)
500 // We need to ignore remains of empty sections.
501 if (auto *Sec = dyn_cast<SyntheticSection<ELFT>>(ID))
502 if (Sec->empty())
503 continue;
504
Rafael Espindolad3190792016-09-16 15:10:23 +0000505 auto *IB = static_cast<InputSectionBase<ELFT> *>(ID);
506 switchTo(IB->OutSec);
507 if (auto *I = dyn_cast<InputSection<ELFT>>(IB))
508 output(I);
Rafael Espindola65499b92016-09-23 20:10:47 +0000509 else
510 flush();
Eugene Leviantceabe802016-08-11 07:56:43 +0000511 }
512}
513
George Rimar8f66df92016-08-12 20:38:20 +0000514template <class ELFT>
Rafael Espindola2b074552017-02-03 22:27:05 +0000515static OutputSectionBase *
516findSection(StringRef Name, const std::vector<OutputSectionBase *> &Sections) {
517 auto End = Sections.end();
518 auto HasName = [=](OutputSectionBase *Sec) { return Sec->getName() == Name; };
519 auto I = std::find_if(Sections.begin(), End, HasName);
Rafael Espindolae08e78d2016-11-09 23:23:45 +0000520 std::vector<OutputSectionBase *> Ret;
Rafael Espindola2b074552017-02-03 22:27:05 +0000521 if (I == End)
522 return nullptr;
523 assert(std::find_if(I + 1, End, HasName) == End);
524 return *I;
George Rimar8f66df92016-08-12 20:38:20 +0000525}
526
Meador Ingeb8897442017-01-24 02:34:00 +0000527// This function searches for a memory region to place the given output
528// section in. If found, a pointer to the appropriate memory region is
529// returned. Otherwise, a nullptr is returned.
530template <class ELFT>
531MemoryRegion *LinkerScript<ELFT>::findMemoryRegion(OutputSectionCommand *Cmd,
532 OutputSectionBase *Sec) {
533 // If a memory region name was specified in the output section command,
534 // then try to find that region first.
535 if (!Cmd->MemoryRegionName.empty()) {
536 auto It = Opt.MemoryRegions.find(Cmd->MemoryRegionName);
537 if (It != Opt.MemoryRegions.end())
538 return &It->second;
539 error("memory region '" + Cmd->MemoryRegionName + "' not declared");
540 return nullptr;
541 }
542
543 // The memory region name is empty, thus a suitable region must be
544 // searched for in the region map. If the region map is empty, just
545 // return. Note that this check doesn't happen at the very beginning
546 // so that uses of undeclared regions can be caught.
547 if (!Opt.MemoryRegions.size())
548 return nullptr;
549
550 // See if a region can be found by matching section flags.
551 for (auto &MRI : Opt.MemoryRegions) {
552 MemoryRegion &MR = MRI.second;
Rui Ueyama8a8a9532017-01-26 02:58:59 +0000553 if ((MR.Flags & Sec->Flags) != 0 && (MR.NegFlags & Sec->Flags) == 0)
Meador Ingeb8897442017-01-24 02:34:00 +0000554 return &MR;
555 }
556
557 // Otherwise, no suitable region was found.
558 if (Sec->Flags & SHF_ALLOC)
559 error("no memory region specified for section '" + Sec->Name + "'");
560 return nullptr;
561}
562
Rui Ueyama0b1b6952016-11-21 02:11:05 +0000563// This function assigns offsets to input sections and an output section
564// for a single sections command (e.g. ".text { *(.text); }").
Rafael Espindolad3190792016-09-16 15:10:23 +0000565template <class ELFT>
566void LinkerScript<ELFT>::assignOffsets(OutputSectionCommand *Cmd) {
Eugene Leviantb71d6f72016-10-06 09:39:28 +0000567 if (Cmd->LMAExpr)
568 LMAOffset = Cmd->LMAExpr(Dot) - Dot;
Rafael Espindola2b074552017-02-03 22:27:05 +0000569 OutputSectionBase *Sec = findSection<ELFT>(Cmd->Name, *OutputSections);
570 if (!Sec)
Rafael Espindolad3190792016-09-16 15:10:23 +0000571 return;
Meador Ingeb8897442017-01-24 02:34:00 +0000572
Meador Ingeb8897442017-01-24 02:34:00 +0000573 // Try and find an appropriate memory region to assign offsets in.
574 CurMemRegion = findMemoryRegion(Cmd, Sec);
575 if (CurMemRegion)
576 Dot = CurMemRegion->Offset;
577 switchTo(Sec);
Rui Ueyama0b1b6952016-11-21 02:11:05 +0000578
Rafael Espindolad3190792016-09-16 15:10:23 +0000579 // Find the last section output location. We will output orphan sections
580 // there so that end symbols point to the correct location.
581 auto E = std::find_if(Cmd->Commands.rbegin(), Cmd->Commands.rend(),
582 [](const std::unique_ptr<BaseCommand> &Cmd) {
583 return !isa<SymbolAssignment>(*Cmd);
584 })
585 .base();
586 for (auto I = Cmd->Commands.begin(); I != E; ++I)
587 process(**I);
Rafael Espindola65499b92016-09-23 20:10:47 +0000588 flush();
George Rimarb31dd372016-09-19 13:27:31 +0000589 std::for_each(E, Cmd->Commands.end(),
590 [this](std::unique_ptr<BaseCommand> &B) { process(*B.get()); });
Rafael Espindolad3190792016-09-16 15:10:23 +0000591}
592
Rafael Espindola07fe6122016-11-14 14:23:35 +0000593template <class ELFT> void LinkerScript<ELFT>::removeEmptyCommands() {
Rafael Espindola6d38e4d2016-09-20 13:12:07 +0000594 // It is common practice to use very generic linker scripts. So for any
595 // given run some of the output sections in the script will be empty.
596 // We could create corresponding empty output sections, but that would
597 // clutter the output.
598 // We instead remove trivially empty sections. The bfd linker seems even
599 // more aggressive at removing them.
600 auto Pos = std::remove_if(
601 Opt.Commands.begin(), Opt.Commands.end(),
602 [&](const std::unique_ptr<BaseCommand> &Base) {
Rui Ueyama0b1b6952016-11-21 02:11:05 +0000603 if (auto *Cmd = dyn_cast<OutputSectionCommand>(Base.get()))
Rafael Espindola2b074552017-02-03 22:27:05 +0000604 return !findSection<ELFT>(Cmd->Name, *OutputSections);
Rui Ueyama0b1b6952016-11-21 02:11:05 +0000605 return false;
Rafael Espindola6d38e4d2016-09-20 13:12:07 +0000606 });
607 Opt.Commands.erase(Pos, Opt.Commands.end());
Rafael Espindola07fe6122016-11-14 14:23:35 +0000608}
609
Rafael Espindola6a537372016-11-14 14:33:49 +0000610static bool isAllSectionDescription(const OutputSectionCommand &Cmd) {
611 for (const std::unique_ptr<BaseCommand> &I : Cmd.Commands)
612 if (!isa<InputSectionDescription>(*I))
613 return false;
614 return true;
615}
Rafael Espindola6d38e4d2016-09-20 13:12:07 +0000616
Rafael Espindola6a537372016-11-14 14:33:49 +0000617template <class ELFT> void LinkerScript<ELFT>::adjustSectionsBeforeSorting() {
Rafael Espindola9546fff2016-09-22 14:40:50 +0000618 // If the output section contains only symbol assignments, create a
619 // corresponding output section. The bfd linker seems to only create them if
620 // '.' is assigned to, but creating these section should not have any bad
621 // consequeces and gives us a section to put the symbol in.
622 uintX_t Flags = SHF_ALLOC;
Rafael Espindolaf93b8c22016-11-26 06:55:35 +0000623 uint32_t Type = SHT_NOBITS;
Rafael Espindola9546fff2016-09-22 14:40:50 +0000624 for (const std::unique_ptr<BaseCommand> &Base : Opt.Commands) {
625 auto *Cmd = dyn_cast<OutputSectionCommand>(Base.get());
626 if (!Cmd)
627 continue;
Rafael Espindola2b074552017-02-03 22:27:05 +0000628 if (OutputSectionBase *Sec =
629 findSection<ELFT>(Cmd->Name, *OutputSections)) {
630 Flags = Sec->Flags;
631 Type = Sec->Type;
Rafael Espindola9546fff2016-09-22 14:40:50 +0000632 continue;
633 }
634
Rafael Espindola6a537372016-11-14 14:33:49 +0000635 if (isAllSectionDescription(*Cmd))
636 continue;
637
Rui Ueyama95642b92016-11-01 23:09:07 +0000638 auto *OutSec = make<OutputSection<ELFT>>(Cmd->Name, Type, Flags);
Rafael Espindola9546fff2016-09-22 14:40:50 +0000639 OutputSections->push_back(OutSec);
640 }
Rafael Espindolaf7a17442016-11-14 15:39:38 +0000641}
642
643template <class ELFT> void LinkerScript<ELFT>::adjustSectionsAfterSorting() {
644 placeOrphanSections();
645
646 // If output section command doesn't specify any segments,
647 // and we haven't previously assigned any section to segment,
648 // then we simply assign section to the very first load segment.
649 // Below is an example of such linker script:
650 // PHDRS { seg PT_LOAD; }
651 // SECTIONS { .aaa : { *(.aaa) } }
652 std::vector<StringRef> DefPhdrs;
653 auto FirstPtLoad =
654 std::find_if(Opt.PhdrsCommands.begin(), Opt.PhdrsCommands.end(),
655 [](const PhdrsCommand &Cmd) { return Cmd.Type == PT_LOAD; });
656 if (FirstPtLoad != Opt.PhdrsCommands.end())
657 DefPhdrs.push_back(FirstPtLoad->Name);
658
659 // Walk the commands and propagate the program headers to commands that don't
660 // explicitly specify them.
661 for (const std::unique_ptr<BaseCommand> &Base : Opt.Commands) {
662 auto *Cmd = dyn_cast<OutputSectionCommand>(Base.get());
663 if (!Cmd)
664 continue;
665 if (Cmd->Phdrs.empty())
666 Cmd->Phdrs = DefPhdrs;
667 else
668 DefPhdrs = Cmd->Phdrs;
669 }
Rafael Espindola6a537372016-11-14 14:33:49 +0000670
671 removeEmptyCommands();
Rafael Espindola9546fff2016-09-22 14:40:50 +0000672}
673
Rafael Espindola15c57952016-09-22 18:05:49 +0000674// When placing orphan sections, we want to place them after symbol assignments
675// so that an orphan after
676// begin_foo = .;
677// foo : { *(foo) }
678// end_foo = .;
679// doesn't break the intended meaning of the begin/end symbols.
680// We don't want to go over sections since Writer<ELFT>::sortSections is the
681// one in charge of deciding the order of the sections.
682// We don't want to go over alignments, since doing so in
683// rx_sec : { *(rx_sec) }
684// . = ALIGN(0x1000);
685// /* The RW PT_LOAD starts here*/
686// rw_sec : { *(rw_sec) }
687// would mean that the RW PT_LOAD would become unaligned.
Rafael Espindola5fcc99c2016-11-27 09:44:45 +0000688static bool shouldSkip(const BaseCommand &Cmd) {
Rafael Espindola15c57952016-09-22 18:05:49 +0000689 if (isa<OutputSectionCommand>(Cmd))
690 return false;
691 const auto *Assign = dyn_cast<SymbolAssignment>(&Cmd);
692 if (!Assign)
693 return true;
Rafael Espindola5fcc99c2016-11-27 09:44:45 +0000694 return Assign->Name != ".";
Rafael Espindola15c57952016-09-22 18:05:49 +0000695}
696
Rui Ueyama6697ec22017-02-02 23:26:12 +0000697// Orphan sections are sections present in the input files which are
698// not explicitly placed into the output file by the linker script.
699//
700// When the control reaches this function, Opt.Commands contains
701// output section commands for non-orphan sections only. This function
702// adds new elements for orphan sections to Opt.Commands so that all
703// sections are explicitly handled by Opt.Commands.
704//
705// Writer<ELFT>::sortSections has already sorted output sections.
706// What we need to do is to scan OutputSections vector and
707// Opt.Commands in parallel to find orphan sections. If there is an
708// output section that doesn't have a corresponding entry in
709// Opt.Commands, we will insert a new entry to Opt.Commands.
710//
711// There is some ambiguity as to where exactly a new entry should be
712// inserted, because Opt.Commands contains not only output section
713// commands but other types of commands such as symbol assignment
714// expressions. There's no correct answer here due to the lack of the
715// formal specification of the linker script. We use heuristics to
716// determine whether a new output command should be added before or
717// after another commands. For the details, look at shouldSkip
718// function.
George Rimar93c64022016-12-15 15:38:09 +0000719template <class ELFT> void LinkerScript<ELFT>::placeOrphanSections() {
Rafael Espindolaaab6d5c2016-09-16 21:29:07 +0000720 // The OutputSections are already in the correct order.
721 // This loops creates or moves commands as needed so that they are in the
722 // correct order.
723 int CmdIndex = 0;
Rafael Espindola5fcc99c2016-11-27 09:44:45 +0000724
725 // As a horrible special case, skip the first . assignment if it is before any
726 // section. We do this because it is common to set a load address by starting
727 // the script with ". = 0xabcd" and the expectation is that every section is
728 // after that.
729 auto FirstSectionOrDotAssignment =
730 std::find_if(Opt.Commands.begin(), Opt.Commands.end(),
731 [](const std::unique_ptr<BaseCommand> &Cmd) {
732 if (isa<OutputSectionCommand>(*Cmd))
733 return true;
734 const auto *Assign = dyn_cast<SymbolAssignment>(Cmd.get());
735 if (!Assign)
736 return false;
737 return Assign->Name == ".";
738 });
739 if (FirstSectionOrDotAssignment != Opt.Commands.end()) {
740 CmdIndex = FirstSectionOrDotAssignment - Opt.Commands.begin();
741 if (isa<SymbolAssignment>(**FirstSectionOrDotAssignment))
742 ++CmdIndex;
743 }
744
Rafael Espindolae08e78d2016-11-09 23:23:45 +0000745 for (OutputSectionBase *Sec : *OutputSections) {
George Rimar652852c2016-04-16 10:10:32 +0000746 StringRef Name = Sec->getName();
Rafael Espindolaaab6d5c2016-09-16 21:29:07 +0000747
748 // Find the last spot where we can insert a command and still get the
Rafael Espindola15c57952016-09-22 18:05:49 +0000749 // correct result.
Rafael Espindolaaab6d5c2016-09-16 21:29:07 +0000750 auto CmdIter = Opt.Commands.begin() + CmdIndex;
751 auto E = Opt.Commands.end();
Rafael Espindola5fcc99c2016-11-27 09:44:45 +0000752 while (CmdIter != E && shouldSkip(**CmdIter)) {
Rafael Espindolaaab6d5c2016-09-16 21:29:07 +0000753 ++CmdIter;
754 ++CmdIndex;
755 }
756
757 auto Pos =
758 std::find_if(CmdIter, E, [&](const std::unique_ptr<BaseCommand> &Base) {
759 auto *Cmd = dyn_cast<OutputSectionCommand>(Base.get());
760 return Cmd && Cmd->Name == Name;
761 });
762 if (Pos == E) {
763 Opt.Commands.insert(CmdIter,
764 llvm::make_unique<OutputSectionCommand>(Name));
Rafael Espindola15c57952016-09-22 18:05:49 +0000765 ++CmdIndex;
766 continue;
Rafael Espindolaaab6d5c2016-09-16 21:29:07 +0000767 }
Rafael Espindola15c57952016-09-22 18:05:49 +0000768
769 // Continue from where we found it.
770 CmdIndex = (Pos - Opt.Commands.begin()) + 1;
George Rimar652852c2016-04-16 10:10:32 +0000771 }
Rafael Espindola337f9032016-11-14 14:13:32 +0000772}
773
774template <class ELFT>
Rafael Espindola17cb7c02016-12-19 17:01:01 +0000775void LinkerScript<ELFT>::assignAddresses(std::vector<PhdrEntry> &Phdrs) {
Rui Ueyama7c18c282016-04-18 21:00:40 +0000776 // Assign addresses as instructed by linker script SECTIONS sub-commands.
Rafael Espindolabe607332016-09-30 00:16:11 +0000777 Dot = 0;
George Rimar652852c2016-04-16 10:10:32 +0000778
George Rimar076fe152016-07-21 06:43:01 +0000779 for (const std::unique_ptr<BaseCommand> &Base : Opt.Commands) {
780 if (auto *Cmd = dyn_cast<SymbolAssignment>(Base.get())) {
Rui Ueyama8d083e62016-07-29 05:48:39 +0000781 if (Cmd->Name == ".") {
782 Dot = Cmd->Expression(Dot);
783 } else if (Cmd->Sym) {
Eugene Leviantafaa9342016-11-16 09:49:39 +0000784 assignSectionSymbol<ELFT>(Cmd, Dot);
Rui Ueyama8d083e62016-07-29 05:48:39 +0000785 }
George Rimar652852c2016-04-16 10:10:32 +0000786 continue;
787 }
788
George Rimareefa7582016-08-04 09:29:31 +0000789 if (auto *Cmd = dyn_cast<AssertCommand>(Base.get())) {
790 Cmd->Expression(Dot);
791 continue;
792 }
793
George Rimar076fe152016-07-21 06:43:01 +0000794 auto *Cmd = cast<OutputSectionCommand>(Base.get());
Rafael Espindolad3190792016-09-16 15:10:23 +0000795 if (Cmd->AddrExpr)
796 Dot = Cmd->AddrExpr(Dot);
Rafael Espindolad3190792016-09-16 15:10:23 +0000797 assignOffsets(Cmd);
George Rimar652852c2016-04-16 10:10:32 +0000798 }
Rui Ueyama52c4e172016-07-01 10:42:25 +0000799
Rafael Espindolaaab6d5c2016-09-16 21:29:07 +0000800 uintX_t MinVA = std::numeric_limits<uintX_t>::max();
Rafael Espindolae08e78d2016-11-09 23:23:45 +0000801 for (OutputSectionBase *Sec : *OutputSections) {
Rafael Espindola04a2e342016-11-09 01:42:41 +0000802 if (Sec->Flags & SHF_ALLOC)
Rafael Espindolae08e78d2016-11-09 23:23:45 +0000803 MinVA = std::min<uint64_t>(MinVA, Sec->Addr);
Rafael Espindolaaab6d5c2016-09-16 21:29:07 +0000804 else
Rafael Espindola04a2e342016-11-09 01:42:41 +0000805 Sec->Addr = 0;
Rafael Espindolaaab6d5c2016-09-16 21:29:07 +0000806 }
807
Rafael Espindola8c495e22017-01-20 20:41:18 +0000808 allocateHeaders<ELFT>(Phdrs, *OutputSections, MinVA);
George Rimar652852c2016-04-16 10:10:32 +0000809}
810
Rui Ueyama464daad2016-08-22 04:55:20 +0000811// Creates program headers as instructed by PHDRS linker script command.
Rafael Espindola17cb7c02016-12-19 17:01:01 +0000812template <class ELFT> std::vector<PhdrEntry> LinkerScript<ELFT>::createPhdrs() {
813 std::vector<PhdrEntry> Ret;
Eugene Leviantbbe38602016-07-19 09:25:43 +0000814
Rui Ueyama464daad2016-08-22 04:55:20 +0000815 // Process PHDRS and FILEHDR keywords because they are not
816 // real output sections and cannot be added in the following loop.
Eugene Leviantbbe38602016-07-19 09:25:43 +0000817 for (const PhdrsCommand &Cmd : Opt.PhdrsCommands) {
Rui Ueyamaedebbdf2016-07-24 23:47:31 +0000818 Ret.emplace_back(Cmd.Type, Cmd.Flags == UINT_MAX ? PF_R : Cmd.Flags);
Rafael Espindola17cb7c02016-12-19 17:01:01 +0000819 PhdrEntry &Phdr = Ret.back();
Eugene Leviantbbe38602016-07-19 09:25:43 +0000820
821 if (Cmd.HasFilehdr)
Rui Ueyamaadca2452016-07-23 14:18:48 +0000822 Phdr.add(Out<ELFT>::ElfHeader);
Eugene Leviantbbe38602016-07-19 09:25:43 +0000823 if (Cmd.HasPhdrs)
Rui Ueyamaadca2452016-07-23 14:18:48 +0000824 Phdr.add(Out<ELFT>::ProgramHeaders);
Eugene Leviant56b21c82016-09-09 09:46:16 +0000825
826 if (Cmd.LMAExpr) {
Rafael Espindola17cb7c02016-12-19 17:01:01 +0000827 Phdr.p_paddr = Cmd.LMAExpr(0);
Eugene Leviant56b21c82016-09-09 09:46:16 +0000828 Phdr.HasLMA = true;
829 }
Eugene Leviantbbe38602016-07-19 09:25:43 +0000830 }
831
Rui Ueyama464daad2016-08-22 04:55:20 +0000832 // Add output sections to program headers.
Rafael Espindolae08e78d2016-11-09 23:23:45 +0000833 for (OutputSectionBase *Sec : *OutputSections) {
Rafael Espindola04a2e342016-11-09 01:42:41 +0000834 if (!(Sec->Flags & SHF_ALLOC))
Eugene Leviantbbe38602016-07-19 09:25:43 +0000835 break;
836
Eugene Leviantce30b1c2016-10-19 15:04:49 +0000837 // Assign headers specified by linker script
Rafael Espindolaf7a17442016-11-14 15:39:38 +0000838 for (size_t Id : getPhdrIndices(Sec->getName())) {
Eugene Leviantce30b1c2016-10-19 15:04:49 +0000839 Ret[Id].add(Sec);
840 if (Opt.PhdrsCommands[Id].Flags == UINT_MAX)
Rafael Espindola17cb7c02016-12-19 17:01:01 +0000841 Ret[Id].p_flags |= Sec->getPhdrFlags();
Eugene Leviantbbe38602016-07-19 09:25:43 +0000842 }
Eugene Leviantbbe38602016-07-19 09:25:43 +0000843 }
Rui Ueyamaedebbdf2016-07-24 23:47:31 +0000844 return Ret;
Eugene Leviantbbe38602016-07-19 09:25:43 +0000845}
846
Eugene Leviantf9bc3bd2016-08-16 06:40:58 +0000847template <class ELFT> bool LinkerScript<ELFT>::ignoreInterpSection() {
848 // Ignore .interp section in case we have PHDRS specification
849 // and PT_INTERP isn't listed.
850 return !Opt.PhdrsCommands.empty() &&
851 llvm::find_if(Opt.PhdrsCommands, [](const PhdrsCommand &Cmd) {
852 return Cmd.Type == PT_INTERP;
853 }) == Opt.PhdrsCommands.end();
854}
855
George Rimar93c64022016-12-15 15:38:09 +0000856template <class ELFT> uint32_t LinkerScript<ELFT>::getFiller(StringRef Name) {
George Rimarf6c3cce2016-07-21 07:48:54 +0000857 for (const std::unique_ptr<BaseCommand> &Base : Opt.Commands)
858 if (auto *Cmd = dyn_cast<OutputSectionCommand>(Base.get()))
859 if (Cmd->Name == Name)
860 return Cmd->Filler;
Rui Ueyama16068ae2016-11-19 18:05:56 +0000861 return 0;
George Rimare2ee72b2016-02-26 14:48:31 +0000862}
863
George Rimare38cbab2016-09-26 19:22:50 +0000864template <class ELFT>
865static void writeInt(uint8_t *Buf, uint64_t Data, uint64_t Size) {
866 const endianness E = ELFT::TargetEndianness;
867
868 switch (Size) {
869 case 1:
870 *Buf = (uint8_t)Data;
871 break;
872 case 2:
873 write16<E>(Buf, Data);
874 break;
875 case 4:
876 write32<E>(Buf, Data);
877 break;
878 case 8:
879 write64<E>(Buf, Data);
880 break;
881 default:
882 llvm_unreachable("unsupported Size argument");
883 }
884}
885
886template <class ELFT>
887void LinkerScript<ELFT>::writeDataBytes(StringRef Name, uint8_t *Buf) {
888 int I = getSectionIndex(Name);
889 if (I == INT_MAX)
890 return;
891
Rui Ueyama6e68c5e2016-11-19 18:05:58 +0000892 auto *Cmd = dyn_cast<OutputSectionCommand>(Opt.Commands[I].get());
893 for (const std::unique_ptr<BaseCommand> &Base : Cmd->Commands)
894 if (auto *Data = dyn_cast<BytesDataCommand>(Base.get()))
Meador Inge95c7d8d2016-12-08 23:21:30 +0000895 writeInt<ELFT>(Buf + Data->Offset, Data->Expression(0), Data->Size);
George Rimare38cbab2016-09-26 19:22:50 +0000896}
897
Eugene Leviantb71d6f72016-10-06 09:39:28 +0000898template <class ELFT> bool LinkerScript<ELFT>::hasLMA(StringRef Name) {
George Rimar8ceadb32016-08-17 07:44:19 +0000899 for (const std::unique_ptr<BaseCommand> &Base : Opt.Commands)
900 if (auto *Cmd = dyn_cast<OutputSectionCommand>(Base.get()))
Eugene Leviantb71d6f72016-10-06 09:39:28 +0000901 if (Cmd->LMAExpr && Cmd->Name == Name)
902 return true;
903 return false;
George Rimar8ceadb32016-08-17 07:44:19 +0000904}
905
Rui Ueyamac3e2a4b2016-04-21 20:30:00 +0000906// Returns the index of the given section name in linker script
907// SECTIONS commands. Sections are laid out as the same order as they
908// were in the script. If a given name did not appear in the script,
909// it returns INT_MAX, so that it will be laid out at end of file.
George Rimar076fe152016-07-21 06:43:01 +0000910template <class ELFT> int LinkerScript<ELFT>::getSectionIndex(StringRef Name) {
Rui Ueyama6e68c5e2016-11-19 18:05:58 +0000911 for (int I = 0, E = Opt.Commands.size(); I != E; ++I)
912 if (auto *Cmd = dyn_cast<OutputSectionCommand>(Opt.Commands[I].get()))
Rui Ueyamaf510fa62016-07-26 00:21:15 +0000913 if (Cmd->Name == Name)
914 return I;
Rui Ueyamaf510fa62016-07-26 00:21:15 +0000915 return INT_MAX;
George Rimar71b26e92016-04-21 10:22:02 +0000916}
917
Eugene Leviantbbe38602016-07-19 09:25:43 +0000918template <class ELFT> bool LinkerScript<ELFT>::hasPhdrsCommands() {
919 return !Opt.PhdrsCommands.empty();
920}
921
George Rimar9e694502016-07-29 16:18:47 +0000922template <class ELFT>
Eugene Levianted30ce72016-11-28 09:58:04 +0000923const OutputSectionBase *LinkerScript<ELFT>::getOutputSection(const Twine &Loc,
924 StringRef Name) {
Eugene Leviantafaa9342016-11-16 09:49:39 +0000925 static OutputSectionBase FakeSec("", 0, 0);
George Rimar96659df2016-08-30 09:54:01 +0000926
Rafael Espindolae08e78d2016-11-09 23:23:45 +0000927 for (OutputSectionBase *Sec : *OutputSections)
Eugene Leviantb71d6f72016-10-06 09:39:28 +0000928 if (Sec->getName() == Name)
Eugene Leviantafaa9342016-11-16 09:49:39 +0000929 return Sec;
Eugene Levianted30ce72016-11-28 09:58:04 +0000930
931 error(Loc + ": undefined section " + Name);
Eugene Leviantafaa9342016-11-16 09:49:39 +0000932 return &FakeSec;
Eugene Leviant36fac7f2016-09-08 09:08:30 +0000933}
934
Rui Ueyamaedf75e72016-11-17 20:27:10 +0000935// This function is essentially the same as getOutputSection(Name)->Size,
936// but it won't print out an error message if a given section is not found.
937//
938// Linker script does not create an output section if its content is empty.
939// We want to allow SIZEOF(.foo) where .foo is a section which happened to
940// be empty. That is why this function is different from getOutputSection().
941template <class ELFT>
942uint64_t LinkerScript<ELFT>::getOutputSectionSize(StringRef Name) {
943 for (OutputSectionBase *Sec : *OutputSections)
944 if (Sec->getName() == Name)
945 return Sec->Size;
946 return 0;
947}
948
George Rimar884e7862016-09-08 08:19:13 +0000949template <class ELFT> uint64_t LinkerScript<ELFT>::getHeaderSize() {
Rafael Espindola0d4b6d52016-09-22 16:47:21 +0000950 return elf::getHeaderSize<ELFT>();
George Rimare32a3592016-08-10 07:59:34 +0000951}
952
Eugene Leviantf6aeed32016-12-22 13:13:12 +0000953template <class ELFT>
954uint64_t LinkerScript<ELFT>::getSymbolValue(const Twine &Loc, StringRef S) {
George Rimar884e7862016-09-08 08:19:13 +0000955 if (SymbolBody *B = Symtab<ELFT>::X->find(S))
956 return B->getVA<ELFT>();
Eugene Leviantf6aeed32016-12-22 13:13:12 +0000957 error(Loc + ": symbol not found: " + S);
George Rimar884e7862016-09-08 08:19:13 +0000958 return 0;
959}
960
George Rimarf34f45f2016-09-23 13:17:23 +0000961template <class ELFT> bool LinkerScript<ELFT>::isDefined(StringRef S) {
962 return Symtab<ELFT>::X->find(S) != nullptr;
963}
964
Rafael Espindola2f831dc2016-10-31 19:56:37 +0000965template <class ELFT> bool LinkerScript<ELFT>::isAbsolute(StringRef S) {
966 SymbolBody *Sym = Symtab<ELFT>::X->find(S);
967 auto *DR = dyn_cast_or_null<DefinedRegular<ELFT>>(Sym);
968 return DR && !DR->Section;
969}
970
Eugene Leviantafaa9342016-11-16 09:49:39 +0000971// Gets section symbol belongs to. Symbol "." doesn't belong to any
972// specific section but isn't absolute at the same time, so we try
973// to find suitable section for it as well.
974template <class ELFT>
975const OutputSectionBase *LinkerScript<ELFT>::getSymbolSection(StringRef S) {
976 SymbolBody *Sym = Symtab<ELFT>::X->find(S);
977 if (!Sym) {
978 if (OutputSections->empty())
979 return nullptr;
980 return CurOutSec ? CurOutSec : (*OutputSections)[0];
981 }
982
George Rimar60aed442017-01-20 09:45:36 +0000983 return SymbolTableSection<ELFT>::getOutputSection(Sym);
Eugene Leviantafaa9342016-11-16 09:49:39 +0000984}
985
Eugene Leviantbbe38602016-07-19 09:25:43 +0000986// Returns indices of ELF headers containing specific section, identified
987// by Name. Each index is a zero based number of ELF header listed within
988// PHDRS {} script block.
989template <class ELFT>
Rui Ueyamaedebbdf2016-07-24 23:47:31 +0000990std::vector<size_t> LinkerScript<ELFT>::getPhdrIndices(StringRef SectionName) {
George Rimar076fe152016-07-21 06:43:01 +0000991 for (const std::unique_ptr<BaseCommand> &Base : Opt.Commands) {
992 auto *Cmd = dyn_cast<OutputSectionCommand>(Base.get());
Rui Ueyamaedebbdf2016-07-24 23:47:31 +0000993 if (!Cmd || Cmd->Name != SectionName)
George Rimar31d842f2016-07-20 16:43:03 +0000994 continue;
995
Rui Ueyama29c5a2a2016-07-26 00:27:36 +0000996 std::vector<size_t> Ret;
997 for (StringRef PhdrName : Cmd->Phdrs)
Eugene Leviant2a942c42016-12-05 16:38:32 +0000998 Ret.push_back(getPhdrIndex(Cmd->Location, PhdrName));
Rui Ueyama29c5a2a2016-07-26 00:27:36 +0000999 return Ret;
Eugene Leviantbbe38602016-07-19 09:25:43 +00001000 }
George Rimar31d842f2016-07-20 16:43:03 +00001001 return {};
Eugene Leviantbbe38602016-07-19 09:25:43 +00001002}
1003
Rui Ueyama29c5a2a2016-07-26 00:27:36 +00001004template <class ELFT>
Eugene Leviant2a942c42016-12-05 16:38:32 +00001005size_t LinkerScript<ELFT>::getPhdrIndex(const Twine &Loc, StringRef PhdrName) {
Rui Ueyama29c5a2a2016-07-26 00:27:36 +00001006 size_t I = 0;
1007 for (PhdrsCommand &Cmd : Opt.PhdrsCommands) {
1008 if (Cmd.Name == PhdrName)
1009 return I;
1010 ++I;
1011 }
Eugene Leviant2a942c42016-12-05 16:38:32 +00001012 error(Loc + ": section header '" + PhdrName + "' is not listed in PHDRS");
Rui Ueyama29c5a2a2016-07-26 00:27:36 +00001013 return 0;
1014}
1015
Eugene Leviant03ff0162016-11-21 15:49:56 +00001016class elf::ScriptParser final : public ScriptParserBase {
George Rimarc3794e52016-02-24 09:21:47 +00001017 typedef void (ScriptParser::*Handler)();
1018
Rui Ueyamaf7c5fbb2015-09-30 17:23:26 +00001019public:
Rui Ueyama22375f22016-11-25 18:51:54 +00001020 ScriptParser(MemoryBufferRef MB)
1021 : ScriptParserBase(MB),
1022 IsUnderSysroot(isUnderSysroot(MB.getBufferIdentifier())) {}
George Rimarf23b2322016-02-19 10:45:45 +00001023
George Rimar20b65982016-08-31 09:08:26 +00001024 void readLinkerScript();
1025 void readVersionScript();
Rafael Espindolad0ebd842016-12-08 17:54:26 +00001026 void readDynamicList();
Rui Ueyamaf7c5fbb2015-09-30 17:23:26 +00001027
1028private:
Rui Ueyama52a15092015-10-11 03:28:42 +00001029 void addFile(StringRef Path);
1030
Rui Ueyamaf7c5fbb2015-09-30 17:23:26 +00001031 void readAsNeeded();
Denis Protivensky90c50992015-10-08 06:48:38 +00001032 void readEntry();
George Rimar83f406c2015-10-19 17:35:12 +00001033 void readExtern();
Rui Ueyamaf7c5fbb2015-09-30 17:23:26 +00001034 void readGroup();
Rui Ueyama31aa1f82015-10-11 01:31:55 +00001035 void readInclude();
Meador Ingeb8897442017-01-24 02:34:00 +00001036 void readMemory();
Rui Ueyamaee592822015-10-07 00:25:09 +00001037 void readOutput();
Davide Italiano9159ce92015-10-12 21:50:08 +00001038 void readOutputArch();
Rui Ueyamaf7c5fbb2015-09-30 17:23:26 +00001039 void readOutputFormat();
Eugene Leviantbbe38602016-07-19 09:25:43 +00001040 void readPhdrs();
Davide Italiano68a39a62015-10-08 17:51:41 +00001041 void readSearchDir();
Denis Protivensky8e3b38a2015-11-12 09:52:08 +00001042 void readSections();
Rui Ueyama95769b42016-08-31 20:03:54 +00001043 void readVersion();
1044 void readVersionScriptCommand();
Denis Protivensky8e3b38a2015-11-12 09:52:08 +00001045
Rui Ueyama113cdec2016-07-24 23:05:57 +00001046 SymbolAssignment *readAssignment(StringRef Name);
George Rimare38cbab2016-09-26 19:22:50 +00001047 BytesDataCommand *readBytesDataCommand(StringRef Tok);
Rui Ueyama16068ae2016-11-19 18:05:56 +00001048 uint32_t readFill();
Rui Ueyama10416562016-08-04 02:03:27 +00001049 OutputSectionCommand *readOutputSectionDescription(StringRef OutSec);
Rui Ueyama16068ae2016-11-19 18:05:56 +00001050 uint32_t readOutputSectionFiller(StringRef Tok);
Eugene Leviantbbe38602016-07-19 09:25:43 +00001051 std::vector<StringRef> readOutputSectionPhdrs();
George Rimara2496cb2016-08-30 09:46:59 +00001052 InputSectionDescription *readInputSectionDescription(StringRef Tok);
Eugene Leviantdb688452016-11-03 10:54:58 +00001053 StringMatcher readFilePatterns();
George Rimar07171f22016-09-21 15:56:44 +00001054 std::vector<SectionPattern> readInputSectionsList();
George Rimara2496cb2016-08-30 09:46:59 +00001055 InputSectionDescription *readInputSectionRules(StringRef FilePattern);
Eugene Leviantbbe38602016-07-19 09:25:43 +00001056 unsigned readPhdrType();
George Rimarbe394db2016-09-16 20:21:55 +00001057 SortSectionPolicy readSortKind();
Petr Hoseka35e39c2016-08-16 01:11:16 +00001058 SymbolAssignment *readProvideHidden(bool Provide, bool Hidden);
Rafael Espindolac96da112016-11-01 11:30:45 +00001059 SymbolAssignment *readProvideOrAssignment(StringRef Tok);
George Rimar03fc0102016-07-28 07:18:23 +00001060 void readSort();
George Rimareefa7582016-08-04 09:29:31 +00001061 Expr readAssert();
Rui Ueyama708019c2016-07-24 18:19:40 +00001062
Rui Ueyama24e626c2017-01-26 02:58:19 +00001063 uint64_t readMemoryAssignment(StringRef, StringRef, StringRef);
1064 std::pair<uint32_t, uint32_t> readMemoryAttributes();
1065
Rui Ueyama708019c2016-07-24 18:19:40 +00001066 Expr readExpr();
1067 Expr readExpr1(Expr Lhs, int MinPrec);
Eugene Leviantb71d6f72016-10-06 09:39:28 +00001068 StringRef readParenLiteral();
Rui Ueyama708019c2016-07-24 18:19:40 +00001069 Expr readPrimary();
1070 Expr readTernary(Expr Cond);
Rui Ueyama6ad7dfc2016-08-17 18:59:16 +00001071 Expr readParenExpr();
Rui Ueyamaf7c5fbb2015-09-30 17:23:26 +00001072
George Rimar20b65982016-08-31 09:08:26 +00001073 // For parsing version script.
Rui Ueyama12450b22016-11-18 06:30:09 +00001074 std::vector<SymbolVersion> readVersionExtern();
1075 void readAnonymousDeclaration();
Rui Ueyama95769b42016-08-31 20:03:54 +00001076 void readVersionDeclaration(StringRef VerStr);
Rui Ueyama12450b22016-11-18 06:30:09 +00001077 std::vector<SymbolVersion> readSymbols();
Rafael Espindolae999ddb2017-01-10 16:37:24 +00001078 void readLocals();
George Rimar20b65982016-08-31 09:08:26 +00001079
Rui Ueyama07320e42016-04-20 20:13:41 +00001080 ScriptConfiguration &Opt = *ScriptConfig;
Simon Atanasyan16b0cc92015-11-26 05:53:00 +00001081 bool IsUnderSysroot;
Rui Ueyamaf7c5fbb2015-09-30 17:23:26 +00001082};
Rui Ueyamaf7c5fbb2015-09-30 17:23:26 +00001083
Rafael Espindolad0ebd842016-12-08 17:54:26 +00001084void ScriptParser::readDynamicList() {
1085 expect("{");
1086 readAnonymousDeclaration();
1087 if (!atEOF())
1088 setError("EOF expected, but got " + next());
1089}
1090
George Rimar20b65982016-08-31 09:08:26 +00001091void ScriptParser::readVersionScript() {
Rui Ueyama95769b42016-08-31 20:03:54 +00001092 readVersionScriptCommand();
1093 if (!atEOF())
1094 setError("EOF expected, but got " + next());
1095}
1096
1097void ScriptParser::readVersionScriptCommand() {
Rui Ueyama83043f22016-10-17 16:01:53 +00001098 if (consume("{")) {
Rui Ueyama12450b22016-11-18 06:30:09 +00001099 readAnonymousDeclaration();
George Rimar20b65982016-08-31 09:08:26 +00001100 return;
1101 }
1102
Rui Ueyama95769b42016-08-31 20:03:54 +00001103 while (!atEOF() && !Error && peek() != "}") {
George Rimar20b65982016-08-31 09:08:26 +00001104 StringRef VerStr = next();
1105 if (VerStr == "{") {
Rui Ueyama95769b42016-08-31 20:03:54 +00001106 setError("anonymous version definition is used in "
1107 "combination with other version definitions");
George Rimar20b65982016-08-31 09:08:26 +00001108 return;
1109 }
1110 expect("{");
Rui Ueyama95769b42016-08-31 20:03:54 +00001111 readVersionDeclaration(VerStr);
George Rimar20b65982016-08-31 09:08:26 +00001112 }
1113}
1114
Rui Ueyama95769b42016-08-31 20:03:54 +00001115void ScriptParser::readVersion() {
1116 expect("{");
1117 readVersionScriptCommand();
1118 expect("}");
1119}
1120
George Rimar20b65982016-08-31 09:08:26 +00001121void ScriptParser::readLinkerScript() {
Rui Ueyamaf7c5fbb2015-09-30 17:23:26 +00001122 while (!atEOF()) {
1123 StringRef Tok = next();
Rui Ueyamaa27eecc2016-09-02 18:52:41 +00001124 if (Tok == ";")
1125 continue;
1126
Eugene Leviant20d03192016-09-16 15:30:47 +00001127 if (Tok == "ASSERT") {
1128 Opt.Commands.emplace_back(new AssertCommand(readAssert()));
1129 } else if (Tok == "ENTRY") {
Rui Ueyamaa27eecc2016-09-02 18:52:41 +00001130 readEntry();
1131 } else if (Tok == "EXTERN") {
1132 readExtern();
1133 } else if (Tok == "GROUP" || Tok == "INPUT") {
1134 readGroup();
1135 } else if (Tok == "INCLUDE") {
1136 readInclude();
Meador Ingeb8897442017-01-24 02:34:00 +00001137 } else if (Tok == "MEMORY") {
1138 readMemory();
Rui Ueyamaa27eecc2016-09-02 18:52:41 +00001139 } else if (Tok == "OUTPUT") {
1140 readOutput();
1141 } else if (Tok == "OUTPUT_ARCH") {
1142 readOutputArch();
1143 } else if (Tok == "OUTPUT_FORMAT") {
1144 readOutputFormat();
1145 } else if (Tok == "PHDRS") {
1146 readPhdrs();
1147 } else if (Tok == "SEARCH_DIR") {
1148 readSearchDir();
1149 } else if (Tok == "SECTIONS") {
1150 readSections();
1151 } else if (Tok == "VERSION") {
1152 readVersion();
Rafael Espindolac96da112016-11-01 11:30:45 +00001153 } else if (SymbolAssignment *Cmd = readProvideOrAssignment(Tok)) {
Eugene Leviant20d03192016-09-16 15:30:47 +00001154 Opt.Commands.emplace_back(Cmd);
Petr Hoseke5d3ca52016-08-31 15:31:17 +00001155 } else {
George Rimar57610422016-03-11 14:43:02 +00001156 setError("unknown directive: " + Tok);
Petr Hoseke5d3ca52016-08-31 15:31:17 +00001157 }
Rui Ueyamaf7c5fbb2015-09-30 17:23:26 +00001158 }
1159}
1160
Rui Ueyama717677a2016-02-11 21:17:59 +00001161void ScriptParser::addFile(StringRef S) {
Simon Atanasyan16b0cc92015-11-26 05:53:00 +00001162 if (IsUnderSysroot && S.startswith("/")) {
Justin Bogner5af16872016-10-17 06:08:48 +00001163 SmallString<128> PathData;
1164 StringRef Path = (Config->Sysroot + S).toStringRef(PathData);
Simon Atanasyan16b0cc92015-11-26 05:53:00 +00001165 if (sys::fs::exists(Path)) {
Justin Bogner5af16872016-10-17 06:08:48 +00001166 Driver->addFile(Saver.save(Path));
Simon Atanasyan16b0cc92015-11-26 05:53:00 +00001167 return;
1168 }
1169 }
1170
Rui Ueyamaf03f3cc2015-10-13 00:09:21 +00001171 if (sys::path::is_absolute(S)) {
Rui Ueyama52a15092015-10-11 03:28:42 +00001172 Driver->addFile(S);
1173 } else if (S.startswith("=")) {
1174 if (Config->Sysroot.empty())
1175 Driver->addFile(S.substr(1));
1176 else
1177 Driver->addFile(Saver.save(Config->Sysroot + "/" + S.substr(1)));
1178 } else if (S.startswith("-l")) {
Rui Ueyama21eecb42016-02-02 21:13:09 +00001179 Driver->addLibrary(S.substr(2));
Simon Atanasyana1b8fc32015-11-26 20:23:46 +00001180 } else if (sys::fs::exists(S)) {
1181 Driver->addFile(S);
Rui Ueyama52a15092015-10-11 03:28:42 +00001182 } else {
Rui Ueyama061f9282016-11-19 19:23:58 +00001183 if (Optional<std::string> Path = findFromSearchPaths(S))
1184 Driver->addFile(Saver.save(*Path));
Rui Ueyama025d59b2016-02-02 20:27:59 +00001185 else
Rui Ueyama061f9282016-11-19 19:23:58 +00001186 setError("unable to find " + S);
Rui Ueyama52a15092015-10-11 03:28:42 +00001187 }
1188}
1189
Rui Ueyama717677a2016-02-11 21:17:59 +00001190void ScriptParser::readAsNeeded() {
Rui Ueyamaf7c5fbb2015-09-30 17:23:26 +00001191 expect("(");
Rui Ueyama35da9b62015-10-11 20:59:12 +00001192 bool Orig = Config->AsNeeded;
1193 Config->AsNeeded = true;
Rui Ueyama83043f22016-10-17 16:01:53 +00001194 while (!Error && !consume(")"))
George Rimarcd574a52016-09-09 14:35:36 +00001195 addFile(unquote(next()));
Rui Ueyama35da9b62015-10-11 20:59:12 +00001196 Config->AsNeeded = Orig;
Rui Ueyamaf7c5fbb2015-09-30 17:23:26 +00001197}
1198
Rui Ueyama717677a2016-02-11 21:17:59 +00001199void ScriptParser::readEntry() {
Denis Protivensky90c50992015-10-08 06:48:38 +00001200 // -e <symbol> takes predecence over ENTRY(<symbol>).
1201 expect("(");
1202 StringRef Tok = next();
1203 if (Config->Entry.empty())
1204 Config->Entry = Tok;
1205 expect(")");
1206}
1207
Rui Ueyama717677a2016-02-11 21:17:59 +00001208void ScriptParser::readExtern() {
George Rimar83f406c2015-10-19 17:35:12 +00001209 expect("(");
Rui Ueyama83043f22016-10-17 16:01:53 +00001210 while (!Error && !consume(")"))
Rui Ueyamaa2acc932016-08-05 01:25:45 +00001211 Config->Undefined.push_back(next());
George Rimar83f406c2015-10-19 17:35:12 +00001212}
1213
Rui Ueyama717677a2016-02-11 21:17:59 +00001214void ScriptParser::readGroup() {
Rui Ueyamaf7c5fbb2015-09-30 17:23:26 +00001215 expect("(");
Rui Ueyama83043f22016-10-17 16:01:53 +00001216 while (!Error && !consume(")")) {
Rui Ueyamaf7c5fbb2015-09-30 17:23:26 +00001217 StringRef Tok = next();
Rui Ueyamaa2acc932016-08-05 01:25:45 +00001218 if (Tok == "AS_NEEDED")
Rui Ueyamaf7c5fbb2015-09-30 17:23:26 +00001219 readAsNeeded();
Rui Ueyamaa2acc932016-08-05 01:25:45 +00001220 else
George Rimarcd574a52016-09-09 14:35:36 +00001221 addFile(unquote(Tok));
Rui Ueyamaf7c5fbb2015-09-30 17:23:26 +00001222 }
1223}
1224
Rui Ueyama717677a2016-02-11 21:17:59 +00001225void ScriptParser::readInclude() {
George Rimard4500652016-12-21 09:42:25 +00001226 StringRef Tok = unquote(next());
Rui Ueyamaec1c75e2017-01-09 01:42:02 +00001227
George Rimard4500652016-12-21 09:42:25 +00001228 // https://sourceware.org/binutils/docs/ld/File-Commands.html:
1229 // The file will be searched for in the current directory, and in any
1230 // directory specified with the -L option.
Rui Ueyamaec1c75e2017-01-09 01:42:02 +00001231 if (sys::fs::exists(Tok)) {
1232 if (Optional<MemoryBufferRef> MB = readFile(Tok))
1233 tokenize(*MB);
Rui Ueyama025d59b2016-02-02 20:27:59 +00001234 return;
1235 }
Rui Ueyamaec1c75e2017-01-09 01:42:02 +00001236 if (Optional<std::string> Path = findFromSearchPaths(Tok)) {
1237 if (Optional<MemoryBufferRef> MB = readFile(*Path))
1238 tokenize(*MB);
1239 return;
1240 }
1241 setError("cannot open " + Tok);
Rui Ueyama31aa1f82015-10-11 01:31:55 +00001242}
1243
Rui Ueyama717677a2016-02-11 21:17:59 +00001244void ScriptParser::readOutput() {
Rui Ueyamaee592822015-10-07 00:25:09 +00001245 // -o <file> takes predecence over OUTPUT(<file>).
1246 expect("(");
1247 StringRef Tok = next();
1248 if (Config->OutputFile.empty())
George Rimarcd574a52016-09-09 14:35:36 +00001249 Config->OutputFile = unquote(Tok);
Rui Ueyamaee592822015-10-07 00:25:09 +00001250 expect(")");
1251}
1252
Rui Ueyama717677a2016-02-11 21:17:59 +00001253void ScriptParser::readOutputArch() {
Davide Italiano9159ce92015-10-12 21:50:08 +00001254 // Error checking only for now.
1255 expect("(");
Justin Bogner5424e7c2016-10-17 06:21:13 +00001256 skip();
Davide Italiano9159ce92015-10-12 21:50:08 +00001257 expect(")");
1258}
1259
Rui Ueyama717677a2016-02-11 21:17:59 +00001260void ScriptParser::readOutputFormat() {
Rui Ueyamaf7c5fbb2015-09-30 17:23:26 +00001261 // Error checking only for now.
1262 expect("(");
Justin Bogner5424e7c2016-10-17 06:21:13 +00001263 skip();
Davide Italiano6836c612015-10-12 21:08:41 +00001264 StringRef Tok = next();
1265 if (Tok == ")")
George Rimar6c55f0e2016-09-08 08:20:30 +00001266 return;
Rui Ueyama025d59b2016-02-02 20:27:59 +00001267 if (Tok != ",") {
George Rimar57610422016-03-11 14:43:02 +00001268 setError("unexpected token: " + Tok);
Rui Ueyama025d59b2016-02-02 20:27:59 +00001269 return;
1270 }
Justin Bogner5424e7c2016-10-17 06:21:13 +00001271 skip();
Davide Italiano6836c612015-10-12 21:08:41 +00001272 expect(",");
Justin Bogner5424e7c2016-10-17 06:21:13 +00001273 skip();
Rui Ueyamaf7c5fbb2015-09-30 17:23:26 +00001274 expect(")");
1275}
1276
Eugene Leviantbbe38602016-07-19 09:25:43 +00001277void ScriptParser::readPhdrs() {
1278 expect("{");
Rui Ueyama83043f22016-10-17 16:01:53 +00001279 while (!Error && !consume("}")) {
Eugene Leviantbbe38602016-07-19 09:25:43 +00001280 StringRef Tok = next();
Eugene Leviant56b21c82016-09-09 09:46:16 +00001281 Opt.PhdrsCommands.push_back(
1282 {Tok, PT_NULL, false, false, UINT_MAX, nullptr});
Eugene Leviantbbe38602016-07-19 09:25:43 +00001283 PhdrsCommand &PhdrCmd = Opt.PhdrsCommands.back();
1284
1285 PhdrCmd.Type = readPhdrType();
1286 do {
1287 Tok = next();
1288 if (Tok == ";")
1289 break;
1290 if (Tok == "FILEHDR")
1291 PhdrCmd.HasFilehdr = true;
1292 else if (Tok == "PHDRS")
1293 PhdrCmd.HasPhdrs = true;
Eugene Leviant56b21c82016-09-09 09:46:16 +00001294 else if (Tok == "AT")
1295 PhdrCmd.LMAExpr = readParenExpr();
Eugene Leviant865bf862016-07-21 10:43:25 +00001296 else if (Tok == "FLAGS") {
1297 expect("(");
Rafael Espindolaeb685cd2016-08-02 22:14:57 +00001298 // Passing 0 for the value of dot is a bit of a hack. It means that
1299 // we accept expressions like ".|1".
1300 PhdrCmd.Flags = readExpr()(0);
Eugene Leviant865bf862016-07-21 10:43:25 +00001301 expect(")");
1302 } else
Eugene Leviantbbe38602016-07-19 09:25:43 +00001303 setError("unexpected header attribute: " + Tok);
1304 } while (!Error);
1305 }
1306}
1307
Rui Ueyama717677a2016-02-11 21:17:59 +00001308void ScriptParser::readSearchDir() {
Davide Italiano68a39a62015-10-08 17:51:41 +00001309 expect("(");
Rui Ueyama86c5fb82016-09-08 23:26:54 +00001310 StringRef Tok = next();
Rui Ueyama6c7ad132016-09-02 19:20:33 +00001311 if (!Config->Nostdlib)
George Rimarcd574a52016-09-09 14:35:36 +00001312 Config->SearchPaths.push_back(unquote(Tok));
Davide Italiano68a39a62015-10-08 17:51:41 +00001313 expect(")");
1314}
1315
Rui Ueyama717677a2016-02-11 21:17:59 +00001316void ScriptParser::readSections() {
Eugene Leviante05336ff2016-09-14 08:32:36 +00001317 Opt.HasSections = true;
George Rimar18a30962016-11-28 10:11:10 +00001318 // -no-rosegment is used to avoid placing read only non-executable sections in
1319 // their own segment. We do the same if SECTIONS command is present in linker
1320 // script. See comment for computeFlags().
1321 Config->SingleRoRx = true;
1322
Denis Protivensky8e3b38a2015-11-12 09:52:08 +00001323 expect("{");
Rui Ueyama83043f22016-10-17 16:01:53 +00001324 while (!Error && !consume("}")) {
Rui Ueyama113cdec2016-07-24 23:05:57 +00001325 StringRef Tok = next();
Rafael Espindolac96da112016-11-01 11:30:45 +00001326 BaseCommand *Cmd = readProvideOrAssignment(Tok);
Eugene Leviantceabe802016-08-11 07:56:43 +00001327 if (!Cmd) {
1328 if (Tok == "ASSERT")
1329 Cmd = new AssertCommand(readAssert());
1330 else
1331 Cmd = readOutputSectionDescription(Tok);
Rui Ueyama708019c2016-07-24 18:19:40 +00001332 }
Rui Ueyama10416562016-08-04 02:03:27 +00001333 Opt.Commands.emplace_back(Cmd);
George Rimar652852c2016-04-16 10:10:32 +00001334 }
Denis Protivensky8e3b38a2015-11-12 09:52:08 +00001335}
1336
Rui Ueyama708019c2016-07-24 18:19:40 +00001337static int precedence(StringRef Op) {
1338 return StringSwitch<int>(Op)
Rui Ueyama0120e3f2016-09-23 18:06:51 +00001339 .Cases("*", "/", 5)
1340 .Cases("+", "-", 4)
1341 .Cases("<<", ">>", 3)
Rui Ueyama9c4ac5f2016-09-23 22:22:34 +00001342 .Cases("<", "<=", ">", ">=", "==", "!=", 2)
Rui Ueyama0120e3f2016-09-23 18:06:51 +00001343 .Cases("&", "|", 1)
Rui Ueyama708019c2016-07-24 18:19:40 +00001344 .Default(-1);
1345}
1346
Eugene Leviantdb688452016-11-03 10:54:58 +00001347StringMatcher ScriptParser::readFilePatterns() {
Rui Ueyama10416562016-08-04 02:03:27 +00001348 std::vector<StringRef> V;
Rui Ueyama83043f22016-10-17 16:01:53 +00001349 while (!Error && !consume(")"))
Rui Ueyama10416562016-08-04 02:03:27 +00001350 V.push_back(next());
Rui Ueyamaf91282e2016-11-03 17:57:38 +00001351 return StringMatcher(V);
George Rimar0702c4e2016-07-29 15:32:46 +00001352}
1353
George Rimarbe394db2016-09-16 20:21:55 +00001354SortSectionPolicy ScriptParser::readSortKind() {
Rui Ueyama83043f22016-10-17 16:01:53 +00001355 if (consume("SORT") || consume("SORT_BY_NAME"))
George Rimarbe394db2016-09-16 20:21:55 +00001356 return SortSectionPolicy::Name;
Rui Ueyama83043f22016-10-17 16:01:53 +00001357 if (consume("SORT_BY_ALIGNMENT"))
George Rimarbe394db2016-09-16 20:21:55 +00001358 return SortSectionPolicy::Alignment;
Rui Ueyama83043f22016-10-17 16:01:53 +00001359 if (consume("SORT_BY_INIT_PRIORITY"))
George Rimarbe394db2016-09-16 20:21:55 +00001360 return SortSectionPolicy::Priority;
Rui Ueyama83043f22016-10-17 16:01:53 +00001361 if (consume("SORT_NONE"))
Rui Ueyamab2a0abd2016-09-16 21:14:55 +00001362 return SortSectionPolicy::None;
1363 return SortSectionPolicy::Default;
George Rimarbe394db2016-09-16 20:21:55 +00001364}
1365
George Rimar395281c2016-09-16 17:42:10 +00001366// Method reads a list of sequence of excluded files and section globs given in
1367// a following form: ((EXCLUDE_FILE(file_pattern+))? section_pattern+)+
1368// Example: *(.foo.1 EXCLUDE_FILE (*a.o) .foo.2 EXCLUDE_FILE (*b.o) .foo.3)
George Rimaraf03be12016-09-17 19:17:25 +00001369// The semantics of that is next:
1370// * Include .foo.1 from every file.
1371// * Include .foo.2 from every file but a.o
1372// * Include .foo.3 from every file but b.o
George Rimar07171f22016-09-21 15:56:44 +00001373std::vector<SectionPattern> ScriptParser::readInputSectionsList() {
1374 std::vector<SectionPattern> Ret;
George Rimar601e9892016-09-21 08:53:21 +00001375 while (!Error && peek() != ")") {
Rui Ueyamaf91282e2016-11-03 17:57:38 +00001376 StringMatcher ExcludeFilePat;
Rui Ueyama83043f22016-10-17 16:01:53 +00001377 if (consume("EXCLUDE_FILE")) {
George Rimar395281c2016-09-16 17:42:10 +00001378 expect("(");
Rui Ueyamaf91282e2016-11-03 17:57:38 +00001379 ExcludeFilePat = readFilePatterns();
George Rimar395281c2016-09-16 17:42:10 +00001380 }
1381
George Rimar601e9892016-09-21 08:53:21 +00001382 std::vector<StringRef> V;
1383 while (!Error && peek() != ")" && peek() != "EXCLUDE_FILE")
1384 V.push_back(next());
1385
1386 if (!V.empty())
Rui Ueyamaf91282e2016-11-03 17:57:38 +00001387 Ret.push_back({std::move(ExcludeFilePat), StringMatcher(V)});
George Rimar601e9892016-09-21 08:53:21 +00001388 else
1389 setError("section pattern is expected");
George Rimar395281c2016-09-16 17:42:10 +00001390 }
George Rimar07171f22016-09-21 15:56:44 +00001391 return Ret;
George Rimar395281c2016-09-16 17:42:10 +00001392}
1393
Rui Ueyamaf8f6f1e2016-11-18 07:03:56 +00001394// Reads contents of "SECTIONS" directive. That directive contains a
1395// list of glob patterns for input sections. The grammar is as follows.
1396//
1397// <patterns> ::= <section-list>
1398// | <sort> "(" <section-list> ")"
1399// | <sort> "(" <sort> "(" <section-list> ")" ")"
1400//
1401// <sort> ::= "SORT" | "SORT_BY_NAME" | "SORT_BY_ALIGNMENT"
1402// | "SORT_BY_INIT_PRIORITY" | "SORT_NONE"
1403//
1404// <section-list> is parsed by readInputSectionsList().
George Rimara2496cb2016-08-30 09:46:59 +00001405InputSectionDescription *
1406ScriptParser::readInputSectionRules(StringRef FilePattern) {
George Rimarc91930a2016-09-02 21:17:20 +00001407 auto *Cmd = new InputSectionDescription(FilePattern);
Davide Italiano0ed42b02016-07-25 21:47:13 +00001408 expect("(");
Rui Ueyamaf373dd72016-11-24 01:43:21 +00001409 while (!Error && !consume(")")) {
George Rimar07171f22016-09-21 15:56:44 +00001410 SortSectionPolicy Outer = readSortKind();
1411 SortSectionPolicy Inner = SortSectionPolicy::Default;
1412 std::vector<SectionPattern> V;
1413 if (Outer != SortSectionPolicy::Default) {
George Rimar350ece42016-08-03 08:35:59 +00001414 expect("(");
George Rimar07171f22016-09-21 15:56:44 +00001415 Inner = readSortKind();
1416 if (Inner != SortSectionPolicy::Default) {
1417 expect("(");
1418 V = readInputSectionsList();
1419 expect(")");
1420 } else {
1421 V = readInputSectionsList();
1422 }
George Rimar350ece42016-08-03 08:35:59 +00001423 expect(")");
1424 } else {
George Rimar07171f22016-09-21 15:56:44 +00001425 V = readInputSectionsList();
George Rimar350ece42016-08-03 08:35:59 +00001426 }
George Rimar0702c4e2016-07-29 15:32:46 +00001427
George Rimar07171f22016-09-21 15:56:44 +00001428 for (SectionPattern &Pat : V) {
1429 Pat.SortInner = Inner;
1430 Pat.SortOuter = Outer;
1431 }
1432
1433 std::move(V.begin(), V.end(), std::back_inserter(Cmd->SectionPatterns));
1434 }
Rui Ueyama10416562016-08-04 02:03:27 +00001435 return Cmd;
Davide Italianoe7282792016-07-27 01:44:01 +00001436}
1437
George Rimara2496cb2016-08-30 09:46:59 +00001438InputSectionDescription *
1439ScriptParser::readInputSectionDescription(StringRef Tok) {
George Rimar06598002016-07-28 21:51:30 +00001440 // Input section wildcard can be surrounded by KEEP.
1441 // https://sourceware.org/binutils/docs/ld/Input-Section-Keep.html#Input-Section-Keep
George Rimara2496cb2016-08-30 09:46:59 +00001442 if (Tok == "KEEP") {
George Rimar06598002016-07-28 21:51:30 +00001443 expect("(");
George Rimara2496cb2016-08-30 09:46:59 +00001444 StringRef FilePattern = next();
1445 InputSectionDescription *Cmd = readInputSectionRules(FilePattern);
George Rimar06598002016-07-28 21:51:30 +00001446 expect(")");
Eugene Leviantcf43f172016-10-05 09:36:59 +00001447 Opt.KeptSections.push_back(Cmd);
Rui Ueyama10416562016-08-04 02:03:27 +00001448 return Cmd;
George Rimar06598002016-07-28 21:51:30 +00001449 }
George Rimara2496cb2016-08-30 09:46:59 +00001450 return readInputSectionRules(Tok);
Davide Italiano0ed42b02016-07-25 21:47:13 +00001451}
1452
George Rimar03fc0102016-07-28 07:18:23 +00001453void ScriptParser::readSort() {
1454 expect("(");
1455 expect("CONSTRUCTORS");
1456 expect(")");
1457}
1458
George Rimareefa7582016-08-04 09:29:31 +00001459Expr ScriptParser::readAssert() {
1460 expect("(");
1461 Expr E = readExpr();
1462 expect(",");
George Rimarcd574a52016-09-09 14:35:36 +00001463 StringRef Msg = unquote(next());
George Rimareefa7582016-08-04 09:29:31 +00001464 expect(")");
1465 return [=](uint64_t Dot) {
1466 uint64_t V = E(Dot);
1467 if (!V)
1468 error(Msg);
1469 return V;
1470 };
1471}
1472
Rui Ueyama25150e82016-09-06 17:46:43 +00001473// Reads a FILL(expr) command. We handle the FILL command as an
1474// alias for =fillexp section attribute, which is different from
1475// what GNU linkers do.
1476// https://sourceware.org/binutils/docs/ld/Output-Section-Data.html
Rui Ueyama16068ae2016-11-19 18:05:56 +00001477uint32_t ScriptParser::readFill() {
George Rimarff1f29e2016-09-06 13:51:57 +00001478 expect("(");
Rui Ueyama16068ae2016-11-19 18:05:56 +00001479 uint32_t V = readOutputSectionFiller(next());
George Rimarff1f29e2016-09-06 13:51:57 +00001480 expect(")");
1481 expect(";");
1482 return V;
1483}
1484
Rui Ueyama10416562016-08-04 02:03:27 +00001485OutputSectionCommand *
1486ScriptParser::readOutputSectionDescription(StringRef OutSec) {
George Rimar076fe152016-07-21 06:43:01 +00001487 OutputSectionCommand *Cmd = new OutputSectionCommand(OutSec);
Eugene Leviant2a942c42016-12-05 16:38:32 +00001488 Cmd->Location = getCurrentLocation();
George Rimar58e5c4d2016-07-25 08:29:46 +00001489
1490 // Read an address expression.
1491 // https://sourceware.org/binutils/docs/ld/Output-Section-Address.html#Output-Section-Address
1492 if (peek() != ":")
1493 Cmd->AddrExpr = readExpr();
1494
Denis Protivensky8e3b38a2015-11-12 09:52:08 +00001495 expect(":");
Davide Italiano246f6812016-07-22 03:36:24 +00001496
Rui Ueyama83043f22016-10-17 16:01:53 +00001497 if (consume("AT"))
Eugene Leviantb71d6f72016-10-06 09:39:28 +00001498 Cmd->LMAExpr = readParenExpr();
Rui Ueyama83043f22016-10-17 16:01:53 +00001499 if (consume("ALIGN"))
Rui Ueyama6ad7dfc2016-08-17 18:59:16 +00001500 Cmd->AlignExpr = readParenExpr();
Rui Ueyama83043f22016-10-17 16:01:53 +00001501 if (consume("SUBALIGN"))
George Rimardb24d9c2016-08-19 15:18:23 +00001502 Cmd->SubalignExpr = readParenExpr();
George Rimar630c6172016-07-26 18:06:29 +00001503
Davide Italiano246f6812016-07-22 03:36:24 +00001504 // Parse constraints.
Rui Ueyama83043f22016-10-17 16:01:53 +00001505 if (consume("ONLY_IF_RO"))
Rui Ueyamaefc40662016-07-25 22:00:10 +00001506 Cmd->Constraint = ConstraintKind::ReadOnly;
Rui Ueyama83043f22016-10-17 16:01:53 +00001507 if (consume("ONLY_IF_RW"))
Rui Ueyamaefc40662016-07-25 22:00:10 +00001508 Cmd->Constraint = ConstraintKind::ReadWrite;
Denis Protivensky8e3b38a2015-11-12 09:52:08 +00001509 expect("{");
Rui Ueyama8ec77e62016-04-21 22:00:51 +00001510
Rui Ueyama83043f22016-10-17 16:01:53 +00001511 while (!Error && !consume("}")) {
Eugene Leviantceabe802016-08-11 07:56:43 +00001512 StringRef Tok = next();
George Rimar2fe07922017-01-31 08:50:11 +00001513 if (Tok == ";") {
George Rimar69750752017-02-01 09:14:22 +00001514 // Empty commands are allowed. Do nothing here.
George Rimar2fe07922017-01-31 08:50:11 +00001515 } else if (SymbolAssignment *Assignment = readProvideOrAssignment(Tok)) {
Eugene Leviantceabe802016-08-11 07:56:43 +00001516 Cmd->Commands.emplace_back(Assignment);
Meador Ingeb2d99d62016-11-22 18:01:50 +00001517 } else if (BytesDataCommand *Data = readBytesDataCommand(Tok)) {
George Rimare38cbab2016-09-26 19:22:50 +00001518 Cmd->Commands.emplace_back(Data);
Meador Ingeb2d99d62016-11-22 18:01:50 +00001519 } else if (Tok == "ASSERT") {
1520 Cmd->Commands.emplace_back(new AssertCommand(readAssert()));
1521 expect(";");
George Rimar8e2eca22017-01-23 09:36:19 +00001522 } else if (Tok == "CONSTRUCTORS") {
1523 // CONSTRUCTORS is a keyword to make the linker recognize C++ ctors/dtors
1524 // by name. This is for very old file formats such as ECOFF/XCOFF.
1525 // For ELF, we should ignore.
Meador Ingeb2d99d62016-11-22 18:01:50 +00001526 } else if (Tok == "FILL") {
George Rimarff1f29e2016-09-06 13:51:57 +00001527 Cmd->Filler = readFill();
Meador Ingeb2d99d62016-11-22 18:01:50 +00001528 } else if (Tok == "SORT") {
George Rimar03fc0102016-07-28 07:18:23 +00001529 readSort();
Meador Ingeb2d99d62016-11-22 18:01:50 +00001530 } else if (peek() == "(") {
George Rimara2496cb2016-08-30 09:46:59 +00001531 Cmd->Commands.emplace_back(readInputSectionDescription(Tok));
Meador Ingeb2d99d62016-11-22 18:01:50 +00001532 } else {
Eugene Leviantceabe802016-08-11 07:56:43 +00001533 setError("unknown command " + Tok);
Meador Ingeb2d99d62016-11-22 18:01:50 +00001534 }
Denis Protivensky8e3b38a2015-11-12 09:52:08 +00001535 }
Meador Ingeb8897442017-01-24 02:34:00 +00001536
1537 if (consume(">"))
1538 Cmd->MemoryRegionName = next();
1539
George Rimar076fe152016-07-21 06:43:01 +00001540 Cmd->Phdrs = readOutputSectionPhdrs();
George Rimar4ebc5622016-09-23 13:29:20 +00001541
Rui Ueyama83043f22016-10-17 16:01:53 +00001542 if (consume("="))
George Rimar4ebc5622016-09-23 13:29:20 +00001543 Cmd->Filler = readOutputSectionFiller(next());
1544 else if (peek().startswith("="))
George Rimarff1f29e2016-09-06 13:51:57 +00001545 Cmd->Filler = readOutputSectionFiller(next().drop_front());
George Rimar4ebc5622016-09-23 13:29:20 +00001546
George Rimar7185a1a2017-01-17 15:32:12 +00001547 // Consume optional comma following output section command.
1548 consume(",");
1549
Rui Ueyama10416562016-08-04 02:03:27 +00001550 return Cmd;
Rui Ueyamaf71caa22016-07-29 06:14:07 +00001551}
Rui Ueyama8ec77e62016-04-21 22:00:51 +00001552
Rui Ueyama2c8f1f02016-08-29 22:01:21 +00001553// Read "=<number>" where <number> is an octal/decimal/hexadecimal number.
1554// https://sourceware.org/binutils/docs/ld/Output-Section-Fill.html
1555//
1556// ld.gold is not fully compatible with ld.bfd. ld.bfd handles
1557// hexstrings as blobs of arbitrary sizes, while ld.gold handles them
1558// as 32-bit big-endian values. We will do the same as ld.gold does
1559// because it's simpler than what ld.bfd does.
Rui Ueyama16068ae2016-11-19 18:05:56 +00001560uint32_t ScriptParser::readOutputSectionFiller(StringRef Tok) {
Rui Ueyama965827d2016-08-03 23:25:15 +00001561 uint32_t V;
Rui Ueyama16068ae2016-11-19 18:05:56 +00001562 if (!Tok.getAsInteger(0, V))
1563 return V;
1564 setError("invalid filler expression: " + Tok);
1565 return 0;
Denis Protivensky8e3b38a2015-11-12 09:52:08 +00001566}
1567
Petr Hoseka35e39c2016-08-16 01:11:16 +00001568SymbolAssignment *ScriptParser::readProvideHidden(bool Provide, bool Hidden) {
Eugene Levianta31c91b2016-07-22 07:38:40 +00001569 expect("(");
Rui Ueyama174e0a12016-07-29 00:29:25 +00001570 SymbolAssignment *Cmd = readAssignment(next());
Petr Hoseka35e39c2016-08-16 01:11:16 +00001571 Cmd->Provide = Provide;
Rui Ueyama174e0a12016-07-29 00:29:25 +00001572 Cmd->Hidden = Hidden;
Eugene Levianta31c91b2016-07-22 07:38:40 +00001573 expect(")");
1574 expect(";");
Rui Ueyama10416562016-08-04 02:03:27 +00001575 return Cmd;
Eugene Levianteda81a12016-07-12 06:39:48 +00001576}
1577
Rafael Espindolac96da112016-11-01 11:30:45 +00001578SymbolAssignment *ScriptParser::readProvideOrAssignment(StringRef Tok) {
Eugene Leviantceabe802016-08-11 07:56:43 +00001579 SymbolAssignment *Cmd = nullptr;
1580 if (peek() == "=" || peek() == "+=") {
1581 Cmd = readAssignment(Tok);
1582 expect(";");
1583 } else if (Tok == "PROVIDE") {
Petr Hoseka35e39c2016-08-16 01:11:16 +00001584 Cmd = readProvideHidden(true, false);
1585 } else if (Tok == "HIDDEN") {
1586 Cmd = readProvideHidden(false, true);
Eugene Leviantceabe802016-08-11 07:56:43 +00001587 } else if (Tok == "PROVIDE_HIDDEN") {
Petr Hoseka35e39c2016-08-16 01:11:16 +00001588 Cmd = readProvideHidden(true, true);
Eugene Leviantceabe802016-08-11 07:56:43 +00001589 }
1590 return Cmd;
1591}
1592
Eugene Leviantf6aeed32016-12-22 13:13:12 +00001593static uint64_t getSymbolValue(const Twine &Loc, StringRef S, uint64_t Dot) {
George Rimar30835ea2016-07-28 21:08:56 +00001594 if (S == ".")
1595 return Dot;
Eugene Leviantf6aeed32016-12-22 13:13:12 +00001596 return ScriptBase->getSymbolValue(Loc, S);
George Rimare32a3592016-08-10 07:59:34 +00001597}
1598
Rafael Espindola2f831dc2016-10-31 19:56:37 +00001599static bool isAbsolute(StringRef S) {
1600 if (S == ".")
1601 return false;
1602 return ScriptBase->isAbsolute(S);
1603}
1604
George Rimar30835ea2016-07-28 21:08:56 +00001605SymbolAssignment *ScriptParser::readAssignment(StringRef Name) {
1606 StringRef Op = next();
Eugene Leviantdb741e72016-09-07 07:08:43 +00001607 Expr E;
George Rimar30835ea2016-07-28 21:08:56 +00001608 assert(Op == "=" || Op == "+=");
Rui Ueyama83043f22016-10-17 16:01:53 +00001609 if (consume("ABSOLUTE")) {
Rui Ueyama7c1381a2016-10-19 23:11:21 +00001610 // The RHS may be something like "ABSOLUTE(.) & 0xff".
1611 // Call readExpr1 to read the whole expression.
1612 E = readExpr1(readParenExpr(), 0);
Rui Ueyama009d1742016-11-18 06:49:09 +00001613 E.IsAbsolute = [] { return true; };
Eugene Leviantdb741e72016-09-07 07:08:43 +00001614 } else {
1615 E = readExpr();
1616 }
Eugene Leviantf6aeed32016-12-22 13:13:12 +00001617 if (Op == "+=") {
1618 std::string Loc = getCurrentLocation();
1619 E = [=](uint64_t Dot) {
1620 return getSymbolValue(Loc, Name, Dot) + E(Dot);
1621 };
1622 }
Rafael Espindolaf6613932016-10-31 17:43:38 +00001623 return new SymbolAssignment(Name, E);
George Rimar30835ea2016-07-28 21:08:56 +00001624}
1625
1626// This is an operator-precedence parser to parse a linker
1627// script expression.
1628Expr ScriptParser::readExpr() { return readExpr1(readPrimary(), 0); }
1629
Rui Ueyama36c1cd22016-08-05 01:04:59 +00001630static Expr combine(StringRef Op, Expr L, Expr R) {
George Rimarcc4d3e52017-02-01 09:01:16 +00001631 auto IsAbs = [=] { return L.IsAbsolute() && R.IsAbsolute(); };
1632 auto GetOutSec = [=] {
1633 const OutputSectionBase *S = L.Section();
1634 return S ? S : R.Section();
1635 };
1636
Rui Ueyama36c1cd22016-08-05 01:04:59 +00001637 if (Op == "*")
1638 return [=](uint64_t Dot) { return L(Dot) * R(Dot); };
1639 if (Op == "/") {
1640 return [=](uint64_t Dot) -> uint64_t {
1641 uint64_t RHS = R(Dot);
1642 if (RHS == 0) {
1643 error("division by zero");
1644 return 0;
1645 }
1646 return L(Dot) / RHS;
1647 };
1648 }
1649 if (Op == "+")
George Rimarcc4d3e52017-02-01 09:01:16 +00001650 return {[=](uint64_t Dot) { return L(Dot) + R(Dot); }, IsAbs, GetOutSec};
Rui Ueyama36c1cd22016-08-05 01:04:59 +00001651 if (Op == "-")
George Rimarcc4d3e52017-02-01 09:01:16 +00001652 return {[=](uint64_t Dot) { return L(Dot) - R(Dot); }, IsAbs, GetOutSec};
George Rimarc8ccd1f2016-09-23 13:13:55 +00001653 if (Op == "<<")
1654 return [=](uint64_t Dot) { return L(Dot) << R(Dot); };
1655 if (Op == ">>")
1656 return [=](uint64_t Dot) { return L(Dot) >> R(Dot); };
Rui Ueyama36c1cd22016-08-05 01:04:59 +00001657 if (Op == "<")
1658 return [=](uint64_t Dot) { return L(Dot) < R(Dot); };
1659 if (Op == ">")
1660 return [=](uint64_t Dot) { return L(Dot) > R(Dot); };
1661 if (Op == ">=")
1662 return [=](uint64_t Dot) { return L(Dot) >= R(Dot); };
1663 if (Op == "<=")
1664 return [=](uint64_t Dot) { return L(Dot) <= R(Dot); };
1665 if (Op == "==")
1666 return [=](uint64_t Dot) { return L(Dot) == R(Dot); };
1667 if (Op == "!=")
1668 return [=](uint64_t Dot) { return L(Dot) != R(Dot); };
1669 if (Op == "&")
1670 return [=](uint64_t Dot) { return L(Dot) & R(Dot); };
Rafael Espindolacc3dd622016-08-22 21:33:35 +00001671 if (Op == "|")
1672 return [=](uint64_t Dot) { return L(Dot) | R(Dot); };
Rui Ueyama36c1cd22016-08-05 01:04:59 +00001673 llvm_unreachable("invalid operator");
1674}
1675
Rui Ueyama708019c2016-07-24 18:19:40 +00001676// This is a part of the operator-precedence parser. This function
1677// assumes that the remaining token stream starts with an operator.
1678Expr ScriptParser::readExpr1(Expr Lhs, int MinPrec) {
1679 while (!atEOF() && !Error) {
1680 // Read an operator and an expression.
Rui Ueyama46247b82016-11-18 06:49:07 +00001681 if (consume("?"))
Rui Ueyama708019c2016-07-24 18:19:40 +00001682 return readTernary(Lhs);
Rui Ueyama46247b82016-11-18 06:49:07 +00001683 StringRef Op1 = peek();
Rui Ueyama708019c2016-07-24 18:19:40 +00001684 if (precedence(Op1) < MinPrec)
Eugene Levianteda81a12016-07-12 06:39:48 +00001685 break;
Justin Bogner5424e7c2016-10-17 06:21:13 +00001686 skip();
Rui Ueyama708019c2016-07-24 18:19:40 +00001687 Expr Rhs = readPrimary();
1688
1689 // Evaluate the remaining part of the expression first if the
1690 // next operator has greater precedence than the previous one.
1691 // For example, if we have read "+" and "3", and if the next
1692 // operator is "*", then we'll evaluate 3 * ... part first.
1693 while (!atEOF()) {
1694 StringRef Op2 = peek();
1695 if (precedence(Op2) <= precedence(Op1))
1696 break;
1697 Rhs = readExpr1(Rhs, precedence(Op2));
1698 }
1699
1700 Lhs = combine(Op1, Lhs, Rhs);
Eugene Levianteda81a12016-07-12 06:39:48 +00001701 }
Rui Ueyama708019c2016-07-24 18:19:40 +00001702 return Lhs;
1703}
1704
1705uint64_t static getConstant(StringRef S) {
Michael J. Spencere2cc07b2016-08-17 02:10:51 +00001706 if (S == "COMMONPAGESIZE")
Rui Ueyama708019c2016-07-24 18:19:40 +00001707 return Target->PageSize;
Michael J. Spencere2cc07b2016-08-17 02:10:51 +00001708 if (S == "MAXPAGESIZE")
Petr Hosek997f8832016-09-28 15:20:47 +00001709 return Config->MaxPageSize;
Rui Ueyama708019c2016-07-24 18:19:40 +00001710 error("unknown constant: " + S);
1711 return 0;
1712}
1713
Rui Ueyama626e0b02016-09-02 18:19:00 +00001714// Parses Tok as an integer. Returns true if successful.
1715// It recognizes hexadecimal (prefixed with "0x" or suffixed with "H")
1716// and decimal numbers. Decimal numbers may have "K" (kilo) or
1717// "M" (mega) prefixes.
George Rimar9f2f7ad2016-09-02 16:01:42 +00001718static bool readInteger(StringRef Tok, uint64_t &Result) {
Rui Ueyama46247b82016-11-18 06:49:07 +00001719 // Negative number
Simon Atanasyaneaeafb22016-09-02 21:54:35 +00001720 if (Tok.startswith("-")) {
1721 if (!readInteger(Tok.substr(1), Result))
1722 return false;
1723 Result = -Result;
1724 return true;
1725 }
Rui Ueyama46247b82016-11-18 06:49:07 +00001726
1727 // Hexadecimal
George Rimar9f2f7ad2016-09-02 16:01:42 +00001728 if (Tok.startswith_lower("0x"))
1729 return !Tok.substr(2).getAsInteger(16, Result);
1730 if (Tok.endswith_lower("H"))
1731 return !Tok.drop_back().getAsInteger(16, Result);
1732
Rui Ueyama46247b82016-11-18 06:49:07 +00001733 // Decimal
George Rimar9f2f7ad2016-09-02 16:01:42 +00001734 int Suffix = 1;
1735 if (Tok.endswith_lower("K")) {
1736 Suffix = 1024;
1737 Tok = Tok.drop_back();
1738 } else if (Tok.endswith_lower("M")) {
1739 Suffix = 1024 * 1024;
1740 Tok = Tok.drop_back();
1741 }
1742 if (Tok.getAsInteger(10, Result))
1743 return false;
1744 Result *= Suffix;
1745 return true;
1746}
1747
George Rimare38cbab2016-09-26 19:22:50 +00001748BytesDataCommand *ScriptParser::readBytesDataCommand(StringRef Tok) {
1749 int Size = StringSwitch<unsigned>(Tok)
1750 .Case("BYTE", 1)
1751 .Case("SHORT", 2)
1752 .Case("LONG", 4)
1753 .Case("QUAD", 8)
1754 .Default(-1);
1755 if (Size == -1)
1756 return nullptr;
1757
Meador Inge95c7d8d2016-12-08 23:21:30 +00001758 return new BytesDataCommand(readParenExpr(), Size);
George Rimare38cbab2016-09-26 19:22:50 +00001759}
1760
Eugene Leviantb71d6f72016-10-06 09:39:28 +00001761StringRef ScriptParser::readParenLiteral() {
1762 expect("(");
1763 StringRef Tok = next();
1764 expect(")");
1765 return Tok;
1766}
1767
Rui Ueyama708019c2016-07-24 18:19:40 +00001768Expr ScriptParser::readPrimary() {
Rui Ueyama6ad7dfc2016-08-17 18:59:16 +00001769 if (peek() == "(")
1770 return readParenExpr();
Rui Ueyama708019c2016-07-24 18:19:40 +00001771
Rui Ueyama6ad7dfc2016-08-17 18:59:16 +00001772 StringRef Tok = next();
Rui Ueyamab5f1c3e2016-12-01 04:36:49 +00001773 std::string Location = getCurrentLocation();
Rui Ueyama708019c2016-07-24 18:19:40 +00001774
Simon Atanasyaneaeafb22016-09-02 21:54:35 +00001775 if (Tok == "~") {
1776 Expr E = readPrimary();
1777 return [=](uint64_t Dot) { return ~E(Dot); };
1778 }
1779 if (Tok == "-") {
1780 Expr E = readPrimary();
1781 return [=](uint64_t Dot) { return -E(Dot); };
1782 }
1783
Rui Ueyama708019c2016-07-24 18:19:40 +00001784 // Built-in functions are parsed here.
1785 // https://sourceware.org/binutils/docs/ld/Builtin-Functions.html.
George Rimar96659df2016-08-30 09:54:01 +00001786 if (Tok == "ADDR") {
Eugene Leviantb71d6f72016-10-06 09:39:28 +00001787 StringRef Name = readParenLiteral();
Eugene Levianted30ce72016-11-28 09:58:04 +00001788 return {[=](uint64_t Dot) {
1789 return ScriptBase->getOutputSection(Location, Name)->Addr;
1790 },
1791 [=] { return false; },
1792 [=] { return ScriptBase->getOutputSection(Location, Name); }};
George Rimar96659df2016-08-30 09:54:01 +00001793 }
Eugene Leviantb71d6f72016-10-06 09:39:28 +00001794 if (Tok == "LOADADDR") {
1795 StringRef Name = readParenLiteral();
Eugene Leviantafaa9342016-11-16 09:49:39 +00001796 return [=](uint64_t Dot) {
Eugene Levianted30ce72016-11-28 09:58:04 +00001797 return ScriptBase->getOutputSection(Location, Name)->getLMA();
Eugene Leviantafaa9342016-11-16 09:49:39 +00001798 };
Eugene Leviantb71d6f72016-10-06 09:39:28 +00001799 }
George Rimareefa7582016-08-04 09:29:31 +00001800 if (Tok == "ASSERT")
1801 return readAssert();
Rui Ueyama708019c2016-07-24 18:19:40 +00001802 if (Tok == "ALIGN") {
Rui Ueyama5d804dc2016-12-16 18:19:35 +00001803 expect("(");
1804 Expr E = readExpr();
1805 if (consume(",")) {
1806 Expr E2 = readExpr();
1807 expect(")");
1808 return [=](uint64_t Dot) { return alignTo(E(Dot), E2(Dot)); };
1809 }
1810 expect(")");
Rui Ueyama708019c2016-07-24 18:19:40 +00001811 return [=](uint64_t Dot) { return alignTo(Dot, E(Dot)); };
1812 }
1813 if (Tok == "CONSTANT") {
Eugene Leviantb71d6f72016-10-06 09:39:28 +00001814 StringRef Name = readParenLiteral();
Rafael Espindolab0de56b2016-10-31 21:36:23 +00001815 return [=](uint64_t Dot) { return getConstant(Name); };
Rui Ueyama708019c2016-07-24 18:19:40 +00001816 }
George Rimarf34f45f2016-09-23 13:17:23 +00001817 if (Tok == "DEFINED") {
Rui Ueyama0ee25a62016-11-17 03:52:14 +00001818 StringRef Name = readParenLiteral();
1819 return [=](uint64_t Dot) { return ScriptBase->isDefined(Name) ? 1 : 0; };
George Rimarf34f45f2016-09-23 13:17:23 +00001820 }
Rafael Espindola54c145c2016-07-28 18:16:24 +00001821 if (Tok == "SEGMENT_START") {
1822 expect("(");
Justin Bogner5424e7c2016-10-17 06:21:13 +00001823 skip();
Rafael Espindola54c145c2016-07-28 18:16:24 +00001824 expect(",");
George Rimar8c658bf2016-09-17 18:14:56 +00001825 Expr E = readExpr();
Rafael Espindola54c145c2016-07-28 18:16:24 +00001826 expect(")");
George Rimar8c658bf2016-09-17 18:14:56 +00001827 return [=](uint64_t Dot) { return E(Dot); };
Rafael Espindola54c145c2016-07-28 18:16:24 +00001828 }
Rui Ueyama708019c2016-07-24 18:19:40 +00001829 if (Tok == "DATA_SEGMENT_ALIGN") {
1830 expect("(");
1831 Expr E = readExpr();
1832 expect(",");
1833 readExpr();
1834 expect(")");
Rui Ueyamaf7791bb2016-07-26 19:34:10 +00001835 return [=](uint64_t Dot) { return alignTo(Dot, E(Dot)); };
Rui Ueyama708019c2016-07-24 18:19:40 +00001836 }
1837 if (Tok == "DATA_SEGMENT_END") {
1838 expect("(");
1839 expect(".");
1840 expect(")");
1841 return [](uint64_t Dot) { return Dot; };
1842 }
George Rimar276b4e62016-07-26 17:58:44 +00001843 // GNU linkers implements more complicated logic to handle
1844 // DATA_SEGMENT_RELRO_END. We instead ignore the arguments and just align to
1845 // the next page boundary for simplicity.
1846 if (Tok == "DATA_SEGMENT_RELRO_END") {
1847 expect("(");
Rafael Espindola97bdc722016-09-14 19:14:01 +00001848 readExpr();
George Rimar276b4e62016-07-26 17:58:44 +00001849 expect(",");
1850 readExpr();
1851 expect(")");
1852 return [](uint64_t Dot) { return alignTo(Dot, Target->PageSize); };
1853 }
George Rimar9e694502016-07-29 16:18:47 +00001854 if (Tok == "SIZEOF") {
Eugene Leviantb71d6f72016-10-06 09:39:28 +00001855 StringRef Name = readParenLiteral();
Rui Ueyamaedf75e72016-11-17 20:27:10 +00001856 return [=](uint64_t Dot) { return ScriptBase->getOutputSectionSize(Name); };
George Rimar9e694502016-07-29 16:18:47 +00001857 }
Eugene Leviant36fac7f2016-09-08 09:08:30 +00001858 if (Tok == "ALIGNOF") {
Eugene Leviantb71d6f72016-10-06 09:39:28 +00001859 StringRef Name = readParenLiteral();
Eugene Leviantafaa9342016-11-16 09:49:39 +00001860 return [=](uint64_t Dot) {
Eugene Levianted30ce72016-11-28 09:58:04 +00001861 return ScriptBase->getOutputSection(Location, Name)->Addralign;
Eugene Leviantafaa9342016-11-16 09:49:39 +00001862 };
Eugene Leviant36fac7f2016-09-08 09:08:30 +00001863 }
George Rimare32a3592016-08-10 07:59:34 +00001864 if (Tok == "SIZEOF_HEADERS")
Rafael Espindolab0de56b2016-10-31 21:36:23 +00001865 return [=](uint64_t Dot) { return ScriptBase->getHeaderSize(); };
Rui Ueyama708019c2016-07-24 18:19:40 +00001866
George Rimar9f2f7ad2016-09-02 16:01:42 +00001867 // Tok is a literal number.
1868 uint64_t V;
1869 if (readInteger(Tok, V))
Rafael Espindolab0de56b2016-10-31 21:36:23 +00001870 return [=](uint64_t Dot) { return V; };
George Rimar9f2f7ad2016-09-02 16:01:42 +00001871
1872 // Tok is a symbol name.
1873 if (Tok != "." && !isValidCIdentifier(Tok))
1874 setError("malformed number: " + Tok);
Eugene Leviantf6aeed32016-12-22 13:13:12 +00001875 return {[=](uint64_t Dot) { return getSymbolValue(Location, Tok, Dot); },
Rui Ueyama009d1742016-11-18 06:49:09 +00001876 [=] { return isAbsolute(Tok); },
1877 [=] { return ScriptBase->getSymbolSection(Tok); }};
Rui Ueyama708019c2016-07-24 18:19:40 +00001878}
1879
1880Expr ScriptParser::readTernary(Expr Cond) {
Rui Ueyama708019c2016-07-24 18:19:40 +00001881 Expr L = readExpr();
1882 expect(":");
1883 Expr R = readExpr();
1884 return [=](uint64_t Dot) { return Cond(Dot) ? L(Dot) : R(Dot); };
1885}
1886
Rui Ueyama6ad7dfc2016-08-17 18:59:16 +00001887Expr ScriptParser::readParenExpr() {
1888 expect("(");
1889 Expr E = readExpr();
1890 expect(")");
1891 return E;
1892}
1893
Eugene Leviantbbe38602016-07-19 09:25:43 +00001894std::vector<StringRef> ScriptParser::readOutputSectionPhdrs() {
1895 std::vector<StringRef> Phdrs;
1896 while (!Error && peek().startswith(":")) {
1897 StringRef Tok = next();
George Rimarda841c12016-11-14 10:03:54 +00001898 Phdrs.push_back((Tok.size() == 1) ? next() : Tok.substr(1));
Eugene Leviantbbe38602016-07-19 09:25:43 +00001899 }
1900 return Phdrs;
1901}
1902
George Rimar95dd7182016-10-18 10:49:50 +00001903// Read a program header type name. The next token must be a
1904// name of a program header type or a constant (e.g. "0x3").
Eugene Leviantbbe38602016-07-19 09:25:43 +00001905unsigned ScriptParser::readPhdrType() {
Eugene Leviantbbe38602016-07-19 09:25:43 +00001906 StringRef Tok = next();
George Rimar95dd7182016-10-18 10:49:50 +00001907 uint64_t Val;
1908 if (readInteger(Tok, Val))
1909 return Val;
1910
Rui Ueyamab0f6c592016-07-20 19:36:38 +00001911 unsigned Ret = StringSwitch<unsigned>(Tok)
George Rimar6c55f0e2016-09-08 08:20:30 +00001912 .Case("PT_NULL", PT_NULL)
1913 .Case("PT_LOAD", PT_LOAD)
1914 .Case("PT_DYNAMIC", PT_DYNAMIC)
1915 .Case("PT_INTERP", PT_INTERP)
1916 .Case("PT_NOTE", PT_NOTE)
1917 .Case("PT_SHLIB", PT_SHLIB)
1918 .Case("PT_PHDR", PT_PHDR)
1919 .Case("PT_TLS", PT_TLS)
1920 .Case("PT_GNU_EH_FRAME", PT_GNU_EH_FRAME)
1921 .Case("PT_GNU_STACK", PT_GNU_STACK)
1922 .Case("PT_GNU_RELRO", PT_GNU_RELRO)
George Rimar270173f2016-10-14 13:02:22 +00001923 .Case("PT_OPENBSD_RANDOMIZE", PT_OPENBSD_RANDOMIZE)
George Rimarcc6e5672016-10-14 10:34:36 +00001924 .Case("PT_OPENBSD_WXNEEDED", PT_OPENBSD_WXNEEDED)
George Rimara2a32c22016-12-06 17:57:42 +00001925 .Case("PT_OPENBSD_BOOTDATA", PT_OPENBSD_BOOTDATA)
George Rimar6c55f0e2016-09-08 08:20:30 +00001926 .Default(-1);
Eugene Leviantbbe38602016-07-19 09:25:43 +00001927
Rui Ueyamab0f6c592016-07-20 19:36:38 +00001928 if (Ret == (unsigned)-1) {
1929 setError("invalid program header type: " + Tok);
1930 return PT_NULL;
1931 }
1932 return Ret;
Eugene Leviantbbe38602016-07-19 09:25:43 +00001933}
1934
Rui Ueyama12450b22016-11-18 06:30:09 +00001935// Reads a list of symbols, e.g. "{ global: foo; bar; local: *; };".
1936void ScriptParser::readAnonymousDeclaration() {
1937 // Read global symbols first. "global:" is default, so if there's
1938 // no label, we assume global symbols.
Rafael Espindola45242682017-02-03 13:24:01 +00001939 if (peek() != "local") {
1940 if (consume("global"))
1941 expect(":");
Rui Ueyama12450b22016-11-18 06:30:09 +00001942 Config->VersionScriptGlobals = readSymbols();
Rafael Espindola45242682017-02-03 13:24:01 +00001943 }
Rafael Espindolae999ddb2017-01-10 16:37:24 +00001944 readLocals();
Rui Ueyama12450b22016-11-18 06:30:09 +00001945 expect("}");
1946 expect(";");
1947}
1948
Rafael Espindolae999ddb2017-01-10 16:37:24 +00001949void ScriptParser::readLocals() {
Rafael Espindola45242682017-02-03 13:24:01 +00001950 if (!consume("local"))
Rafael Espindolae999ddb2017-01-10 16:37:24 +00001951 return;
Rafael Espindola45242682017-02-03 13:24:01 +00001952 expect(":");
Rafael Espindolae999ddb2017-01-10 16:37:24 +00001953 std::vector<SymbolVersion> Locals = readSymbols();
1954 for (SymbolVersion V : Locals) {
1955 if (V.Name == "*") {
1956 Config->DefaultSymbolVersion = VER_NDX_LOCAL;
1957 continue;
1958 }
1959 Config->VersionScriptLocals.push_back(V);
1960 }
1961}
1962
Rui Ueyama12450b22016-11-18 06:30:09 +00001963// Reads a list of symbols, e.g. "VerStr { global: foo; bar; local: *; };".
Rui Ueyama95769b42016-08-31 20:03:54 +00001964void ScriptParser::readVersionDeclaration(StringRef VerStr) {
George Rimar20b65982016-08-31 09:08:26 +00001965 // Identifiers start at 2 because 0 and 1 are reserved
1966 // for VER_NDX_LOCAL and VER_NDX_GLOBAL constants.
Rui Ueyamada805c42016-11-17 03:39:21 +00001967 uint16_t VersionId = Config->VersionDefinitions.size() + 2;
George Rimar20b65982016-08-31 09:08:26 +00001968 Config->VersionDefinitions.push_back({VerStr, VersionId});
1969
Rui Ueyama12450b22016-11-18 06:30:09 +00001970 // Read global symbols.
Rafael Espindola45242682017-02-03 13:24:01 +00001971 if (peek() != "local") {
1972 if (consume("global"))
1973 expect(":");
Rui Ueyama12450b22016-11-18 06:30:09 +00001974 Config->VersionDefinitions.back().Globals = readSymbols();
Rafael Espindola45242682017-02-03 13:24:01 +00001975 }
Rafael Espindolae999ddb2017-01-10 16:37:24 +00001976 readLocals();
George Rimar20b65982016-08-31 09:08:26 +00001977 expect("}");
1978
Rui Ueyama12450b22016-11-18 06:30:09 +00001979 // Each version may have a parent version. For example, "Ver2"
1980 // defined as "Ver2 { global: foo; local: *; } Ver1;" has "Ver1"
1981 // as a parent. This version hierarchy is, probably against your
1982 // instinct, purely for hint; the runtime doesn't care about it
1983 // at all. In LLD, we simply ignore it.
1984 if (peek() != ";")
Justin Bogner5424e7c2016-10-17 06:21:13 +00001985 skip();
George Rimar20b65982016-08-31 09:08:26 +00001986 expect(";");
1987}
1988
Rui Ueyama12450b22016-11-18 06:30:09 +00001989// Reads a list of symbols for a versions cript.
1990std::vector<SymbolVersion> ScriptParser::readSymbols() {
1991 std::vector<SymbolVersion> Ret;
George Rimare0fc2422016-11-16 17:59:10 +00001992 for (;;) {
Rafael Espindola1ef90d22016-12-09 16:44:05 +00001993 if (consume("extern")) {
Rui Ueyama12450b22016-11-18 06:30:09 +00001994 for (SymbolVersion V : readVersionExtern())
1995 Ret.push_back(V);
Rafael Espindola1ef90d22016-12-09 16:44:05 +00001996 continue;
1997 }
George Rimare0fc2422016-11-16 17:59:10 +00001998
Rafael Espindola45242682017-02-03 13:24:01 +00001999 if (peek() == "}" || peek() == "local" || Error)
Rui Ueyama12450b22016-11-18 06:30:09 +00002000 break;
Rui Ueyama0ee25a62016-11-17 03:52:14 +00002001 StringRef Tok = next();
Rui Ueyama12450b22016-11-18 06:30:09 +00002002 Ret.push_back({unquote(Tok), false, hasWildcard(Tok)});
George Rimare0fc2422016-11-16 17:59:10 +00002003 expect(";");
2004 }
Rui Ueyama12450b22016-11-18 06:30:09 +00002005 return Ret;
George Rimare0fc2422016-11-16 17:59:10 +00002006}
2007
Rui Ueyama12450b22016-11-18 06:30:09 +00002008// Reads an "extern C++" directive, e.g.,
2009// "extern "C++" { ns::*; "f(int, double)"; };"
2010std::vector<SymbolVersion> ScriptParser::readVersionExtern() {
Rafael Espindola7e714152016-12-08 17:26:53 +00002011 StringRef Tok = next();
2012 bool IsCXX = Tok == "\"C++\"";
2013 if (!IsCXX && Tok != "\"C\"")
Rafael Espindolad0ebd842016-12-08 17:54:26 +00002014 setError("Unknown language");
George Rimar20b65982016-08-31 09:08:26 +00002015 expect("{");
2016
Rui Ueyama12450b22016-11-18 06:30:09 +00002017 std::vector<SymbolVersion> Ret;
Rui Ueyama0ee25a62016-11-17 03:52:14 +00002018 while (!Error && peek() != "}") {
2019 StringRef Tok = next();
2020 bool HasWildcard = !Tok.startswith("\"") && hasWildcard(Tok);
Rafael Espindola7e714152016-12-08 17:26:53 +00002021 Ret.push_back({unquote(Tok), IsCXX, HasWildcard});
George Rimar20b65982016-08-31 09:08:26 +00002022 expect(";");
2023 }
2024
2025 expect("}");
2026 expect(";");
Rui Ueyama12450b22016-11-18 06:30:09 +00002027 return Ret;
George Rimar20b65982016-08-31 09:08:26 +00002028}
2029
Rui Ueyama24e626c2017-01-26 02:58:19 +00002030uint64_t ScriptParser::readMemoryAssignment(
2031 StringRef S1, StringRef S2, StringRef S3) {
2032 if (!(consume(S1) || consume(S2) || consume(S3))) {
2033 setError("expected one of: " + S1 + ", " + S2 + ", or " + S3);
2034 return 0;
2035 }
2036 expect("=");
2037
2038 // TODO: Fully support constant expressions.
2039 uint64_t Val;
2040 if (!readInteger(next(), Val))
2041 setError("nonconstant expression for "+ S1);
2042 return Val;
2043}
2044
2045// Parse the MEMORY command as specified in:
2046// https://sourceware.org/binutils/docs/ld/MEMORY.html
2047//
2048// MEMORY { name [(attr)] : ORIGIN = origin, LENGTH = len ... }
Meador Ingeb8897442017-01-24 02:34:00 +00002049void ScriptParser::readMemory() {
2050 expect("{");
2051 while (!Error && !consume("}")) {
2052 StringRef Name = next();
Rui Ueyama24e626c2017-01-26 02:58:19 +00002053
Meador Ingeb8897442017-01-24 02:34:00 +00002054 uint32_t Flags = 0;
Rui Ueyama8a8a9532017-01-26 02:58:59 +00002055 uint32_t NegFlags = 0;
Meador Ingeb8897442017-01-24 02:34:00 +00002056 if (consume("(")) {
Rui Ueyama8a8a9532017-01-26 02:58:59 +00002057 std::tie(Flags, NegFlags) = readMemoryAttributes();
Meador Ingeb8897442017-01-24 02:34:00 +00002058 expect(")");
2059 }
2060 expect(":");
2061
Rui Ueyama24e626c2017-01-26 02:58:19 +00002062 uint64_t Origin = readMemoryAssignment("ORIGIN", "org", "o");
Meador Ingeb8897442017-01-24 02:34:00 +00002063 expect(",");
Rui Ueyama24e626c2017-01-26 02:58:19 +00002064 uint64_t Length = readMemoryAssignment("LENGTH", "len", "l");
Meador Ingeb8897442017-01-24 02:34:00 +00002065
Meador Ingeb8897442017-01-24 02:34:00 +00002066 // Add the memory region to the region map (if it doesn't already exist).
2067 auto It = Opt.MemoryRegions.find(Name);
2068 if (It != Opt.MemoryRegions.end())
2069 setError("region '" + Name + "' already defined");
2070 else
Rui Ueyama8a8a9532017-01-26 02:58:59 +00002071 Opt.MemoryRegions[Name] = {Name, Origin, Length, Origin, Flags, NegFlags};
Meador Ingeb8897442017-01-24 02:34:00 +00002072 }
2073}
2074
2075// This function parses the attributes used to match against section
2076// flags when placing output sections in a memory region. These flags
2077// are only used when an explicit memory region name is not used.
2078std::pair<uint32_t, uint32_t> ScriptParser::readMemoryAttributes() {
2079 uint32_t Flags = 0;
Rui Ueyama8a8a9532017-01-26 02:58:59 +00002080 uint32_t NegFlags = 0;
Meador Ingeb8897442017-01-24 02:34:00 +00002081 bool Invert = false;
Rui Ueyama481ac992017-01-26 02:58:39 +00002082
2083 for (char C : next().lower()) {
Meador Ingeb8897442017-01-24 02:34:00 +00002084 uint32_t Flag = 0;
2085 if (C == '!')
2086 Invert = !Invert;
Rui Ueyama481ac992017-01-26 02:58:39 +00002087 else if (C == 'w')
Meador Ingeb8897442017-01-24 02:34:00 +00002088 Flag = SHF_WRITE;
Rui Ueyama481ac992017-01-26 02:58:39 +00002089 else if (C == 'x')
Meador Ingeb8897442017-01-24 02:34:00 +00002090 Flag = SHF_EXECINSTR;
Rui Ueyama481ac992017-01-26 02:58:39 +00002091 else if (C == 'a')
Meador Ingeb8897442017-01-24 02:34:00 +00002092 Flag = SHF_ALLOC;
Rui Ueyama481ac992017-01-26 02:58:39 +00002093 else if (C != 'r')
Meador Ingeb8897442017-01-24 02:34:00 +00002094 setError("invalid memory region attribute");
Rui Ueyama481ac992017-01-26 02:58:39 +00002095
Meador Ingeb8897442017-01-24 02:34:00 +00002096 if (Invert)
Rui Ueyama8a8a9532017-01-26 02:58:59 +00002097 NegFlags |= Flag;
Meador Ingeb8897442017-01-24 02:34:00 +00002098 else
2099 Flags |= Flag;
2100 }
Rui Ueyama8a8a9532017-01-26 02:58:59 +00002101 return {Flags, NegFlags};
Meador Ingeb8897442017-01-24 02:34:00 +00002102}
2103
Rui Ueyama07320e42016-04-20 20:13:41 +00002104void elf::readLinkerScript(MemoryBufferRef MB) {
Rui Ueyama22375f22016-11-25 18:51:54 +00002105 ScriptParser(MB).readLinkerScript();
George Rimar20b65982016-08-31 09:08:26 +00002106}
2107
2108void elf::readVersionScript(MemoryBufferRef MB) {
Rui Ueyama22375f22016-11-25 18:51:54 +00002109 ScriptParser(MB).readVersionScript();
Rui Ueyamaf7c5fbb2015-09-30 17:23:26 +00002110}
Rui Ueyama1ebc8ed2016-02-12 21:47:28 +00002111
Rafael Espindolad0ebd842016-12-08 17:54:26 +00002112void elf::readDynamicList(MemoryBufferRef MB) {
2113 ScriptParser(MB).readDynamicList();
2114}
2115
Rui Ueyama07320e42016-04-20 20:13:41 +00002116template class elf::LinkerScript<ELF32LE>;
2117template class elf::LinkerScript<ELF32BE>;
2118template class elf::LinkerScript<ELF64LE>;
2119template class elf::LinkerScript<ELF64BE>;