lib/MC/WinCOFFStreamer.cpp

   1 //===-- llvm/MC/WinCOFFStreamer.cpp -----------------------------*- C++ -*-===//
   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 // This file contains an implementation of a Win32 COFF object file streamer.
  11 //
  12 //===----------------------------------------------------------------------===//
  13
  14 #define DEBUG_TYPE "WinCOFFStreamer"
  15
  16 #include "llvm/MC/MCStreamer.h"
  17 #include "llvm/MC/MCAsmBackend.h"
  18 #include "llvm/MC/MCAsmLayout.h"
  19 #include "llvm/MC/MCAssembler.h"
  20 #include "llvm/MC/MCCodeEmitter.h"
  21 #include "llvm/MC/MCContext.h"
  22 #include "llvm/MC/MCExpr.h"
  23 #include "llvm/MC/MCObjectStreamer.h"
  24 #include "llvm/MC/MCSection.h"
  25 #include "llvm/MC/MCSectionCOFF.h"
  26 #include "llvm/MC/MCSymbol.h"
  27 #include "llvm/MC/MCValue.h"
  28 #include "llvm/MC/MCWin64EH.h"
  29 #include "llvm/Support/COFF.h"
  30 #include "llvm/Support/Debug.h"
  31 #include "llvm/Support/ErrorHandling.h"
  32 #include "llvm/Support/TargetRegistry.h"
  33 #include "llvm/Support/raw_ostream.h"
  34
  35 using namespace llvm;
  36
  37 namespace {
  38 class WinCOFFStreamer : public MCObjectStreamer {
  39 public:
  40   MCSymbol const *CurSymbol;
  41
  42   WinCOFFStreamer(MCContext &Context,
  43                   MCAsmBackend &MAB,
  44                   MCCodeEmitter &CE,
  45                   raw_ostream &OS);
  46
  47   void AddCommonSymbol(MCSymbol *Symbol, uint64_t Size,
  48                        unsigned ByteAlignment, bool External);
  49
  50   // MCStreamer interface
  51
  52   virtual void InitSections();
  53   virtual void InitToTextSection();
  54   virtual void EmitLabel(MCSymbol *Symbol);
  55   virtual void EmitDebugLabel(MCSymbol *Symbol);
  56   virtual void EmitAssemblerFlag(MCAssemblerFlag Flag);
  57   virtual void EmitThumbFunc(MCSymbol *Func);
  58   virtual void EmitAssignment(MCSymbol *Symbol, const MCExpr *Value);
  59   virtual void EmitSymbolAttribute(MCSymbol *Symbol, MCSymbolAttr Attribute);
  60   virtual void EmitSymbolDesc(MCSymbol *Symbol, unsigned DescValue);
  61   virtual void BeginCOFFSymbolDef(MCSymbol const *Symbol);
  62   virtual void EmitCOFFSymbolStorageClass(int StorageClass);
  63   virtual void EmitCOFFSymbolType(int Type);
  64   virtual void EndCOFFSymbolDef();
  65   virtual void EmitCOFFSecRel32(MCSymbol const *Symbol);
  66   virtual void EmitELFSize(MCSymbol *Symbol, const MCExpr *Value);
  67   virtual void EmitCommonSymbol(MCSymbol *Symbol, uint64_t Size,
  68                                 unsigned ByteAlignment);
  69   virtual void EmitLocalCommonSymbol(MCSymbol *Symbol, uint64_t Size,
  70                                      unsigned ByteAlignment);
  71   virtual void EmitZerofill(const MCSection *Section, MCSymbol *Symbol,
  72                             uint64_t Size,unsigned ByteAlignment);
  73   virtual void EmitTBSSSymbol(const MCSection *Section, MCSymbol *Symbol,
  74                               uint64_t Size, unsigned ByteAlignment);
  75   virtual void EmitFileDirective(StringRef Filename);
  76   virtual void EmitWin64EHHandlerData();
  77   virtual void FinishImpl();
  78
  79 private:
  80   virtual void EmitInstToData(const MCInst &Inst) {
  81     MCDataFragment *DF = getOrCreateDataFragment();
  82
  83     SmallVector<MCFixup, 4> Fixups;
  84     SmallString<256> Code;
  85     raw_svector_ostream VecOS(Code);
  86     getAssembler().getEmitter().EncodeInstruction(Inst, VecOS, Fixups);
  87     VecOS.flush();
  88
  89     // Add the fixups and data.
  90     for (unsigned i = 0, e = Fixups.size(); i != e; ++i) {
  91       Fixups[i].setOffset(Fixups[i].getOffset() + DF->getContents().size());
  92       DF->getFixups().push_back(Fixups[i]);
  93     }
  94     DF->getContents().append(Code.begin(), Code.end());
  95   }
  96
  97   void SetSection(StringRef Section,
  98                   unsigned Characteristics,
  99                   SectionKind Kind) {
 100     SwitchSection(getContext().getCOFFSection(Section, Characteristics, Kind));
 101   }
 102
 103   void SetSectionText() {
 104     SetSection(".text",
 105                COFF::IMAGE_SCN_CNT_CODE
 106              | COFF::IMAGE_SCN_MEM_EXECUTE
 107              | COFF::IMAGE_SCN_MEM_READ,
 108                SectionKind::getText());
 109     EmitCodeAlignment(4, 0);
 110   }
 111
 112   void SetSectionData() {
 113     SetSection(".data",
 114                COFF::IMAGE_SCN_CNT_INITIALIZED_DATA
 115              | COFF::IMAGE_SCN_MEM_READ
 116              | COFF::IMAGE_SCN_MEM_WRITE,
 117                SectionKind::getDataRel());
 118     EmitCodeAlignment(4, 0);
 119   }
 120
 121   void SetSectionBSS() {
 122     SetSection(".bss",
 123                COFF::IMAGE_SCN_CNT_UNINITIALIZED_DATA
 124              | COFF::IMAGE_SCN_MEM_READ
 125              | COFF::IMAGE_SCN_MEM_WRITE,
 126                SectionKind::getBSS());
 127     EmitCodeAlignment(4, 0);
 128   }
 129 };
 130 } // end anonymous namespace.
 131
 132 WinCOFFStreamer::WinCOFFStreamer(MCContext &Context,
 133                                  MCAsmBackend &MAB,
 134                                  MCCodeEmitter &CE,
 135                                  raw_ostream &OS)
 136     : MCObjectStreamer(Context, MAB, OS, &CE)
 137     , CurSymbol(NULL) {
 138 }
 139
 140 void WinCOFFStreamer::AddCommonSymbol(MCSymbol *Symbol, uint64_t Size,
 141                                       unsigned ByteAlignment, bool External) {
 142   assert(!Symbol->isInSection() && "Symbol must not already have a section!");
 143
 144   std::string SectionName(".bss$linkonce");
 145   SectionName.append(Symbol->getName().begin(), Symbol->getName().end());
 146
 147   MCSymbolData &SymbolData = getAssembler().getOrCreateSymbolData(*Symbol);
 148
 149   unsigned Characteristics =
 150     COFF::IMAGE_SCN_LNK_COMDAT |
 151     COFF::IMAGE_SCN_CNT_UNINITIALIZED_DATA |
 152     COFF::IMAGE_SCN_MEM_READ |
 153     COFF::IMAGE_SCN_MEM_WRITE;
 154
 155   int Selection = COFF::IMAGE_COMDAT_SELECT_LARGEST;
 156
 157   const MCSection *Section = MCStreamer::getContext().getCOFFSection(
 158     SectionName, Characteristics, Selection, SectionKind::getBSS());
 159
 160   MCSectionData &SectionData = getAssembler().getOrCreateSectionData(*Section);
 161
 162   if (SectionData.getAlignment() < ByteAlignment)
 163     SectionData.setAlignment(ByteAlignment);
 164
 165   SymbolData.setExternal(External);
 166
 167   Symbol->setSection(*Section);
 168
 169   if (ByteAlignment != 1)
 170       new MCAlignFragment(ByteAlignment, 0, 0, ByteAlignment, &SectionData);
 171
 172   SymbolData.setFragment(new MCFillFragment(0, 0, Size, &SectionData));
 173 }
 174
 175 // MCStreamer interface
 176
 177 void WinCOFFStreamer::InitToTextSection() {
 178   SetSectionText();
 179 }
 180
 181 void WinCOFFStreamer::InitSections() {
 182   SetSectionText();
 183   SetSectionData();
 184   SetSectionBSS();
 185   SetSectionText();
 186 }
 187
 188 void WinCOFFStreamer::EmitLabel(MCSymbol *Symbol) {
 189   assert(Symbol->isUndefined() && "Cannot define a symbol twice!");
 190   MCObjectStreamer::EmitLabel(Symbol);
 191 }
 192
 193 void WinCOFFStreamer::EmitDebugLabel(MCSymbol *Symbol) {
 194   EmitLabel(Symbol);
 195 }
 196 void WinCOFFStreamer::EmitAssemblerFlag(MCAssemblerFlag Flag) {
 197   llvm_unreachable("not implemented");
 198 }
 199
 200 void WinCOFFStreamer::EmitThumbFunc(MCSymbol *Func) {
 201   llvm_unreachable("not implemented");
 202 }
 203
 204 void WinCOFFStreamer::EmitAssignment(MCSymbol *Symbol, const MCExpr *Value) {
 205   assert((Symbol->isInSection()
 206          ? Symbol->getSection().getVariant() == MCSection::SV_COFF
 207          : true) && "Got non COFF section in the COFF backend!");
 208   // FIXME: This is all very ugly and depressing. What needs to happen here
 209   // depends on quite a few things that are all part of relaxation, which we
 210   // don't really even do.
 211
 212   if (Value->getKind() != MCExpr::SymbolRef) {
 213     MCObjectStreamer::EmitAssignment(Symbol, Value);
 214   } else {
 215     // FIXME: This is a horrible way to do this :(. This should really be
 216     // handled after we are done with the MC* objects and immediately before
 217     // writing out the object file when we know exactly what the symbol should
 218     // look like in the coff symbol table. I'm not doing that now because the
 219     // COFF object writer doesn't have a clearly defined separation between MC
 220     // data structures, the object writers data structures, and the raw, POD,
 221     // data structures that get written to disk.
 222
 223     // Copy over the aliased data.
 224     MCSymbolData &SD = getAssembler().getOrCreateSymbolData(*Symbol);
 225     const MCSymbolData &RealSD = getAssembler().getOrCreateSymbolData(
 226       dyn_cast<const MCSymbolRefExpr>(Value)->getSymbol());
 227
 228     // FIXME: This is particularly nasty because it breaks as soon as any data
 229     // members of MCSymbolData change.
 230     SD.CommonAlign     = RealSD.CommonAlign;
 231     SD.CommonSize      = RealSD.CommonSize;
 232     SD.Flags           = RealSD.Flags;
 233     SD.Fragment        = RealSD.Fragment;
 234     SD.Index           = RealSD.Index;
 235     SD.IsExternal      = RealSD.IsExternal;
 236     SD.IsPrivateExtern = RealSD.IsPrivateExtern;
 237     SD.Offset          = RealSD.Offset;
 238     SD.SymbolSize      = RealSD.SymbolSize;
 239   }
 240 }
 241
 242 void WinCOFFStreamer::EmitSymbolAttribute(MCSymbol *Symbol,
 243                                           MCSymbolAttr Attribute) {
 244   assert(Symbol && "Symbol must be non-null!");
 245   assert((Symbol->isInSection()
 246          ? Symbol->getSection().getVariant() == MCSection::SV_COFF
 247          : true) && "Got non COFF section in the COFF backend!");
 248   switch (Attribute) {
 249   case MCSA_WeakReference:
 250   case MCSA_Weak: {
 251       MCSymbolData &SD = getAssembler().getOrCreateSymbolData(*Symbol);
 252       SD.modifyFlags(COFF::SF_WeakExternal, COFF::SF_WeakExternal);
 253       SD.setExternal(true);
 254     }
 255     break;
 256
 257   case MCSA_Global:
 258     getAssembler().getOrCreateSymbolData(*Symbol).setExternal(true);
 259     break;
 260
 261   default:
 262     llvm_unreachable("unsupported attribute");
 263   }
 264 }
 265
 266 void WinCOFFStreamer::EmitSymbolDesc(MCSymbol *Symbol, unsigned DescValue) {
 267   llvm_unreachable("not implemented");
 268 }
 269
 270 void WinCOFFStreamer::BeginCOFFSymbolDef(MCSymbol const *Symbol) {
 271   assert((Symbol->isInSection()
 272          ? Symbol->getSection().getVariant() == MCSection::SV_COFF
 273          : true) && "Got non COFF section in the COFF backend!");
 274   assert(CurSymbol == NULL && "EndCOFFSymbolDef must be called between calls "
 275                               "to BeginCOFFSymbolDef!");
 276   CurSymbol = Symbol;
 277 }
 278
 279 void WinCOFFStreamer::EmitCOFFSymbolStorageClass(int StorageClass) {
 280   assert(CurSymbol != NULL && "BeginCOFFSymbolDef must be called first!");
 281   assert((StorageClass & ~0xFF) == 0 && "StorageClass must only have data in "
 282                                         "the first byte!");
 283
 284   getAssembler().getOrCreateSymbolData(*CurSymbol).modifyFlags(
 285     StorageClass << COFF::SF_ClassShift,
 286     COFF::SF_ClassMask);
 287 }
 288
 289 void WinCOFFStreamer::EmitCOFFSymbolType(int Type) {
 290   assert(CurSymbol != NULL && "BeginCOFFSymbolDef must be called first!");
 291   assert((Type & ~0xFFFF) == 0 && "Type must only have data in the first 2 "
 292                                   "bytes");
 293
 294   getAssembler().getOrCreateSymbolData(*CurSymbol).modifyFlags(
 295     Type << COFF::SF_TypeShift,
 296     COFF::SF_TypeMask);
 297 }
 298
 299 void WinCOFFStreamer::EndCOFFSymbolDef() {
 300   assert(CurSymbol != NULL && "BeginCOFFSymbolDef must be called first!");
 301   CurSymbol = NULL;
 302 }
 303
 304 void WinCOFFStreamer::EmitCOFFSecRel32(MCSymbol const *Symbol)
 305 {
 306   MCDataFragment *DF = getOrCreateDataFragment();
 307
 308   DF->getFixups().push_back(
 309       MCFixup::Create(DF->getContents().size(),
 310                       MCSymbolRefExpr::Create (Symbol, getContext ()),
 311                       FK_SecRel_4));
 312   DF->getContents().resize(DF->getContents().size() + 4, 0);
 313 }
 314
 315 void WinCOFFStreamer::EmitELFSize(MCSymbol *Symbol, const MCExpr *Value) {
 316   llvm_unreachable("not implemented");
 317 }
 318
 319 void WinCOFFStreamer::EmitCommonSymbol(MCSymbol *Symbol, uint64_t Size,
 320                                        unsigned ByteAlignment) {
 321   assert((Symbol->isInSection()
 322          ? Symbol->getSection().getVariant() == MCSection::SV_COFF
 323          : true) && "Got non COFF section in the COFF backend!");
 324   AddCommonSymbol(Symbol, Size, ByteAlignment, true);
 325 }
 326
 327 void WinCOFFStreamer::EmitLocalCommonSymbol(MCSymbol *Symbol, uint64_t Size,
 328                                             unsigned ByteAlignment) {
 329   assert((Symbol->isInSection()
 330          ? Symbol->getSection().getVariant() == MCSection::SV_COFF
 331          : true) && "Got non COFF section in the COFF backend!");
 332   AddCommonSymbol(Symbol, Size, ByteAlignment, false);
 333 }
 334
 335 void WinCOFFStreamer::EmitZerofill(const MCSection *Section, MCSymbol *Symbol,
 336                                    uint64_t Size,unsigned ByteAlignment) {
 337   llvm_unreachable("not implemented");
 338 }
 339
 340 void WinCOFFStreamer::EmitTBSSSymbol(const MCSection *Section, MCSymbol *Symbol,
 341                                      uint64_t Size, unsigned ByteAlignment) {
 342   llvm_unreachable("not implemented");
 343 }
 344
 345 void WinCOFFStreamer::EmitFileDirective(StringRef Filename) {
 346   // Ignore for now, linkers don't care, and proper debug
 347   // info will be a much large effort.
 348 }
 349
 350 void WinCOFFStreamer::EmitWin64EHHandlerData() {
 351   MCStreamer::EmitWin64EHHandlerData();
 352
 353   // We have to emit the unwind info now, because this directive
 354   // actually switches to the .xdata section!
 355   MCWin64EHUnwindEmitter::EmitUnwindInfo(*this, getCurrentW64UnwindInfo());
 356 }
 357
 358 void WinCOFFStreamer::FinishImpl() {
 359   EmitW64Tables();
 360   MCObjectStreamer::FinishImpl();
 361 }
 362
 363 namespace llvm
 364 {
 365   MCStreamer *createWinCOFFStreamer(MCContext &Context,
 366                                     MCAsmBackend &MAB,
 367                                     MCCodeEmitter &CE,
 368                                     raw_ostream &OS,
 369                                     bool RelaxAll) {
 370     WinCOFFStreamer *S = new WinCOFFStreamer(Context, MAB, CE, OS);
 371     S->getAssembler().setRelaxAll(RelaxAll);
 372     return S;
 373   }
 374 }