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