faba61ee0c56735c79b9b3e145b3d3cd85cc3281
[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/ELFObjectWriter.h"
15 #include "llvm/ADT/SmallPtrSet.h"
16 #include "llvm/ADT/STLExtras.h"
17 #include "llvm/ADT/StringMap.h"
18 #include "llvm/ADT/Twine.h"
19 #include "llvm/MC/MCAssembler.h"
20 #include "llvm/MC/MCAsmLayout.h"
21 #include "llvm/MC/MCContext.h"
22 #include "llvm/MC/MCELFSymbolFlags.h"
23 #include "llvm/MC/MCExpr.h"
24 #include "llvm/MC/MCObjectWriter.h"
25 #include "llvm/MC/MCSectionELF.h"
26 #include "llvm/MC/MCSymbol.h"
27 #include "llvm/MC/MCValue.h"
28 #include "llvm/Support/Debug.h"
29 #include "llvm/Support/ErrorHandling.h"
30 #include "llvm/Support/ELF.h"
31 #include "llvm/Target/TargetAsmBackend.h"
32
33 #include "../Target/X86/X86FixupKinds.h"
34
35 #include <vector>
36 using namespace llvm;
37
38 static unsigned GetType(const MCSymbolData &SD) {
39   uint32_t Type = (SD.getFlags() & (0xf << ELF_STT_Shift)) >> ELF_STT_Shift;
40   assert(Type == ELF::STT_NOTYPE || Type == ELF::STT_OBJECT ||
41          Type == ELF::STT_FUNC || Type == ELF::STT_SECTION ||
42          Type == ELF::STT_FILE || Type == ELF::STT_COMMON ||
43          Type == ELF::STT_TLS);
44   return Type;
45 }
46
47 static unsigned GetBinding(const MCSymbolData &SD) {
48   uint32_t Binding = (SD.getFlags() & (0xf << ELF_STB_Shift)) >> ELF_STB_Shift;
49   assert(Binding == ELF::STB_LOCAL || Binding == ELF::STB_GLOBAL ||
50          Binding == ELF::STB_WEAK);
51   return Binding;
52 }
53
54 static void SetBinding(MCSymbolData &SD, unsigned Binding) {
55   assert(Binding == ELF::STB_LOCAL || Binding == ELF::STB_GLOBAL ||
56          Binding == ELF::STB_WEAK);
57   uint32_t OtherFlags = SD.getFlags() & ~(0xf << ELF_STB_Shift);
58   SD.setFlags(OtherFlags | (Binding << ELF_STB_Shift));
59 }
60
61 static bool isFixupKindX86PCRel(unsigned Kind) {
62   switch (Kind) {
63   default:
64     return false;
65   case X86::reloc_pcrel_1byte:
66   case X86::reloc_pcrel_4byte:
67   case X86::reloc_riprel_4byte:
68   case X86::reloc_riprel_4byte_movq_load:
69     return true;
70   }
71 }
72
73 static bool RelocNeedsGOT(unsigned Type) {
74   switch (Type) {
75   default:
76     return false;
77   case ELF::R_X86_64_GOT32:
78   case ELF::R_X86_64_PLT32:
79   case ELF::R_X86_64_GOTPCREL:
80     return true;
81   }
82 }
83
84 namespace {
85
86   class ELFObjectWriterImpl {
87     /*static bool isFixupKindX86RIPRel(unsigned Kind) {
88       return Kind == X86::reloc_riprel_4byte ||
89         Kind == X86::reloc_riprel_4byte_movq_load;
90     }*/
91
92
93     /// ELFSymbolData - Helper struct for containing some precomputed information
94     /// on symbols.
95     struct ELFSymbolData {
96       MCSymbolData *SymbolData;
97       uint64_t StringIndex;
98       uint32_t SectionIndex;
99
100       // Support lexicographic sorting.
101       bool operator<(const ELFSymbolData &RHS) const {
102         if (GetType(*SymbolData) == ELF::STT_FILE)
103           return true;
104         if (GetType(*RHS.SymbolData) == ELF::STT_FILE)
105           return false;
106         return SymbolData->getSymbol().getName() <
107                RHS.SymbolData->getSymbol().getName();
108       }
109     };
110
111     /// @name Relocation Data
112     /// @{
113
114     struct ELFRelocationEntry {
115       // Make these big enough for both 32-bit and 64-bit
116       uint64_t r_offset;
117       int Index;
118       unsigned Type;
119       const MCSymbol *Symbol;
120       uint64_t r_addend;
121
122       // Support lexicographic sorting.
123       bool operator<(const ELFRelocationEntry &RE) const {
124         return RE.r_offset < r_offset;
125       }
126     };
127
128     SmallPtrSet<const MCSymbol *, 16> UsedInReloc;
129
130     llvm::DenseMap<const MCSectionData*,
131                    std::vector<ELFRelocationEntry> > Relocations;
132     DenseMap<const MCSection*, uint64_t> SectionStringTableIndex;
133
134     /// @}
135     /// @name Symbol Table Data
136     /// @{
137
138     SmallString<256> StringTable;
139     std::vector<ELFSymbolData> LocalSymbolData;
140     std::vector<ELFSymbolData> ExternalSymbolData;
141     std::vector<ELFSymbolData> UndefinedSymbolData;
142
143     /// @}
144
145     int NumRegularSections;
146
147     bool NeedsGOT;
148
149     ELFObjectWriter *Writer;
150
151     raw_ostream &OS;
152
153     unsigned Is64Bit : 1;
154
155     bool HasRelocationAddend;
156
157     Triple::OSType OSType;
158
159     // This holds the symbol table index of the last local symbol.
160     unsigned LastLocalSymbolIndex;
161     // This holds the .strtab section index.
162     unsigned StringTableIndex;
163
164     unsigned ShstrtabIndex;
165
166   public:
167     ELFObjectWriterImpl(ELFObjectWriter *_Writer, bool _Is64Bit,
168                         bool _HasRelAddend, Triple::OSType _OSType)
169       : NeedsGOT(false), Writer(_Writer), OS(Writer->getStream()),
170         Is64Bit(_Is64Bit), HasRelocationAddend(_HasRelAddend),
171         OSType(_OSType) {
172     }
173
174     void Write8(uint8_t Value) { Writer->Write8(Value); }
175     void Write16(uint16_t Value) { Writer->Write16(Value); }
176     void Write32(uint32_t Value) { Writer->Write32(Value); }
177     //void Write64(uint64_t Value) { Writer->Write64(Value); }
178     void WriteZeros(unsigned N) { Writer->WriteZeros(N); }
179     //void WriteBytes(StringRef Str, unsigned ZeroFillSize = 0) {
180     //  Writer->WriteBytes(Str, ZeroFillSize);
181     //}
182
183     void WriteWord(uint64_t W) {
184       if (Is64Bit)
185         Writer->Write64(W);
186       else
187         Writer->Write32(W);
188     }
189
190     void String8(char *buf, uint8_t Value) {
191       buf[0] = Value;
192     }
193
194     void StringLE16(char *buf, uint16_t Value) {
195       buf[0] = char(Value >> 0);
196       buf[1] = char(Value >> 8);
197     }
198
199     void StringLE32(char *buf, uint32_t Value) {
200       StringLE16(buf, uint16_t(Value >> 0));
201       StringLE16(buf + 2, uint16_t(Value >> 16));
202     }
203
204     void StringLE64(char *buf, uint64_t Value) {
205       StringLE32(buf, uint32_t(Value >> 0));
206       StringLE32(buf + 4, uint32_t(Value >> 32));
207     }
208
209     void StringBE16(char *buf ,uint16_t Value) {
210       buf[0] = char(Value >> 8);
211       buf[1] = char(Value >> 0);
212     }
213
214     void StringBE32(char *buf, uint32_t Value) {
215       StringBE16(buf, uint16_t(Value >> 16));
216       StringBE16(buf + 2, uint16_t(Value >> 0));
217     }
218
219     void StringBE64(char *buf, uint64_t Value) {
220       StringBE32(buf, uint32_t(Value >> 32));
221       StringBE32(buf + 4, uint32_t(Value >> 0));
222     }
223
224     void String16(char *buf, uint16_t Value) {
225       if (Writer->isLittleEndian())
226         StringLE16(buf, Value);
227       else
228         StringBE16(buf, Value);
229     }
230
231     void String32(char *buf, uint32_t Value) {
232       if (Writer->isLittleEndian())
233         StringLE32(buf, Value);
234       else
235         StringBE32(buf, Value);
236     }
237
238     void String64(char *buf, uint64_t Value) {
239       if (Writer->isLittleEndian())
240         StringLE64(buf, Value);
241       else
242         StringBE64(buf, Value);
243     }
244
245     void WriteHeader(uint64_t SectionDataSize, unsigned NumberOfSections);
246
247     void WriteSymbolEntry(MCDataFragment *F, uint64_t name, uint8_t info,
248                           uint64_t value, uint64_t size,
249                           uint8_t other, uint16_t shndx);
250
251     void WriteSymbol(MCDataFragment *F, ELFSymbolData &MSD,
252                      const MCAsmLayout &Layout);
253
254     void WriteSymbolTable(MCDataFragment *F, const MCAssembler &Asm,
255                           const MCAsmLayout &Layout,
256                           unsigned NumRegularSections);
257
258     void RecordRelocation(const MCAssembler &Asm, const MCAsmLayout &Layout,
259                           const MCFragment *Fragment, const MCFixup &Fixup,
260                           MCValue Target, uint64_t &FixedValue);
261
262     uint64_t getSymbolIndexInSymbolTable(const MCAssembler &Asm,
263                                          const MCSymbol *S);
264
265     /// ComputeSymbolTable - Compute the symbol table data
266     ///
267     /// \param StringTable [out] - The string table data.
268     /// \param StringIndexMap [out] - Map from symbol names to offsets in the
269     /// string table.
270     void ComputeSymbolTable(MCAssembler &Asm);
271
272     void WriteRelocation(MCAssembler &Asm, MCAsmLayout &Layout,
273                          const MCSectionData &SD);
274
275     void WriteRelocations(MCAssembler &Asm, MCAsmLayout &Layout) {
276       for (MCAssembler::const_iterator it = Asm.begin(),
277              ie = Asm.end(); it != ie; ++it) {
278         WriteRelocation(Asm, Layout, *it);
279       }
280     }
281
282     void CreateMetadataSections(MCAssembler &Asm, MCAsmLayout &Layout);
283
284     void ExecutePostLayoutBinding(MCAssembler &Asm) {
285     }
286
287     void WriteSecHdrEntry(uint32_t Name, uint32_t Type, uint64_t Flags,
288                           uint64_t Address, uint64_t Offset,
289                           uint64_t Size, uint32_t Link, uint32_t Info,
290                           uint64_t Alignment, uint64_t EntrySize);
291
292     void WriteRelocationsFragment(const MCAssembler &Asm, MCDataFragment *F,
293                                   const MCSectionData *SD);
294
295     bool IsFixupFullyResolved(const MCAssembler &Asm,
296                               const MCValue Target,
297                               bool IsPCRel,
298                               const MCFragment *DF) const;
299
300     void WriteObject(MCAssembler &Asm, const MCAsmLayout &Layout);
301   };
302
303 }
304
305 // Emit the ELF header.
306 void ELFObjectWriterImpl::WriteHeader(uint64_t SectionDataSize,
307                                       unsigned NumberOfSections) {
308   // ELF Header
309   // ----------
310   //
311   // Note
312   // ----
313   // emitWord method behaves differently for ELF32 and ELF64, writing
314   // 4 bytes in the former and 8 in the latter.
315
316   Write8(0x7f); // e_ident[EI_MAG0]
317   Write8('E');  // e_ident[EI_MAG1]
318   Write8('L');  // e_ident[EI_MAG2]
319   Write8('F');  // e_ident[EI_MAG3]
320
321   Write8(Is64Bit ? ELF::ELFCLASS64 : ELF::ELFCLASS32); // e_ident[EI_CLASS]
322
323   // e_ident[EI_DATA]
324   Write8(Writer->isLittleEndian() ? ELF::ELFDATA2LSB : ELF::ELFDATA2MSB);
325
326   Write8(ELF::EV_CURRENT);        // e_ident[EI_VERSION]
327   // e_ident[EI_OSABI]
328   switch (OSType) {
329     case Triple::FreeBSD:  Write8(ELF::ELFOSABI_FREEBSD); break;
330     case Triple::Linux:    Write8(ELF::ELFOSABI_LINUX); break;
331     default:               Write8(ELF::ELFOSABI_NONE); break;
332   }
333   Write8(0);                  // e_ident[EI_ABIVERSION]
334
335   WriteZeros(ELF::EI_NIDENT - ELF::EI_PAD);
336
337   Write16(ELF::ET_REL);             // e_type
338
339   // FIXME: Make this configurable
340   Write16(Is64Bit ? ELF::EM_X86_64 : ELF::EM_386); // e_machine = target
341
342   Write32(ELF::EV_CURRENT);         // e_version
343   WriteWord(0);                    // e_entry, no entry point in .o file
344   WriteWord(0);                    // e_phoff, no program header for .o
345   WriteWord(SectionDataSize + (Is64Bit ? sizeof(ELF::Elf64_Ehdr) :
346             sizeof(ELF::Elf32_Ehdr)));  // e_shoff = sec hdr table off in bytes
347
348   // FIXME: Make this configurable.
349   Write32(0);   // e_flags = whatever the target wants
350
351   // e_ehsize = ELF header size
352   Write16(Is64Bit ? sizeof(ELF::Elf64_Ehdr) : sizeof(ELF::Elf32_Ehdr));
353
354   Write16(0);                  // e_phentsize = prog header entry size
355   Write16(0);                  // e_phnum = # prog header entries = 0
356
357   // e_shentsize = Section header entry size
358   Write16(Is64Bit ? sizeof(ELF::Elf64_Shdr) : sizeof(ELF::Elf32_Shdr));
359
360   // e_shnum     = # of section header ents
361   Write16(NumberOfSections);
362
363   // e_shstrndx  = Section # of '.shstrtab'
364   Write16(ShstrtabIndex);
365 }
366
367 void ELFObjectWriterImpl::WriteSymbolEntry(MCDataFragment *F, uint64_t name,
368                                            uint8_t info, uint64_t value,
369                                            uint64_t size, uint8_t other,
370                                            uint16_t shndx) {
371   if (Is64Bit) {
372     char buf[8];
373
374     String32(buf, name);
375     F->getContents() += StringRef(buf, 4); // st_name
376
377     String8(buf, info);
378     F->getContents() += StringRef(buf, 1);  // st_info
379
380     String8(buf, other);
381     F->getContents() += StringRef(buf, 1); // st_other
382
383     String16(buf, shndx);
384     F->getContents() += StringRef(buf, 2); // st_shndx
385
386     String64(buf, value);
387     F->getContents() += StringRef(buf, 8); // st_value
388
389     String64(buf, size);
390     F->getContents() += StringRef(buf, 8);  // st_size
391   } else {
392     char buf[4];
393
394     String32(buf, name);
395     F->getContents() += StringRef(buf, 4);  // st_name
396
397     String32(buf, value);
398     F->getContents() += StringRef(buf, 4); // st_value
399
400     String32(buf, size);
401     F->getContents() += StringRef(buf, 4);  // st_size
402
403     String8(buf, info);
404     F->getContents() += StringRef(buf, 1);  // st_info
405
406     String8(buf, other);
407     F->getContents() += StringRef(buf, 1); // st_other
408
409     String16(buf, shndx);
410     F->getContents() += StringRef(buf, 2); // st_shndx
411   }
412 }
413
414 static uint64_t SymbolValue(MCSymbolData &Data, const MCAsmLayout &Layout) {
415   if (Data.isCommon() && Data.isExternal())
416     return Data.getCommonAlignment();
417
418   const MCSymbol &Symbol = Data.getSymbol();
419   if (!Symbol.isInSection())
420     return 0;
421
422   if (!Data.isCommon() && !(Data.getFlags() & ELF_STB_Weak))
423     if (MCFragment *FF = Data.getFragment())
424       return Layout.getSymbolAddress(&Data) -
425              Layout.getSectionAddress(FF->getParent());
426
427   return 0;
428 }
429
430 void ELFObjectWriterImpl::WriteSymbol(MCDataFragment *F, ELFSymbolData &MSD,
431                                       const MCAsmLayout &Layout) {
432   MCSymbolData &Data = *MSD.SymbolData;
433   uint8_t Info = (Data.getFlags() & 0xff);
434   uint8_t Other = ((Data.getFlags() & 0xf00) >> ELF_STV_Shift);
435   uint64_t Value = SymbolValue(Data, Layout);
436   uint64_t Size = 0;
437   const MCExpr *ESize;
438
439   assert(!(Data.isCommon() && !Data.isExternal()));
440
441   ESize = Data.getSize();
442   if (Data.getSize()) {
443     MCValue Res;
444     if (ESize->getKind() == MCExpr::Binary) {
445       const MCBinaryExpr *BE = static_cast<const MCBinaryExpr *>(ESize);
446
447       if (BE->EvaluateAsRelocatable(Res, &Layout)) {
448         uint64_t AddressA = 0;
449         uint64_t AddressB = 0;
450         const MCSymbol &SymA = Res.getSymA()->getSymbol();
451         const MCSymbol &SymB = Res.getSymB()->getSymbol();
452
453         if (SymA.isDefined()) {
454           MCSymbolData &A = Layout.getAssembler().getSymbolData(SymA);
455           AddressA = Layout.getSymbolAddress(&A);
456         }
457
458         if (SymB.isDefined()) {
459           MCSymbolData &B = Layout.getAssembler().getSymbolData(SymB);
460           AddressB = Layout.getSymbolAddress(&B);
461         }
462
463         Size = AddressA - AddressB;
464       }
465     } else if (ESize->getKind() == MCExpr::Constant) {
466       Size = static_cast<const MCConstantExpr *>(ESize)->getValue();
467     } else {
468       assert(0 && "Unsupported size expression");
469     }
470   }
471
472   // Write out the symbol table entry
473   WriteSymbolEntry(F, MSD.StringIndex, Info, Value,
474                    Size, Other, MSD.SectionIndex);
475 }
476
477 void ELFObjectWriterImpl::WriteSymbolTable(MCDataFragment *F,
478                                            const MCAssembler &Asm,
479                                            const MCAsmLayout &Layout,
480                                            unsigned NumRegularSections) {
481   // The string table must be emitted first because we need the index
482   // into the string table for all the symbol names.
483   assert(StringTable.size() && "Missing string table");
484
485   // FIXME: Make sure the start of the symbol table is aligned.
486
487   // The first entry is the undefined symbol entry.
488   unsigned EntrySize = Is64Bit ? ELF::SYMENTRY_SIZE64 : ELF::SYMENTRY_SIZE32;
489   F->getContents().append(EntrySize, '\x00');
490
491   // Write the symbol table entries.
492   LastLocalSymbolIndex = LocalSymbolData.size() + 1;
493   for (unsigned i = 0, e = LocalSymbolData.size(); i != e; ++i) {
494     ELFSymbolData &MSD = LocalSymbolData[i];
495     WriteSymbol(F, MSD, Layout);
496   }
497
498   // Write out a symbol table entry for each regular section.
499   unsigned Index = 1;
500   for (MCAssembler::const_iterator it = Asm.begin();
501        Index <= NumRegularSections; ++it, ++Index) {
502     const MCSectionELF &Section =
503       static_cast<const MCSectionELF&>(it->getSection());
504     // Leave out relocations so we don't have indexes within
505     // the relocations messed up
506     if (Section.getType() == ELF::SHT_RELA || Section.getType() == ELF::SHT_REL)
507       continue;
508     WriteSymbolEntry(F, 0, ELF::STT_SECTION, 0, 0, ELF::STV_DEFAULT, Index);
509     LastLocalSymbolIndex++;
510   }
511
512   for (unsigned i = 0, e = ExternalSymbolData.size(); i != e; ++i) {
513     ELFSymbolData &MSD = ExternalSymbolData[i];
514     MCSymbolData &Data = *MSD.SymbolData;
515     assert((Data.getFlags() & ELF_STB_Global) &&
516            "External symbol requires STB_GLOBAL flag");
517     WriteSymbol(F, MSD, Layout);
518     if (GetBinding(Data) == ELF::STB_LOCAL)
519       LastLocalSymbolIndex++;
520   }
521
522   for (unsigned i = 0, e = UndefinedSymbolData.size(); i != e; ++i) {
523     ELFSymbolData &MSD = UndefinedSymbolData[i];
524     MCSymbolData &Data = *MSD.SymbolData;
525     WriteSymbol(F, MSD, Layout);
526     if (GetBinding(Data) == ELF::STB_LOCAL)
527       LastLocalSymbolIndex++;
528   }
529 }
530
531 static bool ShouldRelocOnSymbol(const MCSymbolData &SD,
532                                 const MCValue &Target) {
533   const MCSymbol &Symbol = SD.getSymbol();
534   if (Symbol.isUndefined())
535     return true;
536
537   const MCSectionELF &Section =
538     static_cast<const MCSectionELF&>(Symbol.getSection());
539
540   if (Section.getFlags() & MCSectionELF::SHF_MERGE)
541     return Target.getConstant() != 0;
542
543   if (SD.isExternal())
544     return true;
545
546   return false;
547 }
548
549 // FIXME: this is currently X86/X86_64 only
550 void ELFObjectWriterImpl::RecordRelocation(const MCAssembler &Asm,
551                                            const MCAsmLayout &Layout,
552                                            const MCFragment *Fragment,
553                                            const MCFixup &Fixup,
554                                            MCValue Target,
555                                            uint64_t &FixedValue) {
556   int64_t Addend = 0;
557   int Index = 0;
558   int64_t Value = Target.getConstant();
559   const MCSymbol *Symbol = 0;
560
561   bool IsPCRel = isFixupKindX86PCRel(Fixup.getKind());
562   if (!Target.isAbsolute()) {
563     Symbol = &Target.getSymA()->getSymbol();
564     MCSymbolData &SD = Asm.getSymbolData(*Symbol);
565     MCFragment *F = SD.getFragment();
566
567     if (const MCSymbolRefExpr *RefB = Target.getSymB()) {
568       const MCSymbol &SymbolB = RefB->getSymbol();
569       MCSymbolData &SDB = Asm.getSymbolData(SymbolB);
570       IsPCRel = true;
571       MCSectionData *Sec = Fragment->getParent();
572
573       // Offset of the symbol in the section
574       int64_t a = Layout.getSymbolAddress(&SDB) - Layout.getSectionAddress(Sec);
575
576       // Ofeset of the relocation in the section
577       int64_t b = Layout.getFragmentOffset(Fragment) + Fixup.getOffset();
578       Value += b - a;
579     }
580
581     // Check that this case has already been fully resolved before we get
582     // here.
583     if (Symbol->isDefined() && !SD.isExternal() &&
584         IsPCRel &&
585         &Fragment->getParent()->getSection() == &Symbol->getSection()) {
586       llvm_unreachable("We don't need a relocation in this case.");
587       return;
588     }
589
590     bool RelocOnSymbol = ShouldRelocOnSymbol(SD, Target);
591     if (!RelocOnSymbol) {
592       Index = F->getParent()->getOrdinal();
593
594       MCSectionData *FSD = F->getParent();
595       // Offset of the symbol in the section
596       Value += Layout.getSymbolAddress(&SD) - Layout.getSectionAddress(FSD);
597     } else {
598       UsedInReloc.insert(Symbol);
599       Index = -1;
600     }
601     Addend = Value;
602     // Compensate for the addend on i386.
603     if (Is64Bit)
604       Value = 0;
605   }
606
607   FixedValue = Value;
608
609   // determine the type of the relocation
610
611   MCSymbolRefExpr::VariantKind Modifier = Target.getSymA()->getKind();
612   unsigned Type;
613   if (Is64Bit) {
614     if (IsPCRel) {
615       switch (Modifier) {
616       case MCSymbolRefExpr::VK_None:
617         Type = ELF::R_X86_64_PC32;
618         break;
619       case MCSymbolRefExpr::VK_PLT:
620         Type = ELF::R_X86_64_PLT32;
621         break;
622       case llvm::MCSymbolRefExpr::VK_GOTPCREL:
623         Type = ELF::R_X86_64_GOTPCREL;
624         break;
625       default:
626         llvm_unreachable("Unimplemented");
627       }
628     } else {
629       switch ((unsigned)Fixup.getKind()) {
630       default: llvm_unreachable("invalid fixup kind!");
631       case FK_Data_8: Type = ELF::R_X86_64_64; break;
632       case X86::reloc_signed_4byte:
633       case X86::reloc_pcrel_4byte:
634         assert(isInt<32>(Target.getConstant()));
635         switch (Modifier) {
636         case MCSymbolRefExpr::VK_None:
637           Type = ELF::R_X86_64_32S;
638           break;
639         case MCSymbolRefExpr::VK_GOT:
640           Type = ELF::R_X86_64_GOT32;
641           break;
642         default:
643           llvm_unreachable("Unimplemented");
644         }
645         break;
646       case FK_Data_4:
647         Type = ELF::R_X86_64_32;
648         break;
649       case FK_Data_2: Type = ELF::R_X86_64_16; break;
650       case X86::reloc_pcrel_1byte:
651       case FK_Data_1: Type = ELF::R_X86_64_8; break;
652       }
653     }
654   } else {
655     if (IsPCRel) {
656       Type = ELF::R_386_PC32;
657     } else {
658       switch ((unsigned)Fixup.getKind()) {
659       default: llvm_unreachable("invalid fixup kind!");
660
661       // FIXME: Should we avoid selecting reloc_signed_4byte in 32 bit mode
662       // instead?
663       case X86::reloc_signed_4byte:
664       case X86::reloc_pcrel_4byte:
665       case FK_Data_4: Type = ELF::R_386_32; break;
666       case FK_Data_2: Type = ELF::R_386_16; break;
667       case X86::reloc_pcrel_1byte:
668       case FK_Data_1: Type = ELF::R_386_8; break;
669       }
670     }
671   }
672
673   if (RelocNeedsGOT(Type))
674     NeedsGOT = true;
675
676   ELFRelocationEntry ERE;
677
678   ERE.Index = Index;
679   ERE.Type = Type;
680   ERE.Symbol = Symbol;
681
682   ERE.r_offset = Layout.getFragmentOffset(Fragment) + Fixup.getOffset();
683
684   if (HasRelocationAddend)
685     ERE.r_addend = Addend;
686   else
687     ERE.r_addend = 0; // Silence compiler warning.
688
689   Relocations[Fragment->getParent()].push_back(ERE);
690 }
691
692 uint64_t
693 ELFObjectWriterImpl::getSymbolIndexInSymbolTable(const MCAssembler &Asm,
694                                                  const MCSymbol *S) {
695   MCSymbolData &SD = Asm.getSymbolData(*S);
696
697   // Local symbol.
698   if (!SD.isExternal() && !S->isUndefined())
699     return SD.getIndex() + /* empty symbol */ 1;
700
701   // External or undefined symbol.
702   return SD.getIndex() + NumRegularSections + /* empty symbol */ 1;
703 }
704
705 static bool isInSymtab(const MCAssembler &Asm, const MCSymbolData &Data,
706                        bool Used) {
707   const MCSymbol &Symbol = Data.getSymbol();
708   if (!Asm.isSymbolLinkerVisible(Symbol) && !Symbol.isUndefined())
709     return false;
710
711   if (!Used && Symbol.isTemporary())
712     return false;
713
714   return true;
715 }
716
717 static bool isLocal(const MCSymbolData &Data) {
718   if (Data.isExternal())
719     return false;
720
721   const MCSymbol &Symbol = Data.getSymbol();
722   if (Symbol.isUndefined() && !Symbol.isVariable())
723     return false;
724
725   return true;
726 }
727
728 void ELFObjectWriterImpl::ComputeSymbolTable(MCAssembler &Asm) {
729   // FIXME: Is this the correct place to do this?
730   if (NeedsGOT) {
731     llvm::StringRef Name = "_GLOBAL_OFFSET_TABLE_";
732     MCSymbol *Sym = Asm.getContext().GetOrCreateSymbol(Name);
733     MCSymbolData &Data = Asm.getOrCreateSymbolData(*Sym);
734     Data.setExternal(true);
735   }
736
737   // Build section lookup table.
738   NumRegularSections = Asm.size();
739   DenseMap<const MCSection*, uint8_t> SectionIndexMap;
740   unsigned Index = 1;
741   for (MCAssembler::iterator it = Asm.begin(),
742          ie = Asm.end(); it != ie; ++it, ++Index)
743     SectionIndexMap[&it->getSection()] = Index;
744
745   // Index 0 is always the empty string.
746   StringMap<uint64_t> StringIndexMap;
747   StringTable += '\x00';
748
749   // Add the data for local symbols.
750   for (MCAssembler::symbol_iterator it = Asm.symbol_begin(),
751          ie = Asm.symbol_end(); it != ie; ++it) {
752     const MCSymbol &Symbol = it->getSymbol();
753
754     if (!isInSymtab(Asm, *it, UsedInReloc.count(&Symbol)))
755       continue;
756
757     if (!isLocal(*it))
758       continue;
759
760     uint64_t &Entry = StringIndexMap[Symbol.getName()];
761     if (!Entry) {
762       Entry = StringTable.size();
763       StringTable += Symbol.getName();
764       StringTable += '\x00';
765     }
766
767     ELFSymbolData MSD;
768     MSD.SymbolData = it;
769     MSD.StringIndex = Entry;
770
771     if (Symbol.isAbsolute()) {
772       MSD.SectionIndex = ELF::SHN_ABS;
773       LocalSymbolData.push_back(MSD);
774     } else {
775       const MCSymbol *SymbolP = &Symbol;
776       if (Symbol.isVariable()) {
777         const MCExpr *Value = Symbol.getVariableValue();
778         assert (Value->getKind() == MCExpr::SymbolRef && "Unimplemented");
779         const MCSymbolRefExpr *Ref = static_cast<const MCSymbolRefExpr*>(Value);
780         SymbolP = &Ref->getSymbol();
781       }
782       MSD.SectionIndex = SectionIndexMap.lookup(&SymbolP->getSection());
783       assert(MSD.SectionIndex && "Invalid section index!");
784       LocalSymbolData.push_back(MSD);
785     }
786   }
787
788   // Now add non-local symbols.
789   for (MCAssembler::symbol_iterator it = Asm.symbol_begin(),
790          ie = Asm.symbol_end(); it != ie; ++it) {
791     const MCSymbol &Symbol = it->getSymbol();
792
793     if (!isInSymtab(Asm, *it, UsedInReloc.count(&Symbol)))
794       continue;
795
796     if (isLocal(*it))
797       continue;
798
799     uint64_t &Entry = StringIndexMap[Symbol.getName()];
800     if (!Entry) {
801       Entry = StringTable.size();
802       StringTable += Symbol.getName();
803       StringTable += '\x00';
804     }
805
806     ELFSymbolData MSD;
807     MSD.SymbolData = it;
808     MSD.StringIndex = Entry;
809
810     if (it->isCommon()) {
811       MSD.SectionIndex = ELF::SHN_COMMON;
812       ExternalSymbolData.push_back(MSD);
813     } else if (Symbol.isUndefined()) {
814       MSD.SectionIndex = ELF::SHN_UNDEF;
815       // FIXME: Undefined symbols are global, but this is the first place we
816       // are able to set it.
817       if (GetBinding(*it) == ELF::STB_LOCAL)
818         SetBinding(*it, ELF::STB_GLOBAL);
819       UndefinedSymbolData.push_back(MSD);
820     } else if (Symbol.isAbsolute()) {
821       MSD.SectionIndex = ELF::SHN_ABS;
822       ExternalSymbolData.push_back(MSD);
823     } else {
824       MSD.SectionIndex = SectionIndexMap.lookup(&Symbol.getSection());
825       assert(MSD.SectionIndex && "Invalid section index!");
826       ExternalSymbolData.push_back(MSD);
827     }
828   }
829
830   // Symbols are required to be in lexicographic order.
831   array_pod_sort(LocalSymbolData.begin(), LocalSymbolData.end());
832   array_pod_sort(ExternalSymbolData.begin(), ExternalSymbolData.end());
833   array_pod_sort(UndefinedSymbolData.begin(), UndefinedSymbolData.end());
834
835   // Set the symbol indices. Local symbols must come before all other
836   // symbols with non-local bindings.
837   Index = 0;
838   for (unsigned i = 0, e = LocalSymbolData.size(); i != e; ++i)
839     LocalSymbolData[i].SymbolData->setIndex(Index++);
840   for (unsigned i = 0, e = ExternalSymbolData.size(); i != e; ++i)
841     ExternalSymbolData[i].SymbolData->setIndex(Index++);
842   for (unsigned i = 0, e = UndefinedSymbolData.size(); i != e; ++i)
843     UndefinedSymbolData[i].SymbolData->setIndex(Index++);
844 }
845
846 void ELFObjectWriterImpl::WriteRelocation(MCAssembler &Asm, MCAsmLayout &Layout,
847                                           const MCSectionData &SD) {
848   if (!Relocations[&SD].empty()) {
849     MCContext &Ctx = Asm.getContext();
850     const MCSection *RelaSection;
851     const MCSectionELF &Section =
852       static_cast<const MCSectionELF&>(SD.getSection());
853
854     const StringRef SectionName = Section.getSectionName();
855     std::string RelaSectionName = HasRelocationAddend ? ".rela" : ".rel";
856     RelaSectionName += SectionName;
857
858     unsigned EntrySize;
859     if (HasRelocationAddend)
860       EntrySize = Is64Bit ? sizeof(ELF::Elf64_Rela) : sizeof(ELF::Elf32_Rela);
861     else
862       EntrySize = Is64Bit ? sizeof(ELF::Elf64_Rel) : sizeof(ELF::Elf32_Rel);
863
864     RelaSection = Ctx.getELFSection(RelaSectionName, HasRelocationAddend ?
865                                     ELF::SHT_RELA : ELF::SHT_REL, 0,
866                                     SectionKind::getReadOnly(),
867                                     false, EntrySize);
868
869     MCSectionData &RelaSD = Asm.getOrCreateSectionData(*RelaSection);
870     RelaSD.setAlignment(Is64Bit ? 8 : 4);
871
872     MCDataFragment *F = new MCDataFragment(&RelaSD);
873
874     WriteRelocationsFragment(Asm, F, &SD);
875
876     Asm.AddSectionToTheEnd(*Writer, RelaSD, Layout);
877   }
878 }
879
880 void ELFObjectWriterImpl::WriteSecHdrEntry(uint32_t Name, uint32_t Type,
881                                            uint64_t Flags, uint64_t Address,
882                                            uint64_t Offset, uint64_t Size,
883                                            uint32_t Link, uint32_t Info,
884                                            uint64_t Alignment,
885                                            uint64_t EntrySize) {
886   Write32(Name);        // sh_name: index into string table
887   Write32(Type);        // sh_type
888   WriteWord(Flags);     // sh_flags
889   WriteWord(Address);   // sh_addr
890   WriteWord(Offset);    // sh_offset
891   WriteWord(Size);      // sh_size
892   Write32(Link);        // sh_link
893   Write32(Info);        // sh_info
894   WriteWord(Alignment); // sh_addralign
895   WriteWord(EntrySize); // sh_entsize
896 }
897
898 void ELFObjectWriterImpl::WriteRelocationsFragment(const MCAssembler &Asm,
899                                                    MCDataFragment *F,
900                                                    const MCSectionData *SD) {
901   std::vector<ELFRelocationEntry> &Relocs = Relocations[SD];
902   // sort by the r_offset just like gnu as does
903   array_pod_sort(Relocs.begin(), Relocs.end());
904
905   for (unsigned i = 0, e = Relocs.size(); i != e; ++i) {
906     ELFRelocationEntry entry = Relocs[e - i - 1];
907
908     if (entry.Index < 0)
909       entry.Index = getSymbolIndexInSymbolTable(Asm, entry.Symbol);
910     else
911       entry.Index += LocalSymbolData.size() + 1;
912     if (Is64Bit) {
913       char buf[8];
914
915       String64(buf, entry.r_offset);
916       F->getContents() += StringRef(buf, 8);
917
918       struct ELF::Elf64_Rela ERE64;
919       ERE64.setSymbolAndType(entry.Index, entry.Type);
920       String64(buf, ERE64.r_info);
921       F->getContents() += StringRef(buf, 8);
922
923       if (HasRelocationAddend) {
924         String64(buf, entry.r_addend);
925         F->getContents() += StringRef(buf, 8);
926       }
927     } else {
928       char buf[4];
929
930       String32(buf, entry.r_offset);
931       F->getContents() += StringRef(buf, 4);
932
933       struct ELF::Elf32_Rela ERE32;
934       ERE32.setSymbolAndType(entry.Index, entry.Type);
935       String32(buf, ERE32.r_info);
936       F->getContents() += StringRef(buf, 4);
937
938       if (HasRelocationAddend) {
939         String32(buf, entry.r_addend);
940         F->getContents() += StringRef(buf, 4);
941       }
942     }
943   }
944 }
945
946 void ELFObjectWriterImpl::CreateMetadataSections(MCAssembler &Asm,
947                                                  MCAsmLayout &Layout) {
948   MCContext &Ctx = Asm.getContext();
949   MCDataFragment *F;
950
951   const MCSection *SymtabSection;
952   unsigned EntrySize = Is64Bit ? ELF::SYMENTRY_SIZE64 : ELF::SYMENTRY_SIZE32;
953
954   unsigned NumRegularSections = Asm.size();
955
956   // We construct .shstrtab, .symtab and .strtab in this order to match gnu as.
957   const MCSection *ShstrtabSection;
958   ShstrtabSection = Ctx.getELFSection(".shstrtab", ELF::SHT_STRTAB, 0,
959                                       SectionKind::getReadOnly(), false);
960   MCSectionData &ShstrtabSD = Asm.getOrCreateSectionData(*ShstrtabSection);
961   ShstrtabSD.setAlignment(1);
962   ShstrtabIndex = Asm.size();
963
964   SymtabSection = Ctx.getELFSection(".symtab", ELF::SHT_SYMTAB, 0,
965                                     SectionKind::getReadOnly(),
966                                     false, EntrySize);
967   MCSectionData &SymtabSD = Asm.getOrCreateSectionData(*SymtabSection);
968   SymtabSD.setAlignment(Is64Bit ? 8 : 4);
969
970   const MCSection *StrtabSection;
971   StrtabSection = Ctx.getELFSection(".strtab", ELF::SHT_STRTAB, 0,
972                                     SectionKind::getReadOnly(), false);
973   MCSectionData &StrtabSD = Asm.getOrCreateSectionData(*StrtabSection);
974   StrtabSD.setAlignment(1);
975   StringTableIndex = Asm.size();
976
977   WriteRelocations(Asm, Layout);
978
979   // Symbol table
980   F = new MCDataFragment(&SymtabSD);
981   WriteSymbolTable(F, Asm, Layout, NumRegularSections);
982   Asm.AddSectionToTheEnd(*Writer, SymtabSD, Layout);
983
984   F = new MCDataFragment(&StrtabSD);
985   F->getContents().append(StringTable.begin(), StringTable.end());
986   Asm.AddSectionToTheEnd(*Writer, StrtabSD, Layout);
987
988   F = new MCDataFragment(&ShstrtabSD);
989
990   // Section header string table.
991   //
992   // The first entry of a string table holds a null character so skip
993   // section 0.
994   uint64_t Index = 1;
995   F->getContents() += '\x00';
996
997   for (MCAssembler::const_iterator it = Asm.begin(),
998          ie = Asm.end(); it != ie; ++it) {
999     const MCSectionELF &Section =
1000       static_cast<const MCSectionELF&>(it->getSection());
1001     // FIXME: We could merge suffixes like in .text and .rela.text.
1002
1003     // Remember the index into the string table so we can write it
1004     // into the sh_name field of the section header table.
1005     SectionStringTableIndex[&it->getSection()] = Index;
1006
1007     Index += Section.getSectionName().size() + 1;
1008     F->getContents() += Section.getSectionName();
1009     F->getContents() += '\x00';
1010   }
1011
1012   Asm.AddSectionToTheEnd(*Writer, ShstrtabSD, Layout);
1013 }
1014
1015 bool ELFObjectWriterImpl::IsFixupFullyResolved(const MCAssembler &Asm,
1016                                                const MCValue Target,
1017                                                bool IsPCRel,
1018                                                const MCFragment *DF) const {
1019   // If this is a PCrel relocation, find the section this fixup value is
1020   // relative to.
1021   const MCSection *BaseSection = 0;
1022   if (IsPCRel) {
1023     BaseSection = &DF->getParent()->getSection();
1024     assert(BaseSection);
1025   }
1026
1027   const MCSection *SectionA = 0;
1028   const MCSymbol *SymbolA = 0;
1029   if (const MCSymbolRefExpr *A = Target.getSymA()) {
1030     SymbolA = &A->getSymbol();
1031     SectionA = &SymbolA->getSection();
1032   }
1033
1034   const MCSection *SectionB = 0;
1035   if (const MCSymbolRefExpr *B = Target.getSymB()) {
1036     SectionB = &B->getSymbol().getSection();
1037   }
1038
1039   if (!BaseSection)
1040     return SectionA == SectionB;
1041
1042   const MCSymbolData &DataA = Asm.getSymbolData(*SymbolA);
1043   if (DataA.isExternal())
1044     return false;
1045
1046   return !SectionB && BaseSection == SectionA;
1047 }
1048
1049 void ELFObjectWriterImpl::WriteObject(MCAssembler &Asm,
1050                                       const MCAsmLayout &Layout) {
1051   // Compute symbol table information.
1052   ComputeSymbolTable(Asm);
1053
1054   CreateMetadataSections(const_cast<MCAssembler&>(Asm),
1055                          const_cast<MCAsmLayout&>(Layout));
1056
1057   // Add 1 for the null section.
1058   unsigned NumSections = Asm.size() + 1;
1059   uint64_t NaturalAlignment = Is64Bit ? 8 : 4;
1060   uint64_t HeaderSize = Is64Bit ? sizeof(ELF::Elf64_Ehdr) : sizeof(ELF::Elf32_Ehdr);
1061   uint64_t FileOff = HeaderSize;
1062
1063   for (MCAssembler::const_iterator it = Asm.begin(),
1064          ie = Asm.end(); it != ie; ++it) {
1065     const MCSectionData &SD = *it;
1066
1067     FileOff = RoundUpToAlignment(FileOff, SD.getAlignment());
1068
1069     // Get the size of the section in the output file (including padding).
1070     uint64_t Size = Layout.getSectionFileSize(&SD);
1071
1072     FileOff += Size;
1073   }
1074
1075   FileOff = RoundUpToAlignment(FileOff, NaturalAlignment);
1076
1077   // Write out the ELF header ...
1078   WriteHeader(FileOff - HeaderSize, NumSections);
1079
1080   FileOff = HeaderSize;
1081
1082   // ... then all of the sections ...
1083   DenseMap<const MCSection*, uint64_t> SectionOffsetMap;
1084
1085   DenseMap<const MCSection*, uint8_t> SectionIndexMap;
1086
1087   unsigned Index = 1;
1088   for (MCAssembler::const_iterator it = Asm.begin(),
1089          ie = Asm.end(); it != ie; ++it) {
1090     const MCSectionData &SD = *it;
1091
1092     uint64_t Padding = OffsetToAlignment(FileOff, SD.getAlignment());
1093     WriteZeros(Padding);
1094     FileOff += Padding;
1095
1096     // Remember the offset into the file for this section.
1097     SectionOffsetMap[&it->getSection()] = FileOff;
1098     SectionIndexMap[&it->getSection()] = Index++;
1099
1100     FileOff += Layout.getSectionFileSize(&SD);
1101
1102     Asm.WriteSectionData(it, Layout, Writer);
1103   }
1104
1105   uint64_t Padding = OffsetToAlignment(FileOff, NaturalAlignment);
1106   WriteZeros(Padding);
1107   FileOff += Padding;
1108
1109   // ... and then the section header table.
1110   // Should we align the section header table?
1111   //
1112   // Null section first.
1113   WriteSecHdrEntry(0, 0, 0, 0, 0, 0, 0, 0, 0, 0);
1114
1115   for (MCAssembler::const_iterator it = Asm.begin(),
1116          ie = Asm.end(); it != ie; ++it) {
1117     const MCSectionData &SD = *it;
1118     const MCSectionELF &Section =
1119       static_cast<const MCSectionELF&>(SD.getSection());
1120
1121     uint64_t sh_link = 0;
1122     uint64_t sh_info = 0;
1123
1124     switch(Section.getType()) {
1125     case ELF::SHT_DYNAMIC:
1126       sh_link = SectionStringTableIndex[&it->getSection()];
1127       sh_info = 0;
1128       break;
1129
1130     case ELF::SHT_REL:
1131     case ELF::SHT_RELA: {
1132       const MCSection *SymtabSection;
1133       const MCSection *InfoSection;
1134
1135       SymtabSection = Asm.getContext().getELFSection(".symtab", ELF::SHT_SYMTAB, 0,
1136                                                      SectionKind::getReadOnly(),
1137                                                      false);
1138       sh_link = SectionIndexMap[SymtabSection];
1139
1140       // Remove ".rel" and ".rela" prefixes.
1141       unsigned SecNameLen = (Section.getType() == ELF::SHT_REL) ? 4 : 5;
1142       StringRef SectionName = Section.getSectionName().substr(SecNameLen);
1143
1144       InfoSection = Asm.getContext().getELFSection(SectionName,
1145                                                    ELF::SHT_PROGBITS, 0,
1146                                                    SectionKind::getReadOnly(),
1147                                                    false);
1148       sh_info = SectionIndexMap[InfoSection];
1149       break;
1150     }
1151
1152     case ELF::SHT_SYMTAB:
1153     case ELF::SHT_DYNSYM:
1154       sh_link = StringTableIndex;
1155       sh_info = LastLocalSymbolIndex;
1156       break;
1157
1158     case ELF::SHT_PROGBITS:
1159     case ELF::SHT_STRTAB:
1160     case ELF::SHT_NOBITS:
1161     case ELF::SHT_NULL:
1162       // Nothing to do.
1163       break;
1164
1165     case ELF::SHT_HASH:
1166     case ELF::SHT_GROUP:
1167     case ELF::SHT_SYMTAB_SHNDX:
1168     default:
1169       assert(0 && "FIXME: sh_type value not supported!");
1170       break;
1171     }
1172
1173     WriteSecHdrEntry(SectionStringTableIndex[&it->getSection()],
1174                      Section.getType(), Section.getFlags(),
1175                      0,
1176                      SectionOffsetMap.lookup(&SD.getSection()),
1177                      Layout.getSectionSize(&SD), sh_link,
1178                      sh_info, SD.getAlignment(),
1179                      Section.getEntrySize());
1180   }
1181 }
1182
1183 ELFObjectWriter::ELFObjectWriter(raw_ostream &OS,
1184                                  bool Is64Bit,
1185                                  Triple::OSType OSType,
1186                                  bool IsLittleEndian,
1187                                  bool HasRelocationAddend)
1188   : MCObjectWriter(OS, IsLittleEndian)
1189 {
1190   Impl = new ELFObjectWriterImpl(this, Is64Bit, HasRelocationAddend, OSType);
1191 }
1192
1193 ELFObjectWriter::~ELFObjectWriter() {
1194   delete (ELFObjectWriterImpl*) Impl;
1195 }
1196
1197 void ELFObjectWriter::ExecutePostLayoutBinding(MCAssembler &Asm) {
1198   ((ELFObjectWriterImpl*) Impl)->ExecutePostLayoutBinding(Asm);
1199 }
1200
1201 void ELFObjectWriter::RecordRelocation(const MCAssembler &Asm,
1202                                        const MCAsmLayout &Layout,
1203                                        const MCFragment *Fragment,
1204                                        const MCFixup &Fixup, MCValue Target,
1205                                        uint64_t &FixedValue) {
1206   ((ELFObjectWriterImpl*) Impl)->RecordRelocation(Asm, Layout, Fragment, Fixup,
1207                                                   Target, FixedValue);
1208 }
1209
1210 bool ELFObjectWriter::IsFixupFullyResolved(const MCAssembler &Asm,
1211                                            const MCValue Target,
1212                                            bool IsPCRel,
1213                                            const MCFragment *DF) const {
1214   return ((ELFObjectWriterImpl*) Impl)->IsFixupFullyResolved(Asm, Target,
1215                                                              IsPCRel, DF);
1216 }
1217
1218 void ELFObjectWriter::WriteObject(MCAssembler &Asm,
1219                                   const MCAsmLayout &Layout) {
1220   ((ELFObjectWriterImpl*) Impl)->WriteObject(Asm, Layout);
1221 }