lib/MC/MCMachOStreamer.cpp

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