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/MCObjectWriter.h"
  17 #include "llvm/MC/MCSection.h"
  18 #include "llvm/MC/MCContext.h"
  19 #include "llvm/MC/MCSymbol.h"
  20 #include "llvm/MC/MCExpr.h"
  21 #include "llvm/MC/MCValue.h"
  22 #include "llvm/MC/MCAssembler.h"
  23 #include "llvm/MC/MCAsmLayout.h"
  24 #include "llvm/MC/MCSectionCOFF.h"
  25
  26 #include "llvm/ADT/DenseMap.h"
  27 #include "llvm/ADT/StringMap.h"
  28 #include "llvm/ADT/StringRef.h"
  29
  30 #include "llvm/Support/COFF.h"
  31 #include "llvm/Support/Debug.h"
  32 #include "llvm/Support/ErrorHandling.h"
  33
  34 #include "llvm/Support/TimeValue.h"
  35
  36 #include "../Target/X86/MCTargetDesc/X86FixupKinds.h"
  37
  38 #include <cstdio>
  39
  40 using namespace llvm;
  41
  42 namespace {
  43 typedef llvm::SmallString<COFF::NameSize> name;
  44
  45 enum AuxiliaryType {
  46   ATFunctionDefinition,
  47   ATbfAndefSymbol,
  48   ATWeakExternal,
  49   ATFile,
  50   ATSectionDefinition
  51 };
  52
  53 struct AuxSymbol {
  54   AuxiliaryType   AuxType;
  55   COFF::Auxiliary Aux;
  56 };
  57
  58 class COFFSymbol;
  59 class COFFSection;
  60
  61 class COFFSymbol {
  62 public:
  63   COFF::symbol Data;
  64
  65   typedef llvm::SmallVector<AuxSymbol, 1> AuxiliarySymbols;
  66
  67   name             Name;
  68   int              Index;
  69   AuxiliarySymbols Aux;
  70   COFFSymbol      *Other;
  71   COFFSection     *Section;
  72   int              Relocations;
  73
  74   MCSymbolData const *MCData;
  75
  76   COFFSymbol(llvm::StringRef name);
  77   size_t size() const;
  78   void set_name_offset(uint32_t Offset);
  79
  80   bool should_keep() const;
  81 };
  82
  83 // This class contains staging data for a COFF relocation entry.
  84 struct COFFRelocation {
  85   COFF::relocation Data;
  86   COFFSymbol          *Symb;
  87
  88   COFFRelocation() : Symb(NULL) {}
  89   static size_t size() { return COFF::RelocationSize; }
  90 };
  91
  92 typedef std::vector<COFFRelocation> relocations;
  93
  94 class COFFSection {
  95 public:
  96   COFF::section Header;
  97
  98   std::string          Name;
  99   int                  Number;
 100   MCSectionData const *MCData;
 101   COFFSymbol          *Symbol;
 102   relocations          Relocations;
 103
 104   COFFSection(llvm::StringRef name);
 105   static size_t size();
 106 };
 107
 108 // This class holds the COFF string table.
 109 class StringTable {
 110   typedef llvm::StringMap<size_t> map;
 111   map Map;
 112
 113   void update_length();
 114 public:
 115   std::vector<char> Data;
 116
 117   StringTable();
 118   size_t size() const;
 119   size_t insert(llvm::StringRef String);
 120 };
 121
 122 class WinCOFFObjectWriter : public MCObjectWriter {
 123 public:
 124
 125   typedef std::vector<COFFSymbol*>  symbols;
 126   typedef std::vector<COFFSection*> sections;
 127
 128   typedef DenseMap<MCSymbol  const *, COFFSymbol *>   symbol_map;
 129   typedef DenseMap<MCSection const *, COFFSection *> section_map;
 130
 131   // Root level file contents.
 132   bool Is64Bit;
 133   COFF::header Header;
 134   sections     Sections;
 135   symbols      Symbols;
 136   StringTable  Strings;
 137
 138   // Maps used during object file creation.
 139   section_map SectionMap;
 140   symbol_map  SymbolMap;
 141
 142   WinCOFFObjectWriter(raw_ostream &OS, bool is64Bit);
 143   ~WinCOFFObjectWriter();
 144
 145   COFFSymbol *createSymbol(StringRef Name);
 146   COFFSymbol *GetOrCreateCOFFSymbol(const MCSymbol * Symbol);
 147   COFFSection *createSection(StringRef Name);
 148
 149   template <typename object_t, typename list_t>
 150   object_t *createCOFFEntity(llvm::StringRef Name, list_t &List);
 151
 152   void DefineSection(MCSectionData const &SectionData);
 153   void DefineSymbol(MCSymbolData const &SymbolData, MCAssembler &Assembler);
 154
 155   void MakeSymbolReal(COFFSymbol &S, size_t Index);
 156   void MakeSectionReal(COFFSection &S, size_t Number);
 157
 158   bool ExportSection(COFFSection const *S);
 159   bool ExportSymbol(MCSymbolData const &SymbolData, MCAssembler &Asm);
 160
 161   bool IsPhysicalSection(COFFSection *S);
 162
 163   // Entity writing methods.
 164
 165   void WriteFileHeader(const COFF::header &Header);
 166   void WriteSymbol(const COFFSymbol *S);
 167   void WriteAuxiliarySymbols(const COFFSymbol::AuxiliarySymbols &S);
 168   void WriteSectionHeader(const COFF::section &S);
 169   void WriteRelocation(const COFF::relocation &R);
 170
 171   // MCObjectWriter interface implementation.
 172
 173   void ExecutePostLayoutBinding(MCAssembler &Asm, const MCAsmLayout &Layout);
 174
 175   void RecordRelocation(const MCAssembler &Asm,
 176                         const MCAsmLayout &Layout,
 177                         const MCFragment *Fragment,
 178                         const MCFixup &Fixup,
 179                         MCValue Target,
 180                         uint64_t &FixedValue);
 181
 182   void WriteObject(MCAssembler &Asm, const MCAsmLayout &Layout);
 183 };
 184 }
 185
 186 static inline void write_uint32_le(void *Data, uint32_t const &Value) {
 187   uint8_t *Ptr = reinterpret_cast<uint8_t *>(Data);
 188   Ptr[0] = (Value & 0x000000FF) >>  0;
 189   Ptr[1] = (Value & 0x0000FF00) >>  8;
 190   Ptr[2] = (Value & 0x00FF0000) >> 16;
 191   Ptr[3] = (Value & 0xFF000000) >> 24;
 192 }
 193
 194 static inline void write_uint16_le(void *Data, uint16_t const &Value) {
 195   uint8_t *Ptr = reinterpret_cast<uint8_t *>(Data);
 196   Ptr[0] = (Value & 0x00FF) >> 0;
 197   Ptr[1] = (Value & 0xFF00) >> 8;
 198 }
 199
 200 static inline void write_uint8_le(void *Data, uint8_t const &Value) {
 201   uint8_t *Ptr = reinterpret_cast<uint8_t *>(Data);
 202   Ptr[0] = (Value & 0xFF) >> 0;
 203 }
 204
 205 //------------------------------------------------------------------------------
 206 // Symbol class implementation
 207
 208 COFFSymbol::COFFSymbol(llvm::StringRef name)
 209   : Name(name.begin(), name.end())
 210   , Other(NULL)
 211   , Section(NULL)
 212   , Relocations(0)
 213   , MCData(NULL) {
 214   memset(&Data, 0, sizeof(Data));
 215 }
 216
 217 size_t COFFSymbol::size() const {
 218   return COFF::SymbolSize + (Data.NumberOfAuxSymbols * COFF::SymbolSize);
 219 }
 220
 221 // In the case that the name does not fit within 8 bytes, the offset
 222 // into the string table is stored in the last 4 bytes instead, leaving
 223 // the first 4 bytes as 0.
 224 void COFFSymbol::set_name_offset(uint32_t Offset) {
 225   write_uint32_le(Data.Name + 0, 0);
 226   write_uint32_le(Data.Name + 4, Offset);
 227 }
 228
 229 /// logic to decide if the symbol should be reported in the symbol table
 230 bool COFFSymbol::should_keep() const {
 231   // no section means its external, keep it
 232   if (Section == NULL)
 233     return true;
 234
 235   // if it has relocations pointing at it, keep it
 236   if (Relocations > 0)   {
 237     assert(Section->Number != -1 && "Sections with relocations must be real!");
 238     return true;
 239   }
 240
 241   // if the section its in is being droped, drop it
 242   if (Section->Number == -1)
 243       return false;
 244
 245   // if it is the section symbol, keep it
 246   if (Section->Symbol == this)
 247     return true;
 248
 249   // if its temporary, drop it
 250   if (MCData && MCData->getSymbol().isTemporary())
 251       return false;
 252
 253   // otherwise, keep it
 254   return true;
 255 }
 256
 257 //------------------------------------------------------------------------------
 258 // Section class implementation
 259
 260 COFFSection::COFFSection(llvm::StringRef name)
 261   : Name(name)
 262   , MCData(NULL)
 263   , Symbol(NULL) {
 264   memset(&Header, 0, sizeof(Header));
 265 }
 266
 267 size_t COFFSection::size() {
 268   return COFF::SectionSize;
 269 }
 270
 271 //------------------------------------------------------------------------------
 272 // StringTable class implementation
 273
 274 /// Write the length of the string table into Data.
 275 /// The length of the string table includes uint32 length header.
 276 void StringTable::update_length() {
 277   write_uint32_le(&Data.front(), Data.size());
 278 }
 279
 280 StringTable::StringTable() {
 281   // The string table data begins with the length of the entire string table
 282   // including the length header. Allocate space for this header.
 283   Data.resize(4);
 284   update_length();
 285 }
 286
 287 size_t StringTable::size() const {
 288   return Data.size();
 289 }
 290
 291 /// Add String to the table iff it is not already there.
 292 /// @returns the index into the string table where the string is now located.
 293 size_t StringTable::insert(llvm::StringRef String) {
 294   map::iterator i = Map.find(String);
 295
 296   if (i != Map.end())
 297     return i->second;
 298
 299   size_t Offset = Data.size();
 300
 301   // Insert string data into string table.
 302   Data.insert(Data.end(), String.begin(), String.end());
 303   Data.push_back('\0');
 304
 305   // Put a reference to it in the map.
 306   Map[String] = Offset;
 307
 308   // Update the internal length field.
 309   update_length();
 310
 311   return Offset;
 312 }
 313
 314 //------------------------------------------------------------------------------
 315 // WinCOFFObjectWriter class implementation
 316
 317 WinCOFFObjectWriter::WinCOFFObjectWriter(raw_ostream &OS, bool is64Bit)
 318   : MCObjectWriter(OS, true)
 319   , Is64Bit(is64Bit) {
 320   memset(&Header, 0, sizeof(Header));
 321
 322   Is64Bit ? Header.Machine = COFF::IMAGE_FILE_MACHINE_AMD64
 323           : Header.Machine = COFF::IMAGE_FILE_MACHINE_I386;
 324 }
 325
 326 WinCOFFObjectWriter::~WinCOFFObjectWriter() {
 327   for (symbols::iterator I = Symbols.begin(), E = Symbols.end(); I != E; ++I)
 328     delete *I;
 329   for (sections::iterator I = Sections.begin(), E = Sections.end(); I != E; ++I)
 330     delete *I;
 331 }
 332
 333 COFFSymbol *WinCOFFObjectWriter::createSymbol(StringRef Name) {
 334   return createCOFFEntity<COFFSymbol>(Name, Symbols);
 335 }
 336
 337 COFFSymbol *WinCOFFObjectWriter::GetOrCreateCOFFSymbol(const MCSymbol * Symbol){
 338   symbol_map::iterator i = SymbolMap.find(Symbol);
 339   if (i != SymbolMap.end())
 340     return i->second;
 341   COFFSymbol *RetSymbol
 342     = createCOFFEntity<COFFSymbol>(Symbol->getName(), Symbols);
 343   SymbolMap[Symbol] = RetSymbol;
 344   return RetSymbol;
 345 }
 346
 347 COFFSection *WinCOFFObjectWriter::createSection(llvm::StringRef Name) {
 348   return createCOFFEntity<COFFSection>(Name, Sections);
 349 }
 350
 351 /// A template used to lookup or create a symbol/section, and initialize it if
 352 /// needed.
 353 template <typename object_t, typename list_t>
 354 object_t *WinCOFFObjectWriter::createCOFFEntity(llvm::StringRef Name,
 355                                                 list_t &List) {
 356   object_t *Object = new object_t(Name);
 357
 358   List.push_back(Object);
 359
 360   return Object;
 361 }
 362
 363 /// This function takes a section data object from the assembler
 364 /// and creates the associated COFF section staging object.
 365 void WinCOFFObjectWriter::DefineSection(MCSectionData const &SectionData) {
 366   assert(SectionData.getSection().getVariant() == MCSection::SV_COFF
 367     && "Got non COFF section in the COFF backend!");
 368   // FIXME: Not sure how to verify this (at least in a debug build).
 369   MCSectionCOFF const &Sec =
 370     static_cast<MCSectionCOFF const &>(SectionData.getSection());
 371
 372   COFFSection *coff_section = createSection(Sec.getSectionName());
 373   COFFSymbol  *coff_symbol = createSymbol(Sec.getSectionName());
 374
 375   coff_section->Symbol = coff_symbol;
 376   coff_symbol->Section = coff_section;
 377   coff_symbol->Data.StorageClass = COFF::IMAGE_SYM_CLASS_STATIC;
 378
 379   // In this case the auxiliary symbol is a Section Definition.
 380   coff_symbol->Aux.resize(1);
 381   memset(&coff_symbol->Aux[0], 0, sizeof(coff_symbol->Aux[0]));
 382   coff_symbol->Aux[0].AuxType = ATSectionDefinition;
 383   coff_symbol->Aux[0].Aux.SectionDefinition.Selection = Sec.getSelection();
 384
 385   coff_section->Header.Characteristics = Sec.getCharacteristics();
 386
 387   uint32_t &Characteristics = coff_section->Header.Characteristics;
 388   switch (SectionData.getAlignment()) {
 389   case 1:    Characteristics |= COFF::IMAGE_SCN_ALIGN_1BYTES;    break;
 390   case 2:    Characteristics |= COFF::IMAGE_SCN_ALIGN_2BYTES;    break;
 391   case 4:    Characteristics |= COFF::IMAGE_SCN_ALIGN_4BYTES;    break;
 392   case 8:    Characteristics |= COFF::IMAGE_SCN_ALIGN_8BYTES;    break;
 393   case 16:   Characteristics |= COFF::IMAGE_SCN_ALIGN_16BYTES;   break;
 394   case 32:   Characteristics |= COFF::IMAGE_SCN_ALIGN_32BYTES;   break;
 395   case 64:   Characteristics |= COFF::IMAGE_SCN_ALIGN_64BYTES;   break;
 396   case 128:  Characteristics |= COFF::IMAGE_SCN_ALIGN_128BYTES;  break;
 397   case 256:  Characteristics |= COFF::IMAGE_SCN_ALIGN_256BYTES;  break;
 398   case 512:  Characteristics |= COFF::IMAGE_SCN_ALIGN_512BYTES;  break;
 399   case 1024: Characteristics |= COFF::IMAGE_SCN_ALIGN_1024BYTES; break;
 400   case 2048: Characteristics |= COFF::IMAGE_SCN_ALIGN_2048BYTES; break;
 401   case 4096: Characteristics |= COFF::IMAGE_SCN_ALIGN_4096BYTES; break;
 402   case 8192: Characteristics |= COFF::IMAGE_SCN_ALIGN_8192BYTES; break;
 403   default:
 404     llvm_unreachable("unsupported section alignment");
 405   }
 406
 407   // Bind internal COFF section to MC section.
 408   coff_section->MCData = &SectionData;
 409   SectionMap[&SectionData.getSection()] = coff_section;
 410 }
 411
 412 /// This function takes a section data object from the assembler
 413 /// and creates the associated COFF symbol staging object.
 414 void WinCOFFObjectWriter::DefineSymbol(MCSymbolData const &SymbolData,
 415                                        MCAssembler &Assembler) {
 416   COFFSymbol *coff_symbol = GetOrCreateCOFFSymbol(&SymbolData.getSymbol());
 417
 418   coff_symbol->Data.Type         = (SymbolData.getFlags() & 0x0000FFFF) >>  0;
 419   coff_symbol->Data.StorageClass = (SymbolData.getFlags() & 0x00FF0000) >> 16;
 420
 421   if (SymbolData.getFlags() & COFF::SF_WeakExternal) {
 422     coff_symbol->Data.StorageClass = COFF::IMAGE_SYM_CLASS_WEAK_EXTERNAL;
 423
 424     if (SymbolData.getSymbol().isVariable()) {
 425       coff_symbol->Data.StorageClass = COFF::IMAGE_SYM_CLASS_WEAK_EXTERNAL;
 426       const MCExpr *Value = SymbolData.getSymbol().getVariableValue();
 427
 428       // FIXME: This assert message isn't very good.
 429       assert(Value->getKind() == MCExpr::SymbolRef &&
 430               "Value must be a SymbolRef!");
 431
 432       const MCSymbolRefExpr *SymbolRef =
 433         static_cast<const MCSymbolRefExpr *>(Value);
 434       coff_symbol->Other = GetOrCreateCOFFSymbol(&SymbolRef->getSymbol());
 435     } else {
 436       std::string WeakName = std::string(".weak.")
 437                            +  SymbolData.getSymbol().getName().str()
 438                            + ".default";
 439       COFFSymbol *WeakDefault = createSymbol(WeakName);
 440       WeakDefault->Data.SectionNumber = COFF::IMAGE_SYM_ABSOLUTE;
 441       WeakDefault->Data.StorageClass  = COFF::IMAGE_SYM_CLASS_EXTERNAL;
 442       WeakDefault->Data.Type          = 0;
 443       WeakDefault->Data.Value         = 0;
 444       coff_symbol->Other = WeakDefault;
 445     }
 446
 447     // Setup the Weak External auxiliary symbol.
 448     coff_symbol->Aux.resize(1);
 449     memset(&coff_symbol->Aux[0], 0, sizeof(coff_symbol->Aux[0]));
 450     coff_symbol->Aux[0].AuxType = ATWeakExternal;
 451     coff_symbol->Aux[0].Aux.WeakExternal.TagIndex = 0;
 452     coff_symbol->Aux[0].Aux.WeakExternal.Characteristics =
 453       COFF::IMAGE_WEAK_EXTERN_SEARCH_LIBRARY;
 454   }
 455
 456   // If no storage class was specified in the streamer, define it here.
 457   if (coff_symbol->Data.StorageClass == 0) {
 458     bool external = SymbolData.isExternal() || (SymbolData.Fragment == NULL);
 459
 460     coff_symbol->Data.StorageClass =
 461       external ? COFF::IMAGE_SYM_CLASS_EXTERNAL : COFF::IMAGE_SYM_CLASS_STATIC;
 462   }
 463
 464   if (SymbolData.Fragment != NULL)
 465     coff_symbol->Section =
 466       SectionMap[&SymbolData.Fragment->getParent()->getSection()];
 467
 468   // Bind internal COFF symbol to MC symbol.
 469   coff_symbol->MCData = &SymbolData;
 470   SymbolMap[&SymbolData.getSymbol()] = coff_symbol;
 471 }
 472
 473 /// making a section real involves assigned it a number and putting
 474 /// name into the string table if needed
 475 void WinCOFFObjectWriter::MakeSectionReal(COFFSection &S, size_t Number) {
 476   if (S.Name.size() > COFF::NameSize) {
 477     size_t StringTableEntry = Strings.insert(S.Name.c_str());
 478
 479     // FIXME: Why is this number 999999? This number is never mentioned in the
 480     // spec. I'm assuming this is due to the printed value needing to fit into
 481     // the S.Header.Name field. In which case why not 9999999 (7 9's instead of
 482     // 6)? The spec does not state if this entry should be null terminated in
 483     // this case, and thus this seems to be the best way to do it. I think I
 484     // just solved my own FIXME...
 485     if (StringTableEntry > 999999)
 486       report_fatal_error("COFF string table is greater than 999999 bytes.");
 487
 488     std::sprintf(S.Header.Name, "/%d", unsigned(StringTableEntry));
 489   } else
 490     std::memcpy(S.Header.Name, S.Name.c_str(), S.Name.size());
 491
 492   S.Number = Number;
 493   S.Symbol->Data.SectionNumber = S.Number;
 494   S.Symbol->Aux[0].Aux.SectionDefinition.Number = S.Number;
 495 }
 496
 497 void WinCOFFObjectWriter::MakeSymbolReal(COFFSymbol &S, size_t Index) {
 498   if (S.Name.size() > COFF::NameSize) {
 499     size_t StringTableEntry = Strings.insert(S.Name.c_str());
 500
 501     S.set_name_offset(StringTableEntry);
 502   } else
 503     std::memcpy(S.Data.Name, S.Name.c_str(), S.Name.size());
 504   S.Index = Index;
 505 }
 506
 507 bool WinCOFFObjectWriter::ExportSection(COFFSection const *S) {
 508   return !S->MCData->getFragmentList().empty();
 509 }
 510
 511 bool WinCOFFObjectWriter::ExportSymbol(MCSymbolData const &SymbolData,
 512                                        MCAssembler &Asm) {
 513   // This doesn't seem to be right. Strings referred to from the .data section
 514   // need symbols so they can be linked to code in the .text section right?
 515
 516   // return Asm.isSymbolLinkerVisible (&SymbolData);
 517
 518   // For now, all non-variable symbols are exported,
 519   // the linker will sort the rest out for us.
 520   return SymbolData.isExternal() || !SymbolData.getSymbol().isVariable();
 521 }
 522
 523 bool WinCOFFObjectWriter::IsPhysicalSection(COFFSection *S) {
 524   return (S->Header.Characteristics
 525          & COFF::IMAGE_SCN_CNT_UNINITIALIZED_DATA) == 0;
 526 }
 527
 528 //------------------------------------------------------------------------------
 529 // entity writing methods
 530
 531 void WinCOFFObjectWriter::WriteFileHeader(const COFF::header &Header) {
 532   WriteLE16(Header.Machine);
 533   WriteLE16(Header.NumberOfSections);
 534   WriteLE32(Header.TimeDateStamp);
 535   WriteLE32(Header.PointerToSymbolTable);
 536   WriteLE32(Header.NumberOfSymbols);
 537   WriteLE16(Header.SizeOfOptionalHeader);
 538   WriteLE16(Header.Characteristics);
 539 }
 540
 541 void WinCOFFObjectWriter::WriteSymbol(const COFFSymbol *S) {
 542   WriteBytes(StringRef(S->Data.Name, COFF::NameSize));
 543   WriteLE32(S->Data.Value);
 544   WriteLE16(S->Data.SectionNumber);
 545   WriteLE16(S->Data.Type);
 546   Write8(S->Data.StorageClass);
 547   Write8(S->Data.NumberOfAuxSymbols);
 548   WriteAuxiliarySymbols(S->Aux);
 549 }
 550
 551 void WinCOFFObjectWriter::WriteAuxiliarySymbols(
 552                                         const COFFSymbol::AuxiliarySymbols &S) {
 553   for(COFFSymbol::AuxiliarySymbols::const_iterator i = S.begin(), e = S.end();
 554       i != e; ++i) {
 555     switch(i->AuxType) {
 556     case ATFunctionDefinition:
 557       WriteLE32(i->Aux.FunctionDefinition.TagIndex);
 558       WriteLE32(i->Aux.FunctionDefinition.TotalSize);
 559       WriteLE32(i->Aux.FunctionDefinition.PointerToLinenumber);
 560       WriteLE32(i->Aux.FunctionDefinition.PointerToNextFunction);
 561       WriteZeros(sizeof(i->Aux.FunctionDefinition.unused));
 562       break;
 563     case ATbfAndefSymbol:
 564       WriteZeros(sizeof(i->Aux.bfAndefSymbol.unused1));
 565       WriteLE16(i->Aux.bfAndefSymbol.Linenumber);
 566       WriteZeros(sizeof(i->Aux.bfAndefSymbol.unused2));
 567       WriteLE32(i->Aux.bfAndefSymbol.PointerToNextFunction);
 568       WriteZeros(sizeof(i->Aux.bfAndefSymbol.unused3));
 569       break;
 570     case ATWeakExternal:
 571       WriteLE32(i->Aux.WeakExternal.TagIndex);
 572       WriteLE32(i->Aux.WeakExternal.Characteristics);
 573       WriteZeros(sizeof(i->Aux.WeakExternal.unused));
 574       break;
 575     case ATFile:
 576       WriteBytes(StringRef(reinterpret_cast<const char *>(i->Aux.File.FileName),
 577                  sizeof(i->Aux.File.FileName)));
 578       break;
 579     case ATSectionDefinition:
 580       WriteLE32(i->Aux.SectionDefinition.Length);
 581       WriteLE16(i->Aux.SectionDefinition.NumberOfRelocations);
 582       WriteLE16(i->Aux.SectionDefinition.NumberOfLinenumbers);
 583       WriteLE32(i->Aux.SectionDefinition.CheckSum);
 584       WriteLE16(i->Aux.SectionDefinition.Number);
 585       Write8(i->Aux.SectionDefinition.Selection);
 586       WriteZeros(sizeof(i->Aux.SectionDefinition.unused));
 587       break;
 588     }
 589   }
 590 }
 591
 592 void WinCOFFObjectWriter::WriteSectionHeader(const COFF::section &S) {
 593   WriteBytes(StringRef(S.Name, COFF::NameSize));
 594
 595   WriteLE32(S.VirtualSize);
 596   WriteLE32(S.VirtualAddress);
 597   WriteLE32(S.SizeOfRawData);
 598   WriteLE32(S.PointerToRawData);
 599   WriteLE32(S.PointerToRelocations);
 600   WriteLE32(S.PointerToLineNumbers);
 601   WriteLE16(S.NumberOfRelocations);
 602   WriteLE16(S.NumberOfLineNumbers);
 603   WriteLE32(S.Characteristics);
 604 }
 605
 606 void WinCOFFObjectWriter::WriteRelocation(const COFF::relocation &R) {
 607   WriteLE32(R.VirtualAddress);
 608   WriteLE32(R.SymbolTableIndex);
 609   WriteLE16(R.Type);
 610 }
 611
 612 ////////////////////////////////////////////////////////////////////////////////
 613 // MCObjectWriter interface implementations
 614
 615 void WinCOFFObjectWriter::ExecutePostLayoutBinding(MCAssembler &Asm,
 616                                                    const MCAsmLayout &Layout) {
 617   // "Define" each section & symbol. This creates section & symbol
 618   // entries in the staging area.
 619
 620   for (MCAssembler::const_iterator i = Asm.begin(), e = Asm.end(); i != e; i++)
 621     DefineSection(*i);
 622
 623   for (MCAssembler::const_symbol_iterator i = Asm.symbol_begin(),
 624                                           e = Asm.symbol_end(); i != e; i++) {
 625     if (ExportSymbol(*i, Asm))
 626       DefineSymbol(*i, Asm);
 627   }
 628 }
 629
 630 void WinCOFFObjectWriter::RecordRelocation(const MCAssembler &Asm,
 631                                            const MCAsmLayout &Layout,
 632                                            const MCFragment *Fragment,
 633                                            const MCFixup &Fixup,
 634                                            MCValue Target,
 635                                            uint64_t &FixedValue) {
 636   assert(Target.getSymA() != NULL && "Relocation must reference a symbol!");
 637
 638   const MCSymbol *A = &Target.getSymA()->getSymbol();
 639   MCSymbolData &A_SD = Asm.getSymbolData(*A);
 640
 641   MCSectionData const *SectionData = Fragment->getParent();
 642
 643   // Mark this symbol as requiring an entry in the symbol table.
 644   assert(SectionMap.find(&SectionData->getSection()) != SectionMap.end() &&
 645          "Section must already have been defined in ExecutePostLayoutBinding!");
 646   assert(SymbolMap.find(&A_SD.getSymbol()) != SymbolMap.end() &&
 647          "Symbol must already have been defined in ExecutePostLayoutBinding!");
 648
 649   COFFSection *coff_section = SectionMap[&SectionData->getSection()];
 650   COFFSymbol *coff_symbol = SymbolMap[&A_SD.getSymbol()];
 651   const MCSymbolRefExpr *SymA = Target.getSymA();
 652   const MCSymbolRefExpr *SymB = Target.getSymB();
 653   const bool CrossSection = SymB &&
 654     &SymA->getSymbol().getSection() != &SymB->getSymbol().getSection();
 655
 656   if (Target.getSymB()) {
 657     const MCSymbol *B = &Target.getSymB()->getSymbol();
 658     MCSymbolData &B_SD = Asm.getSymbolData(*B);
 659
 660     // Offset of the symbol in the section
 661     int64_t a = Layout.getSymbolOffset(&B_SD);
 662
 663     // Ofeset of the relocation in the section
 664     int64_t b = Layout.getFragmentOffset(Fragment) + Fixup.getOffset();
 665
 666     FixedValue = b - a;
 667     // In the case where we have SymbA and SymB, we just need to store the delta
 668     // between the two symbols.  Update FixedValue to account for the delta, and
 669     // skip recording the relocation.
 670     if (!CrossSection)
 671       return;
 672   } else {
 673     FixedValue = Target.getConstant();
 674   }
 675
 676   COFFRelocation Reloc;
 677
 678   Reloc.Data.SymbolTableIndex = 0;
 679   Reloc.Data.VirtualAddress = Layout.getFragmentOffset(Fragment);
 680
 681   // Turn relocations for temporary symbols into section relocations.
 682   if (coff_symbol->MCData->getSymbol().isTemporary() || CrossSection) {
 683     Reloc.Symb = coff_symbol->Section->Symbol;
 684     FixedValue += Layout.getFragmentOffset(coff_symbol->MCData->Fragment)
 685                 + coff_symbol->MCData->getOffset();
 686   } else
 687     Reloc.Symb = coff_symbol;
 688
 689   ++Reloc.Symb->Relocations;
 690
 691   Reloc.Data.VirtualAddress += Fixup.getOffset();
 692
 693   unsigned FixupKind = Fixup.getKind();
 694
 695   if (CrossSection)
 696     FixupKind = FK_PCRel_4;
 697
 698   switch (FixupKind) {
 699   case FK_PCRel_4:
 700   case X86::reloc_riprel_4byte:
 701   case X86::reloc_riprel_4byte_movq_load:
 702     Reloc.Data.Type = Is64Bit ? COFF::IMAGE_REL_AMD64_REL32
 703                               : COFF::IMAGE_REL_I386_REL32;
 704     // FIXME: Can anyone explain what this does other than adjust for the size
 705     // of the offset?
 706     FixedValue += 4;
 707     break;
 708   case FK_Data_4:
 709   case X86::reloc_signed_4byte:
 710     Reloc.Data.Type = Is64Bit ? COFF::IMAGE_REL_AMD64_ADDR32
 711                               : COFF::IMAGE_REL_I386_DIR32;
 712     break;
 713   case FK_Data_8:
 714     if (Is64Bit)
 715       Reloc.Data.Type = COFF::IMAGE_REL_AMD64_ADDR64;
 716     else
 717       llvm_unreachable("unsupported relocation type");
 718     break;
 719   case X86::reloc_coff_secrel32:
 720     Reloc.Data.Type = Is64Bit ? COFF::IMAGE_REL_AMD64_SREL32
 721                               : COFF::IMAGE_REL_I386_SECREL;
 722     break;
 723   default:
 724     llvm_unreachable("unsupported relocation type");
 725   }
 726
 727   coff_section->Relocations.push_back(Reloc);
 728 }
 729
 730 void WinCOFFObjectWriter::WriteObject(MCAssembler &Asm,
 731                                       const MCAsmLayout &Layout) {
 732   // Assign symbol and section indexes and offsets.
 733   Header.NumberOfSections = 0;
 734
 735   for (sections::iterator i = Sections.begin(),
 736                           e = Sections.end(); i != e; i++) {
 737     if (Layout.getSectionAddressSize((*i)->MCData) > 0) {
 738       MakeSectionReal(**i, ++Header.NumberOfSections);
 739     } else {
 740       (*i)->Number = -1;
 741     }
 742   }
 743
 744   Header.NumberOfSymbols = 0;
 745
 746   for (symbols::iterator i = Symbols.begin(), e = Symbols.end(); i != e; i++) {
 747     COFFSymbol *coff_symbol = *i;
 748     MCSymbolData const *SymbolData = coff_symbol->MCData;
 749
 750     // Update section number & offset for symbols that have them.
 751     if ((SymbolData != NULL) && (SymbolData->Fragment != NULL)) {
 752       assert(coff_symbol->Section != NULL);
 753
 754       coff_symbol->Data.SectionNumber = coff_symbol->Section->Number;
 755       coff_symbol->Data.Value = Layout.getFragmentOffset(SymbolData->Fragment)
 756                               + SymbolData->Offset;
 757     }
 758
 759     if (coff_symbol->should_keep()) {
 760       MakeSymbolReal(*coff_symbol, Header.NumberOfSymbols++);
 761
 762       // Update auxiliary symbol info.
 763       coff_symbol->Data.NumberOfAuxSymbols = coff_symbol->Aux.size();
 764       Header.NumberOfSymbols += coff_symbol->Data.NumberOfAuxSymbols;
 765     } else
 766       coff_symbol->Index = -1;
 767   }
 768
 769   // Fixup weak external references.
 770   for (symbols::iterator i = Symbols.begin(), e = Symbols.end(); i != e; i++) {
 771     COFFSymbol *coff_symbol = *i;
 772     if (coff_symbol->Other != NULL) {
 773       assert(coff_symbol->Index != -1);
 774       assert(coff_symbol->Aux.size() == 1 &&
 775              "Symbol must contain one aux symbol!");
 776       assert(coff_symbol->Aux[0].AuxType == ATWeakExternal &&
 777              "Symbol's aux symbol must be a Weak External!");
 778       coff_symbol->Aux[0].Aux.WeakExternal.TagIndex = coff_symbol->Other->Index;
 779     }
 780   }
 781
 782   // Assign file offsets to COFF object file structures.
 783
 784   unsigned offset = 0;
 785
 786   offset += COFF::HeaderSize;
 787   offset += COFF::SectionSize * Header.NumberOfSections;
 788
 789   for (MCAssembler::const_iterator i = Asm.begin(),
 790                                    e = Asm.end();
 791                                    i != e; i++) {
 792     COFFSection *Sec = SectionMap[&i->getSection()];
 793
 794     if (Sec->Number == -1)
 795       continue;
 796
 797     Sec->Header.SizeOfRawData = Layout.getSectionAddressSize(i);
 798
 799     if (IsPhysicalSection(Sec)) {
 800       Sec->Header.PointerToRawData = offset;
 801
 802       offset += Sec->Header.SizeOfRawData;
 803     }
 804
 805     if (Sec->Relocations.size() > 0) {
 806       Sec->Header.NumberOfRelocations = Sec->Relocations.size();
 807       Sec->Header.PointerToRelocations = offset;
 808
 809       offset += COFF::RelocationSize * Sec->Relocations.size();
 810
 811       for (relocations::iterator cr = Sec->Relocations.begin(),
 812                                  er = Sec->Relocations.end();
 813                                  cr != er; ++cr) {
 814         assert((*cr).Symb->Index != -1);
 815         (*cr).Data.SymbolTableIndex = (*cr).Symb->Index;
 816       }
 817     }
 818
 819     assert(Sec->Symbol->Aux.size() == 1
 820       && "Section's symbol must have one aux!");
 821     AuxSymbol &Aux = Sec->Symbol->Aux[0];
 822     assert(Aux.AuxType == ATSectionDefinition &&
 823            "Section's symbol's aux symbol must be a Section Definition!");
 824     Aux.Aux.SectionDefinition.Length = Sec->Header.SizeOfRawData;
 825     Aux.Aux.SectionDefinition.NumberOfRelocations =
 826                                                 Sec->Header.NumberOfRelocations;
 827     Aux.Aux.SectionDefinition.NumberOfLinenumbers =
 828                                                 Sec->Header.NumberOfLineNumbers;
 829   }
 830
 831   Header.PointerToSymbolTable = offset;
 832
 833   Header.TimeDateStamp = sys::TimeValue::now().toEpochTime();
 834
 835   // Write it all to disk...
 836   WriteFileHeader(Header);
 837
 838   {
 839     sections::iterator i, ie;
 840     MCAssembler::const_iterator j, je;
 841
 842     for (i = Sections.begin(), ie = Sections.end(); i != ie; i++)
 843       if ((*i)->Number != -1)
 844         WriteSectionHeader((*i)->Header);
 845
 846     for (i = Sections.begin(), ie = Sections.end(),
 847          j = Asm.begin(), je = Asm.end();
 848          (i != ie) && (j != je); ++i, ++j) {
 849
 850       if ((*i)->Number == -1)
 851         continue;
 852
 853       if ((*i)->Header.PointerToRawData != 0) {
 854         assert(OS.tell() == (*i)->Header.PointerToRawData &&
 855                "Section::PointerToRawData is insane!");
 856
 857         Asm.writeSectionData(j, Layout);
 858       }
 859
 860       if ((*i)->Relocations.size() > 0) {
 861         assert(OS.tell() == (*i)->Header.PointerToRelocations &&
 862                "Section::PointerToRelocations is insane!");
 863
 864         for (relocations::const_iterator k = (*i)->Relocations.begin(),
 865                                                ke = (*i)->Relocations.end();
 866                                                k != ke; k++) {
 867           WriteRelocation(k->Data);
 868         }
 869       } else
 870         assert((*i)->Header.PointerToRelocations == 0 &&
 871                "Section::PointerToRelocations is insane!");
 872     }
 873   }
 874
 875   assert(OS.tell() == Header.PointerToSymbolTable &&
 876          "Header::PointerToSymbolTable is insane!");
 877
 878   for (symbols::iterator i = Symbols.begin(), e = Symbols.end(); i != e; i++)
 879     if ((*i)->Index != -1)
 880       WriteSymbol(*i);
 881
 882   OS.write((char const *)&Strings.Data.front(), Strings.Data.size());
 883 }
 884
 885 //------------------------------------------------------------------------------
 886 // WinCOFFObjectWriter factory function
 887
 888 namespace llvm {
 889   MCObjectWriter *createWinCOFFObjectWriter(raw_ostream &OS, bool is64Bit) {
 890     return new WinCOFFObjectWriter(OS, is64Bit);
 891   }
 892 }