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 const bool isLittleEndian = Context.getAsmInfo().isLittleEndian();
84 for (unsigned i = 0; i != Size; ++i) {
85 unsigned index = isLittleEndian ? i : (Size - i - 1);
86 buf[i] = uint8_t(Value >> (index * 8));
88 EmitBytes(StringRef(buf, Size), AddrSpace);
91 /// EmitULEB128Value - Special case of EmitULEB128Value that avoids the
92 /// client having to pass in a MCExpr for constant integers.
93 void MCStreamer::EmitULEB128IntValue(uint64_t Value, unsigned AddrSpace) {
95 raw_svector_ostream OSE(Tmp);
96 MCObjectWriter::EncodeULEB128(Value, OSE);
97 EmitBytes(OSE.str(), AddrSpace);
100 /// EmitSLEB128Value - Special case of EmitSLEB128Value that avoids the
101 /// client having to pass in a MCExpr for constant integers.
102 void MCStreamer::EmitSLEB128IntValue(int64_t Value, unsigned AddrSpace) {
104 raw_svector_ostream OSE(Tmp);
105 MCObjectWriter::EncodeSLEB128(Value, OSE);
106 EmitBytes(OSE.str(), AddrSpace);
109 void MCStreamer::EmitAbsValue(const MCExpr *Value, unsigned Size,
110 unsigned AddrSpace) {
111 const MCExpr *ABS = ForceExpAbs(Value);
112 EmitValue(ABS, Size, AddrSpace);
116 void MCStreamer::EmitValue(const MCExpr *Value, unsigned Size,
117 unsigned AddrSpace) {
118 EmitValueImpl(Value, Size, AddrSpace);
121 void MCStreamer::EmitSymbolValue(const MCSymbol *Sym, unsigned Size,
122 unsigned AddrSpace) {
123 EmitValueImpl(MCSymbolRefExpr::Create(Sym, getContext()), Size,
127 void MCStreamer::EmitGPRel32Value(const MCExpr *Value) {
128 report_fatal_error("unsupported directive in streamer");
131 /// EmitFill - Emit NumBytes bytes worth of the value specified by
132 /// FillValue. This implements directives such as '.space'.
133 void MCStreamer::EmitFill(uint64_t NumBytes, uint8_t FillValue,
134 unsigned AddrSpace) {
135 const MCExpr *E = MCConstantExpr::Create(FillValue, getContext());
136 for (uint64_t i = 0, e = NumBytes; i != e; ++i)
137 EmitValue(E, 1, AddrSpace);
140 bool MCStreamer::EmitDwarfFileDirective(unsigned FileNo,
141 StringRef Filename) {
142 return getContext().GetDwarfFile(Filename, FileNo) == 0;
145 void MCStreamer::EmitDwarfLocDirective(unsigned FileNo, unsigned Line,
146 unsigned Column, unsigned Flags,
148 unsigned Discriminator,
149 StringRef FileName) {
150 getContext().setCurrentDwarfLoc(FileNo, Line, Column, Flags, Isa,
154 MCDwarfFrameInfo *MCStreamer::getCurrentFrameInfo() {
155 if (FrameInfos.empty())
157 return &FrameInfos.back();
160 void MCStreamer::EnsureValidFrame() {
161 MCDwarfFrameInfo *CurFrame = getCurrentFrameInfo();
162 if (!CurFrame || CurFrame->End)
163 report_fatal_error("No open frame");
166 void MCStreamer::EmitEHSymAttributes(const MCSymbol *Symbol,
167 MCSymbol *EHSymbol) {
170 void MCStreamer::EmitLabel(MCSymbol *Symbol) {
171 assert(!Symbol->isVariable() && "Cannot emit a variable symbol!");
172 assert(getCurrentSection() && "Cannot emit before setting section!");
173 Symbol->setSection(*getCurrentSection());
175 StringRef Prefix = getContext().getAsmInfo().getPrivateGlobalPrefix();
176 if (!Symbol->getName().startswith(Prefix))
177 LastNonPrivate = Symbol;
180 void MCStreamer::EmitCFISections(bool EH, bool Debug) {
183 EmitDebugFrame = Debug;
186 void MCStreamer::EmitCFIStartProc() {
187 MCDwarfFrameInfo *CurFrame = getCurrentFrameInfo();
188 if (CurFrame && !CurFrame->End)
189 report_fatal_error("Starting a frame before finishing the previous one!");
190 MCDwarfFrameInfo Frame;
191 Frame.Begin = getContext().CreateTempSymbol();
192 Frame.Function = LastNonPrivate;
193 EmitLabel(Frame.Begin);
194 FrameInfos.push_back(Frame);
197 void MCStreamer::EmitCFIEndProc() {
199 MCDwarfFrameInfo *CurFrame = getCurrentFrameInfo();
200 CurFrame->End = getContext().CreateTempSymbol();
201 EmitLabel(CurFrame->End);
204 void MCStreamer::EmitCFIDefCfa(int64_t Register, int64_t Offset) {
206 MCDwarfFrameInfo *CurFrame = getCurrentFrameInfo();
207 MCSymbol *Label = getContext().CreateTempSymbol();
209 MachineLocation Dest(MachineLocation::VirtualFP);
210 MachineLocation Source(Register, -Offset);
211 MCCFIInstruction Instruction(Label, Dest, Source);
212 CurFrame->Instructions.push_back(Instruction);
215 void MCStreamer::EmitCFIDefCfaOffset(int64_t Offset) {
217 MCDwarfFrameInfo *CurFrame = getCurrentFrameInfo();
218 MCSymbol *Label = getContext().CreateTempSymbol();
220 MachineLocation Dest(MachineLocation::VirtualFP);
221 MachineLocation Source(MachineLocation::VirtualFP, -Offset);
222 MCCFIInstruction Instruction(Label, Dest, Source);
223 CurFrame->Instructions.push_back(Instruction);
226 void MCStreamer::EmitCFIAdjustCfaOffset(int64_t Adjustment) {
228 MCDwarfFrameInfo *CurFrame = getCurrentFrameInfo();
229 MCSymbol *Label = getContext().CreateTempSymbol();
231 MachineLocation Dest(MachineLocation::VirtualFP);
232 MachineLocation Source(MachineLocation::VirtualFP, Adjustment);
233 MCCFIInstruction Instruction(MCCFIInstruction::RelMove, Label, Dest, Source);
234 CurFrame->Instructions.push_back(Instruction);
237 void MCStreamer::EmitCFIDefCfaRegister(int64_t Register) {
239 MCDwarfFrameInfo *CurFrame = getCurrentFrameInfo();
240 MCSymbol *Label = getContext().CreateTempSymbol();
242 MachineLocation Dest(Register);
243 MachineLocation Source(MachineLocation::VirtualFP);
244 MCCFIInstruction Instruction(Label, Dest, Source);
245 CurFrame->Instructions.push_back(Instruction);
248 void MCStreamer::EmitCFIOffset(int64_t Register, int64_t Offset) {
250 MCDwarfFrameInfo *CurFrame = getCurrentFrameInfo();
251 MCSymbol *Label = getContext().CreateTempSymbol();
253 MachineLocation Dest(Register, Offset);
254 MachineLocation Source(Register, Offset);
255 MCCFIInstruction Instruction(Label, Dest, Source);
256 CurFrame->Instructions.push_back(Instruction);
259 void MCStreamer::EmitCFIRelOffset(int64_t Register, int64_t Offset) {
261 MCDwarfFrameInfo *CurFrame = getCurrentFrameInfo();
262 MCSymbol *Label = getContext().CreateTempSymbol();
264 MachineLocation Dest(Register, Offset);
265 MachineLocation Source(Register, Offset);
266 MCCFIInstruction Instruction(MCCFIInstruction::RelMove, Label, Dest, Source);
267 CurFrame->Instructions.push_back(Instruction);
270 void MCStreamer::EmitCFIPersonality(const MCSymbol *Sym,
273 MCDwarfFrameInfo *CurFrame = getCurrentFrameInfo();
274 CurFrame->Personality = Sym;
275 CurFrame->PersonalityEncoding = Encoding;
278 void MCStreamer::EmitCFILsda(const MCSymbol *Sym, unsigned Encoding) {
280 MCDwarfFrameInfo *CurFrame = getCurrentFrameInfo();
281 CurFrame->Lsda = Sym;
282 CurFrame->LsdaEncoding = Encoding;
285 void MCStreamer::EmitCFIRememberState() {
287 MCDwarfFrameInfo *CurFrame = getCurrentFrameInfo();
288 MCSymbol *Label = getContext().CreateTempSymbol();
290 MCCFIInstruction Instruction(MCCFIInstruction::Remember, Label);
291 CurFrame->Instructions.push_back(Instruction);
294 void MCStreamer::EmitCFIRestoreState() {
295 // FIXME: Error if there is no matching cfi_remember_state.
297 MCDwarfFrameInfo *CurFrame = getCurrentFrameInfo();
298 MCSymbol *Label = getContext().CreateTempSymbol();
300 MCCFIInstruction Instruction(MCCFIInstruction::Restore, Label);
301 CurFrame->Instructions.push_back(Instruction);
304 void MCStreamer::EmitCFISameValue(int64_t Register) {
306 MCDwarfFrameInfo *CurFrame = getCurrentFrameInfo();
307 MCSymbol *Label = getContext().CreateTempSymbol();
309 MCCFIInstruction Instruction(MCCFIInstruction::SameValue, Label, Register);
310 CurFrame->Instructions.push_back(Instruction);
313 void MCStreamer::setCurrentW64UnwindInfo(MCWin64EHUnwindInfo *Frame) {
314 W64UnwindInfos.push_back(Frame);
315 CurrentW64UnwindInfo = W64UnwindInfos.back();
318 void MCStreamer::EnsureValidW64UnwindInfo() {
319 MCWin64EHUnwindInfo *CurFrame = CurrentW64UnwindInfo;
320 if (!CurFrame || CurFrame->End)
321 report_fatal_error("No open Win64 EH frame function!");
324 void MCStreamer::EmitWin64EHStartProc(const MCSymbol *Symbol) {
325 MCWin64EHUnwindInfo *CurFrame = CurrentW64UnwindInfo;
326 if (CurFrame && !CurFrame->End)
327 report_fatal_error("Starting a function before ending the previous one!");
328 MCWin64EHUnwindInfo *Frame = new MCWin64EHUnwindInfo;
329 Frame->Begin = getContext().CreateTempSymbol();
330 Frame->Function = Symbol;
331 EmitLabel(Frame->Begin);
332 setCurrentW64UnwindInfo(Frame);
335 void MCStreamer::EmitWin64EHEndProc() {
336 EnsureValidW64UnwindInfo();
337 MCWin64EHUnwindInfo *CurFrame = CurrentW64UnwindInfo;
338 if (CurFrame->ChainedParent)
339 report_fatal_error("Not all chained regions terminated!");
340 CurFrame->End = getContext().CreateTempSymbol();
341 EmitLabel(CurFrame->End);
344 void MCStreamer::EmitWin64EHStartChained() {
345 EnsureValidW64UnwindInfo();
346 MCWin64EHUnwindInfo *Frame = new MCWin64EHUnwindInfo;
347 MCWin64EHUnwindInfo *CurFrame = CurrentW64UnwindInfo;
348 Frame->Begin = getContext().CreateTempSymbol();
349 Frame->Function = CurFrame->Function;
350 Frame->ChainedParent = CurFrame;
351 EmitLabel(Frame->Begin);
352 setCurrentW64UnwindInfo(Frame);
355 void MCStreamer::EmitWin64EHEndChained() {
356 EnsureValidW64UnwindInfo();
357 MCWin64EHUnwindInfo *CurFrame = CurrentW64UnwindInfo;
358 if (!CurFrame->ChainedParent)
359 report_fatal_error("End of a chained region outside a chained region!");
360 CurFrame->End = getContext().CreateTempSymbol();
361 EmitLabel(CurFrame->End);
362 CurrentW64UnwindInfo = CurFrame->ChainedParent;
365 void MCStreamer::EmitWin64EHHandler(const MCSymbol *Sym, bool Unwind,
367 EnsureValidW64UnwindInfo();
368 MCWin64EHUnwindInfo *CurFrame = CurrentW64UnwindInfo;
369 if (CurFrame->ChainedParent)
370 report_fatal_error("Chained unwind areas can't have handlers!");
371 CurFrame->ExceptionHandler = Sym;
372 if (!Except && !Unwind)
373 report_fatal_error("Don't know what kind of handler this is!");
375 CurFrame->HandlesUnwind = true;
377 CurFrame->HandlesExceptions = true;
380 void MCStreamer::EmitWin64EHHandlerData() {
381 EnsureValidW64UnwindInfo();
382 MCWin64EHUnwindInfo *CurFrame = CurrentW64UnwindInfo;
383 if (CurFrame->ChainedParent)
384 report_fatal_error("Chained unwind areas can't have handlers!");
387 void MCStreamer::EmitWin64EHPushReg(unsigned Register) {
388 EnsureValidW64UnwindInfo();
389 MCWin64EHUnwindInfo *CurFrame = CurrentW64UnwindInfo;
390 MCSymbol *Label = getContext().CreateTempSymbol();
391 MCWin64EHInstruction Inst(Win64EH::UOP_PushNonVol, Label, Register);
393 CurFrame->Instructions.push_back(Inst);
396 void MCStreamer::EmitWin64EHSetFrame(unsigned Register, unsigned Offset) {
397 EnsureValidW64UnwindInfo();
398 MCWin64EHUnwindInfo *CurFrame = CurrentW64UnwindInfo;
399 if (CurFrame->LastFrameInst >= 0)
400 report_fatal_error("Frame register and offset already specified!");
402 report_fatal_error("Misaligned frame pointer offset!");
403 MCWin64EHInstruction Inst(Win64EH::UOP_SetFPReg, NULL, Register, Offset);
404 CurFrame->LastFrameInst = CurFrame->Instructions.size();
405 CurFrame->Instructions.push_back(Inst);
408 void MCStreamer::EmitWin64EHAllocStack(unsigned Size) {
409 EnsureValidW64UnwindInfo();
411 report_fatal_error("Misaligned stack allocation!");
412 MCWin64EHUnwindInfo *CurFrame = CurrentW64UnwindInfo;
413 MCSymbol *Label = getContext().CreateTempSymbol();
414 MCWin64EHInstruction Inst(Label, Size);
416 CurFrame->Instructions.push_back(Inst);
419 void MCStreamer::EmitWin64EHSaveReg(unsigned Register, unsigned Offset) {
420 EnsureValidW64UnwindInfo();
422 report_fatal_error("Misaligned saved register offset!");
423 MCWin64EHUnwindInfo *CurFrame = CurrentW64UnwindInfo;
424 MCSymbol *Label = getContext().CreateTempSymbol();
425 MCWin64EHInstruction Inst(
426 Offset > 512*1024-8 ? Win64EH::UOP_SaveNonVolBig : Win64EH::UOP_SaveNonVol,
427 Label, Register, Offset);
429 CurFrame->Instructions.push_back(Inst);
432 void MCStreamer::EmitWin64EHSaveXMM(unsigned Register, unsigned Offset) {
433 EnsureValidW64UnwindInfo();
435 report_fatal_error("Misaligned saved vector register offset!");
436 MCWin64EHUnwindInfo *CurFrame = CurrentW64UnwindInfo;
437 MCSymbol *Label = getContext().CreateTempSymbol();
438 MCWin64EHInstruction Inst(
439 Offset > 512*1024-16 ? Win64EH::UOP_SaveXMM128Big : Win64EH::UOP_SaveXMM128,
440 Label, Register, Offset);
442 CurFrame->Instructions.push_back(Inst);
445 void MCStreamer::EmitWin64EHPushFrame(bool Code) {
446 EnsureValidW64UnwindInfo();
447 MCWin64EHUnwindInfo *CurFrame = CurrentW64UnwindInfo;
448 if (CurFrame->Instructions.size() > 0)
449 report_fatal_error("If present, PushMachFrame must be the first UOP");
450 MCSymbol *Label = getContext().CreateTempSymbol();
451 MCWin64EHInstruction Inst(Win64EH::UOP_PushMachFrame, Label, Code);
453 CurFrame->Instructions.push_back(Inst);
456 void MCStreamer::EmitWin64EHEndProlog() {
457 EnsureValidW64UnwindInfo();
458 MCWin64EHUnwindInfo *CurFrame = CurrentW64UnwindInfo;
459 CurFrame->PrologEnd = getContext().CreateTempSymbol();
460 EmitLabel(CurFrame->PrologEnd);
463 void MCStreamer::EmitFnStart() {
464 errs() << "Not implemented yet\n";
468 void MCStreamer::EmitFnEnd() {
469 errs() << "Not implemented yet\n";
473 void MCStreamer::EmitCantUnwind() {
474 errs() << "Not implemented yet\n";
478 void MCStreamer::EmitHandlerData() {
479 errs() << "Not implemented yet\n";
483 void MCStreamer::EmitPersonality(const MCSymbol *Personality) {
484 errs() << "Not implemented yet\n";
488 void MCStreamer::EmitSetFP(unsigned FpReg, unsigned SpReg, int64_t Offset) {
489 errs() << "Not implemented yet\n";
493 void MCStreamer::EmitPad(int64_t Offset) {
494 errs() << "Not implemented yet\n";
498 void MCStreamer::EmitRegSave(const SmallVectorImpl<unsigned> &RegList, bool) {
499 errs() << "Not implemented yet\n";
503 /// EmitRawText - If this file is backed by an assembly streamer, this dumps
504 /// the specified string in the output .s file. This capability is
505 /// indicated by the hasRawTextSupport() predicate.
506 void MCStreamer::EmitRawText(StringRef String) {
507 errs() << "EmitRawText called on an MCStreamer that doesn't support it, "
508 " something must not be fully mc'ized\n";
512 void MCStreamer::EmitRawText(const Twine &T) {
513 SmallString<128> Str;
515 EmitRawText(Str.str());
518 void MCStreamer::EmitFrames(bool usingCFI) {
519 if (!getNumFrameInfos())
523 MCDwarfFrameEmitter::Emit(*this, usingCFI, true);
526 MCDwarfFrameEmitter::Emit(*this, usingCFI, false);
529 void MCStreamer::EmitW64Tables() {
530 if (!getNumW64UnwindInfos())
533 MCWin64EHUnwindEmitter::Emit(*this);