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/MCInst.h"
  16 #include "llvm/MC/MCSection.h"
  17 #include "llvm/MC/MCSymbol.h"
  18 #include "llvm/Support/ErrorHandling.h"
  19 #include "llvm/Support/raw_ostream.h"
  20 using namespace llvm;
  21
  22 namespace {
  23
  24 class MCMachOStreamer : public MCStreamer {
  25   /// SymbolFlags - We store the value for the 'desc' symbol field in the lowest
  26   /// 16 bits of the implementation defined flags.
  27   enum SymbolFlags { // See <mach-o/nlist.h>.
  28     SF_DescFlagsMask                        = 0xFFFF,
  29
  30     // Reference type flags.
  31     SF_ReferenceTypeMask                    = 0x0007,
  32     SF_ReferenceTypeUndefinedNonLazy        = 0x0000,
  33     SF_ReferenceTypeUndefinedLazy           = 0x0001,
  34     SF_ReferenceTypeDefined                 = 0x0002,
  35     SF_ReferenceTypePrivateDefined          = 0x0003,
  36     SF_ReferenceTypePrivateUndefinedNonLazy = 0x0004,
  37     SF_ReferenceTypePrivateUndefinedLazy    = 0x0005,
  38
  39     // Other 'desc' flags.
  40     SF_NoDeadStrip                          = 0x0020,
  41     SF_WeakReference                        = 0x0040,
  42     SF_WeakDefinition                       = 0x0080
  43   };
  44
  45 private:
  46   MCAssembler Assembler;
  47
  48   MCCodeEmitter *Emitter;
  49
  50   MCSectionData *CurSectionData;
  51
  52   DenseMap<const MCSection*, MCSectionData*> SectionMap;
  53
  54   DenseMap<const MCSymbol*, MCSymbolData*> SymbolMap;
  55
  56 private:
  57   MCFragment *getCurrentFragment() const {
  58     assert(CurSectionData && "No current section!");
  59
  60     if (!CurSectionData->empty())
  61       return &CurSectionData->getFragmentList().back();
  62
  63     return 0;
  64   }
  65
  66   MCSectionData &getSectionData(const MCSection &Section) {
  67     MCSectionData *&Entry = SectionMap[&Section];
  68
  69     if (!Entry)
  70       Entry = new MCSectionData(Section, &Assembler);
  71
  72     return *Entry;
  73   }
  74
  75   MCSymbolData &getSymbolData(MCSymbol &Symbol) {
  76     MCSymbolData *&Entry = SymbolMap[&Symbol];
  77
  78     if (!Entry)
  79       Entry = new MCSymbolData(Symbol, 0, 0, &Assembler);
  80
  81     return *Entry;
  82   }
  83
  84 public:
  85   MCMachOStreamer(MCContext &Context, raw_ostream &_OS, MCCodeEmitter *_Emitter)
  86     : MCStreamer(Context), Assembler(Context, _OS), Emitter(_Emitter),
  87       CurSectionData(0) {}
  88   ~MCMachOStreamer() {}
  89
  90   const MCValue &AddValueSymbols(const MCValue &Value) {
  91     if (Value.getSymA())
  92       getSymbolData(*const_cast<MCSymbol*>(Value.getSymA()));
  93     if (Value.getSymB())
  94       getSymbolData(*const_cast<MCSymbol*>(Value.getSymB()));
  95     return Value;
  96   }
  97
  98   /// @name MCStreamer Interface
  99   /// @{
 100
 101   virtual void SwitchSection(const MCSection *Section);
 102
 103   virtual void EmitLabel(MCSymbol *Symbol);
 104
 105   virtual void EmitAssemblerFlag(AssemblerFlag Flag);
 106
 107   virtual void EmitAssignment(MCSymbol *Symbol, const MCValue &Value,
 108                               bool MakeAbsolute = false);
 109
 110   virtual void EmitSymbolAttribute(MCSymbol *Symbol, SymbolAttr Attribute);
 111
 112   virtual void EmitSymbolDesc(MCSymbol *Symbol, unsigned DescValue);
 113
 114   virtual void EmitCommonSymbol(MCSymbol *Symbol, unsigned Size,
 115                                 unsigned ByteAlignment);
 116
 117   virtual void EmitZerofill(const MCSection *Section, MCSymbol *Symbol = 0,
 118                             unsigned Size = 0, unsigned ByteAlignment = 0);
 119
 120   virtual void EmitBytes(const StringRef &Data);
 121
 122   virtual void EmitValue(const MCValue &Value, unsigned Size);
 123
 124   virtual void EmitValueToAlignment(unsigned ByteAlignment, int64_t Value = 0,
 125                                     unsigned ValueSize = 1,
 126                                     unsigned MaxBytesToEmit = 0);
 127
 128   virtual void EmitValueToOffset(const MCValue &Offset,
 129                                  unsigned char Value = 0);
 130
 131   virtual void EmitInstruction(const MCInst &Inst);
 132
 133   virtual void Finish();
 134
 135   /// @}
 136 };
 137
 138 } // end anonymous namespace.
 139
 140 void MCMachOStreamer::SwitchSection(const MCSection *Section) {
 141   assert(Section && "Cannot switch to a null section!");
 142
 143   // If already in this section, then this is a noop.
 144   if (Section == CurSection) return;
 145
 146   CurSection = Section;
 147   CurSectionData = &getSectionData(*Section);
 148 }
 149
 150 void MCMachOStreamer::EmitLabel(MCSymbol *Symbol) {
 151   assert(Symbol->isUndefined() && "Cannot define a symbol twice!");
 152
 153   // FIXME: We should also use offsets into Fill fragments.
 154   MCDataFragment *F = dyn_cast_or_null<MCDataFragment>(getCurrentFragment());
 155   if (!F)
 156     F = new MCDataFragment(CurSectionData);
 157
 158   MCSymbolData &SD = getSymbolData(*Symbol);
 159   assert(!SD.getFragment() && "Unexpected fragment on symbol data!");
 160   SD.setFragment(F);
 161   SD.setOffset(F->getContents().size());
 162
 163   // This causes the reference type and weak reference flags to be cleared.
 164   SD.setFlags(SD.getFlags() & ~(SF_WeakReference | SF_ReferenceTypeMask));
 165
 166   Symbol->setSection(*CurSection);
 167 }
 168
 169 void MCMachOStreamer::EmitAssemblerFlag(AssemblerFlag Flag) {
 170   switch (Flag) {
 171   case SubsectionsViaSymbols:
 172     Assembler.setSubsectionsViaSymbols(true);
 173     return;
 174   }
 175
 176   assert(0 && "invalid assembler flag!");
 177 }
 178
 179 void MCMachOStreamer::EmitAssignment(MCSymbol *Symbol,
 180                                      const MCValue &Value,
 181                                      bool MakeAbsolute) {
 182   // Only absolute symbols can be redefined.
 183   assert((Symbol->isUndefined() || Symbol->isAbsolute()) &&
 184          "Cannot define a symbol twice!");
 185
 186   llvm_unreachable("FIXME: Not yet implemented!");
 187 }
 188
 189 void MCMachOStreamer::EmitSymbolAttribute(MCSymbol *Symbol,
 190                                           SymbolAttr Attribute) {
 191   // Indirect symbols are handled differently, to match how 'as' handles
 192   // them. This makes writing matching .o files easier.
 193   if (Attribute == MCStreamer::IndirectSymbol) {
 194     // Note that we intentionally cannot use the symbol data here; this is
 195     // important for matching the string table that 'as' generates.
 196     IndirectSymbolData ISD;
 197     ISD.Symbol = Symbol;
 198     ISD.SectionData = CurSectionData;
 199     Assembler.getIndirectSymbols().push_back(ISD);
 200     return;
 201   }
 202
 203   // Adding a symbol attribute always introduces the symbol, note that an
 204   // important side effect of calling getSymbolData here is to register the
 205   // symbol with the assembler.
 206   MCSymbolData &SD = getSymbolData(*Symbol);
 207
 208   // The implementation of symbol attributes is designed to match 'as', but it
 209   // leaves much to desired. It doesn't really make sense to arbitrarily add and
 210   // remove flags, but 'as' allows this (in particular, see .desc).
 211   //
 212   // In the future it might be worth trying to make these operations more well
 213   // defined.
 214   switch (Attribute) {
 215   case MCStreamer::IndirectSymbol:
 216   case MCStreamer::Hidden:
 217   case MCStreamer::Internal:
 218   case MCStreamer::Protected:
 219   case MCStreamer::Weak:
 220     assert(0 && "Invalid symbol attribute for Mach-O!");
 221     break;
 222
 223   case MCStreamer::Global:
 224     SD.setExternal(true);
 225     break;
 226
 227   case MCStreamer::LazyReference:
 228     // FIXME: This requires -dynamic.
 229     SD.setFlags(SD.getFlags() | SF_NoDeadStrip);
 230     if (Symbol->isUndefined())
 231       SD.setFlags(SD.getFlags() | SF_ReferenceTypeUndefinedLazy);
 232     break;
 233
 234     // Since .reference sets the no dead strip bit, it is equivalent to
 235     // .no_dead_strip in practice.
 236   case MCStreamer::Reference:
 237   case MCStreamer::NoDeadStrip:
 238     SD.setFlags(SD.getFlags() | SF_NoDeadStrip);
 239     break;
 240
 241   case MCStreamer::PrivateExtern:
 242     SD.setExternal(true);
 243     SD.setPrivateExtern(true);
 244     break;
 245
 246   case MCStreamer::WeakReference:
 247     // FIXME: This requires -dynamic.
 248     if (Symbol->isUndefined())
 249       SD.setFlags(SD.getFlags() | SF_WeakReference);
 250     break;
 251
 252   case MCStreamer::WeakDefinition:
 253     // FIXME: 'as' enforces that this is defined and global. The manual claims
 254     // it has to be in a coalesced section, but this isn't enforced.
 255     SD.setFlags(SD.getFlags() | SF_WeakDefinition);
 256     break;
 257   }
 258 }
 259
 260 void MCMachOStreamer::EmitSymbolDesc(MCSymbol *Symbol, unsigned DescValue) {
 261   // Encode the 'desc' value into the lowest implementation defined bits.
 262   assert(DescValue == (DescValue & SF_DescFlagsMask) &&
 263          "Invalid .desc value!");
 264   getSymbolData(*Symbol).setFlags(DescValue & SF_DescFlagsMask);
 265 }
 266
 267 void MCMachOStreamer::EmitCommonSymbol(MCSymbol *Symbol, unsigned Size,
 268                                        unsigned ByteAlignment) {
 269   // FIXME: Darwin 'as' does appear to allow redef of a .comm by itself.
 270   assert(Symbol->isUndefined() && "Cannot define a symbol twice!");
 271
 272   MCSymbolData &SD = getSymbolData(*Symbol);
 273   SD.setExternal(true);
 274   SD.setCommon(Size, ByteAlignment);
 275 }
 276
 277 void MCMachOStreamer::EmitZerofill(const MCSection *Section, MCSymbol *Symbol,
 278                                    unsigned Size, unsigned ByteAlignment) {
 279   MCSectionData &SectData = getSectionData(*Section);
 280
 281   // The symbol may not be present, which only creates the section.
 282   if (!Symbol)
 283     return;
 284
 285   // FIXME: Assert that this section has the zerofill type.
 286
 287   assert(Symbol->isUndefined() && "Cannot define a symbol twice!");
 288
 289   MCSymbolData &SD = getSymbolData(*Symbol);
 290
 291   MCFragment *F = new MCZeroFillFragment(Size, ByteAlignment, &SectData);
 292   SD.setFragment(F);
 293
 294   Symbol->setSection(*Section);
 295
 296   // Update the maximum alignment on the zero fill section if necessary.
 297   if (ByteAlignment > SectData.getAlignment())
 298     SectData.setAlignment(ByteAlignment);
 299 }
 300
 301 void MCMachOStreamer::EmitBytes(const StringRef &Data) {
 302   MCDataFragment *DF = dyn_cast_or_null<MCDataFragment>(getCurrentFragment());
 303   if (!DF)
 304     DF = new MCDataFragment(CurSectionData);
 305   DF->getContents().append(Data.begin(), Data.end());
 306 }
 307
 308 void MCMachOStreamer::EmitValue(const MCValue &Value, unsigned Size) {
 309   new MCFillFragment(AddValueSymbols(Value), Size, 1, CurSectionData);
 310 }
 311
 312 void MCMachOStreamer::EmitValueToAlignment(unsigned ByteAlignment,
 313                                            int64_t Value, unsigned ValueSize,
 314                                            unsigned MaxBytesToEmit) {
 315   if (MaxBytesToEmit == 0)
 316     MaxBytesToEmit = ByteAlignment;
 317   new MCAlignFragment(ByteAlignment, Value, ValueSize, MaxBytesToEmit,
 318                       CurSectionData);
 319
 320   // Update the maximum alignment on the current section if necessary.
 321   if (ByteAlignment > CurSectionData->getAlignment())
 322     CurSectionData->setAlignment(ByteAlignment);
 323 }
 324
 325 void MCMachOStreamer::EmitValueToOffset(const MCValue &Offset,
 326                                         unsigned char Value) {
 327   new MCOrgFragment(AddValueSymbols(Offset), Value, CurSectionData);
 328 }
 329
 330 void MCMachOStreamer::EmitInstruction(const MCInst &Inst) {
 331   // Scan for values.
 332   for (unsigned i = 0; i != Inst.getNumOperands(); ++i)
 333     if (Inst.getOperand(i).isMCValue())
 334       AddValueSymbols(Inst.getOperand(i).getMCValue());
 335
 336   if (!Emitter)
 337     llvm_unreachable("no code emitter available!");
 338
 339   // FIXME: Relocations!
 340   SmallString<256> Code;
 341   raw_svector_ostream VecOS(Code);
 342   Emitter->EncodeInstruction(Inst, VecOS);
 343   EmitBytes(VecOS.str());
 344 }
 345
 346 void MCMachOStreamer::Finish() {
 347   Assembler.Finish();
 348 }
 349
 350 MCStreamer *llvm::createMachOStreamer(MCContext &Context, raw_ostream &OS,
 351                                       MCCodeEmitter *CE) {
 352   return new MCMachOStreamer(Context, OS, CE);
 353 }