Write relocation sections contiguously.
[oota-llvm.git] / lib / MC / ELFObjectWriter.cpp
1 //===- lib/MC/ELFObjectWriter.cpp - ELF File Writer -----------------------===//
2 //
3 //                     The LLVM Compiler Infrastructure
4 //
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
7 //
8 //===----------------------------------------------------------------------===//
9 //
10 // This file implements ELF object file writer information.
11 //
12 //===----------------------------------------------------------------------===//
13
14 #include "llvm/MC/MCELFObjectWriter.h"
15 #include "llvm/ADT/STLExtras.h"
16 #include "llvm/ADT/SmallPtrSet.h"
17 #include "llvm/ADT/SmallString.h"
18 #include "llvm/ADT/StringMap.h"
19 #include "llvm/MC/MCAsmBackend.h"
20 #include "llvm/MC/MCAsmInfo.h"
21 #include "llvm/MC/MCAsmLayout.h"
22 #include "llvm/MC/MCAssembler.h"
23 #include "llvm/MC/MCContext.h"
24 #include "llvm/MC/MCELF.h"
25 #include "llvm/MC/MCELFSymbolFlags.h"
26 #include "llvm/MC/MCExpr.h"
27 #include "llvm/MC/MCFixupKindInfo.h"
28 #include "llvm/MC/MCObjectWriter.h"
29 #include "llvm/MC/MCSectionELF.h"
30 #include "llvm/MC/MCValue.h"
31 #include "llvm/MC/StringTableBuilder.h"
32 #include "llvm/Support/Compression.h"
33 #include "llvm/Support/Debug.h"
34 #include "llvm/Support/ELF.h"
35 #include "llvm/Support/Endian.h"
36 #include "llvm/Support/ErrorHandling.h"
37 #include <vector>
38 using namespace llvm;
39
40 #undef  DEBUG_TYPE
41 #define DEBUG_TYPE "reloc-info"
42
43 namespace {
44 class FragmentWriter {
45   bool IsLittleEndian;
46
47 public:
48   FragmentWriter(bool IsLittleEndian);
49   template <typename T> void write(MCDataFragment &F, T Val);
50 };
51
52 typedef DenseMap<const MCSectionELF *, uint32_t> SectionIndexMapTy;
53
54 class SymbolTableWriter {
55   MCAssembler &Asm;
56   FragmentWriter &FWriter;
57   bool Is64Bit;
58   SectionIndexMapTy &SectionIndexMap;
59
60   // The symbol .symtab fragment we are writting to.
61   MCDataFragment *SymtabF;
62
63   // .symtab_shndx fragment we are writting to.
64   MCDataFragment *ShndxF;
65
66   // The numbel of symbols written so far.
67   unsigned NumWritten;
68
69   void createSymtabShndx();
70
71   template <typename T> void write(MCDataFragment &F, T Value);
72
73 public:
74   SymbolTableWriter(MCAssembler &Asm, FragmentWriter &FWriter, bool Is64Bit,
75                     SectionIndexMapTy &SectionIndexMap,
76                     MCDataFragment *SymtabF);
77
78   void writeSymbol(uint32_t name, uint8_t info, uint64_t value, uint64_t size,
79                    uint8_t other, uint32_t shndx, bool Reserved);
80 };
81
82 class ELFObjectWriter : public MCObjectWriter {
83   FragmentWriter FWriter;
84
85   protected:
86
87     static bool isFixupKindPCRel(const MCAssembler &Asm, unsigned Kind);
88     static bool RelocNeedsGOT(MCSymbolRefExpr::VariantKind Variant);
89     static uint64_t SymbolValue(MCSymbolData &Data, const MCAsmLayout &Layout);
90     static bool isInSymtab(const MCAsmLayout &Layout, const MCSymbolData &Data,
91                            bool Used, bool Renamed);
92     static bool isLocal(const MCSymbolData &Data, bool isUsedInReloc);
93     static bool IsELFMetaDataSection(const MCSectionData &SD);
94     static uint64_t DataSectionSize(const MCSectionData &SD);
95     static uint64_t GetSectionAddressSize(const MCAsmLayout &Layout,
96                                           const MCSectionData &SD);
97
98     void writeDataSectionData(MCAssembler &Asm, const MCAsmLayout &Layout,
99                               const MCSectionData &SD);
100
101     /// Helper struct for containing some precomputed information on symbols.
102     struct ELFSymbolData {
103       MCSymbolData *SymbolData;
104       uint64_t StringIndex;
105       uint32_t SectionIndex;
106       StringRef Name;
107
108       // Support lexicographic sorting.
109       bool operator<(const ELFSymbolData &RHS) const {
110         unsigned LHSType = MCELF::GetType(*SymbolData);
111         unsigned RHSType = MCELF::GetType(*RHS.SymbolData);
112         if (LHSType == ELF::STT_SECTION && RHSType != ELF::STT_SECTION)
113           return false;
114         if (LHSType != ELF::STT_SECTION && RHSType == ELF::STT_SECTION)
115           return true;
116         if (LHSType == ELF::STT_SECTION && RHSType == ELF::STT_SECTION)
117           return SectionIndex < RHS.SectionIndex;
118         return Name < RHS.Name;
119       }
120     };
121
122     /// The target specific ELF writer instance.
123     std::unique_ptr<MCELFObjectTargetWriter> TargetObjectWriter;
124
125     SmallPtrSet<const MCSymbol *, 16> UsedInReloc;
126     SmallPtrSet<const MCSymbol *, 16> WeakrefUsedInReloc;
127     DenseMap<const MCSymbol *, const MCSymbol *> Renames;
128
129     llvm::DenseMap<const MCSectionData *, std::vector<ELFRelocationEntry>>
130     Relocations;
131     StringTableBuilder ShStrTabBuilder;
132
133     /// @}
134     /// @name Symbol Table Data
135     /// @{
136
137     StringTableBuilder StrTabBuilder;
138     std::vector<uint64_t> FileSymbolData;
139     std::vector<ELFSymbolData> LocalSymbolData;
140     std::vector<ELFSymbolData> ExternalSymbolData;
141     std::vector<ELFSymbolData> UndefinedSymbolData;
142
143     /// @}
144
145     bool NeedsGOT;
146
147     // This holds the symbol table index of the last local symbol.
148     unsigned LastLocalSymbolIndex;
149     // This holds the .strtab section index.
150     unsigned StringTableIndex;
151     // This holds the .symtab section index.
152     unsigned SymbolTableIndex;
153
154     unsigned ShstrtabIndex;
155
156
157     // TargetObjectWriter wrappers.
158     bool is64Bit() const { return TargetObjectWriter->is64Bit(); }
159     bool hasRelocationAddend() const {
160       return TargetObjectWriter->hasRelocationAddend();
161     }
162     unsigned GetRelocType(const MCValue &Target, const MCFixup &Fixup,
163                           bool IsPCRel) const {
164       return TargetObjectWriter->GetRelocType(Target, Fixup, IsPCRel);
165     }
166
167   public:
168     ELFObjectWriter(MCELFObjectTargetWriter *MOTW, raw_pwrite_stream &OS,
169                     bool IsLittleEndian)
170         : MCObjectWriter(OS, IsLittleEndian), FWriter(IsLittleEndian),
171           TargetObjectWriter(MOTW), NeedsGOT(false) {}
172
173     void reset() override {
174       UsedInReloc.clear();
175       WeakrefUsedInReloc.clear();
176       Renames.clear();
177       Relocations.clear();
178       ShStrTabBuilder.clear();
179       StrTabBuilder.clear();
180       FileSymbolData.clear();
181       LocalSymbolData.clear();
182       ExternalSymbolData.clear();
183       UndefinedSymbolData.clear();
184       MCObjectWriter::reset();
185     }
186
187     ~ELFObjectWriter() override;
188
189     void WriteWord(uint64_t W) {
190       if (is64Bit())
191         Write64(W);
192       else
193         Write32(W);
194     }
195
196     template <typename T> void write(MCDataFragment &F, T Value) {
197       FWriter.write(F, Value);
198     }
199
200     void WriteHeader(const MCAssembler &Asm,
201                      unsigned NumberOfSections);
202
203     void WriteSymbol(SymbolTableWriter &Writer, ELFSymbolData &MSD,
204                      const MCAsmLayout &Layout);
205
206     void WriteSymbolTable(MCDataFragment *SymtabF, MCAssembler &Asm,
207                           const MCAsmLayout &Layout,
208                           SectionIndexMapTy &SectionIndexMap);
209
210     bool shouldRelocateWithSymbol(const MCAssembler &Asm,
211                                   const MCSymbolRefExpr *RefA,
212                                   const MCSymbolData *SD, uint64_t C,
213                                   unsigned Type) const;
214
215     void RecordRelocation(MCAssembler &Asm, const MCAsmLayout &Layout,
216                           const MCFragment *Fragment, const MCFixup &Fixup,
217                           MCValue Target, bool &IsPCRel,
218                           uint64_t &FixedValue) override;
219
220     uint64_t getSymbolIndexInSymbolTable(const MCAssembler &Asm,
221                                          const MCSymbol *S);
222
223     // Map from a group section to the signature symbol
224     typedef DenseMap<const MCSectionELF*, const MCSymbol*> GroupMapTy;
225     // Map from a signature symbol to the group section
226     typedef DenseMap<const MCSymbol*, const MCSectionELF*> RevGroupMapTy;
227     // Map from a section to its offset
228     typedef DenseMap<const MCSectionELF*, uint64_t> SectionOffsetMapTy;
229
230     /// Compute the symbol table data
231     ///
232     /// \param Asm - The assembler.
233     /// \param SectionIndexMap - Maps a section to its index.
234     /// \param RevGroupMap - Maps a signature symbol to the group section.
235     void computeSymbolTable(MCAssembler &Asm, const MCAsmLayout &Layout,
236                             const SectionIndexMapTy &SectionIndexMap,
237                             const RevGroupMapTy &RevGroupMap);
238
239     void computeIndexMap(MCAssembler &Asm, SectionIndexMapTy &SectionIndexMap);
240
241     MCSectionData *createRelocationSection(MCAssembler &Asm,
242                                            const MCSectionData &SD);
243
244     void CompressDebugSections(MCAssembler &Asm, MCAsmLayout &Layout);
245
246     void WriteRelocations(MCAssembler &Asm, MCAsmLayout &Layout);
247
248     void CreateMetadataSections(MCAssembler &Asm, MCAsmLayout &Layout,
249                                 SectionIndexMapTy &SectionIndexMap);
250
251     // Create the sections that show up in the symbol table. Currently
252     // those are the .note.GNU-stack section and the group sections.
253     void createIndexedSections(MCAssembler &Asm, MCAsmLayout &Layout,
254                                GroupMapTy &GroupMap, RevGroupMapTy &RevGroupMap,
255                                SectionIndexMapTy &SectionIndexMap);
256
257     void ExecutePostLayoutBinding(MCAssembler &Asm,
258                                   const MCAsmLayout &Layout) override;
259
260     void writeSectionHeader(ArrayRef<const MCSectionELF *> Sections,
261                             MCAssembler &Asm, const GroupMapTy &GroupMap,
262                             const MCAsmLayout &Layout,
263                             const SectionIndexMapTy &SectionIndexMap,
264                             const SectionOffsetMapTy &SectionOffsetMap);
265
266     void WriteSecHdrEntry(uint32_t Name, uint32_t Type, uint64_t Flags,
267                           uint64_t Address, uint64_t Offset,
268                           uint64_t Size, uint32_t Link, uint32_t Info,
269                           uint64_t Alignment, uint64_t EntrySize);
270
271     void WriteRelocationsFragment(const MCAssembler &Asm,
272                                   MCDataFragment *F,
273                                   const MCSectionData *SD);
274
275     bool
276     IsSymbolRefDifferenceFullyResolvedImpl(const MCAssembler &Asm,
277                                            const MCSymbolData &DataA,
278                                            const MCSymbolData *DataB,
279                                            const MCFragment &FB,
280                                            bool InSet,
281                                            bool IsPCRel) const override;
282
283     bool isWeak(const MCSymbolData &SD) const override;
284
285     void WriteObject(MCAssembler &Asm, const MCAsmLayout &Layout) override;
286     void writeSection(MCAssembler &Asm,
287                       const SectionIndexMapTy &SectionIndexMap,
288                       uint32_t GroupSymbolIndex,
289                       uint64_t Offset, uint64_t Size, uint64_t Alignment,
290                       const MCSectionELF &Section);
291   };
292 }
293
294 FragmentWriter::FragmentWriter(bool IsLittleEndian)
295     : IsLittleEndian(IsLittleEndian) {}
296
297 template <typename T> void FragmentWriter::write(MCDataFragment &F, T Val) {
298   if (IsLittleEndian)
299     Val = support::endian::byte_swap<T, support::little>(Val);
300   else
301     Val = support::endian::byte_swap<T, support::big>(Val);
302   const char *Start = (const char *)&Val;
303   F.getContents().append(Start, Start + sizeof(T));
304 }
305
306 void SymbolTableWriter::createSymtabShndx() {
307   if (ShndxF)
308     return;
309
310   MCContext &Ctx = Asm.getContext();
311   const MCSectionELF *SymtabShndxSection =
312       Ctx.getELFSection(".symtab_shndxr", ELF::SHT_SYMTAB_SHNDX, 0, 4, "");
313   MCSectionData *SymtabShndxSD =
314       &Asm.getOrCreateSectionData(*SymtabShndxSection);
315   SymtabShndxSD->setAlignment(4);
316   ShndxF = new MCDataFragment(SymtabShndxSD);
317   unsigned Index = SectionIndexMap.size() + 1;
318   SectionIndexMap[SymtabShndxSection] = Index;
319
320   for (unsigned I = 0; I < NumWritten; ++I)
321     write(*ShndxF, uint32_t(0));
322 }
323
324 template <typename T>
325 void SymbolTableWriter::write(MCDataFragment &F, T Value) {
326   FWriter.write(F, Value);
327 }
328
329 SymbolTableWriter::SymbolTableWriter(MCAssembler &Asm, FragmentWriter &FWriter,
330                                      bool Is64Bit,
331                                      SectionIndexMapTy &SectionIndexMap,
332                                      MCDataFragment *SymtabF)
333     : Asm(Asm), FWriter(FWriter), Is64Bit(Is64Bit),
334       SectionIndexMap(SectionIndexMap), SymtabF(SymtabF), ShndxF(nullptr),
335       NumWritten(0) {}
336
337 void SymbolTableWriter::writeSymbol(uint32_t name, uint8_t info, uint64_t value,
338                                     uint64_t size, uint8_t other,
339                                     uint32_t shndx, bool Reserved) {
340   bool LargeIndex = shndx >= ELF::SHN_LORESERVE && !Reserved;
341
342   if (LargeIndex)
343     createSymtabShndx();
344
345   if (ShndxF) {
346     if (LargeIndex)
347       write(*ShndxF, shndx);
348     else
349       write(*ShndxF, uint32_t(0));
350   }
351
352   uint16_t Index = LargeIndex ? uint16_t(ELF::SHN_XINDEX) : shndx;
353
354   if (Is64Bit) {
355     write(*SymtabF, name);  // st_name
356     write(*SymtabF, info);  // st_info
357     write(*SymtabF, other); // st_other
358     write(*SymtabF, Index); // st_shndx
359     write(*SymtabF, value); // st_value
360     write(*SymtabF, size);  // st_size
361   } else {
362     write(*SymtabF, name);            // st_name
363     write(*SymtabF, uint32_t(value)); // st_value
364     write(*SymtabF, uint32_t(size));  // st_size
365     write(*SymtabF, info);            // st_info
366     write(*SymtabF, other);           // st_other
367     write(*SymtabF, Index);           // st_shndx
368   }
369
370   ++NumWritten;
371 }
372
373 bool ELFObjectWriter::isFixupKindPCRel(const MCAssembler &Asm, unsigned Kind) {
374   const MCFixupKindInfo &FKI =
375     Asm.getBackend().getFixupKindInfo((MCFixupKind) Kind);
376
377   return FKI.Flags & MCFixupKindInfo::FKF_IsPCRel;
378 }
379
380 bool ELFObjectWriter::RelocNeedsGOT(MCSymbolRefExpr::VariantKind Variant) {
381   switch (Variant) {
382   default:
383     return false;
384   case MCSymbolRefExpr::VK_GOT:
385   case MCSymbolRefExpr::VK_PLT:
386   case MCSymbolRefExpr::VK_GOTPCREL:
387   case MCSymbolRefExpr::VK_GOTOFF:
388   case MCSymbolRefExpr::VK_TPOFF:
389   case MCSymbolRefExpr::VK_TLSGD:
390   case MCSymbolRefExpr::VK_GOTTPOFF:
391   case MCSymbolRefExpr::VK_INDNTPOFF:
392   case MCSymbolRefExpr::VK_NTPOFF:
393   case MCSymbolRefExpr::VK_GOTNTPOFF:
394   case MCSymbolRefExpr::VK_TLSLDM:
395   case MCSymbolRefExpr::VK_DTPOFF:
396   case MCSymbolRefExpr::VK_TLSLD:
397     return true;
398   }
399 }
400
401 ELFObjectWriter::~ELFObjectWriter()
402 {}
403
404 // Emit the ELF header.
405 void ELFObjectWriter::WriteHeader(const MCAssembler &Asm,
406                                   unsigned NumberOfSections) {
407   // ELF Header
408   // ----------
409   //
410   // Note
411   // ----
412   // emitWord method behaves differently for ELF32 and ELF64, writing
413   // 4 bytes in the former and 8 in the latter.
414
415   Write8(0x7f); // e_ident[EI_MAG0]
416   Write8('E');  // e_ident[EI_MAG1]
417   Write8('L');  // e_ident[EI_MAG2]
418   Write8('F');  // e_ident[EI_MAG3]
419
420   Write8(is64Bit() ? ELF::ELFCLASS64 : ELF::ELFCLASS32); // e_ident[EI_CLASS]
421
422   // e_ident[EI_DATA]
423   Write8(isLittleEndian() ? ELF::ELFDATA2LSB : ELF::ELFDATA2MSB);
424
425   Write8(ELF::EV_CURRENT);        // e_ident[EI_VERSION]
426   // e_ident[EI_OSABI]
427   Write8(TargetObjectWriter->getOSABI());
428   Write8(0);                  // e_ident[EI_ABIVERSION]
429
430   WriteZeros(ELF::EI_NIDENT - ELF::EI_PAD);
431
432   Write16(ELF::ET_REL);             // e_type
433
434   Write16(TargetObjectWriter->getEMachine()); // e_machine = target
435
436   Write32(ELF::EV_CURRENT);         // e_version
437   WriteWord(0);                    // e_entry, no entry point in .o file
438   WriteWord(0);                    // e_phoff, no program header for .o
439   WriteWord(0);                     // e_shoff = sec hdr table off in bytes
440
441   // e_flags = whatever the target wants
442   Write32(Asm.getELFHeaderEFlags());
443
444   // e_ehsize = ELF header size
445   Write16(is64Bit() ? sizeof(ELF::Elf64_Ehdr) : sizeof(ELF::Elf32_Ehdr));
446
447   Write16(0);                  // e_phentsize = prog header entry size
448   Write16(0);                  // e_phnum = # prog header entries = 0
449
450   // e_shentsize = Section header entry size
451   Write16(is64Bit() ? sizeof(ELF::Elf64_Shdr) : sizeof(ELF::Elf32_Shdr));
452
453   // e_shnum     = # of section header ents
454   if (NumberOfSections >= ELF::SHN_LORESERVE)
455     Write16(ELF::SHN_UNDEF);
456   else
457     Write16(NumberOfSections);
458
459   // e_shstrndx  = Section # of '.shstrtab'
460   if (ShstrtabIndex >= ELF::SHN_LORESERVE)
461     Write16(ELF::SHN_XINDEX);
462   else
463     Write16(ShstrtabIndex);
464 }
465
466 uint64_t ELFObjectWriter::SymbolValue(MCSymbolData &Data,
467                                       const MCAsmLayout &Layout) {
468   if (Data.isCommon() && Data.isExternal())
469     return Data.getCommonAlignment();
470
471   uint64_t Res;
472   if (!Layout.getSymbolOffset(&Data, Res))
473     return 0;
474
475   if (Layout.getAssembler().isThumbFunc(&Data.getSymbol()))
476     Res |= 1;
477
478   return Res;
479 }
480
481 void ELFObjectWriter::ExecutePostLayoutBinding(MCAssembler &Asm,
482                                                const MCAsmLayout &Layout) {
483   // The presence of symbol versions causes undefined symbols and
484   // versions declared with @@@ to be renamed.
485
486   for (MCSymbolData &OriginalData : Asm.symbols()) {
487     const MCSymbol &Alias = OriginalData.getSymbol();
488
489     // Not an alias.
490     if (!Alias.isVariable())
491       continue;
492     auto *Ref = dyn_cast<MCSymbolRefExpr>(Alias.getVariableValue());
493     if (!Ref)
494       continue;
495     const MCSymbol &Symbol = Ref->getSymbol();
496     MCSymbolData &SD = Asm.getSymbolData(Symbol);
497
498     StringRef AliasName = Alias.getName();
499     size_t Pos = AliasName.find('@');
500     if (Pos == StringRef::npos)
501       continue;
502
503     // Aliases defined with .symvar copy the binding from the symbol they alias.
504     // This is the first place we are able to copy this information.
505     OriginalData.setExternal(SD.isExternal());
506     MCELF::SetBinding(OriginalData, MCELF::GetBinding(SD));
507
508     StringRef Rest = AliasName.substr(Pos);
509     if (!Symbol.isUndefined() && !Rest.startswith("@@@"))
510       continue;
511
512     // FIXME: produce a better error message.
513     if (Symbol.isUndefined() && Rest.startswith("@@") &&
514         !Rest.startswith("@@@"))
515       report_fatal_error("A @@ version cannot be undefined");
516
517     Renames.insert(std::make_pair(&Symbol, &Alias));
518   }
519 }
520
521 static uint8_t mergeTypeForSet(uint8_t origType, uint8_t newType) {
522   uint8_t Type = newType;
523
524   // Propagation rules:
525   // IFUNC > FUNC > OBJECT > NOTYPE
526   // TLS_OBJECT > OBJECT > NOTYPE
527   //
528   // dont let the new type degrade the old type
529   switch (origType) {
530   default:
531     break;
532   case ELF::STT_GNU_IFUNC:
533     if (Type == ELF::STT_FUNC || Type == ELF::STT_OBJECT ||
534         Type == ELF::STT_NOTYPE || Type == ELF::STT_TLS)
535       Type = ELF::STT_GNU_IFUNC;
536     break;
537   case ELF::STT_FUNC:
538     if (Type == ELF::STT_OBJECT || Type == ELF::STT_NOTYPE ||
539         Type == ELF::STT_TLS)
540       Type = ELF::STT_FUNC;
541     break;
542   case ELF::STT_OBJECT:
543     if (Type == ELF::STT_NOTYPE)
544       Type = ELF::STT_OBJECT;
545     break;
546   case ELF::STT_TLS:
547     if (Type == ELF::STT_OBJECT || Type == ELF::STT_NOTYPE ||
548         Type == ELF::STT_GNU_IFUNC || Type == ELF::STT_FUNC)
549       Type = ELF::STT_TLS;
550     break;
551   }
552
553   return Type;
554 }
555
556 void ELFObjectWriter::WriteSymbol(SymbolTableWriter &Writer, ELFSymbolData &MSD,
557                                   const MCAsmLayout &Layout) {
558   MCSymbolData &OrigData = *MSD.SymbolData;
559   assert((!OrigData.getFragment() ||
560           (&OrigData.getFragment()->getParent()->getSection() ==
561            &OrigData.getSymbol().getSection())) &&
562          "The symbol's section doesn't match the fragment's symbol");
563   const MCSymbol *Base = Layout.getBaseSymbol(OrigData.getSymbol());
564
565   // This has to be in sync with when computeSymbolTable uses SHN_ABS or
566   // SHN_COMMON.
567   bool IsReserved = !Base || OrigData.isCommon();
568
569   // Binding and Type share the same byte as upper and lower nibbles
570   uint8_t Binding = MCELF::GetBinding(OrigData);
571   uint8_t Type = MCELF::GetType(OrigData);
572   MCSymbolData *BaseSD = nullptr;
573   if (Base) {
574     BaseSD = &Layout.getAssembler().getSymbolData(*Base);
575     Type = mergeTypeForSet(Type, MCELF::GetType(*BaseSD));
576   }
577   uint8_t Info = (Binding << ELF_STB_Shift) | (Type << ELF_STT_Shift);
578
579   // Other and Visibility share the same byte with Visibility using the lower
580   // 2 bits
581   uint8_t Visibility = MCELF::GetVisibility(OrigData);
582   uint8_t Other = MCELF::getOther(OrigData) << (ELF_STO_Shift - ELF_STV_Shift);
583   Other |= Visibility;
584
585   uint64_t Value = SymbolValue(OrigData, Layout);
586   uint64_t Size = 0;
587
588   const MCExpr *ESize = OrigData.getSize();
589   if (!ESize && Base)
590     ESize = BaseSD->getSize();
591
592   if (ESize) {
593     int64_t Res;
594     if (!ESize->evaluateKnownAbsolute(Res, Layout))
595       report_fatal_error("Size expression must be absolute.");
596     Size = Res;
597   }
598
599   // Write out the symbol table entry
600   Writer.writeSymbol(MSD.StringIndex, Info, Value, Size, Other,
601                      MSD.SectionIndex, IsReserved);
602 }
603
604 void ELFObjectWriter::WriteSymbolTable(MCDataFragment *SymtabF,
605                                        MCAssembler &Asm,
606                                        const MCAsmLayout &Layout,
607                                        SectionIndexMapTy &SectionIndexMap) {
608   // The string table must be emitted first because we need the index
609   // into the string table for all the symbol names.
610
611   // FIXME: Make sure the start of the symbol table is aligned.
612
613   SymbolTableWriter Writer(Asm, FWriter, is64Bit(), SectionIndexMap, SymtabF);
614
615   // The first entry is the undefined symbol entry.
616   Writer.writeSymbol(0, 0, 0, 0, 0, 0, false);
617
618   for (unsigned i = 0, e = FileSymbolData.size(); i != e; ++i) {
619     Writer.writeSymbol(FileSymbolData[i], ELF::STT_FILE | ELF::STB_LOCAL, 0, 0,
620                        ELF::STV_DEFAULT, ELF::SHN_ABS, true);
621   }
622
623   // Write the symbol table entries.
624   LastLocalSymbolIndex = FileSymbolData.size() + LocalSymbolData.size() + 1;
625
626   for (unsigned i = 0, e = LocalSymbolData.size(); i != e; ++i) {
627     ELFSymbolData &MSD = LocalSymbolData[i];
628     WriteSymbol(Writer, MSD, Layout);
629   }
630
631   for (unsigned i = 0, e = ExternalSymbolData.size(); i != e; ++i) {
632     ELFSymbolData &MSD = ExternalSymbolData[i];
633     MCSymbolData &Data = *MSD.SymbolData;
634     assert(((Data.getFlags() & ELF_STB_Global) ||
635             (Data.getFlags() & ELF_STB_Weak)) &&
636            "External symbol requires STB_GLOBAL or STB_WEAK flag");
637     WriteSymbol(Writer, MSD, Layout);
638     if (MCELF::GetBinding(Data) == ELF::STB_LOCAL)
639       LastLocalSymbolIndex++;
640   }
641
642   for (unsigned i = 0, e = UndefinedSymbolData.size(); i != e; ++i) {
643     ELFSymbolData &MSD = UndefinedSymbolData[i];
644     MCSymbolData &Data = *MSD.SymbolData;
645     WriteSymbol(Writer, MSD, Layout);
646     if (MCELF::GetBinding(Data) == ELF::STB_LOCAL)
647       LastLocalSymbolIndex++;
648   }
649 }
650
651 // It is always valid to create a relocation with a symbol. It is preferable
652 // to use a relocation with a section if that is possible. Using the section
653 // allows us to omit some local symbols from the symbol table.
654 bool ELFObjectWriter::shouldRelocateWithSymbol(const MCAssembler &Asm,
655                                                const MCSymbolRefExpr *RefA,
656                                                const MCSymbolData *SD,
657                                                uint64_t C,
658                                                unsigned Type) const {
659   // A PCRel relocation to an absolute value has no symbol (or section). We
660   // represent that with a relocation to a null section.
661   if (!RefA)
662     return false;
663
664   MCSymbolRefExpr::VariantKind Kind = RefA->getKind();
665   switch (Kind) {
666   default:
667     break;
668   // The .odp creation emits a relocation against the symbol ".TOC." which
669   // create a R_PPC64_TOC relocation. However the relocation symbol name
670   // in final object creation should be NULL, since the symbol does not
671   // really exist, it is just the reference to TOC base for the current
672   // object file. Since the symbol is undefined, returning false results
673   // in a relocation with a null section which is the desired result.
674   case MCSymbolRefExpr::VK_PPC_TOCBASE:
675     return false;
676
677   // These VariantKind cause the relocation to refer to something other than
678   // the symbol itself, like a linker generated table. Since the address of
679   // symbol is not relevant, we cannot replace the symbol with the
680   // section and patch the difference in the addend.
681   case MCSymbolRefExpr::VK_GOT:
682   case MCSymbolRefExpr::VK_PLT:
683   case MCSymbolRefExpr::VK_GOTPCREL:
684   case MCSymbolRefExpr::VK_Mips_GOT:
685   case MCSymbolRefExpr::VK_PPC_GOT_LO:
686   case MCSymbolRefExpr::VK_PPC_GOT_HI:
687   case MCSymbolRefExpr::VK_PPC_GOT_HA:
688     return true;
689   }
690
691   // An undefined symbol is not in any section, so the relocation has to point
692   // to the symbol itself.
693   const MCSymbol &Sym = SD->getSymbol();
694   if (Sym.isUndefined())
695     return true;
696
697   unsigned Binding = MCELF::GetBinding(*SD);
698   switch(Binding) {
699   default:
700     llvm_unreachable("Invalid Binding");
701   case ELF::STB_LOCAL:
702     break;
703   case ELF::STB_WEAK:
704     // If the symbol is weak, it might be overridden by a symbol in another
705     // file. The relocation has to point to the symbol so that the linker
706     // can update it.
707     return true;
708   case ELF::STB_GLOBAL:
709     // Global ELF symbols can be preempted by the dynamic linker. The relocation
710     // has to point to the symbol for a reason analogous to the STB_WEAK case.
711     return true;
712   }
713
714   // If a relocation points to a mergeable section, we have to be careful.
715   // If the offset is zero, a relocation with the section will encode the
716   // same information. With a non-zero offset, the situation is different.
717   // For example, a relocation can point 42 bytes past the end of a string.
718   // If we change such a relocation to use the section, the linker would think
719   // that it pointed to another string and subtracting 42 at runtime will
720   // produce the wrong value.
721   auto &Sec = cast<MCSectionELF>(Sym.getSection());
722   unsigned Flags = Sec.getFlags();
723   if (Flags & ELF::SHF_MERGE) {
724     if (C != 0)
725       return true;
726
727     // It looks like gold has a bug (http://sourceware.org/PR16794) and can
728     // only handle section relocations to mergeable sections if using RELA.
729     if (!hasRelocationAddend())
730       return true;
731   }
732
733   // Most TLS relocations use a got, so they need the symbol. Even those that
734   // are just an offset (@tpoff), require a symbol in gold versions before
735   // 5efeedf61e4fe720fd3e9a08e6c91c10abb66d42 (2014-09-26) which fixed
736   // http://sourceware.org/PR16773.
737   if (Flags & ELF::SHF_TLS)
738     return true;
739
740   // If the symbol is a thumb function the final relocation must set the lowest
741   // bit. With a symbol that is done by just having the symbol have that bit
742   // set, so we would lose the bit if we relocated with the section.
743   // FIXME: We could use the section but add the bit to the relocation value.
744   if (Asm.isThumbFunc(&Sym))
745     return true;
746
747   if (TargetObjectWriter->needsRelocateWithSymbol(*SD, Type))
748     return true;
749   return false;
750 }
751
752 static const MCSymbol *getWeakRef(const MCSymbolRefExpr &Ref) {
753   const MCSymbol &Sym = Ref.getSymbol();
754
755   if (Ref.getKind() == MCSymbolRefExpr::VK_WEAKREF)
756     return &Sym;
757
758   if (!Sym.isVariable())
759     return nullptr;
760
761   const MCExpr *Expr = Sym.getVariableValue();
762   const auto *Inner = dyn_cast<MCSymbolRefExpr>(Expr);
763   if (!Inner)
764     return nullptr;
765
766   if (Inner->getKind() == MCSymbolRefExpr::VK_WEAKREF)
767     return &Inner->getSymbol();
768   return nullptr;
769 }
770
771 static bool isWeak(const MCSymbolData &D) {
772   return D.getFlags() & ELF_STB_Weak || MCELF::GetType(D) == ELF::STT_GNU_IFUNC;
773 }
774
775 void ELFObjectWriter::RecordRelocation(MCAssembler &Asm,
776                                        const MCAsmLayout &Layout,
777                                        const MCFragment *Fragment,
778                                        const MCFixup &Fixup, MCValue Target,
779                                        bool &IsPCRel, uint64_t &FixedValue) {
780   const MCSectionData *FixupSection = Fragment->getParent();
781   uint64_t C = Target.getConstant();
782   uint64_t FixupOffset = Layout.getFragmentOffset(Fragment) + Fixup.getOffset();
783
784   if (const MCSymbolRefExpr *RefB = Target.getSymB()) {
785     assert(RefB->getKind() == MCSymbolRefExpr::VK_None &&
786            "Should not have constructed this");
787
788     // Let A, B and C being the components of Target and R be the location of
789     // the fixup. If the fixup is not pcrel, we want to compute (A - B + C).
790     // If it is pcrel, we want to compute (A - B + C - R).
791
792     // In general, ELF has no relocations for -B. It can only represent (A + C)
793     // or (A + C - R). If B = R + K and the relocation is not pcrel, we can
794     // replace B to implement it: (A - R - K + C)
795     if (IsPCRel)
796       Asm.getContext().FatalError(
797           Fixup.getLoc(),
798           "No relocation available to represent this relative expression");
799
800     const MCSymbol &SymB = RefB->getSymbol();
801
802     if (SymB.isUndefined())
803       Asm.getContext().FatalError(
804           Fixup.getLoc(),
805           Twine("symbol '") + SymB.getName() +
806               "' can not be undefined in a subtraction expression");
807
808     assert(!SymB.isAbsolute() && "Should have been folded");
809     const MCSection &SecB = SymB.getSection();
810     if (&SecB != &FixupSection->getSection())
811       Asm.getContext().FatalError(
812           Fixup.getLoc(), "Cannot represent a difference across sections");
813
814     const MCSymbolData &SymBD = Asm.getSymbolData(SymB);
815     if (::isWeak(SymBD))
816       Asm.getContext().FatalError(
817           Fixup.getLoc(), "Cannot represent a subtraction with a weak symbol");
818
819     uint64_t SymBOffset = Layout.getSymbolOffset(&SymBD);
820     uint64_t K = SymBOffset - FixupOffset;
821     IsPCRel = true;
822     C -= K;
823   }
824
825   // We either rejected the fixup or folded B into C at this point.
826   const MCSymbolRefExpr *RefA = Target.getSymA();
827   const MCSymbol *SymA = RefA ? &RefA->getSymbol() : nullptr;
828   const MCSymbolData *SymAD = SymA ? &Asm.getSymbolData(*SymA) : nullptr;
829
830   unsigned Type = GetRelocType(Target, Fixup, IsPCRel);
831   bool RelocateWithSymbol = shouldRelocateWithSymbol(Asm, RefA, SymAD, C, Type);
832   if (!RelocateWithSymbol && SymA && !SymA->isUndefined())
833     C += Layout.getSymbolOffset(SymAD);
834
835   uint64_t Addend = 0;
836   if (hasRelocationAddend()) {
837     Addend = C;
838     C = 0;
839   }
840
841   FixedValue = C;
842
843   // FIXME: What is this!?!?
844   MCSymbolRefExpr::VariantKind Modifier =
845       RefA ? RefA->getKind() : MCSymbolRefExpr::VK_None;
846   if (RelocNeedsGOT(Modifier))
847     NeedsGOT = true;
848
849   if (!RelocateWithSymbol) {
850     const MCSection *SecA =
851         (SymA && !SymA->isUndefined()) ? &SymA->getSection() : nullptr;
852     auto *ELFSec = cast_or_null<MCSectionELF>(SecA);
853     MCSymbol *SectionSymbol =
854         ELFSec ? Asm.getContext().getOrCreateSectionSymbol(*ELFSec)
855                : nullptr;
856     ELFRelocationEntry Rec(FixupOffset, SectionSymbol, Type, Addend);
857     Relocations[FixupSection].push_back(Rec);
858     return;
859   }
860
861   if (SymA) {
862     if (const MCSymbol *R = Renames.lookup(SymA))
863       SymA = R;
864
865     if (const MCSymbol *WeakRef = getWeakRef(*RefA))
866       WeakrefUsedInReloc.insert(WeakRef);
867     else
868       UsedInReloc.insert(SymA);
869   }
870   ELFRelocationEntry Rec(FixupOffset, SymA, Type, Addend);
871   Relocations[FixupSection].push_back(Rec);
872   return;
873 }
874
875
876 uint64_t
877 ELFObjectWriter::getSymbolIndexInSymbolTable(const MCAssembler &Asm,
878                                              const MCSymbol *S) {
879   const MCSymbolData &SD = Asm.getSymbolData(*S);
880   return SD.getIndex();
881 }
882
883 bool ELFObjectWriter::isInSymtab(const MCAsmLayout &Layout,
884                                  const MCSymbolData &Data, bool Used,
885                                  bool Renamed) {
886   const MCSymbol &Symbol = Data.getSymbol();
887   if (Symbol.isVariable()) {
888     const MCExpr *Expr = Symbol.getVariableValue();
889     if (const MCSymbolRefExpr *Ref = dyn_cast<MCSymbolRefExpr>(Expr)) {
890       if (Ref->getKind() == MCSymbolRefExpr::VK_WEAKREF)
891         return false;
892     }
893   }
894
895   if (Used)
896     return true;
897
898   if (Renamed)
899     return false;
900
901   if (Symbol.getName() == "_GLOBAL_OFFSET_TABLE_")
902     return true;
903
904   if (Symbol.isVariable()) {
905     const MCSymbol *Base = Layout.getBaseSymbol(Symbol);
906     if (Base && Base->isUndefined())
907       return false;
908   }
909
910   bool IsGlobal = MCELF::GetBinding(Data) == ELF::STB_GLOBAL;
911   if (!Symbol.isVariable() && Symbol.isUndefined() && !IsGlobal)
912     return false;
913
914   if (Symbol.isTemporary())
915     return false;
916
917   return true;
918 }
919
920 bool ELFObjectWriter::isLocal(const MCSymbolData &Data, bool isUsedInReloc) {
921   if (Data.isExternal())
922     return false;
923
924   const MCSymbol &Symbol = Data.getSymbol();
925   if (Symbol.isDefined())
926     return true;
927
928   if (isUsedInReloc)
929     return false;
930
931   return true;
932 }
933
934 void ELFObjectWriter::computeIndexMap(MCAssembler &Asm,
935                                       SectionIndexMapTy &SectionIndexMap) {
936   unsigned Index = 1;
937   for (MCAssembler::iterator it = Asm.begin(),
938          ie = Asm.end(); it != ie; ++it) {
939     const MCSectionELF &Section =
940       static_cast<const MCSectionELF &>(it->getSection());
941     if (Section.getType() != ELF::SHT_GROUP)
942       continue;
943     SectionIndexMap[&Section] = Index++;
944   }
945
946   std::vector<const MCSectionELF *> RelSections;
947
948   for (MCAssembler::iterator it = Asm.begin(),
949          ie = Asm.end(); it != ie; ++it) {
950     const MCSectionData &SD = *it;
951     const MCSectionELF &Section =
952       static_cast<const MCSectionELF &>(SD.getSection());
953     if (Section.getType() == ELF::SHT_GROUP ||
954         Section.getType() == ELF::SHT_REL ||
955         Section.getType() == ELF::SHT_RELA)
956       continue;
957     SectionIndexMap[&Section] = Index++;
958     if (MCSectionData *RelSD = createRelocationSection(Asm, SD)) {
959       const MCSectionELF *RelSection =
960           static_cast<const MCSectionELF *>(&RelSD->getSection());
961       RelSections.push_back(RelSection);
962     }
963   }
964
965   // Put relocation sections close together. The linker reads them
966   // first, so this improves cache locality.
967   for (const MCSectionELF * Sec: RelSections)
968     SectionIndexMap[Sec] = Index++;
969 }
970
971 void ELFObjectWriter::computeSymbolTable(
972     MCAssembler &Asm, const MCAsmLayout &Layout,
973     const SectionIndexMapTy &SectionIndexMap,
974     const RevGroupMapTy &RevGroupMap) {
975   // FIXME: Is this the correct place to do this?
976   // FIXME: Why is an undefined reference to _GLOBAL_OFFSET_TABLE_ needed?
977   if (NeedsGOT) {
978     StringRef Name = "_GLOBAL_OFFSET_TABLE_";
979     MCSymbol *Sym = Asm.getContext().GetOrCreateSymbol(Name);
980     MCSymbolData &Data = Asm.getOrCreateSymbolData(*Sym);
981     Data.setExternal(true);
982     MCELF::SetBinding(Data, ELF::STB_GLOBAL);
983   }
984
985   // Add the data for the symbols.
986   for (MCSymbolData &SD : Asm.symbols()) {
987     const MCSymbol &Symbol = SD.getSymbol();
988
989     bool Used = UsedInReloc.count(&Symbol);
990     bool WeakrefUsed = WeakrefUsedInReloc.count(&Symbol);
991     bool isSignature = RevGroupMap.count(&Symbol);
992
993     if (!isInSymtab(Layout, SD,
994                     Used || WeakrefUsed || isSignature,
995                     Renames.count(&Symbol)))
996       continue;
997
998     ELFSymbolData MSD;
999     MSD.SymbolData = &SD;
1000     const MCSymbol *BaseSymbol = Layout.getBaseSymbol(Symbol);
1001
1002     // Undefined symbols are global, but this is the first place we
1003     // are able to set it.
1004     bool Local = isLocal(SD, Used);
1005     if (!Local && MCELF::GetBinding(SD) == ELF::STB_LOCAL) {
1006       assert(BaseSymbol);
1007       MCSymbolData &BaseData = Asm.getSymbolData(*BaseSymbol);
1008       MCELF::SetBinding(SD, ELF::STB_GLOBAL);
1009       MCELF::SetBinding(BaseData, ELF::STB_GLOBAL);
1010     }
1011
1012     if (!BaseSymbol) {
1013       MSD.SectionIndex = ELF::SHN_ABS;
1014     } else if (SD.isCommon()) {
1015       assert(!Local);
1016       MSD.SectionIndex = ELF::SHN_COMMON;
1017     } else if (BaseSymbol->isUndefined()) {
1018       if (isSignature && !Used)
1019         MSD.SectionIndex = SectionIndexMap.lookup(RevGroupMap.lookup(&Symbol));
1020       else
1021         MSD.SectionIndex = ELF::SHN_UNDEF;
1022       if (!Used && WeakrefUsed)
1023         MCELF::SetBinding(SD, ELF::STB_WEAK);
1024     } else {
1025       const MCSectionELF &Section =
1026         static_cast<const MCSectionELF&>(BaseSymbol->getSection());
1027       MSD.SectionIndex = SectionIndexMap.lookup(&Section);
1028       assert(MSD.SectionIndex && "Invalid section index!");
1029     }
1030
1031     // The @@@ in symbol version is replaced with @ in undefined symbols and @@
1032     // in defined ones.
1033     //
1034     // FIXME: All name handling should be done before we get to the writer,
1035     // including dealing with GNU-style version suffixes.  Fixing this isn't
1036     // trivial.
1037     //
1038     // We thus have to be careful to not perform the symbol version replacement
1039     // blindly:
1040     //
1041     // The ELF format is used on Windows by the MCJIT engine.  Thus, on
1042     // Windows, the ELFObjectWriter can encounter symbols mangled using the MS
1043     // Visual Studio C++ name mangling scheme. Symbols mangled using the MSVC
1044     // C++ name mangling can legally have "@@@" as a sub-string. In that case,
1045     // the EFLObjectWriter should not interpret the "@@@" sub-string as
1046     // specifying GNU-style symbol versioning. The ELFObjectWriter therefore
1047     // checks for the MSVC C++ name mangling prefix which is either "?", "@?",
1048     // "__imp_?" or "__imp_@?".
1049     //
1050     // It would have been interesting to perform the MS mangling prefix check
1051     // only when the target triple is of the form *-pc-windows-elf. But, it
1052     // seems that this information is not easily accessible from the
1053     // ELFObjectWriter.
1054     StringRef Name = Symbol.getName();
1055     if (!Name.startswith("?") && !Name.startswith("@?") &&
1056         !Name.startswith("__imp_?") && !Name.startswith("__imp_@?")) {
1057       // This symbol isn't following the MSVC C++ name mangling convention. We
1058       // can thus safely interpret the @@@ in symbol names as specifying symbol
1059       // versioning.
1060       SmallString<32> Buf;
1061       size_t Pos = Name.find("@@@");
1062       if (Pos != StringRef::npos) {
1063         Buf += Name.substr(0, Pos);
1064         unsigned Skip = MSD.SectionIndex == ELF::SHN_UNDEF ? 2 : 1;
1065         Buf += Name.substr(Pos + Skip);
1066         Name = Buf;
1067       }
1068     }
1069
1070     // Sections have their own string table
1071     if (MCELF::GetType(SD) != ELF::STT_SECTION)
1072       MSD.Name = StrTabBuilder.add(Name);
1073
1074     if (MSD.SectionIndex == ELF::SHN_UNDEF)
1075       UndefinedSymbolData.push_back(MSD);
1076     else if (Local)
1077       LocalSymbolData.push_back(MSD);
1078     else
1079       ExternalSymbolData.push_back(MSD);
1080   }
1081
1082   for (auto i = Asm.file_names_begin(), e = Asm.file_names_end(); i != e; ++i)
1083     StrTabBuilder.add(*i);
1084
1085   StrTabBuilder.finalize(StringTableBuilder::ELF);
1086
1087   for (auto i = Asm.file_names_begin(), e = Asm.file_names_end(); i != e; ++i)
1088     FileSymbolData.push_back(StrTabBuilder.getOffset(*i));
1089
1090   for (ELFSymbolData &MSD : LocalSymbolData)
1091     MSD.StringIndex = MCELF::GetType(*MSD.SymbolData) == ELF::STT_SECTION
1092                           ? 0
1093                           : StrTabBuilder.getOffset(MSD.Name);
1094   for (ELFSymbolData &MSD : ExternalSymbolData)
1095     MSD.StringIndex = StrTabBuilder.getOffset(MSD.Name);
1096   for (ELFSymbolData& MSD : UndefinedSymbolData)
1097     MSD.StringIndex = StrTabBuilder.getOffset(MSD.Name);
1098
1099   // Symbols are required to be in lexicographic order.
1100   array_pod_sort(LocalSymbolData.begin(), LocalSymbolData.end());
1101   array_pod_sort(ExternalSymbolData.begin(), ExternalSymbolData.end());
1102   array_pod_sort(UndefinedSymbolData.begin(), UndefinedSymbolData.end());
1103
1104   // Set the symbol indices. Local symbols must come before all other
1105   // symbols with non-local bindings.
1106   unsigned Index = FileSymbolData.size() + 1;
1107   for (unsigned i = 0, e = LocalSymbolData.size(); i != e; ++i)
1108     LocalSymbolData[i].SymbolData->setIndex(Index++);
1109
1110   for (unsigned i = 0, e = ExternalSymbolData.size(); i != e; ++i)
1111     ExternalSymbolData[i].SymbolData->setIndex(Index++);
1112   for (unsigned i = 0, e = UndefinedSymbolData.size(); i != e; ++i)
1113     UndefinedSymbolData[i].SymbolData->setIndex(Index++);
1114 }
1115
1116 MCSectionData *
1117 ELFObjectWriter::createRelocationSection(MCAssembler &Asm,
1118                                          const MCSectionData &SD) {
1119   if (Relocations[&SD].empty())
1120     return nullptr;
1121
1122   MCContext &Ctx = Asm.getContext();
1123   const MCSectionELF &Section =
1124       static_cast<const MCSectionELF &>(SD.getSection());
1125
1126   const StringRef SectionName = Section.getSectionName();
1127   std::string RelaSectionName = hasRelocationAddend() ? ".rela" : ".rel";
1128   RelaSectionName += SectionName;
1129
1130   unsigned EntrySize;
1131   if (hasRelocationAddend())
1132     EntrySize = is64Bit() ? sizeof(ELF::Elf64_Rela) : sizeof(ELF::Elf32_Rela);
1133   else
1134     EntrySize = is64Bit() ? sizeof(ELF::Elf64_Rel) : sizeof(ELF::Elf32_Rel);
1135
1136   unsigned Flags = 0;
1137   if (Section.getFlags() & ELF::SHF_GROUP)
1138     Flags = ELF::SHF_GROUP;
1139
1140   const MCSectionELF *RelaSection = Ctx.createELFRelSection(
1141       RelaSectionName, hasRelocationAddend() ? ELF::SHT_RELA : ELF::SHT_REL,
1142       Flags, EntrySize, Section.getGroup(), &Section);
1143   return &Asm.getOrCreateSectionData(*RelaSection);
1144 }
1145
1146 static SmallVector<char, 128>
1147 getUncompressedData(MCAsmLayout &Layout,
1148                     MCSectionData::FragmentListType &Fragments) {
1149   SmallVector<char, 128> UncompressedData;
1150   for (const MCFragment &F : Fragments) {
1151     const SmallVectorImpl<char> *Contents;
1152     switch (F.getKind()) {
1153     case MCFragment::FT_Data:
1154       Contents = &cast<MCDataFragment>(F).getContents();
1155       break;
1156     case MCFragment::FT_Dwarf:
1157       Contents = &cast<MCDwarfLineAddrFragment>(F).getContents();
1158       break;
1159     case MCFragment::FT_DwarfFrame:
1160       Contents = &cast<MCDwarfCallFrameFragment>(F).getContents();
1161       break;
1162     default:
1163       llvm_unreachable(
1164           "Not expecting any other fragment types in a debug_* section");
1165     }
1166     UncompressedData.append(Contents->begin(), Contents->end());
1167   }
1168   return UncompressedData;
1169 }
1170
1171 // Include the debug info compression header:
1172 // "ZLIB" followed by 8 bytes representing the uncompressed size of the section,
1173 // useful for consumers to preallocate a buffer to decompress into.
1174 static bool
1175 prependCompressionHeader(uint64_t Size,
1176                          SmallVectorImpl<char> &CompressedContents) {
1177   const StringRef Magic = "ZLIB";
1178   if (Size <= Magic.size() + sizeof(Size) + CompressedContents.size())
1179     return false;
1180   if (sys::IsLittleEndianHost)
1181     sys::swapByteOrder(Size);
1182   CompressedContents.insert(CompressedContents.begin(),
1183                             Magic.size() + sizeof(Size), 0);
1184   std::copy(Magic.begin(), Magic.end(), CompressedContents.begin());
1185   std::copy(reinterpret_cast<char *>(&Size),
1186             reinterpret_cast<char *>(&Size + 1),
1187             CompressedContents.begin() + Magic.size());
1188   return true;
1189 }
1190
1191 // Return a single fragment containing the compressed contents of the whole
1192 // section. Null if the section was not compressed for any reason.
1193 static std::unique_ptr<MCDataFragment>
1194 getCompressedFragment(MCAsmLayout &Layout,
1195                       MCSectionData::FragmentListType &Fragments) {
1196   std::unique_ptr<MCDataFragment> CompressedFragment(new MCDataFragment());
1197
1198   // Gather the uncompressed data from all the fragments, recording the
1199   // alignment fragment, if seen, and any fixups.
1200   SmallVector<char, 128> UncompressedData =
1201       getUncompressedData(Layout, Fragments);
1202
1203   SmallVectorImpl<char> &CompressedContents = CompressedFragment->getContents();
1204
1205   zlib::Status Success = zlib::compress(
1206       StringRef(UncompressedData.data(), UncompressedData.size()),
1207       CompressedContents);
1208   if (Success != zlib::StatusOK)
1209     return nullptr;
1210
1211   if (!prependCompressionHeader(UncompressedData.size(), CompressedContents))
1212     return nullptr;
1213
1214   return CompressedFragment;
1215 }
1216
1217 typedef DenseMap<const MCSectionData *, std::vector<MCSymbolData *>>
1218 DefiningSymbolMap;
1219
1220 static void UpdateSymbols(const MCAsmLayout &Layout,
1221                           const std::vector<MCSymbolData *> &Symbols,
1222                           MCFragment &NewFragment) {
1223   for (MCSymbolData *Sym : Symbols) {
1224     Sym->setOffset(Sym->getOffset() +
1225                    Layout.getFragmentOffset(Sym->getFragment()));
1226     Sym->setFragment(&NewFragment);
1227   }
1228 }
1229
1230 static void CompressDebugSection(MCAssembler &Asm, MCAsmLayout &Layout,
1231                                  const DefiningSymbolMap &DefiningSymbols,
1232                                  const MCSectionELF &Section,
1233                                  MCSectionData &SD) {
1234   StringRef SectionName = Section.getSectionName();
1235   MCSectionData::FragmentListType &Fragments = SD.getFragmentList();
1236
1237   std::unique_ptr<MCDataFragment> CompressedFragment =
1238       getCompressedFragment(Layout, Fragments);
1239
1240   // Leave the section as-is if the fragments could not be compressed.
1241   if (!CompressedFragment)
1242     return;
1243
1244   // Update the fragment+offsets of any symbols referring to fragments in this
1245   // section to refer to the new fragment.
1246   auto I = DefiningSymbols.find(&SD);
1247   if (I != DefiningSymbols.end())
1248     UpdateSymbols(Layout, I->second, *CompressedFragment);
1249
1250   // Invalidate the layout for the whole section since it will have new and
1251   // different fragments now.
1252   Layout.invalidateFragmentsFrom(&Fragments.front());
1253   Fragments.clear();
1254
1255   // Complete the initialization of the new fragment
1256   CompressedFragment->setParent(&SD);
1257   CompressedFragment->setLayoutOrder(0);
1258   Fragments.push_back(CompressedFragment.release());
1259
1260   // Rename from .debug_* to .zdebug_*
1261   Asm.getContext().renameELFSection(&Section,
1262                                     (".z" + SectionName.drop_front(1)).str());
1263 }
1264
1265 void ELFObjectWriter::CompressDebugSections(MCAssembler &Asm,
1266                                             MCAsmLayout &Layout) {
1267   if (!Asm.getContext().getAsmInfo()->compressDebugSections())
1268     return;
1269
1270   DefiningSymbolMap DefiningSymbols;
1271
1272   for (MCSymbolData &SD : Asm.symbols())
1273     if (MCFragment *F = SD.getFragment())
1274       DefiningSymbols[F->getParent()].push_back(&SD);
1275
1276   for (MCSectionData &SD : Asm) {
1277     const MCSectionELF &Section =
1278         static_cast<const MCSectionELF &>(SD.getSection());
1279     StringRef SectionName = Section.getSectionName();
1280
1281     // Compressing debug_frame requires handling alignment fragments which is
1282     // more work (possibly generalizing MCAssembler.cpp:writeFragment to allow
1283     // for writing to arbitrary buffers) for little benefit.
1284     if (!SectionName.startswith(".debug_") || SectionName == ".debug_frame")
1285       continue;
1286
1287     CompressDebugSection(Asm, Layout, DefiningSymbols, Section, SD);
1288   }
1289 }
1290
1291 void ELFObjectWriter::WriteRelocations(MCAssembler &Asm, MCAsmLayout &Layout) {
1292   for (MCAssembler::iterator it = Asm.begin(), ie = Asm.end(); it != ie; ++it) {
1293     MCSectionData &RelSD = *it;
1294     const MCSectionELF &RelSection =
1295         static_cast<const MCSectionELF &>(RelSD.getSection());
1296
1297     unsigned Type = RelSection.getType();
1298     if (Type != ELF::SHT_REL && Type != ELF::SHT_RELA)
1299       continue;
1300
1301     const MCSectionELF *Section = RelSection.getAssociatedSection();
1302     MCSectionData &SD = Asm.getOrCreateSectionData(*Section);
1303     RelSD.setAlignment(is64Bit() ? 8 : 4);
1304
1305     MCDataFragment *F = new MCDataFragment(&RelSD);
1306     WriteRelocationsFragment(Asm, F, &SD);
1307   }
1308 }
1309
1310 void ELFObjectWriter::WriteSecHdrEntry(uint32_t Name, uint32_t Type,
1311                                        uint64_t Flags, uint64_t Address,
1312                                        uint64_t Offset, uint64_t Size,
1313                                        uint32_t Link, uint32_t Info,
1314                                        uint64_t Alignment,
1315                                        uint64_t EntrySize) {
1316   Write32(Name);        // sh_name: index into string table
1317   Write32(Type);        // sh_type
1318   WriteWord(Flags);     // sh_flags
1319   WriteWord(Address);   // sh_addr
1320   WriteWord(Offset);    // sh_offset
1321   WriteWord(Size);      // sh_size
1322   Write32(Link);        // sh_link
1323   Write32(Info);        // sh_info
1324   WriteWord(Alignment); // sh_addralign
1325   WriteWord(EntrySize); // sh_entsize
1326 }
1327
1328 void ELFObjectWriter::WriteRelocationsFragment(const MCAssembler &Asm,
1329                                                MCDataFragment *F,
1330                                                const MCSectionData *SD) {
1331   std::vector<ELFRelocationEntry> &Relocs = Relocations[SD];
1332
1333   // Sort the relocation entries. Most targets just sort by Offset, but some
1334   // (e.g., MIPS) have additional constraints.
1335   TargetObjectWriter->sortRelocs(Asm, Relocs);
1336
1337   for (unsigned i = 0, e = Relocs.size(); i != e; ++i) {
1338     const ELFRelocationEntry &Entry = Relocs[e - i - 1];
1339     unsigned Index =
1340         Entry.Symbol ? getSymbolIndexInSymbolTable(Asm, Entry.Symbol) : 0;
1341
1342     if (is64Bit()) {
1343       write(*F, Entry.Offset);
1344       if (TargetObjectWriter->isN64()) {
1345         write(*F, uint32_t(Index));
1346
1347         write(*F, TargetObjectWriter->getRSsym(Entry.Type));
1348         write(*F, TargetObjectWriter->getRType3(Entry.Type));
1349         write(*F, TargetObjectWriter->getRType2(Entry.Type));
1350         write(*F, TargetObjectWriter->getRType(Entry.Type));
1351       } else {
1352         struct ELF::Elf64_Rela ERE64;
1353         ERE64.setSymbolAndType(Index, Entry.Type);
1354         write(*F, ERE64.r_info);
1355       }
1356       if (hasRelocationAddend())
1357         write(*F, Entry.Addend);
1358     } else {
1359       write(*F, uint32_t(Entry.Offset));
1360
1361       struct ELF::Elf32_Rela ERE32;
1362       ERE32.setSymbolAndType(Index, Entry.Type);
1363       write(*F, ERE32.r_info);
1364
1365       if (hasRelocationAddend())
1366         write(*F, uint32_t(Entry.Addend));
1367     }
1368   }
1369 }
1370
1371 void ELFObjectWriter::CreateMetadataSections(
1372     MCAssembler &Asm, MCAsmLayout &Layout, SectionIndexMapTy &SectionIndexMap) {
1373   MCContext &Ctx = Asm.getContext();
1374   MCDataFragment *F;
1375
1376   unsigned EntrySize = is64Bit() ? ELF::SYMENTRY_SIZE64 : ELF::SYMENTRY_SIZE32;
1377
1378   // We construct .shstrtab, .symtab and .strtab in this order to match gnu as.
1379   const MCSectionELF *ShstrtabSection =
1380       Ctx.getELFSection(".shstrtab", ELF::SHT_STRTAB, 0);
1381   MCSectionData &ShstrtabSD = Asm.getOrCreateSectionData(*ShstrtabSection);
1382   ShstrtabSD.setAlignment(1);
1383   ShstrtabIndex = SectionIndexMap.size() + 1;
1384   SectionIndexMap[ShstrtabSection] = ShstrtabIndex;
1385
1386   const MCSectionELF *SymtabSection =
1387     Ctx.getELFSection(".symtab", ELF::SHT_SYMTAB, 0,
1388                       EntrySize, "");
1389   MCSectionData &SymtabSD = Asm.getOrCreateSectionData(*SymtabSection);
1390   SymtabSD.setAlignment(is64Bit() ? 8 : 4);
1391   SymbolTableIndex = SectionIndexMap.size() + 1;
1392   SectionIndexMap[SymtabSection] = SymbolTableIndex;
1393
1394   const MCSectionELF *StrtabSection;
1395   StrtabSection = Ctx.getELFSection(".strtab", ELF::SHT_STRTAB, 0);
1396   MCSectionData &StrtabSD = Asm.getOrCreateSectionData(*StrtabSection);
1397   StrtabSD.setAlignment(1);
1398   StringTableIndex = SectionIndexMap.size() + 1;
1399   SectionIndexMap[StrtabSection] = StringTableIndex;
1400
1401   // Symbol table
1402   F = new MCDataFragment(&SymtabSD);
1403   WriteSymbolTable(F, Asm, Layout, SectionIndexMap);
1404
1405   F = new MCDataFragment(&StrtabSD);
1406   F->getContents().append(StrTabBuilder.data().begin(),
1407                           StrTabBuilder.data().end());
1408
1409   F = new MCDataFragment(&ShstrtabSD);
1410
1411   // Section header string table.
1412   for (auto it = Asm.begin(), ie = Asm.end(); it != ie; ++it) {
1413     const MCSectionELF &Section =
1414       static_cast<const MCSectionELF&>(it->getSection());
1415     ShStrTabBuilder.add(Section.getSectionName());
1416   }
1417   ShStrTabBuilder.finalize(StringTableBuilder::ELF);
1418   F->getContents().append(ShStrTabBuilder.data().begin(),
1419                           ShStrTabBuilder.data().end());
1420 }
1421
1422 void ELFObjectWriter::createIndexedSections(
1423     MCAssembler &Asm, MCAsmLayout &Layout, GroupMapTy &GroupMap,
1424     RevGroupMapTy &RevGroupMap, SectionIndexMapTy &SectionIndexMap) {
1425   MCContext &Ctx = Asm.getContext();
1426
1427   // Build the groups
1428   for (MCAssembler::const_iterator it = Asm.begin(), ie = Asm.end();
1429        it != ie; ++it) {
1430     const MCSectionELF &Section =
1431       static_cast<const MCSectionELF&>(it->getSection());
1432     if (!(Section.getFlags() & ELF::SHF_GROUP))
1433       continue;
1434
1435     const MCSymbol *SignatureSymbol = Section.getGroup();
1436     Asm.getOrCreateSymbolData(*SignatureSymbol);
1437     const MCSectionELF *&Group = RevGroupMap[SignatureSymbol];
1438     if (!Group) {
1439       Group = Ctx.CreateELFGroupSection();
1440       MCSectionData &Data = Asm.getOrCreateSectionData(*Group);
1441       Data.setAlignment(4);
1442       MCDataFragment *F = new MCDataFragment(&Data);
1443       write(*F, uint32_t(ELF::GRP_COMDAT));
1444     }
1445     GroupMap[Group] = SignatureSymbol;
1446   }
1447
1448   computeIndexMap(Asm, SectionIndexMap);
1449
1450   // Add sections to the groups
1451   for (MCAssembler::const_iterator it = Asm.begin(), ie = Asm.end();
1452        it != ie; ++it) {
1453     const MCSectionELF &Section =
1454       static_cast<const MCSectionELF&>(it->getSection());
1455     if (!(Section.getFlags() & ELF::SHF_GROUP))
1456       continue;
1457     const MCSectionELF *Group = RevGroupMap[Section.getGroup()];
1458     MCSectionData &Data = Asm.getOrCreateSectionData(*Group);
1459     // FIXME: we could use the previous fragment
1460     MCDataFragment *F = new MCDataFragment(&Data);
1461     uint32_t Index = SectionIndexMap.lookup(&Section);
1462     write(*F, Index);
1463   }
1464 }
1465
1466 void ELFObjectWriter::writeSection(MCAssembler &Asm,
1467                                    const SectionIndexMapTy &SectionIndexMap,
1468                                    uint32_t GroupSymbolIndex,
1469                                    uint64_t Offset, uint64_t Size,
1470                                    uint64_t Alignment,
1471                                    const MCSectionELF &Section) {
1472   uint64_t sh_link = 0;
1473   uint64_t sh_info = 0;
1474
1475   switch(Section.getType()) {
1476   default:
1477     // Nothing to do.
1478     break;
1479
1480   case ELF::SHT_DYNAMIC:
1481     sh_link = ShStrTabBuilder.getOffset(Section.getSectionName());
1482     break;
1483
1484   case ELF::SHT_REL:
1485   case ELF::SHT_RELA: {
1486     sh_link = SymbolTableIndex;
1487     assert(sh_link && ".symtab not found");
1488     const MCSectionELF *InfoSection = Section.getAssociatedSection();
1489     sh_info = SectionIndexMap.lookup(InfoSection);
1490     break;
1491   }
1492
1493   case ELF::SHT_SYMTAB:
1494   case ELF::SHT_DYNSYM:
1495     sh_link = StringTableIndex;
1496     sh_info = LastLocalSymbolIndex;
1497     break;
1498
1499   case ELF::SHT_SYMTAB_SHNDX:
1500     sh_link = SymbolTableIndex;
1501     break;
1502
1503   case ELF::SHT_GROUP:
1504     sh_link = SymbolTableIndex;
1505     sh_info = GroupSymbolIndex;
1506     break;
1507   }
1508
1509   if (TargetObjectWriter->getEMachine() == ELF::EM_ARM &&
1510       Section.getType() == ELF::SHT_ARM_EXIDX)
1511     sh_link = SectionIndexMap.lookup(Section.getAssociatedSection());
1512
1513   WriteSecHdrEntry(ShStrTabBuilder.getOffset(Section.getSectionName()),
1514                    Section.getType(),
1515                    Section.getFlags(), 0, Offset, Size, sh_link, sh_info,
1516                    Alignment, Section.getEntrySize());
1517 }
1518
1519 bool ELFObjectWriter::IsELFMetaDataSection(const MCSectionData &SD) {
1520   return SD.getOrdinal() == ~UINT32_C(0) &&
1521     !SD.getSection().isVirtualSection();
1522 }
1523
1524 uint64_t ELFObjectWriter::DataSectionSize(const MCSectionData &SD) {
1525   uint64_t Ret = 0;
1526   for (MCSectionData::const_iterator i = SD.begin(), e = SD.end(); i != e;
1527        ++i) {
1528     const MCFragment &F = *i;
1529     assert(F.getKind() == MCFragment::FT_Data);
1530     Ret += cast<MCDataFragment>(F).getContents().size();
1531   }
1532   return Ret;
1533 }
1534
1535 uint64_t ELFObjectWriter::GetSectionAddressSize(const MCAsmLayout &Layout,
1536                                                 const MCSectionData &SD) {
1537   if (IsELFMetaDataSection(SD))
1538     return DataSectionSize(SD);
1539   return Layout.getSectionAddressSize(&SD);
1540 }
1541
1542 void ELFObjectWriter::writeDataSectionData(MCAssembler &Asm,
1543                                            const MCAsmLayout &Layout,
1544                                            const MCSectionData &SD) {
1545   if (IsELFMetaDataSection(SD)) {
1546     for (MCSectionData::const_iterator i = SD.begin(), e = SD.end(); i != e;
1547          ++i) {
1548       const MCFragment &F = *i;
1549       assert(F.getKind() == MCFragment::FT_Data);
1550       WriteBytes(cast<MCDataFragment>(F).getContents());
1551     }
1552   } else {
1553     Asm.writeSectionData(&SD, Layout);
1554   }
1555 }
1556
1557 void ELFObjectWriter::writeSectionHeader(
1558     ArrayRef<const MCSectionELF *> Sections, MCAssembler &Asm,
1559     const GroupMapTy &GroupMap, const MCAsmLayout &Layout,
1560     const SectionIndexMapTy &SectionIndexMap,
1561     const SectionOffsetMapTy &SectionOffsetMap) {
1562   const unsigned NumSections = Asm.size();
1563
1564   // Null section first.
1565   uint64_t FirstSectionSize =
1566       (NumSections + 1) >= ELF::SHN_LORESERVE ? NumSections + 1 : 0;
1567   uint32_t FirstSectionLink =
1568     ShstrtabIndex >= ELF::SHN_LORESERVE ? ShstrtabIndex : 0;
1569   WriteSecHdrEntry(0, 0, 0, 0, 0, FirstSectionSize, FirstSectionLink, 0, 0, 0);
1570
1571   for (unsigned i = 0; i < NumSections; ++i) {
1572     const MCSectionELF &Section = *Sections[i];
1573     const MCSectionData &SD = Asm.getOrCreateSectionData(Section);
1574     uint32_t GroupSymbolIndex;
1575     if (Section.getType() != ELF::SHT_GROUP)
1576       GroupSymbolIndex = 0;
1577     else
1578       GroupSymbolIndex = getSymbolIndexInSymbolTable(Asm,
1579                                                      GroupMap.lookup(&Section));
1580
1581     uint64_t Size = GetSectionAddressSize(Layout, SD);
1582
1583     writeSection(Asm, SectionIndexMap, GroupSymbolIndex,
1584                  SectionOffsetMap.lookup(&Section), Size, SD.getAlignment(),
1585                  Section);
1586   }
1587 }
1588
1589 void ELFObjectWriter::WriteObject(MCAssembler &Asm,
1590                                   const MCAsmLayout &Layout) {
1591   GroupMapTy GroupMap;
1592   RevGroupMapTy RevGroupMap;
1593   SectionIndexMapTy SectionIndexMap;
1594
1595   CompressDebugSections(Asm, const_cast<MCAsmLayout &>(Layout));
1596   createIndexedSections(Asm, const_cast<MCAsmLayout &>(Layout), GroupMap,
1597                         RevGroupMap, SectionIndexMap);
1598
1599   // Compute symbol table information.
1600   computeSymbolTable(Asm, Layout, SectionIndexMap, RevGroupMap);
1601
1602   WriteRelocations(Asm, const_cast<MCAsmLayout &>(Layout));
1603
1604   CreateMetadataSections(const_cast<MCAssembler&>(Asm),
1605                          const_cast<MCAsmLayout&>(Layout),
1606                          SectionIndexMap);
1607
1608   unsigned NumSections = Asm.size();
1609   std::vector<const MCSectionELF*> Sections;
1610   Sections.resize(NumSections);
1611
1612   for (auto &Pair : SectionIndexMap)
1613     Sections[Pair.second - 1] = Pair.first;
1614
1615   SectionOffsetMapTy SectionOffsetMap;
1616
1617   // Write out the ELF header ...
1618   WriteHeader(Asm, NumSections + 1);
1619
1620   // ... then the sections ...
1621   for (unsigned i = 0; i < NumSections; ++i) {
1622     const MCSectionELF &Section = *Sections[i];
1623     const MCSectionData &SD = Asm.getOrCreateSectionData(Section);
1624     uint64_t Padding = OffsetToAlignment(OS.tell(), SD.getAlignment());
1625     WriteZeros(Padding);
1626
1627     // Remember the offset into the file for this section.
1628     SectionOffsetMap[&Section] = OS.tell();
1629
1630     writeDataSectionData(Asm, Layout, SD);
1631   }
1632
1633   uint64_t NaturalAlignment = is64Bit() ? 8 : 4;
1634   uint64_t Padding = OffsetToAlignment(OS.tell(), NaturalAlignment);
1635   WriteZeros(Padding);
1636
1637   const unsigned SectionHeaderOffset = OS.tell();
1638
1639   // ... then the section header table ...
1640   writeSectionHeader(Sections, Asm, GroupMap, Layout, SectionIndexMap,
1641                      SectionOffsetMap);
1642
1643   if (is64Bit()) {
1644     uint64_t Val = SectionHeaderOffset;
1645     if (sys::IsLittleEndianHost != IsLittleEndian)
1646       sys::swapByteOrder(Val);
1647     OS.pwrite(reinterpret_cast<char *>(&Val), sizeof(Val),
1648               offsetof(ELF::Elf64_Ehdr, e_shoff));
1649   } else {
1650     uint32_t Val = SectionHeaderOffset;
1651     if (sys::IsLittleEndianHost != IsLittleEndian)
1652       sys::swapByteOrder(Val);
1653     OS.pwrite(reinterpret_cast<char *>(&Val), sizeof(Val),
1654               offsetof(ELF::Elf32_Ehdr, e_shoff));
1655   }
1656 }
1657
1658 bool ELFObjectWriter::IsSymbolRefDifferenceFullyResolvedImpl(
1659     const MCAssembler &Asm, const MCSymbolData &DataA,
1660     const MCSymbolData *DataB, const MCFragment &FB, bool InSet,
1661     bool IsPCRel) const {
1662   if (!InSet && (::isWeak(DataA) || (DataB && ::isWeak(*DataB))))
1663     return false;
1664   return MCObjectWriter::IsSymbolRefDifferenceFullyResolvedImpl(
1665       Asm, DataA, DataB, FB, InSet, IsPCRel);
1666 }
1667
1668 bool ELFObjectWriter::isWeak(const MCSymbolData &SD) const {
1669   return ::isWeak(SD);
1670 }
1671
1672 MCObjectWriter *llvm::createELFObjectWriter(MCELFObjectTargetWriter *MOTW,
1673                                             raw_pwrite_stream &OS,
1674                                             bool IsLittleEndian) {
1675   return new ELFObjectWriter(MOTW, OS, IsLittleEndian);
1676 }