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