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