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