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