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),
27 UniqueCodeBeginSuffix(0),
28 UniqueDataBeginSuffix(0) {
29 const MCSection *section = NULL;
30 SectionStack.push_back(std::make_pair(section, section));
33 MCStreamer::~MCStreamer() {
34 for (unsigned i = 0; i < getNumW64UnwindInfos(); ++i)
35 delete W64UnwindInfos[i];
38 const MCExpr *MCStreamer::BuildSymbolDiff(MCContext &Context,
41 MCSymbolRefExpr::VariantKind Variant = MCSymbolRefExpr::VK_None;
43 MCSymbolRefExpr::Create(A, Variant, Context);
45 MCSymbolRefExpr::Create(B, Variant, Context);
46 const MCExpr *AddrDelta =
47 MCBinaryExpr::Create(MCBinaryExpr::Sub, ARef, BRef, Context);
51 const MCExpr *MCStreamer::ForceExpAbs(const MCExpr* Expr) {
52 if (Context.getAsmInfo().hasAggressiveSymbolFolding() ||
53 isa<MCSymbolRefExpr>(Expr))
56 MCSymbol *ABS = Context.CreateTempSymbol();
57 EmitAssignment(ABS, Expr);
58 return MCSymbolRefExpr::Create(ABS, Context);
61 raw_ostream &MCStreamer::GetCommentOS() {
62 // By default, discard comments.
66 void MCStreamer::EmitDwarfSetLineAddr(int64_t LineDelta,
67 const MCSymbol *Label, int PointerSize) {
68 // emit the sequence to set the address
69 EmitIntValue(dwarf::DW_LNS_extended_op, 1);
70 EmitULEB128IntValue(PointerSize + 1);
71 EmitIntValue(dwarf::DW_LNE_set_address, 1);
72 EmitSymbolValue(Label, PointerSize);
74 // emit the sequence for the LineDelta (from 1) and a zero address delta.
75 MCDwarfLineAddr::Emit(this, LineDelta, 0);
78 /// EmitIntValue - Special case of EmitValue that avoids the client having to
79 /// pass in a MCExpr for constant integers.
80 void MCStreamer::EmitIntValue(uint64_t Value, unsigned Size,
82 assert(Size <= 8 && "Invalid size");
83 assert((isUIntN(8 * Size, Value) || isIntN(8 * Size, Value)) &&
86 const bool isLittleEndian = Context.getAsmInfo().isLittleEndian();
87 for (unsigned i = 0; i != Size; ++i) {
88 unsigned index = isLittleEndian ? i : (Size - i - 1);
89 buf[i] = uint8_t(Value >> (index * 8));
91 EmitBytes(StringRef(buf, Size), AddrSpace);
94 /// EmitULEB128Value - Special case of EmitULEB128Value that avoids the
95 /// client having to pass in a MCExpr for constant integers.
96 void MCStreamer::EmitULEB128IntValue(uint64_t Value, unsigned AddrSpace,
99 raw_svector_ostream OSE(Tmp);
100 MCObjectWriter::EncodeULEB128(Value, OSE, Padding);
101 EmitBytes(OSE.str(), AddrSpace);
104 /// EmitSLEB128Value - Special case of EmitSLEB128Value that avoids the
105 /// client having to pass in a MCExpr for constant integers.
106 void MCStreamer::EmitSLEB128IntValue(int64_t Value, unsigned AddrSpace) {
108 raw_svector_ostream OSE(Tmp);
109 MCObjectWriter::EncodeSLEB128(Value, OSE);
110 EmitBytes(OSE.str(), AddrSpace);
113 void MCStreamer::EmitAbsValue(const MCExpr *Value, unsigned Size,
114 unsigned AddrSpace) {
115 const MCExpr *ABS = ForceExpAbs(Value);
116 EmitValue(ABS, Size, AddrSpace);
120 void MCStreamer::EmitValue(const MCExpr *Value, unsigned Size,
121 unsigned AddrSpace) {
122 EmitValueImpl(Value, Size, AddrSpace);
125 void MCStreamer::EmitSymbolValue(const MCSymbol *Sym, unsigned Size,
126 unsigned AddrSpace) {
127 EmitValueImpl(MCSymbolRefExpr::Create(Sym, getContext()), Size,
131 void MCStreamer::EmitGPRel32Value(const MCExpr *Value) {
132 report_fatal_error("unsupported directive in streamer");
135 /// EmitFill - Emit NumBytes bytes worth of the value specified by
136 /// FillValue. This implements directives such as '.space'.
137 void MCStreamer::EmitFill(uint64_t NumBytes, uint8_t FillValue,
138 unsigned AddrSpace) {
139 const MCExpr *E = MCConstantExpr::Create(FillValue, getContext());
140 for (uint64_t i = 0, e = NumBytes; i != e; ++i)
141 EmitValue(E, 1, AddrSpace);
144 bool MCStreamer::EmitDwarfFileDirective(unsigned FileNo,
146 StringRef Filename) {
147 return getContext().GetDwarfFile(Directory, Filename, FileNo) == 0;
150 void MCStreamer::EmitDwarfLocDirective(unsigned FileNo, unsigned Line,
151 unsigned Column, unsigned Flags,
153 unsigned Discriminator,
154 StringRef FileName) {
155 getContext().setCurrentDwarfLoc(FileNo, Line, Column, Flags, Isa,
159 MCDwarfFrameInfo *MCStreamer::getCurrentFrameInfo() {
160 if (FrameInfos.empty())
162 return &FrameInfos.back();
165 void MCStreamer::EnsureValidFrame() {
166 MCDwarfFrameInfo *CurFrame = getCurrentFrameInfo();
167 if (!CurFrame || CurFrame->End)
168 report_fatal_error("No open frame");
171 void MCStreamer::EmitEHSymAttributes(const MCSymbol *Symbol,
172 MCSymbol *EHSymbol) {
175 void MCStreamer::EmitLabel(MCSymbol *Symbol) {
176 assert(!Symbol->isVariable() && "Cannot emit a variable symbol!");
177 assert(getCurrentSection() && "Cannot emit before setting section!");
178 Symbol->setSection(*getCurrentSection());
182 void MCStreamer::EmitDataRegion() {
183 if (RegionIndicator == Data) return;
185 MCContext &Context = getContext();
186 const MCAsmInfo &MAI = Context.getAsmInfo();
187 if (!MAI.getSupportsDataRegions()) return;
189 // Generate a unique symbol name.
190 MCSymbol *NewSym = Context.GetOrCreateSymbol(MAI.getDataBeginLabelName() +
191 Twine(UniqueDataBeginSuffix++));
194 RegionIndicator = Data;
197 void MCStreamer::EmitCodeRegion() {
198 if (RegionIndicator == Code) return;
200 MCContext &Context = getContext();
201 const MCAsmInfo &MAI = Context.getAsmInfo();
202 if (!MAI.getSupportsDataRegions()) return;
204 // Generate a unique symbol name.
205 MCSymbol *NewSym = Context.GetOrCreateSymbol(MAI.getCodeBeginLabelName() +
206 Twine(UniqueCodeBeginSuffix++));
209 RegionIndicator = Code;
212 void MCStreamer::EmitJumpTable8Region() {
213 if (RegionIndicator == JumpTable8) return;
215 MCContext &Context = getContext();
216 const MCAsmInfo &MAI = Context.getAsmInfo();
217 if (!MAI.getSupportsDataRegions()) return;
219 // Generate a unique symbol name.
221 Context.GetOrCreateSymbol(MAI.getJumpTable8BeginLabelName() +
222 Twine(UniqueDataBeginSuffix++));
225 RegionIndicator = JumpTable8;
228 void MCStreamer::EmitJumpTable16Region() {
229 if (RegionIndicator == JumpTable16) return;
231 MCContext &Context = getContext();
232 const MCAsmInfo &MAI = Context.getAsmInfo();
233 if (!MAI.getSupportsDataRegions()) return;
235 // Generate a unique symbol name.
237 Context.GetOrCreateSymbol(MAI.getJumpTable16BeginLabelName() +
238 Twine(UniqueDataBeginSuffix++));
241 RegionIndicator = JumpTable16;
245 void MCStreamer::EmitJumpTable32Region() {
246 if (RegionIndicator == JumpTable32) return;
248 MCContext &Context = getContext();
249 const MCAsmInfo &MAI = Context.getAsmInfo();
250 if (!MAI.getSupportsDataRegions()) return;
252 // Generate a unique symbol name.
254 Context.GetOrCreateSymbol(MAI.getJumpTable32BeginLabelName() +
255 Twine(UniqueDataBeginSuffix++));
258 RegionIndicator = JumpTable32;
261 void MCStreamer::EmitCompactUnwindEncoding(uint32_t CompactUnwindEncoding) {
263 MCDwarfFrameInfo *CurFrame = getCurrentFrameInfo();
264 CurFrame->CompactUnwindEncoding = CompactUnwindEncoding;
267 void MCStreamer::EmitCFISections(bool EH, bool Debug) {
270 EmitDebugFrame = Debug;
273 void MCStreamer::EmitCFIStartProc() {
274 MCDwarfFrameInfo *CurFrame = getCurrentFrameInfo();
275 if (CurFrame && !CurFrame->End)
276 report_fatal_error("Starting a frame before finishing the previous one!");
278 MCDwarfFrameInfo Frame;
279 Frame.Function = LastSymbol;
281 // If the function is externally visible, we need to create a local
282 // symbol to avoid relocations.
283 StringRef Prefix = getContext().getAsmInfo().getPrivateGlobalPrefix();
284 if (LastSymbol && LastSymbol->getName().startswith(Prefix)) {
285 Frame.Begin = LastSymbol;
287 Frame.Begin = getContext().CreateTempSymbol();
288 EmitLabel(Frame.Begin);
291 FrameInfos.push_back(Frame);
292 RegionIndicator = Code;
295 void MCStreamer::EmitCFIEndProc() {
297 MCDwarfFrameInfo *CurFrame = getCurrentFrameInfo();
298 CurFrame->End = getContext().CreateTempSymbol();
299 EmitLabel(CurFrame->End);
302 void MCStreamer::EmitCFIDefCfa(int64_t Register, int64_t Offset) {
304 MCDwarfFrameInfo *CurFrame = getCurrentFrameInfo();
305 MCSymbol *Label = getContext().CreateTempSymbol();
307 MachineLocation Dest(MachineLocation::VirtualFP);
308 MachineLocation Source(Register, -Offset);
309 MCCFIInstruction Instruction(Label, Dest, Source);
310 CurFrame->Instructions.push_back(Instruction);
313 void MCStreamer::EmitCFIDefCfaOffset(int64_t Offset) {
315 MCDwarfFrameInfo *CurFrame = getCurrentFrameInfo();
316 MCSymbol *Label = getContext().CreateTempSymbol();
318 MachineLocation Dest(MachineLocation::VirtualFP);
319 MachineLocation Source(MachineLocation::VirtualFP, -Offset);
320 MCCFIInstruction Instruction(Label, Dest, Source);
321 CurFrame->Instructions.push_back(Instruction);
324 void MCStreamer::EmitCFIAdjustCfaOffset(int64_t Adjustment) {
326 MCDwarfFrameInfo *CurFrame = getCurrentFrameInfo();
327 MCSymbol *Label = getContext().CreateTempSymbol();
329 MachineLocation Dest(MachineLocation::VirtualFP);
330 MachineLocation Source(MachineLocation::VirtualFP, Adjustment);
331 MCCFIInstruction Instruction(MCCFIInstruction::RelMove, Label, Dest, Source);
332 CurFrame->Instructions.push_back(Instruction);
335 void MCStreamer::EmitCFIDefCfaRegister(int64_t Register) {
337 MCDwarfFrameInfo *CurFrame = getCurrentFrameInfo();
338 MCSymbol *Label = getContext().CreateTempSymbol();
340 MachineLocation Dest(Register);
341 MachineLocation Source(MachineLocation::VirtualFP);
342 MCCFIInstruction Instruction(Label, Dest, Source);
343 CurFrame->Instructions.push_back(Instruction);
346 void MCStreamer::EmitCFIOffset(int64_t Register, int64_t Offset) {
348 MCDwarfFrameInfo *CurFrame = getCurrentFrameInfo();
349 MCSymbol *Label = getContext().CreateTempSymbol();
351 MachineLocation Dest(Register, Offset);
352 MachineLocation Source(Register, Offset);
353 MCCFIInstruction Instruction(Label, Dest, Source);
354 CurFrame->Instructions.push_back(Instruction);
357 void MCStreamer::EmitCFIRelOffset(int64_t Register, int64_t Offset) {
359 MCDwarfFrameInfo *CurFrame = getCurrentFrameInfo();
360 MCSymbol *Label = getContext().CreateTempSymbol();
362 MachineLocation Dest(Register, Offset);
363 MachineLocation Source(Register, Offset);
364 MCCFIInstruction Instruction(MCCFIInstruction::RelMove, Label, Dest, Source);
365 CurFrame->Instructions.push_back(Instruction);
368 void MCStreamer::EmitCFIPersonality(const MCSymbol *Sym,
371 MCDwarfFrameInfo *CurFrame = getCurrentFrameInfo();
372 CurFrame->Personality = Sym;
373 CurFrame->PersonalityEncoding = Encoding;
376 void MCStreamer::EmitCFILsda(const MCSymbol *Sym, unsigned Encoding) {
378 MCDwarfFrameInfo *CurFrame = getCurrentFrameInfo();
379 CurFrame->Lsda = Sym;
380 CurFrame->LsdaEncoding = Encoding;
383 void MCStreamer::EmitCFIRememberState() {
385 MCDwarfFrameInfo *CurFrame = getCurrentFrameInfo();
386 MCSymbol *Label = getContext().CreateTempSymbol();
388 MCCFIInstruction Instruction(MCCFIInstruction::Remember, Label);
389 CurFrame->Instructions.push_back(Instruction);
392 void MCStreamer::EmitCFIRestoreState() {
393 // FIXME: Error if there is no matching cfi_remember_state.
395 MCDwarfFrameInfo *CurFrame = getCurrentFrameInfo();
396 MCSymbol *Label = getContext().CreateTempSymbol();
398 MCCFIInstruction Instruction(MCCFIInstruction::Restore, Label);
399 CurFrame->Instructions.push_back(Instruction);
402 void MCStreamer::EmitCFISameValue(int64_t Register) {
404 MCDwarfFrameInfo *CurFrame = getCurrentFrameInfo();
405 MCSymbol *Label = getContext().CreateTempSymbol();
407 MCCFIInstruction Instruction(MCCFIInstruction::SameValue, Label, Register);
408 CurFrame->Instructions.push_back(Instruction);
411 void MCStreamer::setCurrentW64UnwindInfo(MCWin64EHUnwindInfo *Frame) {
412 W64UnwindInfos.push_back(Frame);
413 CurrentW64UnwindInfo = W64UnwindInfos.back();
416 void MCStreamer::EnsureValidW64UnwindInfo() {
417 MCWin64EHUnwindInfo *CurFrame = CurrentW64UnwindInfo;
418 if (!CurFrame || CurFrame->End)
419 report_fatal_error("No open Win64 EH frame function!");
422 void MCStreamer::EmitWin64EHStartProc(const MCSymbol *Symbol) {
423 MCWin64EHUnwindInfo *CurFrame = CurrentW64UnwindInfo;
424 if (CurFrame && !CurFrame->End)
425 report_fatal_error("Starting a function before ending the previous one!");
426 MCWin64EHUnwindInfo *Frame = new MCWin64EHUnwindInfo;
427 Frame->Begin = getContext().CreateTempSymbol();
428 Frame->Function = Symbol;
429 EmitLabel(Frame->Begin);
430 setCurrentW64UnwindInfo(Frame);
433 void MCStreamer::EmitWin64EHEndProc() {
434 EnsureValidW64UnwindInfo();
435 MCWin64EHUnwindInfo *CurFrame = CurrentW64UnwindInfo;
436 if (CurFrame->ChainedParent)
437 report_fatal_error("Not all chained regions terminated!");
438 CurFrame->End = getContext().CreateTempSymbol();
439 EmitLabel(CurFrame->End);
442 void MCStreamer::EmitWin64EHStartChained() {
443 EnsureValidW64UnwindInfo();
444 MCWin64EHUnwindInfo *Frame = new MCWin64EHUnwindInfo;
445 MCWin64EHUnwindInfo *CurFrame = CurrentW64UnwindInfo;
446 Frame->Begin = getContext().CreateTempSymbol();
447 Frame->Function = CurFrame->Function;
448 Frame->ChainedParent = CurFrame;
449 EmitLabel(Frame->Begin);
450 setCurrentW64UnwindInfo(Frame);
453 void MCStreamer::EmitWin64EHEndChained() {
454 EnsureValidW64UnwindInfo();
455 MCWin64EHUnwindInfo *CurFrame = CurrentW64UnwindInfo;
456 if (!CurFrame->ChainedParent)
457 report_fatal_error("End of a chained region outside a chained region!");
458 CurFrame->End = getContext().CreateTempSymbol();
459 EmitLabel(CurFrame->End);
460 CurrentW64UnwindInfo = CurFrame->ChainedParent;
463 void MCStreamer::EmitWin64EHHandler(const MCSymbol *Sym, bool Unwind,
465 EnsureValidW64UnwindInfo();
466 MCWin64EHUnwindInfo *CurFrame = CurrentW64UnwindInfo;
467 if (CurFrame->ChainedParent)
468 report_fatal_error("Chained unwind areas can't have handlers!");
469 CurFrame->ExceptionHandler = Sym;
470 if (!Except && !Unwind)
471 report_fatal_error("Don't know what kind of handler this is!");
473 CurFrame->HandlesUnwind = true;
475 CurFrame->HandlesExceptions = true;
478 void MCStreamer::EmitWin64EHHandlerData() {
479 EnsureValidW64UnwindInfo();
480 MCWin64EHUnwindInfo *CurFrame = CurrentW64UnwindInfo;
481 if (CurFrame->ChainedParent)
482 report_fatal_error("Chained unwind areas can't have handlers!");
485 void MCStreamer::EmitWin64EHPushReg(unsigned Register) {
486 EnsureValidW64UnwindInfo();
487 MCWin64EHUnwindInfo *CurFrame = CurrentW64UnwindInfo;
488 MCSymbol *Label = getContext().CreateTempSymbol();
489 MCWin64EHInstruction Inst(Win64EH::UOP_PushNonVol, Label, Register);
491 CurFrame->Instructions.push_back(Inst);
494 void MCStreamer::EmitWin64EHSetFrame(unsigned Register, unsigned Offset) {
495 EnsureValidW64UnwindInfo();
496 MCWin64EHUnwindInfo *CurFrame = CurrentW64UnwindInfo;
497 if (CurFrame->LastFrameInst >= 0)
498 report_fatal_error("Frame register and offset already specified!");
500 report_fatal_error("Misaligned frame pointer offset!");
501 MCWin64EHInstruction Inst(Win64EH::UOP_SetFPReg, NULL, Register, Offset);
502 CurFrame->LastFrameInst = CurFrame->Instructions.size();
503 CurFrame->Instructions.push_back(Inst);
506 void MCStreamer::EmitWin64EHAllocStack(unsigned Size) {
507 EnsureValidW64UnwindInfo();
509 report_fatal_error("Misaligned stack allocation!");
510 MCWin64EHUnwindInfo *CurFrame = CurrentW64UnwindInfo;
511 MCSymbol *Label = getContext().CreateTempSymbol();
512 MCWin64EHInstruction Inst(Label, Size);
514 CurFrame->Instructions.push_back(Inst);
517 void MCStreamer::EmitWin64EHSaveReg(unsigned Register, unsigned Offset) {
518 EnsureValidW64UnwindInfo();
520 report_fatal_error("Misaligned saved register offset!");
521 MCWin64EHUnwindInfo *CurFrame = CurrentW64UnwindInfo;
522 MCSymbol *Label = getContext().CreateTempSymbol();
523 MCWin64EHInstruction Inst(
524 Offset > 512*1024-8 ? Win64EH::UOP_SaveNonVolBig : Win64EH::UOP_SaveNonVol,
525 Label, Register, Offset);
527 CurFrame->Instructions.push_back(Inst);
530 void MCStreamer::EmitWin64EHSaveXMM(unsigned Register, unsigned Offset) {
531 EnsureValidW64UnwindInfo();
533 report_fatal_error("Misaligned saved vector register offset!");
534 MCWin64EHUnwindInfo *CurFrame = CurrentW64UnwindInfo;
535 MCSymbol *Label = getContext().CreateTempSymbol();
536 MCWin64EHInstruction Inst(
537 Offset > 512*1024-16 ? Win64EH::UOP_SaveXMM128Big : Win64EH::UOP_SaveXMM128,
538 Label, Register, Offset);
540 CurFrame->Instructions.push_back(Inst);
543 void MCStreamer::EmitWin64EHPushFrame(bool Code) {
544 EnsureValidW64UnwindInfo();
545 MCWin64EHUnwindInfo *CurFrame = CurrentW64UnwindInfo;
546 if (CurFrame->Instructions.size() > 0)
547 report_fatal_error("If present, PushMachFrame must be the first UOP");
548 MCSymbol *Label = getContext().CreateTempSymbol();
549 MCWin64EHInstruction Inst(Win64EH::UOP_PushMachFrame, Label, Code);
551 CurFrame->Instructions.push_back(Inst);
554 void MCStreamer::EmitWin64EHEndProlog() {
555 EnsureValidW64UnwindInfo();
556 MCWin64EHUnwindInfo *CurFrame = CurrentW64UnwindInfo;
557 CurFrame->PrologEnd = getContext().CreateTempSymbol();
558 EmitLabel(CurFrame->PrologEnd);
561 void MCStreamer::EmitFnStart() {
562 errs() << "Not implemented yet\n";
566 void MCStreamer::EmitFnEnd() {
567 errs() << "Not implemented yet\n";
571 void MCStreamer::EmitCantUnwind() {
572 errs() << "Not implemented yet\n";
576 void MCStreamer::EmitHandlerData() {
577 errs() << "Not implemented yet\n";
581 void MCStreamer::EmitPersonality(const MCSymbol *Personality) {
582 errs() << "Not implemented yet\n";
586 void MCStreamer::EmitSetFP(unsigned FpReg, unsigned SpReg, int64_t Offset) {
587 errs() << "Not implemented yet\n";
591 void MCStreamer::EmitPad(int64_t Offset) {
592 errs() << "Not implemented yet\n";
596 void MCStreamer::EmitRegSave(const SmallVectorImpl<unsigned> &RegList, bool) {
597 errs() << "Not implemented yet\n";
601 /// EmitRawText - If this file is backed by an assembly streamer, this dumps
602 /// the specified string in the output .s file. This capability is
603 /// indicated by the hasRawTextSupport() predicate.
604 void MCStreamer::EmitRawText(StringRef String) {
605 errs() << "EmitRawText called on an MCStreamer that doesn't support it, "
606 " something must not be fully mc'ized\n";
610 void MCStreamer::EmitRawText(const Twine &T) {
611 SmallString<128> Str;
613 EmitRawText(Str.str());
616 void MCStreamer::EmitFrames(bool usingCFI) {
617 if (!getNumFrameInfos())
621 MCDwarfFrameEmitter::Emit(*this, usingCFI, true);
624 MCDwarfFrameEmitter::Emit(*this, usingCFI, false);
627 void MCStreamer::EmitW64Tables() {
628 if (!getNumW64UnwindInfos())
631 MCWin64EHUnwindEmitter::Emit(*this);