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