1 //===- MCStreamer.h - High-level Streaming Machine Code Output --*- C++ -*-===//
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 // This file declares the MCStreamer class.
12 //===----------------------------------------------------------------------===//
14 #ifndef LLVM_MC_MCSTREAMER_H
15 #define LLVM_MC_MCSTREAMER_H
17 #include "llvm/ADT/ArrayRef.h"
18 #include "llvm/ADT/SmallVector.h"
19 #include "llvm/MC/MCAssembler.h"
20 #include "llvm/MC/MCDirectives.h"
21 #include "llvm/MC/MCDwarf.h"
22 #include "llvm/MC/MCLinkerOptimizationHint.h"
23 #include "llvm/MC/MCWin64EH.h"
24 #include "llvm/Support/DataTypes.h"
37 class MCSymbolRefExpr;
38 class MCSubtargetInfo;
42 class formatted_raw_ostream;
43 class AssemblerConstantPools;
45 typedef std::pair<const MCSection *, const MCExpr *> MCSectionSubPair;
47 /// Target specific streamer interface. This is used so that targets can
48 /// implement support for target specific assembly directives.
50 /// If target foo wants to use this, it should implement 3 classes:
51 /// * FooTargetStreamer : public MCTargetStreamer
52 /// * FooTargetAsmSreamer : public FooTargetStreamer
53 /// * FooTargetELFStreamer : public FooTargetStreamer
55 /// FooTargetStreamer should have a pure virtual method for each directive. For
56 /// example, for a ".bar symbol_name" directive, it should have
57 /// virtual emitBar(const MCSymbol &Symbol) = 0;
59 /// The FooTargetAsmSreamer and FooTargetELFStreamer classes implement the
60 /// method. The assembly streamer just prints ".bar symbol_name". The object
61 /// streamer does whatever is needed to implement .bar in the object file.
63 /// In the assembly printer and parser the target streamer can be used by
64 /// calling getTargetStreamer and casting it to FooTargetStreamer:
66 /// MCTargetStreamer &TS = OutStreamer.getTargetStreamer();
67 /// FooTargetStreamer &ATS = static_cast<FooTargetStreamer &>(TS);
69 /// The base classes FooTargetAsmSreamer and FooTargetELFStreamer should *never*
70 /// be treated differently. Callers should always talk to a FooTargetStreamer.
71 class MCTargetStreamer {
76 MCTargetStreamer(MCStreamer &S);
77 virtual ~MCTargetStreamer();
79 const MCStreamer &getStreamer() { return Streamer; }
81 // Allow a target to add behavior to the EmitLabel of MCStreamer.
82 virtual void emitLabel(MCSymbol *Symbol);
83 // Allow a target to add behavior to the emitAssignment of MCStreamer.
84 virtual void emitAssignment(MCSymbol *Symbol, const MCExpr *Value);
86 virtual void finish();
89 // FIXME: declared here because it is used from
90 // lib/CodeGen/AsmPrinter/ARMException.cpp.
91 class ARMTargetStreamer : public MCTargetStreamer {
93 ARMTargetStreamer(MCStreamer &S);
96 virtual void emitFnStart();
97 virtual void emitFnEnd();
98 virtual void emitCantUnwind();
99 virtual void emitPersonality(const MCSymbol *Personality);
100 virtual void emitPersonalityIndex(unsigned Index);
101 virtual void emitHandlerData();
102 virtual void emitSetFP(unsigned FpReg, unsigned SpReg,
104 virtual void emitMovSP(unsigned Reg, int64_t Offset = 0);
105 virtual void emitPad(int64_t Offset);
106 virtual void emitRegSave(const SmallVectorImpl<unsigned> &RegList,
108 virtual void emitUnwindRaw(int64_t StackOffset,
109 const SmallVectorImpl<uint8_t> &Opcodes);
111 virtual void switchVendor(StringRef Vendor);
112 virtual void emitAttribute(unsigned Attribute, unsigned Value);
113 virtual void emitTextAttribute(unsigned Attribute, StringRef String);
114 virtual void emitIntTextAttribute(unsigned Attribute, unsigned IntValue,
115 StringRef StringValue = "");
116 virtual void emitFPU(unsigned FPU);
117 virtual void emitArch(unsigned Arch);
118 virtual void emitObjectArch(unsigned Arch);
119 virtual void finishAttributeSection();
120 virtual void emitInst(uint32_t Inst, char Suffix = '\0');
122 virtual void AnnotateTLSDescriptorSequence(const MCSymbolRefExpr *SRE);
124 void finish() override;
126 /// Callback used to implement the ldr= pseudo.
127 /// Add a new entry to the constant pool for the current section and return an
128 /// MCExpr that can be used to refer to the constant pool location.
129 const MCExpr *addConstantPoolEntry(const MCExpr *);
131 /// Callback used to implemnt the .ltorg directive.
132 /// Emit contents of constant pool for the current section.
133 void emitCurrentConstantPool();
136 std::unique_ptr<AssemblerConstantPools> ConstantPools;
139 /// MCStreamer - Streaming machine code generation interface. This interface
140 /// is intended to provide a programatic interface that is very similar to the
141 /// level that an assembler .s file provides. It has callbacks to emit bytes,
142 /// handle directives, etc. The implementation of this interface retains
143 /// state to know what the current section is etc.
145 /// There are multiple implementations of this interface: one for writing out
146 /// a .s file, and implementations that write out .o files of various formats.
150 std::unique_ptr<MCTargetStreamer> TargetStreamer;
152 MCStreamer(const MCStreamer &) LLVM_DELETED_FUNCTION;
153 MCStreamer &operator=(const MCStreamer &) LLVM_DELETED_FUNCTION;
158 std::vector<MCDwarfFrameInfo> FrameInfos;
159 MCDwarfFrameInfo *getCurrentFrameInfo();
160 MCSymbol *EmitCFICommon();
161 void EnsureValidFrame();
163 std::vector<MCWin64EHUnwindInfo *> W64UnwindInfos;
164 MCWin64EHUnwindInfo *CurrentW64UnwindInfo;
165 void setCurrentW64UnwindInfo(MCWin64EHUnwindInfo *Frame);
166 void EnsureValidW64UnwindInfo();
168 MCSymbol *LastSymbol;
170 // SymbolOrdering - Tracks an index to represent the order
171 // a symbol was emitted in. Zero means we did not emit that symbol.
172 DenseMap<const MCSymbol *, unsigned> SymbolOrdering;
174 /// SectionStack - This is stack of current and previous section
175 /// values saved by PushSection.
176 SmallVector<std::pair<MCSectionSubPair, MCSectionSubPair>, 4> SectionStack;
179 MCStreamer(MCContext &Ctx);
181 const MCExpr *BuildSymbolDiff(MCContext &Context, const MCSymbol *A,
184 const MCExpr *ForceExpAbs(const MCExpr *Expr);
186 void RecordProcStart(MCDwarfFrameInfo &Frame);
187 virtual void EmitCFIStartProcImpl(MCDwarfFrameInfo &Frame);
188 void RecordProcEnd(MCDwarfFrameInfo &Frame);
189 virtual void EmitCFIEndProcImpl(MCDwarfFrameInfo &CurFrame);
190 void EmitFrames(MCAsmBackend *MAB, bool usingCFI);
192 MCWin64EHUnwindInfo *getCurrentW64UnwindInfo() {
193 return CurrentW64UnwindInfo;
195 void EmitW64Tables();
197 virtual void EmitRawTextImpl(StringRef String);
200 virtual ~MCStreamer();
202 void setTargetStreamer(MCTargetStreamer *TS) {
203 TargetStreamer.reset(TS);
208 virtual void reset();
210 MCContext &getContext() const { return Context; }
212 MCTargetStreamer *getTargetStreamer() {
213 return TargetStreamer.get();
216 unsigned getNumFrameInfos() { return FrameInfos.size(); }
218 const MCDwarfFrameInfo &getFrameInfo(unsigned i) { return FrameInfos[i]; }
220 ArrayRef<MCDwarfFrameInfo> getFrameInfos() const { return FrameInfos; }
222 unsigned getNumW64UnwindInfos() { return W64UnwindInfos.size(); }
224 MCWin64EHUnwindInfo &getW64UnwindInfo(unsigned i) {
225 return *W64UnwindInfos[i];
228 void generateCompactUnwindEncodings(MCAsmBackend *MAB);
230 /// @name Assembly File Formatting.
233 /// isVerboseAsm - Return true if this streamer supports verbose assembly
234 /// and if it is enabled.
235 virtual bool isVerboseAsm() const { return false; }
237 /// hasRawTextSupport - Return true if this asm streamer supports emitting
238 /// unformatted text to the .s file with EmitRawText.
239 virtual bool hasRawTextSupport() const { return false; }
241 /// Is the integrated assembler required for this streamer to function
243 virtual bool isIntegratedAssemblerRequired() const { return false; }
245 /// AddComment - Add a comment that can be emitted to the generated .s
246 /// file if applicable as a QoI issue to make the output of the compiler
247 /// more readable. This only affects the MCAsmStreamer, and only when
248 /// verbose assembly output is enabled.
250 /// If the comment includes embedded \n's, they will each get the comment
251 /// prefix as appropriate. The added comment should not end with a \n.
252 virtual void AddComment(const Twine &T) {}
254 /// GetCommentOS - Return a raw_ostream that comments can be written to.
255 /// Unlike AddComment, you are required to terminate comments with \n if you
257 virtual raw_ostream &GetCommentOS();
259 /// Print T and prefix it with the comment string (normally #) and optionally
260 /// a tab. This prints the comment immediately, not at the end of the
261 /// current line. It is basically a safe version of EmitRawText: since it
262 /// only prints comments, the object streamer ignores it instead of asserting.
263 virtual void emitRawComment(const Twine &T, bool TabPrefix = true);
265 /// AddBlankLine - Emit a blank line to a .s file to pretty it up.
266 virtual void AddBlankLine() {}
270 /// @name Symbol & Section Management
273 /// getCurrentSection - Return the current section that the streamer is
274 /// emitting code to.
275 MCSectionSubPair getCurrentSection() const {
276 if (!SectionStack.empty())
277 return SectionStack.back().first;
278 return MCSectionSubPair();
281 /// getPreviousSection - Return the previous section that the streamer is
282 /// emitting code to.
283 MCSectionSubPair getPreviousSection() const {
284 if (!SectionStack.empty())
285 return SectionStack.back().second;
286 return MCSectionSubPair();
289 /// GetSymbolOrder - Returns an index to represent the order
290 /// a symbol was emitted in. (zero if we did not emit that symbol)
291 unsigned GetSymbolOrder(const MCSymbol *Sym) const {
292 return SymbolOrdering.lookup(Sym);
295 /// ChangeSection - Update streamer for a new active section.
297 /// This is called by PopSection and SwitchSection, if the current
299 virtual void ChangeSection(const MCSection *, const MCExpr *) = 0;
301 /// pushSection - Save the current and previous section on the
304 SectionStack.push_back(
305 std::make_pair(getCurrentSection(), getPreviousSection()));
308 /// popSection - Restore the current and previous section from
309 /// the section stack. Calls ChangeSection as needed.
311 /// Returns false if the stack was empty.
313 if (SectionStack.size() <= 1)
315 MCSectionSubPair oldSection = SectionStack.pop_back_val().first;
316 MCSectionSubPair curSection = SectionStack.back().first;
318 if (oldSection != curSection)
319 ChangeSection(curSection.first, curSection.second);
323 bool SubSection(const MCExpr *Subsection) {
324 if (SectionStack.empty())
327 SwitchSection(SectionStack.back().first.first, Subsection);
331 /// SwitchSection - Set the current section where code is being emitted to
332 /// @p Section. This is required to update CurSection.
334 /// This corresponds to assembler directives like .section, .text, etc.
335 void SwitchSection(const MCSection *Section, const MCExpr *Subsection = 0) {
336 assert(Section && "Cannot switch to a null section!");
337 MCSectionSubPair curSection = SectionStack.back().first;
338 SectionStack.back().second = curSection;
339 if (MCSectionSubPair(Section, Subsection) != curSection) {
340 SectionStack.back().first = MCSectionSubPair(Section, Subsection);
341 ChangeSection(Section, Subsection);
345 /// SwitchSectionNoChange - Set the current section where code is being
346 /// emitted to @p Section. This is required to update CurSection. This
347 /// version does not call ChangeSection.
348 void SwitchSectionNoChange(const MCSection *Section,
349 const MCExpr *Subsection = 0) {
350 assert(Section && "Cannot switch to a null section!");
351 MCSectionSubPair curSection = SectionStack.back().first;
352 SectionStack.back().second = curSection;
353 if (MCSectionSubPair(Section, Subsection) != curSection)
354 SectionStack.back().first = MCSectionSubPair(Section, Subsection);
357 /// Create the default sections and set the initial one.
358 virtual void InitSections();
360 /// AssignSection - Sets the symbol's section.
362 /// Each emitted symbol will be tracked in the ordering table,
363 /// so we can sort on them later.
364 void AssignSection(MCSymbol *Symbol, const MCSection *Section);
366 /// EmitLabel - Emit a label for @p Symbol into the current section.
368 /// This corresponds to an assembler statement such as:
371 /// @param Symbol - The symbol to emit. A given symbol should only be
372 /// emitted as a label once, and symbols emitted as a label should never be
373 /// used in an assignment.
374 // FIXME: These emission are non-const because we mutate the symbol to
375 // add the section we're emitting it to later.
376 virtual void EmitLabel(MCSymbol *Symbol);
378 virtual void EmitDebugLabel(MCSymbol *Symbol);
380 virtual void EmitEHSymAttributes(const MCSymbol *Symbol, MCSymbol *EHSymbol);
382 /// EmitAssemblerFlag - Note in the output the specified @p Flag.
383 virtual void EmitAssemblerFlag(MCAssemblerFlag Flag) = 0;
385 /// EmitLinkerOptions - Emit the given list @p Options of strings as linker
386 /// options into the output.
387 virtual void EmitLinkerOptions(ArrayRef<std::string> Kind) {}
389 /// EmitDataRegion - Note in the output the specified region @p Kind.
390 virtual void EmitDataRegion(MCDataRegionType Kind) {}
392 /// EmitVersionMin - Specify the MachO minimum deployment target version.
393 virtual void EmitVersionMin(MCVersionMinType, unsigned Major, unsigned Minor,
396 /// EmitThumbFunc - Note in the output that the specified @p Func is
397 /// a Thumb mode function (ARM target only).
398 virtual void EmitThumbFunc(MCSymbol *Func) = 0;
400 /// getOrCreateSymbolData - Get symbol data for given symbol.
401 virtual MCSymbolData &getOrCreateSymbolData(const MCSymbol *Symbol);
403 /// EmitAssignment - Emit an assignment of @p Value to @p Symbol.
405 /// This corresponds to an assembler statement such as:
408 /// The assignment generates no code, but has the side effect of binding the
409 /// value in the current context. For the assembly streamer, this prints the
410 /// binding into the .s file.
412 /// @param Symbol - The symbol being assigned to.
413 /// @param Value - The value for the symbol.
414 virtual void EmitAssignment(MCSymbol *Symbol, const MCExpr *Value);
416 /// EmitWeakReference - Emit an weak reference from @p Alias to @p Symbol.
418 /// This corresponds to an assembler statement such as:
419 /// .weakref alias, symbol
421 /// @param Alias - The alias that is being created.
422 /// @param Symbol - The symbol being aliased.
423 virtual void EmitWeakReference(MCSymbol *Alias, const MCSymbol *Symbol) = 0;
425 /// EmitSymbolAttribute - Add the given @p Attribute to @p Symbol.
426 virtual bool EmitSymbolAttribute(MCSymbol *Symbol,
427 MCSymbolAttr Attribute) = 0;
429 /// EmitSymbolDesc - Set the @p DescValue for the @p Symbol.
431 /// @param Symbol - The symbol to have its n_desc field set.
432 /// @param DescValue - The value to set into the n_desc field.
433 virtual void EmitSymbolDesc(MCSymbol *Symbol, unsigned DescValue) = 0;
435 /// BeginCOFFSymbolDef - Start emitting COFF symbol definition
437 /// @param Symbol - The symbol to have its External & Type fields set.
438 virtual void BeginCOFFSymbolDef(const MCSymbol *Symbol) = 0;
440 /// EmitCOFFSymbolStorageClass - Emit the storage class of the symbol.
442 /// @param StorageClass - The storage class the symbol should have.
443 virtual void EmitCOFFSymbolStorageClass(int StorageClass) = 0;
445 /// EmitCOFFSymbolType - Emit the type of the symbol.
447 /// @param Type - A COFF type identifier (see COFF::SymbolType in X86COFF.h)
448 virtual void EmitCOFFSymbolType(int Type) = 0;
450 /// EndCOFFSymbolDef - Marks the end of the symbol definition.
451 virtual void EndCOFFSymbolDef() = 0;
453 /// EmitCOFFSectionIndex - Emits a COFF section index.
455 /// @param Symbol - Symbol the section number relocation should point to.
456 virtual void EmitCOFFSectionIndex(MCSymbol const *Symbol);
458 /// EmitCOFFSecRel32 - Emits a COFF section relative relocation.
460 /// @param Symbol - Symbol the section relative relocation should point to.
461 virtual void EmitCOFFSecRel32(MCSymbol const *Symbol);
463 /// EmitELFSize - Emit an ELF .size directive.
465 /// This corresponds to an assembler statement such as:
466 /// .size symbol, expression
468 virtual void EmitELFSize(MCSymbol *Symbol, const MCExpr *Value) = 0;
470 /// \brief Emit a Linker Optimization Hint (LOH) directive.
471 /// \param Args - Arguments of the LOH.
472 virtual void EmitLOHDirective(MCLOHType Kind, const MCLOHArgs &Args) {}
474 /// EmitCommonSymbol - Emit a common symbol.
476 /// @param Symbol - The common symbol to emit.
477 /// @param Size - The size of the common symbol.
478 /// @param ByteAlignment - The alignment of the symbol if
479 /// non-zero. This must be a power of 2.
480 virtual void EmitCommonSymbol(MCSymbol *Symbol, uint64_t Size,
481 unsigned ByteAlignment) = 0;
483 /// EmitLocalCommonSymbol - Emit a local common (.lcomm) symbol.
485 /// @param Symbol - The common symbol to emit.
486 /// @param Size - The size of the common symbol.
487 /// @param ByteAlignment - The alignment of the common symbol in bytes.
488 virtual void EmitLocalCommonSymbol(MCSymbol *Symbol, uint64_t Size,
489 unsigned ByteAlignment) = 0;
491 /// EmitZerofill - Emit the zerofill section and an optional symbol.
493 /// @param Section - The zerofill section to create and or to put the symbol
494 /// @param Symbol - The zerofill symbol to emit, if non-NULL.
495 /// @param Size - The size of the zerofill symbol.
496 /// @param ByteAlignment - The alignment of the zerofill symbol if
497 /// non-zero. This must be a power of 2 on some targets.
498 virtual void EmitZerofill(const MCSection *Section, MCSymbol *Symbol = 0,
499 uint64_t Size = 0, unsigned ByteAlignment = 0) = 0;
501 /// EmitTBSSSymbol - Emit a thread local bss (.tbss) symbol.
503 /// @param Section - The thread local common section.
504 /// @param Symbol - The thread local common symbol to emit.
505 /// @param Size - The size of the symbol.
506 /// @param ByteAlignment - The alignment of the thread local common symbol
507 /// if non-zero. This must be a power of 2 on some targets.
508 virtual void EmitTBSSSymbol(const MCSection *Section, MCSymbol *Symbol,
509 uint64_t Size, unsigned ByteAlignment = 0) = 0;
512 /// @name Generating Data
515 /// EmitBytes - Emit the bytes in \p Data into the output.
517 /// This is used to implement assembler directives such as .byte, .ascii,
519 virtual void EmitBytes(StringRef Data) = 0;
521 /// EmitValue - Emit the expression @p Value into the output as a native
522 /// integer of the given @p Size bytes.
524 /// This is used to implement assembler directives such as .word, .quad,
527 /// @param Value - The value to emit.
528 /// @param Size - The size of the integer (in bytes) to emit. This must
529 /// match a native machine width.
530 virtual void EmitValueImpl(const MCExpr *Value, unsigned Size) = 0;
532 void EmitValue(const MCExpr *Value, unsigned Size);
534 /// EmitIntValue - Special case of EmitValue that avoids the client having
535 /// to pass in a MCExpr for constant integers.
536 virtual void EmitIntValue(uint64_t Value, unsigned Size);
538 /// EmitAbsValue - Emit the Value, but try to avoid relocations. On MachO
539 /// this is done by producing
542 void EmitAbsValue(const MCExpr *Value, unsigned Size);
544 virtual void EmitULEB128Value(const MCExpr *Value) = 0;
546 virtual void EmitSLEB128Value(const MCExpr *Value) = 0;
548 /// EmitULEB128Value - Special case of EmitULEB128Value that avoids the
549 /// client having to pass in a MCExpr for constant integers.
550 void EmitULEB128IntValue(uint64_t Value, unsigned Padding = 0);
552 /// EmitSLEB128Value - Special case of EmitSLEB128Value that avoids the
553 /// client having to pass in a MCExpr for constant integers.
554 void EmitSLEB128IntValue(int64_t Value);
556 /// EmitSymbolValue - Special case of EmitValue that avoids the client
557 /// having to pass in a MCExpr for MCSymbols.
558 void EmitSymbolValue(const MCSymbol *Sym, unsigned Size);
560 /// EmitGPRel64Value - Emit the expression @p Value into the output as a
561 /// gprel64 (64-bit GP relative) value.
563 /// This is used to implement assembler directives such as .gpdword on
564 /// targets that support them.
565 virtual void EmitGPRel64Value(const MCExpr *Value);
567 /// EmitGPRel32Value - Emit the expression @p Value into the output as a
568 /// gprel32 (32-bit GP relative) value.
570 /// This is used to implement assembler directives such as .gprel32 on
571 /// targets that support them.
572 virtual void EmitGPRel32Value(const MCExpr *Value);
574 /// EmitFill - Emit NumBytes bytes worth of the value specified by
575 /// FillValue. This implements directives such as '.space'.
576 virtual void EmitFill(uint64_t NumBytes, uint8_t FillValue);
578 /// \brief Emit NumBytes worth of zeros.
579 /// This function properly handles data in virtual sections.
580 virtual void EmitZeros(uint64_t NumBytes);
582 /// EmitValueToAlignment - Emit some number of copies of @p Value until
583 /// the byte alignment @p ByteAlignment is reached.
585 /// If the number of bytes need to emit for the alignment is not a multiple
586 /// of @p ValueSize, then the contents of the emitted fill bytes is
589 /// This used to implement the .align assembler directive.
591 /// @param ByteAlignment - The alignment to reach. This must be a power of
592 /// two on some targets.
593 /// @param Value - The value to use when filling bytes.
594 /// @param ValueSize - The size of the integer (in bytes) to emit for
595 /// @p Value. This must match a native machine width.
596 /// @param MaxBytesToEmit - The maximum numbers of bytes to emit, or 0. If
597 /// the alignment cannot be reached in this many bytes, no bytes are
599 virtual void EmitValueToAlignment(unsigned ByteAlignment, int64_t Value = 0,
600 unsigned ValueSize = 1,
601 unsigned MaxBytesToEmit = 0) = 0;
603 /// EmitCodeAlignment - Emit nops until the byte alignment @p ByteAlignment
606 /// This used to align code where the alignment bytes may be executed. This
607 /// can emit different bytes for different sizes to optimize execution.
609 /// @param ByteAlignment - The alignment to reach. This must be a power of
610 /// two on some targets.
611 /// @param MaxBytesToEmit - The maximum numbers of bytes to emit, or 0. If
612 /// the alignment cannot be reached in this many bytes, no bytes are
614 virtual void EmitCodeAlignment(unsigned ByteAlignment,
615 unsigned MaxBytesToEmit = 0) = 0;
617 /// EmitValueToOffset - Emit some number of copies of @p Value until the
618 /// byte offset @p Offset is reached.
620 /// This is used to implement assembler directives such as .org.
622 /// @param Offset - The offset to reach. This may be an expression, but the
623 /// expression must be associated with the current section.
624 /// @param Value - The value to use when filling bytes.
625 /// @return false on success, true if the offset was invalid.
626 virtual bool EmitValueToOffset(const MCExpr *Offset,
627 unsigned char Value = 0) = 0;
631 /// EmitFileDirective - Switch to a new logical file. This is used to
632 /// implement the '.file "foo.c"' assembler directive.
633 virtual void EmitFileDirective(StringRef Filename) = 0;
635 /// Emit the "identifiers" directive. This implements the
636 /// '.ident "version foo"' assembler directive.
637 virtual void EmitIdent(StringRef IdentString) {}
639 /// EmitDwarfFileDirective - Associate a filename with a specified logical
640 /// file number. This implements the DWARF2 '.file 4 "foo.c"' assembler
642 virtual unsigned EmitDwarfFileDirective(unsigned FileNo, StringRef Directory,
646 /// EmitDwarfLocDirective - This implements the DWARF2
647 // '.loc fileno lineno ...' assembler directive.
648 virtual void EmitDwarfLocDirective(unsigned FileNo, unsigned Line,
649 unsigned Column, unsigned Flags,
650 unsigned Isa, unsigned Discriminator,
653 virtual void EmitDwarfAdvanceLineAddr(int64_t LineDelta,
654 const MCSymbol *LastLabel,
655 const MCSymbol *Label,
656 unsigned PointerSize) = 0;
658 virtual void EmitDwarfAdvanceFrameAddr(const MCSymbol *LastLabel,
659 const MCSymbol *Label) {}
661 virtual MCSymbol *getDwarfLineTableSymbol(unsigned CUID);
663 void EmitDwarfSetLineAddr(int64_t LineDelta, const MCSymbol *Label,
666 virtual void EmitCompactUnwindEncoding(uint32_t CompactUnwindEncoding);
667 virtual void EmitCFISections(bool EH, bool Debug);
668 void EmitCFIStartProc(bool IsSimple);
669 void EmitCFIEndProc();
670 virtual void EmitCFIDefCfa(int64_t Register, int64_t Offset);
671 virtual void EmitCFIDefCfaOffset(int64_t Offset);
672 virtual void EmitCFIDefCfaRegister(int64_t Register);
673 virtual void EmitCFIOffset(int64_t Register, int64_t Offset);
674 virtual void EmitCFIPersonality(const MCSymbol *Sym, unsigned Encoding);
675 virtual void EmitCFILsda(const MCSymbol *Sym, unsigned Encoding);
676 virtual void EmitCFIRememberState();
677 virtual void EmitCFIRestoreState();
678 virtual void EmitCFISameValue(int64_t Register);
679 virtual void EmitCFIRestore(int64_t Register);
680 virtual void EmitCFIRelOffset(int64_t Register, int64_t Offset);
681 virtual void EmitCFIAdjustCfaOffset(int64_t Adjustment);
682 virtual void EmitCFIEscape(StringRef Values);
683 virtual void EmitCFISignalFrame();
684 virtual void EmitCFIUndefined(int64_t Register);
685 virtual void EmitCFIRegister(int64_t Register1, int64_t Register2);
686 virtual void EmitCFIWindowSave();
688 virtual void EmitWin64EHStartProc(const MCSymbol *Symbol);
689 virtual void EmitWin64EHEndProc();
690 virtual void EmitWin64EHStartChained();
691 virtual void EmitWin64EHEndChained();
692 virtual void EmitWin64EHHandler(const MCSymbol *Sym, bool Unwind,
694 virtual void EmitWin64EHHandlerData();
695 virtual void EmitWin64EHPushReg(unsigned Register);
696 virtual void EmitWin64EHSetFrame(unsigned Register, unsigned Offset);
697 virtual void EmitWin64EHAllocStack(unsigned Size);
698 virtual void EmitWin64EHSaveReg(unsigned Register, unsigned Offset);
699 virtual void EmitWin64EHSaveXMM(unsigned Register, unsigned Offset);
700 virtual void EmitWin64EHPushFrame(bool Code);
701 virtual void EmitWin64EHEndProlog();
703 /// EmitInstruction - Emit the given @p Instruction into the current
705 virtual void EmitInstruction(const MCInst &Inst, const MCSubtargetInfo &STI) = 0;
707 /// \brief Set the bundle alignment mode from now on in the section.
708 /// The argument is the power of 2 to which the alignment is set. The
709 /// value 0 means turn the bundle alignment off.
710 virtual void EmitBundleAlignMode(unsigned AlignPow2) = 0;
712 /// \brief The following instructions are a bundle-locked group.
714 /// \param AlignToEnd - If true, the bundle-locked group will be aligned to
715 /// the end of a bundle.
716 virtual void EmitBundleLock(bool AlignToEnd) = 0;
718 /// \brief Ends a bundle-locked group.
719 virtual void EmitBundleUnlock() = 0;
721 /// EmitRawText - If this file is backed by a assembly streamer, this dumps
722 /// the specified string in the output .s file. This capability is
723 /// indicated by the hasRawTextSupport() predicate. By default this aborts.
724 void EmitRawText(const Twine &String);
726 /// Flush - Causes any cached state to be written out.
727 virtual void Flush() {}
729 /// FinishImpl - Streamer specific finalization.
730 virtual void FinishImpl() = 0;
731 /// Finish - Finish emission of machine code.
735 /// createNullStreamer - Create a dummy machine code streamer, which does
736 /// nothing. This is useful for timing the assembler front end.
737 MCStreamer *createNullStreamer(MCContext &Ctx);
739 /// createAsmStreamer - Create a machine code streamer which will print out
740 /// assembly for the native target, suitable for compiling with a native
743 /// \param InstPrint - If given, the instruction printer to use. If not given
744 /// the MCInst representation will be printed. This method takes ownership of
747 /// \param CE - If given, a code emitter to use to show the instruction
748 /// encoding inline with the assembly. This method takes ownership of \p CE.
750 /// \param TAB - If given, a target asm backend to use to show the fixup
751 /// information in conjunction with encoding information. This method takes
752 /// ownership of \p TAB.
754 /// \param ShowInst - Whether to show the MCInst representation inline with
756 MCStreamer *createAsmStreamer(MCContext &Ctx, formatted_raw_ostream &OS,
757 bool isVerboseAsm, bool useCFI,
758 bool useDwarfDirectory, MCInstPrinter *InstPrint,
759 MCCodeEmitter *CE, MCAsmBackend *TAB,
762 /// createMachOStreamer - Create a machine code streamer which will generate
763 /// Mach-O format object files.
765 /// Takes ownership of \p TAB and \p CE.
766 MCStreamer *createMachOStreamer(MCContext &Ctx, MCAsmBackend &TAB,
767 raw_ostream &OS, MCCodeEmitter *CE,
768 bool RelaxAll = false,
769 bool LabelSections = false);
771 /// createWinCOFFStreamer - Create a machine code streamer which will
772 /// generate Microsoft COFF format object files.
774 /// Takes ownership of \p TAB and \p CE.
775 MCStreamer *createWinCOFFStreamer(MCContext &Ctx, MCAsmBackend &TAB,
776 MCCodeEmitter &CE, raw_ostream &OS,
777 bool RelaxAll = false);
779 /// createELFStreamer - Create a machine code streamer which will generate
780 /// ELF format object files.
781 MCStreamer *createELFStreamer(MCContext &Ctx, MCAsmBackend &TAB,
782 raw_ostream &OS, MCCodeEmitter *CE, bool RelaxAll,
785 } // end namespace llvm