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)
24 : Context(Ctx), EmitEHFrame(true), EmitDebugFrame(false),
25 CurrentW64UnwindInfo(0), LastSymbol(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,
96 raw_svector_ostream OSE(Tmp);
97 MCObjectWriter::EncodeULEB128(Value, OSE, Padding);
98 EmitBytes(OSE.str(), AddrSpace);
101 /// EmitSLEB128Value - Special case of EmitSLEB128Value that avoids the
102 /// client having to pass in a MCExpr for constant integers.
103 void MCStreamer::EmitSLEB128IntValue(int64_t Value, unsigned AddrSpace) {
104 SmallString<128> Tmp;
105 raw_svector_ostream OSE(Tmp);
106 MCObjectWriter::EncodeSLEB128(Value, OSE);
107 EmitBytes(OSE.str(), AddrSpace);
110 void MCStreamer::EmitAbsValue(const MCExpr *Value, unsigned Size,
111 unsigned AddrSpace) {
112 const MCExpr *ABS = ForceExpAbs(Value);
113 EmitValue(ABS, Size, AddrSpace);
117 void MCStreamer::EmitValue(const MCExpr *Value, unsigned Size,
118 unsigned AddrSpace) {
119 EmitValueImpl(Value, Size, AddrSpace);
122 void MCStreamer::EmitSymbolValue(const MCSymbol *Sym, unsigned Size,
123 unsigned AddrSpace) {
124 EmitValueImpl(MCSymbolRefExpr::Create(Sym, getContext()), Size,
128 void MCStreamer::EmitGPRel64Value(const MCExpr *Value) {
129 report_fatal_error("unsupported directive in streamer");
132 void MCStreamer::EmitGPRel32Value(const MCExpr *Value) {
133 report_fatal_error("unsupported directive in streamer");
136 /// EmitFill - Emit NumBytes bytes worth of the value specified by
137 /// FillValue. This implements directives such as '.space'.
138 void MCStreamer::EmitFill(uint64_t NumBytes, uint8_t FillValue,
139 unsigned AddrSpace) {
140 const MCExpr *E = MCConstantExpr::Create(FillValue, getContext());
141 for (uint64_t i = 0, e = NumBytes; i != e; ++i)
142 EmitValue(E, 1, AddrSpace);
145 bool MCStreamer::EmitDwarfFileDirective(unsigned FileNo,
147 StringRef Filename) {
148 return getContext().GetDwarfFile(Directory, Filename, FileNo) == 0;
151 void MCStreamer::EmitDwarfLocDirective(unsigned FileNo, unsigned Line,
152 unsigned Column, unsigned Flags,
154 unsigned Discriminator,
155 StringRef FileName) {
156 getContext().setCurrentDwarfLoc(FileNo, Line, Column, Flags, Isa,
160 MCDwarfFrameInfo *MCStreamer::getCurrentFrameInfo() {
161 if (FrameInfos.empty())
163 return &FrameInfos.back();
166 void MCStreamer::EnsureValidFrame() {
167 MCDwarfFrameInfo *CurFrame = getCurrentFrameInfo();
168 if (!CurFrame || CurFrame->End)
169 report_fatal_error("No open frame");
172 void MCStreamer::EmitEHSymAttributes(const MCSymbol *Symbol,
173 MCSymbol *EHSymbol) {
176 void MCStreamer::EmitLabel(MCSymbol *Symbol) {
177 assert(!Symbol->isVariable() && "Cannot emit a variable symbol!");
178 assert(getCurrentSection() && "Cannot emit before setting section!");
179 Symbol->setSection(*getCurrentSection());
183 void MCStreamer::EmitCompactUnwindEncoding(uint32_t CompactUnwindEncoding) {
185 MCDwarfFrameInfo *CurFrame = getCurrentFrameInfo();
186 CurFrame->CompactUnwindEncoding = CompactUnwindEncoding;
189 void MCStreamer::EmitCFISections(bool EH, bool Debug) {
192 EmitDebugFrame = Debug;
195 void MCStreamer::EmitCFIStartProc() {
196 MCDwarfFrameInfo *CurFrame = getCurrentFrameInfo();
197 if (CurFrame && !CurFrame->End)
198 report_fatal_error("Starting a frame before finishing the previous one!");
200 MCDwarfFrameInfo Frame;
201 EmitCFIStartProcImpl(Frame);
203 FrameInfos.push_back(Frame);
206 void MCStreamer::EmitCFIStartProcImpl(MCDwarfFrameInfo &Frame) {
209 void MCStreamer::RecordProcStart(MCDwarfFrameInfo &Frame) {
210 Frame.Function = LastSymbol;
211 // If the function is externally visible, we need to create a local
212 // symbol to avoid relocations.
213 StringRef Prefix = getContext().getAsmInfo().getPrivateGlobalPrefix();
214 if (LastSymbol && LastSymbol->getName().startswith(Prefix)) {
215 Frame.Begin = LastSymbol;
217 Frame.Begin = getContext().CreateTempSymbol();
218 EmitLabel(Frame.Begin);
222 void MCStreamer::EmitCFIEndProc() {
224 MCDwarfFrameInfo *CurFrame = getCurrentFrameInfo();
225 EmitCFIEndProcImpl(*CurFrame);
228 void MCStreamer::EmitCFIEndProcImpl(MCDwarfFrameInfo &Frame) {
231 void MCStreamer::RecordProcEnd(MCDwarfFrameInfo &Frame) {
232 Frame.End = getContext().CreateTempSymbol();
233 EmitLabel(Frame.End);
236 void MCStreamer::EmitCFIDefCfa(int64_t Register, int64_t Offset) {
238 MCDwarfFrameInfo *CurFrame = getCurrentFrameInfo();
239 MCSymbol *Label = getContext().CreateTempSymbol();
241 MachineLocation Dest(MachineLocation::VirtualFP);
242 MachineLocation Source(Register, -Offset);
243 MCCFIInstruction Instruction(Label, Dest, Source);
244 CurFrame->Instructions.push_back(Instruction);
247 void MCStreamer::EmitCFIDefCfaOffset(int64_t Offset) {
249 MCDwarfFrameInfo *CurFrame = getCurrentFrameInfo();
250 MCSymbol *Label = getContext().CreateTempSymbol();
252 MachineLocation Dest(MachineLocation::VirtualFP);
253 MachineLocation Source(MachineLocation::VirtualFP, -Offset);
254 MCCFIInstruction Instruction(Label, Dest, Source);
255 CurFrame->Instructions.push_back(Instruction);
258 void MCStreamer::EmitCFIAdjustCfaOffset(int64_t Adjustment) {
260 MCDwarfFrameInfo *CurFrame = getCurrentFrameInfo();
261 MCSymbol *Label = getContext().CreateTempSymbol();
263 MachineLocation Dest(MachineLocation::VirtualFP);
264 MachineLocation Source(MachineLocation::VirtualFP, Adjustment);
265 MCCFIInstruction Instruction(MCCFIInstruction::RelMove, Label, Dest, Source);
266 CurFrame->Instructions.push_back(Instruction);
269 void MCStreamer::EmitCFIDefCfaRegister(int64_t Register) {
271 MCDwarfFrameInfo *CurFrame = getCurrentFrameInfo();
272 MCSymbol *Label = getContext().CreateTempSymbol();
274 MachineLocation Dest(Register);
275 MachineLocation Source(MachineLocation::VirtualFP);
276 MCCFIInstruction Instruction(Label, Dest, Source);
277 CurFrame->Instructions.push_back(Instruction);
280 void MCStreamer::EmitCFIOffset(int64_t Register, int64_t Offset) {
282 MCDwarfFrameInfo *CurFrame = getCurrentFrameInfo();
283 MCSymbol *Label = getContext().CreateTempSymbol();
285 MachineLocation Dest(Register, Offset);
286 MachineLocation Source(Register, Offset);
287 MCCFIInstruction Instruction(Label, Dest, Source);
288 CurFrame->Instructions.push_back(Instruction);
291 void MCStreamer::EmitCFIRelOffset(int64_t Register, int64_t Offset) {
293 MCDwarfFrameInfo *CurFrame = getCurrentFrameInfo();
294 MCSymbol *Label = getContext().CreateTempSymbol();
296 MachineLocation Dest(Register, Offset);
297 MachineLocation Source(Register, Offset);
298 MCCFIInstruction Instruction(MCCFIInstruction::RelMove, Label, Dest, Source);
299 CurFrame->Instructions.push_back(Instruction);
302 void MCStreamer::EmitCFIPersonality(const MCSymbol *Sym,
305 MCDwarfFrameInfo *CurFrame = getCurrentFrameInfo();
306 CurFrame->Personality = Sym;
307 CurFrame->PersonalityEncoding = Encoding;
310 void MCStreamer::EmitCFILsda(const MCSymbol *Sym, unsigned Encoding) {
312 MCDwarfFrameInfo *CurFrame = getCurrentFrameInfo();
313 CurFrame->Lsda = Sym;
314 CurFrame->LsdaEncoding = Encoding;
317 void MCStreamer::EmitCFIRememberState() {
319 MCDwarfFrameInfo *CurFrame = getCurrentFrameInfo();
320 MCSymbol *Label = getContext().CreateTempSymbol();
322 MCCFIInstruction Instruction(MCCFIInstruction::RememberState, Label);
323 CurFrame->Instructions.push_back(Instruction);
326 void MCStreamer::EmitCFIRestoreState() {
327 // FIXME: Error if there is no matching cfi_remember_state.
329 MCDwarfFrameInfo *CurFrame = getCurrentFrameInfo();
330 MCSymbol *Label = getContext().CreateTempSymbol();
332 MCCFIInstruction Instruction(MCCFIInstruction::RestoreState, Label);
333 CurFrame->Instructions.push_back(Instruction);
336 void MCStreamer::EmitCFISameValue(int64_t Register) {
338 MCDwarfFrameInfo *CurFrame = getCurrentFrameInfo();
339 MCSymbol *Label = getContext().CreateTempSymbol();
341 MCCFIInstruction Instruction(MCCFIInstruction::SameValue, Label, Register);
342 CurFrame->Instructions.push_back(Instruction);
345 void MCStreamer::EmitCFIRestore(int64_t Register) {
347 MCDwarfFrameInfo *CurFrame = getCurrentFrameInfo();
348 MCSymbol *Label = getContext().CreateTempSymbol();
350 MCCFIInstruction Instruction(MCCFIInstruction::Restore, Label, Register);
351 CurFrame->Instructions.push_back(Instruction);
354 void MCStreamer::EmitCFIEscape(StringRef Values) {
356 MCDwarfFrameInfo *CurFrame = getCurrentFrameInfo();
357 MCSymbol *Label = getContext().CreateTempSymbol();
359 MCCFIInstruction Instruction(MCCFIInstruction::Escape, Label, Values);
360 CurFrame->Instructions.push_back(Instruction);
363 void MCStreamer::EmitCFISignalFrame() {
365 MCDwarfFrameInfo *CurFrame = getCurrentFrameInfo();
366 CurFrame->IsSignalFrame = true;
369 void MCStreamer::setCurrentW64UnwindInfo(MCWin64EHUnwindInfo *Frame) {
370 W64UnwindInfos.push_back(Frame);
371 CurrentW64UnwindInfo = W64UnwindInfos.back();
374 void MCStreamer::EnsureValidW64UnwindInfo() {
375 MCWin64EHUnwindInfo *CurFrame = CurrentW64UnwindInfo;
376 if (!CurFrame || CurFrame->End)
377 report_fatal_error("No open Win64 EH frame function!");
380 void MCStreamer::EmitWin64EHStartProc(const MCSymbol *Symbol) {
381 MCWin64EHUnwindInfo *CurFrame = CurrentW64UnwindInfo;
382 if (CurFrame && !CurFrame->End)
383 report_fatal_error("Starting a function before ending the previous one!");
384 MCWin64EHUnwindInfo *Frame = new MCWin64EHUnwindInfo;
385 Frame->Begin = getContext().CreateTempSymbol();
386 Frame->Function = Symbol;
387 EmitLabel(Frame->Begin);
388 setCurrentW64UnwindInfo(Frame);
391 void MCStreamer::EmitWin64EHEndProc() {
392 EnsureValidW64UnwindInfo();
393 MCWin64EHUnwindInfo *CurFrame = CurrentW64UnwindInfo;
394 if (CurFrame->ChainedParent)
395 report_fatal_error("Not all chained regions terminated!");
396 CurFrame->End = getContext().CreateTempSymbol();
397 EmitLabel(CurFrame->End);
400 void MCStreamer::EmitWin64EHStartChained() {
401 EnsureValidW64UnwindInfo();
402 MCWin64EHUnwindInfo *Frame = new MCWin64EHUnwindInfo;
403 MCWin64EHUnwindInfo *CurFrame = CurrentW64UnwindInfo;
404 Frame->Begin = getContext().CreateTempSymbol();
405 Frame->Function = CurFrame->Function;
406 Frame->ChainedParent = CurFrame;
407 EmitLabel(Frame->Begin);
408 setCurrentW64UnwindInfo(Frame);
411 void MCStreamer::EmitWin64EHEndChained() {
412 EnsureValidW64UnwindInfo();
413 MCWin64EHUnwindInfo *CurFrame = CurrentW64UnwindInfo;
414 if (!CurFrame->ChainedParent)
415 report_fatal_error("End of a chained region outside a chained region!");
416 CurFrame->End = getContext().CreateTempSymbol();
417 EmitLabel(CurFrame->End);
418 CurrentW64UnwindInfo = CurFrame->ChainedParent;
421 void MCStreamer::EmitWin64EHHandler(const MCSymbol *Sym, bool Unwind,
423 EnsureValidW64UnwindInfo();
424 MCWin64EHUnwindInfo *CurFrame = CurrentW64UnwindInfo;
425 if (CurFrame->ChainedParent)
426 report_fatal_error("Chained unwind areas can't have handlers!");
427 CurFrame->ExceptionHandler = Sym;
428 if (!Except && !Unwind)
429 report_fatal_error("Don't know what kind of handler this is!");
431 CurFrame->HandlesUnwind = true;
433 CurFrame->HandlesExceptions = true;
436 void MCStreamer::EmitWin64EHHandlerData() {
437 EnsureValidW64UnwindInfo();
438 MCWin64EHUnwindInfo *CurFrame = CurrentW64UnwindInfo;
439 if (CurFrame->ChainedParent)
440 report_fatal_error("Chained unwind areas can't have handlers!");
443 void MCStreamer::EmitWin64EHPushReg(unsigned Register) {
444 EnsureValidW64UnwindInfo();
445 MCWin64EHUnwindInfo *CurFrame = CurrentW64UnwindInfo;
446 MCSymbol *Label = getContext().CreateTempSymbol();
447 MCWin64EHInstruction Inst(Win64EH::UOP_PushNonVol, Label, Register);
449 CurFrame->Instructions.push_back(Inst);
452 void MCStreamer::EmitWin64EHSetFrame(unsigned Register, unsigned Offset) {
453 EnsureValidW64UnwindInfo();
454 MCWin64EHUnwindInfo *CurFrame = CurrentW64UnwindInfo;
455 if (CurFrame->LastFrameInst >= 0)
456 report_fatal_error("Frame register and offset already specified!");
458 report_fatal_error("Misaligned frame pointer offset!");
459 MCWin64EHInstruction Inst(Win64EH::UOP_SetFPReg, NULL, Register, Offset);
460 CurFrame->LastFrameInst = CurFrame->Instructions.size();
461 CurFrame->Instructions.push_back(Inst);
464 void MCStreamer::EmitWin64EHAllocStack(unsigned Size) {
465 EnsureValidW64UnwindInfo();
467 report_fatal_error("Misaligned stack allocation!");
468 MCWin64EHUnwindInfo *CurFrame = CurrentW64UnwindInfo;
469 MCSymbol *Label = getContext().CreateTempSymbol();
470 MCWin64EHInstruction Inst(Label, Size);
472 CurFrame->Instructions.push_back(Inst);
475 void MCStreamer::EmitWin64EHSaveReg(unsigned Register, unsigned Offset) {
476 EnsureValidW64UnwindInfo();
478 report_fatal_error("Misaligned saved register offset!");
479 MCWin64EHUnwindInfo *CurFrame = CurrentW64UnwindInfo;
480 MCSymbol *Label = getContext().CreateTempSymbol();
481 MCWin64EHInstruction Inst(
482 Offset > 512*1024-8 ? Win64EH::UOP_SaveNonVolBig : Win64EH::UOP_SaveNonVol,
483 Label, Register, Offset);
485 CurFrame->Instructions.push_back(Inst);
488 void MCStreamer::EmitWin64EHSaveXMM(unsigned Register, unsigned Offset) {
489 EnsureValidW64UnwindInfo();
491 report_fatal_error("Misaligned saved vector register offset!");
492 MCWin64EHUnwindInfo *CurFrame = CurrentW64UnwindInfo;
493 MCSymbol *Label = getContext().CreateTempSymbol();
494 MCWin64EHInstruction Inst(
495 Offset > 512*1024-16 ? Win64EH::UOP_SaveXMM128Big : Win64EH::UOP_SaveXMM128,
496 Label, Register, Offset);
498 CurFrame->Instructions.push_back(Inst);
501 void MCStreamer::EmitWin64EHPushFrame(bool Code) {
502 EnsureValidW64UnwindInfo();
503 MCWin64EHUnwindInfo *CurFrame = CurrentW64UnwindInfo;
504 if (CurFrame->Instructions.size() > 0)
505 report_fatal_error("If present, PushMachFrame must be the first UOP");
506 MCSymbol *Label = getContext().CreateTempSymbol();
507 MCWin64EHInstruction Inst(Win64EH::UOP_PushMachFrame, Label, Code);
509 CurFrame->Instructions.push_back(Inst);
512 void MCStreamer::EmitWin64EHEndProlog() {
513 EnsureValidW64UnwindInfo();
514 MCWin64EHUnwindInfo *CurFrame = CurrentW64UnwindInfo;
515 CurFrame->PrologEnd = getContext().CreateTempSymbol();
516 EmitLabel(CurFrame->PrologEnd);
519 void MCStreamer::EmitCOFFSecRel32(MCSymbol const *Symbol) {
520 llvm_unreachable("This file format doesn't support this directive");
523 void MCStreamer::EmitFnStart() {
524 errs() << "Not implemented yet\n";
528 void MCStreamer::EmitFnEnd() {
529 errs() << "Not implemented yet\n";
533 void MCStreamer::EmitCantUnwind() {
534 errs() << "Not implemented yet\n";
538 void MCStreamer::EmitHandlerData() {
539 errs() << "Not implemented yet\n";
543 void MCStreamer::EmitPersonality(const MCSymbol *Personality) {
544 errs() << "Not implemented yet\n";
548 void MCStreamer::EmitSetFP(unsigned FpReg, unsigned SpReg, int64_t Offset) {
549 errs() << "Not implemented yet\n";
553 void MCStreamer::EmitPad(int64_t Offset) {
554 errs() << "Not implemented yet\n";
558 void MCStreamer::EmitRegSave(const SmallVectorImpl<unsigned> &RegList, bool) {
559 errs() << "Not implemented yet\n";
563 /// EmitRawText - If this file is backed by an assembly streamer, this dumps
564 /// the specified string in the output .s file. This capability is
565 /// indicated by the hasRawTextSupport() predicate.
566 void MCStreamer::EmitRawText(StringRef String) {
567 errs() << "EmitRawText called on an MCStreamer that doesn't support it, "
568 " something must not be fully mc'ized\n";
572 void MCStreamer::EmitRawText(const Twine &T) {
573 SmallString<128> Str;
575 EmitRawText(Str.str());
578 void MCStreamer::EmitFrames(bool usingCFI) {
579 if (!getNumFrameInfos())
583 MCDwarfFrameEmitter::Emit(*this, usingCFI, true);
586 MCDwarfFrameEmitter::Emit(*this, usingCFI, false);
589 void MCStreamer::EmitW64Tables() {
590 if (!getNumW64UnwindInfos())
593 MCWin64EHUnwindEmitter::Emit(*this);
596 void MCStreamer::Finish() {
597 if (!FrameInfos.empty() && !FrameInfos.back().End)
598 report_fatal_error("Unfinished frame!");