blob: f790ccfca56f04d2f31873e11764bb95692d23ec [file] [log] [blame]
Michael J. Spencer84487f12015-07-24 21:03:07 +00001//===- Writer.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
Michael J. Spencerf8325412015-09-04 22:48:30 +000010#include "Writer.h"
Rui Ueyamacb8474ed2015-08-05 23:51:50 +000011#include "Config.h"
Rui Ueyama9b55e922017-03-24 00:15:16 +000012#include "Filesystem.h"
Rui Ueyama717677a2016-02-11 21:17:59 +000013#include "LinkerScript.h"
Rafael Espindola1ebfc592017-01-13 21:05:46 +000014#include "MapFile.h"
Rui Ueyama9381eb12016-12-18 14:06:06 +000015#include "Memory.h"
Rafael Espindola5805c4f2015-09-21 21:38:08 +000016#include "OutputSections.h"
Rui Ueyama0fcdc732016-05-24 20:24:43 +000017#include "Relocations.h"
Rui Ueyamafbbde542016-06-29 09:08:02 +000018#include "Strings.h"
Rui Ueyamaafff74e22015-08-05 23:24:46 +000019#include "SymbolTable.h"
Rui Ueyama6dc7fcb2016-11-01 20:28:21 +000020#include "SyntheticSections.h"
Rafael Espindola01205f72015-09-22 18:19:46 +000021#include "Target.h"
George Rimardbf93392017-04-17 08:58:12 +000022#include "Threads.h"
Denis Protivensky8e3b38a2015-11-12 09:52:08 +000023#include "llvm/ADT/StringMap.h"
Hal Finkel3bae2d82015-10-12 20:51:48 +000024#include "llvm/ADT/StringSwitch.h"
Rui Ueyamaafff74e22015-08-05 23:24:46 +000025#include "llvm/Support/FileOutputBuffer.h"
Rafael Espindolad0078b22016-02-06 00:06:26 +000026#include "llvm/Support/raw_ostream.h"
Rui Ueyamae8b2df42016-09-29 01:45:22 +000027#include <climits>
Michael J. Spencer84487f12015-07-24 21:03:07 +000028
29using namespace llvm;
30using namespace llvm::ELF;
31using namespace llvm::object;
Peter Smith0a259f32016-10-10 09:39:26 +000032using namespace llvm::support;
33using namespace llvm::support::endian;
Michael J. Spencer84487f12015-07-24 21:03:07 +000034
35using namespace lld;
Rafael Espindolae0df00b2016-02-28 00:25:54 +000036using namespace lld::elf;
Michael J. Spencer84487f12015-07-24 21:03:07 +000037
Rui Ueyamaafff74e22015-08-05 23:24:46 +000038namespace {
39// The writer writes a SymbolTable result to a file.
40template <class ELFT> class Writer {
41public:
Rui Ueyama9328b2c2016-03-14 23:16:09 +000042 typedef typename ELFT::Shdr Elf_Shdr;
43 typedef typename ELFT::Ehdr Elf_Ehdr;
44 typedef typename ELFT::Phdr Elf_Phdr;
Rui Ueyama0ce388b2017-04-05 21:46:06 +000045
Rui Ueyamaafff74e22015-08-05 23:24:46 +000046 void run();
47
48private:
Rafael Espindolaaeb4b7d2017-05-23 22:54:06 +000049 void clearOutputSections();
Rui Ueyamaf83aca42016-11-01 23:17:45 +000050 void createSyntheticSections();
Rui Ueyama5a9640b2015-10-08 23:49:30 +000051 void copyLocalSymbols();
Rafael Espindola08d6a3f2017-02-11 01:40:49 +000052 void addSectionSymbols();
Rui Ueyamaf18fe7b2015-12-26 07:50:39 +000053 void addReservedSymbols();
George Rimar9e694502016-07-29 16:18:47 +000054 void createSections();
Rafael Espindolab4c9b812017-02-23 02:28:28 +000055 void forEachRelSec(std::function<void(InputSectionBase &)> Fn);
Rafael Espindola24c073d2016-09-21 22:36:19 +000056 void sortSections();
Eugene Leviante63d81b2016-07-20 14:43:20 +000057 void finalizeSections();
Rui Ueyama84417f82015-12-26 07:50:41 +000058 void addPredefinedSections();
Rui Ueyama2df0fd82015-12-25 07:38:58 +000059
Rafael Espindola17cb7c02016-12-19 17:01:01 +000060 std::vector<PhdrEntry> createPhdrs();
Rafael Espindola074ba932016-12-06 13:43:34 +000061 void removeEmptyPTLoad();
Rafael Espindola17cb7c02016-12-19 17:01:01 +000062 void addPtArmExid(std::vector<PhdrEntry> &Phdrs);
Rui Ueyamae044e9c2016-04-01 17:07:17 +000063 void assignFileOffsets();
George Rimar86ce2672016-08-25 09:05:47 +000064 void assignFileOffsetsBinary();
Rui Ueyamae044e9c2016-04-01 17:07:17 +000065 void setPhdrs();
Rui Ueyama47091902016-03-30 19:41:51 +000066 void fixSectionAlignments();
Rafael Espindola78493a22017-01-28 17:48:21 +000067 void fixPredefinedSymbols();
Rui Ueyamaf7f52ef2016-04-01 17:24:19 +000068 void openFile();
Rui Ueyamaafff74e22015-08-05 23:24:46 +000069 void writeHeader();
70 void writeSections();
George Rimar86ce2672016-08-25 09:05:47 +000071 void writeSectionsBinary();
Rui Ueyama634ddf02016-03-11 20:51:53 +000072 void writeBuildId();
Rui Ueyamaafff74e22015-08-05 23:24:46 +000073
Rui Ueyama818bb2f2016-07-16 18:55:47 +000074 std::unique_ptr<FileOutputBuffer> Buffer;
Michael J. Spencer2f008242015-09-17 19:58:07 +000075
Rui Ueyama02a036f2017-02-27 02:31:48 +000076 OutputSectionFactory Factory{OutputSections};
Rafael Espindola4fc60442016-02-10 22:43:13 +000077
Rui Ueyama01687222015-12-26 09:47:57 +000078 void addRelIpltSymbols();
Rui Ueyamaa5d79d12015-12-26 09:48:00 +000079 void addStartEndSymbols();
Rafael Espindola24e6f362017-02-24 15:07:30 +000080 void addStartStopSymbols(OutputSection *Sec);
Rui Ueyama6bd38222017-04-05 21:37:09 +000081 uint64_t getEntryAddr();
Rafael Espindola24e6f362017-02-24 15:07:30 +000082 OutputSection *findSection(StringRef Name);
Rafael Espindola43e76cd2017-05-26 17:48:27 +000083 OutputSection *findSectionInScript(StringRef Name);
84 OutputSectionCommand *findSectionCommand(StringRef Name);
Rui Ueyama2f1b79f2015-10-10 22:34:30 +000085
Rafael Espindola17cb7c02016-12-19 17:01:01 +000086 std::vector<PhdrEntry> Phdrs;
Michael J. Spencer2f008242015-09-17 19:58:07 +000087
Rui Ueyama6bd38222017-04-05 21:37:09 +000088 uint64_t FileSize;
89 uint64_t SectionHeaderOff;
Peter Smith113a59e2017-06-26 10:22:17 +000090
91 bool HasGotBaseSym = false;
Rui Ueyamaafff74e22015-08-05 23:24:46 +000092};
93} // anonymous namespace
94
Rui Ueyama55518e72016-10-28 20:57:25 +000095StringRef elf::getOutputSectionName(StringRef Name) {
George Rimar60a0ea12017-06-05 12:49:21 +000096 // ".zdebug_" is a prefix for ZLIB-compressed sections.
97 // Because we decompressed input sections, we want to remove 'z'.
98 if (Name.startswith(".zdebug_"))
99 return Saver.save("." + Name.substr(2));
100
Eugene Levianta8d12ef2016-10-05 10:10:45 +0000101 if (Config->Relocatable)
102 return Name;
103
Rafael Espindola7d382732016-09-19 19:59:21 +0000104 for (StringRef V :
George Rimar1ab9cf42017-03-17 10:14:53 +0000105 {".text.", ".rodata.", ".data.rel.ro.", ".data.", ".bss.rel.ro.",
106 ".bss.", ".init_array.", ".fini_array.", ".ctors.", ".dtors.", ".tbss.",
Peter Smith691ff762017-06-28 09:12:38 +0000107 ".gcc_except_table.", ".tdata.", ".ARM.exidx.", ".ARM.extab."}) {
Rafael Espindola7d382732016-09-19 19:59:21 +0000108 StringRef Prefix = V.drop_back();
109 if (Name.startswith(V) || Name == Prefix)
110 return Prefix;
111 }
Rui Ueyama05384082016-10-12 22:36:31 +0000112
Rui Ueyamae8a61022016-11-05 23:05:47 +0000113 // CommonSection is identified as "COMMON" in linker scripts.
114 // By default, it should go to .bss section.
115 if (Name == "COMMON")
116 return ".bss";
117
George Rimar5d53d1f2016-07-12 08:50:42 +0000118 return Name;
119}
120
Rui Ueyamafd03cfd2016-07-21 11:01:23 +0000121template <class ELFT> static bool needsInterpSection() {
122 return !Symtab<ELFT>::X->getSharedFiles().empty() &&
George Rimara8dba482017-03-20 10:09:58 +0000123 !Config->DynamicLinker.empty() && !Script->ignoreInterpSection();
Rui Ueyamafd03cfd2016-07-21 11:01:23 +0000124}
125
George Rimard8b27762016-11-14 10:14:18 +0000126template <class ELFT> void elf::writeResult() { Writer<ELFT>().run(); }
Rafael Espindola4fc60442016-02-10 22:43:13 +0000127
Rafael Espindola074ba932016-12-06 13:43:34 +0000128template <class ELFT> void Writer<ELFT>::removeEmptyPTLoad() {
Rafael Espindola17cb7c02016-12-19 17:01:01 +0000129 auto I = std::remove_if(Phdrs.begin(), Phdrs.end(), [&](const PhdrEntry &P) {
130 if (P.p_type != PT_LOAD)
Rafael Espindola074ba932016-12-06 13:43:34 +0000131 return false;
Rafael Espindola41217612016-12-08 03:17:05 +0000132 if (!P.First)
133 return true;
Rui Ueyama6bd38222017-04-05 21:37:09 +0000134 uint64_t Size = P.Last->Addr + P.Last->Size - P.First->Addr;
Rafael Espindola074ba932016-12-06 13:43:34 +0000135 return Size == 0;
136 });
137 Phdrs.erase(I, Phdrs.end());
138}
139
Petr Hosek7b793212017-03-10 20:00:42 +0000140template <class ELFT> static void combineEhFrameSections() {
141 for (InputSectionBase *&S : InputSections) {
142 EhInputSection *ES = dyn_cast<EhInputSection>(S);
Rafael Espindolaa1565552017-03-15 12:31:54 +0000143 if (!ES || !ES->Live)
Petr Hosek7b793212017-03-10 20:00:42 +0000144 continue;
145
146 In<ELFT>::EhFrame->addSection(ES);
147 S = nullptr;
148 }
149
150 std::vector<InputSectionBase *> &V = InputSections;
151 V.erase(std::remove(V.begin(), V.end(), nullptr), V.end());
152}
153
Rafael Espindolaaeb4b7d2017-05-23 22:54:06 +0000154template <class ELFT> void Writer<ELFT>::clearOutputSections() {
Rafael Espindola383971d2017-06-15 21:51:01 +0000155 if (Script->Opt.HasSections)
156 Script->createOrphanCommands();
157 else
158 Script->fabricateDefaultCommands();
Rafael Espindolaaeb4b7d2017-05-23 22:54:06 +0000159 // Clear the OutputSections to make sure it is not used anymore. Any
160 // code from this point on should be using the linker script
161 // commands.
162 for (OutputSection *Sec : OutputSections)
163 Sec->Sections.clear();
164 OutputSections.clear();
165}
166
Rui Ueyamaf83aca42016-11-01 23:17:45 +0000167// The main function of the writer.
168template <class ELFT> void Writer<ELFT>::run() {
Rui Ueyama0b1b6952016-11-21 02:11:05 +0000169 // Create linker-synthesized sections such as .got or .plt.
170 // Such sections are of type input section.
Rui Ueyamaf83aca42016-11-01 23:17:45 +0000171 createSyntheticSections();
George Rimar7beff422016-11-15 08:19:02 +0000172
Petr Hosek7b793212017-03-10 20:00:42 +0000173 if (!Config->Relocatable)
174 combineEhFrameSections<ELFT>();
175
Rui Ueyama0b1b6952016-11-21 02:11:05 +0000176 // We need to create some reserved symbols such as _end. Create them.
George Rimar7beff422016-11-15 08:19:02 +0000177 if (!Config->Relocatable)
178 addReservedSymbols();
Rui Ueyamaf83aca42016-11-01 23:17:45 +0000179
Rui Ueyama0b1b6952016-11-21 02:11:05 +0000180 // Create output sections.
Rui Ueyamaa34da932017-03-21 23:03:09 +0000181 if (Script->Opt.HasSections) {
Rui Ueyama0b1b6952016-11-21 02:11:05 +0000182 // If linker script contains SECTIONS commands, let it create sections.
George Rimara8dba482017-03-20 10:09:58 +0000183 Script->processCommands(Factory);
Rui Ueyama0b1b6952016-11-21 02:11:05 +0000184
185 // Linker scripts may have left some input sections unassigned.
186 // Assign such sections using the default rule.
George Rimara8dba482017-03-20 10:09:58 +0000187 Script->addOrphanSections(Factory);
Rui Ueyamaf83aca42016-11-01 23:17:45 +0000188 } else {
Rui Ueyama0b1b6952016-11-21 02:11:05 +0000189 // If linker script does not contain SECTIONS commands, create
190 // output sections by default rules. We still need to give the
191 // linker script a chance to run, because it might contain
192 // non-SECTIONS commands such as ASSERT.
Rui Ueyamaf83aca42016-11-01 23:17:45 +0000193 createSections();
George Rimara8dba482017-03-20 10:09:58 +0000194 Script->processCommands(Factory);
Rui Ueyamaf83aca42016-11-01 23:17:45 +0000195 }
196
197 if (Config->Discard != DiscardPolicy::All)
198 copyLocalSymbols();
199
Rafael Espindolad48b2082017-07-04 19:08:40 +0000200 clearOutputSections();
201
Rui Ueyamad57e74b72017-03-17 23:29:01 +0000202 if (Config->CopyRelocs)
Rafael Espindola08d6a3f2017-02-11 01:40:49 +0000203 addSectionSymbols();
204
Rui Ueyama0b1b6952016-11-21 02:11:05 +0000205 // Now that we have a complete set of output sections. This function
206 // completes section contents. For example, we need to add strings
207 // to the string table, and add entries to .got and .plt.
208 // finalizeSections does that.
Rui Ueyamaf83aca42016-11-01 23:17:45 +0000209 finalizeSections();
Rui Ueyamaf373dd72016-11-24 01:43:21 +0000210 if (ErrorCount)
Rui Ueyamaf83aca42016-11-01 23:17:45 +0000211 return;
212
Rafael Espindolaa6fef0e2017-06-05 23:43:49 +0000213 if (!Script->Opt.HasSections && !Config->Relocatable)
Rafael Espindolac7c42f62017-06-03 06:51:22 +0000214 fixSectionAlignments();
215
Rafael Espindola55b169b2017-05-24 18:08:04 +0000216 // If -compressed-debug-sections is specified, we need to compress
217 // .debug_* sections. Do it right now because it changes the size of
218 // output sections.
Rafael Espindola68880722017-06-01 16:57:48 +0000219 parallelForEach(
220 OutputSectionCommands.begin(), OutputSectionCommands.end(),
221 [](OutputSectionCommand *Cmd) { Cmd->maybeCompress<ELFT>(); });
Rafael Espindola805f5152017-06-01 16:30:12 +0000222
Rafael Espindolaf51c8052017-06-13 23:26:31 +0000223 Script->assignAddresses(Phdrs);
Rafael Espindola189860c2017-06-07 02:24:08 +0000224
225 // Remove empty PT_LOAD to avoid causing the dynamic linker to try to mmap a
226 // 0 sized region. This has to be done late since only after assignAddresses
227 // we know the size of the sections.
228 removeEmptyPTLoad();
229
230 if (!Config->OFormatBinary)
Rui Ueyamaf83aca42016-11-01 23:17:45 +0000231 assignFileOffsets();
Rafael Espindola189860c2017-06-07 02:24:08 +0000232 else
233 assignFileOffsetsBinary();
234
235 setPhdrs();
236
237 if (Config->Relocatable) {
238 for (OutputSectionCommand *Cmd : OutputSectionCommands)
239 Cmd->Sec->Addr = 0;
Rui Ueyamaf83aca42016-11-01 23:17:45 +0000240 } else {
Rafael Espindola78493a22017-01-28 17:48:21 +0000241 fixPredefinedSymbols();
Rui Ueyamaf83aca42016-11-01 23:17:45 +0000242 }
243
George Rimar2ddab6d2017-01-17 13:50:34 +0000244 // It does not make sense try to open the file if we have error already.
245 if (ErrorCount)
246 return;
Rui Ueyama0b1b6952016-11-21 02:11:05 +0000247 // Write the result down to a file.
Rui Ueyamaf83aca42016-11-01 23:17:45 +0000248 openFile();
Rui Ueyamaf373dd72016-11-24 01:43:21 +0000249 if (ErrorCount)
Rui Ueyamaf83aca42016-11-01 23:17:45 +0000250 return;
Rafael Espindola3f235c72017-06-01 16:32:58 +0000251
Rui Ueyamaf83aca42016-11-01 23:17:45 +0000252 if (!Config->OFormatBinary) {
253 writeHeader();
254 writeSections();
255 } else {
256 writeSectionsBinary();
257 }
Rui Ueyama0b1b6952016-11-21 02:11:05 +0000258
259 // Backfill .note.gnu.build-id section content. This is done at last
260 // because the content is usually a hash value of the entire output file.
Rui Ueyamaf83aca42016-11-01 23:17:45 +0000261 writeBuildId();
Rui Ueyamaf373dd72016-11-24 01:43:21 +0000262 if (ErrorCount)
Rui Ueyamaf83aca42016-11-01 23:17:45 +0000263 return;
Rui Ueyama0b1b6952016-11-21 02:11:05 +0000264
Rafael Espindolaa46f6882017-05-18 21:30:14 +0000265
Rui Ueyama40eaa992017-01-18 03:34:38 +0000266 // Handle -Map option.
Rafael Espindola2d9a3be2017-05-30 01:30:14 +0000267 writeMapFile<ELFT>(OutputSectionCommands);
Rui Ueyama40eaa992017-01-18 03:34:38 +0000268 if (ErrorCount)
269 return;
270
Rui Ueyamaf83aca42016-11-01 23:17:45 +0000271 if (auto EC = Buffer->commit())
Rui Ueyamac8d3a832017-01-12 22:18:04 +0000272 error("failed to write to the output file: " + EC.message());
Rui Ueyama0b1b6952016-11-21 02:11:05 +0000273
274 // Flush the output streams and exit immediately. A full shutdown
275 // is a good test that we are keeping track of all allocated memory,
276 // but actually freeing it is a waste of time in a regular linker run.
277 if (Config->ExitEarly)
Rui Ueyamaf83aca42016-11-01 23:17:45 +0000278 exitLld(0);
Rui Ueyamaf83aca42016-11-01 23:17:45 +0000279}
280
Rui Ueyama9d1bacb12017-02-27 02:31:26 +0000281// Initialize Out members.
Rui Ueyamaf83aca42016-11-01 23:17:45 +0000282template <class ELFT> void Writer<ELFT>::createSyntheticSections() {
283 // Initialize all pointers with NULL. This is needed because
284 // you can call lld::elf::main more than once as a library.
Rui Ueyama9d1bacb12017-02-27 02:31:26 +0000285 memset(&Out::First, 0, sizeof(Out));
Rui Ueyamacfadbd92016-11-01 23:12:51 +0000286
Rui Ueyama536a2672017-02-27 02:32:08 +0000287 auto Add = [](InputSectionBase *Sec) { InputSections.push_back(Sec); };
Rui Ueyama7ddd7a82017-02-05 05:18:58 +0000288
Rafael Espindola895aea62017-05-11 22:02:41 +0000289 InX::DynStrTab = make<StringTableSection>(".dynstr", true);
Rafael Espindola5ab19892017-05-11 23:16:43 +0000290 InX::Dynamic = make<DynamicSection<ELFT>>();
Eugene Levianta96d9022016-11-16 10:02:27 +0000291 In<ELFT>::RelaDyn = make<RelocationSection<ELFT>>(
Rui Ueyamad57e74b72017-03-17 23:29:01 +0000292 Config->IsRela ? ".rela.dyn" : ".rel.dyn", Config->ZCombreloc);
Rafael Espindola895aea62017-05-11 22:02:41 +0000293 InX::ShStrTab = make<StringTableSection>(".shstrtab", false);
Rui Ueyama4197a6a2016-02-05 18:41:40 +0000294
Rui Ueyama9d1bacb12017-02-27 02:31:26 +0000295 Out::ElfHeader = make<OutputSection>("", 0, SHF_ALLOC);
296 Out::ElfHeader->Size = sizeof(Elf_Ehdr);
297 Out::ProgramHeaders = make<OutputSection>("", 0, SHF_ALLOC);
Rui Ueyama6bd38222017-04-05 21:37:09 +0000298 Out::ProgramHeaders->updateAlignment(Config->Wordsize);
Rui Ueyama4197a6a2016-02-05 18:41:40 +0000299
Rui Ueyamae8a61022016-11-05 23:05:47 +0000300 if (needsInterpSection<ELFT>()) {
Rafael Espindola895aea62017-05-11 22:02:41 +0000301 InX::Interp = createInterpSection();
302 Add(InX::Interp);
Rui Ueyamae8a61022016-11-05 23:05:47 +0000303 } else {
Rafael Espindola895aea62017-05-11 22:02:41 +0000304 InX::Interp = nullptr;
Rui Ueyamae8a61022016-11-05 23:05:47 +0000305 }
Rui Ueyama3a41be22016-04-07 22:49:21 +0000306
George Rimarf21aade2016-08-31 08:38:11 +0000307 if (Config->Strip != StripPolicy::All) {
Rafael Espindola895aea62017-05-11 22:02:41 +0000308 InX::StrTab = make<StringTableSection>(".strtab", false);
George Rimarf45f6812017-05-16 08:53:30 +0000309 InX::SymTab = make<SymbolTableSection<ELFT>>(*InX::StrTab);
Rui Ueyama4197a6a2016-02-05 18:41:40 +0000310 }
Rui Ueyamacfadbd92016-11-01 23:12:51 +0000311
Rui Ueyamac4030a12016-11-22 00:54:15 +0000312 if (Config->BuildId != BuildIdKind::None) {
Rafael Espindola895aea62017-05-11 22:02:41 +0000313 InX::BuildId = make<BuildIdSection>();
314 Add(InX::BuildId);
Rui Ueyamac4030a12016-11-22 00:54:15 +0000315 }
Rui Ueyamae8a61022016-11-05 23:05:47 +0000316
Rafael Espindola895aea62017-05-11 22:02:41 +0000317 InX::Common = createCommonSection<ELFT>();
318 if (InX::Common)
George Rimar176d6062017-03-17 13:31:07 +0000319 Add(InX::Common);
Simon Atanasyance02cf02016-11-09 21:36:56 +0000320
Rafael Espindola895aea62017-05-11 22:02:41 +0000321 InX::Bss = make<BssSection>(".bss");
322 Add(InX::Bss);
323 InX::BssRelRo = make<BssSection>(".bss.rel.ro");
324 Add(InX::BssRelRo);
George Rimar1ab9cf42017-03-17 10:14:53 +0000325
Rui Ueyama1d75de02016-11-22 04:28:39 +0000326 // Add MIPS-specific sections.
Rui Ueyamad57e74b72017-03-17 23:29:01 +0000327 bool HasDynSymTab = !Symtab<ELFT>::X->getSharedFiles().empty() ||
328 Config->Pic || Config->ExportDynamic;
Simon Atanasyance02cf02016-11-09 21:36:56 +0000329 if (Config->EMachine == EM_MIPS) {
George Rimar11992c862016-11-25 08:05:41 +0000330 if (!Config->Shared && HasDynSymTab) {
Rafael Espindola895aea62017-05-11 22:02:41 +0000331 InX::MipsRldMap = make<MipsRldMapSection>();
332 Add(InX::MipsRldMap);
Eugene Leviant17b7a572016-11-22 17:49:14 +0000333 }
Rui Ueyama1d75de02016-11-22 04:28:39 +0000334 if (auto *Sec = MipsAbiFlagsSection<ELFT>::create())
Rui Ueyama7ddd7a82017-02-05 05:18:58 +0000335 Add(Sec);
Rui Ueyama1d75de02016-11-22 04:28:39 +0000336 if (auto *Sec = MipsOptionsSection<ELFT>::create())
Rui Ueyama7ddd7a82017-02-05 05:18:58 +0000337 Add(Sec);
Rui Ueyama1d75de02016-11-22 04:28:39 +0000338 if (auto *Sec = MipsReginfoSection<ELFT>::create())
Rui Ueyama7ddd7a82017-02-05 05:18:58 +0000339 Add(Sec);
Simon Atanasyance02cf02016-11-09 21:36:56 +0000340 }
Eugene Leviant41ca3272016-11-10 09:48:29 +0000341
George Rimar11992c862016-11-25 08:05:41 +0000342 if (HasDynSymTab) {
George Rimar69b17c32017-05-16 10:04:42 +0000343 InX::DynSymTab = make<SymbolTableSection<ELFT>>(*InX::DynStrTab);
344 Add(InX::DynSymTab);
George Rimar11992c862016-11-25 08:05:41 +0000345
346 In<ELFT>::VerSym = make<VersionTableSection<ELFT>>();
Rui Ueyama7ddd7a82017-02-05 05:18:58 +0000347 Add(In<ELFT>::VerSym);
George Rimar11992c862016-11-25 08:05:41 +0000348
349 if (!Config->VersionDefinitions.empty()) {
350 In<ELFT>::VerDef = make<VersionDefinitionSection<ELFT>>();
Rui Ueyama7ddd7a82017-02-05 05:18:58 +0000351 Add(In<ELFT>::VerDef);
George Rimar11992c862016-11-25 08:05:41 +0000352 }
353
354 In<ELFT>::VerNeed = make<VersionNeedSection<ELFT>>();
Rui Ueyama7ddd7a82017-02-05 05:18:58 +0000355 Add(In<ELFT>::VerNeed);
George Rimar11992c862016-11-25 08:05:41 +0000356
357 if (Config->GnuHash) {
George Rimar69b17c32017-05-16 10:04:42 +0000358 InX::GnuHashTab = make<GnuHashTableSection>();
359 Add(InX::GnuHashTab);
George Rimar11992c862016-11-25 08:05:41 +0000360 }
361
362 if (Config->SysvHash) {
363 In<ELFT>::HashTab = make<HashTableSection<ELFT>>();
Rui Ueyama7ddd7a82017-02-05 05:18:58 +0000364 Add(In<ELFT>::HashTab);
George Rimar11992c862016-11-25 08:05:41 +0000365 }
366
Rafael Espindola5ab19892017-05-11 23:16:43 +0000367 Add(InX::Dynamic);
Rafael Espindola895aea62017-05-11 22:02:41 +0000368 Add(InX::DynStrTab);
Rui Ueyama7ddd7a82017-02-05 05:18:58 +0000369 Add(In<ELFT>::RelaDyn);
George Rimar11992c862016-11-25 08:05:41 +0000370 }
371
Rui Ueyama1d75de02016-11-22 04:28:39 +0000372 // Add .got. MIPS' .got is so different from the other archs,
373 // it has its own class.
George Rimar11992c862016-11-25 08:05:41 +0000374 if (Config->EMachine == EM_MIPS) {
Rafael Espindolab3aa2c92017-05-11 21:33:30 +0000375 InX::MipsGot = make<MipsGotSection>();
376 Add(InX::MipsGot);
George Rimar11992c862016-11-25 08:05:41 +0000377 } else {
Rafael Espindolaa6465bb2017-05-18 16:45:36 +0000378 InX::Got = make<GotSection>();
Rafael Espindola88ab9fb2017-05-11 23:26:03 +0000379 Add(InX::Got);
George Rimar11992c862016-11-25 08:05:41 +0000380 }
Simon Atanasyan725dc142016-11-16 21:01:02 +0000381
Rafael Espindola4b1c3692017-05-11 21:23:38 +0000382 InX::GotPlt = make<GotPltSection>();
383 Add(InX::GotPlt);
Rafael Espindola895aea62017-05-11 22:02:41 +0000384 InX::IgotPlt = make<IgotPltSection>();
385 Add(InX::IgotPlt);
George Rimar3fb5a6d2016-11-29 16:05:27 +0000386
387 if (Config->GdbIndex) {
Rafael Espindola895aea62017-05-11 22:02:41 +0000388 InX::GdbIndex = make<GdbIndexSection>();
389 Add(InX::GdbIndex);
George Rimar3fb5a6d2016-11-29 16:05:27 +0000390 }
391
392 // We always need to add rel[a].plt to output if it has entries.
393 // Even for static linking it can contain R_[*]_IRELATIVE relocations.
394 In<ELFT>::RelaPlt = make<RelocationSection<ELFT>>(
Rui Ueyamad57e74b72017-03-17 23:29:01 +0000395 Config->IsRela ? ".rela.plt" : ".rel.plt", false /*Sort*/);
Rui Ueyama7ddd7a82017-02-05 05:18:58 +0000396 Add(In<ELFT>::RelaPlt);
George Rimar3fb5a6d2016-11-29 16:05:27 +0000397
Peter Smithbaffdb82016-12-08 12:58:55 +0000398 // The RelaIplt immediately follows .rel.plt (.rel.dyn for ARM) to ensure
399 // that the IRelative relocations are processed last by the dynamic loader
400 In<ELFT>::RelaIplt = make<RelocationSection<ELFT>>(
401 (Config->EMachine == EM_ARM) ? ".rel.dyn" : In<ELFT>::RelaPlt->Name,
402 false /*Sort*/);
Rui Ueyama7ddd7a82017-02-05 05:18:58 +0000403 Add(In<ELFT>::RelaIplt);
Peter Smithbaffdb82016-12-08 12:58:55 +0000404
Rafael Espindola895aea62017-05-11 22:02:41 +0000405 InX::Plt = make<PltSection>(Target->PltHeaderSize);
406 Add(InX::Plt);
407 InX::Iplt = make<PltSection>(0);
408 Add(InX::Iplt);
George Rimar3fb5a6d2016-11-29 16:05:27 +0000409
Rafael Espindola66b4e212017-02-23 22:06:28 +0000410 if (!Config->Relocatable) {
George Rimar1c74c2f2017-03-09 08:45:25 +0000411 if (Config->EhFrameHdr) {
412 In<ELFT>::EhFrameHdr = make<EhFrameHeader<ELFT>>();
413 Add(In<ELFT>::EhFrameHdr);
414 }
Rafael Espindola66b4e212017-02-23 22:06:28 +0000415 In<ELFT>::EhFrame = make<EhFrameSection<ELFT>>();
416 Add(In<ELFT>::EhFrame);
417 }
418
George Rimar69b17c32017-05-16 10:04:42 +0000419 if (InX::SymTab)
420 Add(InX::SymTab);
Rafael Espindola895aea62017-05-11 22:02:41 +0000421 Add(InX::ShStrTab);
422 if (InX::StrTab)
423 Add(InX::StrTab);
Michael J. Spencer84487f12015-07-24 21:03:07 +0000424}
425
Rafael Espindola5616adf2017-03-08 22:36:28 +0000426static bool shouldKeepInSymtab(SectionBase *Sec, StringRef SymName,
Rafael Espindolaccfe3cb2016-04-04 14:04:16 +0000427 const SymbolBody &B) {
Rafael Espindola08d6a3f2017-02-11 01:40:49 +0000428 if (B.isFile() || B.isSection())
Rafael Espindola10d71ff2016-01-27 18:04:26 +0000429 return false;
430
Rafael Espindola10d71ff2016-01-27 18:04:26 +0000431 // If sym references a section in a discarded group, don't keep it.
Rafael Espindola774ea7d2017-02-23 16:49:07 +0000432 if (Sec == &InputSection::Discarded)
Rafael Espindola10d71ff2016-01-27 18:04:26 +0000433 return false;
434
George Rimar9503f6d2016-08-31 08:46:30 +0000435 if (Config->Discard == DiscardPolicy::None)
Rafael Espindola10d71ff2016-01-27 18:04:26 +0000436 return true;
437
438 // In ELF assembly .L symbols are normally discarded by the assembler.
439 // If the assembler fails to do so, the linker discards them if
440 // * --discard-locals is used.
441 // * The symbol is in a SHF_MERGE section, which is normally the reason for
442 // the assembler keeping the .L symbol.
443 if (!SymName.startswith(".L") && !SymName.empty())
444 return true;
445
George Rimar9503f6d2016-08-31 08:46:30 +0000446 if (Config->Discard == DiscardPolicy::Locals)
Rafael Espindola10d71ff2016-01-27 18:04:26 +0000447 return false;
448
Rafael Espindola1854a8e2016-10-26 12:36:56 +0000449 return !Sec || !(Sec->Flags & SHF_MERGE);
Rafael Espindola10d71ff2016-01-27 18:04:26 +0000450}
451
George Rimar7702bc22017-03-16 11:20:02 +0000452static bool includeInSymtab(const SymbolBody &B) {
Rafael Espindola474eb012016-05-05 16:40:28 +0000453 if (!B.isLocal() && !B.symbol()->IsUsedInRegularObj)
454 return false;
455
Rui Ueyama80474a22017-02-28 19:29:55 +0000456 if (auto *D = dyn_cast<DefinedRegular>(&B)) {
Rafael Espindola474eb012016-05-05 16:40:28 +0000457 // Always include absolute symbols.
Rafael Espindola5616adf2017-03-08 22:36:28 +0000458 SectionBase *Sec = D->Section;
459 if (!Sec)
Rafael Espindola474eb012016-05-05 16:40:28 +0000460 return true;
Rafael Espindola5616adf2017-03-08 22:36:28 +0000461 if (auto *IS = dyn_cast<InputSectionBase>(Sec)) {
462 Sec = IS->Repl;
463 IS = cast<InputSectionBase>(Sec);
464 // Exclude symbols pointing to garbage-collected sections.
465 if (!IS->Live)
466 return false;
467 }
468 if (auto *S = dyn_cast<MergeInputSection>(Sec))
Rui Ueyama90fa3722016-05-22 00:41:38 +0000469 if (!S->getSectionPiece(D->Value)->Live)
Rafael Espindola474eb012016-05-05 16:40:28 +0000470 return false;
471 }
472 return true;
473}
Rafael Espindola462220d2016-05-05 16:38:46 +0000474
Rui Ueyama5a9640b2015-10-08 23:49:30 +0000475// Local symbols are not in the linker's symbol table. This function scans
476// each object file's symbol table to copy local symbols to the output.
477template <class ELFT> void Writer<ELFT>::copyLocalSymbols() {
George Rimar69b17c32017-05-16 10:04:42 +0000478 if (!InX::SymTab)
Rui Ueyama90f76fb2016-01-21 03:07:38 +0000479 return;
Rui Ueyama38dbd3e2016-09-14 00:05:51 +0000480 for (elf::ObjectFile<ELFT> *F : Symtab<ELFT>::X->getObjectFiles()) {
Rafael Espindola67d72c02016-03-11 12:06:30 +0000481 for (SymbolBody *B : F->getLocalSymbols()) {
George Rimar78fe56e2016-10-11 09:07:14 +0000482 if (!B->IsLocal)
Rui Ueyama3fc0f7e2016-11-23 18:07:33 +0000483 fatal(toString(F) +
George Rimar78fe56e2016-10-11 09:07:14 +0000484 ": broken object: getLocalSymbols returns a non-local symbol");
Rui Ueyama80474a22017-02-28 19:29:55 +0000485 auto *DR = dyn_cast<DefinedRegular>(B);
Rui Ueyama3fc0f7e2016-11-23 18:07:33 +0000486
Rafael Espindolaccfe3cb2016-04-04 14:04:16 +0000487 // No reason to keep local undefined symbol in symtab.
488 if (!DR)
Rafael Espindola444576d2015-10-09 19:25:07 +0000489 continue;
George Rimar7702bc22017-03-16 11:20:02 +0000490 if (!includeInSymtab(*B))
Rafael Espindola462220d2016-05-05 16:38:46 +0000491 continue;
Rui Ueyama3fc0f7e2016-11-23 18:07:33 +0000492
Rafael Espindola5616adf2017-03-08 22:36:28 +0000493 SectionBase *Sec = DR->Section;
George Rimar7702bc22017-03-16 11:20:02 +0000494 if (!shouldKeepInSymtab(Sec, B->getName(), *B))
Rafael Espindolaccfe3cb2016-04-04 14:04:16 +0000495 continue;
George Rimar69b17c32017-05-16 10:04:42 +0000496 InX::SymTab->addSymbol(B);
Rui Ueyama5a9640b2015-10-08 23:49:30 +0000497 }
498 }
499}
500
Rafael Espindola08d6a3f2017-02-11 01:40:49 +0000501template <class ELFT> void Writer<ELFT>::addSectionSymbols() {
502 // Create one STT_SECTION symbol for each output section we might
503 // have a relocation with.
Rafael Espindolad48b2082017-07-04 19:08:40 +0000504 for (BaseCommand *Base : Script->Opt.Commands) {
505 auto *Cmd = dyn_cast<OutputSectionCommand>(Base);
506 if (!Cmd)
Rui Ueyama73d29ab2017-02-28 19:43:54 +0000507 continue;
Rafael Espindolad48b2082017-07-04 19:08:40 +0000508 auto I = llvm::find_if(Cmd->Commands, [](BaseCommand *Base) {
509 if (auto *ISD = dyn_cast<InputSectionDescription>(Base))
510 return !ISD->Sections.empty();
511 return false;
512 });
513 if (I == Cmd->Commands.end())
514 continue;
515 InputSection *IS = cast<InputSectionDescription>(*I)->Sections[0];
Rui Ueyama73d29ab2017-02-28 19:43:54 +0000516 if (isa<SyntheticSection>(IS) || IS->Type == SHT_REL ||
Rafael Espindola08d6a3f2017-02-11 01:40:49 +0000517 IS->Type == SHT_RELA)
518 continue;
Rafael Espindola08d6a3f2017-02-11 01:40:49 +0000519
Rui Ueyama175e81c2017-02-28 19:36:30 +0000520 auto *Sym =
521 make<DefinedRegular>("", /*IsLocal=*/true, /*StOther=*/0, STT_SECTION,
522 /*Value=*/0, /*Size=*/0, IS, nullptr);
George Rimar69b17c32017-05-16 10:04:42 +0000523 InX::SymTab->addSymbol(Sym);
Rafael Espindola08d6a3f2017-02-11 01:40:49 +0000524 }
525}
526
Rui Ueyama26ad0572017-02-16 04:51:46 +0000527// Today's loaders have a feature to make segments read-only after
528// processing dynamic relocations to enhance security. PT_GNU_RELRO
529// is defined for that.
530//
531// This function returns true if a section needs to be put into a
532// PT_GNU_RELRO segment.
Rafael Espindola9e889eb2017-05-11 23:31:06 +0000533bool elf::isRelroSection(const OutputSection *Sec) {
Rafael Espindola4fc60442016-02-10 22:43:13 +0000534 if (!Config->ZRelro)
535 return false;
Rui Ueyama26ad0572017-02-16 04:51:46 +0000536
Rafael Espindolae08e78d2016-11-09 23:23:45 +0000537 uint64_t Flags = Sec->Flags;
Rui Ueyama9d773f32017-04-13 05:40:07 +0000538
539 // Non-allocatable or non-writable sections don't need RELRO because
540 // they are not writable or not even mapped to memory in the first place.
541 // RELRO is for sections that are essentially read-only but need to
542 // be writable only at process startup to allow dynamic linker to
543 // apply relocations.
George Rimare3336c02015-11-24 10:15:50 +0000544 if (!(Flags & SHF_ALLOC) || !(Flags & SHF_WRITE))
545 return false;
Rui Ueyama9d773f32017-04-13 05:40:07 +0000546
547 // Once initialized, TLS data segments are used as data templates
548 // for a thread-local storage. For each new thread, runtime
549 // allocates memory for a TLS and copy templates there. No thread
550 // are supposed to use templates directly. Thus, it can be in RELRO.
Rui Ueyamaccfc3262015-12-10 19:13:08 +0000551 if (Flags & SHF_TLS)
552 return true;
Rui Ueyama26ad0572017-02-16 04:51:46 +0000553
Rui Ueyama9d773f32017-04-13 05:40:07 +0000554 // .init_array, .preinit_array and .fini_array contain pointers to
555 // functions that are executed on process startup or exit. These
556 // pointers are set by the static linker, and they are not expected
557 // to change at runtime. But if you are an attacker, you could do
558 // interesting things by manipulating pointers in .fini_array, for
559 // example. So they are put into RELRO.
Rafael Espindola04a2e342016-11-09 01:42:41 +0000560 uint32_t Type = Sec->Type;
Rui Ueyamaccfc3262015-12-10 19:13:08 +0000561 if (Type == SHT_INIT_ARRAY || Type == SHT_FINI_ARRAY ||
562 Type == SHT_PREINIT_ARRAY)
George Rimare3336c02015-11-24 10:15:50 +0000563 return true;
Rui Ueyama26ad0572017-02-16 04:51:46 +0000564
Rui Ueyama9d773f32017-04-13 05:40:07 +0000565 // .got contains pointers to external symbols. They are resolved by
566 // the dynamic linker when a module is loaded into memory, and after
567 // that they are not expected to change. So, it can be in RELRO.
Rafael Espindoladb5e56f2017-05-31 20:17:44 +0000568 if (InX::Got && Sec == InX::Got->getParent())
Simon Atanasyan725dc142016-11-16 21:01:02 +0000569 return true;
Rui Ueyama9d773f32017-04-13 05:40:07 +0000570
571 // .got.plt contains pointers to external function symbols. They are
572 // by default resolved lazily, so we usually cannot put it into RELRO.
573 // However, if "-z now" is given, the lazy symbol resolution is
574 // disabled, which enables us to put it into RELRO.
Rafael Espindoladb5e56f2017-05-31 20:17:44 +0000575 if (Sec == InX::GotPlt->getParent())
Rui Ueyama9d773f32017-04-13 05:40:07 +0000576 return Config->ZNow;
577
578 // .dynamic section contains data for the dynamic linker, and
579 // there's no need to write to it at runtime, so it's better to put
580 // it into RELRO.
Rafael Espindoladb5e56f2017-05-31 20:17:44 +0000581 if (Sec == InX::Dynamic->getParent())
Rui Ueyama9d773f32017-04-13 05:40:07 +0000582 return true;
583
584 // .bss.rel.ro is used for copy relocations for read-only symbols.
585 // Since the dynamic linker needs to process copy relocations, the
586 // section cannot be read-only, but once initialized, they shouldn't
587 // change.
Rafael Espindoladb5e56f2017-05-31 20:17:44 +0000588 if (Sec == InX::BssRelRo->getParent())
Peter Collingbournefeb66292017-01-10 01:21:50 +0000589 return true;
Rui Ueyama26ad0572017-02-16 04:51:46 +0000590
Rui Ueyama9d773f32017-04-13 05:40:07 +0000591 // Sections with some special names are put into RELRO. This is a
592 // bit unfortunate because section names shouldn't be significant in
593 // ELF in spirit. But in reality many linker features depend on
594 // magic section names.
Rafael Espindola40849412017-02-24 14:28:00 +0000595 StringRef S = Sec->Name;
Rui Ueyama01faef02015-12-10 19:19:04 +0000596 return S == ".data.rel.ro" || S == ".ctors" || S == ".dtors" || S == ".jcr" ||
George Rimard003c7f2016-12-20 11:28:54 +0000597 S == ".eh_frame" || S == ".openbsd.randomdata";
George Rimare3336c02015-11-24 10:15:50 +0000598}
599
Rafael Espindola52101412017-05-12 14:52:22 +0000600// We compute a rank for each section. The rank indicates where the
601// section should be placed in the file. Instead of using simple
602// numbers (0,1,2...), we use a series of flags. One for each decision
603// point when placing the section.
604// Using flags has two key properties:
605// * It is easy to check if a give branch was taken.
606// * It is easy two see how similar two ranks are (see getRankProximity).
607enum RankFlags {
Rafael Espindolad23e9262017-05-26 17:23:25 +0000608 RF_NOT_ADDR_SET = 1 << 16,
609 RF_NOT_INTERP = 1 << 15,
610 RF_NOT_ALLOC = 1 << 14,
611 RF_WRITE = 1 << 13,
612 RF_EXEC_WRITE = 1 << 12,
Rafael Espindola246c1c42017-05-18 16:20:12 +0000613 RF_EXEC = 1 << 11,
614 RF_NON_TLS_BSS = 1 << 10,
615 RF_NON_TLS_BSS_RO = 1 << 9,
616 RF_NOT_TLS = 1 << 8,
617 RF_BSS = 1 << 7,
618 RF_PPC_NOT_TOCBSS = 1 << 6,
619 RF_PPC_OPD = 1 << 5,
620 RF_PPC_TOCL = 1 << 4,
621 RF_PPC_TOC = 1 << 3,
622 RF_PPC_BRANCH_LT = 1 << 2,
623 RF_MIPS_GPREL = 1 << 1,
624 RF_MIPS_NOT_GOT = 1 << 0
Rafael Espindola52101412017-05-12 14:52:22 +0000625};
Rui Ueyamae288eef2016-11-02 18:58:44 +0000626
Rafael Espindola52101412017-05-12 14:52:22 +0000627static unsigned getSectionRank(const OutputSection *Sec) {
628 unsigned Rank = 0;
Rui Ueyama5a9640b2015-10-08 23:49:30 +0000629
Rafael Espindola5967c972016-12-19 21:21:07 +0000630 // We want to put section specified by -T option first, so we
631 // can start assigning VA starting from them later.
Rafael Espindola52101412017-05-12 14:52:22 +0000632 if (Config->SectionStartMap.count(Sec->Name))
633 return Rank;
634 Rank |= RF_NOT_ADDR_SET;
635
636 // Put .interp first because some loaders want to see that section
637 // on the first page of the executable file when loaded into memory.
638 if (Sec->Name == ".interp")
639 return Rank;
640 Rank |= RF_NOT_INTERP;
641
642 // Allocatable sections go first to reduce the total PT_LOAD size and
643 // so debug info doesn't change addresses in actual code.
644 if (!(Sec->Flags & SHF_ALLOC))
645 return Rank | RF_NOT_ALLOC;
Rafael Espindola5967c972016-12-19 21:21:07 +0000646
Rafael Espindolad23e9262017-05-26 17:23:25 +0000647 // Sort sections based on their access permission in the following
648 // order: R, RX, RWX, RW. This order is based on the following
649 // considerations:
650 // * Read-only sections come first such that they go in the
651 // PT_LOAD covering the program headers at the start of the file.
652 // * Read-only, executable sections come next, unless the
653 // -no-rosegment option is used.
654 // * Writable, executable sections follow such that .plt on
655 // architectures where it needs to be writable will be placed
656 // between .text and .data.
657 // * Writable sections come last, such that .bss lands at the very
658 // end of the last PT_LOAD.
659 bool IsExec = Sec->Flags & SHF_EXECINSTR;
660 bool IsWrite = Sec->Flags & SHF_WRITE;
Rui Ueyama5a9640b2015-10-08 23:49:30 +0000661
Rafael Espindolad23e9262017-05-26 17:23:25 +0000662 if (IsExec) {
663 if (IsWrite)
664 Rank |= RF_EXEC_WRITE;
665 else if (!Config->SingleRoRx)
Rafael Espindola52101412017-05-12 14:52:22 +0000666 Rank |= RF_EXEC;
Rafael Espindolad23e9262017-05-26 17:23:25 +0000667 } else {
668 if (IsWrite)
669 Rank |= RF_WRITE;
Rafael Espindolae979fd12016-09-29 22:48:55 +0000670 }
Rui Ueyama5a9640b2015-10-08 23:49:30 +0000671
Hal Finkel0d7e83b2015-10-13 17:57:46 +0000672 // If we got here we know that both A and B are in the same PT_LOAD.
Michael J. Spencer1bf73002015-10-16 23:11:07 +0000673
Rafael Espindola52101412017-05-12 14:52:22 +0000674 bool IsTls = Sec->Flags & SHF_TLS;
675 bool IsNoBits = Sec->Type == SHT_NOBITS;
Hal Finkel3bae2d82015-10-12 20:51:48 +0000676
Peter Collingbourne628ec9f2017-01-10 01:21:30 +0000677 // The first requirement we have is to put (non-TLS) nobits sections last. The
678 // reason is that the only thing the dynamic linker will see about them is a
679 // p_memsz that is larger than p_filesz. Seeing that it zeros the end of the
680 // PT_LOAD, so that has to correspond to the nobits sections.
Rafael Espindola52101412017-05-12 14:52:22 +0000681 bool IsNonTlsNoBits = IsNoBits && !IsTls;
682 if (IsNonTlsNoBits)
683 Rank |= RF_NON_TLS_BSS;
Peter Collingbourne628ec9f2017-01-10 01:21:30 +0000684
685 // We place nobits RelRo sections before plain r/w ones, and non-nobits RelRo
686 // sections after r/w ones, so that the RelRo sections are contiguous.
Rafael Espindola52101412017-05-12 14:52:22 +0000687 bool IsRelRo = isRelroSection(Sec);
688 if (IsNonTlsNoBits && !IsRelRo)
689 Rank |= RF_NON_TLS_BSS_RO;
690 if (!IsNonTlsNoBits && IsRelRo)
691 Rank |= RF_NON_TLS_BSS_RO;
Peter Collingbourne628ec9f2017-01-10 01:21:30 +0000692
693 // The TLS initialization block needs to be a single contiguous block in a R/W
694 // PT_LOAD, so stick TLS sections directly before the other RelRo R/W
695 // sections. The TLS NOBITS sections are placed here as they don't take up
696 // virtual address space in the PT_LOAD.
Rafael Espindola52101412017-05-12 14:52:22 +0000697 if (!IsTls)
698 Rank |= RF_NOT_TLS;
Peter Collingbourne628ec9f2017-01-10 01:21:30 +0000699
700 // Within the TLS initialization block, the non-nobits sections need to appear
701 // first.
Rafael Espindola52101412017-05-12 14:52:22 +0000702 if (IsNoBits)
703 Rank |= RF_BSS;
George Rimare3336c02015-11-24 10:15:50 +0000704
Rafael Espindola52101412017-05-12 14:52:22 +0000705 // // Some architectures have additional ordering restrictions for sections
706 // // within the same PT_LOAD.
707 if (Config->EMachine == EM_PPC64) {
708 // PPC64 has a number of special SHT_PROGBITS+SHF_ALLOC+SHF_WRITE sections
709 // that we would like to make sure appear is a specific order to maximize
710 // their coverage by a single signed 16-bit offset from the TOC base
711 // pointer. Conversely, the special .tocbss section should be first among
712 // all SHT_NOBITS sections. This will put it next to the loaded special
713 // PPC64 sections (and, thus, within reach of the TOC base pointer).
714 StringRef Name = Sec->Name;
715 if (Name != ".tocbss")
716 Rank |= RF_PPC_NOT_TOCBSS;
Hal Finkel9abc2a52015-10-13 19:07:29 +0000717
Rafael Espindola52101412017-05-12 14:52:22 +0000718 if (Name == ".opd")
719 Rank |= RF_PPC_OPD;
720
721 if (Name == ".toc1")
722 Rank |= RF_PPC_TOCL;
723
724 if (Name == ".toc")
725 Rank |= RF_PPC_TOC;
726
727 if (Name == ".branch_lt")
728 Rank |= RF_PPC_BRANCH_LT;
729 }
730 if (Config->EMachine == EM_MIPS) {
731 // All sections with SHF_MIPS_GPREL flag should be grouped together
732 // because data in these sections is addressable with a gp relative address.
733 if (Sec->Flags & SHF_MIPS_GPREL)
734 Rank |= RF_MIPS_GPREL;
735
736 if (Sec->Name != ".got")
737 Rank |= RF_MIPS_NOT_GOT;
738 }
739
740 return Rank;
741}
742
Rafael Espindola383971d2017-06-15 21:51:01 +0000743static bool compareSections(const BaseCommand *ACmd, const BaseCommand *BCmd) {
744 const OutputSection *A = cast<OutputSectionCommand>(ACmd)->Sec;
745 const OutputSection *B = cast<OutputSectionCommand>(BCmd)->Sec;
Rafael Espindola52101412017-05-12 14:52:22 +0000746 if (A->SortRank != B->SortRank)
747 return A->SortRank < B->SortRank;
748 if (!(A->SortRank & RF_NOT_ADDR_SET))
749 return Config->SectionStartMap.lookup(A->Name) <
750 Config->SectionStartMap.lookup(B->Name);
Rafael Espindola24c073d2016-09-21 22:36:19 +0000751 return false;
752}
753
Rafael Espindola24e6f362017-02-24 15:07:30 +0000754void PhdrEntry::add(OutputSection *Sec) {
Eugene Leviantbbe38602016-07-19 09:25:43 +0000755 Last = Sec;
756 if (!First)
757 First = Sec;
Rafael Espindola37707632017-03-07 14:55:52 +0000758 p_align = std::max(p_align, Sec->Alignment);
Rafael Espindola17cb7c02016-12-19 17:01:01 +0000759 if (p_type == PT_LOAD)
Eugene Leviant3d9abec2016-09-29 09:20:33 +0000760 Sec->FirstInPtLoad = First;
Eugene Leviantbbe38602016-07-19 09:25:43 +0000761}
762
Denis Protivensky8e3b38a2015-11-12 09:52:08 +0000763template <class ELFT>
Rafael Espindola5616adf2017-03-08 22:36:28 +0000764static Symbol *addRegular(StringRef Name, SectionBase *Sec, uint64_t Value,
765 uint8_t StOther = STV_HIDDEN,
766 uint8_t Binding = STB_WEAK) {
Rafael Espindoladab02d42016-11-17 21:20:16 +0000767 // The linker generated symbols are added as STB_WEAK to allow user defined
768 // ones to override them.
Rafael Espindola5616adf2017-03-08 22:36:28 +0000769 return Symtab<ELFT>::X->addRegular(Name, StOther, STT_NOTYPE, Value,
770 /*Size=*/0, Binding, Sec,
Rui Ueyama0cbf7492016-11-23 06:59:47 +0000771 /*File=*/nullptr);
Eugene Leviantad4439e2016-11-11 11:33:32 +0000772}
773
774template <class ELFT>
Rafael Espindola5616adf2017-03-08 22:36:28 +0000775static DefinedRegular *
776addOptionalRegular(StringRef Name, SectionBase *Sec, uint64_t Val,
777 uint8_t StOther = STV_HIDDEN, uint8_t Binding = STB_GLOBAL) {
Eugene Leviantad4439e2016-11-11 11:33:32 +0000778 SymbolBody *S = Symtab<ELFT>::X->find(Name);
779 if (!S)
780 return nullptr;
Rafael Espindola1d6d1b42017-01-17 16:08:06 +0000781 if (S->isInCurrentDSO())
Rafael Espindola5616adf2017-03-08 22:36:28 +0000782 return nullptr;
783 return cast<DefinedRegular>(
784 addRegular<ELFT>(Name, Sec, Val, StOther, Binding)->body());
Eugene Leviantad4439e2016-11-11 11:33:32 +0000785}
786
Rui Ueyama01687222015-12-26 09:47:57 +0000787// The beginning and the ending of .rel[a].plt section are marked
788// with __rel[a]_iplt_{start,end} symbols if it is a statically linked
789// executable. The runtime needs these symbols in order to resolve
790// all IRELATIVE relocs on startup. For dynamic executables, we don't
791// need these symbols, since IRELATIVE relocs are resolved through GOT
792// and PLT. For details, see http://www.airs.com/blog/archives/403.
George Rimaree741cf2016-04-14 13:23:02 +0000793template <class ELFT> void Writer<ELFT>::addRelIpltSymbols() {
George Rimar69b17c32017-05-16 10:04:42 +0000794 if (InX::DynSymTab)
George Rimara07ff662015-12-21 10:12:06 +0000795 return;
Rui Ueyamad57e74b72017-03-17 23:29:01 +0000796 StringRef S = Config->IsRela ? "__rela_iplt_start" : "__rel_iplt_start";
Rafael Espindola5616adf2017-03-08 22:36:28 +0000797 addOptionalRegular<ELFT>(S, In<ELFT>::RelaIplt, 0, STV_HIDDEN, STB_WEAK);
Rui Ueyama01687222015-12-26 09:47:57 +0000798
Rui Ueyamad57e74b72017-03-17 23:29:01 +0000799 S = Config->IsRela ? "__rela_iplt_end" : "__rel_iplt_end";
Rafael Espindola5616adf2017-03-08 22:36:28 +0000800 addOptionalRegular<ELFT>(S, In<ELFT>::RelaIplt, -1, STV_HIDDEN, STB_WEAK);
George Rimara07ff662015-12-21 10:12:06 +0000801}
802
Rui Ueyamaf18fe7b2015-12-26 07:50:39 +0000803// The linker is expected to define some symbols depending on
804// the linking result. This function defines such symbols.
805template <class ELFT> void Writer<ELFT>::addReservedSymbols() {
George Rimar7beff422016-11-15 08:19:02 +0000806 if (Config->EMachine == EM_MIPS) {
Rafael Espindola9b3f99e2016-04-12 02:24:43 +0000807 // Define _gp for MIPS. st_value of _gp symbol will be updated by Writer
Simon Atanasyan6a4eb752016-12-08 06:19:47 +0000808 // so that it points to an absolute address which by default is relative
809 // to GOT. Default offset is 0x7ff0.
Rafael Espindola9b3f99e2016-04-12 02:24:43 +0000810 // See "Global Data Symbols" in Chapter 6 in the following document:
811 // ftp://www.linux-mips.org/pub/linux/mips/doc/ABI/mipsabi.pdf
Rui Ueyama80474a22017-02-28 19:29:55 +0000812 ElfSym::MipsGp = Symtab<ELFT>::X->addAbsolute("_gp", STV_HIDDEN, STB_LOCAL);
Rafael Espindola9b3f99e2016-04-12 02:24:43 +0000813
Rafael Espindolaccfe3cb2016-04-04 14:04:16 +0000814 // On MIPS O32 ABI, _gp_disp is a magic symbol designates offset between
Simon Atanasyand34a3632017-03-20 21:03:43 +0000815 // start of function and 'gp' pointer into GOT.
Simon Atanasyan6a4eb752016-12-08 06:19:47 +0000816 if (Symtab<ELFT>::X->find("_gp_disp"))
Rui Ueyama80474a22017-02-28 19:29:55 +0000817 ElfSym::MipsGpDisp =
Simon Atanasyan6a4eb752016-12-08 06:19:47 +0000818 Symtab<ELFT>::X->addAbsolute("_gp_disp", STV_HIDDEN, STB_LOCAL);
Peter Collingbourne6f535b72016-05-03 18:03:45 +0000819
Rafael Espindolaccfe3cb2016-04-04 14:04:16 +0000820 // The __gnu_local_gp is a magic symbol equal to the current value of 'gp'
821 // pointer. This symbol is used in the code generated by .cpload pseudo-op
822 // in case of using -mno-shared option.
823 // https://sourceware.org/ml/binutils/2004-12/msg00094.html
Simon Atanasyan6a4eb752016-12-08 06:19:47 +0000824 if (Symtab<ELFT>::X->find("__gnu_local_gp"))
Rui Ueyama80474a22017-02-28 19:29:55 +0000825 ElfSym::MipsLocalGp =
Simon Atanasyan6a4eb752016-12-08 06:19:47 +0000826 Symtab<ELFT>::X->addAbsolute("__gnu_local_gp", STV_HIDDEN, STB_LOCAL);
Rafael Espindolaccfe3cb2016-04-04 14:04:16 +0000827 }
828
Peter Smith113a59e2017-06-26 10:22:17 +0000829 // The _GLOBAL_OFFSET_TABLE_ symbol is defined by target convention to
830 // be at some offset from the base of the .got section, usually 0 or the end
831 // of the .got
Rui Ueyama92c37812017-06-26 15:11:24 +0000832 InputSection *GotSection = InX::MipsGot ? cast<InputSection>(InX::MipsGot)
833 : cast<InputSection>(InX::Got);
834 ElfSym::GlobalOffsetTable = addOptionalRegular<ELFT>(
835 "_GLOBAL_OFFSET_TABLE_", GotSection, Target->GotBaseSymOff);
Rafael Espindolaccfe3cb2016-04-04 14:04:16 +0000836
Rui Ueyamaf18fe7b2015-12-26 07:50:39 +0000837 // __tls_get_addr is defined by the dynamic linker for dynamic ELFs. For
838 // static linking the linker is required to optimize away any references to
839 // __tls_get_addr, so it's not defined anywhere. Create a hidden definition
Rui Ueyamaa2a46a92017-04-25 04:44:54 +0000840 // to avoid the undefined symbol error.
George Rimar69b17c32017-05-16 10:04:42 +0000841 if (!InX::DynSymTab)
Rui Ueyama84907c52016-08-09 03:38:23 +0000842 Symtab<ELFT>::X->addIgnored("__tls_get_addr");
Rui Ueyamaf18fe7b2015-12-26 07:50:39 +0000843
Petr Hosek6b936bf2017-05-10 16:20:33 +0000844 // __ehdr_start is the location of ELF file headers. Note that we define
845 // this symbol unconditionally even when using a linker script, which
846 // differs from the behavior implemented by GNU linker which only define
847 // this symbol if ELF headers are in the memory mapped segment.
Rafael Espindola0e454a92017-06-06 16:18:48 +0000848 // __executable_start is not documented, but the expectation of at
849 // least the android libc is that it points to the elf header too.
850 // __dso_handle symbol is passed to cxa_finalize as a marker to identify
851 // each DSO. The address of the symbol doesn't matter as long as they are
852 // different in different DSOs, so we chose the start address of the DSO.
853 for (const char *Name :
854 {"__ehdr_start", "__executable_start", "__dso_handle"})
855 addOptionalRegular<ELFT>(Name, Out::ElfHeader, 0, STV_HIDDEN);
Petr Hosek6b936bf2017-05-10 16:20:33 +0000856
George Rimar28ac19c2016-08-08 08:42:48 +0000857 // If linker script do layout we do not need to create any standart symbols.
Rui Ueyamaa34da932017-03-21 23:03:09 +0000858 if (Script->Opt.HasSections)
George Rimar28ac19c2016-08-08 08:42:48 +0000859 return;
860
Rui Ueyama1505ba82017-04-13 21:23:03 +0000861 auto Add = [](StringRef S) {
862 return addOptionalRegular<ELFT>(S, Out::ElfHeader, 0, STV_DEFAULT);
George Rimar9e859392016-02-26 14:36:36 +0000863 };
864
Rui Ueyama1505ba82017-04-13 21:23:03 +0000865 ElfSym::Bss = Add("__bss_start");
Rui Ueyama3e1fc3f2017-04-13 21:37:56 +0000866 ElfSym::End1 = Add("end");
867 ElfSym::End2 = Add("_end");
868 ElfSym::Etext1 = Add("etext");
869 ElfSym::Etext2 = Add("_etext");
870 ElfSym::Edata1 = Add("edata");
871 ElfSym::Edata2 = Add("_edata");
Rui Ueyamaf18fe7b2015-12-26 07:50:39 +0000872}
873
Rui Ueyamac4185702016-02-10 23:20:42 +0000874// Sort input sections by section name suffixes for
875// __attribute__((init_priority(N))).
Rui Ueyama6bd38222017-04-05 21:37:09 +0000876static void sortInitFini(OutputSection *S) {
Rui Ueyamac4185702016-02-10 23:20:42 +0000877 if (S)
Rafael Espindola24e6f362017-02-24 15:07:30 +0000878 reinterpret_cast<OutputSection *>(S)->sortInitFini();
Rui Ueyama5af83682016-02-11 23:41:38 +0000879}
880
881// Sort input sections by the special rule for .ctors and .dtors.
Rui Ueyama6bd38222017-04-05 21:37:09 +0000882static void sortCtorsDtors(OutputSection *S) {
Rui Ueyama5af83682016-02-11 23:41:38 +0000883 if (S)
Rafael Espindola24e6f362017-02-24 15:07:30 +0000884 reinterpret_cast<OutputSection *>(S)->sortCtorsDtors();
Rui Ueyamac4185702016-02-10 23:20:42 +0000885}
886
George Rimar1a33c0f2016-11-10 09:05:20 +0000887// Sort input sections using the list provided by --symbol-ordering-file.
888template <class ELFT>
Rafael Espindola24e6f362017-02-24 15:07:30 +0000889static void sortBySymbolsOrder(ArrayRef<OutputSection *> OutputSections) {
George Rimar1a33c0f2016-11-10 09:05:20 +0000890 if (Config->SymbolOrderingFile.empty())
891 return;
892
Rui Ueyama31270312016-12-20 01:51:08 +0000893 // Build a map from symbols to their priorities. Symbols that didn't
894 // appear in the symbol ordering file have the lowest priority 0.
895 // All explicitly mentioned symbols have negative (higher) priorities.
896 DenseMap<StringRef, int> SymbolOrder;
897 int Priority = -Config->SymbolOrderingFile.size();
898 for (StringRef S : Config->SymbolOrderingFile)
899 SymbolOrder.insert({S, Priority++});
900
901 // Build a map from sections to their priorities.
Rafael Espindola5616adf2017-03-08 22:36:28 +0000902 DenseMap<SectionBase *, int> SectionOrder;
George Rimar1a33c0f2016-11-10 09:05:20 +0000903 for (elf::ObjectFile<ELFT> *File : Symtab<ELFT>::X->getObjectFiles()) {
904 for (SymbolBody *Body : File->getSymbols()) {
Rui Ueyama80474a22017-02-28 19:29:55 +0000905 auto *D = dyn_cast<DefinedRegular>(Body);
George Rimar1a33c0f2016-11-10 09:05:20 +0000906 if (!D || !D->Section)
907 continue;
Rui Ueyama31270312016-12-20 01:51:08 +0000908 int &Priority = SectionOrder[D->Section];
909 Priority = std::min(Priority, SymbolOrder.lookup(D->getName()));
George Rimar1a33c0f2016-11-10 09:05:20 +0000910 }
911 }
912
Rui Ueyama31270312016-12-20 01:51:08 +0000913 // Sort sections by priority.
Rafael Espindola24e6f362017-02-24 15:07:30 +0000914 for (OutputSection *Base : OutputSections)
915 if (auto *Sec = dyn_cast<OutputSection>(Base))
Rafael Espindolac404d502017-02-23 02:32:18 +0000916 Sec->sort([&](InputSectionBase *S) { return SectionOrder.lookup(S); });
George Rimar1a33c0f2016-11-10 09:05:20 +0000917}
918
Eugene Leviante63d81b2016-07-20 14:43:20 +0000919template <class ELFT>
Rafael Espindolab4c9b812017-02-23 02:28:28 +0000920void Writer<ELFT>::forEachRelSec(std::function<void(InputSectionBase &)> Fn) {
Rui Ueyama536a2672017-02-27 02:32:08 +0000921 for (InputSectionBase *IS : InputSections) {
Rafael Espindola8f9026b2016-11-08 18:23:02 +0000922 if (!IS->Live)
Rui Ueyama8c6a5aa2016-11-05 22:37:59 +0000923 continue;
924 // Scan all relocations. Each relocation goes through a series
925 // of tests to determine if it needs special treatment, such as
926 // creating GOT, PLT, copy relocations, etc.
927 // Note that relocations for non-alloc sections are directly
928 // processed by InputSection::relocateNonAlloc.
929 if (!(IS->Flags & SHF_ALLOC))
930 continue;
Rafael Espindola5c02b742017-03-06 21:17:18 +0000931 if (isa<InputSection>(IS) || isa<EhInputSection>(IS))
Rafael Espindola9f0c4bb2016-11-10 14:53:24 +0000932 Fn(*IS);
Rafael Espindola0f7ceda2016-07-20 17:58:07 +0000933 }
Petr Hosek7b793212017-03-10 20:00:42 +0000934
935 if (!Config->Relocatable) {
936 for (EhInputSection *ES : In<ELFT>::EhFrame->Sections)
937 Fn(*ES);
938 }
Rafael Espindola0f7ceda2016-07-20 17:58:07 +0000939}
940
Eugene Leviant282251a2016-11-01 09:49:24 +0000941template <class ELFT> void Writer<ELFT>::createSections() {
Rui Ueyama536a2672017-02-27 02:32:08 +0000942 for (InputSectionBase *IS : InputSections)
Rafael Espindola82902742017-02-16 17:32:26 +0000943 if (IS)
George Rimare21c3af2017-03-14 09:30:25 +0000944 Factory.addInputSec(IS, getOutputSectionName(IS->Name));
Eugene Leviantceabe802016-08-11 07:56:43 +0000945
George Rimar1a33c0f2016-11-10 09:05:20 +0000946 sortBySymbolsOrder<ELFT>(OutputSections);
Rui Ueyama6bd38222017-04-05 21:37:09 +0000947 sortInitFini(findSection(".init_array"));
948 sortInitFini(findSection(".fini_array"));
949 sortCtorsDtors(findSection(".ctors"));
950 sortCtorsDtors(findSection(".dtors"));
Eugene Leviante63d81b2016-07-20 14:43:20 +0000951}
952
Rafael Espindola52101412017-05-12 14:52:22 +0000953// We want to find how similar two ranks are.
954// The more branches in getSectionRank that match, the more similar they are.
955// Since each branch corresponds to a bit flag, we can just use
956// countLeadingZeros.
Rafael Espindola383971d2017-06-15 21:51:01 +0000957static int getRankProximity(OutputSection *A, OutputSection *B) {
Rafael Espindola52101412017-05-12 14:52:22 +0000958 return countLeadingZeros(A->SortRank ^ B->SortRank);
Eugene Leviantbae1c652016-11-08 10:44:48 +0000959}
960
Rafael Espindola383971d2017-06-15 21:51:01 +0000961static int getRankProximity(OutputSection *A, BaseCommand *B) {
962 if (auto *Cmd = dyn_cast<OutputSectionCommand>(B))
963 if (Cmd->Sec)
964 return getRankProximity(A, Cmd->Sec);
965 return -1;
966}
967
968// When placing orphan sections, we want to place them after symbol assignments
969// so that an orphan after
970// begin_foo = .;
971// foo : { *(foo) }
972// end_foo = .;
973// doesn't break the intended meaning of the begin/end symbols.
974// We don't want to go over sections since findOrphanPos is the
975// one in charge of deciding the order of the sections.
976// We don't want to go over changes to '.', since doing so in
977// rx_sec : { *(rx_sec) }
978// . = ALIGN(0x1000);
979// /* The RW PT_LOAD starts here*/
980// rw_sec : { *(rw_sec) }
981// would mean that the RW PT_LOAD would become unaligned.
982static bool shouldSkip(BaseCommand *Cmd) {
983 if (isa<OutputSectionCommand>(Cmd))
984 return false;
985 if (auto *Assign = dyn_cast<SymbolAssignment>(Cmd))
986 return Assign->Name != ".";
987 return true;
988}
989
Rafael Espindola52101412017-05-12 14:52:22 +0000990// We want to place orphan sections so that they share as much
991// characteristics with their neighbors as possible. For example, if
992// both are rw, or both are tls.
Rafael Espindola0ca37122017-05-09 13:58:46 +0000993template <typename ELFT>
Rafael Espindola383971d2017-06-15 21:51:01 +0000994static std::vector<BaseCommand *>::iterator
995findOrphanPos(std::vector<BaseCommand *>::iterator B,
996 std::vector<BaseCommand *>::iterator E) {
997 OutputSection *Sec = cast<OutputSectionCommand>(*E)->Sec;
Rafael Espindola0ca37122017-05-09 13:58:46 +0000998
Rafael Espindola52101412017-05-12 14:52:22 +0000999 // Find the first element that has as close a rank as possible.
Rafael Espindola383971d2017-06-15 21:51:01 +00001000 auto I = std::max_element(B, E, [=](BaseCommand *A, BaseCommand *B) {
Rafael Espindola52101412017-05-12 14:52:22 +00001001 return getRankProximity(Sec, A) < getRankProximity(Sec, B);
1002 });
1003 if (I == E)
Rafael Espindola0ca37122017-05-09 13:58:46 +00001004 return E;
1005
Rafael Espindola52101412017-05-12 14:52:22 +00001006 // Consider all existing sections with the same proximity.
Rafael Espindola383971d2017-06-15 21:51:01 +00001007 int Proximity = getRankProximity(Sec, *I);
1008 for (; I != E; ++I) {
1009 auto *Cmd = dyn_cast<OutputSectionCommand>(*I);
1010 if (!Cmd || !Cmd->Sec)
1011 continue;
1012 if (getRankProximity(Sec, Cmd->Sec) != Proximity ||
1013 Sec->SortRank < Cmd->Sec->SortRank)
1014 break;
1015 }
1016 auto J = std::find_if(
Rafael Espindolac54b1c82017-06-15 22:03:06 +00001017 llvm::make_reverse_iterator(I), llvm::make_reverse_iterator(B),
Rafael Espindola383971d2017-06-15 21:51:01 +00001018 [](BaseCommand *Cmd) { return isa<OutputSectionCommand>(Cmd); });
1019 I = J.base();
1020 while (I != E && shouldSkip(*I))
Rafael Espindola52101412017-05-12 14:52:22 +00001021 ++I;
1022 return I;
Rafael Espindola0ca37122017-05-09 13:58:46 +00001023}
1024
Rafael Espindola24c073d2016-09-21 22:36:19 +00001025template <class ELFT> void Writer<ELFT>::sortSections() {
George Rimare0b43df2017-06-28 09:59:34 +00001026 if (Script->Opt.HasSections)
1027 Script->adjustSectionsBeforeSorting();
1028
Rafael Espindola1960bcd2016-11-11 22:43:27 +00001029 // Don't sort if using -r. It is not necessary and we want to preserve the
1030 // relative order for SHF_LINK_ORDER sections.
1031 if (Config->Relocatable)
Rafael Espindola85de6782017-06-28 22:44:11 +00001032 return;
Rafael Espindola52101412017-05-12 14:52:22 +00001033
Rafael Espindola383971d2017-06-15 21:51:01 +00001034 for (BaseCommand *Base : Script->Opt.Commands)
1035 if (auto *Cmd = dyn_cast<OutputSectionCommand>(Base))
1036 if (OutputSection *Sec = Cmd->Sec)
1037 Sec->SortRank = getSectionRank(Sec);
Rafael Espindola52101412017-05-12 14:52:22 +00001038
Rui Ueyamaa34da932017-03-21 23:03:09 +00001039 if (!Script->Opt.HasSections) {
Rafael Espindola383971d2017-06-15 21:51:01 +00001040 // We know that all the OutputSectionCommands are contiguous in
1041 // this case.
1042 auto E = Script->Opt.Commands.end();
1043 auto I = Script->Opt.Commands.begin();
1044 auto IsSection = [](BaseCommand *Base) {
1045 return isa<OutputSectionCommand>(Base);
1046 };
1047 I = std::find_if(I, E, IsSection);
Rafael Espindolac54b1c82017-06-15 22:03:06 +00001048 E = std::find_if(llvm::make_reverse_iterator(E),
1049 llvm::make_reverse_iterator(I), IsSection)
Rafael Espindola383971d2017-06-15 21:51:01 +00001050 .base();
1051 std::stable_sort(I, E, compareSections);
Rafael Espindola24c073d2016-09-21 22:36:19 +00001052 return;
1053 }
1054
Rafael Espindola383971d2017-06-15 21:51:01 +00001055 // Orphan sections are sections present in the input files which are
1056 // not explicitly placed into the output file by the linker script.
1057 //
1058 // The sections in the linker script are already in the correct
1059 // order. We have to figuere out where to insert the orphan
1060 // sections.
1061 //
Rafael Espindola24c073d2016-09-21 22:36:19 +00001062 // The order of the sections in the script is arbitrary and may not agree with
Rafael Espindola383971d2017-06-15 21:51:01 +00001063 // compareSections. This means that we cannot easily define a strict weak
1064 // ordering. To see why, consider a comparison of a section in the script and
1065 // one not in the script. We have a two simple options:
Rafael Espindola24c073d2016-09-21 22:36:19 +00001066 // * Make them equivalent (a is not less than b, and b is not less than a).
1067 // The problem is then that equivalence has to be transitive and we can
1068 // have sections a, b and c with only b in a script and a less than c
1069 // which breaks this property.
1070 // * Use compareSectionsNonScript. Given that the script order doesn't have
1071 // to match, we can end up with sections a, b, c, d where b and c are in the
1072 // script and c is compareSectionsNonScript less than b. In which case d
1073 // can be equivalent to c, a to b and d < a. As a concrete example:
1074 // .a (rx) # not in script
1075 // .b (rx) # in script
1076 // .c (ro) # in script
1077 // .d (ro) # not in script
1078 //
1079 // The way we define an order then is:
Rafael Espindola383971d2017-06-15 21:51:01 +00001080 // * Sort only the orphan sections. They are in the end right now.
1081 // * Move each orphan section to its preferred position. We try
Eugene Leviantbae1c652016-11-08 10:44:48 +00001082 // to put each section in the last position where it it can share
1083 // a PT_LOAD.
Rafael Espindola383971d2017-06-15 21:51:01 +00001084 //
1085 // There is some ambiguity as to where exactly a new entry should be
1086 // inserted, because Opt.Commands contains not only output section
1087 // commands but also other types of commands such as symbol assignment
1088 // expressions. There's no correct answer here due to the lack of the
1089 // formal specification of the linker script. We use heuristics to
1090 // determine whether a new output command should be added before or
1091 // after another commands. For the details, look at shouldSkip
1092 // function.
Rafael Espindola24c073d2016-09-21 22:36:19 +00001093
Rafael Espindola383971d2017-06-15 21:51:01 +00001094 auto I = Script->Opt.Commands.begin();
1095 auto E = Script->Opt.Commands.end();
1096 auto NonScriptI = std::find_if(I, E, [](BaseCommand *Base) {
1097 if (auto *Cmd = dyn_cast<OutputSectionCommand>(Base))
1098 return Cmd->Sec && Cmd->Sec->SectionIndex == INT_MAX;
1099 return false;
1100 });
Rafael Espindola24c073d2016-09-21 22:36:19 +00001101
Rafael Espindola383971d2017-06-15 21:51:01 +00001102 // Sort the orphan sections.
1103 std::stable_sort(NonScriptI, E, compareSections);
1104
1105 // As a horrible special case, skip the first . assignment if it is before any
1106 // section. We do this because it is common to set a load address by starting
1107 // the script with ". = 0xabcd" and the expectation is that every section is
1108 // after that.
1109 auto FirstSectionOrDotAssignment =
1110 std::find_if(I, E, [](BaseCommand *Cmd) { return !shouldSkip(Cmd); });
1111 if (FirstSectionOrDotAssignment != E &&
1112 isa<SymbolAssignment>(**FirstSectionOrDotAssignment))
1113 ++FirstSectionOrDotAssignment;
1114 I = FirstSectionOrDotAssignment;
1115
Rafael Espindola52101412017-05-12 14:52:22 +00001116 while (NonScriptI != E) {
1117 auto Pos = findOrphanPos<ELFT>(I, NonScriptI);
Rafael Espindola383971d2017-06-15 21:51:01 +00001118 OutputSection *Orphan = cast<OutputSectionCommand>(*NonScriptI)->Sec;
Rafael Espindola52101412017-05-12 14:52:22 +00001119
1120 // As an optimization, find all sections with the same sort rank
1121 // and insert them with one rotate.
Rafael Espindola383971d2017-06-15 21:51:01 +00001122 unsigned Rank = Orphan->SortRank;
1123 auto End = std::find_if(NonScriptI + 1, E, [=](BaseCommand *Cmd) {
1124 return cast<OutputSectionCommand>(Cmd)->Sec->SortRank != Rank;
Rafael Espindola52101412017-05-12 14:52:22 +00001125 });
1126 std::rotate(Pos, NonScriptI, End);
1127 NonScriptI = End;
1128 }
Rafael Espindolaf7a17442016-11-14 15:39:38 +00001129
George Rimara8dba482017-03-20 10:09:58 +00001130 Script->adjustSectionsAfterSorting();
Rafael Espindola24c073d2016-09-21 22:36:19 +00001131}
1132
Peter Smith1ec42d92017-03-08 14:06:24 +00001133static void applySynthetic(const std::vector<SyntheticSection *> &Sections,
1134 std::function<void(SyntheticSection *)> Fn) {
Rui Ueyama9320cb02017-02-27 02:56:02 +00001135 for (SyntheticSection *SS : Sections)
Rafael Espindolad57c58d2017-06-07 02:31:19 +00001136 if (SS && SS->getParent() && !SS->empty())
Peter Smith1ec42d92017-03-08 14:06:24 +00001137 Fn(SS);
Eugene Leviant6380ce22016-11-15 12:26:55 +00001138}
1139
George Rimar11992c862016-11-25 08:05:41 +00001140// We need to add input synthetic sections early in createSyntheticSections()
Rui Ueyamac38860b2016-12-05 21:39:35 +00001141// to make them visible from linkescript side. But not all sections are always
1142// required to be in output. For example we don't need dynamic section content
James Henderson7ee22752017-04-06 09:40:03 +00001143// sometimes. This function filters out such unused sections from the output.
Rafael Espindolac080ff62017-07-03 16:54:39 +00001144static void removeUnusedSyntheticSections() {
Rafael Espindola9e9754b2017-02-03 13:06:18 +00001145 // All input synthetic sections that can be empty are placed after
1146 // all regular ones. We iterate over them all and exit at first
1147 // non-synthetic.
Rui Ueyama536a2672017-02-27 02:32:08 +00001148 for (InputSectionBase *S : llvm::reverse(InputSections)) {
Rui Ueyama9320cb02017-02-27 02:56:02 +00001149 SyntheticSection *SS = dyn_cast<SyntheticSection>(S);
Rui Ueyamac38860b2016-12-05 21:39:35 +00001150 if (!SS)
George Rimar11992c862016-11-25 08:05:41 +00001151 return;
Rafael Espindoladb5e56f2017-05-31 20:17:44 +00001152 OutputSection *OS = SS->getParent();
1153 if (!SS->empty() || !OS)
George Rimar11992c862016-11-25 08:05:41 +00001154 continue;
Rui Ueyama92c37812017-06-26 15:11:24 +00001155 if ((SS == InX::Got || SS == InX::MipsGot) && ElfSym::GlobalOffsetTable)
Peter Smith113a59e2017-06-26 10:22:17 +00001156 continue;
Rafael Espindolac080ff62017-07-03 16:54:39 +00001157
1158 OutputSectionCommand *Cmd = Script->getCmd(OS);
Rafael Espindola43ee3602017-07-03 17:32:09 +00001159 std::vector<BaseCommand *>::iterator Empty = Cmd->Commands.end();
1160 for (auto I = Cmd->Commands.begin(), E = Cmd->Commands.end(); I != E; ++I) {
1161 BaseCommand *B = *I;
Rafael Espindolac080ff62017-07-03 16:54:39 +00001162 if (auto *ISD = dyn_cast<InputSectionDescription>(B)) {
Rafael Espindola43ee3602017-07-03 17:32:09 +00001163 auto P = std::find(ISD->Sections.begin(), ISD->Sections.end(), SS);
1164 if (P != ISD->Sections.end())
1165 ISD->Sections.erase(P);
Rafael Espindolac080ff62017-07-03 16:54:39 +00001166 if (ISD->Sections.empty())
Rafael Espindola43ee3602017-07-03 17:32:09 +00001167 Empty = I;
Rafael Espindolac080ff62017-07-03 16:54:39 +00001168 }
1169 }
Rafael Espindola43ee3602017-07-03 17:32:09 +00001170 if (Empty != Cmd->Commands.end())
1171 Cmd->Commands.erase(Empty);
Rafael Espindolac080ff62017-07-03 16:54:39 +00001172
James Henderson7ee22752017-04-06 09:40:03 +00001173 // If there are no other sections in the output section, remove it from the
1174 // output.
Rafael Espindolac080ff62017-07-03 16:54:39 +00001175 if (Cmd->Commands.empty()) {
Petr Hosek52db9a42017-07-03 15:49:25 +00001176 // Also remove script commands matching the output section.
1177 auto &Cmds = Script->Opt.Commands;
1178 auto I = std::remove_if(Cmds.begin(), Cmds.end(), [&](BaseCommand *Cmd) {
1179 if (auto *OSCmd = dyn_cast<OutputSectionCommand>(Cmd))
1180 return OSCmd->Sec == OS;
1181 return false;
1182 });
1183 Cmds.erase(I, Cmds.end());
1184 }
George Rimar11992c862016-11-25 08:05:41 +00001185 }
1186}
1187
Eugene Leviante63d81b2016-07-20 14:43:20 +00001188// Create output section objects and add them to OutputSections.
1189template <class ELFT> void Writer<ELFT>::finalizeSections() {
Rafael Espindolab6915452017-07-04 19:05:03 +00001190 Out::DebugInfo = findSectionInScript(".debug_info");
1191 Out::PreinitArray = findSectionInScript(".preinit_array");
1192 Out::InitArray = findSectionInScript(".init_array");
1193 Out::FiniArray = findSectionInScript(".fini_array");
Rafael Espindola77572242015-10-02 19:37:55 +00001194
Rui Ueyamaa5d79d12015-12-26 09:48:00 +00001195 // The linker needs to define SECNAME_start, SECNAME_end and SECNAME_stop
1196 // symbols for sections, so that the runtime can get the start and end
1197 // addresses of each section by section name. Add such symbols.
George Rimarc1034a82016-03-01 19:12:35 +00001198 if (!Config->Relocatable) {
1199 addStartEndSymbols();
Rafael Espindolab6915452017-07-04 19:05:03 +00001200 for (BaseCommand *Base : Script->Opt.Commands)
1201 if (auto *Cmd = dyn_cast<OutputSectionCommand>(Base))
1202 if (Cmd->Sec)
1203 addStartStopSymbols(Cmd->Sec);
George Rimarc1034a82016-03-01 19:12:35 +00001204 }
Rui Ueyamad4530c62016-03-04 18:34:14 +00001205
1206 // Add _DYNAMIC symbol. Unlike GNU gold, our _DYNAMIC symbol has no type.
1207 // It should be okay as no one seems to care about the type.
1208 // Even the author of gold doesn't remember why gold behaves that way.
1209 // https://sourceware.org/ml/binutils/2002-03/msg00360.html
George Rimar69b17c32017-05-16 10:04:42 +00001210 if (InX::DynSymTab)
Rafael Espindola5ab19892017-05-11 23:16:43 +00001211 addRegular<ELFT>("_DYNAMIC", InX::Dynamic, 0);
Rafael Espindola334c3e12015-10-19 15:21:42 +00001212
Rafael Espindolade9857e2016-02-04 21:33:05 +00001213 // Define __rel[a]_iplt_{start,end} symbols if needed.
1214 addRelIpltSymbols();
1215
Rafael Espindola66b4e212017-02-23 22:06:28 +00001216 // This responsible for splitting up .eh_frame section into
Peter Smith1ec42d92017-03-08 14:06:24 +00001217 // pieces. The relocation scan uses those pieces, so this has to be
Rafael Espindola66b4e212017-02-23 22:06:28 +00001218 // earlier.
George Rimar49a47f22017-03-16 10:29:44 +00001219 applySynthetic({In<ELFT>::EhFrame},
1220 [](SyntheticSection *SS) { SS->finalizeContents(); });
Rafael Espindola56004c52016-04-07 14:22:09 +00001221
Rafael Espindola0f7ceda2016-07-20 17:58:07 +00001222 // Scan relocations. This must be done after every symbol is declared so that
1223 // we can correctly decide if a dynamic relocation is needed.
1224 forEachRelSec(scanRelocations<ELFT>);
1225
Rafael Espindola895aea62017-05-11 22:02:41 +00001226 if (InX::Plt && !InX::Plt->empty())
1227 InX::Plt->addSymbols();
1228 if (InX::Iplt && !InX::Iplt->empty())
1229 InX::Iplt->addSymbols();
Peter Smith96943762017-01-25 10:31:16 +00001230
Peter Smith55865432017-02-20 11:12:33 +00001231 // Now that we have defined all possible global symbols including linker-
Rui Ueyama1b2a8bf2015-12-26 10:22:16 +00001232 // synthesized ones. Visit all symbols to give the finishing touches.
Rui Ueyama84907c52016-08-09 03:38:23 +00001233 for (Symbol *S : Symtab<ELFT>::X->getSymbols()) {
Peter Collingbourne4f952702016-05-01 04:55:03 +00001234 SymbolBody *Body = S->body();
Rafael Espindola0baa73f2016-04-26 13:56:26 +00001235
George Rimar7702bc22017-03-16 11:20:02 +00001236 if (!includeInSymtab(*Body))
Rafael Espindola05a3dd22015-09-22 23:38:23 +00001237 continue;
George Rimar69b17c32017-05-16 10:04:42 +00001238 if (InX::SymTab)
1239 InX::SymTab->addSymbol(Body);
Rafael Espindola05a3dd22015-09-22 23:38:23 +00001240
George Rimar69b17c32017-05-16 10:04:42 +00001241 if (InX::DynSymTab && S->includeInDynsym()) {
1242 InX::DynSymTab->addSymbol(Body);
Rui Ueyama4076fa12017-02-26 23:35:34 +00001243 if (auto *SS = dyn_cast<SharedSymbol>(Body))
1244 if (cast<SharedFile<ELFT>>(SS->File)->isNeeded())
Eugene Leviante9bab5d2016-11-21 16:59:33 +00001245 In<ELFT>::VerNeed->addSymbol(SS);
Peter Collingbourne21a12fc2016-04-27 20:22:31 +00001246 }
Rafael Espindola05a3dd22015-09-22 23:38:23 +00001247 }
Rui Ueyamac2a0d7e2016-01-28 22:56:29 +00001248
1249 // Do not proceed if there was an undefined symbol.
Rui Ueyamaf373dd72016-11-24 01:43:21 +00001250 if (ErrorCount)
Rui Ueyamaf7f52ef2016-04-01 17:24:19 +00001251 return;
Rui Ueyamac2a0d7e2016-01-28 22:56:29 +00001252
Rafael Espindola1eb3a0f2017-07-04 18:26:21 +00001253 addPredefinedSections();
Rafael Espindolac080ff62017-07-03 16:54:39 +00001254 removeUnusedSyntheticSections();
1255
Rafael Espindola24c073d2016-09-21 22:36:19 +00001256 sortSections();
Rafael Espindola383971d2017-06-15 21:51:01 +00001257
1258 // Now that we have the final list, create a list of all the
1259 // OutputSectionCommands for convenience.
Rafael Espindolacdf813b2017-06-13 22:36:20 +00001260 for (BaseCommand *Base : Script->Opt.Commands)
1261 if (auto *Cmd = dyn_cast<OutputSectionCommand>(Base))
1262 OutputSectionCommands.push_back(Cmd);
Rui Ueyama84417f82015-12-26 07:50:41 +00001263
Rafael Espindola9c0395e2017-06-20 01:51:50 +00001264 // Prefer command line supplied address over other constraints.
1265 for (OutputSectionCommand *Cmd : OutputSectionCommands) {
1266 auto I = Config->SectionStartMap.find(Cmd->Name);
1267 if (I != Config->SectionStartMap.end())
1268 Cmd->AddrExpr = [=] { return I->second; };
1269 }
1270
Rafael Espindola78493a22017-01-28 17:48:21 +00001271 // This is a bit of a hack. A value of 0 means undef, so we set it
1272 // to 1 t make __ehdr_start defined. The section number is not
1273 // particularly relevant.
Rui Ueyama9d1bacb12017-02-27 02:31:26 +00001274 Out::ElfHeader->SectionIndex = 1;
Rafael Espindola78493a22017-01-28 17:48:21 +00001275
George Rimar7ca06272016-04-06 07:20:45 +00001276 unsigned I = 1;
Rafael Espindolacdf813b2017-06-13 22:36:20 +00001277 for (OutputSectionCommand *Cmd : OutputSectionCommands) {
1278 OutputSection *Sec = Cmd->Sec;
George Rimar7ca06272016-04-06 07:20:45 +00001279 Sec->SectionIndex = I++;
Rafael Espindola895aea62017-05-11 22:02:41 +00001280 Sec->ShName = InX::ShStrTab->addString(Sec->Name);
George Rimar7ca06272016-04-06 07:20:45 +00001281 }
Rui Ueyama84417f82015-12-26 07:50:41 +00001282
Rafael Espindola5967c972016-12-19 21:21:07 +00001283 // Binary and relocatable output does not have PHDRS.
1284 // The headers have to be created before finalize as that can influence the
1285 // image base and the dynamic section on mips includes the image base.
1286 if (!Config->Relocatable && !Config->OFormatBinary) {
Rafael Espindolaf51c8052017-06-13 23:26:31 +00001287 Phdrs = Script->hasPhdrsCommands() ? Script->createPhdrs() : createPhdrs();
Rafael Espindola5967c972016-12-19 21:21:07 +00001288 addPtArmExid(Phdrs);
Rafael Espindola02ed7572017-05-04 19:34:17 +00001289 Out::ProgramHeaders->Size = sizeof(Elf_Phdr) * Phdrs.size();
Rafael Espindola5967c972016-12-19 21:21:07 +00001290 }
1291
Rafael Espindola72046202017-06-07 23:08:55 +00001292 // Compute the size of .rela.dyn and .rela.plt early since we need
1293 // them to populate .dynamic.
1294 for (SyntheticSection *SS : {In<ELFT>::RelaDyn, In<ELFT>::RelaPlt})
1295 if (SS->getParent() && !SS->empty())
1296 SS->getParent()->assignOffsets();
1297
Eugene Leviantbe809a72016-11-18 06:44:18 +00001298 // Dynamic section must be the last one in this list and dynamic
1299 // symbol table section (DynSymTab) must be the first one.
George Rimar69b17c32017-05-16 10:04:42 +00001300 applySynthetic({InX::DynSymTab, InX::Bss, InX::BssRelRo,
1301 InX::GnuHashTab, In<ELFT>::HashTab, InX::SymTab,
1302 InX::ShStrTab, InX::StrTab, In<ELFT>::VerDef,
1303 InX::DynStrTab, InX::GdbIndex, InX::Got,
1304 InX::MipsGot, InX::IgotPlt, InX::GotPlt,
1305 In<ELFT>::RelaDyn, In<ELFT>::RelaIplt, In<ELFT>::RelaPlt,
1306 InX::Plt, InX::Iplt, In<ELFT>::EhFrameHdr,
1307 In<ELFT>::VerSym, In<ELFT>::VerNeed, InX::Dynamic},
George Rimar49a47f22017-03-16 10:29:44 +00001308 [](SyntheticSection *SS) { SS->finalizeContents(); });
Peter Smith1ec42d92017-03-08 14:06:24 +00001309
1310 // Some architectures use small displacements for jump instructions.
1311 // It is linker's responsibility to create thunks containing long
1312 // jump instructions if jump targets are too far. Create thunks.
1313 if (Target->NeedsThunks) {
1314 // FIXME: only ARM Interworking and Mips LA25 Thunks are implemented,
1315 // these
1316 // do not require address information. To support range extension Thunks
1317 // we need to assign addresses so that we can tell if jump instructions
1318 // are out of range. This will need to turn into a loop that converges
1319 // when no more Thunks are added
George Rimarec84ffc2017-05-17 07:10:59 +00001320 ThunkCreator TC;
Peter Smith32980272017-06-16 13:10:08 +00001321 if (TC.createThunks(OutputSectionCommands)) {
Rafael Espindolab3aa2c92017-05-11 21:33:30 +00001322 applySynthetic({InX::MipsGot},
George Rimar49a47f22017-03-16 10:29:44 +00001323 [](SyntheticSection *SS) { SS->updateAllocSize(); });
Peter Smith32980272017-06-16 13:10:08 +00001324 if (TC.createThunks(OutputSectionCommands))
1325 fatal("All non-range thunks should be created in first call");
1326 }
Peter Smith1ec42d92017-03-08 14:06:24 +00001327 }
Peter Smith43e852f2017-06-05 08:51:15 +00001328
Peter Smith1ec42d92017-03-08 14:06:24 +00001329 // Fill other section headers. The dynamic table is finalized
1330 // at the end because some tags like RELSZ depend on result
1331 // of finalizing other sections.
Rafael Espindola13f412f2017-06-06 19:29:36 +00001332 for (OutputSectionCommand *Cmd : OutputSectionCommands)
Rafael Espindola8c284ac2017-06-06 19:40:01 +00001333 Cmd->finalize<ELFT>();
Peter Smith1ec42d92017-03-08 14:06:24 +00001334
1335 // createThunks may have added local symbols to the static symbol table
George Rimar69b17c32017-05-16 10:04:42 +00001336 applySynthetic({InX::SymTab, InX::ShStrTab, InX::StrTab},
George Rimar49a47f22017-03-16 10:29:44 +00001337 [](SyntheticSection *SS) { SS->postThunkContents(); });
Rui Ueyama84417f82015-12-26 07:50:41 +00001338}
1339
Rui Ueyama84417f82015-12-26 07:50:41 +00001340template <class ELFT> void Writer<ELFT>::addPredefinedSections() {
Rui Ueyamadec4ab02017-02-16 04:19:03 +00001341 // ARM ABI requires .ARM.exidx to be terminated by some piece of data.
1342 // We have the terminater synthetic section class. Add that at the end.
Rafael Espindola1eb3a0f2017-07-04 18:26:21 +00001343 OutputSectionCommand *Cmd = findSectionCommand(".ARM.exidx");
1344 if (!Cmd || Cmd->Commands.empty() || Config->Relocatable)
Peter Smith626c9972017-05-30 11:51:02 +00001345 return;
1346
1347 auto *Sentinel = make<ARMExidxSentinelSection>();
Rafael Espindola1eb3a0f2017-07-04 18:26:21 +00001348 Cmd->Sec->addSection(Sentinel);
1349 // Add the sentinel to the last of these too.
1350 auto ISD = std::find_if(Cmd->Commands.rbegin(), Cmd->Commands.rend(),
1351 [](const BaseCommand *Base) {
1352 return isa<InputSectionDescription>(Base);
1353 });
1354 cast<InputSectionDescription>(*ISD)->Sections.push_back(Sentinel);
Rafael Espindolaabad6182015-08-13 15:23:46 +00001355}
1356
Rui Ueyamaa5d79d12015-12-26 09:48:00 +00001357// The linker is expected to define SECNAME_start and SECNAME_end
1358// symbols for a few sections. This function defines them.
1359template <class ELFT> void Writer<ELFT>::addStartEndSymbols() {
Rafael Espindola24e6f362017-02-24 15:07:30 +00001360 auto Define = [&](StringRef Start, StringRef End, OutputSection *OS) {
Peter Collingbourne0fab40b2016-10-24 20:46:21 +00001361 // These symbols resolve to the image base if the section does not exist.
Rui Ueyama4f2f50d2016-12-21 08:40:09 +00001362 // A special value -1 indicates end of the section.
Peter Collingbournef8435a92017-03-13 16:40:20 +00001363 if (OS) {
1364 addOptionalRegular<ELFT>(Start, OS, 0);
1365 addOptionalRegular<ELFT>(End, OS, -1);
1366 } else {
Rui Ueyamad57e74b72017-03-17 23:29:01 +00001367 if (Config->Pic)
Peter Collingbournef8435a92017-03-13 16:40:20 +00001368 OS = Out::ElfHeader;
1369 addOptionalRegular<ELFT>(Start, OS, 0);
1370 addOptionalRegular<ELFT>(End, OS, 0);
1371 }
Rui Ueyamaa5d79d12015-12-26 09:48:00 +00001372 };
1373
Rui Ueyama9d1bacb12017-02-27 02:31:26 +00001374 Define("__preinit_array_start", "__preinit_array_end", Out::PreinitArray);
1375 Define("__init_array_start", "__init_array_end", Out::InitArray);
1376 Define("__fini_array_start", "__fini_array_end", Out::FiniArray);
Peter Smith17cd3752016-10-27 10:28:53 +00001377
Rafael Espindolab6915452017-07-04 19:05:03 +00001378 if (OutputSection *Sec = findSectionInScript(".ARM.exidx"))
Peter Smith17cd3752016-10-27 10:28:53 +00001379 Define("__exidx_start", "__exidx_end", Sec);
Rui Ueyamaa5d79d12015-12-26 09:48:00 +00001380}
1381
Rui Ueyamad9189ce2015-10-15 17:11:03 +00001382// If a section name is valid as a C identifier (which is rare because of
1383// the leading '.'), linkers are expected to define __start_<secname> and
1384// __stop_<secname> symbols. They are at beginning and end of the section,
1385// respectively. This is not requested by the ELF standard, but GNU ld and
1386// gold provide the feature, and used by many programs.
1387template <class ELFT>
Rafael Espindola24e6f362017-02-24 15:07:30 +00001388void Writer<ELFT>::addStartStopSymbols(OutputSection *Sec) {
Rafael Espindola40849412017-02-24 14:28:00 +00001389 StringRef S = Sec->Name;
Rui Ueyamad9189ce2015-10-15 17:11:03 +00001390 if (!isValidCIdentifier(S))
1391 return;
Rafael Espindola5616adf2017-03-08 22:36:28 +00001392 addOptionalRegular<ELFT>(Saver.save("__start_" + S), Sec, 0, STV_DEFAULT);
1393 addOptionalRegular<ELFT>(Saver.save("__stop_" + S), Sec, -1, STV_DEFAULT);
Rui Ueyamad9189ce2015-10-15 17:11:03 +00001394}
1395
Rafael Espindola55b169b2017-05-24 18:08:04 +00001396template <class ELFT>
Rafael Espindola43e76cd2017-05-26 17:48:27 +00001397OutputSectionCommand *Writer<ELFT>::findSectionCommand(StringRef Name) {
Rafael Espindola1eb3a0f2017-07-04 18:26:21 +00001398 for (BaseCommand *Base : Script->Opt.Commands)
1399 if (auto *Cmd = dyn_cast<OutputSectionCommand>(Base))
1400 if (Cmd->Name == Name)
1401 return Cmd;
Rafael Espindola55b169b2017-05-24 18:08:04 +00001402 return nullptr;
1403}
1404
Rafael Espindola43e76cd2017-05-26 17:48:27 +00001405template <class ELFT> OutputSection *Writer<ELFT>::findSectionInScript(StringRef Name) {
1406 if (OutputSectionCommand *Cmd = findSectionCommand(Name))
1407 return Cmd->Sec;
1408 return nullptr;
1409}
1410
Rafael Espindola24e6f362017-02-24 15:07:30 +00001411template <class ELFT> OutputSection *Writer<ELFT>::findSection(StringRef Name) {
1412 for (OutputSection *Sec : OutputSections)
Rafael Espindola40849412017-02-24 14:28:00 +00001413 if (Sec->Name == Name)
Rui Ueyama30634d92016-08-09 01:35:38 +00001414 return Sec;
1415 return nullptr;
1416}
1417
George Rimar7702bc22017-03-16 11:20:02 +00001418static bool needsPtLoad(OutputSection *Sec) {
Rafael Espindola04a2e342016-11-09 01:42:41 +00001419 if (!(Sec->Flags & SHF_ALLOC))
Rafael Espindolaef762f22016-02-10 23:29:38 +00001420 return false;
1421
1422 // Don't allocate VA space for TLS NOBITS sections. The PT_TLS PHDR is
1423 // responsible for allocating space for them, not the PT_LOAD that
1424 // contains the TLS initialization image.
Rafael Espindola04a2e342016-11-09 01:42:41 +00001425 if (Sec->Flags & SHF_TLS && Sec->Type == SHT_NOBITS)
Rafael Espindolaef762f22016-02-10 23:29:38 +00001426 return false;
1427 return true;
Michael J. Spencer1d299a82015-09-09 20:48:09 +00001428}
1429
Rafael Espindolab45fd702016-09-20 15:22:27 +00001430// Linker scripts are responsible for aligning addresses. Unfortunately, most
1431// linker scripts are designed for creating two PT_LOADs only, one RX and one
1432// RW. This means that there is no alignment in the RO to RX transition and we
1433// cannot create a PT_LOAD there.
Rui Ueyama6bd38222017-04-05 21:37:09 +00001434static uint64_t computeFlags(uint64_t Flags) {
Rui Ueyamaa37ace8d2017-02-25 01:52:03 +00001435 if (Config->Omagic)
George Rimar595a7632016-11-29 09:43:51 +00001436 return PF_R | PF_W | PF_X;
Rui Ueyama6bd38222017-04-05 21:37:09 +00001437 if (Config->SingleRoRx && !(Flags & PF_W))
1438 return Flags | PF_X;
1439 return Flags;
Rafael Espindolab45fd702016-09-20 15:22:27 +00001440}
1441
Rafael Espindola4fc60442016-02-10 22:43:13 +00001442// Decide which program headers to create and which sections to include in each
1443// one.
Rafael Espindola17cb7c02016-12-19 17:01:01 +00001444template <class ELFT> std::vector<PhdrEntry> Writer<ELFT>::createPhdrs() {
1445 std::vector<PhdrEntry> Ret;
1446 auto AddHdr = [&](unsigned Type, unsigned Flags) -> PhdrEntry * {
Rui Ueyama703296a2016-07-20 19:36:39 +00001447 Ret.emplace_back(Type, Flags);
1448 return &Ret.back();
Rafael Espindola4fc60442016-02-10 22:43:13 +00001449 };
George Rimare3336c02015-11-24 10:15:50 +00001450
Rui Ueyama803195e2015-10-23 21:45:59 +00001451 // The first phdr entry is PT_PHDR which describes the program header itself.
Rui Ueyama9d1bacb12017-02-27 02:31:26 +00001452 AddHdr(PT_PHDR, PF_R)->add(Out::ProgramHeaders);
Rui Ueyama953c2c42015-10-10 23:59:57 +00001453
Rui Ueyama803195e2015-10-23 21:45:59 +00001454 // PT_INTERP must be the second entry if exists.
Rafael Espindola7ff93292017-06-10 22:12:32 +00001455 if (OutputSection *Sec = findSectionInScript(".interp"))
Rui Ueyamadb00b612017-02-01 22:42:17 +00001456 AddHdr(PT_INTERP, Sec->getPhdrFlags())->add(Sec);
Rafael Espindola70107762015-09-11 18:49:42 +00001457
Rui Ueyama803195e2015-10-23 21:45:59 +00001458 // Add the first PT_LOAD segment for regular output sections.
Rui Ueyama6bd38222017-04-05 21:37:09 +00001459 uint64_t Flags = computeFlags(PF_R);
Rafael Espindola17cb7c02016-12-19 17:01:01 +00001460 PhdrEntry *Load = AddHdr(PT_LOAD, Flags);
Rafael Espindola02ed7572017-05-04 19:34:17 +00001461
1462 // Add the headers. We will remove them if they don't fit.
1463 Load->add(Out::ElfHeader);
1464 Load->add(Out::ProgramHeaders);
1465
Rafael Espindola7ff93292017-06-10 22:12:32 +00001466 for (OutputSectionCommand *Cmd : OutputSectionCommands) {
1467 OutputSection *Sec = Cmd->Sec;
Rafael Espindola04a2e342016-11-09 01:42:41 +00001468 if (!(Sec->Flags & SHF_ALLOC))
Rafael Espindolaaab6d5c2016-09-16 21:29:07 +00001469 break;
George Rimar7702bc22017-03-16 11:20:02 +00001470 if (!needsPtLoad(Sec))
Rafael Espindolaef762f22016-02-10 23:29:38 +00001471 continue;
1472
George Rimar8ceadb32016-08-17 07:44:19 +00001473 // Segments are contiguous memory regions that has the same attributes
1474 // (e.g. executable or writable). There is one phdr for each segment.
1475 // Therefore, we need to create a new phdr when the next section has
1476 // different flags or is loaded at a discontiguous address using AT linker
1477 // script command.
Rui Ueyama6bd38222017-04-05 21:37:09 +00001478 uint64_t NewFlags = computeFlags(Sec->getPhdrFlags());
Rafael Espindoladc1ed122017-05-10 14:12:02 +00001479 if (Script->hasLMA(Sec) || Flags != NewFlags) {
Rafael Espindolae090fb22016-03-09 21:37:22 +00001480 Load = AddHdr(PT_LOAD, NewFlags);
Rafael Espindola4fc60442016-02-10 22:43:13 +00001481 Flags = NewFlags;
1482 }
Michael J. Spencer78aa1de2015-11-03 00:34:39 +00001483
Rui Ueyama18f084f2016-07-20 19:36:41 +00001484 Load->add(Sec);
Michael J. Spencer84487f12015-07-24 21:03:07 +00001485 }
Rafael Espindola6b83b902015-08-12 00:00:24 +00001486
Rui Ueyamadb00b612017-02-01 22:42:17 +00001487 // Add a TLS segment if any.
1488 PhdrEntry TlsHdr(PT_TLS, PF_R);
Rafael Espindola7ff93292017-06-10 22:12:32 +00001489 for (OutputSectionCommand *Cmd : OutputSectionCommands) {
1490 OutputSection *Sec = Cmd->Sec;
Rui Ueyamadb00b612017-02-01 22:42:17 +00001491 if (Sec->Flags & SHF_TLS)
1492 TlsHdr.add(Sec);
Rafael Espindola7ff93292017-06-10 22:12:32 +00001493 }
Rafael Espindola4fc60442016-02-10 22:43:13 +00001494 if (TlsHdr.First)
Rui Ueyama703296a2016-07-20 19:36:39 +00001495 Ret.push_back(std::move(TlsHdr));
Michael J. Spencer78aa1de2015-11-03 00:34:39 +00001496
Rui Ueyama803195e2015-10-23 21:45:59 +00001497 // Add an entry for .dynamic.
George Rimar69b17c32017-05-16 10:04:42 +00001498 if (InX::DynSymTab)
Rafael Espindoladb5e56f2017-05-31 20:17:44 +00001499 AddHdr(PT_DYNAMIC, InX::Dynamic->getParent()->getPhdrFlags())
1500 ->add(InX::Dynamic->getParent());
Rafael Espindola91009b32015-08-12 01:45:28 +00001501
Rafael Espindola4fc60442016-02-10 22:43:13 +00001502 // PT_GNU_RELRO includes all sections that should be marked as
1503 // read-only by dynamic linker after proccessing relocations.
Rui Ueyamadb00b612017-02-01 22:42:17 +00001504 PhdrEntry RelRo(PT_GNU_RELRO, PF_R);
Rafael Espindola7ff93292017-06-10 22:12:32 +00001505 for (OutputSectionCommand *Cmd : OutputSectionCommands) {
1506 OutputSection *Sec = Cmd->Sec;
Rafael Espindola9e889eb2017-05-11 23:31:06 +00001507 if (needsPtLoad(Sec) && isRelroSection(Sec))
Rui Ueyamadb00b612017-02-01 22:42:17 +00001508 RelRo.add(Sec);
Rafael Espindola7ff93292017-06-10 22:12:32 +00001509 }
Rafael Espindola4fc60442016-02-10 22:43:13 +00001510 if (RelRo.First)
Rui Ueyama703296a2016-07-20 19:36:39 +00001511 Ret.push_back(std::move(RelRo));
George Rimare3336c02015-11-24 10:15:50 +00001512
Rafael Espindola4fc60442016-02-10 22:43:13 +00001513 // PT_GNU_EH_FRAME is a special section pointing on .eh_frame_hdr.
Eugene Leviant30c1b432017-03-14 08:49:09 +00001514 if (!In<ELFT>::EhFrame->empty() && In<ELFT>::EhFrameHdr &&
Rafael Espindoladb5e56f2017-05-31 20:17:44 +00001515 In<ELFT>::EhFrame->getParent() && In<ELFT>::EhFrameHdr->getParent())
1516 AddHdr(PT_GNU_EH_FRAME, In<ELFT>::EhFrameHdr->getParent()->getPhdrFlags())
1517 ->add(In<ELFT>::EhFrameHdr->getParent());
George Rimarf6bc65a2016-01-15 13:34:52 +00001518
Rui Ueyama81cb7102017-03-24 00:15:57 +00001519 // PT_OPENBSD_RANDOMIZE is an OpenBSD-specific feature. That makes
1520 // the dynamic linker fill the segment with random data.
Rafael Espindola7ff93292017-06-10 22:12:32 +00001521 if (OutputSection *Sec = findSectionInScript(".openbsd.randomdata"))
Rui Ueyamadb00b612017-02-01 22:42:17 +00001522 AddHdr(PT_OPENBSD_RANDOMIZE, Sec->getPhdrFlags())->add(Sec);
George Rimar270173f2016-10-14 13:02:22 +00001523
Rui Ueyamae79b09a2015-11-21 22:19:32 +00001524 // PT_GNU_STACK is a special section to tell the loader to make the
Rui Ueyamaa7e87252017-02-23 08:09:51 +00001525 // pages for the stack non-executable. If you really want an executable
1526 // stack, you can pass -z execstack, but that's not recommended for
1527 // security reasons.
1528 unsigned Perm;
1529 if (Config->ZExecstack)
1530 Perm = PF_R | PF_W | PF_X;
1531 else
1532 Perm = PF_R | PF_W;
1533 AddHdr(PT_GNU_STACK, Perm)->p_memsz = Config->ZStackSize;
Rafael Espindola9907eb02016-03-01 13:23:29 +00001534
George Rimarcc6e5672016-10-14 10:34:36 +00001535 // PT_OPENBSD_WXNEEDED is a OpenBSD-specific header to mark the executable
1536 // is expected to perform W^X violations, such as calling mprotect(2) or
1537 // mmap(2) with PROT_WRITE | PROT_EXEC, which is prohibited by default on
1538 // OpenBSD.
1539 if (Config->ZWxneeded)
1540 AddHdr(PT_OPENBSD_WXNEEDED, PF_X);
1541
Petr Hosek4d65ef3b2017-02-01 20:58:41 +00001542 // Create one PT_NOTE per a group of contiguous .note sections.
1543 PhdrEntry *Note = nullptr;
Rafael Espindola7ff93292017-06-10 22:12:32 +00001544 for (OutputSectionCommand *Cmd : OutputSectionCommands) {
1545 OutputSection *Sec = Cmd->Sec;
Petr Hosek4d65ef3b2017-02-01 20:58:41 +00001546 if (Sec->Type == SHT_NOTE) {
Rafael Espindoladc1ed122017-05-10 14:12:02 +00001547 if (!Note || Script->hasLMA(Sec))
Petr Hosek4d65ef3b2017-02-01 20:58:41 +00001548 Note = AddHdr(PT_NOTE, PF_R);
1549 Note->add(Sec);
1550 } else {
1551 Note = nullptr;
1552 }
1553 }
Rui Ueyama703296a2016-07-20 19:36:39 +00001554 return Ret;
Rafael Espindola4fc60442016-02-10 22:43:13 +00001555}
1556
Rafael Espindola8e670002016-11-28 00:40:21 +00001557template <class ELFT>
Rafael Espindola17cb7c02016-12-19 17:01:01 +00001558void Writer<ELFT>::addPtArmExid(std::vector<PhdrEntry> &Phdrs) {
Rafael Espindola8e670002016-11-28 00:40:21 +00001559 if (Config->EMachine != EM_ARM)
1560 return;
George Rimara951d5c2017-07-04 13:10:37 +00001561 auto I = llvm::find_if(OutputSectionCommands, [](OutputSectionCommand *Cmd) {
1562 return Cmd->Sec->Type == SHT_ARM_EXIDX;
1563 });
Rafael Espindola7ff93292017-06-10 22:12:32 +00001564 if (I == OutputSectionCommands.end())
Rafael Espindola8e670002016-11-28 00:40:21 +00001565 return;
1566
1567 // PT_ARM_EXIDX is the ARM EHABI equivalent of PT_GNU_EH_FRAME
Rafael Espindola17cb7c02016-12-19 17:01:01 +00001568 PhdrEntry ARMExidx(PT_ARM_EXIDX, PF_R);
Rafael Espindola7ff93292017-06-10 22:12:32 +00001569 ARMExidx.add((*I)->Sec);
Rafael Espindola8e670002016-11-28 00:40:21 +00001570 Phdrs.push_back(ARMExidx);
1571}
1572
Peter Collingbourne628ec9f2017-01-10 01:21:30 +00001573// The first section of each PT_LOAD, the first section in PT_GNU_RELRO and the
1574// first section after PT_GNU_RELRO have to be page aligned so that the dynamic
1575// linker can set the permissions.
Rui Ueyama47091902016-03-30 19:41:51 +00001576template <class ELFT> void Writer<ELFT>::fixSectionAlignments() {
Rafael Espindola0f7dc0e2017-06-02 01:37:58 +00001577 auto PageAlign = [](OutputSection *Sec) {
1578 OutputSectionCommand *Cmd = Script->getCmd(Sec);
1579 if (Cmd && !Cmd->AddrExpr)
1580 Cmd->AddrExpr = [=] {
1581 return alignTo(Script->getDot(), Config->MaxPageSize);
1582 };
1583 };
1584
Rafael Espindola17cb7c02016-12-19 17:01:01 +00001585 for (const PhdrEntry &P : Phdrs)
Rafael Espindola5967c972016-12-19 21:21:07 +00001586 if (P.p_type == PT_LOAD && P.First)
Rafael Espindola0f7dc0e2017-06-02 01:37:58 +00001587 PageAlign(P.First);
Rui Ueyama47091902016-03-30 19:41:51 +00001588
Rafael Espindola17cb7c02016-12-19 17:01:01 +00001589 for (const PhdrEntry &P : Phdrs) {
1590 if (P.p_type != PT_GNU_RELRO)
Rui Ueyama47091902016-03-30 19:41:51 +00001591 continue;
Peter Collingbourne628ec9f2017-01-10 01:21:30 +00001592 if (P.First)
Rafael Espindola0f7dc0e2017-06-02 01:37:58 +00001593 PageAlign(P.First);
Rui Ueyama47091902016-03-30 19:41:51 +00001594 // Find the first section after PT_GNU_RELRO. If it is in a PT_LOAD we
1595 // have to align it to a page.
Rafael Espindolac7c42f62017-06-03 06:51:22 +00001596 auto End = OutputSectionCommands.end();
1597 auto I =
1598 std::find(OutputSectionCommands.begin(), End, Script->getCmd(P.Last));
Rui Ueyama47091902016-03-30 19:41:51 +00001599 if (I == End || (I + 1) == End)
1600 continue;
Rafael Espindolac7c42f62017-06-03 06:51:22 +00001601 OutputSection *Sec = (*(I + 1))->Sec;
George Rimar7702bc22017-03-16 11:20:02 +00001602 if (needsPtLoad(Sec))
Rafael Espindola0f7dc0e2017-06-02 01:37:58 +00001603 PageAlign(Sec);
Rui Ueyama47091902016-03-30 19:41:51 +00001604 }
1605}
1606
George Rimar5f857322016-04-27 09:16:28 +00001607// Adjusts the file alignment for a given output section and returns
1608// its new file offset. The file offset must be the same with its
1609// virtual address (modulo the page size) so that the loader can load
1610// executables without any address adjustment.
Rui Ueyama6bd38222017-04-05 21:37:09 +00001611static uint64_t getFileAlignment(uint64_t Off, OutputSection *Sec) {
Rafael Espindola24e6f362017-02-24 15:07:30 +00001612 OutputSection *First = Sec->FirstInPtLoad;
Rafael Espindola8b8f74f2016-12-07 20:20:39 +00001613 // If the section is not in a PT_LOAD, we just have to align it.
Rafael Espindolac94678b2016-09-29 16:29:55 +00001614 if (!First)
Rafael Espindola37707632017-03-07 14:55:52 +00001615 return alignTo(Off, Sec->Alignment);
Eugene Leviant3d9abec2016-09-29 09:20:33 +00001616
Rafael Espindola8b8f74f2016-12-07 20:20:39 +00001617 // The first section in a PT_LOAD has to have congruent offset and address
1618 // module the page size.
Rafael Espindolac94678b2016-09-29 16:29:55 +00001619 if (Sec == First)
Rafael Espindolaa86a9c62016-12-07 20:10:43 +00001620 return alignTo(Off, Config->MaxPageSize, Sec->Addr);
Rafael Espindola8b8f74f2016-12-07 20:20:39 +00001621
1622 // If two sections share the same PT_LOAD the file offset is calculated
1623 // using this formula: Off2 = Off1 + (VA2 - VA1).
Rafael Espindola04a2e342016-11-09 01:42:41 +00001624 return First->Offset + Sec->Addr - First->Addr;
George Rimar5f857322016-04-27 09:16:28 +00001625}
1626
Rui Ueyama6bd38222017-04-05 21:37:09 +00001627static uint64_t setOffset(OutputSection *Sec, uint64_t Off) {
Rafael Espindola04a2e342016-11-09 01:42:41 +00001628 if (Sec->Type == SHT_NOBITS) {
1629 Sec->Offset = Off;
Rui Ueyama35723f02017-02-14 23:35:42 +00001630 return Off;
George Rimar86ce2672016-08-25 09:05:47 +00001631 }
1632
Rui Ueyama6bd38222017-04-05 21:37:09 +00001633 Off = getFileAlignment(Off, Sec);
Rafael Espindola04a2e342016-11-09 01:42:41 +00001634 Sec->Offset = Off;
Rui Ueyama35723f02017-02-14 23:35:42 +00001635 return Off + Sec->Size;
George Rimar86ce2672016-08-25 09:05:47 +00001636}
1637
1638template <class ELFT> void Writer<ELFT>::assignFileOffsetsBinary() {
Rui Ueyama6bd38222017-04-05 21:37:09 +00001639 uint64_t Off = 0;
Rafael Espindola8a0966e2017-06-01 16:21:33 +00001640 for (OutputSectionCommand *Cmd : OutputSectionCommands) {
1641 OutputSection *Sec = Cmd->Sec;
Rafael Espindola04a2e342016-11-09 01:42:41 +00001642 if (Sec->Flags & SHF_ALLOC)
Rui Ueyama6bd38222017-04-05 21:37:09 +00001643 Off = setOffset(Sec, Off);
Rafael Espindola8a0966e2017-06-01 16:21:33 +00001644 }
Rui Ueyama6bd38222017-04-05 21:37:09 +00001645 FileSize = alignTo(Off, Config->Wordsize);
George Rimar86ce2672016-08-25 09:05:47 +00001646}
1647
Rui Ueyamae044e9c2016-04-01 17:07:17 +00001648// Assign file offsets to output sections.
1649template <class ELFT> void Writer<ELFT>::assignFileOffsets() {
Rui Ueyama6bd38222017-04-05 21:37:09 +00001650 uint64_t Off = 0;
1651 Off = setOffset(Out::ElfHeader, Off);
1652 Off = setOffset(Out::ProgramHeaders, Off);
George Rimar7ca06272016-04-06 07:20:45 +00001653
Rafael Espindola8a0966e2017-06-01 16:21:33 +00001654 for (OutputSectionCommand *Cmd : OutputSectionCommands)
1655 Off = setOffset(Cmd->Sec, Off);
Eugene Leviant467c4d52016-07-01 10:27:36 +00001656
Rui Ueyama6bd38222017-04-05 21:37:09 +00001657 SectionHeaderOff = alignTo(Off, Config->Wordsize);
Rafael Espindola8a0966e2017-06-01 16:21:33 +00001658 FileSize =
1659 SectionHeaderOff + (OutputSectionCommands.size() + 1) * sizeof(Elf_Shdr);
Rui Ueyamae044e9c2016-04-01 17:07:17 +00001660}
1661
1662// Finalize the program headers. We call this function after we assign
1663// file offsets and VAs to all sections.
1664template <class ELFT> void Writer<ELFT>::setPhdrs() {
Rafael Espindola17cb7c02016-12-19 17:01:01 +00001665 for (PhdrEntry &P : Phdrs) {
Rafael Espindola24e6f362017-02-24 15:07:30 +00001666 OutputSection *First = P.First;
1667 OutputSection *Last = P.Last;
Rui Ueyamae8a45e42016-04-01 22:42:04 +00001668 if (First) {
Rafael Espindola17cb7c02016-12-19 17:01:01 +00001669 P.p_filesz = Last->Offset - First->Offset;
Rafael Espindola04a2e342016-11-09 01:42:41 +00001670 if (Last->Type != SHT_NOBITS)
Rafael Espindola17cb7c02016-12-19 17:01:01 +00001671 P.p_filesz += Last->Size;
1672 P.p_memsz = Last->Addr + Last->Size - First->Addr;
1673 P.p_offset = First->Offset;
1674 P.p_vaddr = First->Addr;
Eugene Leviantb71d6f72016-10-06 09:39:28 +00001675 if (!P.HasLMA)
Rafael Espindola17cb7c02016-12-19 17:01:01 +00001676 P.p_paddr = First->getLMA();
Rafael Espindola4fc60442016-02-10 22:43:13 +00001677 }
Rafael Espindola17cb7c02016-12-19 17:01:01 +00001678 if (P.p_type == PT_LOAD)
1679 P.p_align = Config->MaxPageSize;
Peter Collingbourne7b5088b2017-01-04 18:56:15 +00001680 else if (P.p_type == PT_GNU_RELRO) {
Rafael Espindola17cb7c02016-12-19 17:01:01 +00001681 P.p_align = 1;
Peter Collingbourne7b5088b2017-01-04 18:56:15 +00001682 // The glibc dynamic loader rounds the size down, so we need to round up
1683 // to protect the last page. This is a no-op on FreeBSD which always
1684 // rounds up.
Peter Collingbourne4a72c382017-01-30 18:20:07 +00001685 P.p_memsz = alignTo(P.p_memsz, Target->PageSize);
Peter Collingbourne7b5088b2017-01-04 18:56:15 +00001686 }
George Rimar8ceadb32016-08-17 07:44:19 +00001687
Rafael Espindola4fc60442016-02-10 22:43:13 +00001688 // The TLS pointer goes after PT_TLS. At least glibc will align it,
1689 // so round up the size to make sure the offsets are correct.
Rafael Espindola17cb7c02016-12-19 17:01:01 +00001690 if (P.p_type == PT_TLS) {
Rui Ueyama9d1bacb12017-02-27 02:31:26 +00001691 Out::TlsPhdr = &P;
Rafael Espindola17cb7c02016-12-19 17:01:01 +00001692 if (P.p_memsz)
1693 P.p_memsz = alignTo(P.p_memsz, P.p_align);
Rui Ueyama803195e2015-10-23 21:45:59 +00001694 }
1695 }
Michael J. Spencer84487f12015-07-24 21:03:07 +00001696}
1697
Rui Ueyama2eda6d12016-11-23 22:41:00 +00001698// The entry point address is chosen in the following ways.
1699//
1700// 1. the '-e' entry command-line option;
1701// 2. the ENTRY(symbol) command in a linker control script;
1702// 3. the value of the symbol start, if present;
1703// 4. the address of the first byte of the .text section, if present;
1704// 5. the address 0.
Rui Ueyama6bd38222017-04-05 21:37:09 +00001705template <class ELFT> uint64_t Writer<ELFT>::getEntryAddr() {
Rui Ueyamaa1407c42016-12-07 03:23:06 +00001706 // Case 1, 2 or 3. As a special case, if the symbol is actually
1707 // a number, we'll use that number as an address.
Rui Ueyama8da7aa02016-10-20 00:07:36 +00001708 if (SymbolBody *B = Symtab<ELFT>::X->find(Config->Entry))
George Rimarf64618a2017-03-17 11:56:54 +00001709 return B->getVA();
Rui Ueyamaa1407c42016-12-07 03:23:06 +00001710 uint64_t Addr;
George Rimarab947682017-05-16 08:19:25 +00001711 if (to_integer(Config->Entry, Addr))
Rui Ueyamaa1407c42016-12-07 03:23:06 +00001712 return Addr;
Rui Ueyama2eda6d12016-11-23 22:41:00 +00001713
1714 // Case 4
Rafael Espindola43e76cd2017-05-26 17:48:27 +00001715 if (OutputSection *Sec = findSectionInScript(".text")) {
Rui Ueyama9e5f5ef2016-12-07 04:06:21 +00001716 if (Config->WarnMissingEntry)
Petr Hosek2f50fef2016-12-07 02:26:16 +00001717 warn("cannot find entry symbol " + Config->Entry + "; defaulting to 0x" +
1718 utohexstr(Sec->Addr));
Rui Ueyama2eda6d12016-11-23 22:41:00 +00001719 return Sec->Addr;
1720 }
1721
1722 // Case 5
Rui Ueyama9e5f5ef2016-12-07 04:06:21 +00001723 if (Config->WarnMissingEntry)
Petr Hosek2f50fef2016-12-07 02:26:16 +00001724 warn("cannot find entry symbol " + Config->Entry +
1725 "; not setting start address");
Rui Ueyama8da7aa02016-10-20 00:07:36 +00001726 return 0;
Rui Ueyama3bfaba92015-12-24 08:37:34 +00001727}
1728
Rui Ueyama4cea4e82016-02-25 19:28:37 +00001729static uint16_t getELFType() {
Rui Ueyamad57e74b72017-03-17 23:29:01 +00001730 if (Config->Pic)
Rui Ueyama4cea4e82016-02-25 19:28:37 +00001731 return ET_DYN;
1732 if (Config->Relocatable)
1733 return ET_REL;
1734 return ET_EXEC;
1735}
1736
Rui Ueyama1a311f12015-12-26 10:52:26 +00001737// This function is called after we have assigned address and size
Rafael Espindola78493a22017-01-28 17:48:21 +00001738// to each section. This function fixes some predefined
Rui Ueyama1a311f12015-12-26 10:52:26 +00001739// symbol values that depend on section address and size.
Rafael Espindola78493a22017-01-28 17:48:21 +00001740template <class ELFT> void Writer<ELFT>::fixPredefinedSymbols() {
George Rimar2abc5872016-03-01 19:18:07 +00001741 // _etext is the first location after the last read-only loadable segment.
1742 // _edata is the first location after the last read-write loadable segment.
George Rimarefded312016-04-01 10:23:32 +00001743 // _end is the first location after the uninitialized data region.
Rafael Espindola78493a22017-01-28 17:48:21 +00001744 PhdrEntry *Last = nullptr;
1745 PhdrEntry *LastRO = nullptr;
1746 PhdrEntry *LastRW = nullptr;
Rafael Espindola17cb7c02016-12-19 17:01:01 +00001747 for (PhdrEntry &P : Phdrs) {
1748 if (P.p_type != PT_LOAD)
George Rimar9e859392016-02-26 14:36:36 +00001749 continue;
Rafael Espindola78493a22017-01-28 17:48:21 +00001750 Last = &P;
Rafael Espindola17cb7c02016-12-19 17:01:01 +00001751 if (P.p_flags & PF_W)
Rafael Espindola78493a22017-01-28 17:48:21 +00001752 LastRW = &P;
George Rimar8bbff7e2016-04-14 14:37:59 +00001753 else
Rafael Espindola78493a22017-01-28 17:48:21 +00001754 LastRO = &P;
George Rimar9e859392016-02-26 14:36:36 +00001755 }
Rui Ueyamae962e372017-05-26 02:27:19 +00001756
1757 auto Set = [](DefinedRegular *S, OutputSection *Sec, uint64_t Value) {
1758 if (S) {
1759 S->Section = Sec;
1760 S->Value = Value;
1761 }
1762 };
1763
1764 if (Last) {
1765 Set(ElfSym::End1, Last->First, Last->p_memsz);
1766 Set(ElfSym::End2, Last->First, Last->p_memsz);
1767 }
1768 if (LastRO) {
1769 Set(ElfSym::Etext1, LastRO->First, LastRO->p_filesz);
1770 Set(ElfSym::Etext2, LastRO->First, LastRO->p_filesz);
1771 }
1772 if (LastRW) {
1773 Set(ElfSym::Edata1, LastRW->First, LastRW->p_filesz);
1774 Set(ElfSym::Edata2, LastRW->First, LastRW->p_filesz);
1775 }
Simon Atanasyan8469b882016-11-23 22:22:16 +00001776
George Rimare6c5d382017-04-05 10:03:25 +00001777 if (ElfSym::Bss)
Rafael Espindola43e76cd2017-05-26 17:48:27 +00001778 ElfSym::Bss->Section = findSectionInScript(".bss");
George Rimare6c5d382017-04-05 10:03:25 +00001779
Simon Atanasyan8469b882016-11-23 22:22:16 +00001780 // Setup MIPS _gp_disp/__gnu_local_gp symbols which should
1781 // be equal to the _gp symbol's value.
Rafael Espindolacccd2c62017-05-31 22:46:19 +00001782 if (Config->EMachine == EM_MIPS && !ElfSym::MipsGp->Value) {
1783 // Find GP-relative section with the lowest address
1784 // and use this address to calculate default _gp value.
Rafael Espindola8a0966e2017-06-01 16:21:33 +00001785 for (const OutputSectionCommand *Cmd : OutputSectionCommands) {
1786 OutputSection *OS = Cmd->Sec;
Rafael Espindola47c9f842017-05-31 22:49:50 +00001787 if (OS->Flags & SHF_MIPS_GPREL) {
1788 ElfSym::MipsGp->Value = OS->Addr + 0x7ff0;
1789 break;
1790 }
1791 }
Simon Atanasyan8469b882016-11-23 22:22:16 +00001792 }
Rui Ueyama1a311f12015-12-26 10:52:26 +00001793}
1794
Michael J. Spencer84487f12015-07-24 21:03:07 +00001795template <class ELFT> void Writer<ELFT>::writeHeader() {
1796 uint8_t *Buf = Buffer->getBufferStart();
Rui Ueyamae08cd672015-10-23 22:44:39 +00001797 memcpy(Buf, "\177ELF", 4);
1798
Rui Ueyama6621d8e2015-10-24 17:57:40 +00001799 // Write the ELF header.
Rafael Espindola18608a02015-09-08 21:57:31 +00001800 auto *EHdr = reinterpret_cast<Elf_Ehdr *>(Buf);
Rui Ueyamaf2dc4362017-04-05 21:08:47 +00001801 EHdr->e_ident[EI_CLASS] = Config->Is64 ? ELFCLASS64 : ELFCLASS32;
1802 EHdr->e_ident[EI_DATA] = Config->IsLE ? ELFDATA2LSB : ELFDATA2MSB;
Michael J. Spencer84487f12015-07-24 21:03:07 +00001803 EHdr->e_ident[EI_VERSION] = EV_CURRENT;
Rafael Espindola7cc713a2016-10-27 14:00:51 +00001804 EHdr->e_ident[EI_OSABI] = Config->OSABI;
Rui Ueyama4cea4e82016-02-25 19:28:37 +00001805 EHdr->e_type = getELFType();
Rafael Espindola7cc713a2016-10-27 14:00:51 +00001806 EHdr->e_machine = Config->EMachine;
Michael J. Spencer84487f12015-07-24 21:03:07 +00001807 EHdr->e_version = EV_CURRENT;
Rui Ueyama2eda6d12016-11-23 22:41:00 +00001808 EHdr->e_entry = getEntryAddr();
Michael J. Spencer8039dae22015-07-29 00:30:10 +00001809 EHdr->e_shoff = SectionHeaderOff;
Rafael Espindola18608a02015-09-08 21:57:31 +00001810 EHdr->e_ehsize = sizeof(Elf_Ehdr);
Rui Ueyama2f1b79f2015-10-10 22:34:30 +00001811 EHdr->e_phnum = Phdrs.size();
Rafael Espindola18608a02015-09-08 21:57:31 +00001812 EHdr->e_shentsize = sizeof(Elf_Shdr);
Rafael Espindola1da97172017-05-30 01:36:48 +00001813 EHdr->e_shnum = OutputSectionCommands.size() + 1;
Rafael Espindoladb5e56f2017-05-31 20:17:44 +00001814 EHdr->e_shstrndx = InX::ShStrTab->getParent()->SectionIndex;
Rui Ueyama6621d8e2015-10-24 17:57:40 +00001815
Rui Ueyama1e2e8ea2016-09-13 20:51:32 +00001816 if (Config->EMachine == EM_ARM)
1817 // We don't currently use any features incompatible with EF_ARM_EABI_VER5,
1818 // but we don't have any firm guarantees of conformance. Linux AArch64
1819 // kernels (as of 2016) require an EABI version to be set.
1820 EHdr->e_flags = EF_ARM_EABI_VER5;
1821 else if (Config->EMachine == EM_MIPS)
Simon Atanasyan4f90c2f2016-07-20 20:30:41 +00001822 EHdr->e_flags = getMipsEFlags<ELFT>();
Rui Ueyama22b5d1f2016-03-13 19:29:17 +00001823
George Rimar58941ee2016-02-25 08:23:37 +00001824 if (!Config->Relocatable) {
1825 EHdr->e_phoff = sizeof(Elf_Ehdr);
1826 EHdr->e_phentsize = sizeof(Elf_Phdr);
1827 }
1828
Rui Ueyama6621d8e2015-10-24 17:57:40 +00001829 // Write the program header table.
Rafael Espindola4fc60442016-02-10 22:43:13 +00001830 auto *HBuf = reinterpret_cast<Elf_Phdr *>(Buf + EHdr->e_phoff);
Rafael Espindola17cb7c02016-12-19 17:01:01 +00001831 for (PhdrEntry &P : Phdrs) {
1832 HBuf->p_type = P.p_type;
1833 HBuf->p_flags = P.p_flags;
1834 HBuf->p_offset = P.p_offset;
1835 HBuf->p_vaddr = P.p_vaddr;
1836 HBuf->p_paddr = P.p_paddr;
1837 HBuf->p_filesz = P.p_filesz;
1838 HBuf->p_memsz = P.p_memsz;
1839 HBuf->p_align = P.p_align;
1840 ++HBuf;
1841 }
Rafael Espindolae438e072015-09-08 22:55:28 +00001842
Rui Ueyama6621d8e2015-10-24 17:57:40 +00001843 // Write the section header table. Note that the first table entry is null.
Rui Ueyamaad59b652016-02-25 23:58:21 +00001844 auto *SHdrs = reinterpret_cast<Elf_Shdr *>(Buf + EHdr->e_shoff);
Rafael Espindola1da97172017-05-30 01:36:48 +00001845 for (OutputSectionCommand *Cmd : OutputSectionCommands)
1846 Cmd->Sec->writeHeaderTo<ELFT>(++SHdrs);
Michael J. Spencer84487f12015-07-24 21:03:07 +00001847}
1848
Rui Ueyama6d12eae2016-12-05 17:40:37 +00001849// Open a result file.
Rui Ueyamaf7f52ef2016-04-01 17:24:19 +00001850template <class ELFT> void Writer<ELFT>::openFile() {
Rui Ueyama6bd38222017-04-05 21:37:09 +00001851 if (!Config->Is64 && FileSize > UINT32_MAX) {
1852 error("output file too large: " + Twine(FileSize) + " bytes");
1853 return;
1854 }
1855
Rui Ueyama6d12eae2016-12-05 17:40:37 +00001856 unlinkAsync(Config->OutputFile);
Rafael Espindolabdc8f2f2015-08-13 00:31:46 +00001857 ErrorOr<std::unique_ptr<FileOutputBuffer>> BufferOrErr =
Rui Ueyamacbe39262016-02-02 22:48:04 +00001858 FileOutputBuffer::create(Config->OutputFile, FileSize,
1859 FileOutputBuffer::F_executable);
Rui Ueyama6d12eae2016-12-05 17:40:37 +00001860
Rui Ueyamaaa2db882016-07-15 01:38:54 +00001861 if (auto EC = BufferOrErr.getError())
Rui Ueyamac8d3a832017-01-12 22:18:04 +00001862 error("failed to open " + Config->OutputFile + ": " + EC.message());
Rui Ueyamaf7f52ef2016-04-01 17:24:19 +00001863 else
Rui Ueyamaaa2db882016-07-15 01:38:54 +00001864 Buffer = std::move(*BufferOrErr);
Michael J. Spencer84487f12015-07-24 21:03:07 +00001865}
1866
George Rimar86ce2672016-08-25 09:05:47 +00001867template <class ELFT> void Writer<ELFT>::writeSectionsBinary() {
1868 uint8_t *Buf = Buffer->getBufferStart();
Rafael Espindola2d9a3be2017-05-30 01:30:14 +00001869 for (OutputSectionCommand *Cmd : OutputSectionCommands) {
Rafael Espindola55b169b2017-05-24 18:08:04 +00001870 OutputSection *Sec = Cmd->Sec;
Rafael Espindola04a2e342016-11-09 01:42:41 +00001871 if (Sec->Flags & SHF_ALLOC)
Rafael Espindola55b169b2017-05-24 18:08:04 +00001872 Cmd->writeTo<ELFT>(Buf + Sec->Offset);
1873 }
George Rimar86ce2672016-08-25 09:05:47 +00001874}
1875
Michael J. Spencer84487f12015-07-24 21:03:07 +00001876// Write section contents to a mmap'ed file.
1877template <class ELFT> void Writer<ELFT>::writeSections() {
1878 uint8_t *Buf = Buffer->getBufferStart();
Hal Finkeldaedc122015-10-12 23:16:53 +00001879
Rui Ueyama75118252016-08-09 01:35:37 +00001880 // PPC64 needs to process relocations in the .opd section
1881 // before processing relocations in code-containing sections.
Rafael Espindola43e76cd2017-05-26 17:48:27 +00001882 if (auto *OpdCmd = findSectionCommand(".opd")) {
Rafael Espindola55b169b2017-05-24 18:08:04 +00001883 Out::Opd = OpdCmd->Sec;
Rui Ueyama9d1bacb12017-02-27 02:31:26 +00001884 Out::OpdBuf = Buf + Out::Opd->Offset;
Rafael Espindola55b169b2017-05-24 18:08:04 +00001885 OpdCmd->template writeTo<ELFT>(Buf + Out::Opd->Offset);
Rafael Espindola7a513052015-10-13 14:45:51 +00001886 }
Hal Finkeldaedc122015-10-12 23:16:53 +00001887
Rafael Espindola24e6f362017-02-24 15:07:30 +00001888 OutputSection *EhFrameHdr =
Rafael Espindola881cc162017-05-26 17:28:17 +00001889 (In<ELFT>::EhFrameHdr && !In<ELFT>::EhFrameHdr->empty())
Rafael Espindoladb5e56f2017-05-31 20:17:44 +00001890 ? In<ELFT>::EhFrameHdr->getParent()
Rafael Espindola881cc162017-05-26 17:28:17 +00001891 : nullptr;
Rafael Espindola08d6a3f2017-02-11 01:40:49 +00001892
1893 // In -r or -emit-relocs mode, write the relocation sections first as in
1894 // ELf_Rel targets we might find out that we need to modify the relocated
1895 // section while doing it.
Rafael Espindola2d9a3be2017-05-30 01:30:14 +00001896 for (OutputSectionCommand *Cmd : OutputSectionCommands) {
Rafael Espindola55b169b2017-05-24 18:08:04 +00001897 OutputSection *Sec = Cmd->Sec;
Rafael Espindola08d6a3f2017-02-11 01:40:49 +00001898 if (Sec->Type == SHT_REL || Sec->Type == SHT_RELA)
Rafael Espindola55b169b2017-05-24 18:08:04 +00001899 Cmd->writeTo<ELFT>(Buf + Sec->Offset);
1900 }
Rafael Espindola08d6a3f2017-02-11 01:40:49 +00001901
Rafael Espindola2d9a3be2017-05-30 01:30:14 +00001902 for (OutputSectionCommand *Cmd : OutputSectionCommands) {
Rafael Espindola55b169b2017-05-24 18:08:04 +00001903 OutputSection *Sec = Cmd->Sec;
Rui Ueyama9d1bacb12017-02-27 02:31:26 +00001904 if (Sec != Out::Opd && Sec != EhFrameHdr && Sec->Type != SHT_REL &&
Rafael Espindola08d6a3f2017-02-11 01:40:49 +00001905 Sec->Type != SHT_RELA)
Rafael Espindola55b169b2017-05-24 18:08:04 +00001906 Cmd->writeTo<ELFT>(Buf + Sec->Offset);
1907 }
Eugene Leviante4f590f2016-08-31 07:43:50 +00001908
1909 // The .eh_frame_hdr depends on .eh_frame section contents, therefore
1910 // it should be written after .eh_frame is written.
Rafael Espindola881cc162017-05-26 17:28:17 +00001911 if (EhFrameHdr) {
Rafael Espindola55b169b2017-05-24 18:08:04 +00001912 OutputSectionCommand *Cmd = Script->getCmd(EhFrameHdr);
1913 Cmd->writeTo<ELFT>(Buf + EhFrameHdr->Offset);
1914 }
Michael J. Spencer84487f12015-07-24 21:03:07 +00001915}
Rui Ueyama3ce825e2015-10-09 21:07:25 +00001916
Rui Ueyama634ddf02016-03-11 20:51:53 +00001917template <class ELFT> void Writer<ELFT>::writeBuildId() {
Rafael Espindoladb5e56f2017-05-31 20:17:44 +00001918 if (!InX::BuildId || !InX::BuildId->getParent())
Rui Ueyama634ddf02016-03-11 20:51:53 +00001919 return;
1920
Petr Hosekfdfcb792016-09-01 22:43:03 +00001921 // Compute a hash of all sections of the output file.
Rui Ueyama634ddf02016-03-11 20:51:53 +00001922 uint8_t *Start = Buffer->getBufferStart();
Petr Hosekfdfcb792016-09-01 22:43:03 +00001923 uint8_t *End = Start + FileSize;
Rafael Espindola895aea62017-05-11 22:02:41 +00001924 InX::BuildId->writeBuildId({Start, End});
Rui Ueyama634ddf02016-03-11 20:51:53 +00001925}
1926
Rui Ueyama84907c52016-08-09 03:38:23 +00001927template void elf::writeResult<ELF32LE>();
1928template void elf::writeResult<ELF32BE>();
1929template void elf::writeResult<ELF64LE>();
1930template void elf::writeResult<ELF64BE>();