lib/CodeGen/MachOWriter.cpp

   1 //===-- MachOWriter.cpp - Target-independent Mach-O Writer code -----------===//
   2 //
   3 //                     The LLVM Compiler Infrastructure
   4 //
   5 // This file is distributed under the University of Illinois Open Source
   6 // License. See LICENSE.TXT for details.
   7 //
   8 //===----------------------------------------------------------------------===//
   9 //
  10 // This file implements the target-independent Mach-O writer.  This file writes
  11 // out the Mach-O file in the following order:
  12 //
  13 //  #1 FatHeader (universal-only)
  14 //  #2 FatArch (universal-only, 1 per universal arch)
  15 //  Per arch:
  16 //    #3 Header
  17 //    #4 Load Commands
  18 //    #5 Sections
  19 //    #6 Relocations
  20 //    #7 Symbols
  21 //    #8 Strings
  22 //
  23 //===----------------------------------------------------------------------===//
  24
  25 #include "MachOWriter.h"
  26 #include "llvm/Constants.h"
  27 #include "llvm/DerivedTypes.h"
  28 #include "llvm/Module.h"
  29 #include "llvm/PassManager.h"
  30 #include "llvm/CodeGen/FileWriters.h"
  31 #include "llvm/CodeGen/MachineCodeEmitter.h"
  32 #include "llvm/CodeGen/MachineConstantPool.h"
  33 #include "llvm/CodeGen/MachineJumpTableInfo.h"
  34 #include "llvm/Target/TargetAsmInfo.h"
  35 #include "llvm/Target/TargetJITInfo.h"
  36 #include "llvm/Support/Mangler.h"
  37 #include "llvm/Support/MathExtras.h"
  38 #include "llvm/Support/OutputBuffer.h"
  39 #include "llvm/Support/Streams.h"
  40 #include <algorithm>
  41 #include <cstring>
  42 using namespace llvm;
  43
  44 /// AddMachOWriter - Concrete function to add the Mach-O writer to the function
  45 /// pass manager.
  46 MachineCodeEmitter *llvm::AddMachOWriter(PassManagerBase &PM,
  47                                          std::ostream &O,
  48                                          TargetMachine &TM) {
  49   MachOWriter *MOW = new MachOWriter(O, TM);
  50   PM.add(MOW);
  51   return &MOW->getMachineCodeEmitter();
  52 }
  53
  54 //===----------------------------------------------------------------------===//
  55 //                       MachOCodeEmitter Implementation
  56 //===----------------------------------------------------------------------===//
  57
  58 namespace llvm {
  59   /// MachOCodeEmitter - This class is used by the MachOWriter to emit the code
  60   /// for functions to the Mach-O file.
  61   class MachOCodeEmitter : public MachineCodeEmitter {
  62     MachOWriter &MOW;
  63
  64     /// Target machine description.
  65     TargetMachine &TM;
  66
  67     /// is64Bit/isLittleEndian - This information is inferred from the target
  68     /// machine directly, indicating what header values and flags to set.
  69     bool is64Bit, isLittleEndian;
  70
  71     /// Relocations - These are the relocations that the function needs, as
  72     /// emitted.
  73     std::vector<MachineRelocation> Relocations;
  74
  75     /// CPLocations - This is a map of constant pool indices to offsets from the
  76     /// start of the section for that constant pool index.
  77     std::vector<intptr_t> CPLocations;
  78
  79     /// CPSections - This is a map of constant pool indices to the MachOSection
  80     /// containing the constant pool entry for that index.
  81     std::vector<unsigned> CPSections;
  82
  83     /// JTLocations - This is a map of jump table indices to offsets from the
  84     /// start of the section for that jump table index.
  85     std::vector<intptr_t> JTLocations;
  86
  87     /// MBBLocations - This vector is a mapping from MBB ID's to their address.
  88     /// It is filled in by the StartMachineBasicBlock callback and queried by
  89     /// the getMachineBasicBlockAddress callback.
  90     std::vector<intptr_t> MBBLocations;
  91
  92   public:
  93     MachOCodeEmitter(MachOWriter &mow) : MOW(mow), TM(MOW.TM) {
  94       is64Bit = TM.getTargetData()->getPointerSizeInBits() == 64;
  95       isLittleEndian = TM.getTargetData()->isLittleEndian();
  96     }
  97
  98     virtual void startFunction(MachineFunction &MF);
  99     virtual bool finishFunction(MachineFunction &MF);
 100
 101     virtual void addRelocation(const MachineRelocation &MR) {
 102       Relocations.push_back(MR);
 103     }
 104
 105     void emitConstantPool(MachineConstantPool *MCP);
 106     void emitJumpTables(MachineJumpTableInfo *MJTI);
 107
 108     virtual intptr_t getConstantPoolEntryAddress(unsigned Index) const {
 109       assert(CPLocations.size() > Index && "CP not emitted!");
 110       return CPLocations[Index];
 111     }
 112     virtual intptr_t getJumpTableEntryAddress(unsigned Index) const {
 113       assert(JTLocations.size() > Index && "JT not emitted!");
 114       return JTLocations[Index];
 115     }
 116
 117     virtual void StartMachineBasicBlock(MachineBasicBlock *MBB) {
 118       if (MBBLocations.size() <= (unsigned)MBB->getNumber())
 119         MBBLocations.resize((MBB->getNumber()+1)*2);
 120       MBBLocations[MBB->getNumber()] = getCurrentPCOffset();
 121     }
 122
 123     virtual intptr_t getMachineBasicBlockAddress(MachineBasicBlock *MBB) const {
 124       assert(MBBLocations.size() > (unsigned)MBB->getNumber() &&
 125              MBBLocations[MBB->getNumber()] && "MBB not emitted!");
 126       return MBBLocations[MBB->getNumber()];
 127     }
 128
 129     virtual intptr_t getLabelAddress(uint64_t Label) const {
 130       assert(0 && "get Label not implemented");
 131       abort();
 132       return 0;
 133     }
 134
 135     virtual void emitLabel(uint64_t LabelID) {
 136       assert(0 && "emit Label not implemented");
 137       abort();
 138     }
 139
 140
 141     virtual void setModuleInfo(llvm::MachineModuleInfo* MMI) { }
 142
 143     /// JIT SPECIFIC FUNCTIONS - DO NOT IMPLEMENT THESE HERE!
 144     virtual void startFunctionStub(const GlobalValue* F, unsigned StubSize,
 145                                    unsigned Alignment = 1) {
 146       assert(0 && "JIT specific function called!");
 147       abort();
 148     }
 149     virtual void *finishFunctionStub(const GlobalValue* F) {
 150       assert(0 && "JIT specific function called!");
 151       abort();
 152       return 0;
 153     }
 154   };
 155 }
 156
 157 /// startFunction - This callback is invoked when a new machine function is
 158 /// about to be emitted.
 159 void MachOCodeEmitter::startFunction(MachineFunction &MF) {
 160   const TargetData *TD = TM.getTargetData();
 161   const Function *F = MF.getFunction();
 162
 163   // Align the output buffer to the appropriate alignment, power of 2.
 164   unsigned FnAlign = F->getAlignment();
 165   unsigned TDAlign = TD->getPrefTypeAlignment(F->getType());
 166   unsigned Align = Log2_32(std::max(FnAlign, TDAlign));
 167   assert(!(Align & (Align-1)) && "Alignment is not a power of two!");
 168
 169   // Get the Mach-O Section that this function belongs in.
 170   MachOWriter::MachOSection *MOS = MOW.getTextSection();
 171
 172   // FIXME: better memory management
 173   MOS->SectionData.reserve(4096);
 174   BufferBegin = &MOS->SectionData[0];
 175   BufferEnd = BufferBegin + MOS->SectionData.capacity();
 176
 177   // Upgrade the section alignment if required.
 178   if (MOS->align < Align) MOS->align = Align;
 179
 180   // Round the size up to the correct alignment for starting the new function.
 181   if ((MOS->size & ((1 << Align) - 1)) != 0) {
 182     MOS->size += (1 << Align);
 183     MOS->size &= ~((1 << Align) - 1);
 184   }
 185
 186   // FIXME: Using MOS->size directly here instead of calculating it from the
 187   // output buffer size (impossible because the code emitter deals only in raw
 188   // bytes) forces us to manually synchronize size and write padding zero bytes
 189   // to the output buffer for all non-text sections.  For text sections, we do
 190   // not synchonize the output buffer, and we just blow up if anyone tries to
 191   // write non-code to it.  An assert should probably be added to
 192   // AddSymbolToSection to prevent calling it on the text section.
 193   CurBufferPtr = BufferBegin + MOS->size;
 194
 195   // Clear per-function data structures.
 196   CPLocations.clear();
 197   CPSections.clear();
 198   JTLocations.clear();
 199   MBBLocations.clear();
 200 }
 201
 202 /// finishFunction - This callback is invoked after the function is completely
 203 /// finished.
 204 bool MachOCodeEmitter::finishFunction(MachineFunction &MF) {
 205   // Get the Mach-O Section that this function belongs in.
 206   MachOWriter::MachOSection *MOS = MOW.getTextSection();
 207
 208   // Get a symbol for the function to add to the symbol table
 209   // FIXME: it seems like we should call something like AddSymbolToSection
 210   // in startFunction rather than changing the section size and symbol n_value
 211   // here.
 212   const GlobalValue *FuncV = MF.getFunction();
 213   MachOSym FnSym(FuncV, MOW.Mang->getValueName(FuncV), MOS->Index, TM);
 214   FnSym.n_value = MOS->size;
 215   MOS->size = CurBufferPtr - BufferBegin;
 216
 217   // Emit constant pool to appropriate section(s)
 218   emitConstantPool(MF.getConstantPool());
 219
 220   // Emit jump tables to appropriate section
 221   emitJumpTables(MF.getJumpTableInfo());
 222
 223   // If we have emitted any relocations to function-specific objects such as
 224   // basic blocks, constant pools entries, or jump tables, record their
 225   // addresses now so that we can rewrite them with the correct addresses
 226   // later.
 227   for (unsigned i = 0, e = Relocations.size(); i != e; ++i) {
 228     MachineRelocation &MR = Relocations[i];
 229     intptr_t Addr;
 230
 231     if (MR.isBasicBlock()) {
 232       Addr = getMachineBasicBlockAddress(MR.getBasicBlock());
 233       MR.setConstantVal(MOS->Index);
 234       MR.setResultPointer((void*)Addr);
 235     } else if (MR.isJumpTableIndex()) {
 236       Addr = getJumpTableEntryAddress(MR.getJumpTableIndex());
 237       MR.setConstantVal(MOW.getJumpTableSection()->Index);
 238       MR.setResultPointer((void*)Addr);
 239     } else if (MR.isConstantPoolIndex()) {
 240       Addr = getConstantPoolEntryAddress(MR.getConstantPoolIndex());
 241       MR.setConstantVal(CPSections[MR.getConstantPoolIndex()]);
 242       MR.setResultPointer((void*)Addr);
 243     } else if (MR.isGlobalValue()) {
 244       // FIXME: This should be a set or something that uniques
 245       MOW.PendingGlobals.push_back(MR.getGlobalValue());
 246     } else {
 247       assert(0 && "Unhandled relocation type");
 248     }
 249     MOS->Relocations.push_back(MR);
 250   }
 251   Relocations.clear();
 252
 253   // Finally, add it to the symtab.
 254   MOW.SymbolTable.push_back(FnSym);
 255   return false;
 256 }
 257
 258 /// emitConstantPool - For each constant pool entry, figure out which section
 259 /// the constant should live in, allocate space for it, and emit it to the
 260 /// Section data buffer.
 261 void MachOCodeEmitter::emitConstantPool(MachineConstantPool *MCP) {
 262   const std::vector<MachineConstantPoolEntry> &CP = MCP->getConstants();
 263   if (CP.empty()) return;
 264
 265   // FIXME: handle PIC codegen
 266   bool isPIC = TM.getRelocationModel() == Reloc::PIC_;
 267   assert(!isPIC && "PIC codegen not yet handled for mach-o jump tables!");
 268
 269   // Although there is no strict necessity that I am aware of, we will do what
 270   // gcc for OS X does and put each constant pool entry in a section of constant
 271   // objects of a certain size.  That means that float constants go in the
 272   // literal4 section, and double objects go in literal8, etc.
 273   //
 274   // FIXME: revisit this decision if we ever do the "stick everything into one
 275   // "giant object for PIC" optimization.
 276   for (unsigned i = 0, e = CP.size(); i != e; ++i) {
 277     const Type *Ty = CP[i].getType();
 278     unsigned Size = TM.getTargetData()->getABITypeSize(Ty);
 279
 280     MachOWriter::MachOSection *Sec = MOW.getConstSection(CP[i].Val.ConstVal);
 281     OutputBuffer SecDataOut(Sec->SectionData, is64Bit, isLittleEndian);
 282
 283     CPLocations.push_back(Sec->SectionData.size());
 284     CPSections.push_back(Sec->Index);
 285
 286     // FIXME: remove when we have unified size + output buffer
 287     Sec->size += Size;
 288
 289     // Allocate space in the section for the global.
 290     // FIXME: need alignment?
 291     // FIXME: share between here and AddSymbolToSection?
 292     for (unsigned j = 0; j < Size; ++j)
 293       SecDataOut.outbyte(0);
 294
 295     MOW.InitMem(CP[i].Val.ConstVal, &Sec->SectionData[0], CPLocations[i],
 296                 TM.getTargetData(), Sec->Relocations);
 297   }
 298 }
 299
 300 /// emitJumpTables - Emit all the jump tables for a given jump table info
 301 /// record to the appropriate section.
 302 void MachOCodeEmitter::emitJumpTables(MachineJumpTableInfo *MJTI) {
 303   const std::vector<MachineJumpTableEntry> &JT = MJTI->getJumpTables();
 304   if (JT.empty()) return;
 305
 306   // FIXME: handle PIC codegen
 307   bool isPIC = TM.getRelocationModel() == Reloc::PIC_;
 308   assert(!isPIC && "PIC codegen not yet handled for mach-o jump tables!");
 309
 310   MachOWriter::MachOSection *Sec = MOW.getJumpTableSection();
 311   unsigned TextSecIndex = MOW.getTextSection()->Index;
 312   OutputBuffer SecDataOut(Sec->SectionData, is64Bit, isLittleEndian);
 313
 314   for (unsigned i = 0, e = JT.size(); i != e; ++i) {
 315     // For each jump table, record its offset from the start of the section,
 316     // reserve space for the relocations to the MBBs, and add the relocations.
 317     const std::vector<MachineBasicBlock*> &MBBs = JT[i].MBBs;
 318     JTLocations.push_back(Sec->SectionData.size());
 319     for (unsigned mi = 0, me = MBBs.size(); mi != me; ++mi) {
 320       MachineRelocation MR(MOW.GetJTRelocation(Sec->SectionData.size(),
 321                                                MBBs[mi]));
 322       MR.setResultPointer((void *)JTLocations[i]);
 323       MR.setConstantVal(TextSecIndex);
 324       Sec->Relocations.push_back(MR);
 325       SecDataOut.outaddr(0);
 326     }
 327   }
 328   // FIXME: remove when we have unified size + output buffer
 329   Sec->size = Sec->SectionData.size();
 330 }
 331
 332 //===----------------------------------------------------------------------===//
 333 //                          MachOWriter Implementation
 334 //===----------------------------------------------------------------------===//
 335
 336 char MachOWriter::ID = 0;
 337 MachOWriter::MachOWriter(std::ostream &o, TargetMachine &tm)
 338   : MachineFunctionPass((intptr_t)&ID), O(o), TM(tm) {
 339   is64Bit = TM.getTargetData()->getPointerSizeInBits() == 64;
 340   isLittleEndian = TM.getTargetData()->isLittleEndian();
 341
 342   // Create the machine code emitter object for this target.
 343   MCE = new MachOCodeEmitter(*this);
 344 }
 345
 346 MachOWriter::~MachOWriter() {
 347   delete MCE;
 348 }
 349
 350 void MachOWriter::AddSymbolToSection(MachOSection *Sec, GlobalVariable *GV) {
 351   const Type *Ty = GV->getType()->getElementType();
 352   unsigned Size = TM.getTargetData()->getABITypeSize(Ty);
 353   unsigned Align = TM.getTargetData()->getPreferredAlignment(GV);
 354
 355   // Reserve space in the .bss section for this symbol while maintaining the
 356   // desired section alignment, which must be at least as much as required by
 357   // this symbol.
 358   OutputBuffer SecDataOut(Sec->SectionData, is64Bit, isLittleEndian);
 359
 360   if (Align) {
 361     uint64_t OrigSize = Sec->size;
 362     Align = Log2_32(Align);
 363     Sec->align = std::max(unsigned(Sec->align), Align);
 364     Sec->size = (Sec->size + Align - 1) & ~(Align-1);
 365
 366     // Add alignment padding to buffer as well.
 367     // FIXME: remove when we have unified size + output buffer
 368     unsigned AlignedSize = Sec->size - OrigSize;
 369     for (unsigned i = 0; i < AlignedSize; ++i)
 370       SecDataOut.outbyte(0);
 371   }
 372   // Globals without external linkage apparently do not go in the symbol table.
 373   if (GV->getLinkage() != GlobalValue::InternalLinkage) {
 374     MachOSym Sym(GV, Mang->getValueName(GV), Sec->Index, TM);
 375     Sym.n_value = Sec->size;
 376     SymbolTable.push_back(Sym);
 377   }
 378
 379   // Record the offset of the symbol, and then allocate space for it.
 380   // FIXME: remove when we have unified size + output buffer
 381   Sec->size += Size;
 382
 383   // Now that we know what section the GlovalVariable is going to be emitted
 384   // into, update our mappings.
 385   // FIXME: We may also need to update this when outputting non-GlobalVariable
 386   // GlobalValues such as functions.
 387   GVSection[GV] = Sec;
 388   GVOffset[GV] = Sec->SectionData.size();
 389
 390   // Allocate space in the section for the global.
 391   for (unsigned i = 0; i < Size; ++i)
 392     SecDataOut.outbyte(0);
 393 }
 394
 395 void MachOWriter::EmitGlobal(GlobalVariable *GV) {
 396   const Type *Ty = GV->getType()->getElementType();
 397   unsigned Size = TM.getTargetData()->getABITypeSize(Ty);
 398   bool NoInit = !GV->hasInitializer();
 399
 400   // If this global has a zero initializer, it is part of the .bss or common
 401   // section.
 402   if (NoInit || GV->getInitializer()->isNullValue()) {
 403     // If this global is part of the common block, add it now.  Variables are
 404     // part of the common block if they are zero initialized and allowed to be
 405     // merged with other symbols.
 406     if (NoInit || GV->hasLinkOnceLinkage() || GV->hasWeakLinkage()) {
 407       MachOSym ExtOrCommonSym(GV, Mang->getValueName(GV), MachOSym::NO_SECT,TM);
 408       // For undefined (N_UNDF) external (N_EXT) types, n_value is the size in
 409       // bytes of the symbol.
 410       ExtOrCommonSym.n_value = Size;
 411       SymbolTable.push_back(ExtOrCommonSym);
 412       // Remember that we've seen this symbol
 413       GVOffset[GV] = Size;
 414       return;
 415     }
 416     // Otherwise, this symbol is part of the .bss section.
 417     MachOSection *BSS = getBSSSection();
 418     AddSymbolToSection(BSS, GV);
 419     return;
 420   }
 421
 422   // Scalar read-only data goes in a literal section if the scalar is 4, 8, or
 423   // 16 bytes, or a cstring.  Other read only data goes into a regular const
 424   // section.  Read-write data goes in the data section.
 425   MachOSection *Sec = GV->isConstant() ? getConstSection(GV->getInitializer()) :
 426                                          getDataSection();
 427   AddSymbolToSection(Sec, GV);
 428   InitMem(GV->getInitializer(), &Sec->SectionData[0], GVOffset[GV],
 429           TM.getTargetData(), Sec->Relocations);
 430 }
 431
 432
 433 bool MachOWriter::runOnMachineFunction(MachineFunction &MF) {
 434   // Nothing to do here, this is all done through the MCE object.
 435   return false;
 436 }
 437
 438 bool MachOWriter::doInitialization(Module &M) {
 439   // Set the magic value, now that we know the pointer size and endianness
 440   Header.setMagic(isLittleEndian, is64Bit);
 441
 442   // Set the file type
 443   // FIXME: this only works for object files, we do not support the creation
 444   //        of dynamic libraries or executables at this time.
 445   Header.filetype = MachOHeader::MH_OBJECT;
 446
 447   Mang = new Mangler(M);
 448   return false;
 449 }
 450
 451 /// doFinalization - Now that the module has been completely processed, emit
 452 /// the Mach-O file to 'O'.
 453 bool MachOWriter::doFinalization(Module &M) {
 454   // FIXME: we don't handle debug info yet, we should probably do that.
 455
 456   // Okay, the.text section has been completed, build the .data, .bss, and
 457   // "common" sections next.
 458   for (Module::global_iterator I = M.global_begin(), E = M.global_end();
 459        I != E; ++I)
 460     EmitGlobal(I);
 461
 462   // Emit the header and load commands.
 463   EmitHeaderAndLoadCommands();
 464
 465   // Emit the various sections and their relocation info.
 466   EmitSections();
 467
 468   // Write the symbol table and the string table to the end of the file.
 469   O.write((char*)&SymT[0], SymT.size());
 470   O.write((char*)&StrT[0], StrT.size());
 471
 472   // We are done with the abstract symbols.
 473   SectionList.clear();
 474   SymbolTable.clear();
 475   DynamicSymbolTable.clear();
 476
 477   // Release the name mangler object.
 478   delete Mang; Mang = 0;
 479   return false;
 480 }
 481
 482 void MachOWriter::EmitHeaderAndLoadCommands() {
 483   // Step #0: Fill in the segment load command size, since we need it to figure
 484   //          out the rest of the header fields
 485   MachOSegment SEG("", is64Bit);
 486   SEG.nsects  = SectionList.size();
 487   SEG.cmdsize = SEG.cmdSize(is64Bit) +
 488                 SEG.nsects * SectionList[0]->cmdSize(is64Bit);
 489
 490   // Step #1: calculate the number of load commands.  We always have at least
 491   //          one, for the LC_SEGMENT load command, plus two for the normal
 492   //          and dynamic symbol tables, if there are any symbols.
 493   Header.ncmds = SymbolTable.empty() ? 1 : 3;
 494
 495   // Step #2: calculate the size of the load commands
 496   Header.sizeofcmds = SEG.cmdsize;
 497   if (!SymbolTable.empty())
 498     Header.sizeofcmds += SymTab.cmdsize + DySymTab.cmdsize;
 499
 500   // Step #3: write the header to the file
 501   // Local alias to shortenify coming code.
 502   DataBuffer &FH = Header.HeaderData;
 503   OutputBuffer FHOut(FH, is64Bit, isLittleEndian);
 504
 505   FHOut.outword(Header.magic);
 506   FHOut.outword(TM.getMachOWriterInfo()->getCPUType());
 507   FHOut.outword(TM.getMachOWriterInfo()->getCPUSubType());
 508   FHOut.outword(Header.filetype);
 509   FHOut.outword(Header.ncmds);
 510   FHOut.outword(Header.sizeofcmds);
 511   FHOut.outword(Header.flags);
 512   if (is64Bit)
 513     FHOut.outword(Header.reserved);
 514
 515   // Step #4: Finish filling in the segment load command and write it out
 516   for (std::vector<MachOSection*>::iterator I = SectionList.begin(),
 517          E = SectionList.end(); I != E; ++I)
 518     SEG.filesize += (*I)->size;
 519
 520   SEG.vmsize = SEG.filesize;
 521   SEG.fileoff = Header.cmdSize(is64Bit) + Header.sizeofcmds;
 522
 523   FHOut.outword(SEG.cmd);
 524   FHOut.outword(SEG.cmdsize);
 525   FHOut.outstring(SEG.segname, 16);
 526   FHOut.outaddr(SEG.vmaddr);
 527   FHOut.outaddr(SEG.vmsize);
 528   FHOut.outaddr(SEG.fileoff);
 529   FHOut.outaddr(SEG.filesize);
 530   FHOut.outword(SEG.maxprot);
 531   FHOut.outword(SEG.initprot);
 532   FHOut.outword(SEG.nsects);
 533   FHOut.outword(SEG.flags);
 534
 535   // Step #5: Finish filling in the fields of the MachOSections
 536   uint64_t currentAddr = 0;
 537   for (std::vector<MachOSection*>::iterator I = SectionList.begin(),
 538          E = SectionList.end(); I != E; ++I) {
 539     MachOSection *MOS = *I;
 540     MOS->addr = currentAddr;
 541     MOS->offset = currentAddr + SEG.fileoff;
 542
 543     // FIXME: do we need to do something with alignment here?
 544     currentAddr += MOS->size;
 545   }
 546
 547   // Step #6: Emit the symbol table to temporary buffers, so that we know the
 548   // size of the string table when we write the next load command.  This also
 549   // sorts and assigns indices to each of the symbols, which is necessary for
 550   // emitting relocations to externally-defined objects.
 551   BufferSymbolAndStringTable();
 552
 553   // Step #7: Calculate the number of relocations for each section and write out
 554   // the section commands for each section
 555   currentAddr += SEG.fileoff;
 556   for (std::vector<MachOSection*>::iterator I = SectionList.begin(),
 557          E = SectionList.end(); I != E; ++I) {
 558     MachOSection *MOS = *I;
 559     // Convert the relocations to target-specific relocations, and fill in the
 560     // relocation offset for this section.
 561     CalculateRelocations(*MOS);
 562     MOS->reloff = MOS->nreloc ? currentAddr : 0;
 563     currentAddr += MOS->nreloc * 8;
 564
 565     // write the finalized section command to the output buffer
 566     FHOut.outstring(MOS->sectname, 16);
 567     FHOut.outstring(MOS->segname, 16);
 568     FHOut.outaddr(MOS->addr);
 569     FHOut.outaddr(MOS->size);
 570     FHOut.outword(MOS->offset);
 571     FHOut.outword(MOS->align);
 572     FHOut.outword(MOS->reloff);
 573     FHOut.outword(MOS->nreloc);
 574     FHOut.outword(MOS->flags);
 575     FHOut.outword(MOS->reserved1);
 576     FHOut.outword(MOS->reserved2);
 577     if (is64Bit)
 578       FHOut.outword(MOS->reserved3);
 579   }
 580
 581   // Step #8: Emit LC_SYMTAB/LC_DYSYMTAB load commands
 582   SymTab.symoff  = currentAddr;
 583   SymTab.nsyms   = SymbolTable.size();
 584   SymTab.stroff  = SymTab.symoff + SymT.size();
 585   SymTab.strsize = StrT.size();
 586   FHOut.outword(SymTab.cmd);
 587   FHOut.outword(SymTab.cmdsize);
 588   FHOut.outword(SymTab.symoff);
 589   FHOut.outword(SymTab.nsyms);
 590   FHOut.outword(SymTab.stroff);
 591   FHOut.outword(SymTab.strsize);
 592
 593   // FIXME: set DySymTab fields appropriately
 594   // We should probably just update these in BufferSymbolAndStringTable since
 595   // thats where we're partitioning up the different kinds of symbols.
 596   FHOut.outword(DySymTab.cmd);
 597   FHOut.outword(DySymTab.cmdsize);
 598   FHOut.outword(DySymTab.ilocalsym);
 599   FHOut.outword(DySymTab.nlocalsym);
 600   FHOut.outword(DySymTab.iextdefsym);
 601   FHOut.outword(DySymTab.nextdefsym);
 602   FHOut.outword(DySymTab.iundefsym);
 603   FHOut.outword(DySymTab.nundefsym);
 604   FHOut.outword(DySymTab.tocoff);
 605   FHOut.outword(DySymTab.ntoc);
 606   FHOut.outword(DySymTab.modtaboff);
 607   FHOut.outword(DySymTab.nmodtab);
 608   FHOut.outword(DySymTab.extrefsymoff);
 609   FHOut.outword(DySymTab.nextrefsyms);
 610   FHOut.outword(DySymTab.indirectsymoff);
 611   FHOut.outword(DySymTab.nindirectsyms);
 612   FHOut.outword(DySymTab.extreloff);
 613   FHOut.outword(DySymTab.nextrel);
 614   FHOut.outword(DySymTab.locreloff);
 615   FHOut.outword(DySymTab.nlocrel);
 616
 617   O.write((char*)&FH[0], FH.size());
 618 }
 619
 620 /// EmitSections - Now that we have constructed the file header and load
 621 /// commands, emit the data for each section to the file.
 622 void MachOWriter::EmitSections() {
 623   for (std::vector<MachOSection*>::iterator I = SectionList.begin(),
 624          E = SectionList.end(); I != E; ++I)
 625     // Emit the contents of each section
 626     O.write((char*)&(*I)->SectionData[0], (*I)->size);
 627   for (std::vector<MachOSection*>::iterator I = SectionList.begin(),
 628          E = SectionList.end(); I != E; ++I)
 629     // Emit the relocation entry data for each section.
 630     O.write((char*)&(*I)->RelocBuffer[0], (*I)->RelocBuffer.size());
 631 }
 632
 633 /// PartitionByLocal - Simple boolean predicate that returns true if Sym is
 634 /// a local symbol rather than an external symbol.
 635 bool MachOWriter::PartitionByLocal(const MachOSym &Sym) {
 636   return (Sym.n_type & (MachOSym::N_EXT | MachOSym::N_PEXT)) == 0;
 637 }
 638
 639 /// PartitionByDefined - Simple boolean predicate that returns true if Sym is
 640 /// defined in this module.
 641 bool MachOWriter::PartitionByDefined(const MachOSym &Sym) {
 642   // FIXME: Do N_ABS or N_INDR count as defined?
 643   return (Sym.n_type & MachOSym::N_SECT) == MachOSym::N_SECT;
 644 }
 645
 646 /// BufferSymbolAndStringTable - Sort the symbols we encountered and assign them
 647 /// each a string table index so that they appear in the correct order in the
 648 /// output file.
 649 void MachOWriter::BufferSymbolAndStringTable() {
 650   // The order of the symbol table is:
 651   // 1. local symbols
 652   // 2. defined external symbols (sorted by name)
 653   // 3. undefined external symbols (sorted by name)
 654
 655   // Before sorting the symbols, check the PendingGlobals for any undefined
 656   // globals that need to be put in the symbol table.
 657   for (std::vector<GlobalValue*>::iterator I = PendingGlobals.begin(),
 658          E = PendingGlobals.end(); I != E; ++I) {
 659     if (GVOffset[*I] == 0 && GVSection[*I] == 0) {
 660       MachOSym UndfSym(*I, Mang->getValueName(*I), MachOSym::NO_SECT, TM);
 661       SymbolTable.push_back(UndfSym);
 662       GVOffset[*I] = -1;
 663     }
 664   }
 665
 666   // Sort the symbols by name, so that when we partition the symbols by scope
 667   // of definition, we won't have to sort by name within each partition.
 668   std::sort(SymbolTable.begin(), SymbolTable.end(), MachOSymCmp());
 669
 670   // Parition the symbol table entries so that all local symbols come before
 671   // all symbols with external linkage. { 1 | 2 3 }
 672   std::partition(SymbolTable.begin(), SymbolTable.end(), PartitionByLocal);
 673
 674   // Advance iterator to beginning of external symbols and partition so that
 675   // all external symbols defined in this module come before all external
 676   // symbols defined elsewhere. { 1 | 2 | 3 }
 677   for (std::vector<MachOSym>::iterator I = SymbolTable.begin(),
 678          E = SymbolTable.end(); I != E; ++I) {
 679     if (!PartitionByLocal(*I)) {
 680       std::partition(I, E, PartitionByDefined);
 681       break;
 682     }
 683   }
 684
 685   // Calculate the starting index for each of the local, extern defined, and
 686   // undefined symbols, as well as the number of each to put in the LC_DYSYMTAB
 687   // load command.
 688   for (std::vector<MachOSym>::iterator I = SymbolTable.begin(),
 689          E = SymbolTable.end(); I != E; ++I) {
 690     if (PartitionByLocal(*I)) {
 691       ++DySymTab.nlocalsym;
 692       ++DySymTab.iextdefsym;
 693       ++DySymTab.iundefsym;
 694     } else if (PartitionByDefined(*I)) {
 695       ++DySymTab.nextdefsym;
 696       ++DySymTab.iundefsym;
 697     } else {
 698       ++DySymTab.nundefsym;
 699     }
 700   }
 701
 702   // Write out a leading zero byte when emitting string table, for n_strx == 0
 703   // which means an empty string.
 704   OutputBuffer StrTOut(StrT, is64Bit, isLittleEndian);
 705   StrTOut.outbyte(0);
 706
 707   // The order of the string table is:
 708   // 1. strings for external symbols
 709   // 2. strings for local symbols
 710   // Since this is the opposite order from the symbol table, which we have just
 711   // sorted, we can walk the symbol table backwards to output the string table.
 712   for (std::vector<MachOSym>::reverse_iterator I = SymbolTable.rbegin(),
 713         E = SymbolTable.rend(); I != E; ++I) {
 714     if (I->GVName == "") {
 715       I->n_strx = 0;
 716     } else {
 717       I->n_strx = StrT.size();
 718       StrTOut.outstring(I->GVName, I->GVName.length()+1);
 719     }
 720   }
 721
 722   OutputBuffer SymTOut(SymT, is64Bit, isLittleEndian);
 723
 724   unsigned index = 0;
 725   for (std::vector<MachOSym>::iterator I = SymbolTable.begin(),
 726          E = SymbolTable.end(); I != E; ++I, ++index) {
 727     // Add the section base address to the section offset in the n_value field
 728     // to calculate the full address.
 729     // FIXME: handle symbols where the n_value field is not the address
 730     GlobalValue *GV = const_cast<GlobalValue*>(I->GV);
 731     if (GV && GVSection[GV])
 732       I->n_value += GVSection[GV]->addr;
 733     if (GV && (GVOffset[GV] == -1))
 734       GVOffset[GV] = index;
 735
 736     // Emit nlist to buffer
 737     SymTOut.outword(I->n_strx);
 738     SymTOut.outbyte(I->n_type);
 739     SymTOut.outbyte(I->n_sect);
 740     SymTOut.outhalf(I->n_desc);
 741     SymTOut.outaddr(I->n_value);
 742   }
 743 }
 744
 745 /// CalculateRelocations - For each MachineRelocation in the current section,
 746 /// calculate the index of the section containing the object to be relocated,
 747 /// and the offset into that section.  From this information, create the
 748 /// appropriate target-specific MachORelocation type and add buffer it to be
 749 /// written out after we are finished writing out sections.
 750 void MachOWriter::CalculateRelocations(MachOSection &MOS) {
 751   for (unsigned i = 0, e = MOS.Relocations.size(); i != e; ++i) {
 752     MachineRelocation &MR = MOS.Relocations[i];
 753     unsigned TargetSection = MR.getConstantVal();
 754     unsigned TargetAddr = 0;
 755     unsigned TargetIndex = 0;
 756
 757     // This is a scattered relocation entry if it points to a global value with
 758     // a non-zero offset.
 759     bool Scattered = false;
 760     bool Extern = false;
 761
 762     // Since we may not have seen the GlobalValue we were interested in yet at
 763     // the time we emitted the relocation for it, fix it up now so that it
 764     // points to the offset into the correct section.
 765     if (MR.isGlobalValue()) {
 766       GlobalValue *GV = MR.getGlobalValue();
 767       MachOSection *MOSPtr = GVSection[GV];
 768       intptr_t Offset = GVOffset[GV];
 769
 770       // If we have never seen the global before, it must be to a symbol
 771       // defined in another module (N_UNDF).
 772       if (!MOSPtr) {
 773         // FIXME: need to append stub suffix
 774         Extern = true;
 775         TargetAddr = 0;
 776         TargetIndex = GVOffset[GV];
 777       } else {
 778         Scattered = TargetSection != 0;
 779         TargetSection = MOSPtr->Index;
 780       }
 781       MR.setResultPointer((void*)Offset);
 782     }
 783
 784     // If the symbol is locally defined, pass in the address of the section and
 785     // the section index to the code which will generate the target relocation.
 786     if (!Extern) {
 787         MachOSection &To = *SectionList[TargetSection - 1];
 788         TargetAddr = To.addr;
 789         TargetIndex = To.Index;
 790     }
 791
 792     OutputBuffer RelocOut(MOS.RelocBuffer, is64Bit, isLittleEndian);
 793     OutputBuffer SecOut(MOS.SectionData, is64Bit, isLittleEndian);
 794
 795     MOS.nreloc += GetTargetRelocation(MR, MOS.Index, TargetAddr, TargetIndex,
 796                                       RelocOut, SecOut, Scattered, Extern);
 797   }
 798 }
 799
 800 // InitMem - Write the value of a Constant to the specified memory location,
 801 // converting it into bytes and relocations.
 802 void MachOWriter::InitMem(const Constant *C, void *Addr, intptr_t Offset,
 803                           const TargetData *TD,
 804                           std::vector<MachineRelocation> &MRs) {
 805   typedef std::pair<const Constant*, intptr_t> CPair;
 806   std::vector<CPair> WorkList;
 807
 808   WorkList.push_back(CPair(C,(intptr_t)Addr + Offset));
 809
 810   intptr_t ScatteredOffset = 0;
 811
 812   while (!WorkList.empty()) {
 813     const Constant *PC = WorkList.back().first;
 814     intptr_t PA = WorkList.back().second;
 815     WorkList.pop_back();
 816
 817     if (isa<UndefValue>(PC)) {
 818       continue;
 819     } else if (const ConstantVector *CP = dyn_cast<ConstantVector>(PC)) {
 820       unsigned ElementSize =
 821         TD->getABITypeSize(CP->getType()->getElementType());
 822       for (unsigned i = 0, e = CP->getNumOperands(); i != e; ++i)
 823         WorkList.push_back(CPair(CP->getOperand(i), PA+i*ElementSize));
 824     } else if (const ConstantExpr *CE = dyn_cast<ConstantExpr>(PC)) {
 825       //
 826       // FIXME: Handle ConstantExpression.  See EE::getConstantValue()
 827       //
 828       switch (CE->getOpcode()) {
 829       case Instruction::GetElementPtr: {
 830         SmallVector<Value*, 8> Indices(CE->op_begin()+1, CE->op_end());
 831         ScatteredOffset = TD->getIndexedOffset(CE->getOperand(0)->getType(),
 832                                                &Indices[0], Indices.size());
 833         WorkList.push_back(CPair(CE->getOperand(0), PA));
 834         break;
 835       }
 836       case Instruction::Add:
 837       default:
 838         cerr << "ConstantExpr not handled as global var init: " << *CE << "\n";
 839         abort();
 840         break;
 841       }
 842     } else if (PC->getType()->isFirstClassType()) {
 843       unsigned char *ptr = (unsigned char *)PA;
 844       switch (PC->getType()->getTypeID()) {
 845       case Type::IntegerTyID: {
 846         unsigned NumBits = cast<IntegerType>(PC->getType())->getBitWidth();
 847         uint64_t val = cast<ConstantInt>(PC)->getZExtValue();
 848         if (NumBits <= 8)
 849           ptr[0] = val;
 850         else if (NumBits <= 16) {
 851           if (TD->isBigEndian())
 852             val = ByteSwap_16(val);
 853           ptr[0] = val;
 854           ptr[1] = val >> 8;
 855         } else if (NumBits <= 32) {
 856           if (TD->isBigEndian())
 857             val = ByteSwap_32(val);
 858           ptr[0] = val;
 859           ptr[1] = val >> 8;
 860           ptr[2] = val >> 16;
 861           ptr[3] = val >> 24;
 862         } else if (NumBits <= 64) {
 863           if (TD->isBigEndian())
 864             val = ByteSwap_64(val);
 865           ptr[0] = val;
 866           ptr[1] = val >> 8;
 867           ptr[2] = val >> 16;
 868           ptr[3] = val >> 24;
 869           ptr[4] = val >> 32;
 870           ptr[5] = val >> 40;
 871           ptr[6] = val >> 48;
 872           ptr[7] = val >> 56;
 873         } else {
 874           assert(0 && "Not implemented: bit widths > 64");
 875         }
 876         break;
 877       }
 878       case Type::FloatTyID: {
 879         uint32_t val = cast<ConstantFP>(PC)->getValueAPF().convertToAPInt().
 880                         getZExtValue();
 881         if (TD->isBigEndian())
 882           val = ByteSwap_32(val);
 883         ptr[0] = val;
 884         ptr[1] = val >> 8;
 885         ptr[2] = val >> 16;
 886         ptr[3] = val >> 24;
 887         break;
 888       }
 889       case Type::DoubleTyID: {
 890         uint64_t val = cast<ConstantFP>(PC)->getValueAPF().convertToAPInt().
 891                          getZExtValue();
 892         if (TD->isBigEndian())
 893           val = ByteSwap_64(val);
 894         ptr[0] = val;
 895         ptr[1] = val >> 8;
 896         ptr[2] = val >> 16;
 897         ptr[3] = val >> 24;
 898         ptr[4] = val >> 32;
 899         ptr[5] = val >> 40;
 900         ptr[6] = val >> 48;
 901         ptr[7] = val >> 56;
 902         break;
 903       }
 904       case Type::PointerTyID:
 905         if (isa<ConstantPointerNull>(PC))
 906           memset(ptr, 0, TD->getPointerSize());
 907         else if (const GlobalValue* GV = dyn_cast<GlobalValue>(PC)) {
 908           // FIXME: what about function stubs?
 909           MRs.push_back(MachineRelocation::getGV(PA-(intptr_t)Addr,
 910                                                  MachineRelocation::VANILLA,
 911                                                  const_cast<GlobalValue*>(GV),
 912                                                  ScatteredOffset));
 913           ScatteredOffset = 0;
 914         } else
 915           assert(0 && "Unknown constant pointer type!");
 916         break;
 917       default:
 918         cerr << "ERROR: Constant unimp for type: " << *PC->getType() << "\n";
 919         abort();
 920       }
 921     } else if (isa<ConstantAggregateZero>(PC)) {
 922       memset((void*)PA, 0, (size_t)TD->getABITypeSize(PC->getType()));
 923     } else if (const ConstantArray *CPA = dyn_cast<ConstantArray>(PC)) {
 924       unsigned ElementSize =
 925         TD->getABITypeSize(CPA->getType()->getElementType());
 926       for (unsigned i = 0, e = CPA->getNumOperands(); i != e; ++i)
 927         WorkList.push_back(CPair(CPA->getOperand(i), PA+i*ElementSize));
 928     } else if (const ConstantStruct *CPS = dyn_cast<ConstantStruct>(PC)) {
 929       const StructLayout *SL =
 930         TD->getStructLayout(cast<StructType>(CPS->getType()));
 931       for (unsigned i = 0, e = CPS->getNumOperands(); i != e; ++i)
 932         WorkList.push_back(CPair(CPS->getOperand(i),
 933                                  PA+SL->getElementOffset(i)));
 934     } else {
 935       cerr << "Bad Type: " << *PC->getType() << "\n";
 936       assert(0 && "Unknown constant type to initialize memory with!");
 937     }
 938   }
 939 }
 940
 941 MachOSym::MachOSym(const GlobalValue *gv, std::string name, uint8_t sect,
 942                    TargetMachine &TM) :
 943   GV(gv), n_strx(0), n_type(sect == NO_SECT ? N_UNDF : N_SECT), n_sect(sect),
 944   n_desc(0), n_value(0) {
 945
 946   const TargetAsmInfo *TAI = TM.getTargetAsmInfo();
 947
 948   switch (GV->getLinkage()) {
 949   default:
 950     assert(0 && "Unexpected linkage type!");
 951     break;
 952   case GlobalValue::WeakLinkage:
 953   case GlobalValue::LinkOnceLinkage:
 954     assert(!isa<Function>(gv) && "Unexpected linkage type for Function!");
 955   case GlobalValue::ExternalLinkage:
 956     GVName = TAI->getGlobalPrefix() + name;
 957     n_type |= GV->hasHiddenVisibility() ? N_PEXT : N_EXT;
 958     break;
 959   case GlobalValue::InternalLinkage:
 960     GVName = TAI->getGlobalPrefix() + name;
 961     break;
 962   }
 963 }