[COFF] Avoid allocating temporary vectors during ICF
[lldb.git] / lld / COFF / ICF.cpp
1 //===- ICF.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 // ICF is short for Identical Code Folding. That is a size optimization to
10 // identify and merge two or more read-only sections (typically functions)
11 // that happened to have the same contents. It usually reduces output size
12 // by a few percent.
13 //
14 // On Windows, ICF is enabled by default.
15 //
16 // See ELF/ICF.cpp for the details about the algorithm.
17 //
18 //===----------------------------------------------------------------------===//
19
20 #include "ICF.h"
21 #include "Chunks.h"
22 #include "Symbols.h"
23 #include "lld/Common/ErrorHandler.h"
24 #include "lld/Common/Threads.h"
25 #include "lld/Common/Timer.h"
26 #include "llvm/ADT/Hashing.h"
27 #include "llvm/Support/Debug.h"
28 #include "llvm/Support/Parallel.h"
29 #include "llvm/Support/raw_ostream.h"
30 #include "llvm/Support/xxhash.h"
31 #include <algorithm>
32 #include <atomic>
33 #include <vector>
34
35 using namespace llvm;
36
37 namespace lld {
38 namespace coff {
39
40 static Timer icfTimer("ICF", Timer::root());
41
42 class ICF {
43 public:
44   void run(ArrayRef<Chunk *> v);
45
46 private:
47   void segregate(size_t begin, size_t end, bool constant);
48
49   bool assocEquals(const SectionChunk *a, const SectionChunk *b);
50
51   bool equalsConstant(const SectionChunk *a, const SectionChunk *b);
52   bool equalsVariable(const SectionChunk *a, const SectionChunk *b);
53
54   bool isEligible(SectionChunk *c);
55
56   size_t findBoundary(size_t begin, size_t end);
57
58   void forEachClassRange(size_t begin, size_t end,
59                          std::function<void(size_t, size_t)> fn);
60
61   void forEachClass(std::function<void(size_t, size_t)> fn);
62
63   std::vector<SectionChunk *> chunks;
64   int cnt = 0;
65   std::atomic<bool> repeat = {false};
66 };
67
68 // Returns true if section S is subject of ICF.
69 //
70 // Microsoft's documentation
71 // (https://msdn.microsoft.com/en-us/library/bxwfs976.aspx; visited April
72 // 2017) says that /opt:icf folds both functions and read-only data.
73 // Despite that, the MSVC linker folds only functions. We found
74 // a few instances of programs that are not safe for data merging.
75 // Therefore, we merge only functions just like the MSVC tool. However, we also
76 // merge read-only sections in a couple of cases where the address of the
77 // section is insignificant to the user program and the behaviour matches that
78 // of the Visual C++ linker.
79 bool ICF::isEligible(SectionChunk *c) {
80   // Non-comdat chunks, dead chunks, and writable chunks are not eligible.
81   bool writable = c->getOutputCharacteristics() & llvm::COFF::IMAGE_SCN_MEM_WRITE;
82   if (!c->isCOMDAT() || !c->live || writable)
83     return false;
84
85   // Code sections are eligible.
86   if (c->getOutputCharacteristics() & llvm::COFF::IMAGE_SCN_MEM_EXECUTE)
87     return true;
88
89   // .pdata and .xdata unwind info sections are eligible.
90   StringRef outSecName = c->getSectionName().split('$').first;
91   if (outSecName == ".pdata" || outSecName == ".xdata")
92     return true;
93
94   // So are vtables.
95   if (c->sym && c->sym->getName().startswith("??_7"))
96     return true;
97
98   // Anything else not in an address-significance table is eligible.
99   return !c->keepUnique;
100 }
101
102 // Split an equivalence class into smaller classes.
103 void ICF::segregate(size_t begin, size_t end, bool constant) {
104   while (begin < end) {
105     // Divide [Begin, End) into two. Let Mid be the start index of the
106     // second group.
107     auto bound = std::stable_partition(
108         chunks.begin() + begin + 1, chunks.begin() + end, [&](SectionChunk *s) {
109           if (constant)
110             return equalsConstant(chunks[begin], s);
111           return equalsVariable(chunks[begin], s);
112         });
113     size_t mid = bound - chunks.begin();
114
115     // Split [Begin, End) into [Begin, Mid) and [Mid, End). We use Mid as an
116     // equivalence class ID because every group ends with a unique index.
117     for (size_t i = begin; i < mid; ++i)
118       chunks[i]->eqClass[(cnt + 1) % 2] = mid;
119
120     // If we created a group, we need to iterate the main loop again.
121     if (mid != end)
122       repeat = true;
123
124     begin = mid;
125   }
126 }
127
128 // Returns true if two sections' associative children are equal.
129 bool ICF::assocEquals(const SectionChunk *a, const SectionChunk *b) {
130   // Ignore associated metadata sections that don't participate in ICF, such as
131   // debug info and CFGuard metadata.
132   auto considerForICF = [](const SectionChunk &assoc) {
133     StringRef Name = assoc.getSectionName();
134     return !(Name.startswith(".debug") || Name == ".gfids$y" ||
135              Name == ".gljmp$y");
136   };
137   auto ra = make_filter_range(a->children(), considerForICF);
138   auto rb = make_filter_range(b->children(), considerForICF);
139   return std::equal(ra.begin(), ra.end(), rb.begin(), rb.end(),
140                     [&](const SectionChunk &ia, const SectionChunk &ib) {
141                       return ia.eqClass[cnt % 2] == ib.eqClass[cnt % 2];
142                     });
143 }
144
145 // Compare "non-moving" part of two sections, namely everything
146 // except relocation targets.
147 bool ICF::equalsConstant(const SectionChunk *a, const SectionChunk *b) {
148   if (a->relocsSize != b->relocsSize)
149     return false;
150
151   // Compare relocations.
152   auto eq = [&](const coff_relocation &r1, const coff_relocation &r2) {
153     if (r1.Type != r2.Type ||
154         r1.VirtualAddress != r2.VirtualAddress) {
155       return false;
156     }
157     Symbol *b1 = a->file->getSymbol(r1.SymbolTableIndex);
158     Symbol *b2 = b->file->getSymbol(r2.SymbolTableIndex);
159     if (b1 == b2)
160       return true;
161     if (auto *d1 = dyn_cast<DefinedRegular>(b1))
162       if (auto *d2 = dyn_cast<DefinedRegular>(b2))
163         return d1->getValue() == d2->getValue() &&
164                d1->getChunk()->eqClass[cnt % 2] == d2->getChunk()->eqClass[cnt % 2];
165     return false;
166   };
167   if (!std::equal(a->getRelocs().begin(), a->getRelocs().end(),
168                   b->getRelocs().begin(), eq))
169     return false;
170
171   // Compare section attributes and contents.
172   return a->getOutputCharacteristics() == b->getOutputCharacteristics() &&
173          a->getSectionName() == b->getSectionName() &&
174          a->header->SizeOfRawData == b->header->SizeOfRawData &&
175          a->checksum == b->checksum && a->getContents() == b->getContents() &&
176          assocEquals(a, b);
177 }
178
179 // Compare "moving" part of two sections, namely relocation targets.
180 bool ICF::equalsVariable(const SectionChunk *a, const SectionChunk *b) {
181   // Compare relocations.
182   auto eq = [&](const coff_relocation &r1, const coff_relocation &r2) {
183     Symbol *b1 = a->file->getSymbol(r1.SymbolTableIndex);
184     Symbol *b2 = b->file->getSymbol(r2.SymbolTableIndex);
185     if (b1 == b2)
186       return true;
187     if (auto *d1 = dyn_cast<DefinedRegular>(b1))
188       if (auto *d2 = dyn_cast<DefinedRegular>(b2))
189         return d1->getChunk()->eqClass[cnt % 2] == d2->getChunk()->eqClass[cnt % 2];
190     return false;
191   };
192   return std::equal(a->getRelocs().begin(), a->getRelocs().end(),
193                     b->getRelocs().begin(), eq) &&
194          assocEquals(a, b);
195 }
196
197 // Find the first Chunk after Begin that has a different class from Begin.
198 size_t ICF::findBoundary(size_t begin, size_t end) {
199   for (size_t i = begin + 1; i < end; ++i)
200     if (chunks[begin]->eqClass[cnt % 2] != chunks[i]->eqClass[cnt % 2])
201       return i;
202   return end;
203 }
204
205 void ICF::forEachClassRange(size_t begin, size_t end,
206                             std::function<void(size_t, size_t)> fn) {
207   while (begin < end) {
208     size_t mid = findBoundary(begin, end);
209     fn(begin, mid);
210     begin = mid;
211   }
212 }
213
214 // Call Fn on each class group.
215 void ICF::forEachClass(std::function<void(size_t, size_t)> fn) {
216   // If the number of sections are too small to use threading,
217   // call Fn sequentially.
218   if (chunks.size() < 1024) {
219     forEachClassRange(0, chunks.size(), fn);
220     ++cnt;
221     return;
222   }
223
224   // Shard into non-overlapping intervals, and call Fn in parallel.
225   // The sharding must be completed before any calls to Fn are made
226   // so that Fn can modify the Chunks in its shard without causing data
227   // races.
228   const size_t numShards = 256;
229   size_t step = chunks.size() / numShards;
230   size_t boundaries[numShards + 1];
231   boundaries[0] = 0;
232   boundaries[numShards] = chunks.size();
233   parallelForEachN(1, numShards, [&](size_t i) {
234     boundaries[i] = findBoundary((i - 1) * step, chunks.size());
235   });
236   parallelForEachN(1, numShards + 1, [&](size_t i) {
237     if (boundaries[i - 1] < boundaries[i]) {
238       forEachClassRange(boundaries[i - 1], boundaries[i], fn);
239     }
240   });
241   ++cnt;
242 }
243
244 // Merge identical COMDAT sections.
245 // Two sections are considered the same if their section headers,
246 // contents and relocations are all the same.
247 void ICF::run(ArrayRef<Chunk *> vec) {
248   ScopedTimer t(icfTimer);
249
250   // Collect only mergeable sections and group by hash value.
251   uint32_t nextId = 1;
252   for (Chunk *c : vec) {
253     if (auto *sc = dyn_cast<SectionChunk>(c)) {
254       if (isEligible(sc))
255         chunks.push_back(sc);
256       else
257         sc->eqClass[0] = nextId++;
258     }
259   }
260
261   // Make sure that ICF doesn't merge sections that are being handled by string
262   // tail merging.
263   for (MergeChunk *mc : MergeChunk::instances)
264     if (mc)
265       for (SectionChunk *sc : mc->sections)
266         sc->eqClass[0] = nextId++;
267
268   // Initially, we use hash values to partition sections.
269   parallelForEach(chunks, [&](SectionChunk *sc) {
270     sc->eqClass[0] = xxHash64(sc->getContents());
271   });
272
273   // Combine the hashes of the sections referenced by each section into its
274   // hash.
275   for (unsigned cnt = 0; cnt != 2; ++cnt) {
276     parallelForEach(chunks, [&](SectionChunk *sc) {
277       uint32_t hash = sc->eqClass[cnt % 2];
278       for (Symbol *b : sc->symbols())
279         if (auto *sym = dyn_cast_or_null<DefinedRegular>(b))
280           hash += sym->getChunk()->eqClass[cnt % 2];
281       // Set MSB to 1 to avoid collisions with non-hash classes.
282       sc->eqClass[(cnt + 1) % 2] = hash | (1U << 31);
283     });
284   }
285
286   // From now on, sections in Chunks are ordered so that sections in
287   // the same group are consecutive in the vector.
288   llvm::stable_sort(chunks, [](const SectionChunk *a, const SectionChunk *b) {
289     return a->eqClass[0] < b->eqClass[0];
290   });
291
292   // Compare static contents and assign unique IDs for each static content.
293   forEachClass([&](size_t begin, size_t end) { segregate(begin, end, true); });
294
295   // Split groups by comparing relocations until convergence is obtained.
296   do {
297     repeat = false;
298     forEachClass(
299         [&](size_t begin, size_t end) { segregate(begin, end, false); });
300   } while (repeat);
301
302   log("ICF needed " + Twine(cnt) + " iterations");
303
304   // Merge sections in the same classes.
305   forEachClass([&](size_t begin, size_t end) {
306     if (end - begin == 1)
307       return;
308
309     log("Selected " + chunks[begin]->getDebugName());
310     for (size_t i = begin + 1; i < end; ++i) {
311       log("  Removed " + chunks[i]->getDebugName());
312       chunks[begin]->replace(chunks[i]);
313     }
314   });
315 }
316
317 // Entry point to ICF.
318 void doICF(ArrayRef<Chunk *> chunks) { ICF().run(chunks); }
319
320 } // namespace coff
321 } // namespace lld