Line data Source code
1 : //===- llvm/MC/WinCOFFStreamer.cpp ----------------------------------------===//
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 Windows COFF object file streamer.
11 : //
12 : //===----------------------------------------------------------------------===//
13 :
14 : #include "llvm/ADT/SmallString.h"
15 : #include "llvm/ADT/SmallVector.h"
16 : #include "llvm/ADT/Triple.h"
17 : #include "llvm/ADT/Twine.h"
18 : #include "llvm/BinaryFormat/COFF.h"
19 : #include "llvm/MC/MCAsmBackend.h"
20 : #include "llvm/MC/MCAssembler.h"
21 : #include "llvm/MC/MCCodeEmitter.h"
22 : #include "llvm/MC/MCContext.h"
23 : #include "llvm/MC/MCExpr.h"
24 : #include "llvm/MC/MCFixup.h"
25 : #include "llvm/MC/MCFragment.h"
26 : #include "llvm/MC/MCObjectFileInfo.h"
27 : #include "llvm/MC/MCObjectStreamer.h"
28 : #include "llvm/MC/MCSection.h"
29 : #include "llvm/MC/MCSymbolCOFF.h"
30 : #include "llvm/MC/MCWinCOFFStreamer.h"
31 : #include "llvm/Support/Casting.h"
32 : #include "llvm/Support/ErrorHandling.h"
33 : #include "llvm/Support/MathExtras.h"
34 : #include "llvm/Support/SMLoc.h"
35 : #include "llvm/Support/raw_ostream.h"
36 : #include <algorithm>
37 : #include <cassert>
38 : #include <cstdint>
39 :
40 : using namespace llvm;
41 :
42 : #define DEBUG_TYPE "WinCOFFStreamer"
43 :
44 254 : MCWinCOFFStreamer::MCWinCOFFStreamer(MCContext &Context, MCAsmBackend &MAB,
45 254 : MCCodeEmitter &CE, raw_pwrite_stream &OS)
46 254 : : MCObjectStreamer(Context, MAB, OS, &CE), CurSymbol(nullptr) {}
47 :
48 1476 : void MCWinCOFFStreamer::EmitInstToData(const MCInst &Inst,
49 : const MCSubtargetInfo &STI) {
50 1476 : MCDataFragment *DF = getOrCreateDataFragment();
51 :
52 2952 : SmallVector<MCFixup, 4> Fixups;
53 2952 : SmallString<256> Code;
54 2952 : raw_svector_ostream VecOS(Code);
55 1476 : getAssembler().getEmitter().encodeInstruction(Inst, VecOS, Fixups, STI);
56 :
57 : // Add the fixups and data.
58 3229 : for (unsigned i = 0, e = Fixups.size(); i != e; ++i) {
59 1385 : Fixups[i].setOffset(Fixups[i].getOffset() + DF->getContents().size());
60 554 : DF->getFixups().push_back(Fixups[i]);
61 : }
62 :
63 4428 : DF->getContents().append(Code.begin(), Code.end());
64 1476 : }
65 :
66 254 : void MCWinCOFFStreamer::InitSections(bool NoExecStack) {
67 : // FIXME: this is identical to the ELF one.
68 : // This emulates the same behavior of GNU as. This makes it easier
69 : // to compare the output as the major sections are in the same order.
70 254 : SwitchSection(getContext().getObjectFileInfo()->getTextSection());
71 254 : EmitCodeAlignment(4);
72 :
73 254 : SwitchSection(getContext().getObjectFileInfo()->getDataSection());
74 254 : EmitCodeAlignment(4);
75 :
76 254 : SwitchSection(getContext().getObjectFileInfo()->getBSSSection());
77 254 : EmitCodeAlignment(4);
78 :
79 254 : SwitchSection(getContext().getObjectFileInfo()->getTextSection());
80 254 : }
81 :
82 3551 : void MCWinCOFFStreamer::EmitLabel(MCSymbol *S, SMLoc Loc) {
83 3551 : auto *Symbol = cast<MCSymbolCOFF>(S);
84 3551 : MCObjectStreamer::EmitLabel(Symbol, Loc);
85 3551 : }
86 :
87 0 : void MCWinCOFFStreamer::EmitAssemblerFlag(MCAssemblerFlag Flag) {
88 0 : llvm_unreachable("not implemented");
89 : }
90 :
91 0 : void MCWinCOFFStreamer::EmitThumbFunc(MCSymbol *Func) {
92 0 : llvm_unreachable("not implemented");
93 : }
94 :
95 461 : bool MCWinCOFFStreamer::EmitSymbolAttribute(MCSymbol *S,
96 : MCSymbolAttr Attribute) {
97 461 : auto *Symbol = cast<MCSymbolCOFF>(S);
98 461 : getAssembler().registerSymbol(*Symbol);
99 :
100 461 : switch (Attribute) {
101 : default: return false;
102 : case MCSA_WeakReference:
103 : case MCSA_Weak:
104 8 : Symbol->setIsWeakExternal();
105 8 : Symbol->setExternal(true);
106 : break;
107 : case MCSA_Global:
108 451 : Symbol->setExternal(true);
109 : break;
110 : case MCSA_AltEntry:
111 0 : llvm_unreachable("COFF doesn't support the .alt_entry attribute");
112 : }
113 :
114 : return true;
115 : }
116 :
117 0 : void MCWinCOFFStreamer::EmitSymbolDesc(MCSymbol *Symbol, unsigned DescValue) {
118 0 : llvm_unreachable("not implemented");
119 : }
120 :
121 286 : void MCWinCOFFStreamer::BeginCOFFSymbolDef(MCSymbol const *S) {
122 286 : auto *Symbol = cast<MCSymbolCOFF>(S);
123 286 : if (CurSymbol)
124 4 : Error("starting a new symbol definition without completing the "
125 2 : "previous one");
126 286 : CurSymbol = Symbol;
127 286 : }
128 :
129 285 : void MCWinCOFFStreamer::EmitCOFFSymbolStorageClass(int StorageClass) {
130 285 : if (!CurSymbol) {
131 2 : Error("storage class specified outside of symbol definition");
132 2 : return;
133 : }
134 :
135 283 : if (StorageClass & ~COFF::SSC_Invalid) {
136 10 : Error("storage class value '" + Twine(StorageClass) +
137 6 : "' out of range");
138 2 : return;
139 : }
140 :
141 281 : getAssembler().registerSymbol(*CurSymbol);
142 562 : cast<MCSymbolCOFF>(CurSymbol)->setClass((uint16_t)StorageClass);
143 : }
144 :
145 284 : void MCWinCOFFStreamer::EmitCOFFSymbolType(int Type) {
146 284 : if (!CurSymbol) {
147 2 : Error("symbol type specified outside of a symbol definition");
148 2 : return;
149 : }
150 :
151 282 : if (Type & ~0xffff) {
152 5 : Error("type value '" + Twine(Type) + "' out of range");
153 1 : return;
154 : }
155 :
156 281 : getAssembler().registerSymbol(*CurSymbol);
157 562 : cast<MCSymbolCOFF>(CurSymbol)->setType((uint16_t)Type);
158 : }
159 :
160 285 : void MCWinCOFFStreamer::EndCOFFSymbolDef() {
161 285 : if (!CurSymbol)
162 2 : Error("ending symbol definition without starting one");
163 285 : CurSymbol = nullptr;
164 285 : }
165 :
166 0 : void MCWinCOFFStreamer::EmitCOFFSafeSEH(MCSymbol const *Symbol) {
167 : // SafeSEH is a feature specific to 32-bit x86. It does not exist (and is
168 : // unnecessary) on all platforms which use table-based exception dispatch.
169 0 : if (getContext().getObjectFileInfo()->getTargetTriple().getArch() !=
170 : Triple::x86)
171 : return;
172 :
173 0 : const MCSymbolCOFF *CSymbol = cast<MCSymbolCOFF>(Symbol);
174 0 : if (CSymbol->isSafeSEH())
175 : return;
176 :
177 0 : MCSection *SXData = getContext().getObjectFileInfo()->getSXDataSection();
178 0 : getAssembler().registerSection(*SXData);
179 0 : if (SXData->getAlignment() < 4)
180 0 : SXData->setAlignment(4);
181 :
182 0 : new MCSafeSEHFragment(Symbol, SXData);
183 :
184 0 : getAssembler().registerSymbol(*Symbol);
185 0 : CSymbol->setIsSafeSEH();
186 :
187 : // The Microsoft linker requires that the symbol type of a handler be
188 : // function. Go ahead and oblige it here.
189 : CSymbol->setType(COFF::IMAGE_SYM_DTYPE_FUNCTION
190 : << COFF::SCT_COMPLEX_TYPE_SHIFT);
191 : }
192 :
193 219 : void MCWinCOFFStreamer::EmitCOFFSectionIndex(MCSymbol const *Symbol) {
194 219 : MCDataFragment *DF = getOrCreateDataFragment();
195 438 : const MCSymbolRefExpr *SRE = MCSymbolRefExpr::create(Symbol, getContext());
196 657 : MCFixup Fixup = MCFixup::create(DF->getContents().size(), SRE, FK_SecRel_2);
197 219 : DF->getFixups().push_back(Fixup);
198 657 : DF->getContents().resize(DF->getContents().size() + 2, 0);
199 219 : }
200 :
201 376 : void MCWinCOFFStreamer::EmitCOFFSecRel32(MCSymbol const *Symbol,
202 : uint64_t Offset) {
203 376 : MCDataFragment *DF = getOrCreateDataFragment();
204 : // Create Symbol A for the relocation relative reference.
205 752 : const MCExpr *MCE = MCSymbolRefExpr::create(Symbol, getContext());
206 : // Add the constant offset, if given.
207 376 : if (Offset)
208 3 : MCE = MCBinaryExpr::createAdd(
209 6 : MCE, MCConstantExpr::create(Offset, getContext()), getContext());
210 : // Build the secrel32 relocation.
211 1128 : MCFixup Fixup = MCFixup::create(DF->getContents().size(), MCE, FK_SecRel_4);
212 : // Record the relocation.
213 376 : DF->getFixups().push_back(Fixup);
214 : // Emit 4 bytes (zeros) to the object file.
215 1128 : DF->getContents().resize(DF->getContents().size() + 4, 0);
216 376 : }
217 :
218 15 : void MCWinCOFFStreamer::EmitCommonSymbol(MCSymbol *S, uint64_t Size,
219 : unsigned ByteAlignment) {
220 15 : auto *Symbol = cast<MCSymbolCOFF>(S);
221 :
222 30 : const Triple &T = getContext().getObjectFileInfo()->getTargetTriple();
223 15 : if (T.isKnownWindowsMSVCEnvironment()) {
224 10 : if (ByteAlignment > 32)
225 0 : report_fatal_error("alignment is limited to 32-bytes");
226 :
227 : // Round size up to alignment so that we will honor the alignment request.
228 20 : Size = std::max(Size, static_cast<uint64_t>(ByteAlignment));
229 : }
230 :
231 15 : getAssembler().registerSymbol(*Symbol);
232 30 : Symbol->setExternal(true);
233 30 : Symbol->setCommon(Size, ByteAlignment);
234 :
235 15 : if (!T.isKnownWindowsMSVCEnvironment() && ByteAlignment > 1) {
236 8 : SmallString<128> Directive;
237 8 : raw_svector_ostream OS(Directive);
238 4 : const MCObjectFileInfo *MFI = getContext().getObjectFileInfo();
239 :
240 8 : OS << " -aligncomm:\"" << Symbol->getName() << "\","
241 8 : << Log2_32_Ceil(ByteAlignment);
242 :
243 4 : PushSection();
244 4 : SwitchSection(MFI->getDrectveSection());
245 8 : EmitBytes(Directive);
246 4 : PopSection();
247 : }
248 15 : }
249 :
250 4 : void MCWinCOFFStreamer::EmitLocalCommonSymbol(MCSymbol *S, uint64_t Size,
251 : unsigned ByteAlignment) {
252 4 : auto *Symbol = cast<MCSymbolCOFF>(S);
253 :
254 4 : MCSection *Section = getContext().getObjectFileInfo()->getBSSSection();
255 4 : getAssembler().registerSection(*Section);
256 4 : if (Section->getAlignment() < ByteAlignment)
257 0 : Section->setAlignment(ByteAlignment);
258 :
259 4 : getAssembler().registerSymbol(*Symbol);
260 8 : Symbol->setExternal(false);
261 :
262 4 : if (ByteAlignment != 1)
263 : new MCAlignFragment(ByteAlignment, /*Value=*/0, /*ValueSize=*/0,
264 4 : ByteAlignment, Section);
265 :
266 : MCFillFragment *Fragment = new MCFillFragment(
267 8 : /*Value=*/0, Size, Section);
268 8 : Symbol->setFragment(Fragment);
269 4 : }
270 :
271 0 : void MCWinCOFFStreamer::EmitZerofill(MCSection *Section, MCSymbol *Symbol,
272 : uint64_t Size, unsigned ByteAlignment) {
273 0 : llvm_unreachable("not implemented");
274 : }
275 :
276 0 : void MCWinCOFFStreamer::EmitTBSSSymbol(MCSection *Section, MCSymbol *Symbol,
277 : uint64_t Size, unsigned ByteAlignment) {
278 0 : llvm_unreachable("not implemented");
279 : }
280 :
281 : // TODO: Implement this if you want to emit .comment section in COFF obj files.
282 0 : void MCWinCOFFStreamer::EmitIdent(StringRef IdentString) {
283 0 : llvm_unreachable("not implemented");
284 : }
285 :
286 0 : void MCWinCOFFStreamer::EmitWinEHHandlerData() {
287 0 : llvm_unreachable("not implemented");
288 : }
289 :
290 250 : void MCWinCOFFStreamer::FinishImpl() {
291 250 : MCObjectStreamer::FinishImpl();
292 247 : }
293 :
294 11 : void MCWinCOFFStreamer::Error(const Twine &Msg) const {
295 11 : getContext().reportError(SMLoc(), Msg);
296 11 : }
|
