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/StringExtras.h"
20 #include "llvm/ADT/Twine.h"
24 MCStreamer::MCStreamer(MCContext &Ctx) : Context(Ctx), EmitEHFrame(true),
25 EmitDebugFrame(false),
26 CurrentW64UnwindInfo(0),
28 UniqueCodeBeginSuffix(0),
29 UniqueDataBeginSuffix(0) {
30 const MCSection *section = NULL;
31 SectionStack.push_back(std::make_pair(section, section));
34 MCStreamer::~MCStreamer() {
35 for (unsigned i = 0; i < getNumW64UnwindInfos(); ++i)
36 delete W64UnwindInfos[i];
39 const MCExpr *MCStreamer::BuildSymbolDiff(MCContext &Context,
42 MCSymbolRefExpr::VariantKind Variant = MCSymbolRefExpr::VK_None;
44 MCSymbolRefExpr::Create(A, Variant, Context);
46 MCSymbolRefExpr::Create(B, Variant, Context);
47 const MCExpr *AddrDelta =
48 MCBinaryExpr::Create(MCBinaryExpr::Sub, ARef, BRef, Context);
52 const MCExpr *MCStreamer::ForceExpAbs(const MCExpr* Expr) {
53 if (Context.getAsmInfo().hasAggressiveSymbolFolding() ||
54 isa<MCSymbolRefExpr>(Expr))
57 MCSymbol *ABS = Context.CreateTempSymbol();
58 EmitAssignment(ABS, Expr);
59 return MCSymbolRefExpr::Create(ABS, Context);
62 raw_ostream &MCStreamer::GetCommentOS() {
63 // By default, discard comments.
67 void MCStreamer::EmitDwarfSetLineAddr(int64_t LineDelta,
68 const MCSymbol *Label, int PointerSize) {
69 // emit the sequence to set the address
70 EmitIntValue(dwarf::DW_LNS_extended_op, 1);
71 EmitULEB128IntValue(PointerSize + 1);
72 EmitIntValue(dwarf::DW_LNE_set_address, 1);
73 EmitSymbolValue(Label, PointerSize);
75 // emit the sequence for the LineDelta (from 1) and a zero address delta.
76 MCDwarfLineAddr::Emit(this, LineDelta, 0);
79 /// EmitIntValue - Special case of EmitValue that avoids the client having to
80 /// pass in a MCExpr for constant integers.
81 void MCStreamer::EmitIntValue(uint64_t Value, unsigned Size,
83 assert(Size <= 8 && "Invalid size");
84 assert((isUIntN(8 * Size, Value) || isIntN(8 * Size, Value)) &&
87 const bool isLittleEndian = Context.getAsmInfo().isLittleEndian();
88 for (unsigned i = 0; i != Size; ++i) {
89 unsigned index = isLittleEndian ? i : (Size - i - 1);
90 buf[i] = uint8_t(Value >> (index * 8));
92 EmitBytes(StringRef(buf, Size), AddrSpace);
95 /// EmitULEB128Value - Special case of EmitULEB128Value that avoids the
96 /// client having to pass in a MCExpr for constant integers.
97 void MCStreamer::EmitULEB128IntValue(uint64_t Value, unsigned AddrSpace) {
99 raw_svector_ostream OSE(Tmp);
100 MCObjectWriter::EncodeULEB128(Value, OSE);
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(
191 Twine(MAI.getDataBeginLabelName()) +
192 utostr(UniqueDataBeginSuffix++));
195 RegionIndicator = Data;
198 void MCStreamer::EmitCodeRegion() {
199 if (RegionIndicator == Code) return;
201 MCContext &Context = getContext();
202 const MCAsmInfo &MAI = Context.getAsmInfo();
203 if (!MAI.getSupportsDataRegions()) return;
205 // Generate a unique symbol name.
206 MCSymbol *NewSym = Context.GetOrCreateSymbol(
207 Twine(MAI.getCodeBeginLabelName()) +
208 utostr(UniqueCodeBeginSuffix++));
211 RegionIndicator = Code;
214 void MCStreamer::EmitJumpTable8Region() {
215 if (RegionIndicator == JumpTable8) return;
217 MCContext &Context = getContext();
218 const MCAsmInfo &MAI = Context.getAsmInfo();
219 if (!MAI.getSupportsDataRegions()) return;
221 // Generate a unique symbol name.
222 MCSymbol *NewSym = Context.GetOrCreateSymbol(
223 Twine(MAI.getJumpTable8BeginLabelName()) +
224 utostr(UniqueDataBeginSuffix++));
227 RegionIndicator = JumpTable8;
230 void MCStreamer::EmitJumpTable16Region() {
231 if (RegionIndicator == JumpTable16) return;
233 MCContext &Context = getContext();
234 const MCAsmInfo &MAI = Context.getAsmInfo();
235 if (!MAI.getSupportsDataRegions()) return;
237 // Generate a unique symbol name.
238 MCSymbol *NewSym = Context.GetOrCreateSymbol(
239 Twine(MAI.getJumpTable16BeginLabelName()) +
240 utostr(UniqueDataBeginSuffix++));
243 RegionIndicator = JumpTable16;
247 void MCStreamer::EmitJumpTable32Region() {
248 if (RegionIndicator == JumpTable32) return;
250 MCContext &Context = getContext();
251 const MCAsmInfo &MAI = Context.getAsmInfo();
252 if (!MAI.getSupportsDataRegions()) return;
254 // Generate a unique symbol name.
255 MCSymbol *NewSym = Context.GetOrCreateSymbol(
256 Twine(MAI.getJumpTable32BeginLabelName()) +
257 utostr(UniqueDataBeginSuffix++));
260 RegionIndicator = JumpTable32;
263 void MCStreamer::EmitCompactUnwindEncoding(uint32_t CompactUnwindEncoding) {
265 MCDwarfFrameInfo *CurFrame = getCurrentFrameInfo();
266 CurFrame->CompactUnwindEncoding = CompactUnwindEncoding;
269 void MCStreamer::EmitCFISections(bool EH, bool Debug) {
272 EmitDebugFrame = Debug;
275 void MCStreamer::EmitCFIStartProc() {
276 MCDwarfFrameInfo *CurFrame = getCurrentFrameInfo();
277 if (CurFrame && !CurFrame->End)
278 report_fatal_error("Starting a frame before finishing the previous one!");
280 MCDwarfFrameInfo Frame;
281 Frame.Function = LastSymbol;
283 // If the function is externally visible, we need to create a local
284 // symbol to avoid relocations.
285 StringRef Prefix = getContext().getAsmInfo().getPrivateGlobalPrefix();
286 if (LastSymbol && LastSymbol->getName().startswith(Prefix)) {
287 Frame.Begin = LastSymbol;
289 Frame.Begin = getContext().CreateTempSymbol();
290 EmitLabel(Frame.Begin);
293 FrameInfos.push_back(Frame);
294 RegionIndicator = Code;
297 void MCStreamer::EmitCFIEndProc() {
299 MCDwarfFrameInfo *CurFrame = getCurrentFrameInfo();
300 CurFrame->End = getContext().CreateTempSymbol();
301 EmitLabel(CurFrame->End);
304 void MCStreamer::EmitCFIDefCfa(int64_t Register, int64_t Offset) {
306 MCDwarfFrameInfo *CurFrame = getCurrentFrameInfo();
307 MCSymbol *Label = getContext().CreateTempSymbol();
309 MachineLocation Dest(MachineLocation::VirtualFP);
310 MachineLocation Source(Register, -Offset);
311 MCCFIInstruction Instruction(Label, Dest, Source);
312 CurFrame->Instructions.push_back(Instruction);
315 void MCStreamer::EmitCFIDefCfaOffset(int64_t Offset) {
317 MCDwarfFrameInfo *CurFrame = getCurrentFrameInfo();
318 MCSymbol *Label = getContext().CreateTempSymbol();
320 MachineLocation Dest(MachineLocation::VirtualFP);
321 MachineLocation Source(MachineLocation::VirtualFP, -Offset);
322 MCCFIInstruction Instruction(Label, Dest, Source);
323 CurFrame->Instructions.push_back(Instruction);
326 void MCStreamer::EmitCFIAdjustCfaOffset(int64_t Adjustment) {
328 MCDwarfFrameInfo *CurFrame = getCurrentFrameInfo();
329 MCSymbol *Label = getContext().CreateTempSymbol();
331 MachineLocation Dest(MachineLocation::VirtualFP);
332 MachineLocation Source(MachineLocation::VirtualFP, Adjustment);
333 MCCFIInstruction Instruction(MCCFIInstruction::RelMove, Label, Dest, Source);
334 CurFrame->Instructions.push_back(Instruction);
337 void MCStreamer::EmitCFIDefCfaRegister(int64_t Register) {
339 MCDwarfFrameInfo *CurFrame = getCurrentFrameInfo();
340 MCSymbol *Label = getContext().CreateTempSymbol();
342 MachineLocation Dest(Register);
343 MachineLocation Source(MachineLocation::VirtualFP);
344 MCCFIInstruction Instruction(Label, Dest, Source);
345 CurFrame->Instructions.push_back(Instruction);
348 void MCStreamer::EmitCFIOffset(int64_t Register, int64_t Offset) {
350 MCDwarfFrameInfo *CurFrame = getCurrentFrameInfo();
351 MCSymbol *Label = getContext().CreateTempSymbol();
353 MachineLocation Dest(Register, Offset);
354 MachineLocation Source(Register, Offset);
355 MCCFIInstruction Instruction(Label, Dest, Source);
356 CurFrame->Instructions.push_back(Instruction);
359 void MCStreamer::EmitCFIRelOffset(int64_t Register, int64_t Offset) {
361 MCDwarfFrameInfo *CurFrame = getCurrentFrameInfo();
362 MCSymbol *Label = getContext().CreateTempSymbol();
364 MachineLocation Dest(Register, Offset);
365 MachineLocation Source(Register, Offset);
366 MCCFIInstruction Instruction(MCCFIInstruction::RelMove, Label, Dest, Source);
367 CurFrame->Instructions.push_back(Instruction);
370 void MCStreamer::EmitCFIPersonality(const MCSymbol *Sym,
373 MCDwarfFrameInfo *CurFrame = getCurrentFrameInfo();
374 CurFrame->Personality = Sym;
375 CurFrame->PersonalityEncoding = Encoding;
378 void MCStreamer::EmitCFILsda(const MCSymbol *Sym, unsigned Encoding) {
380 MCDwarfFrameInfo *CurFrame = getCurrentFrameInfo();
381 CurFrame->Lsda = Sym;
382 CurFrame->LsdaEncoding = Encoding;
385 void MCStreamer::EmitCFIRememberState() {
387 MCDwarfFrameInfo *CurFrame = getCurrentFrameInfo();
388 MCSymbol *Label = getContext().CreateTempSymbol();
390 MCCFIInstruction Instruction(MCCFIInstruction::Remember, Label);
391 CurFrame->Instructions.push_back(Instruction);
394 void MCStreamer::EmitCFIRestoreState() {
395 // FIXME: Error if there is no matching cfi_remember_state.
397 MCDwarfFrameInfo *CurFrame = getCurrentFrameInfo();
398 MCSymbol *Label = getContext().CreateTempSymbol();
400 MCCFIInstruction Instruction(MCCFIInstruction::Restore, Label);
401 CurFrame->Instructions.push_back(Instruction);
404 void MCStreamer::EmitCFISameValue(int64_t Register) {
406 MCDwarfFrameInfo *CurFrame = getCurrentFrameInfo();
407 MCSymbol *Label = getContext().CreateTempSymbol();
409 MCCFIInstruction Instruction(MCCFIInstruction::SameValue, Label, Register);
410 CurFrame->Instructions.push_back(Instruction);
413 void MCStreamer::setCurrentW64UnwindInfo(MCWin64EHUnwindInfo *Frame) {
414 W64UnwindInfos.push_back(Frame);
415 CurrentW64UnwindInfo = W64UnwindInfos.back();
418 void MCStreamer::EnsureValidW64UnwindInfo() {
419 MCWin64EHUnwindInfo *CurFrame = CurrentW64UnwindInfo;
420 if (!CurFrame || CurFrame->End)
421 report_fatal_error("No open Win64 EH frame function!");
424 void MCStreamer::EmitWin64EHStartProc(const MCSymbol *Symbol) {
425 MCWin64EHUnwindInfo *CurFrame = CurrentW64UnwindInfo;
426 if (CurFrame && !CurFrame->End)
427 report_fatal_error("Starting a function before ending the previous one!");
428 MCWin64EHUnwindInfo *Frame = new MCWin64EHUnwindInfo;
429 Frame->Begin = getContext().CreateTempSymbol();
430 Frame->Function = Symbol;
431 EmitLabel(Frame->Begin);
432 setCurrentW64UnwindInfo(Frame);
435 void MCStreamer::EmitWin64EHEndProc() {
436 EnsureValidW64UnwindInfo();
437 MCWin64EHUnwindInfo *CurFrame = CurrentW64UnwindInfo;
438 if (CurFrame->ChainedParent)
439 report_fatal_error("Not all chained regions terminated!");
440 CurFrame->End = getContext().CreateTempSymbol();
441 EmitLabel(CurFrame->End);
444 void MCStreamer::EmitWin64EHStartChained() {
445 EnsureValidW64UnwindInfo();
446 MCWin64EHUnwindInfo *Frame = new MCWin64EHUnwindInfo;
447 MCWin64EHUnwindInfo *CurFrame = CurrentW64UnwindInfo;
448 Frame->Begin = getContext().CreateTempSymbol();
449 Frame->Function = CurFrame->Function;
450 Frame->ChainedParent = CurFrame;
451 EmitLabel(Frame->Begin);
452 setCurrentW64UnwindInfo(Frame);
455 void MCStreamer::EmitWin64EHEndChained() {
456 EnsureValidW64UnwindInfo();
457 MCWin64EHUnwindInfo *CurFrame = CurrentW64UnwindInfo;
458 if (!CurFrame->ChainedParent)
459 report_fatal_error("End of a chained region outside a chained region!");
460 CurFrame->End = getContext().CreateTempSymbol();
461 EmitLabel(CurFrame->End);
462 CurrentW64UnwindInfo = CurFrame->ChainedParent;
465 void MCStreamer::EmitWin64EHHandler(const MCSymbol *Sym, bool Unwind,
467 EnsureValidW64UnwindInfo();
468 MCWin64EHUnwindInfo *CurFrame = CurrentW64UnwindInfo;
469 if (CurFrame->ChainedParent)
470 report_fatal_error("Chained unwind areas can't have handlers!");
471 CurFrame->ExceptionHandler = Sym;
472 if (!Except && !Unwind)
473 report_fatal_error("Don't know what kind of handler this is!");
475 CurFrame->HandlesUnwind = true;
477 CurFrame->HandlesExceptions = true;
480 void MCStreamer::EmitWin64EHHandlerData() {
481 EnsureValidW64UnwindInfo();
482 MCWin64EHUnwindInfo *CurFrame = CurrentW64UnwindInfo;
483 if (CurFrame->ChainedParent)
484 report_fatal_error("Chained unwind areas can't have handlers!");
487 void MCStreamer::EmitWin64EHPushReg(unsigned Register) {
488 EnsureValidW64UnwindInfo();
489 MCWin64EHUnwindInfo *CurFrame = CurrentW64UnwindInfo;
490 MCSymbol *Label = getContext().CreateTempSymbol();
491 MCWin64EHInstruction Inst(Win64EH::UOP_PushNonVol, Label, Register);
493 CurFrame->Instructions.push_back(Inst);
496 void MCStreamer::EmitWin64EHSetFrame(unsigned Register, unsigned Offset) {
497 EnsureValidW64UnwindInfo();
498 MCWin64EHUnwindInfo *CurFrame = CurrentW64UnwindInfo;
499 if (CurFrame->LastFrameInst >= 0)
500 report_fatal_error("Frame register and offset already specified!");
502 report_fatal_error("Misaligned frame pointer offset!");
503 MCWin64EHInstruction Inst(Win64EH::UOP_SetFPReg, NULL, Register, Offset);
504 CurFrame->LastFrameInst = CurFrame->Instructions.size();
505 CurFrame->Instructions.push_back(Inst);
508 void MCStreamer::EmitWin64EHAllocStack(unsigned Size) {
509 EnsureValidW64UnwindInfo();
511 report_fatal_error("Misaligned stack allocation!");
512 MCWin64EHUnwindInfo *CurFrame = CurrentW64UnwindInfo;
513 MCSymbol *Label = getContext().CreateTempSymbol();
514 MCWin64EHInstruction Inst(Label, Size);
516 CurFrame->Instructions.push_back(Inst);
519 void MCStreamer::EmitWin64EHSaveReg(unsigned Register, unsigned Offset) {
520 EnsureValidW64UnwindInfo();
522 report_fatal_error("Misaligned saved register offset!");
523 MCWin64EHUnwindInfo *CurFrame = CurrentW64UnwindInfo;
524 MCSymbol *Label = getContext().CreateTempSymbol();
525 MCWin64EHInstruction Inst(
526 Offset > 512*1024-8 ? Win64EH::UOP_SaveNonVolBig : Win64EH::UOP_SaveNonVol,
527 Label, Register, Offset);
529 CurFrame->Instructions.push_back(Inst);
532 void MCStreamer::EmitWin64EHSaveXMM(unsigned Register, unsigned Offset) {
533 EnsureValidW64UnwindInfo();
535 report_fatal_error("Misaligned saved vector register offset!");
536 MCWin64EHUnwindInfo *CurFrame = CurrentW64UnwindInfo;
537 MCSymbol *Label = getContext().CreateTempSymbol();
538 MCWin64EHInstruction Inst(
539 Offset > 512*1024-16 ? Win64EH::UOP_SaveXMM128Big : Win64EH::UOP_SaveXMM128,
540 Label, Register, Offset);
542 CurFrame->Instructions.push_back(Inst);
545 void MCStreamer::EmitWin64EHPushFrame(bool Code) {
546 EnsureValidW64UnwindInfo();
547 MCWin64EHUnwindInfo *CurFrame = CurrentW64UnwindInfo;
548 if (CurFrame->Instructions.size() > 0)
549 report_fatal_error("If present, PushMachFrame must be the first UOP");
550 MCSymbol *Label = getContext().CreateTempSymbol();
551 MCWin64EHInstruction Inst(Win64EH::UOP_PushMachFrame, Label, Code);
553 CurFrame->Instructions.push_back(Inst);
556 void MCStreamer::EmitWin64EHEndProlog() {
557 EnsureValidW64UnwindInfo();
558 MCWin64EHUnwindInfo *CurFrame = CurrentW64UnwindInfo;
559 CurFrame->PrologEnd = getContext().CreateTempSymbol();
560 EmitLabel(CurFrame->PrologEnd);
563 void MCStreamer::EmitFnStart() {
564 errs() << "Not implemented yet\n";
568 void MCStreamer::EmitFnEnd() {
569 errs() << "Not implemented yet\n";
573 void MCStreamer::EmitCantUnwind() {
574 errs() << "Not implemented yet\n";
578 void MCStreamer::EmitHandlerData() {
579 errs() << "Not implemented yet\n";
583 void MCStreamer::EmitPersonality(const MCSymbol *Personality) {
584 errs() << "Not implemented yet\n";
588 void MCStreamer::EmitSetFP(unsigned FpReg, unsigned SpReg, int64_t Offset) {
589 errs() << "Not implemented yet\n";
593 void MCStreamer::EmitPad(int64_t Offset) {
594 errs() << "Not implemented yet\n";
598 void MCStreamer::EmitRegSave(const SmallVectorImpl<unsigned> &RegList, bool) {
599 errs() << "Not implemented yet\n";
603 /// EmitRawText - If this file is backed by an assembly streamer, this dumps
604 /// the specified string in the output .s file. This capability is
605 /// indicated by the hasRawTextSupport() predicate.
606 void MCStreamer::EmitRawText(StringRef String) {
607 errs() << "EmitRawText called on an MCStreamer that doesn't support it, "
608 " something must not be fully mc'ized\n";
612 void MCStreamer::EmitRawText(const Twine &T) {
613 SmallString<128> Str;
615 EmitRawText(Str.str());
618 void MCStreamer::EmitFrames(bool usingCFI) {
619 if (!getNumFrameInfos())
623 MCDwarfFrameEmitter::Emit(*this, usingCFI, true);
626 MCDwarfFrameEmitter::Emit(*this, usingCFI, false);
629 void MCStreamer::EmitW64Tables() {
630 if (!getNumW64UnwindInfos())
633 MCWin64EHUnwindEmitter::Emit(*this);