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/Support/LEB128.h"
19 #include "llvm/ADT/SmallString.h"
20 #include "llvm/ADT/Twine.h"
24 MCStreamer::MCStreamer(MCContext &Ctx)
25 : Context(Ctx), EmitEHFrame(true), EmitDebugFrame(false),
26 CurrentW64UnwindInfo(0), LastSymbol(0) {
27 const MCSection *section = NULL;
28 SectionStack.push_back(std::make_pair(section, section));
31 MCStreamer::~MCStreamer() {
32 for (unsigned i = 0; i < getNumW64UnwindInfos(); ++i)
33 delete W64UnwindInfos[i];
36 const MCExpr *MCStreamer::BuildSymbolDiff(MCContext &Context,
39 MCSymbolRefExpr::VariantKind Variant = MCSymbolRefExpr::VK_None;
41 MCSymbolRefExpr::Create(A, Variant, Context);
43 MCSymbolRefExpr::Create(B, Variant, Context);
44 const MCExpr *AddrDelta =
45 MCBinaryExpr::Create(MCBinaryExpr::Sub, ARef, BRef, Context);
49 const MCExpr *MCStreamer::ForceExpAbs(const MCExpr* Expr) {
50 if (Context.getAsmInfo().hasAggressiveSymbolFolding() ||
51 isa<MCSymbolRefExpr>(Expr))
54 MCSymbol *ABS = Context.CreateTempSymbol();
55 EmitAssignment(ABS, Expr);
56 return MCSymbolRefExpr::Create(ABS, Context);
59 raw_ostream &MCStreamer::GetCommentOS() {
60 // By default, discard comments.
64 void MCStreamer::EmitDwarfSetLineAddr(int64_t LineDelta,
65 const MCSymbol *Label, int PointerSize) {
66 // emit the sequence to set the address
67 EmitIntValue(dwarf::DW_LNS_extended_op, 1);
68 EmitULEB128IntValue(PointerSize + 1);
69 EmitIntValue(dwarf::DW_LNE_set_address, 1);
70 EmitSymbolValue(Label, PointerSize);
72 // emit the sequence for the LineDelta (from 1) and a zero address delta.
73 MCDwarfLineAddr::Emit(this, LineDelta, 0);
76 /// EmitIntValue - Special case of EmitValue that avoids the client having to
77 /// pass in a MCExpr for constant integers.
78 void MCStreamer::EmitIntValue(uint64_t Value, unsigned Size,
80 assert(Size <= 8 && "Invalid size");
81 assert((isUIntN(8 * Size, Value) || isIntN(8 * Size, Value)) &&
84 const bool isLittleEndian = Context.getAsmInfo().isLittleEndian();
85 for (unsigned i = 0; i != Size; ++i) {
86 unsigned index = isLittleEndian ? i : (Size - i - 1);
87 buf[i] = uint8_t(Value >> (index * 8));
89 EmitBytes(StringRef(buf, Size), AddrSpace);
92 /// EmitULEB128Value - Special case of EmitULEB128Value that avoids the
93 /// client having to pass in a MCExpr for constant integers.
94 void MCStreamer::EmitULEB128IntValue(uint64_t Value, unsigned AddrSpace,
97 raw_svector_ostream OSE(Tmp);
98 encodeULEB128(Value, OSE, Padding);
99 EmitBytes(OSE.str(), AddrSpace);
102 /// EmitSLEB128Value - Special case of EmitSLEB128Value that avoids the
103 /// client having to pass in a MCExpr for constant integers.
104 void MCStreamer::EmitSLEB128IntValue(int64_t Value, unsigned AddrSpace) {
105 SmallString<128> Tmp;
106 raw_svector_ostream OSE(Tmp);
107 encodeSLEB128(Value, OSE);
108 EmitBytes(OSE.str(), AddrSpace);
111 void MCStreamer::EmitAbsValue(const MCExpr *Value, unsigned Size,
112 unsigned AddrSpace) {
113 const MCExpr *ABS = ForceExpAbs(Value);
114 EmitValue(ABS, Size, AddrSpace);
118 void MCStreamer::EmitValue(const MCExpr *Value, unsigned Size,
119 unsigned AddrSpace) {
120 EmitValueImpl(Value, Size, AddrSpace);
123 void MCStreamer::EmitSymbolValue(const MCSymbol *Sym, unsigned Size,
124 unsigned AddrSpace) {
125 EmitValueImpl(MCSymbolRefExpr::Create(Sym, getContext()), Size,
129 void MCStreamer::EmitGPRel64Value(const MCExpr *Value) {
130 report_fatal_error("unsupported directive in streamer");
133 void MCStreamer::EmitGPRel32Value(const MCExpr *Value) {
134 report_fatal_error("unsupported directive in streamer");
137 /// EmitFill - Emit NumBytes bytes worth of the value specified by
138 /// FillValue. This implements directives such as '.space'.
139 void MCStreamer::EmitFill(uint64_t NumBytes, uint8_t FillValue,
140 unsigned AddrSpace) {
141 const MCExpr *E = MCConstantExpr::Create(FillValue, getContext());
142 for (uint64_t i = 0, e = NumBytes; i != e; ++i)
143 EmitValue(E, 1, AddrSpace);
146 bool MCStreamer::EmitDwarfFileDirective(unsigned FileNo,
148 StringRef Filename) {
149 return getContext().GetDwarfFile(Directory, Filename, FileNo) == 0;
152 void MCStreamer::EmitDwarfLocDirective(unsigned FileNo, unsigned Line,
153 unsigned Column, unsigned Flags,
155 unsigned Discriminator,
156 StringRef FileName) {
157 getContext().setCurrentDwarfLoc(FileNo, Line, Column, Flags, Isa,
161 MCDwarfFrameInfo *MCStreamer::getCurrentFrameInfo() {
162 if (FrameInfos.empty())
164 return &FrameInfos.back();
167 void MCStreamer::EnsureValidFrame() {
168 MCDwarfFrameInfo *CurFrame = getCurrentFrameInfo();
169 if (!CurFrame || CurFrame->End)
170 report_fatal_error("No open frame");
173 void MCStreamer::EmitEHSymAttributes(const MCSymbol *Symbol,
174 MCSymbol *EHSymbol) {
177 void MCStreamer::EmitLabel(MCSymbol *Symbol) {
178 assert(!Symbol->isVariable() && "Cannot emit a variable symbol!");
179 assert(getCurrentSection() && "Cannot emit before setting section!");
180 Symbol->setSection(*getCurrentSection());
184 void MCStreamer::EmitCompactUnwindEncoding(uint32_t CompactUnwindEncoding) {
186 MCDwarfFrameInfo *CurFrame = getCurrentFrameInfo();
187 CurFrame->CompactUnwindEncoding = CompactUnwindEncoding;
190 void MCStreamer::EmitCFISections(bool EH, bool Debug) {
193 EmitDebugFrame = Debug;
196 void MCStreamer::EmitCFIStartProc() {
197 MCDwarfFrameInfo *CurFrame = getCurrentFrameInfo();
198 if (CurFrame && !CurFrame->End)
199 report_fatal_error("Starting a frame before finishing the previous one!");
201 MCDwarfFrameInfo Frame;
202 EmitCFIStartProcImpl(Frame);
204 FrameInfos.push_back(Frame);
207 void MCStreamer::EmitCFIStartProcImpl(MCDwarfFrameInfo &Frame) {
210 void MCStreamer::RecordProcStart(MCDwarfFrameInfo &Frame) {
211 Frame.Function = LastSymbol;
212 // If the function is externally visible, we need to create a local
213 // symbol to avoid relocations.
214 StringRef Prefix = getContext().getAsmInfo().getPrivateGlobalPrefix();
215 if (LastSymbol && LastSymbol->getName().startswith(Prefix)) {
216 Frame.Begin = LastSymbol;
218 Frame.Begin = getContext().CreateTempSymbol();
219 EmitLabel(Frame.Begin);
223 void MCStreamer::EmitCFIEndProc() {
225 MCDwarfFrameInfo *CurFrame = getCurrentFrameInfo();
226 EmitCFIEndProcImpl(*CurFrame);
229 void MCStreamer::EmitCFIEndProcImpl(MCDwarfFrameInfo &Frame) {
232 void MCStreamer::RecordProcEnd(MCDwarfFrameInfo &Frame) {
233 Frame.End = getContext().CreateTempSymbol();
234 EmitLabel(Frame.End);
237 void MCStreamer::EmitCFIDefCfa(int64_t Register, int64_t Offset) {
239 MCDwarfFrameInfo *CurFrame = getCurrentFrameInfo();
240 MCSymbol *Label = getContext().CreateTempSymbol();
242 MachineLocation Dest(MachineLocation::VirtualFP);
243 MachineLocation Source(Register, -Offset);
244 MCCFIInstruction Instruction(Label, Dest, Source);
245 CurFrame->Instructions.push_back(Instruction);
248 void MCStreamer::EmitCFIDefCfaOffset(int64_t Offset) {
250 MCDwarfFrameInfo *CurFrame = getCurrentFrameInfo();
251 MCSymbol *Label = getContext().CreateTempSymbol();
253 MachineLocation Dest(MachineLocation::VirtualFP);
254 MachineLocation Source(MachineLocation::VirtualFP, -Offset);
255 MCCFIInstruction Instruction(Label, Dest, Source);
256 CurFrame->Instructions.push_back(Instruction);
259 void MCStreamer::EmitCFIAdjustCfaOffset(int64_t Adjustment) {
261 MCDwarfFrameInfo *CurFrame = getCurrentFrameInfo();
262 MCSymbol *Label = getContext().CreateTempSymbol();
264 MachineLocation Dest(MachineLocation::VirtualFP);
265 MachineLocation Source(MachineLocation::VirtualFP, Adjustment);
266 MCCFIInstruction Instruction(MCCFIInstruction::RelMove, Label, Dest, Source);
267 CurFrame->Instructions.push_back(Instruction);
270 void MCStreamer::EmitCFIDefCfaRegister(int64_t Register) {
272 MCDwarfFrameInfo *CurFrame = getCurrentFrameInfo();
273 MCSymbol *Label = getContext().CreateTempSymbol();
275 MachineLocation Dest(Register);
276 MachineLocation Source(MachineLocation::VirtualFP);
277 MCCFIInstruction Instruction(Label, Dest, Source);
278 CurFrame->Instructions.push_back(Instruction);
281 void MCStreamer::EmitCFIOffset(int64_t Register, int64_t Offset) {
283 MCDwarfFrameInfo *CurFrame = getCurrentFrameInfo();
284 MCSymbol *Label = getContext().CreateTempSymbol();
286 MachineLocation Dest(Register, Offset);
287 MachineLocation Source(Register, Offset);
288 MCCFIInstruction Instruction(Label, Dest, Source);
289 CurFrame->Instructions.push_back(Instruction);
292 void MCStreamer::EmitCFIRelOffset(int64_t Register, int64_t Offset) {
294 MCDwarfFrameInfo *CurFrame = getCurrentFrameInfo();
295 MCSymbol *Label = getContext().CreateTempSymbol();
297 MachineLocation Dest(Register, Offset);
298 MachineLocation Source(Register, Offset);
299 MCCFIInstruction Instruction(MCCFIInstruction::RelMove, Label, Dest, Source);
300 CurFrame->Instructions.push_back(Instruction);
303 void MCStreamer::EmitCFIPersonality(const MCSymbol *Sym,
306 MCDwarfFrameInfo *CurFrame = getCurrentFrameInfo();
307 CurFrame->Personality = Sym;
308 CurFrame->PersonalityEncoding = Encoding;
311 void MCStreamer::EmitCFILsda(const MCSymbol *Sym, unsigned Encoding) {
313 MCDwarfFrameInfo *CurFrame = getCurrentFrameInfo();
314 CurFrame->Lsda = Sym;
315 CurFrame->LsdaEncoding = Encoding;
318 void MCStreamer::EmitCFIRememberState() {
320 MCDwarfFrameInfo *CurFrame = getCurrentFrameInfo();
321 MCSymbol *Label = getContext().CreateTempSymbol();
323 MCCFIInstruction Instruction(MCCFIInstruction::RememberState, Label);
324 CurFrame->Instructions.push_back(Instruction);
327 void MCStreamer::EmitCFIRestoreState() {
328 // FIXME: Error if there is no matching cfi_remember_state.
330 MCDwarfFrameInfo *CurFrame = getCurrentFrameInfo();
331 MCSymbol *Label = getContext().CreateTempSymbol();
333 MCCFIInstruction Instruction(MCCFIInstruction::RestoreState, Label);
334 CurFrame->Instructions.push_back(Instruction);
337 void MCStreamer::EmitCFISameValue(int64_t Register) {
339 MCDwarfFrameInfo *CurFrame = getCurrentFrameInfo();
340 MCSymbol *Label = getContext().CreateTempSymbol();
342 MCCFIInstruction Instruction(MCCFIInstruction::SameValue, Label, Register);
343 CurFrame->Instructions.push_back(Instruction);
346 void MCStreamer::EmitCFIRestore(int64_t Register) {
348 MCDwarfFrameInfo *CurFrame = getCurrentFrameInfo();
349 MCSymbol *Label = getContext().CreateTempSymbol();
351 MCCFIInstruction Instruction(MCCFIInstruction::Restore, Label, Register);
352 CurFrame->Instructions.push_back(Instruction);
355 void MCStreamer::EmitCFIEscape(StringRef Values) {
357 MCDwarfFrameInfo *CurFrame = getCurrentFrameInfo();
358 MCSymbol *Label = getContext().CreateTempSymbol();
360 MCCFIInstruction Instruction(MCCFIInstruction::Escape, Label, Values);
361 CurFrame->Instructions.push_back(Instruction);
364 void MCStreamer::EmitCFISignalFrame() {
366 MCDwarfFrameInfo *CurFrame = getCurrentFrameInfo();
367 CurFrame->IsSignalFrame = true;
370 void MCStreamer::setCurrentW64UnwindInfo(MCWin64EHUnwindInfo *Frame) {
371 W64UnwindInfos.push_back(Frame);
372 CurrentW64UnwindInfo = W64UnwindInfos.back();
375 void MCStreamer::EnsureValidW64UnwindInfo() {
376 MCWin64EHUnwindInfo *CurFrame = CurrentW64UnwindInfo;
377 if (!CurFrame || CurFrame->End)
378 report_fatal_error("No open Win64 EH frame function!");
381 void MCStreamer::EmitWin64EHStartProc(const MCSymbol *Symbol) {
382 MCWin64EHUnwindInfo *CurFrame = CurrentW64UnwindInfo;
383 if (CurFrame && !CurFrame->End)
384 report_fatal_error("Starting a function before ending the previous one!");
385 MCWin64EHUnwindInfo *Frame = new MCWin64EHUnwindInfo;
386 Frame->Begin = getContext().CreateTempSymbol();
387 Frame->Function = Symbol;
388 EmitLabel(Frame->Begin);
389 setCurrentW64UnwindInfo(Frame);
392 void MCStreamer::EmitWin64EHEndProc() {
393 EnsureValidW64UnwindInfo();
394 MCWin64EHUnwindInfo *CurFrame = CurrentW64UnwindInfo;
395 if (CurFrame->ChainedParent)
396 report_fatal_error("Not all chained regions terminated!");
397 CurFrame->End = getContext().CreateTempSymbol();
398 EmitLabel(CurFrame->End);
401 void MCStreamer::EmitWin64EHStartChained() {
402 EnsureValidW64UnwindInfo();
403 MCWin64EHUnwindInfo *Frame = new MCWin64EHUnwindInfo;
404 MCWin64EHUnwindInfo *CurFrame = CurrentW64UnwindInfo;
405 Frame->Begin = getContext().CreateTempSymbol();
406 Frame->Function = CurFrame->Function;
407 Frame->ChainedParent = CurFrame;
408 EmitLabel(Frame->Begin);
409 setCurrentW64UnwindInfo(Frame);
412 void MCStreamer::EmitWin64EHEndChained() {
413 EnsureValidW64UnwindInfo();
414 MCWin64EHUnwindInfo *CurFrame = CurrentW64UnwindInfo;
415 if (!CurFrame->ChainedParent)
416 report_fatal_error("End of a chained region outside a chained region!");
417 CurFrame->End = getContext().CreateTempSymbol();
418 EmitLabel(CurFrame->End);
419 CurrentW64UnwindInfo = CurFrame->ChainedParent;
422 void MCStreamer::EmitWin64EHHandler(const MCSymbol *Sym, bool Unwind,
424 EnsureValidW64UnwindInfo();
425 MCWin64EHUnwindInfo *CurFrame = CurrentW64UnwindInfo;
426 if (CurFrame->ChainedParent)
427 report_fatal_error("Chained unwind areas can't have handlers!");
428 CurFrame->ExceptionHandler = Sym;
429 if (!Except && !Unwind)
430 report_fatal_error("Don't know what kind of handler this is!");
432 CurFrame->HandlesUnwind = true;
434 CurFrame->HandlesExceptions = true;
437 void MCStreamer::EmitWin64EHHandlerData() {
438 EnsureValidW64UnwindInfo();
439 MCWin64EHUnwindInfo *CurFrame = CurrentW64UnwindInfo;
440 if (CurFrame->ChainedParent)
441 report_fatal_error("Chained unwind areas can't have handlers!");
444 void MCStreamer::EmitWin64EHPushReg(unsigned Register) {
445 EnsureValidW64UnwindInfo();
446 MCWin64EHUnwindInfo *CurFrame = CurrentW64UnwindInfo;
447 MCSymbol *Label = getContext().CreateTempSymbol();
448 MCWin64EHInstruction Inst(Win64EH::UOP_PushNonVol, Label, Register);
450 CurFrame->Instructions.push_back(Inst);
453 void MCStreamer::EmitWin64EHSetFrame(unsigned Register, unsigned Offset) {
454 EnsureValidW64UnwindInfo();
455 MCWin64EHUnwindInfo *CurFrame = CurrentW64UnwindInfo;
456 if (CurFrame->LastFrameInst >= 0)
457 report_fatal_error("Frame register and offset already specified!");
459 report_fatal_error("Misaligned frame pointer offset!");
460 MCWin64EHInstruction Inst(Win64EH::UOP_SetFPReg, NULL, Register, Offset);
461 CurFrame->LastFrameInst = CurFrame->Instructions.size();
462 CurFrame->Instructions.push_back(Inst);
465 void MCStreamer::EmitWin64EHAllocStack(unsigned Size) {
466 EnsureValidW64UnwindInfo();
468 report_fatal_error("Misaligned stack allocation!");
469 MCWin64EHUnwindInfo *CurFrame = CurrentW64UnwindInfo;
470 MCSymbol *Label = getContext().CreateTempSymbol();
471 MCWin64EHInstruction Inst(Label, Size);
473 CurFrame->Instructions.push_back(Inst);
476 void MCStreamer::EmitWin64EHSaveReg(unsigned Register, unsigned Offset) {
477 EnsureValidW64UnwindInfo();
479 report_fatal_error("Misaligned saved register offset!");
480 MCWin64EHUnwindInfo *CurFrame = CurrentW64UnwindInfo;
481 MCSymbol *Label = getContext().CreateTempSymbol();
482 MCWin64EHInstruction Inst(
483 Offset > 512*1024-8 ? Win64EH::UOP_SaveNonVolBig : Win64EH::UOP_SaveNonVol,
484 Label, Register, Offset);
486 CurFrame->Instructions.push_back(Inst);
489 void MCStreamer::EmitWin64EHSaveXMM(unsigned Register, unsigned Offset) {
490 EnsureValidW64UnwindInfo();
492 report_fatal_error("Misaligned saved vector register offset!");
493 MCWin64EHUnwindInfo *CurFrame = CurrentW64UnwindInfo;
494 MCSymbol *Label = getContext().CreateTempSymbol();
495 MCWin64EHInstruction Inst(
496 Offset > 512*1024-16 ? Win64EH::UOP_SaveXMM128Big : Win64EH::UOP_SaveXMM128,
497 Label, Register, Offset);
499 CurFrame->Instructions.push_back(Inst);
502 void MCStreamer::EmitWin64EHPushFrame(bool Code) {
503 EnsureValidW64UnwindInfo();
504 MCWin64EHUnwindInfo *CurFrame = CurrentW64UnwindInfo;
505 if (CurFrame->Instructions.size() > 0)
506 report_fatal_error("If present, PushMachFrame must be the first UOP");
507 MCSymbol *Label = getContext().CreateTempSymbol();
508 MCWin64EHInstruction Inst(Win64EH::UOP_PushMachFrame, Label, Code);
510 CurFrame->Instructions.push_back(Inst);
513 void MCStreamer::EmitWin64EHEndProlog() {
514 EnsureValidW64UnwindInfo();
515 MCWin64EHUnwindInfo *CurFrame = CurrentW64UnwindInfo;
516 CurFrame->PrologEnd = getContext().CreateTempSymbol();
517 EmitLabel(CurFrame->PrologEnd);
520 void MCStreamer::EmitCOFFSecRel32(MCSymbol const *Symbol) {
521 llvm_unreachable("This file format doesn't support this directive");
524 void MCStreamer::EmitFnStart() {
525 errs() << "Not implemented yet\n";
529 void MCStreamer::EmitFnEnd() {
530 errs() << "Not implemented yet\n";
534 void MCStreamer::EmitCantUnwind() {
535 errs() << "Not implemented yet\n";
539 void MCStreamer::EmitHandlerData() {
540 errs() << "Not implemented yet\n";
544 void MCStreamer::EmitPersonality(const MCSymbol *Personality) {
545 errs() << "Not implemented yet\n";
549 void MCStreamer::EmitSetFP(unsigned FpReg, unsigned SpReg, int64_t Offset) {
550 errs() << "Not implemented yet\n";
554 void MCStreamer::EmitPad(int64_t Offset) {
555 errs() << "Not implemented yet\n";
559 void MCStreamer::EmitRegSave(const SmallVectorImpl<unsigned> &RegList, bool) {
560 errs() << "Not implemented yet\n";
564 void MCStreamer::EmitTCEntry(const MCSymbol &S) {
565 llvm_unreachable("Unsupported method");
568 /// EmitRawText - If this file is backed by an assembly streamer, this dumps
569 /// the specified string in the output .s file. This capability is
570 /// indicated by the hasRawTextSupport() predicate.
571 void MCStreamer::EmitRawText(StringRef String) {
572 errs() << "EmitRawText called on an MCStreamer that doesn't support it, "
573 " something must not be fully mc'ized\n";
577 void MCStreamer::EmitRawText(const Twine &T) {
578 SmallString<128> Str;
580 EmitRawText(Str.str());
583 void MCStreamer::EmitFrames(bool usingCFI) {
584 if (!getNumFrameInfos())
588 MCDwarfFrameEmitter::Emit(*this, usingCFI, true);
591 MCDwarfFrameEmitter::Emit(*this, usingCFI, false);
594 void MCStreamer::EmitW64Tables() {
595 if (!getNumW64UnwindInfos())
598 MCWin64EHUnwindEmitter::Emit(*this);
601 void MCStreamer::Finish() {
602 if (!FrameInfos.empty() && !FrameInfos.back().End)
603 report_fatal_error("Unfinished frame!");