1 //===-- llvm/MC/WinCOFFObjectWriter.cpp -------------------------*- C++ -*-===//
3 // The LLVM Compiler Infrastructure
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
10 // This file contains an implementation of a Win32 COFF object file writer.
12 //===----------------------------------------------------------------------===//
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"
39 #define DEBUG_TYPE "WinCOFFObjectWriter"
42 typedef SmallString<COFF::NameSize> name;
53 AuxiliaryType AuxType;
64 typedef SmallVector<AuxSymbol, 1> AuxiliarySymbols;
73 MCSymbolData const *MCData;
75 COFFSymbol(StringRef name);
76 void set_name_offset(uint32_t Offset);
78 bool should_keep() const;
81 // This class contains staging data for a COFF relocation entry.
82 struct COFFRelocation {
83 COFF::relocation Data;
86 COFFRelocation() : Symb(nullptr) {}
87 static size_t size() { return COFF::RelocationSize; }
90 typedef std::vector<COFFRelocation> relocations;
98 MCSectionData const *MCData;
100 relocations Relocations;
102 COFFSection(StringRef name);
103 static size_t size();
106 class WinCOFFObjectWriter : public MCObjectWriter {
109 typedef std::vector<std::unique_ptr<COFFSymbol>> symbols;
110 typedef std::vector<std::unique_ptr<COFFSection>> sections;
112 typedef DenseMap<MCSymbol const *, COFFSymbol *> symbol_map;
113 typedef DenseMap<MCSection const *, COFFSection *> section_map;
115 std::unique_ptr<MCWinCOFFObjectTargetWriter> TargetObjectWriter;
117 // Root level file contents.
121 StringTableBuilder Strings;
123 // Maps used during object file creation.
124 section_map SectionMap;
125 symbol_map SymbolMap;
129 WinCOFFObjectWriter(MCWinCOFFObjectTargetWriter *MOTW, raw_pwrite_stream &OS);
131 void reset() override {
132 memset(&Header, 0, sizeof(Header));
133 Header.Machine = TargetObjectWriter->getMachine();
139 MCObjectWriter::reset();
142 COFFSymbol *createSymbol(StringRef Name);
143 COFFSymbol *GetOrCreateCOFFSymbol(const MCSymbol * Symbol);
144 COFFSection *createSection(StringRef Name);
146 template <typename object_t, typename list_t>
147 object_t *createCOFFEntity(StringRef Name, list_t &List);
149 void DefineSection(MCSectionData const &SectionData);
150 void DefineSymbol(MCSymbolData const &SymbolData, MCAssembler &Assembler,
151 const MCAsmLayout &Layout);
153 void SetSymbolName(COFFSymbol &S);
154 void SetSectionName(COFFSection &S);
156 bool ExportSymbol(const MCSymbol &Symbol, MCAssembler &Asm);
158 bool IsPhysicalSection(COFFSection *S);
160 // Entity writing methods.
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);
168 // MCObjectWriter interface implementation.
170 void ExecutePostLayoutBinding(MCAssembler &Asm,
171 const MCAsmLayout &Layout) override;
173 bool IsSymbolRefDifferenceFullyResolvedImpl(const MCAssembler &Asm,
174 const MCSymbolData &DataA,
175 const MCFragment &FB, bool InSet,
176 bool IsPCRel) const override;
178 bool isWeak(const MCSymbolData &SD) const override;
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;
185 void WriteObject(MCAssembler &Asm, const MCAsmLayout &Layout) override;
189 static inline void write_uint32_le(void *Data, uint32_t Value) {
190 support::endian::write<uint32_t, support::little, support::unaligned>(Data,
194 //------------------------------------------------------------------------------
195 // Symbol class implementation
197 COFFSymbol::COFFSymbol(StringRef name)
198 : Name(name.begin(), name.end())
203 memset(&Data, 0, sizeof(Data));
206 // In the case that the name does not fit within 8 bytes, the offset
207 // into the string table is stored in the last 4 bytes instead, leaving
208 // the first 4 bytes as 0.
209 void COFFSymbol::set_name_offset(uint32_t Offset) {
210 write_uint32_le(Data.Name + 0, 0);
211 write_uint32_le(Data.Name + 4, Offset);
214 /// logic to decide if the symbol should be reported in the symbol table
215 bool COFFSymbol::should_keep() const {
216 // no section means its external, keep it
220 // if it has relocations pointing at it, keep it
221 if (Relocations > 0) {
222 assert(Section->Number != -1 && "Sections with relocations must be real!");
226 // if the section its in is being droped, drop it
227 if (Section->Number == -1)
230 // if it is the section symbol, keep it
231 if (Section->Symbol == this)
234 // if its temporary, drop it
235 if (MCData && MCData->getSymbol().isTemporary())
238 // otherwise, keep it
242 //------------------------------------------------------------------------------
243 // Section class implementation
245 COFFSection::COFFSection(StringRef name)
249 memset(&Header, 0, sizeof(Header));
252 size_t COFFSection::size() {
253 return COFF::SectionSize;
256 //------------------------------------------------------------------------------
257 // WinCOFFObjectWriter class implementation
259 WinCOFFObjectWriter::WinCOFFObjectWriter(MCWinCOFFObjectTargetWriter *MOTW,
260 raw_pwrite_stream &OS)
261 : MCObjectWriter(OS, true), TargetObjectWriter(MOTW) {
262 memset(&Header, 0, sizeof(Header));
264 Header.Machine = TargetObjectWriter->getMachine();
267 COFFSymbol *WinCOFFObjectWriter::createSymbol(StringRef Name) {
268 return createCOFFEntity<COFFSymbol>(Name, Symbols);
271 COFFSymbol *WinCOFFObjectWriter::GetOrCreateCOFFSymbol(const MCSymbol *Symbol) {
272 symbol_map::iterator i = SymbolMap.find(Symbol);
273 if (i != SymbolMap.end())
275 COFFSymbol *RetSymbol =
276 createCOFFEntity<COFFSymbol>(Symbol->getName(), Symbols);
277 SymbolMap[Symbol] = RetSymbol;
281 COFFSection *WinCOFFObjectWriter::createSection(StringRef Name) {
282 return createCOFFEntity<COFFSection>(Name, Sections);
285 /// A template used to lookup or create a symbol/section, and initialize it if
287 template <typename object_t, typename list_t>
288 object_t *WinCOFFObjectWriter::createCOFFEntity(StringRef Name,
290 List.push_back(make_unique<object_t>(Name));
292 return List.back().get();
295 /// This function takes a section data object from the assembler
296 /// and creates the associated COFF section staging object.
297 void WinCOFFObjectWriter::DefineSection(MCSectionData const &SectionData) {
298 assert(SectionData.getSection().getVariant() == MCSection::SV_COFF
299 && "Got non-COFF section in the COFF backend!");
300 // FIXME: Not sure how to verify this (at least in a debug build).
301 MCSectionCOFF const &Sec =
302 static_cast<MCSectionCOFF const &>(SectionData.getSection());
304 COFFSection *coff_section = createSection(Sec.getSectionName());
305 COFFSymbol *coff_symbol = createSymbol(Sec.getSectionName());
306 if (Sec.getSelection() != COFF::IMAGE_COMDAT_SELECT_ASSOCIATIVE) {
307 if (const MCSymbol *S = Sec.getCOMDATSymbol()) {
308 COFFSymbol *COMDATSymbol = GetOrCreateCOFFSymbol(S);
309 if (COMDATSymbol->Section)
310 report_fatal_error("two sections have the same comdat");
311 COMDATSymbol->Section = coff_section;
315 coff_section->Symbol = coff_symbol;
316 coff_symbol->Section = coff_section;
317 coff_symbol->Data.StorageClass = COFF::IMAGE_SYM_CLASS_STATIC;
319 // In this case the auxiliary symbol is a Section Definition.
320 coff_symbol->Aux.resize(1);
321 memset(&coff_symbol->Aux[0], 0, sizeof(coff_symbol->Aux[0]));
322 coff_symbol->Aux[0].AuxType = ATSectionDefinition;
323 coff_symbol->Aux[0].Aux.SectionDefinition.Selection = Sec.getSelection();
325 coff_section->Header.Characteristics = Sec.getCharacteristics();
327 uint32_t &Characteristics = coff_section->Header.Characteristics;
328 switch (SectionData.getAlignment()) {
329 case 1: Characteristics |= COFF::IMAGE_SCN_ALIGN_1BYTES; break;
330 case 2: Characteristics |= COFF::IMAGE_SCN_ALIGN_2BYTES; break;
331 case 4: Characteristics |= COFF::IMAGE_SCN_ALIGN_4BYTES; break;
332 case 8: Characteristics |= COFF::IMAGE_SCN_ALIGN_8BYTES; break;
333 case 16: Characteristics |= COFF::IMAGE_SCN_ALIGN_16BYTES; break;
334 case 32: Characteristics |= COFF::IMAGE_SCN_ALIGN_32BYTES; break;
335 case 64: Characteristics |= COFF::IMAGE_SCN_ALIGN_64BYTES; break;
336 case 128: Characteristics |= COFF::IMAGE_SCN_ALIGN_128BYTES; break;
337 case 256: Characteristics |= COFF::IMAGE_SCN_ALIGN_256BYTES; break;
338 case 512: Characteristics |= COFF::IMAGE_SCN_ALIGN_512BYTES; break;
339 case 1024: Characteristics |= COFF::IMAGE_SCN_ALIGN_1024BYTES; break;
340 case 2048: Characteristics |= COFF::IMAGE_SCN_ALIGN_2048BYTES; break;
341 case 4096: Characteristics |= COFF::IMAGE_SCN_ALIGN_4096BYTES; break;
342 case 8192: Characteristics |= COFF::IMAGE_SCN_ALIGN_8192BYTES; break;
344 llvm_unreachable("unsupported section alignment");
347 // Bind internal COFF section to MC section.
348 coff_section->MCData = &SectionData;
349 SectionMap[&SectionData.getSection()] = coff_section;
352 static uint64_t getSymbolValue(const MCSymbolData &Data,
353 const MCAsmLayout &Layout) {
354 if (Data.isCommon() && Data.isExternal())
355 return Data.getCommonSize();
358 if (!Layout.getSymbolOffset(&Data, Res))
364 /// This function takes a symbol data object from the assembler
365 /// and creates the associated COFF symbol staging object.
366 void WinCOFFObjectWriter::DefineSymbol(MCSymbolData const &SymbolData,
367 MCAssembler &Assembler,
368 const MCAsmLayout &Layout) {
369 MCSymbol const &Symbol = SymbolData.getSymbol();
370 COFFSymbol *coff_symbol = GetOrCreateCOFFSymbol(&Symbol);
371 SymbolMap[&Symbol] = coff_symbol;
373 if (SymbolData.getFlags() & COFF::SF_WeakExternal) {
374 coff_symbol->Data.StorageClass = COFF::IMAGE_SYM_CLASS_WEAK_EXTERNAL;
376 if (Symbol.isVariable()) {
377 const MCSymbolRefExpr *SymRef =
378 dyn_cast<MCSymbolRefExpr>(Symbol.getVariableValue());
381 report_fatal_error("Weak externals may only alias symbols");
383 coff_symbol->Other = GetOrCreateCOFFSymbol(&SymRef->getSymbol());
385 std::string WeakName = (".weak." + Symbol.getName() + ".default").str();
386 COFFSymbol *WeakDefault = createSymbol(WeakName);
387 WeakDefault->Data.SectionNumber = COFF::IMAGE_SYM_ABSOLUTE;
388 WeakDefault->Data.StorageClass = COFF::IMAGE_SYM_CLASS_EXTERNAL;
389 WeakDefault->Data.Type = 0;
390 WeakDefault->Data.Value = 0;
391 coff_symbol->Other = WeakDefault;
394 // Setup the Weak External auxiliary symbol.
395 coff_symbol->Aux.resize(1);
396 memset(&coff_symbol->Aux[0], 0, sizeof(coff_symbol->Aux[0]));
397 coff_symbol->Aux[0].AuxType = ATWeakExternal;
398 coff_symbol->Aux[0].Aux.WeakExternal.TagIndex = 0;
399 coff_symbol->Aux[0].Aux.WeakExternal.Characteristics =
400 COFF::IMAGE_WEAK_EXTERN_SEARCH_LIBRARY;
402 coff_symbol->MCData = &SymbolData;
404 const MCSymbolData &ResSymData = Assembler.getSymbolData(Symbol);
405 const MCSymbol *Base = Layout.getBaseSymbol(Symbol);
406 coff_symbol->Data.Value = getSymbolValue(ResSymData, Layout);
408 coff_symbol->Data.Type = (ResSymData.getFlags() & 0x0000FFFF) >> 0;
409 coff_symbol->Data.StorageClass = (ResSymData.getFlags() & 0x00FF0000) >> 16;
411 // If no storage class was specified in the streamer, define it here.
412 if (coff_symbol->Data.StorageClass == 0) {
414 ResSymData.isExternal() ||
415 (!ResSymData.getFragment() && !ResSymData.getSymbol().isVariable());
417 coff_symbol->Data.StorageClass = IsExternal
418 ? COFF::IMAGE_SYM_CLASS_EXTERNAL
419 : COFF::IMAGE_SYM_CLASS_STATIC;
423 coff_symbol->Data.SectionNumber = COFF::IMAGE_SYM_ABSOLUTE;
425 const MCSymbolData &BaseData = Assembler.getSymbolData(*Base);
426 if (BaseData.getFragment()) {
428 SectionMap[&BaseData.getFragment()->getParent()->getSection()];
430 if (coff_symbol->Section && coff_symbol->Section != Sec)
431 report_fatal_error("conflicting sections for symbol");
433 coff_symbol->Section = Sec;
437 coff_symbol->MCData = &ResSymData;
441 // Maximum offsets for different string table entry encodings.
442 static const unsigned Max6DecimalOffset = 999999;
443 static const unsigned Max7DecimalOffset = 9999999;
444 static const uint64_t MaxBase64Offset = 0xFFFFFFFFFULL; // 64^6, including 0
446 // Encode a string table entry offset in base 64, padded to 6 chars, and
447 // prefixed with a double slash: '//AAAAAA', '//AAAAAB', ...
448 // Buffer must be at least 8 bytes large. No terminating null appended.
449 static void encodeBase64StringEntry(char* Buffer, uint64_t Value) {
450 assert(Value > Max7DecimalOffset && Value <= MaxBase64Offset &&
451 "Illegal section name encoding for value");
453 static const char Alphabet[] = "ABCDEFGHIJKLMNOPQRSTUVWXYZ"
454 "abcdefghijklmnopqrstuvwxyz"
460 char* Ptr = Buffer + 7;
461 for (unsigned i = 0; i < 6; ++i) {
462 unsigned Rem = Value % 64;
464 *(Ptr--) = Alphabet[Rem];
468 void WinCOFFObjectWriter::SetSectionName(COFFSection &S) {
469 if (S.Name.size() > COFF::NameSize) {
470 uint64_t StringTableEntry = Strings.getOffset(S.Name);
472 if (StringTableEntry <= Max6DecimalOffset) {
473 std::sprintf(S.Header.Name, "/%d", unsigned(StringTableEntry));
474 } else if (StringTableEntry <= Max7DecimalOffset) {
475 // With seven digits, we have to skip the terminating null. Because
476 // sprintf always appends it, we use a larger temporary buffer.
477 char buffer[9] = { };
478 std::sprintf(buffer, "/%d", unsigned(StringTableEntry));
479 std::memcpy(S.Header.Name, buffer, 8);
480 } else if (StringTableEntry <= MaxBase64Offset) {
481 // Starting with 10,000,000, offsets are encoded as base64.
482 encodeBase64StringEntry(S.Header.Name, StringTableEntry);
484 report_fatal_error("COFF string table is greater than 64 GB.");
487 std::memcpy(S.Header.Name, S.Name.c_str(), S.Name.size());
490 void WinCOFFObjectWriter::SetSymbolName(COFFSymbol &S) {
491 if (S.Name.size() > COFF::NameSize)
492 S.set_name_offset(Strings.getOffset(S.Name));
494 std::memcpy(S.Data.Name, S.Name.c_str(), S.Name.size());
497 bool WinCOFFObjectWriter::ExportSymbol(const MCSymbol &Symbol,
499 // This doesn't seem to be right. Strings referred to from the .data section
500 // need symbols so they can be linked to code in the .text section right?
502 // return Asm.isSymbolLinkerVisible(Symbol);
504 // Non-temporary labels should always be visible to the linker.
505 if (!Symbol.isTemporary())
508 // Absolute temporary labels are never visible.
509 if (!Symbol.isInSection())
512 // For now, all non-variable symbols are exported,
513 // the linker will sort the rest out for us.
514 return !Symbol.isVariable();
517 bool WinCOFFObjectWriter::IsPhysicalSection(COFFSection *S) {
518 return (S->Header.Characteristics
519 & COFF::IMAGE_SCN_CNT_UNINITIALIZED_DATA) == 0;
522 //------------------------------------------------------------------------------
523 // entity writing methods
525 void WinCOFFObjectWriter::WriteFileHeader(const COFF::header &Header) {
527 WriteLE16(COFF::IMAGE_FILE_MACHINE_UNKNOWN);
529 WriteLE16(COFF::BigObjHeader::MinBigObjectVersion);
530 WriteLE16(Header.Machine);
531 WriteLE32(Header.TimeDateStamp);
532 WriteBytes(StringRef(COFF::BigObjMagic, sizeof(COFF::BigObjMagic)));
537 WriteLE32(Header.NumberOfSections);
538 WriteLE32(Header.PointerToSymbolTable);
539 WriteLE32(Header.NumberOfSymbols);
541 WriteLE16(Header.Machine);
542 WriteLE16(static_cast<int16_t>(Header.NumberOfSections));
543 WriteLE32(Header.TimeDateStamp);
544 WriteLE32(Header.PointerToSymbolTable);
545 WriteLE32(Header.NumberOfSymbols);
546 WriteLE16(Header.SizeOfOptionalHeader);
547 WriteLE16(Header.Characteristics);
551 void WinCOFFObjectWriter::WriteSymbol(const COFFSymbol &S) {
552 WriteBytes(StringRef(S.Data.Name, COFF::NameSize));
553 WriteLE32(S.Data.Value);
555 WriteLE32(S.Data.SectionNumber);
557 WriteLE16(static_cast<int16_t>(S.Data.SectionNumber));
558 WriteLE16(S.Data.Type);
559 Write8(S.Data.StorageClass);
560 Write8(S.Data.NumberOfAuxSymbols);
561 WriteAuxiliarySymbols(S.Aux);
564 void WinCOFFObjectWriter::WriteAuxiliarySymbols(
565 const COFFSymbol::AuxiliarySymbols &S) {
566 for(COFFSymbol::AuxiliarySymbols::const_iterator i = S.begin(), e = S.end();
569 case ATFunctionDefinition:
570 WriteLE32(i->Aux.FunctionDefinition.TagIndex);
571 WriteLE32(i->Aux.FunctionDefinition.TotalSize);
572 WriteLE32(i->Aux.FunctionDefinition.PointerToLinenumber);
573 WriteLE32(i->Aux.FunctionDefinition.PointerToNextFunction);
574 WriteZeros(sizeof(i->Aux.FunctionDefinition.unused));
576 WriteZeros(COFF::Symbol32Size - COFF::Symbol16Size);
578 case ATbfAndefSymbol:
579 WriteZeros(sizeof(i->Aux.bfAndefSymbol.unused1));
580 WriteLE16(i->Aux.bfAndefSymbol.Linenumber);
581 WriteZeros(sizeof(i->Aux.bfAndefSymbol.unused2));
582 WriteLE32(i->Aux.bfAndefSymbol.PointerToNextFunction);
583 WriteZeros(sizeof(i->Aux.bfAndefSymbol.unused3));
585 WriteZeros(COFF::Symbol32Size - COFF::Symbol16Size);
588 WriteLE32(i->Aux.WeakExternal.TagIndex);
589 WriteLE32(i->Aux.WeakExternal.Characteristics);
590 WriteZeros(sizeof(i->Aux.WeakExternal.unused));
592 WriteZeros(COFF::Symbol32Size - COFF::Symbol16Size);
596 StringRef(reinterpret_cast<const char *>(&i->Aux),
597 UseBigObj ? COFF::Symbol32Size : COFF::Symbol16Size));
599 case ATSectionDefinition:
600 WriteLE32(i->Aux.SectionDefinition.Length);
601 WriteLE16(i->Aux.SectionDefinition.NumberOfRelocations);
602 WriteLE16(i->Aux.SectionDefinition.NumberOfLinenumbers);
603 WriteLE32(i->Aux.SectionDefinition.CheckSum);
604 WriteLE16(static_cast<int16_t>(i->Aux.SectionDefinition.Number));
605 Write8(i->Aux.SectionDefinition.Selection);
606 WriteZeros(sizeof(i->Aux.SectionDefinition.unused));
607 WriteLE16(static_cast<int16_t>(i->Aux.SectionDefinition.Number >> 16));
609 WriteZeros(COFF::Symbol32Size - COFF::Symbol16Size);
615 void WinCOFFObjectWriter::WriteSectionHeader(const COFF::section &S) {
616 WriteBytes(StringRef(S.Name, COFF::NameSize));
618 WriteLE32(S.VirtualSize);
619 WriteLE32(S.VirtualAddress);
620 WriteLE32(S.SizeOfRawData);
621 WriteLE32(S.PointerToRawData);
622 WriteLE32(S.PointerToRelocations);
623 WriteLE32(S.PointerToLineNumbers);
624 WriteLE16(S.NumberOfRelocations);
625 WriteLE16(S.NumberOfLineNumbers);
626 WriteLE32(S.Characteristics);
629 void WinCOFFObjectWriter::WriteRelocation(const COFF::relocation &R) {
630 WriteLE32(R.VirtualAddress);
631 WriteLE32(R.SymbolTableIndex);
635 ////////////////////////////////////////////////////////////////////////////////
636 // MCObjectWriter interface implementations
638 void WinCOFFObjectWriter::ExecutePostLayoutBinding(MCAssembler &Asm,
639 const MCAsmLayout &Layout) {
640 // "Define" each section & symbol. This creates section & symbol
641 // entries in the staging area.
642 for (const auto &Section : Asm)
643 DefineSection(Section);
645 for (MCSymbolData &SD : Asm.symbols())
646 if (ExportSymbol(SD.getSymbol(), Asm))
647 DefineSymbol(SD, Asm, Layout);
650 bool WinCOFFObjectWriter::IsSymbolRefDifferenceFullyResolvedImpl(
651 const MCAssembler &Asm, const MCSymbolData &DataA, const MCFragment &FB,
652 bool InSet, bool IsPCRel) const {
653 // MS LINK expects to be able to replace all references to a function with a
654 // thunk to implement their /INCREMENTAL feature. Make sure we don't optimize
655 // away any relocations to functions.
656 if ((((DataA.getFlags() & COFF::SF_TypeMask) >> COFF::SF_TypeShift) >>
657 COFF::SCT_COMPLEX_TYPE_SHIFT) == COFF::IMAGE_SYM_DTYPE_FUNCTION)
659 return MCObjectWriter::IsSymbolRefDifferenceFullyResolvedImpl(Asm, DataA, FB,
663 bool WinCOFFObjectWriter::isWeak(const MCSymbolData &SD) const {
664 if (!SD.isExternal())
667 const MCSymbol &Sym = SD.getSymbol();
668 if (!Sym.isInSection())
671 const auto &Sec = cast<MCSectionCOFF>(Sym.getSection());
672 if (!Sec.getCOMDATSymbol())
675 // It looks like for COFF it is invalid to replace a reference to a global
676 // in a comdat with a reference to a local.
677 // FIXME: Add a specification reference if available.
681 void WinCOFFObjectWriter::RecordRelocation(
682 MCAssembler &Asm, const MCAsmLayout &Layout, const MCFragment *Fragment,
683 const MCFixup &Fixup, MCValue Target, bool &IsPCRel, uint64_t &FixedValue) {
684 assert(Target.getSymA() && "Relocation must reference a symbol!");
686 const MCSymbol &Symbol = Target.getSymA()->getSymbol();
687 const MCSymbol &A = Symbol;
688 if (!Asm.hasSymbolData(A))
689 Asm.getContext().FatalError(
691 Twine("symbol '") + A.getName() + "' can not be undefined");
693 const MCSymbolData &A_SD = Asm.getSymbolData(A);
695 MCSectionData const *SectionData = Fragment->getParent();
697 // Mark this symbol as requiring an entry in the symbol table.
698 assert(SectionMap.find(&SectionData->getSection()) != SectionMap.end() &&
699 "Section must already have been defined in ExecutePostLayoutBinding!");
700 assert(SymbolMap.find(&A_SD.getSymbol()) != SymbolMap.end() &&
701 "Symbol must already have been defined in ExecutePostLayoutBinding!");
703 COFFSection *coff_section = SectionMap[&SectionData->getSection()];
704 COFFSymbol *coff_symbol = SymbolMap[&A_SD.getSymbol()];
705 const MCSymbolRefExpr *SymB = Target.getSymB();
706 bool CrossSection = false;
709 const MCSymbol *B = &SymB->getSymbol();
710 const MCSymbolData &B_SD = Asm.getSymbolData(*B);
711 if (!B_SD.getFragment())
712 Asm.getContext().FatalError(
714 Twine("symbol '") + B->getName() +
715 "' can not be undefined in a subtraction expression");
717 if (!A_SD.getFragment())
718 Asm.getContext().FatalError(
720 Twine("symbol '") + Symbol.getName() +
721 "' can not be undefined in a subtraction expression");
723 CrossSection = &Symbol.getSection() != &B->getSection();
725 // Offset of the symbol in the section
726 int64_t OffsetOfB = Layout.getSymbolOffset(&B_SD);
728 // In the case where we have SymbA and SymB, we just need to store the delta
729 // between the two symbols. Update FixedValue to account for the delta, and
730 // skip recording the relocation.
732 int64_t OffsetOfA = Layout.getSymbolOffset(&A_SD);
733 FixedValue = (OffsetOfA - OffsetOfB) + Target.getConstant();
737 // Offset of the relocation in the section
738 int64_t OffsetOfRelocation =
739 Layout.getFragmentOffset(Fragment) + Fixup.getOffset();
741 FixedValue = OffsetOfRelocation - OffsetOfB;
743 FixedValue = Target.getConstant();
746 COFFRelocation Reloc;
748 Reloc.Data.SymbolTableIndex = 0;
749 Reloc.Data.VirtualAddress = Layout.getFragmentOffset(Fragment);
751 // Turn relocations for temporary symbols into section relocations.
752 if (coff_symbol->MCData->getSymbol().isTemporary() || CrossSection) {
753 Reloc.Symb = coff_symbol->Section->Symbol;
754 FixedValue += Layout.getFragmentOffset(coff_symbol->MCData->getFragment()) +
755 coff_symbol->MCData->getOffset();
757 Reloc.Symb = coff_symbol;
759 ++Reloc.Symb->Relocations;
761 Reloc.Data.VirtualAddress += Fixup.getOffset();
763 TargetObjectWriter->getRelocType(Target, Fixup, CrossSection,
766 // FIXME: Can anyone explain what this does other than adjust for the size
768 if ((Header.Machine == COFF::IMAGE_FILE_MACHINE_AMD64 &&
769 Reloc.Data.Type == COFF::IMAGE_REL_AMD64_REL32) ||
770 (Header.Machine == COFF::IMAGE_FILE_MACHINE_I386 &&
771 Reloc.Data.Type == COFF::IMAGE_REL_I386_REL32))
774 if (Header.Machine == COFF::IMAGE_FILE_MACHINE_ARMNT) {
775 switch (Reloc.Data.Type) {
776 case COFF::IMAGE_REL_ARM_ABSOLUTE:
777 case COFF::IMAGE_REL_ARM_ADDR32:
778 case COFF::IMAGE_REL_ARM_ADDR32NB:
779 case COFF::IMAGE_REL_ARM_TOKEN:
780 case COFF::IMAGE_REL_ARM_SECTION:
781 case COFF::IMAGE_REL_ARM_SECREL:
783 case COFF::IMAGE_REL_ARM_BRANCH11:
784 case COFF::IMAGE_REL_ARM_BLX11:
785 // IMAGE_REL_ARM_BRANCH11 and IMAGE_REL_ARM_BLX11 are only used for
786 // pre-ARMv7, which implicitly rules it out of ARMNT (it would be valid
788 case COFF::IMAGE_REL_ARM_BRANCH24:
789 case COFF::IMAGE_REL_ARM_BLX24:
790 case COFF::IMAGE_REL_ARM_MOV32A:
791 // IMAGE_REL_ARM_BRANCH24, IMAGE_REL_ARM_BLX24, IMAGE_REL_ARM_MOV32A are
792 // only used for ARM mode code, which is documented as being unsupported
793 // by Windows on ARM. Empirical proof indicates that masm is able to
794 // generate the relocations however the rest of the MSVC toolchain is
795 // unable to handle it.
796 llvm_unreachable("unsupported relocation");
798 case COFF::IMAGE_REL_ARM_MOV32T:
800 case COFF::IMAGE_REL_ARM_BRANCH20T:
801 case COFF::IMAGE_REL_ARM_BRANCH24T:
802 case COFF::IMAGE_REL_ARM_BLX23T:
803 // IMAGE_REL_BRANCH20T, IMAGE_REL_ARM_BRANCH24T, IMAGE_REL_ARM_BLX23T all
804 // perform a 4 byte adjustment to the relocation. Relative branches are
805 // offset by 4 on ARM, however, because there is no RELA relocations, all
806 // branches are offset by 4.
807 FixedValue = FixedValue + 4;
812 if (TargetObjectWriter->recordRelocation(Fixup))
813 coff_section->Relocations.push_back(Reloc);
816 void WinCOFFObjectWriter::WriteObject(MCAssembler &Asm,
817 const MCAsmLayout &Layout) {
818 size_t SectionsSize = Sections.size();
819 if (SectionsSize > static_cast<size_t>(INT32_MAX))
821 "PE COFF object files can't have more than 2147483647 sections");
823 // Assign symbol and section indexes and offsets.
824 int32_t NumberOfSections = static_cast<int32_t>(SectionsSize);
826 UseBigObj = NumberOfSections > COFF::MaxNumberOfSections16;
828 DenseMap<COFFSection *, int32_t> SectionIndices(
829 NextPowerOf2(NumberOfSections));
831 // Assign section numbers.
833 for (const auto &Section : Sections) {
834 SectionIndices[Section.get()] = Number;
835 Section->Number = Number;
836 Section->Symbol->Data.SectionNumber = Number;
837 Section->Symbol->Aux[0].Aux.SectionDefinition.Number = Number;
841 Header.NumberOfSections = NumberOfSections;
842 Header.NumberOfSymbols = 0;
844 for (auto FI = Asm.file_names_begin(), FE = Asm.file_names_end();
846 // round up to calculate the number of auxiliary symbols required
847 unsigned SymbolSize = UseBigObj ? COFF::Symbol32Size : COFF::Symbol16Size;
848 unsigned Count = (FI->size() + SymbolSize - 1) / SymbolSize;
850 COFFSymbol *file = createSymbol(".file");
851 file->Data.SectionNumber = COFF::IMAGE_SYM_DEBUG;
852 file->Data.StorageClass = COFF::IMAGE_SYM_CLASS_FILE;
853 file->Aux.resize(Count);
856 unsigned Length = FI->size();
857 for (auto &Aux : file->Aux) {
858 Aux.AuxType = ATFile;
860 if (Length > SymbolSize) {
861 memcpy(&Aux.Aux, FI->c_str() + Offset, SymbolSize);
862 Length = Length - SymbolSize;
864 memcpy(&Aux.Aux, FI->c_str() + Offset, Length);
865 memset((char *)&Aux.Aux + Length, 0, SymbolSize - Length);
869 Offset += SymbolSize;
873 for (auto &Symbol : Symbols) {
874 // Update section number & offset for symbols that have them.
876 Symbol->Data.SectionNumber = Symbol->Section->Number;
877 if (Symbol->should_keep()) {
878 Symbol->Index = Header.NumberOfSymbols++;
879 // Update auxiliary symbol info.
880 Symbol->Data.NumberOfAuxSymbols = Symbol->Aux.size();
881 Header.NumberOfSymbols += Symbol->Data.NumberOfAuxSymbols;
886 // Build string table.
887 for (const auto &S : Sections)
888 if (S->Name.size() > COFF::NameSize)
889 Strings.add(S->Name);
890 for (const auto &S : Symbols)
891 if (S->should_keep() && S->Name.size() > COFF::NameSize)
892 Strings.add(S->Name);
893 Strings.finalize(StringTableBuilder::WinCOFF);
896 for (const auto &S : Sections)
898 for (auto &S : Symbols)
899 if (S->should_keep())
902 // Fixup weak external references.
903 for (auto &Symbol : Symbols) {
905 assert(Symbol->Index != -1);
906 assert(Symbol->Aux.size() == 1 && "Symbol must contain one aux symbol!");
907 assert(Symbol->Aux[0].AuxType == ATWeakExternal &&
908 "Symbol's aux symbol must be a Weak External!");
909 Symbol->Aux[0].Aux.WeakExternal.TagIndex = Symbol->Other->Index;
913 // Fixup associative COMDAT sections.
914 for (auto &Section : Sections) {
915 if (Section->Symbol->Aux[0].Aux.SectionDefinition.Selection !=
916 COFF::IMAGE_COMDAT_SELECT_ASSOCIATIVE)
919 const MCSectionCOFF &MCSec =
920 static_cast<const MCSectionCOFF &>(Section->MCData->getSection());
922 const MCSymbol *COMDAT = MCSec.getCOMDATSymbol();
924 COFFSymbol *COMDATSymbol = GetOrCreateCOFFSymbol(COMDAT);
925 assert(COMDATSymbol);
926 COFFSection *Assoc = COMDATSymbol->Section;
929 Twine("Missing associated COMDAT section for section ") +
930 MCSec.getSectionName());
932 // Skip this section if the associated section is unused.
933 if (Assoc->Number == -1)
936 Section->Symbol->Aux[0].Aux.SectionDefinition.Number = SectionIndices[Assoc];
940 // Assign file offsets to COFF object file structures.
945 offset += COFF::Header32Size;
947 offset += COFF::Header16Size;
948 offset += COFF::SectionSize * Header.NumberOfSections;
950 for (const auto &Section : Asm) {
951 COFFSection *Sec = SectionMap[&Section.getSection()];
953 if (Sec->Number == -1)
956 Sec->Header.SizeOfRawData = Layout.getSectionAddressSize(&Section);
958 if (IsPhysicalSection(Sec)) {
959 // Align the section data to a four byte boundary.
960 offset = RoundUpToAlignment(offset, 4);
961 Sec->Header.PointerToRawData = offset;
963 offset += Sec->Header.SizeOfRawData;
966 if (Sec->Relocations.size() > 0) {
967 bool RelocationsOverflow = Sec->Relocations.size() >= 0xffff;
969 if (RelocationsOverflow) {
970 // Signal overflow by setting NumberOfRelocations to max value. Actual
971 // size is found in reloc #0. Microsoft tools understand this.
972 Sec->Header.NumberOfRelocations = 0xffff;
974 Sec->Header.NumberOfRelocations = Sec->Relocations.size();
976 Sec->Header.PointerToRelocations = offset;
978 if (RelocationsOverflow) {
979 // Reloc #0 will contain actual count, so make room for it.
980 offset += COFF::RelocationSize;
983 offset += COFF::RelocationSize * Sec->Relocations.size();
985 for (auto &Relocation : Sec->Relocations) {
986 assert(Relocation.Symb->Index != -1);
987 Relocation.Data.SymbolTableIndex = Relocation.Symb->Index;
991 assert(Sec->Symbol->Aux.size() == 1 &&
992 "Section's symbol must have one aux!");
993 AuxSymbol &Aux = Sec->Symbol->Aux[0];
994 assert(Aux.AuxType == ATSectionDefinition &&
995 "Section's symbol's aux symbol must be a Section Definition!");
996 Aux.Aux.SectionDefinition.Length = Sec->Header.SizeOfRawData;
997 Aux.Aux.SectionDefinition.NumberOfRelocations =
998 Sec->Header.NumberOfRelocations;
999 Aux.Aux.SectionDefinition.NumberOfLinenumbers =
1000 Sec->Header.NumberOfLineNumbers;
1003 Header.PointerToSymbolTable = offset;
1005 // We want a deterministic output. It looks like GNU as also writes 0 in here.
1006 Header.TimeDateStamp = 0;
1008 // Write it all to disk...
1009 WriteFileHeader(Header);
1012 sections::iterator i, ie;
1013 MCAssembler::const_iterator j, je;
1015 for (auto &Section : Sections) {
1016 if (Section->Number != -1) {
1017 if (Section->Relocations.size() >= 0xffff)
1018 Section->Header.Characteristics |= COFF::IMAGE_SCN_LNK_NRELOC_OVFL;
1019 WriteSectionHeader(Section->Header);
1023 for (i = Sections.begin(), ie = Sections.end(),
1024 j = Asm.begin(), je = Asm.end();
1025 (i != ie) && (j != je); ++i, ++j) {
1027 if ((*i)->Number == -1)
1030 if ((*i)->Header.PointerToRawData != 0) {
1031 assert(OS.tell() <= (*i)->Header.PointerToRawData &&
1032 "Section::PointerToRawData is insane!");
1034 unsigned SectionDataPadding = (*i)->Header.PointerToRawData - OS.tell();
1035 assert(SectionDataPadding < 4 &&
1036 "Should only need at most three bytes of padding!");
1038 WriteZeros(SectionDataPadding);
1040 Asm.writeSectionData(j, Layout);
1043 if ((*i)->Relocations.size() > 0) {
1044 assert(OS.tell() == (*i)->Header.PointerToRelocations &&
1045 "Section::PointerToRelocations is insane!");
1047 if ((*i)->Relocations.size() >= 0xffff) {
1048 // In case of overflow, write actual relocation count as first
1049 // relocation. Including the synthetic reloc itself (+ 1).
1051 r.VirtualAddress = (*i)->Relocations.size() + 1;
1052 r.SymbolTableIndex = 0;
1057 for (const auto &Relocation : (*i)->Relocations)
1058 WriteRelocation(Relocation.Data);
1060 assert((*i)->Header.PointerToRelocations == 0 &&
1061 "Section::PointerToRelocations is insane!");
1065 assert(OS.tell() == Header.PointerToSymbolTable &&
1066 "Header::PointerToSymbolTable is insane!");
1068 for (auto &Symbol : Symbols)
1069 if (Symbol->Index != -1)
1070 WriteSymbol(*Symbol);
1072 OS.write(Strings.data().data(), Strings.data().size());
1075 MCWinCOFFObjectTargetWriter::MCWinCOFFObjectTargetWriter(unsigned Machine_) :
1079 // Pin the vtable to this file.
1080 void MCWinCOFFObjectTargetWriter::anchor() {}
1082 //------------------------------------------------------------------------------
1083 // WinCOFFObjectWriter factory function
1086 llvm::createWinCOFFObjectWriter(MCWinCOFFObjectTargetWriter *MOTW,
1087 raw_pwrite_stream &OS) {
1088 return new WinCOFFObjectWriter(MOTW, OS);