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