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