lib/MC/WinCOFFObjectWriter.cpp

   1 //===-- llvm/MC/WinCOFFObjectWriter.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 writer.
  11 //
  12 //===----------------------------------------------------------------------===//
  13
  14 #include "llvm/MC/MCWinCOFFObjectWriter.h"
  15 #include "llvm/ADT/DenseMap.h"
  16 #include "llvm/ADT/STLExtras.h"
  17 #include "llvm/ADT/StringMap.h"
  18 #include "llvm/ADT/StringRef.h"
  19 #include "llvm/ADT/Twine.h"
  20 #include "llvm/MC/MCAsmLayout.h"
  21 #include "llvm/MC/MCAssembler.h"
  22 #include "llvm/MC/MCContext.h"
  23 #include "llvm/MC/MCExpr.h"
  24 #include "llvm/MC/MCObjectWriter.h"
  25 #include "llvm/MC/MCSection.h"
  26 #include "llvm/MC/MCSectionCOFF.h"
  27 #include "llvm/MC/MCSymbol.h"
  28 #include "llvm/MC/MCValue.h"
  29 #include "llvm/MC/StringTableBuilder.h"
  30 #include "llvm/Support/COFF.h"
  31 #include "llvm/Support/Debug.h"
  32 #include "llvm/Support/Endian.h"
  33 #include "llvm/Support/ErrorHandling.h"
  34 #include "llvm/Support/TimeValue.h"
  35 #include <cstdio>
  36
  37 using namespace llvm;
  38
  39 #define DEBUG_TYPE "WinCOFFObjectWriter"
  40
  41 namespace {
  42 typedef SmallString<COFF::NameSize> name;
  43
  44 enum AuxiliaryType {
  45   ATFunctionDefinition,
  46   ATbfAndefSymbol,
  47   ATWeakExternal,
  48   ATFile,
  49   ATSectionDefinition
  50 };
  51
  52 struct AuxSymbol {
  53   AuxiliaryType   AuxType;
  54   COFF::Auxiliary Aux;
  55 };
  56
  57 class COFFSymbol;
  58 class COFFSection;
  59
  60 class COFFSymbol {
  61 public:
  62   COFF::symbol Data;
  63
  64   typedef SmallVector<AuxSymbol, 1> AuxiliarySymbols;
  65
  66   name             Name;
  67   int              Index;
  68   AuxiliarySymbols Aux;
  69   COFFSymbol      *Other;
  70   COFFSection     *Section;
  71   int              Relocations;
  72
  73   MCSymbolData const *MCData;
  74
  75   COFFSymbol(StringRef name);
  76   void set_name_offset(uint32_t Offset);
  77
  78   bool should_keep() const;
  79 };
  80
  81 // This class contains staging data for a COFF relocation entry.
  82 struct COFFRelocation {
  83   COFF::relocation Data;
  84   COFFSymbol          *Symb;
  85
  86   COFFRelocation() : Symb(nullptr) {}
  87   static size_t size() { return COFF::RelocationSize; }
  88 };
  89
  90 typedef std::vector<COFFRelocation> relocations;
  91
  92 class COFFSection {
  93 public:
  94   COFF::section Header;
  95
  96   std::string          Name;
  97   int                  Number;
  98   MCSectionData const *MCData;
  99   COFFSymbol          *Symbol;
 100   relocations          Relocations;
 101
 102   COFFSection(StringRef name);
 103   static size_t size();
 104 };
 105
 106 class WinCOFFObjectWriter : public MCObjectWriter {
 107 public:
 108
 109   typedef std::vector<std::unique_ptr<COFFSymbol>>  symbols;
 110   typedef std::vector<std::unique_ptr<COFFSection>> sections;
 111
 112   typedef DenseMap<MCSymbol  const *, COFFSymbol *>   symbol_map;
 113   typedef DenseMap<MCSection const *, COFFSection *> section_map;
 114
 115   std::unique_ptr<MCWinCOFFObjectTargetWriter> TargetObjectWriter;
 116
 117   // Root level file contents.
 118   COFF::header Header;
 119   sections     Sections;
 120   symbols      Symbols;
 121   StringTableBuilder Strings;
 122
 123   // Maps used during object file creation.
 124   section_map SectionMap;
 125   symbol_map  SymbolMap;
 126
 127   bool UseBigObj;
 128
 129   WinCOFFObjectWriter(MCWinCOFFObjectTargetWriter *MOTW, raw_ostream &OS);
 130
 131   void reset() override {
 132     memset(&Header, 0, sizeof(Header));
 133     Header.Machine = TargetObjectWriter->getMachine();
 134     Sections.clear();
 135     Symbols.clear();
 136     Strings.clear();
 137     SectionMap.clear();
 138     SymbolMap.clear();
 139     MCObjectWriter::reset();
 140   }
 141
 142   COFFSymbol *createSymbol(StringRef Name);
 143   COFFSymbol *GetOrCreateCOFFSymbol(const MCSymbol * Symbol);
 144   COFFSection *createSection(StringRef Name);
 145
 146   template <typename object_t, typename list_t>
 147   object_t *createCOFFEntity(StringRef Name, list_t &List);
 148
 149   void DefineSection(MCSectionData const &SectionData);
 150   void DefineSymbol(MCSymbolData const &SymbolData, MCAssembler &Assembler,
 151                     const MCAsmLayout &Layout);
 152
 153   void SetSymbolName(COFFSymbol &S);
 154   void SetSectionName(COFFSection &S);
 155
 156   bool ExportSymbol(const MCSymbol &Symbol, MCAssembler &Asm);
 157
 158   bool IsPhysicalSection(COFFSection *S);
 159
 160   // Entity writing methods.
 161
 162   void WriteFileHeader(const COFF::header &Header);
 163   void WriteSymbol(const COFFSymbol &S);
 164   void WriteAuxiliarySymbols(const COFFSymbol::AuxiliarySymbols &S);
 165   void WriteSectionHeader(const COFF::section &S);
 166   void WriteRelocation(const COFF::relocation &R);
 167
 168   // MCObjectWriter interface implementation.
 169
 170   void ExecutePostLayoutBinding(MCAssembler &Asm,
 171                                 const MCAsmLayout &Layout) override;
 172
 173   bool IsSymbolRefDifferenceFullyResolvedImpl(const MCAssembler &Asm,
 174                                               const MCSymbolData &DataA,
 175                                               const MCFragment &FB, bool InSet,
 176                                               bool IsPCRel) const override;
 177
 178   bool isWeak(const MCSymbolData &SD) const override;
 179
 180   void RecordRelocation(MCAssembler &Asm, const MCAsmLayout &Layout,
 181                         const MCFragment *Fragment, const MCFixup &Fixup,
 182                         MCValue Target, bool &IsPCRel,
 183                         uint64_t &FixedValue) override;
 184
 185   void WriteObject(MCAssembler &Asm, const MCAsmLayout &Layout) override;
 186 };
 187 }
 188
 189 static inline void write_uint32_le(void *Data, uint32_t Value) {
 190   support::endian::write<uint32_t, support::little, support::unaligned>(Data,
 191                                                                         Value);
 192 }
 193
 194 //------------------------------------------------------------------------------
 195 // Symbol class implementation
 196
 197 COFFSymbol::COFFSymbol(StringRef name)
 198   : Name(name.begin(), name.end())
 199   , Other(nullptr)
 200   , Section(nullptr)
 201   , Relocations(0)
 202   , MCData(nullptr) {
 203   memset(&Data, 0, sizeof(Data));
 204 }
 205
 206 // In the case that the name does not fit within 8 bytes, the offset
 207 // into the string table is stored in the last 4 bytes instead, leaving
 208 // the first 4 bytes as 0.
 209 void COFFSymbol::set_name_offset(uint32_t Offset) {
 210   write_uint32_le(Data.Name + 0, 0);
 211   write_uint32_le(Data.Name + 4, Offset);
 212 }
 213
 214 /// logic to decide if the symbol should be reported in the symbol table
 215 bool COFFSymbol::should_keep() const {
 216   // no section means its external, keep it
 217   if (!Section)
 218     return true;
 219
 220   // if it has relocations pointing at it, keep it
 221   if (Relocations > 0)   {
 222     assert(Section->Number != -1 && "Sections with relocations must be real!");
 223     return true;
 224   }
 225
 226   // if the section its in is being droped, drop it
 227   if (Section->Number == -1)
 228       return false;
 229
 230   // if it is the section symbol, keep it
 231   if (Section->Symbol == this)
 232     return true;
 233
 234   // if its temporary, drop it
 235   if (MCData && MCData->getSymbol().isTemporary())
 236       return false;
 237
 238   // otherwise, keep it
 239   return true;
 240 }
 241
 242 //------------------------------------------------------------------------------
 243 // Section class implementation
 244
 245 COFFSection::COFFSection(StringRef name)
 246   : Name(name)
 247   , MCData(nullptr)
 248   , Symbol(nullptr) {
 249   memset(&Header, 0, sizeof(Header));
 250 }
 251
 252 size_t COFFSection::size() {
 253   return COFF::SectionSize;
 254 }
 255
 256 //------------------------------------------------------------------------------
 257 // WinCOFFObjectWriter class implementation
 258
 259 WinCOFFObjectWriter::WinCOFFObjectWriter(MCWinCOFFObjectTargetWriter *MOTW,
 260                                          raw_ostream &OS)
 261     : MCObjectWriter(OS, true), TargetObjectWriter(MOTW) {
 262   memset(&Header, 0, sizeof(Header));
 263
 264   Header.Machine = TargetObjectWriter->getMachine();
 265 }
 266
 267 COFFSymbol *WinCOFFObjectWriter::createSymbol(StringRef Name) {
 268   return createCOFFEntity<COFFSymbol>(Name, Symbols);
 269 }
 270
 271 COFFSymbol *WinCOFFObjectWriter::GetOrCreateCOFFSymbol(const MCSymbol *Symbol) {
 272   symbol_map::iterator i = SymbolMap.find(Symbol);
 273   if (i != SymbolMap.end())
 274     return i->second;
 275   COFFSymbol *RetSymbol =
 276       createCOFFEntity<COFFSymbol>(Symbol->getName(), Symbols);
 277   SymbolMap[Symbol] = RetSymbol;
 278   return RetSymbol;
 279 }
 280
 281 COFFSection *WinCOFFObjectWriter::createSection(StringRef Name) {
 282   return createCOFFEntity<COFFSection>(Name, Sections);
 283 }
 284
 285 /// A template used to lookup or create a symbol/section, and initialize it if
 286 /// needed.
 287 template <typename object_t, typename list_t>
 288 object_t *WinCOFFObjectWriter::createCOFFEntity(StringRef Name,
 289                                                 list_t &List) {
 290   List.push_back(make_unique<object_t>(Name));
 291
 292   return List.back().get();
 293 }
 294
 295 /// This function takes a section data object from the assembler
 296 /// and creates the associated COFF section staging object.
 297 void WinCOFFObjectWriter::DefineSection(MCSectionData const &SectionData) {
 298   assert(SectionData.getSection().getVariant() == MCSection::SV_COFF
 299     && "Got non-COFF section in the COFF backend!");
 300   // FIXME: Not sure how to verify this (at least in a debug build).
 301   MCSectionCOFF const &Sec =
 302     static_cast<MCSectionCOFF const &>(SectionData.getSection());
 303
 304   COFFSection *coff_section = createSection(Sec.getSectionName());
 305   COFFSymbol  *coff_symbol = createSymbol(Sec.getSectionName());
 306   if (Sec.getSelection() != COFF::IMAGE_COMDAT_SELECT_ASSOCIATIVE) {
 307     if (const MCSymbol *S = Sec.getCOMDATSymbol()) {
 308       COFFSymbol *COMDATSymbol = GetOrCreateCOFFSymbol(S);
 309       if (COMDATSymbol->Section)
 310         report_fatal_error("two sections have the same comdat");
 311       COMDATSymbol->Section = coff_section;
 312     }
 313   }
 314
 315   coff_section->Symbol = coff_symbol;
 316   coff_symbol->Section = coff_section;
 317   coff_symbol->Data.StorageClass = COFF::IMAGE_SYM_CLASS_STATIC;
 318
 319   // In this case the auxiliary symbol is a Section Definition.
 320   coff_symbol->Aux.resize(1);
 321   memset(&coff_symbol->Aux[0], 0, sizeof(coff_symbol->Aux[0]));
 322   coff_symbol->Aux[0].AuxType = ATSectionDefinition;
 323   coff_symbol->Aux[0].Aux.SectionDefinition.Selection = Sec.getSelection();
 324
 325   coff_section->Header.Characteristics = Sec.getCharacteristics();
 326
 327   uint32_t &Characteristics = coff_section->Header.Characteristics;
 328   switch (SectionData.getAlignment()) {
 329   case 1:    Characteristics |= COFF::IMAGE_SCN_ALIGN_1BYTES;    break;
 330   case 2:    Characteristics |= COFF::IMAGE_SCN_ALIGN_2BYTES;    break;
 331   case 4:    Characteristics |= COFF::IMAGE_SCN_ALIGN_4BYTES;    break;
 332   case 8:    Characteristics |= COFF::IMAGE_SCN_ALIGN_8BYTES;    break;
 333   case 16:   Characteristics |= COFF::IMAGE_SCN_ALIGN_16BYTES;   break;
 334   case 32:   Characteristics |= COFF::IMAGE_SCN_ALIGN_32BYTES;   break;
 335   case 64:   Characteristics |= COFF::IMAGE_SCN_ALIGN_64BYTES;   break;
 336   case 128:  Characteristics |= COFF::IMAGE_SCN_ALIGN_128BYTES;  break;
 337   case 256:  Characteristics |= COFF::IMAGE_SCN_ALIGN_256BYTES;  break;
 338   case 512:  Characteristics |= COFF::IMAGE_SCN_ALIGN_512BYTES;  break;
 339   case 1024: Characteristics |= COFF::IMAGE_SCN_ALIGN_1024BYTES; break;
 340   case 2048: Characteristics |= COFF::IMAGE_SCN_ALIGN_2048BYTES; break;
 341   case 4096: Characteristics |= COFF::IMAGE_SCN_ALIGN_4096BYTES; break;
 342   case 8192: Characteristics |= COFF::IMAGE_SCN_ALIGN_8192BYTES; break;
 343   default:
 344     llvm_unreachable("unsupported section alignment");
 345   }
 346
 347   // Bind internal COFF section to MC section.
 348   coff_section->MCData = &SectionData;
 349   SectionMap[&SectionData.getSection()] = coff_section;
 350 }
 351
 352 static uint64_t getSymbolValue(const MCSymbolData &Data,
 353                                const MCAsmLayout &Layout) {
 354   if (Data.isCommon() && Data.isExternal())
 355     return Data.getCommonSize();
 356
 357   uint64_t Res;
 358   if (!Layout.getSymbolOffset(&Data, Res))
 359     return 0;
 360
 361   return Res;
 362 }
 363
 364 /// This function takes a symbol data object from the assembler
 365 /// and creates the associated COFF symbol staging object.
 366 void WinCOFFObjectWriter::DefineSymbol(MCSymbolData const &SymbolData,
 367                                        MCAssembler &Assembler,
 368                                        const MCAsmLayout &Layout) {
 369   MCSymbol const &Symbol = SymbolData.getSymbol();
 370   COFFSymbol *coff_symbol = GetOrCreateCOFFSymbol(&Symbol);
 371   SymbolMap[&Symbol] = coff_symbol;
 372
 373   if (SymbolData.getFlags() & COFF::SF_WeakExternal) {
 374     coff_symbol->Data.StorageClass = COFF::IMAGE_SYM_CLASS_WEAK_EXTERNAL;
 375
 376     if (Symbol.isVariable()) {
 377       const MCSymbolRefExpr *SymRef =
 378         dyn_cast<MCSymbolRefExpr>(Symbol.getVariableValue());
 379
 380       if (!SymRef)
 381         report_fatal_error("Weak externals may only alias symbols");
 382
 383       coff_symbol->Other = GetOrCreateCOFFSymbol(&SymRef->getSymbol());
 384     } else {
 385       std::string WeakName = std::string(".weak.")
 386                            +  Symbol.getName().str()
 387                            + ".default";
 388       COFFSymbol *WeakDefault = createSymbol(WeakName);
 389       WeakDefault->Data.SectionNumber = COFF::IMAGE_SYM_ABSOLUTE;
 390       WeakDefault->Data.StorageClass  = COFF::IMAGE_SYM_CLASS_EXTERNAL;
 391       WeakDefault->Data.Type          = 0;
 392       WeakDefault->Data.Value         = 0;
 393       coff_symbol->Other = WeakDefault;
 394     }
 395
 396     // Setup the Weak External auxiliary symbol.
 397     coff_symbol->Aux.resize(1);
 398     memset(&coff_symbol->Aux[0], 0, sizeof(coff_symbol->Aux[0]));
 399     coff_symbol->Aux[0].AuxType = ATWeakExternal;
 400     coff_symbol->Aux[0].Aux.WeakExternal.TagIndex = 0;
 401     coff_symbol->Aux[0].Aux.WeakExternal.Characteristics =
 402       COFF::IMAGE_WEAK_EXTERN_SEARCH_LIBRARY;
 403
 404     coff_symbol->MCData = &SymbolData;
 405   } else {
 406     const MCSymbolData &ResSymData = Assembler.getSymbolData(Symbol);
 407     const MCSymbol *Base = Layout.getBaseSymbol(Symbol);
 408     coff_symbol->Data.Value = getSymbolValue(ResSymData, Layout);
 409
 410     coff_symbol->Data.Type         = (ResSymData.getFlags() & 0x0000FFFF) >>  0;
 411     coff_symbol->Data.StorageClass = (ResSymData.getFlags() & 0x00FF0000) >> 16;
 412
 413     // If no storage class was specified in the streamer, define it here.
 414     if (coff_symbol->Data.StorageClass == 0) {
 415       bool IsExternal =
 416           ResSymData.isExternal() ||
 417           (!ResSymData.getFragment() && !ResSymData.getSymbol().isVariable());
 418
 419       coff_symbol->Data.StorageClass = IsExternal
 420                                            ? COFF::IMAGE_SYM_CLASS_EXTERNAL
 421                                            : COFF::IMAGE_SYM_CLASS_STATIC;
 422     }
 423
 424     if (!Base) {
 425       coff_symbol->Data.SectionNumber = COFF::IMAGE_SYM_ABSOLUTE;
 426     } else {
 427       const MCSymbolData &BaseData = Assembler.getSymbolData(*Base);
 428       if (BaseData.getFragment()) {
 429         COFFSection *Sec =
 430             SectionMap[&BaseData.getFragment()->getParent()->getSection()];
 431
 432         if (coff_symbol->Section && coff_symbol->Section != Sec)
 433           report_fatal_error("conflicting sections for symbol");
 434
 435         coff_symbol->Section = Sec;
 436       }
 437     }
 438
 439     coff_symbol->MCData = &ResSymData;
 440   }
 441 }
 442
 443 // Maximum offsets for different string table entry encodings.
 444 static const unsigned Max6DecimalOffset = 999999;
 445 static const unsigned Max7DecimalOffset = 9999999;
 446 static const uint64_t MaxBase64Offset = 0xFFFFFFFFFULL; // 64^6, including 0
 447
 448 // Encode a string table entry offset in base 64, padded to 6 chars, and
 449 // prefixed with a double slash: '//AAAAAA', '//AAAAAB', ...
 450 // Buffer must be at least 8 bytes large. No terminating null appended.
 451 static void encodeBase64StringEntry(char* Buffer, uint64_t Value) {
 452   assert(Value > Max7DecimalOffset && Value <= MaxBase64Offset &&
 453          "Illegal section name encoding for value");
 454
 455   static const char Alphabet[] = "ABCDEFGHIJKLMNOPQRSTUVWXYZ"
 456                                  "abcdefghijklmnopqrstuvwxyz"
 457                                  "0123456789+/";
 458
 459   Buffer[0] = '/';
 460   Buffer[1] = '/';
 461
 462   char* Ptr = Buffer + 7;
 463   for (unsigned i = 0; i < 6; ++i) {
 464     unsigned Rem = Value % 64;
 465     Value /= 64;
 466     *(Ptr--) = Alphabet[Rem];
 467   }
 468 }
 469
 470 void WinCOFFObjectWriter::SetSectionName(COFFSection &S) {
 471   if (S.Name.size() > COFF::NameSize) {
 472     uint64_t StringTableEntry = Strings.getOffset(S.Name);
 473
 474     if (StringTableEntry <= Max6DecimalOffset) {
 475       std::sprintf(S.Header.Name, "/%d", unsigned(StringTableEntry));
 476     } else if (StringTableEntry <= Max7DecimalOffset) {
 477       // With seven digits, we have to skip the terminating null. Because
 478       // sprintf always appends it, we use a larger temporary buffer.
 479       char buffer[9] = { };
 480       std::sprintf(buffer, "/%d", unsigned(StringTableEntry));
 481       std::memcpy(S.Header.Name, buffer, 8);
 482     } else if (StringTableEntry <= MaxBase64Offset) {
 483       // Starting with 10,000,000, offsets are encoded as base64.
 484       encodeBase64StringEntry(S.Header.Name, StringTableEntry);
 485     } else {
 486       report_fatal_error("COFF string table is greater than 64 GB.");
 487     }
 488   } else
 489     std::memcpy(S.Header.Name, S.Name.c_str(), S.Name.size());
 490 }
 491
 492 void WinCOFFObjectWriter::SetSymbolName(COFFSymbol &S) {
 493   if (S.Name.size() > COFF::NameSize)
 494     S.set_name_offset(Strings.getOffset(S.Name));
 495   else
 496     std::memcpy(S.Data.Name, S.Name.c_str(), S.Name.size());
 497 }
 498
 499 bool WinCOFFObjectWriter::ExportSymbol(const MCSymbol &Symbol,
 500                                        MCAssembler &Asm) {
 501   // This doesn't seem to be right. Strings referred to from the .data section
 502   // need symbols so they can be linked to code in the .text section right?
 503
 504   // return Asm.isSymbolLinkerVisible(Symbol);
 505
 506   // Non-temporary labels should always be visible to the linker.
 507   if (!Symbol.isTemporary())
 508     return true;
 509
 510   // Absolute temporary labels are never visible.
 511   if (!Symbol.isInSection())
 512     return false;
 513
 514   // For now, all non-variable symbols are exported,
 515   // the linker will sort the rest out for us.
 516   return !Symbol.isVariable();
 517 }
 518
 519 bool WinCOFFObjectWriter::IsPhysicalSection(COFFSection *S) {
 520   return (S->Header.Characteristics
 521          & COFF::IMAGE_SCN_CNT_UNINITIALIZED_DATA) == 0;
 522 }
 523
 524 //------------------------------------------------------------------------------
 525 // entity writing methods
 526
 527 void WinCOFFObjectWriter::WriteFileHeader(const COFF::header &Header) {
 528   if (UseBigObj) {
 529     WriteLE16(COFF::IMAGE_FILE_MACHINE_UNKNOWN);
 530     WriteLE16(0xFFFF);
 531     WriteLE16(COFF::BigObjHeader::MinBigObjectVersion);
 532     WriteLE16(Header.Machine);
 533     WriteLE32(Header.TimeDateStamp);
 534     for (uint8_t MagicChar : COFF::BigObjMagic)
 535       Write8(MagicChar);
 536     WriteLE32(0);
 537     WriteLE32(0);
 538     WriteLE32(0);
 539     WriteLE32(0);
 540     WriteLE32(Header.NumberOfSections);
 541     WriteLE32(Header.PointerToSymbolTable);
 542     WriteLE32(Header.NumberOfSymbols);
 543   } else {
 544     WriteLE16(Header.Machine);
 545     WriteLE16(static_cast<int16_t>(Header.NumberOfSections));
 546     WriteLE32(Header.TimeDateStamp);
 547     WriteLE32(Header.PointerToSymbolTable);
 548     WriteLE32(Header.NumberOfSymbols);
 549     WriteLE16(Header.SizeOfOptionalHeader);
 550     WriteLE16(Header.Characteristics);
 551   }
 552 }
 553
 554 void WinCOFFObjectWriter::WriteSymbol(const COFFSymbol &S) {
 555   WriteBytes(StringRef(S.Data.Name, COFF::NameSize));
 556   WriteLE32(S.Data.Value);
 557   if (UseBigObj)
 558     WriteLE32(S.Data.SectionNumber);
 559   else
 560     WriteLE16(static_cast<int16_t>(S.Data.SectionNumber));
 561   WriteLE16(S.Data.Type);
 562   Write8(S.Data.StorageClass);
 563   Write8(S.Data.NumberOfAuxSymbols);
 564   WriteAuxiliarySymbols(S.Aux);
 565 }
 566
 567 void WinCOFFObjectWriter::WriteAuxiliarySymbols(
 568                                         const COFFSymbol::AuxiliarySymbols &S) {
 569   for(COFFSymbol::AuxiliarySymbols::const_iterator i = S.begin(), e = S.end();
 570       i != e; ++i) {
 571     switch(i->AuxType) {
 572     case ATFunctionDefinition:
 573       WriteLE32(i->Aux.FunctionDefinition.TagIndex);
 574       WriteLE32(i->Aux.FunctionDefinition.TotalSize);
 575       WriteLE32(i->Aux.FunctionDefinition.PointerToLinenumber);
 576       WriteLE32(i->Aux.FunctionDefinition.PointerToNextFunction);
 577       WriteZeros(sizeof(i->Aux.FunctionDefinition.unused));
 578       if (UseBigObj)
 579         WriteZeros(COFF::Symbol32Size - COFF::Symbol16Size);
 580       break;
 581     case ATbfAndefSymbol:
 582       WriteZeros(sizeof(i->Aux.bfAndefSymbol.unused1));
 583       WriteLE16(i->Aux.bfAndefSymbol.Linenumber);
 584       WriteZeros(sizeof(i->Aux.bfAndefSymbol.unused2));
 585       WriteLE32(i->Aux.bfAndefSymbol.PointerToNextFunction);
 586       WriteZeros(sizeof(i->Aux.bfAndefSymbol.unused3));
 587       if (UseBigObj)
 588         WriteZeros(COFF::Symbol32Size - COFF::Symbol16Size);
 589       break;
 590     case ATWeakExternal:
 591       WriteLE32(i->Aux.WeakExternal.TagIndex);
 592       WriteLE32(i->Aux.WeakExternal.Characteristics);
 593       WriteZeros(sizeof(i->Aux.WeakExternal.unused));
 594       if (UseBigObj)
 595         WriteZeros(COFF::Symbol32Size - COFF::Symbol16Size);
 596       break;
 597     case ATFile:
 598       WriteBytes(
 599           StringRef(reinterpret_cast<const char *>(&i->Aux),
 600                     UseBigObj ? COFF::Symbol32Size : COFF::Symbol16Size));
 601       break;
 602     case ATSectionDefinition:
 603       WriteLE32(i->Aux.SectionDefinition.Length);
 604       WriteLE16(i->Aux.SectionDefinition.NumberOfRelocations);
 605       WriteLE16(i->Aux.SectionDefinition.NumberOfLinenumbers);
 606       WriteLE32(i->Aux.SectionDefinition.CheckSum);
 607       WriteLE16(static_cast<int16_t>(i->Aux.SectionDefinition.Number));
 608       Write8(i->Aux.SectionDefinition.Selection);
 609       WriteZeros(sizeof(i->Aux.SectionDefinition.unused));
 610       WriteLE16(static_cast<int16_t>(i->Aux.SectionDefinition.Number >> 16));
 611       if (UseBigObj)
 612         WriteZeros(COFF::Symbol32Size - COFF::Symbol16Size);
 613       break;
 614     }
 615   }
 616 }
 617
 618 void WinCOFFObjectWriter::WriteSectionHeader(const COFF::section &S) {
 619   WriteBytes(StringRef(S.Name, COFF::NameSize));
 620
 621   WriteLE32(S.VirtualSize);
 622   WriteLE32(S.VirtualAddress);
 623   WriteLE32(S.SizeOfRawData);
 624   WriteLE32(S.PointerToRawData);
 625   WriteLE32(S.PointerToRelocations);
 626   WriteLE32(S.PointerToLineNumbers);
 627   WriteLE16(S.NumberOfRelocations);
 628   WriteLE16(S.NumberOfLineNumbers);
 629   WriteLE32(S.Characteristics);
 630 }
 631
 632 void WinCOFFObjectWriter::WriteRelocation(const COFF::relocation &R) {
 633   WriteLE32(R.VirtualAddress);
 634   WriteLE32(R.SymbolTableIndex);
 635   WriteLE16(R.Type);
 636 }
 637
 638 ////////////////////////////////////////////////////////////////////////////////
 639 // MCObjectWriter interface implementations
 640
 641 void WinCOFFObjectWriter::ExecutePostLayoutBinding(MCAssembler &Asm,
 642                                                    const MCAsmLayout &Layout) {
 643   // "Define" each section & symbol. This creates section & symbol
 644   // entries in the staging area.
 645   for (const auto &Section : Asm)
 646     DefineSection(Section);
 647
 648   for (MCSymbolData &SD : Asm.symbols())
 649     if (ExportSymbol(SD.getSymbol(), Asm))
 650       DefineSymbol(SD, Asm, Layout);
 651 }
 652
 653 bool WinCOFFObjectWriter::IsSymbolRefDifferenceFullyResolvedImpl(
 654     const MCAssembler &Asm, const MCSymbolData &DataA, const MCFragment &FB,
 655     bool InSet, bool IsPCRel) const {
 656   // MS LINK expects to be able to replace all references to a function with a
 657   // thunk to implement their /INCREMENTAL feature.  Make sure we don't optimize
 658   // away any relocations to functions.
 659   if ((((DataA.getFlags() & COFF::SF_TypeMask) >> COFF::SF_TypeShift) >>
 660        COFF::SCT_COMPLEX_TYPE_SHIFT) == COFF::IMAGE_SYM_DTYPE_FUNCTION)
 661     return false;
 662   return MCObjectWriter::IsSymbolRefDifferenceFullyResolvedImpl(Asm, DataA, FB,
 663                                                                 InSet, IsPCRel);
 664 }
 665
 666 bool WinCOFFObjectWriter::isWeak(const MCSymbolData &SD) const {
 667   // FIXME: this is for PR23025. Write a good description on
 668   // why this is needed.
 669   return SD.isExternal();
 670 }
 671
 672 void WinCOFFObjectWriter::RecordRelocation(
 673     MCAssembler &Asm, const MCAsmLayout &Layout, const MCFragment *Fragment,
 674     const MCFixup &Fixup, MCValue Target, bool &IsPCRel, uint64_t &FixedValue) {
 675   assert(Target.getSymA() && "Relocation must reference a symbol!");
 676
 677   const MCSymbol &Symbol = Target.getSymA()->getSymbol();
 678   const MCSymbol &A = Symbol.AliasedSymbol();
 679   if (!Asm.hasSymbolData(A))
 680     Asm.getContext().FatalError(
 681         Fixup.getLoc(),
 682         Twine("symbol '") + A.getName() + "' can not be undefined");
 683
 684   const MCSymbolData &A_SD = Asm.getSymbolData(A);
 685
 686   MCSectionData const *SectionData = Fragment->getParent();
 687
 688   // Mark this symbol as requiring an entry in the symbol table.
 689   assert(SectionMap.find(&SectionData->getSection()) != SectionMap.end() &&
 690          "Section must already have been defined in ExecutePostLayoutBinding!");
 691   assert(SymbolMap.find(&A_SD.getSymbol()) != SymbolMap.end() &&
 692          "Symbol must already have been defined in ExecutePostLayoutBinding!");
 693
 694   COFFSection *coff_section = SectionMap[&SectionData->getSection()];
 695   COFFSymbol *coff_symbol = SymbolMap[&A_SD.getSymbol()];
 696   const MCSymbolRefExpr *SymB = Target.getSymB();
 697   bool CrossSection = false;
 698
 699   if (SymB) {
 700     const MCSymbol *B = &SymB->getSymbol();
 701     const MCSymbolData &B_SD = Asm.getSymbolData(*B);
 702     if (!B_SD.getFragment())
 703       Asm.getContext().FatalError(
 704           Fixup.getLoc(),
 705           Twine("symbol '") + B->getName() +
 706               "' can not be undefined in a subtraction expression");
 707
 708     if (!A_SD.getFragment())
 709       Asm.getContext().FatalError(
 710           Fixup.getLoc(),
 711           Twine("symbol '") + Symbol.getName() +
 712               "' can not be undefined in a subtraction expression");
 713
 714     CrossSection = &Symbol.getSection() != &B->getSection();
 715
 716     // Offset of the symbol in the section
 717     int64_t OffsetOfB = Layout.getSymbolOffset(&B_SD);
 718
 719     // In the case where we have SymbA and SymB, we just need to store the delta
 720     // between the two symbols.  Update FixedValue to account for the delta, and
 721     // skip recording the relocation.
 722     if (!CrossSection) {
 723       int64_t OffsetOfA = Layout.getSymbolOffset(&A_SD);
 724       FixedValue = (OffsetOfA - OffsetOfB) + Target.getConstant();
 725       return;
 726     }
 727
 728     // Offset of the relocation in the section
 729     int64_t OffsetOfRelocation =
 730         Layout.getFragmentOffset(Fragment) + Fixup.getOffset();
 731
 732     FixedValue = OffsetOfRelocation - OffsetOfB;
 733   } else {
 734     FixedValue = Target.getConstant();
 735   }
 736
 737   COFFRelocation Reloc;
 738
 739   Reloc.Data.SymbolTableIndex = 0;
 740   Reloc.Data.VirtualAddress = Layout.getFragmentOffset(Fragment);
 741
 742   // Turn relocations for temporary symbols into section relocations.
 743   if (coff_symbol->MCData->getSymbol().isTemporary() || CrossSection) {
 744     Reloc.Symb = coff_symbol->Section->Symbol;
 745     FixedValue += Layout.getFragmentOffset(coff_symbol->MCData->getFragment()) +
 746                   coff_symbol->MCData->getOffset();
 747   } else
 748     Reloc.Symb = coff_symbol;
 749
 750   ++Reloc.Symb->Relocations;
 751
 752   Reloc.Data.VirtualAddress += Fixup.getOffset();
 753   Reloc.Data.Type =
 754       TargetObjectWriter->getRelocType(Target, Fixup, CrossSection,
 755                                        Asm.getBackend());
 756
 757   // FIXME: Can anyone explain what this does other than adjust for the size
 758   // of the offset?
 759   if ((Header.Machine == COFF::IMAGE_FILE_MACHINE_AMD64 &&
 760        Reloc.Data.Type == COFF::IMAGE_REL_AMD64_REL32) ||
 761       (Header.Machine == COFF::IMAGE_FILE_MACHINE_I386 &&
 762        Reloc.Data.Type == COFF::IMAGE_REL_I386_REL32))
 763     FixedValue += 4;
 764
 765   if (Header.Machine == COFF::IMAGE_FILE_MACHINE_ARMNT) {
 766     switch (Reloc.Data.Type) {
 767     case COFF::IMAGE_REL_ARM_ABSOLUTE:
 768     case COFF::IMAGE_REL_ARM_ADDR32:
 769     case COFF::IMAGE_REL_ARM_ADDR32NB:
 770     case COFF::IMAGE_REL_ARM_TOKEN:
 771     case COFF::IMAGE_REL_ARM_SECTION:
 772     case COFF::IMAGE_REL_ARM_SECREL:
 773       break;
 774     case COFF::IMAGE_REL_ARM_BRANCH11:
 775     case COFF::IMAGE_REL_ARM_BLX11:
 776       // IMAGE_REL_ARM_BRANCH11 and IMAGE_REL_ARM_BLX11 are only used for
 777       // pre-ARMv7, which implicitly rules it out of ARMNT (it would be valid
 778       // for Windows CE).
 779     case COFF::IMAGE_REL_ARM_BRANCH24:
 780     case COFF::IMAGE_REL_ARM_BLX24:
 781     case COFF::IMAGE_REL_ARM_MOV32A:
 782       // IMAGE_REL_ARM_BRANCH24, IMAGE_REL_ARM_BLX24, IMAGE_REL_ARM_MOV32A are
 783       // only used for ARM mode code, which is documented as being unsupported
 784       // by Windows on ARM.  Empirical proof indicates that masm is able to
 785       // generate the relocations however the rest of the MSVC toolchain is
 786       // unable to handle it.
 787       llvm_unreachable("unsupported relocation");
 788       break;
 789     case COFF::IMAGE_REL_ARM_MOV32T:
 790       break;
 791     case COFF::IMAGE_REL_ARM_BRANCH20T:
 792     case COFF::IMAGE_REL_ARM_BRANCH24T:
 793     case COFF::IMAGE_REL_ARM_BLX23T:
 794       // IMAGE_REL_BRANCH20T, IMAGE_REL_ARM_BRANCH24T, IMAGE_REL_ARM_BLX23T all
 795       // perform a 4 byte adjustment to the relocation.  Relative branches are
 796       // offset by 4 on ARM, however, because there is no RELA relocations, all
 797       // branches are offset by 4.
 798       FixedValue = FixedValue + 4;
 799       break;
 800     }
 801   }
 802
 803   if (TargetObjectWriter->recordRelocation(Fixup))
 804     coff_section->Relocations.push_back(Reloc);
 805 }
 806
 807 void WinCOFFObjectWriter::WriteObject(MCAssembler &Asm,
 808                                       const MCAsmLayout &Layout) {
 809   size_t SectionsSize = Sections.size();
 810   if (SectionsSize > static_cast<size_t>(INT32_MAX))
 811     report_fatal_error(
 812         "PE COFF object files can't have more than 2147483647 sections");
 813
 814   // Assign symbol and section indexes and offsets.
 815   int32_t NumberOfSections = static_cast<int32_t>(SectionsSize);
 816
 817   UseBigObj = NumberOfSections > COFF::MaxNumberOfSections16;
 818
 819   DenseMap<COFFSection *, int32_t> SectionIndices(
 820       NextPowerOf2(NumberOfSections));
 821
 822   // Assign section numbers.
 823   size_t Number = 1;
 824   for (const auto &Section : Sections) {
 825     SectionIndices[Section.get()] = Number;
 826     Section->Number = Number;
 827     Section->Symbol->Data.SectionNumber = Number;
 828     Section->Symbol->Aux[0].Aux.SectionDefinition.Number = Number;
 829     ++Number;
 830   }
 831
 832   Header.NumberOfSections = NumberOfSections;
 833   Header.NumberOfSymbols = 0;
 834
 835   for (auto FI = Asm.file_names_begin(), FE = Asm.file_names_end();
 836        FI != FE; ++FI) {
 837     // round up to calculate the number of auxiliary symbols required
 838     unsigned SymbolSize = UseBigObj ? COFF::Symbol32Size : COFF::Symbol16Size;
 839     unsigned Count = (FI->size() + SymbolSize - 1) / SymbolSize;
 840
 841     COFFSymbol *file = createSymbol(".file");
 842     file->Data.SectionNumber = COFF::IMAGE_SYM_DEBUG;
 843     file->Data.StorageClass = COFF::IMAGE_SYM_CLASS_FILE;
 844     file->Aux.resize(Count);
 845
 846     unsigned Offset = 0;
 847     unsigned Length = FI->size();
 848     for (auto &Aux : file->Aux) {
 849       Aux.AuxType = ATFile;
 850
 851       if (Length > SymbolSize) {
 852         memcpy(&Aux.Aux, FI->c_str() + Offset, SymbolSize);
 853         Length = Length - SymbolSize;
 854       } else {
 855         memcpy(&Aux.Aux, FI->c_str() + Offset, Length);
 856         memset((char *)&Aux.Aux + Length, 0, SymbolSize - Length);
 857         break;
 858       }
 859
 860       Offset += SymbolSize;
 861     }
 862   }
 863
 864   for (auto &Symbol : Symbols) {
 865     // Update section number & offset for symbols that have them.
 866     if (Symbol->Section)
 867       Symbol->Data.SectionNumber = Symbol->Section->Number;
 868     if (Symbol->should_keep()) {
 869       Symbol->Index = Header.NumberOfSymbols++;
 870       // Update auxiliary symbol info.
 871       Symbol->Data.NumberOfAuxSymbols = Symbol->Aux.size();
 872       Header.NumberOfSymbols += Symbol->Data.NumberOfAuxSymbols;
 873     } else
 874       Symbol->Index = -1;
 875   }
 876
 877   // Build string table.
 878   for (const auto &S : Sections)
 879     if (S->Name.size() > COFF::NameSize)
 880       Strings.add(S->Name);
 881   for (const auto &S : Symbols)
 882     if (S->should_keep() && S->Name.size() > COFF::NameSize)
 883       Strings.add(S->Name);
 884   Strings.finalize(StringTableBuilder::WinCOFF);
 885
 886   // Set names.
 887   for (const auto &S : Sections)
 888     SetSectionName(*S);
 889   for (auto &S : Symbols)
 890     if (S->should_keep())
 891       SetSymbolName(*S);
 892
 893   // Fixup weak external references.
 894   for (auto &Symbol : Symbols) {
 895     if (Symbol->Other) {
 896       assert(Symbol->Index != -1);
 897       assert(Symbol->Aux.size() == 1 && "Symbol must contain one aux symbol!");
 898       assert(Symbol->Aux[0].AuxType == ATWeakExternal &&
 899              "Symbol's aux symbol must be a Weak External!");
 900       Symbol->Aux[0].Aux.WeakExternal.TagIndex = Symbol->Other->Index;
 901     }
 902   }
 903
 904   // Fixup associative COMDAT sections.
 905   for (auto &Section : Sections) {
 906     if (Section->Symbol->Aux[0].Aux.SectionDefinition.Selection !=
 907         COFF::IMAGE_COMDAT_SELECT_ASSOCIATIVE)
 908       continue;
 909
 910     const MCSectionCOFF &MCSec =
 911       static_cast<const MCSectionCOFF &>(Section->MCData->getSection());
 912
 913     const MCSymbol *COMDAT = MCSec.getCOMDATSymbol();
 914     assert(COMDAT);
 915     COFFSymbol *COMDATSymbol = GetOrCreateCOFFSymbol(COMDAT);
 916     assert(COMDATSymbol);
 917     COFFSection *Assoc = COMDATSymbol->Section;
 918     if (!Assoc)
 919       report_fatal_error(
 920           Twine("Missing associated COMDAT section for section ") +
 921           MCSec.getSectionName());
 922
 923     // Skip this section if the associated section is unused.
 924     if (Assoc->Number == -1)
 925       continue;
 926
 927     Section->Symbol->Aux[0].Aux.SectionDefinition.Number = SectionIndices[Assoc];
 928   }
 929
 930
 931   // Assign file offsets to COFF object file structures.
 932
 933   unsigned offset = 0;
 934
 935   if (UseBigObj)
 936     offset += COFF::Header32Size;
 937   else
 938     offset += COFF::Header16Size;
 939   offset += COFF::SectionSize * Header.NumberOfSections;
 940
 941   for (const auto &Section : Asm) {
 942     COFFSection *Sec = SectionMap[&Section.getSection()];
 943
 944     if (Sec->Number == -1)
 945       continue;
 946
 947     Sec->Header.SizeOfRawData = Layout.getSectionAddressSize(&Section);
 948
 949     if (IsPhysicalSection(Sec)) {
 950       // Align the section data to a four byte boundary.
 951       offset = RoundUpToAlignment(offset, 4);
 952       Sec->Header.PointerToRawData = offset;
 953
 954       offset += Sec->Header.SizeOfRawData;
 955     }
 956
 957     if (Sec->Relocations.size() > 0) {
 958       bool RelocationsOverflow = Sec->Relocations.size() >= 0xffff;
 959
 960       if (RelocationsOverflow) {
 961         // Signal overflow by setting NumberOfRelocations to max value. Actual
 962         // size is found in reloc #0. Microsoft tools understand this.
 963         Sec->Header.NumberOfRelocations = 0xffff;
 964       } else {
 965         Sec->Header.NumberOfRelocations = Sec->Relocations.size();
 966       }
 967       Sec->Header.PointerToRelocations = offset;
 968
 969       if (RelocationsOverflow) {
 970         // Reloc #0 will contain actual count, so make room for it.
 971         offset += COFF::RelocationSize;
 972       }
 973
 974       offset += COFF::RelocationSize * Sec->Relocations.size();
 975
 976       for (auto &Relocation : Sec->Relocations) {
 977         assert(Relocation.Symb->Index != -1);
 978         Relocation.Data.SymbolTableIndex = Relocation.Symb->Index;
 979       }
 980     }
 981
 982     assert(Sec->Symbol->Aux.size() == 1 &&
 983            "Section's symbol must have one aux!");
 984     AuxSymbol &Aux = Sec->Symbol->Aux[0];
 985     assert(Aux.AuxType == ATSectionDefinition &&
 986            "Section's symbol's aux symbol must be a Section Definition!");
 987     Aux.Aux.SectionDefinition.Length = Sec->Header.SizeOfRawData;
 988     Aux.Aux.SectionDefinition.NumberOfRelocations =
 989                                                 Sec->Header.NumberOfRelocations;
 990     Aux.Aux.SectionDefinition.NumberOfLinenumbers =
 991                                                 Sec->Header.NumberOfLineNumbers;
 992   }
 993
 994   Header.PointerToSymbolTable = offset;
 995
 996   // We want a deterministic output. It looks like GNU as also writes 0 in here.
 997   Header.TimeDateStamp = 0;
 998
 999   // Write it all to disk...
1000   WriteFileHeader(Header);
1001
1002   {
1003     sections::iterator i, ie;
1004     MCAssembler::const_iterator j, je;
1005
1006     for (auto &Section : Sections) {
1007       if (Section->Number != -1) {
1008         if (Section->Relocations.size() >= 0xffff)
1009           Section->Header.Characteristics |= COFF::IMAGE_SCN_LNK_NRELOC_OVFL;
1010         WriteSectionHeader(Section->Header);
1011       }
1012     }
1013
1014     for (i = Sections.begin(), ie = Sections.end(),
1015          j = Asm.begin(), je = Asm.end();
1016          (i != ie) && (j != je); ++i, ++j) {
1017
1018       if ((*i)->Number == -1)
1019         continue;
1020
1021       if ((*i)->Header.PointerToRawData != 0) {
1022         assert(OS.tell() <= (*i)->Header.PointerToRawData &&
1023                "Section::PointerToRawData is insane!");
1024
1025         unsigned SectionDataPadding = (*i)->Header.PointerToRawData - OS.tell();
1026         assert(SectionDataPadding < 4 &&
1027                "Should only need at most three bytes of padding!");
1028
1029         WriteZeros(SectionDataPadding);
1030
1031         Asm.writeSectionData(j, Layout);
1032       }
1033
1034       if ((*i)->Relocations.size() > 0) {
1035         assert(OS.tell() == (*i)->Header.PointerToRelocations &&
1036                "Section::PointerToRelocations is insane!");
1037
1038         if ((*i)->Relocations.size() >= 0xffff) {
1039           // In case of overflow, write actual relocation count as first
1040           // relocation. Including the synthetic reloc itself (+ 1).
1041           COFF::relocation r;
1042           r.VirtualAddress = (*i)->Relocations.size() + 1;
1043           r.SymbolTableIndex = 0;
1044           r.Type = 0;
1045           WriteRelocation(r);
1046         }
1047
1048         for (const auto &Relocation : (*i)->Relocations)
1049           WriteRelocation(Relocation.Data);
1050       } else
1051         assert((*i)->Header.PointerToRelocations == 0 &&
1052                "Section::PointerToRelocations is insane!");
1053     }
1054   }
1055
1056   assert(OS.tell() == Header.PointerToSymbolTable &&
1057          "Header::PointerToSymbolTable is insane!");
1058
1059   for (auto &Symbol : Symbols)
1060     if (Symbol->Index != -1)
1061       WriteSymbol(*Symbol);
1062
1063   OS.write(Strings.data().data(), Strings.data().size());
1064 }
1065
1066 MCWinCOFFObjectTargetWriter::MCWinCOFFObjectTargetWriter(unsigned Machine_) :
1067   Machine(Machine_) {
1068 }
1069
1070 // Pin the vtable to this file.
1071 void MCWinCOFFObjectTargetWriter::anchor() {}
1072
1073 //------------------------------------------------------------------------------
1074 // WinCOFFObjectWriter factory function
1075
1076 namespace llvm {
1077   MCObjectWriter *createWinCOFFObjectWriter(MCWinCOFFObjectTargetWriter *MOTW,
1078                                             raw_ostream &OS) {
1079     return new WinCOFFObjectWriter(MOTW, OS);
1080   }
1081 }