|
150
|
1 //===- MarkLive.cpp -------------------------------------------------------===//
|
|
|
2 //
|
|
|
3 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
|
|
|
4 // See https://llvm.org/LICENSE.txt for license information.
|
|
|
5 // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
|
|
|
6 //
|
|
|
7 //===----------------------------------------------------------------------===//
|
|
|
8 //
|
|
|
9 // This file implements --gc-sections, which is a feature to remove unused
|
|
|
10 // sections from output. Unused sections are sections that are not reachable
|
|
|
11 // from known GC-root symbols or sections. Naturally the feature is
|
|
|
12 // implemented as a mark-sweep garbage collector.
|
|
|
13 //
|
|
|
14 // Here's how it works. Each InputSectionBase has a "Live" bit. The bit is off
|
|
|
15 // by default. Starting with GC-root symbols or sections, markLive function
|
|
|
16 // defined in this file visits all reachable sections to set their Live
|
|
|
17 // bits. Writer will then ignore sections whose Live bits are off, so that
|
|
|
18 // such sections are not included into output.
|
|
|
19 //
|
|
|
20 //===----------------------------------------------------------------------===//
|
|
|
21
|
|
|
22 #include "MarkLive.h"
|
|
|
23 #include "InputSection.h"
|
|
|
24 #include "LinkerScript.h"
|
|
|
25 #include "OutputSections.h"
|
|
|
26 #include "SymbolTable.h"
|
|
|
27 #include "Symbols.h"
|
|
|
28 #include "SyntheticSections.h"
|
|
|
29 #include "Target.h"
|
|
|
30 #include "lld/Common/Memory.h"
|
|
|
31 #include "lld/Common/Strings.h"
|
|
|
32 #include "llvm/ADT/STLExtras.h"
|
|
|
33 #include "llvm/Object/ELF.h"
|
|
|
34 #include "llvm/Support/TimeProfiler.h"
|
|
|
35 #include <functional>
|
|
|
36 #include <vector>
|
|
|
37
|
|
|
38 using namespace llvm;
|
|
|
39 using namespace llvm::ELF;
|
|
|
40 using namespace llvm::object;
|
|
173
|
41 using namespace llvm::support::endian;
|
|
|
42 using namespace lld;
|
|
|
43 using namespace lld::elf;
|
|
150
|
44
|
|
|
45 namespace {
|
|
|
46 template <class ELFT> class MarkLive {
|
|
|
47 public:
|
|
|
48 MarkLive(unsigned partition) : partition(partition) {}
|
|
|
49
|
|
|
50 void run();
|
|
|
51 void moveToMain();
|
|
|
52
|
|
|
53 private:
|
|
|
54 void enqueue(InputSectionBase *sec, uint64_t offset);
|
|
|
55 void markSymbol(Symbol *sym);
|
|
|
56 void mark();
|
|
|
57
|
|
|
58 template <class RelTy>
|
|
207
|
59 void resolveReloc(InputSectionBase &sec, RelTy &rel, bool fromFDE);
|
|
150
|
60
|
|
|
61 template <class RelTy>
|
|
|
62 void scanEhFrameSection(EhInputSection &eh, ArrayRef<RelTy> rels);
|
|
|
63
|
|
|
64 // The index of the partition that we are currently processing.
|
|
|
65 unsigned partition;
|
|
|
66
|
|
|
67 // A list of sections to visit.
|
|
207
|
68 SmallVector<InputSection *, 0> queue;
|
|
150
|
69
|
|
|
70 // There are normally few input sections whose names are valid C
|
|
|
71 // identifiers, so we just store a std::vector instead of a multimap.
|
|
|
72 DenseMap<StringRef, std::vector<InputSectionBase *>> cNamedSections;
|
|
|
73 };
|
|
|
74 } // namespace
|
|
|
75
|
|
|
76 template <class ELFT>
|
|
|
77 static uint64_t getAddend(InputSectionBase &sec,
|
|
|
78 const typename ELFT::Rel &rel) {
|
|
|
79 return target->getImplicitAddend(sec.data().begin() + rel.r_offset,
|
|
|
80 rel.getType(config->isMips64EL));
|
|
|
81 }
|
|
|
82
|
|
|
83 template <class ELFT>
|
|
|
84 static uint64_t getAddend(InputSectionBase &sec,
|
|
|
85 const typename ELFT::Rela &rel) {
|
|
|
86 return rel.r_addend;
|
|
|
87 }
|
|
|
88
|
|
|
89 template <class ELFT>
|
|
|
90 template <class RelTy>
|
|
|
91 void MarkLive<ELFT>::resolveReloc(InputSectionBase &sec, RelTy &rel,
|
|
207
|
92 bool fromFDE) {
|
|
150
|
93 Symbol &sym = sec.getFile<ELFT>()->getRelocTargetSym(rel);
|
|
|
94
|
|
|
95 // If a symbol is referenced in a live section, it is used.
|
|
|
96 sym.used = true;
|
|
|
97
|
|
|
98 if (auto *d = dyn_cast<Defined>(&sym)) {
|
|
|
99 auto *relSec = dyn_cast_or_null<InputSectionBase>(d->section);
|
|
|
100 if (!relSec)
|
|
|
101 return;
|
|
|
102
|
|
|
103 uint64_t offset = d->value;
|
|
|
104 if (d->isSection())
|
|
|
105 offset += getAddend<ELFT>(sec, rel);
|
|
|
106
|
|
207
|
107 // fromFDE being true means this is referenced by a FDE in a .eh_frame
|
|
|
108 // piece. The relocation points to the described function or to a LSDA. We
|
|
|
109 // only need to keep the LSDA live, so ignore anything that points to
|
|
|
110 // executable sections. If the LSDA is in a section group or has the
|
|
|
111 // SHF_LINK_ORDER flag, we ignore the relocation as well because (a) if the
|
|
|
112 // associated text section is live, the LSDA will be retained due to section
|
|
|
113 // group/SHF_LINK_ORDER rules (b) if the associated text section should be
|
|
|
114 // discarded, marking the LSDA will unnecessarily retain the text section.
|
|
|
115 if (!(fromFDE && ((relSec->flags & (SHF_EXECINSTR | SHF_LINK_ORDER)) ||
|
|
|
116 relSec->nextInSectionGroup)))
|
|
150
|
117 enqueue(relSec, offset);
|
|
|
118 return;
|
|
|
119 }
|
|
|
120
|
|
|
121 if (auto *ss = dyn_cast<SharedSymbol>(&sym))
|
|
|
122 if (!ss->isWeak())
|
|
|
123 ss->getFile().isNeeded = true;
|
|
|
124
|
|
|
125 for (InputSectionBase *sec : cNamedSections.lookup(sym.getName()))
|
|
|
126 enqueue(sec, 0);
|
|
|
127 }
|
|
|
128
|
|
|
129 // The .eh_frame section is an unfortunate special case.
|
|
|
130 // The section is divided in CIEs and FDEs and the relocations it can have are
|
|
|
131 // * CIEs can refer to a personality function.
|
|
|
132 // * FDEs can refer to a LSDA
|
|
|
133 // * FDEs refer to the function they contain information about
|
|
|
134 // The last kind of relocation cannot keep the referred section alive, or they
|
|
|
135 // would keep everything alive in a common object file. In fact, each FDE is
|
|
|
136 // alive if the section it refers to is alive.
|
|
|
137 // To keep things simple, in here we just ignore the last relocation kind. The
|
|
|
138 // other two keep the referred section alive.
|
|
|
139 //
|
|
|
140 // A possible improvement would be to fully process .eh_frame in the middle of
|
|
|
141 // the gc pass. With that we would be able to also gc some sections holding
|
|
|
142 // LSDAs and personality functions if we found that they were unused.
|
|
|
143 template <class ELFT>
|
|
|
144 template <class RelTy>
|
|
|
145 void MarkLive<ELFT>::scanEhFrameSection(EhInputSection &eh,
|
|
|
146 ArrayRef<RelTy> rels) {
|
|
|
147 for (size_t i = 0, end = eh.pieces.size(); i < end; ++i) {
|
|
|
148 EhSectionPiece &piece = eh.pieces[i];
|
|
|
149 size_t firstRelI = piece.firstRelocation;
|
|
|
150 if (firstRelI == (unsigned)-1)
|
|
|
151 continue;
|
|
|
152
|
|
173
|
153 if (read32<ELFT::TargetEndianness>(piece.data().data() + 4) == 0) {
|
|
150
|
154 // This is a CIE, we only need to worry about the first relocation. It is
|
|
|
155 // known to point to the personality function.
|
|
|
156 resolveReloc(eh, rels[firstRelI], false);
|
|
|
157 continue;
|
|
|
158 }
|
|
|
159
|
|
|
160 uint64_t pieceEnd = piece.inputOff + piece.size;
|
|
207
|
161 for (size_t j = firstRelI, end2 = rels.size();
|
|
|
162 j < end2 && rels[j].r_offset < pieceEnd; ++j)
|
|
|
163 resolveReloc(eh, rels[j], true);
|
|
150
|
164 }
|
|
|
165 }
|
|
|
166
|
|
|
167 // Some sections are used directly by the loader, so they should never be
|
|
|
168 // garbage-collected. This function returns true if a given section is such
|
|
|
169 // section.
|
|
|
170 static bool isReserved(InputSectionBase *sec) {
|
|
|
171 switch (sec->type) {
|
|
|
172 case SHT_FINI_ARRAY:
|
|
|
173 case SHT_INIT_ARRAY:
|
|
|
174 case SHT_PREINIT_ARRAY:
|
|
|
175 return true;
|
|
|
176 case SHT_NOTE:
|
|
|
177 // SHT_NOTE sections in a group are subject to garbage collection.
|
|
|
178 return !sec->nextInSectionGroup;
|
|
|
179 default:
|
|
|
180 StringRef s = sec->name;
|
|
|
181 return s.startswith(".ctors") || s.startswith(".dtors") ||
|
|
|
182 s.startswith(".init") || s.startswith(".fini") ||
|
|
|
183 s.startswith(".jcr");
|
|
|
184 }
|
|
|
185 }
|
|
|
186
|
|
|
187 template <class ELFT>
|
|
|
188 void MarkLive<ELFT>::enqueue(InputSectionBase *sec, uint64_t offset) {
|
|
|
189 // Skip over discarded sections. This in theory shouldn't happen, because
|
|
|
190 // the ELF spec doesn't allow a relocation to point to a deduplicated
|
|
|
191 // COMDAT section directly. Unfortunately this happens in practice (e.g.
|
|
|
192 // .eh_frame) so we need to add a check.
|
|
|
193 if (sec == &InputSection::discarded)
|
|
|
194 return;
|
|
|
195
|
|
|
196 // Usually, a whole section is marked as live or dead, but in mergeable
|
|
|
197 // (splittable) sections, each piece of data has independent liveness bit.
|
|
|
198 // So we explicitly tell it which offset is in use.
|
|
|
199 if (auto *ms = dyn_cast<MergeInputSection>(sec))
|
|
|
200 ms->getSectionPiece(offset)->live = true;
|
|
|
201
|
|
|
202 // Set Sec->Partition to the meet (i.e. the "minimum") of Partition and
|
|
|
203 // Sec->Partition in the following lattice: 1 < other < 0. If Sec->Partition
|
|
|
204 // doesn't change, we don't need to do anything.
|
|
|
205 if (sec->partition == 1 || sec->partition == partition)
|
|
|
206 return;
|
|
|
207 sec->partition = sec->partition ? 1 : partition;
|
|
|
208
|
|
|
209 // Add input section to the queue.
|
|
|
210 if (InputSection *s = dyn_cast<InputSection>(sec))
|
|
|
211 queue.push_back(s);
|
|
|
212 }
|
|
|
213
|
|
|
214 template <class ELFT> void MarkLive<ELFT>::markSymbol(Symbol *sym) {
|
|
|
215 if (auto *d = dyn_cast_or_null<Defined>(sym))
|
|
|
216 if (auto *isec = dyn_cast_or_null<InputSectionBase>(d->section))
|
|
|
217 enqueue(isec, d->value);
|
|
|
218 }
|
|
|
219
|
|
|
220 // This is the main function of the garbage collector.
|
|
|
221 // Starting from GC-root sections, this function visits all reachable
|
|
|
222 // sections to set their "Live" bits.
|
|
|
223 template <class ELFT> void MarkLive<ELFT>::run() {
|
|
|
224 // Add GC root symbols.
|
|
|
225
|
|
|
226 // Preserve externally-visible symbols if the symbols defined by this
|
|
|
227 // file can interrupt other ELF file's symbols at runtime.
|
|
|
228 for (Symbol *sym : symtab->symbols())
|
|
|
229 if (sym->includeInDynsym() && sym->partition == partition)
|
|
|
230 markSymbol(sym);
|
|
|
231
|
|
|
232 // If this isn't the main partition, that's all that we need to preserve.
|
|
|
233 if (partition != 1) {
|
|
|
234 mark();
|
|
|
235 return;
|
|
|
236 }
|
|
|
237
|
|
|
238 markSymbol(symtab->find(config->entry));
|
|
|
239 markSymbol(symtab->find(config->init));
|
|
|
240 markSymbol(symtab->find(config->fini));
|
|
|
241 for (StringRef s : config->undefined)
|
|
|
242 markSymbol(symtab->find(s));
|
|
|
243 for (StringRef s : script->referencedSymbols)
|
|
|
244 markSymbol(symtab->find(s));
|
|
|
245
|
|
|
246 // Preserve special sections and those which are specified in linker
|
|
|
247 // script KEEP command.
|
|
|
248 for (InputSectionBase *sec : inputSections) {
|
|
|
249 // Mark .eh_frame sections as live because there are usually no relocations
|
|
|
250 // that point to .eh_frames. Otherwise, the garbage collector would drop
|
|
|
251 // all of them. We also want to preserve personality routines and LSDA
|
|
|
252 // referenced by .eh_frame sections, so we scan them for that here.
|
|
|
253 if (auto *eh = dyn_cast<EhInputSection>(sec)) {
|
|
|
254 eh->markLive();
|
|
|
255 if (!eh->numRelocations)
|
|
|
256 continue;
|
|
|
257
|
|
|
258 if (eh->areRelocsRela)
|
|
|
259 scanEhFrameSection(*eh, eh->template relas<ELFT>());
|
|
|
260 else
|
|
|
261 scanEhFrameSection(*eh, eh->template rels<ELFT>());
|
|
|
262 }
|
|
|
263
|
|
207
|
264 if (sec->flags & SHF_GNU_RETAIN) {
|
|
|
265 enqueue(sec, 0);
|
|
|
266 continue;
|
|
|
267 }
|
|
150
|
268 if (sec->flags & SHF_LINK_ORDER)
|
|
|
269 continue;
|
|
|
270
|
|
|
271 if (isReserved(sec) || script->shouldKeep(sec)) {
|
|
|
272 enqueue(sec, 0);
|
|
207
|
273 } else if ((!config->zStartStopGC || sec->name.startswith("__libc_")) &&
|
|
|
274 isValidCIdentifier(sec->name)) {
|
|
|
275 // As a workaround for glibc libc.a before 2.34
|
|
|
276 // (https://sourceware.org/PR27492), retain __libc_atexit and similar
|
|
|
277 // sections regardless of zStartStopGC.
|
|
150
|
278 cNamedSections[saver.save("__start_" + sec->name)].push_back(sec);
|
|
|
279 cNamedSections[saver.save("__stop_" + sec->name)].push_back(sec);
|
|
|
280 }
|
|
|
281 }
|
|
|
282
|
|
|
283 mark();
|
|
|
284 }
|
|
|
285
|
|
|
286 template <class ELFT> void MarkLive<ELFT>::mark() {
|
|
|
287 // Mark all reachable sections.
|
|
|
288 while (!queue.empty()) {
|
|
|
289 InputSectionBase &sec = *queue.pop_back_val();
|
|
|
290
|
|
|
291 if (sec.areRelocsRela) {
|
|
|
292 for (const typename ELFT::Rela &rel : sec.template relas<ELFT>())
|
|
|
293 resolveReloc(sec, rel, false);
|
|
|
294 } else {
|
|
|
295 for (const typename ELFT::Rel &rel : sec.template rels<ELFT>())
|
|
|
296 resolveReloc(sec, rel, false);
|
|
|
297 }
|
|
|
298
|
|
|
299 for (InputSectionBase *isec : sec.dependentSections)
|
|
|
300 enqueue(isec, 0);
|
|
|
301
|
|
|
302 // Mark the next group member.
|
|
|
303 if (sec.nextInSectionGroup)
|
|
|
304 enqueue(sec.nextInSectionGroup, 0);
|
|
|
305 }
|
|
|
306 }
|
|
|
307
|
|
|
308 // Move the sections for some symbols to the main partition, specifically ifuncs
|
|
|
309 // (because they can result in an IRELATIVE being added to the main partition's
|
|
|
310 // GOT, which means that the ifunc must be available when the main partition is
|
|
|
311 // loaded) and TLS symbols (because we only know how to correctly process TLS
|
|
|
312 // relocations for the main partition).
|
|
|
313 //
|
|
|
314 // We also need to move sections whose names are C identifiers that are referred
|
|
|
315 // to from __start_/__stop_ symbols because there will only be one set of
|
|
|
316 // symbols for the whole program.
|
|
|
317 template <class ELFT> void MarkLive<ELFT>::moveToMain() {
|
|
|
318 for (InputFile *file : objectFiles)
|
|
|
319 for (Symbol *s : file->getSymbols())
|
|
|
320 if (auto *d = dyn_cast<Defined>(s))
|
|
|
321 if ((d->type == STT_GNU_IFUNC || d->type == STT_TLS) && d->section &&
|
|
|
322 d->section->isLive())
|
|
|
323 markSymbol(s);
|
|
|
324
|
|
|
325 for (InputSectionBase *sec : inputSections) {
|
|
|
326 if (!sec->isLive() || !isValidCIdentifier(sec->name))
|
|
|
327 continue;
|
|
|
328 if (symtab->find(("__start_" + sec->name).str()) ||
|
|
|
329 symtab->find(("__stop_" + sec->name).str()))
|
|
|
330 enqueue(sec, 0);
|
|
|
331 }
|
|
|
332
|
|
|
333 mark();
|
|
|
334 }
|
|
|
335
|
|
|
336 // Before calling this function, Live bits are off for all
|
|
|
337 // input sections. This function make some or all of them on
|
|
|
338 // so that they are emitted to the output file.
|
|
173
|
339 template <class ELFT> void elf::markLive() {
|
|
150
|
340 llvm::TimeTraceScope timeScope("markLive");
|
|
|
341 // If -gc-sections is not given, no sections are removed.
|
|
|
342 if (!config->gcSections) {
|
|
|
343 for (InputSectionBase *sec : inputSections)
|
|
|
344 sec->markLive();
|
|
|
345
|
|
|
346 // If a DSO defines a symbol referenced in a regular object, it is needed.
|
|
|
347 for (Symbol *sym : symtab->symbols())
|
|
|
348 if (auto *s = dyn_cast<SharedSymbol>(sym))
|
|
|
349 if (s->isUsedInRegularObj && !s->isWeak())
|
|
|
350 s->getFile().isNeeded = true;
|
|
|
351 return;
|
|
|
352 }
|
|
|
353
|
|
|
354 // Otherwise, do mark-sweep GC.
|
|
|
355 //
|
|
207
|
356 // The -gc-sections option works only for SHF_ALLOC sections (sections that
|
|
|
357 // are memory-mapped at runtime). So we can unconditionally make non-SHF_ALLOC
|
|
|
358 // sections alive except SHF_LINK_ORDER, SHT_REL/SHT_RELA sections, and
|
|
|
359 // sections in a group.
|
|
150
|
360 //
|
|
|
361 // Usually, non-SHF_ALLOC sections are not removed even if they are
|
|
207
|
362 // unreachable through relocations because reachability is not a good signal
|
|
|
363 // whether they are garbage or not (e.g. there is usually no section referring
|
|
|
364 // to a .comment section, but we want to keep it.) When a non-SHF_ALLOC
|
|
|
365 // section is retained, we also retain sections dependent on it.
|
|
150
|
366 //
|
|
|
367 // Note on SHF_LINK_ORDER: Such sections contain metadata and they
|
|
|
368 // have a reverse dependency on the InputSection they are linked with.
|
|
|
369 // We are able to garbage collect them.
|
|
|
370 //
|
|
|
371 // Note on SHF_REL{,A}: Such sections reach here only when -r
|
|
|
372 // or -emit-reloc were given. And they are subject of garbage
|
|
|
373 // collection because, if we remove a text section, we also
|
|
|
374 // remove its relocation section.
|
|
|
375 //
|
|
|
376 // Note on nextInSectionGroup: The ELF spec says that group sections are
|
|
|
377 // included or omitted as a unit. We take the interpretation that:
|
|
|
378 //
|
|
|
379 // - Group members (nextInSectionGroup != nullptr) are subject to garbage
|
|
|
380 // collection.
|
|
|
381 // - Groups members are retained or discarded as a unit.
|
|
|
382 for (InputSectionBase *sec : inputSections) {
|
|
|
383 bool isAlloc = (sec->flags & SHF_ALLOC);
|
|
|
384 bool isLinkOrder = (sec->flags & SHF_LINK_ORDER);
|
|
|
385 bool isRel = (sec->type == SHT_REL || sec->type == SHT_RELA);
|
|
|
386
|
|
207
|
387 if (!isAlloc && !isLinkOrder && !isRel && !sec->nextInSectionGroup) {
|
|
150
|
388 sec->markLive();
|
|
207
|
389 for (InputSection *isec : sec->dependentSections)
|
|
|
390 isec->markLive();
|
|
|
391 }
|
|
150
|
392 }
|
|
|
393
|
|
|
394 // Follow the graph to mark all live sections.
|
|
|
395 for (unsigned curPart = 1; curPart <= partitions.size(); ++curPart)
|
|
|
396 MarkLive<ELFT>(curPart).run();
|
|
|
397
|
|
|
398 // If we have multiple partitions, some sections need to live in the main
|
|
|
399 // partition even if they were allocated to a loadable partition. Move them
|
|
|
400 // there now.
|
|
|
401 if (partitions.size() != 1)
|
|
|
402 MarkLive<ELFT>(1).moveToMain();
|
|
|
403
|
|
|
404 // Report garbage-collected sections.
|
|
|
405 if (config->printGcSections)
|
|
|
406 for (InputSectionBase *sec : inputSections)
|
|
|
407 if (!sec->isLive())
|
|
|
408 message("removing unused section " + toString(sec));
|
|
|
409 }
|
|
|
410
|
|
173
|
411 template void elf::markLive<ELF32LE>();
|
|
|
412 template void elf::markLive<ELF32BE>();
|
|
|
413 template void elf::markLive<ELF64LE>();
|
|
|
414 template void elf::markLive<ELF64BE>();
|
