lib/MC/WinCOFFObjectWriter.cpp

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