1 //===- UnwindInfoSection.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 #include "UnwindInfoSection.h"
10 #include "ConcatOutputSection.h"
11 #include "Config.h"
12 #include "InputSection.h"
13 #include "OutputSection.h"
14 #include "OutputSegment.h"
15 #include "SymbolTable.h"
16 #include "Symbols.h"
17 #include "SyntheticSections.h"
18 #include "Target.h"
19 
20 #include "lld/Common/ErrorHandler.h"
21 #include "lld/Common/Memory.h"
22 #include "llvm/ADT/DenseMap.h"
23 #include "llvm/ADT/STLExtras.h"
24 #include "llvm/BinaryFormat/MachO.h"
25 #include "llvm/Support/Parallel.h"
26 
27 #include <numeric>
28 
29 using namespace llvm;
30 using namespace llvm::MachO;
31 using namespace lld;
32 using namespace lld::macho;
33 
34 #define COMMON_ENCODINGS_MAX 127
35 #define COMPACT_ENCODINGS_MAX 256
36 
37 #define SECOND_LEVEL_PAGE_BYTES 4096
38 #define SECOND_LEVEL_PAGE_WORDS (SECOND_LEVEL_PAGE_BYTES / sizeof(uint32_t))
39 #define REGULAR_SECOND_LEVEL_ENTRIES_MAX                                       \
40   ((SECOND_LEVEL_PAGE_BYTES -                                                  \
41     sizeof(unwind_info_regular_second_level_page_header)) /                    \
42    sizeof(unwind_info_regular_second_level_entry))
43 #define COMPRESSED_SECOND_LEVEL_ENTRIES_MAX                                    \
44   ((SECOND_LEVEL_PAGE_BYTES -                                                  \
45     sizeof(unwind_info_compressed_second_level_page_header)) /                 \
46    sizeof(uint32_t))
47 
48 #define COMPRESSED_ENTRY_FUNC_OFFSET_BITS 24
49 #define COMPRESSED_ENTRY_FUNC_OFFSET_MASK                                      \
50   UNWIND_INFO_COMPRESSED_ENTRY_FUNC_OFFSET(~0)
51 
52 // Compact Unwind format is a Mach-O evolution of DWARF Unwind that
53 // optimizes space and exception-time lookup.  Most DWARF unwind
54 // entries can be replaced with Compact Unwind entries, but the ones
55 // that cannot are retained in DWARF form.
56 //
57 // This comment will address macro-level organization of the pre-link
58 // and post-link compact unwind tables. For micro-level organization
59 // pertaining to the bitfield layout of the 32-bit compact unwind
60 // entries, see libunwind/include/mach-o/compact_unwind_encoding.h
61 //
62 // Important clarifying factoids:
63 //
64 // * __LD,__compact_unwind is the compact unwind format for compiler
65 // output and linker input. It is never a final output. It could be
66 // an intermediate output with the `-r` option which retains relocs.
67 //
68 // * __TEXT,__unwind_info is the compact unwind format for final
69 // linker output. It is never an input.
70 //
71 // * __TEXT,__eh_frame is the DWARF format for both linker input and output.
72 //
73 // * __TEXT,__unwind_info entries are divided into 4 KiB pages (2nd
74 // level) by ascending address, and the pages are referenced by an
75 // index (1st level) in the section header.
76 //
77 // * Following the headers in __TEXT,__unwind_info, the bulk of the
78 // section contains a vector of compact unwind entries
79 // `{functionOffset, encoding}` sorted by ascending `functionOffset`.
80 // Adjacent entries with the same encoding can be folded to great
81 // advantage, achieving a 3-order-of-magnitude reduction in the
82 // number of entries.
83 //
84 // * The __TEXT,__unwind_info format can accommodate up to 127 unique
85 // encodings for the space-efficient compressed format. In practice,
86 // fewer than a dozen unique encodings are used by C++ programs of
87 // all sizes. Therefore, we don't even bother implementing the regular
88 // non-compressed format. Time will tell if anyone in the field ever
89 // overflows the 127-encodings limit.
90 //
91 // Refer to the definition of unwind_info_section_header in
92 // compact_unwind_encoding.h for an overview of the format we are encoding
93 // here.
94 
95 // TODO(gkm): prune __eh_frame entries superseded by __unwind_info, PR50410
96 // TODO(gkm): how do we align the 2nd-level pages?
97 
98 // The offsets of various fields in the on-disk representation of each compact
99 // unwind entry.
100 struct CompactUnwindOffsets {
101   uint32_t functionAddress;
102   uint32_t functionLength;
103   uint32_t encoding;
104   uint32_t personality;
105   uint32_t lsda;
106 
107   CompactUnwindOffsets(size_t wordSize) {
108     if (wordSize == 8)
109       init<uint64_t>();
110     else {
111       assert(wordSize == 4);
112       init<uint32_t>();
113     }
114   }
115 
116 private:
117   template <class Ptr> void init() {
118     functionAddress = offsetof(Layout<Ptr>, functionAddress);
119     functionLength = offsetof(Layout<Ptr>, functionLength);
120     encoding = offsetof(Layout<Ptr>, encoding);
121     personality = offsetof(Layout<Ptr>, personality);
122     lsda = offsetof(Layout<Ptr>, lsda);
123   }
124 
125   template <class Ptr> struct Layout {
126     Ptr functionAddress;
127     uint32_t functionLength;
128     compact_unwind_encoding_t encoding;
129     Ptr personality;
130     Ptr lsda;
131   };
132 };
133 
134 // LLD's internal representation of a compact unwind entry.
135 struct CompactUnwindEntry {
136   uint64_t functionAddress;
137   uint32_t functionLength;
138   compact_unwind_encoding_t encoding;
139   Symbol *personality;
140   InputSection *lsda;
141 };
142 
143 using EncodingMap = DenseMap<compact_unwind_encoding_t, size_t>;
144 
145 struct SecondLevelPage {
146   uint32_t kind;
147   size_t entryIndex;
148   size_t entryCount;
149   size_t byteCount;
150   std::vector<compact_unwind_encoding_t> localEncodings;
151   EncodingMap localEncodingIndexes;
152 };
153 
154 // UnwindInfoSectionImpl allows us to avoid cluttering our header file with a
155 // lengthy definition of UnwindInfoSection.
156 class UnwindInfoSectionImpl final : public UnwindInfoSection {
157 public:
158   UnwindInfoSectionImpl() : cuOffsets(target->wordSize) {}
159   uint64_t getSize() const override { return unwindInfoSize; }
160   void prepareRelocations() override;
161   void finalize() override;
162   void writeTo(uint8_t *buf) const override;
163 
164 private:
165   void prepareRelocations(ConcatInputSection *);
166   void relocateCompactUnwind(std::vector<CompactUnwindEntry> &);
167   void encodePersonalities();
168 
169   uint64_t unwindInfoSize = 0;
170   std::vector<decltype(symbols)::value_type> symbolsVec;
171   CompactUnwindOffsets cuOffsets;
172   std::vector<std::pair<compact_unwind_encoding_t, size_t>> commonEncodings;
173   EncodingMap commonEncodingIndexes;
174   // The entries here will be in the same order as their originating symbols
175   // in symbolsVec.
176   std::vector<CompactUnwindEntry> cuEntries;
177   // Indices into the cuEntries vector.
178   std::vector<size_t> cuIndices;
179   std::vector<Symbol *> personalities;
180   SmallDenseMap<std::pair<InputSection *, uint64_t /* addend */>, Symbol *>
181       personalityTable;
182   // Indices into cuEntries for CUEs with a non-null LSDA.
183   std::vector<size_t> entriesWithLsda;
184   // Map of cuEntries index to an index within the LSDA array.
185   DenseMap<size_t, uint32_t> lsdaIndex;
186   std::vector<SecondLevelPage> secondLevelPages;
187   uint64_t level2PagesOffset = 0;
188 };
189 
190 UnwindInfoSection::UnwindInfoSection()
191     : SyntheticSection(segment_names::text, section_names::unwindInfo) {
192   align = 4;
193 }
194 
195 // Record function symbols that may need entries emitted in __unwind_info, which
196 // stores unwind data for address ranges.
197 //
198 // Note that if several adjacent functions have the same unwind encoding, LSDA,
199 // and personality function, they share one unwind entry. For this to work,
200 // functions without unwind info need explicit "no unwind info" unwind entries
201 // -- else the unwinder would think they have the unwind info of the closest
202 // function with unwind info right before in the image. Thus, we add function
203 // symbols for each unique address regardless of whether they have associated
204 // unwind info.
205 void UnwindInfoSection::addSymbol(const Defined *d) {
206   if (d->unwindEntry)
207     allEntriesAreOmitted = false;
208   // We don't yet know the final output address of this symbol, but we know that
209   // they are uniquely determined by a combination of the isec and value, so
210   // we use that as the key here.
211   auto p = symbols.insert({{d->isec, d->value}, d});
212   // If we have multiple symbols at the same address, only one of them can have
213   // an associated CUE.
214   if (!p.second && d->unwindEntry) {
215     assert(!p.first->second->unwindEntry);
216     p.first->second = d;
217   }
218 }
219 
220 void UnwindInfoSectionImpl::prepareRelocations() {
221   // This iteration needs to be deterministic, since prepareRelocations may add
222   // entries to the GOT. Hence the use of a MapVector for
223   // UnwindInfoSection::symbols.
224   for (const Defined *d : make_second_range(symbols))
225     if (d->unwindEntry)
226       prepareRelocations(d->unwindEntry);
227 }
228 
229 // Compact unwind relocations have different semantics, so we handle them in a
230 // separate code path from regular relocations. First, we do not wish to add
231 // rebase opcodes for __LD,__compact_unwind, because that section doesn't
232 // actually end up in the final binary. Second, personality pointers always
233 // reside in the GOT and must be treated specially.
234 void UnwindInfoSectionImpl::prepareRelocations(ConcatInputSection *isec) {
235   assert(!isec->shouldOmitFromOutput() &&
236          "__compact_unwind section should not be omitted");
237 
238   // FIXME: Make this skip relocations for CompactUnwindEntries that
239   // point to dead-stripped functions. That might save some amount of
240   // work. But since there are usually just few personality functions
241   // that are referenced from many places, at least some of them likely
242   // live, it wouldn't reduce number of got entries.
243   for (size_t i = 0; i < isec->relocs.size(); ++i) {
244     Reloc &r = isec->relocs[i];
245     assert(target->hasAttr(r.type, RelocAttrBits::UNSIGNED));
246 
247     // Functions and LSDA entries always reside in the same object file as the
248     // compact unwind entries that references them, and thus appear as section
249     // relocs. There is no need to prepare them. We only prepare relocs for
250     // personality functions.
251     if (r.offset != cuOffsets.personality)
252       continue;
253 
254     if (auto *s = r.referent.dyn_cast<Symbol *>()) {
255       // Personality functions are nearly always system-defined (e.g.,
256       // ___gxx_personality_v0 for C++) and relocated as dylib symbols.  When an
257       // application provides its own personality function, it might be
258       // referenced by an extern Defined symbol reloc, or a local section reloc.
259       if (auto *defined = dyn_cast<Defined>(s)) {
260         // XXX(vyng) This is a a special case for handling duplicate personality
261         // symbols. Note that LD64's behavior is a bit different and it is
262         // inconsistent with how symbol resolution usually work
263         //
264         // So we've decided not to follow it. Instead, simply pick the symbol
265         // with the same name from the symbol table to replace the local one.
266         //
267         // (See discussions/alternatives already considered on D107533)
268         if (!defined->isExternal())
269           if (Symbol *sym = symtab->find(defined->getName()))
270             if (!sym->isLazy())
271               r.referent = s = sym;
272       }
273       if (auto *undefined = dyn_cast<Undefined>(s)) {
274         treatUndefinedSymbol(*undefined);
275         // treatUndefinedSymbol() can replace s with a DylibSymbol; re-check.
276         if (isa<Undefined>(s))
277           continue;
278       }
279 
280       if (auto *defined = dyn_cast<Defined>(s)) {
281         // Check if we have created a synthetic symbol at the same address.
282         Symbol *&personality =
283             personalityTable[{defined->isec, defined->value}];
284         if (personality == nullptr) {
285           personality = defined;
286           in.got->addEntry(defined);
287         } else if (personality != defined) {
288           r.referent = personality;
289         }
290         continue;
291       }
292       assert(isa<DylibSymbol>(s));
293       in.got->addEntry(s);
294       continue;
295     }
296 
297     if (auto *referentIsec = r.referent.dyn_cast<InputSection *>()) {
298       assert(!isCoalescedWeak(referentIsec));
299       // Personality functions can be referenced via section relocations
300       // if they live in the same object file. Create placeholder synthetic
301       // symbols for them in the GOT.
302       Symbol *&s = personalityTable[{referentIsec, r.addend}];
303       if (s == nullptr) {
304         // This runs after dead stripping, so the noDeadStrip argument does not
305         // matter.
306         s = make<Defined>("<internal>", /*file=*/nullptr, referentIsec,
307                           r.addend, /*size=*/0, /*isWeakDef=*/false,
308                           /*isExternal=*/false, /*isPrivateExtern=*/false,
309                           /*includeInSymtab=*/true,
310                           /*isThumb=*/false, /*isReferencedDynamically=*/false,
311                           /*noDeadStrip=*/false);
312         in.got->addEntry(s);
313       }
314       r.referent = s;
315       r.addend = 0;
316     }
317   }
318 }
319 
320 // We need to apply the relocations to the pre-link compact unwind section
321 // before converting it to post-link form. There should only be absolute
322 // relocations here: since we are not emitting the pre-link CU section, there
323 // is no source address to make a relative location meaningful.
324 void UnwindInfoSectionImpl::relocateCompactUnwind(
325     std::vector<CompactUnwindEntry> &cuEntries) {
326   parallelForEachN(0, symbolsVec.size(), [&](size_t i) {
327     CompactUnwindEntry &cu = cuEntries[i];
328     const Defined *d = symbolsVec[i].second;
329     cu.functionAddress = d->getVA();
330     if (!d->unwindEntry)
331       return;
332 
333     auto buf = reinterpret_cast<const uint8_t *>(d->unwindEntry->data.data()) -
334                target->wordSize;
335     cu.functionLength =
336         support::endian::read32le(buf + cuOffsets.functionLength);
337     cu.encoding = support::endian::read32le(buf + cuOffsets.encoding);
338     for (const Reloc &r : d->unwindEntry->relocs) {
339       if (r.offset == cuOffsets.personality) {
340         cu.personality = r.referent.get<Symbol *>();
341       } else if (r.offset == cuOffsets.lsda) {
342         if (auto *referentSym = r.referent.dyn_cast<Symbol *>())
343           cu.lsda = cast<Defined>(referentSym)->isec;
344         else
345           cu.lsda = r.referent.get<InputSection *>();
346       }
347     }
348   });
349 }
350 
351 // There should only be a handful of unique personality pointers, so we can
352 // encode them as 2-bit indices into a small array.
353 void UnwindInfoSectionImpl::encodePersonalities() {
354   for (size_t idx : cuIndices) {
355     CompactUnwindEntry &cu = cuEntries[idx];
356     if (cu.personality == nullptr)
357       continue;
358     // Linear search is fast enough for a small array.
359     auto it = find(personalities, cu.personality);
360     uint32_t personalityIndex; // 1-based index
361     if (it != personalities.end()) {
362       personalityIndex = std::distance(personalities.begin(), it) + 1;
363     } else {
364       personalities.push_back(cu.personality);
365       personalityIndex = personalities.size();
366     }
367     cu.encoding |=
368         personalityIndex << countTrailingZeros(
369             static_cast<compact_unwind_encoding_t>(UNWIND_PERSONALITY_MASK));
370   }
371   if (personalities.size() > 3)
372     error("too many personalities (" + Twine(personalities.size()) +
373           ") for compact unwind to encode");
374 }
375 
376 static bool canFoldEncoding(compact_unwind_encoding_t encoding) {
377   // From compact_unwind_encoding.h:
378   //  UNWIND_X86_64_MODE_STACK_IND:
379   //  A "frameless" (RBP not used as frame pointer) function large constant
380   //  stack size.  This case is like the previous, except the stack size is too
381   //  large to encode in the compact unwind encoding.  Instead it requires that
382   //  the function contains "subq $nnnnnnnn,RSP" in its prolog.  The compact
383   //  encoding contains the offset to the nnnnnnnn value in the function in
384   //  UNWIND_X86_64_FRAMELESS_STACK_SIZE.
385   // Since this means the unwinder has to look at the `subq` in the function
386   // of the unwind info's unwind address, two functions that have identical
387   // unwind info can't be folded if it's using this encoding since both
388   // entries need unique addresses.
389   static_assert(UNWIND_X86_64_MODE_MASK == UNWIND_X86_MODE_MASK, "");
390   static_assert(UNWIND_X86_64_MODE_STACK_IND == UNWIND_X86_MODE_STACK_IND, "");
391   if ((target->cpuType == CPU_TYPE_X86_64 || target->cpuType == CPU_TYPE_X86) &&
392       (encoding & UNWIND_X86_64_MODE_MASK) == UNWIND_X86_64_MODE_STACK_IND) {
393     // FIXME: Consider passing in the two function addresses and getting
394     // their two stack sizes off the `subq` and only returning false if they're
395     // actually different.
396     return false;
397   }
398   return true;
399 }
400 
401 // Scan the __LD,__compact_unwind entries and compute the space needs of
402 // __TEXT,__unwind_info and __TEXT,__eh_frame.
403 void UnwindInfoSectionImpl::finalize() {
404   if (symbols.empty())
405     return;
406 
407   // At this point, the address space for __TEXT,__text has been
408   // assigned, so we can relocate the __LD,__compact_unwind entries
409   // into a temporary buffer. Relocation is necessary in order to sort
410   // the CU entries by function address. Sorting is necessary so that
411   // we can fold adjacent CU entries with identical
412   // encoding+personality+lsda. Folding is necessary because it reduces
413   // the number of CU entries by as much as 3 orders of magnitude!
414   cuEntries.resize(symbols.size());
415   // The "map" part of the symbols MapVector was only needed for deduplication
416   // in addSymbol(). Now that we are done adding, move the contents to a plain
417   // std::vector for indexed access.
418   symbolsVec = symbols.takeVector();
419   relocateCompactUnwind(cuEntries);
420 
421   // Rather than sort & fold the 32-byte entries directly, we create a
422   // vector of indices to entries and sort & fold that instead.
423   cuIndices.resize(cuEntries.size());
424   std::iota(cuIndices.begin(), cuIndices.end(), 0);
425   llvm::sort(cuIndices, [&](size_t a, size_t b) {
426     return cuEntries[a].functionAddress < cuEntries[b].functionAddress;
427   });
428 
429   // Fold adjacent entries with matching encoding+personality+lsda
430   // We use three iterators on the same cuIndices to fold in-situ:
431   // (1) `foldBegin` is the first of a potential sequence of matching entries
432   // (2) `foldEnd` is the first non-matching entry after `foldBegin`.
433   // The semi-open interval [ foldBegin .. foldEnd ) contains a range
434   // entries that can be folded into a single entry and written to ...
435   // (3) `foldWrite`
436   auto foldWrite = cuIndices.begin();
437   for (auto foldBegin = cuIndices.begin(); foldBegin < cuIndices.end();) {
438     auto foldEnd = foldBegin;
439     while (++foldEnd < cuIndices.end() &&
440            cuEntries[*foldBegin].encoding == cuEntries[*foldEnd].encoding &&
441            cuEntries[*foldBegin].personality ==
442                cuEntries[*foldEnd].personality &&
443            cuEntries[*foldBegin].lsda == cuEntries[*foldEnd].lsda &&
444            canFoldEncoding(cuEntries[*foldEnd].encoding))
445       ;
446     *foldWrite++ = *foldBegin;
447     foldBegin = foldEnd;
448   }
449   cuIndices.erase(foldWrite, cuIndices.end());
450 
451   encodePersonalities();
452 
453   // Count frequencies of the folded encodings
454   EncodingMap encodingFrequencies;
455   for (size_t idx : cuIndices)
456     encodingFrequencies[cuEntries[idx].encoding]++;
457 
458   // Make a vector of encodings, sorted by descending frequency
459   for (const auto &frequency : encodingFrequencies)
460     commonEncodings.emplace_back(frequency);
461   llvm::sort(commonEncodings,
462              [](const std::pair<compact_unwind_encoding_t, size_t> &a,
463                 const std::pair<compact_unwind_encoding_t, size_t> &b) {
464                if (a.second == b.second)
465                  // When frequencies match, secondarily sort on encoding
466                  // to maintain parity with validate-unwind-info.py
467                  return a.first > b.first;
468                return a.second > b.second;
469              });
470 
471   // Truncate the vector to 127 elements.
472   // Common encoding indexes are limited to 0..126, while encoding
473   // indexes 127..255 are local to each second-level page
474   if (commonEncodings.size() > COMMON_ENCODINGS_MAX)
475     commonEncodings.resize(COMMON_ENCODINGS_MAX);
476 
477   // Create a map from encoding to common-encoding-table index
478   for (size_t i = 0; i < commonEncodings.size(); i++)
479     commonEncodingIndexes[commonEncodings[i].first] = i;
480 
481   // Split folded encodings into pages, where each page is limited by ...
482   // (a) 4 KiB capacity
483   // (b) 24-bit difference between first & final function address
484   // (c) 8-bit compact-encoding-table index,
485   //     for which 0..126 references the global common-encodings table,
486   //     and 127..255 references a local per-second-level-page table.
487   // First we try the compact format and determine how many entries fit.
488   // If more entries fit in the regular format, we use that.
489   for (size_t i = 0; i < cuIndices.size();) {
490     size_t idx = cuIndices[i];
491     secondLevelPages.emplace_back();
492     SecondLevelPage &page = secondLevelPages.back();
493     page.entryIndex = i;
494     uintptr_t functionAddressMax =
495         cuEntries[idx].functionAddress + COMPRESSED_ENTRY_FUNC_OFFSET_MASK;
496     size_t n = commonEncodings.size();
497     size_t wordsRemaining =
498         SECOND_LEVEL_PAGE_WORDS -
499         sizeof(unwind_info_compressed_second_level_page_header) /
500             sizeof(uint32_t);
501     while (wordsRemaining >= 1 && i < cuIndices.size()) {
502       idx = cuIndices[i];
503       const CompactUnwindEntry *cuPtr = &cuEntries[idx];
504       if (cuPtr->functionAddress >= functionAddressMax) {
505         break;
506       } else if (commonEncodingIndexes.count(cuPtr->encoding) ||
507                  page.localEncodingIndexes.count(cuPtr->encoding)) {
508         i++;
509         wordsRemaining--;
510       } else if (wordsRemaining >= 2 && n < COMPACT_ENCODINGS_MAX) {
511         page.localEncodings.emplace_back(cuPtr->encoding);
512         page.localEncodingIndexes[cuPtr->encoding] = n++;
513         i++;
514         wordsRemaining -= 2;
515       } else {
516         break;
517       }
518     }
519     page.entryCount = i - page.entryIndex;
520 
521     // If this is not the final page, see if it's possible to fit more
522     // entries by using the regular format. This can happen when there
523     // are many unique encodings, and we we saturated the local
524     // encoding table early.
525     if (i < cuIndices.size() &&
526         page.entryCount < REGULAR_SECOND_LEVEL_ENTRIES_MAX) {
527       page.kind = UNWIND_SECOND_LEVEL_REGULAR;
528       page.entryCount = std::min(REGULAR_SECOND_LEVEL_ENTRIES_MAX,
529                                  cuIndices.size() - page.entryIndex);
530       i = page.entryIndex + page.entryCount;
531     } else {
532       page.kind = UNWIND_SECOND_LEVEL_COMPRESSED;
533     }
534   }
535 
536   for (size_t idx : cuIndices) {
537     lsdaIndex[idx] = entriesWithLsda.size();
538     if (cuEntries[idx].lsda)
539       entriesWithLsda.push_back(idx);
540   }
541 
542   // compute size of __TEXT,__unwind_info section
543   level2PagesOffset = sizeof(unwind_info_section_header) +
544                       commonEncodings.size() * sizeof(uint32_t) +
545                       personalities.size() * sizeof(uint32_t) +
546                       // The extra second-level-page entry is for the sentinel
547                       (secondLevelPages.size() + 1) *
548                           sizeof(unwind_info_section_header_index_entry) +
549                       entriesWithLsda.size() *
550                           sizeof(unwind_info_section_header_lsda_index_entry);
551   unwindInfoSize =
552       level2PagesOffset + secondLevelPages.size() * SECOND_LEVEL_PAGE_BYTES;
553 }
554 
555 // All inputs are relocated and output addresses are known, so write!
556 
557 void UnwindInfoSectionImpl::writeTo(uint8_t *buf) const {
558   assert(!cuIndices.empty() && "call only if there is unwind info");
559 
560   // section header
561   auto *uip = reinterpret_cast<unwind_info_section_header *>(buf);
562   uip->version = 1;
563   uip->commonEncodingsArraySectionOffset = sizeof(unwind_info_section_header);
564   uip->commonEncodingsArrayCount = commonEncodings.size();
565   uip->personalityArraySectionOffset =
566       uip->commonEncodingsArraySectionOffset +
567       (uip->commonEncodingsArrayCount * sizeof(uint32_t));
568   uip->personalityArrayCount = personalities.size();
569   uip->indexSectionOffset = uip->personalityArraySectionOffset +
570                             (uip->personalityArrayCount * sizeof(uint32_t));
571   uip->indexCount = secondLevelPages.size() + 1;
572 
573   // Common encodings
574   auto *i32p = reinterpret_cast<uint32_t *>(&uip[1]);
575   for (const auto &encoding : commonEncodings)
576     *i32p++ = encoding.first;
577 
578   // Personalities
579   for (const Symbol *personality : personalities)
580     *i32p++ = personality->getGotVA() - in.header->addr;
581 
582   // Level-1 index
583   uint32_t lsdaOffset =
584       uip->indexSectionOffset +
585       uip->indexCount * sizeof(unwind_info_section_header_index_entry);
586   uint64_t l2PagesOffset = level2PagesOffset;
587   auto *iep = reinterpret_cast<unwind_info_section_header_index_entry *>(i32p);
588   for (const SecondLevelPage &page : secondLevelPages) {
589     size_t idx = cuIndices[page.entryIndex];
590     iep->functionOffset = cuEntries[idx].functionAddress - in.header->addr;
591     iep->secondLevelPagesSectionOffset = l2PagesOffset;
592     iep->lsdaIndexArraySectionOffset =
593         lsdaOffset + lsdaIndex.lookup(idx) *
594                          sizeof(unwind_info_section_header_lsda_index_entry);
595     iep++;
596     l2PagesOffset += SECOND_LEVEL_PAGE_BYTES;
597   }
598   // Level-1 sentinel
599   const CompactUnwindEntry &cuEnd = cuEntries[cuIndices.back()];
600   iep->functionOffset =
601       cuEnd.functionAddress - in.header->addr + cuEnd.functionLength;
602   iep->secondLevelPagesSectionOffset = 0;
603   iep->lsdaIndexArraySectionOffset =
604       lsdaOffset + entriesWithLsda.size() *
605                        sizeof(unwind_info_section_header_lsda_index_entry);
606   iep++;
607 
608   // LSDAs
609   auto *lep =
610       reinterpret_cast<unwind_info_section_header_lsda_index_entry *>(iep);
611   for (size_t idx : entriesWithLsda) {
612     const CompactUnwindEntry &cu = cuEntries[idx];
613     lep->lsdaOffset = cu.lsda->getVA(/*off=*/0) - in.header->addr;
614     lep->functionOffset = cu.functionAddress - in.header->addr;
615     lep++;
616   }
617 
618   // Level-2 pages
619   auto *pp = reinterpret_cast<uint32_t *>(lep);
620   for (const SecondLevelPage &page : secondLevelPages) {
621     if (page.kind == UNWIND_SECOND_LEVEL_COMPRESSED) {
622       uintptr_t functionAddressBase =
623           cuEntries[cuIndices[page.entryIndex]].functionAddress;
624       auto *p2p =
625           reinterpret_cast<unwind_info_compressed_second_level_page_header *>(
626               pp);
627       p2p->kind = page.kind;
628       p2p->entryPageOffset =
629           sizeof(unwind_info_compressed_second_level_page_header);
630       p2p->entryCount = page.entryCount;
631       p2p->encodingsPageOffset =
632           p2p->entryPageOffset + p2p->entryCount * sizeof(uint32_t);
633       p2p->encodingsCount = page.localEncodings.size();
634       auto *ep = reinterpret_cast<uint32_t *>(&p2p[1]);
635       for (size_t i = 0; i < page.entryCount; i++) {
636         const CompactUnwindEntry &cue =
637             cuEntries[cuIndices[page.entryIndex + i]];
638         auto it = commonEncodingIndexes.find(cue.encoding);
639         if (it == commonEncodingIndexes.end())
640           it = page.localEncodingIndexes.find(cue.encoding);
641         *ep++ = (it->second << COMPRESSED_ENTRY_FUNC_OFFSET_BITS) |
642                 (cue.functionAddress - functionAddressBase);
643       }
644       if (!page.localEncodings.empty())
645         memcpy(ep, page.localEncodings.data(),
646                page.localEncodings.size() * sizeof(uint32_t));
647     } else {
648       auto *p2p =
649           reinterpret_cast<unwind_info_regular_second_level_page_header *>(pp);
650       p2p->kind = page.kind;
651       p2p->entryPageOffset =
652           sizeof(unwind_info_regular_second_level_page_header);
653       p2p->entryCount = page.entryCount;
654       auto *ep = reinterpret_cast<uint32_t *>(&p2p[1]);
655       for (size_t i = 0; i < page.entryCount; i++) {
656         const CompactUnwindEntry &cue =
657             cuEntries[cuIndices[page.entryIndex + i]];
658         *ep++ = cue.functionAddress;
659         *ep++ = cue.encoding;
660       }
661     }
662     pp += SECOND_LEVEL_PAGE_WORDS;
663   }
664 }
665 
666 UnwindInfoSection *macho::makeUnwindInfoSection() {
667   return make<UnwindInfoSectionImpl>();
668 }
669