1 //===- lib/MC/MCStreamer.cpp - Streaming Machine Code Output --------------===//
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 #include "llvm/MC/MCAsmInfo.h"
11 #include "llvm/MC/MCContext.h"
12 #include "llvm/MC/MCStreamer.h"
13 #include "llvm/MC/MCExpr.h"
14 #include "llvm/MC/MCObjectWriter.h"
15 #include "llvm/MC/MCSymbol.h"
16 #include "llvm/Support/ErrorHandling.h"
17 #include "llvm/Support/raw_ostream.h"
18 #include "llvm/ADT/SmallString.h"
19 #include "llvm/ADT/Twine.h"
23 MCStreamer::MCStreamer(MCContext &Ctx) : Context(Ctx), EmitEHFrame(true),
24 EmitDebugFrame(false),
25 CurrentW64UnwindInfo(0) {
26 const MCSection *section = NULL;
27 SectionStack.push_back(std::make_pair(section, section));
30 MCStreamer::~MCStreamer() {
31 for (unsigned i = 0; i < getNumW64UnwindInfos(); ++i)
32 delete W64UnwindInfos[i];
35 const MCExpr *MCStreamer::BuildSymbolDiff(MCContext &Context,
38 MCSymbolRefExpr::VariantKind Variant = MCSymbolRefExpr::VK_None;
40 MCSymbolRefExpr::Create(A, Variant, Context);
42 MCSymbolRefExpr::Create(B, Variant, Context);
43 const MCExpr *AddrDelta =
44 MCBinaryExpr::Create(MCBinaryExpr::Sub, ARef, BRef, Context);
48 const MCExpr *MCStreamer::ForceExpAbs(const MCExpr* Expr) {
49 if (Context.getAsmInfo().hasAggressiveSymbolFolding() ||
50 isa<MCSymbolRefExpr>(Expr))
53 MCSymbol *ABS = Context.CreateTempSymbol();
54 EmitAssignment(ABS, Expr);
55 return MCSymbolRefExpr::Create(ABS, Context);
58 raw_ostream &MCStreamer::GetCommentOS() {
59 // By default, discard comments.
63 void MCStreamer::EmitDwarfSetLineAddr(int64_t LineDelta,
64 const MCSymbol *Label, int PointerSize) {
65 // emit the sequence to set the address
66 EmitIntValue(dwarf::DW_LNS_extended_op, 1);
67 EmitULEB128IntValue(PointerSize + 1);
68 EmitIntValue(dwarf::DW_LNE_set_address, 1);
69 EmitSymbolValue(Label, PointerSize);
71 // emit the sequence for the LineDelta (from 1) and a zero address delta.
72 MCDwarfLineAddr::Emit(this, LineDelta, 0);
75 /// EmitIntValue - Special case of EmitValue that avoids the client having to
76 /// pass in a MCExpr for constant integers.
77 void MCStreamer::EmitIntValue(uint64_t Value, unsigned Size,
79 assert(Size <= 8 && "Invalid size");
80 assert((isUIntN(8 * Size, Value) || isIntN(8 * Size, Value)) &&
83 // FIXME: Endianness assumption.
84 for (unsigned i = 0; i != Size; ++i)
85 buf[i] = uint8_t(Value >> (i * 8));
86 EmitBytes(StringRef(buf, Size), AddrSpace);
89 /// EmitULEB128Value - Special case of EmitULEB128Value that avoids the
90 /// client having to pass in a MCExpr for constant integers.
91 void MCStreamer::EmitULEB128IntValue(uint64_t Value, unsigned AddrSpace) {
93 raw_svector_ostream OSE(Tmp);
94 MCObjectWriter::EncodeULEB128(Value, OSE);
95 EmitBytes(OSE.str(), AddrSpace);
98 /// EmitSLEB128Value - Special case of EmitSLEB128Value that avoids the
99 /// client having to pass in a MCExpr for constant integers.
100 void MCStreamer::EmitSLEB128IntValue(int64_t Value, unsigned AddrSpace) {
102 raw_svector_ostream OSE(Tmp);
103 MCObjectWriter::EncodeSLEB128(Value, OSE);
104 EmitBytes(OSE.str(), AddrSpace);
107 void MCStreamer::EmitAbsValue(const MCExpr *Value, unsigned Size,
108 unsigned AddrSpace) {
109 const MCExpr *ABS = ForceExpAbs(Value);
110 EmitValue(ABS, Size, AddrSpace);
114 void MCStreamer::EmitValue(const MCExpr *Value, unsigned Size,
115 unsigned AddrSpace) {
116 EmitValueImpl(Value, Size, AddrSpace);
119 void MCStreamer::EmitSymbolValue(const MCSymbol *Sym, unsigned Size,
120 unsigned AddrSpace) {
121 EmitValueImpl(MCSymbolRefExpr::Create(Sym, getContext()), Size,
125 void MCStreamer::EmitGPRel32Value(const MCExpr *Value) {
126 report_fatal_error("unsupported directive in streamer");
129 /// EmitFill - Emit NumBytes bytes worth of the value specified by
130 /// FillValue. This implements directives such as '.space'.
131 void MCStreamer::EmitFill(uint64_t NumBytes, uint8_t FillValue,
132 unsigned AddrSpace) {
133 const MCExpr *E = MCConstantExpr::Create(FillValue, getContext());
134 for (uint64_t i = 0, e = NumBytes; i != e; ++i)
135 EmitValue(E, 1, AddrSpace);
138 bool MCStreamer::EmitDwarfFileDirective(unsigned FileNo,
139 StringRef Filename) {
140 return getContext().GetDwarfFile(Filename, FileNo) == 0;
143 void MCStreamer::EmitDwarfLocDirective(unsigned FileNo, unsigned Line,
144 unsigned Column, unsigned Flags,
146 unsigned Discriminator,
147 StringRef FileName) {
148 getContext().setCurrentDwarfLoc(FileNo, Line, Column, Flags, Isa,
152 MCDwarfFrameInfo *MCStreamer::getCurrentFrameInfo() {
153 if (FrameInfos.empty())
155 return &FrameInfos.back();
158 void MCStreamer::EnsureValidFrame() {
159 MCDwarfFrameInfo *CurFrame = getCurrentFrameInfo();
160 if (!CurFrame || CurFrame->End)
161 report_fatal_error("No open frame");
164 void MCStreamer::EmitEHSymAttributes(const MCSymbol *Symbol,
165 MCSymbol *EHSymbol) {
168 void MCStreamer::EmitLabel(MCSymbol *Symbol) {
169 assert(!Symbol->isVariable() && "Cannot emit a variable symbol!");
170 assert(getCurrentSection() && "Cannot emit before setting section!");
171 Symbol->setSection(*getCurrentSection());
173 StringRef Prefix = getContext().getAsmInfo().getPrivateGlobalPrefix();
174 if (!Symbol->getName().startswith(Prefix))
175 LastNonPrivate = Symbol;
178 void MCStreamer::EmitCFISections(bool EH, bool Debug) {
181 EmitDebugFrame = Debug;
184 void MCStreamer::EmitCFIStartProc() {
185 MCDwarfFrameInfo *CurFrame = getCurrentFrameInfo();
186 if (CurFrame && !CurFrame->End)
187 report_fatal_error("Starting a frame before finishing the previous one!");
188 MCDwarfFrameInfo Frame;
189 Frame.Begin = getContext().CreateTempSymbol();
190 Frame.Function = LastNonPrivate;
191 EmitLabel(Frame.Begin);
192 FrameInfos.push_back(Frame);
195 void MCStreamer::EmitCFIEndProc() {
197 MCDwarfFrameInfo *CurFrame = getCurrentFrameInfo();
198 CurFrame->End = getContext().CreateTempSymbol();
199 EmitLabel(CurFrame->End);
202 void MCStreamer::EmitCFIDefCfa(int64_t Register, int64_t Offset) {
204 MCDwarfFrameInfo *CurFrame = getCurrentFrameInfo();
205 MCSymbol *Label = getContext().CreateTempSymbol();
207 MachineLocation Dest(MachineLocation::VirtualFP);
208 MachineLocation Source(Register, -Offset);
209 MCCFIInstruction Instruction(Label, Dest, Source);
210 CurFrame->Instructions.push_back(Instruction);
213 void MCStreamer::EmitCFIDefCfaOffset(int64_t Offset) {
215 MCDwarfFrameInfo *CurFrame = getCurrentFrameInfo();
216 MCSymbol *Label = getContext().CreateTempSymbol();
218 MachineLocation Dest(MachineLocation::VirtualFP);
219 MachineLocation Source(MachineLocation::VirtualFP, -Offset);
220 MCCFIInstruction Instruction(Label, Dest, Source);
221 CurFrame->Instructions.push_back(Instruction);
224 void MCStreamer::EmitCFIAdjustCfaOffset(int64_t Adjustment) {
226 MCDwarfFrameInfo *CurFrame = getCurrentFrameInfo();
227 MCSymbol *Label = getContext().CreateTempSymbol();
229 MachineLocation Dest(MachineLocation::VirtualFP);
230 MachineLocation Source(MachineLocation::VirtualFP, Adjustment);
231 MCCFIInstruction Instruction(MCCFIInstruction::RelMove, Label, Dest, Source);
232 CurFrame->Instructions.push_back(Instruction);
235 void MCStreamer::EmitCFIDefCfaRegister(int64_t Register) {
237 MCDwarfFrameInfo *CurFrame = getCurrentFrameInfo();
238 MCSymbol *Label = getContext().CreateTempSymbol();
240 MachineLocation Dest(Register);
241 MachineLocation Source(MachineLocation::VirtualFP);
242 MCCFIInstruction Instruction(Label, Dest, Source);
243 CurFrame->Instructions.push_back(Instruction);
246 void MCStreamer::EmitCFIOffset(int64_t Register, int64_t Offset) {
248 MCDwarfFrameInfo *CurFrame = getCurrentFrameInfo();
249 MCSymbol *Label = getContext().CreateTempSymbol();
251 MachineLocation Dest(Register, Offset);
252 MachineLocation Source(Register, Offset);
253 MCCFIInstruction Instruction(Label, Dest, Source);
254 CurFrame->Instructions.push_back(Instruction);
257 void MCStreamer::EmitCFIRelOffset(int64_t Register, int64_t Offset) {
259 MCDwarfFrameInfo *CurFrame = getCurrentFrameInfo();
260 MCSymbol *Label = getContext().CreateTempSymbol();
262 MachineLocation Dest(Register, Offset);
263 MachineLocation Source(Register, Offset);
264 MCCFIInstruction Instruction(MCCFIInstruction::RelMove, Label, Dest, Source);
265 CurFrame->Instructions.push_back(Instruction);
268 void MCStreamer::EmitCFIPersonality(const MCSymbol *Sym,
271 MCDwarfFrameInfo *CurFrame = getCurrentFrameInfo();
272 CurFrame->Personality = Sym;
273 CurFrame->PersonalityEncoding = Encoding;
276 void MCStreamer::EmitCFILsda(const MCSymbol *Sym, unsigned Encoding) {
278 MCDwarfFrameInfo *CurFrame = getCurrentFrameInfo();
279 CurFrame->Lsda = Sym;
280 CurFrame->LsdaEncoding = Encoding;
283 void MCStreamer::EmitCFIRememberState() {
285 MCDwarfFrameInfo *CurFrame = getCurrentFrameInfo();
286 MCSymbol *Label = getContext().CreateTempSymbol();
288 MCCFIInstruction Instruction(MCCFIInstruction::Remember, Label);
289 CurFrame->Instructions.push_back(Instruction);
292 void MCStreamer::EmitCFIRestoreState() {
293 // FIXME: Error if there is no matching cfi_remember_state.
295 MCDwarfFrameInfo *CurFrame = getCurrentFrameInfo();
296 MCSymbol *Label = getContext().CreateTempSymbol();
298 MCCFIInstruction Instruction(MCCFIInstruction::Restore, Label);
299 CurFrame->Instructions.push_back(Instruction);
302 void MCStreamer::EmitCFISameValue(int64_t Register) {
304 MCDwarfFrameInfo *CurFrame = getCurrentFrameInfo();
305 MCSymbol *Label = getContext().CreateTempSymbol();
307 MCCFIInstruction Instruction(MCCFIInstruction::SameValue, Label, Register);
308 CurFrame->Instructions.push_back(Instruction);
311 void MCStreamer::setCurrentW64UnwindInfo(MCWin64EHUnwindInfo *Frame) {
312 W64UnwindInfos.push_back(Frame);
313 CurrentW64UnwindInfo = W64UnwindInfos.back();
316 void MCStreamer::EnsureValidW64UnwindInfo() {
317 MCWin64EHUnwindInfo *CurFrame = CurrentW64UnwindInfo;
318 if (!CurFrame || CurFrame->End)
319 report_fatal_error("No open Win64 EH frame function!");
322 void MCStreamer::EmitWin64EHStartProc(const MCSymbol *Symbol) {
323 MCWin64EHUnwindInfo *CurFrame = CurrentW64UnwindInfo;
324 if (CurFrame && !CurFrame->End)
325 report_fatal_error("Starting a function before ending the previous one!");
326 MCWin64EHUnwindInfo *Frame = new MCWin64EHUnwindInfo;
327 Frame->Begin = getContext().CreateTempSymbol();
328 Frame->Function = Symbol;
329 EmitLabel(Frame->Begin);
330 setCurrentW64UnwindInfo(Frame);
333 void MCStreamer::EmitWin64EHEndProc() {
334 EnsureValidW64UnwindInfo();
335 MCWin64EHUnwindInfo *CurFrame = CurrentW64UnwindInfo;
336 if (CurFrame->ChainedParent)
337 report_fatal_error("Not all chained regions terminated!");
338 CurFrame->End = getContext().CreateTempSymbol();
339 EmitLabel(CurFrame->End);
342 void MCStreamer::EmitWin64EHStartChained() {
343 EnsureValidW64UnwindInfo();
344 MCWin64EHUnwindInfo *Frame = new MCWin64EHUnwindInfo;
345 MCWin64EHUnwindInfo *CurFrame = CurrentW64UnwindInfo;
346 Frame->Begin = getContext().CreateTempSymbol();
347 Frame->Function = CurFrame->Function;
348 Frame->ChainedParent = CurFrame;
349 EmitLabel(Frame->Begin);
350 setCurrentW64UnwindInfo(Frame);
353 void MCStreamer::EmitWin64EHEndChained() {
354 EnsureValidW64UnwindInfo();
355 MCWin64EHUnwindInfo *CurFrame = CurrentW64UnwindInfo;
356 if (!CurFrame->ChainedParent)
357 report_fatal_error("End of a chained region outside a chained region!");
358 CurFrame->End = getContext().CreateTempSymbol();
359 EmitLabel(CurFrame->End);
360 CurrentW64UnwindInfo = CurFrame->ChainedParent;
363 void MCStreamer::EmitWin64EHHandler(const MCSymbol *Sym, bool Unwind,
365 EnsureValidW64UnwindInfo();
366 MCWin64EHUnwindInfo *CurFrame = CurrentW64UnwindInfo;
367 if (CurFrame->ChainedParent)
368 report_fatal_error("Chained unwind areas can't have handlers!");
369 CurFrame->ExceptionHandler = Sym;
370 if (!Except && !Unwind)
371 report_fatal_error("Don't know what kind of handler this is!");
373 CurFrame->HandlesUnwind = true;
375 CurFrame->HandlesExceptions = true;
378 void MCStreamer::EmitWin64EHHandlerData() {
379 EnsureValidW64UnwindInfo();
380 MCWin64EHUnwindInfo *CurFrame = CurrentW64UnwindInfo;
381 if (CurFrame->ChainedParent)
382 report_fatal_error("Chained unwind areas can't have handlers!");
385 void MCStreamer::EmitWin64EHPushReg(unsigned Register) {
386 EnsureValidW64UnwindInfo();
387 MCWin64EHUnwindInfo *CurFrame = CurrentW64UnwindInfo;
388 MCWin64EHInstruction Inst(Win64EH::UOP_PushNonVol, Register);
389 CurFrame->Instructions.push_back(Inst);
392 void MCStreamer::EmitWin64EHSetFrame(unsigned Register, unsigned Offset) {
393 EnsureValidW64UnwindInfo();
394 MCWin64EHUnwindInfo *CurFrame = CurrentW64UnwindInfo;
395 if (CurFrame->LastFrameInst >= 0)
396 report_fatal_error("Frame register and offset already specified!");
398 report_fatal_error("Misaligned frame pointer offset!");
399 MCWin64EHInstruction Inst(Win64EH::UOP_SetFPReg, Register, Offset);
400 CurFrame->LastFrameInst = CurFrame->Instructions.size();
401 CurFrame->Instructions.push_back(Inst);
404 void MCStreamer::EmitWin64EHAllocStack(unsigned Size) {
405 EnsureValidW64UnwindInfo();
407 report_fatal_error("Misaligned stack allocation!");
408 MCWin64EHUnwindInfo *CurFrame = CurrentW64UnwindInfo;
409 MCWin64EHInstruction Inst(Size);
410 CurFrame->Instructions.push_back(Inst);
413 void MCStreamer::EmitWin64EHSaveReg(unsigned Register, unsigned Offset) {
414 EnsureValidW64UnwindInfo();
416 report_fatal_error("Misaligned saved register offset!");
417 MCWin64EHUnwindInfo *CurFrame = CurrentW64UnwindInfo;
418 MCWin64EHInstruction Inst(
419 Offset > 512*1024-8 ? Win64EH::UOP_SaveNonVolBig : Win64EH::UOP_SaveNonVol,
421 CurFrame->Instructions.push_back(Inst);
424 void MCStreamer::EmitWin64EHSaveXMM(unsigned Register, unsigned Offset) {
425 EnsureValidW64UnwindInfo();
427 report_fatal_error("Misaligned saved vector register offset!");
428 MCWin64EHUnwindInfo *CurFrame = CurrentW64UnwindInfo;
429 MCWin64EHInstruction Inst(
430 Offset > 512*1024-16 ? Win64EH::UOP_SaveXMM128Big : Win64EH::UOP_SaveXMM128,
432 CurFrame->Instructions.push_back(Inst);
435 void MCStreamer::EmitWin64EHPushFrame(bool Code) {
436 EnsureValidW64UnwindInfo();
437 MCWin64EHUnwindInfo *CurFrame = CurrentW64UnwindInfo;
438 if (CurFrame->Instructions.size() > 0)
439 report_fatal_error("If present, PushMachFrame must be the first UOP");
440 MCWin64EHInstruction Inst(Win64EH::UOP_PushMachFrame, Code);
441 CurFrame->Instructions.push_back(Inst);
444 void MCStreamer::EmitWin64EHEndProlog() {
445 EnsureValidW64UnwindInfo();
446 MCWin64EHUnwindInfo *CurFrame = CurrentW64UnwindInfo;
447 CurFrame->PrologEnd = getContext().CreateTempSymbol();
448 EmitLabel(CurFrame->PrologEnd);
451 void MCStreamer::EmitFnStart() {
452 errs() << "Not implemented yet\n";
456 void MCStreamer::EmitFnEnd() {
457 errs() << "Not implemented yet\n";
461 void MCStreamer::EmitCantUnwind() {
462 errs() << "Not implemented yet\n";
466 void MCStreamer::EmitHandlerData() {
467 errs() << "Not implemented yet\n";
471 void MCStreamer::EmitPersonality(const MCSymbol *Personality) {
472 errs() << "Not implemented yet\n";
476 void MCStreamer::EmitSetFP(unsigned FpReg, unsigned SpReg, int64_t Offset) {
477 errs() << "Not implemented yet\n";
481 void MCStreamer::EmitPad(int64_t Offset) {
482 errs() << "Not implemented yet\n";
486 void MCStreamer::EmitRegSave(const SmallVectorImpl<unsigned> &RegList, bool) {
487 errs() << "Not implemented yet\n";
491 /// EmitRawText - If this file is backed by an assembly streamer, this dumps
492 /// the specified string in the output .s file. This capability is
493 /// indicated by the hasRawTextSupport() predicate.
494 void MCStreamer::EmitRawText(StringRef String) {
495 errs() << "EmitRawText called on an MCStreamer that doesn't support it, "
496 " something must not be fully mc'ized\n";
500 void MCStreamer::EmitRawText(const Twine &T) {
501 SmallString<128> Str;
503 EmitRawText(Str.str());
506 void MCStreamer::EmitFrames(bool usingCFI) {
507 if (!getNumFrameInfos())
511 MCDwarfFrameEmitter::Emit(*this, usingCFI, true);
514 MCDwarfFrameEmitter::Emit(*this, usingCFI, false);
517 void MCStreamer::EmitW64Tables() {
518 if (!getNumW64UnwindInfos())
521 MCWin64EHUnwindEmitter::Emit(*this);