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