1 //===-- llvm/MC/WinCOFFStreamer.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 Windows COFF object file streamer.
12 //===----------------------------------------------------------------------===//
14 #include "llvm/MC/MCAsmBackend.h"
15 #include "llvm/MC/MCAsmLayout.h"
16 #include "llvm/MC/MCAssembler.h"
17 #include "llvm/MC/MCCodeEmitter.h"
18 #include "llvm/MC/MCContext.h"
19 #include "llvm/MC/MCExpr.h"
20 #include "llvm/MC/MCObjectFileInfo.h"
21 #include "llvm/MC/MCObjectStreamer.h"
22 #include "llvm/MC/MCSection.h"
23 #include "llvm/MC/MCSectionCOFF.h"
24 #include "llvm/MC/MCStreamer.h"
25 #include "llvm/MC/MCSymbolCOFF.h"
26 #include "llvm/MC/MCValue.h"
27 #include "llvm/MC/MCWinCOFFStreamer.h"
28 #include "llvm/Support/COFF.h"
29 #include "llvm/Support/Debug.h"
30 #include "llvm/Support/ErrorHandling.h"
31 #include "llvm/Support/MathExtras.h"
32 #include "llvm/Support/TargetRegistry.h"
33 #include "llvm/Support/raw_ostream.h"
37 #define DEBUG_TYPE "WinCOFFStreamer"
40 MCWinCOFFStreamer::MCWinCOFFStreamer(MCContext &Context, MCAsmBackend &MAB,
41 MCCodeEmitter &CE, raw_pwrite_stream &OS)
42 : MCObjectStreamer(Context, MAB, OS, &CE), CurSymbol(nullptr) {}
44 void MCWinCOFFStreamer::EmitInstToData(const MCInst &Inst,
45 const MCSubtargetInfo &STI) {
46 MCDataFragment *DF = getOrCreateDataFragment();
48 SmallVector<MCFixup, 4> Fixups;
49 SmallString<256> Code;
50 raw_svector_ostream VecOS(Code);
51 getAssembler().getEmitter().encodeInstruction(Inst, VecOS, Fixups, STI);
53 // Add the fixups and data.
54 for (unsigned i = 0, e = Fixups.size(); i != e; ++i) {
55 Fixups[i].setOffset(Fixups[i].getOffset() + DF->getContents().size());
56 DF->getFixups().push_back(Fixups[i]);
59 DF->getContents().append(Code.begin(), Code.end());
62 void MCWinCOFFStreamer::InitSections(bool NoExecStack) {
63 // FIXME: this is identical to the ELF one.
64 // This emulates the same behavior of GNU as. This makes it easier
65 // to compare the output as the major sections are in the same order.
66 SwitchSection(getContext().getObjectFileInfo()->getTextSection());
69 SwitchSection(getContext().getObjectFileInfo()->getDataSection());
72 SwitchSection(getContext().getObjectFileInfo()->getBSSSection());
75 SwitchSection(getContext().getObjectFileInfo()->getTextSection());
78 void MCWinCOFFStreamer::EmitLabel(MCSymbol *Symbol) {
79 assert(Symbol->isUndefined() && "Cannot define a symbol twice!");
80 MCObjectStreamer::EmitLabel(Symbol);
83 void MCWinCOFFStreamer::EmitAssemblerFlag(MCAssemblerFlag Flag) {
84 llvm_unreachable("not implemented");
87 void MCWinCOFFStreamer::EmitThumbFunc(MCSymbol *Func) {
88 llvm_unreachable("not implemented");
91 bool MCWinCOFFStreamer::EmitSymbolAttribute(MCSymbol *Symbol,
92 MCSymbolAttr Attribute) {
93 assert(Symbol && "Symbol must be non-null!");
94 assert((!Symbol->isInSection() ||
95 Symbol->getSection().getVariant() == MCSection::SV_COFF) &&
96 "Got non-COFF section in the COFF backend!");
98 getAssembler().registerSymbol(*Symbol);
101 default: return false;
102 case MCSA_WeakReference:
104 cast<MCSymbolCOFF>(Symbol)->setIsWeakExternal();
105 Symbol->setExternal(true);
108 Symbol->setExternal(true);
115 void MCWinCOFFStreamer::EmitSymbolDesc(MCSymbol *Symbol, unsigned DescValue) {
116 llvm_unreachable("not implemented");
119 void MCWinCOFFStreamer::BeginCOFFSymbolDef(MCSymbol const *Symbol) {
120 assert((!Symbol->isInSection() ||
121 Symbol->getSection().getVariant() == MCSection::SV_COFF) &&
122 "Got non-COFF section in the COFF backend!");
125 FatalError("starting a new symbol definition without completing the "
130 void MCWinCOFFStreamer::EmitCOFFSymbolStorageClass(int StorageClass) {
132 FatalError("storage class specified outside of symbol definition");
134 if (StorageClass & ~COFF::SSC_Invalid)
135 FatalError("storage class value '" + Twine(StorageClass) +
138 getAssembler().registerSymbol(*CurSymbol);
139 cast<MCSymbolCOFF>(CurSymbol)->setClass((uint16_t)StorageClass);
142 void MCWinCOFFStreamer::EmitCOFFSymbolType(int Type) {
144 FatalError("symbol type specified outside of a symbol definition");
147 FatalError("type value '" + Twine(Type) + "' out of range");
149 getAssembler().registerSymbol(*CurSymbol);
150 cast<MCSymbolCOFF>(CurSymbol)->setType((uint16_t)Type);
153 void MCWinCOFFStreamer::EndCOFFSymbolDef() {
155 FatalError("ending symbol definition without starting one");
159 void MCWinCOFFStreamer::EmitCOFFSafeSEH(MCSymbol const *Symbol) {
160 // SafeSEH is a feature specific to 32-bit x86. It does not exist (and is
161 // unnecessary) on all platforms which use table-based exception dispatch.
162 if (getContext().getObjectFileInfo()->getTargetTriple().getArch() !=
166 const MCSymbolCOFF *CSymbol = cast<MCSymbolCOFF>(Symbol);
167 if (CSymbol->isSafeSEH())
170 MCSection *SXData = getContext().getObjectFileInfo()->getSXDataSection();
171 getAssembler().registerSection(*SXData);
172 if (SXData->getAlignment() < 4)
173 SXData->setAlignment(4);
175 new MCSafeSEHFragment(Symbol, SXData);
177 getAssembler().registerSymbol(*Symbol);
178 CSymbol->setIsSafeSEH();
180 // The Microsoft linker requires that the symbol type of a handler be
181 // function. Go ahead and oblige it here.
182 CSymbol->setType(COFF::IMAGE_SYM_DTYPE_FUNCTION
183 << COFF::SCT_COMPLEX_TYPE_SHIFT);
186 void MCWinCOFFStreamer::EmitCOFFSectionIndex(MCSymbol const *Symbol) {
187 MCDataFragment *DF = getOrCreateDataFragment();
188 const MCSymbolRefExpr *SRE = MCSymbolRefExpr::create(Symbol, getContext());
189 MCFixup Fixup = MCFixup::create(DF->getContents().size(), SRE, FK_SecRel_2);
190 DF->getFixups().push_back(Fixup);
191 DF->getContents().resize(DF->getContents().size() + 2, 0);
194 void MCWinCOFFStreamer::EmitCOFFSecRel32(MCSymbol const *Symbol) {
195 MCDataFragment *DF = getOrCreateDataFragment();
196 const MCSymbolRefExpr *SRE = MCSymbolRefExpr::create(Symbol, getContext());
197 MCFixup Fixup = MCFixup::create(DF->getContents().size(), SRE, FK_SecRel_4);
198 DF->getFixups().push_back(Fixup);
199 DF->getContents().resize(DF->getContents().size() + 4, 0);
202 void MCWinCOFFStreamer::EmitCommonSymbol(MCSymbol *Symbol, uint64_t Size,
203 unsigned ByteAlignment) {
204 assert((!Symbol->isInSection() ||
205 Symbol->getSection().getVariant() == MCSection::SV_COFF) &&
206 "Got non-COFF section in the COFF backend!");
208 const Triple &T = getContext().getObjectFileInfo()->getTargetTriple();
209 if (T.isKnownWindowsMSVCEnvironment()) {
210 if (ByteAlignment > 32)
211 report_fatal_error("alignment is limited to 32-bytes");
213 // Round size up to alignment so that we will honor the alignment request.
214 Size = std::max(Size, static_cast<uint64_t>(ByteAlignment));
217 getAssembler().registerSymbol(*Symbol);
218 Symbol->setExternal(true);
219 Symbol->setCommon(Size, ByteAlignment);
221 if (!T.isKnownWindowsMSVCEnvironment() && ByteAlignment > 1) {
222 SmallString<128> Directive;
223 raw_svector_ostream OS(Directive);
224 const MCObjectFileInfo *MFI = getContext().getObjectFileInfo();
226 OS << " -aligncomm:\"" << Symbol->getName() << "\","
227 << Log2_32_Ceil(ByteAlignment);
230 SwitchSection(MFI->getDrectveSection());
231 EmitBytes(Directive);
236 void MCWinCOFFStreamer::EmitLocalCommonSymbol(MCSymbol *Symbol, uint64_t Size,
237 unsigned ByteAlignment) {
238 assert(!Symbol->isInSection() && "Symbol must not already have a section!");
240 MCSection *Section = getContext().getObjectFileInfo()->getBSSSection();
241 getAssembler().registerSection(*Section);
242 if (Section->getAlignment() < ByteAlignment)
243 Section->setAlignment(ByteAlignment);
245 getAssembler().registerSymbol(*Symbol);
246 Symbol->setExternal(false);
248 if (ByteAlignment != 1)
249 new MCAlignFragment(ByteAlignment, /*Value=*/0, /*ValueSize=*/0,
250 ByteAlignment, Section);
252 MCFillFragment *Fragment = new MCFillFragment(
253 /*Value=*/0, /*ValueSize=*/0, Size, Section);
254 Symbol->setFragment(Fragment);
257 void MCWinCOFFStreamer::EmitZerofill(MCSection *Section, MCSymbol *Symbol,
258 uint64_t Size, unsigned ByteAlignment) {
259 llvm_unreachable("not implemented");
262 void MCWinCOFFStreamer::EmitTBSSSymbol(MCSection *Section, MCSymbol *Symbol,
263 uint64_t Size, unsigned ByteAlignment) {
264 llvm_unreachable("not implemented");
267 void MCWinCOFFStreamer::EmitFileDirective(StringRef Filename) {
268 getAssembler().addFileName(Filename);
271 // TODO: Implement this if you want to emit .comment section in COFF obj files.
272 void MCWinCOFFStreamer::EmitIdent(StringRef IdentString) {
273 llvm_unreachable("not implemented");
276 void MCWinCOFFStreamer::EmitWinEHHandlerData() {
277 llvm_unreachable("not implemented");
280 void MCWinCOFFStreamer::FinishImpl() {
281 MCObjectStreamer::FinishImpl();
284 LLVM_ATTRIBUTE_NORETURN
285 void MCWinCOFFStreamer::FatalError(const Twine &Msg) const {
286 getContext().reportFatalError(SMLoc(), Msg);