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