lib/MC/MCMachOStreamer.cpp

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