lib/MC/MCMachOStreamer.cpp

   1 //===- lib/MC/MCMachOStreamer.cpp - Mach-O Object Output ------------===//
   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 #include "llvm/MC/MCStreamer.h"
  11
  12 #include "llvm/MC/MCAssembler.h"
  13 #include "llvm/MC/MCContext.h"
  14 #include "llvm/MC/MCCodeEmitter.h"
  15 #include "llvm/MC/MCExpr.h"
  16 #include "llvm/MC/MCInst.h"
  17 #include "llvm/MC/MCObjectStreamer.h"
  18 #include "llvm/MC/MCSection.h"
  19 #include "llvm/MC/MCSymbol.h"
  20 #include "llvm/MC/MCMachOSymbolFlags.h"
  21 #include "llvm/MC/MCSectionMachO.h"
  22 #include "llvm/MC/MCDwarf.h"
  23 #include "llvm/Support/Dwarf.h"
  24 #include "llvm/Support/ErrorHandling.h"
  25 #include "llvm/Support/raw_ostream.h"
  26 #include "llvm/Target/TargetAsmBackend.h"
  27
  28 using namespace llvm;
  29
  30 namespace {
  31
  32 class MCMachOStreamer : public MCObjectStreamer {
  33 private:
  34   virtual void EmitInstToFragment(const MCInst &Inst);
  35   virtual void EmitInstToData(const MCInst &Inst);
  36
  37 public:
  38   MCMachOStreamer(MCContext &Context, TargetAsmBackend &TAB,
  39                   raw_ostream &OS, MCCodeEmitter *Emitter)
  40     : MCObjectStreamer(Context, TAB, OS, Emitter, true) {}
  41
  42   /// @name MCStreamer Interface
  43   /// @{
  44
  45   virtual void InitSections();
  46   virtual void EmitLabel(MCSymbol *Symbol);
  47   virtual void EmitAssemblerFlag(MCAssemblerFlag Flag);
  48   virtual void EmitThumbFunc(MCSymbol *Func);
  49   virtual void EmitAssignment(MCSymbol *Symbol, const MCExpr *Value);
  50   virtual void EmitSymbolAttribute(MCSymbol *Symbol, MCSymbolAttr Attribute);
  51   virtual void EmitSymbolDesc(MCSymbol *Symbol, unsigned DescValue);
  52   virtual void EmitCommonSymbol(MCSymbol *Symbol, uint64_t Size,
  53                                 unsigned ByteAlignment);
  54   virtual void BeginCOFFSymbolDef(const MCSymbol *Symbol) {
  55     assert(0 && "macho doesn't support this directive");
  56   }
  57   virtual void EmitCOFFSymbolStorageClass(int StorageClass) {
  58     assert(0 && "macho doesn't support this directive");
  59   }
  60   virtual void EmitCOFFSymbolType(int Type) {
  61     assert(0 && "macho doesn't support this directive");
  62   }
  63   virtual void EndCOFFSymbolDef() {
  64     assert(0 && "macho doesn't support this directive");
  65   }
  66   virtual void EmitELFSize(MCSymbol *Symbol, const MCExpr *Value) {
  67     assert(0 && "macho doesn't support this directive");
  68   }
  69   virtual void EmitLocalCommonSymbol(MCSymbol *Symbol, uint64_t Size) {
  70     assert(0 && "macho doesn't support this directive");
  71   }
  72   virtual void EmitZerofill(const MCSection *Section, MCSymbol *Symbol = 0,
  73                             unsigned Size = 0, unsigned ByteAlignment = 0);
  74   virtual void EmitTBSSSymbol(const MCSection *Section, MCSymbol *Symbol,
  75                               uint64_t Size, unsigned ByteAlignment = 0);
  76   virtual void EmitBytes(StringRef Data, unsigned AddrSpace);
  77   virtual void EmitValue(const MCExpr *Value, unsigned Size,unsigned AddrSpace);
  78   virtual void EmitGPRel32Value(const MCExpr *Value) {
  79     assert(0 && "macho doesn't support this directive");
  80   }
  81   virtual void EmitValueToAlignment(unsigned ByteAlignment, int64_t Value = 0,
  82                                     unsigned ValueSize = 1,
  83                                     unsigned MaxBytesToEmit = 0);
  84   virtual void EmitCodeAlignment(unsigned ByteAlignment,
  85                                  unsigned MaxBytesToEmit = 0);
  86   virtual void EmitValueToOffset(const MCExpr *Offset,
  87                                  unsigned char Value = 0);
  88
  89   virtual void EmitFileDirective(StringRef Filename) {
  90     // FIXME: Just ignore the .file; it isn't important enough to fail the
  91     // entire assembly.
  92
  93     //report_fatal_error("unsupported directive: '.file'");
  94   }
  95   virtual void EmitDwarfFileDirective(unsigned FileNo, StringRef Filename) {
  96     // FIXME: Just ignore the .file; it isn't important enough to fail the
  97     // entire assembly.
  98
  99     //report_fatal_error("unsupported directive: '.file'");
 100   }
 101
 102   virtual void Finish();
 103
 104   /// @}
 105 };
 106
 107 } // end anonymous namespace.
 108
 109 void MCMachOStreamer::InitSections() {
 110   SwitchSection(getContext().getMachOSection("__TEXT", "__text",
 111                                     MCSectionMachO::S_ATTR_PURE_INSTRUCTIONS,
 112                                     0, SectionKind::getText()));
 113
 114 }
 115
 116 void MCMachOStreamer::EmitLabel(MCSymbol *Symbol) {
 117   // TODO: This is almost exactly the same as WinCOFFStreamer. Consider merging
 118   // into MCObjectStreamer.
 119   assert(Symbol->isUndefined() && "Cannot define a symbol twice!");
 120   assert(!Symbol->isVariable() && "Cannot emit a variable symbol!");
 121   assert(CurSection && "Cannot emit before setting section!");
 122
 123   Symbol->setSection(*CurSection);
 124
 125   MCSymbolData &SD = getAssembler().getOrCreateSymbolData(*Symbol);
 126
 127   // We have to create a new fragment if this is an atom defining symbol,
 128   // fragments cannot span atoms.
 129   if (getAssembler().isSymbolLinkerVisible(SD.getSymbol()))
 130     new MCDataFragment(getCurrentSectionData());
 131
 132   // FIXME: This is wasteful, we don't necessarily need to create a data
 133   // fragment. Instead, we should mark the symbol as pointing into the data
 134   // fragment if it exists, otherwise we should just queue the label and set its
 135   // fragment pointer when we emit the next fragment.
 136   MCDataFragment *F = getOrCreateDataFragment();
 137   assert(!SD.getFragment() && "Unexpected fragment on symbol data!");
 138   SD.setFragment(F);
 139   SD.setOffset(F->getContents().size());
 140
 141   // This causes the reference type flag to be cleared. Darwin 'as' was "trying"
 142   // to clear the weak reference and weak definition bits too, but the
 143   // implementation was buggy. For now we just try to match 'as', for
 144   // diffability.
 145   //
 146   // FIXME: Cleanup this code, these bits should be emitted based on semantic
 147   // properties, not on the order of definition, etc.
 148   SD.setFlags(SD.getFlags() & ~SF_ReferenceTypeMask);
 149 }
 150
 151 void MCMachOStreamer::EmitAssemblerFlag(MCAssemblerFlag Flag) {
 152   switch (Flag) {
 153   case MCAF_SyntaxUnified: return; // no-op here.
 154   case MCAF_Code16: return; // no-op here.
 155   case MCAF_SubsectionsViaSymbols:
 156     getAssembler().setSubsectionsViaSymbols(true);
 157     return;
 158   default:
 159     llvm_unreachable("invalid assembler flag!");
 160   }
 161 }
 162
 163 void MCMachOStreamer::EmitThumbFunc(MCSymbol *Func) {
 164   // FIXME: Flag the function ISA as thumb with DW_AT_APPLE_isa.
 165 }
 166
 167 void MCMachOStreamer::EmitAssignment(MCSymbol *Symbol, const MCExpr *Value) {
 168   // TODO: This is exactly the same as WinCOFFStreamer. Consider merging into
 169   // MCObjectStreamer.
 170   // FIXME: Lift context changes into super class.
 171   getAssembler().getOrCreateSymbolData(*Symbol);
 172   Symbol->setVariableValue(AddValueSymbols(Value));
 173 }
 174
 175 void MCMachOStreamer::EmitSymbolAttribute(MCSymbol *Symbol,
 176                                           MCSymbolAttr Attribute) {
 177   // Indirect symbols are handled differently, to match how 'as' handles
 178   // them. This makes writing matching .o files easier.
 179   if (Attribute == MCSA_IndirectSymbol) {
 180     // Note that we intentionally cannot use the symbol data here; this is
 181     // important for matching the string table that 'as' generates.
 182     IndirectSymbolData ISD;
 183     ISD.Symbol = Symbol;
 184     ISD.SectionData = getCurrentSectionData();
 185     getAssembler().getIndirectSymbols().push_back(ISD);
 186     return;
 187   }
 188
 189   // Adding a symbol attribute always introduces the symbol, note that an
 190   // important side effect of calling getOrCreateSymbolData here is to register
 191   // the symbol with the assembler.
 192   MCSymbolData &SD = getAssembler().getOrCreateSymbolData(*Symbol);
 193
 194   // The implementation of symbol attributes is designed to match 'as', but it
 195   // leaves much to desired. It doesn't really make sense to arbitrarily add and
 196   // remove flags, but 'as' allows this (in particular, see .desc).
 197   //
 198   // In the future it might be worth trying to make these operations more well
 199   // defined.
 200   switch (Attribute) {
 201   case MCSA_Invalid:
 202   case MCSA_ELF_TypeFunction:
 203   case MCSA_ELF_TypeIndFunction:
 204   case MCSA_ELF_TypeObject:
 205   case MCSA_ELF_TypeTLS:
 206   case MCSA_ELF_TypeCommon:
 207   case MCSA_ELF_TypeNoType:
 208   case MCSA_IndirectSymbol:
 209   case MCSA_Hidden:
 210   case MCSA_Internal:
 211   case MCSA_Protected:
 212   case MCSA_Weak:
 213   case MCSA_Local:
 214     assert(0 && "Invalid symbol attribute for Mach-O!");
 215     break;
 216
 217   case MCSA_Global:
 218     SD.setExternal(true);
 219     // This effectively clears the undefined lazy bit, in Darwin 'as', although
 220     // it isn't very consistent because it implements this as part of symbol
 221     // lookup.
 222     //
 223     // FIXME: Cleanup this code, these bits should be emitted based on semantic
 224     // properties, not on the order of definition, etc.
 225     SD.setFlags(SD.getFlags() & ~SF_ReferenceTypeUndefinedLazy);
 226     break;
 227
 228   case MCSA_LazyReference:
 229     // FIXME: This requires -dynamic.
 230     SD.setFlags(SD.getFlags() | SF_NoDeadStrip);
 231     if (Symbol->isUndefined())
 232       SD.setFlags(SD.getFlags() | SF_ReferenceTypeUndefinedLazy);
 233     break;
 234
 235     // Since .reference sets the no dead strip bit, it is equivalent to
 236     // .no_dead_strip in practice.
 237   case MCSA_Reference:
 238   case MCSA_NoDeadStrip:
 239     SD.setFlags(SD.getFlags() | SF_NoDeadStrip);
 240     break;
 241
 242   case MCSA_PrivateExtern:
 243     SD.setExternal(true);
 244     SD.setPrivateExtern(true);
 245     break;
 246
 247   case MCSA_WeakReference:
 248     // FIXME: This requires -dynamic.
 249     if (Symbol->isUndefined())
 250       SD.setFlags(SD.getFlags() | SF_WeakReference);
 251     break;
 252
 253   case MCSA_WeakDefinition:
 254     // FIXME: 'as' enforces that this is defined and global. The manual claims
 255     // it has to be in a coalesced section, but this isn't enforced.
 256     SD.setFlags(SD.getFlags() | SF_WeakDefinition);
 257     break;
 258
 259   case MCSA_WeakDefAutoPrivate:
 260     SD.setFlags(SD.getFlags() | SF_WeakDefinition | SF_WeakReference);
 261     break;
 262   }
 263 }
 264
 265 void MCMachOStreamer::EmitSymbolDesc(MCSymbol *Symbol, unsigned DescValue) {
 266   // Encode the 'desc' value into the lowest implementation defined bits.
 267   assert(DescValue == (DescValue & SF_DescFlagsMask) &&
 268          "Invalid .desc value!");
 269   getAssembler().getOrCreateSymbolData(*Symbol).setFlags(
 270     DescValue & SF_DescFlagsMask);
 271 }
 272
 273 void MCMachOStreamer::EmitCommonSymbol(MCSymbol *Symbol, uint64_t Size,
 274                                        unsigned ByteAlignment) {
 275   // FIXME: Darwin 'as' does appear to allow redef of a .comm by itself.
 276   assert(Symbol->isUndefined() && "Cannot define a symbol twice!");
 277
 278   MCSymbolData &SD = getAssembler().getOrCreateSymbolData(*Symbol);
 279   SD.setExternal(true);
 280   SD.setCommon(Size, ByteAlignment);
 281 }
 282
 283 void MCMachOStreamer::EmitZerofill(const MCSection *Section, MCSymbol *Symbol,
 284                                    unsigned Size, unsigned ByteAlignment) {
 285   MCSectionData &SectData = getAssembler().getOrCreateSectionData(*Section);
 286
 287   // The symbol may not be present, which only creates the section.
 288   if (!Symbol)
 289     return;
 290
 291   // FIXME: Assert that this section has the zerofill type.
 292
 293   assert(Symbol->isUndefined() && "Cannot define a symbol twice!");
 294
 295   MCSymbolData &SD = getAssembler().getOrCreateSymbolData(*Symbol);
 296
 297   // Emit an align fragment if necessary.
 298   if (ByteAlignment != 1)
 299     new MCAlignFragment(ByteAlignment, 0, 0, ByteAlignment, &SectData);
 300
 301   MCFragment *F = new MCFillFragment(0, 0, Size, &SectData);
 302   SD.setFragment(F);
 303
 304   Symbol->setSection(*Section);
 305
 306   // Update the maximum alignment on the zero fill section if necessary.
 307   if (ByteAlignment > SectData.getAlignment())
 308     SectData.setAlignment(ByteAlignment);
 309 }
 310
 311 // This should always be called with the thread local bss section.  Like the
 312 // .zerofill directive this doesn't actually switch sections on us.
 313 void MCMachOStreamer::EmitTBSSSymbol(const MCSection *Section, MCSymbol *Symbol,
 314                                      uint64_t Size, unsigned ByteAlignment) {
 315   EmitZerofill(Section, Symbol, Size, ByteAlignment);
 316   return;
 317 }
 318
 319 void MCMachOStreamer::EmitBytes(StringRef Data, unsigned AddrSpace) {
 320   // TODO: This is exactly the same as WinCOFFStreamer. Consider merging into
 321   // MCObjectStreamer.
 322   getOrCreateDataFragment()->getContents().append(Data.begin(), Data.end());
 323 }
 324
 325 void MCMachOStreamer::EmitValue(const MCExpr *Value, unsigned Size,
 326                                 unsigned AddrSpace) {
 327   // TODO: This is exactly the same as WinCOFFStreamer. Consider merging into
 328   // MCObjectStreamer.
 329   MCDataFragment *DF = getOrCreateDataFragment();
 330
 331   // Avoid fixups when possible.
 332   int64_t AbsValue;
 333   if (AddValueSymbols(Value)->EvaluateAsAbsolute(AbsValue)) {
 334     // FIXME: Endianness assumption.
 335     for (unsigned i = 0; i != Size; ++i)
 336       DF->getContents().push_back(uint8_t(AbsValue >> (i * 8)));
 337   } else {
 338     DF->addFixup(MCFixup::Create(DF->getContents().size(),
 339                                  AddValueSymbols(Value),
 340                                  MCFixup::getKindForSize(Size)));
 341     DF->getContents().resize(DF->getContents().size() + Size, 0);
 342   }
 343 }
 344
 345 void MCMachOStreamer::EmitValueToAlignment(unsigned ByteAlignment,
 346                                            int64_t Value, unsigned ValueSize,
 347                                            unsigned MaxBytesToEmit) {
 348   // TODO: This is exactly the same as WinCOFFStreamer. Consider merging into
 349   // MCObjectStreamer.
 350   if (MaxBytesToEmit == 0)
 351     MaxBytesToEmit = ByteAlignment;
 352   new MCAlignFragment(ByteAlignment, Value, ValueSize, MaxBytesToEmit,
 353                       getCurrentSectionData());
 354
 355   // Update the maximum alignment on the current section if necessary.
 356   if (ByteAlignment > getCurrentSectionData()->getAlignment())
 357     getCurrentSectionData()->setAlignment(ByteAlignment);
 358 }
 359
 360 void MCMachOStreamer::EmitCodeAlignment(unsigned ByteAlignment,
 361                                         unsigned MaxBytesToEmit) {
 362   // TODO: This is exactly the same as WinCOFFStreamer. Consider merging into
 363   // MCObjectStreamer.
 364   if (MaxBytesToEmit == 0)
 365     MaxBytesToEmit = ByteAlignment;
 366   MCAlignFragment *F = new MCAlignFragment(ByteAlignment, 0, 1, MaxBytesToEmit,
 367                                            getCurrentSectionData());
 368   F->setEmitNops(true);
 369
 370   // Update the maximum alignment on the current section if necessary.
 371   if (ByteAlignment > getCurrentSectionData()->getAlignment())
 372     getCurrentSectionData()->setAlignment(ByteAlignment);
 373 }
 374
 375 void MCMachOStreamer::EmitValueToOffset(const MCExpr *Offset,
 376                                         unsigned char Value) {
 377   new MCOrgFragment(*Offset, Value, getCurrentSectionData());
 378 }
 379
 380 void MCMachOStreamer::EmitInstToFragment(const MCInst &Inst) {
 381   MCInstFragment *IF = new MCInstFragment(Inst, getCurrentSectionData());
 382
 383   // Add the fixups and data.
 384   //
 385   // FIXME: Revisit this design decision when relaxation is done, we may be
 386   // able to get away with not storing any extra data in the MCInst.
 387   SmallVector<MCFixup, 4> Fixups;
 388   SmallString<256> Code;
 389   raw_svector_ostream VecOS(Code);
 390   getAssembler().getEmitter().EncodeInstruction(Inst, VecOS, Fixups);
 391   VecOS.flush();
 392
 393   IF->getCode() = Code;
 394   IF->getFixups() = Fixups;
 395 }
 396
 397 void MCMachOStreamer::EmitInstToData(const MCInst &Inst) {
 398   MCDataFragment *DF = getOrCreateDataFragment();
 399
 400   SmallVector<MCFixup, 4> Fixups;
 401   SmallString<256> Code;
 402   raw_svector_ostream VecOS(Code);
 403   getAssembler().getEmitter().EncodeInstruction(Inst, VecOS, Fixups);
 404   VecOS.flush();
 405
 406   // Add the fixups and data.
 407   for (unsigned i = 0, e = Fixups.size(); i != e; ++i) {
 408     Fixups[i].setOffset(Fixups[i].getOffset() + DF->getContents().size());
 409     DF->addFixup(Fixups[i]);
 410   }
 411   DF->getContents().append(Code.begin(), Code.end());
 412 }
 413
 414 void MCMachOStreamer::Finish() {
 415   // Dump out the dwarf file & directory tables and line tables.
 416   if (getContext().hasDwarfFiles()) {
 417     const MCSection *DwarfLineSection = getContext().getMachOSection("__DWARF",
 418                                          "__debug_line",
 419                                          MCSectionMachO::S_ATTR_DEBUG,
 420                                          0, SectionKind::getDataRelLocal());
 421     MCDwarfFileTable::Emit(this, DwarfLineSection);
 422   }
 423
 424   // We have to set the fragment atom associations so we can relax properly for
 425   // Mach-O.
 426
 427   // First, scan the symbol table to build a lookup table from fragments to
 428   // defining symbols.
 429   DenseMap<const MCFragment*, MCSymbolData*> DefiningSymbolMap;
 430   for (MCAssembler::symbol_iterator it = getAssembler().symbol_begin(),
 431          ie = getAssembler().symbol_end(); it != ie; ++it) {
 432     if (getAssembler().isSymbolLinkerVisible(it->getSymbol()) &&
 433         it->getFragment()) {
 434       // An atom defining symbol should never be internal to a fragment.
 435       assert(it->getOffset() == 0 && "Invalid offset in atom defining symbol!");
 436       DefiningSymbolMap[it->getFragment()] = it;
 437     }
 438   }
 439
 440   // Set the fragment atom associations by tracking the last seen atom defining
 441   // symbol.
 442   for (MCAssembler::iterator it = getAssembler().begin(),
 443          ie = getAssembler().end(); it != ie; ++it) {
 444     MCSymbolData *CurrentAtom = 0;
 445     for (MCSectionData::iterator it2 = it->begin(),
 446            ie2 = it->end(); it2 != ie2; ++it2) {
 447       if (MCSymbolData *SD = DefiningSymbolMap.lookup(it2))
 448         CurrentAtom = SD;
 449       it2->setAtom(CurrentAtom);
 450     }
 451   }
 452
 453   this->MCObjectStreamer::Finish();
 454 }
 455
 456 MCStreamer *llvm::createMachOStreamer(MCContext &Context, TargetAsmBackend &TAB,
 457                                       raw_ostream &OS, MCCodeEmitter *CE,
 458                                       bool RelaxAll) {
 459   MCMachOStreamer *S = new MCMachOStreamer(Context, TAB, OS, CE);
 460   if (RelaxAll)
 461     S->getAssembler().setRelaxAll(true);
 462   return S;
 463 }