MC/Mach-O/x86_64: Temporary labels in cstring sections require symbols (and external...
[oota-llvm.git] / lib / MC / MCAssembler.cpp
1 //===- lib/MC/MCAssembler.cpp - Assembler Backend Implementation ----------===//
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 #define DEBUG_TYPE "assembler"
11 #include "llvm/MC/MCAssembler.h"
12 #include "llvm/MC/MCAsmLayout.h"
13 #include "llvm/MC/MCExpr.h"
14 #include "llvm/MC/MCSectionMachO.h"
15 #include "llvm/MC/MCSymbol.h"
16 #include "llvm/MC/MCValue.h"
17 #include "llvm/ADT/DenseMap.h"
18 #include "llvm/ADT/SmallString.h"
19 #include "llvm/ADT/Statistic.h"
20 #include "llvm/ADT/StringExtras.h"
21 #include "llvm/ADT/StringMap.h"
22 #include "llvm/ADT/Twine.h"
23 #include "llvm/Support/ErrorHandling.h"
24 #include "llvm/Support/MachO.h"
25 #include "llvm/Support/raw_ostream.h"
26 #include "llvm/Support/Debug.h"
27 #include "llvm/Target/TargetRegistry.h"
28 #include "llvm/Target/TargetAsmBackend.h"
29
30 // FIXME: Gross.
31 #include "../Target/X86/X86FixupKinds.h"
32
33 #include <vector>
34 using namespace llvm;
35
36 class MachObjectWriter;
37
38 STATISTIC(EmittedFragments, "Number of emitted assembler fragments");
39
40 // FIXME FIXME FIXME: There are number of places in this file where we convert
41 // what is a 64-bit assembler value used for computation into a value in the
42 // object file, which may truncate it. We should detect that truncation where
43 // invalid and report errors back.
44
45 static void WriteFileData(raw_ostream &OS, const MCSectionData &SD,
46                           MachObjectWriter &MOW);
47
48 static uint64_t WriteNopData(uint64_t Count, MachObjectWriter &MOW);
49
50 /// isVirtualSection - Check if this is a section which does not actually exist
51 /// in the object file.
52 static bool isVirtualSection(const MCSection &Section) {
53   // FIXME: Lame.
54   const MCSectionMachO &SMO = static_cast<const MCSectionMachO&>(Section);
55   return (SMO.getType() == MCSectionMachO::S_ZEROFILL);
56 }
57
58 static unsigned getFixupKindLog2Size(unsigned Kind) {
59   switch (Kind) {
60   default: llvm_unreachable("invalid fixup kind!");
61   case X86::reloc_pcrel_1byte:
62   case FK_Data_1: return 0;
63   case FK_Data_2: return 1;
64   case X86::reloc_pcrel_4byte:
65   case X86::reloc_riprel_4byte:
66   case FK_Data_4: return 2;
67   case FK_Data_8: return 3;
68   }
69 }
70
71 static bool isFixupKindPCRel(unsigned Kind) {
72   switch (Kind) {
73   default:
74     return false;
75   case X86::reloc_pcrel_1byte:
76   case X86::reloc_pcrel_4byte:
77   case X86::reloc_riprel_4byte:
78     return true;
79   }
80 }
81
82 class MachObjectWriter {
83   // See <mach-o/loader.h>.
84   enum {
85     Header_Magic32 = 0xFEEDFACE,
86     Header_Magic64 = 0xFEEDFACF
87   };
88
89   enum {
90     Header32Size = 28,
91     Header64Size = 32,
92     SegmentLoadCommand32Size = 56,
93     SegmentLoadCommand64Size = 72,
94     Section32Size = 68,
95     Section64Size = 80,
96     SymtabLoadCommandSize = 24,
97     DysymtabLoadCommandSize = 80,
98     Nlist32Size = 12,
99     Nlist64Size = 16,
100     RelocationInfoSize = 8
101   };
102
103   enum HeaderFileType {
104     HFT_Object = 0x1
105   };
106
107   enum HeaderFlags {
108     HF_SubsectionsViaSymbols = 0x2000
109   };
110
111   enum LoadCommandType {
112     LCT_Segment = 0x1,
113     LCT_Symtab = 0x2,
114     LCT_Dysymtab = 0xb,
115     LCT_Segment64 = 0x19
116   };
117
118   // See <mach-o/nlist.h>.
119   enum SymbolTypeType {
120     STT_Undefined = 0x00,
121     STT_Absolute  = 0x02,
122     STT_Section   = 0x0e
123   };
124
125   enum SymbolTypeFlags {
126     // If any of these bits are set, then the entry is a stab entry number (see
127     // <mach-o/stab.h>. Otherwise the other masks apply.
128     STF_StabsEntryMask = 0xe0,
129
130     STF_TypeMask       = 0x0e,
131     STF_External       = 0x01,
132     STF_PrivateExtern  = 0x10
133   };
134
135   /// IndirectSymbolFlags - Flags for encoding special values in the indirect
136   /// symbol entry.
137   enum IndirectSymbolFlags {
138     ISF_Local    = 0x80000000,
139     ISF_Absolute = 0x40000000
140   };
141
142   /// RelocationFlags - Special flags for addresses.
143   enum RelocationFlags {
144     RF_Scattered = 0x80000000
145   };
146
147   enum RelocationInfoType {
148     RIT_Vanilla             = 0,
149     RIT_Pair                = 1,
150     RIT_Difference          = 2,
151     RIT_PreboundLazyPointer = 3,
152     RIT_LocalDifference     = 4
153   };
154
155   /// MachSymbolData - Helper struct for containing some precomputed information
156   /// on symbols.
157   struct MachSymbolData {
158     MCSymbolData *SymbolData;
159     uint64_t StringIndex;
160     uint8_t SectionIndex;
161
162     // Support lexicographic sorting.
163     bool operator<(const MachSymbolData &RHS) const {
164       const std::string &Name = SymbolData->getSymbol().getName();
165       return Name < RHS.SymbolData->getSymbol().getName();
166     }
167   };
168
169   raw_ostream &OS;
170   unsigned Is64Bit : 1;
171   unsigned IsLSB : 1;
172
173 public:
174   MachObjectWriter(raw_ostream &_OS, bool _Is64Bit, bool _IsLSB = true)
175     : OS(_OS), Is64Bit(_Is64Bit), IsLSB(_IsLSB) {
176   }
177
178   /// @name Helper Methods
179   /// @{
180
181   void Write8(uint8_t Value) {
182     OS << char(Value);
183   }
184
185   void Write16(uint16_t Value) {
186     if (IsLSB) {
187       Write8(uint8_t(Value >> 0));
188       Write8(uint8_t(Value >> 8));
189     } else {
190       Write8(uint8_t(Value >> 8));
191       Write8(uint8_t(Value >> 0));
192     }
193   }
194
195   void Write32(uint32_t Value) {
196     if (IsLSB) {
197       Write16(uint16_t(Value >> 0));
198       Write16(uint16_t(Value >> 16));
199     } else {
200       Write16(uint16_t(Value >> 16));
201       Write16(uint16_t(Value >> 0));
202     }
203   }
204
205   void Write64(uint64_t Value) {
206     if (IsLSB) {
207       Write32(uint32_t(Value >> 0));
208       Write32(uint32_t(Value >> 32));
209     } else {
210       Write32(uint32_t(Value >> 32));
211       Write32(uint32_t(Value >> 0));
212     }
213   }
214
215   void WriteZeros(unsigned N) {
216     const char Zeros[16] = { 0 };
217
218     for (unsigned i = 0, e = N / 16; i != e; ++i)
219       OS << StringRef(Zeros, 16);
220
221     OS << StringRef(Zeros, N % 16);
222   }
223
224   void WriteString(StringRef Str, unsigned ZeroFillSize = 0) {
225     OS << Str;
226     if (ZeroFillSize)
227       WriteZeros(ZeroFillSize - Str.size());
228   }
229
230   /// @}
231
232   void WriteHeader(unsigned NumLoadCommands, unsigned LoadCommandsSize,
233                    bool SubsectionsViaSymbols) {
234     uint32_t Flags = 0;
235
236     if (SubsectionsViaSymbols)
237       Flags |= HF_SubsectionsViaSymbols;
238
239     // struct mach_header (28 bytes) or
240     // struct mach_header_64 (32 bytes)
241
242     uint64_t Start = OS.tell();
243     (void) Start;
244
245     Write32(Is64Bit ? Header_Magic64 : Header_Magic32);
246
247     // FIXME: Support cputype.
248     Write32(Is64Bit ? MachO::CPUTypeX86_64 : MachO::CPUTypeI386);
249     // FIXME: Support cpusubtype.
250     Write32(MachO::CPUSubType_I386_ALL);
251     Write32(HFT_Object);
252     Write32(NumLoadCommands);    // Object files have a single load command, the
253                                  // segment.
254     Write32(LoadCommandsSize);
255     Write32(Flags);
256     if (Is64Bit)
257       Write32(0); // reserved
258
259     assert(OS.tell() - Start == Is64Bit ? Header64Size : Header32Size);
260   }
261
262   /// WriteSegmentLoadCommand - Write a segment load command.
263   ///
264   /// \arg NumSections - The number of sections in this segment.
265   /// \arg SectionDataSize - The total size of the sections.
266   void WriteSegmentLoadCommand(unsigned NumSections,
267                                uint64_t VMSize,
268                                uint64_t SectionDataStartOffset,
269                                uint64_t SectionDataSize) {
270     // struct segment_command (56 bytes) or
271     // struct segment_command_64 (72 bytes)
272
273     uint64_t Start = OS.tell();
274     (void) Start;
275
276     unsigned SegmentLoadCommandSize = Is64Bit ? SegmentLoadCommand64Size :
277       SegmentLoadCommand32Size;
278     Write32(Is64Bit ? LCT_Segment64 : LCT_Segment);
279     Write32(SegmentLoadCommandSize +
280             NumSections * (Is64Bit ? Section64Size : Section32Size));
281
282     WriteString("", 16);
283     if (Is64Bit) {
284       Write64(0); // vmaddr
285       Write64(VMSize); // vmsize
286       Write64(SectionDataStartOffset); // file offset
287       Write64(SectionDataSize); // file size
288     } else {
289       Write32(0); // vmaddr
290       Write32(VMSize); // vmsize
291       Write32(SectionDataStartOffset); // file offset
292       Write32(SectionDataSize); // file size
293     }
294     Write32(0x7); // maxprot
295     Write32(0x7); // initprot
296     Write32(NumSections);
297     Write32(0); // flags
298
299     assert(OS.tell() - Start == SegmentLoadCommandSize);
300   }
301
302   void WriteSection(const MCSectionData &SD, uint64_t FileOffset,
303                     uint64_t RelocationsStart, unsigned NumRelocations) {
304     // The offset is unused for virtual sections.
305     if (isVirtualSection(SD.getSection())) {
306       assert(SD.getFileSize() == 0 && "Invalid file size!");
307       FileOffset = 0;
308     }
309
310     // struct section (68 bytes) or
311     // struct section_64 (80 bytes)
312
313     uint64_t Start = OS.tell();
314     (void) Start;
315
316     // FIXME: cast<> support!
317     const MCSectionMachO &Section =
318       static_cast<const MCSectionMachO&>(SD.getSection());
319     WriteString(Section.getSectionName(), 16);
320     WriteString(Section.getSegmentName(), 16);
321     if (Is64Bit) {
322       Write64(SD.getAddress()); // address
323       Write64(SD.getSize()); // size
324     } else {
325       Write32(SD.getAddress()); // address
326       Write32(SD.getSize()); // size
327     }
328     Write32(FileOffset);
329
330     unsigned Flags = Section.getTypeAndAttributes();
331     if (SD.hasInstructions())
332       Flags |= MCSectionMachO::S_ATTR_SOME_INSTRUCTIONS;
333
334     assert(isPowerOf2_32(SD.getAlignment()) && "Invalid alignment!");
335     Write32(Log2_32(SD.getAlignment()));
336     Write32(NumRelocations ? RelocationsStart : 0);
337     Write32(NumRelocations);
338     Write32(Flags);
339     Write32(0); // reserved1
340     Write32(Section.getStubSize()); // reserved2
341     if (Is64Bit)
342       Write32(0); // reserved3
343
344     assert(OS.tell() - Start == Is64Bit ? Section64Size : Section32Size);
345   }
346
347   void WriteSymtabLoadCommand(uint32_t SymbolOffset, uint32_t NumSymbols,
348                               uint32_t StringTableOffset,
349                               uint32_t StringTableSize) {
350     // struct symtab_command (24 bytes)
351
352     uint64_t Start = OS.tell();
353     (void) Start;
354
355     Write32(LCT_Symtab);
356     Write32(SymtabLoadCommandSize);
357     Write32(SymbolOffset);
358     Write32(NumSymbols);
359     Write32(StringTableOffset);
360     Write32(StringTableSize);
361
362     assert(OS.tell() - Start == SymtabLoadCommandSize);
363   }
364
365   void WriteDysymtabLoadCommand(uint32_t FirstLocalSymbol,
366                                 uint32_t NumLocalSymbols,
367                                 uint32_t FirstExternalSymbol,
368                                 uint32_t NumExternalSymbols,
369                                 uint32_t FirstUndefinedSymbol,
370                                 uint32_t NumUndefinedSymbols,
371                                 uint32_t IndirectSymbolOffset,
372                                 uint32_t NumIndirectSymbols) {
373     // struct dysymtab_command (80 bytes)
374
375     uint64_t Start = OS.tell();
376     (void) Start;
377
378     Write32(LCT_Dysymtab);
379     Write32(DysymtabLoadCommandSize);
380     Write32(FirstLocalSymbol);
381     Write32(NumLocalSymbols);
382     Write32(FirstExternalSymbol);
383     Write32(NumExternalSymbols);
384     Write32(FirstUndefinedSymbol);
385     Write32(NumUndefinedSymbols);
386     Write32(0); // tocoff
387     Write32(0); // ntoc
388     Write32(0); // modtaboff
389     Write32(0); // nmodtab
390     Write32(0); // extrefsymoff
391     Write32(0); // nextrefsyms
392     Write32(IndirectSymbolOffset);
393     Write32(NumIndirectSymbols);
394     Write32(0); // extreloff
395     Write32(0); // nextrel
396     Write32(0); // locreloff
397     Write32(0); // nlocrel
398
399     assert(OS.tell() - Start == DysymtabLoadCommandSize);
400   }
401
402   void WriteNlist(MachSymbolData &MSD) {
403     MCSymbolData &Data = *MSD.SymbolData;
404     const MCSymbol &Symbol = Data.getSymbol();
405     uint8_t Type = 0;
406     uint16_t Flags = Data.getFlags();
407     uint32_t Address = 0;
408
409     // Set the N_TYPE bits. See <mach-o/nlist.h>.
410     //
411     // FIXME: Are the prebound or indirect fields possible here?
412     if (Symbol.isUndefined())
413       Type = STT_Undefined;
414     else if (Symbol.isAbsolute())
415       Type = STT_Absolute;
416     else
417       Type = STT_Section;
418
419     // FIXME: Set STAB bits.
420
421     if (Data.isPrivateExtern())
422       Type |= STF_PrivateExtern;
423
424     // Set external bit.
425     if (Data.isExternal() || Symbol.isUndefined())
426       Type |= STF_External;
427
428     // Compute the symbol address.
429     if (Symbol.isDefined()) {
430       if (Symbol.isAbsolute()) {
431         llvm_unreachable("FIXME: Not yet implemented!");
432       } else {
433         Address = Data.getAddress();
434       }
435     } else if (Data.isCommon()) {
436       // Common symbols are encoded with the size in the address
437       // field, and their alignment in the flags.
438       Address = Data.getCommonSize();
439
440       // Common alignment is packed into the 'desc' bits.
441       if (unsigned Align = Data.getCommonAlignment()) {
442         unsigned Log2Size = Log2_32(Align);
443         assert((1U << Log2Size) == Align && "Invalid 'common' alignment!");
444         if (Log2Size > 15)
445           llvm_report_error("invalid 'common' alignment '" +
446                             Twine(Align) + "'");
447         // FIXME: Keep this mask with the SymbolFlags enumeration.
448         Flags = (Flags & 0xF0FF) | (Log2Size << 8);
449       }
450     }
451
452     // struct nlist (12 bytes)
453
454     Write32(MSD.StringIndex);
455     Write8(Type);
456     Write8(MSD.SectionIndex);
457
458     // The Mach-O streamer uses the lowest 16-bits of the flags for the 'desc'
459     // value.
460     Write16(Flags);
461     if (Is64Bit)
462       Write64(Address);
463     else
464       Write32(Address);
465   }
466
467   struct MachRelocationEntry {
468     uint32_t Word0;
469     uint32_t Word1;
470   };
471   void ComputeScatteredRelocationInfo(MCAssembler &Asm, MCFragment &Fragment,
472                                       MCAsmFixup &Fixup,
473                                       const MCValue &Target,
474                                      std::vector<MachRelocationEntry> &Relocs) {
475     uint32_t Address = Fragment.getOffset() + Fixup.Offset;
476     unsigned IsPCRel = isFixupKindPCRel(Fixup.Kind);
477     unsigned Log2Size = getFixupKindLog2Size(Fixup.Kind);
478     unsigned Type = RIT_Vanilla;
479
480     // See <reloc.h>.
481     const MCSymbol *A = Target.getSymA();
482     MCSymbolData *A_SD = &Asm.getSymbolData(*A);
483
484     if (!A_SD->getFragment())
485       llvm_report_error("symbol '" + A->getName() +
486                         "' can not be undefined in a subtraction expression");
487
488     uint32_t Value = A_SD->getAddress();
489     uint32_t Value2 = 0;
490
491     if (const MCSymbol *B = Target.getSymB()) {
492       MCSymbolData *B_SD = &Asm.getSymbolData(*B);
493
494       if (!B_SD->getFragment())
495         llvm_report_error("symbol '" + B->getName() +
496                           "' can not be undefined in a subtraction expression");
497
498       // Select the appropriate difference relocation type.
499       //
500       // Note that there is no longer any semantic difference between these two
501       // relocation types from the linkers point of view, this is done solely
502       // for pedantic compatibility with 'as'.
503       Type = A_SD->isExternal() ? RIT_Difference : RIT_LocalDifference;
504       Value2 = B_SD->getAddress();
505     }
506
507     MachRelocationEntry MRE;
508     MRE.Word0 = ((Address   <<  0) |
509                  (Type      << 24) |
510                  (Log2Size  << 28) |
511                  (IsPCRel   << 30) |
512                  RF_Scattered);
513     MRE.Word1 = Value;
514     Relocs.push_back(MRE);
515
516     if (Type == RIT_Difference || Type == RIT_LocalDifference) {
517       MachRelocationEntry MRE;
518       MRE.Word0 = ((0         <<  0) |
519                    (RIT_Pair  << 24) |
520                    (Log2Size  << 28) |
521                    (IsPCRel   << 30) |
522                    RF_Scattered);
523       MRE.Word1 = Value2;
524       Relocs.push_back(MRE);
525     }
526   }
527
528   void ComputeRelocationInfo(MCAssembler &Asm, MCDataFragment &Fragment,
529                              MCAsmFixup &Fixup,
530                              std::vector<MachRelocationEntry> &Relocs) {
531     unsigned IsPCRel = isFixupKindPCRel(Fixup.Kind);
532     unsigned Log2Size = getFixupKindLog2Size(Fixup.Kind);
533
534     // FIXME: Share layout object.
535     MCAsmLayout Layout(Asm);
536
537     // Evaluate the fixup; if the value was resolved, no relocation is needed.
538     MCValue Target;
539     if (Asm.EvaluateFixup(Layout, Fixup, &Fragment, Target, Fixup.FixedValue))
540       return;
541
542     // If this is a difference or a defined symbol plus an offset, then we need
543     // a scattered relocation entry.
544     uint32_t Offset = Target.getConstant();
545     if (IsPCRel)
546       Offset += 1 << Log2Size;
547     if (Target.getSymB() ||
548         (Target.getSymA() && !Target.getSymA()->isUndefined() &&
549          Offset))
550       return ComputeScatteredRelocationInfo(Asm, Fragment, Fixup, Target,
551                                             Relocs);
552
553     // See <reloc.h>.
554     uint32_t Address = Fragment.getOffset() + Fixup.Offset;
555     uint32_t Value = 0;
556     unsigned Index = 0;
557     unsigned IsExtern = 0;
558     unsigned Type = 0;
559
560     if (Target.isAbsolute()) { // constant
561       // SymbolNum of 0 indicates the absolute section.
562       //
563       // FIXME: Currently, these are never generated (see code below). I cannot
564       // find a case where they are actually emitted.
565       Type = RIT_Vanilla;
566       Value = 0;
567     } else {
568       const MCSymbol *Symbol = Target.getSymA();
569       MCSymbolData *SD = &Asm.getSymbolData(*Symbol);
570
571       if (Symbol->isUndefined()) {
572         IsExtern = 1;
573         Index = SD->getIndex();
574         Value = 0;
575       } else {
576         // The index is the section ordinal.
577         //
578         // FIXME: O(N)
579         Index = 1;
580         MCAssembler::iterator it = Asm.begin(), ie = Asm.end();
581         for (; it != ie; ++it, ++Index)
582           if (&*it == SD->getFragment()->getParent())
583             break;
584         assert(it != ie && "Unable to find section index!");
585         Value = SD->getAddress();
586       }
587
588       Type = RIT_Vanilla;
589     }
590
591     // struct relocation_info (8 bytes)
592     MachRelocationEntry MRE;
593     MRE.Word0 = Address;
594     MRE.Word1 = ((Index     <<  0) |
595                  (IsPCRel   << 24) |
596                  (Log2Size  << 25) |
597                  (IsExtern  << 27) |
598                  (Type      << 28));
599     Relocs.push_back(MRE);
600   }
601
602   void BindIndirectSymbols(MCAssembler &Asm) {
603     // This is the point where 'as' creates actual symbols for indirect symbols
604     // (in the following two passes). It would be easier for us to do this
605     // sooner when we see the attribute, but that makes getting the order in the
606     // symbol table much more complicated than it is worth.
607     //
608     // FIXME: Revisit this when the dust settles.
609
610     // Bind non lazy symbol pointers first.
611     for (MCAssembler::indirect_symbol_iterator it = Asm.indirect_symbol_begin(),
612            ie = Asm.indirect_symbol_end(); it != ie; ++it) {
613       // FIXME: cast<> support!
614       const MCSectionMachO &Section =
615         static_cast<const MCSectionMachO&>(it->SectionData->getSection());
616
617       if (Section.getType() != MCSectionMachO::S_NON_LAZY_SYMBOL_POINTERS)
618         continue;
619
620       Asm.getOrCreateSymbolData(*it->Symbol);
621     }
622
623     // Then lazy symbol pointers and symbol stubs.
624     for (MCAssembler::indirect_symbol_iterator it = Asm.indirect_symbol_begin(),
625            ie = Asm.indirect_symbol_end(); it != ie; ++it) {
626       // FIXME: cast<> support!
627       const MCSectionMachO &Section =
628         static_cast<const MCSectionMachO&>(it->SectionData->getSection());
629
630       if (Section.getType() != MCSectionMachO::S_LAZY_SYMBOL_POINTERS &&
631           Section.getType() != MCSectionMachO::S_SYMBOL_STUBS)
632         continue;
633
634       // Set the symbol type to undefined lazy, but only on construction.
635       //
636       // FIXME: Do not hardcode.
637       bool Created;
638       MCSymbolData &Entry = Asm.getOrCreateSymbolData(*it->Symbol, &Created);
639       if (Created)
640         Entry.setFlags(Entry.getFlags() | 0x0001);
641     }
642   }
643
644   /// ComputeSymbolTable - Compute the symbol table data
645   ///
646   /// \param StringTable [out] - The string table data.
647   /// \param StringIndexMap [out] - Map from symbol names to offsets in the
648   /// string table.
649   void ComputeSymbolTable(MCAssembler &Asm, SmallString<256> &StringTable,
650                           std::vector<MachSymbolData> &LocalSymbolData,
651                           std::vector<MachSymbolData> &ExternalSymbolData,
652                           std::vector<MachSymbolData> &UndefinedSymbolData) {
653     // Build section lookup table.
654     DenseMap<const MCSection*, uint8_t> SectionIndexMap;
655     unsigned Index = 1;
656     for (MCAssembler::iterator it = Asm.begin(),
657            ie = Asm.end(); it != ie; ++it, ++Index)
658       SectionIndexMap[&it->getSection()] = Index;
659     assert(Index <= 256 && "Too many sections!");
660
661     // Index 0 is always the empty string.
662     StringMap<uint64_t> StringIndexMap;
663     StringTable += '\x00';
664
665     // Build the symbol arrays and the string table, but only for non-local
666     // symbols.
667     //
668     // The particular order that we collect the symbols and create the string
669     // table, then sort the symbols is chosen to match 'as'. Even though it
670     // doesn't matter for correctness, this is important for letting us diff .o
671     // files.
672     for (MCAssembler::symbol_iterator it = Asm.symbol_begin(),
673            ie = Asm.symbol_end(); it != ie; ++it) {
674       const MCSymbol &Symbol = it->getSymbol();
675
676       // Ignore assembler temporaries.
677       if (it->getSymbol().isTemporary() &&
678           (!it->getFragment() ||
679            !Asm.getBackend().doesSectionRequireSymbols(
680              it->getFragment()->getParent()->getSection())))
681         continue;
682
683       if (!it->isExternal() && !Symbol.isUndefined())
684         continue;
685
686       uint64_t &Entry = StringIndexMap[Symbol.getName()];
687       if (!Entry) {
688         Entry = StringTable.size();
689         StringTable += Symbol.getName();
690         StringTable += '\x00';
691       }
692
693       MachSymbolData MSD;
694       MSD.SymbolData = it;
695       MSD.StringIndex = Entry;
696
697       if (Symbol.isUndefined()) {
698         MSD.SectionIndex = 0;
699         UndefinedSymbolData.push_back(MSD);
700       } else if (Symbol.isAbsolute()) {
701         MSD.SectionIndex = 0;
702         ExternalSymbolData.push_back(MSD);
703       } else {
704         MSD.SectionIndex = SectionIndexMap.lookup(&Symbol.getSection());
705         assert(MSD.SectionIndex && "Invalid section index!");
706         ExternalSymbolData.push_back(MSD);
707       }
708     }
709
710     // Now add the data for local symbols.
711     for (MCAssembler::symbol_iterator it = Asm.symbol_begin(),
712            ie = Asm.symbol_end(); it != ie; ++it) {
713       const MCSymbol &Symbol = it->getSymbol();
714
715       // Ignore assembler temporaries.
716       if (it->getSymbol().isTemporary() &&
717           (!it->getFragment() ||
718            !Asm.getBackend().doesSectionRequireSymbols(
719              it->getFragment()->getParent()->getSection())))
720         continue;
721
722       if (it->isExternal() || Symbol.isUndefined())
723         continue;
724
725       uint64_t &Entry = StringIndexMap[Symbol.getName()];
726       if (!Entry) {
727         Entry = StringTable.size();
728         StringTable += Symbol.getName();
729         StringTable += '\x00';
730       }
731
732       MachSymbolData MSD;
733       MSD.SymbolData = it;
734       MSD.StringIndex = Entry;
735
736       if (Symbol.isAbsolute()) {
737         MSD.SectionIndex = 0;
738         LocalSymbolData.push_back(MSD);
739       } else {
740         MSD.SectionIndex = SectionIndexMap.lookup(&Symbol.getSection());
741         assert(MSD.SectionIndex && "Invalid section index!");
742         LocalSymbolData.push_back(MSD);
743       }
744     }
745
746     // External and undefined symbols are required to be in lexicographic order.
747     std::sort(ExternalSymbolData.begin(), ExternalSymbolData.end());
748     std::sort(UndefinedSymbolData.begin(), UndefinedSymbolData.end());
749
750     // Set the symbol indices.
751     Index = 0;
752     for (unsigned i = 0, e = LocalSymbolData.size(); i != e; ++i)
753       LocalSymbolData[i].SymbolData->setIndex(Index++);
754     for (unsigned i = 0, e = ExternalSymbolData.size(); i != e; ++i)
755       ExternalSymbolData[i].SymbolData->setIndex(Index++);
756     for (unsigned i = 0, e = UndefinedSymbolData.size(); i != e; ++i)
757       UndefinedSymbolData[i].SymbolData->setIndex(Index++);
758
759     // The string table is padded to a multiple of 4.
760     while (StringTable.size() % 4)
761       StringTable += '\x00';
762   }
763
764   void WriteObject(MCAssembler &Asm) {
765     unsigned NumSections = Asm.size();
766
767     // Create symbol data for any indirect symbols.
768     BindIndirectSymbols(Asm);
769
770     // Compute symbol table information.
771     SmallString<256> StringTable;
772     std::vector<MachSymbolData> LocalSymbolData;
773     std::vector<MachSymbolData> ExternalSymbolData;
774     std::vector<MachSymbolData> UndefinedSymbolData;
775     unsigned NumSymbols = Asm.symbol_size();
776
777     // No symbol table command is written if there are no symbols.
778     if (NumSymbols)
779       ComputeSymbolTable(Asm, StringTable, LocalSymbolData, ExternalSymbolData,
780                          UndefinedSymbolData);
781
782     // The section data starts after the header, the segment load command (and
783     // section headers) and the symbol table.
784     unsigned NumLoadCommands = 1;
785     uint64_t LoadCommandsSize = Is64Bit ?
786       SegmentLoadCommand64Size + NumSections * Section64Size :
787       SegmentLoadCommand32Size + NumSections * Section32Size;
788
789     // Add the symbol table load command sizes, if used.
790     if (NumSymbols) {
791       NumLoadCommands += 2;
792       LoadCommandsSize += SymtabLoadCommandSize + DysymtabLoadCommandSize;
793     }
794
795     // Compute the total size of the section data, as well as its file size and
796     // vm size.
797     uint64_t SectionDataStart = (Is64Bit ? Header64Size : Header32Size)
798       + LoadCommandsSize;
799     uint64_t SectionDataSize = 0;
800     uint64_t SectionDataFileSize = 0;
801     uint64_t VMSize = 0;
802     for (MCAssembler::iterator it = Asm.begin(),
803            ie = Asm.end(); it != ie; ++it) {
804       MCSectionData &SD = *it;
805
806       VMSize = std::max(VMSize, SD.getAddress() + SD.getSize());
807
808       if (isVirtualSection(SD.getSection()))
809         continue;
810
811       SectionDataSize = std::max(SectionDataSize,
812                                  SD.getAddress() + SD.getSize());
813       SectionDataFileSize = std::max(SectionDataFileSize,
814                                      SD.getAddress() + SD.getFileSize());
815     }
816
817     // The section data is padded to 4 bytes.
818     //
819     // FIXME: Is this machine dependent?
820     unsigned SectionDataPadding = OffsetToAlignment(SectionDataFileSize, 4);
821     SectionDataFileSize += SectionDataPadding;
822
823     // Write the prolog, starting with the header and load command...
824     WriteHeader(NumLoadCommands, LoadCommandsSize,
825                 Asm.getSubsectionsViaSymbols());
826     WriteSegmentLoadCommand(NumSections, VMSize,
827                             SectionDataStart, SectionDataSize);
828
829     // ... and then the section headers.
830     //
831     // We also compute the section relocations while we do this. Note that
832     // computing relocation info will also update the fixup to have the correct
833     // value; this will overwrite the appropriate data in the fragment when it
834     // is written.
835     std::vector<MachRelocationEntry> RelocInfos;
836     uint64_t RelocTableEnd = SectionDataStart + SectionDataFileSize;
837     for (MCAssembler::iterator it = Asm.begin(),
838            ie = Asm.end(); it != ie; ++it) {
839       MCSectionData &SD = *it;
840
841       // The assembler writes relocations in the reverse order they were seen.
842       //
843       // FIXME: It is probably more complicated than this.
844       unsigned NumRelocsStart = RelocInfos.size();
845       for (MCSectionData::reverse_iterator it2 = SD.rbegin(),
846              ie2 = SD.rend(); it2 != ie2; ++it2)
847         if (MCDataFragment *DF = dyn_cast<MCDataFragment>(&*it2))
848           for (unsigned i = 0, e = DF->fixup_size(); i != e; ++i)
849             ComputeRelocationInfo(Asm, *DF, DF->getFixups()[e - i - 1],
850                                   RelocInfos);
851
852       unsigned NumRelocs = RelocInfos.size() - NumRelocsStart;
853       uint64_t SectionStart = SectionDataStart + SD.getAddress();
854       WriteSection(SD, SectionStart, RelocTableEnd, NumRelocs);
855       RelocTableEnd += NumRelocs * RelocationInfoSize;
856     }
857
858     // Write the symbol table load command, if used.
859     if (NumSymbols) {
860       unsigned FirstLocalSymbol = 0;
861       unsigned NumLocalSymbols = LocalSymbolData.size();
862       unsigned FirstExternalSymbol = FirstLocalSymbol + NumLocalSymbols;
863       unsigned NumExternalSymbols = ExternalSymbolData.size();
864       unsigned FirstUndefinedSymbol = FirstExternalSymbol + NumExternalSymbols;
865       unsigned NumUndefinedSymbols = UndefinedSymbolData.size();
866       unsigned NumIndirectSymbols = Asm.indirect_symbol_size();
867       unsigned NumSymTabSymbols =
868         NumLocalSymbols + NumExternalSymbols + NumUndefinedSymbols;
869       uint64_t IndirectSymbolSize = NumIndirectSymbols * 4;
870       uint64_t IndirectSymbolOffset = 0;
871
872       // If used, the indirect symbols are written after the section data.
873       if (NumIndirectSymbols)
874         IndirectSymbolOffset = RelocTableEnd;
875
876       // The symbol table is written after the indirect symbol data.
877       uint64_t SymbolTableOffset = RelocTableEnd + IndirectSymbolSize;
878
879       // The string table is written after symbol table.
880       uint64_t StringTableOffset =
881         SymbolTableOffset + NumSymTabSymbols * (Is64Bit ? Nlist64Size :
882                                                 Nlist32Size);
883       WriteSymtabLoadCommand(SymbolTableOffset, NumSymTabSymbols,
884                              StringTableOffset, StringTable.size());
885
886       WriteDysymtabLoadCommand(FirstLocalSymbol, NumLocalSymbols,
887                                FirstExternalSymbol, NumExternalSymbols,
888                                FirstUndefinedSymbol, NumUndefinedSymbols,
889                                IndirectSymbolOffset, NumIndirectSymbols);
890     }
891
892     // Write the actual section data.
893     for (MCAssembler::iterator it = Asm.begin(), ie = Asm.end(); it != ie; ++it)
894       WriteFileData(OS, *it, *this);
895
896     // Write the extra padding.
897     WriteZeros(SectionDataPadding);
898
899     // Write the relocation entries.
900     for (unsigned i = 0, e = RelocInfos.size(); i != e; ++i) {
901       Write32(RelocInfos[i].Word0);
902       Write32(RelocInfos[i].Word1);
903     }
904
905     // Write the symbol table data, if used.
906     if (NumSymbols) {
907       // Write the indirect symbol entries.
908       for (MCAssembler::indirect_symbol_iterator
909              it = Asm.indirect_symbol_begin(),
910              ie = Asm.indirect_symbol_end(); it != ie; ++it) {
911         // Indirect symbols in the non lazy symbol pointer section have some
912         // special handling.
913         const MCSectionMachO &Section =
914           static_cast<const MCSectionMachO&>(it->SectionData->getSection());
915         if (Section.getType() == MCSectionMachO::S_NON_LAZY_SYMBOL_POINTERS) {
916           // If this symbol is defined and internal, mark it as such.
917           if (it->Symbol->isDefined() &&
918               !Asm.getSymbolData(*it->Symbol).isExternal()) {
919             uint32_t Flags = ISF_Local;
920             if (it->Symbol->isAbsolute())
921               Flags |= ISF_Absolute;
922             Write32(Flags);
923             continue;
924           }
925         }
926
927         Write32(Asm.getSymbolData(*it->Symbol).getIndex());
928       }
929
930       // FIXME: Check that offsets match computed ones.
931
932       // Write the symbol table entries.
933       for (unsigned i = 0, e = LocalSymbolData.size(); i != e; ++i)
934         WriteNlist(LocalSymbolData[i]);
935       for (unsigned i = 0, e = ExternalSymbolData.size(); i != e; ++i)
936         WriteNlist(ExternalSymbolData[i]);
937       for (unsigned i = 0, e = UndefinedSymbolData.size(); i != e; ++i)
938         WriteNlist(UndefinedSymbolData[i]);
939
940       // Write the string table.
941       OS << StringTable.str();
942     }
943   }
944
945   void ApplyFixup(const MCAsmFixup &Fixup, MCDataFragment &DF) {
946     unsigned Size = 1 << getFixupKindLog2Size(Fixup.Kind);
947
948     // FIXME: Endianness assumption.
949     assert(Fixup.Offset + Size <= DF.getContents().size() &&
950            "Invalid fixup offset!");
951     for (unsigned i = 0; i != Size; ++i)
952       DF.getContents()[Fixup.Offset + i] = uint8_t(Fixup.FixedValue >> (i * 8));
953   }
954 };
955
956 /* *** */
957
958 MCFragment::MCFragment() : Kind(FragmentType(~0)) {
959 }
960
961 MCFragment::MCFragment(FragmentType _Kind, MCSectionData *_Parent)
962   : Kind(_Kind),
963     Parent(_Parent),
964     FileSize(~UINT64_C(0))
965 {
966   if (Parent)
967     Parent->getFragmentList().push_back(this);
968 }
969
970 MCFragment::~MCFragment() {
971 }
972
973 uint64_t MCFragment::getAddress() const {
974   assert(getParent() && "Missing Section!");
975   return getParent()->getAddress() + Offset;
976 }
977
978 /* *** */
979
980 MCSectionData::MCSectionData() : Section(0) {}
981
982 MCSectionData::MCSectionData(const MCSection &_Section, MCAssembler *A)
983   : Section(&_Section),
984     Alignment(1),
985     Address(~UINT64_C(0)),
986     Size(~UINT64_C(0)),
987     FileSize(~UINT64_C(0)),
988     HasInstructions(false)
989 {
990   if (A)
991     A->getSectionList().push_back(this);
992 }
993
994 /* *** */
995
996 MCSymbolData::MCSymbolData() : Symbol(0) {}
997
998 MCSymbolData::MCSymbolData(const MCSymbol &_Symbol, MCFragment *_Fragment,
999                            uint64_t _Offset, MCAssembler *A)
1000   : Symbol(&_Symbol), Fragment(_Fragment), Offset(_Offset),
1001     IsExternal(false), IsPrivateExtern(false),
1002     CommonSize(0), CommonAlign(0), Flags(0), Index(0)
1003 {
1004   if (A)
1005     A->getSymbolList().push_back(this);
1006 }
1007
1008 /* *** */
1009
1010 MCAssembler::MCAssembler(MCContext &_Context, TargetAsmBackend &_Backend,
1011                          raw_ostream &_OS)
1012   : Context(_Context), Backend(_Backend), OS(_OS), SubsectionsViaSymbols(false)
1013 {
1014 }
1015
1016 MCAssembler::~MCAssembler() {
1017 }
1018
1019 bool MCAssembler::EvaluateFixup(const MCAsmLayout &Layout, MCAsmFixup &Fixup,
1020                                 MCDataFragment *DF,
1021                                 MCValue &Target, uint64_t &Value) const {
1022   if (!Fixup.Value->EvaluateAsRelocatable(Target, &Layout))
1023     llvm_report_error("expected relocatable expression");
1024
1025   // FIXME: How do non-scattered symbols work in ELF? I presume the linker
1026   // doesn't support small relocations, but then under what criteria does the
1027   // assembler allow symbol differences?
1028
1029   Value = Target.getConstant();
1030
1031   // FIXME: This "resolved" check isn't quite right. The assumption is that if
1032   // we have a PCrel access to a temporary, then that temporary is in the same
1033   // atom, and so the value is resolved. We need explicit atom's to implement
1034   // this more precisely.
1035   bool IsResolved = true, IsPCRel = isFixupKindPCRel(Fixup.Kind);
1036   if (const MCSymbol *Symbol = Target.getSymA()) {
1037     if (Symbol->isDefined())
1038       Value += getSymbolData(*Symbol).getAddress();
1039     else
1040       IsResolved = false;
1041
1042     // With scattered symbols, we assume anything that isn't a PCrel temporary
1043     // access can have an arbitrary value.
1044     if (getBackend().hasScatteredSymbols() &&
1045         (!IsPCRel || !Symbol->isTemporary()))
1046       IsResolved = false;
1047   }
1048   if (const MCSymbol *Symbol = Target.getSymB()) {
1049     if (Symbol->isDefined())
1050       Value -= getSymbolData(*Symbol).getAddress();
1051     else
1052       IsResolved = false;
1053
1054     // With scattered symbols, we assume anything that isn't a PCrel temporary
1055     // access can have an arbitrary value.
1056     if (getBackend().hasScatteredSymbols() &&
1057         (!IsPCRel || !Symbol->isTemporary()))
1058       IsResolved = false;
1059   }
1060
1061   if (IsPCRel)
1062     Value -= DF->getAddress() + Fixup.Offset;
1063
1064   return IsResolved;
1065 }
1066
1067 void MCAssembler::LayoutSection(MCSectionData &SD) {
1068   MCAsmLayout Layout(*this);
1069   uint64_t Address = SD.getAddress();
1070
1071   for (MCSectionData::iterator it = SD.begin(), ie = SD.end(); it != ie; ++it) {
1072     MCFragment &F = *it;
1073
1074     F.setOffset(Address - SD.getAddress());
1075
1076     // Evaluate fragment size.
1077     switch (F.getKind()) {
1078     case MCFragment::FT_Align: {
1079       MCAlignFragment &AF = cast<MCAlignFragment>(F);
1080
1081       uint64_t Size = OffsetToAlignment(Address, AF.getAlignment());
1082       if (Size > AF.getMaxBytesToEmit())
1083         AF.setFileSize(0);
1084       else
1085         AF.setFileSize(Size);
1086       break;
1087     }
1088
1089     case MCFragment::FT_Data:
1090     case MCFragment::FT_Fill:
1091       F.setFileSize(F.getMaxFileSize());
1092       break;
1093
1094     case MCFragment::FT_Org: {
1095       MCOrgFragment &OF = cast<MCOrgFragment>(F);
1096
1097       int64_t TargetLocation;
1098       if (!OF.getOffset().EvaluateAsAbsolute(TargetLocation, &Layout))
1099         llvm_report_error("expected assembly-time absolute expression");
1100
1101       // FIXME: We need a way to communicate this error.
1102       int64_t Offset = TargetLocation - F.getOffset();
1103       if (Offset < 0)
1104         llvm_report_error("invalid .org offset '" + Twine(TargetLocation) +
1105                           "' (at offset '" + Twine(F.getOffset()) + "'");
1106
1107       F.setFileSize(Offset);
1108       break;
1109     }
1110
1111     case MCFragment::FT_ZeroFill: {
1112       MCZeroFillFragment &ZFF = cast<MCZeroFillFragment>(F);
1113
1114       // Align the fragment offset; it is safe to adjust the offset freely since
1115       // this is only in virtual sections.
1116       Address = RoundUpToAlignment(Address, ZFF.getAlignment());
1117       F.setOffset(Address - SD.getAddress());
1118
1119       // FIXME: This is misnamed.
1120       F.setFileSize(ZFF.getSize());
1121       break;
1122     }
1123     }
1124
1125     Address += F.getFileSize();
1126   }
1127
1128   // Set the section sizes.
1129   SD.setSize(Address - SD.getAddress());
1130   if (isVirtualSection(SD.getSection()))
1131     SD.setFileSize(0);
1132   else
1133     SD.setFileSize(Address - SD.getAddress());
1134 }
1135
1136 /// WriteNopData - Write optimal nops to the output file for the \arg Count
1137 /// bytes.  This returns the number of bytes written.  It may return 0 if
1138 /// the \arg Count is more than the maximum optimal nops.
1139 ///
1140 /// FIXME this is X86 32-bit specific and should move to a better place.
1141 static uint64_t WriteNopData(uint64_t Count, MachObjectWriter &MOW) {
1142   static const uint8_t Nops[16][16] = {
1143     // nop
1144     {0x90},
1145     // xchg %ax,%ax
1146     {0x66, 0x90},
1147     // nopl (%[re]ax)
1148     {0x0f, 0x1f, 0x00},
1149     // nopl 0(%[re]ax)
1150     {0x0f, 0x1f, 0x40, 0x00},
1151     // nopl 0(%[re]ax,%[re]ax,1)
1152     {0x0f, 0x1f, 0x44, 0x00, 0x00},
1153     // nopw 0(%[re]ax,%[re]ax,1)
1154     {0x66, 0x0f, 0x1f, 0x44, 0x00, 0x00},
1155     // nopl 0L(%[re]ax)
1156     {0x0f, 0x1f, 0x80, 0x00, 0x00, 0x00, 0x00},
1157     // nopl 0L(%[re]ax,%[re]ax,1)
1158     {0x0f, 0x1f, 0x84, 0x00, 0x00, 0x00, 0x00, 0x00},
1159     // nopw 0L(%[re]ax,%[re]ax,1)
1160     {0x66, 0x0f, 0x1f, 0x84, 0x00, 0x00, 0x00, 0x00, 0x00},
1161     // nopw %cs:0L(%[re]ax,%[re]ax,1)
1162     {0x66, 0x2e, 0x0f, 0x1f, 0x84, 0x00, 0x00, 0x00, 0x00, 0x00},
1163     // nopl 0(%[re]ax,%[re]ax,1)
1164     // nopw 0(%[re]ax,%[re]ax,1)
1165     {0x0f, 0x1f, 0x44, 0x00, 0x00,
1166      0x66, 0x0f, 0x1f, 0x44, 0x00, 0x00},
1167     // nopw 0(%[re]ax,%[re]ax,1)
1168     // nopw 0(%[re]ax,%[re]ax,1)
1169     {0x66, 0x0f, 0x1f, 0x44, 0x00, 0x00,
1170      0x66, 0x0f, 0x1f, 0x44, 0x00, 0x00},
1171     // nopw 0(%[re]ax,%[re]ax,1)
1172     // nopl 0L(%[re]ax) */
1173     {0x66, 0x0f, 0x1f, 0x44, 0x00, 0x00,
1174      0x0f, 0x1f, 0x80, 0x00, 0x00, 0x00, 0x00},
1175     // nopl 0L(%[re]ax)
1176     // nopl 0L(%[re]ax)
1177     {0x0f, 0x1f, 0x80, 0x00, 0x00, 0x00, 0x00,
1178      0x0f, 0x1f, 0x80, 0x00, 0x00, 0x00, 0x00},
1179     // nopl 0L(%[re]ax)
1180     // nopl 0L(%[re]ax,%[re]ax,1)
1181     {0x0f, 0x1f, 0x80, 0x00, 0x00, 0x00, 0x00,
1182      0x0f, 0x1f, 0x84, 0x00, 0x00, 0x00, 0x00, 0x00}
1183   };
1184
1185   if (Count > 15)
1186     return 0;
1187
1188   for (uint64_t i = 0; i < Count; i++)
1189     MOW.Write8 (uint8_t(Nops[Count - 1][i]));
1190
1191   return Count;
1192 }
1193
1194 /// WriteFileData - Write the \arg F data to the output file.
1195 static void WriteFileData(raw_ostream &OS, const MCFragment &F,
1196                           MachObjectWriter &MOW) {
1197   uint64_t Start = OS.tell();
1198   (void) Start;
1199
1200   ++EmittedFragments;
1201
1202   // FIXME: Embed in fragments instead?
1203   switch (F.getKind()) {
1204   case MCFragment::FT_Align: {
1205     MCAlignFragment &AF = cast<MCAlignFragment>(F);
1206     uint64_t Count = AF.getFileSize() / AF.getValueSize();
1207
1208     // FIXME: This error shouldn't actually occur (the front end should emit
1209     // multiple .align directives to enforce the semantics it wants), but is
1210     // severe enough that we want to report it. How to handle this?
1211     if (Count * AF.getValueSize() != AF.getFileSize())
1212       llvm_report_error("undefined .align directive, value size '" +
1213                         Twine(AF.getValueSize()) +
1214                         "' is not a divisor of padding size '" +
1215                         Twine(AF.getFileSize()) + "'");
1216
1217     // See if we are aligning with nops, and if so do that first to try to fill
1218     // the Count bytes.  Then if that did not fill any bytes or there are any
1219     // bytes left to fill use the the Value and ValueSize to fill the rest.
1220     if (AF.getEmitNops()) {
1221       uint64_t NopByteCount = WriteNopData(Count, MOW);
1222       Count -= NopByteCount;
1223     }
1224
1225     for (uint64_t i = 0; i != Count; ++i) {
1226       switch (AF.getValueSize()) {
1227       default:
1228         assert(0 && "Invalid size!");
1229       case 1: MOW.Write8 (uint8_t (AF.getValue())); break;
1230       case 2: MOW.Write16(uint16_t(AF.getValue())); break;
1231       case 4: MOW.Write32(uint32_t(AF.getValue())); break;
1232       case 8: MOW.Write64(uint64_t(AF.getValue())); break;
1233       }
1234     }
1235     break;
1236   }
1237
1238   case MCFragment::FT_Data: {
1239     MCDataFragment &DF = cast<MCDataFragment>(F);
1240
1241     // Apply the fixups.
1242     //
1243     // FIXME: Move elsewhere.
1244     for (MCDataFragment::const_fixup_iterator it = DF.fixup_begin(),
1245            ie = DF.fixup_end(); it != ie; ++it)
1246       MOW.ApplyFixup(*it, DF);
1247
1248     OS << cast<MCDataFragment>(F).getContents().str();
1249     break;
1250   }
1251
1252   case MCFragment::FT_Fill: {
1253     MCFillFragment &FF = cast<MCFillFragment>(F);
1254     for (uint64_t i = 0, e = FF.getCount(); i != e; ++i) {
1255       switch (FF.getValueSize()) {
1256       default:
1257         assert(0 && "Invalid size!");
1258       case 1: MOW.Write8 (uint8_t (FF.getValue())); break;
1259       case 2: MOW.Write16(uint16_t(FF.getValue())); break;
1260       case 4: MOW.Write32(uint32_t(FF.getValue())); break;
1261       case 8: MOW.Write64(uint64_t(FF.getValue())); break;
1262       }
1263     }
1264     break;
1265   }
1266
1267   case MCFragment::FT_Org: {
1268     MCOrgFragment &OF = cast<MCOrgFragment>(F);
1269
1270     for (uint64_t i = 0, e = OF.getFileSize(); i != e; ++i)
1271       MOW.Write8(uint8_t(OF.getValue()));
1272
1273     break;
1274   }
1275
1276   case MCFragment::FT_ZeroFill: {
1277     assert(0 && "Invalid zero fill fragment in concrete section!");
1278     break;
1279   }
1280   }
1281
1282   assert(OS.tell() - Start == F.getFileSize());
1283 }
1284
1285 /// WriteFileData - Write the \arg SD data to the output file.
1286 static void WriteFileData(raw_ostream &OS, const MCSectionData &SD,
1287                           MachObjectWriter &MOW) {
1288   // Ignore virtual sections.
1289   if (isVirtualSection(SD.getSection())) {
1290     assert(SD.getFileSize() == 0);
1291     return;
1292   }
1293
1294   uint64_t Start = OS.tell();
1295   (void) Start;
1296
1297   for (MCSectionData::const_iterator it = SD.begin(),
1298          ie = SD.end(); it != ie; ++it)
1299     WriteFileData(OS, *it, MOW);
1300
1301   // Add section padding.
1302   assert(SD.getFileSize() >= SD.getSize() && "Invalid section sizes!");
1303   MOW.WriteZeros(SD.getFileSize() - SD.getSize());
1304
1305   assert(OS.tell() - Start == SD.getFileSize());
1306 }
1307
1308 void MCAssembler::Finish() {
1309   DEBUG_WITH_TYPE("mc-dump", {
1310       llvm::errs() << "assembler backend - pre-layout\n--\n";
1311       dump(); });
1312
1313   // Layout until everything fits.
1314   while (LayoutOnce())
1315     continue;
1316
1317   DEBUG_WITH_TYPE("mc-dump", {
1318       llvm::errs() << "assembler backend - post-layout\n--\n";
1319       dump(); });
1320
1321   // Write the object file.
1322   //
1323   // FIXME: Factor out MCObjectWriter.
1324   bool Is64Bit = StringRef(getBackend().getTarget().getName()) == "x86-64";
1325   MachObjectWriter MOW(OS, Is64Bit);
1326   MOW.WriteObject(*this);
1327
1328   OS.flush();
1329 }
1330
1331 bool MCAssembler::FixupNeedsRelaxation(MCAsmFixup &Fixup, MCDataFragment *DF) {
1332   // FIXME: Share layout object.
1333   MCAsmLayout Layout(*this);
1334
1335   // Currently we only need to relax X86::reloc_pcrel_1byte.
1336   if (unsigned(Fixup.Kind) != X86::reloc_pcrel_1byte)
1337     return false;
1338
1339   // If we cannot resolve the fixup value, it requires relaxation.
1340   MCValue Target;
1341   uint64_t Value;
1342   if (!EvaluateFixup(Layout, Fixup, DF, Target, Value))
1343     return true;
1344
1345   // Otherwise, relax if the value is too big for a (signed) i8.
1346   return int64_t(Value) != int64_t(int8_t(Value));
1347 }
1348
1349 bool MCAssembler::LayoutOnce() {
1350   // Layout the concrete sections and fragments.
1351   uint64_t Address = 0;
1352   MCSectionData *Prev = 0;
1353   for (iterator it = begin(), ie = end(); it != ie; ++it) {
1354     MCSectionData &SD = *it;
1355
1356     // Skip virtual sections.
1357     if (isVirtualSection(SD.getSection()))
1358       continue;
1359
1360     // Align this section if necessary by adding padding bytes to the previous
1361     // section.
1362     if (uint64_t Pad = OffsetToAlignment(Address, it->getAlignment())) {
1363       assert(Prev && "Missing prev section!");
1364       Prev->setFileSize(Prev->getFileSize() + Pad);
1365       Address += Pad;
1366     }
1367
1368     // Layout the section fragments and its size.
1369     SD.setAddress(Address);
1370     LayoutSection(SD);
1371     Address += SD.getFileSize();
1372
1373     Prev = &SD;
1374   }
1375
1376   // Layout the virtual sections.
1377   for (iterator it = begin(), ie = end(); it != ie; ++it) {
1378     MCSectionData &SD = *it;
1379
1380     if (!isVirtualSection(SD.getSection()))
1381       continue;
1382
1383     // Align this section if necessary by adding padding bytes to the previous
1384     // section.
1385     if (uint64_t Pad = OffsetToAlignment(Address, it->getAlignment()))
1386       Address += Pad;
1387
1388     SD.setAddress(Address);
1389     LayoutSection(SD);
1390     Address += SD.getSize();
1391   }
1392
1393   // Scan the fixups in order and relax any that don't fit.
1394   for (iterator it = begin(), ie = end(); it != ie; ++it) {
1395     MCSectionData &SD = *it;
1396
1397     for (MCSectionData::iterator it2 = SD.begin(),
1398            ie2 = SD.end(); it2 != ie2; ++it2) {
1399       MCDataFragment *DF = dyn_cast<MCDataFragment>(it2);
1400       if (!DF)
1401         continue;
1402
1403       for (MCDataFragment::fixup_iterator it3 = DF->fixup_begin(),
1404              ie3 = DF->fixup_end(); it3 != ie3; ++it3) {
1405         MCAsmFixup &Fixup = *it3;
1406
1407         // Check whether we need to relax this fixup.
1408         if (!FixupNeedsRelaxation(Fixup, DF))
1409           continue;
1410
1411         // Relax the instruction.
1412         //
1413         // FIXME: This is a huge temporary hack which just looks for x86
1414         // branches; the only thing we need to relax on x86 is
1415         // 'X86::reloc_pcrel_1byte'. Once we have MCInst fragments, this will be
1416         // replaced by a TargetAsmBackend hook (most likely tblgen'd) to relax
1417         // an individual MCInst.
1418         SmallVectorImpl<char> &C = DF->getContents();
1419         uint64_t PrevOffset = Fixup.Offset;
1420         unsigned Amt = 0;
1421
1422           // jcc instructions
1423         if (unsigned(C[Fixup.Offset-1]) >= 0x70 &&
1424             unsigned(C[Fixup.Offset-1]) <= 0x7f) {
1425           C[Fixup.Offset] = C[Fixup.Offset-1] + 0x10;
1426           C[Fixup.Offset-1] = char(0x0f);
1427           ++Fixup.Offset;
1428           Amt = 4;
1429
1430           // jmp rel8
1431         } else if (C[Fixup.Offset-1] == char(0xeb)) {
1432           C[Fixup.Offset-1] = char(0xe9);
1433           Amt = 3;
1434
1435         } else
1436           llvm_unreachable("unknown 1 byte pcrel instruction!");
1437
1438         Fixup.Value = MCBinaryExpr::Create(
1439           MCBinaryExpr::Sub, Fixup.Value,
1440           MCConstantExpr::Create(3, getContext()),
1441           getContext());
1442         C.insert(C.begin() + Fixup.Offset, Amt, char(0));
1443         Fixup.Kind = MCFixupKind(X86::reloc_pcrel_4byte);
1444
1445         // Update the remaining fixups, which have slid.
1446         //
1447         // FIXME: This is bad for performance, but will be eliminated by the
1448         // move to MCInst specific fragments.
1449         ++it3;
1450         for (; it3 != ie3; ++it3)
1451           it3->Offset += Amt;
1452
1453         // Update all the symbols for this fragment, which may have slid.
1454         //
1455         // FIXME: This is really really bad for performance, but will be
1456         // eliminated by the move to MCInst specific fragments.
1457         for (MCAssembler::symbol_iterator it = symbol_begin(),
1458                ie = symbol_end(); it != ie; ++it) {
1459           MCSymbolData &SD = *it;
1460
1461           if (it->getFragment() != DF)
1462             continue;
1463
1464           if (SD.getOffset() > PrevOffset)
1465             SD.setOffset(SD.getOffset() + Amt);
1466         }
1467
1468         // Restart layout.
1469         //
1470         // FIXME: This is O(N^2), but will be eliminated once we have a smart
1471         // MCAsmLayout object.
1472         return true;
1473       }
1474     }
1475   }
1476
1477   return false;
1478 }
1479
1480 // Debugging methods
1481
1482 namespace llvm {
1483
1484 raw_ostream &operator<<(raw_ostream &OS, const MCAsmFixup &AF) {
1485   OS << "<MCAsmFixup" << " Offset:" << AF.Offset << " Value:" << *AF.Value
1486      << " Kind:" << AF.Kind << ">";
1487   return OS;
1488 }
1489
1490 }
1491
1492 void MCFragment::dump() {
1493   raw_ostream &OS = llvm::errs();
1494
1495   OS << "<MCFragment " << (void*) this << " Offset:" << Offset
1496      << " FileSize:" << FileSize;
1497
1498   OS << ">";
1499 }
1500
1501 void MCAlignFragment::dump() {
1502   raw_ostream &OS = llvm::errs();
1503
1504   OS << "<MCAlignFragment ";
1505   this->MCFragment::dump();
1506   OS << "\n       ";
1507   OS << " Alignment:" << getAlignment()
1508      << " Value:" << getValue() << " ValueSize:" << getValueSize()
1509      << " MaxBytesToEmit:" << getMaxBytesToEmit() << ">";
1510 }
1511
1512 void MCDataFragment::dump() {
1513   raw_ostream &OS = llvm::errs();
1514
1515   OS << "<MCDataFragment ";
1516   this->MCFragment::dump();
1517   OS << "\n       ";
1518   OS << " Contents:[";
1519   for (unsigned i = 0, e = getContents().size(); i != e; ++i) {
1520     if (i) OS << ",";
1521     OS << hexdigit((Contents[i] >> 4) & 0xF) << hexdigit(Contents[i] & 0xF);
1522   }
1523   OS << "] (" << getContents().size() << " bytes)";
1524
1525   if (!getFixups().empty()) {
1526     OS << ",\n       ";
1527     OS << " Fixups:[";
1528     for (fixup_iterator it = fixup_begin(), ie = fixup_end(); it != ie; ++it) {
1529       if (it != fixup_begin()) OS << ",\n                ";
1530       OS << *it;
1531     }
1532     OS << "]";
1533   }
1534
1535   OS << ">";
1536 }
1537
1538 void MCFillFragment::dump() {
1539   raw_ostream &OS = llvm::errs();
1540
1541   OS << "<MCFillFragment ";
1542   this->MCFragment::dump();
1543   OS << "\n       ";
1544   OS << " Value:" << getValue() << " ValueSize:" << getValueSize()
1545      << " Count:" << getCount() << ">";
1546 }
1547
1548 void MCOrgFragment::dump() {
1549   raw_ostream &OS = llvm::errs();
1550
1551   OS << "<MCOrgFragment ";
1552   this->MCFragment::dump();
1553   OS << "\n       ";
1554   OS << " Offset:" << getOffset() << " Value:" << getValue() << ">";
1555 }
1556
1557 void MCZeroFillFragment::dump() {
1558   raw_ostream &OS = llvm::errs();
1559
1560   OS << "<MCZeroFillFragment ";
1561   this->MCFragment::dump();
1562   OS << "\n       ";
1563   OS << " Size:" << getSize() << " Alignment:" << getAlignment() << ">";
1564 }
1565
1566 void MCSectionData::dump() {
1567   raw_ostream &OS = llvm::errs();
1568
1569   OS << "<MCSectionData";
1570   OS << " Alignment:" << getAlignment() << " Address:" << Address
1571      << " Size:" << Size << " FileSize:" << FileSize
1572      << " Fragments:[\n      ";
1573   for (iterator it = begin(), ie = end(); it != ie; ++it) {
1574     if (it != begin()) OS << ",\n      ";
1575     it->dump();
1576   }
1577   OS << "]>";
1578 }
1579
1580 void MCSymbolData::dump() {
1581   raw_ostream &OS = llvm::errs();
1582
1583   OS << "<MCSymbolData Symbol:" << getSymbol()
1584      << " Fragment:" << getFragment() << " Offset:" << getOffset()
1585      << " Flags:" << getFlags() << " Index:" << getIndex();
1586   if (isCommon())
1587     OS << " (common, size:" << getCommonSize()
1588        << " align: " << getCommonAlignment() << ")";
1589   if (isExternal())
1590     OS << " (external)";
1591   if (isPrivateExtern())
1592     OS << " (private extern)";
1593   OS << ">";
1594 }
1595
1596 void MCAssembler::dump() {
1597   raw_ostream &OS = llvm::errs();
1598
1599   OS << "<MCAssembler\n";
1600   OS << "  Sections:[\n    ";
1601   for (iterator it = begin(), ie = end(); it != ie; ++it) {
1602     if (it != begin()) OS << ",\n    ";
1603     it->dump();
1604   }
1605   OS << "],\n";
1606   OS << "  Symbols:[";
1607
1608   for (symbol_iterator it = symbol_begin(), ie = symbol_end(); it != ie; ++it) {
1609     if (it != symbol_begin()) OS << ",\n           ";
1610     it->dump();
1611   }
1612   OS << "]>\n";
1613 }