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());
177 void MCStreamer::EmitCompactUnwindEncoding(uint32_t CompactUnwindEncoding) {
179 MCDwarfFrameInfo *CurFrame = getCurrentFrameInfo();
180 CurFrame->CompactUnwindEncoding = CompactUnwindEncoding;
183 void MCStreamer::EmitCFISections(bool EH, bool Debug) {
186 EmitDebugFrame = Debug;
189 void MCStreamer::EmitCFIStartProc() {
190 MCDwarfFrameInfo *CurFrame = getCurrentFrameInfo();
191 if (CurFrame && !CurFrame->End)
192 report_fatal_error("Starting a frame before finishing the previous one!");
193 MCDwarfFrameInfo Frame;
195 Frame.Function = LastSymbol;
197 // If the function is externally visible, we need to create a local
198 // symbol to avoid relocations.
199 StringRef Prefix = getContext().getAsmInfo().getPrivateGlobalPrefix();
200 if (LastSymbol->getName().startswith(Prefix)) {
201 Frame.Begin = LastSymbol;
203 Frame.Begin = getContext().CreateTempSymbol();
204 EmitLabel(Frame.Begin);
207 FrameInfos.push_back(Frame);
210 void MCStreamer::EmitCFIEndProc() {
212 MCDwarfFrameInfo *CurFrame = getCurrentFrameInfo();
213 CurFrame->End = getContext().CreateTempSymbol();
214 EmitLabel(CurFrame->End);
217 void MCStreamer::EmitCFIDefCfa(int64_t Register, int64_t Offset) {
219 MCDwarfFrameInfo *CurFrame = getCurrentFrameInfo();
220 MCSymbol *Label = getContext().CreateTempSymbol();
222 MachineLocation Dest(MachineLocation::VirtualFP);
223 MachineLocation Source(Register, -Offset);
224 MCCFIInstruction Instruction(Label, Dest, Source);
225 CurFrame->Instructions.push_back(Instruction);
228 void MCStreamer::EmitCFIDefCfaOffset(int64_t Offset) {
230 MCDwarfFrameInfo *CurFrame = getCurrentFrameInfo();
231 MCSymbol *Label = getContext().CreateTempSymbol();
233 MachineLocation Dest(MachineLocation::VirtualFP);
234 MachineLocation Source(MachineLocation::VirtualFP, -Offset);
235 MCCFIInstruction Instruction(Label, Dest, Source);
236 CurFrame->Instructions.push_back(Instruction);
239 void MCStreamer::EmitCFIAdjustCfaOffset(int64_t Adjustment) {
241 MCDwarfFrameInfo *CurFrame = getCurrentFrameInfo();
242 MCSymbol *Label = getContext().CreateTempSymbol();
244 MachineLocation Dest(MachineLocation::VirtualFP);
245 MachineLocation Source(MachineLocation::VirtualFP, Adjustment);
246 MCCFIInstruction Instruction(MCCFIInstruction::RelMove, Label, Dest, Source);
247 CurFrame->Instructions.push_back(Instruction);
250 void MCStreamer::EmitCFIDefCfaRegister(int64_t Register) {
252 MCDwarfFrameInfo *CurFrame = getCurrentFrameInfo();
253 MCSymbol *Label = getContext().CreateTempSymbol();
255 MachineLocation Dest(Register);
256 MachineLocation Source(MachineLocation::VirtualFP);
257 MCCFIInstruction Instruction(Label, Dest, Source);
258 CurFrame->Instructions.push_back(Instruction);
261 void MCStreamer::EmitCFIOffset(int64_t Register, int64_t Offset) {
263 MCDwarfFrameInfo *CurFrame = getCurrentFrameInfo();
264 MCSymbol *Label = getContext().CreateTempSymbol();
266 MachineLocation Dest(Register, Offset);
267 MachineLocation Source(Register, Offset);
268 MCCFIInstruction Instruction(Label, Dest, Source);
269 CurFrame->Instructions.push_back(Instruction);
272 void MCStreamer::EmitCFIRelOffset(int64_t Register, int64_t Offset) {
274 MCDwarfFrameInfo *CurFrame = getCurrentFrameInfo();
275 MCSymbol *Label = getContext().CreateTempSymbol();
277 MachineLocation Dest(Register, Offset);
278 MachineLocation Source(Register, Offset);
279 MCCFIInstruction Instruction(MCCFIInstruction::RelMove, Label, Dest, Source);
280 CurFrame->Instructions.push_back(Instruction);
283 void MCStreamer::EmitCFIPersonality(const MCSymbol *Sym,
286 MCDwarfFrameInfo *CurFrame = getCurrentFrameInfo();
287 CurFrame->Personality = Sym;
288 CurFrame->PersonalityEncoding = Encoding;
291 void MCStreamer::EmitCFILsda(const MCSymbol *Sym, unsigned Encoding) {
293 MCDwarfFrameInfo *CurFrame = getCurrentFrameInfo();
294 CurFrame->Lsda = Sym;
295 CurFrame->LsdaEncoding = Encoding;
298 void MCStreamer::EmitCFIRememberState() {
300 MCDwarfFrameInfo *CurFrame = getCurrentFrameInfo();
301 MCSymbol *Label = getContext().CreateTempSymbol();
303 MCCFIInstruction Instruction(MCCFIInstruction::Remember, Label);
304 CurFrame->Instructions.push_back(Instruction);
307 void MCStreamer::EmitCFIRestoreState() {
308 // FIXME: Error if there is no matching cfi_remember_state.
310 MCDwarfFrameInfo *CurFrame = getCurrentFrameInfo();
311 MCSymbol *Label = getContext().CreateTempSymbol();
313 MCCFIInstruction Instruction(MCCFIInstruction::Restore, Label);
314 CurFrame->Instructions.push_back(Instruction);
317 void MCStreamer::EmitCFISameValue(int64_t Register) {
319 MCDwarfFrameInfo *CurFrame = getCurrentFrameInfo();
320 MCSymbol *Label = getContext().CreateTempSymbol();
322 MCCFIInstruction Instruction(MCCFIInstruction::SameValue, Label, Register);
323 CurFrame->Instructions.push_back(Instruction);
326 void MCStreamer::setCurrentW64UnwindInfo(MCWin64EHUnwindInfo *Frame) {
327 W64UnwindInfos.push_back(Frame);
328 CurrentW64UnwindInfo = W64UnwindInfos.back();
331 void MCStreamer::EnsureValidW64UnwindInfo() {
332 MCWin64EHUnwindInfo *CurFrame = CurrentW64UnwindInfo;
333 if (!CurFrame || CurFrame->End)
334 report_fatal_error("No open Win64 EH frame function!");
337 void MCStreamer::EmitWin64EHStartProc(const MCSymbol *Symbol) {
338 MCWin64EHUnwindInfo *CurFrame = CurrentW64UnwindInfo;
339 if (CurFrame && !CurFrame->End)
340 report_fatal_error("Starting a function before ending the previous one!");
341 MCWin64EHUnwindInfo *Frame = new MCWin64EHUnwindInfo;
342 Frame->Begin = getContext().CreateTempSymbol();
343 Frame->Function = Symbol;
344 EmitLabel(Frame->Begin);
345 setCurrentW64UnwindInfo(Frame);
348 void MCStreamer::EmitWin64EHEndProc() {
349 EnsureValidW64UnwindInfo();
350 MCWin64EHUnwindInfo *CurFrame = CurrentW64UnwindInfo;
351 if (CurFrame->ChainedParent)
352 report_fatal_error("Not all chained regions terminated!");
353 CurFrame->End = getContext().CreateTempSymbol();
354 EmitLabel(CurFrame->End);
357 void MCStreamer::EmitWin64EHStartChained() {
358 EnsureValidW64UnwindInfo();
359 MCWin64EHUnwindInfo *Frame = new MCWin64EHUnwindInfo;
360 MCWin64EHUnwindInfo *CurFrame = CurrentW64UnwindInfo;
361 Frame->Begin = getContext().CreateTempSymbol();
362 Frame->Function = CurFrame->Function;
363 Frame->ChainedParent = CurFrame;
364 EmitLabel(Frame->Begin);
365 setCurrentW64UnwindInfo(Frame);
368 void MCStreamer::EmitWin64EHEndChained() {
369 EnsureValidW64UnwindInfo();
370 MCWin64EHUnwindInfo *CurFrame = CurrentW64UnwindInfo;
371 if (!CurFrame->ChainedParent)
372 report_fatal_error("End of a chained region outside a chained region!");
373 CurFrame->End = getContext().CreateTempSymbol();
374 EmitLabel(CurFrame->End);
375 CurrentW64UnwindInfo = CurFrame->ChainedParent;
378 void MCStreamer::EmitWin64EHHandler(const MCSymbol *Sym, bool Unwind,
380 EnsureValidW64UnwindInfo();
381 MCWin64EHUnwindInfo *CurFrame = CurrentW64UnwindInfo;
382 if (CurFrame->ChainedParent)
383 report_fatal_error("Chained unwind areas can't have handlers!");
384 CurFrame->ExceptionHandler = Sym;
385 if (!Except && !Unwind)
386 report_fatal_error("Don't know what kind of handler this is!");
388 CurFrame->HandlesUnwind = true;
390 CurFrame->HandlesExceptions = true;
393 void MCStreamer::EmitWin64EHHandlerData() {
394 EnsureValidW64UnwindInfo();
395 MCWin64EHUnwindInfo *CurFrame = CurrentW64UnwindInfo;
396 if (CurFrame->ChainedParent)
397 report_fatal_error("Chained unwind areas can't have handlers!");
400 void MCStreamer::EmitWin64EHPushReg(unsigned Register) {
401 EnsureValidW64UnwindInfo();
402 MCWin64EHUnwindInfo *CurFrame = CurrentW64UnwindInfo;
403 MCSymbol *Label = getContext().CreateTempSymbol();
404 MCWin64EHInstruction Inst(Win64EH::UOP_PushNonVol, Label, Register);
406 CurFrame->Instructions.push_back(Inst);
409 void MCStreamer::EmitWin64EHSetFrame(unsigned Register, unsigned Offset) {
410 EnsureValidW64UnwindInfo();
411 MCWin64EHUnwindInfo *CurFrame = CurrentW64UnwindInfo;
412 if (CurFrame->LastFrameInst >= 0)
413 report_fatal_error("Frame register and offset already specified!");
415 report_fatal_error("Misaligned frame pointer offset!");
416 MCWin64EHInstruction Inst(Win64EH::UOP_SetFPReg, NULL, Register, Offset);
417 CurFrame->LastFrameInst = CurFrame->Instructions.size();
418 CurFrame->Instructions.push_back(Inst);
421 void MCStreamer::EmitWin64EHAllocStack(unsigned Size) {
422 EnsureValidW64UnwindInfo();
424 report_fatal_error("Misaligned stack allocation!");
425 MCWin64EHUnwindInfo *CurFrame = CurrentW64UnwindInfo;
426 MCSymbol *Label = getContext().CreateTempSymbol();
427 MCWin64EHInstruction Inst(Label, Size);
429 CurFrame->Instructions.push_back(Inst);
432 void MCStreamer::EmitWin64EHSaveReg(unsigned Register, unsigned Offset) {
433 EnsureValidW64UnwindInfo();
435 report_fatal_error("Misaligned saved register offset!");
436 MCWin64EHUnwindInfo *CurFrame = CurrentW64UnwindInfo;
437 MCSymbol *Label = getContext().CreateTempSymbol();
438 MCWin64EHInstruction Inst(
439 Offset > 512*1024-8 ? Win64EH::UOP_SaveNonVolBig : Win64EH::UOP_SaveNonVol,
440 Label, Register, Offset);
442 CurFrame->Instructions.push_back(Inst);
445 void MCStreamer::EmitWin64EHSaveXMM(unsigned Register, unsigned Offset) {
446 EnsureValidW64UnwindInfo();
448 report_fatal_error("Misaligned saved vector register offset!");
449 MCWin64EHUnwindInfo *CurFrame = CurrentW64UnwindInfo;
450 MCSymbol *Label = getContext().CreateTempSymbol();
451 MCWin64EHInstruction Inst(
452 Offset > 512*1024-16 ? Win64EH::UOP_SaveXMM128Big : Win64EH::UOP_SaveXMM128,
453 Label, Register, Offset);
455 CurFrame->Instructions.push_back(Inst);
458 void MCStreamer::EmitWin64EHPushFrame(bool Code) {
459 EnsureValidW64UnwindInfo();
460 MCWin64EHUnwindInfo *CurFrame = CurrentW64UnwindInfo;
461 if (CurFrame->Instructions.size() > 0)
462 report_fatal_error("If present, PushMachFrame must be the first UOP");
463 MCSymbol *Label = getContext().CreateTempSymbol();
464 MCWin64EHInstruction Inst(Win64EH::UOP_PushMachFrame, Label, Code);
466 CurFrame->Instructions.push_back(Inst);
469 void MCStreamer::EmitWin64EHEndProlog() {
470 EnsureValidW64UnwindInfo();
471 MCWin64EHUnwindInfo *CurFrame = CurrentW64UnwindInfo;
472 CurFrame->PrologEnd = getContext().CreateTempSymbol();
473 EmitLabel(CurFrame->PrologEnd);
476 void MCStreamer::EmitFnStart() {
477 errs() << "Not implemented yet\n";
481 void MCStreamer::EmitFnEnd() {
482 errs() << "Not implemented yet\n";
486 void MCStreamer::EmitCantUnwind() {
487 errs() << "Not implemented yet\n";
491 void MCStreamer::EmitHandlerData() {
492 errs() << "Not implemented yet\n";
496 void MCStreamer::EmitPersonality(const MCSymbol *Personality) {
497 errs() << "Not implemented yet\n";
501 void MCStreamer::EmitSetFP(unsigned FpReg, unsigned SpReg, int64_t Offset) {
502 errs() << "Not implemented yet\n";
506 void MCStreamer::EmitPad(int64_t Offset) {
507 errs() << "Not implemented yet\n";
511 void MCStreamer::EmitRegSave(const SmallVectorImpl<unsigned> &RegList, bool) {
512 errs() << "Not implemented yet\n";
516 /// EmitRawText - If this file is backed by an assembly streamer, this dumps
517 /// the specified string in the output .s file. This capability is
518 /// indicated by the hasRawTextSupport() predicate.
519 void MCStreamer::EmitRawText(StringRef String) {
520 errs() << "EmitRawText called on an MCStreamer that doesn't support it, "
521 " something must not be fully mc'ized\n";
525 void MCStreamer::EmitRawText(const Twine &T) {
526 SmallString<128> Str;
528 EmitRawText(Str.str());
531 void MCStreamer::EmitFrames(bool usingCFI) {
532 if (!getNumFrameInfos())
536 MCDwarfFrameEmitter::Emit(*this, usingCFI, true);
539 MCDwarfFrameEmitter::Emit(*this, usingCFI, false);
542 void MCStreamer::EmitW64Tables() {
543 if (!getNumW64UnwindInfos())
546 MCWin64EHUnwindEmitter::Emit(*this);