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 MCCFIInstruction Instruction =
243 MCCFIInstruction::createDefCfa(Label, Register, Offset);
244 CurFrame->Instructions.push_back(Instruction);
247 void MCStreamer::EmitCFIDefCfaOffset(int64_t Offset) {
249 MCDwarfFrameInfo *CurFrame = getCurrentFrameInfo();
250 MCSymbol *Label = getContext().CreateTempSymbol();
252 MCCFIInstruction Instruction =
253 MCCFIInstruction::createDefCfaOffset(Label, Offset);
254 CurFrame->Instructions.push_back(Instruction);
257 void MCStreamer::EmitCFIAdjustCfaOffset(int64_t Adjustment) {
259 MCDwarfFrameInfo *CurFrame = getCurrentFrameInfo();
260 MCSymbol *Label = getContext().CreateTempSymbol();
262 MCCFIInstruction Instruction =
263 MCCFIInstruction::createAdjustCfaOffset(Label, Adjustment);
264 CurFrame->Instructions.push_back(Instruction);
267 void MCStreamer::EmitCFIDefCfaRegister(int64_t Register) {
269 MCDwarfFrameInfo *CurFrame = getCurrentFrameInfo();
270 MCSymbol *Label = getContext().CreateTempSymbol();
272 MCCFIInstruction Instruction =
273 MCCFIInstruction::createDefCfaRegister(Label, Register);
274 CurFrame->Instructions.push_back(Instruction);
277 void MCStreamer::EmitCFIOffset(int64_t Register, int64_t Offset) {
279 MCDwarfFrameInfo *CurFrame = getCurrentFrameInfo();
280 MCSymbol *Label = getContext().CreateTempSymbol();
282 MCCFIInstruction Instruction =
283 MCCFIInstruction::createCFIOffset(Label, Register, Offset);
284 CurFrame->Instructions.push_back(Instruction);
287 void MCStreamer::EmitCFIRelOffset(int64_t Register, int64_t Offset) {
289 MCDwarfFrameInfo *CurFrame = getCurrentFrameInfo();
290 MCSymbol *Label = getContext().CreateTempSymbol();
292 MCCFIInstruction Instruction =
293 MCCFIInstruction::createRelOffset(Label, Register, Offset);
294 CurFrame->Instructions.push_back(Instruction);
297 void MCStreamer::EmitCFIPersonality(const MCSymbol *Sym,
300 MCDwarfFrameInfo *CurFrame = getCurrentFrameInfo();
301 CurFrame->Personality = Sym;
302 CurFrame->PersonalityEncoding = Encoding;
305 void MCStreamer::EmitCFILsda(const MCSymbol *Sym, unsigned Encoding) {
307 MCDwarfFrameInfo *CurFrame = getCurrentFrameInfo();
308 CurFrame->Lsda = Sym;
309 CurFrame->LsdaEncoding = Encoding;
312 void MCStreamer::EmitCFIRememberState() {
314 MCDwarfFrameInfo *CurFrame = getCurrentFrameInfo();
315 MCSymbol *Label = getContext().CreateTempSymbol();
317 MCCFIInstruction Instruction = MCCFIInstruction::createRememberState(Label);
318 CurFrame->Instructions.push_back(Instruction);
321 void MCStreamer::EmitCFIRestoreState() {
322 // FIXME: Error if there is no matching cfi_remember_state.
324 MCDwarfFrameInfo *CurFrame = getCurrentFrameInfo();
325 MCSymbol *Label = getContext().CreateTempSymbol();
327 MCCFIInstruction Instruction = MCCFIInstruction::createRestoreState(Label);
328 CurFrame->Instructions.push_back(Instruction);
331 void MCStreamer::EmitCFISameValue(int64_t Register) {
333 MCDwarfFrameInfo *CurFrame = getCurrentFrameInfo();
334 MCSymbol *Label = getContext().CreateTempSymbol();
336 MCCFIInstruction Instruction =
337 MCCFIInstruction::createSameValue(Label, Register);
338 CurFrame->Instructions.push_back(Instruction);
341 void MCStreamer::EmitCFIRestore(int64_t Register) {
343 MCDwarfFrameInfo *CurFrame = getCurrentFrameInfo();
344 MCSymbol *Label = getContext().CreateTempSymbol();
346 MCCFIInstruction Instruction =
347 MCCFIInstruction::createRestore(Label, Register);
348 CurFrame->Instructions.push_back(Instruction);
351 void MCStreamer::EmitCFIEscape(StringRef Values) {
353 MCDwarfFrameInfo *CurFrame = getCurrentFrameInfo();
354 MCSymbol *Label = getContext().CreateTempSymbol();
356 MCCFIInstruction Instruction = MCCFIInstruction::createEscape(Label, Values);
357 CurFrame->Instructions.push_back(Instruction);
360 void MCStreamer::EmitCFISignalFrame() {
362 MCDwarfFrameInfo *CurFrame = getCurrentFrameInfo();
363 CurFrame->IsSignalFrame = true;
366 void MCStreamer::EmitCFIUndefined(int64_t Register) {
368 MCDwarfFrameInfo *CurFrame = getCurrentFrameInfo();
369 MCSymbol *Label = getContext().CreateTempSymbol();
371 MCCFIInstruction Instruction =
372 MCCFIInstruction::createUndefined(Label, Register);
373 CurFrame->Instructions.push_back(Instruction);
376 void MCStreamer::setCurrentW64UnwindInfo(MCWin64EHUnwindInfo *Frame) {
377 W64UnwindInfos.push_back(Frame);
378 CurrentW64UnwindInfo = W64UnwindInfos.back();
381 void MCStreamer::EnsureValidW64UnwindInfo() {
382 MCWin64EHUnwindInfo *CurFrame = CurrentW64UnwindInfo;
383 if (!CurFrame || CurFrame->End)
384 report_fatal_error("No open Win64 EH frame function!");
387 void MCStreamer::EmitWin64EHStartProc(const MCSymbol *Symbol) {
388 MCWin64EHUnwindInfo *CurFrame = CurrentW64UnwindInfo;
389 if (CurFrame && !CurFrame->End)
390 report_fatal_error("Starting a function before ending the previous one!");
391 MCWin64EHUnwindInfo *Frame = new MCWin64EHUnwindInfo;
392 Frame->Begin = getContext().CreateTempSymbol();
393 Frame->Function = Symbol;
394 EmitLabel(Frame->Begin);
395 setCurrentW64UnwindInfo(Frame);
398 void MCStreamer::EmitWin64EHEndProc() {
399 EnsureValidW64UnwindInfo();
400 MCWin64EHUnwindInfo *CurFrame = CurrentW64UnwindInfo;
401 if (CurFrame->ChainedParent)
402 report_fatal_error("Not all chained regions terminated!");
403 CurFrame->End = getContext().CreateTempSymbol();
404 EmitLabel(CurFrame->End);
407 void MCStreamer::EmitWin64EHStartChained() {
408 EnsureValidW64UnwindInfo();
409 MCWin64EHUnwindInfo *Frame = new MCWin64EHUnwindInfo;
410 MCWin64EHUnwindInfo *CurFrame = CurrentW64UnwindInfo;
411 Frame->Begin = getContext().CreateTempSymbol();
412 Frame->Function = CurFrame->Function;
413 Frame->ChainedParent = CurFrame;
414 EmitLabel(Frame->Begin);
415 setCurrentW64UnwindInfo(Frame);
418 void MCStreamer::EmitWin64EHEndChained() {
419 EnsureValidW64UnwindInfo();
420 MCWin64EHUnwindInfo *CurFrame = CurrentW64UnwindInfo;
421 if (!CurFrame->ChainedParent)
422 report_fatal_error("End of a chained region outside a chained region!");
423 CurFrame->End = getContext().CreateTempSymbol();
424 EmitLabel(CurFrame->End);
425 CurrentW64UnwindInfo = CurFrame->ChainedParent;
428 void MCStreamer::EmitWin64EHHandler(const MCSymbol *Sym, bool Unwind,
430 EnsureValidW64UnwindInfo();
431 MCWin64EHUnwindInfo *CurFrame = CurrentW64UnwindInfo;
432 if (CurFrame->ChainedParent)
433 report_fatal_error("Chained unwind areas can't have handlers!");
434 CurFrame->ExceptionHandler = Sym;
435 if (!Except && !Unwind)
436 report_fatal_error("Don't know what kind of handler this is!");
438 CurFrame->HandlesUnwind = true;
440 CurFrame->HandlesExceptions = true;
443 void MCStreamer::EmitWin64EHHandlerData() {
444 EnsureValidW64UnwindInfo();
445 MCWin64EHUnwindInfo *CurFrame = CurrentW64UnwindInfo;
446 if (CurFrame->ChainedParent)
447 report_fatal_error("Chained unwind areas can't have handlers!");
450 void MCStreamer::EmitWin64EHPushReg(unsigned Register) {
451 EnsureValidW64UnwindInfo();
452 MCWin64EHUnwindInfo *CurFrame = CurrentW64UnwindInfo;
453 MCSymbol *Label = getContext().CreateTempSymbol();
454 MCWin64EHInstruction Inst(Win64EH::UOP_PushNonVol, Label, Register);
456 CurFrame->Instructions.push_back(Inst);
459 void MCStreamer::EmitWin64EHSetFrame(unsigned Register, unsigned Offset) {
460 EnsureValidW64UnwindInfo();
461 MCWin64EHUnwindInfo *CurFrame = CurrentW64UnwindInfo;
462 if (CurFrame->LastFrameInst >= 0)
463 report_fatal_error("Frame register and offset already specified!");
465 report_fatal_error("Misaligned frame pointer offset!");
466 MCWin64EHInstruction Inst(Win64EH::UOP_SetFPReg, NULL, Register, Offset);
467 CurFrame->LastFrameInst = CurFrame->Instructions.size();
468 CurFrame->Instructions.push_back(Inst);
471 void MCStreamer::EmitWin64EHAllocStack(unsigned Size) {
472 EnsureValidW64UnwindInfo();
474 report_fatal_error("Misaligned stack allocation!");
475 MCWin64EHUnwindInfo *CurFrame = CurrentW64UnwindInfo;
476 MCSymbol *Label = getContext().CreateTempSymbol();
477 MCWin64EHInstruction Inst(Label, Size);
479 CurFrame->Instructions.push_back(Inst);
482 void MCStreamer::EmitWin64EHSaveReg(unsigned Register, unsigned Offset) {
483 EnsureValidW64UnwindInfo();
485 report_fatal_error("Misaligned saved register offset!");
486 MCWin64EHUnwindInfo *CurFrame = CurrentW64UnwindInfo;
487 MCSymbol *Label = getContext().CreateTempSymbol();
488 MCWin64EHInstruction Inst(
489 Offset > 512*1024-8 ? Win64EH::UOP_SaveNonVolBig : Win64EH::UOP_SaveNonVol,
490 Label, Register, Offset);
492 CurFrame->Instructions.push_back(Inst);
495 void MCStreamer::EmitWin64EHSaveXMM(unsigned Register, unsigned Offset) {
496 EnsureValidW64UnwindInfo();
498 report_fatal_error("Misaligned saved vector register offset!");
499 MCWin64EHUnwindInfo *CurFrame = CurrentW64UnwindInfo;
500 MCSymbol *Label = getContext().CreateTempSymbol();
501 MCWin64EHInstruction Inst(
502 Offset > 512*1024-16 ? Win64EH::UOP_SaveXMM128Big : Win64EH::UOP_SaveXMM128,
503 Label, Register, Offset);
505 CurFrame->Instructions.push_back(Inst);
508 void MCStreamer::EmitWin64EHPushFrame(bool Code) {
509 EnsureValidW64UnwindInfo();
510 MCWin64EHUnwindInfo *CurFrame = CurrentW64UnwindInfo;
511 if (CurFrame->Instructions.size() > 0)
512 report_fatal_error("If present, PushMachFrame must be the first UOP");
513 MCSymbol *Label = getContext().CreateTempSymbol();
514 MCWin64EHInstruction Inst(Win64EH::UOP_PushMachFrame, Label, Code);
516 CurFrame->Instructions.push_back(Inst);
519 void MCStreamer::EmitWin64EHEndProlog() {
520 EnsureValidW64UnwindInfo();
521 MCWin64EHUnwindInfo *CurFrame = CurrentW64UnwindInfo;
522 CurFrame->PrologEnd = getContext().CreateTempSymbol();
523 EmitLabel(CurFrame->PrologEnd);
526 void MCStreamer::EmitCOFFSecRel32(MCSymbol const *Symbol) {
527 llvm_unreachable("This file format doesn't support this directive");
530 void MCStreamer::EmitFnStart() {
531 errs() << "Not implemented yet\n";
535 void MCStreamer::EmitFnEnd() {
536 errs() << "Not implemented yet\n";
540 void MCStreamer::EmitCantUnwind() {
541 errs() << "Not implemented yet\n";
545 void MCStreamer::EmitHandlerData() {
546 errs() << "Not implemented yet\n";
550 void MCStreamer::EmitPersonality(const MCSymbol *Personality) {
551 errs() << "Not implemented yet\n";
555 void MCStreamer::EmitSetFP(unsigned FpReg, unsigned SpReg, int64_t Offset) {
556 errs() << "Not implemented yet\n";
560 void MCStreamer::EmitPad(int64_t Offset) {
561 errs() << "Not implemented yet\n";
565 void MCStreamer::EmitRegSave(const SmallVectorImpl<unsigned> &RegList, bool) {
566 errs() << "Not implemented yet\n";
570 void MCStreamer::EmitTCEntry(const MCSymbol &S) {
571 llvm_unreachable("Unsupported method");
574 /// EmitRawText - If this file is backed by an assembly streamer, this dumps
575 /// the specified string in the output .s file. This capability is
576 /// indicated by the hasRawTextSupport() predicate.
577 void MCStreamer::EmitRawText(StringRef String) {
578 errs() << "EmitRawText called on an MCStreamer that doesn't support it, "
579 " something must not be fully mc'ized\n";
583 void MCStreamer::EmitRawText(const Twine &T) {
584 SmallString<128> Str;
586 EmitRawText(Str.str());
589 void MCStreamer::EmitFrames(bool usingCFI) {
590 if (!getNumFrameInfos())
594 MCDwarfFrameEmitter::Emit(*this, usingCFI, true);
597 MCDwarfFrameEmitter::Emit(*this, usingCFI, false);
600 void MCStreamer::EmitW64Tables() {
601 if (!getNumW64UnwindInfos())
604 MCWin64EHUnwindEmitter::Emit(*this);
607 void MCStreamer::Finish() {
608 if (!FrameInfos.empty() && !FrameInfos.back().End)
609 report_fatal_error("Unfinished frame!");