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