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 const MCSection *section = NULL;
26 SectionStack.push_back(std::make_pair(section, section));
29 MCStreamer::~MCStreamer() {
32 const MCExpr *MCStreamer::BuildSymbolDiff(MCContext &Context,
35 MCSymbolRefExpr::VariantKind Variant = MCSymbolRefExpr::VK_None;
37 MCSymbolRefExpr::Create(A, Variant, Context);
39 MCSymbolRefExpr::Create(B, Variant, Context);
40 const MCExpr *AddrDelta =
41 MCBinaryExpr::Create(MCBinaryExpr::Sub, ARef, BRef, Context);
45 const MCExpr *MCStreamer::ForceExpAbs(const MCExpr* Expr) {
46 if (Context.getAsmInfo().hasAggressiveSymbolFolding() ||
47 isa<MCSymbolRefExpr>(Expr))
50 MCSymbol *ABS = Context.CreateTempSymbol();
51 EmitAssignment(ABS, Expr);
52 return MCSymbolRefExpr::Create(ABS, Context);
55 raw_ostream &MCStreamer::GetCommentOS() {
56 // By default, discard comments.
60 void MCStreamer::EmitDwarfSetLineAddr(int64_t LineDelta,
61 const MCSymbol *Label, int PointerSize) {
62 // emit the sequence to set the address
63 EmitIntValue(dwarf::DW_LNS_extended_op, 1);
64 EmitULEB128IntValue(PointerSize + 1);
65 EmitIntValue(dwarf::DW_LNE_set_address, 1);
66 EmitSymbolValue(Label, PointerSize);
68 // emit the sequence for the LineDelta (from 1) and a zero address delta.
69 MCDwarfLineAddr::Emit(this, LineDelta, 0);
72 /// EmitIntValue - Special case of EmitValue that avoids the client having to
73 /// pass in a MCExpr for constant integers.
74 void MCStreamer::EmitIntValue(uint64_t Value, unsigned Size,
76 assert(Size <= 8 && "Invalid size");
77 assert((isUIntN(8 * Size, Value) || isIntN(8 * Size, Value)) &&
80 // FIXME: Endianness assumption.
81 for (unsigned i = 0; i != Size; ++i)
82 buf[i] = uint8_t(Value >> (i * 8));
83 EmitBytes(StringRef(buf, Size), AddrSpace);
86 /// EmitULEB128Value - Special case of EmitULEB128Value that avoids the
87 /// client having to pass in a MCExpr for constant integers.
88 void MCStreamer::EmitULEB128IntValue(uint64_t Value, unsigned AddrSpace) {
90 raw_svector_ostream OSE(Tmp);
91 MCObjectWriter::EncodeULEB128(Value, OSE);
92 EmitBytes(OSE.str(), AddrSpace);
95 /// EmitSLEB128Value - Special case of EmitSLEB128Value that avoids the
96 /// client having to pass in a MCExpr for constant integers.
97 void MCStreamer::EmitSLEB128IntValue(int64_t Value, unsigned AddrSpace) {
99 raw_svector_ostream OSE(Tmp);
100 MCObjectWriter::EncodeSLEB128(Value, OSE);
101 EmitBytes(OSE.str(), AddrSpace);
104 void MCStreamer::EmitAbsValue(const MCExpr *Value, unsigned Size,
105 unsigned AddrSpace) {
106 const MCExpr *ABS = ForceExpAbs(Value);
107 EmitValue(ABS, Size, AddrSpace);
111 void MCStreamer::EmitValue(const MCExpr *Value, unsigned Size,
112 unsigned AddrSpace) {
113 EmitValueImpl(Value, Size, AddrSpace);
116 void MCStreamer::EmitSymbolValue(const MCSymbol *Sym, unsigned Size,
117 unsigned AddrSpace) {
118 EmitValueImpl(MCSymbolRefExpr::Create(Sym, getContext()), Size,
122 void MCStreamer::EmitGPRel32Value(const MCExpr *Value) {
123 report_fatal_error("unsupported directive in streamer");
126 /// EmitFill - Emit NumBytes bytes worth of the value specified by
127 /// FillValue. This implements directives such as '.space'.
128 void MCStreamer::EmitFill(uint64_t NumBytes, uint8_t FillValue,
129 unsigned AddrSpace) {
130 const MCExpr *E = MCConstantExpr::Create(FillValue, getContext());
131 for (uint64_t i = 0, e = NumBytes; i != e; ++i)
132 EmitValue(E, 1, AddrSpace);
135 bool MCStreamer::EmitDwarfFileDirective(unsigned FileNo,
136 StringRef Filename) {
137 return getContext().GetDwarfFile(Filename, FileNo) == 0;
140 void MCStreamer::EmitDwarfLocDirective(unsigned FileNo, unsigned Line,
141 unsigned Column, unsigned Flags,
143 unsigned Discriminator,
144 StringRef FileName) {
145 getContext().setCurrentDwarfLoc(FileNo, Line, Column, Flags, Isa,
149 MCDwarfFrameInfo *MCStreamer::getCurrentFrameInfo() {
150 if (FrameInfos.empty())
152 return &FrameInfos.back();
155 void MCStreamer::EnsureValidFrame() {
156 MCDwarfFrameInfo *CurFrame = getCurrentFrameInfo();
157 if (!CurFrame || CurFrame->End)
158 report_fatal_error("No open frame");
161 void MCStreamer::EmitEHSymAttributes(const MCSymbol *Symbol,
162 MCSymbol *EHSymbol) {
165 void MCStreamer::EmitLabel(MCSymbol *Symbol) {
166 assert(!Symbol->isVariable() && "Cannot emit a variable symbol!");
167 assert(getCurrentSection() && "Cannot emit before setting section!");
168 Symbol->setSection(*getCurrentSection());
170 StringRef Prefix = getContext().getAsmInfo().getPrivateGlobalPrefix();
171 if (!Symbol->getName().startswith(Prefix))
172 LastNonPrivate = Symbol;
175 void MCStreamer::EmitCFISections(bool EH, bool Debug) {
178 EmitDebugFrame = Debug;
181 void MCStreamer::EmitCFIStartProc() {
182 MCDwarfFrameInfo *CurFrame = getCurrentFrameInfo();
183 if (CurFrame && !CurFrame->End)
184 report_fatal_error("Starting a frame before finishing the previous one!");
185 MCDwarfFrameInfo Frame;
186 Frame.Begin = getContext().CreateTempSymbol();
187 Frame.Function = LastNonPrivate;
188 EmitLabel(Frame.Begin);
189 FrameInfos.push_back(Frame);
192 void MCStreamer::EmitCFIEndProc() {
194 MCDwarfFrameInfo *CurFrame = getCurrentFrameInfo();
195 CurFrame->End = getContext().CreateTempSymbol();
196 EmitLabel(CurFrame->End);
199 void MCStreamer::EmitCFIDefCfa(int64_t Register, int64_t Offset) {
201 MCDwarfFrameInfo *CurFrame = getCurrentFrameInfo();
202 MCSymbol *Label = getContext().CreateTempSymbol();
204 MachineLocation Dest(MachineLocation::VirtualFP);
205 MachineLocation Source(Register, -Offset);
206 MCCFIInstruction Instruction(Label, Dest, Source);
207 CurFrame->Instructions.push_back(Instruction);
210 void MCStreamer::EmitCFIDefCfaOffset(int64_t Offset) {
212 MCDwarfFrameInfo *CurFrame = getCurrentFrameInfo();
213 MCSymbol *Label = getContext().CreateTempSymbol();
215 MachineLocation Dest(MachineLocation::VirtualFP);
216 MachineLocation Source(MachineLocation::VirtualFP, -Offset);
217 MCCFIInstruction Instruction(Label, Dest, Source);
218 CurFrame->Instructions.push_back(Instruction);
221 void MCStreamer::EmitCFIAdjustCfaOffset(int64_t Adjustment) {
223 MCDwarfFrameInfo *CurFrame = getCurrentFrameInfo();
224 MCSymbol *Label = getContext().CreateTempSymbol();
226 MachineLocation Dest(MachineLocation::VirtualFP);
227 MachineLocation Source(MachineLocation::VirtualFP, Adjustment);
228 MCCFIInstruction Instruction(MCCFIInstruction::RelMove, Label, Dest, Source);
229 CurFrame->Instructions.push_back(Instruction);
232 void MCStreamer::EmitCFIDefCfaRegister(int64_t Register) {
234 MCDwarfFrameInfo *CurFrame = getCurrentFrameInfo();
235 MCSymbol *Label = getContext().CreateTempSymbol();
237 MachineLocation Dest(Register);
238 MachineLocation Source(MachineLocation::VirtualFP);
239 MCCFIInstruction Instruction(Label, Dest, Source);
240 CurFrame->Instructions.push_back(Instruction);
243 void MCStreamer::EmitCFIOffset(int64_t Register, int64_t Offset) {
245 MCDwarfFrameInfo *CurFrame = getCurrentFrameInfo();
246 MCSymbol *Label = getContext().CreateTempSymbol();
248 MachineLocation Dest(Register, Offset);
249 MachineLocation Source(Register, Offset);
250 MCCFIInstruction Instruction(Label, Dest, Source);
251 CurFrame->Instructions.push_back(Instruction);
254 void MCStreamer::EmitCFIRelOffset(int64_t Register, int64_t Offset) {
256 MCDwarfFrameInfo *CurFrame = getCurrentFrameInfo();
257 MCSymbol *Label = getContext().CreateTempSymbol();
259 MachineLocation Dest(Register, Offset);
260 MachineLocation Source(Register, Offset);
261 MCCFIInstruction Instruction(MCCFIInstruction::RelMove, Label, Dest, Source);
262 CurFrame->Instructions.push_back(Instruction);
265 void MCStreamer::EmitCFIPersonality(const MCSymbol *Sym,
268 MCDwarfFrameInfo *CurFrame = getCurrentFrameInfo();
269 CurFrame->Personality = Sym;
270 CurFrame->PersonalityEncoding = Encoding;
273 void MCStreamer::EmitCFILsda(const MCSymbol *Sym, unsigned Encoding) {
275 MCDwarfFrameInfo *CurFrame = getCurrentFrameInfo();
276 CurFrame->Lsda = Sym;
277 CurFrame->LsdaEncoding = Encoding;
280 void MCStreamer::EmitCFIRememberState() {
282 MCDwarfFrameInfo *CurFrame = getCurrentFrameInfo();
283 MCSymbol *Label = getContext().CreateTempSymbol();
285 MCCFIInstruction Instruction(MCCFIInstruction::Remember, Label);
286 CurFrame->Instructions.push_back(Instruction);
289 void MCStreamer::EmitCFIRestoreState() {
290 // FIXME: Error if there is no matching cfi_remember_state.
292 MCDwarfFrameInfo *CurFrame = getCurrentFrameInfo();
293 MCSymbol *Label = getContext().CreateTempSymbol();
295 MCCFIInstruction Instruction(MCCFIInstruction::Restore, Label);
296 CurFrame->Instructions.push_back(Instruction);
299 void MCStreamer::EmitCFISameValue(int64_t Register) {
301 MCDwarfFrameInfo *CurFrame = getCurrentFrameInfo();
302 MCSymbol *Label = getContext().CreateTempSymbol();
304 MCCFIInstruction Instruction(MCCFIInstruction::SameValue, Label, Register);
305 CurFrame->Instructions.push_back(Instruction);
308 void MCStreamer::setCurrentW64UnwindInfo(MCWin64EHUnwindInfo *Frame) {
309 W64UnwindInfos.push_back(*Frame);
310 CurrentW64UnwindInfo = &W64UnwindInfos.back();
313 void MCStreamer::EnsureValidW64UnwindInfo() {
314 MCWin64EHUnwindInfo *CurFrame = CurrentW64UnwindInfo;
315 if (!CurFrame || CurFrame->End)
316 report_fatal_error("No open Win64 EH frame function!");
319 void MCStreamer::EmitWin64EHStartProc(MCSymbol *Symbol) {
320 MCWin64EHUnwindInfo *CurFrame = CurrentW64UnwindInfo;
321 if (CurFrame && !CurFrame->End)
322 report_fatal_error("Starting a function before ending the previous one!");
323 MCWin64EHUnwindInfo Frame;
324 Frame.Begin = getContext().CreateTempSymbol();
325 Frame.Function = Symbol;
326 EmitLabel(Frame.Begin);
327 setCurrentW64UnwindInfo(&Frame);
330 void MCStreamer::EmitWin64EHEndProc() {
331 EnsureValidW64UnwindInfo();
332 MCWin64EHUnwindInfo *CurFrame = CurrentW64UnwindInfo;
333 if (CurFrame->ChainedParent)
334 report_fatal_error("Not all chained regions terminated!");
335 CurFrame->End = getContext().CreateTempSymbol();
336 EmitLabel(CurFrame->End);
339 void MCStreamer::EmitWin64EHStartChained() {
340 EnsureValidW64UnwindInfo();
341 MCWin64EHUnwindInfo Frame;
342 MCWin64EHUnwindInfo *CurFrame = CurrentW64UnwindInfo;
343 Frame.Begin = getContext().CreateTempSymbol();
344 Frame.Function = CurFrame->Function;
345 Frame.ChainedParent = CurFrame;
346 EmitLabel(Frame.Begin);
347 setCurrentW64UnwindInfo(&Frame);
350 void MCStreamer::EmitWin64EHEndChained() {
351 EnsureValidW64UnwindInfo();
352 MCWin64EHUnwindInfo *CurFrame = CurrentW64UnwindInfo;
353 if (!CurFrame->ChainedParent)
354 report_fatal_error("End of a chained region outside a chained region!");
355 CurFrame->End = getContext().CreateTempSymbol();
356 EmitLabel(CurFrame->End);
357 CurrentW64UnwindInfo = CurFrame->ChainedParent;
360 void MCStreamer::EmitWin64EHHandler(const MCSymbol *Sym, bool Unwind,
362 EnsureValidW64UnwindInfo();
363 MCWin64EHUnwindInfo *CurFrame = CurrentW64UnwindInfo;
364 CurFrame->ExceptionHandler = Sym;
365 if (!Except && !Unwind)
366 report_fatal_error("Don't know what kind of handler this is!");
368 CurFrame->HandlesUnwind = true;
370 CurFrame->HandlesExceptions = true;
373 void MCStreamer::EmitWin64EHHandlerData() {
374 EnsureValidW64UnwindInfo();
377 void MCStreamer::EmitWin64EHPushReg(unsigned Register) {
378 EnsureValidW64UnwindInfo();
379 MCWin64EHUnwindInfo *CurFrame = CurrentW64UnwindInfo;
380 MCWin64EHInstruction Inst(Win64EH::UOP_PushNonVol, Register);
381 CurFrame->Instructions.push_back(Inst);
384 void MCStreamer::EmitWin64EHSetFrame(unsigned Register, unsigned Offset) {
385 EnsureValidW64UnwindInfo();
386 MCWin64EHUnwindInfo *CurFrame = CurrentW64UnwindInfo;
387 MCWin64EHInstruction Inst(Win64EH::UOP_SetFPReg, Register, Offset);
388 CurFrame->LastFrameInst = CurFrame->Instructions.size();
389 CurFrame->Instructions.push_back(Inst);
392 void MCStreamer::EmitWin64EHAllocStack(unsigned Size) {
393 EnsureValidW64UnwindInfo();
394 MCWin64EHUnwindInfo *CurFrame = CurrentW64UnwindInfo;
395 MCWin64EHInstruction Inst(Size);
396 CurFrame->Instructions.push_back(Inst);
399 void MCStreamer::EmitWin64EHSaveReg(unsigned Register, unsigned Offset) {
400 EnsureValidW64UnwindInfo();
401 MCWin64EHUnwindInfo *CurFrame = CurrentW64UnwindInfo;
402 MCWin64EHInstruction Inst(
403 Offset > 0xFFFF ? Win64EH::UOP_SaveNonVol : Win64EH::UOP_SaveNonVolBig,
405 CurFrame->Instructions.push_back(Inst);
408 void MCStreamer::EmitWin64EHSaveXMM(unsigned Register, unsigned Offset) {
409 EnsureValidW64UnwindInfo();
410 MCWin64EHUnwindInfo *CurFrame = CurrentW64UnwindInfo;
411 MCWin64EHInstruction Inst(
412 Offset > 0xFFFF ? Win64EH::UOP_SaveXMM128 : Win64EH::UOP_SaveXMM128Big,
414 CurFrame->Instructions.push_back(Inst);
417 void MCStreamer::EmitWin64EHPushFrame(bool Code) {
418 EnsureValidW64UnwindInfo();
419 MCWin64EHUnwindInfo *CurFrame = CurrentW64UnwindInfo;
420 MCWin64EHInstruction Inst(Win64EH::UOP_PushMachFrame, Code);
421 CurFrame->Instructions.push_back(Inst);
424 void MCStreamer::EmitWin64EHEndProlog() {
425 EnsureValidW64UnwindInfo();
426 MCWin64EHUnwindInfo *CurFrame = CurrentW64UnwindInfo;
427 CurFrame->PrologEnd = getContext().CreateTempSymbol();
428 EmitLabel(CurFrame->PrologEnd);
431 void MCStreamer::EmitFnStart() {
432 errs() << "Not implemented yet\n";
436 void MCStreamer::EmitFnEnd() {
437 errs() << "Not implemented yet\n";
441 void MCStreamer::EmitCantUnwind() {
442 errs() << "Not implemented yet\n";
446 void MCStreamer::EmitHandlerData() {
447 errs() << "Not implemented yet\n";
451 void MCStreamer::EmitPersonality(const MCSymbol *Personality) {
452 errs() << "Not implemented yet\n";
456 void MCStreamer::EmitSetFP(unsigned FpReg, unsigned SpReg, int64_t Offset) {
457 errs() << "Not implemented yet\n";
461 void MCStreamer::EmitPad(int64_t Offset) {
462 errs() << "Not implemented yet\n";
466 void MCStreamer::EmitRegSave(const SmallVectorImpl<unsigned> &RegList, bool) {
467 errs() << "Not implemented yet\n";
471 /// EmitRawText - If this file is backed by an assembly streamer, this dumps
472 /// the specified string in the output .s file. This capability is
473 /// indicated by the hasRawTextSupport() predicate.
474 void MCStreamer::EmitRawText(StringRef String) {
475 errs() << "EmitRawText called on an MCStreamer that doesn't support it, "
476 " something must not be fully mc'ized\n";
480 void MCStreamer::EmitRawText(const Twine &T) {
481 SmallString<128> Str;
483 EmitRawText(Str.str());
486 void MCStreamer::EmitFrames(bool usingCFI) {
487 if (!getNumFrameInfos())
491 MCDwarfFrameEmitter::Emit(*this, usingCFI, true);
494 MCDwarfFrameEmitter::Emit(*this, usingCFI, false);