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/MCSection.h"
  18 #include "llvm/MC/MCSymbol.h"
  19 #include "llvm/MC/MCValue.h"
  20 #include "llvm/Support/ErrorHandling.h"
  21 #include "llvm/Support/raw_ostream.h"
  22 using namespace llvm;
  23
  24 namespace {
  25
  26 class MCMachOStreamer : public MCStreamer {
  27   /// SymbolFlags - We store the value for the 'desc' symbol field in the lowest
  28   /// 16 bits of the implementation defined flags.
  29   enum SymbolFlags { // See <mach-o/nlist.h>.
  30     SF_DescFlagsMask                        = 0xFFFF,
  31
  32     // Reference type flags.
  33     SF_ReferenceTypeMask                    = 0x0007,
  34     SF_ReferenceTypeUndefinedNonLazy        = 0x0000,
  35     SF_ReferenceTypeUndefinedLazy           = 0x0001,
  36     SF_ReferenceTypeDefined                 = 0x0002,
  37     SF_ReferenceTypePrivateDefined          = 0x0003,
  38     SF_ReferenceTypePrivateUndefinedNonLazy = 0x0004,
  39     SF_ReferenceTypePrivateUndefinedLazy    = 0x0005,
  40
  41     // Other 'desc' flags.
  42     SF_NoDeadStrip                          = 0x0020,
  43     SF_WeakReference                        = 0x0040,
  44     SF_WeakDefinition                       = 0x0080
  45   };
  46
  47 private:
  48   MCAssembler Assembler;
  49   MCCodeEmitter *Emitter;
  50   MCSectionData *CurSectionData;
  51   DenseMap<const MCSection*, MCSectionData*> SectionMap;
  52   DenseMap<const MCSymbol*, MCSymbolData*> SymbolMap;
  53
  54 private:
  55   MCFragment *getCurrentFragment() const {
  56     assert(CurSectionData && "No current section!");
  57
  58     if (!CurSectionData->empty())
  59       return &CurSectionData->getFragmentList().back();
  60
  61     return 0;
  62   }
  63
  64   MCSectionData &getSectionData(const MCSection &Section) {
  65     MCSectionData *&Entry = SectionMap[&Section];
  66
  67     if (!Entry)
  68       Entry = new MCSectionData(Section, &Assembler);
  69
  70     return *Entry;
  71   }
  72
  73   MCSymbolData &getSymbolData(const MCSymbol &Symbol) {
  74     MCSymbolData *&Entry = SymbolMap[&Symbol];
  75
  76     if (!Entry)
  77       Entry = new MCSymbolData(Symbol, 0, 0, &Assembler);
  78
  79     return *Entry;
  80   }
  81
  82 public:
  83   MCMachOStreamer(MCContext &Context, raw_ostream &_OS, MCCodeEmitter *_Emitter)
  84     : MCStreamer(Context), Assembler(Context, _OS), Emitter(_Emitter),
  85       CurSectionData(0) {}
  86   ~MCMachOStreamer() {}
  87
  88   const MCExpr *AddValueSymbols(const MCExpr *Value) {
  89     switch (Value->getKind()) {
  90     case MCExpr::Constant:
  91       break;
  92
  93     case MCExpr::Binary: {
  94       const MCBinaryExpr *BE = cast<MCBinaryExpr>(Value);
  95       AddValueSymbols(BE->getLHS());
  96       AddValueSymbols(BE->getRHS());
  97       break;
  98     }
  99
 100     case MCExpr::SymbolRef:
 101       getSymbolData(cast<MCSymbolRefExpr>(Value)->getSymbol());
 102       break;
 103
 104     case MCExpr::Unary:
 105       AddValueSymbols(cast<MCUnaryExpr>(Value)->getSubExpr());
 106       break;
 107     }
 108
 109     return Value;
 110   }
 111
 112   /// @name MCStreamer Interface
 113   /// @{
 114
 115   virtual void SwitchSection(const MCSection *Section);
 116   virtual void EmitLabel(MCSymbol *Symbol);
 117   virtual void EmitAssemblerFlag(MCAssemblerFlag Flag);
 118   virtual void EmitAssignment(MCSymbol *Symbol, const MCExpr *Value);
 119   virtual void EmitSymbolAttribute(MCSymbol *Symbol, MCSymbolAttr Attribute);
 120   virtual void EmitSymbolDesc(MCSymbol *Symbol, unsigned DescValue);
 121   virtual void EmitCommonSymbol(MCSymbol *Symbol, uint64_t Size,
 122                                 unsigned ByteAlignment);
 123   virtual void EmitELFSize(MCSymbol *Symbol, const MCExpr *Value) {
 124     assert(0 && "macho doesn't support this directive");
 125   }
 126   virtual void EmitLocalCommonSymbol(MCSymbol *Symbol, uint64_t Size) {
 127     assert(0 && "macho doesn't support this directive");
 128   }
 129   virtual void EmitZerofill(const MCSection *Section, MCSymbol *Symbol = 0,
 130                             unsigned Size = 0, unsigned ByteAlignment = 0);
 131   virtual void EmitBytes(StringRef Data, unsigned AddrSpace);
 132   virtual void EmitValue(const MCExpr *Value, unsigned Size,unsigned AddrSpace);
 133   virtual void EmitGPRel32Value(const MCExpr *Value) {
 134     assert(0 && "macho doesn't support this directive");
 135   }
 136   virtual void EmitValueToAlignment(unsigned ByteAlignment, int64_t Value = 0,
 137                                     unsigned ValueSize = 1,
 138                                     unsigned MaxBytesToEmit = 0);
 139   virtual void EmitValueToOffset(const MCExpr *Offset,
 140                                  unsigned char Value = 0);
 141
 142   virtual void EmitFileDirective(StringRef Filename) {
 143     errs() << "FIXME: MCMachoStreamer:EmitFileDirective not implemented\n";
 144   }
 145   virtual void EmitDwarfFileDirective(unsigned FileNo, StringRef Filename) {
 146     errs() << "FIXME: MCMachoStreamer:EmitDwarfFileDirective not implemented\n";
 147   }
 148
 149   virtual void EmitInstruction(const MCInst &Inst);
 150   virtual void Finish();
 151
 152   /// @}
 153 };
 154
 155 } // end anonymous namespace.
 156
 157 void MCMachOStreamer::SwitchSection(const MCSection *Section) {
 158   assert(Section && "Cannot switch to a null section!");
 159
 160   // If already in this section, then this is a noop.
 161   if (Section == CurSection) return;
 162
 163   CurSection = Section;
 164   CurSectionData = &getSectionData(*Section);
 165 }
 166
 167 void MCMachOStreamer::EmitLabel(MCSymbol *Symbol) {
 168   assert(Symbol->isUndefined() && "Cannot define a symbol twice!");
 169
 170   // FIXME: We should also use offsets into Fill fragments.
 171   MCDataFragment *F = dyn_cast_or_null<MCDataFragment>(getCurrentFragment());
 172   if (!F)
 173     F = new MCDataFragment(CurSectionData);
 174
 175   MCSymbolData &SD = getSymbolData(*Symbol);
 176   assert(!SD.getFragment() && "Unexpected fragment on symbol data!");
 177   SD.setFragment(F);
 178   SD.setOffset(F->getContents().size());
 179
 180   // This causes the reference type and weak reference flags to be cleared.
 181   SD.setFlags(SD.getFlags() & ~(SF_WeakReference | SF_ReferenceTypeMask));
 182
 183   Symbol->setSection(*CurSection);
 184 }
 185
 186 void MCMachOStreamer::EmitAssemblerFlag(MCAssemblerFlag Flag) {
 187   switch (Flag) {
 188   case MCAF_SubsectionsViaSymbols:
 189     Assembler.setSubsectionsViaSymbols(true);
 190     return;
 191   }
 192
 193   assert(0 && "invalid assembler flag!");
 194 }
 195
 196 void MCMachOStreamer::EmitAssignment(MCSymbol *Symbol, const MCExpr *Value) {
 197   // Only absolute symbols can be redefined.
 198   assert((Symbol->isUndefined() || Symbol->isAbsolute()) &&
 199          "Cannot define a symbol twice!");
 200
 201   // FIXME: Lift context changes into super class.
 202   // FIXME: Set associated section.
 203   Symbol->setValue(Value);
 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 = CurSectionData;
 216     Assembler.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 getSymbolData here is to register the
 222   // symbol with the assembler.
 223   MCSymbolData &SD = getSymbolData(*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_IndirectSymbol:
 240   case MCSA_Hidden:
 241   case MCSA_Internal:
 242   case MCSA_Protected:
 243   case MCSA_Weak:
 244   case MCSA_Local:
 245     assert(0 && "Invalid symbol attribute for Mach-O!");
 246     break;
 247
 248   case MCSA_Global:
 249     SD.setExternal(true);
 250     break;
 251
 252   case MCSA_LazyReference:
 253     // FIXME: This requires -dynamic.
 254     SD.setFlags(SD.getFlags() | SF_NoDeadStrip);
 255     if (Symbol->isUndefined())
 256       SD.setFlags(SD.getFlags() | SF_ReferenceTypeUndefinedLazy);
 257     break;
 258
 259     // Since .reference sets the no dead strip bit, it is equivalent to
 260     // .no_dead_strip in practice.
 261   case MCSA_Reference:
 262   case MCSA_NoDeadStrip:
 263     SD.setFlags(SD.getFlags() | SF_NoDeadStrip);
 264     break;
 265
 266   case MCSA_PrivateExtern:
 267     SD.setExternal(true);
 268     SD.setPrivateExtern(true);
 269     break;
 270
 271   case MCSA_WeakReference:
 272     // FIXME: This requires -dynamic.
 273     if (Symbol->isUndefined())
 274       SD.setFlags(SD.getFlags() | SF_WeakReference);
 275     break;
 276
 277   case MCSA_WeakDefinition:
 278     // FIXME: 'as' enforces that this is defined and global. The manual claims
 279     // it has to be in a coalesced section, but this isn't enforced.
 280     SD.setFlags(SD.getFlags() | SF_WeakDefinition);
 281     break;
 282   }
 283 }
 284
 285 void MCMachOStreamer::EmitSymbolDesc(MCSymbol *Symbol, unsigned DescValue) {
 286   // Encode the 'desc' value into the lowest implementation defined bits.
 287   assert(DescValue == (DescValue & SF_DescFlagsMask) &&
 288          "Invalid .desc value!");
 289   getSymbolData(*Symbol).setFlags(DescValue & SF_DescFlagsMask);
 290 }
 291
 292 void MCMachOStreamer::EmitCommonSymbol(MCSymbol *Symbol, uint64_t Size,
 293                                        unsigned ByteAlignment) {
 294   // FIXME: Darwin 'as' does appear to allow redef of a .comm by itself.
 295   assert(Symbol->isUndefined() && "Cannot define a symbol twice!");
 296
 297   MCSymbolData &SD = getSymbolData(*Symbol);
 298   SD.setExternal(true);
 299   SD.setCommon(Size, ByteAlignment);
 300 }
 301
 302 void MCMachOStreamer::EmitZerofill(const MCSection *Section, MCSymbol *Symbol,
 303                                    unsigned Size, unsigned ByteAlignment) {
 304   MCSectionData &SectData = getSectionData(*Section);
 305
 306   // The symbol may not be present, which only creates the section.
 307   if (!Symbol)
 308     return;
 309
 310   // FIXME: Assert that this section has the zerofill type.
 311
 312   assert(Symbol->isUndefined() && "Cannot define a symbol twice!");
 313
 314   MCSymbolData &SD = getSymbolData(*Symbol);
 315
 316   MCFragment *F = new MCZeroFillFragment(Size, ByteAlignment, &SectData);
 317   SD.setFragment(F);
 318
 319   Symbol->setSection(*Section);
 320
 321   // Update the maximum alignment on the zero fill section if necessary.
 322   if (ByteAlignment > SectData.getAlignment())
 323     SectData.setAlignment(ByteAlignment);
 324 }
 325
 326 void MCMachOStreamer::EmitBytes(StringRef Data, unsigned AddrSpace) {
 327   MCDataFragment *DF = dyn_cast_or_null<MCDataFragment>(getCurrentFragment());
 328   if (!DF)
 329     DF = new MCDataFragment(CurSectionData);
 330   DF->getContents().append(Data.begin(), Data.end());
 331 }
 332
 333 void MCMachOStreamer::EmitValue(const MCExpr *Value, unsigned Size,
 334                                 unsigned AddrSpace) {
 335   new MCFillFragment(*AddValueSymbols(Value), Size, 1, CurSectionData);
 336 }
 337
 338 void MCMachOStreamer::EmitValueToAlignment(unsigned ByteAlignment,
 339                                            int64_t Value, unsigned ValueSize,
 340                                            unsigned MaxBytesToEmit) {
 341   if (MaxBytesToEmit == 0)
 342     MaxBytesToEmit = ByteAlignment;
 343   new MCAlignFragment(ByteAlignment, Value, ValueSize, MaxBytesToEmit,
 344                       CurSectionData);
 345
 346   // Update the maximum alignment on the current section if necessary.
 347   if (ByteAlignment > CurSectionData->getAlignment())
 348     CurSectionData->setAlignment(ByteAlignment);
 349 }
 350
 351 void MCMachOStreamer::EmitValueToOffset(const MCExpr *Offset,
 352                                         unsigned char Value) {
 353   new MCOrgFragment(*Offset, Value, CurSectionData);
 354 }
 355
 356 void MCMachOStreamer::EmitInstruction(const MCInst &Inst) {
 357   // Scan for values.
 358   for (unsigned i = 0; i != Inst.getNumOperands(); ++i)
 359     if (Inst.getOperand(i).isExpr())
 360       AddValueSymbols(Inst.getOperand(i).getExpr());
 361
 362   if (!Emitter)
 363     llvm_unreachable("no code emitter available!");
 364
 365   CurSectionData->setHasInstructions(true);
 366
 367   // FIXME: Relocations!
 368   SmallString<256> Code;
 369   raw_svector_ostream VecOS(Code);
 370   Emitter->EncodeInstruction(Inst, VecOS);
 371   EmitBytes(VecOS.str(), 0);
 372 }
 373
 374 void MCMachOStreamer::Finish() {
 375   Assembler.Finish();
 376 }
 377
 378 MCStreamer *llvm::createMachOStreamer(MCContext &Context, raw_ostream &OS,
 379                                       MCCodeEmitter *CE) {
 380   return new MCMachOStreamer(Context, OS, CE);
 381 }